From e193e0140419d117a52e3756ddd9d2bdf3ab7a4a Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Wed, 6 Nov 2013 16:23:17 -0600 Subject: Automated update from Qt3 --- doc/man/man3/QAccel.3qt | 1 - doc/man/man3/QAccessible.3qt | 1 - doc/man/man3/QAccessibleInterface.3qt | 1 - doc/man/man3/QAccessibleObject.3qt | 1 - doc/man/man3/QAction.3qt | 1 - doc/man/man3/QActionGroup.3qt | 1 - doc/man/man3/QApplication.3qt | 1 - doc/man/man3/QAsciiCache.3qt | 1 - doc/man/man3/QAsciiCacheIterator.3qt | 1 - doc/man/man3/QAsciiDict.3qt | 1 - doc/man/man3/QAsciiDictIterator.3qt | 1 - doc/man/man3/QAssistantClient.3qt | 1 - doc/man/man3/QAxAggregated.3qt | 1 - doc/man/man3/QAxBase.3qt | 1 - doc/man/man3/QAxBindable.3qt | 1 - doc/man/man3/QAxFactory.3qt | 1 - doc/man/man3/QAxObject.3qt | 1 - doc/man/man3/QAxScript.3qt | 1 - doc/man/man3/QAxScriptEngine.3qt | 1 - doc/man/man3/QAxScriptManager.3qt | 1 - doc/man/man3/QAxWidget.3qt | 1 - doc/man/man3/QBig5Codec.3qt | 1 - doc/man/man3/QBig5hkscsCodec.3qt | 1 - doc/man/man3/QBitArray.3qt | 1 - doc/man/man3/QBitVal.3qt | 1 - doc/man/man3/QBitmap.3qt | 1 - doc/man/man3/QBoxLayout.3qt | 1 - doc/man/man3/QBrush.3qt | 1 - doc/man/man3/QBuffer.3qt | 1 - doc/man/man3/QButton.3qt | 1 - doc/man/man3/QButtonGroup.3qt | 1 - doc/man/man3/QByteArray.3qt | 1 - doc/man/man3/QCDEStyle.3qt | 1 - doc/man/man3/QCString.3qt | 1 - doc/man/man3/QCache.3qt | 1 - doc/man/man3/QCacheIterator.3qt | 1 - doc/man/man3/QCanvas.3qt | 1 - doc/man/man3/QCanvasEllipse.3qt | 1 - doc/man/man3/QCanvasItem.3qt | 1 - doc/man/man3/QCanvasItemList.3qt | 1 - doc/man/man3/QCanvasLine.3qt | 1 - doc/man/man3/QCanvasPixmap.3qt | 1 - doc/man/man3/QCanvasPixmapArray.3qt | 1 - doc/man/man3/QCanvasPolygon.3qt | 1 - doc/man/man3/QCanvasPolygonalItem.3qt | 1 - doc/man/man3/QCanvasRectangle.3qt | 1 - doc/man/man3/QCanvasSpline.3qt | 1 - doc/man/man3/QCanvasSprite.3qt | 1 - doc/man/man3/QCanvasText.3qt | 1 - doc/man/man3/QCanvasView.3qt | 1 - doc/man/man3/QChar.3qt | 1 - doc/man/man3/QCharRef.3qt | 1 - doc/man/man3/QCheckBox.3qt | 1 - doc/man/man3/QCheckListItem.3qt | 1 - doc/man/man3/QCheckTableItem.3qt | 1 - doc/man/man3/QChildEvent.3qt | 1 - doc/man/man3/QClipboard.3qt | 1 - doc/man/man3/QCloseEvent.3qt | 1 - doc/man/man3/QColor.3qt | 1 - doc/man/man3/QColorDialog.3qt | 1 - doc/man/man3/QColorDrag.3qt | 1 - doc/man/man3/QColorGroup.3qt | 1 - doc/man/man3/QComboBox.3qt | 1 - doc/man/man3/QComboTableItem.3qt | 1 - doc/man/man3/QCommonStyle.3qt | 1 - doc/man/man3/QConstString.3qt | 1 - doc/man/man3/QContextMenuEvent.3qt | 1 - doc/man/man3/QCopChannel.3qt | 1 - doc/man/man3/QCursor.3qt | 1 - doc/man/man3/QCustomEvent.3qt | 1 - doc/man/man3/QCustomMenuItem.3qt | 1 - doc/man/man3/QDataBrowser.3qt | 1 - doc/man/man3/QDataStream.3qt | 1 - doc/man/man3/QDataTable.3qt | 1 - doc/man/man3/QDataView.3qt | 1 - doc/man/man3/QDate.3qt | 1 - doc/man/man3/QDateEdit.3qt | 1 - doc/man/man3/QDateTime.3qt | 1 - doc/man/man3/QDateTimeEdit.3qt | 1 - doc/man/man3/QDateTimeEditBase.3qt | 1 - doc/man/man3/QDeepCopy.3qt | 1 - doc/man/man3/QDesktopWidget.3qt | 1 - doc/man/man3/QDial.3qt | 1 - doc/man/man3/QDialog.3qt | 1 - doc/man/man3/QDict.3qt | 1 - doc/man/man3/QDictIterator.3qt | 1 - doc/man/man3/QDir.3qt | 1 - doc/man/man3/QDirectPainter.3qt | 1 - doc/man/man3/QDns.3qt | 1 - doc/man/man3/QDockArea.3qt | 1 - doc/man/man3/QDockWindow.3qt | 1 - doc/man/man3/QDomAttr.3qt | 1 - doc/man/man3/QDomCDATASection.3qt | 1 - doc/man/man3/QDomCharacterData.3qt | 1 - doc/man/man3/QDomComment.3qt | 1 - doc/man/man3/QDomDocument.3qt | 1 - doc/man/man3/QDomDocumentFragment.3qt | 1 - doc/man/man3/QDomDocumentType.3qt | 1 - doc/man/man3/QDomElement.3qt | 1 - doc/man/man3/QDomEntity.3qt | 1 - doc/man/man3/QDomEntityReference.3qt | 1 - doc/man/man3/QDomImplementation.3qt | 1 - doc/man/man3/QDomNamedNodeMap.3qt | 1 - doc/man/man3/QDomNode.3qt | 1 - doc/man/man3/QDomNodeList.3qt | 1 - doc/man/man3/QDomNotation.3qt | 1 - doc/man/man3/QDomProcessingInstruction.3qt | 1 - doc/man/man3/QDomText.3qt | 1 - doc/man/man3/QDoubleValidator.3qt | 1 - doc/man/man3/QDragEnterEvent.3qt | 1 - doc/man/man3/QDragLeaveEvent.3qt | 1 - doc/man/man3/QDragMoveEvent.3qt | 1 - doc/man/man3/QDragObject.3qt | 1 - doc/man/man3/QDropEvent.3qt | 1 - doc/man/man3/QEditorFactory.3qt | 1 - doc/man/man3/QErrorMessage.3qt | 1 - doc/man/man3/QEucJpCodec.3qt | 1 - doc/man/man3/QEucKrCodec.3qt | 1 - doc/man/man3/QEvent.3qt | 1 - doc/man/man3/QEventLoop.3qt | 1 - doc/man/man3/QFile.3qt | 1 - doc/man/man3/QFileDialog.3qt | 1 - doc/man/man3/QFileIconProvider.3qt | 1 - doc/man/man3/QFileInfo.3qt | 1 - doc/man/man3/QFilePreview.3qt | 1 - doc/man/man3/QFocusData.3qt | 1 - doc/man/man3/QFocusEvent.3qt | 1 - doc/man/man3/QFont.3qt | 1 - doc/man/man3/QFontDatabase.3qt | 1 - doc/man/man3/QFontDialog.3qt | 1 - doc/man/man3/QFontInfo.3qt | 1 - doc/man/man3/QFontManager.3qt | 1 - doc/man/man3/QFontMetrics.3qt | 1 - doc/man/man3/QFrame.3qt | 1 - doc/man/man3/QFtp.3qt | 1 - doc/man/man3/QGL.3qt | 1 - doc/man/man3/QGLColormap.3qt | 1 - doc/man/man3/QGLContext.3qt | 1 - doc/man/man3/QGLFormat.3qt | 1 - doc/man/man3/QGLWidget.3qt | 1 - doc/man/man3/QGLayoutIterator.3qt | 1 - doc/man/man3/QGb18030Codec.3qt | 1 - doc/man/man3/QGb2312Codec.3qt | 1 - doc/man/man3/QGbkCodec.3qt | 1 - doc/man/man3/QGfxDriverFactory.3qt | 1 - doc/man/man3/QGfxDriverPlugin.3qt | 1 - doc/man/man3/QGrid.3qt | 1 - doc/man/man3/QGridLayout.3qt | 1 - doc/man/man3/QGridView.3qt | 1 - doc/man/man3/QGroupBox.3qt | 1 - doc/man/man3/QGuardedPtr.3qt | 1 - doc/man/man3/QHBox.3qt | 1 - doc/man/man3/QHBoxLayout.3qt | 1 - doc/man/man3/QHButtonGroup.3qt | 1 - doc/man/man3/QHGroupBox.3qt | 1 - doc/man/man3/QHeader.3qt | 1 - doc/man/man3/QHebrewCodec.3qt | 1 - doc/man/man3/QHideEvent.3qt | 1 - doc/man/man3/QHostAddress.3qt | 1 - doc/man/man3/QHttp.3qt | 1 - doc/man/man3/QHttpHeader.3qt | 1 - doc/man/man3/QHttpRequestHeader.3qt | 1 - doc/man/man3/QHttpResponseHeader.3qt | 1 - doc/man/man3/QIMEvent.3qt | 1 - doc/man/man3/QIODevice.3qt | 1 - doc/man/man3/QIconDrag.3qt | 1 - doc/man/man3/QIconDragEvent.3qt | 1 - doc/man/man3/QIconDragItem.3qt | 1 - doc/man/man3/QIconFactory.3qt | 1 - doc/man/man3/QIconSet.3qt | 1 - doc/man/man3/QIconView.3qt | 1 - doc/man/man3/QIconViewItem.3qt | 1 - doc/man/man3/QImage.3qt | 1 - doc/man/man3/QImageConsumer.3qt | 1 - doc/man/man3/QImageDecoder.3qt | 1 - doc/man/man3/QImageDrag.3qt | 1 - doc/man/man3/QImageFormat.3qt | 1 - doc/man/man3/QImageFormatPlugin.3qt | 1 - doc/man/man3/QImageFormatType.3qt | 1 - doc/man/man3/QImageIO.3qt | 1 - doc/man/man3/QInputDialog.3qt | 1 - doc/man/man3/QIntCache.3qt | 1 - doc/man/man3/QIntCacheIterator.3qt | 1 - doc/man/man3/QIntDict.3qt | 1 - doc/man/man3/QIntDictIterator.3qt | 1 - doc/man/man3/QIntValidator.3qt | 1 - doc/man/man3/QJisCodec.3qt | 1 - doc/man/man3/QKbdDriverFactory.3qt | 1 - doc/man/man3/QKbdDriverPlugin.3qt | 1 - doc/man/man3/QKeyEvent.3qt | 1 - doc/man/man3/QKeySequence.3qt | 1 - doc/man/man3/QLCDNumber.3qt | 1 - doc/man/man3/QLabel.3qt | 1 - doc/man/man3/QLayout.3qt | 1 - doc/man/man3/QLayoutItem.3qt | 1 - doc/man/man3/QLayoutIterator.3qt | 1 - doc/man/man3/QLibrary.3qt | 1 - doc/man/man3/QLineEdit.3qt | 1 - doc/man/man3/QListBox.3qt | 1 - doc/man/man3/QListBoxItem.3qt | 1 - doc/man/man3/QListBoxPixmap.3qt | 1 - doc/man/man3/QListBoxText.3qt | 1 - doc/man/man3/QListView.3qt | 1 - doc/man/man3/QListViewItem.3qt | 1 - doc/man/man3/QListViewItemIterator.3qt | 1 - doc/man/man3/QLocalFs.3qt | 1 - doc/man/man3/QLocale.3qt | 1 - doc/man/man3/QMacMime.3qt | 1 - doc/man/man3/QMacStyle.3qt | 1 - doc/man/man3/QMainWindow.3qt | 1 - doc/man/man3/QMap.3qt | 1 - doc/man/man3/QMapConstIterator.3qt | 1 - doc/man/man3/QMapIterator.3qt | 1 - doc/man/man3/QMemArray.3qt | 1 - doc/man/man3/QMenuBar.3qt | 1 - doc/man/man3/QMenuData.3qt | 1 - doc/man/man3/QMessageBox.3qt | 1 - doc/man/man3/QMetaObject.3qt | 1 - doc/man/man3/QMetaProperty.3qt | 1 - doc/man/man3/QMimeSource.3qt | 1 - doc/man/man3/QMimeSourceFactory.3qt | 1 - doc/man/man3/QMotif.3qt | 1 - doc/man/man3/QMotifDialog.3qt | 1 - doc/man/man3/QMotifPlusStyle.3qt | 1 - doc/man/man3/QMotifStyle.3qt | 1 - doc/man/man3/QMotifWidget.3qt | 1 - doc/man/man3/QMouseDriverFactory.3qt | 1 - doc/man/man3/QMouseDriverPlugin.3qt | 1 - doc/man/man3/QMouseEvent.3qt | 1 - doc/man/man3/QMoveEvent.3qt | 1 - doc/man/man3/QMovie.3qt | 1 - doc/man/man3/QMutex.3qt | 1 - doc/man/man3/QMutexLocker.3qt | 1 - doc/man/man3/QNPInstance.3qt | 1 - doc/man/man3/QNPStream.3qt | 1 - doc/man/man3/QNPWidget.3qt | 1 - doc/man/man3/QNPlugin.3qt | 1 - doc/man/man3/QNetworkOperation.3qt | 1 - doc/man/man3/QNetworkProtocol.3qt | 1 - doc/man/man3/QObject.3qt | 1 - doc/man/man3/QObjectCleanupHandler.3qt | 1 - doc/man/man3/QObjectList.3qt | 1 - doc/man/man3/QObjectListIterator.3qt | 1 - doc/man/man3/QPNGImagePacker.3qt | 1 - doc/man/man3/QPaintDevice.3qt | 1 - doc/man/man3/QPaintDeviceMetrics.3qt | 1 - doc/man/man3/QPaintEvent.3qt | 1 - doc/man/man3/QPainter.3qt | 1 - doc/man/man3/QPair.3qt | 1 - doc/man/man3/QPalette.3qt | 1 - doc/man/man3/QPen.3qt | 1 - doc/man/man3/QPicture.3qt | 1 - doc/man/man3/QPixmap.3qt | 1 - doc/man/man3/QPixmapCache.3qt | 1 - doc/man/man3/QPlatinumStyle.3qt | 1 - doc/man/man3/QPoint.3qt | 1 - doc/man/man3/QPointArray.3qt | 1 - doc/man/man3/QPopupMenu.3qt | 1 - doc/man/man3/QPrinter.3qt | 1 - doc/man/man3/QProcess.3qt | 1 - doc/man/man3/QProgressBar.3qt | 1 - doc/man/man3/QProgressDialog.3qt | 1 - doc/man/man3/QPtrCollection.3qt | 1 - doc/man/man3/QPtrDict.3qt | 1 - doc/man/man3/QPtrDictIterator.3qt | 1 - doc/man/man3/QPtrList.3qt | 1 - doc/man/man3/QPtrListIterator.3qt | 1 - doc/man/man3/QPtrQueue.3qt | 1 - doc/man/man3/QPtrStack.3qt | 1 - doc/man/man3/QPtrVector.3qt | 1 - doc/man/man3/QPushButton.3qt | 1 - doc/man/man3/QRadioButton.3qt | 1 - doc/man/man3/QRangeControl.3qt | 1 - doc/man/man3/QRect.3qt | 1 - doc/man/man3/QRegExp.3qt | 1 - doc/man/man3/QRegExpValidator.3qt | 1 - doc/man/man3/QRegion.3qt | 1 - doc/man/man3/QResizeEvent.3qt | 1 - doc/man/man3/QSGIStyle.3qt | 1 - doc/man/man3/QScreen.3qt | 1 - doc/man/man3/QScrollBar.3qt | 1 - doc/man/man3/QScrollView.3qt | 1 - doc/man/man3/QSemaphore.3qt | 1 - doc/man/man3/QServerSocket.3qt | 1 - doc/man/man3/QSessionManager.3qt | 1 - doc/man/man3/QSettings.3qt | 1 - doc/man/man3/QShowEvent.3qt | 1 - doc/man/man3/QSignal.3qt | 1 - doc/man/man3/QSignalMapper.3qt | 1 - doc/man/man3/QSimpleRichText.3qt | 1 - doc/man/man3/QSize.3qt | 1 - doc/man/man3/QSizeGrip.3qt | 1 - doc/man/man3/QSizePolicy.3qt | 1 - doc/man/man3/QSjisCodec.3qt | 1 - doc/man/man3/QSlider.3qt | 1 - doc/man/man3/QSocket.3qt | 1 - doc/man/man3/QSocketDevice.3qt | 1 - doc/man/man3/QSocketNotifier.3qt | 1 - doc/man/man3/QSound.3qt | 1 - doc/man/man3/QSpacerItem.3qt | 1 - doc/man/man3/QSpinBox.3qt | 1 - doc/man/man3/QSplashScreen.3qt | 1 - doc/man/man3/QSplitter.3qt | 1 - doc/man/man3/QSql.3qt | 1 - doc/man/man3/QSqlCursor.3qt | 1 - doc/man/man3/QSqlDatabase.3qt | 1 - doc/man/man3/QSqlDriver.3qt | 1 - doc/man/man3/QSqlDriverPlugin.3qt | 1 - doc/man/man3/QSqlEditorFactory.3qt | 1 - doc/man/man3/QSqlError.3qt | 1 - doc/man/man3/QSqlField.3qt | 1 - doc/man/man3/QSqlFieldInfo.3qt | 1 - doc/man/man3/QSqlForm.3qt | 1 - doc/man/man3/QSqlIndex.3qt | 1 - doc/man/man3/QSqlPropertyMap.3qt | 1 - doc/man/man3/QSqlQuery.3qt | 1 - doc/man/man3/QSqlRecord.3qt | 1 - doc/man/man3/QSqlRecordInfo.3qt | 1 - doc/man/man3/QSqlResult.3qt | 1 - doc/man/man3/QSqlSelectCursor.3qt | 1 - doc/man/man3/QStatusBar.3qt | 1 - doc/man/man3/QStoredDrag.3qt | 1 - doc/man/man3/QStrIList.3qt | 1 - doc/man/man3/QStrList.3qt | 1 - doc/man/man3/QStrListIterator.3qt | 1 - doc/man/man3/QString.3qt | 1 - doc/man/man3/QStringList.3qt | 1 - doc/man/man3/QStyle.3qt | 1 - doc/man/man3/QStyleFactory.3qt | 1 - doc/man/man3/QStyleOption.3qt | 1 - doc/man/man3/QStylePlugin.3qt | 1 - doc/man/man3/QStyleSheet.3qt | 1 - doc/man/man3/QStyleSheetItem.3qt | 1 - doc/man/man3/QSyntaxHighlighter.3qt | 1 - doc/man/man3/QTab.3qt | 1 - doc/man/man3/QTabBar.3qt | 1 - doc/man/man3/QTabDialog.3qt | 1 - doc/man/man3/QTabWidget.3qt | 1 - doc/man/man3/QTable.3qt | 1 - doc/man/man3/QTableItem.3qt | 1 - doc/man/man3/QTableSelection.3qt | 1 - doc/man/man3/QTabletEvent.3qt | 1 - doc/man/man3/QTextBrowser.3qt | 1 - doc/man/man3/QTextCodec.3qt | 1 - doc/man/man3/QTextCodecPlugin.3qt | 1 - doc/man/man3/QTextDecoder.3qt | 1 - doc/man/man3/QTextDrag.3qt | 1 - doc/man/man3/QTextEdit.3qt | 1 - doc/man/man3/QTextEncoder.3qt | 1 - doc/man/man3/QTextIStream.3qt | 1 - doc/man/man3/QTextOStream.3qt | 1 - doc/man/man3/QTextStream.3qt | 1 - doc/man/man3/QThread.3qt | 1 - doc/man/man3/QThreadStorage.3qt | 1 - doc/man/man3/QTime.3qt | 1 - doc/man/man3/QTimeEdit.3qt | 1 - doc/man/man3/QTimer.3qt | 1 - doc/man/man3/QTimerEvent.3qt | 1 - doc/man/man3/QToolBar.3qt | 1 - doc/man/man3/QToolBox.3qt | 1 - doc/man/man3/QToolButton.3qt | 1 - doc/man/man3/QToolTip.3qt | 1 - doc/man/man3/QToolTipGroup.3qt | 1 - doc/man/man3/QTranslator.3qt | 1 - doc/man/man3/QTranslatorMessage.3qt | 1 - doc/man/man3/QTsciiCodec.3qt | 1 - doc/man/man3/QUriDrag.3qt | 1 - doc/man/man3/QUrl.3qt | 1 - doc/man/man3/QUrlInfo.3qt | 1 - doc/man/man3/QUrlOperator.3qt | 1 - doc/man/man3/QUuid.3qt | 1 - doc/man/man3/QVBox.3qt | 1 - doc/man/man3/QVBoxLayout.3qt | 1 - doc/man/man3/QVButtonGroup.3qt | 1 - doc/man/man3/QVGroupBox.3qt | 1 - doc/man/man3/QValidator.3qt | 1 - doc/man/man3/QValueList.3qt | 1 - doc/man/man3/QValueListConstIterator.3qt | 1 - doc/man/man3/QValueListIterator.3qt | 1 - doc/man/man3/QValueStack.3qt | 1 - doc/man/man3/QValueVector.3qt | 1 - doc/man/man3/QVariant.3qt | 1 - doc/man/man3/QWMatrix.3qt | 1 - doc/man/man3/QWSDecoration.3qt | 1 - doc/man/man3/QWSInputMethod.3qt | 1 - doc/man/man3/QWSKeyboardHandler.3qt | 1 - doc/man/man3/QWSMouseHandler.3qt | 1 - doc/man/man3/QWSServer.3qt | 1 - doc/man/man3/QWSWindow.3qt | 1 - doc/man/man3/QWaitCondition.3qt | 1 - doc/man/man3/QWhatsThis.3qt | 1 - doc/man/man3/QWheelEvent.3qt | 1 - doc/man/man3/QWidget.3qt | 1 - doc/man/man3/QWidgetFactory.3qt | 1 - doc/man/man3/QWidgetItem.3qt | 1 - doc/man/man3/QWidgetPlugin.3qt | 1 - doc/man/man3/QWidgetStack.3qt | 1 - doc/man/man3/QWindowsMime.3qt | 1 - doc/man/man3/QWindowsStyle.3qt | 1 - doc/man/man3/QWizard.3qt | 1 - doc/man/man3/QWorkspace.3qt | 1 - doc/man/man3/QXmlAttributes.3qt | 1 - doc/man/man3/QXmlContentHandler.3qt | 1 - doc/man/man3/QXmlDTDHandler.3qt | 1 - doc/man/man3/QXmlDeclHandler.3qt | 1 - doc/man/man3/QXmlDefaultHandler.3qt | 1 - doc/man/man3/QXmlEntityResolver.3qt | 1 - doc/man/man3/QXmlErrorHandler.3qt | 1 - doc/man/man3/QXmlInputSource.3qt | 1 - doc/man/man3/QXmlLexicalHandler.3qt | 1 - doc/man/man3/QXmlLocator.3qt | 1 - doc/man/man3/QXmlNamespaceSupport.3qt | 1 - doc/man/man3/QXmlParseException.3qt | 1 - doc/man/man3/QXmlReader.3qt | 1 - doc/man/man3/QXmlSimpleReader.3qt | 1 - doc/man/man3/Qt.3qt | 1 - doc/man/man3/TQAccel.3qt | 1 + doc/man/man3/TQAccessible.3qt | 1 + doc/man/man3/TQAccessibleInterface.3qt | 1 + doc/man/man3/TQAccessibleObject.3qt | 1 + doc/man/man3/TQAction.3qt | 1 + doc/man/man3/TQActionGroup.3qt | 1 + doc/man/man3/TQApplication.3qt | 1 + doc/man/man3/TQAsciiCache.3qt | 1 + doc/man/man3/TQAsciiCacheIterator.3qt | 1 + doc/man/man3/TQAsciiDict.3qt | 1 + doc/man/man3/TQAsciiDictIterator.3qt | 1 + doc/man/man3/TQAssistantClient.3qt | 1 + doc/man/man3/TQAxAggregated.3qt | 1 + doc/man/man3/TQAxBase.3qt | 1 + doc/man/man3/TQAxBindable.3qt | 1 + doc/man/man3/TQAxFactory.3qt | 1 + doc/man/man3/TQAxObject.3qt | 1 + doc/man/man3/TQAxScript.3qt | 1 + doc/man/man3/TQAxScriptEngine.3qt | 1 + doc/man/man3/TQAxScriptManager.3qt | 1 + doc/man/man3/TQAxWidget.3qt | 1 + doc/man/man3/TQBig5Codec.3qt | 1 + doc/man/man3/TQBig5hkscsCodec.3qt | 1 + doc/man/man3/TQBitArray.3qt | 1 + doc/man/man3/TQBitVal.3qt | 1 + doc/man/man3/TQBitmap.3qt | 1 + doc/man/man3/TQBoxLayout.3qt | 1 + doc/man/man3/TQBrush.3qt | 1 + doc/man/man3/TQBuffer.3qt | 1 + doc/man/man3/TQButton.3qt | 1 + doc/man/man3/TQButtonGroup.3qt | 1 + doc/man/man3/TQByteArray.3qt | 1 + doc/man/man3/TQCDEStyle.3qt | 1 + doc/man/man3/TQCString.3qt | 1 + doc/man/man3/TQCache.3qt | 1 + doc/man/man3/TQCacheIterator.3qt | 1 + doc/man/man3/TQCanvas.3qt | 1 + doc/man/man3/TQCanvasEllipse.3qt | 1 + doc/man/man3/TQCanvasItem.3qt | 1 + doc/man/man3/TQCanvasItemList.3qt | 1 + doc/man/man3/TQCanvasLine.3qt | 1 + doc/man/man3/TQCanvasPixmap.3qt | 1 + doc/man/man3/TQCanvasPixmapArray.3qt | 1 + doc/man/man3/TQCanvasPolygon.3qt | 1 + doc/man/man3/TQCanvasPolygonalItem.3qt | 1 + doc/man/man3/TQCanvasRectangle.3qt | 1 + doc/man/man3/TQCanvasSpline.3qt | 1 + doc/man/man3/TQCanvasSprite.3qt | 1 + doc/man/man3/TQCanvasText.3qt | 1 + doc/man/man3/TQCanvasView.3qt | 1 + doc/man/man3/TQChar.3qt | 1 + doc/man/man3/TQCharRef.3qt | 1 + doc/man/man3/TQCheckBox.3qt | 1 + doc/man/man3/TQCheckListItem.3qt | 1 + doc/man/man3/TQCheckTableItem.3qt | 1 + doc/man/man3/TQChildEvent.3qt | 1 + doc/man/man3/TQClipboard.3qt | 1 + doc/man/man3/TQCloseEvent.3qt | 1 + doc/man/man3/TQColor.3qt | 1 + doc/man/man3/TQColorDialog.3qt | 1 + doc/man/man3/TQColorDrag.3qt | 1 + doc/man/man3/TQColorGroup.3qt | 1 + doc/man/man3/TQComboBox.3qt | 1 + doc/man/man3/TQComboTableItem.3qt | 1 + doc/man/man3/TQCommonStyle.3qt | 1 + doc/man/man3/TQConstString.3qt | 1 + doc/man/man3/TQContextMenuEvent.3qt | 1 + doc/man/man3/TQCopChannel.3qt | 1 + doc/man/man3/TQCursor.3qt | 1 + doc/man/man3/TQCustomEvent.3qt | 1 + doc/man/man3/TQCustomMenuItem.3qt | 1 + doc/man/man3/TQDataBrowser.3qt | 1 + doc/man/man3/TQDataStream.3qt | 1 + doc/man/man3/TQDataTable.3qt | 1 + doc/man/man3/TQDataView.3qt | 1 + doc/man/man3/TQDate.3qt | 1 + doc/man/man3/TQDateEdit.3qt | 1 + doc/man/man3/TQDateTime.3qt | 1 + doc/man/man3/TQDateTimeEdit.3qt | 1 + doc/man/man3/TQDateTimeEditBase.3qt | 1 + doc/man/man3/TQDeepCopy.3qt | 1 + doc/man/man3/TQDesktopWidget.3qt | 1 + doc/man/man3/TQDial.3qt | 1 + doc/man/man3/TQDialog.3qt | 1 + doc/man/man3/TQDict.3qt | 1 + doc/man/man3/TQDictIterator.3qt | 1 + doc/man/man3/TQDir.3qt | 1 + doc/man/man3/TQDirectPainter.3qt | 1 + doc/man/man3/TQDns.3qt | 1 + doc/man/man3/TQDockArea.3qt | 1 + doc/man/man3/TQDockWindow.3qt | 1 + doc/man/man3/TQDomAttr.3qt | 1 + doc/man/man3/TQDomCDATASection.3qt | 1 + doc/man/man3/TQDomCharacterData.3qt | 1 + doc/man/man3/TQDomComment.3qt | 1 + doc/man/man3/TQDomDocument.3qt | 1 + doc/man/man3/TQDomDocumentFragment.3qt | 1 + doc/man/man3/TQDomDocumentType.3qt | 1 + doc/man/man3/TQDomElement.3qt | 1 + doc/man/man3/TQDomEntity.3qt | 1 + doc/man/man3/TQDomEntityReference.3qt | 1 + doc/man/man3/TQDomImplementation.3qt | 1 + doc/man/man3/TQDomNamedNodeMap.3qt | 1 + doc/man/man3/TQDomNode.3qt | 1 + doc/man/man3/TQDomNodeList.3qt | 1 + doc/man/man3/TQDomNotation.3qt | 1 + doc/man/man3/TQDomProcessingInstruction.3qt | 1 + doc/man/man3/TQDomText.3qt | 1 + doc/man/man3/TQDoubleValidator.3qt | 1 + doc/man/man3/TQDragEnterEvent.3qt | 1 + doc/man/man3/TQDragLeaveEvent.3qt | 1 + doc/man/man3/TQDragMoveEvent.3qt | 1 + doc/man/man3/TQDragObject.3qt | 1 + doc/man/man3/TQDropEvent.3qt | 1 + doc/man/man3/TQEditorFactory.3qt | 1 + doc/man/man3/TQErrorMessage.3qt | 1 + doc/man/man3/TQEucJpCodec.3qt | 1 + doc/man/man3/TQEucKrCodec.3qt | 1 + doc/man/man3/TQEvent.3qt | 1 + doc/man/man3/TQEventLoop.3qt | 1 + doc/man/man3/TQFile.3qt | 1 + doc/man/man3/TQFileDialog.3qt | 1 + doc/man/man3/TQFileIconProvider.3qt | 1 + doc/man/man3/TQFileInfo.3qt | 1 + doc/man/man3/TQFilePreview.3qt | 1 + doc/man/man3/TQFocusData.3qt | 1 + doc/man/man3/TQFocusEvent.3qt | 1 + doc/man/man3/TQFont.3qt | 1 + doc/man/man3/TQFontDatabase.3qt | 1 + doc/man/man3/TQFontDialog.3qt | 1 + doc/man/man3/TQFontInfo.3qt | 1 + doc/man/man3/TQFontManager.3qt | 1 + doc/man/man3/TQFontMetrics.3qt | 1 + doc/man/man3/TQFrame.3qt | 1 + doc/man/man3/TQFtp.3qt | 1 + doc/man/man3/TQGL.3qt | 1 + doc/man/man3/TQGLColormap.3qt | 1 + doc/man/man3/TQGLContext.3qt | 1 + doc/man/man3/TQGLFormat.3qt | 1 + doc/man/man3/TQGLWidget.3qt | 1 + doc/man/man3/TQGLayoutIterator.3qt | 1 + doc/man/man3/TQGb18030Codec.3qt | 1 + doc/man/man3/TQGb2312Codec.3qt | 1 + doc/man/man3/TQGbkCodec.3qt | 1 + doc/man/man3/TQGfxDriverFactory.3qt | 1 + doc/man/man3/TQGfxDriverPlugin.3qt | 1 + doc/man/man3/TQGrid.3qt | 1 + doc/man/man3/TQGridLayout.3qt | 1 + doc/man/man3/TQGridView.3qt | 1 + doc/man/man3/TQGroupBox.3qt | 1 + doc/man/man3/TQGuardedPtr.3qt | 1 + doc/man/man3/TQHBox.3qt | 1 + doc/man/man3/TQHBoxLayout.3qt | 1 + doc/man/man3/TQHButtonGroup.3qt | 1 + doc/man/man3/TQHGroupBox.3qt | 1 + doc/man/man3/TQHeader.3qt | 1 + doc/man/man3/TQHebrewCodec.3qt | 1 + doc/man/man3/TQHideEvent.3qt | 1 + doc/man/man3/TQHostAddress.3qt | 1 + doc/man/man3/TQHttp.3qt | 1 + doc/man/man3/TQHttpHeader.3qt | 1 + doc/man/man3/TQHttpRequestHeader.3qt | 1 + doc/man/man3/TQHttpResponseHeader.3qt | 1 + doc/man/man3/TQIMEvent.3qt | 1 + doc/man/man3/TQIODevice.3qt | 1 + doc/man/man3/TQIconDrag.3qt | 1 + doc/man/man3/TQIconDragEvent.3qt | 1 + doc/man/man3/TQIconDragItem.3qt | 1 + doc/man/man3/TQIconFactory.3qt | 1 + doc/man/man3/TQIconSet.3qt | 1 + doc/man/man3/TQIconView.3qt | 1 + doc/man/man3/TQIconViewItem.3qt | 1 + doc/man/man3/TQImage.3qt | 1 + doc/man/man3/TQImageConsumer.3qt | 1 + doc/man/man3/TQImageDecoder.3qt | 1 + doc/man/man3/TQImageDrag.3qt | 1 + doc/man/man3/TQImageFormat.3qt | 1 + doc/man/man3/TQImageFormatPlugin.3qt | 1 + doc/man/man3/TQImageFormatType.3qt | 1 + doc/man/man3/TQImageIO.3qt | 1 + doc/man/man3/TQInputDialog.3qt | 1 + doc/man/man3/TQIntCache.3qt | 1 + doc/man/man3/TQIntCacheIterator.3qt | 1 + doc/man/man3/TQIntDict.3qt | 1 + doc/man/man3/TQIntDictIterator.3qt | 1 + doc/man/man3/TQIntValidator.3qt | 1 + doc/man/man3/TQJisCodec.3qt | 1 + doc/man/man3/TQKbdDriverFactory.3qt | 1 + doc/man/man3/TQKbdDriverPlugin.3qt | 1 + doc/man/man3/TQKeyEvent.3qt | 1 + doc/man/man3/TQKeySequence.3qt | 1 + doc/man/man3/TQLCDNumber.3qt | 1 + doc/man/man3/TQLabel.3qt | 1 + doc/man/man3/TQLayout.3qt | 1 + doc/man/man3/TQLayoutItem.3qt | 1 + doc/man/man3/TQLayoutIterator.3qt | 1 + doc/man/man3/TQLibrary.3qt | 1 + doc/man/man3/TQLineEdit.3qt | 1 + doc/man/man3/TQListBox.3qt | 1 + doc/man/man3/TQListBoxItem.3qt | 1 + doc/man/man3/TQListBoxPixmap.3qt | 1 + doc/man/man3/TQListBoxText.3qt | 1 + doc/man/man3/TQListView.3qt | 1 + doc/man/man3/TQListViewItem.3qt | 1 + doc/man/man3/TQListViewItemIterator.3qt | 1 + doc/man/man3/TQLocalFs.3qt | 1 + doc/man/man3/TQLocale.3qt | 1 + doc/man/man3/TQMacMime.3qt | 1 + doc/man/man3/TQMacStyle.3qt | 1 + doc/man/man3/TQMainWindow.3qt | 1 + doc/man/man3/TQMap.3qt | 1 + doc/man/man3/TQMapConstIterator.3qt | 1 + doc/man/man3/TQMapIterator.3qt | 1 + doc/man/man3/TQMemArray.3qt | 1 + doc/man/man3/TQMenuBar.3qt | 1 + doc/man/man3/TQMenuData.3qt | 1 + doc/man/man3/TQMessageBox.3qt | 1 + doc/man/man3/TQMetaObject.3qt | 1 + doc/man/man3/TQMetaProperty.3qt | 1 + doc/man/man3/TQMimeSource.3qt | 1 + doc/man/man3/TQMimeSourceFactory.3qt | 1 + doc/man/man3/TQMotif.3qt | 1 + doc/man/man3/TQMotifDialog.3qt | 1 + doc/man/man3/TQMotifPlusStyle.3qt | 1 + doc/man/man3/TQMotifStyle.3qt | 1 + doc/man/man3/TQMotifWidget.3qt | 1 + doc/man/man3/TQMouseDriverFactory.3qt | 1 + doc/man/man3/TQMouseDriverPlugin.3qt | 1 + doc/man/man3/TQMouseEvent.3qt | 1 + doc/man/man3/TQMoveEvent.3qt | 1 + doc/man/man3/TQMovie.3qt | 1 + doc/man/man3/TQMutex.3qt | 1 + doc/man/man3/TQMutexLocker.3qt | 1 + doc/man/man3/TQNPInstance.3qt | 1 + doc/man/man3/TQNPStream.3qt | 1 + doc/man/man3/TQNPWidget.3qt | 1 + doc/man/man3/TQNPlugin.3qt | 1 + doc/man/man3/TQNetworkOperation.3qt | 1 + doc/man/man3/TQNetworkProtocol.3qt | 1 + doc/man/man3/TQObject.3qt | 1 + doc/man/man3/TQObjectCleanupHandler.3qt | 1 + doc/man/man3/TQObjectList.3qt | 1 + doc/man/man3/TQObjectListIterator.3qt | 1 + doc/man/man3/TQPNGImagePacker.3qt | 1 + doc/man/man3/TQPaintDevice.3qt | 1 + doc/man/man3/TQPaintDeviceMetrics.3qt | 1 + doc/man/man3/TQPaintEvent.3qt | 1 + doc/man/man3/TQPainter.3qt | 1 + doc/man/man3/TQPair.3qt | 1 + doc/man/man3/TQPalette.3qt | 1 + doc/man/man3/TQPen.3qt | 1 + doc/man/man3/TQPicture.3qt | 1 + doc/man/man3/TQPixmap.3qt | 1 + doc/man/man3/TQPixmapCache.3qt | 1 + doc/man/man3/TQPlatinumStyle.3qt | 1 + doc/man/man3/TQPoint.3qt | 1 + doc/man/man3/TQPointArray.3qt | 1 + doc/man/man3/TQPopupMenu.3qt | 1 + doc/man/man3/TQPrinter.3qt | 1 + doc/man/man3/TQProcess.3qt | 1 + doc/man/man3/TQProgressBar.3qt | 1 + doc/man/man3/TQProgressDialog.3qt | 1 + doc/man/man3/TQPtrCollection.3qt | 1 + doc/man/man3/TQPtrDict.3qt | 1 + doc/man/man3/TQPtrDictIterator.3qt | 1 + doc/man/man3/TQPtrList.3qt | 1 + doc/man/man3/TQPtrListIterator.3qt | 1 + doc/man/man3/TQPtrQueue.3qt | 1 + doc/man/man3/TQPtrStack.3qt | 1 + doc/man/man3/TQPtrVector.3qt | 1 + doc/man/man3/TQPushButton.3qt | 1 + doc/man/man3/TQRadioButton.3qt | 1 + doc/man/man3/TQRangeControl.3qt | 1 + doc/man/man3/TQRect.3qt | 1 + doc/man/man3/TQRegExp.3qt | 1 + doc/man/man3/TQRegExpValidator.3qt | 1 + doc/man/man3/TQRegion.3qt | 1 + doc/man/man3/TQResizeEvent.3qt | 1 + doc/man/man3/TQSGIStyle.3qt | 1 + doc/man/man3/TQScreen.3qt | 1 + doc/man/man3/TQScrollBar.3qt | 1 + doc/man/man3/TQScrollView.3qt | 1 + doc/man/man3/TQSemaphore.3qt | 1 + doc/man/man3/TQServerSocket.3qt | 1 + doc/man/man3/TQSessionManager.3qt | 1 + doc/man/man3/TQSettings.3qt | 1 + doc/man/man3/TQShowEvent.3qt | 1 + doc/man/man3/TQSignal.3qt | 1 + doc/man/man3/TQSignalMapper.3qt | 1 + doc/man/man3/TQSimpleRichText.3qt | 1 + doc/man/man3/TQSize.3qt | 1 + doc/man/man3/TQSizeGrip.3qt | 1 + doc/man/man3/TQSizePolicy.3qt | 1 + doc/man/man3/TQSjisCodec.3qt | 1 + doc/man/man3/TQSlider.3qt | 1 + doc/man/man3/TQSocket.3qt | 1 + doc/man/man3/TQSocketDevice.3qt | 1 + doc/man/man3/TQSocketNotifier.3qt | 1 + doc/man/man3/TQSound.3qt | 1 + doc/man/man3/TQSpacerItem.3qt | 1 + doc/man/man3/TQSpinBox.3qt | 1 + doc/man/man3/TQSplashScreen.3qt | 1 + doc/man/man3/TQSplitter.3qt | 1 + doc/man/man3/TQSql.3qt | 1 + doc/man/man3/TQSqlCursor.3qt | 1 + doc/man/man3/TQSqlDatabase.3qt | 1 + doc/man/man3/TQSqlDriver.3qt | 1 + doc/man/man3/TQSqlDriverPlugin.3qt | 1 + doc/man/man3/TQSqlEditorFactory.3qt | 1 + doc/man/man3/TQSqlError.3qt | 1 + doc/man/man3/TQSqlField.3qt | 1 + doc/man/man3/TQSqlFieldInfo.3qt | 1 + doc/man/man3/TQSqlForm.3qt | 1 + doc/man/man3/TQSqlIndex.3qt | 1 + doc/man/man3/TQSqlPropertyMap.3qt | 1 + doc/man/man3/TQSqlQuery.3qt | 1 + doc/man/man3/TQSqlRecord.3qt | 1 + doc/man/man3/TQSqlRecordInfo.3qt | 1 + doc/man/man3/TQSqlResult.3qt | 1 + doc/man/man3/TQSqlSelectCursor.3qt | 1 + doc/man/man3/TQStatusBar.3qt | 1 + doc/man/man3/TQStoredDrag.3qt | 1 + doc/man/man3/TQStrIList.3qt | 1 + doc/man/man3/TQStrList.3qt | 1 + doc/man/man3/TQStrListIterator.3qt | 1 + doc/man/man3/TQString.3qt | 1 + doc/man/man3/TQStringList.3qt | 1 + doc/man/man3/TQStyle.3qt | 1 + doc/man/man3/TQStyleFactory.3qt | 1 + doc/man/man3/TQStyleOption.3qt | 1 + doc/man/man3/TQStylePlugin.3qt | 1 + doc/man/man3/TQStyleSheet.3qt | 1 + doc/man/man3/TQStyleSheetItem.3qt | 1 + doc/man/man3/TQSyntaxHighlighter.3qt | 1 + doc/man/man3/TQTab.3qt | 1 + doc/man/man3/TQTabBar.3qt | 1 + doc/man/man3/TQTabDialog.3qt | 1 + doc/man/man3/TQTabWidget.3qt | 1 + doc/man/man3/TQTable.3qt | 1 + doc/man/man3/TQTableItem.3qt | 1 + doc/man/man3/TQTableSelection.3qt | 1 + doc/man/man3/TQTabletEvent.3qt | 1 + doc/man/man3/TQTextBrowser.3qt | 1 + doc/man/man3/TQTextCodec.3qt | 1 + doc/man/man3/TQTextCodecPlugin.3qt | 1 + doc/man/man3/TQTextDecoder.3qt | 1 + doc/man/man3/TQTextDrag.3qt | 1 + doc/man/man3/TQTextEdit.3qt | 1 + doc/man/man3/TQTextEncoder.3qt | 1 + doc/man/man3/TQTextIStream.3qt | 1 + doc/man/man3/TQTextOStream.3qt | 1 + doc/man/man3/TQTextStream.3qt | 1 + doc/man/man3/TQThread.3qt | 1 + doc/man/man3/TQThreadStorage.3qt | 1 + doc/man/man3/TQTime.3qt | 1 + doc/man/man3/TQTimeEdit.3qt | 1 + doc/man/man3/TQTimer.3qt | 1 + doc/man/man3/TQTimerEvent.3qt | 1 + doc/man/man3/TQToolBar.3qt | 1 + doc/man/man3/TQToolBox.3qt | 1 + doc/man/man3/TQToolButton.3qt | 1 + doc/man/man3/TQToolTip.3qt | 1 + doc/man/man3/TQToolTipGroup.3qt | 1 + doc/man/man3/TQTranslator.3qt | 1 + doc/man/man3/TQTranslatorMessage.3qt | 1 + doc/man/man3/TQTsciiCodec.3qt | 1 + doc/man/man3/TQUriDrag.3qt | 1 + doc/man/man3/TQUrl.3qt | 1 + doc/man/man3/TQUrlInfo.3qt | 1 + doc/man/man3/TQUrlOperator.3qt | 1 + doc/man/man3/TQUuid.3qt | 1 + doc/man/man3/TQVBox.3qt | 1 + doc/man/man3/TQVBoxLayout.3qt | 1 + doc/man/man3/TQVButtonGroup.3qt | 1 + doc/man/man3/TQVGroupBox.3qt | 1 + doc/man/man3/TQValidator.3qt | 1 + doc/man/man3/TQValueList.3qt | 1 + doc/man/man3/TQValueListConstIterator.3qt | 1 + doc/man/man3/TQValueListIterator.3qt | 1 + doc/man/man3/TQValueStack.3qt | 1 + doc/man/man3/TQValueVector.3qt | 1 + doc/man/man3/TQVariant.3qt | 1 + doc/man/man3/TQWMatrix.3qt | 1 + doc/man/man3/TQWSDecoration.3qt | 1 + doc/man/man3/TQWSInputMethod.3qt | 1 + doc/man/man3/TQWSKeyboardHandler.3qt | 1 + doc/man/man3/TQWSMouseHandler.3qt | 1 + doc/man/man3/TQWSServer.3qt | 1 + doc/man/man3/TQWSWindow.3qt | 1 + doc/man/man3/TQWaitCondition.3qt | 1 + doc/man/man3/TQWhatsThis.3qt | 1 + doc/man/man3/TQWheelEvent.3qt | 1 + doc/man/man3/TQWidget.3qt | 1 + doc/man/man3/TQWidgetFactory.3qt | 1 + doc/man/man3/TQWidgetItem.3qt | 1 + doc/man/man3/TQWidgetPlugin.3qt | 1 + doc/man/man3/TQWidgetStack.3qt | 1 + doc/man/man3/TQWindowsMime.3qt | 1 + doc/man/man3/TQWindowsStyle.3qt | 1 + doc/man/man3/TQWizard.3qt | 1 + doc/man/man3/TQWorkspace.3qt | 1 + doc/man/man3/TQXmlAttributes.3qt | 1 + doc/man/man3/TQXmlContentHandler.3qt | 1 + doc/man/man3/TQXmlDTDHandler.3qt | 1 + doc/man/man3/TQXmlDeclHandler.3qt | 1 + doc/man/man3/TQXmlDefaultHandler.3qt | 1 + doc/man/man3/TQXmlEntityResolver.3qt | 1 + doc/man/man3/TQXmlErrorHandler.3qt | 1 + doc/man/man3/TQXmlInputSource.3qt | 1 + doc/man/man3/TQXmlLexicalHandler.3qt | 1 + doc/man/man3/TQXmlLocator.3qt | 1 + doc/man/man3/TQXmlNamespaceSupport.3qt | 1 + doc/man/man3/TQXmlParseException.3qt | 1 + doc/man/man3/TQXmlReader.3qt | 1 + doc/man/man3/TQXmlSimpleReader.3qt | 1 + doc/man/man3/TQt.3qt | 1 + doc/man/man3/qaccel.3qt | 324 --- doc/man/man3/qaccessible.3qt | 399 ---- doc/man/man3/qaccessibleinterface.3qt | 178 -- doc/man/man3/qaccessibleobject.3qt | 72 - doc/man/man3/qaction.3qt | 536 ----- doc/man/man3/qactiongroup.3qt | 206 -- doc/man/man3/qapplication.3qt | 1990 ----------------- doc/man/man3/qasciicache.3qt | 191 -- doc/man/man3/qasciicacheiterator.3qt | 157 -- doc/man/man3/qasciidict.3qt | 317 --- doc/man/man3/qasciidictiterator.3qt | 159 -- doc/man/man3/qassistantclient.3qt | 143 -- doc/man/man3/qaxaggregated.3qt | 143 -- doc/man/man3/qaxbase.3qt | 561 ----- doc/man/man3/qaxbindable.3qt | 152 -- doc/man/man3/qaxfactory.3qt | 436 ---- doc/man/man3/qaxobject.3qt | 183 -- doc/man/man3/qaxscript.3qt | 169 -- doc/man/man3/qaxscriptengine.3qt | 123 - doc/man/man3/qaxscriptmanager.3qt | 197 -- doc/man/man3/qaxwidget.3qt | 215 -- doc/man/man3/qbig5codec.3qt | 62 - doc/man/man3/qbig5hkscscodec.3qt | 78 - doc/man/man3/qbitarray.3qt | 372 ---- doc/man/man3/qbitmap.3qt | 159 -- doc/man/man3/qbitval.3qt | 72 - doc/man/man3/qboxlayout.3qt | 354 --- doc/man/man3/qbrush.3qt | 234 -- doc/man/man3/qbuffer.3qt | 138 -- doc/man/man3/qbutton.3qt | 490 ---- doc/man/man3/qbuttongroup.3qt | 243 -- doc/man/man3/qbytearray.3qt | 99 - doc/man/man3/qcache.3qt | 215 -- doc/man/man3/qcacheiterator.3qt | 157 -- doc/man/man3/qcanvas.3qt | 457 ---- doc/man/man3/qcanvasellipse.3qt | 145 -- doc/man/man3/qcanvasitem.3qt | 426 ---- doc/man/man3/qcanvasitemlist.3qt | 57 - doc/man/man3/qcanvasline.3qt | 94 - doc/man/man3/qcanvaspixmap.3qt | 100 - doc/man/man3/qcanvaspixmaparray.3qt | 156 -- doc/man/man3/qcanvaspolygon.3qt | 114 - doc/man/man3/qcanvaspolygonalitem.3qt | 193 -- doc/man/man3/qcanvasrectangle.3qt | 129 -- doc/man/man3/qcanvasspline.3qt | 102 - doc/man/man3/qcanvassprite.3qt | 263 --- doc/man/man3/qcanvastext.3qt | 160 -- doc/man/man3/qcanvasview.3qt | 188 -- doc/man/man3/qcdestyle.3qt | 64 - doc/man/man3/qchar.3qt | 490 ---- doc/man/man3/qcharref.3qt | 48 - doc/man/man3/qcheckbox.3qt | 308 --- doc/man/man3/qchecklistitem.3qt | 229 -- doc/man/man3/qchecktableitem.3qt | 94 - doc/man/man3/qchildevent.3qt | 78 - doc/man/man3/qclipboard.3qt | 357 --- doc/man/man3/qcloseevent.3qt | 110 - doc/man/man3/qcolor.3qt | 592 ----- doc/man/man3/qcolordialog.3qt | 80 - doc/man/man3/qcolordrag.3qt | 82 - doc/man/man3/qcolorgroup.3qt | 358 --- doc/man/man3/qcombobox.3qt | 603 ----- doc/man/man3/qcombotableitem.3qt | 156 -- doc/man/man3/qcommonstyle.3qt | 59 - doc/man/man3/qconststring.3qt | 70 - doc/man/man3/qcontextmenuevent.3qt | 187 -- doc/man/man3/qcopchannel.3qt | 170 -- doc/man/man3/qcstring.3qt | 1138 ---------- doc/man/man3/qcursor.3qt | 253 --- doc/man/man3/qcustomevent.3qt | 130 -- doc/man/man3/qcustommenuitem.3qt | 106 - doc/man/man3/qdatabrowser.3qt | 593 ----- doc/man/man3/qdatastream.3qt | 563 ----- doc/man/man3/qdatatable.3qt | 700 ------ doc/man/man3/qdataview.3qt | 129 -- doc/man/man3/qdate.3qt | 429 ---- doc/man/man3/qdateedit.3qt | 292 --- doc/man/man3/qdatetime.3qt | 337 --- doc/man/man3/qdatetimeedit.3qt | 146 -- doc/man/man3/qdatetimeeditbase.3qt | 48 - doc/man/man3/qdeepcopy.3qt | 190 -- doc/man/man3/qdesktopwidget.3qt | 190 -- doc/man/man3/qdial.3qt | 365 --- doc/man/man3/qdialog.3qt | 322 --- doc/man/man3/qdict.3qt | 374 ---- doc/man/man3/qdictiterator.3qt | 153 -- doc/man/man3/qdir.3qt | 807 ------- doc/man/man3/qdirectpainter.3qt | 178 -- doc/man/man3/qdns.3qt | 331 --- doc/man/man3/qdockarea.3qt | 233 -- doc/man/man3/qdockwindow.3qt | 470 ---- doc/man/man3/qdomattr.3qt | 153 -- doc/man/man3/qdomcdatasection.3qt | 96 - doc/man/man3/qdomcharacterdata.3qt | 140 -- doc/man/man3/qdomcomment.3qt | 101 - doc/man/man3/qdomdocument.3qt | 448 ---- doc/man/man3/qdomdocumentfragment.3qt | 100 - doc/man/man3/qdomdocumenttype.3qt | 132 -- doc/man/man3/qdomelement.3qt | 335 --- doc/man/man3/qdomentity.3qt | 114 - doc/man/man3/qdomentityreference.3qt | 100 - doc/man/man3/qdomimplementation.3qt | 126 -- doc/man/man3/qdomnamednodemap.3qt | 172 -- doc/man/man3/qdomnode.3qt | 733 ------ doc/man/man3/qdomnodelist.3qt | 108 - doc/man/man3/qdomnotation.3qt | 108 - doc/man/man3/qdomprocessinginstruction.3qt | 115 - doc/man/man3/qdomtext.3qt | 107 - doc/man/man3/qdoublevalidator.3qt | 146 -- doc/man/man3/qdragenterevent.3qt | 58 - doc/man/man3/qdragleaveevent.3qt | 58 - doc/man/man3/qdragmoveevent.3qt | 83 - doc/man/man3/qdragobject.3qt | 182 -- doc/man/man3/qdropevent.3qt | 189 -- doc/man/man3/qeditorfactory.3qt | 85 - doc/man/man3/qerrormessage.3qt | 94 - doc/man/man3/qeucjpcodec.3qt | 90 - doc/man/man3/qeuckrcodec.3qt | 71 - doc/man/man3/qevent.3qt | 238 -- doc/man/man3/qeventloop.3qt | 240 -- doc/man/man3/qfile.3qt | 526 ----- doc/man/man3/qfiledialog.3qt | 1025 --------- doc/man/man3/qfileiconprovider.3qt | 68 - doc/man/man3/qfileinfo.3qt | 537 ----- doc/man/man3/qfilepreview.3qt | 66 - doc/man/man3/qfocusdata.3qt | 92 - doc/man/man3/qfocusevent.3qt | 117 - doc/man/man3/qfont.3qt | 906 -------- doc/man/man3/qfontdatabase.3qt | 303 --- doc/man/man3/qfontdialog.3qt | 163 -- doc/man/man3/qfontinfo.3qt | 175 -- doc/man/man3/qfontmanager.3qt | 76 - doc/man/man3/qfontmetrics.3qt | 416 ---- doc/man/man3/qframe.3qt | 405 ---- doc/man/man3/qftp.3qt | 649 ------ doc/man/man3/qgb18030codec.3qt | 80 - doc/man/man3/qgb2312codec.3qt | 48 - doc/man/man3/qgbkcodec.3qt | 52 - doc/man/man3/qgfxdriverfactory.3qt | 59 - doc/man/man3/qgfxdriverplugin.3qt | 78 - doc/man/man3/qgl.3qt | 95 - doc/man/man3/qglayoutiterator.3qt | 81 - doc/man/man3/qglcolormap.3qt | 166 -- doc/man/man3/qglcontext.3qt | 273 --- doc/man/man3/qglformat.3qt | 511 ----- doc/man/man3/qglwidget.3qt | 512 ----- doc/man/man3/qgrid.3qt | 75 - doc/man/man3/qgridlayout.3qt | 390 ---- doc/man/man3/qgridview.3qt | 245 -- doc/man/man3/qgroupbox.3qt | 329 --- doc/man/man3/qguardedptr.3qt | 148 -- doc/man/man3/qhbox.3qt | 92 - doc/man/man3/qhboxlayout.3qt | 112 - doc/man/man3/qhbuttongroup.3qt | 75 - doc/man/man3/qheader.3qt | 584 ----- doc/man/man3/qhebrewcodec.3qt | 78 - doc/man/man3/qhgroupbox.3qt | 75 - doc/man/man3/qhideevent.3qt | 57 - doc/man/man3/qhostaddress.3qt | 188 -- doc/man/man3/qhttp.3qt | 542 ----- doc/man/man3/qhttpheader.3qt | 210 -- doc/man/man3/qhttprequestheader.3qt | 137 -- doc/man/man3/qhttpresponseheader.3qt | 94 - doc/man/man3/qicondrag.3qt | 96 - doc/man/man3/qicondragevent.3qt | 86 - doc/man/man3/qicondragitem.3qt | 76 - doc/man/man3/qiconfactory.3qt | 98 - doc/man/man3/qiconset.3qt | 284 --- doc/man/man3/qiconview.3qt | 961 -------- doc/man/man3/qiconviewitem.3qt | 576 ----- doc/man/man3/qimage.3qt | 1095 --------- doc/man/man3/qimageconsumer.3qt | 108 - doc/man/man3/qimagedecoder.3qt | 111 - doc/man/man3/qimagedrag.3qt | 105 - doc/man/man3/qimageformat.3qt | 63 - doc/man/man3/qimageformatplugin.3qt | 76 - doc/man/man3/qimageformattype.3qt | 78 - doc/man/man3/qimageio.3qt | 365 --- doc/man/man3/qimevent.3qt | 127 -- doc/man/man3/qinputdialog.3qt | 201 -- doc/man/man3/qintcache.3qt | 185 -- doc/man/man3/qintcacheiterator.3qt | 157 -- doc/man/man3/qintdict.3qt | 315 --- doc/man/man3/qintdictiterator.3qt | 157 -- doc/man/man3/qintvalidator.3qt | 203 -- doc/man/man3/qiodevice.3qt | 551 ----- doc/man/man3/qjiscodec.3qt | 96 - doc/man/man3/qkbddriverfactory.3qt | 59 - doc/man/man3/qkbddriverplugin.3qt | 78 - doc/man/man3/qkeyevent.3qt | 155 -- doc/man/man3/qkeysequence.3qt | 169 -- doc/man/man3/qlabel.3qt | 435 ---- doc/man/man3/qlayout.3qt | 408 ---- doc/man/man3/qlayoutitem.3qt | 226 -- doc/man/man3/qlayoutiterator.3qt | 140 -- doc/man/man3/qlcdnumber.3qt | 335 --- doc/man/man3/qlibrary.3qt | 280 --- doc/man/man3/qlineedit.3qt | 778 ------- doc/man/man3/qlistbox.3qt | 1110 --------- doc/man/man3/qlistboxitem.3qt | 203 -- doc/man/man3/qlistboxpixmap.3qt | 120 - doc/man/man3/qlistboxtext.3qt | 98 - doc/man/man3/qlistview.3qt | 1108 --------- doc/man/man3/qlistviewitem.3qt | 724 ------ doc/man/man3/qlistviewitemiterator.3qt | 218 -- doc/man/man3/qlocale.3qt | 1249 ----------- doc/man/man3/qlocalfs.3qt | 67 - doc/man/man3/qmacmime.3qt | 150 -- doc/man/man3/qmacstyle.3qt | 135 -- doc/man/man3/qmainwindow.3qt | 845 ------- doc/man/man3/qmap.3qt | 554 ----- doc/man/man3/qmapconstiterator.3qt | 141 -- doc/man/man3/qmapiterator.3qt | 152 -- doc/man/man3/qmemarray.3qt | 571 ----- doc/man/man3/qmenubar.3qt | 588 ----- doc/man/man3/qmenudata.3qt | 707 ------ doc/man/man3/qmessagebox.3qt | 858 ------- doc/man/man3/qmetaobject.3qt | 184 -- doc/man/man3/qmetaproperty.3qt | 151 -- doc/man/man3/qmimesource.3qt | 94 - doc/man/man3/qmimesourcefactory.3qt | 233 -- doc/man/man3/qmotif.3qt | 114 - doc/man/man3/qmotifdialog.3qt | 178 -- doc/man/man3/qmotifplusstyle.3qt | 59 - doc/man/man3/qmotifstyle.3qt | 76 - doc/man/man3/qmotifwidget.3qt | 86 - doc/man/man3/qmousedriverfactory.3qt | 59 - doc/man/man3/qmousedriverplugin.3qt | 78 - doc/man/man3/qmouseevent.3qt | 199 -- doc/man/man3/qmoveevent.3qt | 68 - doc/man/man3/qmovie.3qt | 322 --- doc/man/man3/qmutex.3qt | 213 -- doc/man/man3/qmutexlocker.3qt | 273 --- doc/man/man3/qnetworkoperation.3qt | 145 -- doc/man/man3/qnetworkprotocol.3qt | 386 ---- doc/man/man3/qnpinstance.3qt | 290 --- doc/man/man3/qnplugin.3qt | 157 -- doc/man/man3/qnpstream.3qt | 114 - doc/man/man3/qnpwidget.3qt | 129 -- doc/man/man3/qobject.3qt | 1002 --------- doc/man/man3/qobjectcleanuphandler.3qt | 152 -- doc/man/man3/qobjectlist.3qt | 81 - doc/man/man3/qobjectlistiterator.3qt | 63 - doc/man/man3/qpaintdevice.3qt | 384 ---- doc/man/man3/qpaintdevicemetrics.3qt | 116 - doc/man/man3/qpainter.3qt | 1709 -------------- doc/man/man3/qpaintevent.3qt | 94 - doc/man/man3/qpair.3qt | 100 - doc/man/man3/qpalette.3qt | 293 --- doc/man/man3/qpen.3qt | 287 --- doc/man/man3/qpicture.3qt | 255 --- doc/man/man3/qpixmap.3qt | 788 ------- doc/man/man3/qpixmapcache.3qt | 145 -- doc/man/man3/qplatinumstyle.3qt | 68 - doc/man/man3/qpngimagepacker.3qt | 72 - doc/man/man3/qpoint.3qt | 377 ---- doc/man/man3/qpointarray.3qt | 277 --- doc/man/man3/qpopupmenu.3qt | 810 ------- doc/man/man3/qprinter.3qt | 734 ------ doc/man/man3/qprocess.3qt | 521 ----- doc/man/man3/qprogressbar.3qt | 238 -- doc/man/man3/qprogressdialog.3qt | 430 ---- doc/man/man3/qptrcollection.3qt | 145 -- doc/man/man3/qptrdict.3qt | 315 --- doc/man/man3/qptrdictiterator.3qt | 168 -- doc/man/man3/qptrlist.3qt | 718 ------ doc/man/man3/qptrlistiterator.3qt | 210 -- doc/man/man3/qptrqueue.3qt | 186 -- doc/man/man3/qptrstack.3qt | 164 -- doc/man/man3/qptrvector.3qt | 351 --- doc/man/man3/qpushbutton.3qt | 468 ---- doc/man/man3/qradiobutton.3qt | 278 --- doc/man/man3/qrangecontrol.3qt | 294 --- doc/man/man3/qrect.3qt | 662 ------ doc/man/man3/qregexp.3qt | 855 ------- doc/man/man3/qregexpvalidator.3qt | 179 -- doc/man/man3/qregion.3qt | 388 ---- doc/man/man3/qresizeevent.3qt | 70 - doc/man/man3/qscreen.3qt | 329 --- doc/man/man3/qscrollbar.3qt | 360 --- doc/man/man3/qscrollview.3qt | 913 -------- doc/man/man3/qsemaphore.3qt | 110 - doc/man/man3/qserversocket.3qt | 142 -- doc/man/man3/qsessionmanager.3qt | 314 --- doc/man/man3/qsettings.3qt | 654 ------ doc/man/man3/qsgistyle.3qt | 64 - doc/man/man3/qshowevent.3qt | 55 - doc/man/man3/qsignal.3qt | 197 -- doc/man/man3/qsignalmapper.3qt | 118 - doc/man/man3/qsimplerichtext.3qt | 182 -- doc/man/man3/qsize.3qt | 370 --- doc/man/man3/qsizegrip.3qt | 100 - doc/man/man3/qsizepolicy.3qt | 238 -- doc/man/man3/qsjiscodec.3qt | 83 - doc/man/man3/qslider.3qt | 390 ---- doc/man/man3/qsocket.3qt | 471 ---- doc/man/man3/qsocketdevice.3qt | 373 ---- doc/man/man3/qsocketnotifier.3qt | 157 -- doc/man/man3/qsound.3qt | 167 -- doc/man/man3/qspaceritem.3qt | 108 - doc/man/man3/qspinbox.3qt | 572 ----- doc/man/man3/qsplashscreen.3qt | 182 -- doc/man/man3/qsplitter.3qt | 332 --- doc/man/man3/qsql.3qt | 111 - doc/man/man3/qsqlcursor.3qt | 661 ------ doc/man/man3/qsqldatabase.3qt | 666 ------ doc/man/man3/qsqldriver.3qt | 253 --- doc/man/man3/qsqldriverplugin.3qt | 78 - doc/man/man3/qsqleditorfactory.3qt | 93 - doc/man/man3/qsqlerror.3qt | 142 -- doc/man/man3/qsqlfield.3qt | 199 -- doc/man/man3/qsqlfieldinfo.3qt | 175 -- doc/man/man3/qsqlform.3qt | 244 -- doc/man/man3/qsqlindex.3qt | 126 -- doc/man/man3/qsqlpropertymap.3qt | 172 -- doc/man/man3/qsqlquery.3qt | 567 ----- doc/man/man3/qsqlrecord.3qt | 268 --- doc/man/man3/qsqlrecordinfo.3qt | 79 - doc/man/man3/qsqlresult.3qt | 189 -- doc/man/man3/qsqlselectcursor.3qt | 91 - doc/man/man3/qstatusbar.3qt | 209 -- doc/man/man3/qstoreddrag.3qt | 83 - doc/man/man3/qstrilist.3qt | 64 - doc/man/man3/qstring.3qt | 2553 --------------------- doc/man/man3/qstringlist.3qt | 336 --- doc/man/man3/qstrlist.3qt | 92 - doc/man/man3/qstrlistiterator.3qt | 46 - doc/man/man3/qstyle.3qt | 1089 --------- doc/man/man3/qstylefactory.3qt | 61 - doc/man/man3/qstyleoption.3qt | 222 -- doc/man/man3/qstyleplugin.3qt | 78 - doc/man/man3/qstylesheet.3qt | 224 -- doc/man/man3/qstylesheetitem.3qt | 484 ---- doc/man/man3/qsyntaxhighlighter.3qt | 120 - doc/man/man3/qt.3qt | 1451 ------------ doc/man/man3/qtab.3qt | 120 - doc/man/man3/qtabbar.3qt | 332 --- doc/man/man3/qtabdialog.3qt | 464 ---- doc/man/man3/qtable.3qt | 1382 ------------ doc/man/man3/qtableitem.3qt | 466 ---- doc/man/man3/qtableselection.3qt | 158 -- doc/man/man3/qtabletevent.3qt | 192 -- doc/man/man3/qtabwidget.3qt | 424 ---- doc/man/man3/qtextbrowser.3qt | 231 -- doc/man/man3/qtextcodec.3qt | 586 ----- doc/man/man3/qtextcodecplugin.3qt | 96 - doc/man/man3/qtextdecoder.3qt | 64 - doc/man/man3/qtextdrag.3qt | 110 - doc/man/man3/qtextedit.3qt | 1452 ------------ doc/man/man3/qtextencoder.3qt | 65 - doc/man/man3/qtextistream.3qt | 79 - doc/man/man3/qtextostream.3qt | 77 - doc/man/man3/qtextstream.3qt | 642 ------ doc/man/man3/qthread.3qt | 230 -- doc/man/man3/qthreadstorage.3qt | 166 -- doc/man/man3/qtime.3qt | 372 ---- doc/man/man3/qtimeedit.3qt | 256 --- doc/man/man3/qtimer.3qt | 196 -- doc/man/man3/qtimerevent.3qt | 66 - doc/man/man3/qtoolbar.3qt | 163 -- doc/man/man3/qtoolbox.3qt | 211 -- doc/man/man3/qtoolbutton.3qt | 419 ---- doc/man/man3/qtooltip.3qt | 354 --- doc/man/man3/qtooltipgroup.3qt | 154 -- doc/man/man3/qtranslator.3qt | 297 --- doc/man/man3/qtranslatormessage.3qt | 185 -- doc/man/man3/qtsciicodec.3qt | 62 - doc/man/man3/quridrag.3qt | 168 -- doc/man/man3/qurl.3qt | 496 ----- doc/man/man3/qurlinfo.3qt | 366 --- doc/man/man3/qurloperator.3qt | 379 ---- doc/man/man3/quuid.3qt | 203 -- doc/man/man3/qvalidator.3qt | 112 - doc/man/man3/qvaluelist.3qt | 756 ------- doc/man/man3/qvaluelistconstiterator.3qt | 127 -- doc/man/man3/qvaluelistiterator.3qt | 172 -- doc/man/man3/qvaluestack.3qt | 141 -- doc/man/man3/qvaluevector.3qt | 635 ------ doc/man/man3/qvariant.3qt | 1155 ---------- doc/man/man3/qvbox.3qt | 62 - doc/man/man3/qvboxlayout.3qt | 96 - doc/man/man3/qvbuttongroup.3qt | 75 - doc/man/man3/qvgroupbox.3qt | 75 - doc/man/man3/qwaitcondition.3qt | 202 -- doc/man/man3/qwhatsthis.3qt | 207 -- doc/man/man3/qwheelevent.3qt | 160 -- doc/man/man3/qwidget.3qt | 3219 --------------------------- doc/man/man3/qwidgetfactory.3qt | 135 -- doc/man/man3/qwidgetitem.3qt | 104 - doc/man/man3/qwidgetplugin.3qt | 124 -- doc/man/man3/qwidgetstack.3qt | 166 -- doc/man/man3/qwindowsmime.3qt | 157 -- doc/man/man3/qwindowsstyle.3qt | 57 - doc/man/man3/qwizard.3qt | 289 --- doc/man/man3/qwmatrix.3qt | 473 ---- doc/man/man3/qworkspace.3qt | 196 -- doc/man/man3/qwsdecoration.3qt | 156 -- doc/man/man3/qwsinputmethod.3qt | 105 - doc/man/man3/qwskeyboardhandler.3qt | 77 - doc/man/man3/qwsmousehandler.3qt | 89 - doc/man/man3/qwsserver.3qt | 311 --- doc/man/man3/qwswindow.3qt | 140 -- doc/man/man3/qxmlattributes.3qt | 189 -- doc/man/man3/qxmlcontenthandler.3qt | 184 -- doc/man/man3/qxmldeclhandler.3qt | 92 - doc/man/man3/qxmldefaulthandler.3qt | 64 - doc/man/man3/qxmldtdhandler.3qt | 81 - doc/man/man3/qxmlentityresolver.3qt | 72 - doc/man/man3/qxmlerrorhandler.3qt | 88 - doc/man/man3/qxmlinputsource.3qt | 156 -- doc/man/man3/qxmllexicalhandler.3qt | 134 -- doc/man/man3/qxmllocator.3qt | 71 - doc/man/man3/qxmlnamespacesupport.3qt | 180 -- doc/man/man3/qxmlparseexception.3qt | 80 - doc/man/man3/qxmlreader.3qt | 206 -- doc/man/man3/qxmlsimplereader.3qt | 142 -- doc/man/man3/tqaccel.3qt | 324 +++ doc/man/man3/tqaccessible.3qt | 399 ++++ doc/man/man3/tqaccessibleinterface.3qt | 178 ++ doc/man/man3/tqaccessibleobject.3qt | 72 + doc/man/man3/tqaction.3qt | 536 +++++ doc/man/man3/tqactiongroup.3qt | 206 ++ doc/man/man3/tqapplication.3qt | 1990 +++++++++++++++++ doc/man/man3/tqasciicache.3qt | 191 ++ doc/man/man3/tqasciicacheiterator.3qt | 157 ++ doc/man/man3/tqasciidict.3qt | 317 +++ doc/man/man3/tqasciidictiterator.3qt | 159 ++ doc/man/man3/tqassistantclient.3qt | 143 ++ doc/man/man3/tqaxaggregated.3qt | 143 ++ doc/man/man3/tqaxbase.3qt | 561 +++++ doc/man/man3/tqaxbindable.3qt | 152 ++ doc/man/man3/tqaxfactory.3qt | 436 ++++ doc/man/man3/tqaxobject.3qt | 183 ++ doc/man/man3/tqaxscript.3qt | 169 ++ doc/man/man3/tqaxscriptengine.3qt | 123 + doc/man/man3/tqaxscriptmanager.3qt | 197 ++ doc/man/man3/tqaxwidget.3qt | 215 ++ doc/man/man3/tqbig5codec.3qt | 62 + doc/man/man3/tqbig5hkscscodec.3qt | 78 + doc/man/man3/tqbitarray.3qt | 372 ++++ doc/man/man3/tqbitmap.3qt | 159 ++ doc/man/man3/tqbitval.3qt | 72 + doc/man/man3/tqboxlayout.3qt | 354 +++ doc/man/man3/tqbrush.3qt | 234 ++ doc/man/man3/tqbuffer.3qt | 138 ++ doc/man/man3/tqbutton.3qt | 490 ++++ doc/man/man3/tqbuttongroup.3qt | 243 ++ doc/man/man3/tqbytearray.3qt | 99 + doc/man/man3/tqcache.3qt | 215 ++ doc/man/man3/tqcacheiterator.3qt | 157 ++ doc/man/man3/tqcanvas.3qt | 457 ++++ doc/man/man3/tqcanvasellipse.3qt | 145 ++ doc/man/man3/tqcanvasitem.3qt | 426 ++++ doc/man/man3/tqcanvasitemlist.3qt | 57 + doc/man/man3/tqcanvasline.3qt | 94 + doc/man/man3/tqcanvaspixmap.3qt | 100 + doc/man/man3/tqcanvaspixmaparray.3qt | 156 ++ doc/man/man3/tqcanvaspolygon.3qt | 114 + doc/man/man3/tqcanvaspolygonalitem.3qt | 193 ++ doc/man/man3/tqcanvasrectangle.3qt | 129 ++ doc/man/man3/tqcanvasspline.3qt | 102 + doc/man/man3/tqcanvassprite.3qt | 263 +++ doc/man/man3/tqcanvastext.3qt | 160 ++ doc/man/man3/tqcanvasview.3qt | 188 ++ doc/man/man3/tqcdestyle.3qt | 64 + doc/man/man3/tqchar.3qt | 490 ++++ doc/man/man3/tqcharref.3qt | 48 + doc/man/man3/tqcheckbox.3qt | 308 +++ doc/man/man3/tqchecklistitem.3qt | 229 ++ doc/man/man3/tqchecktableitem.3qt | 94 + doc/man/man3/tqchildevent.3qt | 78 + doc/man/man3/tqclipboard.3qt | 357 +++ doc/man/man3/tqcloseevent.3qt | 110 + doc/man/man3/tqcolor.3qt | 592 +++++ doc/man/man3/tqcolordialog.3qt | 80 + doc/man/man3/tqcolordrag.3qt | 82 + doc/man/man3/tqcolorgroup.3qt | 358 +++ doc/man/man3/tqcombobox.3qt | 603 +++++ doc/man/man3/tqcombotableitem.3qt | 156 ++ doc/man/man3/tqcommonstyle.3qt | 59 + doc/man/man3/tqconststring.3qt | 70 + doc/man/man3/tqcontextmenuevent.3qt | 187 ++ doc/man/man3/tqcopchannel.3qt | 170 ++ doc/man/man3/tqcstring.3qt | 1138 ++++++++++ doc/man/man3/tqcursor.3qt | 253 +++ doc/man/man3/tqcustomevent.3qt | 130 ++ doc/man/man3/tqcustommenuitem.3qt | 106 + doc/man/man3/tqdatabrowser.3qt | 593 +++++ doc/man/man3/tqdatastream.3qt | 563 +++++ doc/man/man3/tqdatatable.3qt | 700 ++++++ doc/man/man3/tqdataview.3qt | 129 ++ doc/man/man3/tqdate.3qt | 429 ++++ doc/man/man3/tqdateedit.3qt | 292 +++ doc/man/man3/tqdatetime.3qt | 337 +++ doc/man/man3/tqdatetimeedit.3qt | 146 ++ doc/man/man3/tqdatetimeeditbase.3qt | 48 + doc/man/man3/tqdeepcopy.3qt | 190 ++ doc/man/man3/tqdesktopwidget.3qt | 190 ++ doc/man/man3/tqdial.3qt | 365 +++ doc/man/man3/tqdialog.3qt | 322 +++ doc/man/man3/tqdict.3qt | 374 ++++ doc/man/man3/tqdictiterator.3qt | 153 ++ doc/man/man3/tqdir.3qt | 807 +++++++ doc/man/man3/tqdirectpainter.3qt | 178 ++ doc/man/man3/tqdns.3qt | 331 +++ doc/man/man3/tqdockarea.3qt | 233 ++ doc/man/man3/tqdockwindow.3qt | 470 ++++ doc/man/man3/tqdomattr.3qt | 153 ++ doc/man/man3/tqdomcdatasection.3qt | 96 + doc/man/man3/tqdomcharacterdata.3qt | 140 ++ doc/man/man3/tqdomcomment.3qt | 101 + doc/man/man3/tqdomdocument.3qt | 448 ++++ doc/man/man3/tqdomdocumentfragment.3qt | 100 + doc/man/man3/tqdomdocumenttype.3qt | 132 ++ doc/man/man3/tqdomelement.3qt | 335 +++ doc/man/man3/tqdomentity.3qt | 114 + doc/man/man3/tqdomentityreference.3qt | 100 + doc/man/man3/tqdomimplementation.3qt | 126 ++ doc/man/man3/tqdomnamednodemap.3qt | 172 ++ doc/man/man3/tqdomnode.3qt | 733 ++++++ doc/man/man3/tqdomnodelist.3qt | 108 + doc/man/man3/tqdomnotation.3qt | 108 + doc/man/man3/tqdomprocessinginstruction.3qt | 115 + doc/man/man3/tqdomtext.3qt | 107 + doc/man/man3/tqdoublevalidator.3qt | 146 ++ doc/man/man3/tqdragenterevent.3qt | 58 + doc/man/man3/tqdragleaveevent.3qt | 58 + doc/man/man3/tqdragmoveevent.3qt | 83 + doc/man/man3/tqdragobject.3qt | 182 ++ doc/man/man3/tqdropevent.3qt | 189 ++ doc/man/man3/tqeditorfactory.3qt | 85 + doc/man/man3/tqerrormessage.3qt | 94 + doc/man/man3/tqeucjpcodec.3qt | 90 + doc/man/man3/tqeuckrcodec.3qt | 71 + doc/man/man3/tqevent.3qt | 238 ++ doc/man/man3/tqeventloop.3qt | 240 ++ doc/man/man3/tqfile.3qt | 526 +++++ doc/man/man3/tqfiledialog.3qt | 1025 +++++++++ doc/man/man3/tqfileiconprovider.3qt | 68 + doc/man/man3/tqfileinfo.3qt | 537 +++++ doc/man/man3/tqfilepreview.3qt | 66 + doc/man/man3/tqfocusdata.3qt | 92 + doc/man/man3/tqfocusevent.3qt | 117 + doc/man/man3/tqfont.3qt | 906 ++++++++ doc/man/man3/tqfontdatabase.3qt | 303 +++ doc/man/man3/tqfontdialog.3qt | 163 ++ doc/man/man3/tqfontinfo.3qt | 175 ++ doc/man/man3/tqfontmanager.3qt | 76 + doc/man/man3/tqfontmetrics.3qt | 416 ++++ doc/man/man3/tqframe.3qt | 405 ++++ doc/man/man3/tqftp.3qt | 649 ++++++ doc/man/man3/tqgb18030codec.3qt | 80 + doc/man/man3/tqgb2312codec.3qt | 48 + doc/man/man3/tqgbkcodec.3qt | 52 + doc/man/man3/tqgfxdriverfactory.3qt | 59 + doc/man/man3/tqgfxdriverplugin.3qt | 78 + doc/man/man3/tqgl.3qt | 95 + doc/man/man3/tqglayoutiterator.3qt | 81 + doc/man/man3/tqglcolormap.3qt | 166 ++ doc/man/man3/tqglcontext.3qt | 273 +++ doc/man/man3/tqglformat.3qt | 511 +++++ doc/man/man3/tqglwidget.3qt | 512 +++++ doc/man/man3/tqgrid.3qt | 75 + doc/man/man3/tqgridlayout.3qt | 390 ++++ doc/man/man3/tqgridview.3qt | 245 ++ doc/man/man3/tqgroupbox.3qt | 329 +++ doc/man/man3/tqguardedptr.3qt | 148 ++ doc/man/man3/tqhbox.3qt | 92 + doc/man/man3/tqhboxlayout.3qt | 112 + doc/man/man3/tqhbuttongroup.3qt | 75 + doc/man/man3/tqheader.3qt | 584 +++++ doc/man/man3/tqhebrewcodec.3qt | 78 + doc/man/man3/tqhgroupbox.3qt | 75 + doc/man/man3/tqhideevent.3qt | 57 + doc/man/man3/tqhostaddress.3qt | 188 ++ doc/man/man3/tqhttp.3qt | 542 +++++ doc/man/man3/tqhttpheader.3qt | 210 ++ doc/man/man3/tqhttprequestheader.3qt | 137 ++ doc/man/man3/tqhttpresponseheader.3qt | 94 + doc/man/man3/tqicondrag.3qt | 96 + doc/man/man3/tqicondragevent.3qt | 86 + doc/man/man3/tqicondragitem.3qt | 76 + doc/man/man3/tqiconfactory.3qt | 98 + doc/man/man3/tqiconset.3qt | 284 +++ doc/man/man3/tqiconview.3qt | 961 ++++++++ doc/man/man3/tqiconviewitem.3qt | 576 +++++ doc/man/man3/tqimage.3qt | 1095 +++++++++ doc/man/man3/tqimageconsumer.3qt | 108 + doc/man/man3/tqimagedecoder.3qt | 111 + doc/man/man3/tqimagedrag.3qt | 105 + doc/man/man3/tqimageformat.3qt | 63 + doc/man/man3/tqimageformatplugin.3qt | 76 + doc/man/man3/tqimageformattype.3qt | 78 + doc/man/man3/tqimageio.3qt | 365 +++ doc/man/man3/tqimevent.3qt | 127 ++ doc/man/man3/tqinputdialog.3qt | 201 ++ doc/man/man3/tqintcache.3qt | 185 ++ doc/man/man3/tqintcacheiterator.3qt | 157 ++ doc/man/man3/tqintdict.3qt | 315 +++ doc/man/man3/tqintdictiterator.3qt | 157 ++ doc/man/man3/tqintvalidator.3qt | 203 ++ doc/man/man3/tqiodevice.3qt | 551 +++++ doc/man/man3/tqjiscodec.3qt | 96 + doc/man/man3/tqkbddriverfactory.3qt | 59 + doc/man/man3/tqkbddriverplugin.3qt | 78 + doc/man/man3/tqkeyevent.3qt | 155 ++ doc/man/man3/tqkeysequence.3qt | 169 ++ doc/man/man3/tqlabel.3qt | 435 ++++ doc/man/man3/tqlayout.3qt | 408 ++++ doc/man/man3/tqlayoutitem.3qt | 226 ++ doc/man/man3/tqlayoutiterator.3qt | 140 ++ doc/man/man3/tqlcdnumber.3qt | 335 +++ doc/man/man3/tqlibrary.3qt | 280 +++ doc/man/man3/tqlineedit.3qt | 778 +++++++ doc/man/man3/tqlistbox.3qt | 1110 +++++++++ doc/man/man3/tqlistboxitem.3qt | 203 ++ doc/man/man3/tqlistboxpixmap.3qt | 120 + doc/man/man3/tqlistboxtext.3qt | 98 + doc/man/man3/tqlistview.3qt | 1108 +++++++++ doc/man/man3/tqlistviewitem.3qt | 724 ++++++ doc/man/man3/tqlistviewitemiterator.3qt | 218 ++ doc/man/man3/tqlocale.3qt | 1249 +++++++++++ doc/man/man3/tqlocalfs.3qt | 67 + doc/man/man3/tqmacmime.3qt | 150 ++ doc/man/man3/tqmacstyle.3qt | 135 ++ doc/man/man3/tqmainwindow.3qt | 845 +++++++ doc/man/man3/tqmap.3qt | 554 +++++ doc/man/man3/tqmapconstiterator.3qt | 141 ++ doc/man/man3/tqmapiterator.3qt | 152 ++ doc/man/man3/tqmemarray.3qt | 571 +++++ doc/man/man3/tqmenubar.3qt | 588 +++++ doc/man/man3/tqmenudata.3qt | 707 ++++++ doc/man/man3/tqmessagebox.3qt | 858 +++++++ doc/man/man3/tqmetaobject.3qt | 184 ++ doc/man/man3/tqmetaproperty.3qt | 151 ++ doc/man/man3/tqmimesource.3qt | 94 + doc/man/man3/tqmimesourcefactory.3qt | 233 ++ doc/man/man3/tqmotif.3qt | 114 + doc/man/man3/tqmotifdialog.3qt | 178 ++ doc/man/man3/tqmotifplusstyle.3qt | 59 + doc/man/man3/tqmotifstyle.3qt | 76 + doc/man/man3/tqmotifwidget.3qt | 86 + doc/man/man3/tqmousedriverfactory.3qt | 59 + doc/man/man3/tqmousedriverplugin.3qt | 78 + doc/man/man3/tqmouseevent.3qt | 199 ++ doc/man/man3/tqmoveevent.3qt | 68 + doc/man/man3/tqmovie.3qt | 322 +++ doc/man/man3/tqmutex.3qt | 213 ++ doc/man/man3/tqmutexlocker.3qt | 273 +++ doc/man/man3/tqnetworkoperation.3qt | 145 ++ doc/man/man3/tqnetworkprotocol.3qt | 386 ++++ doc/man/man3/tqnpinstance.3qt | 290 +++ doc/man/man3/tqnplugin.3qt | 157 ++ doc/man/man3/tqnpstream.3qt | 114 + doc/man/man3/tqnpwidget.3qt | 129 ++ doc/man/man3/tqobject.3qt | 1002 +++++++++ doc/man/man3/tqobjectcleanuphandler.3qt | 152 ++ doc/man/man3/tqobjectlist.3qt | 81 + doc/man/man3/tqobjectlistiterator.3qt | 63 + doc/man/man3/tqpaintdevice.3qt | 384 ++++ doc/man/man3/tqpaintdevicemetrics.3qt | 116 + doc/man/man3/tqpainter.3qt | 1709 ++++++++++++++ doc/man/man3/tqpaintevent.3qt | 94 + doc/man/man3/tqpair.3qt | 100 + doc/man/man3/tqpalette.3qt | 293 +++ doc/man/man3/tqpen.3qt | 287 +++ doc/man/man3/tqpicture.3qt | 255 +++ doc/man/man3/tqpixmap.3qt | 788 +++++++ doc/man/man3/tqpixmapcache.3qt | 145 ++ doc/man/man3/tqplatinumstyle.3qt | 68 + doc/man/man3/tqpngimagepacker.3qt | 72 + doc/man/man3/tqpoint.3qt | 377 ++++ doc/man/man3/tqpointarray.3qt | 277 +++ doc/man/man3/tqpopupmenu.3qt | 810 +++++++ doc/man/man3/tqprinter.3qt | 734 ++++++ doc/man/man3/tqprocess.3qt | 521 +++++ doc/man/man3/tqprogressbar.3qt | 238 ++ doc/man/man3/tqprogressdialog.3qt | 430 ++++ doc/man/man3/tqptrcollection.3qt | 145 ++ doc/man/man3/tqptrdict.3qt | 315 +++ doc/man/man3/tqptrdictiterator.3qt | 168 ++ doc/man/man3/tqptrlist.3qt | 718 ++++++ doc/man/man3/tqptrlistiterator.3qt | 210 ++ doc/man/man3/tqptrqueue.3qt | 186 ++ doc/man/man3/tqptrstack.3qt | 164 ++ doc/man/man3/tqptrvector.3qt | 351 +++ doc/man/man3/tqpushbutton.3qt | 468 ++++ doc/man/man3/tqradiobutton.3qt | 278 +++ doc/man/man3/tqrangecontrol.3qt | 294 +++ doc/man/man3/tqrect.3qt | 662 ++++++ doc/man/man3/tqregexp.3qt | 855 +++++++ doc/man/man3/tqregexpvalidator.3qt | 179 ++ doc/man/man3/tqregion.3qt | 388 ++++ doc/man/man3/tqresizeevent.3qt | 70 + doc/man/man3/tqscreen.3qt | 329 +++ doc/man/man3/tqscrollbar.3qt | 360 +++ doc/man/man3/tqscrollview.3qt | 913 ++++++++ doc/man/man3/tqsemaphore.3qt | 110 + doc/man/man3/tqserversocket.3qt | 142 ++ doc/man/man3/tqsessionmanager.3qt | 314 +++ doc/man/man3/tqsettings.3qt | 654 ++++++ doc/man/man3/tqsgistyle.3qt | 64 + doc/man/man3/tqshowevent.3qt | 55 + doc/man/man3/tqsignal.3qt | 197 ++ doc/man/man3/tqsignalmapper.3qt | 118 + doc/man/man3/tqsimplerichtext.3qt | 182 ++ doc/man/man3/tqsize.3qt | 370 +++ doc/man/man3/tqsizegrip.3qt | 100 + doc/man/man3/tqsizepolicy.3qt | 238 ++ doc/man/man3/tqsjiscodec.3qt | 83 + doc/man/man3/tqslider.3qt | 390 ++++ doc/man/man3/tqsocket.3qt | 471 ++++ doc/man/man3/tqsocketdevice.3qt | 373 ++++ doc/man/man3/tqsocketnotifier.3qt | 157 ++ doc/man/man3/tqsound.3qt | 167 ++ doc/man/man3/tqspaceritem.3qt | 108 + doc/man/man3/tqspinbox.3qt | 572 +++++ doc/man/man3/tqsplashscreen.3qt | 182 ++ doc/man/man3/tqsplitter.3qt | 332 +++ doc/man/man3/tqsql.3qt | 111 + doc/man/man3/tqsqlcursor.3qt | 661 ++++++ doc/man/man3/tqsqldatabase.3qt | 666 ++++++ doc/man/man3/tqsqldriver.3qt | 253 +++ doc/man/man3/tqsqldriverplugin.3qt | 78 + doc/man/man3/tqsqleditorfactory.3qt | 93 + doc/man/man3/tqsqlerror.3qt | 142 ++ doc/man/man3/tqsqlfield.3qt | 199 ++ doc/man/man3/tqsqlfieldinfo.3qt | 175 ++ doc/man/man3/tqsqlform.3qt | 244 ++ doc/man/man3/tqsqlindex.3qt | 126 ++ doc/man/man3/tqsqlpropertymap.3qt | 172 ++ doc/man/man3/tqsqlquery.3qt | 567 +++++ doc/man/man3/tqsqlrecord.3qt | 268 +++ doc/man/man3/tqsqlrecordinfo.3qt | 79 + doc/man/man3/tqsqlresult.3qt | 189 ++ doc/man/man3/tqsqlselectcursor.3qt | 91 + doc/man/man3/tqstatusbar.3qt | 209 ++ doc/man/man3/tqstoreddrag.3qt | 83 + doc/man/man3/tqstrilist.3qt | 64 + doc/man/man3/tqstring.3qt | 2553 +++++++++++++++++++++ doc/man/man3/tqstringlist.3qt | 336 +++ doc/man/man3/tqstrlist.3qt | 92 + doc/man/man3/tqstrlistiterator.3qt | 46 + doc/man/man3/tqstyle.3qt | 1089 +++++++++ doc/man/man3/tqstylefactory.3qt | 61 + doc/man/man3/tqstyleoption.3qt | 222 ++ doc/man/man3/tqstyleplugin.3qt | 78 + doc/man/man3/tqstylesheet.3qt | 224 ++ doc/man/man3/tqstylesheetitem.3qt | 484 ++++ doc/man/man3/tqsyntaxhighlighter.3qt | 120 + doc/man/man3/tqt.3qt | 1451 ++++++++++++ doc/man/man3/tqtab.3qt | 120 + doc/man/man3/tqtabbar.3qt | 332 +++ doc/man/man3/tqtabdialog.3qt | 464 ++++ doc/man/man3/tqtable.3qt | 1382 ++++++++++++ doc/man/man3/tqtableitem.3qt | 466 ++++ doc/man/man3/tqtableselection.3qt | 158 ++ doc/man/man3/tqtabletevent.3qt | 192 ++ doc/man/man3/tqtabwidget.3qt | 424 ++++ doc/man/man3/tqtextbrowser.3qt | 231 ++ doc/man/man3/tqtextcodec.3qt | 586 +++++ doc/man/man3/tqtextcodecplugin.3qt | 96 + doc/man/man3/tqtextdecoder.3qt | 64 + doc/man/man3/tqtextdrag.3qt | 110 + doc/man/man3/tqtextedit.3qt | 1452 ++++++++++++ doc/man/man3/tqtextencoder.3qt | 65 + doc/man/man3/tqtextistream.3qt | 79 + doc/man/man3/tqtextostream.3qt | 77 + doc/man/man3/tqtextstream.3qt | 642 ++++++ doc/man/man3/tqthread.3qt | 230 ++ doc/man/man3/tqthreadstorage.3qt | 166 ++ doc/man/man3/tqtime.3qt | 372 ++++ doc/man/man3/tqtimeedit.3qt | 256 +++ doc/man/man3/tqtimer.3qt | 196 ++ doc/man/man3/tqtimerevent.3qt | 66 + doc/man/man3/tqtoolbar.3qt | 163 ++ doc/man/man3/tqtoolbox.3qt | 211 ++ doc/man/man3/tqtoolbutton.3qt | 419 ++++ doc/man/man3/tqtooltip.3qt | 354 +++ doc/man/man3/tqtooltipgroup.3qt | 154 ++ doc/man/man3/tqtranslator.3qt | 297 +++ doc/man/man3/tqtranslatormessage.3qt | 185 ++ doc/man/man3/tqtsciicodec.3qt | 62 + doc/man/man3/tquridrag.3qt | 168 ++ doc/man/man3/tqurl.3qt | 496 +++++ doc/man/man3/tqurlinfo.3qt | 366 +++ doc/man/man3/tqurloperator.3qt | 379 ++++ doc/man/man3/tquuid.3qt | 203 ++ doc/man/man3/tqvalidator.3qt | 112 + doc/man/man3/tqvaluelist.3qt | 756 +++++++ doc/man/man3/tqvaluelistconstiterator.3qt | 127 ++ doc/man/man3/tqvaluelistiterator.3qt | 172 ++ doc/man/man3/tqvaluestack.3qt | 141 ++ doc/man/man3/tqvaluevector.3qt | 635 ++++++ doc/man/man3/tqvariant.3qt | 1155 ++++++++++ doc/man/man3/tqvbox.3qt | 62 + doc/man/man3/tqvboxlayout.3qt | 96 + doc/man/man3/tqvbuttongroup.3qt | 75 + doc/man/man3/tqvgroupbox.3qt | 75 + doc/man/man3/tqwaitcondition.3qt | 202 ++ doc/man/man3/tqwhatsthis.3qt | 207 ++ doc/man/man3/tqwheelevent.3qt | 160 ++ doc/man/man3/tqwidget.3qt | 3219 +++++++++++++++++++++++++++ doc/man/man3/tqwidgetfactory.3qt | 135 ++ doc/man/man3/tqwidgetitem.3qt | 104 + doc/man/man3/tqwidgetplugin.3qt | 124 ++ doc/man/man3/tqwidgetstack.3qt | 166 ++ doc/man/man3/tqwindowsmime.3qt | 157 ++ doc/man/man3/tqwindowsstyle.3qt | 57 + doc/man/man3/tqwizard.3qt | 289 +++ doc/man/man3/tqwmatrix.3qt | 473 ++++ doc/man/man3/tqworkspace.3qt | 196 ++ doc/man/man3/tqwsdecoration.3qt | 156 ++ doc/man/man3/tqwsinputmethod.3qt | 105 + doc/man/man3/tqwskeyboardhandler.3qt | 77 + doc/man/man3/tqwsmousehandler.3qt | 89 + doc/man/man3/tqwsserver.3qt | 311 +++ doc/man/man3/tqwswindow.3qt | 140 ++ doc/man/man3/tqxmlattributes.3qt | 189 ++ doc/man/man3/tqxmlcontenthandler.3qt | 184 ++ doc/man/man3/tqxmldeclhandler.3qt | 92 + doc/man/man3/tqxmldefaulthandler.3qt | 64 + doc/man/man3/tqxmldtdhandler.3qt | 81 + doc/man/man3/tqxmlentityresolver.3qt | 72 + doc/man/man3/tqxmlerrorhandler.3qt | 88 + doc/man/man3/tqxmlinputsource.3qt | 156 ++ doc/man/man3/tqxmllexicalhandler.3qt | 134 ++ doc/man/man3/tqxmllocator.3qt | 71 + doc/man/man3/tqxmlnamespacesupport.3qt | 180 ++ doc/man/man3/tqxmlparseexception.3qt | 80 + doc/man/man3/tqxmlreader.3qt | 206 ++ doc/man/man3/tqxmlsimplereader.3qt | 142 ++ 1664 files changed, 119056 insertions(+), 119056 deletions(-) delete mode 100644 doc/man/man3/QAccel.3qt delete mode 100644 doc/man/man3/QAccessible.3qt delete mode 100644 doc/man/man3/QAccessibleInterface.3qt delete mode 100644 doc/man/man3/QAccessibleObject.3qt delete mode 100644 doc/man/man3/QAction.3qt delete mode 100644 doc/man/man3/QActionGroup.3qt delete mode 100644 doc/man/man3/QApplication.3qt delete mode 100644 doc/man/man3/QAsciiCache.3qt delete mode 100644 doc/man/man3/QAsciiCacheIterator.3qt delete mode 100644 doc/man/man3/QAsciiDict.3qt delete mode 100644 doc/man/man3/QAsciiDictIterator.3qt delete mode 100644 doc/man/man3/QAssistantClient.3qt delete mode 100644 doc/man/man3/QAxAggregated.3qt delete mode 100644 doc/man/man3/QAxBase.3qt delete mode 100644 doc/man/man3/QAxBindable.3qt delete mode 100644 doc/man/man3/QAxFactory.3qt delete mode 100644 doc/man/man3/QAxObject.3qt delete mode 100644 doc/man/man3/QAxScript.3qt delete mode 100644 doc/man/man3/QAxScriptEngine.3qt delete mode 100644 doc/man/man3/QAxScriptManager.3qt delete mode 100644 doc/man/man3/QAxWidget.3qt delete mode 100644 doc/man/man3/QBig5Codec.3qt delete mode 100644 doc/man/man3/QBig5hkscsCodec.3qt delete mode 100644 doc/man/man3/QBitArray.3qt delete mode 100644 doc/man/man3/QBitVal.3qt delete mode 100644 doc/man/man3/QBitmap.3qt delete mode 100644 doc/man/man3/QBoxLayout.3qt delete mode 100644 doc/man/man3/QBrush.3qt delete mode 100644 doc/man/man3/QBuffer.3qt delete mode 100644 doc/man/man3/QButton.3qt delete mode 100644 doc/man/man3/QButtonGroup.3qt delete mode 100644 doc/man/man3/QByteArray.3qt delete mode 100644 doc/man/man3/QCDEStyle.3qt delete mode 100644 doc/man/man3/QCString.3qt delete mode 100644 doc/man/man3/QCache.3qt delete mode 100644 doc/man/man3/QCacheIterator.3qt delete mode 100644 doc/man/man3/QCanvas.3qt delete mode 100644 doc/man/man3/QCanvasEllipse.3qt delete mode 100644 doc/man/man3/QCanvasItem.3qt delete mode 100644 doc/man/man3/QCanvasItemList.3qt delete mode 100644 doc/man/man3/QCanvasLine.3qt delete mode 100644 doc/man/man3/QCanvasPixmap.3qt delete mode 100644 doc/man/man3/QCanvasPixmapArray.3qt delete mode 100644 doc/man/man3/QCanvasPolygon.3qt delete mode 100644 doc/man/man3/QCanvasPolygonalItem.3qt delete mode 100644 doc/man/man3/QCanvasRectangle.3qt delete mode 100644 doc/man/man3/QCanvasSpline.3qt delete mode 100644 doc/man/man3/QCanvasSprite.3qt delete mode 100644 doc/man/man3/QCanvasText.3qt delete mode 100644 doc/man/man3/QCanvasView.3qt delete mode 100644 doc/man/man3/QChar.3qt delete mode 100644 doc/man/man3/QCharRef.3qt delete mode 100644 doc/man/man3/QCheckBox.3qt delete mode 100644 doc/man/man3/QCheckListItem.3qt delete mode 100644 doc/man/man3/QCheckTableItem.3qt delete mode 100644 doc/man/man3/QChildEvent.3qt delete mode 100644 doc/man/man3/QClipboard.3qt delete mode 100644 doc/man/man3/QCloseEvent.3qt delete mode 100644 doc/man/man3/QColor.3qt delete mode 100644 doc/man/man3/QColorDialog.3qt delete mode 100644 doc/man/man3/QColorDrag.3qt delete mode 100644 doc/man/man3/QColorGroup.3qt delete mode 100644 doc/man/man3/QComboBox.3qt delete mode 100644 doc/man/man3/QComboTableItem.3qt delete mode 100644 doc/man/man3/QCommonStyle.3qt delete mode 100644 doc/man/man3/QConstString.3qt delete mode 100644 doc/man/man3/QContextMenuEvent.3qt delete mode 100644 doc/man/man3/QCopChannel.3qt delete mode 100644 doc/man/man3/QCursor.3qt delete mode 100644 doc/man/man3/QCustomEvent.3qt delete mode 100644 doc/man/man3/QCustomMenuItem.3qt delete mode 100644 doc/man/man3/QDataBrowser.3qt delete mode 100644 doc/man/man3/QDataStream.3qt delete mode 100644 doc/man/man3/QDataTable.3qt delete mode 100644 doc/man/man3/QDataView.3qt delete mode 100644 doc/man/man3/QDate.3qt delete mode 100644 doc/man/man3/QDateEdit.3qt delete mode 100644 doc/man/man3/QDateTime.3qt delete mode 100644 doc/man/man3/QDateTimeEdit.3qt delete mode 100644 doc/man/man3/QDateTimeEditBase.3qt delete mode 100644 doc/man/man3/QDeepCopy.3qt delete mode 100644 doc/man/man3/QDesktopWidget.3qt delete mode 100644 doc/man/man3/QDial.3qt delete mode 100644 doc/man/man3/QDialog.3qt delete mode 100644 doc/man/man3/QDict.3qt delete mode 100644 doc/man/man3/QDictIterator.3qt delete mode 100644 doc/man/man3/QDir.3qt delete mode 100644 doc/man/man3/QDirectPainter.3qt delete mode 100644 doc/man/man3/QDns.3qt delete mode 100644 doc/man/man3/QDockArea.3qt delete mode 100644 doc/man/man3/QDockWindow.3qt delete mode 100644 doc/man/man3/QDomAttr.3qt delete mode 100644 doc/man/man3/QDomCDATASection.3qt delete mode 100644 doc/man/man3/QDomCharacterData.3qt delete mode 100644 doc/man/man3/QDomComment.3qt delete mode 100644 doc/man/man3/QDomDocument.3qt delete mode 100644 doc/man/man3/QDomDocumentFragment.3qt delete mode 100644 doc/man/man3/QDomDocumentType.3qt delete mode 100644 doc/man/man3/QDomElement.3qt delete mode 100644 doc/man/man3/QDomEntity.3qt delete mode 100644 doc/man/man3/QDomEntityReference.3qt delete mode 100644 doc/man/man3/QDomImplementation.3qt delete mode 100644 doc/man/man3/QDomNamedNodeMap.3qt delete mode 100644 doc/man/man3/QDomNode.3qt delete mode 100644 doc/man/man3/QDomNodeList.3qt delete mode 100644 doc/man/man3/QDomNotation.3qt delete mode 100644 doc/man/man3/QDomProcessingInstruction.3qt delete mode 100644 doc/man/man3/QDomText.3qt delete mode 100644 doc/man/man3/QDoubleValidator.3qt delete mode 100644 doc/man/man3/QDragEnterEvent.3qt delete mode 100644 doc/man/man3/QDragLeaveEvent.3qt delete mode 100644 doc/man/man3/QDragMoveEvent.3qt delete mode 100644 doc/man/man3/QDragObject.3qt delete mode 100644 doc/man/man3/QDropEvent.3qt delete mode 100644 doc/man/man3/QEditorFactory.3qt delete mode 100644 doc/man/man3/QErrorMessage.3qt delete mode 100644 doc/man/man3/QEucJpCodec.3qt delete mode 100644 doc/man/man3/QEucKrCodec.3qt delete mode 100644 doc/man/man3/QEvent.3qt delete mode 100644 doc/man/man3/QEventLoop.3qt delete mode 100644 doc/man/man3/QFile.3qt delete mode 100644 doc/man/man3/QFileDialog.3qt delete mode 100644 doc/man/man3/QFileIconProvider.3qt delete mode 100644 doc/man/man3/QFileInfo.3qt delete mode 100644 doc/man/man3/QFilePreview.3qt delete mode 100644 doc/man/man3/QFocusData.3qt delete mode 100644 doc/man/man3/QFocusEvent.3qt delete mode 100644 doc/man/man3/QFont.3qt delete mode 100644 doc/man/man3/QFontDatabase.3qt delete mode 100644 doc/man/man3/QFontDialog.3qt delete mode 100644 doc/man/man3/QFontInfo.3qt delete mode 100644 doc/man/man3/QFontManager.3qt delete mode 100644 doc/man/man3/QFontMetrics.3qt delete mode 100644 doc/man/man3/QFrame.3qt delete mode 100644 doc/man/man3/QFtp.3qt delete mode 100644 doc/man/man3/QGL.3qt delete mode 100644 doc/man/man3/QGLColormap.3qt delete mode 100644 doc/man/man3/QGLContext.3qt delete mode 100644 doc/man/man3/QGLFormat.3qt delete mode 100644 doc/man/man3/QGLWidget.3qt delete mode 100644 doc/man/man3/QGLayoutIterator.3qt delete mode 100644 doc/man/man3/QGb18030Codec.3qt delete mode 100644 doc/man/man3/QGb2312Codec.3qt delete mode 100644 doc/man/man3/QGbkCodec.3qt delete mode 100644 doc/man/man3/QGfxDriverFactory.3qt delete mode 100644 doc/man/man3/QGfxDriverPlugin.3qt delete mode 100644 doc/man/man3/QGrid.3qt delete mode 100644 doc/man/man3/QGridLayout.3qt delete mode 100644 doc/man/man3/QGridView.3qt delete mode 100644 doc/man/man3/QGroupBox.3qt delete mode 100644 doc/man/man3/QGuardedPtr.3qt delete mode 100644 doc/man/man3/QHBox.3qt delete mode 100644 doc/man/man3/QHBoxLayout.3qt delete mode 100644 doc/man/man3/QHButtonGroup.3qt delete mode 100644 doc/man/man3/QHGroupBox.3qt delete mode 100644 doc/man/man3/QHeader.3qt delete mode 100644 doc/man/man3/QHebrewCodec.3qt delete mode 100644 doc/man/man3/QHideEvent.3qt delete mode 100644 doc/man/man3/QHostAddress.3qt delete mode 100644 doc/man/man3/QHttp.3qt delete mode 100644 doc/man/man3/QHttpHeader.3qt delete mode 100644 doc/man/man3/QHttpRequestHeader.3qt delete mode 100644 doc/man/man3/QHttpResponseHeader.3qt delete mode 100644 doc/man/man3/QIMEvent.3qt delete mode 100644 doc/man/man3/QIODevice.3qt delete mode 100644 doc/man/man3/QIconDrag.3qt delete mode 100644 doc/man/man3/QIconDragEvent.3qt delete mode 100644 doc/man/man3/QIconDragItem.3qt delete mode 100644 doc/man/man3/QIconFactory.3qt delete mode 100644 doc/man/man3/QIconSet.3qt delete mode 100644 doc/man/man3/QIconView.3qt delete mode 100644 doc/man/man3/QIconViewItem.3qt delete mode 100644 doc/man/man3/QImage.3qt delete mode 100644 doc/man/man3/QImageConsumer.3qt delete mode 100644 doc/man/man3/QImageDecoder.3qt delete mode 100644 doc/man/man3/QImageDrag.3qt delete mode 100644 doc/man/man3/QImageFormat.3qt delete mode 100644 doc/man/man3/QImageFormatPlugin.3qt delete mode 100644 doc/man/man3/QImageFormatType.3qt delete mode 100644 doc/man/man3/QImageIO.3qt delete mode 100644 doc/man/man3/QInputDialog.3qt delete mode 100644 doc/man/man3/QIntCache.3qt delete mode 100644 doc/man/man3/QIntCacheIterator.3qt delete mode 100644 doc/man/man3/QIntDict.3qt delete mode 100644 doc/man/man3/QIntDictIterator.3qt delete mode 100644 doc/man/man3/QIntValidator.3qt delete mode 100644 doc/man/man3/QJisCodec.3qt delete mode 100644 doc/man/man3/QKbdDriverFactory.3qt delete mode 100644 doc/man/man3/QKbdDriverPlugin.3qt delete mode 100644 doc/man/man3/QKeyEvent.3qt delete mode 100644 doc/man/man3/QKeySequence.3qt delete mode 100644 doc/man/man3/QLCDNumber.3qt delete mode 100644 doc/man/man3/QLabel.3qt delete mode 100644 doc/man/man3/QLayout.3qt delete mode 100644 doc/man/man3/QLayoutItem.3qt delete mode 100644 doc/man/man3/QLayoutIterator.3qt delete mode 100644 doc/man/man3/QLibrary.3qt delete mode 100644 doc/man/man3/QLineEdit.3qt delete mode 100644 doc/man/man3/QListBox.3qt delete mode 100644 doc/man/man3/QListBoxItem.3qt delete mode 100644 doc/man/man3/QListBoxPixmap.3qt delete mode 100644 doc/man/man3/QListBoxText.3qt delete mode 100644 doc/man/man3/QListView.3qt delete mode 100644 doc/man/man3/QListViewItem.3qt delete mode 100644 doc/man/man3/QListViewItemIterator.3qt delete mode 100644 doc/man/man3/QLocalFs.3qt delete mode 100644 doc/man/man3/QLocale.3qt delete mode 100644 doc/man/man3/QMacMime.3qt delete mode 100644 doc/man/man3/QMacStyle.3qt delete mode 100644 doc/man/man3/QMainWindow.3qt delete mode 100644 doc/man/man3/QMap.3qt delete mode 100644 doc/man/man3/QMapConstIterator.3qt delete mode 100644 doc/man/man3/QMapIterator.3qt delete mode 100644 doc/man/man3/QMemArray.3qt delete mode 100644 doc/man/man3/QMenuBar.3qt delete mode 100644 doc/man/man3/QMenuData.3qt delete mode 100644 doc/man/man3/QMessageBox.3qt delete mode 100644 doc/man/man3/QMetaObject.3qt delete mode 100644 doc/man/man3/QMetaProperty.3qt delete mode 100644 doc/man/man3/QMimeSource.3qt delete mode 100644 doc/man/man3/QMimeSourceFactory.3qt delete mode 100644 doc/man/man3/QMotif.3qt delete mode 100644 doc/man/man3/QMotifDialog.3qt delete mode 100644 doc/man/man3/QMotifPlusStyle.3qt delete mode 100644 doc/man/man3/QMotifStyle.3qt delete mode 100644 doc/man/man3/QMotifWidget.3qt delete mode 100644 doc/man/man3/QMouseDriverFactory.3qt delete mode 100644 doc/man/man3/QMouseDriverPlugin.3qt delete mode 100644 doc/man/man3/QMouseEvent.3qt delete mode 100644 doc/man/man3/QMoveEvent.3qt delete mode 100644 doc/man/man3/QMovie.3qt delete mode 100644 doc/man/man3/QMutex.3qt delete mode 100644 doc/man/man3/QMutexLocker.3qt delete mode 100644 doc/man/man3/QNPInstance.3qt delete mode 100644 doc/man/man3/QNPStream.3qt delete mode 100644 doc/man/man3/QNPWidget.3qt delete mode 100644 doc/man/man3/QNPlugin.3qt delete mode 100644 doc/man/man3/QNetworkOperation.3qt delete mode 100644 doc/man/man3/QNetworkProtocol.3qt delete mode 100644 doc/man/man3/QObject.3qt delete mode 100644 doc/man/man3/QObjectCleanupHandler.3qt delete mode 100644 doc/man/man3/QObjectList.3qt delete mode 100644 doc/man/man3/QObjectListIterator.3qt delete mode 100644 doc/man/man3/QPNGImagePacker.3qt delete mode 100644 doc/man/man3/QPaintDevice.3qt delete mode 100644 doc/man/man3/QPaintDeviceMetrics.3qt delete mode 100644 doc/man/man3/QPaintEvent.3qt delete mode 100644 doc/man/man3/QPainter.3qt delete mode 100644 doc/man/man3/QPair.3qt delete mode 100644 doc/man/man3/QPalette.3qt delete mode 100644 doc/man/man3/QPen.3qt delete mode 100644 doc/man/man3/QPicture.3qt delete mode 100644 doc/man/man3/QPixmap.3qt delete mode 100644 doc/man/man3/QPixmapCache.3qt delete mode 100644 doc/man/man3/QPlatinumStyle.3qt delete mode 100644 doc/man/man3/QPoint.3qt delete mode 100644 doc/man/man3/QPointArray.3qt delete mode 100644 doc/man/man3/QPopupMenu.3qt delete mode 100644 doc/man/man3/QPrinter.3qt delete mode 100644 doc/man/man3/QProcess.3qt delete mode 100644 doc/man/man3/QProgressBar.3qt delete mode 100644 doc/man/man3/QProgressDialog.3qt delete mode 100644 doc/man/man3/QPtrCollection.3qt delete mode 100644 doc/man/man3/QPtrDict.3qt delete mode 100644 doc/man/man3/QPtrDictIterator.3qt delete mode 100644 doc/man/man3/QPtrList.3qt delete mode 100644 doc/man/man3/QPtrListIterator.3qt delete mode 100644 doc/man/man3/QPtrQueue.3qt delete mode 100644 doc/man/man3/QPtrStack.3qt delete mode 100644 doc/man/man3/QPtrVector.3qt delete mode 100644 doc/man/man3/QPushButton.3qt delete mode 100644 doc/man/man3/QRadioButton.3qt delete mode 100644 doc/man/man3/QRangeControl.3qt delete mode 100644 doc/man/man3/QRect.3qt delete mode 100644 doc/man/man3/QRegExp.3qt delete mode 100644 doc/man/man3/QRegExpValidator.3qt delete mode 100644 doc/man/man3/QRegion.3qt delete mode 100644 doc/man/man3/QResizeEvent.3qt delete mode 100644 doc/man/man3/QSGIStyle.3qt delete mode 100644 doc/man/man3/QScreen.3qt delete mode 100644 doc/man/man3/QScrollBar.3qt delete mode 100644 doc/man/man3/QScrollView.3qt delete mode 100644 doc/man/man3/QSemaphore.3qt delete mode 100644 doc/man/man3/QServerSocket.3qt delete mode 100644 doc/man/man3/QSessionManager.3qt delete mode 100644 doc/man/man3/QSettings.3qt delete mode 100644 doc/man/man3/QShowEvent.3qt delete mode 100644 doc/man/man3/QSignal.3qt delete mode 100644 doc/man/man3/QSignalMapper.3qt delete mode 100644 doc/man/man3/QSimpleRichText.3qt delete mode 100644 doc/man/man3/QSize.3qt delete mode 100644 doc/man/man3/QSizeGrip.3qt delete mode 100644 doc/man/man3/QSizePolicy.3qt delete mode 100644 doc/man/man3/QSjisCodec.3qt delete mode 100644 doc/man/man3/QSlider.3qt delete mode 100644 doc/man/man3/QSocket.3qt delete mode 100644 doc/man/man3/QSocketDevice.3qt delete mode 100644 doc/man/man3/QSocketNotifier.3qt delete mode 100644 doc/man/man3/QSound.3qt delete mode 100644 doc/man/man3/QSpacerItem.3qt delete mode 100644 doc/man/man3/QSpinBox.3qt delete mode 100644 doc/man/man3/QSplashScreen.3qt delete mode 100644 doc/man/man3/QSplitter.3qt delete mode 100644 doc/man/man3/QSql.3qt delete mode 100644 doc/man/man3/QSqlCursor.3qt delete mode 100644 doc/man/man3/QSqlDatabase.3qt delete mode 100644 doc/man/man3/QSqlDriver.3qt delete mode 100644 doc/man/man3/QSqlDriverPlugin.3qt delete mode 100644 doc/man/man3/QSqlEditorFactory.3qt delete mode 100644 doc/man/man3/QSqlError.3qt delete mode 100644 doc/man/man3/QSqlField.3qt delete mode 100644 doc/man/man3/QSqlFieldInfo.3qt delete mode 100644 doc/man/man3/QSqlForm.3qt delete mode 100644 doc/man/man3/QSqlIndex.3qt delete mode 100644 doc/man/man3/QSqlPropertyMap.3qt delete mode 100644 doc/man/man3/QSqlQuery.3qt delete mode 100644 doc/man/man3/QSqlRecord.3qt delete mode 100644 doc/man/man3/QSqlRecordInfo.3qt delete mode 100644 doc/man/man3/QSqlResult.3qt delete mode 100644 doc/man/man3/QSqlSelectCursor.3qt delete mode 100644 doc/man/man3/QStatusBar.3qt delete mode 100644 doc/man/man3/QStoredDrag.3qt delete mode 100644 doc/man/man3/QStrIList.3qt delete mode 100644 doc/man/man3/QStrList.3qt delete mode 100644 doc/man/man3/QStrListIterator.3qt delete mode 100644 doc/man/man3/QString.3qt delete mode 100644 doc/man/man3/QStringList.3qt delete mode 100644 doc/man/man3/QStyle.3qt delete mode 100644 doc/man/man3/QStyleFactory.3qt delete mode 100644 doc/man/man3/QStyleOption.3qt delete mode 100644 doc/man/man3/QStylePlugin.3qt delete mode 100644 doc/man/man3/QStyleSheet.3qt delete mode 100644 doc/man/man3/QStyleSheetItem.3qt delete mode 100644 doc/man/man3/QSyntaxHighlighter.3qt delete mode 100644 doc/man/man3/QTab.3qt delete mode 100644 doc/man/man3/QTabBar.3qt delete mode 100644 doc/man/man3/QTabDialog.3qt delete mode 100644 doc/man/man3/QTabWidget.3qt delete mode 100644 doc/man/man3/QTable.3qt delete mode 100644 doc/man/man3/QTableItem.3qt delete mode 100644 doc/man/man3/QTableSelection.3qt delete mode 100644 doc/man/man3/QTabletEvent.3qt delete mode 100644 doc/man/man3/QTextBrowser.3qt delete mode 100644 doc/man/man3/QTextCodec.3qt delete mode 100644 doc/man/man3/QTextCodecPlugin.3qt delete mode 100644 doc/man/man3/QTextDecoder.3qt delete mode 100644 doc/man/man3/QTextDrag.3qt delete mode 100644 doc/man/man3/QTextEdit.3qt delete mode 100644 doc/man/man3/QTextEncoder.3qt delete mode 100644 doc/man/man3/QTextIStream.3qt delete mode 100644 doc/man/man3/QTextOStream.3qt delete mode 100644 doc/man/man3/QTextStream.3qt delete mode 100644 doc/man/man3/QThread.3qt delete mode 100644 doc/man/man3/QThreadStorage.3qt delete mode 100644 doc/man/man3/QTime.3qt delete mode 100644 doc/man/man3/QTimeEdit.3qt delete mode 100644 doc/man/man3/QTimer.3qt delete mode 100644 doc/man/man3/QTimerEvent.3qt delete mode 100644 doc/man/man3/QToolBar.3qt delete mode 100644 doc/man/man3/QToolBox.3qt delete mode 100644 doc/man/man3/QToolButton.3qt delete mode 100644 doc/man/man3/QToolTip.3qt delete mode 100644 doc/man/man3/QToolTipGroup.3qt delete mode 100644 doc/man/man3/QTranslator.3qt delete mode 100644 doc/man/man3/QTranslatorMessage.3qt delete mode 100644 doc/man/man3/QTsciiCodec.3qt delete mode 100644 doc/man/man3/QUriDrag.3qt delete mode 100644 doc/man/man3/QUrl.3qt delete mode 100644 doc/man/man3/QUrlInfo.3qt delete mode 100644 doc/man/man3/QUrlOperator.3qt delete mode 100644 doc/man/man3/QUuid.3qt delete mode 100644 doc/man/man3/QVBox.3qt delete mode 100644 doc/man/man3/QVBoxLayout.3qt delete mode 100644 doc/man/man3/QVButtonGroup.3qt delete mode 100644 doc/man/man3/QVGroupBox.3qt delete mode 100644 doc/man/man3/QValidator.3qt delete mode 100644 doc/man/man3/QValueList.3qt delete mode 100644 doc/man/man3/QValueListConstIterator.3qt delete mode 100644 doc/man/man3/QValueListIterator.3qt delete mode 100644 doc/man/man3/QValueStack.3qt delete mode 100644 doc/man/man3/QValueVector.3qt delete mode 100644 doc/man/man3/QVariant.3qt delete mode 100644 doc/man/man3/QWMatrix.3qt delete mode 100644 doc/man/man3/QWSDecoration.3qt delete mode 100644 doc/man/man3/QWSInputMethod.3qt delete mode 100644 doc/man/man3/QWSKeyboardHandler.3qt delete mode 100644 doc/man/man3/QWSMouseHandler.3qt delete mode 100644 doc/man/man3/QWSServer.3qt delete mode 100644 doc/man/man3/QWSWindow.3qt delete mode 100644 doc/man/man3/QWaitCondition.3qt delete mode 100644 doc/man/man3/QWhatsThis.3qt delete mode 100644 doc/man/man3/QWheelEvent.3qt delete mode 100644 doc/man/man3/QWidget.3qt delete mode 100644 doc/man/man3/QWidgetFactory.3qt delete mode 100644 doc/man/man3/QWidgetItem.3qt delete mode 100644 doc/man/man3/QWidgetPlugin.3qt delete mode 100644 doc/man/man3/QWidgetStack.3qt delete mode 100644 doc/man/man3/QWindowsMime.3qt delete mode 100644 doc/man/man3/QWindowsStyle.3qt delete mode 100644 doc/man/man3/QWizard.3qt delete mode 100644 doc/man/man3/QWorkspace.3qt delete mode 100644 doc/man/man3/QXmlAttributes.3qt delete mode 100644 doc/man/man3/QXmlContentHandler.3qt delete mode 100644 doc/man/man3/QXmlDTDHandler.3qt delete mode 100644 doc/man/man3/QXmlDeclHandler.3qt delete mode 100644 doc/man/man3/QXmlDefaultHandler.3qt delete mode 100644 doc/man/man3/QXmlEntityResolver.3qt delete mode 100644 doc/man/man3/QXmlErrorHandler.3qt delete mode 100644 doc/man/man3/QXmlInputSource.3qt delete mode 100644 doc/man/man3/QXmlLexicalHandler.3qt delete mode 100644 doc/man/man3/QXmlLocator.3qt delete mode 100644 doc/man/man3/QXmlNamespaceSupport.3qt delete mode 100644 doc/man/man3/QXmlParseException.3qt delete mode 100644 doc/man/man3/QXmlReader.3qt delete mode 100644 doc/man/man3/QXmlSimpleReader.3qt delete mode 100644 doc/man/man3/Qt.3qt create mode 100644 doc/man/man3/TQAccel.3qt create mode 100644 doc/man/man3/TQAccessible.3qt create mode 100644 doc/man/man3/TQAccessibleInterface.3qt create mode 100644 doc/man/man3/TQAccessibleObject.3qt create mode 100644 doc/man/man3/TQAction.3qt create mode 100644 doc/man/man3/TQActionGroup.3qt create mode 100644 doc/man/man3/TQApplication.3qt create mode 100644 doc/man/man3/TQAsciiCache.3qt create mode 100644 doc/man/man3/TQAsciiCacheIterator.3qt create mode 100644 doc/man/man3/TQAsciiDict.3qt create mode 100644 doc/man/man3/TQAsciiDictIterator.3qt create mode 100644 doc/man/man3/TQAssistantClient.3qt create mode 100644 doc/man/man3/TQAxAggregated.3qt create mode 100644 doc/man/man3/TQAxBase.3qt create mode 100644 doc/man/man3/TQAxBindable.3qt create mode 100644 doc/man/man3/TQAxFactory.3qt create mode 100644 doc/man/man3/TQAxObject.3qt create mode 100644 doc/man/man3/TQAxScript.3qt create mode 100644 doc/man/man3/TQAxScriptEngine.3qt create mode 100644 doc/man/man3/TQAxScriptManager.3qt create mode 100644 doc/man/man3/TQAxWidget.3qt create mode 100644 doc/man/man3/TQBig5Codec.3qt create mode 100644 doc/man/man3/TQBig5hkscsCodec.3qt create mode 100644 doc/man/man3/TQBitArray.3qt create mode 100644 doc/man/man3/TQBitVal.3qt create mode 100644 doc/man/man3/TQBitmap.3qt create mode 100644 doc/man/man3/TQBoxLayout.3qt create mode 100644 doc/man/man3/TQBrush.3qt create mode 100644 doc/man/man3/TQBuffer.3qt create mode 100644 doc/man/man3/TQButton.3qt create mode 100644 doc/man/man3/TQButtonGroup.3qt create mode 100644 doc/man/man3/TQByteArray.3qt create mode 100644 doc/man/man3/TQCDEStyle.3qt create mode 100644 doc/man/man3/TQCString.3qt create mode 100644 doc/man/man3/TQCache.3qt create mode 100644 doc/man/man3/TQCacheIterator.3qt create mode 100644 doc/man/man3/TQCanvas.3qt create mode 100644 doc/man/man3/TQCanvasEllipse.3qt create mode 100644 doc/man/man3/TQCanvasItem.3qt create mode 100644 doc/man/man3/TQCanvasItemList.3qt create mode 100644 doc/man/man3/TQCanvasLine.3qt create mode 100644 doc/man/man3/TQCanvasPixmap.3qt create mode 100644 doc/man/man3/TQCanvasPixmapArray.3qt create mode 100644 doc/man/man3/TQCanvasPolygon.3qt create mode 100644 doc/man/man3/TQCanvasPolygonalItem.3qt create mode 100644 doc/man/man3/TQCanvasRectangle.3qt create mode 100644 doc/man/man3/TQCanvasSpline.3qt create mode 100644 doc/man/man3/TQCanvasSprite.3qt create mode 100644 doc/man/man3/TQCanvasText.3qt create mode 100644 doc/man/man3/TQCanvasView.3qt create mode 100644 doc/man/man3/TQChar.3qt create mode 100644 doc/man/man3/TQCharRef.3qt create mode 100644 doc/man/man3/TQCheckBox.3qt create mode 100644 doc/man/man3/TQCheckListItem.3qt create mode 100644 doc/man/man3/TQCheckTableItem.3qt create mode 100644 doc/man/man3/TQChildEvent.3qt create mode 100644 doc/man/man3/TQClipboard.3qt create mode 100644 doc/man/man3/TQCloseEvent.3qt create mode 100644 doc/man/man3/TQColor.3qt create mode 100644 doc/man/man3/TQColorDialog.3qt create mode 100644 doc/man/man3/TQColorDrag.3qt create mode 100644 doc/man/man3/TQColorGroup.3qt create mode 100644 doc/man/man3/TQComboBox.3qt create mode 100644 doc/man/man3/TQComboTableItem.3qt create mode 100644 doc/man/man3/TQCommonStyle.3qt create mode 100644 doc/man/man3/TQConstString.3qt create mode 100644 doc/man/man3/TQContextMenuEvent.3qt create mode 100644 doc/man/man3/TQCopChannel.3qt create mode 100644 doc/man/man3/TQCursor.3qt create mode 100644 doc/man/man3/TQCustomEvent.3qt create mode 100644 doc/man/man3/TQCustomMenuItem.3qt create mode 100644 doc/man/man3/TQDataBrowser.3qt create mode 100644 doc/man/man3/TQDataStream.3qt create mode 100644 doc/man/man3/TQDataTable.3qt create mode 100644 doc/man/man3/TQDataView.3qt create mode 100644 doc/man/man3/TQDate.3qt create mode 100644 doc/man/man3/TQDateEdit.3qt create mode 100644 doc/man/man3/TQDateTime.3qt create mode 100644 doc/man/man3/TQDateTimeEdit.3qt create mode 100644 doc/man/man3/TQDateTimeEditBase.3qt create mode 100644 doc/man/man3/TQDeepCopy.3qt create mode 100644 doc/man/man3/TQDesktopWidget.3qt create mode 100644 doc/man/man3/TQDial.3qt create mode 100644 doc/man/man3/TQDialog.3qt create mode 100644 doc/man/man3/TQDict.3qt create mode 100644 doc/man/man3/TQDictIterator.3qt create mode 100644 doc/man/man3/TQDir.3qt create mode 100644 doc/man/man3/TQDirectPainter.3qt create mode 100644 doc/man/man3/TQDns.3qt create mode 100644 doc/man/man3/TQDockArea.3qt create mode 100644 doc/man/man3/TQDockWindow.3qt create mode 100644 doc/man/man3/TQDomAttr.3qt create mode 100644 doc/man/man3/TQDomCDATASection.3qt create mode 100644 doc/man/man3/TQDomCharacterData.3qt create mode 100644 doc/man/man3/TQDomComment.3qt create mode 100644 doc/man/man3/TQDomDocument.3qt create mode 100644 doc/man/man3/TQDomDocumentFragment.3qt create mode 100644 doc/man/man3/TQDomDocumentType.3qt create mode 100644 doc/man/man3/TQDomElement.3qt create mode 100644 doc/man/man3/TQDomEntity.3qt create mode 100644 doc/man/man3/TQDomEntityReference.3qt create mode 100644 doc/man/man3/TQDomImplementation.3qt create mode 100644 doc/man/man3/TQDomNamedNodeMap.3qt create mode 100644 doc/man/man3/TQDomNode.3qt create mode 100644 doc/man/man3/TQDomNodeList.3qt create mode 100644 doc/man/man3/TQDomNotation.3qt create mode 100644 doc/man/man3/TQDomProcessingInstruction.3qt create mode 100644 doc/man/man3/TQDomText.3qt create mode 100644 doc/man/man3/TQDoubleValidator.3qt create mode 100644 doc/man/man3/TQDragEnterEvent.3qt create mode 100644 doc/man/man3/TQDragLeaveEvent.3qt create mode 100644 doc/man/man3/TQDragMoveEvent.3qt create mode 100644 doc/man/man3/TQDragObject.3qt create mode 100644 doc/man/man3/TQDropEvent.3qt create mode 100644 doc/man/man3/TQEditorFactory.3qt create mode 100644 doc/man/man3/TQErrorMessage.3qt create mode 100644 doc/man/man3/TQEucJpCodec.3qt create mode 100644 doc/man/man3/TQEucKrCodec.3qt create mode 100644 doc/man/man3/TQEvent.3qt create mode 100644 doc/man/man3/TQEventLoop.3qt create mode 100644 doc/man/man3/TQFile.3qt create mode 100644 doc/man/man3/TQFileDialog.3qt create mode 100644 doc/man/man3/TQFileIconProvider.3qt create mode 100644 doc/man/man3/TQFileInfo.3qt create mode 100644 doc/man/man3/TQFilePreview.3qt create mode 100644 doc/man/man3/TQFocusData.3qt create mode 100644 doc/man/man3/TQFocusEvent.3qt create mode 100644 doc/man/man3/TQFont.3qt create mode 100644 doc/man/man3/TQFontDatabase.3qt create mode 100644 doc/man/man3/TQFontDialog.3qt create mode 100644 doc/man/man3/TQFontInfo.3qt create mode 100644 doc/man/man3/TQFontManager.3qt create mode 100644 doc/man/man3/TQFontMetrics.3qt create mode 100644 doc/man/man3/TQFrame.3qt create mode 100644 doc/man/man3/TQFtp.3qt create mode 100644 doc/man/man3/TQGL.3qt create mode 100644 doc/man/man3/TQGLColormap.3qt create mode 100644 doc/man/man3/TQGLContext.3qt create mode 100644 doc/man/man3/TQGLFormat.3qt create mode 100644 doc/man/man3/TQGLWidget.3qt create mode 100644 doc/man/man3/TQGLayoutIterator.3qt create mode 100644 doc/man/man3/TQGb18030Codec.3qt create mode 100644 doc/man/man3/TQGb2312Codec.3qt create mode 100644 doc/man/man3/TQGbkCodec.3qt create mode 100644 doc/man/man3/TQGfxDriverFactory.3qt create mode 100644 doc/man/man3/TQGfxDriverPlugin.3qt create mode 100644 doc/man/man3/TQGrid.3qt create mode 100644 doc/man/man3/TQGridLayout.3qt create mode 100644 doc/man/man3/TQGridView.3qt create mode 100644 doc/man/man3/TQGroupBox.3qt create mode 100644 doc/man/man3/TQGuardedPtr.3qt create mode 100644 doc/man/man3/TQHBox.3qt create mode 100644 doc/man/man3/TQHBoxLayout.3qt create mode 100644 doc/man/man3/TQHButtonGroup.3qt create mode 100644 doc/man/man3/TQHGroupBox.3qt create mode 100644 doc/man/man3/TQHeader.3qt create mode 100644 doc/man/man3/TQHebrewCodec.3qt create mode 100644 doc/man/man3/TQHideEvent.3qt create mode 100644 doc/man/man3/TQHostAddress.3qt create mode 100644 doc/man/man3/TQHttp.3qt create mode 100644 doc/man/man3/TQHttpHeader.3qt create mode 100644 doc/man/man3/TQHttpRequestHeader.3qt create mode 100644 doc/man/man3/TQHttpResponseHeader.3qt create mode 100644 doc/man/man3/TQIMEvent.3qt create mode 100644 doc/man/man3/TQIODevice.3qt create mode 100644 doc/man/man3/TQIconDrag.3qt create mode 100644 doc/man/man3/TQIconDragEvent.3qt create mode 100644 doc/man/man3/TQIconDragItem.3qt create mode 100644 doc/man/man3/TQIconFactory.3qt create mode 100644 doc/man/man3/TQIconSet.3qt create mode 100644 doc/man/man3/TQIconView.3qt create mode 100644 doc/man/man3/TQIconViewItem.3qt create mode 100644 doc/man/man3/TQImage.3qt create mode 100644 doc/man/man3/TQImageConsumer.3qt create mode 100644 doc/man/man3/TQImageDecoder.3qt create mode 100644 doc/man/man3/TQImageDrag.3qt create mode 100644 doc/man/man3/TQImageFormat.3qt create mode 100644 doc/man/man3/TQImageFormatPlugin.3qt create mode 100644 doc/man/man3/TQImageFormatType.3qt create mode 100644 doc/man/man3/TQImageIO.3qt create mode 100644 doc/man/man3/TQInputDialog.3qt create mode 100644 doc/man/man3/TQIntCache.3qt create mode 100644 doc/man/man3/TQIntCacheIterator.3qt create mode 100644 doc/man/man3/TQIntDict.3qt create mode 100644 doc/man/man3/TQIntDictIterator.3qt create mode 100644 doc/man/man3/TQIntValidator.3qt create mode 100644 doc/man/man3/TQJisCodec.3qt create mode 100644 doc/man/man3/TQKbdDriverFactory.3qt create mode 100644 doc/man/man3/TQKbdDriverPlugin.3qt create mode 100644 doc/man/man3/TQKeyEvent.3qt create mode 100644 doc/man/man3/TQKeySequence.3qt create mode 100644 doc/man/man3/TQLCDNumber.3qt create mode 100644 doc/man/man3/TQLabel.3qt create mode 100644 doc/man/man3/TQLayout.3qt create mode 100644 doc/man/man3/TQLayoutItem.3qt create mode 100644 doc/man/man3/TQLayoutIterator.3qt create mode 100644 doc/man/man3/TQLibrary.3qt create mode 100644 doc/man/man3/TQLineEdit.3qt create mode 100644 doc/man/man3/TQListBox.3qt create mode 100644 doc/man/man3/TQListBoxItem.3qt create mode 100644 doc/man/man3/TQListBoxPixmap.3qt create mode 100644 doc/man/man3/TQListBoxText.3qt create mode 100644 doc/man/man3/TQListView.3qt create mode 100644 doc/man/man3/TQListViewItem.3qt create mode 100644 doc/man/man3/TQListViewItemIterator.3qt create mode 100644 doc/man/man3/TQLocalFs.3qt create mode 100644 doc/man/man3/TQLocale.3qt create mode 100644 doc/man/man3/TQMacMime.3qt create mode 100644 doc/man/man3/TQMacStyle.3qt create mode 100644 doc/man/man3/TQMainWindow.3qt create mode 100644 doc/man/man3/TQMap.3qt create mode 100644 doc/man/man3/TQMapConstIterator.3qt create mode 100644 doc/man/man3/TQMapIterator.3qt create mode 100644 doc/man/man3/TQMemArray.3qt create mode 100644 doc/man/man3/TQMenuBar.3qt create mode 100644 doc/man/man3/TQMenuData.3qt create mode 100644 doc/man/man3/TQMessageBox.3qt create mode 100644 doc/man/man3/TQMetaObject.3qt create mode 100644 doc/man/man3/TQMetaProperty.3qt create mode 100644 doc/man/man3/TQMimeSource.3qt create mode 100644 doc/man/man3/TQMimeSourceFactory.3qt create mode 100644 doc/man/man3/TQMotif.3qt create mode 100644 doc/man/man3/TQMotifDialog.3qt create mode 100644 doc/man/man3/TQMotifPlusStyle.3qt create mode 100644 doc/man/man3/TQMotifStyle.3qt create mode 100644 doc/man/man3/TQMotifWidget.3qt create mode 100644 doc/man/man3/TQMouseDriverFactory.3qt create mode 100644 doc/man/man3/TQMouseDriverPlugin.3qt create mode 100644 doc/man/man3/TQMouseEvent.3qt create mode 100644 doc/man/man3/TQMoveEvent.3qt create mode 100644 doc/man/man3/TQMovie.3qt create mode 100644 doc/man/man3/TQMutex.3qt create mode 100644 doc/man/man3/TQMutexLocker.3qt create mode 100644 doc/man/man3/TQNPInstance.3qt create mode 100644 doc/man/man3/TQNPStream.3qt create mode 100644 doc/man/man3/TQNPWidget.3qt create mode 100644 doc/man/man3/TQNPlugin.3qt create mode 100644 doc/man/man3/TQNetworkOperation.3qt create mode 100644 doc/man/man3/TQNetworkProtocol.3qt create mode 100644 doc/man/man3/TQObject.3qt create mode 100644 doc/man/man3/TQObjectCleanupHandler.3qt create mode 100644 doc/man/man3/TQObjectList.3qt create mode 100644 doc/man/man3/TQObjectListIterator.3qt create mode 100644 doc/man/man3/TQPNGImagePacker.3qt create mode 100644 doc/man/man3/TQPaintDevice.3qt create mode 100644 doc/man/man3/TQPaintDeviceMetrics.3qt create mode 100644 doc/man/man3/TQPaintEvent.3qt create mode 100644 doc/man/man3/TQPainter.3qt create mode 100644 doc/man/man3/TQPair.3qt create mode 100644 doc/man/man3/TQPalette.3qt create mode 100644 doc/man/man3/TQPen.3qt create mode 100644 doc/man/man3/TQPicture.3qt create mode 100644 doc/man/man3/TQPixmap.3qt create mode 100644 doc/man/man3/TQPixmapCache.3qt create mode 100644 doc/man/man3/TQPlatinumStyle.3qt create mode 100644 doc/man/man3/TQPoint.3qt create mode 100644 doc/man/man3/TQPointArray.3qt create mode 100644 doc/man/man3/TQPopupMenu.3qt create mode 100644 doc/man/man3/TQPrinter.3qt create mode 100644 doc/man/man3/TQProcess.3qt create mode 100644 doc/man/man3/TQProgressBar.3qt create mode 100644 doc/man/man3/TQProgressDialog.3qt create mode 100644 doc/man/man3/TQPtrCollection.3qt create mode 100644 doc/man/man3/TQPtrDict.3qt create mode 100644 doc/man/man3/TQPtrDictIterator.3qt create mode 100644 doc/man/man3/TQPtrList.3qt create mode 100644 doc/man/man3/TQPtrListIterator.3qt create mode 100644 doc/man/man3/TQPtrQueue.3qt create mode 100644 doc/man/man3/TQPtrStack.3qt create mode 100644 doc/man/man3/TQPtrVector.3qt create mode 100644 doc/man/man3/TQPushButton.3qt create mode 100644 doc/man/man3/TQRadioButton.3qt create mode 100644 doc/man/man3/TQRangeControl.3qt create mode 100644 doc/man/man3/TQRect.3qt create mode 100644 doc/man/man3/TQRegExp.3qt create mode 100644 doc/man/man3/TQRegExpValidator.3qt create mode 100644 doc/man/man3/TQRegion.3qt create mode 100644 doc/man/man3/TQResizeEvent.3qt create mode 100644 doc/man/man3/TQSGIStyle.3qt create mode 100644 doc/man/man3/TQScreen.3qt create mode 100644 doc/man/man3/TQScrollBar.3qt create mode 100644 doc/man/man3/TQScrollView.3qt create mode 100644 doc/man/man3/TQSemaphore.3qt create mode 100644 doc/man/man3/TQServerSocket.3qt create mode 100644 doc/man/man3/TQSessionManager.3qt create mode 100644 doc/man/man3/TQSettings.3qt create mode 100644 doc/man/man3/TQShowEvent.3qt create mode 100644 doc/man/man3/TQSignal.3qt create mode 100644 doc/man/man3/TQSignalMapper.3qt create mode 100644 doc/man/man3/TQSimpleRichText.3qt create mode 100644 doc/man/man3/TQSize.3qt create mode 100644 doc/man/man3/TQSizeGrip.3qt create mode 100644 doc/man/man3/TQSizePolicy.3qt create mode 100644 doc/man/man3/TQSjisCodec.3qt create mode 100644 doc/man/man3/TQSlider.3qt create mode 100644 doc/man/man3/TQSocket.3qt create mode 100644 doc/man/man3/TQSocketDevice.3qt create mode 100644 doc/man/man3/TQSocketNotifier.3qt create mode 100644 doc/man/man3/TQSound.3qt create mode 100644 doc/man/man3/TQSpacerItem.3qt create mode 100644 doc/man/man3/TQSpinBox.3qt create mode 100644 doc/man/man3/TQSplashScreen.3qt create mode 100644 doc/man/man3/TQSplitter.3qt create mode 100644 doc/man/man3/TQSql.3qt create mode 100644 doc/man/man3/TQSqlCursor.3qt create mode 100644 doc/man/man3/TQSqlDatabase.3qt create mode 100644 doc/man/man3/TQSqlDriver.3qt create mode 100644 doc/man/man3/TQSqlDriverPlugin.3qt create mode 100644 doc/man/man3/TQSqlEditorFactory.3qt create mode 100644 doc/man/man3/TQSqlError.3qt create mode 100644 doc/man/man3/TQSqlField.3qt create mode 100644 doc/man/man3/TQSqlFieldInfo.3qt create mode 100644 doc/man/man3/TQSqlForm.3qt create mode 100644 doc/man/man3/TQSqlIndex.3qt create mode 100644 doc/man/man3/TQSqlPropertyMap.3qt create mode 100644 doc/man/man3/TQSqlQuery.3qt create mode 100644 doc/man/man3/TQSqlRecord.3qt create mode 100644 doc/man/man3/TQSqlRecordInfo.3qt create mode 100644 doc/man/man3/TQSqlResult.3qt create mode 100644 doc/man/man3/TQSqlSelectCursor.3qt create mode 100644 doc/man/man3/TQStatusBar.3qt create mode 100644 doc/man/man3/TQStoredDrag.3qt create mode 100644 doc/man/man3/TQStrIList.3qt create mode 100644 doc/man/man3/TQStrList.3qt create mode 100644 doc/man/man3/TQStrListIterator.3qt create mode 100644 doc/man/man3/TQString.3qt create mode 100644 doc/man/man3/TQStringList.3qt create mode 100644 doc/man/man3/TQStyle.3qt create mode 100644 doc/man/man3/TQStyleFactory.3qt create mode 100644 doc/man/man3/TQStyleOption.3qt create mode 100644 doc/man/man3/TQStylePlugin.3qt create mode 100644 doc/man/man3/TQStyleSheet.3qt create mode 100644 doc/man/man3/TQStyleSheetItem.3qt create mode 100644 doc/man/man3/TQSyntaxHighlighter.3qt create mode 100644 doc/man/man3/TQTab.3qt create mode 100644 doc/man/man3/TQTabBar.3qt create mode 100644 doc/man/man3/TQTabDialog.3qt create mode 100644 doc/man/man3/TQTabWidget.3qt create mode 100644 doc/man/man3/TQTable.3qt create mode 100644 doc/man/man3/TQTableItem.3qt create mode 100644 doc/man/man3/TQTableSelection.3qt create mode 100644 doc/man/man3/TQTabletEvent.3qt create mode 100644 doc/man/man3/TQTextBrowser.3qt create mode 100644 doc/man/man3/TQTextCodec.3qt create mode 100644 doc/man/man3/TQTextCodecPlugin.3qt create mode 100644 doc/man/man3/TQTextDecoder.3qt create mode 100644 doc/man/man3/TQTextDrag.3qt create mode 100644 doc/man/man3/TQTextEdit.3qt create mode 100644 doc/man/man3/TQTextEncoder.3qt create mode 100644 doc/man/man3/TQTextIStream.3qt create mode 100644 doc/man/man3/TQTextOStream.3qt create mode 100644 doc/man/man3/TQTextStream.3qt create mode 100644 doc/man/man3/TQThread.3qt create mode 100644 doc/man/man3/TQThreadStorage.3qt create mode 100644 doc/man/man3/TQTime.3qt create mode 100644 doc/man/man3/TQTimeEdit.3qt create mode 100644 doc/man/man3/TQTimer.3qt create mode 100644 doc/man/man3/TQTimerEvent.3qt create mode 100644 doc/man/man3/TQToolBar.3qt create mode 100644 doc/man/man3/TQToolBox.3qt create mode 100644 doc/man/man3/TQToolButton.3qt create mode 100644 doc/man/man3/TQToolTip.3qt create mode 100644 doc/man/man3/TQToolTipGroup.3qt create mode 100644 doc/man/man3/TQTranslator.3qt create mode 100644 doc/man/man3/TQTranslatorMessage.3qt create mode 100644 doc/man/man3/TQTsciiCodec.3qt create mode 100644 doc/man/man3/TQUriDrag.3qt create mode 100644 doc/man/man3/TQUrl.3qt create mode 100644 doc/man/man3/TQUrlInfo.3qt create mode 100644 doc/man/man3/TQUrlOperator.3qt create mode 100644 doc/man/man3/TQUuid.3qt create mode 100644 doc/man/man3/TQVBox.3qt create mode 100644 doc/man/man3/TQVBoxLayout.3qt create mode 100644 doc/man/man3/TQVButtonGroup.3qt create mode 100644 doc/man/man3/TQVGroupBox.3qt create mode 100644 doc/man/man3/TQValidator.3qt create mode 100644 doc/man/man3/TQValueList.3qt create mode 100644 doc/man/man3/TQValueListConstIterator.3qt create mode 100644 doc/man/man3/TQValueListIterator.3qt create mode 100644 doc/man/man3/TQValueStack.3qt create mode 100644 doc/man/man3/TQValueVector.3qt create mode 100644 doc/man/man3/TQVariant.3qt create mode 100644 doc/man/man3/TQWMatrix.3qt create mode 100644 doc/man/man3/TQWSDecoration.3qt create mode 100644 doc/man/man3/TQWSInputMethod.3qt create mode 100644 doc/man/man3/TQWSKeyboardHandler.3qt create mode 100644 doc/man/man3/TQWSMouseHandler.3qt create mode 100644 doc/man/man3/TQWSServer.3qt create mode 100644 doc/man/man3/TQWSWindow.3qt create mode 100644 doc/man/man3/TQWaitCondition.3qt create mode 100644 doc/man/man3/TQWhatsThis.3qt create mode 100644 doc/man/man3/TQWheelEvent.3qt create mode 100644 doc/man/man3/TQWidget.3qt create mode 100644 doc/man/man3/TQWidgetFactory.3qt create mode 100644 doc/man/man3/TQWidgetItem.3qt create mode 100644 doc/man/man3/TQWidgetPlugin.3qt create mode 100644 doc/man/man3/TQWidgetStack.3qt create mode 100644 doc/man/man3/TQWindowsMime.3qt create mode 100644 doc/man/man3/TQWindowsStyle.3qt create mode 100644 doc/man/man3/TQWizard.3qt create mode 100644 doc/man/man3/TQWorkspace.3qt create mode 100644 doc/man/man3/TQXmlAttributes.3qt create mode 100644 doc/man/man3/TQXmlContentHandler.3qt create mode 100644 doc/man/man3/TQXmlDTDHandler.3qt create mode 100644 doc/man/man3/TQXmlDeclHandler.3qt create mode 100644 doc/man/man3/TQXmlDefaultHandler.3qt create mode 100644 doc/man/man3/TQXmlEntityResolver.3qt create mode 100644 doc/man/man3/TQXmlErrorHandler.3qt create mode 100644 doc/man/man3/TQXmlInputSource.3qt create mode 100644 doc/man/man3/TQXmlLexicalHandler.3qt create mode 100644 doc/man/man3/TQXmlLocator.3qt create mode 100644 doc/man/man3/TQXmlNamespaceSupport.3qt create mode 100644 doc/man/man3/TQXmlParseException.3qt create mode 100644 doc/man/man3/TQXmlReader.3qt create mode 100644 doc/man/man3/TQXmlSimpleReader.3qt create mode 100644 doc/man/man3/TQt.3qt delete mode 100644 doc/man/man3/qaccel.3qt delete mode 100644 doc/man/man3/qaccessible.3qt delete mode 100644 doc/man/man3/qaccessibleinterface.3qt delete mode 100644 doc/man/man3/qaccessibleobject.3qt delete mode 100644 doc/man/man3/qaction.3qt delete mode 100644 doc/man/man3/qactiongroup.3qt delete mode 100644 doc/man/man3/qapplication.3qt delete mode 100644 doc/man/man3/qasciicache.3qt delete mode 100644 doc/man/man3/qasciicacheiterator.3qt delete mode 100644 doc/man/man3/qasciidict.3qt delete mode 100644 doc/man/man3/qasciidictiterator.3qt delete mode 100644 doc/man/man3/qassistantclient.3qt delete mode 100644 doc/man/man3/qaxaggregated.3qt delete mode 100644 doc/man/man3/qaxbase.3qt delete mode 100644 doc/man/man3/qaxbindable.3qt delete mode 100644 doc/man/man3/qaxfactory.3qt delete mode 100644 doc/man/man3/qaxobject.3qt delete mode 100644 doc/man/man3/qaxscript.3qt delete mode 100644 doc/man/man3/qaxscriptengine.3qt delete mode 100644 doc/man/man3/qaxscriptmanager.3qt delete mode 100644 doc/man/man3/qaxwidget.3qt delete mode 100644 doc/man/man3/qbig5codec.3qt delete mode 100644 doc/man/man3/qbig5hkscscodec.3qt delete mode 100644 doc/man/man3/qbitarray.3qt delete mode 100644 doc/man/man3/qbitmap.3qt delete mode 100644 doc/man/man3/qbitval.3qt delete mode 100644 doc/man/man3/qboxlayout.3qt delete mode 100644 doc/man/man3/qbrush.3qt delete mode 100644 doc/man/man3/qbuffer.3qt delete mode 100644 doc/man/man3/qbutton.3qt delete mode 100644 doc/man/man3/qbuttongroup.3qt delete mode 100644 doc/man/man3/qbytearray.3qt delete mode 100644 doc/man/man3/qcache.3qt delete mode 100644 doc/man/man3/qcacheiterator.3qt delete mode 100644 doc/man/man3/qcanvas.3qt delete mode 100644 doc/man/man3/qcanvasellipse.3qt delete mode 100644 doc/man/man3/qcanvasitem.3qt delete mode 100644 doc/man/man3/qcanvasitemlist.3qt delete mode 100644 doc/man/man3/qcanvasline.3qt delete mode 100644 doc/man/man3/qcanvaspixmap.3qt delete mode 100644 doc/man/man3/qcanvaspixmaparray.3qt delete mode 100644 doc/man/man3/qcanvaspolygon.3qt delete mode 100644 doc/man/man3/qcanvaspolygonalitem.3qt delete mode 100644 doc/man/man3/qcanvasrectangle.3qt delete mode 100644 doc/man/man3/qcanvasspline.3qt delete mode 100644 doc/man/man3/qcanvassprite.3qt delete mode 100644 doc/man/man3/qcanvastext.3qt delete mode 100644 doc/man/man3/qcanvasview.3qt delete mode 100644 doc/man/man3/qcdestyle.3qt delete mode 100644 doc/man/man3/qchar.3qt delete mode 100644 doc/man/man3/qcharref.3qt delete mode 100644 doc/man/man3/qcheckbox.3qt delete mode 100644 doc/man/man3/qchecklistitem.3qt delete mode 100644 doc/man/man3/qchecktableitem.3qt delete mode 100644 doc/man/man3/qchildevent.3qt delete mode 100644 doc/man/man3/qclipboard.3qt delete mode 100644 doc/man/man3/qcloseevent.3qt delete mode 100644 doc/man/man3/qcolor.3qt delete mode 100644 doc/man/man3/qcolordialog.3qt delete mode 100644 doc/man/man3/qcolordrag.3qt delete mode 100644 doc/man/man3/qcolorgroup.3qt delete mode 100644 doc/man/man3/qcombobox.3qt delete mode 100644 doc/man/man3/qcombotableitem.3qt delete mode 100644 doc/man/man3/qcommonstyle.3qt delete mode 100644 doc/man/man3/qconststring.3qt delete mode 100644 doc/man/man3/qcontextmenuevent.3qt delete mode 100644 doc/man/man3/qcopchannel.3qt delete mode 100644 doc/man/man3/qcstring.3qt delete mode 100644 doc/man/man3/qcursor.3qt delete mode 100644 doc/man/man3/qcustomevent.3qt delete mode 100644 doc/man/man3/qcustommenuitem.3qt delete mode 100644 doc/man/man3/qdatabrowser.3qt delete mode 100644 doc/man/man3/qdatastream.3qt delete mode 100644 doc/man/man3/qdatatable.3qt delete mode 100644 doc/man/man3/qdataview.3qt delete mode 100644 doc/man/man3/qdate.3qt delete mode 100644 doc/man/man3/qdateedit.3qt delete mode 100644 doc/man/man3/qdatetime.3qt delete mode 100644 doc/man/man3/qdatetimeedit.3qt delete mode 100644 doc/man/man3/qdatetimeeditbase.3qt delete mode 100644 doc/man/man3/qdeepcopy.3qt delete mode 100644 doc/man/man3/qdesktopwidget.3qt delete mode 100644 doc/man/man3/qdial.3qt delete mode 100644 doc/man/man3/qdialog.3qt delete mode 100644 doc/man/man3/qdict.3qt delete mode 100644 doc/man/man3/qdictiterator.3qt delete mode 100644 doc/man/man3/qdir.3qt delete mode 100644 doc/man/man3/qdirectpainter.3qt delete mode 100644 doc/man/man3/qdns.3qt delete mode 100644 doc/man/man3/qdockarea.3qt delete mode 100644 doc/man/man3/qdockwindow.3qt delete mode 100644 doc/man/man3/qdomattr.3qt delete mode 100644 doc/man/man3/qdomcdatasection.3qt delete mode 100644 doc/man/man3/qdomcharacterdata.3qt delete mode 100644 doc/man/man3/qdomcomment.3qt delete mode 100644 doc/man/man3/qdomdocument.3qt delete mode 100644 doc/man/man3/qdomdocumentfragment.3qt delete mode 100644 doc/man/man3/qdomdocumenttype.3qt delete mode 100644 doc/man/man3/qdomelement.3qt delete mode 100644 doc/man/man3/qdomentity.3qt delete mode 100644 doc/man/man3/qdomentityreference.3qt delete mode 100644 doc/man/man3/qdomimplementation.3qt delete mode 100644 doc/man/man3/qdomnamednodemap.3qt delete mode 100644 doc/man/man3/qdomnode.3qt delete mode 100644 doc/man/man3/qdomnodelist.3qt delete mode 100644 doc/man/man3/qdomnotation.3qt delete mode 100644 doc/man/man3/qdomprocessinginstruction.3qt delete mode 100644 doc/man/man3/qdomtext.3qt delete mode 100644 doc/man/man3/qdoublevalidator.3qt delete mode 100644 doc/man/man3/qdragenterevent.3qt delete mode 100644 doc/man/man3/qdragleaveevent.3qt delete mode 100644 doc/man/man3/qdragmoveevent.3qt delete mode 100644 doc/man/man3/qdragobject.3qt delete mode 100644 doc/man/man3/qdropevent.3qt delete mode 100644 doc/man/man3/qeditorfactory.3qt delete mode 100644 doc/man/man3/qerrormessage.3qt delete mode 100644 doc/man/man3/qeucjpcodec.3qt delete mode 100644 doc/man/man3/qeuckrcodec.3qt delete mode 100644 doc/man/man3/qevent.3qt delete mode 100644 doc/man/man3/qeventloop.3qt delete mode 100644 doc/man/man3/qfile.3qt delete mode 100644 doc/man/man3/qfiledialog.3qt delete mode 100644 doc/man/man3/qfileiconprovider.3qt delete mode 100644 doc/man/man3/qfileinfo.3qt delete mode 100644 doc/man/man3/qfilepreview.3qt delete mode 100644 doc/man/man3/qfocusdata.3qt delete mode 100644 doc/man/man3/qfocusevent.3qt delete mode 100644 doc/man/man3/qfont.3qt delete mode 100644 doc/man/man3/qfontdatabase.3qt delete mode 100644 doc/man/man3/qfontdialog.3qt delete mode 100644 doc/man/man3/qfontinfo.3qt delete mode 100644 doc/man/man3/qfontmanager.3qt delete mode 100644 doc/man/man3/qfontmetrics.3qt delete mode 100644 doc/man/man3/qframe.3qt delete mode 100644 doc/man/man3/qftp.3qt delete mode 100644 doc/man/man3/qgb18030codec.3qt delete mode 100644 doc/man/man3/qgb2312codec.3qt delete mode 100644 doc/man/man3/qgbkcodec.3qt delete mode 100644 doc/man/man3/qgfxdriverfactory.3qt delete mode 100644 doc/man/man3/qgfxdriverplugin.3qt delete mode 100644 doc/man/man3/qgl.3qt delete mode 100644 doc/man/man3/qglayoutiterator.3qt delete mode 100644 doc/man/man3/qglcolormap.3qt delete mode 100644 doc/man/man3/qglcontext.3qt delete mode 100644 doc/man/man3/qglformat.3qt delete mode 100644 doc/man/man3/qglwidget.3qt delete mode 100644 doc/man/man3/qgrid.3qt delete mode 100644 doc/man/man3/qgridlayout.3qt delete mode 100644 doc/man/man3/qgridview.3qt delete mode 100644 doc/man/man3/qgroupbox.3qt delete mode 100644 doc/man/man3/qguardedptr.3qt delete mode 100644 doc/man/man3/qhbox.3qt delete mode 100644 doc/man/man3/qhboxlayout.3qt delete mode 100644 doc/man/man3/qhbuttongroup.3qt delete mode 100644 doc/man/man3/qheader.3qt delete mode 100644 doc/man/man3/qhebrewcodec.3qt delete mode 100644 doc/man/man3/qhgroupbox.3qt delete mode 100644 doc/man/man3/qhideevent.3qt delete mode 100644 doc/man/man3/qhostaddress.3qt delete mode 100644 doc/man/man3/qhttp.3qt delete mode 100644 doc/man/man3/qhttpheader.3qt delete mode 100644 doc/man/man3/qhttprequestheader.3qt delete mode 100644 doc/man/man3/qhttpresponseheader.3qt delete mode 100644 doc/man/man3/qicondrag.3qt delete mode 100644 doc/man/man3/qicondragevent.3qt delete mode 100644 doc/man/man3/qicondragitem.3qt delete mode 100644 doc/man/man3/qiconfactory.3qt delete mode 100644 doc/man/man3/qiconset.3qt delete mode 100644 doc/man/man3/qiconview.3qt delete mode 100644 doc/man/man3/qiconviewitem.3qt delete mode 100644 doc/man/man3/qimage.3qt delete mode 100644 doc/man/man3/qimageconsumer.3qt delete mode 100644 doc/man/man3/qimagedecoder.3qt delete mode 100644 doc/man/man3/qimagedrag.3qt delete mode 100644 doc/man/man3/qimageformat.3qt delete mode 100644 doc/man/man3/qimageformatplugin.3qt delete mode 100644 doc/man/man3/qimageformattype.3qt delete mode 100644 doc/man/man3/qimageio.3qt delete mode 100644 doc/man/man3/qimevent.3qt delete mode 100644 doc/man/man3/qinputdialog.3qt delete mode 100644 doc/man/man3/qintcache.3qt delete mode 100644 doc/man/man3/qintcacheiterator.3qt delete mode 100644 doc/man/man3/qintdict.3qt delete mode 100644 doc/man/man3/qintdictiterator.3qt delete mode 100644 doc/man/man3/qintvalidator.3qt delete mode 100644 doc/man/man3/qiodevice.3qt delete mode 100644 doc/man/man3/qjiscodec.3qt delete mode 100644 doc/man/man3/qkbddriverfactory.3qt delete mode 100644 doc/man/man3/qkbddriverplugin.3qt delete mode 100644 doc/man/man3/qkeyevent.3qt delete mode 100644 doc/man/man3/qkeysequence.3qt delete mode 100644 doc/man/man3/qlabel.3qt delete mode 100644 doc/man/man3/qlayout.3qt delete mode 100644 doc/man/man3/qlayoutitem.3qt delete mode 100644 doc/man/man3/qlayoutiterator.3qt delete mode 100644 doc/man/man3/qlcdnumber.3qt delete mode 100644 doc/man/man3/qlibrary.3qt delete mode 100644 doc/man/man3/qlineedit.3qt delete mode 100644 doc/man/man3/qlistbox.3qt delete mode 100644 doc/man/man3/qlistboxitem.3qt delete mode 100644 doc/man/man3/qlistboxpixmap.3qt delete mode 100644 doc/man/man3/qlistboxtext.3qt delete mode 100644 doc/man/man3/qlistview.3qt delete mode 100644 doc/man/man3/qlistviewitem.3qt delete mode 100644 doc/man/man3/qlistviewitemiterator.3qt delete mode 100644 doc/man/man3/qlocale.3qt delete mode 100644 doc/man/man3/qlocalfs.3qt delete mode 100644 doc/man/man3/qmacmime.3qt delete mode 100644 doc/man/man3/qmacstyle.3qt delete mode 100644 doc/man/man3/qmainwindow.3qt delete mode 100644 doc/man/man3/qmap.3qt delete mode 100644 doc/man/man3/qmapconstiterator.3qt delete mode 100644 doc/man/man3/qmapiterator.3qt delete mode 100644 doc/man/man3/qmemarray.3qt delete mode 100644 doc/man/man3/qmenubar.3qt delete mode 100644 doc/man/man3/qmenudata.3qt delete mode 100644 doc/man/man3/qmessagebox.3qt delete mode 100644 doc/man/man3/qmetaobject.3qt delete mode 100644 doc/man/man3/qmetaproperty.3qt delete mode 100644 doc/man/man3/qmimesource.3qt delete mode 100644 doc/man/man3/qmimesourcefactory.3qt delete mode 100644 doc/man/man3/qmotif.3qt delete mode 100644 doc/man/man3/qmotifdialog.3qt delete mode 100644 doc/man/man3/qmotifplusstyle.3qt delete mode 100644 doc/man/man3/qmotifstyle.3qt delete mode 100644 doc/man/man3/qmotifwidget.3qt delete mode 100644 doc/man/man3/qmousedriverfactory.3qt delete mode 100644 doc/man/man3/qmousedriverplugin.3qt delete mode 100644 doc/man/man3/qmouseevent.3qt delete mode 100644 doc/man/man3/qmoveevent.3qt delete mode 100644 doc/man/man3/qmovie.3qt delete mode 100644 doc/man/man3/qmutex.3qt delete mode 100644 doc/man/man3/qmutexlocker.3qt delete mode 100644 doc/man/man3/qnetworkoperation.3qt delete mode 100644 doc/man/man3/qnetworkprotocol.3qt delete mode 100644 doc/man/man3/qnpinstance.3qt delete mode 100644 doc/man/man3/qnplugin.3qt delete mode 100644 doc/man/man3/qnpstream.3qt delete mode 100644 doc/man/man3/qnpwidget.3qt delete mode 100644 doc/man/man3/qobject.3qt delete mode 100644 doc/man/man3/qobjectcleanuphandler.3qt delete mode 100644 doc/man/man3/qobjectlist.3qt delete mode 100644 doc/man/man3/qobjectlistiterator.3qt delete mode 100644 doc/man/man3/qpaintdevice.3qt delete mode 100644 doc/man/man3/qpaintdevicemetrics.3qt delete mode 100644 doc/man/man3/qpainter.3qt delete mode 100644 doc/man/man3/qpaintevent.3qt delete mode 100644 doc/man/man3/qpair.3qt delete mode 100644 doc/man/man3/qpalette.3qt delete mode 100644 doc/man/man3/qpen.3qt delete mode 100644 doc/man/man3/qpicture.3qt delete mode 100644 doc/man/man3/qpixmap.3qt delete mode 100644 doc/man/man3/qpixmapcache.3qt delete mode 100644 doc/man/man3/qplatinumstyle.3qt delete mode 100644 doc/man/man3/qpngimagepacker.3qt delete mode 100644 doc/man/man3/qpoint.3qt delete mode 100644 doc/man/man3/qpointarray.3qt delete mode 100644 doc/man/man3/qpopupmenu.3qt delete mode 100644 doc/man/man3/qprinter.3qt delete mode 100644 doc/man/man3/qprocess.3qt delete mode 100644 doc/man/man3/qprogressbar.3qt delete mode 100644 doc/man/man3/qprogressdialog.3qt delete mode 100644 doc/man/man3/qptrcollection.3qt delete mode 100644 doc/man/man3/qptrdict.3qt delete mode 100644 doc/man/man3/qptrdictiterator.3qt delete mode 100644 doc/man/man3/qptrlist.3qt delete mode 100644 doc/man/man3/qptrlistiterator.3qt delete mode 100644 doc/man/man3/qptrqueue.3qt delete mode 100644 doc/man/man3/qptrstack.3qt delete mode 100644 doc/man/man3/qptrvector.3qt delete mode 100644 doc/man/man3/qpushbutton.3qt delete mode 100644 doc/man/man3/qradiobutton.3qt delete mode 100644 doc/man/man3/qrangecontrol.3qt delete mode 100644 doc/man/man3/qrect.3qt delete mode 100644 doc/man/man3/qregexp.3qt delete mode 100644 doc/man/man3/qregexpvalidator.3qt delete mode 100644 doc/man/man3/qregion.3qt delete mode 100644 doc/man/man3/qresizeevent.3qt delete mode 100644 doc/man/man3/qscreen.3qt delete mode 100644 doc/man/man3/qscrollbar.3qt delete mode 100644 doc/man/man3/qscrollview.3qt delete mode 100644 doc/man/man3/qsemaphore.3qt delete mode 100644 doc/man/man3/qserversocket.3qt delete mode 100644 doc/man/man3/qsessionmanager.3qt delete mode 100644 doc/man/man3/qsettings.3qt delete mode 100644 doc/man/man3/qsgistyle.3qt delete mode 100644 doc/man/man3/qshowevent.3qt delete mode 100644 doc/man/man3/qsignal.3qt delete mode 100644 doc/man/man3/qsignalmapper.3qt delete mode 100644 doc/man/man3/qsimplerichtext.3qt delete mode 100644 doc/man/man3/qsize.3qt delete mode 100644 doc/man/man3/qsizegrip.3qt delete mode 100644 doc/man/man3/qsizepolicy.3qt delete mode 100644 doc/man/man3/qsjiscodec.3qt delete mode 100644 doc/man/man3/qslider.3qt delete mode 100644 doc/man/man3/qsocket.3qt delete mode 100644 doc/man/man3/qsocketdevice.3qt delete mode 100644 doc/man/man3/qsocketnotifier.3qt delete mode 100644 doc/man/man3/qsound.3qt delete mode 100644 doc/man/man3/qspaceritem.3qt delete mode 100644 doc/man/man3/qspinbox.3qt delete mode 100644 doc/man/man3/qsplashscreen.3qt delete mode 100644 doc/man/man3/qsplitter.3qt delete mode 100644 doc/man/man3/qsql.3qt delete mode 100644 doc/man/man3/qsqlcursor.3qt delete mode 100644 doc/man/man3/qsqldatabase.3qt delete mode 100644 doc/man/man3/qsqldriver.3qt delete mode 100644 doc/man/man3/qsqldriverplugin.3qt delete mode 100644 doc/man/man3/qsqleditorfactory.3qt delete mode 100644 doc/man/man3/qsqlerror.3qt delete mode 100644 doc/man/man3/qsqlfield.3qt delete mode 100644 doc/man/man3/qsqlfieldinfo.3qt delete mode 100644 doc/man/man3/qsqlform.3qt delete mode 100644 doc/man/man3/qsqlindex.3qt delete mode 100644 doc/man/man3/qsqlpropertymap.3qt delete mode 100644 doc/man/man3/qsqlquery.3qt delete mode 100644 doc/man/man3/qsqlrecord.3qt delete mode 100644 doc/man/man3/qsqlrecordinfo.3qt delete mode 100644 doc/man/man3/qsqlresult.3qt delete mode 100644 doc/man/man3/qsqlselectcursor.3qt delete mode 100644 doc/man/man3/qstatusbar.3qt delete mode 100644 doc/man/man3/qstoreddrag.3qt delete mode 100644 doc/man/man3/qstrilist.3qt delete mode 100644 doc/man/man3/qstring.3qt delete mode 100644 doc/man/man3/qstringlist.3qt delete mode 100644 doc/man/man3/qstrlist.3qt delete mode 100644 doc/man/man3/qstrlistiterator.3qt delete mode 100644 doc/man/man3/qstyle.3qt delete mode 100644 doc/man/man3/qstylefactory.3qt delete mode 100644 doc/man/man3/qstyleoption.3qt delete mode 100644 doc/man/man3/qstyleplugin.3qt delete mode 100644 doc/man/man3/qstylesheet.3qt delete mode 100644 doc/man/man3/qstylesheetitem.3qt delete mode 100644 doc/man/man3/qsyntaxhighlighter.3qt delete mode 100644 doc/man/man3/qt.3qt delete mode 100644 doc/man/man3/qtab.3qt delete mode 100644 doc/man/man3/qtabbar.3qt delete mode 100644 doc/man/man3/qtabdialog.3qt delete mode 100644 doc/man/man3/qtable.3qt delete mode 100644 doc/man/man3/qtableitem.3qt delete mode 100644 doc/man/man3/qtableselection.3qt delete mode 100644 doc/man/man3/qtabletevent.3qt delete mode 100644 doc/man/man3/qtabwidget.3qt delete mode 100644 doc/man/man3/qtextbrowser.3qt delete mode 100644 doc/man/man3/qtextcodec.3qt delete mode 100644 doc/man/man3/qtextcodecplugin.3qt delete mode 100644 doc/man/man3/qtextdecoder.3qt delete mode 100644 doc/man/man3/qtextdrag.3qt delete mode 100644 doc/man/man3/qtextedit.3qt delete mode 100644 doc/man/man3/qtextencoder.3qt delete mode 100644 doc/man/man3/qtextistream.3qt delete mode 100644 doc/man/man3/qtextostream.3qt delete mode 100644 doc/man/man3/qtextstream.3qt delete mode 100644 doc/man/man3/qthread.3qt delete mode 100644 doc/man/man3/qthreadstorage.3qt delete mode 100644 doc/man/man3/qtime.3qt delete mode 100644 doc/man/man3/qtimeedit.3qt delete mode 100644 doc/man/man3/qtimer.3qt delete mode 100644 doc/man/man3/qtimerevent.3qt delete mode 100644 doc/man/man3/qtoolbar.3qt delete mode 100644 doc/man/man3/qtoolbox.3qt delete mode 100644 doc/man/man3/qtoolbutton.3qt delete mode 100644 doc/man/man3/qtooltip.3qt delete mode 100644 doc/man/man3/qtooltipgroup.3qt delete mode 100644 doc/man/man3/qtranslator.3qt delete mode 100644 doc/man/man3/qtranslatormessage.3qt delete mode 100644 doc/man/man3/qtsciicodec.3qt delete mode 100644 doc/man/man3/quridrag.3qt delete mode 100644 doc/man/man3/qurl.3qt delete mode 100644 doc/man/man3/qurlinfo.3qt delete mode 100644 doc/man/man3/qurloperator.3qt delete mode 100644 doc/man/man3/quuid.3qt delete mode 100644 doc/man/man3/qvalidator.3qt delete mode 100644 doc/man/man3/qvaluelist.3qt delete mode 100644 doc/man/man3/qvaluelistconstiterator.3qt delete mode 100644 doc/man/man3/qvaluelistiterator.3qt delete mode 100644 doc/man/man3/qvaluestack.3qt delete mode 100644 doc/man/man3/qvaluevector.3qt delete mode 100644 doc/man/man3/qvariant.3qt delete mode 100644 doc/man/man3/qvbox.3qt delete mode 100644 doc/man/man3/qvboxlayout.3qt delete mode 100644 doc/man/man3/qvbuttongroup.3qt delete mode 100644 doc/man/man3/qvgroupbox.3qt delete mode 100644 doc/man/man3/qwaitcondition.3qt delete mode 100644 doc/man/man3/qwhatsthis.3qt delete mode 100644 doc/man/man3/qwheelevent.3qt delete mode 100644 doc/man/man3/qwidget.3qt delete mode 100644 doc/man/man3/qwidgetfactory.3qt delete mode 100644 doc/man/man3/qwidgetitem.3qt delete mode 100644 doc/man/man3/qwidgetplugin.3qt delete mode 100644 doc/man/man3/qwidgetstack.3qt delete mode 100644 doc/man/man3/qwindowsmime.3qt delete mode 100644 doc/man/man3/qwindowsstyle.3qt delete mode 100644 doc/man/man3/qwizard.3qt delete mode 100644 doc/man/man3/qwmatrix.3qt delete mode 100644 doc/man/man3/qworkspace.3qt delete mode 100644 doc/man/man3/qwsdecoration.3qt delete mode 100644 doc/man/man3/qwsinputmethod.3qt delete mode 100644 doc/man/man3/qwskeyboardhandler.3qt delete mode 100644 doc/man/man3/qwsmousehandler.3qt delete mode 100644 doc/man/man3/qwsserver.3qt delete mode 100644 doc/man/man3/qwswindow.3qt delete mode 100644 doc/man/man3/qxmlattributes.3qt delete mode 100644 doc/man/man3/qxmlcontenthandler.3qt delete mode 100644 doc/man/man3/qxmldeclhandler.3qt delete mode 100644 doc/man/man3/qxmldefaulthandler.3qt delete mode 100644 doc/man/man3/qxmldtdhandler.3qt delete mode 100644 doc/man/man3/qxmlentityresolver.3qt delete mode 100644 doc/man/man3/qxmlerrorhandler.3qt delete mode 100644 doc/man/man3/qxmlinputsource.3qt delete mode 100644 doc/man/man3/qxmllexicalhandler.3qt delete mode 100644 doc/man/man3/qxmllocator.3qt delete mode 100644 doc/man/man3/qxmlnamespacesupport.3qt delete mode 100644 doc/man/man3/qxmlparseexception.3qt delete mode 100644 doc/man/man3/qxmlreader.3qt delete mode 100644 doc/man/man3/qxmlsimplereader.3qt create mode 100644 doc/man/man3/tqaccel.3qt create mode 100644 doc/man/man3/tqaccessible.3qt create mode 100644 doc/man/man3/tqaccessibleinterface.3qt create mode 100644 doc/man/man3/tqaccessibleobject.3qt create mode 100644 doc/man/man3/tqaction.3qt create mode 100644 doc/man/man3/tqactiongroup.3qt create mode 100644 doc/man/man3/tqapplication.3qt create mode 100644 doc/man/man3/tqasciicache.3qt create mode 100644 doc/man/man3/tqasciicacheiterator.3qt create mode 100644 doc/man/man3/tqasciidict.3qt create mode 100644 doc/man/man3/tqasciidictiterator.3qt create mode 100644 doc/man/man3/tqassistantclient.3qt create mode 100644 doc/man/man3/tqaxaggregated.3qt create mode 100644 doc/man/man3/tqaxbase.3qt create mode 100644 doc/man/man3/tqaxbindable.3qt create mode 100644 doc/man/man3/tqaxfactory.3qt create mode 100644 doc/man/man3/tqaxobject.3qt create mode 100644 doc/man/man3/tqaxscript.3qt create mode 100644 doc/man/man3/tqaxscriptengine.3qt create mode 100644 doc/man/man3/tqaxscriptmanager.3qt create mode 100644 doc/man/man3/tqaxwidget.3qt create mode 100644 doc/man/man3/tqbig5codec.3qt create mode 100644 doc/man/man3/tqbig5hkscscodec.3qt create mode 100644 doc/man/man3/tqbitarray.3qt create mode 100644 doc/man/man3/tqbitmap.3qt create mode 100644 doc/man/man3/tqbitval.3qt create mode 100644 doc/man/man3/tqboxlayout.3qt create mode 100644 doc/man/man3/tqbrush.3qt create mode 100644 doc/man/man3/tqbuffer.3qt create mode 100644 doc/man/man3/tqbutton.3qt create mode 100644 doc/man/man3/tqbuttongroup.3qt create mode 100644 doc/man/man3/tqbytearray.3qt create mode 100644 doc/man/man3/tqcache.3qt create mode 100644 doc/man/man3/tqcacheiterator.3qt create mode 100644 doc/man/man3/tqcanvas.3qt create mode 100644 doc/man/man3/tqcanvasellipse.3qt create mode 100644 doc/man/man3/tqcanvasitem.3qt create mode 100644 doc/man/man3/tqcanvasitemlist.3qt create mode 100644 doc/man/man3/tqcanvasline.3qt create mode 100644 doc/man/man3/tqcanvaspixmap.3qt create mode 100644 doc/man/man3/tqcanvaspixmaparray.3qt create mode 100644 doc/man/man3/tqcanvaspolygon.3qt create mode 100644 doc/man/man3/tqcanvaspolygonalitem.3qt create mode 100644 doc/man/man3/tqcanvasrectangle.3qt create mode 100644 doc/man/man3/tqcanvasspline.3qt create mode 100644 doc/man/man3/tqcanvassprite.3qt create mode 100644 doc/man/man3/tqcanvastext.3qt create mode 100644 doc/man/man3/tqcanvasview.3qt create mode 100644 doc/man/man3/tqcdestyle.3qt create mode 100644 doc/man/man3/tqchar.3qt create mode 100644 doc/man/man3/tqcharref.3qt create mode 100644 doc/man/man3/tqcheckbox.3qt create mode 100644 doc/man/man3/tqchecklistitem.3qt create mode 100644 doc/man/man3/tqchecktableitem.3qt create mode 100644 doc/man/man3/tqchildevent.3qt create mode 100644 doc/man/man3/tqclipboard.3qt create mode 100644 doc/man/man3/tqcloseevent.3qt create mode 100644 doc/man/man3/tqcolor.3qt create mode 100644 doc/man/man3/tqcolordialog.3qt create mode 100644 doc/man/man3/tqcolordrag.3qt create mode 100644 doc/man/man3/tqcolorgroup.3qt create mode 100644 doc/man/man3/tqcombobox.3qt create mode 100644 doc/man/man3/tqcombotableitem.3qt create mode 100644 doc/man/man3/tqcommonstyle.3qt create mode 100644 doc/man/man3/tqconststring.3qt create mode 100644 doc/man/man3/tqcontextmenuevent.3qt create mode 100644 doc/man/man3/tqcopchannel.3qt create mode 100644 doc/man/man3/tqcstring.3qt create mode 100644 doc/man/man3/tqcursor.3qt create mode 100644 doc/man/man3/tqcustomevent.3qt create mode 100644 doc/man/man3/tqcustommenuitem.3qt create mode 100644 doc/man/man3/tqdatabrowser.3qt create mode 100644 doc/man/man3/tqdatastream.3qt create mode 100644 doc/man/man3/tqdatatable.3qt create mode 100644 doc/man/man3/tqdataview.3qt create mode 100644 doc/man/man3/tqdate.3qt create mode 100644 doc/man/man3/tqdateedit.3qt create mode 100644 doc/man/man3/tqdatetime.3qt create mode 100644 doc/man/man3/tqdatetimeedit.3qt create mode 100644 doc/man/man3/tqdatetimeeditbase.3qt create mode 100644 doc/man/man3/tqdeepcopy.3qt create mode 100644 doc/man/man3/tqdesktopwidget.3qt create mode 100644 doc/man/man3/tqdial.3qt create mode 100644 doc/man/man3/tqdialog.3qt create mode 100644 doc/man/man3/tqdict.3qt create mode 100644 doc/man/man3/tqdictiterator.3qt create mode 100644 doc/man/man3/tqdir.3qt create mode 100644 doc/man/man3/tqdirectpainter.3qt create mode 100644 doc/man/man3/tqdns.3qt create mode 100644 doc/man/man3/tqdockarea.3qt create mode 100644 doc/man/man3/tqdockwindow.3qt create mode 100644 doc/man/man3/tqdomattr.3qt create mode 100644 doc/man/man3/tqdomcdatasection.3qt create mode 100644 doc/man/man3/tqdomcharacterdata.3qt create mode 100644 doc/man/man3/tqdomcomment.3qt create mode 100644 doc/man/man3/tqdomdocument.3qt create mode 100644 doc/man/man3/tqdomdocumentfragment.3qt create mode 100644 doc/man/man3/tqdomdocumenttype.3qt create mode 100644 doc/man/man3/tqdomelement.3qt create mode 100644 doc/man/man3/tqdomentity.3qt create mode 100644 doc/man/man3/tqdomentityreference.3qt create mode 100644 doc/man/man3/tqdomimplementation.3qt create mode 100644 doc/man/man3/tqdomnamednodemap.3qt create mode 100644 doc/man/man3/tqdomnode.3qt create mode 100644 doc/man/man3/tqdomnodelist.3qt create mode 100644 doc/man/man3/tqdomnotation.3qt create mode 100644 doc/man/man3/tqdomprocessinginstruction.3qt create mode 100644 doc/man/man3/tqdomtext.3qt create mode 100644 doc/man/man3/tqdoublevalidator.3qt create mode 100644 doc/man/man3/tqdragenterevent.3qt create mode 100644 doc/man/man3/tqdragleaveevent.3qt create mode 100644 doc/man/man3/tqdragmoveevent.3qt create mode 100644 doc/man/man3/tqdragobject.3qt create mode 100644 doc/man/man3/tqdropevent.3qt create mode 100644 doc/man/man3/tqeditorfactory.3qt create mode 100644 doc/man/man3/tqerrormessage.3qt create mode 100644 doc/man/man3/tqeucjpcodec.3qt create mode 100644 doc/man/man3/tqeuckrcodec.3qt create mode 100644 doc/man/man3/tqevent.3qt create mode 100644 doc/man/man3/tqeventloop.3qt create mode 100644 doc/man/man3/tqfile.3qt create mode 100644 doc/man/man3/tqfiledialog.3qt create mode 100644 doc/man/man3/tqfileiconprovider.3qt create mode 100644 doc/man/man3/tqfileinfo.3qt create mode 100644 doc/man/man3/tqfilepreview.3qt create mode 100644 doc/man/man3/tqfocusdata.3qt create mode 100644 doc/man/man3/tqfocusevent.3qt create mode 100644 doc/man/man3/tqfont.3qt create mode 100644 doc/man/man3/tqfontdatabase.3qt create mode 100644 doc/man/man3/tqfontdialog.3qt create mode 100644 doc/man/man3/tqfontinfo.3qt create mode 100644 doc/man/man3/tqfontmanager.3qt create mode 100644 doc/man/man3/tqfontmetrics.3qt create mode 100644 doc/man/man3/tqframe.3qt create mode 100644 doc/man/man3/tqftp.3qt create mode 100644 doc/man/man3/tqgb18030codec.3qt create mode 100644 doc/man/man3/tqgb2312codec.3qt create mode 100644 doc/man/man3/tqgbkcodec.3qt create mode 100644 doc/man/man3/tqgfxdriverfactory.3qt create mode 100644 doc/man/man3/tqgfxdriverplugin.3qt create mode 100644 doc/man/man3/tqgl.3qt create mode 100644 doc/man/man3/tqglayoutiterator.3qt create mode 100644 doc/man/man3/tqglcolormap.3qt create mode 100644 doc/man/man3/tqglcontext.3qt create mode 100644 doc/man/man3/tqglformat.3qt create mode 100644 doc/man/man3/tqglwidget.3qt create mode 100644 doc/man/man3/tqgrid.3qt create mode 100644 doc/man/man3/tqgridlayout.3qt create mode 100644 doc/man/man3/tqgridview.3qt create mode 100644 doc/man/man3/tqgroupbox.3qt create mode 100644 doc/man/man3/tqguardedptr.3qt create mode 100644 doc/man/man3/tqhbox.3qt create mode 100644 doc/man/man3/tqhboxlayout.3qt create mode 100644 doc/man/man3/tqhbuttongroup.3qt create mode 100644 doc/man/man3/tqheader.3qt create mode 100644 doc/man/man3/tqhebrewcodec.3qt create mode 100644 doc/man/man3/tqhgroupbox.3qt create mode 100644 doc/man/man3/tqhideevent.3qt create mode 100644 doc/man/man3/tqhostaddress.3qt create mode 100644 doc/man/man3/tqhttp.3qt create mode 100644 doc/man/man3/tqhttpheader.3qt create mode 100644 doc/man/man3/tqhttprequestheader.3qt create mode 100644 doc/man/man3/tqhttpresponseheader.3qt create mode 100644 doc/man/man3/tqicondrag.3qt create mode 100644 doc/man/man3/tqicondragevent.3qt create mode 100644 doc/man/man3/tqicondragitem.3qt create mode 100644 doc/man/man3/tqiconfactory.3qt create mode 100644 doc/man/man3/tqiconset.3qt create mode 100644 doc/man/man3/tqiconview.3qt create mode 100644 doc/man/man3/tqiconviewitem.3qt create mode 100644 doc/man/man3/tqimage.3qt create mode 100644 doc/man/man3/tqimageconsumer.3qt create mode 100644 doc/man/man3/tqimagedecoder.3qt create mode 100644 doc/man/man3/tqimagedrag.3qt create mode 100644 doc/man/man3/tqimageformat.3qt create mode 100644 doc/man/man3/tqimageformatplugin.3qt create mode 100644 doc/man/man3/tqimageformattype.3qt create mode 100644 doc/man/man3/tqimageio.3qt create mode 100644 doc/man/man3/tqimevent.3qt create mode 100644 doc/man/man3/tqinputdialog.3qt create mode 100644 doc/man/man3/tqintcache.3qt create mode 100644 doc/man/man3/tqintcacheiterator.3qt create mode 100644 doc/man/man3/tqintdict.3qt create mode 100644 doc/man/man3/tqintdictiterator.3qt create mode 100644 doc/man/man3/tqintvalidator.3qt create mode 100644 doc/man/man3/tqiodevice.3qt create mode 100644 doc/man/man3/tqjiscodec.3qt create mode 100644 doc/man/man3/tqkbddriverfactory.3qt create mode 100644 doc/man/man3/tqkbddriverplugin.3qt create mode 100644 doc/man/man3/tqkeyevent.3qt create mode 100644 doc/man/man3/tqkeysequence.3qt create mode 100644 doc/man/man3/tqlabel.3qt create mode 100644 doc/man/man3/tqlayout.3qt create mode 100644 doc/man/man3/tqlayoutitem.3qt create mode 100644 doc/man/man3/tqlayoutiterator.3qt create mode 100644 doc/man/man3/tqlcdnumber.3qt create mode 100644 doc/man/man3/tqlibrary.3qt create mode 100644 doc/man/man3/tqlineedit.3qt create mode 100644 doc/man/man3/tqlistbox.3qt create mode 100644 doc/man/man3/tqlistboxitem.3qt create mode 100644 doc/man/man3/tqlistboxpixmap.3qt create mode 100644 doc/man/man3/tqlistboxtext.3qt create mode 100644 doc/man/man3/tqlistview.3qt create mode 100644 doc/man/man3/tqlistviewitem.3qt create mode 100644 doc/man/man3/tqlistviewitemiterator.3qt create mode 100644 doc/man/man3/tqlocale.3qt create mode 100644 doc/man/man3/tqlocalfs.3qt create mode 100644 doc/man/man3/tqmacmime.3qt create mode 100644 doc/man/man3/tqmacstyle.3qt create mode 100644 doc/man/man3/tqmainwindow.3qt create mode 100644 doc/man/man3/tqmap.3qt create mode 100644 doc/man/man3/tqmapconstiterator.3qt create mode 100644 doc/man/man3/tqmapiterator.3qt create mode 100644 doc/man/man3/tqmemarray.3qt create mode 100644 doc/man/man3/tqmenubar.3qt create mode 100644 doc/man/man3/tqmenudata.3qt create mode 100644 doc/man/man3/tqmessagebox.3qt create mode 100644 doc/man/man3/tqmetaobject.3qt create mode 100644 doc/man/man3/tqmetaproperty.3qt create mode 100644 doc/man/man3/tqmimesource.3qt create mode 100644 doc/man/man3/tqmimesourcefactory.3qt create mode 100644 doc/man/man3/tqmotif.3qt create mode 100644 doc/man/man3/tqmotifdialog.3qt create mode 100644 doc/man/man3/tqmotifplusstyle.3qt create mode 100644 doc/man/man3/tqmotifstyle.3qt create mode 100644 doc/man/man3/tqmotifwidget.3qt create mode 100644 doc/man/man3/tqmousedriverfactory.3qt create mode 100644 doc/man/man3/tqmousedriverplugin.3qt create mode 100644 doc/man/man3/tqmouseevent.3qt create mode 100644 doc/man/man3/tqmoveevent.3qt create mode 100644 doc/man/man3/tqmovie.3qt create mode 100644 doc/man/man3/tqmutex.3qt create mode 100644 doc/man/man3/tqmutexlocker.3qt create mode 100644 doc/man/man3/tqnetworkoperation.3qt create mode 100644 doc/man/man3/tqnetworkprotocol.3qt create mode 100644 doc/man/man3/tqnpinstance.3qt create mode 100644 doc/man/man3/tqnplugin.3qt create mode 100644 doc/man/man3/tqnpstream.3qt create mode 100644 doc/man/man3/tqnpwidget.3qt create mode 100644 doc/man/man3/tqobject.3qt create mode 100644 doc/man/man3/tqobjectcleanuphandler.3qt create mode 100644 doc/man/man3/tqobjectlist.3qt create mode 100644 doc/man/man3/tqobjectlistiterator.3qt create mode 100644 doc/man/man3/tqpaintdevice.3qt create mode 100644 doc/man/man3/tqpaintdevicemetrics.3qt create mode 100644 doc/man/man3/tqpainter.3qt create mode 100644 doc/man/man3/tqpaintevent.3qt create mode 100644 doc/man/man3/tqpair.3qt create mode 100644 doc/man/man3/tqpalette.3qt create mode 100644 doc/man/man3/tqpen.3qt create mode 100644 doc/man/man3/tqpicture.3qt create mode 100644 doc/man/man3/tqpixmap.3qt create mode 100644 doc/man/man3/tqpixmapcache.3qt create mode 100644 doc/man/man3/tqplatinumstyle.3qt create mode 100644 doc/man/man3/tqpngimagepacker.3qt create mode 100644 doc/man/man3/tqpoint.3qt create mode 100644 doc/man/man3/tqpointarray.3qt create mode 100644 doc/man/man3/tqpopupmenu.3qt create mode 100644 doc/man/man3/tqprinter.3qt create mode 100644 doc/man/man3/tqprocess.3qt create mode 100644 doc/man/man3/tqprogressbar.3qt create mode 100644 doc/man/man3/tqprogressdialog.3qt create mode 100644 doc/man/man3/tqptrcollection.3qt create mode 100644 doc/man/man3/tqptrdict.3qt create mode 100644 doc/man/man3/tqptrdictiterator.3qt create mode 100644 doc/man/man3/tqptrlist.3qt create mode 100644 doc/man/man3/tqptrlistiterator.3qt create mode 100644 doc/man/man3/tqptrqueue.3qt create mode 100644 doc/man/man3/tqptrstack.3qt create mode 100644 doc/man/man3/tqptrvector.3qt create mode 100644 doc/man/man3/tqpushbutton.3qt create mode 100644 doc/man/man3/tqradiobutton.3qt create mode 100644 doc/man/man3/tqrangecontrol.3qt create mode 100644 doc/man/man3/tqrect.3qt create mode 100644 doc/man/man3/tqregexp.3qt create mode 100644 doc/man/man3/tqregexpvalidator.3qt create mode 100644 doc/man/man3/tqregion.3qt create mode 100644 doc/man/man3/tqresizeevent.3qt create mode 100644 doc/man/man3/tqscreen.3qt create mode 100644 doc/man/man3/tqscrollbar.3qt create mode 100644 doc/man/man3/tqscrollview.3qt create mode 100644 doc/man/man3/tqsemaphore.3qt create mode 100644 doc/man/man3/tqserversocket.3qt create mode 100644 doc/man/man3/tqsessionmanager.3qt create mode 100644 doc/man/man3/tqsettings.3qt create mode 100644 doc/man/man3/tqsgistyle.3qt create mode 100644 doc/man/man3/tqshowevent.3qt create mode 100644 doc/man/man3/tqsignal.3qt create mode 100644 doc/man/man3/tqsignalmapper.3qt create mode 100644 doc/man/man3/tqsimplerichtext.3qt create mode 100644 doc/man/man3/tqsize.3qt create mode 100644 doc/man/man3/tqsizegrip.3qt create mode 100644 doc/man/man3/tqsizepolicy.3qt create mode 100644 doc/man/man3/tqsjiscodec.3qt create mode 100644 doc/man/man3/tqslider.3qt create mode 100644 doc/man/man3/tqsocket.3qt create mode 100644 doc/man/man3/tqsocketdevice.3qt create mode 100644 doc/man/man3/tqsocketnotifier.3qt create mode 100644 doc/man/man3/tqsound.3qt create mode 100644 doc/man/man3/tqspaceritem.3qt create mode 100644 doc/man/man3/tqspinbox.3qt create mode 100644 doc/man/man3/tqsplashscreen.3qt create mode 100644 doc/man/man3/tqsplitter.3qt create mode 100644 doc/man/man3/tqsql.3qt create mode 100644 doc/man/man3/tqsqlcursor.3qt create mode 100644 doc/man/man3/tqsqldatabase.3qt create mode 100644 doc/man/man3/tqsqldriver.3qt create mode 100644 doc/man/man3/tqsqldriverplugin.3qt create mode 100644 doc/man/man3/tqsqleditorfactory.3qt create mode 100644 doc/man/man3/tqsqlerror.3qt create mode 100644 doc/man/man3/tqsqlfield.3qt create mode 100644 doc/man/man3/tqsqlfieldinfo.3qt create mode 100644 doc/man/man3/tqsqlform.3qt create mode 100644 doc/man/man3/tqsqlindex.3qt create mode 100644 doc/man/man3/tqsqlpropertymap.3qt create mode 100644 doc/man/man3/tqsqlquery.3qt create mode 100644 doc/man/man3/tqsqlrecord.3qt create mode 100644 doc/man/man3/tqsqlrecordinfo.3qt create mode 100644 doc/man/man3/tqsqlresult.3qt create mode 100644 doc/man/man3/tqsqlselectcursor.3qt create mode 100644 doc/man/man3/tqstatusbar.3qt create mode 100644 doc/man/man3/tqstoreddrag.3qt create mode 100644 doc/man/man3/tqstrilist.3qt create mode 100644 doc/man/man3/tqstring.3qt create mode 100644 doc/man/man3/tqstringlist.3qt create mode 100644 doc/man/man3/tqstrlist.3qt create mode 100644 doc/man/man3/tqstrlistiterator.3qt create mode 100644 doc/man/man3/tqstyle.3qt create mode 100644 doc/man/man3/tqstylefactory.3qt create mode 100644 doc/man/man3/tqstyleoption.3qt create mode 100644 doc/man/man3/tqstyleplugin.3qt create mode 100644 doc/man/man3/tqstylesheet.3qt create mode 100644 doc/man/man3/tqstylesheetitem.3qt create mode 100644 doc/man/man3/tqsyntaxhighlighter.3qt create mode 100644 doc/man/man3/tqt.3qt create mode 100644 doc/man/man3/tqtab.3qt create mode 100644 doc/man/man3/tqtabbar.3qt create mode 100644 doc/man/man3/tqtabdialog.3qt create mode 100644 doc/man/man3/tqtable.3qt create mode 100644 doc/man/man3/tqtableitem.3qt create mode 100644 doc/man/man3/tqtableselection.3qt create mode 100644 doc/man/man3/tqtabletevent.3qt create mode 100644 doc/man/man3/tqtabwidget.3qt create mode 100644 doc/man/man3/tqtextbrowser.3qt create mode 100644 doc/man/man3/tqtextcodec.3qt create mode 100644 doc/man/man3/tqtextcodecplugin.3qt create mode 100644 doc/man/man3/tqtextdecoder.3qt create mode 100644 doc/man/man3/tqtextdrag.3qt create mode 100644 doc/man/man3/tqtextedit.3qt create mode 100644 doc/man/man3/tqtextencoder.3qt create mode 100644 doc/man/man3/tqtextistream.3qt create mode 100644 doc/man/man3/tqtextostream.3qt create mode 100644 doc/man/man3/tqtextstream.3qt create mode 100644 doc/man/man3/tqthread.3qt create mode 100644 doc/man/man3/tqthreadstorage.3qt create mode 100644 doc/man/man3/tqtime.3qt create mode 100644 doc/man/man3/tqtimeedit.3qt create mode 100644 doc/man/man3/tqtimer.3qt create mode 100644 doc/man/man3/tqtimerevent.3qt create mode 100644 doc/man/man3/tqtoolbar.3qt create mode 100644 doc/man/man3/tqtoolbox.3qt create mode 100644 doc/man/man3/tqtoolbutton.3qt create mode 100644 doc/man/man3/tqtooltip.3qt create mode 100644 doc/man/man3/tqtooltipgroup.3qt create mode 100644 doc/man/man3/tqtranslator.3qt create mode 100644 doc/man/man3/tqtranslatormessage.3qt create mode 100644 doc/man/man3/tqtsciicodec.3qt create mode 100644 doc/man/man3/tquridrag.3qt create mode 100644 doc/man/man3/tqurl.3qt create mode 100644 doc/man/man3/tqurlinfo.3qt create mode 100644 doc/man/man3/tqurloperator.3qt create mode 100644 doc/man/man3/tquuid.3qt create mode 100644 doc/man/man3/tqvalidator.3qt create mode 100644 doc/man/man3/tqvaluelist.3qt create mode 100644 doc/man/man3/tqvaluelistconstiterator.3qt create mode 100644 doc/man/man3/tqvaluelistiterator.3qt create mode 100644 doc/man/man3/tqvaluestack.3qt create mode 100644 doc/man/man3/tqvaluevector.3qt create mode 100644 doc/man/man3/tqvariant.3qt create mode 100644 doc/man/man3/tqvbox.3qt create mode 100644 doc/man/man3/tqvboxlayout.3qt create mode 100644 doc/man/man3/tqvbuttongroup.3qt create mode 100644 doc/man/man3/tqvgroupbox.3qt create mode 100644 doc/man/man3/tqwaitcondition.3qt create mode 100644 doc/man/man3/tqwhatsthis.3qt create mode 100644 doc/man/man3/tqwheelevent.3qt create mode 100644 doc/man/man3/tqwidget.3qt create mode 100644 doc/man/man3/tqwidgetfactory.3qt create mode 100644 doc/man/man3/tqwidgetitem.3qt create mode 100644 doc/man/man3/tqwidgetplugin.3qt create mode 100644 doc/man/man3/tqwidgetstack.3qt create mode 100644 doc/man/man3/tqwindowsmime.3qt create mode 100644 doc/man/man3/tqwindowsstyle.3qt create mode 100644 doc/man/man3/tqwizard.3qt create mode 100644 doc/man/man3/tqwmatrix.3qt create mode 100644 doc/man/man3/tqworkspace.3qt create mode 100644 doc/man/man3/tqwsdecoration.3qt create mode 100644 doc/man/man3/tqwsinputmethod.3qt create mode 100644 doc/man/man3/tqwskeyboardhandler.3qt create mode 100644 doc/man/man3/tqwsmousehandler.3qt create mode 100644 doc/man/man3/tqwsserver.3qt create mode 100644 doc/man/man3/tqwswindow.3qt create mode 100644 doc/man/man3/tqxmlattributes.3qt create mode 100644 doc/man/man3/tqxmlcontenthandler.3qt create mode 100644 doc/man/man3/tqxmldeclhandler.3qt create mode 100644 doc/man/man3/tqxmldefaulthandler.3qt create mode 100644 doc/man/man3/tqxmldtdhandler.3qt create mode 100644 doc/man/man3/tqxmlentityresolver.3qt create mode 100644 doc/man/man3/tqxmlerrorhandler.3qt create mode 100644 doc/man/man3/tqxmlinputsource.3qt create mode 100644 doc/man/man3/tqxmllexicalhandler.3qt create mode 100644 doc/man/man3/tqxmllocator.3qt create mode 100644 doc/man/man3/tqxmlnamespacesupport.3qt create mode 100644 doc/man/man3/tqxmlparseexception.3qt create mode 100644 doc/man/man3/tqxmlreader.3qt create mode 100644 doc/man/man3/tqxmlsimplereader.3qt (limited to 'doc/man/man3') diff --git a/doc/man/man3/QAccel.3qt b/doc/man/man3/QAccel.3qt deleted file mode 100644 index a9fc0bb50..000000000 --- a/doc/man/man3/QAccel.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaccel.3qt diff --git a/doc/man/man3/QAccessible.3qt b/doc/man/man3/QAccessible.3qt deleted file mode 100644 index 8ff1652b2..000000000 --- a/doc/man/man3/QAccessible.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaccessible.3qt diff --git a/doc/man/man3/QAccessibleInterface.3qt b/doc/man/man3/QAccessibleInterface.3qt deleted file mode 100644 index ccbbc4202..000000000 --- a/doc/man/man3/QAccessibleInterface.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaccessibleinterface.3qt diff --git a/doc/man/man3/QAccessibleObject.3qt b/doc/man/man3/QAccessibleObject.3qt deleted file mode 100644 index 793f88871..000000000 --- a/doc/man/man3/QAccessibleObject.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaccessibleobject.3qt diff --git a/doc/man/man3/QAction.3qt b/doc/man/man3/QAction.3qt deleted file mode 100644 index 121200242..000000000 --- a/doc/man/man3/QAction.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaction.3qt diff --git a/doc/man/man3/QActionGroup.3qt b/doc/man/man3/QActionGroup.3qt deleted file mode 100644 index f88fe7f8e..000000000 --- a/doc/man/man3/QActionGroup.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qactiongroup.3qt diff --git a/doc/man/man3/QApplication.3qt b/doc/man/man3/QApplication.3qt deleted file mode 100644 index 58be38bbd..000000000 --- a/doc/man/man3/QApplication.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qapplication.3qt diff --git a/doc/man/man3/QAsciiCache.3qt b/doc/man/man3/QAsciiCache.3qt deleted file mode 100644 index 577078472..000000000 --- a/doc/man/man3/QAsciiCache.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qasciicache.3qt diff --git a/doc/man/man3/QAsciiCacheIterator.3qt b/doc/man/man3/QAsciiCacheIterator.3qt deleted file mode 100644 index aa041134e..000000000 --- a/doc/man/man3/QAsciiCacheIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qasciicacheiterator.3qt diff --git a/doc/man/man3/QAsciiDict.3qt b/doc/man/man3/QAsciiDict.3qt deleted file mode 100644 index 750f270ee..000000000 --- a/doc/man/man3/QAsciiDict.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qasciidict.3qt diff --git a/doc/man/man3/QAsciiDictIterator.3qt b/doc/man/man3/QAsciiDictIterator.3qt deleted file mode 100644 index 32c485319..000000000 --- a/doc/man/man3/QAsciiDictIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qasciidictiterator.3qt diff --git a/doc/man/man3/QAssistantClient.3qt b/doc/man/man3/QAssistantClient.3qt deleted file mode 100644 index 63fad333a..000000000 --- a/doc/man/man3/QAssistantClient.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qassistantclient.3qt diff --git a/doc/man/man3/QAxAggregated.3qt b/doc/man/man3/QAxAggregated.3qt deleted file mode 100644 index eaf21e781..000000000 --- a/doc/man/man3/QAxAggregated.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxaggregated.3qt diff --git a/doc/man/man3/QAxBase.3qt b/doc/man/man3/QAxBase.3qt deleted file mode 100644 index eaff9fd69..000000000 --- a/doc/man/man3/QAxBase.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxbase.3qt diff --git a/doc/man/man3/QAxBindable.3qt b/doc/man/man3/QAxBindable.3qt deleted file mode 100644 index 76e601640..000000000 --- a/doc/man/man3/QAxBindable.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxbindable.3qt diff --git a/doc/man/man3/QAxFactory.3qt b/doc/man/man3/QAxFactory.3qt deleted file mode 100644 index 51336b100..000000000 --- a/doc/man/man3/QAxFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxfactory.3qt diff --git a/doc/man/man3/QAxObject.3qt b/doc/man/man3/QAxObject.3qt deleted file mode 100644 index 1a03d2ec2..000000000 --- a/doc/man/man3/QAxObject.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxobject.3qt diff --git a/doc/man/man3/QAxScript.3qt b/doc/man/man3/QAxScript.3qt deleted file mode 100644 index 9ad0b7521..000000000 --- a/doc/man/man3/QAxScript.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxscript.3qt diff --git a/doc/man/man3/QAxScriptEngine.3qt b/doc/man/man3/QAxScriptEngine.3qt deleted file mode 100644 index bdb3d0ff3..000000000 --- a/doc/man/man3/QAxScriptEngine.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxscriptengine.3qt diff --git a/doc/man/man3/QAxScriptManager.3qt b/doc/man/man3/QAxScriptManager.3qt deleted file mode 100644 index 17568f696..000000000 --- a/doc/man/man3/QAxScriptManager.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxscriptmanager.3qt diff --git a/doc/man/man3/QAxWidget.3qt b/doc/man/man3/QAxWidget.3qt deleted file mode 100644 index 628b4e395..000000000 --- a/doc/man/man3/QAxWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qaxwidget.3qt diff --git a/doc/man/man3/QBig5Codec.3qt b/doc/man/man3/QBig5Codec.3qt deleted file mode 100644 index 38f113947..000000000 --- a/doc/man/man3/QBig5Codec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbig5codec.3qt diff --git a/doc/man/man3/QBig5hkscsCodec.3qt b/doc/man/man3/QBig5hkscsCodec.3qt deleted file mode 100644 index 3162729b4..000000000 --- a/doc/man/man3/QBig5hkscsCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbig5hkscscodec.3qt diff --git a/doc/man/man3/QBitArray.3qt b/doc/man/man3/QBitArray.3qt deleted file mode 100644 index c038849a3..000000000 --- a/doc/man/man3/QBitArray.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbitarray.3qt diff --git a/doc/man/man3/QBitVal.3qt b/doc/man/man3/QBitVal.3qt deleted file mode 100644 index 0071497aa..000000000 --- a/doc/man/man3/QBitVal.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbitval.3qt diff --git a/doc/man/man3/QBitmap.3qt b/doc/man/man3/QBitmap.3qt deleted file mode 100644 index 58bcf31a2..000000000 --- a/doc/man/man3/QBitmap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbitmap.3qt diff --git a/doc/man/man3/QBoxLayout.3qt b/doc/man/man3/QBoxLayout.3qt deleted file mode 100644 index bcda2ae06..000000000 --- a/doc/man/man3/QBoxLayout.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qboxlayout.3qt diff --git a/doc/man/man3/QBrush.3qt b/doc/man/man3/QBrush.3qt deleted file mode 100644 index dd4d55987..000000000 --- a/doc/man/man3/QBrush.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbrush.3qt diff --git a/doc/man/man3/QBuffer.3qt b/doc/man/man3/QBuffer.3qt deleted file mode 100644 index 458f53b71..000000000 --- a/doc/man/man3/QBuffer.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbuffer.3qt diff --git a/doc/man/man3/QButton.3qt b/doc/man/man3/QButton.3qt deleted file mode 100644 index 442d65abe..000000000 --- a/doc/man/man3/QButton.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbutton.3qt diff --git a/doc/man/man3/QButtonGroup.3qt b/doc/man/man3/QButtonGroup.3qt deleted file mode 100644 index da65dec9a..000000000 --- a/doc/man/man3/QButtonGroup.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbuttongroup.3qt diff --git a/doc/man/man3/QByteArray.3qt b/doc/man/man3/QByteArray.3qt deleted file mode 100644 index 6ee12661f..000000000 --- a/doc/man/man3/QByteArray.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qbytearray.3qt diff --git a/doc/man/man3/QCDEStyle.3qt b/doc/man/man3/QCDEStyle.3qt deleted file mode 100644 index 3928f50fc..000000000 --- a/doc/man/man3/QCDEStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcdestyle.3qt diff --git a/doc/man/man3/QCString.3qt b/doc/man/man3/QCString.3qt deleted file mode 100644 index 9bfa0a314..000000000 --- a/doc/man/man3/QCString.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcstring.3qt diff --git a/doc/man/man3/QCache.3qt b/doc/man/man3/QCache.3qt deleted file mode 100644 index 6a779271b..000000000 --- a/doc/man/man3/QCache.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcache.3qt diff --git a/doc/man/man3/QCacheIterator.3qt b/doc/man/man3/QCacheIterator.3qt deleted file mode 100644 index 7dd86df27..000000000 --- a/doc/man/man3/QCacheIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcacheiterator.3qt diff --git a/doc/man/man3/QCanvas.3qt b/doc/man/man3/QCanvas.3qt deleted file mode 100644 index f117aa4c9..000000000 --- a/doc/man/man3/QCanvas.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvas.3qt diff --git a/doc/man/man3/QCanvasEllipse.3qt b/doc/man/man3/QCanvasEllipse.3qt deleted file mode 100644 index b2cea0a7c..000000000 --- a/doc/man/man3/QCanvasEllipse.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvasellipse.3qt diff --git a/doc/man/man3/QCanvasItem.3qt b/doc/man/man3/QCanvasItem.3qt deleted file mode 100644 index 553e36ce9..000000000 --- a/doc/man/man3/QCanvasItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvasitem.3qt diff --git a/doc/man/man3/QCanvasItemList.3qt b/doc/man/man3/QCanvasItemList.3qt deleted file mode 100644 index 1a871d328..000000000 --- a/doc/man/man3/QCanvasItemList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvasitemlist.3qt diff --git a/doc/man/man3/QCanvasLine.3qt b/doc/man/man3/QCanvasLine.3qt deleted file mode 100644 index aa7e1c058..000000000 --- a/doc/man/man3/QCanvasLine.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvasline.3qt diff --git a/doc/man/man3/QCanvasPixmap.3qt b/doc/man/man3/QCanvasPixmap.3qt deleted file mode 100644 index 666942539..000000000 --- a/doc/man/man3/QCanvasPixmap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvaspixmap.3qt diff --git a/doc/man/man3/QCanvasPixmapArray.3qt b/doc/man/man3/QCanvasPixmapArray.3qt deleted file mode 100644 index 69010c72f..000000000 --- a/doc/man/man3/QCanvasPixmapArray.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvaspixmaparray.3qt diff --git a/doc/man/man3/QCanvasPolygon.3qt b/doc/man/man3/QCanvasPolygon.3qt deleted file mode 100644 index 348fa1259..000000000 --- a/doc/man/man3/QCanvasPolygon.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvaspolygon.3qt diff --git a/doc/man/man3/QCanvasPolygonalItem.3qt b/doc/man/man3/QCanvasPolygonalItem.3qt deleted file mode 100644 index cf6c434ac..000000000 --- a/doc/man/man3/QCanvasPolygonalItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvaspolygonalitem.3qt diff --git a/doc/man/man3/QCanvasRectangle.3qt b/doc/man/man3/QCanvasRectangle.3qt deleted file mode 100644 index ebadbbe86..000000000 --- a/doc/man/man3/QCanvasRectangle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvasrectangle.3qt diff --git a/doc/man/man3/QCanvasSpline.3qt b/doc/man/man3/QCanvasSpline.3qt deleted file mode 100644 index b03187069..000000000 --- a/doc/man/man3/QCanvasSpline.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvasspline.3qt diff --git a/doc/man/man3/QCanvasSprite.3qt b/doc/man/man3/QCanvasSprite.3qt deleted file mode 100644 index 0aeb9f39b..000000000 --- a/doc/man/man3/QCanvasSprite.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvassprite.3qt diff --git a/doc/man/man3/QCanvasText.3qt b/doc/man/man3/QCanvasText.3qt deleted file mode 100644 index e8caf1cbc..000000000 --- a/doc/man/man3/QCanvasText.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvastext.3qt diff --git a/doc/man/man3/QCanvasView.3qt b/doc/man/man3/QCanvasView.3qt deleted file mode 100644 index 534014cda..000000000 --- a/doc/man/man3/QCanvasView.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcanvasview.3qt diff --git a/doc/man/man3/QChar.3qt b/doc/man/man3/QChar.3qt deleted file mode 100644 index 420b150ad..000000000 --- a/doc/man/man3/QChar.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qchar.3qt diff --git a/doc/man/man3/QCharRef.3qt b/doc/man/man3/QCharRef.3qt deleted file mode 100644 index b465894fd..000000000 --- a/doc/man/man3/QCharRef.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcharref.3qt diff --git a/doc/man/man3/QCheckBox.3qt b/doc/man/man3/QCheckBox.3qt deleted file mode 100644 index fce0bd248..000000000 --- a/doc/man/man3/QCheckBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcheckbox.3qt diff --git a/doc/man/man3/QCheckListItem.3qt b/doc/man/man3/QCheckListItem.3qt deleted file mode 100644 index 508ff1921..000000000 --- a/doc/man/man3/QCheckListItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qchecklistitem.3qt diff --git a/doc/man/man3/QCheckTableItem.3qt b/doc/man/man3/QCheckTableItem.3qt deleted file mode 100644 index 11799c8db..000000000 --- a/doc/man/man3/QCheckTableItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qchecktableitem.3qt diff --git a/doc/man/man3/QChildEvent.3qt b/doc/man/man3/QChildEvent.3qt deleted file mode 100644 index accb58a19..000000000 --- a/doc/man/man3/QChildEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qchildevent.3qt diff --git a/doc/man/man3/QClipboard.3qt b/doc/man/man3/QClipboard.3qt deleted file mode 100644 index 47af37fcc..000000000 --- a/doc/man/man3/QClipboard.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qclipboard.3qt diff --git a/doc/man/man3/QCloseEvent.3qt b/doc/man/man3/QCloseEvent.3qt deleted file mode 100644 index e223e329b..000000000 --- a/doc/man/man3/QCloseEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcloseevent.3qt diff --git a/doc/man/man3/QColor.3qt b/doc/man/man3/QColor.3qt deleted file mode 100644 index eba87ddb6..000000000 --- a/doc/man/man3/QColor.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcolor.3qt diff --git a/doc/man/man3/QColorDialog.3qt b/doc/man/man3/QColorDialog.3qt deleted file mode 100644 index d945882dc..000000000 --- a/doc/man/man3/QColorDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcolordialog.3qt diff --git a/doc/man/man3/QColorDrag.3qt b/doc/man/man3/QColorDrag.3qt deleted file mode 100644 index 06bf47149..000000000 --- a/doc/man/man3/QColorDrag.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcolordrag.3qt diff --git a/doc/man/man3/QColorGroup.3qt b/doc/man/man3/QColorGroup.3qt deleted file mode 100644 index 77af90a61..000000000 --- a/doc/man/man3/QColorGroup.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcolorgroup.3qt diff --git a/doc/man/man3/QComboBox.3qt b/doc/man/man3/QComboBox.3qt deleted file mode 100644 index 6c208efe3..000000000 --- a/doc/man/man3/QComboBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcombobox.3qt diff --git a/doc/man/man3/QComboTableItem.3qt b/doc/man/man3/QComboTableItem.3qt deleted file mode 100644 index 7bc478eb5..000000000 --- a/doc/man/man3/QComboTableItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcombotableitem.3qt diff --git a/doc/man/man3/QCommonStyle.3qt b/doc/man/man3/QCommonStyle.3qt deleted file mode 100644 index 9c6158095..000000000 --- a/doc/man/man3/QCommonStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcommonstyle.3qt diff --git a/doc/man/man3/QConstString.3qt b/doc/man/man3/QConstString.3qt deleted file mode 100644 index 565854990..000000000 --- a/doc/man/man3/QConstString.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qconststring.3qt diff --git a/doc/man/man3/QContextMenuEvent.3qt b/doc/man/man3/QContextMenuEvent.3qt deleted file mode 100644 index ba554c0a4..000000000 --- a/doc/man/man3/QContextMenuEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcontextmenuevent.3qt diff --git a/doc/man/man3/QCopChannel.3qt b/doc/man/man3/QCopChannel.3qt deleted file mode 100644 index 35d01b0ef..000000000 --- a/doc/man/man3/QCopChannel.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcopchannel.3qt diff --git a/doc/man/man3/QCursor.3qt b/doc/man/man3/QCursor.3qt deleted file mode 100644 index cb8f2efd5..000000000 --- a/doc/man/man3/QCursor.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcursor.3qt diff --git a/doc/man/man3/QCustomEvent.3qt b/doc/man/man3/QCustomEvent.3qt deleted file mode 100644 index 5a4166cc0..000000000 --- a/doc/man/man3/QCustomEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcustomevent.3qt diff --git a/doc/man/man3/QCustomMenuItem.3qt b/doc/man/man3/QCustomMenuItem.3qt deleted file mode 100644 index 8157c72aa..000000000 --- a/doc/man/man3/QCustomMenuItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qcustommenuitem.3qt diff --git a/doc/man/man3/QDataBrowser.3qt b/doc/man/man3/QDataBrowser.3qt deleted file mode 100644 index b11342ef5..000000000 --- a/doc/man/man3/QDataBrowser.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdatabrowser.3qt diff --git a/doc/man/man3/QDataStream.3qt b/doc/man/man3/QDataStream.3qt deleted file mode 100644 index b2bfba375..000000000 --- a/doc/man/man3/QDataStream.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdatastream.3qt diff --git a/doc/man/man3/QDataTable.3qt b/doc/man/man3/QDataTable.3qt deleted file mode 100644 index 61b901842..000000000 --- a/doc/man/man3/QDataTable.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdatatable.3qt diff --git a/doc/man/man3/QDataView.3qt b/doc/man/man3/QDataView.3qt deleted file mode 100644 index bd034924a..000000000 --- a/doc/man/man3/QDataView.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdataview.3qt diff --git a/doc/man/man3/QDate.3qt b/doc/man/man3/QDate.3qt deleted file mode 100644 index b50599553..000000000 --- a/doc/man/man3/QDate.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdate.3qt diff --git a/doc/man/man3/QDateEdit.3qt b/doc/man/man3/QDateEdit.3qt deleted file mode 100644 index be6df0cf6..000000000 --- a/doc/man/man3/QDateEdit.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdateedit.3qt diff --git a/doc/man/man3/QDateTime.3qt b/doc/man/man3/QDateTime.3qt deleted file mode 100644 index 23afa067d..000000000 --- a/doc/man/man3/QDateTime.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdatetime.3qt diff --git a/doc/man/man3/QDateTimeEdit.3qt b/doc/man/man3/QDateTimeEdit.3qt deleted file mode 100644 index b51537896..000000000 --- a/doc/man/man3/QDateTimeEdit.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdatetimeedit.3qt diff --git a/doc/man/man3/QDateTimeEditBase.3qt b/doc/man/man3/QDateTimeEditBase.3qt deleted file mode 100644 index ad813f8da..000000000 --- a/doc/man/man3/QDateTimeEditBase.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdatetimeeditbase.3qt diff --git a/doc/man/man3/QDeepCopy.3qt b/doc/man/man3/QDeepCopy.3qt deleted file mode 100644 index 2cf6e7913..000000000 --- a/doc/man/man3/QDeepCopy.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdeepcopy.3qt diff --git a/doc/man/man3/QDesktopWidget.3qt b/doc/man/man3/QDesktopWidget.3qt deleted file mode 100644 index dab324876..000000000 --- a/doc/man/man3/QDesktopWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdesktopwidget.3qt diff --git a/doc/man/man3/QDial.3qt b/doc/man/man3/QDial.3qt deleted file mode 100644 index 56c4e7b13..000000000 --- a/doc/man/man3/QDial.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdial.3qt diff --git a/doc/man/man3/QDialog.3qt b/doc/man/man3/QDialog.3qt deleted file mode 100644 index 0954f9997..000000000 --- a/doc/man/man3/QDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdialog.3qt diff --git a/doc/man/man3/QDict.3qt b/doc/man/man3/QDict.3qt deleted file mode 100644 index bfcc71f18..000000000 --- a/doc/man/man3/QDict.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdict.3qt diff --git a/doc/man/man3/QDictIterator.3qt b/doc/man/man3/QDictIterator.3qt deleted file mode 100644 index c1cf4a1ea..000000000 --- a/doc/man/man3/QDictIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdictiterator.3qt diff --git a/doc/man/man3/QDir.3qt b/doc/man/man3/QDir.3qt deleted file mode 100644 index f6809fa08..000000000 --- a/doc/man/man3/QDir.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdir.3qt diff --git a/doc/man/man3/QDirectPainter.3qt b/doc/man/man3/QDirectPainter.3qt deleted file mode 100644 index 4894aa811..000000000 --- a/doc/man/man3/QDirectPainter.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdirectpainter.3qt diff --git a/doc/man/man3/QDns.3qt b/doc/man/man3/QDns.3qt deleted file mode 100644 index 233f91aaf..000000000 --- a/doc/man/man3/QDns.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdns.3qt diff --git a/doc/man/man3/QDockArea.3qt b/doc/man/man3/QDockArea.3qt deleted file mode 100644 index ab8bc6d69..000000000 --- a/doc/man/man3/QDockArea.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdockarea.3qt diff --git a/doc/man/man3/QDockWindow.3qt b/doc/man/man3/QDockWindow.3qt deleted file mode 100644 index e3c5ab17e..000000000 --- a/doc/man/man3/QDockWindow.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdockwindow.3qt diff --git a/doc/man/man3/QDomAttr.3qt b/doc/man/man3/QDomAttr.3qt deleted file mode 100644 index 003eb5bd4..000000000 --- a/doc/man/man3/QDomAttr.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomattr.3qt diff --git a/doc/man/man3/QDomCDATASection.3qt b/doc/man/man3/QDomCDATASection.3qt deleted file mode 100644 index 6b603bd3d..000000000 --- a/doc/man/man3/QDomCDATASection.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomcdatasection.3qt diff --git a/doc/man/man3/QDomCharacterData.3qt b/doc/man/man3/QDomCharacterData.3qt deleted file mode 100644 index ab4eed498..000000000 --- a/doc/man/man3/QDomCharacterData.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomcharacterdata.3qt diff --git a/doc/man/man3/QDomComment.3qt b/doc/man/man3/QDomComment.3qt deleted file mode 100644 index ea469ab45..000000000 --- a/doc/man/man3/QDomComment.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomcomment.3qt diff --git a/doc/man/man3/QDomDocument.3qt b/doc/man/man3/QDomDocument.3qt deleted file mode 100644 index ac919eaeb..000000000 --- a/doc/man/man3/QDomDocument.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomdocument.3qt diff --git a/doc/man/man3/QDomDocumentFragment.3qt b/doc/man/man3/QDomDocumentFragment.3qt deleted file mode 100644 index e9871e82c..000000000 --- a/doc/man/man3/QDomDocumentFragment.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomdocumentfragment.3qt diff --git a/doc/man/man3/QDomDocumentType.3qt b/doc/man/man3/QDomDocumentType.3qt deleted file mode 100644 index ba32a6803..000000000 --- a/doc/man/man3/QDomDocumentType.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomdocumenttype.3qt diff --git a/doc/man/man3/QDomElement.3qt b/doc/man/man3/QDomElement.3qt deleted file mode 100644 index 046dcbe98..000000000 --- a/doc/man/man3/QDomElement.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomelement.3qt diff --git a/doc/man/man3/QDomEntity.3qt b/doc/man/man3/QDomEntity.3qt deleted file mode 100644 index 0236af4dc..000000000 --- a/doc/man/man3/QDomEntity.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomentity.3qt diff --git a/doc/man/man3/QDomEntityReference.3qt b/doc/man/man3/QDomEntityReference.3qt deleted file mode 100644 index 7c8cf20a8..000000000 --- a/doc/man/man3/QDomEntityReference.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomentityreference.3qt diff --git a/doc/man/man3/QDomImplementation.3qt b/doc/man/man3/QDomImplementation.3qt deleted file mode 100644 index 8a5301c14..000000000 --- a/doc/man/man3/QDomImplementation.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomimplementation.3qt diff --git a/doc/man/man3/QDomNamedNodeMap.3qt b/doc/man/man3/QDomNamedNodeMap.3qt deleted file mode 100644 index dfc1080b4..000000000 --- a/doc/man/man3/QDomNamedNodeMap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomnamednodemap.3qt diff --git a/doc/man/man3/QDomNode.3qt b/doc/man/man3/QDomNode.3qt deleted file mode 100644 index ee82a8bb2..000000000 --- a/doc/man/man3/QDomNode.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomnode.3qt diff --git a/doc/man/man3/QDomNodeList.3qt b/doc/man/man3/QDomNodeList.3qt deleted file mode 100644 index fadda0bd9..000000000 --- a/doc/man/man3/QDomNodeList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomnodelist.3qt diff --git a/doc/man/man3/QDomNotation.3qt b/doc/man/man3/QDomNotation.3qt deleted file mode 100644 index 8d78d3b30..000000000 --- a/doc/man/man3/QDomNotation.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomnotation.3qt diff --git a/doc/man/man3/QDomProcessingInstruction.3qt b/doc/man/man3/QDomProcessingInstruction.3qt deleted file mode 100644 index c30c5444b..000000000 --- a/doc/man/man3/QDomProcessingInstruction.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomprocessinginstruction.3qt diff --git a/doc/man/man3/QDomText.3qt b/doc/man/man3/QDomText.3qt deleted file mode 100644 index fbad364a3..000000000 --- a/doc/man/man3/QDomText.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdomtext.3qt diff --git a/doc/man/man3/QDoubleValidator.3qt b/doc/man/man3/QDoubleValidator.3qt deleted file mode 100644 index 297ec58a2..000000000 --- a/doc/man/man3/QDoubleValidator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdoublevalidator.3qt diff --git a/doc/man/man3/QDragEnterEvent.3qt b/doc/man/man3/QDragEnterEvent.3qt deleted file mode 100644 index 45e6f9e60..000000000 --- a/doc/man/man3/QDragEnterEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdragenterevent.3qt diff --git a/doc/man/man3/QDragLeaveEvent.3qt b/doc/man/man3/QDragLeaveEvent.3qt deleted file mode 100644 index 77603bf82..000000000 --- a/doc/man/man3/QDragLeaveEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdragleaveevent.3qt diff --git a/doc/man/man3/QDragMoveEvent.3qt b/doc/man/man3/QDragMoveEvent.3qt deleted file mode 100644 index 7cee72787..000000000 --- a/doc/man/man3/QDragMoveEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdragmoveevent.3qt diff --git a/doc/man/man3/QDragObject.3qt b/doc/man/man3/QDragObject.3qt deleted file mode 100644 index c4f29dffb..000000000 --- a/doc/man/man3/QDragObject.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdragobject.3qt diff --git a/doc/man/man3/QDropEvent.3qt b/doc/man/man3/QDropEvent.3qt deleted file mode 100644 index 336db2dab..000000000 --- a/doc/man/man3/QDropEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qdropevent.3qt diff --git a/doc/man/man3/QEditorFactory.3qt b/doc/man/man3/QEditorFactory.3qt deleted file mode 100644 index ffa57380d..000000000 --- a/doc/man/man3/QEditorFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qeditorfactory.3qt diff --git a/doc/man/man3/QErrorMessage.3qt b/doc/man/man3/QErrorMessage.3qt deleted file mode 100644 index ddff21d36..000000000 --- a/doc/man/man3/QErrorMessage.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qerrormessage.3qt diff --git a/doc/man/man3/QEucJpCodec.3qt b/doc/man/man3/QEucJpCodec.3qt deleted file mode 100644 index b94e9a931..000000000 --- a/doc/man/man3/QEucJpCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qeucjpcodec.3qt diff --git a/doc/man/man3/QEucKrCodec.3qt b/doc/man/man3/QEucKrCodec.3qt deleted file mode 100644 index 1677c6848..000000000 --- a/doc/man/man3/QEucKrCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qeuckrcodec.3qt diff --git a/doc/man/man3/QEvent.3qt b/doc/man/man3/QEvent.3qt deleted file mode 100644 index a01f6defb..000000000 --- a/doc/man/man3/QEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qevent.3qt diff --git a/doc/man/man3/QEventLoop.3qt b/doc/man/man3/QEventLoop.3qt deleted file mode 100644 index 760613489..000000000 --- a/doc/man/man3/QEventLoop.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qeventloop.3qt diff --git a/doc/man/man3/QFile.3qt b/doc/man/man3/QFile.3qt deleted file mode 100644 index b49e2c7b3..000000000 --- a/doc/man/man3/QFile.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfile.3qt diff --git a/doc/man/man3/QFileDialog.3qt b/doc/man/man3/QFileDialog.3qt deleted file mode 100644 index 86bdc94c6..000000000 --- a/doc/man/man3/QFileDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfiledialog.3qt diff --git a/doc/man/man3/QFileIconProvider.3qt b/doc/man/man3/QFileIconProvider.3qt deleted file mode 100644 index db0462759..000000000 --- a/doc/man/man3/QFileIconProvider.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfileiconprovider.3qt diff --git a/doc/man/man3/QFileInfo.3qt b/doc/man/man3/QFileInfo.3qt deleted file mode 100644 index be3ea6cb0..000000000 --- a/doc/man/man3/QFileInfo.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfileinfo.3qt diff --git a/doc/man/man3/QFilePreview.3qt b/doc/man/man3/QFilePreview.3qt deleted file mode 100644 index 5cc02f8a2..000000000 --- a/doc/man/man3/QFilePreview.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfilepreview.3qt diff --git a/doc/man/man3/QFocusData.3qt b/doc/man/man3/QFocusData.3qt deleted file mode 100644 index 2a5115c24..000000000 --- a/doc/man/man3/QFocusData.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfocusdata.3qt diff --git a/doc/man/man3/QFocusEvent.3qt b/doc/man/man3/QFocusEvent.3qt deleted file mode 100644 index d4cc8a33e..000000000 --- a/doc/man/man3/QFocusEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfocusevent.3qt diff --git a/doc/man/man3/QFont.3qt b/doc/man/man3/QFont.3qt deleted file mode 100644 index b9f4e47cb..000000000 --- a/doc/man/man3/QFont.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfont.3qt diff --git a/doc/man/man3/QFontDatabase.3qt b/doc/man/man3/QFontDatabase.3qt deleted file mode 100644 index 075fa2c33..000000000 --- a/doc/man/man3/QFontDatabase.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfontdatabase.3qt diff --git a/doc/man/man3/QFontDialog.3qt b/doc/man/man3/QFontDialog.3qt deleted file mode 100644 index a4bbce1bd..000000000 --- a/doc/man/man3/QFontDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfontdialog.3qt diff --git a/doc/man/man3/QFontInfo.3qt b/doc/man/man3/QFontInfo.3qt deleted file mode 100644 index 209263bf1..000000000 --- a/doc/man/man3/QFontInfo.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfontinfo.3qt diff --git a/doc/man/man3/QFontManager.3qt b/doc/man/man3/QFontManager.3qt deleted file mode 100644 index eb64d4e88..000000000 --- a/doc/man/man3/QFontManager.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfontmanager.3qt diff --git a/doc/man/man3/QFontMetrics.3qt b/doc/man/man3/QFontMetrics.3qt deleted file mode 100644 index f08102552..000000000 --- a/doc/man/man3/QFontMetrics.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qfontmetrics.3qt diff --git a/doc/man/man3/QFrame.3qt b/doc/man/man3/QFrame.3qt deleted file mode 100644 index 6fe6149e7..000000000 --- a/doc/man/man3/QFrame.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qframe.3qt diff --git a/doc/man/man3/QFtp.3qt b/doc/man/man3/QFtp.3qt deleted file mode 100644 index 569dd616e..000000000 --- a/doc/man/man3/QFtp.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qftp.3qt diff --git a/doc/man/man3/QGL.3qt b/doc/man/man3/QGL.3qt deleted file mode 100644 index 89ed7ff9c..000000000 --- a/doc/man/man3/QGL.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgl.3qt diff --git a/doc/man/man3/QGLColormap.3qt b/doc/man/man3/QGLColormap.3qt deleted file mode 100644 index b96d04bf9..000000000 --- a/doc/man/man3/QGLColormap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qglcolormap.3qt diff --git a/doc/man/man3/QGLContext.3qt b/doc/man/man3/QGLContext.3qt deleted file mode 100644 index 01cf513dc..000000000 --- a/doc/man/man3/QGLContext.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qglcontext.3qt diff --git a/doc/man/man3/QGLFormat.3qt b/doc/man/man3/QGLFormat.3qt deleted file mode 100644 index ac78b27d8..000000000 --- a/doc/man/man3/QGLFormat.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qglformat.3qt diff --git a/doc/man/man3/QGLWidget.3qt b/doc/man/man3/QGLWidget.3qt deleted file mode 100644 index 8c66dae3f..000000000 --- a/doc/man/man3/QGLWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qglwidget.3qt diff --git a/doc/man/man3/QGLayoutIterator.3qt b/doc/man/man3/QGLayoutIterator.3qt deleted file mode 100644 index f578f9ff3..000000000 --- a/doc/man/man3/QGLayoutIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qglayoutiterator.3qt diff --git a/doc/man/man3/QGb18030Codec.3qt b/doc/man/man3/QGb18030Codec.3qt deleted file mode 100644 index 0670e9cf8..000000000 --- a/doc/man/man3/QGb18030Codec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgb18030codec.3qt diff --git a/doc/man/man3/QGb2312Codec.3qt b/doc/man/man3/QGb2312Codec.3qt deleted file mode 100644 index 779224794..000000000 --- a/doc/man/man3/QGb2312Codec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgb2312codec.3qt diff --git a/doc/man/man3/QGbkCodec.3qt b/doc/man/man3/QGbkCodec.3qt deleted file mode 100644 index fa119da86..000000000 --- a/doc/man/man3/QGbkCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgbkcodec.3qt diff --git a/doc/man/man3/QGfxDriverFactory.3qt b/doc/man/man3/QGfxDriverFactory.3qt deleted file mode 100644 index 9dde1cd5c..000000000 --- a/doc/man/man3/QGfxDriverFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgfxdriverfactory.3qt diff --git a/doc/man/man3/QGfxDriverPlugin.3qt b/doc/man/man3/QGfxDriverPlugin.3qt deleted file mode 100644 index 656beb82e..000000000 --- a/doc/man/man3/QGfxDriverPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgfxdriverplugin.3qt diff --git a/doc/man/man3/QGrid.3qt b/doc/man/man3/QGrid.3qt deleted file mode 100644 index c31d961cb..000000000 --- a/doc/man/man3/QGrid.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgrid.3qt diff --git a/doc/man/man3/QGridLayout.3qt b/doc/man/man3/QGridLayout.3qt deleted file mode 100644 index c594c2dd9..000000000 --- a/doc/man/man3/QGridLayout.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgridlayout.3qt diff --git a/doc/man/man3/QGridView.3qt b/doc/man/man3/QGridView.3qt deleted file mode 100644 index c666a1cf1..000000000 --- a/doc/man/man3/QGridView.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgridview.3qt diff --git a/doc/man/man3/QGroupBox.3qt b/doc/man/man3/QGroupBox.3qt deleted file mode 100644 index 9f5a8df31..000000000 --- a/doc/man/man3/QGroupBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qgroupbox.3qt diff --git a/doc/man/man3/QGuardedPtr.3qt b/doc/man/man3/QGuardedPtr.3qt deleted file mode 100644 index 17e743838..000000000 --- a/doc/man/man3/QGuardedPtr.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qguardedptr.3qt diff --git a/doc/man/man3/QHBox.3qt b/doc/man/man3/QHBox.3qt deleted file mode 100644 index 8157b08a5..000000000 --- a/doc/man/man3/QHBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhbox.3qt diff --git a/doc/man/man3/QHBoxLayout.3qt b/doc/man/man3/QHBoxLayout.3qt deleted file mode 100644 index de7818bd5..000000000 --- a/doc/man/man3/QHBoxLayout.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhboxlayout.3qt diff --git a/doc/man/man3/QHButtonGroup.3qt b/doc/man/man3/QHButtonGroup.3qt deleted file mode 100644 index 4f54007f8..000000000 --- a/doc/man/man3/QHButtonGroup.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhbuttongroup.3qt diff --git a/doc/man/man3/QHGroupBox.3qt b/doc/man/man3/QHGroupBox.3qt deleted file mode 100644 index 3f49ce193..000000000 --- a/doc/man/man3/QHGroupBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhgroupbox.3qt diff --git a/doc/man/man3/QHeader.3qt b/doc/man/man3/QHeader.3qt deleted file mode 100644 index f5e3758de..000000000 --- a/doc/man/man3/QHeader.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qheader.3qt diff --git a/doc/man/man3/QHebrewCodec.3qt b/doc/man/man3/QHebrewCodec.3qt deleted file mode 100644 index 10663d82d..000000000 --- a/doc/man/man3/QHebrewCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhebrewcodec.3qt diff --git a/doc/man/man3/QHideEvent.3qt b/doc/man/man3/QHideEvent.3qt deleted file mode 100644 index 87795c45f..000000000 --- a/doc/man/man3/QHideEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhideevent.3qt diff --git a/doc/man/man3/QHostAddress.3qt b/doc/man/man3/QHostAddress.3qt deleted file mode 100644 index 97869cbb4..000000000 --- a/doc/man/man3/QHostAddress.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhostaddress.3qt diff --git a/doc/man/man3/QHttp.3qt b/doc/man/man3/QHttp.3qt deleted file mode 100644 index 2ebc7edae..000000000 --- a/doc/man/man3/QHttp.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhttp.3qt diff --git a/doc/man/man3/QHttpHeader.3qt b/doc/man/man3/QHttpHeader.3qt deleted file mode 100644 index 135acc193..000000000 --- a/doc/man/man3/QHttpHeader.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhttpheader.3qt diff --git a/doc/man/man3/QHttpRequestHeader.3qt b/doc/man/man3/QHttpRequestHeader.3qt deleted file mode 100644 index 16d311ac2..000000000 --- a/doc/man/man3/QHttpRequestHeader.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhttprequestheader.3qt diff --git a/doc/man/man3/QHttpResponseHeader.3qt b/doc/man/man3/QHttpResponseHeader.3qt deleted file mode 100644 index 47916ae82..000000000 --- a/doc/man/man3/QHttpResponseHeader.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qhttpresponseheader.3qt diff --git a/doc/man/man3/QIMEvent.3qt b/doc/man/man3/QIMEvent.3qt deleted file mode 100644 index 9521c286e..000000000 --- a/doc/man/man3/QIMEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimevent.3qt diff --git a/doc/man/man3/QIODevice.3qt b/doc/man/man3/QIODevice.3qt deleted file mode 100644 index 44812b28e..000000000 --- a/doc/man/man3/QIODevice.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qiodevice.3qt diff --git a/doc/man/man3/QIconDrag.3qt b/doc/man/man3/QIconDrag.3qt deleted file mode 100644 index 3e22169fc..000000000 --- a/doc/man/man3/QIconDrag.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qicondrag.3qt diff --git a/doc/man/man3/QIconDragEvent.3qt b/doc/man/man3/QIconDragEvent.3qt deleted file mode 100644 index f6c18a6a8..000000000 --- a/doc/man/man3/QIconDragEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qicondragevent.3qt diff --git a/doc/man/man3/QIconDragItem.3qt b/doc/man/man3/QIconDragItem.3qt deleted file mode 100644 index 75c58d162..000000000 --- a/doc/man/man3/QIconDragItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qicondragitem.3qt diff --git a/doc/man/man3/QIconFactory.3qt b/doc/man/man3/QIconFactory.3qt deleted file mode 100644 index b4ca32ec4..000000000 --- a/doc/man/man3/QIconFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qiconfactory.3qt diff --git a/doc/man/man3/QIconSet.3qt b/doc/man/man3/QIconSet.3qt deleted file mode 100644 index e57c30467..000000000 --- a/doc/man/man3/QIconSet.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qiconset.3qt diff --git a/doc/man/man3/QIconView.3qt b/doc/man/man3/QIconView.3qt deleted file mode 100644 index 4db5c6c98..000000000 --- a/doc/man/man3/QIconView.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qiconview.3qt diff --git a/doc/man/man3/QIconViewItem.3qt b/doc/man/man3/QIconViewItem.3qt deleted file mode 100644 index d29495d78..000000000 --- a/doc/man/man3/QIconViewItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qiconviewitem.3qt diff --git a/doc/man/man3/QImage.3qt b/doc/man/man3/QImage.3qt deleted file mode 100644 index 84e17b879..000000000 --- a/doc/man/man3/QImage.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimage.3qt diff --git a/doc/man/man3/QImageConsumer.3qt b/doc/man/man3/QImageConsumer.3qt deleted file mode 100644 index e293f8477..000000000 --- a/doc/man/man3/QImageConsumer.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimageconsumer.3qt diff --git a/doc/man/man3/QImageDecoder.3qt b/doc/man/man3/QImageDecoder.3qt deleted file mode 100644 index 414c7077b..000000000 --- a/doc/man/man3/QImageDecoder.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimagedecoder.3qt diff --git a/doc/man/man3/QImageDrag.3qt b/doc/man/man3/QImageDrag.3qt deleted file mode 100644 index c0ae00b3f..000000000 --- a/doc/man/man3/QImageDrag.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimagedrag.3qt diff --git a/doc/man/man3/QImageFormat.3qt b/doc/man/man3/QImageFormat.3qt deleted file mode 100644 index 08b6b9749..000000000 --- a/doc/man/man3/QImageFormat.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimageformat.3qt diff --git a/doc/man/man3/QImageFormatPlugin.3qt b/doc/man/man3/QImageFormatPlugin.3qt deleted file mode 100644 index a0d1eb9e3..000000000 --- a/doc/man/man3/QImageFormatPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimageformatplugin.3qt diff --git a/doc/man/man3/QImageFormatType.3qt b/doc/man/man3/QImageFormatType.3qt deleted file mode 100644 index 8efbbf297..000000000 --- a/doc/man/man3/QImageFormatType.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimageformattype.3qt diff --git a/doc/man/man3/QImageIO.3qt b/doc/man/man3/QImageIO.3qt deleted file mode 100644 index 6a19a01c6..000000000 --- a/doc/man/man3/QImageIO.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qimageio.3qt diff --git a/doc/man/man3/QInputDialog.3qt b/doc/man/man3/QInputDialog.3qt deleted file mode 100644 index 417829b72..000000000 --- a/doc/man/man3/QInputDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qinputdialog.3qt diff --git a/doc/man/man3/QIntCache.3qt b/doc/man/man3/QIntCache.3qt deleted file mode 100644 index dec1afdb2..000000000 --- a/doc/man/man3/QIntCache.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qintcache.3qt diff --git a/doc/man/man3/QIntCacheIterator.3qt b/doc/man/man3/QIntCacheIterator.3qt deleted file mode 100644 index b7af93d70..000000000 --- a/doc/man/man3/QIntCacheIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qintcacheiterator.3qt diff --git a/doc/man/man3/QIntDict.3qt b/doc/man/man3/QIntDict.3qt deleted file mode 100644 index 23ced0cd0..000000000 --- a/doc/man/man3/QIntDict.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qintdict.3qt diff --git a/doc/man/man3/QIntDictIterator.3qt b/doc/man/man3/QIntDictIterator.3qt deleted file mode 100644 index c7e765515..000000000 --- a/doc/man/man3/QIntDictIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qintdictiterator.3qt diff --git a/doc/man/man3/QIntValidator.3qt b/doc/man/man3/QIntValidator.3qt deleted file mode 100644 index 704986728..000000000 --- a/doc/man/man3/QIntValidator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qintvalidator.3qt diff --git a/doc/man/man3/QJisCodec.3qt b/doc/man/man3/QJisCodec.3qt deleted file mode 100644 index c1017c214..000000000 --- a/doc/man/man3/QJisCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qjiscodec.3qt diff --git a/doc/man/man3/QKbdDriverFactory.3qt b/doc/man/man3/QKbdDriverFactory.3qt deleted file mode 100644 index c134f43f1..000000000 --- a/doc/man/man3/QKbdDriverFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qkbddriverfactory.3qt diff --git a/doc/man/man3/QKbdDriverPlugin.3qt b/doc/man/man3/QKbdDriverPlugin.3qt deleted file mode 100644 index 762f3a702..000000000 --- a/doc/man/man3/QKbdDriverPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qkbddriverplugin.3qt diff --git a/doc/man/man3/QKeyEvent.3qt b/doc/man/man3/QKeyEvent.3qt deleted file mode 100644 index 96067e407..000000000 --- a/doc/man/man3/QKeyEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qkeyevent.3qt diff --git a/doc/man/man3/QKeySequence.3qt b/doc/man/man3/QKeySequence.3qt deleted file mode 100644 index 66077c0c4..000000000 --- a/doc/man/man3/QKeySequence.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qkeysequence.3qt diff --git a/doc/man/man3/QLCDNumber.3qt b/doc/man/man3/QLCDNumber.3qt deleted file mode 100644 index dc4f7e024..000000000 --- a/doc/man/man3/QLCDNumber.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlcdnumber.3qt diff --git a/doc/man/man3/QLabel.3qt b/doc/man/man3/QLabel.3qt deleted file mode 100644 index 6c8e67232..000000000 --- a/doc/man/man3/QLabel.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlabel.3qt diff --git a/doc/man/man3/QLayout.3qt b/doc/man/man3/QLayout.3qt deleted file mode 100644 index f3b9f8fd0..000000000 --- a/doc/man/man3/QLayout.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlayout.3qt diff --git a/doc/man/man3/QLayoutItem.3qt b/doc/man/man3/QLayoutItem.3qt deleted file mode 100644 index 3a39d1b31..000000000 --- a/doc/man/man3/QLayoutItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlayoutitem.3qt diff --git a/doc/man/man3/QLayoutIterator.3qt b/doc/man/man3/QLayoutIterator.3qt deleted file mode 100644 index c1fc38bf1..000000000 --- a/doc/man/man3/QLayoutIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlayoutiterator.3qt diff --git a/doc/man/man3/QLibrary.3qt b/doc/man/man3/QLibrary.3qt deleted file mode 100644 index aa7580d1e..000000000 --- a/doc/man/man3/QLibrary.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlibrary.3qt diff --git a/doc/man/man3/QLineEdit.3qt b/doc/man/man3/QLineEdit.3qt deleted file mode 100644 index 8c864faf1..000000000 --- a/doc/man/man3/QLineEdit.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlineedit.3qt diff --git a/doc/man/man3/QListBox.3qt b/doc/man/man3/QListBox.3qt deleted file mode 100644 index ae63bb7d7..000000000 --- a/doc/man/man3/QListBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlistbox.3qt diff --git a/doc/man/man3/QListBoxItem.3qt b/doc/man/man3/QListBoxItem.3qt deleted file mode 100644 index cf7e7e5b1..000000000 --- a/doc/man/man3/QListBoxItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlistboxitem.3qt diff --git a/doc/man/man3/QListBoxPixmap.3qt b/doc/man/man3/QListBoxPixmap.3qt deleted file mode 100644 index 064dbe7d1..000000000 --- a/doc/man/man3/QListBoxPixmap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlistboxpixmap.3qt diff --git a/doc/man/man3/QListBoxText.3qt b/doc/man/man3/QListBoxText.3qt deleted file mode 100644 index 7d7737e8e..000000000 --- a/doc/man/man3/QListBoxText.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlistboxtext.3qt diff --git a/doc/man/man3/QListView.3qt b/doc/man/man3/QListView.3qt deleted file mode 100644 index 9b55ed422..000000000 --- a/doc/man/man3/QListView.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlistview.3qt diff --git a/doc/man/man3/QListViewItem.3qt b/doc/man/man3/QListViewItem.3qt deleted file mode 100644 index 15b68d46f..000000000 --- a/doc/man/man3/QListViewItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlistviewitem.3qt diff --git a/doc/man/man3/QListViewItemIterator.3qt b/doc/man/man3/QListViewItemIterator.3qt deleted file mode 100644 index ce7b7ef9e..000000000 --- a/doc/man/man3/QListViewItemIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlistviewitemiterator.3qt diff --git a/doc/man/man3/QLocalFs.3qt b/doc/man/man3/QLocalFs.3qt deleted file mode 100644 index cfc5f227f..000000000 --- a/doc/man/man3/QLocalFs.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlocalfs.3qt diff --git a/doc/man/man3/QLocale.3qt b/doc/man/man3/QLocale.3qt deleted file mode 100644 index 379aa306c..000000000 --- a/doc/man/man3/QLocale.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qlocale.3qt diff --git a/doc/man/man3/QMacMime.3qt b/doc/man/man3/QMacMime.3qt deleted file mode 100644 index 13d2e9ec9..000000000 --- a/doc/man/man3/QMacMime.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmacmime.3qt diff --git a/doc/man/man3/QMacStyle.3qt b/doc/man/man3/QMacStyle.3qt deleted file mode 100644 index 8f98b2188..000000000 --- a/doc/man/man3/QMacStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmacstyle.3qt diff --git a/doc/man/man3/QMainWindow.3qt b/doc/man/man3/QMainWindow.3qt deleted file mode 100644 index 26e31ced7..000000000 --- a/doc/man/man3/QMainWindow.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmainwindow.3qt diff --git a/doc/man/man3/QMap.3qt b/doc/man/man3/QMap.3qt deleted file mode 100644 index 8376b53b0..000000000 --- a/doc/man/man3/QMap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmap.3qt diff --git a/doc/man/man3/QMapConstIterator.3qt b/doc/man/man3/QMapConstIterator.3qt deleted file mode 100644 index 6da3fd311..000000000 --- a/doc/man/man3/QMapConstIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmapconstiterator.3qt diff --git a/doc/man/man3/QMapIterator.3qt b/doc/man/man3/QMapIterator.3qt deleted file mode 100644 index e3c6e1184..000000000 --- a/doc/man/man3/QMapIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmapiterator.3qt diff --git a/doc/man/man3/QMemArray.3qt b/doc/man/man3/QMemArray.3qt deleted file mode 100644 index cf299dcf5..000000000 --- a/doc/man/man3/QMemArray.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmemarray.3qt diff --git a/doc/man/man3/QMenuBar.3qt b/doc/man/man3/QMenuBar.3qt deleted file mode 100644 index 3ed42d1a5..000000000 --- a/doc/man/man3/QMenuBar.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmenubar.3qt diff --git a/doc/man/man3/QMenuData.3qt b/doc/man/man3/QMenuData.3qt deleted file mode 100644 index 3c30dc3f2..000000000 --- a/doc/man/man3/QMenuData.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmenudata.3qt diff --git a/doc/man/man3/QMessageBox.3qt b/doc/man/man3/QMessageBox.3qt deleted file mode 100644 index 566b2dbbe..000000000 --- a/doc/man/man3/QMessageBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmessagebox.3qt diff --git a/doc/man/man3/QMetaObject.3qt b/doc/man/man3/QMetaObject.3qt deleted file mode 100644 index 4c9304b76..000000000 --- a/doc/man/man3/QMetaObject.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmetaobject.3qt diff --git a/doc/man/man3/QMetaProperty.3qt b/doc/man/man3/QMetaProperty.3qt deleted file mode 100644 index 7ba43ce95..000000000 --- a/doc/man/man3/QMetaProperty.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmetaproperty.3qt diff --git a/doc/man/man3/QMimeSource.3qt b/doc/man/man3/QMimeSource.3qt deleted file mode 100644 index ec5c1690c..000000000 --- a/doc/man/man3/QMimeSource.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmimesource.3qt diff --git a/doc/man/man3/QMimeSourceFactory.3qt b/doc/man/man3/QMimeSourceFactory.3qt deleted file mode 100644 index 0bcee7965..000000000 --- a/doc/man/man3/QMimeSourceFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmimesourcefactory.3qt diff --git a/doc/man/man3/QMotif.3qt b/doc/man/man3/QMotif.3qt deleted file mode 100644 index 7db4b6163..000000000 --- a/doc/man/man3/QMotif.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmotif.3qt diff --git a/doc/man/man3/QMotifDialog.3qt b/doc/man/man3/QMotifDialog.3qt deleted file mode 100644 index 12b6670ce..000000000 --- a/doc/man/man3/QMotifDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmotifdialog.3qt diff --git a/doc/man/man3/QMotifPlusStyle.3qt b/doc/man/man3/QMotifPlusStyle.3qt deleted file mode 100644 index bffa46cab..000000000 --- a/doc/man/man3/QMotifPlusStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmotifplusstyle.3qt diff --git a/doc/man/man3/QMotifStyle.3qt b/doc/man/man3/QMotifStyle.3qt deleted file mode 100644 index 0dee7ab10..000000000 --- a/doc/man/man3/QMotifStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmotifstyle.3qt diff --git a/doc/man/man3/QMotifWidget.3qt b/doc/man/man3/QMotifWidget.3qt deleted file mode 100644 index 4e0423295..000000000 --- a/doc/man/man3/QMotifWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmotifwidget.3qt diff --git a/doc/man/man3/QMouseDriverFactory.3qt b/doc/man/man3/QMouseDriverFactory.3qt deleted file mode 100644 index a40782df5..000000000 --- a/doc/man/man3/QMouseDriverFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmousedriverfactory.3qt diff --git a/doc/man/man3/QMouseDriverPlugin.3qt b/doc/man/man3/QMouseDriverPlugin.3qt deleted file mode 100644 index 17e854244..000000000 --- a/doc/man/man3/QMouseDriverPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmousedriverplugin.3qt diff --git a/doc/man/man3/QMouseEvent.3qt b/doc/man/man3/QMouseEvent.3qt deleted file mode 100644 index 7a3a4e185..000000000 --- a/doc/man/man3/QMouseEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmouseevent.3qt diff --git a/doc/man/man3/QMoveEvent.3qt b/doc/man/man3/QMoveEvent.3qt deleted file mode 100644 index 3421c8d02..000000000 --- a/doc/man/man3/QMoveEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmoveevent.3qt diff --git a/doc/man/man3/QMovie.3qt b/doc/man/man3/QMovie.3qt deleted file mode 100644 index cb2f633fe..000000000 --- a/doc/man/man3/QMovie.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmovie.3qt diff --git a/doc/man/man3/QMutex.3qt b/doc/man/man3/QMutex.3qt deleted file mode 100644 index c2c9bdaab..000000000 --- a/doc/man/man3/QMutex.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmutex.3qt diff --git a/doc/man/man3/QMutexLocker.3qt b/doc/man/man3/QMutexLocker.3qt deleted file mode 100644 index 990f4ce23..000000000 --- a/doc/man/man3/QMutexLocker.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qmutexlocker.3qt diff --git a/doc/man/man3/QNPInstance.3qt b/doc/man/man3/QNPInstance.3qt deleted file mode 100644 index 9a5abfef4..000000000 --- a/doc/man/man3/QNPInstance.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qnpinstance.3qt diff --git a/doc/man/man3/QNPStream.3qt b/doc/man/man3/QNPStream.3qt deleted file mode 100644 index 760f82d00..000000000 --- a/doc/man/man3/QNPStream.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qnpstream.3qt diff --git a/doc/man/man3/QNPWidget.3qt b/doc/man/man3/QNPWidget.3qt deleted file mode 100644 index 42c702c78..000000000 --- a/doc/man/man3/QNPWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qnpwidget.3qt diff --git a/doc/man/man3/QNPlugin.3qt b/doc/man/man3/QNPlugin.3qt deleted file mode 100644 index f25c1c697..000000000 --- a/doc/man/man3/QNPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qnplugin.3qt diff --git a/doc/man/man3/QNetworkOperation.3qt b/doc/man/man3/QNetworkOperation.3qt deleted file mode 100644 index ccbc879dd..000000000 --- a/doc/man/man3/QNetworkOperation.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qnetworkoperation.3qt diff --git a/doc/man/man3/QNetworkProtocol.3qt b/doc/man/man3/QNetworkProtocol.3qt deleted file mode 100644 index 0757364fb..000000000 --- a/doc/man/man3/QNetworkProtocol.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qnetworkprotocol.3qt diff --git a/doc/man/man3/QObject.3qt b/doc/man/man3/QObject.3qt deleted file mode 100644 index 7dd3a2b6d..000000000 --- a/doc/man/man3/QObject.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qobject.3qt diff --git a/doc/man/man3/QObjectCleanupHandler.3qt b/doc/man/man3/QObjectCleanupHandler.3qt deleted file mode 100644 index 508c4ad04..000000000 --- a/doc/man/man3/QObjectCleanupHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qobjectcleanuphandler.3qt diff --git a/doc/man/man3/QObjectList.3qt b/doc/man/man3/QObjectList.3qt deleted file mode 100644 index 0ac5e39fc..000000000 --- a/doc/man/man3/QObjectList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qobjectlist.3qt diff --git a/doc/man/man3/QObjectListIterator.3qt b/doc/man/man3/QObjectListIterator.3qt deleted file mode 100644 index a58d74f72..000000000 --- a/doc/man/man3/QObjectListIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qobjectlistiterator.3qt diff --git a/doc/man/man3/QPNGImagePacker.3qt b/doc/man/man3/QPNGImagePacker.3qt deleted file mode 100644 index 1059a5ea9..000000000 --- a/doc/man/man3/QPNGImagePacker.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpngimagepacker.3qt diff --git a/doc/man/man3/QPaintDevice.3qt b/doc/man/man3/QPaintDevice.3qt deleted file mode 100644 index 573b1477b..000000000 --- a/doc/man/man3/QPaintDevice.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpaintdevice.3qt diff --git a/doc/man/man3/QPaintDeviceMetrics.3qt b/doc/man/man3/QPaintDeviceMetrics.3qt deleted file mode 100644 index 5e8175a48..000000000 --- a/doc/man/man3/QPaintDeviceMetrics.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpaintdevicemetrics.3qt diff --git a/doc/man/man3/QPaintEvent.3qt b/doc/man/man3/QPaintEvent.3qt deleted file mode 100644 index af10e932c..000000000 --- a/doc/man/man3/QPaintEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpaintevent.3qt diff --git a/doc/man/man3/QPainter.3qt b/doc/man/man3/QPainter.3qt deleted file mode 100644 index 1621ea293..000000000 --- a/doc/man/man3/QPainter.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpainter.3qt diff --git a/doc/man/man3/QPair.3qt b/doc/man/man3/QPair.3qt deleted file mode 100644 index e8f6158e2..000000000 --- a/doc/man/man3/QPair.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpair.3qt diff --git a/doc/man/man3/QPalette.3qt b/doc/man/man3/QPalette.3qt deleted file mode 100644 index 972b4a586..000000000 --- a/doc/man/man3/QPalette.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpalette.3qt diff --git a/doc/man/man3/QPen.3qt b/doc/man/man3/QPen.3qt deleted file mode 100644 index 5d805a10e..000000000 --- a/doc/man/man3/QPen.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpen.3qt diff --git a/doc/man/man3/QPicture.3qt b/doc/man/man3/QPicture.3qt deleted file mode 100644 index 7a5be4705..000000000 --- a/doc/man/man3/QPicture.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpicture.3qt diff --git a/doc/man/man3/QPixmap.3qt b/doc/man/man3/QPixmap.3qt deleted file mode 100644 index 614be1b6e..000000000 --- a/doc/man/man3/QPixmap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpixmap.3qt diff --git a/doc/man/man3/QPixmapCache.3qt b/doc/man/man3/QPixmapCache.3qt deleted file mode 100644 index 063c9be07..000000000 --- a/doc/man/man3/QPixmapCache.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpixmapcache.3qt diff --git a/doc/man/man3/QPlatinumStyle.3qt b/doc/man/man3/QPlatinumStyle.3qt deleted file mode 100644 index 4ea571dc1..000000000 --- a/doc/man/man3/QPlatinumStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qplatinumstyle.3qt diff --git a/doc/man/man3/QPoint.3qt b/doc/man/man3/QPoint.3qt deleted file mode 100644 index 0349720f2..000000000 --- a/doc/man/man3/QPoint.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpoint.3qt diff --git a/doc/man/man3/QPointArray.3qt b/doc/man/man3/QPointArray.3qt deleted file mode 100644 index 946f6e011..000000000 --- a/doc/man/man3/QPointArray.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpointarray.3qt diff --git a/doc/man/man3/QPopupMenu.3qt b/doc/man/man3/QPopupMenu.3qt deleted file mode 100644 index db9eb472c..000000000 --- a/doc/man/man3/QPopupMenu.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpopupmenu.3qt diff --git a/doc/man/man3/QPrinter.3qt b/doc/man/man3/QPrinter.3qt deleted file mode 100644 index da61ea94f..000000000 --- a/doc/man/man3/QPrinter.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qprinter.3qt diff --git a/doc/man/man3/QProcess.3qt b/doc/man/man3/QProcess.3qt deleted file mode 100644 index 2e91f451e..000000000 --- a/doc/man/man3/QProcess.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qprocess.3qt diff --git a/doc/man/man3/QProgressBar.3qt b/doc/man/man3/QProgressBar.3qt deleted file mode 100644 index 068e07738..000000000 --- a/doc/man/man3/QProgressBar.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qprogressbar.3qt diff --git a/doc/man/man3/QProgressDialog.3qt b/doc/man/man3/QProgressDialog.3qt deleted file mode 100644 index ccab6fc15..000000000 --- a/doc/man/man3/QProgressDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qprogressdialog.3qt diff --git a/doc/man/man3/QPtrCollection.3qt b/doc/man/man3/QPtrCollection.3qt deleted file mode 100644 index 09d6d8fce..000000000 --- a/doc/man/man3/QPtrCollection.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrcollection.3qt diff --git a/doc/man/man3/QPtrDict.3qt b/doc/man/man3/QPtrDict.3qt deleted file mode 100644 index 5d4904a83..000000000 --- a/doc/man/man3/QPtrDict.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrdict.3qt diff --git a/doc/man/man3/QPtrDictIterator.3qt b/doc/man/man3/QPtrDictIterator.3qt deleted file mode 100644 index fcf7e4310..000000000 --- a/doc/man/man3/QPtrDictIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrdictiterator.3qt diff --git a/doc/man/man3/QPtrList.3qt b/doc/man/man3/QPtrList.3qt deleted file mode 100644 index 9d95ddf1c..000000000 --- a/doc/man/man3/QPtrList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrlist.3qt diff --git a/doc/man/man3/QPtrListIterator.3qt b/doc/man/man3/QPtrListIterator.3qt deleted file mode 100644 index ae56bf548..000000000 --- a/doc/man/man3/QPtrListIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrlistiterator.3qt diff --git a/doc/man/man3/QPtrQueue.3qt b/doc/man/man3/QPtrQueue.3qt deleted file mode 100644 index 366001cfd..000000000 --- a/doc/man/man3/QPtrQueue.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrqueue.3qt diff --git a/doc/man/man3/QPtrStack.3qt b/doc/man/man3/QPtrStack.3qt deleted file mode 100644 index e9380603a..000000000 --- a/doc/man/man3/QPtrStack.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrstack.3qt diff --git a/doc/man/man3/QPtrVector.3qt b/doc/man/man3/QPtrVector.3qt deleted file mode 100644 index 3a2633531..000000000 --- a/doc/man/man3/QPtrVector.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qptrvector.3qt diff --git a/doc/man/man3/QPushButton.3qt b/doc/man/man3/QPushButton.3qt deleted file mode 100644 index 4cd46d657..000000000 --- a/doc/man/man3/QPushButton.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qpushbutton.3qt diff --git a/doc/man/man3/QRadioButton.3qt b/doc/man/man3/QRadioButton.3qt deleted file mode 100644 index 42976a3d8..000000000 --- a/doc/man/man3/QRadioButton.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qradiobutton.3qt diff --git a/doc/man/man3/QRangeControl.3qt b/doc/man/man3/QRangeControl.3qt deleted file mode 100644 index 814842010..000000000 --- a/doc/man/man3/QRangeControl.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qrangecontrol.3qt diff --git a/doc/man/man3/QRect.3qt b/doc/man/man3/QRect.3qt deleted file mode 100644 index 10f40e017..000000000 --- a/doc/man/man3/QRect.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qrect.3qt diff --git a/doc/man/man3/QRegExp.3qt b/doc/man/man3/QRegExp.3qt deleted file mode 100644 index 6b1b4e512..000000000 --- a/doc/man/man3/QRegExp.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qregexp.3qt diff --git a/doc/man/man3/QRegExpValidator.3qt b/doc/man/man3/QRegExpValidator.3qt deleted file mode 100644 index 69c656516..000000000 --- a/doc/man/man3/QRegExpValidator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qregexpvalidator.3qt diff --git a/doc/man/man3/QRegion.3qt b/doc/man/man3/QRegion.3qt deleted file mode 100644 index 1df9f01d7..000000000 --- a/doc/man/man3/QRegion.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qregion.3qt diff --git a/doc/man/man3/QResizeEvent.3qt b/doc/man/man3/QResizeEvent.3qt deleted file mode 100644 index eb52f8077..000000000 --- a/doc/man/man3/QResizeEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qresizeevent.3qt diff --git a/doc/man/man3/QSGIStyle.3qt b/doc/man/man3/QSGIStyle.3qt deleted file mode 100644 index e56aa959a..000000000 --- a/doc/man/man3/QSGIStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsgistyle.3qt diff --git a/doc/man/man3/QScreen.3qt b/doc/man/man3/QScreen.3qt deleted file mode 100644 index 0b5394915..000000000 --- a/doc/man/man3/QScreen.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qscreen.3qt diff --git a/doc/man/man3/QScrollBar.3qt b/doc/man/man3/QScrollBar.3qt deleted file mode 100644 index 19e7177b6..000000000 --- a/doc/man/man3/QScrollBar.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qscrollbar.3qt diff --git a/doc/man/man3/QScrollView.3qt b/doc/man/man3/QScrollView.3qt deleted file mode 100644 index b01df4d6f..000000000 --- a/doc/man/man3/QScrollView.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qscrollview.3qt diff --git a/doc/man/man3/QSemaphore.3qt b/doc/man/man3/QSemaphore.3qt deleted file mode 100644 index f52c7ef7c..000000000 --- a/doc/man/man3/QSemaphore.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsemaphore.3qt diff --git a/doc/man/man3/QServerSocket.3qt b/doc/man/man3/QServerSocket.3qt deleted file mode 100644 index dc91dfcb5..000000000 --- a/doc/man/man3/QServerSocket.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qserversocket.3qt diff --git a/doc/man/man3/QSessionManager.3qt b/doc/man/man3/QSessionManager.3qt deleted file mode 100644 index ed8ee0411..000000000 --- a/doc/man/man3/QSessionManager.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsessionmanager.3qt diff --git a/doc/man/man3/QSettings.3qt b/doc/man/man3/QSettings.3qt deleted file mode 100644 index 2725697be..000000000 --- a/doc/man/man3/QSettings.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsettings.3qt diff --git a/doc/man/man3/QShowEvent.3qt b/doc/man/man3/QShowEvent.3qt deleted file mode 100644 index 5b16be823..000000000 --- a/doc/man/man3/QShowEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qshowevent.3qt diff --git a/doc/man/man3/QSignal.3qt b/doc/man/man3/QSignal.3qt deleted file mode 100644 index c8df8d1f1..000000000 --- a/doc/man/man3/QSignal.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsignal.3qt diff --git a/doc/man/man3/QSignalMapper.3qt b/doc/man/man3/QSignalMapper.3qt deleted file mode 100644 index 72cad66c5..000000000 --- a/doc/man/man3/QSignalMapper.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsignalmapper.3qt diff --git a/doc/man/man3/QSimpleRichText.3qt b/doc/man/man3/QSimpleRichText.3qt deleted file mode 100644 index 4e01b6829..000000000 --- a/doc/man/man3/QSimpleRichText.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsimplerichtext.3qt diff --git a/doc/man/man3/QSize.3qt b/doc/man/man3/QSize.3qt deleted file mode 100644 index b7a14b3c0..000000000 --- a/doc/man/man3/QSize.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsize.3qt diff --git a/doc/man/man3/QSizeGrip.3qt b/doc/man/man3/QSizeGrip.3qt deleted file mode 100644 index fa048c7df..000000000 --- a/doc/man/man3/QSizeGrip.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsizegrip.3qt diff --git a/doc/man/man3/QSizePolicy.3qt b/doc/man/man3/QSizePolicy.3qt deleted file mode 100644 index d7f5909aa..000000000 --- a/doc/man/man3/QSizePolicy.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsizepolicy.3qt diff --git a/doc/man/man3/QSjisCodec.3qt b/doc/man/man3/QSjisCodec.3qt deleted file mode 100644 index da9c7d85e..000000000 --- a/doc/man/man3/QSjisCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsjiscodec.3qt diff --git a/doc/man/man3/QSlider.3qt b/doc/man/man3/QSlider.3qt deleted file mode 100644 index ca028dc1e..000000000 --- a/doc/man/man3/QSlider.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qslider.3qt diff --git a/doc/man/man3/QSocket.3qt b/doc/man/man3/QSocket.3qt deleted file mode 100644 index 59d8bf7e5..000000000 --- a/doc/man/man3/QSocket.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsocket.3qt diff --git a/doc/man/man3/QSocketDevice.3qt b/doc/man/man3/QSocketDevice.3qt deleted file mode 100644 index 6576329ab..000000000 --- a/doc/man/man3/QSocketDevice.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsocketdevice.3qt diff --git a/doc/man/man3/QSocketNotifier.3qt b/doc/man/man3/QSocketNotifier.3qt deleted file mode 100644 index 7cc09462c..000000000 --- a/doc/man/man3/QSocketNotifier.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsocketnotifier.3qt diff --git a/doc/man/man3/QSound.3qt b/doc/man/man3/QSound.3qt deleted file mode 100644 index c68587d6e..000000000 --- a/doc/man/man3/QSound.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsound.3qt diff --git a/doc/man/man3/QSpacerItem.3qt b/doc/man/man3/QSpacerItem.3qt deleted file mode 100644 index 639f1a00c..000000000 --- a/doc/man/man3/QSpacerItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qspaceritem.3qt diff --git a/doc/man/man3/QSpinBox.3qt b/doc/man/man3/QSpinBox.3qt deleted file mode 100644 index 18d8e921b..000000000 --- a/doc/man/man3/QSpinBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qspinbox.3qt diff --git a/doc/man/man3/QSplashScreen.3qt b/doc/man/man3/QSplashScreen.3qt deleted file mode 100644 index 40e867f9b..000000000 --- a/doc/man/man3/QSplashScreen.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsplashscreen.3qt diff --git a/doc/man/man3/QSplitter.3qt b/doc/man/man3/QSplitter.3qt deleted file mode 100644 index 4c547aaca..000000000 --- a/doc/man/man3/QSplitter.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsplitter.3qt diff --git a/doc/man/man3/QSql.3qt b/doc/man/man3/QSql.3qt deleted file mode 100644 index 34474332a..000000000 --- a/doc/man/man3/QSql.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsql.3qt diff --git a/doc/man/man3/QSqlCursor.3qt b/doc/man/man3/QSqlCursor.3qt deleted file mode 100644 index a624ba14d..000000000 --- a/doc/man/man3/QSqlCursor.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlcursor.3qt diff --git a/doc/man/man3/QSqlDatabase.3qt b/doc/man/man3/QSqlDatabase.3qt deleted file mode 100644 index ceb50c5aa..000000000 --- a/doc/man/man3/QSqlDatabase.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqldatabase.3qt diff --git a/doc/man/man3/QSqlDriver.3qt b/doc/man/man3/QSqlDriver.3qt deleted file mode 100644 index 4c4209393..000000000 --- a/doc/man/man3/QSqlDriver.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqldriver.3qt diff --git a/doc/man/man3/QSqlDriverPlugin.3qt b/doc/man/man3/QSqlDriverPlugin.3qt deleted file mode 100644 index e814b875b..000000000 --- a/doc/man/man3/QSqlDriverPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqldriverplugin.3qt diff --git a/doc/man/man3/QSqlEditorFactory.3qt b/doc/man/man3/QSqlEditorFactory.3qt deleted file mode 100644 index 2a956c04d..000000000 --- a/doc/man/man3/QSqlEditorFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqleditorfactory.3qt diff --git a/doc/man/man3/QSqlError.3qt b/doc/man/man3/QSqlError.3qt deleted file mode 100644 index 03c42748c..000000000 --- a/doc/man/man3/QSqlError.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlerror.3qt diff --git a/doc/man/man3/QSqlField.3qt b/doc/man/man3/QSqlField.3qt deleted file mode 100644 index ff6e797e6..000000000 --- a/doc/man/man3/QSqlField.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlfield.3qt diff --git a/doc/man/man3/QSqlFieldInfo.3qt b/doc/man/man3/QSqlFieldInfo.3qt deleted file mode 100644 index 4938647d9..000000000 --- a/doc/man/man3/QSqlFieldInfo.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlfieldinfo.3qt diff --git a/doc/man/man3/QSqlForm.3qt b/doc/man/man3/QSqlForm.3qt deleted file mode 100644 index 0dfb48a99..000000000 --- a/doc/man/man3/QSqlForm.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlform.3qt diff --git a/doc/man/man3/QSqlIndex.3qt b/doc/man/man3/QSqlIndex.3qt deleted file mode 100644 index 2d732473b..000000000 --- a/doc/man/man3/QSqlIndex.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlindex.3qt diff --git a/doc/man/man3/QSqlPropertyMap.3qt b/doc/man/man3/QSqlPropertyMap.3qt deleted file mode 100644 index adb4c95d4..000000000 --- a/doc/man/man3/QSqlPropertyMap.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlpropertymap.3qt diff --git a/doc/man/man3/QSqlQuery.3qt b/doc/man/man3/QSqlQuery.3qt deleted file mode 100644 index cd1a8c2da..000000000 --- a/doc/man/man3/QSqlQuery.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlquery.3qt diff --git a/doc/man/man3/QSqlRecord.3qt b/doc/man/man3/QSqlRecord.3qt deleted file mode 100644 index c66047ebf..000000000 --- a/doc/man/man3/QSqlRecord.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlrecord.3qt diff --git a/doc/man/man3/QSqlRecordInfo.3qt b/doc/man/man3/QSqlRecordInfo.3qt deleted file mode 100644 index 0f04793e3..000000000 --- a/doc/man/man3/QSqlRecordInfo.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlrecordinfo.3qt diff --git a/doc/man/man3/QSqlResult.3qt b/doc/man/man3/QSqlResult.3qt deleted file mode 100644 index 2a1599985..000000000 --- a/doc/man/man3/QSqlResult.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlresult.3qt diff --git a/doc/man/man3/QSqlSelectCursor.3qt b/doc/man/man3/QSqlSelectCursor.3qt deleted file mode 100644 index 004c2db6c..000000000 --- a/doc/man/man3/QSqlSelectCursor.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsqlselectcursor.3qt diff --git a/doc/man/man3/QStatusBar.3qt b/doc/man/man3/QStatusBar.3qt deleted file mode 100644 index 60a253882..000000000 --- a/doc/man/man3/QStatusBar.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstatusbar.3qt diff --git a/doc/man/man3/QStoredDrag.3qt b/doc/man/man3/QStoredDrag.3qt deleted file mode 100644 index 6bd3bf87d..000000000 --- a/doc/man/man3/QStoredDrag.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstoreddrag.3qt diff --git a/doc/man/man3/QStrIList.3qt b/doc/man/man3/QStrIList.3qt deleted file mode 100644 index dd19eb630..000000000 --- a/doc/man/man3/QStrIList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstrilist.3qt diff --git a/doc/man/man3/QStrList.3qt b/doc/man/man3/QStrList.3qt deleted file mode 100644 index 4c2c503c4..000000000 --- a/doc/man/man3/QStrList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstrlist.3qt diff --git a/doc/man/man3/QStrListIterator.3qt b/doc/man/man3/QStrListIterator.3qt deleted file mode 100644 index d04402c88..000000000 --- a/doc/man/man3/QStrListIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstrlistiterator.3qt diff --git a/doc/man/man3/QString.3qt b/doc/man/man3/QString.3qt deleted file mode 100644 index 3574cdb1c..000000000 --- a/doc/man/man3/QString.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstring.3qt diff --git a/doc/man/man3/QStringList.3qt b/doc/man/man3/QStringList.3qt deleted file mode 100644 index a757e4057..000000000 --- a/doc/man/man3/QStringList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstringlist.3qt diff --git a/doc/man/man3/QStyle.3qt b/doc/man/man3/QStyle.3qt deleted file mode 100644 index a76c6f4dd..000000000 --- a/doc/man/man3/QStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstyle.3qt diff --git a/doc/man/man3/QStyleFactory.3qt b/doc/man/man3/QStyleFactory.3qt deleted file mode 100644 index ac3563c18..000000000 --- a/doc/man/man3/QStyleFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstylefactory.3qt diff --git a/doc/man/man3/QStyleOption.3qt b/doc/man/man3/QStyleOption.3qt deleted file mode 100644 index 5e10a1d70..000000000 --- a/doc/man/man3/QStyleOption.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstyleoption.3qt diff --git a/doc/man/man3/QStylePlugin.3qt b/doc/man/man3/QStylePlugin.3qt deleted file mode 100644 index e2b47377f..000000000 --- a/doc/man/man3/QStylePlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstyleplugin.3qt diff --git a/doc/man/man3/QStyleSheet.3qt b/doc/man/man3/QStyleSheet.3qt deleted file mode 100644 index de3d2d773..000000000 --- a/doc/man/man3/QStyleSheet.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstylesheet.3qt diff --git a/doc/man/man3/QStyleSheetItem.3qt b/doc/man/man3/QStyleSheetItem.3qt deleted file mode 100644 index 1b2fff271..000000000 --- a/doc/man/man3/QStyleSheetItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qstylesheetitem.3qt diff --git a/doc/man/man3/QSyntaxHighlighter.3qt b/doc/man/man3/QSyntaxHighlighter.3qt deleted file mode 100644 index 1cf5370ad..000000000 --- a/doc/man/man3/QSyntaxHighlighter.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qsyntaxhighlighter.3qt diff --git a/doc/man/man3/QTab.3qt b/doc/man/man3/QTab.3qt deleted file mode 100644 index a093a672f..000000000 --- a/doc/man/man3/QTab.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtab.3qt diff --git a/doc/man/man3/QTabBar.3qt b/doc/man/man3/QTabBar.3qt deleted file mode 100644 index d20039023..000000000 --- a/doc/man/man3/QTabBar.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtabbar.3qt diff --git a/doc/man/man3/QTabDialog.3qt b/doc/man/man3/QTabDialog.3qt deleted file mode 100644 index 73a52f31c..000000000 --- a/doc/man/man3/QTabDialog.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtabdialog.3qt diff --git a/doc/man/man3/QTabWidget.3qt b/doc/man/man3/QTabWidget.3qt deleted file mode 100644 index 5a8737134..000000000 --- a/doc/man/man3/QTabWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtabwidget.3qt diff --git a/doc/man/man3/QTable.3qt b/doc/man/man3/QTable.3qt deleted file mode 100644 index a6d9f9596..000000000 --- a/doc/man/man3/QTable.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtable.3qt diff --git a/doc/man/man3/QTableItem.3qt b/doc/man/man3/QTableItem.3qt deleted file mode 100644 index 7307bb5ae..000000000 --- a/doc/man/man3/QTableItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtableitem.3qt diff --git a/doc/man/man3/QTableSelection.3qt b/doc/man/man3/QTableSelection.3qt deleted file mode 100644 index 31e00180f..000000000 --- a/doc/man/man3/QTableSelection.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtableselection.3qt diff --git a/doc/man/man3/QTabletEvent.3qt b/doc/man/man3/QTabletEvent.3qt deleted file mode 100644 index 1ee1a3e26..000000000 --- a/doc/man/man3/QTabletEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtabletevent.3qt diff --git a/doc/man/man3/QTextBrowser.3qt b/doc/man/man3/QTextBrowser.3qt deleted file mode 100644 index 3214dc3db..000000000 --- a/doc/man/man3/QTextBrowser.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextbrowser.3qt diff --git a/doc/man/man3/QTextCodec.3qt b/doc/man/man3/QTextCodec.3qt deleted file mode 100644 index 94fe818b8..000000000 --- a/doc/man/man3/QTextCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextcodec.3qt diff --git a/doc/man/man3/QTextCodecPlugin.3qt b/doc/man/man3/QTextCodecPlugin.3qt deleted file mode 100644 index 0f8cba488..000000000 --- a/doc/man/man3/QTextCodecPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextcodecplugin.3qt diff --git a/doc/man/man3/QTextDecoder.3qt b/doc/man/man3/QTextDecoder.3qt deleted file mode 100644 index d99ca4f26..000000000 --- a/doc/man/man3/QTextDecoder.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextdecoder.3qt diff --git a/doc/man/man3/QTextDrag.3qt b/doc/man/man3/QTextDrag.3qt deleted file mode 100644 index 6d79ec185..000000000 --- a/doc/man/man3/QTextDrag.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextdrag.3qt diff --git a/doc/man/man3/QTextEdit.3qt b/doc/man/man3/QTextEdit.3qt deleted file mode 100644 index 63b1c6011..000000000 --- a/doc/man/man3/QTextEdit.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextedit.3qt diff --git a/doc/man/man3/QTextEncoder.3qt b/doc/man/man3/QTextEncoder.3qt deleted file mode 100644 index fde2f7f1d..000000000 --- a/doc/man/man3/QTextEncoder.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextencoder.3qt diff --git a/doc/man/man3/QTextIStream.3qt b/doc/man/man3/QTextIStream.3qt deleted file mode 100644 index dd91f345d..000000000 --- a/doc/man/man3/QTextIStream.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextistream.3qt diff --git a/doc/man/man3/QTextOStream.3qt b/doc/man/man3/QTextOStream.3qt deleted file mode 100644 index 12c7be9da..000000000 --- a/doc/man/man3/QTextOStream.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextostream.3qt diff --git a/doc/man/man3/QTextStream.3qt b/doc/man/man3/QTextStream.3qt deleted file mode 100644 index b47fb9e43..000000000 --- a/doc/man/man3/QTextStream.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtextstream.3qt diff --git a/doc/man/man3/QThread.3qt b/doc/man/man3/QThread.3qt deleted file mode 100644 index febb747ab..000000000 --- a/doc/man/man3/QThread.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qthread.3qt diff --git a/doc/man/man3/QThreadStorage.3qt b/doc/man/man3/QThreadStorage.3qt deleted file mode 100644 index 3b09ba86a..000000000 --- a/doc/man/man3/QThreadStorage.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qthreadstorage.3qt diff --git a/doc/man/man3/QTime.3qt b/doc/man/man3/QTime.3qt deleted file mode 100644 index cc6c72162..000000000 --- a/doc/man/man3/QTime.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtime.3qt diff --git a/doc/man/man3/QTimeEdit.3qt b/doc/man/man3/QTimeEdit.3qt deleted file mode 100644 index e659adc93..000000000 --- a/doc/man/man3/QTimeEdit.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtimeedit.3qt diff --git a/doc/man/man3/QTimer.3qt b/doc/man/man3/QTimer.3qt deleted file mode 100644 index 1740c7391..000000000 --- a/doc/man/man3/QTimer.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtimer.3qt diff --git a/doc/man/man3/QTimerEvent.3qt b/doc/man/man3/QTimerEvent.3qt deleted file mode 100644 index dd5973bab..000000000 --- a/doc/man/man3/QTimerEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtimerevent.3qt diff --git a/doc/man/man3/QToolBar.3qt b/doc/man/man3/QToolBar.3qt deleted file mode 100644 index 1f7fff584..000000000 --- a/doc/man/man3/QToolBar.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtoolbar.3qt diff --git a/doc/man/man3/QToolBox.3qt b/doc/man/man3/QToolBox.3qt deleted file mode 100644 index 70a95a02b..000000000 --- a/doc/man/man3/QToolBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtoolbox.3qt diff --git a/doc/man/man3/QToolButton.3qt b/doc/man/man3/QToolButton.3qt deleted file mode 100644 index 7377a2d69..000000000 --- a/doc/man/man3/QToolButton.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtoolbutton.3qt diff --git a/doc/man/man3/QToolTip.3qt b/doc/man/man3/QToolTip.3qt deleted file mode 100644 index 95b4ac39e..000000000 --- a/doc/man/man3/QToolTip.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtooltip.3qt diff --git a/doc/man/man3/QToolTipGroup.3qt b/doc/man/man3/QToolTipGroup.3qt deleted file mode 100644 index 96fddeac3..000000000 --- a/doc/man/man3/QToolTipGroup.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtooltipgroup.3qt diff --git a/doc/man/man3/QTranslator.3qt b/doc/man/man3/QTranslator.3qt deleted file mode 100644 index 0dfd1cc7a..000000000 --- a/doc/man/man3/QTranslator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtranslator.3qt diff --git a/doc/man/man3/QTranslatorMessage.3qt b/doc/man/man3/QTranslatorMessage.3qt deleted file mode 100644 index e32d071dc..000000000 --- a/doc/man/man3/QTranslatorMessage.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtranslatormessage.3qt diff --git a/doc/man/man3/QTsciiCodec.3qt b/doc/man/man3/QTsciiCodec.3qt deleted file mode 100644 index 1f716aa03..000000000 --- a/doc/man/man3/QTsciiCodec.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qtsciicodec.3qt diff --git a/doc/man/man3/QUriDrag.3qt b/doc/man/man3/QUriDrag.3qt deleted file mode 100644 index ecfb6e4d1..000000000 --- a/doc/man/man3/QUriDrag.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/quridrag.3qt diff --git a/doc/man/man3/QUrl.3qt b/doc/man/man3/QUrl.3qt deleted file mode 100644 index 7a9a4b81e..000000000 --- a/doc/man/man3/QUrl.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qurl.3qt diff --git a/doc/man/man3/QUrlInfo.3qt b/doc/man/man3/QUrlInfo.3qt deleted file mode 100644 index 47991928c..000000000 --- a/doc/man/man3/QUrlInfo.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qurlinfo.3qt diff --git a/doc/man/man3/QUrlOperator.3qt b/doc/man/man3/QUrlOperator.3qt deleted file mode 100644 index d4815444c..000000000 --- a/doc/man/man3/QUrlOperator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qurloperator.3qt diff --git a/doc/man/man3/QUuid.3qt b/doc/man/man3/QUuid.3qt deleted file mode 100644 index 469a10297..000000000 --- a/doc/man/man3/QUuid.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/quuid.3qt diff --git a/doc/man/man3/QVBox.3qt b/doc/man/man3/QVBox.3qt deleted file mode 100644 index 3ba645b29..000000000 --- a/doc/man/man3/QVBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvbox.3qt diff --git a/doc/man/man3/QVBoxLayout.3qt b/doc/man/man3/QVBoxLayout.3qt deleted file mode 100644 index c8eb25b3a..000000000 --- a/doc/man/man3/QVBoxLayout.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvboxlayout.3qt diff --git a/doc/man/man3/QVButtonGroup.3qt b/doc/man/man3/QVButtonGroup.3qt deleted file mode 100644 index 815b6c8d8..000000000 --- a/doc/man/man3/QVButtonGroup.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvbuttongroup.3qt diff --git a/doc/man/man3/QVGroupBox.3qt b/doc/man/man3/QVGroupBox.3qt deleted file mode 100644 index 4bcab4d0f..000000000 --- a/doc/man/man3/QVGroupBox.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvgroupbox.3qt diff --git a/doc/man/man3/QValidator.3qt b/doc/man/man3/QValidator.3qt deleted file mode 100644 index 2dd313ad6..000000000 --- a/doc/man/man3/QValidator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvalidator.3qt diff --git a/doc/man/man3/QValueList.3qt b/doc/man/man3/QValueList.3qt deleted file mode 100644 index e483f6a35..000000000 --- a/doc/man/man3/QValueList.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvaluelist.3qt diff --git a/doc/man/man3/QValueListConstIterator.3qt b/doc/man/man3/QValueListConstIterator.3qt deleted file mode 100644 index a2b5e716a..000000000 --- a/doc/man/man3/QValueListConstIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvaluelistconstiterator.3qt diff --git a/doc/man/man3/QValueListIterator.3qt b/doc/man/man3/QValueListIterator.3qt deleted file mode 100644 index 3c212fd98..000000000 --- a/doc/man/man3/QValueListIterator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvaluelistiterator.3qt diff --git a/doc/man/man3/QValueStack.3qt b/doc/man/man3/QValueStack.3qt deleted file mode 100644 index b754e7b8f..000000000 --- a/doc/man/man3/QValueStack.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvaluestack.3qt diff --git a/doc/man/man3/QValueVector.3qt b/doc/man/man3/QValueVector.3qt deleted file mode 100644 index d7060b8b1..000000000 --- a/doc/man/man3/QValueVector.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvaluevector.3qt diff --git a/doc/man/man3/QVariant.3qt b/doc/man/man3/QVariant.3qt deleted file mode 100644 index 51ca7bc36..000000000 --- a/doc/man/man3/QVariant.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qvariant.3qt diff --git a/doc/man/man3/QWMatrix.3qt b/doc/man/man3/QWMatrix.3qt deleted file mode 100644 index bd9ad0d1d..000000000 --- a/doc/man/man3/QWMatrix.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwmatrix.3qt diff --git a/doc/man/man3/QWSDecoration.3qt b/doc/man/man3/QWSDecoration.3qt deleted file mode 100644 index 8b3d0bb7f..000000000 --- a/doc/man/man3/QWSDecoration.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwsdecoration.3qt diff --git a/doc/man/man3/QWSInputMethod.3qt b/doc/man/man3/QWSInputMethod.3qt deleted file mode 100644 index aef7cf960..000000000 --- a/doc/man/man3/QWSInputMethod.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwsinputmethod.3qt diff --git a/doc/man/man3/QWSKeyboardHandler.3qt b/doc/man/man3/QWSKeyboardHandler.3qt deleted file mode 100644 index b49afb3f0..000000000 --- a/doc/man/man3/QWSKeyboardHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwskeyboardhandler.3qt diff --git a/doc/man/man3/QWSMouseHandler.3qt b/doc/man/man3/QWSMouseHandler.3qt deleted file mode 100644 index edb549864..000000000 --- a/doc/man/man3/QWSMouseHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwsmousehandler.3qt diff --git a/doc/man/man3/QWSServer.3qt b/doc/man/man3/QWSServer.3qt deleted file mode 100644 index 18db91d81..000000000 --- a/doc/man/man3/QWSServer.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwsserver.3qt diff --git a/doc/man/man3/QWSWindow.3qt b/doc/man/man3/QWSWindow.3qt deleted file mode 100644 index bc415b3ac..000000000 --- a/doc/man/man3/QWSWindow.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwswindow.3qt diff --git a/doc/man/man3/QWaitCondition.3qt b/doc/man/man3/QWaitCondition.3qt deleted file mode 100644 index da2466f6e..000000000 --- a/doc/man/man3/QWaitCondition.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwaitcondition.3qt diff --git a/doc/man/man3/QWhatsThis.3qt b/doc/man/man3/QWhatsThis.3qt deleted file mode 100644 index eeb968a0e..000000000 --- a/doc/man/man3/QWhatsThis.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwhatsthis.3qt diff --git a/doc/man/man3/QWheelEvent.3qt b/doc/man/man3/QWheelEvent.3qt deleted file mode 100644 index c50c34bec..000000000 --- a/doc/man/man3/QWheelEvent.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwheelevent.3qt diff --git a/doc/man/man3/QWidget.3qt b/doc/man/man3/QWidget.3qt deleted file mode 100644 index 6eca5cb53..000000000 --- a/doc/man/man3/QWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwidget.3qt diff --git a/doc/man/man3/QWidgetFactory.3qt b/doc/man/man3/QWidgetFactory.3qt deleted file mode 100644 index e3e393e9d..000000000 --- a/doc/man/man3/QWidgetFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwidgetfactory.3qt diff --git a/doc/man/man3/QWidgetItem.3qt b/doc/man/man3/QWidgetItem.3qt deleted file mode 100644 index b5a32fb20..000000000 --- a/doc/man/man3/QWidgetItem.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwidgetitem.3qt diff --git a/doc/man/man3/QWidgetPlugin.3qt b/doc/man/man3/QWidgetPlugin.3qt deleted file mode 100644 index de33b4e7c..000000000 --- a/doc/man/man3/QWidgetPlugin.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwidgetplugin.3qt diff --git a/doc/man/man3/QWidgetStack.3qt b/doc/man/man3/QWidgetStack.3qt deleted file mode 100644 index 5e7926575..000000000 --- a/doc/man/man3/QWidgetStack.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwidgetstack.3qt diff --git a/doc/man/man3/QWindowsMime.3qt b/doc/man/man3/QWindowsMime.3qt deleted file mode 100644 index eefcaf9c8..000000000 --- a/doc/man/man3/QWindowsMime.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwindowsmime.3qt diff --git a/doc/man/man3/QWindowsStyle.3qt b/doc/man/man3/QWindowsStyle.3qt deleted file mode 100644 index ff414cc3b..000000000 --- a/doc/man/man3/QWindowsStyle.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwindowsstyle.3qt diff --git a/doc/man/man3/QWizard.3qt b/doc/man/man3/QWizard.3qt deleted file mode 100644 index 74481614b..000000000 --- a/doc/man/man3/QWizard.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qwizard.3qt diff --git a/doc/man/man3/QWorkspace.3qt b/doc/man/man3/QWorkspace.3qt deleted file mode 100644 index a4be83171..000000000 --- a/doc/man/man3/QWorkspace.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qworkspace.3qt diff --git a/doc/man/man3/QXmlAttributes.3qt b/doc/man/man3/QXmlAttributes.3qt deleted file mode 100644 index a99a2435b..000000000 --- a/doc/man/man3/QXmlAttributes.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlattributes.3qt diff --git a/doc/man/man3/QXmlContentHandler.3qt b/doc/man/man3/QXmlContentHandler.3qt deleted file mode 100644 index 4b4349c66..000000000 --- a/doc/man/man3/QXmlContentHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlcontenthandler.3qt diff --git a/doc/man/man3/QXmlDTDHandler.3qt b/doc/man/man3/QXmlDTDHandler.3qt deleted file mode 100644 index 993666f33..000000000 --- a/doc/man/man3/QXmlDTDHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmldtdhandler.3qt diff --git a/doc/man/man3/QXmlDeclHandler.3qt b/doc/man/man3/QXmlDeclHandler.3qt deleted file mode 100644 index 794af7d38..000000000 --- a/doc/man/man3/QXmlDeclHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmldeclhandler.3qt diff --git a/doc/man/man3/QXmlDefaultHandler.3qt b/doc/man/man3/QXmlDefaultHandler.3qt deleted file mode 100644 index 070113004..000000000 --- a/doc/man/man3/QXmlDefaultHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmldefaulthandler.3qt diff --git a/doc/man/man3/QXmlEntityResolver.3qt b/doc/man/man3/QXmlEntityResolver.3qt deleted file mode 100644 index 6c1566e4c..000000000 --- a/doc/man/man3/QXmlEntityResolver.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlentityresolver.3qt diff --git a/doc/man/man3/QXmlErrorHandler.3qt b/doc/man/man3/QXmlErrorHandler.3qt deleted file mode 100644 index 96332d0dd..000000000 --- a/doc/man/man3/QXmlErrorHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlerrorhandler.3qt diff --git a/doc/man/man3/QXmlInputSource.3qt b/doc/man/man3/QXmlInputSource.3qt deleted file mode 100644 index 7eb985c80..000000000 --- a/doc/man/man3/QXmlInputSource.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlinputsource.3qt diff --git a/doc/man/man3/QXmlLexicalHandler.3qt b/doc/man/man3/QXmlLexicalHandler.3qt deleted file mode 100644 index 4ac9b3799..000000000 --- a/doc/man/man3/QXmlLexicalHandler.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmllexicalhandler.3qt diff --git a/doc/man/man3/QXmlLocator.3qt b/doc/man/man3/QXmlLocator.3qt deleted file mode 100644 index 8f2a5fdfc..000000000 --- a/doc/man/man3/QXmlLocator.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmllocator.3qt diff --git a/doc/man/man3/QXmlNamespaceSupport.3qt b/doc/man/man3/QXmlNamespaceSupport.3qt deleted file mode 100644 index 0f334bb0e..000000000 --- a/doc/man/man3/QXmlNamespaceSupport.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlnamespacesupport.3qt diff --git a/doc/man/man3/QXmlParseException.3qt b/doc/man/man3/QXmlParseException.3qt deleted file mode 100644 index d418b200a..000000000 --- a/doc/man/man3/QXmlParseException.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlparseexception.3qt diff --git a/doc/man/man3/QXmlReader.3qt b/doc/man/man3/QXmlReader.3qt deleted file mode 100644 index 9a201bcd1..000000000 --- a/doc/man/man3/QXmlReader.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlreader.3qt diff --git a/doc/man/man3/QXmlSimpleReader.3qt b/doc/man/man3/QXmlSimpleReader.3qt deleted file mode 100644 index 0c00d0081..000000000 --- a/doc/man/man3/QXmlSimpleReader.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qxmlsimplereader.3qt diff --git a/doc/man/man3/Qt.3qt b/doc/man/man3/Qt.3qt deleted file mode 100644 index 46f304aae..000000000 --- a/doc/man/man3/Qt.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/qt.3qt diff --git a/doc/man/man3/TQAccel.3qt b/doc/man/man3/TQAccel.3qt new file mode 100644 index 000000000..12f28581b --- /dev/null +++ b/doc/man/man3/TQAccel.3qt @@ -0,0 +1 @@ +.so man3/tqaccel.3qt diff --git a/doc/man/man3/TQAccessible.3qt b/doc/man/man3/TQAccessible.3qt new file mode 100644 index 000000000..e44507675 --- /dev/null +++ b/doc/man/man3/TQAccessible.3qt @@ -0,0 +1 @@ +.so man3/tqaccessible.3qt diff --git a/doc/man/man3/TQAccessibleInterface.3qt b/doc/man/man3/TQAccessibleInterface.3qt new file mode 100644 index 000000000..caf5619bd --- /dev/null +++ b/doc/man/man3/TQAccessibleInterface.3qt @@ -0,0 +1 @@ +.so man3/tqaccessibleinterface.3qt diff --git a/doc/man/man3/TQAccessibleObject.3qt b/doc/man/man3/TQAccessibleObject.3qt new file mode 100644 index 000000000..81376d559 --- /dev/null +++ b/doc/man/man3/TQAccessibleObject.3qt @@ -0,0 +1 @@ +.so man3/tqaccessibleobject.3qt diff --git a/doc/man/man3/TQAction.3qt b/doc/man/man3/TQAction.3qt new file mode 100644 index 000000000..0c09f0860 --- /dev/null +++ b/doc/man/man3/TQAction.3qt @@ -0,0 +1 @@ +.so man3/tqaction.3qt diff --git a/doc/man/man3/TQActionGroup.3qt b/doc/man/man3/TQActionGroup.3qt new file mode 100644 index 000000000..cd91d08f6 --- /dev/null +++ b/doc/man/man3/TQActionGroup.3qt @@ -0,0 +1 @@ +.so man3/tqactiongroup.3qt diff --git a/doc/man/man3/TQApplication.3qt b/doc/man/man3/TQApplication.3qt new file mode 100644 index 000000000..24bc96bd1 --- /dev/null +++ b/doc/man/man3/TQApplication.3qt @@ -0,0 +1 @@ +.so man3/tqapplication.3qt diff --git a/doc/man/man3/TQAsciiCache.3qt b/doc/man/man3/TQAsciiCache.3qt new file mode 100644 index 000000000..39cc59de5 --- /dev/null +++ b/doc/man/man3/TQAsciiCache.3qt @@ -0,0 +1 @@ +.so man3/tqasciicache.3qt diff --git a/doc/man/man3/TQAsciiCacheIterator.3qt b/doc/man/man3/TQAsciiCacheIterator.3qt new file mode 100644 index 000000000..9e688a772 --- /dev/null +++ b/doc/man/man3/TQAsciiCacheIterator.3qt @@ -0,0 +1 @@ +.so man3/tqasciicacheiterator.3qt diff --git a/doc/man/man3/TQAsciiDict.3qt b/doc/man/man3/TQAsciiDict.3qt new file mode 100644 index 000000000..602ae4e7e --- /dev/null +++ b/doc/man/man3/TQAsciiDict.3qt @@ -0,0 +1 @@ +.so man3/tqasciidict.3qt diff --git a/doc/man/man3/TQAsciiDictIterator.3qt b/doc/man/man3/TQAsciiDictIterator.3qt new file mode 100644 index 000000000..0a042679e --- /dev/null +++ b/doc/man/man3/TQAsciiDictIterator.3qt @@ -0,0 +1 @@ +.so man3/tqasciidictiterator.3qt diff --git a/doc/man/man3/TQAssistantClient.3qt b/doc/man/man3/TQAssistantClient.3qt new file mode 100644 index 000000000..b39d51527 --- /dev/null +++ b/doc/man/man3/TQAssistantClient.3qt @@ -0,0 +1 @@ +.so man3/tqassistantclient.3qt diff --git a/doc/man/man3/TQAxAggregated.3qt b/doc/man/man3/TQAxAggregated.3qt new file mode 100644 index 000000000..d05590c34 --- /dev/null +++ b/doc/man/man3/TQAxAggregated.3qt @@ -0,0 +1 @@ +.so man3/tqaxaggregated.3qt diff --git a/doc/man/man3/TQAxBase.3qt b/doc/man/man3/TQAxBase.3qt new file mode 100644 index 000000000..84be97693 --- /dev/null +++ b/doc/man/man3/TQAxBase.3qt @@ -0,0 +1 @@ +.so man3/tqaxbase.3qt diff --git a/doc/man/man3/TQAxBindable.3qt b/doc/man/man3/TQAxBindable.3qt new file mode 100644 index 000000000..affde1f63 --- /dev/null +++ b/doc/man/man3/TQAxBindable.3qt @@ -0,0 +1 @@ +.so man3/tqaxbindable.3qt diff --git a/doc/man/man3/TQAxFactory.3qt b/doc/man/man3/TQAxFactory.3qt new file mode 100644 index 000000000..c1881659c --- /dev/null +++ b/doc/man/man3/TQAxFactory.3qt @@ -0,0 +1 @@ +.so man3/tqaxfactory.3qt diff --git a/doc/man/man3/TQAxObject.3qt b/doc/man/man3/TQAxObject.3qt new file mode 100644 index 000000000..f99792754 --- /dev/null +++ b/doc/man/man3/TQAxObject.3qt @@ -0,0 +1 @@ +.so man3/tqaxobject.3qt diff --git a/doc/man/man3/TQAxScript.3qt b/doc/man/man3/TQAxScript.3qt new file mode 100644 index 000000000..4e66e409f --- /dev/null +++ b/doc/man/man3/TQAxScript.3qt @@ -0,0 +1 @@ +.so man3/tqaxscript.3qt diff --git a/doc/man/man3/TQAxScriptEngine.3qt b/doc/man/man3/TQAxScriptEngine.3qt new file mode 100644 index 000000000..61f57d540 --- /dev/null +++ b/doc/man/man3/TQAxScriptEngine.3qt @@ -0,0 +1 @@ +.so man3/tqaxscriptengine.3qt diff --git a/doc/man/man3/TQAxScriptManager.3qt b/doc/man/man3/TQAxScriptManager.3qt new file mode 100644 index 000000000..fdc829434 --- /dev/null +++ b/doc/man/man3/TQAxScriptManager.3qt @@ -0,0 +1 @@ +.so man3/tqaxscriptmanager.3qt diff --git a/doc/man/man3/TQAxWidget.3qt b/doc/man/man3/TQAxWidget.3qt new file mode 100644 index 000000000..5c02f767c --- /dev/null +++ b/doc/man/man3/TQAxWidget.3qt @@ -0,0 +1 @@ +.so man3/tqaxwidget.3qt diff --git a/doc/man/man3/TQBig5Codec.3qt b/doc/man/man3/TQBig5Codec.3qt new file mode 100644 index 000000000..362f1b946 --- /dev/null +++ b/doc/man/man3/TQBig5Codec.3qt @@ -0,0 +1 @@ +.so man3/tqbig5codec.3qt diff --git a/doc/man/man3/TQBig5hkscsCodec.3qt b/doc/man/man3/TQBig5hkscsCodec.3qt new file mode 100644 index 000000000..11e60eff7 --- /dev/null +++ b/doc/man/man3/TQBig5hkscsCodec.3qt @@ -0,0 +1 @@ +.so man3/tqbig5hkscscodec.3qt diff --git a/doc/man/man3/TQBitArray.3qt b/doc/man/man3/TQBitArray.3qt new file mode 100644 index 000000000..c6c3a305c --- /dev/null +++ b/doc/man/man3/TQBitArray.3qt @@ -0,0 +1 @@ +.so man3/tqbitarray.3qt diff --git a/doc/man/man3/TQBitVal.3qt b/doc/man/man3/TQBitVal.3qt new file mode 100644 index 000000000..e3372a708 --- /dev/null +++ b/doc/man/man3/TQBitVal.3qt @@ -0,0 +1 @@ +.so man3/tqbitval.3qt diff --git a/doc/man/man3/TQBitmap.3qt b/doc/man/man3/TQBitmap.3qt new file mode 100644 index 000000000..e550cd45e --- /dev/null +++ b/doc/man/man3/TQBitmap.3qt @@ -0,0 +1 @@ +.so man3/tqbitmap.3qt diff --git a/doc/man/man3/TQBoxLayout.3qt b/doc/man/man3/TQBoxLayout.3qt new file mode 100644 index 000000000..807b761f0 --- /dev/null +++ b/doc/man/man3/TQBoxLayout.3qt @@ -0,0 +1 @@ +.so man3/tqboxlayout.3qt diff --git a/doc/man/man3/TQBrush.3qt b/doc/man/man3/TQBrush.3qt new file mode 100644 index 000000000..7db5eca66 --- /dev/null +++ b/doc/man/man3/TQBrush.3qt @@ -0,0 +1 @@ +.so man3/tqbrush.3qt diff --git a/doc/man/man3/TQBuffer.3qt b/doc/man/man3/TQBuffer.3qt new file mode 100644 index 000000000..96fb361d1 --- /dev/null +++ b/doc/man/man3/TQBuffer.3qt @@ -0,0 +1 @@ +.so man3/tqbuffer.3qt diff --git a/doc/man/man3/TQButton.3qt b/doc/man/man3/TQButton.3qt new file mode 100644 index 000000000..e4b8081eb --- /dev/null +++ b/doc/man/man3/TQButton.3qt @@ -0,0 +1 @@ +.so man3/tqbutton.3qt diff --git a/doc/man/man3/TQButtonGroup.3qt b/doc/man/man3/TQButtonGroup.3qt new file mode 100644 index 000000000..fb8dad274 --- /dev/null +++ b/doc/man/man3/TQButtonGroup.3qt @@ -0,0 +1 @@ +.so man3/tqbuttongroup.3qt diff --git a/doc/man/man3/TQByteArray.3qt b/doc/man/man3/TQByteArray.3qt new file mode 100644 index 000000000..b4c3dc659 --- /dev/null +++ b/doc/man/man3/TQByteArray.3qt @@ -0,0 +1 @@ +.so man3/tqbytearray.3qt diff --git a/doc/man/man3/TQCDEStyle.3qt b/doc/man/man3/TQCDEStyle.3qt new file mode 100644 index 000000000..f89ef9e6a --- /dev/null +++ b/doc/man/man3/TQCDEStyle.3qt @@ -0,0 +1 @@ +.so man3/tqcdestyle.3qt diff --git a/doc/man/man3/TQCString.3qt b/doc/man/man3/TQCString.3qt new file mode 100644 index 000000000..f77040674 --- /dev/null +++ b/doc/man/man3/TQCString.3qt @@ -0,0 +1 @@ +.so man3/tqcstring.3qt diff --git a/doc/man/man3/TQCache.3qt b/doc/man/man3/TQCache.3qt new file mode 100644 index 000000000..41d32bc7d --- /dev/null +++ b/doc/man/man3/TQCache.3qt @@ -0,0 +1 @@ +.so man3/tqcache.3qt diff --git a/doc/man/man3/TQCacheIterator.3qt b/doc/man/man3/TQCacheIterator.3qt new file mode 100644 index 000000000..8170895f0 --- /dev/null +++ b/doc/man/man3/TQCacheIterator.3qt @@ -0,0 +1 @@ +.so man3/tqcacheiterator.3qt diff --git a/doc/man/man3/TQCanvas.3qt b/doc/man/man3/TQCanvas.3qt new file mode 100644 index 000000000..3c8c05167 --- /dev/null +++ b/doc/man/man3/TQCanvas.3qt @@ -0,0 +1 @@ +.so man3/tqcanvas.3qt diff --git a/doc/man/man3/TQCanvasEllipse.3qt b/doc/man/man3/TQCanvasEllipse.3qt new file mode 100644 index 000000000..915aee71f --- /dev/null +++ b/doc/man/man3/TQCanvasEllipse.3qt @@ -0,0 +1 @@ +.so man3/tqcanvasellipse.3qt diff --git a/doc/man/man3/TQCanvasItem.3qt b/doc/man/man3/TQCanvasItem.3qt new file mode 100644 index 000000000..434c555a2 --- /dev/null +++ b/doc/man/man3/TQCanvasItem.3qt @@ -0,0 +1 @@ +.so man3/tqcanvasitem.3qt diff --git a/doc/man/man3/TQCanvasItemList.3qt b/doc/man/man3/TQCanvasItemList.3qt new file mode 100644 index 000000000..f08e3ab01 --- /dev/null +++ b/doc/man/man3/TQCanvasItemList.3qt @@ -0,0 +1 @@ +.so man3/tqcanvasitemlist.3qt diff --git a/doc/man/man3/TQCanvasLine.3qt b/doc/man/man3/TQCanvasLine.3qt new file mode 100644 index 000000000..a24a2aa3d --- /dev/null +++ b/doc/man/man3/TQCanvasLine.3qt @@ -0,0 +1 @@ +.so man3/tqcanvasline.3qt diff --git a/doc/man/man3/TQCanvasPixmap.3qt b/doc/man/man3/TQCanvasPixmap.3qt new file mode 100644 index 000000000..855504960 --- /dev/null +++ b/doc/man/man3/TQCanvasPixmap.3qt @@ -0,0 +1 @@ +.so man3/tqcanvaspixmap.3qt diff --git a/doc/man/man3/TQCanvasPixmapArray.3qt b/doc/man/man3/TQCanvasPixmapArray.3qt new file mode 100644 index 000000000..4476a70b6 --- /dev/null +++ b/doc/man/man3/TQCanvasPixmapArray.3qt @@ -0,0 +1 @@ +.so man3/tqcanvaspixmaparray.3qt diff --git a/doc/man/man3/TQCanvasPolygon.3qt b/doc/man/man3/TQCanvasPolygon.3qt new file mode 100644 index 000000000..d918477ea --- /dev/null +++ b/doc/man/man3/TQCanvasPolygon.3qt @@ -0,0 +1 @@ +.so man3/tqcanvaspolygon.3qt diff --git a/doc/man/man3/TQCanvasPolygonalItem.3qt b/doc/man/man3/TQCanvasPolygonalItem.3qt new file mode 100644 index 000000000..e5123045f --- /dev/null +++ b/doc/man/man3/TQCanvasPolygonalItem.3qt @@ -0,0 +1 @@ +.so man3/tqcanvaspolygonalitem.3qt diff --git a/doc/man/man3/TQCanvasRectangle.3qt b/doc/man/man3/TQCanvasRectangle.3qt new file mode 100644 index 000000000..f77a3086a --- /dev/null +++ b/doc/man/man3/TQCanvasRectangle.3qt @@ -0,0 +1 @@ +.so man3/tqcanvasrectangle.3qt diff --git a/doc/man/man3/TQCanvasSpline.3qt b/doc/man/man3/TQCanvasSpline.3qt new file mode 100644 index 000000000..5f9af11c7 --- /dev/null +++ b/doc/man/man3/TQCanvasSpline.3qt @@ -0,0 +1 @@ +.so man3/tqcanvasspline.3qt diff --git a/doc/man/man3/TQCanvasSprite.3qt b/doc/man/man3/TQCanvasSprite.3qt new file mode 100644 index 000000000..54df2b938 --- /dev/null +++ b/doc/man/man3/TQCanvasSprite.3qt @@ -0,0 +1 @@ +.so man3/tqcanvassprite.3qt diff --git a/doc/man/man3/TQCanvasText.3qt b/doc/man/man3/TQCanvasText.3qt new file mode 100644 index 000000000..955e4af0d --- /dev/null +++ b/doc/man/man3/TQCanvasText.3qt @@ -0,0 +1 @@ +.so man3/tqcanvastext.3qt diff --git a/doc/man/man3/TQCanvasView.3qt b/doc/man/man3/TQCanvasView.3qt new file mode 100644 index 000000000..efbbab1d4 --- /dev/null +++ b/doc/man/man3/TQCanvasView.3qt @@ -0,0 +1 @@ +.so man3/tqcanvasview.3qt diff --git a/doc/man/man3/TQChar.3qt b/doc/man/man3/TQChar.3qt new file mode 100644 index 000000000..d14f087f1 --- /dev/null +++ b/doc/man/man3/TQChar.3qt @@ -0,0 +1 @@ +.so man3/tqchar.3qt diff --git a/doc/man/man3/TQCharRef.3qt b/doc/man/man3/TQCharRef.3qt new file mode 100644 index 000000000..1dfb41cb6 --- /dev/null +++ b/doc/man/man3/TQCharRef.3qt @@ -0,0 +1 @@ +.so man3/tqcharref.3qt diff --git a/doc/man/man3/TQCheckBox.3qt b/doc/man/man3/TQCheckBox.3qt new file mode 100644 index 000000000..964236a42 --- /dev/null +++ b/doc/man/man3/TQCheckBox.3qt @@ -0,0 +1 @@ +.so man3/tqcheckbox.3qt diff --git a/doc/man/man3/TQCheckListItem.3qt b/doc/man/man3/TQCheckListItem.3qt new file mode 100644 index 000000000..92088a9d7 --- /dev/null +++ b/doc/man/man3/TQCheckListItem.3qt @@ -0,0 +1 @@ +.so man3/tqchecklistitem.3qt diff --git a/doc/man/man3/TQCheckTableItem.3qt b/doc/man/man3/TQCheckTableItem.3qt new file mode 100644 index 000000000..0486e6869 --- /dev/null +++ b/doc/man/man3/TQCheckTableItem.3qt @@ -0,0 +1 @@ +.so man3/tqchecktableitem.3qt diff --git a/doc/man/man3/TQChildEvent.3qt b/doc/man/man3/TQChildEvent.3qt new file mode 100644 index 000000000..4450f1cde --- /dev/null +++ b/doc/man/man3/TQChildEvent.3qt @@ -0,0 +1 @@ +.so man3/tqchildevent.3qt diff --git a/doc/man/man3/TQClipboard.3qt b/doc/man/man3/TQClipboard.3qt new file mode 100644 index 000000000..51269f8b5 --- /dev/null +++ b/doc/man/man3/TQClipboard.3qt @@ -0,0 +1 @@ +.so man3/tqclipboard.3qt diff --git a/doc/man/man3/TQCloseEvent.3qt b/doc/man/man3/TQCloseEvent.3qt new file mode 100644 index 000000000..5e55b0505 --- /dev/null +++ b/doc/man/man3/TQCloseEvent.3qt @@ -0,0 +1 @@ +.so man3/tqcloseevent.3qt diff --git a/doc/man/man3/TQColor.3qt b/doc/man/man3/TQColor.3qt new file mode 100644 index 000000000..451cb28d4 --- /dev/null +++ b/doc/man/man3/TQColor.3qt @@ -0,0 +1 @@ +.so man3/tqcolor.3qt diff --git a/doc/man/man3/TQColorDialog.3qt b/doc/man/man3/TQColorDialog.3qt new file mode 100644 index 000000000..12d19e191 --- /dev/null +++ b/doc/man/man3/TQColorDialog.3qt @@ -0,0 +1 @@ +.so man3/tqcolordialog.3qt diff --git a/doc/man/man3/TQColorDrag.3qt b/doc/man/man3/TQColorDrag.3qt new file mode 100644 index 000000000..9fe3bc46a --- /dev/null +++ b/doc/man/man3/TQColorDrag.3qt @@ -0,0 +1 @@ +.so man3/tqcolordrag.3qt diff --git a/doc/man/man3/TQColorGroup.3qt b/doc/man/man3/TQColorGroup.3qt new file mode 100644 index 000000000..742b4c9ec --- /dev/null +++ b/doc/man/man3/TQColorGroup.3qt @@ -0,0 +1 @@ +.so man3/tqcolorgroup.3qt diff --git a/doc/man/man3/TQComboBox.3qt b/doc/man/man3/TQComboBox.3qt new file mode 100644 index 000000000..dabd679fe --- /dev/null +++ b/doc/man/man3/TQComboBox.3qt @@ -0,0 +1 @@ +.so man3/tqcombobox.3qt diff --git a/doc/man/man3/TQComboTableItem.3qt b/doc/man/man3/TQComboTableItem.3qt new file mode 100644 index 000000000..ea97fe730 --- /dev/null +++ b/doc/man/man3/TQComboTableItem.3qt @@ -0,0 +1 @@ +.so man3/tqcombotableitem.3qt diff --git a/doc/man/man3/TQCommonStyle.3qt b/doc/man/man3/TQCommonStyle.3qt new file mode 100644 index 000000000..b36d54ff2 --- /dev/null +++ b/doc/man/man3/TQCommonStyle.3qt @@ -0,0 +1 @@ +.so man3/tqcommonstyle.3qt diff --git a/doc/man/man3/TQConstString.3qt b/doc/man/man3/TQConstString.3qt new file mode 100644 index 000000000..ef407d29a --- /dev/null +++ b/doc/man/man3/TQConstString.3qt @@ -0,0 +1 @@ +.so man3/tqconststring.3qt diff --git a/doc/man/man3/TQContextMenuEvent.3qt b/doc/man/man3/TQContextMenuEvent.3qt new file mode 100644 index 000000000..a3224f055 --- /dev/null +++ b/doc/man/man3/TQContextMenuEvent.3qt @@ -0,0 +1 @@ +.so man3/tqcontextmenuevent.3qt diff --git a/doc/man/man3/TQCopChannel.3qt b/doc/man/man3/TQCopChannel.3qt new file mode 100644 index 000000000..258c473ca --- /dev/null +++ b/doc/man/man3/TQCopChannel.3qt @@ -0,0 +1 @@ +.so man3/tqcopchannel.3qt diff --git a/doc/man/man3/TQCursor.3qt b/doc/man/man3/TQCursor.3qt new file mode 100644 index 000000000..c45f4a331 --- /dev/null +++ b/doc/man/man3/TQCursor.3qt @@ -0,0 +1 @@ +.so man3/tqcursor.3qt diff --git a/doc/man/man3/TQCustomEvent.3qt b/doc/man/man3/TQCustomEvent.3qt new file mode 100644 index 000000000..401bbe5cc --- /dev/null +++ b/doc/man/man3/TQCustomEvent.3qt @@ -0,0 +1 @@ +.so man3/tqcustomevent.3qt diff --git a/doc/man/man3/TQCustomMenuItem.3qt b/doc/man/man3/TQCustomMenuItem.3qt new file mode 100644 index 000000000..392061819 --- /dev/null +++ b/doc/man/man3/TQCustomMenuItem.3qt @@ -0,0 +1 @@ +.so man3/tqcustommenuitem.3qt diff --git a/doc/man/man3/TQDataBrowser.3qt b/doc/man/man3/TQDataBrowser.3qt new file mode 100644 index 000000000..5f163fd66 --- /dev/null +++ b/doc/man/man3/TQDataBrowser.3qt @@ -0,0 +1 @@ +.so man3/tqdatabrowser.3qt diff --git a/doc/man/man3/TQDataStream.3qt b/doc/man/man3/TQDataStream.3qt new file mode 100644 index 000000000..6d219f6ce --- /dev/null +++ b/doc/man/man3/TQDataStream.3qt @@ -0,0 +1 @@ +.so man3/tqdatastream.3qt diff --git a/doc/man/man3/TQDataTable.3qt b/doc/man/man3/TQDataTable.3qt new file mode 100644 index 000000000..abca6aba0 --- /dev/null +++ b/doc/man/man3/TQDataTable.3qt @@ -0,0 +1 @@ +.so man3/tqdatatable.3qt diff --git a/doc/man/man3/TQDataView.3qt b/doc/man/man3/TQDataView.3qt new file mode 100644 index 000000000..c7b6fda6f --- /dev/null +++ b/doc/man/man3/TQDataView.3qt @@ -0,0 +1 @@ +.so man3/tqdataview.3qt diff --git a/doc/man/man3/TQDate.3qt b/doc/man/man3/TQDate.3qt new file mode 100644 index 000000000..5f385c4ff --- /dev/null +++ b/doc/man/man3/TQDate.3qt @@ -0,0 +1 @@ +.so man3/tqdate.3qt diff --git a/doc/man/man3/TQDateEdit.3qt b/doc/man/man3/TQDateEdit.3qt new file mode 100644 index 000000000..cbcbb3589 --- /dev/null +++ b/doc/man/man3/TQDateEdit.3qt @@ -0,0 +1 @@ +.so man3/tqdateedit.3qt diff --git a/doc/man/man3/TQDateTime.3qt b/doc/man/man3/TQDateTime.3qt new file mode 100644 index 000000000..ddf2bab7b --- /dev/null +++ b/doc/man/man3/TQDateTime.3qt @@ -0,0 +1 @@ +.so man3/tqdatetime.3qt diff --git a/doc/man/man3/TQDateTimeEdit.3qt b/doc/man/man3/TQDateTimeEdit.3qt new file mode 100644 index 000000000..361db851b --- /dev/null +++ b/doc/man/man3/TQDateTimeEdit.3qt @@ -0,0 +1 @@ +.so man3/tqdatetimeedit.3qt diff --git a/doc/man/man3/TQDateTimeEditBase.3qt b/doc/man/man3/TQDateTimeEditBase.3qt new file mode 100644 index 000000000..a2d98ce44 --- /dev/null +++ b/doc/man/man3/TQDateTimeEditBase.3qt @@ -0,0 +1 @@ +.so man3/tqdatetimeeditbase.3qt diff --git a/doc/man/man3/TQDeepCopy.3qt b/doc/man/man3/TQDeepCopy.3qt new file mode 100644 index 000000000..a65e3a4c5 --- /dev/null +++ b/doc/man/man3/TQDeepCopy.3qt @@ -0,0 +1 @@ +.so man3/tqdeepcopy.3qt diff --git a/doc/man/man3/TQDesktopWidget.3qt b/doc/man/man3/TQDesktopWidget.3qt new file mode 100644 index 000000000..1bfd00485 --- /dev/null +++ b/doc/man/man3/TQDesktopWidget.3qt @@ -0,0 +1 @@ +.so man3/tqdesktopwidget.3qt diff --git a/doc/man/man3/TQDial.3qt b/doc/man/man3/TQDial.3qt new file mode 100644 index 000000000..85b563868 --- /dev/null +++ b/doc/man/man3/TQDial.3qt @@ -0,0 +1 @@ +.so man3/tqdial.3qt diff --git a/doc/man/man3/TQDialog.3qt b/doc/man/man3/TQDialog.3qt new file mode 100644 index 000000000..f8c205927 --- /dev/null +++ b/doc/man/man3/TQDialog.3qt @@ -0,0 +1 @@ +.so man3/tqdialog.3qt diff --git a/doc/man/man3/TQDict.3qt b/doc/man/man3/TQDict.3qt new file mode 100644 index 000000000..30a494c80 --- /dev/null +++ b/doc/man/man3/TQDict.3qt @@ -0,0 +1 @@ +.so man3/tqdict.3qt diff --git a/doc/man/man3/TQDictIterator.3qt b/doc/man/man3/TQDictIterator.3qt new file mode 100644 index 000000000..b5bc25bc3 --- /dev/null +++ b/doc/man/man3/TQDictIterator.3qt @@ -0,0 +1 @@ +.so man3/tqdictiterator.3qt diff --git a/doc/man/man3/TQDir.3qt b/doc/man/man3/TQDir.3qt new file mode 100644 index 000000000..30a3c8719 --- /dev/null +++ b/doc/man/man3/TQDir.3qt @@ -0,0 +1 @@ +.so man3/tqdir.3qt diff --git a/doc/man/man3/TQDirectPainter.3qt b/doc/man/man3/TQDirectPainter.3qt new file mode 100644 index 000000000..47aeac0e5 --- /dev/null +++ b/doc/man/man3/TQDirectPainter.3qt @@ -0,0 +1 @@ +.so man3/tqdirectpainter.3qt diff --git a/doc/man/man3/TQDns.3qt b/doc/man/man3/TQDns.3qt new file mode 100644 index 000000000..6c6b3097d --- /dev/null +++ b/doc/man/man3/TQDns.3qt @@ -0,0 +1 @@ +.so man3/tqdns.3qt diff --git a/doc/man/man3/TQDockArea.3qt b/doc/man/man3/TQDockArea.3qt new file mode 100644 index 000000000..1d48a63bf --- /dev/null +++ b/doc/man/man3/TQDockArea.3qt @@ -0,0 +1 @@ +.so man3/tqdockarea.3qt diff --git a/doc/man/man3/TQDockWindow.3qt b/doc/man/man3/TQDockWindow.3qt new file mode 100644 index 000000000..0cb14bb4d --- /dev/null +++ b/doc/man/man3/TQDockWindow.3qt @@ -0,0 +1 @@ +.so man3/tqdockwindow.3qt diff --git a/doc/man/man3/TQDomAttr.3qt b/doc/man/man3/TQDomAttr.3qt new file mode 100644 index 000000000..5fffc0d75 --- /dev/null +++ b/doc/man/man3/TQDomAttr.3qt @@ -0,0 +1 @@ +.so man3/tqdomattr.3qt diff --git a/doc/man/man3/TQDomCDATASection.3qt b/doc/man/man3/TQDomCDATASection.3qt new file mode 100644 index 000000000..5d103a9c1 --- /dev/null +++ b/doc/man/man3/TQDomCDATASection.3qt @@ -0,0 +1 @@ +.so man3/tqdomcdatasection.3qt diff --git a/doc/man/man3/TQDomCharacterData.3qt b/doc/man/man3/TQDomCharacterData.3qt new file mode 100644 index 000000000..91307715f --- /dev/null +++ b/doc/man/man3/TQDomCharacterData.3qt @@ -0,0 +1 @@ +.so man3/tqdomcharacterdata.3qt diff --git a/doc/man/man3/TQDomComment.3qt b/doc/man/man3/TQDomComment.3qt new file mode 100644 index 000000000..4ccbc2714 --- /dev/null +++ b/doc/man/man3/TQDomComment.3qt @@ -0,0 +1 @@ +.so man3/tqdomcomment.3qt diff --git a/doc/man/man3/TQDomDocument.3qt b/doc/man/man3/TQDomDocument.3qt new file mode 100644 index 000000000..f4497acf6 --- /dev/null +++ b/doc/man/man3/TQDomDocument.3qt @@ -0,0 +1 @@ +.so man3/tqdomdocument.3qt diff --git a/doc/man/man3/TQDomDocumentFragment.3qt b/doc/man/man3/TQDomDocumentFragment.3qt new file mode 100644 index 000000000..2797bc399 --- /dev/null +++ b/doc/man/man3/TQDomDocumentFragment.3qt @@ -0,0 +1 @@ +.so man3/tqdomdocumentfragment.3qt diff --git a/doc/man/man3/TQDomDocumentType.3qt b/doc/man/man3/TQDomDocumentType.3qt new file mode 100644 index 000000000..e53017cc2 --- /dev/null +++ b/doc/man/man3/TQDomDocumentType.3qt @@ -0,0 +1 @@ +.so man3/tqdomdocumenttype.3qt diff --git a/doc/man/man3/TQDomElement.3qt b/doc/man/man3/TQDomElement.3qt new file mode 100644 index 000000000..1fb993aa6 --- /dev/null +++ b/doc/man/man3/TQDomElement.3qt @@ -0,0 +1 @@ +.so man3/tqdomelement.3qt diff --git a/doc/man/man3/TQDomEntity.3qt b/doc/man/man3/TQDomEntity.3qt new file mode 100644 index 000000000..8b10b1055 --- /dev/null +++ b/doc/man/man3/TQDomEntity.3qt @@ -0,0 +1 @@ +.so man3/tqdomentity.3qt diff --git a/doc/man/man3/TQDomEntityReference.3qt b/doc/man/man3/TQDomEntityReference.3qt new file mode 100644 index 000000000..e622c8d91 --- /dev/null +++ b/doc/man/man3/TQDomEntityReference.3qt @@ -0,0 +1 @@ +.so man3/tqdomentityreference.3qt diff --git a/doc/man/man3/TQDomImplementation.3qt b/doc/man/man3/TQDomImplementation.3qt new file mode 100644 index 000000000..40ad1bf84 --- /dev/null +++ b/doc/man/man3/TQDomImplementation.3qt @@ -0,0 +1 @@ +.so man3/tqdomimplementation.3qt diff --git a/doc/man/man3/TQDomNamedNodeMap.3qt b/doc/man/man3/TQDomNamedNodeMap.3qt new file mode 100644 index 000000000..7cc9f7230 --- /dev/null +++ b/doc/man/man3/TQDomNamedNodeMap.3qt @@ -0,0 +1 @@ +.so man3/tqdomnamednodemap.3qt diff --git a/doc/man/man3/TQDomNode.3qt b/doc/man/man3/TQDomNode.3qt new file mode 100644 index 000000000..d480c8d0f --- /dev/null +++ b/doc/man/man3/TQDomNode.3qt @@ -0,0 +1 @@ +.so man3/tqdomnode.3qt diff --git a/doc/man/man3/TQDomNodeList.3qt b/doc/man/man3/TQDomNodeList.3qt new file mode 100644 index 000000000..efb23ddda --- /dev/null +++ b/doc/man/man3/TQDomNodeList.3qt @@ -0,0 +1 @@ +.so man3/tqdomnodelist.3qt diff --git a/doc/man/man3/TQDomNotation.3qt b/doc/man/man3/TQDomNotation.3qt new file mode 100644 index 000000000..52763e387 --- /dev/null +++ b/doc/man/man3/TQDomNotation.3qt @@ -0,0 +1 @@ +.so man3/tqdomnotation.3qt diff --git a/doc/man/man3/TQDomProcessingInstruction.3qt b/doc/man/man3/TQDomProcessingInstruction.3qt new file mode 100644 index 000000000..fb522c754 --- /dev/null +++ b/doc/man/man3/TQDomProcessingInstruction.3qt @@ -0,0 +1 @@ +.so man3/tqdomprocessinginstruction.3qt diff --git a/doc/man/man3/TQDomText.3qt b/doc/man/man3/TQDomText.3qt new file mode 100644 index 000000000..aa01787de --- /dev/null +++ b/doc/man/man3/TQDomText.3qt @@ -0,0 +1 @@ +.so man3/tqdomtext.3qt diff --git a/doc/man/man3/TQDoubleValidator.3qt b/doc/man/man3/TQDoubleValidator.3qt new file mode 100644 index 000000000..6d9008828 --- /dev/null +++ b/doc/man/man3/TQDoubleValidator.3qt @@ -0,0 +1 @@ +.so man3/tqdoublevalidator.3qt diff --git a/doc/man/man3/TQDragEnterEvent.3qt b/doc/man/man3/TQDragEnterEvent.3qt new file mode 100644 index 000000000..ab96e5c00 --- /dev/null +++ b/doc/man/man3/TQDragEnterEvent.3qt @@ -0,0 +1 @@ +.so man3/tqdragenterevent.3qt diff --git a/doc/man/man3/TQDragLeaveEvent.3qt b/doc/man/man3/TQDragLeaveEvent.3qt new file mode 100644 index 000000000..73aa25aae --- /dev/null +++ b/doc/man/man3/TQDragLeaveEvent.3qt @@ -0,0 +1 @@ +.so man3/tqdragleaveevent.3qt diff --git a/doc/man/man3/TQDragMoveEvent.3qt b/doc/man/man3/TQDragMoveEvent.3qt new file mode 100644 index 000000000..d99c00d11 --- /dev/null +++ b/doc/man/man3/TQDragMoveEvent.3qt @@ -0,0 +1 @@ +.so man3/tqdragmoveevent.3qt diff --git a/doc/man/man3/TQDragObject.3qt b/doc/man/man3/TQDragObject.3qt new file mode 100644 index 000000000..bfc3372da --- /dev/null +++ b/doc/man/man3/TQDragObject.3qt @@ -0,0 +1 @@ +.so man3/tqdragobject.3qt diff --git a/doc/man/man3/TQDropEvent.3qt b/doc/man/man3/TQDropEvent.3qt new file mode 100644 index 000000000..ecb47c93e --- /dev/null +++ b/doc/man/man3/TQDropEvent.3qt @@ -0,0 +1 @@ +.so man3/tqdropevent.3qt diff --git a/doc/man/man3/TQEditorFactory.3qt b/doc/man/man3/TQEditorFactory.3qt new file mode 100644 index 000000000..f02298311 --- /dev/null +++ b/doc/man/man3/TQEditorFactory.3qt @@ -0,0 +1 @@ +.so man3/tqeditorfactory.3qt diff --git a/doc/man/man3/TQErrorMessage.3qt b/doc/man/man3/TQErrorMessage.3qt new file mode 100644 index 000000000..73ff26ae7 --- /dev/null +++ b/doc/man/man3/TQErrorMessage.3qt @@ -0,0 +1 @@ +.so man3/tqerrormessage.3qt diff --git a/doc/man/man3/TQEucJpCodec.3qt b/doc/man/man3/TQEucJpCodec.3qt new file mode 100644 index 000000000..20ec87521 --- /dev/null +++ b/doc/man/man3/TQEucJpCodec.3qt @@ -0,0 +1 @@ +.so man3/tqeucjpcodec.3qt diff --git a/doc/man/man3/TQEucKrCodec.3qt b/doc/man/man3/TQEucKrCodec.3qt new file mode 100644 index 000000000..b3a66e2f2 --- /dev/null +++ b/doc/man/man3/TQEucKrCodec.3qt @@ -0,0 +1 @@ +.so man3/tqeuckrcodec.3qt diff --git a/doc/man/man3/TQEvent.3qt b/doc/man/man3/TQEvent.3qt new file mode 100644 index 000000000..df1c28173 --- /dev/null +++ b/doc/man/man3/TQEvent.3qt @@ -0,0 +1 @@ +.so man3/tqevent.3qt diff --git a/doc/man/man3/TQEventLoop.3qt b/doc/man/man3/TQEventLoop.3qt new file mode 100644 index 000000000..2d2e31706 --- /dev/null +++ b/doc/man/man3/TQEventLoop.3qt @@ -0,0 +1 @@ +.so man3/tqeventloop.3qt diff --git a/doc/man/man3/TQFile.3qt b/doc/man/man3/TQFile.3qt new file mode 100644 index 000000000..1d8c340e9 --- /dev/null +++ b/doc/man/man3/TQFile.3qt @@ -0,0 +1 @@ +.so man3/tqfile.3qt diff --git a/doc/man/man3/TQFileDialog.3qt b/doc/man/man3/TQFileDialog.3qt new file mode 100644 index 000000000..112c74f3b --- /dev/null +++ b/doc/man/man3/TQFileDialog.3qt @@ -0,0 +1 @@ +.so man3/tqfiledialog.3qt diff --git a/doc/man/man3/TQFileIconProvider.3qt b/doc/man/man3/TQFileIconProvider.3qt new file mode 100644 index 000000000..df6ac070c --- /dev/null +++ b/doc/man/man3/TQFileIconProvider.3qt @@ -0,0 +1 @@ +.so man3/tqfileiconprovider.3qt diff --git a/doc/man/man3/TQFileInfo.3qt b/doc/man/man3/TQFileInfo.3qt new file mode 100644 index 000000000..3ded0e41f --- /dev/null +++ b/doc/man/man3/TQFileInfo.3qt @@ -0,0 +1 @@ +.so man3/tqfileinfo.3qt diff --git a/doc/man/man3/TQFilePreview.3qt b/doc/man/man3/TQFilePreview.3qt new file mode 100644 index 000000000..8fa51751f --- /dev/null +++ b/doc/man/man3/TQFilePreview.3qt @@ -0,0 +1 @@ +.so man3/tqfilepreview.3qt diff --git a/doc/man/man3/TQFocusData.3qt b/doc/man/man3/TQFocusData.3qt new file mode 100644 index 000000000..601beac66 --- /dev/null +++ b/doc/man/man3/TQFocusData.3qt @@ -0,0 +1 @@ +.so man3/tqfocusdata.3qt diff --git a/doc/man/man3/TQFocusEvent.3qt b/doc/man/man3/TQFocusEvent.3qt new file mode 100644 index 000000000..0af543d45 --- /dev/null +++ b/doc/man/man3/TQFocusEvent.3qt @@ -0,0 +1 @@ +.so man3/tqfocusevent.3qt diff --git a/doc/man/man3/TQFont.3qt b/doc/man/man3/TQFont.3qt new file mode 100644 index 000000000..39bb512d5 --- /dev/null +++ b/doc/man/man3/TQFont.3qt @@ -0,0 +1 @@ +.so man3/tqfont.3qt diff --git a/doc/man/man3/TQFontDatabase.3qt b/doc/man/man3/TQFontDatabase.3qt new file mode 100644 index 000000000..763a5e6fc --- /dev/null +++ b/doc/man/man3/TQFontDatabase.3qt @@ -0,0 +1 @@ +.so man3/tqfontdatabase.3qt diff --git a/doc/man/man3/TQFontDialog.3qt b/doc/man/man3/TQFontDialog.3qt new file mode 100644 index 000000000..0f9b1bd9d --- /dev/null +++ b/doc/man/man3/TQFontDialog.3qt @@ -0,0 +1 @@ +.so man3/tqfontdialog.3qt diff --git a/doc/man/man3/TQFontInfo.3qt b/doc/man/man3/TQFontInfo.3qt new file mode 100644 index 000000000..bbfef65ea --- /dev/null +++ b/doc/man/man3/TQFontInfo.3qt @@ -0,0 +1 @@ +.so man3/tqfontinfo.3qt diff --git a/doc/man/man3/TQFontManager.3qt b/doc/man/man3/TQFontManager.3qt new file mode 100644 index 000000000..5a1600075 --- /dev/null +++ b/doc/man/man3/TQFontManager.3qt @@ -0,0 +1 @@ +.so man3/tqfontmanager.3qt diff --git a/doc/man/man3/TQFontMetrics.3qt b/doc/man/man3/TQFontMetrics.3qt new file mode 100644 index 000000000..1f103409e --- /dev/null +++ b/doc/man/man3/TQFontMetrics.3qt @@ -0,0 +1 @@ +.so man3/tqfontmetrics.3qt diff --git a/doc/man/man3/TQFrame.3qt b/doc/man/man3/TQFrame.3qt new file mode 100644 index 000000000..4949886a5 --- /dev/null +++ b/doc/man/man3/TQFrame.3qt @@ -0,0 +1 @@ +.so man3/tqframe.3qt diff --git a/doc/man/man3/TQFtp.3qt b/doc/man/man3/TQFtp.3qt new file mode 100644 index 000000000..fbb8ee50f --- /dev/null +++ b/doc/man/man3/TQFtp.3qt @@ -0,0 +1 @@ +.so man3/tqftp.3qt diff --git a/doc/man/man3/TQGL.3qt b/doc/man/man3/TQGL.3qt new file mode 100644 index 000000000..022628196 --- /dev/null +++ b/doc/man/man3/TQGL.3qt @@ -0,0 +1 @@ +.so man3/tqgl.3qt diff --git a/doc/man/man3/TQGLColormap.3qt b/doc/man/man3/TQGLColormap.3qt new file mode 100644 index 000000000..b67ad6bb3 --- /dev/null +++ b/doc/man/man3/TQGLColormap.3qt @@ -0,0 +1 @@ +.so man3/tqglcolormap.3qt diff --git a/doc/man/man3/TQGLContext.3qt b/doc/man/man3/TQGLContext.3qt new file mode 100644 index 000000000..e1dba8852 --- /dev/null +++ b/doc/man/man3/TQGLContext.3qt @@ -0,0 +1 @@ +.so man3/tqglcontext.3qt diff --git a/doc/man/man3/TQGLFormat.3qt b/doc/man/man3/TQGLFormat.3qt new file mode 100644 index 000000000..12d928206 --- /dev/null +++ b/doc/man/man3/TQGLFormat.3qt @@ -0,0 +1 @@ +.so man3/tqglformat.3qt diff --git a/doc/man/man3/TQGLWidget.3qt b/doc/man/man3/TQGLWidget.3qt new file mode 100644 index 000000000..0021c20d8 --- /dev/null +++ b/doc/man/man3/TQGLWidget.3qt @@ -0,0 +1 @@ +.so man3/tqglwidget.3qt diff --git a/doc/man/man3/TQGLayoutIterator.3qt b/doc/man/man3/TQGLayoutIterator.3qt new file mode 100644 index 000000000..0edb1354f --- /dev/null +++ b/doc/man/man3/TQGLayoutIterator.3qt @@ -0,0 +1 @@ +.so man3/tqglayoutiterator.3qt diff --git a/doc/man/man3/TQGb18030Codec.3qt b/doc/man/man3/TQGb18030Codec.3qt new file mode 100644 index 000000000..9b04c4b99 --- /dev/null +++ b/doc/man/man3/TQGb18030Codec.3qt @@ -0,0 +1 @@ +.so man3/tqgb18030codec.3qt diff --git a/doc/man/man3/TQGb2312Codec.3qt b/doc/man/man3/TQGb2312Codec.3qt new file mode 100644 index 000000000..3883fd68b --- /dev/null +++ b/doc/man/man3/TQGb2312Codec.3qt @@ -0,0 +1 @@ +.so man3/tqgb2312codec.3qt diff --git a/doc/man/man3/TQGbkCodec.3qt b/doc/man/man3/TQGbkCodec.3qt new file mode 100644 index 000000000..fb7c7557a --- /dev/null +++ b/doc/man/man3/TQGbkCodec.3qt @@ -0,0 +1 @@ +.so man3/tqgbkcodec.3qt diff --git a/doc/man/man3/TQGfxDriverFactory.3qt b/doc/man/man3/TQGfxDriverFactory.3qt new file mode 100644 index 000000000..66037313f --- /dev/null +++ b/doc/man/man3/TQGfxDriverFactory.3qt @@ -0,0 +1 @@ +.so man3/tqgfxdriverfactory.3qt diff --git a/doc/man/man3/TQGfxDriverPlugin.3qt b/doc/man/man3/TQGfxDriverPlugin.3qt new file mode 100644 index 000000000..e3c6632a5 --- /dev/null +++ b/doc/man/man3/TQGfxDriverPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqgfxdriverplugin.3qt diff --git a/doc/man/man3/TQGrid.3qt b/doc/man/man3/TQGrid.3qt new file mode 100644 index 000000000..5f5238e0a --- /dev/null +++ b/doc/man/man3/TQGrid.3qt @@ -0,0 +1 @@ +.so man3/tqgrid.3qt diff --git a/doc/man/man3/TQGridLayout.3qt b/doc/man/man3/TQGridLayout.3qt new file mode 100644 index 000000000..a48d6e5ba --- /dev/null +++ b/doc/man/man3/TQGridLayout.3qt @@ -0,0 +1 @@ +.so man3/tqgridlayout.3qt diff --git a/doc/man/man3/TQGridView.3qt b/doc/man/man3/TQGridView.3qt new file mode 100644 index 000000000..a2dee3db1 --- /dev/null +++ b/doc/man/man3/TQGridView.3qt @@ -0,0 +1 @@ +.so man3/tqgridview.3qt diff --git a/doc/man/man3/TQGroupBox.3qt b/doc/man/man3/TQGroupBox.3qt new file mode 100644 index 000000000..b983a94f7 --- /dev/null +++ b/doc/man/man3/TQGroupBox.3qt @@ -0,0 +1 @@ +.so man3/tqgroupbox.3qt diff --git a/doc/man/man3/TQGuardedPtr.3qt b/doc/man/man3/TQGuardedPtr.3qt new file mode 100644 index 000000000..55bb107ef --- /dev/null +++ b/doc/man/man3/TQGuardedPtr.3qt @@ -0,0 +1 @@ +.so man3/tqguardedptr.3qt diff --git a/doc/man/man3/TQHBox.3qt b/doc/man/man3/TQHBox.3qt new file mode 100644 index 000000000..c1e4b2df2 --- /dev/null +++ b/doc/man/man3/TQHBox.3qt @@ -0,0 +1 @@ +.so man3/tqhbox.3qt diff --git a/doc/man/man3/TQHBoxLayout.3qt b/doc/man/man3/TQHBoxLayout.3qt new file mode 100644 index 000000000..4b6b0a38b --- /dev/null +++ b/doc/man/man3/TQHBoxLayout.3qt @@ -0,0 +1 @@ +.so man3/tqhboxlayout.3qt diff --git a/doc/man/man3/TQHButtonGroup.3qt b/doc/man/man3/TQHButtonGroup.3qt new file mode 100644 index 000000000..fca5ea671 --- /dev/null +++ b/doc/man/man3/TQHButtonGroup.3qt @@ -0,0 +1 @@ +.so man3/tqhbuttongroup.3qt diff --git a/doc/man/man3/TQHGroupBox.3qt b/doc/man/man3/TQHGroupBox.3qt new file mode 100644 index 000000000..f8c92591f --- /dev/null +++ b/doc/man/man3/TQHGroupBox.3qt @@ -0,0 +1 @@ +.so man3/tqhgroupbox.3qt diff --git a/doc/man/man3/TQHeader.3qt b/doc/man/man3/TQHeader.3qt new file mode 100644 index 000000000..56f9fe81a --- /dev/null +++ b/doc/man/man3/TQHeader.3qt @@ -0,0 +1 @@ +.so man3/tqheader.3qt diff --git a/doc/man/man3/TQHebrewCodec.3qt b/doc/man/man3/TQHebrewCodec.3qt new file mode 100644 index 000000000..e375d00c6 --- /dev/null +++ b/doc/man/man3/TQHebrewCodec.3qt @@ -0,0 +1 @@ +.so man3/tqhebrewcodec.3qt diff --git a/doc/man/man3/TQHideEvent.3qt b/doc/man/man3/TQHideEvent.3qt new file mode 100644 index 000000000..5438e5545 --- /dev/null +++ b/doc/man/man3/TQHideEvent.3qt @@ -0,0 +1 @@ +.so man3/tqhideevent.3qt diff --git a/doc/man/man3/TQHostAddress.3qt b/doc/man/man3/TQHostAddress.3qt new file mode 100644 index 000000000..a741c8ad2 --- /dev/null +++ b/doc/man/man3/TQHostAddress.3qt @@ -0,0 +1 @@ +.so man3/tqhostaddress.3qt diff --git a/doc/man/man3/TQHttp.3qt b/doc/man/man3/TQHttp.3qt new file mode 100644 index 000000000..b7719fc72 --- /dev/null +++ b/doc/man/man3/TQHttp.3qt @@ -0,0 +1 @@ +.so man3/tqhttp.3qt diff --git a/doc/man/man3/TQHttpHeader.3qt b/doc/man/man3/TQHttpHeader.3qt new file mode 100644 index 000000000..2861a884f --- /dev/null +++ b/doc/man/man3/TQHttpHeader.3qt @@ -0,0 +1 @@ +.so man3/tqhttpheader.3qt diff --git a/doc/man/man3/TQHttpRequestHeader.3qt b/doc/man/man3/TQHttpRequestHeader.3qt new file mode 100644 index 000000000..8bcd5f8d1 --- /dev/null +++ b/doc/man/man3/TQHttpRequestHeader.3qt @@ -0,0 +1 @@ +.so man3/tqhttprequestheader.3qt diff --git a/doc/man/man3/TQHttpResponseHeader.3qt b/doc/man/man3/TQHttpResponseHeader.3qt new file mode 100644 index 000000000..93e50d353 --- /dev/null +++ b/doc/man/man3/TQHttpResponseHeader.3qt @@ -0,0 +1 @@ +.so man3/tqhttpresponseheader.3qt diff --git a/doc/man/man3/TQIMEvent.3qt b/doc/man/man3/TQIMEvent.3qt new file mode 100644 index 000000000..08255a624 --- /dev/null +++ b/doc/man/man3/TQIMEvent.3qt @@ -0,0 +1 @@ +.so man3/tqimevent.3qt diff --git a/doc/man/man3/TQIODevice.3qt b/doc/man/man3/TQIODevice.3qt new file mode 100644 index 000000000..79fc21a19 --- /dev/null +++ b/doc/man/man3/TQIODevice.3qt @@ -0,0 +1 @@ +.so man3/tqiodevice.3qt diff --git a/doc/man/man3/TQIconDrag.3qt b/doc/man/man3/TQIconDrag.3qt new file mode 100644 index 000000000..fbe5df559 --- /dev/null +++ b/doc/man/man3/TQIconDrag.3qt @@ -0,0 +1 @@ +.so man3/tqicondrag.3qt diff --git a/doc/man/man3/TQIconDragEvent.3qt b/doc/man/man3/TQIconDragEvent.3qt new file mode 100644 index 000000000..de02499c6 --- /dev/null +++ b/doc/man/man3/TQIconDragEvent.3qt @@ -0,0 +1 @@ +.so man3/tqicondragevent.3qt diff --git a/doc/man/man3/TQIconDragItem.3qt b/doc/man/man3/TQIconDragItem.3qt new file mode 100644 index 000000000..55b63ac42 --- /dev/null +++ b/doc/man/man3/TQIconDragItem.3qt @@ -0,0 +1 @@ +.so man3/tqicondragitem.3qt diff --git a/doc/man/man3/TQIconFactory.3qt b/doc/man/man3/TQIconFactory.3qt new file mode 100644 index 000000000..d7fafb2c7 --- /dev/null +++ b/doc/man/man3/TQIconFactory.3qt @@ -0,0 +1 @@ +.so man3/tqiconfactory.3qt diff --git a/doc/man/man3/TQIconSet.3qt b/doc/man/man3/TQIconSet.3qt new file mode 100644 index 000000000..3c7442bf4 --- /dev/null +++ b/doc/man/man3/TQIconSet.3qt @@ -0,0 +1 @@ +.so man3/tqiconset.3qt diff --git a/doc/man/man3/TQIconView.3qt b/doc/man/man3/TQIconView.3qt new file mode 100644 index 000000000..19983ef50 --- /dev/null +++ b/doc/man/man3/TQIconView.3qt @@ -0,0 +1 @@ +.so man3/tqiconview.3qt diff --git a/doc/man/man3/TQIconViewItem.3qt b/doc/man/man3/TQIconViewItem.3qt new file mode 100644 index 000000000..d3a92bc3f --- /dev/null +++ b/doc/man/man3/TQIconViewItem.3qt @@ -0,0 +1 @@ +.so man3/tqiconviewitem.3qt diff --git a/doc/man/man3/TQImage.3qt b/doc/man/man3/TQImage.3qt new file mode 100644 index 000000000..b119a4c2e --- /dev/null +++ b/doc/man/man3/TQImage.3qt @@ -0,0 +1 @@ +.so man3/tqimage.3qt diff --git a/doc/man/man3/TQImageConsumer.3qt b/doc/man/man3/TQImageConsumer.3qt new file mode 100644 index 000000000..bf7c03d34 --- /dev/null +++ b/doc/man/man3/TQImageConsumer.3qt @@ -0,0 +1 @@ +.so man3/tqimageconsumer.3qt diff --git a/doc/man/man3/TQImageDecoder.3qt b/doc/man/man3/TQImageDecoder.3qt new file mode 100644 index 000000000..9b886c9dc --- /dev/null +++ b/doc/man/man3/TQImageDecoder.3qt @@ -0,0 +1 @@ +.so man3/tqimagedecoder.3qt diff --git a/doc/man/man3/TQImageDrag.3qt b/doc/man/man3/TQImageDrag.3qt new file mode 100644 index 000000000..36f229a8c --- /dev/null +++ b/doc/man/man3/TQImageDrag.3qt @@ -0,0 +1 @@ +.so man3/tqimagedrag.3qt diff --git a/doc/man/man3/TQImageFormat.3qt b/doc/man/man3/TQImageFormat.3qt new file mode 100644 index 000000000..bd0a58028 --- /dev/null +++ b/doc/man/man3/TQImageFormat.3qt @@ -0,0 +1 @@ +.so man3/tqimageformat.3qt diff --git a/doc/man/man3/TQImageFormatPlugin.3qt b/doc/man/man3/TQImageFormatPlugin.3qt new file mode 100644 index 000000000..6f45b5058 --- /dev/null +++ b/doc/man/man3/TQImageFormatPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqimageformatplugin.3qt diff --git a/doc/man/man3/TQImageFormatType.3qt b/doc/man/man3/TQImageFormatType.3qt new file mode 100644 index 000000000..6d8078536 --- /dev/null +++ b/doc/man/man3/TQImageFormatType.3qt @@ -0,0 +1 @@ +.so man3/tqimageformattype.3qt diff --git a/doc/man/man3/TQImageIO.3qt b/doc/man/man3/TQImageIO.3qt new file mode 100644 index 000000000..f6d6a38e3 --- /dev/null +++ b/doc/man/man3/TQImageIO.3qt @@ -0,0 +1 @@ +.so man3/tqimageio.3qt diff --git a/doc/man/man3/TQInputDialog.3qt b/doc/man/man3/TQInputDialog.3qt new file mode 100644 index 000000000..d61f34e52 --- /dev/null +++ b/doc/man/man3/TQInputDialog.3qt @@ -0,0 +1 @@ +.so man3/tqinputdialog.3qt diff --git a/doc/man/man3/TQIntCache.3qt b/doc/man/man3/TQIntCache.3qt new file mode 100644 index 000000000..a195edd9a --- /dev/null +++ b/doc/man/man3/TQIntCache.3qt @@ -0,0 +1 @@ +.so man3/tqintcache.3qt diff --git a/doc/man/man3/TQIntCacheIterator.3qt b/doc/man/man3/TQIntCacheIterator.3qt new file mode 100644 index 000000000..ec21be796 --- /dev/null +++ b/doc/man/man3/TQIntCacheIterator.3qt @@ -0,0 +1 @@ +.so man3/tqintcacheiterator.3qt diff --git a/doc/man/man3/TQIntDict.3qt b/doc/man/man3/TQIntDict.3qt new file mode 100644 index 000000000..f91db5415 --- /dev/null +++ b/doc/man/man3/TQIntDict.3qt @@ -0,0 +1 @@ +.so man3/tqintdict.3qt diff --git a/doc/man/man3/TQIntDictIterator.3qt b/doc/man/man3/TQIntDictIterator.3qt new file mode 100644 index 000000000..c86143b1e --- /dev/null +++ b/doc/man/man3/TQIntDictIterator.3qt @@ -0,0 +1 @@ +.so man3/tqintdictiterator.3qt diff --git a/doc/man/man3/TQIntValidator.3qt b/doc/man/man3/TQIntValidator.3qt new file mode 100644 index 000000000..44e6876b4 --- /dev/null +++ b/doc/man/man3/TQIntValidator.3qt @@ -0,0 +1 @@ +.so man3/tqintvalidator.3qt diff --git a/doc/man/man3/TQJisCodec.3qt b/doc/man/man3/TQJisCodec.3qt new file mode 100644 index 000000000..6b6b3378b --- /dev/null +++ b/doc/man/man3/TQJisCodec.3qt @@ -0,0 +1 @@ +.so man3/tqjiscodec.3qt diff --git a/doc/man/man3/TQKbdDriverFactory.3qt b/doc/man/man3/TQKbdDriverFactory.3qt new file mode 100644 index 000000000..5bfd9070a --- /dev/null +++ b/doc/man/man3/TQKbdDriverFactory.3qt @@ -0,0 +1 @@ +.so man3/tqkbddriverfactory.3qt diff --git a/doc/man/man3/TQKbdDriverPlugin.3qt b/doc/man/man3/TQKbdDriverPlugin.3qt new file mode 100644 index 000000000..9ef6172dd --- /dev/null +++ b/doc/man/man3/TQKbdDriverPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqkbddriverplugin.3qt diff --git a/doc/man/man3/TQKeyEvent.3qt b/doc/man/man3/TQKeyEvent.3qt new file mode 100644 index 000000000..a0a9637d7 --- /dev/null +++ b/doc/man/man3/TQKeyEvent.3qt @@ -0,0 +1 @@ +.so man3/tqkeyevent.3qt diff --git a/doc/man/man3/TQKeySequence.3qt b/doc/man/man3/TQKeySequence.3qt new file mode 100644 index 000000000..771b48b29 --- /dev/null +++ b/doc/man/man3/TQKeySequence.3qt @@ -0,0 +1 @@ +.so man3/tqkeysequence.3qt diff --git a/doc/man/man3/TQLCDNumber.3qt b/doc/man/man3/TQLCDNumber.3qt new file mode 100644 index 000000000..9c6ad7266 --- /dev/null +++ b/doc/man/man3/TQLCDNumber.3qt @@ -0,0 +1 @@ +.so man3/tqlcdnumber.3qt diff --git a/doc/man/man3/TQLabel.3qt b/doc/man/man3/TQLabel.3qt new file mode 100644 index 000000000..7e2113bb4 --- /dev/null +++ b/doc/man/man3/TQLabel.3qt @@ -0,0 +1 @@ +.so man3/tqlabel.3qt diff --git a/doc/man/man3/TQLayout.3qt b/doc/man/man3/TQLayout.3qt new file mode 100644 index 000000000..355f23b9a --- /dev/null +++ b/doc/man/man3/TQLayout.3qt @@ -0,0 +1 @@ +.so man3/tqlayout.3qt diff --git a/doc/man/man3/TQLayoutItem.3qt b/doc/man/man3/TQLayoutItem.3qt new file mode 100644 index 000000000..6367b1508 --- /dev/null +++ b/doc/man/man3/TQLayoutItem.3qt @@ -0,0 +1 @@ +.so man3/tqlayoutitem.3qt diff --git a/doc/man/man3/TQLayoutIterator.3qt b/doc/man/man3/TQLayoutIterator.3qt new file mode 100644 index 000000000..69dd7ccac --- /dev/null +++ b/doc/man/man3/TQLayoutIterator.3qt @@ -0,0 +1 @@ +.so man3/tqlayoutiterator.3qt diff --git a/doc/man/man3/TQLibrary.3qt b/doc/man/man3/TQLibrary.3qt new file mode 100644 index 000000000..231be19ff --- /dev/null +++ b/doc/man/man3/TQLibrary.3qt @@ -0,0 +1 @@ +.so man3/tqlibrary.3qt diff --git a/doc/man/man3/TQLineEdit.3qt b/doc/man/man3/TQLineEdit.3qt new file mode 100644 index 000000000..96329afdc --- /dev/null +++ b/doc/man/man3/TQLineEdit.3qt @@ -0,0 +1 @@ +.so man3/tqlineedit.3qt diff --git a/doc/man/man3/TQListBox.3qt b/doc/man/man3/TQListBox.3qt new file mode 100644 index 000000000..688007a9c --- /dev/null +++ b/doc/man/man3/TQListBox.3qt @@ -0,0 +1 @@ +.so man3/tqlistbox.3qt diff --git a/doc/man/man3/TQListBoxItem.3qt b/doc/man/man3/TQListBoxItem.3qt new file mode 100644 index 000000000..81acb59f8 --- /dev/null +++ b/doc/man/man3/TQListBoxItem.3qt @@ -0,0 +1 @@ +.so man3/tqlistboxitem.3qt diff --git a/doc/man/man3/TQListBoxPixmap.3qt b/doc/man/man3/TQListBoxPixmap.3qt new file mode 100644 index 000000000..56e22a944 --- /dev/null +++ b/doc/man/man3/TQListBoxPixmap.3qt @@ -0,0 +1 @@ +.so man3/tqlistboxpixmap.3qt diff --git a/doc/man/man3/TQListBoxText.3qt b/doc/man/man3/TQListBoxText.3qt new file mode 100644 index 000000000..e4178fc5a --- /dev/null +++ b/doc/man/man3/TQListBoxText.3qt @@ -0,0 +1 @@ +.so man3/tqlistboxtext.3qt diff --git a/doc/man/man3/TQListView.3qt b/doc/man/man3/TQListView.3qt new file mode 100644 index 000000000..cf29bb3e6 --- /dev/null +++ b/doc/man/man3/TQListView.3qt @@ -0,0 +1 @@ +.so man3/tqlistview.3qt diff --git a/doc/man/man3/TQListViewItem.3qt b/doc/man/man3/TQListViewItem.3qt new file mode 100644 index 000000000..34b1be39a --- /dev/null +++ b/doc/man/man3/TQListViewItem.3qt @@ -0,0 +1 @@ +.so man3/tqlistviewitem.3qt diff --git a/doc/man/man3/TQListViewItemIterator.3qt b/doc/man/man3/TQListViewItemIterator.3qt new file mode 100644 index 000000000..83532cae2 --- /dev/null +++ b/doc/man/man3/TQListViewItemIterator.3qt @@ -0,0 +1 @@ +.so man3/tqlistviewitemiterator.3qt diff --git a/doc/man/man3/TQLocalFs.3qt b/doc/man/man3/TQLocalFs.3qt new file mode 100644 index 000000000..f93302bdc --- /dev/null +++ b/doc/man/man3/TQLocalFs.3qt @@ -0,0 +1 @@ +.so man3/tqlocalfs.3qt diff --git a/doc/man/man3/TQLocale.3qt b/doc/man/man3/TQLocale.3qt new file mode 100644 index 000000000..19b5001cc --- /dev/null +++ b/doc/man/man3/TQLocale.3qt @@ -0,0 +1 @@ +.so man3/tqlocale.3qt diff --git a/doc/man/man3/TQMacMime.3qt b/doc/man/man3/TQMacMime.3qt new file mode 100644 index 000000000..6ba95f5c7 --- /dev/null +++ b/doc/man/man3/TQMacMime.3qt @@ -0,0 +1 @@ +.so man3/tqmacmime.3qt diff --git a/doc/man/man3/TQMacStyle.3qt b/doc/man/man3/TQMacStyle.3qt new file mode 100644 index 000000000..ffbfe5b16 --- /dev/null +++ b/doc/man/man3/TQMacStyle.3qt @@ -0,0 +1 @@ +.so man3/tqmacstyle.3qt diff --git a/doc/man/man3/TQMainWindow.3qt b/doc/man/man3/TQMainWindow.3qt new file mode 100644 index 000000000..7f3319556 --- /dev/null +++ b/doc/man/man3/TQMainWindow.3qt @@ -0,0 +1 @@ +.so man3/tqmainwindow.3qt diff --git a/doc/man/man3/TQMap.3qt b/doc/man/man3/TQMap.3qt new file mode 100644 index 000000000..25a6d0b97 --- /dev/null +++ b/doc/man/man3/TQMap.3qt @@ -0,0 +1 @@ +.so man3/tqmap.3qt diff --git a/doc/man/man3/TQMapConstIterator.3qt b/doc/man/man3/TQMapConstIterator.3qt new file mode 100644 index 000000000..d7b80ea3b --- /dev/null +++ b/doc/man/man3/TQMapConstIterator.3qt @@ -0,0 +1 @@ +.so man3/tqmapconstiterator.3qt diff --git a/doc/man/man3/TQMapIterator.3qt b/doc/man/man3/TQMapIterator.3qt new file mode 100644 index 000000000..c206efde0 --- /dev/null +++ b/doc/man/man3/TQMapIterator.3qt @@ -0,0 +1 @@ +.so man3/tqmapiterator.3qt diff --git a/doc/man/man3/TQMemArray.3qt b/doc/man/man3/TQMemArray.3qt new file mode 100644 index 000000000..a78c15fef --- /dev/null +++ b/doc/man/man3/TQMemArray.3qt @@ -0,0 +1 @@ +.so man3/tqmemarray.3qt diff --git a/doc/man/man3/TQMenuBar.3qt b/doc/man/man3/TQMenuBar.3qt new file mode 100644 index 000000000..7ba44c9bf --- /dev/null +++ b/doc/man/man3/TQMenuBar.3qt @@ -0,0 +1 @@ +.so man3/tqmenubar.3qt diff --git a/doc/man/man3/TQMenuData.3qt b/doc/man/man3/TQMenuData.3qt new file mode 100644 index 000000000..408d44c89 --- /dev/null +++ b/doc/man/man3/TQMenuData.3qt @@ -0,0 +1 @@ +.so man3/tqmenudata.3qt diff --git a/doc/man/man3/TQMessageBox.3qt b/doc/man/man3/TQMessageBox.3qt new file mode 100644 index 000000000..c75da0079 --- /dev/null +++ b/doc/man/man3/TQMessageBox.3qt @@ -0,0 +1 @@ +.so man3/tqmessagebox.3qt diff --git a/doc/man/man3/TQMetaObject.3qt b/doc/man/man3/TQMetaObject.3qt new file mode 100644 index 000000000..e46b1d280 --- /dev/null +++ b/doc/man/man3/TQMetaObject.3qt @@ -0,0 +1 @@ +.so man3/tqmetaobject.3qt diff --git a/doc/man/man3/TQMetaProperty.3qt b/doc/man/man3/TQMetaProperty.3qt new file mode 100644 index 000000000..afe62eaa8 --- /dev/null +++ b/doc/man/man3/TQMetaProperty.3qt @@ -0,0 +1 @@ +.so man3/tqmetaproperty.3qt diff --git a/doc/man/man3/TQMimeSource.3qt b/doc/man/man3/TQMimeSource.3qt new file mode 100644 index 000000000..b33669a6d --- /dev/null +++ b/doc/man/man3/TQMimeSource.3qt @@ -0,0 +1 @@ +.so man3/tqmimesource.3qt diff --git a/doc/man/man3/TQMimeSourceFactory.3qt b/doc/man/man3/TQMimeSourceFactory.3qt new file mode 100644 index 000000000..2c6bf772d --- /dev/null +++ b/doc/man/man3/TQMimeSourceFactory.3qt @@ -0,0 +1 @@ +.so man3/tqmimesourcefactory.3qt diff --git a/doc/man/man3/TQMotif.3qt b/doc/man/man3/TQMotif.3qt new file mode 100644 index 000000000..65b5244eb --- /dev/null +++ b/doc/man/man3/TQMotif.3qt @@ -0,0 +1 @@ +.so man3/tqmotif.3qt diff --git a/doc/man/man3/TQMotifDialog.3qt b/doc/man/man3/TQMotifDialog.3qt new file mode 100644 index 000000000..b0c0e8e85 --- /dev/null +++ b/doc/man/man3/TQMotifDialog.3qt @@ -0,0 +1 @@ +.so man3/tqmotifdialog.3qt diff --git a/doc/man/man3/TQMotifPlusStyle.3qt b/doc/man/man3/TQMotifPlusStyle.3qt new file mode 100644 index 000000000..8a5e55a14 --- /dev/null +++ b/doc/man/man3/TQMotifPlusStyle.3qt @@ -0,0 +1 @@ +.so man3/tqmotifplusstyle.3qt diff --git a/doc/man/man3/TQMotifStyle.3qt b/doc/man/man3/TQMotifStyle.3qt new file mode 100644 index 000000000..57b5a1d46 --- /dev/null +++ b/doc/man/man3/TQMotifStyle.3qt @@ -0,0 +1 @@ +.so man3/tqmotifstyle.3qt diff --git a/doc/man/man3/TQMotifWidget.3qt b/doc/man/man3/TQMotifWidget.3qt new file mode 100644 index 000000000..bcb90c72a --- /dev/null +++ b/doc/man/man3/TQMotifWidget.3qt @@ -0,0 +1 @@ +.so man3/tqmotifwidget.3qt diff --git a/doc/man/man3/TQMouseDriverFactory.3qt b/doc/man/man3/TQMouseDriverFactory.3qt new file mode 100644 index 000000000..1ed894f0a --- /dev/null +++ b/doc/man/man3/TQMouseDriverFactory.3qt @@ -0,0 +1 @@ +.so man3/tqmousedriverfactory.3qt diff --git a/doc/man/man3/TQMouseDriverPlugin.3qt b/doc/man/man3/TQMouseDriverPlugin.3qt new file mode 100644 index 000000000..a6b0d69c3 --- /dev/null +++ b/doc/man/man3/TQMouseDriverPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqmousedriverplugin.3qt diff --git a/doc/man/man3/TQMouseEvent.3qt b/doc/man/man3/TQMouseEvent.3qt new file mode 100644 index 000000000..169153cad --- /dev/null +++ b/doc/man/man3/TQMouseEvent.3qt @@ -0,0 +1 @@ +.so man3/tqmouseevent.3qt diff --git a/doc/man/man3/TQMoveEvent.3qt b/doc/man/man3/TQMoveEvent.3qt new file mode 100644 index 000000000..5d678d8ca --- /dev/null +++ b/doc/man/man3/TQMoveEvent.3qt @@ -0,0 +1 @@ +.so man3/tqmoveevent.3qt diff --git a/doc/man/man3/TQMovie.3qt b/doc/man/man3/TQMovie.3qt new file mode 100644 index 000000000..f34d5e1a5 --- /dev/null +++ b/doc/man/man3/TQMovie.3qt @@ -0,0 +1 @@ +.so man3/tqmovie.3qt diff --git a/doc/man/man3/TQMutex.3qt b/doc/man/man3/TQMutex.3qt new file mode 100644 index 000000000..0dcef4441 --- /dev/null +++ b/doc/man/man3/TQMutex.3qt @@ -0,0 +1 @@ +.so man3/tqmutex.3qt diff --git a/doc/man/man3/TQMutexLocker.3qt b/doc/man/man3/TQMutexLocker.3qt new file mode 100644 index 000000000..7f0a38637 --- /dev/null +++ b/doc/man/man3/TQMutexLocker.3qt @@ -0,0 +1 @@ +.so man3/tqmutexlocker.3qt diff --git a/doc/man/man3/TQNPInstance.3qt b/doc/man/man3/TQNPInstance.3qt new file mode 100644 index 000000000..335a56d0e --- /dev/null +++ b/doc/man/man3/TQNPInstance.3qt @@ -0,0 +1 @@ +.so man3/tqnpinstance.3qt diff --git a/doc/man/man3/TQNPStream.3qt b/doc/man/man3/TQNPStream.3qt new file mode 100644 index 000000000..4f347ce8b --- /dev/null +++ b/doc/man/man3/TQNPStream.3qt @@ -0,0 +1 @@ +.so man3/tqnpstream.3qt diff --git a/doc/man/man3/TQNPWidget.3qt b/doc/man/man3/TQNPWidget.3qt new file mode 100644 index 000000000..abcb7e5db --- /dev/null +++ b/doc/man/man3/TQNPWidget.3qt @@ -0,0 +1 @@ +.so man3/tqnpwidget.3qt diff --git a/doc/man/man3/TQNPlugin.3qt b/doc/man/man3/TQNPlugin.3qt new file mode 100644 index 000000000..7b7c90bd1 --- /dev/null +++ b/doc/man/man3/TQNPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqnplugin.3qt diff --git a/doc/man/man3/TQNetworkOperation.3qt b/doc/man/man3/TQNetworkOperation.3qt new file mode 100644 index 000000000..6187e390d --- /dev/null +++ b/doc/man/man3/TQNetworkOperation.3qt @@ -0,0 +1 @@ +.so man3/tqnetworkoperation.3qt diff --git a/doc/man/man3/TQNetworkProtocol.3qt b/doc/man/man3/TQNetworkProtocol.3qt new file mode 100644 index 000000000..561524c47 --- /dev/null +++ b/doc/man/man3/TQNetworkProtocol.3qt @@ -0,0 +1 @@ +.so man3/tqnetworkprotocol.3qt diff --git a/doc/man/man3/TQObject.3qt b/doc/man/man3/TQObject.3qt new file mode 100644 index 000000000..2823edbb0 --- /dev/null +++ b/doc/man/man3/TQObject.3qt @@ -0,0 +1 @@ +.so man3/tqobject.3qt diff --git a/doc/man/man3/TQObjectCleanupHandler.3qt b/doc/man/man3/TQObjectCleanupHandler.3qt new file mode 100644 index 000000000..de2bc5dc4 --- /dev/null +++ b/doc/man/man3/TQObjectCleanupHandler.3qt @@ -0,0 +1 @@ +.so man3/tqobjectcleanuphandler.3qt diff --git a/doc/man/man3/TQObjectList.3qt b/doc/man/man3/TQObjectList.3qt new file mode 100644 index 000000000..3704b98fa --- /dev/null +++ b/doc/man/man3/TQObjectList.3qt @@ -0,0 +1 @@ +.so man3/tqobjectlist.3qt diff --git a/doc/man/man3/TQObjectListIterator.3qt b/doc/man/man3/TQObjectListIterator.3qt new file mode 100644 index 000000000..8c9b64123 --- /dev/null +++ b/doc/man/man3/TQObjectListIterator.3qt @@ -0,0 +1 @@ +.so man3/tqobjectlistiterator.3qt diff --git a/doc/man/man3/TQPNGImagePacker.3qt b/doc/man/man3/TQPNGImagePacker.3qt new file mode 100644 index 000000000..90a73f652 --- /dev/null +++ b/doc/man/man3/TQPNGImagePacker.3qt @@ -0,0 +1 @@ +.so man3/tqpngimagepacker.3qt diff --git a/doc/man/man3/TQPaintDevice.3qt b/doc/man/man3/TQPaintDevice.3qt new file mode 100644 index 000000000..16a947739 --- /dev/null +++ b/doc/man/man3/TQPaintDevice.3qt @@ -0,0 +1 @@ +.so man3/tqpaintdevice.3qt diff --git a/doc/man/man3/TQPaintDeviceMetrics.3qt b/doc/man/man3/TQPaintDeviceMetrics.3qt new file mode 100644 index 000000000..c94ba939d --- /dev/null +++ b/doc/man/man3/TQPaintDeviceMetrics.3qt @@ -0,0 +1 @@ +.so man3/tqpaintdevicemetrics.3qt diff --git a/doc/man/man3/TQPaintEvent.3qt b/doc/man/man3/TQPaintEvent.3qt new file mode 100644 index 000000000..d887ecc4e --- /dev/null +++ b/doc/man/man3/TQPaintEvent.3qt @@ -0,0 +1 @@ +.so man3/tqpaintevent.3qt diff --git a/doc/man/man3/TQPainter.3qt b/doc/man/man3/TQPainter.3qt new file mode 100644 index 000000000..33d7d11f8 --- /dev/null +++ b/doc/man/man3/TQPainter.3qt @@ -0,0 +1 @@ +.so man3/tqpainter.3qt diff --git a/doc/man/man3/TQPair.3qt b/doc/man/man3/TQPair.3qt new file mode 100644 index 000000000..f6df007f0 --- /dev/null +++ b/doc/man/man3/TQPair.3qt @@ -0,0 +1 @@ +.so man3/tqpair.3qt diff --git a/doc/man/man3/TQPalette.3qt b/doc/man/man3/TQPalette.3qt new file mode 100644 index 000000000..71ff3f632 --- /dev/null +++ b/doc/man/man3/TQPalette.3qt @@ -0,0 +1 @@ +.so man3/tqpalette.3qt diff --git a/doc/man/man3/TQPen.3qt b/doc/man/man3/TQPen.3qt new file mode 100644 index 000000000..6fe4f6d4e --- /dev/null +++ b/doc/man/man3/TQPen.3qt @@ -0,0 +1 @@ +.so man3/tqpen.3qt diff --git a/doc/man/man3/TQPicture.3qt b/doc/man/man3/TQPicture.3qt new file mode 100644 index 000000000..cd20153d1 --- /dev/null +++ b/doc/man/man3/TQPicture.3qt @@ -0,0 +1 @@ +.so man3/tqpicture.3qt diff --git a/doc/man/man3/TQPixmap.3qt b/doc/man/man3/TQPixmap.3qt new file mode 100644 index 000000000..d4e2fc357 --- /dev/null +++ b/doc/man/man3/TQPixmap.3qt @@ -0,0 +1 @@ +.so man3/tqpixmap.3qt diff --git a/doc/man/man3/TQPixmapCache.3qt b/doc/man/man3/TQPixmapCache.3qt new file mode 100644 index 000000000..69307ccf4 --- /dev/null +++ b/doc/man/man3/TQPixmapCache.3qt @@ -0,0 +1 @@ +.so man3/tqpixmapcache.3qt diff --git a/doc/man/man3/TQPlatinumStyle.3qt b/doc/man/man3/TQPlatinumStyle.3qt new file mode 100644 index 000000000..fd9040bd8 --- /dev/null +++ b/doc/man/man3/TQPlatinumStyle.3qt @@ -0,0 +1 @@ +.so man3/tqplatinumstyle.3qt diff --git a/doc/man/man3/TQPoint.3qt b/doc/man/man3/TQPoint.3qt new file mode 100644 index 000000000..25802b17e --- /dev/null +++ b/doc/man/man3/TQPoint.3qt @@ -0,0 +1 @@ +.so man3/tqpoint.3qt diff --git a/doc/man/man3/TQPointArray.3qt b/doc/man/man3/TQPointArray.3qt new file mode 100644 index 000000000..51be3c6bd --- /dev/null +++ b/doc/man/man3/TQPointArray.3qt @@ -0,0 +1 @@ +.so man3/tqpointarray.3qt diff --git a/doc/man/man3/TQPopupMenu.3qt b/doc/man/man3/TQPopupMenu.3qt new file mode 100644 index 000000000..db6778600 --- /dev/null +++ b/doc/man/man3/TQPopupMenu.3qt @@ -0,0 +1 @@ +.so man3/tqpopupmenu.3qt diff --git a/doc/man/man3/TQPrinter.3qt b/doc/man/man3/TQPrinter.3qt new file mode 100644 index 000000000..5ed2dfaa1 --- /dev/null +++ b/doc/man/man3/TQPrinter.3qt @@ -0,0 +1 @@ +.so man3/tqprinter.3qt diff --git a/doc/man/man3/TQProcess.3qt b/doc/man/man3/TQProcess.3qt new file mode 100644 index 000000000..cd5ccfdcc --- /dev/null +++ b/doc/man/man3/TQProcess.3qt @@ -0,0 +1 @@ +.so man3/tqprocess.3qt diff --git a/doc/man/man3/TQProgressBar.3qt b/doc/man/man3/TQProgressBar.3qt new file mode 100644 index 000000000..fa3e1cf77 --- /dev/null +++ b/doc/man/man3/TQProgressBar.3qt @@ -0,0 +1 @@ +.so man3/tqprogressbar.3qt diff --git a/doc/man/man3/TQProgressDialog.3qt b/doc/man/man3/TQProgressDialog.3qt new file mode 100644 index 000000000..73528555a --- /dev/null +++ b/doc/man/man3/TQProgressDialog.3qt @@ -0,0 +1 @@ +.so man3/tqprogressdialog.3qt diff --git a/doc/man/man3/TQPtrCollection.3qt b/doc/man/man3/TQPtrCollection.3qt new file mode 100644 index 000000000..acf4470bd --- /dev/null +++ b/doc/man/man3/TQPtrCollection.3qt @@ -0,0 +1 @@ +.so man3/tqptrcollection.3qt diff --git a/doc/man/man3/TQPtrDict.3qt b/doc/man/man3/TQPtrDict.3qt new file mode 100644 index 000000000..8f7614749 --- /dev/null +++ b/doc/man/man3/TQPtrDict.3qt @@ -0,0 +1 @@ +.so man3/tqptrdict.3qt diff --git a/doc/man/man3/TQPtrDictIterator.3qt b/doc/man/man3/TQPtrDictIterator.3qt new file mode 100644 index 000000000..0f3cfccd7 --- /dev/null +++ b/doc/man/man3/TQPtrDictIterator.3qt @@ -0,0 +1 @@ +.so man3/tqptrdictiterator.3qt diff --git a/doc/man/man3/TQPtrList.3qt b/doc/man/man3/TQPtrList.3qt new file mode 100644 index 000000000..6bf51ec54 --- /dev/null +++ b/doc/man/man3/TQPtrList.3qt @@ -0,0 +1 @@ +.so man3/tqptrlist.3qt diff --git a/doc/man/man3/TQPtrListIterator.3qt b/doc/man/man3/TQPtrListIterator.3qt new file mode 100644 index 000000000..a99953d1d --- /dev/null +++ b/doc/man/man3/TQPtrListIterator.3qt @@ -0,0 +1 @@ +.so man3/tqptrlistiterator.3qt diff --git a/doc/man/man3/TQPtrQueue.3qt b/doc/man/man3/TQPtrQueue.3qt new file mode 100644 index 000000000..70b785929 --- /dev/null +++ b/doc/man/man3/TQPtrQueue.3qt @@ -0,0 +1 @@ +.so man3/tqptrqueue.3qt diff --git a/doc/man/man3/TQPtrStack.3qt b/doc/man/man3/TQPtrStack.3qt new file mode 100644 index 000000000..d57291e13 --- /dev/null +++ b/doc/man/man3/TQPtrStack.3qt @@ -0,0 +1 @@ +.so man3/tqptrstack.3qt diff --git a/doc/man/man3/TQPtrVector.3qt b/doc/man/man3/TQPtrVector.3qt new file mode 100644 index 000000000..007ded4f2 --- /dev/null +++ b/doc/man/man3/TQPtrVector.3qt @@ -0,0 +1 @@ +.so man3/tqptrvector.3qt diff --git a/doc/man/man3/TQPushButton.3qt b/doc/man/man3/TQPushButton.3qt new file mode 100644 index 000000000..a4255140f --- /dev/null +++ b/doc/man/man3/TQPushButton.3qt @@ -0,0 +1 @@ +.so man3/tqpushbutton.3qt diff --git a/doc/man/man3/TQRadioButton.3qt b/doc/man/man3/TQRadioButton.3qt new file mode 100644 index 000000000..653603ce6 --- /dev/null +++ b/doc/man/man3/TQRadioButton.3qt @@ -0,0 +1 @@ +.so man3/tqradiobutton.3qt diff --git a/doc/man/man3/TQRangeControl.3qt b/doc/man/man3/TQRangeControl.3qt new file mode 100644 index 000000000..289481edd --- /dev/null +++ b/doc/man/man3/TQRangeControl.3qt @@ -0,0 +1 @@ +.so man3/tqrangecontrol.3qt diff --git a/doc/man/man3/TQRect.3qt b/doc/man/man3/TQRect.3qt new file mode 100644 index 000000000..602f16f25 --- /dev/null +++ b/doc/man/man3/TQRect.3qt @@ -0,0 +1 @@ +.so man3/tqrect.3qt diff --git a/doc/man/man3/TQRegExp.3qt b/doc/man/man3/TQRegExp.3qt new file mode 100644 index 000000000..25b12d595 --- /dev/null +++ b/doc/man/man3/TQRegExp.3qt @@ -0,0 +1 @@ +.so man3/tqregexp.3qt diff --git a/doc/man/man3/TQRegExpValidator.3qt b/doc/man/man3/TQRegExpValidator.3qt new file mode 100644 index 000000000..d2362a16d --- /dev/null +++ b/doc/man/man3/TQRegExpValidator.3qt @@ -0,0 +1 @@ +.so man3/tqregexpvalidator.3qt diff --git a/doc/man/man3/TQRegion.3qt b/doc/man/man3/TQRegion.3qt new file mode 100644 index 000000000..53bed4dd6 --- /dev/null +++ b/doc/man/man3/TQRegion.3qt @@ -0,0 +1 @@ +.so man3/tqregion.3qt diff --git a/doc/man/man3/TQResizeEvent.3qt b/doc/man/man3/TQResizeEvent.3qt new file mode 100644 index 000000000..dcff4abeb --- /dev/null +++ b/doc/man/man3/TQResizeEvent.3qt @@ -0,0 +1 @@ +.so man3/tqresizeevent.3qt diff --git a/doc/man/man3/TQSGIStyle.3qt b/doc/man/man3/TQSGIStyle.3qt new file mode 100644 index 000000000..fbf1bed70 --- /dev/null +++ b/doc/man/man3/TQSGIStyle.3qt @@ -0,0 +1 @@ +.so man3/tqsgistyle.3qt diff --git a/doc/man/man3/TQScreen.3qt b/doc/man/man3/TQScreen.3qt new file mode 100644 index 000000000..67ba13a80 --- /dev/null +++ b/doc/man/man3/TQScreen.3qt @@ -0,0 +1 @@ +.so man3/tqscreen.3qt diff --git a/doc/man/man3/TQScrollBar.3qt b/doc/man/man3/TQScrollBar.3qt new file mode 100644 index 000000000..c38d7fbcb --- /dev/null +++ b/doc/man/man3/TQScrollBar.3qt @@ -0,0 +1 @@ +.so man3/tqscrollbar.3qt diff --git a/doc/man/man3/TQScrollView.3qt b/doc/man/man3/TQScrollView.3qt new file mode 100644 index 000000000..861165067 --- /dev/null +++ b/doc/man/man3/TQScrollView.3qt @@ -0,0 +1 @@ +.so man3/tqscrollview.3qt diff --git a/doc/man/man3/TQSemaphore.3qt b/doc/man/man3/TQSemaphore.3qt new file mode 100644 index 000000000..77f78318f --- /dev/null +++ b/doc/man/man3/TQSemaphore.3qt @@ -0,0 +1 @@ +.so man3/tqsemaphore.3qt diff --git a/doc/man/man3/TQServerSocket.3qt b/doc/man/man3/TQServerSocket.3qt new file mode 100644 index 000000000..ebce2ff5b --- /dev/null +++ b/doc/man/man3/TQServerSocket.3qt @@ -0,0 +1 @@ +.so man3/tqserversocket.3qt diff --git a/doc/man/man3/TQSessionManager.3qt b/doc/man/man3/TQSessionManager.3qt new file mode 100644 index 000000000..e4d190c3b --- /dev/null +++ b/doc/man/man3/TQSessionManager.3qt @@ -0,0 +1 @@ +.so man3/tqsessionmanager.3qt diff --git a/doc/man/man3/TQSettings.3qt b/doc/man/man3/TQSettings.3qt new file mode 100644 index 000000000..607bf9642 --- /dev/null +++ b/doc/man/man3/TQSettings.3qt @@ -0,0 +1 @@ +.so man3/tqsettings.3qt diff --git a/doc/man/man3/TQShowEvent.3qt b/doc/man/man3/TQShowEvent.3qt new file mode 100644 index 000000000..8b499103d --- /dev/null +++ b/doc/man/man3/TQShowEvent.3qt @@ -0,0 +1 @@ +.so man3/tqshowevent.3qt diff --git a/doc/man/man3/TQSignal.3qt b/doc/man/man3/TQSignal.3qt new file mode 100644 index 000000000..12f975ebd --- /dev/null +++ b/doc/man/man3/TQSignal.3qt @@ -0,0 +1 @@ +.so man3/tqsignal.3qt diff --git a/doc/man/man3/TQSignalMapper.3qt b/doc/man/man3/TQSignalMapper.3qt new file mode 100644 index 000000000..f2d688865 --- /dev/null +++ b/doc/man/man3/TQSignalMapper.3qt @@ -0,0 +1 @@ +.so man3/tqsignalmapper.3qt diff --git a/doc/man/man3/TQSimpleRichText.3qt b/doc/man/man3/TQSimpleRichText.3qt new file mode 100644 index 000000000..853895b15 --- /dev/null +++ b/doc/man/man3/TQSimpleRichText.3qt @@ -0,0 +1 @@ +.so man3/tqsimplerichtext.3qt diff --git a/doc/man/man3/TQSize.3qt b/doc/man/man3/TQSize.3qt new file mode 100644 index 000000000..4ee75fe01 --- /dev/null +++ b/doc/man/man3/TQSize.3qt @@ -0,0 +1 @@ +.so man3/tqsize.3qt diff --git a/doc/man/man3/TQSizeGrip.3qt b/doc/man/man3/TQSizeGrip.3qt new file mode 100644 index 000000000..310c137a7 --- /dev/null +++ b/doc/man/man3/TQSizeGrip.3qt @@ -0,0 +1 @@ +.so man3/tqsizegrip.3qt diff --git a/doc/man/man3/TQSizePolicy.3qt b/doc/man/man3/TQSizePolicy.3qt new file mode 100644 index 000000000..809c1945a --- /dev/null +++ b/doc/man/man3/TQSizePolicy.3qt @@ -0,0 +1 @@ +.so man3/tqsizepolicy.3qt diff --git a/doc/man/man3/TQSjisCodec.3qt b/doc/man/man3/TQSjisCodec.3qt new file mode 100644 index 000000000..11e6268f6 --- /dev/null +++ b/doc/man/man3/TQSjisCodec.3qt @@ -0,0 +1 @@ +.so man3/tqsjiscodec.3qt diff --git a/doc/man/man3/TQSlider.3qt b/doc/man/man3/TQSlider.3qt new file mode 100644 index 000000000..71133a794 --- /dev/null +++ b/doc/man/man3/TQSlider.3qt @@ -0,0 +1 @@ +.so man3/tqslider.3qt diff --git a/doc/man/man3/TQSocket.3qt b/doc/man/man3/TQSocket.3qt new file mode 100644 index 000000000..f019953c6 --- /dev/null +++ b/doc/man/man3/TQSocket.3qt @@ -0,0 +1 @@ +.so man3/tqsocket.3qt diff --git a/doc/man/man3/TQSocketDevice.3qt b/doc/man/man3/TQSocketDevice.3qt new file mode 100644 index 000000000..f3f36b05f --- /dev/null +++ b/doc/man/man3/TQSocketDevice.3qt @@ -0,0 +1 @@ +.so man3/tqsocketdevice.3qt diff --git a/doc/man/man3/TQSocketNotifier.3qt b/doc/man/man3/TQSocketNotifier.3qt new file mode 100644 index 000000000..ad0f5db4f --- /dev/null +++ b/doc/man/man3/TQSocketNotifier.3qt @@ -0,0 +1 @@ +.so man3/tqsocketnotifier.3qt diff --git a/doc/man/man3/TQSound.3qt b/doc/man/man3/TQSound.3qt new file mode 100644 index 000000000..bdf0b1e3b --- /dev/null +++ b/doc/man/man3/TQSound.3qt @@ -0,0 +1 @@ +.so man3/tqsound.3qt diff --git a/doc/man/man3/TQSpacerItem.3qt b/doc/man/man3/TQSpacerItem.3qt new file mode 100644 index 000000000..4e20047cc --- /dev/null +++ b/doc/man/man3/TQSpacerItem.3qt @@ -0,0 +1 @@ +.so man3/tqspaceritem.3qt diff --git a/doc/man/man3/TQSpinBox.3qt b/doc/man/man3/TQSpinBox.3qt new file mode 100644 index 000000000..9cc6bf40e --- /dev/null +++ b/doc/man/man3/TQSpinBox.3qt @@ -0,0 +1 @@ +.so man3/tqspinbox.3qt diff --git a/doc/man/man3/TQSplashScreen.3qt b/doc/man/man3/TQSplashScreen.3qt new file mode 100644 index 000000000..fcc0dd8ee --- /dev/null +++ b/doc/man/man3/TQSplashScreen.3qt @@ -0,0 +1 @@ +.so man3/tqsplashscreen.3qt diff --git a/doc/man/man3/TQSplitter.3qt b/doc/man/man3/TQSplitter.3qt new file mode 100644 index 000000000..a613dc758 --- /dev/null +++ b/doc/man/man3/TQSplitter.3qt @@ -0,0 +1 @@ +.so man3/tqsplitter.3qt diff --git a/doc/man/man3/TQSql.3qt b/doc/man/man3/TQSql.3qt new file mode 100644 index 000000000..2500cbc13 --- /dev/null +++ b/doc/man/man3/TQSql.3qt @@ -0,0 +1 @@ +.so man3/tqsql.3qt diff --git a/doc/man/man3/TQSqlCursor.3qt b/doc/man/man3/TQSqlCursor.3qt new file mode 100644 index 000000000..f171d986d --- /dev/null +++ b/doc/man/man3/TQSqlCursor.3qt @@ -0,0 +1 @@ +.so man3/tqsqlcursor.3qt diff --git a/doc/man/man3/TQSqlDatabase.3qt b/doc/man/man3/TQSqlDatabase.3qt new file mode 100644 index 000000000..d4873b84c --- /dev/null +++ b/doc/man/man3/TQSqlDatabase.3qt @@ -0,0 +1 @@ +.so man3/tqsqldatabase.3qt diff --git a/doc/man/man3/TQSqlDriver.3qt b/doc/man/man3/TQSqlDriver.3qt new file mode 100644 index 000000000..cdf1c5dd2 --- /dev/null +++ b/doc/man/man3/TQSqlDriver.3qt @@ -0,0 +1 @@ +.so man3/tqsqldriver.3qt diff --git a/doc/man/man3/TQSqlDriverPlugin.3qt b/doc/man/man3/TQSqlDriverPlugin.3qt new file mode 100644 index 000000000..9f0a48b09 --- /dev/null +++ b/doc/man/man3/TQSqlDriverPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqsqldriverplugin.3qt diff --git a/doc/man/man3/TQSqlEditorFactory.3qt b/doc/man/man3/TQSqlEditorFactory.3qt new file mode 100644 index 000000000..c30106ed8 --- /dev/null +++ b/doc/man/man3/TQSqlEditorFactory.3qt @@ -0,0 +1 @@ +.so man3/tqsqleditorfactory.3qt diff --git a/doc/man/man3/TQSqlError.3qt b/doc/man/man3/TQSqlError.3qt new file mode 100644 index 000000000..94559f4a2 --- /dev/null +++ b/doc/man/man3/TQSqlError.3qt @@ -0,0 +1 @@ +.so man3/tqsqlerror.3qt diff --git a/doc/man/man3/TQSqlField.3qt b/doc/man/man3/TQSqlField.3qt new file mode 100644 index 000000000..a90dcc26f --- /dev/null +++ b/doc/man/man3/TQSqlField.3qt @@ -0,0 +1 @@ +.so man3/tqsqlfield.3qt diff --git a/doc/man/man3/TQSqlFieldInfo.3qt b/doc/man/man3/TQSqlFieldInfo.3qt new file mode 100644 index 000000000..a86d568d9 --- /dev/null +++ b/doc/man/man3/TQSqlFieldInfo.3qt @@ -0,0 +1 @@ +.so man3/tqsqlfieldinfo.3qt diff --git a/doc/man/man3/TQSqlForm.3qt b/doc/man/man3/TQSqlForm.3qt new file mode 100644 index 000000000..22dfc2da7 --- /dev/null +++ b/doc/man/man3/TQSqlForm.3qt @@ -0,0 +1 @@ +.so man3/tqsqlform.3qt diff --git a/doc/man/man3/TQSqlIndex.3qt b/doc/man/man3/TQSqlIndex.3qt new file mode 100644 index 000000000..6ec435347 --- /dev/null +++ b/doc/man/man3/TQSqlIndex.3qt @@ -0,0 +1 @@ +.so man3/tqsqlindex.3qt diff --git a/doc/man/man3/TQSqlPropertyMap.3qt b/doc/man/man3/TQSqlPropertyMap.3qt new file mode 100644 index 000000000..668eb299b --- /dev/null +++ b/doc/man/man3/TQSqlPropertyMap.3qt @@ -0,0 +1 @@ +.so man3/tqsqlpropertymap.3qt diff --git a/doc/man/man3/TQSqlQuery.3qt b/doc/man/man3/TQSqlQuery.3qt new file mode 100644 index 000000000..a9d66df56 --- /dev/null +++ b/doc/man/man3/TQSqlQuery.3qt @@ -0,0 +1 @@ +.so man3/tqsqlquery.3qt diff --git a/doc/man/man3/TQSqlRecord.3qt b/doc/man/man3/TQSqlRecord.3qt new file mode 100644 index 000000000..fbb203817 --- /dev/null +++ b/doc/man/man3/TQSqlRecord.3qt @@ -0,0 +1 @@ +.so man3/tqsqlrecord.3qt diff --git a/doc/man/man3/TQSqlRecordInfo.3qt b/doc/man/man3/TQSqlRecordInfo.3qt new file mode 100644 index 000000000..47c38d2e2 --- /dev/null +++ b/doc/man/man3/TQSqlRecordInfo.3qt @@ -0,0 +1 @@ +.so man3/tqsqlrecordinfo.3qt diff --git a/doc/man/man3/TQSqlResult.3qt b/doc/man/man3/TQSqlResult.3qt new file mode 100644 index 000000000..345a534b7 --- /dev/null +++ b/doc/man/man3/TQSqlResult.3qt @@ -0,0 +1 @@ +.so man3/tqsqlresult.3qt diff --git a/doc/man/man3/TQSqlSelectCursor.3qt b/doc/man/man3/TQSqlSelectCursor.3qt new file mode 100644 index 000000000..3824c0a06 --- /dev/null +++ b/doc/man/man3/TQSqlSelectCursor.3qt @@ -0,0 +1 @@ +.so man3/tqsqlselectcursor.3qt diff --git a/doc/man/man3/TQStatusBar.3qt b/doc/man/man3/TQStatusBar.3qt new file mode 100644 index 000000000..bba8f3c98 --- /dev/null +++ b/doc/man/man3/TQStatusBar.3qt @@ -0,0 +1 @@ +.so man3/tqstatusbar.3qt diff --git a/doc/man/man3/TQStoredDrag.3qt b/doc/man/man3/TQStoredDrag.3qt new file mode 100644 index 000000000..7b005117a --- /dev/null +++ b/doc/man/man3/TQStoredDrag.3qt @@ -0,0 +1 @@ +.so man3/tqstoreddrag.3qt diff --git a/doc/man/man3/TQStrIList.3qt b/doc/man/man3/TQStrIList.3qt new file mode 100644 index 000000000..8534a882e --- /dev/null +++ b/doc/man/man3/TQStrIList.3qt @@ -0,0 +1 @@ +.so man3/tqstrilist.3qt diff --git a/doc/man/man3/TQStrList.3qt b/doc/man/man3/TQStrList.3qt new file mode 100644 index 000000000..00050aef2 --- /dev/null +++ b/doc/man/man3/TQStrList.3qt @@ -0,0 +1 @@ +.so man3/tqstrlist.3qt diff --git a/doc/man/man3/TQStrListIterator.3qt b/doc/man/man3/TQStrListIterator.3qt new file mode 100644 index 000000000..909778090 --- /dev/null +++ b/doc/man/man3/TQStrListIterator.3qt @@ -0,0 +1 @@ +.so man3/tqstrlistiterator.3qt diff --git a/doc/man/man3/TQString.3qt b/doc/man/man3/TQString.3qt new file mode 100644 index 000000000..407f4edbc --- /dev/null +++ b/doc/man/man3/TQString.3qt @@ -0,0 +1 @@ +.so man3/tqstring.3qt diff --git a/doc/man/man3/TQStringList.3qt b/doc/man/man3/TQStringList.3qt new file mode 100644 index 000000000..aeb6e8335 --- /dev/null +++ b/doc/man/man3/TQStringList.3qt @@ -0,0 +1 @@ +.so man3/tqstringlist.3qt diff --git a/doc/man/man3/TQStyle.3qt b/doc/man/man3/TQStyle.3qt new file mode 100644 index 000000000..ed9feb2d5 --- /dev/null +++ b/doc/man/man3/TQStyle.3qt @@ -0,0 +1 @@ +.so man3/tqstyle.3qt diff --git a/doc/man/man3/TQStyleFactory.3qt b/doc/man/man3/TQStyleFactory.3qt new file mode 100644 index 000000000..371fc3d54 --- /dev/null +++ b/doc/man/man3/TQStyleFactory.3qt @@ -0,0 +1 @@ +.so man3/tqstylefactory.3qt diff --git a/doc/man/man3/TQStyleOption.3qt b/doc/man/man3/TQStyleOption.3qt new file mode 100644 index 000000000..ae39d70d1 --- /dev/null +++ b/doc/man/man3/TQStyleOption.3qt @@ -0,0 +1 @@ +.so man3/tqstyleoption.3qt diff --git a/doc/man/man3/TQStylePlugin.3qt b/doc/man/man3/TQStylePlugin.3qt new file mode 100644 index 000000000..0ca5520d0 --- /dev/null +++ b/doc/man/man3/TQStylePlugin.3qt @@ -0,0 +1 @@ +.so man3/tqstyleplugin.3qt diff --git a/doc/man/man3/TQStyleSheet.3qt b/doc/man/man3/TQStyleSheet.3qt new file mode 100644 index 000000000..8be3a5478 --- /dev/null +++ b/doc/man/man3/TQStyleSheet.3qt @@ -0,0 +1 @@ +.so man3/tqstylesheet.3qt diff --git a/doc/man/man3/TQStyleSheetItem.3qt b/doc/man/man3/TQStyleSheetItem.3qt new file mode 100644 index 000000000..90a8d7228 --- /dev/null +++ b/doc/man/man3/TQStyleSheetItem.3qt @@ -0,0 +1 @@ +.so man3/tqstylesheetitem.3qt diff --git a/doc/man/man3/TQSyntaxHighlighter.3qt b/doc/man/man3/TQSyntaxHighlighter.3qt new file mode 100644 index 000000000..c4dceda1b --- /dev/null +++ b/doc/man/man3/TQSyntaxHighlighter.3qt @@ -0,0 +1 @@ +.so man3/tqsyntaxhighlighter.3qt diff --git a/doc/man/man3/TQTab.3qt b/doc/man/man3/TQTab.3qt new file mode 100644 index 000000000..43c037ce9 --- /dev/null +++ b/doc/man/man3/TQTab.3qt @@ -0,0 +1 @@ +.so man3/tqtab.3qt diff --git a/doc/man/man3/TQTabBar.3qt b/doc/man/man3/TQTabBar.3qt new file mode 100644 index 000000000..4ffe6ae4c --- /dev/null +++ b/doc/man/man3/TQTabBar.3qt @@ -0,0 +1 @@ +.so man3/tqtabbar.3qt diff --git a/doc/man/man3/TQTabDialog.3qt b/doc/man/man3/TQTabDialog.3qt new file mode 100644 index 000000000..da80bdf1e --- /dev/null +++ b/doc/man/man3/TQTabDialog.3qt @@ -0,0 +1 @@ +.so man3/tqtabdialog.3qt diff --git a/doc/man/man3/TQTabWidget.3qt b/doc/man/man3/TQTabWidget.3qt new file mode 100644 index 000000000..bf1061b38 --- /dev/null +++ b/doc/man/man3/TQTabWidget.3qt @@ -0,0 +1 @@ +.so man3/tqtabwidget.3qt diff --git a/doc/man/man3/TQTable.3qt b/doc/man/man3/TQTable.3qt new file mode 100644 index 000000000..410da57f4 --- /dev/null +++ b/doc/man/man3/TQTable.3qt @@ -0,0 +1 @@ +.so man3/tqtable.3qt diff --git a/doc/man/man3/TQTableItem.3qt b/doc/man/man3/TQTableItem.3qt new file mode 100644 index 000000000..8f11f5e3a --- /dev/null +++ b/doc/man/man3/TQTableItem.3qt @@ -0,0 +1 @@ +.so man3/tqtableitem.3qt diff --git a/doc/man/man3/TQTableSelection.3qt b/doc/man/man3/TQTableSelection.3qt new file mode 100644 index 000000000..15ad96629 --- /dev/null +++ b/doc/man/man3/TQTableSelection.3qt @@ -0,0 +1 @@ +.so man3/tqtableselection.3qt diff --git a/doc/man/man3/TQTabletEvent.3qt b/doc/man/man3/TQTabletEvent.3qt new file mode 100644 index 000000000..bdd9e3348 --- /dev/null +++ b/doc/man/man3/TQTabletEvent.3qt @@ -0,0 +1 @@ +.so man3/tqtabletevent.3qt diff --git a/doc/man/man3/TQTextBrowser.3qt b/doc/man/man3/TQTextBrowser.3qt new file mode 100644 index 000000000..00bd3b14c --- /dev/null +++ b/doc/man/man3/TQTextBrowser.3qt @@ -0,0 +1 @@ +.so man3/tqtextbrowser.3qt diff --git a/doc/man/man3/TQTextCodec.3qt b/doc/man/man3/TQTextCodec.3qt new file mode 100644 index 000000000..838329218 --- /dev/null +++ b/doc/man/man3/TQTextCodec.3qt @@ -0,0 +1 @@ +.so man3/tqtextcodec.3qt diff --git a/doc/man/man3/TQTextCodecPlugin.3qt b/doc/man/man3/TQTextCodecPlugin.3qt new file mode 100644 index 000000000..7120ed652 --- /dev/null +++ b/doc/man/man3/TQTextCodecPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqtextcodecplugin.3qt diff --git a/doc/man/man3/TQTextDecoder.3qt b/doc/man/man3/TQTextDecoder.3qt new file mode 100644 index 000000000..f96941e72 --- /dev/null +++ b/doc/man/man3/TQTextDecoder.3qt @@ -0,0 +1 @@ +.so man3/tqtextdecoder.3qt diff --git a/doc/man/man3/TQTextDrag.3qt b/doc/man/man3/TQTextDrag.3qt new file mode 100644 index 000000000..871bc86f5 --- /dev/null +++ b/doc/man/man3/TQTextDrag.3qt @@ -0,0 +1 @@ +.so man3/tqtextdrag.3qt diff --git a/doc/man/man3/TQTextEdit.3qt b/doc/man/man3/TQTextEdit.3qt new file mode 100644 index 000000000..434ae170a --- /dev/null +++ b/doc/man/man3/TQTextEdit.3qt @@ -0,0 +1 @@ +.so man3/tqtextedit.3qt diff --git a/doc/man/man3/TQTextEncoder.3qt b/doc/man/man3/TQTextEncoder.3qt new file mode 100644 index 000000000..0fe859037 --- /dev/null +++ b/doc/man/man3/TQTextEncoder.3qt @@ -0,0 +1 @@ +.so man3/tqtextencoder.3qt diff --git a/doc/man/man3/TQTextIStream.3qt b/doc/man/man3/TQTextIStream.3qt new file mode 100644 index 000000000..8f05ff331 --- /dev/null +++ b/doc/man/man3/TQTextIStream.3qt @@ -0,0 +1 @@ +.so man3/tqtextistream.3qt diff --git a/doc/man/man3/TQTextOStream.3qt b/doc/man/man3/TQTextOStream.3qt new file mode 100644 index 000000000..98964be35 --- /dev/null +++ b/doc/man/man3/TQTextOStream.3qt @@ -0,0 +1 @@ +.so man3/tqtextostream.3qt diff --git a/doc/man/man3/TQTextStream.3qt b/doc/man/man3/TQTextStream.3qt new file mode 100644 index 000000000..927e9b49d --- /dev/null +++ b/doc/man/man3/TQTextStream.3qt @@ -0,0 +1 @@ +.so man3/tqtextstream.3qt diff --git a/doc/man/man3/TQThread.3qt b/doc/man/man3/TQThread.3qt new file mode 100644 index 000000000..d52842774 --- /dev/null +++ b/doc/man/man3/TQThread.3qt @@ -0,0 +1 @@ +.so man3/tqthread.3qt diff --git a/doc/man/man3/TQThreadStorage.3qt b/doc/man/man3/TQThreadStorage.3qt new file mode 100644 index 000000000..febf380c9 --- /dev/null +++ b/doc/man/man3/TQThreadStorage.3qt @@ -0,0 +1 @@ +.so man3/tqthreadstorage.3qt diff --git a/doc/man/man3/TQTime.3qt b/doc/man/man3/TQTime.3qt new file mode 100644 index 000000000..e9cd0a8e2 --- /dev/null +++ b/doc/man/man3/TQTime.3qt @@ -0,0 +1 @@ +.so man3/tqtime.3qt diff --git a/doc/man/man3/TQTimeEdit.3qt b/doc/man/man3/TQTimeEdit.3qt new file mode 100644 index 000000000..3134124fc --- /dev/null +++ b/doc/man/man3/TQTimeEdit.3qt @@ -0,0 +1 @@ +.so man3/tqtimeedit.3qt diff --git a/doc/man/man3/TQTimer.3qt b/doc/man/man3/TQTimer.3qt new file mode 100644 index 000000000..1ce9ee287 --- /dev/null +++ b/doc/man/man3/TQTimer.3qt @@ -0,0 +1 @@ +.so man3/tqtimer.3qt diff --git a/doc/man/man3/TQTimerEvent.3qt b/doc/man/man3/TQTimerEvent.3qt new file mode 100644 index 000000000..4843d7397 --- /dev/null +++ b/doc/man/man3/TQTimerEvent.3qt @@ -0,0 +1 @@ +.so man3/tqtimerevent.3qt diff --git a/doc/man/man3/TQToolBar.3qt b/doc/man/man3/TQToolBar.3qt new file mode 100644 index 000000000..98427d0a8 --- /dev/null +++ b/doc/man/man3/TQToolBar.3qt @@ -0,0 +1 @@ +.so man3/tqtoolbar.3qt diff --git a/doc/man/man3/TQToolBox.3qt b/doc/man/man3/TQToolBox.3qt new file mode 100644 index 000000000..ff88ea0ee --- /dev/null +++ b/doc/man/man3/TQToolBox.3qt @@ -0,0 +1 @@ +.so man3/tqtoolbox.3qt diff --git a/doc/man/man3/TQToolButton.3qt b/doc/man/man3/TQToolButton.3qt new file mode 100644 index 000000000..838ec105e --- /dev/null +++ b/doc/man/man3/TQToolButton.3qt @@ -0,0 +1 @@ +.so man3/tqtoolbutton.3qt diff --git a/doc/man/man3/TQToolTip.3qt b/doc/man/man3/TQToolTip.3qt new file mode 100644 index 000000000..6d461df0d --- /dev/null +++ b/doc/man/man3/TQToolTip.3qt @@ -0,0 +1 @@ +.so man3/tqtooltip.3qt diff --git a/doc/man/man3/TQToolTipGroup.3qt b/doc/man/man3/TQToolTipGroup.3qt new file mode 100644 index 000000000..50d1ce3d6 --- /dev/null +++ b/doc/man/man3/TQToolTipGroup.3qt @@ -0,0 +1 @@ +.so man3/tqtooltipgroup.3qt diff --git a/doc/man/man3/TQTranslator.3qt b/doc/man/man3/TQTranslator.3qt new file mode 100644 index 000000000..1e6d1cd8c --- /dev/null +++ b/doc/man/man3/TQTranslator.3qt @@ -0,0 +1 @@ +.so man3/tqtranslator.3qt diff --git a/doc/man/man3/TQTranslatorMessage.3qt b/doc/man/man3/TQTranslatorMessage.3qt new file mode 100644 index 000000000..f5126cd3d --- /dev/null +++ b/doc/man/man3/TQTranslatorMessage.3qt @@ -0,0 +1 @@ +.so man3/tqtranslatormessage.3qt diff --git a/doc/man/man3/TQTsciiCodec.3qt b/doc/man/man3/TQTsciiCodec.3qt new file mode 100644 index 000000000..6cca119a3 --- /dev/null +++ b/doc/man/man3/TQTsciiCodec.3qt @@ -0,0 +1 @@ +.so man3/tqtsciicodec.3qt diff --git a/doc/man/man3/TQUriDrag.3qt b/doc/man/man3/TQUriDrag.3qt new file mode 100644 index 000000000..7bce1e6cb --- /dev/null +++ b/doc/man/man3/TQUriDrag.3qt @@ -0,0 +1 @@ +.so man3/tquridrag.3qt diff --git a/doc/man/man3/TQUrl.3qt b/doc/man/man3/TQUrl.3qt new file mode 100644 index 000000000..76085d89e --- /dev/null +++ b/doc/man/man3/TQUrl.3qt @@ -0,0 +1 @@ +.so man3/tqurl.3qt diff --git a/doc/man/man3/TQUrlInfo.3qt b/doc/man/man3/TQUrlInfo.3qt new file mode 100644 index 000000000..e8163bc72 --- /dev/null +++ b/doc/man/man3/TQUrlInfo.3qt @@ -0,0 +1 @@ +.so man3/tqurlinfo.3qt diff --git a/doc/man/man3/TQUrlOperator.3qt b/doc/man/man3/TQUrlOperator.3qt new file mode 100644 index 000000000..9d679b8ed --- /dev/null +++ b/doc/man/man3/TQUrlOperator.3qt @@ -0,0 +1 @@ +.so man3/tqurloperator.3qt diff --git a/doc/man/man3/TQUuid.3qt b/doc/man/man3/TQUuid.3qt new file mode 100644 index 000000000..5f51dc9ea --- /dev/null +++ b/doc/man/man3/TQUuid.3qt @@ -0,0 +1 @@ +.so man3/tquuid.3qt diff --git a/doc/man/man3/TQVBox.3qt b/doc/man/man3/TQVBox.3qt new file mode 100644 index 000000000..28f528186 --- /dev/null +++ b/doc/man/man3/TQVBox.3qt @@ -0,0 +1 @@ +.so man3/tqvbox.3qt diff --git a/doc/man/man3/TQVBoxLayout.3qt b/doc/man/man3/TQVBoxLayout.3qt new file mode 100644 index 000000000..76c96f23d --- /dev/null +++ b/doc/man/man3/TQVBoxLayout.3qt @@ -0,0 +1 @@ +.so man3/tqvboxlayout.3qt diff --git a/doc/man/man3/TQVButtonGroup.3qt b/doc/man/man3/TQVButtonGroup.3qt new file mode 100644 index 000000000..0353b3a01 --- /dev/null +++ b/doc/man/man3/TQVButtonGroup.3qt @@ -0,0 +1 @@ +.so man3/tqvbuttongroup.3qt diff --git a/doc/man/man3/TQVGroupBox.3qt b/doc/man/man3/TQVGroupBox.3qt new file mode 100644 index 000000000..1e7bebca1 --- /dev/null +++ b/doc/man/man3/TQVGroupBox.3qt @@ -0,0 +1 @@ +.so man3/tqvgroupbox.3qt diff --git a/doc/man/man3/TQValidator.3qt b/doc/man/man3/TQValidator.3qt new file mode 100644 index 000000000..b2047bdcf --- /dev/null +++ b/doc/man/man3/TQValidator.3qt @@ -0,0 +1 @@ +.so man3/tqvalidator.3qt diff --git a/doc/man/man3/TQValueList.3qt b/doc/man/man3/TQValueList.3qt new file mode 100644 index 000000000..f85bd1fac --- /dev/null +++ b/doc/man/man3/TQValueList.3qt @@ -0,0 +1 @@ +.so man3/tqvaluelist.3qt diff --git a/doc/man/man3/TQValueListConstIterator.3qt b/doc/man/man3/TQValueListConstIterator.3qt new file mode 100644 index 000000000..6b85ba7dc --- /dev/null +++ b/doc/man/man3/TQValueListConstIterator.3qt @@ -0,0 +1 @@ +.so man3/tqvaluelistconstiterator.3qt diff --git a/doc/man/man3/TQValueListIterator.3qt b/doc/man/man3/TQValueListIterator.3qt new file mode 100644 index 000000000..e32037b41 --- /dev/null +++ b/doc/man/man3/TQValueListIterator.3qt @@ -0,0 +1 @@ +.so man3/tqvaluelistiterator.3qt diff --git a/doc/man/man3/TQValueStack.3qt b/doc/man/man3/TQValueStack.3qt new file mode 100644 index 000000000..5707b94c7 --- /dev/null +++ b/doc/man/man3/TQValueStack.3qt @@ -0,0 +1 @@ +.so man3/tqvaluestack.3qt diff --git a/doc/man/man3/TQValueVector.3qt b/doc/man/man3/TQValueVector.3qt new file mode 100644 index 000000000..b8c8546ac --- /dev/null +++ b/doc/man/man3/TQValueVector.3qt @@ -0,0 +1 @@ +.so man3/tqvaluevector.3qt diff --git a/doc/man/man3/TQVariant.3qt b/doc/man/man3/TQVariant.3qt new file mode 100644 index 000000000..83d95ef1e --- /dev/null +++ b/doc/man/man3/TQVariant.3qt @@ -0,0 +1 @@ +.so man3/tqvariant.3qt diff --git a/doc/man/man3/TQWMatrix.3qt b/doc/man/man3/TQWMatrix.3qt new file mode 100644 index 000000000..f6e746ab5 --- /dev/null +++ b/doc/man/man3/TQWMatrix.3qt @@ -0,0 +1 @@ +.so man3/tqwmatrix.3qt diff --git a/doc/man/man3/TQWSDecoration.3qt b/doc/man/man3/TQWSDecoration.3qt new file mode 100644 index 000000000..590bcf3c1 --- /dev/null +++ b/doc/man/man3/TQWSDecoration.3qt @@ -0,0 +1 @@ +.so man3/tqwsdecoration.3qt diff --git a/doc/man/man3/TQWSInputMethod.3qt b/doc/man/man3/TQWSInputMethod.3qt new file mode 100644 index 000000000..9c3885f17 --- /dev/null +++ b/doc/man/man3/TQWSInputMethod.3qt @@ -0,0 +1 @@ +.so man3/tqwsinputmethod.3qt diff --git a/doc/man/man3/TQWSKeyboardHandler.3qt b/doc/man/man3/TQWSKeyboardHandler.3qt new file mode 100644 index 000000000..4174d8c09 --- /dev/null +++ b/doc/man/man3/TQWSKeyboardHandler.3qt @@ -0,0 +1 @@ +.so man3/tqwskeyboardhandler.3qt diff --git a/doc/man/man3/TQWSMouseHandler.3qt b/doc/man/man3/TQWSMouseHandler.3qt new file mode 100644 index 000000000..69600e9f5 --- /dev/null +++ b/doc/man/man3/TQWSMouseHandler.3qt @@ -0,0 +1 @@ +.so man3/tqwsmousehandler.3qt diff --git a/doc/man/man3/TQWSServer.3qt b/doc/man/man3/TQWSServer.3qt new file mode 100644 index 000000000..680e8fa71 --- /dev/null +++ b/doc/man/man3/TQWSServer.3qt @@ -0,0 +1 @@ +.so man3/tqwsserver.3qt diff --git a/doc/man/man3/TQWSWindow.3qt b/doc/man/man3/TQWSWindow.3qt new file mode 100644 index 000000000..93149b845 --- /dev/null +++ b/doc/man/man3/TQWSWindow.3qt @@ -0,0 +1 @@ +.so man3/tqwswindow.3qt diff --git a/doc/man/man3/TQWaitCondition.3qt b/doc/man/man3/TQWaitCondition.3qt new file mode 100644 index 000000000..a0d027b35 --- /dev/null +++ b/doc/man/man3/TQWaitCondition.3qt @@ -0,0 +1 @@ +.so man3/tqwaitcondition.3qt diff --git a/doc/man/man3/TQWhatsThis.3qt b/doc/man/man3/TQWhatsThis.3qt new file mode 100644 index 000000000..ccadb1996 --- /dev/null +++ b/doc/man/man3/TQWhatsThis.3qt @@ -0,0 +1 @@ +.so man3/tqwhatsthis.3qt diff --git a/doc/man/man3/TQWheelEvent.3qt b/doc/man/man3/TQWheelEvent.3qt new file mode 100644 index 000000000..6ebc52339 --- /dev/null +++ b/doc/man/man3/TQWheelEvent.3qt @@ -0,0 +1 @@ +.so man3/tqwheelevent.3qt diff --git a/doc/man/man3/TQWidget.3qt b/doc/man/man3/TQWidget.3qt new file mode 100644 index 000000000..26d35c894 --- /dev/null +++ b/doc/man/man3/TQWidget.3qt @@ -0,0 +1 @@ +.so man3/tqwidget.3qt diff --git a/doc/man/man3/TQWidgetFactory.3qt b/doc/man/man3/TQWidgetFactory.3qt new file mode 100644 index 000000000..7c518e08a --- /dev/null +++ b/doc/man/man3/TQWidgetFactory.3qt @@ -0,0 +1 @@ +.so man3/tqwidgetfactory.3qt diff --git a/doc/man/man3/TQWidgetItem.3qt b/doc/man/man3/TQWidgetItem.3qt new file mode 100644 index 000000000..82a20d5bf --- /dev/null +++ b/doc/man/man3/TQWidgetItem.3qt @@ -0,0 +1 @@ +.so man3/tqwidgetitem.3qt diff --git a/doc/man/man3/TQWidgetPlugin.3qt b/doc/man/man3/TQWidgetPlugin.3qt new file mode 100644 index 000000000..1c35a252d --- /dev/null +++ b/doc/man/man3/TQWidgetPlugin.3qt @@ -0,0 +1 @@ +.so man3/tqwidgetplugin.3qt diff --git a/doc/man/man3/TQWidgetStack.3qt b/doc/man/man3/TQWidgetStack.3qt new file mode 100644 index 000000000..486859842 --- /dev/null +++ b/doc/man/man3/TQWidgetStack.3qt @@ -0,0 +1 @@ +.so man3/tqwidgetstack.3qt diff --git a/doc/man/man3/TQWindowsMime.3qt b/doc/man/man3/TQWindowsMime.3qt new file mode 100644 index 000000000..64969ab7a --- /dev/null +++ b/doc/man/man3/TQWindowsMime.3qt @@ -0,0 +1 @@ +.so man3/tqwindowsmime.3qt diff --git a/doc/man/man3/TQWindowsStyle.3qt b/doc/man/man3/TQWindowsStyle.3qt new file mode 100644 index 000000000..7359a7e29 --- /dev/null +++ b/doc/man/man3/TQWindowsStyle.3qt @@ -0,0 +1 @@ +.so man3/tqwindowsstyle.3qt diff --git a/doc/man/man3/TQWizard.3qt b/doc/man/man3/TQWizard.3qt new file mode 100644 index 000000000..a762b228a --- /dev/null +++ b/doc/man/man3/TQWizard.3qt @@ -0,0 +1 @@ +.so man3/tqwizard.3qt diff --git a/doc/man/man3/TQWorkspace.3qt b/doc/man/man3/TQWorkspace.3qt new file mode 100644 index 000000000..67c3ba6f4 --- /dev/null +++ b/doc/man/man3/TQWorkspace.3qt @@ -0,0 +1 @@ +.so man3/tqworkspace.3qt diff --git a/doc/man/man3/TQXmlAttributes.3qt b/doc/man/man3/TQXmlAttributes.3qt new file mode 100644 index 000000000..e4bf5a078 --- /dev/null +++ b/doc/man/man3/TQXmlAttributes.3qt @@ -0,0 +1 @@ +.so man3/tqxmlattributes.3qt diff --git a/doc/man/man3/TQXmlContentHandler.3qt b/doc/man/man3/TQXmlContentHandler.3qt new file mode 100644 index 000000000..e661b713c --- /dev/null +++ b/doc/man/man3/TQXmlContentHandler.3qt @@ -0,0 +1 @@ +.so man3/tqxmlcontenthandler.3qt diff --git a/doc/man/man3/TQXmlDTDHandler.3qt b/doc/man/man3/TQXmlDTDHandler.3qt new file mode 100644 index 000000000..a0ca594e8 --- /dev/null +++ b/doc/man/man3/TQXmlDTDHandler.3qt @@ -0,0 +1 @@ +.so man3/tqxmldtdhandler.3qt diff --git a/doc/man/man3/TQXmlDeclHandler.3qt b/doc/man/man3/TQXmlDeclHandler.3qt new file mode 100644 index 000000000..c8db49db7 --- /dev/null +++ b/doc/man/man3/TQXmlDeclHandler.3qt @@ -0,0 +1 @@ +.so man3/tqxmldeclhandler.3qt diff --git a/doc/man/man3/TQXmlDefaultHandler.3qt b/doc/man/man3/TQXmlDefaultHandler.3qt new file mode 100644 index 000000000..5e7009ee9 --- /dev/null +++ b/doc/man/man3/TQXmlDefaultHandler.3qt @@ -0,0 +1 @@ +.so man3/tqxmldefaulthandler.3qt diff --git a/doc/man/man3/TQXmlEntityResolver.3qt b/doc/man/man3/TQXmlEntityResolver.3qt new file mode 100644 index 000000000..0205c2c83 --- /dev/null +++ b/doc/man/man3/TQXmlEntityResolver.3qt @@ -0,0 +1 @@ +.so man3/tqxmlentityresolver.3qt diff --git a/doc/man/man3/TQXmlErrorHandler.3qt b/doc/man/man3/TQXmlErrorHandler.3qt new file mode 100644 index 000000000..fc88bbdee --- /dev/null +++ b/doc/man/man3/TQXmlErrorHandler.3qt @@ -0,0 +1 @@ +.so man3/tqxmlerrorhandler.3qt diff --git a/doc/man/man3/TQXmlInputSource.3qt b/doc/man/man3/TQXmlInputSource.3qt new file mode 100644 index 000000000..92e440b5a --- /dev/null +++ b/doc/man/man3/TQXmlInputSource.3qt @@ -0,0 +1 @@ +.so man3/tqxmlinputsource.3qt diff --git a/doc/man/man3/TQXmlLexicalHandler.3qt b/doc/man/man3/TQXmlLexicalHandler.3qt new file mode 100644 index 000000000..f4cfccd5d --- /dev/null +++ b/doc/man/man3/TQXmlLexicalHandler.3qt @@ -0,0 +1 @@ +.so man3/tqxmllexicalhandler.3qt diff --git a/doc/man/man3/TQXmlLocator.3qt b/doc/man/man3/TQXmlLocator.3qt new file mode 100644 index 000000000..3519a00a3 --- /dev/null +++ b/doc/man/man3/TQXmlLocator.3qt @@ -0,0 +1 @@ +.so man3/tqxmllocator.3qt diff --git a/doc/man/man3/TQXmlNamespaceSupport.3qt b/doc/man/man3/TQXmlNamespaceSupport.3qt new file mode 100644 index 000000000..0710de321 --- /dev/null +++ b/doc/man/man3/TQXmlNamespaceSupport.3qt @@ -0,0 +1 @@ +.so man3/tqxmlnamespacesupport.3qt diff --git a/doc/man/man3/TQXmlParseException.3qt b/doc/man/man3/TQXmlParseException.3qt new file mode 100644 index 000000000..cb21d1c8e --- /dev/null +++ b/doc/man/man3/TQXmlParseException.3qt @@ -0,0 +1 @@ +.so man3/tqxmlparseexception.3qt diff --git a/doc/man/man3/TQXmlReader.3qt b/doc/man/man3/TQXmlReader.3qt new file mode 100644 index 000000000..7e41b5dcc --- /dev/null +++ b/doc/man/man3/TQXmlReader.3qt @@ -0,0 +1 @@ +.so man3/tqxmlreader.3qt diff --git a/doc/man/man3/TQXmlSimpleReader.3qt b/doc/man/man3/TQXmlSimpleReader.3qt new file mode 100644 index 000000000..5226c3d1a --- /dev/null +++ b/doc/man/man3/TQXmlSimpleReader.3qt @@ -0,0 +1 @@ +.so man3/tqxmlsimplereader.3qt diff --git a/doc/man/man3/TQt.3qt b/doc/man/man3/TQt.3qt new file mode 100644 index 000000000..ff2c093c3 --- /dev/null +++ b/doc/man/man3/TQt.3qt @@ -0,0 +1 @@ +.so man3/tqt.3qt diff --git a/doc/man/man3/qaccel.3qt b/doc/man/man3/qaccel.3qt deleted file mode 100644 index b887dae5d..000000000 --- a/doc/man/man3/qaccel.3qt +++ /dev/null @@ -1,324 +0,0 @@ -'\" t -.TH QAccel 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 -QAccel \- Handles keyboard accelerator and shortcut keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAccel\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQAccel\fR ( QWidget * watch, QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QAccel\fR ()" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "void \fBsetEnabled\fR ( bool enable )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QKeySequence & key, int id = -1 )" -.br -.ti -1c -.BI "void \fBremoveItem\fR ( int id )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "QKeySequence \fBkey\fR ( int id )" -.br -.ti -1c -.BI "int \fBfindKey\fR ( const QKeySequence & key ) const" -.br -.ti -1c -.BI "bool \fBisItemEnabled\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" -.br -.ti -1c -.BI "bool \fBconnectItem\fR ( int id, const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "bool \fBdisconnectItem\fR ( int id, const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "void repairEventFilter () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetWhatsThis\fR ( int id, const QString & text )" -.br -.ti -1c -.BI "QString \fBwhatsThis\fR ( int id ) const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBactivated\fR ( int id )" -.br -.ti -1c -.BI "void \fBactivatedAmbiguously\fR ( int id )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QKeySequence \fBshortcutKey\fR ( const QString & str )" -.br -.ti -1c -.BI "QString keyToString ( QKeySequence k ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QKeySequence stringToKey ( const QString & s ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool eventFilter ( QObject *, QEvent * ) \fI(obsolete)\fR" -.br -.in -1c -.SH DESCRIPTION -The QAccel class handles keyboard accelerator and shortcut keys. -.PP -A keyboard accelerator triggers an action when a certain key combination is pressed. The accelerator handles all keyboard activity for all the children of one top-level widget, so it is not affected by the keyboard focus. -.PP -In most cases, you will not need to use this class directly. Use the QAction class to create actions with accelerators that can be used in both menus and toolbars. If you're only interested in menus use QMenuData::insertItem() or QMenuData::setAccel() to make accelerators for operations that are also available on menus. Many widgets automatically generate accelerators, such as QButton, QGroupBox, QLabel (with QLabel::setBuddy()), QMenuBar and QTabBar. Example: -.PP -.nf -.br - QPushButton p( "&Exit", parent ); // automatic shortcut ALT+Key_E -.br - QPopupMenu *fileMenu = new fileMenu( parent ); -.br - fileMenu->insertItem( "Undo", parent, SLOT(undo()), CTRL+Key_Z ); -.br -.fi -.PP -A QAccel contains a list of accelerator items that can be manipulated using insertItem(), removeItem(), clear(), key() and findKey(). -.PP -Each accelerator item consists of an identifier and a QKeySequence. A single key sequence consists of a keyboard code combined with modifiers (SHIFT, CTRL, ALT or UNICODE_ACCEL). For example, \fCCTRL + Key_P\fR could be a shortcut for printing a document. The key codes are listed in ntqnamespace.h. As an alternative, use UNICODE_ACCEL with the unicode code point of the character. For example, \fCUNICODE_ACCEL + 'A'\fR gives the same accelerator as Key_A. -.PP -When an accelerator key is pressed, the accelerator sends out the signal activated() with a number that identifies this particular accelerator item. Accelerator items can also be individually connected, so that two different keys will activate two different slots (see connectItem() and disconnectItem()). -.PP -The activated() signal is \fInot\fR emitted when two or more accelerators match the same key. Instead, the first matching accelerator sends out the activatedAmbiguously() signal. By pressing the key multiple times, users can navigate between all matching accelerators. Some standard controls like QPushButton and QCheckBox connect the activatedAmbiguously() signal to the harmless setFocus() slot, whereas activated() is connected to a slot invoking the button's action. Most controls, like QLabel and QTabBar, treat activated() and activatedAmbiguously() as equivalent. -.PP -Use setEnabled() to enable or disable all the items in an accelerator, or setItemEnabled() to enable or disable individual items. An item is active only when both the QAccel and the item itself are enabled. -.PP -The function setWhatsThis() specifies a help text that appears when the user presses an accelerator key in What's This mode. -.PP -The accelerator will be deleted when \fIparent\fR is deleted, and will consume relevant key events until then. -.PP -Please note that the accelerator -.PP -.nf -.br - accelerator->insertItem( QKeySequence("M") ); -.br -.fi -can be triggered with both the 'M' key, and with Shift+M, unless a second accelerator is defined for the Shift+M combination. -.PP -Example: -.PP -.nf -.br - QAccel *a = new QAccel( myWindow ); // create accels for myWindow -.br - a->connectItem( a->insertItem(Key_P+CTRL), // adds Ctrl+P accelerator -.br - myWindow, // connected to myWindow's -.br - SLOT(printDoc()) ); // printDoc() slot -.br -.fi -.PP -See also QKeyEvent, QWidget::keyPressEvent(), QMenuData::setAccel(), QButton::accel, QLabel::setBuddy(), QKeySequence, GUI Design Handbook: Keyboard Shortcuts, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAccel::QAccel ( QWidget * parent, const char * name = 0 )" -Constructs a QAccel object called \fIname\fR, with parent \fIparent\fR. The accelerator operates on \fIparent\fR. -.SH "QAccel::QAccel ( QWidget * watch, QObject * parent, const char * name = 0 )" -Constructs a QAccel object called \fIname\fR, that operates on \fIwatch\fR, and is a child of \fIparent\fR. -.PP -This constructor is not needed for normal application programming. -.SH "QAccel::~QAccel ()" -Destroys the accelerator object and frees all allocated resources. -.SH "void QAccel::activated ( int id )\fC [signal]\fR" -This signal is emitted when an accelerator key is pressed. \fIid\fR is a number that identifies this particular accelerator item. -.PP -See also activatedAmbiguously(). -.SH "void QAccel::activatedAmbiguously ( int id )\fC [signal]\fR" -This signal is emitted when an accelerator key is pressed. \fIid\fR is a number that identifies this particular accelerator item. -.PP -See also activated(). -.SH "void QAccel::clear ()" -Removes all accelerator items. -.SH "bool QAccel::connectItem ( int id, const QObject * receiver, const char * member )" -Connects the accelerator item \fIid\fR to the slot \fImember\fR of \fIreceiver\fR. -.PP -.nf -.br - a->connectItem( 201, mainView, SLOT(quit()) ); -.br -.fi -.PP -Of course, you can also send a signal as \fImember\fR. -.PP -Normally accelerators are connected to slots which then receive the \fCactivated(int id)\fR signal with the id of the accelerator item that was activated. If you choose to connect a specific accelerator item using this function, the activated() signal is emitted if the associated key sequence is pressed but no \fCactivated(int id)\fR signal is emitted. -.PP -See also disconnectItem(). -.PP -Example: t14/gamebrd.cpp. -.SH "uint QAccel::count () const" -Returns the number of accelerator items in this accelerator. -.SH "bool QAccel::disconnectItem ( int id, const QObject * receiver, const char * member )" -Disconnects an accelerator item with id \fIid\fR from the function called \fImember\fR in the \fIreceiver\fR object. -.PP -See also connectItem(). -.SH "bool QAccel::eventFilter ( QObject *, QEvent * )\fC [virtual protected]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. serves no purpose anymore -.PP -Reimplemented from QObject. -.SH "int QAccel::findKey ( const QKeySequence & key ) const" -Returns the identifier of the accelerator item with the key code \fIkey\fR, or -1 if the item cannot be found. -.SH "int QAccel::insertItem ( const QKeySequence & key, int id = -1 )" -Inserts an accelerator item and returns the item's identifier. -.PP -\fIkey\fR is a key code and an optional combination of SHIFT, CTRL and ALT. \fIid\fR is the accelerator item id. -.PP -If \fIid\fR is negative, then the item will be assigned a unique negative identifier less than -1. -.PP -.nf -.br - QAccel *a = new QAccel( myWindow ); // create accels for myWindow -.br - a->insertItem( CTRL + Key_P, 200 ); // Ctrl+P, e.g. to print document -.br - a->insertItem( ALT + Key_X, 201 ); // Alt+X, e.g. to quit -.br - a->insertItem( UNICODE_ACCEL + 'q', 202 ); // Unicode 'q', e.g. to quit -.br - a->insertItem( Key_D ); // gets a unique negative id < -1 -.br - a->insertItem( CTRL + SHIFT + Key_P ); // gets a unique negative id < -1 -.br -.fi -.PP -Example: t14/gamebrd.cpp. -.SH "bool QAccel::isEnabled () const" -Returns TRUE if the accelerator is enabled; otherwise returns FALSE. -.PP -See also setEnabled() and isItemEnabled(). -.SH "bool QAccel::isItemEnabled ( int id ) const" -Returns TRUE if the accelerator item with the identifier \fIid\fR is enabled. Returns FALSE if the item is disabled or cannot be found. -.PP -See also setItemEnabled() and isEnabled(). -.SH "QKeySequence QAccel::key ( int id )" -Returns the key sequence of the accelerator item with identifier \fIid\fR, or an invalid key sequence (0) if the id cannot be found. -.SH "QString QAccel::keyToString ( QKeySequence k )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Creates an accelerator string for the key \fIk\fR. For instance CTRL+Key_O gives "Ctrl+O". The "Ctrl" etc. are translated (using QObject::tr()) in the "QAccel" context. -.PP -The function is superfluous. Cast the QKeySequence \fIk\fR to a QString for the same effect. -.SH "void QAccel::removeItem ( int id )" -Removes the accelerator item with the identifier \fIid\fR. -.SH "void QAccel::repairEventFilter ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. serves no purpose anymore -.SH "void QAccel::setEnabled ( bool enable )" -Enables the accelerator if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. -.PP -Individual keys can also be enabled or disabled using setItemEnabled(). To work, a key must be an enabled item in an enabled QAccel. -.PP -See also isEnabled() and setItemEnabled(). -.SH "void QAccel::setItemEnabled ( int id, bool enable )" -Enables the accelerator item with the identifier \fIid\fR if \fIenable\fR is TRUE, and disables item \fIid\fR if \fIenable\fR is FALSE. -.PP -To work, an item must be enabled and be in an enabled QAccel. -.PP -See also isItemEnabled() and isEnabled(). -.SH "void QAccel::setWhatsThis ( int id, const QString & text )" -Sets a What's This help text for the accelerator item \fIid\fR to \fItext\fR. -.PP -The text will be shown when the application is in What's This mode and the user hits the accelerator key. -.PP -To set What's This help on a menu item (with or without an accelerator key), use QMenuData::setWhatsThis(). -.PP -See also whatsThis(), QWhatsThis::inWhatsThisMode(), QMenuData::setWhatsThis(), and QAction::whatsThis. -.SH "QKeySequence QAccel::shortcutKey ( const QString & str )\fC [static]\fR" -Returns the shortcut key sequence for \fIstr\fR, or an invalid key sequence (0) if \fIstr\fR has no shortcut sequence. -.PP -For example, shortcutKey("E&xit") returns ALT+Key_X, shortcutKey("&Quit") returns ALT+Key_Q and shortcutKey("Quit") returns 0. (In code that does not inherit the Qt namespace class, you must write e.g. Qt::ALT+Qt::Key_Q.) -.PP -We provide a list of common accelerators in English. At the time of writing, Microsoft and Open Group do not appear to have issued equivalent recommendations for other languages. -.SH "QKeySequence QAccel::stringToKey ( const QString & s )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns an accelerator code for the string \fIs\fR. For example" Ctrl+O" gives CTRL+UNICODE_ACCEL+'O'. The strings "Ctrl"," Shift", "Alt" are recognized, as well as their translated equivalents in the "QAccel" context (using QObject::tr()). Returns 0 if \fIs\fR is not recognized. -.PP -This function is typically used with tr(), so that accelerator keys can be replaced in translations: -.PP -.nf -.br - QPopupMenu *file = new QPopupMenu( this ); -.br - file->insertItem( p1, tr("&Open..."), this, SLOT(open()), -.br - QAccel::stringToKey(tr("Ctrl+O", "File|Open")) ); -.br -.fi -.PP -Notice the \fC"File|Open"\fR translator comment. It is by no means necessary, but it provides some context for the human translator. -.PP -The function is superfluous. Construct a QKeySequence from the string \fIs\fR for the same effect. -.PP -See also QObject::tr() and Internationalization with Qt. -.PP -Example: i18n/mywidget.cpp. -.SH "QString QAccel::whatsThis ( int id ) const" -Returns the What's This help text for the specified item \fIid\fR or QString::null if no text has been specified. -.PP -See also setWhatsThis(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqaccel.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaccel.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaccessible.3qt b/doc/man/man3/qaccessible.3qt deleted file mode 100644 index 48a2a380e..000000000 --- a/doc/man/man3/qaccessible.3qt +++ /dev/null @@ -1,399 +0,0 @@ -'\" t -.TH QAccessible 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 -QAccessible \- Enums and static functions relating to accessibility -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QAccessibleInterface. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBEvent\fR { SoundPlayed = 0x0001, Alert = 0x0002, ForegroundChanged = 0x0003, MenuStart = 0x0004, MenuEnd = 0x0005, PopupMenuStart = 0x0006, PopupMenuEnd = 0x0007, ContextHelpStart = 0x000C, ContextHelpEnd = 0x000D, DragDropStart = 0x000E, DragDropEnd = 0x000F, DialogStart = 0x0010, DialogEnd = 0x0011, ScrollingStart = 0x0012, ScrollingEnd = 0x0013, MenuCommand = 0x0018, ObjectCreated = 0x8000, ObjectDestroyed = 0x8001, ObjectShow = 0x8002, ObjectHide = 0x8003, ObjectReorder = 0x8004, Focus = 0x8005, Selection = 0x8006, SelectionAdd = 0x8007, SelectionRemove = 0x8008, SelectionWithin = 0x8009, StateChanged = 0x800A, LocationChanged = 0x800B, NameChanged = 0x800C, DescriptionChanged = 0x800D, ValueChanged = 0x800E, ParentChanged = 0x800F, HelpChanged = 0x80A0, DefaultActionChanged = 0x80B0, AcceleratorChanged = 0x80C0 }" -.br -.ti -1c -.BI "enum \fBState\fR { Normal = 0x00000000, Unavailable = 0x00000001, Selected = 0x00000002, Focused = 0x00000004, Pressed = 0x00000008, Checked = 0x00000010, Mixed = 0x00000020, ReadOnly = 0x00000040, HotTracked = 0x00000080, Default = 0x00000100, Expanded = 0x00000200, Collapsed = 0x00000400, Busy = 0x00000800, Floating = 0x00001000, Marqueed = 0x00002000, Animated = 0x00004000, Invisible = 0x00008000, Offscreen = 0x00010000, Sizeable = 0x00020000, Moveable = 0x00040000, SelfVoicing = 0x00080000, Focusable = 0x00100000, Selectable = 0x00200000, Linked = 0x00400000, Traversed = 0x00800000, MultiSelectable = 0x01000000, ExtSelectable = 0x02000000, AlertLow = 0x04000000, AlertMedium = 0x08000000, AlertHigh = 0x10000000, Protected = 0x20000000, Valid = 0x3fffffff }" -.br -.ti -1c -.BI "enum \fBRole\fR { NoRole = 0x00000000, TitleBar = 0x00000001, MenuBar = 0x00000002, ScrollBar = 0x00000003, Grip = 0x00000004, Sound = 0x00000005, Cursor = 0x00000006, Caret = 0x00000007, AlertMessage = 0x00000008, Window = 0x00000009, Client = 0x0000000A, PopupMenu = 0x0000000B, MenuItem = 0x0000000C, ToolTip = 0x0000000D, Application = 0x0000000E, Document = 0x0000000F, Pane = 0x00000010, Chart = 0x00000011, Dialog = 0x00000012, Border = 0x00000013, Grouping = 0x00000014, Separator = 0x00000015, ToolBar = 0x00000016, StatusBar = 0x00000017, Table = 0x00000018, ColumnHeader = 0x00000019, RowHeader = 0x0000001A, Column = 0x0000001B, Row = 0x0000001C, Cell = 0x0000001D, Link = 0x0000001E, HelpBalloon = 0x0000001F, Character = 0x00000020, List = 0x00000021, ListItem = 0x00000022, Outline = 0x00000023, OutlineItem = 0x00000024, PageTab = 0x00000025, PropertyPage = 0x00000026, Indicator = 0x00000027, Graphic = 0x00000028, StaticText = 0x00000029, EditableText = 0x0000002A, PushButton = 0x0000002B, CheckBox = 0x0000002C, RadioButton = 0x0000002D, ComboBox = 0x0000002E, DropLest = 0x0000002F, ProgressBar = 0x00000030, Dial = 0x00000031, HotkeyField = 0x00000032, Slider = 0x00000033, SpinBox = 0x00000034, Diagram = 0x00000035, Animation = 0x00000036, Equation = 0x00000037, ButtonDropDown = 0x00000038, ButtonMenu = 0x00000039, ButtonDropGrid = 0x0000003A, Whitespace = 0x0000003B, PageTabList = 0x0000003C, Clock = 0x0000003D }" -.br -.ti -1c -.BI "enum \fBNavDirection\fR { NavUp = 0x00000001, NavDown = 0x00000002, NavLeft = 0x00000003, NavRight = 0x00000004, NavNext = 0x00000005, NavPrevious = 0x00000006, NavFirstChild = 0x00000007, NavLastChild = 0x00000008, NavFocusChild = 0x00000009 }" -.br -.ti -1c -.BI "enum \fBText\fR { Name = 0, Description, Value, Help, Accelerator, DefaultAction }" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QRESULT \fBqueryAccessibleInterface\fR ( QObject * object, QAccessibleInterface ** iface )" -.br -.ti -1c -.BI "void \fBupdateAccessibility\fR ( QObject * object, int control, Event reason )" -.br -.ti -1c -.BI "bool \fBisActive\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QAccessible class provides enums and static functions relating to accessibility. -.PP -Accessibility clients use implementations of the QAccessibleInterface to read the information an accessible object exposes, or to call functions to manipulate the accessible object. -.PP -See the plugin documentation for more details about how to redistribute Qt plugins. -.PP -See also Miscellaneous Classes. -.SS "Member Type Documentation" -.SH "QAccessible::Event" -This enum type defines event types when the state of the accessible object has changed. The event types are: -.TP -\fCQAccessible::SoundPlayed\fR -.TP -\fCQAccessible::Alert\fR -.TP -\fCQAccessible::ForegroundChanged\fR -.TP -\fCQAccessible::MenuStart\fR -.TP -\fCQAccessible::MenuEnd\fR -.TP -\fCQAccessible::PopupMenuStart\fR -.TP -\fCQAccessible::PopupMenuEnd\fR -.TP -\fCQAccessible::ContextHelpStart\fR -.TP -\fCQAccessible::ContextHelpEnd\fR -.TP -\fCQAccessible::DragDropStart\fR -.TP -\fCQAccessible::DragDropEnd\fR -.TP -\fCQAccessible::DialogStart\fR -.TP -\fCQAccessible::DialogEnd\fR -.TP -\fCQAccessible::ScrollingStart\fR -.TP -\fCQAccessible::ScrollingEnd\fR -.TP -\fCQAccessible::ObjectCreated\fR -.TP -\fCQAccessible::ObjectDestroyed\fR -.TP -\fCQAccessible::ObjectShow\fR -.TP -\fCQAccessible::ObjectHide\fR -.TP -\fCQAccessible::ObjectReorder\fR -.TP -\fCQAccessible::Focus\fR -.TP -\fCQAccessible::Selection\fR -.TP -\fCQAccessible::SelectionAdd\fR -.TP -\fCQAccessible::SelectionRemove\fR -.TP -\fCQAccessible::SelectionWithin\fR -.TP -\fCQAccessible::StateChanged\fR -.TP -\fCQAccessible::LocationChanged\fR -.TP -\fCQAccessible::NameChanged\fR -.TP -\fCQAccessible::DescriptionChanged\fR -.TP -\fCQAccessible::ValueChanged\fR -.TP -\fCQAccessible::ParentChanged\fR -.TP -\fCQAccessible::HelpChanged\fR -.TP -\fCQAccessible::DefaultActionChanged\fR -.TP -\fCQAccessible::AcceleratorChanged\fR -.TP -\fCQAccessible::MenuCommand\fR -.SH "QAccessible::NavDirection" -This enum specifies which item to move to when navigating. -.TP -\fCQAccessible::NavUp\fR - sibling above -.TP -\fCQAccessible::NavDown\fR - sibling below -.TP -\fCQAccessible::NavLeft\fR - left sibling -.TP -\fCQAccessible::NavRight\fR - right sibling -.TP -\fCQAccessible::NavNext\fR - next sibling -.TP -\fCQAccessible::NavPrevious\fR - previous sibling -.TP -\fCQAccessible::NavFirstChild\fR - first child -.TP -\fCQAccessible::NavLastChild\fR - last child -.TP -\fCQAccessible::NavFocusChild\fR - child with focus -.SH "QAccessible::Role" -This enum defines a number of roles an accessible object can have. The roles are: -.TP -\fCQAccessible::NoRole\fR -.TP -\fCQAccessible::TitleBar\fR -.TP -\fCQAccessible::MenuBar\fR -.TP -\fCQAccessible::ScrollBar\fR -.TP -\fCQAccessible::Grip\fR -.TP -\fCQAccessible::Sound\fR -.TP -\fCQAccessible::Cursor\fR -.TP -\fCQAccessible::Caret\fR -.TP -\fCQAccessible::AlertMessage\fR -.TP -\fCQAccessible::Window\fR -.TP -\fCQAccessible::Client\fR -.TP -\fCQAccessible::PopupMenu\fR -.TP -\fCQAccessible::MenuItem\fR -.TP -\fCQAccessible::ToolTip\fR -.TP -\fCQAccessible::Application\fR -.TP -\fCQAccessible::Document\fR -.TP -\fCQAccessible::Pane\fR -.TP -\fCQAccessible::Chart\fR -.TP -\fCQAccessible::Dialog\fR -.TP -\fCQAccessible::Border\fR -.TP -\fCQAccessible::Grouping\fR -.TP -\fCQAccessible::Separator\fR -.TP -\fCQAccessible::ToolBar\fR -.TP -\fCQAccessible::StatusBar\fR -.TP -\fCQAccessible::Table\fR -.TP -\fCQAccessible::ColumnHeader\fR -.TP -\fCQAccessible::RowHeader\fR -.TP -\fCQAccessible::Column\fR -.TP -\fCQAccessible::Row\fR -.TP -\fCQAccessible::Cell\fR -.TP -\fCQAccessible::Link\fR -.TP -\fCQAccessible::HelpBalloon\fR -.TP -\fCQAccessible::Character\fR -.TP -\fCQAccessible::List\fR -.TP -\fCQAccessible::ListItem\fR -.TP -\fCQAccessible::Outline\fR -.TP -\fCQAccessible::OutlineItem\fR -.TP -\fCQAccessible::PageTab\fR -.TP -\fCQAccessible::PropertyPage\fR -.TP -\fCQAccessible::Indicator\fR -.TP -\fCQAccessible::Graphic\fR -.TP -\fCQAccessible::StaticText\fR -.TP -\fCQAccessible::EditableText\fR -.TP -\fCQAccessible::PushButton\fR -.TP -\fCQAccessible::CheckBox\fR -.TP -\fCQAccessible::RadioButton\fR -.TP -\fCQAccessible::ComboBox\fR -.TP -\fCQAccessible::DropLest\fR -.TP -\fCQAccessible::ProgressBar\fR -.TP -\fCQAccessible::Dial\fR -.TP -\fCQAccessible::HotkeyField\fR -.TP -\fCQAccessible::Slider\fR -.TP -\fCQAccessible::SpinBox\fR -.TP -\fCQAccessible::Diagram\fR -.TP -\fCQAccessible::Animation\fR -.TP -\fCQAccessible::Equation\fR -.TP -\fCQAccessible::ButtonDropDown\fR -.TP -\fCQAccessible::ButtonMenu\fR -.TP -\fCQAccessible::ButtonDropGrid\fR -.TP -\fCQAccessible::Whitespace\fR -.TP -\fCQAccessible::PageTabList\fR -.TP -\fCQAccessible::Clock\fR -.SH "QAccessible::State" -This enum type defines bitflags that can be combined to indicate the state of the accessible object. The values are: -.TP -\fCQAccessible::Normal\fR -.TP -\fCQAccessible::Unavailable\fR -.TP -\fCQAccessible::Selected\fR -.TP -\fCQAccessible::Focused\fR -.TP -\fCQAccessible::Pressed\fR -.TP -\fCQAccessible::Checked\fR -.TP -\fCQAccessible::Mixed\fR -.TP -\fCQAccessible::ReadOnly\fR -.TP -\fCQAccessible::HotTracked\fR -.TP -\fCQAccessible::Default\fR -.TP -\fCQAccessible::Expanded\fR -.TP -\fCQAccessible::Collapsed\fR -.TP -\fCQAccessible::Busy\fR -.TP -\fCQAccessible::Floating\fR -.TP -\fCQAccessible::Marqueed\fR -.TP -\fCQAccessible::Animated\fR -.TP -\fCQAccessible::Invisible\fR -.TP -\fCQAccessible::Offscreen\fR -.TP -\fCQAccessible::Sizeable\fR -.TP -\fCQAccessible::Moveable\fR -.TP -\fCQAccessible::SelfVoicing\fR -.TP -\fCQAccessible::Focusable\fR -.TP -\fCQAccessible::Selectable\fR -.TP -\fCQAccessible::Linked\fR -.TP -\fCQAccessible::Traversed\fR -.TP -\fCQAccessible::MultiSelectable\fR -.TP -\fCQAccessible::ExtSelectable\fR -.TP -\fCQAccessible::AlertLow\fR -.TP -\fCQAccessible::AlertMedium\fR -.TP -\fCQAccessible::AlertHigh\fR -.TP -\fCQAccessible::Protected\fR -.TP -\fCQAccessible::Valid\fR -.SH "QAccessible::Text" -This enum specifies string information that an accessible object returns. -.TP -\fCQAccessible::Name\fR - The name of the object -.TP -\fCQAccessible::Description\fR - A short text describing the object -.TP -\fCQAccessible::Value\fR - The value of the object -.TP -\fCQAccessible::Help\fR - A longer text giving information about how to use the object -.TP -\fCQAccessible::DefaultAction\fR - The default method to interact with the object -.TP -\fCQAccessible::Accelerator\fR - The keyboard shortcut that executes the default action -.SH MEMBER FUNCTION DOCUMENTATION -.SH "bool QAccessible::isActive ()\fC [static]\fR" -Returns TRUE if an accessibility implementation has been requested, during the runtime of the application, otherwise returns FALSE. -.PP -Use this function to prevent potentially expensive notifications via updateAccessibility(). -.SH "QRESULT QAccessible::queryAccessibleInterface ( QObject * object, QAccessibleInterface ** iface )\fC [static]\fR" -Sets \fIiface\fR to point to the implementation of the QAccessibleInterface for \fIobject\fR, and returns \fCQS_OK\fR if successfull, or sets \fIiface\fR to 0 and returns \fCQE_NOCOMPONENT\fR if no accessibility implementation for \fIobject\fR exists. -.PP -The function uses the classname of \fIobject\fR to find a suitable implementation. If no implementation for the object's class is available the function tries to find an implementation for the object's parent class. -.PP -This function is called to answer an accessibility client's request for object information. You should never need to call this function yourself. -.SH "void QAccessible::updateAccessibility ( QObject * object, int control, Event reason )\fC [static]\fR" -Notifies accessibility clients about a change in \fIobject\fR's accessibility information. -.PP -\fIreason\fR specifies the cause of the change, for example, ValueChange when the position of a slider has been changed. \fIcontrol\fR is the ID of the child element that has changed. When \fIcontrol\fR is 0, the object itself has changed. -.PP -Call this function whenever the state of your accessible object or one of it's sub-elements has been changed either programmatically (e.g. by calling QLabel::setText()) or by user interaction. -.PP -If there are no accessibility tools listening to this event, the -performance penalty for calling this function is minor, but if determining -the parameters of the call is expensive you can use isActive() to -avoid unnecessary performance penalties if no client is listening. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqaccessible.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaccessible.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaccessibleinterface.3qt b/doc/man/man3/qaccessibleinterface.3qt deleted file mode 100644 index f80757f7e..000000000 --- a/doc/man/man3/qaccessibleinterface.3qt +++ /dev/null @@ -1,178 +0,0 @@ -'\" t -.TH QAccessibleInterface 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 -QAccessibleInterface \- Defines an interface that exposes information about accessible objects -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QAccessible. -.PP -Inherited by QAccessibleObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual bool \fBisValid\fR () const = 0" -.br -.ti -1c -.BI "virtual int \fBchildCount\fR () const = 0" -.br -.ti -1c -.BI "virtual QRESULT \fBqueryChild\fR ( int control, QAccessibleInterface ** iface ) const = 0" -.br -.ti -1c -.BI "virtual QRESULT \fBqueryParent\fR ( QAccessibleInterface ** iface ) const = 0" -.br -.ti -1c -.BI "virtual int \fBcontrolAt\fR ( int x, int y ) const = 0" -.br -.ti -1c -.BI "virtual QRect \fBrect\fR ( int control ) const = 0" -.br -.ti -1c -.BI "virtual int \fBnavigate\fR ( NavDirection direction, int startControl ) const = 0" -.br -.ti -1c -.BI "virtual QString \fBtext\fR ( Text t, int control ) const = 0" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( Text t, int control, const QString & text ) = 0" -.br -.ti -1c -.BI "virtual Role \fBrole\fR ( int control ) const = 0" -.br -.ti -1c -.BI "virtual State \fBstate\fR ( int control ) const = 0" -.br -.ti -1c -.BI "virtual QMemArray \fBselection\fR () const = 0" -.br -.ti -1c -.BI "virtual bool \fBdoDefaultAction\fR ( int control ) = 0" -.br -.ti -1c -.BI "virtual bool \fBsetFocus\fR ( int control ) = 0" -.br -.ti -1c -.BI "virtual bool \fBsetSelected\fR ( int control, bool on, bool extend ) = 0" -.br -.ti -1c -.BI "virtual void \fBclearSelection\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QAccessibleInterface class defines an interface that exposes information about accessible objects. -.PP -See also Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "int QAccessibleInterface::childCount () const\fC [pure virtual]\fR" -Returns the number of children that belong to this object. A child can provide accessibility information on it's own (e.g. a child widget), or be a sub-element of this accessible object. -.PP -All objects provide this information. -.PP -See also queryChild(). -.SH "void QAccessibleInterface::clearSelection ()\fC [pure virtual]\fR" -Removes any selection from the object. -.PP -See also setSelected(). -.SH "int QAccessibleInterface::controlAt ( int x, int y ) const\fC [pure virtual]\fR" -Returns the ID of the child that contains the screen coordinates (\fIx\fR, \fIy\fR). This function returns 0 if the point is positioned on the object itself. If the tested point is outside the boundaries of the object this function returns -1. -.PP -All visual objects provide this information. -.SH "bool QAccessibleInterface::doDefaultAction ( int control )\fC [pure virtual]\fR" -Calling this function performs the default action of the child object specified by \fIcontrol\fR, or the default action of the object itself if \fIcontrol\fR is 0. -.SH "bool QAccessibleInterface::isValid () const\fC [pure virtual]\fR" -Returns TRUE if all the data necessary to use this interface implementation is valid (e.g. all pointers are non-null), otherwise returns FALSE. -.SH "int QAccessibleInterface::navigate ( NavDirection direction, int startControl ) const\fC [pure virtual]\fR" -This function traverses to another object, or to a sub-element of the current object. \fIdirection\fR specifies in which direction to navigate, and \fIstartControl\fR specifies the start point of the navigation, which is either 0 if the navigation starts at the object itself, or an ID of one of the object's sub-elements. -.PP -The function returns the ID of the sub-element located in the \fIdirection\fR specified. If there is nothing in the navigated \fIdirection\fR, this function returns -1. -.PP -All objects support navigation. -.SH "QRESULT QAccessibleInterface::queryChild ( int control, QAccessibleInterface ** iface ) const\fC [pure virtual]\fR" -Sets \fIiface\fR to point to the implementation of the QAccessibleInterface for the child specified with \fIcontrol\fR. If the child doesn't provide accessibility information on it's own, the value of \fIiface\fR is set to 0. For those elements, this object is responsible for exposing the child's properties. -.PP -All objects provide this information. -.PP -See also childCount() and queryParent(). -.SH "QRESULT QAccessibleInterface::queryParent ( QAccessibleInterface ** iface ) const\fC [pure virtual]\fR" -Sets \fIiface\fR to point to the implementation of the QAccessibleInterface for the parent object, or to 0 if there is no such implementation or object. -.PP -All objects provide this information. -.PP -See also queryChild(). -.SH "QRect QAccessibleInterface::rect ( int control ) const\fC [pure virtual]\fR" -Returns the location of the child specified with \fIcontrol\fR in screen coordinates. This function returns the location of the object itself if \fIcontrol\fR is 0. -.PP -All visual objects provide this information. -.SH "Role QAccessibleInterface::role ( int control ) const\fC [pure virtual]\fR" -Returns the role of the object if \fIcontrol\fR is 0, or the role of the object's sub-element with ID \fIcontrol\fR. The role of an object is usually static. All accessible objects have a role. -.PP -See also text(), state(), and selection(). -.SH "QMemArray QAccessibleInterface::selection () const\fC [pure virtual]\fR" -Returns the list of all the element IDs that are selected. -.PP -See also text(), role(), and state(). -.SH "bool QAccessibleInterface::setFocus ( int control )\fC [pure virtual]\fR" -Gives the focus to the child object specified by \fIcontrol\fR, or to the object itself if \fIcontrol\fR is 0. -.PP -Returns TRUE if the focus could be set; otherwise returns FALSE. -.SH "bool QAccessibleInterface::setSelected ( int control, bool on, bool extend )\fC [pure virtual]\fR" -Sets the selection of the child object with ID \fIcontrol\fR to \fIon\fR. If \fIextend\fR is TRUE, all child elements between the focused item and the specified child object have their selection set to \fIon\fR. -.PP -Returns TRUE if the selection could be set; otherwise returns FALSE. -.PP -See also setFocus() and clearSelection(). -.SH "void QAccessibleInterface::setText ( Text t, int control, const QString & text )\fC [pure virtual]\fR" -Sets the text property \fIt\fR of the child object \fIcontrol\fR to \fItext\fR. If \fIcontrol\fR is 0, the text property of the object itself is set. -.SH "State QAccessibleInterface::state ( int control ) const\fC [pure virtual]\fR" -Returns the current state of the object if \fIcontrol\fR is 0, or the state of the object's sub-element element with ID \fIcontrol\fR. All objects have a state. -.PP -See also text(), role(), and selection(). -.SH "QString QAccessibleInterface::text ( Text t, int control ) const\fC [pure virtual]\fR" -Returns a string property \fIt\fR of the child object specified by \fIcontrol\fR, or the string property of the object itself if \fIcontrol\fR is 0. -.PP -The \fIName\fR is a string used by clients to identify, find or announce an accessible object for the user. All objects must have a name that is unique within their container. -.PP -An accessible object's \fIDescription\fR provides textual information about an object's visual appearance. The description is primarily used to provide greater context for low-vision or blind users, but is also used for context searching or other applications. Not all objects have a description. An "OK" button would not need a description, but a toolbutton that shows a picture of a smiley would. -.PP -The \fIValue\fR of an accessible object represents visual information contained by the object, e.g. the text in a line edit. Usually, the value can be modified by the user. Not all objects have a value, e.g. static text labels don't, and some objects have a state that already is the value, e.g. toggle buttons. -.PP -The \fIHelp\fR text provides information about the function and usage of an accessible object. Not all objects provide this information. -.PP -An accessible object's \fIDefaultAction\fR describes the object's primary method of manipulation, and should be a verb or a short phrase, e.g. "Press" for a button. -.PP -The accelerator is a keyboard shortcut that activates the default action of the object. A keyboard shortcut is the underlined character in the text of a menu, menu item or control, and is either the character itself, or a combination of this character and a modifier key like ALT, CTRL or SHIFT. Command controls like tool buttons also have shortcut keys and usually display them in their tooltip. -.PP -See also role(), state(), and selection(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaccessibleinterface.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaccessibleinterface.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaccessibleobject.3qt b/doc/man/man3/qaccessibleobject.3qt deleted file mode 100644 index 3d16f1755..000000000 --- a/doc/man/man3/qaccessibleobject.3qt +++ /dev/null @@ -1,72 +0,0 @@ -'\" t -.TH QAccessibleObject 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 -QAccessibleObject \- Implements parts of the QAccessibleInterface for QObjects -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject and QAccessibleInterface. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAccessibleObject\fR ( QObject * object )" -.br -.ti -1c -.BI "virtual \fB~QAccessibleObject\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "QObject * \fBobject\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QAccessibleObject class implements parts of the QAccessibleInterface for QObjects. -.PP -This class is mainly provided for convenience. All subclasses of the QAccessibleInterface should use this class as the base class. -.PP -See also Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAccessibleObject::QAccessibleObject ( QObject * object )" -Creates a QAccessibleObject for \fIobject\fR. -.SH "QAccessibleObject::~QAccessibleObject ()\fC [virtual]\fR" -Destroys the QAccessibleObject. -.PP -This only happens when a call to release() decrements the internal reference counter to zero. -.SH "QObject * QAccessibleObject::object () const\fC [protected]\fR" -Returns the QObject for which this QAccessibleInterface -implementation provides information. Use isValid() to make sure -the object pointer is safe to use. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaccessibleobject.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaccessibleobject.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaction.3qt b/doc/man/man3/qaction.3qt deleted file mode 100644 index 0b386e34b..000000000 --- a/doc/man/man3/qaction.3qt +++ /dev/null @@ -1,536 +0,0 @@ -'\" t -.TH QAction 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 -QAction \- Abstract user interface action that can appear both in menus and tool bars -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -Inherited by QActionGroup. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAction\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQAction\fR ( const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQAction\fR ( const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "QAction ( const QString & text, const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QAction ( const QString & text, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QAction ( QObject * parent, const char * name, bool toggle ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "\fB~QAction\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetIconSet\fR ( const QIconSet & )" -.br -.ti -1c -.BI "QIconSet \fBiconSet\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMenuText\fR ( const QString & )" -.br -.ti -1c -.BI "QString \fBmenuText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetToolTip\fR ( const QString & )" -.br -.ti -1c -.BI "QString \fBtoolTip\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetStatusTip\fR ( const QString & )" -.br -.ti -1c -.BI "QString \fBstatusTip\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetWhatsThis\fR ( const QString & )" -.br -.ti -1c -.BI "QString \fBwhatsThis\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAccel\fR ( const QKeySequence & key )" -.br -.ti -1c -.BI "QKeySequence \fBaccel\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetToggleAction\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisToggleAction\fR () const" -.br -.ti -1c -.BI "bool \fBisOn\fR () const" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBisVisible\fR () const" -.br -.ti -1c -.BI "virtual bool \fBaddTo\fR ( QWidget * w )" -.br -.ti -1c -.BI "virtual bool \fBremoveFrom\fR ( QWidget * w )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBactivate\fR ()" -.br -.ti -1c -.BI "void \fBtoggle\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetOn\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetEnabled\fR ( bool )" -.br -.ti -1c -.BI "void \fBsetDisabled\fR ( bool disable )" -.br -.ti -1c -.BI "void \fBsetVisible\fR ( bool )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBactivated\fR ()" -.br -.ti -1c -.BI "void \fBtoggled\fR ( bool on )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QKeySequence \fBaccel\fR - the action's accelerator key" -.br -.ti -1c -.BI "bool \fBenabled\fR - whether the action is enabled" -.br -.ti -1c -.BI "QIconSet \fBiconSet\fR - the action's icon" -.br -.ti -1c -.BI "QString \fBmenuText\fR - the action's menu text" -.br -.ti -1c -.BI "bool \fBon\fR - whether a toggle action is on" -.br -.ti -1c -.BI "QString \fBstatusTip\fR - the action's status tip" -.br -.ti -1c -.BI "QString \fBtext\fR - the action's descriptive text" -.br -.ti -1c -.BI "bool \fBtoggleAction\fR - whether the action is a toggle action" -.br -.ti -1c -.BI "QString \fBtoolTip\fR - the action's tool tip" -.br -.ti -1c -.BI "bool \fBvisible\fR - whether the action can be seen (e.g. in menus and " "toolbars" ")" -.br -.ti -1c -.BI "QString \fBwhatsThis\fR - the action's ""What's This?"" help text" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBaddedTo\fR ( QWidget * actionWidget, QWidget * container )" -.br -.ti -1c -.BI "virtual void \fBaddedTo\fR ( int index, QPopupMenu * menu )" -.br -.in -1c -.SH DESCRIPTION -The QAction class provides an abstract user interface action that can appear both in menus and tool bars. -.PP -In GUI applications many commands can be invoked via a menu option, a toolbar button and a keyboard accelerator. Since the same action must be performed regardless of how the action was invoked, and since the menu and toolbar should be kept in sync, it is useful to represent a command as an \fIaction\fR. An action can be added to a menu and a toolbar and will automatically keep them in sync. For example, if the user presses a Bold toolbar button the Bold menu item will automatically be checked. -.PP -A QAction may contain an icon, a menu text, an accelerator, a status text, a whats this text and a tool tip. Most of these can be set in the constructor. They can also be set independently with setIconSet(), setText(), setMenuText(), setToolTip(), setStatusTip(), setWhatsThis() and setAccel(). -.PP -An action may be a toggle action e.g. a Bold toolbar button, or a command action, e.g. 'Open File' to invoke an open file dialog. Toggle actions emit the toggled() signal when their state changes. Both command and toggle actions emit the activated() signal when they are invoked. Use setToggleAction() to set an action's toggled status. To see if an action is a toggle action use isToggleAction(). A toggle action may be "on", isOn() returns TRUE, or "off", isOn() returns FALSE. -.PP -Actions are added to widgets (menus or toolbars) using addTo(), and removed using removeFrom(). -.PP -Once a QAction has been created it should be added to the relevant menu and toolbar and then connected to the slot which will perform the action. For example: -.PP -.nf -.br - fileOpenAction = new QAction( QPixmap( fileopen ), "&Open...", -.br - CTRL+Key_O, this, "open" ); -.br - connect( fileOpenAction, SIGNAL( activated() ) , this, SLOT( choose() ) ); -.fi -.PP -We create a "File Save" action with a menu text of "&Save" and \fICtrl+S\fR as the keyboard accelerator. We connect the fileSaveAction's activated() signal to our own save() slot. Note that at this point there is no menu or toolbar action, we'll add them next: -.PP -.nf -.br - QToolBar * fileTools = new QToolBar( this, "file operations" ); -.fi -.PP -.nf -.br - fileSaveAction->addTo( fileTools ); -.fi -.PP -.nf -.br - QPopupMenu * file = new QPopupMenu( this ); -.br - menuBar()->insertItem( "&File", file ); -.fi -.PP -.nf -.br - fileSaveAction->addTo( file ); -.fi -.PP -We create a toolbar and add our fileSaveAction to it. Similarly we create a menu, add a top-level menu item, and add our fileSaveAction. -.PP -We recommend that actions are created as children of the window that they are used in. In most cases actions will be children of the application's main window. -.PP -To prevent recursion, don't create an action as a child of a widget that the action is later added to. -.PP -See also Main Window and Related Classes and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAction::QAction ( QObject * parent, const char * name = 0 )" -Constructs an action called \fIname\fR with parent \fIparent\fR. -.PP -If \fIparent\fR is a QActionGroup, the new action inserts itself into \fIparent\fR. -.PP -For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. -.PP -\fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. -.SH "QAction::QAction ( const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" -This constructor results in an icon-less action with the the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. -.PP -If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. -.PP -For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. -.PP -The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for toolbuttons. You can override this by setting a specific description with setText(). The same text and \fIaccel\fR will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip(). -.PP -Call setToggleAction(TRUE) to make the action a toggle action. -.PP -\fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. -.SH "QAction::QAction ( const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" -This constructor creates an action with the following properties: the icon or iconset \fIicon\fR, the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. -.PP -If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. -.PP -For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. -.PP -The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for toolbuttons. You can override this by setting a specific description with setText(). The same text and \fIaccel\fR will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip(). -.PP -Call setToggleAction(TRUE) to make the action a toggle action. -.PP -\fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. -.SH "QAction::QAction ( const QString & text, const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This constructor creates an action with the following properties: the description \fItext\fR, the icon or iconset \fIicon\fR, the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. -.PP -If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. -.PP -For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. -.PP -The \fItext\fR and \fIaccel\fR will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip(). -.SH "QAction::QAction ( const QString & text, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This constructor results in an icon-less action with the description \fItext\fR, the menu text \fImenuText\fR and the keyboard accelerator \fIaccel\fR. Its parent is \fIparent\fR and it is called \fIname\fR. If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. -.PP -The action automatically becomes a member of \fIparent\fR if \fIparent\fR is a QActionGroup. -.PP -For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. -.PP -The \fItext\fR and \fIaccel\fR will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip(). -.SH "QAction::QAction ( QObject * parent, const char * name, bool toggle )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Constructs an action called \fIname\fR with parent \fIparent\fR. -.PP -If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. -.PP -If \fIparent\fR is a QActionGroup, the new action inserts itself into \fIparent\fR. -.PP -For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. -.SH "QAction::~QAction ()" -Destroys the object and frees allocated resources. -.SH "QKeySequence QAction::accel () const" -Returns the action's accelerator key. See the "accel" property for details. -.SH "void QAction::activate ()\fC [slot]\fR" -Activates the action and executes all connected slots. This only works for actions that are not toggle action. -.PP -See also toggle(). -.SH "void QAction::activated ()\fC [signal]\fR" -This signal is emitted when an action is activated by the user, e.g. when the user clicks a menu option or a toolbar button or presses an action's accelerator key combination. -.PP -Connect to this signal for command actions. Connect to the toggled() signal for toggle actions. -.PP -Examples: -.)l action/application.cpp, chart/chartform.cpp, and themes/themes.cpp. -.SH "bool QAction::addTo ( QWidget * w )\fC [virtual]\fR" -Adds this action to widget \fIw\fR. -.PP -Currently actions may be added to QToolBar and QPopupMenu widgets. -.PP -An action added to a tool bar is automatically displayed as a tool button; an action added to a pop up menu appears as a menu option. -.PP -addTo() returns TRUE if the action was added successfully and FALSE otherwise. (If \fIw\fR is not a QToolBar or QPopupMenu the action will not be added and FALSE will be returned.) -.PP -See also removeFrom(). -.PP -Examples: -.)l action/application.cpp, action/toggleaction/toggleaction.cpp, and chart/chartform.cpp. -.PP -Reimplemented in QActionGroup. -.SH "void QAction::addedTo ( QWidget * actionWidget, QWidget * container )\fC [virtual protected]\fR" -This function is called from the addTo() function when it has created a widget (\fIactionWidget\fR) for the action in the \fIcontainer\fR. -.SH "void QAction::addedTo ( int index, QPopupMenu * menu )\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function is called from the addTo() function when it has created a menu item at the index position \fIindex\fR in the popup menu \fImenu\fR. -.SH "QIconSet QAction::iconSet () const" -Returns the action's icon. See the "iconSet" property for details. -.SH "bool QAction::isEnabled () const" -Returns TRUE if the action is enabled; otherwise returns FALSE. See the "enabled" property for details. -.SH "bool QAction::isOn () const" -Returns TRUE if a toggle action is on; otherwise returns FALSE. See the "on" property for details. -.SH "bool QAction::isToggleAction () const" -Returns TRUE if the action is a toggle action; otherwise returns FALSE. See the "toggleAction" property for details. -.SH "bool QAction::isVisible () const" -Returns TRUE if the action can be seen (e.g. in menus and toolbars); otherwise returns FALSE. See the "visible" property for details. -.SH "QString QAction::menuText () const" -Returns the action's menu text. See the "menuText" property for details. -.SH "bool QAction::removeFrom ( QWidget * w )\fC [virtual]\fR" -Removes the action from widget \fIw\fR. -.PP -Returns TRUE if the action was removed successfully; otherwise returns FALSE. -.PP -See also addTo(). -.SH "void QAction::setAccel ( const QKeySequence & key )\fC [virtual]\fR" -Sets the action's accelerator key to \fIkey\fR. See the "accel" property for details. -.SH "void QAction::setDisabled ( bool disable )\fC [slot]\fR" -Disables the action if \fIdisable\fR is TRUE; otherwise enables the action. -.PP -See the enabled documentation for more information. -.SH "void QAction::setEnabled ( bool )\fC [virtual slot]\fR" -Sets whether the action is enabled. See the "enabled" property for details. -.SH "void QAction::setIconSet ( const QIconSet & )\fC [virtual]\fR" -Sets the action's icon. See the "iconSet" property for details. -.SH "void QAction::setMenuText ( const QString & )\fC [virtual]\fR" -Sets the action's menu text. See the "menuText" property for details. -.SH "void QAction::setOn ( bool )\fC [virtual slot]\fR" -Sets whether a toggle action is on. See the "on" property for details. -.SH "void QAction::setStatusTip ( const QString & )\fC [virtual]\fR" -Sets the action's status tip. See the "statusTip" property for details. -.SH "void QAction::setText ( const QString & )\fC [virtual]\fR" -Sets the action's descriptive text. See the "text" property for details. -.SH "void QAction::setToggleAction ( bool )\fC [virtual]\fR" -Sets whether the action is a toggle action. See the "toggleAction" property for details. -.SH "void QAction::setToolTip ( const QString & )\fC [virtual]\fR" -Sets the action's tool tip. See the "toolTip" property for details. -.SH "void QAction::setVisible ( bool )\fC [slot]\fR" -Sets whether the action can be seen (e.g. in menus and toolbars). See the "visible" property for details. -.SH "void QAction::setWhatsThis ( const QString & )\fC [virtual]\fR" -Sets the action's "What's This?" help text. See the "whatsThis" property for details. -.SH "QString QAction::statusTip () const" -Returns the action's status tip. See the "statusTip" property for details. -.SH "QString QAction::text () const" -Returns the action's descriptive text. See the "text" property for details. -.SH "void QAction::toggle ()\fC [slot]\fR" -Toggles the state of a toggle action. -.PP -See also on, activate(), toggled(), and toggleAction. -.SH "void QAction::toggled ( bool on )\fC [signal]\fR" -This signal is emitted when a toggle action changes state; command actions and QActionGroups don't emit toggled(). -.PP -The \fIon\fR argument denotes the new state: If \fIon\fR is TRUE the toggle action is switched on, and if \fIon\fR is FALSE the toggle action is switched off. -.PP -To trigger a user command depending on whether a toggle action has been switched on or off connect it to a slot that takes a bool to indicate the state, e.g. -.PP -.nf -.br - QMainWindow * window = new QMainWindow; -.fi -.PP -.nf -.br - QAction * labelonoffaction = new QAction( window, "labelonoff" ); -.fi -.PP -.nf -.br - QObject::connect( labelonoffaction, SIGNAL( toggled( bool ) ), -.br - window, SLOT( setUsesTextLabel( bool ) ) ); -.fi -.PP -See also activated(), toggleAction, and on. -.PP -Example: action/toggleaction/toggleaction.cpp. -.SH "QString QAction::toolTip () const" -Returns the action's tool tip. See the "toolTip" property for details. -.SH "QString QAction::whatsThis () const" -Returns the action's "What's This?" help text. See the "whatsThis" property for details. -.SS "Property Documentation" -.SH "QKeySequence accel" -This property holds the action's accelerator key. -.PP -The keycodes can be found in Qt::Key and Qt::Modifier. There is no default accelerator key. -.PP -Set this property's value with setAccel() and get this property's value with accel(). -.SH "bool enabled" -This property holds whether the action is enabled. -.PP -Disabled actions can't be chosen by the user. They don't disappear from the menu/tool bar but are displayed in a way which indicates that they are unavailable, e.g. they might be displayed grayed out. -.PP -What's this? help on disabled actions is still available provided the QAction::whatsThis property is set. -.PP -Set this property's value with setEnabled() and get this property's value with isEnabled(). -.SH "QIconSet iconSet" -This property holds the action's icon. -.PP -The icon is used as the tool button icon and in the menu to the left of the menu text. There is no default icon. -.PP -If a null icon (QIconSet::isNull() is passed into this function, the icon of the action is cleared. -.PP -(See the action/toggleaction/toggleaction.cpp example.) -.PP -Set this property's value with setIconSet() and get this property's value with iconSet(). -.SH "QString menuText" -This property holds the action's menu text. -.PP -If the action is added to a menu the menu option will consist of the icon (if there is one), the menu text and the accelerator (if there is one). If the menu text is not explicitly set in the constructor or by using setMenuText() the action's description text will be used as the menu text. There is no default menu text. -.PP -See also text. -.PP -Set this property's value with setMenuText() and get this property's value with menuText(). -.SH "bool on" -This property holds whether a toggle action is on. -.PP -This property is always on (TRUE) for command actions and QActionGroups; setOn() has no effect on them. For action's where isToggleAction() is TRUE, this property's default value is off (FALSE). -.PP -See also toggleAction. -.PP -Set this property's value with setOn() and get this property's value with isOn(). -.SH "QString statusTip" -This property holds the action's status tip. -.PP -The statusTip is displayed on all status bars that this action's toplevel parent widget provides. -.PP -If no status tip is defined, the action uses the tool tip text. -.PP -There is no default statusTip text. -.PP -See also statusTip and toolTip. -.PP -Set this property's value with setStatusTip() and get this property's value with statusTip(). -.SH "QString text" -This property holds the action's descriptive text. -.PP -If QMainWindow::usesTextLabel is TRUE, the text appears as a label in the relevant tool button. It also serves as the default text in menus and tool tips if these have not been specifically defined. There is no default text. -.PP -See also menuText, toolTip, and statusTip. -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "bool toggleAction" -This property holds whether the action is a toggle action. -.PP -A toggle action is one which has an on/off state. For example a Bold toolbar button is either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. This property's default is FALSE. -.PP -In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and" Right Align" toggle actions are mutually exclusive. To achieve exclusive toggling, add the relevant toggle actions to a QActionGroup with the QActionGroup::exclusive property set to TRUE. -.PP -Set this property's value with setToggleAction() and get this property's value with isToggleAction(). -.SH "QString toolTip" -This property holds the action's tool tip. -.PP -This text is used for the tool tip. If no status tip has been set the tool tip will be used for the status tip. -.PP -If no tool tip is specified the action's text is used, and if that hasn't been specified the description text is used as the tool tip text. -.PP -There is no default tool tip text. -.PP -See also statusTip and accel. -.PP -Set this property's value with setToolTip() and get this property's value with toolTip(). -.SH "bool visible" -This property holds whether the action can be seen (e.g. in menus and toolbars). -.PP -If \fIvisible\fR is TRUE the action can be seen (e.g. in menus and toolbars) and chosen by the user; if \fIvisible\fR is FALSE the action cannot be seen or chosen by the user. -.PP -Actions which are not visible are \fInot\fR grayed out; they do not appear at all. -.PP -Set this property's value with setVisible() and get this property's value with isVisible(). -.SH "QString whatsThis" -This property holds the action's "What's This?" help text. -.PP -The whats this text is used to provide a brief description of the action. The text may contain rich text (HTML-like tags -- see QStyleSheet for the list of supported tags). There is no default" What's This" text. -.PP -See also QWhatsThis. -.PP -Set this property's value with setWhatsThis() and get this property's value with whatsThis(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqaction.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaction.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qactiongroup.3qt b/doc/man/man3/qactiongroup.3qt deleted file mode 100644 index f4db3f674..000000000 --- a/doc/man/man3/qactiongroup.3qt +++ /dev/null @@ -1,206 +0,0 @@ -'\" t -.TH QActionGroup 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 -QActionGroup \- Groups actions together -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QAction. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQActionGroup\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQActionGroup\fR ( QObject * parent, const char * name, bool exclusive )" -.br -.ti -1c -.BI "\fB~QActionGroup\fR ()" -.br -.ti -1c -.BI "void \fBsetExclusive\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisExclusive\fR () const" -.br -.ti -1c -.BI "void \fBadd\fR ( QAction * action )" -.br -.ti -1c -.BI "void \fBaddSeparator\fR ()" -.br -.ti -1c -.BI "virtual bool \fBaddTo\fR ( QWidget * w )" -.br -.ti -1c -.BI "void \fBsetUsesDropDown\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBusesDropDown\fR () const" -.br -.ti -1c -.BI "void insert ( QAction * a ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBselected\fR ( QAction * )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBexclusive\fR - whether the action group does exclusive toggling" -.br -.ti -1c -.BI "bool \fBusesDropDown\fR - whether the group's actions are displayed in a subwidget of the widgets the action group is added to" -.br -.in -1c -.SH DESCRIPTION -The QActionGroup class groups actions together. -.PP -In some situations it is useful to group actions together. For example, if you have a left justify action, a right justify action and a center action, only one of these actions should be active at any one time, and one simple way of achieving this is to group the actions together in an action group. -.PP -An action group can also be added to a menu or a toolbar as a single unit, with all the actions within the action group appearing as separate menu options and toolbar buttons. -.PP -Here's an example from examples/textedit: -.PP -.nf -.br - QActionGroup *grp = new QActionGroup( this ); -.br - connect( grp, SIGNAL( selected( QAction* ) ), this, SLOT( textAlign( QAction* ) ) ); -.fi -.PP -Here we create a new action group. Since the action group is exclusive by default, only one of the actions in the group is ever active at any one time. We then connect the group's selected() signal to our textAlign() slot. -.PP -.nf -.br - actionAlignLeft = new QAction( QPixmap::fromMimeSource( "textleft.xpm" ), tr( "&Left" ), CTRL + Key_L, grp, "textLeft" ); -.br - actionAlignLeft->setToggleAction( TRUE ); -.fi -.PP -We create a left align action, add it to the toolbar and the menu and make it a toggle action. We create center and right align actions in exactly the same way. -.PP -The actions in an action group emit their activated() (and for toggle actions, toggled()) signals as usual. -.PP -The setExclusive() function is used to ensure that only one action is active at any one time: it should be used with actions which have their toggleAction set to TRUE. -.PP -Action group actions appear as individual menu options and toolbar buttons. For exclusive action groups use setUsesDropDown() to display the actions in a subwidget of any widget the action group is added to. For example, the actions would appear in a combobox in a toolbar or as a submenu in a menu. -.PP -Actions can be added to an action group using add(), but normally they are added by creating the action with the action group as parent. Actions can have separators dividing them using addSeparator(). Action groups are added to widgets with addTo(). -.PP -See also Main Window and Related Classes and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QActionGroup::QActionGroup ( QObject * parent, const char * name = 0 )" -Constructs an action group called \fIname\fR, with parent \fIparent\fR. -.PP -The action group is exclusive by default. Call setExclusive(FALSE) to make the action group non-exclusive. -.SH "QActionGroup::QActionGroup ( QObject * parent, const char * name, bool exclusive )" -Constructs an action group called \fIname\fR, with parent \fIparent\fR. -.PP -If \fIexclusive\fR is TRUE only one toggle action in the group will ever be active. -.PP -See also exclusive. -.SH "QActionGroup::~QActionGroup ()" -Destroys the object and frees allocated resources. -.SH "void QActionGroup::add ( QAction * action )" -Adds action \fIaction\fR to this group. -.PP -Normally an action is added to a group by creating it with the group as parent, so this function is not usually used. -.PP -See also addTo(). -.SH "void QActionGroup::addSeparator ()" -Adds a separator to the group. -.SH "bool QActionGroup::addTo ( QWidget * w )\fC [virtual]\fR" -Adds this action group to the widget \fIw\fR. -.PP -If isExclusive() is FALSE or usesDropDown() is FALSE, the actions within the group are added to the widget individually. For example, if the widget is a menu, the actions will appear as individual menu options, and if the widget is a toolbar, the actions will appear as toolbar buttons. -.PP -If both isExclusive() and usesDropDown() are TRUE, the actions are presented either in a combobox (if \fIw\fR is a toolbar) or in a submenu (if \fIw\fR is a menu). -.PP -All actions should be added to the action group \fIbefore\fR the action group is added to the widget. If actions are added to the action group \fIafter\fR the action group has been added to the widget these later actions will \fInot\fR appear. -.PP -See also exclusive, usesDropDown, and removeFrom(). -.PP -Example: themes/themes.cpp. -.PP -Reimplemented from QAction. -.SH "void QActionGroup::insert ( QAction * a )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use add() instead, or better still create the action with the action group as its parent. -.SH "bool QActionGroup::isExclusive () const" -Returns TRUE if the action group does exclusive toggling; otherwise returns FALSE. See the "exclusive" property for details. -.SH "void QActionGroup::selected ( QAction * )\fC [signal]\fR" -This signal is emitted from exclusive groups when toggle actions change state. -.PP -The argument is the action whose state changed to "on". -.PP -See also exclusive, on, and QAction::toggled(). -.PP -Examples: -.)l chart/chartform.cpp and textedit/textedit.cpp. -.SH "void QActionGroup::setExclusive ( bool )" -Sets whether the action group does exclusive toggling. See the "exclusive" property for details. -.SH "void QActionGroup::setUsesDropDown ( bool enable )" -Sets whether the group's actions are displayed in a subwidget of the widgets the action group is added to to \fIenable\fR. See the "usesDropDown" property for details. -.SH "bool QActionGroup::usesDropDown () const" -Returns TRUE if the group's actions are displayed in a subwidget of the widgets the action group is added to; otherwise returns FALSE. See the "usesDropDown" property for details. -.SS "Property Documentation" -.SH "bool exclusive" -This property holds whether the action group does exclusive toggling. -.PP -If exclusive is TRUE only one toggle action in the action group can ever be active at any one time. If the user chooses another toggle action in the group the one they chose becomes active and the one that was active becomes inactive. -.PP -See also QAction::toggleAction. -.PP -Set this property's value with setExclusive() and get this property's value with isExclusive(). -.SH "bool usesDropDown" -This property holds whether the group's actions are displayed in a subwidget of the widgets the action group is added to. -.PP -Exclusive action groups added to a toolbar display their actions in a combobox with the action's QAction::text and QAction::iconSet properties shown. Non-exclusive groups are represented by a tool button showing their QAction::iconSet and -- depending on QMainWindow::usesTextLabel() -- text() property. -.PP -In a popup menu the member actions are displayed in a submenu. -.PP -Changing usesDropDown only affects \fIsubsequent\fR calls to addTo(). -.PP -Note that setting this property for actions in a combobox causes calls to their QAction::setVisible(), QAction::setEnabled(), and QAction::setDisabled() functions to have no effect. -.PP -This property's default is FALSE. -.PP -Set this property's value with setUsesDropDown() and get this property's value with usesDropDown(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qactiongroup.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qactiongroup.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qapplication.3qt b/doc/man/man3/qapplication.3qt deleted file mode 100644 index 94f3ff327..000000000 --- a/doc/man/man3/qapplication.3qt +++ /dev/null @@ -1,1990 +0,0 @@ -'\" t -.TH QApplication 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 -QApplication \- Manages the GUI application's control flow and main settings -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQApplication\fR ( int & argc, char ** argv )" -.br -.ti -1c -.BI "\fBQApplication\fR ( int & argc, char ** argv, bool GUIenabled )" -.br -.ti -1c -.BI "enum \fBType\fR { Tty, GuiClient, GuiServer }" -.br -.ti -1c -.BI "\fBQApplication\fR ( int & argc, char ** argv, Type type )" -.br -.ti -1c -.BI "\fBQApplication\fR ( Display * dpy, HANDLE visual = 0, HANDLE colormap = 0 )" -.br -.ti -1c -.BI "\fBQApplication\fR ( Display * dpy, int argc, char ** argv, HANDLE visual = 0, HANDLE colormap = 0 )" -.br -.ti -1c -.BI "virtual \fB~QApplication\fR ()" -.br -.ti -1c -.BI "int \fBargc\fR () const" -.br -.ti -1c -.BI "char ** \fBargv\fR () const" -.br -.ti -1c -.BI "Type \fBtype\fR () const" -.br -.ti -1c -.BI "enum \fBColorSpec\fR { NormalColor = 0, CustomColor = 1, ManyColor = 2 }" -.br -.ti -1c -.BI "QWidget * \fBmainWidget\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMainWidget\fR ( QWidget * mainWidget )" -.br -.ti -1c -.BI "virtual void \fBpolish\fR ( QWidget * w )" -.br -.ti -1c -.BI "QWidget * \fBfocusWidget\fR () const" -.br -.ti -1c -.BI "QWidget * \fBactiveWindow\fR () const" -.br -.ti -1c -.BI "int \fBexec\fR ()" -.br -.ti -1c -.BI "void \fBprocessEvents\fR ()" -.br -.ti -1c -.BI "void \fBprocessEvents\fR ( int maxtime )" -.br -.ti -1c -.BI "void processOneEvent () \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBhasPendingEvents\fR ()" -.br -.ti -1c -.BI "int enter_loop () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void exit_loop () \fI(obsolete)\fR" -.br -.ti -1c -.BI "int loopLevel () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual bool \fBnotify\fR ( QObject * receiver, QEvent * e )" -.br -.ti -1c -.BI "void setDefaultCodec ( QTextCodec * codec ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QTextCodec * defaultCodec () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBinstallTranslator\fR ( QTranslator * mf )" -.br -.ti -1c -.BI "void \fBremoveTranslator\fR ( QTranslator * mf )" -.br -.ti -1c -.BI "enum \fBEncoding\fR { DefaultCodec, UnicodeUTF8 }" -.br -.ti -1c -.BI "QString \fBtranslate\fR ( const char * context, const char * sourceText, const char * comment = 0, Encoding encoding = DefaultCodec ) const" -.br -.ti -1c -.BI "QString \fBapplicationDirPath\fR ()" -.br -.ti -1c -.BI "QString \fBapplicationFilePath\fR ()" -.br -.ti -1c -.BI "virtual bool \fBmacEventFilter\fR ( EventHandlerCallRef, EventRef )" -.br -.ti -1c -.BI "virtual bool \fBwinEventFilter\fR ( MSG * )" -.br -.ti -1c -.BI "virtual bool \fBx11EventFilter\fR ( XEvent * )" -.br -.ti -1c -.BI "int \fBx11ProcessEvent\fR ( XEvent * event )" -.br -.ti -1c -.BI "virtual bool \fBqwsEventFilter\fR ( QWSEvent * )" -.br -.ti -1c -.BI "void \fBqwsSetCustomColors\fR ( QRgb * colorTable, int start, int numColors )" -.br -.ti -1c -.BI "void \fBwinFocus\fR ( QWidget * widget, bool gotFocus )" -.br -.ti -1c -.BI "bool \fBisSessionRestored\fR () const" -.br -.ti -1c -.BI "QString \fBsessionId\fR () const" -.br -.ti -1c -.BI "QString \fBsessionKey\fR () const" -.br -.ti -1c -.BI "virtual void \fBcommitData\fR ( QSessionManager & sm )" -.br -.ti -1c -.BI "virtual void \fBsaveState\fR ( QSessionManager & sm )" -.br -.ti -1c -.BI "void \fBwakeUpGuiThread\fR ()" -.br -.ti -1c -.BI "void \fBlock\fR ()" -.br -.ti -1c -.BI "void \fBunlock\fR ( bool wakeUpGui = TRUE )" -.br -.ti -1c -.BI "bool \fBlocked\fR ()" -.br -.ti -1c -.BI "bool \fBtryLock\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBquit\fR ()" -.br -.ti -1c -.BI "void \fBcloseAllWindows\fR ()" -.br -.ti -1c -.BI "void \fBaboutTQt\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBlastWindowClosed\fR ()" -.br -.ti -1c -.BI "void \fBaboutToQuit\fR ()" -.br -.ti -1c -.BI "void \fBguiThreadAwake\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QStyle & \fBstyle\fR ()" -.br -.ti -1c -.BI "void \fBsetStyle\fR ( QStyle * style )" -.br -.ti -1c -.BI "QStyle * \fBsetStyle\fR ( const QString & style )" -.br -.ti -1c -.BI "int \fBcolorSpec\fR ()" -.br -.ti -1c -.BI "void \fBsetColorSpec\fR ( int spec )" -.br -.ti -1c -.BI "QCursor * \fBoverrideCursor\fR ()" -.br -.ti -1c -.BI "void \fBsetOverrideCursor\fR ( const QCursor & cursor, bool replace = FALSE )" -.br -.ti -1c -.BI "void \fBrestoreOverrideCursor\fR ()" -.br -.ti -1c -.BI "bool \fBhasGlobalMouseTracking\fR ()" -.br -.ti -1c -.BI "void \fBsetGlobalMouseTracking\fR ( bool enable )" -.br -.ti -1c -.BI "QPalette \fBpalette\fR ( const QWidget * w = 0 )" -.br -.ti -1c -.BI "void \fBsetPalette\fR ( const QPalette & palette, bool informWidgets = FALSE, const char * className = 0 )" -.br -.ti -1c -.BI "QFont \fBfont\fR ( const QWidget * w = 0 )" -.br -.ti -1c -.BI "void \fBsetFont\fR ( const QFont & font, bool informWidgets = FALSE, const char * className = 0 )" -.br -.ti -1c -.BI "QFontMetrics \fBfontMetrics\fR ()" -.br -.ti -1c -.BI "QWidgetList * \fBallWidgets\fR ()" -.br -.ti -1c -.BI "QWidgetList * \fBtopLevelWidgets\fR ()" -.br -.ti -1c -.BI "QDesktopWidget * \fBdesktop\fR ()" -.br -.ti -1c -.BI "QWidget * \fBactivePopupWidget\fR ()" -.br -.ti -1c -.BI "QWidget * \fBactiveModalWidget\fR ()" -.br -.ti -1c -.BI "QClipboard * \fBclipboard\fR ()" -.br -.ti -1c -.BI "QWidget * \fBwidgetAt\fR ( int x, int y, bool child = FALSE )" -.br -.ti -1c -.BI "QWidget * \fBwidgetAt\fR ( const QPoint & pos, bool child = FALSE )" -.br -.ti -1c -.BI "QEventLoop * \fBeventLoop\fR ()" -.br -.ti -1c -.BI "void \fBexit\fR ( int retcode = 0 )" -.br -.ti -1c -.BI "bool \fBsendEvent\fR ( QObject * receiver, QEvent * event )" -.br -.ti -1c -.BI "void \fBpostEvent\fR ( QObject * receiver, QEvent * event )" -.br -.ti -1c -.BI "void \fBsendPostedEvents\fR ( QObject * receiver, int event_type )" -.br -.ti -1c -.BI "void \fBsendPostedEvents\fR ()" -.br -.ti -1c -.BI "void \fBremovePostedEvents\fR ( QObject * receiver )" -.br -.ti -1c -.BI "bool \fBstartingUp\fR ()" -.br -.ti -1c -.BI "bool \fBclosingDown\fR ()" -.br -.ti -1c -.BI "void \fBflushX\fR ()" -.br -.ti -1c -.BI "void \fBflush\fR ()" -.br -.ti -1c -.BI "void \fBsyncX\fR ()" -.br -.ti -1c -.BI "void \fBbeep\fR ()" -.br -.ti -1c -.BI "void setWinStyleHighlightColor ( const QColor & c ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "const QColor & winStyleHighlightColor () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetDesktopSettingsAware\fR ( bool on )" -.br -.ti -1c -.BI "bool \fBdesktopSettingsAware\fR ()" -.br -.ti -1c -.BI "void \fBsetCursorFlashTime\fR ( int msecs )" -.br -.ti -1c -.BI "int \fBcursorFlashTime\fR ()" -.br -.ti -1c -.BI "void \fBsetDoubleClickInterval\fR ( int ms )" -.br -.ti -1c -.BI "int \fBdoubleClickInterval\fR ()" -.br -.ti -1c -.BI "void \fBsetWheelScrollLines\fR ( int n )" -.br -.ti -1c -.BI "int \fBwheelScrollLines\fR ()" -.br -.ti -1c -.BI "void \fBsetGlobalStrut\fR ( const QSize & strut )" -.br -.ti -1c -.BI "QSize \fBglobalStrut\fR ()" -.br -.ti -1c -.BI "void \fBsetLibraryPaths\fR ( const QStringList & paths )" -.br -.ti -1c -.BI "QStringList \fBlibraryPaths\fR ()" -.br -.ti -1c -.BI "void \fBaddLibraryPath\fR ( const QString & path )" -.br -.ti -1c -.BI "void \fBremoveLibraryPath\fR ( const QString & path )" -.br -.ti -1c -.BI "void \fBsetStartDragTime\fR ( int ms )" -.br -.ti -1c -.BI "int \fBstartDragTime\fR ()" -.br -.ti -1c -.BI "void \fBsetStartDragDistance\fR ( int l )" -.br -.ti -1c -.BI "int \fBstartDragDistance\fR ()" -.br -.ti -1c -.BI "void \fBsetReverseLayout\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBreverseLayout\fR ()" -.br -.ti -1c -.BI "int \fBhorizontalAlignment\fR ( int align )" -.br -.ti -1c -.BI "bool \fBisEffectEnabled\fR ( Qt::UIEffect effect )" -.br -.ti -1c -.BI "void \fBsetEffectEnabled\fR ( Qt::UIEffect effect, bool enable = TRUE )" -.br -.ti -1c -.BI "QWSDecoration & \fBqwsDecoration\fR ()" -.br -.ti -1c -.BI "void \fBqwsSetDecoration\fR ( QWSDecoration * d )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "void \fBqAddPostRoutine\fR ( QtCleanUpFunction p )" -.br -.ti -1c -.BI "const char * \fBqVersion\fR ()" -.br -.ti -1c -.BI "bool \fBqSysInfo\fR ( int * wordSize, bool * bigEndian )" -.br -.ti -1c -.BI "void \fBqDebug\fR ( const char * msg, ... )" -.br -.ti -1c -.BI "void \fBqWarning\fR ( const char * msg, ... )" -.br -.ti -1c -.BI "void \fBqFatal\fR ( const char * msg, ... )" -.br -.ti -1c -.BI "void \fBqSystemWarning\fR ( const char * msg, int code )" -.br -.ti -1c -.BI "void \fBQ_ASSERT\fR ( bool test )" -.br -.ti -1c -.BI "void \fBTQ_CHECK_PTR\fR ( void * p )" -.br -.ti -1c -.BI "QtMsgHandler \fBqInstallMsgHandler\fR ( QtMsgHandler h )" -.br -.in -1c -.SH DESCRIPTION -The QApplication class manages the GUI application's control flow and main settings. -.PP -It contains the main event loop, where all events from the window system and other sources are processed and dispatched. It also handles the application's initialization and finalization, and provides session management. It also handles most system-wide and application-wide settings. -.PP -For any GUI application that uses Qt, there is precisely one QApplication object, no matter whether the application has 0, 1, 2 or more windows at any time. -.PP -The QApplication object is accessible through the global pointer \fCqApp\fR. Its main areas of responsibility are: -.IP -.TP -It initializes the application with the user's desktop settings such as palette(), font() and doubleClickInterval(). It keeps track of these properties in case the user changes the desktop globally, for example through some kind of control panel. -.IP -.TP -It performs event handling, meaning that it receives events from the underlying window system and dispatches them to the relevant widgets. By using sendEvent() and postEvent() you can send your own events to widgets. -.IP -.TP -It parses common command line arguments and sets its internal state accordingly. See the constructor documentation below for more details about this. -.IP -.TP -It defines the application's look and feel, which is encapsulated in a QStyle object. This can be changed at runtime with setStyle(). -.IP -.TP -It specifies how the application is to allocate colors. See setColorSpec() for details. -.IP -.TP -It provides localization of strings that are visible to the user via translate(). -.IP -.TP -It provides some magical objects like the desktop() and the clipboard(). -.IP -.TP -It knows about the application's windows. You can ask which widget is at a certain position using widgetAt(), get a list of topLevelWidgets() and closeAllWindows(), etc. -.IP -.TP -It manages the application's mouse cursor handling, see setOverrideCursor() and setGlobalMouseTracking(). -.IP -.TP -On the X window system, it provides functions to flush and sync the communication stream, see flushX() and syncX(). -.IP -.TP -It provides support for sophisticated session management. This makes it possible for applications to terminate gracefully when the user logs out, to cancel a shutdown process if termination isn't possible and even to preserve the entire application's state for a future session. See isSessionRestored(), sessionId() and commitData() and saveState() for details. -.IP -.PP -The Application walk-through example contains a typical complete main() that does the usual things with QApplication. -.PP -Since the QApplication object does so much initialization, it \fBmust\fR be created before any other objects related to the user interface are created. -.PP -Since it also deals with common command line arguments, it is usually a good idea to create it \fIbefore\fR any interpretation or modification of \fCargv\fR is done in the application itself. (Note also that for X11, setMainWidget() may change the main widget according to the \fC-geometry\fR option. To preserve this functionality, you must set your defaults before setMainWidget() and any overrides after.) -.PP -
.nf -.TS -l - l. Groups of functions System settings desktopSettingsAware(), setDesktopSettingsAware(), cursorFlashTime(), setCursorFlashTime(), doubleClickInterval(), setDoubleClickInterval(), wheelScrollLines(), setWheelScrollLines(), palette(), setPalette(), font(), setFont(), fontMetrics(). Event handling exec(), processEvents(), enter_loop(), exit_loop(), exit(), quit(). sendEvent(), postEvent(), sendPostedEvents(), removePostedEvents(), hasPendingEvents(), notify(), macEventFilter(), qwsEventFilter(), x11EventFilter(), x11ProcessEvent(), winEventFilter(). GUI Styles style(), setStyle(), polish(). Color usage colorSpec(), setColorSpec(), qwsSetCustomColors(). Text handling installTranslator(), removeTranslator() translate(). Widgets mainWidget(), setMainWidget(), allWidgets(), topLevelWidgets(), desktop(), activePopupWidget(), activeModalWidget(), clipboard(), focusWidget(), winFocus(), activeWindow(), widgetAt(). Advanced cursor handling hasGlobalMouseTracking(), setGlobalMouseTracking(), overrideCursor(), setOverrideCursor(), restoreOverrideCursor(). X Window System synchronization flushX(), syncX(). Session management isSessionRestored(), sessionId(), commitData(), saveState(). Threading lock(), unlock(), locked(), tryLock(), wakeUpGuiThread() Miscellaneous -.TE -.fi -
-.PP -\fINon-GUI programs:\fR While Qt is not optimized or designed for writing non-GUI programs, it's possible to use some of its classes without creating a QApplication. This can be useful if you wish to share code between a non-GUI server and a GUI client. -.PP -See also Main Window and Related Classes. -.SS "Member Type Documentation" -.SH "QApplication::ColorSpec" -.TP -\fCQApplication::NormalColor\fR - the default color allocation policy -.TP -\fCQApplication::CustomColor\fR - the same as NormalColor for X11; allocates colors to a palette on demand under Windows -.TP -\fCQApplication::ManyColor\fR - the right choice for applications that use thousands of colors -.PP -See setColorSpec() for full details. -.SH "QApplication::Encoding" -This enum type defines the 8-bit encoding of character string arguments to translate(): -.TP -\fCQApplication::DefaultCodec\fR - the encoding specified by QTextCodec::codecForTr() (Latin-1 if none has been set) -.TP -\fCQApplication::UnicodeUTF8\fR - UTF-8 -.PP -See also QObject::tr(), QObject::trUtf8(), and QString::fromUtf8(). -.SH "QApplication::Type" -.TP -\fCQApplication::Tty\fR - a console application -.TP -\fCQApplication::GuiClient\fR - a GUI client application -.TP -\fCQApplication::GuiServer\fR - a GUI server application -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QApplication::QApplication ( int & argc, char ** argv )" -Initializes the window system and constructs an application object with \fIargc\fR command line arguments in \fIargv\fR. -.PP -The global \fCqApp\fR pointer refers to this application object. Only one application object should be created. -.PP -This application object must be constructed before any paint devices (including widgets, pixmaps, bitmaps etc.). -.PP -Note that \fIargc\fR and \fIargv\fR might be changed. Qt removes command line arguments that it recognizes. The modified \fIargc\fR and \fIargv\fR can also be accessed later with \fCqApp->argc()\fR and \fCqApp->argv()\fR. The documentation for argv() contains a detailed description of how to process command line arguments. -.PP -Qt debugging options (not available if Qt was compiled with the QT_NO_DEBUG flag defined): -.TP --nograb, tells Qt that it must never grab the mouse or the keyboard. -.TP --dograb (only under X11), running under a debugger can cause an implicit -nograb, use -dograb to override. -.TP --sync (only under X11), switches to synchronous mode for debugging. -.PP -See Debugging Techniques for a more detailed explanation. -.PP -All Qt programs automatically support the following command line options: -.TP --reverse causes text to be formatted for right-to-left languages rather than in the usual left-to-right direction. -.TP --style= \fIstyle\fR, sets the application GUI style. Possible values are \fCmotif\fR, \fCwindows\fR, and \fCplatinum\fR. If you compiled Qt with additional styles or have additional styles as plugins these will be available to the \fC-style\fR command line option. -.TP --style \fIstyle\fR, is the same as listed above. -.TP --session= \fIsession\fR, restores the application from an earlier session. -.TP --session \fIsession\fR, is the same as listed above. -.TP --widgetcount, prints debug message at the end about number of widgets left undestroyed and maximum number of widgets existed at the same time -.PP -The X11 version of Qt also supports some traditional X11 command line options: -.TP --display \fIdisplay\fR, sets the X display (default is $DISPLAY). -.TP --geometry \fIgeometry\fR, sets the client geometry of the main widget. -.TP --fn or \fC-font\fR \fIfont\fR, defines the application font. The font should be specified using an X logical font description. -.TP --bg or \fC-background\fR \fIcolor\fR, sets the default background color and an application palette (light and dark shades are calculated). -.TP --fg or \fC-foreground\fR \fIcolor\fR, sets the default foreground color. -.TP --btn or \fC-button\fR \fIcolor\fR, sets the default button color. -.TP --name \fIname\fR, sets the application name. -.TP --title \fItitle\fR, sets the application title (caption). -.TP --visual \fCTrueColor\fR, forces the application to use a TrueColor visual on an 8-bit display. -.TP --ncols \fIcount\fR, limits the number of colors allocated in the color cube on an 8-bit display, if the application is using the QApplication::ManyColor color specification. If \fIcount\fR is 216 then a 6x6x6 color cube is used (i.e. 6 levels of red, 6 of green, and 6 of blue); for other values, a cube approximately proportional to a 2x3x1 cube is used. -.TP --cmap, causes the application to install a private color map on an 8-bit display. -.PP -See also argc() and argv(). -.SH "QApplication::QApplication ( int & argc, char ** argv, bool GUIenabled )" -Constructs an application object with \fIargc\fR command line arguments in \fIargv\fR. If \fIGUIenabled\fR is TRUE, a GUI application is constructed, otherwise a non-GUI (console) application is created. -.PP -Set \fIGUIenabled\fR to FALSE for programs without a graphical user interface that should be able to run without a window system. -.PP -On X11, the window system is initialized if \fIGUIenabled\fR is TRUE. If \fIGUIenabled\fR is FALSE, the application does not connect to the X-server. On Windows and Macintosh, currently the window system is always initialized, regardless of the value of GUIenabled. This may change in future versions of Qt. -.PP -The following example shows how to create an application that uses a graphical interface when available. -.PP -.nf -.br - int main( int argc, char **argv ) -.br - { -.br -#ifdef Q_WS_X11 -.br - bool useGUI = getenv( "DISPLAY" ) != 0; -.br -#else -.br - bool useGUI = TRUE; -.br -#endif -.br - QApplication app(argc, argv, useGUI); -.br -.br - if ( useGUI ) { -.br - //start GUI version -.br - ... -.br - } else { -.br - //start non-GUI version -.br - ... -.br - } -.br - return app.exec(); -.br - } -.fi -.SH "QApplication::QApplication ( int & argc, char ** argv, Type type )" -Constructs an application object with \fIargc\fR command line arguments in \fIargv\fR. -.PP -For Qt/Embedded, passing QApplication::GuiServer for \fItype\fR makes this application the server (equivalent to running with the -qws option). -.SH "QApplication::QApplication ( Display * dpy, HANDLE visual = 0, HANDLE colormap = 0 )" -Create an application, given an already open display \fIdpy\fR. If \fIvisual\fR and \fIcolormap\fR are non-zero, the application will use those as the default Visual and Colormap contexts. -.PP -\fBWarning:\fR Qt only supports TrueColor visuals at depths higher than 8 bits-per-pixel. -.PP -This is available only on X11. -.SH "QApplication::QApplication ( Display * dpy, int argc, char ** argv, HANDLE visual = 0, HANDLE colormap = 0 )" -Create an application, given an already open display \fIdpy\fR and using \fIargc\fR command line arguments in \fIargv\fR. If \fIvisual\fR and \fIcolormap\fR are non-zero, the application will use those as the default Visual and Colormap contexts. -.PP -\fBWarning:\fR Qt only supports TrueColor visuals at depths higher than 8 bits-per-pixel. -.PP -This is available only on X11. -.SH "QApplication::~QApplication ()\fC [virtual]\fR" -Cleans up any window system resources that were allocated by this application. Sets the global variable \fCqApp\fR to 0. -.SH "void QApplication::aboutTQt ()\fC [slot]\fR" -Displays a simple message box about Qt. The message includes the version number of Qt being used by the application. -.PP -This is useful for inclusion in the Help menu of an application. See the examples/menu/menu.cpp example. -.PP -This function is a convenience slot for QMessageBox::aboutTQt(). -.SH "void QApplication::aboutToQuit ()\fC [signal]\fR" -This signal is emitted when the application is about to quit the main event loop, e.g. when the event loop level drops to zero. This may happen either after a call to quit() from inside the application or when the users shuts down the entire desktop session. -.PP -The signal is particularly useful if your application has to do some last-second cleanup. Note that no user interaction is possible in this state. -.PP -See also quit(). -.SH "QWidget * QApplication::activeModalWidget ()\fC [static]\fR" -Returns the active modal widget. -.PP -A modal widget is a special top level widget which is a subclass of QDialog that specifies the modal parameter of the constructor as TRUE. A modal widget must be closed before the user can continue with other parts of the program. -.PP -Modal widgets are organized in a stack. This function returns the active modal widget at the top of the stack. -.PP -See also activePopupWidget() and topLevelWidgets(). -.SH "QWidget * QApplication::activePopupWidget ()\fC [static]\fR" -Returns the active popup widget. -.PP -A popup widget is a special top level widget that sets the WType_Popup widget flag, e.g. the QPopupMenu widget. When the application opens a popup widget, all events are sent to the popup. Normal widgets and modal widgets cannot be accessed before the popup widget is closed. -.PP -Only other popup widgets may be opened when a popup widget is shown. The popup widgets are organized in a stack. This function returns the active popup widget at the top of the stack. -.PP -See also activeModalWidget() and topLevelWidgets(). -.SH "QWidget * QApplication::activeWindow () const" -Returns the application top-level window that has the keyboard input focus, or 0 if no application window has the focus. Note that there might be an activeWindow() even if there is no focusWidget(), for example if no widget in that window accepts key events. -.PP -See also QWidget::setFocus(), QWidget::focus, and focusWidget(). -.PP -Example: network/mail/smtp.cpp. -.SH "void QApplication::addLibraryPath ( const QString & path )\fC [static]\fR" -Append \fIpath\fR to the end of the library path list. If \fIpath\fR is empty or already in the path list, the path list is not changed. -.PP -The default path list consists of a single entry, the installation directory for plugins. The default installation directory for plugins is \fCINSTALL/plugins\fR, where \fCINSTALL\fR is the directory where Qt was installed. -.PP -See also removeLibraryPath(), libraryPaths(), and setLibraryPaths(). -.SH "QWidgetList * QApplication::allWidgets ()\fC [static]\fR" -Returns a list of all the widgets in the application. -.PP -The list is created using \fCnew\fR and must be deleted by the caller. -.PP -The list is empty (QPtrList::isEmpty()) if there are no widgets. -.PP -Note that some of the widgets may be hidden. -.PP -Example that updates all widgets: -.PP -.nf -.br - QWidgetList *list = QApplication::allWidgets(); -.br - QWidgetListIt it( *list ); // iterate over the widgets -.br - QWidget * w; -.br - while ( (w=it.current()) != 0 ) { // for each widget... -.br - ++it; -.br - w->update(); -.br - } -.br - delete list; // delete the list, not the widgets -.br -.fi -.PP -The QWidgetList class is defined in the \fCntqwidgetlist.h\fR header file. -.PP -\fBWarning:\fR Delete the list as soon as you have finished using it. The widgets in the list may be deleted by someone else at any time. -.PP -See also topLevelWidgets(), QWidget::visible, and QPtrList::isEmpty(). -.SH "QString QApplication::applicationDirPath ()" -Returns the directory that contains the application executable. -.PP -For example, if you have installed Qt in the \fCC:\Trolltech\Qt\fR directory, and you run the \fCdemo\fR example, this function will return "C:/Trolltech/Qt/examples/demo". -.PP -On Mac OS X this will point to the directory actually containing the executable, which may be inside of an application bundle (if the application is bundled). -.PP -\fBWarning:\fR On Unix, this function assumes that argv[0] contains the file name of the executable (which it normally does). It also assumes that the current directory hasn't been changed by the application. -.PP -See also applicationFilePath(). -.SH "QString QApplication::applicationFilePath ()" -Returns the file path of the application executable. -.PP -For example, if you have installed Qt in the \fCC:\Trolltech\Qt\fR directory, and you run the \fCdemo\fR example, this function will return "C:/Trolltech/Qt/examples/demo/demo.exe". -.PP -\fBWarning:\fR On Unix, this function assumes that argv[0] contains the file name of the executable (which it normally does). It also assumes that the current directory hasn't been changed by the application. -.PP -See also applicationDirPath(). -.SH "int QApplication::argc () const" -Returns the number of command line arguments. -.PP -The documentation for argv() describes how to process command line arguments. -.PP -See also argv() and QApplication::QApplication(). -.PP -Examples: -.)l chart/main.cpp and scribble/scribble.cpp. -.SH "char ** QApplication::argv () const" -Returns the command line argument vector. -.PP -\fCargv()[0]\fR is the program name, \fCargv()[1]\fR is the first argument and \fCargv()[argc()-1]\fR is the last argument. -.PP -A QApplication object is constructed by passing \fIargc\fR and \fIargv\fR from the \fCmain()\fR function. Some of the arguments may be recognized as Qt options and removed from the argument vector. For example, the X11 version of Qt knows about \fC-display\fR, \fC-font\fR and a few more options. -.PP -Example: -.PP -.nf -.br - // showargs.cpp - displays program arguments in a list box -.br -.br - #include -.br - #include -.br -.br - int main( int argc, char **argv ) -.br - { -.br - QApplication a( argc, argv ); -.br - QListBox b; -.br - a.setMainWidget( &b ); -.br - for ( int i = 0; i < a.argc(); i++ ) // a.argc() == argc -.br - b.insertItem( a.argv()[i] ); // a.argv()[i] == argv[i] -.br - b.show(); -.br - return a.exec(); -.br - } -.br -.fi -.PP -If you run \fCshowargs -display unix:0 -font 9x15bold hello world\fR under X11, the list box contains the three strings "showargs"," hello" and "world". -.PP -Qt provides a global pointer, \fCqApp\fR, that points to the QApplication object, and through which you can access argc() and argv() in functions other than main(). -.PP -See also argc() and QApplication::QApplication(). -.PP -Examples: -.)l chart/main.cpp and scribble/scribble.cpp. -.SH "void QApplication::beep ()\fC [static]\fR" -Sounds the bell, using the default volume and sound. -.SH "QClipboard * QApplication::clipboard ()\fC [static]\fR" -Returns a pointer to the application global clipboard. -.PP -Examples: -.)l regexptester/regexptester.cpp and showimg/showimg.cpp. -.SH "void QApplication::closeAllWindows ()\fC [slot]\fR" -Closes all top-level windows. -.PP -This function is particularly useful for applications with many top-level windows. It could, for example, be connected to a "Quit" entry in the file menu as shown in the following code example: -.PP -.nf -.br - // the "Quit" menu entry should try to close all windows -.br - QPopupMenu* file = new QPopupMenu( this ); -.br - file->insertItem( "&Quit", tqApp, SLOT(closeAllWindows()), CTRL+Key_Q ); -.br -.br - // when the last window is closed, the application should quit -.br - connect( tqApp, SIGNAL( lastWindowClosed() ), tqApp, SLOT( quit() ) ); -.br -.fi -.PP -The windows are closed in random order, until one window does not accept the close event. -.PP -See also QWidget::close(), QWidget::closeEvent(), lastWindowClosed(), quit(), topLevelWidgets(), and QWidget::isTopLevel. -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. -.SH "bool QApplication::closingDown ()\fC [static]\fR" -Returns TRUE if the application objects are being destroyed; otherwise returns FALSE. -.PP -See also startingUp(). -.SH "int QApplication::colorSpec ()\fC [static]\fR" -Returns the color specification. -.PP -See also QApplication::setColorSpec(). -.PP -Example: showimg/showimg.cpp. -.SH "void QApplication::commitData ( QSessionManager & sm )\fC [virtual]\fR" -This function deals with session management. It is invoked when the QSessionManager wants the application to commit all its data. -.PP -Usually this means saving all open files, after getting permission from the user. Furthermore you may want to provide a means by which the user can cancel the shutdown. -.PP -Note that you should not exit the application within this function. Instead, the session manager may or may not do this afterwards, depending on the context. -.PP -\fBWarning:\fR Within this function, no user interaction is possible, \fIunless\fR you ask the session manager \fIsm\fR for explicit permission. See QSessionManager::allowsInteraction() and QSessionManager::allowsErrorInteraction() for details and example usage. -.PP -The default implementation requests interaction and sends a close event to all visible top level widgets. If any event was rejected, the shutdown is canceled. -.PP -See also isSessionRestored(), sessionId(), saveState(), and the Session Management overview. -.SH "int QApplication::cursorFlashTime ()\fC [static]\fR" -Returns the text cursor's flash (blink) time in milliseconds. The flash time is the time required to display, invert and restore the caret display. -.PP -The default value on X11 is 1000 milliseconds. On Windows, the control panel value is used. -.PP -Widgets should not cache this value since it may be changed at any time by the user changing the global desktop settings. -.PP -See also setCursorFlashTime(). -.SH "QTextCodec * QApplication::defaultCodec () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns QTextCodec::codecForTr(). -.SH "QDesktopWidget * QApplication::desktop ()\fC [static]\fR" -Returns the desktop widget (also called the root window). -.PP -The desktop widget is useful for obtaining the size of the screen. It may also be possible to draw on the desktop. We recommend against assuming that it's possible to draw on the desktop, since this does not work on all operating systems. -.PP -.nf -.br - QDesktopWidget *d = QApplication::desktop(); -.br - int w = d->width(); // returns desktop width -.br - int h = d->height(); // returns desktop height -.br -.fi -.PP -Examples: -.)l canvas/main.cpp, desktop/desktop.cpp, helpviewer/main.cpp, i18n/main.cpp, qmag/qmag.cpp, qwerty/main.cpp, and scribble/main.cpp. -.SH "bool QApplication::desktopSettingsAware ()\fC [static]\fR" -Returns the value set by setDesktopSettingsAware(); by default TRUE. -.PP -See also setDesktopSettingsAware(). -.SH "int QApplication::doubleClickInterval ()\fC [static]\fR" -Returns the maximum duration for a double click. -.PP -The default value on X11 is 400 milliseconds. On Windows, the control panel value is used. -.PP -See also setDoubleClickInterval(). -.SH "int QApplication::enter_loop ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function enters the main event loop (recursively). Do not call it unless you really know what you are doing. -.PP -Use QApplication::eventLoop()->enterLoop() instead. -.SH "QEventLoop * QApplication::eventLoop ()\fC [static]\fR" -Returns the application event loop. This function will return zero if called during and after destroying QApplication. -.PP -To create your own instance of QEventLoop or QEventLoop subclass create it before you create the QApplication object. -.PP -See also QEventLoop. -.PP -Example: distributor/distributor.ui.h. -.SH "int QApplication::exec ()" -Enters the main event loop and waits until exit() is called or the main widget is destroyed, and returns the value that was set to exit() (which is 0 if exit() is called via quit()). -.PP -It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets. -.PP -Generally speaking, no user interaction can take place before calling exec(). As a special case, modal widgets like QMessageBox can be used before calling exec(), because modal widgets call exec() to start a local event loop. -.PP -To make your application perform idle processing, i.e. executing a special function whenever there are no pending events, use a QTimer with 0 timeout. More advanced idle processing schemes can be achieved using processEvents(). -.PP -See also quit(), exit(), processEvents(), and setMainWidget(). -.PP -Examples: -.)l helpsystem/main.cpp, life/main.cpp, network/archivesearch/main.cpp, network/ftpclient/main.cpp, opengl/main.cpp, t1/main.cpp, and t4/main.cpp. -.SH "void QApplication::exit ( int retcode = 0 )\fC [static]\fR" -Tells the application to exit with a return code. -.PP -After this function has been called, the application leaves the main event loop and returns from the call to exec(). The exec() function returns \fIretcode\fR. -.PP -By convention, a \fIretcode\fR of 0 means success, and any non-zero value indicates an error. -.PP -Note that unlike the C library function of the same name, this function \fIdoes\fR return to the caller -- it is event processing that stops. -.PP -See also quit() and exec(). -.PP -Examples: -.)l chart/chartform.cpp, extension/mainform.ui.h, and picture/picture.cpp. -.SH "void QApplication::exit_loop ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function exits from a recursive call to the main event loop. Do not call it unless you are an expert. -.PP -Use QApplication::eventLoop()->exitLoop() instead. -.SH "void QApplication::flush ()\fC [static]\fR" -Flushes the window system specific event queues. -.PP -If you are doing graphical changes inside a loop that does not return to the event loop on asynchronous window systems like X11 or double buffered window systems like MacOS X, and you want to visualize these changes immediately (e.g. Splash Screens), call this function. -.PP -See also flushX(), sendPostedEvents(), and QPainter::flush(). -.SH "void QApplication::flushX ()\fC [static]\fR" -Flushes the X event queue in the X11 implementation. This normally returns almost immediately. Does nothing on other platforms. -.PP -See also syncX(). -.PP -Example: xform/xform.cpp. -.SH "QWidget * QApplication::focusWidget () const" -Returns the application widget that has the keyboard input focus, or 0 if no widget in this application has the focus. -.PP -See also QWidget::setFocus(), QWidget::focus, and activeWindow(). -.SH "QFont QApplication::font ( const QWidget * w = 0 )\fC [static]\fR" -Returns the default font for the widget \fIw\fR, or the default application font if \fIw\fR is 0. -.PP -See also setFont(), fontMetrics(), and QWidget::font. -.PP -Examples: -.)l qfd/fontdisplayer.cpp, themes/metal.cpp, and themes/themes.cpp. -.SH "QFontMetrics QApplication::fontMetrics ()\fC [static]\fR" -Returns display (screen) font metrics for the application font. -.PP -See also font(), setFont(), QWidget::fontMetrics(), and QPainter::fontMetrics(). -.SH "QSize QApplication::globalStrut ()\fC [static]\fR" -Returns the application's global strut. -.PP -The strut is a size object whose dimensions are the minimum that any GUI element that the user can interact with should have. For example no button should be resized to be smaller than the global strut size. -.PP -See also setGlobalStrut(). -.SH "void QApplication::guiThreadAwake ()\fC [signal]\fR" -This signal is emitted after the event loop returns from a function that could block. -.PP -See also wakeUpGuiThread(). -.SH "bool QApplication::hasGlobalMouseTracking ()\fC [static]\fR" -Returns TRUE if global mouse tracking is enabled; otherwise returns FALSE. -.PP -See also setGlobalMouseTracking(). -.SH "bool QApplication::hasPendingEvents ()" -This function returns TRUE if there are pending events; otherwise returns FALSE. Pending events can be either from the window system or posted events using QApplication::postEvent(). -.SH "int QApplication::horizontalAlignment ( int align )\fC [static]\fR" -Strips out vertical alignment flags and transforms an alignment \fIalign\fR of AlignAuto into AlignLeft or AlignRight according to the language used. The other horizontal alignment flags are left untouched. -.SH "void QApplication::installTranslator ( QTranslator * mf )" -Adds the message file \fImf\fR to the list of message files to be used for translations. -.PP -Multiple message files can be installed. Translations are searched for in the last installed message file, then the one from last, and so on, back to the first installed message file. The search stops as soon as a matching translation is found. -.PP -See also removeTranslator(), translate(), and QTranslator::load(). -.PP -Example: i18n/main.cpp. -.SH "bool QApplication::isEffectEnabled ( Qt::UIEffect effect )\fC [static]\fR" -Returns TRUE if \fIeffect\fR is enabled; otherwise returns FALSE. -.PP -By default, Qt will try to use the desktop settings. Call setDesktopSettingsAware(FALSE) to prevent this. -.PP -Note: All effects are disabled on screens running at less than 16-bit color depth. -.PP -See also setEffectEnabled() and Qt::UIEffect. -.SH "bool QApplication::isSessionRestored () const" -Returns TRUE if the application has been restored from an earlier session; otherwise returns FALSE. -.PP -See also sessionId(), commitData(), and saveState(). -.SH "void QApplication::lastWindowClosed ()\fC [signal]\fR" -This signal is emitted when the user has closed the last top level window. -.PP -The signal is very useful when your application has many top level widgets but no main widget. You can then connect it to the quit() slot. -.PP -For convenience, this signal is \fInot\fR emitted for transient top level widgets such as popup menus and dialogs. -.PP -See also mainWidget(), topLevelWidgets(), QWidget::isTopLevel, and QWidget::close(). -.PP -Examples: -.)l addressbook/main.cpp, extension/main.cpp, helpviewer/main.cpp, mdi/main.cpp, network/archivesearch/main.cpp, qwerty/main.cpp, and regexptester/main.cpp. -.SH "QStringList QApplication::libraryPaths ()\fC [static]\fR" -Returns a list of paths that the application will search when dynamically loading libraries. The installation directory for plugins is the only entry if no paths have been set. The default installation directory for plugins is \fCINSTALL/plugins\fR, where \fCINSTALL\fR is the directory where Qt was installed. The directory of the application executable (NOT the working directory) is also added to the plugin paths. -.PP -If you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = app.libraryPaths(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See the plugins documentation for a description of how the library paths are used. -.PP -See also setLibraryPaths(), addLibraryPath(), removeLibraryPath(), and QLibrary. -.SH "void QApplication::lock ()" -Lock the Qt Library Mutex. If another thread has already locked the mutex, the calling thread will block until the other thread has unlocked the mutex. -.PP -See also unlock(), locked(), and Thread Support in Qt. -.SH "bool QApplication::locked ()" -Returns TRUE if the Qt Library Mutex is locked by a different thread; otherwise returns FALSE. -.PP -\fBWarning:\fR Due to different implementations of recursive mutexes on the supported platforms, calling this function from the same thread that previously locked the mutex will give undefined results. -.PP -See also lock(), unlock(), and Thread Support in Qt. -.SH "int QApplication::loopLevel () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the current loop level. -.PP -Use QApplication::eventLoop()->loopLevel() instead. -.SH "bool QApplication::macEventFilter ( EventHandlerCallRef, EventRef )\fC [virtual]\fR" -This virtual function is only implemented under Macintosh. -.PP -If you create an application that inherits QApplication and reimplement this function, you get direct access to all Carbon Events that are received from the MacOS. -.PP -Return TRUE if you want to stop the event from being processed. Return FALSE for normal event dispatching. -.SH "QWidget * QApplication::mainWidget () const" -Returns the main application widget, or 0 if there is no main widget. -.PP -See also setMainWidget(). -.SH "bool QApplication::notify ( QObject * receiver, QEvent * e )\fC [virtual]\fR" -Sends event \fIe\fR to \fIreceiver\fR: \fIreceiver\fR->event(\fIe\fR). Returns the value that is returned from the receiver's event handler. -.PP -For certain types of events (e.g. mouse and key events), the event will be propagated to the receiver's parent and so on up to the top-level object if the receiver is not interested in the event (i.e., it returns FALSE). -.PP -There are five different ways that events can be processed; reimplementing this virtual function is just one of them. All five approaches are listed below:
    -.TP -Reimplementing this function. This is very powerful, providing complete control; but only one subclass can be tqApp. -.IP -.TP -Installing an event filter on tqApp. Such an event filter is able to process all events for all widgets, so it's just as powerful as reimplementing notify(); furthermore, it's possible to have more than one application-global event filter. Global event filters even see mouse events for disabled widgets, and if global mouse tracking is enabled, as well as mouse move events for all widgets. -.IP -.TP -Reimplementing QObject::event() (as QWidget does). If you do this you get Tab key presses, and you get to see the events before any widget-specific event filters. -.IP -.TP -Installing an event filter on the object. Such an event filter gets all the events except Tab and Shift-Tab key presses. -.IP -.TP -Reimplementing paintEvent(), mousePressEvent() and so on. This is the commonest, easiest and least powerful way. -.PP -See also QObject::event() and installEventFilter(). -.SH "QCursor * QApplication::overrideCursor ()\fC [static]\fR" -Returns the active application override cursor. -.PP -This function returns 0 if no application cursor has been defined (i.e. the internal cursor stack is empty). -.PP -See also setOverrideCursor() and restoreOverrideCursor(). -.SH "QPalette QApplication::palette ( const QWidget * w = 0 )\fC [static]\fR" -Returns the application palette. -.PP -If a widget is passed in \fIw\fR, the default palette for the widget's class is returned. This may or may not be the application palette. In most cases there isn't a special palette for certain types of widgets, but one notable exception is the popup menu under Windows, if the user has defined a special background color for menus in the display settings. -.PP -See also setPalette() and QWidget::palette. -.PP -Examples: -.)l desktop/desktop.cpp, themes/metal.cpp, and themes/wood.cpp. -.SH "void QApplication::polish ( QWidget * w )\fC [virtual]\fR" -Initialization of the appearance of the widget \fIw\fR \fIbefore\fR it is first shown. -.PP -Usually widgets call this automatically when they are polished. It may be used to do some style-based central customization of widgets. -.PP -Note that you are not limited to the public functions of QWidget. Instead, based on meta information like QObject::className() you are able to customize any kind of widget. -.PP -See also QStyle::polish(), QWidget::polish(), setPalette(), and setFont(). -.SH "void QApplication::postEvent ( QObject * receiver, QEvent * event )\fC [static]\fR" -\fBNote:\fR This function is thread-safe when Qt is built withthread support.

    Adds the event \fIevent\fR with the object \fIreceiver\fR as the receiver of the event, to an event queue and returns immediately. -.PP -The event must be allocated on the heap since the post event queue will take ownership of the event and delete it once it has been posted. -.PP -When control returns to the main event loop, all events that are stored in the queue will be sent using the notify() function. -.PP -See also sendEvent() and notify(). -.SH "void QApplication::processEvents ()" -Processes pending events, for 3 seconds or until there are no more events to process, whichever is shorter. -.PP -You can call this function occasionally when your program is busy performing a long operation (e.g. copying a file). -.PP -See also exec(), QTimer, and QEventLoop::processEvents(). -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and network/ftpclient/main.cpp. -.SH "void QApplication::processEvents ( int maxtime )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Processes pending events for \fImaxtime\fR milliseconds or until there are no more events to process, whichever is shorter. -.PP -You can call this function occasionally when you program is busy doing a long operation (e.g. copying a file). -.PP -See also exec(), QTimer, and QEventLoop::processEvents(). -.SH "void QApplication::processOneEvent ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Waits for an event to occur, processes it, then returns. -.PP -This function is useful for adapting Qt to situations where the event processing must be grafted onto existing program loops. -.PP -Using this function in new applications may be an indication of design problems. -.PP -See also processEvents(), exec(), and QTimer. -.SH "void QApplication::quit ()\fC [slot]\fR" -Tells the application to exit with return code 0 (success). Equivalent to calling QApplication::exit( 0 ). -.PP -It's common to connect the lastWindowClosed() signal to quit(), and you also often connect e.g. QButton::clicked() or signals in QAction, QPopupMenu or QMenuBar to it. -.PP -Example: -.PP -.nf -.br - QPushButton *quitButton = new QPushButton( "Quit" ); -.br - connect( quitButton, SIGNAL(clicked()), tqApp, SLOT(quit()) ); -.br -.fi -.PP -See also exit(), aboutToQuit(), lastWindowClosed(), and QAction. -.PP -Examples: -.)l addressbook/main.cpp, mdi/main.cpp, network/archivesearch/main.cpp, regexptester/main.cpp, t2/main.cpp, t4/main.cpp, and t6/main.cpp. -.SH "QWSDecoration & QApplication::qwsDecoration ()\fC [static]\fR" -Return the QWSDecoration used for decorating windows. -.PP -This method is non-portable. It is available \fIonly\fR in Qt/Embedded. -.PP -See also QWSDecoration. -.SH "bool QApplication::qwsEventFilter ( QWSEvent * )\fC [virtual]\fR" -This virtual function is only implemented under Qt/Embedded. -.PP -If you create an application that inherits QApplication and reimplement this function, you get direct access to all QWS (Q Window System) events that the are received from the QWS master process. -.PP -Return TRUE if you want to stop the event from being processed. Return FALSE for normal event dispatching. -.SH "void QApplication::qwsSetCustomColors ( QRgb * colorTable, int start, int numColors )" -Set Qt/Embedded custom color table. -.PP -Qt/Embedded on 8-bpp displays allocates a standard 216 color cube. The remaining 40 colors may be used by setting a custom color table in the QWS master process before any clients connect. -.PP -\fIcolorTable\fR is an array of up to 40 custom colors. \fIstart\fR is the starting index (0-39) and \fInumColors\fR is the number of colors to be set (1-40). -.PP -This method is non-portable. It is available \fIonly\fR in Qt/Embedded. -.SH "void QApplication::qwsSetDecoration ( QWSDecoration * d )\fC [static]\fR" -Set the QWSDecoration derived class to use for decorating the Qt/Embedded windows to \fId\fR. -.PP -This method is non-portable. It is available \fIonly\fR in Qt/Embedded. -.PP -See also QWSDecoration. -.SH "void QApplication::removeLibraryPath ( const QString & path )\fC [static]\fR" -Removes \fIpath\fR from the library path list. If \fIpath\fR is empty or not in the path list, the list is not changed. -.PP -See also addLibraryPath(), libraryPaths(), and setLibraryPaths(). -.SH "void QApplication::removePostedEvents ( QObject * receiver )\fC [static]\fR" -\fBNote:\fR This function is thread-safe when Qt is built withthread support.

    Removes all events posted using postEvent() for \fIreceiver\fR. -.PP -The events are \fInot\fR dispatched, instead they are removed from the queue. You should never need to call this function. If you do call it, be aware that killing events may cause \fIreceiver\fR to break one or more invariants. -.SH "void QApplication::removeTranslator ( QTranslator * mf )" -Removes the message file \fImf\fR from the list of message files used by this application. (It does not delete the message file from the file system.) -.PP -See also installTranslator(), translate(), and QObject::tr(). -.PP -Example: i18n/main.cpp. -.SH "void QApplication::restoreOverrideCursor ()\fC [static]\fR" -Undoes the last setOverrideCursor(). -.PP -If setOverrideCursor() has been called twice, calling restoreOverrideCursor() will activate the first cursor set. Calling this function a second time restores the original widgets' cursors. -.PP -See also setOverrideCursor() and overrideCursor(). -.PP -Examples: -.)l distributor/distributor.ui.h, network/archivesearch/archivedialog.ui.h, network/ftpclient/ftpmainwindow.ui.h, and showimg/showimg.cpp. -.SH "bool QApplication::reverseLayout ()\fC [static]\fR" -Returns TRUE if all dialogs and widgets will be laid out in a mirrored (right to left) fashion. Returns FALSE if dialogs and widgets will be laid out left to right. -.PP -See also setReverseLayout(). -.SH "void QApplication::saveState ( QSessionManager & sm )\fC [virtual]\fR" -This function deals with session management. It is invoked when the session manager wants the application to preserve its state for a future session. -.PP -For example, a text editor would create a temporary file that includes the current contents of its edit buffers, the location of the cursor and other aspects of the current editing session. -.PP -Note that you should never exit the application within this function. Instead, the session manager may or may not do this afterwards, depending on the context. Futhermore, most session managers will very likely request a saved state immediately after the application has been started. This permits the session manager to learn about the application's restart policy. -.PP -\fBWarning:\fR Within this function, no user interaction is possible, \fIunless\fR you ask the session manager \fIsm\fR for explicit permission. See QSessionManager::allowsInteraction() and QSessionManager::allowsErrorInteraction() for details. -.PP -See also isSessionRestored(), sessionId(), commitData(), and the Session Management overview. -.SH "bool QApplication::sendEvent ( QObject * receiver, QEvent * event )\fC [static]\fR" -Sends event \fIevent\fR directly to receiver \fIreceiver\fR, using the notify() function. Returns the value that was returned from the event handler. -.PP -The event is \fInot\fR deleted when the event has been sent. The normal approach is to create the event on the stack, e.g. -.PP -.nf -.br - QMouseEvent me( QEvent::MouseButtonPress, pos, 0, 0 ); -.br - QApplication::sendEvent( mainWindow, &me ); -.br -.fi -If you create the event on the heap you must delete it. -.PP -See also postEvent() and notify(). -.PP -Example: popup/popup.cpp. -.SH "void QApplication::sendPostedEvents ( QObject * receiver, int event_type )\fC [static]\fR" -Immediately dispatches all events which have been previously queued with QApplication::postEvent() and which are for the object \fIreceiver\fR and have the event type \fIevent_type\fR. -.PP -Note that events from the window system are \fInot\fR dispatched by this function, but by processEvents(). -.PP -If \fIreceiver\fR is null, the events of \fIevent_type\fR are sent for all objects. If \fIevent_type\fR is 0, all the events are sent for \fIreceiver\fR. -.SH "void QApplication::sendPostedEvents ()\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Dispatches all posted events, i.e. empties the event queue. -.SH "QString QApplication::sessionId () const" -Returns the current session's identifier. -.PP -If the application has been restored from an earlier session, this identifier is the same as it was in that previous session. -.PP -The session identifier is guaranteed to be unique both for different applications and for different instances of the same application. -.PP -See also isSessionRestored(), sessionKey(), commitData(), and saveState(). -.SH "QString QApplication::sessionKey () const" -Returns the session key in the current session. -.PP -If the application has been restored from an earlier session, this key is the same as it was when the previous session ended. -.PP -The session key changes with every call of commitData() or saveState(). -.PP -See also isSessionRestored(), sessionId(), commitData(), and saveState(). -.SH "void QApplication::setColorSpec ( int spec )\fC [static]\fR" -Sets the color specification for the application to \fIspec\fR. -.PP -The color specification controls how the application allocates colors when run on a display with a limited amount of colors, e.g. 8 bit / 256 color displays. -.PP -The color specification must be set before you create the QApplication object. -.PP -The options are: -.TP -QApplication::NormalColor. This is the default color allocation strategy. Use this option if your application uses buttons, menus, texts and pixmaps with few colors. With this option, the application uses system global colors. This works fine for most applications under X11, but on Windows machines it may cause dithering of non-standard colors. -.TP -QApplication::CustomColor. Use this option if your application needs a small number of custom colors. On X11, this option is the same as NormalColor. On Windows, Qt creates a Windows palette, and allocates colors to it on demand. -.TP -QApplication::ManyColor. Use this option if your application is very color hungry (e.g. it requires thousands of colors). Under X11 the effect is: -.TP -For 256-color displays which have at best a 256 color true color visual, the default visual is used, and colors are allocated from a color cube. The color cube is the 6x6x6 (216 color) "Web palette"*, but the number of colors can be changed by the \fI-ncols\fR option. The user can force the application to use the true color visual with the -visual option. -.TP -For 256-color displays which have a true color visual with more than 256 colors, use that visual. Silicon Graphics X servers have this feature, for example. They provide an 8 bit visual by default but can deliver true color when asked. On Windows, Qt creates a Windows palette, and fills it with a color cube. -.PP -Be aware that the CustomColor and ManyColor choices may lead to colormap flashing: The foreground application gets (most) of the available colors, while the background windows will look less attractive. -.PP -Example: -.PP -.nf -.br - int main( int argc, char **argv ) -.br - { -.br - QApplication::setColorSpec( QApplication::ManyColor ); -.br - QApplication a( argc, argv ); -.br - ... -.br - } -.br -.fi -.PP -QColor provides more functionality for controlling color allocation and freeing up certain colors. See QColor::enterAllocContext() for more information. -.PP -To check what mode you end up with, call QColor::numBitPlanes() once the QApplication object exists. A value greater than 8 (typically 16, 24 or 32) means true color. -.PP -* The color cube used by Qt has 216 colors whose red, green, and blue components always have one of the following values: 0x00, 0x33, 0x66, 0x99, 0xCC, or 0xFF. -.PP -See also colorSpec(), QColor::numBitPlanes(), and QColor::enterAllocContext(). -.PP -Examples: -.)l helpviewer/main.cpp, opengl/main.cpp, showimg/main.cpp, t9/main.cpp, tetrax/tetrax.cpp, tetrix/tetrix.cpp, and themes/main.cpp. -.SH "void QApplication::setCursorFlashTime ( int msecs )\fC [static]\fR" -Sets the text cursor's flash (blink) time to \fImsecs\fR milliseconds. The flash time is the time required to display, invert and restore the caret display. Usually the text cursor is displayed for \fImsecs/2\fR milliseconds, then hidden for \fImsecs/2\fR milliseconds, but this may vary. -.PP -Note that on Microsoft Windows, calling this function sets the cursor flash time for all windows. -.PP -See also cursorFlashTime(). -.SH "void QApplication::setDefaultCodec ( QTextCodec * codec )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is the same as QTextCodec::setCodecForTr(). -.SH "void QApplication::setDesktopSettingsAware ( bool on )\fC [static]\fR" -By default, Qt will try to use the current standard colors, fonts etc., from the underlying window system's desktop settings, and use them for all relevant widgets. This behavior can be switched off by calling this function with \fIon\fR set to FALSE. -.PP -This static function must be called before creating the QApplication object, like this: -.PP -.nf -.br - int main( int argc, char** argv ) { -.br - QApplication::setDesktopSettingsAware( FALSE ); // I know better than the user -.br - QApplication myApp( argc, argv ); // Use default fonts & colors -.br - ... -.br - } -.br -.fi -.PP -See also desktopSettingsAware(). -.SH "void QApplication::setDoubleClickInterval ( int ms )\fC [static]\fR" -Sets the time limit that distinguishes a double click from two consecutive mouse clicks to \fIms\fR milliseconds. -.PP -Note that on Microsoft Windows, calling this function sets the double click interval for all windows. -.PP -See also doubleClickInterval(). -.SH "void QApplication::setEffectEnabled ( Qt::UIEffect effect, bool enable = TRUE )\fC [static]\fR" -Enables the UI effect \fIeffect\fR if \fIenable\fR is TRUE, otherwise the effect will not be used. -.PP -Note: All effects are disabled on screens running at less than 16-bit color depth. -.PP -See also isEffectEnabled(), Qt::UIEffect, and setDesktopSettingsAware(). -.SH "void QApplication::setFont ( const QFont & font, bool informWidgets = FALSE, const char * className = 0 )\fC [static]\fR" -Changes the default application font to \fIfont\fR. If \fIinformWidgets\fR is TRUE, then existing widgets are informed about the change and may adjust themselves to the new application setting. If \fIinformWidgets\fR is FALSE, the change only affects newly created widgets. If \fIclassName\fR is passed, the change applies only to classes that inherit \fIclassName\fR (as reported by QObject::inherits()). -.PP -On application start-up, the default font depends on the window system. It can vary depending on both the window system version and the locale. This function lets you override the default font; but overriding may be a bad idea because, for example, some locales need extra-large fonts to support their special characters. -.PP -See also font(), fontMetrics(), and QWidget::font. -.PP -Examples: -.)l desktop/desktop.cpp, themes/metal.cpp, and themes/themes.cpp. -.SH "void QApplication::setGlobalMouseTracking ( bool enable )\fC [static]\fR" -Enables global mouse tracking if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. -.PP -Enabling global mouse tracking makes it possible for widget event filters or application event filters to get all mouse move events, even when no button is depressed. This is useful for special GUI elements, e.g. tooltips. -.PP -Global mouse tracking does not affect widgets and their mouseMoveEvent(). For a widget to get mouse move events when no button is depressed, it must do QWidget::setMouseTracking(TRUE). -.PP -This function uses an internal counter. Each setGlobalMouseTracking(TRUE) must have a corresponding setGlobalMouseTracking(FALSE): -.PP -.nf -.br - // at this point global mouse tracking is off -.br - QApplication::setGlobalMouseTracking( TRUE ); -.br - QApplication::setGlobalMouseTracking( TRUE ); -.br - QApplication::setGlobalMouseTracking( FALSE ); -.br - // at this point it's still on -.br - QApplication::setGlobalMouseTracking( FALSE ); -.br - // but now it's off -.br -.fi -.PP -See also hasGlobalMouseTracking() and QWidget::mouseTracking. -.SH "void QApplication::setGlobalStrut ( const QSize & strut )\fC [static]\fR" -Sets the application's global strut to \fIstrut\fR. -.PP -The strut is a size object whose dimensions are the minimum that any GUI element that the user can interact with should have. For example no button should be resized to be smaller than the global strut size. -.PP -The strut size should be considered when reimplementing GUI controls that may be used on touch-screens or similar IO-devices. -.PP -Example: -.PP -.nf -.br - QSize& WidgetClass::sizeHint() const -.br - { -.br - return QSize( 80, 25 ).expandedTo( QApplication::globalStrut() ); -.br - } -.br -.fi -.PP -See also globalStrut(). -.SH "void QApplication::setLibraryPaths ( const QStringList & paths )\fC [static]\fR" -Sets the list of directories to search when loading libraries to \fIpaths\fR. All existing paths will be deleted and the path list will consist of the paths given in \fIpaths\fR. -.PP -See also libraryPaths(), addLibraryPath(), removeLibraryPath(), and QLibrary. -.SH "void QApplication::setMainWidget ( QWidget * mainWidget )\fC [virtual]\fR" -Sets the application's main widget to \fImainWidget\fR. -.PP -In most respects the main widget is like any other widget, except that if it is closed, the application exits. Note that QApplication does \fInot\fR take ownership of the \fImainWidget\fR, so if you create your main widget on the heap you must delete it yourself. -.PP -You need not have a main widget; connecting lastWindowClosed() to quit() is an alternative. -.PP -For X11, this function also resizes and moves the main widget according to the \fI-geometry\fR command-line option, so you should set the default geometry (using QWidget::setGeometry()) before calling setMainWidget(). -.PP -See also mainWidget(), exec(), and quit(). -.PP -Examples: -.)l chart/main.cpp, helpsystem/main.cpp, life/main.cpp, network/ftpclient/main.cpp, opengl/main.cpp, t1/main.cpp, and t4/main.cpp. -.SH "void QApplication::setOverrideCursor ( const QCursor & cursor, bool replace = FALSE )\fC [static]\fR" -Sets the application override cursor to \fIcursor\fR. -.PP -Application override cursors are intended for showing the user that the application is in a special state, for example during an operation that might take some time. -.PP -This cursor will be displayed in all the application's widgets until restoreOverrideCursor() or another setOverrideCursor() is called. -.PP -Application cursors are stored on an internal stack. setOverrideCursor() pushes the cursor onto the stack, and restoreOverrideCursor() pops the active cursor off the stack. Every setOverrideCursor() must eventually be followed by a corresponding restoreOverrideCursor(), otherwise the stack will never be emptied. -.PP -If \fIreplace\fR is TRUE, the new cursor will replace the last override cursor (the stack keeps its depth). If \fIreplace\fR is FALSE, the new stack is pushed onto the top of the stack. -.PP -Example: -.PP -.nf -.br - QApplication::setOverrideCursor( QCursor(Qt::WaitCursor) ); -.br - calculateHugeMandelbrot(); // lunch time... -.br - QApplication::restoreOverrideCursor(); -.br -.fi -.PP -See also overrideCursor(), restoreOverrideCursor(), and QWidget::cursor. -.PP -Examples: -.)l distributor/distributor.ui.h, network/archivesearch/archivedialog.ui.h, network/ftpclient/ftpmainwindow.ui.h, and showimg/showimg.cpp. -.SH "void QApplication::setPalette ( const QPalette & palette, bool informWidgets = FALSE, const char * className = 0 )\fC [static]\fR" -Changes the default application palette to \fIpalette\fR. If \fIinformWidgets\fR is TRUE, then existing widgets are informed about the change and may adjust themselves to the new application setting. If \fIinformWidgets\fR is FALSE, the change only affects newly created widgets. -.PP -If \fIclassName\fR is passed, the change applies only to widgets that inherit \fIclassName\fR (as reported by QObject::inherits()). If \fIclassName\fR is left 0, the change affects all widgets, thus overriding any previously set class specific palettes. -.PP -The palette may be changed according to the current GUI style in QStyle::polish(). -.PP -See also QWidget::palette, palette(), and QStyle::polish(). -.PP -Examples: -.)l i18n/main.cpp, themes/metal.cpp, themes/themes.cpp, and themes/wood.cpp. -.SH "void QApplication::setReverseLayout ( bool b )\fC [static]\fR" -If \fIb\fR is TRUE, all dialogs and widgets will be laid out in a mirrored fashion, as required by right to left languages such as Arabic and Hebrew. If \fIb\fR is FALSE, dialogs and widgets are laid out left to right. -.PP -Changing this flag in runtime does not cause a relayout of already instantiated widgets. -.PP -See also reverseLayout(). -.SH "void QApplication::setStartDragDistance ( int l )\fC [static]\fR" -Sets the distance after which a drag should start to \fIl\fR pixels. -.PP -See also startDragDistance(). -.SH "void QApplication::setStartDragTime ( int ms )\fC [static]\fR" -Sets the time after which a drag should start to \fIms\fR ms. -.PP -See also startDragTime(). -.SH "void QApplication::setStyle ( QStyle * style )\fC [static]\fR" -Sets the application's GUI style to \fIstyle\fR. Ownership of the style object is transferred to QApplication, so QApplication will delete the style object on application exit or when a new style is set. -.PP -Example usage: -.PP -.nf -.br - QApplication::setStyle( new QWindowsStyle ); -.br -.fi -.PP -When switching application styles, the color palette is set back to the initial colors or the system defaults. This is necessary since certain styles have to adapt the color palette to be fully style-guide compliant. -.PP -See also style(), QStyle, setPalette(), and desktopSettingsAware(). -.PP -Example: themes/themes.cpp. -.SH "QStyle * QApplication::setStyle ( const QString & style )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Requests a QStyle object for \fIstyle\fR from the QStyleFactory. -.PP -The string must be one of the QStyleFactory::keys(), typically one of "windows", "motif", "cde", "motifplus", "platinum", "sgi" and" compact". Depending on the platform, "windowsxp", "aqua" or" macintosh" may be available. -.PP -A later call to the QApplication constructor will override the requested style when a "-style" option is passed in as a commandline parameter. -.PP -Returns 0 if an unknown \fIstyle\fR is passed, otherwise the QStyle object returned is set as the application's GUI style. -.SH "void QApplication::setWheelScrollLines ( int n )\fC [static]\fR" -Sets the number of lines to scroll when the mouse wheel is rotated to \fIn\fR. -.PP -If this number exceeds the number of visible lines in a certain widget, the widget should interpret the scroll operation as a single page up / page down operation instead. -.PP -See also wheelScrollLines(). -.SH "void QApplication::setWinStyleHighlightColor ( const QColor & c )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the color used to mark selections in windows style for all widgets in the application. Will repaint all widgets if the color is changed. -.PP -The default color is \fCdarkBlue\fR. -.PP -See also winStyleHighlightColor(). -.SH "int QApplication::startDragDistance ()\fC [static]\fR" -If you support drag and drop in you application and a drag should start after a mouse click and after moving the mouse a certain distance, you should use the value which this method returns as the distance. -.PP -For example, if the mouse position of the click is stored in \fCstartPos\fR and the current position (e.g. in the mouse move event) is \fCcurrPos\fR, you can find out if a drag should be started with code like this: -.PP -.nf -.br - if ( ( startPos - currPos ).manhattanLength() > -.br - QApplication::startDragDistance() ) -.br - startTheDrag(); -.br -.fi -.PP -Qt uses this value internally, e.g. in QFileDialog. -.PP -The default value is 4 pixels. -.PP -See also setStartDragDistance(), startDragTime(), and QPoint::manhattanLength(). -.SH "int QApplication::startDragTime ()\fC [static]\fR" -If you support drag and drop in you application and a drag should start after a mouse click and after a certain time elapsed, you should use the value which this method returns as the delay (in ms). -.PP -Qt also uses this delay internally, e.g. in QTextEdit and QLineEdit, for starting a drag. -.PP -The default value is 500 ms. -.PP -See also setStartDragTime() and startDragDistance(). -.SH "bool QApplication::startingUp ()\fC [static]\fR" -Returns TRUE if an application object has not been created yet; otherwise returns FALSE. -.PP -See also closingDown(). -.SH "QStyle & QApplication::style ()\fC [static]\fR" -Returns the application's style object. -.PP -See also setStyle() and QStyle. -.SH "void QApplication::syncX ()\fC [static]\fR" -Synchronizes with the X server in the X11 implementation. This normally takes some time. Does nothing on other platforms. -.PP -See also flushX(). -.SH "QWidgetList * QApplication::topLevelWidgets ()\fC [static]\fR" -Returns a list of the top level widgets in the application. -.PP -The list is created using \fCnew\fR and must be deleted by the caller. -.PP -The list is empty (QPtrList::isEmpty()) if there are no top level widgets. -.PP -Note that some of the top level widgets may be hidden, for example the tooltip if no tooltip is currently shown. -.PP -Example: -.PP -.nf -.br - // Show all hidden top level widgets. -.br - QWidgetList *list = QApplication::topLevelWidgets(); -.br - QWidgetListIt it( *list ); // iterate over the widgets -.br - QWidget * w; -.br - while ( (w=it.current()) != 0 ) { // for each top level widget... -.br - ++it; -.br - if ( !w->isVisible() ) -.br - w->show(); -.br - } -.br - delete list; // delete the list, not the widgets -.br -.fi -.PP -\fBWarning:\fR Delete the list as soon you have finished using it. The widgets in the list may be deleted by someone else at any time. -.PP -See also allWidgets(), QWidget::isTopLevel, QWidget::visible, and QPtrList::isEmpty(). -.SH "QString QApplication::translate ( const char * context, const char * sourceText, const char * comment = 0, Encoding encoding = DefaultCodec ) const" -\fBNote:\fR This function is reentrant when Qt is built with thread support.

    Returns the translation text for \fIsourceText\fR, by querying the installed messages files. The message files are searched from the most recently installed message file back to the first installed message file. -.PP -QObject::tr() and QObject::trUtf8() provide this functionality more conveniently. -.PP -\fIcontext\fR is typically a class name (e.g., "MyDialog") and \fIsourceText\fR is either English text or a short identifying text, if the output text will be very long (as for help texts). -.PP -\fIcomment\fR is a disambiguating comment, for when the same \fIsourceText\fR is used in different roles within the same context. By default, it is null. \fIencoding\fR indicates the 8-bit encoding of character stings -.PP -See the QTranslator documentation for more information about contexts and comments. -.PP -If none of the message files contain a translation for \fIsourceText\fR in \fIcontext\fR, this function returns a QString equivalent of \fIsourceText\fR. The encoding of \fIsourceText\fR is specified by \fIencoding\fR; it defaults to DefaultCodec. -.PP -This function is not virtual. You can use alternative translation techniques by subclassing QTranslator. -.PP -\fBWarning:\fR This method is reentrant only if all translators are installed \fIbefore\fR calling this method. Installing or removing translators while performing translations is not supported. Doing so will most likely result in crashes or other undesirable behavior. -.PP -See also QObject::tr(), installTranslator(), and defaultCodec(). -.SH "bool QApplication::tryLock ()" -Attempts to lock the Qt Library Mutex, and returns immediately. If the lock was obtained, this function returns TRUE. If another thread has locked the mutex, this function returns FALSE, instead of waiting for the lock to become available. -.PP -The mutex must be unlocked with unlock() before another thread can successfully lock it. -.PP -See also lock(), unlock(), and Thread Support in Qt. -.SH "Type QApplication::type () const" -Returns the type of application, Tty, GuiClient or GuiServer. -.SH "void QApplication::unlock ( bool wakeUpGui = TRUE )" -Unlock the Qt Library Mutex. If \fIwakeUpGui\fR is TRUE (the default), then the GUI thread will be woken with QApplication::wakeUpGuiThread(). -.PP -See also lock(), locked(), and Thread Support in Qt. -.SH "void QApplication::wakeUpGuiThread ()" -Wakes up the GUI thread. -.PP -See also guiThreadAwake() and Thread Support in Qt. -.SH "int QApplication::wheelScrollLines ()\fC [static]\fR" -Returns the number of lines to scroll when the mouse wheel is rotated. -.PP -See also setWheelScrollLines(). -.SH "QWidget * QApplication::widgetAt ( int x, int y, bool child = FALSE )\fC [static]\fR" -Returns a pointer to the widget at global screen position \fI(x, y)\fR, or 0 if there is no Qt widget there. -.PP -If \fIchild\fR is FALSE and there is a child widget at position \fI(x, y)\fR, the top-level widget containing it is returned. If \fIchild\fR is TRUE the child widget at position \fI(x, y)\fR is returned. -.PP -This function is normally rather slow. -.PP -See also QCursor::pos(), QWidget::grabMouse(), and QWidget::grabKeyboard(). -.SH "QWidget * QApplication::widgetAt ( const QPoint & pos, bool child = FALSE )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a pointer to the widget at global screen position \fIpos\fR, or 0 if there is no Qt widget there. -.PP -If \fIchild\fR is FALSE and there is a child widget at position \fIpos\fR, the top-level widget containing it is returned. If \fIchild\fR is TRUE the child widget at position \fIpos\fR is returned. -.SH "bool QApplication::winEventFilter ( MSG * )\fC [virtual]\fR" -This virtual function is only implemented under Windows. -.PP -The message procedure calls this function for every message received. Reimplement this function if you want to process window messages that are not processed by Qt. If you don't want the event to be processed by Qt, then return TRUE; otherwise return FALSE. -.SH "void QApplication::winFocus ( QWidget * widget, bool gotFocus )" -This function is available only on Windows. -.PP -If \fIgotFocus\fR is TRUE, \fIwidget\fR will become the active window. Otherwise the active window is reset to NULL. -.SH "const QColor & QApplication::winStyleHighlightColor ()\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the color used to mark selections in windows style. -.PP -See also setWinStyleHighlightColor(). -.SH "bool QApplication::x11EventFilter ( XEvent * )\fC [virtual]\fR" -This virtual function is only implemented under X11. -.PP -If you create an application that inherits QApplication and reimplement this function, you get direct access to all X events that the are received from the X server. -.PP -Return TRUE if you want to stop the event from being processed. Return FALSE for normal event dispatching. -.PP -See also x11ProcessEvent(). -.SH "int QApplication::x11ProcessEvent ( XEvent * event )" -This function does the core processing of individual X \fIevent\fRs, normally by dispatching Qt events to the right destination. -.PP -It returns 1 if the event was consumed by special handling, 0 if the \fIevent\fR was consumed by normal handling, and -1 if the \fIevent\fR was for an unrecognized widget. -.PP -See also x11EventFilter(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "void Q_ASSERT ( bool test )" -Prints a warning message containing the source code file name and line number if \fItest\fR is FALSE. -.PP -This is really a macro defined in ntqglobal.h. -.PP -Q_ASSERT is useful for testing pre- and post-conditions. -.PP -Example: -.PP -.nf -.br - // -.br - // File: div.cpp -.br - // -.br -.br - #include -.br -.br - int divide( int a, int b ) -.br - { -.br - Q_ASSERT( b != 0 ); // this is line 9 -.br - return a/b; -.br - } -.br -.fi -.PP -If \fCb\fR is zero, the Q_ASSERT statement will output the following message using the tqWarning() function: -.PP -.nf -.br - ASSERT: "b != 0" in div.cpp (9) -.br -.fi -.PP -See also tqWarning() and Debugging. -.SH "void TQ_CHECK_PTR ( void * p )" -If \fIp\fR is 0, prints a warning message containing the source code file name and line number, saying that the program ran out of memory. -.PP -This is really a macro defined in ntqglobal.h. -.PP -Example: -.PP -.nf -.br - int *a; -.br -.br - TQ_CHECK_PTR( a = new int[80] ); // WRONG! -.br -.br - a = new (nothrow) int[80]; // Right -.br - TQ_CHECK_PTR( a ); -.br -.fi -.PP -See also tqWarning() and Debugging. -.SH "void tqAddPostRoutine ( QtCleanUpFunction p )" -Adds a global routine that will be called from the QApplication destructor. This function is normally used to add cleanup routines for program-wide functionality. -.PP -The function given by \fIp\fR should take no arguments and return nothing, like this: -.PP -.nf -.br - static int *global_ptr = 0; -.br -.br - static void cleanup_ptr() -.br - { -.br - delete [] global_ptr; -.br - global_ptr = 0; -.br - } -.br -.br - void init_ptr() -.br - { -.br - global_ptr = new int[100]; // allocate data -.br - tqAddPostRoutine( cleanup_ptr ); // delete later -.br - } -.br -.fi -.PP -Note that for an application- or module-wide cleanup, tqAddPostRoutine() is often not suitable. People have a tendency to make such modules dynamically loaded, and then unload those modules long before the QApplication destructor is called, for example. -.PP -For modules and libraries, using a reference-counted initialization manager or Qt' parent-child delete mechanism may be better. Here is an example of a private class which uses the parent-child mechanism to call a cleanup function at the right time: -.PP -.nf -.br - class MyPrivateInitStuff: public QObject { -.br - private: -.br - MyPrivateInitStuff( QObject * parent ): QObject( parent) { -.br - // initialization goes here -.br - } -.br - MyPrivateInitStuff * p; -.br -.br - public: -.br - static MyPrivateInitStuff * initStuff( QObject * parent ) { -.br - if ( !p ) -.br - p = new MyPrivateInitStuff( parent ); -.br - return p; -.br - } -.br -.br - ~MyPrivateInitStuff() { -.br - // cleanup (the "post routine") goes here -.br - } -.br - } -.br -.fi -.PP -By selecting the right parent widget/object, this can often be made to clean up the module's data at the exact right moment. -.SH "void tqDebug ( const char * msg, ... )" -Prints a debug message \fImsg\fR, or calls the message handler (if it has been installed). -.PP -This function takes a format string and a list of arguments, similar to the C printf() function. -.PP -Example: -.PP -.nf -.br - tqDebug( "my window handle = %x", myWidget->id() ); -.br -.fi -.PP -Under X11, the text is printed to stderr. Under Windows, the text is sent to the debugger. -.PP -\fBWarning:\fR The internal buffer is limited to 8196 bytes (including the '\0'-terminator). -.PP -\fBWarning:\fR Passing (const char *)0 as argument to tqDebug might lead to crashes on certain platforms due to the platforms printf implementation. -.PP -See also tqWarning(), tqFatal(), qInstallMsgHandler(), and Debugging. -.SH "void tqFatal ( const char * msg, ... )" -Prints a fatal error message \fImsg\fR and exits, or calls the message handler (if it has been installed). -.PP -This function takes a format string and a list of arguments, similar to the C printf() function. -.PP -Example: -.PP -.nf -.br - int divide( int a, int b ) -.br - { -.br - if ( b == 0 ) // program error -.br - tqFatal( "divide: cannot divide by zero" ); -.br - return a/b; -.br - } -.br -.fi -.PP -Under X11, the text is printed to stderr. Under Windows, the text is sent to the debugger. -.PP -\fBWarning:\fR The internal buffer is limited to 8196 bytes (including the '\0'-terminator). -.PP -\fBWarning:\fR Passing (const char *)0 as argument to tqFatal might lead to crashes on certain platforms due to the platforms printf implementation. -.PP -See also tqDebug(), tqWarning(), qInstallMsgHandler(), and Debugging. -.SH "QtMsgHandler qInstallMsgHandler ( QtMsgHandler h )" -Installs a Qt message handler \fIh\fR. Returns a pointer to the message handler previously defined. -.PP -The message handler is a function that prints out debug messages, warnings and fatal error messages. The Qt library (debug version) contains hundreds of warning messages that are printed when internal errors (usually invalid function arguments) occur. If you implement your own message handler, you get total control of these messages. -.PP -The default message handler prints the message to the standard output under X11 or to the debugger under Windows. If it is a fatal message, the application aborts immediately. -.PP -Only one message handler can be defined, since this is usually done on an application-wide basis to control debug output. -.PP -To restore the message handler, call \fCqInstallMsgHandler(0)\fR. -.PP -Example: -.PP -.nf -.br - #include -.br - #include -.br - #include -.br -.br - void myMessageOutput( QtMsgType type, const char *msg ) -.br - { -.br - switch ( type ) { -.br - case QtDebugMsg: -.br - fprintf( stderr, "Debug: %s\\n", msg ); -.br - break; -.br - case QtWarningMsg: -.br - fprintf( stderr, "Warning: %s\\n", msg ); -.br - break; -.br - case QtFatalMsg: -.br - fprintf( stderr, "Fatal: %s\\n", msg ); -.br - abort(); // deliberately core dump -.br - } -.br - } -.br -.br - int main( int argc, char **argv ) -.br - { -.br - qInstallMsgHandler( myMessageOutput ); -.br - QApplication a( argc, argv ); -.br - ... -.br - return a.exec(); -.br - } -.br -.fi -.PP -See also tqDebug(), tqWarning(), tqFatal(), and Debugging. -.SH "bool tqSysInfo ( int * wordSize, bool * bigEndian )" -Obtains information about the system. -.PP -The system's word size in bits (typically 32) is returned in \fI*wordSize\fR. The \fI*bigEndian\fR is set to TRUE if this is a big-endian machine, or to FALSE if this is a little-endian machine. -.PP -In debug mode, this function calls tqFatal() with a message if the computer is truly weird (i.e. different endianness for 16 bit and 32 bit integers); in release mode it returns FALSE. -.SH "void tqSystemWarning ( const char * msg, int code )" -Prints the message \fImsg\fR and uses \fIcode\fR to get a system specific error message. When \fIcode\fR is -1 (the default), the system's last error code will be used if possible. Use this method to handle failures in platform specific API calls. -.PP -This function does nothing when Qt is built with \fCQT_NO_DEBUG\fR defined. -.SH "const char * tqVersion ()" -Returns the Qt version number as a string, for example, "2.3.0" or" 3.0.5". -.PP -The \fCTQT_VERSION\fR define has the numeric value in the form: 0xmmiibb (m = major, i = minor, b = bugfix). For example, Qt 3.0.5's \fCTQT_VERSION\fR is 0x030005. -.SH "void tqWarning ( const char * msg, ... )" -Prints a warning message \fImsg\fR, or calls the message handler (if it has been installed). -.PP -This function takes a format string and a list of arguments, similar to the C printf() function. -.PP -Example: -.PP -.nf -.br - void f( int c ) -.br - { -.br - if ( c > 200 ) -.br - tqWarning( "f: bad argument, c == %d", c ); -.br - } -.br -.fi -.PP -Under X11, the text is printed to stderr. Under Windows, the text is sent to the debugger. -.PP -\fBWarning:\fR The internal buffer is limited to 8196 bytes (including the '\0'-terminator). -.PP -\fBWarning:\fR Passing (const char *)0 as argument to tqWarning might lead to crashes on certain platforms due to the platforms printf implementation. -.PP -See also tqDebug(), tqFatal(), qInstallMsgHandler(), and Debugging. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqapplication.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qapplication.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qasciicache.3qt b/doc/man/man3/qasciicache.3qt deleted file mode 100644 index 0d05a0d95..000000000 --- a/doc/man/man3/qasciicache.3qt +++ /dev/null @@ -1,191 +0,0 @@ -'\" t -.TH QAsciiCache 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 -QAsciiCache \- Template class that provides a cache based on char* keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAsciiCache\fR ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" -.br -.ti -1c -.BI "\fB~QAsciiCache\fR ()" -.br -.ti -1c -.BI "int \fBmaxCost\fR () const" -.br -.ti -1c -.BI "int \fBtotalCost\fR () const" -.br -.ti -1c -.BI "void \fBsetMaxCost\fR ( int m )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "bool \fBinsert\fR ( const char * k, const type * d, int c = 1, int p = 0 )" -.br -.ti -1c -.BI "bool \fBremove\fR ( const char * k )" -.br -.ti -1c -.BI "type * \fBtake\fR ( const char * k )" -.br -.ti -1c -.BI "type * \fBfind\fR ( const char * k, bool ref = TRUE ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( const char * k ) const" -.br -.ti -1c -.BI "void \fBstatistics\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QAsciiCache class is a template class that provides a cache based on char* keys. -.PP -QAsciiCache is implemented as a template class. Define a template instance QAsciiCache to create a cache that operates on pointers to X (X*). -.PP -A cache is a least recently used (LRU) list of cache items. The cache items are accessed via \fCchar*\fR keys. For Unicode keys use the QCache template instead, which uses QString keys. A QCache has the same performace as a QAsciiCache. -.PP -Each cache item has a cost. The sum of item costs, totalCost(), will not exceed the maximum cache cost, maxCost(). If inserting a new item would cause the total cost to exceed the maximum cost, the least recently used items in the cache are removed. -.PP -Apart from insert(), by far the most important function is find() (which also exists as operator[]()). This function looks up an item, returns it, and by default marks it as being the most recently used item. -.PP -There are also methods to remove() or take() an object from the cache. Calling setAutoDelete(TRUE) tells the cache to delete items that are removed. The default is to not delete items when then are removed (i.e., remove() and take() are equivalent). -.PP -When inserting an item into the cache, only the pointer is copied, not the item itself. This is called a shallow copy. It is possible to make the cache copy all of the item's data (known as a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a cache and reimplement newItem() if you want deep copies. -.PP -When removing a cache item the virtual function QPtrCollection::deleteItem() is called. Its default implementation in QAsciiCache is to delete the item if auto-deletion is enabled. -.PP -There is a QAsciiCacheIterator which may be used to traverse the items in the cache in arbitrary order. -.PP -See also QAsciiCacheIterator, QCache, QIntCache, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAsciiCache::QAsciiCache ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" -Constructs a cache whose contents will never have a total cost greater than \fImaxCost\fR and which is expected to contain less than \fIsize\fR items. -.PP -\fIsize\fR is actually the size of an internal hash array; it's usually best to make it prime and at least 50% bigger than the largest expected number of items in the cache. -.PP -Each inserted item has an associated cost. When inserting a new item, if the total cost of all items in the cache will exceed \fImaxCost\fR, the cache will start throwing out the older (least recently used) items until there is enough room for the new item to be inserted. -.PP -If \fIcaseSensitive\fR is TRUE (the default), the cache keys are case sensitive; if it is FALSE, they are case-insensitive. Case-insensitive comparison only affects the 26 letters in US-ASCII. If \fIcopyKeys\fR is TRUE (the default), QAsciiCache makes a copy of the cache keys, otherwise it copies just the const char * pointer - slightly faster if you can guarantee that the keys will never change, but very risky. -.SH "QAsciiCache::~QAsciiCache ()" -Removes all items from the cache and destroys it. All iterators that access this cache will be reset. -.SH "void QAsciiCache::clear ()\fC [virtual]\fR" -Removes all items from the cache, and deletes them if auto-deletion has been enabled. -.PP -All cache iterators that operate on this cache are reset. -.PP -See also remove() and take(). -.PP -Reimplemented from QPtrCollection. -.SH "uint QAsciiCache::count () const\fC [virtual]\fR" -Returns the number of items in the cache. -.PP -See also totalCost() and size(). -.PP -Reimplemented from QPtrCollection. -.SH "type * QAsciiCache::find ( const char * k, bool ref = TRUE ) const" -Returns the item with key \fIk\fR, or 0 if the key does not exist in the cache. If \fIref\fR is TRUE (the default), the item is moved to the front of the least recently used list. -.PP -If there are two or more items with equal keys, the one that was inserted last is returned. -.SH "bool QAsciiCache::insert ( const char * k, const type * d, int c = 1, int p = 0 )" -Inserts the item \fId\fR into the cache using key \fIk\fR, and with an associated cost of \fIc\fR. Returns TRUE if the item is successfully inserted. Returns FALSE if the item is not inserted, for example, if the cost of the item exceeds maxCost(). -.PP -The cache's size is limited, and if the total cost is too high, QAsciiCache will remove old, least recently used items until there is room for this new item. -.PP -Items with duplicate keys can be inserted. -.PP -The parameter \fIp\fR is internal and should be left at the default value (0). -.PP -\fBWarning:\fR If this function returns FALSE, you must delete \fId\fR yourself. Additionally, be very careful about using \fId\fR after calling this function, because any other insertions into the cache, from anywhere in the application or within Qt itself, could cause the object to be discarded from the cache and the pointer to become invalid. -.SH "bool QAsciiCache::isEmpty () const" -Returns TRUE if the cache is empty; otherwise returns FALSE. -.SH "int QAsciiCache::maxCost () const" -Returns the maximum allowed total cost of the cache. -.PP -See also setMaxCost() and totalCost(). -.SH "type * QAsciiCache::operator[] ( const char * k ) const" -Returns the item with key \fIk\fR, or 0 if \fIk\fR does not exist in the cache, and moves the item to the front of the least recently used list. -.PP -If there are two or more items with equal keys, the one that was inserted last is returned. -.PP -This is the same as find( k, TRUE ). -.PP -See also find(). -.SH "bool QAsciiCache::remove ( const char * k )" -Removes the item with key \fIk\fR and returns TRUE if the item was present in the cache; otherwise returns FALSE. -.PP -The item is deleted if auto-deletion has been enabled, i.e., if you have called setAutoDelete(TRUE). -.PP -If there are two or more items with equal keys, the one that was inserted last is removed. -.PP -All iterators that refer to the removed item are set to point to the next item in the cache's traversal order. -.PP -See also take() and clear(). -.SH "void QAsciiCache::setMaxCost ( int m )" -Sets the maximum allowed total cost of the cache to \fIm\fR. If the current total cost is greater than \fIm\fR, some items are removed immediately. -.PP -See also maxCost() and totalCost(). -.SH "uint QAsciiCache::size () const" -Returns the size of the hash array used to implement the cache. This should be a bit bigger than count() is likely to be. -.SH "void QAsciiCache::statistics () const" -A debug-only utility function. Prints out cache usage, hit/miss, and distribution information using tqDebug(). This function does nothing in the release library. -.SH "type * QAsciiCache::take ( const char * k )" -Takes the item associated with \fIk\fR out of the cache without deleting it and returns a pointer to the item taken out, or 0 if the key does not exist in the cache. -.PP -If there are two or more items with equal keys, the one that was inserted last is taken. -.PP -All iterators that refer to the taken item are set to point to the next item in the cache's traversal order. -.PP -See also remove() and clear(). -.SH "int QAsciiCache::totalCost () const" -Returns the total cost of the items in the cache. This is an integer in the range 0 to maxCost(). -.PP -See also setMaxCost(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqasciicache.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qasciicache.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qasciicacheiterator.3qt b/doc/man/man3/qasciicacheiterator.3qt deleted file mode 100644 index 0e08186d9..000000000 --- a/doc/man/man3/qasciicacheiterator.3qt +++ /dev/null @@ -1,157 +0,0 @@ -'\" t -.TH QAsciiCacheIterator 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 -QAsciiCacheIterator \- Iterator for QAsciiCache collections -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAsciiCacheIterator\fR ( const QAsciiCache & cache )" -.br -.ti -1c -.BI "\fBQAsciiCacheIterator\fR ( const QAsciiCacheIterator & ci )" -.br -.ti -1c -.BI "QAsciiCacheIterator & \fBoperator=\fR ( const QAsciiCacheIterator & ci )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBatFirst\fR () const" -.br -.ti -1c -.BI "bool \fBatLast\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "type * \fBtoLast\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "const char * \fBcurrentKey\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.ti -1c -.BI "type * \fBoperator+=\fR ( uint jump )" -.br -.ti -1c -.BI "type * \fBoperator--\fR ()" -.br -.ti -1c -.BI "type * \fBoperator-=\fR ( uint jump )" -.br -.in -1c -.SH DESCRIPTION -The QAsciiCacheIterator class provides an iterator for QAsciiCache collections. -.PP -Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them. -.PP -Multiple iterators are completely independent, even when they operate on the same QAsciiCache. QAsciiCache updates all iterators that refer an item when that item is removed. -.PP -QAsciiCacheIterator provides an operator++() and an operator+=() to traverse the cache; current() and currentKey() to access the current cache item and its key. It also provides atFirst() and atLast(), which return TRUE if the iterator points to the first or last item in the cache respectively. The isEmpty() function returns TRUE if the cache is empty; and count() returns the number of items in the cache. -.PP -Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also QAsciiCache, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCache & cache )" -Constructs an iterator for \fIcache\fR. The current iterator item is set to point to the first item in the \fIcache\fR. -.SH "QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCacheIterator & ci )" -Constructs an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current() but moves independently from there on. -.SH "bool QAsciiCacheIterator::atFirst () const" -Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also toFirst() and atLast(). -.SH "bool QAsciiCacheIterator::atLast () const" -Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also toLast() and atFirst(). -.SH "uint QAsciiCacheIterator::count () const" -Returns the number of items in the cache over which this iterator operates. -.PP -See also isEmpty(). -.SH "type * QAsciiCacheIterator::current () const" -Returns a pointer to the current iterator item. -.SH "const char * QAsciiCacheIterator::currentKey () const" -Returns the key for the current iterator item. -.SH "bool QAsciiCacheIterator::isEmpty () const" -Returns TRUE if the cache is empty, i.e. count() == 0; otherwise returns FALSE. -.PP -See also count(). -.SH "QAsciiCacheIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QAsciiCacheIterator::operator() ()" -Makes the succeeding item current and returns the original current item. -.PP -If the current iterator item was the last item in the cache or if it was 0, 0 is returned. -.SH "type * QAsciiCacheIterator::operator++ ()" -Prefix ++ makes the iterator point to the item just after current(), and makes that the new current item for the iterator. If current() was the last item, operator++() returns 0. -.SH "type * QAsciiCacheIterator::operator+= ( uint jump )" -Returns the item \fIjump\fR positions after the current item, or 0 if it is beyond the last item. Makes this the current item. -.SH "type * QAsciiCacheIterator::operator-- ()" -Prefix -- makes the iterator point to the item just before current(), and makes that the new current item for the iterator. If current() was the first item, operator--() returns 0. -.SH "type * QAsciiCacheIterator::operator-= ( uint jump )" -Returns the item \fIjump\fR positions before the current item, or 0 if it is before the first item. Makes this the current item. -.SH "QAsciiCacheIterator & QAsciiCacheIterator::operator= ( const QAsciiCacheIterator & ci )" -Makes this an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently thereafter. -.SH "type * QAsciiCacheIterator::toFirst ()" -Sets the iterator to point to the first item in the cache and returns a pointer to the item. -.PP -Sets the iterator to 0 and returns 0 if the cache is empty. -.PP -See also toLast() and isEmpty(). -.SH "type * QAsciiCacheIterator::toLast ()" -Sets the iterator to point to the last item in the cache and returns a pointer to the item. -.PP -Sets the iterator to 0 and returns 0 if the cache is empty. -.PP -See also isEmpty(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qasciicacheiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qasciicacheiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qasciidict.3qt b/doc/man/man3/qasciidict.3qt deleted file mode 100644 index 1298d4736..000000000 --- a/doc/man/man3/qasciidict.3qt +++ /dev/null @@ -1,317 +0,0 @@ -'\" t -.TH QAsciiDict 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 -QAsciiDict \- Template class that provides a dictionary based on char* keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAsciiDict\fR ( int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" -.br -.ti -1c -.BI "\fBQAsciiDict\fR ( const QAsciiDict & dict )" -.br -.ti -1c -.BI "\fB~QAsciiDict\fR ()" -.br -.ti -1c -.BI "QAsciiDict & \fBoperator=\fR ( const QAsciiDict & dict )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "void \fBinsert\fR ( const char * key, const type * item )" -.br -.ti -1c -.BI "void \fBreplace\fR ( const char * key, const type * item )" -.br -.ti -1c -.BI "bool \fBremove\fR ( const char * key )" -.br -.ti -1c -.BI "type * \fBtake\fR ( const char * key )" -.br -.ti -1c -.BI "type * \fBfind\fR ( const char * key ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( const char * key ) const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "void \fBresize\fR ( uint newsize )" -.br -.ti -1c -.BI "void \fBstatistics\fR () const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" -.br -.in -1c -.SH DESCRIPTION -The QAsciiDict class is a template class that provides a dictionary based on char* keys. -.PP -QAsciiDict is implemented as a template class. Define a template instance QAsciiDict to create a dictionary that operates on pointers to X (X*). -.PP -A dictionary is a collection of key-value pairs. The key is a char* used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. -.PP -QAsciiDict cannot handle Unicode keys; use the QDict template instead, which uses QString keys. A QDict has the same performace as a QAsciiDict. -.PP -Example: -.PP -.nf -.br - QAsciiDict fields; // char* keys, QLineEdit* values -.br - fields.insert( "forename", new QLineEdit( this ) ); -.br - fields.insert( "surname", new QLineEdit( this ) ); -.br -.br - fields["forename"]->setText( "Homer" ); -.br - fields["surname"]->setText( "Simpson" ); -.br -.br - QAsciiDictIterator it( fields ); // See QAsciiDictIterator -.br - for( ; it.current(); ++it ) -.br - cout << it.currentKey() << ": " << it.current()->text() << endl; -.br - cout << endl; -.br -.br - if ( fields["forename"] && fields["surname"] ) -.br - cout << fields["forename"]->text() << " " -.br -.br - << fields["surname"]->text() << endl; // Prints "Homer Simpson" -.br -.br - fields.remove( "forename" ); // Does not delete the line edit -.br - if ( ! fields["forename"] ) -.br - cout << "forename is not in the dictionary" << endl; -.br -.fi -In this example we use a dictionary to keep track of the line edits we're using. We insert each line edit into the dictionary with a unique name and then access the line edits via the dictionary. See QPtrDict, QIntDict and QDict. -.PP -See QDict for full details, including the choice of dictionary size, and how deletions are handled. -.PP -See also QAsciiDictIterator, QDict, QIntDict, QPtrDict, Collection Classes, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAsciiDict::QAsciiDict ( int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" -Constructs a dictionary optimized for less than \fIsize\fR entries. -.PP -We recommend setting \fIsize\fR to a suitably large prime number (a bit larger than the expected number of entries). This makes the hash distribution better and will improve lookup performance. -.PP -When \fIcaseSensitive\fR is TRUE (the default) QAsciiDict treats" abc" and "Abc" as different keys; when it is FALSE "abc" and" Abc" are the same. Case-insensitive comparison only considers the 26 letters in US-ASCII. -.PP -If \fIcopyKeys\fR is TRUE (the default), the dictionary copies keys using strcpy(); if it is FALSE, the dictionary just copies the pointers. -.SH "QAsciiDict::QAsciiDict ( const QAsciiDict & dict )" -Constructs a copy of \fIdict\fR. -.PP -Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). -.SH "QAsciiDict::~QAsciiDict ()" -Removes all items from the dictionary and destroys it. -.PP -The items are deleted if auto-delete is enabled. -.PP -All iterators that access this dictionary will be reset. -.PP -See also setAutoDelete(). -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QAsciiDict::clear ()\fC [virtual]\fR" -Removes all items from the dictionary. -.PP -The removed items are deleted if auto-deletion is enabled. -.PP -All dictionary iterators that operate on dictionary are reset. -.PP -See also remove(), take(), and setAutoDelete(). -.PP -Reimplemented from QPtrCollection. -.SH "uint QAsciiDict::count () const\fC [virtual]\fR" -Returns the number of items in the dictionary. -.PP -See also isEmpty(). -.PP -Reimplemented from QPtrCollection. -.SH "type * QAsciiDict::find ( const char * key ) const" -Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -This function uses an internal hashing algorithm to optimize lookup. -.PP -If there are two or more items with equal keys, then the item that was most recently inserted will be found. -.PP -Equivalent to the [] operator. -.PP -See also operator[](). -.SH "void QAsciiDict::insert ( const char * key, const type * item )" -Inserts the \fIkey\fR with the \fIitem\fR into the dictionary. -.PP -Multiple items can have the same key, in which case only the last item will be accessible using operator[](). -.PP -\fIitem\fR may not be 0. -.PP -See also replace(). -.SH "bool QAsciiDict::isEmpty () const" -Returns TRUE if the dictionary is empty, i.e. count() == 0; otherwise it returns FALSE. -.PP -See also count(). -.SH "QAsciiDict & QAsciiDict::operator= ( const QAsciiDict & dict )" -Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. -.PP -This dictionary is first cleared and then each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy) unless newItem() has been reimplemented(). -.SH "type * QAsciiDict::operator[] ( const char * key ) const" -Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -This function uses an internal hashing algorithm to optimize lookup. -.PP -If there are two or more items with equal keys, then the item that was most recently inserted will be found. -.PP -Equivalent to the find() function. -.PP -See also find(). -.SH "QDataStream & QAsciiDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QAsciiDict::remove ( const char * key )" -Removes the item associated with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if the key existed in the dictionary; otherwise returns FALSE. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be removed. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary traversal order. -.PP -See also take(), clear(), and setAutoDelete(). -.SH "void QAsciiDict::replace ( const char * key, const type * item )" -Replaces an item that has a key equal to \fIkey\fR with \fIitem\fR. -.PP -If the item does not already exist, it will be inserted. -.PP -\fIitem\fR may not be 0. -.PP -Equivalent to: -.PP -.nf -.br - QAsciiDict dict; -.br - ... -.br - if ( dict.find(key) ) -.br - dict.remove( key ); -.br - dict.insert( key, item ); -.br -.fi -.PP -If there are two or more items with equal keys, then the most recently inserted item will be replaced. -.PP -See also insert(). -.SH "void QAsciiDict::resize ( uint newsize )" -Changes the size of the hashtable to \fInewsize\fR. The contents of the dictionary are preserved but all iterators on the dictionary become invalid. -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. -.SH "uint QAsciiDict::size () const" -Returns the size of the internal hash array (as specified in the constructor). -.PP -See also count(). -.SH "void QAsciiDict::statistics () const" -Debugging-only function that prints out the dictionary distribution using tqDebug(). -.SH "type * QAsciiDict::take ( const char * key )" -Takes the item associated with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). -.PP -If there are two or more items with equal keys, then the most recently inserted item will be taken. -.PP -Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. -.PP -All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary traversal order. -.PP -See also remove(), clear(), and setAutoDelete(). -.SH "QDataStream & QAsciiDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" -Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqasciidict.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qasciidict.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qasciidictiterator.3qt b/doc/man/man3/qasciidictiterator.3qt deleted file mode 100644 index 9b31c7ec0..000000000 --- a/doc/man/man3/qasciidictiterator.3qt +++ /dev/null @@ -1,159 +0,0 @@ -'\" t -.TH QAsciiDictIterator 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 -QAsciiDictIterator \- Iterator for QAsciiDict collections -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAsciiDictIterator\fR ( const QAsciiDict & dict )" -.br -.ti -1c -.BI "\fB~QAsciiDictIterator\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "const char * \fBcurrentKey\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.ti -1c -.BI "type * \fBoperator+=\fR ( uint jump )" -.br -.in -1c -.SH DESCRIPTION -The QAsciiDictIterator class provides an iterator for QAsciiDict collections. -.PP -QAsciiDictIterator is implemented as a template class. Define a template instance QAsciiDictIterator to create a dictionary iterator that operates on QAsciiDict (dictionary of X*). -.PP -Example: -.PP -.nf -.br - QAsciiDict fields; -.br - fields.insert( "forename", new QLineEdit( this ) ); -.br - fields.insert( "surname", new QLineEdit( this ) ); -.br - fields.insert( "age", new QLineEdit( this ) ); -.br -.br - fields["forename"]->setText( "Homer" ); -.br - fields["surname"]->setText( "Simpson" ); -.br - fields["age"]->setText( "45" ); -.br -.br - QAsciiDictIterator it( fields ); -.br - for( ; it.current(); ++it ) -.br - cout << it.currentKey() << ": " << it.current()->text() << endl; -.br - cout << endl; -.br -.br - // Output (random order): -.br - // age: 45 -.br - // surname: Simpson -.br - // forename: Homer -.br -.fi -In the example we insert some line edits into a dictionary, then iterate over the dictionary printing the strings associated with those line edits. -.PP -Note that the traversal order is arbitrary; you are not guaranteed any particular order. -.PP -Multiple iterators may independently traverse the same dictionary. A QAsciiDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QAsciiDict updates all the iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order. -.PP -See also QAsciiDict, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAsciiDictIterator::QAsciiDictIterator ( const QAsciiDict & dict )" -Constructs an iterator for \fIdict\fR. The current iterator item is set to point on the first item in the \fIdict\fR. -.SH "QAsciiDictIterator::~QAsciiDictIterator ()" -Destroys the iterator. -.SH "uint QAsciiDictIterator::count () const" -Returns the number of items in the dictionary this iterator operates over. -.PP -See also isEmpty(). -.SH "type * QAsciiDictIterator::current () const" -Returns a pointer to the current iterator item. -.SH "const char * QAsciiDictIterator::currentKey () const" -Returns a pointer to the key for the current iterator item. -.SH "bool QAsciiDictIterator::isEmpty () const" -Returns TRUE if the dictionary is empty, i.e. count() == 0, otherwise returns FALSE. -.PP -See also count(). -.SH "QAsciiDictIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QAsciiDictIterator::operator() ()" -Makes the succeeding item current and returns the original current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QAsciiDictIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns the new current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QAsciiDictIterator::operator+= ( uint jump )" -Sets the current item to the item \fIjump\fR positions after the current item, and returns a pointer to that item. -.PP -If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0. -.SH "type * QAsciiDictIterator::toFirst ()" -Sets the current iterator item to point to the first item in the -dictionary and returns a pointer to the item. If the dictionary is -empty it sets the current item to 0 and returns 0. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qasciidictiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qasciidictiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qassistantclient.3qt b/doc/man/man3/qassistantclient.3qt deleted file mode 100644 index 87d20e918..000000000 --- a/doc/man/man3/qassistantclient.3qt +++ /dev/null @@ -1,143 +0,0 @@ -'\" t -.TH QAssistantClient 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 -QAssistantClient \- Means of using Qt Assistant as an application's help tool -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAssistantClient\fR ( const QString & path, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QAssistantClient\fR ()" -.br -.ti -1c -.BI "bool \fBisOpen\fR () const" -.br -.ti -1c -.BI "void \fBsetArguments\fR ( const QStringList & args )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBopenAssistant\fR ()" -.br -.ti -1c -.BI "virtual void \fBcloseAssistant\fR ()" -.br -.ti -1c -.BI "virtual void \fBshowPage\fR ( const QString & page )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBassistantOpened\fR ()" -.br -.ti -1c -.BI "void \fBassistantClosed\fR ()" -.br -.ti -1c -.BI "void \fBerror\fR ( const QString & msg )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBopen\fR - whether Qt Assistant is open \fI(read " "only" ")\fR" -.br -.in -1c -.SH DESCRIPTION -The QAssistantClient class provides a means of using Qt Assistant as an application's help tool. -.PP -Using Qt Assistant is simple: Create a QAssistantClient instance, then call showPage() as often as necessary to show your help pages. When you call showPage(), Qt Assistant will be launched if it isn't already running. -.PP -The QAssistantClient instance can open (openAssistant()) or close (closeAssistant()) Qt Assistant whenever required. If Qt Assistant is open, isOpen() returns TRUE. -.PP -One QAssistantClient instance interacts with one Qt Assistant instance, so every time you call openAssistant(), showPage() or closeAssistant() they are applied to the particular Qt Assistant instance associated with the QAssistantClient. -.PP -When you call openAssistant() the assistantOpened() signal is emitted. Similarly when closeAssistant() is called, assistantClosed() is emitted. In either case, if an error occurs, error() is emitted. -.PP -This class is not included in the Qt library itself. To use it you must link against \fClibqassistantclient.a\fR (Unix) or \fCqassistantclient.lib\fR (Windows), which is built into \fCINSTALL/lib\fR if you built the Qt tools (\fCINSTALL\fR is the directory where Qt is installed). If you use qmake, then you can simply add the following line to your pro file: -.PP -.nf -.br - LIBS += -lqassistantclient -.br -.fi -.PP -See also "Adding Documentation to Qt Assistant" in the Qt Assistant manual. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAssistantClient::QAssistantClient ( const QString & path, QObject * parent = 0, const char * name = 0 )" -Constructs an assistant client object. The \fIpath\fR specifies the path to the Qt Assistant executable. If \fIpath\fR is an empty string the system path (\fC%PATH%\fR or \fC$PATH\fR) is used. -.PP -The assistant client object is a child of \fIparent\fR and is called \fIname\fR. -.SH "QAssistantClient::~QAssistantClient ()" -Destroys the assistant client object and frees up all allocated resources. -.SH "void QAssistantClient::assistantClosed ()\fC [signal]\fR" -This signal is emitted when the connection to Qt Assistant is closed. This happens when the user exits Qt Assistant, or when an error in the server or client occurs, or if closeAssistant() is called. -.SH "void QAssistantClient::assistantOpened ()\fC [signal]\fR" -This signal is emitted when Qt Assistant is open and the client-server communication is set up. -.SH "void QAssistantClient::closeAssistant ()\fC [virtual slot]\fR" -Use this function to close Qt Assistant. -.PP -See also assistantClosed(). -.SH "void QAssistantClient::error ( const QString & msg )\fC [signal]\fR" -This signal is emitted if Qt Assistant cannot be started or if an error occurs during the initialization of the connection between Qt Assistant and the calling application. The \fImsg\fR provides an explanation of the error. -.SH "bool QAssistantClient::isOpen () const" -Returns TRUE if Qt Assistant is open; otherwise returns FALSE. See the "open" property for details. -.SH "void QAssistantClient::openAssistant ()\fC [virtual slot]\fR" -This function opens Qt Assistant and sets up the client-server communiction between the application and Qt Assistant. If it is already open, this function does nothing. If an error occurs, error() is emitted. -.PP -See also assistantOpened(). -.SH "void QAssistantClient::setArguments ( const QStringList & args )" -Sets the command line arguments used when Qt Assistant is started to \fIargs\fR. -.SH "void QAssistantClient::showPage ( const QString & page )\fC [virtual slot]\fR" -Call this function to make Qt Assistant show a particular \fIpage\fR. The \fIpage\fR is a filename (e.g. \fCmyhelpfile.html\fR). See "Adding Documentation to Qt Assistant" in the Qt Assistant manual for further information. -.PP -If Qt Assistant hasn't been opened yet, this function will do nothing. You can use isOpen() to determine whether Qt Assistant is up and running, or you can connect to the asssistantOpened() signal. -.PP -See also open and assistantOpened(). -.PP -Example: helpsystem/mainwindow.cpp. -.SS "Property Documentation" -.SH "bool open" -This property holds whether Qt Assistant is open. -.PP -Get this property's value with isOpen(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqassistantclient.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qassistantclient.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxaggregated.3qt b/doc/man/man3/qaxaggregated.3qt deleted file mode 100644 index bc457bbf7..000000000 --- a/doc/man/man3/qaxaggregated.3qt +++ /dev/null @@ -1,143 +0,0 @@ -'\" t -.TH QAxAggregated 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 -QAxAggregated \- Abstract base class for implementations of additional COM interfaces -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual long \fBqueryInterface\fR ( const QUuid & iid, void ** iface ) = 0" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "IUnknown * \fBcontrollingUnknown\fR () const" -.br -.ti -1c -.BI "QWidget * \fBwidget\fR () const" -.br -.ti -1c -.BI "QObject * \fBobject\fR () const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxAggregated class is an abstract base class for implementations of additional COM interfaces. -.PP -Create a subclass of QAxAggregated and reimplement queryInterface() to support additional COM interfaces. Use multiple inheritance from those COM interfaces. Implement the IUnknown interface of those COM interfaces by delegating the calls to QueryInterface(), AddRef() and Release() to the interface provided by controllingUnknown(). -.PP -Use the widget() method if you need to make calls to the QWidget implementing the ActiveX control. You must not store that pointer in your subclass (unless you use QGuardedPtr), as the QWidget can be destroyed by the ActiveQt framework at any time. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "IUnknown * QAxAggregated::controllingUnknown () const\fC [protected]\fR" -Returns the IUnknown interface of the ActiveX control. Implement the IUnknown interface in your QAxAggregated subclass to delegate calls to QueryInterface(), AddRef() and Release() to the interface provided by this function. -.PP -.nf -.br - HRESULT AxImpl::QueryInterface( REFIID iid, void **iface ) -.br - { -.br - return controllingUnknown()->QueryInterface( iid, iface ); -.br - } -.br -.br - unsigned long AxImpl::AddRef() -.br - { -.br - return controllingUnknown()->AddRef(); -.br - } -.br -.br - unsigned long AxImpl::Release() -.br - { -.br - return controllingUnknown()->Release(); -.br - } -.br -.fi -.PP -The QAXAGG_IUNKNOWN macro expands to the code above, and you can use it in the class declaration of your subclass. -.SH "QObject * QAxAggregated::object () const\fC [protected]\fR" -Returns a pointer to the QObject subclass implementing the COM object. This function might return 0. -.PP -\fBWarning:\fR You must not store the returned pointer, unless you use a QGuardedPtr, since the QObject can be destroyed by ActiveQt at any time. -.SH "long QAxAggregated::queryInterface ( const QUuid & iid, void ** iface )\fC [pure virtual]\fR" -Reimplement this pure virtual function to support additional COM interfaces. Set the value of \fIiface\fR to point to this object to support the interface \fIiid\fR. Note that you must cast the \fCthis\fR pointer to the appropriate superclass. -.PP -.nf -.br - long AxImpl::queryInterface( const QUuid &iid, void **iface ) -.br - { -.br - *iface = 0; -.br - if ( iid == IID_ISomeCOMInterface ) -.br - *iface = (ISomeCOMInterface*)this; -.br - else -.br - return E_NOINTERFACE; -.br -.br - AddRef(); -.br - return S_OK; -.br - } -.br -.fi -.PP -Return the standard COM results S_OK (interface is supported) or E_NOINTERFACE (requested interface is not supported). -.PP -\fBWarning:\fR Even though you must implement the IUnknown interface if you implement any COM interface you must not support the IUnknown interface in your queryInterface() implementation. -.SH "QWidget * QAxAggregated::widget () const\fC [protected]\fR" -Returns a pointer to the QWidget subclass implementing the ActiveX control. This function might return 0. -.PP -\fBWarning:\fR -You must not store the returned pointer, unless you use a -QGuardedPtr, since the QWidget can be destroyed by ActiveQt at any -time. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxaggregated.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxaggregated.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxbase.3qt b/doc/man/man3/qaxbase.3qt deleted file mode 100644 index 22326f9a4..000000000 --- a/doc/man/man3/qaxbase.3qt +++ /dev/null @@ -1,561 +0,0 @@ -'\" t -.TH QAxBase 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 -QAxBase \- Abstract class that provides an API to initalize and access a COM object -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -Inherited by QAxObject and QAxWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxBase\fR ( IUnknown * iface = 0 )" -.br -.ti -1c -.BI "virtual \fB~QAxBase\fR ()" -.br -.ti -1c -.BI "QString \fBcontrol\fR () const" -.br -.ti -1c -.BI "long \fBqueryInterface\fR ( const QUuid & uuid, void ** iface ) const" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, QValueList & vars )" -.br -.ti -1c -.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.ti -1c -.BI "PropertyBag \fBpropertyBag\fR () const" -.br -.ti -1c -.BI "void \fBsetPropertyBag\fR ( const PropertyBag & bag )" -.br -.ti -1c -.BI "QString \fBgenerateDocumentation\fR ()" -.br -.ti -1c -.BI "virtual bool \fBpropertyWritable\fR ( const char * prop ) const" -.br -.ti -1c -.BI "virtual void \fBsetPropertyWritable\fR ( const char * prop, bool ok )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "QVariant \fBasVariant\fR () const" -.br -.ti -1c -.BI "enum \fBPropertyBag\fR { }" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "bool \fBsetControl\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBdisableMetaObject\fR ()" -.br -.ti -1c -.BI "void \fBdisableClassInfo\fR ()" -.br -.ti -1c -.BI "void \fBdisableEventSink\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBsignal\fR ( const QString & name, int argc, void * argv )" -.br -.ti -1c -.BI "void \fBpropertyChanged\fR ( const QString & name )" -.br -.ti -1c -.BI "void \fBexception\fR ( int code, const QString & source, const QString & desc, const QString & help )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QString \fBcontrol\fR - the name of the COM object wrapped by this QAxBase object" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBinitialize\fR ( IUnknown ** ptr )" -.br -.ti -1c -.BI "bool \fBinitializeRemote\fR ( IUnknown ** ptr )" -.br -.ti -1c -.BI "bool \fBinitializeLicensed\fR ( IUnknown ** ptr )" -.br -.ti -1c -.BI "bool \fBinitializeActive\fR ( IUnknown ** ptr )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxBase class is an abstract class that provides an API to initalize and access a COM object. -.PP -QAxBase is an abstract class that cannot be used directly, and is instantiated through the subclasses QAxObject and QAxWidget. This class provides the API to access the COM object directly through its IUnknown implementation. If the COM object implements the IDispatch interface, the properties and methods of that object become available as Qt properties and slots. -.PP -.nf -.br - connect( buttonBack, SIGNAL(clicked()), webBrowser, SLOT(GoBack()) ); -.br -.fi -.PP -Properties exposed by the object's IDispatch implementation can be read and written through the property system provided by the Qt Object Model (both subclasses are QObjects, so you can use setProperty() and property() as with QObject). Properties with multiple parameters are not supported. -.PP -.nf -.br - activeX->setProperty( "text", "some text" ); -.br - int value = activeX->property( "value" ); -.br -.fi -.PP -Write-functions for properties and other methods exposed by the object's IDispatch implementation can be called directly using dynamicCall(), or indirectly as slots connected to a signal. -.PP -.nf -.br - webBrowser->dynamicCall( "GoHome()" ); -.br -.fi -.PP -Outgoing events supported by the COM object are emitted as standard Qt signals. -.PP -.nf -.br - connect( webBrowser, SIGNAL(TitleChanged(const QString&)), -.br - this, SLOT(setCaption(const QString&)) ); -.br -.fi -.PP -QAxBase transparently converts between COM data types and the equivalent Qt data types. Some COM types have no equivalent Qt data structure. -.PP -Supported COM datatypes are listed in the first column of following table. The second column is the Qt type that can be used with the QObject property functions. The third column is the Qt type that is used in the prototype of generated signals and slots for in-parameters, and the last column is the Qt type that is used in the prototype of signals and slots for out-parameters.
    .nf -.TS -l - l. COM type Qt property in-parameter out-parameter VARIANT_BOOL bool bool bool& BSTR QString const QString& QString& char, short, int, long int int int& uchar, ushort, uint, ulong uint uint uint& float, double double double double& DATE QDateTime const QDateTime& QDateTime& CY TQ_LLONG TQ_LLONG TQ_LLONG& OLE_COLOR QColor const QColor& QColor& SAFEARRAY(VARIANT) QValueList const QValueList& QValueList& SAFEARRAY(BYTE) QByteArray const QByteArray& QByteArray& SAFEARRAY(BSTR) QStringList const QStringList& QStringList& VARIANT type-dependent const QVariant& QVariant& IFontDisp* QFont const QFont& QFont& IPictureDisp* QPixmap const QPixmap& QPixmap& IDispatch* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) IUnknown* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) SCODE, DECIMAL \fIunsupported\fR \fIunsupported\fR -.TE -.fi -
    -.PP -Supported are also enumerations, and typedefs to supported types. -.PP -To call the methods of a COM interface described by the following IDL -.PP -.nf -.br - dispinterface IControl -.br - { -.br - properties: -.br - [id(1)] BSTR text; -.br - [id(2)] IFontDisp *font; -.br -.br - methods: -.br - [id(6)] void showColumn( [in] int i ); -.br - [id(3)] bool addColumn( [in] BSTR t ); -.br - [id(4)] int fillList( [in, out] SAFEARRAY(VARIANT) *list ); -.br - [id(5)] IDispatch *item( [in] int i ); -.br - }; -.br -.fi -use the QAxBase API like this: -.PP -.nf -.br - QAxObject object( "" ); -.br -.br - QString text = object.property( "text" ).toString(); -.br - object.setProperty( "font", QFont( "Times New Roman", 12 ) ); -.br -.br - connect( this, SIGNAL(clicked(int)), &object, SLOT(showColumn(int)) ); -.br - bool ok = object.dynamicCall( "addColumn(const QString&)", "Column 1" ).toBool(); -.br -.br - QValueList varlist; -.br - QValueList parameters; -.br - parameters << QVariant( varlist ); -.br - int n = object.dynamicCall( "fillList(QValueList&)", parameters ).toInt(); -.br -.br - QAxObject *item = object.querySubItem( "item(int)", 5 ); -.br -.fi -.PP -Note that the QValueList the object should fill has to be provided as an element in the parameter list of QVariants. -.PP -If you need to access properties or pass parameters of unsupported datatypes you must access the COM object directly through its IDispatch implementation or other interfaces. Those interfaces can be retrieved through queryInterface(). -.PP -.nf -.br - IUnknown *iface = 0; -.br - activeX->queryInterface( IID_IUnknown, (void**)&iface ); -.br - if ( iface ) { -.br - // use the interface -.br - iface->Release(); -.br - } -.br -.fi -.PP -To get the definition of the COM interfaces you will have to use the header files provided with the component you want to use. Some compilers can also import type libraries using the #import compiler directive. See the component documentation to find out which type libraries you have to import, and how to use them. -.PP -If you need to react to events that pass parameters of unsupported datatypes you can use the generic signal that delivers the event data as provided by the COM event. -.SS "Member Type Documentation" -.SH "QAxBase::PropertyBag" -A QMap that can store properties as name:value pairs. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxBase::QAxBase ( IUnknown * iface = 0 )" -Creates a QAxBase object that wraps the COM object \fIiface\fR. If \fIiface\fR is 0 (the default), use setControl() to instantiate a COM object. -.SH "QAxBase::~QAxBase ()\fC [virtual]\fR" -Shuts down the COM object and destroys the QAxBase object. -.PP -See also clear(). -.SH "QVariant QAxBase::asVariant () const" -Returns a QVariant that wraps the COM object. The variant can then be used as a parameter in e.g. dynamicCall(). -.SH "void QAxBase::clear ()\fC [virtual]\fR" -Disconnects and destroys the COM object. -.PP -If you reimplement this function you must also reimplement the destructor to call clear(), and call this implementation at the end of your clear() function. -.SH "QString QAxBase::control () const" -Returns the name of the COM object wrapped by this QAxBase object. See the "control" property for details. -.SH "void QAxBase::disableClassInfo ()" -Disables the class info generation for this ActiveX container. If you don't require any class information about the ActiveX control use this function to speed up the meta object generation. -.PP -Note that this function must be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). -.SH "void QAxBase::disableEventSink ()" -Disables the event sink implementation for this ActiveX container. If you don't intend to listen to the ActiveX control's events use this function to speed up the meta object generation. -.PP -Some ActiveX controls might be unstable when connected to an event sink. To get OLE events you must use standard COM methods to register your own event sink. Use queryInterface() to get access to the raw COM object. -.PP -Note that this function should be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). -.SH "void QAxBase::disableMetaObject ()" -Disables the meta object generation for this ActiveX container. This also disables the event sink and class info generation. If you don't intend to use the Qt meta object implementation call this function to speed up the meta object generation. -.PP -Some ActiveX controls might be unstable when used with OLE automation. Use standard COM methods to use those controls through the COM interfaces provided by queryInterface(). -.PP -Note that this function must be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Calls the COM object's method \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed. -.PP -If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call. -.PP -.nf -.br - activeX->dynamicCall( "Navigate(const QString&)", "www.trolltech.com" ); -.br -.fi -.PP -Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using -.PP -.nf -.br - activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); -.br -.fi -All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. -.PP -If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. -.PP -.nf -.br - activeX->dynamicCall( "Value", 5 ); -.br - QString text = activeX->dynamicCall( "Text" ).toString(); -.br -.fi -Note that it is faster to get and set properties using QObject::property() and QObject::setProperty(). -.PP -It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly. -.PP -.nf -.br - IWebBrowser2 *webBrowser = 0; -.br - activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); -.br - if ( webBrowser ) { -.br - webBrowser->Navigate2( pvarURL ); -.br - webBrowser->Release(); -.br - } -.br -.fi -.PP -This is also more efficient. -.PP -Example: qutlook/centralwidget.cpp. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, QValueList & vars )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calls the COM object's method \fIfunction\fR, passing the parameters in \fIvars\fR, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object. -.PP -The QVariant objects in \fIvars\fR are updated when the method has out-parameters. -.SH "void QAxBase::exception ( int code, const QString & source, const QString & desc, const QString & help )\fC [signal]\fR" -This signal is emitted when the COM object throws an exception while called using the OLE automation interface IDispatch. \fIcode\fR, \fIsource\fR, \fIdesc\fR and \fIhelp\fR provide information about the exception as provided by the COM server and can be used to provide useful feedback to the end user. \fIhelp\fR includes the help file, and the help context ID in brackets, e.g. "filename [id]". -.SH "QString QAxBase::generateDocumentation ()" -Returns a rich text string with documentation for the wrapped COM object. Dump the string to an HTML-file, or use it in e.g. a QTextBrowser widget. -.SH "bool QAxBase::initialize ( IUnknown ** ptr )\fC [virtual protected]\fR" -This virtual function is called by setControl() and creates the requested COM object. \fIptr\fR is set to the object's IUnknown implementation. The function returns TRUE if the object initialization succeeded; otherwise the function returns FALSE. -.PP -The default implementation interprets the string returned by control(), and calls initializeRemote(), initializeLicensed() or initializeActive() if the string matches the respective patterns. If no pattern is matched, or if remote or licensed initialization fails, CoCreateInstance is used directly to create the object. -.PP -See the control property documentation for details about supported patterns. -.PP -The interface returned in \fIptr\fR must be referenced exactly once when this function returns. The interface provided by e.g. CoCreateInstance is already referenced, and there is no need to reference it again. -.SH "bool QAxBase::initializeActive ( IUnknown ** ptr )\fC [protected]\fR" -Returns an active instance running on the current machine, and returns the IUnknown interface to the running object in \fIptr\fR. This function returns TRUE if successful, otherwise returns FALSE. -.PP -This function is called by initialize() if the control string contains the substring "}&". -.PP -See also initialize(). -.SH "bool QAxBase::initializeLicensed ( IUnknown ** ptr )\fC [protected]\fR" -Creates an instance of a licensed control, and returns the IUnknown interface to the object in \fIptr\fR. This functions returns TRUE if successful, otherwise returns FALSE. -.PP -This function is called by initialize() if the control string contains the substring "}:". The license key needs to follow this substring. -.PP -See also initialize(). -.SH "bool QAxBase::initializeRemote ( IUnknown ** ptr )\fC [protected]\fR" -Creates the instance on a remote server, and returns the IUnknown interface to the object in \fIptr\fR. This function returns TRUE if successful, otherwise returns FALSE. -.PP -This function is called by initialize() if the control string contains the substring "/{". The information about the remote machine needs to be provided in front of the substring. -.PP -See also initialize(). -.SH "bool QAxBase::isNull () const" -Returns TRUE if there is no COM object loaded by this wrapper; otherwise return FALSE. -.PP -See also control. -.SH "PropertyBag QAxBase::propertyBag () const" -Returns a name:value map of all the properties exposed by the COM object. -.PP -This is more efficient than getting multiple properties individually if the COM object supports property bags. -.PP -\fBWarning:\fR It is not guaranteed that the property bag implementation of the COM object returns all properties, or that the properties returned are the same as those available through the IDispatch interface. -.SH "void QAxBase::propertyChanged ( const QString & name )\fC [signal]\fR" -If the COM object supports property notification, this signal gets emitted when the property called \fIname\fR is changed. -.SH "bool QAxBase::propertyWritable ( const char * prop ) const\fC [virtual]\fR" -Returns TRUE if the property \fIprop\fR is writable; otherwise returns FALSE. By default, all properties are writable. -.PP -\fBWarning:\fR Depending on the control implementation this setting might be ignored for some properties. -.PP -See also setPropertyWritable() and propertyChanged(). -.SH "long QAxBase::queryInterface ( const QUuid & uuid, void ** iface ) const" -Requests the interface \fIuuid\fR from the COM object and sets the value of \fIiface\fR to the provided interface, or to 0 if the requested interface could not be provided. -.PP -Returns the result of the QueryInterface implementation of the COM object. -.PP -See also control. -.SH "QAxObject * QAxBase::querySubObject ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. -.PP -If \fIname\fR is provided by a method the string must include the full function prototype. -.PP -If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. -.PP -The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. -.PP -COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. -.PP -.nf -.br - QAxWidget outlook( "Outlook.Application" ); -.br - QAxObject *session = outlook.querySubObject( "Session" ); -.br - if ( session ) { -.br - QAxObject *defFolder = session->querySubObject( -.br - "GetDefaultFolder(OlDefaultFolders)", -.br - "olFolderContacts" ); -.br - //... -.br - } -.br -.fi -.PP -Example: qutlook/centralwidget.cpp. -.SH "bool QAxBase::setControl ( const QString & )" -Sets the name of the COM object wrapped by this QAxBase object. See the "control" property for details. -.SH "void QAxBase::setPropertyBag ( const PropertyBag & bag )" -Sets the properties of the COM object to the corresponding values in \fIbag\fR. -.PP -\fBWarning:\fR You should only set property bags that have been returned by the propertyBag function, as it cannot be guaranteed that the property bag implementation of the COM object supports the same properties that are available through the IDispatch interface. -.PP -See also propertyBag(). -.SH "void QAxBase::setPropertyWritable ( const char * prop, bool ok )\fC [virtual]\fR" -Sets the property \fIprop\fR to writable if \fIok\fR is TRUE, otherwise sets \fIprop\fR to be read-only. By default, all properties are writable. -.PP -\fBWarning:\fR Depending on the control implementation this setting might be ignored for some properties. -.PP -See also propertyWritable() and propertyChanged(). -.SH "void QAxBase::signal ( const QString & name, int argc, void * argv )\fC [signal]\fR" -This generic signal gets emitted when the COM object issues the event \fIname\fR. \fIargc\fR is the number of parameters provided by the event (DISPPARAMS.cArgs), and \fIargv\fR is the pointer to the parameter values (DISPPARAMS.rgvarg). Note that the order of parameter values is turned around, ie. the last element of the array is the first parameter in the function. -.PP -.nf -.br - void Receiver::slot( const QString &name, int argc, void *argv ) -.br - { -.br - VARIANTARG *params = (VARIANTARG*)argv; -.br - if ( name.startsWith( "BeforeNavigate2(" ) ) { -.br - IDispatch *pDisp = params[argc-1].pdispVal; -.br - VARIANTARG URL = *params[argc-2].pvarVal; -.br - VARIANTARG Flags = *params[argc-3].pvarVal; -.br - VARIANTARG TargetFrameName = *params[argc-4].pvarVal; -.br - VARIANTARG PostData = *params[argc-5].pvarVal; -.br - VARIANTARG Headers = *params[argc-6].pvarVal; -.br - bool *Cancel = params[argc-7].pboolVal; -.br - } -.br - } -.br -.fi -.PP -Use this signal if the event has parameters of unsupported data types. Otherwise, connect directly to the signal \fIname\fR. -.SS "Property Documentation" -.SH "QString control" -This property holds the name of the COM object wrapped by this QAxBase object. -.PP -Setting this property initilializes the COM object. Any COM object previously set is shut down. -.PP -The most efficient way to set this property is by using the registered component's UUID, e.g. -.PP -.nf -.br - ctrl->setControl( "{8E27C92B-1264-101C-8A2F-040224009C02}" ); -.br -.fi -The second fastest way is to use the registered control's class name (with or without version number), e.g. -.PP -.nf -.br - ctrl->setControl( "MSCal.Calendar" ); -.br -.fi -The slowest, but easiest way to use is to use the control's full name, e.g. -.PP -.nf -.br - ctrl->setControl( "Calendar Control 9.0" ); -.br -.fi -.PP -If the component's UUID is used the following patterns can be used to initialize the control on a remote machine, to initialize a licensed control or to connect to a running object: -.TP -To initialize the control on a different machine use the following pattern: -.IP -.nf -.br - :@server/{8E27C92B-1264-101C-8A2F-040224009C02} -.br -.fi -.TP -To initialize a licensed control use the following pattern: -.IP -.nf -.br - {8E27C92B-1264-101C-8A2F-040224009C02}: -.br -.fi -.TP -To connect to an already running object use the following pattern: -.IP -.nf -.br - {8E27C92B-1264-101C-8A2F-040224009C02}& -.br -.fi -The first two patterns can be combined, e.g. to initialize a licensed control on a remote machine: -.PP -.nf -.br - ctrl->setControl("DOMAIN/user:password@server/{8E27C92B-1264-101C-8A2F-040224009C02}:LicenseKey"); -.br -.fi -.PP -The control's read function always returns the control's UUID, if provided including the license key, and the name of the server, but not including the username, the domain or the password. -.PP -Set this property's value with setControl() and get this property's value with control(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxbase.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxbase.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxbindable.3qt b/doc/man/man3/qaxbindable.3qt deleted file mode 100644 index 92f69ba8a..000000000 --- a/doc/man/man3/qaxbindable.3qt +++ /dev/null @@ -1,152 +0,0 @@ -'\" t -.TH QAxBindable 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 -QAxBindable \- Interface between a QWidget and an ActiveX client -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxBindable\fR ()" -.br -.ti -1c -.BI "virtual \fB~QAxBindable\fR ()" -.br -.ti -1c -.BI "virtual QAxAggregated * \fBcreateAggregate\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBreportError\fR ( int code, const QString & src, const QString & desc, const QString & context = QString::null )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "bool \fBrequestPropertyChange\fR ( const char * property )" -.br -.ti -1c -.BI "void \fBpropertyChanged\fR ( const char * property )" -.br -.ti -1c -.BI "IUnknown * \fBclientSite\fR () const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxBindable class provides an interface between a QWidget and an ActiveX client. -.PP -The functions provided by this class allow an ActiveX control to communicate property changes to a client application. Inherit your control class from both QWidget (directly or indirectly) and this class to get access to this class's functions. The meta object compiler requires you to inherit from QWidget \fIfirst\fR. -.PP -.nf -.br - class MyActiveX : public QWidget, public QAxBindable -.br - { -.br - TQ_OBJECT -.br - TQ_PROPERTY( int value READ value WRITE setValue ) -.br - public: -.br - MyActiveX( QWidget *parent = 0, const char *name = 0 ); -.br - ... -.br -.br - int value() const; -.br - void setValue( int ); -.br - }; -.br -.fi -.PP -When implementing the property write function, use requestPropertyChange() to get permission from the ActiveX client application to change this property. When the property changes, call propertyChanged() to notify the ActiveX client application about the change. If a fatal error occurs in the control, use the static reportError() function to notify the client. -.PP -Use the interface returned by clientSite() to call the ActiveX client. To implement additional COM interfaces in your ActiveX control, reimplement createAggregate() to return a new object of a QAxAggregated subclass. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxBindable::QAxBindable ()" -Constructs an empty QAxBindable object. -.SH "QAxBindable::~QAxBindable ()\fC [virtual]\fR" -Destroys the QAxBindable object. -.SH "IUnknown * QAxBindable::clientSite () const\fC [protected]\fR" -Returns a pointer to the client site interface for this ActiveX object, or null if no client site has been set. -.PP -Call QueryInterface() on the returned interface to get the interface you want to call. -.SH "QAxAggregated * QAxBindable::createAggregate ()\fC [virtual]\fR" -Reimplement this function when you want to implement additional COM interfaces in the ActiveX control, or when you want to provide alternative implementations of COM interfaces. Return a new object of a QAxAggregated subclass. -.PP -The default implementation returns the null pointer. -.SH "void QAxBindable::propertyChanged ( const char * property )\fC [protected]\fR" -Call this function to notify the client that is hosting this ActiveX control that the property \fIproperty\fR has been changed. -.PP -This function is usually called at the end of the property's write function. -.PP -See also requestPropertyChange(). -.SH "void QAxBindable::reportError ( int code, const QString & src, const QString & desc, const QString & context = QString::null )\fC [static]\fR" -Reports an error to the client application. \fIcode\fR is a control-defined error code. \fIdesc\fR is a human-readable description of the error intended for the application user. \fIsrc\fR is the name of the source for the error, typically the ActiveX server name. \fIcontext\fR can be the location of a help file with more information about the error. If \fIcontext\fR ends with a number in brackets, e.g. [12], this number will be interpreted as the context ID in the help file. -.SH "bool QAxBindable::requestPropertyChange ( const char * property )\fC [protected]\fR" -Call this function to request permission to change the property \fIproperty\fR from the client that is hosting this ActiveX control. Returns TRUE if the client allows the change; otherwise returns FALSE. -.PP -This function is usually called first in the write function for \fIproperty\fR, and writing is abandoned if the function returns FALSE. -.PP -.nf -.br - void MyActiveQt::setText( const QString &text ) -.br - { -.br - if ( !requestPropertyChange( "text" ) ) -.br - return; -.br -.br - // update property -.br -.br - propertyChanged( "text" ); -.br - } -.br -.fi -.PP -See also propertyChanged(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxbindable.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxbindable.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxfactory.3qt b/doc/man/man3/qaxfactory.3qt deleted file mode 100644 index 6f0392019..000000000 --- a/doc/man/man3/qaxfactory.3qt +++ /dev/null @@ -1,436 +0,0 @@ -'\" t -.TH QAxFactory 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 -QAxFactory \- Defines a factory for the creation of COM components -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxFactory\fR ( const QUuid & libid, const QUuid & appid )" -.br -.ti -1c -.BI "virtual \fB~QAxFactory\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBfeatureList\fR () const = 0" -.br -.ti -1c -.BI "virtual QWidget * \fBcreate\fR ( const QString & key, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual QObject * \fBcreateObject\fR ( const QString & key, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual QMetaObject * \fBmetaObject\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBcreateObjectWrapper\fR ( QObject * object, IDispatch ** wrapper )" -.br -.ti -1c -.BI "virtual QUuid \fBclassID\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual QUuid \fBinterfaceID\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual QUuid \fBeventsID\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual QUuid \fBtypeLibID\fR () const" -.br -.ti -1c -.BI "virtual QUuid \fBappID\fR () const" -.br -.ti -1c -.BI "virtual void \fBregisterClass\fR ( const QString & key, QSettings * settings ) const" -.br -.ti -1c -.BI "virtual void \fBunregisterClass\fR ( const QString & key, QSettings * settings ) const" -.br -.ti -1c -.BI "virtual bool \fBvalidateLicenseKey\fR ( const QString & key, const QString & licenseKey ) const" -.br -.ti -1c -.BI "virtual QString \fBexposeToSuperClass\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBstayTopLevel\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBhasStockEvents\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBisService\fR () const" -.br -.ti -1c -.BI "enum \fBServerType\fR { SingleInstance, MultipleInstances }" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBisServer\fR ()" -.br -.ti -1c -.BI "QString \fBserverDirPath\fR ()" -.br -.ti -1c -.BI "QString \fBserverFilePath\fR ()" -.br -.ti -1c -.BI "bool \fBstartServer\fR ( ServerType type = MultipleInstances )" -.br -.ti -1c -.BI "bool \fBstopServer\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxFactory class defines a factory for the creation of COM components. -.PP - -.PP -Implement this factory once in your ActiveX server to provide information about the components the server can create. If your server supports just a single ActiveX control, you can use the default factory implementation instead of implementing the factory yourself. Use the QAXFACTORY_DEFAULT macro in any implementation file (e.g. main.cpp) to instantiate and export the default factory: -.PP -.nf -.br - #include -.br - #include -.br -.br - #include "theactivex.h" -.br -.br - QAXFACTORY_DEFAULT( -.br - TheActiveX, // widget class -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // class ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // interface ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // event interface ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID -.br - ) -.br -.fi -.PP -If you implement your own factory reimplement the pure virtual functions, provide the unique identifiers for the ActiveX controls, and use the QAXFACTORY_EXPORT macro to instantiate and export it: -.PP -.nf -.br - QStringList ActiveQtFactory::featureList() const -.br - { -.br - QStringList list; -.br - list << "ActiveX1"; -.br - list << "ActiveX2"; -.br - ... -.br - return list; -.br - } -.br -.br - QWidget *ActiveQtFactory::create( const QString &key, QWidget *parent, const char *name ) -.br - { -.br - if ( key == "ActiveX1" ) -.br - return new ActiveX1( parent, name ); -.br - if ( key == "ActiveX2" ) -.br - return new ActiveX2( parent, name ); -.br - ... -.br - return 0; -.br - } -.br -.br - QUuid ActiveQtFactory::classID( const QString &key ) const -.br - { -.br - if ( key == "ActiveX1" ) -.br - return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; -.br - ... -.br - return QUuid(); -.br - } -.br -.br - QUuid ActiveQtFactory::interfaceID( const QString &key ) const -.br - { -.br - if ( key == "ActiveX1" ) -.br - return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; -.br - ... -.br - return QUuid(); -.br - } -.br -.br - QUuid ActiveQtFactory::eventsID( const QString &key ) const -.br - { -.br - if ( key == "ActiveX1" ) -.br - return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; -.br - ... -.br - return QUuid(); -.br - } -.br -.br - QAXFACTORY_EXPORT( -.br - MyFactory, // factory class -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID -.br - ) -.br -.fi -.PP -If you use the \fCTQ_CLASSINFO\fR macro to provide the unique identifiers or other attributes for your class you can use the QAXFACTORY_BEGIN, QAXCLASS and QAXFACTORY_END macros to expose one or more classes as COM objects. -.PP -.nf -.br - QAXFACTORY_BEGIN( -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID -.br - ) -.br - QAXCLASS(Class1) -.br - QAXCLASS(Class2) -.br - QAXFACTORY_END() -.br -.fi -.PP -Only one QAxFactory implementation may be instantiated and exported by an ActiveX server application. This instance is accessible through the global qAxFactory() function. -.PP -A factory can also reimplement the registerClass() and unregisterClass() functions to set additional flags for an ActiveX control in the registry. To limit the number of methods or properties a widget class exposes from its parent classes reimplement exposeToSuperClass(). -.SS "Member Type Documentation" -.SH "QAxFactory::ServerType" -This enum specifies the different types of servers that can be started with startServer. -.TP -\fCQAxFactory::SingleInstance\fR - The server can create only one instance of each supplied class. -.TP -\fCQAxFactory::MultipleInstances\fR - The server can create multiple instances of each supplied class. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxFactory::QAxFactory ( const QUuid & libid, const QUuid & appid )" -Constructs a QAxFactory object that returns \fIlibid\fR and \fIappid\fR in the implementation of the respective interface functions. -.SH "QAxFactory::~QAxFactory ()\fC [virtual]\fR" -Destroys the QAxFactory object. -.SH "QUuid QAxFactory::appID () const\fC [virtual]\fR" -Reimplement this function to return the ActiveX server's application identifier. -.SH "QUuid QAxFactory::classID ( const QString & key ) const\fC [virtual]\fR" -Reimplement this function to return the class identifier for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "ClassID". -.SH "QWidget * QAxFactory::create ( const QString & key, QWidget * parent = 0, const char * name = 0 )\fC [virtual]\fR" -Reimplement this function to return a new widget for \fIkey\fR. Propagate \fIparent\fR and \fIname\fR to the QWidget constructor. Return 0 if this factory doesn't support the value of \fIkey\fR. -.PP -The returned widget will be exposed as an ActiveX control, e.g. a COM object that can be embedded as a control into applications. -.PP -The default implementation returns 0. -.SH "QObject * QAxFactory::createObject ( const QString & key, QObject * parent = 0, const char * name = 0 )\fC [virtual]\fR" -Reimplement this function to return a new object for \fIkey\fR. Propagate \fIparent\fR and \fIname\fR to the QWidget constructor. Return 0 if this factory doesn't support the value of \fIkey\fR. -.PP -If the object returned is a QWidget it will be exposed as an ActiveX control, otherwise the returned object will be exposed as a COM object. -.PP -The default implementation returns the result QAxFactory::create() if \fIparent\fR is 0 or a widget, otherwise returns 0. -.SH "bool QAxFactory::createObjectWrapper ( QObject * object, IDispatch ** wrapper )\fC [virtual]\fR" -Reimplement this function to provide the COM object for \fIobject\fR in \fIwrapper\fR. Return TRUE if the function was successfull, otherwise return FALSE. -.PP -The default implementation creates a generic automation wrapper based on the meta object information of \fIobject\fR. -.SH "QUuid QAxFactory::eventsID ( const QString & key ) const\fC [virtual]\fR" -Reimplement this function to return the identifier of the event interface for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "EventsID". -.SH "QString QAxFactory::exposeToSuperClass ( const QString & key ) const\fC [virtual]\fR" -Reimplement this function to return the name of the super class of \fIkey\fR up to which methods and properties should be exposed by the ActiveX control. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "ToSuperClass". If no such value is set the null-string is returned, and the functions and properties of all the super classes including QWidget will be exposed. -.PP -To only expose the functions and properties of the class itself, reimplement this function to return \fIkey\fR. -.SH "QStringList QAxFactory::featureList () const\fC [pure virtual]\fR" -Reimplement this function to return a list of the widgets (class names) supported by this factory. -.SH "bool QAxFactory::hasStockEvents ( const QString & key ) const\fC [virtual]\fR" -Reimplement this function to return TRUE if the ActiveX control \fIkey\fR should support the standard ActiveX events -.TP -Click -.TP -DblClick -.TP -KeyDown -.TP -KeyPress -.TP -KeyUp -.TP -MouseDown -.TP -MouseUp -.TP -MouseMove -.PP -The default implementation interprets \fIkey\fR as the class name, and returns TRUE if the value of the TQ_CLASSINFO entry "StockEvents" is "yes". Otherwise this function returns FALSE. -.SH "QUuid QAxFactory::interfaceID ( const QString & key ) const\fC [virtual]\fR" -Reimplement this function to return the interface identifier for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "InterfaceID". -.SH "bool QAxFactory::isServer ()\fC [static]\fR" -Returns TRUE if the application has been started (by COM) as an ActiveX server, otherwise returns FALSE. -.PP -.nf -.br - int main( int argc, char**argv ) -.br - { -.br - QApplication app( argc, argv ); -.br -.br - if ( !QAxFactory::isServer() ) { -.br - // initialize for stand-alone execution -.br - } -.br -.br - return app.exec() // standard event processing -.br - } -.br -.fi -.SH "bool QAxFactory::isService () const\fC [virtual]\fR" -Reimplement this function to return TRUE if the server is running as a persistent service (e.g. an NT service) and should not terminate even when all objects provided have been released. -.PP -The default implementation returns FALSE. -.SH "QMetaObject * QAxFactory::metaObject ( const QString & key ) const\fC [virtual]\fR" -Reimplement this function to return the QMetaObject corresponding to \fIkey\fR, or 0 if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation returns the QMetaObject for the class \fIkey\fR. -.SH "void QAxFactory::registerClass ( const QString & key, QSettings * settings ) const\fC [virtual]\fR" -Registers additional values for the class \fIkey\fR in the system registry using the \fIsettings\fR object. The standard values have already been registed by the framework, but additional values, e.g. implemented categories, can be added in an implementation of this function. -.PP -.nf -.br - settings->writeEntry( "/CLSID/" + classID(key) + "/Implemented Categories/{00000000-0000-0000-000000000000}/.", QString::null ); -.br -.fi -.PP -If you reimplement this function you must also reimplement unregisterClass() to remove the additional registry values. -.PP -See also QSettings. -.SH "QString QAxFactory::serverDirPath ()\fC [static]\fR" -Returns the directory that contains the server binary. -.PP -For out-of-process servers this is the same as QApplication::applicationDirPath(). For in-process servers that function returns the directory that contains the hosting application. -.SH "QString QAxFactory::serverFilePath ()\fC [static]\fR" -Returns the file path of the server binary. -.PP -For out-of-process servers this is the same as QApplication::applicationFilePath(). For in-process servers that function returns the file path of the hosting application. -.SH "bool QAxFactory::startServer ( ServerType type = MultipleInstances )\fC [static]\fR" -Starts the COM server with \fItype\fR and returns TRUE if successful, otherwise returns FALSE. -.PP -Calling this function if the server is already running (or for an in-process server) does nothing and returns TRUE. -.PP -The server is started automatically with \fItype\fR set to MultipleUse if the server executable has been started with the \fC-activex\fR command line parameter. -.SH "bool QAxFactory::stayTopLevel ( const QString & key ) const\fC [virtual]\fR" -Reimplement this function to return TRUE if the ActiveX control \fIkey\fR should be a top level window, e.g. a dialog. The default implementation returns FALSE. -.SH "bool QAxFactory::stopServer ()\fC [static]\fR" -Stops the COM server and returns TRUE if successful, otherwise returns FALSE. -.PP -Calling this function if the server is not running (or for an in-process server) does nothing and returns TRUE. -.PP -Stopping the server will not invalidate existing objects, but no new objects can be created from the existing server process. Usually COM will start a new server process if additional objects are requested. -.PP -The server is stopped automatically when the main() function returns. -.SH "QUuid QAxFactory::typeLibID () const\fC [virtual]\fR" -Reimplement this function to return the ActiveX server's type library identifier. -.SH "void QAxFactory::unregisterClass ( const QString & key, QSettings * settings ) const\fC [virtual]\fR" -Unregisters any additional values for the class \fIkey\fR from the system registry using the \fIsettings\fR object. -.PP -.nf -.br - settings->removeEntry( "/CLSID/" + classID(key) + "/Implemented Categories/{00000000-0000-0000-000000000000}/." ); -.br -.fi -.PP -See also registerClass() and QSettings. -.SH "bool QAxFactory::validateLicenseKey ( const QString & key, const QString & licenseKey ) const\fC [virtual]\fR" -Reimplement this function to return TRUE if \fIlicenseKey\fR is a valid license for the class \fIkey\fR, or if the current machine is licensed. -.PP -The default implementation returns TRUE if the class \fIkey\fR is not -licensed (ie. no TQ_CLASSINFO attribute "LicenseKey"), or if -\fIlicenseKey\fR matches the value of the "LicenseKey" attribute, or -if the machine is licensed through a .LIC file with the same filename -as this COM server. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxobject.3qt b/doc/man/man3/qaxobject.3qt deleted file mode 100644 index f1b606741..000000000 --- a/doc/man/man3/qaxobject.3qt +++ /dev/null @@ -1,183 +0,0 @@ -'\" t -.TH QAxObject 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 -QAxObject \- QObject that wraps a COM object -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QObject and QAxBase. -.PP -Inherited by QAxScriptEngine. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxObject\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQAxObject\fR ( const QString & c, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQAxObject\fR ( IUnknown * iface, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QAxObject\fR ()" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, QValueList & vars )" -.br -.ti -1c -.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxObject class provides a QObject that wraps a COM object. -.PP -A QAxObject can be instantiated as an empty object, with the name of the COM object it should wrap, or with a pointer to the IUnknown that represents an existing COM object. If the COM object implements the IDispatch interface, the properties, methods and events of that object become available as Qt properties, slots and signals. The base class, QAxBase, provides an API to access the COM object directly through the IUnknown pointer. -.PP -QAxObject is a QObject and can be used as such, e.g. it can be organized in an object hierarchy, receive events and connect to signals and slots. -.PP -\fBWarning:\fR You can subclass QAxObject, but you cannot use the TQ_OBJECT macro in the subclass (the generated moc-file will not compile), so you cannot add further signals, slots or properties. This limitation is due to the metaobject information generated in runtime. To work around this problem, aggregate the QAxObject as a member of the QObject subclass. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxObject::QAxObject ( QObject * parent = 0, const char * name = 0 )" -Creates an empty COM object and propagates \fIparent\fR and \fIname\fR to the QObject constructor. To initialize the object, call setControl. -.SH "QAxObject::QAxObject ( const QString & c, QObject * parent = 0, const char * name = 0 )" -Creates a QAxObject that wraps the COM object \fIc\fR. \fIparent\fR and \fIname\fR are propagated to the QWidget contructor. -.PP -See also control. -.SH "QAxObject::QAxObject ( IUnknown * iface, QObject * parent = 0, const char * name = 0 )" -Creates a QAxObject that wraps the COM object referenced by \fIiface\fR. \fIparent\fR and \fIname\fR are propagated to the QObject contructor. -.SH "QAxObject::~QAxObject ()" -Releases the COM object and destroys the QAxObject, cleaning up all allocated resources. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Calls the COM object's method \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed. -.PP -If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call. -.PP -.nf -.br - activeX->dynamicCall( "Navigate(const QString&)", "www.trolltech.com" ); -.br -.fi -.PP -Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using -.PP -.nf -.br - activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); -.br -.fi -All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. -.PP -If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. -.PP -.nf -.br - activeX->dynamicCall( "Value", 5 ); -.br - QString text = activeX->dynamicCall( "Text" ).toString(); -.br -.fi -Note that it is faster to get and set properties using QObject::property() and QObject::setProperty(). -.PP -It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly. -.PP -.nf -.br - IWebBrowser2 *webBrowser = 0; -.br - activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); -.br - if ( webBrowser ) { -.br - webBrowser->Navigate2( pvarURL ); -.br - webBrowser->Release(); -.br - } -.br -.fi -.PP -This is also more efficient. -.PP -Example: qutlook/centralwidget.cpp. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, QValueList & vars )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calls the COM object's method \fIfunction\fR, passing the parameters in \fIvars\fR, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object. -.PP -The QVariant objects in \fIvars\fR are updated when the method has out-parameters. -.SH "QAxObject * QAxBase::querySubObject ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. -.PP -If \fIname\fR is provided by a method the string must include the full function prototype. -.PP -If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. -.PP -The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. -.PP -COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. -.PP -.nf -.br - QAxWidget outlook( "Outlook.Application" ); -.br - QAxObject *session = outlook.querySubObject( "Session" ); -.br - if ( session ) { -.br - QAxObject *defFolder = session->querySubObject( -.br - "GetDefaultFolder(OlDefaultFolders)", -.br - "olFolderContacts" ); -.br - //... -.br - } -.br -.fi -.PP -Example: qutlook/centralwidget.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxobject.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxobject.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxscript.3qt b/doc/man/man3/qaxscript.3qt deleted file mode 100644 index 2ed728ed2..000000000 --- a/doc/man/man3/qaxscript.3qt +++ /dev/null @@ -1,169 +0,0 @@ -'\" t -.TH QAxScript 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 -QAxScript \- Wrapper around script code -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBFunctionFlags\fR { FunctionNames = 0, FunctionSignatures }" -.br -.ti -1c -.BI "\fBQAxScript\fR ( const QString & name, QAxScriptManager * manager )" -.br -.ti -1c -.BI "\fB~QAxScript\fR ()" -.br -.ti -1c -.BI "bool \fBload\fR ( const QString & code, const QString & language = QString::null )" -.br -.ti -1c -.BI "QStringList \fBfunctions\fR ( FunctionFlags flags = FunctionNames ) const" -.br -.ti -1c -.BI "QString \fBscriptCode\fR () const" -.br -.ti -1c -.BI "QString \fBscriptName\fR () const" -.br -.ti -1c -.BI "QAxScriptEngine * \fBscriptEngine\fR () const" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const QString & function, QValueList & arguments )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBentered\fR ()" -.br -.ti -1c -.BI "void \fBfinished\fR ()" -.br -.ti -1c -.BI "void \fBfinished\fR ( const QVariant & result )" -.br -.ti -1c -.BI "void \fBfinished\fR ( int code, const QString & source, const QString & description, const QString & help )" -.br -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.ti -1c -.BI "void \fBerror\fR ( int code, const QString & description, int sourcePosition, const QString & sourceText )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxScript class provides a wrapper around script code. -.PP -Every instance of the QAxScript class represents a piece of scripting code in a particular scripting language. The code is loaded into the script engine using load(). Functions declared in the code can be called using call(). -.PP -The script provides scriptEngine() provides feedback to the application through signals. The most important signal is the error() signal. Direct access to the QAxScriptEngine is provided through the scriptEngine() function. -.PP -\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. -.SS "Member Type Documentation" -.SH "QAxScript::FunctionFlags" -This FunctionFlags enum describes formatting for function introspection. -.TP -\fCQAxScript::FunctionNames\fR - Only function names are returned. -.TP -\fCQAxScript::FunctionSignatures\fR - Returns the functions with signatures. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxScript::QAxScript ( const QString & name, QAxScriptManager * manager )" -Constructs a QAxScript object called \fIname\fR and registers it with the QAxScriptManager \fImanager\fR. This is usually done by the QAxScriptManager class when loading a script. -.PP -A script should always have a name. A manager is necessary to allow the script code to reference objects in the application. The \fImanager\fR takes ownership of the object. -.SH "QAxScript::~QAxScript ()" -Destroys the object, releasing all allocated resources. -.SH "QVariant QAxScript::call ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Calls \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR as arguments and returns the value returned by the function, or an invalid QVariant if the function does not return a value or when the function call failed. -.PP -See QAxScriptManager::call() for more information about how to call script functions. -.SH "QVariant QAxScript::call ( const QString & function, QValueList & arguments )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calls \fIfunction\fR passing \fIarguments\fR as parameters, and returns the result. Returns when the script's execution has finished. -.PP -See QAxScriptManager::call() for more information about how to call script functions. -.SH "void QAxScript::entered ()\fC [signal]\fR" -This signal is emitted when a script engine has started executing code. -.SH "void QAxScript::error ( int code, const QString & description, int sourcePosition, const QString & sourceText )\fC [signal]\fR" -This signal is emitted when an execution error occured while running a script. -.PP -\fIcode\fR, \fIdescription\fR, \fIsourcePosition\fR and \fIsourceText\fR contain information about the execution error. -.SH "void QAxScript::finished ()\fC [signal]\fR" -This signal is emitted when a script engine has finished executing code. -.SH "void QAxScript::finished ( const QVariant & result )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIresult\fR contains the script's result. This will be an invalid QVariant if the script has no return value. -.SH "void QAxScript::finished ( int code, const QString & source, const QString & description, const QString & help )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIcode\fR, \fIsource\fR, \fIdescription\fR and \fIhelp\fR contain exception information when the script terminated. -.SH "QStringList QAxScript::functions ( FunctionFlags flags = FunctionNames ) const" -Returns a list of all the functions in this script if the respective script engine supports introspection; otherwise returns an empty list. The functions are either provided with full prototypes or only as names, depending on the value of \fIflags\fR. -.PP -See also QAxScriptEngine::hasIntrospection(). -.SH "bool QAxScript::load ( const QString & code, const QString & language = QString::null )" -Loads the script source \fIcode\fR written in language \fIlanguage\fR into the script engine. Returns TRUE if \fIcode\fR was successfully entered into the script engine; otherwise returns FALSE. -.PP -If \fIlanguage\fR is empty (the default) it will be determined heuristically. If \fIcode\fR contains the string \fCEnd Sub\fR it will be interpreted as VBScript, otherwise as JScript. Additional scripting languages can be registered using QAxScript::registerEngine(). -.PP -This function can only be called once for each QAxScript object, which is done automatically when using QAxScriptManager::load(). -.SH "QString QAxScript::scriptCode () const" -Returns the script's code, or the null-string if no code has been loaded yet. -.PP -See also load(). -.SH "QAxScriptEngine * QAxScript::scriptEngine () const" -Returns a pointer to the script engine. -.PP -You can use the object returned to connect signals to the script functions, or to access the script engine directly. -.SH "QString QAxScript::scriptName () const" -Returns the name of the script. -.SH "void QAxScript::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted when a script engine changes state. -\fIstate\fR can be any value in the QAxScriptEngineState enumeration. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxscript.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxscript.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxscriptengine.3qt b/doc/man/man3/qaxscriptengine.3qt deleted file mode 100644 index 99cbc804a..000000000 --- a/doc/man/man3/qaxscriptengine.3qt +++ /dev/null @@ -1,123 +0,0 @@ -'\" t -.TH QAxScriptEngine 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 -QAxScriptEngine \- Wrapper around a script engine -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QAxObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBState\fR { Uninitialized = 0, Initialized = 5, Started = 1, Connected = 2, Disconnected = 3, Closed = 4 }" -.br -.ti -1c -.BI "\fBQAxScriptEngine\fR ( const QString & language, QAxScript * script )" -.br -.ti -1c -.BI "\fB~QAxScriptEngine\fR ()" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBhasIntrospection\fR () const" -.br -.ti -1c -.BI "QString \fBscriptLanguage\fR () const" -.br -.ti -1c -.BI "State \fBstate\fR () const" -.br -.ti -1c -.BI "void \fBsetState\fR ( State st )" -.br -.ti -1c -.BI "void \fBaddItem\fR ( const QString & name )" -.br -.ti -1c -.BI "long \fBqueryInterface\fR ( const QUuid & uuid, void ** iface ) const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxScriptEngine class provides a wrapper around a script engine. -.PP -Every instance of the QAxScriptEngine class represents an interpreter for script code in a particular scripting language. The class is usually not used directly. The QAxScript and QAxScriptManager classes provide convenient functions to handle and call script code. -.PP -Direct access to the script engine is provided through queryInterface(). -.PP -\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. -.SS "Member Type Documentation" -.SH "QAxScriptEngine::State" -The State enumeration defines the different states a script engine can be in. -.TP -\fCQAxScriptEngine::Uninitialized\fR - The script has been created, but not yet initialized -.TP -\fCQAxScriptEngine::Initialized\fR - The script has been initialized, but is not running -.TP -\fCQAxScriptEngine::Started\fR - The script can execute code, but does not yet handle events -.TP -\fCQAxScriptEngine::Connected\fR - The script can execute code and is connected so that it can handle events -.TP -\fCQAxScriptEngine::Disconnected\fR - The script is loaded, but is not connected to event sources -.TP -\fCQAxScriptEngine::Closed\fR - The script has been closed. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxScriptEngine::QAxScriptEngine ( const QString & language, QAxScript * script )" -Constructs a QAxScriptEngine object interpreting script code in \fIlanguage\fR provided by the code in \fIscript\fR. This is usually done by the QAxScript class when loading a script. -.PP -Instances of QAxScriptEngine should always have both a language and a script. -.SH "QAxScriptEngine::~QAxScriptEngine ()" -Destroys the QAxScriptEngine object, releasing all allocated resources. -.SH "void QAxScriptEngine::addItem ( const QString & name )" -Registers an item with the script engine. Script code can refer to this item using \fIname\fR. -.SH "bool QAxScriptEngine::hasIntrospection () const" -Returns TRUE if the script engine supports introspection; otherwise returns FALSE. -.SH "bool QAxScriptEngine::isValid () const" -Returns TRUE if the script engine has been initialized correctly; otherwise returns FALSE. -.SH "long QAxScriptEngine::queryInterface ( const QUuid & uuid, void ** iface ) const" -Requests the interface \fIuuid\fR from the script engine object and sets the value of \fIiface\fR to the provided interface, or to 0 if the requested interface could not be provided. -.PP -Returns the result of the QueryInterface implementation of the COM object. -.SH "QString QAxScriptEngine::scriptLanguage () const" -Returns the scripting language, for example "VBScript", or "JScript". -.SH "void QAxScriptEngine::setState ( State st )" -Sets the state of the script engine to \fIst\fR. Calling this function is usually not necessary. -.SH "State QAxScriptEngine::state () const" -Returns the state of the script engine. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxscriptengine.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxscriptengine.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxscriptmanager.3qt b/doc/man/man3/qaxscriptmanager.3qt deleted file mode 100644 index 1c896e256..000000000 --- a/doc/man/man3/qaxscriptmanager.3qt +++ /dev/null @@ -1,197 +0,0 @@ -'\" t -.TH QAxScriptManager 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 -QAxScriptManager \- Bridge between application objects and script code -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxScriptManager\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QAxScriptManager\fR ()" -.br -.ti -1c -.BI "void \fBaddObject\fR ( QAxBase * object )" -.br -.ti -1c -.BI "void \fBaddObject\fR ( QObject * object )" -.br -.ti -1c -.BI "QStringList \fBfunctions\fR ( QAxScript::FunctionFlags flags = QAxScript::FunctionNames ) const" -.br -.ti -1c -.BI "QStringList \fBscriptNames\fR () const" -.br -.ti -1c -.BI "QAxScript * \fBscript\fR ( const QString & name ) const" -.br -.ti -1c -.BI "QAxScript * \fBload\fR ( const QString & code, const QString & name, const QString & language )" -.br -.ti -1c -.BI "QAxScript * \fBload\fR ( const QString & file, const QString & name )" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const QString & function, QValueList & arguments )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBerror\fR ( QAxScript * script, int code, const QString & description, int sourcePosition, const QString & sourceText )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBregisterEngine\fR ( const QString & name, const QString & extension, const QString & code = QString ( ) )" -.br -.ti -1c -.BI "QString \fBscriptFileFilter\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxScriptManager class provides a bridge between application objects and script code. -.PP -The QAxScriptManager acts as a bridge between the COM objects embedded in the Qt application through QAxObject or QAxWidget, and the scripting languages available through the Windows Script technologies, usually JScript and VBScript. -.PP -Create one QAxScriptManager for each separate document in your application, and add the COM objects the scripts need to access using addObject(). Then load() the script sources and invoke the functions using call(). -.PP -\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxScriptManager::QAxScriptManager ( QObject * parent = 0, const char * name = 0 )" -Creates a QAxScriptManager object. \fIparent\fR and \fIname\fR are passed on to the QObject constructor. -.PP -It is usual to create one QAxScriptManager for each document in an application. -.SH "QAxScriptManager::~QAxScriptManager ()" -Destroys the objects, releasing all allocated resources. -.SH "void QAxScriptManager::addObject ( QAxBase * object )" -Adds \fIobject\fR to the manager. Scripts handled by this manager can access the object in the code using the object's name property. -.PP -You must add all the necessary objects before loading any scripts. -.SH "void QAxScriptManager::addObject ( QObject * object )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a generic COM wrapper for \fIobject\fR to the manager. \fIobject\fR must be exposed as a COM object using the functionality provided by the QAxServer module.. Applications using this function you must link against the qaxserver library. -.SH "QVariant QAxScriptManager::call ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Calls \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR as arguments and returns the value returned by the function, or an invalid QVariant if the function does not return a value or when the function call failed. The call returns when the script's execution has finished. -.PP -In most script engines the only supported parameter type is "const QVariant&", for example, to call a JavaScript function -.PP -.nf -.br - function setNumber(number) -.br - { -.br - n = number; -.br - } -.br -.fi -use -.PP -.nf -.br - QValueList args; -.br - args << 5; -.br - script->call("setNumber(const QVariant&)", args); -.br -.fi -As with dynamicCall the parameters can directly be embedded in the function string. -.PP -.nf -.br - script->call("setNumber(5)"); -.br -.fi -However, this is slower. -.PP -Functions provided by script engines that don't support introspection are not available and must be called directly using QAxScript::call() on the respective script object. -.PP -Note that calling this function can be significantely slower than using call() on the respective QAxScript directly. -.SH "QVariant QAxScriptManager::call ( const QString & function, QValueList & arguments )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calls \fIfunction\fR passing \fIarguments\fR as parameters, and returns the result. Returns when the script's execution has finished. -.SH "void QAxScriptManager::error ( QAxScript * script, int code, const QString & description, int sourcePosition, const QString & sourceText )\fC [signal]\fR" -This signal is emitted when an execution error occured while running \fIscript\fR. -.PP -\fIcode\fR, \fIdescription\fR, \fIsourcePosition\fR and \fIsourceText\fR contain information about the execution error. -.SH "QStringList QAxScriptManager::functions ( QAxScript::FunctionFlags flags = QAxScript::FunctionNames ) const" -Returns a list with all the functions that are available. Functions provided by script engines that don't support introspection are not included in the list. The functions are either provided with full prototypes or only as names, depending on the value of \fIflags\fR. -.SH "QAxScript * QAxScriptManager::load ( const QString & code, const QString & name, const QString & language )" -Loads the script source \fIcode\fR using the script engine for \fIlanguage\fR. The script can later be referred to using its \fIname\fR which should not be empty. -.PP -The function returns a pointer to the script for the given \fIcode\fR if the \fIcode\fR was loaded successfully; otherwise it returns 0. -.PP -If \fIlanguage\fR is empty it will be determined heuristically. If \fIcode\fR contains the string "End Sub" it will be interpreted as VBScript, otherwise as JScript. Additional script engines can be registered using registerEngine(). -.PP -You must add all the objects necessary (using addObject()) \fIbefore\fR loading any scripts. If \fIcode\fR declares a function that is already available (no matter in which language) the first function is overloaded and can no longer be called via call(); but it will still be available by calling its script directly. -.PP -See also addObject(), scriptNames(), and functions(). -.SH "QAxScript * QAxScriptManager::load ( const QString & file, const QString & name )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads the source code from the \fIfile\fR. The script can later be referred to using its \fIname\fR which should not be empty. -.PP -The function returns a pointer to the script engine for the code in \fIfile\fR if \fIfile\fR was loaded successfully; otherwise it returns 0. -.PP -The script engine used is determined from the file's extension. By default ".js" files are interpreted as JScript files, and ".vbs" and ".dsm" files are interpreted as VBScript. Additional script engines can be registered using registerEngine(). -.SH "bool QAxScriptManager::registerEngine ( const QString & name, const QString & extension, const QString & code = QString ( ) )\fC [static]\fR" -Registers the script engine called \fIname\fR and returns TRUE if the engine was found; otherwise does nothing and returns FALSE. -.PP -The script engine will be used when loading files with the given \fIextension\fR, or when loading source code that contains the string \fIcode\fR. -.SH "QAxScript * QAxScriptManager::script ( const QString & name ) const" -Returns the script called \fIname\fR. -.PP -You can use the returned pointer to call functions directly through QAxScript::call(), to access the script engine directly, or to delete and thus unload the script. -.SH "QString QAxScriptManager::scriptFileFilter ()\fC [static]\fR" -Returns a file filter listing all the supported script languages. This filter string is convenient for use with QFileDialog. -.SH "QStringList QAxScriptManager::scriptNames () const" -Returns a list with the names of all the scripts. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxscriptmanager.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxscriptmanager.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qaxwidget.3qt b/doc/man/man3/qaxwidget.3qt deleted file mode 100644 index c153b3cfb..000000000 --- a/doc/man/man3/qaxwidget.3qt +++ /dev/null @@ -1,215 +0,0 @@ -'\" t -.TH QAxWidget 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 -QAxWidget \- QWidget that wraps an ActiveX control -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QWidget and QAxBase. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxWidget\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQAxWidget\fR ( const QString & c, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQAxWidget\fR ( IUnknown * iface, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QAxWidget\fR ()" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, QValueList & vars )" -.br -.ti -1c -.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBcreateHostWindow\fR ( bool initialized )" -.br -.ti -1c -.BI "virtual bool \fBtranslateKeyEvent\fR ( int message, int keycode ) const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QAxWidget class is a QWidget that wraps an ActiveX control. -.PP -A QAxWidget can be instantiated as an empty object, with the name of the ActiveX control it should wrap, or with an existing interface pointer to the ActiveX control. The ActiveX control's properties, methods and events which only use supported data types, become available as Qt properties, slots and signals. The base class QAxBase provides an API to access the ActiveX directly through the IUnknown pointer. -.PP -QAxWidget is a QWidget and can be used as such, e.g. it can be organized in a widget hierarchy, receive events or act as an event filter. Standard widget properties, e.g. enabled are supported, but it depends on the ActiveX control to implement support for ambient properties like e.g. palette or font. QAxWidget tries to provide the necessary hints. -.PP -\fBWarning:\fR You can subclass QAxWidget, but you cannot use the TQ_OBJECT macro in the subclass (the generated moc-file will not compile), so you cannot add further signals, slots or properties. This limitation is due to the metaobject information generated in runtime. To work around this problem, aggregate the QAxWidget as a member of the QObject subclass. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxWidget::QAxWidget ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Creates an empty QAxWidget widget and propagates \fIparent\fR, \fIname\fR and \fIf\fR to the QWidget constructor. To initialize a control, call setControl. -.SH "QAxWidget::QAxWidget ( const QString & c, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Creates an QAxWidget widget and initializes the ActiveX control \fIc\fR. \fIparent\fR, \fIname\fR and \fIf\fR are propagated to the QWidget contructor. -.PP -See also control. -.SH "QAxWidget::QAxWidget ( IUnknown * iface, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Creates a QAxWidget that wraps the COM object referenced by \fIiface\fR. \fIparent\fR, \fIname\fR and \fIf\fR are propagated to the QWidget contructor. -.SH "QAxWidget::~QAxWidget ()" -Shuts down the ActiveX control and destroys the QAxWidget widget, cleaning up all allocated resources. -.PP -See also clear(). -.SH "bool QAxWidget::createHostWindow ( bool initialized )\fC [virtual protected]\fR" -Creates the client site for the ActiveX control, and returns TRUE if the control could be embedded successfully, otherwise returns FALSE. If \fIinitialized\fR is TRUE the control has already been initialized. -.PP -This function is called by initialize(). If you reimplement initialize to customize the actual control instantiation, call this function in your reimplementation to have the control embedded by the default client side. Creates the client site for the ActiveX control, and returns TRUE if the control could be embedded successfully, otherwise returns FALSE. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Calls the COM object's method \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed. -.PP -If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call. -.PP -.nf -.br - activeX->dynamicCall( "Navigate(const QString&)", "www.trolltech.com" ); -.br -.fi -.PP -Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using -.PP -.nf -.br - activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); -.br -.fi -All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. -.PP -If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. -.PP -.nf -.br - activeX->dynamicCall( "Value", 5 ); -.br - QString text = activeX->dynamicCall( "Text" ).toString(); -.br -.fi -Note that it is faster to get and set properties using QObject::property() and QObject::setProperty(). -.PP -It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly. -.PP -.nf -.br - IWebBrowser2 *webBrowser = 0; -.br - activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); -.br - if ( webBrowser ) { -.br - webBrowser->Navigate2( pvarURL ); -.br - webBrowser->Release(); -.br - } -.br -.fi -.PP -This is also more efficient. -.PP -Example: qutlook/centralwidget.cpp. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, QValueList & vars )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calls the COM object's method \fIfunction\fR, passing the parameters in \fIvars\fR, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object. -.PP -The QVariant objects in \fIvars\fR are updated when the method has out-parameters. -.SH "QAxObject * QAxBase::querySubObject ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" -Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. -.PP -If \fIname\fR is provided by a method the string must include the full function prototype. -.PP -If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. -.PP -The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. -.PP -COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. -.PP -.nf -.br - QAxWidget outlook( "Outlook.Application" ); -.br - QAxObject *session = outlook.querySubObject( "Session" ); -.br - if ( session ) { -.br - QAxObject *defFolder = session->querySubObject( -.br - "GetDefaultFolder(OlDefaultFolders)", -.br - "olFolderContacts" ); -.br - //... -.br - } -.br -.fi -.PP -Example: qutlook/centralwidget.cpp. -.SH "bool QAxWidget::translateKeyEvent ( int message, int keycode ) const\fC [virtual protected]\fR" -Reimplement this function to pass certain key events to the ActiveX control. \fImessage\fR is the Window message identifier specifying the message type (ie. WM_KEYDOWN), and \fIkeycode\fR is the virtual keycode (ie. VK_TAB). -.PP -If the function returns TRUE the key event is passed on to the ActiveX control, which then either processes the event or passes the event on to Qt. -.PP -If the function returns FALSE the processing of the key event is ignored by ActiveQt, ie. the ActiveX control might handle it or not. -.PP -The default implementation returns TRUE for the following cases: -.PP -
    .nf -.TS -l - l. WM_SYSKEYDOWN WM_SYSKEYUP WM_KEYDOWN All keycodes VK_MENU -.TE -.fi -
    -.PP -This table is the result of experimenting with popular ActiveX controls, -ie. Internet Explorer and Microsoft Office applications, but for some -controls it might require modification. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxwidget.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qaxwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbig5codec.3qt b/doc/man/man3/qbig5codec.3qt deleted file mode 100644 index e9bec4293..000000000 --- a/doc/man/man3/qbig5codec.3qt +++ /dev/null @@ -1,62 +0,0 @@ -'\" t -.TH QBig5Codec 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 -QBig5Codec \- Conversion to and from the Big5 encoding -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -.SH DESCRIPTION -The QBig5Codec class provides conversion to and from the Big5 encoding. -.PP -QBig5Codec was originally contributed by Ming-Che Chuang for the Big-5+ encoding, and was included in Qt with the author's permission, and the grateful thanks of the Trolltech team. (Note: Ming-Che's code is QPL'd, as per an mail to info@trolltech.com.) -.PP -However, since Big-5+ was never formally approved, and was never used by anyone, the Taiwan Free Software community and the Li18nux Big5 Standard Subgroup agree that the de-facto standard Big5-ETen (zh_TW.Big5 or zh_TW.TW-Big5) be used instead. -.PP -QBig5Codec is currently implemented as a pure subset of QBig5hkscsCodec, so more fine-tuning is needed to make it identical to the standard Big5 mapping as determined by Li18nux-Big5. See http://www.autrijus.org/xml/ for the draft Big5 (2002) standard. -.PP -James Su generated the Big5-HKSCS<->Unicode tables with a very space-efficient algorithm. He generously donated his code to glibc in May 2002. Subsequently, James has kindly allowed Anthony Fok to adapt the code for Qt. -.PP -Copyright (C) 2000 Ming-Che Chuang Copyright (C) 2002 James Su, Turbolinux Inc. Copyright (C) 2002 Anthony Fok, ThizLinux Laboratory Ltd. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
      -.IP 1 -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.IP 2 -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.PP -See also Internationalization with Qt. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqbig5codec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbig5codec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbig5hkscscodec.3qt b/doc/man/man3/qbig5hkscscodec.3qt deleted file mode 100644 index f0369d772..000000000 --- a/doc/man/man3/qbig5hkscscodec.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QBig5hkscsCodec 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 -QBig5hkscsCodec \- Conversion to and from the Big5-HKSCS encoding -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -.SH DESCRIPTION -The QBig5hkscsCodec class provides conversion to and from the Big5-HKSCS encoding. -.PP -QBig5hkscsCodec grew out of the QBig5Codec originally contributed by Ming-Che Chuang . James Su and Anthony Fok implemented HKSCS-1999 QBig5hkscsCodec for Qt-2.3.x, but it was too late in Qt development schedule to be officially included in the Qt-2.3.x series. -.PP -Wu Yi ported the HKSCS-1999 QBig5hkscsCodec to Qt-3.0.1 in March 2002. -.PP -With the advent of the new HKSCS-2001 standard, James Su generated the Big5-HKSCS<->Unicode tables with a very space-efficient algorithm. He generously donated his code to glibc in May 2002. Subsequently, James has generously allowed Anthony Fok to adapt the code for Qt-3.0.5. -.PP -Currently, the Big5-HKSCS tables are generated from the following sources, and with the Euro character added:
        -.IP 1 -http://www.microsoft.com/typography/unicode/950.txt -.IP 2 -http://www.info.gov.hk/digital21/chi/hkscs/download/big5-iso.txt -.IP 3 -http://www.info.gov.hk/digital21/chi/hkscs/download/big5cmp.txt -.PP -There may be more fine-tuning to the QBig5hkscsCodec to maximize its compatibility with the standard Big5 (2002) mapping as determined by Li18nux Big5 Standard Subgroup. See http://www.autrijus.org/xml/ for the various Big5 CharMapML tables. -.PP -Copyright (C) 2000 Ming-Che Chuang Copyright (C) 2001, 2002 James Su, Turbolinux Inc. Copyright (C) 2002 WU Yi, HancomLinux Inc. Copyright (C) 2001, 2002 Anthony Fok, ThizLinux Laboratory Ltd. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
          -.IP 4 -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.IP 5 -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -SUCH DAMAGE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qbig5hkscscodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbig5hkscscodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbitarray.3qt b/doc/man/man3/qbitarray.3qt deleted file mode 100644 index 476b20158..000000000 --- a/doc/man/man3/qbitarray.3qt +++ /dev/null @@ -1,372 +0,0 @@ -'\" t -.TH QBitArray 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 -QBitArray \- Array of bits -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

          -.PP -\fC#include \fR -.PP -Inherits QByteArray. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQBitArray\fR ()" -.br -.ti -1c -.BI "\fBQBitArray\fR ( uint size )" -.br -.ti -1c -.BI "\fBQBitArray\fR ( const QBitArray & a )" -.br -.ti -1c -.BI "QBitArray & \fBoperator=\fR ( const QBitArray & a )" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBresize\fR ( uint size )" -.br -.ti -1c -.BI "bool \fBfill\fR ( bool v, int size = -1 )" -.br -.ti -1c -.BI "virtual void \fBdetach\fR ()" -.br -.ti -1c -.BI "QBitArray \fBcopy\fR () const" -.br -.ti -1c -.BI "bool \fBtestBit\fR ( uint index ) const" -.br -.ti -1c -.BI "void \fBsetBit\fR ( uint index )" -.br -.ti -1c -.BI "void \fBsetBit\fR ( uint index, bool value )" -.br -.ti -1c -.BI "void \fBclearBit\fR ( uint index )" -.br -.ti -1c -.BI "bool \fBtoggleBit\fR ( uint index )" -.br -.ti -1c -.BI "bool \fBat\fR ( uint index ) const" -.br -.ti -1c -.BI "QBitVal \fBoperator[]\fR ( int index )" -.br -.ti -1c -.BI "bool \fBoperator[]\fR ( int index ) const" -.br -.ti -1c -.BI "QBitArray & \fBoperator&=\fR ( const QBitArray & a )" -.br -.ti -1c -.BI "QBitArray & \fBoperator|=\fR ( const QBitArray & a )" -.br -.ti -1c -.BI "QBitArray & \fBoperator^=\fR ( const QBitArray & a )" -.br -.ti -1c -.BI "QBitArray \fBoperator~\fR () const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QBitArray \fBoperator&\fR ( const QBitArray & a1, const QBitArray & a2 )" -.br -.ti -1c -.BI "QBitArray \fBoperator|\fR ( const QBitArray & a1, const QBitArray & a2 )" -.br -.ti -1c -.BI "QBitArray \fBoperator^\fR ( const QBitArray & a1, const QBitArray & a2 )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QBitArray & a )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QBitArray & a )" -.br -.in -1c -.SH DESCRIPTION -The QBitArray class provides an array of bits. -.PP -Because QBitArray is a QMemArray, it uses explicit sharing with a reference count. -.PP -A QBitArray is a special byte array that can access individual bits and perform bit-operations (AND, OR, XOR and NOT) on entire arrays or bits. -.PP -Bits can be manipulated by the setBit() and clearBit() functions, but it is also possible to use the indexing [] operator to test and set individual bits. The [] operator is a little slower than setBit() and clearBit() because some tricks are required to implement single-bit assignments. -.PP -Example: -.PP -.nf -.br - QBitArray a(3); -.br - a.setBit( 0 ); -.br - a.clearBit( 1 ); -.br - a.setBit( 2 ); // a = [1 0 1] -.br -.br - QBitArray b(3); -.br - b[0] = 1; -.br - b[1] = 1; -.br - b[2] = 0; // b = [1 1 0] -.br -.br - QBitArray c; -.br - c = ~a & b; // c = [0 1 0] -.br -.fi -.PP -When a QBitArray is constructed the bits are uninitialized. Use fill() to set all the bits to 0 or 1. The array can be resized with resize() and copied with copy(). Bits can be set with setBit() and cleared with clearBit(). Bits can be toggled with toggleBit(). A bit's value can be obtained with testBit() and with at(). -.PP -QBitArray supports the & (AND), | (OR), ^ (XOR) and ~ (NOT) operators. -.PP -See also Collection Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QBitArray::QBitArray ()" -Constructs an empty bit array. -.SH "QBitArray::QBitArray ( uint size )" -Constructs a bit array of \fIsize\fR bits. The bits are uninitialized. -.PP -See also fill(). -.SH "QBitArray::QBitArray ( const QBitArray & a )" -Constructs a shallow copy of \fIa\fR. -.SH "bool QBitArray::at ( uint index ) const" -Returns the value (0 or 1) of the bit at position \fIindex\fR. -.PP -See also operator[](). -.SH "void QBitArray::clearBit ( uint index )" -Clears the bit at position \fIindex\fR, i.e. sets it to 0. -.PP -See also setBit() and toggleBit(). -.SH "QBitArray QBitArray::copy () const" -Returns a deep copy of the bit array. -.PP -See also detach(). -.SH "void QBitArray::detach ()\fC [virtual]\fR" -Detaches from shared bit array data and makes sure that this bit array is the only one referring to the data. -.PP -If multiple bit arrays share common data, this bit array dereferences the data and gets a copy of the data. Nothing happens if there is only a single reference. -.PP -See also copy(). -.PP -Reimplemented from QMemArray. -.SH "bool QBitArray::fill ( bool v, int size = -1 )" -Fills the bit array with \fIv\fR (1's if \fIv\fR is TRUE, or 0's if \fIv\fR is FALSE). -.PP -fill() resizes the bit array to \fIsize\fR bits if \fIsize\fR is nonnegative. -.PP -Returns FALSE if a nonnegative \fIsize\fR was specified and the bit array could not be resized; otherwise returns TRUE. -.PP -See also resize(). -.SH "QBitArray & QBitArray::operator&= ( const QBitArray & a )" -Performs the AND operation between all bits in this bit array and \fIa\fR. Returns a reference to this bit array. -.PP -The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. -.PP -.nf -.br - QBitArray a( 3 ), b( 2 ); -.br - a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] -.br - b[0] = 1; b[1] = 0; // b = [1 0] -.br - a &= b; // a = [1 0 0] -.br -.fi -.PP -See also operator|=(), operator^=(), and operator~(). -.SH "QBitArray & QBitArray::operator= ( const QBitArray & a )" -Assigns a shallow copy of \fIa\fR to this bit array and returns a reference to this array. -.SH "QBitVal QBitArray::operator[] ( int index )" -Implements the [] operator for bit arrays. -.PP -The returned QBitVal is a context object. It makes it possible to get and set a single bit value by its \fIindex\fR position. -.PP -Example: -.PP -.nf -.br - QBitArray a( 3 ); -.br - a[0] = 0; -.br - a[1] = 1; -.br - a[2] = a[0] ^ a[1]; -.br -.fi -.PP -The functions testBit(), setBit() and clearBit() are faster. -.PP -See also at(). -.SH "bool QBitArray::operator[] ( int index ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Implements the [] operator for constant bit arrays. -.SH "QBitArray & QBitArray::operator^= ( const QBitArray & a )" -Performs the XOR operation between all bits in this bit array and \fIa\fR. Returns a reference to this bit array. -.PP -The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. -.PP -.nf -.br - QBitArray a( 3 ), b( 2 ); -.br - a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] -.br - b[0] = 1; b[1] = 0; // b = [1 0] -.br - a ^= b; // a = [0 0 1] -.br -.fi -.PP -See also operator&=(), operator|=(), and operator~(). -.SH "QBitArray & QBitArray::operator|= ( const QBitArray & a )" -Performs the OR operation between all bits in this bit array and \fIa\fR. Returns a reference to this bit array. -.PP -The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. -.PP -.nf -.br - QBitArray a( 3 ), b( 2 ); -.br - a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] -.br - b[0] = 1; b[1] = 0; // b = [1 0] -.br - a |= b; // a = [1 0 1] -.br -.fi -.PP -See also operator&=(), operator^=(), and operator~(). -.SH "QBitArray QBitArray::operator~ () const" -Returns a bit array that contains the inverted bits of this bit array. -.PP -Example: -.PP -.nf -.br - QBitArray a( 3 ), b; -.br - a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] -.br - b = ~a; // b = [0 1 0] -.br -.fi -.SH "bool QBitArray::resize ( uint size )" -Resizes the bit array to \fIsize\fR bits and returns TRUE if the bit array could be resized; otherwise returns FALSE. The array becomes a null array if \fIsize\fR == 0. -.PP -If the array is expanded, the new bits are set to 0. -.PP -See also size(). -.SH "void QBitArray::setBit ( uint index, bool value )" -Sets the bit at position \fIindex\fR to \fIvalue\fR. -.PP -Equivalent to: -.PP -.nf -.br - if ( value ) -.br - setBit( index ); -.br - else -.br - clearBit( index ); -.br -.fi -.PP -See also clearBit() and toggleBit(). -.SH "void QBitArray::setBit ( uint index )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the bit at position \fIindex\fR to 1. -.PP -See also clearBit() and toggleBit(). -.SH "uint QBitArray::size () const" -Returns the bit array's size (number of bits). -.PP -See also resize(). -.SH "bool QBitArray::testBit ( uint index ) const" -Returns TRUE if the bit at position \fIindex\fR is set, i.e. is 1; otherwise returns FALSE. -.PP -See also setBit() and clearBit(). -.SH "bool QBitArray::toggleBit ( uint index )" -Toggles the bit at position \fIindex\fR. -.PP -If the previous value was 0, the new value will be 1. If the previous value was 1, the new value will be 0. -.PP -See also setBit() and clearBit(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QBitArray operator& ( const QBitArray & a1, const QBitArray & a2 )" -Returns the AND result between the bit arrays \fIa1\fR and \fIa2\fR. -.PP -The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. -.PP -See also QBitArray::operator&=(). -.SH "QDataStream & operator<< ( QDataStream & s, const QBitArray & a )" -Writes bit array \fIa\fR to stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QBitArray & a )" -Reads a bit array into \fIa\fR from stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QBitArray operator^ ( const QBitArray & a1, const QBitArray & a2 )" -Returns the XOR result between the bit arrays \fIa1\fR and \fIa2\fR. -.PP -The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. -.PP -See also QBitArray::operator^(). -.SH "QBitArray operator| ( const QBitArray & a1, const QBitArray & a2 )" -Returns the OR result between the bit arrays \fIa1\fR and \fIa2\fR. -.PP -The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. -.PP -See also QBitArray::operator|=(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqbitarray.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbitarray.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbitmap.3qt b/doc/man/man3/qbitmap.3qt deleted file mode 100644 index a4617a6cb..000000000 --- a/doc/man/man3/qbitmap.3qt +++ /dev/null @@ -1,159 +0,0 @@ -'\" 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 \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/ntqbitmap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbitmap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbitval.3qt b/doc/man/man3/qbitval.3qt deleted file mode 100644 index 2b6d90994..000000000 --- a/doc/man/man3/qbitval.3qt +++ /dev/null @@ -1,72 +0,0 @@ -'\" t -.TH QBitVal 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 -QBitVal \- Internal class, used with QBitArray -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

          -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQBitVal\fR ( QBitArray * a, uint i )" -.br -.ti -1c -.BI "\fBoperator int\fR ()" -.br -.ti -1c -.BI "QBitVal & \fBoperator=\fR ( const QBitVal & v )" -.br -.ti -1c -.BI "QBitVal & \fBoperator=\fR ( bool v )" -.br -.in -1c -.SH DESCRIPTION -The QBitVal class is an internal class, used with QBitArray. -.PP -The QBitVal is required by the indexing [] operator on bit arrays. It is not for use in any other context. -.PP -See also Collection Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QBitVal::QBitVal ( QBitArray * a, uint i )" -Constructs a reference to element \fIi\fR in the QBitArray \fIa\fR. This is what QBitArray::operator[] constructs its return value with. -.SH "QBitVal::operator int ()" -Returns the value referenced by the QBitVal. -.SH "QBitVal & QBitVal::operator= ( const QBitVal & v )" -Sets the value referenced by the QBitVal to that referenced by QBitVal \fIv\fR. -.SH "QBitVal & QBitVal::operator= ( bool v )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the value referenced by the QBitVal to \fIv\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qbitval.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbitval.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qboxlayout.3qt b/doc/man/man3/qboxlayout.3qt deleted file mode 100644 index c8d573242..000000000 --- a/doc/man/man3/qboxlayout.3qt +++ /dev/null @@ -1,354 +0,0 @@ -'\" t -.TH QBoxLayout 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 -QBoxLayout \- Lines up child widgets horizontally or vertically -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QLayout. -.PP -Inherited by QHBoxLayout and QVBoxLayout. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBDirection\fR { LeftToRight, RightToLeft, TopToBottom, BottomToTop, Down = TopToBottom, Up = BottomToTop }" -.br -.ti -1c -.BI "\fBQBoxLayout\fR ( QWidget * parent, Direction d, int margin = 0, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQBoxLayout\fR ( QLayout * parentLayout, Direction d, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQBoxLayout\fR ( Direction d, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QBoxLayout\fR ()" -.br -.ti -1c -.BI "virtual void \fBaddItem\fR ( QLayoutItem * item )" -.br -.ti -1c -.BI "Direction \fBdirection\fR () const" -.br -.ti -1c -.BI "void \fBsetDirection\fR ( Direction direction )" -.br -.ti -1c -.BI "void \fBaddSpacing\fR ( int size )" -.br -.ti -1c -.BI "void \fBaddStretch\fR ( int stretch = 0 )" -.br -.ti -1c -.BI "void \fBaddWidget\fR ( QWidget * widget, int stretch = 0, int alignment = 0 )" -.br -.ti -1c -.BI "void \fBaddLayout\fR ( QLayout * layout, int stretch = 0 )" -.br -.ti -1c -.BI "void \fBaddStrut\fR ( int size )" -.br -.ti -1c -.BI "void \fBinsertSpacing\fR ( int index, int size )" -.br -.ti -1c -.BI "void \fBinsertStretch\fR ( int index, int stretch = 0 )" -.br -.ti -1c -.BI "void \fBinsertWidget\fR ( int index, QWidget * widget, int stretch = 0, int alignment = 0 )" -.br -.ti -1c -.BI "void \fBinsertLayout\fR ( int index, QLayout * layout, int stretch = 0 )" -.br -.ti -1c -.BI "bool \fBsetStretchFactor\fR ( QWidget * w, int stretch )" -.br -.ti -1c -.BI "bool \fBsetStretchFactor\fR ( QLayout * l, int stretch )" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBminimumSize\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBmaximumSize\fR () const" -.br -.ti -1c -.BI "virtual bool \fBhasHeightForWidth\fR () const" -.br -.ti -1c -.BI "virtual int \fBheightForWidth\fR ( int w ) const" -.br -.ti -1c -.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" -.br -.ti -1c -.BI "virtual void \fBinvalidate\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" -.br -.ti -1c -.BI "int \fBfindWidget\fR ( QWidget * w )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBinsertItem\fR ( int index, QLayoutItem * item )" -.br -.in -1c -.SH DESCRIPTION -The QBoxLayout class lines up child widgets horizontally or vertically. -.PP -QBoxLayout takes the space it gets (from its parent layout or from the mainWidget()), divides it up into a row of boxes, and makes each managed widget fill one box. -.PP -
          -.ce 1 -.B "[Image Omitted]" -.PP -
          -.PP -If the QBoxLayout's orientation is Horizontal the boxes are placed in a row, with suitable sizes. Each widget (or other box) will get at least its minimum size and at most its maximum size. Any excess space is shared according to the stretch factors (more about that below). -.PP -
          -.ce 1 -.B "[Image Omitted]" -.PP -
          -.PP -If the QBoxLayout's orientation is Vertical, the boxes are placed in a column, again with suitable sizes. -.PP -The easiest way to create a QBoxLayout is to use one of the convenience classes, e.g. QHBoxLayout (for Horizontal boxes) or QVBoxLayout (for Vertical boxes). You can also use the QBoxLayout constructor directly, specifying its direction as LeftToRight, Down, RightToLeft or Up. -.PP -If the QBoxLayout is not the top-level layout (i.e. it is not managing all of the widget's area and children), you must add it to its parent layout before you can do anything with it. The normal way to add a layout is by calling parentLayout->addLayout(). -.PP -Once you have done this, you can add boxes to the QBoxLayout using one of four functions: -.TP -addWidget() to add a widget to the QBoxLayout and set the widget's stretch factor. (The stretch factor is along the row of boxes.) -.IP -.TP -addSpacing() to create an empty box; this is one of the functions you use to create nice and spacious dialogs. See below for ways to set margins. -.IP -.TP -addStretch() to create an empty, stretchable box. -.IP -.TP -addLayout() to add a box containing another QLayout to the row and set that layout's stretch factor. -.PP -Use insertWidget(), insertSpacing(), insertStretch() or insertLayout() to insert a box at a specified position in the layout. -.PP -QBoxLayout also includes two margin widths: -.TP -setMargin() sets the width of the outer border. This is the width of the reserved space along each of the QBoxLayout's four sides. -.TP -setSpacing() sets the width between neighboring boxes. (You can use addSpacing() to get more space at a particular spot.) -.PP -The margin defaults to 0. The spacing defaults to the same as the margin width for a top-level layout, or to the same as the parent layout. Both are parameters to the constructor. -.PP -To remove a widget from a layout, call remove(). Calling QWidget::hide() on a widget also effectively removes the widget from the layout until QWidget::show() is called. -.PP -You will almost always want to use QVBoxLayout and QHBoxLayout rather than QBoxLayout because of their convenient constructors. -.PP -See also QGrid, Layout Overview, Widget Appearance and Style, and Layout Management. -.SS "Member Type Documentation" -.SH "QBoxLayout::Direction" -This type is used to determine the direction of a box layout. -.TP -\fCQBoxLayout::LeftToRight\fR - Horizontal, from left to right -.TP -\fCQBoxLayout::RightToLeft\fR - Horizontal, from right to left -.TP -\fCQBoxLayout::TopToBottom\fR - Vertical, from top to bottom -.TP -\fCQBoxLayout::Down\fR - The same as TopToBottom -.TP -\fCQBoxLayout::BottomToTop\fR - Vertical, from bottom to top -.TP -\fCQBoxLayout::Up\fR - The same as BottomToTop -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QBoxLayout::QBoxLayout ( QWidget * parent, Direction d, int margin = 0, int spacing = -1, const char * name = 0 )" -Constructs a new QBoxLayout with direction \fId\fR and main widget \fIparent\fR. \fIparent\fR may not be 0. -.PP -The \fImargin\fR is the number of pixels between the edge of the widget and its managed children. The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1 the value of \fImargin\fR is used for \fIspacing\fR. -.PP -\fIname\fR is the internal object name. -.PP -See also direction(). -.SH "QBoxLayout::QBoxLayout ( QLayout * parentLayout, Direction d, int spacing = -1, const char * name = 0 )" -Constructs a new QBoxLayout called \fIname\fR, with direction \fId\fR, and inserts it into \fIparentLayout\fR. -.PP -The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, the layout will inherit its parent's spacing(). -.SH "QBoxLayout::QBoxLayout ( Direction d, int spacing = -1, const char * name = 0 )" -Constructs a new QBoxLayout called \fIname\fR, with direction \fId\fR. -.PP -If \fIspacing\fR is -1, the layout will inherit its parent's spacing(); otherwise \fIspacing\fR is used. -.PP -You must insert this box into another layout. -.SH "QBoxLayout::~QBoxLayout ()" -Destroys this box layout. -.PP -The layout's widgets aren't destroyed. -.SH "void QBoxLayout::addItem ( QLayoutItem * item )\fC [virtual]\fR" -Adds \fIitem\fR to the end of this box layout. -.PP -Examples: -.)l chart/optionsform.cpp and chart/setdataform.cpp. -.PP -Reimplemented from QLayout. -.SH "void QBoxLayout::addLayout ( QLayout * layout, int stretch = 0 )" -Adds \fIlayout\fR to the end of the box, with serial stretch factor \fIstretch\fR. -.PP -When a layout is constructed with another layout as its parent, you don't need to call addLayout(); the child layout is automatically added to the parent layout as it is constructed. -.PP -See also insertLayout(), setAutoAdd(), addWidget(), and addSpacing(). -.PP -Examples: -.)l chart/optionsform.cpp, chart/setdataform.cpp, fonts/simple-qfont-demo/viewer.cpp, listbox/listbox.cpp, regexptester/regexptester.cpp, and tictac/tictac.cpp. -.SH "void QBoxLayout::addSpacing ( int size )" -Adds a non-stretchable space with size \fIsize\fR to the end of this box layout. QBoxLayout provides default margin and spacing. This function adds additional space. -.PP -See also insertSpacing() and addStretch(). -.PP -Example: listbox/listbox.cpp. -.SH "void QBoxLayout::addStretch ( int stretch = 0 )" -Adds a stretchable space with zero minimum size and stretch factor \fIstretch\fR to the end of this box layout. -.PP -See also addSpacing(). -.PP -Examples: -.)l layout/layout.cpp, listbox/listbox.cpp, regexptester/regexptester.cpp, and t13/gamebrd.cpp. -.SH "void QBoxLayout::addStrut ( int size )" -Limits the perpendicular dimension of the box (e.g. height if the box is LeftToRight) to a minimum of \fIsize\fR. Other constraints may increase the limit. -.SH "void QBoxLayout::addWidget ( QWidget * widget, int stretch = 0, int alignment = 0 )" -Adds \fIwidget\fR to the end of this box layout, with a stretch factor of \fIstretch\fR and alignment \fIalignment\fR. -.PP -The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more. -.PP -If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved. -.PP -Alignment is specified by \fIalignment\fR which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. -.PP -From Qt 3.0, the \fIalignment\fR parameter is interpreted more aggressively than in previous versions of Qt. A non-default alignment now indicates that the widget should not grow to fill the available space, but should be sized according to sizeHint(). -.PP -See also insertWidget(), setAutoAdd(), addLayout(), and addSpacing(). -.PP -Examples: -.)l chart/optionsform.cpp, checklists/checklists.cpp, layout/layout.cpp, lineedits/lineedits.cpp, listbox/listbox.cpp, t13/gamebrd.cpp, and t13/lcdrange.cpp. -.SH "Direction QBoxLayout::direction () const" -Returns the direction of the box. addWidget() and addSpacing() work in this direction; the stretch stretches in this direction. -.PP -See also QBoxLayout::Direction, addWidget(), and addSpacing(). -.SH "QSizePolicy::ExpandData QBoxLayout::expanding () const\fC [virtual]\fR" -Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions. -.PP -Reimplemented from QLayout. -.SH "int QBoxLayout::findWidget ( QWidget * w )" -Searches for widget \fIw\fR in this layout (not including child layouts). -.PP -Returns the index of \fIw\fR, or -1 if \fIw\fR is not found. -.SH "bool QBoxLayout::hasHeightForWidth () const\fC [virtual]\fR" -Returns TRUE if this layout's preferred height depends on its width; otherwise returns FALSE. -.PP -Reimplemented from QLayoutItem. -.SH "int QBoxLayout::heightForWidth ( int w ) const\fC [virtual]\fR" -Returns the layout's preferred height when it is \fIw\fR pixels wide. -.PP -Reimplemented from QLayoutItem. -.SH "void QBoxLayout::insertItem ( int index, QLayoutItem * item )\fC [protected]\fR" -Inserts \fIitem\fR into this box layout at position \fIindex\fR. If \fIindex\fR is negative, the item is added at the end. -.PP -\fBWarning:\fR Does not call QLayout::insertChildLayout() if \fIitem\fR is a QLayout. -.PP -See also addItem() and findWidget(). -.SH "void QBoxLayout::insertLayout ( int index, QLayout * layout, int stretch = 0 )" -Inserts \fIlayout\fR at position \fIindex\fR, with stretch factor \fIstretch\fR. If \fIindex\fR is negative, the layout is added at the end. -.PP -\fIlayout\fR becomes a child of the box layout. -.PP -See also setAutoAdd(), insertWidget(), and insertSpacing(). -.SH "void QBoxLayout::insertSpacing ( int index, int size )" -Inserts a non-stretchable space at position \fIindex\fR, with size \fIsize\fR. If \fIindex\fR is negative the space is added at the end. -.PP -The box layout has default margin and spacing. This function adds additional space. -.PP -See also insertStretch(). -.SH "void QBoxLayout::insertStretch ( int index, int stretch = 0 )" -Inserts a stretchable space at position \fIindex\fR, with zero minimum size and stretch factor \fIstretch\fR. If \fIindex\fR is negative the space is added at the end. -.PP -See also insertSpacing(). -.SH "void QBoxLayout::insertWidget ( int index, QWidget * widget, int stretch = 0, int alignment = 0 )" -Inserts \fIwidget\fR at position \fIindex\fR, with stretch factor \fIstretch\fR and alignment \fIalignment\fR. If \fIindex\fR is negative, the widget is added at the end. -.PP -The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more. -.PP -If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved. -.PP -Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. -.PP -From Qt 3.0, the \fIalignment\fR parameter is interpreted more aggressively than in previous versions of Qt. A non-default alignment now indicates that the widget should not grow to fill the available space, but should be sized according to sizeHint(). -.PP -See also setAutoAdd(), insertLayout(), and insertSpacing(). -.SH "void QBoxLayout::invalidate ()\fC [virtual]\fR" -Resets cached information. -.PP -Reimplemented from QLayout. -.SH "QSize QBoxLayout::maximumSize () const\fC [virtual]\fR" -Returns the maximum size needed by this box layout. -.PP -Reimplemented from QLayout. -.SH "QSize QBoxLayout::minimumSize () const\fC [virtual]\fR" -Returns the minimum size needed by this box layout. -.PP -Reimplemented from QLayout. -.SH "void QBoxLayout::setDirection ( Direction direction )" -Sets the direction of this layout to \fIdirection\fR. -.SH "void QBoxLayout::setGeometry ( const QRect & r )\fC [virtual]\fR" -Resizes managed widgets within the rectangle \fIr\fR. -.PP -Reimplemented from QLayout. -.SH "bool QBoxLayout::setStretchFactor ( QWidget * w, int stretch )" -Sets the stretch factor for widget \fIw\fR to \fIstretch\fR and returns TRUE if \fIw\fR is found in this layout (not including child layouts); otherwise returns FALSE. -.SH "bool QBoxLayout::setStretchFactor ( QLayout * l, int stretch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the stretch factor for the layout \fIl\fR to \fIstretch\fR and returns TRUE if \fIl\fR is found in this layout (not including child layouts); otherwise returns FALSE. -.SH "QSize QBoxLayout::sizeHint () const\fC [virtual]\fR" -Returns the preferred size of this box layout. -.PP -Reimplemented from QLayoutItem. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qboxlayout.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qboxlayout.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbrush.3qt b/doc/man/man3/qbrush.3qt deleted file mode 100644 index 0f32c7204..000000000 --- a/doc/man/man3/qbrush.3qt +++ /dev/null @@ -1,234 +0,0 @@ -'\" t -.TH QBrush 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 -QBrush \- Defines the fill pattern of shapes drawn by a QPainter -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQBrush\fR ()" -.br -.ti -1c -.BI "\fBQBrush\fR ( BrushStyle style )" -.br -.ti -1c -.BI "\fBQBrush\fR ( const QColor & color, BrushStyle style = SolidPattern )" -.br -.ti -1c -.BI "\fBQBrush\fR ( const QColor & color, const QPixmap & pixmap )" -.br -.ti -1c -.BI "\fBQBrush\fR ( const QBrush & b )" -.br -.ti -1c -.BI "\fB~QBrush\fR ()" -.br -.ti -1c -.BI "QBrush & \fBoperator=\fR ( const QBrush & b )" -.br -.ti -1c -.BI "BrushStyle \fBstyle\fR () const" -.br -.ti -1c -.BI "void \fBsetStyle\fR ( BrushStyle s )" -.br -.ti -1c -.BI "const QColor & \fBcolor\fR () const" -.br -.ti -1c -.BI "void \fBsetColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QBrush & b ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QBrush & b ) const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QBrush & b )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QBrush & b )" -.br -.in -1c -.SH DESCRIPTION -The QBrush class defines the fill pattern of shapes drawn by a QPainter. -.PP -A brush has a style and a color. One of the brush styles is a custom pattern, which is defined by a QPixmap. -.PP -The brush style defines the fill pattern. The default brush style is NoBrush (depending on how you construct a brush). This style tells the painter to not fill shapes. The standard style for filling is SolidPattern. -.PP -The brush color defines the color of the fill pattern. The QColor documentation lists the predefined colors. -.PP -Use the QPen class for specifying line/outline styles. -.PP -Example: -.PP -.nf -.br - QPainter painter; -.br - QBrush brush( yellow ); // yellow solid pattern -.br - painter.begin( &anyPaintDevice ); // paint something -.br - painter.setBrush( brush ); // set the yellow brush -.br - painter.setPen( NoPen ); // do not draw outline -.br - painter.drawRect( 40,30, 200,100 ); // draw filled rectangle -.br - painter.setBrush( NoBrush ); // do not fill -.br - painter.setPen( black ); // set black pen, 0 pixel width -.br - painter.drawRect( 10,10, 30,20 ); // draw rectangle outline -.br - painter.end(); // painting done -.br -.fi -.PP -See the setStyle() function for a complete list of brush styles. -.PP -
          -.ce 1 -.B "[Image Omitted]" -.PP -
          -.PP -See also QPainter, QPainter::setBrush(), QPainter::setBrushOrigin(), Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QBrush::QBrush ()" -Constructs a default black brush with the style NoBrush (will not fill shapes). -.SH "QBrush::QBrush ( BrushStyle style )" -Constructs a black brush with the style \fIstyle\fR. -.PP -See also setStyle(). -.SH "QBrush::QBrush ( const QColor & color, BrushStyle style = SolidPattern )" -Constructs a brush with the color \fIcolor\fR and the style \fIstyle\fR. -.PP -See also setColor() and setStyle(). -.SH "QBrush::QBrush ( const QColor & color, const QPixmap & pixmap )" -Constructs a brush with the color \fIcolor\fR and a custom pattern stored in \fIpixmap\fR. -.PP -The color will only have an effect for monochrome pixmaps, i.e. for QPixmap::depth() == 1. -.PP -Pixmap brushes are currently not supported when printing on X11. -.PP -See also setColor() and setPixmap(). -.SH "QBrush::QBrush ( const QBrush & b )" -Constructs a brush that is a shallow copy of \fIb\fR. -.SH "QBrush::~QBrush ()" -Destroys the brush. -.SH "const QColor & QBrush::color () const" -Returns the brush color. -.PP -See also setColor(). -.SH "bool QBrush::operator!= ( const QBrush & b ) const" -Returns TRUE if the brush is different from \fIb\fR; otherwise returns FALSE. -.PP -Two brushes are different if they have different styles, colors or pixmaps. -.PP -See also operator==(). -.SH "QBrush & QBrush::operator= ( const QBrush & b )" -Assigns \fIb\fR to this brush and returns a reference to this brush. -.SH "bool QBrush::operator== ( const QBrush & b ) const" -Returns TRUE if the brush is equal to \fIb\fR; otherwise returns FALSE. -.PP -Two brushes are equal if they have equal styles, colors and pixmaps. -.PP -See also operator!=(). -.SH "QPixmap * QBrush::pixmap () const" -Returns a pointer to the custom brush pattern, or 0 if no custom brush pattern has been set. -.PP -See also setPixmap(). -.PP -Example: richtext/richtext.cpp. -.SH "void QBrush::setColor ( const QColor & c )" -Sets the brush color to \fIc\fR. -.PP -See also color() and setStyle(). -.PP -Example: picture/picture.cpp. -.SH "void QBrush::setPixmap ( const QPixmap & pixmap )" -Sets the brush pixmap to \fIpixmap\fR. The style is set to CustomPattern. -.PP -The current brush color will only have an effect for monochrome pixmaps, i.e. for QPixmap::depth() == 1. -.PP -Pixmap brushes are currently not supported when printing on X11. -.PP -See also pixmap() and color(). -.PP -Example: richtext/richtext.cpp. -.SH "void QBrush::setStyle ( BrushStyle s )" -Sets the brush style to \fIs\fR. -.PP -The brush styles are:
          .nf -.TS -l - l. Pattern Meaning NoBrush will not fill shapes (default). SolidPattern solid (100%) fill pattern. Dense1Pattern 94% fill pattern. Dense2Pattern 88% fill pattern. Dense3Pattern 63% fill pattern. Dense4Pattern 50% fill pattern. Dense5Pattern 37% fill pattern. Dense6Pattern 12% fill pattern. Dense7Pattern 6% fill pattern. HorPattern horizontal lines pattern. VerPattern vertical lines pattern. CrossPattern crossing lines pattern. BDiagPattern diagonal lines (directed /) pattern. FDiagPattern diagonal lines (directed \) pattern. DiagCrossPattern diagonal crossing lines pattern. CustomPattern -.TE -.fi -
          -.PP -On Windows, dense and custom patterns cannot be transparent. -.PP -See the Detailed Description for a picture of all the styles. -.PP -See also style(). -.SH "BrushStyle QBrush::style () const" -Returns the brush style. -.PP -See also setStyle(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QBrush & b )" -Writes the brush \fIb\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QBrush & b )" -Reads the brush \fIb\fR from the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqbrush.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbrush.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbuffer.3qt b/doc/man/man3/qbuffer.3qt deleted file mode 100644 index 82d78bb09..000000000 --- a/doc/man/man3/qbuffer.3qt +++ /dev/null @@ -1,138 +0,0 @@ -'\" t -.TH QBuffer 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 -QBuffer \- I/O device that operates on a QByteArray -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

          -.PP -\fC#include \fR -.PP -Inherits QIODevice. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQBuffer\fR ()" -.br -.ti -1c -.BI "\fBQBuffer\fR ( QByteArray buf )" -.br -.ti -1c -.BI "\fB~QBuffer\fR ()" -.br -.ti -1c -.BI "QByteArray \fBbuffer\fR () const" -.br -.ti -1c -.BI "bool \fBsetBuffer\fR ( QByteArray buf )" -.br -.ti -1c -.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * p, TQ_ULONG len )" -.br -.ti -1c -.BI "TQ_LONG \fBwriteBlock\fR ( const QByteArray & data )" -.br -.in -1c -.SH DESCRIPTION -The QBuffer class is an I/O device that operates on a QByteArray. -.PP -QBuffer is used to read and write to a memory buffer. It is normally used with a QTextStream or a QDataStream. QBuffer has an associated QByteArray which holds the buffer data. The size() of the buffer is automatically adjusted as data is written. -.PP -The constructor \fCQBuffer(QByteArray)\fR creates a QBuffer using an existing byte array. The byte array can also be set with setBuffer(). Writing to the QBuffer will modify the original byte array because QByteArray is explicitly shared. -.PP -Use open() to open the buffer before use and to set the mode (read-only, write-only, etc.). close() closes the buffer. The buffer must be closed before reopening or calling setBuffer(). -.PP -A common way to use QBuffer is through QDataStream or QTextStream, which have constructors that take a QBuffer parameter. For convenience, there are also QDataStream and QTextStream constructors that take a QByteArray parameter. These constructors create and open an internal QBuffer. -.PP -Note that QTextStream can also operate on a QString (a Unicode string); a QBuffer cannot. -.PP -You can also use QBuffer directly through the standard QIODevice functions readBlock(), writeBlock() readLine(), at(), getch(), putch() and ungetch(). -.PP -See also QFile, QDataStream, QTextStream, QByteArray, Shared Classes, Collection Classes, and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QBuffer::QBuffer ()" -Constructs an empty buffer. -.SH "QBuffer::QBuffer ( QByteArray buf )" -Constructs a buffer that operates on \fIbuf\fR. -.PP -If you open the buffer in write mode (IO_WriteOnly or IO_ReadWrite) and write something into the buffer, \fIbuf\fR will be modified. -.PP -Example: -.PP -.nf -.br - QCString str = "abc"; -.br - QBuffer b( str ); -.br - b.open( IO_WriteOnly ); -.br - b.at( 3 ); // position at the 4th character (the terminating \\0) -.br - b.writeBlock( "def", 4 ); // write "def" including the terminating \\0 -.br - b.close(); -.br - // Now, str == "abcdef" with a terminating \\0 -.br -.fi -.PP -See also setBuffer(). -.SH "QBuffer::~QBuffer ()" -Destroys the buffer. -.SH "QByteArray QBuffer::buffer () const" -Returns this buffer's byte array. -.PP -See also setBuffer(). -.SH "bool QBuffer::setBuffer ( QByteArray buf )" -Replaces the buffer's contents with \fIbuf\fR and returns TRUE. -.PP -Does nothing (and returns FALSE) if isOpen() is TRUE. -.PP -Note that if you open the buffer in write mode (IO_WriteOnly or IO_ReadWrite) and write something into the buffer, \fIbuf\fR is also modified because QByteArray is an explicitly shared class. -.PP -See also buffer(), open(), and close(). -.SH "TQ_LONG QBuffer::writeBlock ( const char * p, TQ_ULONG len )\fC [virtual]\fR" -Writes \fIlen\fR bytes from \fIp\fR into the buffer at the current index position, overwriting any characters there and extending the buffer if necessary. Returns the number of bytes actually written. -.PP -Returns -1 if an error occurred. -.PP -See also readBlock(). -.PP -Reimplemented from QIODevice. -.SH "TQ_LONG QBuffer::writeBlock ( const QByteArray & data )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This convenience function is the same as calling -\fCwriteBlock( data.data(), data.size() )\fR with \fIdata\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqbuffer.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbuffer.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbutton.3qt b/doc/man/man3/qbutton.3qt deleted file mode 100644 index 28aacc098..000000000 --- a/doc/man/man3/qbutton.3qt +++ /dev/null @@ -1,490 +0,0 @@ -'\" t -.TH QButton 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 -QButton \- The abstract base class of button widgets, providing functionality common to buttons -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -Inherited by QCheckBox, QPushButton, QRadioButton, and QToolButton. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQButton\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QButton\fR ()" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "const QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" -.br -.ti -1c -.BI "QKeySequence \fBaccel\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" -.br -.ti -1c -.BI "bool \fBisToggleButton\fR () const" -.br -.ti -1c -.BI "enum \fBToggleType\fR { SingleShot, Toggle, Tristate }" -.br -.ti -1c -.BI "ToggleType \fBtoggleType\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDown\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisDown\fR () const" -.br -.ti -1c -.BI "bool \fBisOn\fR () const" -.br -.ti -1c -.BI "enum \fBToggleState\fR { Off, NoChange, On }" -.br -.ti -1c -.BI "ToggleState \fBstate\fR () const" -.br -.ti -1c -.BI "bool autoResize () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setAutoResize ( bool ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBautoRepeat\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoRepeat\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisExclusiveToggle\fR () const" -.br -.ti -1c -.BI "QButtonGroup * \fBgroup\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBanimateClick\fR ()" -.br -.ti -1c -.BI "void \fBtoggle\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBpressed\fR ()" -.br -.ti -1c -.BI "void \fBreleased\fR ()" -.br -.ti -1c -.BI "void \fBclicked\fR ()" -.br -.ti -1c -.BI "void \fBtoggled\fR ( bool on )" -.br -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QKeySequence \fBaccel\fR - the accelerator associated with the button" -.br -.ti -1c -.BI "bool \fBautoRepeat\fR - whether autoRepeat is enabled" -.br -.ti -1c -.BI "bool autoResize - whether autoResize is enabled \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBdown\fR - whether the button is pressed" -.br -.ti -1c -.BI "bool \fBexclusiveToggle\fR - whether the button is an exclusive toggle \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBon\fR - whether the button is toggled \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR - the pixmap shown on the button" -.br -.ti -1c -.BI "QString \fBtext\fR - the text shown on the button" -.br -.ti -1c -.BI "bool \fBtoggleButton\fR - whether the button is a toggle button \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "ToggleState \fBtoggleState\fR - the state of the toggle button \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "ToggleType \fBtoggleType\fR - the type of toggle on the button \fI(read " "only" ")\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsetToggleButton\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetToggleType\fR ( ToggleType type )" -.br -.ti -1c -.BI "void \fBsetOn\fR ( bool on )" -.br -.ti -1c -.BI "virtual void \fBsetState\fR ( ToggleState s )" -.br -.ti -1c -.BI "virtual bool \fBhitButton\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "virtual void \fBdrawButton\fR ( QPainter * )" -.br -.ti -1c -.BI "virtual void \fBdrawButtonLabel\fR ( QPainter * )" -.br -.ti -1c -.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" -.br -.in -1c -.SH DESCRIPTION -The QButton class is the abstract base class of button widgets, providing functionality common to buttons. -.PP -\fBIf you want to create a button use QPushButton.\fR -.PP -The QButton class implements an \fIabstract\fR button, and lets subclasses specify how to reply to user actions and how to draw the button. -.PP -QButton provides both push and toggle buttons. The QRadioButton and QCheckBox classes provide only toggle buttons; QPushButton and QToolButton provide both toggle and push buttons. -.PP -Any button can have either a text or pixmap label. setText() sets the button to be a text button and setPixmap() sets it to be a pixmap button. The text/pixmap is manipulated as necessary to create the "disabled" appearance when the button is disabled. -.PP -QButton provides most of the states used for buttons: -.TP -isDown() indicates whether the button is \fIpressed\fR down. -.TP -isOn() indicates whether the button is \fIon\fR. Only toggle buttons can be switched on and off (see below). -.TP -isEnabled() indicates whether the button can be pressed by the user. -.TP -setAutoRepeat() sets whether the button will auto-repeat if the user holds it down. -.TP -setToggleButton() sets whether the button is a toggle button or not. -.PP -The difference between isDown() and isOn() is as follows: When the user clicks a toggle button to toggle it on, the button is first \fIpressed\fR and then released into the \fIon\fR state. When the user clicks it again (to toggle it off), the button moves first to the \fIpressed\fR state, then to the \fIoff\fR state (isOn() and isDown() are both FALSE). -.PP -Default buttons (as used in many dialogs) are provided by QPushButton::setDefault() and QPushButton::setAutoDefault(). -.PP -QButton provides five signals:
            -.TP -pressed() is emitted when the button is pressed. E.g. with the mouse or when animateClick() is called. -.TP -released() is emitted when the button is released. E.g. when the mouse is released or the cursor is moved outside the widget. -.TP -clicked() is emitted when the button is first pressed and then released when the accelerator key is typed, or when animateClick() is called. -.TP -toggled(bool) is emitted when the state of a toggle button changes. -.TP -stateChanged(int) is emitted when the state of a tristate toggle button changes. -.PP -If the button is a text button with an ampersand (&) in its text, QButton creates an automatic accelerator key. This code creates a push button labelled "Rock & Roll" (where the c is underlined). The button gets an automatic accelerator key, Alt+C: -.PP -.nf -.br - QPushButton *p = new QPushButton( "Ro&ck && Roll", this ); -.br -.fi -.PP -In this example, when the user presses Alt+C the button will call animateClick(). -.PP -You can also set a custom accelerator using the setAccel() function. This is useful mostly for pixmap buttons because they have no automatic accelerator. -.PP -.nf -.br - p->setPixmap( QPixmap("print.png") ); -.br - p->setAccel( ALT+Key_F7 ); -.br -.fi -.PP -All of the buttons provided by Qt (QPushButton, QToolButton, QCheckBox and QRadioButton) can display both text and pixmaps. -.PP -To subclass QButton, you must reimplement at least drawButton() (to draw the button's outline) and drawButtonLabel() (to draw its text or pixmap). It is generally advisable to reimplement sizeHint() as well, and sometimes hitButton() (to determine whether a button press is within the button). -.PP -To reduce flickering, QButton::paintEvent() sets up a pixmap that the drawButton() function draws in. You should not reimplement paintEvent() for a subclass of QButton unless you want to take over all drawing. -.PP -See also QButtonGroup and Abstract Widget Classes. -.SS "Member Type Documentation" -.SH "QButton::ToggleState" -This enum defines the state of a toggle button. -.TP -\fCQButton::Off\fR - the button is in the "off" state -.TP -\fCQButton::NoChange\fR - the button is in the default/unchanged state -.TP -\fCQButton::On\fR - the button is in the "on" state -.SH "QButton::ToggleType" -This enum type defines what a button can do in response to a mouse/keyboard press: -.TP -\fCQButton::SingleShot\fR - pressing the button causes an action, then the button returns to the unpressed state. -.TP -\fCQButton::Toggle\fR - pressing the button toggles it between an On and an Off state. -.TP -\fCQButton::Tristate\fR - pressing the button cycles between the three states On, Off and NoChange -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QButton::QButton ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a standard button called \fIname\fR with parent \fIparent\fR, using the widget flags \fIf\fR. -.PP -If \fIparent\fR is a QButtonGroup, this constructor calls QButtonGroup::insert(). -.SH "QButton::~QButton ()" -Destroys the button. -.SH "QKeySequence QButton::accel () const" -Returns the accelerator associated with the button. See the "accel" property for details. -.SH "void QButton::animateClick ()\fC [slot]\fR" -Performs an animated click: the button is pressed and released a short while later. -.PP -The pressed(), released(), clicked(), toggled(), and stateChanged() signals are emitted as appropriate. -.PP -This function does nothing if the button is disabled. -.PP -See also accel. -.SH "bool QButton::autoRepeat () const" -Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. -.SH "bool QButton::autoResize () const" -Returns TRUE if autoResize is enabled; otherwise returns FALSE. See the "autoResize" property for details. -.SH "void QButton::clicked ()\fC [signal]\fR" -This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). -.PP -The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. -.PP -\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. -.PP -See also pressed(), released(), toggled(), autoRepeat, and down. -.PP -Examples: -.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. -.SH "void QButton::drawButton ( QPainter * )\fC [virtual protected]\fR" -Draws the button. The default implementation does nothing. -.PP -This virtual function is reimplemented by subclasses to draw real buttons. At some point, these reimplementations should call drawButtonLabel(). -.PP -See also drawButtonLabel() and paintEvent(). -.SH "void QButton::drawButtonLabel ( QPainter * )\fC [virtual protected]\fR" -Draws the button text or pixmap. -.PP -This virtual function is reimplemented by subclasses to draw real buttons. It is invoked by drawButton(). -.PP -See also drawButton() and paintEvent(). -.SH "QButtonGroup * QButton::group () const" -Returns the group that this button belongs to. -.PP -If the button is not a member of any QButtonGroup, this function returns 0. -.PP -See also QButtonGroup. -.SH "bool QButton::hitButton ( const QPoint & pos ) const\fC [virtual protected]\fR" -Returns TRUE if \fIpos\fR is inside the clickable button rectangle; otherwise returns FALSE. -.PP -By default, the clickable area is the entire widget. Subclasses may reimplement it, though. -.SH "bool QButton::isDown () const" -Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. -.SH "bool QButton::isExclusiveToggle () const" -Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. -.SH "bool QButton::isOn () const" -Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. -.SH "bool QButton::isToggleButton () const" -Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. -.SH "void QButton::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" -Handles paint events for buttons. Small and typically complex buttons are painted double-buffered to reduce flicker. The actually drawing is done in the virtual functions drawButton() and drawButtonLabel(). -.PP -See also drawButton() and drawButtonLabel(). -.PP -Reimplemented from QWidget. -.SH "const QPixmap * QButton::pixmap () const" -Returns the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::pressed ()\fC [signal]\fR" -This signal is emitted when the button is pressed down. -.PP -See also released() and clicked(). -.PP -Examples: -.)l network/httpd/httpd.cpp and popup/popup.cpp. -.SH "void QButton::released ()\fC [signal]\fR" -This signal is emitted when the button is released. -.PP -See also pressed(), clicked(), and toggled(). -.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" -Sets the accelerator associated with the button. See the "accel" property for details. -.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" -Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. -.SH "void QButton::setAutoResize ( bool )" -Sets whether autoResize is enabled. See the "autoResize" property for details. -.SH "void QButton::setDown ( bool )\fC [virtual]\fR" -Sets whether the button is pressed. See the "down" property for details. -.SH "void QButton::setOn ( bool on )\fC [protected]\fR" -Sets the state of this button to On if \fIon\fR is TRUE; otherwise to Off. -.PP -See also toggleState. -.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" -Sets the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::setState ( ToggleState s )\fC [virtual protected]\fR" -Sets the toggle state of the button to \fIs\fR. \fIs\fR can be Off, NoChange or On. -.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" -Sets the text shown on the button. See the "text" property for details. -.SH "void QButton::setToggleButton ( bool b )\fC [protected]\fR" -If \fIb\fR is TRUE, this button becomes a toggle button; if \fIb\fR is FALSE, this button becomes a command button. -.PP -See also toggleButton. -.SH "void QButton::setToggleType ( ToggleType type )\fC [virtual protected]\fR" -Sets the toggle type of the button to \fItype\fR. -.PP -\fItype\fR can be set to SingleShot, Toggle and Tristate. -.SH "ToggleState QButton::state () const" -Returns the state of the toggle button. See the "toggleState" property for details. -.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. -.PP -See also clicked() and QButton::ToggleState. -.SH "QString QButton::text () const" -Returns the text shown on the button. See the "text" property for details. -.SH "void QButton::toggle ()\fC [slot]\fR" -Toggles the state of a toggle button. -.PP -See also on, setOn(), toggled(), and toggleButton. -.SH "ToggleType QButton::toggleType () const" -Returns the type of toggle on the button. See the "toggleType" property for details. -.SH "void QButton::toggled ( bool on )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, or because setOn() was called. -.PP -See also clicked(). -.PP -Example: listbox/listbox.cpp. -.SS "Property Documentation" -.SH "QKeySequence accel" -This property holds the accelerator associated with the button. -.PP -This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. -.PP -Set this property's value with setAccel() and get this property's value with accel(). -.SH "bool autoRepeat" -This property holds whether autoRepeat is enabled. -.PP -If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. -.PP -Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). -.SH "bool autoResize" -This property holds whether autoResize is enabled. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -If autoResize is enabled then the button will resize itself whenever the contents are changed. -.PP -Set this property's value with setAutoResize() and get this property's value with autoResize(). -.SH "bool down" -This property holds whether the button is pressed. -.PP -If this property is TRUE, the button is pressed down. The signals pressed() and clicked() are not emitted if you set this property to TRUE. The default is FALSE. -.PP -Set this property's value with setDown() and get this property's value with isDown(). -.SH "bool exclusiveToggle" -This property holds whether the button is an exclusive toggle. -.PP -If this property is TRUE and the button is in a QButtonGroup, the button can only be toggled off by another one being toggled on. The default is FALSE. -.PP -Get this property's value with isExclusiveToggle(). -.SH "bool on" -This property holds whether the button is toggled. -.PP -This property should only be set for toggle buttons. -.PP -Get this property's value with isOn(). -.SH "QPixmap pixmap" -This property holds the pixmap shown on the button. -.PP -If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. -.PP -pixmap() returns 0 if no pixmap was set. -.PP -Set this property's value with setPixmap() and get this property's value with pixmap(). -.SH "QString text" -This property holds the text shown on the button. -.PP -This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. -.PP -There is no default text. -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "bool toggleButton" -This property holds whether the button is a toggle button. -.PP -The default value is FALSE. -.PP -Get this property's value with isToggleButton(). -.SH "ToggleState toggleState" -This property holds the state of the toggle button. -.PP -If this property is changed then it does not cause the button to be repainted. -.PP -Get this property's value with state(). -.SH "ToggleType toggleType" -This property holds the type of toggle on the button. -.PP -The default toggle type is SingleShot. -.PP -See also QButton::ToggleType. -.PP -Get this property's value with toggleType(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqbutton.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbutton.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbuttongroup.3qt b/doc/man/man3/qbuttongroup.3qt deleted file mode 100644 index e7dec6cbf..000000000 --- a/doc/man/man3/qbuttongroup.3qt +++ /dev/null @@ -1,243 +0,0 @@ -'\" t -.TH QButtonGroup 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 -QButtonGroup \- Organizes QButton widgets in a group -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QGroupBox. -.PP -Inherited by QHButtonGroup and QVButtonGroup. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQButtonGroup\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQButtonGroup\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQButtonGroup\fR ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQButtonGroup\fR ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "bool \fBisExclusive\fR () const" -.br -.ti -1c -.BI "bool \fBisRadioButtonExclusive\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetExclusive\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetRadioButtonExclusive\fR ( bool )" -.br -.ti -1c -.BI "int \fBinsert\fR ( QButton * button, int id = -1 )" -.br -.ti -1c -.BI "void \fBremove\fR ( QButton * button )" -.br -.ti -1c -.BI "QButton * \fBfind\fR ( int id ) const" -.br -.ti -1c -.BI "int \fBid\fR ( QButton * button ) const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetButton\fR ( int id )" -.br -.ti -1c -.BI "virtual void \fBmoveFocus\fR ( int key )" -.br -.ti -1c -.BI "QButton * \fBselected\fR () const" -.br -.ti -1c -.BI "int \fBselectedId\fR () const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBpressed\fR ( int id )" -.br -.ti -1c -.BI "void \fBreleased\fR ( int id )" -.br -.ti -1c -.BI "void \fBclicked\fR ( int id )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBexclusive\fR - whether the button group is exclusive" -.br -.ti -1c -.BI "bool \fBradioButtonExclusive\fR - whether the radio buttons in the group are exclusive" -.br -.ti -1c -.BI "int \fBselectedId\fR - the selected toggle button" -.br -.in -1c -.SH DESCRIPTION -The QButtonGroup widget organizes QButton widgets in a group. -.PP -A button group widget makes it easier to deal with groups of buttons. Each button in a button group has a unique identifier. The button group emits a clicked() signal with this identifier when a button in the group is clicked. This makes a button group particularly useful when you have several similar buttons and want to connect all their clicked() signals to a single slot. -.PP -An exclusive button group switches off all toggle buttons except the one that was clicked. A button group is, by default, non-exclusive. Note that all radio buttons that are inserted into a button group are mutually exclusive even if the button group is non-exclusive. (See setRadioButtonExclusive().) -.PP -There are two ways of using a button group: -.TP -The button group is the parent widget of a number of buttons, i.e. the button group is the parent argument in the button constructor. The buttons are assigned identifiers 0, 1, 2, etc., in the order they are created. A QButtonGroup can display a frame and a title because it inherits QGroupBox. -.TP -The button group is an invisible widget and the contained buttons have some other parent widget. In this usage, each button must be manually inserted, using insert(), into the button group and given an identifier. -.PP -A button can be removed from the group with remove(). A pointer to a button with a given id can be obtained using find(). The id of a button is available using id(). A button can be set \fIon\fR with setButton(). The number of buttons in the group is returned by count(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QPushButton, QCheckBox, QRadioButton, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QButtonGroup::QButtonGroup ( QWidget * parent = 0, const char * name = 0 )" -Constructs a button group with no title. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QButtonGroup::QButtonGroup ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a button group with the title \fItitle\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QButtonGroup::QButtonGroup ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" -Constructs a button group with no title. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QButtonGroup::QButtonGroup ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a button group with title \fItitle\fR. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "void QButtonGroup::clicked ( int id )\fC [signal]\fR" -This signal is emitted when a button in the group is clicked. The \fIid\fR argument is the button's identifier. -.PP -See also insert(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp and xform/xform.cpp. -.SH "int QButtonGroup::count () const" -Returns the number of buttons in the group. -.SH "QButton * QButtonGroup::find ( int id ) const" -Returns the button with the specified identifier \fIid\fR, or 0 if the button was not found. -.SH "int QButtonGroup::id ( QButton * button ) const" -Returns the id of \fIbutton\fR, or -1 if \fIbutton\fR is not a member of this group. -.PP -See also selectedId. -.SH "int QButtonGroup::insert ( QButton * button, int id = -1 )" -Inserts the \fIbutton\fR with the identifier \fIid\fR into the button group. Returns the button identifier. -.PP -Buttons are normally inserted into a button group automatically by passing the button group as the parent when the button is constructed. So it is not necessary to manually insert buttons that have this button group as their parent widget. An exception is when you want custom identifiers instead of the default 0, 1, 2, etc., or if you want the buttons to have some other parent. -.PP -The button is assigned the identifier \fIid\fR or an automatically generated identifier. It works as follows: If \fIid\fR >= 0, this identifier is assigned. If \fIid\fR == -1 (default), the identifier is equal to the number of buttons in the group. If \fIid\fR is any other negative integer, for instance -2, a unique identifier (negative integer <= -2) is generated. No button has an id of -1. -.PP -See also find(), remove(), and exclusive. -.PP -Examples: -.)l listbox/listbox.cpp and xform/xform.cpp. -.SH "bool QButtonGroup::isExclusive () const" -Returns TRUE if the button group is exclusive; otherwise returns FALSE. See the "exclusive" property for details. -.SH "bool QButtonGroup::isRadioButtonExclusive () const" -Returns TRUE if the radio buttons in the group are exclusive; otherwise returns FALSE. See the "radioButtonExclusive" property for details. -.SH "void QButtonGroup::moveFocus ( int key )\fC [virtual]\fR" -Moves the keyboard focus according to \fIkey\fR, and if appropriate checks the new focus item. -.PP -This function does nothing unless the keyboard focus points to one of the button group members and \fIkey\fR is one of Key_Up, Key_Down, Key_Left and Key_Right. -.SH "void QButtonGroup::pressed ( int id )\fC [signal]\fR" -This signal is emitted when a button in the group is pressed. The \fIid\fR argument is the button's identifier. -.PP -See also insert(). -.SH "void QButtonGroup::released ( int id )\fC [signal]\fR" -This signal is emitted when a button in the group is released. The \fIid\fR argument is the button's identifier. -.PP -See also insert(). -.SH "void QButtonGroup::remove ( QButton * button )" -Removes the \fIbutton\fR from the button group. -.PP -See also insert(). -.SH "QButton * QButtonGroup::selected () const" -Returns the selected toggle button if exactly one is selected; otherwise returns 0. -.PP -See also selectedId. -.SH "int QButtonGroup::selectedId () const" -Returns the selected toggle button. See the "selectedId" property for details. -.SH "void QButtonGroup::setButton ( int id )\fC [virtual]\fR" -Sets the selected toggle button to \fIid\fR. See the "selectedId" property for details. -.SH "void QButtonGroup::setExclusive ( bool )\fC [virtual]\fR" -Sets whether the button group is exclusive. See the "exclusive" property for details. -.SH "void QButtonGroup::setRadioButtonExclusive ( bool )\fC [virtual]\fR" -Sets whether the radio buttons in the group are exclusive. See the "radioButtonExclusive" property for details. -.SS "Property Documentation" -.SH "bool exclusive" -This property holds whether the button group is exclusive. -.PP -If this property is TRUE, then the buttons in the group are toggled, and to untoggle a button you must click on another button in the group. The default value is FALSE. -.PP -Set this property's value with setExclusive() and get this property's value with isExclusive(). -.SH "bool radioButtonExclusive" -This property holds whether the radio buttons in the group are exclusive. -.PP -If this property is TRUE (the default), the radiobuttons in the group are treated exclusively. -.PP -Set this property's value with setRadioButtonExclusive() and get this property's value with isRadioButtonExclusive(). -.SH "int selectedId" -This property holds the selected toggle button. -.PP -The toggle button is specified as an ID. -.PP -If no toggle button is selected, this property holds -1. -.PP -If setButton() is called on an exclusive group, the button with the given id will be set to on and all the others will be set to off. -.PP -See also selected(). -.PP -Set this property's value with setButton() and get this property's value with selectedId(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqbuttongroup.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbuttongroup.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qbytearray.3qt b/doc/man/man3/qbytearray.3qt deleted file mode 100644 index 030f5e2ed..000000000 --- a/doc/man/man3/qbytearray.3qt +++ /dev/null @@ -1,99 +0,0 @@ -'\" t -.TH QByteArray 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 -QByteArray \- Array of bytes -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

            -.PP -\fC#include \fR -.PP -Inherits QMemArray. -.PP -Inherited by QBitArray and QCString. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQByteArray\fR ()" -.br -.ti -1c -.BI "\fBQByteArray\fR ( int size )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QByteArray \fBqCompress\fR ( const QByteArray & data )" -.br -.ti -1c -.BI "QByteArray \fBqCompress\fR ( const uchar * data, int nbytes )" -.br -.ti -1c -.BI "QByteArray \fBqUncompress\fR ( const QByteArray & data )" -.br -.ti -1c -.BI "QByteArray \fBqUncompress\fR ( const uchar * data, int nbytes )" -.br -.in -1c -.SH DESCRIPTION -The QByteArray class provides an array of bytes. -.PP -The QByteArray class provides an explicitly shared array of bytes. It is useful for manipulating memory areas with custom data. QByteArray is implemented as a QMemArray. See the QMemArray documentation for further information. -.PP -See also Collection Classes and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QByteArray::QByteArray ()" -Constructs an empty QByteArray. -.SH "QByteArray::QByteArray ( int size )" -Constructs a QByteArray of size \fIsize\fR. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QByteArray tqCompress ( const QByteArray & data )" -Compresses the array \fIdata\fR and returns the compressed byte array using zlib. -.PP -See also tqUncompress(). -.SH "QByteArray tqCompress ( const uchar * data, int nbytes )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Compresses the array \fIdata\fR which is \fInbytes\fR long and returns the compressed byte array. -.SH "QByteArray tqUncompress ( const QByteArray & data )" -Uncompresses the array \fIdata\fR and returns the uncompressed byte array. -.PP -Returns an empty QByteArray if the input data was corrupt. -.PP -See also tqCompress(). -.SH "QByteArray tqUncompress ( const uchar * data, int nbytes )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Uncompresses the array \fIdata\fR which is \fInbytes\fR long and returns -the uncompressed byte array. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qbytearray.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qbytearray.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcache.3qt b/doc/man/man3/qcache.3qt deleted file mode 100644 index 149ada958..000000000 --- a/doc/man/man3/qcache.3qt +++ /dev/null @@ -1,215 +0,0 @@ -'\" t -.TH QCache 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 -QCache \- Template class that provides a cache based on QString keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCache\fR ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE )" -.br -.ti -1c -.BI "\fB~QCache\fR ()" -.br -.ti -1c -.BI "int \fBmaxCost\fR () const" -.br -.ti -1c -.BI "int \fBtotalCost\fR () const" -.br -.ti -1c -.BI "void \fBsetMaxCost\fR ( int m )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "bool \fBinsert\fR ( const QString & k, const type * d, int c = 1, int p = 0 )" -.br -.ti -1c -.BI "bool \fBremove\fR ( const QString & k )" -.br -.ti -1c -.BI "type * \fBtake\fR ( const QString & k )" -.br -.ti -1c -.BI "type * \fBfind\fR ( const QString & k, bool ref = TRUE ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( const QString & k ) const" -.br -.ti -1c -.BI "void \fBstatistics\fR () const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.in -1c -.SH DESCRIPTION -The QCache class is a template class that provides a cache based on QString keys. -.PP -A cache is a least recently used (LRU) list of cache items. Each cache item has a key and a certain cost. The sum of item costs, totalCost(), never exceeds the maximum cache cost, maxCost(). If inserting a new item would cause the total cost to exceed the maximum cost, the least recently used items in the cache are removed. -.PP -QCache is a template class. QCache defines a cache that operates on pointers to X, or X*. -.PP -Apart from insert(), by far the most important function is find() (which also exists as operator[]()). This function looks up an item, returns it, and by default marks it as being the most recently used item. -.PP -There are also methods to remove() or take() an object from the cache. Calling setAutoDelete(TRUE) for a cache tells it to delete items that are removed. The default is to not delete items when they are removed (i.e., remove() and take() are equivalent). -.PP -When inserting an item into the cache, only the pointer is copied, not the item itself. This is called a shallow copy. It is possible to make the cache copy all of the item's data (known as a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a cache and reimplement newItem() if you want deep copies. -.PP -When removing a cache item, the virtual function QPtrCollection::deleteItem() is called. The default implementation deletes the item if auto-deletion is enabled, and does nothing otherwise. -.PP -There is a QCacheIterator that can be used to traverse the items in the cache in arbitrary order. -.PP -In QCache, the cache items are accessed via QString keys, which are Unicode strings. If you want to use non-Unicode, plain 8-bit \fCchar*\fR keys, use the QAsciiCache template. A QCache has the same performance as a QAsciiCache. -.PP -See also QCacheIterator, QAsciiCache, QIntCache, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCache::QCache ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE )" -Constructs a cache whose contents will never have a total cost greater than \fImaxCost\fR and which is expected to contain less than \fIsize\fR items. -.PP -\fIsize\fR is actually the size of an internal hash array; it's usually best to make it a prime number and at least 50% bigger than the largest expected number of items in the cache. -.PP -Each inserted item has an associated cost. When inserting a new item, if the total cost of all items in the cache will exceed \fImaxCost\fR, the cache will start throwing out the older (least recently used) items until there is enough room for the new item to be inserted. -.PP -If \fIcaseSensitive\fR is TRUE (the default), the cache keys are case sensitive; if it is FALSE, they are case-insensitive. Case-insensitive comparison considers all Unicode letters. -.SH "QCache::~QCache ()" -Removes all items from the cache and destroys it. All iterators that access this cache will be reset. -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QCache::clear ()\fC [virtual]\fR" -Removes all items from the cache and deletes them if auto-deletion has been enabled. -.PP -All cache iterators that operate this on cache are reset. -.PP -See also remove() and take(). -.PP -Reimplemented from QPtrCollection. -.SH "uint QCache::count () const\fC [virtual]\fR" -Returns the number of items in the cache. -.PP -See also totalCost(). -.PP -Reimplemented from QPtrCollection. -.SH "type * QCache::find ( const QString & k, bool ref = TRUE ) const" -Returns the item associated with key \fIk\fR, or 0 if the key does not exist in the cache. If \fIref\fR is TRUE (the default), the item is moved to the front of the least recently used list. -.PP -If there are two or more items with equal keys, the one that was inserted last is returned. -.SH "bool QCache::insert ( const QString & k, const type * d, int c = 1, int p = 0 )" -Inserts the item \fId\fR into the cache with key \fIk\fR and associated cost, \fIc\fR. Returns TRUE if it is successfully inserted; otherwise returns FALSE. -.PP -The cache's size is limited, and if the total cost is too high, QCache will remove old, least recently used items until there is room for this new item. -.PP -The parameter \fIp\fR is internal and should be left at the default value (0). -.PP -\fBWarning:\fR If this function returns FALSE (which could happen, e.g. if the cost of this item alone exceeds maxCost()) you must delete \fId\fR yourself. Additionally, be very careful about using \fId\fR after calling this function because any other insertions into the cache, from anywhere in the application or within Qt itself, could cause the object to be discarded from the cache and the pointer to become invalid. -.SH "bool QCache::isEmpty () const" -Returns TRUE if the cache is empty; otherwise returns FALSE. -.SH "int QCache::maxCost () const" -Returns the maximum allowed total cost of the cache. -.PP -See also setMaxCost() and totalCost(). -.SH "type * QCache::operator[] ( const QString & k ) const" -Returns the item associated with key \fIk\fR, or 0 if \fIk\fR does not exist in the cache, and moves the item to the front of the least recently used list. -.PP -If there are two or more items with equal keys, the one that was inserted last is returned. -.PP -This is the same as find( k, TRUE ). -.PP -See also find(). -.SH "bool QCache::remove ( const QString & k )" -Removes the item associated with \fIk\fR, and returns TRUE if the item was present in the cache; otherwise returns FALSE. -.PP -The item is deleted if auto-deletion has been enabled, i.e., if you have called setAutoDelete(TRUE). -.PP -If there are two or more items with equal keys, the one that was inserted last is removed. -.PP -All iterators that refer to the removed item are set to point to the next item in the cache's traversal order. -.PP -See also take() and clear(). -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. -.SH "void QCache::setMaxCost ( int m )" -Sets the maximum allowed total cost of the cache to \fIm\fR. If the current total cost is greater than \fIm\fR, some items are deleted immediately. -.PP -See also maxCost() and totalCost(). -.SH "uint QCache::size () const" -Returns the size of the hash array used to implement the cache. This should be a bit bigger than count() is likely to be. -.SH "void QCache::statistics () const" -A debug-only utility function. Prints out cache usage, hit/miss, and distribution information using tqDebug(). This function does nothing in the release library. -.SH "type * QCache::take ( const QString & k )" -Takes the item associated with \fIk\fR out of the cache without deleting it, and returns a pointer to the item taken out, or 0 if the key does not exist in the cache. -.PP -If there are two or more items with equal keys, the one that was inserted last is taken. -.PP -All iterators that refer to the taken item are set to point to the next item in the cache's traversal order. -.PP -See also remove() and clear(). -.SH "int QCache::totalCost () const" -Returns the total cost of the items in the cache. This is an integer in the range 0 to maxCost(). -.PP -See also setMaxCost(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcache.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcache.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcacheiterator.3qt b/doc/man/man3/qcacheiterator.3qt deleted file mode 100644 index 082394ed3..000000000 --- a/doc/man/man3/qcacheiterator.3qt +++ /dev/null @@ -1,157 +0,0 @@ -'\" t -.TH QCacheIterator 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 -QCacheIterator \- Iterator for QCache collections -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCacheIterator\fR ( const QCache & cache )" -.br -.ti -1c -.BI "\fBQCacheIterator\fR ( const QCacheIterator & ci )" -.br -.ti -1c -.BI "QCacheIterator & \fBoperator=\fR ( const QCacheIterator & ci )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBatFirst\fR () const" -.br -.ti -1c -.BI "bool \fBatLast\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "type * \fBtoLast\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "QString \fBcurrentKey\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.ti -1c -.BI "type * \fBoperator+=\fR ( uint jump )" -.br -.ti -1c -.BI "type * \fBoperator--\fR ()" -.br -.ti -1c -.BI "type * \fBoperator-=\fR ( uint jump )" -.br -.in -1c -.SH DESCRIPTION -The QCacheIterator class provides an iterator for QCache collections. -.PP -Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them. -.PP -Multiple iterators are completely independent, even when they operate on the same QCache. QCache updates all iterators that refer an item when that item is removed. -.PP -QCacheIterator provides an operator++(), and an operator+=() to traverse the cache. The current() and currentKey() functions are used to access the current cache item and its key. The atFirst() and atLast() return TRUE if the iterator points to the first or last item in the cache respectively. The isEmpty() function returns TRUE if the cache is empty, and count() returns the number of items in the cache. -.PP -Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also QCache, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCacheIterator::QCacheIterator ( const QCache & cache )" -Constructs an iterator for \fIcache\fR. The current iterator item is set to point to the first item in the \fIcache\fR. -.SH "QCacheIterator::QCacheIterator ( const QCacheIterator & ci )" -Constructs an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently from there on. -.SH "bool QCacheIterator::atFirst () const" -Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also toFirst() and atLast(). -.SH "bool QCacheIterator::atLast () const" -Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also toLast() and atFirst(). -.SH "uint QCacheIterator::count () const" -Returns the number of items in the cache on which this iterator operates. -.PP -See also isEmpty(). -.SH "type * QCacheIterator::current () const" -Returns a pointer to the current iterator item. -.SH "QString QCacheIterator::currentKey () const" -Returns the key for the current iterator item. -.SH "bool QCacheIterator::isEmpty () const" -Returns TRUE if the cache is empty, i.e. count() == 0; otherwise it returns FALSE. -.PP -See also count(). -.SH "QCacheIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QCacheIterator::operator() ()" -Makes the succeeding item current and returns the original current item. -.PP -If the current iterator item was the last item in the cache or if it was 0, 0 is returned. -.SH "type * QCacheIterator::operator++ ()" -Prefix++ makes the iterator point to the item just after current() and makes that the new current item for the iterator. If current() was the last item, operator++() returns 0. -.SH "type * QCacheIterator::operator+= ( uint jump )" -Returns the item \fIjump\fR positions after the current item, or 0 if it is beyond the last item. Makes this the current item. -.SH "type * QCacheIterator::operator-- ()" -Prefix-- makes the iterator point to the item just before current() and makes that the new current item for the iterator. If current() was the first item, operator--() returns 0. -.SH "type * QCacheIterator::operator-= ( uint jump )" -Returns the item \fIjump\fR positions before the current item, or 0 if it is before the first item. Makes this the current item. -.SH "QCacheIterator & QCacheIterator::operator= ( const QCacheIterator & ci )" -Makes this an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently thereafter. -.SH "type * QCacheIterator::toFirst ()" -Sets the iterator to point to the first item in the cache and returns a pointer to the item. -.PP -Sets the iterator to 0 and returns 0 if the cache is empty. -.PP -See also toLast() and isEmpty(). -.SH "type * QCacheIterator::toLast ()" -Sets the iterator to point to the last item in the cache and returns a pointer to the item. -.PP -Sets the iterator to 0 and returns 0 if the cache is empty. -.PP -See also toFirst() and isEmpty(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcacheiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcacheiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvas.3qt b/doc/man/man3/qcanvas.3qt deleted file mode 100644 index ca68eebcd..000000000 --- a/doc/man/man3/qcanvas.3qt +++ /dev/null @@ -1,457 +0,0 @@ -'\" t -.TH QCanvas 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 -QCanvas \- 2D area that can contain QCanvasItem objects -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvas\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQCanvas\fR ( int w, int h )" -.br -.ti -1c -.BI "\fBQCanvas\fR ( QPixmap p, int h, int v, int tilewidth, int tileheight )" -.br -.ti -1c -.BI "virtual \fB~QCanvas\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetTiles\fR ( QPixmap p, int h, int v, int tilewidth, int tileheight )" -.br -.ti -1c -.BI "virtual void \fBsetBackgroundPixmap\fR ( const QPixmap & p )" -.br -.ti -1c -.BI "QPixmap \fBbackgroundPixmap\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetBackgroundColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "QColor \fBbackgroundColor\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTile\fR ( int x, int y, int tilenum )" -.br -.ti -1c -.BI "int \fBtile\fR ( int x, int y ) const" -.br -.ti -1c -.BI "int \fBtilesHorizontally\fR () const" -.br -.ti -1c -.BI "int \fBtilesVertically\fR () const" -.br -.ti -1c -.BI "int \fBtileWidth\fR () const" -.br -.ti -1c -.BI "int \fBtileHeight\fR () const" -.br -.ti -1c -.BI "virtual void \fBresize\fR ( int w, int h )" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "bool \fBonCanvas\fR ( int x, int y ) const" -.br -.ti -1c -.BI "bool \fBonCanvas\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "bool \fBvalidChunk\fR ( int x, int y ) const" -.br -.ti -1c -.BI "bool \fBvalidChunk\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "int \fBchunkSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBretune\fR ( int chunksze, int mxclusters = 100 )" -.br -.ti -1c -.BI "virtual void \fBsetAllChanged\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetChanged\fR ( const QRect & area )" -.br -.ti -1c -.BI "virtual void \fBsetUnchanged\fR ( const QRect & area )" -.br -.ti -1c -.BI "QCanvasItemList \fBallItems\fR ()" -.br -.ti -1c -.BI "QCanvasItemList \fBcollisions\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "QCanvasItemList \fBcollisions\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "QCanvasItemList \fBcollisions\fR ( const QPointArray & chunklist, const QCanvasItem * item, bool exact ) const" -.br -.ti -1c -.BI "void \fBdrawArea\fR ( const QRect & clip, QPainter * painter, bool dbuf = FALSE )" -.br -.ti -1c -.BI "virtual void \fBsetAdvancePeriod\fR ( int ms )" -.br -.ti -1c -.BI "virtual void \fBsetUpdatePeriod\fR ( int ms )" -.br -.ti -1c -.BI "virtual void \fBsetDoubleBuffering\fR ( bool y )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBadvance\fR ()" -.br -.ti -1c -.BI "virtual void \fBupdate\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBresized\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawBackground\fR ( QPainter & painter, const QRect & clip )" -.br -.ti -1c -.BI "virtual void \fBdrawForeground\fR ( QPainter & painter, const QRect & clip )" -.br -.in -1c -.SH DESCRIPTION -The QCanvas class provides a 2D area that can contain QCanvasItem objects. -.PP -The QCanvas class manages its 2D graphic area and all the canvas items the area contains. The canvas has no visual appearance of its own. Instead, it is displayed on screen using a QCanvasView. Multiple QCanvasView widgets may be associated with a canvas to provide multiple views of the same canvas. -.PP -The canvas is optimized for large numbers of items, particularly where only a small percentage of the items change at any one time. If the entire display changes very frequently, you should consider using your own custom QScrollView subclass. -.PP -Qt provides a rich set of canvas item classes, e.g. QCanvasEllipse, QCanvasLine, QCanvasPolygon, QCanvasPolygonalItem, QCanvasRectangle, QCanvasSpline, QCanvasSprite and QCanvasText. You can subclass to create your own canvas items; QCanvasPolygonalItem is the most common base class used for this purpose. -.PP -Items appear on the canvas after their show() function has been called (or setVisible(TRUE)), and \fIafter\fR update() has been called. The canvas only shows items that are visible, and then only if update() is called. (By default the canvas is white and so are canvas items, so if nothing appears try changing colors.) -.PP -If you created the canvas without passing a width and height to the constructor you must also call resize(). -.PP -Although a canvas may appear to be similar to a widget with child widgets, there are several notable differences: -.TP -Canvas items are usually much faster to manipulate and redraw than child widgets, with the speed advantage becoming especially great when there are \fImany\fR canvas items and non-rectangular items. In most situations canvas items are also a lot more memory efficient than child widgets. -.IP -.TP -It's easy to detect overlapping items (collision detection). -.IP -.TP -The canvas can be larger than a widget. A million-by-million canvas is perfectly possible. At such a size a widget might be very inefficient, and some window systems might not support it at all, whereas QCanvas scales well. Even with a billion pixels and a million items, finding a particular canvas item, detecting collisions, etc., is still fast (though the memory consumption may be prohibitive at such extremes). -.IP -.TP -Two or more QCanvasView objects can view the same canvas. -.IP -.TP -An arbitrary transformation matrix can be set on each QCanvasView which makes it easy to zoom, rotate or shear the viewed canvas. -.IP -.TP -Widgets provide a lot more functionality, such as input (QKeyEvent, QMouseEvent etc.) and layout management (QGridLayout etc.). -.IP -.PP -A canvas consists of a background, a number of canvas items organized by x, y and z coordinates, and a foreground. A canvas item's z coordinate can be treated as a layer number -- canvas items with a higher z coordinate appear in front of canvas items with a lower z coordinate. -.PP -The background is white by default, but can be set to a different color using setBackgroundColor(), or to a repeated pixmap using setBackgroundPixmap() or to a mosaic of smaller pixmaps using setTiles(). Individual tiles can be set with setTile(). There are corresponding get functions, e.g. backgroundColor() and backgroundPixmap(). -.PP -Note that QCanvas does not inherit from QWidget, even though it has some functions which provide the same functionality as those in QWidget. One of these is setBackgroundPixmap(); some others are resize(), size(), width() and height(). QCanvasView is the widget used to display a canvas on the screen. -.PP -Canvas items are added to a canvas by constructing them and passing the canvas to the canvas item's constructor. An item can be moved to a different canvas using QCanvasItem::setCanvas(). -.PP -Canvas items are movable (and in the case of QCanvasSprites, animated) objects that inherit QCanvasItem. Each canvas item has a position on the canvas (x, y coordinates) and a height (z coordinate), all of which are held as floating-point numbers. Moving canvas items also have x and y velocities. It's possible for a canvas item to be outside the canvas (for example QCanvasItem::x() is greater than width()). When a canvas item is off the canvas, onCanvas() returns FALSE and the canvas disregards the item. (Canvas items off the canvas do not slow down any of the common operations on the canvas.) -.PP -Canvas items can be moved with QCanvasItem::move(). The advance() function moves all QCanvasItem::animated() canvas items and setAdvancePeriod() makes QCanvas move them automatically on a periodic basis. In the context of the QCanvas classes, to `animate' a canvas item is to set it in motion, i.e. using QCanvasItem::setVelocity(). Animation of a canvas item itself, i.e. items which change over time, is enabled by calling QCanvasSprite::setFrameAnimation(), or more generally by subclassing and reimplementing QCanvasItem::advance(). To detect collisions use one of the QCanvasItem::collisions() functions. -.PP -The changed parts of the canvas are redrawn (if they are visible in a canvas view) whenever update() is called. You can either call update() manually after having changed the contents of the canvas, or force periodic updates using setUpdatePeriod(). If you have moving objects on the canvas, you must call advance() every time the objects should move one step further. Periodic calls to advance() can be forced using setAdvancePeriod(). The advance() function will call QCanvasItem::advance() on every item that is animated and trigger an update of the affected areas afterwards. (A canvas item that is `animated' is simply a canvas item that is in motion.) -.PP -QCanvas organizes its canvas items into \fIchunks\fR; these are areas on the canvas that are used to speed up most operations. Many operations start by eliminating most chunks (i.e. those which haven't changed) and then process only the canvas items that are in the few interesting (i.e. changed) chunks. A valid chunk, validChunk(), is one which is on the canvas. -.PP -The chunk size is a key factor to QCanvas's speed: if there are too many chunks, the speed benefit of grouping canvas items into chunks is reduced. If the chunks are too large, it takes too long to process each one. The QCanvas constructor tries to pick a suitable size, but you can call retune() to change it at any time. The chunkSize() function returns the current chunk size. The canvas items always make sure they're in the right chunks; all you need to make sure of is that the canvas uses the right chunk size. A good rule of thumb is that the size should be a bit smaller than the average canvas item size. If you have moving objects, the chunk size should be a bit smaller than the average size of the moving items. -.PP -The foreground is normally nothing, but if you reimplement drawForeground(), you can draw things in front of all the canvas items. -.PP -Areas can be set as changed with setChanged() and set unchanged with setUnchanged(). The entire canvas can be set as changed with setAllChanged(). A list of all the items on the canvas is returned by allItems(). -.PP -An area can be copied (painted) to a QPainter with drawArea(). -.PP -If the canvas is resized it emits the resized() signal. -.PP -The examples/canvas application and the 2D graphics page of the examples/demo application demonstrate many of QCanvas's facilities. -.PP -See also QCanvasView, QCanvasItem, Abstract Widget Classes, Graphics Classes, and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvas::QCanvas ( QObject * parent = 0, const char * name = 0 )" -Create a QCanvas with no size. \fIparent\fR and \fIname\fR are passed to the QObject superclass. -.PP -\fBWarning:\fR You \fImust\fR call resize() at some time after creation to be able to use the canvas. -.SH "QCanvas::QCanvas ( int w, int h )" -Constructs a QCanvas that is \fIw\fR pixels wide and \fIh\fR pixels high. -.SH "QCanvas::QCanvas ( QPixmap p, int h, int v, int tilewidth, int tileheight )" -Constructs a QCanvas which will be composed of \fIh\fR tiles horizontally and \fIv\fR tiles vertically. Each tile will be an image \fItilewidth\fR by \fItileheight\fR pixels taken from pixmap \fIp\fR. -.PP -The pixmap \fIp\fR is a list of tiles, arranged left to right, (and in the case of pixmaps that have multiple rows of tiles, top to bottom), with tile 0 in the top-left corner, tile 1 next to the right, and so on, e.g. -.PP -
            .nf -.TS -l - l. 0 1 2 3 4 5 6 -.TE -.fi -
            -.PP -The QCanvas is initially sized to show exactly the given number of tiles horizontally and vertically. If it is resized to be larger, the entire matrix of tiles will be repeated as often as necessary to cover the area. If it is smaller, tiles to the right and bottom will not be visible. -.PP -See also setTiles(). -.SH "QCanvas::~QCanvas ()\fC [virtual]\fR" -Destroys the canvas and all the canvas's canvas items. -.SH "void QCanvas::advance ()\fC [virtual slot]\fR" -Moves all QCanvasItem::animated() canvas items on the canvas and refreshes all changes to all views of the canvas. (An `animated' item is an item that is in motion; see setVelocity().) -.PP -The advance takes place in two phases. In phase 0, the QCanvasItem::advance() function of each QCanvasItem::animated() canvas item is called with paramater 0. Then all these canvas items are called again, with parameter 1. In phase 0, the canvas items should not change position, merely examine other items on the canvas for which special processing is required, such as collisions between items. In phase 1, all canvas items should change positions, ignoring any other items on the canvas. This two-phase approach allows for considerations of "fairness", although no QCanvasItem subclasses supplied with Qt do anything interesting in phase 0. -.PP -The canvas can be configured to call this function periodically with setAdvancePeriod(). -.PP -See also update(). -.SH "QCanvasItemList QCanvas::allItems ()" -Returns a list of all the items in the canvas. -.SH "QColor QCanvas::backgroundColor () const" -Returns the color set by setBackgroundColor(). By default, this is white. -.PP -This function is not a reimplementation of QWidget::backgroundColor() (QCanvas is not a subclass of QWidget), but all QCanvasViews that are viewing the canvas will set their backgrounds to this color. -.PP -See also setBackgroundColor() and backgroundPixmap(). -.SH "QPixmap QCanvas::backgroundPixmap () const" -Returns the pixmap set by setBackgroundPixmap(). By default, this is a null pixmap. -.PP -See also setBackgroundPixmap() and backgroundColor(). -.SH "int QCanvas::chunkSize () const" -Returns the chunk size of the canvas. -.PP -See also retune(). -.SH "QCanvasItemList QCanvas::collisions ( const QPoint & p ) const" -Returns a list of canvas items that collide with the point \fIp\fR. The list is ordered by z coordinates, from highest z coordinate (front-most item) to lowest z coordinate (rear-most item). -.SH "QCanvasItemList QCanvas::collisions ( const QRect & r ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a list of items which collide with the rectangle \fIr\fR. The list is ordered by z coordinates, from highest z coordinate (front-most item) to lowest z coordinate (rear-most item). -.SH "QCanvasItemList QCanvas::collisions ( const QPointArray & chunklist, const QCanvasItem * item, bool exact ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a list of canvas items which intersect with the chunks listed in \fIchunklist\fR, excluding \fIitem\fR. If \fIexact\fR is TRUE, only those which actually collide with \fIitem\fR are returned; otherwise canvas items are included just for being in the chunks. -.PP -This is a utility function mainly used to implement the simpler QCanvasItem::collisions() function. -.SH "void QCanvas::drawArea ( const QRect & clip, QPainter * painter, bool dbuf = FALSE )" -Paints all canvas items that are in the area \fIclip\fR to \fIpainter\fR, using double-buffering if \fIdbuf\fR is TRUE. -.PP -e.g. to print the canvas to a printer: -.PP -.nf -.br - QPrinter pr; -.br - if ( pr.setup() ) { -.br - QPainter p(&pr); -.br - canvas.drawArea( canvas.rect(), &p ); -.br - } -.br -.fi -.PP -Example: canvas/canvas.cpp. -.SH "void QCanvas::drawBackground ( QPainter & painter, const QRect & clip )\fC [virtual protected]\fR" -This virtual function is called for all updates of the canvas. It renders any background graphics using the painter \fIpainter\fR, in the area \fIclip\fR. If the canvas has a background pixmap or a tiled background, that graphic is used, otherwise the canvas is cleared using the background color. -.PP -If the graphics for an area change, you must explicitly call setChanged(const QRect&) for the result to be visible when update() is next called. -.PP -See also setBackgroundColor(), setBackgroundPixmap(), and setTiles(). -.SH "void QCanvas::drawForeground ( QPainter & painter, const QRect & clip )\fC [virtual protected]\fR" -This virtual function is called for all updates of the canvas. It renders any foreground graphics using the painter \fIpainter\fR, in the area \fIclip\fR. -.PP -If the graphics for an area change, you must explicitly call setChanged(const QRect&) for the result to be visible when update() is next called. -.PP -The default is to draw nothing. -.SH "int QCanvas::height () const" -Returns the height of the canvas, in pixels. -.PP -Example: canvas/canvas.cpp. -.SH "bool QCanvas::onCanvas ( int x, int y ) const" -Returns TRUE if the pixel position (\fIx\fR, \fIy\fR) is on the canvas; otherwise returns FALSE. -.PP -See also validChunk(). -.SH "bool QCanvas::onCanvas ( const QPoint & p ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the pixel position \fIp\fR is on the canvas; otherwise returns FALSE. -.PP -See also validChunk(). -.SH "QRect QCanvas::rect () const" -Returns a rectangle the size of the canvas. -.SH "void QCanvas::resize ( int w, int h )\fC [virtual]\fR" -Changes the size of the canvas to have a width of \fIw\fR and a height of \fIh\fR. This is a slow operation. -.PP -Examples: -.)l canvas/canvas.cpp and chart/chartform.cpp. -.SH "void QCanvas::resized ()\fC [signal]\fR" -This signal is emitted whenever the canvas is resized. Each QCanvasView connects to this signal to keep the scrollview's size correct. -.SH "void QCanvas::retune ( int chunksze, int mxclusters = 100 )\fC [virtual]\fR" -Change the efficiency tuning parameters to \fImxclusters\fR clusters, each of size \fIchunksze\fR. This is a slow operation if there are many objects on the canvas. -.PP -The canvas is divided into chunks which are rectangular areas \fIchunksze\fR wide by \fIchunksze\fR high. Use a chunk size which is about the average size of the canvas items. If you choose a chunk size which is too small it will increase the amount of calculation required when drawing since each change will affect many chunks. If you choose a chunk size which is too large the amount of drawing required will increase because for each change, a lot of drawing will be required since there will be many (unchanged) canvas items which are in the same chunk as the changed canvas items. -.PP -Internally, a canvas uses a low-resolution "chunk matrix" to keep track of all the items in the canvas. A 64x64 chunk matrix is the default for a 1024x1024 pixel canvas, where each chunk collects canvas items in a 16x16 pixel square. This default is also affected by setTiles(). You can tune this default using this function. For example if you have a very large canvas and want to trade off speed for memory then you might set the chunk size to 32 or 64. -.PP -The \fImxclusters\fR argument is the number of rectangular groups of chunks that will be separately drawn. If the canvas has a large number of small, dispersed items, this should be about that number. Our testing suggests that a large number of clusters is almost always best. -.SH "void QCanvas::setAdvancePeriod ( int ms )\fC [virtual]\fR" -Sets the canvas to call advance() every \fIms\fR milliseconds. Any previous setting by setAdvancePeriod() or setUpdatePeriod() is overridden. -.PP -If \fIms\fR is less than 0 advancing will be stopped. -.PP -Example: canvas/main.cpp. -.SH "void QCanvas::setAllChanged ()\fC [virtual]\fR" -Marks the whole canvas as changed. All views of the canvas will be entirely redrawn when update() is called next. -.SH "void QCanvas::setBackgroundColor ( const QColor & c )\fC [virtual]\fR" -Sets the solid background to be the color \fIc\fR. -.PP -See also backgroundColor(), setBackgroundPixmap(), and setTiles(). -.SH "void QCanvas::setBackgroundPixmap ( const QPixmap & p )\fC [virtual]\fR" -Sets the solid background to be the pixmap \fIp\fR repeated as necessary to cover the entire canvas. -.PP -See also backgroundPixmap(), setBackgroundColor(), and setTiles(). -.SH "void QCanvas::setChanged ( const QRect & area )\fC [virtual]\fR" -Marks \fIarea\fR as changed. This \fIarea\fR will be redrawn in all views that are showing it when update() is called next. -.SH "void QCanvas::setDoubleBuffering ( bool y )\fC [virtual]\fR" -If \fIy\fR is TRUE (the default) double-buffering is switched on; otherwise double-buffering is switched off. -.PP -Turning off double-buffering causes the redrawn areas to flicker a little and also gives a (usually small) performance improvement. -.PP -Example: canvas/canvas.cpp. -.SH "void QCanvas::setTile ( int x, int y, int tilenum )\fC [virtual]\fR" -Sets the tile at (\fIx\fR, \fIy\fR) to use tile number \fItilenum\fR, which is an index into the tile pixmaps. The canvas will update appropriately when update() is next called. -.PP -The images are taken from the pixmap set by setTiles() and are arranged left to right, (and in the case of pixmaps that have multiple rows of tiles, top to bottom), with tile 0 in the top-left corner, tile 1 next to the right, and so on, e.g. -.PP -
            .nf -.TS -l - l. 0 1 2 3 4 5 6 -.TE -.fi -
            -.PP -See also tile() and setTiles(). -.SH "void QCanvas::setTiles ( QPixmap p, int h, int v, int tilewidth, int tileheight )\fC [virtual]\fR" -Sets the QCanvas to be composed of \fIh\fR tiles horizontally and \fIv\fR tiles vertically. Each tile will be an image \fItilewidth\fR by \fItileheight\fR pixels from pixmap \fIp\fR. -.PP -The pixmap \fIp\fR is a list of tiles, arranged left to right, (and in the case of pixmaps that have multiple rows of tiles, top to bottom), with tile 0 in the top-left corner, tile 1 next to the right, and so on, e.g. -.PP -
            .nf -.TS -l - l. 0 1 2 3 4 5 6 -.TE -.fi -
            -.PP -If the canvas is larger than the matrix of tiles, the entire matrix is repeated as necessary to cover the whole canvas. If it is smaller, tiles to the right and bottom are not visible. -.PP -The width and height of \fIp\fR must be a multiple of \fItilewidth\fR and \fItileheight\fR. If they are not the function will do nothing. -.PP -If you want to unset any tiling set, then just pass in a null pixmap and 0 for \fIh\fR, \fIv\fR, \fItilewidth\fR, and \fItileheight\fR. -.SH "void QCanvas::setUnchanged ( const QRect & area )\fC [virtual]\fR" -Marks \fIarea\fR as \fIunchanged\fR. The area will \fInot\fR be redrawn in the views for the next update(), unless it is marked or changed again before the next call to update(). -.SH "void QCanvas::setUpdatePeriod ( int ms )\fC [virtual]\fR" -Sets the canvas to call update() every \fIms\fR milliseconds. Any previous setting by setAdvancePeriod() or setUpdatePeriod() is overridden. -.PP -If \fIms\fR is less than 0 automatic updating will be stopped. -.SH "QSize QCanvas::size () const" -Returns the size of the canvas, in pixels. -.SH "int QCanvas::tile ( int x, int y ) const" -Returns the tile at position (\fIx\fR, \fIy\fR). Initially, all tiles are 0. -.PP -The parameters must be within range, i.e. 0 < \fIx\fR < tilesHorizontally() and 0 < \fIy\fR < tilesVertically(). -.PP -See also setTile(). -.SH "int QCanvas::tileHeight () const" -Returns the height of each tile. -.SH "int QCanvas::tileWidth () const" -Returns the width of each tile. -.SH "int QCanvas::tilesHorizontally () const" -Returns the number of tiles horizontally. -.SH "int QCanvas::tilesVertically () const" -Returns the number of tiles vertically. -.SH "void QCanvas::update ()\fC [virtual slot]\fR" -Repaints changed areas in all views of the canvas. -.PP -See also advance(). -.SH "bool QCanvas::validChunk ( int x, int y ) const" -Returns TRUE if the chunk position (\fIx\fR, \fIy\fR) is on the canvas; otherwise returns FALSE. -.PP -See also onCanvas(). -.SH "bool QCanvas::validChunk ( const QPoint & p ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the chunk position \fIp\fR is on the canvas; otherwise returns FALSE. -.PP -See also onCanvas(). -.SH "int QCanvas::width () const" -Returns the width of the canvas, in pixels. -.PP -Example: canvas/canvas.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcanvas.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvas.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvasellipse.3qt b/doc/man/man3/qcanvasellipse.3qt deleted file mode 100644 index d98a30690..000000000 --- a/doc/man/man3/qcanvasellipse.3qt +++ /dev/null @@ -1,145 +0,0 @@ -'\" t -.TH QCanvasEllipse 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 -QCanvasEllipse \- Ellipse or ellipse segment on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasPolygonalItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasEllipse\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "\fBQCanvasEllipse\fR ( int width, int height, QCanvas * canvas )" -.br -.ti -1c -.BI "\fBQCanvasEllipse\fR ( int width, int height, int startangle, int angle, QCanvas * canvas )" -.br -.ti -1c -.BI "\fB~QCanvasEllipse\fR ()" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "void \fBsetSize\fR ( int width, int height )" -.br -.ti -1c -.BI "void \fBsetAngles\fR ( int start, int length )" -.br -.ti -1c -.BI "int \fBangleStart\fR () const" -.br -.ti -1c -.BI "int \fBangleLength\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawShape\fR ( QPainter & p )" -.br -.in -1c -.SH DESCRIPTION -The QCanvasEllipse class provides an ellipse or ellipse segment on a QCanvas. -.PP -A canvas item that paints an ellipse or ellipse segment with a QBrush. The ellipse's height, width, start angle and angle length can be set at construction time. The size can be changed at runtime with setSize(), and the angles can be changed (if you're displaying an ellipse segment rather than a whole ellipse) with setAngles(). -.PP -Note that angles are specified in 16ths of a degree. -.PP -
            -.ce 1 -.B "[Image Omitted]" -.PP -
            -.PP -If a start angle and length angle are set then an ellipse segment will be drawn. The start angle is the angle that goes from zero in a counter-clockwise direction (shown in green in the diagram). The length angle is the angle from the start angle in a counter-clockwise direction (shown in blue in the diagram). The blue segment is the segment of the ellipse that would be drawn. If no start angle and length angle are specified the entire ellipse is drawn. -.PP -The ellipse can be drawn on a painter with drawShape(). -.PP -Like any other canvas item ellipses can be moved with move() and moveBy(), or by setting coordinates with setX(), setY() and setZ(). -.PP -Note: QCanvasEllipse does not use the pen. -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasEllipse::QCanvasEllipse ( QCanvas * canvas )" -Constructs a 32x32 ellipse, centered at (0, 0) on \fIcanvas\fR. -.SH "QCanvasEllipse::QCanvasEllipse ( int width, int height, QCanvas * canvas )" -Constructs a \fIwidth\fR by \fIheight\fR pixel ellipse, centered at (0, 0) on \fIcanvas\fR. -.SH "QCanvasEllipse::QCanvasEllipse ( int width, int height, int startangle, int angle, QCanvas * canvas )" -Constructs a \fIwidth\fR by \fIheight\fR pixel ellipse, centered at (0, 0) on \fIcanvas\fR. Only a segment of the ellipse is drawn, starting at angle \fIstartangle\fR, and extending for angle \fIangle\fR (the angle length). -.PP -Note that angles are specified in 1/16ths of a degree. -.SH "QCanvasEllipse::~QCanvasEllipse ()" -Destroys the ellipse. -.SH "int QCanvasEllipse::angleLength () const" -Returns the length angle (the extent of the ellipse segment) in 16ths of a degree. Initially this will be 360 * 16 (a complete ellipse). -.PP -See also setAngles() and angleStart(). -.SH "int QCanvasEllipse::angleStart () const" -Returns the start angle in 16ths of a degree. Initially this will be 0. -.PP -See also setAngles() and angleLength(). -.SH "void QCanvasEllipse::drawShape ( QPainter & p )\fC [virtual protected]\fR" -Draws the ellipse, centered at x(), y() using the painter \fIp\fR. -.PP -Note that QCanvasEllipse does not support an outline (the pen is always NoPen). -.PP -Reimplemented from QCanvasPolygonalItem. -.SH "int QCanvasEllipse::height () const" -Returns the height of the ellipse. -.SH "int QCanvasEllipse::rtti () const\fC [virtual]\fR" -Returns 6 (QCanvasItem::Rtti_Ellipse). -.PP -See also QCanvasItem::rtti(). -.PP -Reimplemented from QCanvasPolygonalItem. -.SH "void QCanvasEllipse::setAngles ( int start, int length )" -Sets the angles for the ellipse. The start angle is \fIstart\fR and the extent of the segment is \fIlength\fR (the angle length) from the \fIstart\fR. The angles are specified in 16ths of a degree. By default the ellipse will start at 0 and have an angle length of 360 * 16 (a complete ellipse). -.PP -See also angleStart() and angleLength(). -.SH "void QCanvasEllipse::setSize ( int width, int height )" -Sets the \fIwidth\fR and \fIheight\fR of the ellipse. -.SH "int QCanvasEllipse::width () const" -Returns the width of the ellipse. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvasellipse.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvasellipse.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvasitem.3qt b/doc/man/man3/qcanvasitem.3qt deleted file mode 100644 index 082fee942..000000000 --- a/doc/man/man3/qcanvasitem.3qt +++ /dev/null @@ -1,426 +0,0 @@ -'\" t -.TH QCanvasItem 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 -QCanvasItem \- Abstract graphic object on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -Inherited by QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasItem\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "virtual \fB~QCanvasItem\fR ()" -.br -.ti -1c -.BI "double \fBx\fR () const" -.br -.ti -1c -.BI "double \fBy\fR () const" -.br -.ti -1c -.BI "double \fBz\fR () const" -.br -.ti -1c -.BI "virtual void \fBmoveBy\fR ( double dx, double dy )" -.br -.ti -1c -.BI "void \fBmove\fR ( double x, double y )" -.br -.ti -1c -.BI "void \fBsetX\fR ( double x )" -.br -.ti -1c -.BI "void \fBsetY\fR ( double y )" -.br -.ti -1c -.BI "void \fBsetZ\fR ( double z )" -.br -.ti -1c -.BI "bool \fBanimated\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAnimated\fR ( bool y )" -.br -.ti -1c -.BI "virtual void \fBsetVelocity\fR ( double vx, double vy )" -.br -.ti -1c -.BI "void \fBsetXVelocity\fR ( double vx )" -.br -.ti -1c -.BI "void \fBsetYVelocity\fR ( double vy )" -.br -.ti -1c -.BI "double \fBxVelocity\fR () const" -.br -.ti -1c -.BI "double \fByVelocity\fR () const" -.br -.ti -1c -.BI "virtual void \fBadvance\fR ( int phase )" -.br -.ti -1c -.BI "virtual bool \fBcollidesWith\fR ( const QCanvasItem * other ) const = 0" -.br -.ti -1c -.BI "QCanvasItemList \fBcollisions\fR ( bool exact ) const" -.br -.ti -1c -.BI "virtual void \fBsetCanvas\fR ( QCanvas * c )" -.br -.ti -1c -.BI "virtual void \fBdraw\fR ( QPainter & painter ) = 0" -.br -.ti -1c -.BI "void \fBshow\fR ()" -.br -.ti -1c -.BI "void \fBhide\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetVisible\fR ( bool yes )" -.br -.ti -1c -.BI "bool \fBisVisible\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSelected\fR ( bool yes )" -.br -.ti -1c -.BI "bool \fBisSelected\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetEnabled\fR ( bool yes )" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetActive\fR ( bool yes )" -.br -.ti -1c -.BI "bool \fBisActive\fR () const" -.br -.ti -1c -.BI "bool visible () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool selected () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool enabled () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool active () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "enum \fBRttiValues\fR { Rtti_Item = 0, Rtti_Sprite = 1, Rtti_PolygonalItem = 2, Rtti_Text = 3, Rtti_Polygon = 4, Rtti_Rectangle = 5, Rtti_Ellipse = 6, Rtti_Line = 7, Rtti_Spline = 8 }" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.ti -1c -.BI "virtual QRect \fBboundingRect\fR () const = 0" -.br -.ti -1c -.BI "virtual QRect \fBboundingRectAdvanced\fR () const" -.br -.ti -1c -.BI "QCanvas * \fBcanvas\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBupdate\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QCanvasItem class provides an abstract graphic object on a QCanvas. -.PP -A variety of QCanvasItem subclasses provide immediately usable behaviour. This class is a pure abstract superclass providing the behaviour that is shared among all the concrete canvas item classes. QCanvasItem is not intended for direct subclassing. It is much easier to subclass one of its subclasses, e.g. QCanvasPolygonalItem (the commonest base class), QCanvasRectangle, QCanvasSprite, QCanvasEllipse or QCanvasText. -.PP -Canvas items are added to a canvas by constructing them and passing the canvas to the canvas item's constructor. An item can be moved to a different canvas using setCanvas(). -.PP -Items appear on the canvas after their show() function has been called (or setVisible(TRUE)), and \fIafter\fR update() has been called. The canvas only shows items that are visible, and then only if update() is called. If you created the canvas without passing a width and height to the constructor you'll also need to call resize(). Since the canvas background defaults to white and canvas items default to white, you may need to change colors to see your items. -.PP -A QCanvasItem object can be moved in the x(), y() and z() dimensions using functions such as move(), moveBy(), setX(), setY() and setZ(). A canvas item can be set in motion, `animated', using setAnimated() and given a velocity in the x and y directions with setXVelocity() and setYVelocity() -- the same effect can be achieved by calling setVelocity(). Use the collidesWith() function to see if the canvas item will collide on the \fInext\fR advance(1) and use collisions() to see what collisions have occurred. -.PP -Use QCanvasSprite or your own subclass of QCanvasSprite to create canvas items which are animated, i.e. which change over time. -.PP -The size of a canvas item is given by boundingRect(). Use boundingRectAdvanced() to see what the size of the canvas item will be \fIafter\fR the next advance(1) call. -.PP -The rtti() function is used for identifying subclasses of QCanvasItem. The canvas() function returns a pointer to the canvas which contains the canvas item. -.PP -QCanvasItem provides the show() and isVisible() functions like those in QWidget. -.PP -QCanvasItem also provides the setEnabled(), setActive() and setSelected() functions; these functions set the relevant boolean and cause a repaint but the boolean values they set are not used in QCanvasItem itself. You can make use of these booleans in your subclasses. -.PP -By default, canvas items have no velocity, no size, and are not in motion. The subclasses provided in Qt do not change these defaults except where noted. -.PP -See also Graphics Classes and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QCanvasItem::RttiValues" -This enum is used to name the different types of canvas item. -.TP -\fCQCanvasItem::Rtti_Item\fR - Canvas item abstract base class -.TP -\fCQCanvasItem::Rtti_Ellipse\fR -.TP -\fCQCanvasItem::Rtti_Line\fR -.TP -\fCQCanvasItem::Rtti_Polygon\fR -.TP -\fCQCanvasItem::Rtti_PolygonalItem\fR -.TP -\fCQCanvasItem::Rtti_Rectangle\fR -.TP -\fCQCanvasItem::Rtti_Spline\fR -.TP -\fCQCanvasItem::Rtti_Sprite\fR -.TP -\fCQCanvasItem::Rtti_Text\fR -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasItem::QCanvasItem ( QCanvas * canvas )" -Constructs a QCanvasItem on canvas \fIcanvas\fR. -.PP -See also setCanvas(). -.SH "QCanvasItem::~QCanvasItem ()\fC [virtual]\fR" -Destroys the QCanvasItem and removes it from its canvas. -.SH "bool QCanvasItem::active () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use isActive() instead. -.SH "void QCanvasItem::advance ( int phase )\fC [virtual]\fR" -The default implementation moves the canvas item, if it is animated(), by the preset velocity if \fIphase\fR is 1, and does nothing if \fIphase\fR is 0. -.PP -Note that if you reimplement this function, the reimplementation must not change the canvas in any way, for example it must not add or remove items. -.PP -See also QCanvas::advance() and setVelocity(). -.PP -Example: canvas/canvas.cpp. -.PP -Reimplemented in QCanvasSprite. -.SH "bool QCanvasItem::animated () const" -Returns TRUE if the canvas item is in motion; otherwise returns FALSE. -.PP -See also setVelocity() and setAnimated(). -.SH "QRect QCanvasItem::boundingRect () const\fC [pure virtual]\fR" -Returns the bounding rectangle in pixels that the canvas item covers. -.PP -See also boundingRectAdvanced(). -.PP -Reimplemented in QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. -.SH "QRect QCanvasItem::boundingRectAdvanced () const\fC [virtual]\fR" -Returns the bounding rectangle of pixels that the canvas item \fIwill\fR cover after advance(1) is called. -.PP -See also boundingRect(). -.SH "QCanvas * QCanvasItem::canvas () const" -Returns the canvas containing the canvas item. -.SH "bool QCanvasItem::collidesWith ( const QCanvasItem * other ) const\fC [pure virtual]\fR" -Returns TRUE if the canvas item will collide with the \fIother\fR item \fIafter\fR they have moved by their current velocities; otherwise returns FALSE. -.PP -See also collisions(). -.PP -Example: canvas/canvas.cpp. -.SH "QCanvasItemList QCanvasItem::collisions ( bool exact ) const" -Returns the list of canvas items that this canvas item has collided with. -.PP -A collision is generally defined as occurring when the pixels of one item draw on the pixels of another item, but not all subclasses are so precise. Also, since pixel-wise collision detection can be slow, this function works in either exact or inexact mode, according to the \fIexact\fR parameter. -.PP -If \fIexact\fR is TRUE, the canvas items returned have been accurately tested for collision with the canvas item. -.PP -If \fIexact\fR is FALSE, the canvas items returned are \fInear\fR the canvas item. You can test the canvas items returned using collidesWith() if any are interesting collision candidates. By using this approach, you can ignore some canvas items for which collisions are not relevant. -.PP -The returned list is a list of QCanvasItems, but often you will need to cast the items to their subclass types. The safe way to do this is to use rtti() before casting. This provides some of the functionality of the standard C++ dynamic cast operation even on compilers where dynamic casts are not available. -.PP -Note that a canvas item may be `on' a canvas, e.g. it was created with the canvas as parameter, even though its coordinates place it beyond the edge of the canvas's area. Collision detection only works for canvas items which are wholly or partly within the canvas's area. -.PP -Note that if items have a velocity (see setVelocity()), then collision testing is done based on where the item \fIwill\fR be when it moves, not its current location. For example, a "ball" item doesn't need to actually embed into a "wall" item before a collision is detected. For items without velocity, plain intersection is used. -.SH "void QCanvasItem::draw ( QPainter & painter )\fC [pure virtual]\fR" -This abstract virtual function draws the canvas item using \fIpainter\fR. -.PP -\fBWarning:\fR When you reimplement this function, make sure that you leave the painter in the same state as you found it. For example, if you start by calling QPainter::translate(50, 50), end your code by calling QPainter::translate(-50, -50). Be also aware that the painter might already have some transformations set (i.e., don't call QPainter::resetXForm() when you're done). -.PP -Reimplemented in QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. -.SH "bool QCanvasItem::enabled () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use isEnabled() instead. -.SH "void QCanvasItem::hide ()" -Shorthand for setVisible(FALSE). -.SH "bool QCanvasItem::isActive () const" -Returns TRUE if the QCanvasItem is active; otherwise returns FALSE. -.SH "bool QCanvasItem::isEnabled () const" -Returns TRUE if the QCanvasItem is enabled; otherwise returns FALSE. -.SH "bool QCanvasItem::isSelected () const" -Returns TRUE if the canvas item is selected; otherwise returns FALSE. -.SH "bool QCanvasItem::isVisible () const" -Returns TRUE if the canvas item is visible; otherwise returns FALSE. -.PP -Note that in this context TRUE does \fInot\fR mean that the canvas item is currently in a view, merely that if a view is showing the area where the canvas item is positioned, and the item is not obscured by items with higher z values, and the view is not obscured by overlaying windows, it would be visible. -.PP -See also setVisible() and z(). -.SH "void QCanvasItem::move ( double x, double y )" -Moves the canvas item to the absolute position (\fIx\fR, \fIy\fR). -.PP -Example: canvas/canvas.cpp. -.SH "void QCanvasItem::moveBy ( double dx, double dy )\fC [virtual]\fR" -Moves the canvas item relative to its current position by (\fIdx\fR, \fIdy\fR). -.PP -Example: canvas/canvas.cpp. -.SH "int QCanvasItem::rtti () const\fC [virtual]\fR" -Returns 0 (QCanvasItem::Rtti_Item). -.PP -Make your derived classes return their own values for rtti(), so that you can distinguish between objects returned by QCanvas::at(). You should use values greater than 1000 to allow for extensions to this class. -.PP -Overuse of this functionality can damage it's extensibility. For example, once you have identified a base class of a QCanvasItem found by QCanvas::at(), cast it to that type and call meaningful methods rather than acting upon the object based on its rtti value. -.PP -For example: -.PP -.nf -.br - QCanvasItem* item; -.br - // Find an item, e.g. with QCanvasItem::collisions(). -.br - ... -.br - if (item->rtti() == MySprite::RTTI ) { -.br - MySprite* s = (MySprite*)item; -.br - if (s->isDamagable()) s->loseHitPoints(1000); -.br - if (s->isHot()) myself->loseHitPoints(1000); -.br - ... -.br - } -.br -.fi -.PP -Example: canvas/canvas.cpp. -.PP -Reimplemented in QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. -.SH "bool QCanvasItem::selected () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use isSelected() instead. -.SH "void QCanvasItem::setActive ( bool yes )\fC [virtual]\fR" -Sets the active flag of the item to \fIyes\fR. If this changes the item's active state the item will be redrawn when QCanvas::update() is next called. -.PP -The QCanvas, QCanvasItem and the Qt-supplied QCanvasItem subclasses do not make use of this value. The setActive() function is supplied because many applications need it, but it is up to you how you use the isActive() value. -.SH "void QCanvasItem::setAnimated ( bool y )\fC [virtual]\fR" -Sets the canvas item to be in motion if \fIy\fR is TRUE, or not if \fIy\fR is FALSE. The speed and direction of the motion is set with setVelocity(), or with setXVelocity() and setYVelocity(). -.PP -See also advance() and QCanvas::advance(). -.SH "void QCanvasItem::setCanvas ( QCanvas * c )\fC [virtual]\fR" -Sets the QCanvas upon which the canvas item is to be drawn to \fIc\fR. -.PP -See also canvas(). -.SH "void QCanvasItem::setEnabled ( bool yes )\fC [virtual]\fR" -Sets the enabled flag of the item to \fIyes\fR. If this changes the item's enabled state the item will be redrawn when QCanvas::update() is next called. -.PP -The QCanvas, QCanvasItem and the Qt-supplied QCanvasItem subclasses do not make use of this value. The setEnabled() function is supplied because many applications need it, but it is up to you how you use the isEnabled() value. -.SH "void QCanvasItem::setSelected ( bool yes )\fC [virtual]\fR" -Sets the selected flag of the item to \fIyes\fR. If this changes the item's selected state the item will be redrawn when QCanvas::update() is next called. -.PP -The QCanvas, QCanvasItem and the Qt-supplied QCanvasItem subclasses do not make use of this value. The setSelected() function is supplied because many applications need it, but it is up to you how you use the isSelected() value. -.SH "void QCanvasItem::setVelocity ( double vx, double vy )\fC [virtual]\fR" -Sets the canvas item to be in motion, moving by \fIvx\fR and \fIvy\fR pixels in the horizontal and vertical directions respectively. -.PP -See also advance(), setXVelocity(), and setYVelocity(). -.SH "void QCanvasItem::setVisible ( bool yes )\fC [virtual]\fR" -Makes the canvas item visible if \fIyes\fR is TRUE, or invisible if \fIyes\fR is FALSE. The change takes effect when QCanvas::update() is next called. -.SH "void QCanvasItem::setX ( double x )" -Moves the canvas item so that its x-position is \fIx\fR. -.PP -See also x() and move(). -.PP -Example: chart/chartform_canvas.cpp. -.SH "void QCanvasItem::setXVelocity ( double vx )" -Sets the horizontal component of the canvas item's velocity to \fIvx\fR. -.PP -See also setYVelocity() and setVelocity(). -.SH "void QCanvasItem::setY ( double y )" -Moves the canvas item so that its y-position is \fIy\fR. -.PP -See also y() and move(). -.PP -Example: chart/chartform_canvas.cpp. -.SH "void QCanvasItem::setYVelocity ( double vy )" -Sets the vertical component of the canvas item's velocity to \fIvy\fR. -.PP -See also setXVelocity() and setVelocity(). -.SH "void QCanvasItem::setZ ( double z )" -Sets the z index of the canvas item to \fIz\fR. Higher-z items obscure (are in front of) lower-z items. -.PP -See also z() and move(). -.PP -Examples: -.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. -.SH "void QCanvasItem::show ()" -Shorthand for setVisible(TRUE). -.PP -Examples: -.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. -.SH "void QCanvasItem::update ()\fC [protected]\fR" -Call this function to repaint the canvas's changed chunks. -.SH "bool QCanvasItem::visible () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use isVisible() instead. -.SH "double QCanvasItem::x () const" -Returns the horizontal position of the canvas item. Note that subclasses often have an origin other than the top-left corner. -.PP -Example: canvas/canvas.cpp. -.SH "double QCanvasItem::xVelocity () const" -Returns the horizontal velocity component of the canvas item. -.SH "double QCanvasItem::y () const" -Returns the vertical position of the canvas item. Note that subclasses often have an origin other than the top-left corner. -.PP -Example: canvas/canvas.cpp. -.SH "double QCanvasItem::yVelocity () const" -Returns the vertical velocity component of the canvas item. -.SH "double QCanvasItem::z () const" -Returns the z index of the canvas item, which is used for visual -order: higher-z items obscure (are in front of) lower-z items. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvasitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvasitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvasitemlist.3qt b/doc/man/man3/qcanvasitemlist.3qt deleted file mode 100644 index 62f79fa36..000000000 --- a/doc/man/man3/qcanvasitemlist.3qt +++ /dev/null @@ -1,57 +0,0 @@ -'\" t -.TH QCanvasItemList 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 -QCanvasItemList \- List of QCanvasItems -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QValueList. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "QCanvasItemList \fBoperator+\fR ( const QCanvasItemList & l ) const" -.br -.in -1c -.SH DESCRIPTION -The QCanvasItemList class is a list of QCanvasItems. -.PP -QCanvasItemList is a QValueList of pointers to QCanvasItems. This class is used by some methods in QCanvas that need to return a list of canvas items. -.PP -The QValueList documentation describes how to use this list. -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasItemList QCanvasItemList::operator+ ( const QCanvasItemList & l ) const" -Returns the concatenation of this list and list \fIl\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvasitemlist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvasitemlist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvasline.3qt b/doc/man/man3/qcanvasline.3qt deleted file mode 100644 index 0e33d42ad..000000000 --- a/doc/man/man3/qcanvasline.3qt +++ /dev/null @@ -1,94 +0,0 @@ -'\" t -.TH QCanvasLine 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 -QCanvasLine \- Line on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasPolygonalItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasLine\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "\fB~QCanvasLine\fR ()" -.br -.ti -1c -.BI "void \fBsetPoints\fR ( int xa, int ya, int xb, int yb )" -.br -.ti -1c -.BI "QPoint \fBstartPoint\fR () const" -.br -.ti -1c -.BI "QPoint \fBendPoint\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QCanvasLine class provides a line on a QCanvas. -.PP -The line inherits functionality from QCanvasPolygonalItem, for example the setPen() function. The start and end points of the line are set with setPoints(). -.PP -Like any other canvas item lines can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasLine::QCanvasLine ( QCanvas * canvas )" -Constructs a line from (0,0) to (0,0) on \fIcanvas\fR. -.PP -See also setPoints(). -.SH "QCanvasLine::~QCanvasLine ()" -Destroys the line. -.SH "QPoint QCanvasLine::endPoint () const" -Returns the end point of the line. -.PP -See also setPoints() and startPoint(). -.SH "int QCanvasLine::rtti () const\fC [virtual]\fR" -Returns 7 (QCanvasItem::Rtti_Line). -.PP -See also QCanvasItem::rtti(). -.PP -Reimplemented from QCanvasPolygonalItem. -.SH "void QCanvasLine::setPoints ( int xa, int ya, int xb, int yb )" -Sets the line's start point to (\fIxa\fR, \fIya\fR) and its end point to (\fIxb\fR, \fIyb\fR). -.PP -Example: canvas/canvas.cpp. -.SH "QPoint QCanvasLine::startPoint () const" -Returns the start point of the line. -.PP -See also setPoints() and endPoint(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvasline.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvasline.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvaspixmap.3qt b/doc/man/man3/qcanvaspixmap.3qt deleted file mode 100644 index 8d9ca364f..000000000 --- a/doc/man/man3/qcanvaspixmap.3qt +++ /dev/null @@ -1,100 +0,0 @@ -'\" t -.TH QCanvasPixmap 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 -QCanvasPixmap \- Pixmaps for QCanvasSprites -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPixmap. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasPixmap\fR ( const QString & datafilename )" -.br -.ti -1c -.BI "\fBQCanvasPixmap\fR ( const QImage & image )" -.br -.ti -1c -.BI "\fBQCanvasPixmap\fR ( const QPixmap & pm, const QPoint & offset )" -.br -.ti -1c -.BI "\fB~QCanvasPixmap\fR ()" -.br -.ti -1c -.BI "int \fBoffsetX\fR () const" -.br -.ti -1c -.BI "int \fBoffsetY\fR () const" -.br -.ti -1c -.BI "void \fBsetOffset\fR ( int x, int y )" -.br -.in -1c -.SH DESCRIPTION -The QCanvasPixmap class provides pixmaps for QCanvasSprites. -.PP -If you want to show a single pixmap on a QCanvas use a QCanvasSprite with just one pixmap. -.PP -When pixmaps are inserted into a QCanvasPixmapArray they are held as QCanvasPixmaps. QCanvasSprites are used to show pixmaps on QCanvases and hold their pixmaps in a QCanvasPixmapArray. If you retrieve a frame (pixmap) from a QCanvasSprite it will be returned as a QCanvasPixmap. -.PP -The pixmap is a QPixmap and can only be set in the constructor. There are three different constructors, one taking a QPixmap, one a QImage and one a file name that refers to a file in any supported file format (see QImageIO). -.PP -QCanvasPixmap can have a hotspot which is defined in terms of an (x, y) offset. When you create a QCanvasPixmap from a PNG file or from a QImage that has a QImage::offset(), the offset() is initialized appropriately, otherwise the constructor leaves it at (0, 0). You can set it later using setOffset(). When the QCanvasPixmap is used in a QCanvasSprite, the offset position is the point at QCanvasItem::x() and QCanvasItem::y(), not the top-left corner of the pixmap. -.PP -Note that for QCanvasPixmap objects created by a QCanvasSprite, the position of each QCanvasPixmap object is set so that the hotspot stays in the same position. -.PP -See also QCanvasPixmapArray, QCanvasItem, QCanvasSprite, Graphics Classes, and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasPixmap::QCanvasPixmap ( const QString & datafilename )" -Constructs a QCanvasPixmap that uses the image stored in \fIdatafilename\fR. -.SH "QCanvasPixmap::QCanvasPixmap ( const QImage & image )" -Constructs a QCanvasPixmap from the image \fIimage\fR. -.SH "QCanvasPixmap::QCanvasPixmap ( const QPixmap & pm, const QPoint & offset )" -Constructs a QCanvasPixmap from the pixmap \fIpm\fR using the offset \fIoffset\fR. -.SH "QCanvasPixmap::~QCanvasPixmap ()" -Destroys the pixmap. -.SH "int QCanvasPixmap::offsetX () const" -Returns the x-offset of the pixmap's hotspot. -.PP -See also setOffset(). -.SH "int QCanvasPixmap::offsetY () const" -Returns the y-offset of the pixmap's hotspot. -.PP -See also setOffset(). -.SH "void QCanvasPixmap::setOffset ( int x, int y )" -Sets the offset of the pixmap's hotspot to (\fIx\fR, \fIy\fR). -.PP -\fBWarning:\fR Do not call this function if any QCanvasSprites are -currently showing this pixmap. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvaspixmap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvaspixmap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvaspixmaparray.3qt b/doc/man/man3/qcanvaspixmaparray.3qt deleted file mode 100644 index d14b485df..000000000 --- a/doc/man/man3/qcanvaspixmaparray.3qt +++ /dev/null @@ -1,156 +0,0 @@ -'\" t -.TH QCanvasPixmapArray 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 -QCanvasPixmapArray \- Array of QCanvasPixmaps -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasPixmapArray\fR ()" -.br -.ti -1c -.BI "\fBQCanvasPixmapArray\fR ( const QString & datafilenamepattern, int fc = 0 )" -.br -.ti -1c -.BI "QCanvasPixmapArray ( QPtrList list, QPtrList hotspots ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "\fBQCanvasPixmapArray\fR ( QValueList list, QPointArray hotspots = QPointArray ( ) )" -.br -.ti -1c -.BI "\fB~QCanvasPixmapArray\fR ()" -.br -.ti -1c -.BI "bool \fBreadPixmaps\fR ( const QString & filenamepattern, int fc = 0 )" -.br -.ti -1c -.BI "bool \fBreadCollisionMasks\fR ( const QString & filename )" -.br -.ti -1c -.BI "bool operator! () \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "QCanvasPixmap * \fBimage\fR ( int i ) const" -.br -.ti -1c -.BI "void \fBsetImage\fR ( int i, QCanvasPixmap * p )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QCanvasPixmapArray class provides an array of QCanvasPixmaps. -.PP -This class is used by QCanvasSprite to hold an array of pixmaps. It is used to implement animated sprites, i.e. images that change over time, with each pixmap in the array holding one frame. -.PP -Depending on the constructor you use you can load multiple pixmaps into the array either from a directory (specifying a wildcard pattern for the files), or from a list of QPixmaps. You can also read in a set of pixmaps after construction using readPixmaps(). -.PP -Individual pixmaps can be set with setImage() and retrieved with image(). The number of pixmaps in the array is returned by count(). -.PP -QCanvasSprite uses an image's mask for collision detection. You can change this by reading in a separate set of image masks using readCollisionMasks(). -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasPixmapArray::QCanvasPixmapArray ()" -Constructs an invalid array (i.e. isValid() will return FALSE). You must call readPixmaps() before being able to use this QCanvasPixmapArray. -.SH "QCanvasPixmapArray::QCanvasPixmapArray ( const QString & datafilenamepattern, int fc = 0 )" -Constructs a QCanvasPixmapArray from files. -.PP -The \fIfc\fR parameter sets the number of frames to be loaded for this image. -.PP -If \fIfc\fR is not 0, \fIdatafilenamepattern\fR should contain "%1", e.g. "foo%1.png". The actual filenames are formed by replacing the %1 with four-digit integers from 0 to (fc - 1), e.g. foo0000.png, foo0001.png, foo0002.png, etc. -.PP -If \fIfc\fR is 0, \fIdatafilenamepattern\fR is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame. -.PP -If \fIdatafilenamepattern\fR does not exist, is not readable, isn't an image, or some other error occurs, the array ends up empty and isValid() returns FALSE. -.SH "QCanvasPixmapArray::QCanvasPixmapArray ( QPtrList list, QPtrList hotspots )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use QCanvasPixmapArray::QCanvasPixmapArray( QValueList, QPointArray ) instead. -.PP -Constructs a QCanvasPixmapArray from the list of QPixmaps \fIlist\fR. The \fIhotspots\fR list has to be of the same size as \fIlist\fR. -.SH "QCanvasPixmapArray::QCanvasPixmapArray ( QValueList list, QPointArray hotspots = QPointArray ( ) )" -Constructs a QCanvasPixmapArray from the list of QPixmaps in the \fIlist\fR. Each pixmap will get a hotspot according to the \fIhotspots\fR array. If no hotspots are specified, each one is set to be at position (0, 0). -.PP -If an error occurs, isValid() will return FALSE. -.SH "QCanvasPixmapArray::~QCanvasPixmapArray ()" -Destroys the pixmap array and all the pixmaps it contains. -.SH "uint QCanvasPixmapArray::count () const" -Returns the number of pixmaps in the array. -.SH "QCanvasPixmap * QCanvasPixmapArray::image ( int i ) const" -Returns pixmap \fIi\fR in the array, if \fIi\fR is non-negative and less than than count(), and returns an unspecified value otherwise. -.SH "bool QCanvasPixmapArray::isValid () const" -Returns TRUE if the pixmap array is valid; otherwise returns FALSE. -.SH "bool QCanvasPixmapArray::operator! ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use isValid() instead. -.PP -This returns FALSE if the array is valid, and TRUE if it is not. -.SH "bool QCanvasPixmapArray::readCollisionMasks ( const QString & filename )" -Reads new collision masks for the array. -.PP -By default, QCanvasSprite uses the image mask of a sprite to detect collisions. Use this function to set your own collision image masks. -.PP -If count() is 1 \fIfilename\fR must specify a real filename to read the mask from. If count() is greater than 1, the \fIfilename\fR must contain a "%1" that will get replaced by the number of the mask to be loaded, just like QCanvasPixmapArray::readPixmaps(). -.PP -All collision masks must be 1-bit images or this function call will fail. -.PP -If the file isn't readable, contains the wrong number of images, or there is some other error, this function will return FALSE, and the array will be flagged as invalid; otherwise this function returns TRUE. -.PP -See also isValid(). -.SH "bool QCanvasPixmapArray::readPixmaps ( const QString & filenamepattern, int fc = 0 )" -Reads one or more pixmaps into the pixmap array. -.PP -If \fIfc\fR is not 0, \fIfilenamepattern\fR should contain "%1", e.g." foo%1.png". The actual filenames are formed by replacing the %1 with four-digit integers from 0 to (fc - 1), e.g. foo0000.png, foo0001.png, foo0002.png, etc. -.PP -If \fIfc\fR is 0, \fIfilenamepattern\fR is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame. -.PP -If \fIfilenamepattern\fR does not exist, is not readable, isn't an image, or some other error occurs, this function will return FALSE, and isValid() will return FALSE; otherwise this function will return TRUE. -.PP -See also isValid(). -.SH "void QCanvasPixmapArray::setImage ( int i, QCanvasPixmap * p )" -Replaces the pixmap at index \fIi\fR with pixmap \fIp\fR. -.PP -The array takes ownership of \fIp\fR and will delete \fIp\fR when the array itself is deleted. -.PP -If \fIi\fR is beyond the end of the array the array is extended to at -least i+1 elements, with elements count() to i-1 being initialized -to 0. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvaspixmaparray.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvaspixmaparray.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvaspolygon.3qt b/doc/man/man3/qcanvaspolygon.3qt deleted file mode 100644 index 88bc51700..000000000 --- a/doc/man/man3/qcanvaspolygon.3qt +++ /dev/null @@ -1,114 +0,0 @@ -'\" t -.TH QCanvasPolygon 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 -QCanvasPolygon \- Polygon on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasPolygonalItem. -.PP -Inherited by QCanvasSpline. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasPolygon\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "\fB~QCanvasPolygon\fR ()" -.br -.ti -1c -.BI "void \fBsetPoints\fR ( QPointArray pa )" -.br -.ti -1c -.BI "QPointArray \fBpoints\fR () const" -.br -.ti -1c -.BI "virtual QPointArray \fBareaPoints\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawShape\fR ( QPainter & p )" -.br -.in -1c -.SH DESCRIPTION -The QCanvasPolygon class provides a polygon on a QCanvas. -.PP -Paints a polygon with a QBrush. The polygon's points can be set in the constructor or set or changed later using setPoints(). Use points() to retrieve the points, or areaPoints() to retrieve the points relative to the canvas's origin. -.PP -The polygon can be drawn on a painter with drawShape(). -.PP -Like any other canvas item polygons can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). -.PP -Note: QCanvasPolygon does not use the pen. -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasPolygon::QCanvasPolygon ( QCanvas * canvas )" -Constructs a point-less polygon on the canvas \fIcanvas\fR. You should call setPoints() before using it further. -.SH "QCanvasPolygon::~QCanvasPolygon ()" -Destroys the polygon. -.SH "QPointArray QCanvasPolygon::areaPoints () const\fC [virtual]\fR" -Returns the vertices of the polygon translated by the polygon's current x(), y() position, i.e. relative to the canvas's origin. -.PP -See also setPoints() and points(). -.PP -Reimplemented from QCanvasPolygonalItem. -.SH "void QCanvasPolygon::drawShape ( QPainter & p )\fC [virtual protected]\fR" -Draws the polygon using the painter \fIp\fR. -.PP -Note that QCanvasPolygon does not support an outline (the pen is always NoPen). -.PP -Reimplemented from QCanvasPolygonalItem. -.SH "QPointArray QCanvasPolygon::points () const" -Returns the vertices of the polygon, not translated by the position. -.PP -See also setPoints() and areaPoints(). -.SH "int QCanvasPolygon::rtti () const\fC [virtual]\fR" -Returns 4 (QCanvasItem::Rtti_Polygon). -.PP -See also QCanvasItem::rtti(). -.PP -Reimplemented from QCanvasPolygonalItem. -.PP -Reimplemented in QCanvasSpline. -.SH "void QCanvasPolygon::setPoints ( QPointArray pa )" -Sets the points of the polygon to be \fIpa\fR. These points will have -their x and y coordinates automatically translated by x(), y() as -the polygon is moved. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvaspolygon.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvaspolygon.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvaspolygonalitem.3qt b/doc/man/man3/qcanvaspolygonalitem.3qt deleted file mode 100644 index 0ce0fc976..000000000 --- a/doc/man/man3/qcanvaspolygonalitem.3qt +++ /dev/null @@ -1,193 +0,0 @@ -'\" t -.TH QCanvasPolygonalItem 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 -QCanvasPolygonalItem \- Polygonal canvas item on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasItem. -.PP -Inherited by QCanvasRectangle, QCanvasPolygon, QCanvasLine, and QCanvasEllipse. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasPolygonalItem\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "virtual \fB~QCanvasPolygonalItem\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetPen\fR ( QPen p )" -.br -.ti -1c -.BI "virtual void \fBsetBrush\fR ( QBrush b )" -.br -.ti -1c -.BI "QPen \fBpen\fR () const" -.br -.ti -1c -.BI "QBrush \fBbrush\fR () const" -.br -.ti -1c -.BI "virtual QPointArray \fBareaPoints\fR () const = 0" -.br -.ti -1c -.BI "virtual QPointArray \fBareaPointsAdvanced\fR () const" -.br -.ti -1c -.BI "virtual QRect \fBboundingRect\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdraw\fR ( QPainter & p )" -.br -.ti -1c -.BI "virtual void \fBdrawShape\fR ( QPainter & p ) = 0" -.br -.ti -1c -.BI "bool \fBwinding\fR () const" -.br -.ti -1c -.BI "void \fBsetWinding\fR ( bool enable )" -.br -.ti -1c -.BI "void \fBinvalidate\fR ()" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QCanvasPolygonalItem class provides a polygonal canvas item on a QCanvas. -.PP -The mostly rectangular classes, such as QCanvasSprite and QCanvasText, use the object's bounding rectangle for movement, repainting and collision calculations. For most other items, the bounding rectangle can be far too large -- a diagonal line being the worst case, and there are many other cases which are also bad. QCanvasPolygonalItem provides polygon-based bounding rectangle handling, etc., which is much faster for non-rectangular items. -.PP -Derived classes should try to define as small an area as possible to maximize efficiency, but the polygon must \fIdefinitely\fR be contained completely within the polygonal area. Calculating the exact requirements is usually difficult, but if you allow a small overestimate it can be easy and quick, while still getting almost all of QCanvasPolygonalItem's speed. -.PP -Note that all subclasses \fImust\fR call hide() in their destructor since hide() needs to be able to access areaPoints(). -.PP -Normally, QCanvasPolygonalItem uses the odd-even algorithm for determining whether an object intersects this object. You can change this to the winding algorithm using setWinding(). -.PP -The bounding rectangle is available using boundingRect(). The points bounding the polygonal item are retrieved with areaPoints(). Use areaPointsAdvanced() to retrieve the bounding points the polygonal item \fIwill\fR have after QCanvasItem::advance(1) has been called. -.PP -If the shape of the polygonal item is about to change while the item is visible, call invalidate() before updating with a different result from areaPoints(). -.PP -By default, QCanvasPolygonalItem objects have a black pen and no brush (the default QPen and QBrush constructors). You can change this with setPen() and setBrush(), but note that some QCanvasPolygonalItem subclasses only use the brush, ignoring the pen setting. -.PP -The polygonal item can be drawn on a painter with draw(). Subclasses must reimplement drawShape() to draw themselves. -.PP -Like any other canvas item polygonal items can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasPolygonalItem::QCanvasPolygonalItem ( QCanvas * canvas )" -Constructs a QCanvasPolygonalItem on the canvas \fIcanvas\fR. -.SH "QCanvasPolygonalItem::~QCanvasPolygonalItem ()\fC [virtual]\fR" -Note that all subclasses \fImust\fR call hide() in their destructor since hide() needs to be able to access areaPoints(). -.SH "QPointArray QCanvasPolygonalItem::areaPoints () const\fC [pure virtual]\fR" -This function must be reimplemented by subclasses. It \fImust\fR return the points bounding (i.e. outside and not touching) the shape or drawing errors will occur. -.PP -Reimplemented in QCanvasPolygon. -.SH "QPointArray QCanvasPolygonalItem::areaPointsAdvanced () const\fC [virtual]\fR" -Returns the points the polygonal item \fIwill\fR have after QCanvasItem::advance(1) is called, i.e. what the points are when advanced by the current xVelocity() and yVelocity(). -.SH "QRect QCanvasPolygonalItem::boundingRect () const\fC [virtual]\fR" -Returns the bounding rectangle of the polygonal item, based on areaPoints(). -.PP -Reimplemented from QCanvasItem. -.SH "QBrush QCanvasPolygonalItem::brush () const" -Returns the QBrush used to fill the item, if filled. -.PP -See also setBrush(). -.SH "void QCanvasPolygonalItem::draw ( QPainter & p )\fC [virtual protected]\fR" -Reimplemented from QCanvasItem, this draws the polygonal item by setting the pen and brush for the item on the painter \fIp\fR and calling drawShape(). -.PP -Reimplemented from QCanvasItem. -.SH "void QCanvasPolygonalItem::drawShape ( QPainter & p )\fC [pure virtual protected]\fR" -Subclasses must reimplement this function to draw their shape. The pen and brush of \fIp\fR are already set to pen() and brush() prior to calling this function. -.PP -\fBWarning:\fR When you reimplement this function, make sure that you leave the painter in the same state as you found it. For example, if you start by calling QPainter::translate(50, 50), end your code by calling QPainter::translate(-50, -50). Be also aware that the painter might already have some transformations set (i.e., don't call QPainter::resetXForm() when you're done). -.PP -See also draw(). -.PP -Reimplemented in QCanvasRectangle, QCanvasPolygon, and QCanvasEllipse. -.SH "void QCanvasPolygonalItem::invalidate ()\fC [protected]\fR" -Invalidates all information about the area covered by the canvas item. The item will be updated automatically on the next call that changes the item's status, for example, move() or update(). Call this function if you are going to change the shape of the item (as returned by areaPoints()) while the item is visible. -.SH "bool QCanvasPolygonalItem::isValid () const\fC [protected]\fR" -Returns TRUE if the polygonal item's area information has not been invalidated; otherwise returns FALSE. -.PP -See also invalidate(). -.SH "QPen QCanvasPolygonalItem::pen () const" -Returns the QPen used to draw the outline of the item, if any. -.PP -See also setPen(). -.SH "int QCanvasPolygonalItem::rtti () const\fC [virtual]\fR" -Returns 2 (QCanvasItem::Rtti_PolygonalItem). -.PP -See also QCanvasItem::rtti(). -.PP -Reimplemented from QCanvasItem. -.PP -Reimplemented in QCanvasRectangle, QCanvasPolygon, QCanvasLine, and QCanvasEllipse. -.SH "void QCanvasPolygonalItem::setBrush ( QBrush b )\fC [virtual]\fR" -Sets the QBrush used when drawing the polygonal item to the brush \fIb\fR. -.PP -See also setPen(), brush(), and drawShape(). -.PP -Examples: -.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. -.SH "void QCanvasPolygonalItem::setPen ( QPen p )\fC [virtual]\fR" -Sets the QPen used when drawing the item to the pen \fIp\fR. Note that many QCanvasPolygonalItems do not use the pen value. -.PP -See also setBrush(), pen(), and drawShape(). -.PP -Examples: -.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. -.SH "void QCanvasPolygonalItem::setWinding ( bool enable )\fC [protected]\fR" -If \fIenable\fR is TRUE, the polygonal item will use the winding algorithm to determine the "inside" of the polygon; otherwise the odd-even algorithm will be used. -.PP -The default is to use the odd-even algorithm. -.PP -See also winding(). -.SH "bool QCanvasPolygonalItem::winding () const\fC [protected]\fR" -Returns TRUE if the polygonal item uses the winding algorithm to determine the "inside" of the polygon. Returns FALSE if it uses the odd-even algorithm. -.PP -The default is to use the odd-even algorithm. -.PP -See also setWinding(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvaspolygonalitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvaspolygonalitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvasrectangle.3qt b/doc/man/man3/qcanvasrectangle.3qt deleted file mode 100644 index dd37ab3f5..000000000 --- a/doc/man/man3/qcanvasrectangle.3qt +++ /dev/null @@ -1,129 +0,0 @@ -'\" t -.TH QCanvasRectangle 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 -QCanvasRectangle \- Rectangle on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasPolygonalItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasRectangle\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "\fBQCanvasRectangle\fR ( const QRect & r, QCanvas * canvas )" -.br -.ti -1c -.BI "\fBQCanvasRectangle\fR ( int x, int y, int width, int height, QCanvas * canvas )" -.br -.ti -1c -.BI "\fB~QCanvasRectangle\fR ()" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "void \fBsetSize\fR ( int width, int height )" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawShape\fR ( QPainter & p )" -.br -.ti -1c -.BI "virtual QPointArray \fBchunks\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QCanvasRectangle class provides a rectangle on a QCanvas. -.PP -This item paints a single rectangle which may have any pen() and brush(), but may not be tilted/rotated. For rotated rectangles, use QCanvasPolygon. -.PP -The rectangle's size and initial position can be set in the constructor. The size can be set or changed later using setSize(). Use height() and width() to retrieve the rectangle's dimensions. -.PP -The rectangle can be drawn on a painter with drawShape(). -.PP -Like any other canvas item rectangles can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasRectangle::QCanvasRectangle ( QCanvas * canvas )" -Constructs a rectangle at position (0,0) with both width and height set to 32 pixels on \fIcanvas\fR. -.SH "QCanvasRectangle::QCanvasRectangle ( const QRect & r, QCanvas * canvas )" -Constructs a rectangle positioned and sized by \fIr\fR on \fIcanvas\fR. -.SH "QCanvasRectangle::QCanvasRectangle ( int x, int y, int width, int height, QCanvas * canvas )" -Constructs a rectangle at position (\fIx\fR, \fIy\fR) and size \fIwidth\fR by \fIheight\fR, on \fIcanvas\fR. -.SH "QCanvasRectangle::~QCanvasRectangle ()" -Destroys the rectangle. -.SH "QPointArray QCanvasRectangle::chunks () const\fC [virtual protected]\fR" -Simply calls QCanvasItem::chunks(). -.SH "void QCanvasRectangle::drawShape ( QPainter & p )\fC [virtual protected]\fR" -Draws the rectangle on painter \fIp\fR. -.PP -Example: canvas/canvas.cpp. -.PP -Reimplemented from QCanvasPolygonalItem. -.SH "int QCanvasRectangle::height () const" -Returns the height of the rectangle. -.SH "QRect QCanvasRectangle::rect () const" -Returns the integer-converted x(), y() position and size() of the rectangle as a QRect. -.SH "int QCanvasRectangle::rtti () const\fC [virtual]\fR" -Returns 5 (QCanvasItem::Rtti_Rectangle). -.PP -See also QCanvasItem::rtti(). -.PP -Reimplemented from QCanvasPolygonalItem. -.SH "void QCanvasRectangle::setSize ( int width, int height )" -Sets the \fIwidth\fR and \fIheight\fR of the rectangle. -.SH "QSize QCanvasRectangle::size () const" -Returns the width() and height() of the rectangle. -.PP -See also rect() and setSize(). -.SH "int QCanvasRectangle::width () const" -Returns the width of the rectangle. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvasrectangle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvasrectangle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvasspline.3qt b/doc/man/man3/qcanvasspline.3qt deleted file mode 100644 index 89f375a42..000000000 --- a/doc/man/man3/qcanvasspline.3qt +++ /dev/null @@ -1,102 +0,0 @@ -'\" t -.TH QCanvasSpline 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 -QCanvasSpline \- Multi-bezier splines on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasPolygon. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasSpline\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "\fB~QCanvasSpline\fR ()" -.br -.ti -1c -.BI "void \fBsetControlPoints\fR ( QPointArray ctrl, bool close = TRUE )" -.br -.ti -1c -.BI "QPointArray \fBcontrolPoints\fR () const" -.br -.ti -1c -.BI "bool \fBclosed\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QCanvasSpline class provides multi-bezier splines on a QCanvas. -.PP -A QCanvasSpline is a sequence of 4-point bezier curves joined together to make a curved shape. -.PP -You set the control points of the spline with setControlPoints(). -.PP -If the bezier is closed(), then the first control point will be re-used as the last control point. Therefore, a closed bezier must have a multiple of 3 control points and an open bezier must have one extra point. -.PP -The beziers are not necessarily joined "smoothly". To ensure this, set control points appropriately (general reference texts about beziers will explain this in detail). -.PP -Like any other canvas item splines can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasSpline::QCanvasSpline ( QCanvas * canvas )" -Create a spline with no control points on the canvas \fIcanvas\fR. -.PP -See also setControlPoints(). -.SH "QCanvasSpline::~QCanvasSpline ()" -Destroy the spline. -.SH "bool QCanvasSpline::closed () const" -Returns TRUE if the control points are a closed set; otherwise returns FALSE. -.SH "QPointArray QCanvasSpline::controlPoints () const" -Returns the current set of control points. -.PP -See also setControlPoints() and closed(). -.SH "int QCanvasSpline::rtti () const\fC [virtual]\fR" -Returns 8 (QCanvasItem::Rtti_Spline). -.PP -See also QCanvasItem::rtti(). -.PP -Reimplemented from QCanvasPolygon. -.SH "void QCanvasSpline::setControlPoints ( QPointArray ctrl, bool close = TRUE )" -Set the spline control points to \fIctrl\fR. -.PP -If \fIclose\fR is TRUE, then the first point in \fIctrl\fR will be re-used as the last point, and the number of control points must be a multiple of 3. If \fIclose\fR is FALSE, one additional control point is required, and the number of control points must be one of (4, 7, 10, 13, ...). -.PP -If the number of control points doesn't meet the above conditions, the number of points will be truncated to the largest number of points that do meet the requirement. -.PP -Example: canvas/canvas.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvasspline.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvasspline.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvassprite.3qt b/doc/man/man3/qcanvassprite.3qt deleted file mode 100644 index 5f69d3703..000000000 --- a/doc/man/man3/qcanvassprite.3qt +++ /dev/null @@ -1,263 +0,0 @@ -'\" t -.TH QCanvasSprite 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 -QCanvasSprite \- Animated canvas item on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasSprite\fR ( QCanvasPixmapArray * a, QCanvas * canvas )" -.br -.ti -1c -.BI "void \fBsetSequence\fR ( QCanvasPixmapArray * a )" -.br -.ti -1c -.BI "virtual \fB~QCanvasSprite\fR ()" -.br -.ti -1c -.BI "virtual void \fBmove\fR ( double nx, double ny, int nf )" -.br -.ti -1c -.BI "void \fBsetFrame\fR ( int f )" -.br -.ti -1c -.BI "enum \fBFrameAnimationType\fR { Cycle, Oscillate }" -.br -.ti -1c -.BI "virtual void \fBsetFrameAnimation\fR ( FrameAnimationType type = Cycle, int step = 1, int state = 0 )" -.br -.ti -1c -.BI "int \fBframe\fR () const" -.br -.ti -1c -.BI "int \fBframeCount\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.ti -1c -.BI "virtual QRect \fBboundingRect\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "int \fBleftEdge\fR () const" -.br -.ti -1c -.BI "int \fBtopEdge\fR () const" -.br -.ti -1c -.BI "int \fBrightEdge\fR () const" -.br -.ti -1c -.BI "int \fBbottomEdge\fR () const" -.br -.ti -1c -.BI "int \fBleftEdge\fR ( int nx ) const" -.br -.ti -1c -.BI "int \fBtopEdge\fR ( int ny ) const" -.br -.ti -1c -.BI "int \fBrightEdge\fR ( int nx ) const" -.br -.ti -1c -.BI "int \fBbottomEdge\fR ( int ny ) const" -.br -.ti -1c -.BI "QCanvasPixmap * \fBimage\fR () const" -.br -.ti -1c -.BI "virtual QCanvasPixmap * \fBimageAdvanced\fR () const" -.br -.ti -1c -.BI "QCanvasPixmap * \fBimage\fR ( int f ) const" -.br -.ti -1c -.BI "virtual void \fBadvance\fR ( int phase )" -.br -.ti -1c -.BI "virtual void \fBdraw\fR ( QPainter & painter )" -.br -.in -1c -.SH DESCRIPTION -The QCanvasSprite class provides an animated canvas item on a QCanvas. -.PP -A canvas sprite is an object which can contain any number of images (referred to as frames), only one of which is current, i.e. displayed, at any one time. The images can be passed in the constructor or set or changed later with setSequence(). If you subclass QCanvasSprite you can change the frame that is displayed periodically, e.g. whenever QCanvasItem::advance(1) is called to create the effect of animation. -.PP -The current frame can be set with setFrame() or with move(). The number of frames available is given by frameCount(). The bounding rectangle of the current frame is returned by boundingRect(). -.PP -The current frame's image can be retrieved with image(); use imageAdvanced() to retrieve the image for the frame that will be shown after advance(1) is called. Use the image() overload passing it an integer index to retrieve a particular image from the list of frames. -.PP -Use width() and height() to retrieve the dimensions of the current frame. -.PP -Use leftEdge() and rightEdge() to retrieve the current frame's left-hand and right-hand x-coordinates respectively. Use bottomEdge() and topEdge() to retrieve the current frame's bottom and top y-coordinates respectively. These functions have an overload which will accept an integer frame number to retrieve the coordinates of a particular frame. -.PP -QCanvasSprite draws very quickly, at the expense of memory. -.PP -The current frame's image can be drawn on a painter with draw(). -.PP -Like any other canvas item, canvas sprites can be moved with move() which sets the x and y coordinates and the frame number, as well as with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). -.PP -See also Graphics Classes and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QCanvasSprite::FrameAnimationType" -This enum is used to identify the different types of frame animation offered by QCanvasSprite. -.TP -\fCQCanvasSprite::Cycle\fR - at each advance the frame number will be incremented by 1 (modulo the frame count). -.TP -\fCQCanvasSprite::Oscillate\fR - at each advance the frame number will be incremented by 1 up to the frame count then decremented to by 1 to 0, repeating this sequence forever. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasSprite::QCanvasSprite ( QCanvasPixmapArray * a, QCanvas * canvas )" -Constructs a QCanvasSprite which uses images from the QCanvasPixmapArray \fIa\fR. -.PP -The sprite in initially positioned at (0, 0) on \fIcanvas\fR, using frame 0. -.SH "QCanvasSprite::~QCanvasSprite ()\fC [virtual]\fR" -Destroys the sprite and removes it from the canvas. Does \fInot\fR delete the images. -.SH "void QCanvasSprite::advance ( int phase )\fC [virtual]\fR" -Extends the default QCanvasItem implementation to provide the functionality of setFrameAnimation(). -.PP -The \fIphase\fR is 0 or 1: see QCanvasItem::advance() for details. -.PP -See also QCanvasItem::advance() and setVelocity(). -.PP -Example: canvas/canvas.cpp. -.PP -Reimplemented from QCanvasItem. -.SH "int QCanvasSprite::bottomEdge () const" -Returns the y-coordinate of the current bottom edge of the sprite. (This may change as the sprite animates since different frames may have different bottom edges.) -.PP -See also leftEdge(), rightEdge(), and topEdge(). -.SH "int QCanvasSprite::bottomEdge ( int ny ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns what the y-coordinate of the top edge of the sprite would be if the sprite (actually its hotspot) were moved to y-position \fIny\fR. -.PP -See also leftEdge(), rightEdge(), and topEdge(). -.SH "QRect QCanvasSprite::boundingRect () const\fC [virtual]\fR" -Returns the bounding rectangle for the image in the sprite's current frame. This assumes that the images are tightly cropped (i.e. do not have transparent pixels all along a side). -.PP -Reimplemented from QCanvasItem. -.SH "void QCanvasSprite::draw ( QPainter & painter )\fC [virtual]\fR" -Draws the current frame's image at the sprite's current position on painter \fIpainter\fR. -.PP -Reimplemented from QCanvasItem. -.SH "int QCanvasSprite::frame () const" -Returns the index of the current animation frame in the QCanvasSprite's QCanvasPixmapArray. -.PP -See also setFrame() and move(). -.SH "int QCanvasSprite::frameCount () const" -Returns the number of frames in the QCanvasSprite's QCanvasPixmapArray. -.SH "int QCanvasSprite::height () const" -The height of the sprite for the current frame's image. -.PP -See also frame(). -.SH "QCanvasPixmap * QCanvasSprite::image () const" -Returns the current frame's image. -.PP -See also frame() and setFrame(). -.SH "QCanvasPixmap * QCanvasSprite::image ( int f ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the image for frame \fIf\fR. Does not do any bounds checking on \fIf\fR. -.SH "QCanvasPixmap * QCanvasSprite::imageAdvanced () const\fC [virtual]\fR" -Returns the image the sprite \fIwill\fR have after advance(1) is called. By default this is the same as image(). -.SH "int QCanvasSprite::leftEdge () const" -Returns the x-coordinate of the current left edge of the sprite. (This may change as the sprite animates since different frames may have different left edges.) -.PP -See also rightEdge(), bottomEdge(), and topEdge(). -.SH "int QCanvasSprite::leftEdge ( int nx ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns what the x-coordinate of the left edge of the sprite would be if the sprite (actually its hotspot) were moved to x-position \fInx\fR. -.PP -See also rightEdge(), bottomEdge(), and topEdge(). -.SH "void QCanvasSprite::move ( double nx, double ny, int nf )\fC [virtual]\fR" -Set the position of the sprite to \fInx\fR, \fIny\fR and the current frame to \fInf\fR. \fInf\fR will be ignored if it is larger than frameCount() or smaller than 0. -.SH "int QCanvasSprite::rightEdge () const" -Returns the x-coordinate of the current right edge of the sprite. (This may change as the sprite animates since different frames may have different right edges.) -.PP -See also leftEdge(), bottomEdge(), and topEdge(). -.SH "int QCanvasSprite::rightEdge ( int nx ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns what the x-coordinate of the right edge of the sprite would be if the sprite (actually its hotspot) were moved to x-position \fInx\fR. -.PP -See also leftEdge(), bottomEdge(), and topEdge(). -.SH "int QCanvasSprite::rtti () const\fC [virtual]\fR" -Returns 1 (QCanvasItem::Rtti_Sprite). -.PP -See also QCanvasItem::rtti(). -.PP -Example: canvas/canvas.cpp. -.PP -Reimplemented from QCanvasItem. -.SH "void QCanvasSprite::setFrame ( int f )" -Sets the animation frame used for displaying the sprite to \fIf\fR, an index into the QCanvasSprite's QCanvasPixmapArray. The call will be ignored if \fIf\fR is larger than frameCount() or smaller than 0. -.PP -See also frame() and move(). -.SH "void QCanvasSprite::setFrameAnimation ( FrameAnimationType type = Cycle, int step = 1, int state = 0 )\fC [virtual]\fR" -Sets the animation characteristics for the sprite. -.PP -For \fItype\fR == Cycle, the frames will increase by \fIstep\fR at each advance, modulo the frameCount(). -.PP -For \fItype\fR == Oscillate, the frames will increase by \fIstep\fR at each advance, up to the frameCount(), then decrease by \fIstep\fR back to 0, repeating forever. -.PP -The \fIstate\fR parameter is for internal use. -.SH "void QCanvasSprite::setSequence ( QCanvasPixmapArray * a )" -Set the array of images used for displaying the sprite to the QCanvasPixmapArray \fIa\fR. -.PP -If the current frame() is larger than the number of images in \fIa\fR, the current frame will be reset to 0. -.SH "int QCanvasSprite::topEdge () const" -Returns the y-coordinate of the top edge of the sprite. (This may change as the sprite animates since different frames may have different top edges.) -.PP -See also leftEdge(), rightEdge(), and bottomEdge(). -.SH "int QCanvasSprite::topEdge ( int ny ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns what the y-coordinate of the top edge of the sprite would be if the sprite (actually its hotspot) were moved to y-position \fIny\fR. -.PP -See also leftEdge(), rightEdge(), and bottomEdge(). -.SH "int QCanvasSprite::width () const" -The width of the sprite for the current frame's image. -.PP -See also frame(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvassprite.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvassprite.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvastext.3qt b/doc/man/man3/qcanvastext.3qt deleted file mode 100644 index bfb835c9e..000000000 --- a/doc/man/man3/qcanvastext.3qt +++ /dev/null @@ -1,160 +0,0 @@ -'\" t -.TH QCanvasText 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 -QCanvasText \- Text object on a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCanvasItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasText\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "\fBQCanvasText\fR ( const QString & t, QCanvas * canvas )" -.br -.ti -1c -.BI "\fBQCanvasText\fR ( const QString & t, QFont f, QCanvas * canvas )" -.br -.ti -1c -.BI "virtual \fB~QCanvasText\fR ()" -.br -.ti -1c -.BI "void \fBsetText\fR ( const QString & t )" -.br -.ti -1c -.BI "void \fBsetFont\fR ( const QFont & f )" -.br -.ti -1c -.BI "void \fBsetColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "QFont \fBfont\fR () const" -.br -.ti -1c -.BI "QColor \fBcolor\fR () const" -.br -.ti -1c -.BI "int \fBtextFlags\fR () const" -.br -.ti -1c -.BI "void \fBsetTextFlags\fR ( int f )" -.br -.ti -1c -.BI "virtual QRect \fBboundingRect\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdraw\fR ( QPainter & painter )" -.br -.in -1c -.SH DESCRIPTION -The QCanvasText class provides a text object on a QCanvas. -.PP -A canvas text item has text with font, color and alignment attributes. The text and font can be set in the constructor or set or changed later with setText() and setFont(). The color is set with setColor() and the alignment with setTextFlags(). The text item's bounding rectangle is retrieved with boundingRect(). -.PP -The text can be drawn on a painter with draw(). -.PP -Like any other canvas item text items can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasText::QCanvasText ( QCanvas * canvas )" -Constructs a QCanvasText with the text "", on \fIcanvas\fR. -.SH "QCanvasText::QCanvasText ( const QString & t, QCanvas * canvas )" -Constructs a QCanvasText with the text \fIt\fR, on canvas \fIcanvas\fR. -.SH "QCanvasText::QCanvasText ( const QString & t, QFont f, QCanvas * canvas )" -Constructs a QCanvasText with the text \fIt\fR and font \fIf\fR, on the canvas \fIcanvas\fR. -.SH "QCanvasText::~QCanvasText ()\fC [virtual]\fR" -Destroys the canvas text item. -.SH "QRect QCanvasText::boundingRect () const\fC [virtual]\fR" -Returns the bounding rectangle of the text. -.PP -Reimplemented from QCanvasItem. -.SH "QColor QCanvasText::color () const" -Returns the color of the text. -.PP -See also setColor(). -.SH "void QCanvasText::draw ( QPainter & painter )\fC [virtual protected]\fR" -Draws the text using the painter \fIpainter\fR. -.PP -Reimplemented from QCanvasItem. -.SH "QFont QCanvasText::font () const" -Returns the font in which the text is drawn. -.PP -See also setFont(). -.SH "int QCanvasText::rtti () const\fC [virtual]\fR" -Returns 3 (QCanvasItem::Rtti_Text). -.PP -See also QCanvasItem::rtti(). -.PP -Reimplemented from QCanvasItem. -.SH "void QCanvasText::setColor ( const QColor & c )" -Sets the color of the text to the color \fIc\fR. -.PP -See also color() and setFont(). -.PP -Example: chart/chartform_canvas.cpp. -.SH "void QCanvasText::setFont ( const QFont & f )" -Sets the font in which the text is drawn to font \fIf\fR. -.PP -See also font(). -.SH "void QCanvasText::setText ( const QString & t )" -Sets the text item's text to \fIt\fR. The text may contain newlines. -.PP -See also text(), setFont(), setColor(), and setTextFlags(). -.PP -Example: canvas/canvas.cpp. -.SH "void QCanvasText::setTextFlags ( int f )" -Sets the alignment flags to \fIf\fR. These are a bitwise OR of the flags available to QPainter::drawText() -- see the Qt::AlignmentFlags. -.PP -See also setFont() and setColor(). -.SH "QString QCanvasText::text () const" -Returns the text item's text. -.PP -See also setText(). -.SH "int QCanvasText::textFlags () const" -Returns the currently set alignment flags. -.PP -See also setTextFlags() and Qt::AlignmentFlags. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvastext.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvastext.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcanvasview.3qt b/doc/man/man3/qcanvasview.3qt deleted file mode 100644 index fb8580f4d..000000000 --- a/doc/man/man3/qcanvasview.3qt +++ /dev/null @@ -1,188 +0,0 @@ -'\" t -.TH QCanvasView 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 -QCanvasView \- On-screen view of a QCanvas -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QScrollView. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCanvasView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQCanvasView\fR ( QCanvas * canvas, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QCanvasView\fR ()" -.br -.ti -1c -.BI "QCanvas * \fBcanvas\fR () const" -.br -.ti -1c -.BI "void \fBsetCanvas\fR ( QCanvas * canvas )" -.br -.ti -1c -.BI "const QWMatrix & \fBworldMatrix\fR () const" -.br -.ti -1c -.BI "const QWMatrix & \fBinverseWorldMatrix\fR () const" -.br -.ti -1c -.BI "bool \fBsetWorldMatrix\fR ( const QWMatrix & wm )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * p, int cx, int cy, int cw, int ch )" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QCanvasView class provides an on-screen view of a QCanvas. -.PP -A QCanvasView is widget which provides a view of a QCanvas. -.PP -If you want users to be able to interact with a canvas view, subclass QCanvasView. You might then reimplement QScrollView::contentsMousePressEvent(). For example, assuming no transformation matrix is set: -.PP -.nf -.br - void MyCanvasView::contentsMousePressEvent( QMouseEvent* e ) -.br - { -.br - QCanvasItemList l = canvas()->collisions(e->pos()); -.br - for (QCanvasItemList::Iterator it=l.begin(); it!=l.end(); ++it) { -.br - if ( (*it)->rtti() == QCanvasRectangle::RTTI ) -.br - tqDebug("A QCanvasRectangle lies somewhere at this point"); -.br - } -.br - } -.br -.fi -.PP -The canvas view shows canvas canvas(); this can be changed using setCanvas(). -.PP -A transformation matrix can be used to transform the view of the canvas in various ways, for example, zooming in or out or rotating. For example: -.PP -.nf -.br - QWMatrix wm; -.br - wm.scale( 2, 2 ); // Zooms in by 2 times -.br - wm.rotate( 90 ); // Rotates 90 degrees counter clockwise -.br - // around the origin. -.br - wm.translate( 0, -canvas->height() ); -.br - // moves the canvas down so what was visible -.br - // before is still visible. -.br - myCanvasView->setWorldMatrix( wm ); -.br -.fi -.PP -Use setWorldMatrix() to set the canvas view's world matrix: you must ensure that the world matrix is invertible. The current world matrix is retrievable with worldMatrix(), and its inversion is retrievable with inverseWorldMatrix(). -.PP -Example: -.PP -The following code finds the part of the canvas that is visible in this view, i.e. the bounding rectangle of the view in canvas coordinates. -.PP -.nf -.br - QRect rc = QRect( myCanvasView->contentsX(), myCanvasView->contentsY(), -.br - myCanvasView->visibleWidth(), myCanvasView->visibleHeight() ); -.br - QRect canvasRect = myCanvasView->inverseWorldMatrix().mapRect(rc); -.br -.fi -.PP -See also QWMatrix, QPainter::setWorldMatrix(), Graphics Classes, and Image Processing Classes. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCanvasView::QCanvasView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a QCanvasView with parent \fIparent\fR, and name \fIname\fR, using the widget flags \fIf\fR. The canvas view is not associated with a canvas, so you must to call setCanvas() to view a canvas. -.SH "QCanvasView::QCanvasView ( QCanvas * canvas, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a QCanvasView which views canvas \fIcanvas\fR, with parent \fIparent\fR, and name \fIname\fR, using the widget flags \fIf\fR. -.SH "QCanvasView::~QCanvasView ()" -Destroys the canvas view. The associated canvas is \fInot\fR deleted. -.SH "QCanvas * QCanvasView::canvas () const" -Returns a pointer to the canvas which the QCanvasView is currently showing. -.SH "void QCanvasView::drawContents ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" -Repaints part of the QCanvas that the canvas view is showing starting at \fIcx\fR by \fIcy\fR, with a width of \fIcw\fR and a height of \fIch\fR using the painter \fIp\fR. -.PP -\fBWarning:\fR When double buffering is enabled, drawContents() will not respect the current settings of the painter when setting up the painter for the double buffer (e.g., viewport() and window()). Also, be aware that QCanvas::update() bypasses drawContents(), which means any reimplementation of drawContents() is not called. -.PP -See also QCanvas::setDoubleBuffering(). -.PP -Reimplemented from QScrollView. -.SH "const QWMatrix & QCanvasView::inverseWorldMatrix () const" -Returns a reference to the inverse of the canvas view's current transformation matrix. -.PP -See also setWorldMatrix() and worldMatrix(). -.SH "void QCanvasView::setCanvas ( QCanvas * canvas )" -Sets the canvas that the QCanvasView is showing to the canvas \fIcanvas\fR. -.SH "bool QCanvasView::setWorldMatrix ( const QWMatrix & wm )" -Sets the transformation matrix of the QCanvasView to \fIwm\fR. The matrix must be invertible (i.e. if you create a world matrix that zooms out by 2 times, then the inverse of this matrix is one that will zoom in by 2 times). -.PP -When you use this, you should note that the performance of the QCanvasView will decrease considerably. -.PP -Returns FALSE if \fIwm\fR is not invertable; otherwise returns TRUE. -.PP -See also worldMatrix(), inverseWorldMatrix(), and QWMatrix::isInvertible(). -.PP -Example: canvas/canvas.cpp. -.SH "QSize QCanvasView::sizeHint () const\fC [virtual protected]\fR" -Suggests a size sufficient to view the entire canvas. -.SH "const QWMatrix & QCanvasView::worldMatrix () const" -Returns a reference to the canvas view's current transformation matrix. -.PP -See also setWorldMatrix() and inverseWorldMatrix(). -.PP -Example: canvas/canvas.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcanvasview.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcanvasview.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcdestyle.3qt b/doc/man/man3/qcdestyle.3qt deleted file mode 100644 index aa01be12d..000000000 --- a/doc/man/man3/qcdestyle.3qt +++ /dev/null @@ -1,64 +0,0 @@ -'\" t -.TH QCDEStyle 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 -QCDEStyle \- CDE look and feel -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QMotifStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCDEStyle\fR ( bool useHighlightCols = FALSE )" -.br -.ti -1c -.BI "virtual \fB~QCDEStyle\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QCDEStyle class provides a CDE look and feel. -.PP -This style provides a slightly improved Motif look similar to some versions of the Common Desktop Environment (CDE). The main differences are thinner frames and more modern radio buttons and checkboxes. Together with a dark background and a bright text/foreground color, the style looks quite attractive (at least for Motif fans). -.PP -Note that the functions provided by QCDEStyle are reimplementations of QStyle functions; see QStyle for their documentation. -.PP -See also Widget Appearance and Style. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCDEStyle::QCDEStyle ( bool useHighlightCols = FALSE )" -Constructs a QCDEStyle. -.PP -If \fIuseHighlightCols\fR is FALSE (the default), then the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. -.SH "QCDEStyle::~QCDEStyle ()\fC [virtual]\fR" -Destroys the style. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcdestyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcdestyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qchar.3qt b/doc/man/man3/qchar.3qt deleted file mode 100644 index 779c8de12..000000000 --- a/doc/man/man3/qchar.3qt +++ /dev/null @@ -1,490 +0,0 @@ -'\" t -.TH QChar 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 -QChar \- Lightweight Unicode character -.SH SYNOPSIS -Almost all the functions in this class are reentrant when Qt is built with thread support. The exception is \fBdecomposition\fR().

            -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQChar\fR ()" -.br -.ti -1c -.BI "\fBQChar\fR ( char c )" -.br -.ti -1c -.BI "\fBQChar\fR ( uchar c )" -.br -.ti -1c -.BI "\fBQChar\fR ( uchar c, uchar r )" -.br -.ti -1c -.BI "\fBQChar\fR ( const QChar & c )" -.br -.ti -1c -.BI "\fBQChar\fR ( ushort rc )" -.br -.ti -1c -.BI "\fBQChar\fR ( short rc )" -.br -.ti -1c -.BI "\fBQChar\fR ( uint rc )" -.br -.ti -1c -.BI "\fBQChar\fR ( int rc )" -.br -.ti -1c -.BI "enum \fBCategory\fR { NoCategory, Mark_NonSpacing, Mark_SpacingCombining, Mark_Enclosing, Number_DecimalDigit, Number_Letter, Number_Other, Separator_Space, Separator_Line, Separator_Paragraph, Other_Control, Other_Format, Other_Surrogate, Other_PrivateUse, Other_NotAssigned, Letter_Uppercase, Letter_Lowercase, Letter_Titlecase, Letter_Modifier, Letter_Other, Punctuation_Connector, Punctuation_Dash, Punctuation_Dask = Punctuation_Dash, Punctuation_Open, Punctuation_Close, Punctuation_InitialQuote, Punctuation_FinalQuote, Punctuation_Other, Symbol_Math, Symbol_Currency, Symbol_Modifier, Symbol_Other }" -.br -.ti -1c -.BI "enum \fBDirection\fR { DirL, DirR, DirEN, DirES, DirET, DirAN, DirCS, DirB, DirS, DirWS, DirON, DirLRE, DirLRO, DirAL, DirRLE, DirRLO, DirPDF, DirNSM, DirBN }" -.br -.ti -1c -.BI "enum \fBDecomposition\fR { Single, Canonical, Font, NoBreak, Initial, Medial, Final, Isolated, Circle, Super, Sub, Vertical, Wide, Narrow, Small, Square, Compat, Fraction }" -.br -.ti -1c -.BI "enum \fBJoining\fR { OtherJoining, Dual, Right, Center }" -.br -.ti -1c -.BI "enum \fBCombiningClass\fR { Combining_BelowLeftAttached = 200, Combining_BelowAttached = 202, Combining_BelowRightAttached = 204, Combining_LeftAttached = 208, Combining_RightAttached = 210, Combining_AboveLeftAttached = 212, Combining_AboveAttached = 214, Combining_AboveRightAttached = 216, Combining_BelowLeft = 218, Combining_Below = 220, Combining_BelowRight = 222, Combining_Left = 224, Combining_Right = 226, Combining_AboveLeft = 228, Combining_Above = 230, Combining_AboveRight = 232, Combining_DoubleBelow = 233, Combining_DoubleAbove = 234, Combining_IotaSubscript = 240 }" -.br -.ti -1c -.BI "int \fBdigitValue\fR () const" -.br -.ti -1c -.BI "QChar \fBlower\fR () const" -.br -.ti -1c -.BI "QChar \fBupper\fR () const" -.br -.ti -1c -.BI "Category \fBcategory\fR () const" -.br -.ti -1c -.BI "Direction \fBdirection\fR () const" -.br -.ti -1c -.BI "Joining \fBjoining\fR () const" -.br -.ti -1c -.BI "bool \fBmirrored\fR () const" -.br -.ti -1c -.BI "QChar \fBmirroredChar\fR () const" -.br -.ti -1c -.BI "const QString & \fBdecomposition\fR () const" -.br -.ti -1c -.BI "Decomposition \fBdecompositionTag\fR () const" -.br -.ti -1c -.BI "unsigned char \fBcombiningClass\fR () const" -.br -.ti -1c -.BI "char \fBlatin1\fR () const" -.br -.ti -1c -.BI "ushort \fBunicode\fR () const" -.br -.ti -1c -.BI "ushort & \fBunicode\fR ()" -.br -.ti -1c -.BI "\fBoperator char\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisPrint\fR () const" -.br -.ti -1c -.BI "bool \fBisPunct\fR () const" -.br -.ti -1c -.BI "bool \fBisSpace\fR () const" -.br -.ti -1c -.BI "bool \fBisMark\fR () const" -.br -.ti -1c -.BI "bool \fBisLetter\fR () const" -.br -.ti -1c -.BI "bool \fBisNumber\fR () const" -.br -.ti -1c -.BI "bool \fBisLetterOrNumber\fR () const" -.br -.ti -1c -.BI "bool \fBisDigit\fR () const" -.br -.ti -1c -.BI "bool \fBisSymbol\fR () const" -.br -.ti -1c -.BI "uchar \fBcell\fR () const" -.br -.ti -1c -.BI "uchar \fBrow\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool networkOrdered () \fI(obsolete)\fR" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "bool \fBoperator==\fR ( QChar c1, QChar c2 )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( char ch, QChar c )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( QChar c, char ch )" -.br -.ti -1c -.BI "int \fBoperator!=\fR ( QChar c1, QChar c2 )" -.br -.ti -1c -.BI "int \fBoperator!=\fR ( char ch, QChar c )" -.br -.ti -1c -.BI "int \fBoperator!=\fR ( QChar c, char ch )" -.br -.ti -1c -.BI "int \fBoperator<=\fR ( QChar c1, QChar c2 )" -.br -.ti -1c -.BI "int \fBoperator<=\fR ( QChar c, char ch )" -.br -.ti -1c -.BI "int \fBoperator<=\fR ( char ch, QChar c )" -.br -.ti -1c -.BI "int \fBoperator>=\fR ( QChar c1, QChar c2 )" -.br -.ti -1c -.BI "int \fBoperator>=\fR ( QChar c, char ch )" -.br -.ti -1c -.BI "int \fBoperator>=\fR ( char ch, QChar c )" -.br -.ti -1c -.BI "int \fBoperator<\fR ( QChar c1, QChar c2 )" -.br -.ti -1c -.BI "int \fBoperator<\fR ( QChar c, char ch )" -.br -.ti -1c -.BI "int \fBoperator<\fR ( char ch, QChar c )" -.br -.ti -1c -.BI "int \fBoperator>\fR ( QChar c1, QChar c2 )" -.br -.ti -1c -.BI "int \fBoperator>\fR ( QChar c, char ch )" -.br -.ti -1c -.BI "int \fBoperator>\fR ( char ch, QChar c )" -.br -.in -1c -.SH DESCRIPTION -The QChar class provides a lightweight Unicode character. -.PP -Unicode characters are (so far) 16-bit entities without any markup or structure. This class represents such an entity. It is lightweight, so it can be used everywhere. Most compilers treat it like a "short int". (In a few years it may be necessary to make QChar 32-bit when more than 65536 Unicode code points have been defined and come into use.) -.PP -QChar provides a full complement of testing/classification functions, converting to and from other formats, converting from composed to decomposed Unicode, and trying to compare and case-convert if you ask it to. -.PP -The classification functions include functions like those in ctype.h, but operating on the full range of Unicode characters. They all return TRUE if the character is a certain type of character; otherwise they return FALSE. These classification functions are isNull() (returns TRUE if the character is U+0000), isPrint() (TRUE if the character is any sort of printable character, including whitespace), isPunct() (any sort of punctation), isMark() (Unicode Mark), isLetter (a letter), isNumber() (any sort of numeric character), isLetterOrNumber(), and isDigit() (decimal digits). All of these are wrappers around category() which return the Unicode-defined category of each character. -.PP -QChar further provides direction(), which indicates the "natural" writing direction of this character. The joining() function indicates how the character joins with its neighbors (needed mostly for Arabic) and finally mirrored(), which indicates whether the character needs to be mirrored when it is printed in its" unnatural" writing direction. -.PP -Composed Unicode characters (like å) can be converted to decomposed Unicode ("a" followed by "ring above") by using decomposition(). -.PP -In Unicode, comparison is not necessarily possible and case conversion is very difficult at best. Unicode, covering the" entire" world, also includes most of the world's case and sorting problems. Qt tries, but not very hard: operator==() and friends will do comparison based purely on the numeric Unicode value (code point) of the characters, and upper() and lower() will do case changes when the character has a well-defined upper/lower-case equivalent. There is no provision for locale-dependent case folding rules or comparison; these functions are meant to be fast so they can be used unambiguously in data structures. (See QString::localeAwareCompare() though.) -.PP -The conversion functions include unicode() (to a scalar), latin1() (to scalar, but converts all non-Latin-1 characters to 0), row() (gives the Unicode row), cell() (gives the Unicode cell), digitValue() (gives the integer value of any of the numerous digit characters), and a host of constructors. -.PP -More information can be found in the document About Unicode. -.PP -See also QString, QCharRef, and Text Related Classes. -.SS "Member Type Documentation" -.SH "QChar::Category" -This enum maps the Unicode character categories. -.PP -The following characters are normative in Unicode: -.TP -\fCQChar::Mark_NonSpacing\fR - Unicode class name Mn -.TP -\fCQChar::Mark_SpacingCombining\fR - Unicode class name Mc -.TP -\fCQChar::Mark_Enclosing\fR - Unicode class name Me -.TP -\fCQChar::Number_DecimalDigit\fR - Unicode class name Nd -.TP -\fCQChar::Number_Letter\fR - Unicode class name Nl -.TP -\fCQChar::Number_Other\fR - Unicode class name No -.TP -\fCQChar::Separator_Space\fR - Unicode class name Zs -.TP -\fCQChar::Separator_Line\fR - Unicode class name Zl -.TP -\fCQChar::Separator_Paragraph\fR - Unicode class name Zp -.TP -\fCQChar::Other_Control\fR - Unicode class name Cc -.TP -\fCQChar::Other_Format\fR - Unicode class name Cf -.TP -\fCQChar::Other_Surrogate\fR - Unicode class name Cs -.TP -\fCQChar::Other_PrivateUse\fR - Unicode class name Co -.TP -\fCQChar::Other_NotAssigned\fR - Unicode class name Cn -.PP -The following categories are informative in Unicode: -.TP -\fCQChar::Letter_Uppercase\fR - Unicode class name Lu -.TP -\fCQChar::Letter_Lowercase\fR - Unicode class name Ll -.TP -\fCQChar::Letter_Titlecase\fR - Unicode class name Lt -.TP -\fCQChar::Letter_Modifier\fR - Unicode class name Lm -.TP -\fCQChar::Letter_Other\fR - Unicode class name Lo -.TP -\fCQChar::Punctuation_Connector\fR - Unicode class name Pc -.TP -\fCQChar::Punctuation_Dash\fR - Unicode class name Pd -.TP -\fCQChar::Punctuation_Open\fR - Unicode class name Ps -.TP -\fCQChar::Punctuation_Close\fR - Unicode class name Pe -.TP -\fCQChar::Punctuation_InitialQuote\fR - Unicode class name Pi -.TP -\fCQChar::Punctuation_FinalQuote\fR - Unicode class name Pf -.TP -\fCQChar::Punctuation_Other\fR - Unicode class name Po -.TP -\fCQChar::Symbol_Math\fR - Unicode class name Sm -.TP -\fCQChar::Symbol_Currency\fR - Unicode class name Sc -.TP -\fCQChar::Symbol_Modifier\fR - Unicode class name Sk -.TP -\fCQChar::Symbol_Other\fR - Unicode class name So -.PP -There are two categories that are specific to Qt: -.TP -\fCQChar::NoCategory\fR - used when Qt is dazed and confused and cannot make sense of anything. -.TP -\fCQChar::Punctuation_Dask\fR - old typo alias for Punctuation_Dash -.SH "QChar::CombiningClass" -This enum type defines names for some of the Unicode combining classes. See the Unicode Standard for a description of the values. -.SH "QChar::Decomposition" -This enum type defines the Unicode decomposition attributes. See the Unicode Standard for a description of the values. -.SH "QChar::Direction" -This enum type defines the Unicode direction attributes. See the Unicode Standard for a description of the values. -.PP -In order to conform to C/C++ naming conventions "Dir" is prepended to the codes used in the Unicode Standard. -.SH "QChar::Joining" -This enum type defines the Unicode joining attributes. See the Unicode Standard for a description of the values. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QChar::QChar ()" -Constructs a null QChar (one that isNull()). -.SH "QChar::QChar ( char c )" -Constructs a QChar corresponding to ASCII/Latin-1 character \fIc\fR. -.SH "QChar::QChar ( uchar c )" -Constructs a QChar corresponding to ASCII/Latin-1 character \fIc\fR. -.SH "QChar::QChar ( uchar c, uchar r )" -Constructs a QChar for Unicode cell \fIc\fR in row \fIr\fR. -.SH "QChar::QChar ( const QChar & c )" -Constructs a copy of \fIc\fR. This is a deep copy, if such a lightweight object can be said to have deep copies. -.SH "QChar::QChar ( ushort rc )" -Constructs a QChar for the character with Unicode code point \fIrc\fR. -.SH "QChar::QChar ( short rc )" -Constructs a QChar for the character with Unicode code point \fIrc\fR. -.SH "QChar::QChar ( uint rc )" -Constructs a QChar for the character with Unicode code point \fIrc\fR. -.SH "QChar::QChar ( int rc )" -Constructs a QChar for the character with Unicode code point \fIrc\fR. -.SH "Category QChar::category () const" -Returns the character category. -.PP -See also Category. -.SH "uchar QChar::cell () const" -Returns the cell (least significant byte) of the Unicode character. -.SH "unsigned char QChar::combiningClass () const" -Returns the combining class for the character as defined in the Unicode standard. This is mainly useful as a positioning hint for marks attached to a base character. -.PP -The Qt text rendering engine uses this information to correctly position non spacing marks around a base character. -.SH "const QString & QChar::decomposition () const" -\fBWarning:\fR This function is \fInot\fR reentrant.

            -.PP -Decomposes a character into its parts. Returns QString::null if no decomposition exists. -.SH "Decomposition QChar::decompositionTag () const" -Returns the tag defining the composition of the character. Returns QChar::Single if no decomposition exists. -.SH "int QChar::digitValue () const" -Returns the numeric value of the digit, or -1 if the character is not a digit. -.SH "Direction QChar::direction () const" -Returns the character's direction. -.PP -See also Direction. -.SH "bool QChar::isDigit () const" -Returns TRUE if the character is a decimal digit (Number_DecimalDigit); otherwise returns FALSE. -.SH "bool QChar::isLetter () const" -Returns TRUE if the character is a letter (Letter_* categories); otherwise returns FALSE. -.SH "bool QChar::isLetterOrNumber () const" -Returns TRUE if the character is a letter or number (Letter_* or Number_* categories); otherwise returns FALSE. -.SH "bool QChar::isMark () const" -Returns TRUE if the character is a mark (Mark_* categories); otherwise returns FALSE. -.SH "bool QChar::isNull () const" -Returns TRUE if the character is the Unicode character 0x0000 (ASCII NUL); otherwise returns FALSE. -.SH "bool QChar::isNumber () const" -Returns TRUE if the character is a number (of any sort - Number_* categories); otherwise returns FALSE. -.PP -See also isDigit(). -.SH "bool QChar::isPrint () const" -Returns TRUE if the character is a printable character; otherwise returns FALSE. This is any character not of category Cc or Cn. -.PP -Note that this gives no indication of whether the character is available in a particular font. -.SH "bool QChar::isPunct () const" -Returns TRUE if the character is a punctuation mark (Punctuation_* categories); otherwise returns FALSE. -.SH "bool QChar::isSpace () const" -Returns TRUE if the character is a separator character (Separator_* categories); otherwise returns FALSE. -.SH "bool QChar::isSymbol () const" -Returns TRUE if the character is a symbol (Symbol_* categories); otherwise returns FALSE. -.SH "Joining QChar::joining () const" -\fBWarning:\fR This function is not supported (it may change to use Unicode character classes). -.PP -Returns information about the joining properties of the character (needed for example, for Arabic). -.SH "char QChar::latin1 () const" -Returns the Latin-1 value of this character, or 0 if it cannot be represented in Latin-1. -.SH "QChar QChar::lower () const" -Returns the lowercase equivalent if the character is uppercase; otherwise returns the character itself. -.SH "bool QChar::mirrored () const" -Returns TRUE if the character is a mirrored character (one that should be reversed if the text direction is reversed); otherwise returns FALSE. -.SH "QChar QChar::mirroredChar () const" -Returns the mirrored character if this character is a mirrored character, otherwise returns the character itself. -.SH "bool QChar::networkOrdered ()\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if this character is in network byte order (MSB first); otherwise returns FALSE. This is platform dependent. -.SH "QChar::operator char () const" -Returns the Latin-1 character equivalent to the QChar, or 0. This is mainly useful for non-internationalized software. -.PP -See also unicode(). -.SH "uchar QChar::row () const" -Returns the row (most significant byte) of the Unicode character. -.SH "ushort QChar::unicode () const" -Returns the numeric Unicode value equal to the QChar. Normally, you should use QChar objects as they are equivalent, but for some low-level tasks (e.g. indexing into an array of Unicode information), this function is useful. -.SH "ushort & QChar::unicode ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a reference to the numeric Unicode value equal to the QChar. -.SH "QChar QChar::upper () const" -Returns the uppercase equivalent if the character is lowercase; otherwise returns the character itself. -.SH RELATED FUNCTION DOCUMENTATION -.SH "int operator!= ( QChar c1, QChar c2 )" -Returns TRUE if \fIc1\fR and \fIc2\fR are not the same Unicode character; otherwise returns FALSE. -.SH "int operator!= ( char ch, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIc\fR is not the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "int operator!= ( QChar c, char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIc\fR is not the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "int operator< ( QChar c1, QChar c2 )" -Returns TRUE if the numeric Unicode value of \fIc1\fR is less than that of \fIc2\fR; otherwise returns FALSE. -.SH "int operator< ( QChar c, char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of \fIc\fR is less than that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "int operator< ( char ch, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 character \fIch\fR is less than that of \fIc\fR; otherwise returns FALSE. -.SH "int operator<= ( QChar c1, QChar c2 )" -Returns TRUE if the numeric Unicode value of \fIc1\fR is less than that of \fIc2\fR, or they are the same Unicode character; otherwise returns FALSE. -.SH "int operator<= ( QChar c, char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of \fIc\fR is less than or equal to that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "int operator<= ( char ch, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 character \fIch\fR is less than or equal to that of \fIc\fR; otherwise returns FALSE. -.SH "bool operator== ( QChar c1, QChar c2 )" -Returns TRUE if \fIc1\fR and \fIc2\fR are the same Unicode character; otherwise returns FALSE. -.SH "bool operator== ( char ch, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIc\fR is the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "bool operator== ( QChar c, char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIc\fR is the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "int operator> ( QChar c1, QChar c2 )" -Returns TRUE if the numeric Unicode value of \fIc1\fR is greater than that of \fIc2\fR; otherwise returns FALSE. -.SH "int operator> ( QChar c, char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of \fIc\fR is greater than that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "int operator> ( char ch, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 character \fIch\fR is greater than that of \fIc\fR; otherwise returns FALSE. -.SH "int operator>= ( QChar c1, QChar c2 )" -Returns TRUE if the numeric Unicode value of \fIc1\fR is greater than that of \fIc2\fR, or they are the same Unicode character; otherwise returns FALSE. -.SH "int operator>= ( QChar c, char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of \fIc\fR is greater than or equal to that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. -.SH "int operator>= ( char ch, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 -character \fIch\fR is greater than or equal to that of \fIc\fR; -otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qchar.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qchar.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcharref.3qt b/doc/man/man3/qcharref.3qt deleted file mode 100644 index d4942b426..000000000 --- a/doc/man/man3/qcharref.3qt +++ /dev/null @@ -1,48 +0,0 @@ -'\" t -.TH QCharRef 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 -QCharRef \- Helper class for QString -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

            -.PP -\fC#include \fR -.PP -.SH DESCRIPTION -The QCharRef class is a helper class for QString. -.PP -When you get an object of type QCharRef, if you can assign to it, the assignment will apply to the character in the string from which you got the reference. That is its whole purpose in life. The QCharRef becomes invalid once modifications are made to the string: if you want to keep the character, copy it into a QChar. -.PP -Most of the QChar member functions also exist in QCharRef. However, they are not explicitly documented here. -.PP -See also QString::operator[](), QString::at(), QChar, and Text Related Classes. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcharref.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcharref.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcheckbox.3qt b/doc/man/man3/qcheckbox.3qt deleted file mode 100644 index d38f22e87..000000000 --- a/doc/man/man3/qcheckbox.3qt +++ /dev/null @@ -1,308 +0,0 @@ -'\" t -.TH QCheckBox 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 -QCheckBox \- Checkbox with a text label -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QButton. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCheckBox\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQCheckBox\fR ( const QString & text, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "bool \fBisChecked\fR () const" -.br -.ti -1c -.BI "void \fBsetNoChange\fR ()" -.br -.ti -1c -.BI "void \fBsetTristate\fR ( bool y = TRUE )" -.br -.ti -1c -.BI "bool \fBisTristate\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBsetChecked\fR ( bool check )" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "const QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" -.br -.ti -1c -.BI "QKeySequence \fBaccel\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" -.br -.ti -1c -.BI "bool \fBisToggleButton\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDown\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisDown\fR () const" -.br -.ti -1c -.BI "bool \fBisOn\fR () const" -.br -.ti -1c -.BI "ToggleState \fBstate\fR () const" -.br -.ti -1c -.BI "bool \fBautoRepeat\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoRepeat\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisExclusiveToggle\fR () const" -.br -.ti -1c -.BI "QButtonGroup * \fBgroup\fR () const" -.br -.ti -1c -.BI "void \fBtoggle\fR ()" -.br -.ti -1c -.BI "void \fBpressed\fR ()" -.br -.ti -1c -.BI "void \fBreleased\fR ()" -.br -.ti -1c -.BI "void \fBclicked\fR ()" -.br -.ti -1c -.BI "void \fBtoggled\fR ( bool on )" -.br -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoMask\fR - whether the checkbox is automatically masked \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBchecked\fR - whether the checkbox is checked" -.br -.ti -1c -.BI "bool \fBtristate\fR - whether the checkbox is a tri-state checkbox" -.br -.in -1c -.SH DESCRIPTION -The QCheckBox widget provides a checkbox with a text label. -.PP -QCheckBox and QRadioButton are both option buttons. That is, they can be switched on (checked) or off (unchecked). The classes differ in how the choices for the user are restricted. Radio buttons define a "one of many" choice, whereas checkboxes provide" many of many" choices. -.PP -A QButtonGroup can be used to group check buttons visually. -.PP -Whenever a checkbox is checked or cleared it emits the signal toggled(). Connect to this signal if you want to trigger an action each time the checkbox changes state. You can use isChecked() to query whether or not a checkbox is checked. -.PP -\fBWarning:\fR The toggled() signal can not be trusted for tristate checkboxes. -.PP -In addition to the usual checked and unchecked states, QCheckBox optionally provides a third state to indicate "no change". This is useful whenever you need to give the user the option of neither checking nor unchecking a checkbox. If you need this third state, enable it with setTristate() and use state() to query the current toggle state. When a tristate checkbox changes state, it emits the stateChanged() signal. -.PP -Just like QPushButton, a checkbox can display text or a pixmap. The text can be set in the constructor or with setText(); the pixmap is set with setPixmap(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QButton, QRadioButton, Fowler: Check Box, and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCheckBox::QCheckBox ( QWidget * parent, const char * name = 0 )" -Constructs a checkbox with no text. -.PP -The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. -.SH "QCheckBox::QCheckBox ( const QString & text, QWidget * parent, const char * name = 0 )" -Constructs a checkbox with text \fItext\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. -.SH "QKeySequence QButton::accel () const" -Returns the accelerator associated with the button. See the "accel" property for details. -.SH "bool QButton::autoRepeat () const" -Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. -.SH "void QButton::clicked ()\fC [signal]\fR" -This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). -.PP -The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. -.PP -\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. -.PP -See also pressed(), released(), toggled(), autoRepeat, and down. -.PP -Examples: -.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. -.SH "QButtonGroup * QButton::group () const" -Returns the group that this button belongs to. -.PP -If the button is not a member of any QButtonGroup, this function returns 0. -.PP -See also QButtonGroup. -.SH "bool QCheckBox::isChecked () const" -Returns TRUE if the checkbox is checked; otherwise returns FALSE. See the "checked" property for details. -.SH "bool QButton::isDown () const" -Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. -.SH "bool QButton::isExclusiveToggle () const" -Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. -.SH "bool QButton::isOn () const" -Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. -.SH "bool QButton::isToggleButton () const" -Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. -.SH "bool QCheckBox::isTristate () const" -Returns TRUE if the checkbox is a tri-state checkbox; otherwise returns FALSE. See the "tristate" property for details. -.SH "const QPixmap * QButton::pixmap () const" -Returns the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::pressed ()\fC [signal]\fR" -This signal is emitted when the button is pressed down. -.PP -See also released() and clicked(). -.PP -Examples: -.)l network/httpd/httpd.cpp and popup/popup.cpp. -.SH "void QButton::released ()\fC [signal]\fR" -This signal is emitted when the button is released. -.PP -See also pressed(), clicked(), and toggled(). -.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" -Sets the accelerator associated with the button. See the "accel" property for details. -.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" -Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. -.SH "void QCheckBox::setChecked ( bool check )\fC [slot]\fR" -Sets whether the checkbox is checked to \fIcheck\fR. See the "checked" property for details. -.SH "void QButton::setDown ( bool )\fC [virtual]\fR" -Sets whether the button is pressed. See the "down" property for details. -.SH "void QCheckBox::setNoChange ()" -Sets the checkbox to the "no change" state. -.PP -See also tristate. -.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" -Sets the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" -Sets the text shown on the button. See the "text" property for details. -.SH "void QCheckBox::setTristate ( bool y = TRUE )" -Sets whether the checkbox is a tri-state checkbox to \fIy\fR. See the "tristate" property for details. -.SH "ToggleState QButton::state () const" -Returns the state of the toggle button. See the "toggleState" property for details. -.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. -.PP -See also clicked() and QButton::ToggleState. -.SH "QString QButton::text () const" -Returns the text shown on the button. See the "text" property for details. -.SH "void QButton::toggle ()\fC [slot]\fR" -Toggles the state of a toggle button. -.PP -See also on, setOn(), toggled(), and toggleButton. -.SH "void QButton::toggled ( bool on )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, or because setOn() was called. -.PP -See also clicked(). -.PP -Example: listbox/listbox.cpp. -.SS "Property Documentation" -.SH "QKeySequence accel" -This property holds the accelerator associated with the button. -.PP -This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. -.PP -Set this property's value with setAccel() and get this property's value with accel(). -.SH "bool autoMask" -This property holds whether the checkbox is automatically masked. -.PP -See also QWidget::autoMask. -.SH "bool autoRepeat" -This property holds whether autoRepeat is enabled. -.PP -If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. -.PP -Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). -.SH "bool checked" -This property holds whether the checkbox is checked. -.PP -The default is unchecked, i.e. FALSE. -.PP -Set this property's value with setChecked() and get this property's value with isChecked(). -.SH "QPixmap pixmap" -This property holds the pixmap shown on the button. -.PP -If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. -.PP -pixmap() returns 0 if no pixmap was set. -.PP -Set this property's value with setPixmap() and get this property's value with pixmap(). -.SH "QString text" -This property holds the text shown on the button. -.PP -This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. -.PP -There is no default text. -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "bool tristate" -This property holds whether the checkbox is a tri-state checkbox. -.PP -The default is two-state, i.e. tri-state is FALSE. -.PP -Set this property's value with setTristate() and get this property's value with isTristate(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcheckbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcheckbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qchecklistitem.3qt b/doc/man/man3/qchecklistitem.3qt deleted file mode 100644 index 1b156e9d0..000000000 --- a/doc/man/man3/qchecklistitem.3qt +++ /dev/null @@ -1,229 +0,0 @@ -'\" t -.TH QCheckListItem 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 -QCheckListItem \- Checkable list view items -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QListViewItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBType\fR { RadioButton, CheckBox, Controller, RadioButtonController = Controller, CheckBoxController }" -.br -.ti -1c -.BI "enum \fBToggleState\fR { Off, NoChange, On }" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QCheckListItem * parent, const QString & text, Type tt = RadioButtonController )" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QCheckListItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QListViewItem * parent, const QString & text, Type tt = RadioButtonController )" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QListViewItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QListView * parent, const QString & text, Type tt = RadioButtonController )" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QListView * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QListViewItem * parent, const QString & text, const QPixmap & p )" -.br -.ti -1c -.BI "\fBQCheckListItem\fR ( QListView * parent, const QString & text, const QPixmap & p )" -.br -.ti -1c -.BI "\fB~QCheckListItem\fR ()" -.br -.ti -1c -.BI "virtual void \fBpaintCell\fR ( QPainter * p, const QColorGroup & cg, int column, int width, int align )" -.br -.ti -1c -.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QColorGroup & cg, const QRect & r )" -.br -.ti -1c -.BI "virtual void \fBsetOn\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisOn\fR () const" -.br -.ti -1c -.BI "Type \fBtype\fR () const" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "void \fBsetTristate\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisTristate\fR () const" -.br -.ti -1c -.BI "ToggleState \fBstate\fR () const" -.br -.ti -1c -.BI "void \fBsetState\fR ( ToggleState s )" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBactivate\fR ()" -.br -.ti -1c -.BI "void \fBturnOffChild\fR ()" -.br -.ti -1c -.BI "virtual void \fBstateChange\fR ( bool )" -.br -.in -1c -.SH DESCRIPTION -The QCheckListItem class provides checkable list view items. -.PP -QCheckListItems are used in QListViews to provide QListViewItems that are checkboxes, radio buttons or controllers. -.PP -Checkbox and controller check list items may be inserted at any level in a list view. Radio button check list items must be children of a controller check list item. -.PP -The item can be checked or unchecked with setOn(). Its type can be retrieved with type() and its text retrieved with text(). -.PP -
            -.ce 1 -.B "[Image Omitted]" -.PP -
            -.PP -See also QListViewItem, QListView, and Advanced Widgets. -.SS "Member Type Documentation" -.SH "QCheckListItem::ToggleState" -This enum specifies a QCheckListItem's toggle state. -.TP -\fCQCheckListItem::Off\fR -.TP -\fCQCheckListItem::NoChange\fR -.TP -\fCQCheckListItem::On\fR -.SH "QCheckListItem::Type" -This enum type specifies a QCheckListItem's type: -.TP -\fCQCheckListItem::RadioButton\fR -.TP -\fCQCheckListItem::CheckBox\fR -.TP -\fCQCheckListItem::Controller\fR - \fIobsolete\fR (use RadioButtonController instead) -.TP -\fCQCheckListItem::RadioButtonController\fR -.TP -\fCQCheckListItem::CheckBoxController\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCheckListItem::QCheckListItem ( QCheckListItem * parent, const QString & text, Type tt = RadioButtonController )" -Constructs a checkable item with parent \fIparent\fR, text \fItext\fR and of type \fItt\fR. Note that a RadioButton must be the child of a RadioButtonController, otherwise it will not toggle. -.SH "QCheckListItem::QCheckListItem ( QCheckListItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" -Constructs a checkable item with parent \fIparent\fR, which is after \fIafter\fR in the parent's list of children, and with text \fItext\fR and of type \fItt\fR. Note that a RadioButton must be the child of a RadioButtonController, otherwise it will not toggle. -.SH "QCheckListItem::QCheckListItem ( QListViewItem * parent, const QString & text, Type tt = RadioButtonController )" -Constructs a checkable item with parent \fIparent\fR, text \fItext\fR and of type \fItt\fR. Note that this item must \fInot\fR be a RadioButton. Radio buttons must be children of a RadioButtonController. -.SH "QCheckListItem::QCheckListItem ( QListViewItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" -Constructs a checkable item with parent \fIparent\fR, which is after \fIafter\fR in the parent's list of children, with text \fItext\fR and of type \fItt\fR. Note that this item must \fInot\fR be a RadioButton. Radio buttons must be children of a RadioButtonController. -.SH "QCheckListItem::QCheckListItem ( QListView * parent, const QString & text, Type tt = RadioButtonController )" -Constructs a checkable item with parent \fIparent\fR, text \fItext\fR and of type \fItt\fR. Note that \fItt\fR must \fInot\fR be RadioButton. Radio buttons must be children of a RadioButtonController. -.SH "QCheckListItem::QCheckListItem ( QListView * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" -Constructs a checkable item with parent \fIparent\fR, which is after \fIafter\fR in the parent's list of children, with text \fItext\fR and of type \fItt\fR. Note that \fItt\fR must \fInot\fR be RadioButton. Radio buttons must be children of a RadioButtonController. -.SH "QCheckListItem::QCheckListItem ( QListViewItem * parent, const QString & text, const QPixmap & p )" -Constructs a RadioButtonController item with parent \fIparent\fR, text \fItext\fR and pixmap \fIp\fR. -.SH "QCheckListItem::QCheckListItem ( QListView * parent, const QString & text, const QPixmap & p )" -Constructs a RadioButtonController item with parent \fIparent\fR, text \fItext\fR and pixmap \fIp\fR. -.SH "QCheckListItem::~QCheckListItem ()" -Destroys the item, and all its children to any depth, freeing up all allocated resources. -.SH "void QCheckListItem::activate ()\fC [virtual protected]\fR" -Toggle check box or set radio button to on. -.PP -Reimplemented from QListViewItem. -.SH "bool QCheckListItem::isOn () const" -Returns TRUE if the item is toggled on; otherwise returns FALSE. -.SH "bool QCheckListItem::isTristate () const" -Returns TRUE if the item is tristate; otherwise returns FALSE. -.PP -See also setTristate(). -.SH "void QCheckListItem::paintCell ( QPainter * p, const QColorGroup & cg, int column, int width, int align )\fC [virtual]\fR" -Paints the item using the painter \fIp\fR and the color group \fIcg\fR. The item is in column \fIcolumn\fR, has width \fIwidth\fR and has alignment \fIalign\fR. (See Qt::AlignmentFlags for valid alignments.) -.PP -Reimplemented from QListViewItem. -.SH "void QCheckListItem::paintFocus ( QPainter * p, const QColorGroup & cg, const QRect & r )\fC [virtual]\fR" -Draws the focus rectangle \fIr\fR using the color group \fIcg\fR on the painter \fIp\fR. -.PP -Reimplemented from QListViewItem. -.SH "int QCheckListItem::rtti () const\fC [virtual]\fR" -Returns 1. -.PP -Make your derived classes return their own values for rtti(), and you can distinguish between list view items. You should use values greater than 1000, to allow for extensions to this class. -.PP -Reimplemented from QListViewItem. -.SH "void QCheckListItem::setOn ( bool b )\fC [virtual]\fR" -Sets the button on if \fIb\fR is TRUE, otherwise sets it off. Maintains radio button exclusivity. -.SH "void QCheckListItem::setState ( ToggleState s )" -Sets the toggle state of the checklistitem to \fIs\fR. \fIs\fR can be Off, NoChange or On. -.PP -Tristate can only be enabled for CheckBox or CheckBoxController, therefore the NoChange only applies to them. -.PP -Setting the state to On or Off on a CheckBoxController will recursivly set the states of its children to the same state. -.PP -Setting the state to NoChange on a CheckBoxController will make it recursivly recall the previous stored state of its children. If there was no previous stored state the children are all set to On. -.SH "void QCheckListItem::setTristate ( bool b )" -Sets tristate to \fIb\fR if the Type is either a CheckBoxController or a CheckBox. -.PP -\fCCheckBoxControllers\fR are tristate by default. -.PP -See also state() and isTristate(). -.SH "ToggleState QCheckListItem::state () const" -Returns the state of the item. -.PP -See also QCheckListItem::ToggleState. -.SH "void QCheckListItem::stateChange ( bool )\fC [virtual protected]\fR" -This virtual function is called when the item changes its state. NoChange (if tristate is enabled and the type is either CheckBox or CheckBoxController) reports the same as Off, so use state() to determine if the state is actually Off or NoChange. -.SH "QString QCheckListItem::text () const" -Returns the item's text. -.SH "void QCheckListItem::turnOffChild ()\fC [protected]\fR" -If this is a RadioButtonController that has RadioButton children, turn off the child that is on. -.SH "Type QCheckListItem::type () const" -Returns the type of this item. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qchecklistitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qchecklistitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qchecktableitem.3qt b/doc/man/man3/qchecktableitem.3qt deleted file mode 100644 index 0dc7b2b29..000000000 --- a/doc/man/man3/qchecktableitem.3qt +++ /dev/null @@ -1,94 +0,0 @@ -'\" t -.TH QCheckTableItem 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 -QCheckTableItem \- Checkboxes in QTables -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QTableItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCheckTableItem\fR ( QTable * table, const QString & txt )" -.br -.ti -1c -.BI "virtual void \fBsetChecked\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisChecked\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QCheckTableItem class provides checkboxes in QTables. -.PP -A QCheckTableItem is a table item which looks and behaves like a checkbox. The advantage of using QCheckTableItems rather than real checkboxes is that a QCheckTableItem uses far less resources than a real checkbox would in a QTable. When the cell has the focus it displays a real checkbox which the user can interact with. When the cell does not have the focus the cell \fIlooks\fR like a checkbox. Pixmaps may not be used in QCheckTableItems. -.PP -QCheckTableItem items have the edit type WhenCurrent (see EditType). -.PP -To change the checkbox's label use setText(). The checkbox can be checked and unchecked with setChecked() and its state retrieved using isChecked(). -.PP -To populate a table cell with a QCheckTableItem use QTable::setItem(). -.PP -QCheckTableItems can be distinguished from QTableItems and QComboTableItems using their Run Time Type Identification (rtti) value. -.PP -
            -.ce 1 -.B "[Image Omitted]" -.PP -
            -.PP -See also rtti(), EditType, QComboTableItem, QTableItem, QCheckBox, and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCheckTableItem::QCheckTableItem ( QTable * table, const QString & txt )" -Creates a QCheckTableItem with an EditType of WhenCurrent as a child of \fItable\fR. The checkbox is initially unchecked and its label is set to the string \fItxt\fR. -.SH "bool QCheckTableItem::isChecked () const" -Returns TRUE if the checkbox table item is checked; otherwise returns FALSE. -.PP -See also setChecked(). -.SH "int QCheckTableItem::rtti () const\fC [virtual]\fR" -Returns 2. -.PP -Make your derived classes return their own values for rtti()to distinguish between different table item subclasses. You should use values greater than 1000, preferably a large random number, to allow for extensions to this class. -.PP -See also QTableItem::rtti(). -.PP -Reimplemented from QTableItem. -.SH "void QCheckTableItem::setChecked ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE the checkbox is checked; if \fIb\fR is FALSE the checkbox is unchecked. -.PP -See also isChecked(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qchecktableitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qchecktableitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qchildevent.3qt b/doc/man/man3/qchildevent.3qt deleted file mode 100644 index 7026c26fb..000000000 --- a/doc/man/man3/qchildevent.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QChildEvent 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 -QChildEvent \- Event parameters for child object events -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQChildEvent\fR ( Type type, QObject * child )" -.br -.ti -1c -.BI "QObject * \fBchild\fR () const" -.br -.ti -1c -.BI "bool \fBinserted\fR () const" -.br -.ti -1c -.BI "bool \fBremoved\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QChildEvent class contains event parameters for child object events. -.PP -Child events are sent to objects when children are inserted or removed. -.PP -A ChildRemoved event is sent immediately, but a ChildInserted event is \fIposted\fR (with QApplication::postEvent()). -.PP -Note that if a child is removed immediately after it is inserted, the ChildInserted event may be suppressed, but the ChildRemoved event will always be sent. In this case there will be a ChildRemoved event without a corresponding ChildInserted event. -.PP -The handler for these events is QObject::childEvent(). -.PP -See also Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QChildEvent::QChildEvent ( Type type, QObject * child )" -Constructs a child event object. The \fIchild\fR is the object that is to be removed or inserted. -.PP -The \fItype\fR parameter must be either QEvent::ChildInserted or QEvent::ChildRemoved. -.SH "QObject * QChildEvent::child () const" -Returns the child widget that was inserted or removed. -.SH "bool QChildEvent::inserted () const" -Returns TRUE if the widget received a new child; otherwise returns FALSE. -.SH "bool QChildEvent::removed () const" -Returns TRUE if the object lost a child; otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qchildevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qchildevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qclipboard.3qt b/doc/man/man3/qclipboard.3qt deleted file mode 100644 index b8480ac87..000000000 --- a/doc/man/man3/qclipboard.3qt +++ /dev/null @@ -1,357 +0,0 @@ -'\" t -.TH QClipboard 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 -QClipboard \- Access to the window system clipboard -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBMode\fR { Clipboard, Selection }" -.br -.ti -1c -.BI "void \fBclear\fR ( Mode mode )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "bool \fBsupportsSelection\fR () const" -.br -.ti -1c -.BI "bool \fBownsSelection\fR () const" -.br -.ti -1c -.BI "bool \fBownsClipboard\fR () const" -.br -.ti -1c -.BI "void setSelectionMode ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool selectionModeEnabled () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString \fBtext\fR ( Mode mode ) const" -.br -.ti -1c -.BI "QString \fBtext\fR ( QCString & subtype, Mode mode ) const" -.br -.ti -1c -.BI "void \fBsetText\fR ( const QString & text, Mode mode )" -.br -.ti -1c -.BI "QMimeSource * \fBdata\fR ( Mode mode ) const" -.br -.ti -1c -.BI "void \fBsetData\fR ( QMimeSource * src, Mode mode )" -.br -.ti -1c -.BI "QImage \fBimage\fR ( Mode mode ) const" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR ( Mode mode ) const" -.br -.ti -1c -.BI "void \fBsetImage\fR ( const QImage & image, Mode mode )" -.br -.ti -1c -.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap, Mode mode )" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "QString \fBtext\fR ( QCString & subtype ) const" -.br -.ti -1c -.BI "void \fBsetText\fR ( const QString & text )" -.br -.ti -1c -.BI "QMimeSource * \fBdata\fR () const" -.br -.ti -1c -.BI "void \fBsetData\fR ( QMimeSource * src )" -.br -.ti -1c -.BI "QImage \fBimage\fR () const" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR () const" -.br -.ti -1c -.BI "void \fBsetImage\fR ( const QImage & image )" -.br -.ti -1c -.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBselectionChanged\fR ()" -.br -.ti -1c -.BI "void \fBdataChanged\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QClipboard class provides access to the window system clipboard. -.PP -The clipboard offers a simple mechanism to copy and paste data between applications. -.PP -QClipboard supports the same data types that QDragObject does, and uses similar mechanisms. For advanced clipboard usage read the drag-and-drop documentation. -.PP -There is a single QClipboard object in an application, and you can access it using QApplication::clipboard(). -.PP -Example: -.PP -.nf -.br - QClipboard *cb = QApplication::clipboard(); -.br -.br - // Copy text from the clipboard (paste) -.br - QString text = cb->text(QClipboard::Clipboard); -.br - if ( !text.isNull() ) -.br - tqDebug( "The clipboard contains: " + text ); -.br -.br - // Copy text into the clipboard -.br - cb->setText( "This text can be pasted by other programs", -.br - QClipboard::Clipboard ); -.br -.fi -.PP -QClipboard features some convenience functions to access common data types: setText() allows the exchange of Unicode text and setPixmap() and setImage() allows the exchange of QPixmaps and QImages between applications. The setData() function is the ultimate in flexibility: it allows you to add any QMimeSource into the clipboard. There are corresponding getters for each of these, e.g. text(), image() and pixmap(). -.PP -You can clear the clipboard by calling clear(). -.SH "Platform Specific Information" -

            X11

            -.IP -.TP -The X11 Window System has the concept of a separate selection and clipboard. When text is selected, it is immediately available as the global mouse selection. The global mouse selection may later be copied to the clipboard. By convention, the middle mouse button is used to paste the global mouse selection. -.IP -.TP -X11 also has the concept of ownership; if you change the selection within a window, X11 will only notify the owner and the previous owner of the change, i.e. it will not notify all applications that the selection or clipboard data changed. -.IP -.TP -Lastly, the X11 clipboard is event driven, i.e. the clipboard will not function properly if the event loop is not running. Similarly, it is recommended that the contents of the clipboard are stored or retrieved in direct response to user-input events, e.g. mouse button or key presses and releases. You should not store or retrieve the clipboard contents in response to timer or non-user-input events. -.IP -.PP -

            Windows

            -.IP -.TP -Microsoft Windows does not support the global mouse selection; it only supports the global clipboard, e.g. Windows only adds text to the clipboard when an explicit copy or cut is made. -.IP -.TP -Windows does not have the concept of ownership; the clipboard is a fully global resource so all applications are notified of changes. -.IP -.PP -See the multiclip example in the \fIQt Designer\fR examples directory for an example of a multiplatform clipboard application that also demonstrates selection handling. -.PP -See also Environment Classes and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QClipboard::Mode" - -.PP -This enum type is used to control which part of the system clipboard is used by QClipboard::data(), QClipboard::setData() and related functions. -.TP -\fCQClipboard::Clipboard\fR - indicates that data should be stored and retrieved from the global clipboard. -.TP -\fCQClipboard::Selection\fR - indicates that data should be stored and retrieved from the global mouse selection. -.PP -\fINote\fR: Support for Selection is provided only on systems with a global mouse selection (e.g. X11). -.PP -See also QClipboard::supportsSelection(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "void QClipboard::clear ( Mode mode )" -Clear the clipboard contents. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, this function clears the the global clipboard contents. If \fImode\fR is QClipboard::Selection, this function clears the global mouse selection contents. -.PP -See also QClipboard::Mode and supportsSelection(). -.SH "void QClipboard::clear ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::clear() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "QMimeSource * QClipboard::data ( Mode mode ) const" -Returns a reference to a QMimeSource representation of the current clipboard data. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the data is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the data is retrieved from the global mouse selection. -.PP -See also setData(). -.SH "QMimeSource * QClipboard::data () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::data() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "void QClipboard::dataChanged ()\fC [signal]\fR" -This signal is emitted when the clipboard data is changed. -.SH "QImage QClipboard::image ( Mode mode ) const" -Returns the clipboard image, or returns a null image if the clipboard does not contain an image or if it contains an image in an unsupported image format. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the image is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the image is retrieved from the global mouse selection. -.PP -See also setImage(), pixmap(), data(), and QImage::isNull(). -.SH "QImage QClipboard::image () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::image() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "bool QClipboard::ownsClipboard () const" -Returns TRUE if this clipboard object owns the clipboard data; otherwise returns FALSE. -.SH "bool QClipboard::ownsSelection () const" -Returns TRUE if this clipboard object owns the mouse selection data; otherwise returns FALSE. -.SH "QPixmap QClipboard::pixmap ( Mode mode ) const" -Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. Note that this can lose information. For example, if the image is 24-bit and the display is 8-bit, the result is converted to 8 bits, and if the image has an alpha channel, the result just has a mask. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the pixmap is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the pixmap is retrieved from the global mouse selection. -.PP -See also setPixmap(), image(), data(), and QPixmap::convertFromImage(). -.SH "QPixmap QClipboard::pixmap () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::pixmap() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "void QClipboard::selectionChanged ()\fC [signal]\fR" -This signal is emitted when the selection is changed. This only applies to windowing systems that support selections, e.g. X11. Windows doesn't support selections. -.SH "bool QClipboard::selectionModeEnabled () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use the QClipboard::data(), QClipboard::setData() and related functions which take a QClipboard::Mode argument. -.PP -Returns the selection mode. -.PP -See also setSelectionMode() and supportsSelection(). -.SH "void QClipboard::setData ( QMimeSource * src, Mode mode )" -Sets the clipboard data to \fIsrc\fR. Ownership of the data is transferred to the clipboard. If you want to remove the data either call clear() or call setData() again with new data. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the data is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the data is retrieved from the global mouse selection. -.PP -The QDragObject subclasses are reasonable objects to put into the clipboard (but do not try to call QDragObject::drag() on the same object). Any QDragObject placed in the clipboard should have a parent of 0. Do not put QDragMoveEvent or QDropEvent subclasses in the clipboard, as they do not belong to the event handler which receives them. -.PP -The setText(), setImage() and setPixmap() functions are simpler wrappers for setting text, image and pixmap data respectively. -.PP -See also data(). -.SH "void QClipboard::setData ( QMimeSource * src )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::setData() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "void QClipboard::setImage ( const QImage & image, Mode mode )" -Copies \fIimage\fR into the clipboard. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the image is stored in the global clipboard. If \fImode\fR is QClipboard::Selection, the data is stored in the global mouse selection. -.PP -This is shorthand for: -.PP -.nf -.br - setData( new QImageDrag(image), mode ) -.br -.fi -.PP -See also image(), setPixmap(), and setData(). -.SH "void QClipboard::setImage ( const QImage & image )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::setImage() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "void QClipboard::setPixmap ( const QPixmap & pixmap, Mode mode )" -Copies \fIpixmap\fR into the clipboard. Note that this is slower than setImage() because it needs to convert the QPixmap to a QImage first. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the pixmap is stored in the global clipboard. If \fImode\fR is QClipboard::Selection, the pixmap is stored in the global mouse selection. -.PP -See also pixmap(), setImage(), and setData(). -.SH "void QClipboard::setPixmap ( const QPixmap & pixmap )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::setPixmap() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "void QClipboard::setSelectionMode ( bool enable )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use the QClipboard::data(), QClipboard::setData() and related functions which take a QClipboard::Mode argument. -.PP -Sets the clipboard selection mode. If \fIenable\fR is TRUE, then subsequent calls to QClipboard::setData() and other functions which put data into the clipboard will put the data into the mouse selection, otherwise the data will be put into the clipboard. -.PP -See also supportsSelection() and selectionModeEnabled(). -.SH "void QClipboard::setText ( const QString & text, Mode mode )" -Copies \fItext\fR into the clipboard as plain text. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the text is stored in the global clipboard. If \fImode\fR is QClipboard::Selection, the text is stored in the global mouse selection. -.PP -See also text() and setData(). -.PP -Example: regexptester/regexptester.cpp. -.SH "void QClipboard::setText ( const QString & text )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::setText() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "bool QClipboard::supportsSelection () const" -Returns TRUE if the clipboard supports mouse selection; otherwise returns FALSE. -.PP -Example: regexptester/regexptester.cpp. -.SH "QString QClipboard::text ( Mode mode ) const" -Returns the clipboard text as plain text, or a null string if the clipboard does not contain any text. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the text is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the text is retrieved from the global mouse selection. -.PP -See also setText(), data(), and QString::operator!(). -.SH "QString QClipboard::text ( QCString & subtype, Mode mode ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the clipboard text in subtype \fIsubtype\fR, or a null string if the clipboard does not contain any text. If \fIsubtype\fR is null, any subtype is acceptable, and \fIsubtype\fR is set to the chosen subtype. -.PP -The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the text is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the text is retrieved from the global mouse selection. -.PP -Common values for \fIsubtype\fR are "plain" and "html". -.PP -See also setText(), data(), and QString::operator!(). -.SH "QString QClipboard::text () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses the QClipboard::text() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. -.SH "QString QClipboard::text ( QCString & subtype ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the clipboard text in subtype \fIsubtype\fR, or a null string -if the clipboard does not contain any text. This function uses the -QClipboard::text() function which takes a QClipboard::Mode -argument. The value of the mode argument is determined by the -return value of selectionModeEnabled(). If selectionModeEnabled() -returns TRUE, the mode argument is QClipboard::Selection, -otherwise the mode argument is QClipboard::Clipboard. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqclipboard.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qclipboard.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcloseevent.3qt b/doc/man/man3/qcloseevent.3qt deleted file mode 100644 index 2a3ed3297..000000000 --- a/doc/man/man3/qcloseevent.3qt +++ /dev/null @@ -1,110 +0,0 @@ -'\" t -.TH QCloseEvent 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 -QCloseEvent \- Parameters that describe a close event -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCloseEvent\fR ()" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QCloseEvent class contains parameters that describe a close event. -.PP -Close events are sent to widgets that the user wants to close, usually by choosing "Close" from the window menu, or by clicking the `X' titlebar button. They are also sent when you call QWidget::close() to close a widget programmatically. -.PP -Close events contain a flag that indicates whether the receiver wants the widget to be closed or not. When a widget accepts the close event, it is hidden (and destroyed if it was created with the WDestructiveClose flag). If it refuses to accept the close event nothing happens. (Under X11 it is possible that the window manager will forcibly close the window; but at the time of writing we are not aware of any window manager that does this.) -.PP -The application's main widget -- QApplication::mainWidget() -- is a special case. When it accepts the close event, Qt leaves the main event loop and the application is immediately terminated (i.e. it returns from the call to QApplication::exec() in the main() function). -.PP -The event handler QWidget::closeEvent() receives close events. The default implementation of this event handler accepts the close event. If you do not want your widget to be hidden, or want some special handing, you should reimplement the event handler. -.PP -The closeEvent() in the Application Walkthrough shows a close event handler that asks whether to save a document before closing. -.PP -If you want the widget to be deleted when it is closed, create it with the WDestructiveClose widget flag. This is very useful for independent top-level windows in a multi-window application. -.PP -QObjects emits the destroyed() signal when they are deleted. -.PP -If the last top-level window is closed, the QApplication::lastWindowClosed() signal is emitted. -.PP -The isAccepted() function returns TRUE if the event's receiver has agreed to close the widget; call accept() to agree to close the widget and call ignore() if the receiver of this event does not want the widget to be closed. -.PP -See also QWidget::close(), QWidget::hide(), QObject::destroyed(), QApplication::setMainWidget(), QApplication::lastWindowClosed(), QApplication::exec(), QApplication::quit(), and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCloseEvent::QCloseEvent ()" -Constructs a close event object with the accept parameter flag set to FALSE. -.PP -See also accept(). -.SH "void QCloseEvent::accept ()" -Sets the accept flag of the close event object. -.PP -Setting the accept flag indicates that the receiver of this event agrees to close the widget. -.PP -The accept flag is \fInot\fR set by default. -.PP -If you choose to accept in QWidget::closeEvent(), the widget will be hidden. If the widget's WDestructiveClose flag is set, it will also be destroyed. -.PP -See also ignore() and QWidget::hide(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, mdi/application.cpp, popup/popup.cpp, and qwerty/qwerty.cpp. -.SH "void QCloseEvent::ignore ()" -Clears the accept flag of the close event object. -.PP -Clearing the accept flag indicates that the receiver of this event does not want the widget to be closed. -.PP -The close event is constructed with the accept flag cleared. -.PP -See also accept(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. -.SH "bool QCloseEvent::isAccepted () const" -Returns TRUE if the receiver of the event has agreed to close the widget; otherwise returns FALSE. -.PP -See also accept() and ignore(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcloseevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcloseevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcolor.3qt b/doc/man/man3/qcolor.3qt deleted file mode 100644 index 17024287b..000000000 --- a/doc/man/man3/qcolor.3qt +++ /dev/null @@ -1,592 +0,0 @@ -'\" t -.TH QColor 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 -QColor \- Colors based on RGB or HSV values -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBSpec\fR { Rgb, Hsv }" -.br -.ti -1c -.BI "\fBQColor\fR ()" -.br -.ti -1c -.BI "\fBQColor\fR ( int r, int g, int b )" -.br -.ti -1c -.BI "\fBQColor\fR ( int x, int y, int z, Spec colorSpec )" -.br -.ti -1c -.BI "\fBQColor\fR ( QRgb rgb, uint pixel = 0xffffffff )" -.br -.ti -1c -.BI "\fBQColor\fR ( const QString & name )" -.br -.ti -1c -.BI "\fBQColor\fR ( const char * name )" -.br -.ti -1c -.BI "\fBQColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "QColor & \fBoperator=\fR ( const QColor & c )" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "void \fBsetNamedColor\fR ( const QString & name )" -.br -.ti -1c -.BI "QRgb \fBrgb\fR () const" -.br -.ti -1c -.BI "void \fBsetRgb\fR ( int r, int g, int b )" -.br -.ti -1c -.BI "void \fBsetRgb\fR ( QRgb rgb )" -.br -.ti -1c -.BI "void \fBgetRgb\fR ( int * r, int * g, int * b ) const" -.br -.ti -1c -.BI "void rgb ( int * r, int * g, int * b ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBred\fR () const" -.br -.ti -1c -.BI "int \fBgreen\fR () const" -.br -.ti -1c -.BI "int \fBblue\fR () const" -.br -.ti -1c -.BI "void \fBsetHsv\fR ( int h, int s, int v )" -.br -.ti -1c -.BI "void \fBgetHsv\fR ( int * h, int * s, int * v ) const" -.br -.ti -1c -.BI "void hsv ( int * h, int * s, int * v ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void getHsv ( int & h, int & s, int & v ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QColor \fBlight\fR ( int factor = 150 ) const" -.br -.ti -1c -.BI "QColor \fBdark\fR ( int factor = 200 ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QColor & c ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QColor & c ) const" -.br -.ti -1c -.BI "uint \fBalloc\fR ()" -.br -.ti -1c -.BI "uint \fBpixel\fR () const" -.br -.ti -1c -.BI "uint \fBpixel\fR ( int screen ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "int \fBmaxColors\fR ()" -.br -.ti -1c -.BI "int \fBnumBitPlanes\fR ()" -.br -.ti -1c -.BI "int \fBenterAllocContext\fR ()" -.br -.ti -1c -.BI "void \fBleaveAllocContext\fR ()" -.br -.ti -1c -.BI "int \fBcurrentAllocContext\fR ()" -.br -.ti -1c -.BI "void \fBdestroyAllocContext\fR ( int context )" -.br -.ti -1c -.BI "void \fBinitialize\fR ()" -.br -.ti -1c -.BI "void \fBcleanup\fR ()" -.br -.ti -1c -.BI "QStringList \fBcolorNames\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QColor & c )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QColor & c )" -.br -.ti -1c -.BI "int \fBqRed\fR ( QRgb rgb )" -.br -.ti -1c -.BI "int \fBqGreen\fR ( QRgb rgb )" -.br -.ti -1c -.BI "int \fBqBlue\fR ( QRgb rgb )" -.br -.ti -1c -.BI "int \fBqAlpha\fR ( QRgb rgba )" -.br -.ti -1c -.BI "QRgb \fBqRgb\fR ( int r, int g, int b )" -.br -.ti -1c -.BI "QRgb \fBqRgba\fR ( int r, int g, int b, int a )" -.br -.ti -1c -.BI "int \fBqGray\fR ( int r, int g, int b )" -.br -.ti -1c -.BI "int \fBqGray\fR ( tqRgb rgb )" -.br -.in -1c -.SH DESCRIPTION -The QColor class provides colors based on RGB or HSV values. -.PP -A color is normally specified in terms of RGB (red, green and blue) components, but it is also possible to specify HSV (hue, saturation and value) or set a color name (the names are copied from from the X11 color database). -.PP -In addition to the RGB value, a QColor also has a pixel value and a validity. The pixel value is used by the underlying window system to refer to a color. It can be thought of as an index into the display hardware's color table. -.PP -The validity (isValid()) indicates whether the color is legal at all. For example, a RGB color with RGB values out of range is illegal. For performance reasons, QColor mostly disregards illegal colors. The result of using an invalid color is unspecified and will usually be surprising. -.PP -There are 19 predefined QColor objects: \fCwhite\fR, \fCblack\fR, \fCred\fR, \fCdarkRed\fR, \fCgreen\fR, \fCdarkGreen\fR, \fCblue\fR, \fCdarkBlue\fR, \fCcyan\fR, \fCdarkCyan\fR, \fCmagenta\fR, \fCdarkMagenta\fR, \fCyellow\fR, \fCdarkYellow\fR, \fCgray\fR, \fCdarkGray\fR, \fClightGray\fR, \fCcolor0\fR and \fCcolor1\fR, accessible as members of the Qt namespace (ie. \fCQt::red\fR). -.PP -
            -.ce 1 -.B "[Image Omitted]" -.PP -
            -.PP -The colors \fCcolor0\fR (zero pixel value) and \fCcolor1\fR (non-zero pixel value) are special colors for drawing in bitmaps. Painting with \fCcolor0\fR sets the bitmap bits to 0 (transparent, i.e. background), and painting with \fCcolor1\fR sets the bits to 1 (opaque, i.e. foreground). -.PP -The QColor class has an efficient, dynamic color allocation strategy. A color is normally allocated the first time it is used (lazy allocation), that is, whenever the pixel() function is called. The following steps are taken to allocate a color. If, at any point, a suitable color is found then the appropriate pixel value is returned and the subsequent steps are not taken: -.PP -
              -.IP 1 -Is the pixel value valid? If it is, just return it; otherwise, allocate a pixel value. -.IP 2 -Check an internal hash table to see if we allocated an equal RGB value earlier. If we did, set the corresponding pixel value for the color and return it. -.IP 3 -Try to allocate the RGB value. If we succeed, we get a pixel value that we save in the internal table with the RGB value. Return the pixel value. -.IP 4 -The color could not be allocated. Find the closest matching color, save it in the internal table, and return it. -.PP -A color can be set by passing setNamedColor() an RGB string like" #112233", or a color name, e.g. "blue". The names are taken from X11's rgb.txt database but can also be used under Windows. To get a lighter or darker color use light() and dark() respectively. Colors can also be set using setRgb() and setHsv(). The color components can be accessed in one go with rgb() and hsv(), or individually with red(), green() and blue(). -.PP -Use maxColors() and numBitPlanes() to determine the maximum number of colors and the number of bit planes supported by the underlying window system, -.PP -If you need to allocate many colors temporarily, for example in an image viewer application, enterAllocContext(), leaveAllocContext() and destroyAllocContext() will prove useful. -.SH "HSV Colors" -Because many people don't know the HSV color model very well, we'll cover it briefly here. -.PP -The RGB model is hardware-oriented. Its representation is close to what most monitors show. In contrast, HSV represents color in a way more suited to the human perception of color. For example, the relationships "stronger than", "darker than" and "the opposite of" are easily expressed in HSV but are much harder to express in RGB. -.PP -HSV, like RGB, has three components: -.IP -.TP -H, for hue, is either 0-359 if the color is chromatic (not gray), or meaningless if it is gray. It represents degrees on the color wheel familiar to most people. Red is 0 (degrees), green is 120 and blue is 240. -.IP -.TP -S, for saturation, is 0-255, and the bigger it is, the stronger the color is. Grayish colors have saturation near 0; very strong colors have saturation near 255. -.IP -.TP -V, for value, is 0-255 and represents lightness or brightness of the color. 0 is black; 255 is as far from black as possible. -.IP -.PP -Here are some examples: Pure red is H=0, S=255, V=255. A dark red, moving slightly towards the magenta, could be H=350 (equivalent to -10), S=255, V=180. A grayish light red could have H about 0 (say 350-359 or 0-10), S about 50-100, and S=255. -.PP -Qt returns a hue value of -1 for achromatic colors. If you pass a too-big hue value, Qt forces it into range. Hue 360 or 720 is treated as 0; hue 540 is treated as 180. -.PP -See also QPalette, QColorGroup, QApplication::setColorSpec(), Color FAQ, Widget Appearance and Style, Graphics Classes, and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QColor::Spec" -The type of color specified, either RGB or HSV, e.g. in the \fCQColor::QColor( x, y, z, colorSpec)\fR constructor. -.TP -\fCQColor::Rgb\fR -.TP -\fCQColor::Hsv\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QColor::QColor ()" -Constructs an invalid color with the RGB value (0, 0, 0). An invalid color is a color that is not properly set up for the underlying window system. -.PP -The alpha value of an invalid color is unspecified. -.PP -See also isValid(). -.SH "QColor::QColor ( int r, int g, int b )" -Constructs a color with the RGB value \fIr\fR, \fIg\fR, \fIb\fR, in the same way as setRgb(). -.PP -The color is left invalid if any or the arguments are illegal. -.PP -See also setRgb(). -.SH "QColor::QColor ( int x, int y, int z, Spec colorSpec )" -Constructs a color with the RGB or HSV value \fIx\fR, \fIy\fR, \fIz\fR. -.PP -The arguments are an RGB value if \fIcolorSpec\fR is QColor::Rgb. \fIx\fR (red), \fIy\fR (green), and \fIz\fR (blue). All of them must be in the range 0-255. -.PP -The arguments are an HSV value if \fIcolorSpec\fR is QColor::Hsv. \fIx\fR (hue) must be -1 for achromatic colors and 0-359 for chromatic colors; \fIy\fR (saturation) and \fIz\fR (value) must both be in the range 0-255. -.PP -See also setRgb() and setHsv(). -.SH "QColor::QColor ( QRgb rgb, uint pixel = 0xffffffff )" -Constructs a color with the RGB value \fIrgb\fR and a custom pixel value \fIpixel\fR. -.PP -If \fIpixel\fR == 0xffffffff (the default), then the color uses the RGB value in a standard way. If \fIpixel\fR is something else, then the pixel value is set directly to \fIpixel\fR, skipping the normal allocation procedure. -.SH "QColor::QColor ( const QString & name )" -Constructs a named color in the same way as setNamedColor() using name \fIname\fR. -.PP -The color is left invalid if \fIname\fR cannot be parsed. -.PP -See also setNamedColor(). -.SH "QColor::QColor ( const char * name )" -Constructs a named color in the same way as setNamedColor() using name \fIname\fR. -.PP -The color is left invalid if \fIname\fR cannot be parsed. -.PP -See also setNamedColor(). -.SH "QColor::QColor ( const QColor & c )" -Constructs a color that is a copy of \fIc\fR. -.SH "uint QColor::alloc ()" -Allocates the RGB color and returns the pixel value. -.PP -Allocating a color means to obtain a pixel value from the RGB specification. The pixel value is an index into the global color table, but should be considered an arbitrary platform-dependent value. -.PP -The pixel() function calls alloc() if necessary, so in general you don't need to call this function. -.PP -See also enterAllocContext(). -.SH "int QColor::blue () const" -Returns the B (blue) component of the RGB value. -.SH "void QColor::cleanup ()\fC [static]\fR" -Internal clean up required for QColor. This function is called from the QApplication destructor. -.PP -See also initialize(). -.SH "QStringList QColor::colorNames ()\fC [static]\fR" -Returns a QStringList containing the color names Qt knows about. -.SH "int QColor::currentAllocContext ()\fC [static]\fR" -Returns the current color allocation context. -.PP -The default context is 0. -.PP -See also enterAllocContext() and leaveAllocContext(). -.SH "QColor QColor::dark ( int factor = 200 ) const" -Returns a darker (or lighter) color, but does not change this object. -.PP -Returns a darker color if \fIfactor\fR is greater than 100. Setting \fIfactor\fR to 300 returns a color that has one-third the brightness. -.PP -Returns a lighter color if \fIfactor\fR is less than 100. We recommend using lighter() for this purpose. If \fIfactor\fR is 0 or negative, the return value is unspecified. -.PP -(This function converts the current RGB color to HSV, divides V by \fIfactor\fR and converts back to RGB.) -.PP -See also light(). -.PP -Examples: -.)l desktop/desktop.cpp and themes/wood.cpp. -.SH "void QColor::destroyAllocContext ( int context )\fC [static]\fR" -Destroys a color allocation context, \fIcontext\fR. -.PP -This function deallocates all colors that were allocated in the specified \fIcontext\fR. If \fIcontext\fR == -1, it frees up all colors that the application has allocated. If \fIcontext\fR == -2, it frees up all colors that the application has allocated, except those in the default context. -.PP -The function does nothing for true color displays. -.PP -See also enterAllocContext() and alloc(). -.PP -Example: showimg/showimg.cpp. -.SH "int QColor::enterAllocContext ()\fC [static]\fR" -Enters a color allocation context and returns a non-zero unique identifier. -.PP -Color allocation contexts are useful for programs that need to allocate many colors and throw them away later, like image viewers. The allocation context functions work for true color displays as well as for colormap displays, except that QColor::destroyAllocContext() does nothing for true color. -.PP -Example: -.PP -.nf -.br - QPixmap loadPixmap( QString fileName ) -.br - { -.br - static int alloc_context = 0; -.br - if ( alloc_context ) -.br - QColor::destroyAllocContext( alloc_context ); -.br - alloc_context = QColor::enterAllocContext(); -.br - QPixmap pm( fileName ); -.br - QColor::leaveAllocContext(); -.br - return pm; -.br - } -.br -.fi -.PP -The example code loads a pixmap from file. It frees up all colors that were allocated the last time loadPixmap() was called. -.PP -The initial/default context is 0. Qt keeps a list of colors associated with their allocation contexts. You can call destroyAllocContext() to get rid of all colors that were allocated in a specific context. -.PP -Calling enterAllocContext() enters an allocation context. The allocation context lasts until you call leaveAllocContext(). QColor has an internal stack of allocation contexts. Each call to enterAllocContex() must have a corresponding leaveAllocContext(). -.PP -.nf -.br - // context 0 active -.br - int c1 = QColor::enterAllocContext(); // enter context c1 -.br - // context c1 active -.br - int c2 = QColor::enterAllocContext(); // enter context c2 -.br - // context c2 active -.br - QColor::leaveAllocContext(); // leave context c2 -.br - // context c1 active -.br - QColor::leaveAllocContext(); // leave context c1 -.br - // context 0 active -.br - // Now, free all colors that were allocated in context c2 -.br - QColor::destroyAllocContext( c2 ); -.br -.fi -.PP -You may also want to set the application's color specification. See QApplication::setColorSpec() for more information. -.PP -See also leaveAllocContext(), currentAllocContext(), destroyAllocContext(), and QApplication::setColorSpec(). -.PP -Example: showimg/showimg.cpp. -.SH "void QColor::getHsv ( int * h, int * s, int * v ) const" -Returns the current RGB value as HSV. The contents of the \fIh\fR, \fIs\fR and \fIv\fR pointers are set to the HSV values. If any of the three pointers are null, the function does nothing. -.PP -The hue (which \fIh\fR points to) is set to -1 if the color is achromatic. -.PP -\fBWarning:\fR Colors are stored internally as RGB values, so getHSv() may return slightly different values to those set by setHsv(). -.PP -See also setHsv() and rgb(). -.SH "void QColor::getHsv ( int & h, int & s, int & v ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QColor::getRgb ( int * r, int * g, int * b ) const" -Sets the contents pointed to by \fIr\fR, \fIg\fR and \fIb\fR to the red, green and blue components of the RGB value respectively. The value range for a component is 0..255. -.PP -See also rgb(), setRgb(), and getHsv(). -.SH "int QColor::green () const" -Returns the G (green) component of the RGB value. -.SH "void QColor::hsv ( int * h, int * s, int * v ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use getHsv() instead. -.PP -Example: themes/metal.cpp. -.SH "void QColor::initialize ()\fC [static]\fR" -Internal initialization required for QColor. This function is called from the QApplication constructor. -.PP -See also cleanup(). -.SH "bool QColor::isValid () const" -Returns FALSE if the color is invalid, i.e. it was constructed using the default constructor; otherwise returns TRUE. -.PP -Examples: -.)l chart/element.cpp, chart/setdataform.cpp, and scribble/scribble.cpp. -.SH "void QColor::leaveAllocContext ()\fC [static]\fR" -Leaves a color allocation context. -.PP -See enterAllocContext() for a detailed explanation. -.PP -See also enterAllocContext() and currentAllocContext(). -.PP -Example: showimg/showimg.cpp. -.SH "QColor QColor::light ( int factor = 150 ) const" -Returns a lighter (or darker) color, but does not change this object. -.PP -Returns a lighter color if \fIfactor\fR is greater than 100. Setting \fIfactor\fR to 150 returns a color that is 50% brighter. -.PP -Returns a darker color if \fIfactor\fR is less than 100. We recommend using dark() for this purpose. If \fIfactor\fR is 0 or negative, the return value is unspecified. -.PP -(This function converts the current RGB color to HSV, multiplies V by \fIfactor\fR, and converts the result back to RGB.) -.PP -See also dark(). -.PP -Examples: -.)l desktop/desktop.cpp and themes/wood.cpp. -.SH "int QColor::maxColors ()\fC [static]\fR" -Returns the maximum number of colors supported by the underlying window system if the window system uses a palette. -.PP -Otherwise returns -1. Use numBitPlanes() to calculate the available colors in that case. -.SH "QString QColor::name () const" -Returns the name of the color in the format "#RRGGBB", i.e. a "#" character followed by three two-digit hexadecimal numbers. -.PP -See also setNamedColor(). -.PP -Example: chart/setdataform.cpp. -.SH "int QColor::numBitPlanes ()\fC [static]\fR" -Returns the number of color bit planes for the underlying window system. -.PP -The returned value is equal to the default pixmap depth. -.PP -See also QPixmap::defaultDepth(). -.SH "bool QColor::operator!= ( const QColor & c ) const" -Returns TRUE if this color has a different RGB value from \fIc\fR; otherwise returns FALSE. -.SH "QColor & QColor::operator= ( const QColor & c )" -Assigns a copy of the color \fIc\fR and returns a reference to this color. -.SH "bool QColor::operator== ( const QColor & c ) const" -Returns TRUE if this color has the same RGB value as \fIc\fR; otherwise returns FALSE. -.SH "uint QColor::pixel () const" -Returns the pixel value. -.PP -This value is used by the underlying window system to refer to a color. It can be thought of as an index into the display hardware's color table, but the value is an arbitrary 32-bit value. -.PP -See also alloc(). -.SH "uint QColor::pixel ( int screen ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the pixel value for screen \fIscreen\fR. -.PP -This value is used by the underlying window system to refer to a color. It can be thought of as an index into the display hardware's color table, but the value is an arbitrary 32-bit value. -.PP -See also alloc(). -.SH "int QColor::red () const" -Returns the R (red) component of the RGB value. -.SH "QRgb QColor::rgb () const" -Returns the RGB value. -.PP -The return type \fIQRgb\fR is equivalent to \fCunsigned\fR \fCint\fR. -.PP -For an invalid color, the alpha value of the returned color is unspecified. -.PP -See also setRgb(), hsv(), tqRed(), tqBlue(), tqGreen(), and isValid(). -.SH "void QColor::rgb ( int * r, int * g, int * b ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use getRgb() instead -.SH "void QColor::setHsv ( int h, int s, int v )" -Sets a HSV color value. \fIh\fR is the hue, \fIs\fR is the saturation and \fIv\fR is the value of the HSV color. -.PP -If \fIs\fR or \fIv\fR are not in the range 0-255, or \fIh\fR is < -1, the color is not changed. -.PP -\fBWarning:\fR Colors are stored internally as RGB values, so getHSv() may return slightly different values to those set by setHsv(). -.PP -See also hsv() and setRgb(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp, grapher/grapher.cpp, and progress/progress.cpp. -.SH "void QColor::setNamedColor ( const QString & name )" -Sets the RGB value to \fIname\fR, which may be in one of these formats: -.TP -#RGB (each of R, G and B is a single hex digit) -.TP -#RRGGBB -.TP -#RRRGGGBBB -.TP -#RRRRGGGGBBBB -.TP -A name from the X color database (rgb.txt) (e.g." steelblue" or "gainsboro"). These color names also work under Windows. -.PP -The color is invalid if \fIname\fR cannot be parsed. -.SH "void QColor::setRgb ( int r, int g, int b )" -Sets the RGB value to \fIr\fR, \fIg\fR, \fIb\fR. The arguments, \fIr\fR, \fIg\fR and \fIb\fR must all be in the range 0..255. If any of them are outside the legal range, the color is not changed. -.PP -See also rgb() and setHsv(). -.SH "void QColor::setRgb ( QRgb rgb )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the RGB value to \fIrgb\fR. -.PP -The type \fIQRgb\fR is equivalent to \fCunsigned\fR \fCint\fR. -.PP -See also rgb() and setHsv(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QColor & c )" -Writes a color object, \fIc\fR to the stream, \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QColor & c )" -Reads a color object, \fIc\fR, from the stream, \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "int tqAlpha ( QRgb rgba )" -Returns the alpha component of the RGBA quadruplet \fIrgba\fR. -.SH "int tqBlue ( QRgb rgb )" -Returns the blue component of the RGB triplet \fIrgb\fR. -.PP -See also tqRgb() and QColor::blue(). -.SH "int tqGray ( int r, int g, int b )" -Returns a gray value 0..255 from the (\fIr\fR, \fIg\fR, \fIb\fR) triplet. -.PP -The gray value is calculated using the formula (r*11 + g*16 + b*5)/32. -.SH "int tqGray ( tqRgb rgb )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a gray value 0..255 from the given \fIrgb\fR colour. -.SH "int tqGreen ( QRgb rgb )" -Returns the green component of the RGB triplet \fIrgb\fR. -.PP -See also tqRgb() and QColor::green(). -.SH "int tqRed ( QRgb rgb )" -Returns the red component of the RGB triplet \fIrgb\fR. -.PP -See also tqRgb() and QColor::red(). -.SH "QRgb tqRgb ( int r, int g, int b )" -Returns the RGB triplet \fI(r,g,b)\fR. -.PP -The return type QRgb is equivalent to \fCunsigned\fR \fCint\fR. -.PP -See also tqRgba(), tqRed(), tqGreen(), and tqBlue(). -.SH "QRgb tqRgba ( int r, int g, int b, int a )" -Returns the RGBA quadruplet \fI(r,g,b,a)\fR. -.PP -The return type QRgba is equivalent to \fCunsigned\fR \fCint\fR. -.PP -See also tqRgb(), tqRed(), tqGreen(), and tqBlue(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcolor.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcolor.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcolordialog.3qt b/doc/man/man3/qcolordialog.3qt deleted file mode 100644 index fb27ff8d9..000000000 --- a/doc/man/man3/qcolordialog.3qt +++ /dev/null @@ -1,80 +0,0 @@ -'\" t -.TH QColorDialog 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 -QColorDialog \- Dialog widget for specifying colors -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Static Public Members" -
            1. QColor \fBgetColor\fR ( const QColor & initial = white, QWidget * parent = 0, const char * name = 0 )
            2. QRgb \fBgetRgba\fR ( QRgb initial, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )
            3. int \fBcustomCount\fR ()
            4. QRgb \fBcustomColor\fR ( int i )
            5. void \fBsetCustomColor\fR ( int i, QRgb c )
            6. void \fBsetStandardColor\fR ( int i, QRgb c ) -.SH DESCRIPTION -The QColorDialog class provides a dialog widget for specifying colors. -.PP -The color dialog's function is to allow users to choose colors. For example, you might use this in a drawing program to allow the user to set the brush color. -.PP -The static functions provide modal color dialogs. -.PP -The static getColor() function shows the dialog and allows the user to specify a color. The getRgba() function does the same but also allows the user to specify a color with an alpha channel (transparency) value. -.PP -The user can store customCount() different custom colors. The custom colors are shared by all color dialogs, and remembered during the execution of the program. Use setCustomColor() to set the custom colors, and use customColor() to get them. -.PP -
              -.ce 1 -.B "[Image Omitted]" -.PP -
              -.PP -See also Dialog Classes and Graphics Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QRgb QColorDialog::customColor ( int i )\fC [static]\fR" -Returns custom color number \fIi\fR as a QRgb. -.SH "int QColorDialog::customCount ()\fC [static]\fR" -Returns the number of custom colors supported by QColorDialog. All color dialogs share the same custom colors. -.SH "QColor QColorDialog::getColor ( const QColor & initial = white, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Pops up a modal color dialog, lets the user choose a color, and returns that color. The color is initially set to \fIinitial\fR. The dialog is a child of \fIparent\fR and is called \fIname\fR. It returns an invalid (see QColor::isValid()) color if the user cancels the dialog. All colors allocated by the dialog will be deallocated before this function returns. -.PP -Examples: -.)l chart/setdataform.cpp and scribble/scribble.cpp. -.SH "QRgb QColorDialog::getRgba ( QRgb initial, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Pops up a modal color dialog to allow the user to choose a color and an alpha channel (transparency) value. The color+alpha is initially set to \fIinitial\fR. The dialog is a child of \fIparent\fR and called \fIname\fR. -.PP -If \fIok\fR is non-null, \fI*\fR\fIok\fR is set to TRUE if the user clicked OK, and to FALSE if the user clicked Cancel. -.PP -If the user clicks Cancel, the \fIinitial\fR value is returned. -.SH "void QColorDialog::setCustomColor ( int i, QRgb c )\fC [static]\fR" -Sets custom color number \fIi\fR to the QRgb value \fIc\fR. -.SH "void QColorDialog::setStandardColor ( int i, QRgb c )\fC [static]\fR" -Sets standard color number \fIi\fR to the QRgb value \fIc\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcolordialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcolordialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcolordrag.3qt b/doc/man/man3/qcolordrag.3qt deleted file mode 100644 index 9bc797b6e..000000000 --- a/doc/man/man3/qcolordrag.3qt +++ /dev/null @@ -1,82 +0,0 @@ -'\" t -.TH QColorDrag 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 -QColorDrag \- Drag and drop object for transferring colors -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QStoredDrag. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQColorDrag\fR ( const QColor & col, QWidget * dragsource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQColorDrag\fR ( QWidget * dragsource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "void \fBsetColor\fR ( const QColor & col )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBcanDecode\fR ( QMimeSource * e )" -.br -.ti -1c -.BI "bool \fBdecode\fR ( QMimeSource * e, QColor & col )" -.br -.in -1c -.SH DESCRIPTION -The QColorDrag class provides a drag and drop object for transferring colors. -.PP -This class provides a drag object which can be used to transfer data about colors for drag and drop and in the clipboard. For example, it is used in QColorDialog. -.PP -The color is set in the constructor but can be changed with setColor(). -.PP -For more information about drag and drop, see the QDragObject class and the drag and drop documentation. -.PP -See also Drag And Drop Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QColorDrag::QColorDrag ( const QColor & col, QWidget * dragsource = 0, const char * name = 0 )" -Constructs a color drag object with the color \fIcol\fR. Passes \fIdragsource\fR and \fIname\fR to the QStoredDrag constructor. -.SH "QColorDrag::QColorDrag ( QWidget * dragsource = 0, const char * name = 0 )" -Constructs a color drag object with a white color. Passes \fIdragsource\fR and \fIname\fR to the QStoredDrag constructor. -.SH "bool QColorDrag::canDecode ( QMimeSource * e )\fC [static]\fR" -Returns TRUE if the color drag object can decode the mime source \fIe\fR; otherwise returns FALSE. -.SH "bool QColorDrag::decode ( QMimeSource * e, QColor & col )\fC [static]\fR" -Decodes the mime source \fIe\fR and sets the decoded values to \fIcol\fR. -.SH "void QColorDrag::setColor ( const QColor & col )" -Sets the color of the color drag to \fIcol\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcolordrag.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcolordrag.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcolorgroup.3qt b/doc/man/man3/qcolorgroup.3qt deleted file mode 100644 index 10f8f0390..000000000 --- a/doc/man/man3/qcolorgroup.3qt +++ /dev/null @@ -1,358 +0,0 @@ -'\" t -.TH QColorGroup 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 -QColorGroup \- Group of widget colors -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQColorGroup\fR ()" -.br -.ti -1c -.BI "QColorGroup ( const QColor & foreground, const QColor & background, const QColor & light, const QColor & dark, const QColor & mid, const QColor & text, const QColor & base ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "\fBQColorGroup\fR ( const QBrush & foreground, const QBrush & button, const QBrush & light, const QBrush & dark, const QBrush & mid, const QBrush & text, const QBrush & bright_text, const QBrush & base, const QBrush & background )" -.br -.ti -1c -.BI "\fBQColorGroup\fR ( const QColorGroup & other )" -.br -.ti -1c -.BI "\fB~QColorGroup\fR ()" -.br -.ti -1c -.BI "QColorGroup & \fBoperator=\fR ( const QColorGroup & other )" -.br -.ti -1c -.BI "enum \fBColorRole\fR { Foreground, Button, Light, Midlight, Dark, Mid, Text, BrightText, ButtonText, Base, Background, Shadow, Highlight, HighlightedText, Link, LinkVisited, NColorRoles }" -.br -.ti -1c -.BI "const QColor & \fBcolor\fR ( ColorRole r ) const" -.br -.ti -1c -.BI "const QBrush & \fBbrush\fR ( ColorRole r ) const" -.br -.ti -1c -.BI "void \fBsetColor\fR ( ColorRole r, const QColor & c )" -.br -.ti -1c -.BI "void \fBsetBrush\fR ( ColorRole r, const QBrush & b )" -.br -.ti -1c -.BI "const QColor & \fBforeground\fR () const" -.br -.ti -1c -.BI "const QColor & \fBbutton\fR () const" -.br -.ti -1c -.BI "const QColor & \fBlight\fR () const" -.br -.ti -1c -.BI "const QColor & \fBdark\fR () const" -.br -.ti -1c -.BI "const QColor & \fBmid\fR () const" -.br -.ti -1c -.BI "const QColor & \fBtext\fR () const" -.br -.ti -1c -.BI "const QColor & \fBbase\fR () const" -.br -.ti -1c -.BI "const QColor & \fBbackground\fR () const" -.br -.ti -1c -.BI "const QColor & \fBmidlight\fR () const" -.br -.ti -1c -.BI "const QColor & \fBbrightText\fR () const" -.br -.ti -1c -.BI "const QColor & \fBbuttonText\fR () const" -.br -.ti -1c -.BI "const QColor & \fBshadow\fR () const" -.br -.ti -1c -.BI "const QColor & \fBhighlight\fR () const" -.br -.ti -1c -.BI "const QColor & \fBhighlightedText\fR () const" -.br -.ti -1c -.BI "const QColor & \fBlink\fR () const" -.br -.ti -1c -.BI "const QColor & \fBlinkVisited\fR () const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QColorGroup & g ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QColorGroup & g ) const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QColorGroup & g )" -.br -.in -1c -.SH DESCRIPTION -The QColorGroup class contains a group of widget colors. -.PP -A color group contains a group of colors used by widgets for drawing themselves. We recommend that widgets use color group roles such as "foreground" and "base" rather than literal colors like "red" or "turquoise". The color roles are enumerated and defined in the ColorRole documentation. -.PP -The most common use of QColorGroup is like this: -.PP -.nf -.br - QPainter p; -.br - ... -.br - p.setPen( colorGroup().foreground() ); -.br - p.drawLine( ... ) -.br -.fi -.PP -It is also possible to modify color groups or create new color groups from scratch. -.PP -The color group class can be created using three different constructors or by modifying one supplied by Qt. The default constructor creates an all-black color group, which can then be modified using set functions; there's also a constructor for specifying all the color group colors. And there is also a copy constructor. -.PP -We strongly recommend using a system-supplied color group and modifying that as necessary. -.PP -You modify a color group by calling the access functions setColor() and setBrush(), depending on whether you want a pure color or a pixmap pattern. -.PP -There are also corresponding color() and brush() getters, and a commonly used convenience function to get each ColorRole: background(), foreground(), base(), etc. -.PP -See also QColor, QPalette, QWidget::colorGroup, Widget Appearance and Style, Graphics Classes, and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QColorGroup::ColorRole" -The ColorRole enum defines the different symbolic color roles used in current GUIs. -.PP -The central roles are: -.TP -\fCQColorGroup::Background\fR - general background color. -.TP -\fCQColorGroup::Foreground\fR - general foreground color. -.TP -\fCQColorGroup::Base\fR - used as background color for text entry widgets, for example; usually white or another light color. -.TP -\fCQColorGroup::Text\fR - the foreground color used with Base. Usually this is the same as the Foreground, in which case it must provide good contrast with Background and Base. -.TP -\fCQColorGroup::Button\fR - general button background color in which buttons need a background different from Background, as in the Macintosh style. -.TP -\fCQColorGroup::ButtonText\fR - a foreground color used with the Button color. -.PP -There are some color roles used mostly for 3D bevel and shadow effects: -.TP -\fCQColorGroup::Light\fR - lighter than Button color. -.TP -\fCQColorGroup::Midlight\fR - between Button and Light. -.TP -\fCQColorGroup::Dark\fR - darker than Button. -.TP -\fCQColorGroup::Mid\fR - between Button and Dark. -.TP -\fCQColorGroup::Shadow\fR - a very dark color. By default, the shadow color is \fCQt::black\fR. -.PP -All of these are normally derived from Background and used in ways that depend on that relationship. For example, buttons depend on it to make the bevels look attractive, and Motif scroll bars depend on Mid to be slightly different from Background. -.PP -Selected (marked) items have two roles: -.TP -\fCQColorGroup::Highlight\fR - a color to indicate a selected item or the current item. By default, the highlight color is \fCQt::darkBlue\fR. -.TP -\fCQColorGroup::HighlightedText\fR - a text color that contrasts with Highlight. By default, the highlighted text color is \fCQt::white\fR. -.PP -Finally, there is a special role for text that needs to be drawn where Text or Foreground would give poor contrast, such as on pressed push buttons: -.TP -\fCQColorGroup::BrightText\fR - a text color that is very different from Foreground and contrasts well with e.g. Dark. -.TP -\fCQColorGroup::Link\fR - a text color used for unvisited hyperlinks. By default, the link color is \fCQt::blue\fR. -.TP -\fCQColorGroup::LinkVisited\fR - a text color used for already visited hyperlinks. By default, the linkvisited color is \fCQt::magenta\fR. -.TP -\fCQColorGroup::NColorRoles\fR - Internal. -.PP -Note that text colors can be used for things other than just words; text colors are \fIusually\fR used for text, but it's quite common to use the text color roles for lines, icons, etc. -.PP -This image shows most of the color roles in use:
              -.ce 1 -.B "[Image Omitted]" -.PP -
              -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QColorGroup::QColorGroup ()" -Constructs a color group with all colors set to black. -.SH "QColorGroup::QColorGroup ( const QColor & foreground, const QColor & background, const QColor & light, const QColor & dark, const QColor & mid, const QColor & text, const QColor & base )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Constructs a color group with the specified colors. The button color will be set to the background color. -.SH "QColorGroup::QColorGroup ( const QBrush & foreground, const QBrush & button, const QBrush & light, const QBrush & dark, const QBrush & mid, const QBrush & text, const QBrush & bright_text, const QBrush & base, const QBrush & background )" -Constructs a color group. You can pass either brushes, pixmaps or plain colors for \fIforeground\fR, \fIbutton\fR, \fIlight\fR, \fIdark\fR, \fImid\fR, \fItext\fR, \fIbright_text\fR, \fIbase\fR and \fIbackground\fR. -.PP -See also QBrush. -.SH "QColorGroup::QColorGroup ( const QColorGroup & other )" -Constructs a color group that is an independent copy of \fIother\fR. -.SH "QColorGroup::~QColorGroup ()" -Destroys the color group. -.SH "const QColor & QColorGroup::background () const" -Returns the background color of the color group. -.PP -See also ColorRole. -.SH "const QColor & QColorGroup::base () const" -Returns the base color of the color group. -.PP -See also ColorRole. -.SH "const QColor & QColorGroup::brightText () const" -Returns the bright text foreground color of the color group. -.PP -See also ColorRole. -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QBrush & QColorGroup::brush ( ColorRole r ) const" -Returns the brush that has been set for color role \fIr\fR. -.PP -See also color(), setBrush(), and ColorRole. -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QColor & QColorGroup::button () const" -Returns the button color of the color group. -.PP -See also ColorRole. -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QColor & QColorGroup::buttonText () const" -Returns the button text foreground color of the color group. -.PP -See also ColorRole. -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QColor & QColorGroup::color ( ColorRole r ) const" -Returns the color that has been set for color role \fIr\fR. -.PP -See also brush() and ColorRole. -.SH "const QColor & QColorGroup::dark () const" -Returns the dark color of the color group. -.PP -See also ColorRole. -.PP -Example: themes/wood.cpp. -.SH "const QColor & QColorGroup::foreground () const" -Returns the foreground color of the color group. -.PP -See also ColorRole. -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QColor & QColorGroup::highlight () const" -Returns the highlight color of the color group. -.PP -See also ColorRole. -.SH "const QColor & QColorGroup::highlightedText () const" -Returns the highlighted text color of the color group. -.PP -See also ColorRole. -.SH "const QColor & QColorGroup::light () const" -Returns the light color of the color group. -.PP -See also ColorRole. -.PP -Example: themes/wood.cpp. -.SH "const QColor & QColorGroup::link () const" -Returns the unvisited link text color of the color group. -.PP -See also ColorRole. -.SH "const QColor & QColorGroup::linkVisited () const" -Returns the visited link text color of the color group. -.PP -See also ColorRole. -.SH "const QColor & QColorGroup::mid () const" -Returns the mid color of the color group. -.PP -See also ColorRole. -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QColor & QColorGroup::midlight () const" -Returns the midlight color of the color group. -.PP -See also ColorRole. -.SH "bool QColorGroup::operator!= ( const QColorGroup & g ) const" -Returns TRUE if this color group is different from \fIg\fR; otherwise returns FALSE. -.PP -See also -.SH "QColorGroup & QColorGroup::operator= ( const QColorGroup & other )" -Copies the colors of \fIother\fR to this color group. -.SH "bool QColorGroup::operator== ( const QColorGroup & g ) const" -Returns TRUE if this color group is equal to \fIg\fR; otherwise returns FALSE. -.PP -See also -.SH "void QColorGroup::setBrush ( ColorRole r, const QBrush & b )" -Sets the brush used for color role \fIr\fR to \fIb\fR. -.PP -See also brush(), setColor(), and ColorRole. -.PP -Example: themes/wood.cpp. -.SH "void QColorGroup::setColor ( ColorRole r, const QColor & c )" -Sets the brush used for color role \fIr\fR to a solid color \fIc\fR. -.PP -See also brush() and ColorRole. -.PP -Examples: -.)l listviews/listviews.cpp, table/statistics/statistics.cpp, and themes/metal.cpp. -.SH "const QColor & QColorGroup::shadow () const" -Returns the shadow color of the color group. -.PP -See also ColorRole. -.SH "const QColor & QColorGroup::text () const" -Returns the text foreground color of the color group. -.PP -See also ColorRole. -.PP -Example: listviews/listviews.cpp. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QColorGroup & g )" -Writes color group, \fIg\fR to the stream \fIs\fR. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcolorgroup.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcolorgroup.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcombobox.3qt b/doc/man/man3/qcombobox.3qt deleted file mode 100644 index cf337e56b..000000000 --- a/doc/man/man3/qcombobox.3qt +++ /dev/null @@ -1,603 +0,0 @@ -'\" t -.TH QComboBox 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 -QComboBox \- Combined button and popup list -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQComboBox\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQComboBox\fR ( bool rw, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QComboBox\fR ()" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "void \fBinsertStringList\fR ( const QStringList & list, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertStrList\fR ( const QStrList & list, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertStrList\fR ( const QStrList * list, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertStrList\fR ( const char ** strings, int numStrings = -1, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QString & t, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, const QString & text, int index = -1 )" -.br -.ti -1c -.BI "void \fBremoveItem\fR ( int index )" -.br -.ti -1c -.BI "int \fBcurrentItem\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCurrentItem\fR ( int index )" -.br -.ti -1c -.BI "QString \fBcurrentText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCurrentText\fR ( const QString & )" -.br -.ti -1c -.BI "QString \fBtext\fR ( int index ) const" -.br -.ti -1c -.BI "const QPixmap * \fBpixmap\fR ( int index ) const" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( const QString & t, int index )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( const QPixmap & im, int index )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( const QPixmap & im, const QString & t, int index )" -.br -.ti -1c -.BI "bool autoResize () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void setAutoResize ( bool ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void \fBsetPalette\fR ( const QPalette & palette )" -.br -.ti -1c -.BI "virtual void \fBsetFont\fR ( const QFont & font )" -.br -.ti -1c -.BI "virtual void \fBsetSizeLimit\fR ( int )" -.br -.ti -1c -.BI "int \fBsizeLimit\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMaxCount\fR ( int )" -.br -.ti -1c -.BI "int \fBmaxCount\fR () const" -.br -.ti -1c -.BI "enum \fBPolicy\fR { NoInsertion, AtTop, AtCurrent, AtBottom, AfterCurrent, BeforeCurrent }" -.br -.ti -1c -.BI "virtual void \fBsetInsertionPolicy\fR ( Policy policy )" -.br -.ti -1c -.BI "Policy \fBinsertionPolicy\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetValidator\fR ( const QValidator * v )" -.br -.ti -1c -.BI "const QValidator * \fBvalidator\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetListBox\fR ( QListBox * newListBox )" -.br -.ti -1c -.BI "QListBox * \fBlistBox\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetLineEdit\fR ( QLineEdit * edit )" -.br -.ti -1c -.BI "QLineEdit * \fBlineEdit\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoCompletion\fR ( bool )" -.br -.ti -1c -.BI "bool \fBautoCompletion\fR () const" -.br -.ti -1c -.BI "void \fBsetDuplicatesEnabled\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBduplicatesEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBeditable\fR () const" -.br -.ti -1c -.BI "void \fBsetEditable\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBpopup\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "void \fBclearValidator\fR ()" -.br -.ti -1c -.BI "void \fBclearEdit\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetEditText\fR ( const QString & newText )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBactivated\fR ( int index )" -.br -.ti -1c -.BI "void \fBhighlighted\fR ( int index )" -.br -.ti -1c -.BI "void \fBactivated\fR ( const QString & string )" -.br -.ti -1c -.BI "void \fBhighlighted\fR ( const QString & string )" -.br -.ti -1c -.BI "void \fBtextChanged\fR ( const QString & string )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoCompletion\fR - whether auto-completion is enabled" -.br -.ti -1c -.BI "bool \fBautoMask\fR - whether the combobox is automatically masked \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool autoResize - whether auto resize is enabled \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBcount\fR - the number of items in the combobox \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcurrentItem\fR - the index of the current item in the combobox" -.br -.ti -1c -.BI "QString \fBcurrentText\fR - the text of the combobox's current item" -.br -.ti -1c -.BI "bool \fBduplicatesEnabled\fR - whether duplicates are allowed" -.br -.ti -1c -.BI "bool \fBeditable\fR - whether the combobox is editable" -.br -.ti -1c -.BI "Policy \fBinsertionPolicy\fR - the position of the items inserted by the user" -.br -.ti -1c -.BI "int \fBmaxCount\fR - the maximum number of items allowed in the combobox" -.br -.ti -1c -.BI "int \fBsizeLimit\fR - the maximum on-screen size of the combobox" -.br -.in -1c -.SH DESCRIPTION -The QComboBox widget is a combined button and popup list. -.PP -A combobox is a selection widget which displays the current item and can pop up a list of items. A combobox may be editable in which case the user can enter arbitrary strings. -.PP -Comboboxes provide a means of showing the user's current choice out of a list of options in a way that takes up the minimum amount of screen space. -.PP -QComboBox supports three different display styles: Aqua/Motif 1.x, Motif 2.0 and Windows. In Motif 1.x, a combobox was called XmOptionMenu. In Motif 2.0, OSF introduced an improved combobox and named that XmComboBox. QComboBox provides both. -.PP -QComboBox provides two different constructors. The simplest constructor creates an "old-style" combobox in Motif (or Aqua) style: -.PP -.nf -.br - QComboBox *c = new QComboBox( this, "read-only combobox" ); -.br -.fi -.PP -The other constructor creates a new-style combobox in Motif style, and can create both read-only and editable comboboxes: -.PP -.nf -.br - QComboBox *c1 = new QComboBox( FALSE, this, "read-only combobox" ); -.br - QComboBox *c2 = new QComboBox( TRUE, this, "editable combobox" ); -.br -.fi -.PP -New-style comboboxes use a list box in both Motif and Windows styles, and both the content size and the on-screen size of the list box can be limited with sizeLimit() and setMaxCount() respectively. Old-style comboboxes use a popup in Aqua and Motif style, and that popup will happily grow larger than the desktop if you put enough data into it. -.PP -The two constructors create identical-looking comboboxes in Windows style. -.PP -Comboboxes can contain pixmaps as well as strings; the insertItem() and changeItem() functions are suitably overloaded. For editable comboboxes, the function clearEdit() is provided, to clear the displayed string without changing the combobox's contents. -.PP -A combobox emits two signals, activated() and highlighted(), when a new item has been activated (selected) or highlighted (made current). Both signals exist in two versions, one with a QString argument and one with an \fCint\fR argument. If the user highlights or activates a pixmap, only the \fCint\fR signals are emitted. Whenever the text of an editable combobox is changed the textChanged() signal is emitted. -.PP -When the user enters a new string in an editable combobox, the widget may or may not insert it, and it can insert it in several locations. The default policy is is AtBottom but you can change this using setInsertionPolicy(). -.PP -It is possible to constrain the input to an editable combobox using QValidator; see setValidator(). By default, any input is accepted. -.PP -If the combobox is not editable then it has a default focusPolicy() of TabFocus, i.e. it will not grab focus if clicked. This differs from both Windows and Motif. If the combobox is editable then it has a default focusPolicy() of StrongFocus, i.e. it will grab focus if clicked. -.PP -A combobox can be populated using the insert functions, insertStringList() and insertItem() for example. Items can be changed with changeItem(). An item can be removed with removeItem() and all items can be removed with clear(). The text of the current item is returned by currentText(), and the text of a numbered item is returned with text(). The current item can be set with setCurrentItem() or setCurrentText(). The number of items in the combobox is returned by count(); the maximum number of items can be set with setMaxCount(). You can allow editing using setEditable(). For editable comboboxes you can set auto-completion using setAutoCompletion() and whether or not the user can add duplicates is set with setDuplicatesEnabled(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP -(Motif 1, read-only) -.br -.ce 1 -.B "[Image Omitted]" -.PP -(Motif 2, editable) -.br -.ce 1 -.B "[Image Omitted]" -.PP -(Motif 2, read-only) -.br -.ce 1 -.B "[Image Omitted]" -.PP -(Windows style) -.PP -Depending on the style, QComboBox will use a QListBox or a QPopupMenu to display the list of items. See setListBox() for more information. -.PP -See also QLineEdit, QListBox, QSpinBox, QRadioButton, QButtonGroup, GUI Design Handbook: Combo Box, GUI Design Handbook: Drop-Down List Box, and Basic Widgets. -.SS "Member Type Documentation" -.SH "QComboBox::Policy" -This enum specifies what the QComboBox should do when a new string is entered by the user. -.TP -\fCQComboBox::NoInsertion\fR - the string will not be inserted into the combobox. -.TP -\fCQComboBox::AtTop\fR - insert the string as the first item in the combobox. -.TP -\fCQComboBox::AtCurrent\fR - replace the previously selected item with the string the user has entered. -.TP -\fCQComboBox::AtBottom\fR - insert the string as the last item in the combobox. -.TP -\fCQComboBox::AfterCurrent\fR - insert the string after the previously selected item. -.TP -\fCQComboBox::BeforeCurrent\fR - insert the string before the previously selected item. -.PP -activated() is always emitted when the string is entered. -.PP -If inserting the new string would cause the combobox to breach its content size limit, the item at the other end of the list is deleted. The definition of "other end" is implementation-dependent. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QComboBox::QComboBox ( QWidget * parent = 0, const char * name = 0 )" -Constructs a combobox widget with parent \fIparent\fR called \fIname\fR. -.PP -This constructor creates a popup list if the program uses Motif (or Aqua) look and feel; this is compatible with Motif 1.x and Aqua. -.PP -Note: If you use this constructor to create your QComboBox, then the pixmap() function will always return 0. To workaround this, use the other constructor. -.SH "QComboBox::QComboBox ( bool rw, QWidget * parent = 0, const char * name = 0 )" -Constructs a combobox with a maximum size and either Motif 2.0 or Windows look and feel. -.PP -The input field can be edited if \fIrw\fR is TRUE, otherwise the user may only choose one of the items in the combobox. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. -.SH "QComboBox::~QComboBox ()" -Destroys the combobox. -.SH "void QComboBox::activated ( int index )\fC [signal]\fR" -This signal is emitted when a new item has been activated (selected). The \fIindex\fR is the position of the item in the combobox. -.PP -This signal is not emitted if the item is changed programmatically, e.g. using setCurrentItem(). -.PP -Examples: -.)l fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, lineedits/lineedits.cpp, listboxcombo/listboxcombo.cpp, and qmag/qmag.cpp. -.SH "void QComboBox::activated ( const QString & string )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when a new item has been activated (selected). \fIstring\fR is the selected string. -.PP -You can also use the activated(int) signal, but be aware that its argument is meaningful only for selected strings, not for user entered strings. -.SH "bool QComboBox::autoCompletion () const" -Returns TRUE if auto-completion is enabled; otherwise returns FALSE. See the "autoCompletion" property for details. -.SH "bool QComboBox::autoResize () const" -Returns TRUE if auto resize is enabled; otherwise returns FALSE. See the "autoResize" property for details. -.SH "void QComboBox::changeItem ( const QString & t, int index )" -Replaces the item at position \fIindex\fR with the text \fIt\fR. -.SH "void QComboBox::changeItem ( const QPixmap & im, int index )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces the item at position \fIindex\fR with the pixmap \fIim\fR, unless the combobox is editable. -.PP -See also insertItem(). -.SH "void QComboBox::changeItem ( const QPixmap & im, const QString & t, int index )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces the item at position \fIindex\fR with the pixmap \fIim\fR and the text \fIt\fR. -.PP -See also insertItem(). -.SH "void QComboBox::clear ()\fC [slot]\fR" -Removes all combobox items. -.SH "void QComboBox::clearEdit ()\fC [slot]\fR" -Clears the line edit without changing the combobox's contents. Does nothing if the combobox isn't editable. -.PP -This is particularly useful when using a combobox as a line edit with history. For example you can connect the combobox's activated() signal to clearEdit() in order to present the user with a new, empty line as soon as Enter is pressed. -.PP -See also setEditText(). -.SH "void QComboBox::clearValidator ()\fC [slot]\fR" -This slot is equivalent to setValidator( 0 ). -.SH "int QComboBox::count () const" -Returns the number of items in the combobox. See the "count" property for details. -.SH "int QComboBox::currentItem () const" -Returns the index of the current item in the combobox. See the "currentItem" property for details. -.SH "QString QComboBox::currentText () const" -Returns the text of the combobox's current item. See the "currentText" property for details. -.SH "bool QComboBox::duplicatesEnabled () const" -Returns TRUE if duplicates are allowed; otherwise returns FALSE. See the "duplicatesEnabled" property for details. -.SH "bool QComboBox::editable () const" -Returns TRUE if the combobox is editable; otherwise returns FALSE. See the "editable" property for details. -.SH "void QComboBox::highlighted ( int index )\fC [signal]\fR" -This signal is emitted when a new item has been set to be the current item. The \fIindex\fR is the position of the item in the combobox. -.PP -This signal is not emitted if the item is changed programmatically, e.g. using setCurrentItem(). -.SH "void QComboBox::highlighted ( const QString & string )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when a new item has been set to be the current item. \fIstring\fR is the item's text. -.PP -You can also use the highlighted(int) signal. -.SH "void QComboBox::insertItem ( const QString & t, int index = -1 )" -Inserts a text item with text \fIt\fR, at position \fIindex\fR. The item will be appended if \fIindex\fR is negative. -.PP -Examples: -.)l chart/optionsform.cpp, fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, lineedits/lineedits.cpp, listboxcombo/listboxcombo.cpp, regexptester/regexptester.cpp, and tictac/tictac.cpp. -.SH "void QComboBox::insertItem ( const QPixmap & pixmap, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a \fIpixmap\fR item at position \fIindex\fR. The item will be appended if \fIindex\fR is negative. -.SH "void QComboBox::insertItem ( const QPixmap & pixmap, const QString & text, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a \fIpixmap\fR item with additional text \fItext\fR at position \fIindex\fR. The item will be appended if \fIindex\fR is negative. -.SH "void QComboBox::insertStrList ( const char ** strings, int numStrings = -1, int index = -1 )" -Inserts the array of char * \fIstrings\fR at position \fIindex\fR in the combobox. -.PP -The \fInumStrings\fR argument is the number of strings. If \fInumStrings\fR is -1 (default), the \fIstrings\fR array must be terminated with 0. -.PP -Example: -.PP -.nf -.br - static const char* items[] = { "red", "green", "blue", 0 }; -.br - combo->insertStrList( items ); -.br -.fi -.PP -See also insertStringList(). -.PP -Example: qmag/qmag.cpp. -.SH "void QComboBox::insertStrList ( const QStrList & list, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the \fIlist\fR of strings at position \fIindex\fR in the combobox. -.PP -This is only for compatibility since it does not support Unicode strings. See insertStringList(). -.SH "void QComboBox::insertStrList ( const QStrList * list, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the \fIlist\fR of strings at position \fIindex\fR in the combobox. -.PP -This is only for compatibility since it does not support Unicode strings. See insertStringList(). -.SH "void QComboBox::insertStringList ( const QStringList & list, int index = -1 )" -Inserts the \fIlist\fR of strings at position \fIindex\fR in the combobox. -.SH "Policy QComboBox::insertionPolicy () const" -Returns the position of the items inserted by the user. See the "insertionPolicy" property for details. -.SH "QLineEdit * QComboBox::lineEdit () const" -Returns the line edit, or 0 if there is no line edit. -.PP -Only editable listboxes have a line editor. -.SH "QListBox * QComboBox::listBox () const" -Returns the current list box, or 0 if there is no list box. (QComboBox can use QPopupMenu instead of QListBox.) Provided to match setListBox(). -.PP -See also setListBox(). -.PP -Example: listboxcombo/listboxcombo.cpp. -.SH "int QComboBox::maxCount () const" -Returns the maximum number of items allowed in the combobox. See the "maxCount" property for details. -.SH "const QPixmap * QComboBox::pixmap ( int index ) const" -Returns the pixmap item at position \fIindex\fR, or 0 if the item is not a pixmap. -.SH "void QComboBox::popup ()\fC [virtual]\fR" -Pops up the combobox popup list. -.PP -If the list is empty, no items appear. -.SH "void QComboBox::removeItem ( int index )" -Removes the item at position \fIindex\fR. -.SH "void QComboBox::setAutoCompletion ( bool )\fC [virtual]\fR" -Sets whether auto-completion is enabled. See the "autoCompletion" property for details. -.SH "void QComboBox::setAutoResize ( bool )\fC [virtual]\fR" -Sets whether auto resize is enabled. See the "autoResize" property for details. -.SH "void QComboBox::setCurrentItem ( int index )\fC [virtual]\fR" -Sets the index of the current item in the combobox to \fIindex\fR. See the "currentItem" property for details. -.SH "void QComboBox::setCurrentText ( const QString & )\fC [virtual]\fR" -Sets the text of the combobox's current item. See the "currentText" property for details. -.SH "void QComboBox::setDuplicatesEnabled ( bool enable )" -Sets whether duplicates are allowed to \fIenable\fR. See the "duplicatesEnabled" property for details. -.SH "void QComboBox::setEditText ( const QString & newText )\fC [virtual slot]\fR" -Sets the text in the line edit to \fInewText\fR without changing the combobox's contents. Does nothing if the combobox isn't editable. -.PP -This is useful e.g. for providing a good starting point for the user's editing and entering the change in the combobox only when the user presses Enter. -.PP -See also clearEdit() and insertItem(). -.SH "void QComboBox::setEditable ( bool )" -Sets whether the combobox is editable. See the "editable" property for details. -.SH "void QComboBox::setFont ( const QFont & font )\fC [virtual]\fR" -Sets the font for both the combobox button and the combobox popup list to \fIfont\fR. -.PP -Reimplemented from QWidget. -.SH "void QComboBox::setInsertionPolicy ( Policy policy )\fC [virtual]\fR" -Sets the position of the items inserted by the user to \fIpolicy\fR. See the "insertionPolicy" property for details. -.SH "void QComboBox::setLineEdit ( QLineEdit * edit )\fC [virtual]\fR" -Sets the line edit to use \fIedit\fR instead of the current line edit. -.SH "void QComboBox::setListBox ( QListBox * newListBox )\fC [virtual]\fR" -Sets the combobox to use \fInewListBox\fR instead of the current list box or popup. As a side effect, it clears the combobox of its current contents. -.PP -\fBWarning:\fR QComboBox assumes that newListBox->text(n) returns non-null for 0 <= n < newListbox->count(). This assumption is necessary because of the line edit in QComboBox. -.SH "void QComboBox::setMaxCount ( int )\fC [virtual]\fR" -Sets the maximum number of items allowed in the combobox. See the "maxCount" property for details. -.SH "void QComboBox::setPalette ( const QPalette & palette )\fC [virtual]\fR" -Sets the palette for both the combobox button and the combobox popup list to \fIpalette\fR. -.PP -Reimplemented from QWidget. -.SH "void QComboBox::setSizeLimit ( int )\fC [virtual]\fR" -Sets the maximum on-screen size of the combobox. See the "sizeLimit" property for details. -.SH "void QComboBox::setValidator ( const QValidator * v )\fC [virtual]\fR" -Applies the validator \fIv\fR to the combobox so that only text which is valid according to \fIv\fR is accepted. -.PP -This function does nothing if the combobox is not editable. -.PP -See also validator(), clearValidator(), and QValidator. -.SH "int QComboBox::sizeLimit () const" -Returns the maximum on-screen size of the combobox. See the "sizeLimit" property for details. -.SH "QString QComboBox::text ( int index ) const" -Returns the text item at position \fIindex\fR, or QString::null if the item is not a string. -.PP -See also currentText. -.PP -Examples: -.)l fileiconview/mainwindow.cpp and helpviewer/helpwindow.cpp. -.SH "void QComboBox::textChanged ( const QString & string )\fC [signal]\fR" -This signal is used for editable comboboxes. It is emitted whenever the contents of the text entry field changes. \fIstring\fR contains the new text. -.SH "const QValidator * QComboBox::validator () const" -Returns the validator which constrains editing for this combobox if there is one; otherwise returns 0. -.PP -See also setValidator(), clearValidator(), and QValidator. -.SS "Property Documentation" -.SH "bool autoCompletion" -This property holds whether auto-completion is enabled. -.PP -This property can only be set for editable comboboxes, for non-editable comboboxes it has no effect. It is FALSE by default. -.PP -Set this property's value with setAutoCompletion() and get this property's value with autoCompletion(). -.SH "bool autoMask" -This property holds whether the combobox is automatically masked. -.PP -See also QWidget::autoMask. -.SH "bool autoResize" -This property holds whether auto resize is enabled. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -If this property is set to TRUE then the combobox will resize itself whenever its contents change. The default is FALSE. -.PP -Set this property's value with setAutoResize() and get this property's value with autoResize(). -.SH "int count" -This property holds the number of items in the combobox. -.PP -Get this property's value with count(). -.SH "int currentItem" -This property holds the index of the current item in the combobox. -.PP -Note that the activated() and highlighted() signals are only emitted when the user changes the current item, not when it is changed programmatically. -.PP -Set this property's value with setCurrentItem() and get this property's value with currentItem(). -.SH "QString currentText" -This property holds the text of the combobox's current item. -.PP -Set this property's value with setCurrentText() and get this property's value with currentText(). -.SH "bool duplicatesEnabled" -This property holds whether duplicates are allowed. -.PP -If the combobox is editable and the user enters some text in the combobox's lineedit and presses Enter (and the insertionPolicy() is not NoInsertion), then what happens is this: -.TP -If the text is not already in the list, the text is inserted. -.TP -If the text is in the list and this property is TRUE (the default), the text is inserted. -.TP -If the text is in the list and this property is FALSE, the text is \fInot\fR inserted; instead the item which has matching text becomes the current item. -.PP -This property only affects user-interaction. You can use insertItem() to insert duplicates if you wish regardless of this setting. -.PP -Set this property's value with setDuplicatesEnabled() and get this property's value with duplicatesEnabled(). -.SH "bool editable" -This property holds whether the combobox is editable. -.PP -This property's default is FALSE. Note that the combobox will be cleared if this property is set to TRUE for a 1.x Motif style combobox. To avoid this, use setEditable() before inserting any items. Also note that the 1.x version of Motif didn't have any editable comboboxes, so the combobox will change it's appearance to a 2.0 style Motif combobox is it is set to be editable. -.PP -Set this property's value with setEditable() and get this property's value with editable(). -.SH "Policy insertionPolicy" -This property holds the position of the items inserted by the user. -.PP -The default insertion policy is AtBottom. See Policy. -.PP -Set this property's value with setInsertionPolicy() and get this property's value with insertionPolicy(). -.SH "int maxCount" -This property holds the maximum number of items allowed in the combobox. -.PP -Set this property's value with setMaxCount() and get this property's value with maxCount(). -.SH "int sizeLimit" -This property holds the maximum on-screen size of the combobox. -.PP -This property is ignored for both Motif 1.x style and non-editable comboboxes in Mac style. The default limit is ten lines. If the number of items in the combobox is or grows larger than lines, a scrollbar is added. -.PP -Set this property's value with setSizeLimit() and get this property's value with sizeLimit(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcombobox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcombobox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcombotableitem.3qt b/doc/man/man3/qcombotableitem.3qt deleted file mode 100644 index 285fef2ad..000000000 --- a/doc/man/man3/qcombotableitem.3qt +++ /dev/null @@ -1,156 +0,0 @@ -'\" t -.TH QComboTableItem 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 -QComboTableItem \- Means of using comboboxes in QTables -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QTableItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQComboTableItem\fR ( QTable * table, const QStringList & list, bool editable = FALSE )" -.br -.ti -1c -.BI "\fB~QComboTableItem\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetCurrentItem\fR ( int i )" -.br -.ti -1c -.BI "virtual void \fBsetCurrentItem\fR ( const QString & s )" -.br -.ti -1c -.BI "int \fBcurrentItem\fR () const" -.br -.ti -1c -.BI "QString \fBcurrentText\fR () const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "QString \fBtext\fR ( int i ) const" -.br -.ti -1c -.BI "virtual void \fBsetEditable\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisEditable\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetStringList\fR ( const QStringList & l )" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QComboTableItem class provides a means of using comboboxes in QTables. -.PP -A QComboTableItem is a table item which looks and behaves like a combobox. The advantage of using QComboTableItems rather than real comboboxes is that a QComboTableItem uses far less resources than real comboboxes in QTables. When the cell has the focus it displays a real combobox which the user can interact with. When the cell does not have the focus the cell \fIlooks\fR like a combobox. Only text items (i.e. no pixmaps) may be used in QComboTableItems. -.PP -QComboTableItem items have the edit type WhenCurrent (see EditType). The QComboTableItem's list of items is provided by a QStringList passed to the constructor. -.PP -The list of items may be changed using setStringList(). The current item can be set with setCurrentItem() and retrieved with currentItem(). The text of the current item can be obtained with currentText(), and the text of a particular item can be retrieved with text(). -.PP -If isEditable() is TRUE the QComboTableItem will permit the user to either choose an existing list item, or create a new list item by entering their own text; otherwise the user may only choose one of the existing list items. -.PP -To populate a table cell with a QComboTableItem use QTable::setItem(). -.PP -QComboTableItems may be deleted with QTable::clearCell(). -.PP -QComboTableItems can be distinguished from QTableItems and QCheckTableItems using their Run Time Type Identification number (see rtti()). -.PP -
              -.ce 1 -.B "[Image Omitted]" -.PP -
              -.PP -See also QCheckTableItem, QTableItem, QComboBox, and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QComboTableItem::QComboTableItem ( QTable * table, const QStringList & list, bool editable = FALSE )" -Creates a combo table item for the table \fItable\fR. The combobox's list of items is passed in the \fIlist\fR argument. If \fIeditable\fR is TRUE the user may type in new list items; if \fIeditable\fR is FALSE the user may only select from the list of items provided. -.PP -By default QComboTableItems cannot be replaced by other table items since isReplaceable() returns FALSE by default. -.PP -See also QTable::clearCell() and EditType. -.SH "QComboTableItem::~QComboTableItem ()" -QComboTableItem destructor. -.SH "int QComboTableItem::count () const" -Returns the total number of list items in the combo table item. -.SH "int QComboTableItem::currentItem () const" -Returns the index of the combo table item's current list item. -.PP -See also setCurrentItem(). -.SH "QString QComboTableItem::currentText () const" -Returns the text of the combo table item's current list item. -.PP -See also currentItem() and text(). -.SH "bool QComboTableItem::isEditable () const" -Returns TRUE if the user can add their own list items to the combobox's list of items; otherwise returns FALSE. -.PP -See also setEditable(). -.SH "int QComboTableItem::rtti () const\fC [virtual]\fR" -Returns 1. -.PP -Make your derived classes return their own values for rtti()to distinguish between different table item subclasses. You should use values greater than 1000, preferably a large random number, to allow for extensions to this class. -.PP -See also QTableItem::rtti(). -.PP -Reimplemented from QTableItem. -.SH "void QComboTableItem::setCurrentItem ( int i )\fC [virtual]\fR" -Sets the list item \fIi\fR to be the combo table item's current list item. -.PP -See also currentItem(). -.PP -Example: table/small-table-demo/main.cpp. -.SH "void QComboTableItem::setCurrentItem ( const QString & s )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the list item whose text is \fIs\fR to be the combo table item's current list item. Does nothing if no list item has the text \fIs\fR. -.PP -See also currentItem(). -.SH "void QComboTableItem::setEditable ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE the combo table item can be edited, i.e. the user may enter a new text item themselves. If \fIb\fR is FALSE the user may may only choose one of the existing items. -.PP -See also isEditable(). -.SH "void QComboTableItem::setStringList ( const QStringList & l )\fC [virtual]\fR" -Sets the list items of this QComboTableItem to the strings in the string list \fIl\fR. -.SH "QString QComboTableItem::text ( int i ) const" -Returns the text of the combo's list item at index \fIi\fR. -.PP -See also currentText(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcombotableitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcombotableitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcommonstyle.3qt b/doc/man/man3/qcommonstyle.3qt deleted file mode 100644 index 3ce8d7cbe..000000000 --- a/doc/man/man3/qcommonstyle.3qt +++ /dev/null @@ -1,59 +0,0 @@ -'\" t -.TH QCommonStyle 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 -QCommonStyle \- Encapsulates the common Look and Feel of a GUI -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QStyle. -.PP -Inherited by QMotifStyle and QWindowsStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCommonStyle\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QCommonStyle class encapsulates the common Look and Feel of a GUI. -.PP -This abstract class implements some of the widget's look and feel that is common to all GUI styles provided and shipped as part of Qt. -.PP -All the functions are documented in QStyle. -.PP -See also Widget Appearance and Style. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCommonStyle::QCommonStyle ()" -Constructs a QCommonStyle. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcommonstyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcommonstyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qconststring.3qt b/doc/man/man3/qconststring.3qt deleted file mode 100644 index 8c8385552..000000000 --- a/doc/man/man3/qconststring.3qt +++ /dev/null @@ -1,70 +0,0 @@ -'\" t -.TH QConstString 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 -QConstString \- String objects using constant Unicode data -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

              -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQConstString\fR ( const QChar * unicode, uint length )" -.br -.ti -1c -.BI "\fB~QConstString\fR ()" -.br -.ti -1c -.BI "const QString & \fBstring\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QConstString class provides string objects using constant Unicode data. -.PP -In order to minimize copying, highly optimized applications can use QConstString to provide a QString-compatible object from existing Unicode data. It is then the programmer's responsibility to ensure that the Unicode data exists for the entire lifetime of the QConstString object. -.PP -A QConstString is created with the QConstString constructor. The string held by the object can be obtained by calling string(). -.PP -See also Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QConstString::QConstString ( const QChar * unicode, uint length )" -Constructs a QConstString that uses the first \fIlength\fR Unicode characters in the array \fIunicode\fR. Any attempt to modify copies of the string will cause it to create a copy of the data, thus it remains forever unmodified. -.PP -The data in \fIunicode\fR is not copied. The caller must be able to guarantee that \fIunicode\fR will not be deleted or modified. -.SH "QConstString::~QConstString ()" -Destroys the QConstString, creating a copy of the data if other strings are still using it. -.SH "const QString & QConstString::string () const" -Returns a constant string referencing the data passed during -construction. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qconststring.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qconststring.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcontextmenuevent.3qt b/doc/man/man3/qcontextmenuevent.3qt deleted file mode 100644 index fa87d1e04..000000000 --- a/doc/man/man3/qcontextmenuevent.3qt +++ /dev/null @@ -1,187 +0,0 @@ -'\" t -.TH QContextMenuEvent 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 -QContextMenuEvent \- Parameters that describe a context menu event -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBReason\fR { Mouse, Keyboard, Other }" -.br -.ti -1c -.BI "\fBQContextMenuEvent\fR ( Reason reason, const QPoint & pos, const QPoint & globalPos, int state )" -.br -.ti -1c -.BI "\fBQContextMenuEvent\fR ( Reason reason, const QPoint & pos, int state )" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "int \fBglobalX\fR () const" -.br -.ti -1c -.BI "int \fBglobalY\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBpos\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBglobalPos\fR () const" -.br -.ti -1c -.BI "ButtonState \fBstate\fR () const" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "bool \fBisConsumed\fR () const" -.br -.ti -1c -.BI "void \fBconsume\fR ()" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.ti -1c -.BI "Reason \fBreason\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QContextMenuEvent class contains parameters that describe a context menu event. -.PP -Context menu events are sent to widgets when a user triggers a context menu. What triggers this is platform dependent. For example, on Windows, pressing the menu button or releasing the right mouse button will cause this event to be sent. -.PP -When this event occurs it is customary to show a QPopupMenu with a context menu, if this is relevant to the context. -.PP -Context menu events contain a special accept flag that indicates whether the receiver accepted the event. If the event handler does not accept the event, then whatever triggered the event will be handled as a regular input event if possible. -.PP -See also QPopupMenu and Event Classes. -.SS "Member Type Documentation" -.SH "QContextMenuEvent::Reason" -This enum describes the reason the ContextMenuEvent was sent. The values are: -.TP -\fCQContextMenuEvent::Mouse\fR - The mouse caused the event to be sent. Normally this means the right mouse button was clicked, but this is platform specific. -.TP -\fCQContextMenuEvent::Keyboard\fR - The keyboard caused this event to be sent. On Windows this means the menu button was pressed. -.TP -\fCQContextMenuEvent::Other\fR - The event was sent by some other means (i.e. not by the mouse or keyboard). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, const QPoint & globalPos, int state )" -Constructs a context menu event object with the accept parameter flag set to FALSE. -.PP -The \fIreason\fR parameter must be QContextMenuEvent::Mouse or QContextMenuEvent::Keyboard. -.PP -The \fIpos\fR parameter specifies the mouse position relative to the receiving widget. \fIglobalPos\fR is the mouse position in absolute coordinates. \fIstate\fR is the ButtonState at the time of the event. -.SH "QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, int state )" -Constructs a context menu event object with the accept parameter flag set to FALSE. -.PP -The \fIreason\fR parameter must be QContextMenuEvent::Mouse or QContextMenuEvent::Keyboard. -.PP -The \fIpos\fR parameter specifies the mouse position relative to the receiving widget. \fIstate\fR is the ButtonState at the time of the event. -.PP -The globalPos() is initialized to QCursor::pos(), which may not be appropriate. Use the other constructor to specify the global position explicitly. -.SH "void QContextMenuEvent::accept ()" -Sets the accept flag of the context event object. -.PP -Setting the accept flag indicates that the receiver of this event has processed the event. Processing the event means you did something with it and it will be implicitly consumed. -.PP -The accept flag is not set by default. -.PP -See also ignore() and consume(). -.SH "void QContextMenuEvent::consume ()" -Sets the consume flag of the context event object. -.PP -Setting the consume flag indicates that the receiver of this event does not want the event to be propagated further (i.e. not sent to parent classes.) -.PP -The consumed flag is not set by default. -.PP -See also ignore() and accept(). -.SH "const QPoint & QContextMenuEvent::globalPos () const" -Returns the global position of the mouse pointer at the time of the event. -.PP -See also x(), y(), and pos(). -.SH "int QContextMenuEvent::globalX () const" -Returns the global x-position of the mouse pointer at the time of the event. -.PP -See also globalY() and globalPos(). -.SH "int QContextMenuEvent::globalY () const" -Returns the global y-position of the mouse pointer at the time of the event. -.PP -See also globalX() and globalPos(). -.SH "void QContextMenuEvent::ignore ()" -Clears the accept flag of the context event object. -.PP -Clearing the accept flag indicates that the receiver of this event does not need to show a context menu. This will implicitly remove the consumed flag as well. -.PP -The accept flag is not set by default. -.PP -See also accept() and consume(). -.SH "bool QContextMenuEvent::isAccepted () const" -Returns TRUE if the receiver has processed the event; otherwise returns FALSE. -.PP -See also accept(), ignore(), and consume(). -.SH "bool QContextMenuEvent::isConsumed () const" -Returns TRUE (which stops propagation of the event) if the receiver has blocked the event; otherwise returns FALSE. -.PP -See also accept(), ignore(), and consume(). -.SH "const QPoint & QContextMenuEvent::pos () const" -Returns the position of the mouse pointer relative to the widget that received the event. -.PP -See also x(), y(), and globalPos(). -.SH "Reason QContextMenuEvent::reason () const" -Returns the reason for this context event. -.SH "ButtonState QContextMenuEvent::state () const" -Returns the button state (a combination of mouse buttons and keyboard modifiers), i.e. what buttons and keys were being pressed immediately before the event was generated. -.PP -The returned value is LeftButton, RightButton, MidButton, ShiftButton, ControlButton and AltButton OR'ed together. -.SH "int QContextMenuEvent::x () const" -Returns the x-position of the mouse pointer, relative to the widget that received the event. -.PP -See also y() and pos(). -.SH "int QContextMenuEvent::y () const" -Returns the y-position of the mouse pointer, relative to the widget that received the event. -.PP -See also x() and pos(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcontextmenuevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcontextmenuevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcopchannel.3qt b/doc/man/man3/qcopchannel.3qt deleted file mode 100644 index 2a3515c58..000000000 --- a/doc/man/man3/qcopchannel.3qt +++ /dev/null @@ -1,170 +0,0 @@ -'\" t -.TH QCopChannel 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 -QCopChannel \- Communication capabilities between several clients -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCopChannel\fR ( const QCString & channel, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QCopChannel\fR ()" -.br -.ti -1c -.BI "QCString \fBchannel\fR () const" -.br -.ti -1c -.BI "virtual void \fBreceive\fR ( const QCString & msg, const QByteArray & data )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBreceived\fR ( const QCString & msg, const QByteArray & data )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBisRegistered\fR ( const QCString & channel )" -.br -.ti -1c -.BI "bool \fBsend\fR ( const QCString & channel, const QCString & msg )" -.br -.ti -1c -.BI "bool \fBsend\fR ( const QCString & channel, const QCString & msg, const QByteArray & data )" -.br -.in -1c -.SH DESCRIPTION -The QCopChannel class provides communication capabilities between several clients. -.PP -The Qt Cop (QCOP) is a COmmunication Protocol, allowing clients to communicate both within the same address space and between different processes. -.PP -Currently, this facility is only available on Qt/Embedded. On X11 and Windows we are exploring the use of existing standards such as DCOP and COM. -.PP -QCopChannel provides send() and isRegistered() which are static functions usable without an object. -.PP -The channel() function returns the name of the channel. -.PP -In order to \fIlisten\fR to the traffic on a channel, you should either subclass QCopChannel and reimplement receive(), or connect() to the received() signal. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCopChannel::QCopChannel ( const QCString & channel, QObject * parent = 0, const char * name = 0 )" -Constructs a QCop channel and registers it with the server using the name \fIchannel\fR. The standard \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. -.SH "QCopChannel::~QCopChannel ()\fC [virtual]\fR" -Destroys the client's end of the channel and notifies the server that the client has closed its connection. The server will keep the channel open until the last registered client detaches. -.SH "QCString QCopChannel::channel () const" -Returns the name of the channel. -.SH "bool QCopChannel::isRegistered ( const QCString & channel )\fC [static]\fR" -Queries the server for the existence of \fIchannel\fR. -.PP -Returns TRUE if \fIchannel\fR is registered; otherwise returns FALSE. -.SH "void QCopChannel::receive ( const QCString & msg, const QByteArray & data )\fC [virtual]\fR" -This virtual function allows subclasses of QCopChannel to process data received from their channel. -.PP -The default implementation emits the received() signal. -.PP -Note that the format of \fIdata\fR has to be well defined in order to extract the information it contains. -.PP -Example: -.PP -.nf -.br - void MyClass::receive( const QCString &msg, const QByteArray &data ) -.br - { -.br - QDataStream stream( data, IO_ReadOnly ); -.br - if ( msg == "execute(QString,QString)" ) { -.br - QString cmd, arg; -.br - stream >> cmd >> arg; -.br - ... -.br - } else if ( msg == "delete(QString)" ) { -.br - QString filenname; -.br - stream >> filename; -.br - ... -.br - } else ... -.br - } -.br -.fi -This example assumes that the \fImsg\fR is a DCOP-style function signature and the \fIdata\fR contains the function's arguments. (See send().) -.PP -Using the DCOP convention is a recommendation, but not a requirement. Whatever convention you use the sender and receiver \fImust\fR agree on the argument types. -.PP -See also send(). -.SH "void QCopChannel::received ( const QCString & msg, const QByteArray & data )\fC [signal]\fR" -This signal is emitted with the \fImsg\fR and \fIdata\fR whenever the receive() function gets incoming data. -.SH "bool QCopChannel::send ( const QCString & channel, const QCString & msg, const QByteArray & data )\fC [static]\fR" -Send the message \fImsg\fR on channel \fIchannel\fR with data \fIdata\fR. The message will be distributed to all clients subscribed to the channel. -.PP -Note that QDataStream provides a convenient way to fill the byte array with auxiliary data. -.PP -Example: -.PP -.nf -.br - QByteArray ba; -.br - QDataStream stream( ba, IO_WriteOnly ); -.br - stream << QString("cat") << QString("file.txt"); -.br - QCopChannel::send( "System/Shell", "execute(QString,QString)", ba ); -.br -.fi -Here the channel is "System/Shell". The \fImsg\fR is an arbitrary string, but in the example we've used the DCOP convention of passing a function signature. Such a signature is formatted as functionname(types) where types is a list of zero or more comma-separated type names, with no whitespace, no consts and no pointer or reference marks, i.e. no "*" or "&". -.PP -Using the DCOP convention is a recommendation, but not a requirement. Whatever convention you use the sender and receiver \fImust\fR agree on the argument types. -.PP -See also receive(). -.SH "bool QCopChannel::send ( const QCString & channel, const QCString & msg )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Send the message \fImsg\fR on channel \fIchannel\fR. The message will be distributed to all clients subscribed to the \fIchannel\fR. -.PP -See also receive(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcopchannel.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcopchannel.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcstring.3qt b/doc/man/man3/qcstring.3qt deleted file mode 100644 index c6194e4fc..000000000 --- a/doc/man/man3/qcstring.3qt +++ /dev/null @@ -1,1138 +0,0 @@ -'\" t -.TH QCString 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 -QCString \- Abstraction of the classic C zero-terminated char array (char *) -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

              -.PP -\fC#include \fR -.PP -Inherits QByteArray. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCString\fR ()" -.br -.ti -1c -.BI "\fBQCString\fR ( int size )" -.br -.ti -1c -.BI "\fBQCString\fR ( const QCString & s )" -.br -.ti -1c -.BI "\fBQCString\fR ( const char * str )" -.br -.ti -1c -.BI "\fBQCString\fR ( const char * str, uint maxsize )" -.br -.ti -1c -.BI "QCString & \fBoperator=\fR ( const QCString & s )" -.br -.ti -1c -.BI "QCString & \fBoperator=\fR ( const char * str )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "uint \fBlength\fR () const" -.br -.ti -1c -.BI "bool \fBresize\fR ( uint len )" -.br -.ti -1c -.BI "bool \fBtruncate\fR ( uint pos )" -.br -.ti -1c -.BI "bool \fBfill\fR ( char c, int len = -1 )" -.br -.ti -1c -.BI "QCString \fBcopy\fR () const" -.br -.ti -1c -.BI "QCString & \fBsprintf\fR ( const char * format, ... )" -.br -.ti -1c -.BI "int \fBfind\fR ( char c, int index = 0, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( const char * str, int index = 0, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( const QRegExp & rx, int index = 0 ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( char c, int index = -1, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( const char * str, int index = -1, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( const QRegExp & rx, int index = -1 ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( char c, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( const char * str, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( const QRegExp & rx ) const" -.br -.ti -1c -.BI "QCString \fBleft\fR ( uint len ) const" -.br -.ti -1c -.BI "QCString \fBright\fR ( uint len ) const" -.br -.ti -1c -.BI "QCString \fBmid\fR ( uint index, uint len = 0xffffffff ) const" -.br -.ti -1c -.BI "QCString \fBleftJustify\fR ( uint width, char fill = ' ', bool truncate = FALSE ) const" -.br -.ti -1c -.BI "QCString \fBrightJustify\fR ( uint width, char fill = ' ', bool truncate = FALSE ) const" -.br -.ti -1c -.BI "QCString \fBlower\fR () const" -.br -.ti -1c -.BI "QCString \fBupper\fR () const" -.br -.ti -1c -.BI "QCString \fBstripWhiteSpace\fR () const" -.br -.ti -1c -.BI "QCString \fBsimplifyWhiteSpace\fR () const" -.br -.ti -1c -.BI "QCString & \fBinsert\fR ( uint index, const char * s )" -.br -.ti -1c -.BI "QCString & \fBinsert\fR ( uint index, char c )" -.br -.ti -1c -.BI "QCString & \fBappend\fR ( const char * str )" -.br -.ti -1c -.BI "QCString & \fBprepend\fR ( const char * s )" -.br -.ti -1c -.BI "QCString & \fBremove\fR ( uint index, uint len )" -.br -.ti -1c -.BI "QCString & \fBreplace\fR ( uint index, uint len, const char * str )" -.br -.ti -1c -.BI "QCString & \fBreplace\fR ( const QRegExp & rx, const char * str )" -.br -.ti -1c -.BI "QCString & \fBreplace\fR ( char c, const char * after )" -.br -.ti -1c -.BI "QCString & \fBreplace\fR ( const char * before, const char * after )" -.br -.ti -1c -.BI "QCString & \fBreplace\fR ( char c1, char c2 )" -.br -.ti -1c -.BI "short \fBtoShort\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "ushort \fBtoUShort\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "int \fBtoInt\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "uint \fBtoUInt\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "long \fBtoLong\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "ulong \fBtoULong\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "float \fBtoFloat\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "double \fBtoDouble\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "QCString & \fBsetStr\fR ( const char * str )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( short n )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( ushort n )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( int n )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( uint n )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( long n )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( ulong n )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( float n, char f = 'g', int prec = 6 )" -.br -.ti -1c -.BI "QCString & \fBsetNum\fR ( double n, char f = 'g', int prec = 6 )" -.br -.ti -1c -.BI "bool \fBsetExpand\fR ( uint index, char c )" -.br -.ti -1c -.BI "\fBoperator const char *\fR () const" -.br -.ti -1c -.BI "QCString & \fBoperator+=\fR ( const char * str )" -.br -.ti -1c -.BI "QCString & \fBoperator+=\fR ( char c )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "void * \fBqmemmove\fR ( void * dst, const void * src, uint len )" -.br -.ti -1c -.BI "char * \fBqstrdup\fR ( const char * src )" -.br -.ti -1c -.BI "char * \fBqstrcpy\fR ( char * dst, const char * src )" -.br -.ti -1c -.BI "char * \fBqstrncpy\fR ( char * dst, const char * src, uint len )" -.br -.ti -1c -.BI "uint \fBqstrlen\fR ( const char * str )" -.br -.ti -1c -.BI "int \fBqstrcmp\fR ( const char * str1, const char * str2 )" -.br -.ti -1c -.BI "int \fBqstrncmp\fR ( const char * str1, const char * str2, uint len )" -.br -.ti -1c -.BI "int \fBqstricmp\fR ( const char * str1, const char * str2 )" -.br -.ti -1c -.BI "int \fBqstrnicmp\fR ( const char * str1, const char * str2, uint len )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QCString & str )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QCString & str )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QCString & s1, const QCString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QCString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const char * s1, const QCString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QCString & s1, const QCString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QCString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const char * s1, const QCString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const QCString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const char * s1, const QCString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const QCString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const char * s1, const QCString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const QCString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const char * s1, const QCString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const QCString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const char * s1, const QCString & s2 )" -.br -.ti -1c -.BI "const QCString \fBoperator+\fR ( const QCString & s1, const QCString & s2 )" -.br -.ti -1c -.BI "const QCString \fBoperator+\fR ( const QCString & s1, const char * s2 )" -.br -.ti -1c -.BI "const QCString \fBoperator+\fR ( const char * s1, const QCString & s2 )" -.br -.ti -1c -.BI "const QCString \fBoperator+\fR ( const QCString & s, char c )" -.br -.ti -1c -.BI "const QCString \fBoperator+\fR ( char c, const QCString & s )" -.br -.in -1c -.SH DESCRIPTION -The QCString class provides an abstraction of the classic C zero-terminated char array (char *). -.PP -QCString inherits QByteArray, which is defined as QMemArray. Since QCString is a QMemArray, it uses explicit sharing with a reference count. -.PP -QCString tries to behave like a more convenient \fCconst char *\fR. The price of doing this is that some algorithms will perform badly. For example, append() is O(length()) since it scans for a null terminator. Although you might use QCString for text that is never exposed to the user, for most purposes, and especially for user-visible text, you should use QString. QString provides implicit sharing, Unicode and other internationalization support, and is well optimized. -.PP -Note that for the QCString methods that take a \fCconst char *\fR parameter the \fCconst char *\fR must either be 0 (null) or not-null and '\0' (NUL byte) terminated; otherwise the results are undefined. -.PP -A QCString that has not been assigned to anything is \fInull\fR, i.e. both the length and the data pointer is 0. A QCString that references the empty string ("", a single '\0' char) is \fIempty\fR. Both null and empty QCStrings are legal parameters to the methods. Assigning \fCconst char *\fR 0 to QCString produces a null QCString. -.PP -The length() function returns the length of the string; resize() resizes the string and truncate() truncates the string. A string can be filled with a character using fill(). Strings can be left or right padded with characters using leftJustify() and rightJustify(). Characters, strings and regular expressions can be searched for using find() and findRev(), and counted using contains(). -.PP -Strings and characters can be inserted with insert() and appended with append(). A string can be prepended with prepend(). Characters can be removed from the string with remove() and replaced with replace(). -.PP -Portions of a string can be extracted using left(), right() and mid(). Whitespace can be removed using stripWhiteSpace() and simplifyWhiteSpace(). Strings can be converted to uppercase or lowercase with upper() and lower() respectively. -.PP -Strings that contain numbers can be converted to numbers with toShort(), toInt(), toLong(), toULong(), toFloat() and toDouble(). Numbers can be converted to strings with setNum(). -.PP -Many operators are overloaded to work with QCStrings. QCString also supports some more obscure functions, e.g. sprintf(), setStr() and setExpand(). -.PP -

              \fB Note on Character Comparisons \fR -.PP -In QCString the notion of uppercase and lowercase and of which character is greater than or less than another character is locale dependent. This affects functions which support a case insensitive option or which compare or lowercase or uppercase their arguments. Case insensitive operations and comparisons will be accurate if both strings contain only ASCII characters. (If \fC$LC_CTYPE\fR is set, most Unix systems do "the right thing".) Functions that this affects include contains(), find(), findRev(), operator<(), operator<=(), operator>(), operator>=(), lower() and upper(). -.PP -This issue does not apply to QStrings since they represent characters using Unicode.

              -.PP -Performance note: The QCString methods for QRegExp searching are implemented by converting the QCString to a QString and performing the search on that. This implies a deep copy of the QCString data. If you are going to perform many QRegExp searches on a large QCString, you will get better performance by converting the QCString to a QString yourself, and then searching in the QString. -.PP -See also Collection Classes, Implicitly and Explicitly Shared Classes, Text Related Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCString::QCString ()" -Constructs a null string. -.PP -See also isNull(). -.SH "QCString::QCString ( int size )" -Constructs a string with room for \fIsize\fR characters, including the '\0'-terminator. Makes a null string if \fIsize\fR == 0. -.PP -If \fIsize\fR > 0, then the first and last characters in the string are initialized to '\0'. All other characters are uninitialized. -.PP -See also resize() and isNull(). -.SH "QCString::QCString ( const QCString & s )" -Constructs a shallow copy \fIs\fR. -.PP -See also assign(). -.SH "QCString::QCString ( const char * str )" -Constructs a string that is a deep copy of \fIstr\fR. -.PP -If \fIstr\fR is 0 a null string is created. -.PP -See also isNull(). -.SH "QCString::QCString ( const char * str, uint maxsize )" -Constructs a string that is a deep copy of \fIstr\fR. The copy will be at most \fImaxsize\fR bytes long including the '\0'-terminator. -.PP -Example: -.PP -.nf -.br - QCString str( "helloworld", 6 ); // assigns "hello" to str -.br -.fi -.PP -If \fIstr\fR contains a 0 byte within the first \fImaxsize\fR bytes, the resulting QCString will be terminated by this 0. If \fIstr\fR is 0 a null string is created. -.PP -See also isNull(). -.SH "QCString & QCString::append ( const char * str )" -Appends string \fIstr\fR to the string and returns a reference to the string. Equivalent to operator+=(). -.SH "int QCString::contains ( char c, bool cs = TRUE ) const" -Returns the number of times the character \fIc\fR occurs in the string. -.PP -The match is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR if FALSE. -.PP -See also Note on character comparisons. -.SH "int QCString::contains ( const char * str, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the number of times \fIstr\fR occurs in the string. -.PP -The match is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR if FALSE. -.PP -This function counts overlapping substrings, for example, "banana" contains two occurrences of "ana". -.PP -See also findRev() and Note on character comparisons. -.SH "int QCString::contains ( const QRegExp & rx ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Counts the number of overlapping occurrences of \fIrx\fR in the string. -.PP -Example: -.PP -.nf -.br - QString s = "banana and panama"; -.br - QRegExp r = QRegExp( "a[nm]a", TRUE, FALSE ); -.br - s.contains( r ); // 4 matches -.br -.fi -.PP -See also find() and findRev(). -.PP -\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. -.SH "QCString QCString::copy () const" -Returns a deep copy of this string. -.PP -See also detach(). -.SH "bool QCString::fill ( char c, int len = -1 )" -Fills the string with \fIlen\fR bytes of character \fIc\fR, followed by a '\0'-terminator. -.PP -If \fIlen\fR is negative, then the current string length is used. -.PP -Returns FALSE is \fIlen\fR is nonnegative and there is not enough memory to resize the string; otherwise returns TRUE. -.SH "int QCString::find ( char c, int index = 0, bool cs = TRUE ) const" -Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR. -.PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. -.PP -Returns the position of \fIc\fR, or -1 if \fIc\fR could not be found. -.PP -See also Note on character comparisons. -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "int QCString::find ( const char * str, int index = 0, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR. -.PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. -.PP -Returns the position of \fIstr\fR, or -1 if \fIstr\fR could not be found. -.PP -See also Note on character comparisons. -.SH "int QCString::find ( const QRegExp & rx, int index = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the regular expression \fIrx\fR, starting at position \fIindex\fR. -.PP -Returns the position of the next match, or -1 if \fIrx\fR was not found. -.PP -\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. -.SH "int QCString::findRev ( char c, int index = -1, bool cs = TRUE ) const" -Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR and searching backwards. -.PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. -.PP -Returns the position of \fIc\fR, or -1 if \fIc\fR could not be found. -.PP -See also Note on character comparisons. -.SH "int QCString::findRev ( const char * str, int index = -1, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR and searching backwards. -.PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. -.PP -Returns the position of \fIstr\fR, or -1 if \fIstr\fR could not be found. -.PP -See also Note on character comparisons. -.SH "int QCString::findRev ( const QRegExp & rx, int index = -1 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the regular expression \fIrx\fR, starting at position \fIindex\fR and searching backwards. -.PP -Returns the position of the next match (backwards), or -1 if \fIrx\fR was not found. -.PP -\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. -.SH "QCString & QCString::insert ( uint index, char c )" -Inserts character \fIc\fR into the string at position \fIindex\fR and returns a reference to the string. -.PP -If \fIindex\fR is beyond the end of the string, the string is padded with spaces (ASCII 32) to length \fIindex\fR and then \fIc\fR is appended. -.PP -Example: -.PP -.nf -.br - QCString s = "Yes"; -.br - s.insert( 3, '!'); // s == "Yes!" -.br -.fi -.PP -See also remove() and replace(). -.SH "QCString & QCString::insert ( uint index, const char * s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts string \fIs\fR into the string at position \fIindex\fR. -.PP -If \fIindex\fR is beyond the end of the string, the string is padded with spaces (ASCII 32) to length \fIindex\fR and then \fIs\fR is appended. -.PP -.nf -.br - QCString s = "I like fish"; -.br - s.insert( 2, "don't "); // s == "I don't like fish" -.br -.br - s = "x"; // index 01234 -.br - s.insert( 3, "yz" ); // s == "x yz" -.br -.fi -.SH "bool QCString::isEmpty () const" -Returns TRUE if the string is empty, i.e. if length() == 0; otherwise returns FALSE. An empty string is not always a null string. -.PP -See example in isNull(). -.PP -See also isNull(), length(), and size(). -.SH "bool QCString::isNull () const" -Returns TRUE if the string is null, i.e. if data() == 0; otherwise returns FALSE. A null string is also an empty string. -.PP -Example: -.PP -.nf -.br - QCString a; // a.data() == 0, a.size() == 0, a.length() == 0 -.br - QCString b == ""; // b.data() == "", b.size() == 1, b.length() == 0 -.br - a.isNull(); // TRUE because a.data() == 0 -.br - a.isEmpty(); // TRUE because a.length() == 0 -.br - b.isNull(); // FALSE because b.data() == "" -.br - b.isEmpty(); // TRUE because b.length() == 0 -.br -.fi -.PP -See also isEmpty(), length(), and size(). -.SH "QCString QCString::left ( uint len ) const" -Returns a substring that contains the \fIlen\fR leftmost characters of the string. -.PP -The whole string is returned if \fIlen\fR exceeds the length of the string. -.PP -Example: -.PP -.nf -.br - QCString s = "Pineapple"; -.br - QCString t = s.left( 4 ); // t == "Pine" -.br -.fi -.PP -See also right() and mid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QCString QCString::leftJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const" -Returns a string of length \fIwidth\fR (plus one for the terminating '\0') that contains this string padded with the \fIfill\fR character. -.PP -If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is FALSE (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is TRUE, then the returned string is a left(\fIwidth\fR). -.PP -Example: -.PP -.nf -.br - QCString s("apple"); -.br - QCString t = s.leftJustify(8, '.'); // t == "apple..." -.br -.fi -.PP -See also rightJustify(). -.SH "uint QCString::length () const" -Returns the length of the string, excluding the '\0'-terminator. Equivalent to calling \fCstrlen(data())\fR. -.PP -Null strings and empty strings have zero length. -.PP -See also size(), isNull(), and isEmpty(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QCString QCString::lower () const" -Returns a new string that is a copy of this string converted to lower case. -.PP -Example: -.PP -.nf -.br - QCString s("Credit"); -.br - QCString t = s.lower(); // t == "credit" -.br -.fi -.PP -See also upper() and Note on character comparisons. -.SH "QCString QCString::mid ( uint index, uint len = 0xffffffff ) const" -Returns a substring that contains at most \fIlen\fR characters from this string, starting at position \fIindex\fR. -.PP -Returns a null string if the string is empty or if \fIindex\fR is out of range. Returns the whole string from \fIindex\fR if \fIindex+len\fR exceeds the length of the string. -.PP -Example: -.PP -.nf -.br - QCString s = "Two pineapples"; -.br - QCString t = s.mid( 4, 3 ); // t == "pin" -.br -.fi -.PP -See also left() and right(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QCString::operator const char * () const" -Returns the string data. -.SH "QCString & QCString::operator+= ( const char * str )" -Appends string \fIstr\fR to the string and returns a reference to the string. -.SH "QCString & QCString::operator+= ( char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends character \fIc\fR to the string and returns a reference to the string. -.SH "QCString & QCString::operator= ( const QCString & s )" -Assigns a shallow copy of \fIs\fR to this string and returns a reference to this string. -.SH "QCString & QCString::operator= ( const char * str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assigns a deep copy of \fIstr\fR to this string and returns a reference to this string. -.PP -If \fIstr\fR is 0 a null string is created. -.PP -See also isNull(). -.SH "QCString & QCString::prepend ( const char * s )" -Prepend \fIs\fR to the string. Equivalent to insert(0, s). -.PP -See also insert(). -.SH "QCString & QCString::remove ( uint index, uint len )" -Removes \fIlen\fR characters from the string, starting at position \fIindex\fR, and returns a reference to the string. -.PP -If \fIindex\fR is out of range, nothing happens. If \fIindex\fR is valid, but \fIindex\fR + \fIlen\fR is larger than the length of the string, the string is truncated at position \fIindex\fR. -.PP -.nf -.br - QCString s = "Montreal"; -.br - s.remove( 1, 4 ); // s == "Meal" -.br -.fi -.PP -See also insert() and replace(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QCString & QCString::replace ( uint index, uint len, const char * str )" -Replaces \fIlen\fR characters from the string, starting at position \fIindex\fR, with \fIstr\fR, and returns a reference to the string. -.PP -If \fIindex\fR is out of range, nothing is removed and \fIstr\fR is appended at the end of the string. If \fIindex\fR is valid, but \fIindex\fR + \fIlen\fR is larger than the length of the string, \fIstr\fR replaces the rest of the string from position \fIindex\fR. -.PP -.nf -.br - QCString s = "Say yes!"; -.br - s.replace( 4, 3, "NO" ); // s == "Say NO!" -.br -.fi -.PP -See also insert() and remove(). -.SH "QCString & QCString::replace ( const QRegExp & rx, const char * str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of \fIrx\fR in the string with \fIstr\fR. Returns a reference to the string. -.PP -Example: -.PP -.nf -.br - QString s = "banana"; -.br - s.replace( QRegExp("a.*a"), "" ); // becomes "b" -.br -.br - s = "banana"; -.br - s.replace( QRegExp("^[bn]a"), "X" ); // becomes "Xnana" -.br -.br - s = "banana"; -.br - s.replace( QRegExp("^[bn]a"), "" ); // becomes "nana" -.br -.fi -.PP -\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. -.SH "QCString & QCString::replace ( char c, const char * after )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of the character \fIc\fR in the string with \fIafter\fR. Returns a reference to the string. -.PP -Example: -.PP -.nf -.br - QCString s = "a,b,c"; -.br - s.replace( ',', " or " ); -.br - // s == "a or b or c" -.br -.fi -.SH "QCString & QCString::replace ( const char * before, const char * after )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of the string \fIbefore\fR in the string with the string \fIafter\fR. Returns a reference to the string. -.PP -Example: -.PP -.nf -.br - QCString s = "Greek is Greek"; -.br - s.replace( "Greek", "English" ); -.br - // s == "English is English" -.br -.fi -.SH "QCString & QCString::replace ( char c1, char c2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of \fIc1\fR with the char \fIc2\fR. Returns a reference to the string. -.SH "bool QCString::resize ( uint len )" -Extends or shrinks the string to \fIlen\fR bytes, including the '\0'-terminator. -.PP -A '\0'-terminator is set at position \fClen - 1\fR unless \fClen == 0\fR. -.PP -Example: -.PP -.nf -.br - QCString s = "resize this string"; -.br - s.resize( 7 ); // s == "resize" -.br -.fi -.PP -See also truncate(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QCString QCString::right ( uint len ) const" -Returns a substring that contains the \fIlen\fR rightmost characters of the string. -.PP -The whole string is returned if \fIlen\fR exceeds the length of the string. -.PP -Example: -.PP -.nf -.br - QCString s = "Pineapple"; -.br - QCString t = s.right( 5 ); // t == "apple" -.br -.fi -.PP -See also left() and mid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QCString QCString::rightJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const" -Returns a string of length \fIwidth\fR (plus one for the terminating '\0') that contains zero or more of the \fIfill\fR character followed by this string. -.PP -If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is FALSE (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is TRUE, then the returned string is a left(\fIwidth\fR). -.PP -Example: -.PP -.nf -.br - QCString s("pie"); -.br - QCString t = s.rightJustify(8, '.'); // t == ".....pie" -.br -.fi -.PP -See also leftJustify(). -.SH "bool QCString::setExpand ( uint index, char c )" -Sets the character at position \fIindex\fR to \fIc\fR and expands the string if necessary, padding with spaces. -.PP -Returns FALSE if \fIindex\fR was out of range and the string could not be expanded; otherwise returns TRUE. -.SH "QCString & QCString::setNum ( double n, char f = 'g', int prec = 6 )" -Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. -.PP -The format of the string representation is specified by the format character \fIf\fR, and the precision (number of digits after the decimal point) is specified with \fIprec\fR. -.PP -The valid formats for \fIf\fR are 'e', 'E', 'f', 'g' and 'G'. The formats are the same as for sprintf(); they are explained in QString::arg(). -.SH "QCString & QCString::setNum ( short n )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. -.SH "QCString & QCString::setNum ( ushort n )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. -.SH "QCString & QCString::setNum ( int n )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. -.SH "QCString & QCString::setNum ( uint n )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. -.SH "QCString & QCString::setNum ( long n )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. -.SH "QCString & QCString::setNum ( ulong n )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. -.SH "QCString & QCString::setNum ( float n, char f = 'g', int prec = 6 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QCString & QCString::setStr ( const char * str )" -Makes a deep copy of \fIstr\fR. Returns a reference to the string. -.SH "QCString QCString::simplifyWhiteSpace () const" -Returns a new string that has white space removed from the start and the end, plus any sequence of internal white space replaced with a single space (ASCII 32). -.PP -White space means the decimal ASCII codes 9, 10, 11, 12, 13 and 32. -.PP -.nf -.br - QCString s = " lots\\t of\\nwhite space "; -.br - QCString t = s.simplifyWhiteSpace(); // t == "lots of white space" -.br -.fi -.PP -See also stripWhiteSpace(). -.SH "QCString & QCString::sprintf ( const char * format, ... )" -Implemented as a call to the native vsprintf() (see the manual for your C library). -.PP -If the string is shorter than 256 characters, this sprintf() calls resize(256) to decrease the chance of memory corruption. The string is resized back to its actual length before sprintf() returns. -.PP -Example: -.PP -.nf -.br - QCString s; -.br - s.sprintf( "%d - %s", 1, "first" ); // result < 256 chars -.br -.br - QCString big( 25000 ); // very long string -.br - big.sprintf( "%d - %s", 2, longString ); // result < 25000 chars -.br -.fi -.PP -\fBWarning:\fR All vsprintf() implementations will write past the end of the target string (*this) if the \fIformat\fR specification and arguments happen to be longer than the target string, and some will also fail if the target string is longer than some arbitrary implementation limit. -.PP -Giving user-supplied arguments to sprintf() is risky: Sooner or later someone will paste a huge line into your application. -.SH "QCString QCString::stripWhiteSpace () const" -Returns a new string that has white space removed from the start and the end. -.PP -White space means the decimal ASCII codes 9, 10, 11, 12, 13 and 32. -.PP -Example: -.PP -.nf -.br - QCString s = " space "; -.br - QCString t = s.stripWhiteSpace(); // t == "space" -.br -.fi -.PP -See also simplifyWhiteSpace(). -.SH "double QCString::toDouble ( bool * ok = 0 ) const" -Returns the string converted to a \fCdouble\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "float QCString::toFloat ( bool * ok = 0 ) const" -Returns the string converted to a \fCfloat\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "int QCString::toInt ( bool * ok = 0 ) const" -Returns the string converted to a \fCint\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "long QCString::toLong ( bool * ok = 0 ) const" -Returns the string converted to a \fClong\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "short QCString::toShort ( bool * ok = 0 ) const" -Returns the string converted to a \fCshort\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "uint QCString::toUInt ( bool * ok = 0 ) const" -Returns the string converted to an \fCunsigned int\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "ulong QCString::toULong ( bool * ok = 0 ) const" -Returns the string converted to an \fCunsigned long\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "ushort QCString::toUShort ( bool * ok = 0 ) const" -Returns the string converted to an \fCunsigned short\fR value. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. -.SH "bool QCString::truncate ( uint pos )" -Truncates the string at position \fIpos\fR. -.PP -Equivalent to calling \fCresize(pos+1)\fR. -.PP -Example: -.PP -.nf -.br - QCString s = "truncate this string"; -.br - s.truncate( 5 ); // s == "trunc" -.br -.fi -.PP -See also resize(). -.SH "QCString QCString::upper () const" -Returns a new string that is a copy of this string converted to upper case. -.PP -Example: -.PP -.nf -.br - QCString s( "Debit" ); -.br - QCString t = s.upper(); // t == "DEBIT" -.br -.fi -.PP -See also lower() and Note on character comparisons. -.SH RELATED FUNCTION DOCUMENTATION -.SH "bool operator!= ( const QCString & s1, const QCString & s2 )" -Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. -.SH "bool operator!= ( const QCString & s1, const char * s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. -.SH "bool operator!= ( const char * s1, const QCString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. -.SH "const QCString operator+ ( const QCString & s1, const QCString & s2 )" -Returns a string which consists of the concatenation of \fIs1\fR and \fIs2\fR. -.SH "const QCString operator+ ( const QCString & s1, const char * s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which consists of the concatenation of \fIs1\fR and \fIs2\fR. -.SH "const QCString operator+ ( const char * s1, const QCString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which consists of the concatenation of \fIs1\fR and \fIs2\fR. -.SH "const QCString operator+ ( const QCString & s, char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which consists of the concatenation of \fIs\fR and \fIc\fR. -.SH "const QCString operator+ ( char c, const QCString & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which consists of the concatenation of \fIc\fR and \fIs\fR. -.SH "bool operator< ( const QCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is less than \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) < 0. -.PP -See also Note on character comparisons. -.SH "bool operator< ( const char * s1, const QCString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is less than \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) < 0. -.PP -See also Note on character comparisons. -.SH "QDataStream & operator<< ( QDataStream & s, const QCString & str )" -Writes string \fIstr\fR to the stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "bool operator<= ( const QCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) <= 0. -.PP -See also Note on character comparisons. -.SH "bool operator<= ( const char * s1, const QCString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) <= 0. -.PP -See also Note on character comparisons. -.SH "bool operator== ( const QCString & s1, const QCString & s2 )" -Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. -.SH "bool operator== ( const QCString & s1, const char * s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. -.SH "bool operator== ( const char * s1, const QCString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. -.SH "bool operator> ( const QCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is greater than \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) > 0. -.PP -See also Note on character comparisons. -.SH "bool operator> ( const char * s1, const QCString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is greater than \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) > 0. -.PP -See also Note on character comparisons. -.SH "bool operator>= ( const QCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) >= 0. -.PP -See also Note on character comparisons. -.SH "bool operator>= ( const char * s1, const QCString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns FALSE. -.PP -Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) >= 0. -.PP -See also Note on character comparisons. -.SH "QDataStream & operator>> ( QDataStream & s, QCString & str )" -Reads a string into \fIstr\fR from the stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "void * tqmemmove ( void * dst, const void * src, uint len )" -This function is normally part of the C library. Qt implements memmove() for platforms that do not provide it. -.PP -memmove() copies \fIlen\fR bytes from \fIsrc\fR into \fIdst\fR. The data is copied correctly even if \fIsrc\fR and \fIdst\fR overlap. -.SH "int qstrcmp ( const char * str1, const char * str2 )" -A safe strcmp() function. -.PP -Compares \fIstr1\fR and \fIstr2\fR. Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. -.PP -Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. -.PP -Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). -.PP -See also tqstrncmp(), tqstricmp(), tqstrnicmp(), and Note on character comparisons. -.SH "char * qstrcpy ( char * dst, const char * src )" -A safe strcpy() function. -.PP -Copies all characters up to and including the '\0' from \fIsrc\fR into \fIdst\fR and returns a pointer to \fIdst\fR. -.SH "char * tqstrdup ( const char * src )" -Returns a duplicate string. -.PP -Allocates space for a copy of \fIsrc\fR, copies it, and returns a pointer to the copy. If \fIsrc\fR is 0, it immediately returns 0. -.PP -The returned string must be deleted using \fCdelete[]\fR. -.SH "int tqstricmp ( const char * str1, const char * str2 )" -A safe stricmp() function. -.PP -Compares \fIstr1\fR and \fIstr2\fR ignoring the case. -.PP -Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. -.PP -Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. -.PP -Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). -.PP -See also qstrcmp(), tqstrncmp(), tqstrnicmp(), and Note on character comparisons. -.SH "uint tqstrlen ( const char * str )" -A safe strlen function. -.PP -Returns the number of characters that precede the terminating '\0'. or 0 if \fIstr\fR is 0. -.SH "int tqstrncmp ( const char * str1, const char * str2, uint len )" -A safe strncmp() function. -.PP -Compares at most \fIlen\fR bytes of \fIstr1\fR and \fIstr2\fR. -.PP -Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. -.PP -Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. -.PP -Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). -.PP -See also qstrcmp(), tqstricmp(), tqstrnicmp(), and Note on character comparisons. -.SH "char * tqstrncpy ( char * dst, const char * src, uint len )" -A safe strncpy() function. -.PP -Copies at most \fIlen\fR bytes from \fIsrc\fR (stopping at \fIlen\fR or the terminating '\0' whichever comes first) into \fIdst\fR and returns a pointer to \fIdst\fR. Guarantees that \fIdst\fR is '\0'-terminated. If \fIsrc\fR or \fIdst\fR is 0, returns 0 immediately. -.PP -See also qstrcpy(). -.SH "int tqstrnicmp ( const char * str1, const char * str2, uint len )" -A safe strnicmp() function. -.PP -Compares at most \fIlen\fR bytes of \fIstr1\fR and \fIstr2\fR ignoring the case. -.PP -Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. -.PP -Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. -.PP -Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). -.PP -See also qstrcmp(), tqstrncmp(), tqstricmp(), and Note on character comparisons. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcstring.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcstring.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcursor.3qt b/doc/man/man3/qcursor.3qt deleted file mode 100644 index 7fd5db969..000000000 --- a/doc/man/man3/qcursor.3qt +++ /dev/null @@ -1,253 +0,0 @@ -'\" t -.TH QCursor 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 -QCursor \- Mouse cursor with an arbitrary shape -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCursor\fR ()" -.br -.ti -1c -.BI "\fBQCursor\fR ( int shape )" -.br -.ti -1c -.BI "\fBQCursor\fR ( const QBitmap & bitmap, const QBitmap & mask, int hotX = -1, int hotY = -1 )" -.br -.ti -1c -.BI "\fBQCursor\fR ( const QPixmap & pixmap, int hotX = -1, int hotY = -1 )" -.br -.ti -1c -.BI "\fBQCursor\fR ( const QCursor & c )" -.br -.ti -1c -.BI "\fB~QCursor\fR ()" -.br -.ti -1c -.BI "QCursor & \fBoperator=\fR ( const QCursor & c )" -.br -.ti -1c -.BI "int \fBshape\fR () const" -.br -.ti -1c -.BI "void \fBsetShape\fR ( int shape )" -.br -.ti -1c -.BI "const QBitmap * \fBbitmap\fR () const" -.br -.ti -1c -.BI "const QBitmap * \fBmask\fR () const" -.br -.ti -1c -.BI "QPoint \fBhotSpot\fR () const" -.br -.ti -1c -.BI "HCURSOR \fBhandle\fR () const" -.br -.ti -1c -.BI "\fBQCursor\fR ( HCURSOR handle )" -.br -.ti -1c -.BI "HANDLE \fBhandle\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QPoint \fBpos\fR ()" -.br -.ti -1c -.BI "void \fBsetPos\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBsetPos\fR ( const QPoint & )" -.br -.ti -1c -.BI "void \fBinitialize\fR ()" -.br -.ti -1c -.BI "void \fBcleanup\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QCursor & c )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QCursor & c )" -.br -.in -1c -.SH DESCRIPTION -The QCursor class provides a mouse cursor with an arbitrary shape. -.PP -This class is mainly used to create mouse cursors that are associated with particular widgets and to get and set the position of the mouse cursor. -.PP -Qt has a number of standard cursor shapes, but you can also make custom cursor shapes based on a QBitmap, a mask and a hotspot. -.PP -To associate a cursor with a widget, use QWidget::setCursor(). To associate a cursor with all widgets (normally for a short period of time), use QApplication::setOverrideCursor(). -.PP -To set a cursor shape use QCursor::setShape() or use the QCursor constructor which takes the shape as argument, or you can use one of the predefined cursors defined in the CursorShape enum. -.PP -If you want to create a cursor with your own bitmap, either use the QCursor constructor which takes a bitmap and a mask or the constructor which takes a pixmap as arguments. -.PP -To set or get the position of the mouse cursor use the static methods QCursor::pos() and QCursor::setPos(). -.PP -
              -.ce 1 -.B "[Image Omitted]" -.PP -
              -.PP -See also QWidget, GUI Design Handbook: Cursors, Widget Appearance and Style, and Implicitly and Explicitly Shared Classes. -.PP -On X11, Qt supports the Xcursor library, which allows for full color icon themes. The table below shows the cursor name used for each Qt::CursorShape value. If a cursor cannot be found using the name shown below, a standard X11 cursor will be used instead. Note: X11 does not provide appropriate cursors for all possible Qt::CursorShape values. It is possible that some cursors will be taken from the Xcursor theme, while others will use an internal bitmap cursor. -.PP -
              .nf -.TS -l - l. Qt::CursorShape Values Cursor Names Qt::ArrowCursor left_ptr Qt::UpArrowCursor up_arrow Qt::CrossCursor cross Qt::WaitCursor wait Qt::BusyCursor left_ptr_watch Qt::IbeamCursor ibeam Qt::SizeVerCursor size_ver Qt::SizeHorCursor size_hor Qt::SizeBDiagCursor size_bdiag Qt::SizeFDiagCursor size_fdiag Qt::SizeAllCursor size_all Qt::SplitVCursor split_v Qt::SplitHCursor split_h Qt::PointingHandCursor pointing_hand Qt::ForbiddenCursor forbidden Qt::WhatsThisCursor -.TE -.fi -
              -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCursor::QCursor ()" -Constructs a cursor with the default arrow shape. -.SH "QCursor::QCursor ( int shape )" -Constructs a cursor with the specified \fIshape\fR. -.PP -See CursorShape for a list of shapes. -.PP -See also setShape(). -.SH "QCursor::QCursor ( const QBitmap & bitmap, const QBitmap & mask, int hotX = -1, int hotY = -1 )" -Constructs a custom bitmap cursor. -.PP -\fIbitmap\fR and \fImask\fR make up the bitmap. \fIhotX\fR and \fIhotY\fR define the cursor's hot spot. -.PP -If \fIhotX\fR is negative, it is set to the \fCbitmap().width()/2\fR. If \fIhotY\fR is negative, it is set to the \fCbitmap().height()/2\fR. -.PP -The cursor \fIbitmap\fR (B) and \fImask\fR (M) bits are combined like this: -.TP -B=1 and M=1 gives black. -.TP -B=0 and M=1 gives white. -.TP -B=0 and M=0 gives transparent. -.TP -B=1 and M=0 gives an undefined result. -.PP -Use the global Qt color \fCcolor0\fR to draw 0-pixels and \fCcolor1\fR to draw 1-pixels in the bitmaps. -.PP -Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors. -.PP -See also QBitmap::QBitmap() and QBitmap::setMask(). -.SH "QCursor::QCursor ( const QPixmap & pixmap, int hotX = -1, int hotY = -1 )" -Constructs a custom pixmap cursor. -.PP -\fIpixmap\fR is the image. It is usual to give it a mask (set using QPixmap::setMask()). \fIhotX\fR and \fIhotY\fR define the cursor's hot spot. -.PP -If \fIhotX\fR is negative, it is set to the \fCpixmap().width()/2\fR. If \fIhotY\fR is negative, it is set to the \fCpixmap().height()/2\fR. -.PP -Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors. -.PP -Currently, only black-and-white pixmaps can be used. -.PP -See also QPixmap::QPixmap() and QPixmap::setMask(). -.SH "QCursor::QCursor ( const QCursor & c )" -Constructs a copy of the cursor \fIc\fR. -.SH "QCursor::QCursor ( HCURSOR handle )" -Creates a cursor with the specified window system handle \fIhandle\fR. -.PP -\fBWarning:\fR Portable in principle, but if you use it you are probably about to do something non-portable. Be careful. -.SH "QCursor::~QCursor ()" -Destroys the cursor. -.SH "const QBitmap * QCursor::bitmap () const" -Returns the cursor bitmap, or 0 if it is one of the standard cursors. -.SH "void QCursor::cleanup ()\fC [static]\fR" -Internal function that deinitializes the predefined cursors. This function is called from the QApplication destructor. -.PP -See also initialize(). -.SH "HANDLE QCursor::handle () const" -Returns the window system cursor handle. -.PP -\fBWarning:\fR Portable in principle, but if you use it you are probably about to do something non-portable. Be careful. -.SH "QPoint QCursor::hotSpot () const" -Returns the cursor hot spot, or (0, 0) if it is one of the standard cursors. -.SH "void QCursor::initialize ()\fC [static]\fR" -Internal function that initializes the predefined cursors. This function is called from the QApplication constructor. -.PP -See also cleanup(). -.SH "const QBitmap * QCursor::mask () const" -Returns the cursor bitmap mask, or 0 if it is one of the standard cursors. -.SH "QCursor & QCursor::operator= ( const QCursor & c )" -Assigns \fIc\fR to this cursor and returns a reference to this cursor. -.SH "QPoint QCursor::pos ()\fC [static]\fR" -Returns the position of the cursor (hot spot) in global screen coordinates. -.PP -You can call QWidget::mapFromGlobal() to translate it to widget coordinates. -.PP -See also setPos(), QWidget::mapFromGlobal(), and QWidget::mapToGlobal(). -.PP -Examples: -.)l chart/canvasview.cpp, fileiconview/qfileiconview.cpp, and menu/menu.cpp. -.SH "void QCursor::setPos ( int x, int y )\fC [static]\fR" -Moves the cursor (hot spot) to the global screen position (\fIx\fR, \fIy\fR). -.PP -You can call QWidget::mapToGlobal() to translate widget coordinates to global screen coordinates. -.PP -See also pos(), QWidget::mapFromGlobal(), and QWidget::mapToGlobal(). -.SH "void QCursor::setPos ( const QPoint & )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QCursor::setShape ( int shape )" -Sets the cursor to the shape identified by \fIshape\fR. -.PP -See CursorShape for the list of cursor shapes. -.PP -See also shape(). -.SH "int QCursor::shape () const" -Returns the cursor shape identifier. The return value is one of the CursorShape enum values (cast to an int). -.PP -See also setShape(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QCursor & c )" -Writes the cursor \fIc\fR to the stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QCursor & c )" -Reads a cursor from the stream \fIs\fR and sets \fIc\fR to the read data. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqcursor.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcursor.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcustomevent.3qt b/doc/man/man3/qcustomevent.3qt deleted file mode 100644 index a76cf9063..000000000 --- a/doc/man/man3/qcustomevent.3qt +++ /dev/null @@ -1,130 +0,0 @@ -'\" t -.TH QCustomEvent 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 -QCustomEvent \- Support for custom events -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCustomEvent\fR ( int type )" -.br -.ti -1c -.BI "\fBQCustomEvent\fR ( Type type, void * data )" -.br -.ti -1c -.BI "void * \fBdata\fR () const" -.br -.ti -1c -.BI "void \fBsetData\fR ( void * data )" -.br -.in -1c -.SH DESCRIPTION -The QCustomEvent class provides support for custom events. -.PP -QCustomEvent is a generic event class for user-defined events. User defined events can be sent to widgets or other QObject instances using QApplication::postEvent() or QApplication::sendEvent(). Subclasses of QObject can easily receive custom events by implementing the QObject::customEvent() event handler function. -.PP -QCustomEvent objects should be created with a type ID that uniquely identifies the event type. To avoid clashes with the Qt-defined events types, the value should be at least as large as the value of the "User" entry in the QEvent::Type enum. -.PP -QCustomEvent contains a generic void* data member that may be used for transferring event-specific data to the receiver. Note that since events are normally delivered asynchronously, the data pointer, if used, must remain valid until the event has been received and processed. -.PP -QCustomEvent can be used as-is for simple user-defined event types, but normally you will want to make a subclass of it for your event types. In a subclass, you can add data members that are suitable for your event type. -.PP -Example: -.PP -.nf -.br - class ColorChangeEvent : public QCustomEvent -.br - { -.br - public: -.br - ColorChangeEvent( QColor color ) -.br - : QCustomEvent( 65432 ), c( color ) {} -.br - QColor color() const { return c; } -.br - private: -.br - QColor c; -.br - }; -.br -.br - // To send an event of this custom event type: -.br -.br - ColorChangeEvent* ce = new ColorChangeEvent( blue ); -.br - QApplication::postEvent( receiver, ce ); // Qt will delete it when done -.br -.br - // To receive an event of this custom event type: -.br -.br - void MyWidget::customEvent( QCustomEvent * e ) -.br - { -.br - if ( e->type() == 65432 ) { // It must be a ColorChangeEvent -.br - ColorChangeEvent* ce = (ColorChangeEvent*)e; -.br - newColor = ce->color(); -.br - } -.br - } -.br -.fi -.PP -See also QWidget::customEvent(), QApplication::notify(), and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCustomEvent::QCustomEvent ( int type )" -Constructs a custom event object with event type \fItype\fR. The value of \fItype\fR must be at least as large as QEvent::User. The data pointer is set to 0. -.SH "QCustomEvent::QCustomEvent ( Type type, void * data )" -Constructs a custom event object with the event type \fItype\fR and a pointer to \fIdata\fR. (Note that any int value may safely be cast to QEvent::Type). -.SH "void * QCustomEvent::data () const" -Returns a pointer to the generic event data. -.PP -See also setData(). -.SH "void QCustomEvent::setData ( void * data )" -Sets the generic data pointer to \fIdata\fR. -.PP -See also data(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcustomevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcustomevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qcustommenuitem.3qt b/doc/man/man3/qcustommenuitem.3qt deleted file mode 100644 index 13e999827..000000000 --- a/doc/man/man3/qcustommenuitem.3qt +++ /dev/null @@ -1,106 +0,0 @@ -'\" t -.TH QCustomMenuItem 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 -QCustomMenuItem \- Abstract base class for custom menu items in popup menus -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQCustomMenuItem\fR ()" -.br -.ti -1c -.BI "virtual \fB~QCustomMenuItem\fR ()" -.br -.ti -1c -.BI "virtual bool \fBfullSpan\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisSeparator\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFont\fR ( const QFont & font )" -.br -.ti -1c -.BI "virtual void \fBpaint\fR ( QPainter * p, const QColorGroup & cg, bool act, bool enabled, int x, int y, int w, int h ) = 0" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QCustomMenuItem class is an abstract base class for custom menu items in popup menus. -.PP -A custom menu item is a menu item that is defined by two pure virtual functions, paint() and sizeHint(). The size hint tells the menu how much space it needs to reserve for this item, and paint is called whenever the item needs painting. -.PP -This simple mechanism allows you to create all kinds of application specific menu items. Examples are items showing different fonts in a word processor or menus that allow the selection of drawing utilities in a vector drawing program. -.PP -A custom item is inserted into a popup menu with QPopupMenu::insertItem(). -.PP -By default, a custom item can also have an icon and a keyboard accelerator. You can reimplement fullSpan() to return TRUE if you want the item to span the entire popup menu width. This is particularly useful for labels. -.PP -If you want the custom item to be treated just as a separator, reimplement isSeparator() to return TRUE. -.PP -Note that you can insert pixmaps or bitmaps as items into a popup menu without needing to create a QCustomMenuItem. However, custom menu items offer more flexibility, and -- especially important with Windows style -- provide the possibility of drawing the item with a different color when it is highlighted. -.PP -menu/menu.cpp shows a simple example how custom menu items can be used. -.PP -Note: the current implementation of QCustomMenuItem will not recognize shortcut keys that are from text with ampersands. Normal accelerators work though. -.PP -.ce 1 -.B "[Image Omitted]" -.PP -See also QMenuData, QPopupMenu, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCustomMenuItem::QCustomMenuItem ()" -Constructs a QCustomMenuItem -.SH "QCustomMenuItem::~QCustomMenuItem ()\fC [virtual]\fR" -Destroys a QCustomMenuItem -.SH "bool QCustomMenuItem::fullSpan () const\fC [virtual]\fR" -Returns TRUE if this item wants to span the entire popup menu width; otherwise returns FALSE. The default is FALSE, meaning that the menu may show an icon and an accelerator key for this item as well. -.SH "bool QCustomMenuItem::isSeparator () const\fC [virtual]\fR" -Returns TRUE if this item is just a separator; otherwise returns FALSE. -.SH "void QCustomMenuItem::paint ( QPainter * p, const QColorGroup & cg, bool act, bool enabled, int x, int y, int w, int h )\fC [pure virtual]\fR" -Paints this item. When this function is invoked, the painter \fIp\fR is set to a font and foreground color suitable for a menu item text using color group \fIcg\fR. The item is active if \fIact\fR is TRUE and enabled if \fIenabled\fR is TRUE. The geometry values \fIx\fR, \fIy\fR, \fIw\fR and \fIh\fR specify where to draw the item. -.PP -Do not draw any background, this has already been done by the popup menu according to the current GUI style. -.SH "void QCustomMenuItem::setFont ( const QFont & font )\fC [virtual]\fR" -Sets the font of the custom menu item to \fIfont\fR. -.PP -This function is called whenever the font in the popup menu changes. For menu items that show their own individual font entry, you want to ignore this. -.SH "QSize QCustomMenuItem::sizeHint ()\fC [pure virtual]\fR" -Returns the item's size hint. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qcustommenuitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qcustommenuitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdatabrowser.3qt b/doc/man/man3/qdatabrowser.3qt deleted file mode 100644 index e5c22c2a8..000000000 --- a/doc/man/man3/qdatabrowser.3qt +++ /dev/null @@ -1,593 +0,0 @@ -'\" t -.TH QDataBrowser 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 -QDataBrowser \- Data manipulation and navigation for data entry forms -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDataBrowser\fR ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" -.br -.ti -1c -.BI "\fB~QDataBrowser\fR ()" -.br -.ti -1c -.BI "enum \fBBoundary\fR { Unknown, None, BeforeBeginning, Beginning, End, AfterEnd }" -.br -.ti -1c -.BI "Boundary \fBboundary\fR ()" -.br -.ti -1c -.BI "void \fBsetBoundaryChecking\fR ( bool active )" -.br -.ti -1c -.BI "bool \fBboundaryChecking\fR () const" -.br -.ti -1c -.BI "void \fBsetSort\fR ( const QSqlIndex & sort )" -.br -.ti -1c -.BI "void \fBsetSort\fR ( const QStringList & sort )" -.br -.ti -1c -.BI "QStringList \fBsort\fR () const" -.br -.ti -1c -.BI "void \fBsetFilter\fR ( const QString & filter )" -.br -.ti -1c -.BI "QString \fBfilter\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSqlCursor\fR ( QSqlCursor * cursor, bool autoDelete = FALSE )" -.br -.ti -1c -.BI "QSqlCursor * \fBsqlCursor\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetForm\fR ( QSqlForm * form )" -.br -.ti -1c -.BI "QSqlForm * \fBform\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetConfirmEdits\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmInsert\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmUpdate\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmDelete\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmCancels\fR ( bool confirm )" -.br -.ti -1c -.BI "bool \fBconfirmEdits\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmInsert\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmUpdate\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmDelete\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmCancels\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetReadOnly\fR ( bool active )" -.br -.ti -1c -.BI "bool \fBisReadOnly\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoEdit\fR ( bool autoEdit )" -.br -.ti -1c -.BI "bool \fBautoEdit\fR () const" -.br -.ti -1c -.BI "virtual bool \fBseek\fR ( int i, bool relative = FALSE )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBrefresh\fR ()" -.br -.ti -1c -.BI "virtual void \fBinsert\fR ()" -.br -.ti -1c -.BI "virtual void \fBupdate\fR ()" -.br -.ti -1c -.BI "virtual void \fBdel\fR ()" -.br -.ti -1c -.BI "virtual void \fBfirst\fR ()" -.br -.ti -1c -.BI "virtual void \fBlast\fR ()" -.br -.ti -1c -.BI "virtual void \fBnext\fR ()" -.br -.ti -1c -.BI "virtual void \fBprev\fR ()" -.br -.ti -1c -.BI "virtual void \fBreadFields\fR ()" -.br -.ti -1c -.BI "virtual void \fBwriteFields\fR ()" -.br -.ti -1c -.BI "virtual void \fBclearValues\fR ()" -.br -.ti -1c -.BI "void \fBupdateBoundary\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBfirstRecordAvailable\fR ( bool available )" -.br -.ti -1c -.BI "void \fBlastRecordAvailable\fR ( bool available )" -.br -.ti -1c -.BI "void \fBnextRecordAvailable\fR ( bool available )" -.br -.ti -1c -.BI "void \fBprevRecordAvailable\fR ( bool available )" -.br -.ti -1c -.BI "void \fBcurrentChanged\fR ( const QSqlRecord * record )" -.br -.ti -1c -.BI "void \fBprimeInsert\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBprimeUpdate\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBprimeDelete\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBbeforeInsert\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBbeforeUpdate\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBbeforeDelete\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBcursorChanged\fR ( QSqlCursor::Mode mode )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoEdit\fR - whether the browser automatically applies edits" -.br -.ti -1c -.BI "bool \fBboundaryChecking\fR - whether boundary checking is active" -.br -.ti -1c -.BI "bool \fBconfirmCancels\fR - whether the browser confirms cancel operations" -.br -.ti -1c -.BI "bool \fBconfirmDelete\fR - whether the browser confirms deletions" -.br -.ti -1c -.BI "bool \fBconfirmEdits\fR - whether the browser confirms edits" -.br -.ti -1c -.BI "bool \fBconfirmInsert\fR - whether the data browser confirms insertions" -.br -.ti -1c -.BI "bool \fBconfirmUpdate\fR - whether the browser confirms updates" -.br -.ti -1c -.BI "QString \fBfilter\fR - the data browser's filter" -.br -.ti -1c -.BI "bool \fBreadOnly\fR - whether the browser is read-only" -.br -.ti -1c -.BI "QStringList \fBsort\fR - the data browser's sort" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBinsertCurrent\fR ()" -.br -.ti -1c -.BI "virtual bool \fBupdateCurrent\fR ()" -.br -.ti -1c -.BI "virtual bool \fBdeleteCurrent\fR ()" -.br -.ti -1c -.BI "virtual bool \fBcurrentEdited\fR ()" -.br -.ti -1c -.BI "virtual QSql::Confirm \fBconfirmEdit\fR ( QSql::Op m )" -.br -.ti -1c -.BI "virtual QSql::Confirm \fBconfirmCancel\fR ( QSql::Op m )" -.br -.ti -1c -.BI "virtual void \fBhandleError\fR ( const QSqlError & error )" -.br -.in -1c -.SH DESCRIPTION -The QDataBrowser class provides data manipulation and navigation for data entry forms. -.PP -A high-level API is provided for navigating through data records in a cursor, for inserting, updating and deleting records, and for refreshing data in the display. -.PP -If you want a read-only form to present database data use QDataView; if you want a table-based presentation of your data use QDataTable. -.PP -A QDataBrowser is used to associate a dataset with a form in much the same way as a QDataTable associates a dataset with a table. Once the data browser has been constructed it can be associated with a dataset with setSqlCursor(), and with a form with setForm(). Boundary checking, sorting and filtering can be set with setBoundaryChecking(), setSort() and setFilter(), respectively. -.PP -The insertCurrent() function reads the fields from the default form into the default cursor and performs the insert. The updateCurrent() and deleteCurrent() functions perform similarly to update and delete the current record respectively. -.PP -The user can be asked to confirm all edits with setConfirmEdits(). For more precise control use setConfirmInsert(), setConfirmUpdate(), setConfirmDelete() and setConfirmCancels(). Use setAutoEdit() to control the behaviour of the form when the user edits a record and then navigates. -.PP -The record set is navigated using first(), next(), prev(), last() and seek(). The form's display is updated with refresh(). When navigation takes place the firstRecordAvailable(), lastRecordAvailable(), nextRecordAvailable() and prevRecordAvailable() signals are emitted. When the cursor record is changed due to navigation the cursorChanged() signal is emitted. -.PP -If you want finer control of the insert, update and delete processes then you can use the lower level functions to perform these operations as described below. -.PP -The form is populated with data from the database with readFields(). If the user is allowed to edit, (see setReadOnly()), write the form's data back to the cursor's edit buffer with writeFields(). You can clear the values in the form with clearValues(). Editing is performed as follows: -.TP -\fIinsert\fR When the data browser enters insertion mode it emits the primeInsert() signal which you can connect to, for example to pre-populate fields. Call writeFields() to write the user's edits to the cursor's edit buffer then call insert() to insert the record into the database. The beforeInsert() signal is emitted just before the cursor's edit buffer is inserted into the database; connect to this for example, to populate fields such as an auto-generated primary key. -.TP -\fIupdate\fR For updates the primeUpdate() signal is emitted when the data browser enters update mode. After calling writeFields() call update() to update the record and connect to the beforeUpdate() signal to manipulate the user's data before the update takes place. -.TP -\fIdelete\fR For deletion the primeDelete() signal is emitted when the data browser enters deletion mode. After calling writeFields() call del() to delete the record and connect to the beforeDelete() signal, for example to record an audit of the deleted record. -.PP -See also Database Classes. -.SS "Member Type Documentation" -.SH "QDataBrowser::Boundary" -This enum describes where the data browser is positioned. -.TP -\fCQDataBrowser::Unknown\fR - the boundary cannot be determined (usually because there is no default cursor, or the default cursor is not active). -.TP -\fCQDataBrowser::None\fR - the browser is not positioned on a boundary, but it is positioned on a record somewhere in the middle. -.TP -\fCQDataBrowser::BeforeBeginning\fR - the browser is positioned before the first available record. -.TP -\fCQDataBrowser::Beginning\fR - the browser is positioned at the first record. -.TP -\fCQDataBrowser::End\fR - the browser is positioned at the last record. -.TP -\fCQDataBrowser::AfterEnd\fR - the browser is positioned after the last available record. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDataBrowser::QDataBrowser ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" -Constructs a data browser which is a child of \fIparent\fR, with the name \fIname\fR and widget flags set to \fIfl\fR. -.SH "QDataBrowser::~QDataBrowser ()" -Destroys the object and frees any allocated resources. -.SH "bool QDataBrowser::autoEdit () const" -Returns TRUE if the browser automatically applies edits; otherwise returns FALSE. See the "autoEdit" property for details. -.SH "void QDataBrowser::beforeDelete ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted just before the cursor's edit buffer is deleted from the database. The \fIbuf\fR parameter points to the edit buffer being deleted. You might connect to this signal to capture some auditing information about the deletion. -.SH "void QDataBrowser::beforeInsert ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted just before the cursor's edit buffer is inserted into the database. The \fIbuf\fR parameter points to the edit buffer being inserted. You might connect to this signal to populate a generated primary key for example. -.SH "void QDataBrowser::beforeUpdate ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted just before the cursor's edit buffer is updated in the database. The \fIbuf\fR parameter points to the edit buffer being updated. You might connect to this signal to capture some auditing information about the update. -.SH "Boundary QDataBrowser::boundary ()" -Returns an enum indicating the boundary status of the browser. -.PP -This is achieved by moving the default cursor and checking the position, however the current default form values will not be altered. After checking for the boundary, the cursor is moved back to its former position. See QDataBrowser::Boundary. -.PP -See also Boundary. -.SH "bool QDataBrowser::boundaryChecking () const" -Returns TRUE if boundary checking is active; otherwise returns FALSE. See the "boundaryChecking" property for details. -.SH "void QDataBrowser::clearValues ()\fC [virtual slot]\fR" -Clears all the values in the form. -.PP -All the edit buffer field values are set to their 'zero state', e.g. 0 for numeric fields and "" for string fields. Then the widgets are updated using the property map. For example, a combobox that is property-mapped to integers would scroll to the first item. See the QSqlPropertyMap constructor for the default mappings of widgets to properties. -.SH "QSql::Confirm QDataBrowser::confirmCancel ( QSql::Op m )\fC [virtual protected]\fR" -Protected virtual function which returns a confirmation for cancelling an edit mode \fIm\fR. Derived classes can reimplement this function and provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action. -.SH "bool QDataBrowser::confirmCancels () const" -Returns TRUE if the browser confirms cancel operations; otherwise returns FALSE. See the "confirmCancels" property for details. -.SH "bool QDataBrowser::confirmDelete () const" -Returns TRUE if the browser confirms deletions; otherwise returns FALSE. See the "confirmDelete" property for details. -.SH "QSql::Confirm QDataBrowser::confirmEdit ( QSql::Op m )\fC [virtual protected]\fR" -Protected virtual function which returns a confirmation for an edit of mode \fIm\fR. Derived classes can reimplement this function and provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action. -.SH "bool QDataBrowser::confirmEdits () const" -Returns TRUE if the browser confirms edits; otherwise returns FALSE. See the "confirmEdits" property for details. -.SH "bool QDataBrowser::confirmInsert () const" -Returns TRUE if the data browser confirms insertions; otherwise returns FALSE. See the "confirmInsert" property for details. -.SH "bool QDataBrowser::confirmUpdate () const" -Returns TRUE if the browser confirms updates; otherwise returns FALSE. See the "confirmUpdate" property for details. -.SH "void QDataBrowser::currentChanged ( const QSqlRecord * record )\fC [signal]\fR" -This signal is emitted whenever the current cursor position changes. The \fIrecord\fR parameter points to the contents of the current cursor's record. -.SH "bool QDataBrowser::currentEdited ()\fC [virtual protected]\fR" -Returns TRUE if the form's edit buffer differs from the current cursor buffer; otherwise returns FALSE. -.SH "void QDataBrowser::cursorChanged ( QSqlCursor::Mode mode )\fC [signal]\fR" -This signal is emitted whenever the cursor record was changed due to navigation. The \fImode\fR parameter is the edit that just took place, e.g. Insert, Update or Delete. See QSqlCursor::Mode. -.SH "void QDataBrowser::del ()\fC [virtual slot]\fR" -Performs a delete operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens. -.PP -Otherwise, the following happens: -.PP -The current form's record is deleted from the database, providing that the data browser is not in insert mode. If the data browser is actively inserting a record (see insert()), the insert action is canceled, and the browser navigates to the last valid record that was current. If there is an error, handleError() is called. -.SH "bool QDataBrowser::deleteCurrent ()\fC [virtual protected]\fR" -Performs a delete on the default cursor using the values from the default form and updates the default form. If there is no default form or no default cursor, nothing happens. If the deletion was successful, the cursor is repositioned to the nearest record and TRUE is returned. The nearest record is the next record if there is one otherwise the previous record if there is one. If an error occurred during the deletion from the database, handleError() is called and FALSE is returned. -.PP -See also cursor, form(), and handleError(). -.SH "QString QDataBrowser::filter () const" -Returns the data browser's filter. See the "filter" property for details. -.SH "void QDataBrowser::first ()\fC [virtual slot]\fR" -Moves the default cursor to the first record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the first record, the default cursor is primed for update and the primeUpdate() signal is emitted. -.PP -If the browser is already positioned on the first record nothing happens. -.SH "void QDataBrowser::firstRecordAvailable ( bool available )\fC [signal]\fR" -This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the first record in the default cursor is available. -.SH "QSqlForm * QDataBrowser::form ()" -Returns the data browser's default form or 0 if no form has been set. -.SH "void QDataBrowser::handleError ( const QSqlError & error )\fC [virtual protected]\fR" -Virtual function which handles the error \fIerror\fR. The default implementation warns the user with a message box. -.SH "void QDataBrowser::insert ()\fC [virtual slot]\fR" -Performs an insert operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens. -.PP -If auto-editing is on (see setAutoEdit()), the following happens: -.TP -If the browser is already actively inserting a record, the current form's data is inserted into the database. -.TP -If the browser is not inserting a record, but the current record was changed by the user, the record is updated in the database with the current form's data (i.e. with the changes). -.PP -If there is an error handling any of the above auto-edit actions, handleError() is called and no insert or update is performed. -.PP -If no error occurred, or auto-editing is not enabled, the data browser begins actively inserting a record into the database by performing the following actions: -.TP -The default cursor is primed for insert using QSqlCursor::primeInsert(). -.TP -The primeInsert() signal is emitted. -.TP -The form is updated with the values in the default cursor's. edit buffer so that the user can fill in the values to be inserted. -.SH "bool QDataBrowser::insertCurrent ()\fC [virtual protected]\fR" -Reads the fields from the default form into the default cursor and performs an insert on the default cursor. If there is no default form or no default cursor, nothing happens. If an error occurred during the insert into the database, handleError() is called and FALSE is returned. If the insert was successfull, the cursor is refreshed and relocated to the newly inserted record, the cursorChanged() signal is emitted, and TRUE is returned. -.PP -See also cursorChanged(), sqlCursor(), form(), and handleError(). -.SH "bool QDataBrowser::isReadOnly () const" -Returns TRUE if the browser is read-only; otherwise returns FALSE. See the "readOnly" property for details. -.SH "void QDataBrowser::last ()\fC [virtual slot]\fR" -Moves the default cursor to the last record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the last record, the default cursor is primed for update and the primeUpdate() signal is emitted. -.PP -If the browser is already positioned on the last record nothing happens. -.SH "void QDataBrowser::lastRecordAvailable ( bool available )\fC [signal]\fR" -This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the last record in the default cursor is available. -.SH "void QDataBrowser::next ()\fC [virtual slot]\fR" -Moves the default cursor to the next record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the next record, the default cursor is primed for update and the primeUpdate() signal is emitted. -.PP -If the browser is positioned on the last record nothing happens. -.SH "void QDataBrowser::nextRecordAvailable ( bool available )\fC [signal]\fR" -This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the next record in the default cursor is available. -.SH "void QDataBrowser::prev ()\fC [virtual slot]\fR" -Moves the default cursor to the previous record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the previous record, the default cursor is primed for update and the primeUpdate() signal is emitted. -.PP -If the browser is positioned on the first record nothing happens. -.SH "void QDataBrowser::prevRecordAvailable ( bool available )\fC [signal]\fR" -This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the previous record in the default cursor is available. -.SH "void QDataBrowser::primeDelete ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted when the data browser enters deletion mode. The \fIbuf\fR parameter points to the record buffer being deleted. (Note that QSqlCursor::primeDelete() is \fInot\fR called on the default cursor, as this would corrupt values in the form.) Connect to this signal in order to, for example, save a copy of the deleted record for auditing purposes. -.PP -See also del(). -.SH "void QDataBrowser::primeInsert ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted when the data browser enters insertion mode. The \fIbuf\fR parameter points to the record buffer that is to be inserted. Connect to this signal to, for example, prime the record buffer with default data values, auto-numbered fields etc. (Note that QSqlCursor::primeInsert() is \fInot\fR called on the default cursor, as this would corrupt values in the form.) -.PP -See also insert(). -.SH "void QDataBrowser::primeUpdate ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted when the data browser enters update mode. Note that during navigation (first(), last(), next(), prev()), each record that is shown in the default form is primed for update. The \fIbuf\fR parameter points to the record buffer being updated. (Note that QSqlCursor::primeUpdate() is \fInot\fR called on the default cursor, as this would corrupt values in the form.) Connect to this signal in order to, for example, keep track of which records have been updated, perhaps for auditing purposes. -.PP -See also update(). -.SH "void QDataBrowser::readFields ()\fC [virtual slot]\fR" -Reads the fields from the default cursor's edit buffer and displays them in the form. If there is no default cursor or no default form, nothing happens. -.SH "void QDataBrowser::refresh ()\fC [virtual slot]\fR" -Refreshes the data browser's data using the default cursor. The browser's current filter and sort are applied if they have been set. -.PP -See also filter and sort. -.SH "bool QDataBrowser::seek ( int i, bool relative = FALSE )\fC [virtual]\fR" -Moves the default cursor to the record specified by the index \fIi\fR and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If \fIrelative\fR is TRUE (the default is FALSE), the cursor is moved relative to its current position. If the data browser successfully navigated to the desired record, the default cursor is primed for update and the primeUpdate() signal is emitted. -.PP -If the browser is already positioned on the desired record nothing happens. -.SH "void QDataBrowser::setAutoEdit ( bool autoEdit )\fC [virtual]\fR" -Sets whether the browser automatically applies edits to \fIautoEdit\fR. See the "autoEdit" property for details. -.SH "void QDataBrowser::setBoundaryChecking ( bool active )" -Sets whether boundary checking is active to \fIactive\fR. See the "boundaryChecking" property for details. -.SH "void QDataBrowser::setConfirmCancels ( bool confirm )\fC [virtual]\fR" -Sets whether the browser confirms cancel operations to \fIconfirm\fR. See the "confirmCancels" property for details. -.SH "void QDataBrowser::setConfirmDelete ( bool confirm )\fC [virtual]\fR" -Sets whether the browser confirms deletions to \fIconfirm\fR. See the "confirmDelete" property for details. -.SH "void QDataBrowser::setConfirmEdits ( bool confirm )\fC [virtual]\fR" -Sets whether the browser confirms edits to \fIconfirm\fR. See the "confirmEdits" property for details. -.SH "void QDataBrowser::setConfirmInsert ( bool confirm )\fC [virtual]\fR" -Sets whether the data browser confirms insertions to \fIconfirm\fR. See the "confirmInsert" property for details. -.SH "void QDataBrowser::setConfirmUpdate ( bool confirm )\fC [virtual]\fR" -Sets whether the browser confirms updates to \fIconfirm\fR. See the "confirmUpdate" property for details. -.SH "void QDataBrowser::setFilter ( const QString & filter )" -Sets the data browser's filter to \fIfilter\fR. See the "filter" property for details. -.SH "void QDataBrowser::setForm ( QSqlForm * form )\fC [virtual]\fR" -Sets the browser's default form to \fIform\fR. The cursor and all navigation and data manipulation functions that the browser provides become available to the \fIform\fR. -.SH "void QDataBrowser::setReadOnly ( bool active )\fC [virtual]\fR" -Sets whether the browser is read-only to \fIactive\fR. See the "readOnly" property for details. -.SH "void QDataBrowser::setSort ( const QStringList & sort )" -Sets the data browser's sort to \fIsort\fR. See the "sort" property for details. -.SH "void QDataBrowser::setSort ( const QSqlIndex & sort )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the data browser's sort to the QSqlIndex \fIsort\fR. To apply the new sort, use refresh(). -.SH "void QDataBrowser::setSqlCursor ( QSqlCursor * cursor, bool autoDelete = FALSE )\fC [virtual]\fR" -Sets the default cursor used by the data browser to \fIcursor\fR. If \fIautoDelete\fR is TRUE (the default is FALSE), the data browser takes ownership of the \fIcursor\fR pointer, which will be deleted when the browser is destroyed, or when setSqlCursor() is called again. To activate the \fIcursor\fR use refresh(). The cursor's edit buffer is used in the default form to browse and edit records. -.PP -See also sqlCursor(), form(), and setForm(). -.SH "QStringList QDataBrowser::sort () const" -Returns the data browser's sort. See the "sort" property for details. -.SH "QSqlCursor * QDataBrowser::sqlCursor () const" -Returns the default cursor used for navigation, or 0 if there is no default cursor. -.PP -See also setSqlCursor(). -.SH "void QDataBrowser::update ()\fC [virtual slot]\fR" -Performs an update operation on the data browser's cursor. -.PP -If there is no default cursor or no default form, nothing happens. Otherwise, the following happens: -.PP -If the data browser is actively inserting a record (see insert()), that record is inserted into the database using insertCurrent(). Otherwise, the database is updated with the current form's data using updateCurrent(). If there is an error handling either action, handleError() is called. -.SH "void QDataBrowser::updateBoundary ()\fC [slot]\fR" -If boundaryChecking() is TRUE, checks the boundary of the current default cursor and emits signals which indicate the position of the cursor. -.SH "bool QDataBrowser::updateCurrent ()\fC [virtual protected]\fR" -Reads the fields from the default form into the default cursor and performs an update on the default cursor. If there is no default form or no default cursor, nothing happens. If an error occurred during the update on the database, handleError() is called and FALSE is returned. If the update was successfull, the cursor is refreshed and relocated to the updated record, the cursorChanged() signal is emitted, and TRUE is returned. -.PP -See also cursor, form(), and handleError(). -.SH "void QDataBrowser::writeFields ()\fC [virtual slot]\fR" -Writes the form's data to the default cursor's edit buffer. If there is no default cursor or no default form, nothing happens. -.SS "Property Documentation" -.SH "bool autoEdit" -This property holds whether the browser automatically applies edits. -.PP -The default value for this property is TRUE. When the user begins an insertion or an update on a form there are two possible outcomes when they navigate to another record: -.TP -the insert or update is is performed -- this occurs if autoEdit is TRUE -.TP -the insert or update is discarded -- this occurs if autoEdit is FALSE -.PP -Set this property's value with setAutoEdit() and get this property's value with autoEdit(). -.SH "bool boundaryChecking" -This property holds whether boundary checking is active. -.PP -When boundary checking is active (the default), signals are emitted indicating the current position of the default cursor. -.PP -See also boundary(). -.PP -Set this property's value with setBoundaryChecking() and get this property's value with boundaryChecking(). -.SH "bool confirmCancels" -This property holds whether the browser confirms cancel operations. -.PP -If this property is TRUE, all cancels must be confirmed by the user through a message box (this behavior can be changed by overriding the confirmCancel() function), otherwise all cancels occur immediately. The default is FALSE. -.PP -See also confirmEdits and confirmCancel(). -.PP -Set this property's value with setConfirmCancels() and get this property's value with confirmCancels(). -.SH "bool confirmDelete" -This property holds whether the browser confirms deletions. -.PP -If this property is TRUE, the browser confirms deletions, otherwise deletions happen immediately. -.PP -See also confirmCancels, confirmEdits, confirmUpdate, confirmInsert, and confirmEdit(). -.PP -Set this property's value with setConfirmDelete() and get this property's value with confirmDelete(). -.SH "bool confirmEdits" -This property holds whether the browser confirms edits. -.PP -If this property is TRUE, the browser confirms all edit operations (insertions, updates and deletions), otherwise all edit operations happen immediately. Confirmation is achieved by presenting the user with a message box -- this behavior can be changed by reimplementing the confirmEdit() function, -.PP -See also confirmEdit(), confirmCancels, confirmInsert, confirmUpdate, and confirmDelete. -.PP -Set this property's value with setConfirmEdits() and get this property's value with confirmEdits(). -.SH "bool confirmInsert" -This property holds whether the data browser confirms insertions. -.PP -If this property is TRUE, the browser confirms insertions, otherwise insertions happen immediately. -.PP -See also confirmCancels, confirmEdits, confirmUpdate, confirmDelete, and confirmEdit(). -.PP -Set this property's value with setConfirmInsert() and get this property's value with confirmInsert(). -.SH "bool confirmUpdate" -This property holds whether the browser confirms updates. -.PP -If this property is TRUE, the browser confirms updates, otherwise updates happen immediately. -.PP -See also confirmCancels, confirmEdits, confirmInsert, confirmDelete, and confirmEdit(). -.PP -Set this property's value with setConfirmUpdate() and get this property's value with confirmUpdate(). -.SH "QString filter" -This property holds the data browser's filter. -.PP -The filter applies to the data shown in the browser. Call refresh() to apply the new filter. A filter is a string containing a SQL WHERE clause without the WHERE keyword, e.g. "id>1000"," name LIKE 'A%'", etc. -.PP -There is no default filter. -.PP -See also sort. -.PP -Set this property's value with setFilter() and get this property's value with filter(). -.SH "bool readOnly" -This property holds whether the browser is read-only. -.PP -The default is FALSE, i.e. data can be edited. If the data browser is read-only, no database edits will be allowed. -.PP -Set this property's value with setReadOnly() and get this property's value with isReadOnly(). -.SH "QStringList sort" -This property holds the data browser's sort. -.PP -The data browser's sort affects the order in which records are viewed in the browser. Call refresh() to apply the new sort. -.PP -When retrieving the sort property, a string list is returned in the form 'fieldname order', e.g. 'id ASC', 'surname DESC'. -.PP -There is no default sort. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myDataBrowser.sort(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -Set this property's value with setSort() and get this property's value with sort(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdatabrowser.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdatabrowser.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdatastream.3qt b/doc/man/man3/qdatastream.3qt deleted file mode 100644 index b4c5222eb..000000000 --- a/doc/man/man3/qdatastream.3qt +++ /dev/null @@ -1,563 +0,0 @@ -'\" t -.TH QDataStream 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 -QDataStream \- Serialization of binary data to a QIODevice -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

              -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDataStream\fR ()" -.br -.ti -1c -.BI "\fBQDataStream\fR ( QIODevice * d )" -.br -.ti -1c -.BI "\fBQDataStream\fR ( QByteArray a, int mode )" -.br -.ti -1c -.BI "virtual \fB~QDataStream\fR ()" -.br -.ti -1c -.BI "QIODevice * \fBdevice\fR () const" -.br -.ti -1c -.BI "void \fBsetDevice\fR ( QIODevice * d )" -.br -.ti -1c -.BI "void \fBunsetDevice\fR ()" -.br -.ti -1c -.BI "bool \fBatEnd\fR () const" -.br -.ti -1c -.BI "bool eof () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "enum \fBByteOrder\fR { BigEndian, LittleEndian }" -.br -.ti -1c -.BI "int \fBbyteOrder\fR () const" -.br -.ti -1c -.BI "void \fBsetByteOrder\fR ( int bo )" -.br -.ti -1c -.BI "bool \fBisPrintableData\fR () const" -.br -.ti -1c -.BI "void \fBsetPrintableData\fR ( bool enable )" -.br -.ti -1c -.BI "int \fBversion\fR () const" -.br -.ti -1c -.BI "void \fBsetVersion\fR ( int v )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT8 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT8 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT16 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT16 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT32 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT32 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT64 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT64 & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_LONG & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_ULONG & i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( float & f )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( double & f )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( char *& s )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT8 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT8 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT16 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT16 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT32 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT32 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT64 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT64 i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_LONG i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_ULONG i )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( float f )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( double f )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( const char * s )" -.br -.ti -1c -.BI "QDataStream & \fBreadBytes\fR ( char *& s, uint & l )" -.br -.ti -1c -.BI "QDataStream & \fBreadRawBytes\fR ( char * s, uint len )" -.br -.ti -1c -.BI "QDataStream & \fBwriteBytes\fR ( const char * s, uint len )" -.br -.ti -1c -.BI "QDataStream & \fBwriteRawBytes\fR ( const char * s, uint len )" -.br -.in -1c -.SH DESCRIPTION -The QDataStream class provides serialization of binary data to a QIODevice. -.PP -A data stream is a binary stream of encoded information which is 100% independent of the host computer's operating system, CPU or byte order. For example, a data stream that is written by a PC under Windows can be read by a Sun SPARC running Solaris. -.PP -You can also use a data stream to read/write raw unencoded binary data. If you want a "parsing" input stream, see QTextStream. -.PP -The QDataStream class implements the serialization of C++'s basic data types, like \fCchar\fR, \fCshort\fR, \fCint\fR, \fCchar*\fR, etc. Serialization of more complex data is accomplished by breaking up the data into primitive units. -.PP -A data stream cooperates closely with a QIODevice. A QIODevice represents an input/output medium one can read data from and write data to. The QFile class is an example of an IO device. -.PP -Example (write binary data to a stream): -.PP -.nf -.br - QFile file( "file.dat" ); -.br - file.open( IO_WriteOnly ); -.br - QDataStream stream( &file ); // we will serialize the data into the file -.br - stream << "the answer is"; // serialize a string -.br - stream << (TQ_INT32)42; // serialize an integer -.br -.fi -.PP -Example (read binary data from a stream): -.PP -.nf -.br - QFile file( "file.dat" ); -.br - file.open( IO_ReadOnly ); -.br - QDataStream stream( &file ); // read the data serialized from the file -.br - QString str; -.br - TQ_INT32 a; -.br - stream >> str >> a; // extract "the answer is" and 42 -.br -.fi -.PP -Each item written to the stream is written in a predefined binary format that varies depending on the item's type. Supported Qt types include QBrush, QColor, QDateTime, QFont, QPixmap, QString, QVariant and many others. For the complete list of all Qt types supporting data streaming see the Format of the QDataStream operators. -.PP -For integers it is best to always cast to a Qt integer type for writing, and to read back into the same Qt integer type. This ensures that you get integers of the size you want and insulates you from compiler and platform differences. -.PP -To take one example, a \fCchar*\fR string is written as a 32-bit integer equal to the length of the string including the NUL byte ('\0'), followed by all the characters of the string including the NUL byte. When reading a \fCchar*\fR string, 4 bytes are read to create the 32-bit length value, then that many characters for the \fCchar*\fR string including the NUL are read. -.PP -The initial IODevice is usually set in the constructor, but can be changed with setDevice(). If you've reached the end of the data (or if there is no IODevice set) atEnd() will return TRUE. -.PP -If you want the data to be compatible with an earlier version of Qt use setVersion(). -.PP -If you want the data to be human-readable, e.g. for debugging, you can set the data stream into printable data mode with setPrintableData(). The data is then written slower, in a bloated but human readable format. -.PP -If you are producing a new binary data format, such as a file format for documents created by your application, you could use a QDataStream to write the data in a portable format. Typically, you would write a brief header containing a magic string and a version number to give yourself room for future expansion. For example: -.PP -.nf -.br - QFile file( "file.xxx" ); -.br - file.open( IO_WriteOnly ); -.br - QDataStream stream( &file ); -.br -.br - // Write a header with a "magic number" and a version -.br - stream << (TQ_UINT32)0xA0B0C0D0; -.br - stream << (TQ_INT32)123; -.br -.br - // Write the data -.br - stream << [lots of interesting data] -.br -.fi -.PP -Then read it in with: -.PP -.nf -.br - QFile file( "file.xxx" ); -.br - file.open( IO_ReadOnly ); -.br - QDataStream stream( &file ); -.br -.br - // Read and check the header -.br - TQ_UINT32 magic; -.br - stream >> magic; -.br - if ( magic != 0xA0B0C0D0 ) -.br - return XXX_BAD_FILE_FORMAT; -.br -.br - // Read the version -.br - TQ_INT32 version; -.br - stream >> version; -.br - if ( version < 100 ) -.br - return XXX_BAD_FILE_TOO_OLD; -.br - if ( version > 123 ) -.br - return XXX_BAD_FILE_TOO_NEW; -.br - if ( version <= 110 ) -.br - stream.setVersion(1); -.br -.br - // Read the data -.br - stream >> [lots of interesting data]; -.br - if ( version > 120 ) -.br - stream >> [data new in XXX version 1.2]; -.br - stream >> [other interesting data]; -.br -.fi -.PP -You can select which byte order to use when serializing data. The default setting is big endian (MSB first). Changing it to little endian breaks the portability (unless the reader also changes to little endian). We recommend keeping this setting unless you have special requirements. -.SH "Reading and writing raw binary data" -You may wish to read/write your own raw binary data to/from the data stream directly. Data may be read from the stream into a preallocated char* using readRawBytes(). Similarly data can be written to the stream using writeRawBytes(). Notice that any encoding/decoding of the data must be done by you. -.PP -A similar pair of functions is readBytes() and writeBytes(). These differ from their \fIraw\fR counterparts as follows: readBytes() reads a TQ_UINT32 which is taken to be the length of the data to be read, then that number of bytes is read into the preallocated char*; writeBytes() writes a TQ_UINT32 containing the length of the data, followed by the data. Notice that any encoding/decoding of the data (apart from the length TQ_UINT32) must be done by you. -.PP -See also QTextStream, QVariant, and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QDataStream::ByteOrder" -The byte order used for reading/writing the data. -.TP -\fCQDataStream::BigEndian\fR - the default -.TP -\fCQDataStream::LittleEndian\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDataStream::QDataStream ()" -Constructs a data stream that has no IO device. -.PP -See also setDevice(). -.SH "QDataStream::QDataStream ( QIODevice * d )" -Constructs a data stream that uses the IO device \fId\fR. -.PP -\fBWarning:\fR If you use QSocket or QSocketDevice as the IO device \fId\fR for reading data, you must make sure that enough data is available on the socket for the operation to successfully proceed; QDataStream does not have any means to handle or recover from short-reads. -.PP -See also setDevice() and device(). -.SH "QDataStream::QDataStream ( QByteArray a, int mode )" -Constructs a data stream that operates on a byte array, \fIa\fR, through an internal QBuffer device. The \fImode\fR is a QIODevice::mode(), usually either IO_ReadOnly or IO_WriteOnly. -.PP -Example: -.PP -.nf -.br - static char bindata[] = { 231, 1, 44, ... }; -.br - QByteArray a; -.br - a.setRawData( bindata, sizeof(bindata) ); // a points to bindata -.br - QDataStream stream( a, IO_ReadOnly ); // open on a's data -.br - stream >> [something]; // read raw bindata -.br - a.resetRawData( bindata, sizeof(bindata) ); // finished -.br -.fi -.PP -The QByteArray::setRawData() function is not for the inexperienced. -.SH "QDataStream::~QDataStream ()\fC [virtual]\fR" -Destroys the data stream. -.PP -The destructor will not affect the current IO device, unless it is an internal IO device processing a QByteArray passed in the \fIconstructor\fR, in which case the internal IO device is destroyed. -.SH "bool QDataStream::atEnd () const" -Returns TRUE if the IO device has reached the end position (end of the stream or file) or if there is no IO device set; otherwise returns FALSE, i.e. if the current position of the IO device is before the end position. -.PP -See also QIODevice::atEnd(). -.SH "int QDataStream::byteOrder () const" -Returns the current byte order setting -- either BigEndian or LittleEndian. -.PP -See also setByteOrder(). -.SH "QIODevice * QDataStream::device () const" -Returns the IO device currently set. -.PP -See also setDevice() and unsetDevice(). -.SH "bool QDataStream::eof () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if the IO device has reached the end position (end of stream or file) or if there is no IO device set. -.PP -Returns FALSE if the current position of the read/write head of the IO device is somewhere before the end position. -.PP -See also QIODevice::atEnd(). -.SH "bool QDataStream::isPrintableData () const" -Returns TRUE if the printable data flag has been set; otherwise returns FALSE. -.PP -See also setPrintableData(). -.SH "QDataStream & QDataStream::operator<< ( TQ_INT8 i )" -Writes a signed byte, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT8 i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an unsigned byte, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_INT16 i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a signed 16-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT16 i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an unsigned 16-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_INT32 i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a signed 32-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT32 i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an unsigned integer, \fIi\fR, to the stream as a 32-bit unsigned integer (TQ_UINT32). Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_INT64 i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a signed 64-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT64 i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an unsigned 64-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_LONG i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a signed integer \fIi\fR, of the system's word length, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_ULONG i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an unsigned integer \fIi\fR, of the system's word length, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( float f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a 32-bit floating point number, \fIf\fR, to the stream using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( double f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a 64-bit floating point number, \fIf\fR, to the stream using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( const char * s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes the '\0'-terminated string \fIs\fR to the stream and returns a reference to the stream. -.PP -The string is serialized using writeBytes(). -.SH "QDataStream & QDataStream::operator>> ( TQ_INT8 & i )" -Reads a signed byte from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT8 & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned byte from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_INT16 & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a signed 16-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT16 & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned 16-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_INT32 & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a signed 32-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT32 & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned 32-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_INT64 & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a signed 64-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT64 & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned 64-bit integer from the stream, into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_LONG & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a signed integer of the system's word length from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_ULONG & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned integer of the system's word length from the stream, into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( float & f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a 32-bit floating point number from the stream into \fIf\fR, using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( double & f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a 64-bit floating point number from the stream into \fIf\fR, using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( char *& s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads the '\0'-terminated string \fIs\fR from the stream and returns a reference to the stream. -.PP -Space for the string is allocated using \fCnew\fR -- the caller must destroy it with delete[]. -.SH "QDataStream & QDataStream::readBytes ( char *& s, uint & l )" -Reads the buffer \fIs\fR from the stream and returns a reference to the stream. -.PP -The buffer \fIs\fR is allocated using \fCnew\fR. Destroy it with the \fCdelete[]\fR operator. If the length is zero or \fIs\fR cannot be allocated, \fIs\fR is set to 0. -.PP -The \fIl\fR parameter will be set to the length of the buffer. -.PP -The serialization format is a TQ_UINT32 length specifier first, then \fIl\fR bytes of data. Note that the data is \fInot\fR encoded. -.PP -See also readRawBytes() and writeBytes(). -.SH "QDataStream & QDataStream::readRawBytes ( char * s, uint len )" -Reads \fIlen\fR bytes from the stream into \fIs\fR and returns a reference to the stream. -.PP -The buffer \fIs\fR must be preallocated. The data is \fInot\fR encoded. -.PP -See also readBytes(), QIODevice::readBlock(), and writeRawBytes(). -.SH "void QDataStream::setByteOrder ( int bo )" -Sets the serialization byte order to \fIbo\fR. -.PP -The \fIbo\fR parameter can be QDataStream::BigEndian or QDataStream::LittleEndian. -.PP -The default setting is big endian. We recommend leaving this setting unless you have special requirements. -.PP -See also byteOrder(). -.SH "void QDataStream::setDevice ( QIODevice * d )" -void QDataStream::setDevice(QIODevice *d ) -.PP -Sets the IO device to \fId\fR. -.PP -See also device() and unsetDevice(). -.SH "void QDataStream::setPrintableData ( bool enable )" -If \fIenable\fR is TRUE, data will be output in a human readable format. If \fIenable\fR is FALSE, data will be output in a binary format. -.PP -If \fIenable\fR is TRUE, the write functions will generate output that consists of printable characters (7 bit ASCII). This output will typically be a lot larger than the default binary output, and consequently slower to write. -.PP -We recommend only enabling printable data for debugging purposes. -.SH "void QDataStream::setVersion ( int v )" -Sets the version number of the data serialization format to \fIv\fR. -.PP -You don't need to set a version if you are using the current version of Qt. -.PP -In order to accommodate new functionality, the datastream serialization format of some Qt classes has changed in some versions of Qt. If you want to read data that was created by an earlier version of Qt, or write data that can be read by a program that was compiled with an earlier version of Qt, use this function to modify the serialization format of QDataStream. -.PP -
              .nf -.TS -l - l. Qt Version QDataStream Version Qt 3.3 6 Qt 3.2 5 Qt 3.1 5 Qt 3.0 4 Qt 2.1.x and Qt 2.2.x 3 Qt 2.0.x 2 Qt 1.x -.TE -.fi -
              -.PP -See also version(). -.SH "void QDataStream::unsetDevice ()" -Unsets the IO device. This is the same as calling setDevice( 0 ). -.PP -See also device() and setDevice(). -.SH "int QDataStream::version () const" -Returns the version number of the data serialization format. In Qt 3.1, this number is 5. -.PP -See also setVersion(). -.SH "QDataStream & QDataStream::writeBytes ( const char * s, uint len )" -Writes the length specifier \fIlen\fR and the buffer \fIs\fR to the stream and returns a reference to the stream. -.PP -The \fIlen\fR is serialized as a TQ_UINT32, followed by \fIlen\fR bytes from \fIs\fR. Note that the data is \fInot\fR encoded. -.PP -See also writeRawBytes() and readBytes(). -.SH "QDataStream & QDataStream::writeRawBytes ( const char * s, uint len )" -Writes \fIlen\fR bytes from \fIs\fR to the stream and returns a reference to the stream. The data is \fInot\fR encoded. -.PP -See also writeBytes(), QIODevice::writeBlock(), and readRawBytes(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdatastream.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdatastream.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdatatable.3qt b/doc/man/man3/qdatatable.3qt deleted file mode 100644 index 4f301af34..000000000 --- a/doc/man/man3/qdatatable.3qt +++ /dev/null @@ -1,700 +0,0 @@ -'\" t -.TH QDataTable 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 -QDataTable \- Flexible SQL table widget that supports browsing and editing -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QTable. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDataTable\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQDataTable\fR ( QSqlCursor * cursor, bool autoPopulate = FALSE, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QDataTable\fR ()" -.br -.ti -1c -.BI "virtual void \fBaddColumn\fR ( const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )" -.br -.ti -1c -.BI "virtual void \fBremoveColumn\fR ( uint col )" -.br -.ti -1c -.BI "virtual void \fBsetColumn\fR ( uint col, const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )" -.br -.ti -1c -.BI "QString \fBnullText\fR () const" -.br -.ti -1c -.BI "QString \fBtrueText\fR () const" -.br -.ti -1c -.BI "QString \fBfalseText\fR () const" -.br -.ti -1c -.BI "DateFormat \fBdateFormat\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmEdits\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmInsert\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmUpdate\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmDelete\fR () const" -.br -.ti -1c -.BI "bool \fBconfirmCancels\fR () const" -.br -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "bool \fBautoEdit\fR () const" -.br -.ti -1c -.BI "QString \fBfilter\fR () const" -.br -.ti -1c -.BI "QStringList \fBsort\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSqlCursor\fR ( QSqlCursor * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )" -.br -.ti -1c -.BI "QSqlCursor * \fBsqlCursor\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNullText\fR ( const QString & nullText )" -.br -.ti -1c -.BI "virtual void \fBsetTrueText\fR ( const QString & trueText )" -.br -.ti -1c -.BI "virtual void \fBsetFalseText\fR ( const QString & falseText )" -.br -.ti -1c -.BI "virtual void \fBsetDateFormat\fR ( const DateFormat f )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmEdits\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmInsert\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmUpdate\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmDelete\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetConfirmCancels\fR ( bool confirm )" -.br -.ti -1c -.BI "virtual void \fBsetAutoDelete\fR ( bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetAutoEdit\fR ( bool autoEdit )" -.br -.ti -1c -.BI "virtual void \fBsetFilter\fR ( const QString & filter )" -.br -.ti -1c -.BI "virtual void \fBsetSort\fR ( const QStringList & sort )" -.br -.ti -1c -.BI "virtual void \fBsetSort\fR ( const QSqlIndex & sort )" -.br -.ti -1c -.BI "enum \fBRefresh\fR { RefreshData = 1, RefreshColumns = 2, RefreshAll = 3 }" -.br -.ti -1c -.BI "void \fBrefresh\fR ( Refresh mode )" -.br -.ti -1c -.BI "virtual void \fBsortColumn\fR ( int col, bool ascending = TRUE, bool wholeRows = FALSE )" -.br -.ti -1c -.BI "virtual QString \fBtext\fR ( int row, int col ) const" -.br -.ti -1c -.BI "QVariant \fBvalue\fR ( int row, int col ) const" -.br -.ti -1c -.BI "QSqlRecord * \fBcurrentRecord\fR () const" -.br -.ti -1c -.BI "void \fBinstallEditorFactory\fR ( QSqlEditorFactory * f )" -.br -.ti -1c -.BI "void \fBinstallPropertyMap\fR ( QSqlPropertyMap * m )" -.br -.ti -1c -.BI "virtual int \fBnumCols\fR () const" -.br -.ti -1c -.BI "virtual int \fBnumRows\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBfind\fR ( const QString & str, bool caseSensitive, bool backwards )" -.br -.ti -1c -.BI "virtual void \fBsortAscending\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBsortDescending\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBrefresh\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetColumnWidth\fR ( int col, int w )" -.br -.ti -1c -.BI "virtual void \fBadjustColumn\fR ( int col )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBcurrentChanged\fR ( QSqlRecord * record )" -.br -.ti -1c -.BI "void \fBprimeInsert\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBprimeUpdate\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBprimeDelete\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBbeforeInsert\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBbeforeUpdate\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBbeforeDelete\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "void \fBcursorChanged\fR ( QSql::Op mode )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoEdit\fR - whether the data table automatically applies edits" -.br -.ti -1c -.BI "bool \fBconfirmCancels\fR - whether the data table confirms cancel operations" -.br -.ti -1c -.BI "bool \fBconfirmDelete\fR - whether the data table confirms delete operations" -.br -.ti -1c -.BI "bool \fBconfirmEdits\fR - whether the data table confirms edit operations" -.br -.ti -1c -.BI "bool \fBconfirmInsert\fR - whether the data table confirms insert operations" -.br -.ti -1c -.BI "bool \fBconfirmUpdate\fR - whether the data table confirms update operations" -.br -.ti -1c -.BI "DateFormat \fBdateFormat\fR - the format used for displaying date/time values" -.br -.ti -1c -.BI "QString \fBfalseText\fR - the text used to represent false values" -.br -.ti -1c -.BI "QString \fBfilter\fR - the data filter for the data table" -.br -.ti -1c -.BI "QString \fBnullText\fR - the text used to represent NULL values" -.br -.ti -1c -.BI "int \fBnumCols\fR - the number of columns in the table \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBnumRows\fR - the number of rows in the table \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QStringList \fBsort\fR - the data table's sort" -.br -.ti -1c -.BI "QString \fBtrueText\fR - the text used to represent true values" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBinsertCurrent\fR ()" -.br -.ti -1c -.BI "virtual bool \fBupdateCurrent\fR ()" -.br -.ti -1c -.BI "virtual bool \fBdeleteCurrent\fR ()" -.br -.ti -1c -.BI "virtual QSql::Confirm \fBconfirmEdit\fR ( QSql::Op m )" -.br -.ti -1c -.BI "virtual QSql::Confirm \fBconfirmCancel\fR ( QSql::Op m )" -.br -.ti -1c -.BI "virtual void \fBhandleError\fR ( const QSqlError & e )" -.br -.ti -1c -.BI "virtual bool \fBbeginInsert\fR ()" -.br -.ti -1c -.BI "virtual QWidget * \fBbeginUpdate\fR ( int row, int col, bool replace )" -.br -.ti -1c -.BI "int \fBindexOf\fR ( uint i ) const" -.br -.ti -1c -.BI "void \fBreset\fR ()" -.br -.ti -1c -.BI "void \fBsetSize\fR ( QSqlCursor * sql )" -.br -.ti -1c -.BI "virtual void \fBpaintField\fR ( QPainter * p, const QSqlField * field, const QRect & cr, bool selected )" -.br -.ti -1c -.BI "virtual int \fBfieldAlignment\fR ( const QSqlField * field )" -.br -.in -1c -.SH DESCRIPTION -The QDataTable class provides a flexible SQL table widget that supports browsing and editing. -.PP -QDataTable supports various functions for presenting and editing SQL data from a QSqlCursor in a table. -.PP -If you want a to present your data in a form use QDataBrowser, or for read-only forms, QDataView. -.PP -When displaying data, QDataTable only retrieves data for visible rows. If the driver supports the 'query size' property the QDataTable will have the correct number of rows and the vertical scrollbar will accurately reflect the number of rows displayed in proportion to the number of rows in the dataset. If the driver does not support the 'query size' property, rows are dynamically fetched from the database on an as-needed basis with the scrollbar becoming more accurate as the user scrolls down through the records. This allows extremely large queries to be displayed as quickly as possible, with minimum memory usage. -.PP -QDataTable inherits QTable's API and extends it with functions to sort and filter the data and sort columns. See setSqlCursor(), setFilter(), setSort(), setSorting(), sortColumn() and refresh(). -.PP -When displaying editable cursors, cell editing will be enabled. (For more information on editable cursors, see QSqlCursor). QDataTable can be used to modify existing data and to add new records. When a user makes changes to a field in the table, the cursor's edit buffer is used. The table will not send changes in the edit buffer to the database until the user moves to a different record in the grid or presses Enter. Cell editing is initiated by pressing F2 (or right clicking and then clicking the appropriate popup menu item) and canceled by pressing Esc. If there is a problem updating or adding data, errors are handled automatically (see handleError() to change this behavior). Note that if autoEdit() is FALSE navigating to another record will cancel the insert or update. -.PP -The user can be asked to confirm all edits with setConfirmEdits(). For more precise control use setConfirmInsert(), setConfirmUpdate(), setConfirmDelete() and setConfirmCancels(). Use setAutoEdit() to control the behaviour of the table when the user edits a record and then navigates. (Note that setAutoDelete() is unrelated; it is used to set whether the QSqlCursor is deleted when the table is deleted.) -.PP -Since the data table can perform edits, it must be able to uniquely identify every record so that edits are correctly applied. Because of this the underlying cursor must have a valid primary index to ensure that a unique record is inserted, updated or deleted within the database otherwise the database may be changed to an inconsistent state. -.PP -QDataTable creates editors using the default QSqlEditorFactory. Different editor factories can be used by calling installEditorFactory(). A property map is used to map between the cell's value and the editor. You can use your own property map with installPropertyMap(). -.PP -The contents of a cell is available as a QString with text() or as a QVariant with value(). The current record is returned by currentRecord(). Use the find() function to search for a string in the table. -.PP -Editing actions can be applied programatically. For example, the insertCurrent() function reads the fields from the current record into the cursor and performs the insert. The updateCurrent() and deleteCurrent() functions perform similarly to update and delete the current record respectively. -.PP -Columns in the table can be created automatically based on the cursor (see setSqlCursor()). Columns can be manipulated manually using addColumn(), removeColumn() and setColumn(). -.PP -The table automatically copies many of the properties of the cursor to format the display of data within cells (alignment, visibility, etc.). The cursor can be changed with setSqlCursor(). The filter (see setFilter()) and sort defined within the table are used instead of the filter and sort set on the cursor. For sorting options see setSort(), sortColumn(), sortAscending() and sortDescending(). Note that sorting operations will not behave as expected if you are using a QSqlSelectCursor because it uses user-defined SQL queries to obtain data. -.PP -The text used to represent NULL, TRUE and FALSE values can be changed with setNullText(), setTrueText() and setFalseText() respectively. You can change the appearance of cells by reimplementing paintField(). -.PP -Whenever a new row is selected in the table the currentChanged() signal is emitted. The primeInsert() signal is emitted when an insert is initiated. The primeUpdate() and primeDelete() signals are emitted when update and deletion are initiated respectively. Just before the database is updated a signal is emitted; beforeInsert(), beforeUpdate() or beforeDelete() as appropriate. -.PP -See also Database Classes. -.SS "Member Type Documentation" -.SH "QDataTable::Refresh" -This enum describes the refresh options. -.TP -\fCQDataTable::RefreshData\fR - refresh the data, i.e. read it from the database -.TP -\fCQDataTable::RefreshColumns\fR - refresh the list of fields, e.g. the column headings -.TP -\fCQDataTable::RefreshAll\fR - refresh both the data and the list of fields -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDataTable::QDataTable ( QWidget * parent = 0, const char * name = 0 )" -Constructs a data table which is a child of \fIparent\fR, called name \fIname\fR. -.SH "QDataTable::QDataTable ( QSqlCursor * cursor, bool autoPopulate = FALSE, QWidget * parent = 0, const char * name = 0 )" -Constructs a data table which is a child of \fIparent\fR, called name \fIname\fR using the cursor \fIcursor\fR. -.PP -If \fIautoPopulate\fR is TRUE (the default is FALSE), columns are automatically created based upon the fields in the \fIcursor\fR record. Note that \fIautoPopulate\fR only governs the creation of columns; to load the cursor's data into the table use refresh(). -.PP -If the \fIcursor\fR is read-only, the table also becomes read-only. In addition, the table adopts the cursor's driver's definition for representing NULL values as strings. -.SH "QDataTable::~QDataTable ()" -Destroys the object and frees any allocated resources. -.SH "void QDataTable::addColumn ( const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )\fC [virtual]\fR" -Adds the next column to be displayed using the field \fIfieldName\fR, column label \fIlabel\fR, width \fIwidth\fR and iconset \fIiconset\fR. -.PP -If \fIlabel\fR is specified, it is used as the column's header label, otherwise the field's display label is used when setSqlCursor() is called. The \fIiconset\fR is used to set the icon used by the column header; by default there is no icon. -.PP -See also setSqlCursor() and refresh(). -.PP -Examples: -.)l sql/overview/subclass1/main.cpp, sql/overview/subclass3/main.cpp, sql/overview/table2/main.cpp, and sql/sqltable/main.cpp. -.SH "void QDataTable::adjustColumn ( int col )\fC [virtual slot]\fR" -Resizes column \fIcol\fR so that the column width is wide enough to display the widest item the column contains (including the column label). If the table's QSqlCursor is not currently active, the cursor will be refreshed before the column width is calculated. Be aware that this function may be slow on tables that contain large result sets. -.PP -Reimplemented from QTable. -.SH "bool QDataTable::autoDelete () const" -Returns TRUE if the table will automatically delete the cursor specified by setSqlCursor(); otherwise returns FALSE. -.SH "bool QDataTable::autoEdit () const" -Returns TRUE if the data table automatically applies edits; otherwise returns FALSE. See the "autoEdit" property for details. -.SH "void QDataTable::beforeDelete ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted just before the currently selected record is deleted from the database. The \fIbuf\fR parameter points to the edit buffer being deleted. Connect to this signal to, for example, copy some of the fields for later use. -.SH "void QDataTable::beforeInsert ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted just before the cursor's edit buffer is inserted into the database. The \fIbuf\fR parameter points to the edit buffer being inserted. Connect to this signal to, for example, populate a key field with a unique sequence number. -.SH "void QDataTable::beforeUpdate ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted just before the cursor's edit buffer is updated in the database. The \fIbuf\fR parameter points to the edit buffer being updated. Connect to this signal when you want to transform the user's data behind-the-scenes. -.SH "bool QDataTable::beginInsert ()\fC [virtual protected]\fR" -Protected virtual function called when editing is about to begin on a new record. If the table is read-only, or if there's no cursor or the cursor does not allow inserts, nothing happens. -.PP -Editing takes place using the cursor's edit buffer(see QSqlCursor::editBuffer()). -.PP -When editing begins, a new row is created in the table marked with an asterisk '*' in the row's vertical header column, i.e. at the left of the row. -.SH "QWidget * QDataTable::beginUpdate ( int row, int col, bool replace )\fC [virtual protected]\fR" -Protected virtual function called when editing is about to begin on an existing row. If the table is read-only, or if there's no cursor, nothing happens. -.PP -Editing takes place using the cursor's edit buffer (see QSqlCursor::editBuffer()). -.PP -\fIrow\fR and \fIcol\fR refer to the row and column in the QDataTable. -.PP -(\fIreplace\fR is provided for reimplementors and reflects the API of QTable::beginEdit().) -.SH "QSql::Confirm QDataTable::confirmCancel ( QSql::Op m )\fC [virtual protected]\fR" -Protected virtual function which returns a confirmation for cancelling an edit mode of \fIm\fR. Derived classes can reimplement this function to provide their own cancel dialog. The default implementation uses a message box which prompts the user to confirm the cancel. -.SH "bool QDataTable::confirmCancels () const" -Returns TRUE if the data table confirms cancel operations; otherwise returns FALSE. See the "confirmCancels" property for details. -.SH "bool QDataTable::confirmDelete () const" -Returns TRUE if the data table confirms delete operations; otherwise returns FALSE. See the "confirmDelete" property for details. -.SH "QSql::Confirm QDataTable::confirmEdit ( QSql::Op m )\fC [virtual protected]\fR" -Protected virtual function which returns a confirmation for an edit of mode \fIm\fR. Derived classes can reimplement this function to provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action. -.SH "bool QDataTable::confirmEdits () const" -Returns TRUE if the data table confirms edit operations; otherwise returns FALSE. See the "confirmEdits" property for details. -.SH "bool QDataTable::confirmInsert () const" -Returns TRUE if the data table confirms insert operations; otherwise returns FALSE. See the "confirmInsert" property for details. -.SH "bool QDataTable::confirmUpdate () const" -Returns TRUE if the data table confirms update operations; otherwise returns FALSE. See the "confirmUpdate" property for details. -.SH "void QDataTable::currentChanged ( QSqlRecord * record )\fC [signal]\fR" -This signal is emitted whenever a new row is selected in the table. The \fIrecord\fR parameter points to the contents of the newly selected record. -.SH "QSqlRecord * QDataTable::currentRecord () const" -Returns the currently selected record, or 0 if there is no current selection. The table owns the pointer, so do \fInot\fR delete it or otherwise modify it or the cursor it points to. -.SH "void QDataTable::cursorChanged ( QSql::Op mode )\fC [signal]\fR" -This signal is emitted whenever the cursor record was changed due to an edit. The \fImode\fR parameter is the type of edit that just took place. -.SH "DateFormat QDataTable::dateFormat () const" -Returns the format used for displaying date/time values. See the "dateFormat" property for details. -.SH "bool QDataTable::deleteCurrent ()\fC [virtual protected]\fR" -For an editable table, issues a delete on the current cursor's primary index using the values of the currently selected row. If there is no current cursor or there is no current selection, nothing happens. If confirmEdits() or confirmDelete() is TRUE, confirmEdit() is called to confirm the delete. Returns TRUE if the delete succeeded; otherwise FALSE. -.PP -The underlying cursor must have a valid primary index to ensure that a unique record is deleted within the database otherwise the database may be changed to an inconsistent state. -.SH "QString QDataTable::falseText () const" -Returns the text used to represent false values. See the "falseText" property for details. -.SH "int QDataTable::fieldAlignment ( const QSqlField * field )\fC [virtual protected]\fR" -Returns the alignment for \fIfield\fR. -.SH "QString QDataTable::filter () const" -Returns the data filter for the data table. See the "filter" property for details. -.SH "void QDataTable::find ( const QString & str, bool caseSensitive, bool backwards )\fC [virtual slot]\fR" -Searches the current cursor for a cell containing the string \fIstr\fR starting at the current cell and working forwards (or backwards if \fIbackwards\fR is TRUE). If the string is found, the cell containing the string is set as the current cell. If \fIcaseSensitive\fR is FALSE the case of \fIstr\fR will be ignored. -.PP -The search will wrap, i.e. if the first (or if backwards is TRUE, last) cell is reached without finding \fIstr\fR the search will continue until it reaches the starting cell. If \fIstr\fR is not found the search will fail and the current cell will remain unchanged. -.SH "void QDataTable::handleError ( const QSqlError & e )\fC [virtual protected]\fR" -Protected virtual function which is called when an error \fIe\fR has occurred on the current cursor(). The default implementation displays a warning message to the user with information about the error. -.SH "int QDataTable::indexOf ( uint i ) const\fC [protected]\fR" -Returns the index of the field within the current SQL query that is displayed in column \fIi\fR. -.SH "bool QDataTable::insertCurrent ()\fC [virtual protected]\fR" -For an editable table, issues an insert on the current cursor using the values in the cursor's edit buffer. If there is no current cursor or there is no current "insert" row, nothing happens. If confirmEdits() or confirmInsert() is TRUE, confirmEdit() is called to confirm the insert. Returns TRUE if the insert succeeded; otherwise returns FALSE. -.PP -The underlying cursor must have a valid primary index to ensure that a unique record is inserted within the database otherwise the database may be changed to an inconsistent state. -.SH "void QDataTable::installEditorFactory ( QSqlEditorFactory * f )" -Installs a new SQL editor factory \fIf\fR. This enables the user to create and instantiate their own editors for use in cell editing. Note that QDataTable takes ownership of this pointer, and will delete it when it is no longer needed or when installEditorFactory() is called again. -.PP -See also QSqlEditorFactory. -.SH "void QDataTable::installPropertyMap ( QSqlPropertyMap * m )" -Installs a new property map \fIm\fR. This enables the user to create and instantiate their own property maps for use in cell editing. Note that QDataTable takes ownership of this pointer, and will delete it when it is no longer needed or when installPropertMap() is called again. -.PP -See also QSqlPropertyMap. -.SH "QString QDataTable::nullText () const" -Returns the text used to represent NULL values. See the "nullText" property for details. -.SH "int QDataTable::numCols () const\fC [virtual]\fR" -Returns the number of columns in the table. See the "numCols" property for details. -.PP -Reimplemented from QTable. -.SH "int QDataTable::numRows () const\fC [virtual]\fR" -Returns the number of rows in the table. See the "numRows" property for details. -.PP -Reimplemented from QTable. -.SH "void QDataTable::paintField ( QPainter * p, const QSqlField * field, const QRect & cr, bool selected )\fC [virtual protected]\fR" -Paints the \fIfield\fR on the painter \fIp\fR. The painter has already been translated to the appropriate cell's origin where the \fIfield\fR is to be rendered. \fIcr\fR describes the cell coordinates in the content coordinate system. The \fIselected\fR parameter is ignored. -.PP -If you want to draw custom field content you must reimplement paintField() to do the custom drawing. The default implementation renders the \fIfield\fR value as text. If the field is NULL, nullText() is displayed in the cell. If the field is Boolean, trueText() or falseText() is displayed as appropriate. -.PP -Example: sql/overview/table4/main.cpp. -.SH "void QDataTable::primeDelete ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted after the cursor is primed for delete by the table, when a delete action is beginning on the table. The \fIbuf\fR parameter points to the edit buffer being deleted. Connect to this signal in order to, for example, record auditing information on deletions. -.SH "void QDataTable::primeInsert ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted after the cursor is primed for insert by the table, when an insert action is beginning on the table. The \fIbuf\fR parameter points to the edit buffer being inserted. Connect to this signal in order to, for example, prime the record buffer with default data values. -.SH "void QDataTable::primeUpdate ( QSqlRecord * buf )\fC [signal]\fR" -This signal is emitted after the cursor is primed for update by the table, when an update action is beginning on the table. The \fIbuf\fR parameter points to the edit buffer being updated. Connect to this signal in order to, for example, provide some visual feedback that the user is in 'edit mode'. -.SH "void QDataTable::refresh ()\fC [virtual slot]\fR" -Refreshes the table. The cursor is refreshed using the current filter, the current sort, and the currently defined columns. Equivalent to calling refresh( QDataTable::RefreshData ). -.PP -Examples: -.)l sql/overview/subclass1/main.cpp, sql/overview/table1/main.cpp, sql/overview/table2/main.cpp, and sql/sqltable/main.cpp. -.SH "void QDataTable::refresh ( Refresh mode )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Refreshes the table. If there is no currently defined cursor (see setSqlCursor()), nothing happens. The \fImode\fR parameter determines which type of refresh will take place. -.PP -See also Refresh, setSqlCursor(), and addColumn(). -.SH "void QDataTable::removeColumn ( uint col )\fC [virtual]\fR" -Removes column \fIcol\fR from the list of columns to be displayed. If \fIcol\fR does not exist, nothing happens. -.PP -See also QSqlField. -.SH "void QDataTable::reset ()\fC [protected]\fR" -Resets the table so that it displays no data. -.PP -See also setSqlCursor(). -.SH "void QDataTable::setAutoDelete ( bool enable )\fC [virtual]\fR" -Sets the cursor auto-delete flag to \fIenable\fR. If \fIenable\fR is TRUE, the table will automatically delete the cursor specified by setSqlCursor(). If \fIenable\fR is FALSE (the default), the cursor will not be deleted. -.SH "void QDataTable::setAutoEdit ( bool autoEdit )\fC [virtual]\fR" -Sets whether the data table automatically applies edits to \fIautoEdit\fR. See the "autoEdit" property for details. -.SH "void QDataTable::setColumn ( uint col, const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )\fC [virtual]\fR" -Sets the \fIcol\fR column to display using the field \fIfieldName\fR, column label \fIlabel\fR, width \fIwidth\fR and iconset \fIiconset\fR. -.PP -If \fIlabel\fR is specified, it is used as the column's header label, otherwise the field's display label is used when setSqlCursor() is called. The \fIiconset\fR is used to set the icon used by the column header; by default there is no icon. -.PP -See also setSqlCursor() and refresh(). -.SH "void QDataTable::setColumnWidth ( int col, int w )\fC [virtual slot]\fR" -Sets the column \fIcol\fR to the width \fIw\fR. Note that unlike QTable the QDataTable is not immediately redrawn, you must call refresh(QDataTable::RefreshColumns) yourself. -.PP -See also refresh(). -.PP -Reimplemented from QTable. -.SH "void QDataTable::setConfirmCancels ( bool confirm )\fC [virtual]\fR" -Sets whether the data table confirms cancel operations to \fIconfirm\fR. See the "confirmCancels" property for details. -.SH "void QDataTable::setConfirmDelete ( bool confirm )\fC [virtual]\fR" -Sets whether the data table confirms delete operations to \fIconfirm\fR. See the "confirmDelete" property for details. -.SH "void QDataTable::setConfirmEdits ( bool confirm )\fC [virtual]\fR" -Sets whether the data table confirms edit operations to \fIconfirm\fR. See the "confirmEdits" property for details. -.SH "void QDataTable::setConfirmInsert ( bool confirm )\fC [virtual]\fR" -Sets whether the data table confirms insert operations to \fIconfirm\fR. See the "confirmInsert" property for details. -.SH "void QDataTable::setConfirmUpdate ( bool confirm )\fC [virtual]\fR" -Sets whether the data table confirms update operations to \fIconfirm\fR. See the "confirmUpdate" property for details. -.SH "void QDataTable::setDateFormat ( const DateFormat f )\fC [virtual]\fR" -Sets the format used for displaying date/time values to \fIf\fR. See the "dateFormat" property for details. -.SH "void QDataTable::setFalseText ( const QString & falseText )\fC [virtual]\fR" -Sets the text used to represent false values to \fIfalseText\fR. See the "falseText" property for details. -.SH "void QDataTable::setFilter ( const QString & filter )\fC [virtual]\fR" -Sets the data filter for the data table to \fIfilter\fR. See the "filter" property for details. -.SH "void QDataTable::setNullText ( const QString & nullText )\fC [virtual]\fR" -Sets the text used to represent NULL values to \fInullText\fR. See the "nullText" property for details. -.SH "void QDataTable::setSize ( QSqlCursor * sql )\fC [protected]\fR" -If the cursor's \fIsql\fR driver supports query sizes, the number of rows in the table is set to the size of the query. Otherwise, the table dynamically resizes itself as it is scrolled. If \fIsql\fR is not active, it is made active by issuing a select() on the cursor using the \fIsql\fR cursor's current filter and current sort. -.SH "void QDataTable::setSort ( const QStringList & sort )\fC [virtual]\fR" -Sets the data table's sort to \fIsort\fR. See the "sort" property for details. -.SH "void QDataTable::setSort ( const QSqlIndex & sort )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the sort to be applied to the displayed data to \fIsort\fR. If there is no current cursor, nothing happens. A QSqlIndex contains field names and their ordering (ASC or DESC); these are used to compose the ORDER BY clause. -.PP -See also sort. -.SH "void QDataTable::setSqlCursor ( QSqlCursor * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )\fC [virtual]\fR" -Sets \fIcursor\fR as the data source for the table. To force the display of the data from \fIcursor\fR, use refresh(). If \fIautoPopulate\fR is TRUE, columns are automatically created based upon the fields in the \fIcursor\fR record. If \fIautoDelete\fR is TRUE (the default is FALSE), the table will take ownership of the \fIcursor\fR and delete it when appropriate. If the \fIcursor\fR is read-only, the table becomes read-only. The table adopts the cursor's driver's definition for representing NULL values as strings. -.PP -See also refresh(), readOnly, setAutoDelete(), and QSqlDriver::nullText(). -.SH "void QDataTable::setTrueText ( const QString & trueText )\fC [virtual]\fR" -Sets the text used to represent true values to \fItrueText\fR. See the "trueText" property for details. -.SH "QStringList QDataTable::sort () const" -Returns the data table's sort. See the "sort" property for details. -.SH "void QDataTable::sortAscending ( int col )\fC [virtual slot]\fR" -Sorts column \fIcol\fR in ascending order. -.PP -See also sorting. -.SH "void QDataTable::sortColumn ( int col, bool ascending = TRUE, bool wholeRows = FALSE )\fC [virtual]\fR" -Sorts column \fIcol\fR in ascending order if \fIascending\fR is TRUE (the default); otherwise sorts in descending order. -.PP -The \fIwholeRows\fR parameter is ignored; QDataTable always sorts whole rows by the specified column. -.PP -Reimplemented from QTable. -.SH "void QDataTable::sortDescending ( int col )\fC [virtual slot]\fR" -Sorts column \fIcol\fR in descending order. -.PP -See also sorting. -.SH "QSqlCursor * QDataTable::sqlCursor () const" -Returns the cursor used by the data table. -.SH "QString QDataTable::text ( int row, int col ) const\fC [virtual]\fR" -Returns the text in cell \fIrow\fR, \fIcol\fR, or an empty string if the cell is empty. If the cell's value is NULL then nullText() will be returned. If the cell does not exist then QString::null is returned. -.PP -Reimplemented from QTable. -.SH "QString QDataTable::trueText () const" -Returns the text used to represent true values. See the "trueText" property for details. -.SH "bool QDataTable::updateCurrent ()\fC [virtual protected]\fR" -For an editable table, issues an update using the cursor's edit buffer. If there is no current cursor or there is no current selection, nothing happens. If confirmEdits() or confirmUpdate() is TRUE, confirmEdit() is called to confirm the update. Returns TRUE if the update succeeded; otherwise returns FALSE. -.PP -The underlying cursor must have a valid primary index to ensure that a unique record is updated within the database otherwise the database may be changed to an inconsistent state. -.SH "QVariant QDataTable::value ( int row, int col ) const" -Returns the value in cell \fIrow\fR, \fIcol\fR, or an invalid value if the cell does not exist or has no value. -.SS "Property Documentation" -.SH "bool autoEdit" -This property holds whether the data table automatically applies edits. -.PP -The default value for this property is TRUE. When the user begins an insert or update in the table there are two possible outcomes when they navigate to another record: -.PP -
                -.TP -the insert or update is is performed -- this occurs if autoEdit is TRUE -.TP -the insert or update is abandoned -- this occurs if autoEdit is FALSE -.PP -Set this property's value with setAutoEdit() and get this property's value with autoEdit(). -.SH "bool confirmCancels" -This property holds whether the data table confirms cancel operations. -.PP -If the confirmCancel property is TRUE, all cancels must be confirmed by the user through a message box (this behavior can be changed by overriding the confirmCancel() function), otherwise all cancels occur immediately. The default is FALSE. -.PP -See also confirmEdits and confirmCancel(). -.PP -Set this property's value with setConfirmCancels() and get this property's value with confirmCancels(). -.SH "bool confirmDelete" -This property holds whether the data table confirms delete operations. -.PP -If the confirmDelete property is TRUE, all deletions must be confirmed by the user through a message box (this behaviour can be changed by overriding the confirmEdit() function), otherwise all delete operations occur immediately. -.PP -See also confirmCancels, confirmEdits, confirmUpdate, and confirmInsert. -.PP -Set this property's value with setConfirmDelete() and get this property's value with confirmDelete(). -.SH "bool confirmEdits" -This property holds whether the data table confirms edit operations. -.PP -If the confirmEdits property is TRUE, the data table confirms all edit operations (inserts, updates and deletes). Finer control of edit confirmation can be achieved using confirmCancels, confirmInsert, confirmUpdate and confirmDelete. -.PP -See also confirmCancels, confirmInsert, confirmUpdate, and confirmDelete. -.PP -Set this property's value with setConfirmEdits() and get this property's value with confirmEdits(). -.SH "bool confirmInsert" -This property holds whether the data table confirms insert operations. -.PP -If the confirmInsert property is TRUE, all insertions must be confirmed by the user through a message box (this behaviour can be changed by overriding the confirmEdit() function), otherwise all insert operations occur immediately. -.PP -See also confirmCancels, confirmEdits, confirmUpdate, and confirmDelete. -.PP -Set this property's value with setConfirmInsert() and get this property's value with confirmInsert(). -.SH "bool confirmUpdate" -This property holds whether the data table confirms update operations. -.PP -If the confirmUpdate property is TRUE, all updates must be confirmed by the user through a message box (this behaviour can be changed by overriding the confirmEdit() function), otherwise all update operations occur immediately. -.PP -See also confirmCancels, confirmEdits, confirmInsert, and confirmDelete. -.PP -Set this property's value with setConfirmUpdate() and get this property's value with confirmUpdate(). -.SH "DateFormat dateFormat" -This property holds the format used for displaying date/time values. -.PP -The dateFormat property is used for displaying date/time values in the table. The default value is Qt::LocalDate. -.PP -Set this property's value with setDateFormat() and get this property's value with dateFormat(). -.SH "QString falseText" -This property holds the text used to represent false values. -.PP -The falseText property will be used to represent NULL values in the table. The default value is "False". -.PP -Set this property's value with setFalseText() and get this property's value with falseText(). -.SH "QString filter" -This property holds the data filter for the data table. -.PP -The filter applies to the data shown in the table. To view data with a new filter, use refresh(). A filter string is an SQL WHERE clause without the WHERE keyword. -.PP -There is no default filter. -.PP -See also sort. -.PP -Set this property's value with setFilter() and get this property's value with filter(). -.SH "QString nullText" -This property holds the text used to represent NULL values. -.PP -The nullText property will be used to represent NULL values in the table. The default value is provided by the cursor's driver. -.PP -Set this property's value with setNullText() and get this property's value with nullText(). -.SH "int numCols" -This property holds the number of columns in the table. -.PP -Get this property's value with numCols(). -.SH "int numRows" -This property holds the number of rows in the table. -.PP -Get this property's value with numRows(). -.SH "QStringList sort" -This property holds the data table's sort. -.PP -The table's sort affects the order in which data records are displayed in the table. To apply a sort, use refresh(). -.PP -When examining the sort property, a string list is returned with each item having the form 'fieldname order' (e.g., 'id ASC', 'surname DESC'). -.PP -There is no default sort. -.PP -Note that if you want to iterate over the sort list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myDataTable.sort(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also filter and refresh(). -.PP -Set this property's value with setSort() and get this property's value with sort(). -.SH "QString trueText" -This property holds the text used to represent true values. -.PP -The trueText property will be used to represent NULL values in the table. The default value is "True". -.PP -Set this property's value with setTrueText() and get this property's value with trueText(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdatatable.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdatatable.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdataview.3qt b/doc/man/man3/qdataview.3qt deleted file mode 100644 index bcd222f30..000000000 --- a/doc/man/man3/qdataview.3qt +++ /dev/null @@ -1,129 +0,0 @@ -'\" t -.TH QDataView 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 -QDataView \- Read-only SQL forms -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDataView\fR ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" -.br -.ti -1c -.BI "\fB~QDataView\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetForm\fR ( QSqlForm * form )" -.br -.ti -1c -.BI "QSqlForm * \fBform\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetRecord\fR ( QSqlRecord * record )" -.br -.ti -1c -.BI "QSqlRecord * \fBrecord\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBrefresh\fR ( QSqlRecord * buf )" -.br -.ti -1c -.BI "virtual void \fBreadFields\fR ()" -.br -.ti -1c -.BI "virtual void \fBwriteFields\fR ()" -.br -.ti -1c -.BI "virtual void \fBclearValues\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QDataView class provides read-only SQL forms. -.PP -This class provides a form which displays SQL field data from a record buffer. Because QDataView does not support editing it uses less resources than a QDataBrowser. This class is well suited for displaying read-only data from a SQL database. -.PP -If you want a to present your data in an editable form use QDataBrowser; if you want a table-based presentation of your data use QDataTable. -.PP -The form is associated with the data view with setForm() and the record is associated with setRecord(). You can also pass a QSqlRecord to the refresh() function which will set the record to the given record and read the record's fields into the form. -.PP -See also Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDataView::QDataView ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" -Constructs a data view which is a child of \fIparent\fR, called \fIname\fR, and with widget flags \fIfl\fR. -.SH "QDataView::~QDataView ()" -Destroys the object and frees any allocated resources. -.SH "void QDataView::clearValues ()\fC [virtual slot]\fR" -Clears the default form's values. If there is no default form, nothing happens. All the values are set to their 'zero state', e.g. 0 for numeric fields, "" for string fields. -.SH "QSqlForm * QDataView::form ()" -Returns the default form used by the data view, or 0 if there is none. -.PP -See also setForm(). -.SH "void QDataView::readFields ()\fC [virtual slot]\fR" -Causes the default form to read its fields from the record buffer. If there is no default form, or no record, nothing happens. -.PP -See also setForm(). -.SH "QSqlRecord * QDataView::record ()" -Returns the default record used by the data view, or 0 if there is none. -.PP -See also setRecord(). -.SH "void QDataView::refresh ( QSqlRecord * buf )\fC [virtual slot]\fR" -Causes the default form to display the contents of \fIbuf\fR. If there is no default form, nothing happens.The \fIbuf\fR also becomes the default record for all subsequent calls to readFields() and writefields(). This slot is equivalant to calling: -.PP -.nf -.br - myView.setRecord( record ); -.br - myView.readFields(); -.br -.fi -.PP -See also setRecord() and readFields(). -.SH "void QDataView::setForm ( QSqlForm * form )\fC [virtual]\fR" -Sets the form used by the data view to \fIform\fR. If a record has already been assigned to the data view, the form will display that record's data. -.PP -See also form(). -.SH "void QDataView::setRecord ( QSqlRecord * record )\fC [virtual]\fR" -Sets the record used by the data view to \fIrecord\fR. If a form has already been assigned to the data view, the form will display the data from \fIrecord\fR in that form. -.PP -See also record(). -.SH "void QDataView::writeFields ()\fC [virtual slot]\fR" -Causes the default form to write its fields to the record buffer. If there is no default form, or no record, nothing happens. -.PP -See also setForm(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdataview.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdataview.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdate.3qt b/doc/man/man3/qdate.3qt deleted file mode 100644 index a76200068..000000000 --- a/doc/man/man3/qdate.3qt +++ /dev/null @@ -1,429 +0,0 @@ -'\" t -.TH QDate 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 -QDate \- Date functions -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDate\fR ()" -.br -.ti -1c -.BI "\fBQDate\fR ( int y, int m, int d )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "int \fByear\fR () const" -.br -.ti -1c -.BI "int \fBmonth\fR () const" -.br -.ti -1c -.BI "int \fBday\fR () const" -.br -.ti -1c -.BI "int \fBdayOfWeek\fR () const" -.br -.ti -1c -.BI "int \fBdayOfYear\fR () const" -.br -.ti -1c -.BI "int \fBdaysInMonth\fR () const" -.br -.ti -1c -.BI "int \fBdaysInYear\fR () const" -.br -.ti -1c -.BI "int \fBweekNumber\fR ( int * yearNumber = 0 ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( Qt::DateFormat f = Qt::TextDate ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( const QString & format ) const" -.br -.ti -1c -.BI "bool \fBsetYMD\fR ( int y, int m, int d )" -.br -.ti -1c -.BI "QDate \fBaddDays\fR ( int ndays ) const" -.br -.ti -1c -.BI "QDate \fBaddMonths\fR ( int nmonths ) const" -.br -.ti -1c -.BI "QDate \fBaddYears\fR ( int nyears ) const" -.br -.ti -1c -.BI "int \fBdaysTo\fR ( const QDate & d ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QDate & d ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QDate & d ) const" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const QDate & d ) const" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const QDate & d ) const" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const QDate & d ) const" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const QDate & d ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString monthName ( int month ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString dayName ( int weekday ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString \fBshortMonthName\fR ( int month )" -.br -.ti -1c -.BI "QString \fBshortDayName\fR ( int weekday )" -.br -.ti -1c -.BI "QString \fBlongMonthName\fR ( int month )" -.br -.ti -1c -.BI "QString \fBlongDayName\fR ( int weekday )" -.br -.ti -1c -.BI "QDate \fBcurrentDate\fR ()" -.br -.ti -1c -.BI "QDate \fBcurrentDate\fR ( Qt::TimeSpec ts )" -.br -.ti -1c -.BI "QDate \fBfromString\fR ( const QString & s, Qt::DateFormat f = Qt::TextDate )" -.br -.ti -1c -.BI "bool \fBisValid\fR ( int y, int m, int d )" -.br -.ti -1c -.BI "bool \fBleapYear\fR ( int y )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QDate & d )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QDate & d )" -.br -.in -1c -.SH DESCRIPTION -The QDate class provides date functions. -.PP -A QDate object contains a calendar date, i.e. year, month, and day numbers, in the modern Western (Gregorian) calendar. It can read the current date from the system clock. It provides functions for comparing dates and for manipulating dates, e.g. by adding a number of days or months or years. -.PP -A QDate object is typically created either by giving the year, month and day numbers explicitly, or by using the static function currentDate(), which creates a QDate object containing the system clock's date. An explicit date can also be set using setYMD(). The fromString() function returns a QDate given a string and a date format which is used to interpret the date within the string. -.PP -The year(), month(), and day() functions provide access to the year, month, and day numbers. Also, dayOfWeek() and dayOfYear() functions are provided. The same information is provided in textual format by the toString(), shortDayName(), longDayName(), shortMonthName() and longMonthName() functions. -.PP -QDate provides a full set of operators to compare two QDate objects where smaller means earlier and larger means later. -.PP -You can increment (or decrement) a date by a given number of days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two dates. -.PP -The daysInMonth() and daysInYear() functions return how many days there are in this date's month and year, respectively. The leapYear() function indicates whether this date is in a leap year. -.PP -Note that QDate should not be used for date calculations for dates prior to the introduction of the Gregorian calendar. This calendar was adopted by England from the 14th September 1752 (hence this is the earliest valid QDate), and subsequently by most other Western countries, until 1923. -.PP -The end of time is reached around the year 8000, by which time we expect Qt to be obsolete. -.PP -See also QTime, QDateTime, QDateEdit, QDateTimeEdit, and Time and Date. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDate::QDate ()" -Constructs a null date. Null dates are invalid. -.PP -See also isNull() and isValid(). -.SH "QDate::QDate ( int y, int m, int d )" -Constructs a date with year \fIy\fR, month \fIm\fR and day \fId\fR. -.PP -\fIy\fR must be in the range 1752..8000, \fIm\fR must be in the range 1..12, and \fId\fR must be in the range 1..31. -.PP -\fBWarning:\fR If \fIy\fR is in the range 0..99, it is interpreted as 1900..1999. -.PP -See also isValid(). -.SH "QDate QDate::addDays ( int ndays ) const" -Returns a QDate object containing a date \fIndays\fR later than the date of this object (or earlier if \fIndays\fR is negative). -.PP -See also addMonths(), addYears(), and daysTo(). -.SH "QDate QDate::addMonths ( int nmonths ) const" -Returns a QDate object containing a date \fInmonths\fR later than the date of this object (or earlier if \fInmonths\fR is negative). -.PP -See also addDays() and addYears(). -.SH "QDate QDate::addYears ( int nyears ) const" -Returns a QDate object containing a date \fInyears\fR later than the date of this object (or earlier if \fInyears\fR is negative). -.PP -See also addDays() and addMonths(). -.SH "QDate QDate::currentDate ( Qt::TimeSpec ts )\fC [static]\fR" -Returns the current date, as reported by the system clock, for the TimeSpec \fIts\fR. The default TimeSpec is LocalTime. -.PP -See also QTime::currentTime(), QDateTime::currentDateTime(), and Qt::TimeSpec. -.PP -Example: dclock/dclock.cpp. -.SH "QDate QDate::currentDate ()\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the current date, as reported by the system clock. -.PP -See also QTime::currentTime() and QDateTime::currentDateTime(). -.SH "int QDate::day () const" -Returns the day of the month (1..31) of this date. -.PP -See also year(), month(), and dayOfWeek(). -.PP -Example: dclock/dclock.cpp. -.SH "QString QDate::dayName ( int weekday )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use shortDayName() instead. -.SH "int QDate::dayOfWeek () const" -Returns the weekday (Monday=1..Sunday=7) for this date. -.PP -See also day() and dayOfYear(). -.SH "int QDate::dayOfYear () const" -Returns the day of the year (1..365) for this date. -.PP -See also day() and dayOfWeek(). -.SH "int QDate::daysInMonth () const" -Returns the number of days in the month (28..31) for this date. -.PP -See also day() and daysInYear(). -.SH "int QDate::daysInYear () const" -Returns the number of days in the year (365 or 366) for this date. -.PP -See also day() and daysInMonth(). -.SH "int QDate::daysTo ( const QDate & d ) const" -Returns the number of days from this date to \fId\fR (which is negative if \fId\fR is earlier than this date). -.PP -Example: -.PP -.nf -.br - QDate d1( 1995, 5, 17 ); // May 17th 1995 -.br - QDate d2( 1995, 5, 20 ); // May 20th 1995 -.br - d1.daysTo( d2 ); // returns 3 -.br - d2.daysTo( d1 ); // returns -3 -.br -.fi -.PP -See also addDays(). -.SH "QDate QDate::fromString ( const QString & s, Qt::DateFormat f = Qt::TextDate )\fC [static]\fR" -Returns the QDate represented by the string \fIs\fR, using the format \fIf\fR, or an invalid date if the string cannot be parsed. -.PP -Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used, they depend on the user's locale settings. -.PP -\fBWarning:\fR Qt::LocalDate cannot be used here. -.SH "bool QDate::isNull () const" -Returns TRUE if the date is null; otherwise returns FALSE. A null date is invalid. -.PP -See also isValid(). -.SH "bool QDate::isValid () const" -Returns TRUE if this date is valid; otherwise returns FALSE. -.PP -See also isNull(). -.SH "bool QDate::isValid ( int y, int m, int d )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the specified date (year \fIy\fR, month \fIm\fR and day \fId\fR) is valid; otherwise returns FALSE. -.PP -Example: -.PP -.nf -.br - QDate::isValid( 2002, 5, 17 ); // TRUE May 17th 2002 is valid -.br - QDate::isValid( 2002, 2, 30 ); // FALSE Feb 30th does not exist -.br - QDate::isValid( 2004, 2, 29 ); // TRUE 2004 is a leap year -.br - QDate::isValid( 1202, 6, 6 ); // FALSE 1202 is pre-Gregorian -.br -.fi -.PP -\fBWarning:\fR A \fIy\fR value in the range 00..99 is interpreted as 1900..1999. -.PP -See also isNull() and setYMD(). -.SH "bool QDate::leapYear ( int y )\fC [static]\fR" -Returns TRUE if the specified year \fIy\fR is a leap year; otherwise returns FALSE. -.SH "QString QDate::longDayName ( int weekday )\fC [static]\fR" -Returns the long name of the \fIweekday\fR. -.PP -1 = "Monday", 2 = "Tuesday", ... 7 = "Sunday" -.PP -The day names will be localized according to the system's locale settings. -.PP -See also toString(), shortDayName(), shortMonthName(), and longMonthName(). -.SH "QString QDate::longMonthName ( int month )\fC [static]\fR" -Returns the long name of the \fImonth\fR. -.PP -1 = "January", 2 = "February", ... 12 = "December" -.PP -The month names will be localized according to the system's locale settings. -.PP -See also toString(), shortMonthName(), shortDayName(), and longDayName(). -.SH "int QDate::month () const" -Returns the month (January=1..December=12) of this date. -.PP -See also year() and day(). -.PP -Example: dclock/dclock.cpp. -.SH "QString QDate::monthName ( int month )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use shortMonthName() instead. -.SH "bool QDate::operator!= ( const QDate & d ) const" -Returns TRUE if this date is different from \fId\fR; otherwise returns FALSE. -.SH "bool QDate::operator< ( const QDate & d ) const" -Returns TRUE if this date is earlier than \fId\fR, otherwise returns FALSE. -.SH "bool QDate::operator<= ( const QDate & d ) const" -Returns TRUE if this date is earlier than or equal to \fId\fR, otherwise returns FALSE. -.SH "bool QDate::operator== ( const QDate & d ) const" -Returns TRUE if this date is equal to \fId\fR; otherwise returns FALSE. -.SH "bool QDate::operator> ( const QDate & d ) const" -Returns TRUE if this date is later than \fId\fR, otherwise returns FALSE. -.SH "bool QDate::operator>= ( const QDate & d ) const" -Returns TRUE if this date is later than or equal to \fId\fR, otherwise returns FALSE. -.SH "bool QDate::setYMD ( int y, int m, int d )" -Sets the date's year \fIy\fR, month \fIm\fR and day \fId\fR. -.PP -\fIy\fR must be in the range 1752..8000, \fIm\fR must be in the range 1..12, and \fId\fR must be in the range 1..31. -.PP -\fBWarning:\fR If \fIy\fR is in the range 0..99, it is interpreted as 1900..1999. -.PP -Returns TRUE if the date is valid; otherwise returns FALSE. -.SH "QString QDate::shortDayName ( int weekday )\fC [static]\fR" -Returns the name of the \fIweekday\fR. -.PP -1 = "Mon", 2 = "Tue", ... 7 = "Sun" -.PP -The day names will be localized according to the system's locale settings. -.PP -See also toString(), shortMonthName(), longMonthName(), and longDayName(). -.SH "QString QDate::shortMonthName ( int month )\fC [static]\fR" -Returns the name of the \fImonth\fR. -.PP -1 = "Jan", 2 = "Feb", ... 12 = "Dec" -.PP -The month names will be localized according to the system's locale settings. -.PP -See also toString(), longMonthName(), shortDayName(), and longDayName(). -.SH "QString QDate::toString ( const QString & format ) const" -Returns the date as a string. The \fIformat\fR parameter determines the format of the result string. -.PP -These expressions may be used: -.PP -
                .nf -.TS -l - l. Expression Output d the day as number without a leading zero (1-31) dd the day as number with a leading zero (01-31) ddd the abbreviated localized day name (e.g. 'Mon'..'Sun'). Uses QDate::shortDayName(). dddd the long localized day name (e.g. 'Monday'..'Sunday'). Uses QDate::longDayName(). M the month as number without a leading zero (1-12) MM the month as number with a leading zero (01-12) MMM the abbreviated localized month name (e.g. 'Jan'..'Dec'). Uses QDate::shortMonthName(). MMMM the long localized month name (e.g. 'January'..'December'). Uses QDate::longMonthName(). yy the year as two digit number (00-99) yyyy -.TE -.fi -
                -.PP -All other input characters will be ignored. -.PP -Example format strings (assuming that the QDate is the 20th July 1969):
                .nf -.TS -l - l. Format Result dd.MM.yyyy 20.07.1969 ddd MMMM d yy -.TE -.fi -
                -.PP -If the date is an invalid date, then QString::null will be returned. -.PP -See also QDateTime::toString() and QTime::toString(). -.SH "QString QDate::toString ( Qt::DateFormat f = Qt::TextDate ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the date as a string. The \fIf\fR parameter determines the format of the string. -.PP -If \fIf\fR is Qt::TextDate, the string format is "Sat May 20 1995" (using the shortDayName() and shortMonthName() functions to generate the string, so the day and month names are locale specific). -.PP -If \fIf\fR is Qt::ISODate, the string format corresponds to the ISO 8601 specification for representations of dates, which is YYYY-MM-DD where YYYY is the year, MM is the month of the year (between 01 and 12), and DD is the day of the month between 01 and 31. -.PP -If \fIf\fR is Qt::LocalDate, the string format depends on the locale settings of the system. -.PP -If the date is an invalid date, then QString::null will be returned. -.PP -See also shortDayName() and shortMonthName(). -.SH "int QDate::weekNumber ( int * yearNumber = 0 ) const" -Returns the week number (1 to 53), and stores the year in \fI*yearNumber\fR unless \fIyearNumber\fR is null (the default). -.PP -Returns 0 if the date is invalid. -.PP -In accordance with ISO 8601, weeks start on Monday and the first Thursday of a year is always in week 1 of that year. Most years have 52 weeks, but some have 53. -.PP -\fI*yearNumber\fR is not always the same as year(). For example, 1 January 2000 has week number 52 in the year 1999, and 31 December 2002 has week number 1 in the year 2003. -.PP -Copyright (c) 1989 The Regents of the University of California. All rights reserved. -.PP -Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. -.PP -See also isValid(). -.SH "int QDate::year () const" -Returns the year (1752..8000) of this date. -.PP -See also month() and day(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QDate & d )" -Writes the date, \fId\fR, to the data stream, \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QDate & d )" -Reads a date from the stream \fIs\fR into \fId\fR. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdate.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdate.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdateedit.3qt b/doc/man/man3/qdateedit.3qt deleted file mode 100644 index a83f15ae1..000000000 --- a/doc/man/man3/qdateedit.3qt +++ /dev/null @@ -1,292 +0,0 @@ -'\" t -.TH QDateEdit 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 -QDateEdit \- Date editor -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDateTimeEditBase. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDateEdit\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQDateEdit\fR ( const QDate & date, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QDateEdit\fR ()" -.br -.ti -1c -.BI "enum \fBOrder\fR { DMY, MDY, YMD, YDM }" -.br -.ti -1c -.BI "QDate \fBdate\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetOrder\fR ( Order order )" -.br -.ti -1c -.BI "Order \fBorder\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoAdvance\fR ( bool advance )" -.br -.ti -1c -.BI "bool \fBautoAdvance\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMinValue\fR ( const QDate & d )" -.br -.ti -1c -.BI "QDate \fBminValue\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMaxValue\fR ( const QDate & d )" -.br -.ti -1c -.BI "QDate \fBmaxValue\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRange\fR ( const QDate & min, const QDate & max )" -.br -.ti -1c -.BI "QString \fBseparator\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSeparator\fR ( const QString & s )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetDate\fR ( const QDate & date )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBvalueChanged\fR ( const QDate & date )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoAdvance\fR - whether the editor automatically advances to the next section" -.br -.ti -1c -.BI "QDate \fBdate\fR - the editor's date value" -.br -.ti -1c -.BI "QDate \fBmaxValue\fR - the editor's maximum value" -.br -.ti -1c -.BI "QDate \fBminValue\fR - the editor's minimum value" -.br -.ti -1c -.BI "Order \fBorder\fR - the order in which the " "year" ", month and day appear" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QString \fBsectionFormattedText\fR ( int sec )" -.br -.ti -1c -.BI "virtual void \fBsetYear\fR ( int year )" -.br -.ti -1c -.BI "virtual void \fBsetMonth\fR ( int month )" -.br -.ti -1c -.BI "virtual void \fBsetDay\fR ( int day )" -.br -.ti -1c -.BI "virtual void \fBfix\fR ()" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "void \fBupdateButtons\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QDateEdit class provides a date editor. -.PP -QDateEdit allows the user to edit dates by using the keyboard or the arrow keys to increase/decrease date values. The arrow keys can be used to move from section to section within the QDateEdit box. Dates appear in accordance with the local date/time settings or in year, month, day order if the system doesn't provide this information. It is recommended that the QDateEdit be initialised with a date, e.g. -.PP -.nf -.br - QDateEdit *dateEdit = new QDateEdit( QDate::currentDate(), this ); -.br - dateEdit->setRange( QDate::currentDate().addDays( -365 ), -.br - QDate::currentDate().addDays( 365 ) ); -.br - dateEdit->setOrder( QDateEdit::MDY ); -.br - dateEdit->setAutoAdvance( TRUE ); -.br -.fi -.PP -Here we've created a new QDateEdit object initialised with today's date and restricted the valid date range to today plus or minus 365 days. We've set the order to month, day, year. If the auto advance property is TRUE (as we've set it here) when the user completes a section of the date, e.g. enters two digits for the month, they are automatically taken to the next section. -.PP -The maximum and minimum values for a date value in the date editor default to the maximum and minimum values for a QDate. You can change this by calling setMinValue(), setMaxValue() or setRange(). -.PP -Terminology: A QDateEdit widget comprises three 'sections', one each for the year, month and day. You can change the separator character using QDateTimeEditor::setSeparator(), by default the separator will be taken from the systems settings. If that is not possible, it defaults to "-". -.PP -
                -.ce 1 -.B "[Image Omitted]" -.PP -
                -.PP -See also QDate, QTimeEdit, QDateTimeEdit, Advanced Widgets, and Time and Date. -.SS "Member Type Documentation" -.SH "QDateEdit::Order" -This enum defines the order in which the sections that comprise a date appear. -.TP -\fCQDateEdit::MDY\fR - month-day-year -.TP -\fCQDateEdit::DMY\fR - day-month-year -.TP -\fCQDateEdit::YMD\fR - year-month-day (the default) -.TP -\fCQDateEdit::YDM\fR - year-day-month (included for completeness; but should not be used) -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDateEdit::QDateEdit ( QWidget * parent = 0, const char * name = 0 )" -Constructs an empty date editor which is a child of \fIparent\fR and called name \fIname\fR. -.SH "QDateEdit::QDateEdit ( const QDate & date, QWidget * parent = 0, const char * name = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a date editor with the initial value \fIdate\fR, parent \fIparent\fR and called \fIname\fR. -.PP -The date editor is initialized with \fIdate\fR. -.SH "QDateEdit::~QDateEdit ()" -Destroys the object and frees any allocated resources. -.SH "bool QDateEdit::autoAdvance () const" -Returns TRUE if the editor automatically advances to the next section; otherwise returns FALSE. See the "autoAdvance" property for details. -.SH "QDate QDateEdit::date () const" -Returns the editor's date value. See the "date" property for details. -.SH "void QDateEdit::fix ()\fC [virtual protected]\fR" -Attempts to fix any invalid date entries. -.PP -The rules applied are as follows: -.TP -If the year has four digits it is left unchanged. -.TP -If the year has two digits, the year will be changed to four digits in the range current year - 70 to current year + 29. -.TP -If the year has three digits in the range 100..999, the current millennium, i.e. 2000, will be added giving a year in the range 2100..2999. -.TP -If the day or month is 0 then it will be set to 1 or the minimum valid day\\month in the range. -.SH "QDate QDateEdit::maxValue () const" -Returns the editor's maximum value. See the "maxValue" property for details. -.SH "QDate QDateEdit::minValue () const" -Returns the editor's minimum value. See the "minValue" property for details. -.SH "Order QDateEdit::order () const" -Returns the order in which the year, month and day appear. See the "order" property for details. -.SH "QString QDateEdit::sectionFormattedText ( int sec )\fC [virtual protected]\fR" -Returns the formatted number for section \fIsec\fR. This will correspond to either the year, month or day section, depending on the current display order. -.PP -See also order. -.SH "QString QDateEdit::separator () const" -Returns the editor's separator. -.SH "void QDateEdit::setAutoAdvance ( bool advance )\fC [virtual]\fR" -Sets whether the editor automatically advances to the next section to \fIadvance\fR. See the "autoAdvance" property for details. -.SH "void QDateEdit::setDate ( const QDate & date )\fC [virtual slot]\fR" -Sets the editor's date value to \fIdate\fR. See the "date" property for details. -.SH "void QDateEdit::setDay ( int day )\fC [virtual protected]\fR" -Sets the day to \fIday\fR, which must be a valid day. The function will ensure that the \fIday\fR set is valid for the month and year. -.SH "void QDateEdit::setMaxValue ( const QDate & d )\fC [virtual]\fR" -Sets the editor's maximum value to \fId\fR. See the "maxValue" property for details. -.SH "void QDateEdit::setMinValue ( const QDate & d )\fC [virtual]\fR" -Sets the editor's minimum value to \fId\fR. See the "minValue" property for details. -.SH "void QDateEdit::setMonth ( int month )\fC [virtual protected]\fR" -Sets the month to \fImonth\fR, which must be a valid month, i.e. between 1 and 12. -.SH "void QDateEdit::setOrder ( Order order )\fC [virtual]\fR" -Sets the order in which the year, month and day appear to \fIorder\fR. See the "order" property for details. -.SH "void QDateEdit::setRange ( const QDate & min, const QDate & max )\fC [virtual]\fR" -Sets the valid input range for the editor to be from \fImin\fR to \fImax\fR inclusive. If \fImin\fR is invalid no minimum date will be set. Similarly, if \fImax\fR is invalid no maximum date will be set. -.SH "void QDateEdit::setSeparator ( const QString & s )\fC [virtual]\fR" -Sets the separator to \fIs\fR. Note that currently only the first character of \fIs\fR is used. -.SH "void QDateEdit::setYear ( int year )\fC [virtual protected]\fR" -Sets the year to \fIyear\fR, which must be a valid year. The range currently supported is from 1752 to 8000. -.PP -See also QDate. -.SH "void QDateEdit::updateButtons ()\fC [protected slot]\fR" -Enables/disables the push buttons according to the min/max date for this widget. -.SH "void QDateEdit::valueChanged ( const QDate & date )\fC [signal]\fR" -This signal is emitted whenever the editor's value changes. The \fIdate\fR parameter is the new value. -.SS "Property Documentation" -.SH "bool autoAdvance" -This property holds whether the editor automatically advances to the next section. -.PP -If autoAdvance is TRUE, the editor will automatically advance focus to the next date section if a user has completed a section. The default is FALSE. -.PP -Set this property's value with setAutoAdvance() and get this property's value with autoAdvance(). -.SH "QDate date" -This property holds the editor's date value. -.PP -If the date property is not valid, the editor displays all zeroes and QDateEdit::date() will return an invalid date. It is strongly recommended that the editor is given a default date value (e.g. currentDate()). That way, attempts to set the date property to an invalid date will fail. -.PP -When changing the date property, if the date is less than minValue(), or is greater than maxValue(), nothing happens. -.PP -Set this property's value with setDate() and get this property's value with date(). -.SH "QDate maxValue" -This property holds the editor's maximum value. -.PP -Setting the maximum date value for the editor is equivalent to calling QDateEdit::setRange( minValue(), \fId\fR ), where \fId\fR is the maximum date. The default maximum date is 8000-12-31. -.PP -See also minValue and setRange(). -.PP -Set this property's value with setMaxValue() and get this property's value with maxValue(). -.SH "QDate minValue" -This property holds the editor's minimum value. -.PP -Setting the minimum date value is equivalent to calling QDateEdit::setRange( \fId\fR, maxValue() ), where \fId\fR is the minimum date. The default minimum date is 1752-09-14. -.PP -See also maxValue and setRange(). -.PP -Set this property's value with setMinValue() and get this property's value with minValue(). -.SH "Order order" -This property holds the order in which the year, month and day appear. -.PP -The default order is locale dependent. -.PP -See also Order. -.PP -Set this property's value with setOrder() and get this property's value with order(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdateedit.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdateedit.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdatetime.3qt b/doc/man/man3/qdatetime.3qt deleted file mode 100644 index c2ecc145d..000000000 --- a/doc/man/man3/qdatetime.3qt +++ /dev/null @@ -1,337 +0,0 @@ -'\" t -.TH QDateTime 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 -QDateTime \- Date and time functions -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDateTime\fR ()" -.br -.ti -1c -.BI "\fBQDateTime\fR ( const QDate & date )" -.br -.ti -1c -.BI "\fBQDateTime\fR ( const QDate & date, const QTime & time )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "QDate \fBdate\fR () const" -.br -.ti -1c -.BI "QTime \fBtime\fR () const" -.br -.ti -1c -.BI "uint \fBtoTime_t\fR () const" -.br -.ti -1c -.BI "void \fBsetDate\fR ( const QDate & date )" -.br -.ti -1c -.BI "void \fBsetTime\fR ( const QTime & time )" -.br -.ti -1c -.BI "void \fBsetTime_t\fR ( uint secsSince1Jan1970UTC )" -.br -.ti -1c -.BI "void \fBsetTime_t\fR ( uint secsSince1Jan1970UTC, Qt::TimeSpec ts )" -.br -.ti -1c -.BI "QString \fBtoString\fR ( Qt::DateFormat f = Qt::TextDate ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( const QString & format ) const" -.br -.ti -1c -.BI "QDateTime \fBaddDays\fR ( int ndays ) const" -.br -.ti -1c -.BI "QDateTime \fBaddMonths\fR ( int nmonths ) const" -.br -.ti -1c -.BI "QDateTime \fBaddYears\fR ( int nyears ) const" -.br -.ti -1c -.BI "QDateTime \fBaddSecs\fR ( int nsecs ) const" -.br -.ti -1c -.BI "int \fBdaysTo\fR ( const QDateTime & dt ) const" -.br -.ti -1c -.BI "int \fBsecsTo\fR ( const QDateTime & dt ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QDateTime & dt ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QDateTime & dt ) const" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const QDateTime & dt ) const" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const QDateTime & dt ) const" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const QDateTime & dt ) const" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const QDateTime & dt ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QDateTime \fBcurrentDateTime\fR ()" -.br -.ti -1c -.BI "QDateTime \fBcurrentDateTime\fR ( Qt::TimeSpec ts )" -.br -.ti -1c -.BI "QDateTime \fBfromString\fR ( const QString & s, Qt::DateFormat f = Qt::TextDate )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QDateTime & dt )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QDateTime & dt )" -.br -.in -1c -.SH DESCRIPTION -The QDateTime class provides date and time functions. -.PP -A QDateTime object contains a calendar date and a clock time (a" datetime"). It is a combination of the QDate and QTime classes. It can read the current datetime from the system clock. It provides functions for comparing datetimes and for manipulating a datetime by adding a number of seconds, days, months or years. -.PP -A QDateTime object is typically created either by giving a date and time explicitly in the constructor, or by using the static function currentDateTime(), which returns a QDateTime object set to the system clock's time. The date and time can be changed with setDate() and setTime(). A datetime can also be set using the setTime_t() function, which takes a POSIX-standard "number of seconds since 00:00:00 on January 1, 1970" value. The fromString() function returns a QDateTime given a string and a date format which is used to interpret the date within the string. -.PP -The date() and time() functions provide access to the date and time parts of the datetime. The same information is provided in textual format by the toString() function. -.PP -QDateTime provides a full set of operators to compare two QDateTime objects where smaller means earlier and larger means later. -.PP -You can increment (or decrement) a datetime by a given number of seconds using addSecs() or days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two datetimes, and secsTo() returns the number of seconds between two datetimes. -.PP -The range of a datetime object is constrained to the ranges of the QDate and QTime objects which it embodies. -.PP -See also QDate, QTime, QDateTimeEdit, and Time and Date. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDateTime::QDateTime ()" -Constructs a null datetime (i.e. null date and null time). A null datetime is invalid, since the date is invalid. -.PP -See also isValid(). -.SH "QDateTime::QDateTime ( const QDate & date )" -Constructs a datetime with date \fIdate\fR and null (but valid) time (00:00:00.000). -.SH "QDateTime::QDateTime ( const QDate & date, const QTime & time )" -Constructs a datetime with date \fIdate\fR and time \fItime\fR. -.SH "QDateTime QDateTime::addDays ( int ndays ) const" -Returns a QDateTime object containing a datetime \fIndays\fR days later than the datetime of this object (or earlier if \fIndays\fR is negative). -.PP -See also daysTo(), addMonths(), addYears(), and addSecs(). -.SH "QDateTime QDateTime::addMonths ( int nmonths ) const" -Returns a QDateTime object containing a datetime \fInmonths\fR months later than the datetime of this object (or earlier if \fInmonths\fR is negative). -.PP -See also daysTo(), addDays(), addYears(), and addSecs(). -.SH "QDateTime QDateTime::addSecs ( int nsecs ) const" -Returns a QDateTime object containing a datetime \fInsecs\fR seconds later than the datetime of this object (or earlier if \fInsecs\fR is negative). -.PP -See also secsTo(), addDays(), addMonths(), and addYears(). -.PP -Example: listviews/listviews.cpp. -.SH "QDateTime QDateTime::addYears ( int nyears ) const" -Returns a QDateTime object containing a datetime \fInyears\fR years later than the datetime of this object (or earlier if \fInyears\fR is negative). -.PP -See also daysTo(), addDays(), addMonths(), and addSecs(). -.SH "QDateTime QDateTime::currentDateTime ( Qt::TimeSpec ts )\fC [static]\fR" -Returns the current datetime, as reported by the system clock, for the TimeSpec \fIts\fR. The default TimeSpec is LocalTime. -.PP -See also QDate::currentDate(), QTime::currentTime(), and Qt::TimeSpec. -.PP -Example: listviews/listviews.cpp. -.SH "QDateTime QDateTime::currentDateTime ()\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the current datetime, as reported by the system clock. -.PP -See also QDate::currentDate() and QTime::currentTime(). -.SH "QDate QDateTime::date () const" -Returns the date part of the datetime. -.PP -See also setDate() and time(). -.SH "int QDateTime::daysTo ( const QDateTime & dt ) const" -Returns the number of days from this datetime to \fIdt\fR (which is negative if \fIdt\fR is earlier than this datetime). -.PP -See also addDays() and secsTo(). -.SH "QDateTime QDateTime::fromString ( const QString & s, Qt::DateFormat f = Qt::TextDate )\fC [static]\fR" -Returns the QDateTime represented by the string \fIs\fR, using the format \fIf\fR, or an invalid datetime if this is not possible. -.PP -Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used, they depend on the user's locale settings. -.PP -\fBWarning:\fR Note that Qt::LocalDate cannot be used here. -.SH "bool QDateTime::isNull () const" -Returns TRUE if both the date and the time are null; otherwise returns FALSE. A null datetime is invalid. -.PP -See also QDate::isNull() and QTime::isNull(). -.SH "bool QDateTime::isValid () const" -Returns TRUE if both the date and the time are valid; otherwise returns FALSE. -.PP -See also QDate::isValid() and QTime::isValid(). -.SH "bool QDateTime::operator!= ( const QDateTime & dt ) const" -Returns TRUE if this datetime is different from \fIdt\fR; otherwise returns FALSE. -.PP -See also operator==(). -.SH "bool QDateTime::operator< ( const QDateTime & dt ) const" -Returns TRUE if this datetime is earlier than \fIdt\fR; otherwise returns FALSE. -.SH "bool QDateTime::operator<= ( const QDateTime & dt ) const" -Returns TRUE if this datetime is earlier than or equal to \fIdt\fR; otherwise returns FALSE. -.SH "bool QDateTime::operator== ( const QDateTime & dt ) const" -Returns TRUE if this datetime is equal to \fIdt\fR; otherwise returns FALSE. -.PP -See also operator!=(). -.SH "bool QDateTime::operator> ( const QDateTime & dt ) const" -Returns TRUE if this datetime is later than \fIdt\fR; otherwise returns FALSE. -.SH "bool QDateTime::operator>= ( const QDateTime & dt ) const" -Returns TRUE if this datetime is later than or equal to \fIdt\fR; otherwise returns FALSE. -.SH "int QDateTime::secsTo ( const QDateTime & dt ) const" -Returns the number of seconds from this datetime to \fIdt\fR (which is negative if \fIdt\fR is earlier than this datetime). -.PP -Example: -.PP -.nf -.br - QDateTime dt = QDateTime::currentDateTime(); -.br - QDateTime xmas( QDate(dt.date().year(),12,24), QTime(17,00) ); -.br - tqDebug( "There are %d seconds to Christmas", dt.secsTo(xmas) ); -.br -.fi -.PP -See also addSecs(), daysTo(), and QTime::secsTo(). -.SH "void QDateTime::setDate ( const QDate & date )" -Sets the date part of this datetime to \fIdate\fR. -.PP -See also date() and setTime(). -.SH "void QDateTime::setTime ( const QTime & time )" -Sets the time part of this datetime to \fItime\fR. -.PP -See also time() and setDate(). -.SH "void QDateTime::setTime_t ( uint secsSince1Jan1970UTC, Qt::TimeSpec ts )" -Sets the date and time to \fIts\fR time (Qt::LocalTime or Qt::UTC) given the number of seconds that have passed since 1970-01-01T00:00:00, Coordinated Universal Time (UTC). On systems that do not support timezones this function will behave as if local time were UTC. -.PP -On Windows, only a subset of \fIsecsSince1Jan1970UTC\fR values are supported, as Windows starts counting from 1980. -.PP -See also toTime_t(). -.SH "void QDateTime::setTime_t ( uint secsSince1Jan1970UTC )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Convenience function that sets the date and time to local time based on the given UTC time. -.SH "QTime QDateTime::time () const" -Returns the time part of the datetime. -.PP -See also setTime() and date(). -.SH "QString QDateTime::toString ( const QString & format ) const" -Returns the datetime as a string. The \fIformat\fR parameter determines the format of the result string. -.PP -These expressions may be used for the date: -.PP -
                .nf -.TS -l - l. Expression Output d the day as number without a leading zero (1-31) dd the day as number with a leading zero (01-31) ddd the abbreviated localized day name (e.g. 'Mon'..'Sun'). Uses QDate::shortDayName(). dddd the long localized day name (e.g. 'Monday'..'Sunday'). Uses QDate::longDayName(). M the month as number without a leading zero (1-12) MM the month as number with a leading zero (01-12) MMM the abbreviated localized month name (e.g. 'Jan'..'Dec'). Uses QDate::shortMonthName(). MMMM the long localized month name (e.g. 'January'..'December'). Uses QDate::longMonthName(). yy the year as two digit number (00-99) yyyy -.TE -.fi -
                -.PP -These expressions may be used for the time: -.PP -
                .nf -.TS -l - l. Expression Output h the hour without a leading zero (0..23 or 1..12 if AM/PM display) hh the hour with a leading zero (00..23 or 01..12 if AM/PM display) m the minute without a leading zero (0..59) mm the minute with a leading zero (00..59) s the second whithout a leading zero (0..59) ss the second whith a leading zero (00..59) z the milliseconds without leading zeroes (0..999) zzz the milliseconds with leading zeroes (000..999) AP use AM/PM display. \fIAP\fR will be replaced by either "AM" or "PM". ap -.TE -.fi -
                -.PP -All other input characters will be ignored. -.PP -Example format strings (assumed that the QDateTime is 21st May 2001 14:13:09) -.PP -
                .nf -.TS -l - l. Format Result dd.MM.yyyy 21.05.2001 ddd MMMM d yy Tue May 21 01 hh:mm:ss.zzz 14:13:09.042 h:m:s ap -.TE -.fi -
                -.PP -If the datetime is an invalid datetime, then QString::null will be returned. -.PP -See also QDate::toString() and QTime::toString(). -.SH "QString QDateTime::toString ( Qt::DateFormat f = Qt::TextDate ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the datetime as a string. The \fIf\fR parameter determines the format of the string. -.PP -If \fIf\fR is Qt::TextDate, the string format is "Wed May 20 03:40:13 1998" (using QDate::shortDayName(), QDate::shortMonthName(), and QTime::toString() to generate the string, so the day and month names will have localized names). -.PP -If \fIf\fR is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, which is YYYY-MM-DDTHH:MM:SS. -.PP -If \fIf\fR is Qt::LocalDate, the string format depends on the locale settings of the system. -.PP -If the format \fIf\fR is invalid or the datetime is invalid, toString() returns a null string. -.PP -See also QDate::toString() and QTime::toString(). -.SH "uint QDateTime::toTime_t () const" -Returns the datetime as the number of seconds that have passed since 1970-01-01T00:00:00, Coordinated Universal Time (UTC). -.PP -On systems that do not support timezones, this function will behave as if local time were UTC. -.PP -See also setTime_t(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QDateTime & dt )" -Writes the datetime \fIdt\fR to the stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QDateTime & dt )" -Reads a datetime from the stream \fIs\fR into \fIdt\fR. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdatetime.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdatetime.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdatetimeedit.3qt b/doc/man/man3/qdatetimeedit.3qt deleted file mode 100644 index 6171a3229..000000000 --- a/doc/man/man3/qdatetimeedit.3qt +++ /dev/null @@ -1,146 +0,0 @@ -'\" t -.TH QDateTimeEdit 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 -QDateTimeEdit \- Combines a QDateEdit and QTimeEdit widget into a single widget for editing datetimes -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDateTimeEdit\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQDateTimeEdit\fR ( const QDateTime & datetime, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QDateTimeEdit\fR ()" -.br -.ti -1c -.BI "QDateTime \fBdateTime\fR () const" -.br -.ti -1c -.BI "QDateEdit * \fBdateEdit\fR ()" -.br -.ti -1c -.BI "QTimeEdit * \fBtimeEdit\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetAutoAdvance\fR ( bool advance )" -.br -.ti -1c -.BI "bool \fBautoAdvance\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetDateTime\fR ( const QDateTime & dt )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBvalueChanged\fR ( const QDateTime & datetime )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QDateTime \fBdateTime\fR - the editor's datetime value" -.br -.in -1c -.SH DESCRIPTION -The QDateTimeEdit class combines a QDateEdit and QTimeEdit widget into a single widget for editing datetimes. -.PP -QDateTimeEdit consists of a QDateEdit and QTimeEdit widget placed side by side and offers the functionality of both. The user can edit the date and time by using the keyboard or the arrow keys to increase/decrease date or time values. The Tab key can be used to move from section to section within the QDateTimeEdit widget, and the user can be moved automatically when they complete a section using setAutoAdvance(). The datetime can be set with setDateTime(). -.PP -The date format is read from the system's locale settings. It is set to year, month, day order if that is not possible. See QDateEdit::setOrder() to change this. Times appear in the order hours, minutes, seconds using the 24 hour clock. -.PP -It is recommended that the QDateTimeEdit is initialised with a datetime, e.g. -.PP -.nf -.br - QDateTimeEdit *dateTimeEdit = new QDateTimeEdit( QDateTime::currentDateTime(), this ); -.br - dateTimeEdit->dateEdit()->setRange( QDateTime::currentDate(), -.br - QDateTime::currentDate().addDays( 7 ) ); -.br -.fi -Here we've created a new QDateTimeEdit set to the current date and time, and set the date to have a minimum date of now and a maximum date of a week from now. -.PP -Terminology: A QDateEdit widget consists of three 'sections', one each for the year, month and day. Similarly a QTimeEdit consists of three sections, one each for the hour, minute and second. The character that separates each date section is specified with setDateSeparator(); similarly setTimeSeparator() is used for the time sections. -.PP -
                -.ce 1 -.B "[Image Omitted]" -.PP -
                -.PP -See also QDateEdit, QTimeEdit, Advanced Widgets, and Time and Date. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDateTimeEdit::QDateTimeEdit ( QWidget * parent = 0, const char * name = 0 )" -Constructs an empty datetime edit with parent \fIparent\fR and called \fIname\fR. -.SH "QDateTimeEdit::QDateTimeEdit ( const QDateTime & datetime, QWidget * parent = 0, const char * name = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a datetime edit with the initial value \fIdatetime\fR, parent \fIparent\fR and called \fIname\fR. -.SH "QDateTimeEdit::~QDateTimeEdit ()" -Destroys the object and frees any allocated resources. -.SH "bool QDateTimeEdit::autoAdvance () const" -Returns TRUE if auto-advance is enabled, otherwise returns FALSE. -.PP -See also setAutoAdvance(). -.SH "QDateEdit * QDateTimeEdit::dateEdit ()" -Returns the internal widget used for editing the date part of the datetime. -.SH "QDateTime QDateTimeEdit::dateTime () const" -Returns the editor's datetime value. See the "dateTime" property for details. -.SH "void QDateTimeEdit::setAutoAdvance ( bool advance )\fC [virtual]\fR" -Sets the auto advance property of the editor to \fIadvance\fR. If set to TRUE, the editor will automatically advance focus to the next date or time section if the user has completed a section. -.SH "void QDateTimeEdit::setDateTime ( const QDateTime & dt )\fC [virtual slot]\fR" -Sets the editor's datetime value to \fIdt\fR. See the "dateTime" property for details. -.SH "QTimeEdit * QDateTimeEdit::timeEdit ()" -Returns the internal widget used for editing the time part of the datetime. -.SH "void QDateTimeEdit::valueChanged ( const QDateTime & datetime )\fC [signal]\fR" -This signal is emitted every time the date or time changes. The \fIdatetime\fR argument is the new datetime. -.SS "Property Documentation" -.SH "QDateTime dateTime" -This property holds the editor's datetime value. -.PP -The datetime edit's datetime which may be an invalid datetime. -.PP -Set this property's value with setDateTime() and get this property's value with dateTime(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdatetimeedit.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdatetimeedit.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdatetimeeditbase.3qt b/doc/man/man3/qdatetimeeditbase.3qt deleted file mode 100644 index 46c2bfcaf..000000000 --- a/doc/man/man3/qdatetimeeditbase.3qt +++ /dev/null @@ -1,48 +0,0 @@ -'\" t -.TH QDateTimeEditBase 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 -QDateTimeEditBase \- Abstraction for date and edit editors -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -Inherited by QDateEdit and QTimeEdit. -.PP -.SH DESCRIPTION -The QDateTimeEditBase class provides an abstraction for date and edit editors. -.PP -Small abstract class that provides some functions that are common -for both QDateEdit and QTimeEdit. It is used internally by -QDateTimeEditor. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdatetimeeditbase.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdatetimeeditbase.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdeepcopy.3qt b/doc/man/man3/qdeepcopy.3qt deleted file mode 100644 index 0d6e163a5..000000000 --- a/doc/man/man3/qdeepcopy.3qt +++ /dev/null @@ -1,190 +0,0 @@ -'\" t -.TH QDeepCopy 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 -QDeepCopy \- Template class which ensures that -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDeepCopy\fR ()" -.br -.ti -1c -.BI "\fBQDeepCopy\fR ( const T & t )" -.br -.ti -1c -.BI "QDeepCopy & \fBoperator=\fR ( const T & t )" -.br -.ti -1c -.BI "\fBoperator T\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QDeepCopy class is a template class which ensures that implicitly shared and explicitly shared classes reference unique data. -.PP -Normally, shared copies reference the same data to optimize memory use and for maximum speed. In the example below, \fCs1\fR, \fCs2\fR, \fCs3\fR, \fCs4\fR and \fCs5\fR share data. -.PP -.nf -.br - // all 5 strings share the same data -.br - QString s1 = "abcd"; -.br - QString s2 = s1; -.br - QString s3 = s2; -.br - QString s4 = s3; -.br - QString s5 = s2; -.br -.fi -.PP -QDeepCopy can be used several ways to ensure that an object references unique, unshared data. In the example below, \fCs1\fR, \fCs2\fR and \fCs5\fR share data, while neither \fCs3\fR nor \fCs4\fR share data. -.PP -.nf -.br - // s1, s2 and s5 share the same data, neither s3 nor s4 are shared -.br - QString s1 = "abcd"; -.br - QString s2 = s1; -.br - QDeepCopy s3 = s2; // s3 is a deep copy of s2 -.br - QString s4 = s3; // s4 is a deep copy of s3 -.br - QString s5 = s2; -.br -.fi -.PP -In the example below, \fCs1\fR, \fCs2\fR and \fCs5\fR share data, and \fCs3\fR and \fCs4\fR share data. -.PP -.nf -.br - // s1, s2 and s5 share the same data, s3 and s4 share the same data -.br - QString s1 = "abcd"; -.br - QString s2 = s1; -.br - QString s3 = QDeepCopy( s2 ); // s3 is a deep copy of s2 -.br - QString s4 = s3; // s4 is a shallow copy of s3 -.br - QString s5 = s2; -.br -.fi -.PP -QDeepCopy can also provide safety in multithreaded applications that use shared classes. In the example below, the variable \fCglobal_string\fR is used safely since the data contained in \fCglobal_string\fR is always a deep copy. This ensures that all threads get a unique copy of the data, and that any assignments to \fCglobal_string\fR will result in a deep copy. -.PP -.nf -.br - QDeepCopy global_string; // global string data -.br - QMutex global_mutex; // mutex to protext global_string -.br -.br - ... -.br -.br - void setGlobalString( const QString &str ) -.br - { -.br - global_mutex.lock(); -.br - global_string = str; // global_string is a deep copy of str -.br - global_mutex.unlock(); -.br - } -.br -.br - ... -.br -.br - void MyThread::run() -.br - { -.br - global_mutex.lock(); -.br - QString str = global_string; // str is a deep copy of global_string -.br - global_mutex.unlock(); -.br -.br - // process the string data -.br - ... -.br -.br - // update global_string -.br - setGlobalString( str ); -.br - } -.br -.fi -.PP -\fBWarning:\fR It is the application developer's responsibility to protect the object shared across multiple threads. -.PP -The examples above use QString, which is an implicitly shared class. The behavior of QDeepCopy is the same when using explicitly shared classes like QByteArray. -.PP -Currently, QDeepCopy works with the following classes: -.TP -QMemArray (including subclasses like QByteArray and QCString) -.TP -QMap -.TP -QString -.TP -QValueList (including subclasses like QStringList and QValueStack) -.TP -QValueVector -.PP -See also Thread Support in Qt, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDeepCopy::QDeepCopy ()" -Constructs an empty instance of type \fIT\fR. -.SH "QDeepCopy::QDeepCopy ( const T & t )" -Constructs a deep copy of \fIt\fR. -.SH "QDeepCopy::operator T ()" -Returns a deep copy of the encapsulated data. -.SH "QDeepCopy & QDeepCopy::operator= ( const T & t )" -Assigns a deep copy of \fIt\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdeepcopy.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdeepcopy.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdesktopwidget.3qt b/doc/man/man3/qdesktopwidget.3qt deleted file mode 100644 index 7eafefd8a..000000000 --- a/doc/man/man3/qdesktopwidget.3qt +++ /dev/null @@ -1,190 +0,0 @@ -'\" t -.TH QDesktopWidget 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 -QDesktopWidget \- Access to screen information on multi-head systems -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDesktopWidget\fR ()" -.br -.ti -1c -.BI "\fB~QDesktopWidget\fR ()" -.br -.ti -1c -.BI "bool \fBisVirtualDesktop\fR () const" -.br -.ti -1c -.BI "int \fBnumScreens\fR () const" -.br -.ti -1c -.BI "int \fBprimaryScreen\fR () const" -.br -.ti -1c -.BI "int \fBscreenNumber\fR ( QWidget * widget = 0 ) const" -.br -.ti -1c -.BI "int \fBscreenNumber\fR ( const QPoint & point ) const" -.br -.ti -1c -.BI "QWidget * \fBscreen\fR ( int screen = -1 )" -.br -.ti -1c -.BI "const QRect & \fBscreenGeometry\fR ( int screen = -1 ) const" -.br -.ti -1c -.BI "const QRect & \fBscreenGeometry\fR ( QWidget * widget ) const" -.br -.ti -1c -.BI "const QRect & \fBscreenGeometry\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "const QRect & \fBavailableGeometry\fR ( int screen = -1 ) const" -.br -.ti -1c -.BI "const QRect & \fBavailableGeometry\fR ( QWidget * widget ) const" -.br -.ti -1c -.BI "const QRect & \fBavailableGeometry\fR ( const QPoint & p ) const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBresized\fR ( int screen )" -.br -.in -1c -.SH DESCRIPTION -The QDesktopWidget class provides access to screen information on multi-head systems. -.PP -Systems with more than one graphics card and monitor can manage the physical screen space available either as multiple desktops, or as a large virtual desktop, which usually has the size of the bounding rectangle of all the screens (see isVirtualDesktop()). For an application, one of the available screens is the primary screen, i.e. the screen where the main widget resides (see primaryScreen()). All windows opened in the context of the application must be constrained to the boundaries of the primary screen; for example, it would be inconvenient if a dialog box popped up on a different screen, or split over two screens. -.PP -The QDesktopWidget provides information about the geometry of the available screens with screenGeometry(). The number of screens available is returned by numScreens(). The screen number that a particular point or widget is located in is returned by screenNumber(). -.PP -Widgets provided by Qt use this class, for example, to place tooltips, menus and dialog boxes according to the parent or application widget. -.PP -Applications can use this class to save window positions, or to place child widgets on one screen. -.PP -
                -.ce 1 -.B "[Image Omitted]" -.PP -
                -.PP -In the illustration above, Application One's primary screen is screen 0, and App Two's primary screen is screen 1. -.PP -See also Advanced Widgets and Environment Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDesktopWidget::QDesktopWidget ()" -Creates the desktop widget. -.PP -If the system supports a virtual desktop, this widget will have the size of the virtual desktop; otherwise this widget will have the size of the primary screen. -.PP -Instead of using QDesktopWidget directly, use QApplication::desktop(). -.SH "QDesktopWidget::~QDesktopWidget ()" -Destroy the object and free allocated resources. -.SH "const QRect & QDesktopWidget::availableGeometry ( int screen = -1 ) const" -Returns the available geometry of the screen with index \fIscreen\fR. What is available will be subrect of screenGeometry() based on what the platform decides is available (for example excludes the Dock and Menubar on Mac OS X, or the taskbar on Windows). -.PP -See also screenNumber() and screenGeometry(). -.SH "const QRect & QDesktopWidget::availableGeometry ( QWidget * widget ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the available geometry of the screen which contains \fIwidget\fR. -.PP -See also screenGeometry(). -.SH "const QRect & QDesktopWidget::availableGeometry ( const QPoint & p ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the available geometry of the screen which contains \fIp\fR. -.PP -See also screenGeometry(). -.SH "bool QDesktopWidget::isVirtualDesktop () const" -Returns TRUE if the system manages the available screens in a virtual desktop; otherwise returns FALSE. -.PP -For virtual desktops, screen() will always return the same widget. The size of the virtual desktop is the size of this desktop widget. -.SH "int QDesktopWidget::numScreens () const" -Returns the number of available screens. -.PP -See also primaryScreen(). -.SH "int QDesktopWidget::primaryScreen () const" -Returns the index of the primary screen. -.PP -See also numScreens(). -.SH "void QDesktopWidget::resized ( int screen )\fC [signal]\fR" -This signal is emitted when the size of \fIscreen\fR changes. -.SH "QWidget * QDesktopWidget::screen ( int screen = -1 )" -Returns a widget that represents the screen with index \fIscreen\fR. This widget can be used to draw directly on the desktop, using an unclipped painter like this: -.PP -.nf -.br - QPainter paint( QApplication::desktop()->screen( 0 ), TRUE ); -.br - paint.draw... -.br - ... -.br - paint.end(); -.br -.fi -.PP -If the system uses a virtual desktop, the returned widget will have the geometry of the entire virtual desktop i.e. bounding every \fIscreen\fR. -.PP -See also primaryScreen(), numScreens(), and isVirtualDesktop(). -.SH "const QRect & QDesktopWidget::screenGeometry ( int screen = -1 ) const" -Returns the geometry of the screen with index \fIscreen\fR. -.PP -See also screenNumber(). -.SH "const QRect & QDesktopWidget::screenGeometry ( QWidget * widget ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the geometry of the screen which contains \fIwidget\fR. -.SH "const QRect & QDesktopWidget::screenGeometry ( const QPoint & p ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the geometry of the screen which contains \fIp\fR. -.SH "int QDesktopWidget::screenNumber ( QWidget * widget = 0 ) const" -Returns the index of the screen that contains the largest part of \fIwidget\fR, or -1 if the widget not on a screen. -.PP -See also primaryScreen(). -.SH "int QDesktopWidget::screenNumber ( const QPoint & point ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the index of the screen that contains \fIpoint\fR, or -1 if no screen contains the point. -.PP -See also primaryScreen(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdesktopwidget.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdesktopwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdial.3qt b/doc/man/man3/qdial.3qt deleted file mode 100644 index c58e65382..000000000 --- a/doc/man/man3/qdial.3qt +++ /dev/null @@ -1,365 +0,0 @@ -'\" t -.TH QDial 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 -QDial \- Rounded range control (like a speedometer or potentiometer) -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget and QRangeControl. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDial\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQDial\fR ( int minValue, int maxValue, int pageStep, int value, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QDial\fR ()" -.br -.ti -1c -.BI "bool \fBtracking\fR () const" -.br -.ti -1c -.BI "bool \fBwrapping\fR () const" -.br -.ti -1c -.BI "int \fBnotchSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNotchTarget\fR ( double )" -.br -.ti -1c -.BI "double \fBnotchTarget\fR () const" -.br -.ti -1c -.BI "bool \fBnotchesVisible\fR () const" -.br -.ti -1c -.BI "int \fBminValue\fR () const" -.br -.ti -1c -.BI "int \fBmaxValue\fR () const" -.br -.ti -1c -.BI "void \fBsetMinValue\fR ( int )" -.br -.ti -1c -.BI "void \fBsetMaxValue\fR ( int )" -.br -.ti -1c -.BI "int \fBlineStep\fR () const" -.br -.ti -1c -.BI "int \fBpageStep\fR () const" -.br -.ti -1c -.BI "void \fBsetLineStep\fR ( int )" -.br -.ti -1c -.BI "void \fBsetPageStep\fR ( int )" -.br -.ti -1c -.BI "int \fBvalue\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetValue\fR ( int )" -.br -.ti -1c -.BI "void \fBaddLine\fR ()" -.br -.ti -1c -.BI "void \fBsubtractLine\fR ()" -.br -.ti -1c -.BI "void \fBaddPage\fR ()" -.br -.ti -1c -.BI "void \fBsubtractPage\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetNotchesVisible\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetWrapping\fR ( bool on )" -.br -.ti -1c -.BI "virtual void \fBsetTracking\fR ( bool enable )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBvalueChanged\fR ( int value )" -.br -.ti -1c -.BI "void \fBdialPressed\fR ()" -.br -.ti -1c -.BI "void \fBdialMoved\fR ( int value )" -.br -.ti -1c -.BI "void \fBdialReleased\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBlineStep\fR - the current line step" -.br -.ti -1c -.BI "int \fBmaxValue\fR - the current maximum value" -.br -.ti -1c -.BI "int \fBminValue\fR - the current minimum value" -.br -.ti -1c -.BI "int \fBnotchSize\fR - the current notch size \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "double \fBnotchTarget\fR - the target number of pixels between notches" -.br -.ti -1c -.BI "bool \fBnotchesVisible\fR - whether the notches are shown" -.br -.ti -1c -.BI "int \fBpageStep\fR - the current page step" -.br -.ti -1c -.BI "bool \fBtracking\fR - whether tracking is enabled" -.br -.ti -1c -.BI "int \fBvalue\fR - the current dial value" -.br -.ti -1c -.BI "bool \fBwrapping\fR - whether wrapping is enabled" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBvalueChange\fR ()" -.br -.ti -1c -.BI "virtual void \fBrangeChange\fR ()" -.br -.ti -1c -.BI "virtual void \fBrepaintScreen\fR ( const QRect * cr = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QDial class provides a rounded range control (like a speedometer or potentiometer). -.PP -QDial is used when the user needs to control a value within a program-definable range, and the range either wraps around (typically, 0..359 degrees) or the dialog layout needs a square widget. -.PP -Both API- and UI-wise, the dial is very similar to a slider. Indeed, when wrapping() is FALSE (the default) there is no real difference between a slider and a dial. They have the same signals, slots and member functions, all of which do the same things. Which one you use depends only on your taste and on the application. -.PP -The dial initially emits valueChanged() signals continuously while the slider is being moved; you can make it emit the signal less often by calling setTracking(FALSE). dialMoved() is emitted continuously even when tracking() is FALSE. -.PP -The slider also emits dialPressed() and dialReleased() signals when the mouse button is pressed and released. But note that the dial's value can change without these signals being emitted; the keyboard and wheel can be used to change the value. -.PP -Unlike the slider, QDial attempts to draw a "nice" number of notches rather than one per lineStep(). If possible, the number of notches drawn is one per lineStep(), but if there aren't enough pixels to draw every one, QDial will draw every second, third etc., notch. notchSize() returns the number of units per notch, hopefully a multiple of lineStep(); setNotchTarget() sets the target distance between neighbouring notches in pixels. The default is 3.75 pixels. -.PP -Like the slider, the dial makes the QRangeControl functions setValue(), addLine(), subtractLine(), addPage() and subtractPage() available as slots. -.PP -The dial's keyboard interface is fairly simple: The left/up and right/down arrow keys move by lineStep(), page up and page down by pageStep() and Home and End to minValue() and maxValue(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QScrollBar, QSpinBox, GUI Design Handbook: Slider, and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDial::QDial ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a dial called \fIname\fR with parent \fIparent\fR. \fIf\fR is propagated to the QWidget constructor. It has the default range of a QRangeControl. -.SH "QDial::QDial ( int minValue, int maxValue, int pageStep, int value, QWidget * parent = 0, const char * name = 0 )" -Constructs a dial called \fIname\fR with parent \fIparent\fR. The dial's value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR. Its page step size is \fIpageStep\fR, and its initial value is \fIvalue\fR. -.PP -\fIvalue\fR is forced to be within the legal range. -.SH "QDial::~QDial ()" -Destroys the dial. -.SH "void QDial::addLine ()\fC [slot]\fR" -Increments the dial's value() by one lineStep(). -.SH "void QDial::addPage ()\fC [slot]\fR" -Increments the dial's value() by one pageStep() of steps. -.SH "void QDial::dialMoved ( int value )\fC [signal]\fR" -This signal is emitted whenever the dial \fIvalue\fR changes. The frequency of this signal is \fInot\fR influenced by setTracking(). -.PP -See also valueChanged(). -.SH "void QDial::dialPressed ()\fC [signal]\fR" -This signal is emitted when the user begins mouse interaction with the dial. -.PP -See also dialReleased(). -.SH "void QDial::dialReleased ()\fC [signal]\fR" -This signal is emitted when the user ends mouse interaction with the dial. -.PP -See also dialPressed(). -.SH "int QDial::lineStep () const" -Returns the current line step. See the "lineStep" property for details. -.SH "int QDial::maxValue () const" -Returns the current maximum value. See the "maxValue" property for details. -.SH "int QDial::minValue () const" -Returns the current minimum value. See the "minValue" property for details. -.SH "int QDial::notchSize () const" -Returns the current notch size. See the "notchSize" property for details. -.SH "double QDial::notchTarget () const" -Returns the target number of pixels between notches. See the "notchTarget" property for details. -.SH "bool QDial::notchesVisible () const" -Returns TRUE if the notches are shown; otherwise returns FALSE. See the "notchesVisible" property for details. -.SH "int QDial::pageStep () const" -Returns the current page step. See the "pageStep" property for details. -.SH "void QDial::rangeChange ()\fC [virtual protected]\fR" -Reimplemented to ensure tick-marks are consistent with the new range. -.PP -Reimplemented from QRangeControl. -.SH "void QDial::repaintScreen ( const QRect * cr = 0 )\fC [virtual protected]\fR" -Paints the dial using clip region \fIcr\fR. -.SH "void QDial::setLineStep ( int )" -Sets the current line step. See the "lineStep" property for details. -.SH "void QDial::setMaxValue ( int )" -Sets the current maximum value. See the "maxValue" property for details. -.SH "void QDial::setMinValue ( int )" -Sets the current minimum value. See the "minValue" property for details. -.SH "void QDial::setNotchTarget ( double )\fC [virtual]\fR" -Sets the target number of pixels between notches. See the "notchTarget" property for details. -.SH "void QDial::setNotchesVisible ( bool b )\fC [virtual slot]\fR" -Sets whether the notches are shown to \fIb\fR. See the "notchesVisible" property for details. -.SH "void QDial::setPageStep ( int )" -Sets the current page step. See the "pageStep" property for details. -.SH "void QDial::setTracking ( bool enable )\fC [virtual slot]\fR" -Sets whether tracking is enabled to \fIenable\fR. See the "tracking" property for details. -.SH "void QDial::setValue ( int )\fC [virtual slot]\fR" -Sets the current dial value. See the "value" property for details. -.SH "void QDial::setWrapping ( bool on )\fC [virtual slot]\fR" -Sets whether wrapping is enabled to \fIon\fR. See the "wrapping" property for details. -.SH "void QDial::subtractLine ()\fC [slot]\fR" -Decrements the dial's value() by one lineStep(). -.SH "void QDial::subtractPage ()\fC [slot]\fR" -Decrements the dial's value() by one pageStep() of steps. -.SH "bool QDial::tracking () const" -Returns TRUE if tracking is enabled; otherwise returns FALSE. See the "tracking" property for details. -.SH "int QDial::value () const" -Returns the current dial value. See the "value" property for details. -.SH "void QDial::valueChange ()\fC [virtual protected]\fR" -Reimplemented to ensure the display is correct and to emit the valueChanged(int) signal when appropriate. -.PP -Reimplemented from QRangeControl. -.SH "void QDial::valueChanged ( int value )\fC [signal]\fR" -This signal is emitted whenever the dial's \fIvalue\fR changes. The frequency of this signal is influenced by setTracking(). -.SH "bool QDial::wrapping () const" -Returns TRUE if wrapping is enabled; otherwise returns FALSE. See the "wrapping" property for details. -.SS "Property Documentation" -.SH "int lineStep" -This property holds the current line step. -.PP -setLineStep() calls the virtual stepChange() function if the new line step is different from the previous setting. -.PP -See also QRangeControl::setSteps(), pageStep, and setRange(). -.PP -Set this property's value with setLineStep() and get this property's value with lineStep(). -.SH "int maxValue" -This property holds the current maximum value. -.PP -When setting this property, the QDial::minValue is adjusted if necessary to ensure that the range remains valid. -.PP -See also setRange(). -.PP -Set this property's value with setMaxValue() and get this property's value with maxValue(). -.SH "int minValue" -This property holds the current minimum value. -.PP -When setting this property, the QDial::maxValue is adjusted if necessary to ensure that the range remains valid. -.PP -See also setRange(). -.PP -Set this property's value with setMinValue() and get this property's value with minValue(). -.SH "int notchSize" -This property holds the current notch size. -.PP -The notch size is in range control units, not pixels, and if possible it is a multiple of lineStep() that results in an on-screen notch size near notchTarget(). -.PP -See also notchTarget and lineStep. -.PP -Get this property's value with notchSize(). -.SH "double notchTarget" -This property holds the target number of pixels between notches. -.PP -The notch target is the number of pixels QDial attempts to put between each notch. -.PP -The actual size may differ from the target size. -.PP -Set this property's value with setNotchTarget() and get this property's value with notchTarget(). -.SH "bool notchesVisible" -This property holds whether the notches are shown. -.PP -If TRUE, the notches are shown. If FALSE (the default) notches are not shown. -.PP -Set this property's value with setNotchesVisible() and get this property's value with notchesVisible(). -.SH "int pageStep" -This property holds the current page step. -.PP -setPageStep() calls the virtual stepChange() function if the new page step is different from the previous setting. -.PP -See also stepChange(). -.PP -Set this property's value with setPageStep() and get this property's value with pageStep(). -.SH "bool tracking" -This property holds whether tracking is enabled. -.PP -If TRUE (the default), tracking is enabled. This means that the arrow can be moved using the mouse; otherwise the arrow cannot be moved with the mouse. -.PP -Set this property's value with setTracking() and get this property's value with tracking(). -.SH "int value" -This property holds the current dial value. -.PP -This is guaranteed to be within the range QDial::minValue..QDial::maxValue. -.PP -See also minValue and maxValue. -.PP -Set this property's value with setValue() and get this property's value with value(). -.SH "bool wrapping" -This property holds whether wrapping is enabled. -.PP -If TRUE, wrapping is enabled. This means that the arrow can be turned around 360°. Otherwise there is some space at the bottom of the dial which is skipped by the arrow. -.PP -This property's default is FALSE. -.PP -Set this property's value with setWrapping() and get this property's value with wrapping(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdial.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdial.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdialog.3qt b/doc/man/man3/qdialog.3qt deleted file mode 100644 index ae66f1c8b..000000000 --- a/doc/man/man3/qdialog.3qt +++ /dev/null @@ -1,322 +0,0 @@ -'\" t -.TH QDialog 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 -QDialog \- The base class of dialog windows -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -Inherited by QColorDialog, QErrorMessage, QFileDialog, QFontDialog, QInputDialog, QMessageBox, QMotifDialog, QProgressDialog, QTabDialog, and QWizard. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "explicit \fBQDialog\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QDialog\fR ()" -.br -.ti -1c -.BI "enum \fBDialogCode\fR { Rejected, Accepted }" -.br -.ti -1c -.BI "int \fBresult\fR () const" -.br -.ti -1c -.BI "virtual void \fBshow\fR ()" -.br -.ti -1c -.BI "void \fBsetOrientation\fR ( Orientation orientation )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "void \fBsetExtension\fR ( QWidget * extension )" -.br -.ti -1c -.BI "QWidget * \fBextension\fR () const" -.br -.ti -1c -.BI "void \fBsetSizeGripEnabled\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisSizeGripEnabled\fR () const" -.br -.ti -1c -.BI "void \fBsetModal\fR ( bool modal )" -.br -.ti -1c -.BI "bool \fBisModal\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "int \fBexec\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBmodal\fR - whether show() should pop up the dialog as modal or modeless" -.br -.ti -1c -.BI "bool \fBsizeGripEnabled\fR - whether the size grip is enabled" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsetResult\fR ( int i )" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "virtual void \fBdone\fR ( int r )" -.br -.ti -1c -.BI "virtual void \fBaccept\fR ()" -.br -.ti -1c -.BI "virtual void \fBreject\fR ()" -.br -.ti -1c -.BI "void \fBshowExtension\fR ( bool showIt )" -.br -.in -1c -.SH DESCRIPTION -The QDialog class is the base class of dialog windows. -.PP -A dialog window is a top-level window mostly used for short-term tasks and brief communications with the user. QDialogs may be modal or modeless. QDialogs support extensibility and can provide a return value. They can have default buttons. QDialogs can also have a QSizeGrip in their lower-right corner, using setSizeGripEnabled(). -.PP -Note that QDialog uses the parent widget slightly differently from other classes in Qt. A dialog is always a top-level widget, but if it has a parent, its default location is centered on top of the parent's top-level widget (if it is not top-level itself). It will also share the parent's taskbar entry. -.SH "Modal Dialogs" -A \fBmodal\fR dialog is a dialog that blocks input to other visible windows in the same application. Users must finish interacting with the dialog and close it before they can access any other window in the application. Dialogs that are used to request a file name from the user or that are used to set application preferences are usually modal. -.PP -The most common way to display a modal dialog is to call its exec() function. When the user closes the dialog, exec() will provide a useful return value. Typically we connect a default button, e.g. "OK", to the accept() slot and a" Cancel" button to the reject() slot, to get the dialog to close and return the appropriate value. Alternatively you can connect to the done() slot, passing it Accepted or Rejected. -.PP -An alternative is to call setModal(TRUE), then show(). Unlike exec(), show() returns control to the caller immediately. Calling setModal(TRUE) is especially useful for progress dialogs, where the user must have the ability to interact with the dialog, e.g. to cancel a long running operation. If you use show() and setModal(TRUE) together you must call QApplication::processEvents() periodically during processing to enable the user to interact with the dialog. (See QProgressDialog.) -.SH "Modeless Dialogs" -A \fBmodeless\fR dialog is a dialog that operates independently of other windows in the same application. Find and replace dialogs in word-processors are often modeless to allow the user to interact with both the application's main window and with the dialog. -.PP -Modeless dialogs are displayed using show(), which returns control to the caller immediately. -.SH "Default button" -A dialog's \fIdefault\fR button is the button that's pressed when the user presses Enter (Return). This button is used to signify that the user accepts the dialog's settings and wants to close the dialog. Use QPushButton::setDefault(), QPushButton::isDefault() and QPushButton::autoDefault() to set and control the dialog's default button. -.SH "Escape Key" -If the user presses the Esc key in a dialog, QDialog::reject() will be called. This will cause the window to close: the closeEvent cannot be ignored. -.SH "Extensibility" -Extensibility is the ability to show the dialog in two ways: a partial dialog that shows the most commonly used options, and a full dialog that shows all the options. Typically an extensible dialog will initially appear as a partial dialog, but with a" More" toggle button. If the user presses the "More" button down, the full dialog will appear. The extension widget will be resized to its sizeHint(). If orientation is Horizontal the extension widget's height() will be expanded to the height() of the dialog. If the orientation is Vertical the extension widget's width() will be expanded to the width() of the dialog. Extensibility is controlled with setExtension(), setOrientation() and showExtension(). -.SH "Return value (modal dialogs)" -Modal dialogs are often used in situations where a return value is required, e.g. to indicate whether the user pressed "OK" or" Cancel". A dialog can be closed by calling the accept() or the reject() slots, and exec() will return Accepted or Rejected as appropriate. The exec() call returns the result of the dialog. The result is also available from result() if the dialog has not been destroyed. If the WDestructiveClose flag is set, the dialog is deleted after exec() returns. -.SH "Examples" -A modal dialog. -.PP -.nf -.br - QFileDialog *dlg = new QFileDialog( workingDirectory, -.br - QString::null, 0, 0, TRUE ); -.br - dlg->setCaption( QFileDialog::tr( "Open" ) ); -.br - dlg->setMode( QFileDialog::ExistingFile ); -.br - QString result; -.br - if ( dlg->exec() == QDialog::Accepted ) { -.br - result = dlg->selectedFile(); -.br - workingDirectory = dlg->url(); -.br - } -.br - delete dlg; -.br - return result; -.fi -.PP -A modeless dialog. After the show() call, control returns to the main event loop. -.PP -.nf -.br - int main( int argc, char **argv ) -.br - { -.br - QApplication a( argc, argv ); -.fi -.PP -.nf -.br - int scale = 10; -.fi -.PP -.nf -.br - LifeDialog *life = new LifeDialog( scale ); -.br - a.setMainWidget( life ); -.br - life->setCaption("Qt Example - Life"); -.br - life->show(); -.fi -.PP -.nf -.br - return a.exec(); -.br - } -.fi -.PP -See also QTabDialog, QWidget, QProgressDialog, GUI Design Handbook: Dialogs, Standard, Abstract Widget Classes, and Dialog Classes. -.SS "Member Type Documentation" -.SH "QDialog::DialogCode" -The value returned by a modal dialog. -.TP -\fCQDialog::Accepted\fR -.TP -\fCQDialog::Rejected\fR -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "explicit QDialog::QDialog ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -Constructs a dialog called \fIname\fR, with parent \fIparent\fR. -.PP -A dialog is always a top-level widget, but if it has a parent, its default location is centered on top of the parent. It will also share the parent's taskbar entry. -.PP -The widget flags \fIf\fR are passed on to the QWidget constructor. If, for example, you don't want a What's This button in the titlebar of the dialog, pass WStyle_Customize | WStyle_NormalBorder | WStyle_Title | WStyle_SysMenu in \fIf\fR. -.PP -\fBWarning:\fR In Qt 3.2, the \fImodal\fR flag is obsolete. There is now a setModal() function that can be used for obtaining a modal behavior when calling show(). This is rarely needed, because modal dialogs are usually invoked using exec(), which ignores the \fImodal\fR flag. -.PP -See also QWidget::setWFlags() and Qt::WidgetFlags. -.SH "QDialog::~QDialog ()" -Destroys the QDialog, deleting all its children. -.SH "void QDialog::accept ()\fC [virtual protected slot]\fR" -Hides the modal dialog and sets the result code to Accepted. -.PP -See also reject() and done(). -.PP -Examples: -.)l chart/setdataform.cpp and distributor/distributor.ui.h. -.SH "void QDialog::done ( int r )\fC [virtual protected slot]\fR" -Closes the dialog and sets its result code to \fIr\fR. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return \fIr\fR. -.PP -As with QWidget::close(), done() deletes the dialog if the WDestructiveClose flag is set. If the dialog is the application's main widget, the application terminates. If the dialog is the last window closed, the QApplication::lastWindowClosed() signal is emitted. -.PP -See also accept(), reject(), QApplication::mainWidget(), and QApplication::quit(). -.SH "int QDialog::exec ()\fC [slot]\fR" -Shows the dialog as a modal dialog, blocking until the user closes it. The function returns a DialogCode result. -.PP -Users cannot interact with any other window in the same application until they close the dialog. -.PP -See also show() and result(). -.PP -Examples: -.)l chart/chartform.cpp, dialog/mainwindow.cpp, i18n/main.cpp, network/ftpclient/ftpmainwindow.ui.h, network/networkprotocol/view.cpp, qdir/qdir.cpp, and wizard/main.cpp. -.SH "QWidget * QDialog::extension () const" -Returns the dialog's extension or 0 if no extension has been defined. -.PP -See also setExtension(). -.SH "bool QDialog::isModal () const" -Returns TRUE if show() should pop up the dialog as modal or modeless; otherwise returns FALSE. See the "modal" property for details. -.SH "bool QDialog::isSizeGripEnabled () const" -Returns TRUE if the size grip is enabled; otherwise returns FALSE. See the "sizeGripEnabled" property for details. -.SH "Orientation QDialog::orientation () const" -Returns the dialog's extension orientation. -.PP -See also setOrientation(). -.SH "void QDialog::reject ()\fC [virtual protected slot]\fR" -Hides the modal dialog and sets the result code to Rejected. -.PP -See also accept() and done(). -.SH "int QDialog::result () const" -Returns the modal dialog's result code, Accepted or Rejected. -.PP -Do not call this function if the dialog was constructed with the WDestructiveClose flag. -.SH "void QDialog::setExtension ( QWidget * extension )" -Sets the widget, \fIextension\fR, to be the dialog's extension, deleting any previous extension. The dialog takes ownership of the extension. Note that if 0 is passed any existing extension will be deleted. -.PP -This function must only be called while the dialog is hidden. -.PP -See also showExtension(), setOrientation(), and extension(). -.SH "void QDialog::setModal ( bool modal )" -Sets whether show() should pop up the dialog as modal or modeless to \fImodal\fR. See the "modal" property for details. -.SH "void QDialog::setOrientation ( Orientation orientation )" -If \fIorientation\fR is Horizontal, the extension will be displayed to the right of the dialog's main area. If \fIorientation\fR is Vertical, the extension will be displayed below the dialog's main area. -.PP -See also orientation() and setExtension(). -.SH "void QDialog::setResult ( int i )\fC [protected]\fR" -Sets the modal dialog's result code to \fIi\fR. -.SH "void QDialog::setSizeGripEnabled ( bool )" -Sets whether the size grip is enabled. See the "sizeGripEnabled" property for details. -.SH "void QDialog::show ()\fC [virtual]\fR" -Shows the dialog as a modeless dialog. Control returns immediately to the calling code. -.PP -The dialog will be modal or modeless according to the value of the modal property. -.PP -See also exec() and modal. -.PP -Examples: -.)l movies/main.cpp, regexptester/main.cpp, showimg/showimg.cpp, and sql/overview/form1/main.cpp. -.PP -Reimplemented from QWidget. -.SH "void QDialog::showExtension ( bool showIt )\fC [protected slot]\fR" -If \fIshowIt\fR is TRUE, the dialog's extension is shown; otherwise the extension is hidden. -.PP -This slot is usually connected to the QButton::toggled() signal of a QPushButton. -.PP -A dialog with a visible extension is not resizeable. -.PP -See also show(), setExtension(), and setOrientation(). -.SS "Property Documentation" -.SH "bool modal" -This property holds whether show() should pop up the dialog as modal or modeless. -.PP -By default, this property is false and show() pops up the dialog as modeless. -.PP -exec() ignores the value of this property and always pops up the dialog as modal. -.PP -See also show() and exec(). -.PP -Set this property's value with setModal() and get this property's value with isModal(). -.SH "bool sizeGripEnabled" -This property holds whether the size grip is enabled. -.PP -A QSizeGrip is placed in the bottom right corner of the dialog when this property is enabled. By default, the size grip is disabled. -.PP -Set this property's value with setSizeGripEnabled() and get this property's value with isSizeGripEnabled(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdict.3qt b/doc/man/man3/qdict.3qt deleted file mode 100644 index c8f9a4c05..000000000 --- a/doc/man/man3/qdict.3qt +++ /dev/null @@ -1,374 +0,0 @@ -'\" t -.TH QDict 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 -QDict \- Template class that provides a dictionary based on QString keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDict\fR ( int size = 17, bool caseSensitive = TRUE )" -.br -.ti -1c -.BI "\fBQDict\fR ( const QDict & dict )" -.br -.ti -1c -.BI "\fB~QDict\fR ()" -.br -.ti -1c -.BI "QDict & \fBoperator=\fR ( const QDict & dict )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "void \fBinsert\fR ( const QString & key, const type * item )" -.br -.ti -1c -.BI "void \fBreplace\fR ( const QString & key, const type * item )" -.br -.ti -1c -.BI "bool \fBremove\fR ( const QString & key )" -.br -.ti -1c -.BI "type * \fBtake\fR ( const QString & key )" -.br -.ti -1c -.BI "type * \fBfind\fR ( const QString & key ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "void \fBresize\fR ( uint newsize )" -.br -.ti -1c -.BI "void \fBstatistics\fR () const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" -.br -.in -1c -.SH DESCRIPTION -The QDict class is a template class that provides a dictionary based on QString keys. -.PP -QMap is an STL-compatible alternative to this class. -.PP -QDict is implemented as a template class. Define a template instance QDict to create a dictionary that operates on pointers to X (X *). -.PP -A dictionary is a collection of key-value pairs. The key is a QString used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. -.PP -If you want to use non-Unicode, plain 8-bit \fCchar*\fR keys, use the QAsciiDict template. A QDict has the same performance as a QAsciiDict. If you want to have a dictionary that maps QStrings to QStrings use QMap. -.PP -The size() of the dictionary is very important. In order to get good performance, you should use a suitably large prime number. Suitable means equal to or larger than the maximum expected number of dictionary items. Size is set in the constructor but may be changed with resize(). -.PP -Items are inserted with insert(); 0 pointers cannot be inserted. Items are removed with remove(). All the items in a dictionary can be removed with clear(). The number of items in the dictionary is returned by count(). If the dictionary contains no items isEmpty() returns TRUE. You can change an item's value with replace(). Items are looked up with operator[](), or with find() which return a pointer to the value or 0 if the given key does not exist. You can take an item out of the dictionary with take(). -.PP -Calling setAutoDelete(TRUE) for a dictionary tells it to delete items that are removed. The default behaviour is not to delete items when they are removed. -.PP -When an item is inserted, the key is converted (hashed) to an integer index into an internal hash array. This makes lookup very fast. -.PP -Items with equal keys are allowed. When inserting two items with the same key, only the last inserted item will be accessible (last in, first out) until it is removed. -.PP -The QDictIterator class can traverse the dictionary, but only in an arbitrary order. Multiple iterators may independently traverse the same dictionary. -.PP -When inserting an item into a dictionary, only the pointer is copied, not the item itself, i.e. a shallow copy is made. It is possible to make the dictionary copy all of the item's data (a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a dictionary and reimplement newItem() if you want deep copies. -.PP -When removing a dictionary item, the virtual function QPtrCollection::deleteItem() is called. QDict's default implementation is to delete the item if auto-deletion is enabled. -.PP -Example #1: -.PP -.nf -.br - QDict fields; // QString keys, QLineEdit* values -.br - fields.insert( "forename", new QLineEdit( this ) ); -.br - fields.insert( "surname", new QLineEdit( this ) ); -.br -.br - fields["forename"]->setText( "Homer" ); -.br - fields["surname"]->setText( "Simpson" ); -.br -.br - QDictIterator it( fields ); // See QDictIterator -.br - for( ; it.current(); ++it ) -.br - cout << it.currentKey() << ": " << it.current()->text() << endl; -.br - cout << endl; -.br -.br - if ( fields["forename"] && fields["surname"] ) -.br - cout << fields["forename"]->text() << " " -.br -.br - << fields["surname"]->text() << endl; // Prints "Homer Simpson" -.br -.br - fields.remove( "forename" ); // Does not delete the line edit -.br - if ( ! fields["forename"] ) -.br - cout << "forename is not in the dictionary" << endl; -.br -.fi -In this example we use a dictionary to keep track of the line edits we're using. We insert each line edit into the dictionary with a unique name and then access the line edits via the dictionary. -.PP -Example #2: -.PP -.nf -.br - QStringList styleList = QStyleFactory::styles(); -.br - styleList.sort(); -.br - QDict letterDict( 17, FALSE ); -.br - for ( QStringList::Iterator it = styleList.begin(); it != styleList.end(); ++it ) { -.br - QString styleName = *it; -.br - QString styleAccel = styleName; -.br - if ( letterDict[styleAccel.left(1)] ) { -.br - for ( uint i = 0; i < styleAccel.length(); i++ ) { -.br - if ( ! letterDict[styleAccel.mid( i, 1 )] ) { -.br - styleAccel = styleAccel.insert( i, '&' ); -.br - letterDict.insert(styleAccel.mid( i, 1 ), (const int *)1); -.br - break; -.br - } -.br - } -.br - } else { -.br - styleAccel = "&" + styleAccel; -.br - letterDict.insert(styleAccel.left(1), (const int *)1); -.br - } -.br - (void) new QAction( styleName, QIconSet(), styleAccel, parent ); -.br - } -.br -.fi -In the example we are using the dictionary to provide fast random access to the keys, and we don't care what the values are. The example is used to generate a menu of QStyles, each with a unique accelerator key (or no accelerator if there are no unused letters left). -.PP -We first obtain the list of available styles, then sort them so that the menu items will be ordered alphabetically. Next we create a dictionary of int pointers. The keys in the dictionary are each one character long, representing letters that have been used for accelerators. We iterate through our list of style names. If the first letter of the style name is in the dictionary, i.e. has been used, we iterate over all the characters in the style name to see if we can find a letter that hasn't been used. If we find an unused letter we put the accelerator ampersand (&) in front of it and add that letter to the dictionary. If we can't find an unused letter the style will simply have no accelerator. If the first letter of the style name is not in the dictionary we use it for the accelerator and add it to the dictionary. Finally we create a QAction for each style. -.PP -See also QDictIterator, QAsciiDict, QIntDict, QPtrDict, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDict::QDict ( int size = 17, bool caseSensitive = TRUE )" -Constructs a dictionary optimized for less than \fIsize\fR entries. -.PP -We recommend setting \fIsize\fR to a suitably large prime number (e.g. a prime that's slightly larger than the expected number of entries). This makes the hash distribution better which will lead to faster lookup. -.PP -If \fIcaseSensitive\fR is TRUE (the default), keys which differ only by case are considered different. -.SH "QDict::QDict ( const QDict & dict )" -Constructs a copy of \fIdict\fR. -.PP -Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). -.SH "QDict::~QDict ()" -Removes all items from the dictionary and destroys it. If setAutoDelete() is TRUE, each value is deleted. All iterators that access this dictionary will be reset. -.PP -See also setAutoDelete(). -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QDict::clear ()\fC [virtual]\fR" -Removes all items from the dictionary. -.PP -The removed items are deleted if auto-deletion is enabled. -.PP -All dictionary iterators that operate on the dictionary are reset. -.PP -See also remove(), take(), and setAutoDelete(). -.PP -Reimplemented from QPtrCollection. -.SH "uint QDict::count () const\fC [virtual]\fR" -Returns the number of items in the dictionary. -.PP -See also isEmpty(). -.PP -Reimplemented from QPtrCollection. -.SH "type * QDict::find ( const QString & key ) const" -Returns the item with key \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be found. -.PP -Equivalent to the [] operator. -.PP -See also operator[](). -.SH "void QDict::insert ( const QString & key, const type * item )" -Inserts the key \fIkey\fR with value \fIitem\fR into the dictionary. -.PP -Multiple items can have the same key, in which case only the last item will be accessible using operator[](). -.PP -\fIitem\fR may not be 0. -.PP -See also replace(). -.PP -Example: themes/themes.cpp. -.SH "bool QDict::isEmpty () const" -Returns TRUE if the dictionary is empty, i.e. count() == 0; otherwise returns FALSE. -.PP -See also count(). -.SH "QDict & QDict::operator= ( const QDict & dict )" -Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. -.PP -This dictionary is first cleared, then each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy), unless newItem() has been reimplemented. -.SH "type * QDict::operator[] ( const QString & key ) const" -Returns the item with key \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be found. -.PP -Equivalent to the find() function. -.PP -See also find(). -.SH "QDataStream & QDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QDict::remove ( const QString & key )" -Removes the item with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if the item is in the dictionary; otherwise returns FALSE. -.PP -If there are two or more items with equal keys, then the last item that was inserted will be removed. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary's traversal order. -.PP -See also take(), clear(), and setAutoDelete(). -.SH "void QDict::replace ( const QString & key, const type * item )" -Replaces the value of the key, \fIkey\fR with \fIitem\fR. -.PP -If the item does not already exist, it will be inserted. -.PP -\fIitem\fR may not be 0. -.PP -Equivalent to: -.PP -.nf -.br - QDict dict; -.br - ... -.br - if ( dict.find( key ) ) -.br - dict.remove( key ); -.br - dict.insert( key, item ); -.br -.fi -.PP -If there are two or more items with equal keys, then the last item that was inserted will be replaced. -.PP -See also insert(). -.SH "void QDict::resize ( uint newsize )" -Changes the size of the hash table to \fInewsize\fR. The contents of the dictionary are preserved, but all iterators on the dictionary become invalid. -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. -.SH "uint QDict::size () const" -Returns the size of the internal hash array (as specified in the constructor). -.PP -See also count(). -.SH "void QDict::statistics () const" -Debugging-only function that prints out the dictionary distribution using tqDebug(). -.SH "type * QDict::take ( const QString & key )" -Takes the item with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). -.PP -If there are two or more items with equal keys, then the last item that was inserted will be taken. -.PP -Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. -.PP -All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary traversal order. -.PP -See also remove(), clear(), and setAutoDelete(). -.SH "QDataStream & QDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" -Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdict.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdict.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdictiterator.3qt b/doc/man/man3/qdictiterator.3qt deleted file mode 100644 index d4838ee9c..000000000 --- a/doc/man/man3/qdictiterator.3qt +++ /dev/null @@ -1,153 +0,0 @@ -'\" t -.TH QDictIterator 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 -QDictIterator \- Iterator for QDict collections -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDictIterator\fR ( const QDict & dict )" -.br -.ti -1c -.BI "\fB~QDictIterator\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "QString \fBcurrentKey\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QDictIterator class provides an iterator for QDict collections. -.PP -QDictIterator is implemented as a template class. Define a template instance QDictIterator to create a dictionary iterator that operates on QDict (dictionary of X*). -.PP -The traversal order is arbitrary; when we speak of the "first"," last" and "next" item we are talking in terms of this arbitrary order. -.PP -Multiple iterators may independently traverse the same dictionary. A QDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QDict updates all iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order. -.PP -Example: -.PP -.nf -.br - QDict fields; -.br - fields.insert( "forename", new QLineEdit( this ) ); -.br - fields.insert( "surname", new QLineEdit( this ) ); -.br - fields.insert( "age", new QLineEdit( this ) ); -.br -.br - fields["forename"]->setText( "Homer" ); -.br - fields["surname"]->setText( "Simpson" ); -.br - fields["age"]->setText( "45" ); -.br -.br - QDictIterator it( fields ); -.br - for( ; it.current(); ++it ) -.br - cout << it.currentKey() << ": " << it.current()->text() << endl; -.br - cout << endl; -.br -.br - // Output (random order): -.br - // age: 45 -.br - // surname: Simpson -.br - // forename: Homer -.br -.fi -In the example we insert some pointers to line edits into a dictionary, then iterate over the dictionary printing the strings associated with the line edits. -.PP -See also QDict, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDictIterator::QDictIterator ( const QDict & dict )" -Constructs an iterator for \fIdict\fR. The current iterator item is set to point to the first item in the dictionary, \fIdict\fR. First in this context means first in the arbitrary traversal order. -.SH "QDictIterator::~QDictIterator ()" -Destroys the iterator. -.SH "uint QDictIterator::count () const" -Returns the number of items in the dictionary over which the iterator is operating. -.PP -See also isEmpty(). -.SH "type * QDictIterator::current () const" -Returns a pointer to the current iterator item's value. -.SH "QString QDictIterator::currentKey () const" -Returns the current iterator item's key. -.SH "bool QDictIterator::isEmpty () const" -Returns TRUE if the dictionary is empty, i.e. count() == 0; otherwise returns FALSE. -.PP -See also count(). -.SH "QDictIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QDictIterator::operator() ()" -Makes the next item current and returns the original current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QDictIterator::operator++ ()" -Prefix ++ makes the next item current and returns the new current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QDictIterator::toFirst ()" -Resets the iterator, making the first item the first current item. First in this context means first in the arbitrary traversal order. Returns a pointer to this item. -.PP -If the dictionary is empty it sets the current item to 0 and -returns 0. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdictiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdictiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdir.3qt b/doc/man/man3/qdir.3qt deleted file mode 100644 index 3ef6a07be..000000000 --- a/doc/man/man3/qdir.3qt +++ /dev/null @@ -1,807 +0,0 @@ -'\" t -.TH QDir 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 -QDir \- Access to directory structures and their contents in a platform-independent way -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBFilterSpec\fR { Dirs = 0x001, Files = 0x002, Drives = 0x004, NoSymLinks = 0x008, All = 0x007, TypeMask = 0x00F, Readable = 0x010, Writable = 0x020, Executable = 0x040, RWEMask = 0x070, Modified = 0x080, Hidden = 0x100, System = 0x200, AccessMask = 0x3F0, DefaultFilter = -1 }" -.br -.ti -1c -.BI "enum \fBSortSpec\fR { Name = 0x00, Time = 0x01, Size = 0x02, Unsorted = 0x03, SortByMask = 0x03, DirsFirst = 0x04, Reversed = 0x08, IgnoreCase = 0x10, LocaleAware = 0x20, DefaultSort = -1 }" -.br -.ti -1c -.BI "\fBQDir\fR ()" -.br -.ti -1c -.BI "\fBQDir\fR ( const QString & path, const QString & nameFilter = QString::null, int sortSpec = Name | IgnoreCase, int filterSpec = All )" -.br -.ti -1c -.BI "\fBQDir\fR ( const QDir & d )" -.br -.ti -1c -.BI "virtual \fB~QDir\fR ()" -.br -.ti -1c -.BI "QDir & \fBoperator=\fR ( const QDir & d )" -.br -.ti -1c -.BI "QDir & \fBoperator=\fR ( const QString & path )" -.br -.ti -1c -.BI "virtual void \fBsetPath\fR ( const QString & path )" -.br -.ti -1c -.BI "virtual QString \fBpath\fR () const" -.br -.ti -1c -.BI "virtual QString \fBabsPath\fR () const" -.br -.ti -1c -.BI "virtual QString \fBcanonicalPath\fR () const" -.br -.ti -1c -.BI "virtual QString \fBdirName\fR () const" -.br -.ti -1c -.BI "virtual QString \fBfilePath\fR ( const QString & fileName, bool acceptAbsPath = TRUE ) const" -.br -.ti -1c -.BI "virtual QString \fBabsFilePath\fR ( const QString & fileName, bool acceptAbsPath = TRUE ) const" -.br -.ti -1c -.BI "virtual bool \fBcd\fR ( const QString & dirName, bool acceptAbsPath = TRUE )" -.br -.ti -1c -.BI "virtual bool \fBcdUp\fR ()" -.br -.ti -1c -.BI "QString \fBnameFilter\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNameFilter\fR ( const QString & nameFilter )" -.br -.ti -1c -.BI "FilterSpec \fBfilter\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFilter\fR ( int filterSpec )" -.br -.ti -1c -.BI "SortSpec \fBsorting\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSorting\fR ( int sortSpec )" -.br -.ti -1c -.BI "bool \fBmatchAllDirs\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMatchAllDirs\fR ( bool enable )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "QString \fBoperator[]\fR ( int index ) const" -.br -.ti -1c -.BI "virtual QStrList encodedEntryList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual QStrList encodedEntryList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual QStringList \fBentryList\fR ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" -.br -.ti -1c -.BI "virtual QStringList \fBentryList\fR ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" -.br -.ti -1c -.BI "virtual const QFileInfoList * \fBentryInfoList\fR ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" -.br -.ti -1c -.BI "virtual const QFileInfoList * \fBentryInfoList\fR ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" -.br -.ti -1c -.BI "virtual bool \fBmkdir\fR ( const QString & dirName, bool acceptAbsPath = TRUE ) const" -.br -.ti -1c -.BI "virtual bool \fBrmdir\fR ( const QString & dirName, bool acceptAbsPath = TRUE ) const" -.br -.ti -1c -.BI "virtual bool \fBisReadable\fR () const" -.br -.ti -1c -.BI "virtual bool \fBexists\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisRoot\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisRelative\fR () const" -.br -.ti -1c -.BI "virtual void \fBconvertToAbs\fR ()" -.br -.ti -1c -.BI "virtual bool \fBoperator==\fR ( const QDir & d ) const" -.br -.ti -1c -.BI "virtual bool \fBoperator!=\fR ( const QDir & d ) const" -.br -.ti -1c -.BI "virtual bool \fBremove\fR ( const QString & fileName, bool acceptAbsPath = TRUE )" -.br -.ti -1c -.BI "virtual bool \fBrename\fR ( const QString & oldName, const QString & newName, bool acceptAbsPaths = TRUE )" -.br -.ti -1c -.BI "virtual bool \fBexists\fR ( const QString & name, bool acceptAbsPath = TRUE )" -.br -.ti -1c -.BI "void \fBrefresh\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBconvertSeparators\fR ( const QString & pathName )" -.br -.ti -1c -.BI "const QFileInfoList * \fBdrives\fR ()" -.br -.ti -1c -.BI "char \fBseparator\fR ()" -.br -.ti -1c -.BI "bool \fBsetCurrent\fR ( const QString & path )" -.br -.ti -1c -.BI "QDir \fBcurrent\fR ()" -.br -.ti -1c -.BI "QDir \fBhome\fR ()" -.br -.ti -1c -.BI "QDir \fBroot\fR ()" -.br -.ti -1c -.BI "QString \fBcurrentDirPath\fR ()" -.br -.ti -1c -.BI "QString \fBhomeDirPath\fR ()" -.br -.ti -1c -.BI "QString \fBrootDirPath\fR ()" -.br -.ti -1c -.BI "bool \fBmatch\fR ( const QStringList & filters, const QString & fileName )" -.br -.ti -1c -.BI "bool \fBmatch\fR ( const QString & filter, const QString & fileName )" -.br -.ti -1c -.BI "QString \fBcleanDirPath\fR ( const QString & filePath )" -.br -.ti -1c -.BI "bool \fBisRelativePath\fR ( const QString & path )" -.br -.in -1c -.SH DESCRIPTION -The QDir class provides access to directory structures and their contents in a platform-independent way. -.PP -A QDir is used to manipulate path names, access information regarding paths and files, and manipulate the underlying file system. -.PP -A QDir can point to a file using either a relative or an absolute path. Absolute paths begin with the directory separator "/" (optionally preceded by a drive specification under Windows). If you always use "/" as a directory separator, Qt will translate your paths to conform to the underlying operating system. Relative file names begin with a directory name or a file name and specify a path relative to the current directory. -.PP -The "current" path refers to the application's working directory. A QDir's own path is set and retrieved with setPath() and path(). -.PP -An example of an absolute path is the string "/tmp/quartz", a relative path might look like "src/fatlib". You can use the function isRelative() to check if a QDir is using a relative or an absolute file path. Call convertToAbs() to convert a relative QDir to an absolute one. For a simplified path use cleanDirPath(). To obtain a path which has no symbolic links or redundant ".." elements use canonicalPath(). The path can be set with setPath(), and changed with cd() and cdUp(). -.PP -QDir provides several static functions, for example, setCurrent() to set the application's working directory and currentDirPath() to retrieve the application's working directory. Access to some common paths is provided with the static functions, current(), home() and root() which return QDir objects or currentDirPath(), homeDirPath() and rootDirPath() which return the path as a string. If you want to know about your application's path use QApplication::applicationDirPath(). -.PP -The number of entries in a directory is returned by count(). Obtain a string list of the names of all the files and directories in a directory with entryList(). If you prefer a list of QFileInfo pointers use entryInfoList(). Both these functions can apply a name filter, an attributes filter (e.g. read-only, files not directories, etc.), and a sort order. The filters and sort may be set with calls to setNameFilter(), setFilter() and setSorting(). They may also be specified in the entryList() and entryInfoList()'s arguments. -.PP -Create a new directory with mkdir(), rename a directory with rename() and remove an existing directory with rmdir(). Remove a file with remove(). You can interrogate a directory with exists(), isReadable() and isRoot(). -.PP -To get a path with a filename use filePath(), and to get a directory name use dirName(); neither of these functions checks for the existence of the file or directory. -.PP -The list of root directories is provided by drives(); on Unix systems this returns a list containing one root directory, "/"; on Windows the list will usually contain "C:/", and possibly "D:/", etc. -.PP -It is easiest to work with "/" separators in Qt code. If you need to present a path to the user or need a path in a form suitable for a function in the underlying operating system use convertSeparators(). -.PP -Examples: -.)l -.PP -See if a directory exists. -.PP -.nf -.br - QDir d( "example" ); // "./example" -.br - if ( !d.exists() ) -.br - tqWarning( "Cannot find the example directory" ); -.br -.fi -.PP -Traversing directories and reading a file. -.PP -.nf -.br - QDir d = QDir::root(); // "/" -.br - if ( !d.cd("tmp") ) { // "/tmp" -.br - tqWarning( "Cannot find the \\"/tmp\\" directory" ); -.br - } else { -.br - QFile f( d.filePath("ex1.txt") ); // "/tmp/ex1.txt" -.br - if ( !f.open(IO_ReadWrite) ) -.br - tqWarning( "Cannot create the file %s", f.name() ); -.br - } -.br -.fi -.PP -A program that lists all the files in the current directory (excluding symbolic links), sorted by size, smallest first: -.PP -.nf -.br - #include -.br - #include -.br -.br - int main( int argc, char **argv ) -.br - { -.br - QDir d; -.br - d.setFilter( QDir::Files | QDir::Hidden | QDir::NoSymLinks ); -.br - d.setSorting( QDir::Size | QDir::Reversed ); -.br -.br - const QFileInfoList *list = d.entryInfoList(); -.br - QFileInfoListIterator it( *list ); -.br - QFileInfo *fi; -.br -.br - printf( " Bytes Filename\\n" ); -.br - while ( (fi = it.current()) != 0 ) { -.br - printf( "%10li %s\\n", fi->size(), fi->fileName().latin1() ); -.br - ++it; -.br - } -.br - return 0; -.br - } -.br -.fi -.PP -See also QApplication::applicationDirPath() and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QDir::FilterSpec" -This enum describes the filtering options available to QDir, e.g. for entryList() and entryInfoList(). The filter value is specified by OR-ing together values from the following list: -.TP -\fCQDir::Dirs\fR - List directories only. -.TP -\fCQDir::Files\fR - List files only. -.TP -\fCQDir::Drives\fR - List disk drives (ignored under Unix). -.TP -\fCQDir::NoSymLinks\fR - Do not list symbolic links (ignored by operating systems that don't support symbolic links). -.TP -\fCQDir::All\fR - List directories, files, drives and symlinks (this does not list broken symlinks unless you specify System). -.TP -\fCQDir::TypeMask\fR - A mask for the the Dirs, Files, Drives and NoSymLinks flags. -.TP -\fCQDir::Readable\fR - List files for which the application has read access. -.TP -\fCQDir::Writable\fR - List files for which the application has write access. -.TP -\fCQDir::Executable\fR - List files for which the application has execute access. Executables needs to be combined with Dirs or Files. -.TP -\fCQDir::RWEMask\fR - A mask for the Readable, Writable and Executable flags. -.TP -\fCQDir::Modified\fR - Only list files that have been modified (ignored under Unix). -.TP -\fCQDir::Hidden\fR - List hidden files (on Unix, files starting with a .). -.TP -\fCQDir::System\fR - List system files (on Unix, FIFOs, sockets and device files) -.TP -\fCQDir::AccessMask\fR - A mask for the Readable, Writable, Executable Modified, Hidden and System flags -.TP -\fCQDir::DefaultFilter\fR - Internal flag. -.PP -If you do not set any of Readable, Writable or Executable, QDir will set all three of them. This makes the default easy to write and at the same time useful. -.PP -Examples: -.)l \fCReadable|Writable\fR means list all files for which the -application has read access, write access or both. \fCDirs|Drives\fR means list drives, directories, all files that the application can read, write or execute, and also symlinks to such files/directories. -.SH "QDir::SortSpec" -This enum describes the sort options available to QDir, e.g. for entryList() and entryInfoList(). The sort value is specified by OR-ing together values from the following list: -.TP -\fCQDir::Name\fR - Sort by name. -.TP -\fCQDir::Time\fR - Sort by time (modification time). -.TP -\fCQDir::Size\fR - Sort by file size. -.TP -\fCQDir::Unsorted\fR - Do not sort. -.TP -\fCQDir::SortByMask\fR - A mask for Name, Time and Size. -.TP -\fCQDir::DirsFirst\fR - Put the directories first, then the files. -.TP -\fCQDir::Reversed\fR - Reverse the sort order. -.TP -\fCQDir::IgnoreCase\fR - Sort case-insensitively. -.TP -\fCQDir::LocaleAware\fR - Sort names using locale aware compares -.TP -\fCQDir::DefaultSort\fR - Internal flag. -.PP -You can only specify one of the first four. -.PP -If you specify both DirsFirst and Reversed, directories are still put first, but in reverse order; the files will be listed after the directories, again in reverse order. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDir::QDir ()" -Constructs a QDir pointing to the current directory ("."). -.PP -See also currentDirPath(). -.SH "QDir::QDir ( const QString & path, const QString & nameFilter = QString::null, int sortSpec = Name | IgnoreCase, int filterSpec = All )" -Constructs a QDir with path \fIpath\fR, that filters its entries by name using \fInameFilter\fR and by attributes using \fIfilterSpec\fR. It also sorts the names using \fIsortSpec\fR. -.PP -The default \fInameFilter\fR is an empty string, which excludes nothing; the default \fIfilterSpec\fR is All, which also means exclude nothing. The default \fIsortSpec\fR is \fCName|IgnoreCase\fR, i.e. sort by name case-insensitively. -.PP -Example that lists all the files in "/tmp": -.PP -.nf -.br - QDir d( "/tmp" ); -.br - for ( int i = 0; i < d.count(); i++ ) -.br - printf( "%s\\n", d[i] ); -.br -.fi -.PP -If \fIpath\fR is "" or QString::null, QDir uses "." (the current directory). If \fInameFilter\fR is "" or QString::null, QDir uses the name filter "*" (all files). -.PP -Note that \fIpath\fR need not exist. -.PP -See also exists(), setPath(), setNameFilter(), setFilter(), and setSorting(). -.SH "QDir::QDir ( const QDir & d )" -Constructs a QDir that is a copy of the directory \fId\fR. -.PP -See also operator=(). -.SH "QDir::~QDir ()\fC [virtual]\fR" -Destroys the QDir frees up its resources. -.SH "QString QDir::absFilePath ( const QString & fileName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" -Returns the absolute path name of a file in the directory. Does \fInot\fR check if the file actually exists in the directory. Redundant multiple separators or "." and ".." directories in \fIfileName\fR will not be removed (see cleanDirPath()). -.PP -If \fIacceptAbsPath\fR is TRUE a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is FALSE an absolute path will be prepended to the fileName and the resultant string returned. -.PP -See also filePath(). -.SH "QString QDir::absPath () const\fC [virtual]\fR" -Returns the absolute path (a path that starts with "/" or with a drive specification), which may contain symbolic links, but never contains redundant ".", ".." or multiple separators. -.PP -See also setPath(), canonicalPath(), exists(), cleanDirPath(), dirName(), and absFilePath(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QString QDir::canonicalPath () const\fC [virtual]\fR" -Returns the canonical path, i.e. a path without symbolic links or redundant "." or ".." elements. -.PP -On systems that do not have symbolic links this function will always return the same string that absPath() returns. If the canonical path does not exist (normally due to dangling symbolic links) canonicalPath() returns QString::null. -.PP -See also path(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), and QString::isNull(). -.SH "bool QDir::cd ( const QString & dirName, bool acceptAbsPath = TRUE )\fC [virtual]\fR" -Changes the QDir's directory to \fIdirName\fR. -.PP -If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will cause the function to change to the absolute directory. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed and the function will descend into \fIdirName\fR. -.PP -Returns TRUE if the new directory exists and is readable; otherwise returns FALSE. Note that the logical cd() operation is not performed if the new directory does not exist. -.PP -Calling cd( ".." ) is equivalent to calling cdUp(). -.PP -See also cdUp(), isReadable(), exists(), and path(). -.PP -Example: fileiconview/mainwindow.cpp. -.SH "bool QDir::cdUp ()\fC [virtual]\fR" -Changes directory by moving one directory up from the QDir's current directory. -.PP -Returns TRUE if the new directory exists and is readable; otherwise returns FALSE. Note that the logical cdUp() operation is not performed if the new directory does not exist. -.PP -See also cd(), isReadable(), exists(), and path(). -.SH "QString QDir::cleanDirPath ( const QString & filePath )\fC [static]\fR" -Removes all multiple directory separators "/" and resolves any" -."s or ".."s found in the path, \fIfilePath\fR. -.PP -Symbolic links are kept. This function does not return the canonical path, but rather the simplest version of the input. For example, "./local" becomes "local", "local/../bin" becomes" bin" and "/local/usr/../bin" becomes "/local/bin". -.PP -See also absPath() and canonicalPath(). -.SH "QString QDir::convertSeparators ( const QString & pathName )\fC [static]\fR" -Returns \fIpathName\fR with the '/' separators converted to separators that are appropriate for the underlying operating system. -.PP -On Windows, convertSeparators("c:/winnt/system32") returns" c:\\winnt\\system32". -.PP -The returned string may be the same as the argument on some operating systems, for example on Unix. -.PP -Examples: -.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. -.SH "void QDir::convertToAbs ()\fC [virtual]\fR" -Converts the directory path to an absolute path. If it is already absolute nothing is done. -.PP -See also isRelative(). -.SH "uint QDir::count () const" -Returns the total number of directories and files that were found. -.PP -Equivalent to entryList().count(). -.PP -See also operator[]() and entryList(). -.SH "QDir QDir::current ()\fC [static]\fR" -Returns the application's current directory. -.PP -Use path() to access a QDir object's path. -.PP -See also currentDirPath() and QDir::QDir(). -.SH "QString QDir::currentDirPath ()\fC [static]\fR" -Returns the absolute path of the application's current directory. -.PP -See also current(). -.PP -Examples: -.)l dirview/dirview.cpp, helpviewer/helpwindow.cpp, and qdir/qdir.cpp. -.SH "QString QDir::dirName () const\fC [virtual]\fR" -Returns the name of the directory; this is \fInot\fR the same as the path, e.g. a directory with the name "mail", might have the path" /var/spool/mail". If the directory has no name (e.g. it is the root directory) QString::null is returned. -.PP -No check is made to ensure that a directory with this name actually exists. -.PP -See also path(), absPath(), absFilePath(), exists(), and QString::isNull(). -.SH "const QFileInfoList * QDir::drives ()\fC [static]\fR" -Returns a list of the root directories on this system. On Windows this returns a number of QFileInfo objects containing "C:/", "D:/" etc. On other operating systems, it returns a list containing just one root directory (e.g. "/"). -.PP -The returned pointer is owned by Qt. Callers should \fInot\fR delete or modify it. -.PP -Example: dirview/main.cpp. -.SH "QStrList QDir::encodedEntryList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function is included to easy porting from Qt 1.x to Qt 2.0, it is the same as entryList(), but encodes the filenames as 8-bit strings using QFile::encodedName(). -.PP -It is more efficient to use entryList(). -.SH "QStrList QDir::encodedEntryList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function is included to easy porting from Qt 1.x to Qt 2.0, it is the same as entryList(), but encodes the filenames as 8-bit strings using QFile::encodedName(). -.PP -It is more efficient to use entryList(). -.SH "const QFileInfoList * QDir::entryInfoList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" -Returns a list of QFileInfo objects for all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). -.PP -The filter and sorting specifications can be overridden using the \fInameFilter\fR, \fIfilterSpec\fR and \fIsortSpec\fR arguments. -.PP -Returns 0 if the directory is unreadable or does not exist. -.PP -The returned pointer is a const pointer to a QFileInfoList. The list is owned by the QDir object and will be reused on the next call to entryInfoList() for the same QDir instance. If you want to keep the entries of the list after a subsequent call to this function you must copy them. -.PP -Note: QFileInfoList is really a QPtrList. -.PP -See also entryList(), setNameFilter(), setSorting(), and setFilter(). -.PP -Examples: -.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. -.SH "const QFileInfoList * QDir::entryInfoList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a list of QFileInfo objects for all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). -.PP -The filter and sorting specifications can be overridden using the \fIfilterSpec\fR and \fIsortSpec\fR arguments. -.PP -Returns 0 if the directory is unreadable or does not exist. -.PP -The returned pointer is a const pointer to a QFileInfoList. The list is owned by the QDir object and will be reused on the next call to entryInfoList() for the same QDir instance. If you want to keep the entries of the list after a subsequent call to this function you must copy them. -.PP -Note: QFileInfoList is really a QPtrList. -.PP -See also entryList(), setNameFilter(), setSorting(), and setFilter(). -.SH "QStringList QDir::entryList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" -Returns a list of the names of all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). -.PP -The filter and sorting specifications can be overridden using the \fInameFilter\fR, \fIfilterSpec\fR and \fIsortSpec\fR arguments. -.PP -Returns an empty list if the directory is unreadable or does not exist. -.PP -See also entryInfoList(), setNameFilter(), setSorting(), and setFilter(). -.PP -Example: table/statistics/statistics.cpp. -.SH "QStringList QDir::entryList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a list of the names of all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). -.PP -The filter and sorting specifications can be overridden using the \fIfilterSpec\fR and \fIsortSpec\fR arguments. -.PP -Returns an empty list if the directory is unreadable or does not exist. -.PP -See also entryInfoList(), setNameFilter(), setSorting(), and setFilter(). -.SH "bool QDir::exists ( const QString & name, bool acceptAbsPath = TRUE )\fC [virtual]\fR" -Checks for the existence of the file \fIname\fR. -.PP -If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will check the file with the absolute path. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIname\fR will be removed and the resultant file name will be checked. -.PP -Returns TRUE if the file exists; otherwise returns FALSE. -.PP -See also QFileInfo::exists() and QFile::exists(). -.SH "bool QDir::exists () const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the \fIdirectory\fR exists; otherwise returns FALSE. (If a file with the same name is found this function will return FALSE). -.PP -See also QFileInfo::exists() and QFile::exists(). -.SH "QString QDir::filePath ( const QString & fileName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" -Returns the path name of a file in the directory. Does \fInot\fR check if the file actually exists in the directory. If the QDir is relative the returned path name will also be relative. Redundant multiple separators or "." and ".." directories in \fIfileName\fR will not be removed (see cleanDirPath()). -.PP -If \fIacceptAbsPath\fR is TRUE a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is FALSE an absolute path will be prepended to the fileName and the resultant string returned. -.PP -See also absFilePath(), isRelative(), and canonicalPath(). -.SH "FilterSpec QDir::filter () const" -Returns the value set by setFilter() -.SH "QDir QDir::home ()\fC [static]\fR" -Returns the home directory. -.PP -Under Windows the \fCHOME\fR environment variable is used. If this does not exist the \fCUSERPROFILE\fR environment variable is used. If that does not exist the path is formed by concatenating the \fCHOMEDRIVE\fR and \fCHOMEPATH\fR environment variables. If they don't exist the rootDirPath() is used (this uses the \fCSystemDrive\fR environment variable). If none of these exist "C:\" is used. -.PP -Under non-Windows operating systems the \fCHOME\fR environment variable is used if it exists, otherwise rootDirPath() is used. -.PP -See also homeDirPath(). -.SH "QString QDir::homeDirPath ()\fC [static]\fR" -Returns the absolute path of the user's home directory. -.PP -See also home(). -.SH "bool QDir::isReadable () const\fC [virtual]\fR" -Returns TRUE if the directory is readable \fIand\fR we can open files by name; otherwise returns FALSE. -.PP -\fBWarning:\fR A FALSE value from this function is not a guarantee that files in the directory are not accessible. -.PP -See also QFileInfo::isReadable(). -.PP -Examples: -.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. -.SH "bool QDir::isRelative () const\fC [virtual]\fR" -Returns TRUE if the directory path is relative to the current directory and returns FALSE if the path is absolute (e.g. under UNIX a path is relative if it does not start with a "/"). -.PP -See also convertToAbs(). -.SH "bool QDir::isRelativePath ( const QString & path )\fC [static]\fR" -Returns TRUE if \fIpath\fR is relative; returns FALSE if it is absolute. -.PP -See also isRelative(). -.SH "bool QDir::isRoot () const\fC [virtual]\fR" -Returns TRUE if the directory is the root directory; otherwise returns FALSE. -.PP -Note: If the directory is a symbolic link to the root directory this function returns FALSE. If you want to test for this use canonicalPath(), e.g. -.PP -.nf -.br - QDir d( "/tmp/root_link" ); -.br - d = d.canonicalPath(); -.br - if ( d.isRoot() ) -.br - tqWarning( "It is a root link" ); -.br -.fi -.PP -See also root() and rootDirPath(). -.SH "bool QDir::match ( const QString & filter, const QString & fileName )\fC [static]\fR" -Returns TRUE if the \fIfileName\fR matches the wildcard (glob) pattern \fIfilter\fR; otherwise returns FALSE. The \fIfilter\fR may contain multiple patterns separated by spaces or semicolons. -.PP -(See QRegExp wildcard matching.) -.PP -See also QRegExp::match(). -.SH "bool QDir::match ( const QStringList & filters, const QString & fileName )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the \fIfileName\fR matches any of the wildcard (glob) patterns in the list of \fIfilters\fR; otherwise returns FALSE. -.PP -(See QRegExp wildcard matching.) -.PP -See also QRegExp::match(). -.SH "bool QDir::matchAllDirs () const" -Returns the value set by setMatchAllDirs() -.PP -See also setMatchAllDirs(). -.SH "bool QDir::mkdir ( const QString & dirName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" -Creates a directory. -.PP -If \fIacceptAbsPath\fR is TRUE a path starting with a separator ('/') will create the absolute directory; if \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed. -.PP -Returns TRUE if successful; otherwise returns FALSE. -.PP -See also rmdir(). -.SH "QString QDir::nameFilter () const" -Returns the string set by setNameFilter() -.SH "bool QDir::operator!= ( const QDir & d ) const\fC [virtual]\fR" -Returns TRUE if directory \fId\fR and this directory have different paths or different sort or filter settings; otherwise returns FALSE. -.PP -Example: -.PP -.nf -.br - // The current directory is "/usr/local" -.br - QDir d1( "/usr/local/bin" ); -.br - QDir d2( "bin" ); -.br - if ( d1 != d2 ) -.br - tqDebug( "They differ" ); -.br -.fi -.SH "QDir & QDir::operator= ( const QDir & d )" -Makes a copy of QDir \fId\fR and assigns it to this QDir. -.SH "QDir & QDir::operator= ( const QString & path )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the directory path to be the given \fIpath\fR. -.SH "bool QDir::operator== ( const QDir & d ) const\fC [virtual]\fR" -Returns TRUE if directory \fId\fR and this directory have the same path and their sort and filter settings are the same; otherwise returns FALSE. -.PP -Example: -.PP -.nf -.br - // The current directory is "/usr/local" -.br - QDir d1( "/usr/local/bin" ); -.br - QDir d2( "bin" ); -.br - d2.convertToAbs(); -.br - if ( d1 == d2 ) -.br - tqDebug( "They're the same" ); -.br -.fi -.SH "QString QDir::operator[] ( int index ) const" -Returns the file name at position \fIindex\fR in the list of file names. Equivalent to entryList().at(index). -.PP -Returns a QString::null if the \fIindex\fR is out of range or if the entryList() function failed. -.PP -See also count() and entryList(). -.SH "QString QDir::path () const\fC [virtual]\fR" -Returns the path, this may contain symbolic links, but never contains redundant ".", ".." or multiple separators. -.PP -The returned path can be either absolute or relative (see setPath()). -.PP -See also setPath(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), and convertSeparators(). -.SH "void QDir::refresh () const" -Refreshes the directory information. -.SH "bool QDir::remove ( const QString & fileName, bool acceptAbsPath = TRUE )\fC [virtual]\fR" -Removes the file, \fIfileName\fR. -.PP -If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will remove the file with the absolute path. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIfileName\fR will be removed and the resultant file name will be removed. -.PP -Returns TRUE if the file is removed successfully; otherwise returns FALSE. -.SH "bool QDir::rename ( const QString & oldName, const QString & newName, bool acceptAbsPaths = TRUE )\fC [virtual]\fR" -Renames a file or directory. -.PP -If \fIacceptAbsPaths\fR is TRUE a path starting with a separator ('/') will rename the file with the absolute path; if \fIacceptAbsPaths\fR is FALSE any number of separators at the beginning of the names will be removed. -.PP -Returns TRUE if successful; otherwise returns FALSE. -.PP -On most file systems, rename() fails only if \fIoldName\fR does not exist or if \fInewName\fR and \fIoldName\fR are not on the same partition. On Windows, rename() will fail if \fInewName\fR already exists. However, there are also other reasons why rename() can fail. For example, on at least one file system rename() fails if \fInewName\fR points to an open file. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QDir::rmdir ( const QString & dirName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" -Removes a directory. -.PP -If \fIacceptAbsPath\fR is TRUE a path starting with a separator ('/') will remove the absolute directory; if \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed. -.PP -The directory must be empty for rmdir() to succeed. -.PP -Returns TRUE if successful; otherwise returns FALSE. -.PP -See also mkdir(). -.SH "QDir QDir::root ()\fC [static]\fR" -Returns the root directory. -.PP -See also rootDirPath() and drives(). -.SH "QString QDir::rootDirPath ()\fC [static]\fR" -Returns the absolute path for the root directory. -.PP -For UNIX operating systems this returns "/". For Windows file systems this normally returns "c:/". -.PP -See also root() and drives(). -.SH "char QDir::separator ()\fC [static]\fR" -Returns the native directory separator; "/" under UNIX (including Mac OS X) and "\" under Windows. -.PP -You do not need to use this function to build file paths. If you always use "/", Qt will translate your paths to conform to the underlying operating system. -.SH "bool QDir::setCurrent ( const QString & path )\fC [static]\fR" -Sets the application's current working directory to \fIpath\fR. Returns TRUE if the directory was successfully changed; otherwise returns FALSE. -.SH "void QDir::setFilter ( int filterSpec )\fC [virtual]\fR" -Sets the filter used by entryList() and entryInfoList() to \fIfilterSpec\fR. The filter is used to specify the kind of files that should be returned by entryList() and entryInfoList(). See QDir::FilterSpec. -.PP -See also filter() and setNameFilter(). -.SH "void QDir::setMatchAllDirs ( bool enable )\fC [virtual]\fR" -If \fIenable\fR is TRUE then all directories are included (e.g. in entryList()), and the nameFilter() is only applied to the files. If \fIenable\fR is FALSE then the nameFilter() is applied to both directories and files. -.PP -See also matchAllDirs(). -.SH "void QDir::setNameFilter ( const QString & nameFilter )\fC [virtual]\fR" -Sets the name filter used by entryList() and entryInfoList() to \fInameFilter\fR. -.PP -The \fInameFilter\fR is a wildcard (globbing) filter that understands" *" and "?" wildcards. (See QRegExp wildcard matching.) You may specify several filter entries all separated by a single space " " or by a semi-colon" ;". -.PP -For example, if you want entryList() and entryInfoList() to list all files ending with either ".cpp" or ".h", you would use either dir.setNameFilter("*.cpp *.h") or dir.setNameFilter("*.cpp;*.h"). -.PP -See also nameFilter() and setFilter(). -.SH "void QDir::setPath ( const QString & path )\fC [virtual]\fR" -Sets the path of the directory to \fIpath\fR. The path is cleaned of redundant ".", ".." and of multiple separators. No check is made to ensure that a directory with this path exists. -.PP -The path can be either absolute or relative. Absolute paths begin with the directory separator "/" (optionally preceded by a drive specification under Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current directory. An example of an absolute path is the string" /tmp/quartz", a relative path might look like "src/fatlib". -.PP -See also path(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), isRelative(), and convertToAbs(). -.SH "void QDir::setSorting ( int sortSpec )\fC [virtual]\fR" -Sets the sort order used by entryList() and entryInfoList(). -.PP -The \fIsortSpec\fR is specified by OR-ing values from the enum QDir::SortSpec. -.PP -See also sorting() and SortSpec. -.SH "SortSpec QDir::sorting () const" -Returns the value set by setSorting() -.PP -See also setSorting() and SortSpec. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdir.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdir.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdirectpainter.3qt b/doc/man/man3/qdirectpainter.3qt deleted file mode 100644 index 8922d4374..000000000 --- a/doc/man/man3/qdirectpainter.3qt +++ /dev/null @@ -1,178 +0,0 @@ -'\" t -.TH QDirectPainter 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 -QDirectPainter \- Direct access to the video hardware -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPainter. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDirectPainter\fR ( const QWidget * w )" -.br -.ti -1c -.BI "\fB~QDirectPainter\fR ()" -.br -.ti -1c -.BI "uchar * \fBframeBuffer\fR ()" -.br -.ti -1c -.BI "int \fBlineStep\fR ()" -.br -.ti -1c -.BI "int \fBtransformOrientation\fR ()" -.br -.ti -1c -.BI "int \fBnumRects\fR () const" -.br -.ti -1c -.BI "const QRect & \fBrect\fR ( int i ) const" -.br -.ti -1c -.BI "QRegion \fBregion\fR () const" -.br -.ti -1c -.BI "int \fBdepth\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "int \fBxOffset\fR () const" -.br -.ti -1c -.BI "int \fByOffset\fR () const" -.br -.ti -1c -.BI "QPoint \fBoffset\fR () const" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "void \fBsetAreaChanged\fR ( const QRect & r )" -.br -.in -1c -.SH DESCRIPTION -The QDirectPainter class provides direct access to the video hardware. -.PP -Only available in Qt/Embedded. -.PP -When the hardware is known and well defined, as is often the case with software for embedded devices, it may be useful to manipulate the underlying video hardware directly. In order to do this in a way that is co-operative with other applications, you must lock the video hardware for exclusive use for a small time while you write to it, and you must know the clipping region which is allocated to a widget. -.PP -QDirectPainter provides this functionality. -.PP -In the simplest case, you make a QDirectPainter on a widget and then, observing the clip region, perform some platform-specific operation. For example: -.PP -.nf -.br - void MyWidget::updatePlatformGraphics() -.br - { -.br - QDirectPainter dp( this ); -.br - for ( int i = 0; i < dp.numRects; i++ ) { -.br - const QRect& clip = dp.rect(i); -.br - ... // platform specific operation -.br - } -.br - } -.br -.fi -.PP -The platform-specific code has access to the display, but should only modify graphics in the rectangles specified by numRects() and rect(). Note that these rectangles are relative to the entire display. -.PP -The offset() function returns the position of the widget relative to the entire display, allowing you to offset platform-specific operations appropriately. The xOffset() and yOffset() functions merely return the component values of offset(). -.PP -For simple frame-buffer hardware, the frameBuffer(), lineStep(), and depth() functions provide basic access, though some hardware configurations are insufficiently specified by such simple parameters. -.PP -Note that while a QDirectPainter exists, the entire Qt/Embedded window system is locked from use by other applications. Always construct the QDirectPainter as an auto (stack) variable, and be very careful to write robust and stable code within its scope. -.PP -See also Graphics Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDirectPainter::QDirectPainter ( const QWidget * w )" -Construct a direct painter on \fIw\fR. The display is locked and the mouse cursor is hidden if it is above \fIw\fR. -.SH "QDirectPainter::~QDirectPainter ()" -Destroys the direct painter. The mouse cursor is revealed if necessary and the display is unlocked. -.SH "int QDirectPainter::depth () const" -Returns the bit-depth of the display. -.SH "uchar * QDirectPainter::frameBuffer ()" -Returns a pointer to the framebuffer memory if available. -.SH "int QDirectPainter::height () const" -Returns the height of the widget drawn upon. -.SH "int QDirectPainter::lineStep ()" -Returns the spacing in bytes from one framebuffer line to the next. -.SH "int QDirectPainter::numRects () const" -Returns the number of rectangles in the drawable region. -.PP -See also rect() and region(). -.SH "QPoint QDirectPainter::offset () const" -Returns the position of the widget relative to the entire display. -.SH "const QRect & QDirectPainter::rect ( int i ) const" -Returns a reference to rectangle \fIi\fR of the drawable region. Valid values for \fIi\fR are 0..numRects()-1. -.PP -See also region(). -.SH "QRegion QDirectPainter::region () const" -Returns the region of the framebuffer which represents the exposed area of the widget being painted on. Note that this may be a sub-area of the clip region, because of child widgets and overlapping cousin widgets. -.PP -See also numRects() and rect(). -.SH "void QDirectPainter::setAreaChanged ( const QRect & r )" -Sets the area changed by the transaction to \fIr\fR. By default, the entire widget is assumed to have changed. The area changed is only used by some graphics drivers, so often calling this function for a smaller area will make no difference to performance. -.SH "QSize QDirectPainter::size () const" -Returns the size of the widget drawn upon. -.PP -See also width() and height(). -.SH "int QDirectPainter::transformOrientation ()" -Returns a number that signifies the orientation of the framebuffer.
                .nf -.TS -l - l. 0 no rotation 1 90 degrees rotation 2 180 degrees rotation 3 -.TE -.fi -
                -.SH "int QDirectPainter::width () const" -Returns the width of the widget drawn upon. -.SH "int QDirectPainter::xOffset () const" -Returns the X-position of the widget relative to the entire display. -.SH "int QDirectPainter::yOffset () const" -Returns the Y-position of the widget relative to the entire -display. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdirectpainter.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdirectpainter.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdns.3qt b/doc/man/man3/qdns.3qt deleted file mode 100644 index fab7a5fab..000000000 --- a/doc/man/man3/qdns.3qt +++ /dev/null @@ -1,331 +0,0 @@ -'\" t -.TH QDns 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 -QDns \- Asynchronous DNS lookups -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBRecordType\fR { None, A, Aaaa, Mx, Srv, Cname, Ptr, Txt }" -.br -.ti -1c -.BI "\fBQDns\fR ()" -.br -.ti -1c -.BI "\fBQDns\fR ( const QString & label, RecordType rr = A )" -.br -.ti -1c -.BI "\fBQDns\fR ( const QHostAddress & address, RecordType rr = Ptr )" -.br -.ti -1c -.BI "virtual \fB~QDns\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetLabel\fR ( const QString & label )" -.br -.ti -1c -.BI "virtual void \fBsetLabel\fR ( const QHostAddress & address )" -.br -.ti -1c -.BI "QString \fBlabel\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRecordType\fR ( RecordType rr = A )" -.br -.ti -1c -.BI "RecordType \fBrecordType\fR () const" -.br -.ti -1c -.BI "bool \fBisWorking\fR () const" -.br -.ti -1c -.BI "QValueList \fBaddresses\fR () const" -.br -.ti -1c -.BI "QValueList \fBmailServers\fR () const" -.br -.ti -1c -.BI "QValueList \fBservers\fR () const" -.br -.ti -1c -.BI "QStringList \fBhostNames\fR () const" -.br -.ti -1c -.BI "QStringList \fBtexts\fR () const" -.br -.ti -1c -.BI "QString \fBcanonicalName\fR () const" -.br -.ti -1c -.BI "QStringList \fBqualifiedNames\fR () const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBresultsReady\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QDns class provides asynchronous DNS lookups. -.PP -Both Windows and Unix provide synchronous DNS lookups; Windows provides some asynchronous support too. At the time of writing neither operating system provides asynchronous support for anything other than hostname-to-address mapping. -.PP -QDns rectifies this shortcoming, by providing asynchronous caching lookups for the record types that we expect modern GUI applications to need in the near future. -.PP -The class is \fInot\fR straightforward to use (although it is much simpler than the native APIs); QSocket provides much easier to use TCP connection facilities. The aim of QDns is to provide a correct and small API to the DNS and nothing more. (We use "correctness" to mean that the DNS information is correctly cached, and correctly timed out.) -.PP -The API comprises a constructor, functions to set the DNS node (the domain in DNS terminology) and record type (setLabel() and setRecordType()), the corresponding get functions, an isWorking() function to determine whether QDns is working or reading, a resultsReady() signal and query functions for the result. -.PP -There is one query function for each RecordType, namely addresses(), mailServers(), servers(), hostNames() and texts(). There are also two generic query functions: canonicalName() returns the name you'll presumably end up using (the exact meaning of this depends on the record type) and qualifiedNames() returns a list of the fully qualified names label() maps to. -.PP -See also QSocket and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QDns::RecordType" -This enum type defines the record types QDns can handle. The DNS provides many more; these are the ones we've judged to be in current use, useful for GUI programs and important enough to support right away: -.TP -\fCQDns::None\fR - No information. This exists only so that QDns can have a default. -.TP -\fCQDns::A\fR - IPv4 addresses. By far the most common type. -.TP -\fCQDns::Aaaa\fR - IPv6 addresses. So far mostly unused. -.TP -\fCQDns::Mx\fR - Mail eXchanger names. Used for mail delivery. -.TP -\fCQDns::Srv\fR - SeRVer names. Generic record type for finding servers. So far mostly unused. -.TP -\fCQDns::Cname\fR - Canonical names. Maps from nicknames to the true name (the canonical name) for a host. -.TP -\fCQDns::Ptr\fR - name PoinTeRs. Maps from IPv4 or IPv6 addresses to hostnames. -.TP -\fCQDns::Txt\fR - arbitrary TeXT for domains. -.PP -We expect that some support for the RFC-2535 extensions will be added in future versions. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDns::QDns ()" -Constructs a DNS query object with invalid settings for both the label and the search type. -.SH "QDns::QDns ( const QString & label, RecordType rr = A )" -Constructs a DNS query object that will return record type \fIrr\fR information about \fIlabel\fR. -.PP -The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. -.PP -\fIrr\fR defaults to A, IPv4 addresses. -.SH "QDns::QDns ( const QHostAddress & address, RecordType rr = Ptr )" -Constructs a DNS query object that will return record type \fIrr\fR information about host address \fIaddress\fR. The label is set to the IN-ADDR.ARPA domain name. This is useful in combination with the Ptr record type (e.g. if you want to look up a hostname for a given address). -.PP -The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. -.PP -\fIrr\fR defaults to Ptr, that maps addresses to hostnames. -.SH "QDns::~QDns ()\fC [virtual]\fR" -Destroys the DNS query object and frees its allocated resources. -.SH "QValueList QDns::addresses () const" -Returns a list of the addresses for this name if this QDns object has a recordType() of QDns::A or QDns::Aaaa and the answer is available; otherwise returns an empty list. -.PP -As a special case, if label() is a valid numeric IP address, this function returns that address. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList list = myDns.addresses(); -.br - QValueList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "QString QDns::canonicalName () const" -Returns the canonical name for this DNS node. (This works regardless of what recordType() is set to.) -.PP -If the canonical name isn't known, this function returns a null string. -.PP -The canonical name of a DNS node is its full name, or the full name of the target of its CNAME. For example, if l.trolltech.com is a CNAME to lillian.troll.no, and the search path for QDns is" trolltech.com", then the canonical name for all of "lillian"," l", "lillian.troll.no." and "l.trolltech.com" is" lillian.troll.no.". -.SH "QStringList QDns::hostNames () const" -Returns a list of host names if the record type is Ptr. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myDns.hostNames(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "bool QDns::isWorking () const" -Returns TRUE if QDns is doing a lookup for this object (i.e. if it does not already have the necessary information); otherwise returns FALSE. -.PP -QDns emits the resultsReady() signal when the status changes to FALSE. -.PP -Example: network/mail/smtp.cpp. -.SH "QString QDns::label () const" -Returns the domain name for which this object returns information. -.PP -See also setLabel(). -.SH "QValueList QDns::mailServers () const" -Returns a list of mail servers if the record type is Mx. The class \fCQDns::MailServer\fR contains the following public variables: -.TP -QString QDns::MailServer::name -.TP -TQ_UINT16 QDns::MailServer::priority -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList list = myDns.mailServers(); -.br - QValueList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -Example: network/mail/smtp.cpp. -.SH "QStringList QDns::qualifiedNames () const" -Returns a list of the fully qualified names label() maps to. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myDns.qualifiedNames(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "RecordType QDns::recordType () const" -Returns the record type of this DNS query object. -.PP -See also setRecordType() and RecordType. -.SH "void QDns::resultsReady ()\fC [signal]\fR" -This signal is emitted when results are available for one of the qualifiedNames(). -.PP -Example: network/mail/smtp.cpp. -.SH "QValueList QDns::servers () const" -Returns a list of servers if the record type is Srv. The class \fCQDns::Server\fR contains the following public variables: -.TP -QString QDns::Server::name -.TP -TQ_UINT16 QDns::Server::priority -.TP -TQ_UINT16 QDns::Server::weight -.TP -TQ_UINT16 QDns::Server::port -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList list = myDns.servers(); -.br - QValueList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "void QDns::setLabel ( const QString & label )\fC [virtual]\fR" -Sets this DNS query object to query for information about \fIlabel\fR. -.PP -This does not change the recordType(), but its isWorking() status will probably change as a result. -.PP -The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. -.SH "void QDns::setLabel ( const QHostAddress & address )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets this DNS query object to query for information about the host address \fIaddress\fR. The label is set to the IN-ADDR.ARPA domain name. This is useful in combination with the Ptr record type (e.g. if you want to look up a hostname for a given address). -.SH "void QDns::setRecordType ( RecordType rr = A )\fC [virtual]\fR" -Sets this object to query for record type \fIrr\fR records. -.PP -The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. -.PP -See also RecordType. -.SH "QStringList QDns::texts () const" -Returns a list of texts if the record type is Txt. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myDns.texts(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdns.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdns.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdockarea.3qt b/doc/man/man3/qdockarea.3qt deleted file mode 100644 index 23cf9ef5a..000000000 --- a/doc/man/man3/qdockarea.3qt +++ /dev/null @@ -1,233 +0,0 @@ -'\" t -.TH QDockArea 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 -QDockArea \- Manages and lays out QDockWindows -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBHandlePosition\fR { Normal, Reverse }" -.br -.ti -1c -.BI "\fBQDockArea\fR ( Orientation o, HandlePosition h = Normal, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QDockArea\fR ()" -.br -.ti -1c -.BI "void \fBmoveDockWindow\fR ( QDockWindow * w, const QPoint & p, const QRect & r, bool swap )" -.br -.ti -1c -.BI "void \fBremoveDockWindow\fR ( QDockWindow * w, bool makeFloating, bool swap, bool fixNewLines = TRUE )" -.br -.ti -1c -.BI "void \fBmoveDockWindow\fR ( QDockWindow * w, int index = -1 )" -.br -.ti -1c -.BI "bool \fBhasDockWindow\fR ( QDockWindow * w, int * index = 0 )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "HandlePosition \fBhandlePosition\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "QPtrList \fBdockWindowList\fR () const" -.br -.ti -1c -.BI "bool \fBisDockWindowAccepted\fR ( QDockWindow * dw )" -.br -.ti -1c -.BI "void \fBsetAcceptDockWindow\fR ( QDockWindow * dw, bool accept )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBlineUp\fR ( bool keepNewLines )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBcount\fR - the number of dock windows in the dock area \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBempty\fR - whether the dock area is empty \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "HandlePosition \fBhandlePosition\fR - where the dock window splitter handle is placed in the dock area \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "Orientation \fBorientation\fR - the dock area's orientation \fI(read " "only" ")\fR" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( QTextStream & ts, const QDockArea & dockArea )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( QTextStream & ts, QDockArea & dockArea )" -.br -.in -1c -.SH DESCRIPTION -The QDockArea class manages and lays out QDockWindows. -.PP -A QDockArea is a container which manages a list of QDockWindows which it lays out within its area. In cooperation with the QDockWindows it is responsible for the docking and undocking of QDockWindows and moving them inside the dock area. QDockAreas also handle the wrapping of QDockWindows to fill the available space as compactly as possible. QDockAreas can contain QToolBars since QToolBar is a QDockWindow subclass. -.PP -QMainWindow contains four QDockAreas which you can use for your QToolBars and QDockWindows, so in most situations you do not need to use the QDockArea class directly. Although QMainWindow contains support for its own dock areas it isn't convenient for adding new QDockAreas. If you need to create your own dock areas we suggest that you create a subclass of QWidget and add your QDockAreas to your subclass. -.PP -
                -.ce 1 -.B "[Image Omitted]" -.PP -
                -.PP -\fILines\fR. QDockArea uses the concept of lines. A line is a horizontal region which may contain dock windows side-by-side. A dock area may have room for more than one line. When dock windows are docked into a dock area they are usually added at the right hand side of the top-most line that has room (unless manually placed by the user). When users move dock windows they may leave empty lines or gaps in non-empty lines. Dock windows can be lined up to minimize wasted space using the lineUp() function. -.PP -The QDockArea class maintains a position list of all its child dock windows. Dock windows are added to a dock area from position 0 onwards. Dock windows are laid out sequentially in position order from left to right, and in the case of multiple lines of dock windows, from top to bottom. If a dock window is floated it still retains its position since this is where the window will return if the user double clicks its caption. A dock window's position can be determined with hasDockWindow(). The position can be changed with moveDockWindow(). -.PP -To dock or undock a dock window use QDockWindow::dock() and QDockWindow::undock() respectively. If you want to control which dock windows can dock in a dock area use setAcceptDockWindow(). To see if a dock area contains a particular dock window use hasDockWindow(); to see how many dock windows a dock area contains use count(). -.PP -The streaming operators can write the positions of the dock windows in the dock area to a QTextStream. The positions can be read back later to restore the saved positions. -.PP -Save the positions to a QTextStream: -.PP -.nf -.br - ts << *myDockArea; -.br -.fi -.PP -Restore the positions from a QTextStream: -.PP -.nf -.br - ts >> *myDockArea; -.br -.fi -.PP -See also Main Window and Related Classes. -.SS "Member Type Documentation" -.SH "QDockArea::HandlePosition" -A dock window has two kinds of handles, the dock window handle used for dragging the dock window, and the splitter handle used to resize the dock window in relation to other dock windows using a splitter. (The splitter handle is only visible for docked windows.) -.PP -This enum specifies where the dock window splitter handle is placed in the dock area. -.TP -\fCQDockArea::Normal\fR - The splitter handles of dock windows are placed at the right or bottom. -.TP -\fCQDockArea::Reverse\fR - The splitter handles of dock windows are placed at the left or top. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDockArea::QDockArea ( Orientation o, HandlePosition h = Normal, QWidget * parent = 0, const char * name = 0 )" -Constructs a QDockArea with orientation \fIo\fR, HandlePosition \fIh\fR, parent \fIparent\fR and called \fIname\fR. -.SH "QDockArea::~QDockArea ()" -Destroys the dock area and all the dock windows docked in the dock area. -.PP -Does not affect any floating dock windows or dock windows in other dock areas, even if they first appeared in this dock area. Floating dock windows are effectively top level windows and are not child windows of the dock area. When a floating dock window is docked (dragged into a dock area) its parent becomes the dock area. -.SH "int QDockArea::count () const" -Returns the number of dock windows in the dock area. See the "count" property for details. -.SH "QPtrList QDockArea::dockWindowList () const" -Returns a list of the dock windows in the dock area. -.SH "HandlePosition QDockArea::handlePosition () const" -Returns where the dock window splitter handle is placed in the dock area. See the "handlePosition" property for details. -.SH "bool QDockArea::hasDockWindow ( QDockWindow * w, int * index = 0 )" -Returns TRUE if the dock area contains the dock window \fIw\fR; otherwise returns FALSE. If \fIindex\fR is not 0 it will be set as follows: if the dock area contains the dock window \fI*index\fR is set to \fIw\fR's index position; otherwise \fI*index\fR is set to -1. -.SH "bool QDockArea::isDockWindowAccepted ( QDockWindow * dw )" -Returns TRUE if dock window \fIdw\fR could be docked into the dock area; otherwise returns FALSE. -.PP -See also setAcceptDockWindow(). -.SH "bool QDockArea::isEmpty () const" -Returns TRUE if the dock area is empty; otherwise returns FALSE. See the "empty" property for details. -.SH "void QDockArea::lineUp ( bool keepNewLines )\fC [slot]\fR" -Lines up the dock windows in this dock area to minimize wasted space. If \fIkeepNewLines\fR is TRUE, only space within lines is cleaned up. If \fIkeepNewLines\fR is FALSE the number of lines might be changed. -.SH "void QDockArea::moveDockWindow ( QDockWindow * w, int index = -1 )" -Moves the QDockWindow \fIw\fR within the dock area. If \fIw\fR is not already docked in this area, \fIw\fR is docked first. If \fIindex\fR is -1 or larger than the number of docked widgets, \fIw\fR is appended at the end, otherwise it is inserted at the position \fIindex\fR. -.SH "void QDockArea::moveDockWindow ( QDockWindow * w, const QPoint & p, const QRect & r, bool swap )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Moves the dock window \fIw\fR inside the dock area where \fIp\fR is the new position (in global screen coordinates), \fIr\fR is the suggested rectangle of the dock window and \fIswap\fR specifies whether or not the orientation of the docked widget needs to be changed. -.PP -This function is used internally by QDockWindow. You shouldn't need to call it yourself. -.SH "Orientation QDockArea::orientation () const" -Returns the dock area's orientation. See the "orientation" property for details. -.SH "void QDockArea::removeDockWindow ( QDockWindow * w, bool makeFloating, bool swap, bool fixNewLines = TRUE )" -Removes the dock window \fIw\fR from the dock area. If \fImakeFloating\fR is TRUE, \fIw\fR gets floated, and if \fIswap\fR is TRUE, the orientation of \fIw\fR gets swapped. If \fIfixNewLines\fR is TRUE (the default) newlines in the area will be fixed. -.PP -You should never need to call this function yourself. Use QDockWindow::dock() and QDockWindow::undock() instead. -.SH "void QDockArea::setAcceptDockWindow ( QDockWindow * dw, bool accept )" -If \fIaccept\fR is TRUE, dock window \fIdw\fR can be docked in the dock area. If \fIaccept\fR is FALSE, dock window \fIdw\fR cannot be docked in the dock area. -.PP -See also isDockWindowAccepted(). -.SS "Property Documentation" -.SH "int count" -This property holds the number of dock windows in the dock area. -.PP -Get this property's value with count(). -.SH "bool empty" -This property holds whether the dock area is empty. -.PP -Get this property's value with isEmpty(). -.SH "HandlePosition handlePosition" -This property holds where the dock window splitter handle is placed in the dock area. -.PP -The default position is Normal. -.PP -Get this property's value with handlePosition(). -.SH "Orientation orientation" -This property holds the dock area's orientation. -.PP -There is no default value; the orientation is specified in the constructor. -.PP -Get this property's value with orientation(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QTextStream & operator<< ( QTextStream & ts, const QDockArea & dockArea )" -Writes the layout of the dock windows in dock area \fIdockArea\fR to the text stream \fIts\fR. -.PP -See also operator>>(). -.SH "QTextStream & operator>> ( QTextStream & ts, QDockArea & dockArea )" -Reads the layout description of the dock windows in dock area \fIdockArea\fR from the text stream \fIts\fR and restores it. The layout description must have been previously written by the operator<<() function. -.PP -See also operator<<(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdockarea.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdockarea.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdockwindow.3qt b/doc/man/man3/qdockwindow.3qt deleted file mode 100644 index cd0bc81cb..000000000 --- a/doc/man/man3/qdockwindow.3qt +++ /dev/null @@ -1,470 +0,0 @@ -'\" t -.TH QDockWindow 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 -QDockWindow \- Widget which can be docked inside a QDockArea or floated as a top level window on the desktop -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -Inherited by QToolBar. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBPlace\fR { InDock, OutsideDock }" -.br -.ti -1c -.BI "enum \fBCloseMode\fR { Never = 0, Docked = 1, Undocked = 2, Always = Docked | Undocked }" -.br -.ti -1c -.BI "\fBQDockWindow\fR ( Place p = InDock, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQDockWindow\fR ( QWidget * parent, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "virtual void \fBsetWidget\fR ( QWidget * w )" -.br -.ti -1c -.BI "QWidget * \fBwidget\fR () const" -.br -.ti -1c -.BI "Place \fBplace\fR () const" -.br -.ti -1c -.BI "QDockArea * \fBarea\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCloseMode\fR ( int m )" -.br -.ti -1c -.BI "bool \fBisCloseEnabled\fR () const" -.br -.ti -1c -.BI "int \fBcloseMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetResizeEnabled\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetMovingEnabled\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisResizeEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBisMovingEnabled\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetHorizontallyStretchable\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetVerticallyStretchable\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisHorizontallyStretchable\fR () const" -.br -.ti -1c -.BI "bool \fBisVerticallyStretchable\fR () const" -.br -.ti -1c -.BI "void setHorizontalStretchable ( bool b ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setVerticalStretchable ( bool b ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isHorizontalStretchable () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isVerticalStretchable () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBisStretchable\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetOffset\fR ( int o )" -.br -.ti -1c -.BI "int \fBoffset\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFixedExtentWidth\fR ( int w )" -.br -.ti -1c -.BI "virtual void \fBsetFixedExtentHeight\fR ( int h )" -.br -.ti -1c -.BI "QSize \fBfixedExtent\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNewLine\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBnewLine\fR () const" -.br -.ti -1c -.BI "Qt::Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "QBoxLayout * \fBboxLayout\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetOpaqueMoving\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBopaqueMoving\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBundock\fR ()" -.br -.ti -1c -.BI "virtual void \fBdock\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetOrientation\fR ( Orientation o )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBorientationChanged\fR ( Orientation o )" -.br -.ti -1c -.BI "void \fBplaceChanged\fR ( QDockWindow::Place p )" -.br -.ti -1c -.BI "void \fBvisibilityChanged\fR ( bool visible )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBcloseMode\fR - the close mode of a dock window" -.br -.ti -1c -.BI "bool \fBhorizontallyStretchable\fR - whether the dock window is horizontally stretchable" -.br -.ti -1c -.BI "bool \fBmovingEnabled\fR - whether the user can move the dock window within the dock " "area" ", move the dock window to another dock " "area" ", or float the dock window" -.br -.ti -1c -.BI "bool \fBnewLine\fR - whether the dock window prefers to start a new line in the dock area" -.br -.ti -1c -.BI "int \fBoffset\fR - the dock window's preferred offset from the dock area's left edge (top edge for vertical dock " "areas" ")" -.br -.ti -1c -.BI "bool \fBopaqueMoving\fR - whether the dock window will be shown normally whilst it is being moved" -.br -.ti -1c -.BI "Place \fBplace\fR \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBresizeEnabled\fR - whether the dock window is resizeable" -.br -.ti -1c -.BI "bool \fBstretchable\fR - whether the dock window is stretchable in the current orientation() \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBverticallyStretchable\fR - whether the dock window is vertically stretchable" -.br -.in -1c -.SH DESCRIPTION -The QDockWindow class provides a widget which can be docked inside a QDockArea or floated as a top level window on the desktop. -.PP -This class handles moving, resizing, docking and undocking dock windows. QToolBar is a subclass of QDockWindow so the functionality provided for dock windows is available with the same API for toolbars. -.PP -
                -.ce 1 -.B "[Image Omitted]" -.PP -

                \fI Two QDockWindows (QToolBars) in a QDockArea \fR

                -.PP -
                -.ce 1 -.B "[Image Omitted]" -.PP -

                \fI A Floating QDockWindow \fR

                -.PP -If the user drags the dock window into the dock area the dock window will be docked. If the user drags the dock area outside any dock areas the dock window will be undocked (floated) and will become a top level window. Double clicking a floating dock window's titlebar will dock the dock window to the last dock area it was docked in. Double clicking a docked dock window's handle will undock (float) the dock window. If the user clicks the close button (which does not appear on dock windows by default - see closeMode) the dock window will disappear. You can control whether or not a dock window has a close button with setCloseMode(). -.PP -QMainWindow provides four dock areas (top, left, right and bottom) which can be used by dock windows. For many applications using the dock areas provided by QMainWindow is sufficient. (See the QDockArea documentation if you want to create your own dock areas.) In QMainWindow a right-click popup menu (the dock window menu) is available which lists dock windows and can be used to show or hide them. (The popup menu only lists dock windows that have a caption.) -.PP -When you construct a dock window you \fImust\fR pass it a QDockArea or a QMainWindow as its parent if you want it docked. Pass 0 for the parent if you want it floated. -.PP -.nf -.br - QToolBar *fileTools = new QToolBar( this, "File Actions" ); -.br - moveDockWindow( fileTools, Left ); -.br -.fi -.PP -In the example above we create a new QToolBar in the constructor of a QMainWindow subclass (so that the \fIthis\fR pointer points to the QMainWindow). By default the toolbar will be added to the Top dock area, but we've moved it to the Left dock area. -.PP -A dock window is often used to contain a single widget. In these cases the widget can be set by calling setWidget(). If you're constructing a dock window that contains multiple widgets, e.g. a toolbar, arrange the widgets within a box layout inside the dock window. To do this use the boxLayout() function to get a pointer to the dock window's box layout, then add widgets to the layout using the box layout's QBoxLayout::addWidget() function. The dock window will dynamically set the orientation of the layout to be vertical or horizontal as necessary, although you can control this yourself with setOrientation(). -.PP -Although a common use of dock windows is for toolbars, they can be used with any widgets. (See the Qt Designer and Qt Linguist applications, for example.) When using larger widgets it may make sense for the dock window to be resizable by calling setResizeEnabled(). Resizable dock windows are given splitter-like handles to allow the user to resize them within their dock area. When resizable dock windows are undocked they become top level windows and can be resized like any other top level windows, e.g. by dragging a corner or edge. -.PP -Dock windows can be docked and undocked using dock() and undock(). A dock window's orientation can be set with setOrientation(). You can also use QDockArea::moveDockWindow(). If you're using a QMainWindow, QMainWindow::moveDockWindow() and QMainWindow::removeDockWindow() are available. -.PP -A dock window can have some preferred settings, for example, you can set a preferred offset from the left edge (or top edge for vertical dock areas) of the dock area using setOffset(). If you'd prefer a dock window to start on a new line when it is docked use setNewLine(). The setFixedExtentWidth() and setFixedExtentHeight() functions can be used to define the dock window's preferred size, and the setHorizontallyStretchable() and setVerticallyStretchable() functions set whether the dock window can be stretched or not. Dock windows can be moved by default, but this can be changed with setMovingEnabled(). When a dock window is moved it is shown as a rectangular outline, but it can be shown normally using setOpaqueMoving(). -.PP -When a dock window's visibility changes, i.e. it is shown or hidden, the visibilityChanged() signal is emitted. When a dock window is docked, undocked or moved inside the dock area the placeChanged() signal is emitted. -.PP -See also Main Window and Related Classes. -.SS "Member Type Documentation" -.SH "QDockWindow::CloseMode" -This enum type specifies when (if ever) a dock window has a close button. -.TP -\fCQDockWindow::Never\fR - The dock window never has a close button and cannot be closed by the user. -.TP -\fCQDockWindow::Docked\fR - The dock window has a close button only when docked. -.TP -\fCQDockWindow::Undocked\fR - The dock window has a close button only when floating. -.TP -\fCQDockWindow::Always\fR - The dock window always has a close button. -.SH "QDockWindow::Place" -This enum specifies the possible locations for a QDockWindow: -.TP -\fCQDockWindow::InDock\fR - Inside a QDockArea. -.TP -\fCQDockWindow::OutsideDock\fR - Floating as a top level window on the desktop. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDockWindow::QDockWindow ( Place p = InDock, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a QDockWindow with parent \fIparent\fR, called \fIname\fR and with widget flags \fIf\fR. -.PP -If \fIp\fR is InDock, the dock window is docked into a dock area and \fIparent\fR \fImust\fR be a QDockArea or a QMainWindow. If the \fIparent\fR is a QMainWindow the dock window will be docked in the main window's Top dock area. -.PP -If \fIp\fR is OutsideDock, the dock window is created as a floating window. -.PP -We recommend creating the dock area InDock with a QMainWindow as parent then calling QMainWindow::moveDockWindow() to move the dock window where you want it. -.SH "QDockWindow::QDockWindow ( QWidget * parent, const char * name = 0, WFlags f = 0 )" -Constructs a QDockWindow with parent \fIparent\fR, called \fIname\fR and with widget flags \fIf\fR. -.SH "QDockArea * QDockWindow::area () const" -Returns the dock area in which this dock window is docked, or 0 if the dock window is floating. -.SH "QBoxLayout * QDockWindow::boxLayout ()" -Returns the layout which is used for adding widgets to the dock window. The layout's orientation is set automatically to match the orientation of the dock window. You can add widgets to the layout using the box layout's QBoxLayout::addWidget() function. -.PP -If the dock window only needs to contain a single widget use setWidget() instead. -.PP -See also setWidget() and setOrientation(). -.SH "int QDockWindow::closeMode () const" -Returns the close mode of a dock window. See the "closeMode" property for details. -.SH "void QDockWindow::dock ()\fC [virtual slot]\fR" -Docks the dock window into the last dock area in which it was docked. -.PP -If the dock window has no last dock area (e.g. it was created as a floating window and has never been docked), or if the last dock area it was docked in does not exist (e.g. the dock area has been deleted), nothing happens. -.PP -The dock window will dock with the dock area regardless of the return value of QDockArea::isDockWindowAccepted(). -.PP -See also undock(), QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), QMainWindow::removeDockWindow(), and QDockArea::isDockWindowAccepted(). -.SH "QSize QDockWindow::fixedExtent () const" -Returns the dock window's preferred size (fixed extent). -.PP -See also setFixedExtentWidth() and setFixedExtentHeight(). -.SH "bool QDockWindow::isCloseEnabled () const" -Returns TRUE if the dock window has a close button; otherwise returns FALSE. The result depends on the dock window's Place and its CloseMode. -.PP -See also closeMode. -.SH "bool QDockWindow::isHorizontalStretchable () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QDockWindow::isHorizontallyStretchable () const" -Returns TRUE if the dock window is horizontally stretchable; otherwise returns FALSE. See the "horizontallyStretchable" property for details. -.SH "bool QDockWindow::isMovingEnabled () const" -Returns TRUE if the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window; otherwise returns FALSE. See the "movingEnabled" property for details. -.SH "bool QDockWindow::isResizeEnabled () const" -Returns TRUE if the dock window is resizeable; otherwise returns FALSE. See the "resizeEnabled" property for details. -.SH "bool QDockWindow::isStretchable () const" -Returns TRUE if the dock window is stretchable in the current orientation(); otherwise returns FALSE. See the "stretchable" property for details. -.SH "bool QDockWindow::isVerticalStretchable () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QDockWindow::isVerticallyStretchable () const" -Returns TRUE if the dock window is vertically stretchable; otherwise returns FALSE. See the "verticallyStretchable" property for details. -.SH "bool QDockWindow::newLine () const" -Returns TRUE if the dock window prefers to start a new line in the dock area; otherwise returns FALSE. See the "newLine" property for details. -.SH "int QDockWindow::offset () const" -Returns the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas). See the "offset" property for details. -.SH "bool QDockWindow::opaqueMoving () const" -Returns TRUE if the dock window will be shown normally whilst it is being moved; otherwise returns FALSE. See the "opaqueMoving" property for details. -.SH "Qt::Orientation QDockWindow::orientation () const" -Returns the orientation of the dock window. -.PP -See also orientationChanged(). -.SH "void QDockWindow::orientationChanged ( Orientation o )\fC [signal]\fR" -This signal is emitted when the orientation of the dock window is changed. The new orientation is \fIo\fR. -.SH "Place QDockWindow::place () const" -This function returns where the dock window is placed. This is either InDock or OutsideDock. -.PP -See also QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), and QMainWindow::removeDockWindow(). -.SH "void QDockWindow::placeChanged ( QDockWindow::Place p )\fC [signal]\fR" -This signal is emitted when the dock window is docked (\fIp\fR is InDock), undocked (\fIp\fR is OutsideDock) or moved inside the the dock area. -.PP -See also QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), and QMainWindow::removeDockWindow(). -.SH "void QDockWindow::setCloseMode ( int m )\fC [virtual]\fR" -Sets the close mode of a dock window to \fIm\fR. See the "closeMode" property for details. -.SH "void QDockWindow::setFixedExtentHeight ( int h )\fC [virtual]\fR" -Sets the dock window's preferred height for its fixed extent (size) to \fIh\fR. -.PP -See also setFixedExtentWidth(). -.SH "void QDockWindow::setFixedExtentWidth ( int w )\fC [virtual]\fR" -Sets the dock window's preferred width for its fixed extent (size) to \fIw\fR. -.PP -See also setFixedExtentHeight(). -.SH "void QDockWindow::setHorizontalStretchable ( bool b )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QDockWindow::setHorizontallyStretchable ( bool b )\fC [virtual]\fR" -Sets whether the dock window is horizontally stretchable to \fIb\fR. See the "horizontallyStretchable" property for details. -.SH "void QDockWindow::setMovingEnabled ( bool b )\fC [virtual]\fR" -Sets whether the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window to \fIb\fR. See the "movingEnabled" property for details. -.SH "void QDockWindow::setNewLine ( bool b )\fC [virtual]\fR" -Sets whether the dock window prefers to start a new line in the dock area to \fIb\fR. See the "newLine" property for details. -.SH "void QDockWindow::setOffset ( int o )\fC [virtual]\fR" -Sets the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas) to \fIo\fR. See the "offset" property for details. -.SH "void QDockWindow::setOpaqueMoving ( bool b )\fC [virtual]\fR" -Sets whether the dock window will be shown normally whilst it is being moved to \fIb\fR. See the "opaqueMoving" property for details. -.SH "void QDockWindow::setOrientation ( Orientation o )\fC [virtual slot]\fR" -Sets the orientation of the dock window to \fIo\fR. The orientation is propagated to the layout boxLayout(). -.PP -\fBWarning:\fR All undocked QToolBars will always have a horizontal orientation. -.SH "void QDockWindow::setResizeEnabled ( bool b )\fC [virtual]\fR" -Sets whether the dock window is resizeable to \fIb\fR. See the "resizeEnabled" property for details. -.SH "void QDockWindow::setVerticalStretchable ( bool b )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QDockWindow::setVerticallyStretchable ( bool b )\fC [virtual]\fR" -Sets whether the dock window is vertically stretchable to \fIb\fR. See the "verticallyStretchable" property for details. -.SH "void QDockWindow::setWidget ( QWidget * w )\fC [virtual]\fR" -Sets the dock window's main widget to \fIw\fR. -.PP -See also boxLayout(). -.SH "void QDockWindow::undock ()\fC [virtual slot]\fR" -Undocks the QDockWindow from its current dock area if it is docked; otherwise does nothing. -.PP -See also dock(), QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), and QMainWindow::removeDockWindow(). -.SH "void QDockWindow::visibilityChanged ( bool visible )\fC [signal]\fR" -This signal is emitted when the visibility of the dock window relatively to its dock area is changed. If \fIvisible\fR is TRUE, the QDockWindow is now visible to the dock area, otherwise it has been hidden. -.PP -A dock window can be hidden if it has a close button which the user has clicked. In the case of a QMainWindow a dock window can have its visibility changed (hidden or shown) by clicking its name in the dock window menu that lists the QMainWindow's dock windows. -.SH "QWidget * QDockWindow::widget () const" -Returns the dock window's main widget. -.PP -See also setWidget(). -.SS "Property Documentation" -.SH "int closeMode" -This property holds the close mode of a dock window. -.PP -Defines when (if ever) the dock window has a close button. The choices are Never, Docked (i.e. only when docked), Undocked (only when undocked, i.e. floated) or Always. -.PP -The default is Never. -.PP -Set this property's value with setCloseMode() and get this property's value with closeMode(). -.SH "bool horizontallyStretchable" -This property holds whether the dock window is horizontally stretchable. -.PP -A dock window is horizontally stretchable if you call setHorizontallyStretchable(TRUE) or setResizeEnabled(TRUE). -.PP -See also resizeEnabled. -.PP -Bugs and limitations: -.TP -Strecthability is broken. You must call setResizeEnabled(TRUE) to get proper behavior and even then QDockWindow does not limit stretchablilty. -.PP -Set this property's value with setHorizontallyStretchable() and get this property's value with isHorizontallyStretchable(). -.SH "bool movingEnabled" -This property holds whether the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window. -.PP -This property is TRUE by default. -.PP -Set this property's value with setMovingEnabled() and get this property's value with isMovingEnabled(). -.SH "bool newLine" -This property holds whether the dock window prefers to start a new line in the dock area. -.PP -The default is FALSE, i.e. the dock window doesn't require a new line in the dock area. -.PP -Set this property's value with setNewLine() and get this property's value with newLine(). -.SH "int offset" -This property holds the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas). -.PP -The default is 0. -.PP -Set this property's value with setOffset() and get this property's value with offset(). -.SH "bool opaqueMoving" -This property holds whether the dock window will be shown normally whilst it is being moved. -.PP -If this property is FALSE, (the default), the dock window will be represented by an outline rectangle whilst it is being moved. -.PP -\fBWarning:\fR Currently opaque moving has some problems and we do not recommend using it at this time. We expect to fix these problems in a future release. -.PP -Set this property's value with setOpaqueMoving() and get this property's value with opaqueMoving(). -.SH "bool resizeEnabled" -This property holds whether the dock window is resizeable. -.PP -A resizeable dock window can be resized using splitter-like handles inside a dock area and like every other top level window when floating. -.PP -A dock window is both horizontally and vertically stretchable if you call setResizeEnabled(TRUE). -.PP -This property is FALSE by default. -.PP -See also verticallyStretchable and horizontallyStretchable. -.PP -Set this property's value with setResizeEnabled() and get this property's value with isResizeEnabled(). -.SH "bool stretchable" -This property holds whether the dock window is stretchable in the current orientation(). -.PP -This property can be set using setHorizontallyStretchable() and setVerticallyStretchable(), or with setResizeEnabled(). -.PP -See also resizeEnabled. -.PP -Bugs and limitations: -.TP -Strecthability is broken. You must call setResizeEnabled(TRUE) to get proper behavior and even then QDockWindow does not limit stretchablilty. -.PP -Get this property's value with isStretchable(). -.SH "bool verticallyStretchable" -This property holds whether the dock window is vertically stretchable. -.PP -A dock window is vertically stretchable if you call setVerticallyStretchable(TRUE) or setResizeEnabled(TRUE). -.PP -See also resizeEnabled. -.PP -Bugs and limitations: -.TP -Strecthability is broken. You must call setResizeEnabled(TRUE) to get proper behavior and even then QDockWindow does not limit stretchablilty. -.PP -Set this property's value with setVerticallyStretchable() and get this property's value with isVerticallyStretchable(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdockwindow.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdockwindow.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomattr.3qt b/doc/man/man3/qdomattr.3qt deleted file mode 100644 index 6962094ac..000000000 --- a/doc/man/man3/qdomattr.3qt +++ /dev/null @@ -1,153 +0,0 @@ -'\" t -.TH QDomAttr 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 -QDomAttr \- Represents one attribute of a QDomElement -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomAttr\fR ()" -.br -.ti -1c -.BI "\fBQDomAttr\fR ( const QDomAttr & x )" -.br -.ti -1c -.BI "QDomAttr & \fBoperator=\fR ( const QDomAttr & x )" -.br -.ti -1c -.BI "\fB~QDomAttr\fR ()" -.br -.ti -1c -.BI "virtual QString \fBname\fR () const" -.br -.ti -1c -.BI "virtual bool \fBspecified\fR () const" -.br -.ti -1c -.BI "virtual QDomElement \fBownerElement\fR () const" -.br -.ti -1c -.BI "virtual QString \fBvalue\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetValue\fR ( const QString & v )" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisAttr\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomAttr class represents one attribute of a QDomElement. -.PP -For example, the following piece of XML produces an element with no children, but two attributes: -.PP -.nf -.br - -.br -.fi -.PP -You can access the attributes of an element with code like this: -.PP -.nf -.br - QDomElement e = //... -.br - //... -.br - QDomAttr a = e.attributeNode( "href" ); -.br - cout << a.value() << endl; // prints "http://www.trolltech.com" -.br - a.setValue( "http://doc.trolltech.com" ); // change the node's attribute -.br - QDomAttr a2 = e.attributeNode( "href" ); -.br - cout << a2.value() << endl; // prints "http://doc.trolltech.com" -.br -.fi -.PP -This example also shows that changing an attribute received from an element changes the attribute of the element. If you do not want to change the value of the element's attribute you must use cloneNode() to get an independent copy of the attribute. -.PP -QDomAttr can return the name() and value() of an attribute. An attribute's value is set with setValue(). If specified() returns TRUE the value was either set in the document or set with setValue(); otherwise the value hasn't been set. The node this attribute is attached to (if any) is returned by ownerElement(). -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomAttr::QDomAttr ()" -Constructs an empty attribute. -.SH "QDomAttr::QDomAttr ( const QDomAttr & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomAttr::~QDomAttr ()" -Destroys the object and frees its resources. -.SH "bool QDomAttr::isAttr () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QString QDomAttr::name () const\fC [virtual]\fR" -Returns the attribute's name. -.SH "QDomNode::NodeType QDomAttr::nodeType () const\fC [virtual]\fR" -Returns AttributeNode. -.PP -Reimplemented from QDomNode. -.SH "QDomAttr & QDomAttr::operator= ( const QDomAttr & x )" -Assigns \fIx\fR to this DOM attribute. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomElement QDomAttr::ownerElement () const\fC [virtual]\fR" -Returns the element node this attribute is attached to or a null node if this attribute is not attached to any element. -.SH "void QDomAttr::setValue ( const QString & v )\fC [virtual]\fR" -Sets the attribute's value to \fIv\fR. -.PP -See also value(). -.SH "bool QDomAttr::specified () const\fC [virtual]\fR" -Returns TRUE if the attribute has either been expicitly specified in the XML document or was set by the user with setValue(). Returns FALSE if the value hasn't been specified or set. -.PP -See also setValue(). -.SH "QString QDomAttr::value () const\fC [virtual]\fR" -Returns the value of the attribute or QString::null if the attribute has not been specified. -.PP -See also specified() and setValue(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomattr.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomattr.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomcdatasection.3qt b/doc/man/man3/qdomcdatasection.3qt deleted file mode 100644 index cd32e666a..000000000 --- a/doc/man/man3/qdomcdatasection.3qt +++ /dev/null @@ -1,96 +0,0 @@ -'\" t -.TH QDomCDATASection 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 -QDomCDATASection \- Represents an XML CDATA section -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomText. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomCDATASection\fR ()" -.br -.ti -1c -.BI "\fBQDomCDATASection\fR ( const QDomCDATASection & x )" -.br -.ti -1c -.BI "QDomCDATASection & \fBoperator=\fR ( const QDomCDATASection & x )" -.br -.ti -1c -.BI "\fB~QDomCDATASection\fR ()" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisCDATASection\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomCDATASection class represents an XML CDATA section. -.PP -CDATA sections are used to escape blocks of text containing characters that would otherwise be regarded as markup. The only delimiter that is recognized in a CDATA section is the "]]>" string that terminates the CDATA section. CDATA sections cannot be nested. Their primary purpose is for including material such as XML fragments, without needing to escape all the delimiters. -.PP -Adjacent QDomCDATASection nodes are not merged by the QDomNode::normalize() function. -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomCDATASection::QDomCDATASection ()" -Constructs an empty CDATA section. To create a CDATA section with content, use the QDomDocument::createCDATASection() function. -.SH "QDomCDATASection::QDomCDATASection ( const QDomCDATASection & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomCDATASection::~QDomCDATASection ()" -Destroys the object and frees its resources. -.SH "bool QDomCDATASection::isCDATASection () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomCDATASection::nodeType () const\fC [virtual]\fR" -Returns \fCCDATASection\fR. -.PP -Reimplemented from QDomText. -.SH "QDomCDATASection & QDomCDATASection::operator= ( const QDomCDATASection & x )" -Assigns \fIx\fR to this CDATA section. -.PP -The data of the copy is shared (shallow copy): modifying one node -will also change the other. If you want to make a deep copy, use -cloneNode(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomcdatasection.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomcdatasection.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomcharacterdata.3qt b/doc/man/man3/qdomcharacterdata.3qt deleted file mode 100644 index dddc5fec0..000000000 --- a/doc/man/man3/qdomcharacterdata.3qt +++ /dev/null @@ -1,140 +0,0 @@ -'\" t -.TH QDomCharacterData 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 -QDomCharacterData \- Represents a generic string in the DOM -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -Inherited by QDomText and QDomComment. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomCharacterData\fR ()" -.br -.ti -1c -.BI "\fBQDomCharacterData\fR ( const QDomCharacterData & x )" -.br -.ti -1c -.BI "QDomCharacterData & \fBoperator=\fR ( const QDomCharacterData & x )" -.br -.ti -1c -.BI "\fB~QDomCharacterData\fR ()" -.br -.ti -1c -.BI "virtual QString \fBsubstringData\fR ( unsigned long offset, unsigned long count )" -.br -.ti -1c -.BI "virtual void \fBappendData\fR ( const QString & arg )" -.br -.ti -1c -.BI "virtual void \fBinsertData\fR ( unsigned long offset, const QString & arg )" -.br -.ti -1c -.BI "virtual void \fBdeleteData\fR ( unsigned long offset, unsigned long count )" -.br -.ti -1c -.BI "virtual void \fBreplaceData\fR ( unsigned long offset, unsigned long count, const QString & arg )" -.br -.ti -1c -.BI "virtual uint \fBlength\fR () const" -.br -.ti -1c -.BI "virtual QString \fBdata\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetData\fR ( const QString & v )" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisCharacterData\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomCharacterData class represents a generic string in the DOM. -.PP -Character data as used in XML specifies a generic data string. More specialized versions of this class are QDomText, QDomComment and QDomCDATASection. -.PP -The data string is set with setData() and retrieved with data(). You can retrieve a portion of the data string using substringData(). Extra data can be appended with appendData(), or inserted with insertData(). Portions of the data string can be deleted with deleteData() or replaced with replaceData(). The length of the data string is returned by length(). -.PP -The node type of the node containing this character data is returned by nodeType(). -.PP -See also QDomText, QDomComment, QDomCDATASection, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomCharacterData::QDomCharacterData ()" -Constructs an empty character data object. -.SH "QDomCharacterData::QDomCharacterData ( const QDomCharacterData & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomCharacterData::~QDomCharacterData ()" -Destroys the object and frees its resources. -.SH "void QDomCharacterData::appendData ( const QString & arg )\fC [virtual]\fR" -Appends the string \fIarg\fR to the stored string. -.SH "QString QDomCharacterData::data () const\fC [virtual]\fR" -Returns the string stored in this object. -.PP -If the node is a null node, it will return QString::null. -.SH "void QDomCharacterData::deleteData ( unsigned long offset, unsigned long count )\fC [virtual]\fR" -Deletes a substring of length \fIcount\fR from position \fIoffset\fR. -.SH "void QDomCharacterData::insertData ( unsigned long offset, const QString & arg )\fC [virtual]\fR" -Inserts the string \fIarg\fR into the stored string at position \fIoffset\fR. -.SH "bool QDomCharacterData::isCharacterData () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "uint QDomCharacterData::length () const\fC [virtual]\fR" -Returns the length of the stored string. -.SH "QDomNode::NodeType QDomCharacterData::nodeType () const\fC [virtual]\fR" -Returns the type of node this object refers to (i.e. TextNode, CDATASectionNode, CommentNode or CharacterDataNode). For a null node CharacterDataNode is returned. -.PP -Reimplemented from QDomNode. -.PP -Reimplemented in QDomText and QDomComment. -.SH "QDomCharacterData & QDomCharacterData::operator= ( const QDomCharacterData & x )" -Assigns \fIx\fR to this character data. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "void QDomCharacterData::replaceData ( unsigned long offset, unsigned long count, const QString & arg )\fC [virtual]\fR" -Replaces the substring of length \fIcount\fR starting at position \fIoffset\fR with the string \fIarg\fR. -.SH "void QDomCharacterData::setData ( const QString & v )\fC [virtual]\fR" -Sets this object's string to \fIv\fR. -.SH "QString QDomCharacterData::substringData ( unsigned long offset, unsigned long count )\fC [virtual]\fR" -Returns the substring of length \fIcount\fR from position \fIoffset\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomcharacterdata.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomcharacterdata.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomcomment.3qt b/doc/man/man3/qdomcomment.3qt deleted file mode 100644 index 985bb8ab6..000000000 --- a/doc/man/man3/qdomcomment.3qt +++ /dev/null @@ -1,101 +0,0 @@ -'\" t -.TH QDomComment 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 -QDomComment \- Represents an XML comment -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomCharacterData. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomComment\fR ()" -.br -.ti -1c -.BI "\fBQDomComment\fR ( const QDomComment & x )" -.br -.ti -1c -.BI "QDomComment & \fBoperator=\fR ( const QDomComment & x )" -.br -.ti -1c -.BI "\fB~QDomComment\fR ()" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisComment\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomComment class represents an XML comment. -.PP -A comment in the parsed XML such as this: -.PP -.nf -.br - -.br -.fi -is represented by QDomComment objects in the parsed Dom tree. -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomComment::QDomComment ()" -Constructs an empty comment. To construct a comment with content, use the QDomDocument::createComment() function. -.SH "QDomComment::QDomComment ( const QDomComment & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomComment::~QDomComment ()" -Destroys the object and frees its resources. -.SH "bool QDomComment::isComment () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomComment::nodeType () const\fC [virtual]\fR" -Returns CommentNode. -.PP -Reimplemented from QDomCharacterData. -.SH "QDomComment & QDomComment::operator= ( const QDomComment & x )" -Assigns \fIx\fR to this DOM comment. -.PP -The data of the copy is shared (shallow copy): modifying one node -will also change the other. If you want to make a deep copy, use -cloneNode(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomcomment.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomcomment.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomdocument.3qt b/doc/man/man3/qdomdocument.3qt deleted file mode 100644 index 568bd4a53..000000000 --- a/doc/man/man3/qdomdocument.3qt +++ /dev/null @@ -1,448 +0,0 @@ -'\" t -.TH QDomDocument 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 -QDomDocument \- Represents an XML document -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomDocument\fR ()" -.br -.ti -1c -.BI "explicit \fBQDomDocument\fR ( const QString & name )" -.br -.ti -1c -.BI "explicit \fBQDomDocument\fR ( const QDomDocumentType & doctype )" -.br -.ti -1c -.BI "\fBQDomDocument\fR ( const QDomDocument & x )" -.br -.ti -1c -.BI "QDomDocument & \fBoperator=\fR ( const QDomDocument & x )" -.br -.ti -1c -.BI "\fB~QDomDocument\fR ()" -.br -.ti -1c -.BI "QDomElement \fBcreateElement\fR ( const QString & tagName )" -.br -.ti -1c -.BI "QDomDocumentFragment \fBcreateDocumentFragment\fR ()" -.br -.ti -1c -.BI "QDomText \fBcreateTextNode\fR ( const QString & value )" -.br -.ti -1c -.BI "QDomComment \fBcreateComment\fR ( const QString & value )" -.br -.ti -1c -.BI "QDomCDATASection \fBcreateCDATASection\fR ( const QString & value )" -.br -.ti -1c -.BI "QDomProcessingInstruction \fBcreateProcessingInstruction\fR ( const QString & target, const QString & data )" -.br -.ti -1c -.BI "QDomAttr \fBcreateAttribute\fR ( const QString & name )" -.br -.ti -1c -.BI "QDomEntityReference \fBcreateEntityReference\fR ( const QString & name )" -.br -.ti -1c -.BI "QDomNodeList \fBelementsByTagName\fR ( const QString & tagname ) const" -.br -.ti -1c -.BI "QDomNode \fBimportNode\fR ( const QDomNode & importedNode, bool deep )" -.br -.ti -1c -.BI "QDomElement \fBcreateElementNS\fR ( const QString & nsURI, const QString & qName )" -.br -.ti -1c -.BI "QDomAttr \fBcreateAttributeNS\fR ( const QString & nsURI, const QString & qName )" -.br -.ti -1c -.BI "QDomNodeList \fBelementsByTagNameNS\fR ( const QString & nsURI, const QString & localName )" -.br -.ti -1c -.BI "QDomElement \fBelementById\fR ( const QString & elementId )" -.br -.ti -1c -.BI "QDomDocumentType \fBdoctype\fR () const" -.br -.ti -1c -.BI "QDomImplementation \fBimplementation\fR () const" -.br -.ti -1c -.BI "QDomElement \fBdocumentElement\fR () const" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( const QCString & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( const QByteArray & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( const QString & text, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( QIODevice * dev, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( const QCString & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( const QByteArray & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( const QString & text, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( QIODevice * dev, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "bool \fBsetContent\fR ( QXmlInputSource * source, QXmlReader * reader, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisDocument\fR () const" -.br -.ti -1c -.BI "QString \fBtoString\fR () const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( int indent ) const" -.br -.ti -1c -.BI "QCString \fBtoCString\fR () const" -.br -.ti -1c -.BI "QCString \fBtoCString\fR ( int indent ) const" -.br -.in -1c -.SH DESCRIPTION -The QDomDocument class represents an XML document. -.PP -The QDomDocument class represents the entire XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data. -.PP -Since elements, text nodes, comments, processing instructions, etc., cannot exist outside the context of a document, the document class also contains the factory functions needed to create these objects. The node objects created have an ownerDocument() function which associates them with the document within whose context they were created. The DOM classes that will be used most often are QDomNode, QDomDocument, QDomElement and QDomText. -.PP -The parsed XML is represented internally by a tree of objects that can be accessed using the various QDom classes. All QDom classes only \fIreference\fR objects in the internal tree. The internal objects in the DOM tree will get deleted once the last QDom object referencing them and the QDomDocument itself are deleted. -.PP -Creation of elements, text nodes, etc. is done using the various factory functions provided in this class. Using the default constructors of the QDom classes will only result in empty objects that cannot be manipulated or inserted into the Document. -.PP -The QDomDocument class has several functions for creating document data, for example, createElement(), createTextNode(), createComment(), createCDATASection(), createProcessingInstruction(), createAttribute() and createEntityReference(). Some of these functions have versions that support namespaces, i.e. createElementNS() and createAttributeNS(). The createDocumentFragment() function is used to hold parts of the document; this is useful for manipulating for complex documents. -.PP -The entire content of the document is set with setContent(). This function parses the string it is passed as an XML document and creates the DOM tree that represents the document. The root element is available using documentElement(). The textual representation of the document can be obtained using toString(). -.PP -It is possible to insert a node from another document into the document using importNode(). -.PP -You can obtain a list of all the elements that have a particular tag with elementsByTagName() or with elementsByTagNameNS(). -.PP -The QDom classes are typically used as follows: -.PP -.nf -.br - QDomDocument doc( "mydocument" ); -.br - QFile file( "mydocument.xml" ); -.br - if ( !file.open( IO_ReadOnly ) ) -.br - return; -.br - if ( !doc.setContent( &file ) ) { -.br - file.close(); -.br - return; -.br - } -.br - file.close(); -.br -.br - // print out the element names of all elements that are direct children -.br - // of the outermost element. -.br - QDomElement docElem = doc.documentElement(); -.br -.br - QDomNode n = docElem.firstChild(); -.br - while( !n.isNull() ) { -.br - QDomElement e = n.toElement(); // try to convert the node to an element. -.br - if( !e.isNull() ) { -.br - cout << e.tagName() << endl; // the node really is an element. -.br - } -.br - n = n.nextSibling(); -.br - } -.br -.br - // Here we append a new element to the end of the document -.br - QDomElement elem = doc.createElement( "img" ); -.br - elem.setAttribute( "src", "myimage.png" ); -.br - docElem.appendChild( elem ); -.br -.fi -.PP -Once \fCdoc\fR and \fCelem\fR go out of scope, the whole internal tree representing the XML document is deleted. -.PP -To create a document using DOM use code like this: -.PP -.nf -.br - QDomDocument doc( "MyML" ); -.br - QDomElement root = doc.createElement( "MyML" ); -.br - doc.appendChild( root ); -.br -.br - QDomElement tag = doc.createElement( "Greeting" ); -.br - root.appendChild( tag ); -.br -.br - QDomText t = doc.createTextNode( "Hello World" ); -.br - tag.appendChild( t ); -.br -.br - QString xml = doc.toString(); -.br -.fi -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomDocument::QDomDocument ()" -Constructs an empty document. -.SH "explicit QDomDocument::QDomDocument ( const QString & name )" -Creates a document and sets the name of the document type to \fIname\fR. -.SH "explicit QDomDocument::QDomDocument ( const QDomDocumentType & doctype )" -Creates a document with the document type \fIdoctype\fR. -.PP -See also QDomImplementation::createDocumentType(). -.SH "QDomDocument::QDomDocument ( const QDomDocument & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomDocument::~QDomDocument ()" -Destroys the object and frees its resources. -.SH "QDomAttr QDomDocument::createAttribute ( const QString & name )" -Creates a new attribute called \fIname\fR that can be inserted into an element, e.g. using QDomElement::setAttributeNode(). -.PP -See also createAttributeNS(). -.SH "QDomAttr QDomDocument::createAttributeNS ( const QString & nsURI, const QString & qName )" -Creates a new attribute with namespace support that can be inserted into an element. The name of the attribute is \fIqName\fR and the namespace URI is \fInsURI\fR. This function also sets QDomNode::prefix() and QDomNode::localName() to appropriate values (depending on \fIqName\fR). -.PP -See also createAttribute(). -.SH "QDomCDATASection QDomDocument::createCDATASection ( const QString & value )" -Creates a new CDATA section for the string \fIvalue\fR that can be inserted into the document, e.g. using QDomNode::appendChild(). -.PP -See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). -.SH "QDomComment QDomDocument::createComment ( const QString & value )" -Creates a new comment for the string \fIvalue\fR that can be inserted into the document, e.g. using QDomNode::appendChild(). -.PP -See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). -.SH "QDomDocumentFragment QDomDocument::createDocumentFragment ()" -Creates a new document fragment, that can be used to hold parts of the document, e.g. when doing complex manipulations of the document tree. -.SH "QDomElement QDomDocument::createElement ( const QString & tagName )" -Creates a new element called \fItagName\fR that can be inserted into the DOM tree, e.g. using QDomNode::appendChild(). -.PP -See also createElementNS(), QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). -.SH "QDomElement QDomDocument::createElementNS ( const QString & nsURI, const QString & qName )" -Creates a new element with namespace support that can be inserted into the DOM tree. The name of the element is \fIqName\fR and the namespace URI is \fInsURI\fR. This function also sets QDomNode::prefix() and QDomNode::localName() to appropriate values (depending on \fIqName\fR). -.PP -See also createElement(). -.SH "QDomEntityReference QDomDocument::createEntityReference ( const QString & name )" -Creates a new entity reference called \fIname\fR that can be inserted into the document, e.g. using QDomNode::appendChild(). -.PP -See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). -.SH "QDomProcessingInstruction QDomDocument::createProcessingInstruction ( const QString & target, const QString & data )" -Creates a new processing instruction that can be inserted into the document, e.g. using QDomNode::appendChild(). This function sets the target for the processing instruction to \fItarget\fR and the data to \fIdata\fR. -.PP -See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). -.SH "QDomText QDomDocument::createTextNode ( const QString & value )" -Creates a text node for the string \fIvalue\fR that can be inserted into the document tree, e.g. using QDomNode::appendChild(). -.PP -\fBWarning:\fR All characters within an XML document must be in the range: -.PP -#x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] -.PP -This rule also applies to characters encoded as character entities and characters in CDATA sections. If you use this function to insert characters outside of this range, the document will not be well-formed. -.PP -If you want to store binary data in an XML document you must either use your own scheme to escape illegal characters, or you must store it in an external unparsed entity. -.PP -See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). -.SH "QDomDocumentType QDomDocument::doctype () const" -Returns the document type of this document. -.SH "QDomElement QDomDocument::documentElement () const" -Returns the root element of the document. -.SH "QDomElement QDomDocument::elementById ( const QString & elementId )" -Returns the element whose ID is equal to \fIelementId\fR. If no element with the ID was found, this function returns a null element. -.PP -Since the QDomClasses do not know which attributes are element IDs, this function returns always a null element. This may change in a future version. -.SH "QDomNodeList QDomDocument::elementsByTagName ( const QString & tagname ) const" -Returns a QDomNodeList, that contains all the elements in the document with the name \fItagname\fR. The order of the node list is the order they are encountered in a preorder traversal of the element tree. -.PP -See also elementsByTagNameNS() and QDomElement::elementsByTagName(). -.SH "QDomNodeList QDomDocument::elementsByTagNameNS ( const QString & nsURI, const QString & localName )" -Returns a QDomNodeList that contains all the elements in the document with the local name \fIlocalName\fR and a namespace URI of \fInsURI\fR. The order of the node list is the order they are encountered in a preorder traversal of the element tree. -.PP -See also elementsByTagName() and QDomElement::elementsByTagNameNS(). -.SH "QDomImplementation QDomDocument::implementation () const" -Returns a QDomImplementation object. -.SH "QDomNode QDomDocument::importNode ( const QDomNode & importedNode, bool deep )" -Imports the node \fIimportedNode\fR from another document to this document. \fIimportedNode\fR remains in the original document; this function creates a copy that can be used within this document. -.PP -This function returns the imported node that belongs to this document. The returned node has no parent. It is not possible to import QDomDocument and QDomDocumentType nodes. In those cases this function returns a null node. -.PP -If \fIdeep\fR is TRUE, this function imports not only the node \fIimportedNode\fR but its whole subtree; if it is FALSE, only the \fIimportedNode\fR is imported. The argument \fIdeep\fR has no effect on QDomAttr and QDomEntityReference nodes, since the descendents of QDomAttr nodes are always imported and those of QDomEntityReference nodes are never imported. -.PP -The behavior of this function is slightly different depending on the node types:
                .nf -.TS -l - l. Node Type Behaviour QDomAttr The owner element is set to 0 and the specified flag is set to TRUE in the generated attribute. The whole subtree of \fIimportedNode\fR is always imported for attribute nodes: \fIdeep\fR has no effect. QDomDocument Document nodes cannot be imported. QDomDocumentFragment If \fIdeep\fR is TRUE, this function imports the whole document fragment; otherwise it only generates an empty document fragment. QDomDocumentType Document type nodes cannot be imported. QDomElement Attributes for which QDomAttr::specified() is TRUE are also imported, other attributes are not imported. If \fIdeep\fR is TRUE, this function also imports the subtree of \fIimportedNode\fR; otherwise it imports only the element node (and some attributes, see above). QDomEntity Entity nodes can be imported, but at the moment there is no way to use them since the document type is read-only in DOM level 2. QDomEntityReference Descendents of entity reference nodes are never imported: \fIdeep\fR has no effect. QDomNotation Notation nodes can be imported, but at the moment there is no way to use them since the document type is read-only in DOM level 2. QDomProcessingInstruction The target and value of the processing instruction is copied to the new node. QDomText The text is copied to the new node. QDomCDATASection The text is copied to the new node. QDomComment -.TE -.fi -
                -.PP -See also QDomElement::setAttribute(), QDomNode::insertBefore(), QDomNode::insertAfter(), QDomNode::replaceChild(), QDomNode::removeChild(), and QDomNode::appendChild(). -.SH "bool QDomDocument::isDocument () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomDocument::nodeType () const\fC [virtual]\fR" -Returns DocumentNode. -.PP -Reimplemented from QDomNode. -.SH "QDomDocument & QDomDocument::operator= ( const QDomDocument & x )" -Assigns \fIx\fR to this DOM document. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "bool QDomDocument::setContent ( const QByteArray & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This function parses the XML document from the byte array \fIbuffer\fR and sets it as the content of the document. It tries to detect the encoding of the document as required by the XML specification. -.PP -If \fInamespaceProcessing\fR is TRUE, the parser recognizes namespaces in the XML file and sets the prefix name, local name and namespace URI to appropriate values. If \fInamespaceProcessing\fR is FALSE, the parser does no namespace processing when it reads the XML file. -.PP -If a parse error occurs, the function returns FALSE; otherwise it returns TRUE. If a parse error occurs and \fIerrorMsg\fR, \fIerrorLine\fR and \fIerrorColumn\fR are not 0, the error message is placed in \fI*errorMsg\fR, the line number \fI*errorLine\fR and the column number in \fI*errorColumn\fR. -.PP -If \fInamespaceProcessing\fR is TRUE, the function QDomNode::prefix() returns a string for all elements and attributes. It returns an empty string if the element or attribute has no prefix. -.PP -If \fInamespaceProcessing\fR is FALSE, the functions QDomNode::prefix(), QDomNode::localName() and QDomNode::namespaceURI() return QString::null. -.PP -See also QDomNode::namespaceURI(), QDomNode::localName(), QDomNode::prefix(), QString::isNull(), and QString::isEmpty(). -.SH "bool QDomDocument::setContent ( const QCString & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the C string \fIbuffer\fR. -.PP -\fBWarning:\fR This function does not try to detect the encoding: instead it assumes that the C string is UTF-8 encoded. -.SH "bool QDomDocument::setContent ( const QString & text, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the string \fItext\fR. Since \fItext\fR is already a Unicode string, no encoding detection is done. -.SH "bool QDomDocument::setContent ( QIODevice * dev, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the IO device \fIdev\fR. -.SH "bool QDomDocument::setContent ( const QCString & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the C string \fIbuffer\fR. -.PP -No namespace processing is performed. -.PP -\fBWarning:\fR This function does not try to detect the encoding: instead it assumes that the C string is UTF-8 encoded. -.SH "bool QDomDocument::setContent ( const QByteArray & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the byte array \fIbuffer\fR. -.PP -No namespace processing is performed. -.SH "bool QDomDocument::setContent ( const QString & text, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the string \fItext\fR. Since \fItext\fR is already a Unicode string, no encoding detection is performed. -.PP -No namespace processing is performed either. -.SH "bool QDomDocument::setContent ( QIODevice * dev, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the IO device \fIdev\fR. -.PP -No namespace processing is performed. -.SH "bool QDomDocument::setContent ( QXmlInputSource * source, QXmlReader * reader, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function reads the XML document from the QXmlInputSource \fIsource\fR and parses it with the QXmlReader \fIreader\fR. -.PP -This function doesn't change the features of the \fIreader\fR. If you want to use certain features for parsing you can use this function to set up the reader appropriate. -.PP -See also QXmlSimpleReader. -.SH "QCString QDomDocument::toCString () const" -Converts the parsed document back to its textual representation and returns a QCString for that is encoded in UTF-8. -.PP -See also toString(). -.SH "QCString QDomDocument::toCString ( int indent ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses \fIindent\fR as the amount of space to indent subelements. -.SH "QString QDomDocument::toString () const" -Converts the parsed document back to its textual representation. -.PP -See also toCString(). -.SH "QString QDomDocument::toString ( int indent ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function uses \fIindent\fR as the amount of space to indent -subelements. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomdocument.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomdocument.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomdocumentfragment.3qt b/doc/man/man3/qdomdocumentfragment.3qt deleted file mode 100644 index e750fe214..000000000 --- a/doc/man/man3/qdomdocumentfragment.3qt +++ /dev/null @@ -1,100 +0,0 @@ -'\" t -.TH QDomDocumentFragment 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 -QDomDocumentFragment \- Tree of QDomNodes which is not usually a complete QDomDocument -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomDocumentFragment\fR ()" -.br -.ti -1c -.BI "\fBQDomDocumentFragment\fR ( const QDomDocumentFragment & x )" -.br -.ti -1c -.BI "QDomDocumentFragment & \fBoperator=\fR ( const QDomDocumentFragment & x )" -.br -.ti -1c -.BI "\fB~QDomDocumentFragment\fR ()" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisDocumentFragment\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomDocumentFragment class is a tree of QDomNodes which is not usually a complete QDomDocument. -.PP -If you want to do complex tree operations it is useful to have a lightweight class to store nodes and their relations. QDomDocumentFragment stores a subtree of a document which does not necessarily represent a well-formed XML document. -.PP -QDomDocumentFragment is also useful if you want to group several nodes in a list and insert them all together as children of some node. In these cases QDomDocumentFragment can be used as a temporary container for this list of children. -.PP -The most important feature of QDomDocumentFragment is that it is treated in a special way by QDomNode::insertAfter(), QDomNode::insertBefore(), QDomNode::replaceChild() and QDomNode::appendChild(): instead of inserting the fragment itself, all the fragment's children are inserted. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomDocumentFragment::QDomDocumentFragment ()" -Constructs an empty document fragment. -.SH "QDomDocumentFragment::QDomDocumentFragment ( const QDomDocumentFragment & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomDocumentFragment::~QDomDocumentFragment ()" -Destroys the object and frees its resources. -.SH "bool QDomDocumentFragment::isDocumentFragment () const\fC [virtual]\fR" -This function reimplements QDomNode::isDocumentFragment(). -.PP -See also nodeType() and QDomNode::toDocumentFragment(). -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomDocumentFragment::nodeType () const\fC [virtual]\fR" -Returns \fCDocumentFragment\fR. -.PP -See also isDocumentFragment() and QDomNode::toDocumentFragment(). -.PP -Reimplemented from QDomNode. -.SH "QDomDocumentFragment & QDomDocumentFragment::operator= ( const QDomDocumentFragment & x )" -Assigns \fIx\fR to this DOM document fragment. -.PP -The data of the copy is shared (shallow copy): modifying one node -will also change the other. If you want to make a deep copy, use -cloneNode(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomdocumentfragment.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomdocumentfragment.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomdocumenttype.3qt b/doc/man/man3/qdomdocumenttype.3qt deleted file mode 100644 index e8da36622..000000000 --- a/doc/man/man3/qdomdocumenttype.3qt +++ /dev/null @@ -1,132 +0,0 @@ -'\" t -.TH QDomDocumentType 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 -QDomDocumentType \- The representation of the DTD in the document tree -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomDocumentType\fR ()" -.br -.ti -1c -.BI "\fBQDomDocumentType\fR ( const QDomDocumentType & n )" -.br -.ti -1c -.BI "QDomDocumentType & \fBoperator=\fR ( const QDomDocumentType & n )" -.br -.ti -1c -.BI "\fB~QDomDocumentType\fR ()" -.br -.ti -1c -.BI "virtual QString \fBname\fR () const" -.br -.ti -1c -.BI "virtual QDomNamedNodeMap \fBentities\fR () const" -.br -.ti -1c -.BI "virtual QDomNamedNodeMap \fBnotations\fR () const" -.br -.ti -1c -.BI "virtual QString \fBpublicId\fR () const" -.br -.ti -1c -.BI "virtual QString \fBsystemId\fR () const" -.br -.ti -1c -.BI "virtual QString \fBinternalSubset\fR () const" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisDocumentType\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomDocumentType class is the representation of the DTD in the document tree. -.PP -The QDomDocumentType class allows read-only access to some of the data structures in the DTD: it can return a map of all entities() and notations(). In addition the function name() returns the name of the document type as specified in the tag. This class also provides the publicId(), systemId() and internalSubset() functions. -.PP -See also QDomDocument and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomDocumentType::QDomDocumentType ()" -Creates an empty QDomDocumentType object. -.SH "QDomDocumentType::QDomDocumentType ( const QDomDocumentType & n )" -Constructs a copy of \fIn\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomDocumentType::~QDomDocumentType ()" -Destroys the object and frees its resources. -.SH "QDomNamedNodeMap QDomDocumentType::entities () const\fC [virtual]\fR" -Returns a map of all entities described in the DTD. -.SH "QString QDomDocumentType::internalSubset () const\fC [virtual]\fR" -Returns the internal subset of the document type or QString::null if there is no internal subset. -.PP -See also publicId() and systemId(). -.SH "bool QDomDocumentType::isDocumentType () const\fC [virtual]\fR" -This function overloads QDomNode::isDocumentType(). -.PP -See also nodeType() and QDomNode::toDocumentType(). -.PP -Reimplemented from QDomNode. -.SH "QString QDomDocumentType::name () const\fC [virtual]\fR" -Returns the name of the document type as specified in the tag. -.PP -See also nodeName(). -.SH "QDomNode::NodeType QDomDocumentType::nodeType () const\fC [virtual]\fR" -Returns DocumentTypeNode. -.PP -See also isDocumentType() and QDomNode::toDocumentType(). -.PP -Reimplemented from QDomNode. -.SH "QDomNamedNodeMap QDomDocumentType::notations () const\fC [virtual]\fR" -Returns a map of all notations described in the DTD. -.SH "QDomDocumentType & QDomDocumentType::operator= ( const QDomDocumentType & n )" -Assigns \fIn\fR to this document type. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QString QDomDocumentType::publicId () const\fC [virtual]\fR" -Returns the public identifier of the external DTD subset or QString::null if there is no public identifier. -.PP -See also systemId(), internalSubset(), and QDomImplementation::createDocumentType(). -.SH "QString QDomDocumentType::systemId () const\fC [virtual]\fR" -Returns the system identifier of the external DTD subset or QString::null if there is no system identifier. -.PP -See also publicId(), internalSubset(), and QDomImplementation::createDocumentType(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomdocumenttype.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomdocumenttype.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomelement.3qt b/doc/man/man3/qdomelement.3qt deleted file mode 100644 index e28f4666f..000000000 --- a/doc/man/man3/qdomelement.3qt +++ /dev/null @@ -1,335 +0,0 @@ -'\" t -.TH QDomElement 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 -QDomElement \- Represents one element in the DOM tree -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomElement\fR ()" -.br -.ti -1c -.BI "\fBQDomElement\fR ( const QDomElement & x )" -.br -.ti -1c -.BI "QDomElement & \fBoperator=\fR ( const QDomElement & x )" -.br -.ti -1c -.BI "\fB~QDomElement\fR ()" -.br -.ti -1c -.BI "QString \fBattribute\fR ( const QString & name, const QString & defValue = QString::null ) const" -.br -.ti -1c -.BI "void \fBsetAttribute\fR ( const QString & name, const QString & value )" -.br -.ti -1c -.BI "void \fBsetAttribute\fR ( const QString & name, int value )" -.br -.ti -1c -.BI "void \fBsetAttribute\fR ( const QString & name, uint value )" -.br -.ti -1c -.BI "void \fBsetAttribute\fR ( const QString & name, long value )" -.br -.ti -1c -.BI "void \fBsetAttribute\fR ( const QString & name, ulong value )" -.br -.ti -1c -.BI "void \fBsetAttribute\fR ( const QString & name, double value )" -.br -.ti -1c -.BI "void \fBremoveAttribute\fR ( const QString & name )" -.br -.ti -1c -.BI "QDomAttr \fBattributeNode\fR ( const QString & name )" -.br -.ti -1c -.BI "QDomAttr \fBsetAttributeNode\fR ( const QDomAttr & newAttr )" -.br -.ti -1c -.BI "QDomAttr \fBremoveAttributeNode\fR ( const QDomAttr & oldAttr )" -.br -.ti -1c -.BI "virtual QDomNodeList \fBelementsByTagName\fR ( const QString & tagname ) const" -.br -.ti -1c -.BI "bool \fBhasAttribute\fR ( const QString & name ) const" -.br -.ti -1c -.BI "QString \fBattributeNS\fR ( const QString nsURI, const QString & localName, const QString & defValue ) const" -.br -.ti -1c -.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, const QString & value )" -.br -.ti -1c -.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, int value )" -.br -.ti -1c -.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, uint value )" -.br -.ti -1c -.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, long value )" -.br -.ti -1c -.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, ulong value )" -.br -.ti -1c -.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, double value )" -.br -.ti -1c -.BI "void \fBremoveAttributeNS\fR ( const QString & nsURI, const QString & localName )" -.br -.ti -1c -.BI "QDomAttr \fBattributeNodeNS\fR ( const QString & nsURI, const QString & localName )" -.br -.ti -1c -.BI "QDomAttr \fBsetAttributeNodeNS\fR ( const QDomAttr & newAttr )" -.br -.ti -1c -.BI "virtual QDomNodeList \fBelementsByTagNameNS\fR ( const QString & nsURI, const QString & localName ) const" -.br -.ti -1c -.BI "bool \fBhasAttributeNS\fR ( const QString & nsURI, const QString & localName ) const" -.br -.ti -1c -.BI "QString \fBtagName\fR () const" -.br -.ti -1c -.BI "void \fBsetTagName\fR ( const QString & name )" -.br -.ti -1c -.BI "virtual QDomNamedNodeMap \fBattributes\fR () const" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisElement\fR () const" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomElement class represents one element in the DOM tree. -.PP -Elements have a tagName() and zero or more attributes associated with them. The tag name can be changed with setTagName(). -.PP -Element attributes are represented by QDomAttr objects that can be queried using the attribute() and attributeNode() functions. You can set attributes with the setAttribute() and setAttributeNode() functions. Attributes can be removed with removeAttribute(). There are namespace-aware equivalents to these functions, i.e. setAttributeNS(), setAttributeNodeNS() and removeAttributeNS(). -.PP -If you want to access the text of a node use text(), e.g. -.PP -.nf -.br - QDomElement e = //... -.br - //... -.br - QString s = e.text() -.br -.fi -The text() function operates recursively to find the text (since not all elements contain text). If you want to find all the text in all of a node's children, iterate over the children looking for QDomText nodes, e.g. -.PP -.nf -.br - QString text; -.br - QDomElement element = doc.documentElement(); -.br - for( QDomNode n = element.firstChild(); !n.isNull(); n = n.nextSibling() ) -.br - { -.br - QDomText t = n.toText(); -.br - if ( !t.isNull() ) -.br - text += t.data(); -.br - } -.br -.fi -Note that we attempt to convert each node to a text node and use text() rather than using firstChild().toText().data() or n.toText().data() directly on the node, because the node may not be a text element. -.PP -You can get a list of all the decendents of an element which have a specified tag name with elementsByTagName() or elementsByTagNameNS(). -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomElement::QDomElement ()" -Constructs an empty element. Use the QDomDocument::createElement() function to construct elements with content. -.SH "QDomElement::QDomElement ( const QDomElement & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomElement::~QDomElement ()" -Destroys the object and frees its resources. -.SH "QString QDomElement::attribute ( const QString & name, const QString & defValue = QString::null ) const" -Returns the attribute called \fIname\fR. If the attribute does not exist \fIdefValue\fR is returned. -.PP -See also setAttribute(), attributeNode(), setAttributeNode(), and attributeNS(). -.SH "QString QDomElement::attributeNS ( const QString nsURI, const QString & localName, const QString & defValue ) const" -Returns the attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. If the attribute does not exist \fIdefValue\fR is returned. -.PP -See also setAttributeNS(), attributeNodeNS(), setAttributeNodeNS(), and attribute(). -.SH "QDomAttr QDomElement::attributeNode ( const QString & name )" -Returns the QDomAttr object that corresponds to the attribute called \fIname\fR. If no such attribute exists a null attribute is returned. -.PP -See also setAttributeNode(), attribute(), setAttribute(), and attributeNodeNS(). -.SH "QDomAttr QDomElement::attributeNodeNS ( const QString & nsURI, const QString & localName )" -Returns the QDomAttr object that corresponds to the attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. If no such attribute exists a null attribute is returned. -.PP -See also setAttributeNode(), attribute(), and setAttribute(). -.SH "QDomNamedNodeMap QDomElement::attributes () const\fC [virtual]\fR" -Returns a QDomNamedNodeMap containing all this element's attributes. -.PP -See also attribute(), setAttribute(), attributeNode(), and setAttributeNode(). -.PP -Reimplemented from QDomNode. -.SH "QDomNodeList QDomElement::elementsByTagName ( const QString & tagname ) const\fC [virtual]\fR" -Returns a QDomNodeList containing all descendent elements of this element that are called \fItagname\fR. The order they are in the node list is the order they are encountered in a preorder traversal of the element tree. -.PP -See also elementsByTagNameNS() and QDomDocument::elementsByTagName(). -.SH "QDomNodeList QDomElement::elementsByTagNameNS ( const QString & nsURI, const QString & localName ) const\fC [virtual]\fR" -Returns a QDomNodeList containing all the descendent elements of this element with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. The order they are in the node list is the order they are encountered in a preorder traversal of the element tree. -.PP -See also elementsByTagName() and QDomDocument::elementsByTagNameNS(). -.SH "bool QDomElement::hasAttribute ( const QString & name ) const" -Returns TRUE if this element has an attribute called \fIname\fR; otherwise returns FALSE. -.SH "bool QDomElement::hasAttributeNS ( const QString & nsURI, const QString & localName ) const" -Returns TRUE if this element has an attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR; otherwise returns FALSE. -.SH "bool QDomElement::isElement () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomElement::nodeType () const\fC [virtual]\fR" -Returns ElementNode. -.PP -Reimplemented from QDomNode. -.SH "QDomElement & QDomElement::operator= ( const QDomElement & x )" -Assigns \fIx\fR to this DOM element. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "void QDomElement::removeAttribute ( const QString & name )" -Removes the attribute called name \fIname\fR from this element. -.PP -See also setAttribute(), attribute(), and removeAttributeNS(). -.SH "void QDomElement::removeAttributeNS ( const QString & nsURI, const QString & localName )" -Removes the attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR from this element. -.PP -See also setAttributeNS(), attributeNS(), and removeAttribute(). -.SH "QDomAttr QDomElement::removeAttributeNode ( const QDomAttr & oldAttr )" -Removes the attribute \fIoldAttr\fR from the element and returns it. -.PP -See also attributeNode() and setAttributeNode(). -.SH "void QDomElement::setAttribute ( const QString & name, const QString & value )" -Adds an attribute called \fIname\fR with value \fIvalue\fR. If an attribute with the same name exists, its value is replaced by \fIvalue\fR. -.PP -See also attribute(), setAttributeNode(), and setAttributeNS(). -.SH "void QDomElement::setAttribute ( const QString & name, int value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttribute ( const QString & name, uint value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttribute ( const QString & name, long value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttribute ( const QString & name, ulong value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttribute ( const QString & name, double value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, const QString & value )" -Adds an attribute with the qualified name \fIqName\fR and the namespace URI \fInsURI\fR with the value \fIvalue\fR. If an attribute with the same local name and namespace URI exists, its prefix is replaced by the prefix of \fIqName\fR and its value is repaced by \fIvalue\fR. -.PP -Although \fIqName\fR is the qualified name, the local name is used to decide if an existing attribute's value should be replaced. -.PP -See also attributeNS(), setAttributeNodeNS(), and setAttribute(). -.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, int value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, uint value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, long value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, ulong value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, double value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QDomAttr QDomElement::setAttributeNode ( const QDomAttr & newAttr )" -Adds the attribute \fInewAttr\fR to this element. -.PP -If the element has another attribute that has the same name as \fInewAttr\fR, this function replaces that attribute and returns it; otherwise the function returns a null attribute. -.PP -See also attributeNode(), setAttribute(), and setAttributeNodeNS(). -.SH "QDomAttr QDomElement::setAttributeNodeNS ( const QDomAttr & newAttr )" -Adds the attribute \fInewAttr\fR to this element. -.PP -If the element has another attribute that has the same local name and namespace URI as \fInewAttr\fR, this function replaces that attribute and returns it; otherwise the function returns a null attribute. -.PP -See also attributeNodeNS(), setAttributeNS(), and setAttributeNode(). -.SH "void QDomElement::setTagName ( const QString & name )" -Sets this element's tag name to \fIname\fR. -.PP -See also tagName(). -.SH "QString QDomElement::tagName () const" -Returns the tag name of this element. For an XML element like this: -.PP -.nf -.br - -.br -.fi -the tagname would return "img". -.PP -See also setTagName(). -.SH "QString QDomElement::text () const" -Returns the element's text or QString::null. -.PP -Example: -.PP -.nf -.br -

                Hello Qt ]]>

                -.br -.fi -.PP -The function text() of the QDomElement for the

                tag, will return "Hello Qt ". -.PP -Comments are ignored by this function. It only evaluates QDomText -and QDomCDATASection objects. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomelement.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomelement.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomentity.3qt b/doc/man/man3/qdomentity.3qt deleted file mode 100644 index 6812de461..000000000 --- a/doc/man/man3/qdomentity.3qt +++ /dev/null @@ -1,114 +0,0 @@ -'\" t -.TH QDomEntity 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 -QDomEntity \- Represents an XML entity -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomEntity\fR ()" -.br -.ti -1c -.BI "\fBQDomEntity\fR ( const QDomEntity & x )" -.br -.ti -1c -.BI "QDomEntity & \fBoperator=\fR ( const QDomEntity & x )" -.br -.ti -1c -.BI "\fB~QDomEntity\fR ()" -.br -.ti -1c -.BI "virtual QString \fBpublicId\fR () const" -.br -.ti -1c -.BI "virtual QString \fBsystemId\fR () const" -.br -.ti -1c -.BI "virtual QString \fBnotationName\fR () const" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisEntity\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomEntity class represents an XML entity. -.PP -This class represents an entity in an XML document, either parsed or unparsed. Note that this models the entity itself not the entity declaration. -.PP -DOM does not support editing entity nodes; if a user wants to make changes to the contents of an entity, every related QDomEntityReference node must be replaced in the DOM tree by a clone of the entity's contents, and then the desired changes must be made to each of the clones instead. All the descendents of an entity node are read-only. -.PP -An entity node does not have any parent. -.PP -You can access the entity's publicId(), systemId() and notationName() when available. -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomEntity::QDomEntity ()" -Constructs an empty entity. -.SH "QDomEntity::QDomEntity ( const QDomEntity & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomEntity::~QDomEntity ()" -Destroys the object and frees its resources. -.SH "bool QDomEntity::isEntity () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomEntity::nodeType () const\fC [virtual]\fR" -Returns EntityNode. -.PP -Reimplemented from QDomNode. -.SH "QString QDomEntity::notationName () const\fC [virtual]\fR" -For unparsed entities this function returns the name of the notation for the entity. For parsed entities this function returns QString::null. -.SH "QDomEntity & QDomEntity::operator= ( const QDomEntity & x )" -Assigns \fIx\fR to this DOM entity. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QString QDomEntity::publicId () const\fC [virtual]\fR" -Returns the public identifier associated with this entity. If the public identifier was not specified QString::null is returned. -.SH "QString QDomEntity::systemId () const\fC [virtual]\fR" -Returns the system identifier associated with this entity. If the -system identifier was not specified QString::null is returned. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomentity.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomentity.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomentityreference.3qt b/doc/man/man3/qdomentityreference.3qt deleted file mode 100644 index 5c04dac81..000000000 --- a/doc/man/man3/qdomentityreference.3qt +++ /dev/null @@ -1,100 +0,0 @@ -'\" t -.TH QDomEntityReference 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 -QDomEntityReference \- Represents an XML entity reference -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomEntityReference\fR ()" -.br -.ti -1c -.BI "\fBQDomEntityReference\fR ( const QDomEntityReference & x )" -.br -.ti -1c -.BI "QDomEntityReference & \fBoperator=\fR ( const QDomEntityReference & x )" -.br -.ti -1c -.BI "\fB~QDomEntityReference\fR ()" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisEntityReference\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomEntityReference class represents an XML entity reference. -.PP -A QDomEntityReference object may be inserted into the DOM tree when an entity reference is in the source document, or when the user wishes to insert an entity reference. -.PP -Note that character references and references to predefined entities are expanded by the XML processor so that characters are represented by their Unicode equivalent rather than by an entity reference. -.PP -Moreover, the XML processor may completely expand references to entities while building the DOM tree, instead of providing QDomEntityReference objects. -.PP -If it does provide such objects, then for a given entity reference node, it may be that there is no entity node representing the referenced entity; but if such an entity exists, then the child list of the entity reference node is the same as that of the entity node. As with the entity node, all descendents of the entity reference are read-only. -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomEntityReference::QDomEntityReference ()" -Constructs an empty entity reference. Use QDomDocument::createEntityReference() to create a entity reference with content. -.SH "QDomEntityReference::QDomEntityReference ( const QDomEntityReference & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomEntityReference::~QDomEntityReference ()" -Destroys the object and frees its resources. -.SH "bool QDomEntityReference::isEntityReference () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomEntityReference::nodeType () const\fC [virtual]\fR" -Returns \fCEntityReference\fR. -.PP -Reimplemented from QDomNode. -.SH "QDomEntityReference & QDomEntityReference::operator= ( const QDomEntityReference & x )" -Assigns \fIx\fR to this entity reference. -.PP -The data of the copy is shared (shallow copy): modifying one node -will also change the other. If you want to make a deep copy, use -cloneNode(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomentityreference.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomentityreference.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomimplementation.3qt b/doc/man/man3/qdomimplementation.3qt deleted file mode 100644 index d00a2c43e..000000000 --- a/doc/man/man3/qdomimplementation.3qt +++ /dev/null @@ -1,126 +0,0 @@ -'\" t -.TH QDomImplementation 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 -QDomImplementation \- Information about the features of the DOM implementation -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomImplementation\fR ()" -.br -.ti -1c -.BI "\fBQDomImplementation\fR ( const QDomImplementation & x )" -.br -.ti -1c -.BI "virtual \fB~QDomImplementation\fR ()" -.br -.ti -1c -.BI "QDomImplementation & \fBoperator=\fR ( const QDomImplementation & x )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QDomImplementation & x ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QDomImplementation & x ) const" -.br -.ti -1c -.BI "virtual bool \fBhasFeature\fR ( const QString & feature, const QString & version )" -.br -.ti -1c -.BI "virtual QDomDocumentType \fBcreateDocumentType\fR ( const QString & qName, const QString & publicId, const QString & systemId )" -.br -.ti -1c -.BI "virtual QDomDocument \fBcreateDocument\fR ( const QString & nsURI, const QString & qName, const QDomDocumentType & doctype )" -.br -.ti -1c -.BI "bool \fBisNull\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QDomImplementation class provides information about the features of the DOM implementation. -.PP -This class describes the features that are supported by the DOM implementation. Currently the XML subset of DOM Level 1 and DOM Level 2 Core are supported. -.PP -Normally you will use the function QDomDocument::implementation() to get the implementation object. -.PP -You can create a new document type with createDocumentType() and a new document with createDocument(). -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also hasFeature() and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomImplementation::QDomImplementation ()" -Constructs a QDomImplementation object. -.SH "QDomImplementation::QDomImplementation ( const QDomImplementation & x )" -Constructs a copy of \fIx\fR. -.SH "QDomImplementation::~QDomImplementation ()\fC [virtual]\fR" -Destroys the object and frees its resources. -.SH "QDomDocument QDomImplementation::createDocument ( const QString & nsURI, const QString & qName, const QDomDocumentType & doctype )\fC [virtual]\fR" -Creates a DOM document with the document type \fIdoctype\fR. This function also adds a root element node with the qualified name \fIqName\fR and the namespace URI \fInsURI\fR. -.SH "QDomDocumentType QDomImplementation::createDocumentType ( const QString & qName, const QString & publicId, const QString & systemId )\fC [virtual]\fR" -Creates a document type node for the name \fIqName\fR. -.PP -\fIpublicId\fR specifies the public identifier of the external subset. If you specify QString::null as the \fIpublicId\fR, this means that the document type has no public identifier. -.PP -\fIsystemId\fR specifies the system identifier of the external subset. If you specify QString::null as the \fIsystemId\fR, this means that the document type has no system identifier. -.PP -Since you cannot have a public identifier without a system identifier, the public identifier is set to QString::null if there is no system identifier. -.PP -DOM level 2 does not support any other document type declaration features. -.PP -The only way you can use a document type that was created this way, is in combination with the createDocument() function to create a QDomDocument with this document type. -.PP -See also createDocument(). -.SH "bool QDomImplementation::hasFeature ( const QString & feature, const QString & version )\fC [virtual]\fR" -The function returns TRUE if QDom implements the requested \fIversion\fR of a \fIfeature\fR; otherwise returns FALSE. -.PP -The currently supported features and their versions:
                .nf -.TS -l - l. Feature Version XML -.TE -.fi -
                -.SH "bool QDomImplementation::isNull ()" -Returns FALSE if the object was created by QDomDocument::implementation(); otherwise returns TRUE. -.SH "bool QDomImplementation::operator!= ( const QDomImplementation & x ) const" -Returns TRUE if \fIx\fR and this DOM implementation object were created from different QDomDocuments; otherwise returns FALSE. -.SH "QDomImplementation & QDomImplementation::operator= ( const QDomImplementation & x )" -Assigns \fIx\fR to this DOM implementation. -.SH "bool QDomImplementation::operator== ( const QDomImplementation & x ) const" -Returns TRUE if \fIx\fR and this DOM implementation object were -created from the same QDomDocument; otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomimplementation.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomimplementation.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomnamednodemap.3qt b/doc/man/man3/qdomnamednodemap.3qt deleted file mode 100644 index fb0aa17eb..000000000 --- a/doc/man/man3/qdomnamednodemap.3qt +++ /dev/null @@ -1,172 +0,0 @@ -'\" t -.TH QDomNamedNodeMap 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 -QDomNamedNodeMap \- Collection of nodes that can be accessed by name -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomNamedNodeMap\fR ()" -.br -.ti -1c -.BI "\fBQDomNamedNodeMap\fR ( const QDomNamedNodeMap & n )" -.br -.ti -1c -.BI "QDomNamedNodeMap & \fBoperator=\fR ( const QDomNamedNodeMap & n )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QDomNamedNodeMap & n ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QDomNamedNodeMap & n ) const" -.br -.ti -1c -.BI "\fB~QDomNamedNodeMap\fR ()" -.br -.ti -1c -.BI "QDomNode \fBnamedItem\fR ( const QString & name ) const" -.br -.ti -1c -.BI "QDomNode \fBsetNamedItem\fR ( const QDomNode & newNode )" -.br -.ti -1c -.BI "QDomNode \fBremoveNamedItem\fR ( const QString & name )" -.br -.ti -1c -.BI "QDomNode \fBitem\fR ( int index ) const" -.br -.ti -1c -.BI "QDomNode \fBnamedItemNS\fR ( const QString & nsURI, const QString & localName ) const" -.br -.ti -1c -.BI "QDomNode \fBsetNamedItemNS\fR ( const QDomNode & newNode )" -.br -.ti -1c -.BI "QDomNode \fBremoveNamedItemNS\fR ( const QString & nsURI, const QString & localName )" -.br -.ti -1c -.BI "uint \fBlength\fR () const" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QString & name ) const" -.br -.in -1c -.SH DESCRIPTION -The QDomNamedNodeMap class contains a collection of nodes that can be accessed by name. -.PP -Note that QDomNamedNodeMap does not inherit from QDomNodeList. QDomNamedNodeMaps do not provide any specific node ordering. Although nodes in a QDomNamedNodeMap may be accessed by an ordinal index, this is simply to allow a convenient enumeration of the contents of a QDomNamedNodeMap, and does not imply that the DOM specifies an ordering of the nodes. -.PP -The QDomNamedNodeMap is used in three places:
                  -.IP 1 -QDomDocumentType::entities() returns a map of all entities described in the DTD. -.IP 2 -QDomDocumentType::notations() returns a map of all notations described in the DTD. -.IP 3 -QDomNode::attributes() returns a map of all attributes of an element. -.PP -Items in the map are identified by the name which QDomNode::name() returns. Nodes are retrieved using namedItem(), namedItemNS() or item(). New nodes are inserted with setNamedItem() or setNamedItemNS() and removed with removeNamedItem() or removeNamedItemNS(). Use contains() to see if an item with the given name is in the named node map. The number of items is returned by length(). -.PP -Terminology: in this class we use "item" and "node" interchangeably. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomNamedNodeMap::QDomNamedNodeMap ()" -Constructs an empty named node map. -.SH "QDomNamedNodeMap::QDomNamedNodeMap ( const QDomNamedNodeMap & n )" -Constructs a copy of \fIn\fR. -.SH "QDomNamedNodeMap::~QDomNamedNodeMap ()" -Destroys the object and frees its resources. -.SH "bool QDomNamedNodeMap::contains ( const QString & name ) const" -Returns TRUE if the map contains a node called \fIname\fR; otherwise returns FALSE. -.SH "uint QDomNamedNodeMap::count () const" -Returns the number of nodes in the map. -.PP -This function is the same as length(). -.SH "QDomNode QDomNamedNodeMap::item ( int index ) const" -Retrieves the node at position \fIindex\fR. -.PP -This can be used to iterate over the map. Note that the nodes in the map are ordered arbitrarily. -.PP -See also length(). -.SH "uint QDomNamedNodeMap::length () const" -Returns the number of nodes in the map. -.PP -See also item(). -.SH "QDomNode QDomNamedNodeMap::namedItem ( const QString & name ) const" -Returns the node called \fIname\fR. -.PP -If the named node map does not contain such a node, a null node is returned. A node's name is the name returned by QDomNode::nodeName(). -.PP -See also setNamedItem() and namedItemNS(). -.SH "QDomNode QDomNamedNodeMap::namedItemNS ( const QString & nsURI, const QString & localName ) const" -Returns the node associated with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. -.PP -If the map does not contain such a node, a null node is returned. -.PP -See also setNamedItemNS() and namedItem(). -.SH "bool QDomNamedNodeMap::operator!= ( const QDomNamedNodeMap & n ) const" -Returns TRUE if \fIn\fR and this named node map are not equal; otherwise returns FALSE. -.SH "QDomNamedNodeMap & QDomNamedNodeMap::operator= ( const QDomNamedNodeMap & n )" -Assigns \fIn\fR to this named node map. -.SH "bool QDomNamedNodeMap::operator== ( const QDomNamedNodeMap & n ) const" -Returns TRUE if \fIn\fR and this named node map are equal; otherwise returns FALSE. -.SH "QDomNode QDomNamedNodeMap::removeNamedItem ( const QString & name )" -Removes the node called \fIname\fR from the map. -.PP -The function returns the removed node or a null node if the map did not contain a node called \fIname\fR. -.PP -See also setNamedItem(), namedItem(), and removeNamedItemNS(). -.SH "QDomNode QDomNamedNodeMap::removeNamedItemNS ( const QString & nsURI, const QString & localName )" -Removes the node with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR from the map. -.PP -The function returns the removed node or a null node if the map did not contain a node with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. -.PP -See also setNamedItemNS(), namedItemNS(), and removeNamedItem(). -.SH "QDomNode QDomNamedNodeMap::setNamedItem ( const QDomNode & newNode )" -Inserts the node \fInewNode\fR into the named node map. The name used by the map is the node name of \fInewNode\fR as returned by QDomNode::nodeName(). -.PP -If the new node replaces an existing node, i.e. the map contains a node with the same name, the replaced node is returned. -.PP -See also namedItem(), removeNamedItem(), and setNamedItemNS(). -.SH "QDomNode QDomNamedNodeMap::setNamedItemNS ( const QDomNode & newNode )" -Inserts the node \fInewNode\fR in the map. If a node with the same namespace URI and the same local name already exists in the map, it is replaced by \fInewNode\fR. If the new node replaces an existing node, the replaced node is returned. -.PP -See also namedItemNS(), removeNamedItemNS(), and setNamedItem(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomnamednodemap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomnamednodemap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomnode.3qt b/doc/man/man3/qdomnode.3qt deleted file mode 100644 index a4695a384..000000000 --- a/doc/man/man3/qdomnode.3qt +++ /dev/null @@ -1,733 +0,0 @@ -'\" t -.TH QDomNode 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 -QDomNode \- The base class for all the nodes in a DOM tree -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                  -.PP -\fC#include \fR -.PP -Inherited by QDomDocumentType, QDomDocument, QDomDocumentFragment, QDomCharacterData, QDomAttr, QDomElement, QDomNotation, QDomEntity, QDomEntityReference, and QDomProcessingInstruction. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBNodeType\fR { ElementNode = 1, AttributeNode = 2, TextNode = 3, CDATASectionNode = 4, EntityReferenceNode = 5, EntityNode = 6, ProcessingInstructionNode = 7, CommentNode = 8, DocumentNode = 9, DocumentTypeNode = 10, DocumentFragmentNode = 11, NotationNode = 12, BaseNode = 21, CharacterDataNode = 22 }" -.br -.ti -1c -.BI "\fBQDomNode\fR ()" -.br -.ti -1c -.BI "\fBQDomNode\fR ( const QDomNode & n )" -.br -.ti -1c -.BI "QDomNode & \fBoperator=\fR ( const QDomNode & n )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QDomNode & n ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QDomNode & n ) const" -.br -.ti -1c -.BI "virtual \fB~QDomNode\fR ()" -.br -.ti -1c -.BI "virtual QDomNode \fBinsertBefore\fR ( const QDomNode & newChild, const QDomNode & refChild )" -.br -.ti -1c -.BI "virtual QDomNode \fBinsertAfter\fR ( const QDomNode & newChild, const QDomNode & refChild )" -.br -.ti -1c -.BI "virtual QDomNode \fBreplaceChild\fR ( const QDomNode & newChild, const QDomNode & oldChild )" -.br -.ti -1c -.BI "virtual QDomNode \fBremoveChild\fR ( const QDomNode & oldChild )" -.br -.ti -1c -.BI "virtual QDomNode \fBappendChild\fR ( const QDomNode & newChild )" -.br -.ti -1c -.BI "virtual bool \fBhasChildNodes\fR () const" -.br -.ti -1c -.BI "virtual QDomNode \fBcloneNode\fR ( bool deep = TRUE ) const" -.br -.ti -1c -.BI "virtual void \fBnormalize\fR ()" -.br -.ti -1c -.BI "virtual bool \fBisSupported\fR ( const QString & feature, const QString & version ) const" -.br -.ti -1c -.BI "virtual QString \fBnodeName\fR () const" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual QDomNode \fBparentNode\fR () const" -.br -.ti -1c -.BI "virtual QDomNodeList \fBchildNodes\fR () const" -.br -.ti -1c -.BI "virtual QDomNode \fBfirstChild\fR () const" -.br -.ti -1c -.BI "virtual QDomNode \fBlastChild\fR () const" -.br -.ti -1c -.BI "virtual QDomNode \fBpreviousSibling\fR () const" -.br -.ti -1c -.BI "virtual QDomNode \fBnextSibling\fR () const" -.br -.ti -1c -.BI "virtual QDomNamedNodeMap \fBattributes\fR () const" -.br -.ti -1c -.BI "virtual QDomDocument \fBownerDocument\fR () const" -.br -.ti -1c -.BI "virtual QString \fBnamespaceURI\fR () const" -.br -.ti -1c -.BI "virtual QString \fBlocalName\fR () const" -.br -.ti -1c -.BI "virtual bool \fBhasAttributes\fR () const" -.br -.ti -1c -.BI "virtual QString \fBnodeValue\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNodeValue\fR ( const QString & v )" -.br -.ti -1c -.BI "virtual QString \fBprefix\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPrefix\fR ( const QString & pre )" -.br -.ti -1c -.BI "virtual bool \fBisAttr\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisCDATASection\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisDocumentFragment\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisDocument\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisDocumentType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisElement\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisEntityReference\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisText\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisEntity\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisNotation\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisProcessingInstruction\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisCharacterData\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisComment\fR () const" -.br -.ti -1c -.BI "QDomNode \fBnamedItem\fR ( const QString & name ) const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "QDomAttr \fBtoAttr\fR ()" -.br -.ti -1c -.BI "QDomCDATASection \fBtoCDATASection\fR ()" -.br -.ti -1c -.BI "QDomDocumentFragment \fBtoDocumentFragment\fR ()" -.br -.ti -1c -.BI "QDomDocument \fBtoDocument\fR ()" -.br -.ti -1c -.BI "QDomDocumentType \fBtoDocumentType\fR ()" -.br -.ti -1c -.BI "QDomElement \fBtoElement\fR ()" -.br -.ti -1c -.BI "QDomEntityReference \fBtoEntityReference\fR ()" -.br -.ti -1c -.BI "QDomText \fBtoText\fR ()" -.br -.ti -1c -.BI "QDomEntity \fBtoEntity\fR ()" -.br -.ti -1c -.BI "QDomNotation \fBtoNotation\fR ()" -.br -.ti -1c -.BI "QDomProcessingInstruction \fBtoProcessingInstruction\fR ()" -.br -.ti -1c -.BI "QDomCharacterData \fBtoCharacterData\fR ()" -.br -.ti -1c -.BI "QDomComment \fBtoComment\fR ()" -.br -.ti -1c -.BI "void \fBsave\fR ( QTextStream & str, int indent ) const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( QTextStream & str, const QDomNode & node )" -.br -.in -1c -.SH DESCRIPTION -The QDomNode class is the base class for all the nodes in a DOM tree. -.PP -Many functions in the DOM return a QDomNode. -.PP -You can find out the type of a node using isAttr(), isCDATASection(), isDocumentFragment(), isDocument(), isDocumentType(), isElement(), isEntityReference(), isText(), isEntity(), isNotation(), isProcessingInstruction(), isCharacterData() and isComment(). -.PP -A QDomNode can be converted into one of its subclasses using toAttr(), toCDATASection(), toDocumentFragment(), toDocument(), toDocumentType(), toElement(), toEntityReference(), toText(), toEntity(), toNotation(), toProcessingInstruction(), toCharacterData() or toComment(). You can convert a node to a null node with clear(). -.PP -Copies of the QDomNode class share their data using explicit sharing. This means that modifying one node will change all copies. This is especially useful in combination with functions which return a QDomNode, e.g. firstChild(). You can make an independent (deep) copy of the node with cloneNode(). -.PP -Nodes are inserted with insertBefore(), insertAfter() or appendChild(). You can replace one node with another using replaceChild() and remove a node with removeChild(). -.PP -To traverse nodes use firstChild() to get a node's first child (if any), and nextSibling() to traverse. QDomNode also provides lastChild(), previousSibling() and parentNode(). To find the first child node with a particular node name use namedItem(). -.PP -To find out if a node has children use hasChildNodes() and to get a list of all of a node's children use childNodes(). -.PP -The node's name and value (the meaning of which varies depending on its type) is returned by nodeName() and nodeValue() respectively. The node's type is returned by nodeType(). The node's value can be set with setNodeValue(). -.PP -The document to which the node belongs is returned by ownerDocument(). -.PP -Adjacent QDomText nodes can be merged into a single node with normalize(). -.PP -QDomElement nodes have attributes which can be retrieved with attributes(). -.PP -QDomElement and QDomAttr nodes can have namespaces which can be retrieved with namespaceURI(). Their local name is retrieved with localName(), and their prefix with prefix(). The prefix can be set with setPrefix(). -.PP -You can write the XML representation of the node to a text stream with save(). -.PP -The following example looks for the first element in an XML document and prints the names of all the elements that are its direct children. -.PP -.nf -.br - QDomDocument d; -.br - d.setContent( someXML ); -.br - QDomNode n = d.firstChild(); -.br - while ( !n.isNull() ) { -.br - if ( n.isElement() ) { -.br - QDomElement e = n.toElement(); -.br - cout << "Element name: " << e.tagName() << endl; -.br - break; -.br - } -.br - n = n.nextSibling(); -.br - } -.br -.fi -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SS "Member Type Documentation" -.SH "QDomNode::NodeType" -This enum defines the type of the node: -.TP -\fCQDomNode::ElementNode\fR -.TP -\fCQDomNode::AttributeNode\fR -.TP -\fCQDomNode::TextNode\fR -.TP -\fCQDomNode::CDATASectionNode\fR -.TP -\fCQDomNode::EntityReferenceNode\fR -.TP -\fCQDomNode::EntityNode\fR -.TP -\fCQDomNode::ProcessingInstructionNode\fR -.TP -\fCQDomNode::CommentNode\fR -.TP -\fCQDomNode::DocumentNode\fR -.TP -\fCQDomNode::DocumentTypeNode\fR -.TP -\fCQDomNode::DocumentFragmentNode\fR -.TP -\fCQDomNode::NotationNode\fR -.TP -\fCQDomNode::BaseNode\fR - A QDomNode object, i.e. not a QDomNode subclass. -.TP -\fCQDomNode::CharacterDataNode\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomNode::QDomNode ()" -Constructs a null node. -.SH "QDomNode::QDomNode ( const QDomNode & n )" -Constructs a copy of \fIn\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomNode::~QDomNode ()\fC [virtual]\fR" -Destroys the object and frees its resources. -.SH "QDomNode QDomNode::appendChild ( const QDomNode & newChild )\fC [virtual]\fR" -Appends \fInewChild\fR as the node's last child. -.PP -If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. -.PP -If \fInewChild\fR is a QDomDocumentFragment, then the children of the fragment are removed from the fragment and appended. -.PP -Returns a new reference to \fInewChild\fR. -.PP -See also insertBefore(), insertAfter(), replaceChild(), and removeChild(). -.SH "QDomNamedNodeMap QDomNode::attributes () const\fC [virtual]\fR" -Returns a named node map of all attributes. Attributes are only provided for QDomElements. -.PP -Changing the attributes in the map will also change the attributes of this QDomNode. -.PP -Reimplemented in QDomElement. -.SH "QDomNodeList QDomNode::childNodes () const\fC [virtual]\fR" -Returns a list of all direct child nodes. -.PP -Most often you will call this function on a QDomElement object. -.PP -For example, if the XML document looks like this: -.PP -.nf -.br - -.br -

                  Heading

                  -.br -

                  Hello you

                  -.br - -.br -.fi -Then the list of child nodes for the "body"-element will contain the node created by the

                  tag and the node created by the

                  tag. -.PP -The nodes in the list are not copied; so changing the nodes in the list will also change the children of this node. -.PP -See also firstChild() and lastChild(). -.SH "void QDomNode::clear ()" -Converts the node into a null node; if it was not a null node before, its type and contents are deleted. -.PP -See also isNull(). -.SH "QDomNode QDomNode::cloneNode ( bool deep = TRUE ) const\fC [virtual]\fR" -Creates a deep (not shallow) copy of the QDomNode. -.PP -If \fIdeep\fR is TRUE, then the cloning is done recursively which means that all the node's children are deep copied too. If \fIdeep\fR is FALSE only the node itself is copied and the copy will have no child nodes. -.SH "QDomNode QDomNode::firstChild () const\fC [virtual]\fR" -Returns the first child of the node. If there is no child node, a null node is returned. Changing the returned node will also change the node in the document tree. -.PP -See also lastChild() and childNodes(). -.PP -Example: xml/outliner/outlinetree.cpp. -.SH "bool QDomNode::hasAttributes () const\fC [virtual]\fR" -Returns TRUE if the node has attributes; otherwise returns FALSE. -.PP -See also attributes(). -.SH "bool QDomNode::hasChildNodes () const\fC [virtual]\fR" -Returns TRUE if the node has one or more children; otherwise returns FALSE. -.SH "QDomNode QDomNode::insertAfter ( const QDomNode & newChild, const QDomNode & refChild )\fC [virtual]\fR" -Inserts the node \fInewChild\fR after the child node \fIrefChild\fR. \fIrefChild\fR must be a direct child of this node. If \fIrefChild\fR is null then \fInewChild\fR is appended as this node's last child. -.PP -If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. -.PP -If \fInewChild\fR is a QDomDocumentFragment, then the children of the fragment are removed from the fragment and inserted after \fIrefChild\fR. -.PP -Returns a new reference to \fInewChild\fR on success or a null node on failure. -.PP -See also insertBefore(), replaceChild(), removeChild(), and appendChild(). -.SH "QDomNode QDomNode::insertBefore ( const QDomNode & newChild, const QDomNode & refChild )\fC [virtual]\fR" -Inserts the node \fInewChild\fR before the child node \fIrefChild\fR. \fIrefChild\fR must be a direct child of this node. If \fIrefChild\fR is null then \fInewChild\fR is inserted as the node's first child. -.PP -If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. -.PP -If \fInewChild\fR is a QDomDocumentFragment, then the children of the fragment are removed from the fragment and inserted before \fIrefChild\fR. -.PP -Returns a new reference to \fInewChild\fR on success or a null node on failure. -.PP -See also insertAfter(), replaceChild(), removeChild(), and appendChild(). -.SH "bool QDomNode::isAttr () const\fC [virtual]\fR" -Returns TRUE if the node is an attribute; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomAttribute; you can get the QDomAttribute with toAttribute(). -.PP -See also toAttr(). -.PP -Reimplemented in QDomAttr. -.SH "bool QDomNode::isCDATASection () const\fC [virtual]\fR" -Returns TRUE if the node is a CDATA section; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomCDATASection; you can get the QDomCDATASection with toCDATASection(). -.PP -See also toCDATASection(). -.PP -Reimplemented in QDomCDATASection. -.SH "bool QDomNode::isCharacterData () const\fC [virtual]\fR" -Returns TRUE if the node is a character data node; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomCharacterData; you can get the QDomCharacterData with toCharacterData(). -.PP -See also toCharacterData(). -.PP -Reimplemented in QDomCharacterData. -.SH "bool QDomNode::isComment () const\fC [virtual]\fR" -Returns TRUE if the node is a comment; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomComment; you can get the QDomComment with toComment(). -.PP -See also toComment(). -.PP -Reimplemented in QDomComment. -.SH "bool QDomNode::isDocument () const\fC [virtual]\fR" -Returns TRUE if the node is a document; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomDocument; you can get the QDomDocument with toDocument(). -.PP -See also toDocument(). -.PP -Reimplemented in QDomDocument. -.SH "bool QDomNode::isDocumentFragment () const\fC [virtual]\fR" -Returns TRUE if the node is a document fragment; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomDocumentFragment; you can get the QDomDocumentFragment with toDocumentFragment(). -.PP -See also toDocumentFragment(). -.PP -Reimplemented in QDomDocumentFragment. -.SH "bool QDomNode::isDocumentType () const\fC [virtual]\fR" -Returns TRUE if the node is a document type; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomDocumentType; you can get the QDomDocumentType with toDocumentType(). -.PP -See also toDocumentType(). -.PP -Reimplemented in QDomDocumentType. -.SH "bool QDomNode::isElement () const\fC [virtual]\fR" -Returns TRUE if the node is an element; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomElement; you can get the QDomElement with toElement(). -.PP -See also toElement(). -.PP -Example: xml/outliner/outlinetree.cpp. -.PP -Reimplemented in QDomElement. -.SH "bool QDomNode::isEntity () const\fC [virtual]\fR" -Returns TRUE if the node is an entity; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomEntity; you can get the QDomEntity with toEntity(). -.PP -See also toEntity(). -.PP -Reimplemented in QDomEntity. -.SH "bool QDomNode::isEntityReference () const\fC [virtual]\fR" -Returns TRUE if the node is an entity reference; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomEntityReference; you can get the QDomEntityReference with toEntityReference(). -.PP -See also toEntityReference(). -.PP -Reimplemented in QDomEntityReference. -.SH "bool QDomNode::isNotation () const\fC [virtual]\fR" -Returns TRUE if the node is a notation; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomNotation; you can get the QDomNotation with toNotation(). -.PP -See also toNotation(). -.PP -Reimplemented in QDomNotation. -.SH "bool QDomNode::isNull () const" -Returns TRUE if this node is null (i.e. if it has no type or contents); otherwise returns FALSE. -.PP -Example: xml/outliner/outlinetree.cpp. -.SH "bool QDomNode::isProcessingInstruction () const\fC [virtual]\fR" -Returns TRUE if the node is a processing instruction; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomProcessingInstruction; you can get the QProcessingInstruction with toProcessingInstruction(). -.PP -See also toProcessingInstruction(). -.PP -Reimplemented in QDomProcessingInstruction. -.SH "bool QDomNode::isSupported ( const QString & feature, const QString & version ) const\fC [virtual]\fR" -Returns TRUE if the DOM implementation implements the feature \fIfeature\fR and this feature is supported by this node in the version \fIversion\fR; otherwise returns FALSE. -.PP -See also QDomImplementation::hasFeature(). -.SH "bool QDomNode::isText () const\fC [virtual]\fR" -Returns TRUE if the node is a text node; otherwise returns FALSE. -.PP -If this function returns TRUE, it does not imply that this object is a QDomText; you can get the QDomText with toText(). -.PP -See also toText(). -.PP -Reimplemented in QDomText. -.SH "QDomNode QDomNode::lastChild () const\fC [virtual]\fR" -Returns the last child of the node. If there is no child node, a null node is returned. Changing the returned node will also change the node in the document tree. -.PP -See also firstChild() and childNodes(). -.SH "QString QDomNode::localName () const\fC [virtual]\fR" -If the node uses namespaces, this function returns the local name of the node; otherwise it returns QString::null. -.PP -Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace must have been specified at creation time; it is not possible to add a namespace afterwards. -.PP -See also prefix(), namespaceURI(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). -.SH "QDomNode QDomNode::namedItem ( const QString & name ) const" -Returns the first direct child node for which nodeName() equals \fIname\fR. -.PP -If no such direct child exists, a null node is returned. -.PP -See also nodeName(). -.SH "QString QDomNode::namespaceURI () const\fC [virtual]\fR" -Returns the namespace URI of this node or QString::null if the node has no namespace URI. -.PP -Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace URI must be specified at creation time and cannot be changed later. -.PP -See also prefix(), localName(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). -.SH "QDomNode QDomNode::nextSibling () const\fC [virtual]\fR" -Returns the next sibling in the document tree. Changing the returned node will also change the node in the document tree. -.PP -If you have XML like this: -.PP -.nf -.br -

                  Heading

                  -.br -

                  The text...

                  -.br -

                  Next heading

                  -.br -.fi -and this QDomNode represents the

                  tag, nextSibling() will return the node representing the

                  tag. -.PP -See also previousSibling(). -.PP -Example: xml/outliner/outlinetree.cpp. -.SH "QString QDomNode::nodeName () const\fC [virtual]\fR" -Returns the name of the node. -.PP -The meaning of the name depends on the subclass:
                  .nf -.TS -l - l. Name Meaning QDomAttr The name of the attribute QDomCDATASection The string "#cdata-section" QDomComment The string "#comment" QDomDocument The string "#document" QDomDocumentFragment The string "#document-fragment" QDomDocumentType The name of the document type QDomElement The tag name QDomEntity The name of the entity QDomEntityReference The name of the referenced entity QDomNotation The name of the notation QDomProcessingInstruction The target of the processing instruction QDomText -.TE -.fi -
                  -.PP -See also nodeValue(). -.PP -Example: xml/outliner/outlinetree.cpp. -.SH "QDomNode::NodeType QDomNode::nodeType () const\fC [virtual]\fR" -Returns the type of the node. -.PP -See also toAttr(), toCDATASection(), toDocumentFragment(), toDocument(), toDocumentType(), toElement(), toEntityReference(), toText(), toEntity(), toNotation(), toProcessingInstruction(), toCharacterData(), and toComment(). -.PP -Reimplemented in QDomDocumentType, QDomDocument, QDomDocumentFragment, QDomCharacterData, QDomAttr, QDomElement, QDomNotation, QDomEntity, QDomEntityReference, and QDomProcessingInstruction. -.SH "QString QDomNode::nodeValue () const\fC [virtual]\fR" -Returns the value of the node. -.PP -The meaning of the value depends on the subclass:
                  .nf -.TS -l - l. Name Meaning QDomAttr The attribute value QDomCDATASection The content of the CDATA section QDomComment The comment QDomProcessingInstruction The data of the processing intruction QDomText -.TE -.fi -
                  -.PP -All the other subclasses do not have a node value and will return QString::null. -.PP -See also setNodeValue() and nodeName(). -.PP -Example: xml/outliner/outlinetree.cpp. -.SH "void QDomNode::normalize ()\fC [virtual]\fR" -Calling normalize() on an element converts all its children into a standard form. This means that adjacent QDomText objects will be merged into a single text object (QDomCDATASection nodes are not merged). -.SH "bool QDomNode::operator!= ( const QDomNode & n ) const" -Returns TRUE if \fIn\fR and this DOM node are not equal; otherwise returns FALSE. -.SH "QDomNode & QDomNode::operator= ( const QDomNode & n )" -Assigns a copy of \fIn\fR to this DOM node. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "bool QDomNode::operator== ( const QDomNode & n ) const" -Returns TRUE if \fIn\fR and this DOM node are equal; otherwise returns FALSE. -.SH "QDomDocument QDomNode::ownerDocument () const\fC [virtual]\fR" -Returns the document to which this node belongs. -.SH "QDomNode QDomNode::parentNode () const\fC [virtual]\fR" -Returns the parent node. If this node has no parent, a null node is returned (i.e. a node for which isNull() returns TRUE). -.SH "QString QDomNode::prefix () const\fC [virtual]\fR" -Returns the namespace prefix of the node or QString::null if the node has no namespace prefix. -.PP -Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace prefix must be specified at creation time. If a node was created with a namespace prefix, you can change it later with setPrefix(). -.PP -If you create an element or attribute with QDomDocument::createElement() or QDomDocument::createAttribute(), the prefix will be QString::null. If you use QDomDocument::createElementNS() or QDomDocument::createAttributeNS() instead, the prefix will not be QString::null; but it might be an empty string if the name does not have a prefix. -.PP -See also setPrefix(), localName(), namespaceURI(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). -.SH "QDomNode QDomNode::previousSibling () const\fC [virtual]\fR" -Returns the previous sibling in the document tree. Changing the returned node will also change the node in the document tree. -.PP -For example, if you have XML like this: -.PP -.nf -.br -

                  Heading

                  -.br -

                  The text...

                  -.br -

                  Next heading

                  -.br -.fi -and this QDomNode represents the

                  tag, previousSibling() will return the node representing the

                  tag. -.PP -See also nextSibling(). -.SH "QDomNode QDomNode::removeChild ( const QDomNode & oldChild )\fC [virtual]\fR" -Removes \fIoldChild\fR from the list of children. \fIoldChild\fR must be a direct child of this node. -.PP -Returns a new reference to \fIoldChild\fR on success or a null node on failure. -.PP -See also insertBefore(), insertAfter(), replaceChild(), and appendChild(). -.SH "QDomNode QDomNode::replaceChild ( const QDomNode & newChild, const QDomNode & oldChild )\fC [virtual]\fR" -Replaces \fIoldChild\fR with \fInewChild\fR. \fIoldChild\fR must be a direct child of this node. -.PP -If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. -.PP -If \fInewChild\fR is a QDomDocumentFragment, then \fIoldChild\fR is replaced by all of the children of the fragment. -.PP -Returns a new reference to \fIoldChild\fR on success or a null node an failure. -.PP -See also insertBefore(), insertAfter(), removeChild(), and appendChild(). -.SH "void QDomNode::save ( QTextStream & str, int indent ) const" -Writes the XML representation of the node and all its children to the stream \fIstr\fR. This function uses \fIindent\fR as the amount of space to indent the node. -.SH "void QDomNode::setNodeValue ( const QString & v )\fC [virtual]\fR" -Sets the node's value to \fIv\fR. -.PP -See also nodeValue(). -.SH "void QDomNode::setPrefix ( const QString & pre )\fC [virtual]\fR" -If the node has a namespace prefix, this function changes the namespace prefix of the node to \fIpre\fR. Otherwise this function does nothing. -.PP -Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace prefix must have be specified at creation time; it is not possible to add a namespace prefix afterwards. -.PP -See also prefix(), localName(), namespaceURI(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). -.SH "QDomAttr QDomNode::toAttr ()" -Converts a QDomNode into a QDomAttr. If the node is not an attribute, the returned object will be null. -.PP -See also isAttr(). -.SH "QDomCDATASection QDomNode::toCDATASection ()" -Converts a QDomNode into a QDomCDATASection. If the node is not a CDATA section, the returned object will be null. -.PP -See also isCDATASection(). -.SH "QDomCharacterData QDomNode::toCharacterData ()" -Converts a QDomNode into a QDomCharacterData. If the node is not a character data node the returned object will be null. -.PP -See also isCharacterData(). -.SH "QDomComment QDomNode::toComment ()" -Converts a QDomNode into a QDomComment. If the node is not a comment the returned object will be null. -.PP -See also isComment(). -.SH "QDomDocument QDomNode::toDocument ()" -Converts a QDomNode into a QDomDocument. If the node is not a document the returned object will be null. -.PP -See also isDocument(). -.SH "QDomDocumentFragment QDomNode::toDocumentFragment ()" -Converts a QDomNode into a QDomDocumentFragment. If the node is not a document fragment the returned object will be null. -.PP -See also isDocumentFragment(). -.SH "QDomDocumentType QDomNode::toDocumentType ()" -Converts a QDomNode into a QDomDocumentType. If the node is not a document type the returned object will be null. -.PP -See also isDocumentType(). -.SH "QDomElement QDomNode::toElement ()" -Converts a QDomNode into a QDomElement. If the node is not an element the returned object will be null. -.PP -See also isElement(). -.PP -Example: xml/outliner/outlinetree.cpp. -.SH "QDomEntity QDomNode::toEntity ()" -Converts a QDomNode into a QDomEntity. If the node is not an entity the returned object will be null. -.PP -See also isEntity(). -.SH "QDomEntityReference QDomNode::toEntityReference ()" -Converts a QDomNode into a QDomEntityReference. If the node is not an entity reference, the returned object will be null. -.PP -See also isEntityReference(). -.SH "QDomNotation QDomNode::toNotation ()" -Converts a QDomNode into a QDomNotation. If the node is not a notation the returned object will be null. -.PP -See also isNotation(). -.SH "QDomProcessingInstruction QDomNode::toProcessingInstruction ()" -Converts a QDomNode into a QDomProcessingInstruction. If the node is not a processing instruction the returned object will be null. -.PP -See also isProcessingInstruction(). -.SH "QDomText QDomNode::toText ()" -Converts a QDomNode into a QDomText. If the node is not a text, the returned object will be null. -.PP -See also isText(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QTextStream & operator<< ( QTextStream & str, const QDomNode & node )" -Writes the XML representation of the node \fInode\fR and all its -children to the stream \fIstr\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomnode.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomnode.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomnodelist.3qt b/doc/man/man3/qdomnodelist.3qt deleted file mode 100644 index d06ef1045..000000000 --- a/doc/man/man3/qdomnodelist.3qt +++ /dev/null @@ -1,108 +0,0 @@ -'\" t -.TH QDomNodeList 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 -QDomNodeList \- List of QDomNode objects -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                  -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomNodeList\fR ()" -.br -.ti -1c -.BI "\fBQDomNodeList\fR ( const QDomNodeList & n )" -.br -.ti -1c -.BI "QDomNodeList & \fBoperator=\fR ( const QDomNodeList & n )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QDomNodeList & n ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QDomNodeList & n ) const" -.br -.ti -1c -.BI "virtual \fB~QDomNodeList\fR ()" -.br -.ti -1c -.BI "virtual QDomNode \fBitem\fR ( int index ) const" -.br -.ti -1c -.BI "virtual uint \fBlength\fR () const" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomNodeList class is a list of QDomNode objects. -.PP -Lists can be obtained by QDomDocument::elementsByTagName() and QDomNode::childNodes(). The Document Object Model (DOM) requires these lists to be "live": whenever you change the underlying document, the contents of the list will get updated. -.PP -You can get a particular node from the list with item(). The number of items in the list is returned by count() (and by length()). -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also QDomNode::childNodes(), QDomDocument::elementsByTagName(), and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomNodeList::QDomNodeList ()" -Creates an empty node list. -.SH "QDomNodeList::QDomNodeList ( const QDomNodeList & n )" -Constructs a copy of \fIn\fR. -.SH "QDomNodeList::~QDomNodeList ()\fC [virtual]\fR" -Destroys the object and frees its resources. -.SH "uint QDomNodeList::count () const" -Returns the number of nodes in the list. -.PP -This function is the same as length(). -.SH "QDomNode QDomNodeList::item ( int index ) const\fC [virtual]\fR" -Returns the node at position \fIindex\fR. -.PP -If \fIindex\fR is negative or if \fIindex\fR >= length() then a null node is returned (i.e. a node for which QDomNode::isNull() returns TRUE). -.PP -See also count(). -.SH "uint QDomNodeList::length () const\fC [virtual]\fR" -Returns the number of nodes in the list. -.PP -This function is the same as count(). -.SH "bool QDomNodeList::operator!= ( const QDomNodeList & n ) const" -Returns TRUE the node list \fIn\fR and this node list are not equal; otherwise returns FALSE. -.SH "QDomNodeList & QDomNodeList::operator= ( const QDomNodeList & n )" -Assigns \fIn\fR to this node list. -.SH "bool QDomNodeList::operator== ( const QDomNodeList & n ) const" -Returns TRUE if the node list \fIn\fR and this node list are equal; -otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomnodelist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomnodelist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomnotation.3qt b/doc/man/man3/qdomnotation.3qt deleted file mode 100644 index 503ddb635..000000000 --- a/doc/man/man3/qdomnotation.3qt +++ /dev/null @@ -1,108 +0,0 @@ -'\" t -.TH QDomNotation 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 -QDomNotation \- Represents an XML notation -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                  -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomNotation\fR ()" -.br -.ti -1c -.BI "\fBQDomNotation\fR ( const QDomNotation & x )" -.br -.ti -1c -.BI "QDomNotation & \fBoperator=\fR ( const QDomNotation & x )" -.br -.ti -1c -.BI "\fB~QDomNotation\fR ()" -.br -.ti -1c -.BI "QString \fBpublicId\fR () const" -.br -.ti -1c -.BI "QString \fBsystemId\fR () const" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisNotation\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomNotation class represents an XML notation. -.PP -A notation either declares, by name, the format of an unparsed entity (see section 4.7 of the XML 1.0 specification), or is used for formal declaration of processing instruction targets (see section 2.6 of the XML 1.0 specification). -.PP -DOM does not support editing notation nodes; they are therefore read-only. -.PP -A notation node does not have any parent. -.PP -You can retrieve the publicId() and systemId() from a notation node. -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomNotation::QDomNotation ()" -Constructor. -.SH "QDomNotation::QDomNotation ( const QDomNotation & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomNotation::~QDomNotation ()" -Destroys the object and frees its resources. -.SH "bool QDomNotation::isNotation () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomNotation::nodeType () const\fC [virtual]\fR" -Returns NotationNode. -.PP -Reimplemented from QDomNode. -.SH "QDomNotation & QDomNotation::operator= ( const QDomNotation & x )" -Assigns \fIx\fR to this DOM notation. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QString QDomNotation::publicId () const" -Returns the public identifier of this notation. -.SH "QString QDomNotation::systemId () const" -Returns the system identifier of this notation. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomnotation.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomnotation.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomprocessinginstruction.3qt b/doc/man/man3/qdomprocessinginstruction.3qt deleted file mode 100644 index 21c8eb4d5..000000000 --- a/doc/man/man3/qdomprocessinginstruction.3qt +++ /dev/null @@ -1,115 +0,0 @@ -'\" t -.TH QDomProcessingInstruction 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 -QDomProcessingInstruction \- Represents an XML processing instruction -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                  -.PP -\fC#include \fR -.PP -Inherits QDomNode. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomProcessingInstruction\fR ()" -.br -.ti -1c -.BI "\fBQDomProcessingInstruction\fR ( const QDomProcessingInstruction & x )" -.br -.ti -1c -.BI "QDomProcessingInstruction & \fBoperator=\fR ( const QDomProcessingInstruction & x )" -.br -.ti -1c -.BI "\fB~QDomProcessingInstruction\fR ()" -.br -.ti -1c -.BI "virtual QString \fBtarget\fR () const" -.br -.ti -1c -.BI "virtual QString \fBdata\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetData\fR ( const QString & d )" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisProcessingInstruction\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomProcessingInstruction class represents an XML processing instruction. -.PP -Processing instructions are used in XML to keep processor-specific information in the text of the document. -.PP -The content of the processing instruction is retrieved with data() and set with setData(). The processing instruction's target is retrieved with target(). -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomProcessingInstruction::QDomProcessingInstruction ()" -Constructs an empty processing instruction. Use QDomDocument::createProcessingInstruction() to create a processing instruction with content. -.SH "QDomProcessingInstruction::QDomProcessingInstruction ( const QDomProcessingInstruction & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomProcessingInstruction::~QDomProcessingInstruction ()" -Destroys the object and frees its resources. -.SH "QString QDomProcessingInstruction::data () const\fC [virtual]\fR" -Returns the content of this processing instruction. -.PP -See also setData() and target(). -.SH "bool QDomProcessingInstruction::isProcessingInstruction () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomProcessingInstruction::nodeType () const\fC [virtual]\fR" -Returns ProcessingInstructionNode. -.PP -Reimplemented from QDomNode. -.SH "QDomProcessingInstruction & QDomProcessingInstruction::operator= ( const QDomProcessingInstruction & x )" -Assigns \fIx\fR to this processing instruction. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "void QDomProcessingInstruction::setData ( const QString & d )\fC [virtual]\fR" -Sets the data contained in the processing instruction to \fId\fR. -.PP -See also data(). -.SH "QString QDomProcessingInstruction::target () const\fC [virtual]\fR" -Returns the target of this processing instruction. -.PP -See also data(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomprocessinginstruction.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomprocessinginstruction.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdomtext.3qt b/doc/man/man3/qdomtext.3qt deleted file mode 100644 index ffc3ba687..000000000 --- a/doc/man/man3/qdomtext.3qt +++ /dev/null @@ -1,107 +0,0 @@ -'\" t -.TH QDomText 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 -QDomText \- Represents text data in the parsed XML document -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                  -.PP -\fC#include \fR -.PP -Inherits QDomCharacterData. -.PP -Inherited by QDomCDATASection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDomText\fR ()" -.br -.ti -1c -.BI "\fBQDomText\fR ( const QDomText & x )" -.br -.ti -1c -.BI "QDomText & \fBoperator=\fR ( const QDomText & x )" -.br -.ti -1c -.BI "\fB~QDomText\fR ()" -.br -.ti -1c -.BI "QDomText \fBsplitText\fR ( int offset )" -.br -.ti -1c -.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisText\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QDomText class represents text data in the parsed XML document. -.PP -You can split the text in a QDomText object over two QDomText objecs with splitText(). -.PP -For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDomText::QDomText ()" -Constructs an empty QDomText object. -.PP -To construct a QDomText with content, use QDomDocument::createTextNode(). -.SH "QDomText::QDomText ( const QDomText & x )" -Constructs a copy of \fIx\fR. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomText::~QDomText ()" -Destroys the object and frees its resources. -.SH "bool QDomText::isText () const\fC [virtual]\fR" -Returns TRUE. -.PP -Reimplemented from QDomNode. -.SH "QDomNode::NodeType QDomText::nodeType () const\fC [virtual]\fR" -Returns TextNode. -.PP -Reimplemented from QDomCharacterData. -.PP -Reimplemented in QDomCDATASection. -.SH "QDomText & QDomText::operator= ( const QDomText & x )" -Assigns \fIx\fR to this DOM text. -.PP -The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). -.SH "QDomText QDomText::splitText ( int offset )" -Splits this DOM text object into two QDomText objects. This object keeps its first \fIoffset\fR characters and the second (newly created) object is inserted into the document tree after this object with the remaining characters. -.PP -The function returns the newly created object. -.PP -See also QDomNode::normalize(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdomtext.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdomtext.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdoublevalidator.3qt b/doc/man/man3/qdoublevalidator.3qt deleted file mode 100644 index 16c8e734d..000000000 --- a/doc/man/man3/qdoublevalidator.3qt +++ /dev/null @@ -1,146 +0,0 @@ -'\" t -.TH QDoubleValidator 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 -QDoubleValidator \- Range checking of floating-point numbers -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QValidator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDoubleValidator\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQDoubleValidator\fR ( double bottom, double top, int decimals, QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QDoubleValidator\fR ()" -.br -.ti -1c -.BI "virtual QValidator::State \fBvalidate\fR ( QString & input, int & ) const" -.br -.ti -1c -.BI "virtual void \fBsetRange\fR ( double minimum, double maximum, int decimals = 0 )" -.br -.ti -1c -.BI "void \fBsetBottom\fR ( double )" -.br -.ti -1c -.BI "void \fBsetTop\fR ( double )" -.br -.ti -1c -.BI "void \fBsetDecimals\fR ( int )" -.br -.ti -1c -.BI "double \fBbottom\fR () const" -.br -.ti -1c -.BI "double \fBtop\fR () const" -.br -.ti -1c -.BI "int \fBdecimals\fR () const" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "double \fBbottom\fR - the validator's minimum acceptable value" -.br -.ti -1c -.BI "int \fBdecimals\fR - the validator's maximum number of digits after the decimal point" -.br -.ti -1c -.BI "double \fBtop\fR - the validator's maximum acceptable value" -.br -.in -1c -.SH DESCRIPTION -The QDoubleValidator class provides range checking of floating-point numbers. -.PP -QDoubleValidator provides an upper bound, a lower bound and a limit on the number of digits after the decimal point. It does not provide a fixup() function. -.PP -You can set the acceptable range in one call with setRange(), or with setBottom() and setTop(). Set the number of decimal places with setDecimals(). The validate() function returns the validation state. -.PP -See also QIntValidator, QRegExpValidator, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDoubleValidator::QDoubleValidator ( QObject * parent, const char * name = 0 )" -Constructs a validator object with parent \fIparent\fR, called \fIname\fR, which accepts any double. -.SH "QDoubleValidator::QDoubleValidator ( double bottom, double top, int decimals, QObject * parent, const char * name = 0 )" -Constructs a validator object with parent \fIparent\fR, called \fIname\fR. This validator will accept doubles from \fIbottom\fR to \fItop\fR inclusive, with up to \fIdecimals\fR digits after the decimal point. -.SH "QDoubleValidator::~QDoubleValidator ()" -Destroys the validator, freeing any resources used. -.SH "double QDoubleValidator::bottom () const" -Returns the validator's minimum acceptable value. See the "bottom" property for details. -.SH "int QDoubleValidator::decimals () const" -Returns the validator's maximum number of digits after the decimal point. See the "decimals" property for details. -.SH "void QDoubleValidator::setBottom ( double )" -Sets the validator's minimum acceptable value. See the "bottom" property for details. -.SH "void QDoubleValidator::setDecimals ( int )" -Sets the validator's maximum number of digits after the decimal point. See the "decimals" property for details. -.SH "void QDoubleValidator::setRange ( double minimum, double maximum, int decimals = 0 )\fC [virtual]\fR" -Sets the validator to accept doubles from \fIminimum\fR to \fImaximum\fR inclusive, with at most \fIdecimals\fR digits after the decimal point. -.SH "void QDoubleValidator::setTop ( double )" -Sets the validator's maximum acceptable value. See the "top" property for details. -.SH "double QDoubleValidator::top () const" -Returns the validator's maximum acceptable value. See the "top" property for details. -.SH "QValidator::State QDoubleValidator::validate ( QString & input, int & ) const\fC [virtual]\fR" -Returns Acceptable if the string \fIinput\fR contains a double that is within the valid range and is in the correct format. -.PP -Returns Intermediate if \fIinput\fR contains a double that is outside the range or is in the wrong format, e.g. with too many digits after the decimal point or is empty. -.PP -Returns Invalid if the \fIinput\fR is not a double. -.PP -Note: If the valid range consists of just positive doubles (e.g. 0.0 - 100.0) and \fIinput\fR is a negative double then Invalid is returned. -.PP -Reimplemented from QValidator. -.SS "Property Documentation" -.SH "double bottom" -This property holds the validator's minimum acceptable value. -.PP -Set this property's value with setBottom() and get this property's value with bottom(). -.PP -See also setRange(). -.SH "int decimals" -This property holds the validator's maximum number of digits after the decimal point. -.PP -Set this property's value with setDecimals() and get this property's value with decimals(). -.PP -See also setRange(). -.SH "double top" -This property holds the validator's maximum acceptable value. -.PP -Set this property's value with setTop() and get this property's value with top(). -.PP -See also setRange(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdoublevalidator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdoublevalidator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdragenterevent.3qt b/doc/man/man3/qdragenterevent.3qt deleted file mode 100644 index def1a8571..000000000 --- a/doc/man/man3/qdragenterevent.3qt +++ /dev/null @@ -1,58 +0,0 @@ -'\" t -.TH QDragEnterEvent 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 -QDragEnterEvent \- Event which is sent to the widget when a drag and drop first drags onto the widget -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDragMoveEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDragEnterEvent\fR ( const QPoint & pos )" -.br -.in -1c -.SH DESCRIPTION -The QDragEnterEvent class provides an event which is sent to the widget when a drag and drop first drags onto the widget. -.PP -This event is always immediately followed by a QDragMoveEvent, so you only need to respond to one or the other event. This class inherits most of its functionality from QDragMoveEvent, which in turn inherits most of its functionality from QDropEvent. -.PP -See also QDragLeaveEvent, QDragMoveEvent, QDropEvent, Drag And Drop Classes, and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDragEnterEvent::QDragEnterEvent ( const QPoint & pos )" -Constructs a QDragEnterEvent entering at the given point, \fIpos\fR. -.PP -\fBWarning:\fR Do not create a QDragEnterEvent yourself since these -objects rely on Qt's internal state. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdragenterevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdragenterevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdragleaveevent.3qt b/doc/man/man3/qdragleaveevent.3qt deleted file mode 100644 index 6a4b5570c..000000000 --- a/doc/man/man3/qdragleaveevent.3qt +++ /dev/null @@ -1,58 +0,0 @@ -'\" t -.TH QDragLeaveEvent 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 -QDragLeaveEvent \- Event which is sent to the widget when a drag and drop leaves the widget -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDragLeaveEvent\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QDragLeaveEvent class provides an event which is sent to the widget when a drag and drop leaves the widget. -.PP -This event is always preceded by a QDragEnterEvent and a series of QDragMoveEvents. It is not sent if a QDropEvent is sent instead. -.PP -See also QDragEnterEvent, QDragMoveEvent, QDropEvent, Drag And Drop Classes, and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDragLeaveEvent::QDragLeaveEvent ()" -Constructs a QDragLeaveEvent. -.PP -\fBWarning:\fR Do not create a QDragLeaveEvent yourself since these -objects rely on Qt's internal state. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdragleaveevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdragleaveevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdragmoveevent.3qt b/doc/man/man3/qdragmoveevent.3qt deleted file mode 100644 index 7e381efd9..000000000 --- a/doc/man/man3/qdragmoveevent.3qt +++ /dev/null @@ -1,83 +0,0 @@ -'\" t -.TH QDragMoveEvent 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 -QDragMoveEvent \- Event which is sent while a drag and drop is in progress -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDropEvent. -.PP -Inherited by QDragEnterEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDragMoveEvent\fR ( const QPoint & pos, Type type = DragMove )" -.br -.ti -1c -.BI "QRect \fBanswerRect\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBignore\fR ( const QRect & r )" -.br -.in -1c -.SH DESCRIPTION -The QDragMoveEvent class provides an event which is sent while a drag and drop is in progress. -.PP -When a widget accepts drop events, it will receive this event repeatedly while the drag is within the widget's boundaries. The widget should examine the event to see what data it provides, and accept() the drop if appropriate. -.PP -Note that this class inherits most of its functionality from QDropEvent. -.PP -See also Drag And Drop Classes and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDragMoveEvent::QDragMoveEvent ( const QPoint & pos, Type type = DragMove )" -Creates a QDragMoveEvent for which the mouse is at point \fIpos\fR, and the event is of type \fItype\fR. -.PP -\fBWarning:\fR Do not create a QDragMoveEvent yourself since these objects rely on Qt's internal state. -.SH "void QDragMoveEvent::accept ( const QRect & r )" -The same as accept(), but also notifies that future moves will also be acceptable if they remain within the rectangle \fIr\fR on the widget: this can improve performance, but may also be ignored by the underlying system. -.PP -If the rectangle is empty, then drag move events will be sent continuously. This is useful if the source is scrolling in a timer event. -.PP -Examples: -.)l desktop/desktop.cpp and dirview/dirview.cpp. -.SH "QRect QDragMoveEvent::answerRect () const" -Returns the rectangle for which the acceptance of the move event applies. -.SH "void QDragMoveEvent::ignore ( const QRect & r )" -The opposite of accept(const QRect&), i.e. says that moves within rectangle \fIr\fR are not acceptable (will be ignored). -.PP -Example: dirview/dirview.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdragmoveevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdragmoveevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdragobject.3qt b/doc/man/man3/qdragobject.3qt deleted file mode 100644 index d2fd24830..000000000 --- a/doc/man/man3/qdragobject.3qt +++ /dev/null @@ -1,182 +0,0 @@ -'\" t -.TH QDragObject 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 -QDragObject \- Encapsulates MIME-based data transfer -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject and QMimeSource. -.PP -Inherited by QStoredDrag, QTextDrag, QImageDrag, and QIconDrag. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDragObject\fR ( QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QDragObject\fR ()" -.br -.ti -1c -.BI "bool \fBdrag\fR ()" -.br -.ti -1c -.BI "bool \fBdragMove\fR ()" -.br -.ti -1c -.BI "void \fBdragCopy\fR ()" -.br -.ti -1c -.BI "void \fBdragLink\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( QPixmap pm )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( QPixmap pm, const QPoint & hotspot )" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR () const" -.br -.ti -1c -.BI "QPoint \fBpixmapHotSpot\fR () const" -.br -.ti -1c -.BI "QWidget * \fBsource\fR ()" -.br -.ti -1c -.BI "enum \fBDragMode\fR { DragDefault, DragCopy, DragMove, DragLink, DragCopyOrMove }" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QWidget * \fBtarget\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBdrag\fR ( DragMode mode )" -.br -.in -1c -.SH DESCRIPTION -The QDragObject class encapsulates MIME-based data transfer. -.PP -QDragObject is the base class for all data that needs to be transferred between and within applications, both for drag and drop and for the clipboard. -.PP -See the Drag-and-drop documentation for an overview of how to provide drag and drop in your application. -.PP -See the QClipboard documentation for an overview of how to provide cut-and-paste in your application. -.PP -The drag() function is used to start a drag operation. You can specify the DragMode in the call or use one of the convenience functions dragCopy(), dragMove() or dragLink(). The drag source where the data originated is retrieved with source(). If the data was dropped on a widget within the application, target() will return a pointer to that widget. Specify the pixmap to display during the drag with setPixmap(). -.PP -See also Drag And Drop Classes. -.SS "Member Type Documentation" -.SH "QDragObject::DragMode" -This enum describes the possible drag modes. -.TP -\fCQDragObject::DragDefault\fR - The mode is determined heuristically. -.TP -\fCQDragObject::DragCopy\fR - The data is copied, never moved. -.TP -\fCQDragObject::DragMove\fR - The data is moved, if dragged at all. -.TP -\fCQDragObject::DragLink\fR - The data is linked, if dragged at all. -.TP -\fCQDragObject::DragCopyOrMove\fR - The user chooses the mode by using a control key to switch from the default. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDragObject::QDragObject ( QWidget * dragSource = 0, const char * name = 0 )" -Constructs a drag object called \fIname\fR, which is a child of \fIdragSource\fR. -.PP -Note that the drag object will be deleted when \fIdragSource\fR is deleted. -.SH "QDragObject::~QDragObject ()\fC [virtual]\fR" -Destroys the drag object, canceling any drag and drop operation in which it is involved, and frees up the storage used. -.SH "bool QDragObject::drag ()" -Starts a drag operation using the contents of this object, using DragDefault mode. -.PP -The function returns TRUE if the caller should delete the original copy of the dragged data (but see target()); otherwise returns FALSE. -.PP -If the drag contains \fIreferences\fR to information (e.g. file names in a QUriDrag are references) then the return value should always be ignored, as the target is expected to manipulate the referred-to content directly. On X11 the return value should always be correct anyway, but on Windows this is not necessarily the case (e.g. the file manager starts a background process to move files, so the source \fImust not\fR delete the files!) -.PP -Note that on Windows the drag operation will spin a blocking modal event loop that will not dispatch any QTimers. -.PP -Example: dirview/dirview.cpp. -.SH "bool QDragObject::drag ( DragMode mode )\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Starts a drag operation using the contents of this object. -.PP -At this point, the object becomes owned by Qt, not the application. You should not delete the drag object or anything it references. The actual transfer of data to the target application will be done during future event processing - after that time the drag object will be deleted. -.PP -Returns TRUE if the dragged data was dragged as a \fImove\fR, indicating that the caller should remove the original source of the data (the drag object must continue to have a copy); otherwise returns FALSE. -.PP -The \fImode\fR specifies the drag mode (see QDragObject::DragMode.) Normally one of the simpler drag(), dragMove(), or dragCopy() functions would be used instead. -.SH "void QDragObject::dragCopy ()" -Starts a drag operation using the contents of this object, using DragCopy mode. Be sure to read the constraints described in drag(). -.PP -See also drag(), dragMove(), and dragLink(). -.PP -Example: iconview/simple_dd/main.cpp. -.SH "void QDragObject::dragLink ()" -Starts a drag operation using the contents of this object, using DragLink mode. Be sure to read the constraints described in drag(). -.PP -See also drag(), dragCopy(), and dragMove(). -.SH "bool QDragObject::dragMove ()" -Starts a drag operation using the contents of this object, using DragMove mode. Be sure to read the constraints described in drag(). -.PP -See also drag(), dragCopy(), and dragLink(). -.SH "QPixmap QDragObject::pixmap () const" -Returns the currently set pixmap (which isNull() if none is set). -.SH "QPoint QDragObject::pixmapHotSpot () const" -Returns the currently set pixmap hotspot. -.SH "void QDragObject::setPixmap ( QPixmap pm, const QPoint & hotspot )\fC [virtual]\fR" -Set the pixmap \fIpm\fR to display while dragging the object. The platform-specific implementation will use this where it can - so provide a small masked pixmap, and do not assume that the user will actually see it. For example, cursors on Windows 95 are of limited size. -.PP -The \fIhotspot\fR is the point on (or off) the pixmap that should be under the cursor as it is dragged. It is relative to the top-left pixel of the pixmap. -.PP -\fBWarning:\fR We have seen problems with drag cursors on different graphics hardware and driver software on Windows. Setting the graphics acceleration in the display settings down one tick solved the problems in all cases. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "void QDragObject::setPixmap ( QPixmap pm )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Uses a hotspot that positions the pixmap below and to the right of the mouse pointer. This allows the user to clearly see the point on the window which they are dragging the data onto. -.SH "QWidget * QDragObject::source ()" -Returns a pointer to the drag source where this object originated. -.SH "QWidget * QDragObject::target ()\fC [static]\fR" -After the drag completes, this function will return the QWidget which received the drop, or 0 if the data was dropped on another application. -.PP -This can be useful for detecting the case where drag and drop is -to and from the same widget. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdragobject.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdragobject.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qdropevent.3qt b/doc/man/man3/qdropevent.3qt deleted file mode 100644 index 85ac8fbd4..000000000 --- a/doc/man/man3/qdropevent.3qt +++ /dev/null @@ -1,189 +0,0 @@ -'\" t -.TH QDropEvent 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 -QDropEvent \- Event which is sent when a drag and drop is completed -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent and QMimeSource. -.PP -Inherited by QDragMoveEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQDropEvent\fR ( const QPoint & pos, Type typ = Drop )" -.br -.ti -1c -.BI "const QPoint & \fBpos\fR () const" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ( bool y = TRUE )" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.ti -1c -.BI "bool \fBisActionAccepted\fR () const" -.br -.ti -1c -.BI "void \fBacceptAction\fR ( bool y = TRUE )" -.br -.ti -1c -.BI "enum \fBAction\fR { Copy, Link, Move, Private, UserAction = 100 }" -.br -.ti -1c -.BI "void \fBsetAction\fR ( Action a )" -.br -.ti -1c -.BI "Action \fBaction\fR () const" -.br -.ti -1c -.BI "QWidget * \fBsource\fR () const" -.br -.ti -1c -.BI "virtual const char * \fBformat\fR ( int n = 0 ) const" -.br -.ti -1c -.BI "virtual QByteArray \fBencodedData\fR ( const char * format ) const" -.br -.ti -1c -.BI "virtual bool \fBprovides\fR ( const char * mimeType ) const" -.br -.ti -1c -.BI "QByteArray data ( const char * f ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetPoint\fR ( const QPoint & np )" -.br -.in -1c -.SH DESCRIPTION -The QDropEvent class provides an event which is sent when a drag and drop is completed. -.PP -When a widget accepts drop events, it will receive this event if it has accepted the most recent QDragEnterEvent or QDragMoveEvent sent to it. -.PP -The widget should use data() to extract the data in an appropriate format. -.PP -See also Drag And Drop Classes and Event Classes. -.SS "Member Type Documentation" -.SH "QDropEvent::Action" -This enum describes the action which a source requests that a target perform with dropped data. -.TP -\fCQDropEvent::Copy\fR - The default action. The source simply uses the data provided in the operation. -.TP -\fCQDropEvent::Link\fR - The source should somehow create a link to the location specified by the data. -.TP -\fCQDropEvent::Move\fR - The source should somehow move the object from the location specified by the data to a new location. -.TP -\fCQDropEvent::Private\fR - The target has special knowledge of the MIME type, which the source should respond to in a similar way to a Copy. -.TP -\fCQDropEvent::UserAction\fR - The source and target can co-operate using special actions. This feature is not currently supported. -.PP -The Link and Move actions only makes sense if the data is a reference, for example, text/uri-list file lists (see QUriDrag). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QDropEvent::QDropEvent ( const QPoint & pos, Type typ = Drop )" -Constructs a drop event that drops a drop of type \fItyp\fR on point \fIpos\fR. -.SH "void QDropEvent::accept ( bool y = TRUE )" -Call this function to indicate whether the event provided data which your widget processed. Set \fIy\fR to TRUE (the default) if your widget could process the data, otherwise set \fIy\fR to FALSE. To get the data, use encodedData(), or preferably, the decode() methods of existing QDragObject subclasses, such as QTextDrag::decode(), or your own subclasses. -.PP -See also acceptAction(). -.PP -Example: iconview/simple_dd/main.cpp. -.SH "void QDropEvent::acceptAction ( bool y = TRUE )" -Call this to indicate that the action described by action() is accepted (i.e. if \fIy\fR is TRUE, which is the default), not merely the default copy action. If you call acceptAction(TRUE), there is no need to also call accept(TRUE). -.PP -Examples: -.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. -.SH "Action QDropEvent::action () const" -Returns the Action which the target is requesting to be performed with the data. If your application understands the action and can process the supplied data, call acceptAction(); if your application can process the supplied data but can only perform the Copy action, call accept(). -.PP -Examples: -.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. -.SH "QByteArray QDropEvent::data ( const char * f ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use QDropEvent::encodedData(). -.SH "QByteArray QDropEvent::encodedData ( const char * format ) const\fC [virtual]\fR" -Returns a byte array containing the drag's data, in \fIformat\fR. -.PP -data() normally needs to get the data from the drag source, which is potentially very slow, so it's advisable to call this function only if you're sure that you will need the data in \fIformat\fR. -.PP -The resulting data will have a size of 0 if the format was not available. -.PP -See also format() and QByteArray::size(). -.PP -Reimplemented from QMimeSource. -.SH "const char * QDropEvent::format ( int n = 0 ) const\fC [virtual]\fR" -Returns a string describing one of the available data types for this drag. Common examples are "text/plain" and "image/gif". If \fIn\fR is less than zero or greater than the number of available data types, format() returns 0. -.PP -This function is provided mainly for debugging. Most drop targets will use provides(). -.PP -See also data() and provides(). -.PP -Example: iconview/main.cpp. -.PP -Reimplemented from QMimeSource. -.SH "void QDropEvent::ignore ()" -The opposite of accept(), i.e. you have ignored the drop event. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QDropEvent::isAccepted () const" -Returns TRUE if the drop target accepts the event; otherwise returns FALSE. -.SH "bool QDropEvent::isActionAccepted () const" -Returns TRUE if the drop action was accepted by the drop site; otherwise returns FALSE. -.SH "const QPoint & QDropEvent::pos () const" -Returns the position where the drop was made. -.PP -Example: dirview/dirview.cpp. -.SH "bool QDropEvent::provides ( const char * mimeType ) const\fC [virtual]\fR" -Returns TRUE if this event provides format \fImimeType\fR; otherwise returns FALSE. -.PP -See also data(). -.PP -Example: fileiconview/qfileiconview.cpp. -.PP -Reimplemented from QMimeSource. -.SH "void QDropEvent::setAction ( Action a )" -Sets the action to \fIa\fR. This is used internally, you should not need to call this in your code: the \fIsource\fR decides the action, not the target. -.SH "void QDropEvent::setPoint ( const QPoint & np )" -Sets the drop to happen at point \fInp\fR. You do not normally need to use this as it will be set internally before your widget receives the drop event. -.SH "QWidget * QDropEvent::source () const" -If the source of the drag operation is a widget in this application, this function returns that source, otherwise it returns 0. The source of the operation is the first parameter to drag object subclasses. -.PP -This is useful if your widget needs special behavior when dragging to itself, etc. -.PP -See QDragObject::QDragObject() and subclasses. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qdropevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qdropevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qeditorfactory.3qt b/doc/man/man3/qeditorfactory.3qt deleted file mode 100644 index c67e49aa1..000000000 --- a/doc/man/man3/qeditorfactory.3qt +++ /dev/null @@ -1,85 +0,0 @@ -'\" t -.TH QEditorFactory 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 -QEditorFactory \- Used to create editor widgets for QVariant data types -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -Inherited by QSqlEditorFactory. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQEditorFactory\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QEditorFactory\fR ()" -.br -.ti -1c -.BI "virtual QWidget * \fBcreateEditor\fR ( QWidget * parent, const QVariant & v )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QEditorFactory * \fBdefaultFactory\fR ()" -.br -.ti -1c -.BI "void \fBinstallDefaultFactory\fR ( QEditorFactory * factory )" -.br -.in -1c -.SH DESCRIPTION -The QEditorFactory class is used to create editor widgets for QVariant data types. -.PP -Each editor factory provides the createEditor() function which given a QVariant will create and return a QWidget that can edit that QVariant. For example if you have a QVariant::String type, a QLineEdit would be the default editor returned, whereas a QVariant::Int's default editor would be a QSpinBox. -.PP -If you want to create different editors for fields with the same data type, subclass QEditorFactory and reimplement the createEditor() function. -.PP -See also Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QEditorFactory::QEditorFactory ( QObject * parent = 0, const char * name = 0 )" -Constructs an editor factory with parent \fIparent\fR, called \fIname\fR. -.SH "QEditorFactory::~QEditorFactory ()" -Destroys the object and frees any allocated resources. -.SH "QWidget * QEditorFactory::createEditor ( QWidget * parent, const QVariant & v )\fC [virtual]\fR" -Creates and returns the appropriate editor for the QVariant \fIv\fR. If the QVariant is invalid, 0 is returned. The \fIparent\fR is passed to the appropriate editor's constructor. -.PP -Reimplemented in QSqlEditorFactory. -.SH "QEditorFactory * QEditorFactory::defaultFactory ()\fC [static]\fR" -Returns an instance of a default editor factory. -.SH "void QEditorFactory::installDefaultFactory ( QEditorFactory * factory )\fC [static]\fR" -Replaces the default editor factory with \fIfactory\fR. -\fIQEditorFactory takes ownership of factory, and destroys it when it is no longer needed.\fR - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqeditorfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qeditorfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qerrormessage.3qt b/doc/man/man3/qerrormessage.3qt deleted file mode 100644 index 4e5ce9e17..000000000 --- a/doc/man/man3/qerrormessage.3qt +++ /dev/null @@ -1,94 +0,0 @@ -'\" t -.TH QErrorMessage 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 -QErrorMessage \- Error message display dialog -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQErrorMessage\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QErrorMessage\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBmessage\fR ( const QString & m )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QErrorMessage * \fBqtHandler\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QErrorMessage class provides an error message display dialog. -.PP -This is basically a QLabel and a "show this message again" checkbox which remembers what not to show. -.PP -There are two ways to use this class:
                    -.IP 1 -For production applications. In this context the class can be used to display messages which you don't need the user to see more than once. To use QErrorMessage like this, you create the dialog in the usual way and call the message() slot, or connect signals to it. -.IP 2 -For developers. In this context the static qtHandler() installs a message handler using qInstallMsgHandler() and creates a QErrorMessage that displays tqDebug(), tqWarning() and tqFatal() messages. -.PP -In both cases QErrorMessage will queue pending messages, and display them (or not) in order, as soon as the user presses Enter or clicks OK after seeing each message. -.PP -
                    -.ce 1 -.B "[Image Omitted]" -.PP -
                    -.PP -See also QMessageBox, QStatusBar::message(), Dialog Classes, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QErrorMessage::QErrorMessage ( QWidget * parent, const char * name = 0 )" -Constructs and installs an error handler window. The parent \fIparent\fR and name \fIname\fR are passed on to the QDialog constructor. -.SH "QErrorMessage::~QErrorMessage ()" -Destroys the object and frees any allocated resources. Notably, the list of "do not show again" messages is deleted. -.SH "void QErrorMessage::message ( const QString & m )\fC [slot]\fR" -Shows message \fIm\fR and returns immediately. If the user has requested that \fIm\fR not be shown, this function does nothing. -.PP -Normally, \fIm\fR is shown at once, but if there are pending messages, \fIm\fR is queued for later display. -.SH "QErrorMessage * QErrorMessage::qtHandler ()\fC [static]\fR" -Returns a pointer to a QErrorMessage object that outputs the -default Qt messages. This function creates such an object, if there -isn't one already. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqerrormessage.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qerrormessage.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qeucjpcodec.3qt b/doc/man/man3/qeucjpcodec.3qt deleted file mode 100644 index 47eddd336..000000000 --- a/doc/man/man3/qeucjpcodec.3qt +++ /dev/null @@ -1,90 +0,0 @@ -'\" t -.TH QEucJpCodec 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 -QEucJpCodec \- Conversion to and from EUC-JP character sets -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                    -.PP -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual int \fBmibEnum\fR () const" -.br -.ti -1c -.BI "virtual const char * \fBmimeName\fR () const" -.br -.ti -1c -.BI "\fBQEucJpCodec\fR ()" -.br -.ti -1c -.BI "\fB~QEucJpCodec\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QEucJpCodec class provides conversion to and from EUC-JP character sets. -.PP -More precisely, the QEucJpCodec class subclasses QTextCodec to provide support for EUC-JP, the main legacy encoding for Unix machines in Japan. -.PP -The environment variable \fCUNICODEMAP_JP\fR can be used to fine-tune QJisCodec, QSjisCodec and QEucJpCodec. The QJisCodec documentation describes how to use this variable. -.PP -Most of the code here was written by Serika Kurusugawa, a.k.a. Junji Takagi, and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for that code: -.PP -Copyright (C) 1999 Serika Kurusugawa. All rights reserved. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
                      -.IP 1 -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.IP 2 -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS". ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.PP -See also Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QEucJpCodec::QEucJpCodec ()" -Constructs a QEucJpCodec. -.SH "QEucJpCodec::~QEucJpCodec ()" -Destroys the codec. -.SH "int QEucJpCodec::mibEnum () const\fC [virtual]\fR" -Returns 18. -.PP -Reimplemented from QTextCodec. -.SH "const char * QEucJpCodec::mimeName () const\fC [virtual]\fR" -Returns the codec's mime name. -.PP -Reimplemented from QTextCodec. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqeucjpcodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qeucjpcodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qeuckrcodec.3qt b/doc/man/man3/qeuckrcodec.3qt deleted file mode 100644 index fdc2ee933..000000000 --- a/doc/man/man3/qeuckrcodec.3qt +++ /dev/null @@ -1,71 +0,0 @@ -'\" t -.TH QEucKrCodec 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 -QEucKrCodec \- Conversion to and from EUC-KR character sets -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                      -.PP -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual const char * \fBmimeName\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QEucKrCodec class provides conversion to and from EUC-KR character sets. -.PP -The QEucKrCodec class subclasses QTextCodec to provide support for EUC-KR, the main legacy encoding for UNIX machines in Korea. -.PP -It was largely written by Mizi Research Inc. Here is the copyright statement for the code as it was at the point of contribution. Trolltech's subsequent modifications are covered by the usual copyright for Qt. -.PP -Copyright (C) 1999-2000 Mizi Research Inc. All rights reserved. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -.IP 1 -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.IP 2 -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.PP -See also Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "const char * QEucKrCodec::mimeName () const\fC [virtual]\fR" -Returns the codec's mime name. -.PP -Reimplemented from QTextCodec. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqeuckrcodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qeuckrcodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qevent.3qt b/doc/man/man3/qevent.3qt deleted file mode 100644 index 3e67b4fc0..000000000 --- a/doc/man/man3/qevent.3qt +++ /dev/null @@ -1,238 +0,0 @@ -'\" t -.TH QEvent 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 -QEvent \- The base class of all event classes. Event objects contain event parameters -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -Inherited by QTimerEvent, QMouseEvent, QWheelEvent, QTabletEvent, QKeyEvent, QFocusEvent, QPaintEvent, QMoveEvent, QResizeEvent, QCloseEvent, QIconDragEvent, QShowEvent, QHideEvent, QContextMenuEvent, QIMEvent, QDropEvent, QDragLeaveEvent, QChildEvent, and QCustomEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBType\fR { None = 0, Timer = 1, MouseButtonPress = 2, MouseButtonRelease = 3, MouseButtonDblClick = 4, MouseMove = 5, KeyPress = 6, KeyRelease = 7, FocusIn = 8, FocusOut = 9, Enter = 10, Leave = 11, Paint = 12, Move = 13, Resize = 14, Create = 15, Destroy = 16, Show = 17, Hide = 18, Close = 19, Quit = 20, Reparent = 21, ShowMinimized = 22, ShowNormal = 23, WindowActivate = 24, WindowDeactivate = 25, ShowToParent = 26, HideToParent = 27, ShowMaximized = 28, ShowFullScreen = 29, Accel = 30, Wheel = 31, AccelAvailable = 32, CaptionChange = 33, IconChange = 34, ParentFontChange = 35, ApplicationFontChange = 36, ParentPaletteChange = 37, ApplicationPaletteChange = 38, PaletteChange = 39, Clipboard = 40, Speech = 42, SockAct = 50, AccelOverride = 51, DeferredDelete = 52, DragEnter = 60, DragMove = 61, DragLeave = 62, Drop = 63, DragResponse = 64, ChildInserted = 70, ChildRemoved = 71, LayoutHint = 72, ShowWindowRequest = 73, WindowBlocked = 74, WindowUnblocked = 75, ActivateControl = 80, DeactivateControl = 81, ContextMenu = 82, IMStart = 83, IMCompose = 84, IMEnd = 85, Accessibility = 86, TabletMove = 87, LocaleChange = 88, LanguageChange = 89, LayoutDirectionChange = 90, Style = 91, TabletPress = 92, TabletRelease = 93, OkRequest = 94, HelpRequest = 95, WindowStateChange = 96, IconDrag = 97, User = 1000, MaxUser = 65535 }" -.br -.ti -1c -.BI "\fBQEvent\fR ( Type type )" -.br -.ti -1c -.BI "virtual \fB~QEvent\fR ()" -.br -.ti -1c -.BI "Type \fBtype\fR () const" -.br -.ti -1c -.BI "bool \fBspontaneous\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QEvent class is the base class of all event classes. Event objects contain event parameters. -.PP -Qt's main event loop (QApplication::exec()) fetches native window system events from the event queue, translates them into QEvents and sends the translated events to QObjects. -.PP -In general, events come from the underlying window system (spontaneous() returns TRUE) but it is also possible to manually send events using QApplication::sendEvent() and QApplication::postEvent() (spontaneous() returns FALSE). -.PP -QObjects receive events by having their QObject::event() function called. The function can be reimplemented in subclasses to customize event handling and add additional event types; QWidget::event() is a notable example. By default, events are dispatched to event handlers like QObject::timerEvent() and QWidget::mouseMoveEvent(). QObject::installEventFilter() allows an object to intercept events destined for another object. -.PP -The basic QEvent contains only an event type parameter. Subclasses of QEvent contain additional parameters that describe the particular event. -.PP -See also QObject::event(), QObject::installEventFilter(), QWidget::event(), QApplication::sendEvent(), QApplication::postEvent(), QApplication::processEvents(), Environment Classes, and Event Classes. -.SS "Member Type Documentation" -.SH "QEvent::Type" -This enum type defines the valid event types in Qt. The event types and the specialized classes for each type are these: -.TP -\fCQEvent::None\fR - Not an event. -.TP -\fCQEvent::Accessibility\fR - Accessibility information is requested -.TP -\fCQEvent::Timer\fR - Regular timer events, QTimerEvent. -.TP -\fCQEvent::MouseButtonPress\fR - Mouse press, QMouseEvent. -.TP -\fCQEvent::MouseButtonRelease\fR - Mouse release, QMouseEvent. -.TP -\fCQEvent::MouseButtonDblClick\fR - Mouse press again, QMouseEvent. -.TP -\fCQEvent::MouseMove\fR - Mouse move, QMouseEvent. -.TP -\fCQEvent::KeyPress\fR - Key press (including Shift, for example), QKeyEvent. -.TP -\fCQEvent::KeyRelease\fR - Key release, QKeyEvent. -.TP -\fCQEvent::IMStart\fR - The start of input method composition, QIMEvent. -.TP -\fCQEvent::IMCompose\fR - Input method composition is taking place, QIMEvent. -.TP -\fCQEvent::IMEnd\fR - The end of input method composition, QIMEvent. -.TP -\fCQEvent::FocusIn\fR - Widget gains keyboard focus, QFocusEvent. -.TP -\fCQEvent::FocusOut\fR - Widget loses keyboard focus, QFocusEvent. -.TP -\fCQEvent::Enter\fR - Mouse enters widget's boundaries. -.TP -\fCQEvent::Leave\fR - Mouse leaves widget's boundaries. -.TP -\fCQEvent::Paint\fR - Screen update necessary, QPaintEvent. -.TP -\fCQEvent::Move\fR - Widget's position changed, QMoveEvent. -.TP -\fCQEvent::Resize\fR - Widget's size changed, QResizeEvent. -.TP -\fCQEvent::Show\fR - Widget was shown on screen, QShowEvent. -.TP -\fCQEvent::Hide\fR - Widget was hidden, QHideEvent. -.TP -\fCQEvent::ShowToParent\fR - A child widget has been shown. -.TP -\fCQEvent::HideToParent\fR - A child widget has been hidden. -.TP -\fCQEvent::Close\fR - Widget was closed (permanently), QCloseEvent. -.TP -\fCQEvent::ShowNormal\fR - Widget should be shown normally (obsolete). -.TP -\fCQEvent::ShowMaximized\fR - Widget should be shown maximized (obsolete). -.TP -\fCQEvent::ShowMinimized\fR - Widget should be shown minimized (obsolete). -.TP -\fCQEvent::ShowFullScreen\fR - Widget should be shown full-screen (obsolete). -.TP -\fCQEvent::ShowWindowRequest\fR - Widget's window should be shown (obsolete). -.TP -\fCQEvent::DeferredDelete\fR - The object will be deleted after it has cleaned up. -.TP -\fCQEvent::Accel\fR - Key press in child for shortcut key handling, QKeyEvent. -.TP -\fCQEvent::Wheel\fR - Mouse wheel rolled, QWheelEvent. -.TP -\fCQEvent::ContextMenu\fR - Context popup menu, QContextMenuEvent -.TP -\fCQEvent::AccelOverride\fR - Key press in child, for overriding shortcut key handling, QKeyEvent. -.TP -\fCQEvent::AccelAvailable\fR - internal. -.TP -\fCQEvent::WindowActivate\fR - Window was activated. -.TP -\fCQEvent::WindowDeactivate\fR - Window was deactivated. -.TP -\fCQEvent::CaptionChange\fR - Widget's caption changed. -.TP -\fCQEvent::IconChange\fR - Widget's icon changed. -.TP -\fCQEvent::ParentFontChange\fR - Font of the parent widget changed. -.TP -\fCQEvent::ApplicationFontChange\fR - Default application font changed. -.TP -\fCQEvent::PaletteChange\fR - Palette of the widget changed. -.TP -\fCQEvent::ParentPaletteChange\fR - Palette of the parent widget changed. -.TP -\fCQEvent::ApplicationPaletteChange\fR - Default application palette changed. -.TP -\fCQEvent::Clipboard\fR - Clipboard contents have changed. -.TP -\fCQEvent::SockAct\fR - Socket activated, used to implement QSocketNotifier. -.TP -\fCQEvent::DragEnter\fR - A drag-and-drop enters widget, QDragEnterEvent. -.TP -\fCQEvent::DragMove\fR - A drag-and-drop is in progress, QDragMoveEvent. -.TP -\fCQEvent::DragLeave\fR - A drag-and-drop leaves widget, QDragLeaveEvent. -.TP -\fCQEvent::Drop\fR - A drag-and-drop is completed, QDropEvent. -.TP -\fCQEvent::DragResponse\fR - Internal event used by Qt on some platforms. -.TP -\fCQEvent::ChildInserted\fR - Object gets a child, QChildEvent. -.TP -\fCQEvent::ChildRemoved\fR - Object loses a child, QChildEvent. -.TP -\fCQEvent::LayoutHint\fR - Widget child has changed layout properties. -.TP -\fCQEvent::ActivateControl\fR - Internal event used by Qt on some platforms. -.TP -\fCQEvent::DeactivateControl\fR - Internal event used by Qt on some platforms. -.TP -\fCQEvent::LanguageChange\fR - The application translation changed, QTranslator -.TP -\fCQEvent::LayoutDirectionChange\fR - The direction of layouts changed -.TP -\fCQEvent::LocaleChange\fR - The system locale changed -.TP -\fCQEvent::Quit\fR - Reserved. -.TP -\fCQEvent::Create\fR - Reserved. -.TP -\fCQEvent::Destroy\fR - Reserved. -.TP -\fCQEvent::Reparent\fR - Reserved. -.TP -\fCQEvent::Speech\fR - Reserved for speech input. -.TP -\fCQEvent::TabletMove\fR - A Wacom Tablet Move Event. -.TP -\fCQEvent::Style\fR - Internal use only -.TP -\fCQEvent::TabletPress\fR - A Wacom Tablet Press Event -.TP -\fCQEvent::TabletRelease\fR - A Wacom Tablet Release Event -.TP -\fCQEvent::OkRequest\fR - Internal event used by Qt on some platforms. -.TP -\fCQEvent::HelpRequest\fR - Internal event used by Qt on some platforms. -.TP -\fCQEvent::IconDrag\fR - Internal event used by Qt on some platforms when proxy icon is dragged. -.TP -\fCQEvent::WindowStateChange\fR - The window's state, i.e. minimized, maximized or full-screen, has changed. See QWidget::windowState(). -.TP -\fCQEvent::WindowBlocked\fR - The window is modally blocked -.TP -\fCQEvent::WindowUnblocked\fR - The window leaves modal blocking -.TP -\fCQEvent::User\fR - User defined event. -.TP -\fCQEvent::MaxUser\fR - Last user event id. -.PP -User events should have values between User and MaxUser inclusive. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QEvent::QEvent ( Type type )" -Contructs an event object of type \fItype\fR. -.SH "QEvent::~QEvent ()\fC [virtual]\fR" -Destroys the event. If it was posted, it will be removed from the list of events to be posted. -.SH "bool QEvent::spontaneous () const" -Returns TRUE if the event originated outside the application, i.e. it is a system event; otherwise returns FALSE. -.SH "Type QEvent::type () const" -Returns the event type. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qeventloop.3qt b/doc/man/man3/qeventloop.3qt deleted file mode 100644 index 3238e613b..000000000 --- a/doc/man/man3/qeventloop.3qt +++ /dev/null @@ -1,240 +0,0 @@ -'\" t -.TH QEventLoop 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 -QEventLoop \- Manages the event queue -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -Inherited by QMotif. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQEventLoop\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QEventLoop\fR ()" -.br -.ti -1c -.BI "enum \fBProcessEvents\fR { AllEvents = 0x00, ExcludeUserInput = 0x01, ExcludeSocketNotifiers = 0x02, WaitForMore = 0x04 }" -.br -.ti -1c -.BI "typedef uint \fBProcessEventsFlags\fR" -.br -.ti -1c -.BI "void \fBprocessEvents\fR ( ProcessEventsFlags flags, int maxTime )" -.br -.ti -1c -.BI "virtual bool \fBprocessEvents\fR ( ProcessEventsFlags flags )" -.br -.ti -1c -.BI "virtual bool \fBhasPendingEvents\fR () const" -.br -.ti -1c -.BI "virtual void \fBregisterSocketNotifier\fR ( QSocketNotifier * notifier )" -.br -.ti -1c -.BI "virtual void \fBunregisterSocketNotifier\fR ( QSocketNotifier * notifier )" -.br -.ti -1c -.BI "void \fBsetSocketNotifierPending\fR ( QSocketNotifier * notifier )" -.br -.ti -1c -.BI "int \fBactivateSocketNotifiers\fR ()" -.br -.ti -1c -.BI "int \fBactivateTimers\fR ()" -.br -.ti -1c -.BI "int \fBtimeToWait\fR () const" -.br -.ti -1c -.BI "virtual int \fBexec\fR ()" -.br -.ti -1c -.BI "virtual void \fBexit\fR ( int retcode = 0 )" -.br -.ti -1c -.BI "virtual int \fBenterLoop\fR ()" -.br -.ti -1c -.BI "virtual void \fBexitLoop\fR ()" -.br -.ti -1c -.BI "virtual int \fBloopLevel\fR () const" -.br -.ti -1c -.BI "virtual void \fBwakeUp\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBawake\fR ()" -.br -.ti -1c -.BI "void \fBaboutToBlock\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QEventLoop class manages the event queue. -.PP -It receives events from the window system and other sources. It then sends them to QApplication for processing and delivery. -.PP -QEventLoop allows the application programmer to have more control over event delivery. Programs that perform long operations can call either processOneEvent() or processEvents() with various ProcessEvent values OR'ed together to control which events should be delivered. -.PP -QEventLoop also allows the integration of an external event loop with the Qt event loop. The Motif Extension included with Qt includes a reimplementation of QEventLoop for merging Qt and Motif events together. -.PP -To use your own instance of QEventLoop or QEventLoop subclass create it before you create the QApplication object. -.PP -See also Main Window and Related Classes and Event Classes. -.SS "Member Type Documentation" -.SH "QEventLoop::ProcessEvents" -This enum controls the types of events processed by the processEvents() functions. -.TP -\fCQEventLoop::AllEvents\fR - All events are processed -.TP -\fCQEventLoop::ExcludeUserInput\fR - Do not process user input events. ( ButtonPress, KeyPress, etc. ) -.TP -\fCQEventLoop::ExcludeSocketNotifiers\fR - Do not process socket notifier events. -.TP -\fCQEventLoop::WaitForMore\fR - Wait for events if no pending events are available. -.PP -See also processEvents(). -.SH "QEventLoop::ProcessEventsFlags" -A \fCtypedef\fR to allow various ProcessEvents values to be OR'ed together. -.PP -See also ProcessEvents. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QEventLoop::QEventLoop ( QObject * parent = 0, const char * name = 0 )" -Creates a QEventLoop object, this object becomes the global event loop object. There can only be one event loop object. The QEventLoop is usually constructed by calling QApplication::eventLoop(). To create your own event loop object create it before you instantiate the QApplication object. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. -.SH "QEventLoop::~QEventLoop ()" -Destructs the QEventLoop object. -.SH "void QEventLoop::aboutToBlock ()\fC [signal]\fR" -This signal is emitted before the event loop calls a function that could block. -.PP -See also awake(). -.SH "int QEventLoop::activateSocketNotifiers ()" -Activates all pending socket notifiers and returns the number of socket notifiers that were activated. -.SH "int QEventLoop::activateTimers ()" -Activates all Qt timers and returns the number of timers that were activated. -.PP -QEventLoop subclasses that do their own timer handling need to call this after the time returned by timeToWait() has elapsed. -.PP -Note: This function is only useful on systems where \fCselect()\fR is used to block the eventloop. On Windows, this function always returns 0. On MacOS X, this function always returns 0 when the GUI is enabled. On MacOS X, this function returns the documented value when the GUI is disabled. -.SH "void QEventLoop::awake ()\fC [signal]\fR" -This signal is emitted after the event loop returns from a function that could block. -.PP -See also wakeUp() and aboutToBlock(). -.SH "int QEventLoop::enterLoop ()\fC [virtual]\fR" -This function enters the main event loop (recursively). Do not call it unless you really know what you are doing. -.SH "int QEventLoop::exec ()\fC [virtual]\fR" -Enters the main event loop and waits until exit() is called, and returns the value that was set to exit(). -.PP -It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets. -.PP -Generally speaking, no user interaction can take place before calling exec(). As a special case, modal widgets like QMessageBox can be used before calling exec(), because modal widgets call exec() to start a local event loop. -.PP -To make your application perform idle processing, i.e. executing a special function whenever there are no pending events, use a QTimer with 0 timeout. More advanced idle processing schemes can be achieved using processEvents(). -.PP -See also QApplication::quit(), exit(), and processEvents(). -.SH "void QEventLoop::exit ( int retcode = 0 )\fC [virtual]\fR" -Tells the event loop to exit with a return code. -.PP -After this function has been called, the event loop returns from the call to exec(). The exec() function returns \fIretcode\fR. -.PP -By convention, a \fIretcode\fR of 0 means success, and any non-zero value indicates an error. -.PP -Note that unlike the C library function of the same name, this function \fIdoes\fR return to the caller -- it is event processing that stops. -.PP -See also QApplication::quit() and exec(). -.SH "void QEventLoop::exitLoop ()\fC [virtual]\fR" -This function exits from a recursive call to the main event loop. Do not call it unless you really know what you are doing. -.SH "bool QEventLoop::hasPendingEvents () const\fC [virtual]\fR" -Returns TRUE if there is an event waiting, otherwise it returns FALSE. -.SH "int QEventLoop::loopLevel () const\fC [virtual]\fR" -Returns the current loop level. -.SH "void QEventLoop::processEvents ( ProcessEventsFlags flags, int maxTime )" -Process pending events that match \fIflags\fR for a maximum of \fImaxTime\fR milliseconds, or until there are no more events to process, which ever is shorter. -.PP -This function is especially useful if you have a long running operation and want to show its progress without allowing user input, i.e. by using the ExcludeUserInput flag. -.PP -NOTE: This function will not process events continuously; it returns after all available events are processed. -.PP -NOTE: Specifying the WaitForMore flag makes no sense and will be ignored. -.SH "bool QEventLoop::processEvents ( ProcessEventsFlags flags )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Processes pending events that match \fIflags\fR until there are no more events to process. -.PP -This function is especially useful if you have a long running operation and want to show its progress without allowing user input, i.e. by using the ExcludeUserInput flag. -.PP -If the WaitForMore flag is set in \fIflags\fR, the behavior of this function is as follows: -.IP -.TP -If events are available, this function returns after processing them. -.IP -.TP -If no events are available, this function will wait until more are available and return after processing newly available events. -.IP -.PP -If the WaitForMore flag is \fInot\fR set in \fIflags\fR, and no events are available, this function will return immediately. -.PP -NOTE: This function will not process events continuously; it returns after all available events are processed. -.PP -This function returns TRUE if an event was processed; otherwise it returns FALSE. -.PP -See also ProcessEvents and hasPendingEvents(). -.SH "void QEventLoop::registerSocketNotifier ( QSocketNotifier * notifier )\fC [virtual]\fR" -Registers \fInotifier\fR with the event loop. Subclasses need to reimplement this method to tie a socket notifier into another event loop. Reimplementations \fIMUST\fR call the base implementation. -.SH "void QEventLoop::setSocketNotifierPending ( QSocketNotifier * notifier )" -Marks \fInotifier\fR as pending. The socket notifier will be activated the next time activateSocketNotifiers() is called. -.SH "int QEventLoop::timeToWait () const" -Returns the number of milliseconds that Qt needs to handle its timers or -1 if there are no timers running. -.PP -QEventLoop subclasses that do their own timer handling need to use this to make sure that Qt's timers continue to work. -.PP -Note: This function is only useful on systems where \fCselect()\fR is used to block the eventloop. On Windows, this function always returns -1. On MacOS X, this function always returns -1 when the GUI is enabled. On MacOS X, this function returns the documented value when the GUI is disabled. -.SH "void QEventLoop::unregisterSocketNotifier ( QSocketNotifier * notifier )\fC [virtual]\fR" -Unregisters \fInotifier\fR from the event loop. Subclasses need to reimplement this method to tie a socket notifier into another event loop. Reimplementations \fIMUST\fR call the base implementation. -.SH "void QEventLoop::wakeUp ()\fC [virtual]\fR" -\fBNote:\fR This function is thread-safe when Qt is built withthread support.

                      -.PP -Wakes up the event loop. -.PP -See also awake(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqeventloop.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qeventloop.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfile.3qt b/doc/man/man3/qfile.3qt deleted file mode 100644 index aab1c83a5..000000000 --- a/doc/man/man3/qfile.3qt +++ /dev/null @@ -1,526 +0,0 @@ -'\" t -.TH QFile 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 -QFile \- I/O device that operates on files -.SH SYNOPSIS -Almost all the functions in this class are reentrant when Qt is built with thread support. The exceptions are \fBsetEncodingFunction\fR(), \fBsetDecodingFunction\fR(), and \fBsetErrorString\fR().

                      -.PP -\fC#include \fR -.PP -Inherits QIODevice. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFile\fR ()" -.br -.ti -1c -.BI "\fBQFile\fR ( const QString & name )" -.br -.ti -1c -.BI "\fB~QFile\fR ()" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "void \fBsetName\fR ( const QString & name )" -.br -.ti -1c -.BI "typedef QCString (* \fBEncoderFn\fR ) ( const QString & fileName )" -.br -.ti -1c -.BI "typedef QString (* \fBDecoderFn\fR ) ( const QCString & localfileName )" -.br -.ti -1c -.BI "bool \fBexists\fR () const" -.br -.ti -1c -.BI "bool \fBremove\fR ()" -.br -.ti -1c -.BI "virtual bool \fBopen\fR ( int m )" -.br -.ti -1c -.BI "bool \fBopen\fR ( int m, FILE * f )" -.br -.ti -1c -.BI "bool \fBopen\fR ( int m, int f )" -.br -.ti -1c -.BI "virtual void \fBclose\fR ()" -.br -.ti -1c -.BI "virtual void \fBflush\fR ()" -.br -.ti -1c -.BI "virtual Offset \fBsize\fR () const" -.br -.ti -1c -.BI "virtual bool \fBatEnd\fR () const" -.br -.ti -1c -.BI "virtual TQ_LONG \fBreadLine\fR ( char * p, TQ_ULONG maxlen )" -.br -.ti -1c -.BI "TQ_LONG \fBreadLine\fR ( QString & s, TQ_ULONG maxlen )" -.br -.ti -1c -.BI "virtual int \fBgetch\fR ()" -.br -.ti -1c -.BI "virtual int \fBputch\fR ( int ch )" -.br -.ti -1c -.BI "virtual int \fBungetch\fR ( int ch )" -.br -.ti -1c -.BI "int \fBhandle\fR () const" -.br -.ti -1c -.BI "QString \fBerrorString\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QCString \fBencodeName\fR ( const QString & fileName )" -.br -.ti -1c -.BI "QString \fBdecodeName\fR ( const QCString & localFileName )" -.br -.ti -1c -.BI "void \fBsetEncodingFunction\fR ( EncoderFn f )" -.br -.ti -1c -.BI "void \fBsetDecodingFunction\fR ( DecoderFn f )" -.br -.ti -1c -.BI "bool \fBexists\fR ( const QString & fileName )" -.br -.ti -1c -.BI "bool \fBremove\fR ( const QString & fileName )" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "virtual QByteArray \fBreadAll\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsetErrorString\fR ( const QString & str )" -.br -.in -1c -.SH DESCRIPTION -The QFile class is an I/O device that operates on files. -.PP -QFile is an I/O device for reading and writing binary and text files. A QFile may be used by itself or more conveniently with a QDataStream or QTextStream. -.PP -The file name is usually passed in the constructor but can be changed with setName(). You can check for a file's existence with exists() and remove a file with remove(). -.PP -The file is opened with open(), closed with close() and flushed with flush(). Data is usually read and written using QDataStream or QTextStream, but you can read with readBlock() and readLine() and write with writeBlock(). QFile also supports getch(), ungetch() and putch(). -.PP -The size of the file is returned by size(). You can get the current file position or move to a new file position using the at() functions. If you've reached the end of the file, atEnd() returns TRUE. The file handle is returned by handle(). -.PP -Here is a code fragment that uses QTextStream to read a text file line by line. It prints each line with a line number. -.PP -.nf -.br - QStringList lines; -.br - QFile file( "file.txt" ); -.br - if ( file.open( IO_ReadOnly ) ) { -.br - QTextStream stream( &file ); -.br - QString line; -.br - int i = 1; -.br - while ( !stream.atEnd() ) { -.br - line = stream.readLine(); // line of text excluding '\\n' -.br - printf( "%3d: %s\\n", i++, line.latin1() ); -.br - lines += line; -.br - } -.br - file.close(); -.br - } -.br -.fi -.PP -Writing text is just as easy. The following example shows how to write the data we read into the string list from the previous example: -.PP -.nf -.br - QFile file( "file.txt" ); -.br - if ( file.open( IO_WriteOnly ) ) { -.br - QTextStream stream( &file ); -.br - for ( QStringList::Iterator it = lines.begin(); it != lines.end(); ++it ) -.br - stream << *it << "\\n"; -.br - file.close(); -.br - } -.br -.fi -.PP -The QFileInfo class holds detailed information about a file, such as access permissions, file dates and file types. -.PP -The QDir class manages directories and lists of file names. -.PP -Qt uses Unicode file names. If you want to do your own I/O on Unix systems you may want to use encodeName() (and decodeName()) to convert the file name into the local encoding. -.PP -See also QDataStream, QTextStream, and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QFile::DecoderFn" -This is used by QFile::setDecodingFunction(). -.SH "QFile::EncoderFn" -This is used by QFile::setEncodingFunction(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFile::QFile ()" -Constructs a QFile with no name. -.SH "QFile::QFile ( const QString & name )" -Constructs a QFile with a file name \fIname\fR. -.PP -See also setName(). -.SH "QFile::~QFile ()" -Destroys a QFile. Calls close(). -.SH "bool QFile::atEnd () const\fC [virtual]\fR" -Returns TRUE if the end of file has been reached; otherwise returns FALSE. If QFile has not been open()'d, then the behavior is undefined. -.PP -See also size(). -.PP -Example: distributor/distributor.ui.h. -.PP -Reimplemented from QIODevice. -.SH "void QFile::close ()\fC [virtual]\fR" -Closes an open file. -.PP -The file is not closed if it was opened with an existing file handle. If the existing file handle is a \fCFILE*\fR, the file is flushed. If the existing file handle is an \fCint\fR file descriptor, nothing is done to the file. -.PP -Some "write-behind" filesystems may report an unspecified error on closing the file. These errors only indicate that something may have gone wrong since the previous open(). In such a case status() reports IO_UnspecifiedError after close(), otherwise IO_Ok. -.PP -See also open() and flush(). -.PP -Examples: -.)l chart/chartform_files.cpp, distributor/distributor.ui.h, helpviewer/helpwindow.cpp, mdi/application.cpp, qdir/qdir.cpp, qwerty/qwerty.cpp, and xml/outliner/outlinetree.cpp. -.PP -Reimplemented from QIODevice. -.SH "QString QFile::decodeName ( const QCString & localFileName )\fC [static]\fR" -This does the reverse of QFile::encodeName() using \fIlocalFileName\fR. -.PP -See also setDecodingFunction(). -.PP -Example: distributor/distributor.ui.h. -.SH "QCString QFile::encodeName ( const QString & fileName )\fC [static]\fR" -When you use QFile, QFileInfo, and QDir to access the file system with Qt, you can use Unicode file names. On Unix, these file names are converted to an 8-bit encoding. If you want to do your own file I/O on Unix, you should convert the file name using this function. On Windows NT/2000, Unicode file names are supported directly in the file system and this function should be avoided. On Windows 95, non-Latin1 locales are not supported. -.PP -By default, this function converts \fIfileName\fR to the local 8-bit encoding determined by the user's locale. This is sufficient for file names that the user chooses. File names hard-coded into the application should only use 7-bit ASCII filename characters. -.PP -The conversion scheme can be changed using setEncodingFunction(). This might be useful if you wish to give the user an option to store file names in UTF-8, etc., but be aware that such file names would probably then be unrecognizable when seen by other programs. -.PP -See also decodeName(). -.PP -Example: distributor/distributor.ui.h. -.SH "QString QFile::errorString () const" -Returns a human-readable description of the reason of an error that occurred on the device. The error described by the string corresponds to changes of QIODevice::status(). If the status is reset, the error string is also reset. -.PP -The returned strings are not translated with the QObject::tr() or QApplication::translate() functions. They are marked as translatable strings in the "QFile" context. Before you show the string to the user you should translate it first, for example: -.PP -.nf -.br - QFile f( "address.dat" ); -.br - if ( !f.open( IO_ReadOnly ) { -.br - QMessageBox::critical( -.br - this, -.br - tr("Open failed"), -.br - tr("Could not open file for reading: %1").arg( tqApp->translate("QFile",f.errorString()) ) -.br - ); -.br - return; -.br - } -.br -.fi -.PP -See also QIODevice::status(), QIODevice::resetStatus(), and setErrorString(). -.SH "bool QFile::exists ( const QString & fileName )\fC [static]\fR" -Returns TRUE if the file given by \fIfileName\fR exists; otherwise returns FALSE. -.PP -Examples: -.)l chart/chartform.cpp, dirview/dirview.cpp, and helpviewer/helpwindow.cpp. -.SH "bool QFile::exists () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if this file exists; otherwise returns FALSE. -.PP -See also name(). -.SH "void QFile::flush ()\fC [virtual]\fR" -Flushes the file buffer to the disk. -.PP -close() also flushes the file buffer. -.PP -Reimplemented from QIODevice. -.SH "int QFile::getch ()\fC [virtual]\fR" -Reads a single byte/character from the file. -.PP -Returns the byte/character read, or -1 if the end of the file has been reached. -.PP -See also putch() and ungetch(). -.PP -Reimplemented from QIODevice. -.SH "int QFile::handle () const" -Returns the file handle of the file. -.PP -This is a small positive integer, suitable for use with C library functions such as fdopen() and fcntl(). On systems that use file descriptors for sockets (ie. Unix systems, but not Windows) the handle can be used with QSocketNotifier as well. -.PP -If the file is not open or there is an error, handle() returns -1. -.PP -See also QSocketNotifier. -.SH "QString QFile::name () const" -Returns the name set by setName(). -.PP -See also setName() and QFileInfo::fileName(). -.SH "bool QFile::open ( int m )\fC [virtual]\fR" -Opens the file specified by the file name currently set, using the mode \fIm\fR. Returns TRUE if successful, otherwise FALSE. -.PP - -.PP -The mode parameter \fIm\fR must be a combination of the following flags:
                      .nf -.TS -l - l. Flag Meaning IO_Raw Raw (non-buffered) file access. IO_ReadOnly Opens the file in read-only mode. IO_WriteOnly Opens the file in write-only mode. If this flag is used with another flag, e.g. IO_ReadOnly or IO_Raw or IO_Append, the file is \fInot\fR truncated; but if used on its own (or with IO_Truncate), the file is truncated. IO_ReadWrite Opens the file in read/write mode, equivalent to IO_Append Opens the file in append mode. (You must actually use IO_Truncate Truncates the file. IO_Translate -.TE -.fi -
                      -.PP -The raw access mode is best when I/O is block-operated using a 4KB block size or greater. Buffered access works better when reading small portions of data at a time. -.PP -\fBWarning:\fR When working with buffered files, data may not be written to the file at once. Call flush() to make sure that the data is really written. -.PP -\fBWarning:\fR If you have a buffered file opened for both reading and writing you must not perform an input operation immediately after an output operation or vice versa. You should always call flush() or a file positioning operation, e.g. at(), between input and output operations, otherwise the buffer may contain garbage. -.PP -If the file does not exist and IO_WriteOnly or IO_ReadWrite is specified, it is created. -.PP -Example: -.PP -.nf -.br - QFile f1( "/tmp/data.bin" ); -.br - f1.open( IO_Raw | IO_ReadWrite ); -.br -.br - QFile f2( "readme.txt" ); -.br - f2.open( IO_ReadOnly | IO_Translate ); -.br -.br - QFile f3( "audit.log" ); -.br - f3.open( IO_WriteOnly | IO_Append ); -.br -.fi -.PP -See also name(), close(), isOpen(), and flush(). -.PP -Examples: -.)l application/application.cpp, chart/chartform_files.cpp, distributor/distributor.ui.h, helpviewer/helpwindow.cpp, qdir/qdir.cpp, qwerty/qwerty.cpp, and xml/outliner/outlinetree.cpp. -.PP -Reimplemented from QIODevice. -.SH "bool QFile::open ( int m, FILE * f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Opens a file in the mode \fIm\fR using an existing file handle \fIf\fR. Returns TRUE if successful, otherwise FALSE. -.PP -Example: -.PP -.nf -.br - #include -.br -.br - void printError( const char* msg ) -.br - { -.br - QFile f; -.br - f.open( IO_WriteOnly, stderr ); -.br - f.writeBlock( msg, tqstrlen(msg) ); // write to stderr -.br - f.close(); -.br - } -.br -.fi -.PP -When a QFile is opened using this function, close() does not actually close the file, only flushes it. -.PP -\fBWarning:\fR If \fIf\fR is \fCstdin\fR, \fCstdout\fR, \fCstderr\fR, you may not be able to seek. See QIODevice::isSequentialAccess() for more information. -.PP -See also close(). -.SH "bool QFile::open ( int m, int f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Opens a file in the mode \fIm\fR using an existing file descriptor \fIf\fR. Returns TRUE if successful, otherwise FALSE. -.PP -When a QFile is opened using this function, close() does not actually close the file. -.PP -The QFile that is opened using this function, is automatically set to be in raw mode; this means that the file input/output functions are slow. If you run into performance issues, you should try to use one of the other open functions. -.PP -\fBWarning:\fR If \fIf\fR is one of 0 (stdin), 1 (stdout) or 2 (stderr), you may not be able to seek. size() is set to \fCINT_MAX\fR (in limits.h). -.PP -See also close(). -.SH "int QFile::putch ( int ch )\fC [virtual]\fR" -Writes the character \fIch\fR to the file. -.PP -Returns \fIch\fR, or -1 if some error occurred. -.PP -See also getch() and ungetch(). -.PP -Reimplemented from QIODevice. -.SH "QByteArray QIODevice::readAll ()\fC [virtual]\fR" -This convenience function returns all of the remaining data in the device. -.SH "TQ_LONG QFile::readLine ( char * p, TQ_ULONG maxlen )\fC [virtual]\fR" -Reads a line of text. -.PP -Reads bytes from the file into the char* \fIp\fR, until end-of-line or \fImaxlen\fR bytes have been read, whichever occurs first. Returns the number of bytes read, or -1 if there was an error. Any terminating newline is not stripped. -.PP -This function is only efficient for buffered files. Avoid readLine() for files that have been opened with the IO_Raw flag. -.PP -See also readBlock() and QTextStream::readLine(). -.PP -Reimplemented from QIODevice. -.SH "TQ_LONG QFile::readLine ( QString & s, TQ_ULONG maxlen )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a line of text. -.PP -Reads bytes from the file into string \fIs\fR, until end-of-line or \fImaxlen\fR bytes have been read, whichever occurs first. Returns the number of bytes read, or -1 if there was an error, e.g. end of file. Any terminating newline is not stripped. -.PP -This function is only efficient for buffered files. Avoid using readLine() for files that have been opened with the IO_Raw flag. -.PP -Note that the string is read as plain Latin1 bytes, not Unicode. -.PP -See also readBlock() and QTextStream::readLine(). -.SH "bool QFile::remove ()" -Removes the file specified by the file name currently set. Returns TRUE if successful; otherwise returns FALSE. -.PP -The file is closed before it is removed. -.SH "bool QFile::remove ( const QString & fileName )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes the file \fIfileName\fR. Returns TRUE if successful, otherwise FALSE. -.SH "void QFile::setDecodingFunction ( DecoderFn f )\fC [static]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                      -.PP -Sets the function for decoding 8-bit file names to \fIf\fR. The default uses the locale-specific 8-bit encoding. -.PP -See also encodeName() and decodeName(). -.SH "void QFile::setEncodingFunction ( EncoderFn f )\fC [static]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                      -.PP -Sets the function for encoding Unicode file names to \fIf\fR. The default encodes in the locale-specific 8-bit encoding. -.PP -See also encodeName(). -.SH "void QFile::setErrorString ( const QString & str )\fC [protected]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                      -.PP -Sets the error string returned by the errorString() function to \fIstr\fR. -.PP -See also errorString() and QIODevice::status(). -.SH "void QFile::setName ( const QString & name )" -Sets the name of the file to \fIname\fR. The name can have no path, a relative path or an absolute absolute path. -.PP -Do not call this function if the file has already been opened. -.PP -If the file name has no path or a relative path, the path used will be whatever the application's current directory path is \fIat the time of the open()\fR call. -.PP -Example: -.PP -.nf -.br - QFile file; -.br - QDir::setCurrent( "/tmp" ); -.br - file.setName( "readme.txt" ); -.br - QDir::setCurrent( "/home" ); -.br - file.open( IO_ReadOnly ); // opens "/home/readme.txt" under Unix -.br -.fi -.PP -Note that the directory separator "/" works for all operating systems supported by Qt. -.PP -See also name(), QFileInfo, and QDir. -.SH "Offset QFile::size () const\fC [virtual]\fR" -Returns the file size. -.PP -See also at(). -.PP -Example: table/statistics/statistics.cpp. -.PP -Reimplemented from QIODevice. -.SH "int QFile::ungetch ( int ch )\fC [virtual]\fR" -Puts the character \fIch\fR back into the file and decrements the index if it is not zero. -.PP -This function is normally called to "undo" a getch() operation. -.PP -Returns \fIch\fR, or -1 if an error occurred. -.PP -See also getch() and putch(). -.PP -Reimplemented from QIODevice. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfile.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfile.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfiledialog.3qt b/doc/man/man3/qfiledialog.3qt deleted file mode 100644 index becd98640..000000000 --- a/doc/man/man3/qfiledialog.3qt +++ /dev/null @@ -1,1025 +0,0 @@ -'\" t -.TH QFileDialog 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 -QFileDialog \- Dialogs that allow users to select files or directories -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFileDialog\fR ( const QString & dirName, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" -.br -.ti -1c -.BI "\fBQFileDialog\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" -.br -.ti -1c -.BI "\fB~QFileDialog\fR ()" -.br -.ti -1c -.BI "QString \fBselectedFile\fR () const" -.br -.ti -1c -.BI "QString \fBselectedFilter\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSelectedFilter\fR ( const QString & mask )" -.br -.ti -1c -.BI "virtual void \fBsetSelectedFilter\fR ( int n )" -.br -.ti -1c -.BI "void \fBsetSelection\fR ( const QString & filename )" -.br -.ti -1c -.BI "void \fBselectAll\fR ( bool b )" -.br -.ti -1c -.BI "QStringList \fBselectedFiles\fR () const" -.br -.ti -1c -.BI "QString \fBdirPath\fR () const" -.br -.ti -1c -.BI "void \fBsetDir\fR ( const QDir & dir )" -.br -.ti -1c -.BI "const QDir * \fBdir\fR () const" -.br -.ti -1c -.BI "void \fBsetShowHiddenFiles\fR ( bool s )" -.br -.ti -1c -.BI "bool \fBshowHiddenFiles\fR () const" -.br -.ti -1c -.BI "void \fBrereadDir\fR ()" -.br -.ti -1c -.BI "void \fBresortDir\fR ()" -.br -.ti -1c -.BI "enum \fBMode\fR { AnyFile, ExistingFile, Directory, ExistingFiles, DirectoryOnly }" -.br -.ti -1c -.BI "void \fBsetMode\fR ( Mode )" -.br -.ti -1c -.BI "Mode \fBmode\fR () const" -.br -.ti -1c -.BI "enum \fBViewMode\fR { Detail, List }" -.br -.ti -1c -.BI "enum \fBPreviewMode\fR { NoPreview, Contents, Info }" -.br -.ti -1c -.BI "void \fBsetViewMode\fR ( ViewMode m )" -.br -.ti -1c -.BI "ViewMode \fBviewMode\fR () const" -.br -.ti -1c -.BI "void \fBsetPreviewMode\fR ( PreviewMode m )" -.br -.ti -1c -.BI "PreviewMode \fBpreviewMode\fR () const" -.br -.ti -1c -.BI "bool \fBisInfoPreviewEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBisContentsPreviewEnabled\fR () const" -.br -.ti -1c -.BI "void \fBsetInfoPreviewEnabled\fR ( bool )" -.br -.ti -1c -.BI "void \fBsetContentsPreviewEnabled\fR ( bool )" -.br -.ti -1c -.BI "void \fBsetInfoPreview\fR ( QWidget * w, QFilePreview * preview )" -.br -.ti -1c -.BI "void \fBsetContentsPreview\fR ( QWidget * w, QFilePreview * preview )" -.br -.ti -1c -.BI "QUrl \fBurl\fR () const" -.br -.ti -1c -.BI "void \fBaddFilter\fR ( const QString & filter )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBsetDir\fR ( const QString & pathstr )" -.br -.ti -1c -.BI "void \fBsetUrl\fR ( const QUrlOperator & url )" -.br -.ti -1c -.BI "void \fBsetFilter\fR ( const QString & newFilter )" -.br -.ti -1c -.BI "void \fBsetFilters\fR ( const QString & filters )" -.br -.ti -1c -.BI "void \fBsetFilters\fR ( const char ** types )" -.br -.ti -1c -.BI "void \fBsetFilters\fR ( const QStringList & )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBfileHighlighted\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBfileSelected\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBfilesSelected\fR ( const QStringList & )" -.br -.ti -1c -.BI "void \fBdirEntered\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBfilterSelected\fR ( const QString & )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBgetOpenFileName\fR ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )" -.br -.ti -1c -.BI "QString \fBgetSaveFileName\fR ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )" -.br -.ti -1c -.BI "QString \fBgetExistingDirectory\fR ( const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, bool dirOnly = TRUE, bool resolveSymlinks = TRUE )" -.br -.ti -1c -.BI "QStringList \fBgetOpenFileNames\fR ( const QString & filter = QString::null, const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )" -.br -.ti -1c -.BI "void \fBsetIconProvider\fR ( QFileIconProvider * provider )" -.br -.ti -1c -.BI "QFileIconProvider * \fBiconProvider\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBcontentsPreview\fR - whether the file dialog can provide a contents preview of the currently selected file" -.br -.ti -1c -.BI "QString \fBdirPath\fR - the file dialog's working directory \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBinfoPreview\fR - whether the file dialog can provide preview information about the currently selected file" -.br -.ti -1c -.BI "Mode \fBmode\fR - the file dialog's mode" -.br -.ti -1c -.BI "PreviewMode \fBpreviewMode\fR - the preview mode for the file dialog" -.br -.ti -1c -.BI "QString \fBselectedFile\fR - the name of the selected file \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QStringList \fBselectedFiles\fR - the list of selected files \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QString \fBselectedFilter\fR - the filter which the user has selected in the file dialog \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBshowHiddenFiles\fR - whether hidden files are shown in the file dialog" -.br -.ti -1c -.BI "ViewMode \fBviewMode\fR - the file dialog's view mode" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBaddWidgets\fR ( QLabel * l, QWidget * w, QPushButton * b )" -.br -.ti -1c -.BI "void \fBaddToolButton\fR ( QButton * b, bool separator = FALSE )" -.br -.ti -1c -.BI "void \fBaddLeftWidget\fR ( QWidget * w )" -.br -.ti -1c -.BI "void \fBaddRightWidget\fR ( QWidget * w )" -.br -.in -1c -.SH DESCRIPTION -The QFileDialog class provides dialogs that allow users to select files or directories. -.PP -The QFileDialog class enables a user to traverse their file system in order to select one or many files or a directory. -.PP -The easiest way to create a QFileDialog is to use the static functions. On Windows, these static functions will call the native Windows file dialog and on Mac OS X, these static function will call the native Mac OS X file dialog. -.PP -.nf -.br - QString s = QFileDialog::getOpenFileName( -.br - "/home", -.br - "Images (*.png *.xpm *.jpg)", -.br - this, -.br - "open file dialog", -.br - "Choose a file" ); -.br -.fi -.PP -In the above example, a modal QFileDialog is created using a static function. The startup directory is set to "/home". The file filter is set to "Images (*.png *.xpm *.jpg)". The parent of the file dialog is set to \fIthis\fR and it is given the identification name - "open file dialog". The caption at the top of file dialog is set to "Choose a file". If you want to use multiple filters, separate each one with \fItwo\fR semi-colons, e.g. -.PP -.nf -.br - "Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)" -.br -.fi -.PP -You can create your own QFileDialog without using the static functions. By calling setMode(), you can set what can be returned by the QFileDialog. -.PP -.nf -.br - QFileDialog* fd = new QFileDialog( this, "file dialog", TRUE ); -.br - fd->setMode( QFileDialog::AnyFile ); -.br -.fi -.PP -In the above example, the mode of the file dialog is set to AnyFile, meaning that the user can select any file, or even specify a file that doesn't exist. This mode is useful for creating a "File Save As" file dialog. Use ExistingFile if the user must select an existing file or Directory if only a directory may be selected. (See the QFileDialog::Mode enum for the complete list of modes.) -.PP -You can retrieve the dialog's mode with mode(). Use setFilter() to set the dialog's file filter, e.g. -.PP -.nf -.br - fd->setFilter( "Images (*.png *.xpm *.jpg)" ); -.br -.fi -.PP -In the above example, the filter is set to "Images (*.png *.xpm *.jpg)", this means that only files with the extension \fCpng\fR, \fCxpm\fR or \fCjpg\fR will be shown in the QFileDialog. You can apply several filters by using setFilters() and add additional filters with addFilter(). Use setSelectedFilter() to select one of the filters you've given as the file dialog's default filter. Whenever the user changes the filter the filterSelected() signal is emitted. -.PP -The file dialog has two view modes, QFileDialog::List which simply lists file and directory names and QFileDialog::Detail which displays additional information alongside each name, e.g. file size, modification date, etc. Set the mode with setViewMode(). -.PP -.nf -.br - fd->setViewMode( QFileDialog::Detail ); -.br -.fi -.PP -The last important function you will need to use when creating your own file dialog is selectedFile(). -.PP -.nf -.br - QString fileName; -.br - if ( fd->exec() == QDialog::Accepted ) -.br - fileName = fd->selectedFile(); -.br -.fi -.PP -In the above example, a modal file dialog is created and shown. If the user clicked OK, then the file they selected is put in \fCfileName\fR. -.PP -If you are using the ExistingFiles mode then you will need to use selectedFiles() which will return the selected files in a QStringList. -.PP -The dialog's working directory can be set with setDir(). The display of hidden files is controlled with setShowHiddenFiles(). The dialog can be forced to re-read the directory with rereadDir() and re-sort the directory with resortDir(). All the files in the current directory can be selected with selectAll(). -.SH "Creating and using preview widgets" -There are two kinds of preview widgets that can be used with QFileDialogs: \fIcontent\fR preview widgets and \fIinformation\fR preview widgets. They are created and used in the same way except that the function names differ, e.g. setContentsPreview() and setInfoPreview(). -.PP -A preview widget is a widget that is placed inside a QFileDialog so that the user can see either the contents of the file, or information about the file. -.PP -.nf -.br - class Preview : public QLabel, public QFilePreview -.br - { -.br - public: -.br - Preview( QWidget *parent=0 ) : QLabel( parent ) {} -.br -.br - void previewUrl( const QUrl &u ) -.br - { -.br - QString path = u.path(); -.br - QPixmap pix( path ); -.br - if ( pix.isNull() ) -.br - setText( "This is not a pixmap" ); -.br - else -.br - setPixmap( pix ); -.br - } -.br - }; -.br -.fi -.PP -In the above snippet, we create a preview widget which inherits from QLabel and QFilePreview. File preview widgets \fImust\fR inherit from QFilePreview. -.PP -Inside the class we reimplement QFilePreview::previewUrl(), this is where we determine what happens when a file is selected. In the above example we only show a preview of the file if it is a valid pixmap. Here's how to make a file dialog use a preview widget: -.PP -.nf -.br - Preview* p = new Preview; -.br -.br - QFileDialog* fd = new QFileDialog( this ); -.br - fd->setContentsPreviewEnabled( TRUE ); -.br - fd->setContentsPreview( p, p ); -.br - fd->setPreviewMode( QFileDialog::Contents ); -.br - fd->show(); -.br -.fi -.PP -The first line creates an instance of our preview widget. We then create our file dialog and call setContentsPreviewEnabled( TRUE ), this tell the file dialog to preview the contents of the currently selected file. We then call setContentsPreview() -- note that we pass the same preview widget twice. Finally, before showing the file dialog, we call setPreviewMode() setting the mode to \fIContents\fR which will show the contents preview of the file that the user has selected. -.PP -If you create another preview widget that is used for displaying information about a file, create it in the same way as the contents preview widget and call setInfoPreviewEnabled(), and setInfoPreview(). Then the user will be able to switch between the two preview modes. -.PP -For more information about creating a QFilePreview widget see QFilePreview. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also Dialog Classes. -.SS "Member Type Documentation" -.SH "QFileDialog::Mode" -This enum is used to indicate what the user may select in the file dialog, i.e. what the dialog will return if the user clicks OK. -.TP -\fCQFileDialog::AnyFile\fR - The name of a file, whether it exists or not. -.TP -\fCQFileDialog::ExistingFile\fR - The name of a single existing file. -.TP -\fCQFileDialog::Directory\fR - The name of a directory. Both files and directories are displayed. -.TP -\fCQFileDialog::DirectoryOnly\fR - The name of a directory. The file dialog will only display directories. -.TP -\fCQFileDialog::ExistingFiles\fR - The names of zero or more existing files. -.PP -See setMode(). -.SH "QFileDialog::PreviewMode" -This enum describes the preview mode of the file dialog. -.TP -\fCQFileDialog::NoPreview\fR - No preview is shown at all. -.TP -\fCQFileDialog::Contents\fR - Show a preview of the contents of the current file using the contents preview widget. -.TP -\fCQFileDialog::Info\fR - Show information about the current file using the info preview widget. -.PP -See setPreviewMode(), setContentsPreview() and setInfoPreview(). -.SH "QFileDialog::ViewMode" -This enum describes the view mode of the file dialog, i.e. what information about each file will be displayed. -.TP -\fCQFileDialog::List\fR - Display file and directory names with icons. -.TP -\fCQFileDialog::Detail\fR - Display file and directory names with icons plus additional information, such as file size and modification date. -.PP -See setViewMode(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFileDialog::QFileDialog ( const QString & dirName, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" -Constructs a file dialog called \fIname\fR with the parent, \fIparent\fR. If \fImodal\fR is TRUE then the file dialog is modal; otherwise it is modeless. -.PP -If \fIdirName\fR is specified then it will be used as the dialog's working directory, i.e. it will be the directory that is shown when the dialog appears. If \fIfilter\fR is specified it will be used as the dialog's file filter. -.SH "QFileDialog::QFileDialog ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" -Constructs a file dialog called \fIname\fR, with the parent, \fIparent\fR. If \fImodal\fR is TRUE then the file dialog is modal; otherwise it is modeless. -.SH "QFileDialog::~QFileDialog ()" -Destroys the file dialog. -.SH "void QFileDialog::addFilter ( const QString & filter )" -Adds the filter \fIfilter\fR to the list of filters and makes it the current filter. -.PP -.nf -.br - QFileDialog* fd = new QFileDialog( this ); -.br - fd->addFilter( "Images (*.png *.jpg *.xpm)" ); -.br - fd->show(); -.br -.fi -.PP -In the above example, a file dialog is created, and the file filter "Images (*.png *.jpg *.xpm)" is added and is set as the current filter. The original filter, "All Files (*)", is still available. -.PP -See also setFilter() and setFilters(). -.SH "void QFileDialog::addLeftWidget ( QWidget * w )\fC [protected]\fR" -Adds the widget \fIw\fR to the left-hand side of the file dialog. -.PP -See also addRightWidget(), addWidgets(), and addToolButton(). -.SH "void QFileDialog::addRightWidget ( QWidget * w )\fC [protected]\fR" -Adds the widget \fIw\fR to the right-hand side of the file dialog. -.PP -See also addLeftWidget(), addWidgets(), and addToolButton(). -.SH "void QFileDialog::addToolButton ( QButton * b, bool separator = FALSE )\fC [protected]\fR" -Adds the tool button \fIb\fR to the row of tool buttons at the top of the file dialog. The button is appended to the right of this row. If \fIseparator\fR is TRUE, a small space is inserted between the last button of the row and the new button \fIb\fR. -.PP -See also addWidgets(), addLeftWidget(), and addRightWidget(). -.SH "void QFileDialog::addWidgets ( QLabel * l, QWidget * w, QPushButton * b )\fC [protected]\fR" -Adds the specified widgets to the bottom of the file dialog. The label \fIl\fR is placed underneath the "file name" and the "file types" labels. The widget \fIw\fR is placed underneath the file types combobox. The button \fIb\fR is placed underneath the Cancel pushbutton. -.PP -.nf -.br - MyFileDialog::MyFileDialog( QWidget* parent, const char* name ) : -.br - QFileDialog( parent, name ) -.br - { -.br - QLabel* label = new QLabel( "Added widgets", this ); -.br - QLineEdit* lineedit = new QLineEdit( this ); -.br - QPushButton* pushbutton = new QPushButton( this ); -.br -.br - addWidgets( label, lineedit, pushbutton ); -.br - } -.br -.fi -.PP -If you don't want to have one of the widgets added, pass 0 in that widget's position. -.PP -Every time you call this function, a new row of widgets will be added to the bottom of the file dialog. -.PP -See also addToolButton(), addLeftWidget(), and addRightWidget(). -.SH "const QDir * QFileDialog::dir () const" -Returns the current directory shown in the file dialog. -.PP -The ownership of the QDir pointer is transferred to the caller, so it must be deleted by the caller when no longer required. -.PP -See also setDir(). -.SH "void QFileDialog::dirEntered ( const QString & )\fC [signal]\fR" -This signal is emitted when the user enters a directory. -.PP -See also dir(). -.SH "QString QFileDialog::dirPath () const" -Returns the file dialog's working directory. See the "dirPath" property for details. -.SH "void QFileDialog::fileHighlighted ( const QString & )\fC [signal]\fR" -This signal is emitted when the user highlights a file, i.e. makes it the current file. -.PP -See also fileSelected() and filesSelected(). -.SH "void QFileDialog::fileSelected ( const QString & )\fC [signal]\fR" -This signal is emitted when the user selects a file. -.PP -See also filesSelected(), fileHighlighted(), and selectedFile. -.SH "void QFileDialog::filesSelected ( const QStringList & )\fC [signal]\fR" -This signal is emitted when the user selects one or more files in \fIExistingFiles\fR mode. -.PP -See also fileSelected(), fileHighlighted(), and selectedFiles. -.SH "void QFileDialog::filterSelected ( const QString & )\fC [signal]\fR" -This signal is emitted when the user selects a filter. -.PP -See also selectedFilter. -.SH "QString QFileDialog::getExistingDirectory ( const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, bool dirOnly = TRUE, bool resolveSymlinks = TRUE )\fC [static]\fR" -This is a convenience static function that will return an existing directory selected by the user. -.PP -.nf -.br - QString s = QFileDialog::getExistingDirectory( -.br - "/home", -.br - this, -.br - "get existing directory", -.br - "Choose a directory", -.br - TRUE ); -.br -.fi -.PP -This function creates a modal file dialog called \fIname\fR, with parent, \fIparent\fR. If parent is not 0, the dialog will be shown centered over the parent. -.PP -The dialog's working directory is set to \fIdir\fR, and the caption is set to \fIcaption\fR. Either of these may be QString::null in which case the current directory and a default caption will be used respectively. -.PP -Note on Windows that if \fIdir\fR is QString::null then the dialog's working directory will be set to the user's My Documents directory. -.PP -If \fIdirOnly\fR is TRUE, then only directories will be shown in the file dialog; otherwise both directories and files will be shown. -.PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. -.PP -Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). -.PP -See also getOpenFileName(), getOpenFileNames(), and getSaveFileName(). -.SH "QString QFileDialog::getOpenFileName ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" -This is a convenience static function that returns an existing file selected by the user. If the user pressed Cancel, it returns a null string. -.PP -.nf -.br - QString s = QFileDialog::getOpenFileName( -.br - "/home", -.br - "Images (*.png *.xpm *.jpg)", -.br - this, -.br - "open file dialog", -.br - "Choose a file to open" ); -.br -.fi -.PP -The function creates a modal file dialog called \fIname\fR, with parent, \fIparent\fR. If a parent is not 0, the dialog will be shown centered over the parent. -.PP -The file dialog's working directory will be set to \fIstartWith\fR. If \fIstartWith\fR includes a file name, the file will be selected. The filter is set to \fIfilter\fR so that only those files which match the filter are shown. The filter selected is set to \fIselectedFilter\fR. The parameters \fIstartWith\fR, \fIselectedFilter\fR and \fIfilter\fR may be QString::null. -.PP -The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified then a default caption will be used. -.PP -Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). -.PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. -.PP -See also getOpenFileNames(), getSaveFileName(), and getExistingDirectory(). -.PP -Examples: -.)l action/application.cpp, addressbook/mainwindow.cpp, application/application.cpp, distributor/distributor.ui.h, network/ftpclient/ftpmainwindow.ui.h, qwerty/qwerty.cpp, and showimg/showimg.cpp. -.SH "QStringList QFileDialog::getOpenFileNames ( const QString & filter = QString::null, const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" -This is a convenience static function that will return one or more existing files selected by the user. -.PP -.nf -.br - QStringList files = QFileDialog::getOpenFileNames( -.br - "Images (*.png *.xpm *.jpg)", -.br - "/home", -.br - this, -.br - "open files dialog", -.br - "Select one or more files to open" ); -.br -.fi -.PP -This function creates a modal file dialog called \fIname\fR, with parent \fIparent\fR. If \fIparent\fR is not 0, the dialog will be shown centered over the parent. -.PP -The file dialog's working directory will be set to \fIdir\fR. If \fIdir\fR includes a file name, the file will be selected. The filter is set to \fIfilter\fR so that only those files which match the filter are shown. The filter selected is set to \fIselectedFilter\fR. The parameters \fIdir\fR, \fIselectedFilter\fR and \fIfilter\fR may be QString::null. -.PP -The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified then a default caption will be used. -.PP -Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). -.PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. -.PP -Note that if you want to iterate over the list of files, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = files; -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also getOpenFileName(), getSaveFileName(), and getExistingDirectory(). -.SH "QString QFileDialog::getSaveFileName ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" -This is a convenience static function that will return a file name selected by the user. The file does not have to exist. -.PP -It creates a modal file dialog called \fIname\fR, with parent, \fIparent\fR. If a parent is not 0, the dialog will be shown centered over the parent. -.PP -.nf -.br - QString s = QFileDialog::getSaveFileName( -.br - "/home", -.br - "Images (*.png *.xpm *.jpg)", -.br - this, -.br - "save file dialog", -.br - "Choose a filename to save under" ); -.br -.fi -.PP -The file dialog's working directory will be set to \fIstartWith\fR. If \fIstartWith\fR includes a file name, the file will be selected. The filter is set to \fIfilter\fR so that only those files which match the filter are shown. The filter selected is set to \fIselectedFilter\fR. The parameters \fIstartWith\fR, \fIselectedFilter\fR and \fIfilter\fR may be QString::null. -.PP -The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified then a default caption will be used. -.PP -Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar. -.PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. -.PP -See also getOpenFileName(), getOpenFileNames(), and getExistingDirectory(). -.PP -Examples: -.)l action/application.cpp, addressbook/mainwindow.cpp, application/application.cpp, network/ftpclient/ftpmainwindow.ui.h, qmag/qmag.cpp, qwerty/qwerty.cpp, and showimg/showimg.cpp. -.SH "QFileIconProvider * QFileDialog::iconProvider ()\fC [static]\fR" -Returns a pointer to the icon provider currently set on the file dialog. By default there is no icon provider, and this function returns 0. -.PP -See also setIconProvider() and QFileIconProvider. -.SH "bool QFileDialog::isContentsPreviewEnabled () const" -Returns TRUE if the file dialog can provide a contents preview of the currently selected file; otherwise returns FALSE. See the "contentsPreview" property for details. -.SH "bool QFileDialog::isInfoPreviewEnabled () const" -Returns TRUE if the file dialog can provide preview information about the currently selected file; otherwise returns FALSE. See the "infoPreview" property for details. -.SH "Mode QFileDialog::mode () const" -Returns the file dialog's mode. See the "mode" property for details. -.SH "PreviewMode QFileDialog::previewMode () const" -Returns the preview mode for the file dialog. See the "previewMode" property for details. -.SH "void QFileDialog::rereadDir ()" -Rereads the current directory shown in the file dialog. -.PP -The only time you will need to call this function is if the contents of the directory change and you wish to refresh the file dialog to reflect the change. -.PP -See also resortDir(). -.SH "void QFileDialog::resortDir ()" -Re-sorts the displayed directory. -.PP -See also rereadDir(). -.SH "void QFileDialog::selectAll ( bool b )" -If \fIb\fR is TRUE then all the files in the current directory are selected; otherwise, they are deselected. -.SH "QString QFileDialog::selectedFile () const" -Returns the name of the selected file. See the "selectedFile" property for details. -.SH "QStringList QFileDialog::selectedFiles () const" -Returns the list of selected files. See the "selectedFiles" property for details. -.SH "QString QFileDialog::selectedFilter () const" -Returns the filter which the user has selected in the file dialog. See the "selectedFilter" property for details. -.SH "void QFileDialog::setContentsPreview ( QWidget * w, QFilePreview * preview )" -Sets the widget to be used for displaying the contents of the file to the widget \fIw\fR and a preview of those contents to the QFilePreview \fIpreview\fR. -.PP -Normally you would create a preview widget that derives from both QWidget and QFilePreview, so you should pass the same widget twice. If you don't, you must remember to delete the preview object in order to avoid memory leaks. -.PP -.nf -.br - class Preview : public QLabel, public QFilePreview -.br - { -.br - public: -.br - Preview( QWidget *parent=0 ) : QLabel( parent ) {} -.br -.br - void previewUrl( const QUrl &u ) -.br - { -.br - QString path = u.path(); -.br - QPixmap pix( path ); -.br - if ( pix.isNull() ) -.br - setText( "This is not a pixmap" ); -.br - else -.br - setPixmap( pix ); -.br - } -.br - }; -.br -.br - //... -.br -.br - int main( int argc, char** argv ) -.br - { -.br - Preview* p = new Preview; -.br -.br - QFileDialog* fd = new QFileDialog( this ); -.br - fd->setContentsPreviewEnabled( TRUE ); -.br - fd->setContentsPreview( p, p ); -.br - fd->setPreviewMode( QFileDialog::Contents ); -.br - fd->show(); -.br - } -.br -.fi -.PP -See also contentsPreview, setInfoPreview(), and previewMode. -.PP -Example: qdir/qdir.cpp. -.SH "void QFileDialog::setContentsPreviewEnabled ( bool )" -Sets whether the file dialog can provide a contents preview of the currently selected file. See the "contentsPreview" property for details. -.SH "void QFileDialog::setDir ( const QDir & dir )" -Sets the file dialog's working directory to \fIdir\fR. -.PP -See also dir(). -.SH "void QFileDialog::setDir ( const QString & pathstr )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the file dialog's working directory to \fIpathstr\fR. -.PP -See also dir(). -.SH "void QFileDialog::setFilter ( const QString & newFilter )\fC [slot]\fR" -Sets the filter used in the file dialog to \fInewFilter\fR. -.PP -If \fInewFilter\fR contains a pair of parentheses containing one or more of \fI\fBanything*something\fR\fR separated by spaces or by semi-colons then only the text contained in the parentheses is used as the filter. This means that these calls are all equivalent: -.PP -.nf -.br - fd->setFilter( "All C++ files (*.cpp *.cc *.C *.cxx *.c++)" ); -.br - fd->setFilter( "*.cpp *.cc *.C *.cxx *.c++" ); -.br - fd->setFilter( "All C++ files (*.cpp;*.cc;*.C;*.cxx;*.c++)" ); -.br - fd->setFilter( "*.cpp;*.cc;*.C;*.cxx;*.c++" ); -.br -.fi -.PP -See also setFilters(). -.SH "void QFileDialog::setFilters ( const QString & filters )\fC [slot]\fR" -Sets the filters used in the file dialog to \fIfilters\fR. Each group of filters must be separated by \fC;;\fR (\fItwo\fR semi-colons). -.PP -.nf -.br - QString types("Image files (*.png *.xpm *.jpg);;" -.br - "Text files (*.txt);;" -.br - "Any files (*)"); -.br - QFileDialog fd = new QFileDialog( this ); -.br - fd->setFilters( types ); -.br - fd->show(); -.br -.fi -.SH "void QFileDialog::setFilters ( const char ** types )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fItypes\fR must be a null-terminated list of strings. -.SH "void QFileDialog::setFilters ( const QStringList & )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QFileDialog::setIconProvider ( QFileIconProvider * provider )\fC [static]\fR" -Sets the QFileIconProvider used by the file dialog to \fIprovider\fR. -.PP -The default is that there is no QFileIconProvider and QFileDialog just draws a folder icon next to each directory and nothing next to files. -.PP -See also QFileIconProvider and iconProvider(). -.PP -Example: showimg/main.cpp. -.SH "void QFileDialog::setInfoPreview ( QWidget * w, QFilePreview * preview )" -Sets the widget to be used for displaying information about the file to the widget \fIw\fR and a preview of that information to the QFilePreview \fIpreview\fR. -.PP -Normally you would create a preview widget that derives from both QWidget and QFilePreview, so you should pass the same widget twice. If you don't, you must remember to delete the preview object in order to avoid memory leaks. -.PP -.nf -.br - class Preview : public QLabel, public QFilePreview -.br - { -.br - public: -.br - Preview( QWidget *parent=0 ) : QLabel( parent ) {} -.br -.br - void previewUrl( const QUrl &u ) -.br - { -.br - QString path = u.path(); -.br - QPixmap pix( path ); -.br - if ( pix.isNull() ) -.br - setText( "This is not a pixmap" ); -.br - else -.br - setText( "This is a pixmap" ); -.br - } -.br - }; -.br -.br - //... -.br -.br - int main( int argc, char** argv ) -.br - { -.br - Preview* p = new Preview; -.br -.br - QFileDialog* fd = new QFileDialog( this ); -.br - fd->setInfoPreviewEnabled( TRUE ); -.br - fd->setInfoPreview( p, p ); -.br - fd->setPreviewMode( QFileDialog::Info ); -.br - fd->show(); -.br - } -.br -.br -.fi -.PP -See also setContentsPreview(), infoPreview, and previewMode. -.SH "void QFileDialog::setInfoPreviewEnabled ( bool )" -Sets whether the file dialog can provide preview information about the currently selected file. See the "infoPreview" property for details. -.SH "void QFileDialog::setMode ( Mode )" -Sets the file dialog's mode. See the "mode" property for details. -.SH "void QFileDialog::setPreviewMode ( PreviewMode m )" -Sets the preview mode for the file dialog to \fIm\fR. See the "previewMode" property for details. -.SH "void QFileDialog::setSelectedFilter ( const QString & mask )\fC [virtual]\fR" -Sets the current filter selected in the file dialog to the first one that contains the text \fImask\fR. -.SH "void QFileDialog::setSelectedFilter ( int n )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the current filter selected in the file dialog to the \fIn\fR-th filter in the filter list. -.PP -See also filterSelected(), selectedFilter, selectedFiles, and selectedFile. -.SH "void QFileDialog::setSelection ( const QString & filename )" -Sets the default selection to \fIfilename\fR. If \fIfilename\fR is absolute, setDir() is also called to set the file dialog's working directory to the filename's directory. -.PP -Example: qdir/qdir.cpp. -.SH "void QFileDialog::setShowHiddenFiles ( bool s )" -Sets whether hidden files are shown in the file dialog to \fIs\fR. See the "showHiddenFiles" property for details. -.SH "void QFileDialog::setUrl ( const QUrlOperator & url )\fC [slot]\fR" -Sets the file dialog's working directory to the directory specified at \fIurl\fR. -.PP -See also url(). -.SH "void QFileDialog::setViewMode ( ViewMode m )" -Sets the file dialog's view mode to \fIm\fR. See the "viewMode" property for details. -.SH "bool QFileDialog::showHiddenFiles () const" -Returns TRUE if hidden files are shown in the file dialog; otherwise returns FALSE. See the "showHiddenFiles" property for details. -.SH "QUrl QFileDialog::url () const" -Returns the URL of the current working directory in the file dialog. -.PP -See also setUrl(). -.PP -Example: network/networkprotocol/view.cpp. -.SH "ViewMode QFileDialog::viewMode () const" -Returns the file dialog's view mode. See the "viewMode" property for details. -.SS "Property Documentation" -.SH "bool contentsPreview" -This property holds whether the file dialog can provide a contents preview of the currently selected file. -.PP -The default is FALSE. -.PP -See also setContentsPreview() and infoPreview. -.PP -Set this property's value with setContentsPreviewEnabled() and get this property's value with isContentsPreviewEnabled(). -.SH "QString dirPath" -This property holds the file dialog's working directory. -.PP -Get this property's value with dirPath(). -.PP -See also dir() and setDir(). -.SH "bool infoPreview" -This property holds whether the file dialog can provide preview information about the currently selected file. -.PP -The default is FALSE. -.PP -Set this property's value with setInfoPreviewEnabled() and get this property's value with isInfoPreviewEnabled(). -.SH "Mode mode" -This property holds the file dialog's mode. -.PP -The default mode is ExistingFile. -.PP -Set this property's value with setMode() and get this property's value with mode(). -.SH "PreviewMode previewMode" -This property holds the preview mode for the file dialog. -.PP -If you set the mode to be a mode other than \fINoPreview\fR, you must use setInfoPreview() or setContentsPreview() to set the dialog's preview widget to your preview widget and enable the preview widget(s) with setInfoPreviewEnabled() or setContentsPreviewEnabled(). -.PP -See also infoPreview, contentsPreview, and viewMode. -.PP -Set this property's value with setPreviewMode() and get this property's value with previewMode(). -.SH "QString selectedFile" -This property holds the name of the selected file. -.PP -If a file was selected selectedFile contains the file's name including its absolute path; otherwise selectedFile is empty. -.PP -See also QString::isEmpty(), selectedFiles, and selectedFilter. -.PP -Get this property's value with selectedFile(). -.SH "QStringList selectedFiles" -This property holds the list of selected files. -.PP -If one or more files are selected, selectedFiles contains their names including their absolute paths. If no files are selected or the mode isn't ExistingFiles selectedFiles is an empty list. -.PP -It is more convenient to use selectedFile() if the mode is ExistingFile, Directory or DirectoryOnly. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myFileDialog.selectedFiles(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also selectedFile, selectedFilter, and QValueList::empty(). -.PP -Get this property's value with selectedFiles(). -.SH "QString selectedFilter" -This property holds the filter which the user has selected in the file dialog. -.PP -Get this property's value with selectedFilter(). -.PP -See also filterSelected(), selectedFiles, and selectedFile. -.SH "bool showHiddenFiles" -This property holds whether hidden files are shown in the file dialog. -.PP -The default is FALSE, i.e. don't show hidden files. -.PP -Set this property's value with setShowHiddenFiles() and get this property's value with showHiddenFiles(). -.SH "ViewMode viewMode" -This property holds the file dialog's view mode. -.PP -If you set the view mode to be \fIDetail\fR (the default), then you will see the file's details, such as the size of the file and the date the file was last modified in addition to the file's name. -.PP -If you set the view mode to be \fIList\fR, then you will just see a list of the files and folders. -.PP -See QFileDialog::ViewMode -.PP -Set this property's value with setViewMode() and get this property's value with viewMode(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfiledialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfiledialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfileiconprovider.3qt b/doc/man/man3/qfileiconprovider.3qt deleted file mode 100644 index d7d088c97..000000000 --- a/doc/man/man3/qfileiconprovider.3qt +++ /dev/null @@ -1,68 +0,0 @@ -'\" t -.TH QFileIconProvider 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 -QFileIconProvider \- Icons for QFileDialog to use -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFileIconProvider\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual const QPixmap * \fBpixmap\fR ( const QFileInfo & info )" -.br -.in -1c -.SH DESCRIPTION -The QFileIconProvider class provides icons for QFileDialog to use. -.PP -By default QFileIconProvider is not used, but any application or library can subclass it, reimplement pixmap() to return a suitable icon, and make all QFileDialog objects use it by calling the static function QFileDialog::setIconProvider(). -.PP -It is advisable to make all the icons that QFileIconProvider returns be the same size or at least the same width. This makes the list view look much better. -.PP -See also QFileDialog and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFileIconProvider::QFileIconProvider ( QObject * parent = 0, const char * name = 0 )" -Constructs an empty file icon provider called \fIname\fR, with the parent \fIparent\fR. -.SH "const QPixmap * QFileIconProvider::pixmap ( const QFileInfo & info )\fC [virtual]\fR" -Returns a pointer to a pixmap that should be used to signify the file with the information \fIinfo\fR. -.PP -If pixmap() returns 0, QFileDialog draws the default pixmap. -.PP -The default implementation returns particular icons for files, directories, link-files and link-directories. It returns a blank "icon" for other types. -.PP -If you return a pixmap here, it should measure 16x16 pixels. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qfileiconprovider.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfileiconprovider.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfileinfo.3qt b/doc/man/man3/qfileinfo.3qt deleted file mode 100644 index 5cf8195df..000000000 --- a/doc/man/man3/qfileinfo.3qt +++ /dev/null @@ -1,537 +0,0 @@ -'\" t -.TH QFileInfo 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 -QFileInfo \- System-independent file information -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                      -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBPermissionSpec\fR { ReadOwner = 04000, WriteOwner = 02000, ExeOwner = 01000, ReadUser = 00400, WriteUser = 00200, ExeUser = 00100, ReadGroup = 00040, WriteGroup = 00020, ExeGroup = 00010, ReadOther = 00004, WriteOther = 00002, ExeOther = 00001 }" -.br -.ti -1c -.BI "\fBQFileInfo\fR ()" -.br -.ti -1c -.BI "\fBQFileInfo\fR ( const QString & file )" -.br -.ti -1c -.BI "\fBQFileInfo\fR ( const QFile & file )" -.br -.ti -1c -.BI "\fBQFileInfo\fR ( const QDir & d, const QString & fileName )" -.br -.ti -1c -.BI "\fBQFileInfo\fR ( const QFileInfo & fi )" -.br -.ti -1c -.BI "\fB~QFileInfo\fR ()" -.br -.ti -1c -.BI "QFileInfo & \fBoperator=\fR ( const QFileInfo & fi )" -.br -.ti -1c -.BI "void \fBsetFile\fR ( const QString & file )" -.br -.ti -1c -.BI "void \fBsetFile\fR ( const QFile & file )" -.br -.ti -1c -.BI "void \fBsetFile\fR ( const QDir & d, const QString & fileName )" -.br -.ti -1c -.BI "bool \fBexists\fR () const" -.br -.ti -1c -.BI "void \fBrefresh\fR () const" -.br -.ti -1c -.BI "bool \fBcaching\fR () const" -.br -.ti -1c -.BI "void \fBsetCaching\fR ( bool enable )" -.br -.ti -1c -.BI "QString \fBfilePath\fR () const" -.br -.ti -1c -.BI "QString \fBfileName\fR () const" -.br -.ti -1c -.BI "QString \fBabsFilePath\fR () const" -.br -.ti -1c -.BI "QString \fBbaseName\fR ( bool complete = FALSE ) const" -.br -.ti -1c -.BI "QString \fBextension\fR ( bool complete = TRUE ) const" -.br -.ti -1c -.BI "QString \fBdirPath\fR ( bool absPath = FALSE ) const" -.br -.ti -1c -.BI "QDir \fBdir\fR ( bool absPath = FALSE ) const" -.br -.ti -1c -.BI "bool \fBisReadable\fR () const" -.br -.ti -1c -.BI "bool \fBisWritable\fR () const" -.br -.ti -1c -.BI "bool \fBisExecutable\fR () const" -.br -.ti -1c -.BI "bool \fBisHidden\fR () const" -.br -.ti -1c -.BI "bool \fBisRelative\fR () const" -.br -.ti -1c -.BI "bool \fBconvertToAbs\fR ()" -.br -.ti -1c -.BI "bool \fBisFile\fR () const" -.br -.ti -1c -.BI "bool \fBisDir\fR () const" -.br -.ti -1c -.BI "bool \fBisSymLink\fR () const" -.br -.ti -1c -.BI "QString \fBreadLink\fR () const" -.br -.ti -1c -.BI "QString \fBowner\fR () const" -.br -.ti -1c -.BI "uint \fBownerId\fR () const" -.br -.ti -1c -.BI "QString \fBgroup\fR () const" -.br -.ti -1c -.BI "uint \fBgroupId\fR () const" -.br -.ti -1c -.BI "bool \fBpermission\fR ( int permissionSpec ) const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "QDateTime \fBcreated\fR () const" -.br -.ti -1c -.BI "QDateTime \fBlastModified\fR () const" -.br -.ti -1c -.BI "QDateTime \fBlastRead\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QFileInfo class provides system-independent file information. -.PP -QFileInfo provides information about a file's name and position (path) in the file system, its access rights and whether it is a directory or symbolic link, etc. The file's size and last modified/read times are also available. -.PP -A QFileInfo can point to a file with either a relative or an absolute file path. Absolute file paths begin with the directory separator "/" (or with a drive specification on Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current working directory. An example of an absolute path is the string "/tmp/quartz". A relative path might look like "src/fatlib". You can use the function isRelative() to check whether a QFileInfo is using a relative or an absolute file path. You can call the function convertToAbs() to convert a relative QFileInfo's path to an absolute path. -.PP -The file that the QFileInfo works on is set in the constructor or later with setFile(). Use exists() to see if the file exists and size() to get its size. -.PP -To speed up performance, QFileInfo caches information about the file. Because files can be changed by other users or programs, or even by other parts of the same program, there is a function that refreshes the file information: refresh(). If you want to switch off a QFileInfo's caching and force it to access the file system every time you request information from it call setCaching(FALSE). -.PP -The file's type is obtained with isFile(), isDir() and isSymLink(). The readLink() function provides the name of the file the symlink points to. -.PP -Elements of the file's name can be extracted with dirPath() and fileName(). The fileName()'s parts can be extracted with baseName() and extension(). -.PP -The file's dates are returned by created(), lastModified() and lastRead(). Information about the file's access permissions is obtained with isReadable(), isWritable() and isExecutable(). The file's ownership is available from owner(), ownerId(), group() and groupId(). You can examine a file's permissions and ownership in a single statement using the permission() function. -.PP -If you need to read and traverse directories, see the QDir class. -.PP -See also Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QFileInfo::PermissionSpec" -This enum is used by the permission() function to report the permissions and ownership of a file. The values may be OR-ed together to test multiple permissions and ownership values. -.TP -\fCQFileInfo::ReadOwner\fR - The file is readable by the owner of the file. -.TP -\fCQFileInfo::WriteOwner\fR - The file is writable by the owner of the file. -.TP -\fCQFileInfo::ExeOwner\fR - The file is executable by the owner of the file. -.TP -\fCQFileInfo::ReadUser\fR - The file is readable by the user. -.TP -\fCQFileInfo::WriteUser\fR - The file is writable by the user. -.TP -\fCQFileInfo::ExeUser\fR - The file is executable by the user. -.TP -\fCQFileInfo::ReadGroup\fR - The file is readable by the group. -.TP -\fCQFileInfo::WriteGroup\fR - The file is writable by the group. -.TP -\fCQFileInfo::ExeGroup\fR - The file is executable by the group. -.TP -\fCQFileInfo::ReadOther\fR - The file is readable by anyone. -.TP -\fCQFileInfo::WriteOther\fR - The file is writable by anyone. -.TP -\fCQFileInfo::ExeOther\fR - The file is executable by anyone. -.PP -\fBWarning:\fR The semantics of ReadUser, WriteUser and ExeUser are unfortunately not platform independent: on Unix, the rights of the owner of the file are returned and on Windows the rights of the current user are returned. This behavior might change in a future Qt version. If you want to find the rights of the owner of the file, you should use the flags ReadOwner, WriteOwner and ExeOwner. If you want to find out the rights of the current user, you should use isReadable(), isWritable() and isExecutable(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFileInfo::QFileInfo ()" -Constructs a new empty QFileInfo. -.SH "QFileInfo::QFileInfo ( const QString & file )" -Constructs a new QFileInfo that gives information about the given file. The \fIfile\fR can also include an absolute or relative path. -.PP -\fBWarning:\fR Some functions might behave in a counter-intuitive way if \fIfile\fR has a trailing directory separator. -.PP -See also setFile(), isRelative(), QDir::setCurrent(), and QDir::isRelativePath(). -.SH "QFileInfo::QFileInfo ( const QFile & file )" -Constructs a new QFileInfo that gives information about file \fIfile\fR. -.PP -If the \fIfile\fR has a relative path, the QFileInfo will also have a relative path. -.PP -See also isRelative(). -.SH "QFileInfo::QFileInfo ( const QDir & d, const QString & fileName )" -Constructs a new QFileInfo that gives information about the file called \fIfileName\fR in the directory \fId\fR. -.PP -If \fId\fR has a relative path, the QFileInfo will also have a relative path. -.PP -See also isRelative(). -.SH "QFileInfo::QFileInfo ( const QFileInfo & fi )" -Constructs a new QFileInfo that is a copy of \fIfi\fR. -.SH "QFileInfo::~QFileInfo ()" -Destroys the QFileInfo and frees its resources. -.SH "QString QFileInfo::absFilePath () const" -Returns the absolute path including the file name. -.PP -The absolute path name consists of the full path and the file name. On Unix this will always begin with the root, '/', directory. On Windows this will always begin 'D:/' where D is a drive letter, except for network shares that are not mapped to a drive letter, in which case the path will begin '//sharename/'. -.PP -This function returns the same as filePath(), unless isRelative() is TRUE. -.PP -If the QFileInfo is empty it returns QDir::currentDirPath(). -.PP -This function can be time consuming under Unix (in the order of milliseconds). -.PP -See also isRelative() and filePath(). -.PP -Examples: -.)l biff/biff.cpp and fileiconview/qfileiconview.cpp. -.SH "QString QFileInfo::baseName ( bool complete = FALSE ) const" -Returns the base name of the file. -.PP -If \fIcomplete\fR is FALSE (the default) the base name consists of all characters in the file name up to (but not including) the \fIfirst\fR '.' character. -.PP -If \fIcomplete\fR is TRUE the base name consists of all characters in the file up to (but not including) the \fIlast\fR '.' character. -.PP -The path is not included in either case. -.PP -Example: -.PP -.nf -.br - QFileInfo fi( "/tmp/archive.tar.gz" ); -.br - QString base = fi.baseName(); // base = "archive" -.br - base = fi.baseName( TRUE ); // base = "archive.tar" -.br -.fi -.PP -See also fileName() and extension(). -.SH "bool QFileInfo::caching () const" -Returns TRUE if caching is enabled; otherwise returns FALSE. -.PP -See also setCaching() and refresh(). -.SH "bool QFileInfo::convertToAbs ()" -Converts the file's path to an absolute path. -.PP -If it is already absolute, nothing is done. -.PP -See also filePath() and isRelative(). -.SH "QDateTime QFileInfo::created () const" -Returns the date and time when the file was created. -.PP -On platforms where this information is not available, returns the same as lastModified(). -.PP -See also lastModified() and lastRead(). -.SH "QDir QFileInfo::dir ( bool absPath = FALSE ) const" -Returns the file's path as a QDir object. -.PP -If the QFileInfo is relative and \fIabsPath\fR is FALSE, the QDir will be relative; otherwise it will be absolute. -.PP -See also dirPath(), filePath(), fileName(), and isRelative(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QString QFileInfo::dirPath ( bool absPath = FALSE ) const" -Returns the file's path. -.PP -If \fIabsPath\fR is TRUE an absolute path is returned. -.PP -See also dir(), filePath(), fileName(), and isRelative(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QFileInfo::exists () const" -Returns TRUE if the file exists; otherwise returns FALSE. -.PP -Examples: -.)l biff/biff.cpp, distributor/distributor.ui.h, and i18n/main.cpp. -.SH "QString QFileInfo::extension ( bool complete = TRUE ) const" -Returns the file's extension name. -.PP -If \fIcomplete\fR is TRUE (the default), extension() returns the string of all characters in the file name after (but not including) the first '.' character. -.PP -If \fIcomplete\fR is FALSE, extension() returns the string of all characters in the file name after (but not including) the last '.' character. -.PP -Example: -.PP -.nf -.br - QFileInfo fi( "/tmp/archive.tar.gz" ); -.br - QString ext = fi.extension(); // ext = "tar.gz" -.br - ext = fi.extension( FALSE ); // ext = "gz" -.br -.fi -.PP -See also fileName() and baseName(). -.PP -Example: qdir/qdir.cpp. -.SH "QString QFileInfo::fileName () const" -Returns the name of the file, excluding the path. -.PP -Example: -.PP -.nf -.br - QFileInfo fi( "/tmp/archive.tar.gz" ); -.br - QString name = fi.fileName(); // name = "archive.tar.gz" -.br -.fi -.PP -See also isRelative(), filePath(), baseName(), and extension(). -.PP -Examples: -.)l dirview/dirview.cpp, fileiconview/qfileiconview.cpp, and network/ftpclient/ftpmainwindow.ui.h. -.SH "QString QFileInfo::filePath () const" -Returns the file name, including the path (which may be absolute or relative). -.PP -See also isRelative() and absFilePath(). -.PP -Examples: -.)l dirview/main.cpp and fileiconview/qfileiconview.cpp. -.SH "QString QFileInfo::group () const" -Returns the group of the file. On Windows, on systems where files do not have groups, or if an error occurs, QString::null is returned. -.PP -This function can be time consuming under Unix (in the order of milliseconds). -.PP -See also groupId(), owner(), and ownerId(). -.SH "uint QFileInfo::groupId () const" -Returns the id of the group the file belongs to. -.PP -On Windows and on systems where files do not have groups this function always returns (uint) -2. -.PP -See also group(), owner(), and ownerId(). -.SH "bool QFileInfo::isDir () const" -Returns TRUE if this object points to a directory or to a symbolic link to a directory; otherwise returns FALSE. -.PP -See also isFile() and isSymLink(). -.PP -Examples: -.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. -.SH "bool QFileInfo::isExecutable () const" -Returns TRUE if the file is executable; otherwise returns FALSE. -.PP -See also isReadable(), isWritable(), and permission(). -.SH "bool QFileInfo::isFile () const" -Returns TRUE if this object points to a file. Returns FALSE if the object points to something which isn't a file, e.g. a directory or a symlink. -.PP -See also isDir() and isSymLink(). -.PP -Examples: -.)l dirview/dirview.cpp, distributor/distributor.ui.h, fileiconview/qfileiconview.cpp, and qdir/qdir.cpp. -.SH "bool QFileInfo::isHidden () const" -Returns TRUE if the file is hidden; otherwise returns FALSE. -.PP -On Unix-like operating systems, including Mac OS X, a file is hidden if its name begins with ".". On Windows a file is hidden if its hidden attribute is set. -.SH "bool QFileInfo::isReadable () const" -Returns TRUE if the file is readable; otherwise returns FALSE. -.PP -See also isWritable(), isExecutable(), and permission(). -.PP -Example: distributor/distributor.ui.h. -.SH "bool QFileInfo::isRelative () const" -Returns TRUE if the file path name is relative. Returns FALSE if the path is absolute (e.g. under Unix a path is absolute if it begins with a "/"). -.SH "bool QFileInfo::isSymLink () const" -Returns TRUE if this object points to a symbolic link (or to a shortcut on Windows, or an alias on Mac OS X); otherwise returns FALSE. -.PP -See also isFile(), isDir(), and readLink(). -.PP -Examples: -.)l dirview/dirview.cpp, distributor/distributor.ui.h, and fileiconview/qfileiconview.cpp. -.SH "bool QFileInfo::isWritable () const" -Returns TRUE if the file is writable; otherwise returns FALSE. -.PP -See also isReadable(), isExecutable(), and permission(). -.PP -Example: distributor/distributor.ui.h. -.SH "QDateTime QFileInfo::lastModified () const" -Returns the date and time when the file was last modified. -.PP -See also created() and lastRead(). -.PP -Example: biff/biff.cpp. -.SH "QDateTime QFileInfo::lastRead () const" -Returns the date and time when the file was last read (accessed). -.PP -On platforms where this information is not available, returns the same as lastModified(). -.PP -See also created() and lastModified(). -.PP -Example: biff/biff.cpp. -.SH "QFileInfo & QFileInfo::operator= ( const QFileInfo & fi )" -Makes a copy of \fIfi\fR and assigns it to this QFileInfo. -.SH "QString QFileInfo::owner () const" -Returns the owner of the file. On systems where files do not have owners, or if an error occurs, QString::null is returned. -.PP -This function can be time consuming under Unix (in the order of milliseconds). -.PP -See also ownerId(), group(), and groupId(). -.SH "uint QFileInfo::ownerId () const" -Returns the id of the owner of the file. -.PP -On Windows and on systems where files do not have owners this function returns ((uint) -2). -.PP -See also owner(), group(), and groupId(). -.SH "bool QFileInfo::permission ( int permissionSpec ) const" -Tests for file permissions. The \fIpermissionSpec\fR argument can be several flags of type PermissionSpec OR-ed together to check for permission combinations. -.PP -On systems where files do not have permissions this function always returns TRUE. -.PP -Example: -.PP -.nf -.br - QFileInfo fi( "/tmp/archive.tar.gz" ); -.br - if ( fi.permission( QFileInfo::WriteUser | QFileInfo::ReadGroup ) ) -.br - tqWarning( "I can change the file; my group can read the file" ); -.br - if ( fi.permission( QFileInfo::WriteGroup | QFileInfo::WriteOther ) ) -.br - tqWarning( "The group or others can change the file" ); -.br -.fi -.PP -See also isReadable(), isWritable(), and isExecutable(). -.SH "QString QFileInfo::readLink () const" -Returns the name a symlink (or shortcut on Windows) points to, or a QString::null if the object isn't a symbolic link. -.PP -This name may not represent an existing file; it is only a string. QFileInfo::exists() returns TRUE if the symlink points to an existing file. -.PP -See also exists(), isSymLink(), isDir(), and isFile(). -.SH "void QFileInfo::refresh () const" -Refreshes the information about the file, i.e. reads in information from the file system the next time a cached property is fetched. -.PP -See also setCaching(). -.SH "void QFileInfo::setCaching ( bool enable )" -If \fIenable\fR is TRUE, enables caching of file information. If \fIenable\fR is FALSE caching is disabled. -.PP -When caching is enabled, QFileInfo reads the file information from the file system the first time it's needed, but generally not later. -.PP -Caching is enabled by default. -.PP -See also refresh() and caching(). -.SH "void QFileInfo::setFile ( const QString & file )" -Sets the file that the QFileInfo provides information about to \fIfile\fR. -.PP -The \fIfile\fR can also include an absolute or relative file path. Absolute paths begin with the directory separator (e.g. "/" under Unix) or a drive specification (under Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current directory. -.PP -Example: -.PP -.nf -.br - QString absolute = "/local/bin"; -.br - QString relative = "local/bin"; -.br - QFileInfo absFile( absolute ); -.br - QFileInfo relFile( relative ); -.br -.br - QDir::setCurrent( QDir::rootDirPath() ); -.br - // absFile and relFile now point to the same file -.br -.br - QDir::setCurrent( "/tmp" ); -.br - // absFile now points to "/local/bin", -.br - // while relFile points to "/tmp/local/bin" -.br -.fi -.PP -See also isRelative(), QDir::setCurrent(), and QDir::isRelativePath(). -.PP -Example: biff/biff.cpp. -.SH "void QFileInfo::setFile ( const QFile & file )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the file that the QFileInfo provides information about to \fIfile\fR. -.PP -If \fIfile\fR includes a relative path, the QFileInfo will also have a relative path. -.PP -See also isRelative(). -.SH "void QFileInfo::setFile ( const QDir & d, const QString & fileName )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the file that the QFileInfo provides information about to \fIfileName\fR in directory \fId\fR. -.PP -If \fIfileName\fR includes a relative path, the QFileInfo will also have a relative path. -.PP -See also isRelative(). -.SH "uint QFileInfo::size () const" -Returns the file size in bytes, or 0 if the file does not exist or if the size is 0 or if the size cannot be fetched. -.PP -Example: qdir/qdir.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfileinfo.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfileinfo.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfilepreview.3qt b/doc/man/man3/qfilepreview.3qt deleted file mode 100644 index 718ca3bd9..000000000 --- a/doc/man/man3/qfilepreview.3qt +++ /dev/null @@ -1,66 +0,0 @@ -'\" t -.TH QFilePreview 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 -QFilePreview \- File previewing in QFileDialog -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFilePreview\fR ()" -.br -.ti -1c -.BI "virtual void \fBpreviewUrl\fR ( const QUrl & url ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QFilePreview class provides file previewing in QFileDialog. -.PP -This class is an abstract base class which is used to implement widgets that can display a preview of a file in a QFileDialog. -.PP -You must derive the preview widget from both QWidget and from this class. Then you must reimplement this class's previewUrl() function, which is called by the file dialog if the preview of a file (specified as a URL) should be shown. -.PP -See also QFileDialog::setPreviewMode(), QFileDialog::setContentsPreview(), QFileDialog::setInfoPreview(), QFileDialog::setInfoPreviewEnabled(), QFileDialog::setContentsPreviewEnabled(). -.PP -For an example of a preview widget see qt/examples/qdir/qdir.cpp. -.PP -See also Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFilePreview::QFilePreview ()" -Constructs the QFilePreview. -.SH "void QFilePreview::previewUrl ( const QUrl & url )\fC [pure virtual]\fR" -This function is called by QFileDialog if a preview -for the \fIurl\fR should be shown. Reimplement this -function to provide file previewing. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qfilepreview.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfilepreview.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfocusdata.3qt b/doc/man/man3/qfocusdata.3qt deleted file mode 100644 index b26bf3d7d..000000000 --- a/doc/man/man3/qfocusdata.3qt +++ /dev/null @@ -1,92 +0,0 @@ -'\" t -.TH QFocusData 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 -QFocusData \- Maintains the list of widgets in the focus chain -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "QWidget * \fBfocusWidget\fR () const" -.br -.ti -1c -.BI "QWidget * \fBhome\fR ()" -.br -.ti -1c -.BI "QWidget * \fBnext\fR ()" -.br -.ti -1c -.BI "QWidget * \fBprev\fR ()" -.br -.ti -1c -.BI "QWidget * \fBfirst\fR () const" -.br -.ti -1c -.BI "QWidget * \fBlast\fR () const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QFocusData class maintains the list of widgets in the focus chain. -.PP -This read-only list always contains at least one widget (i.e. the top-level widget). It provides a simple cursor which can be reset to the current focus widget using home(), or moved to its neighboring widgets using next() and prev(). You can also retrieve the count() of the number of widgets in the list. The list is a loop, so if you keep iterating, for example using next(), you will never come to the end. -.PP -Some widgets in the list may not accept focus. Widgets are added to the list as necessary, but not removed from it. This lets widgets change focus policy dynamically without disrupting the focus chain the user experiences. When a widget disables and re-enables tab focus, its position in the focus chain does not change. -.PP -When reimplementing QWidget::focusNextPrevChild() to provide special focus flow, you will usually call QWidget::focusData() to retrieve the focus data stored at the top-level widget. A top-level widget's focus data contains the focus list for its hierarchy of widgets. -.PP -The cursor may change at any time. -.PP -This class is \fInot\fR thread-safe. -.PP -See also QWidget::focusNextPrevChild(), QWidget::setTabOrder(), QWidget::focusPolicy, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "int QFocusData::count () const" -Returns the number of widgets in the focus chain. -.SH "QWidget * QFocusData::first () const" -Returns the first widget in the focus chain. The cursor is not modified. -.SH "QWidget * QFocusData::focusWidget () const" -Returns the widgets in the hierarchy that are in the focus chain. -.SH "QWidget * QFocusData::home ()" -Moves the cursor to the focusWidget() and returns that widget. You must call this before next() or prev() to iterate meaningfully. -.SH "QWidget * QFocusData::last () const" -Returns the last widget in the focus chain. The cursor is not modified. -.SH "QWidget * QFocusData::next ()" -Moves the cursor to the next widget in the focus chain. There is \fIalways\fR a next widget because the list is a loop. -.SH "QWidget * QFocusData::prev ()" -Moves the cursor to the previous widget in the focus chain. There -is \fIalways\fR a previous widget because the list is a loop. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfocusdata.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfocusdata.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfocusevent.3qt b/doc/man/man3/qfocusevent.3qt deleted file mode 100644 index f79b43273..000000000 --- a/doc/man/man3/qfocusevent.3qt +++ /dev/null @@ -1,117 +0,0 @@ -'\" t -.TH QFocusEvent 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 -QFocusEvent \- Event parameters for widget focus events -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFocusEvent\fR ( Type type )" -.br -.ti -1c -.BI "bool \fBgotFocus\fR () const" -.br -.ti -1c -.BI "bool \fBlostFocus\fR () const" -.br -.ti -1c -.BI "enum \fBReason\fR { Mouse, Tab, Backtab, ActiveWindow, Popup, Shortcut, Other }" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "Reason \fBreason\fR ()" -.br -.ti -1c -.BI "void \fBsetReason\fR ( Reason reason )" -.br -.ti -1c -.BI "void \fBresetReason\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QFocusEvent class contains event parameters for widget focus events. -.PP -Focus events are sent to widgets when the keyboard input focus changes. Focus events occur due to mouse actions, keypresses (e.g. Tab or Backtab), the window system, popup menus, keyboard shortcuts or other application specific reasons. The reason for a particular focus event is returned by reason() in the appropriate event handler. -.PP -The event handlers QWidget::focusInEvent() and QWidget::focusOutEvent() receive focus events. -.PP -Use setReason() to set the reason for all focus events, and resetReason() to set the reason for all focus events to the reason in force before the last setReason() call. -.PP -See also QWidget::setFocus(), QWidget::focusPolicy, and Event Classes. -.SS "Member Type Documentation" -.SH "QFocusEvent::Reason" -This enum specifies why the focus changed. -.TP -\fCQFocusEvent::Mouse\fR - because of a mouse action. -.TP -\fCQFocusEvent::Tab\fR - because of a Tab press. -.TP -\fCQFocusEvent::Backtab\fR - because of a Backtab press (possibly including Shift/Control, e.g. Shift+Tab). -.TP -\fCQFocusEvent::ActiveWindow\fR - because the window system made this window (in)active. -.TP -\fCQFocusEvent::Popup\fR - because the application opened/closed a popup that grabbed/released focus. -.TP -\fCQFocusEvent::Shortcut\fR - because of a keyboard shortcut. -.TP -\fCQFocusEvent::Other\fR - any other reason, usually application-specific. -.PP -See the keyboard focus overview for more about focus. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFocusEvent::QFocusEvent ( Type type )" -Constructs a focus event object. -.PP -The \fItype\fR parameter must be either QEvent::FocusIn or QEvent::FocusOut. -.SH "bool QFocusEvent::gotFocus () const" -Returns TRUE if the widget received the text input focus; otherwise returns FALSE. -.SH "bool QFocusEvent::lostFocus () const" -Returns TRUE if the widget lost the text input focus; otherwise returns FALSE. -.SH "Reason QFocusEvent::reason ()\fC [static]\fR" -Returns the reason for this focus event. -.PP -See also setReason(). -.SH "void QFocusEvent::resetReason ()\fC [static]\fR" -Resets the reason for all future focus events to the value before the last setReason() call. -.PP -See also reason() and setReason(). -.SH "void QFocusEvent::setReason ( Reason reason )\fC [static]\fR" -Sets the reason for all future focus events to \fIreason\fR. -.PP -See also reason() and resetReason(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qfocusevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfocusevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfont.3qt b/doc/man/man3/qfont.3qt deleted file mode 100644 index 8508ea124..000000000 --- a/doc/man/man3/qfont.3qt +++ /dev/null @@ -1,906 +0,0 @@ -'\" t -.TH QFont 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 -QFont \- Font used for drawing text -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBStyleHint\fR { Helvetica, SansSerif = Helvetica, Times, Serif = Times, Courier, TypeWriter = Courier, OldEnglish, Decorative = OldEnglish, System, AnyStyle }" -.br -.ti -1c -.BI "enum \fBStyleStrategy\fR { PreferDefault = 0x0001, PreferBitmap = 0x0002, PreferDevice = 0x0004, PreferOutline = 0x0008, ForceOutline = 0x0010, PreferMatch = 0x0020, PreferQuality = 0x0040, PreferAntialias = 0x0080, NoAntialias = 0x0100, OpenGLCompatible = 0x0200 }" -.br -.ti -1c -.BI "enum \fBWeight\fR { Light = 25, Normal = 50, DemiBold = 63, Bold = 75, Black = 87 }" -.br -.ti -1c -.BI "enum \fBStretch\fR { UltraCondensed = 50, ExtraCondensed = 62, Condensed = 75, SemiCondensed = 87, Unstretched = 100, SemiExpanded = 112, Expanded = 125, ExtraExpanded = 150, UltraExpanded = 200 }" -.br -.ti -1c -.BI "\fBQFont\fR ()" -.br -.ti -1c -.BI "\fBQFont\fR ( const QString & family, int pointSize = 12, int weight = Normal, bool italic = FALSE )" -.br -.ti -1c -.BI "\fBQFont\fR ( const QFont & font )" -.br -.ti -1c -.BI "\fB~QFont\fR ()" -.br -.ti -1c -.BI "QString \fBfamily\fR () const" -.br -.ti -1c -.BI "void \fBsetFamily\fR ( const QString & family )" -.br -.ti -1c -.BI "int \fBpointSize\fR () const" -.br -.ti -1c -.BI "float \fBpointSizeFloat\fR () const" -.br -.ti -1c -.BI "void \fBsetPointSize\fR ( int pointSize )" -.br -.ti -1c -.BI "void \fBsetPointSizeFloat\fR ( float pointSize )" -.br -.ti -1c -.BI "int \fBpixelSize\fR () const" -.br -.ti -1c -.BI "void \fBsetPixelSize\fR ( int pixelSize )" -.br -.ti -1c -.BI "void setPixelSizeFloat ( float pixelSize ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBweight\fR () const" -.br -.ti -1c -.BI "void \fBsetWeight\fR ( int weight )" -.br -.ti -1c -.BI "bool \fBbold\fR () const" -.br -.ti -1c -.BI "void \fBsetBold\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBitalic\fR () const" -.br -.ti -1c -.BI "void \fBsetItalic\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBunderline\fR () const" -.br -.ti -1c -.BI "void \fBsetUnderline\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBoverline\fR () const" -.br -.ti -1c -.BI "void \fBsetOverline\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBstrikeOut\fR () const" -.br -.ti -1c -.BI "void \fBsetStrikeOut\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBfixedPitch\fR () const" -.br -.ti -1c -.BI "void \fBsetFixedPitch\fR ( bool enable )" -.br -.ti -1c -.BI "StyleHint \fBstyleHint\fR () const" -.br -.ti -1c -.BI "StyleStrategy \fBstyleStrategy\fR () const" -.br -.ti -1c -.BI "void \fBsetStyleHint\fR ( StyleHint hint, StyleStrategy strategy = PreferDefault )" -.br -.ti -1c -.BI "void \fBsetStyleStrategy\fR ( StyleStrategy s )" -.br -.ti -1c -.BI "int \fBstretch\fR () const" -.br -.ti -1c -.BI "void \fBsetStretch\fR ( int factor )" -.br -.ti -1c -.BI "bool \fBrawMode\fR () const" -.br -.ti -1c -.BI "void \fBsetRawMode\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBexactMatch\fR () const" -.br -.ti -1c -.BI "QFont & \fBoperator=\fR ( const QFont & font )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QFont & f ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QFont & f ) const" -.br -.ti -1c -.BI "bool \fBisCopyOf\fR ( const QFont & f ) const" -.br -.ti -1c -.BI "HFONT \fBhandle\fR () const" -.br -.ti -1c -.BI "void \fBsetRawName\fR ( const QString & name )" -.br -.ti -1c -.BI "QString \fBrawName\fR () const" -.br -.ti -1c -.BI "QString \fBkey\fR () const" -.br -.ti -1c -.BI "QString \fBtoString\fR () const" -.br -.ti -1c -.BI "bool \fBfromString\fR ( const QString & descrip )" -.br -.ti -1c -.BI "void \fBqwsRenderToDisk\fR ( bool all = TRUE )" -.br -.ti -1c -.BI "enum \fBScript\fR { Latin, Greek, Cyrillic, Armenian, Georgian, Runic, Ogham, SpacingModifiers, CombiningMarks, Hebrew, Arabic, Syriac, Thaana, Devanagari, Bengali, Gurmukhi, Gujarati, Oriya, Tamil, Telugu, Kannada, Malayalam, Sinhala, Thai, Lao, Tibetan, Myanmar, Khmer, Han, Hiragana, Katakana, Hangul, Bopomofo, Yi, Ethiopic, Cherokee, CanadianAboriginal, Mongolian, CurrencySymbols, LetterlikeSymbols, NumberForms, MathematicalOperators, TechnicalSymbols, GeometricSymbols, MiscellaneousSymbols, EnclosedAndSquare, Braille, Unicode, Tagalog, Hanunoo, Buhid, Tagbanwa, KatakanaHalfWidth, Limbu, TaiLe }" -.br -.ti -1c -.BI "QString \fBdefaultFamily\fR () const" -.br -.ti -1c -.BI "QString \fBlastResortFamily\fR () const" -.br -.ti -1c -.BI "QString \fBlastResortFont\fR () const" -.br -.ti -1c -.BI "QFont \fBresolve\fR ( const QFont & other ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBsubstitute\fR ( const QString & familyName )" -.br -.ti -1c -.BI "QStringList \fBsubstitutes\fR ( const QString & familyName )" -.br -.ti -1c -.BI "QStringList \fBsubstitutions\fR ()" -.br -.ti -1c -.BI "void \fBinsertSubstitution\fR ( const QString & familyName, const QString & substituteName )" -.br -.ti -1c -.BI "void \fBinsertSubstitutions\fR ( const QString & familyName, const QStringList & substituteNames )" -.br -.ti -1c -.BI "void \fBremoveSubstitution\fR ( const QString & familyName )" -.br -.ti -1c -.BI "QFont defaultFont () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setDefaultFont ( const QFont & f ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "bool \fBdirty\fR () const" -.br -.ti -1c -.BI "int \fBdeciPointSize\fR () const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QFont & font )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QFont & font )" -.br -.in -1c -.SH DESCRIPTION -The QFont class specifies a font used for drawing text. -.PP -When you create a QFont object you specify various attributes that you want the font to have. Qt will use the font with the specified attributes, or if no matching font exists, Qt will use the closest matching installed font. The attributes of the font that is actually used are retrievable from a QFontInfo object. If the window system provides an exact match exactMatch() returns TRUE. Use QFontMetrics to get measurements, e.g. the pixel length of a string using QFontMetrics::width(). -.PP -Use QApplication::setFont() to set the application's default font. -.PP -If a choosen X11 font does not include all the characters that need to be displayed, QFont will try to find the characters in the nearest equivalent fonts. When a QPainter draws a character from a font the QFont will report whether or not it has the character; if it does not, QPainter will draw an unfilled square. -.PP -Create QFonts like this: -.PP -.nf -.br - QFont serifFont( "Times", 10, Bold ); -.br - QFont sansFont( "Helvetica [Cronyx]", 12 ); -.br -.fi -.PP -The attributes set in the constructor can also be set later, e.g. setFamily(), setPointSize(), setPointSizeFloat(), setWeight() and setItalic(). The remaining attributes must be set after contstruction, e.g. setBold(), setUnderline(), setOverline(), setStrikeOut() and setFixedPitch(). QFontInfo objects should be created \fIafter\fR the font's attributes have been set. A QFontInfo object will not change, even if you change the font's attributes. The corresponding "get" functions, e.g. family(), pointSize(), etc., return the values that were set, even though the values used may differ. The actual values are available from a QFontInfo object. -.PP -If the requested font family is unavailable you can influence the font matching algorithm by choosing a particular QFont::StyleHint and QFont::StyleStrategy with setStyleHint(). The default family (corresponding to the current style hint) is returned by defaultFamily(). -.PP -The font-matching algorithm has a lastResortFamily() and lastResortFont() in cases where a suitable match cannot be found. You can provide substitutions for font family names using insertSubstitution() and insertSubstitutions(). Substitutions can be removed with removeSubstitution(). Use substitute() to retrieve a family's first substitute, or the family name itself if it has no substitutes. Use substitutes() to retrieve a list of a family's substitutes (which may be empty). -.PP -Every QFont has a key() which you can use, for example, as the key in a cache or dictionary. If you want to store a user's font preferences you could use QSettings, writing the font information with toString() and reading it back with fromString(). The operator<<() and operator>>() functions are also available, but they work on a data stream. -.PP -It is possible to set the height of characters shown on the screen to a specified number of pixels with setPixelSize(); however using setPointSize() has a similar effect and provides device independence. -.PP -Under the X Window System you can set a font using its system specific name with setRawName(). -.PP -Loading fonts can be expensive, especially on X11. QFont contains extensive optimizations to make the copying of QFont objects fast, and to cache the results of the slow window system functions it depends upon. -.PP -The font matching algorithm works as follows:
                        -.IP 1 -The specified font family is searched for. -.IP 2 -If not found, the styleHint() is used to select a replacement family. -.IP 3 -Each replacement font family is searched for. -.IP 4 -If none of these are found or there was no styleHint(), "helvetica" will be searched for. -.IP 5 -If "helvetica" isn't found Qt will try the lastResortFamily(). -.IP 6 -If the lastResortFamily() isn't found Qt will try the lastResortFont() which will always return a name of some kind. -.PP -Once a font is found, the remaining attributes are matched in order of priority:
                          -.IP 7 -fixedPitch() -.IP 8 -pointSize() (see below) -.IP 9 -weight() -.IP 10 -italic() -.PP -If you have a font which matches on family, even if none of the other attributes match, this font will be chosen in preference to a font which doesn't match on family but which does match on the other attributes. This is because font family is the dominant search criteria. -.PP -The point size is defined to match if it is within 20% of the requested point size. When several fonts match and are only distinguished by point size, the font with the closest point size to the one requested will be chosen. -.PP -The actual family, font size, weight and other font attributes used for drawing text will depend on what's available for the chosen family under the window system. A QFontInfo object can be used to determine the actual values used for drawing the text. -.PP -Examples: -.)l -.PP -.nf -.br - QFont f("Helvetica"); -.br -.fi -If you had both an Adobe and a Cronyx Helvetica, you might get either. -.PP -.nf -.br - QFont f1( "Helvetica [Cronyx]" ); // Qt 3.x -.br - QFont f2( "Cronyx-Helvetica" ); // Qt 2.x compatibility -.br -.fi -You can specify the foundry you want in the family name. Both fonts, f1 and f2, in the above example will be set to "Helvetica [Cronyx]". -.PP -To determine the attributes of the font actually used in the window system, use a QFontInfo object, e.g. -.PP -.nf -.br - QFontInfo info( f1 ); -.br - QString family = info.family(); -.br -.fi -.PP -To find out font metrics use a QFontMetrics object, e.g. -.PP -.nf -.br - QFontMetrics fm( f1 ); -.br - int pixelWidth = fm.width( "How many pixels wide is this text?" ); -.br - int pixelHeight = fm.height(); -.br -.fi -.PP -For more general information on fonts, see the comp.fonts FAQ. Information on encodings can be found from Roman Czyborra's page. -.PP -See also QFontMetrics, QFontInfo, QFontDatabase, QApplication::setFont(), QWidget::font, QPainter::setFont(), QFont::StyleHint, QFont::Weight, Widget Appearance and Style, Graphics Classes, and Implicitly and Explicitly Shared Classes. -.SS "Member Type Documentation" -.SH "QFont::Script" -This enum represents Unicode allocated scripts. For exhaustive coverage see The Unicode Standard Version 3.0. The following scripts are supported: -.PP -Modern European alphabetic scripts (left to right): -.TP -\fCQFont::Latin\fR - consists of most alphabets based on the original Latin alphabet. -.TP -\fCQFont::Greek\fR - covers ancient and modern Greek and Coptic. -.TP -\fCQFont::Cyrillic\fR - covers the Slavic and non-Slavic languages using cyrillic alphabets. -.TP -\fCQFont::Armenian\fR - contains the Armenian alphabet used with the Armenian language. -.TP -\fCQFont::Georgian\fR - covers at least the language Georgian. -.TP -\fCQFont::Runic\fR - covers the known constituents of the Runic alphabets used by the early and medieval societies in the Germanic, Scandinavian, and Anglo-Saxon areas. -.TP -\fCQFont::Ogham\fR - is an alphabetical script used to write a very early form of Irish. -.TP -\fCQFont::SpacingModifiers\fR - are small signs indicating modifications to the preceeding letter. -.TP -\fCQFont::CombiningMarks\fR - consist of diacritical marks not specific to a particular alphabet, diacritical marks used in combination with mathematical and technical symbols, and glyph encodings applied to multiple letterforms. -.PP -Middle Eastern scripts (right to left): -.TP -\fCQFont::Hebrew\fR - is used for writing Hebrew, Yiddish, and some other languages. -.TP -\fCQFont::Arabic\fR - covers the Arabic language as well as Persian, Urdu, Kurdish and some others. -.TP -\fCQFont::Syriac\fR - is used to write the active liturgical languages and dialects of several Middle Eastern and Southeast Indian communities. -.TP -\fCQFont::Thaana\fR - is used to write the Maledivian Dhivehi language. -.PP -South and Southeast Asian scripts (left to right with few historical exceptions): -.TP -\fCQFont::Devanagari\fR - covers classical Sanskrit and modern Hindi as well as several other languages. -.TP -\fCQFont::Bengali\fR - is a relative to Devanagari employed to write the Bengali language used in West Bengal/India and Bangladesh as well as several minority languages. -.TP -\fCQFont::Gurmukhi\fR - is another Devanagari relative used to write Punjabi. -.TP -\fCQFont::Gujarati\fR - is closely related to Devanagari and used to write the Gujarati language of the Gujarat state in India. -.TP -\fCQFont::Oriya\fR - is used to write the Oriya language of Orissa state/India. -.TP -\fCQFont::Tamil\fR - is used to write the Tamil language of Tamil Nadu state/India, Sri Lanka, Singapore and parts of Malaysia as well as some minority languages. -.TP -\fCQFont::Telugu\fR - is used to write the Telugu language of Andhra Pradesh state/India and some minority languages. -.TP -\fCQFont::Kannada\fR - is another South Indian script used to write the Kannada language of Karnataka state/India and some minority languages. -.TP -\fCQFont::Malayalam\fR - is used to write the Malayalam language of Kerala state/India. -.TP -\fCQFont::Sinhala\fR - is used for Sri Lanka's majority language Sinhala and is also employed to write Pali, Sanskrit, and Tamil. -.TP -\fCQFont::Thai\fR - is used to write Thai and other Southeast Asian languages. -.TP -\fCQFont::Lao\fR - is a language and script quite similar to Thai. -.TP -\fCQFont::Tibetan\fR - is the script used to write Tibetan in several countries like Tibet, the bordering Indian regions and Nepal. It is also used in the Buddist philosophy and liturgy of the Mongolian cultural area. -.TP -\fCQFont::Myanmar\fR - is mainly used to write the Burmese language of Myanmar (former Burma). -.TP -\fCQFont::Khmer\fR - is the official language of Kampuchea. -.PP -East Asian scripts (traditionally top-down, right to left, modern often horizontal left to right): -.TP -\fCQFont::Han\fR - consists of the CJK (Chinese, Japanese, Korean) idiographic characters. -.TP -\fCQFont::Hiragana\fR - is a cursive syllabary used to indicate phonetics and pronounciation of Japanese words. -.TP -\fCQFont::Katakana\fR - is a non-cursive syllabic script used to write Japanese words with visual emphasis and non-Japanese words in a phonetical manner. -.TP -\fCQFont::Hangul\fR - is a Korean script consisting of alphabetic components. -.TP -\fCQFont::Bopomofo\fR - is a phonetic alphabet for Chinese (mainly Mandarin). -.TP -\fCQFont::Yi\fR - (also called Cuan or Wei) is a syllabary used to write the Yi language of Southwestern China, Myanmar, Laos, and Vietnam. -.PP -Additional scripts that do not fit well into the script categories above: -.TP -\fCQFont::Ethiopic\fR - is a syllabary used by several Central East African languages. -.TP -\fCQFont::Cherokee\fR - is a left-to-right syllabic script used to write the Cherokee language. -.TP -\fCQFont::CanadianAboriginal\fR - consists of the syllabics used by some Canadian aboriginal societies. -.TP -\fCQFont::Mongolian\fR - is the traditional (and recently reintroduced) script used to write Mongolian. -.PP -Symbols: -.TP -\fCQFont::CurrencySymbols\fR - contains currency symbols not encoded in other scripts. -.TP -\fCQFont::LetterlikeSymbols\fR - consists of symbols derived from ordinary letters of an alphabetical script. -.TP -\fCQFont::NumberForms\fR - are provided for compatibility with other existing character sets. -.TP -\fCQFont::MathematicalOperators\fR - consists of encodings for operators, relations and other symbols like arrows used in a mathematical context. -.TP -\fCQFont::TechnicalSymbols\fR - contains representations for control codes, the space symbol, APL symbols and other symbols mainly used in the context of electronic data processing. -.TP -\fCQFont::GeometricSymbols\fR - covers block elements and geometric shapes. -.TP -\fCQFont::MiscellaneousSymbols\fR - consists of a heterogeneous collection of symbols that do not fit any other Unicode character block, e.g. Dingbats. -.TP -\fCQFont::EnclosedAndSquare\fR - is provided for compatibility with some East Asian standards. -.TP -\fCQFont::Braille\fR - is an international writing system used by blind people. This script encodes the 256 eight-dot patterns with the 64 six-dot patterns as a subset. -.TP -\fCQFont::Tagalog\fR -.TP -\fCQFont::Hanunoo\fR -.TP -\fCQFont::Buhid\fR -.TP -\fCQFont::Tagbanwa\fR -.TP -\fCQFont::KatakanaHalfWidth\fR -.TP -\fCQFont::Limbu\fR - (Unicode 4.0) -.TP -\fCQFont::TaiLe\fR - (Unicode 4.0) -.TP -\fCQFont::Unicode\fR - includes all the above scripts. -.SH "QFont::Stretch" -Predefined stretch values that follow the CSS naming convention. -.TP -\fCQFont::UltraCondensed\fR - 50 -.TP -\fCQFont::ExtraCondensed\fR - 62 -.TP -\fCQFont::Condensed\fR - 75 -.TP -\fCQFont::SemiCondensed\fR - 87 -.TP -\fCQFont::Unstretched\fR - 100 -.TP -\fCQFont::SemiExpanded\fR - 112 -.TP -\fCQFont::Expanded\fR - 125 -.TP -\fCQFont::ExtraExpanded\fR - 150 -.TP -\fCQFont::UltraExpanded\fR - 200 -.PP -See also setStretch() and stretch(). -.SH "QFont::StyleHint" -Style hints are used by the font matching algorithm to find an appropriate default family if a selected font family is not available. -.TP -\fCQFont::AnyStyle\fR - leaves the font matching algorithm to choose the family. This is the default. -.TP -\fCQFont::SansSerif\fR - the font matcher prefer sans serif fonts. -.TP -\fCQFont::Helvetica\fR - is a synonym for SansSerif. -.TP -\fCQFont::Serif\fR - the font matcher prefers serif fonts. -.TP -\fCQFont::Times\fR - is a synonym for Serif. -.TP -\fCQFont::TypeWriter\fR - the font matcher prefers fixed pitch fonts. -.TP -\fCQFont::Courier\fR - a synonym for TypeWriter. -.TP -\fCQFont::OldEnglish\fR - the font matcher prefers decorative fonts. -.TP -\fCQFont::Decorative\fR - is a synonym for OldEnglish. -.TP -\fCQFont::System\fR - the font matcher prefers system fonts. -.SH "QFont::StyleStrategy" -The style strategy tells the font matching algorithm what type of fonts should be used to find an appropriate default family. -.PP -The following strategies are available: -.TP -\fCQFont::PreferDefault\fR - the default style strategy. It does not prefer any type of font. -.TP -\fCQFont::PreferBitmap\fR - prefers bitmap fonts (as opposed to outline fonts). -.TP -\fCQFont::PreferDevice\fR - prefers device fonts. -.TP -\fCQFont::PreferOutline\fR - prefers outline fonts (as opposed to bitmap fonts). -.TP -\fCQFont::ForceOutline\fR - forces the use of outline fonts. -.TP -\fCQFont::NoAntialias\fR - don't antialias the fonts. -.TP -\fCQFont::PreferAntialias\fR - antialias if possible. -.TP -\fCQFont::OpenGLCompatible\fR - forces the use of OpenGL compatible fonts. -.PP -Any of these may be OR-ed with one of these flags: -.TP -\fCQFont::PreferMatch\fR - prefer an exact match. The font matcher will try to use the exact font size that has been specified. -.TP -\fCQFont::PreferQuality\fR - prefer the best quality font. The font matcher will use the nearest standard point size that the font supports. -.SH "QFont::Weight" -Qt uses a weighting scale from 0 to 99 similar to, but not the same as, the scales used in Windows or CSS. A weight of 0 is ultralight, whilst 99 will be an extremely black. -.PP -This enum contains the predefined font weights: -.TP -\fCQFont::Light\fR - 25 -.TP -\fCQFont::Normal\fR - 50 -.TP -\fCQFont::DemiBold\fR - 63 -.TP -\fCQFont::Bold\fR - 75 -.TP -\fCQFont::Black\fR - 87 -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFont::QFont ()" -Constructs a font object that uses the application's default font. -.PP -See also QApplication::setFont() and QApplication::font(). -.SH "QFont::QFont ( const QString & family, int pointSize = 12, int weight = Normal, bool italic = FALSE )" -Constructs a font object with the specified \fIfamily\fR, \fIpointSize\fR, \fIweight\fR and \fIitalic\fR settings. -.PP -If \fIpointSize\fR is <= 0 it is set to 1. -.PP -The \fIfamily\fR name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". (The Qt 2.x syntax, i.e." Cronyx-Helvetica", is also supported.) If the \fIfamily\fR is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm. -.PP -See also Weight, setFamily(), setPointSize(), setWeight(), setItalic(), setStyleHint(), and QApplication::font(). -.SH "QFont::QFont ( const QFont & font )" -Constructs a font that is a copy of \fIfont\fR. -.SH "QFont::~QFont ()" -Destroys the font object and frees all allocated resources. -.SH "bool QFont::bold () const" -Returns TRUE if weight() is a value greater than QFont::Normal; otherwise returns FALSE. -.PP -See also weight(), setBold(), and QFontInfo::bold(). -.PP -Example: chart/optionsform.cpp. -.SH "int QFont::deciPointSize () const\fC [protected]\fR" -Returns the point size in 1/10ths of a point. -.PP -The returned value will be -1 if the font size has been specified in pixels. -.PP -See also pointSize() and pointSizeFloat(). -.SH "QString QFont::defaultFamily () const" -Returns the family name that corresponds to the current style hint. -.PP -See also StyleHint, styleHint(), and setStyleHint(). -.SH "QFont QFont::defaultFont ()\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Please use QApplication::font() instead. -.SH "bool QFont::dirty () const\fC [protected]\fR" -Returns TRUE if the font attributes have been changed and the font has to be (re)loaded; otherwise returns FALSE. -.SH "bool QFont::exactMatch () const" -Returns TRUE if a window system font exactly matching the settings of this font is available. -.PP -See also QFontInfo. -.SH "QString QFont::family () const" -Returns the requested font family name, i.e. the name set in the constructor or the last setFont() call. -.PP -See also setFamily(), substitutes(), and substitute(). -.PP -Examples: -.)l chart/optionsform.cpp and fonts/simple-qfont-demo/viewer.cpp. -.SH "bool QFont::fixedPitch () const" -Returns TRUE if fixed pitch has been set; otherwise returns FALSE. -.PP -See also setFixedPitch() and QFontInfo::fixedPitch(). -.SH "bool QFont::fromString ( const QString & descrip )" -Sets this font to match the description \fIdescrip\fR. The description is a comma-separated list of the font attributes, as returned by toString(). -.PP -See also toString() and operator>>(). -.SH "HFONT QFont::handle () const" -Returns the window system handle to the font, for low-level access. Using this function is \fInot\fR portable. -.SH "void QFont::insertSubstitution ( const QString & familyName, const QString & substituteName )\fC [static]\fR" -Inserts the family name \fIsubstituteName\fR into the substitution table for \fIfamilyName\fR. -.PP -See also insertSubstitutions(), removeSubstitution(), substitutions(), substitute(), and substitutes(). -.PP -Example: fonts/simple-qfont-demo/viewer.cpp. -.SH "void QFont::insertSubstitutions ( const QString & familyName, const QStringList & substituteNames )\fC [static]\fR" -Inserts the list of families \fIsubstituteNames\fR into the substitution list for \fIfamilyName\fR. -.PP -See also insertSubstitution(), removeSubstitution(), substitutions(), and substitute(). -.PP -Example: fonts/simple-qfont-demo/viewer.cpp. -.SH "bool QFont::isCopyOf ( const QFont & f ) const" -Returns TRUE if this font and \fIf\fR are copies of each other, i.e. one of them was created as a copy of the other and neither has been modified since. This is much stricter than equality. -.PP -See also operator=() and operator==(). -.SH "bool QFont::italic () const" -Returns TRUE if italic has been set; otherwise returns FALSE. -.PP -See also setItalic(). -.PP -Example: chart/optionsform.cpp. -.SH "QString QFont::key () const" -Returns the font's key, a textual representation of a font. It is typically used as the key for a cache or dictionary of fonts. -.PP -See also QMap. -.SH "QString QFont::lastResortFamily () const" -Returns the "last resort" font family name. -.PP -The current implementation tries a wide variety of common fonts, returning the first one it finds. Is is possible that no family is found in which case a null string is returned. -.PP -See also lastResortFont(). -.SH "QString QFont::lastResortFont () const" -Returns a "last resort" font name for the font matching algorithm. This is used if the last resort family is not available. It will always return a name, if necessary returning something like" fixed" or "system". -.PP -The current implementation tries a wide variety of common fonts, returning the first one it finds. The implementation may change at any time, but this function will always return a string containing something. -.PP -It is theoretically possible that there really isn't a lastResortFont() in which case Qt will abort with an error message. We have not been able to identify a case where this happens. Please report it as a bug if it does, preferably with a list of the fonts you have installed. -.PP -See also lastResortFamily() and rawName(). -.SH "bool QFont::operator!= ( const QFont & f ) const" -Returns TRUE if this font is different from \fIf\fR; otherwise returns FALSE. -.PP -Two QFonts are considered to be different if their font attributes are different. If rawMode() is enabled for both fonts, only the family fields are compared. -.PP -See also operator==(). -.SH "QFont & QFont::operator= ( const QFont & font )" -Assigns \fIfont\fR to this font and returns a reference to it. -.SH "bool QFont::operator== ( const QFont & f ) const" -Returns TRUE if this font is equal to \fIf\fR; otherwise returns FALSE. -.PP -Two QFonts are considered equal if their font attributes are equal. If rawMode() is enabled for both fonts, only the family fields are compared. -.PP -See also operator!=() and isCopyOf(). -.SH "bool QFont::overline () const" -Returns TRUE if overline has been set; otherwise returns FALSE. -.PP -See also setOverline(). -.SH "int QFont::pixelSize () const" -Returns the pixel size of the font if it was set with setPixelSize(). Returns -1 if the size was set with setPointSize() or setPointSizeFloat(). -.PP -See also setPixelSize(), pointSize(), QFontInfo::pointSize(), and QFontInfo::pixelSize(). -.SH "int QFont::pointSize () const" -Returns the point size of the font. Returns -1 if the font size was specified in pixels. -.PP -See also setPointSize(), deciPointSize(), and pointSizeFloat(). -.PP -Examples: -.)l chart/optionsform.cpp and fonts/simple-qfont-demo/viewer.cpp. -.SH "float QFont::pointSizeFloat () const" -Returns the point size of the font. Returns -1 if the font size was specified in pixels. -.PP -See also pointSize(), setPointSizeFloat(), pixelSize(), QFontInfo::pointSize(), and QFontInfo::pixelSize(). -.SH "void QFont::qwsRenderToDisk ( bool all = TRUE )" -Saves the glyphs in the font that have previously been accessed as a QPF file. If \fIall\fR is TRUE (the default), then before saving, all glyphs are marked as used. -.PP -If the font is large and you are sure that only a subset of characters will ever be required on the target device, passing FALSE for the \fIall\fR parameter can save a significant amount of disk space. -.PP -Note that this function is only applicable on Qt/Embedded. -.SH "bool QFont::rawMode () const" -Returns TRUE if raw mode is used for font name matching; otherwise returns FALSE. -.PP -See also setRawMode() and rawName(). -.SH "QString QFont::rawName () const" -Returns the name of the font within the underlying window system. -.PP -On Windows, this is usually just the family name of a TrueType font. -.PP -On X11, it is an XLFD (X Logical Font Description). When Qt is build with Xft support on X11, the return value can be an Xft pattern or an XLFD. -.PP -Using the return value of this function is usually \fInot\fR \fIportable\fR. -.PP -See also setRawName(). -.SH "void QFont::removeSubstitution ( const QString & familyName )\fC [static]\fR" -Removes all the substitutions for \fIfamilyName\fR. -.PP -See also insertSubstitutions(), insertSubstitution(), substitutions(), and substitute(). -.SH "QFont QFont::resolve ( const QFont & other ) const" -Returns a new QFont that has attributes copied from \fIother\fR. -.SH "void QFont::setBold ( bool enable )" -If \fIenable\fR is true sets the font's weight to QFont::Bold; otherwise sets the weight to QFont::Normal. -.PP -For finer boldness control use setWeight(). -.PP -See also bold() and setWeight(). -.PP -Examples: -.)l menu/menu.cpp and themes/metal.cpp. -.SH "void QFont::setDefaultFont ( const QFont & f )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Please use QApplication::setFont() instead. -.SH "void QFont::setFamily ( const QString & family )" -Sets the family name of the font. The name is case insensitive and may include a foundry name. -.PP -The \fIfamily\fR name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". (The Qt 2.x syntax, i.e." Cronyx-Helvetica", is also supported.) If the \fIfamily\fR is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm. -.PP -See also family(), setStyleHint(), and QFontInfo. -.SH "void QFont::setFixedPitch ( bool enable )" -If \fIenable\fR is TRUE, sets fixed pitch on; otherwise sets fixed pitch off. -.PP -See also fixedPitch() and QFontInfo. -.SH "void QFont::setItalic ( bool enable )" -If \fIenable\fR is TRUE, italic is set on; otherwise italic is set off. -.PP -See also italic() and QFontInfo. -.PP -Examples: -.)l fileiconview/qfileiconview.cpp, fonts/simple-qfont-demo/viewer.cpp, and themes/metal.cpp. -.SH "void QFont::setOverline ( bool enable )" -If \fIenable\fR is TRUE, sets overline on; otherwise sets overline off. -.PP -See also overline() and QFontInfo. -.SH "void QFont::setPixelSize ( int pixelSize )" -Sets the font size to \fIpixelSize\fR pixels. -.PP -Using this function makes the font device dependent. Use setPointSize() or setPointSizeFloat() to set the size of the font in a device independent manner. -.PP -See also pixelSize(). -.PP -Example: qwerty/qwerty.cpp. -.SH "void QFont::setPixelSizeFloat ( float pixelSize )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the logical pixel height of font characters when shown on the screen to \fIpixelSize\fR. -.SH "void QFont::setPointSize ( int pointSize )" -Sets the point size to \fIpointSize\fR. The point size must be greater than zero. -.PP -See also pointSize() and setPointSizeFloat(). -.PP -Example: fonts/simple-qfont-demo/viewer.cpp. -.SH "void QFont::setPointSizeFloat ( float pointSize )" -Sets the point size to \fIpointSize\fR. The point size must be greater than zero. The requested precision may not be achieved on all platforms. -.PP -See also pointSizeFloat(), setPointSize(), and setPixelSize(). -.SH "void QFont::setRawMode ( bool enable )" -If \fIenable\fR is TRUE, turns raw mode on; otherwise turns raw mode off. This function only has an effect under X11. -.PP -If raw mode is enabled, Qt will search for an X font with a complete font name matching the family name, ignoring all other values set for the QFont. If the font name matches several fonts, Qt will use the first font returned by X. QFontInfo \fIcannot\fR be used to fetch information about a QFont using raw mode (it will return the values set in the QFont for all parameters, including the family name). -.PP -\fBWarning:\fR Do not use raw mode unless you really, really need it! In most (if not all) cases, setRawName() is a much better choice. -.PP -See also rawMode() and setRawName(). -.SH "void QFont::setRawName ( const QString & name )" -Sets a font by its system specific name. The function is particularly useful under X, where system font settings (for example X resources) are usually available in XLFD (X Logical Font Description) form only. You can pass an XLFD as \fIname\fR to this function. -.PP -A font set with setRawName() is still a full-featured QFont. It can be queried (for example with italic()) or modified (for example with setItalic()) and is therefore also suitable for rendering rich text. -.PP -If Qt's internal font database cannot resolve the raw name, the font becomes a raw font with \fIname\fR as its family. -.PP -Note that the present implementation does not handle wildcards in XLFDs well, and that font aliases (file \fCfonts.alias\fR in the font directory on X11) are not supported. -.PP -See also rawName(), setRawMode(), and setFamily(). -.SH "void QFont::setStretch ( int factor )" -Sets the stretch factor for the font. -.PP -The stretch factor changes the width of all characters in the font by \fIfactor\fR percent. For example, setting \fIfactor\fR to 150 results in all characters in the font being 1.5 times ( ie. 150% ) wider. The default stretch factor is 100. The minimum stretch factor is 1, and the maximum stretch factor is 4000. -.PP -The stretch factor is only applied to outline fonts. The stretch factor is ignored for bitmap fonts. -.PP -NOTE: QFont cannot stretch XLFD fonts. When loading XLFD fonts on X11, the stretch factor is matched against a predefined set of values for the SETWIDTH_NAME field of the XLFD. -.PP -See also stretch() and QFont::StyleStrategy. -.SH "void QFont::setStrikeOut ( bool enable )" -If \fIenable\fR is TRUE, sets strikeout on; otherwise sets strikeout off. -.PP -See also strikeOut() and QFontInfo. -.SH "void QFont::setStyleHint ( StyleHint hint, StyleStrategy strategy = PreferDefault )" -Sets the style hint and strategy to \fIhint\fR and \fIstrategy\fR, respectively. -.PP -If these aren't set explicitly the style hint will default to AnyStyle and the style strategy to PreferDefault. -.PP -Qt does not support style hints on X11 since this information is not provided by the window system. -.PP -See also StyleHint, styleHint(), StyleStrategy, styleStrategy(), and QFontInfo. -.PP -Examples: -.)l desktop/desktop.cpp and fonts/simple-qfont-demo/viewer.cpp. -.SH "void QFont::setStyleStrategy ( StyleStrategy s )" -Sets the style strategy for the font to \fIs\fR. -.PP -See also QFont::StyleStrategy. -.SH "void QFont::setUnderline ( bool enable )" -If \fIenable\fR is TRUE, sets underline on; otherwise sets underline off. -.PP -See also underline() and QFontInfo. -.PP -Examples: -.)l fonts/simple-qfont-demo/viewer.cpp and menu/menu.cpp. -.SH "void QFont::setWeight ( int weight )" -Sets the weight the font to \fIweight\fR, which should be a value from the QFont::Weight enumeration. -.PP -See also weight() and QFontInfo. -.PP -Example: fonts/simple-qfont-demo/viewer.cpp. -.SH "int QFont::stretch () const" -Returns the stretch factor for the font. -.PP -See also setStretch(). -.SH "bool QFont::strikeOut () const" -Returns TRUE if strikeout has been set; otherwise returns FALSE. -.PP -See also setStrikeOut(). -.SH "StyleHint QFont::styleHint () const" -Returns the StyleHint. -.PP -The style hint affects the font matching algorithm. See QFont::StyleHint for the list of strategies. -.PP -See also setStyleHint(), QFont::StyleStrategy, and QFontInfo::styleHint(). -.SH "StyleStrategy QFont::styleStrategy () const" -Returns the StyleStrategy. -.PP -The style strategy affects the font matching algorithm. See QFont::StyleStrategy for the list of strategies. -.PP -See also setStyleHint() and QFont::StyleHint. -.SH "QString QFont::substitute ( const QString & familyName )\fC [static]\fR" -Returns the first family name to be used whenever \fIfamilyName\fR is specified. The lookup is case insensitive. -.PP -If there is no substitution for \fIfamilyName\fR, \fIfamilyName\fR is returned. -.PP -To obtain a list of substitutions use substitutes(). -.PP -See also setFamily(), insertSubstitutions(), insertSubstitution(), and removeSubstitution(). -.SH "QStringList QFont::substitutes ( const QString & familyName )\fC [static]\fR" -Returns a list of family names to be used whenever \fIfamilyName\fR is specified. The lookup is case insensitive. -.PP -If there is no substitution for \fIfamilyName\fR, an empty list is returned. -.PP -See also substitute(), insertSubstitutions(), insertSubstitution(), and removeSubstitution(). -.PP -Example: fonts/simple-qfont-demo/viewer.cpp. -.SH "QStringList QFont::substitutions ()\fC [static]\fR" -Returns a sorted list of substituted family names. -.PP -See also insertSubstitution(), removeSubstitution(), and substitute(). -.SH "QString QFont::toString () const" -Returns a description of the font. The description is a comma-separated list of the attributes, perfectly suited for use in QSettings. -.PP -See also fromString() and operator<<(). -.SH "bool QFont::underline () const" -Returns TRUE if underline has been set; otherwise returns FALSE. -.PP -See also setUnderline(). -.SH "int QFont::weight () const" -Returns the weight of the font which is one of the enumerated values from QFont::Weight. -.PP -See also setWeight(), Weight, and QFontInfo. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QFont & font )" -Writes the font \fIfont\fR to the data stream \fIs\fR. (toString() writes to a text stream.) -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QFont & font )" -Reads the font \fIfont\fR from the data stream \fIs\fR. (fromString() reads from a text stream.) -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfont.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfont.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfontdatabase.3qt b/doc/man/man3/qfontdatabase.3qt deleted file mode 100644 index 7582fa7d2..000000000 --- a/doc/man/man3/qfontdatabase.3qt +++ /dev/null @@ -1,303 +0,0 @@ -'\" t -.TH QFontDatabase 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 -QFontDatabase \- Information about the fonts available in the underlying window system -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFontDatabase\fR ()" -.br -.ti -1c -.BI "QStringList \fBfamilies\fR () const" -.br -.ti -1c -.BI "QStringList \fBfamilies\fR ( QFont::Script script ) const" -.br -.ti -1c -.BI "QStringList \fBstyles\fR ( const QString & family ) const" -.br -.ti -1c -.BI "QValueList \fBpointSizes\fR ( const QString & family, const QString & style = QString::null )" -.br -.ti -1c -.BI "QValueList \fBsmoothSizes\fR ( const QString & family, const QString & style )" -.br -.ti -1c -.BI "QString \fBstyleString\fR ( const QFont & f )" -.br -.ti -1c -.BI "QFont \fBfont\fR ( const QString & family, const QString & style, int pointSize )" -.br -.ti -1c -.BI "bool \fBisBitmapScalable\fR ( const QString & family, const QString & style = QString::null ) const" -.br -.ti -1c -.BI "bool \fBisSmoothlyScalable\fR ( const QString & family, const QString & style = QString::null ) const" -.br -.ti -1c -.BI "bool \fBisScalable\fR ( const QString & family, const QString & style = QString::null ) const" -.br -.ti -1c -.BI "bool \fBisFixedPitch\fR ( const QString & family, const QString & style = QString::null ) const" -.br -.ti -1c -.BI "bool \fBitalic\fR ( const QString & family, const QString & style ) const" -.br -.ti -1c -.BI "bool \fBbold\fR ( const QString & family, const QString & style ) const" -.br -.ti -1c -.BI "int \fBweight\fR ( const QString & family, const QString & style ) const" -.br -.ti -1c -.BI "QStringList families ( bool ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QStringList styles ( const QString & family, const QString & ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QValueList pointSizes ( const QString & family, const QString & style, const QString & ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QValueList smoothSizes ( const QString & family, const QString & style, const QString & ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QFont font ( const QString & familyName, const QString & style, int pointSize, const QString & ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isBitmapScalable ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isSmoothlyScalable ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isScalable ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isFixedPitch ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool italic ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool bold ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int weight ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QValueList \fBstandardSizes\fR ()" -.br -.ti -1c -.BI "QString \fBscriptName\fR ( QFont::Script script )" -.br -.ti -1c -.BI "QString \fBscriptSample\fR ( QFont::Script script )" -.br -.in -1c -.SH DESCRIPTION -The QFontDatabase class provides information about the fonts available in the underlying window system. -.PP -The most common uses of this class are to query the database for the list of font families() and for the pointSizes() and styles() that are available for each family. An alternative to pointSizes() is smoothSizes() which returns the sizes at which a given family and style will look attractive. -.PP -If the font family is available from two or more foundries the foundry name is included in the family name, e.g. "Helvetica [Adobe]" and "Helvetica [Cronyx]". When you specify a family you can either use the old hyphenated Qt 2.x "foundry-family" format, e.g. "Cronyx-Helvetica", or the new bracketed Qt 3.x "family [foundry]" format e.g. "Helvetica [Cronyx]". If the family has a foundry it is always returned, e.g. by families(), using the bracketed format. -.PP -The font() function returns a QFont given a family, style and point size. -.PP -A family and style combination can be checked to see if it is italic() or bold(), and to retrieve its weight(). Similarly we can call isBitmapScalable(), isSmoothlyScalable(), isScalable() and isFixedPitch(). -.PP -A text version of a style is given by styleString(). -.PP -The QFontDatabase class also supports some static functions, for example, standardSizes(). You can retrieve the Unicode 3.0 description of a script using scriptName(), and a sample of characters in a script with scriptSample(). -.PP -Example: -.PP -.nf -.br -#include -.br -#include -.br -#include -.br -.br -int main( int argc, char **argv ) -.br -{ -.br - QApplication app( argc, argv ); -.br - QFontDatabase fdb; -.br - QStringList families = fdb.families(); -.br - for ( QStringList::Iterator f = families.begin(); f != families.end(); ++f ) { -.br - QString family = *f; -.br - tqDebug( family ); -.br - QStringList styles = fdb.styles( family ); -.br - for ( QStringList::Iterator s = styles.begin(); s != styles.end(); ++s ) { -.br - QString style = *s; -.br - QString dstyle = "\\t" + style + " ("; -.br - QValueList smoothies = fdb.smoothSizes( family, style ); -.br - for ( QValueList::Iterator points = smoothies.begin(); -.br - points != smoothies.end(); ++points ) { -.br - dstyle += QString::number( *points ) + " "; -.br - } -.br - dstyle = dstyle.left( dstyle.length() - 1 ) + ")"; -.br - tqDebug( dstyle ); -.br - } -.br - } -.br - return 0; -.br -} -.fi -This example gets the list of font families, then the list of styles for each family and the point sizes that are available for each family/style combination. -.PP -See also Environment Classes and Graphics Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFontDatabase::QFontDatabase ()" -Creates a font database object. -.SH "bool QFontDatabase::bold ( const QString & family, const QString & style ) const" -Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is bold; otherwise returns FALSE. -.PP -See also italic() and weight(). -.SH "bool QFontDatabase::bold ( const QString & family, const QString & style, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QStringList QFontDatabase::families () const" -Returns a sorted list of the names of the available font families. -.PP -If a family exists in several foundries, the returned name for that font is in the form "family [foundry]". Examples: -.)l "Times -[Adobe]", "Times [Cronyx]", "Palatino". -.SH "QStringList QFontDatabase::families ( QFont::Script script ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a sorted list of the available font families which support the Unicode script \fIscript\fR. -.PP -If a family exists in several foundries, the returned name for that font is in the form "family [foundry]". Examples: -.)l "Times -[Adobe]", "Times [Cronyx]", "Palatino". -.SH "QStringList QFontDatabase::families ( bool ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QFont QFontDatabase::font ( const QString & family, const QString & style, int pointSize )" -Returns a QFont object that has family \fIfamily\fR, style \fIstyle\fR and point size \fIpointSize\fR. If no matching font could be created, a QFont object that uses the application's default font is returned. -.SH "QFont QFontDatabase::font ( const QString & familyName, const QString & style, int pointSize, const QString & )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QFontDatabase::isBitmapScalable ( const QString & family, const QString & style = QString::null ) const" -Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is a scalable bitmap font; otherwise returns FALSE. Scaling a bitmap font usually produces an unattractive hardly readable result, because the pixels of the font are scaled. If you need to scale a bitmap font it is better to scale it to one of the fixed sizes returned by smoothSizes(). -.PP -See also isScalable() and isSmoothlyScalable(). -.SH "bool QFontDatabase::isBitmapScalable ( const QString & family, const QString & style, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QFontDatabase::isFixedPitch ( const QString & family, const QString & style = QString::null ) const" -Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is fixed pitch; otherwise returns FALSE. -.SH "bool QFontDatabase::isFixedPitch ( const QString & family, const QString & style, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QFontDatabase::isScalable ( const QString & family, const QString & style = QString::null ) const" -Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is scalable; otherwise returns FALSE. -.PP -See also isBitmapScalable() and isSmoothlyScalable(). -.SH "bool QFontDatabase::isScalable ( const QString & family, const QString & style, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QFontDatabase::isSmoothlyScalable ( const QString & family, const QString & style = QString::null ) const" -Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is smoothly scalable; otherwise returns FALSE. If this function returns TRUE, it's safe to scale this font to any size, and the result will always look attractive. -.PP -See also isScalable() and isBitmapScalable(). -.SH "bool QFontDatabase::isSmoothlyScalable ( const QString & family, const QString & style, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QFontDatabase::italic ( const QString & family, const QString & style ) const" -Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is italic; otherwise returns FALSE. -.PP -See also weight() and bold(). -.SH "bool QFontDatabase::italic ( const QString & family, const QString & style, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QValueList QFontDatabase::pointSizes ( const QString & family, const QString & style = QString::null )" -Returns a list of the point sizes available for the font that has family \fIfamily\fR and style \fIstyle\fR. The list may be empty. -.PP -See also smoothSizes() and standardSizes(). -.SH "QValueList QFontDatabase::pointSizes ( const QString & family, const QString & style, const QString & )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QString QFontDatabase::scriptName ( QFont::Script script )\fC [static]\fR" -Returns a string that gives a default description of the \fIscript\fR (e.g. for displaying to the user in a dialog). The name matches the name of the script as defined by the Unicode 3.0 standard. -.PP -See also QFont::Script. -.SH "QString QFontDatabase::scriptSample ( QFont::Script script )\fC [static]\fR" -Returns a string with sample characters from \fIscript\fR. -.PP -See also QFont::Script. -.SH "QValueList QFontDatabase::smoothSizes ( const QString & family, const QString & style )" -Returns the point sizes of a font that has family \fIfamily\fR and style \fIstyle\fR that will look attractive. The list may be empty. For non-scalable fonts and bitmap scalable fonts, this function is equivalent to pointSizes(). -.PP -See also pointSizes() and standardSizes(). -.SH "QValueList QFontDatabase::smoothSizes ( const QString & family, const QString & style, const QString & )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QValueList QFontDatabase::standardSizes ()\fC [static]\fR" -Returns a list of standard font sizes. -.PP -See also smoothSizes() and pointSizes(). -.SH "QString QFontDatabase::styleString ( const QFont & f )" -Returns a string that describes the style of the font \fIf\fR. For example, "Bold Italic", "Bold", "Italic" or "Normal". An empty string may be returned. -.SH "QStringList QFontDatabase::styles ( const QString & family ) const" -Returns a list of the styles available for the font family \fIfamily\fR. Some example styles: "Light", "Light Italic", "Bold"," Oblique", "Demi". The list may be empty. -.SH "QStringList QFontDatabase::styles ( const QString & family, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "int QFontDatabase::weight ( const QString & family, const QString & style ) const" -Returns the weight of the font that has family \fIfamily\fR and style \fIstyle\fR. If there is no such family and style combination, returns -1. -.PP -See also italic() and bold(). -.SH "int QFontDatabase::weight ( const QString & family, const QString & style, const QString & ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfontdatabase.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfontdatabase.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfontdialog.3qt b/doc/man/man3/qfontdialog.3qt deleted file mode 100644 index a824600c2..000000000 --- a/doc/man/man3/qfontdialog.3qt +++ /dev/null @@ -1,163 +0,0 @@ -'\" t -.TH QFontDialog 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 -QFontDialog \- Dialog widget for selecting a font -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Static Public Members" -
                        1. QFont \fBgetFont\fR ( bool * ok, const QFont & initial, QWidget * parent = 0, const char * name = 0 )
                        2. QFont \fBgetFont\fR ( bool * ok, QWidget * parent = 0, const char * name = 0 ) -.SH DESCRIPTION -The QFontDialog class provides a dialog widget for selecting a font. -.PP -The usual way to use this class is to call one of the static convenience functions, e.g. getFont(). -.PP -Examples: -.)l -.PP -.nf -.br - bool ok; -.br - QFont font = QFontDialog::getFont( -.br - &ok, QFont( "Helvetica [Cronyx]", 10 ), this ); -.br - if ( ok ) { -.br - // font is set to the font the user selected -.br - } else { -.br - // the user canceled the dialog; font is set to the initial -.br - // value, in this case Helvetica [Cronyx], 10 -.br - } -.br -.fi -.PP -The dialog can also be used to set a widget's font directly: -.PP -.nf -.br - myWidget.setFont( QFontDialog::getFont( 0, myWidget.font() ) ); -.br -.fi -If the user clicks OK the font they chose will be used for myWidget, and if they click Cancel the original font is used. -.PP -See also QFont, QFontInfo, QFontMetrics, and Dialog Classes. -.PP -.ce 1 -.B "[Image Omitted]" -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFont QFontDialog::getFont ( bool * ok, const QFont & initial, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Executes a modal font dialog and returns a font. -.PP -If the user clicks OK, the selected font is returned. If the user clicks Cancel, the \fIinitial\fR font is returned. -.PP -The dialog is called \fIname\fR, with the parent \fIparent\fR. \fIinitial\fR is the initially selected font. If the \fIok\fR parameter is not-null, \fI*\fR\fIok\fR is set to TRUE if the user clicked OK, and set to FALSE if the user clicked Cancel. -.PP -This static function is less flexible than the full QFontDialog object, but is convenient and easy to use. -.PP -Examples: -.)l -.PP -.nf -.br - bool ok; -.br - QFont font = QFontDialog::getFont( &ok, QFont( "Times", 12 ), this ); -.br - if ( ok ) { -.br - // font is set to the font the user selected -.br - } else { -.br - // the user canceled the dialog; font is set to the initial -.br - // value, in this case Times, 12. -.br - } -.br -.fi -.PP -The dialog can also be used to set a widget's font directly: -.PP -.nf -.br - myWidget.setFont( QFontDialog::getFont( 0, myWidget.font() ) ); -.br -.fi -In this example, if the user clicks OK the font they chose will be used, and if they click Cancel the original font is used. -.PP -Examples: -.)l chart/chartform.cpp, chart/optionsform.cpp, qfd/fontdisplayer.cpp, qwerty/qwerty.cpp, and xform/xform.cpp. -.SH "QFont QFontDialog::getFont ( bool * ok, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Executes a modal font dialog and returns a font. -.PP -If the user clicks OK, the selected font is returned. If the user clicks Cancel, the Qt default font is returned. -.PP -The dialog is called \fIname\fR, with parent \fIparent\fR. If the \fIok\fR parameter is not-null, \fI*\fR\fIok\fR is set to TRUE if the user clicked OK, and FALSE if the user clicked Cancel. -.PP -This static function is less functional than the full QFontDialog object, but is convenient and easy to use. -.PP -Example: -.PP -.nf -.br - bool ok; -.br - QFont font = QFontDialog::getFont( &ok, this ); -.br - if ( ok ) { -.br - // font is set to the font the user selected -.br - } else { -.br - // the user canceled the dialog; font is set to the default -.br - // application font, QApplication::font() -.br - } -.br -.fi -.PP - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfontdialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfontdialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfontinfo.3qt b/doc/man/man3/qfontinfo.3qt deleted file mode 100644 index b1abcab83..000000000 --- a/doc/man/man3/qfontinfo.3qt +++ /dev/null @@ -1,175 +0,0 @@ -'\" t -.TH QFontInfo 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 -QFontInfo \- General information about fonts -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFontInfo\fR ( const QFont & font )" -.br -.ti -1c -.BI "\fBQFontInfo\fR ( const QFont & font, QFont::Script script )" -.br -.ti -1c -.BI "\fBQFontInfo\fR ( const QFontInfo & fi )" -.br -.ti -1c -.BI "\fB~QFontInfo\fR ()" -.br -.ti -1c -.BI "QFontInfo & \fBoperator=\fR ( const QFontInfo & fi )" -.br -.ti -1c -.BI "QString \fBfamily\fR () const" -.br -.ti -1c -.BI "int \fBpixelSize\fR () const" -.br -.ti -1c -.BI "int \fBpointSize\fR () const" -.br -.ti -1c -.BI "bool \fBitalic\fR () const" -.br -.ti -1c -.BI "int \fBweight\fR () const" -.br -.ti -1c -.BI "bool \fBbold\fR () const" -.br -.ti -1c -.BI "bool \fBfixedPitch\fR () const" -.br -.ti -1c -.BI "QFont::StyleHint \fBstyleHint\fR () const" -.br -.ti -1c -.BI "bool \fBrawMode\fR () const" -.br -.ti -1c -.BI "bool \fBexactMatch\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QFontInfo class provides general information about fonts. -.PP -The QFontInfo class provides the same access functions as QFont, e.g. family(), pointSize(), italic(), weight(), fixedPitch(), styleHint() etc. But whilst the QFont access functions return the values that were set, a QFontInfo object returns the values that apply to the font that will actually be used to draw the text. -.PP -For example, when the program asks for a 25pt Courier font on a machine that has a non-scalable 24pt Courier font, QFont will (normally) use the 24pt Courier for rendering. In this case, QFont::pointSize() returns 25 and QFontInfo::pointSize() returns 24. -.PP -There are three ways to create a QFontInfo object.
                            -.IP 1 -Calling the QFontInfo constructor with a QFont creates a font info object for a screen-compatible font, i.e. the font cannot be a printer font*. If the font is changed later, the font info object is \fInot\fR updated. -.IP 2 -QWidget::fontInfo() returns the font info for a widget's font. This is equivalent to calling QFontInfo(widget->font()). If the widget's font is changed later, the font info object is \fInot\fR updated. -.IP 3 -QPainter::fontInfo() returns the font info for a painter's current font. If the painter's font is changed later, the font info object is \fInot\fR updated. -.PP -* If you use a printer font the values returned may be inaccurate. Printer fonts are not always accessible so the nearest screen font is used if a printer font is supplied. -.PP -See also QFont, QFontMetrics, QFontDatabase, Graphics Classes, and Implicitly and Explicitly Shared Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFontInfo::QFontInfo ( const QFont & font )" -Constructs a font info object for \fIfont\fR. -.PP -The font must be screen-compatible, i.e. a font you use when drawing text in widgets or pixmaps, not QPicture or QPrinter. -.PP -The font info object holds the information for the font that is passed in the constructor at the time it is created, and is not updated if the font's attributes are changed later. -.PP -Use QPainter::fontInfo() to get the font info when painting. This will give correct results also when painting on paint device that is not screen-compatible. -.SH "QFontInfo::QFontInfo ( const QFont & font, QFont::Script script )" -Constructs a font info object for \fIfont\fR using the specified \fIscript\fR. -.SH "QFontInfo::QFontInfo ( const QFontInfo & fi )" -Constructs a copy of \fIfi\fR. -.SH "QFontInfo::~QFontInfo ()" -Destroys the font info object. -.SH "bool QFontInfo::bold () const" -Returns TRUE if weight() would return a value greater than QFont::Normal; otherwise returns FALSE. -.PP -See also weight() and QFont::bold(). -.PP -Example: qfd/fontdisplayer.cpp. -.SH "bool QFontInfo::exactMatch () const" -Returns TRUE if the matched window system font is exactly the same as the one specified by the font; otherwise returns FALSE. -.PP -See also QFont::exactMatch(). -.SH "QString QFontInfo::family () const" -Returns the family name of the matched window system font. -.PP -See also QFont::family(). -.PP -Examples: -.)l fonts/simple-qfont-demo/viewer.cpp and qfd/fontdisplayer.cpp. -.SH "bool QFontInfo::fixedPitch () const" -Returns the fixed pitch value of the matched window system font. -.PP -See also QFont::fixedPitch(). -.SH "bool QFontInfo::italic () const" -Returns the italic value of the matched window system font. -.PP -See also QFont::italic(). -.PP -Example: qfd/fontdisplayer.cpp. -.SH "QFontInfo & QFontInfo::operator= ( const QFontInfo & fi )" -Assigns the font info in \fIfi\fR. -.SH "int QFontInfo::pixelSize () const" -Returns the pixel size of the matched window system font. -.PP -See also QFont::pointSize(). -.SH "int QFontInfo::pointSize () const" -Returns the point size of the matched window system font. -.PP -See also QFont::pointSize(). -.PP -Examples: -.)l fonts/simple-qfont-demo/viewer.cpp and qfd/fontdisplayer.cpp. -.SH "bool QFontInfo::rawMode () const" -Returns TRUE if the font is a raw mode font; otherwise returns FALSE. -.PP -If it is a raw mode font, all other functions in QFontInfo will return the same values set in the QFont, regardless of the font actually used. -.PP -See also QFont::rawMode(). -.SH "QFont::StyleHint QFontInfo::styleHint () const" -Returns the style of the matched window system font. -.PP -Currently only returns the style hint set in QFont. -.PP -See also QFont::styleHint() and QFont::StyleHint. -.SH "int QFontInfo::weight () const" -Returns the weight of the matched window system font. -.PP -See also QFont::weight() and bold(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfontinfo.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfontinfo.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfontmanager.3qt b/doc/man/man3/qfontmanager.3qt deleted file mode 100644 index 13b5d9a87..000000000 --- a/doc/man/man3/qfontmanager.3qt +++ /dev/null @@ -1,76 +0,0 @@ -'\" t -.TH QFontManager 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 -QFontManager \- Implements font management in Qt/Embedded -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFontManager\fR ()" -.br -.ti -1c -.BI "\fB~QFontManager\fR ()" -.br -.ti -1c -.BI "QDiskFont * \fBget\fR ( const QFontDef & f )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBinitialize\fR ()" -.br -.ti -1c -.BI "void \fBcleanup\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QFontManager class implements font management in Qt/Embedded. -.PP -There is one and only one QFontManager per Qt/Embedded application. The \fCqt_fontmanager\fR global variable points to it. It keeps a list of font factories, a cache of rendered fonts and a list of fonts available on disk. QFontManager is called when a new font needs to be rendered from a Freetype-compatible or BDF font on disk; this only happens if there isn't an appropriate QPF font already available. -.PP -See also Qt/Embedded. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFontManager::QFontManager ()" -Creates a font manager. This method reads in the font definition file from \fCINSTALL/lib/fonts/fontdir\fR, where \fCINSTALL\fR is the directory where Qt/Embedded was installed, and creates a list of QDiskFonts to hold the information in the file. It also constructs any defined font factories. -.SH "QFontManager::~QFontManager ()" -Destroys the QFontManager and sets \fCqt_fontmanager\fR to 0. -.SH "void QFontManager::cleanup ()\fC [static]\fR" -Destroys the font manager -.SH "QDiskFont * QFontManager::get ( const QFontDef & f )" -Returns the QDiskFont that best matches \fIf\fR, based on family, weight, italicity and font size. -.SH "void QFontManager::initialize ()\fC [static]\fR" -Creates a new QFontManager and points \fCqt_fontmanager\fR to it - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qfontmanager.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfontmanager.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qfontmetrics.3qt b/doc/man/man3/qfontmetrics.3qt deleted file mode 100644 index 90ad7cbc9..000000000 --- a/doc/man/man3/qfontmetrics.3qt +++ /dev/null @@ -1,416 +0,0 @@ -'\" t -.TH QFontMetrics 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 -QFontMetrics \- Font metrics information -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFontMetrics\fR ( const QFont & font )" -.br -.ti -1c -.BI "\fBQFontMetrics\fR ( const QFont & font, QFont::Script script )" -.br -.ti -1c -.BI "\fBQFontMetrics\fR ( const QFontMetrics & fm )" -.br -.ti -1c -.BI "\fB~QFontMetrics\fR ()" -.br -.ti -1c -.BI "QFontMetrics & \fBoperator=\fR ( const QFontMetrics & fm )" -.br -.ti -1c -.BI "int \fBascent\fR () const" -.br -.ti -1c -.BI "int \fBdescent\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "int \fBleading\fR () const" -.br -.ti -1c -.BI "int \fBlineSpacing\fR () const" -.br -.ti -1c -.BI "int \fBminLeftBearing\fR () const" -.br -.ti -1c -.BI "int \fBminRightBearing\fR () const" -.br -.ti -1c -.BI "int \fBmaxWidth\fR () const" -.br -.ti -1c -.BI "bool \fBinFont\fR ( QChar ch ) const" -.br -.ti -1c -.BI "int \fBleftBearing\fR ( QChar ch ) const" -.br -.ti -1c -.BI "int \fBrightBearing\fR ( QChar ch ) const" -.br -.ti -1c -.BI "int \fBwidth\fR ( const QString & str, int len = -1 ) const" -.br -.ti -1c -.BI "int \fBwidth\fR ( QChar ch ) const" -.br -.ti -1c -.BI "int width ( char c ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBcharWidth\fR ( const QString & str, int pos ) const" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR ( const QString & str, int len = -1 ) const" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR ( QChar ch ) const" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR ( int x, int y, int w, int h, int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" -.br -.ti -1c -.BI "QSize \fBsize\fR ( int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" -.br -.ti -1c -.BI "int \fBunderlinePos\fR () const" -.br -.ti -1c -.BI "int \fBoverlinePos\fR () const" -.br -.ti -1c -.BI "int \fBstrikeOutPos\fR () const" -.br -.ti -1c -.BI "int \fBlineWidth\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QFontMetrics class provides font metrics information. -.PP -QFontMetrics functions calculate the size of characters and strings for a given font. There are three ways you can create a QFontMetrics object: -.PP -
                              -.IP 1 -Calling the QFontMetrics constructor with a QFont creates a font metrics object for a screen-compatible font, i.e. the font cannot be a printer font*. If the font is changed later, the font metrics object is \fInot\fR updated. -.IP 2 -QWidget::fontMetrics() returns the font metrics for a widget's font. This is equivalent to QFontMetrics(widget->font()). If the widget's font is changed later, the font metrics object is \fInot\fR updated. -.IP 3 -QPainter::fontMetrics() returns the font metrics for a painter's current font. If the painter's font is changed later, the font metrics object is \fInot\fR updated. -.PP -* If you use a printer font the values returned may be inaccurate. Printer fonts are not always accessible so the nearest screen font is used if a printer font is supplied. -.PP -Once created, the object provides functions to access the individual metrics of the font, its characters, and for strings rendered in the font. -.PP -There are several functions that operate on the font: ascent(), descent(), height(), leading() and lineSpacing() return the basic size properties of the font. The underlinePos(), overlinePos(), strikeOutPos() and lineWidth() functions, return the properties of the line that underlines, overlines or strikes out the characters. These functions are all fast. -.PP -There are also some functions that operate on the set of glyphs in the font: minLeftBearing(), minRightBearing() and maxWidth(). These are by necessity slow, and we recommend avoiding them if possible. -.PP -For each character, you can get its width(), leftBearing() and rightBearing() and find out whether it is in the font using inFont(). You can also treat the character as a string, and use the string functions on it. -.PP -The string functions include width(), to return the width of a string in pixels (or points, for a printer), boundingRect(), to return a rectangle large enough to contain the rendered string, and size(), to return the size of that rectangle. -.PP -Example: -.PP -.nf -.br - QFont font( "times", 24 ); -.br - QFontMetrics fm( font ); -.br - int pixelsWide = fm.width( "What's the width of this text?" ); -.br - int pixelsHigh = fm.height(); -.br -.fi -.PP -See also QFont, QFontInfo, QFontDatabase, Graphics Classes, and Implicitly and Explicitly Shared Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFontMetrics::QFontMetrics ( const QFont & font )" -Constructs a font metrics object for \fIfont\fR. -.PP -The font must be screen-compatible, i.e. a font you use when drawing text in widgets or pixmaps, not QPicture or QPrinter. -.PP -The font metrics object holds the information for the font that is passed in the constructor at the time it is created, and is not updated if the font's attributes are changed later. -.PP -Use QPainter::fontMetrics() to get the font metrics when painting. This will give correct results also when painting on paint device that is not screen-compatible. -.SH "QFontMetrics::QFontMetrics ( const QFont & font, QFont::Script script )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a font metrics object for \fIfont\fR using the given \fIscript\fR. -.SH "QFontMetrics::QFontMetrics ( const QFontMetrics & fm )" -Constructs a copy of \fIfm\fR. -.SH "QFontMetrics::~QFontMetrics ()" -Destroys the font metrics object and frees all allocated resources. -.SH "int QFontMetrics::ascent () const" -Returns the ascent of the font. -.PP -The ascent of a font is the distance from the baseline to the highest position characters extend to. In practice, some font designers break this rule, e.g. when they put more than one accent on top of a character, or to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small. -.PP -See also descent(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp and scrollview/scrollview.cpp. -.SH "QRect QFontMetrics::boundingRect ( QChar ch ) const" -Returns the rectangle that is covered by ink if the character specified by \fIch\fR were to be drawn at the origin of the coordinate system. -.PP -Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts, and that the text output may cover \fIall\fR pixels in the bounding rectangle. For a space character the rectangle will usually be empty. -.PP -Note that the rectangle usually extends both above and below the base line. -.PP -\fBWarning:\fR The width of the returned rectangle is not the advance width of the character. Use boundingRect(const QString &) or width() instead. -.PP -See also width(). -.PP -Example: xform/xform.cpp. -.SH "QRect QFontMetrics::boundingRect ( const QString & str, int len = -1 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the bounding rectangle that contains the first \fIlen\fR characters of string \fIstr\fR. -.SH "QRect QFontMetrics::boundingRect ( int x, int y, int w, int h, int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the bounding rectangle of the first \fIlen\fR characters of \fIstr\fR, which is the set of pixels the text would cover if drawn at (0, 0). The drawing, and hence the bounding rectangle, is constrained to the rectangle (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR). -.PP -If \fIlen\fR is negative (which is the default), the entire string is used. -.PP -The \fIflgs\fR argument is the bitwise OR of the following flags: -.TP -\fCAlignAuto\fR aligns to the left border for all languages except Arabic and Hebrew where it aligns to the right. -.TP -\fCAlignLeft\fR aligns to the left border. -.TP -\fCAlignRight\fR aligns to the right border. -.TP -\fCAlignJustify\fR produces justified text. -.TP -\fCAlignHCenter\fR aligns horizontally centered. -.TP -\fCAlignTop\fR aligns to the top border. -.TP -\fCAlignBottom\fR aligns to the bottom border. -.TP -\fCAlignVCenter\fR aligns vertically centered -.TP -\fCAlignCenter\fR (== \fCAlignHCenter | AlignVCenter\fR) -.TP -\fCSingleLine\fR ignores newline characters in the text. -.TP -\fCExpandTabs\fR expands tabs (see below) -.TP -\fCShowPrefix\fR interprets "&x" as "x", i.e. underlined. -.TP -\fCWordBreak\fR breaks the text to fit the rectangle. -.PP -Horizontal alignment defaults to \fCAlignAuto\fR and vertical alignment defaults to \fCAlignTop\fR. -.PP -If several of the horizontal or several of the vertical alignment flags are set, the resulting alignment is undefined. -.PP -These flags are defined in ntqnamespace.h. -.PP -If \fCExpandTabs\fR is set in \fIflgs\fR, then: if \fItabarray\fR is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs; otherwise if \fItabstops\fR is non-zero, it is used as the tab spacing (in pixels). -.PP -Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts, and that the text output may cover \fIall\fR pixels in the bounding rectangle. -.PP -Newline characters are processed as linebreaks. -.PP -Despite the different actual character heights, the heights of the bounding rectangles of "Yes" and "yes" are the same. -.PP -The bounding rectangle given by this function is somewhat larger than that calculated by the simpler boundingRect() function. This function uses the maximum left and right font bearings as is necessary for multi-line text to align correctly. Also, fontHeight() and lineSpacing() are used to calculate the height, rather than individual character heights. -.PP -The \fIintern\fR argument should not be used. -.PP -See also width(), QPainter::boundingRect(), and Qt::AlignmentFlags. -.SH "int QFontMetrics::charWidth ( const QString & str, int pos ) const" -Returns the width of the character at position \fIpos\fR in the string \fIstr\fR. -.PP -The whole string is needed, as the glyph drawn may change depending on the context (the letter before and after the current one) for some languages (e.g. Arabic). -.PP -This function also takes non spacing marks and ligatures into account. -.SH "int QFontMetrics::descent () const" -Returns the descent of the font. -.PP -The descent is the distance from the base line to the lowest point characters extend to. (Note that this is different from X, which adds 1 pixel.) In practice, some font designers break this rule, e.g. to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small. -.PP -See also ascent(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp and hello/hello.cpp. -.SH "int QFontMetrics::height () const" -Returns the height of the font. -.PP -This is always equal to ascent()+descent()+1 (the 1 is for the base line). -.PP -See also leading() and lineSpacing(). -.PP -Examples: -.)l grapher/grapher.cpp, hello/hello.cpp, and qfd/fontdisplayer.cpp. -.SH "bool QFontMetrics::inFont ( QChar ch ) const" -Returns TRUE if character \fIch\fR is a valid character in the font; otherwise returns FALSE. -.PP -Example: qfd/fontdisplayer.cpp. -.SH "int QFontMetrics::leading () const" -Returns the leading of the font. -.PP -This is the natural inter-line spacing. -.PP -See also height() and lineSpacing(). -.SH "int QFontMetrics::leftBearing ( QChar ch ) const" -Returns the left bearing of character \fIch\fR in the font. -.PP -The left bearing is the right-ward distance of the left-most pixel of the character from the logical origin of the character. This value is negative if the pixels of the character extend to the left of the logical origin. -.PP -See width(QChar) for a graphical description of this metric. -.PP -See also rightBearing(), minLeftBearing(), and width(). -.PP -Example: qfd/fontdisplayer.cpp. -.SH "int QFontMetrics::lineSpacing () const" -Returns the distance from one base line to the next. -.PP -This value is always equal to leading()+height(). -.PP -See also height() and leading(). -.PP -Examples: -.)l qfd/fontdisplayer.cpp, qwerty/qwerty.cpp, and scrollview/scrollview.cpp. -.SH "int QFontMetrics::lineWidth () const" -Returns the width of the underline and strikeout lines, adjusted for the point size of the font. -.PP -See also underlinePos(), overlinePos(), and strikeOutPos(). -.SH "int QFontMetrics::maxWidth () const" -Returns the width of the widest character in the font. -.PP -Example: qfd/fontdisplayer.cpp. -.SH "int QFontMetrics::minLeftBearing () const" -Returns the minimum left bearing of the font. -.PP -This is the smallest leftBearing(char) of all characters in the font. -.PP -Note that this function can be very slow if the font is large. -.PP -See also minRightBearing() and leftBearing(). -.PP -Example: qfd/fontdisplayer.cpp. -.SH "int QFontMetrics::minRightBearing () const" -Returns the minimum right bearing of the font. -.PP -This is the smallest rightBearing(char) of all characters in the font. -.PP -Note that this function can be very slow if the font is large. -.PP -See also minLeftBearing() and rightBearing(). -.PP -Example: qfd/fontdisplayer.cpp. -.SH "QFontMetrics & QFontMetrics::operator= ( const QFontMetrics & fm )" -Assigns the font metrics \fIfm\fR. -.SH "int QFontMetrics::overlinePos () const" -Returns the distance from the base line to where an overline should be drawn. -.PP -See also underlinePos(), strikeOutPos(), and lineWidth(). -.SH "int QFontMetrics::rightBearing ( QChar ch ) const" -Returns the right bearing of character \fIch\fR in the font. -.PP -The right bearing is the left-ward distance of the right-most pixel of the character from the logical origin of a subsequent character. This value is negative if the pixels of the character extend to the right of the width() of the character. -.PP -See width() for a graphical description of this metric. -.PP -See also leftBearing(), minRightBearing(), and width(). -.PP -Example: qfd/fontdisplayer.cpp. -.SH "QSize QFontMetrics::size ( int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" -Returns the size in pixels of the first \fIlen\fR characters of \fIstr\fR. -.PP -If \fIlen\fR is negative (the default), the entire string is used. -.PP -The \fIflgs\fR argument is the bitwise OR of the following flags: -.TP -\fCSingleLine\fR ignores newline characters. -.TP -\fCExpandTabs\fR expands tabs (see below) -.TP -\fCShowPrefix\fR interprets "&x" as "x", i.e. underlined. -.TP -\fCWordBreak\fR breaks the text to fit the rectangle. -.PP -These flags are defined in ntqnamespace.h. -.PP -If \fCExpandTabs\fR is set in \fIflgs\fR, then: if \fItabarray\fR is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs; otherwise if \fItabstops\fR is non-zero, it is used as the tab spacing (in pixels). -.PP -Newline characters are processed as linebreaks. -.PP -Despite the different actual character heights, the heights of the bounding rectangles of "Yes" and "yes" are the same. -.PP -The \fIintern\fR argument should not be used. -.PP -See also boundingRect(). -.SH "int QFontMetrics::strikeOutPos () const" -Returns the distance from the base line to where the strikeout line should be drawn. -.PP -See also underlinePos(), overlinePos(), and lineWidth(). -.SH "int QFontMetrics::underlinePos () const" -Returns the distance from the base line to where an underscore should be drawn. -.PP -See also overlinePos(), strikeOutPos(), and lineWidth(). -.SH "int QFontMetrics::width ( QChar ch ) const" -.ce 1 -.B "[Image Omitted]" -.PP -Returns the logical width of character \fIch\fR in pixels. This is a distance appropriate for drawing a subsequent character after \fIch\fR. -.PP -Some of the metrics are described in the image to the right. The central dark rectangles cover the logical width() of each character. The outer pale rectangles cover the leftBearing() and rightBearing() of each character. Notice that the bearings of "f" in this particular font are both negative, while the bearings of" o" are both positive. -.PP -\fBWarning:\fR This function will produce incorrect results for Arabic characters or non spacing marks in the middle of a string, as the glyph shaping and positioning of marks that happens when processing strings cannot be taken into account. Use charWidth() instead if you aren't looking for the width of isolated characters. -.PP -See also boundingRect() and charWidth(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp, hello/hello.cpp, movies/main.cpp, qfd/fontdisplayer.cpp, and scrollview/scrollview.cpp. -.SH "int QFontMetrics::width ( const QString & str, int len = -1 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the width of the first \fIlen\fR characters of string \fIstr\fR. -.SH "int QFontMetrics::width ( char c ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Provided to aid porting from Qt 1.x. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqfontmetrics.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qfontmetrics.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qframe.3qt b/doc/man/man3/qframe.3qt deleted file mode 100644 index 012e6a540..000000000 --- a/doc/man/man3/qframe.3qt +++ /dev/null @@ -1,405 +0,0 @@ -'\" t -.TH QFrame 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 -QFrame \- The base class of widgets that can have a frame -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -Inherited by QGroupBox, QScrollView, QDockWindow, QGrid, QHBox, QLabel, QLCDNumber, QLineEdit, QMenuBar, QPopupMenu, QProgressBar, QSplitter, QToolBox, and QWidgetStack. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFrame\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "int \fBframeStyle\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFrameStyle\fR ( int style )" -.br -.ti -1c -.BI "int \fBframeWidth\fR () const" -.br -.ti -1c -.BI "QRect \fBcontentsRect\fR () const" -.br -.ti -1c -.BI "enum \fBShape\fR { NoFrame = 0, Box = 0x0001, Panel = 0x0002, WinPanel = 0x0003, HLine = 0x0004, VLine = 0x0005, StyledPanel = 0x0006, PopupPanel = 0x0007, MenuBarPanel = 0x0008, ToolBarPanel = 0x0009, LineEditPanel = 0x000a, TabWidgetPanel = 0x000b, GroupBoxPanel = 0x000c, MShape = 0x000f }" -.br -.ti -1c -.BI "enum \fBShadow\fR { Plain = 0x0010, Raised = 0x0020, Sunken = 0x0030, MShadow = 0x00f0 }" -.br -.ti -1c -.BI "Shape \fBframeShape\fR () const" -.br -.ti -1c -.BI "void \fBsetFrameShape\fR ( Shape )" -.br -.ti -1c -.BI "Shadow \fBframeShadow\fR () const" -.br -.ti -1c -.BI "void \fBsetFrameShadow\fR ( Shadow )" -.br -.ti -1c -.BI "int \fBlineWidth\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetLineWidth\fR ( int )" -.br -.ti -1c -.BI "int \fBmargin\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMargin\fR ( int )" -.br -.ti -1c -.BI "int \fBmidLineWidth\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMidLineWidth\fR ( int )" -.br -.ti -1c -.BI "QRect \fBframeRect\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFrameRect\fR ( const QRect & )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QRect \fBcontentsRect\fR - the rectangle inside the frame \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QRect \fBframeRect\fR - the frame rectangle" -.br -.ti -1c -.BI "Shadow \fBframeShadow\fR - the frame shadow value from the frame style" -.br -.ti -1c -.BI "Shape \fBframeShape\fR - the frame shape value from the frame style" -.br -.ti -1c -.BI "int \fBframeWidth\fR - the width of the frame that is drawn \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBlineWidth\fR - the line width" -.br -.ti -1c -.BI "int \fBmargin\fR - the width of the margin" -.br -.ti -1c -.BI "int \fBmidLineWidth\fR - the width of the mid-line" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * event )" -.br -.ti -1c -.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * e )" -.br -.ti -1c -.BI "virtual void \fBdrawFrame\fR ( QPainter * p )" -.br -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * )" -.br -.ti -1c -.BI "virtual void \fBframeChanged\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QFrame class is the base class of widgets that can have a frame. -.PP -It draws a frame and calls a virtual function, drawContents(), to fill in the frame. This function is reimplemented by subclasses. There are also two other less useful functions: drawFrame() and frameChanged(). -.PP -QPopupMenu uses this to "raise" the menu above the surrounding screen. QProgressBar has a "sunken" look. QLabel has a flat look. The frames of widgets like these can be changed. -.PP -.nf -.br - QLabel label(...); -.br - label.setFrameStyle( QFrame::Panel | QFrame::Raised ); -.br - label.setLineWidth( 2 ); -.br -.br - QProgressBar pbar(...); -.br - label.setFrameStyle( QFrame::NoFrame ); -.br -.fi -.PP -The QFrame class can also be used directly for creating simple frames without any contents, although usually you would use a QHBox or QVBox because they automatically lay out the widgets you put inside the frame. -.PP -A frame widget has four attributes: frameStyle(), lineWidth(), midLineWidth(), and margin(). -.PP -The frame style is specified by a frame shape and a shadow style. The frame shapes are NoFrame, Box, Panel, StyledPanel, PopupPanel, WinPanel, ToolBarPanel, MenuBarPanel, HLine and VLine; the shadow styles are Plain, Raised and Sunken. -.PP -The line width is the width of the frame border. -.PP -The mid-line width specifies the width of an extra line in the middle of the frame, which uses a third color to obtain a special 3D effect. Notice that a mid-line is only drawn for Box, HLine and VLine frames that are raised or sunken. -.PP -The margin is the gap between the frame and the contents of the frame. -.PP -This table shows the most useful combinations of styles and widths (and some rather useless ones): -.PP -
                              -.ce 1 -.B "[Image Omitted]" -.PP -
                              -.PP -See also Abstract Widget Classes. -.SS "Member Type Documentation" -.SH "QFrame::Shadow" -This enum type defines the 3D effect used for QFrame's frame. -.TP -\fCQFrame::Plain\fR - the frame and contents appear level with the surroundings; draws using the palette foreground color (without any 3D effect) -.TP -\fCQFrame::Raised\fR - the frame and contents appear raised; draws a 3D raised line using the light and dark colors of the current color group -.TP -\fCQFrame::Sunken\fR - the frame and contents appear sunken; draws a 3D sunken line using the light and dark colors of the current color group -.TP -\fCQFrame::MShadow\fR - internal; mask for the shadow -.PP -Shadow interacts with QFrame::Shape, the lineWidth() and the midLineWidth(). See the picture of the frames in the class description. -.PP -See also QFrame::Shape, lineWidth, and midLineWidth. -.SH "QFrame::Shape" -This enum type defines the shapes of a QFrame's frame. -.TP -\fCQFrame::NoFrame\fR - QFrame draws nothing -.TP -\fCQFrame::Box\fR - QFrame draws a box around its contents -.TP -\fCQFrame::Panel\fR - QFrame draws a panel to make the contents appear raised or sunken -.TP -\fCQFrame::StyledPanel\fR - draws a rectangular panel with a look that depends on the current GUI style. It can be raised or sunken. -.TP -\fCQFrame::HLine\fR - QFrame draws a horizontal line that frames nothing (useful as separator) -.TP -\fCQFrame::VLine\fR - QFrame draws a vertical line that frames nothing (useful as separator) -.TP -\fCQFrame::GroupBoxPanel\fR - draws a rectangular panel -.TP -\fCQFrame::WinPanel\fR - draws a rectangular panel that can be raised or sunken like those in Windows 95. Specifying this shape sets the line width to 2 pixels. WinPanel is provided for compatibility. For GUI style independence we recommend using StyledPanel instead. -.TP -\fCQFrame::ToolBarPanel\fR -.TP -\fCQFrame::MenuBarPanel\fR -.TP -\fCQFrame::PopupPanel\fR -.TP -\fCQFrame::LineEditPanel\fR - is used to draw a frame suitable for line edits. The look depends upon the current GUI style. -.TP -\fCQFrame::TabWidgetPanel\fR - is used to draw a frame suitable for tab widgets. The look depends upon the current GUI style. -.TP -\fCQFrame::MShape\fR - internal mask -.PP -When it does not call QStyle, Shape interacts with QFrame::Shadow, the lineWidth() and the midLineWidth() to create the total result. See the picture of the frames in the class description. -.PP -See also QFrame::Shadow, QFrame::style(), and QStyle::drawPrimitive(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFrame::QFrame ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a frame widget with frame style NoFrame and a 1-pixel frame width. -.PP -The \fIparent\fR, \fIname\fR and \fIf\fR arguments are passed to the QWidget constructor. -.SH "QRect QFrame::contentsRect () const" -Returns the rectangle inside the frame. See the "contentsRect" property for details. -.SH "void QFrame::drawContents ( QPainter * )\fC [virtual protected]\fR" -Virtual function that draws the contents of the frame. -.PP -The QPainter is already open when you get it, and you must leave it open. Painter transformations are switched off on entry. If you transform the painter, remember to take the frame into account and reset transformation before returning. -.PP -This function is reimplemented by subclasses that draw something inside the frame. It should only draw inside contentsRect(). The default function does nothing. -.PP -See also contentsRect and QPainter::setClipRect(). -.PP -Reimplemented in QLabel, QLCDNumber, QMenuBar, and QPopupMenu. -.SH "void QFrame::drawFrame ( QPainter * p )\fC [virtual protected]\fR" -Draws the frame using the painter \fIp\fR and the current frame attributes and color group. The rectangle inside the frame is not affected. -.PP -This function is virtual, but in general you do not need to reimplement it. If you do, note that the QPainter is already open and must remain open. -.PP -See also frameRect, contentsRect, drawContents(), frameStyle(), and palette. -.SH "void QFrame::frameChanged ()\fC [virtual protected]\fR" -Virtual function that is called when the frame style, line width or mid-line width changes. -.PP -This function can be reimplemented by subclasses that need to know when the frame attributes change. -.PP -The default implementation calls update(). -.SH "QRect QFrame::frameRect () const" -Returns the frame rectangle. See the "frameRect" property for details. -.SH "Shadow QFrame::frameShadow () const" -Returns the frame shadow value from the frame style. See the "frameShadow" property for details. -.SH "Shape QFrame::frameShape () const" -Returns the frame shape value from the frame style. See the "frameShape" property for details. -.SH "int QFrame::frameStyle () const" -Returns the frame style. -.PP -The default value is QFrame::NoFrame. -.PP -See also setFrameStyle(), frameShape, and frameShadow. -.PP -Example: scrollview/scrollview.cpp. -.SH "int QFrame::frameWidth () const" -Returns the width of the frame that is drawn. See the "frameWidth" property for details. -.SH "int QFrame::lineWidth () const" -Returns the line width. See the "lineWidth" property for details. -.SH "int QFrame::margin () const" -Returns the width of the margin. See the "margin" property for details. -.SH "int QFrame::midLineWidth () const" -Returns the width of the mid-line. See the "midLineWidth" property for details. -.SH "void QFrame::paintEvent ( QPaintEvent * event )\fC [virtual protected]\fR" -Processes the paint event \fIevent\fR. -.PP -Paints the frame and the contents. -.PP -Opens the painter on the frame and calls drawFrame(), then drawContents(). -.PP -Examples: -.)l life/life.cpp and qfd/fontdisplayer.cpp. -.PP -Reimplemented from QWidget. -.SH "void QFrame::resizeEvent ( QResizeEvent * e )\fC [virtual protected]\fR" -Processes the resize event \fIe\fR. -.PP -Adjusts the frame rectangle for the resized widget. The frame rectangle is elastic, and the surrounding area is static. -.PP -The resulting frame rectangle may be null or invalid. You can use setMinimumSize() to avoid those possibilities. -.PP -Nothing is done if the frame rectangle is a null rectangle already. -.PP -Example: life/life.cpp. -.PP -Reimplemented from QWidget. -.SH "void QFrame::setFrameRect ( const QRect & )\fC [virtual]\fR" -Sets the frame rectangle. See the "frameRect" property for details. -.SH "void QFrame::setFrameShadow ( Shadow )" -Sets the frame shadow value from the frame style. See the "frameShadow" property for details. -.SH "void QFrame::setFrameShape ( Shape )" -Sets the frame shape value from the frame style. See the "frameShape" property for details. -.SH "void QFrame::setFrameStyle ( int style )\fC [virtual]\fR" -Sets the frame style to \fIstyle\fR. -.PP -The \fIstyle\fR is the bitwise OR between a frame shape and a frame shadow style. See the illustration in the class documentation. -.PP -The frame shapes are given in QFrame::Shape and the shadow styles in QFrame::Shadow. -.PP -If a mid-line width greater than 0 is specified, an additional line is drawn for Raised or Sunken Box, HLine, and VLine frames. The mid-color of the current color group is used for drawing middle lines. -.PP -See also Illustration, frameStyle(), colorGroup, and QColorGroup. -.PP -Examples: -.)l cursor/cursor.cpp, layout/layout.cpp, listboxcombo/listboxcombo.cpp, rangecontrols/rangecontrols.cpp, scrollview/scrollview.cpp, tabdialog/tabdialog.cpp, and tictac/tictac.cpp. -.SH "void QFrame::setLineWidth ( int )\fC [virtual]\fR" -Sets the line width. See the "lineWidth" property for details. -.SH "void QFrame::setMargin ( int )\fC [virtual]\fR" -Sets the width of the margin. See the "margin" property for details. -.SH "void QFrame::setMidLineWidth ( int )\fC [virtual]\fR" -Sets the width of the mid-line. See the "midLineWidth" property for details. -.SS "Property Documentation" -.SH "QRect contentsRect" -This property holds the rectangle inside the frame. -.PP -Get this property's value with contentsRect(). -.PP -See also frameRect and drawContents(). -.SH "QRect frameRect" -This property holds the frame rectangle. -.PP -The frame rectangle is the rectangle the frame is drawn in. By default, this is the entire widget. Setting this property does \fInot\fR cause a widget update. -.PP -If this property is set to a null rectangle (for example \fCQRect(0, 0, 0, 0)\fR), then the frame rectangle is equivalent to the widget rectangle. -.PP -See also contentsRect. -.PP -Set this property's value with setFrameRect() and get this property's value with frameRect(). -.SH "Shadow frameShadow" -This property holds the frame shadow value from the frame style. -.PP -Set this property's value with setFrameShadow() and get this property's value with frameShadow(). -.PP -See also frameStyle() and frameShape. -.SH "Shape frameShape" -This property holds the frame shape value from the frame style. -.PP -Set this property's value with setFrameShape() and get this property's value with frameShape(). -.PP -See also frameStyle() and frameShadow. -.SH "int frameWidth" -This property holds the width of the frame that is drawn. -.PP -Note that the frame width depends on the frame style, not only the line width and the mid-line width. For example, the style NoFrame always has a frame width of 0, whereas the style Panel has a frame width equivalent to the line width. The frame width also includes the margin. -.PP -See also lineWidth, midLineWidth, frameStyle(), and margin. -.PP -Get this property's value with frameWidth(). -.SH "int lineWidth" -This property holds the line width. -.PP -Note that the \fItotal\fR line width for HLine and VLine is given by frameWidth(), not lineWidth(). -.PP -The default value is 1. -.PP -See also midLineWidth and frameWidth. -.PP -Set this property's value with setLineWidth() and get this property's value with lineWidth(). -.SH "int margin" -This property holds the width of the margin. -.PP -The margin is the distance between the innermost pixel of the frame and the outermost pixel of contentsRect(). It is included in frameWidth(). -.PP -The margin is filled according to backgroundMode(). -.PP -The default value is 0. -.PP -See also margin, lineWidth, and frameWidth. -.PP -Set this property's value with setMargin() and get this property's value with margin(). -.SH "int midLineWidth" -This property holds the width of the mid-line. -.PP -The default value is 0. -.PP -See also lineWidth and frameWidth. -.PP -Set this property's value with setMidLineWidth() and get this property's value with midLineWidth(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqframe.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qframe.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qftp.3qt b/doc/man/man3/qftp.3qt deleted file mode 100644 index 94e822485..000000000 --- a/doc/man/man3/qftp.3qt +++ /dev/null @@ -1,649 +0,0 @@ -'\" t -.TH QFtp 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 -QFtp \- Implementation of the FTP protocol -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QNetworkProtocol. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQFtp\fR ()" -.br -.ti -1c -.BI "\fBQFtp\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QFtp\fR ()" -.br -.ti -1c -.BI "enum \fBState\fR { Unconnected, HostLookup, Connecting, Connected, LoggedIn, Closing }" -.br -.ti -1c -.BI "enum \fBError\fR { NoError, UnknownError, HostNotFound, ConnectionRefused, NotConnected }" -.br -.ti -1c -.BI "enum \fBCommand\fR { None, ConnectToHost, Login, Close, List, Cd, Get, Put, Remove, Mkdir, Rmdir, Rename, RawCommand }" -.br -.ti -1c -.BI "int \fBconnectToHost\fR ( const QString & host, TQ_UINT16 port = 21 )" -.br -.ti -1c -.BI "int \fBlogin\fR ( const QString & user = QString::null, const QString & password = QString::null )" -.br -.ti -1c -.BI "int \fBclose\fR ()" -.br -.ti -1c -.BI "int \fBlist\fR ( const QString & dir = QString::null )" -.br -.ti -1c -.BI "int \fBcd\fR ( const QString & dir )" -.br -.ti -1c -.BI "int \fBget\fR ( const QString & file, QIODevice * dev = 0 )" -.br -.ti -1c -.BI "int \fBput\fR ( const QByteArray & data, const QString & file )" -.br -.ti -1c -.BI "int \fBput\fR ( QIODevice * dev, const QString & file )" -.br -.ti -1c -.BI "int \fBremove\fR ( const QString & file )" -.br -.ti -1c -.BI "int \fBmkdir\fR ( const QString & dir )" -.br -.ti -1c -.BI "int \fBrmdir\fR ( const QString & dir )" -.br -.ti -1c -.BI "int \fBrename\fR ( const QString & oldname, const QString & newname )" -.br -.ti -1c -.BI "int \fBrawCommand\fR ( const QString & command )" -.br -.ti -1c -.BI "TQ_ULONG \fBbytesAvailable\fR () const" -.br -.ti -1c -.BI "TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" -.br -.ti -1c -.BI "QByteArray \fBreadAll\fR ()" -.br -.ti -1c -.BI "int \fBcurrentId\fR () const" -.br -.ti -1c -.BI "QIODevice * \fBcurrentDevice\fR () const" -.br -.ti -1c -.BI "Command \fBcurrentCommand\fR () const" -.br -.ti -1c -.BI "bool \fBhasPendingCommands\fR () const" -.br -.ti -1c -.BI "void \fBclearPendingCommands\fR ()" -.br -.ti -1c -.BI "State \fBstate\fR () const" -.br -.ti -1c -.BI "Error \fBerror\fR () const" -.br -.ti -1c -.BI "QString \fBerrorString\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBabort\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.ti -1c -.BI "void \fBlistInfo\fR ( const QUrlInfo & i )" -.br -.ti -1c -.BI "void \fBreadyRead\fR ()" -.br -.ti -1c -.BI "void \fBdataTransferProgress\fR ( int done, int total )" -.br -.ti -1c -.BI "void \fBrawCommandReply\fR ( int replyCode, const QString & detail )" -.br -.ti -1c -.BI "void \fBcommandStarted\fR ( int id )" -.br -.ti -1c -.BI "void \fBcommandFinished\fR ( int id, bool error )" -.br -.ti -1c -.BI "void \fBdone\fR ( bool error )" -.br -.in -1c -.SH DESCRIPTION -The QFtp class provides an implementation of the FTP protocol. -.PP -This class provides two different interfaces: one is the QNetworkProtocol interface that allows you to use FTP through the QUrlOperator abstraction. The other is a direct interface to FTP that gives you lower-level access to the FTP protocol for finer control. Using the direct interface you can also execute arbitrary FTP commands. -.PP -Don't mix the two interfaces, since the behavior is not well-defined. -.PP -If you want to use QFtp with the QNetworkProtocol interface, you do not use it directly, but rather through a QUrlOperator, for example: -.PP -.nf -.br - QUrlOperator op( "ftp://ftp.trolltech.com" ); -.br - op.listChildren(); // Asks the server to provide a directory listing -.br -.fi -.PP -This code will only work if the QFtp class is registered; to register the class, you must call tqInitNetworkProtocols() before using a QUrlOperator with QFtp. -.PP -The rest of this descrption describes the direct interface to FTP. -.PP -The class works asynchronously, so there are no blocking functions. If an operation cannot be executed immediately, the function will still return straight away and the operation will be scheduled for later execution. The results of scheduled operations are reported via signals. This approach depends on the event loop being in operation. -.PP -The operations that can be scheduled (they are called "commands" in the rest of the documentation) are the following: connectToHost(), login(), close(), list(), cd(), get(), put(), remove(), mkdir(), rmdir(), rename() and rawCommand(). -.PP -All of these commands return a unique identifier that allows you to keep track of the command that is currently being executed. When the execution of a command starts, the commandStarted() signal with the command's identifier is emitted. When the command is finished, the commandFinished() signal is emitted with the command's identifier and a bool that indicates whether the command finished with an error. -.PP -In some cases, you might want to execute a sequence of commands, e.g. if you want to connect and login to a FTP server. This is simply achieved: -.PP -.nf -.br - QFtp *ftp = new QFtp( this ); // this is an optional QObject parent -.br - ftp->connectToHost( "ftp.trolltech.com" ); -.br - ftp->login(); -.br -.fi -.PP -In this case two FTP commands have been scheduled. When the last scheduled command has finished, a done() signal is emitted with a bool argument that tells you whether the sequence finished with an error. -.PP -If an error occurs during the execution of one of the commands in a sequence of commands, all the pending commands (i.e. scheduled, but not yet executed commands) are cleared and no signals are emitted for them. -.PP -Some commands, e.g. list(), emit additional signals to report their results. -.PP -Example: If you want to download the INSTALL file from Trolltech's FTP server, you would write this: -.PP -.nf -.br - ftp->connectToHost( "ftp.trolltech.com" ); // id == 1 -.br - ftp->login(); // id == 2 -.br - ftp->cd( "qt" ); // id == 3 -.br - ftp->get( "INSTALL" ); // id == 4 -.br - ftp->close(); // id == 5 -.br -.fi -.PP -For this example the following sequence of signals is emitted (with small variations, depending on network traffic, etc.): -.PP -.nf -.br - start( 1 ) -.br - stateChanged( HostLookup ) -.br - stateChanged( Connecting ) -.br - stateChanged( Connected ) -.br - finished( 1, FALSE ) -.br -.br - start( 2 ) -.br - stateChanged( LoggedIn ) -.br - finished( 2, FALSE ) -.br -.br - start( 3 ) -.br - finished( 3, FALSE ) -.br -.br - start( 4 ) -.br - dataTransferProgress( 0, 3798 ) -.br - dataTransferProgress( 2896, 3798 ) -.br - readyRead() -.br - dataTransferProgress( 3798, 3798 ) -.br - readyRead() -.br - finished( 4, FALSE ) -.br -.br - start( 5 ) -.br - stateChanged( Closing ) -.br - stateChanged( Unconnected ) -.br - finished( 5, FALSE ) -.br -.br - done( FALSE ) -.br -.fi -.PP -The dataTransferProgress() signal in the above example is useful if you want to show a progressbar to inform the user about the progress of the download. The readyRead() signal tells you that there is data ready to be read. The amount of data can be queried then with the bytesAvailable() function and it can be read with the readBlock() or readAll() function. -.PP -If the login fails for the above example, the signals would look like this: -.PP -.nf -.br - start( 1 ) -.br - stateChanged( HostLookup ) -.br - stateChanged( Connecting ) -.br - stateChanged( Connected ) -.br - finished( 1, FALSE ) -.br -.br - start( 2 ) -.br - finished( 2, TRUE ) -.br -.br - done( TRUE ) -.br -.fi -.PP -You can then get details about the error with the error() and errorString() functions. -.PP -The functions currentId() and currentCommand() provide more information about the currently executing command. -.PP -The functions hasPendingCommands() and clearPendingCommands() allow you to query and clear the list of pending commands. -.PP -The safest and easiest way to use the FTP protocol is to use QUrlOperator() or the FTP commands described above. If you are an experienced network programmer and want to have complete control you can use rawCommand() to execute arbitrary FTP commands. -.PP -See also Qt Network Documentation, QNetworkProtocol, QUrlOperator, QHttp, and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QFtp::Command" -This enum is used as the return value for the currentCommand() function. This allows you to perform specific actions for particular commands, e.g. in a FTP client, you might want to clear the directory view when a list() command is started; in this case you can simply check in the slot connected to the start() signal if the currentCommand() is List. -.TP -\fCQFtp::None\fR - No command is being executed. -.TP -\fCQFtp::ConnectToHost\fR - connectToHost() is being executed. -.TP -\fCQFtp::Login\fR - login() is being executed. -.TP -\fCQFtp::Close\fR - close() is being executed. -.TP -\fCQFtp::List\fR - list() is being executed. -.TP -\fCQFtp::Cd\fR - cd() is being executed. -.TP -\fCQFtp::Get\fR - get() is being executed. -.TP -\fCQFtp::Put\fR - put() is being executed. -.TP -\fCQFtp::Remove\fR - remove() is being executed. -.TP -\fCQFtp::Mkdir\fR - mkdir() is being executed. -.TP -\fCQFtp::Rmdir\fR - rmdir() is being executed. -.TP -\fCQFtp::Rename\fR - rename() is being executed. -.TP -\fCQFtp::RawCommand\fR - rawCommand() is being executed. -.PP -See also currentCommand(). -.SH "QFtp::Error" -This enum identifies the error that occurred. -.TP -\fCQFtp::NoError\fR - No error occurred. -.TP -\fCQFtp::HostNotFound\fR - The host name lookup failed. -.TP -\fCQFtp::ConnectionRefused\fR - The server refused the connection. -.TP -\fCQFtp::NotConnected\fR - Tried to send a command, but there is no connection to a server. -.TP -\fCQFtp::UnknownError\fR - An error other than those specified above occurred. -.PP -See also error(). -.SH "QFtp::State" -This enum defines the connection state: -.TP -\fCQFtp::Unconnected\fR - There is no connection to the host. -.TP -\fCQFtp::HostLookup\fR - A host name lookup is in progress. -.TP -\fCQFtp::Connecting\fR - An attempt to connect to the host is in progress. -.TP -\fCQFtp::Connected\fR - Connection to the host has been achieved. -.TP -\fCQFtp::LoggedIn\fR - Connection and user login have been achieved. -.TP -\fCQFtp::Closing\fR - The connection is closing down, but it is not yet closed. (The state will be Unconnected when the connection is closed.) -.PP -See also stateChanged() and state(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QFtp::QFtp ()" -Constructs a QFtp object. -.SH "QFtp::QFtp ( QObject * parent, const char * name = 0 )" -Constructs a QFtp object. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. -.SH "QFtp::~QFtp ()\fC [virtual]\fR" -Destructor. -.SH "void QFtp::abort ()\fC [slot]\fR" -Aborts the current command and deletes all scheduled commands. -.PP -If there is an unfinished command (i.e. a command for which the commandStarted() signal has been emitted, but for which the commandFinished() signal has not been emitted), this function sends an \fCABORT\fR command to the server. When the server replies that the command is aborted, the commandFinished() signal with the \fCerror\fR argument set to \fCTRUE\fR is emitted for the command. Due to timing issues, it is possible that the command had already finished before the abort request reached the server, in which case, the commandFinished() signal is emitted with the \fCerror\fR argument set to \fCFALSE\fR. -.PP -For all other commands that are affected by the abort(), no signals are emitted. -.PP -If you don't start further FTP commands directly after the abort(), there won't be any scheduled commands and the done() signal is emitted. -.PP -\fBWarning:\fR Some FTP servers, for example the BSD FTP daemon (version 0.3), wrongly return a positive reply even when an abort has occurred. For these servers the commandFinished() signal has its error flag set to \fCFALSE\fR, even though the command did not complete successfully. -.PP -See also clearPendingCommands(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "TQ_ULONG QFtp::bytesAvailable () const" -Returns the number of bytes that can be read from the data socket at the moment. -.PP -See also get(), readyRead(), readBlock(), and readAll(). -.SH "int QFtp::cd ( const QString & dir )" -Changes the working directory of the server to \fIdir\fR. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also commandStarted() and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QFtp::clearPendingCommands ()" -Deletes all pending commands from the list of scheduled commands. This does not affect the command that is being executed. If you want to stop this this as well, use abort(). -.PP -See also hasPendingCommands() and abort(). -.SH "int QFtp::close ()" -Closes the connection to the FTP server. -.PP -The stateChanged() signal is emitted when the state of the connecting process changes, e.g. to Closing, then Unconnected. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also stateChanged(), commandStarted(), and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QFtp::commandFinished ( int id, bool error )\fC [signal]\fR" -This signal is emitted when processing the command identified by \fIid\fR has finished. \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. -.PP -See also commandStarted(), done(), error(), and errorString(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QFtp::commandStarted ( int id )\fC [signal]\fR" -This signal is emitted when processing the command identified by \fIid\fR starts. -.PP -See also commandFinished() and done(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "int QFtp::connectToHost ( const QString & host, TQ_UINT16 port = 21 )" -Connects to the FTP server \fIhost\fR using port \fIport\fR. -.PP -The stateChanged() signal is emitted when the state of the connecting process changes, e.g. to HostLookup, then Connecting, then Connected. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also stateChanged(), commandStarted(), and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "Command QFtp::currentCommand () const" -Returns the command type of the FTP command being executed or None if there is no command being executed. -.PP -See also currentId(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "QIODevice * QFtp::currentDevice () const" -Returns the QIODevice pointer that is used by the FTP command to read data from or store data to. If there is no current FTP command being executed or if the command does not use an IO device, this function returns 0. -.PP -This function can be used to delete the QIODevice in the slot connected to the commandFinished() signal. -.PP -See also get() and put(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "int QFtp::currentId () const" -Returns the identifier of the FTP command that is being executed or 0 if there is no command being executed. -.PP -See also currentCommand(). -.SH "void QFtp::dataTransferProgress ( int done, int total )\fC [signal]\fR" -This signal is emitted in response to a get() or put() request to indicate the current progress of the download or upload. -.PP -\fIdone\fR is the amount of data that has already been transferred and \fItotal\fR is the total amount of data to be read or written. It is possible that the QFtp class is not able to determine the total amount of data that should be transferred, in which case \fItotal\fR is 0. (If you connect this signal to a QProgressBar, the progress bar shows a busy indicator if the total is 0). -.PP -\fBWarning:\fR \fIdone\fR and \fItotal\fR are not necessarily the size in bytes, since for large files these values might need to be" scaled" to avoid overflow. -.PP -See also get(), put(), and QProgressBar::progress. -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QFtp::done ( bool error )\fC [signal]\fR" -This signal is emitted when the last pending command has finished; (it is emitted after the last command's commandFinished() signal). \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. -.PP -See also commandFinished(), error(), and errorString(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "Error QFtp::error () const" -Returns the last error that occurred. This is useful to find out what when wrong when receiving a commandFinished() or a done() signal with the \fCerror\fR argument set to \fCTRUE\fR. -.PP -If you start a new command, the error status is reset to NoError. -.SH "QString QFtp::errorString () const" -Returns a human-readable description of the last error that occurred. This is useful for presenting a error message to the user when receiving a commandFinished() or a done() signal with the \fCerror\fR argument set to \fCTRUE\fR. -.PP -The error string is often (but not always) the reply from the server, so it is not always possible to translate the string. If the message comes from Qt, the string has already passed through tr(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "int QFtp::get ( const QString & file, QIODevice * dev = 0 )" -Downloads the file \fIfile\fR from the server. -.PP -If \fIdev\fR is 0, then the readyRead() signal is emitted when there is data available to read. You can then read the data with the readBlock() or readAll() functions. -.PP -If \fIdev\fR is not 0, the data is written directly to the device \fIdev\fR. Make sure that the \fIdev\fR pointer is valid for the duration of the operation (it is safe to delete it when the commandFinished() signal is emitted). In this case the readyRead() signal is \fInot\fR emitted and you cannot read data with the readBlock() or readAll() functions. -.PP -If you don't read the data immediately it becomes available, i.e. when the readyRead() signal is emitted, it is still available until the next command is started. -.PP -For example, if you want to present the data to the user as soon as there is something available, connect to the readyRead() signal and read the data immediately. On the other hand, if you only want to work with the complete data, you can connect to the commandFinished() signal and read the data when the get() command is finished. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also readyRead(), dataTransferProgress(), commandStarted(), and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "bool QFtp::hasPendingCommands () const" -Returns TRUE if there are any commands scheduled that have not yet been executed; otherwise returns FALSE. -.PP -The command that is being executed is \fInot\fR considered as a scheduled command. -.PP -See also clearPendingCommands(), currentId(), and currentCommand(). -.SH "int QFtp::list ( const QString & dir = QString::null )" -Lists the contents of directory \fIdir\fR on the FTP server. If \fIdir\fR is empty, it lists the contents of the current directory. -.PP -The listInfo() signal is emitted for each directory entry found. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also listInfo(), commandStarted(), and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QFtp::listInfo ( const QUrlInfo & i )\fC [signal]\fR" -This signal is emitted for each directory entry the list() command finds. The details of the entry are stored in \fIi\fR. -.PP -See also list(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "int QFtp::login ( const QString & user = QString::null, const QString & password = QString::null )" -Logs in to the FTP server with the username \fIuser\fR and the password \fIpassword\fR. -.PP -The stateChanged() signal is emitted when the state of the connecting process changes, e.g. to LoggedIn. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also commandStarted() and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "int QFtp::mkdir ( const QString & dir )" -Creates a directory called \fIdir\fR on the server. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also commandStarted() and commandFinished(). -.SH "int QFtp::put ( QIODevice * dev, const QString & file )" -Reads the data from the IO device \fIdev\fR, and writes it to the file called \fIfile\fR on the server. The data is read in chunks from the IO device, so this overload allows you to transmit large amounts of data without the need to read all the data into memory at once. -.PP -Make sure that the \fIdev\fR pointer is valid for the duration of the operation (it is safe to delete it when the commandFinished() is emitted). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "int QFtp::put ( const QByteArray & data, const QString & file )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes the data \fIdata\fR to the file called \fIfile\fR on the server. The progress of the upload is reported by the dataTransferProgress() signal. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also dataTransferProgress(), commandStarted(), and commandFinished(). -.SH "int QFtp::rawCommand ( const QString & command )" -Sends the raw FTP command \fIcommand\fR to the FTP server. This is useful for low-level FTP access. If the operation you wish to perform has an equivalent QFtp function, we recommend using the function instead of raw FTP commands since the functions are easier and safer. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also rawCommandReply(), commandStarted(), and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QFtp::rawCommandReply ( int replyCode, const QString & detail )\fC [signal]\fR" -This signal is emitted in response to the rawCommand() function. \fIreplyCode\fR is the 3 digit reply code and \fIdetail\fR is the text that follows the reply code. -.PP -See also rawCommand(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "QByteArray QFtp::readAll ()" -Reads all the bytes available from the data socket and returns them. -.PP -See also get(), readyRead(), bytesAvailable(), and readBlock(). -.SH "TQ_LONG QFtp::readBlock ( char * data, TQ_ULONG maxlen )" -Reads \fImaxlen\fR bytes from the data socket into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. -.PP -See also get(), readyRead(), bytesAvailable(), and readAll(). -.SH "void QFtp::readyRead ()\fC [signal]\fR" -This signal is emitted in response to a get() command when there is new data to read. -.PP -If you specify a device as the second argument in the get() command, this signal is \fInot\fR emitted; instead the data is written directly to the device. -.PP -You can read the data with the readAll() or readBlock() functions. -.PP -This signal is useful if you want to process the data in chunks as soon as it becomes available. If you are only interested in the complete data, just connect to the commandFinished() signal and read the data then instead. -.PP -See also get(), readBlock(), readAll(), and bytesAvailable(). -.SH "int QFtp::remove ( const QString & file )" -Deletes the file called \fIfile\fR from the server. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also commandStarted() and commandFinished(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "int QFtp::rename ( const QString & oldname, const QString & newname )" -Renames the file called \fIoldname\fR to \fInewname\fR on the server. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also commandStarted() and commandFinished(). -.SH "int QFtp::rmdir ( const QString & dir )" -Removes the directory called \fIdir\fR from the server. -.PP -The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). -.PP -When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. -.PP -See also commandStarted() and commandFinished(). -.SH "State QFtp::state () const" -Returns the current state of the object. When the state changes, the stateChanged() signal is emitted. -.PP -See also State and stateChanged(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QFtp::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted when the state of the connection changes. The argument \fIstate\fR is the new state of the connection; it is one of the State values. -.PP -It is usually emitted in response to a connectToHost() or close() command, but it can also be emitted "spontaneously", e.g. when the server closes the connection unexpectedly. -.PP -See also connectToHost(), close(), state(), and State. -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqftp.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qftp.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgb18030codec.3qt b/doc/man/man3/qgb18030codec.3qt deleted file mode 100644 index cace1b372..000000000 --- a/doc/man/man3/qgb18030codec.3qt +++ /dev/null @@ -1,80 +0,0 @@ -'\" t -.TH QGb18030Codec 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 -QGb18030Codec \- Conversion to and from the Chinese GB18030/GBK/GB2312 encoding -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                              -.PP -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -Inherited by QGbkCodec and QGb2312Codec. -.PP -.SH DESCRIPTION -The QGb18030Codec class provides conversion to and from the Chinese GB18030/GBK/GB2312 encoding. -.PP -GBK, formally the Chinese Internal Code Specification, is a commonly used extension of GB 2312-80. Microsoft Windows uses it under the name codepage 936. -.PP -GBK has been superceded by the new Chinese national standard GB 18030-2000, which added a 4-byte encoding while remaining compatible with GB2312 and GBK. The new GB 18030-2000 may be described as a special encoding of Unicode 3.x and ISO-10646-1. -.PP -Special thanks to charset gurus Markus Scherer (IBM), Dirk Meyer (Adobe Systems) and Ken Lunde (Adobe Systems) for publishing an excellent GB 18030-2000 summary and specification on the Internet. Some must-read documents are: -.TP -ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/pdf/GB18030_Summary.pdf -.TP -http://oss.software.ibm.com/cvs/icu/~checkout~/charset/source/gb18030/gb18030.html -.TP -http://oss.software.ibm.com/cvs/icu/~checkout~/charset/data/xml/gb-18030-2000.xml -.PP -The GBK codec was contributed to Qt by Justin Yu and Sean Chen . They may also be reached at Yu Mingjian , Chen Xiangyang -.PP -The GB18030 codec Qt functions were contributed to Qt by James Su , who pioneered much of GB18030 development on GNU/Linux systems. -.PP -The GB18030 codec was contributed to Qt by Anthony Fok , using a Perl script to generate C++ tables from gb-18030-2000.xml while merging contributions from James Su, Justin Yu and Sean Chen. A copy of the source Perl script is available at: -.PP -http://people.debian.org/~foka/gb18030/gen-qgb18030codec.pl -.PP -The copyright notice for their code follows: -.PP -Copyright (C) 2000 TurboLinux, Inc. Written by Justin Yu and Sean Chen. Copyright (C) 2001, 2002 Turbolinux, Inc. Written by James Su. Copyright (C) 2001, 2002 ThizLinux Laboratory Ltd. Written by Anthony Fok. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
                                -.TP -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.TP -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.PP -See also Internationalization with Qt. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqgb18030codec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgb18030codec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgb2312codec.3qt b/doc/man/man3/qgb2312codec.3qt deleted file mode 100644 index 0913389d1..000000000 --- a/doc/man/man3/qgb2312codec.3qt +++ /dev/null @@ -1,48 +0,0 @@ -'\" t -.TH QGb2312Codec 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 -QGb2312Codec \- Conversion to and from the Chinese GB2312 encoding -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QGb18030Codec. -.PP -.SH DESCRIPTION -The QGb2312Codec class provides conversion to and from the Chinese GB2312 encoding. -.PP -The GB2312 encoding has been superceded by the GB18030 encoding and GB18030 is backward compatible to GB2312. For this reason the QGb2312Codec class is implemented in terms of the GB18030 codec and uses its 0xA1A1-0xFEFE subset for conversion from and to Unicode. -.PP -The QGb2312Codec is kept mainly for compatibility reasons with older software. -.PP -See also Internationalization with Qt. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qgb2312codec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgb2312codec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgbkcodec.3qt b/doc/man/man3/qgbkcodec.3qt deleted file mode 100644 index 68dcde62d..000000000 --- a/doc/man/man3/qgbkcodec.3qt +++ /dev/null @@ -1,52 +0,0 @@ -'\" t -.TH QGbkCodec 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 -QGbkCodec \- Conversion to and from the Chinese GBK encoding -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                -.PP -\fC#include \fR -.PP -Inherits QGb18030Codec. -.PP -.SH DESCRIPTION -The QGbkCodec class provides conversion to and from the Chinese GBK encoding. -.PP -GBK, formally the Chinese Internal Code Specification, is a commonly used extension of GB 2312-80. Microsoft Windows uses it under the name code page 936. -.PP -The GBK encoding has been superceded by the GB18030 encoding and GB18030 is backward compatible to GBK. For this reason the QGbkCodec class is implemented in terms of the GB18030 codec and uses its 1-byte and 2-byte portion for conversion from and to Unicode. -.PP -The QGbkCodec is kept mainly for compatibility reasons with older software. -.PP -See also Internationalization with Qt. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqgbkcodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgbkcodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgfxdriverfactory.3qt b/doc/man/man3/qgfxdriverfactory.3qt deleted file mode 100644 index 4d454dede..000000000 --- a/doc/man/man3/qgfxdriverfactory.3qt +++ /dev/null @@ -1,59 +0,0 @@ -'\" t -.TH QGfxDriverFactory 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 -QGfxDriverFactory \- Creates QScreen objects for Qt/Embedded -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Static Public Members" -
                              1. QStringList \fBkeys\fR ()
                              2. QScreen * \fBcreate\fR ( const QString & key, int displayId ) -.SH DESCRIPTION -The QGfxDriverFactory class creates QScreen objects for Qt/Embedded. -.PP -The graphics driver factory creates a QScreen object for a given key with QGfxDriverFactory::create(key). -.PP -The drivers are either built-in or dynamically loaded from a driver plugin (see QGfxDriverPlugin). -.PP -QGfxDriverFactory::keys() returns a list of valid keys. Qt currently ships with "LinuxFb". -.PP -This class is only available in Qt/Embedded. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QScreen * QGfxDriverFactory::create ( const QString & key, int displayId )\fC [static]\fR" -Creates a QScreen object of a type that matches \fIkey\fR, and with the ID, \fIdisplayId\fR. The QScreen object returned may be from a built-in driver, or from a driver plugin. -.PP -See also keys(). -.SH "QStringList QGfxDriverFactory::keys ()\fC [static]\fR" -Returns the list of keys this factory can create drivers for. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qgfxdriverfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgfxdriverfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgfxdriverplugin.3qt b/doc/man/man3/qgfxdriverplugin.3qt deleted file mode 100644 index 54f7c3b48..000000000 --- a/doc/man/man3/qgfxdriverplugin.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QGfxDriverPlugin 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 -QGfxDriverPlugin \- Abstract base for Qt/Embedded graphics driver plugins -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGfxDriverPlugin\fR ()" -.br -.ti -1c -.BI "\fB~QGfxDriverPlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBkeys\fR () const = 0" -.br -.ti -1c -.BI "virtual QScreen * \fBcreate\fR ( const QString & driver, int displayId ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QGfxDriverPlugin class provides an abstract base for Qt/Embedded graphics driver plugins. -.PP -The graphics driver plugin is a simple plugin interface that makes it easy to create custom graphics drivers. -.PP -Writing a graphics driver plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Plugins documentation for details. -.PP -This class is only available in Qt/Embedded. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGfxDriverPlugin::QGfxDriverPlugin ()" -Constructs a graphics driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. -.SH "QGfxDriverPlugin::~QGfxDriverPlugin ()" -Destroys the graphics driver plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "QScreen * QGfxDriverPlugin::create ( const QString & driver, int displayId )\fC [pure virtual]\fR" -Creates a driver matching the type specified by \fIdriver\fR, that will use display \fIdisplayId\fR. -.PP -See also keys(). -.SH "QStringList QGfxDriverPlugin::keys () const\fC [pure virtual]\fR" -Returns the list of graphics drivers this plugin supports. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qgfxdriverplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgfxdriverplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgl.3qt b/doc/man/man3/qgl.3qt deleted file mode 100644 index ae9ef3ce5..000000000 --- a/doc/man/man3/qgl.3qt +++ /dev/null @@ -1,95 +0,0 @@ -'\" t -.TH QGL 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 -QGL \- Namespace for miscellaneous identifiers in the Qt OpenGL module -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QGLFormat, QGLContext, and QGLWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBFormatOption\fR { DoubleBuffer = 0x0001, DepthBuffer = 0x0002, Rgba = 0x0004, AlphaChannel = 0x0008, AccumBuffer = 0x0010, StencilBuffer = 0x0020, StereoBuffers = 0x0040, DirectRendering = 0x0080, HasOverlay = 0x0100, SingleBuffer = DoubleBuffer<<16, NoDepthBuffer = DepthBuffer<<16, ColorIndex = Rgba<<16, NoAlphaChannel = AlphaChannel<<16, NoAccumBuffer = AccumBuffer<<16, NoStencilBuffer = StencilBuffer<<16, NoStereoBuffers = StereoBuffers<<16, IndirectRendering = DirectRendering<<16, NoOverlay = HasOverlay<<16 }" -.br -.in -1c -.SH DESCRIPTION -The QGL class is a namespace for miscellaneous identifiers in the Qt OpenGL module. -.PP -Normally you can ignore this class. QGLWidget and the other OpenGL* module classes inherit it, so when you make your own QGLWidget subclass you can use the identifiers in the QGL namespace without qualification. -.PP -However, you may occasionally find yourself in situations where you need to refer to these identifiers from outside the QGL namespace's scope, e.g. in static functions. In such cases, simply write e.g. QGL::DoubleBuffer instead of just DoubleBuffer. -.PP -* OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. -.PP -See also Graphics Classes and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QGL::FormatOption" -This enum specifies the format options. -.TP -\fCQGL::DoubleBuffer\fR -.TP -\fCQGL::DepthBuffer\fR -.TP -\fCQGL::Rgba\fR -.TP -\fCQGL::AlphaChannel\fR -.TP -\fCQGL::AccumBuffer\fR -.TP -\fCQGL::StencilBuffer\fR -.TP -\fCQGL::StereoBuffers\fR -.TP -\fCQGL::DirectRendering\fR -.TP -\fCQGL::HasOverlay\fR -.TP -\fCQGL::SingleBuffer\fR -.TP -\fCQGL::NoDepthBuffer\fR -.TP -\fCQGL::ColorIndex\fR -.TP -\fCQGL::NoAlphaChannel\fR -.TP -\fCQGL::NoAccumBuffer\fR -.TP -\fCQGL::NoStencilBuffer\fR -.TP -\fCQGL::NoStereoBuffers\fR -.TP -\fCQGL::IndirectRendering\fR -.TP -\fCQGL::NoOverlay\fR - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqgl.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgl.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qglayoutiterator.3qt b/doc/man/man3/qglayoutiterator.3qt deleted file mode 100644 index dfec3e5ff..000000000 --- a/doc/man/man3/qglayoutiterator.3qt +++ /dev/null @@ -1,81 +0,0 @@ -'\" t -.TH QGLayoutIterator 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 -QGLayoutIterator \- Abstract base class of internal layout iterators -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QGLayoutIterator\fR ()" -.br -.ti -1c -.BI "virtual QLayoutItem * \fBnext\fR () = 0" -.br -.ti -1c -.BI "virtual QLayoutItem * \fBcurrent\fR () = 0" -.br -.ti -1c -.BI "virtual QLayoutItem * \fBtakeCurrent\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QGLayoutIterator class is an abstract base class of internal layout iterators. -.PP -(This class is \fInot\fR OpenGL related, it just happens to start with the letters QGL...) -.PP -Subclass this class to create a custom layout. The functions that must be implemented are next(), current(), and takeCurrent(). -.PP -The QGLayoutIterator implements the functionality of QLayoutIterator. Each subclass of QLayout needs a QGLayoutIterator subclass. -.PP -See also Widget Appearance and Style and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGLayoutIterator::~QGLayoutIterator ()\fC [virtual]\fR" -Destroys the iterator -.SH "QLayoutItem * QGLayoutIterator::current ()\fC [pure virtual]\fR" -Implemented in subclasses to return the current item, or 0 if there is no current item. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.SH "QLayoutItem * QGLayoutIterator::next ()\fC [pure virtual]\fR" -Implemented in subclasses to move the iterator to the next item and return that item, or 0 if there is no next item. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.SH "QLayoutItem * QGLayoutIterator::takeCurrent ()\fC [pure virtual]\fR" -Implemented in subclasses. The function must remove the current item from the layout without deleting it, move the iterator to the next item and return the removed item, or 0 if no item was removed. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qglayoutiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qglayoutiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qglcolormap.3qt b/doc/man/man3/qglcolormap.3qt deleted file mode 100644 index a7e0484fb..000000000 --- a/doc/man/man3/qglcolormap.3qt +++ /dev/null @@ -1,166 +0,0 @@ -'\" t -.TH QGLColormap 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 -QGLColormap \- Used for installing custom colormaps into QGLWidgets -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGLColormap\fR ()" -.br -.ti -1c -.BI "\fBQGLColormap\fR ( const QGLColormap & map )" -.br -.ti -1c -.BI "\fB~QGLColormap\fR ()" -.br -.ti -1c -.BI "QGLColormap & \fBoperator=\fR ( const QGLColormap & map )" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "int \fBsize\fR () const" -.br -.ti -1c -.BI "void \fBdetach\fR ()" -.br -.ti -1c -.BI "void \fBsetEntries\fR ( int count, const QRgb * colors, int base = 0 )" -.br -.ti -1c -.BI "void \fBsetEntry\fR ( int idx, QRgb color )" -.br -.ti -1c -.BI "void \fBsetEntry\fR ( int idx, const QColor & color )" -.br -.ti -1c -.BI "QRgb \fBentryRgb\fR ( int idx ) const" -.br -.ti -1c -.BI "QColor \fBentryColor\fR ( int idx ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( QRgb color ) const" -.br -.ti -1c -.BI "int \fBfindNearest\fR ( QRgb color ) const" -.br -.in -1c -.SH DESCRIPTION -The QGLColormap class is used for installing custom colormaps into QGLWidgets. -.PP -QGLColormap provides a platform independent way of specifying and installing indexed colormaps into QGLWidgets. QGLColormap is especially useful when using the OpenGL color-index mode. -.PP -Under X11 you must use an X server that supports either a \fCPseudoColor\fR or \fCDirectColor\fR visual class. If your X server currently only provides a \fCGrayScale\fR, \fCTrueColor\fR, \fCStaticColor\fR or \fCStaticGray\fR visual, you will not be able to allocate colorcells for writing. If this is the case, try setting your X server to 8 bit mode. It should then provide you with at least a \fCPseudoColor\fR visual. Note that you may experience colormap flashing if your X server is running in 8 bit mode. -.PP -Under Windows the size of the colormap is always set to 256 colors. Note that under Windows you can also install colormaps in child widgets. -.PP -This class uses explicit sharing (see Shared Classes). -.PP -Example of use: -.PP -.nf -.br - #include -.br - #include -.br -.br - int main() -.br - { -.br - QApplication a( argc, argv ); -.br -.br - MySuperGLWidget widget( 0 ); // A QGLWidget in color-index mode -.br - QGLColormap colormap; -.br -.br - // This will fill the colormap with colors ranging from -.br - // black to white. -.br - for ( int i = 0; i < colormap.size(); i++ ) -.br - colormap.setEntry( i, tqRgb( i, i, i ) ); -.br -.br - widget.setColormap( colormap ); -.br - widget.show(); -.br - return a.exec(); -.br - } -.br -.fi -.PP -See also QGLWidget::setColormap(), QGLWidget::colormap(), Graphics Classes, and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGLColormap::QGLColormap ()" -Construct a QGLColormap. -.SH "QGLColormap::QGLColormap ( const QGLColormap & map )" -Construct a shallow copy of \fImap\fR. -.SH "QGLColormap::~QGLColormap ()" -Dereferences the QGLColormap and deletes it if this was the last reference to it. -.SH "void QGLColormap::detach ()" -Detaches this QGLColormap from the shared block. -.SH "QColor QGLColormap::entryColor ( int idx ) const" -Returns the QRgb value in the colorcell with index \fIidx\fR. -.SH "QRgb QGLColormap::entryRgb ( int idx ) const" -Returns the QRgb value in the colorcell with index \fIidx\fR. -.SH "int QGLColormap::find ( QRgb color ) const" -Returns the index of the color \fIcolor\fR. If \fIcolor\fR is not in the map, -1 is returned. -.SH "int QGLColormap::findNearest ( QRgb color ) const" -Returns the index of the color that is the closest match to color \fIcolor\fR. -.SH "bool QGLColormap::isEmpty () const" -Returns TRUE if the colormap is empty; otherwise returns FALSE. A colormap with no color values set is considered to be empty. -.SH "QGLColormap & QGLColormap::operator= ( const QGLColormap & map )" -Assign a shallow copy of \fImap\fR to this QGLColormap. -.SH "void QGLColormap::setEntries ( int count, const QRgb * colors, int base = 0 )" -Set an array of cells in this colormap. \fIcount\fR is the number of colors that should be set, \fIcolors\fR is the array of colors, and \fIbase\fR is the starting index. -.SH "void QGLColormap::setEntry ( int idx, QRgb color )" -Set cell at index \fIidx\fR in the colormap to color \fIcolor\fR. -.SH "void QGLColormap::setEntry ( int idx, const QColor & color )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Set the cell with index \fIidx\fR in the colormap to color \fIcolor\fR. -.SH "int QGLColormap::size () const" -Returns the number of colorcells in the colormap. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqglcolormap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qglcolormap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qglcontext.3qt b/doc/man/man3/qglcontext.3qt deleted file mode 100644 index 2816a3648..000000000 --- a/doc/man/man3/qglcontext.3qt +++ /dev/null @@ -1,273 +0,0 @@ -'\" t -.TH QGLContext 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 -QGLContext \- Encapsulates an OpenGL rendering context -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QGL. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGLContext\fR ( const QGLFormat & format, QPaintDevice * device )" -.br -.ti -1c -.BI "virtual \fB~QGLContext\fR ()" -.br -.ti -1c -.BI "virtual bool \fBcreate\fR ( const QGLContext * shareContext = 0 )" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBisSharing\fR () const" -.br -.ti -1c -.BI "virtual void \fBreset\fR ()" -.br -.ti -1c -.BI "QGLFormat \fBformat\fR () const" -.br -.ti -1c -.BI "QGLFormat \fBrequestedFormat\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFormat\fR ( const QGLFormat & format )" -.br -.ti -1c -.BI "virtual void \fBmakeCurrent\fR ()" -.br -.ti -1c -.BI "virtual void \fBswapBuffers\fR () const" -.br -.ti -1c -.BI "QPaintDevice * \fBdevice\fR () const" -.br -.ti -1c -.BI "QColor \fBoverlayTransparentColor\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "const QGLContext * \fBcurrentContext\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBchooseContext\fR ( const QGLContext * shareContext = 0 )" -.br -.ti -1c -.BI "virtual void \fBdoneCurrent\fR ()" -.br -.ti -1c -.BI "virtual int \fBchoosePixelFormat\fR ( void * dummyPfd, HDC pdc )" -.br -.ti -1c -.BI "virtual void * \fBchooseVisual\fR ()" -.br -.ti -1c -.BI "virtual void * \fBchooseMacVisual\fR ( GDHandle device )" -.br -.ti -1c -.BI "bool \fBdeviceIsPixmap\fR () const" -.br -.ti -1c -.BI "bool \fBwindowCreated\fR () const" -.br -.ti -1c -.BI "void \fBsetWindowCreated\fR ( bool on )" -.br -.ti -1c -.BI "bool \fBinitialized\fR () const" -.br -.ti -1c -.BI "void \fBsetInitialized\fR ( bool on )" -.br -.ti -1c -.BI "void \fBgenerateFontDisplayLists\fR ( const QFont & font, int listBase )" -.br -.in -1c -.SH DESCRIPTION -The QGLContext class encapsulates an OpenGL rendering context. -.PP -An OpenGL* rendering context is a complete set of OpenGL state variables. -.PP -The context's format is set in the constructor or later with setFormat(). The format options that are actually set are returned by format(); the options you asked for are returned by requestedFormat(). Note that after a QGLContext object has been constructed, the actual OpenGL context must be created by explicitly calling the create() function. The makeCurrent() function makes this context the current rendering context. You can make \fIno\fR context current using doneCurrent(). The reset() function will reset the context and make it invalid. -.PP -You can examine properties of the context with, e.g. isValid(), isSharing(), initialized(), windowCreated() and overlayTransparentColor(). -.PP -If you're using double buffering you can swap the screen contents with the off-screen buffer using swapBuffers(). -.PP -Please note that QGLContext is not thread safe. -.PP -* OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGLContext::QGLContext ( const QGLFormat & format, QPaintDevice * device )" -Constructs an OpenGL context for the paint device \fIdevice\fR, which can be a widget or a pixmap. The \fIformat\fR specifies several display options for the context. -.PP -If the underlying OpenGL/Window system cannot satisfy all the features requested in \fIformat\fR, the nearest subset of features will be used. After creation, the format() method will return the actual format obtained. -.PP -Note that after a QGLContext object has been constructed, create() must be called explicitly to create the actual OpenGL context. The context will be invalid if it was not possible to obtain a GL context at all. -.PP -See also format() and isValid(). -.SH "QGLContext::~QGLContext ()\fC [virtual]\fR" -Destroys the OpenGL context and frees its resources. -.SH "bool QGLContext::chooseContext ( const QGLContext * shareContext = 0 )\fC [virtual protected]\fR" -This semi-internal function is called by create(). It creates a system-dependent OpenGL handle that matches the format() of \fIshareContext\fR as closely as possible. -.PP -On Windows, it calls the virtual function choosePixelFormat(), which finds a matching pixel format identifier. On X11, it calls the virtual function chooseVisual() which finds an appropriate X visual. On other platforms it may work differently. -.SH "void * QGLContext::chooseMacVisual ( GDHandle device )\fC [virtual protected]\fR" -\fBMac only\fR: This virtual function tries to find a visual that matches the format using the given \fIdevice\fR handle, reducing the demands if the original request cannot be met. -.PP -The algorithm for reducing the demands of the format is quite simple-minded, so override this method in your subclass if your application has specific requirements on visual selection. -.PP -See also chooseContext(). -.SH "int QGLContext::choosePixelFormat ( void * dummyPfd, HDC pdc )\fC [virtual protected]\fR" -\fBWin32 only\fR This virtual function chooses a pixel format that matches the OpenGL format. Reimplement this function in a subclass if you need a custom context. -.PP -\fBWarning:\fR The \fIdummyPfd\fR pointer and \fIpdc\fR are used as a \fCPIXELFORMATDESCRIPTOR*\fR. We use \fCvoid\fR to avoid using Windows-specific types in our header files. -.PP -See also chooseContext(). -.SH "void * QGLContext::chooseVisual ()\fC [virtual protected]\fR" -\fBX11 only\fR: This virtual function tries to find a visual that matches the format, reducing the demands if the original request cannot be met. -.PP -The algorithm for reducing the demands of the format is quite simple-minded, so override this method in your subclass if your application has spcific requirements on visual selection. -.PP -See also chooseContext(). -.SH "bool QGLContext::create ( const QGLContext * shareContext = 0 )\fC [virtual]\fR" -Creates the GL context. Returns TRUE if it was successful in creating a valid GL rendering context on the paint device specified in the constructor; otherwise returns FALSE (i.e. the context is invalid). -.PP -After successful creation, format() returns the set of features of the created GL rendering context. -.PP -If \fIshareContext\fR points to a valid QGLContext, this method will try to establish OpenGL display list sharing between this context and the \fIshareContext\fR. Note that this may fail if the two contexts have different formats. Use isSharing() to see if sharing succeeded. -.PP -\fBWarning:\fR Implementation note: initialization of C++ class members usually takes place in the class constructor. QGLContext is an exception because it must be simple to customize. The virtual functions chooseContext() (and chooseVisual() for X11) can be reimplemented in a subclass to select a particular context. The problem is that virtual functions are not properly called during construction (even though this is correct C++) because C++ constructs class hierarchies from the bottom up. For this reason we need a create() function. -.PP -See also chooseContext(), format(), and isValid(). -.SH "const QGLContext * QGLContext::currentContext ()\fC [static]\fR" -Returns the current context, i.e. the context to which any OpenGL commands will currently be directed. Returns 0 if no context is current. -.PP -See also makeCurrent(). -.SH "QPaintDevice * QGLContext::device () const" -Returns the paint device set for this context. -.PP -See also QGLContext::QGLContext(). -.SH "bool QGLContext::deviceIsPixmap () const\fC [protected]\fR" -Returns TRUE if the paint device of this context is a pixmap; otherwise returns FALSE. -.SH "void QGLContext::doneCurrent ()\fC [virtual protected]\fR" -Makes no GL context the current context. Normally, you do not need to call this function; QGLContext calls it as necessary. -.SH "QGLFormat QGLContext::format () const" -Returns the frame buffer format that was obtained (this may be a subset of what was requested). -.PP -See also requestedFormat(). -.SH "void QGLContext::generateFontDisplayLists ( const QFont & font, int listBase )\fC [protected]\fR" -Generates a set of 256 display lists for the 256 first characters in the font \fIfont\fR. The first list will start at index \fIlistBase\fR. -.PP -See also QGLWidget::renderText(). -.SH "bool QGLContext::initialized () const\fC [protected]\fR" -Returns TRUE if this context has been initialized, i.e. if QGLWidget::initializeGL() has been performed on it; otherwise returns FALSE. -.PP -See also setInitialized(). -.SH "bool QGLContext::isSharing () const" -Returns TRUE if display list sharing with another context was requested in the create() call and the GL system was able to fulfill this request; otherwise returns FALSE. Note that display list sharing might not be supported between contexts with different formats. -.SH "bool QGLContext::isValid () const" -Returns TRUE if a GL rendering context has been successfully created; otherwise returns FALSE. -.SH "void QGLContext::makeCurrent ()\fC [virtual]\fR" -Makes this context the current OpenGL rendering context. All GL functions you call operate on this context until another context is made current. -.PP -In some very rare cases the underlying call may fail. If this occurs an error message is output to stderr. -.SH "QColor QGLContext::overlayTransparentColor () const" -If this context is a valid context in an overlay plane, returns the plane's transparent color. Otherwise returns an invalid color. -.PP -The returned color's pixel value is the index of the transparent color in the colormap of the overlay plane. (Naturally, the color's RGB values are meaningless.) -.PP -The returned QColor object will generally work as expected only when passed as the argument to QGLWidget::qglColor() or QGLWidget::qglClearColor(). Under certain circumstances it can also be used to draw transparent graphics with a QPainter. See the examples/opengl/overlay_x11 example for details. -.SH "QGLFormat QGLContext::requestedFormat () const" -Returns the frame buffer format that was originally requested in the constructor or setFormat(). -.PP -See also format(). -.SH "void QGLContext::reset ()\fC [virtual]\fR" -Resets the context and makes it invalid. -.PP -See also create() and isValid(). -.SH "void QGLContext::setFormat ( const QGLFormat & format )\fC [virtual]\fR" -Sets a \fIformat\fR for this context. The context is reset. -.PP -Call create() to create a new GL context that tries to match the new format. -.PP -.nf -.br - QGLContext *cx; -.br - // ... -.br - QGLFormat f; -.br - f.setStereo( TRUE ); -.br - cx->setFormat( f ); -.br - if ( !cx->create() ) -.br - exit(); // no OpenGL support, or cannot render on the specified paintdevice -.br - if ( !cx->format().stereo() ) -.br - exit(); // could not create stereo context -.br -.fi -.PP -See also format(), reset(), and create(). -.SH "void QGLContext::setInitialized ( bool on )\fC [protected]\fR" -If \fIon\fR is TRUE the context has been initialized, i.e. QGLContext::setInitialized() has been called on it. If \fIon\fR is FALSE the context has not been initialized. -.PP -See also initialized(). -.SH "void QGLContext::setWindowCreated ( bool on )\fC [protected]\fR" -If \fIon\fR is TRUE the context has had a window created for it. If \fIon\fR is FALSE no window has been created for the context. -.PP -See also windowCreated(). -.SH "void QGLContext::swapBuffers () const\fC [virtual]\fR" -Swaps the screen contents with an off-screen buffer. Only works if the context is in double buffer mode. -.PP -See also QGLFormat::setDoubleBuffer(). -.SH "bool QGLContext::windowCreated () const\fC [protected]\fR" -Returns TRUE if a window has been created for this context; otherwise returns FALSE. -.PP -See also setWindowCreated(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qglcontext.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qglcontext.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qglformat.3qt b/doc/man/man3/qglformat.3qt deleted file mode 100644 index 6c61f0638..000000000 --- a/doc/man/man3/qglformat.3qt +++ /dev/null @@ -1,511 +0,0 @@ -'\" t -.TH QGLFormat 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 -QGLFormat \- The display format of an OpenGL rendering context -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QGL. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGLFormat\fR ()" -.br -.ti -1c -.BI "\fBQGLFormat\fR ( int options, int plane = 0 )" -.br -.ti -1c -.BI "bool \fBdoubleBuffer\fR () const" -.br -.ti -1c -.BI "void \fBsetDoubleBuffer\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBdepth\fR () const" -.br -.ti -1c -.BI "void \fBsetDepth\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBrgba\fR () const" -.br -.ti -1c -.BI "void \fBsetRgba\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBalpha\fR () const" -.br -.ti -1c -.BI "void \fBsetAlpha\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBaccum\fR () const" -.br -.ti -1c -.BI "void \fBsetAccum\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBstencil\fR () const" -.br -.ti -1c -.BI "void \fBsetStencil\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBstereo\fR () const" -.br -.ti -1c -.BI "void \fBsetStereo\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBdirectRendering\fR () const" -.br -.ti -1c -.BI "void \fBsetDirectRendering\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBhasOverlay\fR () const" -.br -.ti -1c -.BI "void \fBsetOverlay\fR ( bool enable )" -.br -.ti -1c -.BI "int \fBplane\fR () const" -.br -.ti -1c -.BI "void \fBsetPlane\fR ( int plane )" -.br -.ti -1c -.BI "void \fBsetOption\fR ( FormatOption opt )" -.br -.ti -1c -.BI "bool \fBtestOption\fR ( FormatOption opt ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QGLFormat \fBdefaultFormat\fR ()" -.br -.ti -1c -.BI "void \fBsetDefaultFormat\fR ( const QGLFormat & f )" -.br -.ti -1c -.BI "QGLFormat \fBdefaultOverlayFormat\fR ()" -.br -.ti -1c -.BI "void \fBsetDefaultOverlayFormat\fR ( const QGLFormat & f )" -.br -.ti -1c -.BI "bool \fBhasOpenGL\fR ()" -.br -.ti -1c -.BI "bool \fBhasOpenGLOverlays\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QGLFormat class specifies the display format of an OpenGL rendering context. -.PP -A display format has several characteristics: -.TP -Double or single buffering. -.TP -Depth buffer. -.TP -RGBA or color index mode. -.TP -Alpha channel. -.TP -Accumulation buffer. -.TP -Stencil buffer. -.TP -Stereo buffers. -.TP -Direct rendering. -.TP -Presence of an overlay. -.TP -The plane of an overlay format. -.PP -You create and tell a QGLFormat object what rendering options you want from an OpenGL* rendering context. -.PP -OpenGL drivers or accelerated hardware may or may not support advanced features such as alpha channel or stereographic viewing. If you request some features that the driver/hardware does not provide when you create a QGLWidget, you will get a rendering context with the nearest subset of features. -.PP -There are different ways to define the display characteristics of a rendering context. One is to create a QGLFormat and make it the default for the entire application: -.PP -.nf -.br - QGLFormat f; -.br - f.setAlpha( TRUE ); -.br - f.setStereo( TRUE ); -.br - QGLFormat::setDefaultFormat( f ); -.br -.fi -.PP -Or you can specify the desired format when creating an object of your QGLWidget subclass: -.PP -.nf -.br - QGLFormat f; -.br - f.setDoubleBuffer( FALSE ); // single buffer -.br - f.setDirectRendering( FALSE ); // software rendering -.br - MyGLWidget* myWidget = new MyGLWidget( f, ... ); -.br -.fi -.PP -After the widget has been created, you can find out which of the requested features the system was able to provide: -.PP -.nf -.br - QGLFormat f; -.br - f.setOverlay( TRUE ); -.br - f.setStereo( TRUE ); -.br - MyGLWidget* myWidget = new MyGLWidget( f, ... ); -.br - if ( !w->format().stereo() ) { -.br - // ok, goggles off -.br - if ( !w->format().hasOverlay() ) { -.br - tqFatal( "Cool hardware required" ); -.br - } -.br - } -.br -.fi -.PP -* OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. -.PP -See also QGLContext, QGLWidget, Graphics Classes, and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGLFormat::QGLFormat ()" -Constructs a QGLFormat object with the factory default settings: -.TP -Double buffer: Enabled. -.TP -Depth buffer: Enabled. -.TP -RGBA: Enabled (i.e., color index disabled). -.TP -Alpha channel: Disabled. -.TP -Accumulator buffer: Disabled. -.TP -Stencil buffer: Disabled. -.TP -Stereo: Disabled. -.TP -Direct rendering: Enabled. -.TP -Overlay: Disabled. -.TP -Plane: 0 (i.e., normal plane). -.SH "QGLFormat::QGLFormat ( int options, int plane = 0 )" -Creates a QGLFormat object that is a copy of the current application default format. -.PP -If \fIoptions\fR is not 0, this copy is modified by these format options. The \fIoptions\fR parameter should be FormatOption values OR'ed together. -.PP -This constructor makes it easy to specify a certain desired format in classes derived from QGLWidget, for example: -.PP -.nf -.br - // The rendering in MyGLWidget depends on using -.br - // stencil buffer and alpha channel -.br - MyGLWidget::MyGLWidget( QWidget* parent, const char* name ) -.br - : QGLWidget( QGLFormat( StencilBuffer | AlphaChannel ), parent, name ) -.br - { -.br - if ( !format().stencil() ) -.br - tqWarning( "Could not get stencil buffer; results will be suboptimal" ); -.br - if ( !format().alphaChannel() ) -.br - tqWarning( "Could not get alpha channel; results will be suboptimal" ); -.br - ... -.br - } -.br -.fi -.PP -Note that there are FormatOption values to turn format settings both on and off, e.g. DepthBuffer and NoDepthBuffer, DirectRendering and IndirectRendering, etc. -.PP -The \fIplane\fR parameter defaults to 0 and is the plane which this format should be associated with. Not all OpenGL implmentations supports overlay/underlay rendering planes. -.PP -See also defaultFormat() and setOption(). -.SH "bool QGLFormat::accum () const" -Returns TRUE if the accumulation buffer is enabled; otherwise returns FALSE. The accumulation buffer is disabled by default. -.PP -See also setAccum(). -.SH "bool QGLFormat::alpha () const" -Returns TRUE if the alpha channel of the framebuffer is enabled; otherwise returns FALSE. The alpha channel is disabled by default. -.PP -See also setAlpha(). -.SH "QGLFormat QGLFormat::defaultFormat ()\fC [static]\fR" -Returns the default QGLFormat for the application. All QGLWidgets that are created use this format unless another format is specified, e.g. when they are constructed. -.PP -If no special default format has been set using setDefaultFormat(), the default format is the same as that created with QGLFormat(). -.PP -See also setDefaultFormat(). -.SH "QGLFormat QGLFormat::defaultOverlayFormat ()\fC [static]\fR" -Returns the default QGLFormat for overlay contexts. -.PP -The factory default overlay format is: -.TP -Double buffer: Disabled. -.TP -Depth buffer: Disabled. -.TP -RGBA: Disabled (i.e., color index enabled). -.TP -Alpha channel: Disabled. -.TP -Accumulator buffer: Disabled. -.TP -Stencil buffer: Disabled. -.TP -Stereo: Disabled. -.TP -Direct rendering: Enabled. -.TP -Overlay: Disabled. -.TP -Plane: 1 (i.e., first overlay plane). -.PP -See also setDefaultFormat(). -.SH "bool QGLFormat::depth () const" -Returns TRUE if the depth buffer is enabled; otherwise returns FALSE. The depth buffer is enabled by default. -.PP -See also setDepth(). -.SH "bool QGLFormat::directRendering () const" -Returns TRUE if direct rendering is enabled; otherwise returns FALSE. -.PP -Direct rendering is enabled by default. -.PP -See also setDirectRendering(). -.SH "bool QGLFormat::doubleBuffer () const" -Returns TRUE if double buffering is enabled; otherwise returns FALSE. Double buffering is enabled by default. -.PP -See also setDoubleBuffer(). -.SH "bool QGLFormat::hasOpenGL ()\fC [static]\fR" -Returns TRUE if the window system has any OpenGL support; otherwise returns FALSE. -.PP -\fBWarning:\fR This function must not be called until the QApplication object has been created. -.SH "bool QGLFormat::hasOpenGLOverlays ()\fC [static]\fR" -Returns TRUE if the window system supports OpenGL overlays; otherwise returns FALSE. -.PP -\fBWarning:\fR This function must not be called until the QApplication object has been created. -.SH "bool QGLFormat::hasOverlay () const" -Returns TRUE if overlay plane is enabled; otherwise returns FALSE. -.PP -Overlay is disabled by default. -.PP -See also setOverlay(). -.SH "int QGLFormat::plane () const" -Returns the plane of this format. The default for normal formats is 0, which means the normal plane. The default for overlay formats is 1, which is the first overlay plane. -.PP -See also setPlane(). -.SH "bool QGLFormat::rgba () const" -Returns TRUE if RGBA color mode is set. Returns FALSE if color index mode is set. The default color mode is RGBA. -.PP -See also setRgba(). -.SH "void QGLFormat::setAccum ( bool enable )" -If \fIenable\fR is TRUE enables the accumulation buffer; otherwise disables the accumulation buffer. -.PP -The accumulation buffer is disabled by default. -.PP -The accumulation buffer is used to create blur effects and multiple exposures. -.PP -See also accum(). -.SH "void QGLFormat::setAlpha ( bool enable )" -If \fIenable\fR is TRUE enables the alpha channel; otherwise disables the alpha channel. -.PP -The alpha buffer is disabled by default. -.PP -The alpha channel is typically used for implementing transparency or translucency. The A in RGBA specifies the transparency of a pixel. -.PP -See also alpha(). -.SH "void QGLFormat::setDefaultFormat ( const QGLFormat & f )\fC [static]\fR" -Sets a new default QGLFormat for the application to \fIf\fR. For example, to set single buffering as the default instead of double buffering, your main() might contain code like this: -.PP -.nf -.br - QApplication a(argc, argv); -.br - QGLFormat f; -.br - f.setDoubleBuffer( FALSE ); -.br - QGLFormat::setDefaultFormat( f ); -.br -.fi -.PP -See also defaultFormat(). -.SH "void QGLFormat::setDefaultOverlayFormat ( const QGLFormat & f )\fC [static]\fR" -Sets a new default QGLFormat for overlay contexts to \fIf\fR. This format is used whenever a QGLWidget is created with a format that hasOverlay() enabled. -.PP -For example, to get a double buffered overlay context (if available), use code like this: -.PP -.nf -.br - QGLFormat f = QGLFormat::defaultOverlayFormat(); -.br - f.setDoubleBuffer( TRUE ); -.br - QGLFormat::setDefaultOverlayFormat( f ); -.br -.fi -.PP -As usual, you can find out after widget creation whether the underlying OpenGL system was able to provide the requested specification: -.PP -.nf -.br - // ...continued from above -.br - MyGLWidget* myWidget = new MyGLWidget( QGLFormat( QGL::HasOverlay ), ... ); -.br - if ( myWidget->format().hasOverlay() ) { -.br - // Yes, we got an overlay, let's check _its_ format: -.br - QGLContext* olContext = myWidget->overlayContext(); -.br - if ( olContext->format().doubleBuffer() ) -.br - ; // yes, we got a double buffered overlay -.br - else -.br - ; // no, only single buffered overlays are available -.br - } -.br -.fi -.PP -See also defaultOverlayFormat(). -.SH "void QGLFormat::setDepth ( bool enable )" -If \fIenable\fR is TRUE enables the depth buffer; otherwise disables the depth buffer. -.PP -The depth buffer is enabled by default. -.PP -The purpose of a depth buffer (or Z-buffering) is to remove hidden surfaces. Pixels are assigned Z values based on the distance to the viewer. A pixel with a high Z value is closer to the viewer than a pixel with a low Z value. This information is used to decide whether to draw a pixel or not. -.PP -See also depth(). -.SH "void QGLFormat::setDirectRendering ( bool enable )" -If \fIenable\fR is TRUE enables direct rendering; otherwise disables direct rendering. -.PP -Direct rendering is enabled by default. -.PP -Enabling this option will make OpenGL bypass the underlying window system and render directly from hardware to the screen, if this is supported by the system. -.PP -See also directRendering(). -.SH "void QGLFormat::setDoubleBuffer ( bool enable )" -If \fIenable\fR is TRUE sets double buffering; otherwise sets single buffering. -.PP -Double buffering is enabled by default. -.PP -Double buffering is a technique where graphics are rendered on an off-screen buffer and not directly to the screen. When the drawing has been completed, the program calls a swapBuffers() function to exchange the screen contents with the buffer. The result is flicker-free drawing and often better performance. -.PP -See also doubleBuffer(), QGLContext::swapBuffers(), and QGLWidget::swapBuffers(). -.SH "void QGLFormat::setOption ( FormatOption opt )" -Sets the format option to \fIopt\fR. -.PP -See also testOption(). -.SH "void QGLFormat::setOverlay ( bool enable )" -If \fIenable\fR is TRUE enables an overlay plane; otherwise disables the overlay plane. -.PP -Enabling the overlay plane will cause QGLWidget to create an additional context in an overlay plane. See the QGLWidget documentation for further information. -.PP -See also hasOverlay(). -.SH "void QGLFormat::setPlane ( int plane )" -Sets the requested plane to \fIplane\fR. 0 is the normal plane, 1 is the first overlay plane, 2 is the second overlay plane, etc.; -1, -2, etc. are underlay planes. -.PP -Note that in contrast to other format specifications, the plane specifications will be matched exactly. This means that if you specify a plane that the underlying OpenGL system cannot provide, an invalid QGLWidget will be created. -.PP -See also plane(). -.SH "void QGLFormat::setRgba ( bool enable )" -If \fIenable\fR is TRUE sets RGBA mode. If \fIenable\fR is FALSE sets color index mode. -.PP -The default color mode is RGBA. -.PP -RGBA is the preferred mode for most OpenGL applications. In RGBA color mode you specify colors as red + green + blue + alpha quadruplets. -.PP -In color index mode you specify an index into a color lookup table. -.PP -See also rgba(). -.SH "void QGLFormat::setStencil ( bool enable )" -If \fIenable\fR is TRUE enables the stencil buffer; otherwise disables the stencil buffer. -.PP -The stencil buffer is disabled by default. -.PP -The stencil buffer masks certain parts of the drawing area so that masked parts are not drawn on. -.PP -See also stencil(). -.SH "void QGLFormat::setStereo ( bool enable )" -If \fIenable\fR is TRUE enables stereo buffering; otherwise disables stereo buffering. -.PP -Stereo buffering is disabled by default. -.PP -Stereo buffering provides extra color buffers to generate left-eye and right-eye images. -.PP -See also stereo(). -.SH "bool QGLFormat::stencil () const" -Returns TRUE if the stencil buffer is enabled; otherwise returns FALSE. The stencil buffer is disabled by default. -.PP -See also setStencil(). -.SH "bool QGLFormat::stereo () const" -Returns TRUE if stereo buffering is enabled; otherwise returns FALSE. Stereo buffering is disabled by default. -.PP -See also setStereo(). -.SH "bool QGLFormat::testOption ( FormatOption opt ) const" -Returns TRUE if format option \fIopt\fR is set; otherwise returns FALSE. -.PP -See also setOption(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qglformat.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qglformat.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qglwidget.3qt b/doc/man/man3/qglwidget.3qt deleted file mode 100644 index c1282249c..000000000 --- a/doc/man/man3/qglwidget.3qt +++ /dev/null @@ -1,512 +0,0 @@ -'\" t -.TH QGLWidget 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 -QGLWidget \- Widget for rendering OpenGL graphics -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget and QGL. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGLWidget\fR ( QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQGLWidget\fR ( QGLContext * context, QWidget * parent, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQGLWidget\fR ( const QGLFormat & format, QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QGLWidget\fR ()" -.br -.ti -1c -.BI "void \fBqglColor\fR ( const QColor & c ) const" -.br -.ti -1c -.BI "void \fBqglClearColor\fR ( const QColor & c ) const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBisSharing\fR () const" -.br -.ti -1c -.BI "virtual void \fBmakeCurrent\fR ()" -.br -.ti -1c -.BI "void \fBdoneCurrent\fR ()" -.br -.ti -1c -.BI "bool \fBdoubleBuffer\fR () const" -.br -.ti -1c -.BI "virtual void \fBswapBuffers\fR ()" -.br -.ti -1c -.BI "QGLFormat \fBformat\fR () const" -.br -.ti -1c -.BI "const QGLContext * \fBcontext\fR () const" -.br -.ti -1c -.BI "virtual QPixmap \fBrenderPixmap\fR ( int w = 0, int h = 0, bool useContext = FALSE )" -.br -.ti -1c -.BI "virtual QImage \fBgrabFrameBuffer\fR ( bool withAlpha = FALSE )" -.br -.ti -1c -.BI "virtual void \fBmakeOverlayCurrent\fR ()" -.br -.ti -1c -.BI "const QGLContext * \fBoverlayContext\fR () const" -.br -.ti -1c -.BI "const QGLColormap & \fBcolormap\fR () const" -.br -.ti -1c -.BI "void \fBsetColormap\fR ( const QGLColormap & cmap )" -.br -.ti -1c -.BI "void \fBrenderText\fR ( int x, int y, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" -.br -.ti -1c -.BI "void \fBrenderText\fR ( double x, double y, double z, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBupdateGL\fR ()" -.br -.ti -1c -.BI "virtual void \fBupdateOverlayGL\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QImage \fBconvertToGLFormat\fR ( const QImage & img )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBinitializeGL\fR ()" -.br -.ti -1c -.BI "virtual void \fBresizeGL\fR ( int width, int height )" -.br -.ti -1c -.BI "virtual void \fBpaintGL\fR ()" -.br -.ti -1c -.BI "virtual void \fBinitializeOverlayGL\fR ()" -.br -.ti -1c -.BI "virtual void \fBresizeOverlayGL\fR ( int width, int height )" -.br -.ti -1c -.BI "virtual void \fBpaintOverlayGL\fR ()" -.br -.ti -1c -.BI "void \fBsetAutoBufferSwap\fR ( bool on )" -.br -.ti -1c -.BI "bool \fBautoBufferSwap\fR () const" -.br -.ti -1c -.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" -.br -.ti -1c -.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * )" -.br -.ti -1c -.BI "virtual void \fBglInit\fR ()" -.br -.ti -1c -.BI "virtual void \fBglDraw\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QGLWidget class is a widget for rendering OpenGL graphics. -.PP -QGLWidget provides functionality for displaying OpenGL* graphics integrated into a Qt application. It is very simple to use. You inherit from it and use the subclass like any other QWidget, except that instead of drawing the widget's contents using QPainter etc. you use the standard OpenGL rendering commands. -.PP -QGLWidget provides three convenient virtual functions that you can reimplement in your subclass to perform the typical OpenGL tasks: -.TP -paintGL() - Renders the OpenGL scene. Gets called whenever the widget needs to be updated. -.TP -resizeGL() - Sets up the OpenGL viewport, projection, etc. Gets called whenever the the widget has been resized (and also when it is shown for the first time because all newly created widgets get a resize event automatically). -.TP -initializeGL() - Sets up the OpenGL rendering context, defines display lists, etc. Gets called once before the first time resizeGL() or paintGL() is called. -.PP -Here is a rough outline of how a QGLWidget subclass might look: -.PP -.nf -.br - class MyGLDrawer : public QGLWidget -.br - { -.br - TQ_OBJECT // must include this if you use Qt signals/slots -.br -.br - public: -.br - MyGLDrawer( QWidget *parent, const char *name ) -.br - : QGLWidget(parent, name) {} -.br -.br - protected: -.br -.br - void initializeGL() -.br - { -.br - // Set up the rendering context, define display lists etc.: -.br - ... -.br - glClearColor( 0.0, 0.0, 0.0, 0.0 ); -.br - glEnable(GL_DEPTH_TEST); -.br - ... -.br - } -.br -.br - void resizeGL( int w, int h ) -.br - { -.br - // setup viewport, projection etc.: -.br - glViewport( 0, 0, (GLint)w, (GLint)h ); -.br - ... -.br - glFrustum( ... ); -.br - ... -.br - } -.br -.br - void paintGL() -.br - { -.br - // draw the scene: -.br - ... -.br - glRotatef( ... ); -.br - glMaterialfv( ... ); -.br - glBegin( GL_QUADS ); -.br - glVertex3f( ... ); -.br - glVertex3f( ... ); -.br - ... -.br - glEnd(); -.br - ... -.br - } -.br -.br - }; -.br -.fi -.PP -If you need to trigger a repaint from places other than paintGL() (a typical example is when using timers to animate scenes), you should call the widget's updateGL() function. -.PP -Your widget's OpenGL rendering context is made current when paintGL(), resizeGL(), or initializeGL() is called. If you need to call the standard OpenGL API functions from other places (e.g. in your widget's constructor or in your own paint functions), you must call makeCurrent() first. -.PP -QGLWidget provides functions for requesting a new display format and you can also create widgets with customized rendering contexts. -.PP -You can also share OpenGL display lists between QGLWidgets (see the documentation of the QGLWidget constructors for details). -.SH "Overlays" -The QGLWidget creates a GL overlay context in addition to the normal context if overlays are supported by the underlying system. -.PP -If you want to use overlays, you specify it in the format. (Note: Overlay must be requested in the format passed to the QGLWidget constructor.) Your GL widget should also implement some or all of these virtual methods: -.TP -paintOverlayGL() -.TP -resizeOverlayGL() -.TP -initializeOverlayGL() -.PP -These methods work in the same way as the normal paintGL() etc. functions, except that they will be called when the overlay context is made current. You can explicitly make the overlay context current by using makeOverlayCurrent(), and you can access the overlay context directly (e.g. to ask for its transparent color) by calling overlayContext(). -.PP -On X servers in which the default visual is in an overlay plane, non-GL Qt windows can also be used for overlays. See the examples/opengl/overlay_x11 example program for details. -.PP -* OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGLWidget::QGLWidget ( QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" -Constructs an OpenGL widget with a \fIparent\fR widget and a \fIname\fR. -.PP -The default format is used. The widget will be invalid if the system has no OpenGL support. -.PP -The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QWidget constructor. -.PP -If the \fIshareWidget\fR parameter points to a valid QGLWidget, this widget will share OpenGL display lists with \fIshareWidget\fR. If this widget and \fIshareWidget\fR have different formats, display list sharing may fail. You can check whether display list sharing succeeded by calling isSharing(). -.PP -The initialization of OpenGL rendering state, etc. should be done by overriding the initializeGL() function, rather than in the constructor of your QGLWidget subclass. -.PP -See also QGLFormat::defaultFormat(). -.SH "QGLWidget::QGLWidget ( QGLContext * context, QWidget * parent, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" -Constructs an OpenGL widget with parent \fIparent\fR, called \fIname\fR. -.PP -The \fIcontext\fR argument is a pointer to the QGLContext that you wish to be bound to this widget. This allows you to pass in your own QGLContext sub-classes. -.PP -The widget will be invalid if the system has no OpenGL support. -.PP -The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QWidget constructor. -.PP -If the \fIshareWidget\fR parameter points to a valid QGLWidget, this widget will share OpenGL display lists with \fIshareWidget\fR. If this widget and \fIshareWidget\fR have different formats, display list sharing may fail. You can check whether display list sharing succeeded by calling isSharing(). -.PP -The initialization of OpenGL rendering state, etc. should be done by overriding the initializeGL() function, rather than in the constructor of your QGLWidget subclass. -.PP -See also QGLFormat::defaultFormat() and isValid(). -.SH "QGLWidget::QGLWidget ( const QGLFormat & format, QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" -Constructs an OpenGL widget with parent \fIparent\fR, called \fIname\fR. -.PP -The \fIformat\fR argument specifies the desired rendering options. If the underlying OpenGL/Window system cannot satisfy all the features requested in \fIformat\fR, the nearest subset of features will be used. After creation, the format() method will return the actual format obtained. -.PP -The widget will be invalid if the system has no OpenGL support. -.PP -The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QWidget constructor. -.PP -If the \fIshareWidget\fR parameter points to a valid QGLWidget, this widget will share OpenGL display lists with \fIshareWidget\fR. If this widget and \fIshareWidget\fR have different formats, display list sharing may fail. You can check whether display list sharing succeeded by calling isSharing(). -.PP -The initialization of OpenGL rendering state, etc. should be done by overriding the initializeGL() function, rather than in the constructor of your QGLWidget subclass. -.PP -See also QGLFormat::defaultFormat() and isValid(). -.SH "QGLWidget::~QGLWidget ()" -Destroys the widget. -.SH "bool QGLWidget::autoBufferSwap () const\fC [protected]\fR" -Returns TRUE if the widget is doing automatic GL buffer swapping; otherwise returns FALSE. -.PP -See also setAutoBufferSwap(). -.SH "const QGLColormap & QGLWidget::colormap () const" -Returns the colormap for this widget. -.PP -Usually it is only top-level widgets that can have different colormaps installed. Asking for the colormap of a child widget will return the colormap for the child's top-level widget. -.PP -If no colormap has been set for this widget, the QColormap returned will be empty. -.PP -See also setColormap(). -.SH "const QGLContext * QGLWidget::context () const" -Returns the context of this widget. -.PP -It is possible that the context is not valid (see isValid()), for example, if the underlying hardware does not support the format attributes that were requested. -.SH "QImage QGLWidget::convertToGLFormat ( const QImage & img )\fC [static]\fR" -Converts the image \fIimg\fR into the unnamed format expected by OpenGL functions such as glTexImage2D(). The returned image is not usable as a QImage, but QImage::width(), QImage::height() and QImage::bits() may be used with OpenGL. The following few lines are from the texture example. Most of the code is irrelevant, so we just quote the relevant bits: -.PP -.nf -.br - QImage tex1, tex2, buf; -.br - if ( !buf.load( "gllogo.bmp" ) ) { // Load first image from file -.fi -.PP -We create \fItex1\fR (and another variable) for OpenGL, and load a real image into \fIbuf\fR. -.PP -.nf -.br - tex1 = QGLWidget::convertToGLFormat( buf ); // flipped 32bit RGBA -.fi -.PP -A few lines later, we convert \fIbuf\fR into OpenGL format and store it in \fItex1\fR. -.PP -.nf -.br - glTexImage2D( GL_TEXTURE_2D, 0, 3, tex1.width(), tex1.height(), 0, -.br - GL_RGBA, GL_UNSIGNED_BYTE, tex1.bits() ); -.fi -.PP -Note the dimension restrictions for texture images as described in the glTexImage2D() documentation. The width must be 2^m + 2*border and the height 2^n + 2*border where m and n are integers and border is either 0 or 1. -.PP -Another function in the same example uses \fItex1\fR with OpenGL. -.PP -Example: opengl/texture/gltexobj.cpp. -.SH "void QGLWidget::doneCurrent ()" -Makes no GL context the current context. Normally, you do not need to call this function; QGLContext calls it as necessary. However, it may be useful in multithreaded environments. -.SH "bool QGLWidget::doubleBuffer () const" -Returns TRUE if the contained GL rendering context has double buffering; otherwise returns FALSE. -.PP -See also QGLFormat::doubleBuffer(). -.SH "QGLFormat QGLWidget::format () const" -Returns the format of the contained GL rendering context. -.SH "void QGLWidget::glDraw ()\fC [virtual protected]\fR" -Executes the virtual function paintGL(). -.PP -The widget's rendering context will become the current context and initializeGL() will be called if it hasn't already been called. -.SH "void QGLWidget::glInit ()\fC [virtual protected]\fR" -Initializes OpenGL for this widget's context. Calls the virtual function initializeGL(). -.SH "QImage QGLWidget::grabFrameBuffer ( bool withAlpha = FALSE )\fC [virtual]\fR" -Returns an image of the frame buffer. If \fIwithAlpha\fR is TRUE the alpha channel is included. -.PP -Depending on your hardware, you can explicitly select which color buffer to grab with a glReadBuffer() call before calling this function. -.SH "void QGLWidget::initializeGL ()\fC [virtual protected]\fR" -This virtual function is called once before the first call to paintGL() or resizeGL(), and then once whenever the widget has been assigned a new QGLContext. Reimplement it in a subclass. -.PP -This function should set up any required OpenGL context rendering flags, defining display lists, etc. -.PP -There is no need to call makeCurrent() because this has already been done when this function is called. -.SH "void QGLWidget::initializeOverlayGL ()\fC [virtual protected]\fR" -This virtual function is used in the same manner as initializeGL() except that it operates on the widget's overlay context instead of the widget's main context. This means that initializeOverlayGL() is called once before the first call to paintOverlayGL() or resizeOverlayGL(). Reimplement it in a subclass. -.PP -This function should set up any required OpenGL context rendering flags, defining display lists, etc. for the overlay context. -.PP -There is no need to call makeOverlayCurrent() because this has already been done when this function is called. -.SH "bool QGLWidget::isSharing () const" -Returns TRUE if display list sharing with another QGLWidget was requested in the constructor, and the GL system was able to provide it; otherwise returns FALSE. The GL system may fail to provide display list sharing if the two QGLWidgets use different formats. -.PP -See also format(). -.SH "bool QGLWidget::isValid () const" -Returns TRUE if the widget has a valid GL rendering context; otherwise returns FALSE. A widget will be invalid if the system has no OpenGL support. -.SH "void QGLWidget::makeCurrent ()\fC [virtual]\fR" -Makes this widget the current widget for OpenGL operations, i.e. makes the widget's rendering context the current OpenGL rendering context. -.SH "void QGLWidget::makeOverlayCurrent ()\fC [virtual]\fR" -Makes the overlay context of this widget current. Use this if you need to issue OpenGL commands to the overlay context outside of initializeOverlayGL(), resizeOverlayGL(), and paintOverlayGL(). -.PP -Does nothing if this widget has no overlay. -.PP -See also makeCurrent(). -.SH "const QGLContext * QGLWidget::overlayContext () const" -Returns the overlay context of this widget, or 0 if this widget has no overlay. -.PP -See also context(). -.SH "void QGLWidget::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" -Handles paint events. Will cause the virtual paintGL() function to be called. -.PP -The widget's rendering context will become the current context and initializeGL() will be called if it hasn't already been called. -.PP -Reimplemented from QWidget. -.SH "void QGLWidget::paintGL ()\fC [virtual protected]\fR" -This virtual function is called whenever the widget needs to be painted. Reimplement it in a subclass. -.PP -There is no need to call makeCurrent() because this has already been done when this function is called. -.SH "void QGLWidget::paintOverlayGL ()\fC [virtual protected]\fR" -This virtual function is used in the same manner as paintGL() except that it operates on the widget's overlay context instead of the widget's main context. This means that paintOverlayGL() is called whenever the widget's overlay needs to be painted. Reimplement it in a subclass. -.PP -There is no need to call makeOverlayCurrent() because this has already been done when this function is called. -.SH "void QGLWidget::qglClearColor ( const QColor & c ) const" -Convenience function for specifying the clearing color to OpenGL. Calls glClearColor (in RGBA mode) or glClearIndex (in color-index mode) with the color \fIc\fR. Applies to the current GL context. -.PP -See also qglColor(), QGLContext::currentContext(), and QColor. -.SH "void QGLWidget::qglColor ( const QColor & c ) const" -Convenience function for specifying a drawing color to OpenGL. Calls glColor3 (in RGBA mode) or glIndex (in color-index mode) with the color \fIc\fR. Applies to the current GL context. -.PP -See also qglClearColor(), QGLContext::currentContext(), and QColor. -.SH "QPixmap QGLWidget::renderPixmap ( int w = 0, int h = 0, bool useContext = FALSE )\fC [virtual]\fR" -Renders the current scene on a pixmap and returns the pixmap. -.PP -You can use this method on both visible and invisible QGLWidgets. -.PP -This method will create a pixmap and a temporary QGLContext to render on the pixmap. It will then call initializeGL(), resizeGL(), and paintGL() on this context. Finally, the widget's original GL context is restored. -.PP -The size of the pixmap will be \fIw\fR pixels wide and \fIh\fR pixels high unless one of these parameters is 0 (the default), in which case the pixmap will have the same size as the widget. -.PP -If \fIuseContext\fR is TRUE, this method will try to be more efficient by using the existing GL context to render the pixmap. The default is FALSE. Only use TRUE if you understand the risks. -.PP -Overlays are not rendered onto the pixmap. -.PP -If the GL rendering context and the desktop have different bit depths, the result will most likely look surprising. -.PP -Note that the creation of display lists, modifications of the view frustum etc. should be done from within initializeGL(). If this is not done, the temporary QGLContext will not be initialized properly, and the rendered pixmap may be incomplete/corrupted. -.SH "void QGLWidget::renderText ( int x, int y, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" -Renders the string \fIstr\fR into the GL context of this widget. -.PP -\fIx\fR and \fIy\fR are specified in window coordinates, with the origin in the upper left-hand corner of the window. If \fIfnt\fR is not specified, the currently set application font will be used to render the string. To change the color of the rendered text you can use the glColor() call (or the qglColor() convenience function), just before the renderText() call. Note that if you have GL_LIGHTING enabled, the string will not appear in the color you want. You should therefore switch lighting off before using renderText(). -.PP -\fIlistBase\fR specifies the index of the first display list that is generated by this function. The default value is 2000. 256 display lists will be generated, one for each of the first 256 characters in the font that is used to render the string. If several fonts are used in the same widget, the display lists for these fonts will follow the last generated list. You would normally not have to change this value unless you are using lists in the same range. The lists are deleted when the widget is destroyed. -.PP -Note: This function only works reliably with ASCII strings. -.SH "void QGLWidget::renderText ( double x, double y, double z, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIx\fR, \fIy\fR and \fIz\fR are specified in scene or object coordinates relative to the currently set projection and model matrices. This can be useful if you want to annotate models with text labels and have the labels move with the model as it is rotated etc. -.SH "void QGLWidget::resizeEvent ( QResizeEvent * )\fC [virtual protected]\fR" -Handles resize events. Calls the virtual function resizeGL(). -.PP -Reimplemented from QWidget. -.SH "void QGLWidget::resizeGL ( int width, int height )\fC [virtual protected]\fR" -This virtual function is called whenever the widget has been resized. The new size is passed in \fIwidth\fR and \fIheight\fR. Reimplement it in a subclass. -.PP -There is no need to call makeCurrent() because this has already been done when this function is called. -.SH "void QGLWidget::resizeOverlayGL ( int width, int height )\fC [virtual protected]\fR" -This virtual function is used in the same manner as paintGL() except that it operates on the widget's overlay context instead of the widget's main context. This means that resizeOverlayGL() is called whenever the widget has been resized. The new size is passed in \fIwidth\fR and \fIheight\fR. Reimplement it in a subclass. -.PP -There is no need to call makeOverlayCurrent() because this has already been done when this function is called. -.SH "void QGLWidget::setAutoBufferSwap ( bool on )\fC [protected]\fR" -If \fIon\fR is TRUE automatic GL buffer swapping is switched on; otherwise it is switched off. -.PP -If \fIon\fR is TRUE and the widget is using a double-buffered format, the background and foreground GL buffers will automatically be swapped after each paintGL() call. -.PP -The buffer auto-swapping is on by default. -.PP -See also autoBufferSwap(), doubleBuffer(), and swapBuffers(). -.SH "void QGLWidget::setColormap ( const QGLColormap & cmap )" -Set the colormap for this widget to \fIcmap\fR. Usually it is only top-level widgets that can have colormaps installed. -.PP -See also colormap(). -.SH "void QGLWidget::swapBuffers ()\fC [virtual]\fR" -Swaps the screen contents with an off-screen buffer. This only works if the widget's format specifies double buffer mode. -.PP -Normally, there is no need to explicitly call this function because it is done automatically after each widget repaint, i.e. each time after paintGL() has been executed. -.PP -See also doubleBuffer(), setAutoBufferSwap(), and QGLFormat::setDoubleBuffer(). -.SH "void QGLWidget::updateGL ()\fC [virtual slot]\fR" -Updates the widget by calling glDraw(). -.SH "void QGLWidget::updateOverlayGL ()\fC [virtual slot]\fR" -Updates the widget's overlay (if any). Will cause the virtual function paintOverlayGL() to be executed. -.PP -The widget's rendering context will become the current context and -initializeGL() will be called if it hasn't already been called. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qglwidget.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qglwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgrid.3qt b/doc/man/man3/qgrid.3qt deleted file mode 100644 index 7717e2e26..000000000 --- a/doc/man/man3/qgrid.3qt +++ /dev/null @@ -1,75 +0,0 @@ -'\" t -.TH QGrid 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 -QGrid \- Simple geometry management of its children -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGrid\fR ( int n, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQGrid\fR ( int n, Orientation orient, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "void \fBsetSpacing\fR ( int space )" -.br -.in -1c -.SH DESCRIPTION -The QGrid widget provides simple geometry management of its children. -.PP -The grid places its widgets either in columns or in rows depending on its orientation. -.PP -The number of rows \fIor\fR columns is defined in the constructor. All the grid's children will be placed and sized in accordance with their sizeHint() and sizePolicy(). -.PP -Use setMargin() to add space around the grid itself, and setSpacing() to add space between the widgets. -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.PP -See also QVBox, QHBox, QGridLayout, Widget Appearance and Style, and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGrid::QGrid ( int n, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a grid widget with parent \fIparent\fR, called \fIname\fR. \fIn\fR specifies the number of columns. The widget flags \fIf\fR are passed to the QFrame constructor. -.SH "QGrid::QGrid ( int n, Orientation orient, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a grid widget with parent \fIparent\fR, called \fIname\fR. If \fIorient\fR is Horizontal, \fIn\fR specifies the number of columns. If \fIorient\fR is Vertical, \fIn\fR specifies the number of rows. The widget flags \fIf\fR are passed to the QFrame constructor. -.SH "void QGrid::setSpacing ( int space )" -Sets the spacing between the child widgets to \fIspace\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqgrid.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgrid.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgridlayout.3qt b/doc/man/man3/qgridlayout.3qt deleted file mode 100644 index a62e64b4e..000000000 --- a/doc/man/man3/qgridlayout.3qt +++ /dev/null @@ -1,390 +0,0 @@ -'\" t -.TH QGridLayout 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 -QGridLayout \- Lays out widgets in a grid -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QLayout. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGridLayout\fR ( QWidget * parent, int nRows = 1, int nCols = 1, int margin = 0, int space = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQGridLayout\fR ( int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQGridLayout\fR ( QLayout * parentLayout, int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QGridLayout\fR ()" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBminimumSize\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBmaximumSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRowStretch\fR ( int row, int stretch )" -.br -.ti -1c -.BI "virtual void \fBsetColStretch\fR ( int col, int stretch )" -.br -.ti -1c -.BI "int \fBrowStretch\fR ( int row ) const" -.br -.ti -1c -.BI "int \fBcolStretch\fR ( int col ) const" -.br -.ti -1c -.BI "void \fBsetRowSpacing\fR ( int row, int minSize )" -.br -.ti -1c -.BI "void \fBsetColSpacing\fR ( int col, int minSize )" -.br -.ti -1c -.BI "int \fBrowSpacing\fR ( int row ) const" -.br -.ti -1c -.BI "int \fBcolSpacing\fR ( int col ) const" -.br -.ti -1c -.BI "int \fBnumRows\fR () const" -.br -.ti -1c -.BI "int \fBnumCols\fR () const" -.br -.ti -1c -.BI "QRect \fBcellGeometry\fR ( int row, int col ) const" -.br -.ti -1c -.BI "virtual bool \fBhasHeightForWidth\fR () const" -.br -.ti -1c -.BI "virtual int \fBheightForWidth\fR ( int w ) const" -.br -.ti -1c -.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" -.br -.ti -1c -.BI "virtual void \fBinvalidate\fR ()" -.br -.ti -1c -.BI "virtual void \fBaddItem\fR ( QLayoutItem * item )" -.br -.ti -1c -.BI "void \fBaddItem\fR ( QLayoutItem * item, int row, int col )" -.br -.ti -1c -.BI "void \fBaddMultiCell\fR ( QLayoutItem * item, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" -.br -.ti -1c -.BI "void \fBaddWidget\fR ( QWidget * w, int row, int col, int alignment = 0 )" -.br -.ti -1c -.BI "void \fBaddMultiCellWidget\fR ( QWidget * w, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" -.br -.ti -1c -.BI "void \fBaddLayout\fR ( QLayout * layout, int row, int col )" -.br -.ti -1c -.BI "void \fBaddMultiCellLayout\fR ( QLayout * layout, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" -.br -.ti -1c -.BI "void addRowSpacing ( int row, int minsize ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void addColSpacing ( int col, int minsize ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBexpand\fR ( int nRows, int nCols )" -.br -.ti -1c -.BI "enum \fBCorner\fR { TopLeft, TopRight, BottomLeft, BottomRight }" -.br -.ti -1c -.BI "void \fBsetOrigin\fR ( Corner c )" -.br -.ti -1c -.BI "Corner \fBorigin\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "bool \fBfindWidget\fR ( QWidget * w, int * row, int * col )" -.br -.ti -1c -.BI "void \fBadd\fR ( QLayoutItem * item, int row, int col )" -.br -.in -1c -.SH DESCRIPTION -The QGridLayout class lays out widgets in a grid. -.PP -QGridLayout takes the space made available to it (by its parent layout or by the mainWidget()), divides it up into rows and columns, and puts each widget it manages into the correct cell. -.PP -Columns and rows behave identically; we will discuss columns, but there are equivalent functions for rows. -.PP -Each column has a minimum width and a stretch factor. The minimum width is the greatest of that set using addColSpacing() and the minimum width of each widget in that column. The stretch factor is set using setColStretch() and determines how much of the available space the column will get over and above its necessary minimum. -.PP -Normally, each managed widget or layout is put into a cell of its own using addWidget(), addLayout() or by the auto-add facility. It is also possible for a widget to occupy multiple cells using addMultiCellWidget(). If you do this, QGridLayout will guess how to distribute the size over the columns/rows (based on the stretch factors). -.PP -To remove a widget from a layout, call remove(). Calling QWidget::hide() on a widget also effectively removes the widget from the layout until QWidget::show() is called. -.PP -This illustration shows a fragment of a dialog with a five-column, three-row grid (the grid is shown overlaid in magenta): -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.PP -Columns 0, 2 and 4 in this dialog fragment are made up of a QLabel, a QLineEdit, and a QListBox. Columns 1 and 3 are placeholders made with addColSpacing(). Row 0 consists of three QLabel objects, row 1 of three QLineEdit objects and row 2 of three QListBox objects. We used placeholder columns (1 and 3) to get the right amount of space between the columns. -.PP -Note that the columns and rows are not equally wide or tall. If you want two columns to have the same width, you must set their minimum widths and stretch factors to be the same yourself. You do this using addColSpacing() and setColStretch(). -.PP -If the QGridLayout is not the top-level layout (i.e. does not manage all of the widget's area and children), you must add it to its parent layout when you create it, but before you do anything with it. The normal way to add a layout is by calling parentLayout->addLayout(). -.PP -Once you have added your layout you can start putting widgets and other layouts into the cells of your grid layout using addWidget(), addLayout() and addMultiCellWidget(). -.PP -QGridLayout also includes two margin widths: the border and the spacing. The border is the width of the reserved space along each of the QGridLayout's four sides. The spacing is the width of the automatically allocated spacing between neighboring boxes. -.PP -Both the border and the spacing are parameters of the constructor and default to 0. -.PP -See also QGrid, Layout Overview, Widget Appearance and Style, and Layout Management. -.SS "Member Type Documentation" -.SH "QGridLayout::Corner" -This enum identifies which corner is the origin (0, 0) of the layout. -.TP -\fCQGridLayout::TopLeft\fR - the top-left corner -.TP -\fCQGridLayout::TopRight\fR - the top-right corner -.TP -\fCQGridLayout::BottomLeft\fR - the bottom-left corner -.TP -\fCQGridLayout::BottomRight\fR - the bottom-right corner -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGridLayout::QGridLayout ( QWidget * parent, int nRows = 1, int nCols = 1, int margin = 0, int space = -1, const char * name = 0 )" -Constructs a new QGridLayout with \fInRows\fR rows, \fInCols\fR columns and parent widget, \fIparent\fR. \fIparent\fR may not be 0. The grid layout is called \fIname\fR. -.PP -\fImargin\fR is the number of pixels between the edge of the widget and its managed children. \fIspace\fR is the default number of pixels between cells. If \fIspace\fR is -1, the value of \fImargin\fR is used. -.SH "QGridLayout::QGridLayout ( int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" -Constructs a new grid with \fInRows\fR rows and \fInCols\fR columns. If \fIspacing\fR is -1, this QGridLayout inherits its parent's spacing(); otherwise \fIspacing\fR is used. The grid layout is called \fIname\fR. -.PP -You must insert this grid into another layout. You can insert widgets and layouts into this layout at any time, but laying out will not be performed before this is inserted into another layout. -.SH "QGridLayout::QGridLayout ( QLayout * parentLayout, int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" -Constructs a new grid that is placed inside \fIparentLayout\fR with \fInRows\fR rows and \fInCols\fR columns. If \fIspacing\fR is -1, this QGridLayout inherits its parent's spacing(); otherwise \fIspacing\fR is used. The grid layout is called \fIname\fR. -.PP -This grid is placed according to \fIparentLayout\fR's default placement rules. -.SH "QGridLayout::~QGridLayout ()" -Destroys the grid layout. Geometry management is terminated if this is a top-level grid. -.PP -The layout's widgets aren't destroyed. -.SH "void QGridLayout::add ( QLayoutItem * item, int row, int col )\fC [protected]\fR" -Adds \fIitem\fR at position \fIrow\fR, \fIcol\fR. The layout takes ownership of the \fIitem\fR. -.SH "void QGridLayout::addColSpacing ( int col, int minsize )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the minimum width of column \fIcol\fR to \fIminsize\fR pixels. -.PP -Use setColSpacing() instead. -.SH "void QGridLayout::addItem ( QLayoutItem * item, int row, int col )" -Adds \fIitem\fR at position \fIrow\fR, \fIcol\fR. The layout takes ownership of the \fIitem\fR. -.SH "void QGridLayout::addItem ( QLayoutItem * item )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds \fIitem\fR to the next free position of this layout. -.PP -Reimplemented from QLayout. -.SH "void QGridLayout::addLayout ( QLayout * layout, int row, int col )" -Places the \fIlayout\fR at position (\fIrow\fR, \fIcol\fR) in the grid. The top-left position is (0, 0). -.PP -\fIlayout\fR becomes a child of the grid layout. -.PP -When a layout is constructed with another layout as its parent, you don't need to call addLayout(); the child layout is automatically added to the parent layout as it is constructed. -.PP -See also addMultiCellLayout(). -.PP -Examples: -.)l listbox/listbox.cpp, progressbar/progressbar.cpp, t10/main.cpp, and t13/gamebrd.cpp. -.SH "void QGridLayout::addMultiCell ( QLayoutItem * item, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" -Adds the \fIitem\fR to the cell grid, spanning multiple rows/columns. -.PP -The cell will span from \fIfromRow\fR, \fIfromCol\fR to \fItoRow\fR, \fItoCol\fR. Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. -.SH "void QGridLayout::addMultiCellLayout ( QLayout * layout, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" -Adds the layout \fIlayout\fR to the cell grid, spanning multiple rows/columns. The cell will span from \fIfromRow\fR, \fIfromCol\fR to \fItoRow\fR, \fItoCol\fR. -.PP -Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. -.PP -A non-zero alignment indicates that the layout should not grow to fill the available space but should be sized according to sizeHint(). -.PP -\fIlayout\fR becomes a child of the grid layout. -.PP -See also addLayout(). -.SH "void QGridLayout::addMultiCellWidget ( QWidget * w, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" -Adds the widget \fIw\fR to the cell grid, spanning multiple rows/columns. The cell will span from \fIfromRow\fR, \fIfromCol\fR to \fItoRow\fR, \fItoCol\fR. -.PP -Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. -.PP -A non-zero alignment indicates that the widget should not grow to fill the available space but should be sized according to sizeHint(). -.PP -See also addWidget(). -.PP -Examples: -.)l cursor/cursor.cpp, layout/layout.cpp, and progressbar/progressbar.cpp. -.SH "void QGridLayout::addRowSpacing ( int row, int minsize )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the minimum height of row \fIrow\fR to \fIminsize\fR pixels. -.PP -Use setRowSpacing() instead. -.SH "void QGridLayout::addWidget ( QWidget * w, int row, int col, int alignment = 0 )" -Adds the widget \fIw\fR to the cell grid at \fIrow\fR, \fIcol\fR. The top-left position is (0, 0) by default. -.PP -Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. -.TP -You should not call this if you have enabled the auto-add facility of the layout. -.IP -.TP -From Qt 3.0, the \fIalignment\fR parameter is interpreted more aggressively than in previous versions of Qt. A non-default alignment now indicates that the widget should not grow to fill the available space, but should be sized according to sizeHint(). -.PP -See also addMultiCellWidget(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, layout/layout.cpp, rot13/rot13.cpp, sql/overview/form1/main.cpp, sql/overview/form2/main.cpp, t14/gamebrd.cpp, and t8/main.cpp. -.SH "QRect QGridLayout::cellGeometry ( int row, int col ) const" -Returns the geometry of the cell with row \fIrow\fR and column \fIcol\fR in the grid. Returns an invalid rectangle if \fIrow\fR or \fIcol\fR is outside the grid. -.PP -\fBWarning:\fR in the current version of Qt this function does not return valid results until setGeometry() has been called, i.e. after the mainWidget() is visible. -.SH "int QGridLayout::colSpacing ( int col ) const" -Returns the column spacing for column \fIcol\fR. -.PP -See also setColSpacing(). -.SH "int QGridLayout::colStretch ( int col ) const" -Returns the stretch factor for column \fIcol\fR. -.PP -See also setColStretch(). -.SH "void QGridLayout::expand ( int nRows, int nCols )" -Expands this grid so that it will have \fInRows\fR rows and \fInCols\fR columns. Will not shrink the grid. You should not need to call this function because QGridLayout expands automatically as new items are inserted. -.SH "QSizePolicy::ExpandData QGridLayout::expanding () const\fC [virtual]\fR" -Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions. -.PP -Reimplemented from QLayout. -.SH "bool QGridLayout::findWidget ( QWidget * w, int * row, int * col )\fC [protected]\fR" -Searches for widget \fIw\fR in this layout (not including child layouts). If \fIw\fR is found, it sets \fCrow\fR and \fCcol\fR to the row and column and returns TRUE; otherwise returns FALSE. -.PP -Note: if a widget spans multiple rows/columns, the top-left cell is returned. -.SH "bool QGridLayout::hasHeightForWidth () const\fC [virtual]\fR" -Returns TRUE if this layout's preferred height depends on its width; otherwise returns FALSE. -.PP -Reimplemented from QLayoutItem. -.SH "int QGridLayout::heightForWidth ( int w ) const\fC [virtual]\fR" -Returns the layout's preferred height when it is \fIw\fR pixels wide. -.PP -Reimplemented from QLayoutItem. -.SH "void QGridLayout::invalidate ()\fC [virtual]\fR" -Resets cached information. -.PP -Reimplemented from QLayout. -.SH "QSize QGridLayout::maximumSize () const\fC [virtual]\fR" -Returns the maximum size needed by this grid. -.PP -Reimplemented from QLayout. -.SH "QSize QGridLayout::minimumSize () const\fC [virtual]\fR" -Returns the minimum size needed by this grid. -.PP -Reimplemented from QLayout. -.SH "int QGridLayout::numCols () const" -Returns the number of columns in this grid. -.SH "int QGridLayout::numRows () const" -Returns the number of rows in this grid. -.SH "Corner QGridLayout::origin () const" -Returns the corner that's used for the grid's origin, i.e. for position (0, 0). -.SH "int QGridLayout::rowSpacing ( int row ) const" -Returns the row spacing for row \fIrow\fR. -.PP -See also setRowSpacing(). -.SH "int QGridLayout::rowStretch ( int row ) const" -Returns the stretch factor for row \fIrow\fR. -.PP -See also setRowStretch(). -.SH "void QGridLayout::setColSpacing ( int col, int minSize )" -Sets the minimum width of column \fIcol\fR to \fIminSize\fR pixels. -.PP -See also colSpacing() and setRowSpacing(). -.SH "void QGridLayout::setColStretch ( int col, int stretch )\fC [virtual]\fR" -Sets the stretch factor of column \fIcol\fR to \fIstretch\fR. The first column is number 0. -.PP -The stretch factor is relative to the other columns in this grid. Columns with a higher stretch factor take more of the available space. -.PP -The default stretch factor is 0. If the stretch factor is 0 and no other column in this table can grow at all, the column may still grow. -.PP -See also colStretch(), addColSpacing(), and setRowStretch(). -.PP -Examples: -.)l layout/layout.cpp, t14/gamebrd.cpp, and t8/main.cpp. -.SH "void QGridLayout::setGeometry ( const QRect & r )\fC [virtual]\fR" -Resizes managed widgets within the rectangle \fIr\fR. -.PP -Reimplemented from QLayout. -.SH "void QGridLayout::setOrigin ( Corner c )" -Sets the grid's origin corner, i.e. position (0, 0), to \fIc\fR. -.SH "void QGridLayout::setRowSpacing ( int row, int minSize )" -Sets the minimum height of row \fIrow\fR to \fIminSize\fR pixels. -.PP -See also rowSpacing() and setColSpacing(). -.SH "void QGridLayout::setRowStretch ( int row, int stretch )\fC [virtual]\fR" -Sets the stretch factor of row \fIrow\fR to \fIstretch\fR. The first row is number 0. -.PP -The stretch factor is relative to the other rows in this grid. Rows with a higher stretch factor take more of the available space. -.PP -The default stretch factor is 0. If the stretch factor is 0 and no other row in this table can grow at all, the row may still grow. -.PP -See also rowStretch(), setRowSpacing(), and setColStretch(). -.PP -Examples: -.)l addressbook/centralwidget.cpp and qutlook/centralwidget.cpp. -.SH "QSize QGridLayout::sizeHint () const\fC [virtual]\fR" -Returns the preferred size of this grid. -.PP -Reimplemented from QLayoutItem. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qgridlayout.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgridlayout.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgridview.3qt b/doc/man/man3/qgridview.3qt deleted file mode 100644 index 42cb5f5ac..000000000 --- a/doc/man/man3/qgridview.3qt +++ /dev/null @@ -1,245 +0,0 @@ -'\" t -.TH QGridView 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 -QGridView \- Abstract base for fixed-size grids -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QScrollView. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGridView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QGridView\fR ()" -.br -.ti -1c -.BI "int \fBnumRows\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNumRows\fR ( int )" -.br -.ti -1c -.BI "int \fBnumCols\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNumCols\fR ( int )" -.br -.ti -1c -.BI "int \fBcellWidth\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCellWidth\fR ( int )" -.br -.ti -1c -.BI "int \fBcellHeight\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCellHeight\fR ( int )" -.br -.ti -1c -.BI "QRect \fBcellRect\fR () const" -.br -.ti -1c -.BI "QRect \fBcellGeometry\fR ( int row, int column )" -.br -.ti -1c -.BI "QSize \fBgridSize\fR () const" -.br -.ti -1c -.BI "int \fBrowAt\fR ( int y ) const" -.br -.ti -1c -.BI "int \fBcolumnAt\fR ( int x ) const" -.br -.ti -1c -.BI "void \fBrepaintCell\fR ( int row, int column, bool erase = TRUE )" -.br -.ti -1c -.BI "void \fBupdateCell\fR ( int row, int column )" -.br -.ti -1c -.BI "void \fBensureCellVisible\fR ( int row, int column )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBcellHeight\fR - the height of a grid row" -.br -.ti -1c -.BI "int \fBcellWidth\fR - the width of a grid column" -.br -.ti -1c -.BI "int \fBnumCols\fR - the number of columns in the grid" -.br -.ti -1c -.BI "int \fBnumRows\fR - the number of rows in the grid" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col ) = 0" -.br -.ti -1c -.BI "virtual void \fBpaintEmptyArea\fR ( QPainter * p, int cx, int cy, int cw, int ch )" -.br -.ti -1c -.BI "virtual void \fBdimensionChange\fR ( int oldNumRows, int oldNumCols )" -.br -.in -1c -.SH DESCRIPTION -The QGridView class provides an abstract base for fixed-size grids. -.PP -A grid view consists of a number of abstract cells organized in rows and columns. The cells have a fixed size and are identified with a row index and a column index. The top-left cell is in row 0, column 0. The bottom-right cell is in row numRows()-1, column numCols()-1. -.PP -You can define numRows, numCols, cellWidth and cellHeight. Reimplement the pure virtual function paintCell() to draw the contents of a cell. -.PP -With ensureCellVisible(), you can ensure a certain cell is visible. With rowAt() and columnAt() you can find a cell based on the given x- and y-coordinates. -.PP -If you need to monitor changes to the grid's dimensions (i.e. when numRows or numCols is changed), reimplement the dimensionChange() change handler. -.PP -Note: the row and column indices are always given in the order, row (vertical offset) then column (horizontal offset). This order is the opposite of all pixel operations, which are given in the order x (horizontal offset), y (vertical offset). -.PP -QGridView is a very simple abstract class based on QScrollView. It is designed to simplify the task of drawing many cells of the same size in a potentially scrollable canvas. If you need rows and columns with different sizes, use a QTable instead. If you need a simple list of items, use a QListBox. If you need to present hierachical data use a QListView, and if you need random objects at random positions, consider using either a QIconView or a QCanvas. -.PP -See also Abstract Widget Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGridView::QGridView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a grid view. -.PP -The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QScrollView constructor. -.SH "QGridView::~QGridView ()" -Destroys the grid view. -.SH "QRect QGridView::cellGeometry ( int row, int column )" -Returns the geometry of cell (\fIrow\fR, \fIcolumn\fR) in the content coordinate system. -.PP -See also cellRect(). -.SH "int QGridView::cellHeight () const" -Returns the height of a grid row. See the "cellHeight" property for details. -.SH "QRect QGridView::cellRect () const" -Returns the geometry of a cell in a cell's coordinate system. This is a convenience function useful in paintCell(). It is equivalent to QRect( 0, 0, cellWidth(), cellHeight() ). -.PP -See also cellGeometry(). -.SH "int QGridView::cellWidth () const" -Returns the width of a grid column. See the "cellWidth" property for details. -.SH "int QGridView::columnAt ( int x ) const" -Returns the number of the column at position \fIx\fR. \fIx\fR must be given in content coordinates. -.PP -See also rowAt(). -.SH "void QGridView::dimensionChange ( int oldNumRows, int oldNumCols )\fC [virtual protected]\fR" -This change handler is called whenever any of the grid's dimensions change. \fIoldNumRows\fR and \fIoldNumCols\fR contain the old dimensions, numRows() and numCols() contain the new dimensions. -.SH "void QGridView::ensureCellVisible ( int row, int column )" -Ensures cell (\fIrow\fR, \fIcolumn\fR) is visible, scrolling the grid view if necessary. -.SH "QSize QGridView::gridSize () const" -Returns the size of the grid in pixels. -.SH "int QGridView::numCols () const" -Returns the number of columns in the grid. See the "numCols" property for details. -.SH "int QGridView::numRows () const" -Returns the number of rows in the grid. See the "numRows" property for details. -.SH "void QGridView::paintCell ( QPainter * p, int row, int col )\fC [pure virtual protected]\fR" -This pure virtual function is called to paint the single cell at (\fIrow\fR, \fIcol\fR) using painter \fIp\fR. The painter must be open when paintCell() is called and must remain open. -.PP -The coordinate system is translated so that the origin is at the top-left corner of the cell to be painted, i.e. \fIcell\fR coordinates. Do not scale or shear the coordinate system (or if you do, restore the transformation matrix before you return). -.PP -The painter is not clipped by default in order to get maximum efficiency. If you want clipping, use -.PP -.nf -.br - p->setClipRect( cellRect(), QPainter::CoordPainter ); -.br - //... your drawing code -.br - p->setClipping( FALSE ); -.br -.br -.fi -.SH "void QGridView::paintEmptyArea ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" -This function fills the \fIcw\fR pixels wide and \fIch\fR pixels high rectangle starting at position (\fIcx\fR, \fIcy\fR) with the background color using the painter \fIp\fR. -.PP -paintEmptyArea() is invoked by drawContents() to erase or fill unused areas. -.SH "void QGridView::repaintCell ( int row, int column, bool erase = TRUE )" -Repaints cell (\fIrow\fR, \fIcolumn\fR). -.PP -If \fIerase\fR is TRUE, Qt erases the area of the cell before the paintCell() call; otherwise no erasing takes place. -.PP -See also QWidget::repaint(). -.SH "int QGridView::rowAt ( int y ) const" -Returns the number of the row at position \fIy\fR. \fIy\fR must be given in content coordinates. -.PP -See also columnAt(). -.SH "void QGridView::setCellHeight ( int )\fC [virtual]\fR" -Sets the height of a grid row. See the "cellHeight" property for details. -.SH "void QGridView::setCellWidth ( int )\fC [virtual]\fR" -Sets the width of a grid column. See the "cellWidth" property for details. -.SH "void QGridView::setNumCols ( int )\fC [virtual]\fR" -Sets the number of columns in the grid. See the "numCols" property for details. -.SH "void QGridView::setNumRows ( int )\fC [virtual]\fR" -Sets the number of rows in the grid. See the "numRows" property for details. -.SH "void QGridView::updateCell ( int row, int column )" -Updates cell (\fIrow\fR, \fIcolumn\fR). -.PP -See also QWidget::update(). -.SS "Property Documentation" -.SH "int cellHeight" -This property holds the height of a grid row. -.PP -All rows in a grid view have the same height. -.PP -See also cellWidth. -.PP -Set this property's value with setCellHeight() and get this property's value with cellHeight(). -.SH "int cellWidth" -This property holds the width of a grid column. -.PP -All columns in a grid view have the same width. -.PP -See also cellHeight. -.PP -Set this property's value with setCellWidth() and get this property's value with cellWidth(). -.SH "int numCols" -This property holds the number of columns in the grid. -.PP -Set this property's value with setNumCols() and get this property's value with numCols(). -.PP -See also numRows. -.SH "int numRows" -This property holds the number of rows in the grid. -.PP -Set this property's value with setNumRows() and get this property's value with numRows(). -.PP -See also numCols. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqgridview.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgridview.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qgroupbox.3qt b/doc/man/man3/qgroupbox.3qt deleted file mode 100644 index 37ac77bb2..000000000 --- a/doc/man/man3/qgroupbox.3qt +++ /dev/null @@ -1,329 +0,0 @@ -'\" t -.TH QGroupBox 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 -QGroupBox \- Group box frame with a title -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -Inherited by QButtonGroup, QHGroupBox, and QVGroupBox. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGroupBox\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQGroupBox\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQGroupBox\fR ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQGroupBox\fR ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QGroupBox\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetColumnLayout\fR ( int strips, Orientation direction )" -.br -.ti -1c -.BI "QString \fBtitle\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTitle\fR ( const QString & )" -.br -.ti -1c -.BI "int \fBalignment\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAlignment\fR ( int )" -.br -.ti -1c -.BI "int \fBcolumns\fR () const" -.br -.ti -1c -.BI "void \fBsetColumns\fR ( int )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "void \fBsetOrientation\fR ( Orientation )" -.br -.ti -1c -.BI "int \fBinsideMargin\fR () const" -.br -.ti -1c -.BI "int \fBinsideSpacing\fR () const" -.br -.ti -1c -.BI "void \fBsetInsideMargin\fR ( int m )" -.br -.ti -1c -.BI "void \fBsetInsideSpacing\fR ( int s )" -.br -.ti -1c -.BI "void \fBaddSpace\fR ( int size )" -.br -.ti -1c -.BI "bool \fBisFlat\fR () const" -.br -.ti -1c -.BI "void \fBsetFlat\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisCheckable\fR () const" -.br -.ti -1c -.BI "void \fBsetCheckable\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisChecked\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBsetChecked\fR ( bool b )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBtoggled\fR ( bool on )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "Alignment \fBalignment\fR - the alignment of the group box title" -.br -.ti -1c -.BI "bool \fBcheckable\fR - whether the group box has a checkbox in its title" -.br -.ti -1c -.BI "bool \fBchecked\fR - whether the group box's checkbox is checked" -.br -.ti -1c -.BI "int \fBcolumns\fR - the number of columns or rows (depending on \\l QGroupBox::orientation) in the group box" -.br -.ti -1c -.BI "bool \fBflat\fR - whether the group box is painted flat or has a frame" -.br -.ti -1c -.BI "Orientation \fBorientation\fR - the group box's orientation" -.br -.ti -1c -.BI "QString \fBtitle\fR - the group box title text" -.br -.in -1c -.SH DESCRIPTION -The QGroupBox widget provides a group box frame with a title. -.PP -A group box provides a frame, a title and a keyboard shortcut, and displays various other widgets inside itself. The title is on top, the keyboard shortcut moves keyboard focus to one of the group box's child widgets, and the child widgets are usually laid out horizontally (or vertically) inside the frame. -.PP -The simplest way to use it is to create a group box with the desired number of columns (or rows) and orientation, and then just create widgets with the group box as parent. -.PP -It is also possible to change the orientation() and number of columns() after construction, or to ignore all the automatic layout support and manage the layout yourself. You can add 'empty' spaces to the group box with addSpace(). -.PP -QGroupBox also lets you set the title() (normally set in the constructor) and the title's alignment(). -.PP -You can change the spacing used by the group box with setInsideMargin() and setInsideSpacing(). To minimize space consumption, you can remove the right, left and bottom edges of the frame with setFlat(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP -See also QButtonGroup, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGroupBox::QGroupBox ( QWidget * parent = 0, const char * name = 0 )" -Constructs a group box widget with no title. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.PP -This constructor does not do automatic layout. -.SH "QGroupBox::QGroupBox ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a group box with the title \fItitle\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.PP -This constructor does not do automatic layout. -.SH "QGroupBox::QGroupBox ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" -Constructs a group box with no title. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QGroupBox::QGroupBox ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a group box titled \fItitle\fR. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QGroupBox::~QGroupBox ()" -Destroys the group box. -.SH "void QGroupBox::addSpace ( int size )" -Adds an empty cell at the next free position. If \fIsize\fR is greater than 0, the empty cell takes \fIsize\fR to be its fixed width (if orientation() is Horizontal) or height (if orientation() is Vertical). -.PP -Use this method to separate the widgets in the group box or to skip the next free cell. For performance reasons, call this method after calling setColumnLayout() or by changing the QGroupBox::columns or QGroupBox::orientation properties. It is generally a good idea to call these methods first (if needed at all), and insert the widgets and spaces afterwards. -.SH "int QGroupBox::alignment () const" -Returns the alignment of the group box title. See the "alignment" property for details. -.SH "int QGroupBox::columns () const" -Returns the number of columns or rows (depending on QGroupBox::orientation) in the group box. See the "columns" property for details. -.SH "int QGroupBox::insideMargin () const" -Returns the width of the empty space between the items in the group and the frame of the group. -.PP -Only applies if the group box has a defined orientation. -.PP -The default is usually 11, by may vary depending on the platform and style. -.PP -See also setInsideMargin() and orientation. -.SH "int QGroupBox::insideSpacing () const" -Returns the width of the empty space between each of the items in the group. -.PP -Only applies if the group box has a defined orientation. -.PP -The default is usually 5, by may vary depending on the platform and style. -.PP -See also setInsideSpacing() and orientation. -.SH "bool QGroupBox::isCheckable () const" -Returns TRUE if the group box has a checkbox in its title; otherwise returns FALSE. See the "checkable" property for details. -.SH "bool QGroupBox::isChecked () const" -Returns TRUE if the group box's checkbox is checked; otherwise returns FALSE. See the "checked" property for details. -.SH "bool QGroupBox::isFlat () const" -Returns TRUE if the group box is painted flat or has a frame; otherwise returns FALSE. See the "flat" property for details. -.SH "Orientation QGroupBox::orientation () const" -Returns the group box's orientation. See the "orientation" property for details. -.SH "void QGroupBox::setAlignment ( int )\fC [virtual]\fR" -Sets the alignment of the group box title. See the "alignment" property for details. -.SH "void QGroupBox::setCheckable ( bool b )" -Sets whether the group box has a checkbox in its title to \fIb\fR. See the "checkable" property for details. -.SH "void QGroupBox::setChecked ( bool b )\fC [slot]\fR" -Sets whether the group box's checkbox is checked to \fIb\fR. See the "checked" property for details. -.SH "void QGroupBox::setColumnLayout ( int strips, Orientation direction )\fC [virtual]\fR" -Changes the layout of the group box. This function is only useful in combination with the default constructor that does not take any layout information. This function will put all existing children in the new layout. It is not good Qt programming style to call this function after children have been inserted. Sets the number of columns or rows to be \fIstrips\fR, depending on \fIdirection\fR. -.PP -See also orientation and columns. -.PP -Example: chart/optionsform.cpp. -.SH "void QGroupBox::setColumns ( int )" -Sets the number of columns or rows (depending on QGroupBox::orientation) in the group box. See the "columns" property for details. -.SH "void QGroupBox::setFlat ( bool b )" -Sets whether the group box is painted flat or has a frame to \fIb\fR. See the "flat" property for details. -.SH "void QGroupBox::setInsideMargin ( int m )" -Sets the the width of the inside margin to \fIm\fR pixels. -.PP -See also insideMargin(). -.SH "void QGroupBox::setInsideSpacing ( int s )" -Sets the width of the empty space between each of the items in the group to \fIs\fR pixels. -.PP -See also insideSpacing(). -.SH "void QGroupBox::setOrientation ( Orientation )" -Sets the group box's orientation. See the "orientation" property for details. -.SH "void QGroupBox::setTitle ( const QString & )\fC [virtual]\fR" -Sets the group box title text. See the "title" property for details. -.SH "QString QGroupBox::title () const" -Returns the group box title text. See the "title" property for details. -.SH "void QGroupBox::toggled ( bool on )\fC [signal]\fR" -If the group box has a check box (see isCheckable()) this signal is emitted when the check box is toggled. \fIon\fR is TRUE if the check box is checked; otherwise it is FALSE. -.SS "Property Documentation" -.SH "Alignment alignment" -This property holds the alignment of the group box title. -.PP -The title is always placed on the upper frame line. The horizontal alignment can be specified by the alignment parameter. -.PP -The alignment is one of the following flags: -.TP -AlignAuto aligns the title according to the language, usually to the left. -.TP -AlignLeft aligns the title text to the left. -.TP -AlignRight aligns the title text to the right. -.TP -AlignHCenter aligns the title text centered. -.PP -The default alignment is AlignAuto. -.PP -See also Qt::AlignmentFlags. -.PP -Set this property's value with setAlignment() and get this property's value with alignment(). -.SH "bool checkable" -This property holds whether the group box has a checkbox in its title. -.PP -If this property is TRUE, the group box has a checkbox. If the checkbox is checked (which is the default), the group box's children are enabled. -.PP -setCheckable() controls whether or not the group box has a checkbox, and isCheckable() controls whether the checkbox is checked or not. -.PP -Set this property's value with setCheckable() and get this property's value with isCheckable(). -.SH "bool checked" -This property holds whether the group box's checkbox is checked. -.PP -If the group box has a check box (see isCheckable()), and the check box is checked (see isChecked()), the group box's children are enabled. If the checkbox is unchecked the children are disabled. -.PP -Set this property's value with setChecked() and get this property's value with isChecked(). -.SH "int columns" -This property holds the number of columns or rows (depending on QGroupBox::orientation) in the group box. -.PP -Usually it is not a good idea to set this property because it is slow (it does a complete layout). It is best to set the number of columns directly in the constructor. -.PP -Set this property's value with setColumns() and get this property's value with columns(). -.SH "bool flat" -This property holds whether the group box is painted flat or has a frame. -.PP -By default a group box has a surrounding frame, with the title being placed on the upper frame line. In flat mode the right, left and bottom frame lines are omitted, and only the thin line at the top is drawn. -.PP -See also title. -.PP -Set this property's value with setFlat() and get this property's value with isFlat(). -.SH "Orientation orientation" -This property holds the group box's orientation. -.PP -A horizontal group box arranges it's children in columns, while a vertical group box arranges them in rows. -.PP -Usually it is not a good idea to set this property because it is slow (it does a complete layout). It is better to set the orientation directly in the constructor. -.PP -Set this property's value with setOrientation() and get this property's value with orientation(). -.SH "QString title" -This property holds the group box title text. -.PP -The group box title text will have a focus-change keyboard accelerator if the title contains &, followed by a letter. -.PP -.nf -.br - g->setTitle( "&User information" ); -.br -.fi -This produces "User information"; Alt+U moves the keyboard focus to the group box. -.PP -There is no default title text. -.PP -Set this property's value with setTitle() and get this property's value with title(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqgroupbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qgroupbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qguardedptr.3qt b/doc/man/man3/qguardedptr.3qt deleted file mode 100644 index 11f362d4c..000000000 --- a/doc/man/man3/qguardedptr.3qt +++ /dev/null @@ -1,148 +0,0 @@ -'\" t -.TH QGuardedPtr 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 -QGuardedPtr \- Template class that provides guarded pointers to QObjects -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQGuardedPtr\fR ()" -.br -.ti -1c -.BI "\fBQGuardedPtr\fR ( T * p )" -.br -.ti -1c -.BI "\fBQGuardedPtr\fR ( const QGuardedPtr & p )" -.br -.ti -1c -.BI "\fB~QGuardedPtr\fR ()" -.br -.ti -1c -.BI "QGuardedPtr & \fBoperator=\fR ( const QGuardedPtr & p )" -.br -.ti -1c -.BI "QGuardedPtr & \fBoperator=\fR ( T * p )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QGuardedPtr & p ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QGuardedPtr & p ) const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "T * \fBoperator->\fR () const" -.br -.ti -1c -.BI "T & \fBoperator*\fR () const" -.br -.ti -1c -.BI "\fBoperator T *\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QGuardedPtr class is a template class that provides guarded pointers to QObjects. -.PP -A guarded pointer, \fCQGuardedPtr\fR, behaves like a normal C++ pointer \fCX*\fR, except that it is automatically set to 0 when the referenced object is destroyed (unlike normal C++ pointers, which become "dangling pointers" in such cases). \fCX\fR must be a subclass of QObject. -.PP -Guarded pointers are useful whenever you need to store a pointer to a QObject that is owned by someone else and therefore might be destroyed while you still hold a reference to it. You can safely test the pointer for validity. -.PP -Example: -.PP -.nf -.br - QGuardedPtr label = new QLabel( 0, "label" ); -.br - label->setText( "I like guarded pointers" ); -.br -.br - delete (QLabel*) label; // simulate somebody destroying the label -.br -.br - if ( label) -.br - label->show(); -.br - else -.br - tqDebug("The label has been destroyed"); -.br -.fi -.PP -The program will output \fCThe label has been destroyed\fR rather than dereferencing an invalid address in \fClabel->show()\fR. -.PP -The functions and operators available with a QGuardedPtr are the same as those available with a normal unguarded pointer, except the pointer arithmetic operators (++, --, -, and +), which are normally used only with arrays of objects. Use them like normal pointers and you will not need to read this class documentation. -.PP -For creating guarded pointers, you can construct or assign to them from an X* or from another guarded pointer of the same type. You can compare them with each other using operator==() and operator!=(), or test for 0 with isNull(). And you can dereference them using either the \fC*x\fR or the \fCx->member\fR notation. -.PP -A guarded pointer will automatically cast to an X*, so you can freely mix guarded and unguarded pointers. This means that if you have a QGuardedPtr, you can pass it to a function that requires a QWidget*. For this reason, it is of little value to declare functions to take a QGuardedPtr as a parameter; just use normal pointers. Use a QGuardedPtr when you are storing a pointer over time. -.PP -Note again that class \fIX\fR must inherit QObject, or a compilation or link error will result. -.PP -See also Object Model. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QGuardedPtr::QGuardedPtr ()" -Constructs a 0 guarded pointer. -.PP -See also isNull(). -.SH "QGuardedPtr::QGuardedPtr ( T * p )" -Constructs a guarded pointer that points to same object as \fIp\fR points to. -.SH "QGuardedPtr::QGuardedPtr ( const QGuardedPtr & p )" -Copy one guarded pointer from another. The constructed guarded pointer points to the same object that \fIp\fR points to (which may be 0). -.SH "QGuardedPtr::~QGuardedPtr ()" -Destroys the guarded pointer. Just like a normal pointer, destroying a guarded pointer does \fInot\fR destroy the object being pointed to. -.SH "bool QGuardedPtr::isNull () const" -Returns \fCTRUE\fR if the referenced object has been destroyed or if there is no referenced object; otherwise returns FALSE. -.SH "QGuardedPtr::operator T * () const" -Cast operator; implements pointer semantics. Because of this function you can pass a QGuardedPtr to a function where an X* is required. -.SH "bool QGuardedPtr::operator!= ( const QGuardedPtr & p ) const" -Inequality operator; implements pointer semantics, the negation of operator==(). Returns TRUE if \fIp\fR and this guarded pointer are not pointing to the same object; otherwise returns FALSE. -.SH "T & QGuardedPtr::operator* () const" -Dereference operator; implements pointer semantics. Just use this operator as you would with a normal C++ pointer. -.SH "T * QGuardedPtr::operator-> () const" -Overloaded arrow operator; implements pointer semantics. Just use this operator as you would with a normal C++ pointer. -.SH "QGuardedPtr & QGuardedPtr::operator= ( const QGuardedPtr & p )" -Assignment operator. This guarded pointer then points to the same object as \fIp\fR points to. -.SH "QGuardedPtr & QGuardedPtr::operator= ( T * p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assignment operator. This guarded pointer then points to the same object as \fIp\fR points to. -.SH "bool QGuardedPtr::operator== ( const QGuardedPtr & p ) const" -Equality operator; implements traditional pointer semantics. Returns TRUE if both \fIp\fR and this guarded pointer are 0, or if both \fIp\fR and this pointer point to the same object; otherwise returns FALSE. -.PP -See also operator!=(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqguardedptr.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qguardedptr.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhbox.3qt b/doc/man/man3/qhbox.3qt deleted file mode 100644 index 6a3d9eb9c..000000000 --- a/doc/man/man3/qhbox.3qt +++ /dev/null @@ -1,92 +0,0 @@ -'\" t -.TH QHBox 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 -QHBox \- Horizontal geometry management for its child widgets -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -Inherited by QVBox. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "void \fBsetSpacing\fR ( int space )" -.br -.ti -1c -.BI "bool \fBsetStretchFactor\fR ( QWidget * w, int stretch )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQHBox\fR ( bool horizontal, QWidget * parent, const char * name, WFlags f = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QHBox widget provides horizontal geometry management for its child widgets. -.PP -All the horizontal box's child widgets will be placed alongside each other and sized according to their sizeHint()s. -.PP -Use setMargin() to add space around the edges, and use setSpacing() to add space between the widgets. Use setStretchFactor() if you want the widgets to be different sizes in proportion to one another. (See Layouts for more information on stretch factors.) -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.PP -See also QHBoxLayout, QVBox, QGrid, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHBox::QHBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs an hbox widget with parent \fIparent\fR, called \fIname\fR. The parent, name and widget flags, \fIf\fR, are passed to the QFrame constructor. -.SH "QHBox::QHBox ( bool horizontal, QWidget * parent, const char * name, WFlags f = 0 )\fC [protected]\fR" -Constructs a horizontal hbox if \fIhorizontal\fR is TRUE, otherwise constructs a vertical hbox (also known as a vbox). -.PP -This constructor is provided for the QVBox class. You should never need to use it directly. -.PP -The \fIparent\fR, \fIname\fR and widget flags, \fIf\fR, are passed to the QFrame constructor. -.SH "void QHBox::setSpacing ( int space )" -Sets the spacing between the child widgets to \fIspace\fR. -.PP -Examples: -.)l i18n/mywidget.cpp, listboxcombo/listboxcombo.cpp, qdir/qdir.cpp, tabdialog/tabdialog.cpp, wizard/wizard.cpp, and xform/xform.cpp. -.SH "bool QHBox::setStretchFactor ( QWidget * w, int stretch )" -Sets the stretch factor of widget \fIw\fR to \fIstretch\fR. Returns TRUE if \fIw\fR is found. Otherwise returns FALSE. -.PP -See also QBoxLayout::setStretchFactor() and Layouts. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqhbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhboxlayout.3qt b/doc/man/man3/qhboxlayout.3qt deleted file mode 100644 index 96371ea92..000000000 --- a/doc/man/man3/qhboxlayout.3qt +++ /dev/null @@ -1,112 +0,0 @@ -'\" t -.TH QHBoxLayout 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 -QHBoxLayout \- Lines up widgets horizontally -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QBoxLayout. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHBoxLayout\fR ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQHBoxLayout\fR ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQHBoxLayout\fR ( int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QHBoxLayout\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QHBoxLayout class lines up widgets horizontally. -.PP -This class is used to construct horizontal box layout objects. See QBoxLayout for more details. -.PP -The simplest use of the class is like this: -.PP -.nf -.br - QBoxLayout * l = new QHBoxLayout( widget ); -.br - l->setAutoAdd( TRUE ); -.br - new QSomeWidget( widget ); -.br - new QSomeOtherWidget( widget ); -.br - new QAnotherWidget( widget ); -.br -.fi -.PP -or like this: -.PP -.nf -.br - QBoxLayout * l = new QHBoxLayout( widget ); -.br - l->addWidget( existingChildOfWidget ); -.br - l->addWidget( anotherChildOfWidget ); -.br -.fi -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.PP -See also QVBoxLayout, QGridLayout, the Layout overview, Widget Appearance and Style, and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHBoxLayout::QHBoxLayout ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" -Constructs a new top-level horizontal box called \fIname\fR, with parent \fIparent\fR. -.PP -The \fImargin\fR is the number of pixels between the edge of the widget and its managed children. The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1 the value of \fImargin\fR is used for \fIspacing\fR. -.SH "QHBoxLayout::QHBoxLayout ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" -Constructs a new horizontal box called name \fIname\fR and adds it to \fIparentLayout\fR. -.PP -The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QHBoxLayout will inherit its parent's spacing(). -.SH "QHBoxLayout::QHBoxLayout ( int spacing = -1, const char * name = 0 )" -Constructs a new horizontal box called name \fIname\fR. You must add it to another layout. -.PP -The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QHBoxLayout will inherit its parent's spacing(). -.SH "QHBoxLayout::~QHBoxLayout ()" -Destroys this box layout. -.PP -The layout's widgets aren't destroyed. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qhboxlayout.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhboxlayout.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhbuttongroup.3qt b/doc/man/man3/qhbuttongroup.3qt deleted file mode 100644 index 6d767ded5..000000000 --- a/doc/man/man3/qhbuttongroup.3qt +++ /dev/null @@ -1,75 +0,0 @@ -'\" t -.TH QHButtonGroup 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 -QHButtonGroup \- Organizes QButton widgets in a group with one horizontal row -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QButtonGroup. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHButtonGroup\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQHButtonGroup\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QHButtonGroup\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QHButtonGroup widget organizes QButton widgets in a group with one horizontal row. -.PP -QHButtonGroup is a convenience class that offers a thin layer on top of QButtonGroup. From a layout point of view it is effectively a QHBox that offers a frame with a title and is specifically designed for buttons. From a functionality point of view it is a QButtonGroup. -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.PP -See also QVButtonGroup, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHButtonGroup::QHButtonGroup ( QWidget * parent = 0, const char * name = 0 )" -Constructs a horizontal button group with no title. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QHButtonGroup::QHButtonGroup ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a horizontal button group with the title \fItitle\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QHButtonGroup::~QHButtonGroup ()" -Destroys the horizontal button group, deleting its child widgets. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqhbuttongroup.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhbuttongroup.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qheader.3qt b/doc/man/man3/qheader.3qt deleted file mode 100644 index b4b011151..000000000 --- a/doc/man/man3/qheader.3qt +++ /dev/null @@ -1,584 +0,0 @@ -'\" t -.TH QHeader 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 -QHeader \- Header row or column, e.g. for tables and listviews -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHeader\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQHeader\fR ( int n, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QHeader\fR ()" -.br -.ti -1c -.BI "int \fBaddLabel\fR ( const QString & s, int size = -1 )" -.br -.ti -1c -.BI "int \fBaddLabel\fR ( const QIconSet & iconset, const QString & s, int size = -1 )" -.br -.ti -1c -.BI "void \fBremoveLabel\fR ( int section )" -.br -.ti -1c -.BI "virtual void \fBsetLabel\fR ( int section, const QString & s, int size = -1 )" -.br -.ti -1c -.BI "virtual void \fBsetLabel\fR ( int section, const QIconSet & iconset, const QString & s, int size = -1 )" -.br -.ti -1c -.BI "QString \fBlabel\fR ( int section ) const" -.br -.ti -1c -.BI "QIconSet * \fBiconSet\fR ( int section ) const" -.br -.ti -1c -.BI "virtual void \fBsetOrientation\fR ( Orientation )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTracking\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBtracking\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetClickEnabled\fR ( bool enable, int section = -1 )" -.br -.ti -1c -.BI "virtual void \fBsetResizeEnabled\fR ( bool enable, int section = -1 )" -.br -.ti -1c -.BI "virtual void \fBsetMovingEnabled\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetStretchEnabled\fR ( bool b, int section )" -.br -.ti -1c -.BI "void \fBsetStretchEnabled\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisClickEnabled\fR ( int section = -1 ) const" -.br -.ti -1c -.BI "bool \fBisResizeEnabled\fR ( int section = -1 ) const" -.br -.ti -1c -.BI "bool \fBisMovingEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBisStretchEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBisStretchEnabled\fR ( int section ) const" -.br -.ti -1c -.BI "void \fBresizeSection\fR ( int section, int s )" -.br -.ti -1c -.BI "int \fBsectionSize\fR ( int section ) const" -.br -.ti -1c -.BI "int \fBsectionPos\fR ( int section ) const" -.br -.ti -1c -.BI "int \fBsectionAt\fR ( int pos ) const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "int \fBheaderWidth\fR () const" -.br -.ti -1c -.BI "QRect \fBsectionRect\fR ( int section ) const" -.br -.ti -1c -.BI "virtual void setCellSize ( int section, int s ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int cellSize ( int i ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int cellPos ( int i ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int cellAt ( int pos ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBoffset\fR () const" -.br -.ti -1c -.BI "int \fBmapToSection\fR ( int index ) const" -.br -.ti -1c -.BI "int \fBmapToIndex\fR ( int section ) const" -.br -.ti -1c -.BI "int mapToLogical ( int a ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int mapToActual ( int l ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBmoveSection\fR ( int section, int toIndex )" -.br -.ti -1c -.BI "virtual void moveCell ( int fromIdx, int toIdx ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setSortIndicator ( int section, bool ascending = TRUE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetSortIndicator\fR ( int section, SortOrder order )" -.br -.ti -1c -.BI "int \fBsortIndicatorSection\fR () const" -.br -.ti -1c -.BI "SortOrder \fBsortIndicatorOrder\fR () const" -.br -.ti -1c -.BI "void \fBadjustHeaderSize\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetOffset\fR ( int pos )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBclicked\fR ( int section )" -.br -.ti -1c -.BI "void \fBpressed\fR ( int section )" -.br -.ti -1c -.BI "void \fBreleased\fR ( int section )" -.br -.ti -1c -.BI "void \fBsizeChange\fR ( int section, int oldSize, int newSize )" -.br -.ti -1c -.BI "void \fBindexChange\fR ( int section, int fromIndex, int toIndex )" -.br -.ti -1c -.BI "void sectionClicked ( int index ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void moved ( int fromIndex, int toIndex ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsectionHandleDoubleClicked\fR ( int section )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBcount\fR - the number of sections in the header \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBmoving\fR - whether the header sections can be moved" -.br -.ti -1c -.BI "int \fBoffset\fR - the header's left-most (or top-most) visible pixel" -.br -.ti -1c -.BI "Orientation \fBorientation\fR - the header's orientation" -.br -.ti -1c -.BI "bool \fBstretching\fR - whether the header sections always take up the full width (or " "height" ") of the header" -.br -.ti -1c -.BI "bool \fBtracking\fR - whether the sizeChange() signal is emitted continuously" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "QRect \fBsRect\fR ( int index )" -.br -.ti -1c -.BI "virtual void \fBpaintSection\fR ( QPainter * p, int index, const QRect & fr )" -.br -.ti -1c -.BI "virtual void \fBpaintSectionLabel\fR ( QPainter * p, int index, const QRect & fr )" -.br -.in -1c -.SH DESCRIPTION -The QHeader class provides a header row or column, e.g. for tables and listviews. -.PP -This class provides a header, e.g. a vertical header to display row labels, or a horizontal header to display column labels. It is used by QTable and QListView for example. -.PP -A header is composed of one or more \fIsections\fR, each of which can display a text label and an iconset. A sort indicator (an arrow) can also be displayed using setSortIndicator(). -.PP -Sections are added with addLabel() and removed with removeLabel(). The label and iconset are set in addLabel() and can be changed later with setLabel(). Use count() to retrieve the number of sections in the header. -.PP -The orientation of the header is set with setOrientation(). If setStretchEnabled() is TRUE, the sections will expand to take up the full width (height for vertical headers) of the header. The user can resize the sections manually if setResizeEnabled() is TRUE. Call adjustHeaderSize() to have the sections resize to occupy the full width (or height). -.PP -A section can be moved with moveSection(). If setMovingEnabled() is TRUE (the default)the user may drag a section from one position to another. If a section is moved, the index positions at which sections were added (with addLabel()), may not be the same after the move. You don't have to worry about this in practice because the QHeader API works in terms of section numbers, so it doesn't matter where a particular section has been moved to. -.PP -If you want the current index position of a section call mapToIndex() giving it the section number. (This is the number returned by the addLabel() call which created the section.) If you want to get the section number of a section at a particular index position call mapToSection() giving it the index number. -.PP -Here's an example to clarify mapToSection() and mapToIndex(): -.PP -
                                .nf -.TS -l - l. Index positions 0 1 2 3 Original section ordering Sect 0 Sect 1 Sect 2 Sect 3 Ordering after the user moves a section Sect 0 Sect 2 Sect 3 -.TE -.fi -
                                -.PP -
                                .nf -.TS -l - l. \fIk\fR mapToSection(\fIk\fR) mapToIndex(\fIk\fR) 0 0 0 1 2 3 2 3 1 3 1 -.TE -.fi -
                                -.PP -In the example above, if we wanted to find out which section is at index position 3 we'd call mapToSection(3) and get a section number of 1 since section 1 was moved. Similarly, if we wanted to know which index position section 2 occupied we'd call mapToIndex(2) and get an index of 1. -.PP -QHeader provides the clicked(), pressed() and released() signals. If the user changes the size of a section, the sizeChange() signal is emitted. If you want to have a sizeChange() signal emitted continuously whilst the user is resizing (rather than just after the resizing is finished), use setTracking(). If the user moves a section the indexChange() signal is emitted. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QListView, QTable, and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHeader::QHeader ( QWidget * parent = 0, const char * name = 0 )" -Constructs a horizontal header called \fIname\fR, with parent \fIparent\fR. -.SH "QHeader::QHeader ( int n, QWidget * parent = 0, const char * name = 0 )" -Constructs a horizontal header called \fIname\fR, with \fIn\fR sections and parent \fIparent\fR. -.SH "QHeader::~QHeader ()" -Destroys the header and all its sections. -.SH "int QHeader::addLabel ( const QString & s, int size = -1 )" -Adds a new section with label text \fIs\fR. Returns the index position where the section was added (at the right for horizontal headers, at the bottom for vertical headers). The section's width is set to \fIsize\fR. If \fIsize\fR < 0, an appropriate size for the text \fIs\fR is chosen. -.SH "int QHeader::addLabel ( const QIconSet & iconset, const QString & s, int size = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a new section with iconset \fIiconset\fR and label text \fIs\fR. Returns the index position where the section was added (at the right for horizontal headers, at the bottom for vertical headers). The section's width is set to \fIsize\fR, unless size is negative in which case the size is calculated taking account of the size of the text. -.SH "void QHeader::adjustHeaderSize ()" -Adjusts the size of the sections to fit the size of the header as completely as possible. Only sections for which isStretchEnabled() is TRUE will be resized. -.SH "int QHeader::cellAt ( int pos ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use sectionAt() instead. -.PP -Returns the index at which the section is displayed, which contains \fIpos\fR in widget coordinates, or -1 if \fIpos\fR is outside the header sections. -.SH "int QHeader::cellPos ( int i ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use sectionPos() instead. -.PP -Returns the position in pixels of the section that is displayed at the index \fIi\fR. The position is measured from the start of the header. -.SH "int QHeader::cellSize ( int i ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use sectionSize() instead. -.PP -Returns the size in pixels of the section that is displayed at the index \fIi\fR. -.SH "void QHeader::clicked ( int section )\fC [signal]\fR" -If isClickEnabled() is TRUE, this signal is emitted when the user clicks section \fIsection\fR. -.PP -See also pressed() and released(). -.SH "int QHeader::count () const" -Returns the number of sections in the header. See the "count" property for details. -.SH "int QHeader::headerWidth () const" -Returns the total width of all the header columns. -.SH "QIconSet * QHeader::iconSet ( int section ) const" -Returns the icon set for section \fIsection\fR. If the section does not exist, 0 is returned. -.SH "void QHeader::indexChange ( int section, int fromIndex, int toIndex )\fC [signal]\fR" -This signal is emitted when the user moves section \fIsection\fR from index position \fIfromIndex\fR, to index position \fItoIndex\fR. -.SH "bool QHeader::isClickEnabled ( int section = -1 ) const" -Returns TRUE if section \fIsection\fR is clickable; otherwise returns FALSE. -.PP -If \fIsection\fR is out of range (negative or larger than count() - 1): returns TRUE if all sections are clickable; otherwise returns FALSE. -.PP -See also setClickEnabled(). -.SH "bool QHeader::isMovingEnabled () const" -Returns TRUE if the header sections can be moved; otherwise returns FALSE. See the "moving" property for details. -.SH "bool QHeader::isResizeEnabled ( int section = -1 ) const" -Returns TRUE if section \fIsection\fR is resizeable; otherwise returns FALSE. -.PP -If \fIsection\fR is -1 then this function applies to all sections, i.e. returns TRUE if all sections are resizeable; otherwise returns FALSE. -.PP -See also setResizeEnabled(). -.SH "bool QHeader::isStretchEnabled () const" -Returns TRUE if the header sections always take up the full width (or height) of the header; otherwise returns FALSE. See the "stretching" property for details. -.SH "bool QHeader::isStretchEnabled ( int section ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if section \fIsection\fR will resize to take up the full width (or height) of the header; otherwise returns FALSE. If at least one section has stretch enabled the sections will always take up the full width of the header. -.PP -See also setStretchEnabled(). -.SH "QString QHeader::label ( int section ) const" -Returns the text for section \fIsection\fR. If the section does not exist, a QString::null is returned. -.PP -Example: helpsystem/tooltip.cpp. -.SH "int QHeader::mapToActual ( int l ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use mapToIndex() instead. -.PP -Translates from logical index \fIl\fR to actual index (index at which the section \fIl\fR is displayed) . Returns -1 if \fIl\fR is outside the legal range. -.PP -See also mapToLogical(). -.SH "int QHeader::mapToIndex ( int section ) const" -Returns the index position corresponding to the specified \fIsection\fR number. -.PP -\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping exposed by this function will not reflect the order of the headers in the table; i.e., QTable does not call moveSection() to move sections but handles move operations internally. -.PP -See also mapToSection(). -.SH "int QHeader::mapToLogical ( int a ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use mapToSection() instead. -.PP -Translates from actual index \fIa\fR (index at which the section is displayed) to logical index of the section. Returns -1 if \fIa\fR is outside the legal range. -.PP -See also mapToActual(). -.SH "int QHeader::mapToSection ( int index ) const" -Returns the number of the section that corresponds to the specified \fIindex\fR. -.PP -\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping exposed by this function will not reflect the order of the headers in the table; i.e., QTable does not call moveSection() to move sections but handles move operations internally. -.PP -See also mapToIndex(). -.SH "void QHeader::moveCell ( int fromIdx, int toIdx )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use moveSection() instead. -.PP -Moves the section that is currently displayed at index \fIfromIdx\fR to index \fItoIdx\fR. -.SH "void QHeader::moveSection ( int section, int toIndex )" -Moves section \fIsection\fR to index position \fItoIndex\fR. -.SH "void QHeader::moved ( int fromIndex, int toIndex )\fC [signal]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use indexChange() instead. -.PP -This signal is emitted when the user has moved the section which is displayed at the index \fIfromIndex\fR to the index \fItoIndex\fR. -.SH "int QHeader::offset () const" -Returns the header's left-most (or top-most) visible pixel. See the "offset" property for details. -.SH "Orientation QHeader::orientation () const" -Returns the header's orientation. See the "orientation" property for details. -.SH "void QHeader::paintSection ( QPainter * p, int index, const QRect & fr )\fC [virtual protected]\fR" -Paints the section at position \fIindex\fR, inside rectangle \fIfr\fR (which uses widget coordinates) using painter \fIp\fR. -.PP -Calls paintSectionLabel(). -.SH "void QHeader::paintSectionLabel ( QPainter * p, int index, const QRect & fr )\fC [virtual protected]\fR" -Paints the label of the section at position \fIindex\fR, inside rectangle \fIfr\fR (which uses widget coordinates) using painter \fIp\fR. -.PP -Called by paintSection() -.SH "void QHeader::pressed ( int section )\fC [signal]\fR" -This signal is emitted when the user presses section \fIsection\fR down. -.PP -See also released(). -.SH "void QHeader::released ( int section )\fC [signal]\fR" -This signal is emitted when section \fIsection\fR is released. -.PP -See also pressed(). -.SH "void QHeader::removeLabel ( int section )" -Removes section \fIsection\fR. If the section does not exist, nothing happens. -.SH "void QHeader::resizeSection ( int section, int s )" -Resizes section \fIsection\fR to \fIs\fR pixels wide (or high). -.SH "QRect QHeader::sRect ( int index )\fC [protected]\fR" -Returns the rectangle covered by the section at index \fIindex\fR. -.SH "int QHeader::sectionAt ( int pos ) const" -Returns the index of the section which contains the position \fIpos\fR given in pixels from the left (or top). -.PP -See also offset. -.PP -Example: helpsystem/tooltip.cpp. -.SH "void QHeader::sectionClicked ( int index )\fC [signal]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use clicked() instead. -.PP -This signal is emitted when a part of the header is clicked. \fIindex\fR is the index at which the section is displayed. -.PP -In a list view this signal would typically be connected to a slot that sorts the specified column (or row). -.SH "void QHeader::sectionHandleDoubleClicked ( int section )\fC [signal]\fR" -This signal is emitted when the user doubleclicks on the edge (handle) of section \fIsection\fR. -.SH "int QHeader::sectionPos ( int section ) const" -Returns the position (in pixels) at which the \fIsection\fR starts. -.PP -See also offset. -.SH "QRect QHeader::sectionRect ( int section ) const" -Returns the rectangle covered by section \fIsection\fR. -.PP -Example: helpsystem/tooltip.cpp. -.SH "int QHeader::sectionSize ( int section ) const" -Returns the width (or height) of the \fIsection\fR in pixels. -.SH "void QHeader::setCellSize ( int section, int s )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use resizeSection() instead. -.PP -Sets the size of the section \fIsection\fR to \fIs\fR pixels. -.PP -\fBWarning:\fR does not repaint or send out signals -.SH "void QHeader::setClickEnabled ( bool enable, int section = -1 )\fC [virtual]\fR" -If \fIenable\fR is TRUE, any clicks on section \fIsection\fR will result in clicked() signals being emitted; otherwise the section will ignore clicks. -.PP -If \fIsection\fR is -1 (the default) then the \fIenable\fR value is set for all existing sections and will be applied to any new sections that are added. -.PP -See also moving and setResizeEnabled(). -.SH "void QHeader::setLabel ( int section, const QString & s, int size = -1 )\fC [virtual]\fR" -Sets the text of section \fIsection\fR to \fIs\fR. The section's width is set to \fIsize\fR if \fIsize\fR >= 0; otherwise it is left unchanged. Any icon set that has been set for this section remains unchanged. -.PP -If the section does not exist, nothing happens. -.PP -Examples: -.)l chart/setdataform.cpp and table/small-table-demo/main.cpp. -.SH "void QHeader::setLabel ( int section, const QIconSet & iconset, const QString & s, int size = -1 )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the icon for section \fIsection\fR to \fIiconset\fR and the text to \fIs\fR. The section's width is set to \fIsize\fR if \fIsize\fR >= 0; otherwise it is left unchanged. -.PP -If the section does not exist, nothing happens. -.SH "void QHeader::setMovingEnabled ( bool )\fC [virtual]\fR" -Sets whether the header sections can be moved. See the "moving" property for details. -.SH "void QHeader::setOffset ( int pos )\fC [virtual slot]\fR" -Sets the header's left-most (or top-most) visible pixel to \fIpos\fR. See the "offset" property for details. -.SH "void QHeader::setOrientation ( Orientation )\fC [virtual]\fR" -Sets the header's orientation. See the "orientation" property for details. -.SH "void QHeader::setResizeEnabled ( bool enable, int section = -1 )\fC [virtual]\fR" -If \fIenable\fR is TRUE the user may resize section \fIsection\fR; otherwise the section may not be manually resized. -.PP -If \fIsection\fR is negative (the default) then the \fIenable\fR value is set for all existing sections and will be applied to any new sections that are added. Example: -.PP -.nf -.br - // Allow resizing of all current and future sections -.br - header->setResizeEnabled(TRUE); -.br - // Disable resizing of section 3, (the fourth section added) -.br - header->setResizeEnabled(FALSE, 3); -.br -.fi -.PP -If the user resizes a section, a sizeChange() signal is emitted. -.PP -See also moving, setClickEnabled(), and tracking. -.SH "void QHeader::setSortIndicator ( int section, SortOrder order )" -Sets a sort indicator onto the specified \fIsection\fR. The indicator's \fIorder\fR is either Ascending or Descending. -.PP -Only one section can show a sort indicator at any one time. If you don't want any section to show a sort indicator pass a \fIsection\fR number of -1. -.PP -See also sortIndicatorSection() and sortIndicatorOrder(). -.SH "void QHeader::setSortIndicator ( int section, bool ascending = TRUE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use the other overload instead. -.SH "void QHeader::setStretchEnabled ( bool b, int section )\fC [virtual]\fR" -If \fIb\fR is TRUE, section \fIsection\fR will be resized when the header is resized, so that the sections take up the full width (or height for vertical headers) of the header; otherwise section \fIsection\fR will be set to be unstretchable and will not resize when the header is resized. -.PP -If \fIsection\fR is -1, and if \fIb\fR is TRUE, then all sections will be resized equally when the header is resized so that they take up the full width (or height for vertical headers) of the header; otherwise all the sections will be set to be unstretchable and will not resize when the header is resized. -.PP -See also adjustHeaderSize(). -.SH "void QHeader::setStretchEnabled ( bool b )" -Sets whether the header sections always take up the full width (or height) of the header to \fIb\fR. See the "stretching" property for details. -.SH "void QHeader::setTracking ( bool enable )\fC [virtual]\fR" -Sets whether the sizeChange() signal is emitted continuously to \fIenable\fR. See the "tracking" property for details. -.SH "void QHeader::sizeChange ( int section, int oldSize, int newSize )\fC [signal]\fR" -This signal is emitted when the user has changed the size of a \fIsection\fR from \fIoldSize\fR to \fInewSize\fR. This signal is typically connected to a slot that repaints the table or list that contains the header. -.SH "SortOrder QHeader::sortIndicatorOrder () const" -Returns the implied sort order of the QHeaders sort indicator. -.PP -See also setSortIndicator() and sortIndicatorSection(). -.SH "int QHeader::sortIndicatorSection () const" -Returns the section showing the sort indicator or -1 if there is no sort indicator. -.PP -See also setSortIndicator() and sortIndicatorOrder(). -.SH "bool QHeader::tracking () const" -Returns TRUE if the sizeChange() signal is emitted continuously; otherwise returns FALSE. See the "tracking" property for details. -.SS "Property Documentation" -.SH "int count" -This property holds the number of sections in the header. -.PP -Get this property's value with count(). -.SH "bool moving" -This property holds whether the header sections can be moved. -.PP -If this property is TRUE (the default) the user can move sections. If the user moves a section the indexChange() signal is emitted. -.PP -See also setClickEnabled() and setResizeEnabled(). -.PP -Set this property's value with setMovingEnabled() and get this property's value with isMovingEnabled(). -.SH "int offset" -This property holds the header's left-most (or top-most) visible pixel. -.PP -Setting this property will scroll the header so that \fIoffset\fR becomes the left-most (or top-most for vertical headers) visible pixel. -.PP -Set this property's value with setOffset() and get this property's value with offset(). -.SH "Orientation orientation" -This property holds the header's orientation. -.PP -The orientation is either Vertical or Horizontal (the default). -.PP -Call setOrientation() before adding labels if you don't provide a size parameter otherwise the sizes will be incorrect. -.PP -Set this property's value with setOrientation() and get this property's value with orientation(). -.SH "bool stretching" -This property holds whether the header sections always take up the full width (or height) of the header. -.PP -Set this property's value with setStretchEnabled() and get this property's value with isStretchEnabled(). -.SH "bool tracking" -This property holds whether the sizeChange() signal is emitted continuously. -.PP -If tracking is on, the sizeChange() signal is emitted continuously while the mouse is moved (i.e. when the header is resized), otherwise it is only emitted when the mouse button is released at the end of resizing. -.PP -Tracking defaults to FALSE. -.PP -Set this property's value with setTracking() and get this property's value with tracking(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqheader.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qheader.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhebrewcodec.3qt b/doc/man/man3/qhebrewcodec.3qt deleted file mode 100644 index 498f3124c..000000000 --- a/doc/man/man3/qhebrewcodec.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QHebrewCodec 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 -QHebrewCodec \- Conversion to and from visually ordered Hebrew -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                -.PP -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual const char * \fBmimeName\fR () const" -.br -.ti -1c -.BI "virtual QCString \fBfromUnicode\fR ( const QString & uc, int & lenInOut ) const" -.br -.in -1c -.SH DESCRIPTION -The QHebrewCodec class provides conversion to and from visually ordered Hebrew. -.PP -Hebrew as a semitic language is written from right to left. Because older computer systems couldn't handle reordering a string so that the first letter appears on the right, many older documents were encoded in visual order, so that the first letter of a line is the rightmost one in the string. -.PP -In contrast to this, Unicode defines characters to be in logical order (the order you would read the string). This codec tries to convert visually ordered Hebrew (8859-8) to Unicode. This might not always work perfectly, because reversing the \fIbidi\fR (bi-directional) algorithm that transforms from logical to visual order is non-trivial. -.PP -Transformation from Unicode to visual Hebrew (8859-8) is done using the bidi algorithm in Qt, and will produce correct results, so long as the codec is given the text a whole paragraph at a time. Places where newlines are supposed to go can be indicated by a newline character ('\\n'). Note that these newline characters change the reordering behaviour of the algorithm, since the bidi reordering only takes place within one line of text, whereas line breaks are determined in visual order. -.PP -Visually ordered Hebrew is still used quite often in some places, mainly in email communication (since most email programs still don't understand logically ordered Hebrew) and on web pages. The use on web pages is rapidly decreasing, due to the availability of browsers that correctly support logically ordered Hebrew. -.PP -This codec has the name "iso8859-8". If you don't want any bidi reordering to happen during conversion, use the "iso8859-8-i" codec, which assumes logical order for the 8-bit string. -.PP -See also Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QCString QHebrewCodec::fromUnicode ( const QString & uc, int & lenInOut ) const\fC [virtual]\fR" -Transforms the logically ordered QString, \fIuc\fR, into a visually ordered string in the 8859-8 encoding. Qt's bidi algorithm is used to perform this task. Note that newline characters affect the reordering, since reordering is done on a line by line basis. -.PP -The algorithm is designed to work on whole paragraphs of text, so processing a line at a time may produce incorrect results. This approach is taken because the reordering of the contents of a particular line in a paragraph may depend on the previous line in the same paragraph. -.PP -Some encodings (for example Japanese or UTF-8) are multibyte (so one input character is mapped to two output characters). The \fIlenInOut\fR argument specifies the number of QChars that should be converted and is set to the number of characters returned. -.PP -Reimplemented from QTextCodec. -.SH "const char * QHebrewCodec::mimeName () const\fC [virtual]\fR" -Returns the codec's mime name. -.PP -Reimplemented from QTextCodec. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qhebrewcodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhebrewcodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhgroupbox.3qt b/doc/man/man3/qhgroupbox.3qt deleted file mode 100644 index cb178fcea..000000000 --- a/doc/man/man3/qhgroupbox.3qt +++ /dev/null @@ -1,75 +0,0 @@ -'\" t -.TH QHGroupBox 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 -QHGroupBox \- Organizes widgets in a group with one horizontal row -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QGroupBox. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHGroupBox\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQHGroupBox\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QHGroupBox\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QHGroupBox widget organizes widgets in a group with one horizontal row. -.PP -QHGroupBox is a convenience class that offers a thin layer on top of QGroupBox. Think of it as a QHBox that offers a frame with a title. -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.PP -See also QVGroupBox, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHGroupBox::QHGroupBox ( QWidget * parent = 0, const char * name = 0 )" -Constructs a horizontal group box with no title. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QHGroupBox::QHGroupBox ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a horizontal group box with the title \fItitle\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. -.SH "QHGroupBox::~QHGroupBox ()" -Destroys the horizontal group box, deleting its child widgets. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqhgroupbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhgroupbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhideevent.3qt b/doc/man/man3/qhideevent.3qt deleted file mode 100644 index 4886dd8d8..000000000 --- a/doc/man/man3/qhideevent.3qt +++ /dev/null @@ -1,57 +0,0 @@ -'\" t -.TH QHideEvent 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 -QHideEvent \- Event which is sent after a widget is hidden -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHideEvent\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QHideEvent class provides an event which is sent after a widget is hidden. -.PP -This event is sent just before QWidget::hide() returns, and also when a top-level window has been hidden (iconified) by the user. -.PP -If spontaneous() is TRUE the event originated outside the application, i.e. the user hid the window using the window manager controls, either by iconifying the window or by switching to another virtual desktop where the window isn't visible. The window will become hidden but not withdrawn. If the window was iconified, QWidget::isMinimized() returns TRUE. -.PP -See also QShowEvent and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHideEvent::QHideEvent ()" -Constructs a QHideEvent. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qhideevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhideevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhostaddress.3qt b/doc/man/man3/qhostaddress.3qt deleted file mode 100644 index 2666b7d34..000000000 --- a/doc/man/man3/qhostaddress.3qt +++ /dev/null @@ -1,188 +0,0 @@ -'\" t -.TH QHostAddress 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 -QHostAddress \- IP address -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHostAddress\fR ()" -.br -.ti -1c -.BI "\fBQHostAddress\fR ( TQ_UINT32 ip4Addr )" -.br -.ti -1c -.BI "\fBQHostAddress\fR ( TQ_UINT8 * ip6Addr )" -.br -.ti -1c -.BI "\fBQHostAddress\fR ( const Q_IPV6ADDR & ip6Addr )" -.br -.ti -1c -.BI "\fBQHostAddress\fR ( const QHostAddress & address )" -.br -.ti -1c -.BI "virtual \fB~QHostAddress\fR ()" -.br -.ti -1c -.BI "QHostAddress & \fBoperator=\fR ( const QHostAddress & address )" -.br -.ti -1c -.BI "void \fBsetAddress\fR ( TQ_UINT32 ip4Addr )" -.br -.ti -1c -.BI "void \fBsetAddress\fR ( TQ_UINT8 * ip6Addr )" -.br -.ti -1c -.BI "bool \fBsetAddress\fR ( const QString & address )" -.br -.ti -1c -.BI "bool isIp4Addr () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "TQ_UINT32 ip4Addr () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBisIPv4Address\fR () const" -.br -.ti -1c -.BI "TQ_UINT32 \fBtoIPv4Address\fR () const" -.br -.ti -1c -.BI "bool \fBisIPv6Address\fR () const" -.br -.ti -1c -.BI "Q_IPV6ADDR \fBtoIPv6Address\fR () const" -.br -.ti -1c -.BI "QString \fBtoString\fR () const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QHostAddress & other ) const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QHostAddress class provides an IP address. -.PP -This class contains an IP address in a platform and protocol independent manner. It stores both IPv4 and IPv6 addresses in a way that you can easily access on any platform. -.PP -QHostAddress is normally used with the classes QSocket, QServerSocket and QSocketDevice to set up a server or to connect to a host. -.PP -Host addresses may be set with setAddress() and retrieved with ip4Addr() or toString(). -.PP -See also QSocket, QServerSocket, QSocketDevice, and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHostAddress::QHostAddress ()" -Creates a host address object with the IP address 0.0.0.0. -.SH "QHostAddress::QHostAddress ( TQ_UINT32 ip4Addr )" -Creates a host address object for the IPv4 address \fIip4Addr\fR. -.SH "QHostAddress::QHostAddress ( TQ_UINT8 * ip6Addr )" -Creates a host address object with the specified IPv6 address. -.PP -\fIip6Addr\fR must be a 16 byte array in network byte order (high-order byte first). -.SH "QHostAddress::QHostAddress ( const Q_IPV6ADDR & ip6Addr )" -Creates a host address object with the IPv6 address, \fIip6Addr\fR. -.SH "QHostAddress::QHostAddress ( const QHostAddress & address )" -Creates a copy of \fIaddress\fR. -.SH "QHostAddress::~QHostAddress ()\fC [virtual]\fR" -Destroys the host address object. -.SH "TQ_UINT32 QHostAddress::ip4Addr () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use toIPv4Address() instead. -.SH "bool QHostAddress::isIPv4Address () const" -Returns TRUE if the host address represents an IPv4 address; otherwise returns FALSE. -.SH "bool QHostAddress::isIPv6Address () const" -Returns TRUE if the host address represents an IPv6 address; otherwise returns FALSE. -.SH "bool QHostAddress::isIp4Addr () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use isIPv4Address() instead. -.SH "bool QHostAddress::isNull () const" -Returns TRUE if this host address is null (INADDR_ANY or in6addr_any). The default constructor creates a null address, and that address isn't valid for any particular host or interface. -.SH "QHostAddress & QHostAddress::operator= ( const QHostAddress & address )" -Assigns another host address object \fIaddress\fR to this object and returns a reference to this object. -.SH "bool QHostAddress::operator== ( const QHostAddress & other ) const" -Returns TRUE if this host address is the same as \fIother\fR; otherwise returns FALSE. -.SH "void QHostAddress::setAddress ( TQ_UINT32 ip4Addr )" -Set the IPv4 address specified by \fIip4Addr\fR. -.SH "void QHostAddress::setAddress ( TQ_UINT8 * ip6Addr )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Set the IPv6 address specified by \fIip6Addr\fR. -.PP -\fIip6Addr\fR must be a 16 byte array in network byte order (high-order byte first). -.SH "bool QHostAddress::setAddress ( const QString & address )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the IPv4 or IPv6 address specified by the string representation \fIaddress\fR (e.g. "127.0.0.1"). Returns TRUE and sets the address if the address was successfully parsed; otherwise returns FALSE and leaves the address unchanged. -.SH "TQ_UINT32 QHostAddress::toIPv4Address () const" -Returns the IPv4 address as a number. -.PP -For example, if the address is 127.0.0.1, the returned value is 2130706433 (i.e. 0x7f000001). -.PP -This value is only valid when isIp4Addr() returns TRUE. -.PP -See also toString(). -.SH "Q_IPV6ADDR QHostAddress::toIPv6Address () const" -Returns the IPv6 address as a Q_IPV6ADDR structure. The structure consists of 16 unsigned characters. -.PP -.nf -.br - Q_IPV6ADDR addr = hostAddr.ip6Addr(); -.br - // addr.c[] contains 16 unsigned characters -.br -.br - for (int i = 0; i < 16; ++i) { -.br - // process addr.c[i] -.br - } -.br -.fi -.PP -This value is only valid when isIPv6Address() returns TRUE. -.PP -See also toString(). -.SH "QString QHostAddress::toString () const" -Returns the address as a string. -.PP -For example, if the address is the IPv4 address 127.0.0.1, the returned string is "127.0.0.1". -.PP -See also ip4Addr(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqhostaddress.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhostaddress.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhttp.3qt b/doc/man/man3/qhttp.3qt deleted file mode 100644 index 39573eb70..000000000 --- a/doc/man/man3/qhttp.3qt +++ /dev/null @@ -1,542 +0,0 @@ -'\" t -.TH QHttp 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 -QHttp \- Implementation of the HTTP protocol -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QNetworkProtocol. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHttp\fR ()" -.br -.ti -1c -.BI "\fBQHttp\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQHttp\fR ( const QString & hostname, TQ_UINT16 port = 80, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QHttp\fR ()" -.br -.ti -1c -.BI "enum \fBState\fR { Unconnected, HostLookup, Connecting, Sending, Reading, Connected, Closing }" -.br -.ti -1c -.BI "enum \fBError\fR { NoError, UnknownError, HostNotFound, ConnectionRefused, UnexpectedClose, InvalidResponseHeader, WrongContentLength, Aborted }" -.br -.ti -1c -.BI "int \fBsetHost\fR ( const QString & hostname, TQ_UINT16 port = 80 )" -.br -.ti -1c -.BI "int \fBget\fR ( const QString & path, QIODevice * to = 0 )" -.br -.ti -1c -.BI "int \fBpost\fR ( const QString & path, QIODevice * data, QIODevice * to = 0 )" -.br -.ti -1c -.BI "int \fBpost\fR ( const QString & path, const QByteArray & data, QIODevice * to = 0 )" -.br -.ti -1c -.BI "int \fBhead\fR ( const QString & path )" -.br -.ti -1c -.BI "int \fBrequest\fR ( const QHttpRequestHeader & header, QIODevice * data = 0, QIODevice * to = 0 )" -.br -.ti -1c -.BI "int \fBrequest\fR ( const QHttpRequestHeader & header, const QByteArray & data, QIODevice * to = 0 )" -.br -.ti -1c -.BI "int \fBcloseConnection\fR ()" -.br -.ti -1c -.BI "TQ_ULONG \fBbytesAvailable\fR () const" -.br -.ti -1c -.BI "TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" -.br -.ti -1c -.BI "QByteArray \fBreadAll\fR ()" -.br -.ti -1c -.BI "int \fBcurrentId\fR () const" -.br -.ti -1c -.BI "QIODevice * \fBcurrentSourceDevice\fR () const" -.br -.ti -1c -.BI "QIODevice * \fBcurrentDestinationDevice\fR () const" -.br -.ti -1c -.BI "QHttpRequestHeader \fBcurrentRequest\fR () const" -.br -.ti -1c -.BI "bool \fBhasPendingRequests\fR () const" -.br -.ti -1c -.BI "void \fBclearPendingRequests\fR ()" -.br -.ti -1c -.BI "State \fBstate\fR () const" -.br -.ti -1c -.BI "Error \fBerror\fR () const" -.br -.ti -1c -.BI "QString \fBerrorString\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBabort\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.ti -1c -.BI "void \fBresponseHeaderReceived\fR ( const QHttpResponseHeader & resp )" -.br -.ti -1c -.BI "void \fBreadyRead\fR ( const QHttpResponseHeader & resp )" -.br -.ti -1c -.BI "void \fBdataSendProgress\fR ( int done, int total )" -.br -.ti -1c -.BI "void \fBdataReadProgress\fR ( int done, int total )" -.br -.ti -1c -.BI "void \fBrequestStarted\fR ( int id )" -.br -.ti -1c -.BI "void \fBrequestFinished\fR ( int id, bool error )" -.br -.ti -1c -.BI "void \fBdone\fR ( bool error )" -.br -.in -1c -.SH DESCRIPTION -The QHttp class provides an implementation of the HTTP protocol. -.PP -This class provides two different interfaces: one is the QNetworkProtocol interface that allows you to use HTTP through the QUrlOperator abstraction. The other is a direct interface to HTTP that allows you to have more control over the requests and that allows you to access the response header fields. -.PP -Don't mix the two interfaces, since the behavior is not well-defined. -.PP -If you want to use QHttp with the QNetworkProtocol interface, you do not use it directly, but rather through a QUrlOperator, for example: -.PP -.nf -.br - QUrlOperator op( "http://www.trolltech.com" ); -.br - op.get( "index.html" ); -.br -.fi -.PP -This code will only work if the QHttp class is registered; to register the class, you must call tqInitNetworkProtocols() before using a QUrlOperator with HTTP. -.PP -The QNetworkProtocol interface for HTTP only supports the operations operationGet() and operationPut(), i.e. QUrlOperator::get() and QUrlOperator::put(), if you use it with a QUrlOperator. -.PP -The rest of this descrption describes the direct interface to HTTP. -.PP -The class works asynchronously, so there are no blocking functions. If an operation cannot be executed immediately, the function will still return straight away and the operation will be scheduled for later execution. The results of scheduled operations are reported via signals. This approach depends on the event loop being in operation. -.PP -The operations that can be scheduled (they are called "requests" in the rest of the documentation) are the following: setHost(), get(), post(), head() and request(). -.PP -All of these requests return a unique identifier that allows you to keep track of the request that is currently executed. When the execution of a request starts, the requestStarted() signal with the identifier is emitted and when the request is finished, the requestFinished() signal is emitted with the identifier and a bool that indicates if the request finished with an error. -.PP -To make an HTTP request you must set up suitable HTTP headers. The following example demonstrates, how to request the main HTML page from the Trolltech home page (i.e. the URL http://www.trolltech.com/index.html): -.PP -.nf -.br - QHttpRequestHeader header( "GET", "/index.html" ); -.br - header.setValue( "Host", "www.trolltech.com" ); -.br - http->setHost( "www.trolltech.com" ); -.br - http->request( header ); -.br -.fi -.PP -For the common HTTP requests \fCGET\fR, \fCPOST\fR and \fCHEAD\fR, QHttp provides the convenience functions get(), post() and head(). They already use a reasonable header and if you don't have to set special header fields, they are easier to use. The above example can also be written as: -.PP -.nf -.br - http->setHost( "www.trolltech.com" ); // id == 1 -.br - http->get( "/index.html" ); // id == 2 -.br -.fi -.PP -For this example the following sequence of signals is emitted (with small variations, depending on network traffic, etc.): -.PP -.nf -.br - requestStarted( 1 ) -.br - requestFinished( 1, FALSE ) -.br -.br - requestStarted( 2 ) -.br - stateChanged( Connecting ) -.br - stateChanged( Sending ) -.br - dataSendProgress( 77, 77 ) -.br - stateChanged( Reading ) -.br - responseHeaderReceived( responseheader ) -.br - dataReadProgress( 5388, 0 ) -.br - readyRead( responseheader ) -.br - dataReadProgress( 18300, 0 ) -.br - readyRead( responseheader ) -.br - stateChanged( Connected ) -.br - requestFinished( 2, FALSE ) -.br -.br - done( FALSE ) -.br -.br - stateChanged( Closing ) -.br - stateChanged( Unconnected ) -.br -.fi -.PP -The dataSendProgress() and dataReadProgress() signals in the above example are useful if you want to show a progressbar to inform the user about the progress of the download. The second argument is the total size of data. In certain cases it is not possible to know the total amount in advance, in which case the second argument is 0. (If you connect to a QProgressBar a total of 0 results in a busy indicator.) -.PP -When the response header is read, it is reported with the responseHeaderReceived() signal. -.PP -The readyRead() signal tells you that there is data ready to be read. The amount of data can then be queried with the bytesAvailable() function and it can be read with the readBlock() or readAll() functions. -.PP -If an error occurs during the execution of one of the commands in a sequence of commands, all the pending commands (i.e. scheduled, but not yet executed commands) are cleared and no signals are emitted for them. -.PP -For example, if you have the following sequence of reqeusts -.PP -.nf -.br - http->setHost( "www.foo.bar" ); // id == 1 -.br - http->get( "/index.html" ); // id == 2 -.br - http->post( "register.html", data ); // id == 3 -.br -.fi -.PP -and the get() request fails because the host lookup fails, then the post() request is never executed and the signals would look like this: -.PP -.nf -.br - requestStarted( 1 ) -.br - requestFinished( 1, FALSE ) -.br -.br - requestStarted( 2 ) -.br - stateChanged( HostLookup ) -.br - requestFinished( 2, TRUE ) -.br -.br - done( TRUE ) -.br -.br - stateChanged( Unconnected ) -.br -.fi -.PP -You can then get details about the error with the error() and errorString() functions. Note that only unexpected behaviour, like network failure is considered as an error. If the server response contains an error status, like a 404 response, this is reported as a normal response case. So you should always check the status code of the response header. -.PP -The functions currentId() and currentRequest() provide more information about the currently executing request. -.PP -The functions hasPendingRequests() and clearPendingRequests() allow you to query and clear the list of pending requests. -.PP -See also Qt Network Documentation, QNetworkProtocol, QUrlOperator, QFtp, and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QHttp::Error" -This enum identifies the error that occurred. -.TP -\fCQHttp::NoError\fR - No error occurred. -.TP -\fCQHttp::HostNotFound\fR - The host name lookup failed. -.TP -\fCQHttp::ConnectionRefused\fR - The server refused the connection. -.TP -\fCQHttp::UnexpectedClose\fR - The server closed the connection unexpectedly. -.TP -\fCQHttp::InvalidResponseHeader\fR - The server sent an invalid response header. -.TP -\fCQHttp::WrongContentLength\fR - The client could not read the content correctly because an error with respect to the content length occurred. -.TP -\fCQHttp::Aborted\fR - The request was aborted with abort(). -.TP -\fCQHttp::UnknownError\fR - An error other than those specified above occurred. -.PP -See also error(). -.SH "QHttp::State" -This enum is used to specify the state the client is in: -.TP -\fCQHttp::Unconnected\fR - There is no connection to the host. -.TP -\fCQHttp::HostLookup\fR - A host name lookup is in progress. -.TP -\fCQHttp::Connecting\fR - An attempt to connect to the host is in progress. -.TP -\fCQHttp::Sending\fR - The client is sending its request to the server. -.TP -\fCQHttp::Reading\fR - The client's request has been sent and the client is reading the server's response. -.TP -\fCQHttp::Connected\fR - The connection to the host is open, but the client is neither sending a request, nor waiting for a response. -.TP -\fCQHttp::Closing\fR - The connection is closing down, but is not yet closed. (The state will be Unconnected when the connection is closed.) -.PP -See also stateChanged() and state(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHttp::QHttp ()" -Constructs a QHttp object. -.SH "QHttp::QHttp ( QObject * parent, const char * name = 0 )" -Constructs a QHttp object. The parameters \fIparent\fR and \fIname\fR are passed on to the QObject constructor. -.SH "QHttp::QHttp ( const QString & hostname, TQ_UINT16 port = 80, QObject * parent = 0, const char * name = 0 )" -Constructs a QHttp object. Subsequent requests are done by connecting to the server \fIhostname\fR on port \fIport\fR. The parameters \fIparent\fR and \fIname\fR are passed on to the QObject constructor. -.PP -See also setHost(). -.SH "QHttp::~QHttp ()\fC [virtual]\fR" -Destroys the QHttp object. If there is an open connection, it is closed. -.SH "void QHttp::abort ()\fC [slot]\fR" -Aborts the current request and deletes all scheduled requests. -.PP -For the current request, the requestFinished() signal with the \fCerror\fR argument \fCTRUE\fR is emitted. For all other requests that are affected by the abort(), no signals are emitted. -.PP -Since this slot also deletes the scheduled requests, there are no requests left and the done() signal is emitted (with the \fCerror\fR argument \fCTRUE\fR). -.PP -See also clearPendingRequests(). -.SH "TQ_ULONG QHttp::bytesAvailable () const" -Returns the number of bytes that can be read from the response content at the moment. -.PP -See also get(), post(), request(), readyRead(), readBlock(), and readAll(). -.SH "void QHttp::clearPendingRequests ()" -Deletes all pending requests from the list of scheduled requests. This does not affect the request that is being executed. If you want to stop this this as well, use abort(). -.PP -See also hasPendingRequests() and abort(). -.SH "int QHttp::closeConnection ()" -Closes the connection; this is useful if you have a keep-alive connection and want to close it. -.PP -For the requests issued with get(), post() and head(), QHttp sets the connection to be keep-alive. You can also do this using the header you pass to the request() function. QHttp only closes the connection to the HTTP server if the response header requires it to do so. -.PP -The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). -.PP -When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. -.PP -If you want to close the connection immediately, you have to use abort() instead. -.PP -See also stateChanged(), abort(), requestStarted(), requestFinished(), and done(). -.SH "QIODevice * QHttp::currentDestinationDevice () const" -Returns the QIODevice pointer that is used as to store the data of the HTTP request being executed. If there is no current request or if the request does not store the data to an IO device, this function returns 0. -.PP -This function can be used to delete the QIODevice in the slot connected to the requestFinished() signal. -.PP -See also get(), post(), and request(). -.SH "int QHttp::currentId () const" -Returns the identifier of the HTTP request being executed or 0 if there is no request being executed (i.e. they've all finished). -.PP -See also currentRequest(). -.SH "QHttpRequestHeader QHttp::currentRequest () const" -Returns the request header of the HTTP request being executed. If the request is one issued by setHost() or closeConnection(), it returns an invalid request header, i.e. QHttpRequestHeader::isValid() returns FALSE. -.PP -See also currentId(). -.SH "QIODevice * QHttp::currentSourceDevice () const" -Returns the QIODevice pointer that is used as the data source of the HTTP request being executed. If there is no current request or if the request does not use an IO device as the data source, this function returns 0. -.PP -This function can be used to delete the QIODevice in the slot connected to the requestFinished() signal. -.PP -See also currentDestinationDevice(), post(), and request(). -.SH "void QHttp::dataReadProgress ( int done, int total )\fC [signal]\fR" -This signal is emitted when this object reads data from a HTTP server to indicate the current progress of the download. -.PP -\fIdone\fR is the amount of data that has already arrived and \fItotal\fR is the total amount of data. It is possible that the total amount of data that should be transferred cannot be determined, in which case \fItotal\fR is 0.(If you connect to a QProgressBar, the progress bar shows a busy indicator if the total is 0). -.PP -\fBWarning:\fR \fIdone\fR and \fItotal\fR are not necessarily the size in bytes, since for large files these values might need to be" scaled" to avoid overflow. -.PP -See also dataSendProgress(), get(), post(), request(), and QProgressBar::progress. -.SH "void QHttp::dataSendProgress ( int done, int total )\fC [signal]\fR" -This signal is emitted when this object sends data to a HTTP server to inform it about the progress of the upload. -.PP -\fIdone\fR is the amount of data that has already arrived and \fItotal\fR is the total amount of data. It is possible that the total amount of data that should be transferred cannot be determined, in which case \fItotal\fR is 0.(If you connect to a QProgressBar, the progress bar shows a busy indicator if the total is 0). -.PP -\fBWarning:\fR \fIdone\fR and \fItotal\fR are not necessarily the size in bytes, since for large files these values might need to be" scaled" to avoid overflow. -.PP -See also dataReadProgress(), post(), request(), and QProgressBar::progress. -.SH "void QHttp::done ( bool error )\fC [signal]\fR" -This signal is emitted when the last pending request has finished; (it is emitted after the last request's requestFinished() signal). \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. -.PP -See also requestFinished(), error(), and errorString(). -.SH "Error QHttp::error () const" -Returns the last error that occurred. This is useful to find out what happened when receiving a requestFinished() or a done() signal with the \fCerror\fR argument \fCTRUE\fR. -.PP -If you start a new request, the error status is reset to NoError. -.SH "QString QHttp::errorString () const" -Returns a human-readable description of the last error that occurred. This is useful to present a error message to the user when receiving a requestFinished() or a done() signal with the \fCerror\fR argument \fCTRUE\fR. -.SH "int QHttp::get ( const QString & path, QIODevice * to = 0 )" -Sends a get request for \fIpath\fR to the server set by setHost() or as specified in the constructor. -.PP -\fIpath\fR must be an absolute path like \fC/index.html\fR or an absolute URI like http://www.trolltech.com/index.html. -.PP -If the IO device \fIto\fR is 0 the readyRead() signal is emitted every time new content data is available to read. -.PP -If the IO device \fIto\fR is not 0, the content data of the response is written directly to the device. Make sure that the \fIto\fR pointer is valid for the duration of the operation (it is safe to delete it when the requestFinished() signal is emitted). -.PP -The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). -.PP -When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. -.PP -See also setHost(), post(), head(), request(), requestStarted(), requestFinished(), and done(). -.SH "bool QHttp::hasPendingRequests () const" -Returns TRUE if there are any requests scheduled that have not yet been executed; otherwise returns FALSE. -.PP -The request that is being executed is \fInot\fR considered as a scheduled request. -.PP -See also clearPendingRequests(), currentId(), and currentRequest(). -.SH "int QHttp::head ( const QString & path )" -Sends a header request for \fIpath\fR to the server set by setHost() or as specified in the constructor. -.PP -\fIpath\fR must be an absolute path like \fC/index.html\fR or an absolute URI like http://www.trolltech.com/index.html. -.PP -The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). -.PP -When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. -.PP -See also setHost(), get(), post(), request(), requestStarted(), requestFinished(), and done(). -.SH "int QHttp::post ( const QString & path, QIODevice * data, QIODevice * to = 0 )" -Sends a post request for \fIpath\fR to the server set by setHost() or as specified in the constructor. -.PP -\fIpath\fR must be an absolute path like \fC/index.html\fR or an absolute URI like http://www.trolltech.com/index.html. -.PP -The incoming data comes via the \fIdata\fR IO device. -.PP -If the IO device \fIto\fR is 0 the readyRead() signal is emitted every time new content data is available to read. -.PP -If the IO device \fIto\fR is not 0, the content data of the response is written directly to the device. Make sure that the \fIto\fR pointer is valid for the duration of the operation (it is safe to delete it when the requestFinished() signal is emitted). -.PP -The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). -.PP -When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. -.PP -See also setHost(), get(), head(), request(), requestStarted(), requestFinished(), and done(). -.SH "int QHttp::post ( const QString & path, const QByteArray & data, QIODevice * to = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIdata\fR is used as the content data of the HTTP request. -.SH "QByteArray QHttp::readAll ()" -Reads all the bytes from the response content and returns them. -.PP -See also get(), post(), request(), readyRead(), bytesAvailable(), and readBlock(). -.SH "TQ_LONG QHttp::readBlock ( char * data, TQ_ULONG maxlen )" -Reads \fImaxlen\fR bytes from the response content into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. -.PP -See also get(), post(), request(), readyRead(), bytesAvailable(), and readAll(). -.SH "void QHttp::readyRead ( const QHttpResponseHeader & resp )\fC [signal]\fR" -This signal is emitted when there is new response data to read. -.PP -If you specified a device in the request where the data should be written to, then this signal is \fInot\fR emitted; instead the data is written directly to the device. -.PP -The response header is passed in \fIresp\fR. -.PP -You can read the data with the readAll() or readBlock() functions -.PP -This signal is useful if you want to process the data in chunks as soon as it becomes available. If you are only interested in the complete data, just connect to the requestFinished() signal and read the data then instead. -.PP -See also get(), post(), request(), readAll(), readBlock(), and bytesAvailable(). -.SH "int QHttp::request ( const QHttpRequestHeader & header, QIODevice * data = 0, QIODevice * to = 0 )" -Sends a request to the server set by setHost() or as specified in the constructor. Uses the \fIheader\fR as the HTTP request header. You are responsible for setting up a header that is appropriate for your request. -.PP -The incoming data comes via the \fIdata\fR IO device. -.PP -If the IO device \fIto\fR is 0 the readyRead() signal is emitted every time new content data is available to read. -.PP -If the IO device \fIto\fR is not 0, the content data of the response is written directly to the device. Make sure that the \fIto\fR pointer is valid for the duration of the operation (it is safe to delete it when the requestFinished() signal is emitted). -.PP -The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). -.PP -When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. -.PP -See also setHost(), get(), post(), head(), requestStarted(), requestFinished(), and done(). -.SH "int QHttp::request ( const QHttpRequestHeader & header, const QByteArray & data, QIODevice * to = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIdata\fR is used as the content data of the HTTP request. -.SH "void QHttp::requestFinished ( int id, bool error )\fC [signal]\fR" -This signal is emitted when processing the request identified by \fIid\fR has finished. \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. -.PP -See also requestStarted(), done(), error(), and errorString(). -.SH "void QHttp::requestStarted ( int id )\fC [signal]\fR" -This signal is emitted when processing the request identified by \fIid\fR starts. -.PP -See also requestFinished() and done(). -.SH "void QHttp::responseHeaderReceived ( const QHttpResponseHeader & resp )\fC [signal]\fR" -This signal is emitted when the HTTP header of a server response is available. The header is passed in \fIresp\fR. -.PP -See also get(), post(), head(), request(), and readyRead(). -.SH "int QHttp::setHost ( const QString & hostname, TQ_UINT16 port = 80 )" -Sets the HTTP server that is used for requests to \fIhostname\fR on port \fIport\fR. -.PP -The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). -.PP -When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. -.PP -See also get(), post(), head(), request(), requestStarted(), requestFinished(), and done(). -.SH "State QHttp::state () const" -Returns the current state of the object. When the state changes, the stateChanged() signal is emitted. -.PP -See also State and stateChanged(). -.SH "void QHttp::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted when the state of the QHttp object changes. The argument \fIstate\fR is the new state of the connection; it is one of the State values. -.PP -This usually happens when a request is started, but it can also happen when the server closes the connection or when a call to closeConnection() succeeded. -.PP -See also get(), post(), head(), request(), closeConnection(), state(), and State. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqhttp.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhttp.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhttpheader.3qt b/doc/man/man3/qhttpheader.3qt deleted file mode 100644 index 085d36fe0..000000000 --- a/doc/man/man3/qhttpheader.3qt +++ /dev/null @@ -1,210 +0,0 @@ -'\" t -.TH QHttpHeader 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 -QHttpHeader \- Header information for HTTP -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QHttpResponseHeader and QHttpRequestHeader. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHttpHeader\fR ()" -.br -.ti -1c -.BI "\fBQHttpHeader\fR ( const QHttpHeader & header )" -.br -.ti -1c -.BI "\fBQHttpHeader\fR ( const QString & str )" -.br -.ti -1c -.BI "virtual \fB~QHttpHeader\fR ()" -.br -.ti -1c -.BI "QHttpHeader & \fBoperator=\fR ( const QHttpHeader & h )" -.br -.ti -1c -.BI "QString \fBvalue\fR ( const QString & key ) const" -.br -.ti -1c -.BI "void \fBsetValue\fR ( const QString & key, const QString & value )" -.br -.ti -1c -.BI "void \fBremoveValue\fR ( const QString & key )" -.br -.ti -1c -.BI "QStringList \fBkeys\fR () const" -.br -.ti -1c -.BI "bool \fBhasKey\fR ( const QString & key ) const" -.br -.ti -1c -.BI "bool \fBhasContentLength\fR () const" -.br -.ti -1c -.BI "uint \fBcontentLength\fR () const" -.br -.ti -1c -.BI "void \fBsetContentLength\fR ( int len )" -.br -.ti -1c -.BI "bool \fBhasContentType\fR () const" -.br -.ti -1c -.BI "QString \fBcontentType\fR () const" -.br -.ti -1c -.BI "void \fBsetContentType\fR ( const QString & type )" -.br -.ti -1c -.BI "virtual QString \fBtoString\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "virtual int \fBmajorVersion\fR () const = 0" -.br -.ti -1c -.BI "virtual int \fBminorVersion\fR () const = 0" -.br -.in -1c -.SH DESCRIPTION -The QHttpHeader class contains header information for HTTP. -.PP -In most cases you should use the more specialized derivatives of this class, QHttpResponseHeader and QHttpRequestHeader, rather than directly using QHttpHeader. -.PP -QHttpHeader provides the HTTP header fields. A HTTP header field consists of a name followed by a colon, a single space, and the field value. (See RFC 1945.) Field names are case-insensitive. A typical header field looks like this: -.PP -.nf -.br - content-type: text/html -.br -.fi -.PP -In the API the header field name is called the "key" and the content is called the "value". You can get and set a header field's value by using its key with value() and setValue(), e.g. -.PP -.nf -.br - header.setValue( "content-type", "text/html" ); -.br - QString contentType = header.value( "content-type" ); -.br -.fi -.PP -Some fields are so common that getters and setters are provided for them as a convenient alternative to using value() and setValue(), e.g. contentLength() and contentType(), setContentLength() and setContentType(). -.PP -Each header key has a \fIsingle\fR value associated with it. If you set the value for a key which already exists the previous value will be discarded. -.PP -See also QHttpRequestHeader, QHttpResponseHeader, and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHttpHeader::QHttpHeader ()" -Constructs an empty HTTP header. -.SH "QHttpHeader::QHttpHeader ( const QHttpHeader & header )" -Constructs a copy of \fIheader\fR. -.SH "QHttpHeader::QHttpHeader ( const QString & str )" -Constructs a HTTP header for \fIstr\fR. -.PP -This constructor parses the string \fIstr\fR for header fields and adds this information. The \fIstr\fR should consist of one or more" \\r\\n" delimited lines; each of these lines should have the format key, colon, space, value. -.SH "QHttpHeader::~QHttpHeader ()\fC [virtual]\fR" -Destructor. -.SH "uint QHttpHeader::contentLength () const" -Returns the value of the special HTTP header field \fCcontent-length\fR. -.PP -See also setContentLength() and hasContentLength(). -.SH "QString QHttpHeader::contentType () const" -Returns the value of the special HTTP header field \fCcontent-type\fR. -.PP -See also setContentType() and hasContentType(). -.SH "bool QHttpHeader::hasContentLength () const" -Returns TRUE if the header has an entry for the special HTTP header field \fCcontent-length\fR; otherwise returns FALSE. -.PP -See also contentLength() and setContentLength(). -.SH "bool QHttpHeader::hasContentType () const" -Returns TRUE if the header has an entry for the the special HTTP header field \fCcontent-type\fR; otherwise returns FALSE. -.PP -See also contentType() and setContentType(). -.SH "bool QHttpHeader::hasKey ( const QString & key ) const" -Returns TRUE if the HTTP header has an entry with the given \fIkey\fR; otherwise returns FALSE. -.PP -See also value(), setValue(), and keys(). -.SH "bool QHttpHeader::isValid () const" -Returns TRUE if the HTTP header is valid; otherwise returns FALSE. -.PP -A QHttpHeader is invalid if it was created by parsing a malformed string. -.SH "QStringList QHttpHeader::keys () const" -Returns a list of the keys in the HTTP header. -.PP -See also hasKey(). -.SH "int QHttpHeader::majorVersion () const\fC [pure virtual]\fR" -Returns the major protocol-version of the HTTP header. -.PP -Reimplemented in QHttpResponseHeader and QHttpRequestHeader. -.SH "int QHttpHeader::minorVersion () const\fC [pure virtual]\fR" -Returns the minor protocol-version of the HTTP header. -.PP -Reimplemented in QHttpResponseHeader and QHttpRequestHeader. -.SH "QHttpHeader & QHttpHeader::operator= ( const QHttpHeader & h )" -Assigns \fIh\fR and returns a reference to this http header. -.SH "void QHttpHeader::removeValue ( const QString & key )" -Removes the entry with the key \fIkey\fR from the HTTP header. -.PP -See also value() and setValue(). -.SH "void QHttpHeader::setContentLength ( int len )" -Sets the value of the special HTTP header field \fCcontent-length\fR to \fIlen\fR. -.PP -See also contentLength() and hasContentLength(). -.SH "void QHttpHeader::setContentType ( const QString & type )" -Sets the value of the special HTTP header field \fCcontent-type\fR to \fItype\fR. -.PP -See also contentType() and hasContentType(). -.PP -Example: network/archivesearch/archivedialog.ui.h. -.SH "void QHttpHeader::setValue ( const QString & key, const QString & value )" -Sets the value of the entry with the \fIkey\fR to \fIvalue\fR. -.PP -If no entry with \fIkey\fR exists, a new entry with the given \fIkey\fR and \fIvalue\fR is created. If an entry with the \fIkey\fR already exists, its value is discarded and replaced with the given \fIvalue\fR. -.PP -See also value(), hasKey(), and removeValue(). -.PP -Example: network/archivesearch/archivedialog.ui.h. -.SH "QString QHttpHeader::toString () const\fC [virtual]\fR" -Returns a string representation of the HTTP header. -.PP -The string is suitable for use by the constructor that takes a QString. It consists of lines with the format: key, colon, space, value, "\\r\\n". -.SH "QString QHttpHeader::value ( const QString & key ) const" -Returns the value for the entry with the given \fIkey\fR. If no entry has this \fIkey\fR, an empty string is returned. -.PP -See also setValue(), removeValue(), hasKey(), and keys(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qhttpheader.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhttpheader.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhttprequestheader.3qt b/doc/man/man3/qhttprequestheader.3qt deleted file mode 100644 index e7e73efa5..000000000 --- a/doc/man/man3/qhttprequestheader.3qt +++ /dev/null @@ -1,137 +0,0 @@ -'\" t -.TH QHttpRequestHeader 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 -QHttpRequestHeader \- Request header information for HTTP -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QHttpHeader. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHttpRequestHeader\fR ()" -.br -.ti -1c -.BI "\fBQHttpRequestHeader\fR ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" -.br -.ti -1c -.BI "\fBQHttpRequestHeader\fR ( const QHttpRequestHeader & header )" -.br -.ti -1c -.BI "\fBQHttpRequestHeader\fR ( const QString & str )" -.br -.ti -1c -.BI "void \fBsetRequest\fR ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" -.br -.ti -1c -.BI "QString \fBmethod\fR () const" -.br -.ti -1c -.BI "QString \fBpath\fR () const" -.br -.ti -1c -.BI "virtual int \fBmajorVersion\fR () const" -.br -.ti -1c -.BI "virtual int \fBminorVersion\fR () const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QString \fBvalue\fR ( const QString & key ) const" -.br -.ti -1c -.BI "void \fBsetValue\fR ( const QString & key, const QString & value )" -.br -.in -1c -.SH DESCRIPTION -The QHttpRequestHeader class contains request header information for HTTP. -.PP -This class is used in the QHttp class to report the header information if the client requests something from the server. -.PP -HTTP requests have a method which describes the request's action. The most common requests are "GET" and "POST". In addition to the request method the header also includes a request-URI to specify the location for the method to use. -.PP -The method, request-URI and protocol-version can be set using a constructor or later using setRequest(). The values can be obtained using method(), path(), majorVersion() and minorVersion(). -.PP -This class is a QHttpHeader subclass so that class's functions, e.g. setValue(), value(), etc. are also available. -.PP -See also QHttpResponseHeader, QHttp, and Input/Output and Networking. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHttpRequestHeader::QHttpRequestHeader ()" -Constructs an empty HTTP request header. -.SH "QHttpRequestHeader::QHttpRequestHeader ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" -Constructs a HTTP request header for the method \fImethod\fR, the request-URI \fIpath\fR and the protocol-version \fImajorVer\fR and \fIminorVer\fR. -.SH "QHttpRequestHeader::QHttpRequestHeader ( const QHttpRequestHeader & header )" -Constructs a copy of \fIheader\fR. -.SH "QHttpRequestHeader::QHttpRequestHeader ( const QString & str )" -Constructs a HTTP request header from the string \fIstr\fR. The \fIstr\fR should consist of one or more "\\r\\n" delimited lines; the first line should be the request-line (format: method, space, request-URI, space HTTP-version); each of the remaining lines should have the format key, colon, space, value. -.SH "int QHttpRequestHeader::majorVersion () const\fC [virtual]\fR" -Returns the major protocol-version of the HTTP request header. -.PP -See also minorVersion(), method(), path(), and setRequest(). -.PP -Reimplemented from QHttpHeader. -.SH "QString QHttpRequestHeader::method () const" -Returns the method of the HTTP request header. -.PP -See also path(), majorVersion(), minorVersion(), and setRequest(). -.SH "int QHttpRequestHeader::minorVersion () const\fC [virtual]\fR" -Returns the minor protocol-version of the HTTP request header. -.PP -See also majorVersion(), method(), path(), and setRequest(). -.PP -Reimplemented from QHttpHeader. -.SH "QString QHttpRequestHeader::path () const" -Returns the request-URI of the HTTP request header. -.PP -See also method(), majorVersion(), minorVersion(), and setRequest(). -.SH "void QHttpRequestHeader::setRequest ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" -This function sets the request method to \fImethod\fR, the request-URI to \fIpath\fR and the protocol-version to \fImajorVer\fR and \fIminorVer\fR. -.PP -See also method(), path(), majorVersion(), and minorVersion(). -.SH "void QHttpHeader::setValue ( const QString & key, const QString & value )" -Sets the value of the entry with the \fIkey\fR to \fIvalue\fR. -.PP -If no entry with \fIkey\fR exists, a new entry with the given \fIkey\fR and \fIvalue\fR is created. If an entry with the \fIkey\fR already exists, its value is discarded and replaced with the given \fIvalue\fR. -.PP -See also value(), hasKey(), and removeValue(). -.PP -Example: network/archivesearch/archivedialog.ui.h. -.SH "QString QHttpHeader::value ( const QString & key ) const" -Returns the value for the entry with the given \fIkey\fR. If no entry has this \fIkey\fR, an empty string is returned. -.PP -See also setValue(), removeValue(), hasKey(), and keys(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qhttprequestheader.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhttprequestheader.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qhttpresponseheader.3qt b/doc/man/man3/qhttpresponseheader.3qt deleted file mode 100644 index 61402ff8a..000000000 --- a/doc/man/man3/qhttpresponseheader.3qt +++ /dev/null @@ -1,94 +0,0 @@ -'\" t -.TH QHttpResponseHeader 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 -QHttpResponseHeader \- Response header information for HTTP -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QHttpHeader. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQHttpResponseHeader\fR ()" -.br -.ti -1c -.BI "\fBQHttpResponseHeader\fR ( const QHttpResponseHeader & header )" -.br -.ti -1c -.BI "int \fBstatusCode\fR () const" -.br -.ti -1c -.BI "QString \fBreasonPhrase\fR () const" -.br -.ti -1c -.BI "virtual int \fBmajorVersion\fR () const" -.br -.ti -1c -.BI "virtual int \fBminorVersion\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QHttpResponseHeader class contains response header information for HTTP. -.PP -This class is used by the QHttp class to report the header information that the client received from the server. -.PP -HTTP responses have a status code that indicates the status of the response. This code is a 3-digit integer result code (for details see to RFC 1945). In addition to the status code, you can also specify a human-readable text that describes the reason for the code ("reason phrase"). This class allows you to get the status code and the reason phrase. -.PP -See also QHttpRequestHeader, QHttp, and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QHttpResponseHeader::QHttpResponseHeader ()" -Constructs an empty HTTP response header. -.SH "QHttpResponseHeader::QHttpResponseHeader ( const QHttpResponseHeader & header )" -Constructs a copy of \fIheader\fR. -.SH "int QHttpResponseHeader::majorVersion () const\fC [virtual]\fR" -Returns the major protocol-version of the HTTP response header. -.PP -See also minorVersion(), statusCode(), and reasonPhrase(). -.PP -Reimplemented from QHttpHeader. -.SH "int QHttpResponseHeader::minorVersion () const\fC [virtual]\fR" -Returns the minor protocol-version of the HTTP response header. -.PP -See also majorVersion(), statusCode(), and reasonPhrase(). -.PP -Reimplemented from QHttpHeader. -.SH "QString QHttpResponseHeader::reasonPhrase () const" -Returns the reason phrase of the HTTP response header. -.PP -See also statusCode(), majorVersion(), and minorVersion(). -.SH "int QHttpResponseHeader::statusCode () const" -Returns the status code of the HTTP response header. -.PP -See also reasonPhrase(), majorVersion(), and minorVersion(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qhttpresponseheader.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qhttpresponseheader.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qicondrag.3qt b/doc/man/man3/qicondrag.3qt deleted file mode 100644 index e70a66dad..000000000 --- a/doc/man/man3/qicondrag.3qt +++ /dev/null @@ -1,96 +0,0 @@ -'\" t -.TH QIconDrag 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 -QIconDrag \- Supports drag and drop operations within a QIconView -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDragObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIconDrag\fR ( QWidget * dragSource, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QIconDrag\fR ()" -.br -.ti -1c -.BI "void \fBappend\fR ( const QIconDragItem & i, const QRect & pr, const QRect & tr )" -.br -.ti -1c -.BI "virtual QByteArray \fBencodedData\fR ( const char * mime ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBcanDecode\fR ( QMimeSource * e )" -.br -.in -1c -.SH DESCRIPTION -The QIconDrag class supports drag and drop operations within a QIconView. -.PP -A QIconDrag object is used to maintain information about the positions of dragged items and the data associated with the dragged items. QIconViews are able to use this information to paint the dragged items in the correct positions. Internally QIconDrag stores the data associated with drag items in QIconDragItem objects. -.PP -If you want to use the extended drag-and-drop functionality of QIconView, create a QIconDrag object in a reimplementation of QIconView::dragObject(). Then create a QIconDragItem for each item which should be dragged, set the data it represents with QIconDragItem::setData(), and add each QIconDragItem to the drag object using append(). -.PP -The data in QIconDragItems is stored in a QByteArray and is mime-typed (see QMimeSource and the Drag and Drop overview). If you want to use your own mime-types derive a class from QIconDrag and reimplement format(), encodedData() and canDecode(). -.PP -The fileiconview example program demonstrates the use of the QIconDrag class including subclassing and reimplementing dragObject(), format(), encodedData() and canDecode(). See the files \fCqt/examples/fileiconview/qfileiconview.h\fR and \fCqt/examples/fileiconview/qfileiconview.cpp\fR. -.PP -See also QMimeSource::format() and Drag And Drop Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIconDrag::QIconDrag ( QWidget * dragSource, const char * name = 0 )" -Constructs a drag object called \fIname\fR, which is a child of \fIdragSource\fR. -.PP -Note that the drag object will be deleted when \fIdragSource\fR is deleted. -.SH "QIconDrag::~QIconDrag ()\fC [virtual]\fR" -Destructor. -.SH "void QIconDrag::append ( const QIconDragItem & i, const QRect & pr, const QRect & tr )" -Append the QIconDragItem, \fIi\fR, to the QIconDrag object's list of items. You must also supply the geometry of the pixmap, \fIpr\fR, and the textual caption, \fItr\fR. -.PP -See also QIconDragItem. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QIconDrag::canDecode ( QMimeSource * e )\fC [static]\fR" -Returns TRUE if \fIe\fR can be decoded by the QIconDrag, otherwise return FALSE. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QByteArray QIconDrag::encodedData ( const char * mime ) const\fC [virtual]\fR" -Returns the encoded data of the drag object if \fImime\fR is application/x-qiconlist. -.PP -Example: fileiconview/qfileiconview.cpp. -.PP -Reimplemented from QMimeSource. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qicondrag.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qicondrag.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qicondragevent.3qt b/doc/man/man3/qicondragevent.3qt deleted file mode 100644 index 36275a2f8..000000000 --- a/doc/man/man3/qicondragevent.3qt +++ /dev/null @@ -1,86 +0,0 @@ -'\" t -.TH QIconDragEvent 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 -QIconDragEvent \- Signals that a main icon drag has begun -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIconDragEvent\fR ()" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QIconDragEvent class signals that a main icon drag has begun. -.PP -Icon drag events are sent to widgets when the main icon of a window has been dragged away. On Mac OS X this is fired when the proxy icon of a window is dragged off titlebar, in response to this event is is normal to begin using drag and drop. -.PP -See also Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIconDragEvent::QIconDragEvent ()" -Constructs an icon drag event object with the accept parameter flag set to FALSE. -.PP -See also accept(). -.SH "void QIconDragEvent::accept ()" -Sets the accept flag of the icon drag event object. -.PP -Setting the accept flag indicates that the receiver of this event has started a drag and drop oeration. -.PP -The accept flag is \fInot\fR set by default. -.PP -See also ignore() and QWidget::hide(). -.SH "void QIconDragEvent::ignore ()" -Clears the accept flag of the icon drag object. -.PP -Clearing the accept flag indicates that the receiver of this event has not handled the icon drag as a result other events can be sent. -.PP -The icon drag event is constructed with the accept flag cleared. -.PP -See also accept(). -.SH "bool QIconDragEvent::isAccepted () const" -Returns TRUE if the receiver of the event has started a drag and drop operation; otherwise returns FALSE. -.PP -See also accept() and ignore(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qicondragevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qicondragevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qicondragitem.3qt b/doc/man/man3/qicondragitem.3qt deleted file mode 100644 index c80ec9fa6..000000000 --- a/doc/man/man3/qicondragitem.3qt +++ /dev/null @@ -1,76 +0,0 @@ -'\" t -.TH QIconDragItem 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 -QIconDragItem \- Encapsulates a drag item -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIconDragItem\fR ()" -.br -.ti -1c -.BI "virtual \fB~QIconDragItem\fR ()" -.br -.ti -1c -.BI "virtual QByteArray \fBdata\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetData\fR ( const QByteArray & d )" -.br -.in -1c -.SH DESCRIPTION -The QIconDragItem class encapsulates a drag item. -.PP -The QIconDrag class uses a list of QIconDragItems to support drag and drop operations. -.PP -In practice a QIconDragItem object (or an object of a class derived from QIconDragItem) is created for each icon view item which is dragged. Each of these QIconDragItems is stored in a QIconDrag object. -.PP -See QIconView::dragObject() for more information. -.PP -See the fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp examples. -.PP -See also Drag And Drop Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIconDragItem::QIconDragItem ()" -Constructs a QIconDragItem with no data. -.SH "QIconDragItem::~QIconDragItem ()\fC [virtual]\fR" -Destructor. -.SH "QByteArray QIconDragItem::data () const\fC [virtual]\fR" -Returns the data contained in the QIconDragItem. -.SH "void QIconDragItem::setData ( const QByteArray & d )\fC [virtual]\fR" -Sets the data for the QIconDragItem to the data stored in the QByteArray \fId\fR. -.PP -Example: fileiconview/qfileiconview.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qicondragitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qicondragitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qiconfactory.3qt b/doc/man/man3/qiconfactory.3qt deleted file mode 100644 index d8423ed29..000000000 --- a/doc/man/man3/qiconfactory.3qt +++ /dev/null @@ -1,98 +0,0 @@ -'\" t -.TH QIconFactory 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 -QIconFactory \- Used to create pixmaps for a QIconSet -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIconFactory\fR ()" -.br -.ti -1c -.BI "virtual \fB~QIconFactory\fR ()" -.br -.ti -1c -.BI "virtual QPixmap * \fBcreatePixmap\fR ( const QIconSet & iconSet, QIconSet::Size size, QIconSet::Mode mode, QIconSet::State state )" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool autoDelete )" -.br -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QIconFactory * \fBdefaultFactory\fR ()" -.br -.ti -1c -.BI "void \fBinstallDefaultFactory\fR ( QIconFactory * factory )" -.br -.in -1c -.SH DESCRIPTION -The QIconFactory class is used to create pixmaps for a QIconSet. -.PP -By reimplementing createPixmap(), you can override QIconSet's default algorithm for computing pixmaps not supplied by the user. -.PP -Call setAutoDelete(TRUE) if you want the factory to automatically delete itself when it is no longer needed by QIconSet. -.PP -See also QIconSet and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIconFactory::QIconFactory ()" -Constructs an icon factory. -.SH "QIconFactory::~QIconFactory ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "bool QIconFactory::autoDelete () const" -Returns TRUE if auto-deletion is enabled; otherwise returns FALSE. -.PP -See also setAutoDelete(). -.SH "QPixmap * QIconFactory::createPixmap ( const QIconSet & iconSet, QIconSet::Size size, QIconSet::Mode mode, QIconSet::State state )\fC [virtual]\fR" -Ceates a pixmap for \fIiconSet\fR with a certain \fIsize\fR, \fImode\fR, and \fIstate\fR. Returns 0 if the default QIconSet algorithm should be used to create a pixmap that wasn't supplied by the user. -.PP -It is the caller's responsibility to delete the returned pixmap. -.PP -The default implementation always returns 0. -.SH "QIconFactory * QIconFactory::defaultFactory ()\fC [static]\fR" -Returns the default icon factory. -.PP -See also installDefaultFactory(). -.SH "void QIconFactory::installDefaultFactory ( QIconFactory * factory )\fC [static]\fR" -Replaces the default icon factory with \fIfactory\fR. -.SH "void QIconFactory::setAutoDelete ( bool autoDelete )" -If \fIautoDelete\fR is TRUE, sets the icon factory to automatically delete itself when it is no longer referenced by any QIconSet and isn't the default factory. If \fIautoDelete\fR is FALSE (the default) auto-deletion is disabled. -.PP -See also autoDelete() and defaultFactory(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qiconfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qiconfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qiconset.3qt b/doc/man/man3/qiconset.3qt deleted file mode 100644 index 8e63bf980..000000000 --- a/doc/man/man3/qiconset.3qt +++ /dev/null @@ -1,284 +0,0 @@ -'\" t -.TH QIconSet 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 -QIconSet \- Set of icons with different styles and sizes -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBSize\fR { Automatic, Small, Large }" -.br -.ti -1c -.BI "enum \fBMode\fR { Normal, Disabled, Active }" -.br -.ti -1c -.BI "enum \fBState\fR { On, Off }" -.br -.ti -1c -.BI "\fBQIconSet\fR ()" -.br -.ti -1c -.BI "\fBQIconSet\fR ( const QPixmap & pixmap, Size size = Automatic )" -.br -.ti -1c -.BI "\fBQIconSet\fR ( const QPixmap & smallPix, const QPixmap & largePix )" -.br -.ti -1c -.BI "\fBQIconSet\fR ( const QIconSet & other )" -.br -.ti -1c -.BI "virtual \fB~QIconSet\fR ()" -.br -.ti -1c -.BI "void \fBreset\fR ( const QPixmap & pixmap, Size size )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & pixmap, Size size, Mode mode = Normal, State state = Off )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QString & fileName, Size size, Mode mode = Normal, State state = Off )" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR ( Size size, Mode mode, State state = Off ) const" -.br -.ti -1c -.BI "QPixmap pixmap ( Size size, bool enabled, State state = Off ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR () const" -.br -.ti -1c -.BI "bool \fBisGenerated\fR ( Size size, Mode mode, State state = Off ) const" -.br -.ti -1c -.BI "void \fBclearGenerated\fR ()" -.br -.ti -1c -.BI "void \fBinstallIconFactory\fR ( QIconFactory * factory )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "void \fBdetach\fR ()" -.br -.ti -1c -.BI "QIconSet & \fBoperator=\fR ( const QIconSet & other )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBsetIconSize\fR ( Size which, const QSize & size )" -.br -.ti -1c -.BI "const QSize & \fBiconSize\fR ( Size which )" -.br -.in -1c -.SH DESCRIPTION -The QIconSet class provides a set of icons with different styles and sizes. -.PP -A QIconSet can generate smaller, larger, active, and disabled pixmaps from the set of icons it is given. Such pixmaps are used by QToolButton, QHeader, QPopupMenu, etc. to show an icon representing a particular action. -.PP -The simplest use of QIconSet is to create one from a QPixmap and then use it, allowing Qt to work out all the required icon styles and sizes. For example: -.PP -.nf -.br - QToolButton *but = new QToolButton( QIconSet( QPixmap("open.xpm") ), ... ); -.br -.fi -.PP -Using whichever pixmaps you specify as a base, QIconSet provides a set of six icons, each with a Size and a Mode: Small Normal, Small Disabled, Small Active, Large Normal, Large Disabled, and Large Active. -.PP -An additional set of six icons can be provided for widgets that have an "On" or "Off" state, like checkable menu items or toggleable toolbuttons. If you provide pixmaps for the "On" state, but not for the "Off" state, the QIconSet will provide the "Off" pixmaps. You may specify icons for both states in you wish. -.PP -You can set any of the icons using setPixmap(). -.PP -When you retrieve a pixmap using pixmap(Size, Mode, State), QIconSet will return the icon that has been set or previously generated for that size, mode and state combination. If none is available, QIconSet will ask the icon factory. If the icon factory cannot provide any (the default), QIconSet generates a pixmap based on the pixmaps it has been given and returns it. -.PP -The Disabled appearance is computed using an algorithm that produces results very similar to those used in Microsoft Windows 95. The Active appearance is identical to the Normal appearance unless you use setPixmap() to set it to something special. -.PP -When scaling icons, QIconSet uses smooth scaling, which can partially blend the color component of pixmaps. If the results look poor, the best solution is to supply pixmaps in both large and small sizes. -.PP -You can use the static function setIconSize() to set the preferred size of the generated large/small icons. The default small size is 22 x 22, while the default large size is 32 x 32. These sizes only affect generated icons. -.PP -The isGenerated() function returns TRUE if an icon was generated by QIconSet or by a factory; clearGenerated() clears all cached pixmaps. -.SH "Making Classes that Use QIconSet" -If you write your own widgets that have an option to set a small pixmap, consider allowing a QIconSet to be set for that pixmap. The Qt class QToolButton is an example of such a widget. -.PP -Provide a method to set a QIconSet, and when you draw the icon, choose whichever icon is appropriate for the current state of your widget. For example: -.PP -.nf -.br - void MyWidget::drawIcon( QPainter* p, QPoint pos ) -.br - { -.br - p->drawPixmap( pos, icons->pixmap( -.br - QIconSet::Small, -.br - isEnabled() ? QIconSet::Normal : -.br - QIconSet::Disabled, -.br - isEnabled() ? QIconSet::On : -.br - QIconSet::Off)); -.br - } -.br -.fi -.PP -You might also make use of the Active mode, perhaps making your widget Active when the mouse is over the widget (see QWidget::enterEvent()), while the mouse is pressed pending the release that will activate the function, or when it is the currently selected item. If the widget can be toggled, the "On" mode might be used to draw a different icon. -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.PP -See also QIconFactory, QPixmap, QMainWindow::usesBigPixmaps, GUI Design Handbook: Iconic Label, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SS "Member Type Documentation" -.SH "QIconSet::Mode" -This enum type describes the mode for which a pixmap is intended to be used. The currently defined modes are: -.TP -\fCQIconSet::Normal\fR - Display the pixmap when the user is not interacting with the icon, but the functionality represented by the icon is available. -.TP -\fCQIconSet::Disabled\fR - Display the pixmap when the functionality represented by the icon is not available. -.TP -\fCQIconSet::Active\fR - Display the pixmap when the functionality represented by the icon is available and the user is interacting with the icon, for example, moving the mouse over it or clicking it. -.SH "QIconSet::Size" -This enum type describes the size at which a pixmap is intended to be used. The currently defined sizes are: -.TP -\fCQIconSet::Automatic\fR - The size of the pixmap is determined from its pixel size. This is a useful default. -.TP -\fCQIconSet::Small\fR - The pixmap is the smaller of two. -.TP -\fCQIconSet::Large\fR - The pixmap is the larger of two. -.PP -If a Small pixmap is not set by QIconSet::setPixmap(), the Large pixmap will be automatically scaled down to the size of a small pixmap to generate the Small pixmap when required. Similarly, a Small pixmap will be automatically scaled up to generate a Large pixmap. The preferred sizes for large/small generated icons can be set using setIconSize(). -.PP -See also setIconSize(), iconSize(), setPixmap(), pixmap(), and QMainWindow::usesBigPixmaps. -.SH "QIconSet::State" -This enum describes the state for which a pixmap is intended to be used. The \fIstate\fR can be: -.TP -\fCQIconSet::Off\fR - Display the pixmap when the widget is in an "off" state -.TP -\fCQIconSet::On\fR - Display the pixmap when the widget is in an "on" state -.PP -See also setPixmap() and pixmap(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIconSet::QIconSet ()" -Constructs a null icon set. -.PP -See also setPixmap() and reset(). -.SH "QIconSet::QIconSet ( const QPixmap & pixmap, Size size = Automatic )" -Constructs an icon set for which the Normal pixmap is \fIpixmap\fR, which is assumed to be of size \fIsize\fR. -.PP -The default for \fIsize\fR is Automatic, which means that QIconSet will determine whether the pixmap is Small or Large from its pixel size. Pixmaps less than the width of a small generated icon are considered to be Small. You can use setIconSize() to set the preferred size of a generated icon. -.PP -See also setIconSize() and reset(). -.SH "QIconSet::QIconSet ( const QPixmap & smallPix, const QPixmap & largePix )" -Creates an iconset which uses the pixmap \fIsmallPix\fR for for displaying a small icon, and the pixmap \fIlargePix\fR for displaying a large icon. -.SH "QIconSet::QIconSet ( const QIconSet & other )" -Constructs a copy of \fIother\fR. This is very fast. -.SH "QIconSet::~QIconSet ()\fC [virtual]\fR" -Destroys the icon set and frees any allocated resources. -.SH "void QIconSet::clearGenerated ()" -Clears all cached pixmaps, including those obtained from an eventual QIconFactory. -.SH "void QIconSet::detach ()" -Detaches this icon set from others with which it may share data. -.PP -You will never need to call this function; other QIconSet functions call it as necessary. -.SH "const QSize & QIconSet::iconSize ( Size which )\fC [static]\fR" -If \fIwhich\fR is Small, returns the preferred size of a small generated icon; if \fIwhich\fR is Large, returns the preferred size of a large generated icon. -.PP -See also setIconSize(). -.SH "void QIconSet::installIconFactory ( QIconFactory * factory )" -Installs \fIfactory\fR as the icon factory for this iconset. The icon factory is used to generates pixmaps not set by the user. -.PP -If no icon factory is installed, QIconFactory::defaultFactory() is used. -.SH "bool QIconSet::isGenerated ( Size size, Mode mode, State state = Off ) const" -Returns TRUE if the pixmap with size \fIsize\fR, mode \fImode\fR and state \fIstate\fR is generated from other pixmaps; otherwise returns FALSE. -.PP -A pixmap obtained from a QIconFactory is considered non-generated. -.SH "bool QIconSet::isNull () const" -Returns TRUE if the icon set is empty; otherwise returns FALSE. -.SH "QIconSet & QIconSet::operator= ( const QIconSet & other )" -Assigns \fIother\fR to this icon set and returns a reference to this icon set. -.PP -See also detach(). -.SH "QPixmap QIconSet::pixmap ( Size size, Mode mode, State state = Off ) const" -Returns a pixmap with size \fIsize\fR, mode \fImode\fR and state \fIstate\fR, generating one if necessary. Generated pixmaps are cached. -.SH "QPixmap QIconSet::pixmap ( Size size, bool enabled, State state = Off ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is the same as pixmap(\fIsize\fR, \fIenabled\fR, \fIstate\fR). -.SH "QPixmap QIconSet::pixmap () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the pixmap originally provided to the constructor or to reset(). This is the Normal pixmap of unspecified Size. -.PP -See also reset(). -.SH "void QIconSet::reset ( const QPixmap & pixmap, Size size )" -Sets this icon set to use pixmap \fIpixmap\fR for the Normal pixmap, assuming it to be of size \fIsize\fR. -.PP -This is equivalent to assigning QIconSet(\fIpixmap\fR, \fIsize\fR) to this icon set. -.PP -This function does nothing if \fIpixmap\fR is a null pixmap. -.SH "void QIconSet::setIconSize ( Size which, const QSize & size )\fC [static]\fR" -Set the preferred size for all small or large icons that are generated after this call. If \fIwhich\fR is Small, sets the preferred size of small generated icons to \fIsize\fR. Similarly, if \fIwhich\fR is Large, sets the preferred size of large generated icons to \fIsize\fR. -.PP -Note that cached icons will not be regenerated, so it is recommended that you set the preferred icon sizes before generating any icon sets. Also note that the preferred icon sizes will be ignored for icon sets that have been created using both small and large pixmaps. -.PP -See also iconSize(). -.SH "void QIconSet::setPixmap ( const QPixmap & pixmap, Size size, Mode mode = Normal, State state = Off )\fC [virtual]\fR" -Sets this icon set to provide pixmap \fIpixmap\fR for size \fIsize\fR, mode \fImode\fR and state \fIstate\fR. The icon set may also use \fIpixmap\fR for generating other pixmaps if they are not explicitly set. -.PP -The \fIsize\fR can be one of Automatic, Large or Small. If Automatic is used, QIconSet will determine if the pixmap is Small or Large from its pixel size. -.PP -Pixmaps less than the width of a small generated icon are considered to be Small. You can use setIconSize() to set the preferred size of a generated icon. -.PP -This function does nothing if \fIpixmap\fR is a null pixmap. -.PP -See also reset(). -.SH "void QIconSet::setPixmap ( const QString & fileName, Size size, Mode mode = Normal, State state = Off )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The pixmap is loaded from \fIfileName\fR when it becomes necessary. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqiconset.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qiconset.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qiconview.3qt b/doc/man/man3/qiconview.3qt deleted file mode 100644 index 516ac408a..000000000 --- a/doc/man/man3/qiconview.3qt +++ /dev/null @@ -1,961 +0,0 @@ -'\" t -.TH QIconView 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 -QIconView \- Area with movable labelled icons -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QScrollView. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBSelectionMode\fR { Single = 0, Multi, Extended, NoSelection }" -.br -.ti -1c -.BI "enum \fBArrangement\fR { LeftToRight = 0, TopToBottom }" -.br -.ti -1c -.BI "enum \fBResizeMode\fR { Fixed = 0, Adjust }" -.br -.ti -1c -.BI "enum \fBItemTextPos\fR { Bottom = 0, Right }" -.br -.ti -1c -.BI "\fBQIconView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "virtual \fB~QIconView\fR ()" -.br -.ti -1c -.BI "virtual void \fBinsertItem\fR ( QIconViewItem * item, QIconViewItem * after = 0L )" -.br -.ti -1c -.BI "virtual void \fBtakeItem\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "int \fBindex\fR ( const QIconViewItem * item ) const" -.br -.ti -1c -.BI "QIconViewItem * \fBfirstItem\fR () const" -.br -.ti -1c -.BI "QIconViewItem * \fBlastItem\fR () const" -.br -.ti -1c -.BI "QIconViewItem * \fBcurrentItem\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCurrentItem\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "virtual void \fBsetSelected\fR ( QIconViewItem * item, bool s, bool cb = FALSE )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSelectionMode\fR ( SelectionMode m )" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR () const" -.br -.ti -1c -.BI "QIconViewItem * \fBfindItem\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "QIconViewItem * \fBfindItem\fR ( const QString & text, ComparisonFlags compare = BeginsWith ) const" -.br -.ti -1c -.BI "virtual void \fBselectAll\fR ( bool select )" -.br -.ti -1c -.BI "virtual void \fBclearSelection\fR ()" -.br -.ti -1c -.BI "virtual void \fBinvertSelection\fR ()" -.br -.ti -1c -.BI "virtual void \fBrepaintItem\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBrepaintSelectedItems\fR ()" -.br -.ti -1c -.BI "void \fBensureItemVisible\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "QIconViewItem * \fBfindFirstVisibleItem\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "QIconViewItem * \fBfindLastVisibleItem\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetGridX\fR ( int rx )" -.br -.ti -1c -.BI "virtual void \fBsetGridY\fR ( int ry )" -.br -.ti -1c -.BI "int \fBgridX\fR () const" -.br -.ti -1c -.BI "int \fBgridY\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSpacing\fR ( int sp )" -.br -.ti -1c -.BI "int \fBspacing\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetItemTextPos\fR ( ItemTextPos pos )" -.br -.ti -1c -.BI "ItemTextPos \fBitemTextPos\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetItemTextBackground\fR ( const QBrush & b )" -.br -.ti -1c -.BI "QBrush \fBitemTextBackground\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetArrangement\fR ( Arrangement am )" -.br -.ti -1c -.BI "Arrangement \fBarrangement\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetResizeMode\fR ( ResizeMode am )" -.br -.ti -1c -.BI "ResizeMode \fBresizeMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMaxItemWidth\fR ( int w )" -.br -.ti -1c -.BI "int \fBmaxItemWidth\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMaxItemTextLength\fR ( int w )" -.br -.ti -1c -.BI "int \fBmaxItemTextLength\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoArrange\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBautoArrange\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetShowToolTips\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBshowToolTips\fR () const" -.br -.ti -1c -.BI "void \fBsetSorting\fR ( bool sort, bool ascending = TRUE )" -.br -.ti -1c -.BI "bool \fBsorting\fR () const" -.br -.ti -1c -.BI "bool \fBsortDirection\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetItemsMovable\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBitemsMovable\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetWordWrapIconText\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBwordWrapIconText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsort\fR ( bool ascending = TRUE )" -.br -.ti -1c -.BI "bool \fBisRenaming\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBarrangeItemsInGrid\fR ( const QSize & grid, bool update = TRUE )" -.br -.ti -1c -.BI "virtual void \fBarrangeItemsInGrid\fR ( bool update = TRUE )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBselectionChanged\fR ()" -.br -.ti -1c -.BI "void \fBselectionChanged\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBcurrentChanged\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBclicked\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBclicked\fR ( QIconViewItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBpressed\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBpressed\fR ( QIconViewItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBdoubleClicked\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBreturnPressed\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBrightButtonClicked\fR ( QIconViewItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBrightButtonPressed\fR ( QIconViewItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBmouseButtonPressed\fR ( int button, QIconViewItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBmouseButtonClicked\fR ( int button, QIconViewItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBcontextMenuRequested\fR ( QIconViewItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBdropped\fR ( QDropEvent * e, const QValueList & lst )" -.br -.ti -1c -.BI "void \fBmoved\fR ()" -.br -.ti -1c -.BI "void \fBonItem\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "void \fBonViewport\fR ()" -.br -.ti -1c -.BI "void \fBitemRenamed\fR ( QIconViewItem * item, const QString & name )" -.br -.ti -1c -.BI "void \fBitemRenamed\fR ( QIconViewItem * item )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "Arrangement \fBarrangement\fR - the arrangement mode of the icon view" -.br -.ti -1c -.BI "bool \fBautoArrange\fR - whether the icon view rearranges its items when a new item is inserted" -.br -.ti -1c -.BI "uint \fBcount\fR - the number of items in the icon view \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBgridX\fR - the horizontal grid of the icon view" -.br -.ti -1c -.BI "int \fBgridY\fR - the vertical grid of the icon view" -.br -.ti -1c -.BI "QBrush \fBitemTextBackground\fR - the brush to use when drawing the background of an item's text" -.br -.ti -1c -.BI "ItemTextPos \fBitemTextPos\fR - the position where the text of each item is drawn" -.br -.ti -1c -.BI "bool \fBitemsMovable\fR - whether the user is allowed to move items around in the icon view" -.br -.ti -1c -.BI "int \fBmaxItemTextLength\fR - the maximum length (in " "characters" ") that an item's text may have" -.br -.ti -1c -.BI "int \fBmaxItemWidth\fR - the maximum width that an item may have" -.br -.ti -1c -.BI "ResizeMode \fBresizeMode\fR - the resize mode of the icon view" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR - the selection mode of the icon view" -.br -.ti -1c -.BI "bool \fBshowToolTips\fR - whether the icon view will display a tool tip with the complete text for any truncated item text" -.br -.ti -1c -.BI "bool \fBsortDirection\fR - whether the sort direction for inserting new items is ascending; \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBsorting\fR - whether the icon view sorts on insertion \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBspacing\fR - the space in pixels between icon view items" -.br -.ti -1c -.BI "bool \fBwordWrapIconText\fR - whether the item text will be word-wrapped if it is too long" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawRubber\fR ( QPainter * p )" -.br -.ti -1c -.BI "virtual QDragObject * \fBdragObject\fR ()" -.br -.ti -1c -.BI "virtual void \fBstartDrag\fR ()" -.br -.ti -1c -.BI "virtual void \fBinsertInGrid\fR ( QIconViewItem * item )" -.br -.ti -1c -.BI "virtual void \fBdrawBackground\fR ( QPainter * p, const QRect & r )" -.br -.ti -1c -.BI "void \fBemitSelectionChanged\fR ( QIconViewItem * i = 0 )" -.br -.ti -1c -.BI "QIconViewItem * \fBmakeRowLayout\fR ( QIconViewItem * begin, int & y, bool & changed )" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "virtual void \fBdoAutoScroll\fR ()" -.br -.ti -1c -.BI "virtual void \fBadjustItems\fR ()" -.br -.ti -1c -.BI "virtual void \fBslotUpdate\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QIconView class provides an area with movable labelled icons. -.PP -A QIconView can display and manage a grid or other 2D layout of labelled icons. Each labelled icon is a QIconViewItem. Items (QIconViewItems) can be added or deleted at any time; items can be moved within the QIconView. Single or multiple items can be selected. Items can be renamed in-place. QIconView also supports drag and drop. -.PP -Each item contains a label string, a pixmap or picture (the icon itself) and optionally a sort key. The sort key is used for sorting the items and defaults to the label string. The label string can be displayed below or to the right of the icon (see ItemTextPos). -.PP -The simplest way to create a QIconView is to create a QIconView object and create some QIconViewItems with the QIconView as their parent, set the icon view's geometry and show it. For example: -.PP -.nf -.br - QIconView *iv = new QIconView( this ); -.br - QDir dir( path, "*.xpm" ); -.br - for ( uint i = 0; i < dir.count(); i++ ) { -.br - (void) new QIconViewItem( iv, dir[i], QPixmap( path + dir[i] ) ); -.br - } -.br - iv->resize( 600, 400 ); -.br - iv->show(); -.br -.fi -.PP -The QIconViewItem call passes a pointer to the QIconView we wish to populate, along with the label text and a QPixmap. -.PP -When an item is inserted the QIconView allocates a position for it. Existing items are rearranged if autoArrange() is TRUE. The default arrangement is LeftToRight -- the QIconView fills up the \fIleft-most\fR column from top to bottom, then moves one column \fIright\fR and fills that from top to bottom and so on. The arrangement can be modified with any of the following approaches: -.TP -Call setArrangement(), e.g. with TopToBottom which will fill the \fItop-most\fR row from left to right, then moves one row \fIdown\fR and fills that row from left to right and so on. -.TP -Construct each QIconViewItem using a constructor which allows you to specify which item the new one is to follow. -.TP -Call setSorting() or sort() to sort the items. -.PP -The spacing between items is set with setSpacing(). Items can be laid out using a fixed grid using setGridX() and setGridY(); by default the QIconView calculates a grid dynamically. The position of items' label text is set with setItemTextPos(). The text's background can be set with setItemTextBackground(). The maximum width of an item and of its text are set with setMaxItemWidth() and setMaxItemTextLength(). The label text will be word-wrapped if it is too long; this is controlled by setWordWrapIconText(). If the label text is truncated, the user can still see the entire text in a tool tip if they hover the mouse over the item. This is controlled with setShowToolTips(). -.PP -Items which are selectable may be selected depending on the SelectionMode; the default is Single. Because QIconView offers multiple selection it must display keyboard focus and selection state separately. Therefore there are functions to set the selection state of an item (setSelected()) and to select which item displays keyboard focus (setCurrentItem()). When multiple items may be selected the icon view provides a rubberband, too. -.PP -When in-place renaming is enabled (it is disabled by default), the user may change the item's label. They do this by selecting the item (single clicking it or navigating to it with the arrow keys), then single clicking it (or pressing F2), and entering their text. If no key has been set with QIconViewItem::setKey() the new text will also serve as the key. (See QIconViewItem::setRenameEnabled().) -.PP -You can control whether users can move items themselves with setItemsMovable(). -.PP -Because the internal structure used to store the icon view items is linear, no iterator class is needed to iterate over all the items. Instead we iterate by getting the first item from the \fIicon view\fR and then each subsequent (QIconViewItem::nextItem()) from each \fIitem\fR in turn: -.PP -.nf -.br - for ( QIconViewItem *item = iv->firstItem(); item; item = item->nextItem() ) -.br - do_something( item ); -.br -.fi -QIconView also provides currentItem(). You can search for an item using findItem() (searching by position or for label text) and with findFirstVisibleItem() and findLastVisibleItem(). The number of items is returned by count(). An item can be removed from an icon view using takeItem(); to delete an item use \fCdelete\fR. All the items can be deleted with clear(). -.PP -The QIconView emits a wide range of useful signals, including selectionChanged(), currentChanged(), clicked(), moved() and itemRenamed(). -.SH "Drag and Drop" -QIconView supports the drag and drop of items within the QIconView itself. It also supports the drag and drop of items out of or into the QIconView and drag and drop onto items themselves. The drag and drop of items outside the QIconView can be achieved in a simple way with basic functionality, or in a more sophisticated way which provides more power and control. -.PP -The simple approach to dragging items out of the icon view is to subclass QIconView and reimplement QIconView::dragObject(). -.PP -.nf -.br - QDragObject *MyIconView::dragObject() -.br - { -.br - return new QTextDrag( currentItem()->text(), this ); -.br - } -.br -.fi -.PP -In this example we create a QTextDrag object, (derived from QDragObject), containing the item's label and return it as the drag object. We could just as easily have created a QImageDrag from the item's pixmap and returned that instead. -.PP -QIconViews and their QIconViewItems can also be the targets of drag and drops. To make the QIconView itself able to accept drops connect to the dropped() signal. When a drop occurs this signal will be emitted with a QDragEvent and a QValueList of QIconDragItems. To make a QIconViewItem into a drop target subclass QIconViewItem and reimplement QIconViewItem::acceptDrop() and QIconViewItem::dropped(). -.PP -.nf -.br - bool MyIconViewItem::acceptDrop( const QMimeSource *mime ) const -.br - { -.br - if ( mime->provides( "text/plain" ) ) -.br - return TRUE; -.br - return FALSE; -.br - } -.br -.br - void MyIconViewItem::dropped( QDropEvent *evt, const QValueList& ) -.br - { -.br - QString label; -.br - if ( QTextDrag::decode( evt, label ) ) -.br - setText( label ); -.br - } -.br -.fi -.PP -See iconview/simple_dd/main.h and iconview/simple_dd/main.cpp for a simple drag and drop example which demonstrates drag and drop between a QIconView and a QListBox. -.PP -If you want to use extended drag-and-drop or have drag shapes drawn you must take a more sophisticated approach. -.PP -The first part is starting drags -- you should use a QIconDrag (or a class derived from it) for the drag object. In dragObject() create the drag object, populate it with QIconDragItems and return it. Normally such a drag should offer each selected item's data. So in dragObject() you should iterate over all the items, and create a QIconDragItem for each selected item, and append these items with QIconDrag::append() to the QIconDrag object. You can use QIconDragItem::setData() to set the data of each item that should be dragged. If you want to offer the data in additional mime-types, it's best to use a class derived from QIconDrag, which implements additional encoding and decoding functions. -.PP -When a drag enters the icon view, there is little to do. Simply connect to the dropped() signal and reimplement QIconViewItem::acceptDrop() and QIconViewItem::dropped(). If you've used a QIconDrag (or a subclass of it) the second argument to the dropped signal contains a QValueList of QIconDragItems -- you can access their data by calling QIconDragItem::data() on each one. -.PP -For an example implementation of complex drag-and-drop look at the fileiconview example (qt/examples/fileiconview). -.PP -See also QIconViewItem::setDragEnabled(), QIconViewItem::setDropEnabled(), QIconViewItem::acceptDrop(), QIconViewItem::dropped(), and Advanced Widgets. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -.SS "Member Type Documentation" -.SH "QIconView::Arrangement" -This enum type determines in which direction the items flow when the view runs out of space. -.TP -\fCQIconView::LeftToRight\fR - Items which don't fit into the view cause the viewport to extend vertically (you get a vertical scrollbar). -.TP -\fCQIconView::TopToBottom\fR - Items which don't fit into the view cause the viewport to extend horizontally (you get a horizontal scrollbar). -.SH "QIconView::ItemTextPos" -This enum type specifies the position of the item text in relation to the icon. -.TP -\fCQIconView::Bottom\fR - The text is drawn below the icon. -.TP -\fCQIconView::Right\fR - The text is drawn to the right of the icon. -.SH "QIconView::ResizeMode" -This enum type is used to tell QIconView how it should treat the positions of its icons when the widget is resized. The modes are: -.TP -\fCQIconView::Fixed\fR - The icons' positions are not changed. -.TP -\fCQIconView::Adjust\fR - The icons' positions are adjusted to be within the new geometry, if possible. -.SH "QIconView::SelectionMode" -This enumerated type is used by QIconView to indicate how it reacts to selection by the user. It has four values: -.TP -\fCQIconView::Single\fR - When the user selects an item, any already-selected item becomes unselected and the user cannot unselect the selected item. This means that the user can never clear the selection. (The application programmer can, using QIconView::clearSelection().) -.TP -\fCQIconView::Multi\fR - When the user selects an item, e.g. by navigating to it with the keyboard arrow keys or by clicking it, the selection status of that item is toggled and the other items are left alone. Also, multiple items can be selected by dragging the mouse while the left mouse button stays pressed. -.TP -\fCQIconView::Extended\fR - When the user selects an item the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item get selected or unselected, depending on the state of the clicked item. Also, multiple items can be selected by dragging the mouse while the left mouse button stays pressed. -.TP -\fCQIconView::NoSelection\fR - Items cannot be selected. -.PP -To summarise: Single is a real single-selection icon view; Multi a real multi-selection icon view; Extended is an icon view in which users can select multiple items but usually want to select either just one or a range of contiguous items; and NoSelection mode is for an icon view where the user can look but not touch. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIconView::QIconView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs an empty icon view called \fIname\fR, with parent \fIparent\fR and using the widget flags \fIf\fR. -.SH "QIconView::~QIconView ()\fC [virtual]\fR" -Destroys the icon view and deletes all items. -.SH "void QIconView::adjustItems ()\fC [virtual protected slot]\fR" -Adjusts the positions of the items to the geometry of the icon view. -.SH "void QIconView::arrangeItemsInGrid ( const QSize & grid, bool update = TRUE )\fC [virtual slot]\fR" -This variant uses \fIgrid\fR instead of (gridX(), gridY()). If \fIgrid\fR is invalid (see QSize::isValid()), arrangeItemsInGrid() calculates a valid grid itself and uses that. -.PP -If \fIupdate\fR is TRUE (the default) the viewport is repainted. -.PP -Example: fileiconview/qfileiconview.h. -.SH "void QIconView::arrangeItemsInGrid ( bool update = TRUE )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Arranges all the items in the grid given by gridX() and gridY(). -.PP -Even if sorting() is enabled, the items are not sorted by this function. If you want to sort or rearrange the items, use iconview->sort(iconview->sortDirection()). -.PP -If \fIupdate\fR is TRUE (the default), the viewport is repainted as well. -.PP -See also QIconView::gridX, QIconView::gridY, and QIconView::sort(). -.SH "Arrangement QIconView::arrangement () const" -Returns the arrangement mode of the icon view. See the "arrangement" property for details. -.SH "bool QIconView::autoArrange () const" -Returns TRUE if the icon view rearranges its items when a new item is inserted; otherwise returns FALSE. See the "autoArrange" property for details. -.SH "void QIconView::clear ()\fC [virtual]\fR" -Clears the icon view. All items are deleted. -.SH "void QIconView::clearSelection ()\fC [virtual]\fR" -Unselects all the items. -.SH "void QIconView::clicked ( QIconViewItem * item )\fC [signal]\fR" -This signal is emitted when the user clicks any mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. -.PP -See also mouseButtonClicked(), rightButtonClicked(), and pressed(). -.SH "void QIconView::clicked ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user clicks any mouse button on an icon view item. \fIitem\fR is a pointer to the item that has been clicked. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) -.PP -See also mouseButtonClicked(), rightButtonClicked(), and pressed(). -.SH "void QIconView::contextMenuRequested ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user invokes a context menu with the right mouse button or with special system keys, with \fIitem\fR being the item under the mouse cursor or the current item, respectively. -.PP -\fIpos\fR is the position for the context menu in the global coordinate system. -.SH "uint QIconView::count () const" -Returns the number of items in the icon view. See the "count" property for details. -.SH "void QIconView::currentChanged ( QIconViewItem * item )\fC [signal]\fR" -This signal is emitted when a new item becomes current. \fIitem\fR is the new current item (or 0 if no item is now current). -.PP -See also currentItem(). -.SH "QIconViewItem * QIconView::currentItem () const" -Returns a pointer to the current item of the icon view, or 0 if no item is current. -.PP -See also setCurrentItem(), firstItem(), and lastItem(). -.SH "void QIconView::doAutoScroll ()\fC [virtual protected slot]\fR" -Performs autoscrolling when selecting multiple icons with the rubber band. -.SH "void QIconView::doubleClicked ( QIconViewItem * item )\fC [signal]\fR" -This signal is emitted when the user double-clicks on \fIitem\fR. -.SH "QDragObject * QIconView::dragObject ()\fC [virtual protected]\fR" -Returns the QDragObject that should be used for drag-and-drop. This function is called by the icon view when starting a drag to get the dragobject that should be used for the drag. Subclasses may reimplement this. -.PP -See also QIconDrag. -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp. -.SH "void QIconView::drawBackground ( QPainter * p, const QRect & r )\fC [virtual protected]\fR" -This function is called to draw the rectangle \fIr\fR of the background using the painter \fIp\fR. -.PP -The default implementation fills \fIr\fR with the viewport's backgroundBrush(). Subclasses may reimplement this to draw custom backgrounds. -.PP -See also contentsX, contentsY, and drawContents(). -.SH "void QIconView::drawRubber ( QPainter * p )\fC [virtual protected]\fR" -Draws the rubber band using the painter \fIp\fR. -.SH "void QIconView::dropped ( QDropEvent * e, const QValueList & lst )\fC [signal]\fR" -This signal is emitted when a drop event occurs in the viewport (but not on any icon) which the icon view itself can't handle. -.PP -\fIe\fR provides all the information about the drop. If the drag object of the drop was a QIconDrag, \fIlst\fR contains the list of the dropped items. You can get the data using QIconDragItem::data() on each item. If the \fIlst\fR is empty, i.e. the drag was not a QIconDrag, you have to decode the data in \fIe\fR and work with that. -.PP -Note QIconViewItems may be drop targets; if a drop event occurs on an item the item handles the drop. -.PP -Examples: -.)l iconview/main.cpp and iconview/simple_dd/main.cpp. -.SH "void QIconView::emitSelectionChanged ( QIconViewItem * i = 0 )\fC [protected]\fR" -Emits a signal to indicate selection changes. \fIi\fR is the QIconViewItem that was selected or de-selected. -.PP -\fIYou should never need to call this function.\fR -.SH "void QIconView::ensureItemVisible ( QIconViewItem * item )" -Makes sure that \fIitem\fR is entirely visible. If necessary, ensureItemVisible() scrolls the icon view. -.PP -See also ensureVisible(). -.SH "QIconViewItem * QIconView::findFirstVisibleItem ( const QRect & r ) const" -Finds the first item whose bounding rectangle overlaps \fIr\fR and returns a pointer to that item. \fIr\fR is given in content coordinates. Returns 0 if no item overlaps \fIr\fR. -.PP -If you want to find all items that touch \fIr\fR, you will need to use this function and nextItem() in a loop ending at findLastVisibleItem() and test QIconViewItem::rect() for each of these items. -.PP -See also findLastVisibleItem() and QIconViewItem::rect(). -.SH "QIconViewItem * QIconView::findItem ( const QPoint & pos ) const" -Returns a pointer to the item that contains point \fIpos\fR, which is given in contents coordinates, or 0 if no item contains point \fIpos\fR. -.SH "QIconViewItem * QIconView::findItem ( const QString & text, ComparisonFlags compare = BeginsWith ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a pointer to the first item whose text begins with \fItext\fR, or 0 if no such item could be found. Use the \fIcompare\fR flag to control the comparison behaviour. (See Qt::StringComparisonMode.) -.SH "QIconViewItem * QIconView::findLastVisibleItem ( const QRect & r ) const" -Finds the last item whose bounding rectangle overlaps \fIr\fR and returns a pointer to that item. \fIr\fR is given in content coordinates. Returns 0 if no item overlaps \fIr\fR. -.PP -See also findFirstVisibleItem(). -.SH "QIconViewItem * QIconView::firstItem () const" -Returns a pointer to the first item of the icon view, or 0 if there are no items in the icon view. -.PP -See also lastItem() and currentItem(). -.SH "int QIconView::gridX () const" -Returns the horizontal grid of the icon view. See the "gridX" property for details. -.SH "int QIconView::gridY () const" -Returns the vertical grid of the icon view. See the "gridY" property for details. -.SH "int QIconView::index ( const QIconViewItem * item ) const" -Returns the index of \fIitem\fR, or -1 if \fIitem\fR doesn't exist in this icon view. -.SH "void QIconView::insertInGrid ( QIconViewItem * item )\fC [virtual protected]\fR" -Inserts the QIconViewItem \fIitem\fR in the icon view's grid. \fIYou should never need to call this function.\fR Instead, insert QIconViewItems by creating them with a pointer to the QIconView that they are to be inserted into. -.SH "void QIconView::insertItem ( QIconViewItem * item, QIconViewItem * after = 0L )\fC [virtual]\fR" -Inserts the icon view item \fIitem\fR after \fIafter\fR. If \fIafter\fR is 0, \fIitem\fR is appended after the last item. -.PP -\fIYou should never need to call this function.\fR Instead create QIconViewItem's and associate them with your icon view like this: -.PP -.nf -.br - (void) new QIconViewItem( myIconview, "The text of the item", aPixmap ); -.br -.fi -.SH "void QIconView::invertSelection ()\fC [virtual]\fR" -Inverts the selection. Works only in Multi and Extended selection mode. -.SH "bool QIconView::isRenaming () const" -Returns TRUE if an iconview item is being renamed; otherwise returns FALSE. -.SH "void QIconView::itemRenamed ( QIconViewItem * item, const QString & name )\fC [signal]\fR" -This signal is emitted when \fIitem\fR has been renamed to \fIname\fR, usually by in-place renaming. -.PP -See also QIconViewItem::setRenameEnabled() and QIconViewItem::rename(). -.SH "void QIconView::itemRenamed ( QIconViewItem * item )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when \fIitem\fR has been renamed, usually by in-place renaming. -.PP -See also QIconViewItem::setRenameEnabled() and QIconViewItem::rename(). -.SH "QBrush QIconView::itemTextBackground () const" -Returns the brush to use when drawing the background of an item's text. See the "itemTextBackground" property for details. -.SH "ItemTextPos QIconView::itemTextPos () const" -Returns the position where the text of each item is drawn. See the "itemTextPos" property for details. -.SH "bool QIconView::itemsMovable () const" -Returns TRUE if the user is allowed to move items around in the icon view; otherwise returns FALSE. See the "itemsMovable" property for details. -.SH "QIconViewItem * QIconView::lastItem () const" -Returns a pointer to the last item of the icon view, or 0 if there are no items in the icon view. -.PP -See also firstItem() and currentItem(). -.SH "QIconViewItem * QIconView::makeRowLayout ( QIconViewItem * begin, int & y, bool & changed )\fC [protected]\fR" -Lays out a row of icons (if Arrangement == TopToBottom this is a column). Starts laying out with the item \fIbegin\fR. \fIy\fR is the starting coordinate. Returns the last item of the row (column) and sets the new starting coordinate to \fIy\fR. The \fIchanged\fR parameter is used internally. -.PP -\fBWarning:\fR This function may be made private in a future version of Qt. We do not recommend calling it. -.SH "int QIconView::maxItemTextLength () const" -Returns the maximum length (in characters) that an item's text may have. See the "maxItemTextLength" property for details. -.SH "int QIconView::maxItemWidth () const" -Returns the maximum width that an item may have. See the "maxItemWidth" property for details. -.SH "void QIconView::mouseButtonClicked ( int button, QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user clicks mouse button \fIbutton\fR. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) -.PP -See also mouseButtonPressed(), rightButtonClicked(), and clicked(). -.SH "void QIconView::mouseButtonPressed ( int button, QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user presses mouse button \fIbutton\fR. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). -.PP -See also rightButtonClicked() and pressed(). -.SH "void QIconView::moved ()\fC [signal]\fR" -This signal is emitted after successfully dropping one (or more) items of the icon view. If the items should be removed, it's best to do so in a slot connected to this signal. -.PP -Example: iconview/main.cpp. -.SH "void QIconView::onItem ( QIconViewItem * item )\fC [signal]\fR" -This signal is emitted when the user moves the mouse cursor onto an \fIitem\fR, similar to the QWidget::enterEvent() function. -.SH "void QIconView::onViewport ()\fC [signal]\fR" -This signal is emitted when the user moves the mouse cursor from an item to an empty part of the icon view. -.PP -See also onItem(). -.SH "void QIconView::pressed ( QIconViewItem * item )\fC [signal]\fR" -This signal is emitted when the user presses any mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. -.PP -See also mouseButtonPressed(), rightButtonPressed(), and clicked(). -.SH "void QIconView::pressed ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user presses any mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) -.PP -See also mouseButtonPressed(), rightButtonPressed(), and clicked(). -.SH "void QIconView::repaintItem ( QIconViewItem * item )\fC [virtual]\fR" -Repaints the \fIitem\fR. -.SH "void QIconView::repaintSelectedItems ()" -Repaints the selected items. -.SH "ResizeMode QIconView::resizeMode () const" -Returns the resize mode of the icon view. See the "resizeMode" property for details. -.SH "void QIconView::returnPressed ( QIconViewItem * item )\fC [signal]\fR" -This signal is emitted if the user presses the Return or Enter key. \fIitem\fR is the currentItem() at the time of the keypress. -.SH "void QIconView::rightButtonClicked ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user clicks the right mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) -.PP -See also rightButtonPressed(), mouseButtonClicked(), and clicked(). -.SH "void QIconView::rightButtonPressed ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user presses the right mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). -.SH "void QIconView::selectAll ( bool select )\fC [virtual]\fR" -In Multi and Extended modes, this function sets all items to be selected if \fIselect\fR is TRUE, and to be unselected if \fIselect\fR is FALSE. -.PP -In Single and NoSelection modes, this function only changes the selection status of currentItem(). -.SH "void QIconView::selectionChanged ()\fC [signal]\fR" -This signal is emitted when the selection has been changed. It's emitted in each selection mode. -.SH "void QIconView::selectionChanged ( QIconViewItem * item )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the selection changes. \fIitem\fR is the newly selected item. This signal is emitted only in single selection mode. -.SH "SelectionMode QIconView::selectionMode () const" -Returns the selection mode of the icon view. See the "selectionMode" property for details. -.SH "void QIconView::setArrangement ( Arrangement am )\fC [virtual]\fR" -Sets the arrangement mode of the icon view to \fIam\fR. See the "arrangement" property for details. -.SH "void QIconView::setAutoArrange ( bool b )\fC [virtual]\fR" -Sets whether the icon view rearranges its items when a new item is inserted to \fIb\fR. See the "autoArrange" property for details. -.SH "void QIconView::setCurrentItem ( QIconViewItem * item )\fC [virtual]\fR" -Makes \fIitem\fR the new current item of the icon view. -.SH "void QIconView::setGridX ( int rx )\fC [virtual]\fR" -Sets the horizontal grid of the icon view to \fIrx\fR. See the "gridX" property for details. -.SH "void QIconView::setGridY ( int ry )\fC [virtual]\fR" -Sets the vertical grid of the icon view to \fIry\fR. See the "gridY" property for details. -.SH "void QIconView::setItemTextBackground ( const QBrush & b )\fC [virtual]\fR" -Sets the brush to use when drawing the background of an item's text to \fIb\fR. See the "itemTextBackground" property for details. -.SH "void QIconView::setItemTextPos ( ItemTextPos pos )\fC [virtual]\fR" -Sets the position where the text of each item is drawn to \fIpos\fR. See the "itemTextPos" property for details. -.SH "void QIconView::setItemsMovable ( bool b )\fC [virtual]\fR" -Sets whether the user is allowed to move items around in the icon view to \fIb\fR. See the "itemsMovable" property for details. -.SH "void QIconView::setMaxItemTextLength ( int w )\fC [virtual]\fR" -Sets the maximum length (in characters) that an item's text may have to \fIw\fR. See the "maxItemTextLength" property for details. -.SH "void QIconView::setMaxItemWidth ( int w )\fC [virtual]\fR" -Sets the maximum width that an item may have to \fIw\fR. See the "maxItemWidth" property for details. -.SH "void QIconView::setResizeMode ( ResizeMode am )\fC [virtual]\fR" -Sets the resize mode of the icon view to \fIam\fR. See the "resizeMode" property for details. -.SH "void QIconView::setSelected ( QIconViewItem * item, bool s, bool cb = FALSE )\fC [virtual]\fR" -Selects or unselects \fIitem\fR depending on \fIs\fR, and may also unselect other items, depending on QIconView::selectionMode() and \fIcb\fR. -.PP -If \fIs\fR is FALSE, \fIitem\fR is unselected. -.PP -If \fIs\fR is TRUE and QIconView::selectionMode() is Single, \fIitem\fR is selected, and the item which was selected is unselected. -.PP -If \fIs\fR is TRUE and QIconView::selectionMode() is Extended, \fIitem\fR is selected. If \fIcb\fR is TRUE, the selection state of the icon view's other items is left unchanged. If \fIcb\fR is FALSE (the default) all other items are unselected. -.PP -If \fIs\fR is TRUE and QIconView::selectionMode() is Multi \fIitem\fR is selected. -.PP -Note that \fIcb\fR is used only if QIconView::selectionMode() is Extended. \fIcb\fR defaults to FALSE. -.PP -All items whose selection status is changed repaint themselves. -.SH "void QIconView::setSelectionMode ( SelectionMode m )\fC [virtual]\fR" -Sets the selection mode of the icon view to \fIm\fR. See the "selectionMode" property for details. -.SH "void QIconView::setShowToolTips ( bool b )\fC [virtual]\fR" -Sets whether the icon view will display a tool tip with the complete text for any truncated item text to \fIb\fR. See the "showToolTips" property for details. -.SH "void QIconView::setSorting ( bool sort, bool ascending = TRUE )" -If \fIsort\fR is TRUE, this function sets the icon view to sort items when a new item is inserted. If \fIsort\fR is FALSE, the icon view will not be sorted. -.PP -Note that autoArrange() must be TRUE for sorting to take place. -.PP -If \fIascending\fR is TRUE (the default), items are sorted in ascending order. If \fIascending\fR is FALSE, items are sorted in descending order. -.PP -QIconViewItem::compare() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' text unless specifically set to something else. -.PP -See also QIconView::autoArrange, QIconView::autoArrange, sortDirection, sort(), and QIconViewItem::setKey(). -.SH "void QIconView::setSpacing ( int sp )\fC [virtual]\fR" -Sets the space in pixels between icon view items to \fIsp\fR. See the "spacing" property for details. -.SH "void QIconView::setWordWrapIconText ( bool b )\fC [virtual]\fR" -Sets whether the item text will be word-wrapped if it is too long to \fIb\fR. See the "wordWrapIconText" property for details. -.SH "bool QIconView::showToolTips () const" -Returns TRUE if the icon view will display a tool tip with the complete text for any truncated item text; otherwise returns FALSE. See the "showToolTips" property for details. -.SH "void QIconView::slotUpdate ()\fC [virtual protected slot]\fR" -This slot is used for a slightly-delayed update. -.PP -The icon view is not redrawn immediately after inserting a new item but after a very small delay using a QTimer. This means that when many items are inserted in a loop the icon view is probably redrawn only once at the end of the loop. This makes the insertions both flicker-free and faster. -.SH "void QIconView::sort ( bool ascending = TRUE )\fC [virtual]\fR" -Sorts and rearranges all the items in the icon view. If \fIascending\fR is TRUE, the items are sorted in increasing order, otherwise they are sorted in decreasing order. -.PP -QIconViewItem::compare() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' text unless specifically set to something else. -.PP -Note that this function sets the sort order to \fIascending\fR. -.PP -See also QIconViewItem::key(), QIconViewItem::setKey(), QIconViewItem::compare(), QIconView::setSorting(), and QIconView::sortDirection. -.SH "bool QIconView::sortDirection () const" -Returns TRUE if the sort direction for inserting new items is ascending;; otherwise returns FALSE. See the "sortDirection" property for details. -.SH "bool QIconView::sorting () const" -Returns TRUE if the icon view sorts on insertion; otherwise returns FALSE. See the "sorting" property for details. -.SH "int QIconView::spacing () const" -Returns the space in pixels between icon view items. See the "spacing" property for details. -.SH "void QIconView::startDrag ()\fC [virtual protected]\fR" -Starts a drag. -.SH "void QIconView::takeItem ( QIconViewItem * item )\fC [virtual]\fR" -Takes the icon view item \fIitem\fR out of the icon view and causes an update of the screen display. The item is not deleted. You should normally not need to call this function because QIconViewItem::~QIconViewItem() calls it. The normal way to delete an item is to delete it. -.SH "bool QIconView::wordWrapIconText () const" -Returns TRUE if the item text will be word-wrapped if it is too long; otherwise returns FALSE. See the "wordWrapIconText" property for details. -.SS "Property Documentation" -.SH "Arrangement arrangement" -This property holds the arrangement mode of the icon view. -.PP -This can be LeftToRight or TopToBottom. The default is LeftToRight. -.PP -Set this property's value with setArrangement() and get this property's value with arrangement(). -.SH "bool autoArrange" -This property holds whether the icon view rearranges its items when a new item is inserted. -.PP -The default is TRUE. -.PP -Note that if the icon view is not visible at the time of insertion, QIconView defers all position-related work until it is shown and then calls arrangeItemsInGrid(). -.PP -Set this property's value with setAutoArrange() and get this property's value with autoArrange(). -.SH "uint count" -This property holds the number of items in the icon view. -.PP -Get this property's value with count(). -.SH "int gridX" -This property holds the horizontal grid of the icon view. -.PP -If the value is -1, (the default), QIconView computes suitable column widths based on the icon view's contents. -.PP -Note that setting a grid width overrides setMaxItemWidth(). -.PP -Set this property's value with setGridX() and get this property's value with gridX(). -.SH "int gridY" -This property holds the vertical grid of the icon view. -.PP -If the value is -1, (the default), QIconView computes suitable column heights based on the icon view's contents. -.PP -Set this property's value with setGridY() and get this property's value with gridY(). -.SH "QBrush itemTextBackground" -This property holds the brush to use when drawing the background of an item's text. -.PP -By default this brush is set to NoBrush, meaning that only the normal icon view background is used. -.PP -Set this property's value with setItemTextBackground() and get this property's value with itemTextBackground(). -.SH "ItemTextPos itemTextPos" -This property holds the position where the text of each item is drawn. -.PP -Valid values are Bottom or Right. The default is Bottom. -.PP -Set this property's value with setItemTextPos() and get this property's value with itemTextPos(). -.SH "bool itemsMovable" -This property holds whether the user is allowed to move items around in the icon view. -.PP -The default is TRUE. -.PP -Set this property's value with setItemsMovable() and get this property's value with itemsMovable(). -.SH "int maxItemTextLength" -This property holds the maximum length (in characters) that an item's text may have. -.PP -The default is 255 characters. -.PP -Set this property's value with setMaxItemTextLength() and get this property's value with maxItemTextLength(). -.SH "int maxItemWidth" -This property holds the maximum width that an item may have. -.PP -The default is 100 pixels. -.PP -Note that if the gridX() value is set QIconView will ignore this property. -.PP -Set this property's value with setMaxItemWidth() and get this property's value with maxItemWidth(). -.SH "ResizeMode resizeMode" -This property holds the resize mode of the icon view. -.PP -This can be Fixed or Adjust. The default is Fixed. See ResizeMode. -.PP -Set this property's value with setResizeMode() and get this property's value with resizeMode(). -.SH "SelectionMode selectionMode" -This property holds the selection mode of the icon view. -.PP -This can be Single (the default), Extended, Multi or NoSelection. -.PP -Set this property's value with setSelectionMode() and get this property's value with selectionMode(). -.SH "bool showToolTips" -This property holds whether the icon view will display a tool tip with the complete text for any truncated item text. -.PP -The default is TRUE. Note that this has no effect if setWordWrapIconText() is TRUE, as it is by default. -.PP -Set this property's value with setShowToolTips() and get this property's value with showToolTips(). -.SH "bool sortDirection" -This property holds whether the sort direction for inserting new items is ascending;. -.PP -The default is TRUE (i.e. ascending). This sort direction is only meaningful if both sorting() and autoArrange() are TRUE. -.PP -To set the sort direction, use setSorting() -.PP -Get this property's value with sortDirection(). -.SH "bool sorting" -This property holds whether the icon view sorts on insertion. -.PP -The default is FALSE, i.e. no sorting on insertion. -.PP -To set the sorting, use setSorting(). -.PP -Get this property's value with sorting(). -.SH "int spacing" -This property holds the space in pixels between icon view items. -.PP -The default is 5 pixels. -.PP -Negative values for spacing are illegal. -.PP -Set this property's value with setSpacing() and get this property's value with spacing(). -.SH "bool wordWrapIconText" -This property holds whether the item text will be word-wrapped if it is too long. -.PP -The default is TRUE. -.PP -If this property is FALSE, icon text that is too long is truncated, and an ellipsis (...) appended to indicate that truncation has occurred. The full text can still be seen by the user if they hover the mouse because the full text is shown in a tooltip; see setShowToolTips(). -.PP -Set this property's value with setWordWrapIconText() and get this property's value with wordWrapIconText(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqiconview.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qiconview.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qiconviewitem.3qt b/doc/man/man3/qiconviewitem.3qt deleted file mode 100644 index ba3998678..000000000 --- a/doc/man/man3/qiconviewitem.3qt +++ /dev/null @@ -1,576 +0,0 @@ -'\" t -.TH QIconViewItem 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 -QIconViewItem \- Single item in a QIconView -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent )" -.br -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after )" -.br -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent, const QString & text )" -.br -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after, const QString & text )" -.br -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent, const QString & text, const QPixmap & icon )" -.br -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after, const QString & text, const QPixmap & icon )" -.br -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent, const QString & text, const QPicture & picture )" -.br -.ti -1c -.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after, const QString & text, const QPicture & picture )" -.br -.ti -1c -.BI "virtual \fB~QIconViewItem\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetRenameEnabled\fR ( bool allow )" -.br -.ti -1c -.BI "virtual void \fBsetDragEnabled\fR ( bool allow )" -.br -.ti -1c -.BI "virtual void \fBsetDropEnabled\fR ( bool allow )" -.br -.ti -1c -.BI "virtual QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual QPicture * \fBpicture\fR () const" -.br -.ti -1c -.BI "virtual QString \fBkey\fR () const" -.br -.ti -1c -.BI "bool \fBrenameEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBdragEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBdropEnabled\fR () const" -.br -.ti -1c -.BI "QIconView * \fBiconView\fR () const" -.br -.ti -1c -.BI "QIconViewItem * \fBprevItem\fR () const" -.br -.ti -1c -.BI "QIconViewItem * \fBnextItem\fR () const" -.br -.ti -1c -.BI "int \fBindex\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSelected\fR ( bool s, bool cb )" -.br -.ti -1c -.BI "virtual void \fBsetSelected\fR ( bool s )" -.br -.ti -1c -.BI "virtual void \fBsetSelectable\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBisSelected\fR () const" -.br -.ti -1c -.BI "bool \fBisSelectable\fR () const" -.br -.ti -1c -.BI "virtual void \fBrepaint\fR ()" -.br -.ti -1c -.BI "virtual bool \fBmove\fR ( int x, int y )" -.br -.ti -1c -.BI "virtual void \fBmoveBy\fR ( int dx, int dy )" -.br -.ti -1c -.BI "virtual bool \fBmove\fR ( const QPoint & pnt )" -.br -.ti -1c -.BI "virtual void \fBmoveBy\fR ( const QPoint & pnt )" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "QPoint \fBpos\fR () const" -.br -.ti -1c -.BI "QRect \fBtextRect\fR ( bool relative = TRUE ) const" -.br -.ti -1c -.BI "QRect \fBpixmapRect\fR ( bool relative = TRUE ) const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QPoint & pnt ) const" -.br -.ti -1c -.BI "bool \fBintersects\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "virtual bool \fBacceptDrop\fR ( const QMimeSource * mime ) const" -.br -.ti -1c -.BI "void \fBrename\fR ()" -.br -.ti -1c -.BI "virtual int \fBcompare\fR ( QIconViewItem * i ) const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & text )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & icon )" -.br -.ti -1c -.BI "virtual void \fBsetPicture\fR ( const QPicture & icon )" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & text, bool recalc, bool redraw = TRUE )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & icon, bool recalc, bool redraw = TRUE )" -.br -.ti -1c -.BI "virtual void \fBsetKey\fR ( const QString & k )" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBremoveRenameBox\fR ()" -.br -.ti -1c -.BI "virtual void \fBcalcRect\fR ( const QString & text_ = QString::null )" -.br -.ti -1c -.BI "virtual void \fBpaintItem\fR ( QPainter * p, const QColorGroup & cg )" -.br -.ti -1c -.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QColorGroup & cg )" -.br -.ti -1c -.BI "virtual void \fBdropped\fR ( QDropEvent * e, const QValueList & lst )" -.br -.ti -1c -.BI "virtual void \fBdragEntered\fR ()" -.br -.ti -1c -.BI "virtual void \fBdragLeft\fR ()" -.br -.ti -1c -.BI "void \fBsetItemRect\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBsetTextRect\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBsetPixmapRect\fR ( const QRect & r )" -.br -.in -1c -.SH DESCRIPTION -The QIconViewItem class provides a single item in a QIconView. -.PP -A QIconViewItem contains an icon, a string and optionally a sort key, and can display itself in a QIconView. The class is designed to be very similar to QListView and QListBox in use, both via instantiation and subclassing. -.PP -The simplest way to create a QIconViewItem and insert it into a QIconView is to construct the item passing the constructor a pointer to the icon view, a string and an icon: -.PP -.nf -.br - (void) new QIconViewItem( -.br - iconView, // A pointer to a QIconView -.br - "This is the text of the item", -.br - aPixmap ); -.br -.fi -.PP -By default the text of an icon view item may not be edited by the user but calling setRenameEnabled(TRUE) will allow the user to perform in-place editing of the item's text. -.PP -When the icon view is deleted all items in it are deleted automatically. -.PP -The QIconView::firstItem() and QIconViewItem::nextItem() functions provide a means of iterating over all the items in a QIconView: -.PP -.nf -.br - QIconViewItem *item; -.br - for ( item = iconView->firstItem(); item; item = item->nextItem() ) -.br - do_something_with( item ); -.br -.fi -.PP -The item's icon view is available from iconView(), and its position in the icon view from index(). -.PP -The item's selection status is available from isSelected() and is set and controlled by setSelected() and isSelectable(). -.PP -The text and icon can be set with setText() and setPixmap() and retrieved with text() and pixmap(). The item's sort key defaults to text() but may be set with setKey() and retrieved with key(). The comparison function, compare() uses key(). -.PP -Items may be repositioned with move() and moveBy(). An item's geometry is available from rect(), x(), y(), width(), height(), size(), pos(), textRect() and pixmapRect(). You can also test against the position of a point with contains() and intersects(). -.PP -To remove an item from an icon view, just delete the item. The QIconViewItem destructor removes it cleanly from its icon view. -.PP -Because the icon view is designed to use drag-and-drop, the icon view item also has functions for drag-and-drop which may be reimplemented. -.PP -\fBNote:\fR Pixmaps with individual dimensions larger than 300 pixels may not be displayed properly, depending on the arrangement in use. For example, pixmaps wider than 300 pixels will not be arranged correctly if the icon view uses a QIconView::TopToBottom arrangement, and pixmaps taller than 300 pixels will not be arranged correctly if the icon view uses a QIconView::LeftToRight arrangement. -.PP -See also Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIconViewItem::QIconViewItem ( QIconView * parent )" -Constructs a QIconViewItem and inserts it into icon view \fIparent\fR with no text and a default icon. -.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after )" -Constructs a QIconViewItem and inserts it into the icon view \fIparent\fR with no text and a default icon, after the icon view item \fIafter\fR. -.SH "QIconViewItem::QIconViewItem ( QIconView * parent, const QString & text )" -Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and a default icon. -.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after, const QString & text )" -Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and a default icon, after the icon view item \fIafter\fR. -.SH "QIconViewItem::QIconViewItem ( QIconView * parent, const QString & text, const QPixmap & icon )" -Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIicon\fR as the icon. -.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after, const QString & text, const QPixmap & icon )" -Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIicon\fR as the icon, after the icon view item \fIafter\fR. -.PP -See also setPixmap(). -.SH "QIconViewItem::QIconViewItem ( QIconView * parent, const QString & text, const QPicture & picture )" -Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIpicture\fR as the icon. -.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after, const QString & text, const QPicture & picture )" -Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIpicture\fR as the icon, after the icon view item \fIafter\fR. -.SH "QIconViewItem::~QIconViewItem ()\fC [virtual]\fR" -Destroys the icon view item and tells the parent icon view that the item has been destroyed. -.SH "bool QIconViewItem::acceptDrop ( const QMimeSource * mime ) const\fC [virtual]\fR" -Returns TRUE if you can drop things with a QMimeSource of \fImime\fR onto this item; otherwise returns FALSE. -.PP -The default implementation always returns FALSE. You must subclass QIconViewItem and reimplement acceptDrop() to accept drops. -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp. -.SH "void QIconViewItem::calcRect ( const QString & text_ = QString::null )\fC [virtual protected]\fR" -This virtual function is responsible for calculating the rectangles returned by rect(), textRect() and pixmapRect(). setRect(), setTextRect() and setPixmapRect() are provided mainly for reimplementations of this function. -.PP -\fItext_\fR is an internal parameter which defaults to QString::null. -.SH "int QIconViewItem::compare ( QIconViewItem * i ) const\fC [virtual]\fR" -Compares this icon view item to \fIi\fR. Returns -1 if this item is less than \fIi\fR, 0 if they are equal, and 1 if this icon view item is greater than \fIi\fR. -.PP -The default implementation compares the item keys (key()) using QString::localeAwareCompare(). A reimplementation may use different values and a different comparison function. Here is a reimplementation that uses plain Unicode comparison: -.PP -.nf -.br - int MyIconViewItem::compare( QIconViewItem *i ) const -.br - { -.br - return key().compare( i->key() ); -.br - } -.br -.fi -.PP -See also key(), QString::localeAwareCompare(), and QString::compare(). -.SH "bool QIconViewItem::contains ( const QPoint & pnt ) const" -Returns TRUE if the item contains the point \fIpnt\fR (in contents coordinates); otherwise returns FALSE. -.SH "bool QIconViewItem::dragEnabled () const" -Returns TRUE if the user is allowed to drag the icon view item; otherwise returns FALSE. -.PP -See also setDragEnabled(). -.SH "void QIconViewItem::dragEntered ()\fC [virtual protected]\fR" -This function is called when a drag enters the item's bounding rectangle. -.PP -The default implementation does nothing; subclasses may reimplement this function. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "void QIconViewItem::dragLeft ()\fC [virtual protected]\fR" -This function is called when a drag leaves the item's bounding rectangle. -.PP -The default implementation does nothing; subclasses may reimplement this function. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QIconViewItem::dropEnabled () const" -Returns TRUE if the user is allowed to drop something onto the item; otherwise returns FALSE. -.PP -See also setDropEnabled(). -.SH "void QIconViewItem::dropped ( QDropEvent * e, const QValueList & lst )\fC [virtual protected]\fR" -This function is called when something is dropped on the item. \fIe\fR provides all the information about the drop. If the drag object of the drop was a QIconDrag, \fIlst\fR contains the list of the dropped items. You can get the data by calling QIconDragItem::data() on each item. If the \fIlst\fR is empty, i.e. the drag was not a QIconDrag, you must decode the data in \fIe\fR and work with that. -.PP -The default implementation does nothing; subclasses may reimplement this function. -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp. -.SH "int QIconViewItem::height () const" -Returns the height of the item. -.SH "QIconView * QIconViewItem::iconView () const" -Returns a pointer to this item's icon view parent. -.SH "int QIconViewItem::index () const" -Returns the index of this item in the icon view, or -1 if an error occurred. -.SH "bool QIconViewItem::intersects ( const QRect & r ) const" -Returns TRUE if the item intersects the rectangle \fIr\fR (in contents coordinates); otherwise returns FALSE. -.SH "bool QIconViewItem::isSelectable () const" -Returns TRUE if the item is selectable; otherwise returns FALSE. -.PP -See also setSelectable(). -.SH "bool QIconViewItem::isSelected () const" -Returns TRUE if the item is selected; otherwise returns FALSE. -.PP -See also setSelected(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QString QIconViewItem::key () const\fC [virtual]\fR" -Returns the key of the icon view item or text() if no key has been explicitly set. -.PP -See also setKey() and compare(). -.SH "bool QIconViewItem::move ( int x, int y )\fC [virtual]\fR" -Moves the item to position (\fIx\fR, \fIy\fR) in the icon view (these are contents coordinates). -.SH "bool QIconViewItem::move ( const QPoint & pnt )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Moves the item to the point \fIpnt\fR. -.SH "void QIconViewItem::moveBy ( int dx, int dy )\fC [virtual]\fR" -Moves the item \fIdx\fR pixels in the x-direction and \fIdy\fR pixels in the y-direction. -.SH "void QIconViewItem::moveBy ( const QPoint & pnt )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Moves the item by the x, y values in point \fIpnt\fR. -.SH "QIconViewItem * QIconViewItem::nextItem () const" -Returns a pointer to the next item, or 0 if this is the last item in the icon view. -.PP -To find the first item use QIconView::firstItem(). -.PP -Example: -.PP -.nf -.br - QIconViewItem *item; -.br - for ( item = iconView->firstItem(); item; item = item->nextItem() ) -.br - do_something_with( item ); -.br -.fi -.PP -See also prevItem(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "void QIconViewItem::paintFocus ( QPainter * p, const QColorGroup & cg )\fC [virtual protected]\fR" -Paints the focus rectangle of the item using the painter \fIp\fR and the color group \fIcg\fR. -.SH "void QIconViewItem::paintItem ( QPainter * p, const QColorGroup & cg )\fC [virtual protected]\fR" -Paints the item using the painter \fIp\fR and the color group \fIcg\fR. If you want the item to be drawn with a different font or color, reimplement this function, change the values of the color group or the painter's font, and then call the QIconViewItem::paintItem() with the changed values. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QPicture * QIconViewItem::picture () const\fC [virtual]\fR" -Returns the icon of the icon view item if it is a picture, or 0 if it is a pixmap. In the latter case use pixmap() instead. Normally you set the picture of the item with setPicture(), but sometimes it's inconvenient to call setPicture() for every item. So you can subclass QIconViewItem, reimplement this function and return a pointer to the item's picture. If you do this, you \fImust\fR call calcRect() manually each time the size of this picture changes. -.PP -See also setPicture(). -.SH "QPixmap * QIconViewItem::pixmap () const\fC [virtual]\fR" -Returns the icon of the icon view item if it is a pixmap, or 0 if it is a picture. In the latter case use picture() instead. Normally you set the pixmap of the item with setPixmap(), but sometimes it's inconvenient to call setPixmap() for every item. So you can subclass QIconViewItem, reimplement this function and return a pointer to the item's pixmap. If you do this, you \fImust\fR call calcRect() manually each time the size of this pixmap changes. -.PP -See also setPixmap(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QRect QIconViewItem::pixmapRect ( bool relative = TRUE ) const" -Returns the bounding rectangle of the item's icon. -.PP -If \fIrelative\fR is TRUE, (the default), the rectangle is relative to the origin of the item's rectangle. If \fIrelative\fR is FALSE, the returned rectangle is relative to the origin of the icon view's contents coordinate system. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QPoint QIconViewItem::pos () const" -Returns the position of the item (in contents coordinates). -.SH "QIconViewItem * QIconViewItem::prevItem () const" -Returns a pointer to the previous item, or 0 if this is the first item in the icon view. -.PP -See also nextItem() and QIconView::firstItem(). -.SH "QRect QIconViewItem::rect () const" -Returns the bounding rectangle of the item (in contents coordinates). -.SH "void QIconViewItem::removeRenameBox ()\fC [virtual protected]\fR" -Removes the editbox that is used for in-place renaming. -.SH "void QIconViewItem::rename ()" -Starts in-place renaming of an icon, if allowed. -.PP -This function sets up the icon view so that the user can edit the item text, and then returns. When the user is done, setText() will be called and QIconView::itemRenamed() will be emitted (unless the user canceled, e.g. by pressing the Escape key). -.PP -See also setRenameEnabled(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QIconViewItem::renameEnabled () const" -Returns TRUE if the item can be renamed by the user with in-place renaming; otherwise returns FALSE. -.PP -See also setRenameEnabled(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "void QIconViewItem::repaint ()\fC [virtual]\fR" -Repaints the item. -.SH "int QIconViewItem::rtti () const\fC [virtual]\fR" -Returns 0. -.PP -Make your derived classes return their own values for rtti(), so that you can distinguish between icon view item types. You should use values greater than 1000, preferably a large random number, to allow for extensions to this class. -.SH "void QIconViewItem::setDragEnabled ( bool allow )\fC [virtual]\fR" -If \fIallow\fR is TRUE, the icon view permits the user to drag the icon view item either to another position within the icon view or to somewhere outside of it. If \fIallow\fR is FALSE, the item cannot be dragged. -.SH "void QIconViewItem::setDropEnabled ( bool allow )\fC [virtual]\fR" -If \fIallow\fR is TRUE, the icon view lets the user drop something on this icon view item. -.SH "void QIconViewItem::setItemRect ( const QRect & r )\fC [protected]\fR" -Sets the bounding rectangle of the whole item to \fIr\fR. This function is provided for subclasses which reimplement calcRect(), so that they can set the calculated rectangle. \fIAny other use is discouraged.\fR -.PP -See also calcRect(), textRect(), setTextRect(), pixmapRect(), and setPixmapRect(). -.SH "void QIconViewItem::setKey ( const QString & k )\fC [virtual]\fR" -Sets \fIk\fR as the sort key of the icon view item. By default text() is used for sorting. -.PP -See also compare(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "void QIconViewItem::setPicture ( const QPicture & icon )\fC [virtual]\fR" -Sets \fIicon\fR as the item's icon in the icon view. This function might be a no-op if you reimplement picture(). -.PP -See also picture(). -.SH "void QIconViewItem::setPixmap ( const QPixmap & icon )\fC [virtual]\fR" -Sets \fIicon\fR as the item's icon in the icon view. This function might be a no-op if you reimplement pixmap(). -.PP -\fBNote:\fR Pixmaps with individual dimensions larger than 300 pixels may not be displayed properly, depending on the arrangement in use. See the main class documentation for details. -.PP -See also pixmap(). -.SH "void QIconViewItem::setPixmap ( const QPixmap & icon, bool recalc, bool redraw = TRUE )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets \fIicon\fR as the item's icon in the icon view. If \fIrecalc\fR is TRUE, the icon view's layout is recalculated. If \fIredraw\fR is TRUE (the default), the icon view is repainted. -.PP -\fBNote:\fR Pixmaps with individual dimensions larger than 300 pixels may not be displayed properly, depending on the arrangement in use. See the main class documentation for details. -.PP -See also pixmap(). -.SH "void QIconViewItem::setPixmapRect ( const QRect & r )\fC [protected]\fR" -Sets the bounding rectangle of the item's icon to \fIr\fR. This function is provided for subclasses which reimplement calcRect(), so that they can set the calculated rectangle. \fIAny other use is discouraged.\fR -.PP -See also calcRect(), pixmapRect(), setItemRect(), and setTextRect(). -.SH "void QIconViewItem::setRenameEnabled ( bool allow )\fC [virtual]\fR" -If \fIallow\fR is TRUE, the user can rename the icon view item by clicking on the text (or pressing F2) while the item is selected (in-place renaming). If \fIallow\fR is FALSE, in-place renaming is not possible. -.PP -Examples: -.)l fileiconview/qfileiconview.cpp, iconview/main.cpp, and iconview/simple_dd/main.cpp. -.SH "void QIconViewItem::setSelectable ( bool enable )\fC [virtual]\fR" -Sets this item to be selectable if \fIenable\fR is TRUE (the default) or unselectable if \fIenable\fR is FALSE. -.PP -The user is unable to select a non-selectable item using either the keyboard or the mouse. (The application programmer can select an item in code regardless of this setting.) -.PP -See also isSelectable(). -.SH "void QIconViewItem::setSelected ( bool s, bool cb )\fC [virtual]\fR" -Selects or unselects the item, depending on \fIs\fR; it may also unselect other items, depending on QIconView::selectionMode() and \fIcb\fR. -.PP -If \fIs\fR is FALSE, the item is unselected. -.PP -If \fIs\fR is TRUE and QIconView::selectionMode() is \fCSingle\fR, the item is selected and the item previously selected is unselected. -.PP -If \fIs\fR is TRUE and QIconView::selectionMode() is \fCExtended\fR, the item is selected. If \fIcb\fR is TRUE, the selection state of the other items is left unchanged. If \fIcb\fR is FALSE (the default) all other items are unselected. -.PP -If \fIs\fR is TRUE and QIconView::selectionMode() is \fCMulti\fR, the item is selected. -.PP -Note that \fIcb\fR is used only if QIconView::selectionMode() is \fCExtended\fR; cb defaults to FALSE. -.PP -All items whose selection status changes repaint themselves. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "void QIconViewItem::setSelected ( bool s )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This variant is equivalent to calling the other variant with \fIcb\fR set to FALSE. -.SH "void QIconViewItem::setText ( const QString & text )\fC [virtual]\fR" -Sets \fItext\fR as the text of the icon view item. This function might be a no-op if you reimplement text(). -.PP -See also text(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "void QIconViewItem::setText ( const QString & text, bool recalc, bool redraw = TRUE )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets \fItext\fR as the text of the icon view item. If \fIrecalc\fR is TRUE, the icon view's layout is recalculated. If \fIredraw\fR is TRUE (the default), the icon view is repainted. -.PP -See also text(). -.SH "void QIconViewItem::setTextRect ( const QRect & r )\fC [protected]\fR" -Sets the bounding rectangle of the item's text to \fIr\fR. This function is provided for subclasses which reimplement calcRect(), so that they can set the calculated rectangle. \fIAny other use is discouraged.\fR -.PP -See also calcRect(), textRect(), setItemRect(), and setPixmapRect(). -.SH "QSize QIconViewItem::size () const" -Returns the size of the item. -.SH "QString QIconViewItem::text () const\fC [virtual]\fR" -Returns the text of the icon view item. Normally you set the text of the item with setText(), but sometimes it's inconvenient to call setText() for every item; so you can subclass QIconViewItem, reimplement this function, and return the text of the item. If you do this, you must call calcRect() manually each time the text (and therefore its size) changes. -.PP -See also setText(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QRect QIconViewItem::textRect ( bool relative = TRUE ) const" -Returns the bounding rectangle of the item's text. -.PP -If \fIrelative\fR is TRUE, (the default), the returned rectangle is relative to the origin of the item's rectangle. If \fIrelative\fR is FALSE, the returned rectangle is relative to the origin of the icon view's contents coordinate system. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "int QIconViewItem::width () const" -Returns the width of the item. -.SH "int QIconViewItem::x () const" -Returns the x-coordinate of the item (in contents coordinates). -.SH "int QIconViewItem::y () const" -Returns the y-coordinate of the item (in contents coordinates). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qiconviewitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qiconviewitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimage.3qt b/doc/man/man3/qimage.3qt deleted file mode 100644 index 5b9e1e493..000000000 --- a/doc/man/man3/qimage.3qt +++ /dev/null @@ -1,1095 +0,0 @@ -'\" t -.TH QImage 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 -QImage \- Hardware-independent pixmap representation with direct access to the pixel data -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBEndian\fR { IgnoreEndian, BigEndian, LittleEndian }" -.br -.ti -1c -.BI "\fBQImage\fR ()" -.br -.ti -1c -.BI "\fBQImage\fR ( int w, int h, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -.br -.ti -1c -.BI "\fBQImage\fR ( const QSize & size, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -.br -.ti -1c -.BI "\fBQImage\fR ( const QString & fileName, const char * format = 0 )" -.br -.ti -1c -.BI "\fBQImage\fR ( const char * const xpm[] )" -.br -.ti -1c -.BI "\fBQImage\fR ( const QByteArray & array )" -.br -.ti -1c -.BI "\fBQImage\fR ( uchar * yourdata, int w, int h, int depth, QRgb * colortable, int numColors, Endian bitOrder )" -.br -.ti -1c -.BI "\fBQImage\fR ( uchar * yourdata, int w, int h, int depth, int bpl, QRgb * colortable, int numColors, Endian bitOrder )" -.br -.ti -1c -.BI "\fBQImage\fR ( const QImage & image )" -.br -.ti -1c -.BI "\fB~QImage\fR ()" -.br -.ti -1c -.BI "QImage & \fBoperator=\fR ( const QImage & image )" -.br -.ti -1c -.BI "QImage & \fBoperator=\fR ( const QPixmap & pixmap )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QImage & i ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QImage & i ) const" -.br -.ti -1c -.BI "void \fBdetach\fR ()" -.br -.ti -1c -.BI "QImage \fBcopy\fR () const" -.br -.ti -1c -.BI "QImage \fBcopy\fR ( int x, int y, int w, int h, int conversion_flags = 0 ) const" -.br -.ti -1c -.BI "QImage \fBcopy\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "int \fBdepth\fR () const" -.br -.ti -1c -.BI "int \fBnumColors\fR () const" -.br -.ti -1c -.BI "Endian \fBbitOrder\fR () const" -.br -.ti -1c -.BI "QRgb \fBcolor\fR ( int i ) const" -.br -.ti -1c -.BI "void \fBsetColor\fR ( int i, QRgb c )" -.br -.ti -1c -.BI "void \fBsetNumColors\fR ( int numColors )" -.br -.ti -1c -.BI "bool \fBhasAlphaBuffer\fR () const" -.br -.ti -1c -.BI "void \fBsetAlphaBuffer\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBallGray\fR () const" -.br -.ti -1c -.BI "bool \fBisGrayscale\fR () const" -.br -.ti -1c -.BI "uchar * \fBbits\fR () const" -.br -.ti -1c -.BI "uchar * \fBscanLine\fR ( int i ) const" -.br -.ti -1c -.BI "uchar ** \fBjumpTable\fR () const" -.br -.ti -1c -.BI "QRgb * \fBcolorTable\fR () const" -.br -.ti -1c -.BI "int \fBnumBytes\fR () const" -.br -.ti -1c -.BI "int \fBbytesPerLine\fR () const" -.br -.ti -1c -.BI "bool \fBcreate\fR ( int width, int height, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -.br -.ti -1c -.BI "bool \fBcreate\fR ( const QSize &, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -.br -.ti -1c -.BI "void \fBreset\fR ()" -.br -.ti -1c -.BI "void \fBfill\fR ( uint pixel )" -.br -.ti -1c -.BI "void \fBinvertPixels\fR ( bool invertAlpha = TRUE )" -.br -.ti -1c -.BI "QImage \fBconvertDepth\fR ( int depth ) const" -.br -.ti -1c -.BI "QImage \fBconvertDepthWithPalette\fR ( int d, QRgb * palette, int palette_count, int conversion_flags = 0 ) const" -.br -.ti -1c -.BI "QImage \fBconvertDepth\fR ( int depth, int conversion_flags ) const" -.br -.ti -1c -.BI "QImage \fBconvertBitOrder\fR ( Endian bitOrder ) const" -.br -.ti -1c -.BI "enum \fBScaleMode\fR { ScaleFree, ScaleMin, ScaleMax }" -.br -.ti -1c -.BI "QImage \fBsmoothScale\fR ( int w, int h, ScaleMode mode = ScaleFree ) const" -.br -.ti -1c -.BI "QImage \fBsmoothScale\fR ( const QSize & s, ScaleMode mode = ScaleFree ) const" -.br -.ti -1c -.BI "QImage \fBscale\fR ( int w, int h, ScaleMode mode = ScaleFree ) const" -.br -.ti -1c -.BI "QImage \fBscale\fR ( const QSize & s, ScaleMode mode = ScaleFree ) const" -.br -.ti -1c -.BI "QImage \fBscaleWidth\fR ( int w ) const" -.br -.ti -1c -.BI "QImage \fBscaleHeight\fR ( int h ) const" -.br -.ti -1c -.BI "QImage \fBxForm\fR ( const QWMatrix & matrix ) const" -.br -.ti -1c -.BI "QImage \fBcreateAlphaMask\fR ( int conversion_flags = 0 ) const" -.br -.ti -1c -.BI "QImage \fBcreateHeuristicMask\fR ( bool clipTight = TRUE ) const" -.br -.ti -1c -.BI "QImage \fBmirror\fR () const" -.br -.ti -1c -.BI "QImage \fBmirror\fR ( bool horizontal, bool vertical ) const" -.br -.ti -1c -.BI "QImage \fBswapRGB\fR () const" -.br -.ti -1c -.BI "bool \fBload\fR ( const QString & fileName, const char * format = 0 )" -.br -.ti -1c -.BI "bool \fBloadFromData\fR ( const uchar * buf, uint len, const char * format = 0 )" -.br -.ti -1c -.BI "bool \fBloadFromData\fR ( QByteArray buf, const char * format = 0 )" -.br -.ti -1c -.BI "bool \fBsave\fR ( const QString & fileName, const char * format, int quality = -1 ) const" -.br -.ti -1c -.BI "bool \fBsave\fR ( QIODevice * device, const char * format, int quality = -1 ) const" -.br -.ti -1c -.BI "bool \fBvalid\fR ( int x, int y ) const" -.br -.ti -1c -.BI "int \fBpixelIndex\fR ( int x, int y ) const" -.br -.ti -1c -.BI "QRgb \fBpixel\fR ( int x, int y ) const" -.br -.ti -1c -.BI "void \fBsetPixel\fR ( int x, int y, uint index_or_rgb )" -.br -.ti -1c -.BI "int \fBdotsPerMeterX\fR () const" -.br -.ti -1c -.BI "int \fBdotsPerMeterY\fR () const" -.br -.ti -1c -.BI "void \fBsetDotsPerMeterX\fR ( int x )" -.br -.ti -1c -.BI "void \fBsetDotsPerMeterY\fR ( int y )" -.br -.ti -1c -.BI "QPoint \fBoffset\fR () const" -.br -.ti -1c -.BI "void \fBsetOffset\fR ( const QPoint & p )" -.br -.ti -1c -.BI "QValueList \fBtextList\fR () const" -.br -.ti -1c -.BI "QStringList \fBtextLanguages\fR () const" -.br -.ti -1c -.BI "QStringList \fBtextKeys\fR () const" -.br -.ti -1c -.BI "QString \fBtext\fR ( const char * key, const char * lang = 0 ) const" -.br -.ti -1c -.BI "QString \fBtext\fR ( const QImageTextKeyLang & kl ) const" -.br -.ti -1c -.BI "void \fBsetText\fR ( const char * key, const char * lang, const QString & s )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QImage \fBfromMimeSource\fR ( const QString & abs_name )" -.br -.ti -1c -.BI "Endian \fBsystemBitOrder\fR ()" -.br -.ti -1c -.BI "Endian \fBsystemByteOrder\fR ()" -.br -.ti -1c -.BI "const char * \fBimageFormat\fR ( const QString & fileName )" -.br -.ti -1c -.BI "QStrList \fBinputFormats\fR ()" -.br -.ti -1c -.BI "QStrList \fBoutputFormats\fR ()" -.br -.ti -1c -.BI "QStringList \fBinputFormatList\fR ()" -.br -.ti -1c -.BI "QStringList \fBoutputFormatList\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QImage & image )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QImage & image )" -.br -.ti -1c -.BI "void \fBbitBlt\fR ( QImage * dst, int dx, int dy, const QImage * src, int sx, int sy, int sw, int sh, int conversion_flags )" -.br -.in -1c -.SH DESCRIPTION -The QImage class provides a hardware-independent pixmap representation with direct access to the pixel data. -.PP -It is one of the two classes Qt provides for dealing with images, the other being QPixmap. QImage is designed and optimized for I/O and for direct pixel access/manipulation. QPixmap is designed and optimized for drawing. There are (slow) functions to convert between QImage and QPixmap: QPixmap::convertToImage() and QPixmap::convertFromImage(). -.PP -An image has the parameters width, height and depth (bits per pixel, bpp), a color table and the actual pixels. QImage supports 1-bpp, 8-bpp and 32-bpp image data. 1-bpp and 8-bpp images use a color lookup table; the pixel value is a color table index. -.PP -32-bpp images encode an RGB value in 24 bits and ignore the color table. The most significant byte is used for the alpha buffer. -.PP -An entry in the color table is an RGB triplet encoded as a \fCuint\fR. Use the tqRed(), tqGreen() and tqBlue() functions (ntqcolor.h) to access the components, and tqRgb to make an RGB triplet (see the QColor class documentation). -.PP -1-bpp (monochrome) images have a color table with a most two colors. There are two different formats: big endian (MSB first) or little endian (LSB first) bit order. To access a single bit you will must do some bit shifts: -.PP -.nf -.br - QImage image; -.br - // sets bit at (x,y) to 1 -.br - if ( image.bitOrder() == QImage::LittleEndian ) -.br - *(image.scanLine(y) + (x >> 3)) |= 1 << (x & 7); -.br - else -.br - *(image.scanLine(y) + (x >> 3)) |= 1 << (7 - (x & 7)); -.br -.fi -.PP -If this looks complicated, it might be a good idea to convert the 1-bpp image to an 8-bpp image using convertDepth(). -.PP -8-bpp images are much easier to work with than 1-bpp images because they have a single byte per pixel: -.PP -.nf -.br - QImage image; -.br - // set entry 19 in the color table to yellow -.br - image.setColor( 19, tqRgb(255,255,0) ); -.br - // set 8 bit pixel at (x,y) to value yellow (in color table) -.br - *(image.scanLine(y) + x) = 19; -.br -.fi -.PP -32-bpp images ignore the color table; instead, each pixel contains the RGB triplet. 24 bits contain the RGB value; the most significant byte is reserved for the alpha buffer. -.PP -.nf -.br - QImage image; -.br - // sets 32 bit pixel at (x,y) to yellow. -.br - uint *p = (uint *)image.scanLine(y) + x; -.br - *p = tqRgb(255,255,0); -.br -.fi -.PP -On Qt/Embedded, scanlines are aligned to the pixel depth and may be padded to any degree, while on all other platforms, the scanlines are 32-bit aligned for all depths. The constructor taking a \fCuchar*\fR argument always expects 32-bit aligned data. On Qt/Embedded, an additional constructor allows the number of bytes-per-line to be specified. -.PP -QImage supports a variety of methods for getting information about the image, for example, colorTable(), allGray(), isGrayscale(), bitOrder(), bytesPerLine(), depth(), dotsPerMeterX() and dotsPerMeterY(), hasAlphaBuffer(), numBytes(), numColors(), and width() and height(). -.PP -Pixel colors are retrieved with pixel() and set with setPixel(). -.PP -QImage also supports a number of functions for creating a new image that is a transformed version of the original. For example, copy(), convertBitOrder(), convertDepth(), createAlphaMask(), createHeuristicMask(), mirror(), scale(), smoothScale(), swapRGB() and xForm(). There are also functions for changing attributes of an image in-place, for example, setAlphaBuffer(), setColor(), setDotsPerMeterX() and setDotsPerMeterY() and setNumColors(). -.PP -Images can be loaded and saved in the supported formats. Images are saved to a file with save(). Images are loaded from a file with load() (or in the constructor) or from an array of data with loadFromData(). The lists of supported formats are available from inputFormatList() and outputFormatList(). -.PP -Strings of text may be added to images using setText(). -.PP -The QImage class uses explicit sharing, similar to that used by QMemArray. -.PP -New image formats can be added as plugins. -.PP -See also QImageIO, QPixmap, Shared Classes, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SS "Member Type Documentation" -.SH "QImage::Endian" -This enum type is used to describe the endianness of the CPU and graphics hardware. -.TP -\fCQImage::IgnoreEndian\fR - Endianness does not matter. Useful for some operations that are independent of endianness. -.TP -\fCQImage::BigEndian\fR - Network byte order, as on SPARC and Motorola CPUs. -.TP -\fCQImage::LittleEndian\fR - PC/Alpha byte order. -.SH "QImage::ScaleMode" -The functions scale() and smoothScale() use different modes for scaling the image. The purpose of these modes is to retain the ratio of the image if this is required. -.PP -
                                -.ce 1 -.B "[Image Omitted]" -.PP -
                                -.TP -\fCQImage::ScaleFree\fR - The image is scaled freely: the resulting image fits exactly into the specified size; the ratio will not necessarily be preserved. -.TP -\fCQImage::ScaleMin\fR - The ratio of the image is preserved and the resulting image is guaranteed to fit into the specified size (it is as large as possible within these constraints) - the image might be smaller than the requested size. -.TP -\fCQImage::ScaleMax\fR - The ratio of the image is preserved and the resulting image fills the whole specified rectangle (it is as small as possible within these constraints) - the image might be larger than the requested size. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QImage::QImage ()" -Constructs a null image. -.PP -See also isNull(). -.SH "QImage::QImage ( int w, int h, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -Constructs an image with \fIw\fR width, \fIh\fR height, \fIdepth\fR bits per pixel, \fInumColors\fR colors and bit order \fIbitOrder\fR. -.PP -Using this constructor is the same as first constructing a null image and then calling the create() function. -.PP -See also create(). -.SH "QImage::QImage ( const QSize & size, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -Constructs an image with size \fIsize\fR pixels, depth \fIdepth\fR bits, \fInumColors\fR and \fIbitOrder\fR endianness. -.PP -Using this constructor is the same as first constructing a null image and then calling the create() function. -.PP -See also create(). -.SH "QImage::QImage ( const QString & fileName, const char * format = 0 )" -Constructs an image and tries to load the image from the file \fIfileName\fR. -.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 -If the loading of the image failed, this object is a null image. -.PP -The QImageIO documentation lists the supported image formats and explains how to add extra formats. -.PP -See also load(), isNull(), and QImageIO. -.SH "QImage::QImage ( const char * const xpm[] )" -Constructs an image from \fIxpm\fR, which must be a valid XPM image. -.PP -Errors are silently ignored. -.PP -Note that it's possible to squeeze the XPM variable a little bit by using an unusual declaration: -.PP -.nf -.br - static const char * const start_xpm[]={ -.br - "16 15 8 1", -.br - "a c #cec6bd", -.br - .... -.br -.fi -.PP -The extra \fCconst\fR makes the entire definition read-only, which is slightly more efficient (e.g. when the code is in a shared library) and ROMable when the application is to be stored in ROM. -.SH "QImage::QImage ( const QByteArray & array )" -Constructs an image from the binary data \fIarray\fR. It tries to guess the file format. -.PP -If the loading of the image failed, this object is a null image. -.PP -See also loadFromData(), isNull(), and imageFormat(). -.SH "QImage::QImage ( uchar * yourdata, int w, int h, int depth, QRgb * colortable, int numColors, Endian bitOrder )" -Constructs an image \fIw\fR pixels wide, \fIh\fR pixels high with a color depth of \fIdepth\fR, that uses an existing memory buffer, \fIyourdata\fR. The buffer must remain valid throughout the life of the QImage. The image does not delete the buffer at destruction. -.PP -If \fIcolortable\fR is 0, a color table sufficient for \fInumColors\fR will be allocated (and destructed later). -.PP -Note that \fIyourdata\fR must be 32-bit aligned. -.PP -The endianness is given in \fIbitOrder\fR. -.SH "QImage::QImage ( uchar * yourdata, int w, int h, int depth, int bpl, QRgb * colortable, int numColors, Endian bitOrder )" -Constructs an image that uses an existing memory buffer. The buffer must remain valid for the life of the QImage. The image does not delete the buffer at destruction. The buffer is passed as \fIyourdata\fR. The image's width is \fIw\fR and its height is \fIh\fR. The color depth is \fIdepth\fR. \fIbpl\fR specifies the number of bytes per line. -.PP -If \fIcolortable\fR is 0, a color table sufficient for \fInumColors\fR will be allocated (and destructed later). -.PP -The endianness is specified by \fIbitOrder\fR. -.PP -\fBWarning:\fR This constructor is only available on Qt/Embedded. -.SH "QImage::QImage ( const QImage & image )" -Constructs a shallow copy of \fIimage\fR. -.SH "QImage::~QImage ()" -Destroys the image and cleans up. -.SH "bool QImage::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. -.PP -This function is slow for large 16-bit (Qt/Embedded only) and 32-bit images. -.PP -See also isGrayscale(). -.SH "Endian QImage::bitOrder () const" -Returns the bit order for the image. -.PP -If it is a 1-bpp image, this function returns either QImage::BigEndian or QImage::LittleEndian. -.PP -If it is not a 1-bpp image, this function returns QImage::IgnoreEndian. -.PP -See also depth(). -.SH "uchar * QImage::bits () const" -Returns a pointer to the first pixel data. This is equivalent to scanLine(0). -.PP -See also numBytes(), scanLine(), and jumpTable(). -.PP -Example: opengl/texture/gltexobj.cpp. -.SH "int QImage::bytesPerLine () const" -Returns the number of bytes per image scanline. This is equivalent to numBytes()/height(). -.PP -See also numBytes() and scanLine(). -.SH "QRgb QImage::color ( int i ) const" -Returns the color in the color table at index \fIi\fR. The first color is at index 0. -.PP -A color value is an RGB triplet. Use the tqRed(), tqGreen() and tqBlue() functions (defined in ntqcolor.h) to get the color value components. -.PP -See also setColor(), numColors(), and QColor. -.PP -Example: themes/wood.cpp. -.SH "QRgb * QImage::colorTable () const" -Returns a pointer to the color table. -.PP -See also numColors(). -.SH "QImage QImage::convertBitOrder ( Endian bitOrder ) const" -Converts the bit order of the image to \fIbitOrder\fR and returns the converted image. The original image is not changed. -.PP -Returns \fC*this\fR if the \fIbitOrder\fR is equal to the image bit order, or a null image if this image cannot be converted. -.PP -See also bitOrder(), systemBitOrder(), and isNull(). -.SH "QImage QImage::convertDepth ( int depth, int conversion_flags ) const" -Converts the depth (bpp) of the image to \fIdepth\fR and returns the converted image. The original image is not changed. -.PP -The \fIdepth\fR argument must be 1, 8, 16 (Qt/Embedded only) or 32. -.PP -Returns \fC*this\fR if \fIdepth\fR is equal to the image depth, or a null image if this image cannot be converted. -.PP -If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. -.PP -See also Qt::ImageConversionFlags, depth(), and isNull(). -.SH "QImage QImage::convertDepth ( int depth ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QImage QImage::convertDepthWithPalette ( int d, QRgb * palette, int palette_count, int conversion_flags = 0 ) const" -Returns an image with depth \fId\fR, using the \fIpalette_count\fR colors pointed to by \fIpalette\fR. If \fId\fR is 1 or 8, the returned image will have its color table ordered the same as \fIpalette\fR. -.PP -If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. -.PP -Note: currently no closest-color search is made. If colors are found that are not in the palette, the palette may not be used at all. This result should not be considered valid because it may change in future implementations. -.PP -Currently inefficient for non-32-bit images. -.PP -See also Qt::ImageConversionFlags. -.SH "QImage QImage::copy () const" -Returns a deep copy of the image. -.PP -See also detach(). -.SH "QImage QImage::copy ( int x, int y, int w, int h, int conversion_flags = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a deep copy of a sub-area of the image. -.PP -The returned image is always \fIw\fR by \fIh\fR pixels in size, and is copied from position \fIx\fR, \fIy\fR in this image. In areas beyond this image pixels are filled with pixel 0. -.PP -If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. -.PP -See also bitBlt() and Qt::ImageConversionFlags. -.SH "QImage QImage::copy ( const QRect & r ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -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 QImage::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. -.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 QImage::LittleEndian or QImage::BigEndian. For other depths \fIbitOrder\fR must be QImage::IgnoreEndian. -.PP -This function allocates a color table and a buffer for the image data. The image data is not initialized. -.PP -The image buffer is allocated as a single block that consists of a table of scanline pointers (jumpTable()) and the image data (bits()). -.PP -See also fill(), width(), height(), depth(), numColors(), bitOrder(), jumpTable(), scanLine(), bits(), bytesPerLine(), and numBytes(). -.SH "bool QImage::create ( const QSize &, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QImage QImage::createAlphaMask ( int conversion_flags = 0 ) const" -Builds and returns a 1-bpp mask from the alpha buffer in this image. Returns a null image if alpha buffer mode is disabled. -.PP -See QPixmap::convertFromImage() for a description of the \fIconversion_flags\fR argument. -.PP -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 "QImage QImage::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. -.PP -This function disregards the alpha buffer. -.PP -See also createAlphaMask(). -.SH "int QImage::depth () const" -Returns the depth of the image. -.PP -The image depth is the number of bits used to encode a single pixel, also called bits per pixel (bpp) or bit planes of an image. -.PP -The supported depths are 1, 8, 16 (Qt/Embedded only) and 32. -.PP -See also convertDepth(). -.SH "void QImage::detach ()" -Detaches from shared image data and makes sure that this image is the only one referring to the data. -.PP -If multiple images share common data, this image makes a copy of the data and detaches itself from the sharing mechanism. Nothing is done if there is just a single reference. -.PP -See also copy(). -.PP -Example: themes/wood.cpp. -.SH "int QImage::dotsPerMeterX () const" -Returns the number of pixels that fit horizontally in a physical meter. This and dotsPerMeterY() define the intended scale and aspect ratio of the image. -.PP -See also setDotsPerMeterX(). -.SH "int QImage::dotsPerMeterY () const" -Returns the number of pixels that fit vertically in a physical meter. This and dotsPerMeterX() define the intended scale and aspect ratio of the image. -.PP -See also setDotsPerMeterY(). -.SH "void QImage::fill ( uint pixel )" -Fills the entire image with the pixel value \fIpixel\fR. -.PP -If the depth of this image is 1, only the lowest bit is used. If you say fill(0), fill(2), etc., the image is filled with 0s. If you say fill(1), fill(3), etc., the image is filled with 1s. If the depth is 8, the lowest 8 bits are used. -.PP -If the depth is 32 and the image has no alpha buffer, the \fIpixel\fR value is written to each pixel in the image. If the image has an alpha buffer, only the 24 RGB bits are set and the upper 8 bits (alpha value) are left unchanged. -.PP -Note: QImage::pixel() returns the color of the pixel at the given coordinates; QColor::pixel() returns the pixel value of the underlying window system (essentially an index value), so normally you will want to use QImage::pixel() to use a color from an existing image or QColor::rgb() to use a specific color. -.PP -See also invertPixels(), depth(), hasAlphaBuffer(), and create(). -.SH "QImage QImage::fromMimeSource ( const QString & abs_name )\fC [static]\fR" -Convenience function. Gets the data associated with the absolute name \fIabs_name\fR from the default mime source factory and decodes it to an image. -.PP -See also QMimeSourceFactory, QImage::fromMimeSource(), and QImageDrag::decode(). -.SH "bool QImage::hasAlphaBuffer () const" -Returns TRUE if alpha buffer mode is enabled; otherwise returns FALSE. -.PP -See also setAlphaBuffer(). -.SH "int QImage::height () const" -Returns the height of the image. -.PP -See also width(), size(), and rect(). -.PP -Examples: -.)l canvas/canvas.cpp and opengl/texture/gltexobj.cpp. -.SH "const char * QImage::imageFormat ( const QString & fileName )\fC [static]\fR" -Returns a string that specifies the image format of the file \fIfileName\fR, or 0 if the file cannot be read or if the format is not recognized. -.PP -The QImageIO documentation lists the guaranteed supported image formats, or use QImage::inputFormats() and QImage::outputFormats() to get lists that include the installed formats. -.PP -See also load() and save(). -.SH "QStringList QImage::inputFormatList ()\fC [static]\fR" -Returns a list of image formats that are supported for image input. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myImage.inputFormatList(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also outputFormatList(), inputFormats(), and QImageIO. -.PP -Example: showimg/showimg.cpp. -.SH "QStrList QImage::inputFormats ()\fC [static]\fR" -Returns a list of image formats that are supported for image input. -.PP -See also outputFormats(), inputFormatList(), and QImageIO. -.SH "void QImage::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. -.PP -If the depth is not 32, the argument \fIinvertAlpha\fR has no meaning. -.PP -Note that inverting an 8-bit image means to replace all pixels using color index \fIi\fR with a pixel using color index 255 minus \fIi\fR. Similarly for a 1-bit image. The color table is not changed. -.PP -See also fill(), depth(), and hasAlphaBuffer(). -.SH "bool QImage::isGrayscale () const" -For 16-bit (Qt/Embedded only) and 32-bit images, this function is equivalent to allGray(). -.PP -For 8-bpp images, this function returns TRUE if color(i) is QRgb(i,i,i) for all indices of the color table; otherwise returns FALSE. -.PP -See also allGray() and depth(). -.SH "bool QImage::isNull () const" -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 -Example: showimg/showimg.cpp. -.SH "uchar ** QImage::jumpTable () const" -Returns a pointer to the scanline pointer table. -.PP -This is the beginning of the data block for the image. -.PP -See also bits() and scanLine(). -.SH "bool QImage::load ( const QString & fileName, const char * format = 0 )" -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 -The QImageIO documentation lists the supported image formats and explains how to add extra formats. -.PP -See also loadFromData(), save(), imageFormat(), QPixmap::load(), and QImageIO. -.SH "bool QImage::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. -.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 -The QImageIO documentation lists the supported image formats and explains how to add extra formats. -.PP -See also load(), save(), imageFormat(), QPixmap::loadFromData(), and QImageIO. -.SH "bool QImage::loadFromData ( QByteArray buf, const char * format = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads an image from the QByteArray \fIbuf\fR. -.SH "QImage QImage::mirror () const" -Returns a QImage which is a vertically mirrored copy of this image. The original QImage is not changed. -.SH "QImage QImage::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. -.PP -See also smoothScale(). -.SH "int QImage::numBytes () const" -Returns the number of bytes occupied by the image data. -.PP -See also bytesPerLine() and bits(). -.SH "int QImage::numColors () const" -Returns the size of the color table for the image. -.PP -Notice that numColors() returns 0 for 16-bpp (Qt/Embedded only) and 32-bpp images because these images do not use color tables, but instead encode pixel values as RGB triplets. -.PP -See also setNumColors() and colorTable(). -.PP -Example: themes/wood.cpp. -.SH "QPoint QImage::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 QImage::operator!= ( const QImage & 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. -.PP -See also operator=(). -.SH "QImage & QImage::operator= ( const QImage & image )" -Assigns a shallow copy of \fIimage\fR to this image and returns a reference to this image. -.PP -See also copy(). -.SH "QImage & QImage::operator= ( const QPixmap & pixmap )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the image bits to the \fIpixmap\fR contents and returns a reference to the image. -.PP -If the image shares data with other images, it will first dereference the shared data. -.PP -Makes a call to QPixmap::convertToImage(). -.SH "bool QImage::operator== ( const QImage & 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. -.PP -See also operator=(). -.SH "QStringList QImage::outputFormatList ()\fC [static]\fR" -Returns a list of image formats that are supported for image output. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myImage.outputFormatList(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also inputFormatList(), outputFormats(), and QImageIO. -.SH "QStrList QImage::outputFormats ()\fC [static]\fR" -Returns a list of image formats that are supported for image output. -.PP -See also inputFormats(), outputFormatList(), and QImageIO. -.PP -Example: showimg/showimg.cpp. -.SH "QRgb QImage::pixel ( int x, int y ) const" -Returns the color of the pixel at the coordinates (\fIx\fR, \fIy\fR). -.PP -If (\fIx\fR, \fIy\fR) is not on the image, the results are undefined. -.PP -See also setPixel(), tqRed(), tqGreen(), tqBlue(), and valid(). -.PP -Examples: -.)l canvas/canvas.cpp and qmag/qmag.cpp. -.SH "int QImage::pixelIndex ( int x, int y ) const" -Returns the pixel index at the given coordinates. -.PP -If (\fIx\fR, \fIy\fR) is not valid, or if the image is not a paletted image (depth() > 8), the results are undefined. -.PP -See also valid() and depth(). -.SH "QRect QImage::rect () const" -Returns the enclosing rectangle (0, 0, width(), height()) of the image. -.PP -See also width(), height(), and size(). -.SH "void QImage::reset ()" -Resets all image parameters and deallocates the image data. -.SH "bool QImage::save ( const QString & 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. -.PP -See also load(), loadFromData(), imageFormat(), QPixmap::save(), and QImageIO. -.SH "bool QImage::save ( QIODevice * device, const char * format, int quality = -1 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function writes a QImage to the QIODevice, \fIdevice\fR. This can be used, for example, to save an image directly into a QByteArray: -.PP -.nf -.br - QImage image; -.br - QByteArray ba; -.br - QBuffer buffer( ba ); -.br - buffer.open( IO_WriteOnly ); -.br - image.save( &buffer, "PNG" ); // writes image into ba in PNG format -.br -.fi -.SH "QImage QImage::scale ( int w, int h, ScaleMode mode = ScaleFree ) const" -Returns a copy of the image scaled to a rectangle of width \fIw\fR and height \fIh\fR according to the ScaleMode \fImode\fR. -.TP -If \fImode\fR is ScaleFree, the image is scaled to (\fIw\fR, \fIh\fR). -.TP -If \fImode\fR is ScaleMin, the image is scaled to a rectangle as large as possible inside (\fIw\fR, \fIh\fR), preserving the aspect ratio. -.TP -If \fImode\fR is ScaleMax, the image is scaled to a rectangle as small as possible outside (\fIw\fR, \fIh\fR), preserving the aspect ratio. -.PP -If either the width \fIw\fR or the height \fIh\fR is 0 or negative, this function returns a null image. -.PP -This function uses a simple, fast algorithm. If you need better quality, use smoothScale() instead. -.PP -See also scaleWidth(), scaleHeight(), smoothScale(), and xForm(). -.SH "QImage QImage::scale ( const QSize & s, ScaleMode mode = ScaleFree ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The requested size of the image is \fIs\fR. -.SH "QImage QImage::scaleHeight ( int h ) const" -Returns a scaled copy of the image. The returned image has a height of \fIh\fR pixels. This function automatically calculates the width of the image so that the ratio of the image is preserved. -.PP -If \fIh\fR is 0 or negative a null image is returned. -.PP -See also scale(), scaleWidth(), smoothScale(), and xForm(). -.PP -Example: table/small-table-demo/main.cpp. -.SH "QImage QImage::scaleWidth ( int w ) const" -Returns a scaled copy of the image. The returned image has a width of \fIw\fR pixels. This function automatically calculates the height of the image so that the ratio of the image is preserved. -.PP -If \fIw\fR is 0 or negative a null image is returned. -.PP -See also scale(), scaleHeight(), smoothScale(), and xForm(). -.SH "uchar * QImage::scanLine ( int i ) const" -Returns a pointer to the pixel data at the scanline with index \fIi\fR. The first scanline is at index 0. -.PP -The scanline data is aligned on a 32-bit boundary. -.PP -\fBWarning:\fR If you are accessing 32-bpp image data, cast the returned pointer to \fCQRgb*\fR (QRgb has a 32-bit size) and use it to read/write the pixel value. You cannot use the \fCuchar*\fR pointer directly, because the pixel format depends on the byte order on the underlying platform. Hint: use tqRed(), tqGreen() and tqBlue(), etc. (ntqcolor.h) to access the pixels. -.PP -\fBWarning:\fR If you are accessing 16-bpp image data, you must handle endianness yourself. (Qt/Embedded only) -.PP -See also bytesPerLine(), bits(), and jumpTable(). -.PP -Example: desktop/desktop.cpp. -.SH "void QImage::setAlphaBuffer ( bool enable )" -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 -This 32-bit value is encoded as follows: The lower 24 bits are used for the red, green, and blue components. The upper 8 bits contain the alpha component. -.PP -The alpha component specifies the transparency of a pixel. 0 means completely transparent and 255 means opaque. The alpha component is ignored if you do not enable alpha buffer mode. -.PP -The alpha buffer is used to set a mask when a QImage is translated to a QPixmap. -.PP -See also hasAlphaBuffer() and createAlphaMask(). -.SH "void QImage::setColor ( int i, QRgb c )" -Sets a color in the color table at index \fIi\fR to \fIc\fR. -.PP -A color value is an RGB triplet. Use the tqRgb() function (defined in ntqcolor.h) to make RGB triplets. -.PP -See also color(), setNumColors(), and numColors(). -.PP -Examples: -.)l desktop/desktop.cpp and themes/wood.cpp. -.SH "void QImage::setDotsPerMeterX ( int x )" -Sets the value returned by dotsPerMeterX() to \fIx\fR. -.SH "void QImage::setDotsPerMeterY ( int y )" -Sets the value returned by dotsPerMeterY() to \fIy\fR. -.SH "void QImage::setNumColors ( int numColors )" -Resizes the color table to \fInumColors\fR colors. -.PP -If the color table is expanded all the extra colors will be set to black (RGB 0,0,0). -.PP -See also numColors(), color(), setColor(), and colorTable(). -.SH "void QImage::setOffset ( const QPoint & p )" -Sets the value returned by offset() to \fIp\fR. -.SH "void QImage::setPixel ( int x, int y, uint index_or_rgb )" -Sets the pixel index or color at the coordinates (\fIx\fR, \fIy\fR) to \fIindex_or_rgb\fR. -.PP -If (\fIx\fR, \fIy\fR) is not valid, the result is undefined. -.PP -If the image is a paletted image (depth() <= 8) and \fIindex_or_rgb\fR >= numColors(), the result is undefined. -.PP -See also pixelIndex(), pixel(), tqRgb(), tqRgba(), and valid(). -.SH "void QImage::setText ( const char * key, const char * lang, const QString & s )" -Records string \fIs\fR for the keyword \fIkey\fR. The \fIkey\fR should be a portable keyword recognizable by other software - some suggested values can be found in the PNG specification. \fIs\fR can be any text. \fIlang\fR should specify the language code (see RFC 1766) or 0. -.SH "QSize QImage::size () const" -Returns the size of the image, i.e. its width and height. -.PP -See also width(), height(), and rect(). -.SH "QImage QImage::smoothScale ( int w, int h, ScaleMode mode = ScaleFree ) const" -Returns a smoothly scaled copy of the image. The returned image has a size of width \fIw\fR by height \fIh\fR pixels if \fImode\fR is ScaleFree. The modes ScaleMin and ScaleMax may be used to preserve the ratio of the image: if \fImode\fR is ScaleMin, the returned image is guaranteed to fit into the rectangle specified by \fIw\fR and \fIh\fR (it is as large as possible within the constraints); if \fImode\fR is ScaleMax, the returned image fits at least into the specified rectangle (it is a small as possible within the constraints). -.PP -For 32-bpp images and 1-bpp/8-bpp color images the result will be 32-bpp, whereas all-gray images (including black-and-white 1-bpp) will produce 8-bit grayscale images with the palette spanning 256 grays from black to white. -.PP -This function uses code based on pnmscale.c by Jef Poskanzer. -.PP -pnmscale.c - read a portable anymap and scale it -.PP -Copyright (C) 1989, 1991 by Jef Poskanzer. -.PP -Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. This software is provided "as is" without express or implied warranty. -.PP -See also scale() and mirror(). -.SH "QImage QImage::smoothScale ( const QSize & s, ScaleMode mode = ScaleFree ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The requested size of the image is \fIs\fR. -.SH "QImage QImage::swapRGB () const" -Returns a QImage in which the values of the red and blue components of all pixels have been swapped, effectively converting an RGB image to a BGR image. The original QImage is not changed. -.SH "Endian QImage::systemBitOrder ()\fC [static]\fR" -Determines the bit order of the display hardware. Returns QImage::LittleEndian (LSB first) or QImage::BigEndian (MSB first). -.PP -See also systemByteOrder(). -.SH "Endian QImage::systemByteOrder ()\fC [static]\fR" -Determines the host computer byte order. Returns QImage::LittleEndian (LSB first) or QImage::BigEndian (MSB first). -.PP -See also systemBitOrder(). -.SH "QString QImage::text ( const char * key, const char * lang = 0 ) const" -Returns the string recorded for the keyword \fIkey\fR in language \fIlang\fR, or in a default language if \fIlang\fR is 0. -.SH "QString QImage::text ( const QImageTextKeyLang & kl ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the string recorded for the keyword and language \fIkl\fR. -.SH "QStringList QImage::textKeys () const" -Returns the keywords for which some texts are recorded. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myImage.textKeys(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also textList(), text(), setText(), and textLanguages(). -.SH "QStringList QImage::textLanguages () const" -Returns the language identifiers for which some texts are recorded. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myImage.textLanguages(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also textList(), text(), setText(), and textKeys(). -.SH "QValueList QImage::textList () const" -Returns a list of QImageTextKeyLang objects that enumerate all the texts key/language pairs set by setText() for this image. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList list = myImage.textList(); -.br - QValueList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "bool QImage::valid ( int x, int y ) const" -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 -Examples: -.)l canvas/canvas.cpp and qmag/qmag.cpp. -.SH "int QImage::width () const" -Returns the width of the image. -.PP -See also height(), size(), and rect(). -.PP -Examples: -.)l canvas/canvas.cpp and opengl/texture/gltexobj.cpp. -.SH "QImage QImage::xForm ( const QWMatrix & matrix ) const" -Returns a copy of the image that is transformed using the transformation matrix, \fImatrix\fR. -.PP -The transformation \fImatrix\fR is internally adjusted to compensate for unwanted translation, i.e. xForm() returns the smallest image that contains all the transformed points of the original image. -.PP -See also scale(), QPixmap::xForm(), QPixmap::trueMatrix(), and QWMatrix. -.SH RELATED FUNCTION DOCUMENTATION -.SH "void bitBlt ( QImage * dst, int dx, int dy, const QImage * src, int sx, int sy, int sw, int sh, int conversion_flags )" -Copies a block of pixels from \fIsrc\fR to \fIdst\fR. The pixels copied from source (src) are converted according to \fIconversion_flags\fR if it is incompatible with the destination (\fIdst\fR). -.PP -\fIsx\fR, \fIsy\fR is the top-left pixel in \fIsrc\fR, \fIdx\fR, \fIdy\fR is the top-left position in \fIdst\fR and \fIsw\fR, \\sh is the size of the copied block. -.PP -The copying is clipped if areas outside \fIsrc\fR or \fIdst\fR are specified. -.PP -If \fIsw\fR is -1, it is adjusted to src->width(). Similarly, if \fIsh\fR is -1, it is adjusted to src->height(). -.PP -Currently inefficient for non 32-bit images. -.SH "QDataStream & operator<< ( QDataStream & s, const QImage & image )" -Writes the image \fIimage\fR to the stream \fIs\fR as a PNG image, or as a BMP image if the stream's version is 1. -.PP -Note that writing the stream to a file will not produce a valid image file. -.PP -See also QImage::save() and Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QImage & image )" -Reads an image from the stream \fIs\fR and stores it in \fIimage\fR. -.PP -See also QImage::load() and Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqimage.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimage.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimageconsumer.3qt b/doc/man/man3/qimageconsumer.3qt deleted file mode 100644 index 8a31dae0d..000000000 --- a/doc/man/man3/qimageconsumer.3qt +++ /dev/null @@ -1,108 +0,0 @@ -'\" t -.TH QImageConsumer 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 -QImageConsumer \- Abstraction used by QImageDecoder -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual void \fBend\fR () = 0" -.br -.ti -1c -.BI "virtual void \fBchanged\fR ( const QRect & ) = 0" -.br -.ti -1c -.BI "virtual void \fBframeDone\fR () = 0" -.br -.ti -1c -.BI "virtual void \fBframeDone\fR ( const QPoint & offset, const QRect & rect ) = 0" -.br -.ti -1c -.BI "virtual void \fBsetLooping\fR ( int n ) = 0" -.br -.ti -1c -.BI "virtual void \fBsetFramePeriod\fR ( int milliseconds ) = 0" -.br -.ti -1c -.BI "virtual void \fBsetSize\fR ( int, int ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QImageConsumer class is an abstraction used by QImageDecoder. -.PP -The QMovie class, or QLabel::setMovie(), are easy to use and for most situations do what you want with regards animated images. -.PP -A QImageConsumer consumes information about changes to the QImage maintained by a QImageDecoder. Think of the QImage as the model or source of the image data, with the QImageConsumer as a view of that data and the QImageDecoder being the controller that orchestrates the relationship between the model and the view. -.PP -You'd use the QImageConsumer class, for example, if you were implementing a web browser with your own image loaders. -.PP -See also QImageDecoder, Graphics Classes, Image Processing Classes, and Multimedia Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "void QImageConsumer::changed ( const QRect & )\fC [pure virtual]\fR" -Called when the given area of the image has changed. -.SH "void QImageConsumer::end ()\fC [pure virtual]\fR" -Called when all the data from all the frames has been decoded and revealed as changed(). -.SH "void QImageConsumer::frameDone ()\fC [pure virtual]\fR" -One of the two frameDone() functions will be called when a frame of an animated image has ended and been revealed as changed(). -.PP -When this function is called, the current image should be displayed. -.PP -The decoder will not make any further changes to the image until the next call to QImageFormat::decode(). -.SH "void QImageConsumer::frameDone ( const QPoint & offset, const QRect & rect )\fC [pure virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -One of the two frameDone() functions will be called when a frame of an animated image has ended and been revealed as changed(). -.PP -When this function is called, the area \fIrect\fR in the current image should be moved by \fIoffset\fR and displayed. -.PP -The decoder will not make any further changes to the image until the next call to QImageFormat::decode(). -.SH "void QImageConsumer::setFramePeriod ( int milliseconds )\fC [pure virtual]\fR" -Notes that the frame about to be decoded should not be displayed until the given number of \fImilliseconds\fR after the time that this function is called. Of course, the image may not have been decoded by then, in which case the frame should not be displayed until it is complete. A value of -1 (the assumed default) indicates that the image should be displayed even while it is only partially loaded. -.SH "void QImageConsumer::setLooping ( int n )\fC [pure virtual]\fR" -Called to indicate that the sequence of frames in the image should be repeated \fIn\fR times, including the sequence during decoding. -.TP -0 = Forever -.TP -1 = Only display frames the first time through -.TP -2 = Repeat once after first pass through images -.TP -etc. -.PP -To make the QImageDecoder do this, just delete it and pass the information to it again for decoding (setLooping() will be called again, of course, but that can be ignored), or keep copies of the changed areas at the ends of frames. -.SH "void QImageConsumer::setSize ( int, int )\fC [pure virtual]\fR" -This function is called as soon as the size of the image has been -determined. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qimageconsumer.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimageconsumer.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimagedecoder.3qt b/doc/man/man3/qimagedecoder.3qt deleted file mode 100644 index 1b583199a..000000000 --- a/doc/man/man3/qimagedecoder.3qt +++ /dev/null @@ -1,111 +0,0 @@ -'\" t -.TH QImageDecoder 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 -QImageDecoder \- Incremental image decoder for all supported image formats -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQImageDecoder\fR ( QImageConsumer * c )" -.br -.ti -1c -.BI "\fB~QImageDecoder\fR ()" -.br -.ti -1c -.BI "const QImage & \fBimage\fR ()" -.br -.ti -1c -.BI "int \fBdecode\fR ( const uchar * buffer, int length )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "const char * \fBformatName\fR ( const uchar * buffer, int length )" -.br -.ti -1c -.BI "QImageFormatType * \fBformat\fR ( const char * name )" -.br -.ti -1c -.BI "QStrList \fBinputFormats\fR ()" -.br -.ti -1c -.BI "void \fBregisterDecoderFactory\fR ( QImageFormatType * f )" -.br -.ti -1c -.BI "void \fBunregisterDecoderFactory\fR ( QImageFormatType * f )" -.br -.in -1c -.SH DESCRIPTION -The QImageDecoder class is an incremental image decoder for all supported image formats. -.PP -New formats are installed by creating objects of class QImageFormatType; the QMovie class can be used for all installed incremental image formats. QImageDecoder is only useful for creating new ways of feeding data to an QImageConsumer. -.PP -A QImageDecoder is a machine that decodes images. It takes encoded image data via its decode() method and expresses its decoding by supplying information to a QImageConsumer. It implements its decoding by using a QImageFormat created by one of the currently-existing QImageFormatType factory objects. -.PP -QImageFormatType and QImageFormat are the classes that you might need to implement support for additional image formats. -.PP -Qt supports GIF reading if it is configured that way during installation (see ntqgif.h). If it is, we are required to state that" The Graphics Interchange Format(c) is the Copyright property of CompuServe Incorporated. GIF(sm) is a Service Mark property of CompuServe Incorporated." -.PP -\fBWarning:\fR If you are in a country that recognizes software patents and in which Unisys holds a patent on LZW compression and/or decompression and you want to use GIF, Unisys may require you to license that technology. Such countries include Canada, Japan, the USA, France, Germany, Italy and the UK. -.PP -GIF support may be removed completely in a future version of Qt. We recommend using the MNG or PNG format. -.PP -See also Graphics Classes, Image Processing Classes, and Multimedia Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QImageDecoder::QImageDecoder ( QImageConsumer * c )" -Constructs a QImageDecoder that will send change information to the QImageConsumer \fIc\fR. -.SH "QImageDecoder::~QImageDecoder ()" -Destroys a QImageDecoder. The image it built is destroyed. The decoder built by the factory for the file format is destroyed. The consumer for which it decoded the image is \fInot\fR destroyed. -.SH "int QImageDecoder::decode ( const uchar * buffer, int length )" -Call this function to decode some data into image changes. The data in \fIbuffer\fR will be decoded, sending change information to the QImageConsumer of this QImageDecoder until one of the change functions of the consumer returns FALSE. The length of the data is given in \fIlength\fR. -.PP -Returns the number of bytes consumed: 0 if consumption is complete, and -1 if decoding fails due to invalid data. -.SH "QImageFormatType * QImageDecoder::format ( const char * name )\fC [static]\fR" -Returns a QImageFormatType by name. This might be used when the user needs to force data to be interpreted as being in a certain format. \fIname\fR is one of the formats listed by QImageDecoder::inputFormats(). Note that you will still need to supply decodable data to result->decoderFor() before you can begin decoding the data. -.SH "const char * QImageDecoder::formatName ( const uchar * buffer, int length )\fC [static]\fR" -Call this function to find the name of the format of the given header. The returned string is statically allocated. The function will look at the first \fIlength\fR characters in the \fIbuffer\fR. -.PP -Returns 0 if the format is not recognized. -.SH "const QImage & QImageDecoder::image ()" -Returns the image currently being decoded. -.SH "QStrList QImageDecoder::inputFormats ()\fC [static]\fR" -Returns a sorted list of formats for which asynchronous loading is supported. -.SH "void QImageDecoder::registerDecoderFactory ( QImageFormatType * f )\fC [static]\fR" -Registers the new QImageFormatType \fIf\fR. This is not needed in application code because factories call this themselves. -.SH "void QImageDecoder::unregisterDecoderFactory ( QImageFormatType * f )\fC [static]\fR" -Unregisters the QImageFormatType \fIf\fR. This is not needed in -application code because factories call this themselves. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qimagedecoder.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimagedecoder.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimagedrag.3qt b/doc/man/man3/qimagedrag.3qt deleted file mode 100644 index 1e540c323..000000000 --- a/doc/man/man3/qimagedrag.3qt +++ /dev/null @@ -1,105 +0,0 @@ -'\" t -.TH QImageDrag 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 -QImageDrag \- Drag and drop object for transferring images -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDragObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQImageDrag\fR ( QImage image, QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQImageDrag\fR ( QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QImageDrag\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetImage\fR ( QImage image )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBcanDecode\fR ( const QMimeSource * e )" -.br -.ti -1c -.BI "bool \fBdecode\fR ( const QMimeSource * e, QImage & img )" -.br -.ti -1c -.BI "bool \fBdecode\fR ( const QMimeSource * e, QPixmap & pm )" -.br -.in -1c -.SH DESCRIPTION -The QImageDrag class provides a drag and drop object for transferring images. -.PP -Images are offered to the receiving application in multiple formats, determined by Qt's output formats. -.PP -For more information about drag and drop, see the QDragObject class and the drag and drop documentation. -.PP -See also Drag And Drop Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QImageDrag::QImageDrag ( QImage image, QWidget * dragSource = 0, const char * name = 0 )" -Constructs an image drag object and sets its data to \fIimage\fR. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. -.SH "QImageDrag::QImageDrag ( QWidget * dragSource = 0, const char * name = 0 )" -Constructs a default image drag object. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. -.SH "QImageDrag::~QImageDrag ()" -Destroys the image drag object and frees up all allocated resources. -.SH "bool QImageDrag::canDecode ( const QMimeSource * e )\fC [static]\fR" -Returns TRUE if the information in mime source \fIe\fR can be decoded into an image; otherwise returns FALSE. -.PP -See also decode(). -.PP -Example: desktop/desktop.cpp. -.SH "bool QImageDrag::decode ( const QMimeSource * e, QImage & img )\fC [static]\fR" -Attempts to decode the dropped information in mime source \fIe\fR into \fIimg\fR. Returns TRUE if successful; otherwise returns FALSE. -.PP -See also canDecode(). -.PP -Example: desktop/desktop.cpp. -.SH "bool QImageDrag::decode ( const QMimeSource * e, QPixmap & pm )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Attempts to decode the dropped information in mime source \fIe\fR into pixmap \fIpm\fR. Returns TRUE if successful; otherwise returns FALSE. -.PP -This is a convenience function that converts to a QPixmap via a QImage. -.PP -See also canDecode(). -.SH "void QImageDrag::setImage ( QImage image )\fC [virtual]\fR" -Sets the image to be dragged to \fIimage\fR. You will need to call -this if you did not pass the image during construction. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qimagedrag.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimagedrag.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimageformat.3qt b/doc/man/man3/qimageformat.3qt deleted file mode 100644 index 765900a51..000000000 --- a/doc/man/man3/qimageformat.3qt +++ /dev/null @@ -1,63 +0,0 @@ -'\" t -.TH QImageFormat 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 -QImageFormat \- Incremental image decoder for a specific image format -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual int \fBdecode\fR ( QImage & img, QImageConsumer * consumer, const uchar * buffer, int length ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QImageFormat class is an incremental image decoder for a specific image format. -.PP -By making a derived class of QImageFormatType, which in turn creates objects that are a subclass of QImageFormat, you can add support for more incremental image formats, allowing such formats to be sources for a QMovie or for the first frame of the image stream to be loaded as a QImage or QPixmap. -.PP -Your new subclass must reimplement the decode() function in order to process your new format. -.PP -New QImageFormat objects are generated by new QImageFormatType factories. -.PP -See also Graphics Classes, Image Processing Classes, and Multimedia Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "int QImageFormat::decode ( QImage & img, QImageConsumer * consumer, const uchar * buffer, int length )\fC [pure virtual]\fR" -New subclasses must reimplement this method. -.PP -It should decode some or all of the bytes from \fIbuffer\fR into \fIimg\fR, calling the methods of \fIconsumer\fR as the decoding proceeds to inform that consumer of changes to the image. The length of the data is given in \fIlength\fR. The consumer may be 0, in which case the function should just process the data into \fIimg\fR without telling any consumer about the changes. Note that the decoder must store enough state to be able to continue in subsequent calls to this method - this is the essence of the incremental image loading. -.PP -The function should return without processing all the data if it reaches the end of a frame in the input. -.PP -The function must return the number of bytes it has processed. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qimageformat.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimageformat.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimageformatplugin.3qt b/doc/man/man3/qimageformatplugin.3qt deleted file mode 100644 index c21acf9b6..000000000 --- a/doc/man/man3/qimageformatplugin.3qt +++ /dev/null @@ -1,76 +0,0 @@ -'\" t -.TH QImageFormatPlugin 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 -QImageFormatPlugin \- Abstract base for custom image format plugins -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQImageFormatPlugin\fR ()" -.br -.ti -1c -.BI "\fB~QImageFormatPlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBkeys\fR () const = 0" -.br -.ti -1c -.BI "virtual bool \fBinstallIOHandler\fR ( const QString & format ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QImageFormatPlugin class provides an abstract base for custom image format plugins. -.PP -The image format plugin is a simple plugin interface that makes it easy to create custom image formats that can be used transparently by applications. -.PP -Writing an image format plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and installIOHandler(), and exporting the class with the Q_EXPORT_PLUGIN macro. See the Plugins documentation for details. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QImageFormatPlugin::QImageFormatPlugin ()" -Constructs an image format plugin. This is invoked automatically by the Q_EXPORT_PLUGIN macro. -.SH "QImageFormatPlugin::~QImageFormatPlugin ()" -Destroys the image format plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "bool QImageFormatPlugin::installIOHandler ( const QString & format )\fC [pure virtual]\fR" -Installs a QImageIO image I/O handler for the image format \fIformat\fR. -.PP -See also keys(). -.SH "QStringList QImageFormatPlugin::keys () const\fC [pure virtual]\fR" -Returns the list of image formats this plugin supports. -.PP -See also installIOHandler(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqimageformatplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimageformatplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimageformattype.3qt b/doc/man/man3/qimageformattype.3qt deleted file mode 100644 index ec716cc5e..000000000 --- a/doc/man/man3/qimageformattype.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QImageFormatType 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 -QImageFormatType \- Factory that makes QImageFormat objects -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QImageFormatType\fR ()" -.br -.ti -1c -.BI "virtual QImageFormat * \fBdecoderFor\fR ( const uchar * buffer, int length ) = 0" -.br -.ti -1c -.BI "virtual const char * \fBformatName\fR () const = 0" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQImageFormatType\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QImageFormatType class is a factory that makes QImageFormat objects. -.PP -Whereas the QImageIO class allows for \fIcomplete\fR loading of images, QImageFormatType allows for \fIincremental\fR loading of images. -.PP -New image file formats are installed by creating objects of derived classes of QImageFormatType. They must implement decoderFor() and formatName(). -.PP -QImageFormatType is a very simple class. Its only task is to recognize image data in some format and make a new object, subclassed from QImageFormat, which can decode that format. -.PP -The factories for formats built into Qt are automatically defined before any other factory is initialized. If two factories would recognize an image format, the factory created last will override the earlier one; you can thus override current and future built-in formats. -.PP -See also Graphics Classes, Image Processing Classes, and Multimedia Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QImageFormatType::QImageFormatType ()\fC [protected]\fR" -Constructs a factory. It automatically registers itself with QImageDecoder. -.SH "QImageFormatType::~QImageFormatType ()\fC [virtual]\fR" -Destroys a factory. It automatically unregisters itself from QImageDecoder. -.SH "QImageFormat * QImageFormatType::decoderFor ( const uchar * buffer, int length )\fC [pure virtual]\fR" -Returns a decoder for decoding an image that starts with the bytes in \fIbuffer\fR. The length of the data is given in \fIlength\fR. This function should only return a decoder if it is certain that the decoder applies to data with the given header. Returns 0 if there is insufficient data in the header to make a positive identification or if the data is not recognized. -.SH "const char * QImageFormatType::formatName () const\fC [pure virtual]\fR" -Returns the name of the format supported by decoders from this -factory. The string is statically allocated. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qimageformattype.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimageformattype.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimageio.3qt b/doc/man/man3/qimageio.3qt deleted file mode 100644 index c74b7f20d..000000000 --- a/doc/man/man3/qimageio.3qt +++ /dev/null @@ -1,365 +0,0 @@ -'\" t -.TH QImageIO 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 -QImageIO \- Parameters for loading and saving images -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQImageIO\fR ()" -.br -.ti -1c -.BI "\fBQImageIO\fR ( QIODevice * ioDevice, const char * format )" -.br -.ti -1c -.BI "\fBQImageIO\fR ( const QString & fileName, const char * format )" -.br -.ti -1c -.BI "\fB~QImageIO\fR ()" -.br -.ti -1c -.BI "const QImage & \fBimage\fR () const" -.br -.ti -1c -.BI "int \fBstatus\fR () const" -.br -.ti -1c -.BI "const char * \fBformat\fR () const" -.br -.ti -1c -.BI "QIODevice * \fBioDevice\fR () const" -.br -.ti -1c -.BI "QString \fBfileName\fR () const" -.br -.ti -1c -.BI "int \fBquality\fR () const" -.br -.ti -1c -.BI "QString \fBdescription\fR () const" -.br -.ti -1c -.BI "const char * \fBparameters\fR () const" -.br -.ti -1c -.BI "float \fBgamma\fR () const" -.br -.ti -1c -.BI "void \fBsetImage\fR ( const QImage & image )" -.br -.ti -1c -.BI "void \fBsetStatus\fR ( int status )" -.br -.ti -1c -.BI "void \fBsetFormat\fR ( const char * format )" -.br -.ti -1c -.BI "void \fBsetIODevice\fR ( QIODevice * ioDevice )" -.br -.ti -1c -.BI "void \fBsetFileName\fR ( const QString & fileName )" -.br -.ti -1c -.BI "void \fBsetQuality\fR ( int q )" -.br -.ti -1c -.BI "void \fBsetDescription\fR ( const QString & description )" -.br -.ti -1c -.BI "void \fBsetParameters\fR ( const char * parameters )" -.br -.ti -1c -.BI "void \fBsetGamma\fR ( float gamma )" -.br -.ti -1c -.BI "bool \fBread\fR ()" -.br -.ti -1c -.BI "bool \fBwrite\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "const char * \fBimageFormat\fR ( const QString & fileName )" -.br -.ti -1c -.BI "const char * \fBimageFormat\fR ( QIODevice * d )" -.br -.ti -1c -.BI "QStrList \fBinputFormats\fR ()" -.br -.ti -1c -.BI "QStrList \fBoutputFormats\fR ()" -.br -.ti -1c -.BI "void \fBdefineIOHandler\fR ( const char * format, const char * header, const char * flags, image_io_handler readImage, image_io_handler writeImage )" -.br -.in -1c -.SH DESCRIPTION -The QImageIO class contains parameters for loading and saving images. -.PP -QImageIO contains a QIODevice object that is used for image data I/O. The programmer can install new image file formats in addition to those that Qt provides. -.PP -Qt 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). -.PP -You don't normally need to use this class; QPixmap::load(), QPixmap::save(), and QImage contain sufficient functionality. -.PP -For image files that contain sequences of images, only the first is read. See QMovie for loading multiple images. -.PP -PBM, PGM, and PPM format \fIoutput\fR is always in the more condensed raw format. PPM and PGM files with more than 256 levels of intensity are scaled down when reading. -.PP -\fBWarning:\fR 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 require you to license the technology. Such countries include Canada, Japan, the USA, France, Germany, Italy and the UK. -.PP -GIF support may be removed completely in a future version of Qt. We recommend using the PNG format. -.PP -See also QImage, QPixmap, QFile, QMovie, Graphics Classes, Image Processing Classes, and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QImageIO::QImageIO ()" -Constructs a QImageIO object with all parameters set to zero. -.SH "QImageIO::QImageIO ( QIODevice * ioDevice, const char * format )" -Constructs a QImageIO object with the I/O device \fIioDevice\fR and a \fIformat\fR tag. -.SH "QImageIO::QImageIO ( const QString & fileName, const char * format )" -Constructs a QImageIO object with the file name \fIfileName\fR and a \fIformat\fR tag. -.SH "QImageIO::~QImageIO ()" -Destroys the object and all related data. -.SH "void QImageIO::defineIOHandler ( const char * format, const char * header, const char * flags, image_io_handler readImage, image_io_handler writeImage )\fC [static]\fR" -Defines an image I/O handler for the image format called \fIformat\fR, which is recognized using the regular expression \fIheader\fR, read using \fIreadImage\fR and written using \fIwriteImage\fR. -.PP -\fIflags\fR 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 \fIflags\fR are "T" and the empty string. The "T" flag means that the image file is a text file, and Qt should treat all newline conventions as equivalent. (XPM files and some PPM files are text files for example.) -.PP -\fIformat\fR is used to select a handler to write a QImage; \fIheader\fR is used to select a handler to read an image file. -.PP -If \fIreadImage\fR is a null pointer, the QImageIO will not be able to read images in \fIformat\fR. If \fIwriteImage\fR is a null pointer, the QImageIO will not be able to write images in \fIformat\fR. If both are null, the QImageIO object is valid but useless. -.PP -Example: -.PP -.nf -.br - void readGIF( QImageIO *image ) -.br - { -.br - // read the image using the image->ioDevice() -.br - } -.br -.br - void writeGIF( QImageIO *image ) -.br - { -.br - // write the image using the image->ioDevice() -.br - } -.br -.br - // add the GIF image handler -.br -.br - QImageIO::defineIOHandler( "GIF", -.br - "^GIF[0-9][0-9][a-z]", -.br - 0, -.br - readGIF, -.br - writeGIF ); -.br -.fi -.PP -Before the regex test, all the 0 bytes in the file header are converted to 1 bytes. This is done because when Qt was ASCII-based, QRegExp could not handle 0 bytes in strings. -.PP -The regexp is only applied on the first 14 bytes of the file. -.PP -Note that Qt assumes that there is only one handler per format; if two handlers support the same format, Qt will choose one arbitrarily. It is not possible to have one handler support reading, and another support writing. -.SH "QString QImageIO::description () const" -Returns the image description string. -.PP -See also setDescription(). -.SH "QString QImageIO::fileName () const" -Returns the file name currently set. -.PP -See also setFileName(). -.SH "const char * QImageIO::format () const" -Returns the image format string or 0 if no format has been explicitly set. -.SH "float QImageIO::gamma () const" -Returns the gamma value at which the image will be viewed. -.PP -See also setGamma(). -.SH "const QImage & QImageIO::image () const" -Returns the image currently set. -.PP -See also setImage(). -.SH "const char * QImageIO::imageFormat ( const QString & fileName )\fC [static]\fR" -Returns a string that specifies the image format of the file \fIfileName\fR, or null if the file cannot be read or if the format is not recognized. -.SH "const char * QImageIO::imageFormat ( QIODevice * d )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string that specifies the image format of the image read from IO device \fId\fR, or 0 if the device cannot be read or if the format is not recognized. -.PP -Make sure that \fId\fR is at the right position in the device (for example, at the beginning of the file). -.PP -See also QIODevice::at(). -.SH "QStrList QImageIO::inputFormats ()\fC [static]\fR" -Returns a sorted list of image formats that are supported for image input. -.SH "QIODevice * QImageIO::ioDevice () const" -Returns the IO device currently set. -.PP -See also setIODevice(). -.SH "QStrList QImageIO::outputFormats ()\fC [static]\fR" -Returns a sorted list of image formats that are supported for image output. -.PP -Example: scribble/scribble.cpp. -.SH "const char * QImageIO::parameters () const" -Returns the image's parameters string. -.PP -See also setParameters(). -.SH "int QImageIO::quality () const" -Returns the quality of the written image, related to the compression ratio. -.PP -See also setQuality() and QImage::save(). -.SH "bool QImageIO::read ()" -Reads an image into memory and returns TRUE if the image was successfully read; otherwise returns FALSE. -.PP -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. -.PP -Setting the image file format string is optional. -.PP -Note that this function does \fInot\fR set the format used to read the image. If you need that information, use the imageFormat() static functions. -.PP -Example: -.PP -.nf -.br - QImageIO iio; -.br - QPixmap pixmap; -.br - iio.setFileName( "vegeburger.bmp" ); -.br - if ( image.read() ) // ok -.br - pixmap = iio.image(); // convert to pixmap -.br -.fi -.PP -See also setIODevice(), setFileName(), setFormat(), write(), and QPixmap::load(). -.SH "void QImageIO::setDescription ( const QString & description )" -Sets the image description string for image handlers that support image descriptions to \fIdescription\fR. -.PP -Currently, no image format supported by Qt uses the description string. -.SH "void QImageIO::setFileName ( const QString & fileName )" -Sets the name of the file to read or write an image from to \fIfileName\fR. -.PP -See also setIODevice(). -.SH "void QImageIO::setFormat ( const char * format )" -Sets the image format to \fIformat\fR for the image to be read or written. -.PP -It is necessary to specify a format before writing an image, but it is not necessary to specify a format before reading an image. -.PP -If no format has been set, Qt guesses the image format before reading it. If a format is set the image will only be read if it has that format. -.PP -See also read(), write(), and format(). -.SH "void QImageIO::setGamma ( float gamma )" -Sets the gamma value at which the image will be viewed to \fIgamma\fR. 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). -.PP -The default value is 0.0. -.PP -See also gamma(). -.SH "void QImageIO::setIODevice ( QIODevice * ioDevice )" -Sets the IO device to be used for reading or writing an image. -.PP -Setting the IO device allows images to be read/written to any block-oriented QIODevice. -.PP -If \fIioDevice\fR is not null, this IO device will override file name settings. -.PP -See also setFileName(). -.SH "void QImageIO::setImage ( const QImage & image )" -Sets the image to \fIimage\fR. -.PP -See also image(). -.SH "void QImageIO::setParameters ( const char * parameters )" -Sets the image's parameter string to \fIparameters\fR. This is for image handlers that require special parameters. -.PP -Although the current image formats supported by Qt ignore the parameters string, it may be used in future extensions or by contributions (for example, JPEG). -.PP -See also parameters(). -.SH "void QImageIO::setQuality ( int q )" -Sets the quality of the written image to \fIq\fR, related to the compression ratio. -.PP -\fIq\fR must be in the range -1..100. Specify 0 to obtain small compressed files, 100 for large uncompressed files. (-1 signifies the default compression.) -.PP -See also quality() and QImage::save(). -.SH "void QImageIO::setStatus ( int status )" -Sets the image IO status to \fIstatus\fR. A non-zero value indicates an error, whereas 0 means that the IO operation was successful. -.PP -See also status(). -.SH "int QImageIO::status () const" -Returns the image's IO status. A non-zero value indicates an error, whereas 0 means that the IO operation was successful. -.PP -See also setStatus(). -.SH "bool QImageIO::write ()" -Writes an image to an IO device and returns TRUE if the image was successfully written; otherwise returns FALSE. -.PP -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. -.PP -The image will be written using the specified image format. -.PP -Example: -.PP -.nf -.br - QImageIO iio; -.br - QImage im; -.br - im = pixmap; // convert to image -.br - iio.setImage( im ); -.br - iio.setFileName( "vegeburger.bmp" ); -.br - iio.setFormat( "BMP" ); -.br - if ( iio.write() ) -.br - // returned TRUE if written successfully -.br -.fi -.PP -See also setIODevice(), setFileName(), setFormat(), read(), and QPixmap::save(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qimageio.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimageio.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qimevent.3qt b/doc/man/man3/qimevent.3qt deleted file mode 100644 index 3eb8d8c87..000000000 --- a/doc/man/man3/qimevent.3qt +++ /dev/null @@ -1,127 +0,0 @@ -'\" t -.TH QIMEvent 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 -QIMEvent \- Parameters for input method events -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIMEvent\fR ( Type type, const QString & text, int cursorPosition )" -.br -.ti -1c -.BI "const QString & \fBtext\fR () const" -.br -.ti -1c -.BI "int \fBcursorPos\fR () const" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.ti -1c -.BI "int \fBselectionLength\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QIMEvent class provides parameters for input method events. -.PP -Input method events are sent to widgets when an input method is used to enter text into a widget. Input methods are widely used to enter text in Asian and other complex languages. -.PP -The events are of interest to widgets that accept keyboard input and want to be able to correctly handle complex languages. Text input in such languages is usually a three step process. -.PP -
                                  -.IP 1 -\fBStarting to Compose\fR -.br -When the user presses the first key on a keyboard an input context is created. This input context will contain a string with the typed characters. -.IP 2 -\fBComposing\fR -.br -With every new key pressed, the input method will try to create a matching string for the text typed so far. While the input context is active, the user can only move the cursor inside the string belonging to this input context. -.IP 3 -\fBCompleting\fR -.br -At some point, e.g. when the user presses the Spacebar, they get to this stage, where they can choose from a number of strings that match the text they have typed so far. The user can press Enter to confirm their choice or Escape to cancel the input; in either case the input context will be closed. -.PP -Note that the particular key presses used for a given input context may differ from those we've mentioned here, i.e. they may not be Spacebar, Enter and Escape. -.PP -These three stages are represented by three different types of events. The IMStartEvent, IMComposeEvent and IMEndEvent. When a new input context is created, an IMStartEvent will be sent to the widget and delivered to the QWidget::imStartEvent() function. The widget can then update internal data structures to reflect this. -.PP -After this, an IMComposeEvent will be sent to the widget for every key the user presses. It will contain the current composition string the widget has to show and the current cursor position within the composition string. This string is temporary and can change with every key the user types, so the widget will need to store the state before the composition started (the state it had when it received the IMStartEvent). IMComposeEvents will be delivered to the QWidget::imComposeEvent() function. -.PP -Usually, widgets try to mark the part of the text that is part of the current composition in a way that is visible to the user. A commonly used visual cue is to use a dotted underline. -.PP -After the user has selected the final string, an IMEndEvent will be sent to the widget. The event contains the final string the user selected, and could be empty if they canceled the composition. This string should be accepted as the final text the user entered, and the intermediate composition string should be cleared. These events are delivered to QWidget::imEndEvent(). -.PP -If the user clicks another widget, taking the focus out of the widget where the composition is taking place the IMEndEvent will be sent and the string it holds will be the result of the composition up to that point (which may be an empty string). -.PP -See also Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIMEvent::QIMEvent ( Type type, const QString & text, int cursorPosition )" -Constructs a new QIMEvent with the accept flag set to FALSE. \fItype\fR can be one of QEvent::IMStartEvent, QEvent::IMComposeEvent or QEvent::IMEndEvent. \fItext\fR contains the current compostion string and \fIcursorPosition\fR the current position of the cursor inside \fItext\fR. -.SH "void QIMEvent::accept ()" -Sets the accept flag of the input method event object. -.PP -Setting the accept parameter indicates that the receiver of the event processed the input method event. -.PP -The accept flag is not set by default. -.PP -See also ignore(). -.SH "int QIMEvent::cursorPos () const" -Returns the current cursor position inside the composition string. Will return -1 for IMStartEvent and IMEndEvent. -.SH "void QIMEvent::ignore ()" -Clears the accept flag parameter of the input method event object. -.PP -Clearing the accept parameter indicates that the event receiver does not want the input method event. -.PP -The accept flag is cleared by default. -.PP -See also accept(). -.SH "bool QIMEvent::isAccepted () const" -Returns TRUE if the receiver of the event processed the event; otherwise returns FALSE. -.SH "int QIMEvent::selectionLength () const" -Returns the number of characters in the composition string ( starting at cursorPos() ) that should be marked as selected by the input widget receiving the event. Will return 0 for IMStartEvent and IMEndEvent. -.SH "const QString & QIMEvent::text () const" -Returns the composition text. This is a null string for an -IMStartEvent, and contains the final accepted string (which may be -empty) in the IMEndEvent. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qimevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qimevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qinputdialog.3qt b/doc/man/man3/qinputdialog.3qt deleted file mode 100644 index 83ee42c9e..000000000 --- a/doc/man/man3/qinputdialog.3qt +++ /dev/null @@ -1,201 +0,0 @@ -'\" t -.TH QInputDialog 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 -QInputDialog \- Simple convenience dialog to get a single value from the user -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Static Public Members" -
                                1. QString \fBgetText\fR ( const QString & caption, const QString & label, QLineEdit::EchoMode mode = QLineEdit::Normal, const QString & text = QString::null, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )
                                2. int \fBgetInteger\fR ( const QString & caption, const QString & label, int value = 0, int minValue = -2147483647, int maxValue = 2147483647, int step = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )
                                3. double \fBgetDouble\fR ( const QString & caption, const QString & label, double value = 0, double minValue = -2147483647, double maxValue = 2147483647, int decimals = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )
                                4. QString \fBgetItem\fR ( const QString & caption, const QString & label, const QStringList & list, int current = 0, bool editable = TRUE, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) -.SH DESCRIPTION -The QInputDialog class provides a simple convenience dialog to get a single value from the user. -.PP -The input value can be a string, a number or an item from a list. A label must be set to tell the user what they should enter. -.PP -Four static convenience functions are provided: getText(), getInteger(), getDouble() and getItem(). All the functions can be used in a similar way, for example: -.PP -.nf -.br - bool ok; -.br - QString text = QInputDialog::getText( -.br - "MyApp 3000", "Enter your name:", QLineEdit::Normal, -.br - QString::null, &ok, this ); -.br - if ( ok && !text.isEmpty() ) { -.br - // user entered something and pressed OK -.br - } else { -.br - // user entered nothing or pressed Cancel -.br - } -.br -.fi -.PP -
                                  -.ce 1 -.B "[Image Omitted]" -.PP -
                                  -.PP -See also Dialog Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "double QInputDialog::getDouble ( const QString & caption, const QString & label, double value = 0, double minValue = -2147483647, double maxValue = 2147483647, int decimals = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Static convenience function to get a floating point number from the user. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fIvalue\fR is the default floating point number that the line edit will be set to. \fIminValue\fR and \fImaxValue\fR are the minimum and maximum values the user may choose, and \fIdecimals\fR is the maximum number of decimal places the number may have. -.PP -If \fIok\fR is not-null \fI*\fR\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. -.PP -This function returns the floating point number which has been entered by the user. -.PP -Use this static function like this: -.PP -.nf -.br - bool ok; -.br - double res = QInputDialog::getDouble( -.br - "MyApp 3000", "Enter a decimal number:", 33.7, 0, -.br - 1000, 2, &ok, this ); -.br - if ( ok ) { -.br - // user entered something and pressed OK -.br - } else { -.br - // user pressed Cancel -.br - } -.br -.fi -.SH "int QInputDialog::getInteger ( const QString & caption, const QString & label, int value = 0, int minValue = -2147483647, int maxValue = 2147483647, int step = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Static convenience function to get an integer input from the user. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fIvalue\fR is the default integer which the spinbox will be set to. \fIminValue\fR and \fImaxValue\fR are the minimum and maximum values the user may choose, and \fIstep\fR is the amount by which the values change as the user presses the arrow buttons to increment or decrement the value. -.PP -If \fIok\fR is not-null *\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. -.PP -This function returns the integer which has been entered by the user. -.PP -Use this static function like this: -.PP -.nf -.br - bool ok; -.br - int res = QInputDialog::getInteger( -.br - "MyApp 3000", "Enter a number:", 22, 0, 1000, 2, -.br - &ok, this ); -.br - if ( ok ) { -.br - // user entered something and pressed OK -.br - } else { -.br - // user pressed Cancel -.br - } -.br -.fi -.SH "QString QInputDialog::getItem ( const QString & caption, const QString & label, const QStringList & list, int current = 0, bool editable = TRUE, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Static convenience function to let the user select an item from a string list. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fIlist\fR is the string list which is inserted into the combobox, and \fIcurrent\fR is the number of the item which should be the current item. If \fIeditable\fR is TRUE the user can enter their own text; if \fIeditable\fR is FALSE the user may only select one of the existing items. -.PP -If \fIok\fR is not-null \fI*\fR\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. -.PP -This function returns the text of the current item, or if \fIeditable\fR is TRUE, the current text of the combobox. -.PP -Use this static function like this: -.PP -.nf -.br - QStringList lst; -.br - lst << "First" << "Second" << "Third" << "Fourth" << "Fifth"; -.br - bool ok; -.br - QString res = QInputDialog::getItem( -.br - "MyApp 3000", "Select an item:", lst, 1, TRUE, &ok, -.br - this ); -.br - if ( ok ) { -.br - // user selected an item and pressed OK -.br - } else { -.br - // user pressed Cancel -.br - } -.br -.fi -.SH "QString QInputDialog::getText ( const QString & caption, const QString & label, QLineEdit::EchoMode mode = QLineEdit::Normal, const QString & text = QString::null, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Static convenience function to get a string from the user. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fItext\fR is the default text which is placed in the line edit. The \fImode\fR is the echo mode the line edit will use. If \fIok\fR is not-null \fI*\fR\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. -.PP -This function returns the text which has been entered in the line edit. It will not return an empty string. -.PP -Use this static function like this: -.PP -.nf -.br - bool ok; -.br - QString text = QInputDialog::getText( -.br - "MyApp 3000", "Enter your name:", QLineEdit::Normal, -.br - QString::null, &ok, this ); -.br - if ( ok && !text.isEmpty() ) { -.br - // user entered something and pressed OK -.br - } else { -.br - // user entered nothing or pressed Cancel -.br - } -.br -.fi - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqinputdialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qinputdialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qintcache.3qt b/doc/man/man3/qintcache.3qt deleted file mode 100644 index b12feaed0..000000000 --- a/doc/man/man3/qintcache.3qt +++ /dev/null @@ -1,185 +0,0 @@ -'\" t -.TH QIntCache 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 -QIntCache \- Template class that provides a cache based on long keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIntCache\fR ( int maxCost = 100, int size = 17 )" -.br -.ti -1c -.BI "\fB~QIntCache\fR ()" -.br -.ti -1c -.BI "int \fBmaxCost\fR () const" -.br -.ti -1c -.BI "int \fBtotalCost\fR () const" -.br -.ti -1c -.BI "void \fBsetMaxCost\fR ( int m )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBinsert\fR ( long k, const type * d, int c = 1, int p = 0 )" -.br -.ti -1c -.BI "bool \fBremove\fR ( long k )" -.br -.ti -1c -.BI "type * \fBtake\fR ( long k )" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "type * \fBfind\fR ( long k, bool ref = TRUE ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( long k ) const" -.br -.ti -1c -.BI "void \fBstatistics\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QIntCache class is a template class that provides a cache based on long keys. -.PP -QIntCache is implemented as a template class. Define a template instance QIntCache to create a cache that operates on pointers to X, or X*. -.PP -A cache is a least recently used (LRU) list of cache items, accessed via \fClong\fR keys. Each cache item has a cost. The sum of item costs, totalCost(), will not exceed the maximum cache cost, maxCost(). If inserting a new item would cause the total cost to exceed the maximum cost, the least recently used items in the cache are removed. -.PP -Apart from insert(), by far the most important function is find() (which also exists as operator[]). This function looks up an item, returns it, and by default marks it as being the most recently used item. -.PP -There are also methods to remove() or take() an object from the cache. Calling setAutoDelete(TRUE) for a cache tells it to delete items that are removed. The default is to not delete items when they are removed (i.e. remove() and take() are equivalent). -.PP -When inserting an item into the cache, only the pointer is copied, not the item itself. This is called a shallow copy. It is possible to make the cache copy all of the item's data (known as a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a dictionary and reimplement newItem() if you want deep copies. -.PP -When removing a cache item, the item will be automatically deleted if auto-deletion is enabled. -.PP -There is a QIntCacheIterator which may be used to traverse the items in the cache in arbitrary order. -.PP -See also QIntCacheIterator, QCache, QAsciiCache, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIntCache::QIntCache ( int maxCost = 100, int size = 17 )" -Constructs a cache whose contents will never have a total cost greater than \fImaxCost\fR and which is expected to contain less than \fIsize\fR items. -.PP -\fIsize\fR is actually the size of an internal hash array; it's usually best to make it prime and at least 50% bigger than the largest expected number of items in the cache. -.PP -Each inserted item is associated with a cost. When inserting a new item, if the total cost of all items in the cache will exceed \fImaxCost\fR, the cache will start throwing out the older (least recently used) items until there is enough room for the new item to be inserted. -.SH "QIntCache::~QIntCache ()" -Removes all items from the cache and then destroys the int cache. If auto-deletion is enabled the cache's items are deleted. All iterators that access this cache will be reset. -.SH "void QIntCache::clear ()\fC [virtual]\fR" -Removes all items from the cache, and deletes them if auto-deletion has been enabled. -.PP -All cache iterators that operate this on cache are reset. -.PP -See also remove() and take(). -.PP -Reimplemented from QPtrCollection. -.SH "uint QIntCache::count () const\fC [virtual]\fR" -Returns the number of items in the cache. -.PP -See also totalCost(). -.PP -Reimplemented from QPtrCollection. -.SH "type * QIntCache::find ( long k, bool ref = TRUE ) const" -Returns the item associated with \fIk\fR, or 0 if the key does not exist in the cache. If \fIref\fR is TRUE (the default), the item is moved to the front of the least recently used list. -.PP -If there are two or more items with equal keys, the one that was inserted most recently is returned. -.SH "bool QIntCache::insert ( long k, const type * d, int c = 1, int p = 0 )" -Inserts the item \fId\fR into the cache with key \fIk\fR and assigns it a cost of \fIc\fR (default 1). Returns TRUE if it succeeds; otherwise returns FALSE. -.PP -The cache's size is limited, and if the total cost is too high, QIntCache will remove old, least-used items until there is room for this new item. -.PP -The parameter \fIp\fR is internal and should be left at the default value (0). -.PP -\fBWarning:\fR If this function returns FALSE (for example, the cost \fC,\fR exceeds maxCost()), you must delete \fId\fR yourself. Additionally, be very careful about using \fId\fR after calling this function. Any other insertions into the cache, from anywhere in the application or within Qt itself, could cause the object to be discarded from the cache and the pointer to become invalid. -.SH "bool QIntCache::isEmpty () const" -Returns TRUE if the cache is empty; otherwise returns FALSE. -.SH "int QIntCache::maxCost () const" -Returns the maximum allowed total cost of the cache. -.PP -See also setMaxCost() and totalCost(). -.SH "type * QIntCache::operator[] ( long k ) const" -Returns the item associated with \fIk\fR, or 0 if \fIk\fR does not exist in the cache, and moves the item to the front of the least recently used list. -.PP -If there are two or more items with equal keys, the one that was inserted most recently is returned. -.PP -This is the same as find( k, TRUE ). -.PP -See also find(). -.SH "bool QIntCache::remove ( long k )" -Removes the item associated with \fIk\fR, and returns TRUE if the item was present in the cache; otherwise returns FALSE. -.PP -The item is deleted if auto-deletion has been enabled, i.e. if you have called setAutoDelete(TRUE). -.PP -If there are two or more items with equal keys, the one that was inserted most recently is removed. -.PP -All iterators that refer to the removed item are set to point to the next item in the cache's traversal order. -.PP -See also take() and clear(). -.SH "void QIntCache::setMaxCost ( int m )" -Sets the maximum allowed total cost of the cache to \fIm\fR. If the current total cost is greater than \fIm\fR, some items are removed immediately. -.PP -See also maxCost() and totalCost(). -.SH "uint QIntCache::size () const" -Returns the size of the hash array used to implement the cache. This should be a bit larger than count() is likely to be. -.SH "void QIntCache::statistics () const" -A debug-only utility function. Prints out cache usage, hit/miss, and distribution information using tqDebug(). This function does nothing in the release library. -.SH "type * QIntCache::take ( long k )" -Takes the item associated with \fIk\fR out of the cache without deleting it, and returns a pointer to the item taken out or 0 if the key does not exist in the cache. -.PP -If there are two or more items with equal keys, the one that was inserted most recently is taken. -.PP -All iterators that refer to the taken item are set to point to the next item in the cache's traversal order. -.PP -See also remove() and clear(). -.SH "int QIntCache::totalCost () const" -Returns the total cost of the items in the cache. This is an integer in the range 0 to maxCost(). -.PP -See also setMaxCost(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqintcache.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qintcache.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qintcacheiterator.3qt b/doc/man/man3/qintcacheiterator.3qt deleted file mode 100644 index b3afd4f58..000000000 --- a/doc/man/man3/qintcacheiterator.3qt +++ /dev/null @@ -1,157 +0,0 @@ -'\" t -.TH QIntCacheIterator 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 -QIntCacheIterator \- Iterator for QIntCache collections -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIntCacheIterator\fR ( const QIntCache & cache )" -.br -.ti -1c -.BI "\fBQIntCacheIterator\fR ( const QIntCacheIterator & ci )" -.br -.ti -1c -.BI "QIntCacheIterator & \fBoperator=\fR ( const QIntCacheIterator & ci )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBatFirst\fR () const" -.br -.ti -1c -.BI "bool \fBatLast\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "type * \fBtoLast\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "long \fBcurrentKey\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.ti -1c -.BI "type * \fBoperator+=\fR ( uint jump )" -.br -.ti -1c -.BI "type * \fBoperator--\fR ()" -.br -.ti -1c -.BI "type * \fBoperator-=\fR ( uint jump )" -.br -.in -1c -.SH DESCRIPTION -The QIntCacheIterator class provides an iterator for QIntCache collections. -.PP -Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them. -.PP -Multiple iterators are completely independent, even when they operate on the same QIntCache. QIntCache updates all iterators that refer an item when that item is removed. -.PP -QIntCacheIterator provides an operator++(), and an operator+=() to traverse the cache; current() and currentKey() to access the current cache item and its key; atFirst() atLast(), which return TRUE if the iterator points to the first/last item in the cache; isEmpty(), which returns TRUE if the cache is empty; and count(), which returns the number of items in the cache. -.PP -Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also QIntCache, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIntCacheIterator::QIntCacheIterator ( const QIntCache & cache )" -Constructs an iterator for \fIcache\fR. The current iterator item is set to point to the first item in the \fIcache\fR (or rather, the first item is defined to be the item at which this constructor sets the iterator to point). -.SH "QIntCacheIterator::QIntCacheIterator ( const QIntCacheIterator & ci )" -Constructs an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently from there on. -.SH "bool QIntCacheIterator::atFirst () const" -Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also toFirst() and atLast(). -.SH "bool QIntCacheIterator::atLast () const" -Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. -.PP -See also toLast() and atFirst(). -.SH "uint QIntCacheIterator::count () const" -Returns the number of items in the cache on which this iterator operates. -.PP -See also isEmpty(). -.SH "type * QIntCacheIterator::current () const" -Returns a pointer to the current iterator item. -.SH "long QIntCacheIterator::currentKey () const" -Returns the key for the current iterator item. -.SH "bool QIntCacheIterator::isEmpty () const" -Returns TRUE if the cache is empty; otherwise returns FALSE. -.PP -See also count(). -.SH "QIntCacheIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QIntCacheIterator::operator() ()" -Makes the succeeding item current and returns the original current item. -.PP -If the current iterator item was the last item in the cache or if it was 0, 0 is returned. -.SH "type * QIntCacheIterator::operator++ ()" -Prefix ++ makes the iterator point to the item just after current(), and makes it the new current item for the iterator. If current() was the last item, operator--() returns 0. -.SH "type * QIntCacheIterator::operator+= ( uint jump )" -Returns the item \fIjump\fR positions after the current item, or 0 if it is beyond the last item. Makes this the current item. -.SH "type * QIntCacheIterator::operator-- ()" -Prefix -- makes the iterator point to the item just before current(), and makes it the new current item for the iterator. If current() was the first item, operator--() returns 0. -.SH "type * QIntCacheIterator::operator-= ( uint jump )" -Returns the item \fIjump\fR positions before the current item, or 0 if it is beyond the first item. Makes this the current item. -.SH "QIntCacheIterator & QIntCacheIterator::operator= ( const QIntCacheIterator & ci )" -Makes this an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently thereafter. -.SH "type * QIntCacheIterator::toFirst ()" -Sets the iterator to point to the first item in the cache and returns a pointer to the item. -.PP -Sets the iterator to 0, and returns 0, if the cache is empty. -.PP -See also toLast() and isEmpty(). -.SH "type * QIntCacheIterator::toLast ()" -Sets the iterator to point to the last item in the cache and returns a pointer to the item. -.PP -Sets the iterator to 0, and returns 0, if the cache is empty. -.PP -See also toFirst() and isEmpty(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qintcacheiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qintcacheiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qintdict.3qt b/doc/man/man3/qintdict.3qt deleted file mode 100644 index 355002cad..000000000 --- a/doc/man/man3/qintdict.3qt +++ /dev/null @@ -1,315 +0,0 @@ -'\" t -.TH QIntDict 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 -QIntDict \- Template class that provides a dictionary based on long keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIntDict\fR ( int size = 17 )" -.br -.ti -1c -.BI "\fBQIntDict\fR ( const QIntDict & dict )" -.br -.ti -1c -.BI "\fB~QIntDict\fR ()" -.br -.ti -1c -.BI "QIntDict & \fBoperator=\fR ( const QIntDict & dict )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "void \fBinsert\fR ( long key, const type * item )" -.br -.ti -1c -.BI "void \fBreplace\fR ( long key, const type * item )" -.br -.ti -1c -.BI "bool \fBremove\fR ( long key )" -.br -.ti -1c -.BI "type * \fBtake\fR ( long key )" -.br -.ti -1c -.BI "type * \fBfind\fR ( long key ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( long key ) const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "void \fBresize\fR ( uint newsize )" -.br -.ti -1c -.BI "void \fBstatistics\fR () const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" -.br -.in -1c -.SH DESCRIPTION -The QIntDict class is a template class that provides a dictionary based on long keys. -.PP -QMap is an STL-compatible alternative to this class. -.PP -QIntDict is implemented as a template class. Define a template instance QIntDict to create a dictionary that operates on pointers to X (X*). -.PP -A dictionary is a collection of key-value pairs. The key is an \fClong\fR used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. -.PP -Example: -.PP -.nf -.br - QIntDict fields; // long int keys, QLineEdit* values -.br - for ( int i = 0; i < 3; i++ ) -.br - fields.insert( i, new QLineEdit( this ) ); -.br -.br - fields[0]->setText( "Homer" ); -.br - fields[1]->setText( "Simpson" ); -.br - fields[2]->setText( "45" ); -.br -.br - QIntDictIterator it( fields ); -.br - for ( ; it.current(); ++it ) -.br - cout << it.currentKey() << ": " << it.current()->text() << endl; -.br -.br - for ( int i = 0; i < 3; i++ ) -.br - cout << fields[i]->text() << " "; // Prints "Homer Simpson 45" -.br - cout << endl; -.br -.br - fields.remove( 1 ); // Does not delete the line edit -.br - for ( int i = 0; i < 3; i++ ) -.br - if ( fields[i] ) -.br - cout << fields[i]->text() << " "; // Prints "Homer 45" -.br -.fi -.PP -See QDict for full details, including the choice of dictionary size, and how deletions are handled. -.PP -See also QIntDictIterator, QDict, QAsciiDict, QPtrDict, Collection Classes, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIntDict::QIntDict ( int size = 17 )" -Constructs a dictionary using an internal hash array of size \fIsize\fR. -.PP -Setting \fIsize\fR to a suitably large prime number (equal to or greater than the expected number of entries) makes the hash distribution better which leads to faster lookup. -.SH "QIntDict::QIntDict ( const QIntDict & dict )" -Constructs a copy of \fIdict\fR. -.PP -Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). -.SH "QIntDict::~QIntDict ()" -Removes all items from the dictionary and destroys it. -.PP -All iterators that access this dictionary will be reset. -.PP -See also setAutoDelete(). -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QIntDict::clear ()\fC [virtual]\fR" -Removes all items from the dictionary. -.PP -The removed items are deleted if auto-deletion is enabled. -.PP -All dictionary iterators that access this dictionary will be reset. -.PP -See also remove(), take(), and setAutoDelete(). -.PP -Reimplemented from QPtrCollection. -.SH "uint QIntDict::count () const\fC [virtual]\fR" -Returns the number of items in the dictionary. -.PP -See also isEmpty(). -.PP -Reimplemented from QPtrCollection. -.SH "type * QIntDict::find ( long key ) const" -Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be found. -.PP -Equivalent to operator[]. -.PP -See also operator[](). -.PP -Example: table/bigtable/main.cpp. -.SH "void QIntDict::insert ( long key, const type * item )" -Insert item \fIitem\fR into the dictionary using key \fIkey\fR. -.PP -Multiple items can have the same key, in which case only the last item will be accessible using operator[](). -.PP -\fIitem\fR may not be 0. -.PP -See also replace(). -.PP -Example: scribble/scribble.cpp. -.SH "bool QIntDict::isEmpty () const" -Returns TRUE if the dictionary is empty; otherwise returns FALSE. -.PP -See also count(). -.SH "QIntDict & QIntDict::operator= ( const QIntDict & dict )" -Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. -.PP -This dictionary is first cleared and then each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy), unless newItem() has been reimplemented. -.SH "type * QIntDict::operator[] ( long key ) const" -Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be found. -.PP -Equivalent to the find() function. -.PP -See also find(). -.SH "QDataStream & QIntDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QIntDict::remove ( long key )" -Removes the item associated with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if the \fIkey\fR is in the dictionary; otherwise returns FALSE. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be removed. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary's traversal order. -.PP -See also take(), clear(), and setAutoDelete(). -.PP -Example: table/bigtable/main.cpp. -.SH "void QIntDict::replace ( long key, const type * item )" -If the dictionary has key \fIkey\fR, this key's item is replaced with \fIitem\fR. If the dictionary doesn't contain key \fIkey\fR, \fIitem\fR is inserted into the dictionary using key \fIkey\fR. -.PP -\fIitem\fR may not be 0. -.PP -Equivalent to: -.PP -.nf -.br - QIntDict dict; -.br - // ... -.br - if ( dict.find(key) ) -.br - dict.remove( key ); -.br - dict.insert( key, item ); -.br -.fi -.PP -If there are two or more items with equal keys, then the most recently inserted item will be replaced. -.PP -See also insert(). -.PP -Example: table/bigtable/main.cpp. -.SH "void QIntDict::resize ( uint newsize )" -Changes the size of the hashtable to \fInewsize\fR. The contents of the dictionary are preserved, but all iterators on the dictionary become invalid. -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. -.SH "uint QIntDict::size () const" -Returns the size of the internal hash array (as specified in the constructor). -.PP -See also count(). -.SH "void QIntDict::statistics () const" -Debugging-only function that prints out the dictionary distribution using tqDebug(). -.SH "type * QIntDict::take ( long key )" -Takes the item associated with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). -.PP -If there are two or more items with equal keys, then the most recently inserted item will be taken. -.PP -Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. -.PP -All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary's traversing order. -.PP -See also remove(), clear(), and setAutoDelete(). -.PP -Example: table/bigtable/main.cpp. -.SH "QDataStream & QIntDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" -Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqintdict.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qintdict.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qintdictiterator.3qt b/doc/man/man3/qintdictiterator.3qt deleted file mode 100644 index 7a7c54473..000000000 --- a/doc/man/man3/qintdictiterator.3qt +++ /dev/null @@ -1,157 +0,0 @@ -'\" t -.TH QIntDictIterator 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 -QIntDictIterator \- Iterator for QIntDict collections -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIntDictIterator\fR ( const QIntDict & dict )" -.br -.ti -1c -.BI "\fB~QIntDictIterator\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "long \fBcurrentKey\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.ti -1c -.BI "type * \fBoperator+=\fR ( uint jump )" -.br -.in -1c -.SH DESCRIPTION -The QIntDictIterator class provides an iterator for QIntDict collections. -.PP -QIntDictIterator is implemented as a template class. Define a template instance QIntDictIterator to create a dictionary iterator that operates on QIntDict (dictionary of X*). -.PP -Example: -.PP -.nf -.br - QIntDict fields; -.br - for ( int i = 0; i < 3; i++ ) -.br - fields.insert( i, new QLineEdit( this ) ); -.br -.br - fields[0]->setText( "Homer" ); -.br - fields[1]->setText( "Simpson" ); -.br - fields[2]->setText( "45" ); -.br -.br - QIntDictIterator it( fields ); -.br -.br - for ( ; it.current(); ++it ) -.br - cout << it.currentKey() << ": " << it.current()->text() << endl; -.br -.br - // Output (random order): -.br - // 0: Homer -.br - // 1: Simpson -.br - // 2: 45 -.br -.fi -.PP -Note that the traversal order is arbitrary; you are not guaranteed the order shown above. -.PP -Multiple iterators may independently traverse the same dictionary. A QIntDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QIntDict updates all iterators that refer the removed item to point to the next item in the traversal order. -.PP -See also QIntDict, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIntDictIterator::QIntDictIterator ( const QIntDict & dict )" -Constructs an iterator for \fIdict\fR. The current iterator item is set to point to the 'first' item in the \fIdict\fR. The first item refers to the first item in the dictionary's arbitrary internal ordering. -.SH "QIntDictIterator::~QIntDictIterator ()" -Destroys the iterator. -.SH "uint QIntDictIterator::count () const" -Returns the number of items in the dictionary this iterator operates over. -.PP -See also isEmpty(). -.SH "type * QIntDictIterator::current () const" -Returns a pointer to the current iterator item. -.SH "long QIntDictIterator::currentKey () const" -Returns the key for the current iterator item. -.SH "bool QIntDictIterator::isEmpty () const" -Returns TRUE if the dictionary is empty; otherwise eturns FALSE. -.PP -See also count(). -.SH "QIntDictIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QIntDictIterator::operator() ()" -Makes the succeeding item current and returns the original current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QIntDictIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns the new current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QIntDictIterator::operator+= ( uint jump )" -Sets the current item to the item \fIjump\fR positions after the current item, and returns a pointer to that item. -.PP -If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0. -.SH "type * QIntDictIterator::toFirst ()" -Sets the current iterator item to point to the first item in the -dictionary and returns a pointer to the item. The first item -refers to the first item in the dictionary's arbitrary internal -ordering. If the dictionary is empty it sets the current item to -0 and returns 0. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qintdictiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qintdictiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qintvalidator.3qt b/doc/man/man3/qintvalidator.3qt deleted file mode 100644 index 54dd7a105..000000000 --- a/doc/man/man3/qintvalidator.3qt +++ /dev/null @@ -1,203 +0,0 @@ -'\" t -.TH QIntValidator 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 -QIntValidator \- Validator which ensures that a string contains a valid integer within a specified range -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QValidator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQIntValidator\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQIntValidator\fR ( int minimum, int maximum, QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QIntValidator\fR ()" -.br -.ti -1c -.BI "virtual QValidator::State \fBvalidate\fR ( QString & input, int & ) const" -.br -.ti -1c -.BI "void \fBsetBottom\fR ( int )" -.br -.ti -1c -.BI "void \fBsetTop\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBsetRange\fR ( int bottom, int top )" -.br -.ti -1c -.BI "int \fBbottom\fR () const" -.br -.ti -1c -.BI "int \fBtop\fR () const" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBbottom\fR - the validator's lowest acceptable value" -.br -.ti -1c -.BI "int \fBtop\fR - the validator's highest acceptable value" -.br -.in -1c -.SH DESCRIPTION -The QIntValidator class provides a validator which ensures that a string contains a valid integer within a specified range. -.PP -Example of use: -.PP -.nf -.br - QValidator* validator = new QIntValidator( 100, 999, this ); -.br - QLineEdit* edit = new QLineEdit( this ); -.br -.br - // the edit lineedit will only accept integers between 100 and 999 -.br - edit->setValidator( validator ); -.br -.fi -.PP -Below we present some examples of validators. In practice they would normally be associated with a widget as in the example above. -.PP -.nf -.br - QString str; -.br - int pos = 0; -.br - QIntValidator v( 100, 999, this ); -.br -.br - str = "1"; -.br - v.validate( str, pos ); // returns Intermediate -.br - str = "12"; -.br - v.validate( str, pos ); // returns Intermediate -.br -.br - str = "123"; -.br - v.validate( str, pos ); // returns Acceptable -.br - str = "678"; -.br - v.validate( str, pos ); // returns Acceptable -.br -.br - str = "1234"; -.br - v.validate( str, pos ); // returns Invalid -.br - str = "-123"; -.br - v.validate( str, pos ); // returns Invalid -.br - str = "abc"; -.br - v.validate( str, pos ); // returns Invalid -.br - str = "12cm"; -.br - v.validate( str, pos ); // returns Invalid -.br -.fi -.PP -The minimum and maximum values are set in one call with setRange() or individually with setBottom() and setTop(). -.PP -See also QDoubleValidator, QRegExpValidator, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIntValidator::QIntValidator ( QObject * parent, const char * name = 0 )" -Constructs a validator called \fIname\fR with parent \fIparent\fR, that accepts all integers. -.SH "QIntValidator::QIntValidator ( int minimum, int maximum, QObject * parent, const char * name = 0 )" -Constructs a validator called \fIname\fR with parent \fIparent\fR, that accepts integers from \fIminimum\fR to \fImaximum\fR inclusive. -.SH "QIntValidator::~QIntValidator ()" -Destroys the validator, freeing any resources allocated. -.SH "int QIntValidator::bottom () const" -Returns the validator's lowest acceptable value. See the "bottom" property for details. -.SH "void QIntValidator::setBottom ( int )" -Sets the validator's lowest acceptable value. See the "bottom" property for details. -.SH "void QIntValidator::setRange ( int bottom, int top )\fC [virtual]\fR" -Sets the range of the validator to only accept integers between \fIbottom\fR and \fItop\fR inclusive. -.SH "void QIntValidator::setTop ( int )" -Sets the validator's highest acceptable value. See the "top" property for details. -.SH "int QIntValidator::top () const" -Returns the validator's highest acceptable value. See the "top" property for details. -.SH "QValidator::State QIntValidator::validate ( QString & input, int & ) const\fC [virtual]\fR" -Returns Acceptable if the \fIinput\fR is an integer within the valid range, Intermediate if the \fIinput\fR is an integer outside the valid range and Invalid if the \fIinput\fR is not an integer. -.PP -Note: If the valid range consists of just positive integers (e.g. 32 - 100) and \fIinput\fR is a negative integer then Invalid is returned. -.PP -.nf -.br - int pos = 0; -.br - s = "abc"; -.br - v.validate( s, pos ); // returns Invalid -.br -.br - s = "5"; -.br - v.validate( s, pos ); // returns Intermediate -.br -.br - s = "50"; -.br - v.validate( s, pos ); // returns Valid -.br -.fi -.PP -Reimplemented from QValidator. -.SS "Property Documentation" -.SH "int bottom" -This property holds the validator's lowest acceptable value. -.PP -Set this property's value with setBottom() and get this property's value with bottom(). -.PP -See also setRange(). -.SH "int top" -This property holds the validator's highest acceptable value. -.PP -Set this property's value with setTop() and get this property's value with top(). -.PP -See also setRange(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qintvalidator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qintvalidator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qiodevice.3qt b/doc/man/man3/qiodevice.3qt deleted file mode 100644 index 6d087c344..000000000 --- a/doc/man/man3/qiodevice.3qt +++ /dev/null @@ -1,551 +0,0 @@ -'\" t -.TH QIODevice 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 -QIODevice \- The base class of I/O devices -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                  -.PP -\fC#include \fR -.PP -Inherited by QBuffer, QFile, QSocket, and QSocketDevice. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef TQ_ULONG \fBOffset\fR" -.br -.ti -1c -.BI "\fBQIODevice\fR ()" -.br -.ti -1c -.BI "virtual \fB~QIODevice\fR ()" -.br -.ti -1c -.BI "int \fBflags\fR () const" -.br -.ti -1c -.BI "int \fBmode\fR () const" -.br -.ti -1c -.BI "int \fBstate\fR () const" -.br -.ti -1c -.BI "bool \fBisDirectAccess\fR () const" -.br -.ti -1c -.BI "bool \fBisSequentialAccess\fR () const" -.br -.ti -1c -.BI "bool \fBisCombinedAccess\fR () const" -.br -.ti -1c -.BI "bool \fBisBuffered\fR () const" -.br -.ti -1c -.BI "bool \fBisRaw\fR () const" -.br -.ti -1c -.BI "bool \fBisSynchronous\fR () const" -.br -.ti -1c -.BI "bool \fBisAsynchronous\fR () const" -.br -.ti -1c -.BI "bool \fBisTranslated\fR () const" -.br -.ti -1c -.BI "bool \fBisReadable\fR () const" -.br -.ti -1c -.BI "bool \fBisWritable\fR () const" -.br -.ti -1c -.BI "bool \fBisReadWrite\fR () const" -.br -.ti -1c -.BI "bool \fBisInactive\fR () const" -.br -.ti -1c -.BI "bool \fBisOpen\fR () const" -.br -.ti -1c -.BI "int \fBstatus\fR () const" -.br -.ti -1c -.BI "void \fBresetStatus\fR ()" -.br -.ti -1c -.BI "virtual bool \fBopen\fR ( int mode ) = 0" -.br -.ti -1c -.BI "virtual void \fBclose\fR () = 0" -.br -.ti -1c -.BI "virtual void \fBflush\fR () = 0" -.br -.ti -1c -.BI "virtual Offset \fBsize\fR () const = 0" -.br -.ti -1c -.BI "virtual Offset \fBat\fR () const" -.br -.ti -1c -.BI "virtual bool \fBat\fR ( Offset pos )" -.br -.ti -1c -.BI "virtual bool \fBatEnd\fR () const" -.br -.ti -1c -.BI "bool \fBreset\fR ()" -.br -.ti -1c -.BI "virtual TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen ) = 0" -.br -.ti -1c -.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len ) = 0" -.br -.ti -1c -.BI "virtual TQ_LONG \fBreadLine\fR ( char * data, TQ_ULONG maxlen )" -.br -.ti -1c -.BI "TQ_LONG \fBwriteBlock\fR ( const QByteArray & data )" -.br -.ti -1c -.BI "virtual QByteArray \fBreadAll\fR ()" -.br -.ti -1c -.BI "virtual int \fBgetch\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBputch\fR ( int ch ) = 0" -.br -.ti -1c -.BI "virtual int \fBungetch\fR ( int ch ) = 0" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsetFlags\fR ( int flags )" -.br -.ti -1c -.BI "void \fBsetType\fR ( int type )" -.br -.ti -1c -.BI "void \fBsetMode\fR ( int mode )" -.br -.ti -1c -.BI "void \fBsetState\fR ( int state )" -.br -.ti -1c -.BI "void \fBsetStatus\fR ( int s )" -.br -.in -1c -.SH DESCRIPTION -The QIODevice class is the base class of I/O devices. -.PP -An I/O device represents a medium that one can read bytes from and/or write bytes to. The QIODevice class is the abstract superclass of all such devices; classes such as QFile, QBuffer and QSocket inherit QIODevice and implement virtual functions such as write() appropriately. -.PP -Although applications sometimes use QIODevice directly, it is usually better to use QTextStream and QDataStream, which provide stream operations on any QIODevice subclass. QTextStream provides text-oriented stream functionality (for human-readable ASCII files, for example), whereas QDataStream deals with binary data in a totally platform-independent manner. -.PP -The public member functions in QIODevice roughly fall into two groups: the action functions and the state access functions. The most important action functions are: -.IP -.TP -open() opens a device for reading and/or writing, depending on the mode argument. -.IP -.TP -close() closes the device and tidies up (e.g. flushes buffered data) -.IP -.TP -readBlock() reads a block of data from the device. -.IP -.TP -writeBlock() writes a block of data to the device. -.IP -.TP -readLine() reads a line (of text, usually) from the device. -.IP -.TP -flush() ensures that all buffered data are written to the real device. -.IP -.PP -There are also some other, less used, action functions: -.IP -.TP -getch() reads a single character. -.IP -.TP -ungetch() forgets the last call to getch(), if possible. -.IP -.TP -putch() writes a single character. -.IP -.TP -size() returns the size of the device, if there is one. -.IP -.TP -at() returns the current read/write pointer's position, if there is one for this device, or it moves the pointer if given an offset. -.IP -.TP -atEnd() indicates whether there is more to read, if this is meaningful for this device. -.IP -.TP -reset() moves the read/write pointer to the start of the device, if that is possible for this device. -.IP -.PP -The state access are all "get" functions. The QIODevice subclass calls setState() to update the state, and simple access functions tell the user of the device what the device's state is. Here are the settings, and their associated access functions: -.IP -.TP -Access type. Some devices are direct access (it is possible to read/write anywhere), whereas others are sequential. QIODevice provides the access functions (isDirectAccess(), isSequentialAccess(), and isCombinedAccess()) to tell users what a given I/O device supports. -.IP -.TP -Buffering. Some devices are accessed in raw mode, whereas others are buffered. Buffering usually provides greater efficiency, particularly for small read/write operations. isBuffered() tells the user whether a given device is buffered. (This can often be set by the application in the call to open().) -.IP -.TP -Synchronicity. Synchronous devices work immediately (for example, files). When you read from a file, the file delivers its data straight away. Other kinds of device, such as a socket connected to a HTTP server, may not deliver the data until seconds after you ask to read it. isSynchronous() and isAsynchronous() tell the user how this device operates. -.IP -.TP -CR/LF translation. For simplicity, applications often like to see just a single CR/LF style, and QIODevice subclasses can provide this. isTranslated() returns TRUE if this object translates CR/LF to just LF. (This can often be set by the application in the call to open().) -.IP -.TP -Permissions. Some files cannot be written. For example, isReadable(), isWritable() and isReadWrite() tell the application whether it can read from and write to a given device. (This can often be set by the application in the call to open().) -.IP -.TP -Finally, isOpen() returns TRUE if the device is open, i.e. after an open() call. -.IP -.PP -QIODevice provides numerous pure virtual functions that you need to implement when subclassing it. Here is a skeleton subclass with all the members you are sure to need and some that you will probably need: -.PP -.nf -.br - class MyDevice : public QIODevice -.br - { -.br - public: -.br - MyDevice(); -.br - ~MyDevice(); -.br -.br - bool open( int mode ); -.br - void close(); -.br - void flush(); -.br -.br - uint size() const; -.br - int at() const; // non-pure virtual -.br - bool at( int ); // non-pure virtual -.br - bool atEnd() const; // non-pure virtual -.br -.br - int readBlock( char *data, uint maxlen ); -.br - int writeBlock( const char *data, uint len ); -.br - int readLine( char *data, uint maxlen ); -.br -.br - int getch(); -.br - int putch( int ); -.br - int ungetch( int ); -.br - }; -.br -.fi -.PP -The three non-pure virtual functions need not be reimplemented for sequential devices. -.PP -See also QDataStream, QTextStream, and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QIODevice::Offset" -The offset within the device. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QIODevice::QIODevice ()" -Constructs an I/O device. -.SH "QIODevice::~QIODevice ()\fC [virtual]\fR" -Destroys the I/O device. -.SH "Offset QIODevice::at () const\fC [virtual]\fR" -Virtual function that returns the current I/O device position. -.PP -This is the position of the data read/write head of the I/O device. -.PP -See also size(). -.PP -Example: distributor/distributor.ui.h. -.PP -Reimplemented in QSocket. -.SH "bool QIODevice::at ( Offset pos )\fC [virtual]\fR" -Virtual function that sets the I/O device position to \fIpos\fR. Returns TRUE if the position was successfully set, i.e. \fIpos\fR is within range and the seek was successful; otherwise returns FALSE. -.PP -See also size(). -.PP -Reimplemented in QSocket. -.SH "bool QIODevice::atEnd () const\fC [virtual]\fR" -Virtual function that returns TRUE if the I/O device position is at the end of the input; otherwise returns FALSE. -.PP -Reimplemented in QFile and QSocket. -.SH "void QIODevice::close ()\fC [pure virtual]\fR" -Closes the I/O device. -.PP -This virtual function must be reimplemented by all subclasses. -.PP -See also open(). -.PP -Example: grapher/grapher.cpp. -.PP -Reimplemented in QFile and QSocket. -.SH "int QIODevice::flags () const" -Returns the current I/O device flags setting. -.PP -Flags consists of mode flags and state flags. -.PP -See also mode() and state(). -.SH "void QIODevice::flush ()\fC [pure virtual]\fR" -Flushes an open I/O device. -.PP -This virtual function must be reimplemented by all subclasses. -.PP -Reimplemented in QFile and QSocket. -.SH "int QIODevice::getch ()\fC [pure virtual]\fR" -Reads a single byte/character from the I/O device. -.PP -Returns the byte/character read, or -1 if the end of the I/O device has been reached. -.PP -This virtual function must be reimplemented by all subclasses. -.PP -See also putch() and ungetch(). -.PP -Reimplemented in QFile and QSocket. -.SH "bool QIODevice::isAsynchronous () const" -Returns TRUE if the device is an asynchronous device; otherwise returns FALSE, i.e. if the device is a synchronous device. -.PP -This mode is currently not in use. -.PP -See also isSynchronous(). -.SH "bool QIODevice::isBuffered () const" -Returns TRUE if the I/O device is a buffered device; otherwise returns FALSE, i.e. the device is a raw device. -.PP -See also isRaw(). -.SH "bool QIODevice::isCombinedAccess () const" -Returns TRUE if the I/O device is a combined access (both direct and sequential) device; otherwise returns FALSE. -.PP -This access method is currently not in use. -.SH "bool QIODevice::isDirectAccess () const" -Returns TRUE if the I/O device is a direct access device; otherwise returns FALSE, i.e. if the device is a sequential access device. -.PP -See also isSequentialAccess(). -.SH "bool QIODevice::isInactive () const" -Returns TRUE if the I/O device state is 0, i.e. the device is not open; otherwise returns FALSE. -.PP -See also isOpen(). -.SH "bool QIODevice::isOpen () const" -Returns TRUE if the I/O device has been opened; otherwise returns FALSE. -.PP -See also isInactive(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "bool QIODevice::isRaw () const" -Returns TRUE if the device is a raw device; otherwise returns FALSE, i.e. if the device is a buffered device. -.PP -See also isBuffered(). -.SH "bool QIODevice::isReadWrite () const" -Returns TRUE if the I/O device was opened using IO_ReadWrite mode; otherwise returns FALSE. -.PP -See also isReadable() and isWritable(). -.SH "bool QIODevice::isReadable () const" -Returns TRUE if the I/O device was opened using IO_ReadOnly or IO_ReadWrite mode; otherwise returns FALSE. -.PP -See also isWritable() and isReadWrite(). -.SH "bool QIODevice::isSequentialAccess () const" -Returns TRUE if the device is a sequential access device; otherwise returns FALSE, i.e. if the device is a direct access device. -.PP -Operations involving size() and at(int) are not valid on sequential devices. -.PP -See also isDirectAccess(). -.SH "bool QIODevice::isSynchronous () const" -Returns TRUE if the I/O device is a synchronous device; otherwise returns FALSE, i.e. the device is an asynchronous device. -.PP -See also isAsynchronous(). -.SH "bool QIODevice::isTranslated () const" -Returns TRUE if the I/O device translates carriage-return and linefeed characters; otherwise returns FALSE. -.PP -A QFile is translated if it is opened with the IO_Translate mode flag. -.SH "bool QIODevice::isWritable () const" -Returns TRUE if the I/O device was opened using IO_WriteOnly or IO_ReadWrite mode; otherwise returns FALSE. -.PP -See also isReadable() and isReadWrite(). -.SH "int QIODevice::mode () const" -Returns bits OR'ed together that specify the current operation mode. -.PP -These are the flags that were given to the open() function. -.PP -The flags are IO_ReadOnly, IO_WriteOnly, IO_ReadWrite, IO_Append, IO_Truncate and IO_Translate. -.SH "bool QIODevice::open ( int mode )\fC [pure virtual]\fR" -Opens the I/O device using the specified \fImode\fR. Returns TRUE if the device was successfully opened; otherwise returns FALSE. -.PP -The mode parameter \fImode\fR must be an OR'ed combination of the following flags.
                                  .nf -.TS -l - l. Mode flags Meaning IO_Raw specifies raw (unbuffered) file access. IO_ReadOnly opens a file in read-only mode. IO_WriteOnly opens a file in write-only mode. IO_ReadWrite opens a file in read/write mode. IO_Append sets the file index to the end of the file. IO_Truncate truncates the file. IO_Translate -.TE -.fi -
                                  -.PP -This virtual function must be reimplemented by all subclasses. -.PP -See also close(). -.PP -Example: grapher/grapher.cpp. -.PP -Reimplemented in QFile and QSocket. -.SH "int QIODevice::putch ( int ch )\fC [pure virtual]\fR" -Writes the character \fIch\fR to the I/O device. -.PP -Returns \fIch\fR, or -1 if an error occurred. -.PP -This virtual function must be reimplemented by all subclasses. -.PP -See also getch() and ungetch(). -.PP -Example: grapher/grapher.cpp. -.PP -Reimplemented in QFile and QSocket. -.SH "QByteArray QIODevice::readAll ()\fC [virtual]\fR" -This convenience function returns all of the remaining data in the device. -.SH "TQ_LONG QIODevice::readBlock ( char * data, TQ_ULONG maxlen )\fC [pure virtual]\fR" -Reads at most \fImaxlen\fR bytes from the I/O device into \fIdata\fR and returns the number of bytes actually read. -.PP -This function should return -1 if a fatal error occurs and should return 0 if there are no bytes to read. -.PP -The device must be opened for reading, and \fIdata\fR must not be 0. -.PP -This virtual function must be reimplemented by all subclasses. -.PP -See also writeBlock(), isOpen(), and isReadable(). -.PP -Example: distributor/distributor.ui.h. -.PP -Reimplemented in QSocket and QSocketDevice. -.SH "TQ_LONG QIODevice::readLine ( char * data, TQ_ULONG maxlen )\fC [virtual]\fR" -Reads a line of text, (or up to \fImaxlen\fR bytes if a newline isn't encountered) plus a terminating '\0' into \fIdata\fR. If there is a newline at the end if the line, it is not stripped. -.PP -Returns the number of bytes read including the terminating '\0', or -1 if an error occurred. -.PP -This virtual function can be reimplemented much more efficiently by the most subclasses. -.PP -See also readBlock() and QTextStream::readLine(). -.PP -Reimplemented in QFile. -.SH "bool QIODevice::reset ()" -Sets the device index position to 0. -.PP -See also at(). -.SH "void QIODevice::resetStatus ()" -Sets the I/O device status to IO_Ok. -.PP -See also status(). -.SH "void QIODevice::setFlags ( int flags )\fC [protected]\fR" -Used by subclasses to set the device flags to the \fIflags\fR specified. -.SH "void QIODevice::setMode ( int mode )\fC [protected]\fR" -Used by subclasses to set the device mode to the \fImode\fR specified. -.SH "void QIODevice::setState ( int state )\fC [protected]\fR" -Used by subclasses to set the device state to the \fIstate\fR specified. -.SH "void QIODevice::setStatus ( int s )\fC [protected]\fR" -Used by subclasses to set the device status (not state) to \fIs\fR. -.SH "void QIODevice::setType ( int type )\fC [protected]\fR" -Used by subclasses to set the device type to the \fItype\fR specified. -.SH "Offset QIODevice::size () const\fC [pure virtual]\fR" -Virtual function that returns the size of the I/O device. -.PP -See also at(). -.PP -Reimplemented in QFile and QSocket. -.SH "int QIODevice::state () const" -Returns bits OR'ed together that specify the current state. -.PP -The flags are: \fCIO_Open\fR. -.PP -Subclasses may define additional flags. -.SH "int QIODevice::status () const" -Returns the I/O device status. -.PP -The I/O device status returns an error code. If open() returns FALSE or readBlock() or writeBlock() return -1, this function can be called to find out the reason why the operation failed. -.PP - -.PP -The status codes are:
                                  .nf -.TS -l - l. Status code Meaning IO_Ok The operation was successful. IO_ReadError Could not read from the device. IO_WriteError Could not write to the device. IO_FatalError A fatal unrecoverable error occurred. IO_OpenError Could not open the device. IO_ConnectError Could not connect to the device. IO_AbortError The operation was unexpectedly aborted. IO_TimeOutError The operation timed out. IO_UnspecifiedError -.TE -.fi -
                                  -.PP -See also resetStatus(). -.SH "int QIODevice::ungetch ( int ch )\fC [pure virtual]\fR" -Puts the character \fIch\fR back into the I/O device and decrements the index position if it is not zero. -.PP -This function is normally called to "undo" a getch() operation. -.PP -Returns \fIch\fR, or -1 if an error occurred. -.PP -This virtual function must be reimplemented by all subclasses. -.PP -See also getch() and putch(). -.PP -Reimplemented in QFile and QSocket. -.SH "TQ_LONG QIODevice::writeBlock ( const char * data, TQ_ULONG len )\fC [pure virtual]\fR" -Writes \fIlen\fR bytes from \fIdata\fR to the I/O device and returns the number of bytes actually written. -.PP -This function should return -1 if a fatal error occurs. -.PP -This virtual function must be reimplemented by all subclasses. -.PP -See also readBlock(). -.PP -Example: distributor/distributor.ui.h. -.PP -Reimplemented in QBuffer, QSocket, and QSocketDevice. -.SH "TQ_LONG QIODevice::writeBlock ( const QByteArray & data )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This convenience function is the same as calling writeBlock( -data.data(), data.size() ). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqiodevice.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qiodevice.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qjiscodec.3qt b/doc/man/man3/qjiscodec.3qt deleted file mode 100644 index 25dbc5cc4..000000000 --- a/doc/man/man3/qjiscodec.3qt +++ /dev/null @@ -1,96 +0,0 @@ -'\" t -.TH QJisCodec 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 -QJisCodec \- Conversion to and from JIS character sets -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                  -.PP -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual const char * \fBmimeName\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QJisCodec class provides conversion to and from JIS character sets. -.PP -More precisely, the QJisCodec class subclasses QTextCodec to provide support for JIS X 0201 Latin, JIS X 0201 Kana, JIS X 0208 and JIS X 0212. -.PP -The environment variable UNICODEMAP_JP can be used to fine-tune QJisCodec, QSjisCodec and QEucJpCodec. The mapping names are as for the Japanese XML working group's XML Japanese Profile, because it names and explains all the widely used mappings. Here are brief descriptions, written by Serika Kurusugawa: -.IP -.TP -"unicode-0.9" or "unicode-0201" for Unicode style. This assumes JISX0201 for 0x00-0x7f. (0.9 is a table version of jisx02xx mapping used for Uniocde spec version 1.1.) -.IP -.TP -"unicode-ascii" This assumes US-ASCII for 0x00-0x7f; some chars (JISX0208 0x2140 and JISX0212 0x2237) are different from Unicode 1.1 to avoid conflict. -.IP -.TP -"open-19970715-0201" ("open-0201" for convenience) or" jisx0221-1995" for JISX0221-JISX0201 style. JIS X 0221 is JIS version of Unicode, but a few chars (0x5c, 0x7e, 0x2140, 0x216f, 0x2131) are different from Unicode 1.1. This is used when 0x5c is treated as YEN SIGN. -.IP -.TP -"open-19970715-ascii" ("open-ascii" for convenience) for JISX0221-ASCII style. This is used when 0x5c is treated as REVERSE SOLIDUS. -.IP -.TP -"open-19970715-ms" ("open-ms" for convenience) or "cp932" for Microsoft Windows style. Windows Code Page 932. Some chars (0x2140, 0x2141, 0x2142, 0x215d, 0x2171, 0x2172) are different from Unicode 1.1. -.IP -.TP -"jdk1.1.7" for Sun's JDK style. Same as Unicode 1.1, except that JIS 0x2140 is mapped to UFF3C. Either ASCII or JISX0201 can be used for 0x00-0x7f. -.IP -.PP -In addition, the extensions "nec-vdc", "ibm-vdc" and "udc" are supported. -.PP -For example, if you want to use Unicode style conversion but with NEC's extension, set \fCUNICODEMAP_JP\fR to \fCunicode-0.9, nec-vdc\fR. (You will probably need to quote that in a shell command.) -.PP -Most of the code here was written by Serika Kurusugawa, a.k.a. Junji Takagi, and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for that code: -.PP -Copyright (C) 1999 Serika Kurusugawa. All rights reserved. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
                                    -.TP -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.TP -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS". ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.PP -See also Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "const char * QJisCodec::mimeName () const\fC [virtual]\fR" -Returns the codec's mime name. -.PP -Reimplemented from QTextCodec. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqjiscodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qjiscodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qkbddriverfactory.3qt b/doc/man/man3/qkbddriverfactory.3qt deleted file mode 100644 index 9fa5e2658..000000000 --- a/doc/man/man3/qkbddriverfactory.3qt +++ /dev/null @@ -1,59 +0,0 @@ -'\" t -.TH QKbdDriverFactory 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 -QKbdDriverFactory \- Creates QWSKeyboardHandler objects for Qt/Embedded -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Static Public Members" -
                                  1. QStringList \fBkeys\fR ()
                                  2. QWSKeyboardHandler * \fBcreate\fR ( const QString & key, const QString & device ) -.SH DESCRIPTION -The QKbdDriverFactory class creates QWSKeyboardHandler objects for Qt/Embedded. -.PP -The graphics driver factory creates a QWSKeyboardHandler object for a given key with QKbdDriverFactory::create(key). -.PP -The drivers are either built-in or dynamically loaded from a driver plugin (see QKbdDriverPlugin). -.PP -This class is only available in Qt/Embedded. -.PP -QKbdDriverFactory::keys() returns a list of valid keys. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSKeyboardHandler * QKbdDriverFactory::create ( const QString & key, const QString & device )\fC [static]\fR" -Creates a QWSKeyboardHandler object that matches \fIkey\fR for device \fIdevice\fR. This is either a built-in driver, or a driver from a driver plugin. -.PP -See also keys(). -.SH "QStringList QKbdDriverFactory::keys ()\fC [static]\fR" -Returns the list of keys this factory can create drivers for. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qkbddriverfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qkbddriverfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qkbddriverplugin.3qt b/doc/man/man3/qkbddriverplugin.3qt deleted file mode 100644 index 05d942bdf..000000000 --- a/doc/man/man3/qkbddriverplugin.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QKbdDriverPlugin 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 -QKbdDriverPlugin \- Abstract base for Qt/Embedded keyboard driver plugins -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQKbdDriverPlugin\fR ()" -.br -.ti -1c -.BI "\fB~QKbdDriverPlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBkeys\fR () const = 0" -.br -.ti -1c -.BI "virtual QWSKeyboardHandler * \fBcreate\fR ( const QString & driver, const QString & device ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QKbdDriverPlugin class provides an abstract base for Qt/Embedded keyboard driver plugins. -.PP -The keyboard driver plugin is a simple plugin interface that makes it easy to create custom keyboard drivers. -.PP -Writing a keyboard driver plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Plugins documentation for details. -.PP -This class is only available in Qt/Embedded. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QKbdDriverPlugin::QKbdDriverPlugin ()" -Constructs a keyboard driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. -.SH "QKbdDriverPlugin::~QKbdDriverPlugin ()" -Destroys the keyboard driver plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "QWSKeyboardHandler * QKbdDriverPlugin::create ( const QString & driver, const QString & device )\fC [pure virtual]\fR" -Creates a driver matching the type specified by \fIdriver\fR and \fIdevice\fR. -.PP -See also keys(). -.SH "QStringList QKbdDriverPlugin::keys () const\fC [pure virtual]\fR" -Returns the list of keyboard drivers this plugin supports. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qkbddriverplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qkbddriverplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qkeyevent.3qt b/doc/man/man3/qkeyevent.3qt deleted file mode 100644 index c2df3179b..000000000 --- a/doc/man/man3/qkeyevent.3qt +++ /dev/null @@ -1,155 +0,0 @@ -'\" t -.TH QKeyEvent 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 -QKeyEvent \- Describes a key event -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQKeyEvent\fR ( Type type, int key, int ascii, int state, const QString & text = QString::null, bool autorep = FALSE, ushort count = 1 )" -.br -.ti -1c -.BI "int \fBkey\fR () const" -.br -.ti -1c -.BI "int \fBascii\fR () const" -.br -.ti -1c -.BI "ButtonState \fBstate\fR () const" -.br -.ti -1c -.BI "ButtonState \fBstateAfter\fR () const" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "bool \fBisAutoRepeat\fR () const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QKeyEvent class contains describes a key event. -.PP -Key events occur when a key is pressed or released when a widget has keyboard input focus. -.PP -A key event contains a special accept flag that indicates whether the receiver wants the key event. You should call QKeyEvent::ignore() if the key press or release event is not handled by your widget. A key event is propagated up the parent widget chain until a widget accepts it with QKeyEvent::accept() or an event filter consumes it. Key events for multi media keys are ignored by default. You should call QKeyEvent::accept() if your widget handles those events. -.PP -The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget. -.PP -The event handlers QWidget::keyPressEvent() and QWidget::keyReleaseEvent() receive key events. -.PP -See also QFocusEvent, QWidget::grabKeyboard(), and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QKeyEvent::QKeyEvent ( Type type, int key, int ascii, int state, const QString & text = QString::null, bool autorep = FALSE, ushort count = 1 )" -Constructs a key event object. -.PP -The \fItype\fR parameter must be QEvent::KeyPress or QEvent::KeyRelease. If \fIkey\fR is 0 the event is not a result of a known key (e.g. it may be the result of a compose sequence or keyboard macro). \fIascii\fR is the ASCII code of the key that was pressed or released. \fIstate\fR holds the keyboard modifiers. \fItext\fR is the Unicode text that the key generated. If \fIautorep\fR is TRUE, isAutoRepeat() will be TRUE. \fIcount\fR is the number of single keys. -.PP -The accept flag is set to TRUE. -.SH "void QKeyEvent::accept ()" -Sets the accept flag of the key event object. -.PP -Setting the accept parameter indicates that the receiver of the event wants the key event. Unwanted key events are sent to the parent widget. -.PP -The accept flag is set by default. -.PP -See also ignore(). -.SH "int QKeyEvent::ascii () const" -Returns the ASCII code of the key that was pressed or released. We recommend using text() instead. -.PP -See also text(). -.PP -Example: picture/picture.cpp. -.SH "int QKeyEvent::count () const" -Returns the number of single keys for this event. If text() is not empty, this is simply the length of the string. -.PP -See also QWidget::setKeyCompression(). -.SH "void QKeyEvent::ignore ()" -Clears the accept flag parameter of the key event object. -.PP -Clearing the accept parameter indicates that the event receiver does not want the key event. Unwanted key events are sent to the parent widget. -.PP -The accept flag is set by default. -.PP -See also accept(). -.SH "bool QKeyEvent::isAccepted () const" -Returns TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE -.SH "bool QKeyEvent::isAutoRepeat () const" -Returns TRUE if this event comes from an auto-repeating key and FALSE if it comes from an initial key press. -.PP -Note that if the event is a multiple-key compressed event that is partly due to auto-repeat, this function could return either TRUE or FALSE indeterminately. -.SH "int QKeyEvent::key () const" -Returns the code of the key that was pressed or released. -.PP -See Qt::Key for the list of keyboard codes. These codes are independent of the underlying window system. -.PP -A value of either 0 or Key_unknown means that the event is not the result of a known key (e.g. it may be the result of a compose sequence or a keyboard macro, or due to key event compression). -.PP -See also QWidget::setKeyCompression(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "ButtonState QKeyEvent::state () const" -Returns the keyboard modifier flags that existed immediately before the event occurred. -.PP -The returned value is ShiftButton, ControlButton, AltButton and MetaButton OR'ed together. -.PP -See also stateAfter(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "ButtonState QKeyEvent::stateAfter () const" -Returns the keyboard modifier flags that existed immediately after the event occurred. -.PP -\fBWarning:\fR This function cannot be trusted. -.PP -See also state(). -.SH "QString QKeyEvent::text () const" -Returns the Unicode text that this key generated. The text returned migth be empty, which is the case when pressing or releasing modifying keys as Shift, Control, Alt and Meta. In these cases key() will contain a valid value. -.PP -See also QWidget::setKeyCompression(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qkeyevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qkeyevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qkeysequence.3qt b/doc/man/man3/qkeysequence.3qt deleted file mode 100644 index 45a7e9b15..000000000 --- a/doc/man/man3/qkeysequence.3qt +++ /dev/null @@ -1,169 +0,0 @@ -'\" t -.TH QKeySequence 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 -QKeySequence \- Encapsulates a key sequence as used by accelerators -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQKeySequence\fR ()" -.br -.ti -1c -.BI "\fBQKeySequence\fR ( const QString & key )" -.br -.ti -1c -.BI "\fBQKeySequence\fR ( int key )" -.br -.ti -1c -.BI "\fBQKeySequence\fR ( int k1, int k2, int k3 = 0, int k4 = 0 )" -.br -.ti -1c -.BI "\fBQKeySequence\fR ( const QKeySequence & keysequence )" -.br -.ti -1c -.BI "\fB~QKeySequence\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "Qt::SequenceMatch \fBmatches\fR ( const QKeySequence & seq ) const" -.br -.ti -1c -.BI "\fBoperator QString\fR () const" -.br -.ti -1c -.BI "operator int () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBoperator[]\fR ( uint index ) const" -.br -.ti -1c -.BI "QKeySequence & \fBoperator=\fR ( const QKeySequence & keysequence )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QKeySequence & keysequence ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QKeySequence & keysequence ) const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QKeySequence & keysequence )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QKeySequence & keysequence )" -.br -.in -1c -.SH DESCRIPTION -The QKeySequence class encapsulates a key sequence as used by accelerators. -.PP -A key sequence consists of up to four keyboard codes, each optionally combined with modifiers, e.g. SHIFT, CTRL, ALT, META, or UNICODE_ACCEL. For example, \fCCTRL + Key_P\fR might be a sequence used as a shortcut for printing a document. The key codes are listed in ntqnamespace.h. As an alternative, use UNICODE_ACCEL with the unicode code point of the character. For example, \fCUNICODE_ACCEL + 'A'\fR gives the same key sequence as Key_A. -.PP -Key sequences can be constructed either from an integer key code, or from a human readable translatable string such as" Ctrl+X,Alt+Space". A key sequence can be cast to a QString to obtain a human readable translated version of the sequence. Translations are done in the "QAccel" context. -.PP -See also QAccel and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QKeySequence::QKeySequence ()" -Constructs an empty key sequence. -.SH "QKeySequence::QKeySequence ( const QString & key )" -Creates a key sequence from the string \fIkey\fR. For example" Ctrl+O" gives CTRL+UNICODE_ACCEL+'O'. The strings "Ctrl"," Shift", "Alt" and "Meta" are recognized, as well as their translated equivalents in the "QAccel" context (using QObject::tr()). -.PP -Multiple key codes (up to four) may be entered by separating them with commas, e.g. "Alt+X,Ctrl+S,Q". -.PP -This contructor is typically used with tr(), so that accelerator keys can be replaced in translations: -.PP -.nf -.br - QPopupMenu *file = new QPopupMenu( this ); -.br - file->insertItem( tr("&Open..."), this, SLOT(open()), -.br - QKeySequence( tr("Ctrl+O", "File|Open") ) ); -.br -.fi -.PP -Note the \fC"File|Open"\fR translator comment. It is by no means necessary, but it provides some context for the human translator. -.SH "QKeySequence::QKeySequence ( int key )" -Constructs a key sequence that has a single \fIkey\fR. -.PP -The key codes are listed in ntqnamespace.h and can be combined with modifiers, e.g. with SHIFT, CTRL, ALT, META or UNICODE_ACCEL. -.SH "QKeySequence::QKeySequence ( int k1, int k2, int k3 = 0, int k4 = 0 )" -Constructs a key sequence with up to 4 keys \fIk1\fR, \fIk2\fR, \fIk3\fR and \fIk4\fR. -.PP -The key codes are listed in ntqnamespace.h and can be combined with modifiers, e.g. with SHIFT, CTRL, ALT, META or UNICODE_ACCEL. -.SH "QKeySequence::QKeySequence ( const QKeySequence & keysequence )" -Copy constructor. Makes a copy of \fIkeysequence\fR. -.SH "QKeySequence::~QKeySequence ()" -Destroys the key sequence. -.SH "uint QKeySequence::count () const" -Returns the number of keys in the key sequence. The maximum is 4. -.SH "bool QKeySequence::isEmpty () const" -Returns TRUE if the key sequence is empty; otherwise returns FALSE. -.SH "Qt::SequenceMatch QKeySequence::matches ( const QKeySequence & seq ) const" -Matches the sequence with \fIseq\fR. Returns Qt::Identical if successful, Qt::PartialMatch for matching but incomplete \fIseq\fR, and Qt::NoMatch if the sequences have nothing in common. Returns Qt::NoMatch if \fIseq\fR is shorter. -.SH "QKeySequence::operator QString () const" -Creates an accelerator string for the key sequence. For instance CTRL+Key_O gives "Ctrl+O". If the key sequence has multiple key codes they are returned comma-separated, e.g." Alt+X, Ctrl+Y, Z". The strings, "Ctrl", "Shift", etc. are translated (using QObject::tr()) in the "QAccel" scope. If the key sequence has no keys, QString::null is returned. -.PP -On Mac OS X, the string returned resembles the sequence that is shown in the menubar. -.SH "QKeySequence::operator int () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -For backward compatibility: returns the first keycode as integer. If the key sequence is empty, 0 is returned. -.SH "bool QKeySequence::operator!= ( const QKeySequence & keysequence ) const" -Returns TRUE if \fIkeysequence\fR is not equal to this key sequence; otherwise returns FALSE. -.SH "QKeySequence & QKeySequence::operator= ( const QKeySequence & keysequence )" -Assignment operator. Assigns \fIkeysequence\fR to this object. -.SH "bool QKeySequence::operator== ( const QKeySequence & keysequence ) const" -Returns TRUE if \fIkeysequence\fR is equal to this key sequence; otherwise returns FALSE. -.SH "int QKeySequence::operator[] ( uint index ) const" -Returns a reference to the element at position \fIindex\fR in the key sequence. This can only be used to read an element. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QKeySequence & keysequence )" -Writes the key sequence \fIkeysequence\fR to the stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QKeySequence & keysequence )" -Reads a key sequence from the stream \fIs\fR into the key sequence \fIkeysequence\fR. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqkeysequence.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qkeysequence.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlabel.3qt b/doc/man/man3/qlabel.3qt deleted file mode 100644 index 9f7e44ee2..000000000 --- a/doc/man/man3/qlabel.3qt +++ /dev/null @@ -1,435 +0,0 @@ -'\" t -.TH QLabel 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 -QLabel \- Text or image display -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQLabel\fR ( QWidget * parent, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQLabel\fR ( const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQLabel\fR ( QWidget * buddy, const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QLabel\fR ()" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "QPicture * \fBpicture\fR () const" -.br -.ti -1c -.BI "QMovie * \fBmovie\fR () const" -.br -.ti -1c -.BI "TextFormat \fBtextFormat\fR () const" -.br -.ti -1c -.BI "void \fBsetTextFormat\fR ( TextFormat )" -.br -.ti -1c -.BI "int \fBalignment\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAlignment\fR ( int )" -.br -.ti -1c -.BI "int \fBindent\fR () const" -.br -.ti -1c -.BI "void \fBsetIndent\fR ( int )" -.br -.ti -1c -.BI "bool autoResize () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void setAutoResize ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBhasScaledContents\fR () const" -.br -.ti -1c -.BI "void \fBsetScaledContents\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetBuddy\fR ( QWidget * buddy )" -.br -.ti -1c -.BI "QWidget * \fBbuddy\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFont\fR ( const QFont & f )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" -.br -.ti -1c -.BI "virtual void \fBsetPicture\fR ( const QPicture & picture )" -.br -.ti -1c -.BI "virtual void \fBsetMovie\fR ( const QMovie & movie )" -.br -.ti -1c -.BI "virtual void \fBsetNum\fR ( int num )" -.br -.ti -1c -.BI "virtual void \fBsetNum\fR ( double num )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "Alignment \fBalignment\fR - the alignment of the label's contents" -.br -.ti -1c -.BI "BackgroundMode \fBbackgroundMode\fR - the label's background mode \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBindent\fR - the label's text indent in pixels" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR - the label's pixmap" -.br -.ti -1c -.BI "bool \fBscaledContents\fR - whether the label will scale its contents to fill all available space" -.br -.ti -1c -.BI "QString \fBtext\fR - the label's text" -.br -.ti -1c -.BI "TextFormat \fBtextFormat\fR - the label's text format" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * p )" -.br -.in -1c -.SH DESCRIPTION -The QLabel widget provides a text or image display. -.PP -QLabel is used for displaying text or an image. No user interaction functionality is provided. The visual appearance of the label can be configured in various ways, and it can be used for specifying a focus accelerator key for another widget. -.PP -A QLabel can contain any of the following content types:
                                    .nf -.TS -l - l. Content Setting Plain text Pass a QString to setText(). Rich text Pass a QString that contains rich text to setText(). A pixmap Pass a QPixmap to setPixmap(). A movie Pass a QMovie to setMovie(). A number Pass an \fIint\fR or a \fIdouble\fR to setNum(), which converts the number to plain text. Nothing -.TE -.fi -
                                    -.PP -When the content is changed using any of these functions, any previous content is cleared. -.PP -The look of a QLabel can be tuned in several ways. All the settings of QFrame are available for specifying a widget frame. The positioning of the content within the QLabel widget area can be tuned with setAlignment() and setIndent(). For example, this code sets up a sunken panel with a two-line text in the bottom right corner (both lines being flush with the right side of the label): -.PP -.nf -.br - QLabel *label = new QLabel( this ); -.br - label->setFrameStyle( QFrame::Panel | QFrame::Sunken ); -.br - label->setText( "first line\\nsecond line" ); -.br - label->setAlignment( AlignBottom | AlignRight ); -.br -.fi -.PP -A QLabel is often used as a label for an interactive widget. For this use QLabel provides a useful mechanism for adding an accelerator key (see QAccel) that will set the keyboard focus to the other widget (called the QLabel's "buddy"). For example: -.PP -.nf -.br - QLineEdit* phoneEdit = new QLineEdit( this, "phoneEdit" ); -.br - QLabel* phoneLabel = new QLabel( phoneEdit, "&Phone:", this, "phoneLabel" ); -.br -.fi -.PP -In this example, keyboard focus is transferred to the label's buddy (the QLineEdit) when the user presses Alt+P. You can also use the setBuddy() function to accomplish the same thing. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QLineEdit, QTextEdit, QPixmap, QMovie, GUI Design Handbook: Label, Basic Widgets, and Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLabel::QLabel ( QWidget * parent, const char * name = 0, WFlags f = 0 )" -Constructs an empty label. -.PP -The \fIparent\fR, \fIname\fR and widget flag \fIf\fR, arguments are passed to the QFrame constructor. -.PP -See also alignment, setFrameStyle(), and indent. -.SH "QLabel::QLabel ( const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" -Constructs a label that displays the text, \fItext\fR. -.PP -The \fIparent\fR, \fIname\fR and widget flag \fIf\fR, arguments are passed to the QFrame constructor. -.PP -See also text, alignment, setFrameStyle(), and indent. -.SH "QLabel::QLabel ( QWidget * buddy, const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" -Constructs a label that displays the text \fItext\fR. The label has a buddy widget, \fIbuddy\fR. -.PP -If the \fItext\fR contains an underlined letter (a letter preceded by an ampersand, &), and the text is in plain text format, when the user presses Alt+ the underlined letter, focus is passed to the buddy widget. -.PP -The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QFrame constructor. -.PP -See also text, setBuddy(), alignment, setFrameStyle(), and indent. -.SH "QLabel::~QLabel ()" -Destroys the label. -.SH "int QLabel::alignment () const" -Returns the alignment of the label's contents. See the "alignment" property for details. -.SH "bool QLabel::autoResize () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if auto-resizing is enabled, or FALSE if auto-resizing is disabled. -.PP -Auto-resizing is disabled by default. -.PP -See also setAutoResize(). -.SH "QWidget * QLabel::buddy () const" -Returns this label's buddy, or 0 if no buddy is currently set. -.PP -See also setBuddy(). -.SH "void QLabel::clear ()\fC [slot]\fR" -Clears any label contents. Equivalent to setText( "" ). -.SH "void QLabel::drawContents ( QPainter * p )\fC [virtual protected]\fR" -Draws the label contents using the painter \fIp\fR. -.PP -Reimplemented from QFrame. -.SH "bool QLabel::hasScaledContents () const" -Returns TRUE if the label will scale its contents to fill all available space; otherwise returns FALSE. See the "scaledContents" property for details. -.SH "int QLabel::indent () const" -Returns the label's text indent in pixels. See the "indent" property for details. -.SH "QMovie * QLabel::movie () const" -Returns a pointer to the label's movie, or 0 if no movie has been set. -.PP -See also setMovie(). -.SH "QPicture * QLabel::picture () const" -Returns the label's picture or 0 if the label doesn't have a picture. -.SH "QPixmap * QLabel::pixmap () const" -Returns the label's pixmap. See the "pixmap" property for details. -.SH "void QLabel::setAlignment ( int )\fC [virtual]\fR" -Sets the alignment of the label's contents. See the "alignment" property for details. -.SH "void QLabel::setAutoResize ( bool enable )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Enables auto-resizing if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. -.PP -When auto-resizing is enabled the label will resize itself to fit the contents whenever the contents change. The top-left corner is not moved. This is useful for QLabel widgets that are not managed by a QLayout (e.g., top-level widgets). -.PP -Auto-resizing is disabled by default. -.PP -See also autoResize(), adjustSize(), and sizeHint. -.SH "void QLabel::setBuddy ( QWidget * buddy )\fC [virtual]\fR" -Sets this label's buddy to \fIbuddy\fR. -.PP -When the user presses the accelerator key indicated by this label, the keyboard focus is transferred to the label's buddy widget. -.PP -The buddy mechanism is only available for QLabels that contain plain text in which one letter is prefixed with an ampersand, &. This letter is set as the accelerator key. The letter is displayed underlined, and the '&' is not displayed (i.e. the ShowPrefix alignment flag is turned on; see setAlignment()). -.PP -In a dialog, you might create two data entry widgets and a label for each, and set up the geometry layout so each label is just to the left of its data entry widget (its "buddy"), for example: -.PP -.nf -.br - QLineEdit *nameEd = new QLineEdit( this ); -.br - QLabel *nameLb = new QLabel( "&Name:", this ); -.br - nameLb->setBuddy( nameEd ); -.br - QLineEdit *phoneEd = new QLineEdit( this ); -.br - QLabel *phoneLb = new QLabel( "&Phone:", this ); -.br - phoneLb->setBuddy( phoneEd ); -.br - // ( layout setup not shown ) -.br -.fi -.PP -With the code above, the focus jumps to the Name field when the user presses Alt+N, and to the Phone field when the user presses Alt+P. -.PP -To unset a previously set buddy, call this function with \fIbuddy\fR set to 0. -.PP -See also buddy(), text, QAccel, and alignment. -.PP -Examples: -.)l addressbook/centralwidget.cpp, chart/optionsform.cpp, and regexptester/regexptester.cpp. -.SH "void QLabel::setFont ( const QFont & f )\fC [virtual]\fR" -Sets the font used on the QLabel to font \fIf\fR. -.PP -Example: menu/menu.cpp. -.PP -Reimplemented from QWidget. -.SH "void QLabel::setIndent ( int )" -Sets the label's text indent in pixels. See the "indent" property for details. -.SH "void QLabel::setMovie ( const QMovie & movie )\fC [virtual slot]\fR" -Sets the label contents to \fImovie\fR. Any previous content is cleared. -.PP -The buddy accelerator, if any, is disabled. -.PP -The label resizes itself if auto-resizing is enabled. -.PP -See also movie() and setBuddy(). -.SH "void QLabel::setNum ( int num )\fC [virtual slot]\fR" -Sets the label contents to plain text containing the textual representation of integer \fInum\fR. Any previous content is cleared. Does nothing if the integer's string representation is the same as the current contents of the label. -.PP -The buddy accelerator, if any, is disabled. -.PP -The label resizes itself if auto-resizing is enabled. -.PP -See also text, QString::setNum(), and setBuddy(). -.SH "void QLabel::setNum ( double num )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the label contents to plain text containing the textual representation of double \fInum\fR. Any previous content is cleared. Does nothing if the double's string representation is the same as the current contents of the label. -.PP -The buddy accelerator, if any, is disabled. -.PP -The label resizes itself if auto-resizing is enabled. -.PP -See also text, QString::setNum(), and setBuddy(). -.SH "void QLabel::setPicture ( const QPicture & picture )\fC [virtual slot]\fR" -Sets the label contents to \fIpicture\fR. Any previous content is cleared. -.PP -The buddy accelerator, if any, is disabled. -.PP -See also picture() and setBuddy(). -.SH "void QLabel::setPixmap ( const QPixmap & )\fC [virtual slot]\fR" -Sets the label's pixmap. See the "pixmap" property for details. -.SH "void QLabel::setScaledContents ( bool )" -Sets whether the label will scale its contents to fill all available space. See the "scaledContents" property for details. -.SH "void QLabel::setText ( const QString & )\fC [virtual slot]\fR" -Sets the label's text. See the "text" property for details. -.SH "void QLabel::setTextFormat ( TextFormat )" -Sets the label's text format. See the "textFormat" property for details. -.SH "QString QLabel::text () const" -Returns the label's text. See the "text" property for details. -.SH "TextFormat QLabel::textFormat () const" -Returns the label's text format. See the "textFormat" property for details. -.SS "Property Documentation" -.SH "Alignment alignment" -This property holds the alignment of the label's contents. -.PP -The alignment is a bitwise OR of Qt::AlignmentFlags and Qt::TextFlags values. The ExpandTabs, SingleLine and ShowPrefix flags apply only if the label contains plain text; otherwise they are ignored. The DontClip flag is always ignored. WordBreak applies to both rich text and plain text labels. The BreakAnywhere flag is not supported in QLabel. -.PP -If the label has a buddy, the ShowPrefix flag is forced to TRUE. -.PP -The default alignment is \fCAlignAuto | AlignVCenter | ExpandTabs\fR if the label doesn't have a buddy and \fCAlignAuto | AlignVCenter | ExpandTabs | ShowPrefix\fR if the label has a buddy. If the label contains rich text, additionally WordBreak is turned on. -.PP -See also Qt::AlignmentFlags, setBuddy(), and text. -.PP -Set this property's value with setAlignment() and get this property's value with alignment(). -.SH "BackgroundMode backgroundMode" -This property holds the label's background mode. -.PP -Get this property with backgroundMode(). -.PP -See also QWidget::backgroundMode. -.SH "int indent" -This property holds the label's text indent in pixels. -.PP -If a label displays text, the indent applies to the left edge if alignment() is AlignLeft, to the right edge if alignment() is AlignRight, to the top edge if alignment() is AlignTop, and to to the bottom edge if alignment() is AlignBottom. -.PP -If indent is negative, or if no indent has been set, the label computes the effective indent as follows: If frameWidth() is 0, the effective indent becomes 0. If frameWidth() is greater than 0, the effective indent becomes half the width of the "x" character of the widget's current font(). -.PP -See also alignment, frameWidth, and font. -.PP -Set this property's value with setIndent() and get this property's value with indent(). -.SH "QPixmap pixmap" -This property holds the label's pixmap. -.PP -If no pixmap has been set this will return an invalid pixmap. -.PP -Setting the pixmap clears any previous content, and resizes the label if QLabel::autoResize() is TRUE. The buddy accelerator, if any, is disabled. -.PP -Set this property's value with setPixmap() and get this property's value with pixmap(). -.SH "bool scaledContents" -This property holds whether the label will scale its contents to fill all available space. -.PP -When enabled and the label shows a pixmap, it will scale the pixmap to fill the available space. -.PP -This property's default is FALSE. -.PP -See also scaledContents. -.PP -Set this property's value with setScaledContents() and get this property's value with hasScaledContents(). -.SH "QString text" -This property holds the label's text. -.PP -If no text has been set this will return an empty string. Setting the text clears any previous content, unless they are the same. -.PP -The text will be interpreted either as a plain text or as a rich text, depending on the text format setting; see setTextFormat(). The default setting is AutoText, i.e. QLabel will try to auto-detect the format of the text set. -.PP -If the text is interpreted as a plain text and a buddy has been set, the buddy accelerator key is updated from the new text. -.PP -The label resizes itself if auto-resizing is enabled. -.PP -Note that Qlabel is well-suited to display small rich text documents, i.e. those small documents that get their document specific settings (font, text color, link color) from the label's palette and font properties. For large documents, use QTextEdit in read-only mode instead. QTextEdit will flicker less on resize and can also provide a scrollbar when necessary. -.PP -See also textFormat, setBuddy(), and alignment. -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "TextFormat textFormat" -This property holds the label's text format. -.PP -See the Qt::TextFormat enum for an explanation of the possible options. -.PP -The default format is AutoText. -.PP -See also text. -.PP -Set this property's value with setTextFormat() and get this property's value with textFormat(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlabel.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlabel.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlayout.3qt b/doc/man/man3/qlayout.3qt deleted file mode 100644 index 1ab66d555..000000000 --- a/doc/man/man3/qlayout.3qt +++ /dev/null @@ -1,408 +0,0 @@ -'\" t -.TH QLayout 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 -QLayout \- The base class of geometry managers -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject and QLayoutItem. -.PP -Inherited by QGridLayout and QBoxLayout. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBResizeMode\fR { FreeResize, Minimum, Fixed, Auto }" -.br -.ti -1c -.BI "\fBQLayout\fR ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQLayout\fR ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQLayout\fR ( int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "int \fBmargin\fR () const" -.br -.ti -1c -.BI "int \fBspacing\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMargin\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBsetSpacing\fR ( int )" -.br -.ti -1c -.BI "void \fBsetResizeMode\fR ( ResizeMode )" -.br -.ti -1c -.BI "ResizeMode \fBresizeMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMenuBar\fR ( QMenuBar * w )" -.br -.ti -1c -.BI "QMenuBar * \fBmenuBar\fR () const" -.br -.ti -1c -.BI "QWidget * \fBmainWidget\fR ()" -.br -.ti -1c -.BI "bool \fBisTopLevel\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoAdd\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBautoAdd\fR () const" -.br -.ti -1c -.BI "virtual void \fBinvalidate\fR ()" -.br -.ti -1c -.BI "bool \fBactivate\fR ()" -.br -.ti -1c -.BI "void \fBadd\fR ( QWidget * w )" -.br -.ti -1c -.BI "virtual void \fBaddItem\fR ( QLayoutItem * item ) = 0" -.br -.ti -1c -.BI "void \fBremove\fR ( QWidget * widget )" -.br -.ti -1c -.BI "void \fBremoveItem\fR ( QLayoutItem * item )" -.br -.ti -1c -.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBminimumSize\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBmaximumSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( const QRect & r ) = 0" -.br -.ti -1c -.BI "virtual QLayoutIterator \fBiterator\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBsupportsMargin\fR () const" -.br -.ti -1c -.BI "void \fBsetEnabled\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBmargin\fR - the width of the outside border of the layout" -.br -.ti -1c -.BI "ResizeMode \fBresizeMode\fR - the resize mode of the layout" -.br -.ti -1c -.BI "int \fBspacing\fR - the spacing between widgets inside the layout" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBaddChildLayout\fR ( QLayout * l )" -.br -.ti -1c -.BI "void \fBdeleteAllItems\fR ()" -.br -.ti -1c -.BI "void \fBsetSupportsMargin\fR ( bool b )" -.br -.ti -1c -.BI "QRect \fBalignmentRect\fR ( const QRect & r ) const" -.br -.in -1c -.SH DESCRIPTION -The QLayout class is the base class of geometry managers. -.PP -This is an abstract base class inherited by the concrete classes, QBoxLayout and QGridLayout. -.PP -For users of QLayout subclasses or of QMainWindow there is seldom any need to use the basic functions provided by QLayout, such as setResizeMode() or setMenuBar(). See the layout overview page for more information. -.PP -To make your own layout manager, subclass QGLayoutIterator and implement the functions addItem(), sizeHint(), setGeometry(), and iterator(). You should also implement minimumSize() to ensure your layout isn't resized to zero size if there is too little space. To support children whose heights depend on their widths, implement hasHeightForWidth() and heightForWidth(). See the custom layout page for an in-depth description. -.PP -Geometry management stops when the layout manager is deleted. -.PP -See also Widget Appearance and Style and Layout Management. -.SS "Member Type Documentation" -.SH "QLayout::ResizeMode" -The possible values are: -.TP -\fCQLayout::Auto\fR - If the main widget is a top-level widget with no height-for-width (hasHeightForWidth()), this is the same as \fCMinimium\fR; otherwise, this is the same as FreeResize. -.TP -\fCQLayout::Fixed\fR - The main widget's size is set to sizeHint(); it cannot be resized at all. -.TP -\fCQLayout::Minimum\fR - The main widget's minimum size is set to minimumSize(); it cannot be smaller. -.TP -\fCQLayout::FreeResize\fR - The widget is not constrained. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLayout::QLayout ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" -Constructs a new top-level QLayout called \fIname\fR, with main widget \fIparent\fR. \fIparent\fR may not be 0. -.PP -The \fImargin\fR is the number of pixels between the edge of the widget and the managed children. The \fIspacing\fR sets the value of spacing(), which gives the spacing between the managed widgets. If \fIspacing\fR is -1 (the default), spacing is set to the value of \fImargin\fR. -.PP -There can be only one top-level layout for a widget. It is returned by QWidget::layout() -.SH "QLayout::QLayout ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" -Constructs a new child QLayout called \fIname\fR, and places it inside \fIparentLayout\fR by using the default placement defined by addItem(). -.PP -If \fIspacing\fR is -1, this QLayout inherits \fIparentLayout\fR's spacing(), otherwise the value of \fIspacing\fR is used. -.SH "QLayout::QLayout ( int spacing = -1, const char * name = 0 )" -Constructs a new child QLayout called \fIname\fR. If \fIspacing\fR is -1, this QLayout inherits its parent's spacing(); otherwise the value of \fIspacing\fR is used. -.PP -This layout has to be inserted into another layout before geometry management will work. -.SH "bool QLayout::activate ()" -Redoes the layout for mainWidget(). You should generally not need to call this because it is automatically called at the most appropriate times. -.PP -However, if you set up a QLayout for a visible widget without resizing that widget, you will need to call this function in order to lay it out. -.PP -See also QWidget::updateGeometry(). -.PP -Examples: -.)l layout/layout.cpp, popup/popup.cpp, scrollview/scrollview.cpp, and sql/overview/form1/main.cpp. -.SH "void QLayout::add ( QWidget * w )" -Adds widget \fIw\fR to this layout in a manner specific to the layout. This function uses addItem(). -.PP -Examples: -.)l customlayout/border.cpp and customlayout/main.cpp. -.SH "void QLayout::addChildLayout ( QLayout * l )\fC [protected]\fR" -This function is called from addLayout() functions in subclasses to add layout \fIl\fR as a sub-layout. -.SH "void QLayout::addItem ( QLayoutItem * item )\fC [pure virtual]\fR" -Implemented in subclasses to add an \fIitem\fR. How it is added is specific to each subclass. -.PP -The ownership of \fIitem\fR is transferred to the layout, and it's the layout's responsibility to delete it. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "QRect QLayout::alignmentRect ( const QRect & r ) const\fC [protected]\fR" -Returns the rectangle that should be covered when the geometry of this layout is set to \fIr\fR, provided that this layout supports setAlignment(). -.PP -The result is derived from sizeHint() and expanding(). It is never larger than \fIr\fR. -.SH "bool QLayout::autoAdd () const" -Returns TRUE if this layout automatically grabs all new mainWidget()'s new children and adds them as defined by addItem(); otherwise returns FALSE. This has effect only for top-level layouts, i.e. layouts that are direct children of their mainWidget(). -.PP -autoAdd() is disabled by default. -.PP -Note that a top-level layout is not necessarily associated with the top-level widget. -.PP -See also setAutoAdd(). -.SH "void QLayout::deleteAllItems ()\fC [protected]\fR" -Removes and deletes all items in this layout. -.SH "QSizePolicy::ExpandData QLayout::expanding () const\fC [virtual]\fR" -Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions. -.PP -The default implementation returns \fCBothDirections\fR. -.PP -Examples: -.)l customlayout/border.cpp and customlayout/flow.cpp. -.PP -Reimplemented from QLayoutItem. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "void QLayout::invalidate ()\fC [virtual]\fR" -Invalidates cached information. Reimplementations must call this. -.PP -Reimplemented from QLayoutItem. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "bool QLayout::isEmpty () const\fC [virtual]\fR" -Returns TRUE if this layout is empty. The default implementation returns FALSE. -.PP -Reimplemented from QLayoutItem. -.SH "bool QLayout::isEnabled () const" -Returns TRUE if the layout is enabled; otherwise returns FALSE. -.PP -See also setEnabled(). -.SH "bool QLayout::isTopLevel () const" -Returns TRUE if this layout is a top-level layout, i.e. not a child of another layout; otherwise returns FALSE. -.SH "QLayoutIterator QLayout::iterator ()\fC [pure virtual]\fR" -Implemented in subclasses to return an iterator that iterates over this layout's children. -.PP -A typical implementation will be: -.PP -.nf -.br - QLayoutIterator MyLayout::iterator() -.br - { -.br - QGLayoutIterator *i = new MyLayoutIterator( internal_data ); -.br - return QLayoutIterator( i ); -.br - } -.br -.fi -where MyLayoutIterator is a subclass of QGLayoutIterator. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.PP -Reimplemented from QLayoutItem. -.SH "QWidget * QLayout::mainWidget ()" -Returns the main widget (parent widget) of this layout, or 0 if this layout is a sub-layout that is not yet inserted. -.SH "int QLayout::margin () const" -Returns the width of the outside border of the layout. See the "margin" property for details. -.SH "QSize QLayout::maximumSize () const\fC [virtual]\fR" -Returns the maximum size of this layout. This is the largest size that the layout can have while still respecting the specifications. Does not include what's needed by margin() or menuBar(). -.PP -The default implementation allows unlimited resizing. -.PP -Reimplemented from QLayoutItem. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "QMenuBar * QLayout::menuBar () const" -Returns the menu bar set for this layout, or 0 if no menu bar is set. -.SH "QSize QLayout::minimumSize () const\fC [virtual]\fR" -Returns the minimum size of this layout. This is the smallest size that the layout can have while still respecting the specifications. Does not include what's needed by margin() or menuBar(). -.PP -The default implementation allows unlimited resizing. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.PP -Reimplemented from QLayoutItem. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "void QLayout::remove ( QWidget * widget )" -Removes the widget \fIwidget\fR from the layout. After this call, it is the caller's responsibility to give the widget a reasonable geometry or to put the widget back into a layout. -.PP -See also removeItem(), QWidget::geometry, and add(). -.SH "void QLayout::removeItem ( QLayoutItem * item )" -Removes the layout item \fIitem\fR from the layout. It is the caller's responsibility to delete the item. -.PP -Notice that \fIitem\fR can be a layout (since QLayout inherits QLayoutItem). -.PP -See also remove() and addItem(). -.SH "ResizeMode QLayout::resizeMode () const" -Returns the resize mode of the layout. See the "resizeMode" property for details. -.SH "void QLayout::setAutoAdd ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE, auto-add is enabled; otherwise auto-add is disabled. -.PP -\fBWarning:\fR If auto-add is enabled, you cannot set stretch factors on the child widgets until the widgets are actually inserted in the layout (after control returned to the event loop). We therefore recommend that you avoid the auto-add feature in new programs. -.PP -See also autoAdd(). -.PP -Examples: -.)l hierarchy/objects.cpp and i18n/main.cpp. -.SH "void QLayout::setEnabled ( bool enable )" -Enables this layout if \fIenable\fR is TRUE, otherwise disables it. -.PP -An enabled layout adjusts dynamically to changes; a disabled layout acts as if it did not exist. -.PP -By default all layouts are enabled. -.PP -See also isEnabled(). -.SH "void QLayout::setGeometry ( const QRect & r )\fC [pure virtual]\fR" -This function is reimplemented in subclasses to perform layout. -.PP -The default implementation maintains the geometry() information given by rect \fIr\fR. Reimplementors must call this function. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.PP -Reimplemented from QLayoutItem. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "void QLayout::setMargin ( int )\fC [virtual]\fR" -Sets the width of the outside border of the layout. See the "margin" property for details. -.SH "void QLayout::setMenuBar ( QMenuBar * w )\fC [virtual]\fR" -Makes the geometry manager take account of the menu bar \fIw\fR. All child widgets are placed below the bottom edge of the menu bar. -.PP -A menu bar does its own geometry management: never do addWidget() on a QMenuBar. -.PP -Examples: -.)l layout/layout.cpp and scrollview/scrollview.cpp. -.SH "void QLayout::setResizeMode ( ResizeMode )" -Sets the resize mode of the layout. See the "resizeMode" property for details. -.SH "void QLayout::setSpacing ( int )\fC [virtual]\fR" -Sets the spacing between widgets inside the layout. See the "spacing" property for details. -.SH "void QLayout::setSupportsMargin ( bool b )\fC [protected]\fR" -Sets the value returned by supportsMargin(). If \fIb\fR is TRUE, margin() handling is implemented by the subclass. If \fIb\fR is FALSE (the default), QLayout will add margin() around top-level layouts. -.PP -If \fIb\fR is TRUE, margin handling needs to be implemented in setGeometry(), maximumSize(), minimumSize(), sizeHint() and heightForWidth(). -.PP -See also supportsMargin(). -.SH "int QLayout::spacing () const" -Returns the spacing between widgets inside the layout. See the "spacing" property for details. -.SH "bool QLayout::supportsMargin () const" -Returns TRUE if this layout supports QLayout::margin on non-top-level layouts; otherwise returns FALSE. -.PP -See also margin. -.SS "Property Documentation" -.SH "int margin" -This property holds the width of the outside border of the layout. -.PP -For some layout classes this property has an effect only on top-level layouts; QBoxLayout and QGridLayout support margins for child layouts. The default value is 0. -.PP -See also spacing. -.PP -Set this property's value with setMargin() and get this property's value with margin(). -.SH "ResizeMode resizeMode" -This property holds the resize mode of the layout. -.PP -The default mode is Auto. -.PP -See also QLayout::ResizeMode. -.PP -Set this property's value with setResizeMode() and get this property's value with resizeMode(). -.SH "int spacing" -This property holds the spacing between widgets inside the layout. -.PP -The default value is -1, which signifies that the layout's spacing should not override the widget's spacing. -.PP -See also margin. -.PP -Set this property's value with setSpacing() and get this property's value with spacing(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlayout.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlayout.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlayoutitem.3qt b/doc/man/man3/qlayoutitem.3qt deleted file mode 100644 index 1e115a7e1..000000000 --- a/doc/man/man3/qlayoutitem.3qt +++ /dev/null @@ -1,226 +0,0 @@ -'\" t -.TH QLayoutItem 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 -QLayoutItem \- Abstract item that a QLayout manipulates -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QLayout, QSpacerItem, and QWidgetItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQLayoutItem\fR ( int alignment = 0 )" -.br -.ti -1c -.BI "virtual \fB~QLayoutItem\fR ()" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const = 0" -.br -.ti -1c -.BI "virtual QSize \fBminimumSize\fR () const = 0" -.br -.ti -1c -.BI "virtual QSize \fBmaximumSize\fR () const = 0" -.br -.ti -1c -.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const = 0" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( const QRect & r ) = 0" -.br -.ti -1c -.BI "virtual QRect \fBgeometry\fR () const = 0" -.br -.ti -1c -.BI "virtual bool \fBisEmpty\fR () const = 0" -.br -.ti -1c -.BI "virtual bool \fBhasHeightForWidth\fR () const" -.br -.ti -1c -.BI "virtual int \fBheightForWidth\fR ( int w ) const" -.br -.ti -1c -.BI "virtual void \fBinvalidate\fR ()" -.br -.ti -1c -.BI "virtual QWidget * \fBwidget\fR ()" -.br -.ti -1c -.BI "virtual QLayoutIterator \fBiterator\fR ()" -.br -.ti -1c -.BI "virtual QLayout * \fBlayout\fR ()" -.br -.ti -1c -.BI "virtual QSpacerItem * \fBspacerItem\fR ()" -.br -.ti -1c -.BI "int \fBalignment\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAlignment\fR ( int a )" -.br -.in -1c -.SH DESCRIPTION -The QLayoutItem class provides an abstract item that a QLayout manipulates. -.PP -This is used by custom layouts. -.PP -Pure virtual functions are provided to return information about the layout, including, sizeHint(), minimumSize(), maximumSize() and expanding(). -.PP -The layout's geometry can be set and retrieved with setGeometry() and geometry(), and its alignment with setAlignment() and alignment(). -.PP -isEmpty() returns whether the layout is empty. iterator() returns an iterator for the layout's children. If the concrete item is a QWidget, it can be retrieved using widget(). Similarly for layout() and spacerItem(). -.PP -See also QLayout, Widget Appearance and Style, and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLayoutItem::QLayoutItem ( int alignment = 0 )" -Constructs a layout item with an \fIalignment\fR that is a bitwise OR of the Qt::AlignmentFlags. Not all subclasses support alignment. -.SH "QLayoutItem::~QLayoutItem ()\fC [virtual]\fR" -Destroys the QLayoutItem. -.SH "int QLayoutItem::alignment () const" -Returns the alignment of this item. -.SH "QSizePolicy::ExpandData QLayoutItem::expanding () const\fC [pure virtual]\fR" -Implemented in subclasses to return the direction(s) this item" wants" to expand in (if any). -.PP -Reimplemented in QLayout, QSpacerItem, and QWidgetItem. -.SH "QRect QLayoutItem::geometry () const\fC [pure virtual]\fR" -Returns the rectangle covered by this layout item. -.PP -Example: customlayout/border.cpp. -.SH "bool QLayoutItem::hasHeightForWidth () const\fC [virtual]\fR" -Returns TRUE if this layout's preferred height depends on its width; otherwise returns FALSE. The default implementation returns FALSE. -.PP -Reimplement this function in layout managers that support height for width. -.PP -See also heightForWidth() and QWidget::heightForWidth(). -.PP -Examples: -.)l customlayout/border.cpp and customlayout/flow.cpp. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "int QLayoutItem::heightForWidth ( int w ) const\fC [virtual]\fR" -Returns the preferred height for this layout item, given the width \fIw\fR. -.PP -The default implementation returns -1, indicating that the preferred height is independent of the width of the item. Using the function hasHeightForWidth() will typically be much faster than calling this function and testing for -1. -.PP -Reimplement this function in layout managers that support height for width. A typical implementation will look like this: -.PP -.nf -.br - int MyLayout::heightForWidth( int w ) const -.br - { -.br - if ( cache_dirty || cached_width != w ) { -.br - // not all C++ compilers support "mutable" -.br - MyLayout *that = (MyLayout*)this; -.br - int h = calculateHeightForWidth( w ); -.br - that->cached_hfw = h; -.br - return h; -.br - } -.br - return cached_hfw; -.br - } -.br -.fi -.PP -Caching is strongly recommended; without it layout will take exponential time. -.PP -See also hasHeightForWidth(). -.PP -Example: customlayout/flow.cpp. -.PP -Reimplemented in QGridLayout and QBoxLayout. -.SH "void QLayoutItem::invalidate ()\fC [virtual]\fR" -Invalidates any cached information in this layout item. -.PP -Reimplemented in QLayout. -.SH "bool QLayoutItem::isEmpty () const\fC [pure virtual]\fR" -Implemented in subclasses to return whether this item is empty, i.e. whether it contains any widgets. -.PP -Reimplemented in QLayout, QSpacerItem, and QWidgetItem. -.SH "QLayoutIterator QLayoutItem::iterator ()\fC [virtual]\fR" -Returns an iterator over this item's QLayoutItem children. The default implementation returns an empty iterator. -.PP -Reimplement this function in subclasses that can have children. -.PP -Reimplemented in QLayout. -.SH "QLayout * QLayoutItem::layout ()\fC [virtual]\fR" -If this item is a QLayout, it is returned as a QLayout; otherwise 0 is returned. This function provides type-safe casting. -.SH "QSize QLayoutItem::maximumSize () const\fC [pure virtual]\fR" -Implemented in subclasses to return the maximum size of this item. -.PP -Reimplemented in QLayout, QSpacerItem, and QWidgetItem. -.SH "QSize QLayoutItem::minimumSize () const\fC [pure virtual]\fR" -Implemented in subclasses to return the minimum size of this item. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.PP -Reimplemented in QLayout, QSpacerItem, and QWidgetItem. -.SH "void QLayoutItem::setAlignment ( int a )\fC [virtual]\fR" -Sets the alignment of this item to \fIa\fR, which is a bitwise OR of the Qt::AlignmentFlags. Not all subclasses support alignment. -.PP -Example: chart/optionsform.cpp. -.SH "void QLayoutItem::setGeometry ( const QRect & r )\fC [pure virtual]\fR" -Implemented in subclasses to set this item's geometry to \fIr\fR. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.PP -Reimplemented in QLayout, QSpacerItem, and QWidgetItem. -.SH "QSize QLayoutItem::sizeHint () const\fC [pure virtual]\fR" -Implemented in subclasses to return the preferred size of this item. -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.PP -Reimplemented in QSpacerItem, QWidgetItem, QGridLayout, and QBoxLayout. -.SH "QSpacerItem * QLayoutItem::spacerItem ()\fC [virtual]\fR" -If this item is a QSpacerItem, it is returned as a QSpacerItem; otherwise 0 is returned. This function provides type-safe casting. -.SH "QWidget * QLayoutItem::widget ()\fC [virtual]\fR" -If this item is a QWidget, it is returned as a QWidget; otherwise 0 is returned. This function provides type-safe casting. -.PP -Reimplemented in QWidgetItem. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qlayoutitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlayoutitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlayoutiterator.3qt b/doc/man/man3/qlayoutiterator.3qt deleted file mode 100644 index f0c40c876..000000000 --- a/doc/man/man3/qlayoutiterator.3qt +++ /dev/null @@ -1,140 +0,0 @@ -'\" t -.TH QLayoutIterator 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 -QLayoutIterator \- Iterators over QLayoutItem -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQLayoutIterator\fR ( QGLayoutIterator * gi )" -.br -.ti -1c -.BI "\fBQLayoutIterator\fR ( const QLayoutIterator & i )" -.br -.ti -1c -.BI "\fB~QLayoutIterator\fR ()" -.br -.ti -1c -.BI "QLayoutIterator & \fBoperator=\fR ( const QLayoutIterator & i )" -.br -.ti -1c -.BI "QLayoutItem * \fBoperator++\fR ()" -.br -.ti -1c -.BI "QLayoutItem * \fBcurrent\fR ()" -.br -.ti -1c -.BI "QLayoutItem * \fBtakeCurrent\fR ()" -.br -.ti -1c -.BI "void \fBdeleteCurrent\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QLayoutIterator class provides iterators over QLayoutItem. -.PP -Use QLayoutItem::iterator() to create an iterator over a layout. -.PP -QLayoutIterator uses \fIexplicit\fR sharing with a reference count. If an iterator is copied and one of the copies is modified, both iterators will be modified. -.PP -A QLayoutIterator is not protected against changes in its layout. If the layout is modified or deleted the iterator will become invalid. It is not possible to test for validity. It is safe to delete an invalid layout; any other access may lead to an illegal memory reference and the abnormal termination of the program. -.PP -Calling takeCurrent() or deleteCurrent() leaves the iterator in a valid state, but may invalidate any other iterators that access the same layout. -.PP -The following code will draw a rectangle for each layout item in the layout structure of the widget. -.PP -.nf -.br - static void paintLayout( QPainter *p, QLayoutItem *lay ) -.br - { -.br - QLayoutIterator it = lay->iterator(); -.br - QLayoutItem *child; -.br - while ( (child = it.current()) != 0 ) { -.br - paintLayout( p, child ); -.br - ++it; -.br - } -.br - p->drawRect( lay->geometry() ); -.br - } -.br - void ExampleWidget::paintEvent( QPaintEvent * ) -.br - { -.br - QPainter p( this ); -.br - if ( layout() ) -.br - paintLayout( &p, layout() ); -.br - } -.br -.fi -.PP -All the functionality of QLayoutIterator is implemented by subclasses of QGLayoutIterator. QLayoutIterator itself is not designed to be subclassed. -.PP -See also Widget Appearance and Style and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLayoutIterator::QLayoutIterator ( QGLayoutIterator * gi )" -Constructs an iterator based on \fIgi\fR. The constructed iterator takes ownership of \fIgi\fR and will delete it. -.PP -This constructor is provided for layout implementors. Application programmers should use QLayoutItem::iterator() to create an iterator over a layout. -.SH "QLayoutIterator::QLayoutIterator ( const QLayoutIterator & i )" -Creates a shallow copy of \fIi\fR, i.e. if the copy is modified, then the original will also be modified. -.SH "QLayoutIterator::~QLayoutIterator ()" -Destroys the iterator. -.SH "QLayoutItem * QLayoutIterator::current ()" -Returns the current item, or 0 if there is no current item. -.SH "void QLayoutIterator::deleteCurrent ()" -Removes and deletes the current child item from the layout and moves the iterator to the next item. This iterator will still be valid, but any other iterator over the same layout may become invalid. -.SH "QLayoutItem * QLayoutIterator::operator++ ()" -Moves the iterator to the next child item and returns that item, or 0 if there is no such item. -.SH "QLayoutIterator & QLayoutIterator::operator= ( const QLayoutIterator & i )" -Assigns \fIi\fR to this iterator and returns a reference to this iterator. -.SH "QLayoutItem * QLayoutIterator::takeCurrent ()" -Removes the current child item from the layout without deleting -it, and moves the iterator to the next item. Returns the removed -item, or 0 if there was no item to be removed. This iterator will -still be valid, but any other iterator over the same layout may -become invalid. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qlayoutiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlayoutiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlcdnumber.3qt b/doc/man/man3/qlcdnumber.3qt deleted file mode 100644 index af69911df..000000000 --- a/doc/man/man3/qlcdnumber.3qt +++ /dev/null @@ -1,335 +0,0 @@ -'\" t -.TH QLCDNumber 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 -QLCDNumber \- Displays a number with LCD-like digits -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQLCDNumber\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQLCDNumber\fR ( uint numDigits, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QLCDNumber\fR ()" -.br -.ti -1c -.BI "enum \fBMode\fR { Hex, Dec, Oct, Bin, HEX = Hex, DEC = Dec, OCT = Oct, BIN = Bin }" -.br -.ti -1c -.BI "enum \fBSegmentStyle\fR { Outline, Filled, Flat }" -.br -.ti -1c -.BI "bool \fBsmallDecimalPoint\fR () const" -.br -.ti -1c -.BI "int \fBnumDigits\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNumDigits\fR ( int nDigits )" -.br -.ti -1c -.BI "bool \fBcheckOverflow\fR ( double num ) const" -.br -.ti -1c -.BI "bool \fBcheckOverflow\fR ( int num ) const" -.br -.ti -1c -.BI "Mode \fBmode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMode\fR ( Mode )" -.br -.ti -1c -.BI "SegmentStyle \fBsegmentStyle\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSegmentStyle\fR ( SegmentStyle )" -.br -.ti -1c -.BI "double \fBvalue\fR () const" -.br -.ti -1c -.BI "int \fBintValue\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBdisplay\fR ( const QString & s )" -.br -.ti -1c -.BI "void \fBdisplay\fR ( int num )" -.br -.ti -1c -.BI "void \fBdisplay\fR ( double num )" -.br -.ti -1c -.BI "virtual void \fBsetHexMode\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetDecMode\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetOctMode\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetBinMode\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetSmallDecimalPoint\fR ( bool )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBoverflow\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBintValue\fR - the displayed value rounded to the nearest integer" -.br -.ti -1c -.BI "Mode \fBmode\fR - the current display mode (number " "base" ")" -.br -.ti -1c -.BI "int \fBnumDigits\fR - the current number of digits displayed" -.br -.ti -1c -.BI "SegmentStyle \fBsegmentStyle\fR - the style of the LCDNumber" -.br -.ti -1c -.BI "bool \fBsmallDecimalPoint\fR - the style of the decimal point" -.br -.ti -1c -.BI "double \fBvalue\fR - the displayed value" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * p )" -.br -.in -1c -.SH DESCRIPTION -The QLCDNumber widget displays a number with LCD-like digits. -.PP -It can display a number in just about any size. It can display decimal, hexadecimal, octal or binary numbers. It is easy to connect to data sources using the display() slot, which is overloaded to take any of five argument types. -.PP -There are also slots to change the base with setMode() and the decimal point with setSmallDecimalPoint(). -.PP -QLCDNumber emits the overflow() signal when it is asked to display something beyond its range. The range is set by setNumDigits(), but setSmallDecimalPoint() also influences it. If the display is set to hexadecimal, octal or binary, the integer equivalent of the value is displayed. -.PP -These digits and other symbols can be shown: 0/O, 1, 2, 3, 4, 5/S, 6, 7, 8, 9/g, minus, decimal point, A, B, C, D, E, F, h, H, L, o, P, r, u, U, Y, colon, degree sign (which is specified as single quote in the string) and space. QLCDNumber substitutes spaces for illegal characters. -.PP -It is not possible to retrieve the contents of a QLCDNumber object, although you can retrieve the numeric value with value(). If you really need the text, we recommend that you connect the signals that feed the display() slot to another slot as well and store the value there. -.PP -Incidentally, QLCDNumber is the very oldest part of Qt, tracing back to a BASIC program on the Sinclair Spectrum. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QLabel, QFrame, and Basic Widgets. -.SS "Member Type Documentation" -.SH "QLCDNumber::Mode" -This type determines how numbers are shown. -.TP -\fCQLCDNumber::Hex\fR - Hexadecimal -.TP -\fCQLCDNumber::Dec\fR - Decimal -.TP -\fCQLCDNumber::Oct\fR - Octal -.TP -\fCQLCDNumber::Bin\fR - Binary -.PP -If the display is set to hexadecimal, octal or binary, the integer equivalent of the value is displayed. -.SH "QLCDNumber::SegmentStyle" -This type determines the visual appearance of the QLCDNumber widget. -.TP -\fCQLCDNumber::Outline\fR - gives raised segments filled with the background brush. -.TP -\fCQLCDNumber::Filled\fR - gives raised segments filled with the foreground brush. -.TP -\fCQLCDNumber::Flat\fR - gives flat segments filled with the foreground brush. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLCDNumber::QLCDNumber ( QWidget * parent = 0, const char * name = 0 )" -Constructs an LCD number, sets the number of digits to 5, the base to decimal, the decimal point mode to 'small' and the frame style to a raised box. The segmentStyle() is set to Outline. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QFrame constructor. -.PP -See also numDigits and smallDecimalPoint. -.SH "QLCDNumber::QLCDNumber ( uint numDigits, QWidget * parent = 0, const char * name = 0 )" -Constructs an LCD number, sets the number of digits to \fInumDigits\fR, the base to decimal, the decimal point mode to 'small' and the frame style to a raised box. The segmentStyle() is set to Outline. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QFrame constructor. -.PP -See also numDigits and smallDecimalPoint. -.SH "QLCDNumber::~QLCDNumber ()" -Destroys the LCD number. -.SH "bool QLCDNumber::checkOverflow ( double num ) const" -Returns TRUE if \fInum\fR is too big to be displayed in its entirety; otherwise returns FALSE. -.PP -See also display(), numDigits, and smallDecimalPoint. -.SH "bool QLCDNumber::checkOverflow ( int num ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fInum\fR is too big to be displayed in its entirety; otherwise returns FALSE. -.PP -See also display(), numDigits, and smallDecimalPoint. -.SH "void QLCDNumber::display ( const QString & s )\fC [slot]\fR" -Displays the number represented by the string \fIs\fR. -.PP -This version of the function disregards mode() and smallDecimalPoint(). -.PP -These digits and other symbols can be shown: 0/O, 1, 2, 3, 4, 5/S, 6, 7, 8, 9/g, minus, decimal point, A, B, C, D, E, F, h, H, L, o, P, r, u, U, Y, colon, degree sign (which is specified as single quote in the string) and space. QLCDNumber substitutes spaces for illegal characters. -.PP -Examples: -.)l rangecontrols/rangecontrols.cpp, t12/lcdrange.cpp, t13/gamebrd.cpp, t5/main.cpp, t6/main.cpp, t7/lcdrange.cpp, and xform/xform.cpp. -.SH "void QLCDNumber::display ( int num )\fC [slot]\fR" -Sets the displayed value rounded to the nearest integer to \fInum\fR. See the "intValue" property for details. -.SH "void QLCDNumber::display ( double num )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Displays the number \fInum\fR. -.SH "void QLCDNumber::drawContents ( QPainter * p )\fC [virtual protected]\fR" -Draws the LCD number using painter \fIp\fR. This function is called from QFrame::paintEvent(). -.PP -Reimplemented from QFrame. -.SH "int QLCDNumber::intValue () const" -Returns the displayed value rounded to the nearest integer. See the "intValue" property for details. -.SH "Mode QLCDNumber::mode () const" -Returns the current display mode (number base). See the "mode" property for details. -.SH "int QLCDNumber::numDigits () const" -Returns the current number of digits displayed. See the "numDigits" property for details. -.SH "void QLCDNumber::overflow ()\fC [signal]\fR" -This signal is emitted whenever the QLCDNumber is asked to display a too-large number or a too-long string. -.PP -It is never emitted by setNumDigits(). -.SH "SegmentStyle QLCDNumber::segmentStyle () const" -Returns the style of the LCDNumber. See the "segmentStyle" property for details. -.SH "void QLCDNumber::setBinMode ()\fC [virtual slot]\fR" -Calls setMode( BIN ). Provided for convenience (e.g. for connecting buttons to it). -.PP -See also mode, setHexMode(), setDecMode(), setOctMode(), and mode. -.SH "void QLCDNumber::setDecMode ()\fC [virtual slot]\fR" -Calls setMode( DEC ). Provided for convenience (e.g. for connecting buttons to it). -.PP -See also mode, setHexMode(), setOctMode(), setBinMode(), and mode. -.SH "void QLCDNumber::setHexMode ()\fC [virtual slot]\fR" -Calls setMode( HEX ). Provided for convenience (e.g. for connecting buttons to it). -.PP -See also mode, setDecMode(), setOctMode(), setBinMode(), and mode. -.SH "void QLCDNumber::setMode ( Mode )\fC [virtual]\fR" -Sets the current display mode (number base). See the "mode" property for details. -.SH "void QLCDNumber::setNumDigits ( int nDigits )\fC [virtual]\fR" -Sets the current number of digits displayed to \fInDigits\fR. See the "numDigits" property for details. -.SH "void QLCDNumber::setOctMode ()\fC [virtual slot]\fR" -Calls setMode( OCT ). Provided for convenience (e.g. for connecting buttons to it). -.PP -See also mode, setHexMode(), setDecMode(), setBinMode(), and mode. -.SH "void QLCDNumber::setSegmentStyle ( SegmentStyle )\fC [virtual]\fR" -Sets the style of the LCDNumber. See the "segmentStyle" property for details. -.SH "void QLCDNumber::setSmallDecimalPoint ( bool )\fC [virtual slot]\fR" -Sets the style of the decimal point. See the "smallDecimalPoint" property for details. -.SH "bool QLCDNumber::smallDecimalPoint () const" -Returns the style of the decimal point. See the "smallDecimalPoint" property for details. -.SH "double QLCDNumber::value () const" -Returns the displayed value. See the "value" property for details. -.SS "Property Documentation" -.SH "int intValue" -This property holds the displayed value rounded to the nearest integer. -.PP -This property corresponds to the nearest integer to the current value displayed by the LCDNumber. This is the value used for hexadecimal, octal and binary modes. -.PP -If the displayed value is not a number, the property has a value of 0. -.PP -Set this property's value with display() and get this property's value with intValue(). -.SH "Mode mode" -This property holds the current display mode (number base). -.PP -Corresponds to the current display mode, which is one of BIN, OCT, DEC (the default) and HEX. DEC mode can display floating point values, the other modes display the integer equivalent. -.PP -See also smallDecimalPoint, setHexMode(), setDecMode(), setOctMode(), and setBinMode(). -.PP -Set this property's value with setMode() and get this property's value with mode(). -.SH "int numDigits" -This property holds the current number of digits displayed. -.PP -Corresponds to the current number of digits. If QLCDNumber::smallDecimalPoint is FALSE, the decimal point occupies one digit position. -.PP -See also smallDecimalPoint. -.PP -Set this property's value with setNumDigits() and get this property's value with numDigits(). -.SH "SegmentStyle segmentStyle" -This property holds the style of the LCDNumber. -.PP -
                                    .nf -.TS -l - l. Style Result Outline Produces raised segments filled with the background color (this is the default). Filled Produces raised segments filled with the foreground color. Flat -.TE -.fi -
                                    -.PP -Outline and Filled will additionally use QColorGroup::light() and QColorGroup::dark() for shadow effects. -.PP -Set this property's value with setSegmentStyle() and get this property's value with segmentStyle(). -.SH "bool smallDecimalPoint" -This property holds the style of the decimal point. -.PP -If TRUE the decimal point is drawn between two digit positions. Otherwise it occupies a digit position of its own, i.e. is drawn in a digit position. The default is FALSE. -.PP -The inter-digit space is made slightly wider when the decimal point is drawn between the digits. -.PP -See also mode. -.PP -Set this property's value with setSmallDecimalPoint() and get this property's value with smallDecimalPoint(). -.SH "double value" -This property holds the displayed value. -.PP -This property corresponds to the current value displayed by the LCDNumber. -.PP -If the displayed value is not a number, the property has a value of 0. -.PP -Set this property's value with display() and get this property's value with value(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlcdnumber.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlcdnumber.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlibrary.3qt b/doc/man/man3/qlibrary.3qt deleted file mode 100644 index b589e5eaa..000000000 --- a/doc/man/man3/qlibrary.3qt +++ /dev/null @@ -1,280 +0,0 @@ -'\" t -.TH QLibrary 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 -QLibrary \- Wrapper for handling shared libraries -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                    -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQLibrary\fR ( const QString & filename )" -.br -.ti -1c -.BI "virtual \fB~QLibrary\fR ()" -.br -.ti -1c -.BI "void * \fBresolve\fR ( const char * symb )" -.br -.ti -1c -.BI "bool \fBload\fR ()" -.br -.ti -1c -.BI "virtual bool \fBunload\fR ()" -.br -.ti -1c -.BI "bool \fBisLoaded\fR () const" -.br -.ti -1c -.BI "bool \fBautoUnload\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoUnload\fR ( bool enabled )" -.br -.ti -1c -.BI "QString \fBlibrary\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void * \fBresolve\fR ( const QString & filename, const char * symb )" -.br -.in -1c -.SH DESCRIPTION -The QLibrary class provides a wrapper for handling shared libraries. -.PP -An instance of a QLibrary object can handle a single shared library and provide access to the functionality in the library in a platform independent way. If the library is a component server, QLibrary provides access to the exported component and can directly query this component for interfaces. -.PP -QLibrary ensures that the shared library is loaded and stays in memory whilst it is in use. QLibrary can also unload the library on destruction and release unused resources. -.PP -A typical use of QLibrary is to resolve an exported symbol in a shared object, and to call the function that this symbol represents. This is called "explicit linking" in contrast to" implicit linking", which is done by the link step in the build process when linking an executable against a library. -.PP -The following code snippet loads a library, resolves the symbol" mysymbol", and calls the function if everything succeeded. If something went wrong, e.g. the library file does not exist or the symbol is not defined, the function pointer will be 0 and won't be called. When the QLibrary object is destroyed the library will be unloaded, making all references to memory allocated in the library invalid. -.PP -.nf -.br - typedef void (*MyPrototype)(); -.br - MyPrototype myFunction; -.br -.br - QLibrary myLib( "mylib" ); -.br - myFunction = (MyPrototype) myLib.resolve( "mysymbol" ); -.br - if ( myFunction ) { -.br - myFunction(); -.br - } -.br -.fi -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLibrary::QLibrary ( const QString & filename )" -Creates a QLibrary object for the shared library \fIfilename\fR. The library will be unloaded in the destructor. -.PP -Note that \fIfilename\fR does not need to include the (platform specific) file extension, so calling -.PP -.nf -.br - QLibrary lib( "mylib" ); -.br -.fi -is equivalent to calling -.PP -.nf -.br - QLibrary lib( "mylib.dll" ); -.br -.fi -on Windows, and -.PP -.nf -.br - QLibrary lib( "libmylib.so" ); -.br -.fi -on Unix. Specifying the extension is not recommended, since doing so introduces a platform dependency. -.PP -If \fIfilename\fR does not include a path, the library loader will look for the file in the platform specific search paths. -.PP -See also load(), unload(), and setAutoUnload(). -.SH "QLibrary::~QLibrary ()\fC [virtual]\fR" -Deletes the QLibrary object. -.PP -The library will be unloaded if autoUnload() is TRUE (the default), otherwise it stays in memory until the application exits. -.PP -See also unload() and setAutoUnload(). -.SH "bool QLibrary::autoUnload () const" -Returns TRUE if the library will be automatically unloaded when this wrapper object is destructed; otherwise returns FALSE. The default is TRUE. -.PP -See also setAutoUnload(). -.SH "bool QLibrary::isLoaded () const" -Returns TRUE if the library is loaded; otherwise returns FALSE. -.PP -See also unload(). -.SH "QString QLibrary::library () const" -Returns the filename of the shared library this QLibrary object handles, including the platform specific file extension. -.PP -For example: -.PP -.nf -.br - QLibrary lib( "mylib" ); -.br - QString str = lib.library(); -.br -.fi -will set \fIstr\fR to "mylib.dll" on Windows, and "libmylib.so" on Linux. -.SH "bool QLibrary::load ()" -Loads the library. Since resolve() always calls this function before resolving any symbols it is not necessary to call it explicitly. In some situations you might want the library loaded in advance, in which case you would use this function. -.PP -On Darwin and Mac OS X this function uses code from dlcompat, part of the OpenDarwin project. -.PP -Copyright (c) 2002 Jorge Acereda and Peter O'Gorman -.PP -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the" Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -.PP -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -.PP -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -.SH "void * QLibrary::resolve ( const char * symb )" -Returns the address of the exported symbol \fIsymb\fR. The library is loaded if necessary. The function returns 0 if the symbol could not be resolved or the library could not be loaded. -.PP -.nf -.br - typedef int (*avgProc)( int, int ); -.br -.br - avgProc avg = (avgProc) library->resolve( "avg" ); -.br - if ( avg ) -.br - return avg( 5, 8 ); -.br - else -.br - return -1; -.br -.fi -.PP -The symbol must be exported as a C-function from the library. This requires the \fCextern "C"\fR notation if the library is compiled with a C++ compiler. On Windows you also have to explicitly export the function from the DLL using the \fC__declspec(dllexport)\fR compiler directive. -.PP -.nf -.br - extern "C" MY_EXPORT_MACRO int avg(int a, int b) -.br - { -.br - return (a + b) / 2; -.br - } -.br -.fi -.PP -with \fCMY_EXPORT\fR defined as -.PP -.nf -.br - #ifdef Q_WS_WIN -.br - # define MY_EXPORT __declspec(dllexport) -.br - #else -.br - # define MY_EXPORT -.br - #endif -.br -.fi -.PP -On Darwin and Mac OS X this function uses code from dlcompat, part of the OpenDarwin project. -.PP -Copyright (c) 2002 Jorge Acereda and Peter O'Gorman -.PP -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the" Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -.PP -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -.PP -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -.SH "void * QLibrary::resolve ( const QString & filename, const char * symb )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads the library \fIfilename\fR and returns the address of the exported symbol \fIsymb\fR. Note that like the constructor, \fIfilename\fR does not need to include the (platform specific) file extension. The library remains loaded until the process exits. -.PP -The function returns 0 if the symbol could not be resolved or the library could not be loaded. -.PP -This function is useful only if you want to resolve a single symbol, e.g. a function pointer from a specific library once: -.PP -.nf -.br - typedef void (*FunctionType)(); -.br - static FunctionType *ptrFunction = 0; -.br - static bool triedResolve = FALSE; -.br - if ( !ptrFunction && !triedResolve ) -.br - ptrFunction = QLibrary::resolve( "mylib", "mysymb" ); -.br -.br - if ( ptrFunction ) -.br - ptrFunction(); -.br - else -.br - ... -.br -.fi -.PP -If you want to resolve multiple symbols, use a QLibrary object and call the non-static version of resolve(). -.PP -See also -.SH "void QLibrary::setAutoUnload ( bool enabled )" -If \fIenabled\fR is TRUE (the default), the wrapper object is set to automatically unload the library upon destruction. If \fIenabled\fR is FALSE, the wrapper object is not unloaded unless you explicitly call unload(). -.PP -See also autoUnload(). -.SH "bool QLibrary::unload ()\fC [virtual]\fR" -Unloads the library and returns TRUE if the library could be unloaded; otherwise returns FALSE. -.PP -This function is called by the destructor if autoUnload() is enabled. -.PP -See also resolve(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlibrary.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlibrary.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlineedit.3qt b/doc/man/man3/qlineedit.3qt deleted file mode 100644 index 128d4dc9f..000000000 --- a/doc/man/man3/qlineedit.3qt +++ /dev/null @@ -1,778 +0,0 @@ -'\" t -.TH QLineEdit 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 -QLineEdit \- One-line text editor -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQLineEdit\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQLineEdit\fR ( const QString & contents, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQLineEdit\fR ( const QString & contents, const QString & inputMask, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QLineEdit\fR ()" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "QString \fBdisplayText\fR () const" -.br -.ti -1c -.BI "int \fBmaxLength\fR () const" -.br -.ti -1c -.BI "bool \fBframe\fR () const" -.br -.ti -1c -.BI "enum \fBEchoMode\fR { Normal, NoEcho, Password }" -.br -.ti -1c -.BI "EchoMode \fBechoMode\fR () const" -.br -.ti -1c -.BI "bool \fBisReadOnly\fR () const" -.br -.ti -1c -.BI "const QValidator * \fBvalidator\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBminimumSizeHint\fR () const" -.br -.ti -1c -.BI "int \fBcursorPosition\fR () const" -.br -.ti -1c -.BI "bool validateAndSet ( const QString & newText, int newPos, int newMarkAnchor, int newMarkDrag ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBalignment\fR () const" -.br -.ti -1c -.BI "void cursorLeft ( bool mark, int steps = 1 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void cursorRight ( bool mark, int steps = 1 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBcursorForward\fR ( bool mark, int steps = 1 )" -.br -.ti -1c -.BI "void \fBcursorBackward\fR ( bool mark, int steps = 1 )" -.br -.ti -1c -.BI "void \fBcursorWordForward\fR ( bool mark )" -.br -.ti -1c -.BI "void \fBcursorWordBackward\fR ( bool mark )" -.br -.ti -1c -.BI "void \fBbackspace\fR ()" -.br -.ti -1c -.BI "void \fBdel\fR ()" -.br -.ti -1c -.BI "void \fBhome\fR ( bool mark )" -.br -.ti -1c -.BI "void \fBend\fR ( bool mark )" -.br -.ti -1c -.BI "bool \fBisModified\fR () const" -.br -.ti -1c -.BI "void \fBclearModified\fR ()" -.br -.ti -1c -.BI "bool edited () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setEdited ( bool ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBhasSelectedText\fR () const" -.br -.ti -1c -.BI "QString \fBselectedText\fR () const" -.br -.ti -1c -.BI "int \fBselectionStart\fR () const" -.br -.ti -1c -.BI "bool \fBisUndoAvailable\fR () const" -.br -.ti -1c -.BI "bool \fBisRedoAvailable\fR () const" -.br -.ti -1c -.BI "bool hasMarkedText () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString markedText () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBdragEnabled\fR () const" -.br -.ti -1c -.BI "QString \fBinputMask\fR () const" -.br -.ti -1c -.BI "void \fBsetInputMask\fR ( const QString & inputMask )" -.br -.ti -1c -.BI "bool \fBhasAcceptableInput\fR () const" -.br -.ti -1c -.BI "int characterAt ( int xpos, QChar * chr ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool getSelection ( int * start, int * end ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "virtual void \fBselectAll\fR ()" -.br -.ti -1c -.BI "virtual void \fBdeselect\fR ()" -.br -.ti -1c -.BI "virtual void \fBclearValidator\fR ()" -.br -.ti -1c -.BI "virtual void \fBinsert\fR ( const QString & newText )" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBundo\fR ()" -.br -.ti -1c -.BI "virtual void \fBredo\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetMaxLength\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBsetFrame\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetEchoMode\fR ( EchoMode )" -.br -.ti -1c -.BI "virtual void \fBsetReadOnly\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetValidator\fR ( const QValidator * v )" -.br -.ti -1c -.BI "virtual void \fBsetSelection\fR ( int start, int length )" -.br -.ti -1c -.BI "virtual void \fBsetCursorPosition\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBsetAlignment\fR ( int flag )" -.br -.ti -1c -.BI "virtual void \fBcut\fR ()" -.br -.ti -1c -.BI "virtual void \fBcopy\fR () const" -.br -.ti -1c -.BI "virtual void \fBpaste\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetDragEnabled\fR ( bool b )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBtextChanged\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBreturnPressed\fR ()" -.br -.ti -1c -.BI "void \fBlostFocus\fR ()" -.br -.ti -1c -.BI "void \fBselectionChanged\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBacceptableInput\fR - whether the input satisfies the inputMask and the validator \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "Alignment \fBalignment\fR - the alignment of the line edit" -.br -.ti -1c -.BI "int \fBcursorPosition\fR - the current cursor position for this line edit" -.br -.ti -1c -.BI "QString \fBdisplayText\fR - the displayed text \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBdragEnabled\fR - whether the lineedit starts a drag if the user presses and moves the mouse on some selected text" -.br -.ti -1c -.BI "EchoMode \fBechoMode\fR - the line edit's echo mode" -.br -.ti -1c -.BI "bool edited - whether the line edit has been edited. Use modified instead \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBframe\fR - whether the line edit draws itself with a frame" -.br -.ti -1c -.BI "bool hasMarkedText - whether part of the text has been selected by the user. Use hasSelectedText instead \fI(read " "only" ")\fR \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBhasSelectedText\fR - whether there is any text selected \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QString \fBinputMask\fR - the validation input mask" -.br -.ti -1c -.BI "QString markedText - the text selected by the user. Use selectedText instead \fI(read " "only" ")\fR \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBmaxLength\fR - the maximum permitted length of the text" -.br -.ti -1c -.BI "bool \fBmodified\fR - whether the line edit's contents has been modified by the user \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBreadOnly\fR - whether the line edit is read only" -.br -.ti -1c -.BI "bool \fBredoAvailable\fR - whether redo is available \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QString \fBselectedText\fR - the selected text \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QString \fBtext\fR - the line edit's text" -.br -.ti -1c -.BI "bool \fBundoAvailable\fR - whether undo is available \fI(read " "only" ")\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" -.br -.ti -1c -.BI "virtual QPopupMenu * \fBcreatePopupMenu\fR ()" -.br -.ti -1c -.BI "void repaintArea ( int from, int to ) \fI(obsolete)\fR" -.br -.in -1c -.SH DESCRIPTION -The QLineEdit widget is a one-line text editor. -.PP -A line edit allows the user to enter and edit a single line of plain text with a useful collection of editing functions, including undo and redo, cut and paste, and drag and drop. -.PP -By changing the echoMode() of a line edit, it can also be used as a "write-only" field, for inputs such as passwords. -.PP -The length of the text can be constrained to maxLength(). The text can be arbitrarily constrained using a validator() or an inputMask(), or both. -.PP -A related class is QTextEdit which allows multi-line, rich-text editing. -.PP -You can change the text with setText() or insert(). The text is retrieved with text(); the displayed text (which may be different, see EchoMode) is retrieved with displayText(). Text can be selected with setSelection() or selectAll(), and the selection can be cut(), copy()ied and paste()d. The text can be aligned with setAlignment(). -.PP -When the text changes the textChanged() signal is emitted; when the Return or Enter key is pressed the returnPressed() signal is emitted. Note that if there is a validator set on the line edit, the returnPressed() signal will only be emitted if the validator returns \fCAcceptable\fR. -.PP -By default, QLineEdits have a frame as specified by the Windows and Motif style guides; you can turn it off by calling setFrame(FALSE). -.PP -The default key bindings are described below. The line edit also provides a context menu (usually invoked by a right mouse click) that presents some of these editing options.
                                    .nf -.TS -l - l. Keypress Action Left Arrow Moves the cursor one character to the left. Shift+Left Arrow Moves and selects text one character to the left. Right Arrow Moves the cursor one character to the right. Shift+Right Arrow Moves and selects text one character to the right. Home Moves the cursor to the beginning of the line. End Moves the cursor to the end of the line. Backspace Deletes the character to the left of the cursor. Ctrl+Backspace Deletes the word to the left of the cursor. Delete Deletes the character to the right of the cursor. Ctrl+Delete Deletes the word to the right of the cursor. Ctrl+A Moves the cursor to the beginning of the line. Ctrl+B Moves the cursor one character to the left. Ctrl+C Copies the selected text to the clipboard. (Windows also supports Ctrl+Insert for this operation.) Ctrl+D Deletes the character to the right of the cursor. Ctrl+E Moves the cursor to the end of the line. Ctrl+F Moves the cursor one character to the right. Ctrl+H Deletes the character to the left of the cursor. Ctrl+K Deletes to the end of the line. Ctrl+V Pastes the clipboard text into line edit. (Windows also supports Shift+Insert for this operation.) Ctrl+X Deletes the selected text and copies it to the clipboard. (Windows also supports Shift+Delete for this operation.) Ctrl+Z Undoes the last operation. Ctrl+Y -.TE -.fi -
                                    -.PP -Any other key sequence that represents a valid character, will cause the character to be inserted into the line edit. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QTextEdit, QLabel, QComboBox, GUI Design Handbook: Field, Entry, and Basic Widgets. -.SS "Member Type Documentation" -.SH "QLineEdit::EchoMode" -This enum type describes how a line edit should display its contents. -.TP -\fCQLineEdit::Normal\fR - Display characters as they are entered. This is the default. -.TP -\fCQLineEdit::NoEcho\fR - Do not display anything. This may be appropriate for passwords where even the length of the password should be kept secret. -.TP -\fCQLineEdit::Password\fR - Display asterisks instead of the characters actually entered. -.PP -See also echoMode and echoMode. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLineEdit::QLineEdit ( QWidget * parent, const char * name = 0 )" -Constructs a line edit with no text. -.PP -The maximum text length is set to 32767 characters. -.PP -The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. -.PP -See also text and maxLength. -.SH "QLineEdit::QLineEdit ( const QString & contents, QWidget * parent, const char * name = 0 )" -Constructs a line edit containing the text \fIcontents\fR. -.PP -The cursor position is set to the end of the line and the maximum text length to 32767 characters. -.PP -The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. -.PP -See also text and maxLength. -.SH "QLineEdit::QLineEdit ( const QString & contents, const QString & inputMask, QWidget * parent, const char * name = 0 )" -Constructs a line edit with an input \fIinputMask\fR and the text \fIcontents\fR. -.PP -The cursor position is set to the end of the line and the maximum text length is set to the length of the mask (the number of mask characters and separators). -.PP -The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. -.PP -See also setMask() and text. -.SH "QLineEdit::~QLineEdit ()" -Destroys the line edit. -.SH "int QLineEdit::alignment () const" -Returns the alignment of the line edit. See the "alignment" property for details. -.SH "void QLineEdit::backspace ()" -If no text is selected, deletes the character to the left of the text cursor and moves the cursor one position to the left. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted. -.PP -See also del(). -.SH "int QLineEdit::characterAt ( int xpos, QChar * chr ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QLineEdit::clear ()\fC [virtual slot]\fR" -Clears the contents of the line edit. -.SH "void QLineEdit::clearModified ()" -Resets the modified flag to FALSE. -.PP -See also modified. -.SH "void QLineEdit::clearValidator ()\fC [virtual slot]\fR" -This slot is equivalent to setValidator(0). -.SH "void QLineEdit::copy () const\fC [virtual slot]\fR" -Copies the selected text to the clipboard, if there is any, and if echoMode() is Normal. -.PP -See also cut() and paste(). -.SH "QPopupMenu * QLineEdit::createPopupMenu ()\fC [virtual protected]\fR" -This function is called to create the popup menu which is shown when the user clicks on the line edit with the right mouse button. If you want to create a custom popup menu, reimplement this function and return the popup menu you create. The popup menu's ownership is transferred to the caller. -.SH "void QLineEdit::cursorBackward ( bool mark, int steps = 1 )" -Moves the cursor back \fIsteps\fR characters. If \fImark\fR is TRUE each character moved over is added to the selection; if \fImark\fR is FALSE the selection is cleared. -.PP -See also cursorForward(). -.SH "void QLineEdit::cursorForward ( bool mark, int steps = 1 )" -Moves the cursor forward \fIsteps\fR characters. If \fImark\fR is TRUE each character moved over is added to the selection; if \fImark\fR is FALSE the selection is cleared. -.PP -See also cursorBackward(). -.SH "void QLineEdit::cursorLeft ( bool mark, int steps = 1 )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -For compatibilty with older applications only. Use cursorBackward() instead. -.PP -See also cursorBackward(). -.SH "int QLineEdit::cursorPosition () const" -Returns the current cursor position for this line edit. See the "cursorPosition" property for details. -.SH "void QLineEdit::cursorRight ( bool mark, int steps = 1 )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use cursorForward() instead. -.PP -See also cursorForward(). -.SH "void QLineEdit::cursorWordBackward ( bool mark )" -Moves the cursor one word backward. If \fImark\fR is TRUE, the word is also selected. -.PP -See also cursorWordForward(). -.SH "void QLineEdit::cursorWordForward ( bool mark )" -Moves the cursor one word forward. If \fImark\fR is TRUE, the word is also selected. -.PP -See also cursorWordBackward(). -.SH "void QLineEdit::cut ()\fC [virtual slot]\fR" -Copies the selected text to the clipboard and deletes it, if there is any, and if echoMode() is Normal. -.PP -If the current validator disallows deleting the selected text, cut() will copy without deleting. -.PP -See also copy(), paste(), and setValidator(). -.SH "void QLineEdit::del ()" -If no text is selected, deletes the character to the right of the text cursor. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted. -.PP -See also backspace(). -.SH "void QLineEdit::deselect ()\fC [virtual slot]\fR" -Deselects any selected text. -.PP -See also setSelection() and selectAll(). -.SH "QString QLineEdit::displayText () const" -Returns the displayed text. See the "displayText" property for details. -.SH "bool QLineEdit::dragEnabled () const" -Returns TRUE if the lineedit starts a drag if the user presses and moves the mouse on some selected text; otherwise returns FALSE. See the "dragEnabled" property for details. -.SH "EchoMode QLineEdit::echoMode () const" -Returns the line edit's echo mode. See the "echoMode" property for details. -.SH "bool QLineEdit::edited () const" -Returns TRUE if the line edit has been edited. Use modified instead; otherwise returns FALSE. See the "edited" property for details. -.SH "void QLineEdit::end ( bool mark )" -Moves the text cursor to the end of the line unless it is already there. If \fImark\fR is TRUE, text is selected towards the last position; otherwise, any selected text is unselected if the cursor is moved. -.PP -See also home(). -.SH "bool QLineEdit::frame () const" -Returns TRUE if the line edit draws itself with a frame; otherwise returns FALSE. See the "frame" property for details. -.SH "bool QLineEdit::getSelection ( int * start, int * end )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. use selectedText(), selectionStart() -.SH "bool QLineEdit::hasAcceptableInput () const" -Returns TRUE if the input satisfies the inputMask and the validator; otherwise returns FALSE. See the "acceptableInput" property for details. -.SH "bool QLineEdit::hasMarkedText () const" -Returns TRUE if part of the text has been selected by the user. Use hasSelectedText instead; otherwise returns FALSE. See the "hasMarkedText" property for details. -.SH "bool QLineEdit::hasSelectedText () const" -Returns TRUE if there is any text selected; otherwise returns FALSE. See the "hasSelectedText" property for details. -.SH "void QLineEdit::home ( bool mark )" -Moves the text cursor to the beginning of the line unless it is already there. If \fImark\fR is TRUE, text is selected towards the first position; otherwise, any selected text is unselected if the cursor is moved. -.PP -See also end(). -.SH "QString QLineEdit::inputMask () const" -Returns the validation input mask. See the "inputMask" property for details. -.SH "void QLineEdit::insert ( const QString & newText )\fC [virtual slot]\fR" -Deletes any selected text, inserts \fInewText\fR, and validates the result. If it is valid, it sets it as the new contents of the line edit. -.SH "bool QLineEdit::isModified () const" -Returns TRUE if the line edit's contents has been modified by the user; otherwise returns FALSE. See the "modified" property for details. -.SH "bool QLineEdit::isReadOnly () const" -Returns TRUE if the line edit is read only; otherwise returns FALSE. See the "readOnly" property for details. -.SH "bool QLineEdit::isRedoAvailable () const" -Returns TRUE if redo is available; otherwise returns FALSE. See the "redoAvailable" property for details. -.SH "bool QLineEdit::isUndoAvailable () const" -Returns TRUE if undo is available; otherwise returns FALSE. See the "undoAvailable" property for details. -.SH "void QLineEdit::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" -Converts key press event \fIe\fR into a line edit action. -.PP -If Return or Enter is pressed and the current text is valid (or can be made valid by the validator), the signal returnPressed() is emitted. -.PP -The default key bindings are listed in the detailed description. -.PP -Reimplemented from QWidget. -.SH "void QLineEdit::lostFocus ()\fC [signal]\fR" -This signal is emitted when the line edit has lost focus. -.PP -See also focus, QWidget::focusInEvent(), and QWidget::focusOutEvent(). -.SH "QString QLineEdit::markedText () const" -Returns the text selected by the user. Use selectedText instead. See the "markedText" property for details. -.SH "int QLineEdit::maxLength () const" -Returns the maximum permitted length of the text. See the "maxLength" property for details. -.SH "QSize QLineEdit::minimumSizeHint () const\fC [virtual]\fR" -Returns a minimum size for the line edit. -.PP -The width returned is enough for at least one character. -.PP -Reimplemented from QWidget. -.SH "void QLineEdit::paste ()\fC [virtual slot]\fR" -Inserts the clipboard's text at the cursor position, deleting any selected text, providing the line edit is not read-only. -.PP -If the end result would not be acceptable to the current validator, nothing happens. -.PP -See also copy() and cut(). -.SH "void QLineEdit::redo ()\fC [virtual slot]\fR" -Redoes the last operation if redo is available. -.SH "void QLineEdit::repaintArea ( int from, int to )\fC [protected]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Repaints all characters from \fIfrom\fR to \fIto\fR. If cursorPos is between from and to, ensures that cursorPos is visible. -.SH "void QLineEdit::returnPressed ()\fC [signal]\fR" -This signal is emitted when the Return or Enter key is pressed. Note that if there is a validator() or inputMask() set on the line edit, the returnPressed() signal will only be emitted if the input follows the inputMask() and the validator() returns \fCAcceptable\fR. -.PP -Example: popup/popup.cpp. -.SH "void QLineEdit::selectAll ()\fC [virtual slot]\fR" -Selects all the text (i.e. highlights it) and moves the cursor to the end. This is useful when a default value has been inserted because if the user types before clicking on the widget, the selected text will be deleted. -.PP -See also setSelection() and deselect(). -.SH "QString QLineEdit::selectedText () const" -Returns the selected text. See the "selectedText" property for details. -.SH "void QLineEdit::selectionChanged ()\fC [signal]\fR" -This signal is emitted whenever the selection changes. -.PP -See also hasSelectedText and selectedText. -.SH "int QLineEdit::selectionStart () const" -selectionStart() returns the index of the first selected character in the line edit or -1 if no text is selected. -.PP -See also selectedText. -.SH "void QLineEdit::setAlignment ( int flag )\fC [virtual slot]\fR" -Sets the alignment of the line edit to \fIflag\fR. See the "alignment" property for details. -.SH "void QLineEdit::setCursorPosition ( int )\fC [virtual slot]\fR" -Sets the current cursor position for this line edit. See the "cursorPosition" property for details. -.SH "void QLineEdit::setDragEnabled ( bool b )\fC [virtual slot]\fR" -Sets whether the lineedit starts a drag if the user presses and moves the mouse on some selected text to \fIb\fR. See the "dragEnabled" property for details. -.SH "void QLineEdit::setEchoMode ( EchoMode )\fC [virtual slot]\fR" -Sets the line edit's echo mode. See the "echoMode" property for details. -.SH "void QLineEdit::setEdited ( bool )" -Sets whether the line edit has been edited. Use modified instead. See the "edited" property for details. -.SH "void QLineEdit::setFrame ( bool )\fC [virtual slot]\fR" -Sets whether the line edit draws itself with a frame. See the "frame" property for details. -.SH "void QLineEdit::setInputMask ( const QString & inputMask )" -Sets the validation input mask to \fIinputMask\fR. See the "inputMask" property for details. -.SH "void QLineEdit::setMaxLength ( int )\fC [virtual slot]\fR" -Sets the maximum permitted length of the text. See the "maxLength" property for details. -.SH "void QLineEdit::setReadOnly ( bool )\fC [virtual slot]\fR" -Sets whether the line edit is read only. See the "readOnly" property for details. -.SH "void QLineEdit::setSelection ( int start, int length )\fC [virtual slot]\fR" -Selects text from position \fIstart\fR and for \fIlength\fR characters. -.PP -Note that this function sets the cursor's position to the end of the selection regardless of its current position. -.PP -See also deselect(), selectAll(), getSelection(), cursorForward(), and cursorBackward(). -.SH "void QLineEdit::setText ( const QString & )\fC [virtual slot]\fR" -Sets the line edit's text. See the "text" property for details. -.SH "void QLineEdit::setValidator ( const QValidator * v )\fC [virtual slot]\fR" -Sets this line edit to only accept input that the validator, \fIv\fR, will accept. This allows you to place any arbitrary constraints on the text which may be entered. -.PP -If \fIv\fR == 0, setValidator() removes the current input validator. The initial setting is to have no input validator (i.e. any input is accepted up to maxLength()). -.PP -See also validator(), QIntValidator, QDoubleValidator, and QRegExpValidator. -.PP -Examples: -.)l lineedits/lineedits.cpp and wizard/wizard.cpp. -.SH "QSize QLineEdit::sizeHint () const\fC [virtual]\fR" -Returns a recommended size for the widget. -.PP -The width returned, in pixels, is usually enough for about 15 to 20 characters. -.PP -Example: addressbook/centralwidget.cpp. -.SH "QString QLineEdit::text () const" -Returns the line edit's text. See the "text" property for details. -.SH "void QLineEdit::textChanged ( const QString & )\fC [signal]\fR" -This signal is emitted whenever the text changes. The argument is the new text. -.PP -Examples: -.)l simple/main.cpp, wizard/wizard.cpp, and xform/xform.cpp. -.SH "void QLineEdit::undo ()\fC [virtual slot]\fR" -Undoes the last operation if undo is available. Deselects any current selection, and updates the selection start to the current cursor position. -.SH "bool QLineEdit::validateAndSet ( const QString & newText, int newPos, int newMarkAnchor, int newMarkDrag )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use setText(), setCursorPosition() and setSelection() instead. -.SH "const QValidator * QLineEdit::validator () const" -Returns a pointer to the current input validator, or 0 if no validator has been set. -.PP -See also setValidator(). -.PP -Example: wizard/wizard.cpp. -.SS "Property Documentation" -.SH "bool acceptableInput" -This property holds whether the input satisfies the inputMask and the validator. -.PP -Get this property's value with hasAcceptableInput(). -.PP -See also inputMask and setValidator(). -.SH "Alignment alignment" -This property holds the alignment of the line edit. -.PP -Possible Values are Qt::AlignAuto, Qt::AlignLeft, Qt::AlignRight and Qt::AlignHCenter. -.PP -Attempting to set the alignment to an illegal flag combination does nothing. -.PP -See also Qt::AlignmentFlags. -.PP -Set this property's value with setAlignment() and get this property's value with alignment(). -.SH "int cursorPosition" -This property holds the current cursor position for this line edit. -.PP -Setting the cursor position causes a repaint when appropriate. -.PP -Set this property's value with setCursorPosition() and get this property's value with cursorPosition(). -.SH "QString displayText" -This property holds the displayed text. -.PP -If EchoMode is Normal this returns the same as text(); if EchoMode is Password it returns a string of asterisks text().length() characters long, e.g. "******"; if EchoMode is NoEcho returns an empty string, "". -.PP -See also echoMode, text, and EchoMode. -.PP -Get this property's value with displayText(). -.SH "bool dragEnabled" -This property holds whether the lineedit starts a drag if the user presses and moves the mouse on some selected text. -.PP -Set this property's value with setDragEnabled() and get this property's value with dragEnabled(). -.SH "EchoMode echoMode" -This property holds the line edit's echo mode. -.PP -The initial setting is Normal, but QLineEdit also supports NoEcho and Password modes. -.PP -The widget's display and the ability to copy or drag the text is affected by this setting. -.PP -See also EchoMode and displayText. -.PP -Set this property's value with setEchoMode() and get this property's value with echoMode(). -.SH "bool edited" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This property holds whether the line edit has been edited. Use modified instead. -.PP -Set this property's value with setEdited() and get this property's value with edited(). -.SH "bool frame" -This property holds whether the line edit draws itself with a frame. -.PP -If enabled (the default) the line edit draws itself inside a two-pixel frame, otherwise the line edit draws itself without any frame. -.PP -Set this property's value with setFrame() and get this property's value with frame(). -.SH "bool hasMarkedText" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This property holds whether part of the text has been selected by the user. Use hasSelectedText instead. -.PP -Get this property's value with hasMarkedText(). -.SH "bool hasSelectedText" -This property holds whether there is any text selected. -.PP -hasSelectedText() returns TRUE if some or all of the text has been selected by the user; otherwise returns FALSE. -.PP -See also selectedText. -.PP -Get this property's value with hasSelectedText(). -.SH "QString inputMask" -This property holds the validation input mask. -.PP -If no mask is set, inputMask() returns QString::null. -.PP -Sets the QLineEdit's validation mask. Validators can be used instead of, or in conjunction with masks; see setValidator(). -.PP -Unset the mask and return to normal QLineEdit operation by passing an empty string ("") or just calling setInputMask() with no arguments. -.PP -The mask format understands these mask characters:
                                    .nf -.TS -l - l. Character Meaning ASCII alphabetic character required. A-Z, a-z. ASCII alphabetic character permitted but not required. ASCII alphanumeric character required. A-Z, a-z, 0-9. ASCII alphanumeric character permitted but not required. Any character required. x Any character permitted but not required. ASCII digit required. 0-9. ASCII digit permitted but not required. ASCII digit required. 1-9. ASCII digit permitted but not required (1-9). ASCII digit or plus/minus sign permitted but not required. All following alphabetic characters are uppercased. All following alphabetic characters are lowercased. Switch off case conversion. Use -.TE -.fi -
                                    -.PP -The mask consists of a string of mask characters and separators, optionally followed by a semi-colon and the character used for blanks: the blank characters are always removed from the text after editing. The default blank character is space. -.PP -Examples: -.)l -
                                    .nf -.TS -l - l. Mask Notes IP address; blanks are ISO Date; blanks are License number; blanks are -.TE -.fi -
                                    -.PP -To get range control (e.g. for an IP address) use masks together with validators. -.PP -See also maxLength. -.PP -Set this property's value with setInputMask() and get this property's value with inputMask(). -.SH "QString markedText" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This property holds the text selected by the user. Use selectedText instead. -.PP -Get this property's value with markedText(). -.SH "int maxLength" -This property holds the maximum permitted length of the text. -.PP -If the text is too long, it is truncated at the limit. -.PP -If truncation occurs any selected text will be unselected, the cursor position is set to 0 and the first part of the string is shown. -.PP -If the line edit has an input mask, the mask defines the maximum string length. -.PP -See also inputMask. -.PP -Set this property's value with setMaxLength() and get this property's value with maxLength(). -.SH "bool modified" -This property holds whether the line edit's contents has been modified by the user. -.PP -The modified flag is never read by QLineEdit; it has a default value of FALSE and is changed to TRUE whenever the user changes the line edit's contents. -.PP -This is useful for things that need to provide a default value but do not start out knowing what the default should be (perhaps it depends on other fields on the form). Start the line edit without the best default, and when the default is known, if modified() returns FALSE (the user hasn't entered any text), insert the default value. -.PP -Calling clearModified() or setText() resets the modified flag to FALSE. -.PP -Get this property's value with isModified(). -.SH "bool readOnly" -This property holds whether the line edit is read only. -.PP -In read-only mode, the user can still copy the text to the clipboard or drag-and-drop the text (if echoMode() is Normal), but cannot edit it. -.PP -QLineEdit does not show a cursor in read-only mode. -.PP -See also enabled. -.PP -Set this property's value with setReadOnly() and get this property's value with isReadOnly(). -.SH "bool redoAvailable" -This property holds whether redo is available. -.PP -Get this property's value with isRedoAvailable(). -.SH "QString selectedText" -This property holds the selected text. -.PP -If there is no selected text this property's value is QString::null. -.PP -See also hasSelectedText. -.PP -Get this property's value with selectedText(). -.SH "QString text" -This property holds the line edit's text. -.PP -Note that setting this property clears the selection, clears the undo/redo history, moves the cursor to the end of the line and resets the modified property to FALSE. The text is not validated when inserted with setText(). -.PP -The text is truncated to maxLength() length. -.PP -See also insert(). -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "bool undoAvailable" -This property holds whether undo is available. -.PP -Get this property's value with isUndoAvailable(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlineedit.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlineedit.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlistbox.3qt b/doc/man/man3/qlistbox.3qt deleted file mode 100644 index 7748489b5..000000000 --- a/doc/man/man3/qlistbox.3qt +++ /dev/null @@ -1,1110 +0,0 @@ -'\" t -.TH QListBox 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 -QListBox \- List of selectable, read-only items -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QScrollView. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQListBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QListBox\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "void \fBinsertStringList\fR ( const QStringList & list, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertStrList\fR ( const QStrList * list, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertStrList\fR ( const QStrList & list, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertStrList\fR ( const char ** strings, int numStrings = -1, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QListBoxItem * lbi, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QListBoxItem * lbi, const QListBoxItem * after )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QString & text, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, const QString & text, int index = -1 )" -.br -.ti -1c -.BI "void \fBremoveItem\fR ( int index )" -.br -.ti -1c -.BI "QString \fBtext\fR ( int index ) const" -.br -.ti -1c -.BI "const QPixmap * \fBpixmap\fR ( int index ) const" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( const QListBoxItem * lbi, int index )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( const QString & text, int index )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( const QPixmap & pixmap, int index )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( const QPixmap & pixmap, const QString & text, int index )" -.br -.ti -1c -.BI "void \fBtakeItem\fR ( const QListBoxItem * item )" -.br -.ti -1c -.BI "int \fBnumItemsVisible\fR () const" -.br -.ti -1c -.BI "int \fBcurrentItem\fR () const" -.br -.ti -1c -.BI "QString \fBcurrentText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCurrentItem\fR ( int index )" -.br -.ti -1c -.BI "virtual void \fBsetCurrentItem\fR ( QListBoxItem * i )" -.br -.ti -1c -.BI "void centerCurrentItem () \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBtopItem\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTopItem\fR ( int index )" -.br -.ti -1c -.BI "virtual void \fBsetBottomItem\fR ( int index )" -.br -.ti -1c -.BI "long \fBmaxItemWidth\fR () const" -.br -.ti -1c -.BI "enum \fBSelectionMode\fR { Single, Multi, Extended, NoSelection }" -.br -.ti -1c -.BI "virtual void \fBsetSelectionMode\fR ( SelectionMode )" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR () const" -.br -.ti -1c -.BI "void setMultiSelection ( bool multi ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isMultiSelection () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void \fBsetSelected\fR ( QListBoxItem * item, bool select )" -.br -.ti -1c -.BI "void \fBsetSelected\fR ( int index, bool select )" -.br -.ti -1c -.BI "bool \fBisSelected\fR ( int i ) const" -.br -.ti -1c -.BI "bool \fBisSelected\fR ( const QListBoxItem * i ) const" -.br -.ti -1c -.BI "QListBoxItem * \fBselectedItem\fR () const" -.br -.ti -1c -.BI "QListBoxItem * \fBitem\fR ( int index ) const" -.br -.ti -1c -.BI "int \fBindex\fR ( const QListBoxItem * lbi ) const" -.br -.ti -1c -.BI "QListBoxItem * \fBfindItem\fR ( const QString & text, ComparisonFlags compare = BeginsWith ) const" -.br -.ti -1c -.BI "void \fBtriggerUpdate\fR ( bool doLayout )" -.br -.ti -1c -.BI "bool \fBitemVisible\fR ( int index )" -.br -.ti -1c -.BI "bool \fBitemVisible\fR ( const QListBoxItem * item )" -.br -.ti -1c -.BI "enum \fBLayoutMode\fR { FixedNumber, FitToWidth, FitToHeight = FitToWidth, Variable }" -.br -.ti -1c -.BI "virtual void \fBsetColumnMode\fR ( LayoutMode )" -.br -.ti -1c -.BI "virtual void \fBsetColumnMode\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBsetRowMode\fR ( LayoutMode )" -.br -.ti -1c -.BI "virtual void \fBsetRowMode\fR ( int )" -.br -.ti -1c -.BI "LayoutMode \fBcolumnMode\fR () const" -.br -.ti -1c -.BI "LayoutMode \fBrowMode\fR () const" -.br -.ti -1c -.BI "int \fBnumColumns\fR () const" -.br -.ti -1c -.BI "int \fBnumRows\fR () const" -.br -.ti -1c -.BI "bool \fBvariableWidth\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetVariableWidth\fR ( bool )" -.br -.ti -1c -.BI "bool \fBvariableHeight\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetVariableHeight\fR ( bool )" -.br -.ti -1c -.BI "bool autoScrollBar () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setAutoScrollBar ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool scrollBar () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setScrollBar ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool autoBottomScrollBar () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setAutoBottomScrollBar ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool bottomScrollBar () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setBottomScrollBar ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int inSort ( const QListBoxItem * lbi ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int inSort ( const QString & text ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int cellHeight ( int i ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int cellHeight () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int cellWidth () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int numCols () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBitemHeight\fR ( int index = 0 ) const" -.br -.ti -1c -.BI "QListBoxItem * \fBitemAt\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "QRect \fBitemRect\fR ( QListBoxItem * item ) const" -.br -.ti -1c -.BI "QListBoxItem * \fBfirstItem\fR () const" -.br -.ti -1c -.BI "void \fBsort\fR ( bool ascending = TRUE )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBensureCurrentVisible\fR ()" -.br -.ti -1c -.BI "virtual void \fBclearSelection\fR ()" -.br -.ti -1c -.BI "virtual void \fBselectAll\fR ( bool select )" -.br -.ti -1c -.BI "virtual void \fBinvertSelection\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBhighlighted\fR ( int index )" -.br -.ti -1c -.BI "void \fBselected\fR ( int index )" -.br -.ti -1c -.BI "void \fBhighlighted\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBselected\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBhighlighted\fR ( QListBoxItem * )" -.br -.ti -1c -.BI "void \fBselected\fR ( QListBoxItem * )" -.br -.ti -1c -.BI "void \fBselectionChanged\fR ()" -.br -.ti -1c -.BI "void \fBselectionChanged\fR ( QListBoxItem * item )" -.br -.ti -1c -.BI "void \fBcurrentChanged\fR ( QListBoxItem * item )" -.br -.ti -1c -.BI "void \fBclicked\fR ( QListBoxItem * item )" -.br -.ti -1c -.BI "void \fBclicked\fR ( QListBoxItem * item, const QPoint & pnt )" -.br -.ti -1c -.BI "void \fBpressed\fR ( QListBoxItem * item )" -.br -.ti -1c -.BI "void \fBpressed\fR ( QListBoxItem * item, const QPoint & pnt )" -.br -.ti -1c -.BI "void \fBdoubleClicked\fR ( QListBoxItem * item )" -.br -.ti -1c -.BI "void \fBreturnPressed\fR ( QListBoxItem * )" -.br -.ti -1c -.BI "void \fBrightButtonClicked\fR ( QListBoxItem *, const QPoint & )" -.br -.ti -1c -.BI "void \fBrightButtonPressed\fR ( QListBoxItem *, const QPoint & )" -.br -.ti -1c -.BI "void \fBmouseButtonPressed\fR ( int button, QListBoxItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBmouseButtonClicked\fR ( int button, QListBoxItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBcontextMenuRequested\fR ( QListBoxItem * item, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBonItem\fR ( QListBoxItem * i )" -.br -.ti -1c -.BI "void \fBonViewport\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "LayoutMode \fBcolumnMode\fR - the column layout mode for this list box" -.br -.ti -1c -.BI "uint \fBcount\fR - the number of items in the list box \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcurrentItem\fR - the current highlighted item" -.br -.ti -1c -.BI "QString \fBcurrentText\fR - the text of the current item \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool multiSelection - whether or not the list box is in Multi selection mode \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBnumColumns\fR - the number of columns in the list box \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBnumItemsVisible\fR - the number of visible items \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBnumRows\fR - the number of rows in the list box \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "LayoutMode \fBrowMode\fR - the row layout mode for this list box" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR - the selection mode of the list box" -.br -.ti -1c -.BI "int \fBtopItem\fR - the index of an item at the top of the screen" -.br -.ti -1c -.BI "bool \fBvariableHeight\fR - whether this list box has variable-height rows" -.br -.ti -1c -.BI "bool \fBvariableWidth\fR - whether this list box has variable-width columns" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBupdateItem\fR ( int index )" -.br -.ti -1c -.BI "void \fBupdateItem\fR ( QListBoxItem * i )" -.br -.ti -1c -.BI "int totalWidth () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int totalHeight () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col )" -.br -.ti -1c -.BI "void \fBtoggleCurrentItem\fR ()" -.br -.ti -1c -.BI "bool \fBisRubberSelecting\fR () const" -.br -.ti -1c -.BI "void \fBdoLayout\fR () const" -.br -.ti -1c -.BI "bool itemYPos ( int index, int * yPos ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int findItem ( int yPos ) const \fI(obsolete)\fR" -.br -.in -1c -.SH DESCRIPTION -The QListBox widget provides a list of selectable, read-only items. -.PP -This is typically a single-column list in which either no item or one item is selected, but it can also be used in many other ways. -.PP -QListBox will add scroll bars as necessary, but it isn't intended for \fIreally\fR big lists. If you want more than a few thousand items, it's probably better to use a different widget mainly because the scroll bars won't provide very good navigation, but also because QListBox may become slow with huge lists. (See QListView and QTable for possible alternatives.) -.PP -There are a variety of selection modes described in the QListBox::SelectionMode documentation. The default is Single selection mode, but you can change it using setSelectionMode(). (setMultiSelection() is still provided for compatibility with Qt 1.x. We recommend using setSelectionMode() in all code.) -.PP -Because QListBox offers multiple selection it must display keyboard focus and selection state separately. Therefore there are functions both to set the selection state of an item, i.e. setSelected(), and to set which item displays keyboard focus, i.e. setCurrentItem(). -.PP -The list box normally arranges its items in a single column and adds a vertical scroll bar if required. It is possible to have a different fixed number of columns (setColumnMode()), or as many columns as will fit in the list box's assigned screen space (setColumnMode(FitToWidth)), or to have a fixed number of rows (setRowMode()) or as many rows as will fit in the list box's assigned screen space (setRowMode(FitToHeight)). In all these cases QListBox will add scroll bars, as appropriate, in at least one direction. -.PP -If multiple rows are used, each row can be as high as necessary (the normal setting), or you can request that all items will have the same height by calling setVariableHeight(FALSE). The same applies to a column's width, see setVariableWidth(). -.PP -The QListBox's items are QListBoxItem objects. QListBox provides methods to insert new items as strings, as pixmaps, and as QListBoxItem * (insertItem() with various arguments), and to replace an existing item with a new string, pixmap or QListBoxItem (changeItem() with various arguments). You can also remove items singly with removeItem() or clear() the entire list box. Note that if you create a QListBoxItem yourself and insert it, QListBox takes ownership of the item. -.PP -You can also create a QListBoxItem, such as QListBoxText or QListBoxPixmap, with the list box as first parameter. The item will then append itself. When you delete an item it is automatically removed from the list box. -.PP -The list of items can be arbitrarily large; QListBox will add scroll bars if necessary. QListBox can display a single-column (the common case) or multiple-columns, and offers both single and multiple selection. QListBox does not support multiple-column items (but QListView and QTable do), or tree hierarchies (but QListView does). -.PP -The list box items can be accessed both as QListBoxItem objects (recommended) and using integer indexes (the original QListBox implementation used an array of strings internally, and the API still supports this mode of operation). Everything can be done using the new objects, and most things can be done using indexes. -.PP -Each item in a QListBox contains a QListBoxItem. One of the items can be the current item. The currentChanged() signal and the highlighted() signal are emitted when a new item becomes current, e.g. because the user clicks on it or QListBox::setCurrentItem() is called. The selected() signal is emitted when the user double-clicks on an item or presses Enter on the current item. -.PP -If the user does not select anything, no signals are emitted and currentItem() returns -1. -.PP -A list box has WheelFocus as a default focusPolicy(), i.e. it can get keyboard focus by tabbing, clicking and through the use of the mouse wheel. -.PP -New items can be inserted using insertItem(), insertStrList() or insertStringList(). inSort() is obsolete because this method is quite inefficient. It's preferable to insert the items normally and call sort() afterwards, or to insert a sorted QStringList(). -.PP -By default, vertical and horizontal scroll bars are added and removed as necessary. setHScrollBarMode() and setVScrollBarMode() can be used to change this policy. -.PP -If you need to insert types other than strings and pixmaps, you must define new classes which inherit QListBoxItem. -.PP -\fBWarning:\fR The list box assumes ownership of all list box items and will delete them when it does not need them any more. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QListView, QComboBox, QButtonGroup, GUI Design Handbook: List Box (two sections), and Advanced Widgets. -.SS "Member Type Documentation" -.SH "QListBox::LayoutMode" -This enum type is used to specify how QListBox lays out its rows and columns. -.TP -\fCQListBox::FixedNumber\fR - There is a fixed number of rows (or columns). -.TP -\fCQListBox::FitToWidth\fR - There are as many columns as will fit on-screen. -.TP -\fCQListBox::FitToHeight\fR - There are as many rows as will fit on-screen. -.TP -\fCQListBox::Variable\fR - There are as many rows as are required by the column mode. (Or as many columns as required by the row mode.) -.PP -Example: When you call setRowMode( FitToHeight ), columnMode() automatically becomes Variable to accommodate the row mode you've set. -.SH "QListBox::SelectionMode" -This enumerated type is used by QListBox to indicate how it reacts to selection by the user. -.TP -\fCQListBox::Single\fR - When the user selects an item, any already-selected item becomes unselected and the user cannot unselect the selected item. This means that the user can never clear the selection, even though the selection may be cleared by the application programmer using QListBox::clearSelection(). -.TP -\fCQListBox::Multi\fR - When the user selects an item the selection status of that item is toggled and the other items are left alone. Also, multiple items can be selected by dragging the mouse while the left mouse button is kept pressed. -.TP -\fCQListBox::Extended\fR - When the user selects an item the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. And if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item get selected or unselected, depending on the state of the clicked item. Also, multiple items can be selected by dragging the mouse while the left mouse button is kept pressed. -.TP -\fCQListBox::NoSelection\fR - Items cannot be selected. -.PP -In other words, Single is a real single-selection list box, Multi is a real multi-selection list box, Extended is a list box in which users can select multiple items but usually want to select either just one or a range of contiguous items, and NoSelection is for a list box where the user can look but not touch. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QListBox::QListBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a new empty list box called \fIname\fR and with parent \fIparent\fR. -.PP -Performance is boosted by modifying the widget flags \fIf\fR so that only part of the QListBoxItem children is redrawn. This may be unsuitable for custom QListBoxItem classes, in which case WStaticContents and WNoAutoErase should be cleared immediately after construction. -.PP -See also QWidget::clearWFlags() and Qt::WidgetFlags. -.SH "QListBox::~QListBox ()" -Destroys the list box. Deletes all list box items. -.SH "bool QListBox::autoBottomScrollBar () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if hScrollBarMode() is Auto; otherwise returns FALSE. -.SH "bool QListBox::autoScrollBar () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if vScrollBarMode() is Auto; otherwise returns FALSE. -.SH "bool QListBox::bottomScrollBar () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns FALSE if vScrollBarMode() is AlwaysOff; otherwise returns TRUE. -.SH "int QListBox::cellHeight ( int i ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the item height of item \fIi\fR. -.PP -See also itemHeight(). -.SH "int QListBox::cellHeight () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the item height of the first item, item 0. -.PP -See also itemHeight(). -.SH "int QListBox::cellWidth () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the maximum item width. -.PP -See also maxItemWidth(). -.SH "void QListBox::centerCurrentItem ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function does exactly the same as ensureCurrentVisible() -.PP -See also QListBox::ensureCurrentVisible(). -.SH "void QListBox::changeItem ( const QListBoxItem * lbi, int index )" -Replaces the item at position \fIindex\fR with \fIlbi\fR. If \fIindex\fR is negative or too large, changeItem() does nothing. -.PP -The item that has been changed will become selected. -.PP -See also insertItem() and removeItem(). -.SH "void QListBox::changeItem ( const QString & text, int index )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces the item at position \fIindex\fR with a new list box text item with text \fItext\fR. -.PP -The operation is ignored if \fIindex\fR is out of range. -.PP -See also insertItem() and removeItem(). -.SH "void QListBox::changeItem ( const QPixmap & pixmap, int index )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces the item at position \fIindex\fR with a new list box pixmap item with pixmap \fIpixmap\fR. -.PP -The operation is ignored if \fIindex\fR is out of range. -.PP -See also insertItem() and removeItem(). -.SH "void QListBox::changeItem ( const QPixmap & pixmap, const QString & text, int index )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces the item at position \fIindex\fR with a new list box pixmap item with pixmap \fIpixmap\fR and text \fItext\fR. -.PP -The operation is ignored if \fIindex\fR is out of range. -.PP -See also insertItem() and removeItem(). -.SH "void QListBox::clear ()\fC [slot]\fR" -Deletes all the items in the list. -.PP -See also removeItem(). -.SH "void QListBox::clearSelection ()\fC [virtual slot]\fR" -Deselects all items, if possible. -.PP -Note that a Single selection list box will automatically select an item if it has keyboard focus. -.PP -Example: listbox/listbox.cpp. -.SH "void QListBox::clicked ( QListBoxItem * item )\fC [signal]\fR" -This signal is emitted when the user clicks any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. -.PP -Note that you must not delete any QListBoxItem objects in slots connected to this signal. -.SH "void QListBox::clicked ( QListBoxItem * item, const QPoint & pnt )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user clicks any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. -.PP -\fIpnt\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differs by a pixel or two, \fIpnt\fR is the position at release time.) -.PP -Note that you must not delete any QListBoxItem objects in slots connected to this signal. -.SH "LayoutMode QListBox::columnMode () const" -Returns the column layout mode for this list box. See the "columnMode" property for details. -.SH "void QListBox::contextMenuRequested ( QListBoxItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user invokes a context menu with the right mouse button or with special system keys, with \fIitem\fR being the item under the mouse cursor or the current item, respectively. -.PP -\fIpos\fR is the position for the context menu in the global coordinate system. -.SH "uint QListBox::count () const" -Returns the number of items in the list box. See the "count" property for details. -.SH "void QListBox::currentChanged ( QListBoxItem * item )\fC [signal]\fR" -This signal is emitted when the user makes a new item the current item. \fIitem\fR is the new current list box item. -.PP -See also currentItem and currentItem. -.SH "int QListBox::currentItem () const" -Returns the current highlighted item. See the "currentItem" property for details. -.SH "QString QListBox::currentText () const" -Returns the text of the current item. See the "currentText" property for details. -.SH "void QListBox::doLayout () const\fC [protected]\fR" -This function does the hard layout work. You should never need to call it. -.SH "void QListBox::doubleClicked ( QListBoxItem * item )\fC [signal]\fR" -This signal is emitted whenever an item is double-clicked. It's emitted on the second button press, not the second button release. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. -.SH "void QListBox::ensureCurrentVisible ()\fC [virtual slot]\fR" -Ensures that the current item is visible. -.SH "QListBoxItem * QListBox::findItem ( const QString & text, ComparisonFlags compare = BeginsWith ) const" -Finds the first list box item that has the text \fItext\fR and returns it, or returns 0 of no such item could be found. The search starts from the current item if the current item exists, otherwise it starts from the first list box item. If \fCComparisonFlags\fR are specified in \fIcompare\fR then these flags are used, otherwise the default is a case-insensitive, "begins with" search. -.PP -See also Qt::StringComparisonMode. -.SH "int QListBox::findItem ( int yPos ) const\fC [protected]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the index of the item a point (0, \fIyPos\fR). -.PP -See also index() and itemAt(). -.SH "QListBoxItem * QListBox::firstItem () const" -Returns the first item in this list box. If the list box is empty, returns 0. -.SH "void QListBox::highlighted ( int index )\fC [signal]\fR" -This signal is emitted when the user makes a new item the current item. \fIindex\fR is the index of the new current item. -.PP -See also currentChanged(), selected(), currentItem, and selectionChanged(). -.SH "void QListBox::highlighted ( const QString & )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user makes a new item the current item and the item is (or has) a string. The argument is the text of the new current item. -.PP -See also currentChanged(), selected(), currentItem, and selectionChanged(). -.SH "void QListBox::highlighted ( QListBoxItem * )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user makes a new item the current item. The argument is a pointer to the new current item. -.PP -See also currentChanged(), selected(), currentItem, and selectionChanged(). -.SH "int QListBox::inSort ( const QListBoxItem * lbi )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Using this method is quite inefficient. We suggest to use insertItem() for inserting and sort() afterwards. -.PP -Inserts \fIlbi\fR at its sorted position in the list box and returns the position. -.PP -All items must be inserted with inSort() to maintain the sorting order. inSort() treats any pixmap (or user-defined type) as lexicographically less than any string. -.PP -See also insertItem() and sort(). -.SH "int QListBox::inSort ( const QString & text )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Using this method is quite inefficient. We suggest to use insertItem() for inserting and sort() afterwards. -.PP -Inserts a new item of \fItext\fR at its sorted position in the list box and returns the position. -.PP -All items must be inserted with inSort() to maintain the sorting order. inSort() treats any pixmap (or user-defined type) as lexicographically less than any string. -.PP -See also insertItem() and sort(). -.SH "int QListBox::index ( const QListBoxItem * lbi ) const" -Returns the index of \fIlbi\fR, or -1 if the item is not in this list box or \fIlbi\fR is 0. -.PP -See also item(). -.SH "void QListBox::insertItem ( const QListBoxItem * lbi, int index = -1 )" -Inserts the item \fIlbi\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative or larger than the number of items in the list box, \fIlbi\fR is inserted at the end of the list. -.PP -See also insertStrList(). -.PP -Examples: -.)l i18n/mywidget.cpp, listbox/listbox.cpp, listboxcombo/listboxcombo.cpp, and tabdialog/tabdialog.cpp. -.SH "void QListBox::insertItem ( const QListBoxItem * lbi, const QListBoxItem * after )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the item \fIlbi\fR into the list after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. -.PP -See also insertStrList(). -.SH "void QListBox::insertItem ( const QString & text, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a new list box text item with the text \fItext\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative, \fItext\fR is inserted at the end of the list. -.PP -See also insertStrList(). -.SH "void QListBox::insertItem ( const QPixmap & pixmap, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a new list box pixmap item with the pixmap \fIpixmap\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative, \fIpixmap\fR is inserted at the end of the list. -.PP -See also insertStrList(). -.SH "void QListBox::insertItem ( const QPixmap & pixmap, const QString & text, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a new list box pixmap item with the pixmap \fIpixmap\fR and the text \fItext\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative, \fIpixmap\fR is inserted at the end of the list. -.PP -See also insertStrList(). -.SH "void QListBox::insertStrList ( const QStrList * list, int index = -1 )" -Inserts the string list \fIlist\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative, \fIlist\fR is inserted at the end of the list. If \fIindex\fR is too large, the operation is ignored. -.PP -\fBWarning:\fR This function uses \fCconst char *\fR rather than QString, so we recommend against using it. It is provided so that legacy code will continue to work, and so that programs that certainly will not need to handle code outside a single 8-bit locale can use it. See insertStringList() which uses real QStrings. -.PP -\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). -.PP -See also insertItem() and insertStringList(). -.SH "void QListBox::insertStrList ( const QStrList & list, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the string list \fIlist\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative, \fIlist\fR is inserted at the end of the list. If \fIindex\fR is too large, the operation is ignored. -.PP -\fBWarning:\fR This function uses \fCconst char *\fR rather than QString, so we recommend against using it. It is provided so that legacy code will continue to work, and so that programs that certainly will not need to handle code outside a single 8-bit locale can use it. See insertStringList() which uses real QStrings. -.PP -\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). -.PP -See also insertItem() and insertStringList(). -.SH "void QListBox::insertStrList ( const char ** strings, int numStrings = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the \fInumStrings\fR strings of the array \fIstrings\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative, insertStrList() inserts \fIstrings\fR at the end of the list. If \fIindex\fR is too large, the operation is ignored. -.PP -\fBWarning:\fR This function uses \fCconst char *\fR rather than QString, so we recommend against using it. It is provided so that legacy code will continue to work, and so that programs that certainly will not need to handle code outside a single 8-bit locale can use it. See insertStringList() which uses real QStrings. -.PP -\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). -.PP -See also insertItem() and insertStringList(). -.SH "void QListBox::insertStringList ( const QStringList & list, int index = -1 )" -Inserts the string list \fIlist\fR into the list at position \fIindex\fR. -.PP -If \fIindex\fR is negative, \fIlist\fR is inserted at the end of the list. If \fIindex\fR is too large, the operation is ignored. -.PP -\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). -.PP -See also insertItem() and insertStrList(). -.SH "void QListBox::invertSelection ()\fC [virtual slot]\fR" -Inverts the selection. Only works in Multi and Extended selection mode. -.SH "bool QListBox::isMultiSelection () const" -Returns TRUE if or not the list box is in Multi selection mode; otherwise returns FALSE. See the "multiSelection" property for details. -.SH "bool QListBox::isRubberSelecting () const\fC [protected]\fR" -Returns TRUE if the user is selecting items using a rubber band rectangle; otherwise returns FALSE. -.SH "bool QListBox::isSelected ( int i ) const" -Returns TRUE if item \fIi\fR is selected; otherwise returns FALSE. -.SH "bool QListBox::isSelected ( const QListBoxItem * i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if item \fIi\fR is selected; otherwise returns FALSE. -.SH "QListBoxItem * QListBox::item ( int index ) const" -Returns a pointer to the item at position \fIindex\fR, or 0 if \fIindex\fR is out of bounds. -.PP -See also index(). -.PP -Example: listboxcombo/listboxcombo.cpp. -.SH "QListBoxItem * QListBox::itemAt ( const QPoint & p ) const" -Returns the item at point \fIp\fR, specified in viewport coordinates, or a 0 if there is no item at \fIp\fR. -.PP -Use contentsToViewport() to convert between widget coordinates and viewport coordinates. -.SH "int QListBox::itemHeight ( int index = 0 ) const" -Returns the height in pixels of the item with index \fIindex\fR. \fIindex\fR defaults to 0. -.PP -If \fIindex\fR is too large, this function returns 0. -.SH "QRect QListBox::itemRect ( QListBoxItem * item ) const" -Returns the rectangle on the screen that \fIitem\fR occupies in viewport()'s coordinates, or an invalid rectangle if \fIitem\fR is 0 or is not currently visible. -.SH "bool QListBox::itemVisible ( int index )" -Returns TRUE if the item at position \fIindex\fR is at least partly visible; otherwise returns FALSE. -.SH "bool QListBox::itemVisible ( const QListBoxItem * item )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIitem\fR is at least partly visible; otherwise returns FALSE. -.SH "bool QListBox::itemYPos ( int index, int * yPos ) const\fC [protected]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the vertical pixel-coordinate in \fI*yPos\fR, of the list box item at position \fIindex\fR in the list. Returns FALSE if the item is outside the visible area. -.SH "long QListBox::maxItemWidth () const" -Returns the width of the widest item in the list box. -.SH "void QListBox::mouseButtonClicked ( int button, QListBoxItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user clicks mouse button \fIbutton\fR. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differs by a pixel or two, \fIpos\fR is the position at release time.) -.PP -Note that you must not delete any QListBoxItem objects in slots connected to this signal. -.SH "void QListBox::mouseButtonPressed ( int button, QListBoxItem * item, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user presses mouse button \fIbutton\fR. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. -.PP -\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). -.PP -Note that you must not delete any QListBoxItem objects in slots connected to this signal. -.SH "int QListBox::numCols () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the number of columns. -.PP -See also numColumns. -.SH "int QListBox::numColumns () const" -Returns the number of columns in the list box. See the "numColumns" property for details. -.SH "int QListBox::numItemsVisible () const" -Returns the number of visible items. See the "numItemsVisible" property for details. -.SH "int QListBox::numRows () const" -Returns the number of rows in the list box. See the "numRows" property for details. -.SH "void QListBox::onItem ( QListBoxItem * i )\fC [signal]\fR" -This signal is emitted when the user moves the mouse cursor onto an item, similar to the QWidget::enterEvent() function. \fIi\fR is the QListBoxItem that the mouse has moved on. -.SH "void QListBox::onViewport ()\fC [signal]\fR" -This signal is emitted when the user moves the mouse cursor from an item to an empty part of the list box. -.SH "void QListBox::paintCell ( QPainter * p, int row, int col )\fC [virtual protected]\fR" -Provided for compatibility with the old QListBox. We recommend using QListBoxItem::paint() instead. -.PP -Repaints the cell at \fIrow\fR, \fIcol\fR using painter \fIp\fR. -.SH "const QPixmap * QListBox::pixmap ( int index ) const" -Returns a pointer to the pixmap at position \fIindex\fR, or 0 if there is no pixmap there. -.PP -See also text(). -.SH "void QListBox::pressed ( QListBoxItem * item )\fC [signal]\fR" -This signal is emitted when the user presses any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. -.PP -Note that you must not delete any QListBoxItem objects in slots connected to this signal. -.SH "void QListBox::pressed ( QListBoxItem * item, const QPoint & pnt )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user presses any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. -.PP -\fIpnt\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). -.PP -Note that you must not delete any QListBoxItem objects in slots connected to this signal. -.PP -See also mouseButtonPressed(), rightButtonPressed(), and clicked(). -.SH "void QListBox::removeItem ( int index )" -Removes and deletes the item at position \fIindex\fR. If \fIindex\fR is equal to currentItem(), a new item becomes current and the currentChanged() and highlighted() signals are emitted. -.PP -See also insertItem() and clear(). -.SH "void QListBox::returnPressed ( QListBoxItem * )\fC [signal]\fR" -This signal is emitted when Enter or Return is pressed. The argument is currentItem(). -.SH "void QListBox::rightButtonClicked ( QListBoxItem *, const QPoint & )\fC [signal]\fR" -This signal is emitted when the right button is clicked (i.e. when it's released at the same point where it was pressed). The arguments are the relevant QListBoxItem (may be 0) and the point in global coordinates. -.SH "void QListBox::rightButtonPressed ( QListBoxItem *, const QPoint & )\fC [signal]\fR" -This signal is emitted when the right button is pressed. The arguments are the relevant QListBoxItem (may be 0) and the point in global coordinates. -.SH "LayoutMode QListBox::rowMode () const" -Returns the row layout mode for this list box. See the "rowMode" property for details. -.SH "bool QListBox::scrollBar () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns FALSE if vScrollBarMode() is AlwaysOff; otherwise returns TRUE. -.SH "void QListBox::selectAll ( bool select )\fC [virtual slot]\fR" -In Multi and Extended modes, this function sets all items to be selected if \fIselect\fR is TRUE, and to be unselected if \fIselect\fR is FALSE. -.PP -In Single and NoSelection modes, this function only changes the selection status of currentItem(). -.SH "void QListBox::selected ( int index )\fC [signal]\fR" -This signal is emitted when the user double-clicks on an item or presses Enter on the current item. \fIindex\fR is the index of the selected item. -.PP -See also currentChanged(), highlighted(), and selectionChanged(). -.SH "void QListBox::selected ( const QString & )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user double-clicks on an item or presses Enter on the current item, and the item is (or has) a string. The argument is the text of the selected item. -.PP -See also currentChanged(), highlighted(), and selectionChanged(). -.SH "void QListBox::selected ( QListBoxItem * )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the user double-clicks on an item or presses Enter on the current item. The argument is a pointer to the new selected item. -.PP -See also currentChanged(), highlighted(), and selectionChanged(). -.SH "QListBoxItem * QListBox::selectedItem () const" -Returns the selected item if the list box is in single-selection mode and an item is selected. -.PP -If no items are selected or the list box is in another selection mode this function returns 0. -.PP -See also setSelected() and multiSelection. -.SH "void QListBox::selectionChanged ()\fC [signal]\fR" -This signal is emitted when the selection set of a list box changes. This signal is emitted in each selection mode. If the user selects five items by drag-selecting, QListBox tries to emit just one selectionChanged() signal so the signal can be connected to computationally expensive slots. -.PP -See also selected() and currentItem. -.SH "void QListBox::selectionChanged ( QListBoxItem * item )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when the selection in a Single selection list box changes. \fIitem\fR is the newly selected list box item. -.PP -See also selected() and currentItem. -.SH "SelectionMode QListBox::selectionMode () const" -Returns the selection mode of the list box. See the "selectionMode" property for details. -.SH "void QListBox::setAutoBottomScrollBar ( bool enable )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -If \fIenable\fR is TRUE sets setHScrollBarMode() to AlwaysOn; otherwise sets setHScrollBarMode() to AlwaysOff. -.SH "void QListBox::setAutoScrollBar ( bool enable )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -If \fIenable\fR is TRUE sets setVScrollBarMode() to AlwaysOn; otherwise sets setVScrollBarMode() to AlwaysOff. -.SH "void QListBox::setBottomItem ( int index )\fC [virtual]\fR" -Scrolls the list box so the item at position \fIindex\fR in the list is displayed in the bottom row of the list box. -.PP -See also topItem. -.SH "void QListBox::setBottomScrollBar ( bool enable )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -If \fIenable\fR is TRUE sets setHScrollBarMode() to AlwaysOn; otherwise sets setHScrollBarMode() to AlwaysOff. -.SH "void QListBox::setColumnMode ( LayoutMode )\fC [virtual]\fR" -Sets the column layout mode for this list box. See the "columnMode" property for details. -.SH "void QListBox::setColumnMode ( int )\fC [virtual]\fR" -Sets the column layout mode for this list box. See the "columnMode" property for details. -.SH "void QListBox::setCurrentItem ( int index )\fC [virtual]\fR" -Sets the current highlighted item to \fIindex\fR. See the "currentItem" property for details. -.SH "void QListBox::setCurrentItem ( QListBoxItem * i )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the current item to the QListBoxItem \fIi\fR. -.SH "void QListBox::setMultiSelection ( bool multi )" -Sets whether or not the list box is in Multi selection mode to \fImulti\fR. See the "multiSelection" property for details. -.SH "void QListBox::setRowMode ( LayoutMode )\fC [virtual]\fR" -Sets the row layout mode for this list box. See the "rowMode" property for details. -.SH "void QListBox::setRowMode ( int )\fC [virtual]\fR" -Sets the row layout mode for this list box. See the "rowMode" property for details. -.SH "void QListBox::setScrollBar ( bool enable )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -If \fIenable\fR is TRUE sets setVScrollBarMode() to AlwaysOn; otherwise sets setVScrollBarMode() to AlwaysOff. -.SH "void QListBox::setSelected ( QListBoxItem * item, bool select )\fC [virtual]\fR" -Selects \fIitem\fR if \fIselect\fR is TRUE or unselects it if \fIselect\fR is FALSE, and repaints the item appropriately. -.PP -If the list box is a Single selection list box and \fIselect\fR is TRUE, setSelected() calls setCurrentItem(). -.PP -If the list box is a Single selection list box, \fIselect\fR is FALSE, setSelected() calls clearSelection(). -.PP -See also multiSelection, currentItem, clearSelection(), and currentItem. -.SH "void QListBox::setSelected ( int index, bool select )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -If \fIselect\fR is TRUE the item at position \fIindex\fR is selected; otherwise the item is deselected. -.SH "void QListBox::setSelectionMode ( SelectionMode )\fC [virtual]\fR" -Sets the selection mode of the list box. See the "selectionMode" property for details. -.SH "void QListBox::setTopItem ( int index )\fC [virtual]\fR" -Sets the index of an item at the top of the screen to \fIindex\fR. See the "topItem" property for details. -.SH "void QListBox::setVariableHeight ( bool )\fC [virtual]\fR" -Sets whether this list box has variable-height rows. See the "variableHeight" property for details. -.SH "void QListBox::setVariableWidth ( bool )\fC [virtual]\fR" -Sets whether this list box has variable-width columns. See the "variableWidth" property for details. -.SH "void QListBox::sort ( bool ascending = TRUE )" -If \fIascending\fR is TRUE sorts the items in ascending order; otherwise sorts in descending order. -.PP -To compare the items, the text (QListBoxItem::text()) of the items is used. -.PP -Example: listbox/listbox.cpp. -.SH "void QListBox::takeItem ( const QListBoxItem * item )" -Removes \fIitem\fR from the list box and causes an update of the screen display. The item is not deleted. You should normally not need to call this function because QListBoxItem::~QListBoxItem() calls it. The normal way to delete an item is with \fCdelete\fR. -.PP -See also QListBox::insertItem(). -.SH "QString QListBox::text ( int index ) const" -Returns the text at position \fIindex\fR, or QString::null if there is no text at that position. -.PP -See also pixmap(). -.SH "void QListBox::toggleCurrentItem ()\fC [protected]\fR" -Toggles the selection status of currentItem() and repaints if the list box is a Multi selection list box. -.PP -See also multiSelection. -.SH "int QListBox::topItem () const" -Returns the index of an item at the top of the screen. See the "topItem" property for details. -.SH "int QListBox::totalHeight () const\fC [protected]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns contentsHeight(). -.SH "int QListBox::totalWidth () const\fC [protected]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns contentsWidth(). -.SH "void QListBox::triggerUpdate ( bool doLayout )" -Ensures that a single paint event will occur at the end of the current event loop iteration. If \fIdoLayout\fR is TRUE, the layout is also redone. -.SH "void QListBox::updateItem ( int index )\fC [protected]\fR" -Repaints the item at position \fIindex\fR in the list. -.SH "void QListBox::updateItem ( QListBoxItem * i )\fC [protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Repaints the QListBoxItem \fIi\fR. -.SH "bool QListBox::variableHeight () const" -Returns TRUE if this list box has variable-height rows; otherwise returns FALSE. See the "variableHeight" property for details. -.SH "bool QListBox::variableWidth () const" -Returns TRUE if this list box has variable-width columns; otherwise returns FALSE. See the "variableWidth" property for details. -.SS "Property Documentation" -.SH "LayoutMode columnMode" -This property holds the column layout mode for this list box. -.PP -setColumnMode() sets the layout mode and adjusts the number of displayed columns. The row layout mode automatically becomes Variable, unless the column mode is Variable. -.PP -See also rowMode, rowMode, and numColumns. -.PP -Set this property's value with setColumnMode() and get this property's value with columnMode(). -.SH "uint count" -This property holds the number of items in the list box. -.PP -Get this property's value with count(). -.SH "int currentItem" -This property holds the current highlighted item. -.PP -When setting this property, the highlighting is moved to the item and the list box scrolled as necessary. -.PP -If no item is current, currentItem() returns -1. -.PP -Set this property's value with setCurrentItem() and get this property's value with currentItem(). -.SH "QString currentText" -This property holds the text of the current item. -.PP -This is equivalent to text(currentItem()). -.PP -Get this property's value with currentText(). -.SH "bool multiSelection" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This property holds whether or not the list box is in Multi selection mode. -.PP -Consider using the QListBox::selectionMode property instead of this property. -.PP -When setting this property, Multi selection mode is used if set to TRUE and to Single selection mode if set to FALSE. -.PP -When getting this property, TRUE is returned if the list box is in Multi selection mode or Extended selection mode, and FALSE if it is in Single selection mode or NoSelection mode. -.PP -See also selectionMode. -.PP -Set this property's value with setMultiSelection() and get this property's value with isMultiSelection(). -.SH "int numColumns" -This property holds the number of columns in the list box. -.PP -This is normally 1, but can be different if QListBox::columnMode or QListBox::rowMode has been set. -.PP -See also columnMode, rowMode, and numRows. -.PP -Get this property's value with numColumns(). -.SH "int numItemsVisible" -This property holds the number of visible items. -.PP -Both partially and entirely visible items are counted. -.PP -Get this property's value with numItemsVisible(). -.SH "int numRows" -This property holds the number of rows in the list box. -.PP -This is equal to the number of items in the default single-column layout, but can be different. -.PP -See also columnMode, rowMode, and numColumns. -.PP -Get this property's value with numRows(). -.SH "LayoutMode rowMode" -This property holds the row layout mode for this list box. -.PP -This property is normally Variable. -.PP -setRowMode() sets the layout mode and adjusts the number of displayed rows. The column layout mode automatically becomes Variable, unless the row mode is Variable. -.PP -See also columnMode. -.PP -Set this property's value with setRowMode() and get this property's value with rowMode(). -.SH "SelectionMode selectionMode" -This property holds the selection mode of the list box. -.PP -Sets the list box's selection mode, which may be one of Single (the default), Extended, Multi or NoSelection. -.PP -See also SelectionMode. -.PP -Set this property's value with setSelectionMode() and get this property's value with selectionMode(). -.SH "int topItem" -This property holds the index of an item at the top of the screen. -.PP -When getting this property and the listbox has multiple columns, an arbitrary item is selected and returned. -.PP -When setting this property, the list box is scrolled so the item at position \fIindex\fR in the list is displayed in the top row of the list box. -.PP -Set this property's value with setTopItem() and get this property's value with topItem(). -.SH "bool variableHeight" -This property holds whether this list box has variable-height rows. -.PP -When the list box has variable-height rows (the default), each row is as high as the highest item in that row. When it has same-sized rows, all rows are as high as the highest item in the list box. -.PP -See also variableWidth. -.PP -Set this property's value with setVariableHeight() and get this property's value with variableHeight(). -.SH "bool variableWidth" -This property holds whether this list box has variable-width columns. -.PP -When the list box has variable-width columns, each column is as wide as the widest item in that column. When it has same-sized columns (the default), all columns are as wide as the widest item in the list box. -.PP -See also variableHeight. -.PP -Set this property's value with setVariableWidth() and get this property's value with variableWidth(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlistbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlistbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlistboxitem.3qt b/doc/man/man3/qlistboxitem.3qt deleted file mode 100644 index ea9e3f896..000000000 --- a/doc/man/man3/qlistboxitem.3qt +++ /dev/null @@ -1,203 +0,0 @@ -'\" t -.TH QListBoxItem 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 -QListBoxItem \- The base class of all list box items -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QListBoxText and QListBoxPixmap. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQListBoxItem\fR ( QListBox * listbox = 0 )" -.br -.ti -1c -.BI "\fBQListBoxItem\fR ( QListBox * listbox, QListBoxItem * after )" -.br -.ti -1c -.BI "virtual \fB~QListBoxItem\fR ()" -.br -.ti -1c -.BI "virtual QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual const QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual int \fBheight\fR ( const QListBox * lb ) const" -.br -.ti -1c -.BI "virtual int \fBwidth\fR ( const QListBox * lb ) const" -.br -.ti -1c -.BI "bool \fBisSelected\fR () const" -.br -.ti -1c -.BI "bool \fBisCurrent\fR () const" -.br -.ti -1c -.BI "bool selected () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool current () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QListBox * \fBlistBox\fR () const" -.br -.ti -1c -.BI "void \fBsetSelectable\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisSelectable\fR () const" -.br -.ti -1c -.BI "QListBoxItem * \fBnext\fR () const" -.br -.ti -1c -.BI "QListBoxItem * \fBprev\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaint\fR ( QPainter * p ) = 0" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & text )" -.br -.ti -1c -.BI "void \fBsetCustomHighlighting\fR ( bool b )" -.br -.in -1c -.SH DESCRIPTION -The QListBoxItem class is the base class of all list box items. -.PP -This class is an abstract base class used for all list box items. If you need to insert customized items into a QListBox you must inherit this class and reimplement paint(), height() and width(). -.PP -See also QListBox. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QListBoxItem::QListBoxItem ( QListBox * listbox = 0 )" -Constructs an empty list box item in the list box \fIlistbox\fR. -.SH "QListBoxItem::QListBoxItem ( QListBox * listbox, QListBoxItem * after )" -Constructs an empty list box item in the list box \fIlistbox\fR and inserts it after the item \fIafter\fR or at the beginning if \fIafter\fR is 0. -.SH "QListBoxItem::~QListBoxItem ()\fC [virtual]\fR" -Destroys the list box item. -.SH "bool QListBoxItem::current () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "int QListBoxItem::height ( const QListBox * lb ) const\fC [virtual]\fR" -Implement this function to return the height of your item. The \fIlb\fR parameter is the same as listBox() and is provided for convenience and compatibility. -.PP -The default implementation returns QApplication::globalStrut()'s height. -.PP -See also paint() and width(). -.PP -Reimplemented in QListBoxText and QListBoxPixmap. -.SH "bool QListBoxItem::isCurrent () const" -Returns TRUE if the item is the current item; otherwise returns FALSE. -.PP -See also QListBox::currentItem, QListBox::item(), and isSelected(). -.SH "bool QListBoxItem::isSelectable () const" -Returns TRUE if this item is selectable (the default); otherwise returns FALSE. -.PP -See also setSelectable(). -.SH "bool QListBoxItem::isSelected () const" -Returns TRUE if the item is selected; otherwise returns FALSE. -.PP -See also QListBox::isSelected() and isCurrent(). -.PP -Example: listboxcombo/listboxcombo.cpp. -.SH "QListBox * QListBoxItem::listBox () const" -Returns a pointer to the list box containing this item. -.SH "QListBoxItem * QListBoxItem::next () const" -Returns the item that comes after this in the list box. If this is the last item, 0 is returned. -.PP -See also prev(). -.SH "void QListBoxItem::paint ( QPainter * p )\fC [pure virtual protected]\fR" -Implement this function to draw your item. The painter, \fIp\fR, is already open for painting. -.PP -See also height() and width(). -.PP -Example: listboxcombo/listboxcombo.cpp. -.PP -Reimplemented in QListBoxText and QListBoxPixmap. -.SH "const QPixmap * QListBoxItem::pixmap () const\fC [virtual]\fR" -Returns the pixmap associated with the item, or 0 if there isn't one. -.PP -The default implementation returns 0. -.PP -Example: listboxcombo/listboxcombo.cpp. -.PP -Reimplemented in QListBoxPixmap. -.SH "QListBoxItem * QListBoxItem::prev () const" -Returns the item which comes before this in the list box. If this is the first item, 0 is returned. -.PP -See also next(). -.SH "int QListBoxItem::rtti () const\fC [virtual]\fR" -Returns 0. -.PP -Make your derived classes return their own values for rtti(), and you can distinguish between listbox items. You should use values greater than 1000 preferably a large random number, to allow for extensions to this class. -.SH "bool QListBoxItem::selected () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QListBoxItem::setCustomHighlighting ( bool b )\fC [protected]\fR" -Defines whether the list box item is responsible for drawing itself in a highlighted state when being selected. -.PP -If \fIb\fR is FALSE (the default), the list box will draw some default highlight indicator before calling paint(). -.PP -See also selected() and paint(). -.SH "void QListBoxItem::setSelectable ( bool b )" -If \fIb\fR is TRUE (the default) then this item can be selected by the user; otherwise this item cannot be selected by the user. -.PP -See also isSelectable(). -.SH "void QListBoxItem::setText ( const QString & text )\fC [virtual protected]\fR" -Sets the text of the QListBoxItem to \fItext\fR. This \fItext\fR is also used for sorting. The text is not shown unless explicitly drawn in paint(). -.PP -See also text(). -.SH "QString QListBoxItem::text () const\fC [virtual]\fR" -Returns the text of the item. This text is also used for sorting. -.PP -See also setText(). -.PP -Example: listboxcombo/listboxcombo.cpp. -.SH "int QListBoxItem::width ( const QListBox * lb ) const\fC [virtual]\fR" -Reimplement this function to return the width of your item. The \fIlb\fR parameter is the same as listBox() and is provided for convenience and compatibility. -.PP -The default implementation returns QApplication::globalStrut()'s width. -.PP -See also paint() and height(). -.PP -Reimplemented in QListBoxText and QListBoxPixmap. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qlistboxitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlistboxitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlistboxpixmap.3qt b/doc/man/man3/qlistboxpixmap.3qt deleted file mode 100644 index d26b76f60..000000000 --- a/doc/man/man3/qlistboxpixmap.3qt +++ /dev/null @@ -1,120 +0,0 @@ -'\" t -.TH QListBoxPixmap 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 -QListBoxPixmap \- List box items with a pixmap and optional text -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QListBoxItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pixmap )" -.br -.ti -1c -.BI "\fBQListBoxPixmap\fR ( const QPixmap & pixmap )" -.br -.ti -1c -.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pixmap, QListBoxItem * after )" -.br -.ti -1c -.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pix, const QString & text )" -.br -.ti -1c -.BI "\fBQListBoxPixmap\fR ( const QPixmap & pix, const QString & text )" -.br -.ti -1c -.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pix, const QString & text, QListBoxItem * after )" -.br -.ti -1c -.BI "\fB~QListBoxPixmap\fR ()" -.br -.ti -1c -.BI "virtual const QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual int \fBheight\fR ( const QListBox * lb ) const" -.br -.ti -1c -.BI "virtual int \fBwidth\fR ( const QListBox * lb ) const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaint\fR ( QPainter * painter )" -.br -.in -1c -.SH DESCRIPTION -The QListBoxPixmap class provides list box items with a pixmap and optional text. -.PP -Items of this class are drawn with the pixmap on the left with the optional text to the right of the pixmap. -.PP -See also QListBox, QListBoxItem, and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pixmap )" -Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpixmap\fR. -.SH "QListBoxPixmap::QListBoxPixmap ( const QPixmap & pixmap )" -Constructs a new list box item showing the pixmap \fIpixmap\fR. -.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pixmap, QListBoxItem * after )" -Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpixmap\fR. The item gets inserted after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. -.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pix, const QString & text )" -Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpix\fR and the text \fItext\fR. -.SH "QListBoxPixmap::QListBoxPixmap ( const QPixmap & pix, const QString & text )" -Constructs a new list box item showing the pixmap \fIpix\fR and the text to \fItext\fR. -.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pix, const QString & text, QListBoxItem * after )" -Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpix\fR and the string \fItext\fR. The item gets inserted after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. -.SH "QListBoxPixmap::~QListBoxPixmap ()" -Destroys the item. -.SH "int QListBoxPixmap::height ( const QListBox * lb ) const\fC [virtual]\fR" -Returns the height of the pixmap in list box \fIlb\fR. -.PP -See also paint() and width(). -.PP -Reimplemented from QListBoxItem. -.SH "void QListBoxPixmap::paint ( QPainter * painter )\fC [virtual protected]\fR" -Draws the pixmap using \fIpainter\fR. -.PP -Reimplemented from QListBoxItem. -.SH "const QPixmap * QListBoxPixmap::pixmap () const\fC [virtual]\fR" -Returns the pixmap associated with the item. -.PP -Reimplemented from QListBoxItem. -.SH "int QListBoxPixmap::width ( const QListBox * lb ) const\fC [virtual]\fR" -Returns the width of the pixmap plus some margin in list box \fIlb\fR. -.PP -See also paint() and height(). -.PP -Reimplemented from QListBoxItem. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qlistboxpixmap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlistboxpixmap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlistboxtext.3qt b/doc/man/man3/qlistboxtext.3qt deleted file mode 100644 index 1d6b0a883..000000000 --- a/doc/man/man3/qlistboxtext.3qt +++ /dev/null @@ -1,98 +0,0 @@ -'\" t -.TH QListBoxText 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 -QListBoxText \- List box items that display text -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QListBoxItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQListBoxText\fR ( QListBox * listbox, const QString & text = QString::null )" -.br -.ti -1c -.BI "\fBQListBoxText\fR ( const QString & text = QString::null )" -.br -.ti -1c -.BI "\fBQListBoxText\fR ( QListBox * listbox, const QString & text, QListBoxItem * after )" -.br -.ti -1c -.BI "\fB~QListBoxText\fR ()" -.br -.ti -1c -.BI "virtual int \fBheight\fR ( const QListBox * lb ) const" -.br -.ti -1c -.BI "virtual int \fBwidth\fR ( const QListBox * lb ) const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaint\fR ( QPainter * painter )" -.br -.in -1c -.SH DESCRIPTION -The QListBoxText class provides list box items that display text. -.PP -The text is drawn in the widget's current font. If you need several different fonts, you must implement your own subclass of QListBoxItem. -.PP -See also QListBox, QListBoxItem, and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QListBoxText::QListBoxText ( QListBox * listbox, const QString & text = QString::null )" -Constructs a list box item in list box \fIlistbox\fR showing the text \fItext\fR. -.SH "QListBoxText::QListBoxText ( const QString & text = QString::null )" -Constructs a list box item showing the text \fItext\fR. -.SH "QListBoxText::QListBoxText ( QListBox * listbox, const QString & text, QListBoxItem * after )" -Constructs a list box item in list box \fIlistbox\fR showing the text \fItext\fR. The item is inserted after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. -.SH "QListBoxText::~QListBoxText ()" -Destroys the item. -.SH "int QListBoxText::height ( const QListBox * lb ) const\fC [virtual]\fR" -Returns the height of a line of text in list box \fIlb\fR. -.PP -See also paint() and width(). -.PP -Reimplemented from QListBoxItem. -.SH "void QListBoxText::paint ( QPainter * painter )\fC [virtual protected]\fR" -Draws the text using \fIpainter\fR. -.PP -Reimplemented from QListBoxItem. -.SH "int QListBoxText::width ( const QListBox * lb ) const\fC [virtual]\fR" -Returns the width of this line in list box \fIlb\fR. -.PP -See also paint() and height(). -.PP -Reimplemented from QListBoxItem. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qlistboxtext.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlistboxtext.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlistview.3qt b/doc/man/man3/qlistview.3qt deleted file mode 100644 index 1f3af2588..000000000 --- a/doc/man/man3/qlistview.3qt +++ /dev/null @@ -1,1108 +0,0 @@ -'\" t -.TH QListView 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 -QListView \- Implements a list/tree view -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QScrollView. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQListView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QListView\fR ()" -.br -.ti -1c -.BI "int \fBtreeStepSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTreeStepSize\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBinsertItem\fR ( QListViewItem * i )" -.br -.ti -1c -.BI "virtual void \fBtakeItem\fR ( QListViewItem * i )" -.br -.ti -1c -.BI "virtual void removeItem ( QListViewItem * item ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QHeader * \fBheader\fR () const" -.br -.ti -1c -.BI "virtual int \fBaddColumn\fR ( const QString & label, int width = -1 )" -.br -.ti -1c -.BI "virtual int \fBaddColumn\fR ( const QIconSet & iconset, const QString & label, int width = -1 )" -.br -.ti -1c -.BI "virtual void \fBremoveColumn\fR ( int index )" -.br -.ti -1c -.BI "virtual void \fBsetColumnText\fR ( int column, const QString & label )" -.br -.ti -1c -.BI "virtual void \fBsetColumnText\fR ( int column, const QIconSet & iconset, const QString & label )" -.br -.ti -1c -.BI "QString \fBcolumnText\fR ( int c ) const" -.br -.ti -1c -.BI "virtual void \fBsetColumnWidth\fR ( int column, int w )" -.br -.ti -1c -.BI "int \fBcolumnWidth\fR ( int c ) const" -.br -.ti -1c -.BI "enum \fBWidthMode\fR { Manual, Maximum }" -.br -.ti -1c -.BI "virtual void \fBsetColumnWidthMode\fR ( int c, WidthMode mode )" -.br -.ti -1c -.BI "WidthMode \fBcolumnWidthMode\fR ( int c ) const" -.br -.ti -1c -.BI "int \fBcolumns\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetColumnAlignment\fR ( int column, int align )" -.br -.ti -1c -.BI "int \fBcolumnAlignment\fR ( int column ) const" -.br -.ti -1c -.BI "QListViewItem * \fBitemAt\fR ( const QPoint & viewPos ) const" -.br -.ti -1c -.BI "QRect \fBitemRect\fR ( const QListViewItem * i ) const" -.br -.ti -1c -.BI "int \fBitemPos\fR ( const QListViewItem * item )" -.br -.ti -1c -.BI "void \fBensureItemVisible\fR ( const QListViewItem * i )" -.br -.ti -1c -.BI "void \fBrepaintItem\fR ( const QListViewItem * item ) const" -.br -.ti -1c -.BI "virtual void setMultiSelection ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isMultiSelection () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "enum \fBSelectionMode\fR { Single, Multi, Extended, NoSelection }" -.br -.ti -1c -.BI "void \fBsetSelectionMode\fR ( SelectionMode mode )" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBclearSelection\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetSelected\fR ( QListViewItem * item, bool selected )" -.br -.ti -1c -.BI "void \fBsetSelectionAnchor\fR ( QListViewItem * item )" -.br -.ti -1c -.BI "bool \fBisSelected\fR ( const QListViewItem * i ) const" -.br -.ti -1c -.BI "QListViewItem * \fBselectedItem\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetOpen\fR ( QListViewItem * item, bool open )" -.br -.ti -1c -.BI "bool \fBisOpen\fR ( const QListViewItem * item ) const" -.br -.ti -1c -.BI "virtual void \fBsetCurrentItem\fR ( QListViewItem * i )" -.br -.ti -1c -.BI "QListViewItem * \fBcurrentItem\fR () const" -.br -.ti -1c -.BI "QListViewItem * \fBfirstChild\fR () const" -.br -.ti -1c -.BI "QListViewItem * \fBlastItem\fR () const" -.br -.ti -1c -.BI "int \fBchildCount\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAllColumnsShowFocus\fR ( bool )" -.br -.ti -1c -.BI "bool \fBallColumnsShowFocus\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetItemMargin\fR ( int )" -.br -.ti -1c -.BI "int \fBitemMargin\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRootIsDecorated\fR ( bool )" -.br -.ti -1c -.BI "bool \fBrootIsDecorated\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSorting\fR ( int column, bool ascending = TRUE )" -.br -.ti -1c -.BI "int \fBsortColumn\fR () const" -.br -.ti -1c -.BI "void \fBsetSortColumn\fR ( int column )" -.br -.ti -1c -.BI "SortOrder \fBsortOrder\fR () const" -.br -.ti -1c -.BI "void \fBsetSortOrder\fR ( SortOrder order )" -.br -.ti -1c -.BI "virtual void \fBsort\fR ()" -.br -.ti -1c -.BI "virtual bool \fBeventFilter\fR ( QObject * o, QEvent * e )" -.br -.ti -1c -.BI "virtual void \fBsetShowSortIndicator\fR ( bool show )" -.br -.ti -1c -.BI "bool \fBshowSortIndicator\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetShowToolTips\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBshowToolTips\fR () const" -.br -.ti -1c -.BI "enum \fBResizeMode\fR { NoColumn, AllColumns, LastColumn }" -.br -.ti -1c -.BI "virtual void \fBsetResizeMode\fR ( ResizeMode m )" -.br -.ti -1c -.BI "ResizeMode \fBresizeMode\fR () const" -.br -.ti -1c -.BI "QListViewItem * \fBfindItem\fR ( const QString & text, int column, ComparisonFlags compare = ExactMatch | CaseSensitive ) const" -.br -.ti -1c -.BI "enum \fBRenameAction\fR { Accept, Reject }" -.br -.ti -1c -.BI "virtual void \fBsetDefaultRenameAction\fR ( RenameAction a )" -.br -.ti -1c -.BI "RenameAction \fBdefaultRenameAction\fR () const" -.br -.ti -1c -.BI "bool \fBisRenaming\fR () const" -.br -.ti -1c -.BI "void \fBhideColumn\fR ( int column )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBinvertSelection\fR ()" -.br -.ti -1c -.BI "virtual void \fBselectAll\fR ( bool select )" -.br -.ti -1c -.BI "void \fBtriggerUpdate\fR ()" -.br -.ti -1c -.BI "void \fBadjustColumn\fR ( int col )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBselectionChanged\fR ()" -.br -.ti -1c -.BI "void \fBselectionChanged\fR ( QListViewItem * )" -.br -.ti -1c -.BI "void \fBcurrentChanged\fR ( QListViewItem * )" -.br -.ti -1c -.BI "void \fBclicked\fR ( QListViewItem * item )" -.br -.ti -1c -.BI "void \fBclicked\fR ( QListViewItem * item, const QPoint & pnt, int c )" -.br -.ti -1c -.BI "void \fBpressed\fR ( QListViewItem * item )" -.br -.ti -1c -.BI "void \fBpressed\fR ( QListViewItem * item, const QPoint & pnt, int c )" -.br -.ti -1c -.BI "void doubleClicked ( QListViewItem * item ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBdoubleClicked\fR ( QListViewItem *, const QPoint &, int )" -.br -.ti -1c -.BI "void \fBreturnPressed\fR ( QListViewItem * )" -.br -.ti -1c -.BI "void \fBspacePressed\fR ( QListViewItem * )" -.br -.ti -1c -.BI "void \fBrightButtonClicked\fR ( QListViewItem *, const QPoint &, int )" -.br -.ti -1c -.BI "void \fBrightButtonPressed\fR ( QListViewItem *, const QPoint &, int )" -.br -.ti -1c -.BI "void \fBmouseButtonPressed\fR ( int button, QListViewItem * item, const QPoint & pos, int c )" -.br -.ti -1c -.BI "void \fBmouseButtonClicked\fR ( int button, QListViewItem * item, const QPoint & pos, int c )" -.br -.ti -1c -.BI "void \fBcontextMenuRequested\fR ( QListViewItem * item, const QPoint & pos, int col )" -.br -.ti -1c -.BI "void \fBonItem\fR ( QListViewItem * i )" -.br -.ti -1c -.BI "void \fBonViewport\fR ()" -.br -.ti -1c -.BI "void \fBexpanded\fR ( QListViewItem * item )" -.br -.ti -1c -.BI "void \fBcollapsed\fR ( QListViewItem * item )" -.br -.ti -1c -.BI "void \fBdropped\fR ( QDropEvent * e )" -.br -.ti -1c -.BI "void \fBitemRenamed\fR ( QListViewItem * item, int col, const QString & text )" -.br -.ti -1c -.BI "void \fBitemRenamed\fR ( QListViewItem * item, int col )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBallColumnsShowFocus\fR - whether items should show keyboard focus using all columns" -.br -.ti -1c -.BI "int \fBchildCount\fR - the number of parentless (top-level) QListViewItem objects in this QListView \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcolumns\fR - the number of columns in this list view \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "RenameAction \fBdefaultRenameAction\fR - what action to perform when the editor loses focus during renaming" -.br -.ti -1c -.BI "int \fBitemMargin\fR - the advisory item margin that list items may use" -.br -.ti -1c -.BI "bool multiSelection - whether the list view is in multi-selection or extended-selection mode \fI(obsolete)\fR" -.br -.ti -1c -.BI "ResizeMode \fBresizeMode\fR - whether " "all" ", none or the only the last column should be resized" -.br -.ti -1c -.BI "bool \fBrootIsDecorated\fR - whether the list view shows open/close signs on root items" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR - the list view's selection mode" -.br -.ti -1c -.BI "bool \fBshowSortIndicator\fR - whether the list view header should display a sort indicator" -.br -.ti -1c -.BI "bool \fBshowToolTips\fR - whether this list view should show tooltips for truncated column texts" -.br -.ti -1c -.BI "int \fBtreeStepSize\fR - the number of pixels a child is offset from its parent" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBcontentsMousePressEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsMouseReleaseEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsMouseMoveEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsMouseDoubleClickEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual QDragObject * \fBdragObject\fR ()" -.br -.ti -1c -.BI "virtual void \fBstartDrag\fR ()" -.br -.ti -1c -.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * e )" -.br -.ti -1c -.BI "virtual void \fBdrawContentsOffset\fR ( QPainter * p, int ox, int oy, int cx, int cy, int cw, int ch )" -.br -.ti -1c -.BI "virtual void \fBpaintEmptyArea\fR ( QPainter * p, const QRect & rect )" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "void \fBupdateContents\fR ()" -.br -.ti -1c -.BI "void \fBdoAutoScroll\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QListView class implements a list/tree view. -.PP -It can display and control a hierarchy of multi-column items, and provides the ability to add new items at any time. The user may select one or many items (depending on the SelectionMode) and sort the list in increasing or decreasing order by any column. -.PP -The simplest pattern of use is to create a QListView, add some column headers using addColumn() and create one or more QListViewItem or QCheckListItem objects with the QListView as parent: -.PP -.nf -.br - QListView * table; -.fi -.PP -.nf -.br - table->addColumn( "Qualified name" ); -.br - table->addColumn( "Namespace" ); -.fi -.PP -.nf -.br - element = new QListViewItem( table, qName, namespaceURI ); -.fi -.PP -Further nodes can be added to the list view object (the root of the tree) or as child nodes to QListViewItems: -.PP -.nf -.br - for ( int i = 0 ; i < attributes.length(); i++ ) { -.br - new QListViewItem( element, attributes.qName(i), attributes.uri(i) ); -.br - } -.fi -.PP -(From xml/tagreader-with-features/structureparser.cpp) -.PP -The main setup functions are:
                                    .nf -.TS -l - l. Function Action addColumn() Adds a column with a text label and perhaps width. Columns are counted from the left starting with column 0. setColumnWidthMode() Sets the column to be resized automatically or not. setAllColumnsShowFocus() Sets whether items should show keyboard focus using all columns or just column 0. The default is to show focus just using column 0. setRootIsDecorated() Sets whether root items should show open/close decoration to their left. The default is FALSE. setTreeStepSize() Sets how many pixels an item's children are indented relative to their parent. The default is 20. This is mostly a matter of taste. setSorting() -.TE -.fi -
                                    -.PP -To handle events such as mouse presses on the list view, derived classes can reimplement the QScrollView functions: contentsMousePressEvent, contentsMouseReleaseEvent, contentsMouseDoubleClickEvent, contentsMouseMoveEvent, contentsDragEnterEvent, contentsDragMoveEvent, contentsDragLeaveEvent, contentsDropEvent, and contentsWheelEvent. -.PP -There are also several functions for mapping between items and coordinates. itemAt() returns the item at a position on-screen, itemRect() returns the rectangle an item occupies on the screen, and itemPos() returns the position of any item (whether it is on-screen or not). firstChild() returns the list view's first item (not necessarily visible on-screen). -.PP -You can iterate over visible items using QListViewItem::itemBelow(); over a list view's top-level items using QListViewItem::firstChild() and QListViewItem::nextSibling(); or every item using a QListViewItemIterator. See the QListViewItem documentation for examples of traversal. -.PP -An item can be moved amongst its siblings using QListViewItem::moveItem(). To move an item in the hierarchy use takeItem() and insertItem(). Item's (and all their child items) are deleted with \fCdelete\fR; to delete all the list view's items use clear(). -.PP -There are a variety of selection modes described in the QListView::SelectionMode documentation. The default is Single selection, which you can change using setSelectionMode(). -.PP -Because QListView offers multiple selection it must display keyboard focus and selection state separately. Therefore there are functions both to set the selection state of an item (setSelected()) and to set which item displays keyboard focus (setCurrentItem()). -.PP -QListView emits two groups of signals; one group signals changes in selection/focus state and one indicates selection. The first group consists of selectionChanged() (applicable to all list views), selectionChanged(QListViewItem*) (applicable only to a Single selection list view), and currentChanged(QListViewItem*). The second group consists of doubleClicked(QListViewItem*), returnPressed(QListViewItem*), rightButtonClicked(QListViewItem*, const QPoint&, int), etc. -.PP -Note that changing the state of the list view in a slot connected to a list view signal may cause unexpected side effects. If you need to change the list view's state in response to a signal, use a single shot timer with a time out of 0, and connect this timer to a slot that modifies the list view's state. -.PP -In Motif style, QListView deviates fairly strongly from the look and feel of the Motif hierarchical tree view. This is done mostly to provide a usable keyboard interface and to make the list view look better with a white background. -.PP -If selectionMode() is Single (the default) the user can select one item at a time, e.g. by clicking an item with the mouse, see QListView::SelectionMode for details. -.PP -The list view can be navigated either using the mouse or the keyboard. Clicking a \fB-\fR icon closes an item (hides its children) and clicking a \fB+\fR icon opens an item (shows its children). The keyboard controls are these:
                                    .nf -.TS -l - l. Keypress Action Home Make the first item current and visible. End Make the last item current and visible. Page Up Make the item above the top visible item current and visible. Page Down Make the item below the bottom visible item current and visible. Up Arrow Make the item above the current item current and visible. Down Arrow Make the item below the current item current and visible. Left Arrow If the current item is closed ( Right Arrow If the current item is closed ( -.TE -.fi -
                                    -.PP -If the user starts typing letters with the focus in the list view an incremental search will occur. For example if the user types 'd' the current item will change to the first item that begins with the letter 'd'; if they then type 'a', the current item will change to the first item that begins with 'da', and so on. If no item begins with the letters they type the current item doesn't change. -.PP -\fBWarning:\fR The list view assumes ownership of all list view items and will delete them when it does not need them any more. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QListViewItem, QCheckListItem, and Advanced Widgets. -.SS "Member Type Documentation" -.SH "QListView::RenameAction" -This enum describes whether a rename operation is accepted if the rename editor loses focus without the user pressing Enter. -.TP -\fCQListView::Accept\fR - Rename if Enter is pressed or focus is lost. -.TP -\fCQListView::Reject\fR - Discard the rename operation if focus is lost (and Enter has not been pressed). -.SH "QListView::ResizeMode" -This enum describes how the list view's header adjusts to resize events which affect the width of the list view. -.TP -\fCQListView::NoColumn\fR - The columns do not get resized in resize events. -.TP -\fCQListView::AllColumns\fR - All columns are resized equally to fit the width of the list view. -.TP -\fCQListView::LastColumn\fR - The last column is resized to fit the width of the list view. -.SH "QListView::SelectionMode" -This enumerated type is used by QListView to indicate how it reacts to selection by the user. -.TP -\fCQListView::Single\fR - When the user selects an item, any already-selected item becomes unselected. The user can unselect the selected item by clicking on some empty space within the view. -.TP -\fCQListView::Multi\fR - When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone. Also, multiple items can be selected by dragging the mouse while the left mouse button stays pressed. -.TP -\fCQListView::Extended\fR - When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. And if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item get selected or unselected, depending on the state of the clicked item. Also, multiple items can be selected by dragging the mouse over them. -.TP -\fCQListView::NoSelection\fR - Items cannot be selected. -.PP -In other words, Single is a real single-selection list view, Multi a real multi-selection list view, Extended is a list view where users can select multiple items but usually want to select either just one or a range of contiguous items, and NoSelection is a list view where the user can look but not touch. -.SH "QListView::WidthMode" -This enum type describes how the width of a column in the view changes. -.TP -\fCQListView::Manual\fR - the column width does not change automatically. -.TP -\fCQListView::Maximum\fR - the column is automatically sized according to the widths of all items in the column. (Note: The column never shrinks in this case.) This means that the column is always resized to the width of the item with the largest width in the column. -.PP -See also setColumnWidth(), setColumnWidthMode(), and columnWidth(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QListView::QListView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a new empty list view called \fIname\fR with parent \fIparent\fR. -.PP -Performance is boosted by modifying the widget flags \fIf\fR so that only part of the QListViewItem children is redrawn. This may be unsuitable for custom QListViewItem classes, in which case WStaticContents and WNoAutoErase should be cleared. -.PP -See also QWidget::clearWFlags() and Qt::WidgetFlags. -.SH "QListView::~QListView ()" -Destroys the list view, deleting all its items, and frees up all allocated resources. -.SH "int QListView::addColumn ( const QString & label, int width = -1 )\fC [virtual]\fR" -Adds a \fIwidth\fR pixels wide column with the column header \fIlabel\fR to the list view, and returns the index of the new column. -.PP -All columns apart from the first one are inserted to the right of the existing ones. -.PP -If \fIwidth\fR is negative, the new column's WidthMode is set to Maximum instead of Manual. -.PP -See also setColumnText(), setColumnWidth(), and setColumnWidthMode(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, checklists/checklists.cpp, dirview/main.cpp, fileiconview/mainwindow.cpp, listviews/listviews.cpp, and qdir/qdir.cpp. -.SH "int QListView::addColumn ( const QIconSet & iconset, const QString & label, int width = -1 )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a \fIwidth\fR pixels wide new column with the header \fIlabel\fR and the \fIiconset\fR to the list view, and returns the index of the column. -.PP -If \fIwidth\fR is negative, the new column's WidthMode is set to Maximum, and to Manual otherwise. -.PP -See also setColumnText(), setColumnWidth(), and setColumnWidthMode(). -.SH "void QListView::adjustColumn ( int col )\fC [slot]\fR" -Adjusts the column \fIcol\fR to its preferred width -.SH "bool QListView::allColumnsShowFocus () const" -Returns TRUE if items should show keyboard focus using all columns; otherwise returns FALSE. See the "allColumnsShowFocus" property for details. -.SH "int QListView::childCount () const" -Returns the number of parentless (top-level) QListViewItem objects in this QListView. See the "childCount" property for details. -.SH "void QListView::clear ()\fC [virtual slot]\fR" -Removes and deletes all the items in this list view and triggers an update. -.PP -Note that the currentChanged() signal is not emitted when this slot is invoked. -.PP -See also triggerUpdate(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, checklists/checklists.cpp, listviews/listviews.cpp, and qutlook/centralwidget.cpp. -.SH "void QListView::clearSelection ()\fC [virtual]\fR" -Sets all the items to be not selected, updates the list view as necessary, and emits the selectionChanged() signals. Note that for Multi selection list views this function needs to iterate over \fIall\fR items. -.PP -See also setSelected() and multiSelection. -.PP -Example: addressbook/centralwidget.cpp. -.SH "void QListView::clicked ( QListViewItem * item )\fC [signal]\fR" -This signal is emitted whenever the user clicks (mouse pressed \fIand\fR mouse released) in the list view. \fIitem\fR is the clicked list view item, or 0 if the user didn't click on an item. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.PP -Example: addressbook/centralwidget.cpp. -.SH "void QListView::clicked ( QListViewItem * item, const QPoint & pnt, int c )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted whenever the user clicks (mouse pressed \fIand\fR mouse released) in the list view. \fIitem\fR is the clicked list view item, or 0 if the user didn't click on an item. \fIpnt\fR is the position where the user has clicked in global coordinates. If \fIitem\fR is not 0, \fIc\fR is the list view column into which the user pressed; if \fIitem\fR is 0 \fIc\fR's value is undefined. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.SH "void QListView::collapsed ( QListViewItem * item )\fC [signal]\fR" -This signal is emitted when the \fIitem\fR has been collapsed, i.e. when the children of \fIitem\fR are hidden. -.PP -See also setOpen() and expanded(). -.SH "int QListView::columnAlignment ( int column ) const" -Returns the alignment of column \fIcolumn\fR. The default is AlignAuto. -.PP -See also Qt::AlignmentFlags. -.SH "QString QListView::columnText ( int c ) const" -Returns the text of column \fIc\fR. -.PP -See also setColumnText(). -.SH "int QListView::columnWidth ( int c ) const" -Returns the width of column \fIc\fR. -.PP -See also setColumnWidth(). -.SH "WidthMode QListView::columnWidthMode ( int c ) const" -Returns the WidthMode for column \fIc\fR. -.PP -See also setColumnWidthMode(). -.SH "int QListView::columns () const" -Returns the number of columns in this list view. See the "columns" property for details. -.SH "void QListView::contentsMouseDoubleClickEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -Processes the mouse double-click event \fIe\fR on behalf of the viewed widget. -.PP -Reimplemented from QScrollView. -.SH "void QListView::contentsMouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -Processes the mouse move event \fIe\fR on behalf of the viewed widget. -.PP -Example: dirview/dirview.cpp. -.PP -Reimplemented from QScrollView. -.SH "void QListView::contentsMousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -Processes the mouse press event \fIe\fR on behalf of the viewed widget. -.PP -Example: dirview/dirview.cpp. -.PP -Reimplemented from QScrollView. -.SH "void QListView::contentsMouseReleaseEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -Processes the mouse release event \fIe\fR on behalf of the viewed widget. -.PP -Example: dirview/dirview.cpp. -.PP -Reimplemented from QScrollView. -.SH "void QListView::contextMenuRequested ( QListViewItem * item, const QPoint & pos, int col )\fC [signal]\fR" -This signal is emitted when the user invokes a context menu with the right mouse button or with special system keys. If the keyboard was used \fIitem\fR is the current item; if the mouse was used, \fIitem\fR is the item under the mouse pointer or 0 if there is no item under the mouse pointer. If no item is clicked, the column index emitted is -1. -.PP -\fIpos\fR is the position for the context menu in the global coordinate system. -.PP -\fIcol\fR is the column on which the user pressed, or -1 if the signal was triggered by a key event. -.PP -Example: listviews/listviews.cpp. -.SH "void QListView::currentChanged ( QListViewItem * )\fC [signal]\fR" -This signal is emitted whenever the current item has changed (normally after the screen update). The current item is the item responsible for indicating keyboard focus. -.PP -The argument is the newly current item, or 0 if the change made no item current. This can happen, for example, if all items in the list view are deleted. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.PP -See also setCurrentItem() and currentItem(). -.PP -Example: listviews/listviews.cpp. -.SH "QListViewItem * QListView::currentItem () const" -Returns the current item, or 0 if there isn't one. -.PP -See also setCurrentItem(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, listviews/listviews.cpp, and qutlook/centralwidget.cpp. -.SH "RenameAction QListView::defaultRenameAction () const" -Returns what action to perform when the editor loses focus during renaming. See the "defaultRenameAction" property for details. -.SH "void QListView::doAutoScroll ()\fC [protected slot]\fR" -This slot handles auto-scrolling when the mouse button is pressed and the mouse is outside the widget. -.SH "void QListView::doubleClicked ( QListViewItem *, const QPoint &, int )\fC [signal]\fR" -This signal is emitted whenever an item is double-clicked. It's emitted on the second button press, not the second button release. The arguments are the relevant QListViewItem (may be 0), the point in global coordinates and the relevant column (or -1 if the click was outside the list). -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.SH "void QListView::doubleClicked ( QListViewItem * item )\fC [signal]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. (use doubleClicked( QListViewItem *, const QPoint&, int )) -.PP -This signal is emitted whenever an item is double-clicked. It's emitted on the second button press, not the second button release. \fIitem\fR is the list view item on which the user did the double-click. -.SH "QDragObject * QListView::dragObject ()\fC [virtual protected]\fR" -If the user presses the mouse on an item and starts moving the mouse, and the item allow dragging (see QListViewItem::setDragEnabled()), this function is called to get a drag object and a drag is started unless dragObject() returns 0. -.PP -By default this function returns 0. You should reimplement it and create a QDragObject depending on the selected items. -.SH "void QListView::drawContentsOffset ( QPainter * p, int ox, int oy, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" -Calls QListViewItem::paintCell() and QListViewItem::paintBranches() as necessary for all list view items that require repainting in the \fIcw\fR pixels wide and \fIch\fR pixels high bounding rectangle starting at position \fIcx\fR, \fIcy\fR with offset \fIox\fR, \fIoy\fR. Uses the painter \fIp\fR. -.PP -Reimplemented from QScrollView. -.SH "void QListView::dropped ( QDropEvent * e )\fC [signal]\fR" -This signal is emitted, when a drop event occurred on the viewport (not onto an item). -.PP -\fIe\fR provides all the information about the drop. -.SH "void QListView::ensureItemVisible ( const QListViewItem * i )" -Ensures that item \fIi\fR is visible, scrolling the list view vertically if necessary and opening (expanding) any parent items if this is required to show the item. -.PP -See also itemRect() and QScrollView::ensureVisible(). -.SH "bool QListView::eventFilter ( QObject * o, QEvent * e )\fC [virtual]\fR" -Redirects the event \fIe\fR relating to object \fIo\fR, for the viewport to mousePressEvent(), keyPressEvent() and friends. -.PP -Reimplemented from QScrollView. -.SH "void QListView::expanded ( QListViewItem * item )\fC [signal]\fR" -This signal is emitted when \fIitem\fR has been expanded, i.e. when the children of \fIitem\fR are shown. -.PP -See also setOpen() and collapsed(). -.SH "QListViewItem * QListView::findItem ( const QString & text, int column, ComparisonFlags compare = ExactMatch | CaseSensitive ) const" -Finds the first list view item in column \fIcolumn\fR, that matches \fItext\fR and returns the item, or returns 0 of no such item could be found. The search starts from the current item if the current item exists, otherwise it starts from the first list view item. After reaching the last item the search continues from the first item. Pass OR-ed together Qt::StringComparisonMode values in the \fIcompare\fR flag, to control how the matching is performed. The default comparison mode is case-sensitive, exact match. -.SH "QListViewItem * QListView::firstChild () const" -Returns the first item in this QListView. Returns 0 if there is no first item. -.PP -A list view's items can be traversed using firstChild() and nextSibling() or using a QListViewItemIterator. -.PP -See also itemAt(), QListViewItem::itemBelow(), and QListViewItem::itemAbove(). -.PP -Examples: -.)l addressbook/centralwidget.cpp and listviews/listviews.cpp. -.SH "QHeader * QListView::header () const" -Returns the QHeader object that manages this list view's columns. Please don't modify the header behind the list view's back. -.PP -You may safely call QHeader::setClickEnabled(), QHeader::setResizeEnabled(), QHeader::setMovingEnabled(), QHeader::hide() and all the const QHeader functions. -.PP -Examples: -.)l listviews/listviews.cpp and qdir/qdir.cpp. -.SH "void QListView::hideColumn ( int column )" -Hides the column specified at \fIcolumn\fR. This is a convenience function that calls setColumnWidth( \fIcolumn\fR, 0 ). -.PP -Note: The user may still be able to resize the hidden column using the header handles. To prevent this, call setResizeEnabled(FALSE, \fIcolumn\fR) on the list views header. -.PP -See also setColumnWidth(). -.SH "void QListView::insertItem ( QListViewItem * i )\fC [virtual]\fR" -Inserts item \fIi\fR into the list view as a top-level item. You do not need to call this unless you've called takeItem(\fIi\fR) or QListViewItem::takeItem(\fIi\fR) and need to reinsert \fIi\fR elsewhere. -.PP -See also QListViewItem::takeItem() and takeItem(). -.SH "void QListView::invertSelection ()\fC [virtual slot]\fR" -Inverts the selection. Only works in Multi and Extended selection modes. -.SH "bool QListView::isMultiSelection () const" -Returns TRUE if the list view is in multi-selection or extended-selection mode; otherwise returns FALSE. See the "multiSelection" property for details. -.SH "bool QListView::isOpen ( const QListViewItem * item ) const" -Identical to \fIitem\fR->isOpen(). Provided for completeness. -.PP -See also setOpen(). -.SH "bool QListView::isRenaming () const" -Returns TRUE if an item is being renamed; otherwise returns FALSE. -.SH "bool QListView::isSelected ( const QListViewItem * i ) const" -Returns TRUE if the list view item \fIi\fR is selected; otherwise returns FALSE. -.PP -See also QListViewItem::isSelected(). -.SH "QListViewItem * QListView::itemAt ( const QPoint & viewPos ) const" -Returns the list view item at \fIviewPos\fR. Note that \fIviewPos\fR is in the viewport()'s coordinate system, not in the list view's own, much larger, coordinate system. -.PP -itemAt() returns 0 if there is no such item. -.PP -Note that you also get the pointer to the item if \fIviewPos\fR points to the root decoration (see setRootIsDecorated()) of the item. To check whether or not \fIviewPos\fR is on the root decoration of the item, you can do something like this: -.PP -.nf -.br - QListViewItem *i = itemAt( p ); -.br - if ( i ) { -.br - if ( p.x() > header()->sectionPos( header()->mapToIndex( 0 ) ) + -.br - treeStepSize() * ( i->depth() + ( rootIsDecorated() ? 1 : 0) ) + itemMargin() || -.br - p.x() < header()->sectionPos( header()->mapToIndex( 0 ) ) ) { -.br - ; // p is not on root decoration -.br - else -.br - ; // p is on the root decoration -.br - } -.br -.fi -.PP -This might be interesting if you use this function to find out where the user clicked and if you want to start a drag (which you do not want to do if the user clicked onto the root decoration of an item). -.PP -See also itemPos(), itemRect(), and viewportToContents(). -.SH "int QListView::itemMargin () const" -Returns the advisory item margin that list items may use. See the "itemMargin" property for details. -.SH "int QListView::itemPos ( const QListViewItem * item )" -Returns the y-coordinate of \fIitem\fR in the list view's coordinate system. This function is normally much slower than itemAt() but it works for all items, whereas itemAt() normally works only for items on the screen. -.PP -This is a thin wrapper around QListViewItem::itemPos(). -.PP -See also itemAt() and itemRect(). -.SH "QRect QListView::itemRect ( const QListViewItem * i ) const" -Returns the rectangle on the screen that item \fIi\fR occupies in viewport()'s coordinates, or an invalid rectangle if \fIi\fR is 0 or is not currently visible. -.PP -The rectangle returned does not include any children of the rectangle (i.e. it uses QListViewItem::height(), rather than QListViewItem::totalHeight()). If you want the rectangle to include children you can use something like this: -.PP -.nf -.br - QRect r( listView->itemRect( item ) ); -.br - r.setHeight( (QCOORD)(QMIN( item->totalHeight(), -.br - listView->viewport->height() - r.y() ) ) ) -.br -.fi -.PP -Note the way it avoids too-high rectangles. totalHeight() can be much larger than the window system's coordinate system allows. -.PP -itemRect() is comparatively slow. It's best to call it only for items that are probably on-screen. -.SH "void QListView::itemRenamed ( QListViewItem * item, int col, const QString & text )\fC [signal]\fR" -This signal is emitted when \fIitem\fR has been renamed to \fItext\fR, e.g. by in in-place renaming, in column \fIcol\fR. -.PP -See also QListViewItem::setRenameEnabled(). -.SH "void QListView::itemRenamed ( QListViewItem * item, int col )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when \fIitem\fR has been renamed, e.g. by in-place renaming, in column \fIcol\fR. -.PP -See also QListViewItem::setRenameEnabled(). -.SH "QListViewItem * QListView::lastItem () const" -Returns the last item in the list view tree. Returns 0 if there are no items in the QListView. -.PP -This function is slow because it traverses the entire tree to find the last item. -.SH "void QListView::mouseButtonClicked ( int button, QListViewItem * item, const QPoint & pos, int c )\fC [signal]\fR" -This signal is emitted whenever the user clicks (mouse pressed \fIand\fR mouse released) in the list view at position \fIpos\fR. \fIbutton\fR is the mouse button that the user pressed, \fIitem\fR is the clicked list view item or 0 if the user didn't click on an item. If \fIitem\fR is not 0, \fIc\fR is the list view column into which the user pressed; if \fIitem\fR is 0 \fIc\fR's value is undefined. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.SH "void QListView::mouseButtonPressed ( int button, QListViewItem * item, const QPoint & pos, int c )\fC [signal]\fR" -This signal is emitted whenever the user pressed the mouse button in the list view at position \fIpos\fR. \fIbutton\fR is the mouse button which the user pressed, \fIitem\fR is the pressed list view item or 0 if the user didn't press on an item. If \fIitem\fR is not 0, \fIc\fR is the list view column into which the user pressed; if \fIitem\fR is 0 \fIc\fR's value is undefined. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.SH "void QListView::onItem ( QListViewItem * i )\fC [signal]\fR" -This signal is emitted when the user moves the mouse cursor onto item \fIi\fR, similar to the QWidget::enterEvent() function. -.SH "void QListView::onViewport ()\fC [signal]\fR" -This signal is emitted when the user moves the mouse cursor from an item to an empty part of the list view. -.SH "void QListView::paintEmptyArea ( QPainter * p, const QRect & rect )\fC [virtual protected]\fR" -Paints \fIrect\fR so that it looks like empty background using painter \fIp\fR. \fIrect\fR is in widget coordinates, ready to be fed to \fIp\fR. -.PP -The default function fills \fIrect\fR with the viewport()->backgroundBrush(). -.SH "void QListView::pressed ( QListViewItem * item )\fC [signal]\fR" -This signal is emitted whenever the user presses the mouse button in a list view. \fIitem\fR is the list view item on which the user pressed the mouse button, or 0 if the user didn't press the mouse on an item. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.SH "void QListView::pressed ( QListViewItem * item, const QPoint & pnt, int c )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted whenever the user presses the mouse button in a list view. \fIitem\fR is the list view item on which the user pressed the mouse button, or 0 if the user didn't press the mouse on an item. \fIpnt\fR is the position of the mouse cursor in global coordinates, and \fIc\fR is the column where the mouse cursor was when the user pressed the mouse button. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.SH "void QListView::removeColumn ( int index )\fC [virtual]\fR" -Removes the column at position \fIindex\fR. -.PP -If no columns remain after the column is removed, the list view will be cleared. -.PP -See also clear(). -.SH "void QListView::removeItem ( QListViewItem * item )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function has been renamed takeItem(). -.SH "void QListView::repaintItem ( const QListViewItem * item ) const" -Repaints \fIitem\fR on the screen if \fIitem\fR is currently visible. Takes care to avoid multiple repaints. -.SH "void QListView::resizeEvent ( QResizeEvent * e )\fC [virtual protected]\fR" -Ensures that the header is correctly sized and positioned when the resize event \fIe\fR occurs. -.SH "ResizeMode QListView::resizeMode () const" -Returns TRUE if all, none or the only the last column should be resized; otherwise returns FALSE. See the "resizeMode" property for details. -.SH "void QListView::returnPressed ( QListViewItem * )\fC [signal]\fR" -This signal is emitted when Enter or Return is pressed. The argument is the currentItem(). -.SH "void QListView::rightButtonClicked ( QListViewItem *, const QPoint &, int )\fC [signal]\fR" -This signal is emitted when the right button is clicked (i.e. when it's released). The arguments are the relevant QListViewItem (may be 0), the point in global coordinates and the relevant column (or -1 if the click was outside the list). -.SH "void QListView::rightButtonPressed ( QListViewItem *, const QPoint &, int )\fC [signal]\fR" -This signal is emitted when the right button is pressed. The arguments are the relevant QListViewItem (may be 0), the point in global coordinates and the relevant column (or -1 if the click was outside the list). -.SH "bool QListView::rootIsDecorated () const" -Returns TRUE if the list view shows open/close signs on root items; otherwise returns FALSE. See the "rootIsDecorated" property for details. -.SH "void QListView::selectAll ( bool select )\fC [virtual slot]\fR" -If \fIselect\fR is TRUE, all the items get selected; otherwise all the items get unselected. This only works in the selection modes Multi and Extended. In Single and NoSelection mode the selection of the current item is just set to \fIselect\fR. -.SH "QListViewItem * QListView::selectedItem () const" -Returns the selected item if the list view is in Single selection mode and an item is selected. -.PP -If no items are selected or the list view is not in Single selection mode this function returns 0. -.PP -See also setSelected() and multiSelection. -.SH "void QListView::selectionChanged ()\fC [signal]\fR" -This signal is emitted whenever the set of selected items has changed (normally before the screen update). It is available in Single, Multi, and Extended selection modes, but is most useful in Multi selection mode. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.PP -See also setSelected() and QListViewItem::setSelected(). -.PP -Example: listviews/listviews.cpp. -.SH "void QListView::selectionChanged ( QListViewItem * )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted whenever the selected item has changed in Single selection mode (normally after the screen update). The argument is the newly selected item. If the selection is cleared (when, for example, the user clicks in the unused area of the list view) then this signal will not be emitted. -.PP -In Multi selection mode, use the no argument overload of this signal. -.PP -\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. -.PP -See also setSelected(), QListViewItem::setSelected(), and currentChanged(). -.SH "SelectionMode QListView::selectionMode () const" -Returns the list view's selection mode. See the "selectionMode" property for details. -.SH "void QListView::setAllColumnsShowFocus ( bool )\fC [virtual]\fR" -Sets whether items should show keyboard focus using all columns. See the "allColumnsShowFocus" property for details. -.SH "void QListView::setColumnAlignment ( int column, int align )\fC [virtual]\fR" -Sets column \fIcolumn\fR's alignment to \fIalign\fR. The alignment is ultimately passed to QListViewItem::paintCell() for each item in the list view. For horizontally aligned text with Qt::AlignLeft or Qt::AlignHCenter the ellipsis (...) will be to the right, for Qt::AlignRight the ellipsis will be to the left. -.PP -See also Qt::AlignmentFlags. -.PP -Example: listviews/listviews.cpp. -.SH "void QListView::setColumnText ( int column, const QString & label )\fC [virtual]\fR" -Sets the heading of column \fIcolumn\fR to \fIlabel\fR. -.PP -See also columnText(). -.SH "void QListView::setColumnText ( int column, const QIconSet & iconset, const QString & label )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the heading of column \fIcolumn\fR to \fIiconset\fR and \fIlabel\fR. -.PP -See also columnText(). -.SH "void QListView::setColumnWidth ( int column, int w )\fC [virtual]\fR" -Sets the width of column \fIcolumn\fR to \fIw\fR pixels. Note that if the column has a WidthMode other than Manual, this width setting may be subsequently overridden. -.PP -See also columnWidth(). -.SH "void QListView::setColumnWidthMode ( int c, WidthMode mode )\fC [virtual]\fR" -Sets column \fIc\fR's width mode to \fImode\fR. The default depends on the original width argument to addColumn(). -.PP -See also QListViewItem::width(). -.SH "void QListView::setCurrentItem ( QListViewItem * i )\fC [virtual]\fR" -Sets item \fIi\fR to be the current item and repaints appropriately (i.e. highlights the item). The current item is used for keyboard navigation and focus indication; it is independent of any selected items, although a selected item can also be the current item. -.PP -This function does not set the selection anchor. Use setSelectionAnchor() instead. -.PP -See also currentItem() and setSelected(). -.PP -Example: listviews/listviews.cpp. -.SH "void QListView::setDefaultRenameAction ( RenameAction a )\fC [virtual]\fR" -Sets what action to perform when the editor loses focus during renaming to \fIa\fR. See the "defaultRenameAction" property for details. -.SH "void QListView::setItemMargin ( int )\fC [virtual]\fR" -Sets the advisory item margin that list items may use. See the "itemMargin" property for details. -.SH "void QListView::setMultiSelection ( bool enable )\fC [virtual]\fR" -Sets whether the list view is in multi-selection or extended-selection mode to \fIenable\fR. See the "multiSelection" property for details. -.SH "void QListView::setOpen ( QListViewItem * item, bool open )\fC [virtual]\fR" -Sets \fIitem\fR to be open if \fIopen\fR is TRUE and \fIitem\fR is expandable, and to be closed if \fIopen\fR is FALSE. Repaints accordingly. -.PP -See also QListViewItem::setOpen() and QListViewItem::setExpandable(). -.SH "void QListView::setResizeMode ( ResizeMode m )\fC [virtual]\fR" -Sets whether all, none or the only the last column should be resized to \fIm\fR. See the "resizeMode" property for details. -.SH "void QListView::setRootIsDecorated ( bool )\fC [virtual]\fR" -Sets whether the list view shows open/close signs on root items. See the "rootIsDecorated" property for details. -.SH "void QListView::setSelected ( QListViewItem * item, bool selected )\fC [virtual]\fR" -If \fIselected\fR is TRUE the \fIitem\fR is selected; otherwise it is unselected. -.PP -If the list view is in Single selection mode and \fIselected\fR is TRUE, the currently selected item is unselected and \fIitem\fR is made current. Unlike QListViewItem::setSelected(), this function updates the list view as necessary and emits the selectionChanged() signals. -.PP -See also isSelected(), multiSelection, multiSelection, setCurrentItem(), and setSelectionAnchor(). -.PP -Example: listviews/listviews.cpp. -.SH "void QListView::setSelectionAnchor ( QListViewItem * item )" -Sets the selection anchor to \fIitem\fR, if \fIitem\fR is selectable. -.PP -The selection anchor is the item that remains selected when Shift-selecting with either mouse or keyboard in Extended selection mode. -.PP -See also setSelected(). -.SH "void QListView::setSelectionMode ( SelectionMode mode )" -Sets the list view's selection mode to \fImode\fR. See the "selectionMode" property for details. -.SH "void QListView::setShowSortIndicator ( bool show )\fC [virtual]\fR" -Sets whether the list view header should display a sort indicator to \fIshow\fR. See the "showSortIndicator" property for details. -.SH "void QListView::setShowToolTips ( bool b )\fC [virtual]\fR" -Sets whether this list view should show tooltips for truncated column texts to \fIb\fR. See the "showToolTips" property for details. -.SH "void QListView::setSortColumn ( int column )" -Sets the sorting column for the list view. -.PP -If \fIcolumn\fR is -1, sorting is disabled and the user cannot sort columns by clicking on the column headers. If \fIcolumn\fR is larger than the number of columns the user must click on a column header to sort the list view. -.PP -See also setSorting(). -.SH "void QListView::setSortOrder ( SortOrder order )" -Sets the sort order for the items in the list view to \fIorder\fR. -.PP -See also setSorting(). -.SH "void QListView::setSorting ( int column, bool ascending = TRUE )\fC [virtual]\fR" -Sets the list view to be sorted by column \fIcolumn\fR in ascending order if \fIascending\fR is TRUE or descending order if it is FALSE. -.PP -If \fIcolumn\fR is -1, sorting is disabled and the user cannot sort columns by clicking on the column headers. If \fIcolumn\fR is larger than the number of columns the user must click on a column header to sort the list view. -.SH "void QListView::setTreeStepSize ( int )\fC [virtual]\fR" -Sets the number of pixels a child is offset from its parent. See the "treeStepSize" property for details. -.SH "bool QListView::showSortIndicator () const" -Returns TRUE if the list view header should display a sort indicator; otherwise returns FALSE. See the "showSortIndicator" property for details. -.SH "bool QListView::showToolTips () const" -Returns TRUE if this list view should show tooltips for truncated column texts; otherwise returns FALSE. See the "showToolTips" property for details. -.SH "void QListView::sort ()\fC [virtual]\fR" -Sorts the list view using the last sorting configuration (sort column and ascending/descending). -.SH "int QListView::sortColumn () const" -Returns the column by which the list view is sorted, or -1 if sorting is disabled. -.PP -See also sortOrder(). -.SH "SortOrder QListView::sortOrder () const" -Returns the sorting order of the list view items. -.PP -See also sortColumn(). -.SH "void QListView::spacePressed ( QListViewItem * )\fC [signal]\fR" -This signal is emitted when Space is pressed. The argument is the currentItem(). -.SH "void QListView::startDrag ()\fC [virtual protected]\fR" -Starts a drag. -.SH "void QListView::takeItem ( QListViewItem * i )\fC [virtual]\fR" -Removes item \fIi\fR from the list view; \fIi\fR must be a top-level item. The warnings regarding QListViewItem::takeItem() apply to this function, too. -.PP -See also insertItem(). -.SH "int QListView::treeStepSize () const" -Returns the number of pixels a child is offset from its parent. See the "treeStepSize" property for details. -.SH "void QListView::triggerUpdate ()\fC [slot]\fR" -Triggers a size, geometry and content update during the next iteration of the event loop. Ensures that there'll be just one update to avoid flicker. -.SH "void QListView::updateContents ()\fC [protected slot]\fR" -Updates the sizes of the viewport, header, scroll bars and so on. -.PP -\fBWarning:\fR Don't call this directly; call triggerUpdate() instead. -.SS "Property Documentation" -.SH "bool allColumnsShowFocus" -This property holds whether items should show keyboard focus using all columns. -.PP -If this property is TRUE all columns will show focus and selection states, otherwise only column 0 will show focus. -.PP -The default is FALSE. -.PP -Setting this to TRUE if it's not necessary may cause noticeable flicker. -.PP -Set this property's value with setAllColumnsShowFocus() and get this property's value with allColumnsShowFocus(). -.SH "int childCount" -This property holds the number of parentless (top-level) QListViewItem objects in this QListView. -.PP -Holds the current number of parentless (top-level) QListViewItem objects in this QListView. -.PP -See also QListViewItem::childCount(). -.PP -Get this property's value with childCount(). -.SH "int columns" -This property holds the number of columns in this list view. -.PP -Get this property's value with columns(). -.PP -See also addColumn() and removeColumn(). -.SH "RenameAction defaultRenameAction" -This property holds what action to perform when the editor loses focus during renaming. -.PP -If this property is Accept, and the user renames an item and the editor loses focus (without the user pressing Enter), the item will still be renamed. If the property's value is Reject, the item will not be renamed unless the user presses Enter. The default is Reject. -.PP -Set this property's value with setDefaultRenameAction() and get this property's value with defaultRenameAction(). -.SH "int itemMargin" -This property holds the advisory item margin that list items may use. -.PP -The item margin defaults to one pixel and is the margin between the item's edges and the area where it draws its contents. QListViewItem::paintFocus() draws in the margin. -.PP -See also QListViewItem::paintCell(). -.PP -Set this property's value with setItemMargin() and get this property's value with itemMargin(). -.SH "bool multiSelection" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This property holds whether the list view is in multi-selection or extended-selection mode. -.PP -If you enable multi-selection, Multi, mode, it is possible to specify whether or not this mode should be extended. Extended means that the user can select multiple items only when pressing the Shift or Ctrl key at the same time. -.PP -The default selection mode is Single. -.PP -See also selectionMode. -.PP -Set this property's value with setMultiSelection() and get this property's value with isMultiSelection(). -.SH "ResizeMode resizeMode" -This property holds whether all, none or the only the last column should be resized. -.PP -Specifies whether all, none or only the last column should be resized to fit the full width of the list view. The values for this property can be one of: NoColumn (the default), AllColumns or LastColumn. -.PP -\fBWarning:\fR Setting the resize mode should be done after all necessary columns have been added to the list view, otherwise the behavior is undefined. -.PP -See also QHeader and header(). -.PP -Set this property's value with setResizeMode() and get this property's value with resizeMode(). -.SH "bool rootIsDecorated" -This property holds whether the list view shows open/close signs on root items. -.PP -Open/close signs are small \fB+\fR or \fB-\fR symbols in windows style, or arrows in Motif style. The default is FALSE. -.PP -Set this property's value with setRootIsDecorated() and get this property's value with rootIsDecorated(). -.SH "SelectionMode selectionMode" -This property holds the list view's selection mode. -.PP -The mode can be Single (the default), Extended, Multi or NoSelection. -.PP -See also multiSelection. -.PP -Set this property's value with setSelectionMode() and get this property's value with selectionMode(). -.SH "bool showSortIndicator" -This property holds whether the list view header should display a sort indicator. -.PP -If this property is TRUE, an arrow is drawn in the header of the list view to indicate the sort order of the list view contents. The arrow will be drawn in the correct column and will point up or down, depending on the current sort direction. The default is FALSE (don't show an indicator). -.PP -See also QHeader::setSortIndicator(). -.PP -Set this property's value with setShowSortIndicator() and get this property's value with showSortIndicator(). -.SH "bool showToolTips" -This property holds whether this list view should show tooltips for truncated column texts. -.PP -The default is TRUE. -.PP -Set this property's value with setShowToolTips() and get this property's value with showToolTips(). -.SH "int treeStepSize" -This property holds the number of pixels a child is offset from its parent. -.PP -The default is 20 pixels. -.PP -Of course, this property is only meaningful for hierarchical list views. -.PP -Set this property's value with setTreeStepSize() and get this property's value with treeStepSize(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlistview.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlistview.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlistviewitem.3qt b/doc/man/man3/qlistviewitem.3qt deleted file mode 100644 index 521cd8dfd..000000000 --- a/doc/man/man3/qlistviewitem.3qt +++ /dev/null @@ -1,724 +0,0 @@ -'\" t -.TH QListViewItem 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 -QListViewItem \- Implements a list view item -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -Inherited by QCheckListItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQListViewItem\fR ( QListView * parent )" -.br -.ti -1c -.BI "\fBQListViewItem\fR ( QListViewItem * parent )" -.br -.ti -1c -.BI "\fBQListViewItem\fR ( QListView * parent, QListViewItem * after )" -.br -.ti -1c -.BI "\fBQListViewItem\fR ( QListViewItem * parent, QListViewItem * after )" -.br -.ti -1c -.BI "\fBQListViewItem\fR ( QListView * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -.br -.ti -1c -.BI "\fBQListViewItem\fR ( QListViewItem * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -.br -.ti -1c -.BI "\fBQListViewItem\fR ( QListView * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -.br -.ti -1c -.BI "\fBQListViewItem\fR ( QListViewItem * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -.br -.ti -1c -.BI "virtual \fB~QListViewItem\fR ()" -.br -.ti -1c -.BI "virtual void \fBinsertItem\fR ( QListViewItem * newChild )" -.br -.ti -1c -.BI "virtual void \fBtakeItem\fR ( QListViewItem * item )" -.br -.ti -1c -.BI "virtual void removeItem ( QListViewItem * item ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "virtual void \fBinvalidateHeight\fR ()" -.br -.ti -1c -.BI "int \fBtotalHeight\fR () const" -.br -.ti -1c -.BI "virtual int \fBwidth\fR ( const QFontMetrics & fm, const QListView * lv, int c ) const" -.br -.ti -1c -.BI "void \fBwidthChanged\fR ( int c = -1 ) const" -.br -.ti -1c -.BI "int \fBdepth\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( int column, const QString & text )" -.br -.ti -1c -.BI "virtual QString \fBtext\fR ( int column ) const" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( int column, const QPixmap & pm )" -.br -.ti -1c -.BI "virtual const QPixmap * \fBpixmap\fR ( int column ) const" -.br -.ti -1c -.BI "virtual QString \fBkey\fR ( int column, bool ascending ) const" -.br -.ti -1c -.BI "virtual int \fBcompare\fR ( QListViewItem * i, int col, bool ascending ) const" -.br -.ti -1c -.BI "virtual void \fBsortChildItems\fR ( int column, bool ascending )" -.br -.ti -1c -.BI "int \fBchildCount\fR () const" -.br -.ti -1c -.BI "bool \fBisOpen\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetOpen\fR ( bool o )" -.br -.ti -1c -.BI "virtual void \fBsetup\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetSelected\fR ( bool s )" -.br -.ti -1c -.BI "bool \fBisSelected\fR () const" -.br -.ti -1c -.BI "virtual void \fBpaintCell\fR ( QPainter * p, const QColorGroup & cg, int column, int width, int align )" -.br -.ti -1c -.BI "virtual void \fBpaintBranches\fR ( QPainter * p, const QColorGroup & cg, int w, int y, int h )" -.br -.ti -1c -.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QColorGroup & cg, const QRect & r )" -.br -.ti -1c -.BI "QListViewItem * \fBfirstChild\fR () const" -.br -.ti -1c -.BI "QListViewItem * \fBnextSibling\fR () const" -.br -.ti -1c -.BI "QListViewItem * \fBparent\fR () const" -.br -.ti -1c -.BI "QListViewItem * \fBitemAbove\fR ()" -.br -.ti -1c -.BI "QListViewItem * \fBitemBelow\fR ()" -.br -.ti -1c -.BI "int \fBitemPos\fR () const" -.br -.ti -1c -.BI "QListView * \fBlistView\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSelectable\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBisSelectable\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetExpandable\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBisExpandable\fR () const" -.br -.ti -1c -.BI "void \fBrepaint\fR () const" -.br -.ti -1c -.BI "virtual void \fBsort\fR ()" -.br -.ti -1c -.BI "void \fBmoveItem\fR ( QListViewItem * after )" -.br -.ti -1c -.BI "virtual void \fBsetDragEnabled\fR ( bool allow )" -.br -.ti -1c -.BI "virtual void \fBsetDropEnabled\fR ( bool allow )" -.br -.ti -1c -.BI "bool \fBdragEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBdropEnabled\fR () const" -.br -.ti -1c -.BI "virtual bool \fBacceptDrop\fR ( const QMimeSource * mime ) const" -.br -.ti -1c -.BI "void \fBsetVisible\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisVisible\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRenameEnabled\fR ( int col, bool b )" -.br -.ti -1c -.BI "bool \fBrenameEnabled\fR ( int col ) const" -.br -.ti -1c -.BI "virtual void \fBstartRename\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBsetEnabled\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMultiLinesEnabled\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBmultiLinesEnabled\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBenforceSortOrder\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetHeight\fR ( int height )" -.br -.ti -1c -.BI "virtual void \fBactivate\fR ()" -.br -.ti -1c -.BI "bool \fBactivatedPos\fR ( QPoint & pos )" -.br -.ti -1c -.BI "virtual void \fBdropped\fR ( QDropEvent * e )" -.br -.ti -1c -.BI "virtual void \fBdragEntered\fR ()" -.br -.ti -1c -.BI "virtual void \fBdragLeft\fR ()" -.br -.ti -1c -.BI "virtual void \fBokRename\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBcancelRename\fR ( int col )" -.br -.in -1c -.SH DESCRIPTION -The QListViewItem class implements a list view item. -.PP -A list view item is a multi-column object capable of displaying itself in a QListView. -.PP -The easiest way to use QListViewItem is to construct one with a few constant strings, and either a QListView or another QListViewItem as parent. -.PP -.nf -.br - (void) new QListViewItem( listView, "Column 1", "Column 2" ); -.br - (void) new QListViewItem( listView->firstChild(), "A", "B", "C" ); -.br -.fi -We've discarded the pointers to the items since we can still access them via their parent \fIlistView\fR. By default, QListView sorts its items; this can be switched off with QListView::setSorting(-1). -.PP -The parent must be another QListViewItem or a QListView. If the parent is a QListView, the item becomes a top-level item within that QListView. If the parent is another QListViewItem, the item becomes a child of that list view item. -.PP -If you keep the pointer, you can set or change the texts using setText(), add pixmaps using setPixmap(), change its mode using setSelectable(), setSelected(), setOpen() and setExpandable(). You'll also be able to change its height using setHeight(), and traverse its sub-items. You don't have to keep the pointer since you can get a pointer to any QListViewItem in a QListView using QListView::selectedItem(), QListView::currentItem(), QListView::firstChild(), QListView::lastItem() and QListView::findItem(). -.PP -If you call \fCdelete\fR on a list view item, it will be deleted as expected, and as usual for QObjects, if it has any child items (to any depth), all these will be deleted too. -.PP -QCheckListItems are list view items that have a checkbox or radio button and can be used in place of plain QListViewItems. -.PP -You can traverse the tree as if it were a doubly-linked list using itemAbove() and itemBelow(); they return pointers to the items directly above and below this item on the screen (even if none of them are actually visible at the moment). -.PP -Here's how to traverse all of an item's children (but not its children's children, etc.): Example: -.PP -.nf -.br - QListViewItem * myChild = myItem->firstChild(); -.br - while( myChild ) { -.br - doSomething( myChild ); -.br - myChild = myChild->nextSibling(); -.br - } -.br -.fi -.PP -If you want to iterate over every item, to any level of depth use an iterator. To iterate over the entire tree, initialize the iterator with the list view itself; to iterate starting from a particular item, initialize the iterator with the item: -.PP -.nf -.br - QListViewItemIterator it( listview ); -.br - while ( it.current() ) { -.br - QListViewItem *item = it.current(); -.br - doSomething( item ); -.br - ++it; -.br - } -.br -.fi -.PP -Note that the order of the children will change when the sorting order changes and is undefined if the items are not visible. You can, however, call enforceSortOrder() at any time; QListView will always call it before it needs to show an item. -.PP -Many programs will need to reimplement QListViewItem. The most commonly reimplemented functions are:
                                    .nf -.TS -l - l. Function Description text() Returns the text in a column. Many subclasses will compute this on the fly. key() Used for sorting. The default key() simply calls text(), but judicious use of key() can give you fine control over sorting; for example, QFileDialog reimplements key() to sort by date. setup() Called before showing the item and whenever the list view's font changes, for example. activate() -.TE -.fi -
                                    -.PP -Some subclasses call setExpandable(TRUE) even when they have no children, and populate themselves when setup() or setOpen(TRUE) is called. The dirview/dirview.cpp example program uses this technique to start up quickly: The files and subdirectories in a directory aren't inserted into the tree until they're actually needed. -.PP -
                                    -.ce 1 -.B "[Image Omitted]" -.PP -
                                    -.PP -See also QCheckListItem, QListView, and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QListViewItem::QListViewItem ( QListView * parent )" -Constructs a new top-level list view item in the QListView \fIparent\fR. -.SH "QListViewItem::QListViewItem ( QListViewItem * parent )" -Constructs a new list view item that is a child of \fIparent\fR and first in the parent's list of children. -.SH "QListViewItem::QListViewItem ( QListView * parent, QListViewItem * after )" -Constructs an empty list view item that is a child of \fIparent\fR and is after item \fIafter\fR in the parent's list of children. Since \fIparent\fR is a QListView the item will be a top-level item. -.SH "QListViewItem::QListViewItem ( QListViewItem * parent, QListViewItem * after )" -Constructs an empty list view item that is a child of \fIparent\fR and is after item \fIafter\fR in the parent's list of children. -.SH "QListViewItem::QListViewItem ( QListView * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -Constructs a new top-level list view item in the QListView \fIparent\fR, with up to eight constant strings, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and \fIlabel8\fR defining its columns' contents. -.PP -See also setText(). -.SH "QListViewItem::QListViewItem ( QListViewItem * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -Constructs a new list view item as a child of the QListViewItem \fIparent\fR with up to eight constant strings, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and \fIlabel8\fR as columns' contents. -.PP -See also setText(). -.SH "QListViewItem::QListViewItem ( QListView * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -Constructs a new list view item in the QListView \fIparent\fR that is included after item \fIafter\fR and that has up to eight column texts, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and\fIlabel8\fR. -.PP -Note that the order is changed according to QListViewItem::key() unless the list view's sorting is disabled using QListView::setSorting(-1). -.PP -See also setText(). -.SH "QListViewItem::QListViewItem ( QListViewItem * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" -Constructs a new list view item as a child of the QListViewItem \fIparent\fR. It is inserted after item \fIafter\fR and may contain up to eight strings, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and \fIlabel8\fR as column entries. -.PP -Note that the order is changed according to QListViewItem::key() unless the list view's sorting is disabled using QListView::setSorting(-1). -.PP -See also setText(). -.SH "QListViewItem::~QListViewItem ()\fC [virtual]\fR" -Destroys the item, deleting all its children and freeing up all allocated resources. -.SH "bool QListViewItem::acceptDrop ( const QMimeSource * mime ) const\fC [virtual]\fR" -Returns TRUE if the item can accept drops of type QMimeSource \fImime\fR; otherwise returns FALSE. -.PP -The default implementation does nothing and returns FALSE. A subclass must reimplement this to accept drops. -.SH "void QListViewItem::activate ()\fC [virtual protected]\fR" -This virtual function is called whenever the user presses the mouse on this item or presses Space on it. -.PP -See also activatedPos(). -.PP -Reimplemented in QCheckListItem. -.SH "bool QListViewItem::activatedPos ( QPoint & pos )\fC [protected]\fR" -When called from a reimplementation of activate(), this function gives information on how the item was activated. Otherwise the behavior is undefined. -.PP -If activate() was caused by a mouse press, the function sets \fIpos\fR to where the user clicked and returns TRUE; otherwise it returns FALSE and does not change \fIpos\fR. -.PP -\fIpos\fR is relative to the top-left corner of this item. -.PP -\fBWarning:\fR We recommend that you ignore this function; it is scheduled to become obsolete. -.PP -See also activate(). -.SH "void QListViewItem::cancelRename ( int col )\fC [virtual protected]\fR" -This function is called if the user cancels in-place renaming of this item in column \fIcol\fR (e.g. by pressing Esc). -.PP -See also okRename(). -.SH "int QListViewItem::childCount () const" -Returns how many children this item has. The count only includes the item's immediate children. -.SH "int QListViewItem::compare ( QListViewItem * i, int col, bool ascending ) const\fC [virtual]\fR" -Compares this list view item to \fIi\fR using the column \fIcol\fR in \fIascending\fR order. Returns < 0 if this item is less than \fIi\fR, 0 if they are equal and > 0 if this item is greater than \fIi\fR. -.PP -This function is used for sorting. -.PP -The default implementation compares the item keys (key()) using QString::localeAwareCompare(). A reimplementation can use different values and a different comparison function. Here is a reimplementation that uses plain Unicode comparison: -.PP -.nf -.br - int MyListViewItem::compare( QListViewItem *i, int col, -.br - bool ascending ) const -.br - { -.br - return key( col, ascending ).compare( i->key( col, ascending) ); -.br - } -.br -.fi -We don't recommend using \fIascending\fR so your code can safely ignore it. -.PP -See also key(), QString::localeAwareCompare(), and QString::compare(). -.SH "int QListViewItem::depth () const" -Returns the depth of this item. -.PP -Example: dirview/dirview.cpp. -.SH "bool QListViewItem::dragEnabled () const" -Returns TRUE if this item can be dragged; otherwise returns FALSE. -.PP -See also setDragEnabled(). -.SH "void QListViewItem::dragEntered ()\fC [virtual protected]\fR" -This function is called when a drag enters the item's bounding rectangle. -.PP -The default implementation does nothing, subclasses may need to reimplement this function. -.SH "void QListViewItem::dragLeft ()\fC [virtual protected]\fR" -This function is called when a drag leaves the item's bounding rectangle. -.PP -The default implementation does nothing, subclasses may need to reimplement this function. -.SH "bool QListViewItem::dropEnabled () const" -Returns TRUE if this item accepts drops; otherwise returns FALSE. -.PP -See also setDropEnabled() and acceptDrop(). -.SH "void QListViewItem::dropped ( QDropEvent * e )\fC [virtual protected]\fR" -This function is called when something was dropped on the item. \fIe\fR contains all the information about the drop. -.PP -The default implementation does nothing, subclasses may need to reimplement this function. -.SH "void QListViewItem::enforceSortOrder () const\fC [virtual protected]\fR" -Makes sure that this object's children are sorted appropriately. -.PP -This only works if every item from the root item down to this item is already sorted. -.PP -See also sortChildItems(). -.SH "QListViewItem * QListViewItem::firstChild () const" -Returns the first (top) child of this item, or 0 if this item has no children. -.PP -Note that the children are not guaranteed to be sorted properly. QListView and QListViewItem try to postpone or avoid sorting to the greatest degree possible, in order to keep the user interface snappy. -.PP -See also nextSibling() and sortChildItems(). -.PP -Example: checklists/checklists.cpp. -.SH "int QListViewItem::height () const" -Returns the height of this item in pixels. This does not include the height of any children; totalHeight() returns that. -.SH "void QListViewItem::insertItem ( QListViewItem * newChild )\fC [virtual]\fR" -Inserts \fInewChild\fR into this list view item's list of children. You should not need to call this function; it is called automatically by the constructor of \fInewChild\fR. -.PP -\fBWarning:\fR If you are using \fCSingle\fR selection mode, then you should only insert unselected items. -.SH "void QListViewItem::invalidateHeight ()\fC [virtual]\fR" -Invalidates the cached total height of this item, including all open children. -.PP -See also setHeight(), height(), and totalHeight(). -.SH "bool QListViewItem::isEnabled () const" -Returns TRUE if this item is enabled; otherwise returns FALSE. -.PP -See also setEnabled(). -.SH "bool QListViewItem::isExpandable () const" -Returns TRUE if this item is expandable even when it has no children; otherwise returns FALSE. -.SH "bool QListViewItem::isOpen () const" -Returns TRUE if this list view item has children \fIand\fR they are not explicitly hidden; otherwise returns FALSE. -.PP -See also setOpen(). -.SH "bool QListViewItem::isSelectable () const" -Returns TRUE if the item is selectable (as it is by default); otherwise returns FALSE -.PP -See also setSelectable(). -.SH "bool QListViewItem::isSelected () const" -Returns TRUE if this item is selected; otherwise returns FALSE. -.PP -See also setSelected(), QListView::setSelected(), and QListView::selectionChanged(). -.PP -Example: listviews/listviews.cpp. -.SH "bool QListViewItem::isVisible () const" -Returns TRUE if the item is visible; otherwise returns FALSE. -.PP -See also setVisible(). -.SH "QListViewItem * QListViewItem::itemAbove ()" -Returns a pointer to the item immediately above this item on the screen. This is usually the item's closest older sibling, but it may also be its parent or its next older sibling's youngest child, or something else if anyoftheabove->height() returns 0. Returns 0 if there is no item immediately above this item. -.PP -This function assumes that all parents of this item are open (i.e. that this item is visible, or can be made visible by scrolling). -.PP -This function might be relatively slow because of the tree traversions needed to find the correct item. -.PP -See also itemBelow() and QListView::itemRect(). -.SH "QListViewItem * QListViewItem::itemBelow ()" -Returns a pointer to the item immediately below this item on the screen. This is usually the item's eldest child, but it may also be its next younger sibling, its parent's next younger sibling, grandparent's, etc., or something else if anyoftheabove->height() returns 0. Returns 0 if there is no item immediately below this item. -.PP -This function assumes that all parents of this item are open (i.e. that this item is visible or can be made visible by scrolling). -.PP -See also itemAbove() and QListView::itemRect(). -.PP -Example: dirview/dirview.cpp. -.SH "int QListViewItem::itemPos () const" -Returns the y coordinate of this item in the list view's coordinate system. This function is normally much slower than QListView::itemAt(), but it works for all items whereas QListView::itemAt() normally only works for items on the screen. -.PP -See also QListView::itemAt(), QListView::itemRect(), and QListView::itemPos(). -.SH "QString QListViewItem::key ( int column, bool ascending ) const\fC [virtual]\fR" -Returns a key that can be used for sorting by column \fIcolumn\fR. The default implementation returns text(). Derived classes may also incorporate the order indicated by \fIascending\fR into this key, although this is not recommended. -.PP -If you want to sort on non-alphabetical data, e.g. dates, numbers, etc., it is more efficient to reimplement compare(). -.PP -See also compare() and sortChildItems(). -.SH "QListView * QListViewItem::listView () const" -Returns a pointer to the list view containing this item. -.PP -Note that this function traverses the items to the root to find the listview. This function will return 0 for taken items - see QListViewItem::takeItem() -.SH "void QListViewItem::moveItem ( QListViewItem * after )" -Move the item to be after item \fIafter\fR, which must be one of the item's siblings. To move an item in the hierarchy, use takeItem() and insertItem(). -.PP -Note that this function will have no effect if sorting is enabled in the list view. -.SH "bool QListViewItem::multiLinesEnabled () const" -Returns TRUE if the item can display multiple lines of text in its columns; otherwise returns FALSE. -.SH "QListViewItem * QListViewItem::nextSibling () const" -Returns the sibling item below this item, or 0 if there is no sibling item after this item. -.PP -Note that the siblings are not guaranteed to be sorted properly. QListView and QListViewItem try to postpone or avoid sorting to the greatest degree possible, in order to keep the user interface snappy. -.PP -See also firstChild() and sortChildItems(). -.PP -Example: xml/tagreader-with-features/structureparser.cpp. -.SH "void QListViewItem::okRename ( int col )\fC [virtual protected]\fR" -This function is called if the user presses Enter during in-place renaming of the item in column \fIcol\fR. -.PP -See also cancelRename(). -.SH "void QListViewItem::paintBranches ( QPainter * p, const QColorGroup & cg, int w, int y, int h )\fC [virtual]\fR" -Paints a set of branches from this item to (some of) its children. -.PP -Painter \fIp\fR is set up with clipping and translation so that you can only draw in the rectangle that needs redrawing; \fIcg\fR is the color group to use; the update rectangle is at (0, 0) and has size width \fIw\fR by height \fIh\fR. The top of the rectangle you own is at \fIy\fR (which is never greater than 0 but can be outside the window system's allowed coordinate range). -.PP -The update rectangle is in an undefined state when this function is called; this function must draw on \fIall\fR of the pixels. -.PP -See also paintCell() and QListView::drawContentsOffset(). -.SH "void QListViewItem::paintCell ( QPainter * p, const QColorGroup & cg, int column, int width, int align )\fC [virtual]\fR" -This virtual function paints the contents of one column of an item and aligns it as described by \fIalign\fR. -.PP -\fIp\fR is a QPainter open on the relevant paint device. \fIp\fR is translated so (0, 0) is the top-left pixel in the cell and \fIwidth-1\fR, height()-1 is the bottom-right pixel \fIin\fR the cell. The other properties of \fIp\fR (pen, brush, etc) are undefined. \fIcg\fR is the color group to use. \fIcolumn\fR is the logical column number within the item that is to be painted; 0 is the column which may contain a tree. -.PP -This function may use QListView::itemMargin() for readability spacing on the left and right sides of data such as text, and should honor isSelected() and QListView::allColumnsShowFocus(). -.PP -If you reimplement this function, you should also reimplement width(). -.PP -The rectangle to be painted is in an undefined state when this function is called, so you \fImust\fR draw on all the pixels. The painter \fIp\fR has the right font on entry. -.PP -See also paintBranches() and QListView::drawContentsOffset(). -.PP -Example: listviews/listviews.cpp. -.PP -Reimplemented in QCheckListItem. -.SH "void QListViewItem::paintFocus ( QPainter * p, const QColorGroup & cg, const QRect & r )\fC [virtual]\fR" -Paints a focus indicator on the rectangle \fIr\fR using painter \fIp\fR and colors \fIcg\fR. -.PP -\fIp\fR is already clipped. -.PP -See also paintCell(), paintBranches(), and QListView::allColumnsShowFocus. -.PP -Reimplemented in QCheckListItem. -.SH "QListViewItem * QListViewItem::parent () const" -Returns the parent of this item, or 0 if this item has no parent. -.PP -See also firstChild() and nextSibling(). -.PP -Examples: -.)l dirview/dirview.cpp and qutlook/centralwidget.cpp. -.SH "const QPixmap * QListViewItem::pixmap ( int column ) const\fC [virtual]\fR" -Returns the pixmap for \fIcolumn\fR, or 0 if there is no pixmap for \fIcolumn\fR. -.PP -See also setText() and setPixmap(). -.PP -Example: dirview/dirview.cpp. -.SH "void QListViewItem::removeItem ( QListViewItem * item )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function has been renamed takeItem(). -.SH "bool QListViewItem::renameEnabled ( int col ) const" -Returns TRUE if this item can be in-place renamed in column \fIcol\fR; otherwise returns FALSE. -.SH "void QListViewItem::repaint () const" -Repaints this item on the screen if it is currently visible. -.PP -Example: addressbook/centralwidget.cpp. -.SH "int QListViewItem::rtti () const\fC [virtual]\fR" -Returns 0. -.PP -Make your derived classes return their own values for rtti(), so that you can distinguish between different kinds of list view items. You should use values greater than 1000 to allow for extensions to this class. -.PP -Reimplemented in QCheckListItem. -.SH "void QListViewItem::setDragEnabled ( bool allow )\fC [virtual]\fR" -If \fIallow\fR is TRUE, the list view starts a drag (see QListView::dragObject()) when the user presses and moves the mouse on this item. -.SH "void QListViewItem::setDropEnabled ( bool allow )\fC [virtual]\fR" -If \fIallow\fR is TRUE, the list view accepts drops onto the item; otherwise drops are not allowed. -.SH "void QListViewItem::setEnabled ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE the item is enabled; otherwise it is disabled. Disabled items are drawn differently (e.g. grayed-out) and are not accessible by the user. -.SH "void QListViewItem::setExpandable ( bool enable )\fC [virtual]\fR" -Sets this item to be expandable even if it has no children if \fIenable\fR is TRUE, and to be expandable only if it has children if \fIenable\fR is FALSE (the default). -.PP -The dirview example uses this in the canonical fashion. It checks whether the directory is empty in setup() and calls setExpandable(TRUE) if not; in setOpen() it reads the contents of the directory and inserts items accordingly. This strategy means that dirview can display the entire file system without reading very much at startup. -.PP -Note that root items are not expandable by the user unless QListView::setRootIsDecorated() is set to TRUE. -.PP -See also setSelectable(). -.SH "void QListViewItem::setHeight ( int height )\fC [virtual protected]\fR" -Sets this item's height to \fIheight\fR pixels. This implicitly changes totalHeight(), too. -.PP -Note that a font change causes this height to be overwritten unless you reimplement setup(). -.PP -For best results in Windows style we suggest using an even number of pixels. -.PP -See also height(), totalHeight(), and isOpen(). -.SH "void QListViewItem::setMultiLinesEnabled ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE each of the item's columns may contain multiple lines of text; otherwise each of them may only contain a single line. -.SH "void QListViewItem::setOpen ( bool o )\fC [virtual]\fR" -Opens or closes an item, i.e. shows or hides an item's children. -.PP -If \fIo\fR is TRUE all child items are shown initially. The user can hide them by clicking the \fB-\fR icon to the left of the item. If \fIo\fR is FALSE, the children of this item are initially hidden. The user can show them by clicking the \fB+\fR icon to the left of the item. -.PP -See also height(), totalHeight(), and isOpen(). -.PP -Examples: -.)l checklists/checklists.cpp, dirview/dirview.cpp, dirview/main.cpp, fileiconview/mainwindow.cpp, and xml/tagreader-with-features/structureparser.cpp. -.SH "void QListViewItem::setPixmap ( int column, const QPixmap & pm )\fC [virtual]\fR" -Sets the pixmap in column \fIcolumn\fR to \fIpm\fR, if \fIpm\fR is non-null and different from the current pixmap, and if \fIcolumn\fR is non-negative. -.PP -See also pixmap() and setText(). -.PP -Example: dirview/dirview.cpp. -.SH "void QListViewItem::setRenameEnabled ( int col, bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE, this item can be in-place renamed in the column \fIcol\fR by the user; otherwise it cannot be renamed in-place. -.SH "void QListViewItem::setSelectable ( bool enable )\fC [virtual]\fR" -Sets this item to be selectable if \fIenable\fR is TRUE (the default) or not to be selectable if \fIenable\fR is FALSE. -.PP -The user is not able to select a non-selectable item using either the keyboard or the mouse. This also applies for the application programmer (e.g. setSelected() respects this value). -.PP -See also isSelectable(). -.SH "void QListViewItem::setSelected ( bool s )\fC [virtual]\fR" -If \fIs\fR is TRUE this item is selected; otherwise it is deselected. -.PP -This function does not maintain any invariants or repaint anything -- QListView::setSelected() does that. -.PP -See also height() and totalHeight(). -.PP -Example: addressbook/centralwidget.cpp. -.SH "void QListViewItem::setText ( int column, const QString & text )\fC [virtual]\fR" -Sets the text in column \fIcolumn\fR to \fItext\fR, if \fIcolumn\fR is a valid column number and \fItext\fR is different from the existing text. -.PP -If \fItext()\fR has been reimplemented, this function may be a no-op. -.PP -See also text() and key(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, qutlook/centralwidget.cpp, and xml/outliner/outlinetree.cpp. -.SH "void QListViewItem::setVisible ( bool b )" -If \fIb\fR is TRUE, the item is made visible; otherwise it is hidden. -.PP -If the item is not visible, itemAbove() and itemBelow() will never return this item, although you still can reach it by using e.g. QListViewItemIterator. -.SH "void QListViewItem::setup ()\fC [virtual]\fR" -This virtual function is called before the first time QListView needs to know the height or any other graphical attribute of this object, and whenever the font, GUI style, or colors of the list view change. -.PP -The default calls widthChanged() and sets the item's height to the height of a single line of text in the list view's font. (If you use icons, multi-line text, etc., you will probably need to call setHeight() yourself or reimplement it.) -.PP -Example: dirview/dirview.cpp. -.SH "void QListViewItem::sort ()\fC [virtual]\fR" -Sorts all this item's child items using the current sorting configuration (sort column and direction). -.PP -See also enforceSortOrder(). -.SH "void QListViewItem::sortChildItems ( int column, bool ascending )\fC [virtual]\fR" -Sorts this item's children using column \fIcolumn\fR. This is done in ascending order if \fIascending\fR is TRUE and in descending order if \fIascending\fR is FALSE. -.PP -Asks some of the children to sort their children. (QListView and QListViewItem ensure that all on-screen objects are properly sorted but may avoid or defer sorting other objects in order to be more responsive.) -.PP -See also key() and compare(). -.SH "void QListViewItem::startRename ( int col )\fC [virtual]\fR" -If in-place renaming of this item is enabled (see renameEnabled()), this function starts renaming the item in column \fIcol\fR, by creating and initializing an edit box. -.SH "void QListViewItem::takeItem ( QListViewItem * item )\fC [virtual]\fR" -Removes \fIitem\fR from this object's list of children and causes an update of the screen display. The item is not deleted. You should not normally need to call this function because QListViewItem::~QListViewItem() calls it. -.PP -The normal way to delete an item is to use \fCdelete\fR. -.PP -If you need to move an item from one place in the hierarchy to another you can use takeItem() to remove the item from the list view and then insertItem() to put the item back in its new position. -.PP -If a taken item is part of a selection in \fCSingle\fR selection mode, it is unselected and selectionChanged() is emitted. If a taken item is part of a selection in \fCMulti\fR or \fCExtended\fR selection mode, it remains selected. -.PP -\fBWarning:\fR This function leaves \fIitem\fR and its children in a state where most member functions are unsafe. Only a few functions work correctly on an item in this state, most notably insertItem(). The functions that work on taken items are explicitly documented as such. -.PP -See also QListViewItem::insertItem(). -.SH "QString QListViewItem::text ( int column ) const\fC [virtual]\fR" -Returns the text in column \fIcolumn\fR, or QString::null if there is no text in that column. -.PP -See also key() and paintCell(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, dirview/dirview.cpp, network/archivesearch/archivedialog.ui.h, and network/ftpclient/ftpmainwindow.ui.h. -.SH "int QListViewItem::totalHeight () const" -Returns the total height of this object, including any visible children. This height is recomputed lazily and cached for as long as possible. -.PP -Functions which can affect the total height are, setHeight() which is used to set an item's height, setOpen() to show or hide an item's children, and invalidateHeight() to invalidate the cached height. -.PP -See also height(). -.SH "int QListViewItem::width ( const QFontMetrics & fm, const QListView * lv, int c ) const\fC [virtual]\fR" -Returns the number of pixels of width required to draw column \fIc\fR of list view \fIlv\fR, using the metrics \fIfm\fR without cropping. The list view containing this item may use this information depending on the QListView::WidthMode settings for the column. -.PP -The default implementation returns the width of the bounding rectangle of the text of column \fIc\fR. -.PP -See also listView(), widthChanged(), QListView::setColumnWidthMode(), and QListView::itemMargin. -.SH "void QListViewItem::widthChanged ( int c = -1 ) const" -Call this function when the value of width() may have changed for column \fIc\fR. Normally, you should call this if text(c) changes. Passing -1 for \fIc\fR indicates that all columns may have changed. It is more efficient to pass -1 if two or more columns have changed than to call widthChanged() separately for each one. -.PP -See also width(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qlistviewitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlistviewitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlistviewitemiterator.3qt b/doc/man/man3/qlistviewitemiterator.3qt deleted file mode 100644 index 5de39cab2..000000000 --- a/doc/man/man3/qlistviewitemiterator.3qt +++ /dev/null @@ -1,218 +0,0 @@ -'\" t -.TH QListViewItemIterator 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 -QListViewItemIterator \- Iterator for collections of QListViewItems -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBIteratorFlag\fR { Visible = 0x00000001, Invisible = 0x00000002, Selected = 0x00000004, Unselected = 0x00000008, Selectable = 0x00000010, NotSelectable = 0x00000020, DragEnabled = 0x00000040, DragDisabled = 0x00000080, DropEnabled = 0x00000100, DropDisabled = 0x00000200, Expandable = 0x00000400, NotExpandable = 0x00000800, Checked = 0x00001000, NotChecked = 0x00002000 }" -.br -.ti -1c -.BI "\fBQListViewItemIterator\fR ()" -.br -.ti -1c -.BI "\fBQListViewItemIterator\fR ( QListViewItem * item )" -.br -.ti -1c -.BI "\fBQListViewItemIterator\fR ( QListViewItem * item, int iteratorFlags )" -.br -.ti -1c -.BI "\fBQListViewItemIterator\fR ( const QListViewItemIterator & it )" -.br -.ti -1c -.BI "\fBQListViewItemIterator\fR ( QListView * lv )" -.br -.ti -1c -.BI "\fBQListViewItemIterator\fR ( QListView * lv, int iteratorFlags )" -.br -.ti -1c -.BI "QListViewItemIterator & \fBoperator=\fR ( const QListViewItemIterator & it )" -.br -.ti -1c -.BI "\fB~QListViewItemIterator\fR ()" -.br -.ti -1c -.BI "QListViewItemIterator & \fBoperator++\fR ()" -.br -.ti -1c -.BI "const QListViewItemIterator \fBoperator++\fR ( int )" -.br -.ti -1c -.BI "QListViewItemIterator & \fBoperator+=\fR ( int j )" -.br -.ti -1c -.BI "QListViewItemIterator & \fBoperator--\fR ()" -.br -.ti -1c -.BI "const QListViewItemIterator \fBoperator--\fR ( int )" -.br -.ti -1c -.BI "QListViewItemIterator & \fBoperator-=\fR ( int j )" -.br -.ti -1c -.BI "QListViewItem * \fBoperator*\fR ()" -.br -.ti -1c -.BI "QListViewItem * \fBcurrent\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QListViewItemIterator class provides an iterator for collections of QListViewItems. -.PP -Construct an instance of a QListViewItemIterator, with either a QListView* or a QListViewItem* as argument, to operate on the tree of QListViewItems, starting from the argument. -.PP -A QListViewItemIterator iterates over all the items from its starting point. This means that it always makes the first child of the current item the new current item. If there is no child, the next sibling becomes the new current item; and if there is no next sibling, the next sibling of the parent becomes current. -.PP -The following example creates a list of all the items that have been selected by the user, storing pointers to the items in a QPtrList: -.PP -.nf -.br - QPtrList lst; -.br - QListViewItemIterator it( myListView ); -.br - while ( it.current() ) { -.br - if ( it.current()->isSelected() ) -.br - lst.append( it.current() ); -.br - ++it; -.br - } -.br -.fi -.PP -An alternative approach is to use an IteratorFlag: -.PP -.nf -.br - QPtrList lst; -.br - QListViewItemIterator it( myListView, QListViewItemIterator::Selected ); -.br - while ( it.current() ) { -.br - lst.append( it.current() ); -.br - ++it; -.br - } -.br -.fi -.PP -A QListViewItemIterator provides a convenient and easy way to traverse a hierarchical QListView. -.PP -Multiple QListViewItemIterators can operate on the tree of QListViewItems. A QListView knows about all iterators operating on its QListViewItems. So when a QListViewItem gets removed all iterators that point to this item are updated and point to the following item if possible, otherwise to a valid item before the current one or to 0. Note however that deleting the parent item of an item that an iterator points to is not safe. -.PP -See also QListView, QListViewItem, and Advanced Widgets. -.SS "Member Type Documentation" -.SH "QListViewItemIterator::IteratorFlag" -These flags can be passed to a QListViewItemIterator constructor (OR-ed together if more than one is used), so that the iterator will only iterate over items that match the given flags. -.TP -\fCQListViewItemIterator::Visible\fR -.TP -\fCQListViewItemIterator::Invisible\fR -.TP -\fCQListViewItemIterator::Selected\fR -.TP -\fCQListViewItemIterator::Unselected\fR -.TP -\fCQListViewItemIterator::Selectable\fR -.TP -\fCQListViewItemIterator::NotSelectable\fR -.TP -\fCQListViewItemIterator::DragEnabled\fR -.TP -\fCQListViewItemIterator::DragDisabled\fR -.TP -\fCQListViewItemIterator::DropEnabled\fR -.TP -\fCQListViewItemIterator::DropDisabled\fR -.TP -\fCQListViewItemIterator::Expandable\fR -.TP -\fCQListViewItemIterator::NotExpandable\fR -.TP -\fCQListViewItemIterator::Checked\fR -.TP -\fCQListViewItemIterator::NotChecked\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QListViewItemIterator::QListViewItemIterator ()" -Constructs an empty iterator. -.SH "QListViewItemIterator::QListViewItemIterator ( QListViewItem * item )" -Constructs an iterator for the QListView that contains the \fIitem\fR. The current iterator item is set to point to the \fIitem\fR. -.SH "QListViewItemIterator::QListViewItemIterator ( QListViewItem * item, int iteratorFlags )" -Constructs an iterator for the QListView that contains the \fIitem\fR using the flags \fIiteratorFlags\fR. The current iterator item is set to point to \fIitem\fR or the next matching item if \fIitem\fR doesn't match the flags. -.PP -See also QListViewItemIterator::IteratorFlag. -.SH "QListViewItemIterator::QListViewItemIterator ( const QListViewItemIterator & it )" -Constructs an iterator for the same QListView as \fIit\fR. The current iterator item is set to point on the current item of \fIit\fR. -.SH "QListViewItemIterator::QListViewItemIterator ( QListView * lv )" -Constructs an iterator for the QListView \fIlv\fR. The current iterator item is set to point on the first child (QListViewItem) of \fIlv\fR. -.SH "QListViewItemIterator::QListViewItemIterator ( QListView * lv, int iteratorFlags )" -Constructs an iterator for the QListView \fIlv\fR with the flags \fIiteratorFlags\fR. The current iterator item is set to point on the first child (QListViewItem) of \fIlv\fR that matches the flags. -.PP -See also QListViewItemIterator::IteratorFlag. -.SH "QListViewItemIterator::~QListViewItemIterator ()" -Destroys the iterator. -.SH "QListViewItem * QListViewItemIterator::current () const" -Returns iterator's current item. -.PP -Examples: -.)l addressbook/centralwidget.cpp, checklists/checklists.cpp, and dirview/dirview.cpp. -.SH "QListViewItem * QListViewItemIterator::operator* ()" -Dereference operator. Returns a reference to the current item. The same as current(). -.SH "QListViewItemIterator & QListViewItemIterator::operator++ ()" -Prefix ++. Makes the next item the new current item and returns it. Returns 0 if the current item is the last item or the QListView is 0. -.SH "const QListViewItemIterator QListViewItemIterator::operator++ ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix ++. Makes the next item the new current item and returns the item that \fIwas\fR the current item. -.SH "QListViewItemIterator & QListViewItemIterator::operator+= ( int j )" -Sets the current item to the item \fIj\fR positions after the current item. If that item is beyond the last item, the current item is set to 0. Returns the current item. -.SH "QListViewItemIterator & QListViewItemIterator::operator-- ()" -Prefix --. Makes the previous item the new current item and returns it. Returns 0 if the current item is the first item or the QListView is 0. -.SH "const QListViewItemIterator QListViewItemIterator::operator-- ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix --. Makes the previous item the new current item and returns the item that \fIwas\fR the current item. -.SH "QListViewItemIterator & QListViewItemIterator::operator-= ( int j )" -Sets the current item to the item \fIj\fR positions before the current item. If that item is before the first item, the current item is set to 0. Returns the current item. -.SH "QListViewItemIterator & QListViewItemIterator::operator= ( const QListViewItemIterator & it )" -Assignment. Makes a copy of \fIit\fR and returns a reference to its -iterator. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qlistviewitemiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlistviewitemiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlocale.3qt b/doc/man/man3/qlocale.3qt deleted file mode 100644 index b1ff1ad39..000000000 --- a/doc/man/man3/qlocale.3qt +++ /dev/null @@ -1,1249 +0,0 @@ -'\" t -.TH QLocale 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 -QLocale \- Converts between numbers and their string representations in various languages -.SH SYNOPSIS -Almost all the functions in this class are reentrant when Qt is built with thread support. The exception is \fBsetDefault\fR().

                                    -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBLanguage\fR { C = 1, Abkhazian = 2, Afan = 3, Afar = 4, Afrikaans = 5, Albanian = 6, Amharic = 7, Arabic = 8, Armenian = 9, Assamese = 10, Aymara = 11, Azerbaijani = 12, Bashkir = 13, Basque = 14, Bengali = 15, Bhutani = 16, Bihari = 17, Bislama = 18, Breton = 19, Bulgarian = 20, Burmese = 21, Byelorussian = 22, Cambodian = 23, Catalan = 24, Chinese = 25, Corsican = 26, Croatian = 27, Czech = 28, Danish = 29, Dutch = 30, English = 31, Esperanto = 32, Estonian = 33, Faroese = 34, FijiLanguage = 35, Finnish = 36, French = 37, Frisian = 38, Gaelic = 39, Galician = 40, Georgian = 41, German = 42, Greek = 43, Greenlandic = 44, Guarani = 45, Gujarati = 46, Hausa = 47, Hebrew = 48, Hindi = 49, Hungarian = 50, Icelandic = 51, Indonesian = 52, Interlingua = 53, Interlingue = 54, Inuktitut = 55, Inupiak = 56, Irish = 57, Italian = 58, Japanese = 59, Javanese = 60, Kannada = 61, Kashmiri = 62, Kazakh = 63, Kinyarwanda = 64, Kirghiz = 65, Korean = 66, Kurdish = 67, Kurundi = 68, Laothian = 69, Latin = 70, Latvian = 71, Lingala = 72, Lithuanian = 73, Macedonian = 74, Malagasy = 75, Malay = 76, Malayalam = 77, Maltese = 78, Maori = 79, Marathi = 80, Moldavian = 81, Mongolian = 82, NauruLanguage = 83, Nepali = 84, Norwegian = 85, Occitan = 86, Oriya = 87, Pashto = 88, Persian = 89, Polish = 90, Portuguese = 91, Punjabi = 92, Quechua = 93, RhaetoRomance = 94, Romanian = 95, Russian = 96, Samoan = 97, Sangho = 98, Sanskrit = 99, Serbian = 100, SerboCroatian = 101, Sesotho = 102, Setswana = 103, Shona = 104, Sindhi = 105, Singhalese = 106, Siswati = 107, Slovak = 108, Slovenian = 109, Somali = 110, Spanish = 111, Sundanese = 112, Swahili = 113, Swedish = 114, Tagalog = 115, Tajik = 116, Tamil = 117, Tatar = 118, Telugu = 119, Thai = 120, Tibetan = 121, Tigrinya = 122, TongaLanguage = 123, Tsonga = 124, Turkish = 125, Turkmen = 126, Twi = 127, Uigur = 128, Ukrainian = 129, Urdu = 130, Uzbek = 131, Vietnamese = 132, Volapuk = 133, Welsh = 134, Wolof = 135, Xhosa = 136, Yiddish = 137, Yoruba = 138, Zhuang = 139, Zulu = 140, LastLanguage = Zulu }" -.br -.ti -1c -.BI "enum \fBCountry\fR { AnyCountry = 0, Afghanistan = 1, Albania = 2, Algeria = 3, AmericanSamoa = 4, Andorra = 5, Angola = 6, Anguilla = 7, Antarctica = 8, AntiguaAndBarbuda = 9, Argentina = 10, Armenia = 11, Aruba = 12, Australia = 13, Austria = 14, Azerbaijan = 15, Bahamas = 16, Bahrain = 17, Bangladesh = 18, Barbados = 19, Belarus = 20, Belgium = 21, Belize = 22, Benin = 23, Bermuda = 24, Bhutan = 25, Bolivia = 26, BosniaAndHerzegowina = 27, Botswana = 28, BouvetIsland = 29, Brazil = 30, BritishIndianOceanTerritory = 31, BruneiDarussalam = 32, Bulgaria = 33, BurkinaFaso = 34, Burundi = 35, Cambodia = 36, Cameroon = 37, Canada = 38, CapeVerde = 39, CaymanIslands = 40, CentralAfricanRepublic = 41, Chad = 42, Chile = 43, China = 44, ChristmasIsland = 45, CocosIslands = 46, Colombia = 47, Comoros = 48, DemocraticRepublicOfCongo = 49, PeoplesRepublicOfCongo = 50, CookIslands = 51, CostaRica = 52, IvoryCoast = 53, Croatia = 54, Cuba = 55, Cyprus = 56, CzechRepublic = 57, Denmark = 58, Djibouti = 59, Dominica = 60, DominicanRepublic = 61, EastTimor = 62, Ecuador = 63, Egypt = 64, ElSalvador = 65, EquatorialGuinea = 66, Eritrea = 67, Estonia = 68, Ethiopia = 69, FalklandIslands = 70, FaroeIslands = 71, FijiCountry = 72, Finland = 73, France = 74, MetropolitanFrance = 75, FrenchGuiana = 76, FrenchPolynesia = 77, FrenchSouthernTerritories = 78, Gabon = 79, Gambia = 80, Georgia = 81, Germany = 82, Ghana = 83, Gibraltar = 84, Greece = 85, Greenland = 86, Grenada = 87, Guadeloupe = 88, Guam = 89, Guatemala = 90, Guinea = 91, GuineaBissau = 92, Guyana = 93, Haiti = 94, HeardAndMcDonaldIslands = 95, Honduras = 96, HongKong = 97, Hungary = 98, Iceland = 99, India = 100, Indonesia = 101, Iran = 102, Iraq = 103, Ireland = 104, Israel = 105, Italy = 106, Jamaica = 107, Japan = 108, Jordan = 109, Kazakhstan = 110, Kenya = 111, Kiribati = 112, DemocraticRepublicOfKorea = 113, RepublicOfKorea = 114, Kuwait = 115, Kyrgyzstan = 116, Lao = 117, Latvia = 118, Lebanon = 119, Lesotho = 120, Liberia = 121, LibyanArabJamahiriya = 122, Liechtenstein = 123, Lithuania = 124, Luxembourg = 125, Macau = 126, Macedonia = 127, Madagascar = 128, Malawi = 129, Malaysia = 130, Maldives = 131, Mali = 132, Malta = 133, MarshallIslands = 134, Martinique = 135, Mauritania = 136, Mauritius = 137, Mayotte = 138, Mexico = 139, Micronesia = 140, Moldova = 141, Monaco = 142, Mongolia = 143, Montserrat = 144, Morocco = 145, Mozambique = 146, Myanmar = 147, Namibia = 148, NauruCountry = 149, Nepal = 150, Netherlands = 151, NetherlandsAntilles = 152, NewCaledonia = 153, NewZealand = 154, Nicaragua = 155, Niger = 156, Nigeria = 157, Niue = 158, NorfolkIsland = 159, NorthernMarianaIslands = 160, Norway = 161, Oman = 162, Pakistan = 163, Palau = 164, PalestinianTerritory = 165, Panama = 166, PapuaNewGuinea = 167, Paraguay = 168, Peru = 169, Philippines = 170, Pitcairn = 171, Poland = 172, Portugal = 173, PuertoRico = 174, Qatar = 175, Reunion = 176, Romania = 177, RussianFederation = 178, Rwanda = 179, SaintKittsAndNevis = 180, StLucia = 181, StVincentAndTheGrenadines = 182, Samoa = 183, SanMarino = 184, SaoTomeAndPrincipe = 185, SaudiArabia = 186, Senegal = 187, Seychelles = 188, SierraLeone = 189, Singapore = 190, Slovakia = 191, Slovenia = 192, SolomonIslands = 193, Somalia = 194, SouthAfrica = 195, SouthGeorgiaAndTheSouthSandwichIslands = 196, Spain = 197, SriLanka = 198, StHelena = 199, StPierreAndMiquelon = 200, Sudan = 201, Suriname = 202, SvalbardAndJanMayenIslands = 203, Swaziland = 204, Sweden = 205, Switzerland = 206, SyrianArabRepublic = 207, Taiwan = 208, Tajikistan = 209, Tanzania = 210, Thailand = 211, Togo = 212, Tokelau = 213, TongaCountry = 214, TrinidadAndTobago = 215, Tunisia = 216, Turkey = 217, Turkmenistan = 218, TurksAndCaicosIslands = 219, Tuvalu = 220, Uganda = 221, Ukraine = 222, UnitedArabEmirates = 223, UnitedKingdom = 224, UnitedStates = 225, UnitedStatesMinorOutlyingIslands = 226, Uruguay = 227, Uzbekistan = 228, Vanuatu = 229, VaticanCityState = 230, Venezuela = 231, VietNam = 232, BritishVirginIslands = 233, USVirginIslands = 234, WallisAndFutunaIslands = 235, WesternSahara = 236, Yemen = 237, Yugoslavia = 238, Zambia = 239, Zimbabwe = 240, LastCountry = Zimbabwe }" -.br -.ti -1c -.BI "\fBQLocale\fR ()" -.br -.ti -1c -.BI "\fBQLocale\fR ( const QString & name )" -.br -.ti -1c -.BI "\fBQLocale\fR ( Language language, Country country = AnyCountry )" -.br -.ti -1c -.BI "\fBQLocale\fR ( const QLocale & other )" -.br -.ti -1c -.BI "QLocale & \fBoperator=\fR ( const QLocale & other )" -.br -.ti -1c -.BI "Language \fBlanguage\fR () const" -.br -.ti -1c -.BI "Country \fBcountry\fR () const" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "short \fBtoShort\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "ushort \fBtoUShort\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "int \fBtoInt\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "uint \fBtoUInt\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "TQ_LONG \fBtoLong\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "TQ_ULONG \fBtoULong\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "TQ_LLONG \fBtoLongLong\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "TQ_ULLONG \fBtoULongLong\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "float \fBtoFloat\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "double \fBtoDouble\fR ( const QString & s, bool * ok = 0 ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( short i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( ushort i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( int i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( uint i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( TQ_LONG i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( TQ_ULONG i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( TQ_LLONG i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( TQ_ULLONG i ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( float i, char f = 'g', int prec = 6 ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( double i, char f = 'g', int prec = 6 ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBlanguageToString\fR ( Language language )" -.br -.ti -1c -.BI "QString \fBcountryToString\fR ( Country country )" -.br -.ti -1c -.BI "void \fBsetDefault\fR ( const QLocale & locale )" -.br -.ti -1c -.BI "QLocale \fBc\fR ()" -.br -.ti -1c -.BI "QLocale \fBsystem\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QLocale class converts between numbers and their string representations in various languages. -.PP -It is initialized with a country/language pair in its constructor and offers number-to-string and string-to-number conversion functions simmilar to those in QString. -.PP -.nf -.br - QLocale egyptian(QLocale::Arabic, QLocale::Egypt); -.br - QString s1 = egyptian.toString(1.571429E+07, 'e'); -.br - QString s2 = egyptian.toString(10); -.br -.br - double d = egyptian.toDouble(s1); -.br - int s2 = egyptian.toInt(s2); -.br -.fi -.PP -QLocale supports the concept of a default locale, which is determined from the system's locale settings at application startup. The default locale can be changed by calling the static member setDefault(). The default locale has the following effects: -.TP -If a QLocale object is constructed with the default constructor, it will use the default locale's settings. -.TP -QString::toDouble() interprets the string according to the default locale. If this fails, it falls back on the "C" locale. -.TP -QString::arg() uses the default locale to format a number when its position specifier in the format string contains an 'L', e.g. "%L1". -.PP -.nf -.br - QLocale::setDefault(QLocale(QLocale::Hebrew, QLocale::Israel)); -.br - QLocale hebrew; // Constructs a default QLocale -.br - QString s1 = hebrew.toString(15714.3, 'e'); -.br -.br - bool ok; -.br - double d; -.br -.br - QLocale::setDefault(QLocale::C); -.br - d = QString( "1234,56" ).toDouble(&ok); // ok == false -.br - d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 -.br -.br - QLocale::setDefault(QLocale::German); -.br - d = QString( "1234,56" ).toDouble(&ok); // ok == true, d == 1234.56 -.br - d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 -.br -.br - QLocale::setDefault(QLocale(QLocale::English, QLocale::UnitedStates)); -.br - str = QString( "%1 %L2 %L3" ) -.br - .arg( 12345 ) -.br - .arg( 12345 ) -.br - .arg( 12345, 0, 16 ); -.br - // str == "12345 12,345 3039" -.br -.fi -.PP -When a language/country pair is specified in the constructor, one of three things can happen: -.TP -If the language/country pair is found in the database, it is used. -.TP -If the language is found but the country is not, or if the country is AnyCountry, the language is used with the most appropriate available country (for example, Germany for German), -.TP -If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()). -.PP -The "C" locale is identical to English/UnitedStates. -.PP -Use language() and country() to determine the actual language and country values used. -.PP -An alternative method for constructing a QLocale object is by specifying the locale name. -.PP -.nf -.br - QLocale korean("ko"); -.br - QLocale swiss("de_CH"); -.br -.fi -.PP -This constructor converts the locale name to a language/country pair; it does not use the system locale database. -.PP -All the methods in QLocale, with the exception of setDefault(), are reentrant. -.PP -See also QString::toDouble(), QString::arg(), and Text Related Classes. -.PP -The double-to-string and string-to-double conversion functions are covered by the following licenses: -.PP -Copyright (c) 1991 by AT&T. -.PP -Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software. -.PP -THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR AT&T MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE. -.PP -This product includes software developed by the University of California, Berkeley and its contributors. -.SS "Member Type Documentation" -.SH "QLocale::Country" -This enumerated type is used to specify a country. -.TP -\fCQLocale::AnyCountry\fR -.TP -\fCQLocale::Afghanistan\fR -.TP -\fCQLocale::Albania\fR -.TP -\fCQLocale::Algeria\fR -.TP -\fCQLocale::AmericanSamoa\fR -.TP -\fCQLocale::Andorra\fR -.TP -\fCQLocale::Angola\fR -.TP -\fCQLocale::Anguilla\fR -.TP -\fCQLocale::Antarctica\fR -.TP -\fCQLocale::AntiguaAndBarbuda\fR -.TP -\fCQLocale::Argentina\fR -.TP -\fCQLocale::Armenia\fR -.TP -\fCQLocale::Aruba\fR -.TP -\fCQLocale::Australia\fR -.TP -\fCQLocale::Austria\fR -.TP -\fCQLocale::Azerbaijan\fR -.TP -\fCQLocale::Bahamas\fR -.TP -\fCQLocale::Bahrain\fR -.TP -\fCQLocale::Bangladesh\fR -.TP -\fCQLocale::Barbados\fR -.TP -\fCQLocale::Belarus\fR -.TP -\fCQLocale::Belgium\fR -.TP -\fCQLocale::Belize\fR -.TP -\fCQLocale::Benin\fR -.TP -\fCQLocale::Bermuda\fR -.TP -\fCQLocale::Bhutan\fR -.TP -\fCQLocale::Bolivia\fR -.TP -\fCQLocale::BosniaAndHerzegowina\fR -.TP -\fCQLocale::Botswana\fR -.TP -\fCQLocale::BouvetIsland\fR -.TP -\fCQLocale::Brazil\fR -.TP -\fCQLocale::BritishIndianOceanTerritory\fR -.TP -\fCQLocale::BruneiDarussalam\fR -.TP -\fCQLocale::Bulgaria\fR -.TP -\fCQLocale::BurkinaFaso\fR -.TP -\fCQLocale::Burundi\fR -.TP -\fCQLocale::Cambodia\fR -.TP -\fCQLocale::Cameroon\fR -.TP -\fCQLocale::Canada\fR -.TP -\fCQLocale::CapeVerde\fR -.TP -\fCQLocale::CaymanIslands\fR -.TP -\fCQLocale::CentralAfricanRepublic\fR -.TP -\fCQLocale::Chad\fR -.TP -\fCQLocale::Chile\fR -.TP -\fCQLocale::China\fR -.TP -\fCQLocale::ChristmasIsland\fR -.TP -\fCQLocale::CocosIslands\fR -.TP -\fCQLocale::Colombia\fR -.TP -\fCQLocale::Comoros\fR -.TP -\fCQLocale::DemocraticRepublicOfCongo\fR -.TP -\fCQLocale::PeoplesRepublicOfCongo\fR -.TP -\fCQLocale::CookIslands\fR -.TP -\fCQLocale::CostaRica\fR -.TP -\fCQLocale::IvoryCoast\fR -.TP -\fCQLocale::Croatia\fR -.TP -\fCQLocale::Cuba\fR -.TP -\fCQLocale::Cyprus\fR -.TP -\fCQLocale::CzechRepublic\fR -.TP -\fCQLocale::Denmark\fR -.TP -\fCQLocale::Djibouti\fR -.TP -\fCQLocale::Dominica\fR -.TP -\fCQLocale::DominicanRepublic\fR -.TP -\fCQLocale::EastTimor\fR -.TP -\fCQLocale::Ecuador\fR -.TP -\fCQLocale::Egypt\fR -.TP -\fCQLocale::ElSalvador\fR -.TP -\fCQLocale::EquatorialGuinea\fR -.TP -\fCQLocale::Eritrea\fR -.TP -\fCQLocale::Estonia\fR -.TP -\fCQLocale::Ethiopia\fR -.TP -\fCQLocale::FalklandIslands\fR -.TP -\fCQLocale::FaroeIslands\fR -.TP -\fCQLocale::FijiCountry\fR -.TP -\fCQLocale::Finland\fR -.TP -\fCQLocale::France\fR -.TP -\fCQLocale::MetropolitanFrance\fR -.TP -\fCQLocale::FrenchGuiana\fR -.TP -\fCQLocale::FrenchPolynesia\fR -.TP -\fCQLocale::FrenchSouthernTerritories\fR -.TP -\fCQLocale::Gabon\fR -.TP -\fCQLocale::Gambia\fR -.TP -\fCQLocale::Georgia\fR -.TP -\fCQLocale::Germany\fR -.TP -\fCQLocale::Ghana\fR -.TP -\fCQLocale::Gibraltar\fR -.TP -\fCQLocale::Greece\fR -.TP -\fCQLocale::Greenland\fR -.TP -\fCQLocale::Grenada\fR -.TP -\fCQLocale::Guadeloupe\fR -.TP -\fCQLocale::Guam\fR -.TP -\fCQLocale::Guatemala\fR -.TP -\fCQLocale::Guinea\fR -.TP -\fCQLocale::GuineaBissau\fR -.TP -\fCQLocale::Guyana\fR -.TP -\fCQLocale::Haiti\fR -.TP -\fCQLocale::HeardAndMcDonaldIslands\fR -.TP -\fCQLocale::Honduras\fR -.TP -\fCQLocale::HongKong\fR -.TP -\fCQLocale::Hungary\fR -.TP -\fCQLocale::Iceland\fR -.TP -\fCQLocale::India\fR -.TP -\fCQLocale::Indonesia\fR -.TP -\fCQLocale::Iran\fR -.TP -\fCQLocale::Iraq\fR -.TP -\fCQLocale::Ireland\fR -.TP -\fCQLocale::Israel\fR -.TP -\fCQLocale::Italy\fR -.TP -\fCQLocale::Jamaica\fR -.TP -\fCQLocale::Japan\fR -.TP -\fCQLocale::Jordan\fR -.TP -\fCQLocale::Kazakhstan\fR -.TP -\fCQLocale::Kenya\fR -.TP -\fCQLocale::Kiribati\fR -.TP -\fCQLocale::DemocraticRepublicOfKorea\fR -.TP -\fCQLocale::RepublicOfKorea\fR -.TP -\fCQLocale::Kuwait\fR -.TP -\fCQLocale::Kyrgyzstan\fR -.TP -\fCQLocale::Lao\fR -.TP -\fCQLocale::Latvia\fR -.TP -\fCQLocale::Lebanon\fR -.TP -\fCQLocale::Lesotho\fR -.TP -\fCQLocale::Liberia\fR -.TP -\fCQLocale::LibyanArabJamahiriya\fR -.TP -\fCQLocale::Liechtenstein\fR -.TP -\fCQLocale::Lithuania\fR -.TP -\fCQLocale::Luxembourg\fR -.TP -\fCQLocale::Macau\fR -.TP -\fCQLocale::Macedonia\fR -.TP -\fCQLocale::Madagascar\fR -.TP -\fCQLocale::Malawi\fR -.TP -\fCQLocale::Malaysia\fR -.TP -\fCQLocale::Maldives\fR -.TP -\fCQLocale::Mali\fR -.TP -\fCQLocale::Malta\fR -.TP -\fCQLocale::MarshallIslands\fR -.TP -\fCQLocale::Martinique\fR -.TP -\fCQLocale::Mauritania\fR -.TP -\fCQLocale::Mauritius\fR -.TP -\fCQLocale::Mayotte\fR -.TP -\fCQLocale::Mexico\fR -.TP -\fCQLocale::Micronesia\fR -.TP -\fCQLocale::Moldova\fR -.TP -\fCQLocale::Monaco\fR -.TP -\fCQLocale::Mongolia\fR -.TP -\fCQLocale::Montserrat\fR -.TP -\fCQLocale::Morocco\fR -.TP -\fCQLocale::Mozambique\fR -.TP -\fCQLocale::Myanmar\fR -.TP -\fCQLocale::Namibia\fR -.TP -\fCQLocale::NauruCountry\fR -.TP -\fCQLocale::Nepal\fR -.TP -\fCQLocale::Netherlands\fR -.TP -\fCQLocale::NetherlandsAntilles\fR -.TP -\fCQLocale::NewCaledonia\fR -.TP -\fCQLocale::NewZealand\fR -.TP -\fCQLocale::Nicaragua\fR -.TP -\fCQLocale::Niger\fR -.TP -\fCQLocale::Nigeria\fR -.TP -\fCQLocale::Niue\fR -.TP -\fCQLocale::NorfolkIsland\fR -.TP -\fCQLocale::NorthernMarianaIslands\fR -.TP -\fCQLocale::Norway\fR -.TP -\fCQLocale::Oman\fR -.TP -\fCQLocale::Pakistan\fR -.TP -\fCQLocale::Palau\fR -.TP -\fCQLocale::PalestinianTerritory\fR -.TP -\fCQLocale::Panama\fR -.TP -\fCQLocale::PapuaNewGuinea\fR -.TP -\fCQLocale::Paraguay\fR -.TP -\fCQLocale::Peru\fR -.TP -\fCQLocale::Philippines\fR -.TP -\fCQLocale::Pitcairn\fR -.TP -\fCQLocale::Poland\fR -.TP -\fCQLocale::Portugal\fR -.TP -\fCQLocale::PuertoRico\fR -.TP -\fCQLocale::Qatar\fR -.TP -\fCQLocale::Reunion\fR -.TP -\fCQLocale::Romania\fR -.TP -\fCQLocale::RussianFederation\fR -.TP -\fCQLocale::Rwanda\fR -.TP -\fCQLocale::SaintKittsAndNevis\fR -.TP -\fCQLocale::StLucia\fR -.TP -\fCQLocale::StVincentAndTheGrenadines\fR -.TP -\fCQLocale::Samoa\fR -.TP -\fCQLocale::SanMarino\fR -.TP -\fCQLocale::SaoTomeAndPrincipe\fR -.TP -\fCQLocale::SaudiArabia\fR -.TP -\fCQLocale::Senegal\fR -.TP -\fCQLocale::Seychelles\fR -.TP -\fCQLocale::SierraLeone\fR -.TP -\fCQLocale::Singapore\fR -.TP -\fCQLocale::Slovakia\fR -.TP -\fCQLocale::Slovenia\fR -.TP -\fCQLocale::SolomonIslands\fR -.TP -\fCQLocale::Somalia\fR -.TP -\fCQLocale::SouthAfrica\fR -.TP -\fCQLocale::SouthGeorgiaAndTheSouthSandwichIslands\fR -.TP -\fCQLocale::Spain\fR -.TP -\fCQLocale::SriLanka\fR -.TP -\fCQLocale::StHelena\fR -.TP -\fCQLocale::StPierreAndMiquelon\fR -.TP -\fCQLocale::Sudan\fR -.TP -\fCQLocale::Suriname\fR -.TP -\fCQLocale::SvalbardAndJanMayenIslands\fR -.TP -\fCQLocale::Swaziland\fR -.TP -\fCQLocale::Sweden\fR -.TP -\fCQLocale::Switzerland\fR -.TP -\fCQLocale::SyrianArabRepublic\fR -.TP -\fCQLocale::Taiwan\fR -.TP -\fCQLocale::Tajikistan\fR -.TP -\fCQLocale::Tanzania\fR -.TP -\fCQLocale::Thailand\fR -.TP -\fCQLocale::Togo\fR -.TP -\fCQLocale::Tokelau\fR -.TP -\fCQLocale::TongaCountry\fR -.TP -\fCQLocale::TrinidadAndTobago\fR -.TP -\fCQLocale::Tunisia\fR -.TP -\fCQLocale::Turkey\fR -.TP -\fCQLocale::Turkmenistan\fR -.TP -\fCQLocale::TurksAndCaicosIslands\fR -.TP -\fCQLocale::Tuvalu\fR -.TP -\fCQLocale::Uganda\fR -.TP -\fCQLocale::Ukraine\fR -.TP -\fCQLocale::UnitedArabEmirates\fR -.TP -\fCQLocale::UnitedKingdom\fR -.TP -\fCQLocale::UnitedStates\fR -.TP -\fCQLocale::UnitedStatesMinorOutlyingIslands\fR -.TP -\fCQLocale::Uruguay\fR -.TP -\fCQLocale::Uzbekistan\fR -.TP -\fCQLocale::Vanuatu\fR -.TP -\fCQLocale::VaticanCityState\fR -.TP -\fCQLocale::Venezuela\fR -.TP -\fCQLocale::VietNam\fR -.TP -\fCQLocale::BritishVirginIslands\fR -.TP -\fCQLocale::USVirginIslands\fR -.TP -\fCQLocale::WallisAndFutunaIslands\fR -.TP -\fCQLocale::WesternSahara\fR -.TP -\fCQLocale::Yemen\fR -.TP -\fCQLocale::Yugoslavia\fR -.TP -\fCQLocale::Zambia\fR -.TP -\fCQLocale::Zimbabwe\fR -.SH "QLocale::Language" -This enumerated type is used to specify a language. -.TP -\fCQLocale::C\fR - Identical to English/UnitedStates -.TP -\fCQLocale::Abkhazian\fR -.TP -\fCQLocale::Afan\fR -.TP -\fCQLocale::Afar\fR -.TP -\fCQLocale::Afrikaans\fR -.TP -\fCQLocale::Albanian\fR -.TP -\fCQLocale::Amharic\fR -.TP -\fCQLocale::Arabic\fR -.TP -\fCQLocale::Armenian\fR -.TP -\fCQLocale::Assamese\fR -.TP -\fCQLocale::Aymara\fR -.TP -\fCQLocale::Azerbaijani\fR -.TP -\fCQLocale::Bashkir\fR -.TP -\fCQLocale::Basque\fR -.TP -\fCQLocale::Bengali\fR -.TP -\fCQLocale::Bhutani\fR -.TP -\fCQLocale::Bihari\fR -.TP -\fCQLocale::Bislama\fR -.TP -\fCQLocale::Breton\fR -.TP -\fCQLocale::Bulgarian\fR -.TP -\fCQLocale::Burmese\fR -.TP -\fCQLocale::Byelorussian\fR -.TP -\fCQLocale::Cambodian\fR -.TP -\fCQLocale::Catalan\fR -.TP -\fCQLocale::Chinese\fR -.TP -\fCQLocale::Corsican\fR -.TP -\fCQLocale::Croatian\fR -.TP -\fCQLocale::Czech\fR -.TP -\fCQLocale::Danish\fR -.TP -\fCQLocale::Dutch\fR -.TP -\fCQLocale::English\fR -.TP -\fCQLocale::Esperanto\fR -.TP -\fCQLocale::Estonian\fR -.TP -\fCQLocale::Faroese\fR -.TP -\fCQLocale::FijiLanguage\fR -.TP -\fCQLocale::Finnish\fR -.TP -\fCQLocale::French\fR -.TP -\fCQLocale::Frisian\fR -.TP -\fCQLocale::Gaelic\fR -.TP -\fCQLocale::Galician\fR -.TP -\fCQLocale::Georgian\fR -.TP -\fCQLocale::German\fR -.TP -\fCQLocale::Greek\fR -.TP -\fCQLocale::Greenlandic\fR -.TP -\fCQLocale::Guarani\fR -.TP -\fCQLocale::Gujarati\fR -.TP -\fCQLocale::Hausa\fR -.TP -\fCQLocale::Hebrew\fR -.TP -\fCQLocale::Hindi\fR -.TP -\fCQLocale::Hungarian\fR -.TP -\fCQLocale::Icelandic\fR -.TP -\fCQLocale::Indonesian\fR -.TP -\fCQLocale::Interlingua\fR -.TP -\fCQLocale::Interlingue\fR -.TP -\fCQLocale::Inuktitut\fR -.TP -\fCQLocale::Inupiak\fR -.TP -\fCQLocale::Irish\fR -.TP -\fCQLocale::Italian\fR -.TP -\fCQLocale::Japanese\fR -.TP -\fCQLocale::Javanese\fR -.TP -\fCQLocale::Kannada\fR -.TP -\fCQLocale::Kashmiri\fR -.TP -\fCQLocale::Kazakh\fR -.TP -\fCQLocale::Kinyarwanda\fR -.TP -\fCQLocale::Kirghiz\fR -.TP -\fCQLocale::Korean\fR -.TP -\fCQLocale::Kurdish\fR -.TP -\fCQLocale::Kurundi\fR -.TP -\fCQLocale::Laothian\fR -.TP -\fCQLocale::Latin\fR -.TP -\fCQLocale::Latvian\fR -.TP -\fCQLocale::Lingala\fR -.TP -\fCQLocale::Lithuanian\fR -.TP -\fCQLocale::Macedonian\fR -.TP -\fCQLocale::Malagasy\fR -.TP -\fCQLocale::Malay\fR -.TP -\fCQLocale::Malayalam\fR -.TP -\fCQLocale::Maltese\fR -.TP -\fCQLocale::Maori\fR -.TP -\fCQLocale::Marathi\fR -.TP -\fCQLocale::Moldavian\fR -.TP -\fCQLocale::Mongolian\fR -.TP -\fCQLocale::NauruLanguage\fR -.TP -\fCQLocale::Nepali\fR -.TP -\fCQLocale::Norwegian\fR -.TP -\fCQLocale::Occitan\fR -.TP -\fCQLocale::Oriya\fR -.TP -\fCQLocale::Pashto\fR -.TP -\fCQLocale::Persian\fR -.TP -\fCQLocale::Polish\fR -.TP -\fCQLocale::Portuguese\fR -.TP -\fCQLocale::Punjabi\fR -.TP -\fCQLocale::Quechua\fR -.TP -\fCQLocale::RhaetoRomance\fR -.TP -\fCQLocale::Romanian\fR -.TP -\fCQLocale::Russian\fR -.TP -\fCQLocale::Samoan\fR -.TP -\fCQLocale::Sangho\fR -.TP -\fCQLocale::Sanskrit\fR -.TP -\fCQLocale::Serbian\fR -.TP -\fCQLocale::SerboCroatian\fR -.TP -\fCQLocale::Sesotho\fR -.TP -\fCQLocale::Setswana\fR -.TP -\fCQLocale::Shona\fR -.TP -\fCQLocale::Sindhi\fR -.TP -\fCQLocale::Singhalese\fR -.TP -\fCQLocale::Siswati\fR -.TP -\fCQLocale::Slovak\fR -.TP -\fCQLocale::Slovenian\fR -.TP -\fCQLocale::Somali\fR -.TP -\fCQLocale::Spanish\fR -.TP -\fCQLocale::Sundanese\fR -.TP -\fCQLocale::Swahili\fR -.TP -\fCQLocale::Swedish\fR -.TP -\fCQLocale::Tagalog\fR -.TP -\fCQLocale::Tajik\fR -.TP -\fCQLocale::Tamil\fR -.TP -\fCQLocale::Tatar\fR -.TP -\fCQLocale::Telugu\fR -.TP -\fCQLocale::Thai\fR -.TP -\fCQLocale::Tibetan\fR -.TP -\fCQLocale::Tigrinya\fR -.TP -\fCQLocale::TongaLanguage\fR -.TP -\fCQLocale::Tsonga\fR -.TP -\fCQLocale::Turkish\fR -.TP -\fCQLocale::Turkmen\fR -.TP -\fCQLocale::Twi\fR -.TP -\fCQLocale::Uigur\fR -.TP -\fCQLocale::Ukrainian\fR -.TP -\fCQLocale::Urdu\fR -.TP -\fCQLocale::Uzbek\fR -.TP -\fCQLocale::Vietnamese\fR -.TP -\fCQLocale::Volapuk\fR -.TP -\fCQLocale::Welsh\fR -.TP -\fCQLocale::Wolof\fR -.TP -\fCQLocale::Xhosa\fR -.TP -\fCQLocale::Yiddish\fR -.TP -\fCQLocale::Yoruba\fR -.TP -\fCQLocale::Zhuang\fR -.TP -\fCQLocale::Zulu\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLocale::QLocale ()" -Constructs a QLocale object initialized with the default locale. -.PP -See also setDefault(). -.SH "QLocale::QLocale ( const QString & name )" -Constructs a QLocale object with the specified \fIname\fR, which has the format" language[_country][.codeset][@modifier]" or "C", where: -.TP -language is a lowercase, two-letter, ISO 639 language code, -.TP -territory is an uppercase, two-letter, ISO 3166 country code, -.TP -and codeset and modifier are ignored. -.PP -If the string violates the locale format, or language is not a valid ISO 369 code, the "C" locale is used instead. If country is not present, or is not a valid ISO 3166 code, the most appropriate country is chosen for the specified language. -.PP -The language and country codes are converted to their respective Language and Country enums. After this conversion is performed the constructor behaves exactly like QLocale(Country, Language). -.PP -This constructor is much slower than QLocale(Country, Language). -.PP -See also name(). -.SH "QLocale::QLocale ( Language language, Country country = AnyCountry )" -Constructs a QLocale object with the specified \fIlanguage\fR and \fIcountry\fR. -.TP -If the language/country pair is found in the database, it is used. -.TP -If the language is found but the country is not, or if the country is AnyCountry, the language is used with the most appropriate available country (for example, Germany for German), -.TP -If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()). -.PP -The language and country that are actually used can be queried using language() and country(). -.PP -See also setDefault(), language(), and country(). -.SH "QLocale::QLocale ( const QLocale & other )" -Constructs a QLocale object as a copy of \fIother\fR. -.SH "QLocale QLocale::c ()\fC [static]\fR" -Returns a QLocale object initialized to the "C" locale. -.PP -See also system(). -.SH "Country QLocale::country () const" -Returns the country of this locale. -.PP -See also QLocale(). -.SH "QString QLocale::countryToString ( Country country )\fC [static]\fR" -Returns a QString containing the name of \fIcountry\fR. -.SH "Language QLocale::language () const" -Returns the language of this locale. -.PP -See also QLocale(). -.SH "QString QLocale::languageToString ( Language language )\fC [static]\fR" -Returns a QString containing the name of \fIlanguage\fR. -.SH "QString QLocale::name () const" -Returns the language and country of this locale as a string of the form "language_country", where language is a lowercase, two-letter ISO 639 language code, and country is an uppercase, two-letter ISO 3166 country code. -.PP -See also QLocale(). -.SH "QLocale & QLocale::operator= ( const QLocale & other )" -Assigns \fIother\fR to this QLocale object and returns a reference to this QLocale object. -.SH "void QLocale::setDefault ( const QLocale & locale )\fC [static]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                                    -.PP -Sets the global default locale to \fIlocale\fR. These values are used when a QLocale object is constructed with no arguments. If this function is not called, the system's locale is used. -.PP -\fBWarning:\fR In a multithreaded application, the default locale should be set at application startup, before any non-GUI threads are created. -.PP -See also system() and c(). -.SH "QLocale QLocale::system ()\fC [static]\fR" -Returns a QLocale object initialized to the system locale. -.SH "double QLocale::toDouble ( const QString & s, bool * ok = 0 ) const" -Returns the double represented by the localized string \fIs\fR, or 0.0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -Unlike QString::toDouble(), this function does not fall back to the "C" locale if the string cannot be interpreted in this locale. -.PP -.nf -.br - bool ok; -.br - double d; -.br -.br - QLocale c(QLocale::C); -.br - d = c.toDouble( "1234.56", &ok ); // ok == true, d == 1234.56 -.br - d = c.toDouble( "1,234.56", &ok ); // ok == true, d == 1234.56 -.br - d = c.toDouble( "1234,56", &ok ); // ok == false -.br -.br - QLocale german(QLocale::German); -.br - d = german.toDouble( "1234,56", &ok ); // ok == true, d == 1234.56 -.br - d = german.toDouble( "1.234,56", &ok ); // ok == true, d == 1234.56 -.br - d = german.toDouble( "1234.56", &ok ); // ok == false -.br -.br - d = german.toDouble( "1.234", &ok ); // ok == true, d == 1234.0 -.br -.fi -.PP -Notice that the last conversion returns 1234.0, because '.' is the thousands group separator in the German locale. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString() and QString::toDouble(). -.SH "float QLocale::toFloat ( const QString & s, bool * ok = 0 ) const" -Returns the float represented by the localized string \fIs\fR, or 0.0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "int QLocale::toInt ( const QString & s, bool * ok = 0 ) const" -Returns the int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "TQ_LONG QLocale::toLong ( const QString & s, bool * ok = 0 ) const" -Returns the long int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "TQ_LLONG QLocale::toLongLong ( const QString & s, bool * ok = 0 ) const" -Returns the long long int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "short QLocale::toShort ( const QString & s, bool * ok = 0 ) const" -Returns the short int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "QString QLocale::toString ( TQ_LLONG i ) const" -Returns a localized string representation of \fIi\fR. -.PP -See also toLongLong(). -.SH "QString QLocale::toString ( short i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also toShort(). -.SH "QString QLocale::toString ( ushort i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also toUShort(). -.SH "QString QLocale::toString ( int i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also toInt(). -.SH "QString QLocale::toString ( uint i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also toUInt(). -.SH "QString QLocale::toString ( TQ_LONG i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also toLong(). -.SH "QString QLocale::toString ( TQ_ULONG i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also toULong(). -.SH "QString QLocale::toString ( TQ_ULLONG i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also toULongLong(). -.SH "QString QLocale::toString ( float i, char f = 'g', int prec = 6 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIf\fR and \fIprec\fR have the same meaning as in QString::number(double, char, int). -.PP -See also toDouble(). -.SH "QString QLocale::toString ( double i, char f = 'g', int prec = 6 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIf\fR and \fIprec\fR have the same meaning as in QString::number(double, char, int). -.PP -See also toDouble(). -.SH "uint QLocale::toUInt ( const QString & s, bool * ok = 0 ) const" -Returns the unsigned int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "TQ_ULONG QLocale::toULong ( const QString & s, bool * ok = 0 ) const" -Returns the unsigned long int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "TQ_ULLONG QLocale::toULongLong ( const QString & s, bool * ok = 0 ) const" -Returns the unsigned long long int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). -.SH "ushort QLocale::toUShort ( const QString & s, bool * ok = 0 ) const" -Returns the unsigned short int represented by the localized string \fIs\fR, or 0 if the conversion failed. -.PP -If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. -.PP -This function ignores leading and trailing whitespace. -.PP -See also toString(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlocale.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlocale.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qlocalfs.3qt b/doc/man/man3/qlocalfs.3qt deleted file mode 100644 index 13ffcab91..000000000 --- a/doc/man/man3/qlocalfs.3qt +++ /dev/null @@ -1,67 +0,0 @@ -'\" t -.TH QLocalFs 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 -QLocalFs \- Implementation of a QNetworkProtocol that works on the local file system -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QNetworkProtocol. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQLocalFs\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QLocalFs class is an implementation of a QNetworkProtocol that works on the local file system. -.PP -This class is derived from QNetworkProtocol. QLocalFs is not normally used directly, but rather through a QUrlOperator, for example: -.PP -.nf -.br - QUrlOperator op( "file:///tmp" ); -.br - op.listChildren(); // Asks the server to provide a directory listing -.br -.fi -.PP -This code will only work if the QLocalFs class is registered; to register the class, you must call tqInitNetworkProtocols() before using a QUrlOperator with QLocalFs. -.PP -If you really need to use QLocalFs directly, don't forget to set its QUrlOperator with setUrl(). -.PP -See also Qt Network Documentation, QNetworkProtocol, QUrlOperator, and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QLocalFs::QLocalFs ()" -Constructor. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlocalfs.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qlocalfs.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmacmime.3qt b/doc/man/man3/qmacmime.3qt deleted file mode 100644 index fa0b0cb5c..000000000 --- a/doc/man/man3/qmacmime.3qt +++ /dev/null @@ -1,150 +0,0 @@ -'\" t -.TH QMacMime 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 -QMacMime \- Maps open-standard MIME to Mac flavors -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMacMime\fR ( char t )" -.br -.ti -1c -.BI "virtual \fB~QMacMime\fR ()" -.br -.ti -1c -.BI "virtual const char * \fBconvertorName\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBcountFlavors\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBflavor\fR ( int index ) = 0" -.br -.ti -1c -.BI "virtual bool \fBcanConvert\fR ( const char * mime, int flav ) = 0" -.br -.ti -1c -.BI "virtual const char * \fBmimeFor\fR ( int flav ) = 0" -.br -.ti -1c -.BI "virtual int \fBflavorFor\fR ( const char * mime ) = 0" -.br -.ti -1c -.BI "virtual QByteArray \fBconvertToMime\fR ( QValueList data, const char * mime, int flav ) = 0" -.br -.ti -1c -.BI "virtual QValueList \fBconvertFromMime\fR ( QByteArray data, const char * mime, int flav ) = 0" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QPtrList \fBall\fR ( QMacMimeType t )" -.br -.ti -1c -.BI "QMacMime * \fBconvertor\fR ( QMacMimeType t, const char * mime, int flav )" -.br -.ti -1c -.BI "const char * \fBflavorToMime\fR ( QMacMimeType t, int flav )" -.br -.in -1c -.SH DESCRIPTION -The QMacMime class maps open-standard MIME to Mac flavors. -.PP -Qt's drag-and-drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol, but on Mac although some applications use MIME types to describe clipboard formats, others use arbitrary non-standardized naming conventions, or unnamed built-in Mac formats. -.PP -By instantiating subclasses of QMacMime that provide conversions between Mac flavors and MIME formats, you can convert proprietary clipboard formats to MIME formats. -.PP -Qt has predefined support for the following Mac flavors: -.TP -kScrapFlavorTypeUnicode - converted to "text/plain;charset=ISO-10646-UCS-2" and supported by QTextDrag. -.TP -kScrapFlavorTypeText - converted to "text/plain;charset=system" or "text/plain" and supported by QTextDrag. -.TP -kScrapFlavorTypePicture - converted to "image/format", where format is a Qt image format, and supported by QImageDrag. -.TP -kDragFlavorTypeHFS - converted to "text/uri-list", and supported by QUriDrag. -.PP -You can check if a MIME type is convertible using canConvert() and can perform conversions with convertToMime() and convertFromMime(). -.PP -See also Drag And Drop Classes, Input/Output and Networking, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMacMime::QMacMime ( char t )" -Constructs a new conversion object of type \fIt\fR, adding it to the globally accessed list of available convertors. -.SH "QMacMime::~QMacMime ()\fC [virtual]\fR" -Destroys a conversion object, removing it from the global list of available convertors. -.SH "QPtrList QMacMime::all ( QMacMimeType t )\fC [static]\fR" -Returns a list of all currently defined QMacMime objects of type \fIt\fR. -.SH "bool QMacMime::canConvert ( const char * mime, int flav )\fC [pure virtual]\fR" -Returns TRUE if the convertor can convert (both ways) between \fImime\fR and \fIflav\fR; otherwise returns FALSE. -.PP -All subclasses must reimplement this pure virtual function. -.SH "QValueList QMacMime::convertFromMime ( QByteArray data, const char * mime, int flav )\fC [pure virtual]\fR" -Returns \fIdata\fR converted from MIME type \fImime\fR to Mac flavor \fIflav\fR. -.PP -Note that Mac flavors must all be self-terminating. The return value may contain trailing data. -.PP -All subclasses must reimplement this pure virtual function. -.SH "QByteArray QMacMime::convertToMime ( QValueList data, const char * mime, int flav )\fC [pure virtual]\fR" -Returns \fIdata\fR converted from Mac flavor \fIflav\fR to MIME type \fImime\fR. -.PP -Note that Mac flavors must all be self-terminating. The input \fIdata\fR may contain trailing data. -.PP -All subclasses must reimplement this pure virtual function. -.SH "QMacMime * QMacMime::convertor ( QMacMimeType t, const char * mime, int flav )\fC [static]\fR" -Returns the most-recently created QMacMime of type \fIt\fR that can convert between the \fImime\fR and \fIflav\fR formats. Returns 0 if no such convertor exists. -.SH "const char * QMacMime::convertorName ()\fC [pure virtual]\fR" -Returns a name for the convertor. -.PP -All subclasses must reimplement this pure virtual function. -.SH "int QMacMime::countFlavors ()\fC [pure virtual]\fR" -Returns the number of Mac flavors supported by this convertor. -.PP -All subclasses must reimplement this pure virtual function. -.SH "int QMacMime::flavor ( int index )\fC [pure virtual]\fR" -Returns the Mac flavor supported by this convertor that is ordinarily at position \fIindex\fR. This means that flavor(0) returns the first Mac flavor supported, and flavor(countFlavors()-1) returns the last. If \fIindex\fR is out of range the return value is undefined. -.PP -All subclasses must reimplement this pure virtual function. -.SH "int QMacMime::flavorFor ( const char * mime )\fC [pure virtual]\fR" -Returns the Mac flavor used for MIME type \fImime\fR, or 0 if this convertor does not support \fImime\fR. -.PP -All subclasses must reimplement this pure virtual function. -.SH "const char * QMacMime::flavorToMime ( QMacMimeType t, int flav )\fC [static]\fR" -Returns a MIME type of type \fIt\fR for \fIflav\fR, or 0 if none exists. -.SH "const char * QMacMime::mimeFor ( int flav )\fC [pure virtual]\fR" -Returns the MIME type used for Mac flavor \fIflav\fR, or 0 if this convertor does not support \fIflav\fR. -.PP -All subclasses must reimplement this pure virtual function. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmacmime.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmacmime.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmacstyle.3qt b/doc/man/man3/qmacstyle.3qt deleted file mode 100644 index 761714712..000000000 --- a/doc/man/man3/qmacstyle.3qt +++ /dev/null @@ -1,135 +0,0 @@ -'\" t -.TH QMacStyle 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 -QMacStyle \- Implements an Appearance Manager style -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWindowsStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMacStyle\fR ()" -.br -.ti -1c -.BI "virtual \fB~QMacStyle\fR ()" -.br -.ti -1c -.BI "enum \fBFocusRectPolicy\fR { FocusEnabled, FocusDisabled, FocusDefault }" -.br -.ti -1c -.BI "enum \fBWidgetSizePolicy\fR { SizeSmall, SizeLarge, SizeNone, SizeDefault }" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBsetFocusRectPolicy\fR ( QWidget * w, FocusRectPolicy policy )" -.br -.ti -1c -.BI "FocusRectPolicy \fBfocusRectPolicy\fR ( QWidget * w )" -.br -.ti -1c -.BI "void \fBsetWidgetSizePolicy\fR ( QWidget * w, WidgetSizePolicy policy )" -.br -.ti -1c -.BI "WidgetSizePolicy \fBwidgetSizePolicy\fR ( QWidget * w )" -.br -.in -1c -.SH DESCRIPTION -The QMacStyle class implements an Appearance Manager style. -.PP -This class is implemented as a wrapper to the Apple Appearance Manager. This allows your application to be styled by whatever theme your Macintosh is using. This is done by having primitives in QStyle implemented in terms of what the Macintosh would normally theme (i.e. the Finder). -.PP -There are additional issues that should be taken into consideration to make an application compatible with the Aqua Style Guidelines. Some of these issues are outlined below. -.IP -.TP -Layout - The restrictions on window layout are such that some aspects of layout that are style-dependent cannot be achieved using QLayout. Changes are being considered (and feedback would be appreciated) to make layouts QStyle-able. Some of the restrictions involve horizontal and vertical widget alignment and widget size (covered below). -.IP -.TP -Widget size - Aqua allows widgets to have specific fixed sizes. Qt does not fully implement this behaviour so as to maintain multiplatform compatibility. As a result some widgets sizes may be inappropriate (and subsequently not rendered correctly by the Appearance Manager).The QWidget::sizeHint() will return the appropriate size for many managed widgets (widgets enumerated in QStyle::ContentsType). -.IP -.TP -Effects - QMacStyle (in contrast to QAquaStyle) is not emulating (except where Appearance Manager does not provide certain capabilities), for example QPushButton pulsing effects. In this case a near matching emulation has been implemented, but naturally this will not be identical to the similar functionality built into the Appearance Manager. Please report any issues you see in effects or non-standard widgets. -.IP -.PP -There are other issues that need to be considered in the feel of your application (including the general color scheme to match the Aqua colors). The Guidelines mentioned above will remain current with new advances and design suggestions for Mac OS X. -.PP -Note that the functions provided by QMacStyle are reimplementations of QStyle functions; see QStyle for their documentation. -.PP -See also Widget Appearance and Style. -.SS "Member Type Documentation" -.SH "QMacStyle::FocusRectPolicy" -This type is used to signify a widget's focus rectangle policy. -.TP -\fCQMacStyle::FocusEnabled\fR - show a focus rectangle when the widget has focus. -.TP -\fCQMacStyle::FocusDisabled\fR - never show a focus rectangle for the widget. -.TP -\fCQMacStyle::FocusDefault\fR - show a focus rectangle when the widget has focus and the widget is a QSpinWidget, QDateTimeEdit, QLineEdit, QListBox, QListView, editable QTextEdit, or one of their subclasses. -.SH "QMacStyle::WidgetSizePolicy" -.TP -\fCQMacStyle::SizeSmall\fR -.TP -\fCQMacStyle::SizeLarge\fR -.TP -\fCQMacStyle::SizeNone\fR -.TP -\fCQMacStyle::SizeDefault\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMacStyle::QMacStyle ()" -Constructs a QMacStyle object. -.SH "QMacStyle::~QMacStyle ()\fC [virtual]\fR" -Destructs a QMacStyle object. -.SH "FocusRectPolicy QMacStyle::focusRectPolicy ( QWidget * w )\fC [static]\fR" -Returns the focus rectangle policy for the widget \fIw\fR. -.PP -The focus rectangle policy can be one of QMacStyle::FocusRectPolicy. -.PP -See also setFocusRectPolicy(). -.SH "void QMacStyle::setFocusRectPolicy ( QWidget * w, FocusRectPolicy policy )\fC [static]\fR" -Sets the focus rectangle policy of \fIw\fR. The \fIpolicy\fR can be one of QMacStyle::FocusRectPolicy. -.PP -See also focusRectPolicy(). -.SH "void QMacStyle::setWidgetSizePolicy ( QWidget * w, WidgetSizePolicy policy )\fC [static]\fR" -Sets the widget size policy of \fIw\fR. The \fIpolicy\fR can be one of QMacStyle::WidgetSizePolicy. -.PP -See also widgetSizePolicy(). -.SH "WidgetSizePolicy QMacStyle::widgetSizePolicy ( QWidget * w )\fC [static]\fR" -Returns the widget size policy for the widget \fIw\fR. -.PP -The widget size policy can be one of QMacStyle::WidgetSizePolicy. -.PP -See also setWidgetSizePolicy(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmacstyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmacstyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmainwindow.3qt b/doc/man/man3/qmainwindow.3qt deleted file mode 100644 index 0bdd8a7b6..000000000 --- a/doc/man/man3/qmainwindow.3qt +++ /dev/null @@ -1,845 +0,0 @@ -'\" t -.TH QMainWindow 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 -QMainWindow \- Main application window, with a menu bar, dock windows (e.g. for toolbars), and a status bar -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMainWindow\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = WType_TopLevel )" -.br -.ti -1c -.BI "\fB~QMainWindow\fR ()" -.br -.ti -1c -.BI "QMenuBar * \fBmenuBar\fR () const" -.br -.ti -1c -.BI "QStatusBar * \fBstatusBar\fR () const" -.br -.ti -1c -.BI "QToolTipGroup * \fBtoolTipGroup\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCentralWidget\fR ( QWidget * w )" -.br -.ti -1c -.BI "QWidget * \fBcentralWidget\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDockEnabled\fR ( Dock dock, bool enable )" -.br -.ti -1c -.BI "bool \fBisDockEnabled\fR ( Dock dock ) const" -.br -.ti -1c -.BI "bool \fBisDockEnabled\fR ( QDockArea * area ) const" -.br -.ti -1c -.BI "virtual void \fBsetDockEnabled\fR ( QDockWindow * dw, Dock dock, bool enable )" -.br -.ti -1c -.BI "bool \fBisDockEnabled\fR ( QDockWindow * tb, Dock dock ) const" -.br -.ti -1c -.BI "bool \fBisDockEnabled\fR ( QDockWindow * dw, QDockArea * area ) const" -.br -.ti -1c -.BI "virtual void \fBaddDockWindow\fR ( QDockWindow * dockWindow, Dock edge = DockTop, bool newLine = FALSE )" -.br -.ti -1c -.BI "virtual void \fBaddDockWindow\fR ( QDockWindow * dockWindow, const QString & label, Dock edge = DockTop, bool newLine = FALSE )" -.br -.ti -1c -.BI "virtual void \fBmoveDockWindow\fR ( QDockWindow * dockWindow, Dock edge = DockTop )" -.br -.ti -1c -.BI "virtual void \fBmoveDockWindow\fR ( QDockWindow * dockWindow, Dock edge, bool nl, int index, int extraOffset = -1 )" -.br -.ti -1c -.BI "virtual void \fBremoveDockWindow\fR ( QDockWindow * dockWindow )" -.br -.ti -1c -.BI "bool rightJustification () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBusesBigPixmaps\fR () const" -.br -.ti -1c -.BI "bool \fBusesTextLabel\fR () const" -.br -.ti -1c -.BI "bool \fBdockWindowsMovable\fR () const" -.br -.ti -1c -.BI "bool \fBopaqueMoving\fR () const" -.br -.ti -1c -.BI "bool \fBgetLocation\fR ( QDockWindow * dw, Dock & dock, int & index, bool & nl, int & extraOffset ) const" -.br -.ti -1c -.BI "QPtrList \fBdockWindows\fR ( Dock dock ) const" -.br -.ti -1c -.BI "QPtrList \fBdockWindows\fR () const" -.br -.ti -1c -.BI "void \fBlineUpDockWindows\fR ( bool keepNewLines = FALSE )" -.br -.ti -1c -.BI "bool \fBisDockMenuEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBhasDockWindow\fR ( QDockWindow * dw )" -.br -.ti -1c -.BI "void addToolBar ( QDockWindow *, Dock = DockTop, bool newLine = FALSE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void addToolBar ( QDockWindow *, const QString & label, Dock = DockTop, bool newLine = FALSE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void moveToolBar ( QDockWindow *, Dock = DockTop ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void moveToolBar ( QDockWindow *, Dock, bool nl, int index, int extraOffset = -1 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void removeToolBar ( QDockWindow * ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool toolBarsMovable () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QPtrList \fBtoolBars\fR ( Dock dock ) const" -.br -.ti -1c -.BI "void lineUpToolBars ( bool keepNewLines = FALSE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QDockArea * \fBleftDock\fR () const" -.br -.ti -1c -.BI "QDockArea * \fBrightDock\fR () const" -.br -.ti -1c -.BI "QDockArea * \fBtopDock\fR () const" -.br -.ti -1c -.BI "QDockArea * \fBbottomDock\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisCustomizable\fR () const" -.br -.ti -1c -.BI "bool \fBappropriate\fR ( QDockWindow * dw ) const" -.br -.ti -1c -.BI "enum \fBDockWindows\fR { OnlyToolBars, NoToolBars, AllDockWindows }" -.br -.ti -1c -.BI "QPopupMenu * \fBcreateDockWindowMenu\fR ( DockWindows dockWindows = AllDockWindows ) const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void setRightJustification ( bool ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void \fBsetUsesBigPixmaps\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetUsesTextLabel\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetDockWindowsMovable\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetOpaqueMoving\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetDockMenuEnabled\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBwhatsThis\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetAppropriate\fR ( QDockWindow * dw, bool a )" -.br -.ti -1c -.BI "virtual void \fBcustomize\fR ()" -.br -.ti -1c -.BI "void setToolBarsMovable ( bool ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBpixmapSizeChanged\fR ( bool )" -.br -.ti -1c -.BI "void \fBusesTextLabelChanged\fR ( bool )" -.br -.ti -1c -.BI "void \fBdockWindowPositionChanged\fR ( QDockWindow * dockWindow )" -.br -.ti -1c -.BI "void toolBarPositionChanged ( QToolBar * ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBdockWindowsMovable\fR - whether the dock windows are movable" -.br -.ti -1c -.BI "bool \fBopaqueMoving\fR - whether dock windows are moved opaquely" -.br -.ti -1c -.BI "bool rightJustification - whether the main window right-justifies its dock windows \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBusesBigPixmaps\fR - whether big pixmaps are enabled" -.br -.ti -1c -.BI "bool \fBusesTextLabel\fR - whether text labels for toolbar buttons are enabled" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBchildEvent\fR ( QChildEvent * e )" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetUpLayout\fR ()" -.br -.ti -1c -.BI "virtual bool \fBshowDockMenu\fR ( const QPoint & globalPos )" -.br -.ti -1c -.BI "void \fBmenuAboutToShow\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( QTextStream & ts, const QMainWindow & mainWindow )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( QTextStream & ts, QMainWindow & mainWindow )" -.br -.in -1c -.SH DESCRIPTION -The QMainWindow class provides a main application window, with a menu bar, dock windows (e.g. for toolbars), and a status bar. -.PP -Main windows are most often used to provide menus, toolbars and a status bar around a large central widget, such as a text edit, drawing canvas or QWorkspace (for MDI applications). QMainWindow is usually subclassed since this makes it easier to encapsulate the central widget, menus and toolbars as well as the window's state. Subclassing makes it possible to create the slots that are called when the user clicks menu items or toolbar buttons. You can also create main windows using Qt Designer. We'll briefly review adding menu items and toolbar buttons then describe the facilities of QMainWindow itself. -.PP -.nf -.br - QMainWindow *mw = new QMainWindow; -.br - QTextEdit *edit = new QTextEdit( mw, "editor" ); -.br - edit->setFocus(); -.br - mw->setCaption( "Main Window" ); -.br - mw->setCentralWidget( edit ); -.br - mw->show(); -.br -.fi -.PP -QMainWindows may be created in their own right as shown above. The central widget is set with setCentralWidget(). Popup menus can be added to the default menu bar, widgets can be added to the status bar, toolbars and dock windows can be added to any of the dock areas. -.PP -.nf -.br - ApplicationWindow *mw = new ApplicationWindow(); -.br - mw->setCaption( "Qt Example - Application" ); -.br - mw->show(); -.fi -.PP -In the extract above ApplicationWindow is a subclass of QMainWindow that we must write for ourselves; this is the usual approach to using QMainWindow. (The source for the extracts in this description are taken from application/main.cpp, application/application.cpp, action/main.cpp, and action/application.cpp ) -.PP -When subclassing we add the menu items and toolbars in the subclass's constructor. If we've created a QMainWindow instance directly we can add menu items and toolbars just as easily by passing the QMainWindow instance as the parent instead of the \fIthis\fR pointer. -.PP -.nf -.br - QPopupMenu * help = new QPopupMenu( this ); -.br - menuBar()->insertItem( "&Help", help ); -.br -.br - help->insertItem( "&About", this, SLOT(about()), Key_F1 ); -.fi -.PP -Here we've added a new menu with one menu item. The menu has been inserted into the menu bar that QMainWindow provides by default and which is accessible through the menuBar() function. The slot will be called when the menu item is clicked. -.PP -.nf -.br - QToolBar * fileTools = new QToolBar( this, "file operations" ); -.br - fileTools->setLabel( "File Operations" ); -.fi -.PP -.nf -.br - QToolButton * fileOpen -.br - = new QToolButton( openIcon, "Open File", QString::null, -.br - this, SLOT(choose()), fileTools, "open file" ); -.fi -.PP -This extract shows the creation of a toolbar with one toolbar button. QMainWindow supplies four dock areas for toolbars. When a toolbar is created as a child of a QMainWindow (or derived class) instance it will be placed in a dock area (the Top dock area by default). The slot will be called when the toolbar button is clicked. Any dock window can be added to a dock area either using addDockWindow(), or by creating a dock window with the QMainWindow as the parent. -.PP -.nf -.br - e = new QTextEdit( this, "editor" ); -.br - e->setFocus(); -.br - setCentralWidget( e ); -.br - statusBar()->message( "Ready", 2000 ); -.fi -.PP -Having created the menus and toolbar we create an instance of the large central widget, give it the focus and set it as the main window's central widget. In the example we've also set the status bar, accessed via the statusBar() function, to an initial message which will be displayed for two seconds. Note that you can add additional widgets to the status bar, for example labels, to show further status information. See the QStatusBar documentation for details, particularly the addWidget() function. -.PP -Often we want to synchronize a toolbar button with a menu item. For example, if the user clicks a 'bold' toolbar button we want the 'bold' menu item to be checked. This synchronization can be achieved automatically by creating actions and adding the actions to the toolbar and menu. -.PP -.nf -.br - QAction * fileOpenAction; -.fi -.PP -.nf -.br - fileOpenAction = new QAction( QPixmap( fileopen ), "&Open...", -.br - CTRL+Key_O, this, "open" ); -.br - connect( fileOpenAction, SIGNAL( activated() ) , this, SLOT( choose() ) ); -.fi -.PP -Here we create an action with an icon which will be used in any menu and toolbar that the action is added to. We've also given the action a menu name, '&Open', and a keyboard shortcut. The connection that we have made will be used when the user clicks either the menu item \fIor\fR the toolbar button. -.PP -.nf -.br - QPopupMenu * file = new QPopupMenu( this ); -.br - menuBar()->insertItem( "&File", file ); -.fi -.PP -.nf -.br - fileOpenAction->addTo( file ); -.fi -.PP -The extract above shows the creation of a popup menu. We add the menu to the QMainWindow's menu bar and add our action. -.PP -.nf -.br - QToolBar * fileTools = new QToolBar( this, "file operations" ); -.br - fileTools->setLabel( "File Operations" ); -.br - fileOpenAction->addTo( fileTools ); -.fi -.PP -Here we create a new toolbar as a child of the QMainWindow and add our action to the toolbar. -.PP -We'll now explore the functionality offered by QMainWindow. -.PP -The main window will take care of the dock areas, and the geometry of the central widget, but all other aspects of the central widget are left to you. QMainWindow automatically detects the creation of a menu bar or status bar if you specify the QMainWindow as parent, or you can use the provided menuBar() and statusBar() functions. The functions menuBar() and statusBar() create a suitable widget if one doesn't exist, and update the window's layout to make space. -.PP -QMainWindow provides a QToolTipGroup connected to the status bar. The function toolTipGroup() provides access to the default QToolTipGroup. It isn't possible to set a different tool tip group. -.PP -New dock windows and toolbars can be added to a QMainWindow using addDockWindow(). Dock windows can be moved using moveDockWindow() and removed with removeDockWindow(). QMainWindow allows default dock window (toolbar) docking in all its dock areas (Top, Left, Right, Bottom). You can use setDockEnabled() to enable and disable docking areas for dock windows. When adding or moving dock windows you can specify their 'edge' (dock area). The currently available edges are: Top, Left, Right, Bottom, Minimized (effectively a 'hidden' dock area) and TornOff (floating). See Qt::Dock for an explanation of these areas. Note that the *ToolBar functions are included for backward compatibility; all new code should use the *DockWindow functions. QToolbar is a subclass of QDockWindow so all functions that work with dock windows work on toolbars in the same way. -.PP -If the user clicks the close button, then the dock window is hidden. A dock window can be hidden or unhidden by the user by right clicking a dock area and clicking the name of the relevant dock window on the pop up dock window menu. This menu lists the names of every dock window; visible dock windows have a tick beside their names. The dock window menu is created automatically as required by createDockWindowMenu(). Since it may not always be appropriate for a dock window to appear on this menu the setAppropriate() function is used to inform the main window whether or not the dock window menu should include a particular dock window. Double clicking a dock window handle (usually on the left-hand side of the dock window) undocks (floats) the dock window. Double clicking a floating dock window's titlebar will dock the floating dock window. (See also QMainWindow::DockWindows.) -.PP -Some functions change the appearance of a QMainWindow globally: -.TP -QDockWindow::setHorizontalStretchable() and QDockWindow::setVerticalStretchable() are used to make specific dock windows or toolbars stretchable. -.TP -setUsesBigPixmaps() is used to set whether tool buttons should draw small or large pixmaps (see QIconSet for more information). -.TP -setUsesTextLabel() is used to set whether tool buttons should display a textual label in addition to pixmaps (see QToolButton for more information). -.PP -The user can drag dock windows into any enabled docking area. Dock windows can also be dragged \fIwithin\fR a docking area, for example to rearrange the order of some toolbars. Dock windows can also be dragged outside any docking area (undocked or 'floated'). Being able to drag dock windows can be enabled (the default) and disabled using setDockWindowsMovable(). -.PP -The Minimized edge is a hidden dock area. If this dock area is enabled the user can hide (minimize) a dock window or show (restore) a minimized dock window by clicking the dock window handle. If the user hovers the mouse cursor over one of the handles, the caption of the dock window is displayed in a tool tip (see QDockWindow::caption() or QToolBar::label()), so if you enable the Minimized dock area, it is best to specify a meaningful caption or label for each dock window. To minimize a dock window programmatically use moveDockWindow() with an edge of Minimized. -.PP -Dock windows are moved transparently by default, i.e. during the drag an outline rectangle is drawn on the screen representing the position of the dock window as it moves. If you want the dock window to be shown normally whilst it is moved use setOpaqueMoving(). -.PP -The location of a dock window, i.e. its dock area and position within the dock area, can be determined by calling getLocation(). Movable dock windows can be lined up to minimize wasted space with lineUpDockWindows(). Pointers to the dock areas are available from topDock(), leftDock(), rightDock() and bottomDock(). A customize menu item is added to the pop up dock window menu if isCustomizable() returns TRUE; it returns FALSE by default. Reimplement isCustomizable() and customize() if you want to offer this extra menu item, for example, to allow the user to change settings relating to the main window and its toolbars and dock windows. -.PP -The main window's menu bar is fixed (at the top) by default. If you want a movable menu bar, create a QMenuBar as a stretchable widget inside its own movable dock window and restrict this dock window to only live within the Top or Bottom dock: -.PP -.nf -.br - QToolBar *tb = new QToolBar( this ); -.br - addDockWindow( tb, tr( "Menubar" ), Top, FALSE ); -.br - QMenuBar *mb = new QMenuBar( tb ); -.br - mb->setFrameStyle( QFrame::NoFrame ); -.br - tb->setStretchableWidget( mb ); -.br - setDockEnabled( tb, Left, FALSE ); -.br - setDockEnabled( tb, Right, FALSE ); -.br -.fi -.PP -An application with multiple dock windows can choose to save the current dock window layout in order to restore it later, e.g. in the next session. You can do this by using the streaming operators for QMainWindow. -.PP -To save the layout and positions of all the dock windows do this: -.PP -.nf -.br - QFile file( filename ); -.br - if ( file.open( IO_WriteOnly ) ) { -.br - QTextStream stream( &file ); -.br - stream << *mainWindow; -.br - file.close(); -.br - } -.br -.fi -.PP -To restore the dock window positions and sizes (normally when the application is next started), do following: -.PP -.nf -.br - QFile file( filename ); -.br - if ( file.open( IO_ReadOnly ) ) { -.br - QTextStream stream( &file ); -.br - stream >> *mainWindow; -.br - file.close(); -.br - } -.br -.fi -.PP -The QSettings class can be used in conjunction with the streaming operators to store the application's settings. -.PP -QMainWindow's management of dock windows and toolbars is done transparently behind-the-scenes by QDockArea. -.PP -For multi-document interfaces (MDI), use a QWorkspace as the central widget. -.PP -Adding dock windows, e.g. toolbars, to QMainWindow's dock areas is straightforward. If the supplied dock areas are not sufficient for your application we suggest that you create a QWidget subclass and add your own dock areas (see QDockArea) to the subclass since QMainWindow provides functionality specific to the standard dock areas it provides. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QToolBar, QDockWindow, QStatusBar, QAction, QMenuBar, QPopupMenu, QToolTipGroup, QDialog, and Main Window and Related Classes. -.SS "Member Type Documentation" -.SH "QMainWindow::DockWindows" -Right-clicking a dock area will pop-up the dock window menu (createDockWindowMenu() is called automatically). When called in code you can specify what items should appear on the menu with this enum. -.TP -\fCQMainWindow::OnlyToolBars\fR - The menu will list all the toolbars, but not any other dock windows. -.TP -\fCQMainWindow::NoToolBars\fR - The menu will list dock windows but not toolbars. -.TP -\fCQMainWindow::AllDockWindows\fR - The menu will list all toolbars and other dock windows. (This is the default.) -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMainWindow::QMainWindow ( QWidget * parent = 0, const char * name = 0, WFlags f = WType_TopLevel )" -Constructs an empty main window. The \fIparent\fR, \fIname\fR and widget flags \fIf\fR, are passed on to the QWidget constructor. -.PP -By default, the widget flags are set to WType_TopLevel rather than 0 as they are with QWidget. If you don't want your QMainWindow to be a top level widget then you will need to set \fIf\fR to 0. -.SH "QMainWindow::~QMainWindow ()" -Destroys the object and frees any allocated resources. -.SH "void QMainWindow::addDockWindow ( QDockWindow * dockWindow, Dock edge = DockTop, bool newLine = FALSE )\fC [virtual]\fR" -Adds \fIdockWindow\fR to the \fIedge\fR dock area. -.PP -If \fInewLine\fR is FALSE (the default) then the \fIdockWindow\fR is added at the end of the \fIedge\fR. For vertical edges the end is at the bottom, for horizontal edges (including Minimized) the end is at the right. If \fInewLine\fR is TRUE a new line of dock windows is started with \fIdockWindow\fR as the first (left-most and top-most) dock window. -.PP -If \fIdockWindow\fR is managed by another main window, it is first removed from that window. -.SH "void QMainWindow::addDockWindow ( QDockWindow * dockWindow, const QString & label, Dock edge = DockTop, bool newLine = FALSE )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds \fIdockWindow\fR to the dock area with label \fIlabel\fR. -.PP -If \fInewLine\fR is FALSE (the default) the \fIdockWindow\fR is added at the end of the \fIedge\fR. For vertical edges the end is at the bottom, for horizontal edges (including Minimized) the end is at the right. If \fInewLine\fR is TRUE a new line of dock windows is started with \fIdockWindow\fR as the first (left-most and top-most) dock window. -.PP -If \fIdockWindow\fR is managed by another main window, it is first removed from that window. -.SH "void QMainWindow::addToolBar ( QDockWindow *, Dock = DockTop, bool newLine = FALSE )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QMainWindow::addToolBar ( QDockWindow *, const QString & label, Dock = DockTop, bool newLine = FALSE )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "bool QMainWindow::appropriate ( QDockWindow * dw ) const" -Returns TRUE if it is appropriate to include a menu item for the \fIdw\fR dock window in the dock window menu; otherwise returns FALSE. -.PP -The user is able to change the state (show or hide) a dock window that has a menu item by clicking the item. -.PP -Call setAppropriate() to indicate whether or not a particular dock window should appear on the popup menu. -.PP -See also setAppropriate(). -.SH "QDockArea * QMainWindow::bottomDock () const" -Returns a pointer the Bottom dock area -.PP -See also topDock(), leftDock(), and rightDock(). -.SH "QWidget * QMainWindow::centralWidget () const" -Returns a pointer to the main window's central widget. -.PP -The central widget is surrounded by the left, top, right and bottom dock areas. The menu bar is above the top dock area. -.PP -See also setCentralWidget(). -.PP -Example: qfd/qfd.cpp. -.SH "void QMainWindow::childEvent ( QChildEvent * e )\fC [virtual protected]\fR" -Monitors events, recieved in \fIe\fR, to ensure the layout is updated. -.PP -Reimplemented from QObject. -.SH "QPopupMenu * QMainWindow::createDockWindowMenu ( DockWindows dockWindows = AllDockWindows ) const" -Creates the dock window menu which contains all toolbars (if \fIdockWindows\fR is OnlyToolBars ), all dock windows (if \fIdockWindows\fR is NoToolBars) or all toolbars and dock windows (if \fIdockWindows\fR is AllDockWindows - the default). -.PP -This function is called internally when necessary, e.g. when the user right clicks a dock area (providing isDockMenuEnabled() returns TRUE). -.PP -The menu items representing the toolbars and dock windows are checkable. The visible dock windows are checked and the hidden dock windows are unchecked. The user can click a menu item to change its state (show or hide the dock window). -.PP -The list and the state are always kept up-to-date. -.PP -Toolbars and dock windows which are not appropriate in the current context (see setAppropriate()) are not listed in the menu. -.PP -The menu also has a menu item for lining up the dock windows. -.PP -If isCustomizable() returns TRUE, a Customize menu item is added to the menu, which if clicked will call customize(). The isCustomizable() function we provide returns FALSE and customize() does nothing, so they must be reimplemented in a subclass to be useful. -.SH "void QMainWindow::customize ()\fC [virtual slot]\fR" -This function is called when the user clicks the Customize menu item on the dock window menu. -.PP -The customize menu item will only appear if isCustomizable() returns TRUE (it returns FALSE by default). -.PP -The function is intended, for example, to provide the user with a means of telling the application that they wish to customize the main window, dock windows or dock areas. -.PP -The default implementation does nothing and the Customize menu item is not shown on the right-click menu by default. If you want the item to appear then reimplement isCustomizable() to return TRUE, and reimplement this function to do whatever you want. -.PP -See also isCustomizable(). -.SH "void QMainWindow::dockWindowPositionChanged ( QDockWindow * dockWindow )\fC [signal]\fR" -This signal is emitted when the \fIdockWindow\fR has changed its position. A change in position occurs when a dock window is moved within its dock area or moved to another dock area (including the Minimized and \fCTearOff\fR dock areas). -.PP -See also getLocation(). -.SH "QPtrList QMainWindow::dockWindows ( Dock dock ) const" -Returns a list of all the dock windows which are in the \fIdock\fR dock area, regardless of their state. -.PP -For example, the DockTornOff dock area may contain closed dock windows but these are returned along with the visible dock windows. -.SH "QPtrList QMainWindow::dockWindows () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the list of dock windows which belong to this main window, regardless of which dock area they are in or what their state is, (e.g. irrespective of whether they are visible or not). -.SH "bool QMainWindow::dockWindowsMovable () const" -Returns TRUE if the dock windows are movable; otherwise returns FALSE. See the "dockWindowsMovable" property for details. -.SH "bool QMainWindow::getLocation ( QDockWindow * dw, Dock & dock, int & index, bool & nl, int & extraOffset ) const" -Finds the location of the dock window \fIdw\fR. -.PP -If the \fIdw\fR dock window is found in the main window the function returns TRUE and populates the \fIdock\fR variable with the dw's dock area and the \fIindex\fR with the dw's position within the dock area. It also sets \fInl\fR to TRUE if the \fIdw\fR begins a new line (otherwise FALSE), and \fIextraOffset\fR with the dock window's offset. -.PP -If the \fIdw\fR dock window is not found then the function returns FALSE and the state of \fIdock\fR, \fIindex\fR, \fInl\fR and \fIextraOffset\fR is undefined. -.PP -If you want to save and restore dock window positions then use operator>>() and operator<<(). -.PP -See also operator>>() and operator<<(). -.SH "bool QMainWindow::hasDockWindow ( QDockWindow * dw )" -Returns TRUE if \fIdw\fR is a dock window known to the main window; otherwise returns FALSE. -.SH "bool QMainWindow::isCustomizable () const\fC [virtual]\fR" -Returns TRUE if the dock area dock window menu includes the Customize menu item (which calls customize() when clicked). Returns FALSE by default, i.e. the popup menu will not contain a Customize menu item. You will need to reimplement this function and set it to return TRUE if you wish the user to be able to see the dock window menu. -.PP -See also customize(). -.SH "bool QMainWindow::isDockEnabled ( Dock dock ) const" -Returns TRUE if the \fIdock\fR dock area is enabled, i.e. it can accept user dragged dock windows; otherwise returns FALSE. -.PP -See also setDockEnabled(). -.SH "bool QMainWindow::isDockEnabled ( QDockArea * area ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if dock area \fIarea\fR is enabled, i.e. it can accept user dragged dock windows; otherwise returns FALSE. -.PP -See also setDockEnabled(). -.SH "bool QMainWindow::isDockEnabled ( QDockWindow * tb, Dock dock ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if dock area \fIdock\fR is enabled for the dock window \fItb\fR; otherwise returns FALSE. -.PP -See also setDockEnabled(). -.SH "bool QMainWindow::isDockEnabled ( QDockWindow * dw, QDockArea * area ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if dock area \fIarea\fR is enabled for the dock window \fIdw\fR; otherwise returns FALSE. -.PP -See also setDockEnabled(). -.SH "bool QMainWindow::isDockMenuEnabled () const" -Returns TRUE, if the dock window menu is enabled; otherwise returns FALSE. -.PP -The menu lists the (appropriate()) dock windows (which may be shown or hidden), and has a "Line Up Dock Windows" menu item. It will also have a "Customize" menu item if isCustomizable() returns TRUE. -.PP -See also setDockEnabled(), lineUpDockWindows(), appropriate(), and setAppropriate(). -.SH "QDockArea * QMainWindow::leftDock () const" -Returns the Left dock area -.PP -See also rightDock(), topDock(), and bottomDock(). -.SH "void QMainWindow::lineUpDockWindows ( bool keepNewLines = FALSE )" -This function will line up dock windows within the visible dock areas (Top, Left, Right and Bottom) as compactly as possible. -.PP -If \fIkeepNewLines\fR is TRUE, all dock windows stay on their original lines. If \fIkeepNewLines\fR is FALSE then newlines may be removed to achieve the most compact layout possible. -.PP -The method only works if dockWindowsMovable() returns TRUE. -.SH "void QMainWindow::lineUpToolBars ( bool keepNewLines = FALSE )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QMainWindow::menuAboutToShow ()\fC [protected slot]\fR" -This slot is called from the aboutToShow() signal of the default dock menu of the mainwindow. The default implementation initializes the menu with all dock windows and toolbars in this slot. -.SH "QMenuBar * QMainWindow::menuBar () const" -Returns the menu bar for this window. -.PP -If there isn't one, then menuBar() creates an empty menu bar. -.PP -See also statusBar(). -.SH "void QMainWindow::moveDockWindow ( QDockWindow * dockWindow, Dock edge = DockTop )\fC [virtual]\fR" -Moves \fIdockWindow\fR to the end of the \fIedge\fR. -.PP -For vertical edges the end is at the bottom, for horizontal edges (including Minimized) the end is at the right. -.PP -If \fIdockWindow\fR is managed by another main window, it is first removed from that window. -.SH "void QMainWindow::moveDockWindow ( QDockWindow * dockWindow, Dock edge, bool nl, int index, int extraOffset = -1 )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Moves \fIdockWindow\fR to position \fIindex\fR within the \fIedge\fR dock area. -.PP -Any dock windows with positions \fIindex\fR or higher have their position number incremented and any of these on the same line are moved right (down for vertical dock areas) to make room. -.PP -If \fInl\fR is TRUE, a new dock window line is created below the line in which the moved dock window appears and the moved dock window, with any others with higher positions on the same line, is moved to this new line. -.PP -The \fIextraOffset\fR is the space to put between the left side of the dock area (top side for vertical dock areas) and the dock window. (This is mostly used for restoring dock windows to the positions the user has dragged them to.) -.PP -If \fIdockWindow\fR is managed by another main window, it is first removed from that window. -.SH "void QMainWindow::moveToolBar ( QDockWindow *, Dock = DockTop )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QMainWindow::moveToolBar ( QDockWindow *, Dock, bool nl, int index, int extraOffset = -1 )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "bool QMainWindow::opaqueMoving () const" -Returns TRUE if dock windows are moved opaquely; otherwise returns FALSE. See the "opaqueMoving" property for details. -.SH "void QMainWindow::pixmapSizeChanged ( bool )\fC [signal]\fR" -This signal is emitted whenever the setUsesBigPixmaps() is called with a value different to the current setting. All widgets that should respond to such changes, e.g. toolbar buttons, must connect to this signal. -.SH "void QMainWindow::removeDockWindow ( QDockWindow * dockWindow )\fC [virtual]\fR" -Removes \fIdockWindow\fR from the main window's docking area, provided \fIdockWindow\fR is non-null and managed by this main window. -.SH "void QMainWindow::removeToolBar ( QDockWindow * )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QDockArea * QMainWindow::rightDock () const" -Returns the Right dock area -.PP -See also leftDock(), topDock(), and bottomDock(). -.SH "bool QMainWindow::rightJustification () const" -Returns TRUE if the main window right-justifies its dock windows; otherwise returns FALSE. See the "rightJustification" property for details. -.SH "void QMainWindow::setAppropriate ( QDockWindow * dw, bool a )\fC [virtual slot]\fR" -Use this function to control whether or not the \fIdw\fR dock window's caption should appear as a menu item on the dock window menu that lists the dock windows. -.PP -If \fIa\fR is TRUE then the \fIdw\fR will appear as a menu item on the dock window menu. The user is able to change the state (show or hide) a dock window that has a menu item by clicking the item; depending on the state of your application, this may or may not be appropriate. If \fIa\fR is FALSE the \fIdw\fR will not appear on the popup menu. -.PP -See also showDockMenu(), isCustomizable(), and customize(). -.SH "void QMainWindow::setCentralWidget ( QWidget * w )\fC [virtual]\fR" -Sets the central widget for this main window to \fIw\fR. -.PP -The central widget is surrounded by the left, top, right and bottom dock areas. The menu bar is above the top dock area. -.PP -See also centralWidget(). -.SH "void QMainWindow::setDockEnabled ( Dock dock, bool enable )\fC [virtual]\fR" -If \fIenable\fR is TRUE then users can dock windows in the \fIdock\fR area. If \fIenable\fR is FALSE users cannot dock windows in the \fIdock\fR dock area. -.PP -Users can dock (drag) dock windows into any enabled dock area. -.SH "void QMainWindow::setDockEnabled ( QDockWindow * dw, Dock dock, bool enable )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -If \fIenable\fR is TRUE then users can dock the \fIdw\fR dock window in the \fIdock\fR area. If \fIenable\fR is FALSE users cannot dock the \fIdw\fR dock window in the \fIdock\fR area. -.PP -In general users can dock (drag) dock windows into any enabled dock area. Using this function particular dock areas can be enabled (or disabled) as docking points for particular dock windows. -.SH "void QMainWindow::setDockMenuEnabled ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE, then right clicking on a dock window or dock area will pop up the dock window menu. If \fIb\fR is FALSE, right clicking a dock window or dock area will not pop up the menu. -.PP -The menu lists the (appropriate()) dock windows (which may be shown or hidden), and has a "Line Up Dock Windows" item. It will also have a "Customize" menu item if isCustomizable() returns TRUE. -.PP -See also lineUpDockWindows() and isDockMenuEnabled(). -.SH "void QMainWindow::setDockWindowsMovable ( bool )\fC [virtual slot]\fR" -Sets whether the dock windows are movable. See the "dockWindowsMovable" property for details. -.SH "void QMainWindow::setOpaqueMoving ( bool )\fC [virtual slot]\fR" -Sets whether dock windows are moved opaquely. See the "opaqueMoving" property for details. -.SH "void QMainWindow::setRightJustification ( bool )\fC [virtual slot]\fR" -Sets whether the main window right-justifies its dock windows. See the "rightJustification" property for details. -.SH "void QMainWindow::setToolBarsMovable ( bool )\fC [slot]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QMainWindow::setUpLayout ()\fC [virtual protected slot]\fR" -Sets up the geometry management of the window. It is called automatically when needed, so you shouldn't need to call it. -.SH "void QMainWindow::setUsesBigPixmaps ( bool )\fC [virtual slot]\fR" -Sets whether big pixmaps are enabled. See the "usesBigPixmaps" property for details. -.SH "void QMainWindow::setUsesTextLabel ( bool )\fC [virtual slot]\fR" -Sets whether text labels for toolbar buttons are enabled. See the "usesTextLabel" property for details. -.SH "bool QMainWindow::showDockMenu ( const QPoint & globalPos )\fC [virtual protected slot]\fR" -Shows the dock menu at the position \fIglobalPos\fR. The menu lists the dock windows so that they can be shown (or hidden), lined up, and possibly customized. Returns TRUE if the menu is shown; otherwise returns FALSE. -.PP -If you want a custom menu, reimplement this function. You can create the menu from scratch or call createDockWindowMenu() and modify the result. -.SH "QStatusBar * QMainWindow::statusBar () const" -Returns this main window's status bar. If there isn't one, statusBar() creates an empty status bar, and if necessary a tool tip group too. -.PP -See also menuBar() and toolTipGroup(). -.PP -Example: qfd/qfd.cpp. -.SH "void QMainWindow::toolBarPositionChanged ( QToolBar * )\fC [signal]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QPtrList QMainWindow::toolBars ( Dock dock ) const" -Returns a list of all the toolbars which are in the \fIdock\fR dock area, regardless of their state. -.PP -For example, the TornOff dock area may contain closed toolbars but these are returned along with the visible toolbars. -.PP -See also dockWindows(). -.SH "bool QMainWindow::toolBarsMovable () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QToolTipGroup * QMainWindow::toolTipGroup () const" -Returns this main window's tool tip group. If there isn't one, toolTipGroup() creates an empty tool tip group. -.PP -See also menuBar() and statusBar(). -.SH "QDockArea * QMainWindow::topDock () const" -Returns the Top dock area -.PP -See also bottomDock(), leftDock(), and rightDock(). -.SH "bool QMainWindow::usesBigPixmaps () const" -Returns TRUE if big pixmaps are enabled; otherwise returns FALSE. See the "usesBigPixmaps" property for details. -.SH "bool QMainWindow::usesTextLabel () const" -Returns TRUE if text labels for toolbar buttons are enabled; otherwise returns FALSE. See the "usesTextLabel" property for details. -.SH "void QMainWindow::usesTextLabelChanged ( bool )\fC [signal]\fR" -This signal is emitted whenever the setUsesTextLabel() is called with a value different to the current setting. All widgets that should respond to such changes, e.g. toolbar buttons, must connect to this signal. -.SH "void QMainWindow::whatsThis ()\fC [virtual slot]\fR" -Enters 'What's This?' mode and returns immediately. -.PP -This is the same as QWhatsThis::enterWhatsThisMode(), but implemented as a main window object's slot. This way it can easily be used for popup menus, for example: -.PP -.nf -.br - QPopupMenu * help = new QPopupMenu( this ); -.br - help->insertItem( "What's &This", this , SLOT(whatsThis()), SHIFT+Key_F1); -.br -.fi -.PP -See also QWhatsThis::enterWhatsThisMode(). -.SS "Property Documentation" -.SH "bool dockWindowsMovable" -This property holds whether the dock windows are movable. -.PP -If TRUE (the default), the user will be able to move movable dock windows from one QMainWindow dock area to another, including the \fCTearOff\fR area (i.e. where the dock window floats freely as a window in its own right), and the Minimized area (where only the dock window's handle is shown below the menu bar). Moveable dock windows can also be moved within QMainWindow dock areas, i.e. to rearrange them within a dock area. -.PP -If FALSE the user will not be able to move any dock windows. -.PP -By default dock windows are moved transparently (i.e. only an outline rectangle is shown during the drag), but this setting can be changed with setOpaqueMoving(). -.PP -See also setDockEnabled() and opaqueMoving. -.PP -Set this property's value with setDockWindowsMovable() and get this property's value with dockWindowsMovable(). -.SH "bool opaqueMoving" -This property holds whether dock windows are moved opaquely. -.PP -If TRUE the dock windows of the main window are shown opaquely (i.e. it shows the toolbar as it looks when docked) whilst it is being moved. If FALSE (the default) they are shown transparently, (i.e. as an outline rectangle). -.PP -\fBWarning:\fR Opaque moving of toolbars and dockwindows is known to have several problems. We recommend avoiding the use of this feature for the time being. We intend fixing the problems in a future release. -.PP -Set this property's value with setOpaqueMoving() and get this property's value with opaqueMoving(). -.SH "bool rightJustification" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This property holds whether the main window right-justifies its dock windows. -.PP -If disabled (the default), stretchable dock windows are expanded, and non-stretchable dock windows are given the minimum space they need. Since most dock windows are not stretchable, this usually results in an unjustified right edge (or unjustified bottom edge for a vertical dock area). If enabled, the main window will right-justify its dock windows. -.PP -See also QDockWindow::setVerticalStretchable() and QDockWindow::setHorizontalStretchable(). -.PP -Set this property's value with setRightJustification() and get this property's value with rightJustification(). -.SH "bool usesBigPixmaps" -This property holds whether big pixmaps are enabled. -.PP -If FALSE (the default), the tool buttons will use small pixmaps; otherwise big pixmaps will be used. -.PP -Tool buttons and other widgets that wish to respond to this setting are responsible for reading the correct state on startup, and for connecting to the main window's widget's pixmapSizeChanged() signal. -.PP -Set this property's value with setUsesBigPixmaps() and get this property's value with usesBigPixmaps(). -.SH "bool usesTextLabel" -This property holds whether text labels for toolbar buttons are enabled. -.PP -If disabled (the default), the tool buttons will not use text labels. If enabled, text labels will be used. -.PP -Tool buttons and other widgets that wish to respond to this setting are responsible for reading the correct state on startup, and for connecting to the main window's widget's usesTextLabelChanged() signal. -.PP -See also QToolButton::usesTextLabel. -.PP -Set this property's value with setUsesTextLabel() and get this property's value with usesTextLabel(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QTextStream & operator<< ( QTextStream & ts, const QMainWindow & mainWindow )" -Writes the layout (sizes and positions) of the dock windows in the dock areas of the QMainWindow \fImainWindow\fR, including Minimized and TornOff dock windows, to the text stream \fIts\fR. -.PP -This can be used, for example, in conjunction with QSettings to save the user's layout when the \\mainWindow receives a closeEvent. -.PP -See also operator>>() and closeEvent(). -.SH "QTextStream & operator>> ( QTextStream & ts, QMainWindow & mainWindow )" -Reads the layout (sizes and positions) of the dock windows in the dock areas of the QMainWindow \fImainWindow\fR from the text stream, \fIts\fR, including Minimized and TornOff dock windows. Restores the dock windows and dock areas to these sizes and positions. The layout information must be in the format produced by operator<<(). -.PP -This can be used, for example, in conjunction with QSettings to restore the user's layout. -.PP -See also operator<<(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmainwindow.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmainwindow.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmap.3qt b/doc/man/man3/qmap.3qt deleted file mode 100644 index efaf4c210..000000000 --- a/doc/man/man3/qmap.3qt +++ /dev/null @@ -1,554 +0,0 @@ -'\" t -.TH QMap 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 -QMap \- Value-based template class that provides a dictionary -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef Key \fBkey_type\fR" -.br -.ti -1c -.BI "typedef T \fBmapped_type\fR" -.br -.ti -1c -.BI "typedef QPair \fBvalue_type\fR" -.br -.ti -1c -.BI "typedef value_type * \fBpointer\fR" -.br -.ti -1c -.BI "typedef const value_type * \fBconst_pointer\fR" -.br -.ti -1c -.BI "typedef value_type & \fBreference\fR" -.br -.ti -1c -.BI "typedef const value_type & \fBconst_reference\fR" -.br -.ti -1c -.BI "typedef size_t \fBsize_type\fR" -.br -.ti -1c -.BI "typedef QMapIterator \fBiterator\fR" -.br -.ti -1c -.BI "typedef QMapConstIterator \fBconst_iterator\fR" -.br -.ti -1c -.BI "typedef QPair \fBinsert_pair\fR" -.br -.ti -1c -.BI "typedef QMapIterator \fBIterator\fR" -.br -.ti -1c -.BI "typedef QMapConstIterator \fBConstIterator\fR" -.br -.ti -1c -.BI "typedef T \fBValueType\fR" -.br -.ti -1c -.BI "\fBQMap\fR ()" -.br -.ti -1c -.BI "\fBQMap\fR ( const QMap & m )" -.br -.ti -1c -.BI "\fBQMap\fR ( const std::map & m )" -.br -.ti -1c -.BI "\fB~QMap\fR ()" -.br -.ti -1c -.BI "QMap & \fBoperator=\fR ( const QMap & m )" -.br -.ti -1c -.BI "QMap & \fBoperator=\fR ( const std::map & m )" -.br -.ti -1c -.BI "iterator \fBbegin\fR ()" -.br -.ti -1c -.BI "iterator \fBend\fR ()" -.br -.ti -1c -.BI "const_iterator \fBbegin\fR () const" -.br -.ti -1c -.BI "const_iterator \fBend\fR () const" -.br -.ti -1c -.BI "const_iterator \fBconstBegin\fR () const" -.br -.ti -1c -.BI "const_iterator \fBconstEnd\fR () const" -.br -.ti -1c -.BI "iterator \fBreplace\fR ( const Key & k, const T & v )" -.br -.ti -1c -.BI "size_type \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBempty\fR () const" -.br -.ti -1c -.BI "QPair \fBinsert\fR ( const value_type & x )" -.br -.ti -1c -.BI "void \fBerase\fR ( iterator it )" -.br -.ti -1c -.BI "void \fBerase\fR ( const key_type & k )" -.br -.ti -1c -.BI "size_type \fBcount\fR ( const key_type & k ) const" -.br -.ti -1c -.BI "T & \fBoperator[]\fR ( const Key & k )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "iterator \fBfind\fR ( const Key & k )" -.br -.ti -1c -.BI "const_iterator \fBfind\fR ( const Key & k ) const" -.br -.ti -1c -.BI "const T & \fBoperator[]\fR ( const Key & k ) const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const Key & k ) const" -.br -.ti -1c -.BI "size_type \fBcount\fR () const" -.br -.ti -1c -.BI "QValueList \fBkeys\fR () const" -.br -.ti -1c -.BI "QValueList \fBvalues\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "iterator \fBinsert\fR ( const Key & key, const T & value, bool overwrite = TRUE )" -.br -.ti -1c -.BI "void \fBremove\fR ( iterator it )" -.br -.ti -1c -.BI "void \fBremove\fR ( const Key & k )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBdetach\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QMap & m )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QMap & m )" -.br -.in -1c -.SH DESCRIPTION -The QMap class is a value-based template class that provides a dictionary. -.PP -QMap is a Qt implementation of an STL-like map container. It can be used in your application if the standard \fCmap\fR is not available on all your target platforms. QMap is part of the Qt Template Library. -.PP -QMap defines a template instance to create a dictionary with keys of type Key and values of type Data. QMap does not store pointers to the members of the map; instead, it holds a copy of every member. For this reason, QMap is value-based, whereas QPtrList and QDict are pointer-based. -.PP -QMap contains and manages a collection of objects of type Data with associated key values of type Key and provides iterators that allow the contained objects to be addressed. QMap owns the contained items. -.PP -Some classes cannot be used within a QMap. For example everything derived from QObject and thus all classes that implement widgets. Only values can be used in a QMap. To qualify as a value, the class must provide -.TP -A copy constructor -.TP -An assignment operator -.TP -A default constructor, i.e. a constructor that does not take any arguments. -.PP -Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases, this is sufficient. -.PP -The class used for the key requires that the \fCoperator<\fR is implemented to define ordering of the keys. -.PP -QMap's function naming is consistent with the other Qt classes (e.g., count(), isEmpty()). QMap also provides extra functions for compatibility with STL algorithms, such as size() and empty(). Programmers already familiar with the STL \fCmap\fR can use these the STL-like functions if preferred. -.PP -Example: -.PP -.nf -.br - #include -.br - #include -.br - #include -.br -.br - class Employee -.br - { -.br - public: -.br - Employee(): sn(0) {} -.br - Employee( const QString& forename, const QString& surname, int salary ) -.br - : fn(forename), sn(surname), sal(salary) -.br - { } -.br -.br - QString forename() const { return fn; } -.br - QString surname() const { return sn; } -.br - int salary() const { return sal; } -.br - void setSalary( int salary ) { sal = salary; } -.br -.br - private: -.br - QString fn; -.br - QString sn; -.br - int sal; -.br - }; -.br -.br - int main(int argc, char **argv) -.br - { -.br - QApplication app( argc, argv ); -.br -.br - typedef QMap EmployeeMap; -.br - EmployeeMap map; -.br -.br - map["JD001"] = Employee("John", "Doe", 50000); -.br - map["JW002"] = Employee("Jane", "Williams", 80000); -.br - map["TJ001"] = Employee("Tom", "Jones", 60000); -.br -.br - Employee sasha( "Sasha", "Hind", 50000 ); -.br - map["SH001"] = sasha; -.br - sasha.setSalary( 40000 ); -.br -.br - EmployeeMap::Iterator it; -.br - for ( it = map.begin(); it != map.end(); ++it ) { -.br - printf( "%s: %s, %s earns %d\\n", -.br - it.key().latin1(), -.br - it.data().surname().latin1(), -.br - it.data().forename().latin1(), -.br - it.data().salary() ); -.br - } -.br - return 0; -.br - } -.br -.fi -.PP -Program output: -.PP -.nf -.br - JD001: Doe, John earns 50000 -.br - JW002: Williams, Jane earns 80000 -.br - SH001: Hind, Sasha earns 50000 -.br - TJ001: Jones, Tom earns 60000 -.br -.fi -.PP -The latest changes to Sasha's salary did not affect the value in the list because the map created a copy of Sasha's entry. In addition, notice that the items are sorted alphabetically (by key) when iterating over the map. -.PP -There are several ways to find items in a map. The begin() and end() functions return iterators to the beginning and end of the map. The advantage of using an iterator is that you can move forward or backward by incrementing/decrementing the iterator. The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the map it belongs to, however it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. If the map is empty, the iterator returned by begin() will equal the iterator returned by end(). -.PP -Another way to find an element in the map is by using the find() function. This returns an iterator pointing to the desired item or to the end() iterator if no such element exists. -.PP -Another approach uses the operator[]. But be warned: if the map does not contain an entry for the element you are looking for, operator[] inserts a default value. If you do not know that the element you are searching for is really in the list, you should not use operator[]. The following example illustrates this: -.PP -.nf -.br - QMap map; -.br - map["Clinton"] = "Bill"; -.br - str << map["Clinton"] << map["Bush"] << endl; -.br -.fi -.PP -The code fragment will print out "Clinton", "". Since the value associated with the "Bush" key did not exist, the map inserted a default value (in this case, an empty string). If you are not sure whether a certain element is in the map, you should use find() and iterators instead. -.PP -If you just want to know whether a certain key is contained in the map, use the contains() function. In addition, count() tells you how many keys are in the map. -.PP -It is safe to have multiple iterators at the same time. If some member of the map is removed, only iterators pointing to the removed member become invalid; inserting in the map does not invalidate any iterators. -.PP -Since QMap is value-based, there is no need to be concerned about deleting items in the map. The map holds its own copies and will free them if the corresponding member or the map itself is deleted. -.PP -QMap is implicitly shared. This means you can just make copies of the map in time O(1). If multiple QMap instances share the same data and one is modifying the map's data, this modifying instance makes a copy and modifies its private copy: so it does not affect other instances. If a QMap is being used in a multi-threaded program, you must protect all access to the map. See QMutex. -.PP -There are a couple of ways of inserting new items into the map. One uses the insert() method; the other uses operator[]: -.PP -.nf -.br - QMap map; -.br - map["Clinton"] = "Bill"; -.br - map.insert( "Bush", "George" ); -.br -.fi -.PP -Items can also be removed from the map in several ways. One way is to pass an iterator to remove(). Another way is to pass a key value to remove(), which will delete the entry with the requested key. In addition you can clear the entire map using the clear() method. -.PP -See also QMapIterator, Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QMap::ConstIterator" -The map's const iterator type, Qt style. -.SH "QMap::Iterator" -The map's iterator type, Qt style. -.SH "QMap::ValueType" -Corresponds to QPair, Qt style. -.SH "QMap::const_iterator" -The map's const iterator type. -.SH "QMap::const_pointer" -Const pointer to value_type. -.SH "QMap::const_reference" -Const reference to value_type. -.SH "QMap::iterator" -The map's iterator type. -.SH "QMap::key_type" -The map's key type. -.SH "QMap::mapped_type" -The map's data type. -.SH "QMap::pointer" -Pointer to value_type. -.SH "QMap::reference" -Reference to value_type. -.SH "QMap::size_type" -An unsigned integral type, used to represent various sizes. -.SH "QMap::value_type" -Corresponds to QPair. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMap::QMap ()" -Constructs an empty map. -.SH "QMap::QMap ( const QMap & m )" -Constructs a copy of \fIm\fR. -.PP -This operation costs O(1) time because QMap is implicitly shared. This makes returning a QMap from a function very fast. If a shared instance is modified, it will be copied (copy-on-write), and this takes O(n) time. -.SH "QMap::QMap ( const std::map & m )" -Constructs a copy of \fIm\fR. -.SH "QMap::~QMap ()" -Destroys the map. References to the values in the map and all iterators of this map become invalidated. Since QMap is highly tuned for performance you won't see warnings if you use invalid iterators, because it is not possible for an iterator to check whether it is valid or not. -.SH "iterator QMap::begin ()" -Returns an iterator pointing to the first element in the map. This iterator equals end() if the map is empty. -.PP -The items in the map are traversed in the order defined by operator<(Key, Key). -.PP -See also end() and QMapIterator. -.SH "const_iterator QMap::begin () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also end() and QMapConstIterator. -.SH "void QMap::clear ()" -Removes all items from the map. -.PP -See also remove(). -.SH "const_iterator QMap::constBegin () const" -Returns an iterator pointing to the first element in the map. This iterator equals end() if the map is empty. -.PP -The items in the map are traversed in the order defined by operator<(Key, Key). -.PP -See also constEnd() and QMapConstIterator. -.SH "const_iterator QMap::constEnd () const" -The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the map it belongs to, but it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. -.PP -This iterator equals constBegin() if the map is empty. -.PP -See also constBegin() and QMapConstIterator. -.SH "bool QMap::contains ( const Key & k ) const" -Returns TRUE if the map contains an item with key \fIk\fR; otherwise returns FALSE. -.SH "size_type QMap::count ( const key_type & k ) const" -Returns the number of items whose key is \fIk\fR. Since QMap does not allow duplicate keys, the return value is always 0 or 1. -.PP -This function is provided for STL compatibility. -.SH "size_type QMap::count () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the number of items in the map. -.PP -See also isEmpty(). -.SH "void QMap::detach ()\fC [protected]\fR" -If the map does not share its data with another QMap instance, nothing happens; otherwise the function creates a new copy of this map and detaches from the shared one. This function is called whenever the map is modified. The implicit sharing mechanism is implemented this way. -.SH "bool QMap::empty () const" -Returns TRUE if the map contains no items; otherwise returns FALSE. -.PP -This function is provided for STL compatibility. It is equivalent to isEmpty(). -.PP -See also size(). -.SH "iterator QMap::end ()" -The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the map it belongs to, but it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. -.PP -This iterator equals begin() if the map is empty. -.PP -See also begin() and QMapIterator. -.SH "const_iterator QMap::end () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QMap::erase ( iterator it )" -Removes the item associated with the iterator \fIit\fR from the map. -.PP -This function is provided for STL compatibility. It is equivalent to remove(). -.PP -See also clear(). -.SH "void QMap::erase ( const key_type & k )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes the item with the key \fIk\fR from the map. -.SH "iterator QMap::find ( const Key & k )" -Returns an iterator pointing to the element with key \fIk\fR in the map. -.PP -Returns end() if no key matched. -.PP -See also QMapIterator. -.SH "const_iterator QMap::find ( const Key & k ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an iterator pointing to the element with key \fIk\fR in the map. -.PP -Returns end() if no key matched. -.PP -See also QMapConstIterator. -.SH "iterator QMap::insert ( const Key & key, const T & value, bool overwrite = TRUE )" -Inserts a new item with the key, \fIkey\fR, and a value of \fIvalue\fR. If there is already an item whose key is \fIkey\fR, that item's value is replaced with \fIvalue\fR, unless \fIoverwrite\fR is FALSE (it is TRUE by default). In this case an iterator to this item is returned, else an iterator to the new item is returned. -.SH "QPair QMap::insert ( const value_type & x )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the (key, value) pair \fIx\fR into the map. \fIx\fR is a QPair whose \fCfirst\fR element is a key to be inserted and whose \fCsecond\fR element is the associated value to be inserted. Returns a pair whose \fCfirst\fR element is an iterator pointing to the inserted item and whose \fCsecond\fR element is a bool indicating TRUE if \fIx\fR was inserted and FALSE if it was not inserted, e.g. because it was already present. -.PP -See also replace(). -.SH "bool QMap::isEmpty () const" -Returns TRUE if the map contains no items; otherwise returns FALSE. -.PP -See also count(). -.SH "QValueList QMap::keys () const" -Returns a list of all the keys in the map, in order. -.SH "QMap & QMap::operator= ( const QMap & m )" -Assigns \fIm\fR to this map and returns a reference to this map. -.PP -All iterators of the current map become invalidated by this operation. The cost of such an assignment is O(1), because QMap is implicitly shared. -.SH "QMap & QMap::operator= ( const std::map & m )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assigns \fIm\fR to this map and returns a reference to this map. -.PP -All iterators of the current map become invalidated by this operation. -.SH "T & QMap::operator[] ( const Key & k )" -Returns the value associated with the key \fIk\fR. If no such key is present, an empty item is inserted with this key and a reference to the empty item is returned. -.PP -You can use this operator both for reading and writing: -.PP -.nf -.br - QMap map; -.br - map["Clinton"] = "Bill"; -.br - stream << map["Clinton"]; -.br -.fi -.SH "const T & QMap::operator[] ( const Key & k ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBWarning:\fR This function differs from the non-const version of the same function. It will \fInot\fR insert an empty value if the key \fIk\fR does not exist. This may lead to logic errors in your program. You should check if the element exists before calling this function. -.PP -Returns the value associated with the key \fIk\fR. If no such key is present, a reference to an empty item is returned. -.SH "void QMap::remove ( iterator it )" -Removes the item associated with the iterator \fIit\fR from the map. -.PP -See also clear(). -.SH "void QMap::remove ( const Key & k )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes the item with the key \fIk\fR from the map. -.SH "iterator QMap::replace ( const Key & k, const T & v )" -Replaces the value of the element with key \fIk\fR, with the value \fIv\fR. -.PP -See also insert() and remove(). -.SH "size_type QMap::size () const" -Returns the number of items in the map. -.PP -This function is provided for STL compatibility. It is equivalent to count(). -.PP -See also empty(). -.SH "QValueList QMap::values () const" -Returns a list of all the values in the map, in key order. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QMap & m )" -Writes the map \fIm\fR to the stream \fIs\fR. The types \fIKey\fR and \fIT\fR must implement the streaming operator as well. -.SH "QDataStream & operator>> ( QDataStream & s, QMap & m )" -Reads the map \fIm\fR from the stream \fIs\fR. The types \fIKey\fR and \fIT\fR -must implement the streaming operator as well. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmapconstiterator.3qt b/doc/man/man3/qmapconstiterator.3qt deleted file mode 100644 index 3a4d27750..000000000 --- a/doc/man/man3/qmapconstiterator.3qt +++ /dev/null @@ -1,141 +0,0 @@ -'\" t -.TH QMapConstIterator 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 -QMapConstIterator \- Iterator for QMap -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef std::bidirectional_iterator_tag \fBiterator_category\fR" -.br -.ti -1c -.BI "typedef T \fBvalue_type\fR" -.br -.ti -1c -.BI "typedef const T * \fBpointer\fR" -.br -.ti -1c -.BI "typedef const T & \fBreference\fR" -.br -.ti -1c -.BI "\fBQMapConstIterator\fR ()" -.br -.ti -1c -.BI "\fBQMapConstIterator\fR ( QMapNode * p )" -.br -.ti -1c -.BI "\fBQMapConstIterator\fR ( const QMapConstIterator & it )" -.br -.ti -1c -.BI "\fBQMapConstIterator\fR ( const QMapIterator & it )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QMapConstIterator & it ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QMapConstIterator & it ) const" -.br -.ti -1c -.BI "const T & \fBoperator*\fR () const" -.br -.ti -1c -.BI "const K & \fBkey\fR () const" -.br -.ti -1c -.BI "const T & \fBdata\fR () const" -.br -.ti -1c -.BI "QMapConstIterator & \fBoperator++\fR ()" -.br -.ti -1c -.BI "QMapConstIterator \fBoperator++\fR ( int )" -.br -.ti -1c -.BI "QMapConstIterator & \fBoperator--\fR ()" -.br -.ti -1c -.BI "QMapConstIterator \fBoperator--\fR ( int )" -.br -.in -1c -.SH DESCRIPTION -The QMapConstIterator class provides an iterator for QMap. -.PP -In contrast to QMapIterator, this class is used to iterate over a const map. It does not allow you to modify the values of the map because this would break the const semantics. -.PP -For more information on QMap iterators, see QMapIterator and the QMap example. -.PP -See also QMap, QMapIterator, Qt Template Library Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QMapConstIterator::iterator_category" -The type of iterator category, \fCstd::bidirectional_iterator_tag\fR. -.SH "QMapConstIterator::pointer" -Const pointer to value_type. -.SH "QMapConstIterator::reference" -Const reference to value_type. -.SH "QMapConstIterator::value_type" -The type of const value. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMapConstIterator::QMapConstIterator ()" -Constructs an uninitialized iterator. -.SH "QMapConstIterator::QMapConstIterator ( QMapNode * p )" -Constructs an iterator starting at node \fIp\fR. -.SH "QMapConstIterator::QMapConstIterator ( const QMapConstIterator & it )" -Constructs a copy of the iterator, \fIit\fR. -.SH "QMapConstIterator::QMapConstIterator ( const QMapIterator & it )" -Constructs a copy of the iterator, \fIit\fR. -.SH "const T & QMapConstIterator::data () const" -Returns a const reference to the current item's data. -.SH "const K & QMapConstIterator::key () const" -Returns a const reference to the current item's key. -.SH "bool QMapConstIterator::operator!= ( const QMapConstIterator & it ) const" -Compares the iterator to the \fIit\fR iterator and returns FALSE if they point to the same item; otherwise returns TRUE. -.SH "const T & QMapConstIterator::operator* () const" -Dereference operator. Returns a const reference to the current item's data. The same as data(). -.SH "QMapConstIterator & QMapConstIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. -.SH "QMapConstIterator QMapConstIterator::operator++ ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. -.SH "QMapConstIterator & QMapConstIterator::operator-- ()" -Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. -.SH "QMapConstIterator QMapConstIterator::operator-- ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. -.SH "bool QMapConstIterator::operator== ( const QMapConstIterator & it ) const" -Compares the iterator to the \fIit\fR iterator and returns TRUE if -they point to the same item; otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmapconstiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmapconstiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmapiterator.3qt b/doc/man/man3/qmapiterator.3qt deleted file mode 100644 index 86633a4d5..000000000 --- a/doc/man/man3/qmapiterator.3qt +++ /dev/null @@ -1,152 +0,0 @@ -'\" t -.TH QMapIterator 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 -QMapIterator \- Iterator for QMap -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef std::bidirectional_iterator_tag \fBiterator_category\fR" -.br -.ti -1c -.BI "typedef T \fBvalue_type\fR" -.br -.ti -1c -.BI "typedef T * \fBpointer\fR" -.br -.ti -1c -.BI "typedef T & \fBreference\fR" -.br -.ti -1c -.BI "\fBQMapIterator\fR ()" -.br -.ti -1c -.BI "\fBQMapIterator\fR ( QMapNode * p )" -.br -.ti -1c -.BI "\fBQMapIterator\fR ( const QMapIterator & it )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QMapIterator & it ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QMapIterator & it ) const" -.br -.ti -1c -.BI "T & \fBoperator*\fR ()" -.br -.ti -1c -.BI "const T & \fBoperator*\fR () const" -.br -.ti -1c -.BI "const K & \fBkey\fR () const" -.br -.ti -1c -.BI "T & \fBdata\fR ()" -.br -.ti -1c -.BI "const T & \fBdata\fR () const" -.br -.ti -1c -.BI "QMapIterator & \fBoperator++\fR ()" -.br -.ti -1c -.BI "QMapIterator \fBoperator++\fR ( int )" -.br -.ti -1c -.BI "QMapIterator & \fBoperator--\fR ()" -.br -.ti -1c -.BI "QMapIterator \fBoperator--\fR ( int )" -.br -.in -1c -.SH DESCRIPTION -The QMapIterator class provides an iterator for QMap. -.PP -You cannot create an iterator by yourself. Instead, you must ask a map to give you one. An iterator is as big as a pointer; on 32-bit machines that means 4 bytes, on 64-bit machines, 8 bytes. That makes copying iterators very fast. Iterators behave in a similar way to pointers, and they are almost as fast as pointers. See the QMap example. -.PP -QMap is highly optimized for performance and memory usage, but the trade-off is that you must be more careful. The only way to traverse a map is to use iterators. QMap does not know about its iterators, and the iterators don't even know to which map they belong. That makes things fast but a bit dangerous because it is up to you to make sure that the iterators you are using are still valid. QDictIterator will be able to give warnings, whereas QMapIterator may end up in an undefined state. -.PP -For every Iterator there is also a ConstIterator. You must use the ConstIterator to access a QMap in a const environment or if the reference or pointer to the map is itself const. Its semantics are the same, but it only returns const references to the item it points to. -.PP -See also QMap, QMapConstIterator, Qt Template Library Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QMapIterator::iterator_category" -The type of iterator category, \fCstd::bidirectional_iterator_tag\fR. -.SH "QMapIterator::pointer" -Pointer to value_type. -.SH "QMapIterator::reference" -Reference to value_type. -.SH "QMapIterator::value_type" -The type of value. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMapIterator::QMapIterator ()" -Creates an uninitialized iterator. -.SH "QMapIterator::QMapIterator ( QMapNode * p )" -Constructs an iterator starting at node \fIp\fR. -.SH "QMapIterator::QMapIterator ( const QMapIterator & it )" -Constructs a copy of the iterator, \fIit\fR. -.SH "T & QMapIterator::data ()" -Returns a reference to the current item's data. -.SH "const T & QMapIterator::data () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const reference to the current item's data. -.SH "const K & QMapIterator::key () const" -Returns a const reference to the current item's key. -.SH "bool QMapIterator::operator!= ( const QMapIterator & it ) const" -Compares the iterator to the \fIit\fR iterator and returns FALSE if they point to the same item; otherwise returns TRUE. -.SH "T & QMapIterator::operator* ()" -Dereference operator. Returns a reference to the current item's data. The same as data(). -.SH "const T & QMapIterator::operator* () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Dereference operator. Returns a const reference to the current item's data. The same as data(). -.SH "QMapIterator & QMapIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. -.SH "QMapIterator QMapIterator::operator++ ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. -.SH "QMapIterator & QMapIterator::operator-- ()" -Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. -.SH "QMapIterator QMapIterator::operator-- ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. -.SH "bool QMapIterator::operator== ( const QMapIterator & it ) const" -Compares the iterator to the \fIit\fR iterator and returns TRUE if -they point to the same item; otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmapiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmapiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmemarray.3qt b/doc/man/man3/qmemarray.3qt deleted file mode 100644 index ef3c0871d..000000000 --- a/doc/man/man3/qmemarray.3qt +++ /dev/null @@ -1,571 +0,0 @@ -'\" t -.TH QMemArray 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 -QMemArray \- Template class that provides arrays of simple types -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                    -.PP -\fC#include \fR -.PP -Inherited by QByteArray and QPointArray. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef type * \fBIterator\fR" -.br -.ti -1c -.BI "typedef const type * \fBConstIterator\fR" -.br -.ti -1c -.BI "\fBQMemArray\fR ()" -.br -.ti -1c -.BI "\fBQMemArray\fR ( int size )" -.br -.ti -1c -.BI "\fBQMemArray\fR ( const QMemArray & a )" -.br -.ti -1c -.BI "\fB~QMemArray\fR ()" -.br -.ti -1c -.BI "QMemArray & \fBoperator=\fR ( const QMemArray & a )" -.br -.ti -1c -.BI "type * \fBdata\fR () const" -.br -.ti -1c -.BI "uint \fBnrefs\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBresize\fR ( uint size )" -.br -.ti -1c -.BI "bool \fBresize\fR ( uint size, Optimization optim )" -.br -.ti -1c -.BI "bool \fBtruncate\fR ( uint pos )" -.br -.ti -1c -.BI "bool \fBfill\fR ( const type & v, int size = -1 )" -.br -.ti -1c -.BI "virtual void \fBdetach\fR ()" -.br -.ti -1c -.BI "QMemArray \fBcopy\fR () const" -.br -.ti -1c -.BI "QMemArray & \fBassign\fR ( const QMemArray & a )" -.br -.ti -1c -.BI "QMemArray & \fBassign\fR ( const type * data, uint size )" -.br -.ti -1c -.BI "QMemArray & \fBduplicate\fR ( const QMemArray & a )" -.br -.ti -1c -.BI "QMemArray & \fBduplicate\fR ( const type * data, uint size )" -.br -.ti -1c -.BI "QMemArray & \fBsetRawData\fR ( const type * data, uint size )" -.br -.ti -1c -.BI "void \fBresetRawData\fR ( const type * data, uint size )" -.br -.ti -1c -.BI "int \fBfind\fR ( const type & v, uint index = 0 ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( const type & v ) const" -.br -.ti -1c -.BI "void \fBsort\fR ()" -.br -.ti -1c -.BI "int \fBbsearch\fR ( const type & v ) const" -.br -.ti -1c -.BI "type & \fBoperator[]\fR ( int index ) const" -.br -.ti -1c -.BI "type & \fBat\fR ( uint index ) const" -.br -.ti -1c -.BI "\fBoperator const type *\fR () const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QMemArray & a ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QMemArray & a ) const" -.br -.ti -1c -.BI "Iterator \fBbegin\fR ()" -.br -.ti -1c -.BI "Iterator \fBend\fR ()" -.br -.ti -1c -.BI "ConstIterator \fBbegin\fR () const" -.br -.ti -1c -.BI "ConstIterator \fBend\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQMemArray\fR ( int, int )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "TQ_UINT16 \fBqChecksum\fR ( const char * data, uint len )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QByteArray & a )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QByteArray & a )" -.br -.in -1c -.SH DESCRIPTION -The QMemArray class is a template class that provides arrays of simple types. -.PP -QMemArray is implemented as a template class. Define a template instance QMemArray to create an array that contains X items. -.PP -QMemArray stores the array elements directly in the array. It can only deal with simple types (i.e. C++ types, structs, and classes that have no constructors, destructors, or virtual functions). QMemArray uses bitwise operations to copy and compare array elements. -.PP -The QPtrVector collection class is also a kind of array. Like most collection classes, it uses pointers to the contained items. -.PP -QMemArray uses explicit sharing with a reference count. If more than one array shares common data and one of the arrays is modified, all the arrays are modified. -.PP -The benefit of sharing is that a program does not need to duplicate data when it is not required, which results in lower memory use and less copying of data. -.PP -An alternative to QMemArray is QValueVector. The QValueVector class also provides an array of objects, but can deal with objects that have constructors (specifically a copy constructor and a default constructor). QValueVector provides an STL-compatible syntax and is implicitly shared. -.PP -Example: -.PP -.nf -.br - #include -.br - #include -.br -.br - QMemArray fib( int num ) // returns fibonacci array -.br - { -.br - Q_ASSERT( num > 2 ); -.br - QMemArray f( num ); // array of ints -.br -.br - f[0] = f[1] = 1; -.br - for ( int i = 2; i < num; i++ ) -.br - f[i] = f[i-1] + f[i-2]; -.br -.br - return f; -.br - } -.br -.br - int main() -.br - { -.br - QMemArray a = fib( 6 ); // get first 6 fibonaccis -.br - for ( int i = 0; i < a.size(); i++ ) -.br - tqDebug( "%d: %d", i, a[i] ); -.br -.br - tqDebug( "1 is found %d times", a.contains(1) ); -.br - tqDebug( "5 is found at index %d", a.find(5) ); -.br -.br - return 0; -.br - } -.br -.fi -.PP -Program output: -.PP -.nf -.br - 0: 1 -.br - 1: 1 -.br - 2: 2 -.br - 3: 3 -.br - 4: 5 -.br - 5: 8 -.br - 1 is found 2 times -.br - 5 is found at index 4 -.br -.fi -.PP -Note concerning the use of QMemArray for manipulating structs or classes: Compilers will often pad the size of structs of odd sizes up to the nearest word boundary. This will then be the size QMemArray will use for its bitwise element comparisons. Because the remaining bytes will typically be uninitialized, this can cause find() etc. to fail to find the element. Example: -.PP -.nf -.br - // MyStruct may be padded to 4 or 8 bytes -.br - struct MyStruct -.br - { -.br - short i; // 2 bytes -.br - char c; // 1 byte -.br - }; -.br -.br - QMemArray a(1); -.br - a[0].i = 5; -.br - a[0].c = 't'; -.br -.br - MyStruct x; -.br - x.i = '5'; -.br - x.c = 't'; -.br - int i = a.find( x ); // may return -1 if the pad bytes differ -.br -.fi -.PP -To work around this, make sure that you use a struct where sizeof() returns the same as the sum of the sizes of the members either by changing the types of the struct members or by adding dummy members. -.PP -QMemArray data can be traversed by iterators (see begin() and end()). The number of items is returned by count(). The array can be resized with resize() and filled using fill(). -.PP -You can make a shallow copy of the array with assign() (or operator=()) and a deep copy with duplicate(). -.PP -Search for values in the array with find() and contains(). For sorted arrays (see sort()) you can search using bsearch(). -.PP -You can set the data directly using setRawData() and resetRawData(), although this requires care. -.PP -See also Shared Classes and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QMemArray::ConstIterator" -A const QMemArray iterator. -.PP -See also begin() and end(). -.SH "QMemArray::Iterator" -A QMemArray iterator. -.PP -See also begin() and end(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMemArray::QMemArray ( int, int )\fC [protected]\fR" -Constructs an array \fIwithout allocating\fR array space. The arguments should be (0, 0). Use at your own risk. -.SH "QMemArray::QMemArray ()" -Constructs a null array. -.PP -See also isNull(). -.SH "QMemArray::QMemArray ( int size )" -Constructs an array with room for \fIsize\fR elements. Makes a null array if \fIsize\fR == 0. -.PP -The elements are left uninitialized. -.PP -See also resize() and isNull(). -.SH "QMemArray::QMemArray ( const QMemArray & a )" -Constructs a shallow copy of \fIa\fR. -.PP -See also assign(). -.SH "QMemArray::~QMemArray ()" -Dereferences the array data and deletes it if this was the last reference. -.SH "QMemArray & QMemArray::assign ( const QMemArray & a )" -Shallow copy. Dereferences the current array and references the data contained in \fIa\fR instead. Returns a reference to this array. -.PP -See also operator=(). -.SH "QMemArray & QMemArray::assign ( const type * data, uint size )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Shallow copy. Dereferences the current array and references the array data \fIdata\fR, which contains \fIsize\fR elements. Returns a reference to this array. -.PP -Do not delete \fIdata\fR later; QMemArray will call free() on it at the right time. -.SH "type & QMemArray::at ( uint index ) const" -Returns a reference to the element at position \fIindex\fR in the array. -.PP -This can be used to both read and set an element. -.PP -See also operator[](). -.SH "Iterator QMemArray::begin ()" -Returns an iterator pointing at the beginning of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. -.SH "ConstIterator QMemArray::begin () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const iterator pointing at the beginning of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. -.SH "int QMemArray::bsearch ( const type & v ) const" -In a sorted array (as sorted by sort()), finds the first occurrence of \fIv\fR by using a binary search. For a sorted array this is generally much faster than find(), which does a linear search. -.PP -Returns the position of \fIv\fR, or -1 if \fIv\fR could not be found. -.PP -See also sort() and find(). -.SH "int QMemArray::contains ( const type & v ) const" -Returns the number of times \fIv\fR occurs in the array. -.PP -See also find(). -.SH "QMemArray QMemArray::copy () const" -Returns a deep copy of this array. -.PP -See also detach() and duplicate(). -.SH "uint QMemArray::count () const" -Returns the same as size(). -.PP -See also size(). -.PP -Example: scribble/scribble.cpp. -.SH "type * QMemArray::data () const" -Returns a pointer to the actual array data. -.PP -The array is a null array if data() == 0 (null pointer). -.PP -See also isNull(). -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and network/networkprotocol/nntp.cpp. -.SH "void QMemArray::detach ()\fC [virtual]\fR" -Detaches this array from shared array data; i.e. it makes a private, deep copy of the data. -.PP -Copying will be performed only if the reference count is greater than one. -.PP -See also copy(). -.PP -Reimplemented in QBitArray. -.SH "QMemArray & QMemArray::duplicate ( const QMemArray & a )" -Deep copy. Dereferences the current array and obtains a copy of the data contained in \fIa\fR instead. Returns a reference to this array. -.PP -See also copy(). -.SH "QMemArray & QMemArray::duplicate ( const type * data, uint size )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Deep copy. Dereferences the current array and obtains a copy of the array data \fIdata\fR instead. Returns a reference to this array. The size of the array is given by \fIsize\fR. -.PP -See also copy(). -.SH "Iterator QMemArray::end ()" -Returns an iterator pointing behind the last element of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. -.SH "ConstIterator QMemArray::end () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const iterator pointing behind the last element of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. -.SH "bool QMemArray::fill ( const type & v, int size = -1 )" -Fills the array with the value \fIv\fR. If \fIsize\fR is specified as different from -1, then the array will be resized before being filled. -.PP -Returns TRUE if successful, i.e. if \fIsize\fR is -1, or \fIsize\fR is != -1 and the memory can be allocated; otherwise returns FALSE. -.PP -See also resize(). -.SH "int QMemArray::find ( const type & v, uint index = 0 ) const" -Finds the first occurrence of \fIv\fR, starting at position \fIindex\fR. -.PP -Returns the position of \fIv\fR, or -1 if \fIv\fR could not be found. -.PP -See also contains(). -.SH "bool QMemArray::isEmpty () const" -Returns TRUE if the array is empty; otherwise returns FALSE. -.PP -isEmpty() is equivalent to isNull() for QMemArray (unlike QString). -.SH "bool QMemArray::isNull () const" -Returns TRUE if the array is null; otherwise returns FALSE. -.PP -A null array has size() == 0 and data() == 0. -.SH "uint QMemArray::nrefs () const" -Returns the reference count for the shared array data. This reference count is always greater than zero. -.SH "QMemArray::operator const type * () const" -Cast operator. Returns a pointer to the array. -.PP -See also data(). -.SH "bool QMemArray::operator!= ( const QMemArray & a ) const" -Returns TRUE if this array is different from \fIa\fR; otherwise returns FALSE. -.PP -The two arrays are compared bitwise. -.PP -See also operator==(). -.SH "QMemArray & QMemArray::operator= ( const QMemArray & a )" -Assigns a shallow copy of \fIa\fR to this array and returns a reference to this array. -.PP -Equivalent to assign( a ). -.SH "bool QMemArray::operator== ( const QMemArray & a ) const" -Returns TRUE if this array is equal to \fIa\fR; otherwise returns FALSE. -.PP -The two arrays are compared bitwise. -.PP -See also operator!=(). -.SH "type & QMemArray::operator[] ( int index ) const" -Returns a reference to the element at position \fIindex\fR in the array. -.PP -This can be used to both read and set an element. Equivalent to at(). -.PP -See also at(). -.SH "void QMemArray::resetRawData ( const type * data, uint size )" -Removes internal references to the raw data that was set using setRawData(). This means that QMemArray no longer has access to the \fIdata\fR, so you are free to manipulate \fIdata\fR as you wish. You can now use the QMemArray without affecting the original \fIdata\fR, for example by calling setRawData() with a pointer to some other data. -.PP -The arguments must be the \fIdata\fR and length, \fIsize\fR, that were passed to setRawData(). This is for consistency checking. -.PP -See also setRawData(). -.SH "bool QMemArray::resize ( uint size, Optimization optim )" -Resizes (expands or shrinks) the array to \fIsize\fR elements. The array becomes a null array if \fIsize\fR == 0. -.PP -Returns TRUE if successful, or FALSE if the memory cannot be allocated. -.PP -New elements are not initialized. -.PP -\fIoptim\fR is either \fCQGArray::MemOptim\fR (the default) or \fCQGArray::SpeedOptim\fR. -.PP -\fBNote:\fR By default, \fCSpeedOptim\fR is not available for general use since it is only available if Qt is built in a particular configuration. -.PP -See also size(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QMemArray::resize ( uint size )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Resizes (expands or shrinks) the array to \fIsize\fR elements. The array becomes a null array if \fIsize\fR == 0. -.PP -Returns TRUE if successful, i.e. if the memory can be allocated; otherwise returns FALSE. -.PP -New elements are not initialized. -.PP -See also size(). -.SH "QMemArray & QMemArray::setRawData ( const type * data, uint size )" -Sets raw data and returns a reference to the array. -.PP -Dereferences the current array and sets the new array data to \fIdata\fR and the new array size to \fIsize\fR. Do not attempt to resize or re-assign the array data when raw data has been set. Call resetRawData(\fIdata\fR, \fIsize\fR) to reset the array. -.PP -Setting raw data is useful because it sets QMemArray data without allocating memory or copying data. -.PP -Example I (intended use): -.PP -.nf -.br - static char bindata[] = { 231, 1, 44, ... }; -.br - QByteArray a; -.br - a.setRawData( bindata, sizeof(bindata) ); // a points to bindata -.br - QDataStream s( a, IO_ReadOnly ); // open on a's data -.br - s >> ; // read raw bindata -.br - a.resetRawData( bindata, sizeof(bindata) ); // finished -.br -.fi -.PP -Example II (you don't want to do this): -.PP -.nf -.br - static char bindata[] = { 231, 1, 44, ... }; -.br - QByteArray a, b; -.br - a.setRawData( bindata, sizeof(bindata) ); // a points to bindata -.br - a.resize( 8 ); // will crash -.br - b = a; // will crash -.br - a[2] = 123; // might crash -.br - // forget to resetRawData: will crash -.br -.fi -.PP -\fBWarning:\fR If you do not call resetRawData(), QMemArray will attempt to deallocate or reallocate the raw data, which might not be too good. Be careful. -.PP -See also resetRawData(). -.SH "uint QMemArray::size () const" -Returns the size of the array (maximum number of elements). -.PP -The array is a null array if size() == 0. -.PP -See also isNull() and resize(). -.SH "void QMemArray::sort ()" -Sorts the array elements in ascending order, using bitwise comparison (memcmp()). -.PP -See also bsearch(). -.SH "bool QMemArray::truncate ( uint pos )" -Truncates the array at position \fIpos\fR. -.PP -Returns TRUE if successful, i.e. if the memory can be allocated; otherwise returns FALSE. -.PP -Equivalent to resize(\fIpos\fR). -.PP -See also resize(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QByteArray & a )" -Writes byte array \fIa\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QByteArray & a )" -Reads a byte array into \fIa\fR from the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "TQ_UINT16 tqChecksum ( const char * data, uint len )" -Returns the CRC-16 checksum of \fIlen\fR bytes starting at \fIdata\fR. -.PP -The checksum is independent of the byte order (endianness). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmemarray.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmemarray.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmenubar.3qt b/doc/man/man3/qmenubar.3qt deleted file mode 100644 index 9a4a2ec4c..000000000 --- a/doc/man/man3/qmenubar.3qt +++ /dev/null @@ -1,588 +0,0 @@ -'\" t -.TH QMenuBar 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 -QMenuBar \- Horizontal menu bar -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame and QMenuData. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMenuBar\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QMenuBar\fR ()" -.br -.ti -1c -.BI "virtual void \fBshow\fR ()" -.br -.ti -1c -.BI "virtual void \fBhide\fR ()" -.br -.ti -1c -.BI "virtual int \fBheightForWidth\fR ( int max_width ) const" -.br -.ti -1c -.BI "enum \fBSeparator\fR { Never = 0, InWindowsStyle = 1 }" -.br -.ti -1c -.BI "Separator separator () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void setSeparator ( Separator when ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetDefaultUp\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisDefaultUp\fR () const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBactivated\fR ( int id )" -.br -.ti -1c -.BI "void \fBhighlighted\fR ( int id )" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( QWidget * widget, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( QCustomMenuItem * custom, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertSeparator\fR ( int index = -1 )" -.br -.ti -1c -.BI "void \fBremoveItem\fR ( int id )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "bool \fBisItemEnabled\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" -.br -.ti -1c -.BI "bool \fBisItemVisible\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemVisible\fR ( int id, bool visible )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBdefaultUp\fR - the popup orientation" -.br -.ti -1c -.BI "Separator separator - in which cases a menubar sparator is drawn \fI(obsolete)\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * p )" -.br -.ti -1c -.BI "virtual void \fBmenuContentsChanged\fR ()" -.br -.ti -1c -.BI "virtual void \fBmenuStateChanged\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QMenuBar class provides a horizontal menu bar. -.PP -A menu bar consists of a list of pull-down menu items. You add menu items with insertItem(). For example, asuming that \fCmenubar\fR is a pointer to a QMenuBar and \fCfilemenu\fR is a pointer to a QPopupMenu, the following statement inserts the menu into the menu bar: -.PP -.nf -.br - menubar->insertItem( "&File", filemenu ); -.br -.fi -The ampersand in the menu item's text sets Alt+F as a shortcut for this menu. (You can use "&&" to get a real ampersand in the menu bar.) -.PP -Items are either enabled or disabled. You toggle their state with setItemEnabled(). -.PP -There is no need to lay out a menu bar. It automatically sets its own geometry to the top of the parent widget and changes it appropriately whenever the parent is resized. -.PP -Example of creating a menu bar with menu items (from menu/menu.cpp): -.PP -.nf -.br - QPopupMenu *file = new QPopupMenu( this ); -.fi -.PP -.nf -.br - file->insertItem( p1, "&Open", this, SLOT(open()), CTRL+Key_O ); -.br - file->insertItem( p2, "&New", this, SLOT(news()), CTRL+Key_N ); -.fi -.PP -.nf -.br - menu = new QMenuBar( this ); -.fi -.PP -.nf -.br - menu->insertItem( "&File", file ); -.fi -.PP -In most main window style applications you would use the menuBar() provided in QMainWindow, adding QPopupMenus to the menu bar and adding QActions to the popup menus. -.PP -Example (from action/application.cpp): -.PP -.nf -.br - QPopupMenu * file = new QPopupMenu( this ); -.br - menuBar()->insertItem( "&File", file ); -.br - fileNewAction->addTo( file ); -.fi -.PP -Menu items can have text and pixmaps (or iconsets), see the various insertItem() overloads, as well as separators, see insertSeparator(). You can also add custom menu items that are derived from QCustomMenuItem. -.PP -Menu items may be removed with removeItem() and enabled or disabled with setItemEnabled(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -.SH "QMenuBar on Qt/Mac" -QMenuBar on Qt/Mac is a wrapper for using the system-wide menubar. If you have multiple menubars in one dialog the outermost menubar (normally inside a widget with widget flag WType_TopLevel) will be used for the system-wide menubar. -.PP -Note that arbitrary Qt widgets \fIcannot\fR be inserted into a QMenuBar on the Mac because Qt uses Mac's native menus which don't support this functionality. This limitation does not apply to stand-alone QPopupMenus. -.PP -Qt/Mac also provides a menubar merging feature to make QMenuBar conform more closely to accepted Mac OS X menubar layout. The merging functionality is based on string matching the title of a QPopupMenu entry. These strings are translated (using QObject::tr()) in the "QMenuBar" context. If an entry is moved its slots will still fire as if it was in the original place. The table below outlines the strings looked for and where the entry is placed if matched: -.PP -
                                    .nf -.TS -l - l. String matches Placement Notes about.* Application Menu | About If this entry is not found no About item will appear in the Application Menu config, options, setup, settings or preferences Application Menu | Preferences If this entry is not found the Settings item will be disabled quit or exit Application Menu | Quit If this entry is not found a default Quit item will be created to call -.TE -.fi -
                                    -.PP -menu/menu.cpp is an example of QMenuBar and QPopupMenu use. -.PP -See also QPopupMenu, QAccel, QAction, Aqua Style Guidelines, GUI Design Handbook: Menu Bar, and Main Window and Related Classes. -.SS "Member Type Documentation" -.SH "QMenuBar::Separator" -This enum type is used to decide whether QMenuBar should draw a separator line at its bottom. -.TP -\fCQMenuBar::Never\fR - In many applications there is already a separator, and having two looks wrong. -.TP -\fCQMenuBar::InWindowsStyle\fR - In some other applications a separator looks good in Windows style, but nowhere else. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMenuBar::QMenuBar ( QWidget * parent = 0, const char * name = 0 )" -Constructs a menu bar called \fIname\fR with parent \fIparent\fR. -.SH "QMenuBar::~QMenuBar ()" -Destroys the menu bar. -.SH "void QMenuBar::activated ( int id )\fC [signal]\fR" -This signal is emitted when a menu item is selected; \fIid\fR is the id of the selected item. -.PP -Normally you will connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is useful in such cases. -.PP -See also highlighted() and QMenuData::insertItem(). -.PP -Example: progress/progress.cpp. -.SH "void QMenuData::clear ()" -Removes all menu items. -.PP -See also removeItem() and removeItemAt(). -.PP -Examples: -.)l mdi/application.cpp and qwerty/qwerty.cpp. -.SH "void QMenuBar::drawContents ( QPainter * p )\fC [virtual protected]\fR" -Called from QFrame::paintEvent(). Draws the menu bar contents using painter \fIp\fR. -.PP -Reimplemented from QFrame. -.SH "int QMenuBar::heightForWidth ( int max_width ) const\fC [virtual]\fR" -Returns the height that the menu would resize itself to if its parent (and hence itself) resized to the given \fImax_width\fR. This can be useful for simple layout tasks in which the height of the menu bar is needed after items have been inserted. See showimg/showimg.cpp for an example of the usage. -.PP -Example: showimg/showimg.cpp. -.PP -Reimplemented from QWidget. -.SH "void QMenuBar::hide ()\fC [virtual]\fR" -Reimplements QWidget::hide() in order to deselect any selected item, and calls setUpLayout() for the main window. -.PP -Example: grapher/grapher.cpp. -.PP -Reimplemented from QWidget. -.SH "void QMenuBar::highlighted ( int id )\fC [signal]\fR" -This signal is emitted when a menu item is highlighted; \fIid\fR is the id of the highlighted item. -.PP -Normally, you will connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is useful in such cases. -.PP -See also activated() and QMenuData::insertItem(). -.SH "int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -The family of insertItem() functions inserts menu items into a popup menu or a menu bar. -.PP -A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus. -.PP -Some insertItem() members take a popup menu as an additional argument. Use this to insert submenus into existing menus or pulldown menus into a menu bar. -.PP -The number of insert functions may look confusing, but they are actually quite simple to use. -.PP -This default version inserts a menu item with the text \fItext\fR, the accelerator key \fIaccel\fR, an id and an optional index and connects it to the slot \fImember\fR in the object \fIreceiver\fR. -.PP -Example: -.PP -.nf -.br - QMenuBar *mainMenu = new QMenuBar; -.br - QPopupMenu *fileMenu = new QPopupMenu; -.br - fileMenu->insertItem( "New", myView, SLOT(newFile()), CTRL+Key_N ); -.br - fileMenu->insertItem( "Open", myView, SLOT(open()), CTRL+Key_O ); -.br - mainMenu->insertItem( "File", fileMenu ); -.br -.fi -.PP -Not all insert functions take an object/slot parameter or an accelerator key. Use connectItem() and setAccel() on those items. -.PP -If you need to translate accelerators, use tr() with the text and accelerator. (For translations use a string key sequence.): -.PP -.nf -.br - fileMenu->insertItem( tr("Open"), myView, SLOT(open()), -.br - tr("Ctrl+O") ); -.br -.fi -.PP -In the example above, pressing Ctrl+O or selecting "Open" from the menu activates the myView->open() function. -.PP -Some insert functions take a QIconSet parameter to specify the little menu item icon. Note that you can always pass a QPixmap object instead. -.PP -The \fIid\fR specifies the identification number associated with the menu item. Note that only positive values are valid, as a negative value will make Qt select a unique id for the item. -.PP -The \fIindex\fR specifies the position in the menu. The menu item is appended at the end of the list if \fIindex\fR is negative. -.PP -Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. -.PP -\fBWarning:\fR Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g. \fC(QObject*)0\fR. -.PP -\fBWarning:\fR On Mac OS X, items that connect to a slot that are inserted into a menubar will not function as we use the native menubar that knows nothing about signals or slots. Instead insert the items into a popup menu and insert the popup menu into the menubar. This may be fixed in a future Qt version. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.PP -Examples: -.)l addressbook/mainwindow.cpp, canvas/canvas.cpp, menu/menu.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the \fImember\fR slot in the \fIreceiver\fR object. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item that consists of the widget \fIwidget\fR with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -Ownership of \fIwidget\fR is transferred to the popup menu or to the menu bar. -.PP -Theoretically, any widget can be inserted into a popup menu. In practice, this only makes sense with certain widgets. -.PP -If a widget is not focus-enabled (see QWidget::isFocusEnabled()), the menu treats it as a separator; this means that the item is not selectable and will never get focus. In this way you can, for example, simply insert a QLabel if you need a popup menu with a title. -.PP -If the widget is focus-enabled it will get focus when the user traverses the popup menu with the arrow keys. If the widget does not accept \fCArrowUp\fR and \fCArrowDown\fR in its key event handler, the focus will move back to the menu when the respective arrow key is hit one more time. This works with a QLineEdit, for example. If the widget accepts the arrow key itself, it must also provide the possibility to put the focus back on the menu again by calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu when the user made a selection, this can be done safely by calling: -.PP -.nf -.br - if ( isVisible() && -.br - parentWidget() && -.br - parentWidget()->inherits("QPopupMenu") ) -.br - parentWidget()->close(); -.br -.fi -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a custom menu item \fIcustom\fR with an \fIicon\fR and with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. -.PP -If you want to connect a custom item to a slot, use connectItem(). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a custom menu item \fIcustom\fR with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. -.PP -If you want to connect a custom item to a slot, use connectItem(). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertSeparator ( int index = -1 )" -Inserts a separator at position \fIindex\fR, and returns the menu identifier number allocated to it. The separator becomes the last menu item if \fIindex\fR is negative. -.PP -In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guidelines). -.PP -Examples: -.)l addressbook/mainwindow.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "bool QMenuBar::isDefaultUp () const" -Returns the popup orientation. See the "defaultUp" property for details. -.SH "bool QMenuData::isItemEnabled ( int id ) const" -Returns TRUE if the item with identifier \fIid\fR is enabled; otherwise returns FALSE -.PP -See also setItemEnabled() and isItemVisible(). -.SH "bool QMenuData::isItemVisible ( int id ) const" -Returns TRUE if the menu item with the id \fIid\fR is visible; otherwise returns FALSE. -.PP -See also setItemVisible(). -.SH "void QMenuBar::menuContentsChanged ()\fC [virtual protected]\fR" -Recomputes the menu bar's display data according to the new contents. -.PP -You should never need to call this; it is called automatically by QMenuData whenever it needs to be called. -.PP -Reimplemented from QMenuData. -.SH "void QMenuBar::menuStateChanged ()\fC [virtual protected]\fR" -Recomputes the menu bar's display data according to the new state. -.PP -You should never need to call this; it is called automatically by QMenuData whenever it needs to be called. -.PP -Reimplemented from QMenuData. -.SH "void QMenuData::removeItem ( int id )" -Removes the menu item that has the identifier \fIid\fR. -.PP -See also removeItemAt() and clear(). -.PP -Example: chart/chartform.cpp. -.SH "Separator QMenuBar::separator () const" -Returns in which cases a menubar sparator is drawn. See the "separator" property for details. -.SH "void QMenuBar::setDefaultUp ( bool )" -Sets the popup orientation. See the "defaultUp" property for details. -.SH "void QMenuData::setItemEnabled ( int id, bool enable )" -If \fIenable\fR is TRUE, enables the menu item with identifier \fIid\fR; otherwise disables the menu item with identifier \fIid\fR. -.PP -See also isItemEnabled(). -.PP -Examples: -.)l mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, and showimg/showimg.cpp. -.SH "void QMenuData::setItemVisible ( int id, bool visible )" -If \fIvisible\fR is TRUE, shows the menu item with id \fIid\fR; otherwise hides the menu item with id \fIid\fR. -.PP -See also isItemVisible() and isItemEnabled(). -.SH "void QMenuBar::setSeparator ( Separator when )\fC [virtual]\fR" -Sets in which cases a menubar sparator is drawn to \fIwhen\fR. See the "separator" property for details. -.SH "void QMenuBar::show ()\fC [virtual]\fR" -Reimplements QWidget::show() in order to set up the correct keyboard accelerators and to raise itself to the top of the widget stack. -.PP -Example: grapher/grapher.cpp. -.PP -Reimplemented from QWidget. -.SS "Property Documentation" -.SH "bool defaultUp" -This property holds the popup orientation. -.PP -The default popup orientation. By default, menus pop "down" the screen. By setting the property to TRUE, the menu will pop "up". You might call this for menus that are \fIbelow\fR the document to which they refer. -.PP -If the menu would not fit on the screen, the other direction is used automatically. -.PP -Set this property's value with setDefaultUp() and get this property's value with isDefaultUp(). -.SH "Separator separator" -This property holds in which cases a menubar sparator is drawn. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Set this property's value with setSeparator() and get this property's value with separator(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmenubar.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmenubar.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmenudata.3qt b/doc/man/man3/qmenudata.3qt deleted file mode 100644 index a72649012..000000000 --- a/doc/man/man3/qmenudata.3qt +++ /dev/null @@ -1,707 +0,0 @@ -'\" t -.TH QMenuData 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 -QMenuData \- Base class for QMenuBar and QPopupMenu -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QMenuBar and QPopupMenu. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMenuData\fR ()" -.br -.ti -1c -.BI "virtual \fB~QMenuData\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( QWidget * widget, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( QCustomMenuItem * custom, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertSeparator\fR ( int index = -1 )" -.br -.ti -1c -.BI "void \fBremoveItem\fR ( int id )" -.br -.ti -1c -.BI "void \fBremoveItemAt\fR ( int index )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "QKeySequence \fBaccel\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetAccel\fR ( const QKeySequence & key, int id )" -.br -.ti -1c -.BI "QIconSet * \fBiconSet\fR ( int id ) const" -.br -.ti -1c -.BI "QString \fBtext\fR ( int id ) const" -.br -.ti -1c -.BI "QPixmap * \fBpixmap\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetWhatsThis\fR ( int id, const QString & text )" -.br -.ti -1c -.BI "QString \fBwhatsThis\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QString & text )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QPixmap & pixmap )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QString & text )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QPixmap & pixmap )" -.br -.ti -1c -.BI "void changeItem ( const QString & text, int id ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void changeItem ( const QPixmap & pixmap, int id ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void changeItem ( const QIconSet & icon, const QString & text, int id ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBisItemActive\fR ( int id ) const" -.br -.ti -1c -.BI "bool \fBisItemEnabled\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" -.br -.ti -1c -.BI "bool \fBisItemChecked\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemChecked\fR ( int id, bool check )" -.br -.ti -1c -.BI "bool \fBisItemVisible\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemVisible\fR ( int id, bool visible )" -.br -.ti -1c -.BI "virtual void \fBupdateItem\fR ( int id )" -.br -.ti -1c -.BI "int \fBindexOf\fR ( int id ) const" -.br -.ti -1c -.BI "int \fBidAt\fR ( int index ) const" -.br -.ti -1c -.BI "virtual void \fBsetId\fR ( int index, int id )" -.br -.ti -1c -.BI "bool \fBconnectItem\fR ( int id, const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "bool \fBdisconnectItem\fR ( int id, const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "bool \fBsetItemParameter\fR ( int id, int param )" -.br -.ti -1c -.BI "int \fBitemParameter\fR ( int id ) const" -.br -.ti -1c -.BI "QMenuItem * \fBfindItem\fR ( int id ) const" -.br -.ti -1c -.BI "QMenuItem * \fBfindItem\fR ( int id, QMenuData ** parent ) const" -.br -.ti -1c -.BI "virtual void \fBactivateItemAt\fR ( int index )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBmenuContentsChanged\fR ()" -.br -.ti -1c -.BI "virtual void \fBmenuStateChanged\fR ()" -.br -.ti -1c -.BI "virtual void \fBmenuInsPopup\fR ( QPopupMenu * )" -.br -.ti -1c -.BI "virtual void \fBmenuDelPopup\fR ( QPopupMenu * )" -.br -.in -1c -.SH DESCRIPTION -The QMenuData class is a base class for QMenuBar and QPopupMenu. -.PP -QMenuData has an internal list of menu items. A menu item can have a text(), an accelerator, a pixmap(), an iconSet(), a whatsThis() text and a popup menu (unless it is a separator). Menu items may optionally be checked (except for separators). -.PP -The menu item sends out an activated() signal when it is chosen and a highlighted() signal when it receives the user input focus. -.PP - -.PP -Menu items are assigned the menu identifier \fIid\fR that is passed in insertItem() or an automatically generated identifier if \fIid\fR is < 0 (the default). The generated identifiers (negative integers) are guaranteed to be unique within the entire application. The identifier is used to access the menu item in other functions. -.PP -Menu items can be removed with removeItem() and removeItemAt(), or changed with changeItem(). All menu items can be removed with clear(). Accelerators can be changed or set with setAccel(). Checkable items can be checked or unchecked with setItemChecked(). Items can be enabled or disabled using setItemEnabled() and connected and disconnected with connectItem() and disconnectItem() respectively. By default, newly created menu items are visible. They can be hidden (and shown again) with setItemVisible(). -.PP -Menu items are stored in a list. Use findItem() to find an item by its list position or by its menu identifier. (See also indexOf() and idAt().) -.PP -See also QAccel, QPopupMenu, QAction, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMenuData::QMenuData ()" -Constructs an empty menu data list. -.SH "QMenuData::~QMenuData ()\fC [virtual]\fR" -Removes all menu items and disconnects any signals that have been connected. -.SH "QKeySequence QMenuData::accel ( int id ) const" -Returns the accelerator key that has been defined for the menu item \fIid\fR, or 0 if it has no accelerator key or if there is no such menu item. -.PP -See also setAccel(), QAccel, and ntqnamespace.h. -.SH "void QMenuData::activateItemAt ( int index )\fC [virtual]\fR" -Activates the menu item at position \fIindex\fR. -.PP -If the index is invalid (for example, -1), the object itself is deactivated. -.SH "void QMenuData::changeItem ( int id, const QString & text )" -Changes the text of the menu item \fIid\fR to \fItext\fR. If the item has an icon, the icon remains unchanged. -.PP -See also text(). -.SH "void QMenuData::changeItem ( int id, const QPixmap & pixmap )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Changes the pixmap of the menu item \fIid\fR to the pixmap \fIpixmap\fR. If the item has an icon, the icon is unchanged. -.PP -See also pixmap(). -.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QString & text )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Changes the iconset and text of the menu item \fIid\fR to the \fIicon\fR and \fItext\fR respectively. -.PP -See also pixmap(). -.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QPixmap & pixmap )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Changes the iconset and pixmap of the menu item \fIid\fR to \fIicon\fR and \fIpixmap\fR respectively. -.PP -See also pixmap(). -.SH "void QMenuData::changeItem ( const QString & text, int id )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Changes the text of the menu item \fIid\fR. If the item has an icon, the icon remains unchanged. -.PP -See also text(). -.SH "void QMenuData::changeItem ( const QPixmap & pixmap, int id )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Changes the pixmap of the menu item \fIid\fR. If the item has an icon, the icon remains unchanged. -.PP -See also pixmap(). -.SH "void QMenuData::changeItem ( const QIconSet & icon, const QString & text, int id )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Changes the icon and text of the menu item \fIid\fR. -.PP -See also pixmap(). -.SH "void QMenuData::clear ()" -Removes all menu items. -.PP -See also removeItem() and removeItemAt(). -.PP -Examples: -.)l mdi/application.cpp and qwerty/qwerty.cpp. -.SH "bool QMenuData::connectItem ( int id, const QObject * receiver, const char * member )" -Connects the menu item with identifier \fIid\fR to \fIreceiver\fR's \fImember\fR slot or signal. -.PP -The receiver's slot (or signal) is activated when the menu item is activated. -.PP -See also disconnectItem() and setItemParameter(). -.PP -Example: menu/menu.cpp. -.SH "uint QMenuData::count () const" -Returns the number of items in the menu. -.SH "bool QMenuData::disconnectItem ( int id, const QObject * receiver, const char * member )" -Disconnects the \fIreceiver\fR's \fImember\fR from the menu item with identifier \fIid\fR. -.PP -All connections are removed when the menu data object is destroyed. -.PP -See also connectItem() and setItemParameter(). -.SH "QMenuItem * QMenuData::findItem ( int id ) const" -Returns the menu item with identifier \fIid\fR, or 0 if there is no item with this identifier. -.PP -Note that QMenuItem is an internal class, and that you should not need to call this function. Use the higher level functions like text(), pixmap() and changeItem() to get and modify menu item attributes instead. -.PP -See also indexOf(). -.PP -Example: chart/chartform.cpp. -.SH "QMenuItem * QMenuData::findItem ( int id, QMenuData ** parent ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the menu item with identifier \fIid\fR, or 0 if there is no item with this identifier. Changes \fI*parent\fR to point to the parent of the return value. -.PP -Note that QMenuItem is an internal class, and that you should not need to call this function. Use the higher level functions like text(), pixmap() and changeItem() to get and modify menu item attributes instead. -.PP -See also indexOf(). -.SH "QIconSet * QMenuData::iconSet ( int id ) const" -Returns the icon set that has been set for menu item \fIid\fR, or 0 if no icon set has been set. -.PP -See also changeItem(), text(), and pixmap(). -.SH "int QMenuData::idAt ( int index ) const" -Returns the identifier of the menu item at position \fIindex\fR in the internal list, or -1 if \fIindex\fR is out of range. -.PP -See also setId() and indexOf(). -.SH "int QMenuData::indexOf ( int id ) const" -Returns the index of the menu item with identifier \fIid\fR, or -1 if there is no item with this identifier. -.PP -See also idAt() and findItem(). -.PP -Example: scrollview/scrollview.cpp. -.SH "int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -The family of insertItem() functions inserts menu items into a popup menu or a menu bar. -.PP -A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus. -.PP -Some insertItem() members take a popup menu as an additional argument. Use this to insert submenus into existing menus or pulldown menus into a menu bar. -.PP -The number of insert functions may look confusing, but they are actually quite simple to use. -.PP -This default version inserts a menu item with the text \fItext\fR, the accelerator key \fIaccel\fR, an id and an optional index and connects it to the slot \fImember\fR in the object \fIreceiver\fR. -.PP -Example: -.PP -.nf -.br - QMenuBar *mainMenu = new QMenuBar; -.br - QPopupMenu *fileMenu = new QPopupMenu; -.br - fileMenu->insertItem( "New", myView, SLOT(newFile()), CTRL+Key_N ); -.br - fileMenu->insertItem( "Open", myView, SLOT(open()), CTRL+Key_O ); -.br - mainMenu->insertItem( "File", fileMenu ); -.br -.fi -.PP -Not all insert functions take an object/slot parameter or an accelerator key. Use connectItem() and setAccel() on those items. -.PP -If you need to translate accelerators, use tr() with the text and accelerator. (For translations use a string key sequence.): -.PP -.nf -.br - fileMenu->insertItem( tr("Open"), myView, SLOT(open()), -.br - tr("Ctrl+O") ); -.br -.fi -.PP -In the example above, pressing Ctrl+O or selecting "Open" from the menu activates the myView->open() function. -.PP -Some insert functions take a QIconSet parameter to specify the little menu item icon. Note that you can always pass a QPixmap object instead. -.PP -The \fIid\fR specifies the identification number associated with the menu item. Note that only positive values are valid, as a negative value will make Qt select a unique id for the item. -.PP -The \fIindex\fR specifies the position in the menu. The menu item is appended at the end of the list if \fIindex\fR is negative. -.PP -Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. -.PP -\fBWarning:\fR Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g. \fC(QObject*)0\fR. -.PP -\fBWarning:\fR On Mac OS X, items that connect to a slot that are inserted into a menubar will not function as we use the native menubar that knows nothing about signals or slots. Instead insert the items into a popup menu and insert the popup menu into the menubar. This may be fixed in a future Qt version. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.PP -Examples: -.)l addressbook/mainwindow.cpp, canvas/canvas.cpp, menu/menu.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the \fImember\fR slot in the \fIreceiver\fR object. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item that consists of the widget \fIwidget\fR with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -Ownership of \fIwidget\fR is transferred to the popup menu or to the menu bar. -.PP -Theoretically, any widget can be inserted into a popup menu. In practice, this only makes sense with certain widgets. -.PP -If a widget is not focus-enabled (see QWidget::isFocusEnabled()), the menu treats it as a separator; this means that the item is not selectable and will never get focus. In this way you can, for example, simply insert a QLabel if you need a popup menu with a title. -.PP -If the widget is focus-enabled it will get focus when the user traverses the popup menu with the arrow keys. If the widget does not accept \fCArrowUp\fR and \fCArrowDown\fR in its key event handler, the focus will move back to the menu when the respective arrow key is hit one more time. This works with a QLineEdit, for example. If the widget accepts the arrow key itself, it must also provide the possibility to put the focus back on the menu again by calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu when the user made a selection, this can be done safely by calling: -.PP -.nf -.br - if ( isVisible() && -.br - parentWidget() && -.br - parentWidget()->inherits("QPopupMenu") ) -.br - parentWidget()->close(); -.br -.fi -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a custom menu item \fIcustom\fR with an \fIicon\fR and with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. -.PP -If you want to connect a custom item to a slot, use connectItem(). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a custom menu item \fIcustom\fR with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. -.PP -If you want to connect a custom item to a slot, use connectItem(). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertSeparator ( int index = -1 )" -Inserts a separator at position \fIindex\fR, and returns the menu identifier number allocated to it. The separator becomes the last menu item if \fIindex\fR is negative. -.PP -In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guidelines). -.PP -Examples: -.)l addressbook/mainwindow.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "bool QMenuData::isItemActive ( int id ) const" -Returns TRUE if the menu item with the id \fIid\fR is currently active; otherwise returns FALSE. -.SH "bool QMenuData::isItemChecked ( int id ) const" -Returns TRUE if the menu item with the id \fIid\fR has been checked; otherwise returns FALSE. -.PP -See also setItemChecked(). -.PP -Examples: -.)l canvas/canvas.cpp, progress/progress.cpp, and showimg/showimg.cpp. -.SH "bool QMenuData::isItemEnabled ( int id ) const" -Returns TRUE if the item with identifier \fIid\fR is enabled; otherwise returns FALSE -.PP -See also setItemEnabled() and isItemVisible(). -.SH "bool QMenuData::isItemVisible ( int id ) const" -Returns TRUE if the menu item with the id \fIid\fR is visible; otherwise returns FALSE. -.PP -See also setItemVisible(). -.SH "int QMenuData::itemParameter ( int id ) const" -Returns the parameter of the activation signal of item \fIid\fR. -.PP -If no parameter has been specified for this item with setItemParameter(), the value defaults to \fIid\fR. -.PP -See also connectItem(), disconnectItem(), and setItemParameter(). -.SH "void QMenuData::menuContentsChanged ()\fC [virtual protected]\fR" -Virtual function; notifies subclasses that one or more items have been inserted or removed. -.PP -Reimplemented in QMenuBar. -.SH "void QMenuData::menuDelPopup ( QPopupMenu * )\fC [virtual protected]\fR" -Virtual function; notifies subclasses that a popup menu item has been removed. -.SH "void QMenuData::menuInsPopup ( QPopupMenu * )\fC [virtual protected]\fR" -Virtual function; notifies subclasses that a popup menu item has been inserted. -.SH "void QMenuData::menuStateChanged ()\fC [virtual protected]\fR" -Virtual function; notifies subclasses that one or more items have changed state (enabled/disabled or checked/unchecked). -.PP -Reimplemented in QMenuBar. -.SH "QPixmap * QMenuData::pixmap ( int id ) const" -Returns the pixmap that has been set for menu item \fIid\fR, or 0 if no pixmap has been set. -.PP -See also changeItem(), text(), and iconSet(). -.SH "void QMenuData::removeItem ( int id )" -Removes the menu item that has the identifier \fIid\fR. -.PP -See also removeItemAt() and clear(). -.PP -Example: chart/chartform.cpp. -.SH "void QMenuData::removeItemAt ( int index )" -Removes the menu item at position \fIindex\fR. -.PP -See also removeItem() and clear(). -.SH "void QMenuData::setAccel ( const QKeySequence & key, int id )" -Sets the accelerator key for the menu item \fIid\fR to \fIkey\fR. -.PP -An accelerator key consists of a key code and a combination of the modifiers \fCSHIFT\fR, \fCCTRL\fR, \fCALT\fR or \fCUNICODE_ACCEL\fR (OR'ed or added). The header file ntqnamespace.h contains a list of key codes. -.PP -Defining an accelerator key produces a text that is added to the menu item; for instance, \fCCTRL\fR + \fCKey_O\fR produces "Ctrl+O". The text is formatted differently for different platforms. -.PP -Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. -.PP -Example: -.PP -.nf -.br - QMenuBar *mainMenu = new QMenuBar; -.br - QPopupMenu *fileMenu = new QPopupMenu; // file sub menu -.br - fileMenu->insertItem( "Open Document", 67 ); // add "Open" item -.br - fileMenu->setAccel( CTRL + Key_O, 67 ); // Ctrl+O to open -.br - fileMenu->insertItem( "Quit", 69 ); // add "Quit" item -.br - fileMenu->setAccel( CTRL + ALT + Key_Delete, 69 ); // add Alt+Del to quit -.br - mainMenu->insertItem( "File", fileMenu ); // add the file menu -.br -.fi -.PP -If you need to translate accelerators, use tr() with a string: -.PP -.nf -.br - fileMenu->setAccel( tr("Ctrl+O"), 67 ); -.br -.fi -.PP -You can also specify the accelerator in the insertItem() function. You may prefer to use QAction to associate accelerators with menu items. -.PP -See also accel(), insertItem(), QAccel, and QAction. -.PP -Example: menu/menu.cpp. -.SH "void QMenuData::setId ( int index, int id )\fC [virtual]\fR" -Sets the menu identifier of the item at \fIindex\fR to \fIid\fR. -.PP -If \fIindex\fR is out of range, the operation is ignored. -.PP -See also idAt(). -.SH "void QMenuData::setItemChecked ( int id, bool check )" -If \fIcheck\fR is TRUE, checks the menu item with id \fIid\fR; otherwise unchecks the menu item with id \fIid\fR. Calls QPopupMenu::setCheckable( TRUE ) if necessary. -.PP -See also isItemChecked(). -.PP -Examples: -.)l canvas/canvas.cpp, grapher/grapher.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. -.SH "void QMenuData::setItemEnabled ( int id, bool enable )" -If \fIenable\fR is TRUE, enables the menu item with identifier \fIid\fR; otherwise disables the menu item with identifier \fIid\fR. -.PP -See also isItemEnabled(). -.PP -Examples: -.)l mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, and showimg/showimg.cpp. -.SH "bool QMenuData::setItemParameter ( int id, int param )" -Sets the parameter of the activation signal of item \fIid\fR to \fIparam\fR. -.PP -If any receiver takes an integer parameter, this value is passed. -.PP -See also connectItem(), disconnectItem(), and itemParameter(). -.PP -Example: mdi/application.cpp. -.SH "void QMenuData::setItemVisible ( int id, bool visible )" -If \fIvisible\fR is TRUE, shows the menu item with id \fIid\fR; otherwise hides the menu item with id \fIid\fR. -.PP -See also isItemVisible() and isItemEnabled(). -.SH "void QMenuData::setWhatsThis ( int id, const QString & text )" -Sets \fItext\fR as What's This help for the menu item with identifier \fIid\fR. -.PP -See also whatsThis(). -.PP -Examples: -.)l application/application.cpp, helpsystem/mainwindow.cpp, and mdi/application.cpp. -.SH "QString QMenuData::text ( int id ) const" -Returns the text that has been set for menu item \fIid\fR, or QString::null if no text has been set. -.PP -See also changeItem(), pixmap(), and iconSet(). -.PP -Examples: -.)l qdir/qdir.cpp and showimg/showimg.cpp. -.SH "void QMenuData::updateItem ( int id )\fC [virtual]\fR" -Virtual function; notifies subclasses about an item with \fIid\fR that has been changed. -.PP -Reimplemented in QPopupMenu. -.SH "QString QMenuData::whatsThis ( int id ) const" -Returns the What's This help text for the item with identifier \fIid\fR or QString::null if no text has yet been defined. -.PP -See also setWhatsThis(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmenudata.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmenudata.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmessagebox.3qt b/doc/man/man3/qmessagebox.3qt deleted file mode 100644 index e5b81bda9..000000000 --- a/doc/man/man3/qmessagebox.3qt +++ /dev/null @@ -1,858 +0,0 @@ -'\" t -.TH QMessageBox 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 -QMessageBox \- Modal dialog with a short message, an icon, and some buttons -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBIcon\fR { NoIcon = 0, Information = 1, Warning = 2, Critical = 3, Question = 4 }" -.br -.ti -1c -.BI "\fBQMessageBox\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQMessageBox\fR ( const QString & caption, const QString & text, Icon icon, int button0, int button1, int button2, QWidget * parent = 0, const char * name = 0, bool modal = TRUE, WFlags f = WStyle_DialogBorder )" -.br -.ti -1c -.BI "\fB~QMessageBox\fR ()" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "Icon \fBicon\fR () const" -.br -.ti -1c -.BI "void \fBsetIcon\fR ( Icon )" -.br -.ti -1c -.BI "const QPixmap * \fBiconPixmap\fR () const" -.br -.ti -1c -.BI "void \fBsetIconPixmap\fR ( const QPixmap & )" -.br -.ti -1c -.BI "QString \fBbuttonText\fR ( int button ) const" -.br -.ti -1c -.BI "void \fBsetButtonText\fR ( int button, const QString & text )" -.br -.ti -1c -.BI "virtual void \fBadjustSize\fR ()" -.br -.ti -1c -.BI "TextFormat \fBtextFormat\fR () const" -.br -.ti -1c -.BI "void \fBsetTextFormat\fR ( TextFormat )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "int \fBinformation\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )" -.br -.ti -1c -.BI "int \fBinformation\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" -.br -.ti -1c -.BI "int \fBquestion\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )" -.br -.ti -1c -.BI "int \fBquestion\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" -.br -.ti -1c -.BI "int \fBwarning\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )" -.br -.ti -1c -.BI "int \fBwarning\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" -.br -.ti -1c -.BI "int \fBcritical\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )" -.br -.ti -1c -.BI "int \fBcritical\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" -.br -.ti -1c -.BI "void \fBabout\fR ( QWidget * parent, const QString & caption, const QString & text )" -.br -.ti -1c -.BI "void \fBaboutTQt\fR ( QWidget * parent, const QString & caption = QString::null )" -.br -.ti -1c -.BI "int message ( const QString & caption, const QString & text, const QString & buttonText = QString::null, QWidget * parent = 0, const char * = 0 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool query ( const QString & caption, const QString & text, const QString & yesButtonText = QString::null, const QString & noButtonText = QString::null, QWidget * parent = 0, const char * = 0 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QPixmap standardIcon ( Icon icon, GUIStyle style ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QPixmap \fBstandardIcon\fR ( Icon icon )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "Icon \fBicon\fR - the message box's icon" -.br -.ti -1c -.BI "QPixmap \fBiconPixmap\fR - the current icon" -.br -.ti -1c -.BI "QString \fBtext\fR - the message box text to be displayed" -.br -.ti -1c -.BI "TextFormat \fBtextFormat\fR - the format of the text displayed by the message box" -.br -.in -1c -.SH DESCRIPTION -The QMessageBox class provides a modal dialog with a short message, an icon, and some buttons. -.PP -Message boxes are used to provide informative messages and to ask simple questions. -.PP -QMessageBox provides a range of different messages, arranged roughly along two axes: severity and complexity. -.PP -Severity is
                                    .nf -.TS -l - l. Question For message boxes that ask a question as part of normal operation. Some style guides recommend using Information for this purpose. Information For message boxes that are part of normal operation. Warning For message boxes that tell the user about unusual errors. Critical -.TE -.fi -
                                    -.PP -The message box has a different icon for each of the severity levels. -.PP -Complexity is one button (OK) for simple messages, or two or even three buttons for questions. -.PP -There are static functions for the most common cases. -.PP -Examples: -.)l -.PP -If a program is unable to find a supporting file, but can do perfectly well without it: -.PP -.nf -.br - QMessageBox::information( this, "Application name", -.br - "Unable to find the user preferences file.\\n" -.br - "The factory default will be used instead." ); -.br -.fi -.PP -question() is useful for simple yes/no questions: -.PP -.nf -.br - if ( QFile::exists( filename ) && -.br - QMessageBox::question( -.br - this, -.br - tr("Overwrite File? -- Application Name"), -.br - tr("A file called %1 already exists." -.br - "Do you want to overwrite it?") -.br - .arg( filename ), -.br - tr("&Yes"), tr("&No"), -.br - QString::null, 0, 1 ) ) -.br - return false; -.br -.fi -.PP -warning() can be used to tell the user about unusual errors, or errors which can't be easily fixed: -.PP -.nf -.br - switch( QMessageBox::warning( this, "Application name", -.br - "Could not connect to the server.\\n" -.br - "This program can't function correctly " -.br - "without the server.\\n\\n", -.br - "Retry", -.br - "Quit", 0, 0, 1 ) ) { -.br - case 0: // The user clicked the Retry again button or pressed Enter -.br - // try again -.br - break; -.br - case 1: // The user clicked the Quit or pressed Escape -.br - // exit -.br - break; -.br - } -.br -.fi -.PP -The text part of all message box messages can be either rich text or plain text. If you specify a rich text formatted string, it will be rendered using the default stylesheet. See QStyleSheet::defaultSheet() for details. With certain strings that contain XML meta characters, the auto-rich text detection may fail, interpreting plain text incorrectly as rich text. In these rare cases, use QStyleSheet::convertFromPlainText() to convert your plain text string to a visually equivalent rich text string or set the text format explicitly with setTextFormat(). -.PP -Note that the Microsoft Windows User Interface Guidelines recommend using the application name as the window's caption. -.PP -Below are more examples of how to use the static member functions. After these examples you will find an overview of the non-static member functions. -.PP -Exiting a program is part of its normal operation. If there is unsaved data the user probably should be asked if they want to save the data. For example: -.PP -.nf -.br - switch( QMessageBox::information( this, "Application name here", -.br - "The document contains unsaved changes\\n" -.br - "Do you want to save the changes before exiting?", -.br - "&Save", "&Discard", "Cancel", -.br - 0, // Enter == button 0 -.br - 2 ) ) { // Escape == button 2 -.br - case 0: // Save clicked or Alt+S pressed or Enter pressed. -.br - // save -.br - break; -.br - case 1: // Discard clicked or Alt+D pressed -.br - // don't save but exit -.br - break; -.br - case 2: // Cancel clicked or Escape pressed -.br - // don't exit -.br - break; -.br - } -.br -.fi -.PP -The Escape button cancels the entire exit operation, and pressing Enter causes the changes to be saved before the exit occurs. -.PP -Disk full errors are unusual and they certainly can be hard to correct. This example uses predefined buttons instead of hard-coded button texts: -.PP -.nf -.br - switch( QMessageBox::warning( this, "Application name here", -.br - "Could not save the user preferences,\\n" -.br - "because the disk is full. You can delete\\n" -.br - "some files and press Retry, or you can\\n" -.br - "abort the Save Preferences operation.", -.br - QMessageBox::Retry | QMessageBox::Default, -.br - QMessageBox::Abort | QMessageBox::Escape )) { -.br - case QMessageBox::Retry: // Retry clicked or Enter pressed -.br - // try again -.br - break; -.br - case QMessageBox::Abort: // Abort clicked or Escape pressed -.br - // abort -.br - break; -.br - } -.br -.fi -.PP -The critical() function should be reserved for critical errors. In this example errorDetails is a QString or const char*, and QString is used to concatenate several strings: -.PP -.nf -.br - QMessageBox::critical( 0, "Application name here", -.br - QString("An internal error occurred. Please ") + -.br - "call technical support at 1234-56789 and report\\n"+ -.br - "these numbers:\\n\\n" + errorDetails + -.br - "\\n\\nApplication will now exit." ); -.br -.fi -.PP -In this example an OK button is displayed. -.PP -QMessageBox provides a very simple About box which displays an appropriate icon and the string you provide: -.PP -.nf -.br - QMessageBox::about( this, "About ", -.br - " is a \\n\\n" -.br - "Copyright 1991-2003 Such-and-such. " -.br - "\\n\\n" -.br - "For technical support, call 1234-56789 or see\\n" -.br - "http://www.such-and-such.com/Application/\\n" ); -.br -.fi -.PP -See about() for more information. -.PP -If you want your users to know that the application is built using Qt (so they know that you use high quality tools) you might like to add an "About Qt" menu option under the Help menu to invoke aboutTQt(). -.PP -If none of the standard message boxes is suitable, you can create a QMessageBox from scratch and use custom button texts: -.PP -.nf -.br - QMessageBox mb( "Application name here", -.br - "Saving the file will overwrite the original file on the disk.\\n" -.br - "Do you really want to save?", -.br - QMessageBox::Information, -.br - QMessageBox::Yes | QMessageBox::Default, -.br - QMessageBox::No, -.br - QMessageBox::Cancel | QMessageBox::Escape ); -.br - mb.setButtonText( QMessageBox::Yes, "Save" ); -.br - mb.setButtonText( QMessageBox::No, "Discard" ); -.br - switch( mb.exec() ) { -.br - case QMessageBox::Yes: -.br - // save and exit -.br - break; -.br - case QMessageBox::No: -.br - // exit without saving -.br - break; -.br - case QMessageBox::Cancel: -.br - // don't save and don't exit -.br - break; -.br - } -.br -.fi -.PP -QMessageBox defines two enum types: Icon and an unnamed button type. Icon defines the Question, Information, Warning, and Critical icons for each GUI style. It is used by the constructor and by the static member functions question(), information(), warning() and critical(). A function called standardIcon() gives you access to the various icons. -.PP -The button types are: -.TP -Ok - the default for single-button message boxes -.TP -Cancel - note that this is \fInot\fR automatically Escape -.TP -Yes -.TP -No -.TP -Abort -.TP -Retry -.TP -Ignore -.TP -YesAll -.TP -NoAll -.PP -Button types can be combined with two modifiers by using OR, '|': -.TP -Default - makes pressing Enter equivalent to clicking this button. Normally used with Ok, Yes or similar. -.TP -Escape - makes pressing Escape equivalent to clicking this button. Normally used with Abort, Cancel or similar. -.PP -The text(), icon() and iconPixmap() functions provide access to the current text and pixmap of the message box. The setText(), setIcon() and setIconPixmap() let you change it. The difference between setIcon() and setIconPixmap() is that the former accepts a QMessageBox::Icon and can be used to set standard icons, whereas the latter accepts a QPixmap and can be used to set custom icons. -.PP -setButtonText() and buttonText() provide access to the buttons. -.PP -QMessageBox has no signals or slots. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QDialog, Isys on error messages, GUI Design Handbook: Message Box, and Dialog Classes. -.SS "Member Type Documentation" -.SH "QMessageBox::Icon" -This enum has the following values: -.TP -\fCQMessageBox::NoIcon\fR - the message box does not have any icon. -.TP -\fCQMessageBox::Question\fR - an icon indicating that the message is asking a question. -.TP -\fCQMessageBox::Information\fR - an icon indicating that the message is nothing out of the ordinary. -.TP -\fCQMessageBox::Warning\fR - an icon indicating that the message is a warning, but can be dealt with. -.TP -\fCQMessageBox::Critical\fR - an icon indicating that the message represents a critical problem. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMessageBox::QMessageBox ( QWidget * parent = 0, const char * name = 0 )" -Constructs a message box with no text and a button with the label" OK". -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QDialog constructor. -.SH "QMessageBox::QMessageBox ( const QString & caption, const QString & text, Icon icon, int button0, int button1, int button2, QWidget * parent = 0, const char * name = 0, bool modal = TRUE, WFlags f = WStyle_DialogBorder )" -Constructs a message box with a \fIcaption\fR, a \fItext\fR, an \fIicon\fR, and up to three buttons. -.PP -The \fIicon\fR must be one of the following: -.TP -QMessageBox::NoIcon -.TP -QMessageBox::Question -.TP -QMessageBox::Information -.TP -QMessageBox::Warning -.TP -QMessageBox::Critical -.PP -Each button, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR, can have one of the following values: -.TP -QMessageBox::NoButton -.TP -QMessageBox::Ok -.TP -QMessageBox::Cancel -.TP -QMessageBox::Yes -.TP -QMessageBox::No -.TP -QMessageBox::Abort -.TP -QMessageBox::Retry -.TP -QMessageBox::Ignore -.TP -QMessageBox::YesAll -.TP -QMessageBox::NoAll -.PP -Use QMessageBox::NoButton for the later parameters to have fewer than three buttons in your message box. If you don't specify any buttons at all, QMessageBox will provide an Ok button. -.PP -One of the buttons can be OR-ed with the \fCQMessageBox::Default\fR flag to make it the default button (clicked when Enter is pressed). -.PP -One of the buttons can be OR-ed with the \fCQMessageBox::Escape\fR flag to make it the cancel or close button (clicked when Escape is pressed). -.PP -Example: -.PP -.nf -.br - QMessageBox mb( "Application Name", -.br - "Hardware failure.\\n\\nDisk error detected\\nDo you want to stop?", -.br - QMessageBox::Question, -.br - QMessageBox::Yes | QMessageBox::Default, -.br - QMessageBox::No | QMessageBox::Escape, -.br - QMessageBox::NoButton ); -.br - if ( mb.exec() == QMessageBox::No ) -.br - // try again -.br -.fi -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -If \fImodal\fR is TRUE the message box is modal; otherwise it is modeless. -.PP -The \fIparent\fR, \fIname\fR, \fImodal\fR, and \fIf\fR arguments are passed to the QDialog constructor. -.PP -See also caption, text, and icon. -.SH "QMessageBox::~QMessageBox ()" -Destroys the message box. -.SH "void QMessageBox::about ( QWidget * parent, const QString & caption, const QString & text )\fC [static]\fR" -Displays a simple about box with caption \fIcaption\fR and text \fItext\fR. The about box's parent is \fIparent\fR. -.PP -about() looks for a suitable icon in four locations:
                                      -.TP -It prefers parent->icon() if that exists. -.TP -If not, it tries the top-level widget containing \fIparent\fR. -.TP -If that fails, it tries the main widget. -.TP -As a last resort it uses the Information icon. -.PP -The about box has a single button labelled "OK". -.PP -See also QWidget::icon and QApplication::mainWidget(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, chart/chartform.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, menu/menu.cpp, and themes/themes.cpp. -.SH "void QMessageBox::aboutTQt ( QWidget * parent, const QString & caption = QString::null )\fC [static]\fR" -Displays a simple message box about Qt, with caption \fIcaption\fR and centered over \fIparent\fR (if \fIparent\fR is not 0). The message includes the version number of Qt being used by the application. -.PP -This is useful for inclusion in the Help menu of an application. See the examples/menu/menu.cpp example. -.PP -QApplication provides this functionality as a slot. -.PP -See also QApplication::aboutTQt(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, chart/chartform.cpp, helpviewer/helpwindow.cpp, menu/menu.cpp, themes/themes.cpp, and trivial/trivial.cpp. -.SH "void QMessageBox::adjustSize ()\fC [virtual]\fR" -Adjusts the size of the message box to fit the contents just before QDialog::exec() or QDialog::show() is called. -.PP -This function will not be called if the message box has been explicitly resized before showing it. -.PP -Reimplemented from QWidget. -.SH "QString QMessageBox::buttonText ( int button ) const" -Returns the text of the message box button \fIbutton\fR, or QString::null if the message box does not contain the button. -.PP -See also setButtonText(). -.SH "int QMessageBox::critical ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )\fC [static]\fR" -Opens a critical message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the button parameters, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: -.TP -QMessageBox::NoButton -.TP -QMessageBox::Ok -.TP -QMessageBox::Cancel -.TP -QMessageBox::Yes -.TP -QMessageBox::No -.TP -QMessageBox::Abort -.TP -QMessageBox::Retry -.TP -QMessageBox::Ignore -.TP -QMessageBox::YesAll -.TP -QMessageBox::NoAll -.PP -If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. -.PP -One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. -.PP -Returns the identity (QMessageBox::Ok, or QMessageBox::No, etc.) of the button that was clicked. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -See also information(), question(), and warning(). -.PP -Examples: -.)l network/archivesearch/archivedialog.ui.h, network/ftpclient/ftpmainwindow.ui.h, process/process.cpp, and xml/outliner/outlinetree.cpp. -.SH "int QMessageBox::critical ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Displays a critical error message box with a caption, a text, and 1, 2 or 3 buttons. Returns the number of the button that was clicked (0, 1 or 2). -.PP -\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional, and \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1, or 2 to make pressing Escape equivalent to clicking the relevant button. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -See also information(), question(), and warning(). -.SH "Icon QMessageBox::icon () const" -Returns the message box's icon. See the "icon" property for details. -.SH "const QPixmap * QMessageBox::iconPixmap () const" -Returns the current icon. See the "iconPixmap" property for details. -.SH "int QMessageBox::information ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )\fC [static]\fR" -Opens an information message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the buttons, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: -.TP -QMessageBox::NoButton -.TP -QMessageBox::Ok -.TP -QMessageBox::Cancel -.TP -QMessageBox::Yes -.TP -QMessageBox::No -.TP -QMessageBox::Abort -.TP -QMessageBox::Retry -.TP -QMessageBox::Ignore -.TP -QMessageBox::YesAll -.TP -QMessageBox::NoAll -.PP -If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. -.PP -One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. -.PP -Returns the identity (QMessageBox::Ok, or QMessageBox::No, etc.) of the button that was clicked. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -See also question(), warning(), and critical(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, dirview/dirview.cpp, fileiconview/qfileiconview.cpp, picture/picture.cpp, qwerty/qwerty.cpp, and simple/main.cpp. -.SH "int QMessageBox::information ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Displays an information message box with caption \fIcaption\fR, text \fItext\fR and one, two or three buttons. Returns the index of the button that was clicked (0, 1 or 2). -.PP -\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional. \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1 or 2 to make pressing Escape equivalent to clicking the relevant button. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -Note: If you do not specify an Escape button then if the Escape button is pressed then -1 will be returned. It is suggested that you specify an Escape button to prevent this from happening. -.PP -See also question(), warning(), and critical(). -.SH "int QMessageBox::message ( const QString & caption, const QString & text, const QString & buttonText = QString::null, QWidget * parent = 0, const char * = 0 )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Opens a modal message box directly using the specified parameters. -.PP -Please use information(), warning(), question(), or critical() instead. -.PP -Example: grapher/grapher.cpp. -.SH "bool QMessageBox::query ( const QString & caption, const QString & text, const QString & yesButtonText = QString::null, const QString & noButtonText = QString::null, QWidget * parent = 0, const char * = 0 )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Queries the user using a modal message box with two buttons. Note that \fIcaption\fR is not always shown, it depends on the window manager. -.PP -Please use information(), question(), warning(), or critical() instead. -.SH "int QMessageBox::question ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )\fC [static]\fR" -Opens a question message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the buttons, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: -.TP -QMessageBox::NoButton -.TP -QMessageBox::Ok -.TP -QMessageBox::Cancel -.TP -QMessageBox::Yes -.TP -QMessageBox::No -.TP -QMessageBox::Abort -.TP -QMessageBox::Retry -.TP -QMessageBox::Ignore -.TP -QMessageBox::YesAll -.TP -QMessageBox::NoAll -.PP -If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. -.PP -One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. -.PP -Returns the identity (QMessageBox::Yes, or QMessageBox::No, etc.) of the button that was clicked. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -See also information(), warning(), and critical(). -.SH "int QMessageBox::question ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Displays a question message box with caption \fIcaption\fR, text \fItext\fR and one, two or three buttons. Returns the index of the button that was clicked (0, 1 or 2). -.PP -\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional. \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1 or 2 to make pressing Escape equivalent to clicking the relevant button. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -Note: If you do not specify an Escape button then if the Escape button is pressed then -1 will be returned. It is suggested that you specify an Escape button to prevent this from happening. -.PP -See also information(), warning(), and critical(). -.SH "void QMessageBox::setButtonText ( int button, const QString & text )" -Sets the text of the message box button \fIbutton\fR to \fItext\fR. Setting the text of a button that is not in the message box is silently ignored. -.PP -See also buttonText(). -.SH "void QMessageBox::setIcon ( Icon )" -Sets the message box's icon. See the "icon" property for details. -.SH "void QMessageBox::setIconPixmap ( const QPixmap & )" -Sets the current icon. See the "iconPixmap" property for details. -.SH "void QMessageBox::setText ( const QString & )" -Sets the message box text to be displayed. See the "text" property for details. -.SH "void QMessageBox::setTextFormat ( TextFormat )" -Sets the format of the text displayed by the message box. See the "textFormat" property for details. -.SH "QPixmap QMessageBox::standardIcon ( Icon icon )\fC [static]\fR" -Returns the pixmap used for a standard icon. This allows the pixmaps to be used in more complex message boxes. \fIicon\fR specifies the required icon, e.g. QMessageBox::Question, QMessageBox::Information, QMessageBox::Warning or QMessageBox::Critical. -.SH "QPixmap QMessageBox::standardIcon ( Icon icon, GUIStyle style )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the pixmap used for a standard icon. This allows the pixmaps to be used in more complex message boxes. \fIicon\fR specifies the required icon, e.g. QMessageBox::Information, QMessageBox::Warning or QMessageBox::Critical. -.PP -\fIstyle\fR is unused. -.SH "QString QMessageBox::text () const" -Returns the message box text to be displayed. See the "text" property for details. -.SH "TextFormat QMessageBox::textFormat () const" -Returns the format of the text displayed by the message box. See the "textFormat" property for details. -.SH "int QMessageBox::warning ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )\fC [static]\fR" -Opens a warning message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the button parameters, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: -.TP -QMessageBox::NoButton -.TP -QMessageBox::Ok -.TP -QMessageBox::Cancel -.TP -QMessageBox::Yes -.TP -QMessageBox::No -.TP -QMessageBox::Abort -.TP -QMessageBox::Retry -.TP -QMessageBox::Ignore -.TP -QMessageBox::YesAll -.TP -QMessageBox::NoAll -.PP -If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. -.PP -One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. -.PP -Returns the identity (QMessageBox::Ok, or QMessageBox::No, etc.) of the button that was clicked. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -See also information(), question(), and critical(). -.PP -Examples: -.)l chart/chartform.cpp, i18n/main.cpp, network/mail/smtp.cpp, qwerty/qwerty.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "int QMessageBox::warning ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Displays a warning message box with a caption, a text, and 1, 2 or 3 buttons. Returns the number of the button that was clicked (0, 1, or 2). -.PP -\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional, and \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1, or 2 to make pressing Escape equivalent to clicking the relevant button. -.PP -If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. -.PP -Note: If you do not specify an Escape button then if the Escape button is pressed then -1 will be returned. It is suggested that you specify an Escape button to prevent this from happening. -.PP -See also information(), question(), and critical(). -.SS "Property Documentation" -.SH "Icon icon" -This property holds the message box's icon. -.PP -The icon of the message box can be one of the following predefined icons: -.TP -QMessageBox::NoIcon -.TP -QMessageBox::Question -.TP -QMessageBox::Information -.TP -QMessageBox::Warning -.TP -QMessageBox::Critical -.PP -The actual pixmap used for displaying the icon depends on the current GUI style. You can also set a custom pixmap icon using the QMessageBox::iconPixmap property. The default icon is QMessageBox::NoIcon. -.PP -See also iconPixmap. -.PP -Set this property's value with setIcon() and get this property's value with icon(). -.SH "QPixmap iconPixmap" -This property holds the current icon. -.PP -The icon currently used by the message box. Note that it's often hard to draw one pixmap that looks appropriate in both Motif and Windows GUI styles; you may want to draw two pixmaps. -.PP -See also icon. -.PP -Set this property's value with setIconPixmap() and get this property's value with iconPixmap(). -.SH "QString text" -This property holds the message box text to be displayed. -.PP -The text will be interpreted either as a plain text or as rich text, depending on the text format setting (QMessageBox::textFormat). The default setting is AutoText, i.e. the message box will try to auto-detect the format of the text. -.PP -The default value of this property is QString::null. -.PP -See also textFormat. -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "TextFormat textFormat" -This property holds the format of the text displayed by the message box. -.PP -The current text format used by the message box. See the Qt::TextFormat enum for an explanation of the possible options. -.PP -The default format is AutoText. -.PP -See also text. -.PP -Set this property's value with setTextFormat() and get this property's value with textFormat(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmessagebox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmessagebox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmetaobject.3qt b/doc/man/man3/qmetaobject.3qt deleted file mode 100644 index a8923dccd..000000000 --- a/doc/man/man3/qmetaobject.3qt +++ /dev/null @@ -1,184 +0,0 @@ -'\" t -.TH QMetaObject 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 -QMetaObject \- Meta information about Qt objects -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "const char * \fBclassName\fR () const" -.br -.ti -1c -.BI "const char * \fBsuperClassName\fR () const" -.br -.ti -1c -.BI "QMetaObject * \fBsuperClass\fR () const" -.br -.ti -1c -.BI "bool \fBinherits\fR ( const char * clname ) const" -.br -.ti -1c -.BI "int \fBnumSlots\fR ( bool super = FALSE ) const" -.br -.ti -1c -.BI "int \fBnumSignals\fR ( bool super = FALSE ) const" -.br -.ti -1c -.BI "QStrList \fBslotNames\fR ( bool super = FALSE ) const" -.br -.ti -1c -.BI "QStrList \fBsignalNames\fR ( bool super = FALSE ) const" -.br -.ti -1c -.BI "int \fBnumClassInfo\fR ( bool super = FALSE ) const" -.br -.ti -1c -.BI "const QClassInfo * \fBclassInfo\fR ( int index, bool super = FALSE ) const" -.br -.ti -1c -.BI "const char * \fBclassInfo\fR ( const char * name, bool super = FALSE ) const" -.br -.ti -1c -.BI "const QMetaProperty * \fBproperty\fR ( int index, bool super = FALSE ) const" -.br -.ti -1c -.BI "int \fBfindProperty\fR ( const char * name, bool super = FALSE ) const" -.br -.ti -1c -.BI "QStrList \fBpropertyNames\fR ( bool super = FALSE ) const" -.br -.ti -1c -.BI "int \fBnumProperties\fR ( bool super = FALSE ) const" -.br -.in -1c -.SH DESCRIPTION -The QMetaObject class contains meta information about Qt objects. -.PP -The Meta Object System in Qt is responsible for the signals and slots inter-object communication mechanism, runtime type information and the property system. All meta information in Qt is kept in a single instance of QMetaObject per class. -.PP -This class is not normally required for application programming. But if you write meta applications, such as scripting engines or GUI builders, you might find these functions useful: -.TP -className() to get the name of a class. -.TP -superClassName() to get the name of the superclass. -.TP -inherits(), the function called by QObject::inherits(). -.TP -superClass() to access the superclass's meta object. -.TP -numSlots(), numSignals(), slotNames(), and signalNames() to get information about a class's signals and slots. -.TP -property() and propertyNames() to obtain information about a class's properties. -.PP -Classes may have a list of name-value pairs of class information. The number of pairs is returned by numClassInfo(), and values are returned by classInfo(). -.PP -See also moc (Meta Object Compiler) and Object Model. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "const QClassInfo * QMetaObject::classInfo ( int index, bool super = FALSE ) const" -Returns the class information with index \fIindex\fR or 0 if no such information exists. -.PP -If \fIsuper\fR is TRUE, inherited class information is included. -.SH "const char * QMetaObject::classInfo ( const char * name, bool super = FALSE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the class information with name \fIname\fR or 0 if no such information exists. -.PP -If \fIsuper\fR is TRUE, inherited class information is included. -.SH "const char * QMetaObject::className () const" -Returns the class name. -.PP -See also QObject::className() and superClassName(). -.SH "int QMetaObject::findProperty ( const char * name, bool super = FALSE ) const" -Returns the index for the property with name \fIname\fR or -1 if no such property exists. -.PP -If \fIsuper\fR is TRUE, inherited properties are included. -.PP -See also property() and propertyNames(). -.SH "bool QMetaObject::inherits ( const char * clname ) const" -Returns TRUE if this class inherits \fIclname\fR within the meta object inheritance chain; otherwise returns FALSE. -.PP -(A class is considered to inherit itself.) -.SH "int QMetaObject::numClassInfo ( bool super = FALSE ) const" -Returns the number of items of class information available for this class. -.PP -If \fIsuper\fR is TRUE, inherited class information is included. -.SH "int QMetaObject::numProperties ( bool super = FALSE ) const" -Returns the number of properties for this class. -.PP -If \fIsuper\fR is TRUE, inherited properties are included. -.PP -See also propertyNames(). -.SH "int QMetaObject::numSignals ( bool super = FALSE ) const" -Returns the number of signals for this class. -.PP -If \fIsuper\fR is TRUE, inherited signals are included. -.PP -See also signalNames(). -.SH "int QMetaObject::numSlots ( bool super = FALSE ) const" -Returns the number of slots for this class. -.PP -If \fIsuper\fR is TRUE, inherited slots are included. -.PP -See also slotNames(). -.SH "const QMetaProperty * QMetaObject::property ( int index, bool super = FALSE ) const" -Returns the property meta data for the property at index \fIindex\fR or 0 if no such property exists. -.PP -If \fIsuper\fR is TRUE, inherited properties are included. -.PP -See also propertyNames(). -.SH "QStrList QMetaObject::propertyNames ( bool super = FALSE ) const" -Returns a list with the names of all this class's properties. -.PP -If \fIsuper\fR is TRUE, inherited properties are included. -.PP -See also property(). -.SH "QStrList QMetaObject::signalNames ( bool super = FALSE ) const" -Returns a list with the names of all this class's signals. -.PP -If \fIsuper\fR is TRUE, inherited signals are included. -.SH "QStrList QMetaObject::slotNames ( bool super = FALSE ) const" -Returns a list with the names of all this class's slots. -.PP -If \fIsuper\fR is TRUE, inherited slots are included. -.PP -See also numSlots(). -.SH "QMetaObject * QMetaObject::superClass () const" -Returns the meta object of the super class or 0 if there is no such object. -.SH "const char * QMetaObject::superClassName () const" -Returns the class name of the superclass or 0 if there is no superclass in the QObject hierachy. -.PP -See also className(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmetaobject.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmetaobject.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmetaproperty.3qt b/doc/man/man3/qmetaproperty.3qt deleted file mode 100644 index c13a455f2..000000000 --- a/doc/man/man3/qmetaproperty.3qt +++ /dev/null @@ -1,151 +0,0 @@ -'\" t -.TH QMetaProperty 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 -QMetaProperty \- Stores meta data about a property -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "const char * \fBtype\fR () const" -.br -.ti -1c -.BI "const char * \fBname\fR () const" -.br -.ti -1c -.BI "bool \fBwritable\fR () const" -.br -.ti -1c -.BI "bool \fBisSetType\fR () const" -.br -.ti -1c -.BI "bool \fBisEnumType\fR () const" -.br -.ti -1c -.BI "QStrList \fBenumKeys\fR () const" -.br -.ti -1c -.BI "int \fBkeyToValue\fR ( const char * key ) const" -.br -.ti -1c -.BI "const char * \fBvalueToKey\fR ( int value ) const" -.br -.ti -1c -.BI "int \fBkeysToValue\fR ( const QStrList & keys ) const" -.br -.ti -1c -.BI "QStrList \fBvalueToKeys\fR ( int value ) const" -.br -.ti -1c -.BI "bool \fBdesignable\fR ( QObject * o = 0 ) const" -.br -.ti -1c -.BI "bool \fBscriptable\fR ( QObject * o = 0 ) const" -.br -.ti -1c -.BI "bool \fBstored\fR ( QObject * o = 0 ) const" -.br -.ti -1c -.BI "bool \fBreset\fR ( QObject * o ) const" -.br -.in -1c -.SH DESCRIPTION -The QMetaProperty class stores meta data about a property. -.PP -Property meta data includes type(), name(), and whether a property is writable(), designable() and stored(). -.PP -The functions isSetType(), isEnumType() and enumKeys() provide further information about a property's type. The conversion functions keyToValue(), valueToKey(), keysToValue() and valueToKeys() allow conversion between the integer representation of an enumeration or set value and its literal representation. -.PP -Actual property values are set and received through QObject's set and get functions. See QObject::setProperty() and QObject::property() for details. -.PP -You receive meta property data through an object's meta object. See QMetaObject::property() and QMetaObject::propertyNames() for details. -.PP -See also Object Model. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "bool QMetaProperty::designable ( QObject * o = 0 ) const" -Returns TRUE if the property is designable for object \fIo\fR; otherwise returns FALSE. -.PP -If no object \fIo\fR is given, the function returns a static approximation. -.SH "QStrList QMetaProperty::enumKeys () const" -Returns the possible enumeration keys if this property is an enumeration type (or a set type). -.PP -See also isEnumType(). -.SH "bool QMetaProperty::isEnumType () const" -Returns TRUE if the property's type is an enumeration value; otherwise returns FALSE. -.PP -See also isSetType() and enumKeys(). -.SH "bool QMetaProperty::isSetType () const" -Returns TRUE if the property's type is an enumeration value that is used as set, i.e. if the enumeration values can be OR-ed together; otherwise returns FALSE. A set type is implicitly also an enum type. -.PP -See also isEnumType() and enumKeys(). -.SH "int QMetaProperty::keyToValue ( const char * key ) const" -Converts the enumeration key \fIkey\fR to its integer value. -.PP -For set types, use keysToValue(). -.PP -See also valueToKey(), isSetType(), and keysToValue(). -.SH "int QMetaProperty::keysToValue ( const QStrList & keys ) const" -Converts the list of keys \fIkeys\fR to their combined (OR-ed) integer value. -.PP -See also isSetType() and valueToKey(). -.SH "const char * QMetaProperty::name () const" -Returns the name of the property. -.SH "bool QMetaProperty::reset ( QObject * o ) const" -Tries to reset the property for object \fIo\fR with a reset method. On success, returns TRUE; otherwise returns FALSE. -.PP -Reset methods are optional, usually only a few properties support them. -.SH "bool QMetaProperty::scriptable ( QObject * o = 0 ) const" -Returns TRUE if the property is scriptable for object \fIo\fR; otherwise returns FALSE. -.PP -If no object \fIo\fR is given, the function returns a static approximation. -.SH "bool QMetaProperty::stored ( QObject * o = 0 ) const" -Returns TRUE if the property shall be stored for object \fIo\fR; otherwise returns FALSE. -.PP -If no object \fIo\fR is given, the function returns a static approximation. -.SH "const char * QMetaProperty::type () const" -Returns the type of the property. -.SH "const char * QMetaProperty::valueToKey ( int value ) const" -Converts the enumeration value \fIvalue\fR to its literal key. -.PP -For set types, use valueToKeys(). -.PP -See also isSetType() and valueToKeys(). -.SH "QStrList QMetaProperty::valueToKeys ( int value ) const" -Converts the set value \fIvalue\fR to a list of keys. -.PP -See also isSetType() and valueToKey(). -.SH "bool QMetaProperty::writable () const" -Returns TRUE if the property is writable; otherwise returns FALSE. -.PP - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmetaproperty.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmetaproperty.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmimesource.3qt b/doc/man/man3/qmimesource.3qt deleted file mode 100644 index 3bf6b8654..000000000 --- a/doc/man/man3/qmimesource.3qt +++ /dev/null @@ -1,94 +0,0 @@ -'\" t -.TH QMimeSource 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 -QMimeSource \- Abstraction of objects which provide formatted data of a certain MIME type -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QDragObject and QDropEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMimeSource\fR ()" -.br -.ti -1c -.BI "virtual \fB~QMimeSource\fR ()" -.br -.ti -1c -.BI "virtual const char * \fBformat\fR ( int i = 0 ) const = 0" -.br -.ti -1c -.BI "virtual bool \fBprovides\fR ( const char * mimeType ) const" -.br -.ti -1c -.BI "virtual QByteArray \fBencodedData\fR ( const char * ) const = 0" -.br -.ti -1c -.BI "int \fBserialNumber\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QMimeSource class is an abstraction of objects which provide formatted data of a certain MIME type. -.PP -Drag-and-drop and clipboard use this abstraction. -.PP -See also IANA list of MIME media types, Drag And Drop Classes, Input/Output and Networking, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMimeSource::QMimeSource ()" -Constructs a mime source and assigns a globally unique serial number to it. -.PP -See also serialNumber(). -.SH "QMimeSource::~QMimeSource ()\fC [virtual]\fR" -Provided to ensure that subclasses destroy themselves correctly. -.SH "QByteArray QMimeSource::encodedData ( const char * ) const\fC [pure virtual]\fR" -Returns the encoded data of this object in the specified MIME format. -.PP -Subclasses must reimplement this function. -.PP -Reimplemented in QStoredDrag, QDropEvent, and QIconDrag. -.SH "const char * QMimeSource::format ( int i = 0 ) const\fC [pure virtual]\fR" -Returns the \fIi\fR-th supported MIME format, or 0. -.PP -Reimplemented in QDropEvent. -.SH "bool QMimeSource::provides ( const char * mimeType ) const\fC [virtual]\fR" -Returns TRUE if the object can provide the data in format \fImimeType\fR; otherwise returns FALSE. -.PP -If you inherit from QMimeSource, for consistency reasons it is better to implement the more abstract canDecode() functions such as QTextDrag::canDecode() and QImageDrag::canDecode(). -.PP -Example: iconview/simple_dd/main.cpp. -.PP -Reimplemented in QDropEvent. -.SH "int QMimeSource::serialNumber () const" -Returns the mime source's globally unique serial number. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmimesource.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmimesource.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmimesourcefactory.3qt b/doc/man/man3/qmimesourcefactory.3qt deleted file mode 100644 index 7797f1cab..000000000 --- a/doc/man/man3/qmimesourcefactory.3qt +++ /dev/null @@ -1,233 +0,0 @@ -'\" t -.TH QMimeSourceFactory 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 -QMimeSourceFactory \- Extensible provider of mime-typed data -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMimeSourceFactory\fR ()" -.br -.ti -1c -.BI "virtual \fB~QMimeSourceFactory\fR ()" -.br -.ti -1c -.BI "virtual const QMimeSource * \fBdata\fR ( const QString & abs_name ) const" -.br -.ti -1c -.BI "virtual QString \fBmakeAbsolute\fR ( const QString & abs_or_rel_name, const QString & context ) const" -.br -.ti -1c -.BI "const QMimeSource * \fBdata\fR ( const QString & abs_or_rel_name, const QString & context ) const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & abs_name, const QString & text )" -.br -.ti -1c -.BI "virtual void \fBsetImage\fR ( const QString & abs_name, const QImage & image )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QString & abs_name, const QPixmap & pixmap )" -.br -.ti -1c -.BI "virtual void \fBsetData\fR ( const QString & abs_name, QMimeSource * data )" -.br -.ti -1c -.BI "virtual void \fBsetFilePath\fR ( const QStringList & path )" -.br -.ti -1c -.BI "virtual QStringList \fBfilePath\fR () const" -.br -.ti -1c -.BI "void \fBaddFilePath\fR ( const QString & p )" -.br -.ti -1c -.BI "virtual void \fBsetExtensionType\fR ( const QString & ext, const char * mimetype )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QMimeSourceFactory * \fBdefaultFactory\fR ()" -.br -.ti -1c -.BI "void \fBsetDefaultFactory\fR ( QMimeSourceFactory * factory )" -.br -.ti -1c -.BI "QMimeSourceFactory * \fBtakeDefaultFactory\fR ()" -.br -.ti -1c -.BI "void \fBaddFactory\fR ( QMimeSourceFactory * f )" -.br -.ti -1c -.BI "void \fBremoveFactory\fR ( QMimeSourceFactory * f )" -.br -.in -1c -.SH DESCRIPTION -The QMimeSourceFactory class is an extensible provider of mime-typed data. -.PP -A QMimeSourceFactory provides an abstract interface to a collection of information. Each piece of information is represented by a QMimeSource object which can be examined and converted to concrete data types by functions such as QImageDrag::canDecode() and QImageDrag::decode(). -.PP -The base QMimeSourceFactory can be used in two ways: as an abstraction of a collection of files or as specifically stored data. For it to access files, call setFilePath() before accessing data. For stored data, call setData() for each item (there are also convenience functions, e.g. setText(), setImage() and setPixmap(), that simply call setData() with appropriate parameters). -.PP -The rich text widgets, QTextEdit and QTextBrowser, use QMimeSourceFactory to resolve references such as images or links within rich text documents. They either access the default factory (see defaultFactory()) or their own (see QTextEdit::setMimeSourceFactory()). Other classes that are capable of displaying rich text (such as QLabel, QWhatsThis or QMessageBox) always use the default factory. -.PP -A factory can also be used as a container to store data associated with a name. This technique is useful whenever rich text contains images that are stored in the program itself, not loaded from the hard disk. Your program may, for example, define some image data as: -.PP -.nf -.br - static const char* myimage_data[]={ -.br - "...", -.br - ... -.br - "..."}; -.br -.fi -.PP -To be able to use this image within some rich text, for example inside a QLabel, you must create a QImage from the raw data and insert it into the factory with a unique name: -.PP -.nf -.br - QMimeSourceFactory::defaultFactory()->setImage( "myimage", QImage(myimage_data) ); -.br -.fi -.PP -Now you can create a rich text QLabel with -.PP -.nf -.br - QLabel* label = new QLabel( -.br - "Rich text with embedded image:" -.br - "Isn't that cute?" ); -.br -.fi -.PP -When no longer needed, you can clear the data from the factory: -.PP -.nf -.br - delete label; -.br - QMimeSourceFactory::defaultFactory()->setData( "myimage", 0 ); -.br -.fi -.PP -See also Environment Classes and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMimeSourceFactory::QMimeSourceFactory ()" -Constructs a QMimeSourceFactory that has no file path and no stored content. -.SH "QMimeSourceFactory::~QMimeSourceFactory ()\fC [virtual]\fR" -Destroys the QMimeSourceFactory, deleting all stored content. -.SH "void QMimeSourceFactory::addFactory ( QMimeSourceFactory * f )\fC [static]\fR" -Adds the QMimeSourceFactory \fIf\fR to the list of available mimesource factories. If the defaultFactory() can't resolve a data() it iterates over the list of installed mimesource factories until the data can be resolved. -.PP -See also removeFactory(). -.SH "void QMimeSourceFactory::addFilePath ( const QString & p )" -Adds another search path, \fIp\fR to the existing search paths. -.PP -See also setFilePath(). -.SH "const QMimeSource * QMimeSourceFactory::data ( const QString & abs_name ) const\fC [virtual]\fR" -Returns a reference to the data associated with \fIabs_name\fR. The return value remains valid only until the next data() or setData() call, so you should immediately decode the result. -.PP -If there is no data associated with \fIabs_name\fR in the factory's store, the factory tries to access the local filesystem. If \fIabs_name\fR isn't an absolute file name, the factory will search for it in all defined paths (see setFilePath()). -.PP -The factory understands all the image formats supported by QImageIO. Any other mime types are determined by the file name extension. The default settings are -.PP -.nf -.br - setExtensionType("html", "text/html;charset=iso8859-1"); -.br - setExtensionType("htm", "text/html;charset=iso8859-1"); -.br - setExtensionType("txt", "text/plain"); -.br - setExtensionType("xml", "text/xml;charset=UTF-8"); -.br -.fi -The effect of these is that file names ending in "txt" will be treated as text encoded in the local encoding; those ending in" xml" will be treated as text encoded in Unicode UTF-8 encoding. The text/html type is treated specially, since the encoding can be specified in the html file itself. "html" or "htm" will be treated as text encoded in the encoding specified by the html meta tag, if none could be found, the charset of the mime type will be used. The text subtype ("html", "plain", or "xml") does not affect the factory, but users of the factory may behave differently. We recommend creating "xml" files where practical. These files can be viewed regardless of the runtime encoding and can encode any Unicode characters without resorting to encoding definitions inside the file. -.PP -Any file data that is not recognized will be retrieved as a QMimeSource providing the "application/octet-stream" mime type, meaning uninterpreted binary data. -.PP -You can add further extensions or change existing ones with subsequent calls to setExtensionType(). If the extension mechanism is not sufficient for your problem domain, you can inherit QMimeSourceFactory and reimplement this function to perform some more specialized mime-type detection. The same applies if you want to use the mime source factory to access URL referenced data over a network. -.SH "const QMimeSource * QMimeSourceFactory::data ( const QString & abs_or_rel_name, const QString & context ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -A convenience function. See data(const QString& abs_name). The file name is given in \fIabs_or_rel_name\fR and the path is in \fIcontext\fR. -.SH "QMimeSourceFactory * QMimeSourceFactory::defaultFactory ()\fC [static]\fR" -Returns the application-wide default mime source factory. This factory is used by rich text rendering classes such as QSimpleRichText, QWhatsThis and QMessageBox to resolve named references within rich text documents. It serves also as the initial factory for the more complex render widgets, QTextEdit and QTextBrowser. -.PP -See also setDefaultFactory(). -.PP -Examples: -.)l action/application.cpp and application/application.cpp. -.SH "QStringList QMimeSourceFactory::filePath () const\fC [virtual]\fR" -Returns the currently set search paths. -.SH "QString QMimeSourceFactory::makeAbsolute ( const QString & abs_or_rel_name, const QString & context ) const\fC [virtual]\fR" -Converts the absolute or relative data item name \fIabs_or_rel_name\fR to an absolute name, interpreted within the context (path) of the data item named \fIcontext\fR (this must be an absolute name). -.SH "void QMimeSourceFactory::removeFactory ( QMimeSourceFactory * f )\fC [static]\fR" -Removes the mimesource factory \fIf\fR from the list of available mimesource factories. -.PP -See also addFactory(). -.SH "void QMimeSourceFactory::setData ( const QString & abs_name, QMimeSource * data )\fC [virtual]\fR" -Sets \fIdata\fR to be the data item associated with the absolute name \fIabs_name\fR. Note that the ownership of \fIdata\fR is transferred to the factory: do not delete or access the pointer after passing it to this function. -.PP -Passing 0 for data removes previously stored data. -.SH "void QMimeSourceFactory::setDefaultFactory ( QMimeSourceFactory * factory )\fC [static]\fR" -Sets the default \fIfactory\fR, destroying any previously set mime source provider. The ownership of the factory is transferred to Qt. -.PP -See also defaultFactory(). -.SH "void QMimeSourceFactory::setExtensionType ( const QString & ext, const char * mimetype )\fC [virtual]\fR" -Sets the mime-type to be associated with the file name extension, \fIext\fR to \fImimetype\fR. This determines the mime-type for files found via the paths set by setFilePath(). -.SH "void QMimeSourceFactory::setFilePath ( const QStringList & path )\fC [virtual]\fR" -Sets the list of directories that will be searched when named data is requested to the those given in the string list \fIpath\fR. -.PP -See also filePath(). -.SH "void QMimeSourceFactory::setImage ( const QString & abs_name, const QImage & image )\fC [virtual]\fR" -Sets \fIimage\fR to be the data item associated with the absolute name \fIabs_name\fR. -.PP -Equivalent to setData(abs_name, new QImageDrag(image)). -.SH "void QMimeSourceFactory::setPixmap ( const QString & abs_name, const QPixmap & pixmap )\fC [virtual]\fR" -Sets \fIpixmap\fR to be the data item associated with the absolute name \fIabs_name\fR. -.SH "void QMimeSourceFactory::setText ( const QString & abs_name, const QString & text )\fC [virtual]\fR" -Sets \fItext\fR to be the data item associated with the absolute name \fIabs_name\fR. -.PP -Equivalent to setData(abs_name, new QTextDrag(text)). -.SH "QMimeSourceFactory * QMimeSourceFactory::takeDefaultFactory ()\fC [static]\fR" -Sets the defaultFactory() to 0 and returns the previous one. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmimesourcefactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmimesourcefactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmotif.3qt b/doc/man/man3/qmotif.3qt deleted file mode 100644 index f0f67d405..000000000 --- a/doc/man/man3/qmotif.3qt +++ /dev/null @@ -1,114 +0,0 @@ -'\" t -.TH QMotif 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 -QMotif \- The basis of the -.SH SYNOPSIS -This class is part of the \fBQt Motif Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QEventLoop. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMotif\fR ( const char * applicationClass, XtAppContext context = NULL, XrmOptionDescRec * options = 0, int numOptions = 0 )" -.br -.ti -1c -.BI "\fB~QMotif\fR ()" -.br -.ti -1c -.BI "XtAppContext \fBapplicationContext\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "Display * \fBx11Display\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt Motif Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QMotif class provides the basis of the Motif Extension. -.PP -QMotif only provides a few public functions, but it is at the heart of the integration. QMotif is responsible for initializing the Xt toolkit and the Xt application context. It does not open a connection to the X server, that is done by QApplication. -.PP -The only member function in QMotif that depends on an X server connection is QMotif::initialize(). QMotif must be created before QApplication. -.PP -Example usage of QMotif and QApplication: -.PP -.nf -.br - static char *resources[] = { -.br - ... -.br - }; -.br -.br - int main(int argc, char **argv) -.br - { -.br - QMotif integrator( "AppClass" ); -.br - XtAppSetFallbackResources( integrator.applicationContext(), -.br - resources ); -.br - QApplication app( argc, argv ); -.br -.br - ... -.br -.br - return app.exec(); -.br - } -.br -.fi -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMotif::QMotif ( const char * applicationClass, XtAppContext context = NULL, XrmOptionDescRec * options = 0, int numOptions = 0 )" -Creates QMotif, which allows Qt and Xt/Motif integration. -.PP -If \fIcontext\fR is 0, QMotif creates a default application context itself. The context is accessible through applicationContext(). -.PP -All arguments passed to this function (\fIapplicationClass\fR, \fIoptions\fR and \fInumOptions\fR) are used to call XtDisplayInitialize() after QApplication has been constructed. -.SH "QMotif::~QMotif ()" -Destroys QMotif. -.SH "XtAppContext QMotif::applicationContext () const" -Returns the application context. -.SH "Display * QMotif::x11Display ()\fC [static]\fR" -Returns the X11 display connection used by the Qt Motif Extension. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmotif.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmotif.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmotifdialog.3qt b/doc/man/man3/qmotifdialog.3qt deleted file mode 100644 index 96539cf3b..000000000 --- a/doc/man/man3/qmotifdialog.3qt +++ /dev/null @@ -1,178 +0,0 @@ -'\" t -.TH QMotifDialog 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 -QMotifDialog \- The QDialog API for Motif-based dialogs -.SH SYNOPSIS -This class is part of the \fBQt Motif Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum DialogType { Prompt, Selection, Command, FileSelection, Template, Error, Information, Message, Question, Warning, Working } \fI(obsolete)\fR" -.br -.ti -1c -.BI "QMotifDialog ( DialogType dialogtype, Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QMotifDialog ( Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "\fBQMotifDialog\fR ( Widget parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" -.br -.ti -1c -.BI "\fBQMotifDialog\fR ( QWidget * parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" -.br -.ti -1c -.BI "virtual \fB~QMotifDialog\fR ()" -.br -.ti -1c -.BI "Widget \fBshell\fR () const" -.br -.ti -1c -.BI "Widget \fBdialog\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBacceptCallback\fR ( Widget, XtPointer client_data, XtPointer )" -.br -.ti -1c -.BI "void \fBrejectCallback\fR ( Widget, XtPointer client_data, XtPointer )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt Motif Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QMotifDialog class provides the QDialog API for Motif-based dialogs. -.PP -QMotifDialog provides two separate modes of operation. The application programmer can use QMotifDialog with an existing Motif-based dialog and a QWidget parent, or the application programmer can use QMotifDialog with a custom Qt-based dialog and a Motif-based parent. Modality continues to work as expected. -.PP -Motif-based dialogs must have a \fCShell\fR widget parent with a single child, due to requirements of the Motif toolkit. The \fCShell\fR widget, which is a special subclass of \fCXmDialogShell\fR, is created during construction. It can be accessed using the shell() member function. -.PP -The single child of the \fCShell\fR can be accessed using the dialog() member function \fIafter\fR it has been created. -.PP -The acceptCallback() and rejectCallback() functions provide a convenient way to call QDialog::accept() and QDialog::reject() through callbacks. A pointer to the QMotifDialog should be passed as the \fCclient_data\fR argument to the callback. -.PP -The API and behavior QMotifDialog is identical to that of QDialog when using a custom Qt-based dialog with a Motif-based parent. The only difference is that a Motif-based \fIparent\fR argument is passed to the constructor, instead of a QWidget parent. -.SS "Member Type Documentation" -.SH "QMotifDialog::DialogType" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This enum lists the predefined Motif dialog types. -.TP -\fCQMotifDialog::Prompt\fR -.TP -\fCQMotifDialog::Selection\fR -.TP -\fCQMotifDialog::Command\fR -.TP -\fCQMotifDialog::FileSelection\fR -.TP -\fCQMotifDialog::Template\fR -.TP -\fCQMotifDialog::Error\fR -.TP -\fCQMotifDialog::Information\fR -.TP -\fCQMotifDialog::Message\fR -.TP -\fCQMotifDialog::Question\fR -.TP -\fCQMotifDialog::Warning\fR -.TP -\fCQMotifDialog::Working\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMotifDialog::QMotifDialog ( DialogType dialogtype, Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Creates a QMotifDialog using one of the predefined Motif dialog types. The \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. -.PP -This constructor creates a Shell widget, which is a special subclass of XmDialogShell. The \fIparent\fR, \fIargs\fR and \fIargcount\fR arguments are passed to XtCreatePopupShell() when creating the subclass. You can access the Shell widget with the shell() member function. -.PP -This constructor also creates the dialog widget with the Shell widget as its parent. The type of the dialog created is specified by the \fIdialogtype\fR argument. See the DialogType enum for a list of available dialog types. You can access the dialog widget with the dialog() member function. -.PP -\fBWarning:\fR QMotifDialog takes ownership of the child widget and destroys it during destruction. You should not destroy the dialog widget yourself. -.PP -See also DialogType, shell(), and dialog(). -.SH "QMotifDialog::QMotifDialog ( Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Creates a QMotifDialog which allows the application programmer to use the Motif-based \fIparent\fR for a custom QDialog. The \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. -.PP -This constructor creates a Shell widget, which is a special subclass of XmDialogShell. The \fIargs\fR and \fIargcount\fR arguments are passed to XtCreatePopupShell() when creating the subclass. You can access the Shell widget with the shell() member function. -.PP -The dialog widget is not created by the constructor. You must create the dialog widget as a child of the the widget returned by shell(). You can access the child widget with the dialog() member function. -.PP -A dialog widget is not created by this constructor. Instead, you should create the dialog widget as a child of this dialog. QMotifDialog will take ownership of your custom dialog, and you can access it with the dialog() member function. -.PP -\fBWarning:\fR QMotifDialog takes ownership of the child widget and destroys it during destruction. You should not destroy the dialog widget yourself. -.PP -See also shell() and dialog(). -.SH "QMotifDialog::QMotifDialog ( Widget parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" -Creates a QMotifDialog which allows the application programmer to use the Motif-based \fIparent\fR for a custom QDialog. The \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. -.PP -This constructor creates a \fCShell\fR widget, which is a special subclass of \fCXmDialogShell\fR. You can access the \fCShell\fR widget with the shell() member function. -.PP -See also shell(). -.SH "QMotifDialog::QMotifDialog ( QWidget * parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" -Creates a QMotifDialog which allows the application programmer to use a QWidget parent for an existing Motif-based dialog. The \fIparent\fR, \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. -.PP -This constructor creates a \fCShell\fR widget, which is a special subclass of \fCXmDialogShell\fR. You can access the \fCShell\fR widget with the shell() member functon. -.PP -A dialog widget is not created by this constructor. Instead, you should create the dialog widget as a child of this dialog. QMotifDialog will take ownership of your custom dialog, and you can access it with the dialog() member function. -.PP -\fBWarning:\fR QMotifDialog takes ownership of the child widget and destroys it during destruction. You should not destroy the dialog widget yourself. -.PP -See also shell() and dialog(). -.SH "QMotifDialog::~QMotifDialog ()\fC [virtual]\fR" -Destroys the QDialog, dialog widget and \fCShell\fR widget. -.SH "void QMotifDialog::acceptCallback ( Widget, XtPointer client_data, XtPointer )\fC [static]\fR" -Convenient Xt/Motif callback to accept the QMotifDialog. -.PP -The data is passed in \fIclient_data\fR. -.SH "Widget QMotifDialog::dialog () const" -Returns the Motif widget embedded in this dialog. -.SH "void QMotifDialog::rejectCallback ( Widget, XtPointer client_data, XtPointer )\fC [static]\fR" -Convenient Xt/Motif callback to reject the QMotifDialog. -.PP -The data is passed in \fIclient_data\fR. -.SH "Widget QMotifDialog::shell () const" -Returns the \fCShell\fR widget embedded in this dialog. -.PP -Example: dialog/mainwindow.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmotifdialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmotifdialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmotifplusstyle.3qt b/doc/man/man3/qmotifplusstyle.3qt deleted file mode 100644 index 09f5ee9f1..000000000 --- a/doc/man/man3/qmotifplusstyle.3qt +++ /dev/null @@ -1,59 +0,0 @@ -'\" t -.TH QMotifPlusStyle 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 -QMotifPlusStyle \- More sophisticated Motif-ish look and feel -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QMotifStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMotifPlusStyle\fR ( bool hoveringHighlight = TRUE )" -.br -.in -1c -.SH DESCRIPTION -The QMotifPlusStyle class provides a more sophisticated Motif-ish look and feel. -.PP -This class implements a Motif-ish look and feel with the more sophisticated bevelling as used by the GIMP Toolkit (GTK+) for Unix/X11. -.PP -See also Widget Appearance and Style. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMotifPlusStyle::QMotifPlusStyle ( bool hoveringHighlight = TRUE )" -Constructs a QMotifPlusStyle -.PP -If \fIhoveringHighlight\fR is TRUE (the default), then the style will -not highlight push buttons, checkboxes, radiobuttons, comboboxes, -scrollbars or sliders. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmotifplusstyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmotifplusstyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmotifstyle.3qt b/doc/man/man3/qmotifstyle.3qt deleted file mode 100644 index 42b15a3c3..000000000 --- a/doc/man/man3/qmotifstyle.3qt +++ /dev/null @@ -1,76 +0,0 @@ -'\" t -.TH QMotifStyle 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 -QMotifStyle \- Motif look and feel -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QCommonStyle. -.PP -Inherited by QCDEStyle, QMotifPlusStyle, and QSGIStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMotifStyle\fR ( bool useHighlightCols = FALSE )" -.br -.ti -1c -.BI "void \fBsetUseHighlightColors\fR ( bool arg )" -.br -.ti -1c -.BI "bool \fBuseHighlightColors\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QMotifStyle class provides Motif look and feel. -.PP -This class implements the Motif look and feel. It closely resembles the original Motif look as defined by the Open Group, but with some minor improvements. The Motif style is Qt's default GUI style on UNIX platforms. -.PP -See also Widget Appearance and Style. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMotifStyle::QMotifStyle ( bool useHighlightCols = FALSE )" -Constructs a QMotifStyle. -.PP -If \fIuseHighlightCols\fR is FALSE (the default), the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. -.SH "void QMotifStyle::setUseHighlightColors ( bool arg )" -If \fIarg\fR is FALSE, the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. -.PP -The effect will show up the next time an application palette is set via QApplication::setPalette(). The current color palette of the application remains unchanged. -.PP -See also QStyle::polish(). -.SH "bool QMotifStyle::useHighlightColors () const" -Returns TRUE if the style treats the highlight colors of the -palette in a Motif-like manner, which is a simple inversion -between the base and the text color; otherwise returns FALSE. The -default is FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmotifstyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmotifstyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmotifwidget.3qt b/doc/man/man3/qmotifwidget.3qt deleted file mode 100644 index 0249dfd36..000000000 --- a/doc/man/man3/qmotifwidget.3qt +++ /dev/null @@ -1,86 +0,0 @@ -'\" t -.TH QMotifWidget 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 -QMotifWidget \- The QWidget API for Xt/Motif widgets -.SH SYNOPSIS -This class is part of the \fBQt Motif Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMotifWidget\fR ( QWidget * parent, WidgetClass widgetclass, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, WFlags flags = 0 )" -.br -.ti -1c -.BI "virtual \fB~QMotifWidget\fR ()" -.br -.ti -1c -.BI "Widget \fBmotifWidget\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBx11Event\fR ( XEvent * event )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt Motif Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QMotifWidget class provides the QWidget API for Xt/Motif widgets. -.PP -QMotifWidget exists to provide a QWidget that can act as a parent for any Xt/Motif widget. Since the QMotifWidget is a proper QWidget, it can be used as a top-level widget (e.g. 0 parent) or as a child of any other QWidget. Note: Since QMotifWidget acts as a parent for Xt/Motif widgets, you should not create QWidgets with a QMotifWidget parent. -.PP -An Xt/Motif widget with a top-level QMotifWidget parent can begin using the standard Qt dialogs and custom QDialogs while keeping the main Xt/Motif interface of the application. Using a QMotifWidget as the parent for the various QDialogs will ensure that modality and stacking works properly throughout the entire application. -.PP -Applications moving to Qt may have custom Xt/Motif widgets that will take time to rewrite with Qt. Such applications can use these custom widgets as QMotifWidget with QWidget parents. This allows the application's interface to be replaced gradually. -.PP -\fBWarning:\fR QMotifWidget uses the X11 window ID of the Motif widget directly, instead of creating its own. Because ot this, QWidget::reparent() will not work. This includes the functions QWidget::showFullScreen() and QWidget::showNormal(), which use QWidget::reparent(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMotifWidget::QMotifWidget ( QWidget * parent, WidgetClass widgetclass, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, WFlags flags = 0 )" -Creates a QMotifWidget of the given \fIwidgetclass\fR as a child of \fIparent\fR, with the name \fIname\fR and widget flags \fIflags\fR. -.PP -The \fIargs\fR and \fIargcount\fR arguments are passed on to XtCreateWidget. -.PP -The motifWidget() function returns the resulting Xt/Motif widget. This widget can be used as a parent for any other Xt/Motif widget. -.PP -If \fIparent\fR is a QMotifWidget, the Xt/Motif widget is created as a child of the parent's motifWidget(). If \ parent is 0 or a normal QWidget, the Xt/Motif widget is created as a child of a special TopLevelShell widget. Xt/Motif widgets can use this special TopLevelShell parent as the parent for existing Xt/Motif dialogs or QMotifDialogs. -.SH "QMotifWidget::~QMotifWidget ()\fC [virtual]\fR" -Destroys the QMotifWidget. The special TopLevelShell is also destroyed, if it was created during construction. -.SH "Widget QMotifWidget::motifWidget () const" -Returns the embedded Xt/Motif widget. If a Shell widget was -created by the constructor, you can access it with XtParent(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmotifwidget.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmotifwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmousedriverfactory.3qt b/doc/man/man3/qmousedriverfactory.3qt deleted file mode 100644 index 0efcc3f8a..000000000 --- a/doc/man/man3/qmousedriverfactory.3qt +++ /dev/null @@ -1,59 +0,0 @@ -'\" t -.TH QMouseDriverFactory 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 -QMouseDriverFactory \- Creates QWSMouseHandler objects for Qt/Embedded -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Static Public Members" -
                                    1. QStringList \fBkeys\fR ()
                                    2. QWSMouseHandler * \fBcreate\fR ( const QString & key, const QString & device ) -.SH DESCRIPTION -The QMouseDriverFactory class creates QWSMouseHandler objects for Qt/Embedded. -.PP -The graphics driver factory creates a QWSMouseHandler object for a given key with QMouseDriverFactory::create(key). -.PP -The drivers are either built-in or dynamically loaded from a driver plugin (see QMouseDriverPlugin). -.PP -This class is only available in Qt/Embedded. -.PP -QMouseDriverFactory::keys() returns a list of valid keys. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSMouseHandler * QMouseDriverFactory::create ( const QString & key, const QString & device )\fC [static]\fR" -Creates a QWSMouseHandler object that matches \fIkey\fR and uses device \fIdevice\fR. This is either a built-in driver, or a driver from a driver plugin. -.PP -See also keys(). -.SH "QStringList QMouseDriverFactory::keys ()\fC [static]\fR" -Returns the list of keys this factory can create drivers for. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmousedriverfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmousedriverfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmousedriverplugin.3qt b/doc/man/man3/qmousedriverplugin.3qt deleted file mode 100644 index ad2e3c5a1..000000000 --- a/doc/man/man3/qmousedriverplugin.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QMouseDriverPlugin 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 -QMouseDriverPlugin \- Abstract base for Qt/Embedded mouse driver plugins -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMouseDriverPlugin\fR ()" -.br -.ti -1c -.BI "\fB~QMouseDriverPlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBkeys\fR () const = 0" -.br -.ti -1c -.BI "virtual QWSMouseHandler * \fBcreate\fR ( const QString & driver, const QString & device ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QMouseDriverPlugin class provides an abstract base for Qt/Embedded mouse driver plugins. -.PP -The mouse driver plugin is a simple plugin interface that makes it easy to create custom mouse drivers. -.PP -Writing a mouse driver plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Plugins documentation for details. -.PP -This class is only available in Qt/Embedded. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMouseDriverPlugin::QMouseDriverPlugin ()" -Constructs a mouse driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. -.SH "QMouseDriverPlugin::~QMouseDriverPlugin ()" -Destroys the mouse driver plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "QWSMouseHandler * QMouseDriverPlugin::create ( const QString & driver, const QString & device )\fC [pure virtual]\fR" -Creates a driver matching the type specified by \fIdriver\fR and which uses device \fIdevice\fR. -.PP -See also keys(). -.SH "QStringList QMouseDriverPlugin::keys () const\fC [pure virtual]\fR" -Returns the list of mouse drivers this plugin supports. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmousedriverplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmousedriverplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmouseevent.3qt b/doc/man/man3/qmouseevent.3qt deleted file mode 100644 index a97241ca1..000000000 --- a/doc/man/man3/qmouseevent.3qt +++ /dev/null @@ -1,199 +0,0 @@ -'\" t -.TH QMouseEvent 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 -QMouseEvent \- Parameters that describe a mouse event -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMouseEvent\fR ( Type type, const QPoint & pos, int button, int state )" -.br -.ti -1c -.BI "\fBQMouseEvent\fR ( Type type, const QPoint & pos, const QPoint & globalPos, int button, int state )" -.br -.ti -1c -.BI "const QPoint & \fBpos\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBglobalPos\fR () const" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "int \fBglobalX\fR () const" -.br -.ti -1c -.BI "int \fBglobalY\fR () const" -.br -.ti -1c -.BI "ButtonState \fBbutton\fR () const" -.br -.ti -1c -.BI "ButtonState \fBstate\fR () const" -.br -.ti -1c -.BI "ButtonState \fBstateAfter\fR () const" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QMouseEvent class contains parameters that describe a mouse event. -.PP -Mouse events occur when a mouse button is pressed or released inside a widget or when the mouse cursor is moved. -.PP -Mouse move events will occur only when a mouse button is pressed down, unless mouse tracking has been enabled with QWidget::setMouseTracking(). -.PP -Qt automatically grabs the mouse when a mouse button is pressed inside a widget; the widget will continue to receive mouse events until the last mouse button is released. -.PP -A mouse event contains a special accept flag that indicates whether the receiver wants the event. You should call QMouseEvent::ignore() if the mouse event is not handled by your widget. A mouse event is propagated up the parent widget chain until a widget accepts it with QMouseEvent::accept() or an event filter consumes it. -.PP -The functions pos(), x() and y() give the cursor position relative to the widget that receives the mouse event. If you move the widget as a result of the mouse event, use the global position returned by globalPos() to avoid a shaking motion. -.PP -The QWidget::setEnabled() function can be used to enable or disable mouse and keyboard events for a widget. -.PP -The event handlers QWidget::mousePressEvent(), QWidget::mouseReleaseEvent(), QWidget::mouseDoubleClickEvent() and QWidget::mouseMoveEvent() receive mouse events. -.PP -See also QWidget::mouseTracking, QWidget::grabMouse(), QCursor::pos(), and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMouseEvent::QMouseEvent ( Type type, const QPoint & pos, int button, int state )" -Constructs a mouse event object. -.PP -The \fItype\fR parameter must be one of QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick or QEvent::MouseMove. -.PP -The \fIpos\fR parameter specifies the position relative to the receiving widget. \fIbutton\fR specifies the button that caused the event, which should be Qt::NoButton (0), if \fItype\fR is MouseMove. \fIstate\fR is the ButtonState at the time of the event. -.PP -The globalPos() is initialized to QCursor::pos(), which may not be appropriate. Use the other constructor to specify the global position explicitly. -.SH "QMouseEvent::QMouseEvent ( Type type, const QPoint & pos, const QPoint & globalPos, int button, int state )" -Constructs a mouse event object. -.PP -The \fItype\fR parameter must be QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick or QEvent::MouseMove. -.PP -The \fIpos\fR parameter specifies the position relative to the receiving widget. \fIglobalPos\fR is the position in absolute coordinates. \fIbutton\fR specifies the button that caused the event, which should be Qt::NoButton (0), if \fItype\fR is MouseMove. \fIstate\fR is the ButtonState at the time of the event. -.SH "void QMouseEvent::accept ()" -Sets the accept flag of the mouse event object. -.PP -Setting the accept parameter indicates that the receiver of the event wants the mouse event. Unwanted mouse events are sent to the parent widget. -.PP -The accept flag is set by default. -.PP -See also ignore(). -.SH "ButtonState QMouseEvent::button () const" -Returns the button that caused the event. -.PP -Possible return values are LeftButton, RightButton, MidButton and NoButton. -.PP -Note that the returned value is always NoButton for mouse move events. -.PP -See also state() and Qt::ButtonState. -.PP -Examples: -.)l dclock/dclock.cpp, life/life.cpp, and t14/cannon.cpp. -.SH "const QPoint & QMouseEvent::globalPos () const" -Returns the global position of the mouse pointer \fIat the time of the event\fR. This is important on asynchronous window systems like X11. Whenever you move your widgets around in response to mouse events, globalPos() may differ a lot from the current pointer position QCursor::pos(), and from QWidget::mapToGlobal( pos() ). -.PP -See also globalX() and globalY(). -.PP -Example: aclock/aclock.cpp. -.SH "int QMouseEvent::globalX () const" -Returns the global x-position of the mouse pointer at the time of the event. -.PP -See also globalY() and globalPos(). -.SH "int QMouseEvent::globalY () const" -Returns the global y-position of the mouse pointer at the time of the event. -.PP -See also globalX() and globalPos(). -.SH "void QMouseEvent::ignore ()" -Clears the accept flag parameter of the mouse event object. -.PP -Clearing the accept parameter indicates that the event receiver does not want the mouse event. Unwanted mouse events are sent to the parent widget. -.PP -The accept flag is set by default. -.PP -See also accept(). -.SH "bool QMouseEvent::isAccepted () const" -Returns TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE. -.SH "const QPoint & QMouseEvent::pos () const" -Returns the position of the mouse pointer relative to the widget that received the event. -.PP -If you move the widget as a result of the mouse event, use the global position returned by globalPos() to avoid a shaking motion. -.PP -See also x(), y(), and globalPos(). -.PP -Examples: -.)l chart/canvasview.cpp, drawlines/connect.cpp, life/life.cpp, popup/popup.cpp, qmag/qmag.cpp, t14/cannon.cpp, and tooltip/tooltip.cpp. -.SH "ButtonState QMouseEvent::state () const" -Returns the button state (a combination of mouse buttons and keyboard modifiers), i.e. what buttons and keys were being pressed immediately before the event was generated. -.PP -This means that if you have a QEvent::MouseButtonPress or a QEvent::MouseButtonDblClick state() will \fInot\fR include the mouse button that's pressed. But once the mouse button has been released, the QEvent::MouseButtonRelease event will have the button() that was pressed. -.PP -This value is mainly interesting for QEvent::MouseMove; for the other cases, button() is more useful. -.PP -The returned value is LeftButton, RightButton, MidButton, ShiftButton, ControlButton and AltButton OR'ed together. -.PP -See also button(), stateAfter(), and Qt::ButtonState. -.PP -Examples: -.)l popup/popup.cpp and showimg/showimg.cpp. -.SH "ButtonState QMouseEvent::stateAfter () const" -Returns the state of buttons after the event. -.PP -See also state() and Qt::ButtonState. -.SH "int QMouseEvent::x () const" -Returns the x-position of the mouse pointer, relative to the widget that received the event. -.PP -See also y() and pos(). -.PP -Example: showimg/showimg.cpp. -.SH "int QMouseEvent::y () const" -Returns the y-position of the mouse pointer, relative to the widget that received the event. -.PP -See also x() and pos(). -.PP -Example: showimg/showimg.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmouseevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmouseevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmoveevent.3qt b/doc/man/man3/qmoveevent.3qt deleted file mode 100644 index a98c6072a..000000000 --- a/doc/man/man3/qmoveevent.3qt +++ /dev/null @@ -1,68 +0,0 @@ -'\" t -.TH QMoveEvent 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 -QMoveEvent \- Event parameters for move events -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMoveEvent\fR ( const QPoint & pos, const QPoint & oldPos )" -.br -.ti -1c -.BI "const QPoint & \fBpos\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBoldPos\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QMoveEvent class contains event parameters for move events. -.PP -Move events are sent to widgets that have been moved to a new position relative to their parent. -.PP -The event handler QWidget::moveEvent() receives move events. -.PP -See also QWidget::pos, QWidget::geometry, and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMoveEvent::QMoveEvent ( const QPoint & pos, const QPoint & oldPos )" -Constructs a move event with the new and old widget positions, \fIpos\fR and \fIoldPos\fR respectively. -.SH "const QPoint & QMoveEvent::oldPos () const" -Returns the old position of the widget. -.SH "const QPoint & QMoveEvent::pos () const" -Returns the new position of the widget. This excludes the window -frame for top level widgets. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmoveevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmoveevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmovie.3qt b/doc/man/man3/qmovie.3qt deleted file mode 100644 index 40db5245e..000000000 --- a/doc/man/man3/qmovie.3qt +++ /dev/null @@ -1,322 +0,0 @@ -'\" t -.TH QMovie 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 -QMovie \- Incremental loading of animations or images, signalling as it progresses -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMovie\fR ()" -.br -.ti -1c -.BI "\fBQMovie\fR ( int bufsize )" -.br -.ti -1c -.BI "\fBQMovie\fR ( QDataSource * src, int bufsize = 1024 )" -.br -.ti -1c -.BI "\fBQMovie\fR ( const QString & fileName, int bufsize = 1024 )" -.br -.ti -1c -.BI "\fBQMovie\fR ( QByteArray data, int bufsize = 1024 )" -.br -.ti -1c -.BI "\fBQMovie\fR ( const QMovie & movie )" -.br -.ti -1c -.BI "\fB~QMovie\fR ()" -.br -.ti -1c -.BI "QMovie & \fBoperator=\fR ( const QMovie & movie )" -.br -.ti -1c -.BI "int \fBpushSpace\fR () const" -.br -.ti -1c -.BI "void \fBpushData\fR ( const uchar * data, int length )" -.br -.ti -1c -.BI "const QColor & \fBbackgroundColor\fR () const" -.br -.ti -1c -.BI "void \fBsetBackgroundColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "const QRect & \fBgetValidRect\fR () const" -.br -.ti -1c -.BI "const QPixmap & \fBframePixmap\fR () const" -.br -.ti -1c -.BI "const QImage & \fBframeImage\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "int \fBframeNumber\fR () const" -.br -.ti -1c -.BI "int \fBsteps\fR () const" -.br -.ti -1c -.BI "bool \fBpaused\fR () const" -.br -.ti -1c -.BI "bool \fBfinished\fR () const" -.br -.ti -1c -.BI "bool \fBrunning\fR () const" -.br -.ti -1c -.BI "void \fBunpause\fR ()" -.br -.ti -1c -.BI "void \fBpause\fR ()" -.br -.ti -1c -.BI "void \fBstep\fR ()" -.br -.ti -1c -.BI "void \fBstep\fR ( int steps )" -.br -.ti -1c -.BI "void \fBrestart\fR ()" -.br -.ti -1c -.BI "int \fBspeed\fR () const" -.br -.ti -1c -.BI "void \fBsetSpeed\fR ( int percent )" -.br -.ti -1c -.BI "void \fBconnectResize\fR ( QObject * receiver, const char * member )" -.br -.ti -1c -.BI "void \fBdisconnectResize\fR ( QObject * receiver, const char * member = 0 )" -.br -.ti -1c -.BI "void \fBconnectUpdate\fR ( QObject * receiver, const char * member )" -.br -.ti -1c -.BI "void \fBdisconnectUpdate\fR ( QObject * receiver, const char * member = 0 )" -.br -.ti -1c -.BI "enum \fBStatus\fR { SourceEmpty = -2, UnrecognizedFormat = -1, Paused = 1, EndOfFrame = 2, EndOfLoop = 3, EndOfMovie = 4, SpeedChanged = 5 }" -.br -.ti -1c -.BI "void \fBconnectStatus\fR ( QObject * receiver, const char * member )" -.br -.ti -1c -.BI "void \fBdisconnectStatus\fR ( QObject * receiver, const char * member = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QMovie class provides incremental loading of animations or images, signalling as it progresses. -.PP -The simplest way to display a QMovie is to use a QLabel and QLabel::setMovie(). -.PP -A QMovie provides a QPixmap as the framePixmap(); connections can be made via connectResize() and connectUpdate() to receive notification of size and pixmap changes. All decoding is driven by the normal event-processing mechanisms. -.PP -The movie begins playing as soon as the QMovie is created (actually, once control returns to the event loop). When the last frame in the movie has been played, it may loop back to the start if such looping is defined in the input source. -.PP -QMovie objects are explicitly shared. This means that a QMovie copied from another QMovie will be displaying the same frame at all times. If one shared movie pauses, all pause. To make \fIindependent\fR movies, they must be constructed separately. -.PP -The set of data formats supported by QMovie is determined by the decoder factories that have been installed; the format of the input is determined as the input is decoded. -.PP -The supported formats are MNG (if Qt is configured with MNG support enabled) and GIF (if Qt is configured with GIF support enabled, see ntqgif.h). -.PP -If Qt is configured to support GIF reading, we are required to state that "The Graphics Interchange Format(c) is the Copyright property of CompuServe Incorporated. GIF(sm) is a Service Mark property of CompuServe Incorporated. -.PP -\fBWarning:\fR If you are in a country that recognizes software patents and in which Unisys holds a patent on LZW compression and/or decompression and you want to use GIF, Unisys may require you to license that technology. Such countries include Canada, Japan, the USA, France, Germany, Italy and the UK. -.PP -GIF support may be removed completely in a future version of Qt. We recommend using the MNG or PNG format. -.PP -
                                      -.ce 1 -.B "[Image Omitted]" -.PP -
                                      -.PP -See also QLabel::setMovie(), Graphics Classes, Image Processing Classes, and Multimedia Classes. -.SS "Member Type Documentation" -.SH "QMovie::Status" -.TP -\fCQMovie::SourceEmpty\fR -.TP -\fCQMovie::UnrecognizedFormat\fR -.TP -\fCQMovie::Paused\fR -.TP -\fCQMovie::EndOfFrame\fR -.TP -\fCQMovie::EndOfLoop\fR -.TP -\fCQMovie::EndOfMovie\fR -.TP -\fCQMovie::SpeedChanged\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMovie::QMovie ()" -Constructs a null QMovie. The only interesting thing to do with such a movie is to assign another movie to it. -.PP -See also isNull(). -.SH "QMovie::QMovie ( int bufsize )" -Constructs a QMovie with an external data source. You should later call pushData() to send incoming animation data to the movie. -.PP -The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. -.PP -See also pushData(). -.SH "QMovie::QMovie ( QDataSource * src, int bufsize = 1024 )" -Constructs a QMovie that reads an image sequence from the given data source, \fIsrc\fR. The source must be allocated dynamically, because QMovie will take ownership of it and will destroy it when the movie is destroyed. The movie starts playing as soon as event processing continues. -.PP -The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. -.SH "QMovie::QMovie ( const QString & fileName, int bufsize = 1024 )" -Constructs a QMovie that reads an image sequence from the file, \fIfileName\fR. -.PP -The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. -.SH "QMovie::QMovie ( QByteArray data, int bufsize = 1024 )" -Constructs a QMovie that reads an image sequence from the byte array, \fIdata\fR. -.PP -The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. -.SH "QMovie::QMovie ( const QMovie & movie )" -Constructs a movie that uses the same data as movie \fImovie\fR. QMovies use explicit sharing, so operations on the copy will affect both. -.SH "QMovie::~QMovie ()" -Destroys the QMovie. If this is the last reference to the data of the movie, the data is deallocated. -.SH "const QColor & QMovie::backgroundColor () const" -Returns the background color of the movie set by setBackgroundColor(). -.SH "void QMovie::connectResize ( QObject * receiver, const char * member )" -Connects the \fIreceiver\fR's \fImember\fR of type \fCvoid member(const QSize&)\fR so that it is signalled when the movie changes size. -.PP -Note that due to the explicit sharing of QMovie objects, these connections persist until they are explicitly disconnected with disconnectResize() or until \fIevery\fR shared copy of the movie is deleted. -.PP -Example: movies/main.cpp. -.SH "void QMovie::connectStatus ( QObject * receiver, const char * member )" -Connects the \fIreceiver\fR's \fImember\fR, of type \fCvoid member(int)\fR so that it is signalled when the movie changes status. The status codes are negative for errors and positive for information. -.PP -
                                      .nf -.TS -l - l. Status Code Meaning QMovie::SourceEmpty signalled if the input cannot be read. QMovie::UnrecognizedFormat signalled if the input data is unrecognized. QMovie::Paused signalled when the movie is paused by a call to paused() or by after stepping pauses. QMovie::EndOfFrame signalled at end-of-frame after any update and Paused signals. QMovie::EndOfLoop signalled at end-of-loop, after any update signals, EndOfFrame - but before EndOfMovie. QMovie::EndOfMovie -.TE -.fi -
                                      -.PP -More status messages may be added in the future, so a general test for errors would test for negative. -.PP -Note that due to the explicit sharing of QMovie objects, these connections persist until they are explicitly disconnected with disconnectStatus() or until \fIevery\fR shared copy of the movie is deleted. -.PP -Example: movies/main.cpp. -.SH "void QMovie::connectUpdate ( QObject * receiver, const char * member )" -Connects the \fIreceiver\fR's \fImember\fR of type \fCvoid member(const QRect&)\fR so that it is signalled when an area of the framePixmap() has changed since the previous frame. -.PP -Note that due to the explicit sharing of QMovie objects, these connections persist until they are explicitly disconnected with disconnectUpdate() or until \fIevery\fR shared copy of the movie is deleted. -.PP -Example: movies/main.cpp. -.SH "void QMovie::disconnectResize ( QObject * receiver, const char * member = 0 )" -Disconnects the \fIreceiver\fR's \fImember\fR (or all members if \fImember\fR is zero) that were previously connected by connectResize(). -.SH "void QMovie::disconnectStatus ( QObject * receiver, const char * member = 0 )" -Disconnects the \fIreceiver\fR's \fImember\fR (or all members if \fImember\fR is zero) that were previously connected by connectStatus(). -.SH "void QMovie::disconnectUpdate ( QObject * receiver, const char * member = 0 )" -Disconnects the \fIreceiver\fR's \fImember\fR (or all members if \\q member is zero) that were previously connected by connectUpdate(). -.SH "bool QMovie::finished () const" -Returns TRUE if the image is no longer playing: this happens when all loops of all frames are complete; otherwise returns FALSE. -.PP -Example: movies/main.cpp. -.SH "const QImage & QMovie::frameImage () const" -Returns the current frame of the movie, as a QImage. It is not generally useful to keep a copy of this image. Also note that you must not call this function if the movie is finished(), since by then the image will not be available. -.PP -See also framePixmap(). -.SH "int QMovie::frameNumber () const" -Returns the number of times EndOfFrame has been emitted since the start of the current loop of the movie. Thus, before any EndOfFrame has been emitted the value will be 0; within slots processing the first signal, frameNumber() will be 1, and so on. -.SH "const QPixmap & QMovie::framePixmap () const" -Returns the current frame of the movie, as a QPixmap. It is not generally useful to keep a copy of this pixmap. It is better to keep a copy of the QMovie and get the framePixmap() only when needed for drawing. -.PP -See also frameImage(). -.PP -Example: movies/main.cpp. -.SH "const QRect & QMovie::getValidRect () const" -Returns the area of the pixmap for which pixels have been generated. -.SH "bool QMovie::isNull () const" -Returns TRUE if the movie is null; otherwise returns FALSE. -.SH "QMovie & QMovie::operator= ( const QMovie & movie )" -Makes this movie use the same data as movie \fImovie\fR. QMovies use explicit sharing. -.SH "void QMovie::pause ()" -Pauses the progress of the animation. -.PP -See also unpause(). -.PP -Example: movies/main.cpp. -.SH "bool QMovie::paused () const" -Returns TRUE if the image is paused; otherwise returns FALSE. -.PP -Example: movies/main.cpp. -.SH "void QMovie::pushData ( const uchar * data, int length )" -Pushes \fIlength\fR bytes from \fIdata\fR into the movie. \fIlength\fR must be no more than the amount returned by pushSpace() since the previous call to pushData(). -.SH "int QMovie::pushSpace () const" -Returns the maximum amount of data that can currently be pushed into the movie by a call to pushData(). This is affected by the initial buffer size, but varies as the movie plays and data is consumed. -.SH "void QMovie::restart ()" -Rewinds the movie to the beginning. If the movie has not been paused, it begins playing again. -.PP -Example: movies/main.cpp. -.SH "bool QMovie::running () const" -Returns TRUE if the image is not single-stepping, not paused, and not finished; otherwise returns FALSE. -.SH "void QMovie::setBackgroundColor ( const QColor & c )" -Sets the background color of the pixmap to \fIc\fR. If the background color isValid(), the pixmap will never have a mask because the background color will be used in transparent regions of the image. -.PP -See also backgroundColor(). -.SH "void QMovie::setSpeed ( int percent )" -Sets the movie's play speed as a percentage, to \fIpercent\fR. This is a percentage of the speed dictated by the input data format. The default is 100 percent. -.SH "int QMovie::speed () const" -Returns the movie's play speed as a percentage. The default is 100 percent. -.PP -See also setSpeed(). -.SH "void QMovie::step ()" -Steps forward 1 frame and then pauses. -.PP -Example: movies/main.cpp. -.SH "void QMovie::step ( int steps )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Steps forward, showing \fIsteps\fR frames, and then pauses. -.SH "int QMovie::steps () const" -Returns the number of steps remaining after a call to step(). If the movie is paused, steps() returns 0. If it's running normally or is finished, steps() returns a negative number. -.PP -Example: movies/main.cpp. -.SH "void QMovie::unpause ()" -Unpauses the progress of the animation. -.PP -See also pause(). -.PP -Example: movies/main.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmovie.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmovie.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmutex.3qt b/doc/man/man3/qmutex.3qt deleted file mode 100644 index b4693110d..000000000 --- a/doc/man/man3/qmutex.3qt +++ /dev/null @@ -1,213 +0,0 @@ -'\" t -.TH QMutex 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 -QMutex \- Access serialization between threads -.SH SYNOPSIS -All the functions in this class are thread-safe when Qt is built with thread support.

                                      -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMutex\fR ( bool recursive = FALSE )" -.br -.ti -1c -.BI "virtual \fB~QMutex\fR ()" -.br -.ti -1c -.BI "void \fBlock\fR ()" -.br -.ti -1c -.BI "void \fBunlock\fR ()" -.br -.ti -1c -.BI "bool \fBlocked\fR ()" -.br -.ti -1c -.BI "bool \fBtryLock\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QMutex class provides access serialization between threads. -.PP -The purpose of a QMutex is to protect an object, data structure or section of code so that only one thread can access it at a time (This is similar to the Java \fCsynchronized\fR keyword). For example, say there is a method which prints a message to the user on two lines: -.PP -.nf -.br - int number = 6; -.br -.br - void method1() -.br - { -.br - number *= 5; -.br - number /= 4; -.br - } -.br -.br - void method2() -.br - { -.br - number *= 3; -.br - number /= 2; -.br - } -.br -.fi -.PP -If these two methods are called in succession, the following happens: -.PP -.nf -.br - // method1() -.br - number *= 5; // number is now 30 -.br - number /= 4; // number is now 7 -.br -.br - // method2() -.br - number *= 3; // nubmer is now 21 -.br - number /= 2; // number is now 10 -.br -.fi -.PP -If these two methods are called simultaneously from two threads then the following sequence could result: -.PP -.nf -.br - // Thread 1 calls method1() -.br - number *= 5; // number is now 30 -.br -.br - // Thread 2 calls method2(). -.br - // -.br - // Most likely Thread 1 has been put to sleep by the operating -.br - // system to allow Thread 2 to run. -.br - number *= 3; // number is now 90 -.br - number /= 2; // number is now 45 -.br -.br - // Thread 1 finishes executing. -.br - number /= 4; // number is now 11, instead of 10 -.br -.fi -.PP -If we add a mutex, we should get the result we want: -.PP -.nf -.br - QMutex mutex; -.br - int number = 6; -.br -.br - void method1() -.br - { -.br - mutex.lock(); -.br - number *= 5; -.br - number /= 4; -.br - mutex.unlock(); -.br - } -.br -.br - void method2() -.br - { -.br - mutex.lock(); -.br - number *= 3; -.br - number /= 2; -.br - mutex.unlock(); -.br - } -.br -.fi -.PP -Then only one thread can modify \fCnumber\fR at any given time and the result is correct. This is a trivial example, of course, but applies to any other case where things need to happen in a particular sequence. -.PP -When you call lock() in a thread, other threads that try to call lock() in the same place will block until the thread that got the lock calls unlock(). A non-blocking alternative to lock() is tryLock(). -.PP -See also Environment Classes and Threading. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMutex::QMutex ( bool recursive = FALSE )" -Constructs a new mutex. The mutex is created in an unlocked state. A recursive mutex is created if \fIrecursive\fR is TRUE; a normal mutex is created if \fIrecursive\fR is FALSE (the default). With a recursive mutex, a thread can lock the same mutex multiple times and it will not be unlocked until a corresponding number of unlock() calls have been made. -.SH "QMutex::~QMutex ()\fC [virtual]\fR" -Destroys the mutex. -.PP -\fBWarning:\fR If you destroy a mutex that still holds a lock the resultant behavior is undefined. -.SH "void QMutex::lock ()" -Attempt to lock the mutex. If another thread has locked the mutex then this call will \fIblock\fR until that thread has unlocked it. -.PP -See also unlock() and locked(). -.SH "bool QMutex::locked ()" -Returns TRUE if the mutex is locked by another thread; otherwise returns FALSE. -.PP -\fBWarning:\fR Due to differing implementations of recursive mutexes on various platforms, calling this function from the same thread that previously locked the mutex will return undefined results. -.PP -See also lock() and unlock(). -.SH "bool QMutex::tryLock ()" -Attempt to lock the mutex. If the lock was obtained, this function returns TRUE. If another thread has locked the mutex, this function returns FALSE, instead of waiting for the mutex to become available, i.e. it does not block. -.PP -If the lock was obtained, the mutex must be unlocked with unlock() before another thread can successfully lock it. -.PP -See also lock(), unlock(), and locked(). -.SH "void QMutex::unlock ()" -Unlocks the mutex. Attempting to unlock a mutex in a different thread to the one that locked it results in an error. Unlocking a mutex that is not locked results in undefined behaviour (varies between different Operating Systems' thread implementations). -.PP -See also lock() and locked(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqmutex.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmutex.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qmutexlocker.3qt b/doc/man/man3/qmutexlocker.3qt deleted file mode 100644 index cff0f062f..000000000 --- a/doc/man/man3/qmutexlocker.3qt +++ /dev/null @@ -1,273 +0,0 @@ -'\" t -.TH QMutexLocker 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 -QMutexLocker \- Simplifies locking and unlocking QMutexes -.SH SYNOPSIS -All the functions in this class are thread-safe when Qt is built with thread support.

                                      -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQMutexLocker\fR ( QMutex * mutex )" -.br -.ti -1c -.BI "\fB~QMutexLocker\fR ()" -.br -.ti -1c -.BI "QMutex * \fBmutex\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QMutexLocker class simplifies locking and unlocking QMutexes. -.PP -The purpose of QMutexLocker is to simplify QMutex locking and unlocking. Locking and unlocking a QMutex in complex functions and statements or in exception handling code is error prone and difficult to debug. QMutexLocker should be used in such situations to ensure that the state of the mutex is well defined and always locked and unlocked properly. -.PP -QMutexLocker should be created within a function where a QMutex needs to be locked. The mutex is locked when QMutexLocker is created, and unlocked when QMutexLocker is destroyed. -.PP -For example, this complex function locks a QMutex upon entering the function and unlocks the mutex at all the exit points: -.PP -.nf -.br - int complexFunction( int flag ) -.br - { -.br - mutex.lock(); -.br -.br - int return_value = 0; -.br -.br - switch ( flag ) { -.br - case 0: -.br - case 1: -.br - { -.br - mutex.unlock(); -.br - return moreComplexFunction( flag ); -.br - } -.br -.br - case 2: -.br - { -.br - int status = anotherFunction(); -.br - if ( status < 0 ) { -.br - mutex.unlock(); -.br - return -2; -.br - } -.br - return_value = status + flag; -.br - break; -.br - } -.br -.br - default: -.br - { -.br - if ( flag > 10 ) { -.br - mutex.unlock(); -.br - return -1; -.br - } -.br - break; -.br - } -.br - } -.br -.br - mutex.unlock(); -.br - return return_value; -.br - } -.br -.fi -.PP -This example function will get more complicated as it is developed, which increases the likelihood that errors will occur. -.PP -Using QMutexLocker greatly simplifies the code, and makes it more readable: -.PP -.nf -.br - int complexFunction( int flag ) -.br - { -.br - QMutexLocker locker( &mutex ); -.br -.br - int return_value = 0; -.br -.br - switch ( flag ) { -.br - case 0: -.br - case 1: -.br - { -.br - return moreComplexFunction( flag ); -.br - } -.br -.br - case 2: -.br - { -.br - int status = anotherFunction(); -.br - if ( status < 0 ) -.br - return -2; -.br - return_value = status + flag; -.br - break; -.br - } -.br -.br - default: -.br - { -.br - if ( flag > 10 ) -.br - return -1; -.br - break; -.br - } -.br - } -.br -.br - return return_value; -.br - } -.br -.fi -.PP -Now, the mutex will always be unlocked when the QMutexLocker object is destroyed (when the function returns since \fClocker\fR is an auto variable). Note that the mutex will be unlocked after the call to moreComplexFunction() in this example, avoiding possible bugs caused by unlocking the mutex too early, as in the first example. -.PP -The same principle applies to code that throws and catches exceptions. An exception that is not caught in the function that has locked the mutex has no way of unlocking the mutex before the exception is passed up the stack to the calling function. -.PP -QMutexLocker also provides a mutex() member function that returns the mutex on which the QMutexLocker is operating. This is useful for code that needs access to the mutex, such as QWaitCondition::wait(). For example: -.PP -.nf -.br - class SignalWaiter -.br - { -.br - private: -.br - QMutexLocker locker; -.br -.br - public: -.br - SignalWaiter( QMutex *mutex ) -.br - : locker( mutex ) -.br - { -.br - } -.br -.br - void waitForSignal() -.br - { -.br - ... -.br - ... -.br - ... -.br -.br - while ( ! signalled ) -.br - waitcondition.wait( locker.mutex() ); -.br -.br - ... -.br - ... -.br - ... -.br - } -.br - }; -.br -.fi -.PP -See also QMutex, QWaitCondition, Environment Classes, and Threading. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QMutexLocker::QMutexLocker ( QMutex * mutex )" -Constructs a QMutexLocker and locks \fImutex\fR. The mutex will be unlocked when the QMutexLocker is destroyed. If \fImutex\fR is zero, QMutexLocker does nothing. -.PP -See also QMutex::lock(). -.SH "QMutexLocker::~QMutexLocker ()" -Destroys the QMutexLocker and unlocks the mutex which was locked in the constructor. -.PP -See also QMutexLocker::QMutexLocker() and QMutex::unlock(). -.SH "QMutex * QMutexLocker::mutex () const" -Returns a pointer to the mutex which was locked in the constructor. -.PP -See also QMutexLocker::QMutexLocker(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qmutexlocker.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qmutexlocker.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qnetworkoperation.3qt b/doc/man/man3/qnetworkoperation.3qt deleted file mode 100644 index 891803ac6..000000000 --- a/doc/man/man3/qnetworkoperation.3qt +++ /dev/null @@ -1,145 +0,0 @@ -'\" t -.TH QNetworkOperation 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 -QNetworkOperation \- Common operations for network protocols -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQNetworkOperation\fR ( QNetworkProtocol::Operation operation, const QString & arg0, const QString & arg1, const QString & arg2 )" -.br -.ti -1c -.BI "\fBQNetworkOperation\fR ( QNetworkProtocol::Operation operation, const QByteArray & arg0, const QByteArray & arg1, const QByteArray & arg2 )" -.br -.ti -1c -.BI "\fB~QNetworkOperation\fR ()" -.br -.ti -1c -.BI "void \fBsetState\fR ( QNetworkProtocol::State state )" -.br -.ti -1c -.BI "void \fBsetProtocolDetail\fR ( const QString & detail )" -.br -.ti -1c -.BI "void \fBsetErrorCode\fR ( int ec )" -.br -.ti -1c -.BI "void \fBsetArg\fR ( int num, const QString & arg )" -.br -.ti -1c -.BI "void \fBsetRawArg\fR ( int num, const QByteArray & arg )" -.br -.ti -1c -.BI "QNetworkProtocol::Operation \fBoperation\fR () const" -.br -.ti -1c -.BI "QNetworkProtocol::State \fBstate\fR () const" -.br -.ti -1c -.BI "QString \fBarg\fR ( int num ) const" -.br -.ti -1c -.BI "QByteArray \fBrawArg\fR ( int num ) const" -.br -.ti -1c -.BI "QString \fBprotocolDetail\fR () const" -.br -.ti -1c -.BI "int \fBerrorCode\fR () const" -.br -.ti -1c -.BI "void \fBfree\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QNetworkOperation class provides common operations for network protocols. -.PP -An object is created to describe the operation and the current state for each operation that a network protocol should process. -.PP -For a detailed description of the Qt Network Architecture and how to implement and use network protocols in Qt, see the Qt Network Documentation. -.PP -See also QNetworkProtocol and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QNetworkOperation::QNetworkOperation ( QNetworkProtocol::Operation operation, const QString & arg0, const QString & arg1, const QString & arg2 )" -Constructs a network operation object. \fIoperation\fR is the type of the operation, and \fIarg0\fR, \fIarg1\fR and \fIarg2\fR are the first three arguments of the operation. The state is initialized to QNetworkProtocol::StWaiting. -.PP -See also QNetworkProtocol::Operation and QNetworkProtocol::State. -.SH "QNetworkOperation::QNetworkOperation ( QNetworkProtocol::Operation operation, const QByteArray & arg0, const QByteArray & arg1, const QByteArray & arg2 )" -Constructs a network operation object. \fIoperation\fR is the type of the operation, and \fIarg0\fR, \fIarg1\fR and \fIarg2\fR are the first three raw data arguments of the operation. The state is initialized to QNetworkProtocol::StWaiting. -.PP -See also QNetworkProtocol::Operation and QNetworkProtocol::State. -.SH "QNetworkOperation::~QNetworkOperation ()" -Destructor. -.SH "QString QNetworkOperation::arg ( int num ) const" -Returns the operation's \fInum\fR-th argument. If this argument was not already set, an empty string is returned. -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "int QNetworkOperation::errorCode () const" -Returns the error code for the last error that occurred. -.SH "void QNetworkOperation::free ()" -Sets this object to delete itself when it hasn't been used for one second. -.PP -Because QNetworkOperation pointers are passed around a lot the QNetworkProtocol generally does not have enough knowledge to delete these at the correct time. If a QNetworkProtocol doesn't need an operation any more it will call this function instead. -.PP -Note: you should never need to call the method yourself. -.SH "QNetworkProtocol::Operation QNetworkOperation::operation () const" -Returns the type of the operation. -.SH "QString QNetworkOperation::protocolDetail () const" -Returns a detailed error message for the last error. This must have been set using setProtocolDetail(). -.SH "QByteArray QNetworkOperation::rawArg ( int num ) const" -Returns the operation's \fInum\fR-th raw data argument. If this argument was not already set, an empty bytearray is returned. -.SH "void QNetworkOperation::setArg ( int num, const QString & arg )" -Sets the network operation's \fInum\fR-th argument to \fIarg\fR. -.SH "void QNetworkOperation::setErrorCode ( int ec )" -Sets the error code to \fIec\fR. -.PP -If the operation failed, the protocol should set an error code to describe the error in more detail. If possible, one of the error codes defined in QNetworkProtocol should be used. -.PP -See also setProtocolDetail() and QNetworkProtocol::Error. -.SH "void QNetworkOperation::setProtocolDetail ( const QString & detail )" -If the operation failed, the error message can be specified as \fIdetail\fR. -.SH "void QNetworkOperation::setRawArg ( int num, const QByteArray & arg )" -Sets the network operation's \fInum\fR-th raw data argument to \fIarg\fR. -.SH "void QNetworkOperation::setState ( QNetworkProtocol::State state )" -Sets the \fIstate\fR of the operation object. This should be done by the network protocol during processing; at the end it should be set to QNetworkProtocol::StDone or QNetworkProtocol::StFailed, depending on success or failure. -.PP -See also QNetworkProtocol::State. -.SH "QNetworkProtocol::State QNetworkOperation::state () const" -Returns the state of the operation. You can determine whether an -operation is still waiting to be processed, is being processed, -has been processed successfully, or failed. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qnetworkoperation.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qnetworkoperation.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qnetworkprotocol.3qt b/doc/man/man3/qnetworkprotocol.3qt deleted file mode 100644 index 4f0e20805..000000000 --- a/doc/man/man3/qnetworkprotocol.3qt +++ /dev/null @@ -1,386 +0,0 @@ -'\" t -.TH QNetworkProtocol 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 -QNetworkProtocol \- Common API for network protocols -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -Inherited by QFtp, QHttp, and QLocalFs. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBState\fR { StWaiting = 0, StInProgress, StDone, StFailed, StStopped }" -.br -.ti -1c -.BI "enum \fBOperation\fR { OpListChildren = 1, OpMkDir = 2, OpMkdir = OpMkDir, OpRemove = 4, OpRename = 8, OpGet = 32, OpPut = 64 }" -.br -.ti -1c -.BI "enum \fBConnectionState\fR { ConHostFound, ConConnected, ConClosed }" -.br -.ti -1c -.BI "enum \fBError\fR { NoError = 0, ErrValid, ErrUnknownProtocol, ErrUnsupported, ErrParse, ErrLoginIncorrect, ErrHostNotFound, ErrListChildren, ErrListChlidren = ErrListChildren, ErrMkDir, ErrMkdir = ErrMkDir, ErrRemove, ErrRename, ErrGet, ErrPut, ErrFileNotExisting, ErrPermissionDenied }" -.br -.ti -1c -.BI "\fBQNetworkProtocol\fR ()" -.br -.ti -1c -.BI "virtual \fB~QNetworkProtocol\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetUrl\fR ( QUrlOperator * u )" -.br -.ti -1c -.BI "virtual void \fBsetAutoDelete\fR ( bool b, int i = 10000 )" -.br -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "virtual int \fBsupportedOperations\fR () const" -.br -.ti -1c -.BI "virtual void \fBaddOperation\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "QUrlOperator * \fBurl\fR () const" -.br -.ti -1c -.BI "QNetworkOperation * \fBoperationInProgress\fR () const" -.br -.ti -1c -.BI "virtual void \fBclearOperationQueue\fR ()" -.br -.ti -1c -.BI "virtual void \fBstop\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBdata\fR ( const QByteArray & data, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBconnectionStateChanged\fR ( int state, const QString & data )" -.br -.ti -1c -.BI "void \fBfinished\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBstart\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBnewChildren\fR ( const QValueList & i, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBnewChild\fR ( const QUrlInfo & i, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBcreatedDirectory\fR ( const QUrlInfo & i, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBremoved\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBitemChanged\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBdataTransferProgress\fR ( int bytesDone, int bytesTotal, QNetworkOperation * op )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBregisterNetworkProtocol\fR ( const QString & protocol, QNetworkProtocolFactoryBase * protocolFactory )" -.br -.ti -1c -.BI "QNetworkProtocol * \fBgetNetworkProtocol\fR ( const QString & protocol )" -.br -.ti -1c -.BI "bool \fBhasOnlyLocalFileSystem\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBoperationListChildren\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "virtual void \fBoperationMkDir\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "virtual void \fBoperationRemove\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "virtual void \fBoperationRename\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "virtual void \fBoperationGet\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "virtual void \fBoperationPut\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "virtual bool \fBcheckConnection\fR ( QNetworkOperation * op )" -.br -.in -1c -.SH DESCRIPTION -The QNetworkProtocol class provides a common API for network protocols. -.PP -This is a base class which should be used for network protocols implementations that can then be used in Qt (e.g. in the file dialog) together with the QUrlOperator. -.PP -The easiest way to implement a new network protocol is to reimplement the operation*() methods, e.g. operationGet(), etc. Only the supported operations should be reimplemented. To specify which operations are supported, also reimplement supportedOperations() and return an int that is OR'd together using the supported operations from the QNetworkProtocol::Operation enum. -.PP -When you implement a network protocol this way, it is important to emit the correct signals. Also, always emit the finished() signal when an operation is done (on success \fIand\fR on failure). Qt relies on correctly emitted finished() signals. -.PP -For a detailed description of the Qt Network Architecture and how to implement and use network protocols in Qt, see the Qt Network Documentation. -.PP -See also Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QNetworkProtocol::ConnectionState" -When the connection state of a network protocol changes it emits the signal connectionStateChanged(). The first argument is one of the following values: -.TP -\fCQNetworkProtocol::ConHostFound\fR - Host has been found. -.TP -\fCQNetworkProtocol::ConConnected\fR - Connection to the host has been established. -.TP -\fCQNetworkProtocol::ConClosed\fR - Connection has been closed. -.SH "QNetworkProtocol::Error" -When an operation fails (finishes unsuccessfully), the QNetworkOperation of the operation returns an error code which has one of the following values: -.TP -\fCQNetworkProtocol::NoError\fR - No error occurred. -.TP -\fCQNetworkProtocol::ErrValid\fR - The URL you are operating on is not valid. -.TP -\fCQNetworkProtocol::ErrUnknownProtocol\fR - There is no protocol implementation available for the protocol of the URL you are operating on (e.g. if the protocol is http and no http implementation has been registered). -.TP -\fCQNetworkProtocol::ErrUnsupported\fR - The operation is not supported by the protocol. -.TP -\fCQNetworkProtocol::ErrParse\fR - The URL could not be parsed correctly. -.TP -\fCQNetworkProtocol::ErrLoginIncorrect\fR - You needed to login but the username or password is wrong. -.TP -\fCQNetworkProtocol::ErrHostNotFound\fR - The specified host (in the URL) couldn't be found. -.TP -\fCQNetworkProtocol::ErrListChildren\fR - An error occurred while listing the children (files). -.TP -\fCQNetworkProtocol::ErrMkDir\fR - An error occurred when creating a directory. -.TP -\fCQNetworkProtocol::ErrRemove\fR - An error occurred when removing a child (file). -.TP -\fCQNetworkProtocol::ErrRename\fR - An error occurred when renaming a child (file). -.TP -\fCQNetworkProtocol::ErrGet\fR - An error occurred while getting (retrieving) data. -.TP -\fCQNetworkProtocol::ErrPut\fR - An error occurred while putting (uploading) data. -.TP -\fCQNetworkProtocol::ErrFileNotExisting\fR - A file which is needed by the operation doesn't exist. -.TP -\fCQNetworkProtocol::ErrPermissionDenied\fR - Permission for doing the operation has been denied. -.PP -You should also use these error codes when implementing custom network protocols. If this is not possible, you can define your own error codes by using integer values that don't conflict with any of these values. -.SH "QNetworkProtocol::Operation" -This enum lists the possible operations that a network protocol can support. supportedOperations() returns an int of these that is OR'd together. Also, the type() of a QNetworkOperation is always one of these values. -.TP -\fCQNetworkProtocol::OpListChildren\fR - List the children of a URL, e.g. of a directory. -.TP -\fCQNetworkProtocol::OpMkDir\fR - Create a directory. -.TP -\fCQNetworkProtocol::OpRemove\fR - Remove a child (e.g. a file). -.TP -\fCQNetworkProtocol::OpRename\fR - Rename a child (e.g. a file). -.TP -\fCQNetworkProtocol::OpGet\fR - Get data from a location. -.TP -\fCQNetworkProtocol::OpPut\fR - Put data to a location. -.SH "QNetworkProtocol::State" -This enum contains the state that a QNetworkOperation can have. -.TP -\fCQNetworkProtocol::StWaiting\fR - The operation is in the QNetworkProtocol's queue waiting to be prcessed. -.TP -\fCQNetworkProtocol::StInProgress\fR - The operation is being processed. -.TP -\fCQNetworkProtocol::StDone\fR - The operation has been processed succesfully. -.TP -\fCQNetworkProtocol::StFailed\fR - The operation has been processed but an error occurred. -.TP -\fCQNetworkProtocol::StStopped\fR - The operation has been processed but has been stopped before it finished, and is waiting to be processed. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QNetworkProtocol::QNetworkProtocol ()" -Constructor of the network protocol base class. Does some initialization and connecting of signals and slots. -.SH "QNetworkProtocol::~QNetworkProtocol ()\fC [virtual]\fR" -Destructor. -.SH "void QNetworkProtocol::addOperation ( QNetworkOperation * op )\fC [virtual]\fR" -Adds the operation \fIop\fR to the operation queue. The operation will be processed as soon as possible. This method returns immediately. -.SH "bool QNetworkProtocol::autoDelete () const" -Returns TRUE if auto-deleting is enabled; otherwise returns FALSE. -.PP -See also QNetworkProtocol::setAutoDelete(). -.SH "bool QNetworkProtocol::checkConnection ( QNetworkOperation * op )\fC [virtual protected]\fR" -For processing operations the network protocol base class calls this method quite often. This should be reimplemented by new network protocols. It should return TRUE if the connection is OK (open); otherwise it should return FALSE. If the connection is not open the protocol should open it. -.PP -If the connection can't be opened (e.g. because you already tried but the host couldn't be found), set the state of \fIop\fR to QNetworkProtocol::StFailed and emit the finished() signal with this QNetworkOperation as argument. -.PP -\fIop\fR is the operation that needs an open connection. -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QNetworkProtocol::clearOperationQueue ()\fC [virtual]\fR" -Clears the operation queue. -.SH "void QNetworkProtocol::connectionStateChanged ( int state, const QString & data )\fC [signal]\fR" -This signal is emitted whenever the state of the connection of the network protocol is changed. \fIstate\fR describes the new state, which is one of, ConHostFound, ConConnected or ConClosed. \fIdata\fR is a message text. -.SH "void QNetworkProtocol::createdDirectory ( const QUrlInfo & i, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when mkdir() has been succesful and the directory has been created. \fIi\fR holds the information about the new directory. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. Using op->arg( 0 ), you can get the file name of the new directory. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. -.SH "void QNetworkProtocol::data ( const QByteArray & data, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when new \fIdata\fR has been received after calling get() or put(). \fIop\fR holds the name of the file from which data is retrieved or uploaded in its first argument, and the (raw) data in its second argument. You can get them with op->arg( 0 ) and op->rawArg( 1 ). \fIop\fR is the pointer to the operation object, which contains all the information about the operation, including the state, etc. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator (which is used by the network protocol) emit its corresponding signal. -.SH "void QNetworkProtocol::dataTransferProgress ( int bytesDone, int bytesTotal, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted during the transfer of data (using put() or get()). \fIbytesDone\fR is how many bytes of \fIbytesTotal\fR have been transferred. \fIbytesTotal\fR may be -1, which means that the total number of bytes is not known. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. -.SH "void QNetworkProtocol::finished ( QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when an operation finishes. This signal is always emitted, for both success and failure. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. Check the state and error code of the operation object to determine whether or not the operation was successful. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. -.SH "QNetworkProtocol * QNetworkProtocol::getNetworkProtocol ( const QString & protocol )\fC [static]\fR" -Static method to get a new instance of the network protocol \fIprotocol\fR. For example, if you need to do some FTP operations, do the following: -.PP -.nf -.br - QFtp *ftp = QNetworkProtocol::getNetworkProtocol( "ftp" ); -.br -.fi -This returns a pointer to a new instance of an ftp implementation or null if no protocol for ftp was registered. The ownership of the pointer is transferred to you, so you must delete it if you don't need it anymore. -.PP -Normally you should not work directly with network protocols, so you will not need to call this method yourself. Instead, use QUrlOperator, which makes working with network protocols much more convenient. -.PP -See also QUrlOperator. -.SH "bool QNetworkProtocol::hasOnlyLocalFileSystem ()\fC [static]\fR" -Returns TRUE if the only protocol registered is for working on the local filesystem; returns FALSE if other network protocols are also registered. -.SH "void QNetworkProtocol::itemChanged ( QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted whenever a file which is a child of this URL has been changed, e.g. by successfully calling rename(). \fIop\fR holds the original and the new file names in the first and second arguments, accessible with op->arg( 0 ) and op->arg( 1 ) respectively. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. -.SH "void QNetworkProtocol::newChild ( const QUrlInfo & i, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted if a new child (file) has been read. QNetworkProtocol automatically connects it to a slot which creates a list of QUrlInfo objects (with just one QUrlInfo \fIi\fR) and emits the newChildren() signal with this list. \fIop\fR is the pointer to the operation object which contains all the information about the operation that has finished, including the state, etc. -.PP -This is just a convenience signal useful for implementing your own network protocol. In all other cases connect to the newChildren() signal with its list of QUrlInfo objects. -.SH "void QNetworkProtocol::newChildren ( const QValueList & i, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted after listChildren() was called and new children (files) have been read from the list of files. \fIi\fR holds the information about the new children. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. -.PP -When implementing your own network protocol and reading children, you usually don't read one child at once, but rather a list of them. That's why this signal takes a list of QUrlInfo objects. If you prefer to read just one child at a time you can use the convenience signal newChild(), which takes a single QUrlInfo object. -.SH "void QNetworkProtocol::operationGet ( QNetworkOperation * op )\fC [virtual protected]\fR" -When implementing a new network protocol, this method should be reimplemented if the protocol supports getting data; this method should then process the QNetworkOperation. -.PP -When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. -.PP -\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QNetworkOperation * QNetworkProtocol::operationInProgress () const" -Returns the operation, which is being processed, or 0 of no operation is being processed at the moment. -.SH "void QNetworkProtocol::operationListChildren ( QNetworkOperation * op )\fC [virtual protected]\fR" -When implementing a new network protocol, this method should be reimplemented if the protocol supports listing children (files); this method should then process this QNetworkOperation. -.PP -When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. -.PP -\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QNetworkProtocol::operationMkDir ( QNetworkOperation * op )\fC [virtual protected]\fR" -When implementing a new network protocol, this method should be reimplemented if the protocol supports making directories; this method should then process this QNetworkOperation. -.PP -When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. -.PP -\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. -.SH "void QNetworkProtocol::operationPut ( QNetworkOperation * op )\fC [virtual protected]\fR" -When implementing a new network protocol, this method should be reimplemented if the protocol supports putting (uploading) data; this method should then process the QNetworkOperation. -.PP -When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. -.PP -\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. -.SH "void QNetworkProtocol::operationRemove ( QNetworkOperation * op )\fC [virtual protected]\fR" -When implementing a new network protocol, this method should be reimplemented if the protocol supports removing children (files); this method should then process this QNetworkOperation. -.PP -When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which is describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. -.PP -\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. -.SH "void QNetworkProtocol::operationRename ( QNetworkOperation * op )\fC [virtual protected]\fR" -When implementing a new newtork protocol, this method should be reimplemented if the protocol supports renaming children (files); this method should then process this QNetworkOperation. -.PP -When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. -.PP -\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. -.SH "void QNetworkProtocol::registerNetworkProtocol ( const QString & protocol, QNetworkProtocolFactoryBase * protocolFactory )\fC [static]\fR" -Static method to register a network protocol for Qt. For example, if you have an implementation of NNTP (called Nntp) which is derived from QNetworkProtocol, call: -.PP -.nf -.br - QNetworkProtocol::registerNetworkProtocol( "nntp", new QNetworkProtocolFactory ); -.br -.fi -after which your implementation is registered for future nntp operations. -.PP -The name of the protocol is given in \fIprotocol\fR and a pointer to the protocol factory is given in \fIprotocolFactory\fR. -.SH "void QNetworkProtocol::removed ( QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when remove() has been succesful and the file has been removed. \fIop\fR holds the file name of the removed file in the first argument, accessible with op->arg( 0 ). \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. -.SH "void QNetworkProtocol::setAutoDelete ( bool b, int i = 10000 )\fC [virtual]\fR" -Because it's sometimes hard to take care of removing network protocol instances, QNetworkProtocol provides an auto-delete mechanism. If you set \fIb\fR to TRUE, the network protocol instance is removed after it has been inactive for \fIi\fR milliseconds (i.e. \fIi\fR milliseconds after the last operation has been processed). If you set \fIb\fR to FALSE the auto-delete mechanism is switched off. -.PP -If you switch on auto-delete, the QNetworkProtocol also deletes its QUrlOperator. -.SH "void QNetworkProtocol::setUrl ( QUrlOperator * u )\fC [virtual]\fR" -Sets the QUrlOperator, on which the protocol works, to \fIu\fR. -.PP -See also QUrlOperator. -.SH "void QNetworkProtocol::start ( QNetworkOperation * op )\fC [signal]\fR" -Some operations (such as listChildren()) emit this signal when they start processing the operation. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. -.PP -When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. -.SH "void QNetworkProtocol::stop ()\fC [virtual]\fR" -Stops the current operation that is being processed and clears all waiting operations. -.SH "int QNetworkProtocol::supportedOperations () const\fC [virtual]\fR" -Returns an int that is OR'd together using the enum values of QNetworkProtocol::Operation, which describes which operations are supported by the network protocol. Should be reimplemented by new network protocols. -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QUrlOperator * QNetworkProtocol::url () const" -Returns the QUrlOperator on which the protocol works. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqnetworkprotocol.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qnetworkprotocol.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qnpinstance.3qt b/doc/man/man3/qnpinstance.3qt deleted file mode 100644 index a52b1b0cf..000000000 --- a/doc/man/man3/qnpinstance.3qt +++ /dev/null @@ -1,290 +0,0 @@ -'\" t -.TH QNPInstance 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 -QNPInstance \- QObject that is a web browser plugin -.SH SYNOPSIS -This class is part of the \fBQt Netscape Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fB~QNPInstance\fR ()" -.br -.ti -1c -.BI "int \fBargc\fR () const" -.br -.ti -1c -.BI "const char * \fBargn\fR ( int i ) const" -.br -.ti -1c -.BI "const char * \fBargv\fR ( int i ) const" -.br -.ti -1c -.BI "enum \fBReason\fR { ReasonDone = 0, ReasonBreak = 1, ReasonError = 2, ReasonUnknown = -1 }" -.br -.ti -1c -.BI "const char * \fBarg\fR ( const char * name ) const" -.br -.ti -1c -.BI "enum \fBInstanceMode\fR { Embed = 1, Full = 2, Background = 3 }" -.br -.ti -1c -.BI "InstanceMode \fBmode\fR () const" -.br -.ti -1c -.BI "const char * \fBuserAgent\fR () const" -.br -.ti -1c -.BI "virtual QNPWidget * \fBnewWindow\fR ()" -.br -.ti -1c -.BI "QNPWidget * \fBwidget\fR ()" -.br -.ti -1c -.BI "enum \fBStreamMode\fR { Normal = 1, Seek = 2, AsFile = 3, AsFileOnly = 4 }" -.br -.ti -1c -.BI "virtual bool \fBnewStreamCreated\fR ( QNPStream *, StreamMode & smode )" -.br -.ti -1c -.BI "virtual int \fBwriteReady\fR ( QNPStream * )" -.br -.ti -1c -.BI "virtual int \fBwrite\fR ( QNPStream *, int offset, int len, void * buffer )" -.br -.ti -1c -.BI "virtual void \fBstreamDestroyed\fR ( QNPStream * )" -.br -.ti -1c -.BI "void \fBstatus\fR ( const char * msg )" -.br -.ti -1c -.BI "void \fBgetURLNotify\fR ( const char * url, const char * window = 0, void * data = 0 )" -.br -.ti -1c -.BI "void \fBgetURL\fR ( const char * url, const char * window = 0 )" -.br -.ti -1c -.BI "void \fBpostURL\fR ( const char * url, const char * window, uint len, const char * buf, bool file )" -.br -.ti -1c -.BI "QNPStream * \fBnewStream\fR ( const char * mimetype, const char * window, bool as_file = FALSE )" -.br -.ti -1c -.BI "virtual void \fBstreamAsFile\fR ( QNPStream *, const char * fname )" -.br -.ti -1c -.BI "void * \fBgetJavaPeer\fR () const" -.br -.ti -1c -.BI "virtual void \fBnotifyURL\fR ( const char * url, Reason r, void * notifyData )" -.br -.ti -1c -.BI "virtual bool \fBprintFullPage\fR ()" -.br -.ti -1c -.BI "virtual void \fBprint\fR ( QPainter * )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQNPInstance\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QNPInstance class provides a QObject that is a web browser plugin. -.PP -Deriving from QNPInstance creates an object that represents a single \fC\fR tag in an HTML document. -.PP -The QNPInstance is responsible for creating an appropriate QNPWidget window if required (not all plugins have windows), and for interacting with the input/output facilities intrinsic to plugins. -.PP -Note that there is \fIabsolutely no guarantee\fR regarding the order in which functions are called. Sometimes the browser will call newWindow() first, at other times, newStreamCreated() will be called first (assuming the \fC\fR tag has a SRC parameter). -.PP -\fINone of Qt's GUI functionality\fR may be used until after the first call to newWindow(). This includes any use of QPaintDevice (i.e. QPixmap, QWidget, and all subclasses), QApplication, anything related to QPainter (QBrush, etc.), fonts, QMovie, QToolTip, etc. Useful classes which specifically \fIcan\fR be used are QImage, QFile, and QBuffer. -.PP -This restriction can easily be accommodated by structuring your plugin so that the task of the QNPInstance is to gather data, while the task of the QNPWidget is to provide a graphical interface to that data. -.SS "Member Type Documentation" -.SH "QNPInstance::InstanceMode" -This enum type provides Qt-style names for three #defines in \fCnpapi.h\fR: -.TP -\fCQNPInstance::Embed\fR - corresponds to NP_EMBED -.TP -\fCQNPInstance::Full\fR - corresponds to NP_FULL -.TP -\fCQNPInstance::Background\fR - corresponds to NP_BACKGROUND -.SH "QNPInstance::Reason" -.TP -\fCQNPInstance::ReasonDone\fR -.TP -\fCQNPInstance::ReasonBreak\fR -.TP -\fCQNPInstance::ReasonError\fR -.TP -\fCQNPInstance::ReasonUnknown\fR -.SH "QNPInstance::StreamMode" -.TP -\fCQNPInstance::Normal\fR -.TP -\fCQNPInstance::Seek\fR -.TP -\fCQNPInstance::AsFile\fR -.TP -\fCQNPInstance::AsFileOnly\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QNPInstance::QNPInstance ()\fC [protected]\fR" -Creates a QNPInstance. -.PP -Can only be called from within a derived class created within QNPlugin::newInstance(). -.SH "QNPInstance::~QNPInstance ()" -Called when the plugin instance is about to be deleted. -.SH "const char * QNPInstance::arg ( const char * name ) const" -Returns the value of the named arguments, or 0 if no argument called \fIname\fR appears in the \fC\fR tag of this instance. If the argument appears, but has no value assigned, the empty string is returned. In summary: -.PP -
                                      .nf -.TS -l -- -l. -Tag Result - arg("FOO") == 0 - arg("FOO") == "" - -.TE -.fi -
                                      -.SH "int QNPInstance::argc () const" -Returns the number of arguments to the instance. Note that you should not normally rely on the ordering of arguments, and note that the SGML specification does not permit multiple arguments with the same name. -.PP -See also arg() and argn(). -.SH "const char * QNPInstance::argn ( int i ) const" -Returns the name of the \fIi\fR-th argument. -.PP -See also argc() and argv(). -.SH "const char * QNPInstance::argv ( int i ) const" -Returns the value of the \fIi\fR-th argument. -.PP -\\as argc(), arg() -.SH "void * QNPInstance::getJavaPeer () const" -Returns the Java object associated with the plugin instance, an object of the plugin's Java class, or 0 if the plug-in does not have a Java class, Java is disabled, or an error occurred. -.PP -The return value is actually a \fCjref\fR we use \fCvoid*\fR so as to avoid burdening plugins which do not require Java. -.PP -See also QNPlugin::getJavaClass() and QNPlugin::getJavaEnv(). -.SH "void QNPInstance::getURL ( const char * url, const char * window = 0 )" -Requests that the \fIurl\fR be retrieved and sent to the named \fIwindow\fR. See Netscape's JavaScript documentation for an explanation of window names. -.SH "void QNPInstance::getURLNotify ( const char * url, const char * window = 0, void * data = 0 )" -Requests that the given \fIurl\fR be retrieved and sent to the named \fIwindow\fR. See Netscape's JavaScript documentation for an explanation of window names. Passes the arguments including \fIdata\fR to NPN_GetURLNotify. -.PP -Netscape: NPN_GetURLNotify method -.SH "InstanceMode QNPInstance::mode () const" -Returns the mode of the plugin. -.SH "QNPStream * QNPInstance::newStream ( const char * mimetype, const char * window, bool as_file = FALSE )" -\fBThis function is under development and is subject to change.\fR -.PP -This function is \fInot tested\fR. -.PP -Requests the creation of a new data stream \fIfrom\fR the plugin. The MIME type and window are passed in \fImimetype\fR and \fIwindow\fR. \fIas_file\fR holds the AsFileOnly flag. It is an interface to the NPN_NewStream function of the Netscape Plugin API. -.SH "bool QNPInstance::newStreamCreated ( QNPStream *, StreamMode & smode )\fC [virtual]\fR" -This function is called when a new stream has been created. The instance should return TRUE if it accepts the processing of the stream. If the instance requires the stream as a file, it should set \fIsmode\fR to AsFileOnly, in which case the data will be delivered some time later to the streamAsFile() function. Otherwise, the data will be delivered in chunks to the write() function, which must consume at least as much data as returned by the most recent call to writeReady(). -.PP -Note that the AsFileOnly method is not supported by Netscape 2.0 and MSIE 3.0. -.PP -The default implementation accepts any stream. -.SH "QNPWidget * QNPInstance::newWindow ()\fC [virtual]\fR" -Called at most once, at some time after the QNPInstance is created. If the plugin requires a window, this function should return a derived class of QNPWidget that provides the required interface. -.PP -Example: grapher/grapher.cpp. -.SH "void QNPInstance::notifyURL ( const char * url, Reason r, void * notifyData )\fC [virtual]\fR" -\fBThis function is under development and is subject to change.\fR -.PP -This function is \fInot tested\fR. -.PP -Called whenever a \fIurl\fR is notified after a call to NPN_GetURLNotify with \fInotifyData\fR. The reason is given in \fIr\fR. -.PP -It is an encapsulation of the NPP_URLNotify function of the Netscape Plugin API. -.PP -See also: Netscape: NPP_URLNotify method -.SH "void QNPInstance::postURL ( const char * url, const char * window, uint len, const char * buf, bool file )" -\fBThis function is under development and is subject to change.\fR -.PP -This function is \fInot tested\fR. -.PP -It is an interface to the NPN_PostURL function of the Netscape Plugin API. -.PP -Passes \fIurl\fR, \fIwindow\fR, \fIbuf\fR, \fIlen\fR, and \fIfile\fR to NPN_PostURL. -.SH "void QNPInstance::print ( QPainter * )\fC [virtual]\fR" -\fBThis function is under development and is subject to change.\fR -.PP -This function is \fInot tested\fR. -.PP -Print the instance embedded in a page. -.PP -It is an encapsulation of the NPP_Print function of the Netscape Plugin API. -.SH "bool QNPInstance::printFullPage ()\fC [virtual]\fR" -\fBThis function is under development and is subject to change.\fR -.PP -This function is \fInot tested\fR. -.PP -It is an encapsulation of the NPP_Print function of the Netscape Plugin API. -.SH "void QNPInstance::status ( const char * msg )" -Sets the status message in the browser containing this instance to \fImsg\fR. -.SH "void QNPInstance::streamAsFile ( QNPStream *, const char * fname )\fC [virtual]\fR" -Called when a stream is delivered as a single file called \fIfname\fR rather than as chunks. This may be simpler for a plugin to deal with, but precludes any incremental behavior. -.PP -Note that the AsFileOnly method is not supported by Netscape 2.0 and MSIE 3.0. -.PP -See also newStreamCreated() and newStream(). -.SH "void QNPInstance::streamDestroyed ( QNPStream * )\fC [virtual]\fR" -Called when a stream is destroyed. At this point, the stream may be complete() and okay(). If it is not okay(), then an error has occurred. If it is okay(), but not complete(), then the user has cancelled the transmission; do not give an error message in this case. -.SH "const char * QNPInstance::userAgent () const" -Returns the user agent (browser name) containing this instance. -.SH "QNPWidget * QNPInstance::widget ()" -Returns the plugin window created by newWindow(), if any. -.SH "int QNPInstance::write ( QNPStream *, int offset, int len, void * buffer )\fC [virtual]\fR" -Called when incoming data is available for processing by the instance. The instance \fImust\fR consume at least the amount that it returned in the most recent call to writeReady(), but it may consume up to the amount given by \fIlen\fR. \fIbuffer\fR is the data available for consumption. The \fIoffset\fR argument is merely an informational value indicating the total amount of data that has been consumed in prior calls. -.PP -This function should return the amount of data actually consumed. -.PP -Example: grapher/grapher.cpp. -.SH "int QNPInstance::writeReady ( QNPStream * )\fC [virtual]\fR" -Returns the minimum amount of data the instance is willing to receive from the given stream. -.PP -The default returns a very large value. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qnpinstance.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qnpinstance.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qnplugin.3qt b/doc/man/man3/qnplugin.3qt deleted file mode 100644 index f2ffc6cd4..000000000 --- a/doc/man/man3/qnplugin.3qt +++ /dev/null @@ -1,157 +0,0 @@ -'\" t -.TH QNPlugin 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 -QNPlugin \- The main factory for plugin objects -.SH SYNOPSIS -This class is part of the \fBQt Netscape Extension\fR. -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QNPlugin\fR ()" -.br -.ti -1c -.BI "void \fBgetVersionInfo\fR ( int & plugin_major, int & plugin_minor, int & browser_major, int & browser_minor )" -.br -.ti -1c -.BI "virtual QNPInstance * \fBnewInstance\fR () = 0" -.br -.ti -1c -.BI "virtual const char * \fBgetMIMEDescription\fR () const = 0" -.br -.ti -1c -.BI "virtual const char * \fBgetPluginNameString\fR () const = 0" -.br -.ti -1c -.BI "virtual const char * \fBgetPluginDescriptionString\fR () const = 0" -.br -.ti -1c -.BI "virtual void * \fBgetJavaClass\fR ()" -.br -.ti -1c -.BI "virtual void \fBunuseJavaClass\fR ()" -.br -.ti -1c -.BI "void * \fBgetJavaEnv\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QNPlugin * \fBcreate\fR ()" -.br -.ti -1c -.BI "QNPlugin * \fBactual\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQNPlugin\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QNPlugin class provides the main factory for plugin objects. -.PP -This class is the heart of the plugin. One instance of this object is created when the plugin is \fIfirst\fR needed, by calling QNPlugin::create(), which must be implemented in your plugin code to return some derived class of QNPlugin. The one QNPlugin object creates all QNPInstance instances for a web browser running in a single process. -.PP -Additionally, if Qt is linked to the plugin as a dynamic library, only one instance of QApplication will exist \fIacross all plugins that have been made with Qt\fR. So, your plugin should tread lightly on global settings. Do not, for example, use QApplication::setFont() - that will change the font in every widget of every Qt-based plugin currently loaded! -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QNPlugin::QNPlugin ()\fC [protected]\fR" -Creates a QNPlugin. This may only be used by the constructor of the class, derived from QNPlugin, that is returned by your plugin's implementation of the QNPlugin::create() function. -.SH "QNPlugin::~QNPlugin ()\fC [virtual]\fR" -Destroys the QNPlugin. This is called by the plugin binding code just before the plugin is about to be unloaded from memory. If newWindow() has been called, a QApplication will still exist at this time, but will be deleted shortly after, just before the plugin is deleted. -.SH "QNPlugin * QNPlugin::actual ()\fC [static]\fR" -Returns the plugin most recently returned by QNPlugin::create(). -.SH "QNPlugin * QNPlugin::create ()\fC [static]\fR" -This function must be implemented by your plugin code. It should return a derived class of QNPlugin. -.SH "void * QNPlugin::getJavaClass ()\fC [virtual]\fR" -Override this function to return a reference to the Java class that represents the plugin. The default returns 0, indicating no class. -.PP -If you override this class, you must also override QNPlugin::unuseJavaClass(). -.PP -The return value is actually a \fCjref\fR; we use \fCvoid*\fR so as to avoid burdening plugins which do not require Java. -.PP -See also getJavaEnv() and QNPInstance::getJavaPeer(). -.SH "void * QNPlugin::getJavaEnv () const" -Returns a pointer to the Java execution environment, or 0 if either Java is disabled or an error occurred. -.PP -The return value is actually a \fCJRIEnv*\fR; we use \fCvoid*\fR so as to avoid burdening plugins which do not require Java. -.PP -See also getJavaClass() and QNPInstance::getJavaPeer(). -.SH "const char * QNPlugin::getMIMEDescription () const\fC [pure virtual]\fR" -Override this function to return the MIME description of the data formats supported by your plugin. The format of this string is shown by the following example: -.PP -.nf -.br - const char* getMIMEDescription() const -.br - { -.br - return "image/x-png:png:PNG Image;" -.br - "image/png:png:PNG Image;" -.br - "image/x-portable-bitmap:pbm:PBM Image;" -.br - "image/x-portable-graymap:pgm:PGM Image;" -.br - "image/x-portable-pixmap:ppm:PPM Image;" -.br - "image/bmp:bmp:BMP Image;" -.br - "image/x-ms-bmp:bmp:BMP Image;" -.br - "image/x-xpixmap:xpm:XPM Image;" -.br - "image/xpm:xpm:XPM Image"; -.br - } -.fi -.SH "const char * QNPlugin::getPluginDescriptionString () const\fC [pure virtual]\fR" -Returns a pointer to the plain-text description of the plugin. -.SH "const char * QNPlugin::getPluginNameString () const\fC [pure virtual]\fR" -Returns a pointer to the plain-text name of the plugin. -.SH "void QNPlugin::getVersionInfo ( int & plugin_major, int & plugin_minor, int & browser_major, int & browser_minor )" -Populates \fI*\fR\fIplugin_major\fR and \fI*\fR\fIplugin_minor\fR with the version of the plugin API and populates \fI*\fR\fIbrowser_major\fR and \fI*\fR\fIbrowser_minor\fR with the version of the web browser. -.SH "QNPInstance * QNPlugin::newInstance ()\fC [pure virtual]\fR" -Override this function to return an appropriate derived class of QNPInstance. -.SH "void QNPlugin::unuseJavaClass ()\fC [virtual]\fR" -This function is called when the plugin is shutting down. The -function should \fIunuse\fR the Java class returned earlier by -getJavaClass(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qnplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qnplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qnpstream.3qt b/doc/man/man3/qnpstream.3qt deleted file mode 100644 index c0148a716..000000000 --- a/doc/man/man3/qnpstream.3qt +++ /dev/null @@ -1,114 +0,0 @@ -'\" t -.TH QNPStream 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 -QNPStream \- Stream of data provided to a QNPInstance by the browser -.SH SYNOPSIS -This class is part of the \fBQt Netscape Extension\fR. -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fB~QNPStream\fR ()" -.br -.ti -1c -.BI "const char * \fBurl\fR () const" -.br -.ti -1c -.BI "uint \fBend\fR () const" -.br -.ti -1c -.BI "uint \fBlastModified\fR () const" -.br -.ti -1c -.BI "const char * \fBtype\fR () const" -.br -.ti -1c -.BI "bool \fBseekable\fR () const" -.br -.ti -1c -.BI "bool \fBokay\fR () const" -.br -.ti -1c -.BI "bool \fBcomplete\fR () const" -.br -.ti -1c -.BI "void \fBrequestRead\fR ( int offset, uint length )" -.br -.ti -1c -.BI "int \fBwrite\fR ( int len, void * buffer )" -.br -.ti -1c -.BI "QNPInstance * \fBinstance\fR ()" -.br -.ti -1c -.BI "\fBQNPStream\fR ( QNPInstance * in, const char * mt, _NPStream * st, bool se )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QNPStream class provides a stream of data provided to a QNPInstance by the browser. -.PP -Note that this is neither a QTextStream nor a QDataStream. -.PP -See also QNPInstance::write() and QNPInstance::newStreamCreated(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QNPStream::QNPStream ( QNPInstance * in, const char * mt, _NPStream * st, bool se )" -Creates a stream. Plugins should not call this; they should call QNPInstance::newStream() if they need a stream. -.PP -Takes a QNPInstance \fIin\fR, MIME type \fImt\fR, a pointer to an _NPStream \fIst\fR and a seekable flag \fIse\fR. -.SH "QNPStream::~QNPStream ()" -Destroys the stream. -.SH "bool QNPStream::complete () const" -Returns TRUE if the stream has received all the data from the source; otherwise returns FALSE. -.SH "uint QNPStream::end () const" -Returns the length of the stream in bytes. The function might return 0 for streams of unknown length. -.SH "QNPInstance * QNPStream::instance ()" -Returns the QNPInstance for which this stream was created. -.SH "uint QNPStream::lastModified () const" -Returns the time when the source of the stream was last modified. -.SH "bool QNPStream::okay () const" -Returns TRUE if no errors have occurred on the stream; otherwise returns FALSE. -.SH "void QNPStream::requestRead ( int offset, uint length )" -Requests the section of the stream, of \fIlength\fR bytes from \fIoffset\fR, be sent to the QNPInstance::write() function of the instance() of this stream. -.SH "bool QNPStream::seekable () const" -Returns TRUE if the stream is seekable; otherwise returns FALSE. -.SH "const char * QNPStream::type () const" -Returns the MIME type of the stream. -.SH "const char * QNPStream::url () const" -Returns the URL from which the stream was created. -.SH "int QNPStream::write ( int len, void * buffer )" -Writes \fIlen\fR bytes from \fIbuffer\fR \fIto\fR the stream. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qnpstream.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qnpstream.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qnpwidget.3qt b/doc/man/man3/qnpwidget.3qt deleted file mode 100644 index 634bacfad..000000000 --- a/doc/man/man3/qnpwidget.3qt +++ /dev/null @@ -1,129 +0,0 @@ -'\" t -.TH QNPWidget 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 -QNPWidget \- QWidget that is a web browser plugin window -.SH SYNOPSIS -This class is part of the \fBQt Netscape Extension\fR. -.PP -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQNPWidget\fR ()" -.br -.ti -1c -.BI "\fB~QNPWidget\fR ()" -.br -.ti -1c -.BI "virtual void \fBenterInstance\fR ()" -.br -.ti -1c -.BI "virtual void \fBleaveInstance\fR ()" -.br -.ti -1c -.BI "QNPInstance * \fBinstance\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. -.PP -The QNPWidget class provides a QWidget that is a web browser plugin window. -.PP -Derive from QNPWidget to create a widget that can be used as a web browser plugin window, or create one and add child widgets. Instances of QNPWidget may only be created when QNPInstance::newWindow() is called by the browser. -.PP -A common way to develop a plugin widget is to develop it as a stand-alone application window, then make it a \fIchild\fR of a plugin widget to use it as a browser plugin. The technique is: -.PP -.nf -.br -class MyPluginWindow : public QNPWidget -.br -{ -.br - QWidget* child; -.br -public: -.br - MyPluginWindow() -.br - { -.br - // Some widget that is normally used as a top-level widget -.br - child = new MyIndependentlyDevelopedWidget(); -.br -.br - // Use the background color of the web page -.br - child->setBackgroundColor( backgroundColor() ); -.br -.br - // Fill the plugin widget -.br - child->setGeometry( 0, 0, width(), height() ); -.br - } -.br -.br - void resizeEvent(QResizeEvent*) -.br - { -.br - // Fill the plugin widget -.br - child->resize(size()); -.br - } -.br -}; -.fi -.PP -The default implementation is an empty window. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QNPWidget::QNPWidget ()" -Creates a QNPWidget. -.SH "QNPWidget::~QNPWidget ()" -Destroys the window. This will be called by the plugin binding code when the window is no longer required. The web browser will delete windows when they leave the page. The bindings will change the QWidget::winId() of the window when the window is resized, but this should not affect normal widget behavior. -.SH "void QNPWidget::enterInstance ()\fC [virtual]\fR" -Called when the mouse enters the plugin window. Does nothing by default. -.PP -Example: grapher/grapher.cpp. -.SH "QNPInstance * QNPWidget::instance ()" -Returns the instance for which this widget is the plugin window. -.SH "void QNPWidget::leaveInstance ()\fC [virtual]\fR" -Called when the mouse leaves the plugin window. Does nothing by default. -.PP -Example: grapher/grapher.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qnpwidget.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qnpwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qobject.3qt b/doc/man/man3/qobject.3qt deleted file mode 100644 index f0b0823c2..000000000 --- a/doc/man/man3/qobject.3qt +++ /dev/null @@ -1,1002 +0,0 @@ -'\" t -.TH QObject 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 -QObject \- The base class of all Qt objects -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                      -.PP -\fC#include \fR -.PP -Inherits Qt. -.PP -Inherited by QAccel, QAccessibleObject, QAction, QApplication, QAssistantClient, QDataPump, QAxObject, QAxScript, QAxScriptManager, QWidget, QCanvas, QStyle, QClipboard, QCopChannel, QDns, QLayout, QDragObject, QEditorFactory, QEventLoop, QFileIconProvider, QNetworkProtocol, QWSKeyboardHandler, QNetworkOperation, QNPInstance, QObjectCleanupHandler, QProcess, QServerSocket, QSessionManager, QSignal, QSignalMapper, QSocket, QSocketNotifier, QSound, QSqlDatabase, QSqlDriver, QSqlForm, QStyleSheet, QTimer, QToolTipGroup, QTranslator, QUrlOperator, and QValidator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQObject\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QObject\fR ()" -.br -.ti -1c -.BI "virtual const char * \fBclassName\fR () const" -.br -.ti -1c -.BI "virtual QMetaObject * \fBmetaObject\fR () const" -.br -.ti -1c -.BI "virtual bool \fBevent\fR ( QEvent * e )" -.br -.ti -1c -.BI "virtual bool \fBeventFilter\fR ( QObject * watched, QEvent * e )" -.br -.ti -1c -.BI "bool \fBisA\fR ( const char * clname ) const" -.br -.ti -1c -.BI "bool \fBinherits\fR ( const char * clname ) const" -.br -.ti -1c -.BI "const char * \fBname\fR () const" -.br -.ti -1c -.BI "const char * \fBname\fR ( const char * defaultName ) const" -.br -.ti -1c -.BI "virtual void \fBsetName\fR ( const char * name )" -.br -.ti -1c -.BI "bool \fBisWidgetType\fR () const" -.br -.ti -1c -.BI "bool \fBhighPriority\fR () const" -.br -.ti -1c -.BI "bool \fBsignalsBlocked\fR () const" -.br -.ti -1c -.BI "void \fBblockSignals\fR ( bool block )" -.br -.ti -1c -.BI "int \fBstartTimer\fR ( int interval )" -.br -.ti -1c -.BI "void \fBkillTimer\fR ( int id )" -.br -.ti -1c -.BI "void \fBkillTimers\fR ()" -.br -.ti -1c -.BI "QObject * \fBchild\fR ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = TRUE )" -.br -.ti -1c -.BI "const QObjectList * \fBchildren\fR () const" -.br -.ti -1c -.BI "QObjectList * \fBqueryList\fR ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = TRUE, bool recursiveSearch = TRUE ) const" -.br -.ti -1c -.BI "virtual void \fBinsertChild\fR ( QObject * obj )" -.br -.ti -1c -.BI "virtual void \fBremoveChild\fR ( QObject * obj )" -.br -.ti -1c -.BI "void \fBinstallEventFilter\fR ( const QObject * filterObj )" -.br -.ti -1c -.BI "void \fBremoveEventFilter\fR ( const QObject * obj )" -.br -.ti -1c -.BI "bool \fBconnect\fR ( const QObject * sender, const char * signal, const char * member ) const" -.br -.ti -1c -.BI "bool \fBdisconnect\fR ( const char * signal = 0, const QObject * receiver = 0, const char * member = 0 )" -.br -.ti -1c -.BI "bool \fBdisconnect\fR ( const QObject * receiver, const char * member = 0 )" -.br -.ti -1c -.BI "void \fBdumpObjectTree\fR ()" -.br -.ti -1c -.BI "void \fBdumpObjectInfo\fR ()" -.br -.ti -1c -.BI "virtual bool \fBsetProperty\fR ( const char * name, const QVariant & value )" -.br -.ti -1c -.BI "virtual QVariant \fBproperty\fR ( const char * name ) const" -.br -.ti -1c -.BI "QObject * \fBparent\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBdeleteLater\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBdestroyed\fR ()" -.br -.ti -1c -.BI "void \fBdestroyed\fR ( QObject * obj )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBtr\fR ( const char * sourceText, const char * comment )" -.br -.ti -1c -.BI "QString \fBtrUtf8\fR ( const char * sourceText, const char * comment )" -.br -.ti -1c -.BI "const QObjectList * \fBobjectTrees\fR ()" -.br -.ti -1c -.BI "bool \fBconnect\fR ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "bool \fBdisconnect\fR ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QCString \fBname\fR - the name of this object" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "const QObject * \fBsender\fR ()" -.br -.ti -1c -.BI "virtual void \fBtimerEvent\fR ( QTimerEvent * )" -.br -.ti -1c -.BI "virtual void \fBchildEvent\fR ( QChildEvent * )" -.br -.ti -1c -.BI "virtual void \fBcustomEvent\fR ( QCustomEvent * )" -.br -.ti -1c -.BI "virtual void \fBconnectNotify\fR ( const char * signal )" -.br -.ti -1c -.BI "virtual void \fBdisconnectNotify\fR ( const char * signal )" -.br -.ti -1c -.BI "virtual bool \fBcheckConnectArgs\fR ( const char * signal, const QObject * receiver, const char * member )" -.br -.in -1c -.SS "Static Protected Members" -.in +1c -.ti -1c -.BI "QCString \fBnormalizeSignalSlot\fR ( const char * signalSlot )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "void * \fBqt_find_obj_child\fR ( QObject * parent, const char * type, const char * name )" -.br -.in -1c -.SH DESCRIPTION -The QObject class is the base class of all Qt objects. -.PP -QObject is the heart of the Qt object model. The central feature in this model is a very powerful mechanism for seamless object communication called signals and slots. You can connect a signal to a slot with connect() and destroy the connection with disconnect(). To avoid never ending notification loops you can temporarily block signals with blockSignals(). The protected functions connectNotify() and disconnectNotify() make it possible to track connections. -.PP -QObjects organize themselves in object trees. When you create a QObject with another object as parent, the object will automatically do an insertChild() on the parent and thus show up in the parent's children() list. The parent takes ownership of the object i.e. it will automatically delete its children in its destructor. You can look for an object by name and optionally type using child() or queryList(), and get the list of tree roots using objectTrees(). -.PP -Every object has an object name() and can report its className() and whether it inherits() another class in the QObject inheritance hierarchy. -.PP -When an object is deleted, it emits a destroyed() signal. You can catch this signal to avoid dangling references to QObjects. The QGuardedPtr class provides an elegant way to use this feature. -.PP -QObjects can receive events through event() and filter the events of other objects. See installEventFilter() and eventFilter() for details. A convenience handler, childEvent(), can be reimplemented to catch child events. -.PP -Last but not least, QObject provides the basic timer support in Qt; see QTimer for high-level support for timers. -.PP -Notice that the TQ_OBJECT macro is mandatory for any object that implements signals, slots or properties. You also need to run the moc program (Meta Object Compiler) on the source file. We strongly recommend the use of this macro in \fIall\fR subclasses of QObject regardless of whether or not they actually use signals, slots and properties, since failure to do so may lead certain functions to exhibit undefined behaviour. -.PP -All Qt widgets inherit QObject. The convenience function isWidgetType() returns whether an object is actually a widget. It is much faster than inherits( "QWidget" ). -.PP -Some QObject functions, e.g. children(), objectTrees() and queryList() return a QObjectList. A QObjectList is a QPtrList of QObjects. QObjectLists support the same operations as QPtrLists and have an iterator class, QObjectListIt. -.PP -See also Object Model. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QObject::QObject ( QObject * parent = 0, const char * name = 0 )" -Constructs an object called \fIname\fR with parent object, \fIparent\fR. -.PP -The parent of an object may be viewed as the object's owner. For instance, a dialog box is the parent of the" OK" and "Cancel" buttons it contains. -.PP -The destructor of a parent object destroys all child objects. -.PP -Setting \fIparent\fR to 0 constructs an object with no parent. If the object is a widget, it will become a top-level window. -.PP -The object name is some text that can be used to identify a QObject. It's particularly useful in conjunction with \fIQt Designer\fR. You can find an object by name (and type) using child(). To find several objects use queryList(). -.PP -See also parent(), name, child(), and queryList(). -.SH "QObject::~QObject ()\fC [virtual]\fR" -Destroys the object, deleting all its child objects. -.PP -All signals to and from the object are automatically disconnected. -.PP -\fBWarning:\fR All child objects are deleted. If any of these objects are on the stack or global, sooner or later your program will crash. We do not recommend holding pointers to child objects from outside the parent. If you still do, the QObject::destroyed() signal gives you an opportunity to detect when an object is destroyed. -.PP -\fBWarning:\fR Deleting a QObject while pending events are waiting to be delivered can cause a crash. You must not delete the QObject directly from a thread that is not the GUI thread. Use the QObject::deleteLater() method instead, which will cause the event loop to delete the object after all pending events have been delivered to the object. -.SH "void QObject::blockSignals ( bool block )" -Blocks signals if \fIblock\fR is TRUE, or unblocks signals if \fIblock\fR is FALSE. -.PP -Emitted signals disappear into hyperspace if signals are blocked. Note that the destroyed() signals will be emitted even if the signals for this object have been blocked. -.PP -Examples: -.)l rot13/rot13.cpp and simple/main.cpp. -.SH "bool QObject::checkConnectArgs ( const char * signal, const QObject * receiver, const char * member )\fC [virtual protected]\fR" -Returns TRUE if the \fIsignal\fR and the \fImember\fR arguments are compatible; otherwise returns FALSE. (The \fIreceiver\fR argument is currently ignored.) -.PP -\fBWarning:\fR We recommend that you use the default implementation and do not reimplement this function. -.SH "QObject * QObject::child ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = TRUE )" -Searches the children and optionally grandchildren of this object, and returns a child that is called \fIobjName\fR that inherits \fIinheritsClass\fR. If \fIinheritsClass\fR is 0 (the default), any class matches. -.PP -If \fIrecursiveSearch\fR is TRUE (the default), child() performs a depth-first search of the object's children. -.PP -If there is no such object, this function returns 0. If there are more than one, the first one found is retured; if you need all of them, use queryList(). -.SH "void QObject::childEvent ( QChildEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive child events. -.PP -Child events are sent to objects when children are inserted or removed. -.PP -Note that events with QEvent::type() QEvent::ChildInserted are posted (with QApplication::postEvent()) to make sure that the child's construction is completed before this function is called. -.PP -If a child is removed immediately after it is inserted, the \fCChildInserted\fR event may be suppressed, but the \fCChildRemoved\fR event will always be sent. In such cases it is possible that there will be a \fCChildRemoved\fR event without a corresponding \fCChildInserted\fR event. -.PP -If you change state based on \fCChildInserted\fR events, call QWidget::constPolish(), or do -.PP -.nf -.br - QApplication::sendPostedEvents( this, QEvent::ChildInserted ); -.br -.fi -in functions that depend on the state. One notable example is QWidget::sizeHint(). -.PP -See also event() and QChildEvent. -.PP -Reimplemented in QMainWindow and QSplitter. -.SH "const QObjectList * QObject::children () const" -Returns a list of child objects, or 0 if this object has no children. -.PP -The QObjectList class is defined in the ntqobjectlist.h header file. -.PP -The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end. -.PP -Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list. -.PP -See also child(), queryList(), parent(), insertChild(), and removeChild(). -.SH "const char * QObject::className () const\fC [virtual]\fR" -Returns the class name of this object. -.PP -This function is generated by the Meta Object Compiler. -.PP -\fBWarning:\fR This function will return the wrong name if the class definition lacks the TQ_OBJECT macro. -.PP -See also name, inherits(), isA(), and isWidgetType(). -.PP -Example: sql/overview/custom1/main.cpp. -.SH "bool QObject::connect ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )\fC [static]\fR" -Connects \fIsignal\fR from the \fIsender\fR object to \fImember\fR in object \fIreceiver\fR, and returns TRUE if the connection succeeds; otherwise returns FALSE. -.PP -You must use the SIGNAL() and SLOT() macros when specifying the \fIsignal\fR and the \fImember\fR, for example: -.PP -.nf -.br - QLabel *label = new QLabel; -.br - QScrollBar *scroll = new QScrollBar; -.br - QObject::connect( scroll, SIGNAL(valueChanged(int)), -.br - label, SLOT(setNum(int)) ); -.br -.fi -.PP -This example ensures that the label always displays the current scroll bar value. Note that the signal and slots parameters must not contain any variable names, only the type. E.g. the following would not work and return FALSE: QObject::connect( scroll, SIGNAL(valueChanged(int v)), label, SLOT(setNum(int v)) ); -.PP -A signal can also be connected to another signal: -.PP -.nf -.br - class MyWidget : public QWidget -.br - { -.br - TQ_OBJECT -.br - public: -.br - MyWidget(); -.br -.br - signals: -.br - void myUsefulSignal(); -.br -.br - private: -.br - QPushButton *aButton; -.br - }; -.br -.br - MyWidget::MyWidget() -.br - { -.br - aButton = new QPushButton( this ); -.br - connect( aButton, SIGNAL(clicked()), SIGNAL(myUsefulSignal()) ); -.br - } -.br -.fi -.PP -In this example, the MyWidget constructor relays a signal from a private member variable, and makes it available under a name that relates to MyWidget. -.PP -A signal can be connected to many slots and signals. Many signals can be connected to one slot. -.PP -If a signal is connected to several slots, the slots are activated in an arbitrary order when the signal is emitted. -.PP -The function returns TRUE if it successfully connects the signal to the slot. It will return FALSE if it cannot create the connection, for example, if QObject is unable to verify the existence of either \fIsignal\fR or \fImember\fR, or if their signatures aren't compatible. -.PP -A signal is emitted for \fIevery\fR connection you make, so if you duplicate a connection, two signals will be emitted. You can always break a connection using disconnect(). -.PP -See also disconnect(). -.PP -Examples: -.)l action/main.cpp, application/main.cpp, extension/main.cpp, iconview/main.cpp, network/archivesearch/main.cpp, regexptester/main.cpp, and t2/main.cpp. -.SH "bool QObject::connect ( const QObject * sender, const char * signal, const char * member ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Connects \fIsignal\fR from the \fIsender\fR object to this object's \fImember\fR. -.PP -Equivalent to: \fCQObject::connect(sender, signal, this, member)\fR. -.PP -See also disconnect(). -.SH "void QObject::connectNotify ( const char * signal )\fC [virtual protected]\fR" -This virtual function is called when something has been connected to \fIsignal\fR in this object. -.PP -\fBWarning:\fR This function violates the object-oriented principle of modularity. However, it might be useful when you need to perform expensive initialization only if something is connected to a signal. -.PP -See also connect() and disconnectNotify(). -.SH "void QObject::customEvent ( QCustomEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive custom events. Custom events are user-defined events with a type value at least as large as the "User" item of the QEvent::Type enum, and is typically a QCustomEvent or QCustomEvent subclass. -.PP -See also event() and QCustomEvent. -.SH "void QObject::deleteLater ()\fC [slot]\fR" -Performs a deferred deletion of this object. -.PP -Instead of an immediate deletion this function schedules a deferred delete event for processing when Qt returns to the main event loop. -.PP -Example: table/bigtable/main.cpp. -.SH "void QObject::destroyed ()\fC [signal]\fR" -This signal is emitted when the object is being destroyed. -.PP -Note that the signal is emitted by the QObject destructor, so the object's virtual table is already degenerated at this point, and it is not safe to call any functions on the object emitting the signal. This signal can not be blocked. -.PP -All the objects's children are destroyed immediately after this signal is emitted. -.SH "void QObject::destroyed ( QObject * obj )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted immediately before the object \fIobj\fR is destroyed, and can not be blocked. -.PP -All the objects's children are destroyed immediately after this signal is emitted. -.SH "bool QObject::disconnect ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )\fC [static]\fR" -Disconnects \fIsignal\fR in object \fIsender\fR from \fImember\fR in object \fIreceiver\fR. -.PP -A signal-slot connection is removed when either of the objects involved are destroyed. -.PP -disconnect() is typically used in three ways, as the following examples demonstrate.
                                        -.IP 1 -Disconnect everything connected to an object's signals: -.IP -.nf -.br - disconnect( myObject, 0, 0, 0 ); -.br -.fi -equivalent to the non-static overloaded function -.IP -.nf -.br - myObject->disconnect(); -.br -.fi -.IP 2 -Disconnect everything connected to a specific signal: -.IP -.nf -.br - disconnect( myObject, SIGNAL(mySignal()), 0, 0 ); -.br -.fi -equivalent to the non-static overloaded function -.IP -.nf -.br - myObject->disconnect( SIGNAL(mySignal()) ); -.br -.fi -.IP 3 -Disconnect a specific receiver: -.IP -.nf -.br - disconnect( myObject, 0, myReceiver, 0 ); -.br -.fi -equivalent to the non-static overloaded function -.IP -.nf -.br - myObject->disconnect( myReceiver ); -.br -.fi -.PP -0 may be used as a wildcard, meaning "any signal", "any receiving object", or "any slot in the receiving object", respectively. -.PP -The \fIsender\fR may never be 0. (You cannot disconnect signals from more than one object in a single call.) -.PP -If \fIsignal\fR is 0, it disconnects \fIreceiver\fR and \fImember\fR from any signal. If not, only the specified signal is disconnected. -.PP -If \fIreceiver\fR is 0, it disconnects anything connected to \fIsignal\fR. If not, slots in objects other than \fIreceiver\fR are not disconnected. -.PP -If \fImember\fR is 0, it disconnects anything that is connected to \fIreceiver\fR. If not, only slots named \fImember\fR will be disconnected, and all other slots are left alone. The \fImember\fR must be 0 if \fIreceiver\fR is left out, so you cannot disconnect a specifically-named slot on all objects. -.PP -See also connect(). -.SH "bool QObject::disconnect ( const char * signal = 0, const QObject * receiver = 0, const char * member = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Disconnects \fIsignal\fR from \fImember\fR of \fIreceiver\fR. -.PP -A signal-slot connection is removed when either of the objects involved are destroyed. -.SH "bool QObject::disconnect ( const QObject * receiver, const char * member = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Disconnects all signals in this object from \fIreceiver\fR's \fImember\fR. -.PP -A signal-slot connection is removed when either of the objects involved are destroyed. -.SH "void QObject::disconnectNotify ( const char * signal )\fC [virtual protected]\fR" -This virtual function is called when something has been disconnected from \fIsignal\fR in this object. -.PP -\fBWarning:\fR This function violates the object-oriented principle of modularity. However, it might be useful for optimizing access to expensive resources. -.PP -See also disconnect() and connectNotify(). -.SH "void QObject::dumpObjectInfo ()" -Dumps information about signal connections, etc. for this object to the debug output. -.PP -This function is useful for debugging, but does nothing if the library has been compiled in release mode (i.e. without debugging information). -.SH "void QObject::dumpObjectTree ()" -Dumps a tree of children to the debug output. -.PP -This function is useful for debugging, but does nothing if the library has been compiled in release mode (i.e. without debugging information). -.SH "bool QObject::event ( QEvent * e )\fC [virtual]\fR" -This virtual function receives events to an object and should return TRUE if the event \fIe\fR was recognized and processed. -.PP -The event() function can be reimplemented to customize the behavior of an object. -.PP -See also installEventFilter(), timerEvent(), QApplication::sendEvent(), QApplication::postEvent(), and QWidget::event(). -.PP -Reimplemented in QWidget. -.SH "bool QObject::eventFilter ( QObject * watched, QEvent * e )\fC [virtual]\fR" -Filters events if this object has been installed as an event filter for the \fIwatched\fR object. -.PP -In your reimplementation of this function, if you want to filter the event \fIe\fR, out, i.e. stop it being handled further, return TRUE; otherwise return FALSE. -.PP -Example: -.PP -.nf -.br - class MyMainWindow : public QMainWindow -.br - { -.br - public: -.br - MyMainWindow( QWidget *parent = 0, const char *name = 0 ); -.br -.br - protected: -.br - bool eventFilter( QObject *obj, QEvent *ev ); -.br -.br - private: -.br - QTextEdit *textEdit; -.br - }; -.br -.br - MyMainWindow::MyMainWindow( QWidget *parent, const char *name ) -.br - : QMainWindow( parent, name ) -.br - { -.br - textEdit = new QTextEdit( this ); -.br - setCentralWidget( textEdit ); -.br - textEdit->installEventFilter( this ); -.br - } -.br -.br - bool MyMainWindow::eventFilter( QObject *obj, QEvent *ev ) -.br - { -.br - if ( obj == textEdit ) { -.br - if ( e->type() == QEvent::KeyPress ) { -.br - QKeyEvent *k = (QKeyEvent*)ev; -.br - tqDebug( "Ate key press %d", k->key() ); -.br - return TRUE; -.br - } else { -.br - return FALSE; -.br - } -.br - } else { -.br - // pass the event on to the parent class -.br - return QMainWindow::eventFilter( obj, ev ); -.br - } -.br - } -.br -.fi -.PP -Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes. -.PP -\fBWarning:\fR If you delete the receiver object in this function, be sure to return TRUE. Otherwise, Qt will forward the event to the deleted object and the program might crash. -.PP -See also installEventFilter(). -.PP -Reimplemented in QAccel, QScrollView, and QSpinBox. -.SH "bool QObject::highPriority () const" -Returns TRUE if the object is a high-priority object, or FALSE if it is a standard-priority object. -.PP -High-priority objects are placed first in QObject's list of children on the assumption that they will be referenced very often. -.SH "bool QObject::inherits ( const char * clname ) const" -Returns TRUE if this object is an instance of a class that inherits \fIclname\fR, and \fIclname\fR inherits QObject; otherwise returns FALSE. -.PP -A class is considered to inherit itself. -.PP -Example: -.PP -.nf -.br - QTimer *t = new QTimer; // QTimer inherits QObject -.br - t->inherits( "QTimer" ); // returns TRUE -.br - t->inherits( "QObject" ); // returns TRUE -.br - t->inherits( "QButton" ); // returns FALSE -.br -.br - // QScrollBar inherits QWidget and QRangeControl -.br - QScrollBar *s = new QScrollBar( 0 ); -.br - s->inherits( "QWidget" ); // returns TRUE -.br - s->inherits( "QRangeControl" ); // returns FALSE -.br -.fi -.PP -(QRangeControl is not a QObject.) -.PP -See also isA() and metaObject(). -.PP -Examples: -.)l table/statistics/statistics.cpp, themes/metal.cpp, and themes/wood.cpp. -.SH "void QObject::insertChild ( QObject * obj )\fC [virtual]\fR" -Inserts an object \fIobj\fR into the list of child objects. -.PP -\fBWarning:\fR This function cannot be used to make one widget the child widget of another widget. Child widgets can only be created by setting the parent widget in the constructor or by calling QWidget::reparent(). -.PP -See also removeChild() and QWidget::reparent(). -.SH "void QObject::installEventFilter ( const QObject * filterObj )" -Installs an event filter \fIfilterObj\fR on this object. For example: -.PP -.nf -.br - monitoredObj->installEventFilter( filterObj ); -.br -.fi -.PP -An event filter is an object that receives all events that are sent to this object. The filter can either stop the event or forward it to this object. The event filter \fIfilterObj\fR receives events via its eventFilter() function. The eventFilter() function must return TRUE if the event should be filtered, (i.e. stopped); otherwise it must return FALSE. -.PP -If multiple event filters are installed on a single object, the filter that was installed last is activated first. -.PP -Here's a \fCKeyPressEater\fR class that eats the key presses of its monitored objects: -.PP -.nf -.br - class KeyPressEater : public QObject -.br - { -.br - ... -.br - protected: -.br - bool eventFilter( QObject *o, QEvent *e ); -.br - }; -.br -.br - bool KeyPressEater::eventFilter( QObject *o, QEvent *e ) -.br - { -.br - if ( e->type() == QEvent::KeyPress ) { -.br - // special processing for key press -.br - QKeyEvent *k = (QKeyEvent *)e; -.br - tqDebug( "Ate key press %d", k->key() ); -.br - return TRUE; // eat event -.br - } else { -.br - // standard event processing -.br - return FALSE; -.br - } -.br - } -.br -.fi -.PP -And here's how to install it on two widgets: -.PP -.nf -.br - KeyPressEater *keyPressEater = new KeyPressEater( this ); -.br - QPushButton *pushButton = new QPushButton( this ); -.br - QListView *listView = new QListView( this ); -.br -.br - pushButton->installEventFilter( keyPressEater ); -.br - listView->installEventFilter( keyPressEater ); -.br -.fi -.PP -The QAccel class, for example, uses this technique to intercept accelerator key presses. -.PP -\fBWarning:\fR If you delete the receiver object in your eventFilter() function, be sure to return TRUE. If you return FALSE, Qt sends the event to the deleted object and the program will crash. -.PP -See also removeEventFilter(), eventFilter(), and event(). -.SH "bool QObject::isA ( const char * clname ) const" -Returns TRUE if this object is an instance of the class \fIclname\fR; otherwise returns FALSE. -.PP -Example: -.PP -.nf -.br - QTimer *t = new QTimer; // QTimer inherits QObject -.br - t->isA( "QTimer" ); // returns TRUE -.br - t->isA( "QObject" ); // returns FALSE -.br -.fi -.PP -See also inherits() and metaObject(). -.SH "bool QObject::isWidgetType () const" -Returns TRUE if the object is a widget; otherwise returns FALSE. -.PP -Calling this function is equivalent to calling inherits("QWidget"), except that it is much faster. -.SH "void QObject::killTimer ( int id )" -Kills the timer with timer identifier, \fIid\fR. -.PP -The timer identifier is returned by startTimer() when a timer event is started. -.PP -See also timerEvent(), startTimer(), and killTimers(). -.SH "void QObject::killTimers ()" -Kills all timers that this object has started. -.PP -\fBWarning:\fR Using this function can cause hard-to-find bugs: it kills timers started by sub- and superclasses as well as those started by you, which is often not what you want. We recommend using a QTimer or perhaps killTimer(). -.PP -See also timerEvent(), startTimer(), and killTimer(). -.SH "QMetaObject * QObject::metaObject () const\fC [virtual]\fR" -Returns a pointer to the meta object of this object. -.PP -A meta object contains information about a class that inherits QObject, e.g. class name, superclass name, properties, signals and slots. Every class that contains the TQ_OBJECT macro will also have a meta object. -.PP -The meta object information is required by the signal/slot connection mechanism and the property system. The functions isA() and inherits() also make use of the meta object. -.SH "const char * QObject::name () const" -Returns the name of this object. See the "name" property for details. -.SH "const char * QObject::name ( const char * defaultName ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the name of this object, or \fIdefaultName\fR if the object does not have a name. -.SH "QCString QObject::normalizeSignalSlot ( const char * signalSlot )\fC [static protected]\fR" -Normlizes the signal or slot definition \fIsignalSlot\fR by removing unnecessary whitespace. -.SH "const QObjectList * QObject::objectTrees ()\fC [static]\fR" -Returns a pointer to the list of all object trees (their root objects), or 0 if there are no objects. -.PP -The QObjectList class is defined in the ntqobjectlist.h header file. -.PP -The most recent root object created is the first object in the list and the first root object added is the last object in the list. -.PP -See also children(), parent(), insertChild(), and removeChild(). -.SH "QObject * QObject::parent () const" -Returns a pointer to the parent object. -.PP -See also children(). -.SH "QVariant QObject::property ( const char * name ) const\fC [virtual]\fR" -Returns the value of the object's \fIname\fR property. -.PP -If no such property exists, the returned variant is invalid. -.PP -Information about all available properties are provided through the metaObject(). -.PP -See also setProperty(), QVariant::isValid(), metaObject(), QMetaObject::propertyNames(), and QMetaObject::property(). -.PP -Example: qutlook/centralwidget.cpp. -.SH "QObjectList * QObject::queryList ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = TRUE, bool recursiveSearch = TRUE ) const" -Searches the children and optionally grandchildren of this object, and returns a list of those objects that are named or that match \fIobjName\fR and inherit \fIinheritsClass\fR. If \fIinheritsClass\fR is 0 (the default), all classes match. If \fIobjName\fR is 0 (the default), all object names match. -.PP -If \fIregexpMatch\fR is TRUE (the default), \fIobjName\fR is a regular expression that the objects's names must match. The syntax is that of a QRegExp. If \fIregexpMatch\fR is FALSE, \fIobjName\fR is a string and object names must match it exactly. -.PP -Note that \fIinheritsClass\fR uses single inheritance from QObject, the way inherits() does. According to inherits(), QMenuBar inherits QWidget but not QMenuData. This does not quite match reality, but is the best that can be done on the wide variety of compilers Qt supports. -.PP -Finally, if \fIrecursiveSearch\fR is TRUE (the default), queryList() searches \fIn\fRth-generation as well as first-generation children. -.PP -If all this seems a bit complex for your needs, the simpler child() function may be what you want. -.PP -This somewhat contrived example disables all the buttons in this window: -.PP -.nf -.br - QObjectList *l = topLevelWidget()->queryList( "QButton" ); -.br - QObjectListIt it( *l ); // iterate over the buttons -.br - QObject *obj; -.br -.br - while ( (obj = it.current()) != 0 ) { -.br - // for each found object... -.br - ++it; -.br - ((QButton*)obj)->setEnabled( FALSE ); -.br - } -.br - delete l; // delete the list, not the objects -.br -.fi -.PP -The QObjectList class is defined in the ntqobjectlist.h header file. -.PP -\fBWarning:\fR Delete the list as soon you have finished using it. The list contains pointers that may become invalid at almost any time without notice (as soon as the user closes a window you may have dangling pointers, for example). -.PP -See also child(), children(), parent(), inherits(), name, and QRegExp. -.SH "void QObject::removeChild ( QObject * obj )\fC [virtual]\fR" -Removes the child object \fIobj\fR from the list of children. -.PP -\fBWarning:\fR This function will not remove a child widget from the screen. It will only remove it from the parent widget's list of children. -.PP -See also insertChild() and QWidget::reparent(). -.SH "void QObject::removeEventFilter ( const QObject * obj )" -Removes an event filter object \fIobj\fR from this object. The request is ignored if such an event filter has not been installed. -.PP -All event filters for this object are automatically removed when this object is destroyed. -.PP -It is always safe to remove an event filter, even during event filter activation (i.e. from the eventFilter() function). -.PP -See also installEventFilter(), eventFilter(), and event(). -.SH "const QObject * QObject::sender ()\fC [protected]\fR" -Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. The pointer is valid only during the execution of the slot that calls this function. -.PP -The pointer returned by this function becomes invalid if the sender is destroyed, or if the slot is disconnected from the sender's signal. -.PP -\fBWarning:\fR This function violates the object-oriented principle of modularity. However, getting access to the sender might be useful when many signals are connected to a single slot. The sender is undefined if the slot is called as a normal C++ function. -.SH "void QObject::setName ( const char * name )\fC [virtual]\fR" -Sets the object's name to \fIname\fR. -.SH "bool QObject::setProperty ( const char * name, const QVariant & value )\fC [virtual]\fR" -Sets the value of the object's \fIname\fR property to \fIvalue\fR. -.PP -Returns TRUE if the operation was successful; otherwise returns FALSE. -.PP -Information about all available properties is provided through the metaObject(). -.PP -See also property(), metaObject(), QMetaObject::propertyNames(), and QMetaObject::property(). -.PP -Example: qutlook/centralwidget.cpp. -.SH "bool QObject::signalsBlocked () const" -Returns TRUE if signals are blocked; otherwise returns FALSE. -.PP -Signals are not blocked by default. -.PP -See also blockSignals(). -.SH "int QObject::startTimer ( int interval )" -Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. -.PP -A timer event will occur every \fIinterval\fR milliseconds until killTimer() or killTimers() is called. If \fIinterval\fR is 0, then the timer event occurs once every time there are no more window system events to process. -.PP -The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events. -.PP -If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated. -.PP -Example: -.PP -.nf -.br - class MyObject : public QObject -.br - { -.br - TQ_OBJECT -.br - public: -.br - MyObject( QObject *parent = 0, const char *name = 0 ); -.br -.br - protected: -.br - void timerEvent( QTimerEvent * ); -.br - }; -.br -.br - MyObject::MyObject( QObject *parent, const char *name ) -.br - : QObject( parent, name ) -.br - { -.br - startTimer( 50 ); // 50-millisecond timer -.br - startTimer( 1000 ); // 1-second timer -.br - startTimer( 60000 ); // 1-minute timer -.br - } -.br -.br - void MyObject::timerEvent( QTimerEvent *e ) -.br - { -.br - tqDebug( "timer event, id %d", e->timerId() ); -.br - } -.br -.fi -.PP -Note that QTimer's accuracy depends on the underlying operating system and hardware. Most platforms support an accuracy of 20 ms; some provide more. If Qt is unable to deliver the requested number of timer clicks, it will silently discard some. -.PP -The QTimer class provides a high-level programming interface with one-shot timers and timer signals instead of events. -.PP -See also timerEvent(), killTimer(), killTimers(), QEventLoop::awake(), and QEventLoop::aboutToBlock(). -.SH "void QObject::timerEvent ( QTimerEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive timer events for the object. -.PP -QTimer provides a higher-level interface to the timer functionality, and also more general information about timers. -.PP -See also startTimer(), killTimer(), killTimers(), and event(). -.PP -Examples: -.)l biff/biff.cpp, dclock/dclock.cpp, forever/forever.cpp, grapher/grapher.cpp, qmag/qmag.cpp, and xform/xform.cpp. -.SH "QString QObject::tr ( const char * sourceText, const char * comment )\fC [static]\fR" -Returns a translated version of \fIsourceText\fR, or \fIsourceText\fR itself if there is no appropriate translated version. The translation context is QObject with \fIcomment\fR (0 by default). All QObject subclasses using the TQ_OBJECT macro automatically have a reimplementation of this function with the subclass name as context. -.PP -\fBWarning:\fR This method is reentrant only if all translators are installed \fIbefore\fR calling this method. Installing or removing translators while performing translations is not supported. Doing so will probably result in crashes or other undesirable behavior. -.PP -See also trUtf8(), QApplication::translate(), and Internationalization with Qt. -.PP -Example: network/networkprotocol/view.cpp. -.SH "QString QObject::trUtf8 ( const char * sourceText, const char * comment )\fC [static]\fR" -Returns a translated version of \fIsourceText\fR, or QString::fromUtf8(\fIsourceText\fR) if there is no appropriate version. It is otherwise identical to tr(\fIsourceText\fR, \fIcomment\fR). -.PP -\fBWarning:\fR This method is reentrant only if all translators are installed \fIbefore\fR calling this method. Installing or removing translators while performing translations is not supported. Doing so will probably result in crashes or other undesirable behavior. -.PP -See also tr() and QApplication::translate(). -.SS "Property Documentation" -.SH "QCString name" -This property holds the name of this object. -.PP -You can find an object by name (and type) using child(). You can find a set of objects with queryList(). -.PP -The object name is set by the constructor or by the setName() function. The object name is not very useful in the current version of Qt, but will become increasingly important in the future. -.PP -If the object does not have a name, the name() function returns" unnamed", so printf() (used in tqDebug()) will not be asked to output a null pointer. If you want a null pointer to be returned for unnamed objects, you can call name( 0 ). -.PP -.nf -.br - tqDebug( "MyClass::setPrecision(): (%s) invalid precision %f", -.br - name(), newPrecision ); -.br -.fi -.PP -See also className(), child(), and queryList(). -.PP -Set this property's value with setName() and get this property's value with name(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "void * tqt_find_obj_child ( QObject * parent, const char * type, const char * name )" -Returns a pointer to the object named \fIname\fR that inherits \fItype\fR and with a given \fIparent\fR. -.PP -Returns 0 if there is no such child. -.PP -.nf -.br - QListBox *c = (QListBox *) tqt_find_obj_child( myWidget, "QListBox", -.br - "my list box" ); -.br - if ( c ) -.br - c->insertItem( "another string" ); -.br -.fi - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqobject.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qobject.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qobjectcleanuphandler.3qt b/doc/man/man3/qobjectcleanuphandler.3qt deleted file mode 100644 index 2e24bc736..000000000 --- a/doc/man/man3/qobjectcleanuphandler.3qt +++ /dev/null @@ -1,152 +0,0 @@ -'\" t -.TH QObjectCleanupHandler 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 -QObjectCleanupHandler \- Watches the lifetime of multiple QObjects -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQObjectCleanupHandler\fR ()" -.br -.ti -1c -.BI "\fB~QObjectCleanupHandler\fR ()" -.br -.ti -1c -.BI "QObject * \fBadd\fR ( QObject * object )" -.br -.ti -1c -.BI "void \fBremove\fR ( QObject * object )" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QObjectCleanupHandler class watches the lifetime of multiple QObjects. -.PP -A QObjectCleanupHandler is useful whenever you need to know when a number of QObjects that are owned by someone else have been deleted. This is important, for example, when referencing memory in an application that has been allocated in a shared library. -.PP -Example: -.PP -.nf -.br - class FactoryComponent : public FactoryInterface, public QLibraryInterface -.br - { -.br - public: -.br - ... -.br -.br - QObject *createObject(); -.br -.br - bool init(); -.br - void cleanup(); -.br - bool canUnload() const; -.br -.br - private: -.br - QObjectCleanupHandler objects; -.br - }; -.br -.br - // allocate a new object, and add it to the cleanup handler -.br - QObject *FactoryComponent::createObject() -.br - { -.br - return objects.add( new QObject() ); -.br - } -.br -.br - // QLibraryInterface implementation -.br - bool FactoryComponent::init() -.br - { -.br - return TRUE; -.br - } -.br -.br - void FactoryComponent::cleanup() -.br - { -.br - } -.br -.br - // it is only safe to unload the library when all QObject's have been destroyed -.br - bool FactoryComponent::canUnload() const -.br - { -.br - return objects.isEmpty(); -.br - } -.br -.fi -.PP -See also Object Model. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QObjectCleanupHandler::QObjectCleanupHandler ()" -Constructs an empty QObjectCleanupHandler. -.SH "QObjectCleanupHandler::~QObjectCleanupHandler ()" -Destroys the cleanup handler. All objects in this cleanup handler will be deleted. -.SH "QObject * QObjectCleanupHandler::add ( QObject * object )" -Adds \fIobject\fR to this cleanup handler and returns the pointer to the object. -.SH "void QObjectCleanupHandler::clear ()" -Deletes all objects in this cleanup handler. The cleanup handler becomes empty. -.SH "bool QObjectCleanupHandler::isEmpty () const" -Returns TRUE if this cleanup handler is empty or if all objects in this cleanup handler have been destroyed; otherwise return FALSE. -.SH "void QObjectCleanupHandler::remove ( QObject * object )" -Removes the \fIobject\fR from this cleanup handler. The object will -not be destroyed. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqobjectcleanuphandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qobjectcleanuphandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qobjectlist.3qt b/doc/man/man3/qobjectlist.3qt deleted file mode 100644 index 4375b2e96..000000000 --- a/doc/man/man3/qobjectlist.3qt +++ /dev/null @@ -1,81 +0,0 @@ -'\" t -.TH QObjectList 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 -QObjectList \- QPtrList of QObjects -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrList. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQObjectList\fR ()" -.br -.ti -1c -.BI "\fBQObjectList\fR ( const QObjectList & list )" -.br -.ti -1c -.BI "\fB~QObjectList\fR ()" -.br -.ti -1c -.BI "QObjectList & \fBoperator=\fR ( const QObjectList & list )" -.br -.in -1c -.SH DESCRIPTION -The QObjectList class is a QPtrList of QObjects. -.PP -A QObjectList is a QPtrList. The list can be traversed using inherited functions, e.g. getFirst(), next(), etc., or using a QObjectListIterator iterator. -.PP -See QObject::queryList() for an example of use. -.PP -See also QObjectListIterator, QObject, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QObjectList::QObjectList ()" -Constructs an empty QObject list. -.SH "QObjectList::QObjectList ( const QObjectList & list )" -Constructs a copy of \fIlist\fR. -.PP -Each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy). -.SH "QObjectList::~QObjectList ()" -Removes all the object pointers from the list and destroys the list. -.PP -All list iterators that access this list will be reset. -.PP -See also setAutoDelete(). -.SH "QObjectList & QObjectList::operator= ( const QObjectList & list )" -Assigns \fIlist\fR to this list and returns a reference to this list. -.PP -This list is first cleared and then each item in \fIlist\fR is appended to this list. Only the pointers are -copied (shallow copy) unless newItem() has been reimplemented(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqobjectlist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qobjectlist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qobjectlistiterator.3qt b/doc/man/man3/qobjectlistiterator.3qt deleted file mode 100644 index 35a7ae28f..000000000 --- a/doc/man/man3/qobjectlistiterator.3qt +++ /dev/null @@ -1,63 +0,0 @@ -'\" t -.TH QObjectListIterator 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 -QObjectListIterator \- Iterator for QObjectLists -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrListIterator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQObjectListIterator\fR ( const QObjectList & list )" -.br -.ti -1c -.BI "QObjectListIterator & \fBoperator=\fR ( const QObjectListIterator & it )" -.br -.in -1c -.SH DESCRIPTION -The QObjectListIterator class provides an iterator for QObjectLists. -.PP -A QObjectListIterator iterator is a QPtrListIterator. -.PP -See QObject::queryList() for an example of use. -.PP -See also QObjectList, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QObjectListIterator::QObjectListIterator ( const QObjectList & list )" -Constructs an iterator for \fIlist\fR. The current iterator item is set to point on the first item in the \fIlist\fR. -.SH "QObjectListIterator & QObjectListIterator::operator= ( const QObjectListIterator & it )" -Assignment. Makes a copy of the iterator \fIit\fR and returns a -reference to this iterator. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qobjectlistiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qobjectlistiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpaintdevice.3qt b/doc/man/man3/qpaintdevice.3qt deleted file mode 100644 index fd95f0317..000000000 --- a/doc/man/man3/qpaintdevice.3qt +++ /dev/null @@ -1,384 +0,0 @@ -'\" t -.TH QPaintDevice 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 -QPaintDevice \- The base class of objects that can be painted -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QWidget, QPixmap, QPicture, and QPrinter. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QPaintDevice\fR ()" -.br -.ti -1c -.BI "bool \fBisExtDev\fR () const" -.br -.ti -1c -.BI "bool \fBpaintingActive\fR () const" -.br -.ti -1c -.BI "virtual HDC \fBhandle\fR () const" -.br -.ti -1c -.BI "virtual Qt::HANDLE \fBhandle\fR () const" -.br -.ti -1c -.BI "Display * \fBx11Display\fR () const" -.br -.ti -1c -.BI "int \fBx11Screen\fR () const" -.br -.ti -1c -.BI "int \fBx11Depth\fR () const" -.br -.ti -1c -.BI "int \fBx11Cells\fR () const" -.br -.ti -1c -.BI "Qt::HANDLE \fBx11Colormap\fR () const" -.br -.ti -1c -.BI "bool \fBx11DefaultColormap\fR () const" -.br -.ti -1c -.BI "void * \fBx11Visual\fR () const" -.br -.ti -1c -.BI "bool \fBx11DefaultVisual\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "Display * \fBx11AppDisplay\fR ()" -.br -.ti -1c -.BI "int \fBx11AppScreen\fR ()" -.br -.ti -1c -.BI "int \fBx11AppDpiX\fR ()" -.br -.ti -1c -.BI "int \fBx11AppDpiY\fR ()" -.br -.ti -1c -.BI "void \fBx11SetAppDpiX\fR ( int dpi )" -.br -.ti -1c -.BI "void \fBx11SetAppDpiY\fR ( int dpi )" -.br -.ti -1c -.BI "int \fBx11AppDepth\fR ()" -.br -.ti -1c -.BI "int \fBx11AppCells\fR ()" -.br -.ti -1c -.BI "Qt::HANDLE \fBx11AppRootWindow\fR ()" -.br -.ti -1c -.BI "Qt::HANDLE \fBx11AppColormap\fR ()" -.br -.ti -1c -.BI "bool \fBx11AppDefaultColormap\fR ()" -.br -.ti -1c -.BI "void * \fBx11AppVisual\fR ()" -.br -.ti -1c -.BI "bool \fBx11AppDefaultVisual\fR ()" -.br -.ti -1c -.BI "int \fBx11AppDepth\fR ( int screen )" -.br -.ti -1c -.BI "int \fBx11AppCells\fR ( int screen )" -.br -.ti -1c -.BI "Qt::HANDLE \fBx11AppRootWindow\fR ( int screen )" -.br -.ti -1c -.BI "Qt::HANDLE \fBx11AppColormap\fR ( int screen )" -.br -.ti -1c -.BI "void * \fBx11AppVisual\fR ( int screen )" -.br -.ti -1c -.BI "bool \fBx11AppDefaultColormap\fR ( int screen )" -.br -.ti -1c -.BI "bool \fBx11AppDefaultVisual\fR ( int screen )" -.br -.ti -1c -.BI "int \fBx11AppDpiX\fR ( int screen )" -.br -.ti -1c -.BI "int \fBx11AppDpiY\fR ( int screen )" -.br -.ti -1c -.BI "void \fBx11SetAppDpiX\fR ( int dpi, int screen )" -.br -.ti -1c -.BI "void \fBx11SetAppDpiY\fR ( int dpi, int screen )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQPaintDevice\fR ( uint devflags )" -.br -.ti -1c -.BI "virtual bool \fBcmd\fR ( int, QPainter *, QPDevCmdParam * )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "void \fBbitBlt\fR ( QPaintDevice * dst, int dx, int dy, const QPaintDevice * src, int sx, int sy, int sw, int sh, Qt::RasterOp rop, bool ignoreMask )" -.br -.ti -1c -.BI "void \fBbitBlt\fR ( QPaintDevice * dst, const QPoint & dp, const QPaintDevice * src, const QRect & sr, RasterOp rop )" -.br -.in -1c -.SH DESCRIPTION -The QPaintDevice class is the base class of objects that can be painted. -.PP -A paint device is an abstraction of a two-dimensional space that can be drawn using a QPainter. The drawing capabilities are implemented by the subclasses QWidget, QPixmap, QPicture and QPrinter. -.PP -The default coordinate system of a paint device has its origin located at the top-left position. X increases to the right and Y increases downward. The unit is one pixel. There are several ways to set up a user-defined coordinate system using the painter, for example, using QPainter::setWorldMatrix(). -.PP -Example (draw on a paint device): -.PP -.nf -.br - void MyWidget::paintEvent( QPaintEvent * ) -.br - { -.br - QPainter p; // our painter -.br - p.begin( this ); // start painting the widget -.br - p.setPen( red ); // red outline -.br - p.setBrush( yellow ); // yellow fill -.br - p.drawEllipse( 10, 20, 100,100 ); // 100x100 ellipse at position (10, 20) -.br - p.end(); // painting done -.br - } -.br -.fi -.PP -The bit block transfer is an extremely useful operation for copying pixels from one paint device to another (or to itself). It is implemented as the global function bitBlt(). -.PP -Example (scroll widget contents 10 pixels to the right): -.PP -.nf -.br - bitBlt( myWidget, 10, 0, myWidget ); -.br -.fi -.PP -\fBWarning:\fR Qt requires that a QApplication object exists before any paint devices can be created. Paint devices access window system resources, and these resources are not initialized before an application object is created. -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPaintDevice::QPaintDevice ( uint devflags )\fC [protected]\fR" -Constructs a paint device with internal flags \fIdevflags\fR. This constructor can be invoked only from QPaintDevice subclasses. -.SH "QPaintDevice::~QPaintDevice ()\fC [virtual]\fR" -Destroys the paint device and frees window system resources. -.SH "bool QPaintDevice::cmd ( int, QPainter *, QPDevCmdParam * )\fC [virtual protected]\fR" -Internal virtual function that interprets drawing commands from the painter. -.PP -Implemented by subclasses that have no direct support for drawing graphics (external paint devices, for example, QPicture). -.SH "Qt::HANDLE QPaintDevice::handle () const\fC [virtual]\fR" -Returns the window system handle of the paint device, for low-level access. Using this function is not portable. -.PP -The HANDLE type varies with platform; see ntqpaintdevice.h and ntqwindowdefs.h for details. -.PP -See also x11Display(). -.SH "bool QPaintDevice::isExtDev () const" -Returns TRUE if the device is an external paint device; otherwise returns FALSE. -.PP -External paint devices cannot be bitBlt()'ed from. QPicture and QPrinter are external paint devices. -.SH "bool QPaintDevice::paintingActive () const" -Returns TRUE if the device is being painted, i.e. someone has called QPainter::begin() but not yet called QPainter::end() for this device; otherwise returns FALSE. -.PP -See also QPainter::isActive(). -.SH "int QPaintDevice::x11AppCells ()\fC [static]\fR" -Returns the number of entries in the colormap for the default screen of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also x11Colormap(). -.SH "int QPaintDevice::x11AppCells ( int screen )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the number of entries in the colormap for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also x11Colormap(). -.SH "Qt::HANDLE QPaintDevice::x11AppColormap ()\fC [static]\fR" -Returns the colormap for the default screen of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also x11Cells(). -.SH "Qt::HANDLE QPaintDevice::x11AppColormap ( int screen )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the colormap for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also x11Cells(). -.SH "bool QPaintDevice::x11AppDefaultColormap ()\fC [static]\fR" -Returns the default colormap for the default screen of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also x11Cells(). -.SH "bool QPaintDevice::x11AppDefaultColormap ( int screen )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the default colormap for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also x11Cells(). -.SH "bool QPaintDevice::x11AppDefaultVisual ()\fC [static]\fR" -Returns TRUE if the Visual used is the default for the default screen of the X display global to the application (X11 only); otherwise returns FALSE. Using this function is not portable. -.SH "bool QPaintDevice::x11AppDefaultVisual ( int screen )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the Visual used is the default for screen \fIscreen\fR of the X display global to the application (X11 only); otherwise returns FALSE. Using this function is not portable. -.SH "int QPaintDevice::x11AppDepth ( int screen )\fC [static]\fR" -Returns the depth for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also QPixmap::defaultDepth(). -.SH "int QPaintDevice::x11AppDepth ()\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the depth for the default screen of the X display global to the application (X11 only). Using this function is not portable. -.PP -See also QPixmap::defaultDepth(). -.SH "Display * QPaintDevice::x11AppDisplay ()\fC [static]\fR" -Returns a pointer to the X display global to the application (X11 only). Using this function is not portable. -.PP -See also handle(). -.SH "int QPaintDevice::x11AppDpiX ( int screen )\fC [static]\fR" -Returns the horizontal DPI of the X display (X11 only) for screen \fIscreen\fR. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. -.PP -See also x11AppDpiY(), x11SetAppDpiX(), and QPaintDeviceMetrics::logicalDpiX(). -.SH "int QPaintDevice::x11AppDpiX ()\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the horizontal DPI of the X display (X11 only) for the default screen. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. -.SH "int QPaintDevice::x11AppDpiY ( int screen )\fC [static]\fR" -Returns the vertical DPI of the X11 display (X11 only) for screen \fIscreen\fR. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. -.PP -See also x11AppDpiX(), x11SetAppDpiY(), and QPaintDeviceMetrics::logicalDpiY(). -.SH "int QPaintDevice::x11AppDpiY ()\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the vertical DPI of the X11 display (X11 only) for the default screen. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. -.PP -See also x11AppDpiX(), x11SetAppDpiY(), and QPaintDeviceMetrics::logicalDpiY(). -.SH "Qt::HANDLE QPaintDevice::x11AppRootWindow ()\fC [static]\fR" -Returns the root window for the default screen of the X display global to the applicatoin (X11 only). Using this function is not portable. -.SH "Qt::HANDLE QPaintDevice::x11AppRootWindow ( int screen )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the root window for screen \fIscreen\fR of the X display global to the applicatoin (X11 only). Using this function is not portable. -.SH "int QPaintDevice::x11AppScreen ()\fC [static]\fR" -Returns the screen number on the X display global to the application (X11 only). Using this function is not portable. -.SH "void * QPaintDevice::x11AppVisual ()\fC [static]\fR" -Returns the Visual for the default screen of the X display global to the application (X11 only). Using this function is not portable. -.SH "void * QPaintDevice::x11AppVisual ( int screen )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the Visual for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. -.SH "int QPaintDevice::x11Cells () const" -Returns the number of entries in the colormap of the X display for the paint device (X11 only). Using this function is not portable. -.PP -See also x11Colormap(). -.SH "Qt::HANDLE QPaintDevice::x11Colormap () const" -Returns the colormap of the X display for the paint device (X11 only). Using this function is not portable. -.PP -See also x11Cells(). -.SH "bool QPaintDevice::x11DefaultColormap () const" -Returns the default colormap of the X display for the paint device (X11 only). Using this function is not portable. -.PP -See also x11Cells(). -.SH "bool QPaintDevice::x11DefaultVisual () const" -Returns the default Visual of the X display for the paint device (X11 only). Using this function is not portable. -.SH "int QPaintDevice::x11Depth () const" -Returns the depth of the X display for the paint device (X11 only). Using this function is not portable. -.PP -See also QPixmap::defaultDepth(). -.SH "Display * QPaintDevice::x11Display () const" -Returns a pointer to the X display for the paint device (X11 only). Using this function is not portable. -.PP -See also handle(). -.SH "int QPaintDevice::x11Screen () const" -Returns the screen number on the X display for the paint device (X11 only). Using this function is not portable. -.SH "void QPaintDevice::x11SetAppDpiX ( int dpi, int screen )\fC [static]\fR" -Sets the value returned by x11AppDpiX() to \fIdpi\fR for screen \fIscreen\fR. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. -.PP -See also x11SetAppDpiY(). -.SH "void QPaintDevice::x11SetAppDpiX ( int dpi )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the value returned by x11AppDpiX() to \fIdpi\fR for the default screen. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. -.SH "void QPaintDevice::x11SetAppDpiY ( int dpi, int screen )\fC [static]\fR" -Sets the value returned by x11AppDpiY() to \fIdpi\fR for screen \fIscreen\fR. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. -.PP -See also x11SetAppDpiX(). -.SH "void QPaintDevice::x11SetAppDpiY ( int dpi )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the value returned by x11AppDpiY() to \fIdpi\fR for the default screen. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. -.SH "void * QPaintDevice::x11Visual () const" -Returns the Visual of the X display for the paint device (X11 only). Using this function is not portable. -.SH RELATED FUNCTION DOCUMENTATION -.SH "void bitBlt ( QPaintDevice * dst, int dx, int dy, const QPaintDevice * src, int sx, int sy, int sw, int sh, Qt::RasterOp rop, bool ignoreMask )" -Copies a block of pixels from \fIsrc\fR to \fIdst\fR, perhaps merging each pixel according to the raster operation \fIrop\fR. \fIsx\fR, \fIsy\fR is the top-left pixel in \fIsrc\fR (0, 0) by default, \fIdx\fR, \fIdy\fR is the top-left position in \fIdst\fR and \fIsw\fR, \fIsh\fR is the size of the copied block (all of \fIsrc\fR by default). -.PP -The most common values for \fIrop\fR are CopyROP and XorROP; the Qt::RasterOp documentation defines all the possible values. -.PP -If \fIignoreMask\fR is FALSE (the default) and \fIsrc\fR is a masked QPixmap, the entire blit is masked by \fIsrc\fR->mask(). -.PP -If \fIsrc\fR, \fIdst\fR, \fIsw\fR or \fIsh\fR is 0, bitBlt() does nothing. If \fIsw\fR or \fIsh\fR is negative bitBlt() copies starting at \fIsx\fR (and respectively, \fIsy\fR) and ending at the right end (respectively, bottom) of \fIsrc\fR. -.PP -\fIsrc\fR must be a QWidget or QPixmap. You cannot blit from a QPrinter, for example. bitBlt() does nothing if you attempt to blit from an unsupported device. -.PP -bitBlt() does nothing if \fIsrc\fR has a greater depth than \fIdst\fR. If you need to for example, draw a 24-bit pixmap on an 8-bit widget, you must use drawPixmap(). -.SH "void bitBlt ( QPaintDevice * dst, const QPoint & dp, const QPaintDevice * src, const QRect & sr, RasterOp rop )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Overloaded bitBlt() with the destination point \fIdp\fR and source -rectangle \fIsr\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpaintdevice.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpaintdevice.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpaintdevicemetrics.3qt b/doc/man/man3/qpaintdevicemetrics.3qt deleted file mode 100644 index 0db2fe5ab..000000000 --- a/doc/man/man3/qpaintdevicemetrics.3qt +++ /dev/null @@ -1,116 +0,0 @@ -'\" t -.TH QPaintDeviceMetrics 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 -QPaintDeviceMetrics \- Information about a paint device -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPaintDeviceMetrics\fR ( const QPaintDevice * pd )" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "int \fBwidthMM\fR () const" -.br -.ti -1c -.BI "int \fBheightMM\fR () const" -.br -.ti -1c -.BI "int \fBlogicalDpiX\fR () const" -.br -.ti -1c -.BI "int \fBlogicalDpiY\fR () const" -.br -.ti -1c -.BI "int \fBnumColors\fR () const" -.br -.ti -1c -.BI "int \fBdepth\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QPaintDeviceMetrics class provides information about a paint device. -.PP -Sometimes when drawing graphics it is necessary to obtain information about the physical characteristics of a paint device. This class provides the information. For example, to compute the aspect ratio of a paint device: -.PP -.nf -.br - QPaintDeviceMetrics pdm( myWidget ); -.br - double aspect = (double)pdm.widthMM() / (double)pdm.heightMM(); -.br -.fi -.PP -QPaintDeviceMetrics contains methods to provide the width and height of a device in both pixels (width() and height()) and millimeters (widthMM() and heightMM()), the number of colors the device supports (numColors()), the number of bit planes (depth()), and the resolution of the device (logicalDpiX() and logicalDpiY()). -.PP -It is not always possible for QPaintDeviceMetrics to compute the values you ask for, particularly for external devices. The ultimate example is asking for the resolution of of a QPrinter that is set to "print to file": who knows what printer that file will end up on? -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPaintDeviceMetrics::QPaintDeviceMetrics ( const QPaintDevice * pd )" -Constructs a metric for the paint device \fIpd\fR. -.SH "int QPaintDeviceMetrics::depth () const" -Returns the bit depth (number of bit planes) of the paint device. -.SH "int QPaintDeviceMetrics::height () const" -Returns the height of the paint device in default coordinate system units (e.g. pixels for QPixmap and QWidget). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. -.SH "int QPaintDeviceMetrics::heightMM () const" -Returns the height of the paint device, measured in millimeters. -.SH "int QPaintDeviceMetrics::logicalDpiX () const" -Returns the horizontal resolution of the device in dots per inch, which is used when computing font sizes. For X, this is usually the same as could be computed from widthMM(), but it varies on Windows. -.PP -Example: qwerty/qwerty.cpp. -.SH "int QPaintDeviceMetrics::logicalDpiY () const" -Returns the vertical resolution of the device in dots per inch, which is used when computing font sizes. For X, this is usually the same as could be computed from heightMM(), but it varies on Windows. -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "int QPaintDeviceMetrics::numColors () const" -Returns the number of different colors available for the paint device. Since this value is an int will not be sufficient to represent the number of colors on 32 bit displays, in which case INT_MAX is returned instead. -.SH "int QPaintDeviceMetrics::width () const" -Returns the width of the paint device in default coordinate system units (e.g. pixels for QPixmap and QWidget). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. -.SH "int QPaintDeviceMetrics::widthMM () const" -Returns the width of the paint device, measured in millimeters. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpaintdevicemetrics.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpaintdevicemetrics.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpainter.3qt b/doc/man/man3/qpainter.3qt deleted file mode 100644 index 477015ed3..000000000 --- a/doc/man/man3/qpainter.3qt +++ /dev/null @@ -1,1709 +0,0 @@ -'\" t -.TH QPainter 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 -QPainter \- Does low-level painting e.g. on widgets -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -Inherited by QDirectPainter. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBCoordinateMode\fR { CoordDevice, CoordPainter }" -.br -.ti -1c -.BI "\fBQPainter\fR ()" -.br -.ti -1c -.BI "\fBQPainter\fR ( const QPaintDevice * pd, bool unclipped = FALSE )" -.br -.ti -1c -.BI "\fBQPainter\fR ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" -.br -.ti -1c -.BI "\fB~QPainter\fR ()" -.br -.ti -1c -.BI "bool \fBbegin\fR ( const QPaintDevice * pd, bool unclipped = FALSE )" -.br -.ti -1c -.BI "bool \fBbegin\fR ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" -.br -.ti -1c -.BI "bool \fBend\fR ()" -.br -.ti -1c -.BI "QPaintDevice * \fBdevice\fR () const" -.br -.ti -1c -.BI "bool \fBisActive\fR () const" -.br -.ti -1c -.BI "void \fBflush\fR ( const QRegion & region, CoordinateMode cm = CoordDevice )" -.br -.ti -1c -.BI "void \fBflush\fR ()" -.br -.ti -1c -.BI "void \fBsave\fR ()" -.br -.ti -1c -.BI "void \fBrestore\fR ()" -.br -.ti -1c -.BI "QFontMetrics \fBfontMetrics\fR () const" -.br -.ti -1c -.BI "QFontInfo \fBfontInfo\fR () const" -.br -.ti -1c -.BI "const QFont & \fBfont\fR () const" -.br -.ti -1c -.BI "void \fBsetFont\fR ( const QFont & font )" -.br -.ti -1c -.BI "const QPen & \fBpen\fR () const" -.br -.ti -1c -.BI "void \fBsetPen\fR ( const QPen & pen )" -.br -.ti -1c -.BI "void \fBsetPen\fR ( PenStyle style )" -.br -.ti -1c -.BI "void \fBsetPen\fR ( const QColor & color )" -.br -.ti -1c -.BI "const QBrush & \fBbrush\fR () const" -.br -.ti -1c -.BI "void \fBsetBrush\fR ( const QBrush & brush )" -.br -.ti -1c -.BI "void \fBsetBrush\fR ( BrushStyle style )" -.br -.ti -1c -.BI "void \fBsetBrush\fR ( const QColor & color )" -.br -.ti -1c -.BI "QPoint pos () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "const QColor & \fBbackgroundColor\fR () const" -.br -.ti -1c -.BI "void \fBsetBackgroundColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "BGMode \fBbackgroundMode\fR () const" -.br -.ti -1c -.BI "void \fBsetBackgroundMode\fR ( BGMode m )" -.br -.ti -1c -.BI "RasterOp \fBrasterOp\fR () const" -.br -.ti -1c -.BI "void \fBsetRasterOp\fR ( RasterOp r )" -.br -.ti -1c -.BI "const QPoint & \fBbrushOrigin\fR () const" -.br -.ti -1c -.BI "void \fBsetBrushOrigin\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBsetBrushOrigin\fR ( const QPoint & p )" -.br -.ti -1c -.BI "bool \fBhasViewXForm\fR () const" -.br -.ti -1c -.BI "bool \fBhasWorldXForm\fR () const" -.br -.ti -1c -.BI "void \fBsetViewXForm\fR ( bool enable )" -.br -.ti -1c -.BI "QRect \fBwindow\fR () const" -.br -.ti -1c -.BI "void \fBsetWindow\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBsetWindow\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "QRect \fBviewport\fR () const" -.br -.ti -1c -.BI "void \fBsetViewport\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBsetViewport\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBsetWorldXForm\fR ( bool enable )" -.br -.ti -1c -.BI "const QWMatrix & \fBworldMatrix\fR () const" -.br -.ti -1c -.BI "void \fBsetWorldMatrix\fR ( const QWMatrix & m, bool combine = FALSE )" -.br -.ti -1c -.BI "void saveWorldMatrix () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void restoreWorldMatrix () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBscale\fR ( double sx, double sy )" -.br -.ti -1c -.BI "void \fBshear\fR ( double sh, double sv )" -.br -.ti -1c -.BI "void \fBrotate\fR ( double a )" -.br -.ti -1c -.BI "void \fBtranslate\fR ( double dx, double dy )" -.br -.ti -1c -.BI "void \fBresetXForm\fR ()" -.br -.ti -1c -.BI "QPoint \fBxForm\fR ( const QPoint & pv ) const" -.br -.ti -1c -.BI "QRect \fBxForm\fR ( const QRect & rv ) const" -.br -.ti -1c -.BI "QPointArray \fBxForm\fR ( const QPointArray & av ) const" -.br -.ti -1c -.BI "QPointArray \fBxForm\fR ( const QPointArray & av, int index, int npoints ) const" -.br -.ti -1c -.BI "QPoint \fBxFormDev\fR ( const QPoint & pd ) const" -.br -.ti -1c -.BI "QRect \fBxFormDev\fR ( const QRect & rd ) const" -.br -.ti -1c -.BI "QPointArray \fBxFormDev\fR ( const QPointArray & ad ) const" -.br -.ti -1c -.BI "QPointArray \fBxFormDev\fR ( const QPointArray & ad, int index, int npoints ) const" -.br -.ti -1c -.BI "void \fBsetClipping\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBhasClipping\fR () const" -.br -.ti -1c -.BI "QRegion \fBclipRegion\fR ( CoordinateMode m = CoordDevice ) const" -.br -.ti -1c -.BI "void \fBsetClipRect\fR ( const QRect & r, CoordinateMode m = CoordDevice )" -.br -.ti -1c -.BI "void \fBsetClipRect\fR ( int x, int y, int w, int h, CoordinateMode m = CoordDevice )" -.br -.ti -1c -.BI "void \fBsetClipRegion\fR ( const QRegion & rgn, CoordinateMode m = CoordDevice )" -.br -.ti -1c -.BI "void \fBdrawPoint\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBdrawPoint\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBdrawPoints\fR ( const QPointArray & a, int index = 0, int npoints = -1 )" -.br -.ti -1c -.BI "void moveTo ( int x, int y ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void moveTo ( const QPoint & p ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void lineTo ( int x, int y ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void lineTo ( const QPoint & p ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBdrawLine\fR ( int x1, int y1, int x2, int y2 )" -.br -.ti -1c -.BI "void \fBdrawLine\fR ( const QPoint & p1, const QPoint & p2 )" -.br -.ti -1c -.BI "void \fBdrawRect\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBdrawRect\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBdrawWinFocusRect\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBdrawWinFocusRect\fR ( int x, int y, int w, int h, const QColor & bgColor )" -.br -.ti -1c -.BI "void \fBdrawWinFocusRect\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBdrawWinFocusRect\fR ( const QRect & r, const QColor & bgColor )" -.br -.ti -1c -.BI "void \fBdrawRoundRect\fR ( int x, int y, int w, int h, int xRnd = 25, int yRnd = 25 )" -.br -.ti -1c -.BI "void \fBdrawRoundRect\fR ( const QRect & r, int xRnd = 25, int yRnd = 25 )" -.br -.ti -1c -.BI "void \fBdrawEllipse\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBdrawEllipse\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBdrawArc\fR ( int x, int y, int w, int h, int a, int alen )" -.br -.ti -1c -.BI "void \fBdrawArc\fR ( const QRect & r, int a, int alen )" -.br -.ti -1c -.BI "void \fBdrawPie\fR ( int x, int y, int w, int h, int a, int alen )" -.br -.ti -1c -.BI "void \fBdrawPie\fR ( const QRect & r, int a, int alen )" -.br -.ti -1c -.BI "void \fBdrawChord\fR ( int x, int y, int w, int h, int a, int alen )" -.br -.ti -1c -.BI "void \fBdrawChord\fR ( const QRect & r, int a, int alen )" -.br -.ti -1c -.BI "void \fBdrawLineSegments\fR ( const QPointArray & a, int index = 0, int nlines = -1 )" -.br -.ti -1c -.BI "void \fBdrawPolyline\fR ( const QPointArray & a, int index = 0, int npoints = -1 )" -.br -.ti -1c -.BI "void \fBdrawPolygon\fR ( const QPointArray & a, bool winding = FALSE, int index = 0, int npoints = -1 )" -.br -.ti -1c -.BI "void \fBdrawConvexPolygon\fR ( const QPointArray & pa, int index = 0, int npoints = -1 )" -.br -.ti -1c -.BI "void \fBdrawCubicBezier\fR ( const QPointArray & a, int index = 0 )" -.br -.ti -1c -.BI "void \fBdrawPixmap\fR ( int x, int y, const QPixmap & pixmap, int sx = 0, int sy = 0, int sw = -1, int sh = -1 )" -.br -.ti -1c -.BI "void \fBdrawPixmap\fR ( const QPoint & p, const QPixmap & pm, const QRect & sr )" -.br -.ti -1c -.BI "void \fBdrawPixmap\fR ( const QPoint & p, const QPixmap & pm )" -.br -.ti -1c -.BI "void \fBdrawPixmap\fR ( const QRect & r, const QPixmap & pm )" -.br -.ti -1c -.BI "void \fBdrawImage\fR ( int x, int y, const QImage & image, int sx = 0, int sy = 0, int sw = -1, int sh = -1, int conversionFlags = 0 )" -.br -.ti -1c -.BI "void \fBdrawImage\fR ( const QPoint &, const QImage &, const QRect & sr, int conversionFlags = 0 )" -.br -.ti -1c -.BI "void \fBdrawImage\fR ( const QPoint & p, const QImage & i, int conversion_flags = 0 )" -.br -.ti -1c -.BI "void \fBdrawImage\fR ( const QRect & r, const QImage & i )" -.br -.ti -1c -.BI "void \fBdrawTiledPixmap\fR ( int x, int y, int w, int h, const QPixmap & pixmap, int sx = 0, int sy = 0 )" -.br -.ti -1c -.BI "void \fBdrawTiledPixmap\fR ( const QRect & r, const QPixmap & pm, const QPoint & sp )" -.br -.ti -1c -.BI "void \fBdrawTiledPixmap\fR ( const QRect & r, const QPixmap & pm )" -.br -.ti -1c -.BI "void drawPicture ( const QPicture & pic ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBdrawPicture\fR ( int x, int y, const QPicture & pic )" -.br -.ti -1c -.BI "void \fBdrawPicture\fR ( const QPoint & p, const QPicture & pic )" -.br -.ti -1c -.BI "void \fBfillRect\fR ( int x, int y, int w, int h, const QBrush & brush )" -.br -.ti -1c -.BI "void \fBfillRect\fR ( const QRect & r, const QBrush & brush )" -.br -.ti -1c -.BI "void \fBeraseRect\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBeraseRect\fR ( const QRect & r )" -.br -.ti -1c -.BI "enum \fBTextDirection\fR { Auto, RTL, LTR }" -.br -.ti -1c -.BI "void \fBdrawText\fR ( int x, int y, const QString &, int len = -1, TextDirection dir = Auto )" -.br -.ti -1c -.BI "void \fBdrawText\fR ( const QPoint &, const QString &, int len = -1, TextDirection dir = Auto )" -.br -.ti -1c -.BI "void \fBdrawText\fR ( int x, int y, const QString &, int pos, int len, TextDirection dir = Auto )" -.br -.ti -1c -.BI "void \fBdrawText\fR ( const QPoint & p, const QString &, int pos, int len, TextDirection dir = Auto )" -.br -.ti -1c -.BI "void \fBdrawText\fR ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QRect * br = 0, QTextParag ** internal = 0 )" -.br -.ti -1c -.BI "void \fBdrawText\fR ( const QRect & r, int tf, const QString & str, int len = -1, QRect * brect = 0, QTextParag ** internal = 0 )" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QTextParag ** intern = 0 )" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR ( const QRect & r, int flags, const QString & str, int len = -1, QTextParag ** internal = 0 )" -.br -.ti -1c -.BI "int \fBtabStops\fR () const" -.br -.ti -1c -.BI "void \fBsetTabStops\fR ( int ts )" -.br -.ti -1c -.BI "int * \fBtabArray\fR () const" -.br -.ti -1c -.BI "void \fBsetTabArray\fR ( int * ta )" -.br -.ti -1c -.BI "HDC \fBhandle\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBredirect\fR ( QPaintDevice * pdev, QPaintDevice * replacement )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "void \fBqDrawShadeLine\fR ( QPainter * p, int x1, int y1, int x2, int y2, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth )" -.br -.ti -1c -.BI "void \fBqDrawShadeRect\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth, const QBrush * fill )" -.br -.ti -1c -.BI "void \fBqDrawShadePanel\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, const QBrush * fill )" -.br -.ti -1c -.BI "void \fBqDrawWinButton\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" -.br -.ti -1c -.BI "void \fBqDrawWinPanel\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" -.br -.ti -1c -.BI "void \fBqDrawPlainRect\fR ( QPainter * p, int x, int y, int w, int h, const QColor & c, int lineWidth, const QBrush * fill )" -.br -.in -1c -.SH DESCRIPTION -The QPainter class does low-level painting e.g. on widgets. -.PP -The painter provides highly optimized functions to do most of the drawing GUI programs require. QPainter can draw everything from simple lines to complex shapes like pies and chords. It can also draw aligned text and pixmaps. Normally, it draws in a "natural" coordinate system, but it can also do view and world transformation. -.PP -The typical use of a painter is: -.TP -Construct a painter. -.TP -Set a pen, a brush etc. -.TP -Draw. -.TP -Destroy the painter. -.PP -Mostly, all this is done inside a paint event. (In fact, 99% of all QPainter use is in a reimplementation of QWidget::paintEvent(), and the painter is heavily optimized for such use.) Here's one very simple example: -.PP -.nf -.br - void SimpleExampleWidget::paintEvent() -.br - { -.br - QPainter paint( this ); -.br - paint.setPen( Qt::blue ); -.br - paint.drawText( rect(), AlignCenter, "The Text" ); -.br - } -.br -.fi -.PP -Usage is simple, and there are many settings you can use: -.IP -.TP -font() is the currently set font. If you set a font that isn't available, Qt finds a close match. In fact font() returns what you set using setFont() and fontInfo() returns the font actually being used (which may be the same). -.IP -.TP -brush() is the currently set brush; the color or pattern that's used for filling e.g. circles. -.IP -.TP -pen() is the currently set pen; the color or stipple that's used for drawing lines or boundaries. -.IP -.TP -backgroundMode() is \fCOpaque\fR or \fCTransparent\fR, i.e. whether backgroundColor() is used or not. -.IP -.TP -backgroundColor() only applies when backgroundMode() is Opaque and pen() is a stipple. In that case, it describes the color of the background pixels in the stipple. -.IP -.TP -rasterOp() is how pixels drawn interact with the pixels already there. -.IP -.TP -brushOrigin() is the origin of the tiled brushes, normally the origin of the window. -.IP -.TP -viewport(), window(), worldMatrix() and many more make up the painter's coordinate transformation system. See The Coordinate System for an explanation of this, or see below for a very brief overview of the functions. -.IP -.TP -hasClipping() is whether the painter clips at all. (The paint device clips, too.) If the painter clips, it clips to clipRegion(). -.IP -.TP -pos() is the current position, set by moveTo() and used by lineTo(). -.IP -.PP -Note that some of these settings mirror settings in some paint devices, e.g. QWidget::font(). QPainter::begin() (or the QPainter constructor) copies these attributes from the paint device. Calling, for example, QWidget::setFont() doesn't take effect until the next time a painter begins painting on it. -.PP -save() saves all of these settings on an internal stack, restore() pops them back. -.PP -The core functionality of QPainter is drawing, and there are functions to draw most primitives: drawPoint(), drawPoints(), drawLine(), drawRect(), drawWinFocusRect(), drawRoundRect(), drawEllipse(), drawArc(), drawPie(), drawChord(), drawLineSegments(), drawPolyline(), drawPolygon(), drawConvexPolygon() and drawCubicBezier(). All of these functions take integer coordinates; there are no floating-point versions since we want drawing to be as fast as possible. -.PP -There are functions to draw pixmaps/images, namely drawPixmap(), drawImage() and drawTiledPixmap(). drawPixmap() and drawImage() produce the same result, except that drawPixmap() is faster on-screen and drawImage() faster and sometimes better on QPrinter and QPicture. -.PP -Text drawing is done using drawText(), and when you need fine-grained positioning, boundingRect() tells you where a given drawText() command would draw. -.PP -There is a drawPicture() function that draws the contents of an entire QPicture using this painter. drawPicture() is the only function that disregards all the painter's settings: the QPicture has its own settings. -.PP -Normally, the QPainter operates on the device's own coordinate system (usually pixels), but QPainter has good support for coordinate transformation. See The Coordinate System for a more general overview and a simple example. -.PP -The most common functions used are scale(), rotate(), translate() and shear(), all of which operate on the worldMatrix(). setWorldMatrix() can replace or add to the currently set worldMatrix(). -.PP -setViewport() sets the rectangle on which QPainter operates. The default is the entire device, which is usually fine, except on printers. setWindow() sets the coordinate system, that is, the rectangle that maps to viewport(). What's drawn inside the window() ends up being inside the viewport(). The window's default is the same as the viewport, and if you don't use the transformations, they are optimized away, gaining another little bit of speed. -.PP -After all the coordinate transformation is done, QPainter can clip the drawing to an arbitrary rectangle or region. hasClipping() is TRUE if QPainter clips, and clipRegion() returns the clip region. You can set it using either setClipRegion() or setClipRect(). Note that the clipping can be slow. It's all system-dependent, but as a rule of thumb, you can assume that drawing speed is inversely proportional to the number of rectangles in the clip region. -.PP -After QPainter's clipping, the paint device may also clip. For example, most widgets clip away the pixels used by child widgets, and most printers clip away an area near the edges of the paper. This additional clipping is not reflected by the return value of clipRegion() or hasClipping(). -.PP -QPainter also includes some less-used functions that are very useful on those occasions when they're needed. -.PP -isActive() indicates whether the painter is active. begin() (and the most usual constructor) makes it active. end() (and the destructor) deactivates it. If the painter is active, device() returns the paint device on which the painter paints. -.PP -Sometimes it is desirable to make someone else paint on an unusual QPaintDevice. QPainter supports a static function to do this, redirect(). We recommend not using it, but for some hacks it's perfect. -.PP -setTabStops() and setTabArray() can change where the tab stops are, but these are very seldomly used. -.PP -\fBWarning:\fR Note that QPainter does not attempt to work around coordinate limitations in the underlying window system. Some platforms may behave incorrectly with coordinates as small as +/-4000. -.PP -See also QPaintDevice, QWidget, QPixmap, QPrinter, QPicture, Application Walkthrough, Coordinate System Overview, Graphics Classes, and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QPainter::CoordinateMode" -.TP -\fCQPainter::CoordDevice\fR -.TP -\fCQPainter::CoordPainter\fR -.PP -See also clipRegion(). -.SH "QPainter::TextDirection" -.TP -\fCQPainter::Auto\fR -.TP -\fCQPainter::RTL\fR - right to left -.TP -\fCQPainter::LTR\fR - left to right -.PP -See also drawText(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPainter::QPainter ()" -Constructs a painter. -.PP -Notice that all painter settings (setPen, setBrush etc.) are reset to default values when begin() is called. -.PP -See also begin() and end(). -.SH "QPainter::QPainter ( const QPaintDevice * pd, bool unclipped = FALSE )" -Constructs a painter that begins painting the paint device \fIpd\fR immediately. Depending on the underlying graphic system the painter will paint over children of the paintdevice if \fIunclipped\fR is TRUE. -.PP -This constructor is convenient for short-lived painters, e.g. in a paint event and should be used only once. The constructor calls begin() for you and the QPainter destructor automatically calls end(). -.PP -Here's an example using begin() and end(): -.PP -.nf -.br - void MyWidget::paintEvent( QPaintEvent * ) -.br - { -.br - QPainter p; -.br - p.begin( this ); -.br - p.drawLine( ... ); // drawing code -.br - p.end(); -.br - } -.br -.fi -.PP -The same example using this constructor: -.PP -.nf -.br - void MyWidget::paintEvent( QPaintEvent * ) -.br - { -.br - QPainter p( this ); -.br - p.drawLine( ... ); // drawing code -.br - } -.br -.fi -.PP -Since the constructor cannot provide feedback when the initialization of the painter failed you should rather use begin() and end() to paint on external devices, e.g. printers. -.PP -See also begin() and end(). -.SH "QPainter::QPainter ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" -Constructs a painter that begins painting the paint device \fIpd\fR immediately, with the default arguments taken from \fIcopyAttributes\fR. The painter will paint over children of the paint device if \fIunclipped\fR is TRUE (although this is not supported on all platforms). -.PP -See also begin(). -.SH "QPainter::~QPainter ()" -Destroys the painter. -.SH "const QColor & QPainter::backgroundColor () const" -Returns the current background color. -.PP -See also setBackgroundColor() and QColor. -.SH "BGMode QPainter::backgroundMode () const" -Returns the current background mode. -.PP -See also setBackgroundMode() and BGMode. -.SH "bool QPainter::begin ( const QPaintDevice * pd, bool unclipped = FALSE )" -Begins painting the paint device \fIpd\fR and returns TRUE if successful; otherwise returns FALSE. If \fIunclipped\fR is TRUE, the painting will not be clipped at the paint device's boundaries, (although this is not supported by all platforms). -.PP -The errors that can occur are serious problems, such as these: -.PP -.nf -.br - p->begin( 0 ); // impossible - paint device cannot be 0 -.br -.br - QPixmap pm( 0, 0 ); -.br - p->begin( pm ); // impossible - pm.isNull(); -.br -.br - p->begin( myWidget ); -.br - p2->begin( myWidget ); // impossible - only one painter at a time -.br -.fi -.PP -Note that most of the time, you can use one of the constructors instead of begin(), and that end() is automatically done at destruction. -.PP -\fBWarning:\fR A paint device can only be painted by one painter at a time. -.PP -See also end() and flush(). -.PP -Examples: -.)l aclock/aclock.cpp, desktop/desktop.cpp, drawdemo/drawdemo.cpp, hello/hello.cpp, picture/picture.cpp, t10/cannon.cpp, and xform/xform.cpp. -.SH "bool QPainter::begin ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version opens the painter on a paint device \fIpd\fR and sets the initial pen, background color and font from \fIcopyAttributes\fR, painting over the paint device's children when \fIunclipped\fR is TRUE. This is equivalent to: -.PP -.nf -.br - QPainter p; -.br - p.begin( pd ); -.br - p.setPen( copyAttributes->foregroundColor() ); -.br - p.setBackgroundColor( copyAttributes->backgroundColor() ); -.br - p.setFont( copyAttributes->font() ); -.br -.fi -.PP -This begin function is convenient for double buffering. When you draw in a pixmap instead of directly in a widget (to later bitBlt the pixmap into the widget) you will need to set the widget's font etc. This function does exactly that. -.PP -Example: -.PP -.nf -.br - void MyWidget::paintEvent( QPaintEvent * ) -.br - { -.br - QPixmap pm(size()); -.br - QPainter p; -.br - p.begin(&pm, this); -.br - // ... potentially flickering paint operation ... -.br - p.end(); -.br - bitBlt(this, 0, 0, &pm); -.br - } -.br -.fi -.PP -See also end(). -.SH "QRect QPainter::boundingRect ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QTextParag ** intern = 0 )" -Returns the bounding rectangle of the aligned text that would be printed with the corresponding drawText() function using the first \fIlen\fR characters of the string if \fIlen\fR is > -1, or the whole of the string if \fIlen\fR is -1. The drawing, and hence the bounding rectangle, is constrained to the rectangle that begins at point \fI(x, y)\fR with width \fIw\fR and hight \fIh\fR, or to the rectangle required to draw the text, whichever is the larger. -.PP -The \fIflags\fR argument is the bitwise OR of the following flags:
                                        .nf -.TS -l - l. Flag Meaning AlignAuto aligns according to the language, usually left. AlignLeft aligns to the left border. AlignRight aligns to the right border. AlignHCenter aligns horizontally centered. AlignTop aligns to the top border. AlignBottom aligns to the bottom border. AlignVCenter aligns vertically centered. AlignCenter (== AlignHCenter | AlignVCenter). SingleLine ignores newline characters in the text. ExpandTabs expands tabs. ShowPrefix interprets "&x" as " WordBreak -.TE -.fi -
                                        -.PP -Horizontal alignment defaults to AlignLeft and vertical alignment defaults to AlignTop. -.PP -If several of the horizontal or several of the vertical alignment flags are set, the resulting alignment is undefined. -.PP -The \fIintern\fR parameter should not be used. -.PP -See also Qt::TextFlags. -.SH "QRect QPainter::boundingRect ( const QRect & r, int flags, const QString & str, int len = -1, QTextParag ** internal = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the bounding rectangle of the aligned text that would be printed with the corresponding drawText() function using the first \fIlen\fR characters from \fIstr\fR if \fIlen\fR is > -1, or the whole of \fIstr\fR if \fIlen\fR is -1. The drawing, and hence the bounding rectangle, is constrained to the rectangle \fIr\fR, or to the rectangle required to draw the text, whichever is the larger. -.PP -The \fIinternal\fR parameter should not be used. -.PP -See also drawText(), fontMetrics(), QFontMetrics::boundingRect(), and Qt::TextFlags. -.SH "const QBrush & QPainter::brush () const" -Returns the painter's current brush. -.PP -See also QPainter::setBrush(). -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QPoint & QPainter::brushOrigin () const" -Returns the brush origin currently set. -.PP -See also setBrushOrigin(). -.SH "QRegion QPainter::clipRegion ( CoordinateMode m = CoordDevice ) const" -Returns the currently set clip region. Note that the clip region is given in physical device coordinates and \fInot\fR subject to any coordinate transformation if \fIm\fR is equal to CoordDevice (the default). If \fIm\fR equals CoordPainter the returned region is in model coordinates. -.PP -See also setClipRegion(), setClipRect(), setClipping(), and QPainter::CoordinateMode. -.PP -Example: themes/wood.cpp. -.SH "QPaintDevice * QPainter::device () const" -Returns the paint device on which this painter is currently painting, or 0 if the painter is not active. -.PP -See also QPaintDevice::paintingActive(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, listboxcombo/listboxcombo.cpp, and mdi/application.cpp. -.SH "void QPainter::drawArc ( int x, int y, int w, int h, int a, int alen )" -Draws an arc defined by the rectangle \fI(x, y, w, h)\fR, the start angle \fIa\fR and the arc length \fIalen\fR. -.PP -The angles \fIa\fR and \fIalen\fR are 1/16th of a degree, i.e. a full circle equals 5760 (16*360). Positive values of \fIa\fR and \fIalen\fR mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. -.PP -Example: -.PP -.nf -.br - QPainter p( myWidget ); -.br - p.drawArc( 10,10, 70,100, 100*16, 160*16 ); // draws a "(" arc -.br -.fi -.PP -See also drawPie() and drawChord(). -.SH "void QPainter::drawArc ( const QRect & r, int a, int alen )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the arc that fits inside the rectangle \fIr\fR with start angle \fIa\fR and arc length \fIalen\fR. -.SH "void QPainter::drawChord ( int x, int y, int w, int h, int a, int alen )" -Draws a chord defined by the rectangle \fI(x, y, w, h)\fR, the start angle \fIa\fR and the arc length \fIalen\fR. -.PP -The chord is filled with the current brush(). -.PP -The angles \fIa\fR and \fIalen\fR are 1/16th of a degree, i.e. a full circle equals 5760 (16*360). Positive values of \fIa\fR and \fIalen\fR mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. -.PP -See also drawArc() and drawPie(). -.SH "void QPainter::drawChord ( const QRect & r, int a, int alen )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a chord that fits inside the rectangle \fIr\fR with start angle \fIa\fR and arc length \fIalen\fR. -.SH "void QPainter::drawConvexPolygon ( const QPointArray & pa, int index = 0, int npoints = -1 )" -Draws the convex polygon defined by the \fInpoints\fR points in \fIpa\fR starting at \fIpa[index]\fR (\fIindex\fR defaults to 0). -.PP -If the supplied polygon is not convex, the results are undefined. -.PP -On some platforms (e.g. X Window), this is faster than drawPolygon(). -.PP -\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. -.PP -Example: aclock/aclock.cpp. -.SH "void QPainter::drawCubicBezier ( const QPointArray & a, int index = 0 )" -Draws a cubic Bezier curve defined by the control points in \fIa\fR, starting at \fIa[index]\fR (\fIindex\fR defaults to 0). -.PP -Control points after \fIa[index + 3]\fR are ignored. Nothing happens if there aren't enough control points. -.PP -\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. -.SH "void QPainter::drawEllipse ( int x, int y, int w, int h )" -Draws an ellipse with center at \fI(x + w/2, y + h/2)\fR and size \fI(w, h)\fR. -.PP -Examples: -.)l drawdemo/drawdemo.cpp, multiple/ax2.h, picture/picture.cpp, and tictac/tictac.cpp. -.SH "void QPainter::drawEllipse ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the ellipse that fits inside rectangle \fIr\fR. -.SH "void QPainter::drawImage ( int x, int y, const QImage & image, int sx = 0, int sy = 0, int sw = -1, int sh = -1, int conversionFlags = 0 )" -Draws at (\fIx\fR, \fIy\fR) the \fIsw\fR by \fIsh\fR area of pixels from (\fIsx\fR, \fIsy\fR) in \fIimage\fR, using \fIconversionFlags\fR if the image needs to be converted to a pixmap. The default value for \fIconversionFlags\fR is 0; see convertFromImage() for information about what other values do. -.PP -This function may convert \fIimage\fR to a pixmap and then draw it, if device() is a QPixmap or a QWidget, or else draw it directly, if device() is a QPrinter or QPicture. -.PP -Currently alpha masks of the image are ignored when painting on a QPrinter. -.PP -See also drawPixmap() and QPixmap::convertFromImage(). -.PP -Example: canvas/canvas.cpp. -.SH "void QPainter::drawImage ( const QPoint &, const QImage &, const QRect & sr, int conversionFlags = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the rectangle \fIsr\fR from the image at the given point. -.SH "void QPainter::drawImage ( const QPoint & p, const QImage & i, int conversion_flags = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the image \fIi\fR at point \fIp\fR. -.PP -If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. -.PP -See also Qt::ImageConversionFlags. -.SH "void QPainter::drawImage ( const QRect & r, const QImage & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the image \fIi\fR into the rectangle \fIr\fR. The image will be scaled to fit the rectangle if image and rectangle dimensions differ. -.SH "void QPainter::drawLine ( int x1, int y1, int x2, int y2 )" -Draws a line from (\fIx1\fR, \fIy1\fR) to (\fIx2\fR, \fIy2\fR) and sets the current pen position to (\fIx2\fR, \fIy2\fR). -.PP -See also pen(). -.PP -Examples: -.)l aclock/aclock.cpp, drawlines/connect.cpp, progress/progress.cpp, splitter/splitter.cpp, themes/metal.cpp, and themes/wood.cpp. -.SH "void QPainter::drawLine ( const QPoint & p1, const QPoint & p2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a line from point \fIp1\fR to point \fIp2\fR. -.SH "void QPainter::drawLineSegments ( const QPointArray & a, int index = 0, int nlines = -1 )" -Draws \fInlines\fR separate lines from points defined in \fIa\fR, starting at \fIa[index]\fR (\fIindex\fR defaults to 0). If \fInlines\fR is -1 (the default) all points until the end of the array are used (i.e. (a.size()-index)/2 lines are drawn). -.PP -Draws the 1st line from \fIa[index]\fR to \fIa[index+1]\fR. Draws the 2nd line from \fIa[index+2]\fR to \fIa[index+3]\fR etc. -.PP -\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. -.PP -See also drawPolyline(), drawPolygon(), and QPen. -.SH "void QPainter::drawPicture ( int x, int y, const QPicture & pic )" -Replays the picture \fIpic\fR translated by (\fIx\fR, \fIy\fR). -.PP -This function does exactly the same as QPicture::play() when called with (\fIx\fR, \fIy\fR) = (0, 0). -.PP -Examples: -.)l picture/picture.cpp and xform/xform.cpp. -.SH "void QPainter::drawPicture ( const QPicture & pic )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use one of the other QPainter::drawPicture() functions with a (0, 0) offset instead. -.SH "void QPainter::drawPicture ( const QPoint & p, const QPicture & pic )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws picture \fIpic\fR at point \fIp\fR. -.SH "void QPainter::drawPie ( int x, int y, int w, int h, int a, int alen )" -Draws a pie defined by the rectangle \fI(x, y, w, h)\fR, the start angle \fIa\fR and the arc length \fIalen\fR. -.PP -The pie is filled with the current brush(). -.PP -The angles \fIa\fR and \fIalen\fR are 1/16th of a degree, i.e. a full circle equals 5760 (16*360). Positive values of \fIa\fR and \fIalen\fR mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. -.PP -See also drawArc() and drawChord(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp, grapher/grapher.cpp, t10/cannon.cpp, and t9/cannon.cpp. -.SH "void QPainter::drawPie ( const QRect & r, int a, int alen )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a pie segment that fits inside the rectangle \fIr\fR with start angle \fIa\fR and arc length \fIalen\fR. -.SH "void QPainter::drawPixmap ( int x, int y, const QPixmap & pixmap, int sx = 0, int sy = 0, int sw = -1, int sh = -1 )" -Draws a pixmap at \fI(x, y)\fR by copying a part of \fIpixmap\fR into the paint device. -.PP -\fI(x, y)\fR specifies the top-left point in the paint device that is to be drawn onto. \fI(sx, sy)\fR specifies the top-left point in \fIpixmap\fR that is to be drawn. The default is (0, 0). -.PP -\fI(sw, sh)\fR specifies the size of the pixmap that is to be drawn. The default, (-1, -1), means all the way to the bottom right of the pixmap. -.PP -Currently the mask of the pixmap or it's alpha channel are ignored when painting on a QPrinter. -.PP -See also bitBlt() and QPixmap::setMask(). -.PP -Examples: -.)l grapher/grapher.cpp, picture/picture.cpp, qdir/qdir.cpp, qmag/qmag.cpp, showimg/showimg.cpp, t10/cannon.cpp, and xform/xform.cpp. -.SH "void QPainter::drawPixmap ( const QPoint & p, const QPixmap & pm, const QRect & sr )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the rectangle \fIsr\fR of pixmap \fIpm\fR with its origin at point \fIp\fR. -.SH "void QPainter::drawPixmap ( const QPoint & p, const QPixmap & pm )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the pixmap \fIpm\fR with its origin at point \fIp\fR. -.SH "void QPainter::drawPixmap ( const QRect & r, const QPixmap & pm )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the pixmap \fIpm\fR into the rectangle \fIr\fR. The pixmap is scaled to fit the rectangle, if image and rectangle size disagree. -.SH "void QPainter::drawPoint ( int x, int y )" -Draws/plots a single point at \fI(x, y)\fR using the current pen. -.PP -See also QPen. -.PP -Examples: -.)l desktop/desktop.cpp and drawlines/connect.cpp. -.SH "void QPainter::drawPoint ( const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the point \fIp\fR. -.SH "void QPainter::drawPoints ( const QPointArray & a, int index = 0, int npoints = -1 )" -Draws/plots an array of points, \fIa\fR, using the current pen. -.PP -If \fIindex\fR is non-zero (the default is zero) only points from \fIindex\fR are drawn. If \fInpoints\fR is negative (the default) the rest of the points from \fIindex\fR are drawn. If \fInpoints\fR is zero or greater, \fInpoints\fR points are drawn. -.PP -\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. -.SH "void QPainter::drawPolygon ( const QPointArray & a, bool winding = FALSE, int index = 0, int npoints = -1 )" -Draws the polygon defined by the \fInpoints\fR points in \fIa\fR starting at \fIa[index]\fR. (\fIindex\fR defaults to 0.) -.PP -If \fInpoints\fR is -1 (the default) all points until the end of the array are used (i.e. a.size()-index line segments define the polygon). -.PP -The first point is always connected to the last point. -.PP -The polygon is filled with the current brush(). If \fIwinding\fR is TRUE, the polygon is filled using the winding fill algorithm. If \fIwinding\fR is FALSE, the polygon is filled using the even-odd (alternative) fill algorithm. -.PP -\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. -.PP -See also drawLineSegments(), drawPolyline(), and QPen. -.PP -Examples: -.)l desktop/desktop.cpp and picture/picture.cpp. -.SH "void QPainter::drawPolyline ( const QPointArray & a, int index = 0, int npoints = -1 )" -Draws the polyline defined by the \fInpoints\fR points in \fIa\fR starting at \fIa[index]\fR. (\fIindex\fR defaults to 0.) -.PP -If \fInpoints\fR is -1 (the default) all points until the end of the array are used (i.e. a.size()-index-1 line segments are drawn). -.PP -\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. -.PP -See also drawLineSegments(), drawPolygon(), and QPen. -.PP -Examples: -.)l scribble/scribble.cpp and themes/metal.cpp. -.SH "void QPainter::drawRect ( int x, int y, int w, int h )" -Draws a rectangle with upper left corner at \fI(x, y)\fR and with width \fIw\fR and height \fIh\fR. -.PP -See also QPen and drawRoundRect(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp, picture/picture.cpp, t10/cannon.cpp, t11/cannon.cpp, t9/cannon.cpp, tooltip/tooltip.cpp, and trivial/trivial.cpp. -.SH "void QPainter::drawRect ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the rectangle \fIr\fR. -.SH "void QPainter::drawRoundRect ( int x, int y, int w, int h, int xRnd = 25, int yRnd = 25 )" -Draws a rectangle with rounded corners at \fI(x, y)\fR, with width \fIw\fR and height \fIh\fR. -.PP -The \fIxRnd\fR and \fIyRnd\fR arguments specify how rounded the corners should be. 0 is angled corners, 99 is maximum roundedness. -.PP -The width and height include all of the drawn lines. -.PP -See also drawRect() and QPen. -.PP -Examples: -.)l drawdemo/drawdemo.cpp and themes/wood.cpp. -.SH "void QPainter::drawRoundRect ( const QRect & r, int xRnd = 25, int yRnd = 25 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a rounded rectangle \fIr\fR, rounding to the x position \fIxRnd\fR and the y position \fIyRnd\fR on each corner. -.SH "void QPainter::drawText ( const QPoint & p, const QString &, int pos, int len, TextDirection dir = Auto )" -Draws the text from position \fIpos\fR, at point \fIp\fR. If \fIlen\fR is -1 the entire string is drawn, otherwise just the first \fIlen\fR characters. The text's direction is specified by \fIdir\fR. -.PP -Note that the meaning of \fIy\fR is not the same for the two drawText() varieties. For overloads that take a simple \fIx\fR, \fIy\fR pair (or a point), the \fIy\fR value is the text's baseline; for overloads that take a rectangle, \fIrect.y()\fR is the top of the rectangle and the text is aligned within that rectangle in accordance with the alignment flags. -.PP -See also QPainter::TextDirection. -.PP -Examples: -.)l desktop/desktop.cpp, drawdemo/drawdemo.cpp, grapher/grapher.cpp, picture/picture.cpp, progress/progress.cpp, t8/cannon.cpp, and trivial/trivial.cpp. -.SH "void QPainter::drawText ( int x, int y, const QString &, int len = -1, TextDirection dir = Auto )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the given text at position \fIx\fR, \fIy\fR. If \fIlen\fR is -1 (the default) all the text is drawn, otherwise the first \fIlen\fR characters are drawn. The text's direction is given by \fIdir\fR. -.PP -See also QPainter::TextDirection. -.SH "void QPainter::drawText ( const QPoint &, const QString &, int len = -1, TextDirection dir = Auto )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the text at the given point. -.PP -See also QPainter::TextDirection. -.SH "void QPainter::drawText ( int x, int y, const QString &, int pos, int len, TextDirection dir = Auto )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the text from position \fIpos\fR, at point \fI(x, y)\fR. If \fIlen\fR is -1 the entire string is drawn, otherwise just the first \fIlen\fR characters. The text's direction is specified by \fIdir\fR. -.SH "void QPainter::drawText ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QRect * br = 0, QTextParag ** internal = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the given text within the rectangle starting at \fIx\fR, \fIy\fR, with width \fIw\fR and height \fIh\fR. If \fIlen\fR is -1 (the default) all the text is drawn, otherwise the first \fIlen\fR characters are drawn. The text's flags that are given in the \fIflags\fR parameter are Qt::AlignmentFlags and Qt::TextFlags OR'd together. \fIbr\fR (if not null) is set to the actual bounding rectangle of the output. The \fIinternal\fR parameter is for internal use only. -.SH "void QPainter::drawText ( const QRect & r, int tf, const QString & str, int len = -1, QRect * brect = 0, QTextParag ** internal = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws at most \fIlen\fR characters from \fIstr\fR in the rectangle \fIr\fR. -.PP -This function draws formatted text. The \fItf\fR text format is really of type Qt::AlignmentFlags and Qt::TextFlags OR'd together. -.PP -Horizontal alignment defaults to AlignAuto and vertical alignment defaults to AlignTop. -.PP -\fIbrect\fR (if not null) is set to the actual bounding rectangle of the output. \fIinternal\fR is, yes, internal. -.PP -See also boundingRect(). -.SH "void QPainter::drawTiledPixmap ( int x, int y, int w, int h, const QPixmap & pixmap, int sx = 0, int sy = 0 )" -Draws a tiled \fIpixmap\fR in the specified rectangle. -.PP -\fI(x, y)\fR specifies the top-left point in the paint device that is to be drawn onto; with the width and height given by \fIw\fR and \fIh\fR. \fI(sx, sy)\fR specifies the top-left point in \fIpixmap\fR that is to be drawn. The default is (0, 0). -.PP -Calling drawTiledPixmap() is similar to calling drawPixmap() several times to fill (tile) an area with a pixmap, but is potentially much more efficient depending on the underlying window system. -.PP -See also drawPixmap(). -.SH "void QPainter::drawTiledPixmap ( const QRect & r, const QPixmap & pm, const QPoint & sp )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a tiled pixmap, \fIpm\fR, inside rectangle \fIr\fR with its origin at point \fIsp\fR. -.SH "void QPainter::drawTiledPixmap ( const QRect & r, const QPixmap & pm )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a tiled pixmap, \fIpm\fR, inside rectangle \fIr\fR. -.SH "void QPainter::drawWinFocusRect ( int x, int y, int w, int h, const QColor & bgColor )" -Draws a Windows focus rectangle with upper left corner at (\fIx\fR, \fIy\fR) and with width \fIw\fR and height \fIh\fR using a pen color that contrasts with \fIbgColor\fR. -.PP -This function draws a stippled rectangle (XOR is not used) that is used to indicate keyboard focus (when the QApplication::style() is \fCWindowStyle\fR). -.PP -The pen color used to draw the rectangle is either white or black depending on the color of \fIbgColor\fR (see QColor::gray()). -.PP -\fBWarning:\fR This function draws nothing if the coordinate system has been rotated or sheared. -.PP -See also drawRect() and QApplication::style(). -.SH "void QPainter::drawWinFocusRect ( int x, int y, int w, int h )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a Windows focus rectangle with upper left corner at (\fIx\fR, \fIy\fR) and with width \fIw\fR and height \fIh\fR. -.PP -This function draws a stippled XOR rectangle that is used to indicate keyboard focus (when QApplication::style() is \fCWindowStyle\fR). -.PP -\fBWarning:\fR This function draws nothing if the coordinate system has been rotated or sheared. -.PP -See also drawRect() and QApplication::style(). -.SH "void QPainter::drawWinFocusRect ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws rectangle \fIr\fR as a window focus rectangle. -.SH "void QPainter::drawWinFocusRect ( const QRect & r, const QColor & bgColor )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws rectangle \fIr\fR as a window focus rectangle using background color \fIbgColor\fR. -.SH "bool QPainter::end ()" -Ends painting. Any resources used while painting are released. -.PP -Note that while you mostly don't need to call end(), the destructor will do it, there is at least one common case when it is needed, namely double buffering. -.PP -.nf -.br - QPainter p( myPixmap, this ) -.br - // ... -.br - p.end(); // stops drawing on myPixmap -.br - p.begin( this ); -.br - p.drawPixmap( 0, 0, myPixmap ); -.br -.fi -.PP -Since you can't draw a QPixmap while it is being painted, it is necessary to close the active painter. -.PP -See also begin() and isActive(). -.PP -Examples: -.)l aclock/aclock.cpp, desktop/desktop.cpp, hello/hello.cpp, picture/picture.cpp, scribble/scribble.cpp, t10/cannon.cpp, and xform/xform.cpp. -.SH "void QPainter::eraseRect ( int x, int y, int w, int h )" -Erases the area inside \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR. Equivalent to \fCfillRect( x, y, w, h, backgroundColor() )\fR. -.PP -Examples: -.)l listboxcombo/listboxcombo.cpp and showimg/showimg.cpp. -.SH "void QPainter::eraseRect ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Erases the area inside the rectangle \fIr\fR. -.SH "void QPainter::fillRect ( int x, int y, int w, int h, const QBrush & brush )" -Fills the rectangle \fI(x, y, w, h)\fR with the \fIbrush\fR. -.PP -You can specify a QColor as \fIbrush\fR, since there is a QBrush constructor that takes a QColor argument and creates a solid pattern brush. -.PP -See also drawRect(). -.PP -Examples: -.)l listboxcombo/listboxcombo.cpp, multiple/ax1.h, progress/progress.cpp, qdir/qdir.cpp, qfd/fontdisplayer.cpp, themes/metal.cpp, and themes/wood.cpp. -.SH "void QPainter::fillRect ( const QRect & r, const QBrush & brush )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Fills the rectangle \fIr\fR using brush \fIbrush\fR. -.SH "void QPainter::flush ( const QRegion & region, CoordinateMode cm = CoordDevice )" -Flushes any buffered drawing operations inside the region \fIregion\fR using clipping mode \fIcm\fR. -.PP -The flush may update the whole device if the platform does not support flushing to a specified region. -.PP -See also CoordinateMode. -.SH "void QPainter::flush ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Flushes any buffered drawing operations. -.SH "const QFont & QPainter::font () const" -Returns the currently set painter font. -.PP -See also setFont() and QFont. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QFontInfo QPainter::fontInfo () const" -Returns the font info for the painter, if the painter is active. It is not possible to obtain font information for an inactive painter, so the return value is undefined if the painter is not active. -.PP -See also fontMetrics() and isActive(). -.SH "QFontMetrics QPainter::fontMetrics () const" -Returns the font metrics for the painter, if the painter is active. It is not possible to obtain metrics for an inactive painter, so the return value is undefined if the painter is not active. -.PP -See also fontInfo() and isActive(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, desktop/desktop.cpp, drawdemo/drawdemo.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. -.SH "HDC QPainter::handle () const" -Returns the platform-dependent handle used for drawing. Using this function is not portable. -.SH "bool QPainter::hasClipping () const" -Returns TRUE if clipping has been set; otherwise returns FALSE. -.PP -See also setClipping(). -.PP -Example: themes/wood.cpp. -.SH "bool QPainter::hasViewXForm () const" -Returns TRUE if view transformation is enabled; otherwise returns FALSE. -.PP -See also setViewXForm() and xForm(). -.SH "bool QPainter::hasWorldXForm () const" -Returns TRUE if world transformation is enabled; otherwise returns FALSE. -.PP -See also setWorldXForm(). -.SH "bool QPainter::isActive () const" -Returns TRUE if the painter is active painting, i.e. begin() has been called and end() has not yet been called; otherwise returns FALSE. -.PP -See also QPaintDevice::paintingActive(). -.PP -Examples: -.)l desktop/desktop.cpp and helpviewer/helpwindow.cpp. -.SH "void QPainter::lineTo ( int x, int y )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use drawLine() instead. -.PP -Draws a line from the current pen position to \fI(x, y)\fR and sets \fI(x, y)\fR to be the new current pen position. -.PP -See also QPen, moveTo(), drawLine(), and pos(). -.SH "void QPainter::lineTo ( const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws a line to the point \fIp\fR. -.SH "void QPainter::moveTo ( int x, int y )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the current pen position to \fI(x, y)\fR -.PP -See also lineTo() and pos(). -.SH "void QPainter::moveTo ( const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Moves to the point \fIp\fR. -.SH "const QPen & QPainter::pen () const" -Returns the painter's current pen. -.PP -See also setPen(). -.PP -Examples: -.)l multiple/ax2.h, progress/progress.cpp, and themes/wood.cpp. -.SH "QPoint QPainter::pos () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the current position of the pen. -.PP -See also moveTo(). -.SH "RasterOp QPainter::rasterOp () const" -Returns the current raster operation. -.PP -See also setRasterOp() and RasterOp. -.SH "void QPainter::redirect ( QPaintDevice * pdev, QPaintDevice * replacement )\fC [static]\fR" -Redirects all paint commands for a paint device, \fIpdev\fR, to another paint device, \fIreplacement\fR, unless \fIreplacement\fR is 0. If \fIreplacement\fR is 0, the redirection for \fIpdev\fR is removed. -.PP -In general, you'll probably find calling QPixmap::grabWidget() or QPixmap::grabWindow() is an easier solution. -.SH "void QPainter::resetXForm ()" -Resets any transformations that were made using translate(), scale(), shear(), rotate(), setWorldMatrix(), setViewport() and setWindow(). -.PP -See also worldMatrix(), viewport(), and window(). -.SH "void QPainter::restore ()" -Restores the current painter state (pops a saved state off the stack). -.PP -See also save(). -.PP -Example: aclock/aclock.cpp. -.SH "void QPainter::restoreWorldMatrix ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -We recommend using restore() instead. -.SH "void QPainter::rotate ( double a )" -Rotates the coordinate system \fIa\fR degrees counterclockwise. -.PP -See also translate(), scale(), shear(), resetXForm(), setWorldMatrix(), and xForm(). -.PP -Examples: -.)l aclock/aclock.cpp, t10/cannon.cpp, and t9/cannon.cpp. -.SH "void QPainter::save ()" -Saves the current painter state (pushes the state onto a stack). A save() must be followed by a corresponding restore(). end() unwinds the stack. -.PP -See also restore(). -.PP -Example: aclock/aclock.cpp. -.SH "void QPainter::saveWorldMatrix ()" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -We recommend using save() instead. -.SH "void QPainter::scale ( double sx, double sy )" -Scales the coordinate system by \fI(sx, sy)\fR. -.PP -See also translate(), shear(), rotate(), resetXForm(), setWorldMatrix(), and xForm(). -.PP -Example: xform/xform.cpp. -.SH "void QPainter::setBackgroundColor ( const QColor & c )" -Sets the background color of the painter to \fIc\fR. -.PP -The background color is the color that is filled in when drawing opaque text, stippled lines and bitmaps. The background color has no effect in transparent background mode (which is the default). -.PP -See also backgroundColor(), setBackgroundMode(), and BackgroundMode. -.SH "void QPainter::setBackgroundMode ( BGMode m )" -Sets the background mode of the painter to \fIm\fR, which must be either TransparentMode (the default) or OpaqueMode. -.PP -Transparent mode draws stippled lines and text without setting the background pixels. Opaque mode fills these space with the current background color. -.PP -Note that in order to draw a bitmap or pixmap transparently, you must use QPixmap::setMask(). -.PP -See also backgroundMode() and setBackgroundColor(). -.PP -Example: picture/picture.cpp. -.SH "void QPainter::setBrush ( BrushStyle style )" -Sets the painter's brush to black color and the specified \fIstyle\fR. -.PP -See also brush() and QBrush. -.PP -Examples: -.)l aclock/aclock.cpp, drawdemo/drawdemo.cpp, picture/picture.cpp, t10/cannon.cpp, t9/cannon.cpp, themes/wood.cpp, and tooltip/tooltip.cpp. -.SH "void QPainter::setBrush ( const QBrush & brush )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the painter's brush to \fIbrush\fR. -.PP -The \fIbrush\fR defines how shapes are filled. -.PP -See also brush(). -.SH "void QPainter::setBrush ( const QColor & color )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the painter's brush to have style SolidPattern and the specified \fIcolor\fR. -.PP -See also brush() and QBrush. -.SH "void QPainter::setBrushOrigin ( int x, int y )" -Sets the brush origin to \fI(x, y)\fR. -.PP -The brush origin specifies the (0, 0) coordinate of the painter's brush. This setting only applies to pattern brushes and pixmap brushes. -.PP -See also brushOrigin(). -.SH "void QPainter::setBrushOrigin ( const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the brush origin to point \fIp\fR. -.SH "void QPainter::setClipRect ( int x, int y, int w, int h, CoordinateMode m = CoordDevice )" -Sets the clip region to the rectangle \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR and enables clipping. The clip mode is set to \fIm\fR. -.PP -If \fIm\fR is CoordDevice (the default), the coordinates given for the clip region are taken to be physical device coordinates and are \fInot\fR subject to any coordinate transformations. If \fIm\fR is CoordPainter, the coordinates given for the clip region are taken to be model coordinates. -.PP -See also setClipRegion(), clipRegion(), setClipping(), and QPainter::CoordinateMode. -.PP -Examples: -.)l grapher/grapher.cpp, progress/progress.cpp, showimg/showimg.cpp, splitter/splitter.cpp, and trivial/trivial.cpp. -.SH "void QPainter::setClipRect ( const QRect & r, CoordinateMode m = CoordDevice )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the clip region to the rectangle \fIr\fR and enables clipping. The clip mode is set to \fIm\fR. -.PP -See also CoordinateMode. -.SH "void QPainter::setClipRegion ( const QRegion & rgn, CoordinateMode m = CoordDevice )" -Sets the clip region to \fIrgn\fR and enables clipping. The clip mode is set to \fIm\fR. -.PP -Note that the clip region is given in physical device coordinates and \fInot\fR subject to any coordinate transformation. -.PP -See also setClipRect(), clipRegion(), setClipping(), and CoordinateMode. -.PP -Examples: -.)l qfd/fontdisplayer.cpp and themes/wood.cpp. -.SH "void QPainter::setClipping ( bool enable )" -Enables clipping if \fIenable\fR is TRUE, or disables clipping if \fIenable\fR is FALSE. -.PP -See also hasClipping(), setClipRect(), and setClipRegion(). -.PP -Example: themes/wood.cpp. -.SH "void QPainter::setFont ( const QFont & font )" -Sets the painter's font to \fIfont\fR. -.PP -This font is used by subsequent drawText() functions. The text color is the same as the pen color. -.PP -See also font() and drawText(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp, grapher/grapher.cpp, hello/hello.cpp, picture/picture.cpp, qwerty/qwerty.cpp, t13/cannon.cpp, and xform/xform.cpp. -.SH "void QPainter::setPen ( const QPen & pen )" -Sets a new painter pen. -.PP -The \fIpen\fR defines how to draw lines and outlines, and it also defines the text color. -.PP -See also pen(). -.PP -Examples: -.)l desktop/desktop.cpp, drawdemo/drawdemo.cpp, multiple/ax2.h, progress/progress.cpp, t9/cannon.cpp, themes/metal.cpp, and themes/wood.cpp. -.SH "void QPainter::setPen ( PenStyle style )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the painter's pen to have style \fIstyle\fR, width 0 and black color. -.PP -See also pen() and QPen. -.SH "void QPainter::setPen ( const QColor & color )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the painter's pen to have style SolidLine, width 0 and the specified \fIcolor\fR. -.PP -See also pen() and QPen. -.SH "void QPainter::setRasterOp ( RasterOp r )" -Sets the raster operation to \fIr\fR. The default is CopyROP. -.PP -See also rasterOp() and Qt::RasterOp. -.SH "void QPainter::setTabArray ( int * ta )" -Sets the tab stop array to \fIta\fR. This puts tab stops at \fIta[0]\fR, \fIta[1]\fR and so on. The array is null-terminated. -.PP -If both a tab array and a tab top size is set, the tab array wins. -.PP -See also tabArray(), setTabStops(), drawText(), and fontMetrics(). -.SH "void QPainter::setTabStops ( int ts )" -Set the tab stop width to \fIts\fR, i.e. locates tab stops at \fIts\fR, 2*\fIts\fR, 3*\fIts\fR and so on. -.PP -Tab stops are used when drawing formatted text with ExpandTabs set. This fixed tab stop value is used only if no tab array is set (which is the default case). -.PP -A value of 0 (the default) implies a tabstop setting of 8 times the width of the character 'x' in the font currently set on the painter. -.PP -See also tabStops(), setTabArray(), drawText(), and fontMetrics(). -.SH "void QPainter::setViewXForm ( bool enable )" -Enables view transformations if \fIenable\fR is TRUE, or disables view transformations if \fIenable\fR is FALSE. -.PP -See also hasViewXForm(), setWindow(), setViewport(), setWorldMatrix(), setWorldXForm(), and xForm(). -.SH "void QPainter::setViewport ( int x, int y, int w, int h )" -Sets the viewport rectangle view transformation for the painter and enables view transformation. -.PP -The viewport rectangle is part of the view transformation. The viewport specifies the device coordinate system and is specified by the \fIx\fR, \fIy\fR, \fIw\fR width and \fIh\fR height parameters. Its sister, the window(), specifies the logical coordinate system. -.PP -The default viewport rectangle is the same as the device's rectangle. See the Coordinate System Overview for an overview of coordinate transformation. -.PP -See also viewport(), setWindow(), setViewXForm(), setWorldMatrix(), setWorldXForm(), and xForm(). -.PP -Example: aclock/aclock.cpp. -.SH "void QPainter::setViewport ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the painter's viewport to rectangle \fIr\fR. -.SH "void QPainter::setWindow ( int x, int y, int w, int h )" -Sets the window rectangle view transformation for the painter and enables view transformation. -.PP -The window rectangle is part of the view transformation. The window specifies the logical coordinate system and is specified by the \fIx\fR, \fIy\fR, \fIw\fR width and \fIh\fR height parameters. Its sister, the viewport(), specifies the device coordinate system. -.PP -The default window rectangle is the same as the device's rectangle. See the Coordinate System Overview for an overview of coordinate transformation. -.PP -See also window(), setViewport(), setViewXForm(), setWorldMatrix(), and setWorldXForm(). -.PP -Examples: -.)l aclock/aclock.cpp and drawdemo/drawdemo.cpp. -.SH "void QPainter::setWindow ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the painter's window to rectangle \fIr\fR. -.SH "void QPainter::setWorldMatrix ( const QWMatrix & m, bool combine = FALSE )" -Sets the world transformation matrix to \fIm\fR and enables world transformation. -.PP -If \fIcombine\fR is TRUE, then \fIm\fR is combined with the current transformation matrix, otherwise \fIm\fR replaces the current transformation matrix. -.PP -If \fIm\fR is the identity matrix and \fIcombine\fR is FALSE, this function calls setWorldXForm(FALSE). (The identity matrix is the matrix where QWMatrix::m11() and QWMatrix::m22() are 1.0 and the rest are 0.0.) -.PP -World transformations are applied after the view transformations (i.e. window and viewport). -.PP -The following functions can transform the coordinate system without using a QWMatrix: -.TP -translate() -.TP -scale() -.TP -shear() -.TP -rotate() -.PP -They operate on the painter's worldMatrix() and are implemented like this: -.PP -.nf -.br - void QPainter::rotate( double a ) -.br - { -.br - QWMatrix m; -.br - m.rotate( a ); -.br - setWorldMatrix( m, TRUE ); -.br - } -.br -.fi -.PP -Note that you should always use \fIcombine\fR when you are drawing into a QPicture. Otherwise it may not be possible to replay the picture with additional transformations. Using translate(), scale(), etc., is safe. -.PP -For a brief overview of coordinate transformation, see the Coordinate System Overview. -.PP -See also worldMatrix(), setWorldXForm(), setWindow(), setViewport(), setViewXForm(), xForm(), and QWMatrix. -.PP -Examples: -.)l drawdemo/drawdemo.cpp and xform/xform.cpp. -.SH "void QPainter::setWorldXForm ( bool enable )" -Enables world transformations if \fIenable\fR is TRUE, or disables world transformations if \fIenable\fR is FALSE. The world transformation matrix is not changed. -.PP -See also setWorldMatrix(), setWindow(), setViewport(), setViewXForm(), and xForm(). -.SH "void QPainter::shear ( double sh, double sv )" -Shears the coordinate system by \fI(sh, sv)\fR. -.PP -See also translate(), scale(), rotate(), resetXForm(), setWorldMatrix(), and xForm(). -.SH "int * QPainter::tabArray () const" -Returns the currently set tab stop array. -.PP -See also setTabArray(). -.SH "int QPainter::tabStops () const" -Returns the tab stop setting. -.PP -See also setTabStops(). -.SH "void QPainter::translate ( double dx, double dy )" -Translates the coordinate system by \fI(dx, dy)\fR. After this call, \fI(dx, dy)\fR is added to points. -.PP -For example, the following code draws the same point twice: -.PP -.nf -.br - void MyWidget::paintEvent() -.br - { -.br - QPainter paint( this ); -.br -.br - paint.drawPoint( 0, 0 ); -.br -.br - paint.translate( 100.0, 40.0 ); -.br - paint.drawPoint( -100, -40 ); -.br - } -.br -.fi -.PP -See also scale(), shear(), rotate(), resetXForm(), setWorldMatrix(), and xForm(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, t10/cannon.cpp, t9/cannon.cpp, themes/metal.cpp, themes/wood.cpp, and xform/xform.cpp. -.SH "QRect QPainter::viewport () const" -Returns the viewport rectangle. -.PP -See also setViewport() and setViewXForm(). -.PP -Example: aclock/aclock.cpp. -.SH "QRect QPainter::window () const" -Returns the window rectangle. -.PP -See also setWindow() and setViewXForm(). -.SH "const QWMatrix & QPainter::worldMatrix () const" -Returns the world transformation matrix. -.PP -See also setWorldMatrix(). -.SH "QPoint QPainter::xForm ( const QPoint & pv ) const" -Returns the point \fIpv\fR transformed from model coordinates to device coordinates. -.PP -See also xFormDev() and QWMatrix::map(). -.SH "QRect QPainter::xForm ( const QRect & rv ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the rectangle \fIrv\fR transformed from model coordinates to device coordinates. -.PP -If world transformation is enabled and rotation or shearing has been specified, then the bounding rectangle is returned. -.PP -See also xFormDev() and QWMatrix::map(). -.SH "QPointArray QPainter::xForm ( const QPointArray & av ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point array \fIav\fR transformed from model coordinates to device coordinates. -.PP -See also xFormDev() and QWMatrix::map(). -.SH "QPointArray QPainter::xForm ( const QPointArray & av, int index, int npoints ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point array \fIav\fR transformed from model coordinates to device coordinates. The \fIindex\fR is the first point in the array and \fInpoints\fR denotes the number of points to be transformed. If \fInpoints\fR is negative, all points from \fIav[index]\fR until the last point in the array are transformed. -.PP -The returned point array consists of the number of points that were transformed. -.PP -Example: -.PP -.nf -.br - QPointArray a(10); -.br - QPointArray b; -.br - b = painter.xForm(a, 2, 4); // b.size() == 4 -.br - b = painter.xForm(a, 2, -1); // b.size() == 8 -.br -.fi -.PP -See also xFormDev() and QWMatrix::map(). -.SH "QRect QPainter::xFormDev ( const QRect & rd ) const" -Returns the rectangle \fIrd\fR transformed from device coordinates to model coordinates. -.PP -If world transformation is enabled and rotation or shearing is used, then the bounding rectangle is returned. -.PP -See also xForm() and QWMatrix::map(). -.SH "QPoint QPainter::xFormDev ( const QPoint & pd ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point \fIpd\fR transformed from device coordinates to model coordinates. -.PP -See also xForm() and QWMatrix::map(). -.SH "QPointArray QPainter::xFormDev ( const QPointArray & ad ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point array \fIad\fR transformed from device coordinates to model coordinates. -.PP -See also xForm() and QWMatrix::map(). -.SH "QPointArray QPainter::xFormDev ( const QPointArray & ad, int index, int npoints ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point array \fIad\fR transformed from device coordinates to model coordinates. The \fIindex\fR is the first point in the array and \fInpoints\fR denotes the number of points to be transformed. If \fInpoints\fR is negative, all points from \fIad[index]\fR until the last point in the array are transformed. -.PP -The returned point array consists of the number of points that were transformed. -.PP -Example: -.PP -.nf -.br - QPointArray a(10); -.br - QPointArray b; -.br - b = painter.xFormDev(a, 1, 3); // b.size() == 3 -.br - b = painter.xFormDev(a, 1, -1); // b.size() == 9 -.br -.fi -.PP -See also xForm() and QWMatrix::map(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "void qDrawPlainRect ( QPainter * p, int x, int y, int w, int h, const QColor & c, int lineWidth, const QBrush * fill )" -\fC#include \fR -.PP -Draws the plain rectangle specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. -.PP -The color argument \fIc\fR specifies the line color. -.PP -The \fIlineWidth\fR argument specifies the line width. -.PP -The rectangle's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. -.PP -If you want to use a QFrame widget instead, you can make it display a plain rectangle, for example \fCQFrame::setFrameStyle( QFrame::Box | QFrame::Plain )\fR. -.PP -\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. -.PP -See also qDrawShadeRect() and QStyle::drawPrimitive(). -.SH "void qDrawShadeLine ( QPainter * p, int x1, int y1, int x2, int y2, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth )" -\fC#include \fR -.PP -Draws a horizontal (\fIy1\fR == \fIy2\fR) or vertical (\fIx1\fR == \fIx2\fR) shaded line using the painter \fIp\fR. -.PP -Nothing is drawn if \fIy1\fR != \fIy2\fR and \fIx1\fR != \fIx2\fR (i.e. the line is neither horizontal nor vertical). -.PP -The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). -.PP -The line appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. -.PP -The \fIlineWidth\fR argument specifies the line width for each of the lines. It is not the total line width. -.PP -The \fImidLineWidth\fR argument specifies the width of a middle line drawn in the QColorGroup::mid() color. -.PP -If you want to use a QFrame widget instead, you can make it display a shaded line, for example \fCQFrame::setFrameStyle( QFrame::HLine | QFrame::Sunken )\fR. -.PP -\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. -.PP -See also qDrawShadeRect(), qDrawShadePanel(), and QStyle::drawPrimitive(). -.SH "void qDrawShadePanel ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, const QBrush * fill )" -\fC#include \fR -.PP -Draws the shaded panel specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. -.PP -The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). -.PP -The panel appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. -.PP -The \fIlineWidth\fR argument specifies the line width. -.PP -The panel's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. -.PP -If you want to use a QFrame widget instead, you can make it display a shaded panel, for example \fCQFrame::setFrameStyle( QFrame::Panel | QFrame::Sunken )\fR. -.PP -\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. -.PP -See also qDrawWinPanel(), qDrawShadeLine(), qDrawShadeRect(), and QStyle::drawPrimitive(). -.SH "void qDrawShadeRect ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth, const QBrush * fill )" -\fC#include \fR -.PP -Draws the shaded rectangle specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. -.PP -The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). -.PP -The rectangle appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. -.PP -The \fIlineWidth\fR argument specifies the line width for each of the lines. It is not the total line width. -.PP -The \fImidLineWidth\fR argument specifies the width of a middle line drawn in the QColorGroup::mid() color. -.PP -The rectangle's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. -.PP -If you want to use a QFrame widget instead, you can make it display a shaded rectangle, for example \fCQFrame::setFrameStyle( QFrame::Box | QFrame::Raised )\fR. -.PP -\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. -.PP -See also qDrawShadeLine(), qDrawShadePanel(), qDrawPlainRect(), QStyle::drawItem(), QStyle::drawControl(), and QStyle::drawComplexControl(). -.SH "void qDrawWinButton ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" -\fC#include \fR -.PP -Draws the Windows-style button specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. -.PP -The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). -.PP -The button appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. -.PP -The line width is 2 pixels. -.PP -The button's interior is filled with the \fI*fill\fR brush unless \fIfill\fR is 0. -.PP -\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. -.PP -See also qDrawWinPanel() and QStyle::drawControl(). -.SH "void qDrawWinPanel ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" -\fC#include \fR -.PP -Draws the Windows-style panel specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. -.PP -The color group argument \fIg\fR specifies the shading colors. -.PP -The panel appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. -.PP -The line width is 2 pixels. -.PP -The button's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. -.PP -If you want to use a QFrame widget instead, you can make it display a shaded panel, for example \fCQFrame::setFrameStyle( QFrame::WinPanel | QFrame::Raised )\fR. -.PP -\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. -.PP -See also qDrawShadePanel(), qDrawWinButton(), and QStyle::drawPrimitive(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpainter.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpainter.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpaintevent.3qt b/doc/man/man3/qpaintevent.3qt deleted file mode 100644 index c2ed46429..000000000 --- a/doc/man/man3/qpaintevent.3qt +++ /dev/null @@ -1,94 +0,0 @@ -'\" t -.TH QPaintEvent 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 -QPaintEvent \- Event parameters for paint events -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPaintEvent\fR ( const QRegion & paintRegion, bool erased = TRUE )" -.br -.ti -1c -.BI "\fBQPaintEvent\fR ( const QRect & paintRect, bool erased = TRUE )" -.br -.ti -1c -.BI "\fBQPaintEvent\fR ( const QRegion & paintRegion, const QRect & paintRect, bool erased = TRUE )" -.br -.ti -1c -.BI "const QRect & \fBrect\fR () const" -.br -.ti -1c -.BI "const QRegion & \fBregion\fR () const" -.br -.ti -1c -.BI "bool \fBerased\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QPaintEvent class contains event parameters for paint events. -.PP -Paint events are sent to widgets that need to update themselves, for instance when part of a widget is exposed because a covering widget is moved. -.PP -The event contains a region() that needs to be updated, and a rect() that is the bounding rectangle of that region. Both are provided because many widgets can't make much use of region(), and rect() can be much faster than region().boundingRect(). Painting is clipped to region() during processing of a paint event. -.PP -The erased() function returns TRUE if the region() has been cleared to the widget's background (see QWidget::backgroundMode()), and FALSE if the region's contents are arbitrary. -.PP -See also QPainter, QWidget::update(), QWidget::repaint(), QWidget::paintEvent(), QWidget::backgroundMode, QRegion, and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPaintEvent::QPaintEvent ( const QRegion & paintRegion, bool erased = TRUE )" -Constructs a paint event object with the region that should be updated. The region is given by \fIpaintRegion\fR. If \fIerased\fR is TRUE the region will be cleared before repainting. -.SH "QPaintEvent::QPaintEvent ( const QRect & paintRect, bool erased = TRUE )" -Constructs a paint event object with the rectangle that should be updated. The region is also given by \fIpaintRect\fR. If \fIerased\fR is TRUE the region will be cleared before repainting. -.SH "QPaintEvent::QPaintEvent ( const QRegion & paintRegion, const QRect & paintRect, bool erased = TRUE )" -Constructs a paint event object with the rectangle \fIpaintRect\fR that should be updated. The region is given by \fIpaintRegion\fR. If \fIerased\fR is TRUE the region will be cleared before repainting. -.SH "bool QPaintEvent::erased () const" -Returns TRUE if the paint event region (or rectangle) has been erased with the widget's background; otherwise returns FALSE. -.SH "const QRect & QPaintEvent::rect () const" -Returns the rectangle that should be updated. -.PP -See also region() and QPainter::setClipRect(). -.PP -Examples: -.)l life/life.cpp, qfd/fontdisplayer.cpp, showimg/showimg.cpp, t10/cannon.cpp, t11/cannon.cpp, t13/cannon.cpp, and tooltip/tooltip.cpp. -.SH "const QRegion & QPaintEvent::region () const" -Returns the region that should be updated. -.PP -See also rect() and QPainter::setClipRegion(). -.PP -Examples: -.)l qfd/fontdisplayer.cpp and scribble/scribble.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qpaintevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpaintevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpair.3qt b/doc/man/man3/qpair.3qt deleted file mode 100644 index 39030007c..000000000 --- a/doc/man/man3/qpair.3qt +++ /dev/null @@ -1,100 +0,0 @@ -'\" t -.TH QPair 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 -QPair \- Value-based template class that provides a pair of elements -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef T1 \fBfirst_type\fR" -.br -.ti -1c -.BI "typedef T2 \fBsecond_type\fR" -.br -.ti -1c -.BI "\fBQPair\fR ()" -.br -.ti -1c -.BI "\fBQPair\fR ( const T1 & t1, const T2 & t2 )" -.br -.ti -1c -.BI "QPair & \fBoperator=\fR ( const QPair & other )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QPair \fBqMakePair\fR ( T1 t1, T2 t2 )" -.br -.in -1c -.SH DESCRIPTION -The QPair class is a value-based template class that provides a pair of elements. -.PP -QPair is a Qt implementation of an STL-like pair. It can be used in your application if the standard pair<> is not available on your target platforms. -.PP -QPair defines a template instance to create a pair of values that contains two values of type T1 and T2. Please note that QPair does not store pointers to the two elements; it holds a copy of every member. This is why these kinds of classes are called \fIvalue based\fR. If you're interested in \fIpointer based\fR classes see, for example, QPtrList and QDict. -.PP -QPair holds one copy of type T1 and one copy of type T2, but does not provide iterators to access these elements. Instead, the two elements (\fCfirst\fR and \fCsecond\fR) are public member variables of the pair. QPair owns the contained elements. For more relaxed ownership semantics, see QPtrCollection and friends which are pointer-based containers. -.PP -Some classes cannot be used within a QPair: for example, all classes derived from QObject and thus all classes that implement widgets. Only "values" can be used in a QPair. To qualify as a value the class must provide: -.TP -A copy constructor -.TP -An assignment operator -.TP -A constructor that takes no arguments -.PP -Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. -.PP -QPair uses an STL-like syntax to manipulate and address the objects it contains. See the QTL documentation for more information. -.PP -Functions that need to return two values can use a QPair. -.PP -See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QPair::first_type" -The type of the first element in the pair. -.SH "QPair::second_type" -The type of the second element in the pair. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPair::QPair ()" -Constructs an empty pair. The \fCfirst\fR and \fCsecond\fR elements are default constructed. -.SH "QPair::QPair ( const T1 & t1, const T2 & t2 )" -Constructs a pair and initializes the \fCfirst\fR element with \fIt1\fR and the \fCsecond\fR element with \fIt2\fR. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QPair qMakePair ( T1 t1, T2 t2 )" -This is a template convenience function. It is used to create a -QPair<> object that contains \fIt1\fR and \fIt2\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpair.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpair.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpalette.3qt b/doc/man/man3/qpalette.3qt deleted file mode 100644 index 3ecf55dd7..000000000 --- a/doc/man/man3/qpalette.3qt +++ /dev/null @@ -1,293 +0,0 @@ -'\" t -.TH QPalette 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 -QPalette \- Color groups for each widget state -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPalette\fR ()" -.br -.ti -1c -.BI "QPalette ( const QColor & button ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "\fBQPalette\fR ( const QColor & button, const QColor & background )" -.br -.ti -1c -.BI "\fBQPalette\fR ( const QColorGroup & active, const QColorGroup & disabled, const QColorGroup & inactive )" -.br -.ti -1c -.BI "\fBQPalette\fR ( const QPalette & p )" -.br -.ti -1c -.BI "\fB~QPalette\fR ()" -.br -.ti -1c -.BI "QPalette & \fBoperator=\fR ( const QPalette & p )" -.br -.ti -1c -.BI "enum \fBColorGroup\fR { Disabled, Active, Inactive, NColorGroups, Normal = Active }" -.br -.ti -1c -.BI "const QColor & \fBcolor\fR ( ColorGroup gr, QColorGroup::ColorRole r ) const" -.br -.ti -1c -.BI "const QBrush & \fBbrush\fR ( ColorGroup gr, QColorGroup::ColorRole r ) const" -.br -.ti -1c -.BI "void \fBsetColor\fR ( ColorGroup gr, QColorGroup::ColorRole r, const QColor & c )" -.br -.ti -1c -.BI "void \fBsetBrush\fR ( ColorGroup gr, QColorGroup::ColorRole r, const QBrush & b )" -.br -.ti -1c -.BI "void \fBsetColor\fR ( QColorGroup::ColorRole r, const QColor & c )" -.br -.ti -1c -.BI "void \fBsetBrush\fR ( QColorGroup::ColorRole r, const QBrush & b )" -.br -.ti -1c -.BI "QPalette \fBcopy\fR () const" -.br -.ti -1c -.BI "const QColorGroup & \fBactive\fR () const" -.br -.ti -1c -.BI "const QColorGroup & \fBdisabled\fR () const" -.br -.ti -1c -.BI "const QColorGroup & \fBinactive\fR () const" -.br -.ti -1c -.BI "const QColorGroup & normal () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetActive\fR ( const QColorGroup & g )" -.br -.ti -1c -.BI "void \fBsetDisabled\fR ( const QColorGroup & g )" -.br -.ti -1c -.BI "void \fBsetInactive\fR ( const QColorGroup & g )" -.br -.ti -1c -.BI "void setNormal ( const QColorGroup & cg ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QPalette & p ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QPalette & p ) const" -.br -.ti -1c -.BI "bool \fBisCopyOf\fR ( const QPalette & p )" -.br -.ti -1c -.BI "int \fBserialNumber\fR () const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPalette & p )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPalette & p )" -.br -.in -1c -.SH DESCRIPTION -The QPalette class contains color groups for each widget state. -.PP -A palette consists of three color groups: \fIactive\fR, \fIdisabled\fR, and \fIinactive\fR. All widgets contain a palette, and all widgets in Qt use their palette to draw themselves. This makes the user interface easily configurable and easier to keep consistent. -.PP -If you create a new widget we strongly recommend that you use the colors in the palette rather than hard-coding specific colors. -.PP -The color groups: -.TP -The active() group is used for the window that has keyboard focus. -.TP -The inactive() group is used for other windows. -.TP -The disabled() group is used for widgets (not windows) that are disabled for some reason. -.PP -Both active and inactive windows can contain disabled widgets. (Disabled widgets are often called \fIinaccessible\fR or \fIgrayed out\fR.) -.PP -In Motif style, active() and inactive() look the same. In Windows 2000 style and Macintosh Platinum style, the two styles look slightly different. -.PP -There are setActive(), setInactive(), and setDisabled() functions to modify the palette. (Qt also supports a normal() group; this is an obsolete alias for active(), supported for backwards compatibility.) -.PP -Colors and brushes can be set for particular roles in any of a palette's color groups with setColor() and setBrush(). -.PP -You can copy a palette using the copy constructor and test to see if two palettes are \fIidentical\fR using isCopyOf(). -.PP -See also QApplication::setPalette(), QWidget::palette, QColorGroup, QColor, Widget Appearance and Style, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SS "Member Type Documentation" -.SH "QPalette::ColorGroup" -.TP -\fCQPalette::Disabled\fR -.TP -\fCQPalette::Active\fR -.TP -\fCQPalette::Inactive\fR -.TP -\fCQPalette::NColorGroups\fR -.TP -\fCQPalette::Normal\fR - synonym for Active -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPalette::QPalette ()" -Constructs a palette that consists of color groups with only black colors. -.SH "QPalette::QPalette ( const QColor & button )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Constructs a palette from the \fIbutton\fR color. The other colors are automatically calculated, based on this color. Background will be the button color as well. -.SH "QPalette::QPalette ( const QColor & button, const QColor & background )" -Constructs a palette from a \fIbutton\fR color and a \fIbackground\fR. The other colors are automatically calculated, based on these colors. -.SH "QPalette::QPalette ( const QColorGroup & active, const QColorGroup & disabled, const QColorGroup & inactive )" -Constructs a palette that consists of the three color groups \fIactive\fR, \fIdisabled\fR and \fIinactive\fR. See the Detailed Description for definitions of the color groups and QColorGroup::ColorRole for definitions of each color role in the three groups. -.PP -See also QColorGroup and QColorGroup::ColorRole. -.SH "QPalette::QPalette ( const QPalette & p )" -Constructs a copy of \fIp\fR. -.PP -This constructor is fast (it uses copy-on-write). -.SH "QPalette::~QPalette ()" -Destroys the palette. -.SH "const QColorGroup & QPalette::active () const" -Returns the active color group of this palette. -.PP -See also QColorGroup, setActive(), inactive(), and disabled(). -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QBrush & QPalette::brush ( ColorGroup gr, QColorGroup::ColorRole r ) const" -Returns the brush in color group \fIgr\fR, used for color role \fIr\fR. -.PP -See also color(), setBrush(), and QColorGroup::ColorRole. -.SH "const QColor & QPalette::color ( ColorGroup gr, QColorGroup::ColorRole r ) const" -Returns the color in color group \fIgr\fR, used for color role \fIr\fR. -.PP -See also brush(), setColor(), and QColorGroup::ColorRole. -.SH "QPalette QPalette::copy () const" -Returns a deep copy of this palette. -.PP -\fBWarning:\fR This is slower than the copy constructor and assignment operator and offers no benefits. -.SH "const QColorGroup & QPalette::disabled () const" -Returns the disabled color group of this palette. -.PP -See also QColorGroup, setDisabled(), active(), and inactive(). -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "const QColorGroup & QPalette::inactive () const" -Returns the inactive color group of this palette. -.PP -See also QColorGroup, setInactive(), active(), and disabled(). -.SH "bool QPalette::isCopyOf ( const QPalette & p )" -Returns TRUE if this palette and \fIp\fR are copies of each other, i.e. one of them was created as a copy of the other and neither was subsequently modified; otherwise returns FALSE. This is much stricter than equality. -.PP -See also operator=() and operator==(). -.SH "const QColorGroup & QPalette::normal () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the active color group. Use active() instead. -.PP -See also setActive() and active(). -.SH "bool QPalette::operator!= ( const QPalette & p ) const" -Returns TRUE (slowly) if this palette is different from \fIp\fR; otherwise returns FALSE (usually quickly). -.SH "QPalette & QPalette::operator= ( const QPalette & p )" -Assigns \fIp\fR to this palette and returns a reference to this palette. -.PP -This is fast (it uses copy-on-write). -.PP -See also copy(). -.SH "bool QPalette::operator== ( const QPalette & p ) const" -Returns TRUE (usually quickly) if this palette is equal to \fIp\fR; otherwise returns FALSE (slowly). -.SH "int QPalette::serialNumber () const" -Returns a number that uniquely identifies this QPalette object. The serial number is intended for caching. Its value may not be used for anything other than equality testing. -.PP -Note that QPalette uses copy-on-write, and the serial number changes during the lazy copy operation (detach()), not during a shallow copy (copy constructor or assignment). -.PP -See also QPixmap, QPixmapCache, and QCache. -.SH "void QPalette::setActive ( const QColorGroup & g )" -Sets the Active color group to \fIg\fR. -.PP -See also active(), setDisabled(), setInactive(), and QColorGroup. -.SH "void QPalette::setBrush ( ColorGroup gr, QColorGroup::ColorRole r, const QBrush & b )" -Sets the brush in color group \fIgr\fR, used for color role \fIr\fR, to \fIb\fR. -.PP -See also brush(), setColor(), and QColorGroup::ColorRole. -.SH "void QPalette::setBrush ( QColorGroup::ColorRole r, const QBrush & b )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the brush in for color role \fIr\fR in all three color groups to \fIb\fR. -.PP -See also brush(), setColor(), QColorGroup::ColorRole, active(), inactive(), and disabled(). -.SH "void QPalette::setColor ( ColorGroup gr, QColorGroup::ColorRole r, const QColor & c )" -Sets the brush in color group \fIgr\fR, used for color role \fIr\fR, to the solid color \fIc\fR. -.PP -See also setBrush(), color(), and QColorGroup::ColorRole. -.PP -Example: themes/themes.cpp. -.SH "void QPalette::setColor ( QColorGroup::ColorRole r, const QColor & c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the brush color used for color role \fIr\fR to color \fIc\fR in all three color groups. -.PP -See also color(), setBrush(), and QColorGroup::ColorRole. -.SH "void QPalette::setDisabled ( const QColorGroup & g )" -Sets the Disabled color group to \fIg\fR. -.PP -See also disabled(), setActive(), and setInactive(). -.SH "void QPalette::setInactive ( const QColorGroup & g )" -Sets the Inactive color group to \fIg\fR. -.PP -See also active(), setDisabled(), setActive(), and QColorGroup. -.SH "void QPalette::setNormal ( const QColorGroup & cg )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the active color group to \fIcg\fR. Use setActive() instead. -.PP -See also setActive() and active(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QPalette & p )" -Writes the palette, \fIp\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QPalette & p )" -Reads a palette from the stream, \fIs\fR into the palette \fIp\fR, and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpalette.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpalette.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpen.3qt b/doc/man/man3/qpen.3qt deleted file mode 100644 index 839804684..000000000 --- a/doc/man/man3/qpen.3qt +++ /dev/null @@ -1,287 +0,0 @@ -'\" t -.TH QPen 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 -QPen \- Defines how a QPainter should draw lines and outlines of shapes -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPen\fR ()" -.br -.ti -1c -.BI "\fBQPen\fR ( PenStyle style )" -.br -.ti -1c -.BI "\fBQPen\fR ( const QColor & color, uint width = 0, PenStyle style = SolidLine )" -.br -.ti -1c -.BI "\fBQPen\fR ( const QColor & cl, uint w, PenStyle s, PenCapStyle c, PenJoinStyle j )" -.br -.ti -1c -.BI "\fBQPen\fR ( const QPen & p )" -.br -.ti -1c -.BI "\fB~QPen\fR ()" -.br -.ti -1c -.BI "QPen & \fBoperator=\fR ( const QPen & p )" -.br -.ti -1c -.BI "PenStyle \fBstyle\fR () const" -.br -.ti -1c -.BI "void \fBsetStyle\fR ( PenStyle s )" -.br -.ti -1c -.BI "uint \fBwidth\fR () const" -.br -.ti -1c -.BI "void \fBsetWidth\fR ( uint w )" -.br -.ti -1c -.BI "const QColor & \fBcolor\fR () const" -.br -.ti -1c -.BI "void \fBsetColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "PenCapStyle \fBcapStyle\fR () const" -.br -.ti -1c -.BI "void \fBsetCapStyle\fR ( PenCapStyle c )" -.br -.ti -1c -.BI "PenJoinStyle \fBjoinStyle\fR () const" -.br -.ti -1c -.BI "void \fBsetJoinStyle\fR ( PenJoinStyle j )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QPen & p ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QPen & p ) const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPen & p )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPen & p )" -.br -.in -1c -.SH DESCRIPTION -The QPen class defines how a QPainter should draw lines and outlines of shapes. -.PP -A pen has a style, width, color, cap style and join style. -.PP -The pen style defines the line type. The default pen style is Qt::SolidLine. Setting the style to NoPen tells the painter to not draw lines or outlines. -.PP -When drawing 1 pixel wide diagonal lines you can either use a very fast algorithm (specified by a line width of 0, which is the default), or a slower but more accurate algorithm (specified by a line width of 1). For horizontal and vertical lines a line width of 0 is the same as a line width of 1. The cap and join style have no effect on 0-width lines. -.PP -The pen color defines the color of lines and text. The default line color is black. The QColor documentation lists predefined colors. -.PP -The cap style defines how the end points of lines are drawn. The join style defines how the joins between two lines are drawn when multiple connected lines are drawn (QPainter::drawPolyline() etc.). The cap and join styles only apply to wide lines, i.e. when the width is 1 or greater. -.PP -Use the QBrush class to specify fill styles. -.PP -Example: -.PP -.nf -.br - QPainter painter; -.br - QPen pen( red, 2 ); // red solid line, 2 pixels wide -.br - painter.begin( &anyPaintDevice ); // paint something -.br - painter.setPen( pen ); // set the red, wide pen -.br - painter.drawRect( 40,30, 200,100 ); // draw a rectangle -.br - painter.setPen( blue ); // set blue pen, 0 pixel width -.br - painter.drawLine( 40,30, 240,130 ); // draw a diagonal in rectangle -.br - painter.end(); // painting done -.br -.fi -.PP -See the Qt::PenStyle enum type for a complete list of pen styles. -.PP -With reference to the end points of lines, for wide (non-0-width) pens it depends on the cap style whether the end point is drawn or not. QPainter will try to make sure that the end point is drawn for 0-width pens, but this cannot be absolutely guaranteed because the underlying drawing engine is free to use any (typically accelerated) algorithm for drawing 0-width lines. On all tested systems, however, the end point of at least all non-diagonal lines are drawn. -.PP -A pen's color(), width(), style(), capStyle() and joinStyle() can be set in the constructor or later with setColor(), setWidth(), setStyle(), setCapStyle() and setJoinStyle(). Pens may also be compared and streamed. -.PP -
                                        -.ce 1 -.B "[Image Omitted]" -.PP -
                                        -.PP -See also QPainter, QPainter::setPen(), Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPen::QPen ()" -Constructs a default black solid line pen with 0 width, which renders lines 1 pixel wide (fast diagonals). -.SH "QPen::QPen ( PenStyle style )" -Constructs a black pen with 0 width (fast diagonals) and style \fIstyle\fR. -.PP -See also setStyle(). -.SH "QPen::QPen ( const QColor & color, uint width = 0, PenStyle style = SolidLine )" -Constructs a pen with the specified \fIcolor\fR, \fIwidth\fR and \fIstyle\fR. -.PP -See also setWidth(), setStyle(), and setColor(). -.SH "QPen::QPen ( const QColor & cl, uint w, PenStyle s, PenCapStyle c, PenJoinStyle j )" -Constructs a pen with the specified color \fIcl\fR and width \fIw\fR. The pen style is set to \fIs\fR, the pen cap style to \fIc\fR and the pen join style to \fIj\fR. -.PP -A line width of 0 will produce a 1 pixel wide line using a fast algorithm for diagonals. A line width of 1 will also produce a 1 pixel wide line, but uses a slower more accurate algorithm for diagonals. For horizontal and vertical lines a line width of 0 is the same as a line width of 1. The cap and join style have no effect on 0-width lines. -.PP -See also setWidth(), setStyle(), and setColor(). -.SH "QPen::QPen ( const QPen & p )" -Constructs a pen that is a copy of \fIp\fR. -.SH "QPen::~QPen ()" -Destroys the pen. -.SH "PenCapStyle QPen::capStyle () const" -Returns the pen's cap style. -.PP -See also setCapStyle(). -.SH "const QColor & QPen::color () const" -Returns the pen color. -.PP -See also setColor(). -.PP -Example: scribble/scribble.h. -.SH "PenJoinStyle QPen::joinStyle () const" -Returns the pen's join style. -.PP -See also setJoinStyle(). -.SH "bool QPen::operator!= ( const QPen & p ) const" -Returns TRUE if the pen is different from \fIp\fR; otherwise returns FALSE. -.PP -Two pens are different if they have different styles, widths or colors. -.PP -See also operator==(). -.SH "QPen & QPen::operator= ( const QPen & p )" -Assigns \fIp\fR to this pen and returns a reference to this pen. -.SH "bool QPen::operator== ( const QPen & p ) const" -Returns TRUE if the pen is equal to \fIp\fR; otherwise returns FALSE. -.PP -Two pens are equal if they have equal styles, widths and colors. -.PP -See also operator!=(). -.SH "void QPen::setCapStyle ( PenCapStyle c )" -Sets the pen's cap style to \fIc\fR. -.PP -The default value is FlatCap. The cap style has no effect on 0-width pens. -.PP -
                                        -.ce 1 -.B "[Image Omitted]" -.PP -
                                        -.PP -\fBWarning:\fR On Windows 95/98 and Macintosh, the cap style setting has no effect. Wide lines are rendered as if the cap style was SquareCap. -.PP -See also capStyle(). -.PP -Example: themes/wood.cpp. -.SH "void QPen::setColor ( const QColor & c )" -Sets the pen color to \fIc\fR. -.PP -See also color(). -.PP -Examples: -.)l progress/progress.cpp and scribble/scribble.h. -.SH "void QPen::setJoinStyle ( PenJoinStyle j )" -Sets the pen's join style to \fIj\fR. -.PP -The default value is MiterJoin. The join style has no effect on 0-width pens. -.PP -
                                        -.ce 1 -.B "[Image Omitted]" -.PP -
                                        -.PP -\fBWarning:\fR On Windows 95/98 and Macintosh, the join style setting has no effect. Wide lines are rendered as if the join style was BevelJoin. -.PP -See also joinStyle(). -.PP -Example: themes/wood.cpp. -.SH "void QPen::setStyle ( PenStyle s )" -Sets the pen style to \fIs\fR. -.PP -See the Qt::PenStyle documentation for a list of all the styles. -.PP -\fBWarning:\fR On Mac OS X the style setting (other than NoPen and SolidLine) have no effect as they are not implemented by the underlying system. -.PP -\fBWarning:\fR On Windows 95/98, the style setting (other than NoPen and SolidLine) has no effect for lines with width greater than 1. -.PP -See also style(). -.PP -Example: chart/chartform_canvas.cpp. -.SH "void QPen::setWidth ( uint w )" -Sets the pen width to \fIw\fR. -.PP -A line width of 0 will produce a 1 pixel wide line using a fast algorithm for diagonals. A line width of 1 will also produce a 1 pixel wide line, but uses a slower more accurate algorithm for diagonals. For horizontal and vertical lines a line width of 0 is the same as a line width of 1. The cap and join style have no effect on 0-width lines. -.PP -See also width(). -.PP -Examples: -.)l multiple/ax2.h, progress/progress.cpp, and scribble/scribble.h. -.SH "PenStyle QPen::style () const" -Returns the pen style. -.PP -See also setStyle(). -.SH "uint QPen::width () const" -Returns the pen width. -.PP -See also setWidth(). -.PP -Example: scribble/scribble.h. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QPen & p )" -Writes the pen \fIp\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QPen & p )" -Reads a pen from the stream \fIs\fR into \fIp\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpen.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpen.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpicture.3qt b/doc/man/man3/qpicture.3qt deleted file mode 100644 index cad1469fd..000000000 --- a/doc/man/man3/qpicture.3qt +++ /dev/null @@ -1,255 +0,0 @@ -'\" t -.TH QPicture 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 -QPicture \- Paint device that records and replays QPainter commands -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPaintDevice. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPicture\fR ( int formatVersion = -1 )" -.br -.ti -1c -.BI "\fBQPicture\fR ( const QPicture & pic )" -.br -.ti -1c -.BI "\fB~QPicture\fR ()" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "const char * \fBdata\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetData\fR ( const char * data, uint size )" -.br -.ti -1c -.BI "bool \fBplay\fR ( QPainter * painter )" -.br -.ti -1c -.BI "bool \fBload\fR ( QIODevice * dev, const char * format = 0 )" -.br -.ti -1c -.BI "bool \fBload\fR ( const QString & fileName, const char * format = 0 )" -.br -.ti -1c -.BI "bool \fBsave\fR ( QIODevice * dev, const char * format = 0 )" -.br -.ti -1c -.BI "bool \fBsave\fR ( const QString & fileName, const char * format = 0 )" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR () const" -.br -.ti -1c -.BI "void \fBsetBoundingRect\fR ( const QRect & r )" -.br -.ti -1c -.BI "QPicture & \fBoperator=\fR ( const QPicture & p )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual int \fBmetric\fR ( int m ) const" -.br -.ti -1c -.BI "void \fBdetach\fR ()" -.br -.ti -1c -.BI "QPicture \fBcopy\fR () const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPicture & r )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPicture & r )" -.br -.in -1c -.SH DESCRIPTION -The QPicture class is a paint device that records and replays QPainter commands. -.PP -A picture serializes painter commands to an IO device in a platform-independent format. For example, a picture created under Windows can be read on a Sun SPARC. -.PP -Pictures are called meta-files on some platforms. -.PP -Qt pictures use a proprietary binary format. Unlike native picture (meta-file) formats on many window systems, Qt pictures have no limitations regarding their contents. Everything that can be painted can also be stored in a picture, e.g. fonts, pixmaps, regions, transformed graphics, etc. -.PP -QPicture is an implicitly shared class. -.PP -Example of how to record a picture: -.PP -.nf -.br - QPicture pic; -.br - QPainter p; -.br - p.begin( &pic ); // paint in picture -.br - p.drawEllipse( 10,20, 80,70 ); // draw an ellipse -.br - p.end(); // painting done -.br - pic.save( "drawing.pic" ); // save picture -.br -.fi -.PP -Example of how to replay a picture: -.PP -.nf -.br - QPicture pic; -.br - pic.load( "drawing.pic" ); // load picture -.br - QPainter p; -.br - p.begin( &myWidget ); // paint in myWidget -.br - p.drawPicture( pic ); // draw the picture -.br - p.end(); // painting done -.br -.fi -.PP -Pictures can also be drawn using play(). Some basic data about a picture is available, for example, size(), isNull() and boundingRect(). -.PP -See also Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPicture::QPicture ( int formatVersion = -1 )" -Constructs an empty picture. -.PP -The \fIformatVersion\fR parameter may be used to \fIcreate\fR a QPicture that can be read by applications that are compiled with earlier versions of Qt. -.TP -\fIformatVersion\fR == 1 is binary compatible with Qt 1.x and later. -.TP -\fIformatVersion\fR == 2 is binary compatible with Qt 2.0.x and later. -.TP -\fIformatVersion\fR == 3 is binary compatible with Qt 2.1.x and later. -.TP -\fIformatVersion\fR == 4 is binary compatible with Qt 3.0.x and later. -.TP -\fIformatVersion\fR == 5 is binary compatible with Qt 3.1. -.PP -Note that the default formatVersion is -1 which signifies the current release, i.e. for Qt 3.1 a formatVersion of 5 is the same as the default formatVersion of -1. -.PP -Reading pictures generated by earlier versions of Qt is supported and needs no special coding; the format is automatically detected. -.SH "QPicture::QPicture ( const QPicture & pic )" -Constructs a shallow copy of \fIpic\fR. -.SH "QPicture::~QPicture ()" -Destroys the picture. -.SH "QRect QPicture::boundingRect () const" -Returns the picture's bounding rectangle or an invalid rectangle if the picture contains no data. -.SH "QPicture QPicture::copy () const\fC [protected]\fR" -Returns a deep copy of the picture. -.SH "const char * QPicture::data () const" -Returns a pointer to the picture data. The pointer is only valid until the next non-const function is called on this picture. The returned pointer is 0 if the picture contains no data. -.PP -See also size() and isNull(). -.SH "void QPicture::detach ()\fC [protected]\fR" -Detaches from shared picture data and makes sure that this picture is the only one referring to the data. -.PP -If multiple pictures share common data, this picture makes a copy of the data and detaches itself from the sharing mechanism. Nothing is done if there is just a single reference. -.SH "bool QPicture::isNull () const" -Returns TRUE if the picture contains no data; otherwise returns FALSE. -.SH "bool QPicture::load ( const QString & fileName, const char * format = 0 )" -Loads a picture from the file specified by \fIfileName\fR and returns TRUE if successful; otherwise returns FALSE. -.PP -By default, the file will be interpreted as being in the native QPicture format. Specifying the \fIformat\fR string is optional and is only needed for importing picture data stored in a different format. -.PP -Currently, the only external format supported is the W3C SVG format which requires the Qt XML module. The corresponding \fIformat\fR string is "svg". -.PP -See also save(). -.PP -Examples: -.)l picture/picture.cpp and xform/xform.cpp. -.SH "bool QPicture::load ( QIODevice * dev, const char * format = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIdev\fR is the device to use for loading. -.SH "int QPicture::metric ( int m ) const\fC [virtual protected]\fR" -Internal implementation of the virtual QPaintDevice::metric() function. -.PP -Use the QPaintDeviceMetrics class instead. -.PP -A picture has the following hard-coded values: dpi=72, numcolors=16777216 and depth=24. -.PP -\fIm\fR is the metric to get. -.SH "QPicture & QPicture::operator= ( const QPicture & p )" -Assigns a shallow copy of \fIp\fR to this picture and returns a reference to this picture. -.SH "bool QPicture::play ( QPainter * painter )" -Replays the picture using \fIpainter\fR, and returns TRUE if successful; otherwise returns FALSE. -.PP -This function does exactly the same as QPainter::drawPicture() with (x, y) = (0, 0). -.SH "bool QPicture::save ( const QString & fileName, const char * format = 0 )" -Saves a picture to the file specified by \fIfileName\fR and returns TRUE if successful; otherwise returns FALSE. -.PP -Specifying the file \fIformat\fR string is optional. It's not recommended unless you intend to export the picture data for use by a third party reader. By default the data will be saved in the native QPicture file format. -.PP -Currently, the only external format supported is the W3C SVG format which requires the Qt XML module. The corresponding \fIformat\fR string is "svg". -.PP -See also load(). -.PP -Example: picture/picture.cpp. -.SH "bool QPicture::save ( QIODevice * dev, const char * format = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIdev\fR is the device to use for saving. -.SH "void QPicture::setBoundingRect ( const QRect & r )" -Sets the picture's bounding rectangle to \fIr\fR. The automatically calculated value is overriden. -.SH "void QPicture::setData ( const char * data, uint size )\fC [virtual]\fR" -Sets the picture data directly from \fIdata\fR and \fIsize\fR. This function copies the input data. -.PP -See also data() and size(). -.SH "uint QPicture::size () const" -Returns the size of the picture data. -.PP -See also data(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QPicture & r )" -Writes picture \fIr\fR to the stream \fIs\fR and returns a reference to the stream. -.SH "QDataStream & operator>> ( QDataStream & s, QPicture & r )" -Reads a picture from the stream \fIs\fR into picture \fIr\fR and returns -a reference to the stream. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpicture.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpicture.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpixmap.3qt b/doc/man/man3/qpixmap.3qt deleted file mode 100644 index 5ca74ab2b..000000000 --- a/doc/man/man3/qpixmap.3qt +++ /dev/null @@ -1,788 +0,0 @@ -'\" t -.TH QPixmap 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 -QPixmap \- Off-screen, pixel-based paint device -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPaintDevice and Qt. -.PP -Inherited by QBitmap and QCanvasPixmap. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBColorMode\fR { Auto, Color, Mono }" -.br -.ti -1c -.BI "enum \fBOptimization\fR { DefaultOptim, NoOptim, MemoryOptim = NoOptim, NormalOptim, BestOptim }" -.br -.ti -1c -.BI "\fBQPixmap\fR ()" -.br -.ti -1c -.BI "\fBQPixmap\fR ( const QImage & image )" -.br -.ti -1c -.BI "\fBQPixmap\fR ( int w, int h, int depth = -1, Optimization optimization = DefaultOptim )" -.br -.ti -1c -.BI "\fBQPixmap\fR ( const QSize & size, int depth = -1, Optimization optimization = DefaultOptim )" -.br -.ti -1c -.BI "\fBQPixmap\fR ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" -.br -.ti -1c -.BI "\fBQPixmap\fR ( const QString & fileName, const char * format, int conversion_flags )" -.br -.ti -1c -.BI "\fBQPixmap\fR ( const char * xpm[] )" -.br -.ti -1c -.BI "\fBQPixmap\fR ( const QByteArray & img_data )" -.br -.ti -1c -.BI "\fBQPixmap\fR ( const QPixmap & pixmap )" -.br -.ti -1c -.BI "\fB~QPixmap\fR ()" -.br -.ti -1c -.BI "QPixmap & \fBoperator=\fR ( const QPixmap & pixmap )" -.br -.ti -1c -.BI "QPixmap & \fBoperator=\fR ( const QImage & image )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "int \fBdepth\fR () const" -.br -.ti -1c -.BI "void \fBfill\fR ( const QColor & fillColor = Qt::white )" -.br -.ti -1c -.BI "void \fBfill\fR ( const QWidget * widget, int xofs, int yofs )" -.br -.ti -1c -.BI "void \fBfill\fR ( const QWidget * widget, const QPoint & ofs )" -.br -.ti -1c -.BI "void \fBresize\fR ( int w, int h )" -.br -.ti -1c -.BI "void \fBresize\fR ( const QSize & size )" -.br -.ti -1c -.BI "const QBitmap * \fBmask\fR () const" -.br -.ti -1c -.BI "void \fBsetMask\fR ( const QBitmap & newmask )" -.br -.ti -1c -.BI "bool \fBselfMask\fR () const" -.br -.ti -1c -.BI "bool \fBhasAlpha\fR () const" -.br -.ti -1c -.BI "bool \fBhasAlphaChannel\fR () const" -.br -.ti -1c -.BI "QBitmap \fBcreateHeuristicMask\fR ( bool clipTight = TRUE ) const" -.br -.ti -1c -.BI "QPixmap \fBxForm\fR ( const QWMatrix & matrix ) const" -.br -.ti -1c -.BI "QImage \fBconvertToImage\fR () const" -.br -.ti -1c -.BI "bool \fBconvertFromImage\fR ( const QImage & image, ColorMode mode = Auto )" -.br -.ti -1c -.BI "bool \fBconvertFromImage\fR ( const QImage & img, int conversion_flags )" -.br -.ti -1c -.BI "bool \fBload\fR ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" -.br -.ti -1c -.BI "bool \fBload\fR ( const QString & fileName, const char * format, int conversion_flags )" -.br -.ti -1c -.BI "bool \fBloadFromData\fR ( const uchar * buf, uint len, const char * format = 0, ColorMode mode = Auto )" -.br -.ti -1c -.BI "bool \fBloadFromData\fR ( const uchar * buf, uint len, const char * format, int conversion_flags )" -.br -.ti -1c -.BI "bool \fBloadFromData\fR ( const QByteArray & buf, const char * format = 0, int conversion_flags = 0 )" -.br -.ti -1c -.BI "bool \fBsave\fR ( const QString & fileName, const char * format, int quality = -1 ) const" -.br -.ti -1c -.BI "bool \fBsave\fR ( QIODevice * device, const char * format, int quality = -1 ) const" -.br -.ti -1c -.BI "int \fBserialNumber\fR () const" -.br -.ti -1c -.BI "Optimization \fBoptimization\fR () const" -.br -.ti -1c -.BI "void \fBsetOptimization\fR ( Optimization optimization )" -.br -.ti -1c -.BI "virtual void \fBdetach\fR ()" -.br -.ti -1c -.BI "bool \fBisQBitmap\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "int \fBdefaultDepth\fR ()" -.br -.ti -1c -.BI "QPixmap \fBfromMimeSource\fR ( const QString & abs_name )" -.br -.ti -1c -.BI "QPixmap \fBgrabWindow\fR ( WId window, int x = 0, int y = 0, int w = -1, int h = -1 )" -.br -.ti -1c -.BI "QPixmap \fBgrabWidget\fR ( QWidget * widget, int x = 0, int y = 0, int w = -1, int h = -1 )" -.br -.ti -1c -.BI "QWMatrix \fBtrueMatrix\fR ( const QWMatrix & matrix, int w, int h )" -.br -.ti -1c -.BI "const char * \fBimageFormat\fR ( const QString & fileName )" -.br -.ti -1c -.BI "Optimization \fBdefaultOptimization\fR ()" -.br -.ti -1c -.BI "void \fBsetDefaultOptimization\fR ( Optimization optimization )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQPixmap\fR ( int w, int h, const uchar * bits, bool isXbitmap )" -.br -.ti -1c -.BI "virtual int \fBmetric\fR ( int m ) const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPixmap & pixmap )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPixmap & pixmap )" -.br -.ti -1c -.BI "void \fBcopyBlt\fR ( QPixmap * dst, int dx, int dy, const QPixmap * src, int sx, int sy, int sw, int sh )" -.br -.in -1c -.SH DESCRIPTION -The QPixmap class is an off-screen, pixel-based paint device. -.PP -QPixmap is one of the two classes Qt provides for dealing with images; the other is QImage. QPixmap is designed and optimized for drawing; QImage is designed and optimized for I/O and for direct pixel access/manipulation. There are (slow) functions to convert between QImage and QPixmap: convertToImage() and convertFromImage(). -.PP -One common use of the QPixmap class is to enable smooth updating of widgets. Whenever something complex needs to be drawn, you can use a pixmap to obtain flicker-free drawing, like this: -.PP -
                                          -.IP 1 -Create a pixmap with the same size as the widget. -.IP 2 -Fill the pixmap with the widget background color. -.IP 3 -Paint the pixmap. -.IP 4 -bitBlt() the pixmap contents onto the widget. -.PP -Pixel data in a pixmap is internal and is managed by the underlying window system. Pixels can be accessed only through QPainter functions, through bitBlt(), and by converting the QPixmap to a QImage. -.PP -You can easily display a QPixmap on the screen using QLabel::setPixmap(). For example, all the QButton subclasses support pixmap use. -.PP -The QPixmap class uses copy-on-write, so it is practical to pass QPixmap objects by value. -.PP -You can retrieve the width(), height(), depth() and size() of a pixmap. The enclosing rectangle is given by rect(). Pixmaps can be filled with fill() and resized with resize(). You can create and set a mask with createHeuristicMask() and setMask(). Use selfMask() to see if the pixmap is identical to its mask. -.PP -In addition to loading a pixmap from file using load() you can also loadFromData(). You can control optimization with setOptimization() and obtain a transformed version of the pixmap using xForm() -.PP -Note regarding Windows 95 and 98: on Windows 9x the system crashes if you create more than about 1000 pixmaps, independent of the size of the pixmaps or installed RAM. Windows NT-systems (including 2000, XP and following versions) do not have the same limitation, but depending on the graphics equipment the system will fail to allocate pixmap objects at some point (due to system running out of GDI resources). -.PP -Qt tries to work around the resource limitation. If you set the pixmap optimization to QPixmap::MemoryOptim and the width of your pixmap is less than or equal to 128 pixels, Qt stores the pixmap in a way that is very memory-efficient when there are many pixmaps. -.PP -If your application uses dozens or hundreds of pixmaps (for example on tool bar buttons and in popup menus), and you plan to run it on Windows 95 or Windows 98, we recommend using code like this: -.PP -.nf -.br - QPixmap::setDefaultOptimization( QPixmap::MemoryOptim ); -.br - while ( ... ) { -.br - // load tool bar pixmaps etc. -.br - QPixmap *pixmap = new QPixmap(fileName); -.br - } -.br - QPixmap::setDefaultOptimization( QPixmap::NormalOptim ); -.br -.fi -.PP -In general it is recommended to make as much use of QPixmap's implicit sharing and the QPixmapCache as possible. -.PP -See also QBitmap, QImage, QImageIO, Shared Classes, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SS "Member Type Documentation" -.SH "QPixmap::ColorMode" -This enum type defines the color modes that exist for converting QImage objects to QPixmap. -.TP -\fCQPixmap::Auto\fR - Select Color or Mono on a case-by-case basis. -.TP -\fCQPixmap::Color\fR - Always create colored pixmaps. -.TP -\fCQPixmap::Mono\fR - Always create bitmaps. -.SH "QPixmap::Optimization" -QPixmap has the choice of optimizing for speed or memory in a few places; the best choice varies from pixmap to pixmap but can generally be derived heuristically. This enum type defines a number of optimization modes that you can set for any pixmap to tweak the speed/memory tradeoffs: -.TP -\fCQPixmap::DefaultOptim\fR - Whatever QPixmap::defaultOptimization() returns. A pixmap with this optimization will have whatever the current default optimization is. If the default optimization is changed using setDefaultOptimization(), then this will not effect any pixmaps that have already been created. -.TP -\fCQPixmap::NoOptim\fR - No optimization (currently the same as MemoryOptim). -.TP -\fCQPixmap::MemoryOptim\fR - Optimize for minimal memory use on Windows 9x and X11 systems. -.TP -\fCQPixmap::NormalOptim\fR - Optimize for typical usage. Often uses more memory than MemoryOptim, and is often faster. -.TP -\fCQPixmap::BestOptim\fR - Optimize for pixmaps that are drawn very often and where performance is critical. Generally uses more memory than NormalOptim and may provide a little more speed. -.PP -We recommend using DefaultOptim. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPixmap::QPixmap ()" -Constructs a null pixmap. -.PP -See also isNull(). -.SH "QPixmap::QPixmap ( const QImage & image )" -Constructs a pixmap from the QImage \fIimage\fR. -.PP -See also convertFromImage(). -.SH "QPixmap::QPixmap ( int w, int h, int depth = -1, Optimization optimization = DefaultOptim )" -Constructs a pixmap with \fIw\fR width, \fIh\fR height and \fIdepth\fR bits per pixel. The pixmap is optimized in accordance with the \fIoptimization\fR value. -.PP -The contents of the pixmap is uninitialized. -.PP -The \fIdepth\fR can be either 1 (monochrome) or the depth of the current video mode. If \fIdepth\fR is negative, then the hardware depth of the current video mode will be used. -.PP -If either \fIw\fR or \fIh\fR is zero, a null pixmap is constructed. -.PP -See also isNull() and QPixmap::Optimization. -.SH "QPixmap::QPixmap ( const QSize & size, int depth = -1, Optimization optimization = DefaultOptim )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a pixmap of size \fIsize\fR, \fIdepth\fR bits per pixel, optimized in accordance with the \fIoptimization\fR value. -.SH "QPixmap::QPixmap ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" -Constructs a pixmap from the file \fIfileName\fR. If the file does not exist or is of an unknown format, the pixmap becomes a null pixmap. -.PP -The \fIfileName\fR, \fIformat\fR and \fImode\fR parameters are passed on to load(). This means that the data in \fIfileName\fR is not compiled into the binary. If \fIfileName\fR contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory. -.PP -See also QPixmap::ColorMode, isNull(), load(), loadFromData(), save(), and imageFormat(). -.SH "QPixmap::QPixmap ( const QString & fileName, const char * format, int conversion_flags )" -Constructs a pixmap from the file \fIfileName\fR. If the file does not exist or is of an unknown format, the pixmap becomes a null pixmap. -.PP -The \fIfileName\fR, \fIformat\fR and \fIconversion_flags\fR parameters are passed on to load(). This means that the data in \fIfileName\fR is not compiled into the binary. If \fIfileName\fR contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory. -.PP -If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. -.PP -See also Qt::ImageConversionFlags, isNull(), load(), loadFromData(), save(), and imageFormat(). -.SH "QPixmap::QPixmap ( const char * xpm[] )" -Constructs a pixmap from \fIxpm\fR, which must be a valid XPM image. -.PP -Errors are silently ignored. -.PP -Note that it's possible to squeeze the XPM variable a little bit by using an unusual declaration: -.PP -.nf -.br - static const char * const start_xpm[]={ -.br - "16 15 8 1", -.br - "a c #cec6bd", -.br - .... -.br -.fi -.PP -The extra \fCconst\fR makes the entire definition read-only, which is slightly more efficient (for example, when the code is in a shared library) and ROMable when the application is to be stored in ROM. -.PP -In order to use that sort of declaration you must cast the variable back to \fCconst char **\fR when you create the QPixmap. -.SH "QPixmap::QPixmap ( const QByteArray & img_data )" -Constructs a pixmaps by loading from \fIimg_data\fR. The data can be in any image format supported by Qt. -.PP -See also loadFromData(). -.SH "QPixmap::QPixmap ( const QPixmap & pixmap )" -Constructs a pixmap that is a copy of \fIpixmap\fR. -.SH "QPixmap::QPixmap ( int w, int h, const uchar * bits, bool isXbitmap )\fC [protected]\fR" -Constructs a monochrome pixmap, with width \fIw\fR and height \fIh\fR, that is initialized with the data in \fIbits\fR. The \fIisXbitmap\fR indicates whether the data is an X bitmap and defaults to FALSE. This constructor is protected and used by the QBitmap class. -.SH "QPixmap::~QPixmap ()" -Destroys the pixmap. -.SH "bool QPixmap::convertFromImage ( const QImage & img, int conversion_flags )" -Converts image \fIimg\fR and sets this pixmap. Returns TRUE if successful; otherwise returns FALSE. -.PP -The \fIconversion_flags\fR argument is a bitwise-OR of the Qt::ImageConversionFlags. Passing 0 for \fIconversion_flags\fR sets all the default options. -.PP -Note that even though a QPixmap with depth 1 behaves much like a QBitmap, isQBitmap() returns FALSE. -.PP -If a pixmap with depth 1 is painted with color0 and color1 and converted to an image, the pixels painted with color0 will produce pixel index 0 in the image and those painted with color1 will produce pixel index 1. -.PP -See also convertToImage(), isQBitmap(), QImage::convertDepth(), defaultDepth(), and QImage::hasAlphaBuffer(). -.PP -Examples: -.)l canvas/canvas.cpp and themes/wood.cpp. -.SH "bool QPixmap::convertFromImage ( const QImage & image, ColorMode mode = Auto )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Converts \fIimage\fR and sets this pixmap using color mode \fImode\fR. Returns TRUE if successful; otherwise returns FALSE. -.PP -See also QPixmap::ColorMode. -.SH "QImage QPixmap::convertToImage () const" -Converts the pixmap to a QImage. Returns a null image if it fails. -.PP -If the pixmap has 1-bit depth, the returned image will also be 1 bit deep. If the pixmap has 2- to 8-bit depth, the returned image has 8-bit depth. If the pixmap has greater than 8-bit depth, the returned image has 32-bit depth. -.PP -Note that for the moment, alpha masks on monochrome images are ignored. -.PP -See also convertFromImage(). -.PP -Example: qmag/qmag.cpp. -.SH "QBitmap QPixmap::createHeuristicMask ( bool clipTight = TRUE ) const" -Creates and returns a heuristic mask for this pixmap. It works by selecting a color from one of the corners and then chipping away pixels of that color, starting at all the edges. -.PP -The mask may not be perfect but it should be reasonable, so you can do things such as the following: -.PP -.nf -.br - pm->setMask( pm->createHeuristicMask() ); -.br -.fi -.PP -This function is slow because it involves transformation to a QImage, non-trivial computations and a transformation back to a QBitmap. -.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. -.PP -See also QImage::createHeuristicMask(). -.SH "int QPixmap::defaultDepth ()\fC [static]\fR" -Returns the default pixmap depth, i.e. the depth a pixmap gets if -1 is specified. -.PP -See also depth(). -.SH "Optimization QPixmap::defaultOptimization ()\fC [static]\fR" -Returns the default pixmap optimization setting. -.PP -See also setDefaultOptimization(), setOptimization(), and optimization(). -.SH "int QPixmap::depth () const" -Returns the depth of the pixmap. -.PP -The pixmap depth is also called bits per pixel (bpp) or bit planes of a pixmap. A null pixmap has depth 0. -.PP -See also defaultDepth(), isNull(), and QImage::convertDepth(). -.SH "void QPixmap::detach ()\fC [virtual]\fR" -This is a special-purpose function that detaches the pixmap from shared pixmap data. -.PP -A pixmap is automatically detached by Qt whenever its contents is about to change. This is done in all QPixmap member functions that modify the pixmap (fill(), resize(), convertFromImage(), load(), etc.), in bitBlt() for the destination pixmap and in QPainter::begin() on a pixmap. -.PP -It is possible to modify a pixmap without letting Qt know. You can first obtain the system-dependent handle() and then call system-specific functions (for instance, BitBlt under Windows) that modify the pixmap contents. In such cases, you can call detach() to cut the pixmap loose from other pixmaps that share data with this one. -.PP -detach() returns immediately if there is just a single reference or if the pixmap has not been initialized yet. -.SH "void QPixmap::fill ( const QColor & fillColor = Qt::white )" -Fills the pixmap with the color \fIfillColor\fR. -.PP -Examples: -.)l chart/setdataform.cpp, desktop/desktop.cpp, grapher/grapher.cpp, hello/hello.cpp, t10/cannon.cpp, themes/metal.cpp, and xform/xform.cpp. -.SH "void QPixmap::fill ( const QWidget * widget, int xofs, int yofs )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Fills the pixmap with the \fIwidget\fR's background color or pixmap. If the background is empty, nothing is done. \fIxofs\fR, \fIyofs\fR is an offset in the widget. -.SH "void QPixmap::fill ( const QWidget * widget, const QPoint & ofs )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Fills the pixmap with the \fIwidget\fR's background color or pixmap. If the background is empty, nothing is done. -.PP -The \fIofs\fR point is an offset in the widget. -.PP -The point \fIofs\fR is a point in the widget's coordinate system. The pixmap's top-left pixel will be mapped to the point \fIofs\fR in the widget. This is significant if the widget has a background pixmap; otherwise the pixmap will simply be filled with the background color of the widget. -.PP -Example: -.PP -.nf -.br - void CuteWidget::paintEvent( QPaintEvent *e ) -.br - { -.br - QRect ur = e->rect(); // rectangle to update -.br - QPixmap pix( ur.size() ); // Pixmap for double-buffering -.br - pix.fill( this, ur.topLeft() ); // fill with widget background -.br -.br - QPainter p( &pix ); -.br - p.translate( -ur.x(), -ur.y() ); // use widget coordinate system -.br - // when drawing on pixmap -.br - // ... draw on pixmap ... -.br -.br - p.end(); -.br -.br - bitBlt( this, ur.topLeft(), &pix ); -.br - } -.br -.fi -.SH "QPixmap QPixmap::fromMimeSource ( const QString & abs_name )\fC [static]\fR" -Convenience function. Gets the data associated with the absolute name \fIabs_name\fR from the default mime source factory and decodes it to a pixmap. -.PP -See also QMimeSourceFactory, QImage::fromMimeSource(), and QImageDrag::decode(). -.PP -Example: textedit/textedit.cpp. -.SH "QPixmap QPixmap::grabWidget ( QWidget * widget, int x = 0, int y = 0, int w = -1, int h = -1 )\fC [static]\fR" -Creates a pixmap and paints \fIwidget\fR in it. -.PP -If the \fIwidget\fR has any children, then they are also painted in the appropriate positions. -.PP -If you specify \fIx\fR, \fIy\fR, \fIw\fR or \fIh\fR, only the rectangle you specify is painted. The defaults are 0, 0 (top-left corner) and -1,-1 (which means the entire widget). -.PP -(If \fIw\fR is negative, the function copies everything to the right border of the window. If \fIh\fR is negative, the function copies everything to the bottom of the window.) -.PP -If \fIwidget\fR is 0, or if the rectangle defined by \fIx\fR, \fIy\fR, the modified \fIw\fR and the modified \fIh\fR does not overlap the \fIwidget\fR->rect(), this function will return a null QPixmap. -.PP -This function actually asks \fIwidget\fR to paint itself (and its children to paint themselves). QPixmap::grabWindow() grabs pixels off the screen, which is a bit faster and picks up \fIexactly\fR what's on-screen. This function works by calling paintEvent() with painter redirection turned on. If there are overlaying windows, grabWindow() will see them, but not this function. -.PP -If there is overlap, it returns a pixmap of the size you want, containing a rendering of \fIwidget\fR. If the rectangle you ask for is a superset of \fIwidget\fR, the areas outside \fIwidget\fR are covered with the widget's background. -.PP -If an error occurs when trying to grab the widget, such as the size of the widget being too large to fit in memory, an isNull() pixmap is returned. -.PP -See also grabWindow(), QPainter::redirect(), and QWidget::paintEvent(). -.SH "QPixmap QPixmap::grabWindow ( WId window, int x = 0, int y = 0, int w = -1, int h = -1 )\fC [static]\fR" -Grabs the contents of the window \fIwindow\fR and makes a pixmap out of it. Returns the pixmap. -.PP -The arguments \fI(x, y)\fR specify the offset in the window, whereas \fI(w, h)\fR specify the width and height of the area to be copied. -.PP -If \fIw\fR is negative, the function copies everything to the right border of the window. If \fIh\fR is negative, the function copies everything to the bottom of the window. -.PP -Note that grabWindow() grabs pixels from the screen, not from the window. If there is another window partially or entirely over the one you grab, you get pixels from the overlying window, too. -.PP -Note also that the mouse cursor is generally not grabbed. -.PP -The reason we use a window identifier and not a QWidget is to enable grabbing of windows that are not part of the application, window system frames, and so on. -.PP -\fBWarning:\fR Grabbing an area outside the screen is not safe in general. This depends on the underlying window system. -.PP -\fBWarning:\fR X11 only: If \fIwindow\fR is not the same depth as the root window and another window partially or entirely obscures the one you grab, you will \fInot\fR get pixels from the overlying window. The contests of the obscured areas in the pixmap are undefined and uninitialized. -.PP -See also grabWidget(). -.PP -Example: qmag/qmag.cpp. -.SH "bool QPixmap::hasAlpha () const" -Returns TRUE this pixmap has an alpha channel or a mask. -.PP -See also hasAlphaChannel() and mask(). -.SH "bool QPixmap::hasAlphaChannel () const" -Returns TRUE if the pixmap has an alpha channel; otherwise it returns FALSE. -.PP -NOTE: If the pixmap has a mask but not alpha channel, this function returns FALSE. -.PP -See also hasAlpha() and mask(). -.SH "int QPixmap::height () const" -Returns the height of the pixmap. -.PP -See also width(), size(), and rect(). -.PP -Examples: -.)l desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, scrollview/scrollview.cpp, t10/cannon.cpp, and xform/xform.cpp. -.SH "const char * QPixmap::imageFormat ( const QString & fileName )\fC [static]\fR" -Returns a string that specifies the image format of the file \fIfileName\fR, or 0 if the file cannot be read or if the format cannot be recognized. -.PP -The QImageIO documentation lists the supported image formats. -.PP -See also load() and save(). -.SH "bool QPixmap::isNull () const" -Returns TRUE if this is a null pixmap; otherwise returns FALSE. -.PP -A null pixmap has zero width, zero height and no contents. You cannot draw in a null pixmap or bitBlt() anything to it. -.PP -Resizing an existing pixmap to (0, 0) makes a pixmap into a null pixmap. -.PP -See also resize(). -.PP -Examples: -.)l movies/main.cpp, qdir/qdir.cpp, qmag/qmag.cpp, and scrollview/scrollview.cpp. -.SH "bool QPixmap::isQBitmap () const" -Returns TRUE if this is a QBitmap; otherwise returns FALSE. -.SH "bool QPixmap::load ( const QString & fileName, const char * format, int conversion_flags )" -Loads a pixmap from the file \fIfileName\fR at runtime. Returns TRUE if successful; otherwise returns FALSE. -.PP -If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. -.PP -See the convertFromImage() documentation for a description of the \fIconversion_flags\fR argument. -.PP -The QImageIO documentation lists the supported image formats and explains how to add extra formats. -.PP -See also loadFromData(), save(), imageFormat(), QImage::load(), and QImageIO. -.PP -Examples: -.)l picture/picture.cpp, scrollview/scrollview.cpp, and xform/xform.cpp. -.SH "bool QPixmap::load ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads a pixmap from the file \fIfileName\fR at runtime. -.PP -If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. -.PP -The \fImode\fR is used to specify the color mode of the pixmap. -.PP -See also QPixmap::ColorMode. -.SH "bool QPixmap::loadFromData ( const uchar * buf, uint len, const char * format, int conversion_flags )" -Loads a pixmap from the binary data in \fIbuf\fR (\fIlen\fR bytes). Returns TRUE if successful; otherwise returns FALSE. -.PP -If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. -.PP -See the convertFromImage() documentation for a description of the \fIconversion_flags\fR argument. -.PP -The QImageIO documentation lists the supported image formats and explains how to add extra formats. -.PP -See also load(), save(), imageFormat(), QImage::loadFromData(), and QImageIO. -.SH "bool QPixmap::loadFromData ( const uchar * buf, uint len, const char * format = 0, ColorMode mode = Auto )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads a pixmap from the binary data in \fIbuf\fR (\fIlen\fR bytes) using color mode \fImode\fR. Returns TRUE if successful; otherwise returns FALSE. -.PP -If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. -.PP -See also QPixmap::ColorMode. -.SH "bool QPixmap::loadFromData ( const QByteArray & buf, const char * format = 0, int conversion_flags = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "const QBitmap * QPixmap::mask () const" -Returns the mask bitmap, or 0 if no mask has been set. -.PP -See also setMask(), QBitmap, and hasAlpha(). -.SH "int QPixmap::metric ( int m ) const\fC [virtual protected]\fR" -Internal implementation of the virtual QPaintDevice::metric() function. -.PP -Use the QPaintDeviceMetrics class instead. -.PP -\fIm\fR is the metric to get. -.SH "QPixmap & QPixmap::operator= ( const QPixmap & pixmap )" -Assigns the pixmap \fIpixmap\fR to this pixmap and returns a reference to this pixmap. -.SH "QPixmap & QPixmap::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 pixmap that is assigned to this pixmap. Returns a reference to the pixmap. -.PP -See also convertFromImage(). -.SH "Optimization QPixmap::optimization () const" -Returns the optimization setting for this pixmap. -.PP -The default optimization setting is QPixmap::NormalOptim. You can change this setting in two ways: -.TP -Call setDefaultOptimization() to set the default optimization for all new pixmaps. -.TP -Call setOptimization() to set the optimization for individual pixmaps. -.PP -See also setOptimization(), setDefaultOptimization(), and defaultOptimization(). -.SH "QRect QPixmap::rect () const" -Returns the enclosing rectangle (0,0,width(),height()) of the pixmap. -.PP -See also width(), height(), and size(). -.SH "void QPixmap::resize ( int w, int h )" -Resizes the pixmap to \fIw\fR width and \fIh\fR height. If either \fIw\fR or \fIh\fR is 0, the pixmap becomes a null pixmap. -.PP -If both \fIw\fR and \fIh\fR are greater than 0, a valid pixmap is created. New pixels will be uninitialized (random) if the pixmap is expanded. -.PP -Examples: -.)l desktop/desktop.cpp and grapher/grapher.cpp. -.SH "void QPixmap::resize ( const QSize & size )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Resizes the pixmap to size \fIsize\fR. -.SH "bool QPixmap::save ( const QString & fileName, const char * format, int quality = -1 ) const" -Saves the pixmap to the file \fIfileName\fR using the image file format \fIformat\fR and a quality factor \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 to use the default settings. Returns TRUE if successful; otherwise returns FALSE. -.PP -See also load(), loadFromData(), imageFormat(), QImage::save(), and QImageIO. -.PP -Example: qmag/qmag.cpp. -.SH "bool QPixmap::save ( QIODevice * device, const char * format, int quality = -1 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function writes a QPixmap to the QIODevice, \fIdevice\fR. This can be used, for example, to save a pixmap directly into a QByteArray: -.PP -.nf -.br - QPixmap pixmap; -.br - QByteArray ba; -.br - QBuffer buffer( ba ); -.br - buffer.open( IO_WriteOnly ); -.br - pixmap.save( &buffer, "PNG" ); // writes pixmap into ba in PNG format -.br -.fi -.SH "bool QPixmap::selfMask () const" -Returns TRUE if the pixmap's mask is identical to the pixmap itself; otherwise returns FALSE. -.PP -See also mask(). -.SH "int QPixmap::serialNumber () const" -Returns a number that uniquely identifies the contents of this QPixmap object. This means that multiple QPixmap objects can have the same serial number as long as they refer to the same contents. -.PP -An example of where this is useful is for caching QPixmaps. -.PP -See also QPixmapCache. -.SH "void QPixmap::setDefaultOptimization ( Optimization optimization )\fC [static]\fR" -Sets the default pixmap optimization. -.PP -All \fInew\fR pixmaps that are created will use this default optimization. You may also set optimization for individual pixmaps using the setOptimization() function. -.PP -The initial default \fIoptimization\fR setting is \fCQPixmap::Normal\fR. -.PP -See also defaultOptimization(), setOptimization(), and optimization(). -.SH "void QPixmap::setMask ( const QBitmap & newmask )" -Sets a mask bitmap. -.PP -The \fInewmask\fR bitmap defines the clip mask for this pixmap. Every pixel in \fInewmask\fR corresponds to a pixel in this pixmap. Pixel value 1 means opaque and pixel value 0 means transparent. The mask must have the same size as this pixmap. -.PP -\fBWarning:\fR Setting the mask on a pixmap will cause any alpha channel data to be cleared. For example: -.PP -.nf -.br - QPixmap alpha( "image-with-alpha.png" ); -.br - QPixmap alphacopy = alpha; -.br - alphacopy.setMask( *alphacopy.mask() ); -.br -.fi -Now, alpha and alphacopy are visually different. -.PP -Setting a null mask resets the mask. -.PP -See also mask(), createHeuristicMask(), and QBitmap. -.SH "void QPixmap::setOptimization ( Optimization optimization )" -Sets pixmap drawing optimization for this pixmap. -.PP -The \fIoptimization\fR setting affects pixmap operations, in particular drawing of transparent pixmaps (bitBlt() a pixmap with a mask set) and pixmap transformations (the xForm() function). -.PP -Pixmap optimization involves keeping intermediate results in a cache buffer and using the cache to speed up bitBlt() and xForm(). The cost is more memory consumption, up to twice as much as an unoptimized pixmap. -.PP -Use the setDefaultOptimization() to change the default optimization for all new pixmaps. -.PP -See also optimization(), setDefaultOptimization(), and defaultOptimization(). -.PP -Example: desktop/desktop.cpp. -.SH "QSize QPixmap::size () const" -Returns the size of the pixmap. -.PP -See also width(), height(), and rect(). -.PP -Example: movies/main.cpp. -.SH "QWMatrix QPixmap::trueMatrix ( const QWMatrix & matrix, int w, int h )\fC [static]\fR" -Returns the actual matrix used for transforming a pixmap with \fIw\fR width and \fIh\fR height and matrix \fImatrix\fR. -.PP -When transforming a pixmap with xForm(), the transformation matrix is internally adjusted to compensate for unwanted translation, i.e. xForm() returns the smallest pixmap containing all transformed points of the original pixmap. -.PP -This function returns the modified matrix, which maps points correctly from the original pixmap into the new pixmap. -.PP -See also xForm() and QWMatrix. -.SH "int QPixmap::width () const" -Returns the width of the pixmap. -.PP -See also height(), size(), and rect(). -.PP -Examples: -.)l desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, scrollview/scrollview.cpp, and xform/xform.cpp. -.SH "QPixmap QPixmap::xForm ( const QWMatrix & matrix ) const" -Returns a copy of the pixmap that is transformed using \fImatrix\fR. The original pixmap is not changed. -.PP -The transformation \fImatrix\fR is internally adjusted to compensate for unwanted translation, i.e. xForm() returns the smallest image that contains all the transformed points of the original image. -.PP -This function is slow because it involves transformation to a QImage, non-trivial computations and a transformation back to a QPixmap. -.PP -See also trueMatrix(), QWMatrix, QPainter::setWorldMatrix(), and QImage::xForm(). -.PP -Examples: -.)l desktop/desktop.cpp, fileiconview/qfileiconview.cpp, movies/main.cpp, and qmag/qmag.cpp. -.SH RELATED FUNCTION DOCUMENTATION -.SH "void copyBlt ( QPixmap * dst, int dx, int dy, const QPixmap * src, int sx, int sy, int sw, int sh )" -Copies a block of pixels from \fIsrc\fR to \fIdst\fR. The alpha channel and mask data (if any) is also copied from \fIsrc\fR. NOTE: \fIsrc\fR is \fInot\fR alpha blended or masked when copied to \fIdst\fR. Use bitBlt() or QPainter::drawPixmap() to perform alpha blending or masked drawing. -.PP -\fIsx\fR, \fIsy\fR is the top-left pixel in \fIsrc\fR (0, 0 by default), \fIdx\fR, \fIdy\fR is the top-left position in \fIdst\fR and \fIsw\fR, \\sh is the size of the copied block (all of \fIsrc\fR by default). -.PP -If \fIsrc\fR, \fIdst\fR, \fIsw\fR or \fIsh\fR is 0 (zero), copyBlt() does nothing. If \fIsw\fR or \fIsh\fR is negative, copyBlt() copies starting at \fIsx\fR (and respectively, \fIsy\fR) and ending at the right edge (and respectively, the bottom edge) of \fIsrc\fR. -.PP -copyBlt() does nothing if \fIsrc\fR and \fIdst\fR have different depths. -.SH "QDataStream & operator<< ( QDataStream & s, const QPixmap & pixmap )" -Writes the pixmap \fIpixmap\fR to the stream \fIs\fR as a PNG image. -.PP -Note that writing the stream to a file will not produce a valid image file. -.PP -See also QPixmap::save() and Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QPixmap & pixmap )" -Reads a pixmap from the stream \fIs\fR into the pixmap \fIpixmap\fR. -.PP -See also QPixmap::load() and Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpixmap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpixmap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpixmapcache.3qt b/doc/man/man3/qpixmapcache.3qt deleted file mode 100644 index 6a0d98af1..000000000 --- a/doc/man/man3/qpixmapcache.3qt +++ /dev/null @@ -1,145 +0,0 @@ -'\" t -.TH QPixmapCache 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 -QPixmapCache \- Application-global cache for pixmaps -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Static Public Members" -
                                        1. int \fBcacheLimit\fR ()
                                        2. void \fBsetCacheLimit\fR ( int n )
                                        3. QPixmap * \fBfind\fR ( const QString & key )
                                        4. bool \fBfind\fR ( const QString & key, QPixmap & pm )
                                        5. bool insert ( const QString & key, QPixmap * pm ) \fI(obsolete)\fR
                                        6. bool \fBinsert\fR ( const QString & key, const QPixmap & pm )
                                        7. void \fBremove\fR ( const QString & key )
                                        8. void \fBclear\fR () -.SH DESCRIPTION -The QPixmapCache class provides an application-global cache for pixmaps. -.PP -This class is a tool for optimized drawing with QPixmap. You can use it to store temporary pixmaps that are expensive to generate without using more storage space than cacheLimit(). Use insert() to insert pixmaps, find() to find them and clear() to empty the cache. -.PP -For example, QRadioButton has a non-trivial visual representation so we don't want to regenerate a pixmap whenever a radio button is displayed or changes state. In the function QRadioButton::drawButton(), we do not draw the radio button directly. Instead, we first check the global pixmap cache for a pixmap with the key "$qt_radio_nnn_", where \fCnnn\fR is a numerical value that specifies the the radio button state. If a pixmap is found, we bitBlt() it onto the widget and return. Otherwise, we create a new pixmap, draw the radio button in the pixmap, and finally insert the pixmap in the global pixmap cache, using the key above. The bitBlt() is ten times faster than drawing the radio button. All radio buttons in the program share the cached pixmap since QPixmapCache is application-global. -.PP -QPixmapCache contains no member data, only static functions to access the global pixmap cache. It creates an internal QCache for caching the pixmaps. -.PP -The cache associates a pixmap with a string (key). If two pixmaps are inserted into the cache using equal keys, then the last pixmap will hide the first pixmap. The QDict and QCache classes do exactly the same. -.PP -The cache becomes full when the total size of all pixmaps in the cache exceeds cacheLimit(). The initial cache limit is 1024 KByte (1 MByte); it is changed with setCacheLimit(). A pixmap takes roughly width*height*depth/8 bytes of memory. -.PP -See the QCache documentation for more details about the cache mechanism. -.PP -See also Environment Classes, Graphics Classes, and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "int QPixmapCache::cacheLimit ()\fC [static]\fR" -Returns the cache limit (in kilobytes). -.PP -The default setting is 1024 kilobytes. -.PP -See also setCacheLimit(). -.SH "void QPixmapCache::clear ()\fC [static]\fR" -Removes all pixmaps from the cache. -.SH "QPixmap * QPixmapCache::find ( const QString & key )\fC [static]\fR" -Returns the pixmap associated with the \fIkey\fR in the cache, or null if there is no such pixmap. -.PP -\fBWarning:\fR If valid, you should copy the pixmap immediately (this is fast). Subsequent insertions into the cache could cause the pointer to become invalid. For this reason, we recommend you use find(const QString&, QPixmap&) instead. -.PP -Example: -.PP -.nf -.br - QPixmap* pp; -.br - QPixmap p; -.br - if ( (pp=QPixmapCache::find("my_big_image", pm)) ) { -.br - p = *pp; -.br - } else { -.br - p.load("bigimage.png"); -.br - QPixmapCache::insert("my_big_image", new QPixmap(p)); -.br - } -.br - painter->drawPixmap(0, 0, p); -.br -.fi -.SH "bool QPixmapCache::find ( const QString & key, QPixmap & pm )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Looks for a cached pixmap associated with the \fIkey\fR in the cache. If a pixmap is found, the function sets \fIpm\fR to that pixmap and returns TRUE; otherwise leaves \fIpm\fR alone and returns FALSE. -.PP -Example: -.PP -.nf -.br - QPixmap p; -.br - if ( !QPixmapCache::find("my_big_image", pm) ) { -.br - pm.load("bigimage.png"); -.br - QPixmapCache::insert("my_big_image", pm); -.br - } -.br - painter->drawPixmap(0, 0, p); -.br -.fi -.SH "bool QPixmapCache::insert ( const QString & key, const QPixmap & pm )\fC [static]\fR" -Inserts a copy of the pixmap \fIpm\fR associated with the \fIkey\fR into the cache. -.PP -All pixmaps inserted by the Qt library have a key starting with" $qt", so your own pixmap keys should never begin "$qt". -.PP -When a pixmap is inserted and the cache is about to exceed its limit, it removes pixmaps until there is enough room for the pixmap to be inserted. -.PP -The oldest pixmaps (least recently accessed in the cache) are deleted when more space is needed. -.PP -See also setCacheLimit(). -.SH "bool QPixmapCache::insert ( const QString & key, QPixmap * pm )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Inserts the pixmap \fIpm\fR associated with \fIkey\fR into the cache. Returns TRUE if successful, or FALSE if the pixmap is too big for the cache. -.PP -\fB Note: \fIpm\fR must be allocated on the heap (using \fCnew\fR). -.PP -If this function returns FALSE, you must delete \fIpm\fR yourself. -.PP -If this function returns TRUE, do not use \fIpm\fR afterwards or keep references to it because any other insertions into the cache, whether from anywhere in the application or within Qt itself, could cause the pixmap to be discarded from the cache and the pointer to become invalid. -.PP -Due to these dangers, we strongly recommend that you use insert(const QString&, const QPixmap&) instead. \fR -.SH "void QPixmapCache::remove ( const QString & key )\fC [static]\fR" -Removes the pixmap associated with \fIkey\fR from the cache. -.SH "void QPixmapCache::setCacheLimit ( int n )\fC [static]\fR" -Sets the cache limit to \fIn\fR kilobytes. -.PP -The default setting is 1024 kilobytes. -.PP -See also cacheLimit(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpixmapcache.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpixmapcache.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qplatinumstyle.3qt b/doc/man/man3/qplatinumstyle.3qt deleted file mode 100644 index c7bf25e77..000000000 --- a/doc/man/man3/qplatinumstyle.3qt +++ /dev/null @@ -1,68 +0,0 @@ -'\" t -.TH QPlatinumStyle 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 -QPlatinumStyle \- Mac/Platinum look and feel -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWindowsStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPlatinumStyle\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "QColor \fBmixedColor\fR ( const QColor & c1, const QColor & c2 ) const" -.br -.ti -1c -.BI "void \fBdrawRiffles\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool horizontal ) const" -.br -.in -1c -.SH DESCRIPTION -The QPlatinumStyle class provides Mac/Platinum look and feel. -.PP -This class implements the Platinum look and feel. It's an experimental class that tries to resemble a Macinosh-like GUI style with the QStyle system. The emulation is currently far from perfect. -.PP -See also QAquaStyle and Widget Appearance and Style. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPlatinumStyle::QPlatinumStyle ()" -Constructs a QPlatinumStyle -.SH "void QPlatinumStyle::drawRiffles ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool horizontal ) const\fC [protected]\fR" -Draws the nifty Macintosh decoration used on sliders using painter \fIp\fR and colorgroup \fIg\fR. \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR and \fIhorizontal\fR specify the geometry and orientation of the riffles. -.SH "QColor QPlatinumStyle::mixedColor ( const QColor & c1, const QColor & c2 ) const\fC [protected]\fR" -Mixes two colors \fIc1\fR and \fIc2\fR to a new color. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqplatinumstyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qplatinumstyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpngimagepacker.3qt b/doc/man/man3/qpngimagepacker.3qt deleted file mode 100644 index 91e7a3bd8..000000000 --- a/doc/man/man3/qpngimagepacker.3qt +++ /dev/null @@ -1,72 +0,0 @@ -'\" t -.TH QPNGImagePacker 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 -QPNGImagePacker \- Creates well-compressed PNG animations -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPNGImagePacker\fR ( QIODevice * iod, int storage_depth, int conversionflags )" -.br -.ti -1c -.BI "void \fBsetPixelAlignment\fR ( int x )" -.br -.ti -1c -.BI "bool \fBpackImage\fR ( const QImage & img )" -.br -.in -1c -.SH DESCRIPTION -The QPNGImagePacker class creates well-compressed PNG animations. -.PP -By using transparency, QPNGImagePacker allows you to build a PNG image from a sequence of QImages. -.PP -Images are added using packImage(). -.PP -See also Graphics Classes and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPNGImagePacker::QPNGImagePacker ( QIODevice * iod, int storage_depth, int conversionflags )" -Creates an image packer that writes PNG data to IO device \fIiod\fR using a \fIstorage_depth\fR bit encoding (use 8 or 32, depending on the desired quality and compression requirements). -.PP -If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversionflags\fR to specify how you'd prefer this to happen. -.PP -See also Qt::ImageConversionFlags. -.SH "bool QPNGImagePacker::packImage ( const QImage & img )" -Adds the image \fIimg\fR to the PNG animation, analyzing the differences between this and the previous image to improve compression. -.SH "void QPNGImagePacker::setPixelAlignment ( int x )" -Aligns pixel differences to \fIx\fR pixels. For example, using 8 can -improve playback on certain hardware. Normally the default of -1-pixel alignment (i.e. no alignment) gives better compression and -performance. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qpngimagepacker.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpngimagepacker.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpoint.3qt b/doc/man/man3/qpoint.3qt deleted file mode 100644 index 21f6d0955..000000000 --- a/doc/man/man3/qpoint.3qt +++ /dev/null @@ -1,377 +0,0 @@ -'\" t -.TH QPoint 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 -QPoint \- Defines a point in the plane -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPoint\fR ()" -.br -.ti -1c -.BI "\fBQPoint\fR ( int xpos, int ypos )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "void \fBsetX\fR ( int x )" -.br -.ti -1c -.BI "void \fBsetY\fR ( int y )" -.br -.ti -1c -.BI "int \fBmanhattanLength\fR () const" -.br -.ti -1c -.BI "QCOORD & \fBrx\fR ()" -.br -.ti -1c -.BI "QCOORD & \fBry\fR ()" -.br -.ti -1c -.BI "QPoint & \fBoperator+=\fR ( const QPoint & p )" -.br -.ti -1c -.BI "QPoint & \fBoperator-=\fR ( const QPoint & p )" -.br -.ti -1c -.BI "QPoint & \fBoperator*=\fR ( int c )" -.br -.ti -1c -.BI "QPoint & \fBoperator*=\fR ( double c )" -.br -.ti -1c -.BI "QPoint & \fBoperator/=\fR ( int c )" -.br -.ti -1c -.BI "QPoint & \fBoperator/=\fR ( double c )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "bool \fBoperator==\fR ( const QPoint & p1, const QPoint & p2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QPoint & p1, const QPoint & p2 )" -.br -.ti -1c -.BI "const QPoint \fBoperator+\fR ( const QPoint & p1, const QPoint & p2 )" -.br -.ti -1c -.BI "const QPoint \fBoperator-\fR ( const QPoint & p1, const QPoint & p2 )" -.br -.ti -1c -.BI "const QPoint \fBoperator*\fR ( const QPoint & p, int c )" -.br -.ti -1c -.BI "const QPoint \fBoperator*\fR ( int c, const QPoint & p )" -.br -.ti -1c -.BI "const QPoint \fBoperator*\fR ( const QPoint & p, double c )" -.br -.ti -1c -.BI "const QPoint \fBoperator*\fR ( double c, const QPoint & p )" -.br -.ti -1c -.BI "const QPoint \fBoperator-\fR ( const QPoint & p )" -.br -.ti -1c -.BI "const QPoint \fBoperator/\fR ( const QPoint & p, int c )" -.br -.ti -1c -.BI "const QPoint \fBoperator/\fR ( const QPoint & p, double c )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPoint & p )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPoint & p )" -.br -.in -1c -.SH DESCRIPTION -The QPoint class defines a point in the plane. -.PP -A point is specified by an x coordinate and a y coordinate. -.PP -The coordinate type is \fCQCOORD\fR (a 32-bit integer). The minimum value of \fCQCOORD\fR is \fCQCOORD_MIN\fR (-2147483648) and the maximum value is \fCQCOORD_MAX\fR (2147483647). -.PP -The coordinates are accessed by the functions x() and y(); they can be set by setX() and setY() or by the reference functions rx() and ry(). -.PP -Given a point \fIp\fR, the following statements are all equivalent: -.PP -.nf -.br - p.setX( p.x() + 1 ); -.br - p += QPoint( 1, 0 ); -.br - p.rx()++; -.br -.fi -.PP -A QPoint can also be used as a vector. Addition and subtraction of QPoints are defined as for vectors (each component is added separately). You can divide or multiply a QPoint by an \fCint\fR or a \fCdouble\fR. The function manhattanLength() gives an inexpensive approximation of the length of the QPoint interpreted as a vector. -.PP -Example: -.PP -.nf -.br - //QPoint oldPos is defined somewhere else -.br - MyWidget::mouseMoveEvent( QMouseEvent *e ) -.br - { -.br - QPoint vector = e->pos() - oldPos; -.br - if ( vector.manhattanLength() > 3 ) -.br - ... //mouse has moved more than 3 pixels since oldPos -.br - } -.br -.fi -.PP -QPoints can be compared for equality or inequality, and they can be written to and read from a QStream. -.PP -See also QPointArray, QSize, QRect, Graphics Classes, and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPoint::QPoint ()" -Constructs a point with coordinates (0, 0) (isNull() returns TRUE). -.SH "QPoint::QPoint ( int xpos, int ypos )" -Constructs a point with x value \fIxpos\fR and y value \fIypos\fR. -.SH "bool QPoint::isNull () const" -Returns TRUE if both the x value and the y value are 0; otherwise returns FALSE. -.SH "int QPoint::manhattanLength () const" -Returns the sum of the absolute values of x() and y(), traditionally known as the "Manhattan length" of the vector from the origin to the point. The tradition arises because such distances apply to travelers who can only travel on a rectangular grid, like the streets of Manhattan. -.PP -This is a useful, and quick to calculate, approximation to the true length: sqrt(pow(x(),2)+pow(y(),2)). -.SH "QPoint & QPoint::operator*= ( int c )" -Multiplies this point's x and y by \fIc\fR, and returns a reference to this point. -.PP -Example: -.PP -.nf -.br - QPoint p( -1, 4 ); -.br - p *= 2; // p becomes (-2,8) -.br -.fi -.SH "QPoint & QPoint::operator*= ( double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Multiplies this point's x and y by \fIc\fR, and returns a reference to this point. -.PP -Example: -.PP -.nf -.br - QPoint p( -1, 4 ); -.br - p *= 2.5; // p becomes (-3,10) -.br -.fi -.PP -Note that the result is truncated because points are held as integers. -.SH "QPoint & QPoint::operator+= ( const QPoint & p )" -Adds point \fIp\fR to this point and returns a reference to this point. -.PP -Example: -.PP -.nf -.br - QPoint p( 3, 7 ); -.br - QPoint q( -1, 4 ); -.br - p += q; // p becomes (2,11) -.br -.fi -.SH "QPoint & QPoint::operator-= ( const QPoint & p )" -Subtracts point \fIp\fR from this point and returns a reference to this point. -.PP -Example: -.PP -.nf -.br - QPoint p( 3, 7 ); -.br - QPoint q( -1, 4 ); -.br - p -= q; // p becomes (4,3) -.br -.fi -.SH "QPoint & QPoint::operator/= ( int c )" -Divides both x and y by \fIc\fR, and returns a reference to this point. -.PP -Example: -.PP -.nf -.br - QPoint p( -2, 8 ); -.br - p /= 2; // p becomes (-1,4) -.br -.fi -.SH "QPoint & QPoint::operator/= ( double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Divides both x and y by \fIc\fR, and returns a reference to this point. -.PP -Example: -.PP -.nf -.br - QPoint p( -3, 10 ); -.br - p /= 2.5; // p becomes (-1,4) -.br -.fi -.PP -Note that the result is truncated because points are held as integers. -.SH "QCOORD & QPoint::rx ()" -Returns a reference to the x coordinate of the point. -.PP -Using a reference makes it possible to directly manipulate x. -.PP -Example: -.PP -.nf -.br - QPoint p( 1, 2 ); -.br - p.rx()--; // p becomes (0, 2) -.br -.fi -.PP -See also ry(). -.SH "QCOORD & QPoint::ry ()" -Returns a reference to the y coordinate of the point. -.PP -Using a reference makes it possible to directly manipulate y. -.PP -Example: -.PP -.nf -.br - QPoint p( 1, 2 ); -.br - p.ry()++; // p becomes (1, 3) -.br -.fi -.PP -See also rx(). -.SH "void QPoint::setX ( int x )" -Sets the x coordinate of the point to \fIx\fR. -.PP -See also x() and setY(). -.PP -Example: t14/cannon.cpp. -.SH "void QPoint::setY ( int y )" -Sets the y coordinate of the point to \fIy\fR. -.PP -See also y() and setX(). -.PP -Example: t14/cannon.cpp. -.SH "int QPoint::x () const" -Returns the x coordinate of the point. -.PP -See also setX() and y(). -.PP -Examples: -.)l canvas/canvas.cpp, chart/canvasview.cpp, dirview/dirview.cpp, fileiconview/qfileiconview.cpp, helpsystem/tooltip.cpp, life/life.cpp, and t14/cannon.cpp. -.SH "int QPoint::y () const" -Returns the y coordinate of the point. -.PP -See also setY() and x(). -.PP -Examples: -.)l canvas/canvas.cpp, chart/canvasview.cpp, fileiconview/qfileiconview.cpp, helpsystem/tooltip.cpp, life/life.cpp, t14/cannon.cpp, and themes/wood.cpp. -.SH RELATED FUNCTION DOCUMENTATION -.SH "bool operator!= ( const QPoint & p1, const QPoint & p2 )" -Returns TRUE if \fIp1\fR and \fIp2\fR are not equal; otherwise returns FALSE. -.SH "const QPoint operator* ( const QPoint & p, int c )" -Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. -.SH "const QPoint operator* ( int c, const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. -.SH "const QPoint operator* ( const QPoint & p, double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. -.PP -Note that the result is truncated because points are held as integers. -.SH "const QPoint operator* ( double c, const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. -.PP -Note that the result is truncated because points are held as integers. -.SH "const QPoint operator+ ( const QPoint & p1, const QPoint & p2 )" -Returns the sum of \fIp1\fR and \fIp2\fR; each component is added separately. -.SH "const QPoint operator- ( const QPoint & p1, const QPoint & p2 )" -Returns \fIp2\fR subtracted from \fIp1\fR; each component is subtracted separately. -.SH "const QPoint operator- ( const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the QPoint formed by changing the sign of both components of \fIp\fR, equivalent to \fCQPoint(0,0) - p\fR. -.SH "const QPoint operator/ ( const QPoint & p, int c )" -Returns the QPoint formed by dividing both components of \fIp\fR by \fIc\fR. -.SH "const QPoint operator/ ( const QPoint & p, double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the QPoint formed by dividing both components of \fIp\fR by \fIc\fR. -.PP -Note that the result is truncated because points are held as integers. -.SH "QDataStream & operator<< ( QDataStream & s, const QPoint & p )" -Writes point \fIp\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "bool operator== ( const QPoint & p1, const QPoint & p2 )" -Returns TRUE if \fIp1\fR and \fIp2\fR are equal; otherwise returns FALSE. -.SH "QDataStream & operator>> ( QDataStream & s, QPoint & p )" -Reads a QPoint from the stream \fIs\fR into point \fIp\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpoint.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpoint.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpointarray.3qt b/doc/man/man3/qpointarray.3qt deleted file mode 100644 index f380085c3..000000000 --- a/doc/man/man3/qpointarray.3qt +++ /dev/null @@ -1,277 +0,0 @@ -'\" t -.TH QPointArray 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 -QPointArray \- Array of points -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QMemArray. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPointArray\fR ()" -.br -.ti -1c -.BI "\fB~QPointArray\fR ()" -.br -.ti -1c -.BI "\fBQPointArray\fR ( int size )" -.br -.ti -1c -.BI "\fBQPointArray\fR ( const QPointArray & a )" -.br -.ti -1c -.BI "\fBQPointArray\fR ( const QRect & r, bool closed = FALSE )" -.br -.ti -1c -.BI "QPointArray & \fBoperator=\fR ( const QPointArray & a )" -.br -.ti -1c -.BI "QPointArray \fBcopy\fR () const" -.br -.ti -1c -.BI "void \fBtranslate\fR ( int dx, int dy )" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR () const" -.br -.ti -1c -.BI "void \fBpoint\fR ( uint index, int * x, int * y ) const" -.br -.ti -1c -.BI "QPoint \fBpoint\fR ( uint index ) const" -.br -.ti -1c -.BI "void \fBsetPoint\fR ( uint index, int x, int y )" -.br -.ti -1c -.BI "void \fBsetPoint\fR ( uint i, const QPoint & p )" -.br -.ti -1c -.BI "bool \fBputPoints\fR ( int index, int nPoints, int firstx, int firsty, ... )" -.br -.ti -1c -.BI "bool \fBputPoints\fR ( int index, int nPoints, const QPointArray & from, int fromIndex = 0 )" -.br -.ti -1c -.BI "void \fBmakeArc\fR ( int x, int y, int w, int h, int a1, int a2 )" -.br -.ti -1c -.BI "void \fBmakeEllipse\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBmakeArc\fR ( int x, int y, int w, int h, int a1, int a2, const QWMatrix & xf )" -.br -.ti -1c -.BI "QPointArray \fBcubicBezier\fR () const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPointArray & a )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPointArray & a )" -.br -.in -1c -.SH DESCRIPTION -The QPointArray class provides an array of points. -.PP -A QPointArray is an array of QPoint objects. In addition to the functions provided by QMemArray, QPointArray provides some point-specific functions. -.PP -For convenient reading and writing of the point data use setPoints(), putPoints(), point(), and setPoint(). -.PP -For geometry operations use boundingRect() and translate(). There is also the QWMatrix::map() function for more general transformations of QPointArrays. You can also create arcs and ellipses with makeArc() and makeEllipse(). -.PP -Among others, QPointArray is used by QPainter::drawLineSegments(), QPainter::drawPolyline(), QPainter::drawPolygon() and QPainter::drawCubicBezier(). -.PP -Note that because this class is a QMemArray, copying an array and modifying the copy modifies the original as well, i.e. a shallow copy. If you need a deep copy use copy() or detach(), for example: -.PP -.nf -.br - void drawGiraffe( const QPointArray & r, QPainter * p ) -.br - { -.br - QPointArray tmp = r; -.br - tmp.detach(); -.br - // some code that modifies tmp -.br - p->drawPoints( tmp ); -.br - } -.br -.fi -.PP -If you forget the tmp.detach(), the const array will be modified. -.PP -See also QPainter, QWMatrix, QMemArray, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPointArray::QPointArray ()" -Constructs a null point array. -.PP -See also isNull(). -.SH "QPointArray::QPointArray ( int size )" -Constructs a point array with room for \fIsize\fR points. Makes a null array if \fIsize\fR == 0. -.PP -See also resize() and isNull(). -.SH "QPointArray::QPointArray ( const QPointArray & a )" -Constructs a shallow copy of the point array \fIa\fR. -.PP -See also copy() and detach(). -.SH "QPointArray::QPointArray ( const QRect & r, bool closed = FALSE )" -Constructs a point array from the rectangle \fIr\fR. -.PP -If \fIclosed\fR is FALSE, then the point array just contains the following four points in the listed order: r.topLeft(), r.topRight(), r.bottomRight() and r.bottomLeft(). -.PP -If \fIclosed\fR is TRUE, then a fifth point is set to r.topLeft(). -.SH "QPointArray::~QPointArray ()" -Destroys the point array. -.SH "QRect QPointArray::boundingRect () const" -Returns the bounding rectangle of the points in the array, or QRect(0,0,0,0) if the array is empty. -.SH "QPointArray QPointArray::copy () const" -Creates a deep copy of the array. -.PP -See also detach(). -.SH "QPointArray QPointArray::cubicBezier () const" -Returns the Bezier points for the four control points in this array. -.SH "void QPointArray::makeArc ( int x, int y, int w, int h, int a1, int a2 )" -Sets the points of the array to those describing an arc of an ellipse with size, width \fIw\fR by height \fIh\fR, and position (\fIx\fR, \fIy\fR), starting from angle \fIa1\fR and spanning by angle \fIa2\fR. The resulting array has sufficient resolution for pixel accuracy (see the overloaded function which takes an additional QWMatrix parameter). -.PP -Angles are specified in 16ths of a degree, i.e. a full circle equals 5760 (16*360). Positive values mean counter-clockwise, whereas negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. -.PP -See the angle diagram. -.SH "void QPointArray::makeArc ( int x, int y, int w, int h, int a1, int a2, const QWMatrix & xf )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the points of the array to those describing an arc of an ellipse with width \fIw\fR and height \fIh\fR and position (\fIx\fR, \fIy\fR), starting from angle \fIa1\fR, and spanning angle by \fIa2\fR, and transformed by the matrix \fIxf\fR. The resulting array has sufficient resolution for pixel accuracy. -.PP -Angles are specified in 16ths of a degree, i.e. a full circle equals 5760 (16*360). Positive values mean counter-clockwise, whereas negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. -.PP -See the angle diagram. -.SH "void QPointArray::makeEllipse ( int x, int y, int w, int h )" -Sets the points of the array to those describing an ellipse with size, width \fIw\fR by height \fIh\fR, and position (\fIx\fR, \fIy\fR). -.PP -The returned array has sufficient resolution for use as pixels. -.SH "QPointArray & QPointArray::operator= ( const QPointArray & a )" -Assigns a shallow copy of \fIa\fR to this point array and returns a reference to this point array. -.PP -Equivalent to assign(a). -.PP -See also copy() and detach(). -.SH "void QPointArray::point ( uint index, int * x, int * y ) const" -Reads the coordinates of the point at position \fIindex\fR within the array and writes them into \fI*x\fR and \fI*y\fR. -.SH "QPoint QPointArray::point ( uint index ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point at position \fIindex\fR within the array. -.SH "bool QPointArray::putPoints ( int index, int nPoints, int firstx, int firsty, ... )" -Copies \fInPoints\fR points from the variable argument list into this point array from position \fIindex\fR, and resizes the point array if \fCindex+nPoints\fR exceeds the size of the array. -.PP -Returns TRUE if successful, or FALSE if the array could not be resized (typically due to lack of memory). -.PP -The example code creates an array with three points (4,5), (6,7) and (8,9), by expanding the array from 1 to 3 points: -.PP -.nf -.br - QPointArray a( 1 ); -.br - a[0] = QPoint( 4, 5 ); -.br - a.putPoints( 1, 2, 6,7, 8,9 ); // index == 1, points == 2 -.br -.fi -.PP -This has the same result, but here putPoints overwrites rather than extends: -.PP -.nf -.br - QPointArray a( 3 ); -.br - a.putPoints( 0, 3, 4,5, 0,0, 8,9 ); -.br - a.putPoints( 1, 1, 6,7 ); -.br -.fi -.PP -The points are given as a sequence of integers, starting with \fIfirstx\fR then \fIfirsty\fR, and so on. -.PP -See also resize(). -.SH "bool QPointArray::putPoints ( int index, int nPoints, const QPointArray & from, int fromIndex = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version of the function copies \fInPoints\fR from \fIfrom\fR into this array, starting at \fIindex\fR in this array and \fIfromIndex\fR in \fIfrom\fR. \fIfromIndex\fR is 0 by default. -.PP -.nf -.br - QPointArray a; -.br - a.putPoints( 0, 3, 1,2, 0,0, 5,6 ); -.br - // a is now the three-point array ( 1,2, 0,0, 5,6 ); -.br - QPointArray b; -.br - b.putPoints( 0, 3, 4,4, 5,5, 6,6 ); -.br - // b is now ( 4,4, 5,5, 6,6 ); -.br - a.putPoints( 2, 3, b ); -.br - // a is now ( 1,2, 0,0, 4,4, 5,5, 6,6 ); -.br -.fi -.SH "void QPointArray::setPoint ( uint index, int x, int y )" -Sets the point at position \fIindex\fR in the array to \fI(x, y)\fR. -.PP -Example: themes/wood.cpp. -.SH "void QPointArray::setPoint ( uint i, const QPoint & p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the point at array index \fIi\fR to \fIp\fR. -.SH "void QPointArray::translate ( int dx, int dy )" -Translates all points in the array by \fI(dx, dy)\fR. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QPointArray & a )" -Writes the point array, \fIa\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QPointArray & a )" -Reads a point array, \fIa\fR from the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpointarray.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpointarray.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpopupmenu.3qt b/doc/man/man3/qpopupmenu.3qt deleted file mode 100644 index ded526d1d..000000000 --- a/doc/man/man3/qpopupmenu.3qt +++ /dev/null @@ -1,810 +0,0 @@ -'\" t -.TH QPopupMenu 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 -QPopupMenu \- Popup menu widget -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame and QMenuData. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPopupMenu\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QPopupMenu\fR ()" -.br -.ti -1c -.BI "void \fBpopup\fR ( const QPoint & pos, int indexAtPoint = -1 )" -.br -.ti -1c -.BI "virtual void \fBupdateItem\fR ( int id )" -.br -.ti -1c -.BI "virtual void \fBsetCheckable\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisCheckable\fR () const" -.br -.ti -1c -.BI "int \fBexec\fR ()" -.br -.ti -1c -.BI "int \fBexec\fR ( const QPoint & pos, int indexAtPoint = 0 )" -.br -.ti -1c -.BI "virtual void \fBsetActiveItem\fR ( int i )" -.br -.ti -1c -.BI "int \fBidAt\fR ( int index ) const" -.br -.ti -1c -.BI "int \fBidAt\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "int \fBinsertTearOffHandle\fR ( int id = -1, int index = -1 )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBactivated\fR ( int id )" -.br -.ti -1c -.BI "void \fBhighlighted\fR ( int id )" -.br -.ti -1c -.BI "void \fBaboutToShow\fR ()" -.br -.ti -1c -.BI "void \fBaboutToHide\fR ()" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( QWidget * widget, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( QCustomMenuItem * custom, int id = -1, int index = -1 )" -.br -.ti -1c -.BI "int \fBinsertSeparator\fR ( int index = -1 )" -.br -.ti -1c -.BI "void \fBremoveItem\fR ( int id )" -.br -.ti -1c -.BI "void \fBremoveItemAt\fR ( int index )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "QKeySequence \fBaccel\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetAccel\fR ( const QKeySequence & key, int id )" -.br -.ti -1c -.BI "QIconSet * \fBiconSet\fR ( int id ) const" -.br -.ti -1c -.BI "QString \fBtext\fR ( int id ) const" -.br -.ti -1c -.BI "QPixmap * \fBpixmap\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetWhatsThis\fR ( int id, const QString & text )" -.br -.ti -1c -.BI "QString \fBwhatsThis\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QString & text )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QPixmap & pixmap )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QString & text )" -.br -.ti -1c -.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QPixmap & pixmap )" -.br -.ti -1c -.BI "bool \fBisItemEnabled\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" -.br -.ti -1c -.BI "bool \fBisItemChecked\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemChecked\fR ( int id, bool check )" -.br -.ti -1c -.BI "bool \fBisItemVisible\fR ( int id ) const" -.br -.ti -1c -.BI "void \fBsetItemVisible\fR ( int id, bool visible )" -.br -.ti -1c -.BI "bool \fBconnectItem\fR ( int id, const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "bool \fBdisconnectItem\fR ( int id, const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "bool \fBsetItemParameter\fR ( int id, int param )" -.br -.ti -1c -.BI "int \fBitemParameter\fR ( int id ) const" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBcheckable\fR - whether the display of check marks on menu items is enabled" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "int \fBitemHeight\fR ( int row ) const" -.br -.ti -1c -.BI "int \fBitemHeight\fR ( QMenuItem * mi ) const" -.br -.ti -1c -.BI "void \fBdrawItem\fR ( QPainter * p, int tab_, QMenuItem * mi, bool act, int x, int y, int w, int h )" -.br -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * p )" -.br -.ti -1c -.BI "int \fBcolumns\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QPopupMenu class provides a popup menu widget. -.PP -A popup menu widget is a selection menu. It can be either a pull-down menu in a menu bar or a standalone context (popup) menu. Pull-down menus are shown by the menu bar when the user clicks on the respective item or presses the specified shortcut key. Use QMenuBar::insertItem() to insert a popup menu into a menu bar. Show a context menu either asynchronously with popup() or synchronously with exec(). -.PP -Technically, a popup menu consists of a list of menu items. You add items with insertItem(). An item is either a string, a pixmap or a custom item that provides its own drawing function (see QCustomMenuItem). In addition, items can have an optional icon drawn on the very left side and an accelerator key such as" Ctrl+X". -.PP -There are three kinds of menu items: separators, menu items that perform an action and menu items that show a submenu. Separators are inserted with insertSeparator(). For submenus, you pass a pointer to a QPopupMenu in your call to insertItem(). All other items are considered action items. -.PP -When inserting action items you usually specify a receiver and a slot. The receiver will be notifed whenever the item is selected. In addition, QPopupMenu provides two signals, activated() and highlighted(), which signal the identifier of the respective menu item. It is sometimes practical to connect several items to one slot. To distinguish between them, specify a slot that takes an integer argument and use setItemParameter() to associate a unique value with each item. -.PP -You clear a popup menu with clear() and remove single items with removeItem() or removeItemAt(). -.PP -A popup menu can display check marks for certain items when enabled with setCheckable(TRUE). You check or uncheck items with setItemChecked(). -.PP -Items are either enabled or disabled. You toggle their state with setItemEnabled(). Just before a popup menu becomes visible, it emits the aboutToShow() signal. You can use this signal to set the correct enabled/disabled states of all menu items before the user sees it. The corresponding aboutToHide() signal is emitted when the menu hides again. -.PP -You can provide What's This? help for single menu items with setWhatsThis(). See QWhatsThis for general information about this kind of lightweight online help. -.PP -For ultimate flexibility, you can also add entire widgets as items into a popup menu (for example, a color selector). -.PP -A QPopupMenu can also provide a tear-off menu. A tear-off menu is a top-level window that contains a copy of the menu. This makes it possible for the user to "tear off" frequently used menus and position them in a convenient place on the screen. If you want that functionality for a certain menu, insert a tear-off handle with insertTearOffHandle(). When using tear-off menus, bear in mind that the concept isn't typically used on Microsoft Windows so users may not be familiar with it. Consider using a QToolBar instead. Tear-off menus cannot contain custom widgets; if the original menu contains a custom widget item, this item is omitted. -.PP -menu/menu.cpp is an example of QMenuBar and QPopupMenu use. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QMenuBar, GUI Design Handbook: Menu, Drop-Down and Pop-Up, Main Window and Related Classes, and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPopupMenu::QPopupMenu ( QWidget * parent = 0, const char * name = 0 )" -Constructs a popup menu called \fIname\fR with parent \fIparent\fR. -.PP -Although a popup menu is always a top-level widget, if a parent is passed the popup menu will be deleted when that parent is destroyed (as with any other QObject). -.SH "QPopupMenu::~QPopupMenu ()" -Destroys the popup menu. -.SH "void QPopupMenu::aboutToHide ()\fC [signal]\fR" -This signal is emitted just before the popup menu is hidden after it has been displayed. -.PP -\fBWarning:\fR Do not open a widget in a slot connected to this signal. -.PP -See also aboutToShow(), setItemEnabled(), setItemChecked(), insertItem(), and removeItem(). -.SH "void QPopupMenu::aboutToShow ()\fC [signal]\fR" -This signal is emitted just before the popup menu is displayed. You can connect it to any slot that sets up the menu contents (e.g. to ensure that the right items are enabled). -.PP -See also aboutToHide(), setItemEnabled(), setItemChecked(), insertItem(), and removeItem(). -.PP -Example: mdi/application.cpp. -.SH "QKeySequence QMenuData::accel ( int id ) const" -Returns the accelerator key that has been defined for the menu item \fIid\fR, or 0 if it has no accelerator key or if there is no such menu item. -.PP -See also setAccel(), QAccel, and ntqnamespace.h. -.SH "void QPopupMenu::activated ( int id )\fC [signal]\fR" -This signal is emitted when a menu item is selected; \fIid\fR is the id of the selected item. -.PP -Normally, you connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is useful in such cases. -.PP -See also highlighted() and QMenuData::insertItem(). -.PP -Examples: -.)l grapher/grapher.cpp, helpviewer/helpwindow.cpp, qdir/qdir.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. -.SH "void QMenuData::changeItem ( int id, const QString & text )" -Changes the text of the menu item \fIid\fR to \fItext\fR. If the item has an icon, the icon remains unchanged. -.PP -See also text(). -.SH "void QMenuData::changeItem ( int id, const QPixmap & pixmap )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Changes the pixmap of the menu item \fIid\fR to the pixmap \fIpixmap\fR. If the item has an icon, the icon is unchanged. -.PP -See also pixmap(). -.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QString & text )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Changes the iconset and text of the menu item \fIid\fR to the \fIicon\fR and \fItext\fR respectively. -.PP -See also pixmap(). -.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QPixmap & pixmap )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Changes the iconset and pixmap of the menu item \fIid\fR to \fIicon\fR and \fIpixmap\fR respectively. -.PP -See also pixmap(). -.SH "void QMenuData::clear ()" -Removes all menu items. -.PP -See also removeItem() and removeItemAt(). -.PP -Examples: -.)l mdi/application.cpp and qwerty/qwerty.cpp. -.SH "int QPopupMenu::columns () const\fC [protected]\fR" -If a popup menu does not fit on the screen it lays itself out so that it does fit. It is style dependent what layout means (for example, on Windows it will use multiple columns). -.PP -This functions returns the number of columns necessary. -.PP -See also sizeHint. -.SH "bool QMenuData::connectItem ( int id, const QObject * receiver, const char * member )" -Connects the menu item with identifier \fIid\fR to \fIreceiver\fR's \fImember\fR slot or signal. -.PP -The receiver's slot (or signal) is activated when the menu item is activated. -.PP -See also disconnectItem() and setItemParameter(). -.PP -Example: menu/menu.cpp. -.SH "bool QMenuData::disconnectItem ( int id, const QObject * receiver, const char * member )" -Disconnects the \fIreceiver\fR's \fImember\fR from the menu item with identifier \fIid\fR. -.PP -All connections are removed when the menu data object is destroyed. -.PP -See also connectItem() and setItemParameter(). -.SH "void QPopupMenu::drawContents ( QPainter * p )\fC [virtual protected]\fR" -Draws all menu items using painter \fIp\fR. -.PP -Reimplemented from QFrame. -.SH "void QPopupMenu::drawItem ( QPainter * p, int tab_, QMenuItem * mi, bool act, int x, int y, int w, int h )\fC [protected]\fR" -Draws menu item \fImi\fR in the area \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, using painter \fIp\fR. The item is drawn active if \fIact\fR is TRUE or drawn inactive if \fIact\fR is FALSE. The rightmost \fItab_\fR pixels are used for accelerator text. -.PP -See also QStyle::drawControl(). -.SH "int QPopupMenu::exec ()" -Executes this popup synchronously. -.PP -This is equivalent to \fCexec(mapToGlobal(QPoint(0,0)))\fR. In most situations you'll want to specify the position yourself, for example at the current mouse position: -.PP -.nf -.br - exec(QCursor::pos()); -.br -.fi -or aligned to a widget: -.PP -.nf -.br - exec(somewidget.mapToGlobal(QPoint(0,0))); -.br -.fi -.PP -Examples: -.)l fileiconview/qfileiconview.cpp, menu/menu.cpp, and scribble/scribble.cpp. -.SH "int QPopupMenu::exec ( const QPoint & pos, int indexAtPoint = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Executes this popup synchronously. -.PP -Opens the popup menu so that the item number \fIindexAtPoint\fR will be at the specified \fIglobal\fR position \fIpos\fR. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal(). -.PP -The return code is the id of the selected item in either the popup menu or one of its submenus, or -1 if no item is selected (normally because the user pressed Esc). -.PP -Note that all signals are emitted as usual. If you connect a menu item to a slot and call the menu's exec(), you get the result both via the signal-slot connection and in the return value of exec(). -.PP -Common usage is to position the popup at the current mouse position: -.PP -.nf -.br - exec( QCursor::pos() ); -.br -.fi -or aligned to a widget: -.PP -.nf -.br - exec( somewidget.mapToGlobal(QPoint(0, 0)) ); -.br -.fi -.PP -When positioning a popup with exec() or popup(), bear in mind that you cannot rely on the popup menu's current size(). For performance reasons, the popup adapts its size only when necessary. So in many cases, the size before and after the show is different. Instead, use sizeHint(). It calculates the proper size depending on the menu's current contents. -.PP -See also popup() and sizeHint. -.SH "void QPopupMenu::highlighted ( int id )\fC [signal]\fR" -This signal is emitted when a menu item is highlighted; \fIid\fR is the id of the highlighted item. -.PP -See also activated() and QMenuData::insertItem(). -.SH "QIconSet * QMenuData::iconSet ( int id ) const" -Returns the icon set that has been set for menu item \fIid\fR, or 0 if no icon set has been set. -.PP -See also changeItem(), text(), and pixmap(). -.SH "int QPopupMenu::idAt ( int index ) const" -Returns the identifier of the menu item at position \fIindex\fR in the internal list, or -1 if \fIindex\fR is out of range. -.PP -See also QMenuData::setId() and QMenuData::indexOf(). -.PP -Example: scrollview/scrollview.cpp. -.SH "int QPopupMenu::idAt ( const QPoint & pos ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the id of the item at \fIpos\fR, or -1 if there is no item there or if it is a separator. -.SH "int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -The family of insertItem() functions inserts menu items into a popup menu or a menu bar. -.PP -A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus. -.PP -Some insertItem() members take a popup menu as an additional argument. Use this to insert submenus into existing menus or pulldown menus into a menu bar. -.PP -The number of insert functions may look confusing, but they are actually quite simple to use. -.PP -This default version inserts a menu item with the text \fItext\fR, the accelerator key \fIaccel\fR, an id and an optional index and connects it to the slot \fImember\fR in the object \fIreceiver\fR. -.PP -Example: -.PP -.nf -.br - QMenuBar *mainMenu = new QMenuBar; -.br - QPopupMenu *fileMenu = new QPopupMenu; -.br - fileMenu->insertItem( "New", myView, SLOT(newFile()), CTRL+Key_N ); -.br - fileMenu->insertItem( "Open", myView, SLOT(open()), CTRL+Key_O ); -.br - mainMenu->insertItem( "File", fileMenu ); -.br -.fi -.PP -Not all insert functions take an object/slot parameter or an accelerator key. Use connectItem() and setAccel() on those items. -.PP -If you need to translate accelerators, use tr() with the text and accelerator. (For translations use a string key sequence.): -.PP -.nf -.br - fileMenu->insertItem( tr("Open"), myView, SLOT(open()), -.br - tr("Ctrl+O") ); -.br -.fi -.PP -In the example above, pressing Ctrl+O or selecting "Open" from the menu activates the myView->open() function. -.PP -Some insert functions take a QIconSet parameter to specify the little menu item icon. Note that you can always pass a QPixmap object instead. -.PP -The \fIid\fR specifies the identification number associated with the menu item. Note that only positive values are valid, as a negative value will make Qt select a unique id for the item. -.PP -The \fIindex\fR specifies the position in the menu. The menu item is appended at the end of the list if \fIindex\fR is negative. -.PP -Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. -.PP -\fBWarning:\fR Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g. \fC(QObject*)0\fR. -.PP -\fBWarning:\fR On Mac OS X, items that connect to a slot that are inserted into a menubar will not function as we use the native menubar that knows nothing about signals or slots. Instead insert the items into a popup menu and insert the popup menu into the menubar. This may be fixed in a future Qt version. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.PP -Examples: -.)l addressbook/mainwindow.cpp, canvas/canvas.cpp, menu/menu.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the \fImember\fR slot in the \fIreceiver\fR object. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with pixmap \fIpixmap\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. -.PP -The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a menu item that consists of the widget \fIwidget\fR with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -Ownership of \fIwidget\fR is transferred to the popup menu or to the menu bar. -.PP -Theoretically, any widget can be inserted into a popup menu. In practice, this only makes sense with certain widgets. -.PP -If a widget is not focus-enabled (see QWidget::isFocusEnabled()), the menu treats it as a separator; this means that the item is not selectable and will never get focus. In this way you can, for example, simply insert a QLabel if you need a popup menu with a title. -.PP -If the widget is focus-enabled it will get focus when the user traverses the popup menu with the arrow keys. If the widget does not accept \fCArrowUp\fR and \fCArrowDown\fR in its key event handler, the focus will move back to the menu when the respective arrow key is hit one more time. This works with a QLineEdit, for example. If the widget accepts the arrow key itself, it must also provide the possibility to put the focus back on the menu again by calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu when the user made a selection, this can be done safely by calling: -.PP -.nf -.br - if ( isVisible() && -.br - parentWidget() && -.br - parentWidget()->inherits("QPopupMenu") ) -.br - parentWidget()->close(); -.br -.fi -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also removeItem(). -.SH "int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a custom menu item \fIcustom\fR with an \fIicon\fR and with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. -.PP -If you want to connect a custom item to a slot, use connectItem(). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a custom menu item \fIcustom\fR with optional id \fIid\fR, and optional \fIindex\fR position. -.PP -This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. -.PP -If you want to connect a custom item to a slot, use connectItem(). -.PP -Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). -.PP -See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertSeparator ( int index = -1 )" -Inserts a separator at position \fIindex\fR, and returns the menu identifier number allocated to it. The separator becomes the last menu item if \fIindex\fR is negative. -.PP -In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guidelines). -.PP -Examples: -.)l addressbook/mainwindow.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "int QPopupMenu::insertTearOffHandle ( int id = -1, int index = -1 )" -Inserts a tear-off handle into the menu. A tear-off handle is a special menu item that creates a copy of the menu when the menu is selected. This "torn-off" copy lives in a separate window. It contains the same menu items as the original menu, with the exception of the tear-off handle. -.PP -The handle item is assigned the identifier \fIid\fR or an automatically generated identifier if \fIid\fR is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application. -.PP -The \fIindex\fR specifies the position in the menu. The tear-off handle is appended at the end of the list if \fIindex\fR is negative. -.PP -Example: menu/menu.cpp. -.SH "bool QPopupMenu::isCheckable () const" -Returns TRUE if the display of check marks on menu items is enabled; otherwise returns FALSE. See the "checkable" property for details. -.SH "bool QMenuData::isItemChecked ( int id ) const" -Returns TRUE if the menu item with the id \fIid\fR has been checked; otherwise returns FALSE. -.PP -See also setItemChecked(). -.PP -Examples: -.)l canvas/canvas.cpp, progress/progress.cpp, and showimg/showimg.cpp. -.SH "bool QMenuData::isItemEnabled ( int id ) const" -Returns TRUE if the item with identifier \fIid\fR is enabled; otherwise returns FALSE -.PP -See also setItemEnabled() and isItemVisible(). -.SH "bool QMenuData::isItemVisible ( int id ) const" -Returns TRUE if the menu item with the id \fIid\fR is visible; otherwise returns FALSE. -.PP -See also setItemVisible(). -.SH "int QPopupMenu::itemHeight ( int row ) const\fC [protected]\fR" -Calculates the height in pixels of the item in row \fIrow\fR. -.SH "int QPopupMenu::itemHeight ( QMenuItem * mi ) const\fC [protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calculates the height in pixels of the menu item \fImi\fR. -.SH "int QMenuData::itemParameter ( int id ) const" -Returns the parameter of the activation signal of item \fIid\fR. -.PP -If no parameter has been specified for this item with setItemParameter(), the value defaults to \fIid\fR. -.PP -See also connectItem(), disconnectItem(), and setItemParameter(). -.SH "QPixmap * QMenuData::pixmap ( int id ) const" -Returns the pixmap that has been set for menu item \fIid\fR, or 0 if no pixmap has been set. -.PP -See also changeItem(), text(), and iconSet(). -.SH "void QPopupMenu::popup ( const QPoint & pos, int indexAtPoint = -1 )" -Displays the popup menu so that the item number \fIindexAtPoint\fR will be at the specified \fIglobal\fR position \fIpos\fR. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal(). -.PP -When positioning a popup with exec() or popup(), bear in mind that you cannot rely on the popup menu's current size(). For performance reasons, the popup adapts its size only when necessary, so in many cases, the size before and after the show is different. Instead, use sizeHint(). It calculates the proper size depending on the menu's current contents. -.PP -Example: listviews/listviews.cpp. -.SH "void QMenuData::removeItem ( int id )" -Removes the menu item that has the identifier \fIid\fR. -.PP -See also removeItemAt() and clear(). -.PP -Example: chart/chartform.cpp. -.SH "void QMenuData::removeItemAt ( int index )" -Removes the menu item at position \fIindex\fR. -.PP -See also removeItem() and clear(). -.SH "void QMenuData::setAccel ( const QKeySequence & key, int id )" -Sets the accelerator key for the menu item \fIid\fR to \fIkey\fR. -.PP -An accelerator key consists of a key code and a combination of the modifiers SHIFT, CTRL, ALT or UNICODE_ACCEL (OR'ed or added). The header file ntqnamespace.h contains a list of key codes. -.PP -Defining an accelerator key produces a text that is added to the menu item; for instance, CTRL + Key_O produces "Ctrl+O". The text is formatted differently for different platforms. -.PP -Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. -.PP -Example: -.PP -.nf -.br - QMenuBar *mainMenu = new QMenuBar; -.br - QPopupMenu *fileMenu = new QPopupMenu; // file sub menu -.br - fileMenu->insertItem( "Open Document", 67 ); // add "Open" item -.br - fileMenu->setAccel( CTRL + Key_O, 67 ); // Ctrl+O to open -.br - fileMenu->insertItem( "Quit", 69 ); // add "Quit" item -.br - fileMenu->setAccel( CTRL + ALT + Key_Delete, 69 ); // add Alt+Del to quit -.br - mainMenu->insertItem( "File", fileMenu ); // add the file menu -.br -.fi -.PP -If you need to translate accelerators, use tr() with a string: -.PP -.nf -.br - fileMenu->setAccel( tr("Ctrl+O"), 67 ); -.br -.fi -.PP -You can also specify the accelerator in the insertItem() function. You may prefer to use QAction to associate accelerators with menu items. -.PP -See also accel(), insertItem(), QAccel, and QAction. -.PP -Example: menu/menu.cpp. -.SH "void QPopupMenu::setActiveItem ( int i )\fC [virtual]\fR" -Sets the currently active item to index \fIi\fR and repaints as necessary. -.SH "void QPopupMenu::setCheckable ( bool )\fC [virtual]\fR" -Sets whether the display of check marks on menu items is enabled. See the "checkable" property for details. -.SH "void QMenuData::setItemChecked ( int id, bool check )" -If \fIcheck\fR is TRUE, checks the menu item with id \fIid\fR; otherwise unchecks the menu item with id \fIid\fR. Calls QPopupMenu::setCheckable( TRUE ) if necessary. -.PP -See also isItemChecked(). -.PP -Examples: -.)l canvas/canvas.cpp, grapher/grapher.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. -.SH "void QMenuData::setItemEnabled ( int id, bool enable )" -If \fIenable\fR is TRUE, enables the menu item with identifier \fIid\fR; otherwise disables the menu item with identifier \fIid\fR. -.PP -See also isItemEnabled(). -.PP -Examples: -.)l mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, and showimg/showimg.cpp. -.SH "bool QMenuData::setItemParameter ( int id, int param )" -Sets the parameter of the activation signal of item \fIid\fR to \fIparam\fR. -.PP -If any receiver takes an integer parameter, this value is passed. -.PP -See also connectItem(), disconnectItem(), and itemParameter(). -.PP -Example: mdi/application.cpp. -.SH "void QMenuData::setItemVisible ( int id, bool visible )" -If \fIvisible\fR is TRUE, shows the menu item with id \fIid\fR; otherwise hides the menu item with id \fIid\fR. -.PP -See also isItemVisible() and isItemEnabled(). -.SH "void QMenuData::setWhatsThis ( int id, const QString & text )" -Sets \fItext\fR as What's This help for the menu item with identifier \fIid\fR. -.PP -See also whatsThis(). -.PP -Examples: -.)l application/application.cpp, helpsystem/mainwindow.cpp, and mdi/application.cpp. -.SH "QString QMenuData::text ( int id ) const" -Returns the text that has been set for menu item \fIid\fR, or QString::null if no text has been set. -.PP -See also changeItem(), pixmap(), and iconSet(). -.PP -Examples: -.)l qdir/qdir.cpp and showimg/showimg.cpp. -.SH "void QPopupMenu::updateItem ( int id )\fC [virtual]\fR" -Updates the item with identity \fIid\fR. -.PP -Reimplemented from QMenuData. -.SH "QString QMenuData::whatsThis ( int id ) const" -Returns the What's This help text for the item with identifier \fIid\fR or QString::null if no text has yet been defined. -.PP -See also setWhatsThis(). -.SS "Property Documentation" -.SH "bool checkable" -This property holds whether the display of check marks on menu items is enabled. -.PP -When TRUE, the display of check marks on menu items is enabled. Checking is always enabled when in Windows-style. -.PP -See also QMenuData::setItemChecked(). -.PP -Set this property's value with setCheckable() and get this property's value with isCheckable(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpopupmenu.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpopupmenu.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qprinter.3qt b/doc/man/man3/qprinter.3qt deleted file mode 100644 index f3e3afcfe..000000000 --- a/doc/man/man3/qprinter.3qt +++ /dev/null @@ -1,734 +0,0 @@ -'\" t -.TH QPrinter 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 -QPrinter \- Paint device that paints on a printer -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPaintDevice. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBPrinterMode\fR { ScreenResolution, PrinterResolution, HighResolution, Compatible }" -.br -.ti -1c -.BI "\fBQPrinter\fR ( PrinterMode m = ScreenResolution )" -.br -.ti -1c -.BI "\fB~QPrinter\fR ()" -.br -.ti -1c -.BI "enum \fBOrientation\fR { Portrait, Landscape }" -.br -.ti -1c -.BI "enum \fBPageSize\fR { A4, B5, Letter, Legal, Executive, A0, A1, A2, A3, A5, A6, A7, A8, A9, B0, B1, B10, B2, B3, B4, B6, B7, B8, B9, C5E, Comm10E, DLE, Folio, Ledger, Tabloid, Custom, NPageSize = Custom }" -.br -.ti -1c -.BI "enum \fBPageOrder\fR { FirstPageFirst, LastPageFirst }" -.br -.ti -1c -.BI "enum \fBColorMode\fR { GrayScale, Color }" -.br -.ti -1c -.BI "enum \fBPaperSource\fR { OnlyOne, Lower, Middle, Manual, Envelope, EnvelopeManual, Auto, Tractor, SmallFormat, LargeFormat, LargeCapacity, Cassette, FormSource }" -.br -.ti -1c -.BI "enum \fBPrintRange\fR { AllPages, Selection, PageRange }" -.br -.ti -1c -.BI "enum \fBPrinterOption\fR { PrintToFile, PrintSelection, PrintPageRange }" -.br -.ti -1c -.BI "QString \fBprinterName\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPrinterName\fR ( const QString & name )" -.br -.ti -1c -.BI "bool \fBoutputToFile\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetOutputToFile\fR ( bool enable )" -.br -.ti -1c -.BI "QString \fBoutputFileName\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetOutputFileName\fR ( const QString & fileName )" -.br -.ti -1c -.BI "QString \fBprintProgram\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPrintProgram\fR ( const QString & printProg )" -.br -.ti -1c -.BI "QString \fBprinterSelectionOption\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPrinterSelectionOption\fR ( const QString & option )" -.br -.ti -1c -.BI "QString \fBdocName\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDocName\fR ( const QString & name )" -.br -.ti -1c -.BI "QString \fBcreator\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCreator\fR ( const QString & creator )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetOrientation\fR ( Orientation orientation )" -.br -.ti -1c -.BI "PageSize \fBpageSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPageSize\fR ( PageSize newPageSize )" -.br -.ti -1c -.BI "void \fBsetWinPageSize\fR ( short winPageSize )" -.br -.ti -1c -.BI "short \fBwinPageSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPageOrder\fR ( PageOrder newPageOrder )" -.br -.ti -1c -.BI "PageOrder \fBpageOrder\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetResolution\fR ( int dpi )" -.br -.ti -1c -.BI "virtual int \fBresolution\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetColorMode\fR ( ColorMode newColorMode )" -.br -.ti -1c -.BI "ColorMode \fBcolorMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFullPage\fR ( bool fp )" -.br -.ti -1c -.BI "bool \fBfullPage\fR () const" -.br -.ti -1c -.BI "QSize \fBmargins\fR () const" -.br -.ti -1c -.BI "void \fBsetMargins\fR ( uint top, uint left, uint bottom, uint right )" -.br -.ti -1c -.BI "void \fBmargins\fR ( uint * top, uint * left, uint * bottom, uint * right ) const" -.br -.ti -1c -.BI "int \fBfromPage\fR () const" -.br -.ti -1c -.BI "int \fBtoPage\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFromTo\fR ( int fromPage, int toPage )" -.br -.ti -1c -.BI "int \fBminPage\fR () const" -.br -.ti -1c -.BI "int \fBmaxPage\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMinMax\fR ( int minPage, int maxPage )" -.br -.ti -1c -.BI "int \fBnumCopies\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNumCopies\fR ( int numCopies )" -.br -.ti -1c -.BI "PrintRange \fBprintRange\fR () const" -.br -.ti -1c -.BI "void \fBsetPrintRange\fR ( PrintRange range )" -.br -.ti -1c -.BI "bool \fBnewPage\fR ()" -.br -.ti -1c -.BI "bool \fBabort\fR ()" -.br -.ti -1c -.BI "bool \fBaborted\fR () const" -.br -.ti -1c -.BI "bool \fBsetup\fR ( QWidget * parent = 0 )" -.br -.ti -1c -.BI "PaperSource \fBpaperSource\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPaperSource\fR ( PaperSource source )" -.br -.ti -1c -.BI "void \fBsetOptionEnabled\fR ( PrinterOption option, bool enable )" -.br -.ti -1c -.BI "bool \fBisOptionEnabled\fR ( PrinterOption option )" -.br -.in -1c -.SH DESCRIPTION -The QPrinter class is a paint device that paints on a printer. -.PP -On Windows it uses the built-in printer drivers. On X11 it generates postscript and sends that to lpr, lp, or another print command. -.PP -QPrinter is used in much the same way as QWidget and QPixmap are used. The big difference is that you must keep track of the pages. -.PP -QPrinter supports a number of settable parameters, most of which can be changed by the end user when the application calls QPrinter::setup(). -.PP -The most important parameters are: -.TP -setOrientation() tells QPrinter which page orientation to use (virtual). -.TP -setPageSize() tells QPrinter what page size to expect from the printer. -.TP -setResolution() tells QPrinter what resolution you wish the printer to provide (in dpi). -.TP -setFullPage() tells QPrinter whether you want to deal with the full page or just with the part the printer can draw on. The default is FALSE, so that by default you should be able to paint on (0,0). If TRUE the origin of the coordinate system will be in the top left corner of the paper and most probably the printer will not be able to paint something there due to it's physical margins. -.TP -setNumCopies() tells QPrinter how many copies of the document it should print. -.TP -setMinMax() tells QPrinter and QPrintDialog what the allowed range for fromPage() and toPage() are. -.PP -Except where noted, you can only call the set functions before setup(), or between QPainter::end() and setup(). (Some may take effect between setup() and begin(), or between begin() and end(), but that's strictly undocumented and such behaviour may differ depending on platform.) -.PP -There are also some settings that the user sets (through the printer dialog) and that applications are expected to obey: -.IP -.TP -pageOrder() tells the application program whether to print first-page-first or last-page-first. -.IP -.TP -colorMode() tells the application program whether to print in color or grayscale. (If you print in color and the printer does not support color, Qt will try to approximate. The document may take longer to print, but the quality should not be made visibly poorer.) -.IP -.TP -fromPage() and toPage() indicate what pages the application program should print. -.IP -.TP -paperSource() tells the application progam which paper source to print from. -.IP -.PP -You can of course call these functions to establish defaults before you ask the user through QPrinter::setup(). -.PP -Once you start printing, calling newPage() is essential. You will probably also need to look at the QPaintDeviceMetrics for the printer (see the print function in the Application walk-through). In previous versions, paint device metrics were valid only after the QPrinter has been set up, i.e. after setup() has returned successfully. This is no longer the case and paint device metrics can be requested safely before set up. -.PP -If you want to abort the print job, abort() will try its best to stop printing. It may cancel the entire job or just some of it. -.PP -If your current locale converts "," to ".", you will need to set a locale (via the standard C setlocale() function) that doen't do this before using QPrinter. The "C" locale works well for this. -.PP -The TrueType font embedding for Qt's postscript driver uses code by David Chappell of Trinity College Computing Center. -.PP -Copyright 1995, Trinity College Computing Center. Written by David Chappell. -.PP -Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. This software is provided "as is" without express or implied warranty. -.PP -TrueType font support. These functions allow PPR to generate PostScript fonts from Microsoft compatible TrueType font files. -.PP -The functions in this file do most of the work to convert a TrueType font to a type 3 PostScript font. -.PP -Most of the material in this file is derived from a program called" ttf2ps" which L. S. Ng posted to the usenet news group" comp.sources.postscript". The author did not provide a copyright notice or indicate any restrictions on use. -.PP -Last revised 11 July 1995. -.PP -See also Graphics Classes and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QPrinter::ColorMode" -This enum type is used to indicate whether QPrinter should print in color or not. -.TP -\fCQPrinter::Color\fR - print in color if available, otherwise in grayscale. -.TP -\fCQPrinter::GrayScale\fR - print in grayscale, even on color printers. Might be a little faster than Color. This is the default. -.SH "QPrinter::Orientation" -This enum type (not to be confused with Qt::Orientation) is used to specify each page's orientation. -.TP -\fCQPrinter::Portrait\fR - the page's height is greater than its width (the default). -.TP -\fCQPrinter::Landscape\fR - the page's width is greater than its height. -.PP -This type interacts with QPrinter::PageSize and QPrinter::setFullPage() to determine the final size of the page available to the application. -.SH "QPrinter::PageOrder" -This enum type is used by QPrinter to tell the application program how to print. -.TP -\fCQPrinter::FirstPageFirst\fR - the lowest-numbered page should be printed first. -.TP -\fCQPrinter::LastPageFirst\fR - the highest-numbered page should be printed first. -.SH "QPrinter::PageSize" -This enum type specifies what paper size QPrinter should use. QPrinter does not check that the paper size is available; it just uses this information, together with QPrinter::Orientation and QPrinter::setFullPage(), to determine the printable area (see QPaintDeviceMetrics). -.PP -The defined sizes (with setFullPage(TRUE)) are: -.TP -\fCQPrinter::A0\fR - 841 x 1189 mm This value is not supported on windows. -.TP -\fCQPrinter::A1\fR - 594 x 841 mm This value is not supported on windows. -.TP -\fCQPrinter::A2\fR - 420 x 594 mm -.TP -\fCQPrinter::A3\fR - 297 x 420 mm -.TP -\fCQPrinter::A4\fR - 210 x 297 mm, 8.26 x 11.7 inches -.TP -\fCQPrinter::A5\fR - 148 x 210 mm -.TP -\fCQPrinter::A6\fR - 105 x 148 mm -.TP -\fCQPrinter::A7\fR - 74 x 105 mm -.TP -\fCQPrinter::A8\fR - 52 x 74 mm -.TP -\fCQPrinter::A9\fR - 37 x 52 mm -.TP -\fCQPrinter::B0\fR - 1030 x 1456 mm -.TP -\fCQPrinter::B1\fR - 728 x 1030 mm -.TP -\fCQPrinter::B10\fR - 32 x 45 mm -.TP -\fCQPrinter::B2\fR - 515 x 728 mm -.TP -\fCQPrinter::B3\fR - 364 x 515 mm -.TP -\fCQPrinter::B4\fR - 257 x 364 mm -.TP -\fCQPrinter::B5\fR - 182 x 257 mm, 7.17 x 10.13 inches -.TP -\fCQPrinter::B6\fR - 128 x 182 mm -.TP -\fCQPrinter::B7\fR - 91 x 128 mm -.TP -\fCQPrinter::B8\fR - 64 x 91 mm -.TP -\fCQPrinter::B9\fR - 45 x 64 mm -.TP -\fCQPrinter::C5E\fR - 163 x 229 mm -.TP -\fCQPrinter::Comm10E\fR - 105 x 241 mm, US Common #10 Envelope -.TP -\fCQPrinter::DLE\fR - 110 x 220 mm -.TP -\fCQPrinter::Executive\fR - 7.5 x 10 inches, 191 x 254 mm -.TP -\fCQPrinter::Folio\fR - 210 x 330 mm -.TP -\fCQPrinter::Ledger\fR - 432 x 279 mm -.TP -\fCQPrinter::Legal\fR - 8.5 x 14 inches, 216 x 356 mm -.TP -\fCQPrinter::Letter\fR - 8.5 x 11 inches, 216 x 279 mm -.TP -\fCQPrinter::Tabloid\fR - 279 x 432 mm -.TP -\fCQPrinter::Custom\fR -.TP -\fCQPrinter::NPageSize\fR - (internal) -.PP -With setFullPage(FALSE) (the default), the metrics will be a bit smaller; how much depends on the printer in use. -.SH "QPrinter::PaperSource" -This enum type specifies what paper source QPrinter is to use. QPrinter does not check that the paper source is available; it just uses this information to try and set the paper source. Whether it will set the paper source depends on whether the printer has that particular source. -.PP -Note: this is currently only implemented for Windows. -.TP -\fCQPrinter::OnlyOne\fR -.TP -\fCQPrinter::Lower\fR -.TP -\fCQPrinter::Middle\fR -.TP -\fCQPrinter::Manual\fR -.TP -\fCQPrinter::Envelope\fR -.TP -\fCQPrinter::EnvelopeManual\fR -.TP -\fCQPrinter::Auto\fR -.TP -\fCQPrinter::Tractor\fR -.TP -\fCQPrinter::SmallFormat\fR -.TP -\fCQPrinter::LargeFormat\fR -.TP -\fCQPrinter::LargeCapacity\fR -.TP -\fCQPrinter::Cassette\fR -.TP -\fCQPrinter::FormSource\fR -.SH "QPrinter::PrintRange" -This enum is used to specify which print range the application should use to print. -.TP -\fCQPrinter::AllPages\fR - All pages should be printed -.TP -\fCQPrinter::Selection\fR - Only the selection should be printed. -.TP -\fCQPrinter::PageRange\fR - From page, to page option. -.PP -See also setPrintRange() and printRange(). -.SH "QPrinter::PrinterMode" -This enum describes the mode the printer should work in. It basically presets a certain resolution and working mode. -.TP -\fCQPrinter::ScreenResolution\fR - Sets the resolution of the print device to the screen resolution. This has the big advantage that the results obtained when painting on the printer will match more or less exactly the visible output on the screen. It is the easiest to use, as font metrics on the screen and on the printer are the same. This is the default value. ScreenResolution will produce a lower quality output than HighResolution and should only be used for drafts. -.TP -\fCQPrinter::PrinterResolution\fR - Use the physical resolution of the printer on Windows. On Unix, set the postscript resolution to 72 dpi. -.TP -\fCQPrinter::HighResolution\fR - Use printer resolution on windows, set the resolution of the postscript driver to 600dpi. -.TP -\fCQPrinter::Compatible\fR - Almost the same as PrinterResolution, but keeps some peculiarities of the Qt 2.x printer driver. This is useful for applications ported from Qt 2.x to Qt 3.x. -.SH "QPrinter::PrinterOption" -This enum describes various printer options that appear in the printer setup dialog. It is used to enable and disable these options in the setup dialog. -.TP -\fCQPrinter::PrintToFile\fR - Describes if print to file should be enabled. -.TP -\fCQPrinter::PrintSelection\fR - Describes if printing selections should be enabled. -.TP -\fCQPrinter::PrintPageRange\fR - Describes if printing page ranges (from, to) should be enabled -.PP -See also setOptionEnabled() and isOptionEnabled(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPrinter::QPrinter ( PrinterMode m = ScreenResolution )" -Constructs a printer paint device with mode \fIm\fR. -.PP -See also QPrinter::PrinterMode. -.SH "QPrinter::~QPrinter ()" -Destroys the printer paint device and cleans up. -.SH "bool QPrinter::abort ()" -Aborts the print job. Returns TRUE if successful; otherwise returns FALSE. -.PP -See also aborted(). -.SH "bool QPrinter::aborted () const" -Returns TRUE if the print job was aborted; otherwise returns FALSE. -.PP -See also abort(). -.SH "ColorMode QPrinter::colorMode () const" -Returns the current color mode. The default color mode is Color. -.PP -See also setColorMode(). -.SH "QString QPrinter::creator () const" -Returns the name of the application that created the document. -.PP -See also setCreator(). -.SH "QString QPrinter::docName () const" -Returns the document name. -.PP -See also setDocName(). -.SH "int QPrinter::fromPage () const" -Returns the from-page setting. The default value is 0. -.PP -If fromPage() and toPage() both return 0 this signifies 'print the whole document'. -.PP -The programmer is responsible for reading this setting and printing accordingly. -.PP -See also setFromTo() and toPage(). -.SH "bool QPrinter::fullPage () const" -Returns TRUE if the origin of the printer's coordinate system is at the corner of the sheet and FALSE if it is at the edge of the printable area. -.PP -See setFullPage() for details and caveats. -.PP -See also setFullPage(), PageSize, and QPaintDeviceMetrics. -.SH "bool QPrinter::isOptionEnabled ( PrinterOption option )" -Returns TRUE if the printer option with identifier \fIoption\fR is enabled; otherwise returns FALSE. -.PP -See also setOptionEnabled(). -.SH "QSize QPrinter::margins () const" -Returns the width of the left margin and the height of the top margin of the printer. On Unix, this is a best-effort guess, not based on perfect knowledge. -.PP -If you have called setFullPage( TRUE ), margins().width() may be treated as the smallest sane left margin you can use, and margins().height() as the smallest sane top margin you can use. -.PP -If you have called setFullPage( FALSE ) (this is the default), margins() is automatically subtracted from the pageSize() by QPrinter. -.PP -See also setFullPage(), QPaintDeviceMetrics, and PageSize. -.SH "void QPrinter::margins ( uint * top, uint * left, uint * bottom, uint * right ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets \fItop\fR, \fIleft\fR, \fIbottom\fR and \fIright\fR to the margins of the printer. On Unix, this is a best-effort guess, not based on perfect knowledge. -.PP -If you have called setFullPage( TRUE ), the four values specify the smallest sane margins you can use. -.PP -If you have called setFullPage( FALSE ) (this is the default), the margins are automatically subtracted from the pageSize() by QPrinter. -.PP -See also setFullPage(), QPaintDeviceMetrics, and PageSize. -.SH "int QPrinter::maxPage () const" -Returns the max-page setting. A user can't choose a higher page number than maxPage() when they select a print range. The default value is 0. -.PP -See also minPage(), setMinMax(), and setFromTo(). -.SH "int QPrinter::minPage () const" -Returns the min-page setting, i.e. the lowest page number a user is allowed to choose. The default value is 0. -.PP -See also maxPage(), setMinMax(), and setFromTo(). -.SH "bool QPrinter::newPage ()" -Advances to a new page on the printer. Returns TRUE if successful; otherwise returns FALSE. -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "int QPrinter::numCopies () const" -Returns the number of copies to be printed. The default value is 1. -.PP -This value will return the number of times the application is required to print in order to match the number specified in the printer setup dialog. This has been done since some printer drivers are not capable of buffering up the copies and the application in those cases have to make an explicit call to the print code for each copy. -.PP -See also setNumCopies(). -.SH "Orientation QPrinter::orientation () const" -Returns the orientation setting. The default value is QPrinter::Portrait. -.PP -See also setOrientation(). -.SH "QString QPrinter::outputFileName () const" -Returns the name of the output file. There is no default file name. -.PP -See also setOutputFileName() and setOutputToFile(). -.SH "bool QPrinter::outputToFile () const" -Returns TRUE if the output should be written to a file, or FALSE if the output should be sent directly to the printer. The default setting is FALSE. -.PP -This function is currently only supported under X11 and Mac OS X. -.PP -See also setOutputToFile() and setOutputFileName(). -.SH "PageOrder QPrinter::pageOrder () const" -Returns the current page order. -.PP -The default page order is FirstPageFirst. -.PP -Bugs and limitations: -.TP -This value is not kept in sync with the Windows or Mac OS X printer dialogs. -.SH "PageSize QPrinter::pageSize () const" -Returns the printer page size. The default value is system-dependent. -.PP -See also setPageSize(). -.SH "PaperSource QPrinter::paperSource () const" -Returns the currently set paper source of the printer. -.PP -See also setPaperSource(). -.SH "QString QPrinter::printProgram () const" -Returns the name of the program that sends the print output to the printer. -.PP -The default is to return a null string; meaning that QPrinter will try to be smart in a system-dependent way. On X11 only, you can set it to something different to use a specific print program. -.PP -On Windows, this function returns the name of the printer device driver. -.PP -See also setPrintProgram() and setPrinterSelectionOption(). -.SH "PrintRange QPrinter::printRange () const" -Returns the PageRange of the QPrinter. After the print setup dialog has been opened, this function returns the value selected by the user. -.PP -See also setPrintRange(). -.SH "QString QPrinter::printerName () const" -Returns the printer name. This value is initially set to the name of the default printer. -.PP -See also setPrinterName(). -.SH "QString QPrinter::printerSelectionOption () const" -Returns the printer options selection string. This is useful only if the print command has been explicitly set. -.PP -The default value (a null string) implies that the printer should be selected in a system-dependent manner. -.PP -Any other value implies that the given value should be used. -.PP -See also setPrinterSelectionOption(). -.SH "int QPrinter::resolution () const\fC [virtual]\fR" -Returns the current assumed resolution of the printer, as set by setResolution() or by the printer subsystem. -.PP -See also setResolution(). -.SH "void QPrinter::setColorMode ( ColorMode newColorMode )\fC [virtual]\fR" -Sets the printer's color mode to \fInewColorMode\fR, which can be either Color or GrayScale (the default). -.PP -See also colorMode(). -.SH "void QPrinter::setCreator ( const QString & creator )\fC [virtual]\fR" -Sets the name of the application that created the document to \fIcreator\fR. -.PP -This function is only applicable to the X11 version of Qt. If no creator name is specified, the creator will be set to "Qt" followed by some version number. -.PP -See also creator(). -.SH "void QPrinter::setDocName ( const QString & name )\fC [virtual]\fR" -Sets the document name to \fIname\fR. -.SH "void QPrinter::setFromTo ( int fromPage, int toPage )\fC [virtual]\fR" -Sets the from-page and to-page settings to \fIfromPage\fR and \fItoPage\fR respectively. -.PP -The from-page and to-page settings specify what pages to print. -.PP -If fromPage() and toPage() both return 0 this signifies 'print the whole document'. -.PP -This function is useful mostly to set a default value that the user can override in the print dialog when you call setup(). -.PP -See also fromPage(), toPage(), setMinMax(), and setup(). -.SH "void QPrinter::setFullPage ( bool fp )\fC [virtual]\fR" -Sets QPrinter to have the origin of the coordinate system at the top-left corner of the paper if \fIfp\fR is TRUE, or where it thinks the top-left corner of the printable area is if \fIfp\fR is FALSE. -.PP -The default is FALSE. You can (probably) print on (0,0), and QPaintDeviceMetrics will report something smaller than the size indicated by PageSize. (Note that QPrinter may be wrong on Unix systems - it does not have perfect knowledge of the physical printer.) -.PP -If you set \fIfp\fR to TRUE, QPaintDeviceMetrics will report the exact same size as indicated by PageSize, but you cannot print on all of that - you must take care of the output margins yourself. -.PP -See also PageSize, setPageSize(), QPaintDeviceMetrics, and fullPage(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "void QPrinter::setMargins ( uint top, uint left, uint bottom, uint right )" -Sets the printer margins to the sizes specified in \fItop\fR, \fIleft\fR, \fIbottom\fR and \fIright\fR. -.PP -This function currently only has an effect on Unix systems. -.PP -See also margins(). -.SH "void QPrinter::setMinMax ( int minPage, int maxPage )\fC [virtual]\fR" -Sets the min-page and max-page settings to \fIminPage\fR and \fImaxPage\fR respectively. -.PP -The min-page and max-page restrict the from-page and to-page settings. When the printer setup dialog appears, the user cannot select a from page or a to page that are outside the range specified by min and max pages. -.PP -See also minPage(), maxPage(), setFromTo(), and setup(). -.SH "void QPrinter::setNumCopies ( int numCopies )\fC [virtual]\fR" -Sets the number of copies to be printed to \fInumCopies\fR. -.PP -The printer driver reads this setting and prints the specified number of copies. -.PP -See also numCopies() and setup(). -.SH "void QPrinter::setOptionEnabled ( PrinterOption option, bool enable )" -Enables the printer option with the identifier \fIoption\fR if \fIenable\fR is TRUE, and disables option \fIoption\fR if \fIenable\fR is FALSE. -.PP -See also isOptionEnabled(). -.SH "void QPrinter::setOrientation ( Orientation orientation )\fC [virtual]\fR" -Sets the print orientation to \fIorientation\fR. -.PP -The orientation can be either QPrinter::Portrait or QPrinter::Landscape. -.PP -The printer driver reads this setting and prints using the specified orientation. On Windows this setting won't take effect until the printer dialog is shown (using QPrinter::setup()). -.PP -Windows only! This option can be changed while printing and will take effect from the next call to newPage() -.PP -See also orientation(). -.SH "void QPrinter::setOutputFileName ( const QString & fileName )\fC [virtual]\fR" -Sets the name of the output file to \fIfileName\fR. -.PP -Setting a null or empty name (0 or "") disables output to a file, i.e. calls setOutputToFile(FALSE). Setting a non-empty name enables output to a file, i.e. calls setOutputToFile(TRUE). -.PP -This function is currently only supported under X11. -.PP -See also outputFileName() and setOutputToFile(). -.SH "void QPrinter::setOutputToFile ( bool enable )\fC [virtual]\fR" -Specifies whether the output should be written to a file or sent directly to the printer. -.PP -Will output to a file if \fIenable\fR is TRUE, or will output directly to the printer if \fIenable\fR is FALSE. -.PP -This function is currently only supported under X11 and Mac OS X. -.PP -See also outputToFile() and setOutputFileName(). -.SH "void QPrinter::setPageOrder ( PageOrder newPageOrder )\fC [virtual]\fR" -Sets the page order to \fInewPageOrder\fR. -.PP -The page order can be QPrinter::FirstPageFirst or QPrinter::LastPageFirst. The application programmer is responsible for reading the page order and printing accordingly. -.PP -This function is useful mostly for setting a default value that the user can override in the print dialog when you call setup(). -.PP -Bugs and limitations: -.TP -This value is not kept in sync with the Windows or Mac OS X printer dialogs. -.SH "void QPrinter::setPageSize ( PageSize newPageSize )\fC [virtual]\fR" -Sets the printer page size to \fInewPageSize\fR if that size is supported. The result if undefined if \fInewPageSize\fR is not supported. -.PP -The default page size is system-dependent. -.PP -This function is useful mostly for setting a default value that the user can override in the print dialog when you call setup(). -.PP -See also pageSize(), PageSize, setFullPage(), and setResolution(). -.SH "void QPrinter::setPaperSource ( PaperSource source )\fC [virtual]\fR" -Sets the paper source setting to \fIsource\fR. -.PP -Windows only! This option can be changed while printing and will take effect from the next call to newPage() -.PP -See also paperSource(). -.SH "void QPrinter::setPrintProgram ( const QString & printProg )\fC [virtual]\fR" -Sets the name of the program that should do the print job to \fIprintProg\fR. -.PP -On X11, this function sets the program to call with the PostScript output. On other platforms, it has no effect. -.PP -See also printProgram(). -.SH "void QPrinter::setPrintRange ( PrintRange range )" -Sets the default selected page range to be used when the print setup dialog is opened to \fIrange\fR. If the PageRange specified by \fIrange\fR is currently disabled the function does nothing. -.PP -See also printRange(). -.SH "void QPrinter::setPrinterName ( const QString & name )\fC [virtual]\fR" -Sets the printer name to \fIname\fR. -.PP -The default printer will be used if no printer name is set. -.PP -Under X11, the \fCPRINTER\fR environment variable defines the default printer. Under any other window system, the window system defines the default printer. -.PP -See also printerName(). -.SH "void QPrinter::setPrinterSelectionOption ( const QString & option )\fC [virtual]\fR" -Sets the printer to use \fIoption\fR to select the printer. \fIoption\fR is null by default (which implies that Qt should be smart enough to guess correctly), but it can be set to other values to use a specific printer selection option. -.PP -If the printer selection option is changed while the printer is active, the current print job may or may not be affected. -.PP -See also printerSelectionOption(). -.SH "void QPrinter::setResolution ( int dpi )\fC [virtual]\fR" -Requests that the printer prints at \fIdpi\fR or as near to \fIdpi\fR as possible. -.PP -This setting affects the coordinate system as returned by, for example, QPaintDeviceMetrics and QPainter::viewport(). -.PP -The value depends on the \fCPrintingMode\fR used in the QPrinter constructor. By default, the dpi value of the screen is used. -.PP -This function must be called before setup() to have an effect on all platforms. -.PP -See also resolution() and setPageSize(). -.SH "void QPrinter::setWinPageSize ( short winPageSize )" -Windows only, using this function is not portable! Sets the windows page size value that is used by the \fCDEVMODE\fR struct. The \fIwinPageSize\fR value must be one of the DMPAPER_ defines from wingdi.h. -.SH "bool QPrinter::setup ( QWidget * parent = 0 )" -Opens a printer setup dialog, with parent \fIparent\fR, and asks the user to specify which printer they wish to use and what settings it should have. -.PP -Returns TRUE if the user pressed "OK" to print, or FALSE if the user canceled the operation. -.PP -Examples: -.)l action/application.cpp, application/application.cpp, drawdemo/drawdemo.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "int QPrinter::toPage () const" -Returns the to-page setting. The default value is 0. -.PP -If fromPage() and toPage() both return 0 this signifies 'print the whole document'. -.PP -The programmer is responsible for reading this setting and printing accordingly. -.PP -See also setFromTo() and fromPage(). -.SH "short QPrinter::winPageSize () const" -Returns the Windows page size value as used by the \fCDEVMODE\fR struct (Windows only). Using this function is not portable. -.PP -Use pageSize() to get the PageSize, e.g. 'A4', 'Letter', etc. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqprinter.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qprinter.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qprocess.3qt b/doc/man/man3/qprocess.3qt deleted file mode 100644 index 210500110..000000000 --- a/doc/man/man3/qprocess.3qt +++ /dev/null @@ -1,521 +0,0 @@ -'\" t -.TH QProcess 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 -QProcess \- Used to start external programs and to communicate with them -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQProcess\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQProcess\fR ( const QString & arg0, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQProcess\fR ( const QStringList & args, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QProcess\fR ()" -.br -.ti -1c -.BI "QStringList \fBarguments\fR () const" -.br -.ti -1c -.BI "void \fBclearArguments\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetArguments\fR ( const QStringList & args )" -.br -.ti -1c -.BI "virtual void \fBaddArgument\fR ( const QString & arg )" -.br -.ti -1c -.BI "QDir \fBworkingDirectory\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetWorkingDirectory\fR ( const QDir & dir )" -.br -.ti -1c -.BI "enum \fBCommunication\fR { Stdin = 0x01, Stdout = 0x02, Stderr = 0x04, DupStderr = 0x08 }" -.br -.ti -1c -.BI "void \fBsetCommunication\fR ( int commFlags )" -.br -.ti -1c -.BI "int \fBcommunication\fR () const" -.br -.ti -1c -.BI "virtual bool \fBstart\fR ( QStringList * env = 0 )" -.br -.ti -1c -.BI "virtual bool \fBlaunch\fR ( const QString & buf, QStringList * env = 0 )" -.br -.ti -1c -.BI "virtual bool \fBlaunch\fR ( const QByteArray & buf, QStringList * env = 0 )" -.br -.ti -1c -.BI "bool \fBisRunning\fR () const" -.br -.ti -1c -.BI "bool \fBnormalExit\fR () const" -.br -.ti -1c -.BI "int \fBexitStatus\fR () const" -.br -.ti -1c -.BI "virtual QByteArray \fBreadStdout\fR ()" -.br -.ti -1c -.BI "virtual QByteArray \fBreadStderr\fR ()" -.br -.ti -1c -.BI "bool \fBcanReadLineStdout\fR () const" -.br -.ti -1c -.BI "bool \fBcanReadLineStderr\fR () const" -.br -.ti -1c -.BI "virtual QString \fBreadLineStdout\fR ()" -.br -.ti -1c -.BI "virtual QString \fBreadLineStderr\fR ()" -.br -.ti -1c -.BI "PID \fBprocessIdentifier\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBtryTerminate\fR () const" -.br -.ti -1c -.BI "void \fBkill\fR () const" -.br -.ti -1c -.BI "virtual void \fBwriteToStdin\fR ( const QByteArray & buf )" -.br -.ti -1c -.BI "virtual void \fBwriteToStdin\fR ( const QString & buf )" -.br -.ti -1c -.BI "virtual void \fBcloseStdin\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBreadyReadStdout\fR ()" -.br -.ti -1c -.BI "void \fBreadyReadStderr\fR ()" -.br -.ti -1c -.BI "void \fBprocessExited\fR ()" -.br -.ti -1c -.BI "void \fBwroteToStdin\fR ()" -.br -.ti -1c -.BI "void \fBlaunchFinished\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QProcess class is used to start external programs and to communicate with them. -.PP -You can write to the started program's standard input, and can read the program's standard output and standard error. You can pass command line arguments to the program either in the constructor or with setArguments() or addArgument(). The program's working directory can be set with setWorkingDirectory(). If you need to set up environment variables pass them to the start() or launch() functions (see below). The processExited() signal is emitted if the program exits. The program's exit status is available from exitStatus(), although you could simply call normalExit() to see if the program terminated normally. -.PP -There are two different ways to start a process. If you just want to run a program, optionally passing data to its standard input at the beginning, use one of the launch() functions. If you want full control of the program's standard input (especially if you don't know all the data you want to send to standard input at the beginning), use the start() function. -.PP -If you use start() you can write to the program's standard input using writeToStdin() and you can close the standard input with closeStdin(). The wroteToStdin() signal is emitted if the data sent to standard input has been written. You can read from the program's standard output using readStdout() or readLineStdout(). These functions return an empty QByteArray if there is no data to read. The readyReadStdout() signal is emitted when there is data available to be read from standard output. Standard error has a set of functions that correspond to the standard output functions, i.e. readStderr(), readLineStderr() and readyReadStderr(). -.PP -If you use one of the launch() functions the data you pass will be sent to the program's standard input which will be closed once all the data has been written. You should \fInot\fR use writeToStdin() or closeStdin() if you use launch(). If you need to send data to the program's standard input after it has started running use start() instead of launch(). -.PP -Both start() and launch() can accept a string list of strings each of which has the format, key=value, where the keys are the names of environment variables. -.PP -You can test to see if a program is running with isRunning(). The program's process identifier is available from processIdentifier(). If you want to terminate a running program use tryTerminate(), but note that the program may ignore this. If you \fIreally\fR want to terminate the program, without it having any chance to clean up, you can use kill(). -.PP -As an example, suppose we want to start the \fCuic\fR command (a Qt command line tool used with \fIQt Designer\fR) and perform some operations on the output (the \fCuic\fR outputs the code it generates to standard output by default). Suppose further that we want to run the program on the file "small_dialog.ui" with the command line options "-tr i18n". On the command line we would write: -.PP -.nf -.br - uic -tr i18n small_dialog.ui -.br -.fi -.PP -A code snippet for this with the QProcess class might look like this: -.PP -.nf -.br - UicManager::UicManager() -.br - { -.fi -.PP -.nf -.br - proc = new QProcess( this ); -.fi -.PP -.nf -.br - proc->addArgument( "uic" ); -.br - proc->addArgument( "-tr" ); -.br - proc->addArgument( "i18n" ); -.br - proc->addArgument( "small_dialog.ui" ); -.br -.br - connect( proc, SIGNAL(readyReadStdout()), -.br - this, SLOT(readFromStdout()) ); -.fi -.PP -.nf -.br - if ( !proc->start() ) { -.br - // error handling -.fi -.PP -.nf -.br - } -.br - } -.fi -.PP -.nf -.br - void UicManager::readFromStdout() -.br - { -.br - // Read and process the data. -.br - // Bear in mind that the data might be output in chunks. -.fi -.PP -.nf -.br - } -.fi -.PP -Although you may need quotes for a file named on the command line (e.g. if it contains spaces) you shouldn't use extra quotes for arguments passed to addArgument() or setArguments(). -.PP -The readyReadStdout() signal is emitted when there is new data on standard output. This happens asynchronously: you don't know if more data will arrive later. -.PP -In the above example you could connect the processExited() signal to the slot UicManager::readFromStdout() instead. If you do so, you will be certain that all the data is available when the slot is called. On the other hand, you must wait until the process has finished before doing any processing. -.PP -Note that if you are expecting a lot of output from the process, you may hit platform-dependent limits to the pipe buffer size. The solution is to make sure you connect to the output, e.g. the readyReadStdout() and readyReadStderr() signals and read the data as soon as it becomes available. -.PP -Please note that QProcess does not emulate a shell. This means that QProcess does not do any expansion of arguments: a '*' is passed as a '*' to the program and is \fInot\fR replaced by all the files, a '$HOME' is also passed literally and is \fInot\fR replaced by the environment variable HOME and the special characters for IO redirection ('>', '|', etc.) are also passed literally and do \fInot\fR have the special meaning as they have in a shell. -.PP -Also note that QProcess does not emulate a terminal. This means that certain programs which need direct terminal control, do not work as expected with QProcess. Such programs include console email programs (like pine and mutt) but also programs which require the user to enter a password (like su and ssh). -.SH "Notes for Windows users" -Some Windows commands, for example, \fCdir\fR, are not provided by separate applications, but by the command interpreter. If you attempt to use QProcess to execute these commands directly it won't work. One possible solution is to execute the command interpreter itself (\fCcmd.exe\fR on some Windows systems), and ask the interpreter to execute the desired command. -.PP -Under Windows there are certain problems starting 16-bit applications and capturing their output. Microsoft recommends using an intermediate application to start 16-bit applications. -.PP -See also QSocket, Input/Output and Networking, and Miscellaneous Classes. -.SS "Member Type Documentation" -.SH "QProcess::Communication" -This enum type defines the communication channels connected to the process. -.TP -\fCQProcess::Stdin\fR - Data can be written to the process's standard input. -.TP -\fCQProcess::Stdout\fR - Data can be read from the process's standard output. -.TP -\fCQProcess::Stderr\fR - Data can be read from the process's standard error. -.TP -\fCQProcess::DupStderr\fR - Both the process's standard error output \fIand\fR its standard output are written to its standard output. (Like Unix's dup2().) This means that nothing is sent to the standard error output. This is especially useful if your application requires that the output on standard output and on standard error must be read in the same order that they are produced. This is a flag, so to activate it you must pass \fCStdout|Stderr|DupStderr\fR, or \fCStdin|Stdout|Stderr|DupStderr\fR if you want to provide input, to the setCommunication() call. -.PP -See also setCommunication() and communication(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QProcess::QProcess ( QObject * parent = 0, const char * name = 0 )" -Constructs a QProcess object. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. -.PP -See also setArguments(), addArgument(), and start(). -.SH "QProcess::QProcess ( const QString & arg0, QObject * parent = 0, const char * name = 0 )" -Constructs a QProcess with \fIarg0\fR as the command to be executed. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. -.PP -The process is not started. You must call start() or launch() to start the process. -.PP -See also setArguments(), addArgument(), and start(). -.SH "QProcess::QProcess ( const QStringList & args, QObject * parent = 0, const char * name = 0 )" -Constructs a QProcess with \fIargs\fR as the arguments of the process. The first element in the list is the command to be executed. The other elements in the list are the arguments to this command. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. -.PP -The process is not started. You must call start() or launch() to start the process. -.PP -See also setArguments(), addArgument(), and start(). -.SH "QProcess::~QProcess ()" -Destroys the instance. -.PP -If the process is running, it is \fBnot\fR terminated! The standard input, standard output and standard error of the process are closed. -.PP -You can connect the destroyed() signal to the kill() slot, if you want the process to be terminated automatically when the instance is destroyed. -.PP -See also tryTerminate() and kill(). -.SH "void QProcess::addArgument ( const QString & arg )\fC [virtual]\fR" -Adds \fIarg\fR to the end of the list of arguments. -.PP -The first element in the list of arguments is the command to be executed; the following elements are the command's arguments. -.PP -See also arguments() and setArguments(). -.PP -Example: process/process.cpp. -.SH "QStringList QProcess::arguments () const" -Returns the list of arguments that are set for the process. Arguments can be specified with the constructor or with the functions setArguments() and addArgument(). -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myProcess.arguments(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also setArguments() and addArgument(). -.SH "bool QProcess::canReadLineStderr () const" -Returns TRUE if it's possible to read an entire line of text from standard error at this time; otherwise returns FALSE. -.PP -See also readLineStderr() and canReadLineStdout(). -.SH "bool QProcess::canReadLineStdout () const" -Returns TRUE if it's possible to read an entire line of text from standard output at this time; otherwise returns FALSE. -.PP -See also readLineStdout() and canReadLineStderr(). -.SH "void QProcess::clearArguments ()" -Clears the list of arguments that are set for the process. -.PP -See also setArguments() and addArgument(). -.SH "void QProcess::closeStdin ()\fC [virtual slot]\fR" -Closes the process's standard input. -.PP -This function also deletes any pending data that has not been written to standard input. -.PP -See also wroteToStdin(). -.SH "int QProcess::communication () const" -Returns the communication required with the process, i.e. some combination of the Communication flags. -.PP -See also setCommunication(). -.SH "int QProcess::exitStatus () const" -Returns the exit status of the process or 0 if the process is still running. This function returns immediately and does not wait until the process is finished. -.PP -If normalExit() is FALSE (e.g. if the program was killed or crashed), this function returns 0, so you should check the return value of normalExit() before relying on this value. -.PP -See also normalExit() and processExited(). -.SH "bool QProcess::isRunning () const" -Returns TRUE if the process is running; otherwise returns FALSE. -.PP -See also normalExit(), exitStatus(), and processExited(). -.SH "void QProcess::kill () const\fC [slot]\fR" -Terminates the process. This is not a safe way to end a process since the process will not be able to do any cleanup. tryTerminate() is safer, but processes can ignore a tryTerminate(). -.PP -The nice way to end a process and to be sure that it is finished, is to do something like this: -.PP -.nf -.br - process->tryTerminate(); -.br - QTimer::singleShot( 5000, process, SLOT( kill() ) ); -.br -.fi -.PP -This tries to terminate the process the nice way. If the process is still running after 5 seconds, it terminates the process the hard way. The timeout should be chosen depending on the time the process needs to do all its cleanup: use a higher value if the process is likely to do a lot of computation or I/O on cleanup. -.PP -The slot returns immediately: it does not wait until the process has finished. When the process terminates, the processExited() signal is emitted. -.PP -See also tryTerminate() and processExited(). -.SH "bool QProcess::launch ( const QByteArray & buf, QStringList * env = 0 )\fC [virtual]\fR" -Runs the process and writes the data \fIbuf\fR to the process's standard input. If all the data is written to standard input, standard input is closed. The command is searched for in the path for executable programs; you can also use an absolute path in the command itself. -.PP -If \fIenv\fR is null, then the process is started with the same environment as the starting process. If \fIenv\fR is non-null, then the values in the string list are interpreted as environment setttings of the form \fCkey=value\fR and the process is started with these environment settings. For convenience, there is a small exception to this rule under Unix: if \fIenv\fR does not contain any settings for the environment variable \fCLD_LIBRARY_PATH\fR, then this variable is inherited from the starting process. -.PP -Returns TRUE if the process could be started; otherwise returns FALSE. -.PP -Note that you should not use the slots writeToStdin() and closeStdin() on processes started with launch(), since the result is not well-defined. If you need these slots, use start() instead. -.PP -The process may or may not read the \fIbuf\fR data sent to its standard input. -.PP -You can call this function even when a process that was started with this instance is still running. Be aware that if you do this the standard input of the process that was launched first will be closed, with any pending data being deleted, and the process will be left to run out of your control. Similarly, if the process could not be started the standard input will be closed and the pending data deleted. (On operating systems that have zombie processes, Qt will also wait() on the old process.) -.PP -The object emits the signal launchFinished() when this function call is finished. If the start was successful, this signal is emitted after all the data has been written to standard input. If the start failed, then this signal is emitted immediately. -.PP -See also start() and launchFinished(). -.SH "bool QProcess::launch ( const QString & buf, QStringList * env = 0 )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The data \fIbuf\fR is written to standard input with writeToStdin() using the QString::local8Bit() representation of the strings. -.SH "void QProcess::launchFinished ()\fC [signal]\fR" -This signal is emitted when the process was started with launch(). If the start was successful, this signal is emitted after all the data has been written to standard input. If the start failed, then this signal is emitted immediately. -.PP -This signal is especially useful if you want to know when you can safely delete the QProcess object when you are not interested in reading from standard output or standard error. -.PP -See also launch() and QObject::deleteLater(). -.SH "bool QProcess::normalExit () const" -Returns TRUE if the process has exited normally; otherwise returns FALSE. This implies that this function returns FALSE if the process is still running. -.PP -See also isRunning(), exitStatus(), and processExited(). -.SH "void QProcess::processExited ()\fC [signal]\fR" -This signal is emitted when the process has exited. -.PP -See also isRunning(), normalExit(), exitStatus(), start(), and launch(). -.PP -Example: process/process.cpp. -.SH "PID QProcess::processIdentifier ()" -Returns platform dependent information about the process. This can be used together with platform specific system calls. -.PP -Under Unix the return value is the PID of the process, or -1 if no process belongs to this object. -.PP -Under Windows it is a pointer to the \fCPROCESS_INFORMATION\fR struct, or 0 if no process is belongs to this object. -.PP -Use of this function's return value is likely to be non-portable. -.SH "QString QProcess::readLineStderr ()\fC [virtual]\fR" -Reads a line of text from standard error, excluding any trailing newline or carriage return characters and returns it. Returns QString::null if canReadLineStderr() returns FALSE. -.PP -By default, the text is interpreted to be in Latin-1 encoding. If you need other codecs, you can set a different codec with QTextCodec::setCodecForCStrings(). -.PP -See also canReadLineStderr(), readyReadStderr(), readStderr(), and readLineStdout(). -.SH "QString QProcess::readLineStdout ()\fC [virtual]\fR" -Reads a line of text from standard output, excluding any trailing newline or carriage return characters, and returns it. Returns QString::null if canReadLineStdout() returns FALSE. -.PP -By default, the text is interpreted to be in Latin-1 encoding. If you need other codecs, you can set a different codec with QTextCodec::setCodecForCStrings(). -.PP -See also canReadLineStdout(), readyReadStdout(), readStdout(), and readLineStderr(). -.SH "QByteArray QProcess::readStderr ()\fC [virtual]\fR" -Reads the data that the process has written to standard error. When new data is written to standard error, the class emits the signal readyReadStderr(). -.PP -If there is no data to read, this function returns a QByteArray of size 0: it does not wait until there is something to read. -.PP -See also readyReadStderr(), readLineStderr(), readStdout(), and writeToStdin(). -.SH "QByteArray QProcess::readStdout ()\fC [virtual]\fR" -Reads the data that the process has written to standard output. When new data is written to standard output, the class emits the signal readyReadStdout(). -.PP -If there is no data to read, this function returns a QByteArray of size 0: it does not wait until there is something to read. -.PP -See also readyReadStdout(), readLineStdout(), readStderr(), and writeToStdin(). -.PP -Example: process/process.cpp. -.SH "void QProcess::readyReadStderr ()\fC [signal]\fR" -This signal is emitted when the process has written data to standard error. You can read the data with readStderr(). -.PP -Note that this signal is only emitted when there is new data and not when there is old, but unread data. In the slot connected to this signal, you should always read everything that is available at that moment to make sure that you don't lose any data. -.PP -See also readStderr(), readLineStderr(), and readyReadStdout(). -.SH "void QProcess::readyReadStdout ()\fC [signal]\fR" -This signal is emitted when the process has written data to standard output. You can read the data with readStdout(). -.PP -Note that this signal is only emitted when there is new data and not when there is old, but unread data. In the slot connected to this signal, you should always read everything that is available at that moment to make sure that you don't lose any data. -.PP -See also readStdout(), readLineStdout(), and readyReadStderr(). -.PP -Example: process/process.cpp. -.SH "void QProcess::setArguments ( const QStringList & args )\fC [virtual]\fR" -Sets \fIargs\fR as the arguments for the process. The first element in the list is the command to be executed. The other elements in the list are the arguments to the command. Any previous arguments are deleted. -.PP -QProcess does not perform argument substitutions; for example, if you specify "*" or "$DISPLAY", these values are passed to the process literally. If you want to have the same behavior as the shell provides, you must do the substitutions yourself; i.e. instead of specifying a "*" you must specify the list of all the filenames in the current directory, and instead of "$DISPLAY" you must specify the value of the environment variable \fCDISPLAY\fR. -.PP -Note for Windows users. The standard Windows shells, e.g. \fCcommand.com\fR and \fCcmd.exe\fR, do not perform file globbing, i.e. they do not convert a "*" on the command line into a list of files in the current directory. For this reason most Windows applications implement their own file globbing, and as a result of this, specifying an argument of "*" for a Windows application is likely to result in the application performing a file glob and ending up with a list of filenames. -.PP -See also arguments() and addArgument(). -.SH "void QProcess::setCommunication ( int commFlags )" -Sets \fIcommFlags\fR as the communication required with the process. -.PP -\fIcommFlags\fR is a bitwise OR of the flags defined by the Communication enum. -.PP -The default is \fCStdin|Stdout|Stderr\fR. -.PP -See also communication(). -.SH "void QProcess::setWorkingDirectory ( const QDir & dir )\fC [virtual]\fR" -Sets \fIdir\fR as the working directory for processes. This does not affect running processes; only processes that are started afterwards are affected. -.PP -Setting the working directory is especially useful for processes that try to access files with relative paths. -.PP -See also workingDirectory() and start(). -.SH "bool QProcess::start ( QStringList * env = 0 )\fC [virtual]\fR" -Tries to run a process for the command and arguments that were specified with setArguments(), addArgument() or that were specified in the constructor. The command is searched for in the path for executable programs; you can also use an absolute path in the command itself. -.PP -If \fIenv\fR is null, then the process is started with the same environment as the starting process. If \fIenv\fR is non-null, then the values in the stringlist are interpreted as environment setttings of the form \fCkey=value\fR and the process is started in these environment settings. For convenience, there is a small exception to this rule: under Unix, if \fIenv\fR does not contain any settings for the environment variable \fCLD_LIBRARY_PATH\fR, then this variable is inherited from the starting process; under Windows the same applies for the environment variable \fCPATH\fR. -.PP -Returns TRUE if the process could be started; otherwise returns FALSE. -.PP -You can write data to the process's standard input with writeToStdin(). You can close standard input with closeStdin() and you can terminate the process with tryTerminate(), or with kill(). -.PP -You can call this function even if you've used this instance to create a another process which is still running. In such cases, QProcess closes the old process's standard input and deletes pending data, i.e., you lose all control over the old process, but the old process is not terminated. This applies also if the process could not be started. (On operating systems that have zombie processes, Qt will also wait() on the old process.) -.PP -See also launch() and closeStdin(). -.PP -Example: process/process.cpp. -.SH "void QProcess::tryTerminate () const\fC [slot]\fR" -Asks the process to terminate. Processes can ignore this if they wish. If you want to be certain that the process really terminates, you can use kill() instead. -.PP -The slot returns immediately: it does not wait until the process has finished. When the process terminates, the processExited() signal is emitted. -.PP -See also kill() and processExited(). -.SH "QDir QProcess::workingDirectory () const" -Returns the working directory that was set with setWorkingDirectory(), or the current directory if none has been explicitly set. -.PP -See also setWorkingDirectory() and QDir::current(). -.SH "void QProcess::writeToStdin ( const QByteArray & buf )\fC [virtual slot]\fR" -Writes the data \fIbuf\fR to the process's standard input. The process may or may not read this data. -.PP -This function always returns immediately. The data you pass to writeToStdin() is copied into an internal memory buffer in QProcess, and when control goes back to the event loop, QProcess will starting transferring data from this buffer to the running process. Sometimes the data will be transferred in several payloads, depending on how much data is read at a time by the process itself. When QProcess has transferred all the data from its memory buffer to the running process, it emits wroteToStdin(). -.PP -Note that some operating systems use a buffer to transfer the data. As a result, wroteToStdin() may be emitted before the running process has actually read all the data. -.PP -See also wroteToStdin(), closeStdin(), readStdout(), and readStderr(). -.SH "void QProcess::writeToStdin ( const QString & buf )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The string \fIbuf\fR is handled as text using the QString::local8Bit() representation. -.SH "void QProcess::wroteToStdin ()\fC [signal]\fR" -This signal is emitted if the data sent to standard input (via writeToStdin()) was actually written to the process. This does not imply that the process really read the data, since this class only detects when it was able to write the data to the operating system. But it is now safe to close standard input without losing pending data. -.PP -See also writeToStdin() and closeStdin(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqprocess.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qprocess.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qprogressbar.3qt b/doc/man/man3/qprogressbar.3qt deleted file mode 100644 index 647a1d177..000000000 --- a/doc/man/man3/qprogressbar.3qt +++ /dev/null @@ -1,238 +0,0 @@ -'\" t -.TH QProgressBar 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 -QProgressBar \- Horizontal progress bar -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQProgressBar\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQProgressBar\fR ( int totalSteps, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "int \fBtotalSteps\fR () const" -.br -.ti -1c -.BI "int \fBprogress\fR () const" -.br -.ti -1c -.BI "const QString & \fBprogressString\fR () const" -.br -.ti -1c -.BI "void \fBsetCenterIndicator\fR ( bool on )" -.br -.ti -1c -.BI "bool \fBcenterIndicator\fR () const" -.br -.ti -1c -.BI "void \fBsetIndicatorFollowsStyle\fR ( bool )" -.br -.ti -1c -.BI "bool \fBindicatorFollowsStyle\fR () const" -.br -.ti -1c -.BI "bool \fBpercentageVisible\fR () const" -.br -.ti -1c -.BI "void \fBsetPercentageVisible\fR ( bool )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBreset\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetTotalSteps\fR ( int totalSteps )" -.br -.ti -1c -.BI "virtual void \fBsetProgress\fR ( int progress )" -.br -.ti -1c -.BI "void \fBsetProgress\fR ( int progress, int totalSteps )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBcenterIndicator\fR - whether the indicator string should be centered" -.br -.ti -1c -.BI "bool \fBindicatorFollowsStyle\fR - whether the display of the indicator string should follow the GUI style" -.br -.ti -1c -.BI "bool \fBpercentageVisible\fR - whether the current progress value is displayed" -.br -.ti -1c -.BI "int \fBprogress\fR - the current amount of progress" -.br -.ti -1c -.BI "QString \fBprogressString\fR - the amount of progress as a string \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBtotalSteps\fR - the total number of steps" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBsetIndicator\fR ( QString & indicator, int progress, int totalSteps )" -.br -.in -1c -.SH DESCRIPTION -The QProgressBar widget provides a horizontal progress bar. -.PP -A progress bar is used to give the user an indication of the progress of an operation and to reassure them that the application is still running. -.PP -The progress bar uses the concept of \fIsteps\fR; you give it the total number of steps and the number of steps completed so far and it will display the percentage of steps that have been completed. You can specify the total number of steps in the constructor or later with setTotalSteps(). The current number of steps is set with setProgress(). The progress bar can be rewound to the beginning with reset(). -.PP -If the total is given as 0 the progress bar shows a busy indicator instead of a percentage of steps. This is useful, for example, when using QFtp or QHttp to download items when they are unable to determine the size of the item being downloaded. -.PP -See also QProgressDialog, GUI Design Handbook: Progress Indicator, and Advanced Widgets. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QProgressDialog, GUI Design Handbook: Progress Indicator, and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QProgressBar::QProgressBar ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a progress bar. -.PP -The total number of steps is set to 100 by default. -.PP -The \fIparent\fR, \fIname\fR and widget flags, \fIf\fR, are passed on to the QFrame::QFrame() constructor. -.PP -See also totalSteps. -.SH "QProgressBar::QProgressBar ( int totalSteps, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a progress bar. -.PP -The \fItotalSteps\fR is the total number of steps that need to be completed for the operation which this progress bar represents. For example, if the operation is to examine 50 files, this value would be 50. Before examining the first file, call setProgress(0); call setProgress(50) after examining the last file. -.PP -The \fIparent\fR, \fIname\fR and widget flags, \fIf\fR, are passed to the QFrame::QFrame() constructor. -.PP -See also totalSteps and progress. -.SH "bool QProgressBar::centerIndicator () const" -Returns TRUE if the indicator string should be centered; otherwise returns FALSE. See the "centerIndicator" property for details. -.SH "bool QProgressBar::indicatorFollowsStyle () const" -Returns TRUE if the display of the indicator string should follow the GUI style; otherwise returns FALSE. See the "indicatorFollowsStyle" property for details. -.SH "bool QProgressBar::percentageVisible () const" -Returns TRUE if the current progress value is displayed; otherwise returns FALSE. See the "percentageVisible" property for details. -.SH "int QProgressBar::progress () const" -Returns the current amount of progress. See the "progress" property for details. -.SH "const QString & QProgressBar::progressString () const" -Returns the amount of progress as a string. See the "progressString" property for details. -.SH "void QProgressBar::reset ()\fC [slot]\fR" -Reset the progress bar. The progress bar "rewinds" and shows no progress. -.PP -Examples: -.)l fileiconview/mainwindow.cpp and progressbar/progressbar.cpp. -.SH "void QProgressBar::setCenterIndicator ( bool on )" -Sets whether the indicator string should be centered to \fIon\fR. See the "centerIndicator" property for details. -.SH "bool QProgressBar::setIndicator ( QString & indicator, int progress, int totalSteps )\fC [virtual protected]\fR" -This method is called to generate the text displayed in the center (or in some styles, to the left) of the progress bar. -.PP -The \fIprogress\fR may be negative, indicating that the progress bar is in the "reset" state before any progress is set. -.PP -The default implementation is the percentage of completion or blank in the reset state. The percentage is calculated based on the \fIprogress\fR and \fItotalSteps\fR. You can set the \fIindicator\fR text if you wish. -.PP -To allow efficient repainting of the progress bar, this method should return FALSE if the string is unchanged from the last call to this function. -.SH "void QProgressBar::setIndicatorFollowsStyle ( bool )" -Sets whether the display of the indicator string should follow the GUI style. See the "indicatorFollowsStyle" property for details. -.SH "void QProgressBar::setPercentageVisible ( bool )" -Sets whether the current progress value is displayed. See the "percentageVisible" property for details. -.SH "void QProgressBar::setProgress ( int progress )\fC [virtual slot]\fR" -Sets the current amount of progress to \fIprogress\fR. See the "progress" property for details. -.SH "void QProgressBar::setProgress ( int progress, int totalSteps )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the amount of progress to \fIprogress\fR and the total number of steps to \fItotalSteps\fR. -.PP -See also totalSteps. -.SH "void QProgressBar::setTotalSteps ( int totalSteps )\fC [virtual slot]\fR" -Sets the total number of steps to \fItotalSteps\fR. See the "totalSteps" property for details. -.SH "int QProgressBar::totalSteps () const" -Returns the total number of steps. See the "totalSteps" property for details. -.SS "Property Documentation" -.SH "bool centerIndicator" -This property holds whether the indicator string should be centered. -.PP -Changing this property sets QProgressBar::indicatorFollowsStyle to FALSE. The default is TRUE. -.PP -Set this property's value with setCenterIndicator() and get this property's value with centerIndicator(). -.SH "bool indicatorFollowsStyle" -This property holds whether the display of the indicator string should follow the GUI style. -.PP -The default is TRUE. -.PP -See also centerIndicator. -.PP -Set this property's value with setIndicatorFollowsStyle() and get this property's value with indicatorFollowsStyle(). -.SH "bool percentageVisible" -This property holds whether the current progress value is displayed. -.PP -The default is TRUE. -.PP -See also centerIndicator and indicatorFollowsStyle. -.PP -Set this property's value with setPercentageVisible() and get this property's value with percentageVisible(). -.SH "int progress" -This property holds the current amount of progress. -.PP -This property is -1 if progress counting has not started. -.PP -Set this property's value with setProgress() and get this property's value with progress(). -.SH "QString progressString" -This property holds the amount of progress as a string. -.PP -This property is QString::null if progress counting has not started. -.PP -Get this property's value with progressString(). -.SH "int totalSteps" -This property holds the total number of steps. -.PP -If totalSteps is 0, the progress bar will display a busy indicator. -.PP -See also -.PP -Set this property's value with setTotalSteps() and get this property's value with totalSteps(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqprogressbar.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qprogressbar.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qprogressdialog.3qt b/doc/man/man3/qprogressdialog.3qt deleted file mode 100644 index 7dcb397ad..000000000 --- a/doc/man/man3/qprogressdialog.3qt +++ /dev/null @@ -1,430 +0,0 @@ -'\" t -.TH QProgressDialog 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 -QProgressDialog \- Feedback on the progress of a slow operation -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQProgressDialog\fR ( QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQProgressDialog\fR ( const QString & labelText, const QString & cancelButtonText, int totalSteps, QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QProgressDialog\fR ()" -.br -.ti -1c -.BI "void \fBsetLabel\fR ( QLabel * label )" -.br -.ti -1c -.BI "void \fBsetCancelButton\fR ( QPushButton * cancelButton )" -.br -.ti -1c -.BI "void \fBsetBar\fR ( QProgressBar * bar )" -.br -.ti -1c -.BI "bool wasCancelled () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBwasCanceled\fR () const" -.br -.ti -1c -.BI "int \fBtotalSteps\fR () const" -.br -.ti -1c -.BI "int \fBprogress\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "QString \fBlabelText\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoReset\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBautoReset\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoClose\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBautoClose\fR () const" -.br -.ti -1c -.BI "int \fBminimumDuration\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBcancel\fR ()" -.br -.ti -1c -.BI "void \fBreset\fR ()" -.br -.ti -1c -.BI "void \fBsetTotalSteps\fR ( int totalSteps )" -.br -.ti -1c -.BI "void \fBsetProgress\fR ( int progress )" -.br -.ti -1c -.BI "void \fBsetProgress\fR ( int progress, int totalSteps )" -.br -.ti -1c -.BI "void \fBsetLabelText\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBsetCancelButtonText\fR ( const QString & cancelButtonText )" -.br -.ti -1c -.BI "void \fBsetMinimumDuration\fR ( int ms )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void cancelled () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBcanceled\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoClose\fR - whether the dialog gets hidden by reset()" -.br -.ti -1c -.BI "bool \fBautoReset\fR - whether the progress dialog calls reset() as soon as progress() equals totalSteps()" -.br -.ti -1c -.BI "QString \fBlabelText\fR - the label's text" -.br -.ti -1c -.BI "int \fBminimumDuration\fR - the time that must pass before the dialog appears" -.br -.ti -1c -.BI "int \fBprogress\fR - the current amount of progress made" -.br -.ti -1c -.BI "int \fBtotalSteps\fR - the total number of steps" -.br -.ti -1c -.BI "bool \fBwasCanceled\fR - whether the dialog was canceled \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool wasCancelled - whether the dialog was canceled \fI(read " "only" ")\fR \fI(obsolete)\fR" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "void \fBforceShow\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QProgressDialog class provides feedback on the progress of a slow operation. -.PP -A progress dialog is used to give the user an indication of how long an operation is going to take, and to demonstrate that the application has not frozen. It can also give the user an opportunity to abort the operation. -.PP -A common problem with progress dialogs is that it is difficult to know when to use them; operations take different amounts of time on different hardware. QProgressDialog offers a solution to this problem: it estimates the time the operation will take (based on time for steps), and only shows itself if that estimate is beyond minimumDuration() (4 seconds by default). -.PP -Use setTotalSteps() (or the constructor) to set the number of" steps" in the operation and call setProgress() as the operation progresses. The step value can be chosen arbitrarily. It can be the number of files copied, the number of bytes received, the number of iterations through the main loop of your algorithm, or some other suitable unit. Progress starts at 0, and the progress dialog shows that the operation has finished when you call setProgress() with totalSteps() as its argument. -.PP -The dialog automatically resets and hides itself at the end of the operation. Use setAutoReset() and setAutoClose() to change this behavior. -.PP -There are two ways of using QProgressDialog: modal and modeless. -.PP -Using a modal QProgressDialog is simpler for the programmer, but you must call QApplication::processEvents() or QEventLoop::processEvents(ExcludeUserInput) to keep the event loop running to ensure that the application doesn't freeze. Do the operation in a loop, call setProgress() at intervals, and check for cancellation with wasCanceled(). For example: -.PP -.nf -.br -QProgressDialog progress( "Copying files...", "Abort Copy", numFiles, -.br - this, "progress", TRUE ); -.br -for ( int i = 0; i < numFiles; i++ ) { -.br - progress.setProgress( i ); -.br - tqApp->processEvents(); -.br -.br - if ( progress.wasCanceled() ) -.br - break; -.br - //... copy one file -.br -} -.br -progress.setProgress( numFiles ); -.fi -.PP -A modeless progress dialog is suitable for operations that take place in the background, where the user is able to interact with the application. Such operations are typically based on QTimer (or QObject::timerEvent()), QSocketNotifier, or QUrlOperator; or performed in a separate thread. A QProgressBar in the status bar of your main window is often an alternative to a modeless progress dialog. -.PP -You need to have an event loop to be running, connect the canceled() signal to a slot that stops the operation, and call setProgress() at intervals. For example: -.PP -.nf -.br -Operation::Operation( QObject *parent = 0 ) -.br - : QObject( parent ), steps( 0 ) -.br -{ -.br - pd = new QProgressDialog( "Operation in progress.", "Cancel", 100 ); -.br - connect( pd, SIGNAL(canceled()), this, SLOT(cancel()) ); -.br - t = new QTimer( this ); -.br - connect( t, SIGNAL(timeout()), this, SLOT(perform()) ); -.br - t->start( 0 ); -.br -} -.br -.br -void Operation::perform() -.br -{ -.br - pd->setProgress( steps ); -.br - //... perform one percent of the operation -.br - steps++; -.br - if ( steps > pd->totalSteps() ) -.br - t->stop(); -.br -} -.br -.br -void Operation::cancel() -.br -{ -.br - t->stop(); -.br - //... cleanup -.br -} -.fi -.PP -In both modes the progress dialog may be customized by replacing the child widgets with custom widgets by using setLabel(), setBar(), and setCancelButton(). The functions setLabelText() and setCancelButtonText() set the texts shown. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QDialog, QProgressBar, GUI Design Handbook: Progress Indicator, and Dialog Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QProgressDialog::QProgressDialog ( QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -Constructs a progress dialog. -.PP -Default settings: -.TP -The label text is empty. -.TP -The cancel button text is (translated) "Cancel". -.TP -The total number of steps is 100. -.PP -The \fIcreator\fR argument is the widget to use as the dialog's parent. The \fIname\fR, \fImodal\fR, and the widget flags, \fIf\fR, are passed to the QDialog::QDialog() constructor. If \fImodal\fR is FALSE (the default), you must have an event loop proceeding for any redrawing of the dialog to occur. If \fImodal\fR is TRUE, the dialog ensures that events are processed when needed. -.PP -See also labelText, setLabel(), setCancelButtonText(), setCancelButton(), and totalSteps. -.SH "QProgressDialog::QProgressDialog ( const QString & labelText, const QString & cancelButtonText, int totalSteps, QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -Constructs a progress dialog. -.PP -The \fIlabelText\fR is text used to remind the user what is progressing. -.PP -The \fIcancelButtonText\fR is the text to display on the cancel button, or 0 if no cancel button is to be shown. -.PP -The \fItotalSteps\fR is the total number of steps in the operation for which this progress dialog shows progress. For example, if the operation is to examine 50 files, this value would be 50. Before examining the first file, call setProgress(0). As each file is processed call setProgress(1), setProgress(2), etc., finally calling setProgress(50) after examining the last file. -.PP -The \fIcreator\fR argument is the widget to use as the dialog's parent. The \fIname\fR, \fImodal\fR, and widget flags, \fIf\fR, are passed to the QDialog::QDialog() constructor. If \fImodal\fR is FALSE (the default), you will must have an event loop proceeding for any redrawing of the dialog to occur. If \fImodal\fR is TRUE, the dialog ensures that events are processed when needed. -.PP -See also labelText, setLabel(), setCancelButtonText(), setCancelButton(), and totalSteps. -.SH "QProgressDialog::~QProgressDialog ()" -Destroys the progress dialog. -.SH "bool QProgressDialog::autoClose () const" -Returns TRUE if the dialog gets hidden by reset(); otherwise returns FALSE. See the "autoClose" property for details. -.SH "bool QProgressDialog::autoReset () const" -Returns TRUE if the progress dialog calls reset() as soon as progress() equals totalSteps(); otherwise returns FALSE. See the "autoReset" property for details. -.SH "void QProgressDialog::cancel ()\fC [slot]\fR" -Resets the progress dialog. wasCanceled() becomes TRUE until the progress dialog is reset. The progress dialog becomes hidden. -.SH "void QProgressDialog::canceled ()\fC [signal]\fR" -This signal is emitted when the cancel button is clicked. It is connected to the cancel() slot by default. -.PP -See also wasCanceled. -.SH "void QProgressDialog::cancelled ()\fC [signal]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use canceled() instead. -.PP -Examples: -.)l network/ftpclient/ftpmainwindow.ui.h and progress/progress.cpp. -.SH "void QProgressDialog::forceShow ()\fC [protected slot]\fR" -Shows the dialog if it is still hidden after the algorithm has been started and minimumDuration milliseconds have passed. -.PP -See also minimumDuration. -.SH "QString QProgressDialog::labelText () const" -Returns the label's text. See the "labelText" property for details. -.SH "int QProgressDialog::minimumDuration () const" -Returns the time that must pass before the dialog appears. See the "minimumDuration" property for details. -.SH "int QProgressDialog::progress () const" -Returns the current amount of progress made. See the "progress" property for details. -.SH "void QProgressDialog::reset ()\fC [slot]\fR" -Resets the progress dialog. The progress dialog becomes hidden if autoClose() is TRUE. -.PP -See also autoClose and autoReset. -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QProgressDialog::setAutoClose ( bool b )" -Sets whether the dialog gets hidden by reset() to \fIb\fR. See the "autoClose" property for details. -.SH "void QProgressDialog::setAutoReset ( bool b )" -Sets whether the progress dialog calls reset() as soon as progress() equals totalSteps() to \fIb\fR. See the "autoReset" property for details. -.SH "void QProgressDialog::setBar ( QProgressBar * bar )" -Sets the progress bar widget to \fIbar\fR. The progress dialog resizes to fit. The progress dialog takes ownership of the progress \fIbar\fR which will be deleted when necessary, so do not use a progress bar allocated on the stack. -.SH "void QProgressDialog::setCancelButton ( QPushButton * cancelButton )" -Sets the cancel button to the push button, \fIcancelButton\fR. The progress dialog takes ownership of this button which will be deleted when necessary, so do not pass the address of an object that is on the stack, i.e. use new() to create the button. -.PP -See also setCancelButtonText(). -.SH "void QProgressDialog::setCancelButtonText ( const QString & cancelButtonText )\fC [slot]\fR" -Sets the cancel button's text to \fIcancelButtonText\fR. -.PP -See also setCancelButton(). -.SH "void QProgressDialog::setLabel ( QLabel * label )" -Sets the label to \fIlabel\fR. The progress dialog resizes to fit. The label becomes owned by the progress dialog and will be deleted when necessary, so do not pass the address of an object on the stack. -.PP -See also labelText. -.PP -Example: progress/progress.cpp. -.SH "void QProgressDialog::setLabelText ( const QString & )\fC [slot]\fR" -Sets the label's text. See the "labelText" property for details. -.SH "void QProgressDialog::setMinimumDuration ( int ms )\fC [slot]\fR" -Sets the time that must pass before the dialog appears to \fIms\fR. See the "minimumDuration" property for details. -.SH "void QProgressDialog::setProgress ( int progress )\fC [slot]\fR" -Sets the current amount of progress made to \fIprogress\fR. See the "progress" property for details. -.SH "void QProgressDialog::setProgress ( int progress, int totalSteps )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the current amount of progress to \fIprogress\fR and the total number of steps to \fItotalSteps\fR. -.PP -See also totalSteps. -.SH "void QProgressDialog::setTotalSteps ( int totalSteps )\fC [slot]\fR" -Sets the total number of steps to \fItotalSteps\fR. See the "totalSteps" property for details. -.SH "QSize QProgressDialog::sizeHint () const\fC [virtual]\fR" -Returns a size that fits the contents of the progress dialog. The progress dialog resizes itself as required, so you should not need to call this yourself. -.SH "int QProgressDialog::totalSteps () const" -Returns the total number of steps. See the "totalSteps" property for details. -.SH "bool QProgressDialog::wasCanceled () const" -Returns TRUE if the dialog was canceled; otherwise returns FALSE. See the "wasCanceled" property for details. -.SH "bool QProgressDialog::wasCancelled () const" -Returns TRUE if the dialog was canceled; otherwise returns FALSE. See the "wasCancelled" property for details. -.SS "Property Documentation" -.SH "bool autoClose" -This property holds whether the dialog gets hidden by reset(). -.PP -The default is TRUE. -.PP -See also autoReset. -.PP -Set this property's value with setAutoClose() and get this property's value with autoClose(). -.SH "bool autoReset" -This property holds whether the progress dialog calls reset() as soon as progress() equals totalSteps(). -.PP -The default is TRUE. -.PP -See also autoClose. -.PP -Set this property's value with setAutoReset() and get this property's value with autoReset(). -.SH "QString labelText" -This property holds the label's text. -.PP -The default text is QString::null. -.PP -Set this property's value with setLabelText() and get this property's value with labelText(). -.SH "int minimumDuration" -This property holds the time that must pass before the dialog appears. -.PP -If the expected duration of the task is less than the minimumDuration, the dialog will not appear at all. This prevents the dialog popping up for tasks that are quickly over. For tasks that are expected to exceed the minimumDuration, the dialog will pop up after the minimumDuration time or as soon as any progress is set. -.PP -If set to 0, the dialog is always shown as soon as any progress is set. The default is 4000 milliseconds. -.PP -Set this property's value with setMinimumDuration() and get this property's value with minimumDuration(). -.SH "int progress" -This property holds the current amount of progress made. -.PP -For the progress dialog to work as expected, you should initially set this property to 0 and finally set it to QProgressDialog::totalSteps(); you can call setProgress() any number of times in-between. -.PP -\fBWarning:\fR If the progress dialog is modal (see QProgressDialog::QProgressDialog()), this function calls QApplication::processEvents(), so take care that this does not cause undesirable re-entrancy in your code. For example, don't use a QProgressDialog inside a paintEvent()! -.PP -See also totalSteps. -.PP -Set this property's value with setProgress() and get this property's value with progress(). -.SH "int totalSteps" -This property holds the total number of steps. -.PP -The default is 0. -.PP -Set this property's value with setTotalSteps() and get this property's value with totalSteps(). -.SH "bool wasCanceled" -This property holds whether the dialog was canceled. -.PP -Get this property's value with wasCanceled(). -.PP -See also progress. -.SH "bool wasCancelled" -This property holds whether the dialog was canceled. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use wasCanceled instead. -.PP -Get this property's value with wasCancelled(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqprogressdialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qprogressdialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrcollection.3qt b/doc/man/man3/qptrcollection.3qt deleted file mode 100644 index 174e05717..000000000 --- a/doc/man/man3/qptrcollection.3qt +++ /dev/null @@ -1,145 +0,0 @@ -'\" t -.TH QPtrCollection 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 -QPtrCollection \- The base class of most pointer-based Qt collections -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                          -.PP -\fC#include \fR -.PP -Inherited by QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const = 0" -.br -.ti -1c -.BI "virtual void \fBclear\fR () = 0" -.br -.ti -1c -.BI "typedef void * \fBItem\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQPtrCollection\fR ()" -.br -.ti -1c -.BI "\fBQPtrCollection\fR ( const QPtrCollection & source )" -.br -.ti -1c -.BI "virtual \fB~QPtrCollection\fR ()" -.br -.ti -1c -.BI "virtual Item \fBnewItem\fR ( Item d )" -.br -.ti -1c -.BI "virtual void \fBdeleteItem\fR ( Item d ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QPtrCollection class is the base class of most pointer-based Qt collections. -.PP -The QPtrCollection class is an abstract base class for the Qt collection classes QDict, QPtrList, etc. Qt also includes value based collections, e.g. QValueList, QMap, etc. -.PP -A QPtrCollection only knows about the number of objects in the collection and the deletion strategy (see setAutoDelete()). -.PP -A collection is implemented using the Item (generic collection item) type, which is a \fCvoid*\fR. The template classes that create the real collections cast the Item to the required type. -.PP -See also Collection Classes and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QPtrCollection::Item" -This type is the generic "item" in a QPtrCollection. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrCollection::QPtrCollection ()\fC [protected]\fR" -Constructs a collection. The constructor is protected because QPtrCollection is an abstract class. -.SH "QPtrCollection::QPtrCollection ( const QPtrCollection & source )\fC [protected]\fR" -Constructs a copy of \fIsource\fR with autoDelete() set to FALSE. The constructor is protected because QPtrCollection is an abstract class. -.PP -Note that if \fIsource\fR has autoDelete turned on, copying it will risk memory leaks, reading freed memory, or both. -.SH "QPtrCollection::~QPtrCollection ()\fC [virtual protected]\fR" -Destroys the collection. The destructor is protected because QPtrCollection is an abstract class. -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QPtrCollection::clear ()\fC [pure virtual]\fR" -Removes all objects from the collection. The objects will be deleted if auto-delete has been enabled. -.PP -See also setAutoDelete(). -.PP -Reimplemented in QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. -.SH "uint QPtrCollection::count () const\fC [pure virtual]\fR" -Returns the number of objects in the collection. -.PP -Reimplemented in QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. -.SH "void QPtrCollection::deleteItem ( Item d )\fC [pure virtual protected]\fR" -Reimplement this function if you want to be able to delete items. -.PP -Deletes an item that is about to be removed from the collection. -.PP -This function has to reimplemented in the collection template classes, and should \fIonly\fR delete item \fId\fR if auto-delete has been enabled. -.PP -\fBWarning:\fR If you reimplement this function you must also reimplement the destructor and call the virtual function clear() from your destructor. This is due to the way virtual functions and destructors work in C++: Virtual functions in derived classes cannot be called from a destructor. If you do not do this, your deleteItem() function will not be called when the container is destroyed. -.PP -See also newItem() and setAutoDelete(). -.SH "Item QPtrCollection::newItem ( Item d )\fC [virtual protected]\fR" -Virtual function that creates a copy of an object that is about to be inserted into the collection. -.PP -The default implementation returns the \fId\fR pointer, i.e. no copy is made. -.PP -This function is seldom reimplemented in the collection template classes. It is not common practice to make a copy of something that is being inserted. -.PP -See also deleteItem(). -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqptrcollection.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrcollection.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrdict.3qt b/doc/man/man3/qptrdict.3qt deleted file mode 100644 index 4656bb15e..000000000 --- a/doc/man/man3/qptrdict.3qt +++ /dev/null @@ -1,315 +0,0 @@ -'\" t -.TH QPtrDict 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 -QPtrDict \- Template class that provides a dictionary based on void* keys -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPtrDict\fR ( int size = 17 )" -.br -.ti -1c -.BI "\fBQPtrDict\fR ( const QPtrDict & dict )" -.br -.ti -1c -.BI "\fB~QPtrDict\fR ()" -.br -.ti -1c -.BI "QPtrDict & \fBoperator=\fR ( const QPtrDict & dict )" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "void \fBinsert\fR ( void * key, const type * item )" -.br -.ti -1c -.BI "void \fBreplace\fR ( void * key, const type * item )" -.br -.ti -1c -.BI "bool \fBremove\fR ( void * key )" -.br -.ti -1c -.BI "type * \fBtake\fR ( void * key )" -.br -.ti -1c -.BI "type * \fBfind\fR ( void * key ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( void * key ) const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "void \fBresize\fR ( uint newsize )" -.br -.ti -1c -.BI "void \fBstatistics\fR () const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" -.br -.in -1c -.SH DESCRIPTION -The QPtrDict class is a template class that provides a dictionary based on void* keys. -.PP -QPtrDict is implemented as a template class. Define a template instance QPtrDict to create a dictionary that operates on pointers to X (X*). -.PP -A dictionary is a collection of key-value pairs. The key is a void* used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. -.PP -Example: -.PP -.nf -.br - QPtrDict fields; // void* keys, char* values -.br -.br - QLineEdit *le1 = new QLineEdit( this ); -.br - le1->setText( "Simpson" ); -.br - QLineEdit *le2 = new QLineEdit( this ); -.br - le2->setText( "Homer" ); -.br - QLineEdit *le3 = new QLineEdit( this ); -.br - le3->setText( "45" ); -.br -.br - fields.insert( le1, "Surname" ); -.br - fields.insert( le2, "Forename" ); -.br - fields.insert( le3, "Age" ); -.br -.br - QPtrDictIterator it( fields ); -.br - for( ; it.current(); ++it ) -.br - cout << it.current() << endl; -.br - cout << endl; -.br -.br - if ( fields[le1] ) // Prints "Surname: Simpson" -.br - cout << fields[le1] << ": " << le1->text() << endl; -.br -.br - if ( fields[le2] ) // Prints "Forename: Homer" -.br - cout << fields[le2] << ": " << le2->text() << endl; -.br -.br -.br - fields.remove( le1 ); // Removes le1 from the dictionary -.br - cout << le1->text() << endl; // Prints "Simpson" -.br -.fi -In this example we use a dictionary to add an extra property (a char*) to the line edits we're using. -.PP -See QDict for full details, including the choice of dictionary size, and how deletions are handled. -.PP -See also QPtrDictIterator, QDict, QAsciiDict, QIntDict, Collection Classes, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrDict::QPtrDict ( int size = 17 )" -Constructs a dictionary using an internal hash array with the size \fIsize\fR. -.PP -Setting \fIsize\fR to a suitably large prime number (equal to or greater than the expected number of entries) makes the hash distribution better and improves lookup performance. -.SH "QPtrDict::QPtrDict ( const QPtrDict & dict )" -Constructs a copy of \fIdict\fR. -.PP -Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). -.SH "QPtrDict::~QPtrDict ()" -Removes all items from the dictionary and destroys it. -.PP -All iterators that access this dictionary will be reset. -.PP -See also setAutoDelete(). -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QPtrDict::clear ()\fC [virtual]\fR" -Removes all items from the dictionary. -.PP -The removed items are deleted if auto-deletion is enabled. -.PP -All dictionary iterators that access this dictionary will be reset. -.PP -See also remove(), take(), and setAutoDelete(). -.PP -Reimplemented from QPtrCollection. -.SH "uint QPtrDict::count () const\fC [virtual]\fR" -Returns the number of items in the dictionary. -.PP -See also isEmpty(). -.PP -Reimplemented from QPtrCollection. -.SH "type * QPtrDict::find ( void * key ) const" -Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be found. -.PP -Equivalent to operator[]. -.PP -See also operator[](). -.SH "void QPtrDict::insert ( void * key, const type * item )" -Inserts the \fIkey\fR with the \fIitem\fR into the dictionary. -.PP -Multiple items can have the same key, in which case only the last item will be accessible using operator[](). -.PP -\fIitem\fR may not be 0. -.PP -See also replace(). -.SH "bool QPtrDict::isEmpty () const" -Returns TRUE if the dictionary is empty; otherwise returns FALSE. -.PP -See also count(). -.SH "QPtrDict & QPtrDict::operator= ( const QPtrDict & dict )" -Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. -.PP -This dictionary is first cleared and then each item in \fIdict\fR is inserted into the dictionary. Only the pointers are copied (shallow copy), unless newItem() has been reimplemented. -.SH "type * QPtrDict::operator[] ( void * key ) const" -Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be found. -.PP -Equivalent to the find() function. -.PP -See also find(). -.SH "QDataStream & QPtrDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QPtrDict::remove ( void * key )" -Removes the item associated with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if \fIkey\fR is in the dictionary; otherwise returns FALSE. -.PP -If there are two or more items with equal keys, then the most recently inserted item will be removed. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary traversal order. -.PP -See also take(), clear(), and setAutoDelete(). -.SH "void QPtrDict::replace ( void * key, const type * item )" -If the dictionary has key \fIkey\fR, this key's item is replaced with \fIitem\fR. If the dictionary doesn't contain key \fIkey\fR, \fIitem\fR is inserted into the dictionary using key \fIkey\fR. -.PP -\fIitem\fR may not be 0. -.PP -Equivalent to -.PP -.nf -.br - QPtrDict dict; -.br - ... -.br - if ( dict.find( key ) ) -.br - dict.remove( key ); -.br - dict.insert( key, item ); -.br -.fi -.PP -If there are two or more items with equal keys, then the most recently inserted item will be replaced. -.PP -See also insert(). -.SH "void QPtrDict::resize ( uint newsize )" -Changes the size of the hash table to \fInewsize\fR. The contents of the dictionary are preserved, but all iterators on the dictionary become invalid. -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. -.SH "uint QPtrDict::size () const" -Returns the size of the internal hash table (as specified in the constructor). -.PP -See also count(). -.SH "void QPtrDict::statistics () const" -Debugging-only function that prints out the dictionary distribution using tqDebug(). -.SH "type * QPtrDict::take ( void * key )" -Takes the item associated with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). -.PP -If there are two or more items with equal keys, then the most recently inserted item will be removed. -.PP -Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. -.PP -All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary traversal order. -.PP -See also remove(), clear(), and setAutoDelete(). -.SH "QDataStream & QPtrDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" -Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqptrdict.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrdict.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrdictiterator.3qt b/doc/man/man3/qptrdictiterator.3qt deleted file mode 100644 index 154c9d345..000000000 --- a/doc/man/man3/qptrdictiterator.3qt +++ /dev/null @@ -1,168 +0,0 @@ -'\" t -.TH QPtrDictIterator 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 -QPtrDictIterator \- Iterator for QPtrDict collections -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPtrDictIterator\fR ( const QPtrDict & dict )" -.br -.ti -1c -.BI "\fB~QPtrDictIterator\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "void * \fBcurrentKey\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.ti -1c -.BI "type * \fBoperator+=\fR ( uint jump )" -.br -.in -1c -.SH DESCRIPTION -The QPtrDictIterator class provides an iterator for QPtrDict collections. -.PP -QPtrDictIterator is implemented as a template class. Define a template instance QPtrDictIterator to create a dictionary iterator that operates on QPtrDict (dictionary of X*). -.PP -Example: -.PP -.nf -.br - QPtrDict fields; -.br -.br - QLineEdit *le1 = new QLineEdit( this ); -.br - le1->setText( "Simpson" ); -.br - QLineEdit *le2 = new QLineEdit( this ); -.br - le2->setText( "Homer" ); -.br - QLineEdit *le3 = new QLineEdit( this ); -.br - le3->setText( "45" ); -.br -.br - fields.insert( le1, "Surname" ); -.br - fields.insert( le2, "Forename" ); -.br - fields.insert( le3, "Age" ); -.br -.br - QPtrDictIterator it( fields ); -.br - for( ; it.current(); ++it ) { -.br - QLineEdit *le = (QLineEdit)it.currentKey(); -.br - cout << it.current() << ": " << le->text() << endl; -.br - } -.br - cout << endl; -.br -.br - // Output (random order): -.br - // Forename: Homer -.br - // Age: 45 -.br - // Surname: Simpson -.br -.fi -In the example we insert some line edits into a dictionary, associating a string with each. We then iterate over the dictionary printing the associated strings. -.PP -Multiple iterators may independently traverse the same dictionary. A QPtrDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QPtrDict updates all iterators that refer the removed item to point to the next item in the traversing order. -.PP -See also QPtrDict, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrDictIterator::QPtrDictIterator ( const QPtrDict & dict )" -Constructs an iterator for \fIdict\fR. The current iterator item is set to point on the first item in the \fIdict\fR. -.SH "QPtrDictIterator::~QPtrDictIterator ()" -Destroys the iterator. -.SH "uint QPtrDictIterator::count () const" -Returns the number of items in the dictionary this iterator operates on. -.PP -See also isEmpty(). -.SH "type * QPtrDictIterator::current () const" -Returns a pointer to the current iterator item's value. -.SH "void * QPtrDictIterator::currentKey () const" -Returns the current iterator item's key. -.SH "bool QPtrDictIterator::isEmpty () const" -Returns TRUE if the dictionary is empty; otherwise returns FALSE. -.PP -See also count(). -.SH "QPtrDictIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QPtrDictIterator::operator() ()" -Makes the succeeding item current and returns the original current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QPtrDictIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns the new current item. -.PP -If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. -.SH "type * QPtrDictIterator::operator+= ( uint jump )" -Sets the current item to the item \fIjump\fR positions after the current item and returns a pointer to that item. -.PP -If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0. -.SH "type * QPtrDictIterator::toFirst ()" -Sets the current iterator item to point to the first item in the -dictionary and returns a pointer to the item. If the dictionary is -empty, it sets the current item to 0 and returns 0. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qptrdictiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrdictiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrlist.3qt b/doc/man/man3/qptrlist.3qt deleted file mode 100644 index 3d7048b5c..000000000 --- a/doc/man/man3/qptrlist.3qt +++ /dev/null @@ -1,718 +0,0 @@ -'\" t -.TH QPtrList 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 -QPtrList \- Template class that provides a list -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -Inherited by QObjectList, QSortedList, and QStrList. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPtrList\fR ()" -.br -.ti -1c -.BI "\fBQPtrList\fR ( const QPtrList & list )" -.br -.ti -1c -.BI "\fB~QPtrList\fR ()" -.br -.ti -1c -.BI "QPtrList & \fBoperator=\fR ( const QPtrList & list )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QPtrList & list ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QPtrList & list ) const" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBinsert\fR ( uint index, const type * item )" -.br -.ti -1c -.BI "void \fBinSort\fR ( const type * item )" -.br -.ti -1c -.BI "void \fBprepend\fR ( const type * item )" -.br -.ti -1c -.BI "void \fBappend\fR ( const type * item )" -.br -.ti -1c -.BI "bool \fBremove\fR ( uint index )" -.br -.ti -1c -.BI "bool \fBremove\fR ()" -.br -.ti -1c -.BI "bool \fBremove\fR ( const type * item )" -.br -.ti -1c -.BI "bool \fBremoveRef\fR ( const type * item )" -.br -.ti -1c -.BI "void \fBremoveNode\fR ( QLNode * node )" -.br -.ti -1c -.BI "bool \fBremoveFirst\fR ()" -.br -.ti -1c -.BI "bool \fBremoveLast\fR ()" -.br -.ti -1c -.BI "type * \fBtake\fR ( uint index )" -.br -.ti -1c -.BI "type * \fBtake\fR ()" -.br -.ti -1c -.BI "type * \fBtakeNode\fR ( QLNode * node )" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "void \fBsort\fR ()" -.br -.ti -1c -.BI "int \fBfind\fR ( const type * item )" -.br -.ti -1c -.BI "int \fBfindNext\fR ( const type * item )" -.br -.ti -1c -.BI "int \fBfindRef\fR ( const type * item )" -.br -.ti -1c -.BI "int \fBfindNextRef\fR ( const type * item )" -.br -.ti -1c -.BI "uint \fBcontains\fR ( const type * item ) const" -.br -.ti -1c -.BI "uint \fBcontainsRef\fR ( const type * item ) const" -.br -.ti -1c -.BI "bool \fBreplace\fR ( uint index, const type * item )" -.br -.ti -1c -.BI "type * \fBat\fR ( uint index )" -.br -.ti -1c -.BI "int \fBat\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "QLNode * \fBcurrentNode\fR () const" -.br -.ti -1c -.BI "type * \fBgetFirst\fR () const" -.br -.ti -1c -.BI "type * \fBgetLast\fR () const" -.br -.ti -1c -.BI "type * \fBfirst\fR ()" -.br -.ti -1c -.BI "type * \fBlast\fR ()" -.br -.ti -1c -.BI "type * \fBnext\fR ()" -.br -.ti -1c -.BI "type * \fBprev\fR ()" -.br -.ti -1c -.BI "void \fBtoVector\fR ( QGVector * vec ) const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual int \fBcompareItems\fR ( QPtrCollection::Item item1, QPtrCollection::Item item2 )" -.br -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" -.br -.in -1c -.SH DESCRIPTION -The QPtrList class is a template class that provides a list. -.PP -QValueList is an STL-compatible alternative to this class. -.PP -Define a template instance QPtrList to create a list that operates on pointers to X (X*). -.PP -The list class is indexable and has a current index and a current item. The first item corresponds to index position 0. The current index is -1 if the current item is 0. -.PP -Items are inserted with prepend(), insert() or append(). Items are removed with remove(), removeRef(), removeFirst() and removeLast(). You can search for an item using find(), findNext(), findRef() or findNextRef(). The list can be sorted with sort(). You can count the number of occurrences of an item with contains() or containsRef(). You can get a pointer to the current item with current(), to an item at a particular index position in the list with at() or to the first or last item with getFirst() and getLast(). You can also iterate over the list with first(), last(), next() and prev() (which all update current()). The list's deletion property is set with setAutoDelete(). -.PP -Example: -.PP -.nf -.br - class Employee -.br - { -.br - public: -.br - Employee() : sn( 0 ) { } -.br - Employee( const QString& forename, const QString& surname, int salary ) -.br - : fn( forename ), sn( surname ), sal( salary ) -.br - { } -.br -.br - void setSalary( int salary ) { sal = salary; } -.br -.br - QString forename() const { return fn; } -.br - QString surname() const { return sn; } -.br - int salary() const { return sal; } -.br -.br - private: -.br - QString fn; -.br - QString sn; -.br - int sal; -.br - }; -.br -.br - QPtrList list; -.br - list.setAutoDelete( TRUE ); // the list owns the objects -.br -.br - list.append( new Employee("John", "Doe", 50000) ); -.br - list.append( new Employee("Jane", "Williams", 80000) ); -.br - list.append( new Employee("Tom", "Jones", 60000) ); -.br -.br - Employee *employee; -.br - for ( employee = list.first(); employee; employee = list.next() ) -.br - cout << employee->surname().latin1() << ", " << -.br - employee->forename().latin1() << " earns " << -.br - employee->salary() << endl; -.br - cout << endl; -.br -.br - // very inefficient for big lists -.br - for ( uint i = 0; i < list.count(); ++i ) -.br - if ( list.at(i) ) -.br - cout << list.at( i )->surname().latin1() << endl; -.br -.fi -.PP -The output is -.PP -.nf -.br - Doe, John earns 50000 -.br - Williams, Jane earns 80000 -.br - Jones, Tom earns 60000 -.br -.br - Doe -.br - Williams -.br - Jones -.br -.fi -.PP -QPtrList has several member functions for traversing the list, but using a QPtrListIterator can be more practical. Multiple list iterators may traverse the same list, independently of each other and of the current list item. -.PP -In the example above we make the call setAutoDelete(TRUE). Enabling auto-deletion tells the list to delete items that are removed. The default is to not delete items when they are removed but this would cause a memory leak in the example because there are no other references to the list items. -.PP -When inserting an item into a list only the pointer is copied, not the item itself, i.e. a shallow copy. It is possible to make the list copy all of the item's data (deep copy) when an item is inserted. insert(), inSort() and append() call the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a list and reimplement newItem() to have deep copies. -.PP -When removing an item from a list, the virtual function QPtrCollection::deleteItem() is called. QPtrList's default implementation is to delete the item if auto-deletion is enabled. -.PP -The virtual function compareItems() can be reimplemented to compare two list items. This function is called from all list functions that need to compare list items, for instance remove(const type*). If you only want to deal with pointers, there are functions that compare pointers instead, for instance removeRef(const type*). These functions are somewhat faster than those that call compareItems(). -.PP -List items are stored as \fCvoid*\fR in an internal QLNode, which also holds pointers to the next and previous list items. The functions currentNode(), removeNode(), and takeNode() operate directly on the QLNode, but they should be used with care. The data component of the node is available through QLNode::getData(). -.PP -The QStrList class defined in ntqstrlist.h is a list of \fCchar*\fR. It reimplements newItem(), deleteItem() and compareItems(). (But see QStringList for a list of Unicode QStrings.) -.PP -See also QPtrListIterator, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrList::QPtrList ()" -Constructs an empty list. -.SH "QPtrList::QPtrList ( const QPtrList & list )" -Constructs a copy of \fIlist\fR. -.PP -Each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy). -.SH "QPtrList::~QPtrList ()" -Removes all items from the list and destroys the list. -.PP -All list iterators that access this list will be reset. -.PP -See also setAutoDelete(). -.SH "void QPtrList::append ( const type * item )" -Inserts the \fIitem\fR at the end of the list. -.PP -The inserted item becomes the current list item. This is equivalent to \fCinsert( count(), item )\fR. -.PP -\fIitem\fR must not be 0. -.PP -See also insert(), current(), and prepend(). -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, customlayout/flow.cpp, grapher/grapher.cpp, listviews/listviews.cpp, listviews/listviews.h, and qwerty/qwerty.cpp. -.SH "type * QPtrList::at ( uint index )" -Returns a pointer to the item at position \fIindex\fR in the list, or 0 if the index is out of range. -.PP -Sets the current list item to this item if \fIindex\fR is valid. The valid range is \fC0..(count() - 1)\fR inclusive. -.PP -This function is very efficient. It starts scanning from the first item, last item, or current item, whichever is closest to \fIindex\fR. -.PP -See also current(). -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, customlayout/flow.cpp, dirview/dirview.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. -.SH "int QPtrList::at () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the index of the current list item. The returned value is -1 if the current item is 0. -.PP -See also current(). -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QPtrList::clear ()\fC [virtual]\fR" -Removes all items from the list. -.PP -The removed items are deleted if auto-deletion is enabled. -.PP -All list iterators that access this list will be reset. -.PP -See also remove(), take(), and setAutoDelete(). -.PP -Reimplemented from QPtrCollection. -.SH "int QPtrList::compareItems ( QPtrCollection::Item item1, QPtrCollection::Item item2 )\fC [virtual protected]\fR" -This virtual function compares two list items. -.PP -Returns: -.TP -zero if \fIitem1\fR == \fIitem2\fR -.TP -nonzero if \fIitem1\fR != \fIitem2\fR -.PP -This function returns \fIint\fR rather than \fIbool\fR so that reimplementations can return three values and use it to sort by: -.TP -0 if \fIitem1\fR == \fIitem2\fR -.TP -> 0 (positive integer) if \fIitem1\fR > \fIitem2\fR -.TP -< 0 (negative integer) if \fIitem1\fR < \fIitem2\fR -.PP -inSort() requires that compareItems() is implemented as described here. -.PP -This function should not modify the list because some const functions call compareItems(). -.PP -The default implementation compares the pointers. -.SH "uint QPtrList::contains ( const type * item ) const" -Returns the number of occurrences of \fIitem\fR in the list. -.PP -The compareItems() function is called when looking for the \fIitem\fR in the list. If compareItems() is not reimplemented, it is more efficient to call containsRef(). -.PP -This function does not affect the current list item. -.PP -See also containsRef() and compareItems(). -.SH "uint QPtrList::containsRef ( const type * item ) const" -Returns the number of occurrences of \fIitem\fR in the list. -.PP -Calling this function is much faster than contains() because contains() compares \fIitem\fR with each list item using compareItems(), whereas his function only compares the pointers. -.PP -This function does not affect the current list item. -.PP -See also contains(). -.SH "uint QPtrList::count () const\fC [virtual]\fR" -Returns the number of items in the list. -.PP -See also isEmpty(). -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, customlayout/flow.cpp, dirview/dirview.cpp, grapher/grapher.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. -.PP -Reimplemented from QPtrCollection. -.SH "type * QPtrList::current () const" -Returns a pointer to the current list item. The current item may be 0 (implies that the current index is -1). -.PP -See also at(). -.SH "QLNode * QPtrList::currentNode () const" -Returns a pointer to the current list node. -.PP -The node can be kept and removed later using removeNode(). The advantage is that the item can be removed directly without searching the list. -.PP -\fBWarning:\fR Do not call this function unless you are an expert. -.PP -See also removeNode(), takeNode(), and current(). -.SH "int QPtrList::find ( const type * item )" -Finds the first occurrence of \fIitem\fR in the list. -.PP -If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. -.PP -The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call findRef(). -.PP -See also findNext(), findRef(), compareItems(), and current(). -.SH "int QPtrList::findNext ( const type * item )" -Finds the next occurrence of \fIitem\fR in the list, starting from the current list item. -.PP -If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. -.PP -The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call findNextRef(). -.PP -See also find(), findNextRef(), compareItems(), and current(). -.SH "int QPtrList::findNextRef ( const type * item )" -Finds the next occurrence of \fIitem\fR in the list, starting from the current list item. -.PP -If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. -.PP -Calling this function is much faster than findNext() because findNext() compares \fIitem\fR with each list item using compareItems(), whereas this function only compares the pointers. -.PP -See also findRef(), findNext(), and current(). -.SH "int QPtrList::findRef ( const type * item )" -Finds the first occurrence of \fIitem\fR in the list. -.PP -If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. -.PP -Calling this function is much faster than find() because find() compares \fIitem\fR with each list item using compareItems(), whereas this function only compares the pointers. -.PP -See also findNextRef(), find(), and current(). -.SH "type * QPtrList::first ()" -Returns a pointer to the first item in the list and makes this the current list item; returns 0 if the list is empty. -.PP -See also getFirst(), last(), next(), prev(), and current(). -.PP -Examples: -.)l grapher/grapher.cpp, listviews/listviews.h, and showimg/showimg.cpp. -.SH "type * QPtrList::getFirst () const" -Returns a pointer to the first item in the list, or 0 if the list is empty. -.PP -This function does not affect the current list item. -.PP -See also first() and getLast(). -.SH "type * QPtrList::getLast () const" -Returns a pointer to the last item in the list, or 0 if the list is empty. -.PP -This function does not affect the current list item. -.PP -See also last() and getFirst(). -.SH "void QPtrList::inSort ( const type * item )" -Inserts the \fIitem\fR at its sorted position in the list. -.PP -The sort order depends on the virtual compareItems() function. All items must be inserted with inSort() to maintain the sorting order. -.PP -The inserted item becomes the current list item. -.PP -\fIitem\fR must not be 0. -.PP -\fBWarning:\fR Using inSort() is slow. An alternative, especially if you have lots of items, is to simply append() or insert() them and then use sort(). inSort() takes up to O(n) compares. That means inserting n items in your list will need O(n^2) compares whereas sort() only needs O(n*log n) for the same task. So use inSort() only if you already have a presorted list and want to insert just a few additional items. -.PP -See also insert(), compareItems(), current(), and sort(). -.SH "bool QPtrList::insert ( uint index, const type * item )" -Inserts the \fIitem\fR at position \fIindex\fR in the list. -.PP -Returns TRUE if successful, i.e. if \fIindex\fR is in range; otherwise returns FALSE. The valid range is 0 to count() (inclusively). The item is appended if \fIindex\fR == count(). -.PP -The inserted item becomes the current list item. -.PP -\fIitem\fR must not be 0. -.PP -See also append(), current(), and replace(). -.SH "bool QPtrList::isEmpty () const" -Returns TRUE if the list is empty; otherwise returns FALSE. -.PP -See also count(). -.SH "type * QPtrList::last ()" -Returns a pointer to the last item in the list and makes this the current list item; returns 0 if the list is empty. -.PP -See also getLast(), first(), next(), prev(), and current(). -.SH "type * QPtrList::next ()" -Returns a pointer to the item succeeding the current item. Returns 0 if the current item is 0 or equal to the last item. -.PP -Makes the succeeding item current. If the current item before this function call was the last item, the current item will be set to 0. If the current item was 0, this function does nothing. -.PP -See also first(), last(), prev(), and current(). -.PP -Examples: -.)l grapher/grapher.cpp, listviews/listviews.h, and showimg/showimg.cpp. -.SH "bool QPtrList::operator!= ( const QPtrList & list ) const" -Compares this list with \fIlist\fR. Returns TRUE if the lists contain different data; otherwise returns FALSE. -.SH "QPtrList & QPtrList::operator= ( const QPtrList & list )" -Assigns \fIlist\fR to this list and returns a reference to this list. -.PP -This list is first cleared and then each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy) unless newItem() has been reimplemented. -.SH "bool QPtrList::operator== ( const QPtrList & list ) const" -Compares this list with \fIlist\fR. Returns TRUE if the lists contain the same data; otherwise returns FALSE. -.SH "void QPtrList::prepend ( const type * item )" -Inserts the \fIitem\fR at the start of the list. -.PP -The inserted item becomes the current list item. This is equivalent to \fCinsert( 0, item )\fR. -.PP -\fIitem\fR must not be 0. -.PP -See also append(), insert(), and current(). -.SH "type * QPtrList::prev ()" -Returns a pointer to the item preceding the current item. Returns 0 if the current item is 0 or equal to the first item. -.PP -Makes the preceding item current. If the current item before this function call was the first item, the current item will be set to 0. If the current item was 0, this function does nothing. -.PP -See also first(), last(), next(), and current(). -.SH "QDataStream & QPtrList::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a list item from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QPtrList::remove ( uint index )" -Removes the item at position \fIindex\fR in the list. -.PP -Returns TRUE if successful, i.e. if \fIindex\fR is in range; otherwise returns FALSE. The valid range is \fC0..(count() - 1)\fR inclusive. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. -.PP -All list iterators that refer to the removed item will be set to point to the new current item. -.PP -See also take(), clear(), setAutoDelete(), current(), and removeRef(). -.SH "bool QPtrList::remove ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes the current list item. -.PP -Returns TRUE if successful, i.e. if the current item isn't 0; otherwise returns FALSE. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the removed item will be set to point to the new current item. -.PP -See also take(), clear(), setAutoDelete(), current(), and removeRef(). -.SH "bool QPtrList::remove ( const type * item )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes the first occurrence of \fIitem\fR from the list. -.PP -Returns TRUE if successful, i.e. if \fIitem\fR is in the list; otherwise returns FALSE. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call removeRef(). -.PP -If \fIitem\fR is NULL then the current item is removed from the list. -.PP -The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the removed item will be set to point to the new current item. -.PP -See also removeRef(), take(), clear(), setAutoDelete(), compareItems(), and current(). -.SH "bool QPtrList::removeFirst ()" -Removes the first item from the list. Returns TRUE if successful, i.e. if the list isn't empty; otherwise returns FALSE. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -The first item in the list becomes the new current list item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the removed item will be set to point to the new current item. -.PP -See also removeLast(), setAutoDelete(), current(), and remove(). -.SH "bool QPtrList::removeLast ()" -Removes the last item from the list. Returns TRUE if successful, i.e. if the list isn't empty; otherwise returns FALSE. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -The last item in the list becomes the new current list item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the removed item will be set to point to the new current item. -.PP -See also removeFirst(), setAutoDelete(), and current(). -.SH "void QPtrList::removeNode ( QLNode * node )" -Removes the \fInode\fR from the list. -.PP -This node must exist in the list, otherwise the program may crash. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -The first item in the list will become the new current list item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the removed item will be set to point to the item succeeding this item or to the preceding item if the removed item was the last item. -.PP -\fBWarning:\fR Do not call this function unless you are an expert. -.PP -See also takeNode(), currentNode(), remove(), and removeRef(). -.SH "bool QPtrList::removeRef ( const type * item )" -Removes the first occurrence of \fIitem\fR from the list. -.PP -Returns TRUE if successful, i.e. if \fIitem\fR is in the list; otherwise returns FALSE. -.PP -The removed item is deleted if auto-deletion is enabled. -.PP -Equivalent to: -.PP -.nf -.br - if ( list.findRef( item ) != -1 ) -.br - list.remove(); -.br -.fi -.PP -The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the removed item will be set to point to the new current item. -.PP -See also remove(), clear(), setAutoDelete(), and current(). -.SH "bool QPtrList::replace ( uint index, const type * item )" -Replaces the item at position \fIindex\fR with the new \fIitem\fR. -.PP -Returns TRUE if successful, i.e. \fIindex\fR is in the range 0 to count()-1. -.PP -See also append(), current(), and insert(). -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. -.SH "void QPtrList::sort ()" -Sorts the list by the result of the virtual compareItems() function. -.PP -The heap sort algorithm is used for sorting. It sorts n items with O(n*log n) comparisons. This is the asymptotic optimal solution of the sorting problem. -.PP -If the items in your list support operator<() and operator==(), you might be better off with QSortedList because it implements the compareItems() function for you using these two operators. -.PP -See also inSort(). -.SH "type * QPtrList::take ( uint index )" -Takes the item at position \fIindex\fR out of the list without deleting it (even if auto-deletion is enabled). -.PP -Returns a pointer to the item taken out of the list, or 0 if the index is out of range. The valid range is \fC0..(count() - 1)\fR inclusive. -.PP -The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the taken item will be set to point to the new current item. -.PP -See also remove(), clear(), and current(). -.PP -Examples: -.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.SH "type * QPtrList::take ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Takes the current item out of the list without deleting it (even if auto-deletion is enabled). -.PP -Returns a pointer to the item taken out of the list, or 0 if the current item is 0. -.PP -The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. -.PP -All list iterators that refer to the taken item will be set to point to the new current item. -.PP -See also remove(), clear(), and current(). -.SH "type * QPtrList::takeNode ( QLNode * node )" -Takes the \fInode\fR out of the list without deleting its item (even if auto-deletion is enabled). Returns a pointer to the item taken out of the list. -.PP -This node must exist in the list, otherwise the program may crash. -.PP -The first item in the list becomes the new current list item. -.PP -All list iterators that refer to the taken item will be set to point to the item succeeding this item or to the preceding item if the taken item was the last item. -.PP -\fBWarning:\fR Do not call this function unless you are an expert. -.PP -See also removeNode() and currentNode(). -.SH "void QPtrList::toVector ( QGVector * vec ) const" -Stores all list items in the vector \fIvec\fR. -.PP -The vector must be of the same item type, otherwise the result will be undefined. -.SH "QDataStream & QPtrList::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" -Writes a list item, \fIitem\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation does nothing. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqptrlist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrlist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrlistiterator.3qt b/doc/man/man3/qptrlistiterator.3qt deleted file mode 100644 index 06f1037a1..000000000 --- a/doc/man/man3/qptrlistiterator.3qt +++ /dev/null @@ -1,210 +0,0 @@ -'\" t -.TH QPtrListIterator 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 -QPtrListIterator \- Iterator for QPtrList collections -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QObjectListIterator and QStrListIterator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPtrListIterator\fR ( const QPtrList & list )" -.br -.ti -1c -.BI "\fB~QPtrListIterator\fR ()" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBatFirst\fR () const" -.br -.ti -1c -.BI "bool \fBatLast\fR () const" -.br -.ti -1c -.BI "type * \fBtoFirst\fR ()" -.br -.ti -1c -.BI "type * \fBtoLast\fR ()" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBoperator*\fR ()" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.ti -1c -.BI "type * \fBoperator()\fR ()" -.br -.ti -1c -.BI "type * \fBoperator++\fR ()" -.br -.ti -1c -.BI "type * \fBoperator+=\fR ( uint jump )" -.br -.ti -1c -.BI "type * \fBoperator--\fR ()" -.br -.ti -1c -.BI "type * \fBoperator-=\fR ( uint jump )" -.br -.ti -1c -.BI "QPtrListIterator & \fBoperator=\fR ( const QPtrListIterator & it )" -.br -.in -1c -.SH DESCRIPTION -The QPtrListIterator class provides an iterator for QPtrList collections. -.PP -Define a template instance QPtrListIterator to create a list iterator that operates on QPtrList (list of X*). -.PP -The following example is similar to the example in the QPtrList class documentation, but it uses QPtrListIterator. The class Employee is defined there. -.PP -.nf -.br - QPtrList list; -.br -.br - list.append( new Employee("John", "Doe", 50000) ); -.br - list.append( new Employee("Jane", "Williams", 80000) ); -.br - list.append( new Employee("Tom", "Jones", 60000) ); -.br -.br - QPtrListIterator it( list ); -.br - Employee *employee; -.br - while ( (employee = it.current()) != 0 ) { -.br - ++it; -.br - cout << employee->surname().latin1() << ", " << -.br - employee->forename().latin1() << " earns " << -.br - employee->salary() << endl; -.br - } -.br -.fi -.PP -The output is -.PP -.nf -.br - Doe, John earns 50000 -.br - Williams, Jane earns 80000 -.br - Jones, Tom earns 60000 -.br -.fi -.PP -Using a list iterator is a more robust way of traversing the list than using the QPtrList member functions first(), next(), current(), etc., as many iterators can traverse the same list independently. -.PP -An iterator has its own current list item and can get the next and previous list items. It doesn't modify the list in any way. -.PP -When an item is removed from the list, all iterators that point to that item are updated to point to QPtrList::current() instead to avoid dangling references. -.PP -See also QPtrList, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrListIterator::QPtrListIterator ( const QPtrList & list )" -Constructs an iterator for \fIlist\fR. The current iterator item is set to point on the first item in the \fIlist\fR. -.SH "QPtrListIterator::~QPtrListIterator ()" -Destroys the iterator. -.SH "bool QPtrListIterator::atFirst () const" -Returns TRUE if the current iterator item is the first list item; otherwise returns FALSE. -.PP -See also toFirst() and atLast(). -.SH "bool QPtrListIterator::atLast () const" -Returns TRUE if the current iterator item is the last list item; otherwise returns FALSE. -.PP -See also toLast() and atFirst(). -.SH "uint QPtrListIterator::count () const" -Returns the number of items in the list this iterator operates on. -.PP -See also isEmpty(). -.PP -Example: customlayout/card.cpp. -.SH "type * QPtrListIterator::current () const" -Returns a pointer to the current iterator item. If the iterator is positioned before the first item in the list or after the last item in the list, 0 is returned. -.PP -Examples: -.)l canvas/canvas.cpp, customlayout/card.cpp, and customlayout/flow.cpp. -.SH "bool QPtrListIterator::isEmpty () const" -Returns TRUE if the list is empty; otherwise returns FALSE. -.PP -See also count(). -.SH "QPtrListIterator::operator type * () const" -Cast operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QPtrListIterator::operator() ()" -Makes the succeeding item current and returns the original current item. -.PP -If the current iterator item was the last item in the list or if it was 0, 0 is returned. -.SH "type * QPtrListIterator::operator* ()" -Asterisk operator. Returns a pointer to the current iterator item. Same as current(). -.SH "type * QPtrListIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns the new current item. -.PP -If the current iterator item was the last item in the list or if it was 0, 0 is returned. -.SH "type * QPtrListIterator::operator+= ( uint jump )" -Sets the current item to the item \fIjump\fR positions after the current item and returns a pointer to that item. -.PP -If that item is beyond the last item or if the list is empty, it sets the current item to 0 and returns 0 -.SH "type * QPtrListIterator::operator-- ()" -Prefix - makes the preceding item current and returns the new current item. -.PP -If the current iterator item was the first item in the list or if it was 0, 0 is returned. -.SH "type * QPtrListIterator::operator-= ( uint jump )" -Returns the item \fIjump\fR positions before the current item or 0 if it is beyond the first item. Makes this the current item. -.SH "QPtrListIterator & QPtrListIterator::operator= ( const QPtrListIterator & it )" -Assignment. Makes a copy of the iterator \fIit\fR and returns a reference to this iterator. -.SH "type * QPtrListIterator::toFirst ()" -Sets the current iterator item to point to the first list item and returns a pointer to the item. Sets the current item to 0 and returns 0 if the list is empty. -.PP -See also toLast() and atFirst(). -.SH "type * QPtrListIterator::toLast ()" -Sets the current iterator item to point to the last list item and returns a pointer to the item. Sets the current item to 0 and returns 0 if the list is empty. -.PP -See also toFirst() and atLast(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qptrlistiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrlistiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrqueue.3qt b/doc/man/man3/qptrqueue.3qt deleted file mode 100644 index 9dbb5e7c9..000000000 --- a/doc/man/man3/qptrqueue.3qt +++ /dev/null @@ -1,186 +0,0 @@ -'\" t -.TH QPtrQueue 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 -QPtrQueue \- Template class that provides a queue -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPtrQueue\fR ()" -.br -.ti -1c -.BI "\fBQPtrQueue\fR ( const QPtrQueue & queue )" -.br -.ti -1c -.BI "\fB~QPtrQueue\fR ()" -.br -.ti -1c -.BI "QPtrQueue & \fBoperator=\fR ( const QPtrQueue & queue )" -.br -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "void \fBenqueue\fR ( const type * d )" -.br -.ti -1c -.BI "type * \fBdequeue\fR ()" -.br -.ti -1c -.BI "bool \fBremove\fR ()" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "type * \fBhead\fR () const" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" -.br -.in -1c -.SH DESCRIPTION -The QPtrQueue class is a template class that provides a queue. -.PP -QValueVector can be used as an STL-compatible alternative to this class. -.PP -A template instance QPtrQueue is a queue that operates on pointers to X (X*). -.PP -A queue is a first in, first out structure. Items are added to the tail of the queue with enqueue() and retrieved from the head with dequeue(). You can peek at the head item without dequeing it using head(). -.PP -You can control the queue's deletion policy with setAutoDelete(). -.PP -For compatibility with the QPtrCollection classes, current() and remove() are provided; both operate on the head(). -.PP -See also QPtrList, QPtrStack, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrQueue::QPtrQueue ()" -Creates an empty queue with autoDelete() set to FALSE. -.SH "QPtrQueue::QPtrQueue ( const QPtrQueue & queue )" -Creates a queue from \fIqueue\fR. -.PP -Only the pointers are copied; the items are not. The autoDelete() flag is set to FALSE. -.SH "QPtrQueue::~QPtrQueue ()" -Destroys the queue. Items in the queue are deleted if autoDelete() is TRUE. -.SH "bool QPtrQueue::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "void QPtrQueue::clear ()" -Removes all items from the queue, and deletes them if autoDelete() is TRUE. -.PP -See also remove(). -.SH "uint QPtrQueue::count () const" -Returns the number of items in the queue. -.PP -See also isEmpty(). -.SH "type * QPtrQueue::current () const" -Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty. -.PP -See also dequeue() and isEmpty(). -.SH "type * QPtrQueue::dequeue ()" -Takes the head item from the queue and returns a pointer to it. Returns 0 if the queue is empty. -.PP -See also enqueue() and count(). -.SH "void QPtrQueue::enqueue ( const type * d )" -Adds item \fId\fR to the tail of the queue. -.PP -See also count() and dequeue(). -.SH "type * QPtrQueue::head () const" -Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty. -.PP -See also dequeue() and isEmpty(). -.SH "bool QPtrQueue::isEmpty () const" -Returns TRUE if the queue is empty; otherwise returns FALSE. -.PP -See also count(), dequeue(), and head(). -.SH "QPtrQueue::operator type * () const" -Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty. -.PP -See also dequeue() and isEmpty(). -.SH "QPtrQueue & QPtrQueue::operator= ( const QPtrQueue & queue )" -Assigns \fIqueue\fR to this queue and returns a reference to this queue. -.PP -This queue is first cleared and then each item in \fIqueue\fR is enqueued to this queue. Only the pointers are copied. -.PP -\fBWarning:\fR The autoDelete() flag is not modified. If it it TRUE for both \fIqueue\fR and this queue, deleting the two lists will cause \fIdouble-deletion\fR of the items. -.SH "QDataStream & QPtrQueue::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a queue item, \fIitem\fR, from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QPtrQueue::remove ()" -Removes the head item from the queue, and returns TRUE if there was an item, i.e. the queue wasn't empty; otherwise returns FALSE. -.PP -The item is deleted if autoDelete() is TRUE. -.PP -See also head(), isEmpty(), and dequeue(). -.SH "void QPtrQueue::setAutoDelete ( bool enable )" -Sets the queue to auto-delete its contents if \fIenable\fR is TRUE and not to delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a queue are deleted when the queue itself is deleted. This can be quite convenient if the queue has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the queue: you might find yourself with two queues deleting the same items. -.PP -See also autoDelete(). -.SH "QDataStream & QPtrQueue::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" -Writes a queue item, \fIitem\fR, to the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation does nothing. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqptrqueue.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrqueue.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrstack.3qt b/doc/man/man3/qptrstack.3qt deleted file mode 100644 index 5632af1d9..000000000 --- a/doc/man/man3/qptrstack.3qt +++ /dev/null @@ -1,164 +0,0 @@ -'\" t -.TH QPtrStack 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 -QPtrStack \- Template class that provides a stack -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPtrStack\fR ()" -.br -.ti -1c -.BI "\fBQPtrStack\fR ( const QPtrStack & s )" -.br -.ti -1c -.BI "\fB~QPtrStack\fR ()" -.br -.ti -1c -.BI "QPtrStack & \fBoperator=\fR ( const QPtrStack & s )" -.br -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "void \fBpush\fR ( const type * d )" -.br -.ti -1c -.BI "type * \fBpop\fR ()" -.br -.ti -1c -.BI "bool \fBremove\fR ()" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "type * \fBtop\fR () const" -.br -.ti -1c -.BI "\fBoperator type *\fR () const" -.br -.ti -1c -.BI "type * \fBcurrent\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" -.br -.in -1c -.SH DESCRIPTION -The QPtrStack class is a template class that provides a stack. -.PP -QValueStack is an STL-compatible alternative to this class. -.PP -Define a template instance QPtrStack to create a stack that operates on pointers to X, (X*). -.PP -A stack is a last in, first out (LIFO) structure. Items are added to the top of the stack with push() and retrieved from the top with pop(). Use top() to get a reference to the top element without changing the stack. -.PP -You can control the stack's deletion policy with setAutoDelete(). -.PP -For compatibility with the QPtrCollection classes current() and remove() are provided; they both operate on the top(). -.PP -See also QPtrList, QPtrQueue, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrStack::QPtrStack ()" -Creates an empty stack. -.SH "QPtrStack::QPtrStack ( const QPtrStack & s )" -Creates a stack by making a shallow copy of another stack \fIs\fR. -.SH "QPtrStack::~QPtrStack ()" -Destroys the stack. All items will be deleted if autoDelete() is TRUE. -.SH "bool QPtrStack::autoDelete () const" -The same as QPtrCollection::autoDelete(). -.PP -See also setAutoDelete(). -.SH "void QPtrStack::clear ()" -Removes all items from the stack, deleting them if autoDelete() is TRUE. -.PP -See also remove(). -.SH "uint QPtrStack::count () const" -Returns the number of items in the stack. -.PP -See also isEmpty(). -.SH "type * QPtrStack::current () const" -Returns a pointer to the top item on the stack (most recently pushed). The stack is not changed. Returns 0 if the stack is empty. -.SH "bool QPtrStack::isEmpty () const" -Returns TRUE if the stack contains no elements; otherwise returns FALSE. -.SH "QPtrStack::operator type * () const" -Returns a pointer to the top item on the stack (most recently pushed). The stack is not changed. Returns 0 if the stack is empty. -.SH "QPtrStack & QPtrStack::operator= ( const QPtrStack & s )" -Sets the contents of this stack by making a shallow copy of another stack \fIs\fR. Elements currently in this stack will be deleted if autoDelete() is TRUE. -.SH "type * QPtrStack::pop ()" -Removes the top item from the stack and returns it. The stack must not be empty. -.SH "void QPtrStack::push ( const type * d )" -Adds an element \fId\fR to the top of the stack. Last in, first out. -.SH "QDataStream & QPtrStack::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a stack item, \fIitem\fR, from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QPtrStack::remove ()" -Removes the top item from the stack and deletes it if autoDelete() is TRUE. Returns TRUE if there was an item to pop; otherwise returns FALSE. -.PP -See also clear(). -.SH "void QPtrStack::setAutoDelete ( bool enable )" -Defines whether this stack auto-deletes its contents. The same as QPtrCollection::setAutoDelete(). -.PP -If \fIenable\fR is TRUE the stack auto-deletes its contents; if \fIenable\fR is FALSE the stack does not delete its contents. -.PP -See also autoDelete(). -.SH "type * QPtrStack::top () const" -Returns a pointer to the top item on the stack (most recently pushed). The stack is not changed. Returns 0 if the stack is empty. -.SH "QDataStream & QPtrStack::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" -Writes a stack item, \fIitem\fR, to the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation does nothing. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqptrstack.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrstack.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qptrvector.3qt b/doc/man/man3/qptrvector.3qt deleted file mode 100644 index b513696e7..000000000 --- a/doc/man/man3/qptrvector.3qt +++ /dev/null @@ -1,351 +0,0 @@ -'\" t -.TH QPtrVector 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 -QPtrVector \- Template collection class that provides a vector (array) -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrCollection. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPtrVector\fR ()" -.br -.ti -1c -.BI "\fBQPtrVector\fR ( uint size )" -.br -.ti -1c -.BI "\fBQPtrVector\fR ( const QPtrVector & v )" -.br -.ti -1c -.BI "\fB~QPtrVector\fR ()" -.br -.ti -1c -.BI "QPtrVector & \fBoperator=\fR ( const QPtrVector & v )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QPtrVector & v ) const" -.br -.ti -1c -.BI "type ** \fBdata\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "virtual uint \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBresize\fR ( uint size )" -.br -.ti -1c -.BI "bool \fBinsert\fR ( uint i, const type * d )" -.br -.ti -1c -.BI "bool \fBremove\fR ( uint i )" -.br -.ti -1c -.BI "type * \fBtake\fR ( uint i )" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "bool \fBfill\fR ( const type * d, int size = -1 )" -.br -.ti -1c -.BI "void \fBsort\fR ()" -.br -.ti -1c -.BI "int \fBbsearch\fR ( const type * d ) const" -.br -.ti -1c -.BI "int \fBfindRef\fR ( const type * d, uint i = 0 ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( const type * d, uint i = 0 ) const" -.br -.ti -1c -.BI "uint \fBcontainsRef\fR ( const type * d ) const" -.br -.ti -1c -.BI "uint \fBcontains\fR ( const type * d ) const" -.br -.ti -1c -.BI "type * \fBoperator[]\fR ( int i ) const" -.br -.ti -1c -.BI "type * \fBat\fR ( uint i ) const" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "bool \fBautoDelete\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoDelete\fR ( bool enable )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual int \fBcompareItems\fR ( QPtrCollection::Item d1, QPtrCollection::Item d2 )" -.br -.ti -1c -.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" -.br -.ti -1c -.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" -.br -.in -1c -.SH DESCRIPTION -The QPtrVector class is a template collection class that provides a vector (array). -.PP -QValueVector is an STL-compatible alternative to this class. -.PP -QPtrVector is implemented as a template class. Defines a template instance QPtrVector to create a vector that contains pointers to X (X*). -.PP -A vector is the same as an array. The main difference between QPtrVector and QMemArray is that QPtrVector stores pointers to the elements, whereas QMemArray stores the elements themselves (i.e. QMemArray is value-based and QPtrVector is pointer-based). -.PP -Items are added to the vector using insert() or fill(). Items are removed with remove(). You can get a pointer to an item at a particular index position using at(). -.PP -Unless otherwise stated, all functions that remove items from the vector will also delete the element pointed to if auto-deletion is enabled. By default, auto-deletion is disabled; see setAutoDelete(). This behaviour can be changed in a subclass by reimplementing the virtual function deleteItem(). -.PP -Functions that compare items (find() and sort() for example) will do so using the virtual function compareItems(). The default implementation of this function only compares the pointer values. Reimplement compareItems() in a subclass to get searching and sorting based on the item contents. You can perform a linear search for a pointer in the vector using findRef(), or a binary search (of a sorted vector) using bsearch(). You can count the number of times an item appears in the vector with contains() or containsRef(). -.PP -See also QMemArray and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPtrVector::QPtrVector ()" -Constructs a null vector. -.PP -See also isNull(). -.SH "QPtrVector::QPtrVector ( uint size )" -Constructs an vector with room for \fIsize\fR items. Makes a null vector if \fIsize\fR == 0. -.PP -All \fIsize\fR positions in the vector are initialized to 0. -.PP -See also size(), resize(), and isNull(). -.SH "QPtrVector::QPtrVector ( const QPtrVector & v )" -Constructs a copy of \fIv\fR. Only the pointers are copied (i.e. shallow copy). -.SH "QPtrVector::~QPtrVector ()" -Removes all items from the vector, and destroys the vector itself. -.PP -See also clear(). -.SH "type * QPtrVector::at ( uint i ) const" -Returns the item at position \fIi\fR, or 0 if there is no item at that position. \fIi\fR must be less than size(). -.SH "bool QPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. -.PP -See also setAutoDelete(). -.SH "int QPtrVector::bsearch ( const type * d ) const" -In a sorted array, finds the first occurrence of \fId\fR using a binary search. For a sorted array, this is generally much faster than find(), which performs a linear search. -.PP -Returns the position of \fId\fR, or -1 if \fId\fR could not be found. \fId\fR must not be 0. -.PP -Compares items using the virtual function compareItems(). -.PP -See also sort() and find(). -.SH "void QPtrVector::clear ()\fC [virtual]\fR" -Removes all items from the vector, and destroys the vector itself. -.PP -The vector becomes a null vector. -.PP -See also isNull(). -.PP -Reimplemented from QPtrCollection. -.SH "int QPtrVector::compareItems ( QPtrCollection::Item d1, QPtrCollection::Item d2 )\fC [virtual protected]\fR" -This virtual function compares two list items. -.PP -Returns: -.TP -zero if \fId1\fR == \fId2\fR -.TP -nonzero if \fId1\fR != \fId2\fR -.PP -This function returns \fIint\fR rather than \fIbool\fR so that reimplementations can return one of three values and use it to sort by: -.TP -0 if \fId1\fR == \fId2\fR -.TP -> 0 (positive integer) if \fId1\fR > \fId2\fR -.TP -< 0 (negative integer) if \fId1\fR < \fId2\fR -.PP -The sort() and bsearch() functions require compareItems() to be implemented as described here. -.PP -This function should not modify the vector because some const functions call compareItems(). -.SH "uint QPtrVector::contains ( const type * d ) const" -Returns the number of occurrences of item \fId\fR in the vector. -.PP -Compares items using the virtual function compareItems(). -.PP -See also containsRef(). -.SH "uint QPtrVector::containsRef ( const type * d ) const" -Returns the number of occurrences of the item pointer \fId\fR in the vector. -.PP -This function does \fInot\fR use compareItems() to compare items. -.PP -See also findRef(). -.SH "uint QPtrVector::count () const\fC [virtual]\fR" -Returns the number of items in the vector. The vector is empty if count() == 0. -.PP -See also isEmpty(), size(), and isNull(). -.PP -Reimplemented from QPtrCollection. -.SH "type ** QPtrVector::data () const" -Returns a pointer to the actual vector data, which is an array of type*. -.PP -The vector is a null vector if data() == 0 (null pointer). -.PP -See also isNull(). -.SH "bool QPtrVector::fill ( const type * d, int size = -1 )" -Inserts item \fId\fR in all positions in the vector. Any existing items are removed. If \fId\fR is 0, the vector becomes empty. -.PP -If \fIsize\fR >= 0, the vector is first resized to \fIsize\fR. By default, \fIsize\fR is -1. -.PP -Returns TRUE if successful, i.e. \fIsize\fR is the same as the current size, or \fIsize\fR is larger and the memory has successfully been allocated; otherwise returns FALSE. -.PP -See also resize(), insert(), and isEmpty(). -.SH "int QPtrVector::find ( const type * d, uint i = 0 ) const" -Finds the first occurrence of item \fId\fR in the vector using a linear search. The search starts at position \fIi\fR, which must be less than size(). \fIi\fR is by default 0; i.e. the search starts at the start of the vector. -.PP -Returns the position of \fId\fR, or -1 if \fId\fR could not be found. -.PP -Compares items using the virtual function compareItems(). -.PP -Use the much faster bsearch() to search a sorted vector. -.PP -See also findRef() and bsearch(). -.SH "int QPtrVector::findRef ( const type * d, uint i = 0 ) const" -Finds the first occurrence of the item pointer \fId\fR in the vector using a linear search. The search starts at position \fIi\fR, which must be less than size(). \fIi\fR is by default 0; i.e. the search starts at the start of the vector. -.PP -Returns the position of \fId\fR, or -1 if \fId\fR could not be found. -.PP -This function does \fInot\fR use compareItems() to compare items. -.PP -Use the much faster bsearch() to search a sorted vector. -.PP -See also find() and bsearch(). -.SH "bool QPtrVector::insert ( uint i, const type * d )" -Sets position \fIi\fR in the vector to contain the item \fId\fR. \fIi\fR must be less than size(). Any previous element in position \fIi\fR is removed. -.PP -See also at(). -.SH "bool QPtrVector::isEmpty () const" -Returns TRUE if the vector is empty; otherwise returns FALSE. -.PP -See also count(). -.SH "bool QPtrVector::isNull () const" -Returns TRUE if the vector is null; otherwise returns FALSE. -.PP -A null vector has size() == 0 and data() == 0. -.PP -See also size(). -.SH "QPtrVector & QPtrVector::operator= ( const QPtrVector & v )" -Assigns \fIv\fR to this vector and returns a reference to this vector. -.PP -This vector is first cleared and then all the items from \fIv\fR are copied into the vector. Only the pointers are copied (i.e. shallow copy). -.PP -See also clear(). -.SH "bool QPtrVector::operator== ( const QPtrVector & v ) const" -Returns TRUE if this vector and \fIv\fR are equal; otherwise returns FALSE. -.SH "type * QPtrVector::operator[] ( int i ) const" -Returns the item at position \fIi\fR, or 0 if there is no item at that position. \fIi\fR must be less than size(). -.PP -Equivalent to at( \fIi\fR ). -.PP -See also at(). -.SH "QDataStream & QPtrVector::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" -Reads a vector item, \fIitem\fR, from the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation sets \fIitem\fR to 0. -.PP -See also write(). -.SH "bool QPtrVector::remove ( uint i )" -Removes the item at position \fIi\fR in the vector, if there is one. \fIi\fR must be less than size(). -.PP -Returns TRUE if \fIi\fR is within range; otherwise returns FALSE. -.PP -See also take() and at(). -.SH "bool QPtrVector::resize ( uint size )" -Resizes (expands or shrinks) the vector to \fIsize\fR elements. The vector becomes a null vector if \fIsize\fR == 0. -.PP -Any items at position \fIsize\fR or beyond in the vector are removed. New positions are initialized to 0. -.PP -Returns TRUE if successful, i.e. if the memory was successfully allocated; otherwise returns FALSE. -.PP -See also size() and isNull(). -.SH "void QPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. -.PP -If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. -.PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. -.PP -Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. -.PP -See also autoDelete(). -.PP -Examples: -.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. -.SH "uint QPtrVector::size () const" -Returns the size of the vector, i.e. the number of vector positions. This is also the maximum number of items the vector can hold. -.PP -The vector is a null vector if size() == 0. -.PP -See also isNull(), resize(), and count(). -.SH "void QPtrVector::sort ()" -Sorts the items in ascending order. Any empty positions will be put last. -.PP -Compares items using the virtual function compareItems(). -.PP -See also bsearch(). -.SH "type * QPtrVector::take ( uint i )" -Returns the item at position \fIi\fR in the vector, and removes that item from the vector. \fIi\fR must be less than size(). If there is no item at position \fIi\fR, 0 is returned. -.PP -Unlike remove(), this function does \fInot\fR call deleteItem() for the removed item. -.PP -See also remove() and at(). -.SH "QDataStream & QPtrVector::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" -Writes a vector item, \fIitem\fR, to the stream \fIs\fR and returns a reference to the stream. -.PP -The default implementation does nothing. -.PP -See also read(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqptrvector.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qptrvector.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qpushbutton.3qt b/doc/man/man3/qpushbutton.3qt deleted file mode 100644 index b948f949f..000000000 --- a/doc/man/man3/qpushbutton.3qt +++ /dev/null @@ -1,468 +0,0 @@ -'\" t -.TH QPushButton 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 -QPushButton \- Command button -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QButton. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQPushButton\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQPushButton\fR ( const QString & text, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQPushButton\fR ( const QIconSet & icon, const QString & text, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QPushButton\fR ()" -.br -.ti -1c -.BI "void \fBsetToggleButton\fR ( bool )" -.br -.ti -1c -.BI "bool \fBautoDefault\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoDefault\fR ( bool autoDef )" -.br -.ti -1c -.BI "bool \fBisDefault\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDefault\fR ( bool def )" -.br -.ti -1c -.BI "virtual void setIsMenuButton ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool isMenuButton () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetPopup\fR ( QPopupMenu * popup )" -.br -.ti -1c -.BI "QPopupMenu * \fBpopup\fR () const" -.br -.ti -1c -.BI "void \fBsetIconSet\fR ( const QIconSet & )" -.br -.ti -1c -.BI "QIconSet * \fBiconSet\fR () const" -.br -.ti -1c -.BI "void \fBsetFlat\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisFlat\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetOn\fR ( bool )" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "const QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" -.br -.ti -1c -.BI "QKeySequence \fBaccel\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" -.br -.ti -1c -.BI "bool \fBisToggleButton\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDown\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisDown\fR () const" -.br -.ti -1c -.BI "bool \fBisOn\fR () const" -.br -.ti -1c -.BI "ToggleState \fBstate\fR () const" -.br -.ti -1c -.BI "bool \fBautoRepeat\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoRepeat\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisExclusiveToggle\fR () const" -.br -.ti -1c -.BI "QButtonGroup * \fBgroup\fR () const" -.br -.ti -1c -.BI "void \fBtoggle\fR ()" -.br -.ti -1c -.BI "void \fBpressed\fR ()" -.br -.ti -1c -.BI "void \fBreleased\fR ()" -.br -.ti -1c -.BI "void \fBclicked\fR ()" -.br -.ti -1c -.BI "void \fBtoggled\fR ( bool on )" -.br -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoDefault\fR - whether the push button is the auto default button" -.br -.ti -1c -.BI "bool \fBautoMask\fR - whether the button is automatically masked \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBdefault\fR - whether the push button is the default button" -.br -.ti -1c -.BI "bool \fBflat\fR - whether the border is disabled" -.br -.ti -1c -.BI "QIconSet \fBiconSet\fR - the icon set on the push button" -.br -.ti -1c -.BI "bool menuButton - whether the push button has a menu button on it \fI(read " "only" ")\fR \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBon\fR - whether the push button is toggled" -.br -.ti -1c -.BI "bool \fBtoggleButton\fR - whether the button is a toggle button" -.br -.in -1c -.SH DESCRIPTION -The QPushButton widget provides a command button. -.PP -The push button, or command button, is perhaps the most commonly used widget in any graphical user interface. Push (click) a button to command the computer to perform some action, or to answer a question. Typical buttons are OK, Apply, Cancel, Close, Yes, No and Help. -.PP -A command button is rectangular and typically displays a text label describing its action. An underlined character in the label (signified by preceding it with an ampersand in the text) indicates an accelerator key, e.g. -.PP -.nf -.br - QPushButton *pb = new QPushButton( "&Download", this ); -.br -.fi -In this example the accelerator is \fIAlt+D\fR, and the label text will be displayed as \fBDownload\fR. -.PP -Push buttons can display a textual label or a pixmap, and optionally a small icon. These can be set using the constructors and changed later using setText(), setPixmap() and setIconSet(). If the button is disabled the appearance of the text or pixmap and iconset will be manipulated with respect to the GUI style to make the button look "disabled". -.PP -A push button emits the signal clicked() when it is activated by the mouse, the Spacebar or by a keyboard accelerator. Connect to this signal to perform the button's action. Push buttons also provide less commonly used signals, for example, pressed() and released(). -.PP -Command buttons in dialogs are by default auto-default buttons, i.e. they become the default push button automatically when they receive the keyboard input focus. A default button is a push button that is activated when the user presses the Enter or Return key in a dialog. You can change this with setAutoDefault(). Note that auto-default buttons reserve a little extra space which is necessary to draw a default-button indicator. If you do not want this space around your buttons, call setAutoDefault(FALSE). -.PP -Being so central, the button widget has grown to accommodate a great many variations in the past decade. The Microsoft style guide now shows about ten different states of Windows push buttons and the text implies that there are dozens more when all the combinations of features are taken into consideration. -.PP -The most important modes or states are: -.TP -Available or not (grayed out, disabled). -.TP -Standard push button, toggling push button or menu button. -.TP -On or off (only for toggling push buttons). -.TP -Default or normal. The default button in a dialog can generally be "clicked" using the Enter or Return key. -.TP -Auto-repeat or not. -.TP -Pressed down or not. -.PP -As a general rule, use a push button when the application or dialog window performs an action when the user clicks on it (such as Apply, Cancel, Close and Help) \fIand\fR when the widget is supposed to have a wide, rectangular shape with a text label. Small, typically square buttons that change the state of the window rather than performing an action (such as the buttons in the top-right corner of the QFileDialog) are not command buttons, but tool buttons. Qt provides a special class (QToolButton) for these buttons. -.PP -If you need toggle behavior (see setToggleButton()) or a button that auto-repeats the activation signal when being pushed down like the arrows in a scroll bar (see setAutoRepeat()), a command button is probably not what you want. When in doubt, use a tool button. -.PP -A variation of a command button is a menu button. These provide not just one command, but several, since when they are clicked they pop up a menu of options. Use the method setPopup() to associate a popup menu with a push button. -.PP -Other classes of buttons are option buttons (see QRadioButton) and check boxes (see QCheckBox). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -In Qt, the QButton abstract base class provides most of the modes and other API, and QPushButton provides GUI logic. See QButton for more information about the API. -.PP -See also QToolButton, QRadioButton, QCheckBox, GUI Design Handbook: Push Button, and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QPushButton::QPushButton ( QWidget * parent, const char * name = 0 )" -Constructs a push button with no text. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.SH "QPushButton::QPushButton ( const QString & text, QWidget * parent, const char * name = 0 )" -Constructs a push button called \fIname\fR with the parent \fIparent\fR and the text \fItext\fR. -.SH "QPushButton::QPushButton ( const QIconSet & icon, const QString & text, QWidget * parent, const char * name = 0 )" -Constructs a push button with an \fIicon\fR and a \fItext\fR. -.PP -Note that you can also pass a QPixmap object as an icon (thanks to the implicit type conversion provided by C++). -.PP -The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. -.SH "QPushButton::~QPushButton ()" -Destroys the push button. -.SH "QKeySequence QButton::accel () const" -Returns the accelerator associated with the button. See the "accel" property for details. -.SH "bool QPushButton::autoDefault () const" -Returns TRUE if the push button is the auto default button; otherwise returns FALSE. See the "autoDefault" property for details. -.SH "bool QButton::autoRepeat () const" -Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. -.SH "void QButton::clicked ()\fC [signal]\fR" -This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). -.PP -The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. -.PP -\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. -.PP -See also pressed(), released(), toggled(), autoRepeat, and down. -.PP -Examples: -.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. -.SH "QButtonGroup * QButton::group () const" -Returns the group that this button belongs to. -.PP -If the button is not a member of any QButtonGroup, this function returns 0. -.PP -See also QButtonGroup. -.SH "QIconSet * QPushButton::iconSet () const" -Returns the icon set on the push button. See the "iconSet" property for details. -.SH "bool QPushButton::isDefault () const" -Returns TRUE if the push button is the default button; otherwise returns FALSE. See the "default" property for details. -.SH "bool QButton::isDown () const" -Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. -.SH "bool QButton::isExclusiveToggle () const" -Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. -.SH "bool QPushButton::isFlat () const" -Returns TRUE if the border is disabled; otherwise returns FALSE. See the "flat" property for details. -.SH "bool QPushButton::isMenuButton () const" -Returns TRUE if the push button has a menu button on it; otherwise returns FALSE. See the "menuButton" property for details. -.SH "bool QButton::isOn () const" -Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. -.SH "bool QButton::isToggleButton () const" -Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. -.SH "const QPixmap * QButton::pixmap () const" -Returns the pixmap shown on the button. See the "pixmap" property for details. -.SH "QPopupMenu * QPushButton::popup () const" -Returns the button's associated popup menu or 0 if no popup menu has been set. -.PP -See also setPopup(). -.SH "void QButton::pressed ()\fC [signal]\fR" -This signal is emitted when the button is pressed down. -.PP -See also released() and clicked(). -.PP -Examples: -.)l network/httpd/httpd.cpp and popup/popup.cpp. -.SH "void QButton::released ()\fC [signal]\fR" -This signal is emitted when the button is released. -.PP -See also pressed(), clicked(), and toggled(). -.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" -Sets the accelerator associated with the button. See the "accel" property for details. -.SH "void QPushButton::setAutoDefault ( bool autoDef )\fC [virtual]\fR" -Sets whether the push button is the auto default button to \fIautoDef\fR. See the "autoDefault" property for details. -.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" -Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. -.SH "void QPushButton::setDefault ( bool def )\fC [virtual]\fR" -Sets whether the push button is the default button to \fIdef\fR. See the "default" property for details. -.SH "void QButton::setDown ( bool )\fC [virtual]\fR" -Sets whether the button is pressed. See the "down" property for details. -.SH "void QPushButton::setFlat ( bool )" -Sets whether the border is disabled. See the "flat" property for details. -.SH "void QPushButton::setIconSet ( const QIconSet & )" -Sets the icon set on the push button. See the "iconSet" property for details. -.SH "void QPushButton::setIsMenuButton ( bool enable )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QPushButton::setOn ( bool )\fC [virtual slot]\fR" -Sets whether the push button is toggled. See the "on" property for details. -.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" -Sets the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QPushButton::setPopup ( QPopupMenu * popup )" -Associates the popup menu \fIpopup\fR with this push button. This turns the button into a menu button. -.PP -Ownership of the popup menu is \fInot\fR transferred to the push button. -.PP -See also popup(). -.PP -Examples: -.)l buttongroups/buttongroups.cpp and qdir/qdir.cpp. -.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" -Sets the text shown on the button. See the "text" property for details. -.SH "void QPushButton::setToggleButton ( bool )" -Sets whether the button is a toggle button. See the "toggleButton" property for details. -.SH "ToggleState QButton::state () const" -Returns the state of the toggle button. See the "toggleState" property for details. -.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. -.PP -See also clicked() and QButton::ToggleState. -.SH "QString QButton::text () const" -Returns the text shown on the button. See the "text" property for details. -.SH "void QButton::toggle ()\fC [slot]\fR" -Toggles the state of a toggle button. -.PP -See also on, on, toggled(), and toggleButton. -.SH "void QButton::toggled ( bool on )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, or because setOn() was called. -.PP -See also clicked(). -.PP -Example: listbox/listbox.cpp. -.SS "Property Documentation" -.SH "QKeySequence accel" -This property holds the accelerator associated with the button. -.PP -This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. -.PP -Set this property's value with setAccel() and get this property's value with accel(). -.SH "bool autoDefault" -This property holds whether the push button is the auto default button. -.PP -If this property is set to TRUE then the push button is the auto default button in a dialog. -.PP -In some GUI styles a default button is drawn with an extra frame around it, up to 3 pixels or more. Qt automatically keeps this space free around auto-default buttons, i.e. auto-default buttons may have a slightly larger size hint. -.PP -This property's default is TRUE for buttons that have a QDialog parent; otherwise it defaults to FALSE. -.PP -See the default property for details of how default and auto-default interact. -.PP -Set this property's value with setAutoDefault() and get this property's value with autoDefault(). -.SH "bool autoMask" -This property holds whether the button is automatically masked. -.PP -See also QWidget::autoMask. -.SH "bool autoRepeat" -This property holds whether autoRepeat is enabled. -.PP -If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. -.PP -Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). -.SH "bool default" -This property holds whether the push button is the default button. -.PP -If this property is set to TRUE then the push button will be pressed if the user presses the Enter (or Return) key in a dialog. -.PP -Regardless of focus, if the user presses Enter: If there is a default button the default button is pressed; otherwise, if there are one or more autoDefault buttons the first autoDefault button that is next in the tab order is pressed. If there are no default or autoDefault buttons only pressing Space on a button with focus, mouse clicking, or using an accelerator will press a button. -.PP -In a dialog, only one push button at a time can be the default button. This button is then displayed with an additional frame (depending on the GUI style). -.PP -The default button behavior is provided only in dialogs. Buttons can always be clicked from the keyboard by pressing Enter (or Return) or the Spacebar when the button has focus. -.PP -This property's default is FALSE. -.PP -Set this property's value with setDefault() and get this property's value with isDefault(). -.SH "bool flat" -This property holds whether the border is disabled. -.PP -This property's default is FALSE. -.PP -Set this property's value with setFlat() and get this property's value with isFlat(). -.SH "QIconSet iconSet" -This property holds the icon set on the push button. -.PP -This property will return 0 if the push button has no iconset. -.PP -Set this property's value with setIconSet() and get this property's value with iconSet(). -.SH "bool menuButton" -This property holds whether the push button has a menu button on it. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -If this property is set to TRUE, then a down arrow is drawn on the push button to indicate that a menu will pop up if the user clicks on the arrow. -.PP -Get this property's value with isMenuButton(). -.SH "bool on" -This property holds whether the push button is toggled. -.PP -This property should only be set for toggle push buttons. The default value is FALSE. -.PP -See also on, toggle(), toggled(), and toggleButton. -.PP -Set this property's value with setOn(). -.SH "QPixmap pixmap" -This property holds the pixmap shown on the button. -.PP -If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. -.PP -pixmap() returns 0 if no pixmap was set. -.PP -Set this property's value with setPixmap() and get this property's value with pixmap(). -.SH "QString text" -This property holds the text shown on the button. -.PP -This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. -.PP -There is no default text. -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "bool toggleButton" -This property holds whether the button is a toggle button. -.PP -Toggle buttons have an on/off state similar to check boxes. A push button is initially not a toggle button. -.PP -See also on, toggle(), toggleButton, and toggled(). -.PP -Set this property's value with setToggleButton(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpushbutton.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qpushbutton.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qradiobutton.3qt b/doc/man/man3/qradiobutton.3qt deleted file mode 100644 index 0ff9cfa20..000000000 --- a/doc/man/man3/qradiobutton.3qt +++ /dev/null @@ -1,278 +0,0 @@ -'\" t -.TH QRadioButton 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 -QRadioButton \- Radio button with a text or pixmap label -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QButton. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQRadioButton\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQRadioButton\fR ( const QString & text, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "bool \fBisChecked\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetChecked\fR ( bool check )" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & )" -.br -.ti -1c -.BI "const QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" -.br -.ti -1c -.BI "QKeySequence \fBaccel\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" -.br -.ti -1c -.BI "bool \fBisToggleButton\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDown\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisDown\fR () const" -.br -.ti -1c -.BI "bool \fBisOn\fR () const" -.br -.ti -1c -.BI "ToggleState \fBstate\fR () const" -.br -.ti -1c -.BI "bool \fBautoRepeat\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoRepeat\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisExclusiveToggle\fR () const" -.br -.ti -1c -.BI "QButtonGroup * \fBgroup\fR () const" -.br -.ti -1c -.BI "void \fBtoggle\fR ()" -.br -.ti -1c -.BI "void \fBpressed\fR ()" -.br -.ti -1c -.BI "void \fBreleased\fR ()" -.br -.ti -1c -.BI "void \fBclicked\fR ()" -.br -.ti -1c -.BI "void \fBtoggled\fR ( bool on )" -.br -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoMask\fR - whether the radio button is automatically masked \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBchecked\fR - whether the radio button is checked" -.br -.in -1c -.SH DESCRIPTION -The QRadioButton widget provides a radio button with a text or pixmap label. -.PP -QRadioButton and QCheckBox are both option buttons. That is, they can be switched on (checked) or off (unchecked). The classes differ in how the choices for the user are restricted. Check boxes define "many of many" choices, whereas radio buttons provide a" one of many" choice. In a group of radio buttons only one radio button at a time can be checked; if the user selects another button, the previously selected button is switched off. -.PP -The easiest way to implement a "one of many" choice is simply to put the radio buttons into QButtonGroup. -.PP -Whenever a button is switched on or off it emits the signal toggled(). Connect to this signal if you want to trigger an action each time the button changes state. Otherwise, use isChecked() to see if a particular button is selected. -.PP -Just like QPushButton, a radio button can display text or a pixmap. The text can be set in the constructor or with setText(); the pixmap is set with setPixmap(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QPushButton, QToolButton, GUI Design Handbook: Radio Button, and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QRadioButton::QRadioButton ( QWidget * parent, const char * name = 0 )" -Constructs a radio button with no text. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.SH "QRadioButton::QRadioButton ( const QString & text, QWidget * parent, const char * name = 0 )" -Constructs a radio button with the text \fItext\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.SH "QKeySequence QButton::accel () const" -Returns the accelerator associated with the button. See the "accel" property for details. -.SH "bool QButton::autoRepeat () const" -Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. -.SH "void QButton::clicked ()\fC [signal]\fR" -This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). -.PP -The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. -.PP -\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. -.PP -See also pressed(), released(), toggled(), autoRepeat, and down. -.PP -Examples: -.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. -.SH "QButtonGroup * QButton::group () const" -Returns the group that this button belongs to. -.PP -If the button is not a member of any QButtonGroup, this function returns 0. -.PP -See also QButtonGroup. -.SH "bool QRadioButton::isChecked () const" -Returns TRUE if the radio button is checked; otherwise returns FALSE. See the "checked" property for details. -.SH "bool QButton::isDown () const" -Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. -.SH "bool QButton::isExclusiveToggle () const" -Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. -.SH "bool QButton::isOn () const" -Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. -.SH "bool QButton::isToggleButton () const" -Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. -.SH "const QPixmap * QButton::pixmap () const" -Returns the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::pressed ()\fC [signal]\fR" -This signal is emitted when the button is pressed down. -.PP -See also released() and clicked(). -.PP -Examples: -.)l network/httpd/httpd.cpp and popup/popup.cpp. -.SH "void QButton::released ()\fC [signal]\fR" -This signal is emitted when the button is released. -.PP -See also pressed(), clicked(), and toggled(). -.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" -Sets the accelerator associated with the button. See the "accel" property for details. -.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" -Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. -.SH "void QRadioButton::setChecked ( bool check )\fC [virtual slot]\fR" -Sets whether the radio button is checked to \fIcheck\fR. See the "checked" property for details. -.SH "void QButton::setDown ( bool )\fC [virtual]\fR" -Sets whether the button is pressed. See the "down" property for details. -.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" -Sets the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" -Sets the text shown on the button. See the "text" property for details. -.SH "ToggleState QButton::state () const" -Returns the state of the toggle button. See the "toggleState" property for details. -.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. -.PP -See also clicked() and QButton::ToggleState. -.SH "QString QButton::text () const" -Returns the text shown on the button. See the "text" property for details. -.SH "void QButton::toggle ()\fC [slot]\fR" -Toggles the state of a toggle button. -.PP -See also on, setOn(), toggled(), and toggleButton. -.SH "void QButton::toggled ( bool on )\fC [signal]\fR" -This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. -.PP -This may be the result of a user action, toggle() slot activation, or because setOn() was called. -.PP -See also clicked(). -.PP -Example: listbox/listbox.cpp. -.SS "Property Documentation" -.SH "QKeySequence accel" -This property holds the accelerator associated with the button. -.PP -This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. -.PP -Set this property's value with setAccel() and get this property's value with accel(). -.SH "bool autoMask" -This property holds whether the radio button is automatically masked. -.PP -See also QWidget::autoMask. -.SH "bool autoRepeat" -This property holds whether autoRepeat is enabled. -.PP -If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. -.PP -Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). -.SH "bool checked" -This property holds whether the radio button is checked. -.PP -This property will not effect any other radio buttons unless they have been placed in the same QButtonGroup. The default value is FALSE (unchecked). -.PP -Set this property's value with setChecked() and get this property's value with isChecked(). -.SH "QPixmap pixmap" -This property holds the pixmap shown on the button. -.PP -If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. -.PP -pixmap() returns 0 if no pixmap was set. -.PP -Set this property's value with setPixmap() and get this property's value with pixmap(). -.SH "QString text" -This property holds the text shown on the button. -.PP -This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. -.PP -There is no default text. -.PP -Set this property's value with setText() and get this property's value with text(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqradiobutton.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qradiobutton.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qrangecontrol.3qt b/doc/man/man3/qrangecontrol.3qt deleted file mode 100644 index 62f7acf6a..000000000 --- a/doc/man/man3/qrangecontrol.3qt +++ /dev/null @@ -1,294 +0,0 @@ -'\" t -.TH QRangeControl 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 -QRangeControl \- Integer value within a range -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QDial, QScrollBar, QSlider, and QSpinBox. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQRangeControl\fR ()" -.br -.ti -1c -.BI "\fBQRangeControl\fR ( int minValue, int maxValue, int lineStep, int pageStep, int value )" -.br -.ti -1c -.BI "virtual \fB~QRangeControl\fR ()" -.br -.ti -1c -.BI "int \fBvalue\fR () const" -.br -.ti -1c -.BI "void \fBsetValue\fR ( int value )" -.br -.ti -1c -.BI "void \fBaddPage\fR ()" -.br -.ti -1c -.BI "void \fBsubtractPage\fR ()" -.br -.ti -1c -.BI "void \fBaddLine\fR ()" -.br -.ti -1c -.BI "void \fBsubtractLine\fR ()" -.br -.ti -1c -.BI "int \fBminValue\fR () const" -.br -.ti -1c -.BI "int \fBmaxValue\fR () const" -.br -.ti -1c -.BI "void \fBsetRange\fR ( int minValue, int maxValue )" -.br -.ti -1c -.BI "void \fBsetMinValue\fR ( int minVal )" -.br -.ti -1c -.BI "void \fBsetMaxValue\fR ( int maxVal )" -.br -.ti -1c -.BI "int \fBlineStep\fR () const" -.br -.ti -1c -.BI "int \fBpageStep\fR () const" -.br -.ti -1c -.BI "void \fBsetSteps\fR ( int lineStep, int pageStep )" -.br -.ti -1c -.BI "int \fBbound\fR ( int v ) const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "int \fBpositionFromValue\fR ( int logical_val, int span ) const" -.br -.ti -1c -.BI "int \fBvalueFromPosition\fR ( int pos, int span ) const" -.br -.ti -1c -.BI "void \fBdirectSetValue\fR ( int value )" -.br -.ti -1c -.BI "int \fBprevValue\fR () const" -.br -.ti -1c -.BI "virtual void \fBvalueChange\fR ()" -.br -.ti -1c -.BI "virtual void \fBrangeChange\fR ()" -.br -.ti -1c -.BI "virtual void \fBstepChange\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QRangeControl class provides an integer value within a range. -.PP -Although originally designed for the QScrollBar widget, the QRangeControl can also be used in conjunction with other widgets such as QSlider and QSpinBox. Here are the five main concepts in the class: -.PP -
                                            -.IP 1 -\fICurrent value\fR The bounded integer that QRangeControl maintains. value() returns it, and several functions, including setValue(), set it. -.IP 2 -\fIMinimum\fR The lowest value that value() can ever return. Returned by minValue() and set by setRange() or one of the constructors. -.IP 3 -\fIMaximum\fR The highest value that value() can ever return. Returned by maxValue() and set by setRange() or one of the constructors. -.IP 4 -\fILine step\fR The smaller of two natural steps that QRangeControl provides and typically corresponds to the user pressing an arrow key. The line step is returned by lineStep() and set using setSteps(). The functions addLine() and subtractLine() respectively increment and decrement the current value by lineStep(). -.IP 5 -\fIPage step\fR The larger of two natural steps that QRangeControl provides and typically corresponds to the user pressing PageUp or PageDown. The page step is returned by pageStep() and set using setSteps(). The functions addPage() and substractPage() respectively increment and decrement the current value by pageStep(). -.IP -.PP -Unity (1) may be viewed as a third step size. setValue() lets you set the current value to any integer in the allowed range, not just minValue() + \fIn\fR * lineStep() for integer values of \fIn\fR. Some widgets may allow the user to set any value at all; others may just provide multiples of lineStep() or pageStep(). -.PP -QRangeControl provides three virtual functions that are well suited for updating the on-screen representation of range controls and emitting signals: valueChange(), rangeChange() and stepChange(). -.PP -QRangeControl also provides a function called bound() which lets you force arbitrary integers to be within the allowed range of the range control. -.PP -We recommend that all widgets that inherit QRangeControl provide at least a signal called valueChanged(); many widgets will want to provide addStep(), addPage(), substractStep() and substractPage() as slots. -.PP -Note that you must use multiple inheritance if you plan to implement a widget using QRangeControl because QRangeControl is not derived from QWidget. -.PP -See also Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QRangeControl::QRangeControl ()" -Constructs a range control with a minimum value of 0, maximum value of 99, line step of 1, page step of 10 and initial value 0. -.SH "QRangeControl::QRangeControl ( int minValue, int maxValue, int lineStep, int pageStep, int value )" -Constructs a range control whose value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR, whose line step size is \fIlineStep\fR and page step size is \fIpageStep\fR and whose value is initially \fIvalue\fR (which is guaranteed to be in range using bound()). -.SH "QRangeControl::~QRangeControl ()\fC [virtual]\fR" -Destroys the range control -.SH "void QRangeControl::addLine ()" -Equivalent to \fCsetValue( value() + lineStep() )\fR. -.PP -If the value is changed, then valueChange() is called. -.PP -See also subtractLine(), addPage(), and setValue(). -.SH "void QRangeControl::addPage ()" -Equivalent to \fCsetValue( value() + pageStep() )\fR. -.PP -If the value is changed, then valueChange() is called. -.PP -See also subtractPage(), addLine(), and setValue(). -.SH "int QRangeControl::bound ( int v ) const" -Forces the value \fIv\fR to be within the range from minValue() to maxValue() inclusive, and returns the result. -.PP -This function is provided so that you can easily force other numbers than value() into the allowed range. You do not need to call it in order to use QRangeControl itself. -.PP -See also setValue(), value(), minValue(), and maxValue(). -.SH "void QRangeControl::directSetValue ( int value )\fC [protected]\fR" -Sets the range control \fIvalue\fR directly without calling valueChange(). -.PP -Forces the new \fIvalue\fR to be within the legal range. -.PP -You will rarely have to call this function. However, if you want to change the range control's value inside the overloaded method valueChange(), setValue() would call the function valueChange() again. To avoid this recursion you must use directSetValue() instead. -.PP -See also setValue(). -.SH "int QRangeControl::lineStep () const" -Returns the line step. -.PP -See also setSteps() and pageStep(). -.SH "int QRangeControl::maxValue () const" -Returns the maximum value of the range. -.PP -See also setMaxValue(), setRange(), and minValue(). -.SH "int QRangeControl::minValue () const" -Returns the minimum value of the range. -.PP -See also setMinValue(), setRange(), and maxValue(). -.SH "int QRangeControl::pageStep () const" -Returns the page step. -.PP -See also setSteps() and lineStep(). -.SH "int QRangeControl::positionFromValue ( int logical_val, int span ) const\fC [protected]\fR" -Converts \fIlogical_val\fR to a pixel position. minValue() maps to 0, maxValue() maps to \fIspan\fR and other values are distributed evenly in-between. -.PP -This function can handle the entire integer range without overflow, providing \fIspan\fR is <= 4096. -.PP -Calling this method is useful when actually drawing a range control such as a QScrollBar on-screen. -.PP -See also valueFromPosition(). -.SH "int QRangeControl::prevValue () const\fC [protected]\fR" -Returns the previous value of the range control. "Previous value" means the value before the last change occurred. Setting a new range may affect the value, too, because the value is forced to be inside the specified range. When the range control is initially created, this is the same as value(). -.PP -prevValue() can be outside the current legal range if a call to setRange() causes the current value to change. For example, if the range was [0, 1000] and the current value is 500, setRange(0, 400) makes value() return 400 and prevValue() return 500. -.PP -See also value() and setRange(). -.SH "void QRangeControl::rangeChange ()\fC [virtual protected]\fR" -This virtual function is called whenever the range control's range changes. You can reimplement it if you want to be notified when the range changes. The default implementation does nothing. -.PP -Note that this method is called after the range has changed. -.PP -See also setRange(), valueChange(), and stepChange(). -.PP -Reimplemented in QDial, QSlider, and QSpinBox. -.SH "void QRangeControl::setMaxValue ( int maxVal )" -Sets the minimum value of the range to \fImaxVal\fR. -.PP -If necessary, the minValue() is adjusted so that the range remains valid. -.PP -See also maxValue() and setMinValue(). -.SH "void QRangeControl::setMinValue ( int minVal )" -Sets the minimum value of the range to \fIminVal\fR. -.PP -If necessary, the maxValue() is adjusted so that the range remains valid. -.PP -See also minValue() and setMaxValue(). -.SH "void QRangeControl::setRange ( int minValue, int maxValue )" -Sets the range control's minimum value to \fIminValue\fR and its maximum value to \fImaxValue\fR. -.PP -Calls the virtual rangeChange() function if one or both of the new minimum and maximum values are different from the previous setting. Calls the virtual valueChange() function if the current value is adjusted because it was outside the new range. -.PP -If \fImaxValue\fR is smaller than \fIminValue\fR, \fIminValue\fR becomes the only legal value. -.PP -See also minValue() and maxValue(). -.PP -Examples: -.)l listbox/listbox.cpp, t12/lcdrange.cpp, t5/main.cpp, t6/main.cpp, t8/lcdrange.cpp, and xform/xform.cpp. -.SH "void QRangeControl::setSteps ( int lineStep, int pageStep )" -Sets the range's line step to \fIlineStep\fR and page step to \fIpageStep\fR. -.PP -Calls the virtual stepChange() function if the new line step or page step are different from the previous settings. -.PP -See also lineStep(), pageStep(), and setRange(). -.SH "void QRangeControl::setValue ( int value )" -Sets the range control's value to \fIvalue\fR and forces it to be within the legal range. -.PP -Calls the virtual valueChange() function if the new value is different from the previous value. The old value can still be retrieved using prevValue(). -.PP -See also value(). -.SH "void QRangeControl::stepChange ()\fC [virtual protected]\fR" -This virtual function is called whenever the range control's line or page step settings change. You can reimplement it if you want to be notified when the step changes. The default implementation does nothing. -.PP -Note that this method is called after a step setting has changed. -.PP -See also setSteps(), rangeChange(), and valueChange(). -.SH "void QRangeControl::subtractLine ()" -Equivalent to \fCsetValue( value() - lineStep() )\fR. -.PP -If the value is changed, then valueChange() is called. -.PP -See also addLine(), subtractPage(), and setValue(). -.SH "void QRangeControl::subtractPage ()" -Equivalent to \fCsetValue( value() - pageStep() )\fR. -.PP -If the value is changed, then valueChange() is called. -.PP -See also addPage(), subtractLine(), and setValue(). -.SH "int QRangeControl::value () const" -Returns the current range control value. This is guaranteed to be within the range [minValue(), maxValue()]. -.PP -See also setValue() and prevValue(). -.SH "void QRangeControl::valueChange ()\fC [virtual protected]\fR" -This virtual function is called whenever the range control value changes. You can reimplement it if you want to be notified when the value changes. The default implementation does nothing. -.PP -Note that this method is called after the value has changed. The previous value can be retrieved using prevValue(). -.PP -See also setValue(), addPage(), subtractPage(), addLine(), subtractLine(), rangeChange(), and stepChange(). -.PP -Reimplemented in QDial, QSlider, and QSpinBox. -.SH "int QRangeControl::valueFromPosition ( int pos, int span ) const\fC [protected]\fR" -Converts the pixel position \fIpos\fR to a value. 0 maps to minValue(), \fIspan\fR maps to maxValue() and other values are distributed evenly in-between. -.PP -This function can handle the entire integer range without overflow. -.PP -Calling this method is useful if you actually implemented a range control widget such as QScrollBar and want to handle mouse press events. This function then maps screen coordinates to the logical values. -.PP -See also positionFromValue(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqrangecontrol.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qrangecontrol.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qrect.3qt b/doc/man/man3/qrect.3qt deleted file mode 100644 index 6dfe4b92a..000000000 --- a/doc/man/man3/qrect.3qt +++ /dev/null @@ -1,662 +0,0 @@ -'\" t -.TH QRect 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 -QRect \- Defines a rectangle in the plane -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQRect\fR ()" -.br -.ti -1c -.BI "\fBQRect\fR ( const QPoint & topLeft, const QPoint & bottomRight )" -.br -.ti -1c -.BI "\fBQRect\fR ( const QPoint & topLeft, const QSize & size )" -.br -.ti -1c -.BI "\fBQRect\fR ( int left, int top, int width, int height )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "QRect \fBnormalize\fR () const" -.br -.ti -1c -.BI "int \fBleft\fR () const" -.br -.ti -1c -.BI "int \fBtop\fR () const" -.br -.ti -1c -.BI "int \fBright\fR () const" -.br -.ti -1c -.BI "int \fBbottom\fR () const" -.br -.ti -1c -.BI "QCOORD & \fBrLeft\fR ()" -.br -.ti -1c -.BI "QCOORD & \fBrTop\fR ()" -.br -.ti -1c -.BI "QCOORD & \fBrRight\fR ()" -.br -.ti -1c -.BI "QCOORD & \fBrBottom\fR ()" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "void \fBsetLeft\fR ( int pos )" -.br -.ti -1c -.BI "void \fBsetTop\fR ( int pos )" -.br -.ti -1c -.BI "void \fBsetRight\fR ( int pos )" -.br -.ti -1c -.BI "void \fBsetBottom\fR ( int pos )" -.br -.ti -1c -.BI "void \fBsetX\fR ( int x )" -.br -.ti -1c -.BI "void \fBsetY\fR ( int y )" -.br -.ti -1c -.BI "void \fBsetTopLeft\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBsetBottomRight\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBsetTopRight\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBsetBottomLeft\fR ( const QPoint & p )" -.br -.ti -1c -.BI "QPoint \fBtopLeft\fR () const" -.br -.ti -1c -.BI "QPoint \fBbottomRight\fR () const" -.br -.ti -1c -.BI "QPoint \fBtopRight\fR () const" -.br -.ti -1c -.BI "QPoint \fBbottomLeft\fR () const" -.br -.ti -1c -.BI "QPoint \fBcenter\fR () const" -.br -.ti -1c -.BI "void \fBrect\fR ( int * x, int * y, int * w, int * h ) const" -.br -.ti -1c -.BI "void \fBcoords\fR ( int * xp1, int * yp1, int * xp2, int * yp2 ) const" -.br -.ti -1c -.BI "void \fBmoveLeft\fR ( int pos )" -.br -.ti -1c -.BI "void \fBmoveTop\fR ( int pos )" -.br -.ti -1c -.BI "void \fBmoveRight\fR ( int pos )" -.br -.ti -1c -.BI "void \fBmoveBottom\fR ( int pos )" -.br -.ti -1c -.BI "void \fBmoveTopLeft\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBmoveBottomRight\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBmoveTopRight\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBmoveBottomLeft\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBmoveCenter\fR ( const QPoint & p )" -.br -.ti -1c -.BI "void \fBmoveBy\fR ( int dx, int dy )" -.br -.ti -1c -.BI "void \fBsetRect\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBsetCoords\fR ( int xp1, int yp1, int xp2, int yp2 )" -.br -.ti -1c -.BI "void \fBaddCoords\fR ( int xp1, int yp1, int xp2, int yp2 )" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "void \fBsetWidth\fR ( int w )" -.br -.ti -1c -.BI "void \fBsetHeight\fR ( int h )" -.br -.ti -1c -.BI "void \fBsetSize\fR ( const QSize & s )" -.br -.ti -1c -.BI "QRect \fBoperator|\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "QRect \fBoperator&\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "QRect & \fBoperator|=\fR ( const QRect & r )" -.br -.ti -1c -.BI "QRect & \fBoperator&=\fR ( const QRect & r )" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QPoint & p, bool proper = FALSE ) const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( int x, int y ) const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( int x, int y, bool proper ) const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QRect & r, bool proper = FALSE ) const" -.br -.ti -1c -.BI "QRect \fBunite\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "QRect \fBintersect\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "bool \fBintersects\fR ( const QRect & r ) const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "bool \fBoperator==\fR ( const QRect & r1, const QRect & r2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QRect & r1, const QRect & r2 )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QRect & r )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QRect & r )" -.br -.in -1c -.SH DESCRIPTION -The QRect class defines a rectangle in the plane. -.PP -A rectangle is internally represented as an upper-left corner and a bottom-right corner, but it is normally expressed as an upper-left corner and a size. -.PP -The coordinate type is QCOORD (defined in ntqwindowdefs.h as \fCint\fR). The minimum value of QCOORD is QCOORD_MIN (-2147483648) and the maximum value is QCOORD_MAX (2147483647). -.PP -Note that the size (width and height) of a rectangle might be different from what you are used to. If the top-left corner and the bottom-right corner are the same, the height and the width of the rectangle will both be 1. -.PP -Generally, \fIwidth = right - left + 1\fR and \fIheight = bottom - top + 1\fR. We designed it this way to make it correspond to rectangular spaces used by drawing functions in which the width and height denote a number of pixels. For example, drawing a rectangle with width and height 1 draws a single pixel. -.PP -The default coordinate system has origin (0, 0) in the top-left corner. The positive direction of the y axis is down, and the positive x axis is from left to right. -.PP -A QRect can be constructed with a set of left, top, width and height integers, from two QPoints or from a QPoint and a QSize. After creation the dimensions can be changed, e.g. with setLeft(), setRight(), setTop() and setBottom(), or by setting sizes, e.g. setWidth(), setHeight() and setSize(). The dimensions can also be changed with the move functions, e.g. moveBy(), moveCenter(), moveBottomRight(), etc. You can also add coordinates to a rectangle with addCoords(). -.PP -You can test to see if a QRect contains a specific point with contains(). You can also test to see if two QRects intersect with intersects() (see also intersect()). To get the bounding rectangle of two QRects use unite(). -.PP -See also QPoint, QSize, Graphics Classes, and Image Processing Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QRect::QRect ()" -Constructs an invalid rectangle. -.SH "QRect::QRect ( const QPoint & topLeft, const QPoint & bottomRight )" -Constructs a rectangle with \fItopLeft\fR as the top-left corner and \fIbottomRight\fR as the bottom-right corner. -.SH "QRect::QRect ( const QPoint & topLeft, const QSize & size )" -Constructs a rectangle with \fItopLeft\fR as the top-left corner and \fIsize\fR as the rectangle size. -.SH "QRect::QRect ( int left, int top, int width, int height )" -Constructs a rectangle with the \fItop\fR, \fIleft\fR corner and \fIwidth\fR and \fIheight\fR. -.PP -Example (creates three identical rectangles): -.PP -.nf -.br - QRect r1( QPoint(100,200), QPoint(110,215) ); -.br - QRect r2( QPoint(100,200), QSize(11,16) ); -.br - QRect r3( 100, 200, 11, 16 ); -.br -.fi -.SH "void QRect::addCoords ( int xp1, int yp1, int xp2, int yp2 )" -Adds \fIxp1\fR, \fIyp1\fR, \fIxp2\fR and \fIyp2\fR respectively to the existing coordinates of the rectangle. -.PP -Examples: -.)l multiple/ax1.h and multiple/ax2.h. -.SH "int QRect::bottom () const" -Returns the bottom coordinate of the rectangle. -.PP -See also setBottom(), top(), bottomLeft(), and bottomRight(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, desktop/desktop.cpp, helpviewer/helpwindow.cpp, qfd/fontdisplayer.cpp, scribble/scribble.cpp, and themes/wood.cpp. -.SH "QPoint QRect::bottomLeft () const" -Returns the bottom-left position of the rectangle. -.PP -See also setBottomLeft(), moveBottomLeft(), topRight(), bottom(), and left(). -.PP -Example: tictac/tictac.cpp. -.SH "QPoint QRect::bottomRight () const" -Returns the bottom-right position of the rectangle. -.PP -See also setBottomRight(), moveBottomRight(), topLeft(), right(), and bottom(). -.PP -Example: tictac/tictac.cpp. -.SH "QPoint QRect::center () const" -Returns the center point of the rectangle. -.PP -See also moveCenter(), topLeft(), bottomRight(), topRight(), and bottomLeft(). -.PP -Example: tooltip/tooltip.cpp. -.SH "bool QRect::contains ( const QPoint & p, bool proper = FALSE ) const" -Returns TRUE if the point \fIp\fR is inside or on the edge of the rectangle; otherwise returns FALSE. -.PP -If \fIproper\fR is TRUE, this function returns TRUE only if \fIp\fR is inside (not on the edge). -.PP -Example: t14/cannon.cpp. -.SH "bool QRect::contains ( int x, int y ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the point \fIx\fR, \fIy\fR is inside this rectangle; otherwise returns FALSE. -.SH "bool QRect::contains ( int x, int y, bool proper ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the point \fIx\fR, \fIy\fR is inside this rectangle; otherwise returns FALSE. -.PP -If \fIproper\fR is TRUE, this function returns TRUE only if the point is entirely inside (not on the edge). -.SH "bool QRect::contains ( const QRect & r, bool proper = FALSE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the rectangle \fIr\fR is inside this rectangle; otherwise returns FALSE. -.PP -If \fIproper\fR is TRUE, this function returns TRUE only if \fIr\fR is entirely inside (not on the edge). -.PP -See also unite(), intersect(), and intersects(). -.SH "void QRect::coords ( int * xp1, int * yp1, int * xp2, int * yp2 ) const" -Extracts the rectangle parameters as the top-left point \fI*xp1\fR, \fI*yp1\fR and the bottom-right point \fI*xp2\fR, \fI*yp2\fR. -.PP -See also setCoords() and rect(). -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "int QRect::height () const" -Returns the height of the rectangle. The height includes both the top and bottom edges, i.e. height = bottom - top + 1. -.PP -See also width(), size(), and setHeight(). -.PP -Examples: -.)l aclock/aclock.cpp, desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, themes/metal.cpp, themes/wood.cpp, and xform/xform.cpp. -.SH "QRect QRect::intersect ( const QRect & r ) const" -Returns the intersection of this rectangle and rectangle \fIr\fR. \fCr.intersect(s)\fR is equivalent to \fCr&s\fR. -.SH "bool QRect::intersects ( const QRect & r ) const" -Returns TRUE if this rectangle intersects with rectangle \fIr\fR (there is at least one pixel that is within both rectangles); otherwise returns FALSE. -.PP -See also intersect() and contains(). -.PP -Examples: -.)l t11/cannon.cpp, t12/cannon.cpp, t13/cannon.cpp, and t14/cannon.cpp. -.SH "bool QRect::isEmpty () const" -Returns TRUE if the rectangle is empty; otherwise returns FALSE. -.PP -An empty rectangle has a left() > right() or top() > bottom(). -.PP -An empty rectangle is not valid. \fCisEmpty() == !isValid()\fR -.PP -See also isNull(), isValid(), and normalize(). -.SH "bool QRect::isNull () const" -Returns TRUE if the rectangle is a null rectangle; otherwise returns FALSE. -.PP -A null rectangle has both the width and the height set to 0, that is right() == left() - 1 and bottom() == top() - 1. -.PP -Note that if right() == left() and bottom() == top(), then the rectangle has width 1 and height 1. -.PP -A null rectangle is also empty. -.PP -A null rectangle is not valid. -.PP -See also isEmpty() and isValid(). -.SH "bool QRect::isValid () const" -Returns TRUE if the rectangle is valid; otherwise returns FALSE. -.PP -A valid rectangle has a left() <= right() and top() <= bottom(). -.PP -Note that non-trivial operations like intersections are not defined for invalid rectangles. -.PP -\fCisValid() == !isEmpty()\fR -.PP -See also isNull(), isEmpty(), and normalize(). -.PP -Examples: -.)l themes/metal.cpp and tooltip/tooltip.cpp. -.SH "int QRect::left () const" -Returns the left coordinate of the rectangle. Identical to x(). -.PP -See also setLeft(), right(), topLeft(), and bottomLeft(). -.PP -Examples: -.)l aclock/aclock.cpp, desktop/desktop.cpp, i18n/main.cpp, scribble/scribble.cpp, tictac/tictac.cpp, and xform/xform.cpp. -.SH "void QRect::moveBottom ( int pos )" -Sets the bottom position of the rectangle to \fIpos\fR, leaving the size unchanged. -.PP -See also bottom(), setBottom(), moveLeft(), moveTop(), and moveRight(). -.SH "void QRect::moveBottomLeft ( const QPoint & p )" -Sets the bottom-left position of the rectangle to \fIp\fR, leaving the size unchanged. -.PP -See also bottomLeft(), setBottomLeft(), moveTopLeft(), moveBottomRight(), and moveTopRight(). -.PP -Example: t10/cannon.cpp. -.SH "void QRect::moveBottomRight ( const QPoint & p )" -Sets the bottom-right position of the rectangle to \fIp\fR, leaving the size unchanged. -.PP -See also bottomRight(), setBottomRight(), moveTopLeft(), moveTopRight(), and moveBottomLeft(). -.SH "void QRect::moveBy ( int dx, int dy )" -Moves the rectangle \fIdx\fR along the x axis and \fIdy\fR along the y axis, relative to the current position. Positive values move the rectangle to the right and down. -.PP -See also moveTopLeft(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, themes/wood.cpp, and xform/xform.cpp. -.SH "void QRect::moveCenter ( const QPoint & p )" -Sets the center point of the rectangle to \fIp\fR, leaving the size unchanged. -.PP -See also center(), moveTopLeft(), moveBottomRight(), moveTopRight(), and moveBottomLeft(). -.PP -Examples: -.)l t11/cannon.cpp and t12/cannon.cpp. -.SH "void QRect::moveLeft ( int pos )" -Sets the left position of the rectangle to \fIpos\fR, leaving the size unchanged. -.PP -See also left(), setLeft(), moveTop(), moveRight(), and moveBottom(). -.SH "void QRect::moveRight ( int pos )" -Sets the right position of the rectangle to \fIpos\fR, leaving the size unchanged. -.PP -See also right(), setRight(), moveLeft(), moveTop(), and moveBottom(). -.SH "void QRect::moveTop ( int pos )" -Sets the top position of the rectangle to \fIpos\fR, leaving the size unchanged. -.PP -See also top(), setTop(), moveLeft(), moveRight(), and moveBottom(). -.SH "void QRect::moveTopLeft ( const QPoint & p )" -Sets the top-left position of the rectangle to \fIp\fR, leaving the size unchanged. -.PP -See also topLeft(), setTopLeft(), moveBottomRight(), moveTopRight(), and moveBottomLeft(). -.PP -Examples: -.)l helpsystem/tooltip.cpp and xform/xform.cpp. -.SH "void QRect::moveTopRight ( const QPoint & p )" -Sets the top-right position of the rectangle to \fIp\fR, leaving the size unchanged. -.PP -See also topRight(), setTopRight(), moveTopLeft(), moveBottomRight(), and moveBottomLeft(). -.SH "QRect QRect::normalize () const" -Returns a normalized rectangle, i.e. a rectangle that has a non-negative width and height. -.PP -It swaps left and right if left() > right(), and swaps top and bottom if top() > bottom(). -.PP -See also isValid(). -.PP -Example: scribble/scribble.cpp. -.SH "QRect QRect::operator& ( const QRect & r ) const" -Returns the intersection of this rectangle and rectangle \fIr\fR. -.PP -Returns an empty rectangle if there is no intersection. -.PP -See also operator&=(), operator|(), isEmpty(), intersects(), and contains(). -.SH "QRect & QRect::operator&= ( const QRect & r )" -Intersects this rectangle with rectangle \fIr\fR. -.SH "QRect QRect::operator| ( const QRect & r ) const" -Returns the bounding rectangle of this rectangle and rectangle \fIr\fR. -.PP -The bounding rectangle of a nonempty rectangle and an empty or invalid rectangle is defined to be the nonempty rectangle. -.PP -See also operator|=(), operator&(), intersects(), and contains(). -.SH "QRect & QRect::operator|= ( const QRect & r )" -Unites this rectangle with rectangle \fIr\fR. -.SH "QCOORD & QRect::rBottom ()" -Returns a reference to the bottom coordinate of the rectangle. -.PP -See also rLeft(), rTop(), and rRight(). -.SH "QCOORD & QRect::rLeft ()" -Returns a reference to the left coordinate of the rectangle. -.PP -See also rTop(), rRight(), and rBottom(). -.SH "QCOORD & QRect::rRight ()" -Returns a reference to the right coordinate of the rectangle. -.PP -See also rLeft(), rTop(), and rBottom(). -.SH "QCOORD & QRect::rTop ()" -Returns a reference to the top coordinate of the rectangle. -.PP -See also rLeft(), rRight(), and rBottom(). -.SH "void QRect::rect ( int * x, int * y, int * w, int * h ) const" -Extracts the rectangle parameters as the position \fI*x\fR, \fI*y\fR and width \fI*w\fR and height \fI*h\fR. -.PP -See also setRect() and coords(). -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "int QRect::right () const" -Returns the right coordinate of the rectangle. -.PP -See also setRight(), left(), topRight(), and bottomRight(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, customlayout/flow.cpp, desktop/desktop.cpp, scribble/scribble.cpp, t11/cannon.cpp, and themes/wood.cpp. -.SH "void QRect::setBottom ( int pos )" -Sets the bottom edge of the rectangle to \fIpos\fR. May change the height, but will never change the top edge of the rectangle. -.PP -See also bottom(), setTop(), and setHeight(). -.PP -Example: scribble/scribble.cpp. -.SH "void QRect::setBottomLeft ( const QPoint & p )" -Set the bottom-left corner of the rectangle to \fIp\fR. May change the size, but will the never change the top-right corner of the rectangle. -.PP -See also bottomLeft(), moveBottomLeft(), setTopLeft(), setBottomRight(), and setTopRight(). -.SH "void QRect::setBottomRight ( const QPoint & p )" -Set the bottom-right corner of the rectangle to \fIp\fR. May change the size, but will the never change the top-left corner of the rectangle. -.PP -See also bottomRight(), moveBottomRight(), setTopLeft(), setTopRight(), and setBottomLeft(). -.SH "void QRect::setCoords ( int xp1, int yp1, int xp2, int yp2 )" -Sets the coordinates of the rectangle's top-left corner to \fI(xp1, yp1)\fR, and the coordinates of its bottom-right corner to \fI(xp2, yp2)\fR. -.PP -See also coords() and setRect(). -.SH "void QRect::setHeight ( int h )" -Sets the height of the rectangle to \fIh\fR. The top edge is not moved, but the bottom edge may be moved. -.PP -See also height(), setTop(), setBottom(), and setSize(). -.PP -Example: desktop/desktop.cpp. -.SH "void QRect::setLeft ( int pos )" -Sets the left edge of the rectangle to \fIpos\fR. May change the width, but will never change the right edge of the rectangle. -.PP -Identical to setX(). -.PP -See also left(), setTop(), and setWidth(). -.PP -Example: scribble/scribble.cpp. -.SH "void QRect::setRect ( int x, int y, int w, int h )" -Sets the coordinates of the rectangle's top-left corner to \fI(x, y)\fR, and its size to \fI(w, h)\fR. -.PP -See also rect() and setCoords(). -.PP -Example: themes/wood.cpp. -.SH "void QRect::setRight ( int pos )" -Sets the right edge of the rectangle to \fIpos\fR. May change the width, but will never change the left edge of the rectangle. -.PP -See also right(), setLeft(), and setWidth(). -.PP -Example: scribble/scribble.cpp. -.SH "void QRect::setSize ( const QSize & s )" -Sets the size of the rectangle to \fIs\fR. The top-left corner is not moved. -.PP -See also size(), setWidth(), and setHeight(). -.PP -Example: xform/xform.cpp. -.SH "void QRect::setTop ( int pos )" -Sets the top edge of the rectangle to \fIpos\fR. May change the height, but will never change the bottom edge of the rectangle. -.PP -Identical to setY(). -.PP -See also top(), setBottom(), and setHeight(). -.PP -Example: scribble/scribble.cpp. -.SH "void QRect::setTopLeft ( const QPoint & p )" -Set the top-left corner of the rectangle to \fIp\fR. May change the size, but will the never change the bottom-right corner of the rectangle. -.PP -See also topLeft(), moveTopLeft(), setBottomRight(), setTopRight(), and setBottomLeft(). -.SH "void QRect::setTopRight ( const QPoint & p )" -Set the top-right corner of the rectangle to \fIp\fR. May change the size, but will the never change the bottom-left corner of the rectangle. -.PP -See also topRight(), moveTopRight(), setTopLeft(), setBottomRight(), and setBottomLeft(). -.SH "void QRect::setWidth ( int w )" -Sets the width of the rectangle to \fIw\fR. The right edge is changed, but not the left edge. -.PP -See also width(), setLeft(), setRight(), and setSize(). -.PP -Example: desktop/desktop.cpp. -.SH "void QRect::setX ( int x )" -Sets the x position of the rectangle (its left end) to \fIx\fR. May change the width, but will never change the right edge of the rectangle. -.PP -Identical to setLeft(). -.PP -See also x() and setY(). -.SH "void QRect::setY ( int y )" -Sets the y position of the rectangle (its top) to \fIy\fR. May change the height, but will never change the bottom edge of the rectangle. -.PP -Identical to setTop(). -.PP -See also y() and setX(). -.SH "QSize QRect::size () const" -Returns the size of the rectangle. -.PP -See also width() and height(). -.PP -Examples: -.)l desktop/desktop.cpp, movies/main.cpp, and t10/cannon.cpp. -.SH "int QRect::top () const" -Returns the top coordinate of the rectangle. Identical to y(). -.PP -See also setTop(), bottom(), topLeft(), and topRight(). -.PP -Examples: -.)l aclock/aclock.cpp, desktop/desktop.cpp, scribble/scribble.cpp, themes/wood.cpp, tictac/tictac.cpp, and xform/xform.cpp. -.SH "QPoint QRect::topLeft () const" -Returns the top-left position of the rectangle. -.PP -See also setTopLeft(), moveTopLeft(), bottomRight(), left(), and top(). -.PP -Examples: -.)l helpsystem/tooltip.cpp, t10/cannon.cpp, and tictac/tictac.cpp. -.SH "QPoint QRect::topRight () const" -Returns the top-right position of the rectangle. -.PP -See also setTopRight(), moveTopRight(), bottomLeft(), top(), and right(). -.PP -Example: tictac/tictac.cpp. -.SH "QRect QRect::unite ( const QRect & r ) const" -Returns the bounding rectangle of this rectangle and rectangle \fIr\fR. \fCr.unite(s)\fR is equivalent to \fCr|s\fR. -.PP -Examples: -.)l t11/cannon.cpp, t12/cannon.cpp, and xform/xform.cpp. -.SH "int QRect::width () const" -Returns the width of the rectangle. The width includes both the left and right edges, i.e. width = right - left + 1. -.PP -See also height(), size(), and setHeight(). -.PP -Examples: -.)l aclock/aclock.cpp, customlayout/border.cpp, desktop/desktop.cpp, movies/main.cpp, themes/metal.cpp, themes/wood.cpp, and xform/xform.cpp. -.SH "int QRect::x () const" -Returns the left coordinate of the rectangle. Identical to left(). -.PP -See also left(), y(), and setX(). -.PP -Examples: -.)l customlayout/border.cpp, desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, t12/cannon.cpp, themes/metal.cpp, and themes/wood.cpp. -.SH "int QRect::y () const" -Returns the top coordinate of the rectangle. Identical to top(). -.PP -See also top(), x(), and setY(). -.PP -Examples: -.)l desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, t12/cannon.cpp, t14/cannon.cpp, themes/metal.cpp, and themes/wood.cpp. -.SH RELATED FUNCTION DOCUMENTATION -.SH "bool operator!= ( const QRect & r1, const QRect & r2 )" -Returns TRUE if \fIr1\fR and \fIr2\fR are different; otherwise returns FALSE. -.SH "QDataStream & operator<< ( QDataStream & s, const QRect & r )" -Writes the QRect, \fIr\fR, to the stream \fIs\fR, and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "bool operator== ( const QRect & r1, const QRect & r2 )" -Returns TRUE if \fIr1\fR and \fIr2\fR are equal; otherwise returns FALSE. -.SH "QDataStream & operator>> ( QDataStream & s, QRect & r )" -Reads a QRect from the stream \fIs\fR into rect \fIr\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqrect.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qrect.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qregexp.3qt b/doc/man/man3/qregexp.3qt deleted file mode 100644 index a03ad3af5..000000000 --- a/doc/man/man3/qregexp.3qt +++ /dev/null @@ -1,855 +0,0 @@ -'\" t -.TH QRegExp 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 -QRegExp \- Pattern matching using regular expressions -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                            -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBCaretMode\fR { CaretAtZero, CaretAtOffset, CaretWontMatch }" -.br -.ti -1c -.BI "\fBQRegExp\fR ()" -.br -.ti -1c -.BI "\fBQRegExp\fR ( const QString & pattern, bool caseSensitive = TRUE, bool wildcard = FALSE )" -.br -.ti -1c -.BI "\fBQRegExp\fR ( const QRegExp & rx )" -.br -.ti -1c -.BI "\fB~QRegExp\fR ()" -.br -.ti -1c -.BI "QRegExp & \fBoperator=\fR ( const QRegExp & rx )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QRegExp & rx ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QRegExp & rx ) const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "QString \fBpattern\fR () const" -.br -.ti -1c -.BI "void \fBsetPattern\fR ( const QString & pattern )" -.br -.ti -1c -.BI "bool \fBcaseSensitive\fR () const" -.br -.ti -1c -.BI "void \fBsetCaseSensitive\fR ( bool sensitive )" -.br -.ti -1c -.BI "bool \fBwildcard\fR () const" -.br -.ti -1c -.BI "void \fBsetWildcard\fR ( bool wildcard )" -.br -.ti -1c -.BI "bool \fBminimal\fR () const" -.br -.ti -1c -.BI "void \fBsetMinimal\fR ( bool minimal )" -.br -.ti -1c -.BI "bool \fBexactMatch\fR ( const QString & str ) const" -.br -.ti -1c -.BI "int match ( const QString & str, int index = 0, int * len = 0, bool indexIsStart = TRUE ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBsearch\fR ( const QString & str, int offset = 0, CaretMode caretMode = CaretAtZero ) const" -.br -.ti -1c -.BI "int \fBsearchRev\fR ( const QString & str, int offset = -1, CaretMode caretMode = CaretAtZero ) const" -.br -.ti -1c -.BI "int \fBmatchedLength\fR () const" -.br -.ti -1c -.BI "int \fBnumCaptures\fR () const" -.br -.ti -1c -.BI "QStringList \fBcapturedTexts\fR ()" -.br -.ti -1c -.BI "QString \fBcap\fR ( int nth = 0 )" -.br -.ti -1c -.BI "int \fBpos\fR ( int nth = 0 )" -.br -.ti -1c -.BI "QString \fBerrorString\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBescape\fR ( const QString & str )" -.br -.in -1c -.SH DESCRIPTION -The QRegExp class provides pattern matching using regular expressions. -.PP - -.PP -Regular expressions, or "regexps", provide a way to find patterns within text. This is useful in many contexts, for example: -.PP -
                                            .nf -.TS -l - l. Validation A regexp can be used to check whether a piece of text meets some criteria, e.g. is an integer or contains no whitespace. Searching Regexps provide a much more powerful means of searching text than simple string matching does. For example we can create a regexp which says "find one of the words 'mail', 'letter' or 'correspondence' but not any of the words 'email', 'mailman' 'mailer', 'letterbox' etc." Search and Replace A regexp can be used to replace a pattern with a piece of text, for example replace all occurrences of '&' with '&' except where the '&' is already followed by 'amp;'. String Splitting -.TE -.fi -
                                            -.PP -We present a very brief introduction to regexps, a description of Qt's regexp language, some code examples, and finally the function documentation itself. QRegExp is modeled on Perl's regexp language, and also fully supports Unicode. QRegExp can also be used in the weaker 'wildcard' (globbing) mode which works in a similar way to command shells. A good text on regexps is \fIMastering Regular Expressions: Powerful Techniques for Perl and Other Tools\fR by Jeffrey E. Friedl, ISBN 1565922573. -.PP -Experienced regexp users may prefer to skip the introduction and go directly to the relevant information. -.PP -In case of multi-threaded programming, note that QRegExp depends on QThreadStorage internally. For that reason, QRegExp should only be used with threads started with QThread, i.e. not with threads started with platform-specific APIs. -.PP - -.TP -Introduction -.TP -Characters and Abbreviations for Sets of Characters -.TP -Sets of Characters -.TP -Quantifiers -.TP -Capturing Text -.TP -Assertions -.TP -Wildcard Matching (globbing) -.TP -Notes for Perl Users -.TP - Code Examples - -.SH "Introduction" -Regexps are built up from expressions, quantifiers, and assertions. The simplest form of expression is simply a character, e.g. \fBx\fR or \fB5\fR. An expression can also be a set of characters. For example, \fB[ABCD]\fR, will match an \fBA\fR or a \fBB\fR or a \fBC\fR or a \fBD\fR. As a shorthand we could write this as \fB[A-D]\fR. If we want to match any of the captital letters in the English alphabet we can write \fB[A-Z]\fR. A quantifier tells the regexp engine how many occurrences of the expression we want, e.g. \fBx{1,1}\fR means match an \fBx\fR which occurs at least once and at most once. We'll look at assertions and more complex expressions later. -.PP -Note that in general regexps cannot be used to check for balanced brackets or tags. For example if you want to match an opening html \fC\fR and its closing \fC\fR you can only use a regexp if you know that these tags are not nested; the html fragment, \fCbold bolder\fR will not match as expected. If you know the maximum level of nesting it is possible to create a regexp that will match correctly, but for an unknown level of nesting, regexps will fail. -.PP -We'll start by writing a regexp to match integers in the range 0 to 99. We will require at least one digit so we will start with \fB[0-9]{1,1}\fR which means match a digit exactly once. This regexp alone will match integers in the range 0 to 9. To match one or two digits we can increase the maximum number of occurrences so the regexp becomes \fB[0-9]{1,2}\fR meaning match a digit at least once and at most twice. However, this regexp as it stands will not match correctly. This regexp will match one or two digits \fIwithin\fR a string. To ensure that we match against the whole string we must use the anchor assertions. We need \fB^\fR (caret) which when it is the first character in the regexp means that the regexp must match from the beginning of the string. And we also need \fB$\fR (dollar) which when it is the last character in the regexp means that the regexp must match until the end of the string. So now our regexp is \fB^[0-9]{1,2}$\fR. Note that assertions, such as \fB^\fR and \fB$\fR, do not match any characters. -.PP -If you've seen regexps elsewhere they may have looked different from the ones above. This is because some sets of characters and some quantifiers are so common that they have special symbols to represent them. \fB[0-9]\fR can be replaced with the symbol \fB\\d\fR. The quantifier to match exactly one occurrence, \fB{1,1}\fR, can be replaced with the expression itself. This means that \fBx{1,1}\fR is exactly the same as \fBx\fR alone. So our 0 to 99 matcher could be written \fB^\\d{1,2}$\fR. Another way of writing it would be \fB^\\d\\d{0,1}$\fR, i.e. from the start of the string match a digit followed by zero or one digits. In practice most people would write it \fB^\\d\\d?$\fR. The \fB?\fR is a shorthand for the quantifier \fB{0,1}\fR, i.e. a minimum of no occurrences a maximum of one occurrence. This is used to make an expression optional. The regexp \fB^\\d\\d?$\fR means "from the beginning of the string match one digit followed by zero or one digits and then the end of the string". -.PP -Our second example is matching the words 'mail', 'letter' or 'correspondence' but without matching 'email', 'mailman', 'mailer', 'letterbox' etc. We'll start by just matching 'mail'. In full the regexp is, \fBm{1,1}a{1,1}i{1,1}l{1,1}\fR, but since each expression itself is automatically quantified by \fB{1,1}\fR we can simply write this as \fBmail\fR; an 'm' followed by an 'a' followed by an 'i' followed by an 'l'. The symbol '|' (bar) is used for \fIalternation\fR, so our regexp now becomes \fBmail|letter|correspondence\fR which means match 'mail' \fIor\fR 'letter' \fIor\fR 'correspondence'. Whilst this regexp will find the words we want it will also find words we don't want such as 'email'. We will start by putting our regexp in parentheses, \fB(mail|letter|correspondence)\fR. Parentheses have two effects, firstly they group expressions together and secondly they identify parts of the regexp that we wish to capture. Our regexp still matches any of the three words but now they are grouped together as a unit. This is useful for building up more complex regexps. It is also useful because it allows us to examine which of the words actually matched. We need to use another assertion, this time \fB\\b\fR "word boundary": \fB\\b(mail|letter|correspondence)\\b\fR. This regexp means "match a word boundary followed by the expression in parentheses followed by another word boundary". The \fB\\b\fR assertion matches at a \fIposition\fR in the regexp not a \fIcharacter\fR in the regexp. A word boundary is any non-word character such as a space a newline or the beginning or end of the string. -.PP -For our third example we want to replace ampersands with the HTML entity '&'. The regexp to match is simple: \fB&\fR, i.e. match one ampersand. Unfortunately this will mess up our text if some of the ampersands have already been turned into HTML entities. So what we really want to say is replace an ampersand providing it is not followed by 'amp;'. For this we need the negative lookahead assertion and our regexp becomes: \fB&(?!amp;)\fR. The negative lookahead assertion is introduced with '(?!' and finishes at the ')'. It means that the text it contains, 'amp;' in our example, must \fInot\fR follow the expression that preceeds it. -.PP -Regexps provide a rich language that can be used in a variety of ways. For example suppose we want to count all the occurrences of 'Eric' and 'Eirik' in a string. Two valid regexps to match these are \fB\b(Eric|Eirik)\b\fR and \fB\bEi?ri[ck]\b\fR. We need the word boundary '\\b' so we don't get 'Ericsson' etc. The second regexp actually matches more than we want, 'Eric', 'Erik', 'Eiric' and 'Eirik'. -.PP -We will implement some the examples above in the code examples section. -.SH "Characters and Abbreviations for Sets of Characters" -
                                            .nf -.TS -l -- -l. -Element Meaning - Any character represents itself unless it has a special -regexp meaning. Thus - A character that follows a backslash matches the character -itself except where mentioned below. For example if you -wished to match a literal caret at the beginning of a string -you would write - This matches the ASCII bell character (BEL, 0x07). - This matches the ASCII form feed character (FF, 0x0C). - This matches the ASCII line feed character (LF, 0x0A, Unix newline). - This matches the ASCII carriage return character (CR, 0x0D). - This matches the ASCII horizontal tab character (HT, 0x09). - This matches the ASCII vertical tab character (VT, 0x0B). - This matches the Unicode character corresponding to the -hexadecimal number hhhh (between 0x0000 and 0xFFFF). \0ooo -(i.e., \\zero ooo) matches the ASCII/Latin-1 character -corresponding to the octal number ooo (between 0 and 0377). - This matches any character (including newline). - This matches a digit (QChar::isDigit()). - This matches a non-digit. - This matches a whitespace (QChar::isSpace()). - This matches a non-whitespace. - This matches a word character (QChar::isLetterOrNumber() or '_'). - This matches a non-word character. - -.TE -.fi -
                                            -.PP -\fINote that the C++ compiler transforms backslashes in strings so to include a \fB\\fR in a regexp you will need to enter it twice, i.e. \fB\\\fR.\fR -.SH "Sets of Characters" -Square brackets are used to match any character in the set of characters contained within the square brackets. All the character set abbreviations described above can be used within square brackets. Apart from the character set abbreviations and the following two exceptions no characters have special meanings in square brackets. -.PP -
                                            .nf -.TS -l - l. The caret negates the character set if it occurs as the first character, i.e. immediately after the opening square bracket. For example, The dash is used to indicate a range of characters, for example -.TE -.fi -
                                            -.PP -Using the predefined character set abbreviations is more portable than using character ranges across platforms and languages. For example, \fB[0-9]\fR matches a digit in Western alphabets but \fB\\d\fR matches a digit in \fIany\fR alphabet. -.PP -Note that in most regexp literature sets of characters are called" character classes". -.SH "Quantifiers" -By default an expression is automatically quantified by \fB{1,1}\fR, i.e. it should occur exactly once. In the following list \fB\fIE\fR\fR stands for any expression. An expression is a character or an abbreviation for a set of characters or a set of characters in square brackets or any parenthesised expression. -.PP -
                                            .nf -.TS -l -- -l. - Matches zero or one occurrence of \fIE\fR. This quantifier -means "the previous expression is optional" since it will -match whether or not the expression occurs in the string. It -is the same as - Matches one or more occurrences of \fIE\fR. This is the same -as - Matches zero or more occurrences of \fIE\fR. This is the same -as - Matches exactly \fIn\fR occurrences of the expression. This -is the same as repeating the expression \fIn\fR times. For -example, - Matches at least \fIn\fR occurrences of the expression. This -is the same as - Matches at most \fIm\fR occurrences of the expression. This -is the same as - -.TE -.fi -
                                            -.PP -(MAXINT is implementation dependent but will not be smaller than 1024.) -.PP -If we wish to apply a quantifier to more than just the preceding character we can use parentheses to group characters together in an expression. For example, \fBtag+\fR matches a 't' followed by an 'a' followed by at least one 'g', whereas \fB(tag)+\fR matches at least one occurrence of 'tag'. -.PP -Note that quantifiers are "greedy". They will match as much text as they can. For example, \fB0+\fR will match as many zeros as it can from the first zero it finds, e.g. '2.0005'. Quantifiers can be made non-greedy, see setMinimal(). -.SH "Capturing Text" -Parentheses allow us to group elements together so that we can quantify and capture them. For example if we have the expression \fBmail|letter|correspondence\fR that matches a string we know that \fIone\fR of the words matched but not which one. Using parentheses allows us to "capture" whatever is matched within their bounds, so if we used \fB(mail|letter|correspondence)\fR and matched this regexp against the string "I sent you some email" we can use the cap() or capturedTexts() functions to extract the matched characters, in this case 'mail'. -.PP -We can use captured text within the regexp itself. To refer to the captured text we use \fIbackreferences\fR which are indexed from 1, the same as for cap(). For example we could search for duplicate words in a string using \fB\\b(\\w+)\\W+\1\\b\fR which means match a word boundary followed by one or more word characters followed by one or more non-word characters followed by the same text as the first parenthesised expression followed by a word boundary. -.PP -If we want to use parentheses purely for grouping and not for capturing we can use the non-capturing syntax, e.g. \fB(?:green|blue)\fR. Non-capturing parentheses begin '(?:' and end ')'. In this example we match either 'green' or 'blue' but we do not capture the match so we only know whether or not we matched but not which color we actually found. Using non-capturing parentheses is more efficient than using capturing parentheses since the regexp engine has to do less book-keeping. -.PP -Both capturing and non-capturing parentheses may be nested. -.SH "Assertions" -Assertions make some statement about the text at the point where they occur in the regexp but they do not match any characters. In the following list \fB\fIE\fR\fR stands for any expression. -.PP -
                                            .nf -.TS -l - l. The caret signifies the beginning of the string. If you wish to match a literal The dollar signifies the end of the string. For example A word boundary. For example the regexp A non-word boundary. This assertion is true wherever Positive lookahead. This assertion is true if the expression matches at this point in the regexp. For example, Negative lookahead. This assertion is true if the expression does not match at this point in the regexp. For example, -.TE -.fi -
                                            -.SH "Wildcard Matching (globbing)" -Most command shells such as \fIbash\fR or \fIcmd.exe\fR support "file globbing", the ability to identify a group of files by using wildcards. The setWildcard() function is used to switch between regexp and wildcard mode. Wildcard matching is much simpler than full regexps and has only four features: -.PP -
                                            .nf -.TS -l -- -l. - Any character represents itself apart from those mentioned -below. Thus - This matches any single character. It is the same as - This matches zero or more of any characters. It is the -same as - -.TE -.fi -
                                            -.PP -For example if we are in wildcard mode and have strings which contain filenames we could identify HTML files with \fB*.html\fR. This will match zero or more characters followed by a dot followed by 'h', 't', 'm' and 'l'. -.SH "Notes for Perl Users" -Most of the character class abbreviations supported by Perl are supported by QRegExp, see characters and abbreviations for sets of characters. -.PP -In QRegExp, apart from within character classes, \fC^\fR always signifies the start of the string, so carets must always be escaped unless used for that purpose. In Perl the meaning of caret varies automagically depending on where it occurs so escaping it is rarely necessary. The same applies to \fC$\fR which in QRegExp always signifies the end of the string. -.PP -QRegExp's quantifiers are the same as Perl's greedy quantifiers. Non-greedy matching cannot be applied to individual quantifiers, but can be applied to all the quantifiers in the pattern. For example, to match the Perl regexp \fBro+?m\fR requires: -.PP -.nf -.br - QRegExp rx( "ro+m" ); -.br - rx.setMinimal( TRUE ); -.br -.fi -.PP -The equivalent of Perl's \fC/i\fR option is setCaseSensitive(FALSE). -.PP -Perl's \fC/g\fR option can be emulated using a loop. -.PP -In QRegExp \fB.\fR matches any character, therefore all QRegExp regexps have the equivalent of Perl's \fC/s\fR option. QRegExp does not have an equivalent to Perl's \fC/m\fR option, but this can be emulated in various ways for example by splitting the input into lines or by looping with a regexp that searches for newlines. -.PP -Because QRegExp is string oriented there are no \\A, \\Z or \\z assertions. The \\G assertion is not supported but can be emulated in a loop. -.PP -Perl's $& is cap(0) or capturedTexts()[0]. There are no QRegExp equivalents for $`, $' or $+. Perl's capturing variables, $1, $2, -... correspond to cap(1) or capturedTexts()[1], cap(2) or -capturedTexts()[2], etc. -.PP -To substitute a pattern use QString::replace(). -.PP -Perl's extended \fC/x\fR syntax is not supported, nor are directives, e.g. (?i), or regexp comments, e.g. (?#comment). On the other hand, C++'s rules for literal strings can be used to achieve the same: -.PP -.nf -.br - QRegExp mark( "\\\\b" // word boundary -.br - "[Mm]ark" // the word we want to match -.br - ); -.br -.fi -.PP -Both zero-width positive and zero-width negative lookahead assertions (?=pattern) and (?!pattern) are supported with the same syntax as Perl. Perl's lookbehind assertions, "independent" subexpressions and conditional expressions are not supported. -.PP -Non-capturing parentheses are also supported, with the same (?:pattern) syntax. -.PP -See QStringList::split() and QStringList::join() for equivalents to Perl's split and join functions. -.PP -Note: because C++ transforms \'s they must be written \fItwice\fR in code, e.g. \fB\b\fR must be written \fB\\b\fR. -.SH "Code Examples" -.nf -.br - QRegExp rx( "^\\\\d\\\\d?$" ); // match integers 0 to 99 -.br - rx.search( "123" ); // returns -1 (no match) -.br - rx.search( "-6" ); // returns -1 (no match) -.br - rx.search( "6" ); // returns 0 (matched as position 0) -.br -.fi -.PP -The third string matches '6'. This is a simple validation regexp for integers in the range 0 to 99. -.PP -.nf -.br - QRegExp rx( "^\\\\S+$" ); // match strings without whitespace -.br - rx.search( "Hello world" ); // returns -1 (no match) -.br - rx.search( "This_is-OK" ); // returns 0 (matched at position 0) -.br -.fi -.PP -The second string matches 'This_is-OK'. We've used the character set abbreviation '\\S' (non-whitespace) and the anchors to match strings which contain no whitespace. -.PP -In the following example we match strings containing 'mail' or 'letter' or 'correspondence' but only match whole words i.e. not 'email' -.PP -.nf -.br - QRegExp rx( "\\\\b(mail|letter|correspondence)\\\\b" ); -.br - rx.search( "I sent you an email" ); // returns -1 (no match) -.br - rx.search( "Please write the letter" ); // returns 17 -.br -.fi -.PP -The second string matches "Please write the letter". The word 'letter' is also captured (because of the parentheses). We can see what text we've captured like this: -.PP -.nf -.br - QString captured = rx.cap( 1 ); // captured == "letter" -.br -.fi -.PP -This will capture the text from the first set of capturing parentheses (counting capturing left parentheses from left to right). The parentheses are counted from 1 since cap( 0 ) is the whole matched regexp (equivalent to '&' in most regexp engines). -.PP -.nf -.br - QRegExp rx( "&(?!amp;)" ); // match ampersands but not & -.br - QString line1 = "This & that"; -.br - line1.replace( rx, "&" ); -.br - // line1 == "This & that" -.br - QString line2 = "His & hers & theirs"; -.br - line2.replace( rx, "&" ); -.br - // line2 == "His & hers & theirs" -.br -.fi -.PP -Here we've passed the QRegExp to QString's replace() function to replace the matched text with new text. -.PP -.nf -.br - QString str = "One Eric another Eirik, and an Ericsson." -.br - " How many Eiriks, Eric?"; -.br - QRegExp rx( "\\\\b(Eric|Eirik)\\\\b" ); // match Eric or Eirik -.br - int pos = 0; // where we are in the string -.br - int count = 0; // how many Eric and Eirik's we've counted -.br - while ( pos >= 0 ) { -.br - pos = rx.search( str, pos ); -.br - if ( pos >= 0 ) { -.br - pos++; // move along in str -.br - count++; // count our Eric or Eirik -.br - } -.br - } -.br -.fi -.PP -We've used the search() function to repeatedly match the regexp in the string. Note that instead of moving forward by one character at a time \fCpos++\fR we could have written \fCpos += rx.matchedLength()\fR to skip over the already matched string. The count will equal 3, matching 'One Eric another Eirik, and an Ericsson. How many Eiriks, Eric?'; it doesn't match 'Ericsson' or 'Eiriks' because they are not bounded by non-word boundaries. -.PP -One common use of regexps is to split lines of delimited data into their component fields. -.PP -.nf -.br - str = "Trolltech AS\\twww.trolltech.com\\tNorway"; -.br - QString company, web, country; -.br - rx.setPattern( "^([^\\t]+)\\t([^\\t]+)\\t([^\\t]+)$" ); -.br - if ( rx.search( str ) != -1 ) { -.br - company = rx.cap( 1 ); -.br - web = rx.cap( 2 ); -.br - country = rx.cap( 3 ); -.br - } -.br -.fi -.PP -In this example our input lines have the format company name, web address and country. Unfortunately the regexp is rather long and not very versatile -- the code will break if we add any more fields. A simpler and better solution is to look for the separator, '\\t' in this case, and take the surrounding text. The QStringList split() function can take a separator string or regexp as an argument and split a string accordingly. -.PP -.nf -.br - QStringList field = QStringList::split( "\\t", str ); -.br -.fi -.PP -Here field[0] is the company, field[1] the web address and so on. -.PP -To imitate the matching of a shell we can use wildcard mode. -.PP -.nf -.br - QRegExp rx( "*.html" ); // invalid regexp: * doesn't quantify anything -.br - rx.setWildcard( TRUE ); // now it's a valid wildcard regexp -.br - rx.exactMatch( "index.html" ); // returns TRUE -.br - rx.exactMatch( "default.htm" ); // returns FALSE -.br - rx.exactMatch( "readme.txt" ); // returns FALSE -.br -.fi -.PP -Wildcard matching can be convenient because of its simplicity, but any wildcard regexp can be defined using full regexps, e.g. \fB.*\.html$\fR. Notice that we can't match both \fC.html\fR and \fC.htm\fR files with a wildcard unless we use \fB*.htm*\fR which will also match 'test.html.bak'. A full regexp gives us the precision we need, \fB.*\.html?$\fR. -.PP -QRegExp can match case insensitively using setCaseSensitive(), and can use non-greedy matching, see setMinimal(). By default QRegExp uses full regexps but this can be changed with setWildcard(). Searching can be forward with search() or backward with searchRev(). Captured text can be accessed using capturedTexts() which returns a string list of all captured strings, or using cap() which returns the captured string for the given index. The pos() function takes a match index and returns the position in the string where the match was made (or -1 if there was no match). -.PP -See also QRegExpValidator, QString, QStringList, Miscellaneous Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.PP -.SS "Member Type Documentation" -.SH "QRegExp::CaretMode" -The CaretMode enum defines the different meanings of the caret (\fB^\fR) in a regular expression. The possible values are: -.TP -\fCQRegExp::CaretAtZero\fR - The caret corresponds to index 0 in the searched string. -.TP -\fCQRegExp::CaretAtOffset\fR - The caret corresponds to the start offset of the search. -.TP -\fCQRegExp::CaretWontMatch\fR - The caret never matches. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QRegExp::QRegExp ()" -Constructs an empty regexp. -.PP -See also isValid() and errorString(). -.SH "QRegExp::QRegExp ( const QString & pattern, bool caseSensitive = TRUE, bool wildcard = FALSE )" -Constructs a regular expression object for the given \fIpattern\fR string. The pattern must be given using wildcard notation if \fIwildcard\fR is TRUE (default is FALSE). The pattern is case sensitive, unless \fIcaseSensitive\fR is FALSE. Matching is greedy (maximal), but can be changed by calling setMinimal(). -.PP -See also setPattern(), setCaseSensitive(), setWildcard(), and setMinimal(). -.SH "QRegExp::QRegExp ( const QRegExp & rx )" -Constructs a regular expression as a copy of \fIrx\fR. -.PP -See also operator=(). -.SH "QRegExp::~QRegExp ()" -Destroys the regular expression and cleans up its internal data. -.SH "QString QRegExp::cap ( int nth = 0 )" -Returns the text captured by the \fInth\fR subexpression. The entire match has index 0 and the parenthesized subexpressions have indices starting from 1 (excluding non-capturing parentheses). -.PP -.nf -.br - QRegExp rxlen( "(\\\\d+)(?:\\\\s*)(cm|inch)" ); -.br - int pos = rxlen.search( "Length: 189cm" ); -.br - if ( pos > -1 ) { -.br - QString value = rxlen.cap( 1 ); // "189" -.br - QString unit = rxlen.cap( 2 ); // "cm" -.br - // ... -.br - } -.br -.fi -.PP -The order of elements matched by cap() is as follows. The first element, cap(0), is the entire matching string. Each subsequent element corresponds to the next capturing open left parentheses. Thus cap(1) is the text of the first capturing parentheses, cap(2) is the text of the second, and so on. -.PP -Some patterns may lead to a number of matches which cannot be determined in advance, for example: -.PP -.nf -.br - QRegExp rx( "(\\\\d+)" ); -.br - str = "Offsets: 12 14 99 231 7"; -.br - QStringList list; -.br - pos = 0; -.br - while ( pos >= 0 ) { -.br - pos = rx.search( str, pos ); -.br - if ( pos > -1 ) { -.br - list += rx.cap( 1 ); -.br - pos += rx.matchedLength(); -.br - } -.br - } -.br - // list contains "12", "14", "99", "231", "7" -.br -.fi -.PP -See also capturedTexts(), pos(), exactMatch(), search(), and searchRev(). -.PP -Examples: -.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. -.SH "QStringList QRegExp::capturedTexts ()" -Returns a list of the captured text strings. -.PP -The first string in the list is the entire matched string. Each subsequent list element contains a string that matched a (capturing) subexpression of the regexp. -.PP -For example: -.PP -.nf -.br - QRegExp rx( "(\\\\d+)(\\\\s*)(cm|inch(es)?)" ); -.br - int pos = rx.search( "Length: 36 inches" ); -.br - QStringList list = rx.capturedTexts(); -.br - // list is now ( "36 inches", "36", " ", "inches", "es" ) -.br -.fi -.PP -The above example also captures elements that may be present but which we have no interest in. This problem can be solved by using non-capturing parentheses: -.PP -.nf -.br - QRegExp rx( "(\\\\d+)(?:\\\\s*)(cm|inch(?:es)?)" ); -.br - int pos = rx.search( "Length: 36 inches" ); -.br - QStringList list = rx.capturedTexts(); -.br - // list is now ( "36 inches", "36", "inches" ) -.br -.fi -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = rx.capturedTexts(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -Some regexps can match an indeterminate number of times. For example if the input string is "Offsets: 12 14 99 231 7" and the regexp, \fCrx\fR, is \fB(\d+)+\fR, we would hope to get a list of all the numbers matched. However, after calling \fCrx.search(str)\fR, capturedTexts() will return the list ( "12"," 12" ), i.e. the entire match was "12" and the first subexpression matched was "12". The correct approach is to use cap() in a loop. -.PP -The order of elements in the string list is as follows. The first element is the entire matching string. Each subsequent element corresponds to the next capturing open left parentheses. Thus capturedTexts()[1] is the text of the first capturing parentheses, capturedTexts()[2] is the text of the second and so on (corresponding to $1, $2, etc., in some other regexp languages). -.PP -See also cap(), pos(), exactMatch(), search(), and searchRev(). -.SH "bool QRegExp::caseSensitive () const" -Returns TRUE if case sensitivity is enabled; otherwise returns FALSE. The default is TRUE. -.PP -See also setCaseSensitive(). -.SH "QString QRegExp::errorString ()" -Returns a text string that explains why a regexp pattern is invalid the case being; otherwise returns "no error occurred". -.PP -See also isValid(). -.PP -Example: regexptester/regexptester.cpp. -.SH "QString QRegExp::escape ( const QString & str )\fC [static]\fR" -Returns the string \fIstr\fR with every regexp special character escaped with a backslash. The special characters are $, (, ), *, +, -., ?, [, \, ], ^, {, | and }. -.PP -Example: -.PP -.nf -.br - s1 = QRegExp::escape( "bingo" ); // s1 == "bingo" -.br - s2 = QRegExp::escape( "f(x)" ); // s2 == "f\\\\(x\\\\)" -.br -.fi -.PP -This function is useful to construct regexp patterns dynamically: -.PP -.nf -.br - QRegExp rx( "(" + QRegExp::escape(name) + -.br - "|" + QRegExp::escape(alias) + ")" ); -.br -.fi -.SH "bool QRegExp::exactMatch ( const QString & str ) const" -Returns TRUE if \fIstr\fR is matched exactly by this regular expression; otherwise returns FALSE. You can determine how much of the string was matched by calling matchedLength(). -.PP -For a given regexp string, R, exactMatch("R") is the equivalent of search("^R$") since exactMatch() effectively encloses the regexp in the start of string and end of string anchors, except that it sets matchedLength() differently. -.PP -For example, if the regular expression is \fBblue\fR, then exactMatch() returns TRUE only for input \fCblue\fR. For inputs \fCbluebell\fR, \fCblutak\fR and \fClightblue\fR, exactMatch() returns FALSE and matchedLength() will return 4, 3 and 0 respectively. -.PP -Although const, this function sets matchedLength(), capturedTexts() and pos(). -.PP -See also search(), searchRev(), and QRegExpValidator. -.SH "bool QRegExp::isEmpty () const" -Returns TRUE if the pattern string is empty; otherwise returns FALSE. -.PP -If you call exactMatch() with an empty pattern on an empty string it will return TRUE; otherwise it returns FALSE since it operates over the whole string. If you call search() with an empty pattern on \fIany\fR string it will return the start offset (0 by default) because the empty pattern matches the 'emptiness' at the start of the string. In this case the length of the match returned by matchedLength() will be 0. -.PP -See QString::isEmpty(). -.SH "bool QRegExp::isValid () const" -Returns TRUE if the regular expression is valid; otherwise returns FALSE. An invalid regular expression never matches. -.PP -The pattern \fB[a-z\fR is an example of an invalid pattern, since it lacks a closing square bracket. -.PP -Note that the validity of a regexp may also depend on the setting of the wildcard flag, for example \fB*.html\fR is a valid wildcard regexp but an invalid full regexp. -.PP -See also errorString(). -.PP -Example: regexptester/regexptester.cpp. -.SH "int QRegExp::match ( const QString & str, int index = 0, int * len = 0, bool indexIsStart = TRUE ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Attempts to match in \fIstr\fR, starting from position \fIindex\fR. Returns the position of the match, or -1 if there was no match. -.PP -The length of the match is stored in \fI*len\fR, unless \fIlen\fR is a null pointer. -.PP -If \fIindexIsStart\fR is TRUE (the default), the position \fIindex\fR in the string will match the start of string anchor, \fB^\fR, in the regexp, if present. Otherwise, position 0 in \fIstr\fR will match. -.PP -Use search() and matchedLength() instead of this function. -.PP -See also QString::mid() and QConstString. -.PP -Example: qmag/qmag.cpp. -.SH "int QRegExp::matchedLength () const" -Returns the length of the last matched string, or -1 if there was no match. -.PP -See also exactMatch(), search(), and searchRev(). -.PP -Examples: -.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. -.SH "bool QRegExp::minimal () const" -Returns TRUE if minimal (non-greedy) matching is enabled; otherwise returns FALSE. -.PP -See also setMinimal(). -.SH "int QRegExp::numCaptures () const" -Returns the number of captures contained in the regular expression. -.PP -Example: regexptester/regexptester.cpp. -.SH "bool QRegExp::operator!= ( const QRegExp & rx ) const" -Returns TRUE if this regular expression is not equal to \fIrx\fR; otherwise returns FALSE. -.PP -See also operator==(). -.SH "QRegExp & QRegExp::operator= ( const QRegExp & rx )" -Copies the regular expression \fIrx\fR and returns a reference to the copy. The case sensitivity, wildcard and minimal matching options are also copied. -.SH "bool QRegExp::operator== ( const QRegExp & rx ) const" -Returns TRUE if this regular expression is equal to \fIrx\fR; otherwise returns FALSE. -.PP -Two QRegExp objects are equal if they have the same pattern strings and the same settings for case sensitivity, wildcard and minimal matching. -.SH "QString QRegExp::pattern () const" -Returns the pattern string of the regular expression. The pattern has either regular expression syntax or wildcard syntax, depending on wildcard(). -.PP -See also setPattern(). -.SH "int QRegExp::pos ( int nth = 0 )" -Returns the position of the \fInth\fR captured text in the searched string. If \fInth\fR is 0 (the default), pos() returns the position of the whole match. -.PP -Example: -.PP -.nf -.br - QRegExp rx( "/([a-z]+)/([a-z]+)" ); -.br - rx.search( "Output /dev/null" ); // returns 7 (position of /dev/null) -.br - rx.pos( 0 ); // returns 7 (position of /dev/null) -.br - rx.pos( 1 ); // returns 8 (position of dev) -.br - rx.pos( 2 ); // returns 12 (position of null) -.br -.fi -.PP -For zero-length matches, pos() always returns -1. (For example, if cap(4) would return an empty string, pos(4) returns -1.) This is due to an implementation tradeoff. -.PP -See also capturedTexts(), exactMatch(), search(), and searchRev(). -.SH "int QRegExp::search ( const QString & str, int offset = 0, CaretMode caretMode = CaretAtZero ) const" -Attempts to find a match in \fIstr\fR from position \fIoffset\fR (0 by default). If \fIoffset\fR is -1, the search starts at the last character; if -2, at the next to last character; etc. -.PP -Returns the position of the first match, or -1 if there was no match. -.PP -The \fIcaretMode\fR parameter can be used to instruct whether \fB^\fR should match at index 0 or at \fIoffset\fR. -.PP -You might prefer to use QString::find(), QString::contains() or even QStringList::grep(). To replace matches use QString::replace(). -.PP -Example: -.PP -.nf -.br - QString str = "offsets: 1.23 .50 71.00 6.00"; -.br - QRegExp rx( "\\\\d*\\\\.\\\\d+" ); // primitive floating point matching -.br - int count = 0; -.br - int pos = 0; -.br - while ( (pos = rx.search(str, pos)) != -1 ) { -.br - count++; -.br - pos += rx.matchedLength(); -.br - } -.br - // pos will be 9, 14, 18 and finally 24; count will end up as 4 -.br -.fi -.PP -Although const, this function sets matchedLength(), capturedTexts() and pos(). -.PP -See also searchRev() and exactMatch(). -.PP -Examples: -.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. -.SH "int QRegExp::searchRev ( const QString & str, int offset = -1, CaretMode caretMode = CaretAtZero ) const" -Attempts to find a match backwards in \fIstr\fR from position \fIoffset\fR. If \fIoffset\fR is -1 (the default), the search starts at the last character; if -2, at the next to last character; etc. -.PP -Returns the position of the first match, or -1 if there was no match. -.PP -The \fIcaretMode\fR parameter can be used to instruct whether \fB^\fR should match at index 0 or at \fIoffset\fR. -.PP -Although const, this function sets matchedLength(), capturedTexts() and pos(). -.PP -\fBWarning:\fR Searching backwards is much slower than searching forwards. -.PP -See also search() and exactMatch(). -.SH "void QRegExp::setCaseSensitive ( bool sensitive )" -Sets case sensitive matching to \fIsensitive\fR. -.PP -If \fIsensitive\fR is TRUE, \fB\.txt$\fR matches \fCreadme.txt\fR but not \fCREADME.TXT\fR. -.PP -See also caseSensitive(). -.PP -Example: regexptester/regexptester.cpp. -.SH "void QRegExp::setMinimal ( bool minimal )" -Enables or disables minimal matching. If \fIminimal\fR is FALSE, matching is greedy (maximal) which is the default. -.PP -For example, suppose we have the input string "We must be bold, very bold!" and the pattern \fB.*\fR. With the default greedy (maximal) matching, the match is "We must be bold, very bold!". But with minimal (non-greedy) matching the first match is: "We must be bold, very bold!" and the second match is "We must be bold, very bold!". In practice we might use the pattern \fB[^<]+\fR instead, although this will still fail for nested tags. -.PP -See also minimal(). -.PP -Examples: -.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. -.SH "void QRegExp::setPattern ( const QString & pattern )" -Sets the pattern string to \fIpattern\fR. The case sensitivity, wildcard and minimal matching options are not changed. -.PP -See also pattern(). -.SH "void QRegExp::setWildcard ( bool wildcard )" -Sets the wildcard mode for the regular expression. The default is FALSE. -.PP -Setting \fIwildcard\fR to TRUE enables simple shell-like wildcard matching. (See wildcard matching (globbing).) -.PP -For example, \fBr*.txt\fR matches the string \fCreadme.txt\fR in wildcard mode, but does not match \fCreadme\fR. -.PP -See also wildcard(). -.PP -Example: regexptester/regexptester.cpp. -.SH "bool QRegExp::wildcard () const" -Returns TRUE if wildcard mode is enabled; otherwise returns FALSE. The default is FALSE. -.PP -See also setWildcard(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqregexp.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qregexp.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qregexpvalidator.3qt b/doc/man/man3/qregexpvalidator.3qt deleted file mode 100644 index 60cdaca89..000000000 --- a/doc/man/man3/qregexpvalidator.3qt +++ /dev/null @@ -1,179 +0,0 @@ -'\" t -.TH QRegExpValidator 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 -QRegExpValidator \- Used to check a string against a -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QValidator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQRegExpValidator\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQRegExpValidator\fR ( const QRegExp & rx, QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QRegExpValidator\fR ()" -.br -.ti -1c -.BI "virtual QValidator::State \fBvalidate\fR ( QString & input, int & pos ) const" -.br -.ti -1c -.BI "void \fBsetRegExp\fR ( const QRegExp & rx )" -.br -.ti -1c -.BI "const QRegExp & \fBregExp\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QRegExpValidator class is used to check a string against a regular expression. -.PP -QRegExpValidator contains a regular expression, "regexp", used to determine whether an input string is Acceptable, Intermediate or Invalid. -.PP -The regexp is treated as if it begins with the start of string assertion, \fB^\fR, and ends with the end of string assertion \fB$\fR so the match is against the entire input string, or from the given position if a start position greater than zero is given. -.PP -For a brief introduction to Qt's regexp engine see QRegExp. -.PP -Example of use: -.PP -.nf -.br - // regexp: optional '-' followed by between 1 and 3 digits -.br - QRegExp rx( "-?\\\\d{1,3}" ); -.br - QValidator* validator = new QRegExpValidator( rx, this ); -.br -.br - QLineEdit* edit = new QLineEdit( this ); -.br - edit->setValidator( validator ); -.br -.fi -.PP -Below we present some examples of validators. In practice they would normally be associated with a widget as in the example above. -.PP -.nf -.br - // integers 1 to 9999 -.br - QRegExp rx( "[1-9]\\\\d{0,3}" ); -.br - // the validator treats the regexp as "^[1-9]\\\\d{0,3}$" -.br - QRegExpValidator v( rx, 0 ); -.br - QString s; -.br - int pos = 0; -.br -.br - s = "0"; v.validate( s, pos ); // returns Invalid -.br - s = "12345"; v.validate( s, pos ); // returns Invalid -.br - s = "1"; v.validate( s, pos ); // returns Acceptable -.br -.br - rx.setPattern( "\\\\S+" ); // one or more non-whitespace characters -.br - v.setRegExp( rx ); -.br - s = "myfile.txt"; v.validate( s, pos ); // Returns Acceptable -.br - s = "my file.txt"; v.validate( s, pos ); // Returns Invalid -.br -.br - // A, B or C followed by exactly five digits followed by W, X, Y or Z -.br - rx.setPattern( "[A-C]\\\\d{5}[W-Z]" ); -.br - v.setRegExp( rx ); -.br - s = "a12345Z"; v.validate( s, pos ); // Returns Invalid -.br - s = "A12345Z"; v.validate( s, pos ); // Returns Acceptable -.br - s = "B12"; v.validate( s, pos ); // Returns Intermediate -.br -.br - // match most 'readme' files -.br - rx.setPattern( "read\\\\S?me(\\.(txt|asc|1st))?" ); -.br - rx.setCaseSensitive( FALSE ); -.br - v.setRegExp( rx ); -.br - s = "readme"; v.validate( s, pos ); // Returns Acceptable -.br - s = "README.1ST"; v.validate( s, pos ); // Returns Acceptable -.br - s = "read me.txt"; v.validate( s, pos ); // Returns Invalid -.br - s = "readm"; v.validate( s, pos ); // Returns Intermediate -.br -.fi -.PP -See also QRegExp, QIntValidator, QDoubleValidator, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QRegExpValidator::QRegExpValidator ( QObject * parent, const char * name = 0 )" -Constructs a validator that accepts any string (including an empty one) as valid. The object's parent is \fIparent\fR and its name is \fIname\fR. -.SH "QRegExpValidator::QRegExpValidator ( const QRegExp & rx, QObject * parent, const char * name = 0 )" -Constructs a validator which accepts all strings that match the regular expression \fIrx\fR. The object's parent is \fIparent\fR and its name is \fIname\fR. -.PP -The match is made against the entire string, e.g. if the regexp is \fB[A-Fa-f0-9]+\fR it will be treated as \fB^[A-Fa-f0-9]+$\fR. -.SH "QRegExpValidator::~QRegExpValidator ()" -Destroys the validator, freeing any resources allocated. -.SH "const QRegExp & QRegExpValidator::regExp () const" -Returns the regular expression used for validation. -.PP -See also setRegExp(). -.SH "void QRegExpValidator::setRegExp ( const QRegExp & rx )" -Sets the regular expression used for validation to \fIrx\fR. -.PP -See also regExp(). -.SH "QValidator::State QRegExpValidator::validate ( QString & input, int & pos ) const\fC [virtual]\fR" -Returns Acceptable if \fIinput\fR is matched by the regular expression for this validator, Intermediate if it has matched partially (i.e. could be a valid match if additional valid characters are added), and Invalid if \fIinput\fR is not matched. -.PP -The \fIpos\fR parameter is set to the length of the \fIinput\fR parameter. -.PP -For example, if the regular expression is \fB\w\d\d\fR (that is, word-character, digit, digit) then "A57" is Acceptable," E5" is Intermediate and "+9" is Invalid. -.PP -See also QRegExp::match() and QRegExp::search(). -.PP -Reimplemented from QValidator. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qregexpvalidator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qregexpvalidator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qregion.3qt b/doc/man/man3/qregion.3qt deleted file mode 100644 index 637e3d1ca..000000000 --- a/doc/man/man3/qregion.3qt +++ /dev/null @@ -1,388 +0,0 @@ -'\" t -.TH QRegion 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 -QRegion \- Clip region for a painter -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBRegionType\fR { Rectangle, Ellipse }" -.br -.ti -1c -.BI "\fBQRegion\fR ()" -.br -.ti -1c -.BI "\fBQRegion\fR ( int x, int y, int w, int h, RegionType t = Rectangle )" -.br -.ti -1c -.BI "\fBQRegion\fR ( const QRect & r, RegionType t = Rectangle )" -.br -.ti -1c -.BI "\fBQRegion\fR ( const QPointArray & a, bool winding = FALSE )" -.br -.ti -1c -.BI "\fBQRegion\fR ( const QRegion & r )" -.br -.ti -1c -.BI "\fBQRegion\fR ( const QBitmap & bm )" -.br -.ti -1c -.BI "\fB~QRegion\fR ()" -.br -.ti -1c -.BI "QRegion & \fBoperator=\fR ( const QRegion & r )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QRect & r ) const" -.br -.ti -1c -.BI "void \fBtranslate\fR ( int dx, int dy )" -.br -.ti -1c -.BI "QRegion \fBunite\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "QRegion \fBintersect\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "QRegion \fBsubtract\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "QRegion \fBeor\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "QRect \fBboundingRect\fR () const" -.br -.ti -1c -.BI "QMemArray \fBrects\fR () const" -.br -.ti -1c -.BI "const QRegion \fBoperator|\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "const QRegion \fBoperator+\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "const QRegion \fBoperator&\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "const QRegion \fBoperator-\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "const QRegion \fBoperator^\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "QRegion & \fBoperator|=\fR ( const QRegion & r )" -.br -.ti -1c -.BI "QRegion & \fBoperator+=\fR ( const QRegion & r )" -.br -.ti -1c -.BI "QRegion & \fBoperator&=\fR ( const QRegion & r )" -.br -.ti -1c -.BI "QRegion & \fBoperator-=\fR ( const QRegion & r )" -.br -.ti -1c -.BI "QRegion & \fBoperator^=\fR ( const QRegion & r )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "HRGN \fBhandle\fR () const" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QRegion & r )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QRegion & r )" -.br -.in -1c -.SH DESCRIPTION -The QRegion class specifies a clip region for a painter. -.PP -QRegion is used with QPainter::setClipRegion() to limit the paint area to what needs to be painted. There is also a QWidget::repaint() that takes a QRegion parameter. QRegion is the best tool for reducing flicker. -.PP -A region can be created from a rectangle, an ellipse, a polygon or a bitmap. Complex regions may be created by combining simple regions using unite(), intersect(), subtract() or eor() (exclusive or). You can move a region using translate(). -.PP -You can test whether a region isNull(), isEmpty() or if it contains() a QPoint or QRect. The bounding rectangle is given by boundingRect(). -.PP -The function rects() gives a decomposition of the region into rectangles. -.PP -Example of using complex regions: -.PP -.nf -.br - void MyWidget::paintEvent( QPaintEvent * ) -.br - { -.br - QPainter p; // our painter -.br - QRegion r1( QRect(100,100,200,80), // r1 = elliptic region -.br - QRegion::Ellipse ); -.br - QRegion r2( QRect(100,120,90,30) ); // r2 = rectangular region -.br - QRegion r3 = r1.intersect( r2 ); // r3 = intersection -.br - p.begin( this ); // start painting widget -.br - p.setClipRegion( r3 ); // set clip region -.br - ... // paint clipped graphics -.br - p.end(); // painting done -.br - } -.br -.fi -.PP -QRegion is an implicitly shared class. -.PP -\fBWarning:\fR Due to window system limitations, the whole coordinate space for a region is limited to the points between -32767 and 32767 on Mac OS X and Windows 95/98/ME. -.PP -See also QPainter::setClipRegion(), QPainter::setClipRect(), Graphics Classes, and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QRegion::RegionType" -Specifies the shape of the region to be created. -.TP -\fCQRegion::Rectangle\fR - the region covers the entire rectangle. -.TP -\fCQRegion::Ellipse\fR - the region is an ellipse inside the rectangle. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QRegion::QRegion ()" -Constructs a null region. -.PP -See also isNull(). -.SH "QRegion::QRegion ( int x, int y, int w, int h, RegionType t = Rectangle )" -Constructs a rectangular or elliptic region. -.PP -If \fIt\fR is Rectangle, the region is the filled rectangle (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR). If \fIt\fR is Ellipse, the region is the filled ellipse with center at (\fIx\fR + \fIw\fR / 2, \fIy\fR + \fIh\fR / 2) and size (\fIw\fR ,\fIh\fR ). -.SH "QRegion::QRegion ( const QRect & r, RegionType t = Rectangle )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Create a region based on the rectange \fIr\fR with region type \fIt\fR. -.PP -If the rectangle is invalid a null region will be created. -.PP -See also QRegion::RegionType. -.SH "QRegion::QRegion ( const QPointArray & a, bool winding = FALSE )" -Constructs a polygon region from the point array \fIa\fR. -.PP -If \fIwinding\fR is TRUE, the polygon region is filled using the winding algorithm, otherwise the default even-odd fill algorithm is used. -.PP -This constructor may create complex regions that will slow down painting when used. -.SH "QRegion::QRegion ( const QRegion & r )" -Constructs a new region which is equal to region \fIr\fR. -.SH "QRegion::QRegion ( const QBitmap & bm )" -Constructs a region from the bitmap \fIbm\fR. -.PP -The resulting region consists of the pixels in bitmap \fIbm\fR that are \fCcolor1\fR, as if each pixel was a 1 by 1 rectangle. -.PP -This constructor may create complex regions that will slow down painting when used. Note that drawing masked pixmaps can be done much faster using QPixmap::setMask(). -.SH "QRegion::~QRegion ()" -Destroys the region. -.SH "QRect QRegion::boundingRect () const" -Returns the bounding rectangle of this region. An empty region gives a rectangle that is QRect::isNull(). -.SH "bool QRegion::contains ( const QPoint & p ) const" -Returns TRUE if the region contains the point \fIp\fR; otherwise returns FALSE. -.SH "bool QRegion::contains ( const QRect & r ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the region overlaps the rectangle \fIr\fR; otherwise returns FALSE. -.SH "QRegion QRegion::eor ( const QRegion & r ) const" -Returns a region which is the exclusive or (XOR) of this region and \fIr\fR. -.PP -
                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                            -.PP -The figure shows the exclusive or of two elliptical regions. -.SH "HRGN QRegion::handle () const" -Returns the region's handle. -.SH "QRegion QRegion::intersect ( const QRegion & r ) const" -Returns a region which is the intersection of this region and \fIr\fR. -.PP -
                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                            -.PP -The figure shows the intersection of two elliptical regions. -.SH "bool QRegion::isEmpty () const" -Returns TRUE if the region is empty; otherwise returns FALSE. An empty region is a region that contains no points. -.PP -Example: -.PP -.nf -.br - QRegion r1( 10, 10, 20, 20 ); -.br - QRegion r2( 40, 40, 20, 20 ); -.br - QRegion r3; -.br - r1.isNull(); // FALSE -.br - r1.isEmpty(); // FALSE -.br - r3.isNull(); // TRUE -.br - r3.isEmpty(); // TRUE -.br - r3 = r1.intersect( r2 ); // r3 = intersection of r1 and r2 -.br - r3.isNull(); // FALSE -.br - r3.isEmpty(); // TRUE -.br - r3 = r1.unite( r2 ); // r3 = union of r1 and r2 -.br - r3.isNull(); // FALSE -.br - r3.isEmpty(); // FALSE -.br -.fi -.PP -See also isNull(). -.SH "bool QRegion::isNull () const" -Returns TRUE if the region is a null region; otherwise returns FALSE. -.PP -A null region is a region that has not been initialized. A null region is always empty. -.PP -See also isEmpty(). -.SH "bool QRegion::operator!= ( const QRegion & r ) const" -Returns TRUE if the region is different from \fIr\fR; otherwise returns FALSE. -.SH "const QRegion QRegion::operator& ( const QRegion & r ) const" -Applies the intersect() function to this region and \fIr\fR. \fCr1&r2\fR is equivalent to \fCr1.intersect(r2)\fR -.PP -See also intersect(). -.SH "QRegion & QRegion::operator&= ( const QRegion & r )" -Applies the intersect() function to this region and \fIr\fR and assigns the result to this region. \fCr1&=r2\fR is equivalent to \fCr1=r1.intersect(r2)\fR -.PP -See also intersect(). -.SH "const QRegion QRegion::operator+ ( const QRegion & r ) const" -Applies the unite() function to this region and \fIr\fR. \fCr1+r2\fR is equivalent to \fCr1.unite(r2)\fR -.PP -See also unite() and operator|(). -.SH "QRegion & QRegion::operator+= ( const QRegion & r )" -Applies the unite() function to this region and \fIr\fR and assigns the result to this region. \fCr1+=r2\fR is equivalent to \fCr1=r1.unite(r2)\fR -.PP -See also intersect(). -.SH "const QRegion QRegion::operator- ( const QRegion & r ) const" -Applies the subtract() function to this region and \fIr\fR. \fCr1-r2\fR is equivalent to \fCr1.subtract(r2)\fR -.PP -See also subtract(). -.SH "QRegion & QRegion::operator-= ( const QRegion & r )" -Applies the subtract() function to this region and \fIr\fR and assigns the result to this region. \fCr1-=r2\fR is equivalent to \fCr1=r1.subtract(r2)\fR -.PP -See also subtract(). -.SH "QRegion & QRegion::operator= ( const QRegion & r )" -Assigns \fIr\fR to this region and returns a reference to the region. -.SH "bool QRegion::operator== ( const QRegion & r ) const" -Returns TRUE if the region is equal to \fIr\fR; otherwise returns FALSE. -.SH "const QRegion QRegion::operator^ ( const QRegion & r ) const" -Applies the eor() function to this region and \fIr\fR. \fCr1^r2\fR is equivalent to \fCr1.eor(r2)\fR -.PP -See also eor(). -.SH "QRegion & QRegion::operator^= ( const QRegion & r )" -Applies the eor() function to this region and \fIr\fR and assigns the result to this region. \fCr1^=r2\fR is equivalent to \fCr1=r1.eor(r2)\fR -.PP -See also eor(). -.SH "const QRegion QRegion::operator| ( const QRegion & r ) const" -Applies the unite() function to this region and \fIr\fR. \fCr1|r2\fR is equivalent to \fCr1.unite(r2)\fR -.PP -See also unite() and operator+(). -.SH "QRegion & QRegion::operator|= ( const QRegion & r )" -Applies the unite() function to this region and \fIr\fR and assigns the result to this region. \fCr1|=r2\fR is equivalent to \fCr1=r1.unite(r2)\fR -.PP -See also unite(). -.SH "QMemArray QRegion::rects () const" -Returns an array of non-overlapping rectangles that make up the region. -.PP -The union of all the rectangles is equal to the original region. -.SH "QRegion QRegion::subtract ( const QRegion & r ) const" -Returns a region which is \fIr\fR subtracted from this region. -.PP -
                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                            -.PP -The figure shows the result when the ellipse on the right is subtracted from the ellipse on the left. (\fCleft-right\fR ) -.SH "void QRegion::translate ( int dx, int dy )" -Translates (moves) the region \fIdx\fR along the X axis and \fIdy\fR along the Y axis. -.SH "QRegion QRegion::unite ( const QRegion & r ) const" -Returns a region which is the union of this region and \fIr\fR. -.PP -
                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                            -.PP -The figure shows the union of two elliptical regions. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QRegion & r )" -Writes the region \fIr\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QRegion & r )" -Reads a region from the stream \fIs\fR into \fIr\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqregion.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qregion.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qresizeevent.3qt b/doc/man/man3/qresizeevent.3qt deleted file mode 100644 index 593ee4b8b..000000000 --- a/doc/man/man3/qresizeevent.3qt +++ /dev/null @@ -1,70 +0,0 @@ -'\" t -.TH QResizeEvent 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 -QResizeEvent \- Event parameters for resize events -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQResizeEvent\fR ( const QSize & size, const QSize & oldSize )" -.br -.ti -1c -.BI "const QSize & \fBsize\fR () const" -.br -.ti -1c -.BI "const QSize & \fBoldSize\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QResizeEvent class contains event parameters for resize events. -.PP -Resize events are sent to widgets that have been resized. -.PP -The event handler QWidget::resizeEvent() receives resize events. -.PP -See also QWidget::size, QWidget::geometry, and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QResizeEvent::QResizeEvent ( const QSize & size, const QSize & oldSize )" -Constructs a resize event with the new and old widget sizes, \fIsize\fR and \fIoldSize\fR respectively. -.SH "const QSize & QResizeEvent::oldSize () const" -Returns the old size of the widget. -.SH "const QSize & QResizeEvent::size () const" -Returns the new size of the widget, which is the same as QWidget::size(). -.PP -Examples: -.)l chart/canvasview.cpp and life/life.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qresizeevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qresizeevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qscreen.3qt b/doc/man/man3/qscreen.3qt deleted file mode 100644 index 202ff372f..000000000 --- a/doc/man/man3/qscreen.3qt +++ /dev/null @@ -1,329 +0,0 @@ -'\" t -.TH QScreen 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 -QScreen \- And its descendants manage the framebuffer and palette -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQScreen\fR ( int display_id )" -.br -.ti -1c -.BI "virtual \fB~QScreen\fR ()" -.br -.ti -1c -.BI "virtual bool \fBinitDevice\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBconnect\fR ( const QString & displaySpec ) = 0" -.br -.ti -1c -.BI "virtual void \fBdisconnect\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBinitCursor\fR ( void * end_of_location, bool init = FALSE )" -.br -.ti -1c -.BI "virtual void \fBshutdownDevice\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetMode\fR ( int, int, int ) = 0" -.br -.ti -1c -.BI "virtual bool \fBsupportsDepth\fR ( int d ) const" -.br -.ti -1c -.BI "virtual QGfx * \fBcreateGfx\fR ( unsigned char * bytes, int w, int h, int d, int linestep )" -.br -.ti -1c -.BI "virtual QGfx * \fBscreenGfx\fR ()" -.br -.ti -1c -.BI "virtual void \fBsave\fR ()" -.br -.ti -1c -.BI "virtual void \fBrestore\fR ()" -.br -.ti -1c -.BI "virtual void \fBblank\fR ( bool on )" -.br -.ti -1c -.BI "virtual int \fBpixmapOffsetAlignment\fR ()" -.br -.ti -1c -.BI "virtual int \fBpixmapLinestepAlignment\fR ()" -.br -.ti -1c -.BI "virtual bool \fBonCard\fR ( unsigned char * p ) const" -.br -.ti -1c -.BI "virtual bool \fBonCard\fR ( unsigned char * p, ulong & offset ) const" -.br -.ti -1c -.BI "virtual void \fBset\fR ( unsigned " "int" ", unsigned " "int" ", unsigned " "int" ", unsigned int )" -.br -.ti -1c -.BI "virtual int \fBalloc\fR ( unsigned int r, unsigned int g, unsigned int b )" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "int \fBdepth\fR () const" -.br -.ti -1c -.BI "virtual int \fBpixmapDepth\fR () const" -.br -.ti -1c -.BI "int \fBpixelType\fR () const" -.br -.ti -1c -.BI "int \fBlinestep\fR () const" -.br -.ti -1c -.BI "int \fBdeviceWidth\fR () const" -.br -.ti -1c -.BI "int \fBdeviceHeight\fR () const" -.br -.ti -1c -.BI "uchar * \fBbase\fR () const" -.br -.ti -1c -.BI "virtual uchar * \fBcache\fR ( int, int )" -.br -.ti -1c -.BI "virtual void \fBuncache\fR ( uchar * )" -.br -.ti -1c -.BI "int \fBscreenSize\fR () const" -.br -.ti -1c -.BI "int \fBtotalSize\fR () const" -.br -.ti -1c -.BI "QRgb * \fBclut\fR ()" -.br -.ti -1c -.BI "int \fBnumCols\fR ()" -.br -.ti -1c -.BI "virtual QSize \fBmapToDevice\fR ( const QSize & s ) const" -.br -.ti -1c -.BI "virtual QSize \fBmapFromDevice\fR ( const QSize & s ) const" -.br -.ti -1c -.BI "virtual QPoint \fBmapToDevice\fR ( const QPoint &, const QSize & ) const" -.br -.ti -1c -.BI "virtual QPoint \fBmapFromDevice\fR ( const QPoint &, const QSize & ) const" -.br -.ti -1c -.BI "virtual QRect \fBmapToDevice\fR ( const QRect & r, const QSize & ) const" -.br -.ti -1c -.BI "virtual QRect \fBmapFromDevice\fR ( const QRect & r, const QSize & ) const" -.br -.ti -1c -.BI "virtual QImage \fBmapToDevice\fR ( const QImage & i ) const" -.br -.ti -1c -.BI "virtual QImage \fBmapFromDevice\fR ( const QImage & i ) const" -.br -.ti -1c -.BI "virtual QRegion \fBmapToDevice\fR ( const QRegion & r, const QSize & ) const" -.br -.ti -1c -.BI "virtual QRegion \fBmapFromDevice\fR ( const QRegion & r, const QSize & ) const" -.br -.ti -1c -.BI "virtual int \fBtransformOrientation\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisTransformed\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisInterlaced\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDirty\fR ( const QRect & )" -.br -.ti -1c -.BI "int * \fBopType\fR ()" -.br -.ti -1c -.BI "int * \fBlastOp\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QScreen class and its descendants manage the framebuffer and palette. -.PP -QScreens act as factories for the screen cursor and QGfx's. QLinuxFbScreen manages a Linux framebuffer; accelerated drivers subclass QLinuxFbScreen. There can only be one screen in a Qt/Embedded application. -.PP -See also Qt/Embedded. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QScreen::QScreen ( int display_id )" -Create a screen; the \fIdisplay_id\fR is the number of the Qt/Embedded server to connect to. -.SH "QScreen::~QScreen ()\fC [virtual]\fR" -Destroys a QScreen -.SH "int QScreen::alloc ( unsigned int r, unsigned int g, unsigned int b )\fC [virtual]\fR" -Given an RGB value \fIr\fR \fIg\fR \fIb\fR, return an index which is the closest match to it in the screen's palette. Used in paletted modes only. -.SH "uchar * QScreen::base () const" -Returns a pointer to the start of the framebuffer. -.SH "void QScreen::blank ( bool on )\fC [virtual]\fR" -If \fIon\fR is true, blank the screen. Otherwise unblank it. -.SH "uchar * QScreen::cache ( int, int )\fC [virtual]\fR" -This function is used to store pixmaps in graphics memory for the use of the accelerated drivers. See QLinuxFbScreen (where the cacheing is implemented) for more information. -.SH "QRgb * QScreen::clut ()" -Returns the screen's color lookup table (color palette). This is only valid in paletted modes (8bpp and lower). -.SH "bool QScreen::connect ( const QString & displaySpec )\fC [pure virtual]\fR" -This function is called by every Qt/Embedded application on startup. It maps in the framebuffer and in the accelerated drivers the graphics card control registers. \fIdisplaySpec\fR has the following syntax: -.PP -\fC[gfx driver][:driver specific options][:display number]\fR -.PP -for example if you want to use the mach64 driver on fb1 as display 2: -.PP -\fCMach64:/dev/fb1:2\fR -.PP -\fIdisplaySpec\fR is passed in via the QWS_DISPLAY environment variable or the -display command line parameter. -.SH "QGfx * QScreen::createGfx ( unsigned char * bytes, int w, int h, int d, int linestep )\fC [virtual]\fR" -Creates a gfx on an arbitrary buffer \fIbytes\fR, width \fIw\fR and height \fIh\fR in pixels, depth \fId\fR and \fIlinestep\fR (length in bytes of each line in the buffer). Accelerated drivers can check to see if \fIbytes\fR points into graphics memory and create an accelerated Gfx. -.SH "int QScreen::depth () const" -Gives the depth in bits per pixel of the framebuffer. This is the number of bits each pixel takes up rather than the number of significant bits, so 24bpp and 32bpp express the same range of colors (8 bits of red, green and blue) -.SH "int QScreen::deviceHeight () const" -Gives the full height of the framebuffer device, as opposed to the height which Qt/Embedded will actually use. These can differ if the display is centered within the framebuffer. -.SH "int QScreen::deviceWidth () const" -Gives the full width of the framebuffer device, as opposed to the width which Qt/Embedded will actually use. These can differ if the display is centered within the framebuffer. -.SH "void QScreen::disconnect ()\fC [pure virtual]\fR" -This function is called by every Qt/Embedded application just before exitting; it's normally used to unmap the framebuffer. -.SH "int QScreen::height () const" -Gives the height in pixels of the framebuffer. -.SH "int QScreen::initCursor ( void * end_of_location, bool init = FALSE )\fC [virtual]\fR" -This is used to initialize the software cursor - \fIend_of_location\fR points to the address after the area where the cursor image can be stored. \fIinit\fR is true for the first application this method is called from (the Qt/Embedded server), false otherwise. -.SH "bool QScreen::initDevice ()\fC [pure virtual]\fR" -This function is called by the Qt/Embedded server when initializing the framebuffer. Accelerated drivers use it to set up the graphics card. -.SH "bool QScreen::isInterlaced () const\fC [virtual]\fR" -Returns TRUE if the display is interlaced (for instance a television screen); otherwise returns FALSE. If TRUE, drawing is altered to look better on such displays. -.SH "bool QScreen::isTransformed () const\fC [virtual]\fR" -Returns TRUE if the screen is transformed (for instance, rotated 90 degrees); otherwise returns FALSE. QScreen's version always returns FALSE. -.SH "int * QScreen::lastOp ()" -Returns the screens last operation. -.SH "int QScreen::linestep () const" -Returns the length in bytes of each scanline of the framebuffer. -.SH "QSize QScreen::mapFromDevice ( const QSize & s ) const\fC [virtual]\fR" -Map a framebuffer coordinate to the coordinate space used by the application. Used by the rotated driver; the QScreen implementation simply returns \fIs\fR. -.SH "QPoint QScreen::mapFromDevice ( const QPoint &, const QSize & ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Map a framebuffer coordinate to the coordinate space used by the application. Used by the rotated driver; the QScreen implementation simply returns the point. -.SH "QRect QScreen::mapFromDevice ( const QRect & r, const QSize & ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Map a framebuffer coordinate to the coordinate space used by the application. Used by the rotated driver; the QScreen implementation simply returns \fIr\fR. -.SH "QImage QScreen::mapFromDevice ( const QImage & i ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Transforms an image so that it matches the application coordinate space (e.g. rotating it 90 degrees counter-clockwise). The QScreen implementation simply returns \fIi\fR. -.SH "QRegion QScreen::mapFromDevice ( const QRegion & r, const QSize & ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Transforms a region so that it matches the application coordinate space (e.g. rotating it 90 degrees counter-clockwise). The QScreen implementation simply returns \fIr\fR. -.SH "QSize QScreen::mapToDevice ( const QSize & s ) const\fC [virtual]\fR" -Map a user coordinate to the one to actually draw. Used by the rotated driver; the QScreen implementation simply returns \fIs\fR. -.SH "QPoint QScreen::mapToDevice ( const QPoint &, const QSize & ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Map a user coordinate to the one to actually draw. Used by the rotated driver; the QScreen implementation simply returns the point passed in. -.SH "QRect QScreen::mapToDevice ( const QRect & r, const QSize & ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Map a user coordinate to the one to actually draw. Used by the rotated driver; the QScreen implementation simply returns \fIr\fR. -.SH "QImage QScreen::mapToDevice ( const QImage & i ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Transforms an image so that it fits the device coordinate space (e.g. rotating it 90 degrees clockwise). The QScreen implementation simply returns \fIi\fR. -.SH "QRegion QScreen::mapToDevice ( const QRegion & r, const QSize & ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Transforms a region so that it fits the device coordinate space (e.g. rotating it 90 degrees clockwise). The QScreen implementation simply returns \fIr\fR. -.SH "int QScreen::numCols ()" -Returns the number of entries in the color table returned by clut(). -.SH "bool QScreen::onCard ( unsigned char * p ) const\fC [virtual]\fR" -Returns true if the buffer pointed to by \fIp\fR is within graphics card memory, false if it's in main RAM. -.SH "bool QScreen::onCard ( unsigned char * p, ulong & offset ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This checks whether the buffer specified by \fIp\fR is on the card (as per the other version of onCard) and returns an offset in bytes from the start of graphics card memory in \fIoffset\fR if it is. -.SH "int * QScreen::opType ()" -Returns the screen's operation type. -.SH "int QScreen::pixelType () const" -Returns an integer (taking the same values as QGfx::PixelType) that specifies the pixel storage format of the screen. -.SH "int QScreen::pixmapDepth () const\fC [virtual]\fR" -Gives the preferred depth for pixmaps. By default this is the same as the screen depth, but for the VGA16 driver it's 8bpp. -.SH "int QScreen::pixmapLinestepAlignment ()\fC [virtual]\fR" -Returns the value in bits to which individual scanlines of pixmaps held in graphics card memory should be aligned. This is only useful for accelerated drivers. By default the value returned is 64 but it can be overridden by individual accelerated drivers. -.SH "int QScreen::pixmapOffsetAlignment ()\fC [virtual]\fR" -Returns the value in bits to which the start address of pixmaps held in graphics card memory should be aligned. This is only useful for accelerated drivers. By default the value returned is 64 but it can be overridden by individual accelerated drivers. -.SH "void QScreen::restore ()\fC [virtual]\fR" -Restores the state of the graphics card from a previous save() -.SH "void QScreen::save ()\fC [virtual]\fR" -Saves the state of the graphics card - used so that, for instance, the palette can be restored when switching between linux virtual consoles. Hardware QScreen descendants should save register state here if necessary if switching between virtual consoles (for example to/from X) is to be permitted. -.SH "QGfx * QScreen::screenGfx ()\fC [virtual]\fR" -Returns a QGfx (normally a QGfxRaster) initialized to point to the screen, with an origin at 0,0 and a clip region covering the whole screen. -.SH "int QScreen::screenSize () const" -Returns the size in bytes of the screen. This is always located at the beginning of framebuffer memory (i.e. at base()). -.SH "void QScreen::set ( unsigned int, unsigned int, unsigned int, unsigned int )\fC [virtual]\fR" -Sets an entry in the color palette. -.SH "void QScreen::setDirty ( const QRect & )\fC [virtual]\fR" -Indicates which section of the screen has been altered. Used by the VNC and VFB displays; the QScreen version does nothing. -.SH "void QScreen::setMode ( int, int, int )\fC [pure virtual]\fR" -This function can be used to set the framebuffer width, height and depth. It's currently unused. -.SH "void QScreen::shutdownDevice ()\fC [virtual]\fR" -Called by the Qt/Embedded server on shutdown; never called by a Qt/Embedded client. This is intended to support graphics card specific shutdown; the unaccelerated implementation simply hides the mouse cursor. -.SH "bool QScreen::supportsDepth ( int d ) const\fC [virtual]\fR" -Returns true if the screen supports a particular color depth \fId\fR. Possible values are 1,4,8,16 and 32. -.SH "int QScreen::totalSize () const" -Returns the size in bytes of available graphics card memory, including the screen. Offscreen memory is only used by the accelerated drivers. -.SH "int QScreen::transformOrientation () const\fC [virtual]\fR" -Used by the rotated server. The QScreeen implementation returns 0. -.SH "void QScreen::uncache ( uchar * )\fC [virtual]\fR" -This function is called on pixmap destruction to remove them from graphics card memory. -.SH "int QScreen::width () const" -Gives the width in pixels of the framebuffer. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qscreen.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qscreen.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qscrollbar.3qt b/doc/man/man3/qscrollbar.3qt deleted file mode 100644 index 378de0069..000000000 --- a/doc/man/man3/qscrollbar.3qt +++ /dev/null @@ -1,360 +0,0 @@ -'\" t -.TH QScrollBar 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 -QScrollBar \- Vertical or horizontal scroll bar -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget and QRangeControl. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQScrollBar\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQScrollBar\fR ( Orientation orientation, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQScrollBar\fR ( int minValue, int maxValue, int lineStep, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QScrollBar\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetOrientation\fR ( Orientation )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTracking\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBtracking\fR () const" -.br -.ti -1c -.BI "bool \fBdraggingSlider\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPalette\fR ( const QPalette & p )" -.br -.ti -1c -.BI "int \fBminValue\fR () const" -.br -.ti -1c -.BI "int \fBmaxValue\fR () const" -.br -.ti -1c -.BI "void \fBsetMinValue\fR ( int )" -.br -.ti -1c -.BI "void \fBsetMaxValue\fR ( int )" -.br -.ti -1c -.BI "int \fBlineStep\fR () const" -.br -.ti -1c -.BI "int \fBpageStep\fR () const" -.br -.ti -1c -.BI "void \fBsetLineStep\fR ( int )" -.br -.ti -1c -.BI "void \fBsetPageStep\fR ( int )" -.br -.ti -1c -.BI "int \fBvalue\fR () const" -.br -.ti -1c -.BI "int \fBsliderStart\fR () const" -.br -.ti -1c -.BI "QRect \fBsliderRect\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBsetValue\fR ( int )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBvalueChanged\fR ( int value )" -.br -.ti -1c -.BI "void \fBsliderPressed\fR ()" -.br -.ti -1c -.BI "void \fBsliderMoved\fR ( int value )" -.br -.ti -1c -.BI "void \fBsliderReleased\fR ()" -.br -.ti -1c -.BI "void \fBnextLine\fR ()" -.br -.ti -1c -.BI "void \fBprevLine\fR ()" -.br -.ti -1c -.BI "void \fBnextPage\fR ()" -.br -.ti -1c -.BI "void \fBprevPage\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBdraggingSlider\fR - whether the user has clicked the mouse on the slider and is currently dragging it \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBlineStep\fR - the line step" -.br -.ti -1c -.BI "int \fBmaxValue\fR - the scroll bar's maximum value" -.br -.ti -1c -.BI "int \fBminValue\fR - the scroll bar's minimum value" -.br -.ti -1c -.BI "Orientation \fBorientation\fR - the orientation of the scroll bar" -.br -.ti -1c -.BI "int \fBpageStep\fR - the page step" -.br -.ti -1c -.BI "bool \fBtracking\fR - whether scroll bar tracking is enabled" -.br -.ti -1c -.BI "int \fBvalue\fR - the scroll bar's value" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBhideEvent\fR ( QHideEvent * )" -.br -.in -1c -.SH DESCRIPTION -The QScrollBar widget provides a vertical or horizontal scroll bar. -.PP -A scroll bar allows the user to control a value within a program-definable range and gives users a visible indication of the current value of a range control. -.PP -Scroll bars include four separate controls: -.IP -.TP -The \fIline-up\fR and \fIline-down\fR controls are little buttons which the user can use to move one "line" up or down. The meaning of line is configurable. In editors and list boxes it means one line of text; in an image viewer it might mean 20 pixels. -.IP -.TP -The \fIslider\fR is the handle that indicates the current value of the scroll bar, which the user can drag to change the value. This part of the scroll bar is sometimes called the "thumb". -.IP -.TP -The \fIpage-up/page-down\fR control is the area on which the slider slides (the scroll bar's background). Clicking here moves the scroll bar towards the click. The meaning of "page" is also configurable: in editors and list boxes it means as many lines as there is space for in the widget. -.IP -.PP -QScrollBar has very few of its own functions; it mostly relies on QRangeControl. The most useful functions are setValue() to set the scroll bar directly to some value; addPage(), addLine(), subtractPage(), and subtractLine() to simulate the effects of clicking (useful for accelerator keys); setSteps() to define the values of pageStep() and lineStep(); and setRange() to set the minValue() and maxValue() of the scroll bar. QScrollBar has a convenience constructor with which you can set most of these properties. -.PP -Some GUI styles (for example, the Windows and Motif styles provided with Qt), also use the pageStep() value to calculate the size of the slider. -.PP -In addition to the access functions from QRangeControl, QScrollBar provides a comprehensive set of signals:
                                            .nf -.TS -l - l. Signal Emitted when valueChanged() the scroll bar's value has changed. The tracking() determines whether this signal is emitted during user interaction. sliderPressed() the user starts to drag the slider. sliderMoved() the user drags the slider. sliderReleased() the user releases the slider. nextLine() the scroll bar has moved one line down or right. Line is defined in QRangeControl. prevLine() the scroll bar has moved one line up or left. nextPage() the scroll bar has moved one page down or right. prevPage() -.TE -.fi -
                                            -.PP -QScrollBar only provides integer ranges. Note that although QScrollBar handles very large numbers, scroll bars on current screens cannot usefully control ranges above about 100,000 pixels. Beyond that, it becomes difficult for the user to control the scroll bar using either the keyboard or the mouse. -.PP -A scroll bar can be controlled by the keyboard, but it has a default focusPolicy() of NoFocus. Use setFocusPolicy() to enable keyboard focus. See keyPressEvent() for a list of key bindings. -.PP -If you need to add scroll bars to an interface, consider using the QScrollView class, which encapsulates the common uses for scroll bars. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QSlider, QSpinBox, QScrollView, GUI Design Handbook: Scroll Bar, and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QScrollBar::QScrollBar ( QWidget * parent, const char * name = 0 )" -Constructs a vertical scroll bar. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.PP -The minValue defaults to 0, the maxValue to 99, with a lineStep size of 1 and a pageStep size of 10, and an initial value of 0. -.SH "QScrollBar::QScrollBar ( Orientation orientation, QWidget * parent, const char * name = 0 )" -Constructs a scroll bar. -.PP -The \fIorientation\fR must be Qt::Vertical or Qt::Horizontal. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.PP -The minValue defaults to 0, the maxValue to 99, with a lineStep size of 1 and a pageStep size of 10, and an initial value of 0. -.SH "QScrollBar::QScrollBar ( int minValue, int maxValue, int lineStep, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" -Constructs a scroll bar whose value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR, whose line step size is \fIlineStep\fR and page step size is \fIpageStep\fR and whose value is initially \fIvalue\fR (which is guaranteed to be in range using bound()). -.PP -If \fIorientation\fR is Vertical the scroll bar is vertical and if it is Horizontal the scroll bar is horizontal. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.SH "QScrollBar::~QScrollBar ()" -Destructor. -.SH "bool QScrollBar::draggingSlider () const" -Returns TRUE if the user has clicked the mouse on the slider and is currently dragging it; otherwise returns FALSE. See the "draggingSlider" property for details. -.SH "void QScrollBar::hideEvent ( QHideEvent * )\fC [virtual protected]\fR" -This function is called when the scrollbar is hidden. -.PP -Reimplemented from QWidget. -.SH "int QScrollBar::lineStep () const" -Returns the line step. See the "lineStep" property for details. -.SH "int QScrollBar::maxValue () const" -Returns the scroll bar's maximum value. See the "maxValue" property for details. -.SH "int QScrollBar::minValue () const" -Returns the scroll bar's minimum value. See the "minValue" property for details. -.SH "void QScrollBar::nextLine ()\fC [signal]\fR" -This signal is emitted when the scroll bar scrolls one line down or right. -.SH "void QScrollBar::nextPage ()\fC [signal]\fR" -This signal is emitted when the scroll bar scrolls one page down or right. -.SH "Orientation QScrollBar::orientation () const" -Returns the orientation of the scroll bar. See the "orientation" property for details. -.SH "int QScrollBar::pageStep () const" -Returns the page step. See the "pageStep" property for details. -.SH "void QScrollBar::prevLine ()\fC [signal]\fR" -This signal is emitted when the scroll bar scrolls one line up or left. -.SH "void QScrollBar::prevPage ()\fC [signal]\fR" -This signal is emitted when the scroll bar scrolls one page up or left. -.SH "void QScrollBar::setLineStep ( int )" -Sets the line step. See the "lineStep" property for details. -.SH "void QScrollBar::setMaxValue ( int )" -Sets the scroll bar's maximum value. See the "maxValue" property for details. -.SH "void QScrollBar::setMinValue ( int )" -Sets the scroll bar's minimum value. See the "minValue" property for details. -.SH "void QScrollBar::setOrientation ( Orientation )\fC [virtual]\fR" -Sets the orientation of the scroll bar. See the "orientation" property for details. -.SH "void QScrollBar::setPageStep ( int )" -Sets the page step. See the "pageStep" property for details. -.SH "void QScrollBar::setPalette ( const QPalette & p )\fC [virtual]\fR" -Reimplements the virtual function QWidget::setPalette(). -.PP -Sets the background color to the mid color for Motif style scroll bars using palette \fIp\fR. -.PP -Reimplemented from QWidget. -.SH "void QScrollBar::setTracking ( bool enable )\fC [virtual]\fR" -Sets whether scroll bar tracking is enabled to \fIenable\fR. See the "tracking" property for details. -.SH "void QScrollBar::setValue ( int )\fC [slot]\fR" -Sets the scroll bar's value. See the "value" property for details. -.SH "void QScrollBar::sliderMoved ( int value )\fC [signal]\fR" -This signal is emitted when the slider is dragged by the user, with the new scroll bar \fIvalue\fR as an argument. -.PP -This signal is emitted even when tracking is turned off. -.PP -See also tracking, valueChanged(), nextLine(), prevLine(), nextPage(), and prevPage(). -.SH "void QScrollBar::sliderPressed ()\fC [signal]\fR" -This signal is emitted when the user presses the slider with the mouse. -.SH "QRect QScrollBar::sliderRect () const" -Returns the scroll bar slider rectangle. -.PP -See also sliderStart(). -.SH "void QScrollBar::sliderReleased ()\fC [signal]\fR" -This signal is emitted when the user releases the slider with the mouse. -.SH "int QScrollBar::sliderStart () const" -Returns the pixel position where the scroll bar slider starts. -.PP -This is equivalent to sliderRect().y() for vertical scroll bars or sliderRect().x() for horizontal scroll bars. -.SH "bool QScrollBar::tracking () const" -Returns TRUE if scroll bar tracking is enabled; otherwise returns FALSE. See the "tracking" property for details. -.SH "int QScrollBar::value () const" -Returns the scroll bar's value. See the "value" property for details. -.SH "void QScrollBar::valueChanged ( int value )\fC [signal]\fR" -This signal is emitted when the scroll bar value has changed, with the new scroll bar \fIvalue\fR as an argument. -.SS "Property Documentation" -.SH "bool draggingSlider" -This property holds whether the user has clicked the mouse on the slider and is currently dragging it. -.PP -Get this property's value with draggingSlider(). -.SH "int lineStep" -This property holds the line step. -.PP -When setting lineStep, the virtual stepChange() function will be called if the new line step is different from the previous setting. -.PP -See also setSteps(), QRangeControl::pageStep(), and setRange(). -.PP -Set this property's value with setLineStep() and get this property's value with lineStep(). -.SH "int maxValue" -This property holds the scroll bar's maximum value. -.PP -When setting this property, the QScrollBar::minValue is adjusted if necessary to ensure that the range remains valid. -.PP -See also setRange(). -.PP -Set this property's value with setMaxValue() and get this property's value with maxValue(). -.SH "int minValue" -This property holds the scroll bar's minimum value. -.PP -When setting this property, the QScrollBar::maxValue is adjusted if necessary to ensure that the range remains valid. -.PP -See also setRange(). -.PP -Set this property's value with setMinValue() and get this property's value with minValue(). -.SH "Orientation orientation" -This property holds the orientation of the scroll bar. -.PP -The orientation must be Qt::Vertical (the default) or Qt::Horizontal. -.PP -Set this property's value with setOrientation() and get this property's value with orientation(). -.SH "int pageStep" -This property holds the page step. -.PP -When setting pageStep, the virtual stepChange() function will be called if the new page step is different from the previous setting. -.PP -See also QRangeControl::setSteps(), lineStep, and setRange(). -.PP -Set this property's value with setPageStep() and get this property's value with pageStep(). -.SH "bool tracking" -This property holds whether scroll bar tracking is enabled. -.PP -If tracking is enabled (the default), the scroll bar emits the valueChanged() signal while the slider is being dragged. If tracking is disabled, the scroll bar emits the valueChanged() signal only when the user releases the mouse button after moving the slider. -.PP -Set this property's value with setTracking() and get this property's value with tracking(). -.SH "int value" -This property holds the scroll bar's value. -.PP -Set this property's value with setValue() and get this property's value with value(). -.PP -See also QRangeControl::value() and prevValue(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqscrollbar.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qscrollbar.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qscrollview.3qt b/doc/man/man3/qscrollview.3qt deleted file mode 100644 index c44ae2b01..000000000 --- a/doc/man/man3/qscrollview.3qt +++ /dev/null @@ -1,913 +0,0 @@ -'\" t -.TH QScrollView 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 -QScrollView \- Scrolling area with on-demand scroll bars -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -Inherited by QCanvasView, QTable, QGridView, QIconView, QListBox, QListView, and QTextEdit. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQScrollView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QScrollView\fR ()" -.br -.ti -1c -.BI "enum \fBResizePolicy\fR { Default, Manual, AutoOne, AutoOneFit }" -.br -.ti -1c -.BI "virtual void \fBsetResizePolicy\fR ( ResizePolicy )" -.br -.ti -1c -.BI "ResizePolicy \fBresizePolicy\fR () const" -.br -.ti -1c -.BI "void \fBremoveChild\fR ( QWidget * child )" -.br -.ti -1c -.BI "virtual void \fBaddChild\fR ( QWidget * child, int x = 0, int y = 0 )" -.br -.ti -1c -.BI "virtual void \fBmoveChild\fR ( QWidget * child, int x, int y )" -.br -.ti -1c -.BI "int \fBchildX\fR ( QWidget * child )" -.br -.ti -1c -.BI "int \fBchildY\fR ( QWidget * child )" -.br -.ti -1c -.BI "bool childIsVisible ( QWidget * child ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void showChild ( QWidget * child, bool y = TRUE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "enum \fBScrollBarMode\fR { Auto, AlwaysOff, AlwaysOn }" -.br -.ti -1c -.BI "ScrollBarMode \fBvScrollBarMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetVScrollBarMode\fR ( ScrollBarMode )" -.br -.ti -1c -.BI "ScrollBarMode \fBhScrollBarMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetHScrollBarMode\fR ( ScrollBarMode )" -.br -.ti -1c -.BI "QWidget * \fBcornerWidget\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCornerWidget\fR ( QWidget * corner )" -.br -.ti -1c -.BI "QScrollBar * \fBhorizontalScrollBar\fR () const" -.br -.ti -1c -.BI "QScrollBar * \fBverticalScrollBar\fR () const" -.br -.ti -1c -.BI "QWidget * \fBviewport\fR () const" -.br -.ti -1c -.BI "QWidget * \fBclipper\fR () const" -.br -.ti -1c -.BI "int \fBvisibleWidth\fR () const" -.br -.ti -1c -.BI "int \fBvisibleHeight\fR () const" -.br -.ti -1c -.BI "int \fBcontentsWidth\fR () const" -.br -.ti -1c -.BI "int \fBcontentsHeight\fR () const" -.br -.ti -1c -.BI "int \fBcontentsX\fR () const" -.br -.ti -1c -.BI "int \fBcontentsY\fR () const" -.br -.ti -1c -.BI "void \fBupdateContents\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBupdateContents\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBupdateContents\fR ()" -.br -.ti -1c -.BI "void \fBrepaintContents\fR ( int x, int y, int w, int h, bool erase = TRUE )" -.br -.ti -1c -.BI "void \fBrepaintContents\fR ( const QRect & r, bool erase = TRUE )" -.br -.ti -1c -.BI "void \fBrepaintContents\fR ( bool erase = TRUE )" -.br -.ti -1c -.BI "void \fBcontentsToViewport\fR ( int x, int y, int & vx, int & vy ) const" -.br -.ti -1c -.BI "void \fBviewportToContents\fR ( int vx, int vy, int & x, int & y ) const" -.br -.ti -1c -.BI "QPoint \fBcontentsToViewport\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "QPoint \fBviewportToContents\fR ( const QPoint & vp ) const" -.br -.ti -1c -.BI "void \fBenableClipper\fR ( bool y )" -.br -.ti -1c -.BI "void \fBsetStaticBackground\fR ( bool y )" -.br -.ti -1c -.BI "bool \fBhasStaticBackground\fR () const" -.br -.ti -1c -.BI "QSize \fBviewportSize\fR ( int x, int y ) const" -.br -.ti -1c -.BI "bool \fBisHorizontalSliderPressed\fR ()" -.br -.ti -1c -.BI "bool \fBisVerticalSliderPressed\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetDragAutoScroll\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBdragAutoScroll\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBresizeContents\fR ( int w, int h )" -.br -.ti -1c -.BI "void \fBscrollBy\fR ( int dx, int dy )" -.br -.ti -1c -.BI "virtual void \fBsetContentsPos\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBensureVisible\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBensureVisible\fR ( int x, int y, int xmargin, int ymargin )" -.br -.ti -1c -.BI "void \fBcenter\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBcenter\fR ( int x, int y, float xmargin, float ymargin )" -.br -.ti -1c -.BI "void \fBupdateScrollBars\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBcontentsMoving\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBhorizontalSliderPressed\fR ()" -.br -.ti -1c -.BI "void \fBhorizontalSliderReleased\fR ()" -.br -.ti -1c -.BI "void \fBverticalSliderPressed\fR ()" -.br -.ti -1c -.BI "void \fBverticalSliderReleased\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBcontentsHeight\fR - the height of the contents area \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcontentsWidth\fR - the width of the contents area \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcontentsX\fR - the X coordinate of the contents that are at the left edge of the viewport \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcontentsY\fR - the Y coordinate of the contents that are at the top edge of the viewport \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBdragAutoScroll\fR - whether autoscrolling in drag move events is enabled" -.br -.ti -1c -.BI "ScrollBarMode \fBhScrollBarMode\fR - the mode for the horizontal scroll bar" -.br -.ti -1c -.BI "ResizePolicy \fBresizePolicy\fR - the resize policy" -.br -.ti -1c -.BI "ScrollBarMode \fBvScrollBarMode\fR - the mode for the vertical scroll bar" -.br -.ti -1c -.BI "int \fBvisibleHeight\fR - the vertical amount of the content that is visible \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBvisibleWidth\fR - the horizontal amount of the content that is visible \fI(read " "only" ")\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * p, int clipx, int clipy, int clipw, int cliph )" -.br -.ti -1c -.BI "virtual void \fBdrawContentsOffset\fR ( QPainter * p, int offsetx, int offsety, int clipx, int clipy, int clipw, int cliph )" -.br -.ti -1c -.BI "virtual void \fBcontentsMousePressEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsMouseReleaseEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsMouseDoubleClickEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsMouseMoveEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsDragEnterEvent\fR ( QDragEnterEvent * )" -.br -.ti -1c -.BI "virtual void \fBcontentsDragMoveEvent\fR ( QDragMoveEvent * )" -.br -.ti -1c -.BI "virtual void \fBcontentsDragLeaveEvent\fR ( QDragLeaveEvent * )" -.br -.ti -1c -.BI "virtual void \fBcontentsDropEvent\fR ( QDropEvent * )" -.br -.ti -1c -.BI "virtual void \fBcontentsWheelEvent\fR ( QWheelEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsContextMenuEvent\fR ( QContextMenuEvent * e )" -.br -.ti -1c -.BI "virtual void \fBviewportPaintEvent\fR ( QPaintEvent * pe )" -.br -.ti -1c -.BI "virtual void \fBviewportResizeEvent\fR ( QResizeEvent * )" -.br -.ti -1c -.BI "virtual void \fBsetMargins\fR ( int left, int top, int right, int bottom )" -.br -.ti -1c -.BI "int \fBleftMargin\fR () const" -.br -.ti -1c -.BI "int \fBtopMargin\fR () const" -.br -.ti -1c -.BI "int \fBrightMargin\fR () const" -.br -.ti -1c -.BI "int \fBbottomMargin\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetHBarGeometry\fR ( QScrollBar & hbar, int x, int y, int w, int h )" -.br -.ti -1c -.BI "virtual void \fBsetVBarGeometry\fR ( QScrollBar & vbar, int x, int y, int w, int h )" -.br -.ti -1c -.BI "virtual bool \fBeventFilter\fR ( QObject * obj, QEvent * e )" -.br -.in -1c -.SH DESCRIPTION -The QScrollView widget provides a scrolling area with on-demand scroll bars. -.PP -The QScrollView is a large canvas - potentially larger than the coordinate system normally supported by the underlying window system. This is important because it is quite easy to go beyond these limitations (e.g. many web pages are more than 32000 pixels high). Additionally, the QScrollView can have QWidgets positioned on it that scroll around with the drawn content. These sub-widgets can also have positions outside the normal coordinate range (but they are still limited in size). -.PP -To provide content for the widget, inherit from QScrollView, reimplement drawContents() and use resizeContents() to set the size of the viewed area. Use addChild() and moveChild() to position widgets on the view. -.PP -To use QScrollView effectively it is important to understand its widget structure in the three styles of use: a single large child widget, a large panning area with some widgets and a large panning area with many widgets. -.SH "Using One Big Widget" -
                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                            -.PP -The first, simplest usage of QScrollView (depicted above), is appropriate for scrolling areas that are never more than about 4000 pixels in either dimension (this is about the maximum reliable size on X11 servers). In this usage, you just make one large child in the QScrollView. The child should be a child of the viewport() of the scrollview and be added with addChild(): -.PP -.nf -.br - QScrollView* sv = new QScrollView(...); -.br - QVBox* big_box = new QVBox(sv->viewport()); -.br - sv->addChild(big_box); -.br -.fi -You can go on to add arbitrary child widgets to the single child in the scrollview as you would with any widget: -.PP -.nf -.br - QLabel* child1 = new QLabel("CHILD", big_box); -.br - QLabel* child2 = new QLabel("CHILD", big_box); -.br - QLabel* child3 = new QLabel("CHILD", big_box); -.br - ... -.br -.fi -.PP -Here the QScrollView has four children: the viewport(), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The viewport() has one child: the big QVBox. The QVBox has the three QLabel objects as child widgets. When the view is scrolled, the QVBox is moved; its children move with it as child widgets normally do. -.SH "Using a Very Big View with Some Widgets" -
                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                            -.PP -The second usage of QScrollView (depicted above) is appropriate when few, if any, widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You may also add some widgets by making them children of the viewport() and adding them with addChild() (this is the same as the process for the single large widget in the previous example): -.PP -.nf -.br - QScrollView* sv = new QScrollView(...); -.br - QLabel* child1 = new QLabel("CHILD", sv->viewport()); -.br - sv->addChild(child1); -.br - QLabel* child2 = new QLabel("CHILD", sv->viewport()); -.br - sv->addChild(child2); -.br - QLabel* child3 = new QLabel("CHILD", sv->viewport()); -.br - sv->addChild(child3); -.br -.fi -Here, the QScrollView has the same four children: the viewport(), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The viewport() has the three QLabel objects as child widgets. When the view is scrolled, the scrollview moves the child widgets individually. -.SH "Using a Very Big View with Many Widgets" -
                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                            -.PP -The final usage of QScrollView (depicted above) is appropriate when many widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You then call enableClipper(TRUE) and add widgets, again by making them children of the viewport(), and adding them with addChild(): -.PP -.nf -.br - QScrollView* sv = new QScrollView(...); -.br - sv->enableClipper(TRUE); -.br - QLabel* child1 = new QLabel("CHILD", sv->viewport()); -.br - sv->addChild(child1); -.br - QLabel* child2 = new QLabel("CHILD", sv->viewport()); -.br - sv->addChild(child2); -.br - QLabel* child3 = new QLabel("CHILD", sv->viewport()); -.br - sv->addChild(child3); -.br -.fi -.PP -Here, the QScrollView has four children: the clipper() (not the viewport() this time), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The clipper() has one child: the viewport(). The viewport() has the same three labels as child widgets. When the view is scrolled the viewport() is moved; its children move with it as child widgets normally do. -.SH "Details Relevant for All Views" -Normally you will use the first or third method if you want any child widgets in the view. -.PP -Note that the widget you see in the scrolled area is the viewport() widget, not the QScrollView itself. So to turn mouse tracking on, for example, use viewport()->setMouseTracking(TRUE). -.PP -To enable drag-and-drop, you would setAcceptDrops(TRUE) on the QScrollView (because drag-and-drop events propagate to the parent). But to work out the logical position in the view, you would need to map the drop co-ordinate from being relative to the QScrollView to being relative to the contents; use the function viewportToContents() for this. -.PP -To handle mouse events on the scrolling area, subclass scrollview as you would subclass other widgets, but rather than reimplementing mousePressEvent(), reimplement contentsMousePressEvent() instead. The contents specific event handlers provide translated events in the coordinate system of the scrollview. If you reimplement mousePressEvent(), you'll get called only when part of the QScrollView is clicked: and the only such part is the "corner" (if you don't set a cornerWidget()) and the frame; everything else is covered up by the viewport, clipper or scroll bars. -.PP -When you construct a QScrollView, some of the widget flags apply to the viewport() instead of being sent to the QWidget constructor for the QScrollView. This applies to WNoAutoErase, WStaticContents, and WPaintClever. See Qt::WidgetFlags for documentation about these flags. Here are some examples: -.IP -.TP -An image-manipulation widget would use \fCWNoAutoErase|WStaticContents\fR because the widget draws all pixels itself, and when its size increases, it only needs a paint event for the new part because the old part remains unchanged. -.IP -.TP -A scrolling game widget in which the background scrolls as the characters move might use WNoAutoErase (in addition to WStaticContents) so that the window system background does not flash in and out during scrolling. -.IP -.TP -A word processing widget might use WNoAutoErase and repaint itself line by line to get a less-flickery resizing. If the widget is in a mode in which no text justification can take place, it might use WStaticContents too, so that it would only get a repaint for the newly visible parts. -.IP -.PP -Child widgets may be moved using addChild() or moveChild(). Use childX() and childY() to get the position of a child widget. -.PP -A widget may be placed in the corner between the vertical and horizontal scrollbars with setCornerWidget(). You can get access to the scrollbars using horizontalScrollBar() and verticalScrollBar(), and to the viewport with viewport(). The scroll view can be scrolled using scrollBy(), ensureVisible(), setContentsPos() or center(). -.PP -The visible area is given by visibleWidth() and visibleHeight(), and the contents area by contentsWidth() and contentsHeight(). The contents may be repainted using one of the repaintContents() or updateContents() functions. -.PP -Coordinate conversion is provided by contentsToViewport() and viewportToContents(). -.PP -The contentsMoving() signal is emitted just before the contents are moved to a new position. -.PP -\fBWarning:\fR QScrollView currently does not erase the background when resized, i.e. you must always clear the background manually in scrollview subclasses. This will change in a future version of Qt and we recommend specifying the WNoAutoErase flag explicitly. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also Abstract Widget Classes. -.SS "Member Type Documentation" -.SH "QScrollView::ResizePolicy" -This enum type is used to control a QScrollView's reaction to resize events. -.TP -\fCQScrollView::Default\fR - the QScrollView selects one of the other settings automatically when it has to. In this version of Qt, QScrollView changes to Manual if you resize the contents with resizeContents() and to AutoOne if a child is added. -.TP -\fCQScrollView::Manual\fR - the contents stays the size set by resizeContents(). -.TP -\fCQScrollView::AutoOne\fR - if there is only one child widget the contents stays the size of that widget. Otherwise the behavior is undefined. -.TP -\fCQScrollView::AutoOneFit\fR - if there is only one child widget the contents stays the size of that widget's sizeHint(). If the scrollview is resized larger than the child's sizeHint(), the child will be resized to fit. If there is more than one child, the behavior is undefined. -.SH "QScrollView::ScrollBarMode" -This enum type describes the various modes of QScrollView's scroll bars. -.TP -\fCQScrollView::Auto\fR - QScrollView shows a scroll bar when the content is too large to fit and not otherwise. This is the default. -.TP -\fCQScrollView::AlwaysOff\fR - QScrollView never shows a scroll bar. -.TP -\fCQScrollView::AlwaysOn\fR - QScrollView always shows a scroll bar. -.PP -(The modes for the horizontal and vertical scroll bars are independent.) -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QScrollView::QScrollView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a QScrollView called \fIname\fR with parent \fIparent\fR and widget flags \fIf\fR. -.PP -The widget flags WStaticContents, WNoAutoErase and WPaintClever are propagated to the viewport() widget. The other widget flags are propagated to the parent constructor as usual. -.SH "QScrollView::~QScrollView ()" -Destroys the QScrollView. Any children added with addChild() will be deleted. -.SH "void QScrollView::addChild ( QWidget * child, int x = 0, int y = 0 )\fC [virtual]\fR" -Inserts the widget, \fIchild\fR, into the scrolled area positioned at (\fIx\fR, \fIy\fR). The position defaults to (0, 0). If the child is already in the view, it is just moved. -.PP -You may want to call enableClipper(TRUE) if you add a large number of widgets. -.PP -Example: scrollview/scrollview.cpp. -.SH "int QScrollView::bottomMargin () const\fC [protected]\fR" -Returns the bottom margin. -.PP -See also setMargins(). -.SH "void QScrollView::center ( int x, int y )\fC [slot]\fR" -Scrolls the content so that the point \fI(x, y)\fR is in the center of visible area. -.PP -Example: scrollview/scrollview.cpp. -.SH "void QScrollView::center ( int x, int y, float xmargin, float ymargin )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Scrolls the content so that the point \fI(x, y)\fR is visible with the \fIxmargin\fR and \fIymargin\fR margins (as fractions of visible the area). -.PP -For example: -.TP -Margin 0.0 allows (x, y) to be on the edge of the visible area. -.TP -Margin 0.5 ensures that (x, y) is in middle 50% of the visible area. -.TP -Margin 1.0 ensures that (x, y) is in the center of the the visible area. -.SH "bool QScrollView::childIsVisible ( QWidget * child )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if \fIchild\fR is visible. This is equivalent to child->isVisible(). -.SH "int QScrollView::childX ( QWidget * child )" -Returns the X position of the given \fIchild\fR widget. Use this rather than QWidget::x() for widgets added to the view. -.PP -This function returns 0 if \fIchild\fR has not been added to the view. -.SH "int QScrollView::childY ( QWidget * child )" -Returns the Y position of the given \fIchild\fR widget. Use this rather than QWidget::y() for widgets added to the view. -.PP -This function returns 0 if \fIchild\fR has not been added to the view. -.SH "QWidget * QScrollView::clipper () const" -Returns the clipper widget. Contents in the scrollview are ultimately clipped to be inside the clipper widget. -.PP -You should not need to use this function. -.PP -See also visibleWidth and visibleHeight. -.SH "void QScrollView::contentsContextMenuEvent ( QContextMenuEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a contextMenuEvent() in \fIe\fR: the mouse position is translated to be a point on the contents. -.PP -Example: chart/canvasview.cpp. -.SH "void QScrollView::contentsDragEnterEvent ( QDragEnterEvent * )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a dragEnterEvent(): the drag position is translated to be a point on the contents. -.PP -Reimplemented in QTable. -.SH "void QScrollView::contentsDragLeaveEvent ( QDragLeaveEvent * )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a dragLeaveEvent(): the drag position is translated to be a point on the contents. -.PP -Reimplemented in QTable. -.SH "void QScrollView::contentsDragMoveEvent ( QDragMoveEvent * )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a dragMoveEvent(): the drag position is translated to be a point on the contents. -.PP -Reimplemented in QTable. -.SH "void QScrollView::contentsDropEvent ( QDropEvent * )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a dropEvent(): the drop position is translated to be a point on the contents. -.PP -Reimplemented in QTable. -.SH "int QScrollView::contentsHeight () const" -Returns the height of the contents area. See the "contentsHeight" property for details. -.SH "void QScrollView::contentsMouseDoubleClickEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a mouseDoubleClickEvent(): the click position in \fIe\fR is translated to be a point on the contents. -.PP -The default implementation generates a normal mouse press event. -.PP -Reimplemented in QListView. -.SH "void QScrollView::contentsMouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a mouseMoveEvent(): the mouse position in \fIe\fR is translated to be a point on the contents. -.PP -Examples: -.)l canvas/canvas.cpp and chart/canvasview.cpp. -.PP -Reimplemented in QListView. -.SH "void QScrollView::contentsMousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a mousePressEvent(): the press position in \fIe\fR is translated to be a point on the contents. -.PP -Examples: -.)l canvas/canvas.cpp and chart/canvasview.cpp. -.PP -Reimplemented in QListView. -.SH "void QScrollView::contentsMouseReleaseEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a mouseReleaseEvent(): the release position in \fIe\fR is translated to be a point on the contents. -.PP -Reimplemented in QListView. -.SH "void QScrollView::contentsMoving ( int x, int y )\fC [signal]\fR" -This signal is emitted just before the contents are moved to position \fI(x, y)\fR. -.PP -See also contentsX and contentsY. -.SH "void QScrollView::contentsToViewport ( int x, int y, int & vx, int & vy ) const" -Translates a point (\fIx\fR, \fIy\fR) in the contents to a point (\fIvx\fR, \fIvy\fR) on the viewport() widget. -.SH "QPoint QScrollView::contentsToViewport ( const QPoint & p ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point \fIp\fR translated to a point on the viewport() widget. -.SH "void QScrollView::contentsWheelEvent ( QWheelEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever the QScrollView receives a wheelEvent() in \fIe\fR: the mouse position is translated to be a point on the contents. -.SH "int QScrollView::contentsWidth () const" -Returns the width of the contents area. See the "contentsWidth" property for details. -.SH "int QScrollView::contentsX () const" -Returns the X coordinate of the contents that are at the left edge of the viewport. See the "contentsX" property for details. -.SH "int QScrollView::contentsY () const" -Returns the Y coordinate of the contents that are at the top edge of the viewport. See the "contentsY" property for details. -.SH "QWidget * QScrollView::cornerWidget () const" -Returns the widget in the corner between the two scroll bars. -.PP -By default, no corner widget is present. -.PP -Example: scrollview/scrollview.cpp. -.SH "bool QScrollView::dragAutoScroll () const" -Returns TRUE if autoscrolling in drag move events is enabled; otherwise returns FALSE. See the "dragAutoScroll" property for details. -.SH "void QScrollView::drawContents ( QPainter * p, int clipx, int clipy, int clipw, int cliph )\fC [virtual protected]\fR" -Reimplement this function if you are viewing a drawing area rather than a widget. -.PP -The function should draw the rectangle (\fIclipx\fR, \fIclipy\fR, \fIclipw\fR, \fIcliph\fR) of the contents using painter \fIp\fR. The clip rectangle is in the scrollview's coordinates. -.PP -For example: -.PP -.nf -.br - { -.br - // Fill a 40000 by 50000 rectangle at (100000,150000) -.br -.br - // Calculate the coordinates... -.br - int x1 = 100000, y1 = 150000; -.br - int x2 = x1+40000-1, y2 = y1+50000-1; -.br -.br - // Clip the coordinates so X/Windows will not have problems... -.br - if (x1 < clipx) x1=clipx; -.br - if (y1 < clipy) y1=clipy; -.br - if (x2 > clipx+clipw-1) x2=clipx+clipw-1; -.br - if (y2 > clipy+cliph-1) y2=clipy+cliph-1; -.br -.br - // Paint using the small coordinates... -.br - if ( x2 >= x1 && y2 >= y1 ) -.br - p->fillRect(x1, y1, x2-x1+1, y2-y1+1, red); -.br - } -.br -.fi -.PP -The clip rectangle and translation of the painter \fIp\fR is already set appropriately. -.PP -Example: qdir/qdir.cpp. -.PP -Reimplemented in QCanvasView and QTable. -.SH "void QScrollView::drawContentsOffset ( QPainter * p, int offsetx, int offsety, int clipx, int clipy, int clipw, int cliph )\fC [virtual protected]\fR" -For backward-compatibility only. It is easier to use drawContents(QPainter*,int,int,int,int). -.PP -The default implementation translates the painter appropriately and calls drawContents(QPainter*,int,int,int,int). See drawContents() for an explanation of the parameters \fIp\fR, \fIoffsetx\fR, \fIoffsety\fR, \fIclipx\fR, \fIclipy\fR, \fIclipw\fR and \fIcliph\fR. -.PP -Reimplemented in QListView. -.SH "void QScrollView::enableClipper ( bool y )" -When a large numbers of child widgets are in a scrollview, especially if they are close together, the scrolling performance can suffer greatly. If \fIy\fR is TRUE the scrollview will use an extra widget to group child widgets. -.PP -Note that you may only call enableClipper() prior to adding widgets. -.PP -For a full discussion, see this class's detailed description. -.PP -Example: scrollview/scrollview.cpp. -.SH "void QScrollView::ensureVisible ( int x, int y )\fC [slot]\fR" -Scrolls the content so that the point \fI(x, y)\fR is visible with at least 50-pixel margins (if possible, otherwise centered). -.SH "void QScrollView::ensureVisible ( int x, int y, int xmargin, int ymargin )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Scrolls the content so that the point \fI(x, y)\fR is visible with at least the \fIxmargin\fR and \fIymargin\fR margins (if possible, otherwise centered). -.SH "bool QScrollView::eventFilter ( QObject * obj, QEvent * e )\fC [virtual protected]\fR" -This event filter ensures the scroll bars are updated when a single contents widget is resized, shown, hidden or destroyed; it passes mouse events to the QScrollView. The event is in \fIe\fR and the object is in \fIobj\fR. -.PP -Reimplemented from QObject. -.PP -Reimplemented in QListView. -.SH "ScrollBarMode QScrollView::hScrollBarMode () const" -Returns the mode for the horizontal scroll bar. See the "hScrollBarMode" property for details. -.SH "bool QScrollView::hasStaticBackground () const" -Returns TRUE if QScrollView uses a static background; otherwise returns FALSE. -.PP -See also setStaticBackground(). -.SH "QScrollBar * QScrollView::horizontalScrollBar () const" -Returns the component horizontal scroll bar. It is made available to allow accelerators, autoscrolling, etc. -.PP -It should not be used for other purposes. -.PP -This function never returns 0. -.SH "void QScrollView::horizontalSliderPressed ()\fC [signal]\fR" -This signal is emitted whenever the user presses the horizontal slider. -.SH "void QScrollView::horizontalSliderReleased ()\fC [signal]\fR" -This signal is emitted whenever the user releases the horizontal slider. -.SH "bool QScrollView::isHorizontalSliderPressed ()" -Returns TRUE if horizontal slider is pressed by user; otherwise returns FALSE. -.SH "bool QScrollView::isVerticalSliderPressed ()" -Returns TRUE if vertical slider is pressed by user; otherwise returns FALSE. -.SH "int QScrollView::leftMargin () const\fC [protected]\fR" -Returns the left margin. -.PP -See also setMargins(). -.SH "void QScrollView::moveChild ( QWidget * child, int x, int y )\fC [virtual]\fR" -Repositions the \fIchild\fR widget to (\fIx\fR, \fIy\fR). This function is the same as addChild(). -.SH "void QScrollView::removeChild ( QWidget * child )" -Removes the \fIchild\fR widget from the scrolled area. Note that this happens automatically if the \fIchild\fR is deleted. -.SH "void QScrollView::repaintContents ( int x, int y, int w, int h, bool erase = TRUE )" -Calls repaint() on a rectangle defined by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, translated appropriately. If the rectangle is not visible, nothing is repainted. If \fIerase\fR is TRUE the background is cleared using the background color. -.PP -See also updateContents(). -.SH "void QScrollView::repaintContents ( const QRect & r, bool erase = TRUE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Repaints the contents of rectangle \fIr\fR. If \fIerase\fR is TRUE the background is cleared using the background color. -.SH "void QScrollView::repaintContents ( bool erase = TRUE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Repaints the contents. If \fIerase\fR is TRUE the background is cleared using the background color. -.SH "void QScrollView::resizeContents ( int w, int h )\fC [virtual slot]\fR" -Sets the size of the contents area to \fIw\fR pixels wide and \fIh\fR pixels high and updates the viewport accordingly. -.SH "ResizePolicy QScrollView::resizePolicy () const" -Returns the resize policy. See the "resizePolicy" property for details. -.SH "int QScrollView::rightMargin () const\fC [protected]\fR" -Returns the right margin. -.PP -See also setMargins(). -.SH "void QScrollView::scrollBy ( int dx, int dy )\fC [slot]\fR" -Scrolls the content by \fIdx\fR to the left and \fIdy\fR upwards. -.SH "void QScrollView::setContentsPos ( int x, int y )\fC [virtual slot]\fR" -Scrolls the content so that the point \fI(x, y)\fR is in the top-left corner. -.PP -Example: process/process.cpp. -.SH "void QScrollView::setCornerWidget ( QWidget * corner )\fC [virtual]\fR" -Sets the widget in the \fIcorner\fR between the two scroll bars. -.PP -You will probably also want to set at least one of the scroll bar modes to AlwaysOn. -.PP -Passing 0 shows no widget in the corner. -.PP -Any previous \fIcorner\fR widget is hidden. -.PP -You may call setCornerWidget() with the same widget at different times. -.PP -All widgets set here will be deleted by the QScrollView when it is destroyed unless you separately reparent the widget after setting some other corner widget (or 0). -.PP -Any \fInewly\fR set widget should have no current parent. -.PP -By default, no corner widget is present. -.PP -See also vScrollBarMode and hScrollBarMode. -.PP -Example: scrollview/scrollview.cpp. -.SH "void QScrollView::setDragAutoScroll ( bool b )\fC [virtual]\fR" -Sets whether autoscrolling in drag move events is enabled to \fIb\fR. See the "dragAutoScroll" property for details. -.SH "void QScrollView::setHBarGeometry ( QScrollBar & hbar, int x, int y, int w, int h )\fC [virtual protected]\fR" -Called when the horizontal scroll bar geometry changes. This is provided as a protected function so that subclasses can do interesting things such as providing extra buttons in some of the space normally used by the scroll bars. -.PP -The default implementation simply gives all the space to \fIhbar\fR. The new geometry is given by \fIx\fR, \fIy\fR, \fIw\fR and \fIh\fR. -.PP -See also setVBarGeometry(). -.SH "void QScrollView::setHScrollBarMode ( ScrollBarMode )\fC [virtual]\fR" -Sets the mode for the horizontal scroll bar. See the "hScrollBarMode" property for details. -.SH "void QScrollView::setMargins ( int left, int top, int right, int bottom )\fC [virtual protected]\fR" -Sets the margins around the scrolling area to \fIleft\fR, \fItop\fR, \fIright\fR and \fIbottom\fR. This is useful for applications such as spreadsheets with "locked" rows and columns. The marginal space is \fIinside\fR the frameRect() and is left blank; reimplement drawFrame() or put widgets in the unused area. -.PP -By default all margins are zero. -.PP -See also frameChanged(). -.SH "void QScrollView::setResizePolicy ( ResizePolicy )\fC [virtual]\fR" -Sets the resize policy. See the "resizePolicy" property for details. -.SH "void QScrollView::setStaticBackground ( bool y )" -Sets the scrollview to have a static background if \fIy\fR is TRUE, or a scrolling background if \fIy\fR is FALSE. By default, the background is scrolling. -.PP -Be aware that this mode is quite slow, as a full repaint of the visible area has to be triggered on every contents move. -.PP -See also hasStaticBackground(). -.SH "void QScrollView::setVBarGeometry ( QScrollBar & vbar, int x, int y, int w, int h )\fC [virtual protected]\fR" -Called when the vertical scroll bar geometry changes. This is provided as a protected function so that subclasses can do interesting things such as providing extra buttons in some of the space normally used by the scroll bars. -.PP -The default implementation simply gives all the space to \fIvbar\fR. The new geometry is given by \fIx\fR, \fIy\fR, \fIw\fR and \fIh\fR. -.PP -See also setHBarGeometry(). -.SH "void QScrollView::setVScrollBarMode ( ScrollBarMode )\fC [virtual]\fR" -Sets the mode for the vertical scroll bar. See the "vScrollBarMode" property for details. -.SH "void QScrollView::showChild ( QWidget * child, bool y = TRUE )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the visibility of \fIchild\fR. Equivalent to QWidget::show() or QWidget::hide(). -.SH "int QScrollView::topMargin () const\fC [protected]\fR" -Returns the top margin. -.PP -See also setMargins(). -.SH "void QScrollView::updateContents ( int x, int y, int w, int h )" -Calls update() on a rectangle defined by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, translated appropriately. If the rectangle is not visible, nothing is repainted. -.PP -See also repaintContents(). -.SH "void QScrollView::updateContents ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Updates the contents in rectangle \fIr\fR -.SH "void QScrollView::updateContents ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QScrollView::updateScrollBars ()\fC [slot]\fR" -Updates scroll bars: all possibilities are considered. You should never need to call this in your code. -.SH "ScrollBarMode QScrollView::vScrollBarMode () const" -Returns the mode for the vertical scroll bar. See the "vScrollBarMode" property for details. -.SH "QScrollBar * QScrollView::verticalScrollBar () const" -Returns the component vertical scroll bar. It is made available to allow accelerators, autoscrolling, etc. -.PP -It should not be used for other purposes. -.PP -This function never returns 0. -.SH "void QScrollView::verticalSliderPressed ()\fC [signal]\fR" -This signal is emitted whenever the user presses the vertical slider. -.SH "void QScrollView::verticalSliderReleased ()\fC [signal]\fR" -This signal is emitted whenever the user releases the vertical slider. -.SH "QWidget * QScrollView::viewport () const" -Returns the viewport widget of the scrollview. This is the widget containing the contents widget or which is the drawing area. -.PP -Examples: -.)l helpsystem/tooltip.cpp and scrollview/scrollview.cpp. -.SH "void QScrollView::viewportPaintEvent ( QPaintEvent * pe )\fC [virtual protected]\fR" -This is a low-level painting routine that draws the viewport contents. Reimplement this if drawContents() is too high-level (for example, if you don't want to open a QPainter on the viewport). The paint event is passed in \fIpe\fR. -.SH "void QScrollView::viewportResizeEvent ( QResizeEvent * )\fC [virtual protected]\fR" -To provide simple processing of events on the contents, this function receives all resize events sent to the viewport. -.PP -See also QWidget::resizeEvent(). -.PP -Example: chart/canvasview.cpp. -.SH "QSize QScrollView::viewportSize ( int x, int y ) const" -Returns the viewport size for size (\fIx\fR, \fIy\fR). -.PP -The viewport size depends on \fI(x, y)\fR (the size of the contents), the size of this widget and the modes of the horizontal and vertical scroll bars. -.PP -This function permits widgets that can trade vertical and horizontal space for each other to control scroll bar appearance better. For example, a word processor or web browser can control the width of the right margin accurately, whether or not there needs to be a vertical scroll bar. -.SH "void QScrollView::viewportToContents ( int vx, int vy, int & x, int & y ) const" -Translates a point (\fIvx\fR, \fIvy\fR) on the viewport() widget to a point (\fIx\fR, \fIy\fR) in the contents. -.SH "QPoint QScrollView::viewportToContents ( const QPoint & vp ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point on the viewport \fIvp\fR translated to a point in the contents. -.SH "int QScrollView::visibleHeight () const" -Returns the vertical amount of the content that is visible. See the "visibleHeight" property for details. -.SH "int QScrollView::visibleWidth () const" -Returns the horizontal amount of the content that is visible. See the "visibleWidth" property for details. -.SS "Property Documentation" -.SH "int contentsHeight" -This property holds the height of the contents area. -.PP -Get this property's value with contentsHeight(). -.SH "int contentsWidth" -This property holds the width of the contents area. -.PP -Get this property's value with contentsWidth(). -.SH "int contentsX" -This property holds the X coordinate of the contents that are at the left edge of the viewport. -.PP -Get this property's value with contentsX(). -.SH "int contentsY" -This property holds the Y coordinate of the contents that are at the top edge of the viewport. -.PP -Get this property's value with contentsY(). -.SH "bool dragAutoScroll" -This property holds whether autoscrolling in drag move events is enabled. -.PP -If this property is set to TRUE (the default), the QScrollView automatically scrolls the contents in drag move events if the user moves the cursor close to a border of the view. Of course this works only if the viewport accepts drops. Specifying FALSE disables this autoscroll feature. -.PP -\fBWarning:\fR Enabling this property might not be enough to effectively turn on autoscrolling. If you put a custom widget in the QScrollView, you might need to call QDragEvent::ignore() on the event in the dragEnterEvent() and dragMoveEvent() reimplementations. -.PP -Set this property's value with setDragAutoScroll() and get this property's value with dragAutoScroll(). -.SH "ScrollBarMode hScrollBarMode" -This property holds the mode for the horizontal scroll bar. -.PP -The default mode is QScrollView::Auto. -.PP -See also vScrollBarMode. -.PP -Set this property's value with setHScrollBarMode() and get this property's value with hScrollBarMode(). -.SH "ResizePolicy resizePolicy" -This property holds the resize policy. -.PP -The default is Default. -.PP -See also ResizePolicy. -.PP -Set this property's value with setResizePolicy() and get this property's value with resizePolicy(). -.SH "ScrollBarMode vScrollBarMode" -This property holds the mode for the vertical scroll bar. -.PP -The default mode is QScrollView::Auto. -.PP -See also hScrollBarMode. -.PP -Set this property's value with setVScrollBarMode() and get this property's value with vScrollBarMode(). -.SH "int visibleHeight" -This property holds the vertical amount of the content that is visible. -.PP -Get this property's value with visibleHeight(). -.SH "int visibleWidth" -This property holds the horizontal amount of the content that is visible. -.PP -Get this property's value with visibleWidth(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqscrollview.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qscrollview.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsemaphore.3qt b/doc/man/man3/qsemaphore.3qt deleted file mode 100644 index 567f8ad62..000000000 --- a/doc/man/man3/qsemaphore.3qt +++ /dev/null @@ -1,110 +0,0 @@ -'\" t -.TH QSemaphore 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 -QSemaphore \- Robust integer semaphore -.SH SYNOPSIS -All the functions in this class are thread-safe when Qt is built with thread support.

                                            -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSemaphore\fR ( int maxcount )" -.br -.ti -1c -.BI "virtual \fB~QSemaphore\fR ()" -.br -.ti -1c -.BI "int \fBavailable\fR () const" -.br -.ti -1c -.BI "int \fBtotal\fR () const" -.br -.ti -1c -.BI "int \fBoperator++\fR ( int )" -.br -.ti -1c -.BI "int \fBoperator--\fR ( int )" -.br -.ti -1c -.BI "int \fBoperator+=\fR ( int n )" -.br -.ti -1c -.BI "int \fBoperator-=\fR ( int n )" -.br -.ti -1c -.BI "bool \fBtryAccess\fR ( int n )" -.br -.in -1c -.SH DESCRIPTION -The QSemaphore class provides a robust integer semaphore. -.PP -A QSemaphore can be used to serialize thread execution, in a similar way to a QMutex. A semaphore differs from a mutex, in that a semaphore can be accessed by more than one thread at a time. -.PP -For example, suppose we have an application that stores data in a large tree structure. The application creates 10 threads (commonly called a thread pool) to perform searches on the tree. When the application searches the tree for some piece of data, it uses one thread per base node to do the searching. A semaphore could be used to make sure that two threads don't try to search the same branch of the tree at the same time. -.PP -A non-computing example of a semaphore would be dining at a restuarant. A semaphore is initialized to have a maximum count equal to the number of chairs in the restuarant. As people arrive, they want a seat. As seats are filled, the semaphore is accessed, once per person. As people leave, the access is released, allowing more people to enter. If a party of 10 people want to be seated, but there are only 9 seats, those 10 people will wait, but a party of 4 people would be seated (taking the available seats to 5, making the party of 10 people wait longer). -.PP -When a semaphore is created it is given a number which is the maximum number of concurrent accesses it will permit. Accesses to the sempahore are gained using operator++() or operator+=(), and released with operator--() or operator-=(). The number of accesses allowed is retrieved with available(), and the total number with total(). Note that the incrementing functions will block if there aren't enough available accesses. Use tryAccess() if you want to acquire accesses without blocking. -.PP -See also Environment Classes and Threading. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSemaphore::QSemaphore ( int maxcount )" -Creates a new semaphore. The semaphore can be concurrently accessed at most \fImaxcount\fR times. -.SH "QSemaphore::~QSemaphore ()\fC [virtual]\fR" -Destroys the semaphore. -.PP -\fBWarning:\fR If you destroy a semaphore that has accesses in use the resultant behavior is undefined. -.SH "int QSemaphore::available () const" -Returns the number of accesses currently available to the semaphore. -.SH "int QSemaphore::operator++ ( int )" -Postfix ++ operator. -.PP -Try to get access to the semaphore. If available() == 0, this call will block until it can get access, i.e. until available() > 0. -.SH "int QSemaphore::operator+= ( int n )" -Try to get access to the semaphore. If available() < \fIn\fR, this call will block until it can get all the accesses it wants, i.e. until available() >= \fIn\fR. -.SH "int QSemaphore::operator-- ( int )" -Postfix -- operator. -.PP -Release access of the semaphore. This wakes all threads waiting for access to the semaphore. -.SH "int QSemaphore::operator-= ( int n )" -Release \fIn\fR accesses to the semaphore. -.SH "int QSemaphore::total () const" -Returns the total number of accesses to the semaphore. -.SH "bool QSemaphore::tryAccess ( int n )" -Try to get access to the semaphore. If available() < \fIn\fR, this -function will return FALSE immediately. If available() >= \fIn\fR, -this function will take \fIn\fR accesses and return TRUE. This -function does \fInot\fR block. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsemaphore.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsemaphore.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qserversocket.3qt b/doc/man/man3/qserversocket.3qt deleted file mode 100644 index 7fbb9757d..000000000 --- a/doc/man/man3/qserversocket.3qt +++ /dev/null @@ -1,142 +0,0 @@ -'\" t -.TH QServerSocket 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 -QServerSocket \- TCP-based server -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQServerSocket\fR ( TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQServerSocket\fR ( const QHostAddress & address, TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQServerSocket\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QServerSocket\fR ()" -.br -.ti -1c -.BI "bool \fBok\fR () const" -.br -.ti -1c -.BI "TQ_UINT16 \fBport\fR () const" -.br -.ti -1c -.BI "int \fBsocket\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSocket\fR ( int socket )" -.br -.ti -1c -.BI "QHostAddress \fBaddress\fR () const" -.br -.ti -1c -.BI "virtual void \fBnewConnection\fR ( int socket ) = 0" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "QSocketDevice * \fBsocketDevice\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QServerSocket class provides a TCP-based server. -.PP -This class is a convenience class for accepting incoming TCP connections. You can specify the port or have QServerSocket pick one, and listen on just one address or on all the machine's addresses. -.PP -Using the API is very simple: subclass QServerSocket, call the constructor of your choice, and implement newConnection() to handle new incoming connections. There is nothing more to do. -.PP -(Note that due to lack of support in the underlying APIs, QServerSocket cannot accept or reject connections conditionally.) -.PP -See also QSocket, QSocketDevice, QHostAddress, QSocketNotifier, and Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QServerSocket::QServerSocket ( TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" -Creates a server socket object, that will serve the given \fIport\fR on all the addresses of this host. If \fIport\fR is 0, QServerSocket will pick a suitable port in a system-dependent manner. Use \fIbacklog\fR to specify how many pending connections the server can have. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. -.PP -\fBWarning:\fR On Tru64 Unix systems a value of 0 for \fIbacklog\fR means that you don't accept any connections at all; you should specify a value larger than 0. -.SH "QServerSocket::QServerSocket ( const QHostAddress & address, TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" -Creates a server socket object, that will serve the given \fIport\fR only on the given \fIaddress\fR. Use \fIbacklog\fR to specify how many pending connections the server can have. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. -.PP -\fBWarning:\fR On Tru64 Unix systems a value of 0 for \fIbacklog\fR means that you don't accept any connections at all; you should specify a value larger than 0. -.SH "QServerSocket::QServerSocket ( QObject * parent = 0, const char * name = 0 )" -Construct an empty server socket. -.PP -This constructor, in combination with setSocket(), allows us to use the QServerSocket class as a wrapper for other socket types (e.g. Unix Domain Sockets under Unix). -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. -.PP -See also setSocket(). -.SH "QServerSocket::~QServerSocket ()\fC [virtual]\fR" -Destroys the socket. -.PP -This causes any backlogged connections (connections that have reached the host, but not yet been completely set up by calling QSocketDevice::accept()) to be severed. -.PP -Existing connections continue to exist; this only affects the acceptance of new connections. -.SH "QHostAddress QServerSocket::address () const" -Returns the address on which this object listens, or 0.0.0.0 if this object listens on more than one address. ok() must be TRUE before calling this function. -.PP -See also port() and QSocketDevice::address(). -.SH "void QServerSocket::newConnection ( int socket )\fC [pure virtual]\fR" -This pure virtual function is responsible for setting up a new incoming connection. \fIsocket\fR is the fd (file descriptor) for the newly accepted connection. -.SH "bool QServerSocket::ok () const" -Returns TRUE if the construction succeeded; otherwise returns FALSE. -.SH "TQ_UINT16 QServerSocket::port () const" -Returns the port number on which this server socket listens. This is always non-zero; if you specify 0 in the constructor, QServerSocket will pick a non-zero port itself. ok() must be TRUE before calling this function. -.PP -See also address() and QSocketDevice::port(). -.PP -Example: network/httpd/httpd.cpp. -.SH "void QServerSocket::setSocket ( int socket )\fC [virtual]\fR" -Sets the socket to use \fIsocket\fR. bind() and listen() should already have been called for \fIsocket\fR. -.PP -This allows us to use the QServerSocket class as a wrapper for other socket types (e.g. Unix Domain Sockets). -.SH "int QServerSocket::socket () const" -Returns the operating system socket. -.SH "QSocketDevice * QServerSocket::socketDevice ()\fC [protected]\fR" -Returns a pointer to the internal socket device. The returned pointer is 0 if there is no connection or pending connection. -.PP -There is normally no need to manipulate the socket device directly -since this class does all the necessary setup for most client or -server socket applications. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqserversocket.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qserversocket.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsessionmanager.3qt b/doc/man/man3/qsessionmanager.3qt deleted file mode 100644 index b6028bed9..000000000 --- a/doc/man/man3/qsessionmanager.3qt +++ /dev/null @@ -1,314 +0,0 @@ -'\" t -.TH QSessionManager 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 -QSessionManager \- Access to the session manager -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "QString \fBsessionId\fR () const" -.br -.ti -1c -.BI "QString \fBsessionKey\fR () const" -.br -.ti -1c -.BI "void * \fBhandle\fR () const" -.br -.ti -1c -.BI "bool \fBallowsInteraction\fR ()" -.br -.ti -1c -.BI "bool \fBallowsErrorInteraction\fR ()" -.br -.ti -1c -.BI "void \fBrelease\fR ()" -.br -.ti -1c -.BI "void \fBcancel\fR ()" -.br -.ti -1c -.BI "enum \fBRestartHint\fR { RestartIfRunning, RestartAnyway, RestartImmediately, RestartNever }" -.br -.ti -1c -.BI "void \fBsetRestartHint\fR ( RestartHint hint )" -.br -.ti -1c -.BI "RestartHint \fBrestartHint\fR () const" -.br -.ti -1c -.BI "void \fBsetRestartCommand\fR ( const QStringList & command )" -.br -.ti -1c -.BI "QStringList \fBrestartCommand\fR () const" -.br -.ti -1c -.BI "void \fBsetDiscardCommand\fR ( const QStringList & )" -.br -.ti -1c -.BI "QStringList \fBdiscardCommand\fR () const" -.br -.ti -1c -.BI "void \fBsetManagerProperty\fR ( const QString & name, const QString & value )" -.br -.ti -1c -.BI "void \fBsetManagerProperty\fR ( const QString & name, const QStringList & value )" -.br -.ti -1c -.BI "bool \fBisPhase2\fR () const" -.br -.ti -1c -.BI "void \fBrequestPhase2\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSessionManager class provides access to the session manager. -.PP -The session manager is responsible for session management, most importantly for interruption and resumption. A "session" is a kind of record of the state of the system, e.g. which applications were run at start up and which applications are currently running. The session manager is used to save the session, e.g. when the machine is shut down; and to restore a session, e.g. when the machine is started up. Use QSettings to save and restore an individual application's settings, e.g. window positions, recently used files, etc. -.PP -QSessionManager provides an interface between the application and the session manager so that the program can work well with the session manager. In Qt, session management requests for action are handled by the two virtual functions QApplication::commitData() and QApplication::saveState(). Both provide a reference to a session manager object as argument, to allow the application to communicate with the session manager. -.PP -During a session management action (i.e. within commitData() and saveState()), no user interaction is possible \fIunless\fR the application got explicit permission from the session manager. You ask for permission by calling allowsInteraction() or, if it's really urgent, allowsErrorInteraction(). Qt does not enforce this, but the session manager may. -.PP -You can try to abort the shutdown process by calling cancel(). The default commitData() function does this if some top-level window rejected its closeEvent(). -.PP -For sophisticated session managers provided on Unix/X11, QSessionManager offers further possibilites to fine-tune an application's session management behavior: setRestartCommand(), setDiscardCommand(), setRestartHint(), setProperty(), requestPhase2(). See the respective function descriptions for further details. -.PP -See also Main Window and Related Classes and Environment Classes. -.SS "Member Type Documentation" -.SH "QSessionManager::RestartHint" -This enum type defines the circumstances under which this application wants to be restarted by the session manager. The current values are -.TP -\fCQSessionManager::RestartIfRunning\fR - if the application is still running when the session is shut down, it wants to be restarted at the start of the next session. -.TP -\fCQSessionManager::RestartAnyway\fR - the application wants to be started at the start of the next session, no matter what. (This is useful for utilities that run just after startup and then quit.) -.TP -\fCQSessionManager::RestartImmediately\fR - the application wants to be started immediately whenever it is not running. -.TP -\fCQSessionManager::RestartNever\fR - the application does not want to be restarted automatically. -.PP -The default hint is RestartIfRunning. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "bool QSessionManager::allowsErrorInteraction ()" -This is similar to allowsInteraction(), but also tells the session manager that an error occurred. Session managers may give error interaction request higher priority, which means that it is more likely that an error interaction is permitted. However, you are still not guaranteed that the session manager will allow interaction. -.PP -See also allowsInteraction(), release(), and cancel(). -.SH "bool QSessionManager::allowsInteraction ()" -Asks the session manager for permission to interact with the user. Returns TRUE if interaction is permitted; otherwise returns FALSE. -.PP -The rationale behind this mechanism is to make it possible to synchronize user interaction during a shutdown. Advanced session managers may ask all applications simultaneously to commit their data, resulting in a much faster shutdown. -.PP -When the interaction is completed we strongly recommend releasing the user interaction semaphore with a call to release(). This way, other applications may get the chance to interact with the user while your application is still busy saving data. (The semaphore is implicitly released when the application exits.) -.PP -If the user decides to cancel the shutdown process during the interaction phase, you must tell the session manager that this has happened by calling cancel(). -.PP -Here's an example of how an application's QApplication::commitData() might be implemented: -.PP -.nf -.br -void MyApplication::commitData( QSessionManager& sm ) { -.br - if ( sm.allowsInteraction() ) { -.br - switch ( QMessageBox::warning( -.br - yourMainWindow, -.br - tr("Application Name"), -.br - tr("Save changes to document Foo?"), -.br - tr("&Yes"), -.br - tr("&No"), -.br - tr("Cancel"), -.br - 0, 2) ) { -.br - case 0: // yes -.br - sm.release(); -.br - // save document here; if saving fails, call sm.cancel() -.br - break; -.br - case 1: // continue without saving -.br - break; -.br - default: // cancel -.br - sm.cancel(); -.br - break; -.br - } -.br - } else { -.br - // we did not get permission to interact, then -.br - // do something reasonable instead. -.br - } -.br -} -.fi -.PP -If an error occurred within the application while saving its data, you may want to try allowsErrorInteraction() instead. -.PP -See also QApplication::commitData(), release(), and cancel(). -.SH "void QSessionManager::cancel ()" -Tells the session manager to cancel the shutdown process. Applications should not call this function without first asking the user. -.PP -See also allowsInteraction() and allowsErrorInteraction(). -.SH "QStringList QSessionManager::discardCommand () const" -Returns the currently set discard command. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = mySession.discardCommand(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also setDiscardCommand(), restartCommand(), and setRestartCommand(). -.SH "void * QSessionManager::handle () const" -X11 only: returns a handle to the current \fCSmcConnection\fR. -.SH "bool QSessionManager::isPhase2 () const" -Returns TRUE if the session manager is currently performing a second session management phase; otherwise returns FALSE. -.PP -See also requestPhase2(). -.SH "void QSessionManager::release ()" -Releases the session manager's interaction semaphore after an interaction phase. -.PP -See also allowsInteraction() and allowsErrorInteraction(). -.SH "void QSessionManager::requestPhase2 ()" -Requests a second session management phase for the application. The application may then return immediately from the QApplication::commitData() or QApplication::saveState() function, and they will be called again once most or all other applications have finished their session management. -.PP -The two phases are useful for applications such as the X11 window manager that need to store information about another application's windows and therefore have to wait until these applications have completed their respective session management tasks. -.PP -Note that if another application has requested a second phase it may get called before, simultaneously with, or after your application's second phase. -.PP -See also isPhase2(). -.SH "QStringList QSessionManager::restartCommand () const" -Returns the currently set restart command. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = mySession.restartCommand(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also setRestartCommand() and restartHint(). -.SH "RestartHint QSessionManager::restartHint () const" -Returns the application's current restart hint. The default is RestartIfRunning. -.PP -See also setRestartHint(). -.SH "QString QSessionManager::sessionId () const" -Returns the identifier of the current session. -.PP -If the application has been restored from an earlier session, this identifier is the same as it was in that earlier session. -.PP -See also sessionKey() and QApplication::sessionId(). -.SH "QString QSessionManager::sessionKey () const" -Returns the session key in the current session. -.PP -If the application has been restored from an earlier session, this key is the same as it was when the previous session ended. -.PP -The session key changes with every call of commitData() or saveState(). -.PP -See also sessionId() and QApplication::sessionKey(). -.SH "void QSessionManager::setDiscardCommand ( const QStringList & )" -See also discardCommand() and setRestartCommand(). -.SH "void QSessionManager::setManagerProperty ( const QString & name, const QStringList & value )" -Low-level write access to the application's identification and state record are kept in the session manager. -.PP -The property called \fIname\fR has its value set to the string list \fIvalue\fR. -.SH "void QSessionManager::setManagerProperty ( const QString & name, const QString & value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Low-level write access to the application's identification and state records are kept in the session manager. -.PP -The property called \fIname\fR has its value set to the string \fIvalue\fR. -.SH "void QSessionManager::setRestartCommand ( const QStringList & command )" -If the session manager is capable of restoring sessions it will execute \fIcommand\fR in order to restore the application. The command defaults to -.PP -.nf -.br - appname -session id -.br -.fi -.PP -The \fC-session\fR option is mandatory; otherwise QApplication cannot tell whether it has been restored or what the current session identifier is. See QApplication::isSessionRestored() and QApplication::sessionId() for details. -.PP -If your application is very simple, it may be possible to store the entire application state in additional command line options. This is usually a very bad idea because command lines are often limited to a few hundred bytes. Instead, use QSettings, or temporary files or a database for this purpose. By marking the data with the unique sessionId(), you will be able to restore the application in a future session. -.PP -See also restartCommand(), setDiscardCommand(), and setRestartHint(). -.SH "void QSessionManager::setRestartHint ( RestartHint hint )" -Sets the application's restart hint to \fIhint\fR. On application startup the hint is set to RestartIfRunning. -.PP -Note that these flags are only hints, a session manager may or may not respect them. -.PP -We recommend setting the restart hint in QApplication::saveState() because most session managers perform a checkpoint shortly after an application's startup. -.PP -See also restartHint(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsessionmanager.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsessionmanager.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsettings.3qt b/doc/man/man3/qsettings.3qt deleted file mode 100644 index 8de83c9a5..000000000 --- a/doc/man/man3/qsettings.3qt +++ /dev/null @@ -1,654 +0,0 @@ -'\" t -.TH QSettings 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 -QSettings \- Persistent platform-independent application settings -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBFormat\fR { Native = 0, Ini }" -.br -.ti -1c -.BI "enum \fBSystem\fR { Unix = 0, Windows, Mac }" -.br -.ti -1c -.BI "enum \fBScope\fR { User, Global }" -.br -.ti -1c -.BI "\fBQSettings\fR ()" -.br -.ti -1c -.BI "\fBQSettings\fR ( Format format )" -.br -.ti -1c -.BI "\fB~QSettings\fR ()" -.br -.ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, bool value )" -.br -.ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, double value )" -.br -.ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, int value )" -.br -.ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, const QString & value )" -.br -.ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, const QStringList & value )" -.br -.ti -1c -.BI "bool writeEntry ( const QString & key, const QStringList & value, const QChar & separator ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QStringList \fBentryList\fR ( const QString & key ) const" -.br -.ti -1c -.BI "QStringList \fBsubkeyList\fR ( const QString & key ) const" -.br -.ti -1c -.BI "QStringList \fBreadListEntry\fR ( const QString & key, bool * ok = 0 ) const" -.br -.ti -1c -.BI "QStringList readListEntry ( const QString & key, const QChar & separator, bool * ok = 0 ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString \fBreadEntry\fR ( const QString & key, const QString & def = QString::null, bool * ok = 0 ) const" -.br -.ti -1c -.BI "int \fBreadNumEntry\fR ( const QString & key, int def = 0, bool * ok = 0 ) const" -.br -.ti -1c -.BI "double \fBreadDoubleEntry\fR ( const QString & key, double def = 0, bool * ok = 0 ) const" -.br -.ti -1c -.BI "bool \fBreadBoolEntry\fR ( const QString & key, bool def = FALSE, bool * ok = 0 ) const" -.br -.ti -1c -.BI "bool \fBremoveEntry\fR ( const QString & key )" -.br -.ti -1c -.BI "void \fBinsertSearchPath\fR ( System s, const QString & path )" -.br -.ti -1c -.BI "void \fBremoveSearchPath\fR ( System s, const QString & path )" -.br -.ti -1c -.BI "void \fBsetPath\fR ( const QString & domain, const QString & product, Scope scope = Global )" -.br -.ti -1c -.BI "void \fBbeginGroup\fR ( const QString & group )" -.br -.ti -1c -.BI "void \fBendGroup\fR ()" -.br -.ti -1c -.BI "void \fBresetGroup\fR ()" -.br -.ti -1c -.BI "QString \fBgroup\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QSettings class provides persistent platform-independent application settings. -.PP -On Unix systems, QSettings uses text files to store settings. On Windows systems, QSettings uses the system registry. On Mac OS X, QSettings uses the Carbon preferences API. -.PP -Each setting comprises an identifying key and the data associated with the key. A key is a unicode string which consists of \fItwo\fR or more subkeys. A subkey is a slash, '/', followed by one or more unicode characters (excluding slashes, newlines, carriage returns and equals, '=', signs). The associated data, called the entry or value, may be a boolean, an integer, a double, a string or a list of strings. Entry strings may contain any unicode characters. -.PP -If you want to save and restore the entire desktop's settings, i.e. which applications are running, use QSettings to save the settings for each individual application and QSessionManager to save the desktop's session. -.PP -Example settings: -.PP -.nf -.br - /MyCompany/MyApplication/background color -.br - /MyCompany/MyApplication/foreground color -.br - /MyCompany/MyApplication/geometry/x -.br - /MyCompany/MyApplication/geometry/y -.br - /MyCompany/MyApplication/geometry/width -.br - /MyCompany/MyApplication/geometry/height -.br - /MyCompany/MyApplication/recent files/1 -.br - /MyCompany/MyApplication/recent files/2 -.br - /MyCompany/MyApplication/recent files/3 -.br -.fi -Each line above is a complete key, made up of subkeys. -.PP -A typical usage pattern for reading settings at application startup: -.PP -.nf -.br - QSettings settings; -.br - settings.setPath( "MyCompany.com", "MyApplication" ); -.br -.br - QString bgColor = settings.readEntry( "/colors/background", "white" ); -.br - int width = settings.readNumEntry( "/geometry/width", 640 ); -.br - // ... -.br -.fi -.PP -A typical usage pattern for saving settings at application exit or 'save preferences': -.PP -.nf -.br - QSettings settings; -.br - settings.setPath( "MyCompany.com", "MyApplication" ); -.br -.br - settings.writeEntry( "/colors/background", bgColor ); -.br - settings.writeEntry( "/geometry/width", width ); -.br - // ... -.br -.fi -.PP -A key prefix can be prepended to all keys using beginGroup(). The application of the prefix is stopped using endGroup(). For example: -.PP -.nf -.br - QSettings settings; -.br -.br - settings.beginGroup( "/MainWindow" ); -.br - settings.beginGroup( "/Geometry" ); -.br - int x = settings.readEntry( "/x" ); -.br - // ... -.br - settings.endGroup(); -.br - settings.beginGroup( "/Toolbars" ); -.br - // ... -.br - settings.endGroup(); -.br - settings.endGroup(); -.br -.fi -.PP -You can get a list of entry-holding keys by calling entryList(), and a list of key-holding keys using subkeyList(). -.PP -.nf -.br - QStringList keys = settings.entryList( "/MyApplication" ); -.br - // keys contains 'background color' and 'foreground color'. -.br -.br - QStringList keys = settings.entryList( "/MyApplication/recent files" ); -.br - // keys contains '1', '2' and '3'. -.br -.br - QStringList subkeys = settings.subkeyList( "/MyApplication" ); -.br - // subkeys contains 'geometry' and 'recent files' -.br -.br - QStringList subkeys = settings.subkeyList( "/MyApplication/recent files" ); -.br - // subkeys is empty. -.br -.fi -.PP -Since settings for Windows are stored in the registry there are some size limitations as follows: -.TP -A subkey may not exceed 255 characters. -.TP -An entry's value may not exceed 16,300 characters. -.TP -All the values of a key (for example, all the 'recent files' subkeys values), may not exceed 65,535 characters. -.PP -These limitations are not enforced on Unix or Mac OS X. -.PP -\fBWarning:\fR Creating multiple, simultaneous instances of QSettings writing to a text file may lead to data loss! This is a known issue which will be fixed in a future release of Qt. -.SH "Notes for Mac OS X Applications" -The location where settings are stored is not formally defined by the CFPreferences API. -.PP -At the time of writing settings are stored (either on a global or user basis, preferring locally) into a plist file in \fC$ROOT/System/Library/Preferences\fR (in XML format). QSettings will create an appropriate plist file (\fCcom..plist\fR) out of the full path to a key. -.PP -For further information on CFPreferences see Apple's Specifications -.SH "Notes for Unix Applications" -There is no universally accepted place for storing application settings under Unix. In the examples the settings file will be searched for in the following directories:
                                              -.TP -\fCSYSCONF\fR - the default value is \fCINSTALL/etc/settings\fR -.TP -\fC/opt/MyCompany/share/etc\fR -.TP -\fC/opt/MyCompany/share/MyApplication/etc\fR -.TP -\fC$HOME/.qt\fR When reading settings the files are searched in the order shown above, with later settings overriding earlier settings. Files for which the user doesn't have read permission are ignored. When saving settings QSettings works in the order shown above, writing to the first settings file for which the user has write permission. (\fCINSTALL\fR is the directory where Qt was installed. This can be modified by using the configure script's -prefix argument ) -.PP -If you want to put the settings in a particular place in the filesystem you could do this: -.PP -.nf -.br - settings.insertSearchPath( QSettings::Unix, "/opt/MyCompany/share" ); -.br -.fi -.PP -But in practice you may prefer not to use a search path for Unix. For example the following code: -.PP -.nf -.br - settings.writeEntry( "/MyApplication/geometry/width", width ); -.br -.fi -will end up writing the "geometry/width" setting to the file \fC$HOME/.qt/myapplicationrc\fR (assuming that the application is being run by an ordinary user, i.e. not by root). -.PP -For cross-platform applications you should ensure that the Windows size limitations are not exceeded. -.PP -\fBWarning:\fR QSettings doesn't write the settings until it is destroyed so you should construct the QSettings object on the stack. -.PP -See also Input/Output and Networking and Miscellaneous Classes. -.SS "Member Type Documentation" -.SH "QSettings::Format" -.TP -\fCQSettings::Native\fR - Store the settings in a platform dependent location -.TP -\fCQSettings::Ini\fR - Store the settings in a text file -.SH "QSettings::Scope" -.TP -\fCQSettings::Global\fR - Save settings as global as possible -.TP -\fCQSettings::User\fR - Save settings in user space -.SH "QSettings::System" -.TP -\fCQSettings::Mac\fR - Macintosh execution environments -.TP -\fCQSettings::Unix\fR - Mac OS X, Unix, Linux and Unix-like execution environments -.TP -\fCQSettings::Windows\fR - Windows execution environments -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSettings::QSettings ()" -Creates a settings object. -.PP -Be aware that you must call setPath() or insertSearchPath() before you can use the QSettings object. -.SH "QSettings::QSettings ( Format format )" -Creates a settings object. If \fIformat\fR is 'Ini' the settings will be stored in a text file, using the Unix strategy (see above). If \fIformat\fR is 'Native', the settings will be stored in a platform specific way (ie. the Windows registry). -.PP -Be aware that you must call setPath() or insertSearchPath() before you can use the QSettings object. -.SH "QSettings::~QSettings ()" -Destroys the settings object. All modifications made to the settings will automatically be saved. -.SH "void QSettings::beginGroup ( const QString & group )" -Appends \fIgroup\fR to the current key prefix. -.PP -.nf -.br - QSettings settings; -.br - settings.beginGroup( "/MainWindow" ); -.br - // read values -.br - settings.endGroup(); -.br -.fi -.SH "void QSettings::endGroup ()" -Undo previous calls to beginGroup(). Note that a single beginGroup("a/b/c") is undone by a single call to endGroup(). -.PP -.nf -.br - QSettings settings; -.br - settings.beginGroup( "/MainWindow/Geometry" ); -.br - // read values -.br - settings.endGroup(); -.br -.fi -.SH "QStringList QSettings::entryList ( const QString & key ) const" -Returns a list of the keys which contain entries under \fIkey\fR. Does \fInot\fR return any keys that contain subkeys. -.PP -Example settings: -.PP -.nf -.br - /MyCompany/MyApplication/background color -.br - /MyCompany/MyApplication/foreground color -.br - /MyCompany/MyApplication/geometry/x -.br - /MyCompany/MyApplication/geometry/y -.br - /MyCompany/MyApplication/geometry/width -.br - /MyCompany/MyApplication/geometry/height -.br -.fi -.PP -.nf -.br - QStringList keys = settings.entryList( "/MyCompany/MyApplication" ); -.br -.fi -.PP -In the above example, \fCkeys\fR will contain 'background color' and 'foreground color'. It will not contain 'geometry' because this key contains subkeys not entries. -.PP -To access the geometry values, you could either use subkeyList() to read the keys then read each entry, or simply read each entry directly by specifying its full key, e.g." /MyCompany/MyApplication/geometry/y". -.PP -See also subkeyList(). -.SH "QString QSettings::group () const" -Returns the current key prefix, or a null string if there is no key prefix set. -.PP -See also beginGroup(). -.SH "void QSettings::insertSearchPath ( System s, const QString & path )" -Inserts \fIpath\fR into the settings search path. The semantics of \fIpath\fR depends on the system \fIs\fR. It is usually easier and better to use setPath() instead of this function. -.PP -When \fIs\fR is \fIWindows\fR and the execution environment is \fInot\fR Windows the function does nothing. Similarly when \fIs\fR is \fIUnix\fR and the execution environment is \fInot\fR Unix the function does nothing. -.PP -When \fIs\fR is \fIWindows\fR, and the execution environment is Windows, the search path list will be used as the first subfolder of the "Software" folder in the registry. -.PP -When reading settings the folders are searched forwards from the first folder (listed below) to the last, returning the first settings found, and ignoring any folders for which the user doesn't have read permission.
                                                -.TP -HKEY_CURRENT_USER/Software/MyCompany/MyApplication -.TP -HKEY_LOCAL_MACHINE/Software/MyCompany/MyApplication -.TP -HKEY_CURRENT_USER/Software/MyApplication -.TP -HKEY_LOCAL_MACHINE/Software/MyApplication -.PP -.nf -.br - QSettings settings; -.br - settings.insertSearchPath( QSettings::Windows, "/MyCompany" ); -.br - settings.writeEntry( "/MyApplication/Tip of the day", TRUE ); -.br -.fi -The code above will write the subkey "Tip of the day" into the \fIfirst\fR of the registry folders listed below that is found and for which the user has write permission.
                                                  -.TP -HKEY_LOCAL_MACHINE/Software/MyCompany/MyApplication -.TP -HKEY_CURRENT_USER/Software/MyCompany/MyApplication -.TP -HKEY_LOCAL_MACHINE/Software/MyApplication -.TP -HKEY_CURRENT_USER/Software/MyApplication If a setting is found in the HKEY_CURRENT_USER space, this setting is overwritten independently of write permissions in the HKEY_LOCAL_MACHINE space. -.PP -When \fIs\fR is \fIUnix\fR, and the execution environment is Unix, the search path list will be used when trying to determine a suitable filename for reading and writing settings files. By default, there are two entries in the search path: -.PP -
                                                    -.TP -\fCSYSCONF\fR - where \fCSYSCONF\fR is a directory specified when configuring Qt; by default it is INSTALL/etc/settings. -.TP -\fC$HOME/.qt/\fR - where \fC$HOME\fR is the user's home directory. -.PP -All insertions into the search path will go before $HOME/.qt/. For example: -.PP -.nf -.br - QSettings settings; -.br - settings.insertSearchPath( QSettings::Unix, "/opt/MyCompany/share/etc" ); -.br - settings.insertSearchPath( QSettings::Unix, "/opt/MyCompany/share/MyApplication/etc" ); -.br - // ... -.br -.fi -Will result in a search path of:
                                                      -.TP -SYSCONF -.TP -/opt/MyCompany/share/etc -.TP -/opt/MyCompany/share/MyApplication/etc -.TP -$HOME/.qt When reading settings the files are searched in the order shown above, with later settings overriding earlier settings. Files for which the user doesn't have read permission are ignored. When saving settings QSettings works in the order shown above, writing to the first settings file for which the user has write permission. -.PP -Note that paths in the file system are not created by this function, so they must already exist to be useful. -.PP -Settings under Unix are stored in files whose names are based on the first subkey of the key (not including the search path). The algorithm for creating names is essentially: lowercase the first subkey, replace spaces with underscores and add 'rc', e.g. \fC/MyCompany/MyApplication/background color\fR will be stored in \fCmyapplicationrc\fR (assuming that \fC/MyCompany\fR is part of the search path). -.PP -See also removeSearchPath(). -.PP -Example: chart/chartform.cpp. -.SH "bool QSettings::readBoolEntry ( const QString & key, bool def = FALSE, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns a bool, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. -.PP -See also readEntry(), readNumEntry(), readDoubleEntry(), writeEntry(), and removeEntry(). -.SH "double QSettings::readDoubleEntry ( const QString & key, double def = 0, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns a double, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. -.PP -See also readEntry(), readNumEntry(), readBoolEntry(), writeEntry(), and removeEntry(). -.SH "QString QSettings::readEntry ( const QString & key, const QString & def = QString::null, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns a QString, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. -.PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). -.SH "QStringList QSettings::readListEntry ( const QString & key, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR as a string. If \fIok\fR is not 0, \fI*ok\fR is set to TRUE if the key was read, otherwise \fI*ok\fR is set to FALSE. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = mySettings.readListEntry( "recentfiles" ); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). -.SH "QStringList QSettings::readListEntry ( const QString & key, const QChar & separator, bool * ok = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Reads the entry specified by \fIkey\fR as a string. The \fIseparator\fR is used to create a QStringList by calling QStringList::split(\fIseparator\fR, entry). If \fIok\fR is not 0: \fI*ok\fR is set to TRUE if the key was read, otherwise \fI*ok\fR is set to FALSE. -.PP -\fBWarning:\fR As the documentation states, QStringList::split() will omit empty strings from the list. Because of this, it is impossible to retrieve identical list data with this function. We recommend using the readListEntry() and writeEntry() overloads that do not take a \fIseparator\fR argument. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = mySettings.readListEntry( "size", " " ); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). -.SH "int QSettings::readNumEntry ( const QString & key, int def = 0, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns an integer, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. -.PP -See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). -.SH "bool QSettings::removeEntry ( const QString & key )" -Removes the entry specified by \fIkey\fR. -.PP -Returns true if the entry was successfully removed; otherwise returns false. Note that removing the last entry in any given folder, will also remove the folder. -.PP -See also readEntry() and writeEntry(). -.SH "void QSettings::removeSearchPath ( System s, const QString & path )" -Removes all occurrences of \fIpath\fR (using exact matching) from the settings search path for system \fIs\fR. Note that the default search paths cannot be removed. -.PP -See also insertSearchPath(). -.SH "void QSettings::resetGroup ()" -Set the current key prefix to the empty string. -.SH "void QSettings::setPath ( const QString & domain, const QString & product, Scope scope = Global )" -Insert platform-dependent paths from platform-independent information. -.PP -The \fIdomain\fR should be an Internet domain name controlled by the producer of the software, eg. Trolltech products use "trolltech.com". -.PP -The \fIproduct\fR should be the official name of the product. -.PP -The \fIscope\fR should be QSettings::User for user-specific settings, or QSettings::Global for system-wide settings (generally these will be read-only to many users). -.PP -Not all information is relevant on all systems. -.SH "QStringList QSettings::subkeyList ( const QString & key ) const" -Returns a list of the keys which contain subkeys under \fIkey\fR. Does \fInot\fR return any keys that contain entries. -.PP -Example settings: -.PP -.nf -.br - /MyCompany/MyApplication/background color -.br - /MyCompany/MyApplication/foreground color -.br - /MyCompany/MyApplication/geometry/x -.br - /MyCompany/MyApplication/geometry/y -.br - /MyCompany/MyApplication/geometry/width -.br - /MyCompany/MyApplication/geometry/height -.br - /MyCompany/MyApplication/recent files/1 -.br - /MyCompany/MyApplication/recent files/2 -.br - /MyCompany/MyApplication/recent files/3 -.br -.fi -.PP -.nf -.br - QStringList keys = settings.subkeyList( "/MyCompany/MyApplication" ); -.br -.fi -.PP -In the above example, \fCkeys\fR will contain 'geometry' and 'recent files'. It will not contain 'background color' or 'foreground color' because those keys contain entries not subkeys. To get a list of keys that contain entries rather than subkeys use entryList() instead. -.PP -\fBWarning:\fR In the above example, if QSettings is writing to an Ini file, then a call to -.PP -.nf -.br - subkeyList("/MyCompany") -.fi -will return an empty list. This happens because a key like -.PP -.nf -.br - /MyCompany/MyApplication/background color -.fi -is written to the file \fI"mycompanyrc"\fR, under the section \fI[MyApplication]\fR. This call is therefore a request to list the sections in an ini file, which is not supported in this version of QSettings. This is a known issue which will be fixed in Qt-4. -.PP -See also entryList(). -.SH "bool QSettings::writeEntry ( const QString & key, bool value )" -Writes the boolean entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. -.PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. -.PP -\fBWarning:\fR On certain platforms, keys are required to contain at least two components (e.g., "/foo/bar"). This limitation does not apply to Qt 4. -.PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). -.PP -Example: chart/chartform.cpp. -.SH "bool QSettings::writeEntry ( const QString & key, double value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes the double entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. -.PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. -.PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). -.SH "bool QSettings::writeEntry ( const QString & key, int value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes the integer entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. -.PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. -.PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). -.SH "bool QSettings::writeEntry ( const QString & key, const QString & value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes the string entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. If \fIvalue\fR is an empty string or a null string the key's value will be an empty string. -.PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. -.PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). -.SH "bool QSettings::writeEntry ( const QString & key, const QStringList & value )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes the string list entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. -.PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise returns TRUE. -.PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). -.SH "bool QSettings::writeEntry ( const QString & key, const QStringList & value, const QChar & separator )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Writes the string list entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. The list is stored as a sequence of strings separated by \fIseparator\fR (using QStringList::join()), so none of the strings in the list should contain the separator. If the list is empty or null the key's value will be an empty string. -.PP -\fBWarning:\fR The list should not contain empty or null strings, as readListEntry() will use QStringList::split() to recreate the list. As the documentation states, QStringList::split() will omit empty strings from the list. Because of this, it is impossible to retrieve identical list data that is stored with this function. We recommend using the writeEntry() and readListEntry() overloads that do not take a \fIseparator\fR argument. -.PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise returns TRUE. -.PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), removeEntry(), and QStringList::join(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsettings.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsettings.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsgistyle.3qt b/doc/man/man3/qsgistyle.3qt deleted file mode 100644 index 079871a91..000000000 --- a/doc/man/man3/qsgistyle.3qt +++ /dev/null @@ -1,64 +0,0 @@ -'\" t -.TH QSGIStyle 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 -QSGIStyle \- SGI/Irix look and feel -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QMotifStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSGIStyle\fR ( bool useHighlightCols = FALSE )" -.br -.ti -1c -.BI "virtual \fB~QSGIStyle\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSGIStyle class provides SGI/Irix look and feel. -.PP -This class implements the SGI look and feel. It resembles the SGI/Irix Motif GUI style as closely as QStyle allows. -.PP -See also Widget Appearance and Style. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSGIStyle::QSGIStyle ( bool useHighlightCols = FALSE )" -Constructs a QSGIStyle. -.PP -If \fIuseHighlightCols\fR is FALSE (default value), the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. -.PP -See also QMotifStyle::useHighlightColors(). -.SH "QSGIStyle::~QSGIStyle ()\fC [virtual]\fR" -Destroys the style. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsgistyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsgistyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qshowevent.3qt b/doc/man/man3/qshowevent.3qt deleted file mode 100644 index 05a5d489e..000000000 --- a/doc/man/man3/qshowevent.3qt +++ /dev/null @@ -1,55 +0,0 @@ -'\" t -.TH QShowEvent 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 -QShowEvent \- Event which is sent when a widget is shown -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQShowEvent\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QShowEvent class provides an event which is sent when a widget is shown. -.PP -There are two kinds of show events: show events caused by the window system (spontaneous) and internal show events. Spontaneous show events are sent just after the window system shows the window, including after a top-level window has been shown (un-iconified) by the user. Internal show events are delivered just before the widget becomes visible. -.PP -See also QHideEvent and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QShowEvent::QShowEvent ()" -Constructs a QShowEvent. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qshowevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qshowevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsignal.3qt b/doc/man/man3/qsignal.3qt deleted file mode 100644 index be2f63d98..000000000 --- a/doc/man/man3/qsignal.3qt +++ /dev/null @@ -1,197 +0,0 @@ -'\" t -.TH QSignal 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 -QSignal \- Can be used to send signals for classes that don't inherit QObject -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSignal\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSignal\fR ()" -.br -.ti -1c -.BI "bool \fBconnect\fR ( const QObject * receiver, const char * member )" -.br -.ti -1c -.BI "bool \fBdisconnect\fR ( const QObject * receiver, const char * member = 0 )" -.br -.ti -1c -.BI "void \fBactivate\fR ()" -.br -.ti -1c -.BI "bool isBlocked () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void block ( bool b ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setParameter ( int value ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int parameter () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetValue\fR ( const QVariant & value )" -.br -.ti -1c -.BI "QVariant \fBvalue\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QSignal class can be used to send signals for classes that don't inherit QObject. -.PP -If you want to send signals from a class that does not inherit QObject, you can create an internal QSignal object to emit the signal. You must also provide a function that connects the signal to an outside object slot. This is how we have implemented signals in the QMenuData class, which is not a QObject. -.PP -In general, we recommend inheriting QObject instead. QObject provides much more functionality. -.PP -You can set a single QVariant parameter for the signal with setValue(). -.PP -Note that QObject is a \fIprivate\fR base class of QSignal, i.e. you cannot call any QObject member functions from a QSignal object. -.PP -Example: -.PP -.nf -.br - #include -.br -.br - class MyClass -.br - { -.br - public: -.br - MyClass(); -.br - ~MyClass(); -.br -.br - void doSomething(); -.br -.br - void connect( QObject *receiver, const char *member ); -.br -.br - private: -.br - QSignal *sig; -.br - }; -.br -.br - MyClass::MyClass() -.br - { -.br - sig = new QSignal; -.br - } -.br -.br - MyClass::~MyClass() -.br - { -.br - delete sig; -.br - } -.br -.br - void MyClass::doSomething() -.br - { -.br - // ... does something -.br - sig->activate(); // emits the signal -.br - } -.br -.br - void MyClass::connect( QObject *receiver, const char *member ) -.br - { -.br - sig->connect( receiver, member ); -.br - } -.br -.fi -.PP -See also Input/Output and Networking and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSignal::QSignal ( QObject * parent = 0, const char * name = 0 )" -Constructs a signal object called \fIname\fR, with the parent object \fIparent\fR. These arguments are passed directly to QObject. -.SH "QSignal::~QSignal ()" -Destroys the signal. All connections are removed, as is the case with all QObjects. -.SH "void QSignal::activate ()" -Emits the signal. If the platform supports QVariant and a parameter has been set with setValue(), this value is passed in the signal. -.SH "void QSignal::block ( bool b )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Blocks the signal if \fIb\fR is TRUE, or unblocks the signal if \fIb\fR is FALSE. -.PP -An activated signal disappears into hyperspace if it is blocked. -.PP -See also isBlocked(), activate(), and QObject::blockSignals(). -.SH "bool QSignal::connect ( const QObject * receiver, const char * member )" -Connects the signal to \fImember\fR in object \fIreceiver\fR. -.PP -See also disconnect() and QObject::connect(). -.SH "bool QSignal::disconnect ( const QObject * receiver, const char * member = 0 )" -Disonnects the signal from \fImember\fR in object \fIreceiver\fR. -.PP -See also connect() and QObject::disconnect(). -.SH "bool QSignal::isBlocked () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if the signal is blocked, or FALSE if it is not blocked. -.PP -The signal is not blocked by default. -.PP -See also block() and QObject::signalsBlocked(). -.SH "int QSignal::parameter () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QSignal::setParameter ( int value )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QSignal::setValue ( const QVariant & value )" -Sets the signal's parameter to \fIvalue\fR -.SH "QVariant QSignal::value () const" -Returns the signal's parameter - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsignal.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsignal.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsignalmapper.3qt b/doc/man/man3/qsignalmapper.3qt deleted file mode 100644 index 411b73c3c..000000000 --- a/doc/man/man3/qsignalmapper.3qt +++ /dev/null @@ -1,118 +0,0 @@ -'\" t -.TH QSignalMapper 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 -QSignalMapper \- Bundles signals from identifiable senders -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSignalMapper\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSignalMapper\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetMapping\fR ( const QObject * sender, int identifier )" -.br -.ti -1c -.BI "virtual void \fBsetMapping\fR ( const QObject * sender, const QString & identifier )" -.br -.ti -1c -.BI "void \fBremoveMappings\fR ( const QObject * sender )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBmap\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBmapped\fR ( int )" -.br -.ti -1c -.BI "void \fBmapped\fR ( const QString & )" -.br -.in -1c -.SH DESCRIPTION -The QSignalMapper class bundles signals from identifiable senders. -.PP -This class collects a set of parameterless signals, and re-emits them with integer or string parameters corresponding to the object that sent the signal. -.PP -See also Input/Output and Networking. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSignalMapper::QSignalMapper ( QObject * parent, const char * name = 0 )" -Constructs a QSignalMapper called \fIname\fR, with parent \fIparent\fR. Like all QObjects, it will be deleted when the parent is deleted. -.SH "QSignalMapper::~QSignalMapper ()" -Destroys the QSignalMapper. -.SH "void QSignalMapper::map ()\fC [slot]\fR" -This slot emits signals based on which object sends signals to it. -.PP -Examples: -.)l i18n/main.cpp and themes/themes.cpp. -.SH "void QSignalMapper::mapped ( int )\fC [signal]\fR" -This signal is emitted when map() is signaled from an object that has an integer mapping set. -.PP -See also setMapping(). -.PP -Examples: -.)l i18n/main.cpp and themes/themes.cpp. -.SH "void QSignalMapper::mapped ( const QString & )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted when map() is signaled from an object that has a string mapping set. -.PP -See also setMapping(). -.SH "void QSignalMapper::removeMappings ( const QObject * sender )" -Removes all mappings for \fIsender\fR. This is done automatically when mapped objects are destroyed. -.SH "void QSignalMapper::setMapping ( const QObject * sender, int identifier )\fC [virtual]\fR" -Adds a mapping so that when map() is signaled from the given \fIsender\fR, the signal mapped(\fIidentifier\fR) is emitted. -.PP -There may be at most one integer identifier for each object. -.PP -Examples: -.)l i18n/main.cpp and themes/themes.cpp. -.SH "void QSignalMapper::setMapping ( const QObject * sender, const QString & identifier )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a mapping so that when map() is signaled from the given \fIsender\fR, the signal mapper(\fIidentifier\fR) is emitted. -.PP -There may be at most one string identifier for each object, and it -may not be empty. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsignalmapper.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsignalmapper.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsimplerichtext.3qt b/doc/man/man3/qsimplerichtext.3qt deleted file mode 100644 index dd7637e27..000000000 --- a/doc/man/man3/qsimplerichtext.3qt +++ /dev/null @@ -1,182 +0,0 @@ -'\" t -.TH QSimpleRichText 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 -QSimpleRichText \- Small displayable piece of rich text -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSimpleRichText\fR ( const QString & text, const QFont & fnt, const QString & context = QString::null, const QStyleSheet * sheet = 0 )" -.br -.ti -1c -.BI "\fBQSimpleRichText\fR ( const QString & text, const QFont & fnt, const QString & context, const QStyleSheet * sheet, const QMimeSourceFactory * factory, int pageBreak = -1, const QColor & linkColor = Qt::blue, bool linkUnderline = TRUE )" -.br -.ti -1c -.BI "\fB~QSimpleRichText\fR ()" -.br -.ti -1c -.BI "void \fBsetWidth\fR ( int w )" -.br -.ti -1c -.BI "void \fBsetWidth\fR ( QPainter * p, int w )" -.br -.ti -1c -.BI "void \fBsetDefaultFont\fR ( const QFont & f )" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBwidthUsed\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "void \fBadjustSize\fR ()" -.br -.ti -1c -.BI "void \fBdraw\fR ( QPainter * p, int x, int y, const QRect & clipRect, const QColorGroup & cg, const QBrush * paper = 0 ) const" -.br -.ti -1c -.BI "void draw ( QPainter * p, int x, int y, const QRegion & clipRegion, const QColorGroup & cg, const QBrush * paper = 0 ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString \fBcontext\fR () const" -.br -.ti -1c -.BI "QString \fBanchorAt\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "bool \fBinText\fR ( const QPoint & pos ) const" -.br -.in -1c -.SH DESCRIPTION -The QSimpleRichText class provides a small displayable piece of rich text. -.PP -This class encapsulates simple rich text usage in which a string is interpreted as rich text and can be drawn. This is particularly useful if you want to display some rich text in a custom widget. A QStyleSheet is needed to interpret the tags and format the rich text. Qt provides a default HTML-like style sheet, but you may define custom style sheets. -.PP -Once created, the rich text object can be queried for its width(), height(), and the actual width used (see widthUsed()). Most importantly, it can be drawn on any given QPainter with draw(). QSimpleRichText can also be used to implement hypertext or active text facilities by using anchorAt(). A hit test through inText() makes it possible to use simple rich text for text objects in editable drawing canvases. -.PP -Once constructed from a string the contents cannot be changed, only resized. If the contents change, just throw the rich text object away and make a new one with the new contents. -.PP -For large documents use QTextEdit or QTextBrowser. For very small items of rich text you can use a QLabel. -.PP -If you are using QSimpleRichText to print in high resolution you should call setWidth(QPainter, int) so that the content will be laid out properly on the page. -.PP -See also Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSimpleRichText::QSimpleRichText ( const QString & text, const QFont & fnt, const QString & context = QString::null, const QStyleSheet * sheet = 0 )" -Constructs a QSimpleRichText from the rich text string \fItext\fR and the font \fIfnt\fR. -.PP -The font is used as a basis for the text rendering. When using rich text rendering on a widget \fIw\fR, you would normally specify the widget's font, for example: -.PP -.nf -.br - QSimpleRichText myrichtext( contents, mywidget->font() ); -.br -.fi -.PP -\fIcontext\fR is the optional context of the rich text object. This becomes important if \fItext\fR contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see QMimeSourceFactory::defaultFactory()) to resolve those references. The context will then be used to calculate the absolute path. See QMimeSourceFactory::makeAbsolute() for details. -.PP -The \fIsheet\fR is an optional style sheet. If it is 0, the default style sheet will be used (see QStyleSheet::defaultSheet()). -.SH "QSimpleRichText::QSimpleRichText ( const QString & text, const QFont & fnt, const QString & context, const QStyleSheet * sheet, const QMimeSourceFactory * factory, int pageBreak = -1, const QColor & linkColor = Qt::blue, bool linkUnderline = TRUE )" -Constructs a QSimpleRichText from the rich text string \fItext\fR and the font \fIfnt\fR. -.PP -This is a slightly more complex constructor for QSimpleRichText that takes an additional mime source factory \fIfactory\fR, a page break parameter \fIpageBreak\fR and a bool \fIlinkUnderline\fR. \fIlinkColor\fR is only provided for compatibility, but has no effect, as QColorGroup's QColorGroup::link() color is used now. -.PP -\fIcontext\fR is the optional context of the rich text object. This becomes important if \fItext\fR contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see QMimeSourceFactory::defaultFactory()) to resolve those references. The context will then be used to calculate the absolute path. See QMimeSourceFactory::makeAbsolute() for details. -.PP -The \fIsheet\fR is an optional style sheet. If it is 0, the default style sheet will be used (see QStyleSheet::defaultSheet()). -.PP -This constructor is useful for creating a QSimpleRichText object suitable for printing. Set \fIpageBreak\fR to be the height of the contents area of the pages. -.SH "QSimpleRichText::~QSimpleRichText ()" -Destroys the rich text object, freeing memory. -.SH "void QSimpleRichText::adjustSize ()" -Adjusts the richt text object to a reasonable size. -.PP -See also setWidth(). -.SH "QString QSimpleRichText::anchorAt ( const QPoint & pos ) const" -Returns the anchor at the requested position, \fIpos\fR. An empty string is returned if no anchor is specified for this position. -.SH "QString QSimpleRichText::context () const" -Returns the context of the rich text object. If no context has been specified in the constructor, a null string is returned. The context is the path to use to look up relative links, such as image tags and anchor references. -.SH "void QSimpleRichText::draw ( QPainter * p, int x, int y, const QRect & clipRect, const QColorGroup & cg, const QBrush * paper = 0 ) const" -Draws the formatted text with painter \fIp\fR, at position (\fIx\fR, \fIy\fR), clipped to \fIclipRect\fR. The clipping rectangle is given in the rich text object's coordinates translated by (\fIx\fR, \fIy\fR). Passing an null rectangle results in no clipping. Colors from the color group \fIcg\fR are used as needed, and if not 0, \fI*paper\fR is used as the background brush. -.PP -Note that the display code is highly optimized to reduce flicker, so passing a brush for \fIpaper\fR is preferable to simply clearing the area to be painted and then calling this without a brush. -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "void QSimpleRichText::draw ( QPainter * p, int x, int y, const QRegion & clipRegion, const QColorGroup & cg, const QBrush * paper = 0 ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use the version with clipRect instead. The region version has problems with larger documents on some platforms (on X11 regions internally are represented with 16bit coordinates). -.SH "int QSimpleRichText::height () const" -Returns the height of the rich text object in pixels. -.PP -See also setWidth(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "bool QSimpleRichText::inText ( const QPoint & pos ) const" -Returns TRUE if \fIpos\fR is within a text line of the rich text object; otherwise returns FALSE. -.SH "void QSimpleRichText::setDefaultFont ( const QFont & f )" -Sets the default font for the rich text object to \fIf\fR -.SH "void QSimpleRichText::setWidth ( QPainter * p, int w )" -Sets the width of the rich text object to \fIw\fR pixels, recalculating the layout as if it were to be drawn with painter \fIp\fR. -.PP -Passing a painter is useful when you intend drawing on devices other than the screen, for example a QPrinter. -.PP -See also height() and adjustSize(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "void QSimpleRichText::setWidth ( int w )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the width of the rich text object to \fIw\fR pixels. -.PP -See also height() and adjustSize(). -.SH "int QSimpleRichText::width () const" -Returns the set width of the rich text object in pixels. -.PP -See also widthUsed(). -.SH "int QSimpleRichText::widthUsed () const" -Returns the width in pixels that is actually used by the rich text object. This can be smaller or wider than the set width. -.PP -It may be wider, for example, if the text contains images or non-breakable words that are already wider than the available space. It's smaller when the object only consists of lines that do not fill the width completely. -.PP -See also width(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsimplerichtext.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsimplerichtext.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsize.3qt b/doc/man/man3/qsize.3qt deleted file mode 100644 index 52166c006..000000000 --- a/doc/man/man3/qsize.3qt +++ /dev/null @@ -1,370 +0,0 @@ -'\" t -.TH QSize 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 -QSize \- Defines the size of a two-dimensional object -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBScaleMode\fR { ScaleFree, ScaleMin, ScaleMax }" -.br -.ti -1c -.BI "\fBQSize\fR ()" -.br -.ti -1c -.BI "\fBQSize\fR ( int w, int h )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "void \fBsetWidth\fR ( int w )" -.br -.ti -1c -.BI "void \fBsetHeight\fR ( int h )" -.br -.ti -1c -.BI "void \fBtranspose\fR ()" -.br -.ti -1c -.BI "void \fBscale\fR ( int w, int h, ScaleMode mode )" -.br -.ti -1c -.BI "void \fBscale\fR ( const QSize & s, ScaleMode mode )" -.br -.ti -1c -.BI "QSize \fBexpandedTo\fR ( const QSize & otherSize ) const" -.br -.ti -1c -.BI "QSize \fBboundedTo\fR ( const QSize & otherSize ) const" -.br -.ti -1c -.BI "QCOORD & \fBrwidth\fR ()" -.br -.ti -1c -.BI "QCOORD & \fBrheight\fR ()" -.br -.ti -1c -.BI "QSize & \fBoperator+=\fR ( const QSize & s )" -.br -.ti -1c -.BI "QSize & \fBoperator-=\fR ( const QSize & s )" -.br -.ti -1c -.BI "QSize & \fBoperator*=\fR ( int c )" -.br -.ti -1c -.BI "QSize & \fBoperator*=\fR ( double c )" -.br -.ti -1c -.BI "QSize & \fBoperator/=\fR ( int c )" -.br -.ti -1c -.BI "QSize & \fBoperator/=\fR ( double c )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "bool \fBoperator==\fR ( const QSize & s1, const QSize & s2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QSize & s1, const QSize & s2 )" -.br -.ti -1c -.BI "const QSize \fBoperator+\fR ( const QSize & s1, const QSize & s2 )" -.br -.ti -1c -.BI "const QSize \fBoperator-\fR ( const QSize & s1, const QSize & s2 )" -.br -.ti -1c -.BI "const QSize \fBoperator*\fR ( const QSize & s, int c )" -.br -.ti -1c -.BI "const QSize \fBoperator*\fR ( int c, const QSize & s )" -.br -.ti -1c -.BI "const QSize \fBoperator*\fR ( const QSize & s, double c )" -.br -.ti -1c -.BI "const QSize \fBoperator*\fR ( double c, const QSize & s )" -.br -.ti -1c -.BI "const QSize \fBoperator/\fR ( const QSize & s, int c )" -.br -.ti -1c -.BI "const QSize \fBoperator/\fR ( const QSize & s, double c )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QSize & sz )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QSize & sz )" -.br -.in -1c -.SH DESCRIPTION -The QSize class defines the size of a two-dimensional object. -.PP -A size is specified by a width and a height. -.PP -The coordinate type is QCOORD (defined in \fC\fR as \fCint\fR). The minimum value of QCOORD is QCOORD_MIN (-2147483648) and the maximum value is QCOORD_MAX (2147483647). -.PP -The size can be set in the constructor and changed with setWidth() and setHeight(), or using operator+=(), operator-=(), operator*=() and operator/=(), etc. You can swap the width and height with transpose(). You can get a size which holds the maximum height and width of two sizes using expandedTo(), and the minimum height and width of two sizes using boundedTo(). -.PP -See also QPoint, QRect, Graphics Classes, and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QSize::ScaleMode" -This enum type defines the different ways of scaling a size. -.PP -
                                                      -.ce 1 -.B "[Image Omitted]" -.PP -
                                                      -.TP -\fCQSize::ScaleFree\fR - The size is scaled freely. The ratio is not preserved. -.TP -\fCQSize::ScaleMin\fR - The size is scaled to a rectangle as large as possible inside a given rectangle, preserving the aspect ratio. -.TP -\fCQSize::ScaleMax\fR - The size is scaled to a rectangle as small as possible outside a given rectangle, preserving the aspect ratio. -.PP -See also QSize::scale(), QImage::scale(), and QImage::smoothScale(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSize::QSize ()" -Constructs a size with invalid (negative) width and height. -.SH "QSize::QSize ( int w, int h )" -Constructs a size with width \fIw\fR and height \fIh\fR. -.SH "QSize QSize::boundedTo ( const QSize & otherSize ) const" -Returns a size with the minimum width and height of this size and \fIotherSize\fR. -.SH "QSize QSize::expandedTo ( const QSize & otherSize ) const" -Returns a size with the maximum width and height of this size and \fIotherSize\fR. -.PP -Examples: -.)l customlayout/card.cpp and customlayout/flow.cpp. -.SH "int QSize::height () const" -Returns the height. -.PP -See also width(). -.PP -Examples: -.)l movies/main.cpp, qfd/fontdisplayer.cpp, and qfd/qfd.cpp. -.SH "bool QSize::isEmpty () const" -Returns TRUE if the width is less than or equal to 0, or the height is less than or equal to 0; otherwise returns FALSE. -.SH "bool QSize::isNull () const" -Returns TRUE if the width is 0 and the height is 0; otherwise returns FALSE. -.SH "bool QSize::isValid () const" -Returns TRUE if the width is equal to or greater than 0 and the height is equal to or greater than 0; otherwise returns FALSE. -.SH "QSize & QSize::operator*= ( int c )" -Multiplies both the width and height by \fIc\fR and returns a reference to the size. -.SH "QSize & QSize::operator*= ( double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Multiplies both the width and height by \fIc\fR and returns a reference to the size. -.PP -Note that the result is truncated. -.SH "QSize & QSize::operator+= ( const QSize & s )" -Adds \fIs\fR to the size and returns a reference to this size. -.PP -Example: -.PP -.nf -.br - QSize s( 3, 7 ); -.br - QSize r( -1, 4 ); -.br - s += r; // s becomes (2,11) -.fi -.SH "QSize & QSize::operator-= ( const QSize & s )" -Subtracts \fIs\fR from the size and returns a reference to this size. -.PP -Example: -.PP -.nf -.br - QSize s( 3, 7 ); -.br - QSize r( -1, 4 ); -.br - s -= r; // s becomes (4,3) -.br -.fi -.SH "QSize & QSize::operator/= ( int c )" -Divides both the width and height by \fIc\fR and returns a reference to the size. -.SH "QSize & QSize::operator/= ( double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Divides both the width and height by \fIc\fR and returns a reference to the size. -.PP -Note that the result is truncated. -.SH "QCOORD & QSize::rheight ()" -Returns a reference to the height. -.PP -Using a reference makes it possible to directly manipulate the height. -.PP -Example: -.PP -.nf -.br - QSize s( 100, 10 ); -.br - s.rheight() += 5; // s becomes (100,15) -.br -.fi -.PP -See also rwidth(). -.SH "QCOORD & QSize::rwidth ()" -Returns a reference to the width. -.PP -Using a reference makes it possible to directly manipulate the width. -.PP -Example: -.PP -.nf -.br - QSize s( 100, 10 ); -.br - s.rwidth() += 20; // s becomes (120,10) -.br -.fi -.PP -See also rheight(). -.SH "void QSize::scale ( int w, int h, ScaleMode mode )" -Scales the size to a rectangle of width \fIw\fR and height \fIh\fR according to the ScaleMode \fImode\fR. -.TP -If \fImode\fR is ScaleFree, the size is set to (\fIw\fR, \fIh\fR). -.TP -If \fImode\fR is ScaleMin, the current size is scaled to a rectangle as large as possible inside (\fIw\fR, \fIh\fR), preserving the aspect ratio. -.TP -If \fImode\fR is ScaleMax, the current size is scaled to a rectangle as small as possible outside (\fIw\fR, \fIh\fR), preserving the aspect ratio. -.PP -Example: -.PP -.nf -.br - QSize t1( 10, 12 ); -.br - t1.scale( 60, 60, QSize::ScaleFree ); -.br - // t1 is (60, 60) -.br -.br - QSize t2( 10, 12 ); -.br - t2.scale( 60, 60, QSize::ScaleMin ); -.br - // t2 is (50, 60) -.br -.br - QSize t3( 10, 12 ); -.br - t3.scale( 60, 60, QSize::ScaleMax ); -.br - // t3 is (60, 72) -.br -.fi -.SH "void QSize::scale ( const QSize & s, ScaleMode mode )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Equivalent to scale(\fIs\fR.width(), \fIs\fR.height(), \fImode\fR). -.SH "void QSize::setHeight ( int h )" -Sets the height to \fIh\fR. -.PP -See also height() and setWidth(). -.SH "void QSize::setWidth ( int w )" -Sets the width to \fIw\fR. -.PP -See also width() and setHeight(). -.SH "void QSize::transpose ()" -Swaps the values of width and height. -.SH "int QSize::width () const" -Returns the width. -.PP -See also height(). -.PP -Examples: -.)l movies/main.cpp, qfd/fontdisplayer.cpp, and qfd/qfd.cpp. -.SH RELATED FUNCTION DOCUMENTATION -.SH "bool operator!= ( const QSize & s1, const QSize & s2 )" -Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. -.SH "const QSize operator* ( const QSize & s, int c )" -Multiplies \fIs\fR by \fIc\fR and returns the result. -.SH "const QSize operator* ( int c, const QSize & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Multiplies \fIs\fR by \fIc\fR and returns the result. -.SH "const QSize operator* ( const QSize & s, double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Multiplies \fIs\fR by \fIc\fR and returns the result. -.SH "const QSize operator* ( double c, const QSize & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Multiplies \fIs\fR by \fIc\fR and returns the result. -.SH "const QSize operator+ ( const QSize & s1, const QSize & s2 )" -Returns the sum of \fIs1\fR and \fIs2\fR; each component is added separately. -.SH "const QSize operator- ( const QSize & s1, const QSize & s2 )" -Returns \fIs2\fR subtracted from \fIs1\fR; each component is subtracted separately. -.SH "const QSize operator/ ( const QSize & s, int c )" -Divides \fIs\fR by \fIc\fR and returns the result. -.SH "const QSize operator/ ( const QSize & s, double c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Divides \fIs\fR by \fIc\fR and returns the result. -.PP -Note that the result is truncated. -.SH "QDataStream & operator<< ( QDataStream & s, const QSize & sz )" -Writes the size \fIsz\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "bool operator== ( const QSize & s1, const QSize & s2 )" -Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. -.SH "QDataStream & operator>> ( QDataStream & s, QSize & sz )" -Reads the size from the stream \fIs\fR into size \fIsz\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsize.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsize.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsizegrip.3qt b/doc/man/man3/qsizegrip.3qt deleted file mode 100644 index 0cacb8227..000000000 --- a/doc/man/man3/qsizegrip.3qt +++ /dev/null @@ -1,100 +0,0 @@ -'\" t -.TH QSizeGrip 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 -QSizeGrip \- Corner-grip for resizing a top-level window -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSizeGrip\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSizeGrip\fR ()" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * e )" -.br -.ti -1c -.BI "virtual void \fBmousePressEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBmouseMoveEvent\fR ( QMouseEvent * e )" -.br -.in -1c -.SH DESCRIPTION -The QSizeGrip class provides a corner-grip for resizing a top-level window. -.PP -This widget works like the standard Windows resize handle. In the X11 version this resize handle generally works differently from the one provided by the system; we hope to reduce this difference in the future. -.PP -Put this widget anywhere in a widget tree and the user can use it to resize the top-level window. Generally, this should be in the lower right-hand corner. Note that QStatusBar already uses this widget, so if you have a status bar (e.g. you are using QMainWindow), then you don't need to use this widget explicitly. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QStatusBar, Widget Appearance and Style, Main Window and Related Classes, and Basic Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSizeGrip::QSizeGrip ( QWidget * parent, const char * name = 0 )" -Constructs a resize corner called \fIname\fR, as a child widget of \fIparent\fR. -.SH "QSizeGrip::~QSizeGrip ()" -Destroys the size grip. -.SH "void QSizeGrip::mouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -Resizes the top-level widget containing this widget. The event is in \fIe\fR. -.PP -Reimplemented from QWidget. -.SH "void QSizeGrip::mousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -Primes the resize operation. The event is in \fIe\fR. -.PP -Reimplemented from QWidget. -.SH "void QSizeGrip::paintEvent ( QPaintEvent * e )\fC [virtual protected]\fR" -Paints the resize grip. Resize grips are usually rendered as small diagonal textured lines in the lower-right corner. The event is in \fIe\fR. -.PP -Reimplemented from QWidget. -.SH "QSize QSizeGrip::sizeHint () const\fC [virtual]\fR" -Returns the size grip's size hint; this is a small size. -.PP -Reimplemented from QWidget. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsizegrip.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsizegrip.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsizepolicy.3qt b/doc/man/man3/qsizepolicy.3qt deleted file mode 100644 index 067a11692..000000000 --- a/doc/man/man3/qsizepolicy.3qt +++ /dev/null @@ -1,238 +0,0 @@ -'\" t -.TH QSizePolicy 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 -QSizePolicy \- Layout attribute describing horizontal and vertical resizing policy -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBSizeType\fR { Fixed = 0, Minimum = MayGrow, Maximum = MayShrink, Preferred = MayGrow | MayShrink, MinimumExpanding = MayGrow | ExpMask, Expanding = MayGrow | MayShrink | ExpMask, Ignored = ExpMask }" -.br -.ti -1c -.BI "enum \fBExpandData\fR { NoDirection = 0, Horizontally = 1, Vertically = 2, Horizontal = Horizontally, Vertical = Vertically, BothDirections = Horizontally | Vertically }" -.br -.ti -1c -.BI "\fBQSizePolicy\fR ()" -.br -.ti -1c -.BI "\fBQSizePolicy\fR ( SizeType hor, SizeType ver, bool hfw = FALSE )" -.br -.ti -1c -.BI "\fBQSizePolicy\fR ( SizeType hor, SizeType ver, uchar horStretch, uchar verStretch, bool hfw = FALSE )" -.br -.ti -1c -.BI "SizeType \fBhorData\fR () const" -.br -.ti -1c -.BI "SizeType \fBverData\fR () const" -.br -.ti -1c -.BI "bool \fBmayShrinkHorizontally\fR () const" -.br -.ti -1c -.BI "bool \fBmayShrinkVertically\fR () const" -.br -.ti -1c -.BI "bool \fBmayGrowHorizontally\fR () const" -.br -.ti -1c -.BI "bool \fBmayGrowVertically\fR () const" -.br -.ti -1c -.BI "ExpandData \fBexpanding\fR () const" -.br -.ti -1c -.BI "void \fBsetHorData\fR ( SizeType d )" -.br -.ti -1c -.BI "void \fBsetVerData\fR ( SizeType d )" -.br -.ti -1c -.BI "void \fBsetHeightForWidth\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBhasHeightForWidth\fR () const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QSizePolicy & s ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QSizePolicy & s ) const" -.br -.ti -1c -.BI "uint \fBhorStretch\fR () const" -.br -.ti -1c -.BI "uint \fBverStretch\fR () const" -.br -.ti -1c -.BI "void \fBsetHorStretch\fR ( uchar sf )" -.br -.ti -1c -.BI "void \fBsetVerStretch\fR ( uchar sf )" -.br -.ti -1c -.BI "void \fBtranspose\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSizePolicy class is a layout attribute describing horizontal and vertical resizing policy. -.PP -The size policy of a widget is an expression of its willingness to be resized in various ways. -.PP -Widgets that reimplement QWidget::sizePolicy() return a QSizePolicy that describes the horizontal and vertical resizing policy they prefer when being laid out. Only one of the constructors is of interest in most applications. -.PP -QSizePolicy contains two independent SizeType objects; one describes the widgets's horizontal size policy, and the other describes its vertical size policy. It also contains a flag to indicate whether the height and width of its preferred size are related. -.PP -The horizontal and vertical SizeTypes are set in the usual constructor and can be queried using a variety of functions. -.PP -The hasHeightForWidth() flag indicates whether the widget's sizeHint() is width-dependent (such as a word-wrapping label) or not. -.PP -See also QSizePolicy::SizeType, Widget Appearance and Style, and Layout Management. -.SS "Member Type Documentation" -.SH "QSizePolicy::ExpandData" -This enum type describes in which directions a widget can make use of extra space. There are four possible values: -.TP -\fCQSizePolicy::NoDirection\fR - the widget cannot make use of extra space in any direction. -.TP -\fCQSizePolicy::Horizontally\fR - the widget can usefully be wider than the sizeHint(). -.TP -\fCQSizePolicy::Vertically\fR - the widget can usefully be taller than the sizeHint(). -.TP -\fCQSizePolicy::BothDirections\fR - the widget can usefully be both wider and taller than the sizeHint(). -.SH "QSizePolicy::SizeType" -The per-dimension sizing types used when constructing a QSizePolicy are: -.TP -\fCQSizePolicy::Fixed\fR - The QWidget::sizeHint() is the only acceptable alternative, so the widget can never grow or shrink (e.g. the vertical direction of a push button). -.TP -\fCQSizePolicy::Minimum\fR - The sizeHint() is minimal, and sufficient. The widget can be expanded, but there is no advantage to it being larger (e.g. the horizontal direction of a push button). It cannot be smaller than the size provided by sizeHint(). -.TP -\fCQSizePolicy::Maximum\fR - The sizeHint() is a maximum. The widget can be shrunk any amount without detriment if other widgets need the space (e.g. a separator line). It cannot be larger than the size provided by sizeHint(). -.TP -\fCQSizePolicy::Preferred\fR - The sizeHint() is best, but the widget can be shrunk and still be useful. The widget can be expanded, but there is no advantage to it being larger than sizeHint() (the default QWidget policy). -.TP -\fCQSizePolicy::Expanding\fR - The sizeHint() is a sensible size, but the widget can be shrunk and still be useful. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a slider). -.TP -\fCQSizePolicy::MinimumExpanding\fR - The sizeHint() is minimal, and sufficient. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a slider). -.TP -\fCQSizePolicy::Ignored\fR - the sizeHint() is ignored. The widget will get as much space as possible. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSizePolicy::QSizePolicy ()" -Constructs a minimally initialized QSizePolicy. -.SH "QSizePolicy::QSizePolicy ( SizeType hor, SizeType ver, bool hfw = FALSE )" -This is the constructor normally used to return a value in the overridden QWidget::sizePolicy() function of a QWidget subclass. -.PP -It constructs a QSizePolicy with independent horizontal and vertical sizing types, \fIhor\fR and \fIver\fR respectively. These sizing types affect how the widget is treated by the layout engine. -.PP -If \fIhfw\fR is TRUE, the preferred height of the widget is dependent on the width of the widget (for example, a QLabel with line wrapping). -.PP -See also horData(), verData(), and hasHeightForWidth(). -.SH "QSizePolicy::QSizePolicy ( SizeType hor, SizeType ver, uchar horStretch, uchar verStretch, bool hfw = FALSE )" -Constructs a QSizePolicy with independent horizontal and vertical sizing types \fIhor\fR and \fIver\fR, and stretch factors \fIhorStretch\fR and \fIverStretch\fR. -.PP -If \fIhfw\fR is TRUE, the preferred height of the widget is dependent on the width of the widget. -.PP -See also horStretch() and verStretch(). -.SH "ExpandData QSizePolicy::expanding () const" -Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas BothDirections means that it wants to grow in both dimensions. -.PP -See also mayShrinkHorizontally(), mayGrowHorizontally(), mayShrinkVertically(), and mayGrowVertically(). -.SH "bool QSizePolicy::hasHeightForWidth () const" -Returns TRUE if the widget's preferred height depends on its width; otherwise returns FALSE. -.PP -See also setHeightForWidth(). -.SH "SizeType QSizePolicy::horData () const" -Returns the horizontal component of the size policy. -.PP -See also setHorData(), verData(), and horStretch(). -.SH "uint QSizePolicy::horStretch () const" -Returns the horizontal stretch factor of the size policy. -.PP -See also setHorStretch() and verStretch(). -.SH "bool QSizePolicy::mayGrowHorizontally () const" -Returns TRUE if the widget can sensibly be wider than its sizeHint(); otherwise returns FALSE. -.PP -See also mayGrowVertically() and mayShrinkHorizontally(). -.SH "bool QSizePolicy::mayGrowVertically () const" -Returns TRUE if the widget can sensibly be taller than its sizeHint(); otherwise returns FALSE. -.PP -See also mayGrowHorizontally() and mayShrinkVertically(). -.SH "bool QSizePolicy::mayShrinkHorizontally () const" -Returns TRUE if the widget can sensibly be narrower than its sizeHint(); otherwise returns FALSE. -.PP -See also mayShrinkVertically() and mayGrowHorizontally(). -.SH "bool QSizePolicy::mayShrinkVertically () const" -Returns TRUE if the widget can sensibly be shorter than its sizeHint(); otherwise returns FALSE. -.PP -See also mayShrinkHorizontally() and mayGrowVertically(). -.SH "bool QSizePolicy::operator!= ( const QSizePolicy & s ) const" -Returns TRUE if this policy is different from \fIs\fR; otherwise returns FALSE. -.PP -See also operator==(). -.SH "bool QSizePolicy::operator== ( const QSizePolicy & s ) const" -Returns TRUE if this policy is equal to \fIs\fR; otherwise returns FALSE. -.PP -See also operator!=(). -.SH "void QSizePolicy::setHeightForWidth ( bool b )" -Sets the hasHeightForWidth() flag to \fIb\fR. -.PP -See also hasHeightForWidth(). -.SH "void QSizePolicy::setHorData ( SizeType d )" -Sets the horizontal component of the size policy to size type \fId\fR. -.PP -See also horData() and setVerData(). -.SH "void QSizePolicy::setHorStretch ( uchar sf )" -Sets the horizontal stretch factor of the size policy to \fIsf\fR. -.PP -See also horStretch() and setVerStretch(). -.SH "void QSizePolicy::setVerData ( SizeType d )" -Sets the vertical component of the size policy to size type \fId\fR. -.PP -See also verData() and setHorData(). -.SH "void QSizePolicy::setVerStretch ( uchar sf )" -Sets the vertical stretch factor of the size policy to \fIsf\fR. -.PP -See also verStretch() and setHorStretch(). -.SH "void QSizePolicy::transpose ()" -Swaps the horizontal and vertical policies and stretches. -.SH "SizeType QSizePolicy::verData () const" -Returns the vertical component of the size policy. -.PP -See also setVerData(), horData(), and verStretch(). -.SH "uint QSizePolicy::verStretch () const" -Returns the vertical stretch factor of the size policy. -.PP -See also setVerStretch() and horStretch(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsizepolicy.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsizepolicy.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsjiscodec.3qt b/doc/man/man3/qsjiscodec.3qt deleted file mode 100644 index cbfd3ba48..000000000 --- a/doc/man/man3/qsjiscodec.3qt +++ /dev/null @@ -1,83 +0,0 @@ -'\" t -.TH QSjisCodec 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 -QSjisCodec \- Conversion to and from Shift-JIS -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                                      -.PP -\fC#include \fR -.PP -Inherits QTextCodec. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual const char * \fBmimeName\fR () const" -.br -.ti -1c -.BI "\fBQSjisCodec\fR ()" -.br -.ti -1c -.BI "\fB~QSjisCodec\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSjisCodec class provides conversion to and from Shift-JIS. -.PP -More precisely, the QSjisCodec class subclasses QTextCodec to provide support for Shift-JIS, an encoding of JIS X 0201 Latin, JIS X 0201 Kana or JIS X 0208. -.PP -The environment variable \fCUNICODEMAP_JP\fR can be used to fine-tune QJisCodec, QSjisCodec and QEucJpCodec. The QJisCodec documentation describes how to use this variable. -.PP -Most of the code here was written by Serika Kurusugawa, a.k.a. Junji Takagi, and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for the code as it was at the point of contribution. Trolltech's subsequent modifications are covered by the usual copyright for Qt. -.PP -Copyright (C) 1999 Serika Kurusugawa. All rights reserved. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
                                                        -.IP 1 -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.IP 2 -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS". ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.PP -See also Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSjisCodec::QSjisCodec ()" -Creates a Shift-JIS codec. Note that this is done automatically by the QApplication, you do not need construct your own. -.SH "QSjisCodec::~QSjisCodec ()" -Destroys the Shift-JIS codec. -.SH "const char * QSjisCodec::mimeName () const\fC [virtual]\fR" -Returns the codec's mime name. -.PP -Reimplemented from QTextCodec. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsjiscodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsjiscodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qslider.3qt b/doc/man/man3/qslider.3qt deleted file mode 100644 index 52f262ecc..000000000 --- a/doc/man/man3/qslider.3qt +++ /dev/null @@ -1,390 +0,0 @@ -'\" t -.TH QSlider 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 -QSlider \- Vertical or horizontal slider -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget and QRangeControl. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBTickSetting\fR { NoMarks = 0, Above = 1, Left = Above, Below = 2, Right = Below, Both = 3 }" -.br -.ti -1c -.BI "\fBQSlider\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQSlider\fR ( Orientation orientation, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQSlider\fR ( int minValue, int maxValue, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSlider\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetOrientation\fR ( Orientation )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTracking\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBtracking\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPalette\fR ( const QPalette & p )" -.br -.ti -1c -.BI "int \fBsliderStart\fR () const" -.br -.ti -1c -.BI "QRect \fBsliderRect\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTickmarks\fR ( TickSetting )" -.br -.ti -1c -.BI "TickSetting \fBtickmarks\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTickInterval\fR ( int )" -.br -.ti -1c -.BI "int \fBtickInterval\fR () const" -.br -.ti -1c -.BI "int \fBminValue\fR () const" -.br -.ti -1c -.BI "int \fBmaxValue\fR () const" -.br -.ti -1c -.BI "void \fBsetMinValue\fR ( int )" -.br -.ti -1c -.BI "void \fBsetMaxValue\fR ( int )" -.br -.ti -1c -.BI "int \fBlineStep\fR () const" -.br -.ti -1c -.BI "int \fBpageStep\fR () const" -.br -.ti -1c -.BI "void \fBsetLineStep\fR ( int )" -.br -.ti -1c -.BI "void \fBsetPageStep\fR ( int )" -.br -.ti -1c -.BI "int \fBvalue\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetValue\fR ( int )" -.br -.ti -1c -.BI "void \fBaddStep\fR ()" -.br -.ti -1c -.BI "void \fBsubtractStep\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBvalueChanged\fR ( int value )" -.br -.ti -1c -.BI "void \fBsliderPressed\fR ()" -.br -.ti -1c -.BI "void \fBsliderMoved\fR ( int value )" -.br -.ti -1c -.BI "void \fBsliderReleased\fR ()" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "void \fBsetRange\fR ( int minValue, int maxValue )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBlineStep\fR - the current line step" -.br -.ti -1c -.BI "int \fBmaxValue\fR - the current maximum value of the slider" -.br -.ti -1c -.BI "int \fBminValue\fR - the current minimum value of the slider" -.br -.ti -1c -.BI "Orientation \fBorientation\fR - the slider's orientation" -.br -.ti -1c -.BI "int \fBpageStep\fR - the current page step" -.br -.ti -1c -.BI "int \fBtickInterval\fR - the interval between tickmarks" -.br -.ti -1c -.BI "TickSetting \fBtickmarks\fR - the tickmark settings for this slider" -.br -.ti -1c -.BI "bool \fBtracking\fR - whether slider tracking is enabled" -.br -.ti -1c -.BI "int \fBvalue\fR - the current slider value" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBvalueChange\fR ()" -.br -.ti -1c -.BI "virtual void \fBrangeChange\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSlider widget provides a vertical or horizontal slider. -.PP -The slider is the classic widget for controlling a bounded value. It lets the user move a slider along a horizontal or vertical groove and translates the slider's position into an integer value within the legal range. -.PP -QSlider inherits QRangeControl, which provides the "integer" side of the slider. setRange() and value() are likely to be used by practically all slider users; see the QRangeControl documentation for information about the many other functions that class provides. -.PP -The main functions offered by the slider itself are tickmark and orientation control; you can use setTickmarks() to indicate where you want the tickmarks to be, setTickInterval() to indicate how many of them you want and setOrientation() to indicate whether the slider is to be horizontal or vertical. -.PP -A slider accepts focus on Tab and uses the mouse wheel and a suitable keyboard interface. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QScrollBar, QSpinBox, GUI Design Handbook: Slider, and Basic Widgets. -.SS "Member Type Documentation" -.SH "QSlider::TickSetting" -This enum specifies where the tickmarks are to be drawn relative to the slider's groove and the handle the user moves. -.TP -\fCQSlider::NoMarks\fR - do not draw any tickmarks. -.TP -\fCQSlider::Both\fR - draw tickmarks on both sides of the groove. -.TP -\fCQSlider::Above\fR - draw tickmarks above the (horizontal) slider -.TP -\fCQSlider::Below\fR - draw tickmarks below the (horizontal) slider -.TP -\fCQSlider::Left\fR - draw tickmarks to the left of the (vertical) slider -.TP -\fCQSlider::Right\fR - draw tickmarks to the right of the (vertical) slider -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSlider::QSlider ( QWidget * parent, const char * name = 0 )" -Constructs a vertical slider. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.SH "QSlider::QSlider ( Orientation orientation, QWidget * parent, const char * name = 0 )" -Constructs a slider. -.PP -The \fIorientation\fR must be Qt::Vertical or Qt::Horizontal. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.SH "QSlider::QSlider ( int minValue, int maxValue, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" -Constructs a slider whose value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR, whose page step size is \fIpageStep\fR and whose value is initially \fIvalue\fR (which is guaranteed to be in range using bound()). -.PP -If \fIorientation\fR is Qt::Vertical the slider is vertical and if it is Qt::Horizontal the slider is horizontal. -.PP -The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. -.SH "QSlider::~QSlider ()" -Destructor. -.SH "void QSlider::addStep ()\fC [slot]\fR" -Moves the slider one pageStep() up or right. -.SH "int QSlider::lineStep () const" -Returns the current line step. See the "lineStep" property for details. -.SH "int QSlider::maxValue () const" -Returns the current maximum value of the slider. See the "maxValue" property for details. -.SH "int QSlider::minValue () const" -Returns the current minimum value of the slider. See the "minValue" property for details. -.SH "Orientation QSlider::orientation () const" -Returns the slider's orientation. See the "orientation" property for details. -.SH "int QSlider::pageStep () const" -Returns the current page step. See the "pageStep" property for details. -.SH "void QSlider::rangeChange ()\fC [virtual protected]\fR" -Implements the virtual QRangeControl function. -.PP -Reimplemented from QRangeControl. -.SH "void QSlider::setLineStep ( int )" -Sets the current line step. See the "lineStep" property for details. -.SH "void QSlider::setMaxValue ( int )" -Sets the current maximum value of the slider. See the "maxValue" property for details. -.SH "void QSlider::setMinValue ( int )" -Sets the current minimum value of the slider. See the "minValue" property for details. -.SH "void QSlider::setOrientation ( Orientation )\fC [virtual]\fR" -Sets the slider's orientation. See the "orientation" property for details. -.SH "void QSlider::setPageStep ( int )" -Sets the current page step. See the "pageStep" property for details. -.SH "void QSlider::setPalette ( const QPalette & p )\fC [virtual]\fR" -Reimplements the virtual function QWidget::setPalette(). -.PP -Sets the background color to the mid color for Motif style sliders using palette \fIp\fR. -.PP -Reimplemented from QWidget. -.SH "void QRangeControl::setRange ( int minValue, int maxValue )" -Sets the range control's minimum value to \fIminValue\fR and its maximum value to \fImaxValue\fR. -.PP -Calls the virtual rangeChange() function if one or both of the new minimum and maximum values are different from the previous setting. Calls the virtual valueChange() function if the current value is adjusted because it was outside the new range. -.PP -If \fImaxValue\fR is smaller than \fIminValue\fR, \fIminValue\fR becomes the only legal value. -.PP -See also minValue and maxValue. -.PP -Examples: -.)l listbox/listbox.cpp, t12/lcdrange.cpp, t5/main.cpp, t6/main.cpp, t8/lcdrange.cpp, and xform/xform.cpp. -.SH "void QSlider::setTickInterval ( int )\fC [virtual]\fR" -Sets the interval between tickmarks. See the "tickInterval" property for details. -.SH "void QSlider::setTickmarks ( TickSetting )\fC [virtual]\fR" -Sets the tickmark settings for this slider. See the "tickmarks" property for details. -.SH "void QSlider::setTracking ( bool enable )\fC [virtual]\fR" -Sets whether slider tracking is enabled to \fIenable\fR. See the "tracking" property for details. -.SH "void QSlider::setValue ( int )\fC [virtual slot]\fR" -Sets the current slider value. See the "value" property for details. -.SH "void QSlider::sliderMoved ( int value )\fC [signal]\fR" -This signal is emitted when the slider is dragged, with the new slider \fIvalue\fR as its argument. -.SH "void QSlider::sliderPressed ()\fC [signal]\fR" -This signal is emitted when the user presses the slider with the mouse. -.SH "QRect QSlider::sliderRect () const" -Returns the slider handle rectangle. (This is the visual marker that the user can move.) -.SH "void QSlider::sliderReleased ()\fC [signal]\fR" -This signal is emitted when the user releases the slider with the mouse. -.SH "int QSlider::sliderStart () const" -Returns the start position of the slider. -.SH "void QSlider::subtractStep ()\fC [slot]\fR" -Moves the slider one pageStep() down or left. -.SH "int QSlider::tickInterval () const" -Returns the interval between tickmarks. See the "tickInterval" property for details. -.SH "TickSetting QSlider::tickmarks () const" -Returns the tickmark settings for this slider. See the "tickmarks" property for details. -.SH "bool QSlider::tracking () const" -Returns TRUE if slider tracking is enabled; otherwise returns FALSE. See the "tracking" property for details. -.SH "int QSlider::value () const" -Returns the current slider value. See the "value" property for details. -.SH "void QSlider::valueChange ()\fC [virtual protected]\fR" -Implements the virtual QRangeControl function. -.PP -Reimplemented from QRangeControl. -.SH "void QSlider::valueChanged ( int value )\fC [signal]\fR" -This signal is emitted when the slider value is changed, with the new slider \fIvalue\fR as its argument. -.PP -Examples: -.)l rangecontrols/rangecontrols.cpp, simple/main.cpp, t12/lcdrange.cpp, t5/main.cpp, t6/main.cpp, t7/lcdrange.cpp, and xform/xform.cpp. -.SS "Property Documentation" -.SH "int lineStep" -This property holds the current line step. -.PP -When setting lineStep, the virtual stepChange() function will be called if the new line step is different from the previous setting. -.PP -See also setSteps(), QRangeControl::pageStep(), and setRange(). -.PP -Set this property's value with setLineStep() and get this property's value with lineStep(). -.SH "int maxValue" -This property holds the current maximum value of the slider. -.PP -When setting this property, the QSlider::minValue is adjusted, if necessary, to ensure that the range remains valid. -.PP -See also setRange(). -.PP -Set this property's value with setMaxValue() and get this property's value with maxValue(). -.SH "int minValue" -This property holds the current minimum value of the slider. -.PP -When setting this property, the QSlider::maxValue is adjusted, if necessary, to ensure that the range remains valid. -.PP -See also setRange(). -.PP -Set this property's value with setMinValue() and get this property's value with minValue(). -.SH "Orientation orientation" -This property holds the slider's orientation. -.PP -The orientation must be Qt::Vertical (the default) or Qt::Horizontal. -.PP -Set this property's value with setOrientation() and get this property's value with orientation(). -.SH "int pageStep" -This property holds the current page step. -.PP -When setting pageStep, the virtual stepChange() function will be called if the new page step is different from the previous setting. -.PP -See also QRangeControl::setSteps(), lineStep, and setRange(). -.PP -Set this property's value with setPageStep() and get this property's value with pageStep(). -.SH "int tickInterval" -This property holds the interval between tickmarks. -.PP -This is a value interval, not a pixel interval. If it is 0, the slider will choose between lineStep() and pageStep(). The initial value of tickInterval is 0. -.PP -See also QRangeControl::lineStep() and QRangeControl::pageStep(). -.PP -Set this property's value with setTickInterval() and get this property's value with tickInterval(). -.SH "TickSetting tickmarks" -This property holds the tickmark settings for this slider. -.PP -The valid values are in QSlider::TickSetting. The default is NoMarks. -.PP -See also tickInterval. -.PP -Set this property's value with setTickmarks() and get this property's value with tickmarks(). -.SH "bool tracking" -This property holds whether slider tracking is enabled. -.PP -If tracking is enabled (the default), the slider emits the valueChanged() signal whenever the slider is being dragged. If tracking is disabled, the slider emits the valueChanged() signal when the user releases the mouse button (unless the value happens to be the same as before). -.PP -Set this property's value with setTracking() and get this property's value with tracking(). -.SH "int value" -This property holds the current slider value. -.PP -Set this property's value with setValue() and get this property's value with value(). -.PP -See also QRangeControl::value() and prevValue(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqslider.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qslider.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsocket.3qt b/doc/man/man3/qsocket.3qt deleted file mode 100644 index 2a643b61c..000000000 --- a/doc/man/man3/qsocket.3qt +++ /dev/null @@ -1,471 +0,0 @@ -'\" t -.TH QSocket 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 -QSocket \- Buffered TCP connection -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject and QIODevice. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBError\fR { ErrConnectionRefused, ErrHostNotFound, ErrSocketRead }" -.br -.ti -1c -.BI "\fBQSocket\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QSocket\fR ()" -.br -.ti -1c -.BI "enum \fBState\fR { Idle, HostLookup, Connecting, Connected, Closing, Connection = Connected }" -.br -.ti -1c -.BI "State \fBstate\fR () const" -.br -.ti -1c -.BI "int \fBsocket\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSocket\fR ( int socket )" -.br -.ti -1c -.BI "QSocketDevice * \fBsocketDevice\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetSocketDevice\fR ( QSocketDevice * device )" -.br -.ti -1c -.BI "virtual void \fBconnectToHost\fR ( const QString & host, TQ_UINT16 port )" -.br -.ti -1c -.BI "QString \fBpeerName\fR () const" -.br -.ti -1c -.BI "virtual bool \fBopen\fR ( int m )" -.br -.ti -1c -.BI "virtual void \fBclose\fR ()" -.br -.ti -1c -.BI "virtual void \fBflush\fR ()" -.br -.ti -1c -.BI "virtual Offset \fBsize\fR () const" -.br -.ti -1c -.BI "virtual Offset \fBat\fR () const" -.br -.ti -1c -.BI "virtual bool \fBat\fR ( Offset index )" -.br -.ti -1c -.BI "virtual bool \fBatEnd\fR () const" -.br -.ti -1c -.BI "TQ_ULONG \fBbytesAvailable\fR () const" -.br -.ti -1c -.BI "TQ_ULONG \fBwaitForMore\fR ( int msecs, bool * timeout ) const" -.br -.ti -1c -.BI "TQ_ULONG \fBwaitForMore\fR ( int msecs ) const" -.br -.ti -1c -.BI "TQ_ULONG \fBbytesToWrite\fR () const" -.br -.ti -1c -.BI "void \fBclearPendingData\fR ()" -.br -.ti -1c -.BI "virtual TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" -.br -.ti -1c -.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len )" -.br -.ti -1c -.BI "virtual int \fBgetch\fR ()" -.br -.ti -1c -.BI "virtual int \fBputch\fR ( int ch )" -.br -.ti -1c -.BI "virtual int \fBungetch\fR ( int ch )" -.br -.ti -1c -.BI "bool \fBcanReadLine\fR () const" -.br -.ti -1c -.BI "virtual QString \fBreadLine\fR ()" -.br -.ti -1c -.BI "TQ_UINT16 \fBport\fR () const" -.br -.ti -1c -.BI "TQ_UINT16 \fBpeerPort\fR () const" -.br -.ti -1c -.BI "QHostAddress \fBaddress\fR () const" -.br -.ti -1c -.BI "QHostAddress \fBpeerAddress\fR () const" -.br -.ti -1c -.BI "void \fBsetReadBufferSize\fR ( TQ_ULONG bufSize )" -.br -.ti -1c -.BI "TQ_ULONG \fBreadBufferSize\fR () const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBhostFound\fR ()" -.br -.ti -1c -.BI "void \fBconnected\fR ()" -.br -.ti -1c -.BI "void \fBconnectionClosed\fR ()" -.br -.ti -1c -.BI "void \fBdelayedCloseFinished\fR ()" -.br -.ti -1c -.BI "void \fBreadyRead\fR ()" -.br -.ti -1c -.BI "void \fBbytesWritten\fR ( int nbytes )" -.br -.ti -1c -.BI "void \fBerror\fR ( int )" -.br -.in -1c -.SH DESCRIPTION -The QSocket class provides a buffered TCP connection. -.PP -It provides a totally non-blocking QIODevice, and modifies and extends the API of QIODevice with socket-specific code. -.PP -Note that a QApplication must have been constructed before this class can be used. -.PP -The functions you're likely to call most are connectToHost(), bytesAvailable(), canReadLine() and the ones it inherits from QIODevice. -.PP -connectToHost() is the most-used function. As its name implies, it opens a connection to a named host. -.PP -Most network protocols are either packet-oriented or line-oriented. canReadLine() indicates whether a connection contains an entire unread line or not, and bytesAvailable() returns the number of bytes available for reading. -.PP -The signals error(), connected(), readyRead() and connectionClosed() inform you of the progress of the connection. There are also some less commonly used signals. hostFound() is emitted when connectToHost() has finished its DNS lookup and is starting its TCP connection. delayedCloseFinished() is emitted when close() succeeds. bytesWritten() is emitted when QSocket moves data from its "to be written" queue into the TCP implementation. -.PP -There are several access functions for the socket: state() returns whether the object is idle, is doing a DNS lookup, is connecting, has an operational connection, etc. address() and port() return the IP address and port used for the connection. The peerAddress() and peerPort() functions return the IP address and port used by the peer, and peerName() returns the name of the peer (normally the name that was passed to connectToHost()). socketDevice() returns a pointer to the QSocketDevice used for this socket. -.PP -QSocket inherits QIODevice, and reimplements some functions. In general, you can treat it as a QIODevice for writing, and mostly also for reading. The match isn't perfect, since the QIODevice API is designed for devices that are controlled by the same machine, and an asynchronous peer-to-peer network connection isn't quite like that. For example, there is nothing that matches QIODevice::size() exactly. The documentation for open(), close(), flush(), size(), at(), atEnd(), readBlock(), writeBlock(), getch(), putch(), ungetch() and readLine() describes the differences in detail. -.PP -\fBWarning:\fR QSocket is not suitable for use in threads. If you need to uses sockets in threads use the lower-level QSocketDevice class. -.PP -\fBWarning:\fR Because Qt doesn't use the native socketstream implementation on Mac OS X, QSocket has an implicit transfer latency of 100ms. You can achieve lower latency on Mac OS X by using QSocketDevice instead. -.PP -See also QSocketDevice, QHostAddress, QSocketNotifier, and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QSocket::Error" -This enum specifies the possible errors: -.TP -\fCQSocket::ErrConnectionRefused\fR - if the connection was refused -.TP -\fCQSocket::ErrHostNotFound\fR - if the host was not found -.TP -\fCQSocket::ErrSocketRead\fR - if a read from the socket failed -.SH "QSocket::State" -This enum defines the connection states: -.TP -\fCQSocket::Idle\fR - if there is no connection -.TP -\fCQSocket::HostLookup\fR - during a DNS lookup -.TP -\fCQSocket::Connecting\fR - during TCP connection establishment -.TP -\fCQSocket::Connected\fR - when there is an operational connection -.TP -\fCQSocket::Closing\fR - if the socket is closing down, but is not yet closed. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSocket::QSocket ( QObject * parent = 0, const char * name = 0 )" -Creates a QSocket object in QSocket::Idle state. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. -.PP -Note that a QApplication must have been constructed before sockets can be used. -.SH "QSocket::~QSocket ()\fC [virtual]\fR" -Destroys the socket. Closes the connection if necessary. -.PP -See also close(). -.SH "QHostAddress QSocket::address () const" -Returns the host address of this socket. (This is normally the main IP address of the host, but can be e.g. 127.0.0.1 for connections to localhost.) -.SH "Offset QSocket::at () const\fC [virtual]\fR" -Returns the current read index. Since QSocket is a sequential device, the current read index is always zero. -.PP -Reimplemented from QIODevice. -.SH "bool QSocket::at ( Offset index )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Moves the read index forward to \fIindex\fR and returns TRUE if the operation was successful; otherwise returns FALSE. Moving the index forward means skipping incoming data. -.PP -Reimplemented from QIODevice. -.SH "bool QSocket::atEnd () const\fC [virtual]\fR" -Returns TRUE if there is no more data to read; otherwise returns FALSE. -.PP -Reimplemented from QIODevice. -.SH "TQ_ULONG QSocket::bytesAvailable () const" -Returns the number of incoming bytes that can be read, i.e. the size of the input buffer. Equivalent to size(). -.PP -This function can trigger the readyRead() signal, if more data has arrived on the socket. -.PP -See also bytesToWrite(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "TQ_ULONG QSocket::bytesToWrite () const" -Returns the number of bytes that are waiting to be written, i.e. the size of the output buffer. -.PP -See also bytesAvailable() and clearPendingData(). -.SH "void QSocket::bytesWritten ( int nbytes )\fC [signal]\fR" -This signal is emitted when data has been written to the network. The \fInbytes\fR parameter specifies how many bytes were written. -.PP -The bytesToWrite() function is often used in the same context; it indicates how many buffered bytes there are left to write. -.PP -See also writeBlock() and bytesToWrite(). -.SH "bool QSocket::canReadLine () const" -Returns TRUE if it's possible to read an entire line of text from this socket at this time; otherwise returns FALSE. -.PP -Note that if the peer closes the connection unexpectedly, this function returns FALSE. This means that loops such as this won't work: -.PP -.nf -.br - while( !socket->canReadLine() ) // WRONG -.br - ; -.br -.fi -.PP -See also readLine(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. -.SH "void QSocket::clearPendingData ()" -Deletes the data that is waiting to be written. This is useful if you want to close the socket without waiting for all the data to be written. -.PP -See also bytesToWrite(), close(), and delayedCloseFinished(). -.SH "void QSocket::close ()\fC [virtual]\fR" -Closes the socket. -.PP -The read buffer is cleared. -.PP -If the output buffer is empty, the state is set to QSocket::Idle and the connection is terminated immediately. If the output buffer still contains data to be written, QSocket goes into the QSocket::Closing state and the rest of the data will be written. When all of the outgoing data have been written, the state is set to QSocket::Idle and the connection is terminated. At this point, the delayedCloseFinished() signal is emitted. -.PP -If you don't want that the data of the output buffer is written, call clearPendingData() before you call close(). -.PP -See also state(), bytesToWrite(), and clearPendingData(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, and network/networkprotocol/nntp.cpp. -.PP -Reimplemented from QIODevice. -.SH "void QSocket::connectToHost ( const QString & host, TQ_UINT16 port )\fC [virtual]\fR" -Attempts to make a connection to \fIhost\fR on the specified \fIport\fR and return immediately. -.PP -Any connection or pending connection is closed immediately, and QSocket goes into the HostLookup state. When the lookup succeeds, it emits hostFound(), starts a TCP connection and goes into the Connecting state. Finally, when the connection succeeds, it emits connected() and goes into the Connected state. If there is an error at any point, it emits error(). -.PP -\fIhost\fR may be an IP address in string form, or it may be a DNS name. QSocket will do a normal DNS lookup if required. Note that \fIport\fR is in native byte order, unlike some other libraries. -.PP -See also state(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. -.SH "void QSocket::connected ()\fC [signal]\fR" -This signal is emitted after connectToHost() has been called and a connection has been successfully established. -.PP -See also connectToHost() and connectionClosed(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. -.SH "void QSocket::connectionClosed ()\fC [signal]\fR" -This signal is emitted when the other end has closed the connection. The read buffers may contain buffered input data which you can read after the connection was closed. -.PP -See also connectToHost() and close(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/clientserver/server/server.cpp, and network/networkprotocol/nntp.cpp. -.SH "void QSocket::delayedCloseFinished ()\fC [signal]\fR" -This signal is emitted when a delayed close is finished. -.PP -If you call close() and there is buffered output data to be written, QSocket goes into the QSocket::Closing state and returns immediately. It will then keep writing to the socket until all the data has been written. Then, the delayedCloseFinished() signal is emitted. -.PP -See also close(). -.PP -Examples: -.)l network/clientserver/client/client.cpp and network/httpd/httpd.cpp. -.SH "void QSocket::error ( int )\fC [signal]\fR" -This signal is emitted after an error occurred. The parameter is the Error value. -.PP -Examples: -.)l network/clientserver/client/client.cpp and network/networkprotocol/nntp.cpp. -.SH "void QSocket::flush ()\fC [virtual]\fR" -Implementation of the abstract virtual QIODevice::flush() function. -.PP -Reimplemented from QIODevice. -.SH "int QSocket::getch ()\fC [virtual]\fR" -Reads a single byte/character from the internal read buffer. Returns the byte/character read, or -1 if there is nothing to be read. -.PP -See also bytesAvailable() and putch(). -.PP -Reimplemented from QIODevice. -.SH "void QSocket::hostFound ()\fC [signal]\fR" -This signal is emitted after connectToHost() has been called and the host lookup has succeeded. -.PP -See also connected(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "bool QSocket::open ( int m )\fC [virtual]\fR" -Opens the socket using the specified QIODevice file mode \fIm\fR. This function is called automatically when needed and you should not call it yourself. -.PP -See also close(). -.PP -Reimplemented from QIODevice. -.SH "QHostAddress QSocket::peerAddress () const" -Returns the address of the connected peer if the socket is in Connected state; otherwise an empty QHostAddress is returned. -.SH "QString QSocket::peerName () const" -Returns the host name as specified to the connectToHost() function. An empty string is returned if none has been set. -.PP -Example: network/mail/smtp.cpp. -.SH "TQ_UINT16 QSocket::peerPort () const" -Returns the peer's host port number, normally as specified to the connectToHost() function. If none has been set, this function returns 0. -.PP -Note that Qt always uses native byte order, i.e. 67 is 67 in Qt; there is no need to call htons(). -.SH "TQ_UINT16 QSocket::port () const" -Returns the host port number of this socket, in native byte order. -.SH "int QSocket::putch ( int ch )\fC [virtual]\fR" -Writes the character \fIch\fR to the output buffer. -.PP -Returns \fIch\fR, or -1 if an error occurred. -.PP -See also getch(). -.PP -Reimplemented from QIODevice. -.SH "TQ_LONG QSocket::readBlock ( char * data, TQ_ULONG maxlen )\fC [virtual]\fR" -Reads \fImaxlen\fR bytes from the socket into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. -.PP -Example: network/networkprotocol/nntp.cpp. -.PP -Reimplemented from QIODevice. -.SH "TQ_ULONG QSocket::readBufferSize () const" -Returns the size of the read buffer. -.PP -See also setReadBufferSize(). -.SH "QString QSocket::readLine ()\fC [virtual]\fR" -Returns a line of text including a terminating newline character (\\n). Returns "" if canReadLine() returns FALSE. -.PP -See also canReadLine(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. -.SH "void QSocket::readyRead ()\fC [signal]\fR" -This signal is emitted every time there is new incoming data. -.PP -Bear in mind that new incoming data is only reported once; if you do not read all the data, this class buffers the data and you can read it later, but no signal is emitted unless new data arrives. A good practice is to read all data in the slot connected to this signal unless you are sure that you need to receive more data to be able to process it. -.PP -See also readBlock(), readLine(), and bytesAvailable(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. -.SH "void QSocket::setReadBufferSize ( TQ_ULONG bufSize )" -Sets the size of the QSocket's internal read buffer to \fIbufSize\fR. -.PP -Usually QSocket reads all data that is available from the operating system's socket. If the buffer size is limited to a certain size, this means that the QSocket class doesn't buffer more than this size of data. -.PP -If the size of the read buffer is 0, the read buffer is unlimited and all incoming data is buffered. This is the default. -.PP -If you read the data in the readyRead() signal, you shouldn't use this option since it might slow down your program unnecessary. This option is useful if you only need to read the data at certain points in time, like in a realtime streaming application. -.PP -See also readBufferSize(). -.SH "void QSocket::setSocket ( int socket )\fC [virtual]\fR" -Sets the socket to use \fIsocket\fR and the state() to Connected. The socket must already be connected. -.PP -This allows us to use the QSocket class as a wrapper for other socket types (e.g. Unix Domain Sockets). -.PP -Example: network/httpd/httpd.cpp. -.SH "void QSocket::setSocketDevice ( QSocketDevice * device )\fC [virtual]\fR" -Sets the internal socket device to \fIdevice\fR. Passing a \fIdevice\fR of 0 will cause the internal socket device to be used. Any existing connection will be disconnected before using the new \fIdevice\fR. -.PP -The new device should not be connected before being associated with a QSocket; after setting the socket call connectToHost() to make the connection. -.PP -This function is useful if you need to subclass QSocketDevice and want to use the QSocket API, for example, to implement Unix domain sockets. -.SH "Offset QSocket::size () const\fC [virtual]\fR" -Returns the number of incoming bytes that can be read right now (like bytesAvailable()). -.PP -Reimplemented from QIODevice. -.SH "int QSocket::socket () const" -Returns the socket number, or -1 if there is no socket at the moment. -.SH "QSocketDevice * QSocket::socketDevice ()" -Returns a pointer to the internal socket device. -.PP -There is normally no need to manipulate the socket device directly since this class does the necessary setup for most applications. -.SH "State QSocket::state () const" -Returns the current state of the socket connection. -.PP -See also QSocket::State. -.PP -Examples: -.)l network/clientserver/client/client.cpp and network/networkprotocol/nntp.cpp. -.SH "int QSocket::ungetch ( int ch )\fC [virtual]\fR" -This implementation of the virtual function QIODevice::ungetch() prepends the character \fIch\fR to the read buffer so that the next read returns this character as the first character of the output. -.PP -Reimplemented from QIODevice. -.SH "TQ_ULONG QSocket::waitForMore ( int msecs, bool * timeout ) const" -Wait up to \fImsecs\fR milliseconds for more data to be available. -.PP -If \fImsecs\fR is -1 the call will block indefinitely. -.PP -Returns the number of bytes available. -.PP -If \fItimeout\fR is non-null and no error occurred (i.e. it does not return -1): this function sets \fI*timeout\fR to TRUE, if the reason for returning was that the timeout was reached; otherwise it sets \fI*timeout\fR to FALSE. This is useful to find out if the peer closed the connection. -.PP -\fBWarning:\fR This is a blocking call and should be avoided in event driven applications. -.PP -See also bytesAvailable(). -.SH "TQ_ULONG QSocket::waitForMore ( int msecs ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "TQ_LONG QSocket::writeBlock ( const char * data, TQ_ULONG len )\fC [virtual]\fR" -Writes \fIlen\fR bytes to the socket from \fIdata\fR and returns the number of bytes written. Returns -1 if an error occurred. -.PP -Example: network/networkprotocol/nntp.cpp. -.PP -Reimplemented from QIODevice. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsocket.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsocket.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsocketdevice.3qt b/doc/man/man3/qsocketdevice.3qt deleted file mode 100644 index aaf0c39c1..000000000 --- a/doc/man/man3/qsocketdevice.3qt +++ /dev/null @@ -1,373 +0,0 @@ -'\" t -.TH QSocketDevice 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 -QSocketDevice \- Platform-independent low-level socket API -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QIODevice. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBType\fR { Stream, Datagram }" -.br -.ti -1c -.BI "enum \fBProtocol\fR { IPv4, IPv6, Unknown }" -.br -.ti -1c -.BI "\fBQSocketDevice\fR ( Type type = Stream )" -.br -.ti -1c -.BI "\fBQSocketDevice\fR ( Type type, Protocol protocol, int dummy )" -.br -.ti -1c -.BI "\fBQSocketDevice\fR ( int socket, Type type )" -.br -.ti -1c -.BI "virtual \fB~QSocketDevice\fR ()" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "Type \fBtype\fR () const" -.br -.ti -1c -.BI "Protocol \fBprotocol\fR () const" -.br -.ti -1c -.BI "int \fBsocket\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSocket\fR ( int socket, Type type )" -.br -.ti -1c -.BI "bool \fBblocking\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetBlocking\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBaddressReusable\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAddressReusable\fR ( bool enable )" -.br -.ti -1c -.BI "int \fBreceiveBufferSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetReceiveBufferSize\fR ( uint size )" -.br -.ti -1c -.BI "int \fBsendBufferSize\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSendBufferSize\fR ( uint size )" -.br -.ti -1c -.BI "virtual bool \fBconnect\fR ( const QHostAddress & addr, TQ_UINT16 port )" -.br -.ti -1c -.BI "virtual bool \fBbind\fR ( const QHostAddress & address, TQ_UINT16 port )" -.br -.ti -1c -.BI "virtual bool \fBlisten\fR ( int backlog )" -.br -.ti -1c -.BI "virtual int \fBaccept\fR ()" -.br -.ti -1c -.BI "TQ_LONG \fBbytesAvailable\fR () const" -.br -.ti -1c -.BI "TQ_LONG \fBwaitForMore\fR ( int msecs, bool * timeout = 0 ) const" -.br -.ti -1c -.BI "virtual TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" -.br -.ti -1c -.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len )" -.br -.ti -1c -.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len, const QHostAddress & host, TQ_UINT16 port )" -.br -.ti -1c -.BI "TQ_UINT16 \fBport\fR () const" -.br -.ti -1c -.BI "TQ_UINT16 \fBpeerPort\fR () const" -.br -.ti -1c -.BI "QHostAddress \fBaddress\fR () const" -.br -.ti -1c -.BI "QHostAddress \fBpeerAddress\fR () const" -.br -.ti -1c -.BI "enum \fBError\fR { NoError, AlreadyBound, Inaccessible, NoResources, InternalError, Bug = InternalError, Impossible, NoFiles, ConnectionRefused, NetworkFailure, UnknownError }" -.br -.ti -1c -.BI "Error \fBerror\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsetError\fR ( Error err )" -.br -.in -1c -.SH DESCRIPTION -The QSocketDevice class provides a platform-independent low-level socket API. -.PP -This class provides a low level API for working with sockets. Users of this class are assumed to have networking experience. For most users the QSocket class provides a much easier and high level alternative, but certain things (like UDP) can't be done with QSocket and if you need a platform-independent API for those, QSocketDevice is the right choice. -.PP -The essential purpose of the class is to provide a QIODevice that works on sockets, wrapped in a platform-independent API. -.PP -When calling connect() or bind(), QSocketDevice detects the protocol family (IPv4, IPv6) automatically. Passing the protocol family to QSocketDevice's constructor or to setSocket() forces creation of a socket device of a specific protocol. If not set, the protocol will be detected at the first call to connect() or bind(). -.PP -See also QSocket, QSocketNotifier, QHostAddress, and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QSocketDevice::Error" -This enum type describes the error states of QSocketDevice. -.TP -\fCQSocketDevice::NoError\fR - No error has occurred. -.TP -\fCQSocketDevice::AlreadyBound\fR - The device is already bound, according to bind(). -.TP -\fCQSocketDevice::Inaccessible\fR - The operating system or firewall prohibited the action. -.TP -\fCQSocketDevice::NoResources\fR - The operating system ran out of a resource. -.TP -\fCQSocketDevice::InternalError\fR - An internal error occurred in QSocketDevice. -.TP -\fCQSocketDevice::Impossible\fR - An attempt was made to do something which makes no sense. For example: -.IP -.nf -.br - ::close( sd->socket() ); -.br - sd->writeBlock( someData, 42 ); -.br -.fi -The libc ::close() closes the socket, but QSocketDevice is not aware of this. So when you call writeBlock(), the impossible happens. -.TP -\fCQSocketDevice::NoFiles\fR - The operating system will not let QSocketDevice open another file. -.TP -\fCQSocketDevice::ConnectionRefused\fR - A connection attempt was rejected by the peer. -.TP -\fCQSocketDevice::NetworkFailure\fR - There is a network failure. -.TP -\fCQSocketDevice::UnknownError\fR - The operating system did something unexpected. -.SH "QSocketDevice::Protocol" -This enum type describes the protocol family of the socket. Possible values are: -.TP -\fCQSocketDevice::IPv4\fR - The socket is an IPv4 socket. -.TP -\fCQSocketDevice::IPv6\fR - The socket is an IPv6 socket. -.TP -\fCQSocketDevice::Unknown\fR - The protocol family of the socket is not known. This can happen if you use QSocketDevice with an already existing socket; it tries to determine the protocol family, but this can fail if the protocol family is not known to QSocketDevice. -.PP -See also protocol() and setSocket(). -.SH "QSocketDevice::Type" -This enum type describes the type of the socket: -.TP -\fCQSocketDevice::Stream\fR - a stream socket (TCP, usually) -.TP -\fCQSocketDevice::Datagram\fR - a datagram socket (UDP, usually) -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSocketDevice::QSocketDevice ( Type type = Stream )" -Creates a QSocketDevice object for a stream or datagram socket. -.PP -The \fItype\fR argument must be either QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable UDP socket. -.PP -The socket is created as an IPv4 socket. -.PP -See also blocking() and protocol(). -.SH "QSocketDevice::QSocketDevice ( Type type, Protocol protocol, int dummy )" -Creates a QSocketDevice object for a stream or datagram socket. -.PP -The \fItype\fR argument must be either QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable UDP socket. -.PP -The \fIprotocol\fR indicates whether the socket should be of type IPv4 or IPv6. Passing Unknown is not meaningful in this context and you should avoid using (it creates an IPv4 socket, but your code is not easily readable). -.PP -The argument \fIdummy\fR is necessary for compatibility with some compilers. -.PP -See also blocking() and protocol(). -.SH "QSocketDevice::QSocketDevice ( int socket, Type type )" -Creates a QSocketDevice object for the existing socket \fIsocket\fR. -.PP -The \fItype\fR argument must match the actual socket type; use QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable, connectionless UDP socket. -.SH "QSocketDevice::~QSocketDevice ()\fC [virtual]\fR" -Destroys the socket device and closes the socket if it is open. -.SH "int QSocketDevice::accept ()\fC [virtual]\fR" -Extracts the first connection from the queue of pending connections for this socket and returns a new socket identifier. Returns -1 if the operation failed. -.PP -See also bind() and listen(). -.SH "QHostAddress QSocketDevice::address () const" -Returns the address of this socket device. This may be 0.0.0.0 for a while, but is set to something sensible as soon as a sensible value is available. -.SH "bool QSocketDevice::addressReusable () const" -Returns TRUE if the address of this socket can be used by other sockets at the same time, and FALSE if this socket claims exclusive ownership. -.PP -See also setAddressReusable(). -.SH "bool QSocketDevice::bind ( const QHostAddress & address, TQ_UINT16 port )\fC [virtual]\fR" -Assigns a name to an unnamed socket. The name is the host address \fIaddress\fR and the port number \fIport\fR. If the operation succeeds, bind() returns TRUE; otherwise it returns FALSE without changing what port() and address() return. -.PP -bind() is used by servers for setting up incoming connections. Call bind() before listen(). -.SH "bool QSocketDevice::blocking () const" -Returns TRUE if the socket is valid and in blocking mode; otherwise returns FALSE. -.PP -Note that this function does not set error(). -.PP -\fBWarning:\fR On Windows, this function always returns TRUE since the ioctlsocket() function is broken. -.PP -See also setBlocking() and isValid(). -.SH "TQ_LONG QSocketDevice::bytesAvailable () const" -Returns the number of bytes available for reading, or -1 if an error occurred. -.PP -\fBWarning:\fR On Microsoft Windows, we use the ioctlsocket() function to determine the number of bytes queued on the socket. According to Microsoft (KB Q125486), ioctlsocket() sometimes returns an incorrect number. The only safe way to determine the amount of data on the socket is to read it using readBlock(). QSocket has workarounds to deal with this problem. -.SH "bool QSocketDevice::connect ( const QHostAddress & addr, TQ_UINT16 port )\fC [virtual]\fR" -Connects to the IP address and port specified by \fIaddr\fR and \fIport\fR. Returns TRUE if it establishes a connection; otherwise returns FALSE. If it returns FALSE, error() explains why. -.PP -Note that error() commonly returns NoError for non-blocking sockets; this just means that you can call connect() again in a little while and it'll probably succeed. -.SH "Error QSocketDevice::error () const" -Returns the first error seen. -.SH "bool QSocketDevice::isValid () const" -Returns TRUE if this is a valid socket; otherwise returns FALSE. -.PP -See also socket(). -.SH "bool QSocketDevice::listen ( int backlog )\fC [virtual]\fR" -Specifies how many pending connections a server socket can have. Returns TRUE if the operation was successful; otherwise returns FALSE. A \fIbacklog\fR value of 50 is quite common. -.PP -The listen() call only applies to sockets where type() is Stream, i.e. not to Datagram sockets. listen() must not be called before bind() or after accept(). -.PP -See also bind() and accept(). -.SH "QHostAddress QSocketDevice::peerAddress () const" -Returns the address of the port this socket device is connected to. This may be 0.0.0.0 for a while, but is set to something sensible as soon as a sensible value is available. -.PP -Note that for Datagram sockets, this is the source port of the last packet received. -.SH "TQ_UINT16 QSocketDevice::peerPort () const" -Returns the port number of the port this socket device is connected to. This may be 0 for a while, but is set to something sensible as soon as a sensible value is available. -.PP -Note that for Datagram sockets, this is the source port of the last packet received, and that it is in native byte order. -.SH "TQ_UINT16 QSocketDevice::port () const" -Returns the port number of this socket device. This may be 0 for a while, but is set to something sensible as soon as a sensible value is available. -.PP -Note that Qt always uses native byte order, i.e. 67 is 67 in Qt; there is no need to call htons(). -.SH "Protocol QSocketDevice::protocol () const" -Returns the socket's protocol family, which is one of Unknown, IPv4, or IPv6. -.PP -QSocketDevice either creates a socket with a well known protocol family or it uses an already existing socket. In the first case, this function returns the protocol family it was constructed with. In the second case, it tries to determine the protocol family of the socket; if this fails, it returns Unknown. -.PP -See also Protocol and setSocket(). -.SH "TQ_LONG QSocketDevice::readBlock ( char * data, TQ_ULONG maxlen )\fC [virtual]\fR" -Reads \fImaxlen\fR bytes from the socket into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. Returning 0 is not an error. For Stream sockets, 0 is returned when the remote host closes the connection. For Datagram sockets, 0 is a valid datagram size. -.PP -Reimplemented from QIODevice. -.SH "int QSocketDevice::receiveBufferSize () const" -Returns the size of the operating system receive buffer. -.PP -See also setReceiveBufferSize(). -.SH "int QSocketDevice::sendBufferSize () const" -Returns the size of the operating system send buffer. -.PP -See also setSendBufferSize(). -.SH "void QSocketDevice::setAddressReusable ( bool enable )\fC [virtual]\fR" -Sets the address of this socket to be usable by other sockets too if \fIenable\fR is TRUE, and to be used exclusively by this socket if \fIenable\fR is FALSE. -.PP -When a socket is reusable, other sockets can use the same port number (and IP address), which is generally useful. Of course other sockets cannot use the same (address,port,peer-address,peer-port) 4-tuple as this socket, so there is no risk of confusing the two TCP connections. -.PP -See also addressReusable(). -.SH "void QSocketDevice::setBlocking ( bool enable )\fC [virtual]\fR" -Makes the socket blocking if \fIenable\fR is TRUE or nonblocking if \fIenable\fR is FALSE. -.PP -Sockets are blocking by default, but we recommend using nonblocking socket operations, especially for GUI programs that need to be responsive. -.PP -\fBWarning:\fR On Windows, this function should be used with care since whenever you use a QSocketNotifier on Windows, the socket is immediately made nonblocking. -.PP -See also blocking() and isValid(). -.SH "void QSocketDevice::setError ( Error err )\fC [protected]\fR" -Allows subclasses to set the error state to \fIerr\fR. -.SH "void QSocketDevice::setReceiveBufferSize ( uint size )\fC [virtual]\fR" -Sets the size of the operating system receive buffer to \fIsize\fR. -.PP -The operating system receive buffer size effectively limits two things: how much data can be in transit at any one moment, and how much data can be received in one iteration of the main event loop. -.PP -The default is operating system-dependent. A socket that receives large amounts of data is probably best with a buffer size of 49152. -.SH "void QSocketDevice::setSendBufferSize ( uint size )\fC [virtual]\fR" -Sets the size of the operating system send buffer to \fIsize\fR. -.PP -The operating system send buffer size effectively limits how much data can be in transit at any one moment. -.PP -The default is operating system-dependent. A socket that sends large amounts of data is probably best with a buffer size of 49152. -.SH "void QSocketDevice::setSocket ( int socket, Type type )\fC [virtual]\fR" -Sets the socket device to operate on the existing socket \fIsocket\fR. -.PP -The \fItype\fR argument must match the actual socket type; use QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable, connectionless UDP socket. -.PP -Any existing socket is closed. -.PP -See also isValid() and close(). -.SH "int QSocketDevice::socket () const" -Returns the socket number, or -1 if it is an invalid socket. -.PP -See also isValid() and type(). -.SH "Type QSocketDevice::type () const" -Returns the socket type which is either QSocketDevice::Stream or QSocketDevice::Datagram. -.PP -See also socket(). -.SH "TQ_LONG QSocketDevice::waitForMore ( int msecs, bool * timeout = 0 ) const" -Wait up to \fImsecs\fR milliseconds for more data to be available. If \fImsecs\fR is -1 the call will block indefinitely. -.PP -Returns the number of bytes available for reading, or -1 if an error occurred. -.PP -If \fItimeout\fR is non-null and no error occurred (i.e. it does not return -1): this function sets \fI*timeout\fR to TRUE, if the reason for returning was that the timeout was reached; otherwise it sets \fI*timeout\fR to FALSE. This is useful to find out if the peer closed the connection. -.PP -\fBWarning:\fR This is a blocking call and should be avoided in event driven applications. -.PP -See also bytesAvailable(). -.SH "TQ_LONG QSocketDevice::writeBlock ( const char * data, TQ_ULONG len )\fC [virtual]\fR" -Writes \fIlen\fR bytes to the socket from \fIdata\fR and returns the number of bytes written. Returns -1 if an error occurred. -.PP -This is used for QSocketDevice::Stream sockets. -.PP -Reimplemented from QIODevice. -.SH "TQ_LONG QSocketDevice::writeBlock ( const char * data, TQ_ULONG len, const QHostAddress & host, TQ_UINT16 port )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes \fIlen\fR bytes to the socket from \fIdata\fR and returns the number of bytes written. Returns -1 if an error occurred. -.PP -This is used for QSocketDevice::Datagram sockets. You must -specify the \fIhost\fR and \fIport\fR of the destination of the data. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsocketdevice.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsocketdevice.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsocketnotifier.3qt b/doc/man/man3/qsocketnotifier.3qt deleted file mode 100644 index dc36c6197..000000000 --- a/doc/man/man3/qsocketnotifier.3qt +++ /dev/null @@ -1,157 +0,0 @@ -'\" t -.TH QSocketNotifier 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 -QSocketNotifier \- Support for socket callbacks -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBType\fR { Read, Write, Exception }" -.br -.ti -1c -.BI "\fBQSocketNotifier\fR ( int socket, Type type, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSocketNotifier\fR ()" -.br -.ti -1c -.BI "int \fBsocket\fR () const" -.br -.ti -1c -.BI "Type \fBtype\fR () const" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetEnabled\fR ( bool enable )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBactivated\fR ( int socket )" -.br -.in -1c -.SH DESCRIPTION -The QSocketNotifier class provides support for socket callbacks. -.PP -This class makes it possible to write asynchronous socket-based code in Qt. Using synchronous socket operations blocks the program, which is clearly not acceptable for an event-driven GUI program. -.PP -Once you have opened a non-blocking socket (whether for TCP, UDP, a UNIX-domain socket, or any other protocol family your operating system supports), you can create a socket notifier to monitor the socket. Then you connect the activated() signal to the slot you want to be called when a socket event occurs. -.PP -Note for Windows users: the socket passed to QSocketNotifier will become non-blocking, even if it was created as a blocking socket. -.PP -There are three types of socket notifiers (read, write and exception); you must specify one of these in the constructor. -.PP -The type specifies when the activated() signal is to be emitted:
                                                          -.IP 1 -QSocketNotifier::Read - There is data to be read (socket read event). -.IP 2 -QSocketNotifier::Write - Data can be written (socket write event). -.IP 3 -QSocketNofifier::Exception - An exception has occurred (socket exception event). We recommend against using this. -.PP -For example, if you need to monitor both reads and writes for the same socket you must create two socket notifiers. -.PP -For read notifiers it makes little sense to connect the activated() signal to more than one slot because the data can be read from the socket only once. -.PP -Also observe that if you do not read all the available data when the read notifier fires, it fires again and again. -.PP -For write notifiers, immediately disable the notifier after the activated() signal has been received and you have sent the data to be written on the socket. When you have more data to be written, enable it again to get a new activated() signal. The exception is if the socket data writing operation (send() or equivalent) fails with a "would block" error, which means that some buffer is full and you must wait before sending more data. In that case you do not need to disable and re-enable the write notifier; it will fire again as soon as the system allows more data to be sent. -.PP -The behavior of a write notifier that is left in enabled state after having emitting the first activated() signal (and no "would block" error has occurred) is undefined. Depending on the operating system, it may fire on every pass of the event loop or not at all. -.PP -If you need a time-out for your sockets you can use either timer events or the QTimer class. -.PP -Socket action is detected in the main event loop of Qt. The X11 version of Qt has a single UNIX select() call that incorporates all socket notifiers and the X socket. -.PP -Note that on XFree86 for OS/2, select() works only in the thread in which main() is running; you should therefore use that thread for GUI operations. -.PP -See also QSocket, QServerSocket, QSocketDevice, QFile::handle(), and Input/Output and Networking. -.SS "Member Type Documentation" -.SH "QSocketNotifier::Type" -.TP -\fCQSocketNotifier::Read\fR -.TP -\fCQSocketNotifier::Write\fR -.TP -\fCQSocketNotifier::Exception\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSocketNotifier::QSocketNotifier ( int socket, Type type, QObject * parent = 0, const char * name = 0 )" -Constructs a socket notifier called \fIname\fR, with the parent, \fIparent\fR. It watches \fIsocket\fR for \fItype\fR events, and enables it. -.PP -It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers. -.PP -See also setEnabled() and isEnabled(). -.SH "QSocketNotifier::~QSocketNotifier ()" -Destroys the socket notifier. -.SH "void QSocketNotifier::activated ( int socket )\fC [signal]\fR" -This signal is emitted under certain conditions specified by the notifier type():
                                                            -.TP -QSocketNotifier::Read - There is data to be read (socket read event). -.TP -QSocketNotifier::Write - Data can be written (socket write event). -.TP -QSocketNofifier::Exception - An exception has occurred (socket exception event). -.PP -The \fIsocket\fR argument is the socket identifier. -.PP -See also type() and socket(). -.SH "bool QSocketNotifier::isEnabled () const" -Returns TRUE if the notifier is enabled; otherwise returns FALSE. -.PP -See also setEnabled(). -.SH "void QSocketNotifier::setEnabled ( bool enable )\fC [virtual]\fR" -Enables the notifier if \fIenable\fR is TRUE or disables it if \fIenable\fR is FALSE. -.PP -The notifier is enabled by default. -.PP -If the notifier is enabled, it emits the activated() signal whenever a socket event corresponding to its type occurs. If it is disabled, it ignores socket events (the same effect as not creating the socket notifier). -.PP -Write notifiers should normally be disabled immediately after the activated() signal has been emitted; see discussion of write notifiers in the class description above. -.PP -See also isEnabled() and activated(). -.SH "int QSocketNotifier::socket () const" -Returns the socket identifier specified to the constructor. -.PP -See also type(). -.SH "Type QSocketNotifier::type () const" -Returns the socket event type specified to the constructor: QSocketNotifier::Read, QSocketNotifier::Write, or QSocketNotifier::Exception. -.PP -See also socket(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsocketnotifier.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsocketnotifier.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsound.3qt b/doc/man/man3/qsound.3qt deleted file mode 100644 index 439b2720a..000000000 --- a/doc/man/man3/qsound.3qt +++ /dev/null @@ -1,167 +0,0 @@ -'\" t -.TH QSound 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 -QSound \- Access to the platform audio facilities -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSound\fR ( const QString & filename, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSound\fR ()" -.br -.ti -1c -.BI "int \fBloops\fR () const" -.br -.ti -1c -.BI "int \fBloopsRemaining\fR () const" -.br -.ti -1c -.BI "void \fBsetLoops\fR ( int l )" -.br -.ti -1c -.BI "QString \fBfileName\fR () const" -.br -.ti -1c -.BI "bool \fBisFinished\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBplay\fR ()" -.br -.ti -1c -.BI "void \fBstop\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBisAvailable\fR ()" -.br -.ti -1c -.BI "void \fBplay\fR ( const QString & filename )" -.br -.ti -1c -.BI "bool \fBavailable\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSound class provides access to the platform audio facilities. -.PP -Qt provides the most commonly required audio operation in GUI applications: asynchronously playing a sound file. This is most easily accomplished with a single call: -.PP -.nf -.br - QSound::play("mysounds/bells.wav"); -.br -.fi -.PP -A second API is provided in which a QSound object is created from a sound file and is played later: -.PP -.nf -.br - QSound bells("mysounds/bells.wav"); -.br -.br - bells.play(); -.br -.fi -.PP -Sounds played using the second model may use more memory but play more immediately than sounds played using the first model, depending on the underlying platform audio facilities. -.PP -On Microsoft Windows the underlying multimedia system is used; only WAVE format sound files are supported. -.PP -On X11 the Network Audio System is used if available, otherwise all operations work silently. NAS supports WAVE and AU files. -.PP -On Macintosh, ironically, we use QT (QuickTime) for sound, this means all QuickTime formats are supported by Qt/Mac. -.PP -On Qt/Embedded, a built-in mixing sound server is used, which accesses \fC/dev/dsp\fR directly. Only the WAVE format is supported. -.PP -The availability of sound can be tested with QSound::isAvailable(). -.PP -See also Multimedia Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSound::QSound ( const QString & filename, QObject * parent = 0, const char * name = 0 )" -Constructs a QSound that can quickly play the sound in a file named \fIfilename\fR. -.PP -This may use more memory than the static \fCplay\fR function. -.PP -The \fIparent\fR and \fIname\fR arguments (default 0) are passed on to the QObject constructor. -.SH "QSound::~QSound ()" -Destroys the sound object. If the sound is not finished playing stop() is called on it. -.PP -See also stop() and isFinished(). -.SH "bool QSound::available ()\fC [static]\fR" -Returns TRUE if sound support is available; otherwise returns FALSE. -.SH "QString QSound::fileName () const" -Returns the filename associated with the sound. -.SH "bool QSound::isAvailable ()\fC [static]\fR" -Returns TRUE if sound facilities exist on the platform; otherwise returns FALSE. An application may choose either to notify the user if sound is crucial to the application or to operate silently without bothering the user. -.PP -If no sound is available, all QSound operations work silently and quickly. -.SH "bool QSound::isFinished () const" -Returns TRUE if the sound has finished playing; otherwise returns FALSE. -.PP -\fBWarning:\fR On Windows this function always returns TRUE for unlooped sounds. -.SH "int QSound::loops () const" -Returns the number of times the sound will play. -.SH "int QSound::loopsRemaining () const" -Returns the number of times the sound will loop. This value decreases each time the sound loops. -.SH "void QSound::play ( const QString & filename )\fC [static]\fR" -Plays the sound in a file called \fIfilename\fR. -.PP -Example: sound/sound.cpp. -.SH "void QSound::play ()\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Starts the sound playing. The function returns immediately. Depending on the platform audio facilities, other sounds may stop or may be mixed with the new sound. -.PP -The sound can be played again at any time, possibly mixing or replacing previous plays of the sound. -.SH "void QSound::setLoops ( int l )" -Sets the sound to repeat \fIl\fR times when it is played. Passing the value -1 will cause the sound to loop indefinitely. -.PP -See also loops(). -.SH "void QSound::stop ()\fC [slot]\fR" -Stops the sound playing. -.PP -On Windows the current loop will finish if a sound is played in a loop. -.PP -See also play(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsound.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsound.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qspaceritem.3qt b/doc/man/man3/qspaceritem.3qt deleted file mode 100644 index 171450f68..000000000 --- a/doc/man/man3/qspaceritem.3qt +++ /dev/null @@ -1,108 +0,0 @@ -'\" t -.TH QSpacerItem 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 -QSpacerItem \- Blank space in a layout -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QLayoutItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSpacerItem\fR ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" -.br -.ti -1c -.BI "void \fBchangeSize\fR ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBminimumSize\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBmaximumSize\fR () const" -.br -.ti -1c -.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" -.br -.in -1c -.SH DESCRIPTION -The QSpacerItem class provides blank space in a layout. -.PP -This class is used by custom layouts. -.PP -See also QLayout, QLayout::spacerItem(), Widget Appearance and Style, and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSpacerItem::QSpacerItem ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" -Constructs a spacer item with preferred width \fIw\fR, preferred height \fIh\fR, horizontal size policy \fIhData\fR and vertical size policy \fIvData\fR. -.PP -The default values provide a gap that is able to stretch if nothing else wants the space. -.SH "void QSpacerItem::changeSize ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" -Changes this spacer item to have preferred width \fIw\fR, preferred height \fIh\fR, horizontal size policy \fIhData\fR and vertical size policy \fIvData\fR. -.PP -The default values provide a gap that is able to stretch if nothing else wants the space. -.SH "QSizePolicy::ExpandData QSpacerItem::expanding () const\fC [virtual]\fR" -Returns the direction in which this spacer item will expand. -.PP -See also QSizePolicy::ExpandData. -.PP -Reimplemented from QLayoutItem. -.SH "bool QSpacerItem::isEmpty () const\fC [virtual]\fR" -Returns TRUE because a spacer item never contains widgets. -.PP -Reimplemented from QLayoutItem. -.SH "QSize QSpacerItem::maximumSize () const\fC [virtual]\fR" -Returns the maximum size of this spacer item. -.PP -Reimplemented from QLayoutItem. -.SH "QSize QSpacerItem::minimumSize () const\fC [virtual]\fR" -Returns the minimum size of this spacer item. -.PP -Reimplemented from QLayoutItem. -.SH "void QSpacerItem::setGeometry ( const QRect & r )\fC [virtual]\fR" -Stores the spacer item's rect \fIr\fR so that it can be returned by geometry(). -.PP -Reimplemented from QLayoutItem. -.SH "QSize QSpacerItem::sizeHint () const\fC [virtual]\fR" -Returns the preferred size of this spacer item. -.PP -Reimplemented from QLayoutItem. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qspaceritem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qspaceritem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qspinbox.3qt b/doc/man/man3/qspinbox.3qt deleted file mode 100644 index f4b922239..000000000 --- a/doc/man/man3/qspinbox.3qt +++ /dev/null @@ -1,572 +0,0 @@ -'\" t -.TH QSpinBox 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 -QSpinBox \- Spin box widget (spin button) -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget and QRangeControl. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSpinBox\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQSpinBox\fR ( int minValue, int maxValue, int step = 1, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSpinBox\fR ()" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual QString \fBprefix\fR () const" -.br -.ti -1c -.BI "virtual QString \fBsuffix\fR () const" -.br -.ti -1c -.BI "virtual QString \fBcleanText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSpecialValueText\fR ( const QString & text )" -.br -.ti -1c -.BI "QString \fBspecialValueText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetWrapping\fR ( bool on )" -.br -.ti -1c -.BI "bool \fBwrapping\fR () const" -.br -.ti -1c -.BI "enum \fBButtonSymbols\fR { UpDownArrows, PlusMinus }" -.br -.ti -1c -.BI "virtual void \fBsetButtonSymbols\fR ( ButtonSymbols )" -.br -.ti -1c -.BI "ButtonSymbols \fBbuttonSymbols\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetValidator\fR ( const QValidator * v )" -.br -.ti -1c -.BI "const QValidator * \fBvalidator\fR () const" -.br -.ti -1c -.BI "int \fBminValue\fR () const" -.br -.ti -1c -.BI "int \fBmaxValue\fR () const" -.br -.ti -1c -.BI "void \fBsetMinValue\fR ( int )" -.br -.ti -1c -.BI "void \fBsetMaxValue\fR ( int )" -.br -.ti -1c -.BI "int \fBlineStep\fR () const" -.br -.ti -1c -.BI "void \fBsetLineStep\fR ( int )" -.br -.ti -1c -.BI "int \fBvalue\fR () const" -.br -.ti -1c -.BI "QRect \fBupRect\fR () const" -.br -.ti -1c -.BI "QRect \fBdownRect\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetValue\fR ( int value )" -.br -.ti -1c -.BI "virtual void \fBsetPrefix\fR ( const QString & text )" -.br -.ti -1c -.BI "virtual void \fBsetSuffix\fR ( const QString & text )" -.br -.ti -1c -.BI "virtual void \fBstepUp\fR ()" -.br -.ti -1c -.BI "virtual void \fBstepDown\fR ()" -.br -.ti -1c -.BI "virtual void \fBselectAll\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBvalueChanged\fR ( int value )" -.br -.ti -1c -.BI "void \fBvalueChanged\fR ( const QString & valueText )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "ButtonSymbols \fBbuttonSymbols\fR - the current button symbol mode" -.br -.ti -1c -.BI "QString \fBcleanText\fR - the spin box's text with no prefix(), suffix() or leading or trailing whitespace \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBlineStep\fR - the line step" -.br -.ti -1c -.BI "int \fBmaxValue\fR - the maximum value of the spin box" -.br -.ti -1c -.BI "int \fBminValue\fR - the minimum value of the spin box" -.br -.ti -1c -.BI "QString \fBprefix\fR - the spin box's prefix" -.br -.ti -1c -.BI "QString \fBspecialValueText\fR - the special-value text" -.br -.ti -1c -.BI "QString \fBsuffix\fR - the suffix of the spin box" -.br -.ti -1c -.BI "QString \fBtext\fR - the spin box's " "text" ", including any prefix() and suffix() \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBvalue\fR - the value of the spin box" -.br -.ti -1c -.BI "bool \fBwrapping\fR - whether it is possible to step the value from the highest value to the lowest value and vice versa" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QString \fBmapValueToText\fR ( int v )" -.br -.ti -1c -.BI "virtual int \fBmapTextToValue\fR ( bool * ok )" -.br -.ti -1c -.BI "QString \fBcurrentValueText\fR ()" -.br -.ti -1c -.BI "virtual void \fBupdateDisplay\fR ()" -.br -.ti -1c -.BI "virtual void \fBinterpretText\fR ()" -.br -.ti -1c -.BI "QLineEdit * \fBeditor\fR () const" -.br -.ti -1c -.BI "virtual void \fBvalueChange\fR ()" -.br -.ti -1c -.BI "virtual void \fBrangeChange\fR ()" -.br -.ti -1c -.BI "virtual bool \fBeventFilter\fR ( QObject * o, QEvent * ev )" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "void \fBtextChanged\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSpinBox class provides a spin box widget (spin button). -.PP -QSpinBox allows the user to choose a value either by clicking the up/down buttons to increase/decrease the value currently displayed or by typing the value directly into the spin box. If the value is entered directly into the spin box, Enter (or Return) must be pressed to apply the new value. The value is usually an integer. -.PP -Every time the value changes QSpinBox emits the valueChanged() signal. The current value can be fetched with value() and set with setValue(). -.PP -The spin box keeps the value within a numeric range, and to multiples of the lineStep() size (see QRangeControl for details). Clicking the up/down buttons or using the keyboard accelerator's up and down arrows will increase or decrease the current value in steps of size lineStep(). The minimum and maximum value and the step size can be set using one of the constructors, and can be changed later with setMinValue(), setMaxValue() and setLineStep(). -.PP -Most spin boxes are directional, but QSpinBox can also operate as a circular spin box, i.e. if the range is 0-99 and the current value is 99, clicking "up" will give 0. Use setWrapping() if you want circular behavior. -.PP -The displayed value can be prepended and appended with arbitrary strings indicating, for example, currency or the unit of measurement. See setPrefix() and setSuffix(). The text in the spin box is retrieved with text() (which includes any prefix() and suffix()), or with cleanText() (which has no prefix(), no suffix() and no leading or trailing whitespace). currentValueText() returns the spin box's current value as text. -.PP -Normally the spin box displays up and down arrows in the buttons. You can use setButtonSymbols() to change the display to show \fB+\fR and \fB-\fR symbols if you prefer. In either case the up and down arrow keys work as expected. -.PP -It is often desirable to give the user a special (often default) choice in addition to the range of numeric values. See setSpecialValueText() for how to do this with QSpinBox. -.PP -The default QWidget::focusPolicy() is StrongFocus. -.PP -If using prefix(), suffix() and specialValueText() don't provide enough control, you can ignore them and subclass QSpinBox instead. -.PP -QSpinBox can easily be subclassed to allow the user to input things other than an integer value as long as the allowed input can be mapped to a range of integers. This can be done by overriding the virtual functions mapValueToText() and mapTextToValue(), and setting another suitable validator using setValidator(). -.PP -For example, these functions could be changed so that the user provided values from 0.0 to 10.0, or -1 to signify 'Auto', while the range of integers used inside the program would be -1 to 100: -.PP -.nf -.br - class MySpinBox : public QSpinBox -.br - { -.br - TQ_OBJECT -.br - public: -.br - ... -.br -.br - QString mapValueToText( int value ) -.br - { -.br - if ( value == -1 ) // special case -.br - return QString( "Auto" ); -.br -.br - return QString( "%1.%2" ) // 0.0 to 10.0 -.br - .arg( value / 10 ).arg( value % 10 ); -.br - } -.br -.br - int mapTextToValue( bool *ok ) -.br - { -.br - if ( text() == "Auto" ) // special case -.br - return -1; -.br -.br - return (int) ( 10 * text().toFloat() ); // 0 to 100 -.br - } -.br - }; -.br -.fi -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QScrollBar, QSlider, GUI Design Handbook: Spin Box, and Basic Widgets. -.SS "Member Type Documentation" -.SH "QSpinBox::ButtonSymbols" -This enum type determines what the buttons in a spin box show. -.TP -\fCQSpinBox::UpDownArrows\fR - the buttons show little arrows in the classic style. -.TP -\fCQSpinBox::PlusMinus\fR - the buttons show \fB+\fR and \fB-\fR symbols. -.PP -See also QSpinBox::buttonSymbols. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSpinBox::QSpinBox ( QWidget * parent = 0, const char * name = 0 )" -Constructs a spin box with the default QRangeControl range and step values. It is called \fIname\fR and has parent \fIparent\fR. -.PP -See also minValue, maxValue, setRange(), lineStep, and setSteps(). -.SH "QSpinBox::QSpinBox ( int minValue, int maxValue, int step = 1, QWidget * parent = 0, const char * name = 0 )" -Constructs a spin box that allows values from \fIminValue\fR to \fImaxValue\fR inclusive, with step amount \fIstep\fR. The value is initially set to \fIminValue\fR. -.PP -The spin box is called \fIname\fR and has parent \fIparent\fR. -.PP -See also minValue, maxValue, setRange(), lineStep, and setSteps(). -.SH "QSpinBox::~QSpinBox ()" -Destroys the spin box, freeing all memory and other resources. -.SH "ButtonSymbols QSpinBox::buttonSymbols () const" -Returns the current button symbol mode. See the "buttonSymbols" property for details. -.SH "QString QSpinBox::cleanText () const\fC [virtual]\fR" -Returns the spin box's text with no prefix(), suffix() or leading or trailing whitespace. See the "cleanText" property for details. -.SH "QString QSpinBox::currentValueText ()\fC [protected]\fR" -Returns the full text calculated from the current value, including any prefix and suffix. If there is special value text and the value is minValue() the specialValueText() is returned. -.SH "QRect QSpinBox::downRect () const" -Returns the geometry of the "down" button. -.SH "QLineEdit * QSpinBox::editor () const\fC [protected]\fR" -Returns a pointer to the embedded QLineEdit. -.SH "bool QSpinBox::eventFilter ( QObject * o, QEvent * ev )\fC [virtual protected]\fR" -Intercepts and handles the events coming to the embedded QLineEdit that have special meaning for the QSpinBox. The object is passed as \fIo\fR and the event is passed as \fIev\fR. -.PP -Reimplemented from QObject. -.SH "void QSpinBox::interpretText ()\fC [virtual protected]\fR" -QSpinBox calls this after the user has manually edited the contents of the spin box (i.e. by typing in the embedded QLineEdit, rather than using the up/down buttons/keys). -.PP -The default implementation of this function interprets the new text using mapTextToValue(). If mapTextToValue() is successful, it changes the spin box's value; if not, the value is left unchanged. -.PP -See also editor(). -.SH "int QSpinBox::lineStep () const" -Returns the line step. See the "lineStep" property for details. -.SH "int QSpinBox::mapTextToValue ( bool * ok )\fC [virtual protected]\fR" -This virtual function is used by the spin box whenever it needs to interpret text entered by the user as a value. The text is available as text() and as cleanText(), and this function must parse it if possible. If \fIok\fR is not 0: if it parses the text successfully, \fI*ok\fR is set to TRUE; otherwise \fI*ok\fR is set to FALSE. -.PP -Subclasses that need to display spin box values in a non-numeric way need to reimplement this function. -.PP -Note that Qt handles specialValueText() separately; this function is only concerned with the other values. -.PP -The default implementation tries to interpret the text() as an integer in the standard way and returns the integer value. -.PP -See also interpretText() and mapValueToText(). -.SH "QString QSpinBox::mapValueToText ( int v )\fC [virtual protected]\fR" -This virtual function is used by the spin box whenever it needs to display value \fIv\fR. The default implementation returns a string containing \fIv\fR printed in the standard way. Reimplementations may return anything. (See the example in the detailed description.) -.PP -Note that Qt does not call this function for specialValueText() and that neither prefix() nor suffix() are included in the return value. -.PP -If you reimplement this, you may also need to reimplement mapTextToValue(). -.PP -See also updateDisplay() and mapTextToValue(). -.SH "int QSpinBox::maxValue () const" -Returns the maximum value of the spin box. See the "maxValue" property for details. -.SH "int QSpinBox::minValue () const" -Returns the minimum value of the spin box. See the "minValue" property for details. -.SH "QString QSpinBox::prefix () const\fC [virtual]\fR" -Returns the spin box's prefix. See the "prefix" property for details. -.SH "void QSpinBox::rangeChange ()\fC [virtual protected]\fR" -This virtual function is called by QRangeControl whenever the range has changed. It adjusts the default validator and updates the display; if you need additional processing, you can reimplement this function. -.PP -Reimplemented from QRangeControl. -.SH "void QSpinBox::selectAll ()\fC [virtual slot]\fR" -Selects all the text in the spin box's editor. -.SH "void QSpinBox::setButtonSymbols ( ButtonSymbols )\fC [virtual]\fR" -Sets the current button symbol mode. See the "buttonSymbols" property for details. -.SH "void QSpinBox::setLineStep ( int )" -Sets the line step. See the "lineStep" property for details. -.SH "void QSpinBox::setMaxValue ( int )" -Sets the maximum value of the spin box. See the "maxValue" property for details. -.SH "void QSpinBox::setMinValue ( int )" -Sets the minimum value of the spin box. See the "minValue" property for details. -.SH "void QSpinBox::setPrefix ( const QString & text )\fC [virtual slot]\fR" -Sets the spin box's prefix to \fItext\fR. See the "prefix" property for details. -.SH "void QSpinBox::setSpecialValueText ( const QString & text )\fC [virtual]\fR" -Sets the special-value text to \fItext\fR. See the "specialValueText" property for details. -.SH "void QSpinBox::setSuffix ( const QString & text )\fC [virtual slot]\fR" -Sets the suffix of the spin box to \fItext\fR. See the "suffix" property for details. -.SH "void QSpinBox::setValidator ( const QValidator * v )\fC [virtual]\fR" -Sets the validator to \fIv\fR. The validator controls what keyboard input is accepted when the user is editing in the value field. The default is to use a suitable QIntValidator. -.PP -Use setValidator(0) to turn off input validation (entered input will still be kept within the spin box's range). -.SH "void QSpinBox::setValue ( int value )\fC [virtual slot]\fR" -Sets the value of the spin box to \fIvalue\fR. See the "value" property for details. -.SH "void QSpinBox::setWrapping ( bool on )\fC [virtual]\fR" -Sets whether it is possible to step the value from the highest value to the lowest value and vice versa to \fIon\fR. See the "wrapping" property for details. -.SH "QString QSpinBox::specialValueText () const" -Returns the special-value text. See the "specialValueText" property for details. -.SH "void QSpinBox::stepDown ()\fC [virtual slot]\fR" -Decreases the spin box's value one lineStep(), wrapping as necessary if wrapping() is TRUE. This is the same as clicking on the pointing-down button and can be used for keyboard accelerators, for example. -.PP -See also stepUp(), subtractLine(), lineStep, setSteps(), value, and value. -.SH "void QSpinBox::stepUp ()\fC [virtual slot]\fR" -Increases the spin box's value by one lineStep(), wrapping as necessary if wrapping() is TRUE. This is the same as clicking on the pointing-up button and can be used for keyboard accelerators, for example. -.PP -See also stepDown(), addLine(), lineStep, setSteps(), value, and value. -.SH "QString QSpinBox::suffix () const\fC [virtual]\fR" -Returns the suffix of the spin box. See the "suffix" property for details. -.SH "QString QSpinBox::text () const" -Returns the spin box's text, including any prefix() and suffix(). See the "text" property for details. -.SH "void QSpinBox::textChanged ()\fC [protected slot]\fR" -This slot is called whenever the user edits the spin box's text. -.SH "QRect QSpinBox::upRect () const" -Returns the geometry of the "up" button. -.SH "void QSpinBox::updateDisplay ()\fC [virtual protected]\fR" -Updates the contents of the embedded QLineEdit to reflect the current value using mapValueToText(). Also enables/disables the up/down push buttons accordingly. -.PP -See also mapValueToText(). -.SH "const QValidator * QSpinBox::validator () const" -Returns the validator that constrains editing for this spin box if there is any; otherwise returns 0. -.PP -See also setValidator() and QValidator. -.SH "int QSpinBox::value () const" -Returns the value of the spin box. See the "value" property for details. -.SH "void QSpinBox::valueChange ()\fC [virtual protected]\fR" -This virtual function is called by QRangeControl whenever the value has changed. The QSpinBox reimplementation updates the display and emits the valueChanged() signals; if you need additional processing, either reimplement this or connect to one of the valueChanged() signals. -.PP -Reimplemented from QRangeControl. -.SH "void QSpinBox::valueChanged ( int value )\fC [signal]\fR" -This signal is emitted every time the value of the spin box changes; the new value is passed in \fIvalue\fR. This signal will be emitted as a result of a call to setValue(), or because the user changed the value by using a keyboard accelerator or mouse click, etc. -.PP -Note that the valueChanged() signal is emitted \fIevery\fR time, not just for the "last" step; i.e. if the user clicks "up" three times, this signal is emitted three times. -.PP -See also value. -.PP -Examples: -.)l listbox/listbox.cpp, qfd/fontdisplayer.cpp, and scribble/scribble.cpp. -.SH "void QSpinBox::valueChanged ( const QString & valueText )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted whenever the valueChanged( int ) signal is emitted, i.e. every time the value of the spin box changes (whatever the cause, e.g. by setValue(), by a keyboard accelerator, by mouse clicks, etc.). -.PP -The \fIvalueText\fR parameter is the same string that is displayed in the edit field of the spin box. -.PP -See also value, prefix, suffix, and specialValueText. -.SH "bool QSpinBox::wrapping () const" -Returns TRUE if it is possible to step the value from the highest value to the lowest value and vice versa; otherwise returns FALSE. See the "wrapping" property for details. -.SS "Property Documentation" -.SH "ButtonSymbols buttonSymbols" -This property holds the current button symbol mode. -.PP -The possible values can be either UpDownArrows or PlusMinus. The default is UpDownArrows. -.PP -See also ButtonSymbols. -.PP -Set this property's value with setButtonSymbols() and get this property's value with buttonSymbols(). -.SH "QString cleanText" -This property holds the spin box's text with no prefix(), suffix() or leading or trailing whitespace. -.PP -Get this property's value with cleanText(). -.PP -See also text, prefix, and suffix. -.SH "int lineStep" -This property holds the line step. -.PP -When the user uses the arrows to change the spin box's value the value will be incremented/decremented by the amount of the line step. -.PP -The setLineStep() function calls the virtual stepChange() function if the new line step is different from the previous setting. -.PP -See also QRangeControl::setSteps() and setRange(). -.PP -Set this property's value with setLineStep() and get this property's value with lineStep(). -.SH "int maxValue" -This property holds the maximum value of the spin box. -.PP -When setting this property, QSpinBox::minValue is adjusted, if necessary, to ensure that the range remains valid. -.PP -See also setRange() and specialValueText. -.PP -Set this property's value with setMaxValue() and get this property's value with maxValue(). -.SH "int minValue" -This property holds the minimum value of the spin box. -.PP -When setting this property, QSpinBox::maxValue is adjusted, if necessary, to ensure that the range remains valid. -.PP -See also setRange() and specialValueText. -.PP -Set this property's value with setMinValue() and get this property's value with minValue(). -.SH "QString prefix" -This property holds the spin box's prefix. -.PP -The prefix is prepended to the start of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example: -.PP -.nf -.br - sb->setPrefix( "$" ); -.br -.fi -.PP -To turn off the prefix display, set this property to an empty string. The default is no prefix. The prefix is not displayed for the minValue() if specialValueText() is not empty. -.PP -If no prefix is set, prefix() returns QString::null. -.PP -See also suffix. -.PP -Set this property's value with setPrefix() and get this property's value with prefix(). -.SH "QString specialValueText" -This property holds the special-value text. -.PP -If set, the spin box will display this text instead of a numeric value whenever the current value is equal to minVal(). Typical use is to indicate that this choice has a special (default) meaning. -.PP -For example, if your spin box allows the user to choose the margin width in a print dialog and your application is able to automatically choose a good margin width, you can set up the spin box like this: -.PP -.nf -.br - QSpinBox marginBox( -1, 20, 1, parent, "marginBox" ); -.br - marginBox->setSuffix( " mm" ); -.br - marginBox->setSpecialValueText( "Auto" ); -.br -.fi -The user will then be able to choose a margin width from 0-20 millimeters or select "Auto" to leave it to the application to choose. Your code must then interpret the spin box value of -1 as the user requesting automatic margin width. -.PP -All values are displayed with the prefix() and suffix() (if set), \fIexcept\fR for the special value, which only shows the special value text. -.PP -To turn off the special-value text display, call this function with an empty string. The default is no special-value text, i.e. the numeric value is shown as usual. -.PP -If no special-value text is set, specialValueText() returns QString::null. -.PP -Set this property's value with setSpecialValueText() and get this property's value with specialValueText(). -.SH "QString suffix" -This property holds the suffix of the spin box. -.PP -The suffix is appended to the end of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example: -.PP -.nf -.br - sb->setSuffix( " km" ); -.br -.fi -.PP -To turn off the suffix display, set this property to an empty string. The default is no suffix. The suffix is not displayed for the minValue() if specialValueText() is not empty. -.PP -If no suffix is set, suffix() returns a QString::null. -.PP -See also prefix. -.PP -Set this property's value with setSuffix() and get this property's value with suffix(). -.SH "QString text" -This property holds the spin box's text, including any prefix() and suffix(). -.PP -There is no default text. -.PP -See also value. -.PP -Get this property's value with text(). -.SH "int value" -This property holds the value of the spin box. -.PP -Set this property's value with setValue() and get this property's value with value(). -.PP -See also QRangeControl::setValue(). -.SH "bool wrapping" -This property holds whether it is possible to step the value from the highest value to the lowest value and vice versa. -.PP -By default, wrapping is turned off. -.PP -If you have a range of 0..100 and wrapping is off when the user reaches 100 and presses the Up Arrow nothing will happen; but if wrapping is on the value will change from 100 to 0, then to 1, etc. When wrapping is on, navigating past the highest value takes you to the lowest and vice versa. -.PP -See also minValue, maxValue, and setRange(). -.PP -Set this property's value with setWrapping() and get this property's value with wrapping(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqspinbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qspinbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsplashscreen.3qt b/doc/man/man3/qsplashscreen.3qt deleted file mode 100644 index ef0e76029..000000000 --- a/doc/man/man3/qsplashscreen.3qt +++ /dev/null @@ -1,182 +0,0 @@ -'\" t -.TH QSplashScreen 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 -QSplashScreen \- Splash screen that can be shown during application startup -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSplashScreen\fR ( const QPixmap & pixmap = QPixmap ( ), WFlags f = 0 )" -.br -.ti -1c -.BI "virtual \fB~QSplashScreen\fR ()" -.br -.ti -1c -.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap )" -.br -.ti -1c -.BI "QPixmap * \fBpixmap\fR () const" -.br -.ti -1c -.BI "void \fBfinish\fR ( QWidget * mainWin )" -.br -.ti -1c -.BI "void \fBrepaint\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBmessage\fR ( const QString & message, int alignment = AlignLeft, const QColor & color = black )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBmessageChanged\fR ( const QString & message )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * painter )" -.br -.in -1c -.SH DESCRIPTION -The QSplashScreen widget provides a splash screen that can be shown during application startup. -.PP -A splash screen is a widget that is usually displayed when an application is being started. Splash screens are often used for applications that have long start up times (e.g. database or networking applications that take time to establish connections) to provide the user with feedback that the application is loading. -.PP -The splash screen appears centered on the screen. It may be useful to add the WStyle_StaysOnTop if you desire to keep above all the windows in the GUI. -.PP -Some X11 window managers do not support the "stays on top" flag. A solution is to set up a timer that periodically calls raise() on the splash screen to simulate the "stays on top" effect. -.PP -The most common usage is to show a splash screen before the main widget is displayed on the screen. This is illustrated in the following code snippet. -.PP -.nf -.br - int main( int argc, char **argv ) -.br - { -.br - QApplication app( argc, argv ); -.br - QPixmap pixmap( "splash.png" ); -.br - QSplashScreen *splash = new QSplashScreen( pixmap ); -.br - splash->show(); -.br - QMainWindow *mainWin = new QMainWindow; -.br - ... -.br - app.setMainWidget( mainWin ); -.br - mainWin->show(); -.br - splash->finish( mainWin ); -.br - delete splash; -.br - return app.exec(); -.br - } -.br -.fi -.PP -It is sometimes useful to update the splash screen with messages, for example, announcing connections established or modules loaded as the application starts up. QSplashScreen supports this with the message() function. If you wish to do your own drawing you can get a pointer to the pixmap used in the splash screen with pixmap(). Alternatively, you can subclass QSplashScreen and reimplement drawContents(). -.PP -The user can hide the splash screen by clicking on it with the mouse. Since the splash screen is typically displayed before the event loop has started running, it is necessary to periodically call QApplication::processEvents() to receive the mouse clicks. -.PP -.nf -.br - QPixmap pixmap( "splash.png" ); -.br - QSplashScreen *splash = new QSplashScreen( pixmap ); -.br - splash->show(); -.br - ... // Loading some items -.br - splash->message( "Loaded modules" ); -.br - tqApp->processEvents(); -.br - ... // Establishing connections -.br - splash->message( "Established connections" ); -.br - tqApp->processEvents(); -.br -.fi -.PP -See also Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSplashScreen::QSplashScreen ( const QPixmap & pixmap = QPixmap ( ), WFlags f = 0 )" -Construct a splash screen that will display the \fIpixmap\fR. -.PP -There should be no need to set the widget flags, \fIf\fR, except perhaps WDestructiveClose or WStyle_StaysOnTop. -.SH "QSplashScreen::~QSplashScreen ()\fC [virtual]\fR" -Destructor. -.SH "void QSplashScreen::clear ()\fC [slot]\fR" -Removes the message being displayed on the splash screen -.PP -See also message(). -.SH "void QSplashScreen::drawContents ( QPainter * painter )\fC [virtual protected]\fR" -Draw the contents of the splash screen using painter \fIpainter\fR. The default implementation draws the message passed by message(). Reimplement this function if you want to do your own drawing on the splash screen. -.SH "void QSplashScreen::finish ( QWidget * mainWin )" -Makes the splash screen wait until the widget \fImainWin\fR is displayed before calling close() on itself. -.SH "void QSplashScreen::message ( const QString & message, int alignment = AlignLeft, const QColor & color = black )\fC [slot]\fR" -Draws the \fImessage\fR text onto the splash screen with color \fIcolor\fR and aligns the text according to the flags in \fIalignment\fR. -.PP -See also Qt::AlignmentFlags and clear(). -.SH "void QSplashScreen::messageChanged ( const QString & message )\fC [signal]\fR" -This signal is emitted when the message on the splash screen changes. \fImessage\fR is the new message and is a null-string when the message has been removed. -.PP -See also message() and clear(). -.SH "QPixmap * QSplashScreen::pixmap () const" -Returns the pixmap that is used in the splash screen. The image does not have any of the text drawn by message() calls. -.SH "void QSplashScreen::repaint ()" -This overrides QWidget::repaint(). It differs from the standard repaint function in that it also calls QApplication::flush() to ensure the updates are displayed, even when there is no event loop present. -.SH "void QSplashScreen::setPixmap ( const QPixmap & pixmap )" -Sets the pixmap that will be used as the splash screen's image to -\fIpixmap\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsplashscreen.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsplashscreen.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsplitter.3qt b/doc/man/man3/qsplitter.3qt deleted file mode 100644 index c237b198e..000000000 --- a/doc/man/man3/qsplitter.3qt +++ /dev/null @@ -1,332 +0,0 @@ -'\" t -.TH QSplitter 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 -QSplitter \- Implements a splitter widget -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBResizeMode\fR { Stretch, KeepSize, FollowSizeHint, Auto }" -.br -.ti -1c -.BI "\fBQSplitter\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQSplitter\fR ( Orientation o, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSplitter\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetOrientation\fR ( Orientation )" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "void \fBsetChildrenCollapsible\fR ( bool )" -.br -.ti -1c -.BI "bool \fBchildrenCollapsible\fR () const" -.br -.ti -1c -.BI "void \fBsetCollapsible\fR ( QWidget * w, bool collapse )" -.br -.ti -1c -.BI "virtual void \fBsetResizeMode\fR ( QWidget * w, ResizeMode mode )" -.br -.ti -1c -.BI "virtual void \fBsetOpaqueResize\fR ( bool = TRUE )" -.br -.ti -1c -.BI "bool \fBopaqueResize\fR () const" -.br -.ti -1c -.BI "void \fBmoveToFirst\fR ( QWidget * w )" -.br -.ti -1c -.BI "void \fBmoveToLast\fR ( QWidget * w )" -.br -.ti -1c -.BI "void \fBrefresh\fR ()" -.br -.ti -1c -.BI "QValueList \fBsizes\fR () const" -.br -.ti -1c -.BI "void \fBsetSizes\fR ( QValueList list )" -.br -.ti -1c -.BI "int \fBhandleWidth\fR () const" -.br -.ti -1c -.BI "void \fBsetHandleWidth\fR ( int )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBchildrenCollapsible\fR - whether child widgets can be resized down to size 0 by the user" -.br -.ti -1c -.BI "int \fBhandleWidth\fR - the width of the splitter handle" -.br -.ti -1c -.BI "bool \fBopaqueResize\fR - whether resizing is opaque" -.br -.ti -1c -.BI "Orientation \fBorientation\fR - the orientation of the splitter" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBchildEvent\fR ( QChildEvent * c )" -.br -.ti -1c -.BI "int \fBidAfter\fR ( QWidget * w ) const" -.br -.ti -1c -.BI "void \fBmoveSplitter\fR ( QCOORD p, int id )" -.br -.ti -1c -.BI "virtual void drawSplitter ( QPainter * p, QCOORD x, QCOORD y, QCOORD w, QCOORD h ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBadjustPos\fR ( int pos, int id )" -.br -.ti -1c -.BI "virtual void \fBsetRubberband\fR ( int p )" -.br -.ti -1c -.BI "void \fBgetRange\fR ( int id, int * min, int * max )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( QTextStream & ts, const QSplitter & splitter )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( QTextStream & ts, QSplitter & splitter )" -.br -.in -1c -.SH DESCRIPTION -The QSplitter class implements a splitter widget. -.PP -A splitter lets the user control the size of child widgets by dragging the boundary between the children. Any number of widgets may be controlled by a single splitter. -.PP -To show a QListBox, a QListView and a QTextEdit side by side: -.PP -.nf -.br - QSplitter *split = new QSplitter( parent ); -.br - QListBox *lb = new QListBox( split ); -.br - QListView *lv = new QListView( split ); -.br - QTextEdit *ed = new QTextEdit( split ); -.br -.fi -.PP -QSplitter lays out its children horizontally (side by side); you can use setOrientation(QSplitter::Vertical) to lay out the children vertically. -.PP -By default, all widgets can be as large or as small as the user wishes, between the minimumSizeHint() (or minimumSize()) and maximumSize() of the widgets. Use setResizeMode() to specify that a widget should keep its size when the splitter is resized, or set the stretch component of the sizePolicy. -.PP -Although QSplitter normally resizes the children only at the end of a resize operation, if you call setOpaqueResize(TRUE) the widgets are resized as often as possible. -.PP -The initial distribution of size between the widgets is determined by the initial size of each widget. You can also use setSizes() to set the sizes of all the widgets. The function sizes() returns the sizes set by the user. -.PP -If you hide() a child its space will be distributed among the other children. It will be reinstated when you show() it again. It is also possible to reorder the widgets within the splitter using moveToFirst() and moveToLast(). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QTabBar and Organizers. -.SS "Member Type Documentation" -.SH "QSplitter::ResizeMode" -This enum type describes how QSplitter will resize each of its child widgets. -.TP -\fCQSplitter::Auto\fR - The widget will be resized according to the stretch factors set in its sizePolicy(). -.TP -\fCQSplitter::Stretch\fR - The widget will be resized when the splitter itself is resized. -.TP -\fCQSplitter::KeepSize\fR - QSplitter will try to keep the widget's size unchanged. -.TP -\fCQSplitter::FollowSizeHint\fR - QSplitter will resize the widget when the widget's size hint changes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSplitter::QSplitter ( QWidget * parent = 0, const char * name = 0 )" -Constructs a horizontal splitter with the \fIparent\fR and \fIname\fR arguments being passed on to the QFrame constructor. -.SH "QSplitter::QSplitter ( Orientation o, QWidget * parent = 0, const char * name = 0 )" -Constructs a splitter with orientation \fIo\fR with the \fIparent\fR and \fIname\fR arguments being passed on to the QFrame constructor. -.SH "QSplitter::~QSplitter ()" -Destroys the splitter and any children. -.SH "int QSplitter::adjustPos ( int pos, int id )\fC [protected]\fR" -Returns the closest legal position to \fIpos\fR of the widget with ID \fIid\fR. -.PP -See also idAfter(). -.SH "void QSplitter::childEvent ( QChildEvent * c )\fC [virtual protected]\fR" -Tells the splitter that the child widget described by \fIc\fR has been inserted or removed. -.PP -Reimplemented from QObject. -.SH "bool QSplitter::childrenCollapsible () const" -Returns TRUE if child widgets can be resized down to size 0 by the user; otherwise returns FALSE. See the "childrenCollapsible" property for details. -.SH "void QSplitter::drawSplitter ( QPainter * p, QCOORD x, QCOORD y, QCOORD w, QCOORD h )\fC [virtual protected]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Draws the splitter handle in the rectangle described by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR using painter \fIp\fR. -.PP -See also QStyle::drawPrimitive(). -.SH "void QSplitter::getRange ( int id, int * min, int * max )\fC [protected]\fR" -Returns the valid range of the splitter with ID \fIid\fR in \fI*min\fR and \fI*max\fR if \fImin\fR and \fImax\fR are not 0. -.PP -See also idAfter(). -.SH "int QSplitter::handleWidth () const" -Returns the width of the splitter handle. See the "handleWidth" property for details. -.SH "int QSplitter::idAfter ( QWidget * w ) const\fC [protected]\fR" -Returns the ID of the widget to the right of or below the widget \fIw\fR, or 0 if there is no such widget (i.e. it is either not in this QSplitter or \fIw\fR is at the end). -.SH "void QSplitter::moveSplitter ( QCOORD p, int id )\fC [protected]\fR" -Moves the left/top edge of the splitter handle with ID \fIid\fR as close as possible to position \fIp\fR, which is the distance from the left (or top) edge of the widget. -.PP -For Arabic, Hebrew and other right-to-left languages the layout is reversed. \fIp\fR is then the distance from the right (or top) edge of the widget. -.PP -See also idAfter(). -.SH "void QSplitter::moveToFirst ( QWidget * w )" -Moves widget \fIw\fR to the leftmost/top position. -.PP -Example: splitter/splitter.cpp. -.SH "void QSplitter::moveToLast ( QWidget * w )" -Moves widget \fIw\fR to the rightmost/bottom position. -.SH "bool QSplitter::opaqueResize () const" -Returns TRUE if resizing is opaque; otherwise returns FALSE. See the "opaqueResize" property for details. -.SH "Orientation QSplitter::orientation () const" -Returns the orientation of the splitter. See the "orientation" property for details. -.SH "void QSplitter::refresh ()" -Updates the splitter's state. You should not need to call this function. -.SH "void QSplitter::setChildrenCollapsible ( bool )" -Sets whether child widgets can be resized down to size 0 by the user. See the "childrenCollapsible" property for details. -.SH "void QSplitter::setCollapsible ( QWidget * w, bool collapse )" -Sets whether the child widget \fIw\fR is collapsible to \fIcollapse\fR. -.PP -By default, children are collapsible, meaning that the user can resize them down to size 0, even if they have a non-zero minimumSize() or minimumSizeHint(). This behavior can be changed on a per-widget basis by calling this function, or globally for all the widgets in the splitter by setting the childrenCollapsible property. -.PP -See also childrenCollapsible. -.SH "void QSplitter::setHandleWidth ( int )" -Sets the width of the splitter handle. See the "handleWidth" property for details. -.SH "void QSplitter::setOpaqueResize ( bool = TRUE )\fC [virtual]\fR" -Sets whether resizing is opaque. See the "opaqueResize" property for details. -.SH "void QSplitter::setOrientation ( Orientation )\fC [virtual]\fR" -Sets the orientation of the splitter. See the "orientation" property for details. -.SH "void QSplitter::setResizeMode ( QWidget * w, ResizeMode mode )\fC [virtual]\fR" -Sets resize mode of widget \fIw\fR to \fImode\fR. (The default is Auto.) -.PP -Examples: -.)l fileiconview/mainwindow.cpp, listviews/listviews.cpp, and splitter/splitter.cpp. -.SH "void QSplitter::setRubberband ( int p )\fC [virtual protected]\fR" -Displays a rubber band at position \fIp\fR. If \fIp\fR is negative, the rubber band is removed. -.SH "void QSplitter::setSizes ( QValueList list )" -Sets the size parameters to the values given in the \fIlist\fR. If the splitter is horizontal, the values set the widths of each widget going from left to right. If the splitter is vertical, the values set the heights of each widget going from top to bottom. Extra values in the \fIlist\fR are ignored. -.PP -If \fIlist\fR contains too few values, the result is undefined but the program will still be well-behaved. -.PP -Note that the values in \fIlist\fR should be the height/width that the widgets should be resized to. -.PP -See also sizes(). -.SH "QValueList QSplitter::sizes () const" -Returns a list of the size parameters of all the widgets in this splitter. -.PP -If the splitter's orientation is horizontal, the list is a list of widget widths; if the orientation is vertical, the list is a list of widget heights. -.PP -Giving the values to another splitter's setSizes() function will produce a splitter with the same layout as this one. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList list = mySplitter.sizes(); -.br - QValueList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also setSizes(). -.SS "Property Documentation" -.SH "bool childrenCollapsible" -This property holds whether child widgets can be resized down to size 0 by the user. -.PP -By default, children are collapsible. It is possible to enable and disable the collapsing of individual children; see setCollapsible(). -.PP -Set this property's value with setChildrenCollapsible() and get this property's value with childrenCollapsible(). -.SH "int handleWidth" -This property holds the width of the splitter handle. -.PP -Set this property's value with setHandleWidth() and get this property's value with handleWidth(). -.SH "bool opaqueResize" -This property holds whether resizing is opaque. -.PP -Opaque resizing is off by default. -.PP -Set this property's value with setOpaqueResize() and get this property's value with opaqueResize(). -.SH "Orientation orientation" -This property holds the orientation of the splitter. -.PP -By default the orientation is horizontal (the widgets are side by side). The possible orientations are Horizontal and Vertical. -.PP -Set this property's value with setOrientation() and get this property's value with orientation(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QTextStream & operator<< ( QTextStream & ts, const QSplitter & splitter )" -Writes the sizes and the hidden state of the widgets in the splitter \fIsplitter\fR to the text stream \fIts\fR. -.PP -See also operator>>(), sizes(), and QWidget::hidden. -.SH "QTextStream & operator>> ( QTextStream & ts, QSplitter & splitter )" -Reads the sizes and the hidden state of the widgets in the splitter \fIsplitter\fR from the text stream \fIts\fR. The sizes must have been previously written by the operator<<() function. -.PP -See also operator<<(), setSizes(), and QWidget::hide(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsplitter.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsplitter.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsql.3qt b/doc/man/man3/qsql.3qt deleted file mode 100644 index 723e9ca46..000000000 --- a/doc/man/man3/qsql.3qt +++ /dev/null @@ -1,111 +0,0 @@ -'\" t -.TH QSql 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 -QSql \- Namespace for Qt SQL identifiers that need to be global-like -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSql\fR ()" -.br -.ti -1c -.BI "enum \fBOp\fR { None = -1, Insert = 0, Update = 1, Delete = 2 }" -.br -.ti -1c -.BI "enum \fBLocation\fR { BeforeFirst = -1, AfterLast = -2 }" -.br -.ti -1c -.BI "enum \fBConfirm\fR { Cancel = -1, No = 0, Yes = 1 }" -.br -.ti -1c -.BI "enum \fBParameterType\fR { In = 1, Out = 2, InOut = 3 }" -.br -.ti -1c -.BI "enum \fBTableType\fR { Tables = 0x01, SystemTables = 0x02, Views = 0x04, AllTables = 0xff }" -.br -.in -1c -.SH DESCRIPTION -The QSql class is a namespace for Qt SQL identifiers that need to be global-like. -.PP -Normally, you can ignore this class. Several Qt SQL classes inherit it, so all the identifiers in the Qt SQL namespace are visible without qualification. -.PP -See also Database Classes. -.SS "Member Type Documentation" -.SH "QSql::Confirm" -This enum type describes edit confirmations. -.TP -\fCQSql::Yes\fR -.TP -\fCQSql::No\fR -.TP -\fCQSql::Cancel\fR -.SH "QSql::Location" -This enum type describes SQL navigation locations. -.TP -\fCQSql::BeforeFirst\fR -.TP -\fCQSql::AfterLast\fR -.SH "QSql::Op" -This enum type describes edit operations. -.TP -\fCQSql::None\fR -.TP -\fCQSql::Insert\fR -.TP -\fCQSql::Update\fR -.TP -\fCQSql::Delete\fR -.SH "QSql::ParameterType" -This enum is used to set the type of a bind parameter -.TP -\fCQSql::In\fR - the bind parameter is used to put data into the database -.TP -\fCQSql::Out\fR - the bind parameter is used to receive data from the database -.TP -\fCQSql::InOut\fR - the bind parameter is used to put data into the database; it will be overwritten with output data on executing a query. -.SH "QSql::TableType" -This enum type describes types of tables -.TP -\fCQSql::Tables\fR - All the tables visible to the user -.TP -\fCQSql::SystemTables\fR - Internal tables used by the DBMS -.TP -\fCQSql::Views\fR - All the views visible to the user -.TP -\fCQSql::AllTables\fR - All of the above -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSql::QSql ()" -Constructs a Qt SQL namespace class - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsql.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsql.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlcursor.3qt b/doc/man/man3/qsqlcursor.3qt deleted file mode 100644 index a9aabf5a5..000000000 --- a/doc/man/man3/qsqlcursor.3qt +++ /dev/null @@ -1,661 +0,0 @@ -'\" t -.TH QSqlCursor 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 -QSqlCursor \- Browsing and editing of SQL tables and views -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QSqlRecord and QSqlQuery. -.PP -Inherited by QSqlSelectCursor. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlCursor\fR ( const QString & name = QString::null, bool autopopulate = TRUE, QSqlDatabase * db = 0 )" -.br -.ti -1c -.BI "\fBQSqlCursor\fR ( const QSqlCursor & other )" -.br -.ti -1c -.BI "QSqlCursor & \fBoperator=\fR ( const QSqlCursor & other )" -.br -.ti -1c -.BI "\fB~QSqlCursor\fR ()" -.br -.ti -1c -.BI "enum \fBMode\fR { ReadOnly = 0, Insert = 1, Update = 2, Delete = 4, Writable = 7 }" -.br -.ti -1c -.BI "virtual QSqlIndex \fBprimaryIndex\fR ( bool setFromCursor = TRUE ) const" -.br -.ti -1c -.BI "virtual QSqlIndex \fBindex\fR ( const QStringList & fieldNames ) const" -.br -.ti -1c -.BI "QSqlIndex \fBindex\fR ( const QString & fieldName ) const" -.br -.ti -1c -.BI "QSqlIndex \fBindex\fR ( const char * fieldName ) const" -.br -.ti -1c -.BI "virtual void \fBsetPrimaryIndex\fR ( const QSqlIndex & idx )" -.br -.ti -1c -.BI "virtual void \fBappend\fR ( const QSqlFieldInfo & fieldInfo )" -.br -.ti -1c -.BI "virtual void \fBinsert\fR ( int pos, const QSqlFieldInfo & fieldInfo )" -.br -.ti -1c -.BI "virtual void \fBremove\fR ( int pos )" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetGenerated\fR ( const QString & name, bool generated )" -.br -.ti -1c -.BI "virtual void \fBsetGenerated\fR ( int i, bool generated )" -.br -.ti -1c -.BI "virtual QSqlRecord * \fBeditBuffer\fR ( bool copy = FALSE )" -.br -.ti -1c -.BI "virtual QSqlRecord * \fBprimeInsert\fR ()" -.br -.ti -1c -.BI "virtual QSqlRecord * \fBprimeUpdate\fR ()" -.br -.ti -1c -.BI "virtual QSqlRecord * \fBprimeDelete\fR ()" -.br -.ti -1c -.BI "virtual int \fBinsert\fR ( bool invalidate = TRUE )" -.br -.ti -1c -.BI "virtual int \fBupdate\fR ( bool invalidate = TRUE )" -.br -.ti -1c -.BI "virtual int \fBdel\fR ( bool invalidate = TRUE )" -.br -.ti -1c -.BI "virtual void \fBsetMode\fR ( int mode )" -.br -.ti -1c -.BI "int \fBmode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCalculated\fR ( const QString & name, bool calculated )" -.br -.ti -1c -.BI "bool \fBisCalculated\fR ( const QString & name ) const" -.br -.ti -1c -.BI "virtual void \fBsetTrimmed\fR ( const QString & name, bool trim )" -.br -.ti -1c -.BI "bool \fBisTrimmed\fR ( const QString & name ) const" -.br -.ti -1c -.BI "bool \fBisReadOnly\fR () const" -.br -.ti -1c -.BI "bool \fBcanInsert\fR () const" -.br -.ti -1c -.BI "bool \fBcanUpdate\fR () const" -.br -.ti -1c -.BI "bool \fBcanDelete\fR () const" -.br -.ti -1c -.BI "bool \fBselect\fR ()" -.br -.ti -1c -.BI "bool \fBselect\fR ( const QSqlIndex & sort )" -.br -.ti -1c -.BI "bool \fBselect\fR ( const QSqlIndex & filter, const QSqlIndex & sort )" -.br -.ti -1c -.BI "virtual bool \fBselect\fR ( const QString & filter, const QSqlIndex & sort = QSqlIndex ( ) )" -.br -.ti -1c -.BI "virtual void \fBsetSort\fR ( const QSqlIndex & sort )" -.br -.ti -1c -.BI "QSqlIndex \fBsort\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFilter\fR ( const QString & filter )" -.br -.ti -1c -.BI "QString \fBfilter\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetName\fR ( const QString & name, bool autopopulate = TRUE )" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR ( int i ) const" -.br -.ti -1c -.BI "bool \fBisNull\fR ( const QString & name ) const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QVariant \fBcalculateField\fR ( const QString & name )" -.br -.ti -1c -.BI "virtual int \fBupdate\fR ( const QString & filter, bool invalidate = TRUE )" -.br -.ti -1c -.BI "virtual int \fBdel\fR ( const QString & filter, bool invalidate = TRUE )" -.br -.ti -1c -.BI "virtual QString \fBtoString\fR ( const QString & prefix, QSqlField * field, const QString & fieldSep ) const" -.br -.ti -1c -.BI "virtual QString \fBtoString\fR ( QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const" -.br -.ti -1c -.BI "virtual QString \fBtoString\fR ( const QSqlIndex & i, QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const" -.br -.in -1c -.SH DESCRIPTION -The QSqlCursor class provides browsing and editing of SQL tables and views. -.PP -A QSqlCursor is a database record (see QSqlRecord) that corresponds to a table or view within an SQL database (see QSqlDatabase). There are two buffers in a cursor, one used for browsing and one used for editing records. Each buffer contains a list of fields which correspond to the fields in the table or view. -.PP -When positioned on a valid record, the browse buffer contains the values of the current record's fields from the database. The edit buffer is separate, and is used for editing existing records and inserting new records. -.PP -For browsing data, a cursor must first select() data from the database. After a successful select() the cursor is active (isActive() returns TRUE), but is initially not positioned on a valid record (isValid() returns FALSE). To position the cursor on a valid record, use one of the navigation functions, next(), prev(), first(), last(), or seek(). Once positioned on a valid record, data can be retrieved from the browse buffer using value(). If a navigation function is not successful, it returns FALSE, the cursor will no longer be positioned on a valid record and the values returned by value() are undefined. -.PP -For example: -.PP -.nf -.br - QSqlCursor cur( "staff" ); // Specify the table/view name -.br - cur.select(); // We'll retrieve every record -.br - while ( cur.next() ) { -.br - tqDebug( cur.value( "id" ).toString() + ": " + -.br - cur.value( "surname" ).toString() + " " + -.br - cur.value( "salary" ).toString() ); -.br - } -.fi -.PP -In the above example, a cursor is created specifying a table or view name in the database. Then, select() is called, which can be optionally parameterised to filter and order the records retrieved. Each record in the cursor is retrieved using next(). When next() returns FALSE, there are no more records to process, and the loop terminates. -.PP -For editing records (rows of data), a cursor contains a separate edit buffer which is independent of the fields used when browsing. The functions insert(), update() and del() operate on the edit buffer. This allows the cursor to be repositioned to other records while simultaneously maintaining a separate buffer for edits. You can get a pointer to the edit buffer using editBuffer(). The primeInsert(), primeUpdate() and primeDelete() functions also return a pointer to the edit buffer and prepare it for insert, update and delete respectively. Edit operations only affect a single row at a time. Note that update() and del() require that the table or view contain a primaryIndex() to ensure that edit operations affect a unique record within the database. -.PP -For example: -.PP -.nf -.br - QSqlCursor cur( "prices" ); -.br - cur.select( "id=202" ); -.br - if ( cur.next() ) { -.br - QSqlRecord *buffer = cur.primeUpdate(); -.br - double price = buffer->value( "price" ).toDouble(); -.br - double newprice = price * 1.05; -.br - buffer->setValue( "price", newprice ); -.br - cur.update(); -.br - } -.fi -.PP -To edit an existing database record, first move to the record you wish to update. Call primeUpdate() to get the pointer to the cursor's edit buffer. Then use this pointer to modify the values in the edit buffer. Finally, call update() to save the changes to the database. The values in the edit buffer will be used to locate the appropriate record when updating the database (see primaryIndex()). -.PP -Similarly, when deleting an existing database record, first move to the record you wish to delete. Then, call primeDelete() to get the pointer to the edit buffer. Finally, call del() to delete the record from the database. Again, the values in the edit buffer will be used to locate and delete the appropriate record. -.PP -To insert a new record, call primeInsert() to get the pointer to the edit buffer. Use this pointer to populate the edit buffer with new values and then insert() the record into the database. -.PP -After calling insert(), update() or del(), the cursor is no longer positioned on a valid record and can no longer be navigated (isValid() return FALSE). The reason for this is that any changes made to the database will not be visible until select() is called to refresh the cursor. You can change this behavior by passing FALSE to insert(), update() or del() which will prevent the cursor from becoming invalid. The edits will still not be visible when navigating the cursor until select() is called. -.PP -QSqlCursor contains virtual methods which allow editing behavior to be customized by subclasses. This allows custom cursors to be created that encapsulate the editing behavior of a database table for an entire application. For example, a cursor can be customized to always auto-number primary index fields, or provide fields with suitable default values, when inserting new records. QSqlCursor generates SQL statements which are sent to the database engine; you can control which fields are included in these statements using setGenerated(). -.PP -Note that QSqlCursor does not inherit from QObject. This means that you are responsible for destroying instances of this class yourself. However if you create a QSqlCursor and use it in a QDataTable, QDataBrowser or a QDataView these classes will usually take ownership of the cursor and destroy it when they don't need it anymore. The documentation for QDataTable, QDataBrowser and QDataView explicitly states which calls take ownership of the cursor. -.PP -See also Database Classes. -.SS "Member Type Documentation" -.SH "QSqlCursor::Mode" -This enum type describes how QSqlCursor operates on records in the database. -.TP -\fCQSqlCursor::ReadOnly\fR - the cursor can only SELECT records from the database. -.TP -\fCQSqlCursor::Insert\fR - the cursor can INSERT records into the database. -.TP -\fCQSqlCursor::Update\fR - the cursor can UPDATE records in the database. -.TP -\fCQSqlCursor::Delete\fR - the cursor can DELETE records from the database. -.TP -\fCQSqlCursor::Writable\fR - the cursor can INSERT, UPDATE and DELETE records in the database. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlCursor::QSqlCursor ( const QString & name = QString::null, bool autopopulate = TRUE, QSqlDatabase * db = 0 )" -Constructs a cursor on database \fIdb\fR using table or view \fIname\fR. -.PP -If \fIautopopulate\fR is TRUE (the default), the \fIname\fR of the cursor must correspond to an existing table or view name in the database so that field information can be automatically created. If the table or view does not exist, the cursor will not be functional. -.PP -The cursor is created with an initial mode of QSqlCursor::Writable (meaning that records can be inserted, updated or deleted using the cursor). If the cursor does not have a unique primary index, update and deletes cannot be performed. -.PP -Note that \fIautopopulate\fR refers to populating the cursor with meta-data, e.g. the names of the table's fields, not with retrieving data. The select() function is used to populate the cursor with data. -.PP -See also setName() and setMode(). -.SH "QSqlCursor::QSqlCursor ( const QSqlCursor & other )" -Constructs a copy of \fIother\fR. -.SH "QSqlCursor::~QSqlCursor ()" -Destroys the object and frees any allocated resources. -.SH "void QSqlCursor::append ( const QSqlFieldInfo & fieldInfo )\fC [virtual]\fR" -Append a copy of field \fIfieldInfo\fR to the end of the cursor. Note that all references to the cursor edit buffer become invalidated. -.SH "QVariant QSqlCursor::calculateField ( const QString & name )\fC [virtual protected]\fR" -Protected virtual function which is called whenever a field needs to be calculated. If calculated fields are being used, derived classes must reimplement this function and return the appropriate value for field \fIname\fR. The default implementation returns an invalid QVariant. -.PP -See also setCalculated(). -.PP -Examples: -.)l sql/overview/subclass3/main.cpp and sql/overview/subclass4/main.cpp. -.SH "bool QSqlCursor::canDelete () const" -Returns TRUE if the cursor will perform deletes; otherwise returns FALSE. -.PP -See also setMode(). -.SH "bool QSqlCursor::canInsert () const" -Returns TRUE if the cursor will perform inserts; otherwise returns FALSE. -.PP -See also setMode(). -.SH "bool QSqlCursor::canUpdate () const" -Returns TRUE if the cursor will perform updates; otherwise returns FALSE. -.PP -See also setMode(). -.SH "void QSqlCursor::clear ()\fC [virtual]\fR" -Removes all fields from the cursor. Note that all references to the cursor edit buffer become invalidated. -.PP -Reimplemented from QSqlRecord. -.SH "int QSqlCursor::del ( bool invalidate = TRUE )\fC [virtual]\fR" -Deletes a record from the database using the cursor's primary index and the contents of the cursor edit buffer. Returns the number of records which were deleted. For error information, use lastError(). -.PP -Only records which meet the filter criteria specified by the cursor's primary index are deleted. If the cursor does not contain a primary index, no delete is performed and 0 is returned. If \fIinvalidate\fR is TRUE (the default), the current cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. For example: -.PP -.nf -.br - QSqlCursor cur( "prices" ); -.br - cur.select( "id=999" ); -.br - if ( cur.next() ) { -.br - cur.primeDelete(); -.br - cur.del(); -.br - } -.fi -.PP -In the above example, a cursor is created on the 'prices' table and positioned to the record to be deleted. First primeDelete() is called to populate the edit buffer with the current cursor values, e.g. with an id of 999, and then del() is called to actually delete the record from the database. Remember: all edit operations (insert(), update() and delete()) operate on the contents of the cursor edit buffer and not on the contents of the cursor itself. -.PP -See also primeDelete(), setMode(), and lastError(). -.PP -Example: sql/overview/delete/main.cpp. -.SH "int QSqlCursor::del ( const QString & filter, bool invalidate = TRUE )\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Deletes the current cursor record from the database using the filter \fIfilter\fR. Only records which meet the filter criteria are deleted. Returns the number of records which were deleted. If \fIinvalidate\fR is TRUE (the default), the current cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. For error information, use lastError(). -.PP -The \fIfilter\fR is an SQL \fCWHERE\fR clause, e.g. \fCid=500\fR. -.PP -See also setMode() and lastError(). -.SH "QSqlRecord * QSqlCursor::editBuffer ( bool copy = FALSE )\fC [virtual]\fR" -Returns the current internal edit buffer. If \fIcopy\fR is TRUE (the default is FALSE), the current cursor field values are first copied into the edit buffer. The edit buffer is valid as long as the cursor remains valid. The cursor retains ownership of the returned pointer, so it must not be deleted or modified. -.PP -See also primeInsert(), primeUpdate(), and primeDelete(). -.SH "QString QSqlCursor::filter () const" -Returns the current filter, or an empty string if there is no current filter. -.SH "QSqlIndex QSqlCursor::index ( const QStringList & fieldNames ) const\fC [virtual]\fR" -Returns an index composed of \fIfieldNames\fR, all in ASCending order. Note that all field names must exist in the cursor, otherwise an empty index is returned. -.PP -See also QSqlIndex. -.PP -Examples: -.)l sql/overview/extract/main.cpp, sql/overview/order1/main.cpp, sql/overview/order2/main.cpp, and sql/overview/table3/main.cpp. -.SH "QSqlIndex QSqlCursor::index ( const QString & fieldName ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an index based on \fIfieldName\fR. -.SH "QSqlIndex QSqlCursor::index ( const char * fieldName ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an index based on \fIfieldName\fR. -.SH "void QSqlCursor::insert ( int pos, const QSqlFieldInfo & fieldInfo )\fC [virtual]\fR" -Insert a copy of \fIfieldInfo\fR at position \fIpos\fR. If a field already exists at \fIpos\fR, it is removed. Note that all references to the cursor edit buffer become invalidated. -.PP -Examples: -.)l sql/overview/insert/main.cpp and sql/overview/insert2/main.cpp. -.SH "int QSqlCursor::insert ( bool invalidate = TRUE )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the current contents of the cursor's edit record buffer into the database, if the cursor allows inserts. Returns the number of rows affected by the insert. For error information, use lastError(). -.PP -If \fIinvalidate\fR is TRUE (the default), the cursor will no longer be positioned on a valid record and can no longer be navigated. A new select() call must be made before navigating to a valid record. -.PP -.nf -.br - QSqlCursor cur( "prices" ); -.br - QSqlRecord *buffer = cur.primeInsert(); -.br - buffer->setValue( "id", 53981 ); -.br - buffer->setValue( "name", "Thingy" ); -.br - buffer->setValue( "price", 105.75 ); -.br - cur.insert(); -.fi -.PP -In the above example, a cursor is created on the 'prices' table and a pointer to the insert buffer is acquired using primeInsert(). Each field's value is set to the desired value and then insert() is called to insert the data into the database. Remember: all edit operations (insert(), update() and delete()) operate on the contents of the cursor edit buffer and not on the contents of the cursor itself. -.PP -See also setMode() and lastError(). -.SH "bool QSqlCursor::isCalculated ( const QString & name ) const" -Returns TRUE if the field \fIname\fR exists and is calculated; otherwise returns FALSE. -.PP -See also setCalculated(). -.SH "bool QSqlCursor::isNull ( int i ) const" -Returns TRUE if the field \fIi\fR is NULL or if there is no field at position \fIi\fR; otherwise returns FALSE. -.PP -This is the same as calling QSqlRecord::isNull( \fIi\fR ) -.SH "bool QSqlCursor::isNull ( const QString & name ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the field called \fIname\fR is NULL or if there is no field called \fIname\fR; otherwise returns FALSE. -.PP -This is the same as calling QSqlRecord::isNull( \fIname\fR ) -.SH "bool QSqlCursor::isReadOnly () const" -Returns TRUE if the cursor is read-only; otherwise returns FALSE. The default is FALSE. Read-only cursors cannot be edited using insert(), update() or del(). -.PP -See also setMode(). -.SH "bool QSqlCursor::isTrimmed ( const QString & name ) const" -Returns TRUE if the field \fIname\fR exists and is trimmed; otherwise returns FALSE. -.PP -When a trimmed field of type string or cstring is read from the database any trailing (right-most) spaces are removed. -.PP -See also setTrimmed(). -.SH "int QSqlCursor::mode () const" -Returns the current cursor mode. -.PP -See also setMode(). -.SH "QString QSqlCursor::name () const" -Returns the name of the cursor. -.SH "QSqlCursor & QSqlCursor::operator= ( const QSqlCursor & other )" -Sets the cursor equal to \fIother\fR. -.SH "QSqlIndex QSqlCursor::primaryIndex ( bool setFromCursor = TRUE ) const\fC [virtual]\fR" -Returns the primary index associated with the cursor as defined in the database, or an empty index if there is no primary index. If \fIsetFromCursor\fR is TRUE (the default), the index fields are populated with the corresponding values in the cursor's current record. -.SH "QSqlRecord * QSqlCursor::primeDelete ()\fC [virtual]\fR" -This function primes the edit buffer's field values for delete and returns the edit buffer. The default implementation copies the field values from the current cursor record into the edit buffer (therefore, this function is equivalent to calling editBuffer( TRUE ) ). The cursor retains ownership of the returned pointer, so it must not be deleted or modified. -.PP -See also editBuffer() and del(). -.PP -Example: sql/overview/delete/main.cpp. -.SH "QSqlRecord * QSqlCursor::primeInsert ()\fC [virtual]\fR" -This function primes the edit buffer's field values for insert and returns the edit buffer. The default implementation clears all field values in the edit buffer. The cursor retains ownership of the returned pointer, so it must not be deleted or modified. -.PP -See also editBuffer() and insert(). -.PP -Examples: -.)l sql/overview/insert/main.cpp, sql/overview/insert2/main.cpp, sql/overview/subclass5/main.cpp, and sql/sqltable/main.cpp. -.SH "QSqlRecord * QSqlCursor::primeUpdate ()\fC [virtual]\fR" -This function primes the edit buffer's field values for update and returns the edit buffer. The default implementation copies the field values from the current cursor record into the edit buffer (therefore, this function is equivalent to calling editBuffer( TRUE ) ). The cursor retains ownership of the returned pointer, so it must not be deleted or modified. -.PP -See also editBuffer() and update(). -.PP -Examples: -.)l sql/overview/custom1/main.cpp, sql/overview/form1/main.cpp, and sql/overview/update/main.cpp. -.SH "void QSqlCursor::remove ( int pos )\fC [virtual]\fR" -Removes the field at \fIpos\fR. If \fIpos\fR does not exist, nothing happens. Note that all references to the cursor edit buffer become invalidated. -.PP -Reimplemented from QSqlRecord. -.SH "bool QSqlCursor::select ( const QString & filter, const QSqlIndex & sort = QSqlIndex ( ) )\fC [virtual]\fR" -Selects all fields in the cursor from the database matching the filter criteria \fIfilter\fR. The data is returned in the order specified by the index \fIsort\fR. Returns TRUE if the data was successfully selected; otherwise returns FALSE. -.PP -The \fIfilter\fR is a string containing a SQL \fCWHERE\fR clause but without the 'WHERE' keyword. The cursor is initially positioned at an invalid row after this function is called. To move to a valid row, use seek(), first(), last(), prev() or next(). -.PP -Example: -.PP -.nf -.br - QSqlCursor cur( "Employee" ); // Use the Employee table or view -.br - cur.select( "deptno=10" ); // select all records in department 10 -.br - while( cur.next() ) { -.br - ... // process data -.br - } -.br - ... -.br - // select records in other departments, ordered by department number -.br - cur.select( "deptno>10", cur.index( "deptno" ) ); -.br - ... -.br -.fi -.PP -The filter will apply to any subsequent select() calls that do not explicitly specify another filter. Similarly the sort will apply to any subsequent select() calls that do not explicitly specify another sort. -.PP -.nf -.br - QSqlCursor cur( "Employee" ); -.br - cur.select( "deptno=10" ); // select all records in department 10 -.br - while( cur.next() ) { -.br - ... // process data -.br - } -.br - ... -.br - cur.select(); // re-selects all records in department 10 -.br - ... -.br -.fi -.PP -Examples: -.)l sql/overview/delete/main.cpp, sql/overview/extract/main.cpp, sql/overview/order1/main.cpp, sql/overview/order2/main.cpp, sql/overview/retrieve2/main.cpp, sql/overview/table3/main.cpp, and sql/overview/update/main.cpp. -.SH "bool QSqlCursor::select ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Selects all fields in the cursor from the database. The rows are returned in the order specified by the last call to setSort() or the last call to select() that specified a sort, whichever is the most recent. If there is no current sort, the order in which the rows are returned is undefined. The records are filtered according to the filter specified by the last call to setFilter() or the last call to select() that specified a filter, whichever is the most recent. If there is no current filter, all records are returned. The cursor is initially positioned at an invalid row. To move to a valid row, use seek(), first(), last(), prev() or next(). -.PP -See also setSort() and setFilter(). -.SH "bool QSqlCursor::select ( const QSqlIndex & sort )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Selects all fields in the cursor from the database. The data is returned in the order specified by the index \fIsort\fR. The records are filtered according to the filter specified by the last call to setFilter() or the last call to select() that specified a filter, whichever is the most recent. The cursor is initially positioned at an invalid row. To move to a valid row, use seek(), first(), last(), prev() or next(). -.SH "bool QSqlCursor::select ( const QSqlIndex & filter, const QSqlIndex & sort )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Selects all fields in the cursor matching the filter index \fIfilter\fR. The data is returned in the order specified by the index \fIsort\fR. The \fIfilter\fR index works by constructing a WHERE clause using the names of the fields from the \fIfilter\fR and their values from the current cursor record. The cursor is initially positioned at an invalid row. To move to a valid row, use seek(), first(), last(), prev() or next(). This function is useful, for example, for retrieving data based upon a table's primary index: -.PP -.nf -.br - QSqlCursor cur( "Employee" ); -.br - QSqlIndex pk = cur.primaryIndex(); -.br - cur.setValue( "id", 10 ); -.br - cur.select( pk, pk ); // generates "SELECT ... FROM Employee WHERE id=10 ORDER BY id" -.br - ... -.br -.fi -.PP -In this example the QSqlIndex, pk, is used for two different purposes. When used as the filter (first) argument, the field names it contains are used to construct the WHERE clause, each set to the current cursor value, \fCWHERE id=10\fR, in this case. When used as the sort (second) argument the field names it contains are used for the ORDER BY clause, \fCORDER BY id\fR in this example. -.SH "void QSqlCursor::setCalculated ( const QString & name, bool calculated )\fC [virtual]\fR" -Sets field \fIname\fR to \fIcalculated\fR. If the field \fIname\fR does not exist, nothing happens. The value of a calculated field is set by the calculateField() virtual function which you must reimplement (or the field value will be an invalid QVariant). Calculated fields do not appear in generated SQL statements sent to the database. -.PP -See also calculateField() and QSqlRecord::setGenerated(). -.SH "void QSqlCursor::setFilter ( const QString & filter )\fC [virtual]\fR" -Sets the current filter to \fIfilter\fR. Note that no new records are selected. To select new records, use select(). The \fIfilter\fR will apply to any subsequent select() calls that do not explicitly specify a filter. -.PP -The filter is a SQL \fCWHERE\fR clause without the keyword 'WHERE', e.g. \fCname='Dave'\fR which will be processed by the DBMS. -.SH "void QSqlCursor::setGenerated ( const QString & name, bool generated )\fC [virtual]\fR" -Sets the generated flag for the field \fIname\fR to \fIgenerated\fR. If the field does not exist, nothing happens. Only fields that have \fIgenerated\fR set to TRUE are included in the SQL that is generated by insert(), update() or del(). -.PP -See also isGenerated(). -.PP -Reimplemented from QSqlRecord. -.SH "void QSqlCursor::setGenerated ( int i, bool generated )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the generated flag for the field \fIi\fR to \fIgenerated\fR. -.PP -See also isGenerated(). -.PP -Reimplemented from QSqlRecord. -.SH "void QSqlCursor::setMode ( int mode )\fC [virtual]\fR" -Sets the cursor mode to \fImode\fR. This value can be an OR'ed combination of QSqlCursor::Mode values. The default mode for a cursor is QSqlCursor::Writable. -.PP -.nf -.br - QSqlCursor cur( "Employee" ); -.br - cur.setMode( QSqlCursor::Writable ); // allow insert/update/delete -.br - ... -.br - cur.setMode( QSqlCursor::Insert | QSqlCursor::Update ); // allow inserts and updates only -.br - ... -.br - cur.setMode( QSqlCursor::ReadOnly ); // no inserts/updates/deletes allowed -.br -.br -.fi -.SH "void QSqlCursor::setName ( const QString & name, bool autopopulate = TRUE )\fC [virtual]\fR" -Sets the name of the cursor to \fIname\fR. If \fIautopopulate\fR is TRUE (the default), the \fIname\fR must correspond to a valid table or view name in the database. Also, note that all references to the cursor edit buffer become invalidated when fields are auto-populated. See the QSqlCursor constructor documentation for more information. -.SH "void QSqlCursor::setPrimaryIndex ( const QSqlIndex & idx )\fC [virtual]\fR" -Sets the primary index associated with the cursor to the index \fIidx\fR. Note that this index must contain a field or set of fields which identify a unique record within the underlying database table or view so that update() and del() will execute as expected. -.PP -See also update() and del(). -.SH "void QSqlCursor::setSort ( const QSqlIndex & sort )\fC [virtual]\fR" -Sets the current sort to \fIsort\fR. Note that no new records are selected. To select new records, use select(). The \fIsort\fR will apply to any subsequent select() calls that do not explicitly specify a sort. -.SH "void QSqlCursor::setTrimmed ( const QString & name, bool trim )\fC [virtual]\fR" -Sets field \fIname\fR's trimmed status to \fItrim\fR. If the field \fIname\fR does not exist, nothing happens. -.PP -When a trimmed field of type string or cstring is read from the database any trailing (right-most) spaces are removed. -.PP -See also isTrimmed() and QVariant. -.SH "QSqlIndex QSqlCursor::sort () const" -Returns the current sort, or an empty index if there is no current sort. -.SH "QString QSqlCursor::toString ( QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const\fC [virtual protected]\fR" -Returns a formatted string composed of all the fields in \fIrec\fR. Each field is composed of the \fIprefix\fR (e.g. table or view name)," -.", the field name, the \fIfieldSep\fR and the field value. If the -\fIprefix\fR is empty then each field will begin with the field name. The fields are then joined together separated by \fIsep\fR. Fields where isGenerated() returns FALSE are not included. This function is useful for generating SQL statements. -.SH "QString QSqlCursor::toString ( const QString & prefix, QSqlField * field, const QString & fieldSep ) const\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a formatted string composed of the \fIprefix\fR (e.g. table or view name), ".", the \fIfield\fR name, the \fIfieldSep\fR and the field value. If the \fIprefix\fR is empty then the string will begin with the \fIfield\fR name. This function is useful for generating SQL statements. -.SH "QString QSqlCursor::toString ( const QSqlIndex & i, QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a formatted string composed of all the fields in the index \fIi\fR. Each field is composed of the \fIprefix\fR (e.g. table or view name), ".", the field name, the \fIfieldSep\fR and the field value. If the \fIprefix\fR is empty then each field will begin with the field name. The field values are taken from \fIrec\fR. The fields are then joined together separated by \fIsep\fR. Fields where isGenerated() returns FALSE are ignored. This function is useful for generating SQL statements. -.SH "int QSqlCursor::update ( bool invalidate = TRUE )\fC [virtual]\fR" -Updates the database with the current contents of the edit buffer. Returns the number of records which were updated. For error information, use lastError(). -.PP -Only records which meet the filter criteria specified by the cursor's primary index are updated. If the cursor does not contain a primary index, no update is performed and 0 is returned. -.PP -If \fIinvalidate\fR is TRUE (the default), the current cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. For example: -.PP -.nf -.br - QSqlCursor cur( "prices" ); -.br - cur.select( "id=202" ); -.br - if ( cur.next() ) { -.br - QSqlRecord *buffer = cur.primeUpdate(); -.br - double price = buffer->value( "price" ).toDouble(); -.br - double newprice = price * 1.05; -.br - buffer->setValue( "price", newprice ); -.br - cur.update(); -.br - } -.fi -.PP -In the above example, a cursor is created on the 'prices' table and is positioned on the record to be updated. Then a pointer to the cursor's edit buffer is acquired using primeUpdate(). A new value is calculated and placed into the edit buffer with the setValue() call. Finally, an update() call is made on the cursor which uses the tables's primary index to update the record in the database with the contents of the cursor's edit buffer. Remember: all edit operations (insert(), update() and delete()) operate on the contents of the cursor edit buffer and not on the contents of the cursor itself. -.PP -Note that if the primary index does not uniquely distinguish records the database may be changed into an inconsistent state. -.PP -See also setMode() and lastError(). -.PP -Example: sql/overview/update/main.cpp. -.SH "int QSqlCursor::update ( const QString & filter, bool invalidate = TRUE )\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Updates the database with the current contents of the cursor edit buffer using the specified \fIfilter\fR. Returns the number of records which were updated. For error information, use lastError(). -.PP -Only records which meet the filter criteria are updated, otherwise all records in the table are updated. -.PP -If \fIinvalidate\fR is TRUE (the default), the cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. -.PP -See also primeUpdate(), setMode(), and lastError(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlcursor.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlcursor.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqldatabase.3qt b/doc/man/man3/qsqldatabase.3qt deleted file mode 100644 index 7ee987260..000000000 --- a/doc/man/man3/qsqldatabase.3qt +++ /dev/null @@ -1,666 +0,0 @@ -'\" t -.TH QSqlDatabase 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 -QSqlDatabase \- Used to create SQL database connections and to provide transaction handling -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fB~QSqlDatabase\fR ()" -.br -.ti -1c -.BI "bool \fBopen\fR ()" -.br -.ti -1c -.BI "bool \fBopen\fR ( const QString & user, const QString & password )" -.br -.ti -1c -.BI "void \fBclose\fR ()" -.br -.ti -1c -.BI "bool \fBisOpen\fR () const" -.br -.ti -1c -.BI "bool \fBisOpenError\fR () const" -.br -.ti -1c -.BI "QStringList \fBtables\fR () const" -.br -.ti -1c -.BI "QStringList \fBtables\fR ( QSql::TableType type ) const" -.br -.ti -1c -.BI "QSqlIndex \fBprimaryIndex\fR ( const QString & tablename ) const" -.br -.ti -1c -.BI "QSqlRecord \fBrecord\fR ( const QString & tablename ) const" -.br -.ti -1c -.BI "QSqlRecord \fBrecord\fR ( const QSqlQuery & query ) const" -.br -.ti -1c -.BI "QSqlRecordInfo \fBrecordInfo\fR ( const QString & tablename ) const" -.br -.ti -1c -.BI "QSqlRecordInfo \fBrecordInfo\fR ( const QSqlQuery & query ) const" -.br -.ti -1c -.BI "QSqlQuery \fBexec\fR ( const QString & query = QString::null ) const" -.br -.ti -1c -.BI "QSqlError \fBlastError\fR () const" -.br -.ti -1c -.BI "bool \fBtransaction\fR ()" -.br -.ti -1c -.BI "bool \fBcommit\fR ()" -.br -.ti -1c -.BI "bool \fBrollback\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetDatabaseName\fR ( const QString & name )" -.br -.ti -1c -.BI "virtual void \fBsetUserName\fR ( const QString & name )" -.br -.ti -1c -.BI "virtual void \fBsetPassword\fR ( const QString & password )" -.br -.ti -1c -.BI "virtual void \fBsetHostName\fR ( const QString & host )" -.br -.ti -1c -.BI "virtual void \fBsetPort\fR ( int p )" -.br -.ti -1c -.BI "void \fBsetConnectOptions\fR ( const QString & options = QString::null )" -.br -.ti -1c -.BI "QString \fBdatabaseName\fR () const" -.br -.ti -1c -.BI "QString \fBuserName\fR () const" -.br -.ti -1c -.BI "QString \fBpassword\fR () const" -.br -.ti -1c -.BI "QString \fBhostName\fR () const" -.br -.ti -1c -.BI "QString \fBdriverName\fR () const" -.br -.ti -1c -.BI "int \fBport\fR () const" -.br -.ti -1c -.BI "QString \fBconnectOptions\fR () const" -.br -.ti -1c -.BI "QSqlDriver * \fBdriver\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QSqlDatabase * \fBaddDatabase\fR ( const QString & type, const QString & connectionName = defaultConnection )" -.br -.ti -1c -.BI "QSqlDatabase * \fBaddDatabase\fR ( QSqlDriver * driver, const QString & connectionName = defaultConnection )" -.br -.ti -1c -.BI "QSqlDatabase * \fBdatabase\fR ( const QString & connectionName = defaultConnection, bool open = TRUE )" -.br -.ti -1c -.BI "void \fBremoveDatabase\fR ( const QString & connectionName )" -.br -.ti -1c -.BI "void \fBremoveDatabase\fR ( QSqlDatabase * db )" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QString & connectionName = defaultConnection )" -.br -.ti -1c -.BI "QStringList \fBdrivers\fR ()" -.br -.ti -1c -.BI "void \fBregisterSqlDriver\fR ( const QString & name, const QSqlDriverCreatorBase * creator )" -.br -.ti -1c -.BI "bool \fBisDriverAvailable\fR ( const QString & name )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QString \fBconnectOptions\fR - the database connect options" -.br -.ti -1c -.BI "QString \fBdatabaseName\fR - the name of the database" -.br -.ti -1c -.BI "QString \fBhostName\fR - the host name where the database resides" -.br -.ti -1c -.BI "QString \fBpassword\fR - the password used to connect to the database" -.br -.ti -1c -.BI "int \fBport\fR - the port used to connect to the database" -.br -.ti -1c -.BI "QString \fBuserName\fR - the user name connected to the database" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQSqlDatabase\fR ( const QString & type, const QString & name, QObject * parent = 0, const char * objname = 0 )" -.br -.ti -1c -.BI "\fBQSqlDatabase\fR ( QSqlDriver * driver, QObject * parent = 0, const char * objname = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QSqlDatabase class is used to create SQL database connections and to provide transaction handling. -.PP -Note that transaction handling is not supported by every SQL database. You can find out whether transactions are supported using QSqlDriver::hasFeature(). -.PP -The QSqlDatabase class provides an abstract interface for accessing many types of database backends. Database-specific drivers are used internally to actually access and manipulate data, (see QSqlDriver). Result set objects provide the interface for executing and manipulating SQL queries (see QSqlQuery). -.PP -See also Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlDatabase::QSqlDatabase ( const QString & type, const QString & name, QObject * parent = 0, const char * objname = 0 )\fC [protected]\fR" -Creates a QSqlDatabase connection called \fIname\fR that uses the driver referred to by \fItype\fR, with the parent \fIparent\fR and the object name \fIobjname\fR. If the \fItype\fR is not recognized, the database connection will have no functionality. -.PP -The currently available drivers are: -.PP -
                                                            .nf -.TS -l - l. Driver Type Description QODBC3 ODBC Driver (includes Microsoft SQL Server) QOCI8 Oracle Call Interface Driver QPSQL7 PostgreSQL v6.x and v7.x Driver QTDS7 Sybase Adaptive Server QMYSQL3 MySQL Driver QDB2 IBM DB2, v7.1 and higher QSQLITE SQLite Driver QIBASE -.TE -.fi -
                                                            -.PP -Additional third party drivers, including your own custom drivers, can be loaded dynamically. -.PP -See also registerSqlDriver(). -.SH "QSqlDatabase::QSqlDatabase ( QSqlDriver * driver, QObject * parent = 0, const char * objname = 0 )\fC [protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Creates a database connection using the driver \fIdriver\fR, with the parent \fIparent\fR and the object name \fIobjname\fR. -.PP -\fBWarning:\fR The framework takes ownership of the \fIdriver\fR pointer, so it should not be deleted. -.SH "QSqlDatabase::~QSqlDatabase ()" -Destroys the object and frees any allocated resources. -.SH "QSqlDatabase * QSqlDatabase::addDatabase ( const QString & type, const QString & connectionName = defaultConnection )\fC [static]\fR" -Adds a database to the list of database connections using the driver \fItype\fR and the connection name \fIconnectionName\fR. -.PP -The database connection is referred to by \fIconnectionName\fR. The newly added database connection is returned. This pointer is owned by QSqlDatabase and will be deleted on program exit or when removeDatabase() is called. -.PP -If \fIconnectionName\fR is not specified, the newly added database connection becomes the default database connection for the application, and subsequent calls to database() (without a database name parameter) will return a pointer to it. If \fIconnectionName\fR is given, use database(connectionName) to retrieve a pointer to the database connection. -.PP -\fBWarning:\fR If you add a database with the same name as an existing database, the new database will replace the old one. This will happen automatically if you call this function more than once without specifying \fIconnectionName\fR. -.PP -See also database() and removeDatabase(). -.PP -Examples: -.)l sql/overview/connect1/main.cpp, sql/overview/connection.cpp, and sql/sqltable/main.cpp. -.SH "QSqlDatabase * QSqlDatabase::addDatabase ( QSqlDriver * driver, const QString & connectionName = defaultConnection )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function is useful if you need to set up the database connection and instantiate the driver yourself. If you do this, it is recommended that you include the driver code in your own application. For example, setting up a custom PostgreSQL connection and instantiating the QPSQL7 driver can be done the following way: -.PP -.nf -.br - #include "qtdir/src/sql/drivers/psql/qsql_psql.cpp" -.br -.fi -(We assume that \fCqtdir\fR is the directory where Qt is installed.) This will pull in the code that is needed to use the PostgreSQL client library and to instantiate a QPSQLDriver object, assuming that you have the PostgreSQL headers somewhere in your include search path. -.PP -.nf -.br - PGconn* con = PQconnectdb( "host=server user=bart password=simpson dbname=springfield" ); -.br - QPSQLDriver* drv = new QPSQLDriver( con ); -.br - QSqlDatabase* db = QSqlDatabase::addDatabase( drv ); // becomes the new default connection -.br - QSqlQuery q; -.br - q.exec( "SELECT * FROM people" ); -.br - ... -.br -.fi -.PP -The above code sets up a PostgreSQL connection and instantiates a QPSQLDriver object. Next, addDatabase() is called to add the connection to the known connections so that it can be used by the Qt SQL classes. When a driver is instantiated with a connection handle (or set of handles), Qt assumes that you have already opened the database connection. -.PP -Remember that you must link your application against the database client library as well. The simplest way to do this is to add lines like those below to your \fC.pro\fR file: -.PP -.nf -.br - unix:LIBS += -lpq -.br - win32:LIBS += libpqdll.lib -.br -.fi -.PP -You will need to have the client library in your linker's search path. -.PP -The method described above will work for all the drivers, the only difference is the arguments the driver constructors take. Below is an overview of the drivers and their constructor arguments. -.PP -
                                                            .nf -.TS -l - l. Driver Class name Constructor arguments File to include QPSQL7 QPSQLDriver PGconn* connection QMYSQL3 QMYSQLDriver MYSQL* connection QOCI8 QOCIDriver OCIEnv* environment, OCIError* error, OCISvcCtx* serviceContext QODBC3 QODBCDriver SQLHANDLE environment, SQLHANDLE connection QDB2 QDB2 SQLHANDLE environment, SQLHANDLE connection QTDS7 QTDSDriver LOGINREC* loginRecord, DBPROCESS* dbProcess, const QString& hostName QSQLITE QSQLiteDriver sqlite* connection QIBASE QIBaseDriver isc_db_handle connection -.TE -.fi -
                                                            -.PP -Note: The host name (or service name) is needed when constructing the QTDSDriver for creating new connections for internal queries. This is to prevent the simultaneous usage of several QSqlQuery/QSqlCursor objects from blocking each other. -.PP -\fBWarning:\fR The SQL framework takes ownership of the \fIdriver\fR pointer, and it should not be deleted. The returned QSqlDatabase object is owned by the framework and must not be deleted. If you want to explicitly remove the connection, use removeDatabase() -.PP -See also drivers(). -.SH "void QSqlDatabase::close ()" -Closes the database connection, freeing any resources acquired. -.PP -See also removeDatabase(). -.SH "bool QSqlDatabase::commit ()" -Commits a transaction to the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. -.PP -See also QSqlDriver::hasFeature() and rollback(). -.SH "QString QSqlDatabase::connectOptions () const" -Returns the database connect options. See the "connectOptions" property for details. -.SH "bool QSqlDatabase::contains ( const QString & connectionName = defaultConnection )\fC [static]\fR" -Returns TRUE if the list of database connections contains \fIconnectionName\fR; otherwise returns FALSE. -.SH "QSqlDatabase * QSqlDatabase::database ( const QString & connectionName = defaultConnection, bool open = TRUE )\fC [static]\fR" -Returns the database connection called \fIconnectionName\fR. The database connection must have been previously added with addDatabase(). If \fIopen\fR is TRUE (the default) and the database connection is not already open it is opened now. If no \fIconnectionName\fR is specified the default connection is used. If \fIconnectionName\fR does not exist in the list of databases, 0 is returned. The pointer returned is owned by QSqlDatabase and should \fInot\fR be deleted. -.PP -\fBWarning:\fR There are restrictions on the use of database connections in threaded applications. Please see the Thread Support in Qt document for more information about threading and SQL databases. -.PP -Examples: -.)l sql/overview/basicbrowsing/main.cpp and sql/overview/create_connections/main.cpp. -.SH "QString QSqlDatabase::databaseName () const" -Returns the name of the database. See the "databaseName" property for details. -.SH "QSqlDriver * QSqlDatabase::driver () const" -Returns the database driver used to access the database connection. -.SH "QString QSqlDatabase::driverName () const" -Returns the name of the driver used by the database connection. -.SH "QStringList QSqlDatabase::drivers ()\fC [static]\fR" -Returns a list of all the available database drivers. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = QSqlDatabase::drivers(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "QSqlQuery QSqlDatabase::exec ( const QString & query = QString::null ) const" -Executes a SQL statement (e.g. an \fCINSERT\fR, \fCUPDATE\fR or \fCDELETE\fR statement) on the database, and returns a QSqlQuery object. Use lastError() to retrieve error information. If \fIquery\fR is QString::null, an empty, invalid query is returned and lastError() is not affected. -.PP -See also QSqlQuery and lastError(). -.SH "QString QSqlDatabase::hostName () const" -Returns the host name where the database resides. See the "hostName" property for details. -.SH "bool QSqlDatabase::isDriverAvailable ( const QString & name )\fC [static]\fR" -Returns TRUE if a driver called \fIname\fR is available; otherwise returns FALSE. -.PP -See also drivers(). -.SH "bool QSqlDatabase::isOpen () const" -Returns TRUE if the database connection is currently open; otherwise returns FALSE. -.SH "bool QSqlDatabase::isOpenError () const" -Returns TRUE if there was an error opening the database connection; otherwise returns FALSE. Error information can be retrieved using the lastError() function. -.SH "QSqlError QSqlDatabase::lastError () const" -Returns information about the last error that occurred on the database. See QSqlError for more information. -.PP -Examples: -.)l sql/overview/connection.cpp and sql/sqltable/main.cpp. -.SH "bool QSqlDatabase::open ()" -Opens the database connection using the current connection values. Returns TRUE on success; otherwise returns FALSE. Error information can be retrieved using the lastError() function. -.PP -See also lastError(). -.PP -Examples: -.)l sql/overview/connect1/main.cpp, sql/overview/connection.cpp, and sql/sqltable/main.cpp. -.SH "bool QSqlDatabase::open ( const QString & user, const QString & password )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Opens the database connection using the given \fIuser\fR name and \fIpassword\fR. Returns TRUE on success; otherwise returns FALSE. Error information can be retrieved using the lastError() function. -.PP -This function does not store the password it is given. Instead, the password is passed directly to the driver for opening a connection and is then discarded. -.PP -See also lastError(). -.SH "QString QSqlDatabase::password () const" -Returns the password used to connect to the database. See the "password" property for details. -.SH "int QSqlDatabase::port () const" -Returns the port used to connect to the database. See the "port" property for details. -.SH "QSqlIndex QSqlDatabase::primaryIndex ( const QString & tablename ) const" -Returns the primary index for table \fItablename\fR. If no primary index exists an empty QSqlIndex will be returned. -.SH "QSqlRecord QSqlDatabase::record ( const QString & tablename ) const" -Returns a QSqlRecord populated with the names of all the fields in the table (or view) called \fItablename\fR. The order in which the fields appear in the record is undefined. If no such table (or view) exists, an empty record is returned. -.PP -See also recordInfo(). -.SH "QSqlRecord QSqlDatabase::record ( const QSqlQuery & query ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a QSqlRecord populated with the names of all the fields used in the SQL \fIquery\fR. If the query is a "SELECT *" the order in which fields appear in the record is undefined. -.PP -See also recordInfo(). -.SH "QSqlRecordInfo QSqlDatabase::recordInfo ( const QString & tablename ) const" -Returns a QSqlRecordInfo populated with meta data about the table or view \fItablename\fR. If no such table (or view) exists, an empty record is returned. -.PP -See also QSqlRecordInfo, QSqlFieldInfo, and record(). -.SH "QSqlRecordInfo QSqlDatabase::recordInfo ( const QSqlQuery & query ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a QSqlRecordInfo object with meta data for the QSqlQuery \fIquery\fR. Note that this overloaded function may return less information than the recordInfo() function which takes the name of a table as parameter. -.PP -See also QSqlRecordInfo, QSqlFieldInfo, and record(). -.SH "void QSqlDatabase::registerSqlDriver ( const QString & name, const QSqlDriverCreatorBase * creator )\fC [static]\fR" -This function registers a new SQL driver called \fIname\fR, within the SQL framework. This is useful if you have a custom SQL driver and don't want to compile it as a plugin. -.PP -Example usage: -.PP -.nf -.br - QSqlDatabase::registerSqlDriver( "MYDRIVER", new QSqlDriverCreator ); -.br - QSqlDatabase* db = QSqlDatabase::addDatabase( "MYDRIVER" ); -.br - ... -.br -.fi -.PP -\fBWarning:\fR The framework takes ownership of the \fIcreator\fR pointer, so it should not be deleted. -.SH "void QSqlDatabase::removeDatabase ( const QString & connectionName )\fC [static]\fR" -Removes the database connection \fIconnectionName\fR from the list of database connections. -.PP -\fBWarning:\fR There should be no open queries on the database connection when this function is called, otherwise a resource leak will occur. -.SH "void QSqlDatabase::removeDatabase ( QSqlDatabase * db )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes the database connection \fIdb\fR from the list of database connections. The QSqlDatabase object is destroyed when it is removed from the list. -.PP -\fBWarning:\fR The \fIdb\fR pointer is not valid after this function has been called. There should be no open queries on the database connection when this function is called, otherwise a resource leak will occur. -.SH "bool QSqlDatabase::rollback ()" -Rolls a transaction back on the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. -.PP -See also QSqlDriver::hasFeature(), commit(), and transaction(). -.SH "void QSqlDatabase::setConnectOptions ( const QString & options = QString::null )" -Sets the database connect options to \fIoptions\fR. See the "connectOptions" property for details. -.SH "void QSqlDatabase::setDatabaseName ( const QString & name )\fC [virtual]\fR" -Sets the name of the database to \fIname\fR. See the "databaseName" property for details. -.SH "void QSqlDatabase::setHostName ( const QString & host )\fC [virtual]\fR" -Sets the host name where the database resides to \fIhost\fR. See the "hostName" property for details. -.SH "void QSqlDatabase::setPassword ( const QString & password )\fC [virtual]\fR" -Sets the password used to connect to the database to \fIpassword\fR. See the "password" property for details. -.SH "void QSqlDatabase::setPort ( int p )\fC [virtual]\fR" -Sets the port used to connect to the database to \fIp\fR. See the "port" property for details. -.SH "void QSqlDatabase::setUserName ( const QString & name )\fC [virtual]\fR" -Sets the user name connected to the database to \fIname\fR. See the "userName" property for details. -.SH "QStringList QSqlDatabase::tables ( QSql::TableType type ) const" -Returns a list of the database's tables, system tables and views, as specified by the parameter \fItype\fR. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myDatabase.tables( QSql::Tables | QSql::Views ); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -Example: sql/sqltable/main.cpp. -.SH "QStringList QSqlDatabase::tables () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a list of the database's tables that are visible to the user. To include views or system tables, use the version of this function that takes a table \fCtype\fR parameter. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myDatabase.tables(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "bool QSqlDatabase::transaction ()" -Begins a transaction on the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. -.PP -See also QSqlDriver::hasFeature(), commit(), and rollback(). -.SH "QString QSqlDatabase::userName () const" -Returns the user name connected to the database. See the "userName" property for details. -.SS "Property Documentation" -.SH "QString connectOptions" -This property holds the database connect options. -.PP -The format of the options string is a semi-colon separated list of option names or option = value pairs. The options depend on the database client used: -.PP -
                                                            .nf -.TS -l - l. ODBC MySQL PostgreSQL -.TP -SQL_ATTR_ACCESS_MODE -.TP -SQL_ATTR_LOGIN_TIMEOUT -.TP -SQL_ATTR_CONNECTION_TIMEOUT -.TP -SQL_ATTR_CURRENT_CATALOG -.TP -SQL_ATTR_METADATA_ID -.TP -SQL_ATTR_PACKET_SIZE -.TP -SQL_ATTR_TRACEFILE -.TP -SQL_ATTR_TRACE -.PP .TP -CLIENT_COMPRESS -.TP -CLIENT_FOUND_ROWS -.TP -CLIENT_IGNORE_SPACE -.TP -CLIENT_SSL -.TP -CLIENT_ODBC -.TP -CLIENT_NO_SCHEMA -.TP -CLIENT_INTERACTIVE -.PP .TP -connect_timeout -.TP -options -.TP -tty -.TP -requiressl -.TP -service DB2 OCI TDS -.TP -SQL_ATTR_ACCESS_MODE -.TP -SQL_ATTR_LOGIN_TIMEOUT -.PP \fInone\fR -.PP -.TE -.fi -
                                                            -.PP -Example of usage: -.PP -.nf -.br - ... -.br - // MySQL connection -.br - db->setConnectOptions( "CLIENT_SSL;CLIENT_IGNORE_SPACE" ); // use an SSL connection to the server -.br - if ( !db->open() ) { -.br - db->setConnectOptions(); // clears the connect option string -.br - ... -.br - } -.br - ... -.br - // PostgreSQL connection -.br - db->setConnectOptions( "requiressl=1" ); // enable PostgreSQL SSL connections -.br - if ( !db->open() ) { -.br - db->setConnectOptions(); // clear options -.br - ... -.br - } -.br - ... -.br - // ODBC connection -.br - db->setConnectOptions( "SQL_ATTR_ACCESS_MODE=SQL_MODE_READ_ONLY;SQL_ATTR_TRACE=SQL_OPT_TRACE_ON" ); // set ODBC options -.br - if ( !db->open() ) { -.br - db->setConnectOptions(); // don't try to set this option -.br - ... -.br - } -.br -.fi -.PP -Please refer to the client library documentation for more information about the different options. The options will be set prior to opening the database connection. Setting new options without re-opening the connection does nothing. -.PP -See also -.PP -Set this property's value with setConnectOptions() and get this property's value with connectOptions(). -.SH "QString databaseName" -This property holds the name of the database. -.PP -Note that the database name is the TNS Service Name for the QOCI8 (Oracle) driver. -.PP -For the QODBC3 driver it can either be a DSN, a DSN filename (the file must have a \fC.dsn\fR extension), or a connection string. MS Access users can for example use the following connection string to open a \fC.mdb\fR file directly, instead of having to create a DSN entry in the ODBC manager: -.PP -.nf -.br - ... -.br - db = QSqlDatabase::addDatabase( "QODBC3" ); -.br - db->setDatabaseName( "DRIVER={Microsoft Access Driver (*.mdb)};FIL={MS Access};DBQ=myaccessfile.mdb" ); -.br - if ( db->open() ) { -.br - // success! -.br - } -.br - ... -.br -.fi -("FIL" is the required spelling in Microsoft's API.) -.PP -There is no default value. -.PP -Set this property's value with setDatabaseName() and get this property's value with databaseName(). -.SH "QString hostName" -This property holds the host name where the database resides. -.PP -There is no default value. -.PP -Set this property's value with setHostName() and get this property's value with hostName(). -.SH "QString password" -This property holds the password used to connect to the database. -.PP -There is no default value. -.PP -\fBWarning:\fR This function stores the password in plain text within Qt. Use the open() call that takes a password as parameter to avoid this behaviour. -.PP -See also open(). -.PP -Set this property's value with setPassword() and get this property's value with password(). -.SH "int port" -This property holds the port used to connect to the database. -.PP -There is no default value. -.PP -Set this property's value with setPort() and get this property's value with port(). -.SH "QString userName" -This property holds the user name connected to the database. -.PP -There is no default value. -.PP -Set this property's value with setUserName() and get this property's value with userName(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqldatabase.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqldatabase.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqldriver.3qt b/doc/man/man3/qsqldriver.3qt deleted file mode 100644 index b3d0f239f..000000000 --- a/doc/man/man3/qsqldriver.3qt +++ /dev/null @@ -1,253 +0,0 @@ -'\" t -.TH QSqlDriver 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 -QSqlDriver \- Abstract base class for accessing SQL databases -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBDriverFeature\fR { Transactions, QuerySize, BLOB, Unicode, PreparedQueries, NamedPlaceholders, PositionalPlaceholders }" -.br -.ti -1c -.BI "\fBQSqlDriver\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSqlDriver\fR ()" -.br -.ti -1c -.BI "bool \fBisOpen\fR () const" -.br -.ti -1c -.BI "bool \fBisOpenError\fR () const" -.br -.ti -1c -.BI "virtual bool \fBbeginTransaction\fR ()" -.br -.ti -1c -.BI "virtual bool \fBcommitTransaction\fR ()" -.br -.ti -1c -.BI "virtual bool \fBrollbackTransaction\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBtables\fR ( const QString & tableType ) const" -.br -.ti -1c -.BI "virtual QSqlIndex \fBprimaryIndex\fR ( const QString & tableName ) const" -.br -.ti -1c -.BI "virtual QSqlRecord \fBrecord\fR ( const QString & tableName ) const" -.br -.ti -1c -.BI "virtual QSqlRecord \fBrecord\fR ( const QSqlQuery & query ) const" -.br -.ti -1c -.BI "virtual QSqlRecordInfo \fBrecordInfo\fR ( const QString & tablename ) const" -.br -.ti -1c -.BI "virtual QSqlRecordInfo \fBrecordInfo\fR ( const QSqlQuery & query ) const" -.br -.ti -1c -.BI "virtual QString \fBnullText\fR () const" -.br -.ti -1c -.BI "virtual QString \fBformatValue\fR ( const QSqlField * field, bool trimStrings = FALSE ) const" -.br -.ti -1c -.BI "QSqlError \fBlastError\fR () const" -.br -.ti -1c -.BI "virtual bool \fBhasFeature\fR ( DriverFeature f ) const = 0" -.br -.ti -1c -.BI "virtual bool \fBopen\fR ( const QString & db, const QString & user = QString::null, const QString & password = QString::null, const QString & host = QString::null, int port = -1 ) = 0" -.br -.ti -1c -.BI "virtual void \fBclose\fR () = 0" -.br -.ti -1c -.BI "virtual QSqlQuery \fBcreateQuery\fR () const = 0" -.br -.ti -1c -.BI "bool \fBopen\fR ( const QString & db, const QString & user, const QString & password, const QString & host, int port, const QString & connOpts )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBsetOpen\fR ( bool o )" -.br -.ti -1c -.BI "virtual void \fBsetOpenError\fR ( bool e )" -.br -.ti -1c -.BI "virtual void \fBsetLastError\fR ( const QSqlError & e )" -.br -.in -1c -.SH DESCRIPTION -The QSqlDriver class is an abstract base class for accessing SQL databases. -.PP -This class should not be used directly. Use QSqlDatabase instead. -.PP -See also Database Classes. -.SS "Member Type Documentation" -.SH "QSqlDriver::DriverFeature" -This enum contains a list of features a driver may support. Use hasFeature() to query whether a feature is supported or not. -.TP -\fCQSqlDriver::Transactions\fR - whether the driver supports SQL transactions -.TP -\fCQSqlDriver::QuerySize\fR - whether the database is capable of reporting the size of a query. Note that some databases do not support returning the size (i.e. number of rows returned) of a query, in which case QSqlQuery::size() will return -1 -.TP -\fCQSqlDriver::BLOB\fR - whether the driver supports Binary Large Object fields -.TP -\fCQSqlDriver::Unicode\fR - whether the driver supports Unicode strings if the database server does -.TP -\fCQSqlDriver::PreparedQueries\fR - whether the driver supports prepared query execution -.TP -\fCQSqlDriver::NamedPlaceholders\fR - whether the driver supports usage of named placeholders -.TP -\fCQSqlDriver::PositionalPlaceholders\fR - whether the driver supports usage of positional placeholders -.PP -More information about supported features can be found in the Qt SQL driver documentation. -.PP -See also hasFeature(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlDriver::QSqlDriver ( QObject * parent = 0, const char * name = 0 )" -Default constructor. Creates a new driver with parent \fIparent\fR, called \fIname\fR. -.SH "QSqlDriver::~QSqlDriver ()" -Destroys the object and frees any allocated resources. -.SH "bool QSqlDriver::beginTransaction ()\fC [virtual]\fR" -Protected function which derived classes can reimplement to begin a transaction. If successful, return TRUE, otherwise return FALSE. The default implementation returns FALSE. -.PP -See also commitTransaction() and rollbackTransaction(). -.SH "void QSqlDriver::close ()\fC [pure virtual]\fR" -Derived classes must reimplement this abstract virtual function in order to close the database connection. Return TRUE on success, FALSE on failure. -.PP -See also setOpen(). -.SH "bool QSqlDriver::commitTransaction ()\fC [virtual]\fR" -Protected function which derived classes can reimplement to commit a transaction. If successful, return TRUE, otherwise return FALSE. The default implementation returns FALSE. -.PP -See also beginTransaction() and rollbackTransaction(). -.SH "QSqlQuery QSqlDriver::createQuery () const\fC [pure virtual]\fR" -Creates an empty SQL result on the database. Derived classes must reimplement this function and return a QSqlQuery object appropriate for their database to the caller. -.SH "QString QSqlDriver::formatValue ( const QSqlField * field, bool trimStrings = FALSE ) const\fC [virtual]\fR" -Returns a string representation of the \fIfield\fR value for the database. This is used, for example, when constructing INSERT and UPDATE statements. -.PP -The default implementation returns the value formatted as a string according to the following rules: -.IP -.TP -If \fIfield\fR is NULL, nullText() is returned. -.IP -.TP -If \fIfield\fR is character data, the value is returned enclosed in single quotation marks, which is appropriate for many SQL databases. Any embedded single-quote characters are escaped (replaced with two single-quote characters). If \fItrimStrings\fR is TRUE (the default is FALSE), all trailing whitespace is trimmed from the field. -.IP -.TP -If \fIfield\fR is date/time data, the value is formatted in ISO format and enclosed in single quotation marks. If the date/time data is invalid, nullText() is returned. -.IP -.TP -If \fIfield\fR is bytearray data, and the driver can edit binary fields, the value is formatted as a hexadecimal string. -.IP -.TP -For any other field type toString() will be called on its value and the result returned. -.IP -.PP -See also QVariant::toString(). -.SH "bool QSqlDriver::hasFeature ( DriverFeature f ) const\fC [pure virtual]\fR" -Returns TRUE if the driver supports feature \fIf\fR; otherwise returns FALSE. -.PP -Note that some databases need to be open() before this can be determined. -.PP -See also DriverFeature. -.SH "bool QSqlDriver::isOpen () const" -Returns TRUE if the database connection is open; otherwise returns FALSE. -.SH "bool QSqlDriver::isOpenError () const" -Returns TRUE if the there was an error opening the database connection; otherwise returns FALSE. -.SH "QSqlError QSqlDriver::lastError () const" -Returns a QSqlError object which contains information about the last error that occurred on the database. -.SH "QString QSqlDriver::nullText () const\fC [virtual]\fR" -Returns a string representation of the NULL value for the database. This is used, for example, when constructing INSERT and UPDATE statements. The default implementation returns the string" NULL". -.SH "bool QSqlDriver::open ( const QString & db, const QString & user = QString::null, const QString & password = QString::null, const QString & host = QString::null, int port = -1 )\fC [pure virtual]\fR" -Derived classes must reimplement this abstract virtual function in order to open a database connection on database \fIdb\fR, using user name \fIuser\fR, password \fIpassword\fR, host \fIhost\fR and port \fIport\fR. -.PP -The function \fImust\fR return TRUE on success and FALSE on failure. -.PP -See also setOpen(). -.SH "bool QSqlDriver::open ( const QString & db, const QString & user, const QString & password, const QString & host, int port, const QString & connOpts )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Open a database connection on database \fIdb\fR, using user name \fIuser\fR, password \fIpassword\fR, host \fIhost\fR, port \fIport\fR and connection options \fIconnOpts\fR. -.PP -Returns TRUE on success and FALSE on failure. -.PP -See also setOpen(). -.SH "QSqlIndex QSqlDriver::primaryIndex ( const QString & tableName ) const\fC [virtual]\fR" -Returns the primary index for table \fItableName\fR. Returns an empty QSqlIndex if the table doesn't have a primary index. The default implementation returns an empty index. -.SH "QSqlRecord QSqlDriver::record ( const QString & tableName ) const\fC [virtual]\fR" -Returns a QSqlRecord populated with the names of the fields in table \fItableName\fR. If no such table exists, an empty record is returned. The default implementation returns an empty record. -.SH "QSqlRecord QSqlDriver::record ( const QSqlQuery & query ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a QSqlRecord populated with the names of the fields in the SQL \fIquery\fR. The default implementation returns an empty record. -.SH "QSqlRecordInfo QSqlDriver::recordInfo ( const QString & tablename ) const\fC [virtual]\fR" -Returns a QSqlRecordInfo object with meta data about the table \fItablename\fR. -.SH "QSqlRecordInfo QSqlDriver::recordInfo ( const QSqlQuery & query ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a QSqlRecordInfo object with meta data for the QSqlQuery \fIquery\fR. Note that this overloaded function may return less information than the recordInfo() function which takes the name of a table as parameter. -.SH "bool QSqlDriver::rollbackTransaction ()\fC [virtual]\fR" -Protected function which derived classes can reimplement to rollback a transaction. If successful, return TRUE, otherwise return FALSE. The default implementation returns FALSE. -.PP -See also beginTransaction() and commitTransaction(). -.SH "void QSqlDriver::setLastError ( const QSqlError & e )\fC [virtual protected]\fR" -Protected function which allows derived classes to set the value of the last error, \fIe\fR, that occurred on the database. -.PP -See also lastError(). -.SH "void QSqlDriver::setOpen ( bool o )\fC [virtual protected]\fR" -Protected function which sets the open state of the database to \fIo\fR. Derived classes can use this function to report the status of open(). -.PP -See also open() and setOpenError(). -.SH "void QSqlDriver::setOpenError ( bool e )\fC [virtual protected]\fR" -Protected function which sets the open error state of the database to \fIe\fR. Derived classes can use this function to report the status of open(). Note that if \fIe\fR is TRUE the open state of the database is set to closed (i.e. isOpen() returns FALSE). -.PP -See also open(). -.SH "QStringList QSqlDriver::tables ( const QString & tableType ) const\fC [virtual]\fR" -Returns a list of tables in the database. The default implementation returns an empty list. -.PP -The \fItableType\fR argument describes what types of tables should be returned. Due to binary compatibility, the string contains the value of the enum QSql::TableTypes as text. An empty string should be treated as QSql::Tables for downward compatibility. -.PP -See also QSql::TableType. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqldriver.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqldriver.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqldriverplugin.3qt b/doc/man/man3/qsqldriverplugin.3qt deleted file mode 100644 index b2a495265..000000000 --- a/doc/man/man3/qsqldriverplugin.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QSqlDriverPlugin 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 -QSqlDriverPlugin \- Abstract base for custom QSqlDriver plugins -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlDriverPlugin\fR ()" -.br -.ti -1c -.BI "\fB~QSqlDriverPlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBkeys\fR () const = 0" -.br -.ti -1c -.BI "virtual QSqlDriver * \fBcreate\fR ( const QString & key ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QSqlDriverPlugin class provides an abstract base for custom QSqlDriver plugins. -.PP -The SQL driver plugin is a simple plugin interface that makes it easy to create your own SQL driver plugins that can be loaded dynamically by Qt. -.PP -Writing a SQL plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the SQL plugins that come with Qt for example implementations (in the \fCplugins/src/sqldrivers\fR subdirectory of the source distribution). Read the plugins documentation for more information on plugins. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlDriverPlugin::QSqlDriverPlugin ()" -Constructs a SQL driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. -.SH "QSqlDriverPlugin::~QSqlDriverPlugin ()" -Destroys the SQL driver plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "QSqlDriver * QSqlDriverPlugin::create ( const QString & key )\fC [pure virtual]\fR" -Creates and returns a QSqlDriver object for the driver key \fIkey\fR. The driver key is usually the class name of the required driver. -.PP -See also keys(). -.SH "QStringList QSqlDriverPlugin::keys () const\fC [pure virtual]\fR" -Returns the list of drivers (keys) this plugin supports. -.PP -These keys are usually the class names of the custom drivers that are implemented in the plugin. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqldriverplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqldriverplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqleditorfactory.3qt b/doc/man/man3/qsqleditorfactory.3qt deleted file mode 100644 index 46e7333ec..000000000 --- a/doc/man/man3/qsqleditorfactory.3qt +++ /dev/null @@ -1,93 +0,0 @@ -'\" t -.TH QSqlEditorFactory 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 -QSqlEditorFactory \- Used to create the editors used by QDataTable and QSqlForm -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEditorFactory. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlEditorFactory\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSqlEditorFactory\fR ()" -.br -.ti -1c -.BI "virtual QWidget * \fBcreateEditor\fR ( QWidget * parent, const QVariant & variant )" -.br -.ti -1c -.BI "virtual QWidget * \fBcreateEditor\fR ( QWidget * parent, const QSqlField * field )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QSqlEditorFactory * \fBdefaultFactory\fR ()" -.br -.ti -1c -.BI "void \fBinstallDefaultFactory\fR ( QSqlEditorFactory * factory )" -.br -.in -1c -.SH DESCRIPTION -The QSqlEditorFactory class is used to create the editors used by QDataTable and QSqlForm. -.PP -QSqlEditorFactory is used by QDataTable and QSqlForm to automatically create appropriate editors for a given QSqlField. For example if the field is a QVariant::String a QLineEdit would be the default editor, whereas a QVariant::Int's default editor would be a QSpinBox. -.PP -If you want to create different editors for fields with the same data type, subclass QSqlEditorFactory and reimplement the createEditor() function. -.PP -See also QDataTable, QSqlForm, and Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlEditorFactory::QSqlEditorFactory ( QObject * parent = 0, const char * name = 0 )" -Constructs a SQL editor factory with parent \fIparent\fR, called \fIname\fR. -.SH "QSqlEditorFactory::~QSqlEditorFactory ()" -Destroys the object and frees any allocated resources. -.SH "QWidget * QSqlEditorFactory::createEditor ( QWidget * parent, const QVariant & variant )\fC [virtual]\fR" -Creates and returns the appropriate editor widget for the QVariant \fIvariant\fR. -.PP -The widget that is returned has the parent \fIparent\fR (which may be zero). If \fIvariant\fR is invalid, 0 is returned. -.PP -Reimplemented from QEditorFactory. -.SH "QWidget * QSqlEditorFactory::createEditor ( QWidget * parent, const QSqlField * field )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Creates and returns the appropriate editor for the QSqlField \fIfield\fR. -.SH "QSqlEditorFactory * QSqlEditorFactory::defaultFactory ()\fC [static]\fR" -Returns an instance of a default editor factory. -.SH "void QSqlEditorFactory::installDefaultFactory ( QSqlEditorFactory * factory )\fC [static]\fR" -Replaces the default editor factory with \fIfactory\fR. All -QDataTable and QSqlForm instantiations will use this new factory -for creating field editors. \fIQSqlEditorFactory takes ownership of \a factory, and destroys it when it is no longer needed.\fR - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqleditorfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqleditorfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlerror.3qt b/doc/man/man3/qsqlerror.3qt deleted file mode 100644 index b8c1f7749..000000000 --- a/doc/man/man3/qsqlerror.3qt +++ /dev/null @@ -1,142 +0,0 @@ -'\" t -.TH QSqlError 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 -QSqlError \- SQL database error information -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBType\fR { None, Connection, Statement, Transaction, Unknown }" -.br -.ti -1c -.BI "\fBQSqlError\fR ( const QString & driverText = QString::null, const QString & databaseText = QString::null, int type = QSqlError::None, int number = -1 )" -.br -.ti -1c -.BI "\fBQSqlError\fR ( const QSqlError & other )" -.br -.ti -1c -.BI "QSqlError & \fBoperator=\fR ( const QSqlError & other )" -.br -.ti -1c -.BI "virtual \fB~QSqlError\fR ()" -.br -.ti -1c -.BI "QString \fBdriverText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDriverText\fR ( const QString & driverText )" -.br -.ti -1c -.BI "QString \fBdatabaseText\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetDatabaseText\fR ( const QString & databaseText )" -.br -.ti -1c -.BI "int \fBtype\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetType\fR ( int type )" -.br -.ti -1c -.BI "int \fBnumber\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNumber\fR ( int number )" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "void showMessage ( const QString & msg = QString::null ) const \fI(obsolete)\fR" -.br -.in -1c -.SH DESCRIPTION -The QSqlError class provides SQL database error information. -.PP -This class is used to report database-specific errors. An error description and (if appropriate) a database-specific error number can be obtained using this class. -.PP -See also Database Classes. -.SS "Member Type Documentation" -.SH "QSqlError::Type" -This enum type describes the type of SQL error that occurred. -.TP -\fCQSqlError::None\fR - no error occurred -.TP -\fCQSqlError::Connection\fR - connection error -.TP -\fCQSqlError::Statement\fR - SQL statement syntax error -.TP -\fCQSqlError::Transaction\fR - transaction failed error -.TP -\fCQSqlError::Unknown\fR - unknown error -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlError::QSqlError ( const QString & driverText = QString::null, const QString & databaseText = QString::null, int type = QSqlError::None, int number = -1 )" -Constructs an error containing the driver error text \fIdriverText\fR, the database-specific error text \fIdatabaseText\fR, the type \fItype\fR and the optional error number \fInumber\fR. -.SH "QSqlError::QSqlError ( const QSqlError & other )" -Creates a copy of \fIother\fR. -.SH "QSqlError::~QSqlError ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "QString QSqlError::databaseText () const" -Returns the text of the error as reported by the database. This may contain database-specific descriptions. -.SH "QString QSqlError::driverText () const" -Returns the text of the error as reported by the driver. This may contain database-specific descriptions. -.SH "int QSqlError::number () const" -Returns the database-specific error number, or -1 if it cannot be determined. -.SH "QSqlError & QSqlError::operator= ( const QSqlError & other )" -Sets the error equal to \fIother\fR. -.SH "void QSqlError::setDatabaseText ( const QString & databaseText )\fC [virtual]\fR" -Sets the database error text to the value of \fIdatabaseText\fR. -.SH "void QSqlError::setDriverText ( const QString & driverText )\fC [virtual]\fR" -Sets the driver error text to the value of \fIdriverText\fR. -.SH "void QSqlError::setNumber ( int number )\fC [virtual]\fR" -Sets the database-specific error number to \fInumber\fR. -.SH "void QSqlError::setType ( int type )\fC [virtual]\fR" -Sets the error type to the value of \fItype\fR. -.SH "void QSqlError::showMessage ( const QString & msg = QString::null ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is a convenience function that pops up a QMessageBox containing the message returned by text(). An additional string can be passed in via the \fImsg\fR parameter, which will be concatenated with the text() message. -.PP -See also text(), driverText(), and databaseText(). -.SH "QString QSqlError::text () const" -This is a convenience function that returns databaseText() and driverText() concatenated into a single string. -.PP -See also showMessage(), driverText(), and databaseText(). -.SH "int QSqlError::type () const" -Returns the error type, or -1 if the type cannot be determined. -.PP -See also QSqlError::Type. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlerror.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlerror.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlfield.3qt b/doc/man/man3/qsqlfield.3qt deleted file mode 100644 index f39ce8e8b..000000000 --- a/doc/man/man3/qsqlfield.3qt +++ /dev/null @@ -1,199 +0,0 @@ -'\" t -.TH QSqlField 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 -QSqlField \- Manipulates the fields in SQL database tables and views -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlField\fR ( const QString & fieldName = QString::null, QVariant::Type type = QVariant::Invalid )" -.br -.ti -1c -.BI "\fBQSqlField\fR ( const QSqlField & other )" -.br -.ti -1c -.BI "QSqlField & \fBoperator=\fR ( const QSqlField & other )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QSqlField & other ) const" -.br -.ti -1c -.BI "virtual \fB~QSqlField\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetValue\fR ( const QVariant & value )" -.br -.ti -1c -.BI "virtual QVariant \fBvalue\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetName\fR ( const QString & name )" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetNull\fR ()" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetReadOnly\fR ( bool readOnly )" -.br -.ti -1c -.BI "bool \fBisReadOnly\fR () const" -.br -.ti -1c -.BI "void \fBclear\fR ( bool nullify = TRUE )" -.br -.ti -1c -.BI "QVariant::Type \fBtype\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QSqlField class manipulates the fields in SQL database tables and views. -.PP -QSqlField represents the characteristics of a single column in a database table or view, such as the data type and column name. A field also contains the value of the database column, which can be viewed or changed. -.PP -Field data values are stored as QVariants. Using an incompatible type is not permitted. For example: -.PP -.nf -.br - QSqlField f( "myfield", QVariant::Int ); -.br - f.setValue( QPixmap() ); // will not work -.br -.fi -.PP -However, the field will attempt to cast certain data types to the field data type where possible: -.PP -.nf -.br - QSqlField f( "myfield", QVariant::Int ); -.br - f.setValue( QString("123") ); // casts QString to int -.br -.fi -.PP -QSqlField objects are rarely created explicitly in application code. They are usually accessed indirectly through QSqlRecord or QSqlCursor which already contain a list of fields. For example: -.PP -.nf -.br - QSqlCursor cur( "Employee" ); // create cursor using the 'Employee' table -.br - QSqlField* f = cur.field( "name" ); // use the 'name' field -.br - f->setValue( "Dave" ); // set field value -.br - ... -.br -.fi -.PP -In practice we rarely need to extract a pointer to a field at all. The previous example would normally be written: -.PP -.nf -.br - QSqlCursor cur( "Employee" ); -.br - cur.setValue( "name", "Dave" ); -.br - ... -.br -.fi -.PP -See also Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlField::QSqlField ( const QString & fieldName = QString::null, QVariant::Type type = QVariant::Invalid )" -Constructs an empty field called \fIfieldName\fR of type \fItype\fR. -.SH "QSqlField::QSqlField ( const QSqlField & other )" -Constructs a copy of \fIother\fR. -.SH "QSqlField::~QSqlField ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "void QSqlField::clear ( bool nullify = TRUE )" -Clears the value of the field. If the field is read-only, nothing happens. If \fInullify\fR is TRUE (the default), the field is set to NULL. -.SH "bool QSqlField::isNull () const" -Returns TRUE if the field is currently NULL; otherwise returns FALSE. -.SH "bool QSqlField::isReadOnly () const" -Returns TRUE if the field's value is read only; otherwise returns FALSE. -.SH "QString QSqlField::name () const" -Returns the name of the field. -.PP -Example: sql/overview/table4/main.cpp. -.SH "QSqlField & QSqlField::operator= ( const QSqlField & other )" -Sets the field equal to \fIother\fR. -.SH "bool QSqlField::operator== ( const QSqlField & other ) const" -Returns TRUE if the field is equal to \fIother\fR; otherwise returns FALSE. Fields are considered equal when the following field properties are the same: -.TP -name() -.TP -isNull() -.TP -value() -.TP -isReadOnly() -.SH "void QSqlField::setName ( const QString & name )\fC [virtual]\fR" -Sets the name of the field to \fIname\fR. -.SH "void QSqlField::setNull ()\fC [virtual]\fR" -Sets the field to NULL and clears the value using clear(). If the field is read-only, nothing happens. -.PP -See also isReadOnly() and clear(). -.SH "void QSqlField::setReadOnly ( bool readOnly )\fC [virtual]\fR" -Sets the read only flag of the field's value to \fIreadOnly\fR. -.PP -See also setValue(). -.SH "void QSqlField::setValue ( const QVariant & value )\fC [virtual]\fR" -Sets the value of the field to \fIvalue\fR. If the field is read-only (isReadOnly() returns TRUE), nothing happens. If the data type of \fIvalue\fR differs from the field's current data type, an attempt is made to cast it to the proper type. This preserves the data type of the field in the case of assignment, e.g. a QString to an integer data type. For example: -.PP -.nf -.br - QSqlCursor cur( "Employee" ); // 'Employee' table -.br - QSqlField* f = cur.field( "student_count" ); // an integer field -.br - ... -.br - f->setValue( myLineEdit->text() ); // cast the line edit text to an integer -.br -.fi -.PP -See also isReadOnly(). -.SH "QVariant::Type QSqlField::type () const" -Returns the field's type as stored in the database. Note that the actual value might have a different type, Numerical values that are too large to store in a long int or double are usually stored as strings to prevent precision loss. -.SH "QVariant QSqlField::value () const\fC [virtual]\fR" -Returns the value of the field as a QVariant. -.PP -Example: sql/overview/table4/main.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlfield.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlfield.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlfieldinfo.3qt b/doc/man/man3/qsqlfieldinfo.3qt deleted file mode 100644 index c616e031c..000000000 --- a/doc/man/man3/qsqlfieldinfo.3qt +++ /dev/null @@ -1,175 +0,0 @@ -'\" t -.TH QSqlFieldInfo 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 -QSqlFieldInfo \- Stores meta data associated with a SQL field -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlFieldInfo\fR ( const QString & name = QString::null, QVariant::Type typ = QVariant::Invalid, int required = -1, int len = -1, int prec = -1, const QVariant & defValue = QVariant ( ), int typeID = 0, bool generated = TRUE, bool trim = FALSE, bool calculated = FALSE )" -.br -.ti -1c -.BI "\fBQSqlFieldInfo\fR ( const QSqlFieldInfo & other )" -.br -.ti -1c -.BI "\fBQSqlFieldInfo\fR ( const QSqlField & other, bool generated = TRUE )" -.br -.ti -1c -.BI "virtual \fB~QSqlFieldInfo\fR ()" -.br -.ti -1c -.BI "QSqlFieldInfo & \fBoperator=\fR ( const QSqlFieldInfo & other )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QSqlFieldInfo & f ) const" -.br -.ti -1c -.BI "QSqlField \fBtoField\fR () const" -.br -.ti -1c -.BI "int \fBisRequired\fR () const" -.br -.ti -1c -.BI "QVariant::Type \fBtype\fR () const" -.br -.ti -1c -.BI "int \fBlength\fR () const" -.br -.ti -1c -.BI "int \fBprecision\fR () const" -.br -.ti -1c -.BI "QVariant \fBdefaultValue\fR () const" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "int \fBtypeID\fR () const" -.br -.ti -1c -.BI "bool \fBisGenerated\fR () const" -.br -.ti -1c -.BI "bool \fBisTrim\fR () const" -.br -.ti -1c -.BI "bool \fBisCalculated\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetTrim\fR ( bool trim )" -.br -.ti -1c -.BI "virtual void \fBsetGenerated\fR ( bool gen )" -.br -.ti -1c -.BI "virtual void \fBsetCalculated\fR ( bool calc )" -.br -.in -1c -.SH DESCRIPTION -The QSqlFieldInfo class stores meta data associated with a SQL field. -.PP -QSqlFieldInfo objects only store meta data; field values are stored in QSqlField objects. -.PP -All values must be set in the constructor, and may be retrieved using isRequired(), type(), length(), precision(), defaultValue(), name(), isGenerated() and typeID(). -.PP -See also Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlFieldInfo::QSqlFieldInfo ( const QString & name = QString::null, QVariant::Type typ = QVariant::Invalid, int required = -1, int len = -1, int prec = -1, const QVariant & defValue = QVariant ( ), int typeID = 0, bool generated = TRUE, bool trim = FALSE, bool calculated = FALSE )" -Constructs a QSqlFieldInfo with the following parameters:
                                                            .nf -.TS -l - l. \fIname\fR the name of the field. \fItyp\fR the field's type in a QVariant. \fIrequired\fR greater than 0 if the field is required, 0 if its value can be NULL and less than 0 if it cannot be determined whether the field is required or not. \fIlen\fR the length of the field. Note that for non-character types some databases return either the length in bytes or the number of digits. -1 signifies that the length cannot be determined. \fIprec\fR the precision of the field, or -1 if the field has no precision or it cannot be determined. \fIdefValue\fR the default value that is inserted into the table if none is specified by the user. QVariant() if there is no default value or it cannot be determined. \fItypeID\fR the internal typeID of the database system (only useful for low-level programming). 0 if unknown. \fIgenerated\fR TRUE indicates that this field should be included in auto-generated SQL statments, e.g. in QSqlCursor. \fItrim\fR TRUE indicates that widgets should remove trailing whitespace from character fields. This does not affect the field value but only its representation inside widgets. \fIcalculated\fR -.TE -.fi -
                                                            -.SH "QSqlFieldInfo::QSqlFieldInfo ( const QSqlFieldInfo & other )" -Constructs a copy of \fIother\fR. -.SH "QSqlFieldInfo::QSqlFieldInfo ( const QSqlField & other, bool generated = TRUE )" -Creates a QSqlFieldInfo object with the type and the name of the QSqlField \fIother\fR. If \fIgenerated\fR is TRUE this field will be included in auto-generated SQL statments, e.g. in QSqlCursor. -.SH "QSqlFieldInfo::~QSqlFieldInfo ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "QVariant QSqlFieldInfo::defaultValue () const" -Returns the field's default value or an empty QVariant if the field has no default value or the value couldn't be determined. The default value is the value inserted in the database when it is not explicitly specified by the user. -.SH "bool QSqlFieldInfo::isCalculated () const" -Returns TRUE if the field is calculated; otherwise returns FALSE. -.PP -See also setCalculated(). -.SH "bool QSqlFieldInfo::isGenerated () const" -Returns TRUE if the field should be included in auto-generated SQL statments, e.g. in QSqlCursor; otherwise returns FALSE. -.PP -See also setGenerated(). -.SH "int QSqlFieldInfo::isRequired () const" -Returns a value greater than 0 if the field is required (NULL values are not allowed), 0 if it isn't required (NULL values are allowed) or less than 0 if it cannot be determined whether the field is required or not. -.SH "bool QSqlFieldInfo::isTrim () const" -Returns TRUE if trailing whitespace should be removed from character fields; otherwise returns FALSE. -.PP -See also setTrim(). -.SH "int QSqlFieldInfo::length () const" -Returns the field's length. For fields storing text the return value is the maximum number of characters the field can hold. For non-character fields some database systems return the number of bytes needed or the number of digits allowed. If the length cannot be determined -1 is returned. -.SH "QString QSqlFieldInfo::name () const" -Returns the name of the field in the SQL table. -.PP -Examples: -.)l sql/overview/subclass3/main.cpp and sql/overview/subclass4/main.cpp. -.SH "QSqlFieldInfo & QSqlFieldInfo::operator= ( const QSqlFieldInfo & other )" -Assigns \fIother\fR to this field info and returns a reference to it. -.SH "bool QSqlFieldInfo::operator== ( const QSqlFieldInfo & f ) const" -Returns TRUE if this fieldinfo is equal to \fIf\fR; otherwise returns FALSE. -.PP -Two field infos are considered equal if all their attributes match. -.SH "int QSqlFieldInfo::precision () const" -Returns the field's precision or -1 if the field has no precision or it cannot be determined. -.SH "void QSqlFieldInfo::setCalculated ( bool calc )\fC [virtual]\fR" -\fIcalc\fR set to TRUE indicates that this field is a calculated field. The value of calculated fields can by modified by subclassing QSqlCursor and overriding QSqlCursor::calculateField(). -.PP -See also isCalculated(). -.SH "void QSqlFieldInfo::setGenerated ( bool gen )\fC [virtual]\fR" -\fIgen\fR set to FALSE indicates that this field should not appear in auto-generated SQL statements (for example in QSqlCursor). -.PP -See also isGenerated(). -.SH "void QSqlFieldInfo::setTrim ( bool trim )\fC [virtual]\fR" -If \fItrim\fR is TRUE widgets should remove trailing whitespace from character fields. This does not affect the field value but only its representation inside widgets. -.PP -See also isTrim(). -.SH "QSqlField QSqlFieldInfo::toField () const" -Returns an empty QSqlField based on the information in this QSqlFieldInfo. -.SH "QVariant::Type QSqlFieldInfo::type () const" -Returns the field's type or QVariant::Invalid if the type is unknown. -.SH "int QSqlFieldInfo::typeID () const" -Returns the internal type identifier as returned from the database system. The return value is 0 if the type is unknown. -.PP -\fBWarning:\fR This information is only useful for low-level database -programming and is \fInot\fR database independent. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qsqlfieldinfo.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlfieldinfo.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlform.3qt b/doc/man/man3/qsqlform.3qt deleted file mode 100644 index d273db32b..000000000 --- a/doc/man/man3/qsqlform.3qt +++ /dev/null @@ -1,244 +0,0 @@ -'\" t -.TH QSqlForm 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 -QSqlForm \- Creates and manages data entry forms tied to SQL databases -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlForm\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QSqlForm\fR ()" -.br -.ti -1c -.BI "virtual void \fBinsert\fR ( QWidget * widget, const QString & field )" -.br -.ti -1c -.BI "virtual void \fBremove\fR ( const QString & field )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "QWidget * \fBwidget\fR ( uint i ) const" -.br -.ti -1c -.BI "QSqlField * \fBwidgetToField\fR ( QWidget * widget ) const" -.br -.ti -1c -.BI "QWidget * \fBfieldToWidget\fR ( QSqlField * field ) const" -.br -.ti -1c -.BI "void \fBinstallPropertyMap\fR ( QSqlPropertyMap * pmap )" -.br -.ti -1c -.BI "virtual void \fBsetRecord\fR ( QSqlRecord * buf )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBreadField\fR ( QWidget * widget )" -.br -.ti -1c -.BI "virtual void \fBwriteField\fR ( QWidget * widget )" -.br -.ti -1c -.BI "virtual void \fBreadFields\fR ()" -.br -.ti -1c -.BI "virtual void \fBwriteFields\fR ()" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBclearValues\fR ( bool nullify = FALSE )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBinsert\fR ( QWidget * widget, QSqlField * field )" -.br -.ti -1c -.BI "virtual void \fBremove\fR ( QWidget * widget )" -.br -.in -1c -.SH DESCRIPTION -The QSqlForm class creates and manages data entry forms tied to SQL databases. -.PP -Typical use of a QSqlForm consists of the following steps: -.TP -Create the widgets you want to appear in the form. -.TP -Create a cursor and navigate to the record to be edited. -.TP -Create the QSqlForm. -.TP -Set the form's record buffer to the cursor's update buffer. -.TP -Insert each widget and the field it is to edit into the form. -.TP -Use readFields() to update the editor widgets with values from the database's fields. -.TP -Display the form and let the user edit values etc. -.TP -Use writeFields() to update the database's field values with the values in the editor widgets. -.PP -Note that a QSqlForm does not access the database directly, but most often via QSqlFields which are part of a QSqlCursor. A QSqlCursor::insert(), QSqlCursor::update() or QSqlCursor::del() call is needed to actually write values to the database. -.PP -Some sample code to initialize a form successfully: -.PP -.nf -.br - QLineEdit myEditor( this ); -.br - QSqlForm myForm( this ); -.br - QSqlCursor myCursor( "mytable" ); -.br -.br - // Execute a query to make the cursor valid -.br - myCursor.select(); -.br - // Move the cursor to a valid record (the first record) -.br - myCursor.next(); -.br - // Set the form's record pointer to the cursor's edit buffer (which -.br - // contains the current record's values) -.br - myForm.setRecord( myCursor.primeUpdate() ); -.br -.br - // Insert a field into the form that uses myEditor to edit the -.br - // field 'somefield' in 'mytable' -.br - myForm.insert( &myEditor, "somefield" ); -.br -.br - // Update myEditor with the value from the mapped database field -.br - myForm.readFields(); -.br - ... -.br - // Let the user edit the form -.br - ... -.br - // Update the database -.br - myForm.writeFields(); // Update the cursor's edit buffer from the form -.br - myCursor.update(); // Update the database from the cursor's buffer -.br -.fi -.PP -If you want to use custom editors for displaying and editing data fields, you must install a custom QSqlPropertyMap. The form uses this object to get or set the value of a widget. -.PP -Note that Qt Designer provides a visual means of creating data-aware forms. -.PP -See also installPropertyMap(), QSqlPropertyMap, and Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlForm::QSqlForm ( QObject * parent = 0, const char * name = 0 )" -Constructs a QSqlForm with parent \fIparent\fR and called \fIname\fR. -.SH "QSqlForm::~QSqlForm ()" -Destroys the object and frees any allocated resources. -.SH "void QSqlForm::clear ()\fC [virtual slot]\fR" -Removes every widget, and the fields they're mapped to, from the form. -.SH "void QSqlForm::clearValues ( bool nullify = FALSE )\fC [virtual slot]\fR" -Clears the values in all the widgets, and the fields they are mapped to, in the form. If \fInullify\fR is TRUE (the default is FALSE), each field is also set to NULL. -.SH "uint QSqlForm::count () const" -Returns the number of widgets in the form. -.SH "QWidget * QSqlForm::fieldToWidget ( QSqlField * field ) const" -Returns the widget that field \fIfield\fR is mapped to. -.SH "void QSqlForm::insert ( QWidget * widget, const QString & field )\fC [virtual]\fR" -Inserts a \fIwidget\fR, and the name of the \fIfield\fR it is to be mapped to, into the form. To actually associate inserted widgets with an edit buffer, use setRecord(). -.PP -See also setRecord(). -.PP -Examples: -.)l sql/overview/form1/main.cpp and sql/overview/form2/main.cpp. -.SH "void QSqlForm::insert ( QWidget * widget, QSqlField * field )\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts a \fIwidget\fR, and the \fIfield\fR it is to be mapped to, into the form. -.SH "void QSqlForm::installPropertyMap ( QSqlPropertyMap * pmap )" -Installs a custom QSqlPropertyMap. This is useful if you plan to create your own custom editor widgets. -.PP -QSqlForm takes ownership of \fIpmap\fR, so \fIpmap\fR is deleted when QSqlForm goes out of scope. -.PP -See also QDataTable::installEditorFactory(). -.PP -Example: sql/overview/custom1/main.cpp. -.SH "void QSqlForm::readField ( QWidget * widget )\fC [virtual slot]\fR" -Updates the widget \fIwidget\fR with the value from the SQL field it is mapped to. Nothing happens if no SQL field is mapped to the \fIwidget\fR. -.SH "void QSqlForm::readFields ()\fC [virtual slot]\fR" -Updates the widgets in the form with current values from the SQL fields they are mapped to. -.PP -Examples: -.)l sql/overview/form1/main.cpp and sql/overview/form2/main.cpp. -.SH "void QSqlForm::remove ( QWidget * widget )\fC [virtual protected]\fR" -Removes a \fIwidget\fR, and hence the field it's mapped to, from the form. -.SH "void QSqlForm::remove ( const QString & field )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes \fIfield\fR from the form. -.SH "void QSqlForm::setRecord ( QSqlRecord * buf )\fC [virtual]\fR" -Sets \fIbuf\fR as the record buffer for the form. To force the display of the data from \fIbuf\fR, use readFields(). -.PP -See also readFields() and writeFields(). -.PP -Examples: -.)l sql/overview/custom1/main.cpp, sql/overview/form1/main.cpp, and sql/overview/form2/main.cpp. -.SH "QWidget * QSqlForm::widget ( uint i ) const" -Returns the \fIi\fR-th widget in the form. Useful for traversing the widgets in the form. -.SH "QSqlField * QSqlForm::widgetToField ( QWidget * widget ) const" -Returns the SQL field that widget \fIwidget\fR is mapped to. -.SH "void QSqlForm::writeField ( QWidget * widget )\fC [virtual slot]\fR" -Updates the SQL field with the value from the \fIwidget\fR it is mapped to. Nothing happens if no SQL field is mapped to the \fIwidget\fR. -.SH "void QSqlForm::writeFields ()\fC [virtual slot]\fR" -Updates the SQL fields with values from the widgets they are mapped to. To actually update the database with the contents of the record buffer, use QSqlCursor::insert(), QSqlCursor::update() or QSqlCursor::del() as appropriate. -.PP -Example: sql/overview/form2/main.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlform.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlform.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlindex.3qt b/doc/man/man3/qsqlindex.3qt deleted file mode 100644 index a9893b6bf..000000000 --- a/doc/man/man3/qsqlindex.3qt +++ /dev/null @@ -1,126 +0,0 @@ -'\" t -.TH QSqlIndex 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 -QSqlIndex \- Functions to manipulate and describe QSqlCursor and QSqlDatabase indexes -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QSqlRecord. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlIndex\fR ( const QString & cursorname = QString::null, const QString & name = QString::null )" -.br -.ti -1c -.BI "\fBQSqlIndex\fR ( const QSqlIndex & other )" -.br -.ti -1c -.BI "\fB~QSqlIndex\fR ()" -.br -.ti -1c -.BI "QSqlIndex & \fBoperator=\fR ( const QSqlIndex & other )" -.br -.ti -1c -.BI "virtual void \fBsetCursorName\fR ( const QString & cursorName )" -.br -.ti -1c -.BI "QString \fBcursorName\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetName\fR ( const QString & name )" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "virtual void \fBappend\fR ( const QSqlField & field )" -.br -.ti -1c -.BI "virtual void \fBappend\fR ( const QSqlField & field, bool desc )" -.br -.ti -1c -.BI "bool \fBisDescending\fR ( int i ) const" -.br -.ti -1c -.BI "virtual void \fBsetDescending\fR ( int i, bool desc )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QSqlIndex \fBfromStringList\fR ( const QStringList & l, const QSqlCursor * cursor )" -.br -.in -1c -.SH DESCRIPTION -The QSqlIndex class provides functions to manipulate and describe QSqlCursor and QSqlDatabase indexes. -.PP -This class is used to describe and manipulate QSqlCursor and QSqlDatabase indexes. An index refers to a single table or view in a database. Information about the fields that comprise the index can be used to generate SQL statements, or to affect the behavior of a QSqlCursor object. -.PP -Normally, QSqlIndex objects are created by QSqlDatabase or QSqlCursor. -.PP -See also Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlIndex::QSqlIndex ( const QString & cursorname = QString::null, const QString & name = QString::null )" -Constructs an empty index using the cursor name \fIcursorname\fR and index name \fIname\fR. -.SH "QSqlIndex::QSqlIndex ( const QSqlIndex & other )" -Constructs a copy of \fIother\fR. -.SH "QSqlIndex::~QSqlIndex ()" -Destroys the object and frees any allocated resources. -.SH "void QSqlIndex::append ( const QSqlField & field )\fC [virtual]\fR" -Appends the field \fIfield\fR to the list of indexed fields. The field is appended with an ascending sort order. -.PP -Reimplemented from QSqlRecord. -.SH "void QSqlIndex::append ( const QSqlField & field, bool desc )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends the field \fIfield\fR to the list of indexed fields. The field is appended with an ascending sort order, unless \fIdesc\fR is TRUE. -.SH "QString QSqlIndex::cursorName () const" -Returns the name of the cursor which the index is associated with. -.SH "QSqlIndex QSqlIndex::fromStringList ( const QStringList & l, const QSqlCursor * cursor )\fC [static]\fR" -Returns an index based on the field descriptions in \fIl\fR and the cursor \fIcursor\fR. The field descriptions should be in the same format that toStringList() produces, for example, a surname field in the people table might be in one of these forms: "surname"," surname DESC" or "people.surname ASC". -.PP -See also toStringList(). -.SH "bool QSqlIndex::isDescending ( int i ) const" -Returns TRUE if field \fIi\fR in the index is sorted in descending order; otherwise returns FALSE. -.SH "QString QSqlIndex::name () const" -Returns the name of the index. -.SH "QSqlIndex & QSqlIndex::operator= ( const QSqlIndex & other )" -Sets the index equal to \fIother\fR. -.SH "void QSqlIndex::setCursorName ( const QString & cursorName )\fC [virtual]\fR" -Sets the name of the cursor that the index is associated with to \fIcursorName\fR. -.SH "void QSqlIndex::setDescending ( int i, bool desc )\fC [virtual]\fR" -If \fIdesc\fR is TRUE, field \fIi\fR is sorted in descending order. Otherwise, field \fIi\fR is sorted in ascending order (the default). If the field does not exist, nothing happens. -.SH "void QSqlIndex::setName ( const QString & name )\fC [virtual]\fR" -Sets the name of the index to \fIname\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlindex.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlindex.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlpropertymap.3qt b/doc/man/man3/qsqlpropertymap.3qt deleted file mode 100644 index 3d0cbe34a..000000000 --- a/doc/man/man3/qsqlpropertymap.3qt +++ /dev/null @@ -1,172 +0,0 @@ -'\" t -.TH QSqlPropertyMap 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 -QSqlPropertyMap \- Used to map widgets to SQL fields -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlPropertyMap\fR ()" -.br -.ti -1c -.BI "virtual \fB~QSqlPropertyMap\fR ()" -.br -.ti -1c -.BI "QVariant \fBproperty\fR ( QWidget * widget )" -.br -.ti -1c -.BI "virtual void \fBsetProperty\fR ( QWidget * widget, const QVariant & value )" -.br -.ti -1c -.BI "void \fBinsert\fR ( const QString & classname, const QString & property )" -.br -.ti -1c -.BI "void \fBremove\fR ( const QString & classname )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QSqlPropertyMap * \fBdefaultMap\fR ()" -.br -.ti -1c -.BI "void \fBinstallDefaultMap\fR ( QSqlPropertyMap * map )" -.br -.in -1c -.SH DESCRIPTION -The QSqlPropertyMap class is used to map widgets to SQL fields. -.PP -The SQL module uses Qt object properties to insert and extract values from editor widgets. -.PP -This class is used to map editors to SQL fields. This works by associating SQL editor class names to the properties used to insert and extract values to/from the editor. -.PP -For example, a QLineEdit can be used to edit text strings and other data types in QDataTables or QSqlForms. Several properties are defined in QLineEdit, but only the \fItext\fR property is used to insert and extract text from a QLineEdit. Both QDataTable and QSqlForm use the global QSqlPropertyMap for inserting and extracting values to and from an editor widget. The global property map defines several common widgets and properties that are suitable for many applications. You can add and remove widget properties to suit your specific needs. -.PP -If you want to use custom editors with your QDataTable or QSqlForm, you must install your own QSqlPropertyMap for that table or form. Example: -.PP -.nf -.br - QSqlPropertyMap *myMap = new QSqlPropertyMap(); -.br - QSqlForm *myForm = new QSqlForm( this ); -.br - MyEditor myEditor( this ); -.br -.br - // Set the QSqlForm's record buffer to the update buffer of -.br - // a pre-existing QSqlCursor called 'cur'. -.br - myForm->setRecord( cur->primeUpdate() ); -.br -.br - // Install the customized map -.br - myMap->insert( "MyEditor", "content" ); -.br - myForm->installPropertyMap( myMap ); // myForm now owns myMap -.br - ... -.br - // Insert a field into the form that uses a myEditor to edit the -.br - // field 'somefield' -.br - myForm->insert( &myEditor, "somefield" ); -.br -.br - // Update myEditor with the value from the mapped database field -.br - myForm->readFields(); -.br - ... -.br - // Let the user edit the form -.br - ... -.br - // Update the database fields with the values in the form -.br - myForm->writeFields(); -.br - ... -.br -.fi -.PP -You can also replace the global QSqlPropertyMap that is used by default. (Bear in mind that QSqlPropertyMap takes ownership of the new default map.) -.PP -.nf -.br - QSqlPropertyMap *myMap = new QSqlPropertyMap; -.br -.br - myMap->insert( "MyEditor", "content" ); -.br - QSqlPropertyMap::installDefaultMap( myMap ); -.br - ... -.br -.fi -.PP -See also QDataTable, QSqlForm, QSqlEditorFactory, and Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlPropertyMap::QSqlPropertyMap ()" -Constructs a QSqlPropertyMap. -.PP -The default property mappings used by Qt widgets are:
                                                            .nf -.TS -l - l. Widgets Property QCheckBox, QRadioButton checked QComboBox, QListBox currentItem QDateEdit date QDateTimeEdit dateTime QTextBrowser source QButton, QDial, QLabel, QLineEdit, QMultiLineEdit, QPushButton, QTextEdit, text QTimeEdit time QLCDNumber, QScrollBar QSlider, QSpinBox -.TE -.fi -
                                                            -.SH "QSqlPropertyMap::~QSqlPropertyMap ()\fC [virtual]\fR" -Destroys the QSqlPropertyMap. -.PP -Note that if the QSqlPropertyMap is installed with installPropertyMap() the object it was installed into, e.g. the QSqlForm, takes ownership and will delete the QSqlPropertyMap when necessary. -.SH "QSqlPropertyMap * QSqlPropertyMap::defaultMap ()\fC [static]\fR" -Returns the application global QSqlPropertyMap. -.SH "void QSqlPropertyMap::insert ( const QString & classname, const QString & property )" -Insert a new classname/property pair, which is used for custom SQL field editors. There \fImust\fR be a \fCTQ_PROPERTY\fR clause in the \fIclassname\fR class declaration for the \fIproperty\fR. -.PP -Example: sql/overview/custom1/main.cpp. -.SH "void QSqlPropertyMap::installDefaultMap ( QSqlPropertyMap * map )\fC [static]\fR" -Replaces the global default property map with \fImap\fR. All QDataTable and QSqlForm instantiations will use this new map for inserting and extracting values to and from editors. \fIQSqlPropertyMap takes ownership of \a map, and destroys it when it is no longer needed.\fR -.SH "QVariant QSqlPropertyMap::property ( QWidget * widget )" -Returns the mapped property of \fIwidget\fR as a QVariant. -.SH "void QSqlPropertyMap::remove ( const QString & classname )" -Removes \fIclassname\fR from the map. -.SH "void QSqlPropertyMap::setProperty ( QWidget * widget, const QVariant & value )\fC [virtual]\fR" -Sets the property of \fIwidget\fR to \fIvalue\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlpropertymap.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlpropertymap.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlquery.3qt b/doc/man/man3/qsqlquery.3qt deleted file mode 100644 index 07b22894e..000000000 --- a/doc/man/man3/qsqlquery.3qt +++ /dev/null @@ -1,567 +0,0 @@ -'\" t -.TH QSqlQuery 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 -QSqlQuery \- Means of executing and manipulating SQL statements -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QSqlCursor. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlQuery\fR ( QSqlResult * r )" -.br -.ti -1c -.BI "\fBQSqlQuery\fR ( const QString & query = QString::null, QSqlDatabase * db = 0 )" -.br -.ti -1c -.BI "explicit \fBQSqlQuery\fR ( QSqlDatabase * db )" -.br -.ti -1c -.BI "\fBQSqlQuery\fR ( const QSqlQuery & other )" -.br -.ti -1c -.BI "QSqlQuery & \fBoperator=\fR ( const QSqlQuery & other )" -.br -.ti -1c -.BI "virtual \fB~QSqlQuery\fR ()" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBisActive\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR ( int field ) const" -.br -.ti -1c -.BI "int \fBat\fR () const" -.br -.ti -1c -.BI "QString \fBlastQuery\fR () const" -.br -.ti -1c -.BI "int \fBnumRowsAffected\fR () const" -.br -.ti -1c -.BI "QSqlError \fBlastError\fR () const" -.br -.ti -1c -.BI "bool \fBisSelect\fR () const" -.br -.ti -1c -.BI "int \fBsize\fR () const" -.br -.ti -1c -.BI "const QSqlDriver * \fBdriver\fR () const" -.br -.ti -1c -.BI "const QSqlResult * \fBresult\fR () const" -.br -.ti -1c -.BI "bool \fBisForwardOnly\fR () const" -.br -.ti -1c -.BI "void \fBsetForwardOnly\fR ( bool forward )" -.br -.ti -1c -.BI "virtual bool \fBexec\fR ( const QString & query )" -.br -.ti -1c -.BI "virtual QVariant \fBvalue\fR ( int i ) const" -.br -.ti -1c -.BI "virtual bool \fBseek\fR ( int i, bool relative = FALSE )" -.br -.ti -1c -.BI "virtual bool \fBnext\fR ()" -.br -.ti -1c -.BI "virtual bool \fBprev\fR ()" -.br -.ti -1c -.BI "virtual bool \fBfirst\fR ()" -.br -.ti -1c -.BI "virtual bool \fBlast\fR ()" -.br -.ti -1c -.BI "bool \fBexec\fR ()" -.br -.ti -1c -.BI "bool \fBprepare\fR ( const QString & query )" -.br -.ti -1c -.BI "void \fBbindValue\fR ( const QString & placeholder, const QVariant & val )" -.br -.ti -1c -.BI "void \fBbindValue\fR ( int pos, const QVariant & val )" -.br -.ti -1c -.BI "void \fBaddBindValue\fR ( const QVariant & val )" -.br -.ti -1c -.BI "void \fBbindValue\fR ( const QString & placeholder, const QVariant & val, QSql::ParameterType type )" -.br -.ti -1c -.BI "void \fBbindValue\fR ( int pos, const QVariant & val, QSql::ParameterType type )" -.br -.ti -1c -.BI "void \fBaddBindValue\fR ( const QVariant & val, QSql::ParameterType type )" -.br -.ti -1c -.BI "QVariant \fBboundValue\fR ( const QString & placeholder ) const" -.br -.ti -1c -.BI "QVariant \fBboundValue\fR ( int pos ) const" -.br -.ti -1c -.BI "QMap \fBboundValues\fR () const" -.br -.ti -1c -.BI "QString \fBexecutedQuery\fR () const" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBbeforeSeek\fR ()" -.br -.ti -1c -.BI "virtual void \fBafterSeek\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSqlQuery class provides a means of executing and manipulating SQL statements. -.PP -QSqlQuery encapsulates the functionality involved in creating, navigating and retrieving data from SQL queries which are executed on a QSqlDatabase. It can be used to execute DML (data manipulation language) statements, e.g. \fCSELECT\fR, \fCINSERT\fR, \fCUPDATE\fR and \fCDELETE\fR, and also DDL (data definition language) statements, e.g. \fCCREATE TABLE\fR. It can also be used to execute database-specific commands which are not standard SQL (e.g. \fCSET DATESTYLE=ISO\fR for PostgreSQL). -.PP -Successfully executed SQL statements set the query's state to active (isActive() returns TRUE); otherwise the query's state is set to inactive. In either case, when executing a new SQL statement, the query is positioned on an invalid record; an active query must be navigated to a valid record (so that isValid() returns TRUE) before values can be retrieved. -.PP -Navigating records is performed with the following functions: -.TP -next() -.TP -prev() -.TP -first() -.TP -last() -.TP -\fC\fRseek(int) -.PP -These functions allow the programmer to move forward, backward or arbitrarily through the records returned by the query. If you only need to move forward through the results, e.g. using next() or using seek() with a positive offset, you can use setForwardOnly() and save a significant amount of memory overhead. Once an active query is positioned on a valid record, data can be retrieved using value(). All data is transferred from the SQL backend using QVariants. -.PP -For example: -.PP -.nf -.br - QSqlQuery query( "SELECT name FROM customer" ); -.br - while ( query.next() ) { -.br - QString name = query.value(0).toString(); -.br - doSomething( name ); -.br - } -.br -.fi -.PP -To access the data returned by a query, use the value() method. Each field in the data returned by a SELECT statement is accessed by passing the field's position in the statement, starting from 0. Information about the fields can be obtained via QSqlDatabase::record(). For the sake of efficiency there are no functions to access a field by name. (The QSqlCursor class provides a higher-level interface with field access by name and automatic SQL generation.) -.PP -QSqlQuery supports prepared query execution and the binding of parameter values to placeholders. Some databases don't support these features, so for them Qt emulates the required functionality. For example, the Oracle and ODBC drivers have proper prepared query support, and Qt makes use of it; but for databases that don't have this support, Qt implements the feature itself, e.g. by replacing placeholders with actual values when a query is executed. The exception is positional binding using named placeholders, which requires that the database supports prepared queries. -.PP -Oracle databases identify placeholders by using a colon-name syntax, e.g \fC:name\fR. ODBC simply uses \fC?\fR characters. Qt supports both syntaxes (although you can't mix them in the same query). -.PP -Below we present the same example using each of the four different binding approaches. -.PP -\fBNamed binding using named placeholders\fR -.PP -.nf -.br - QSqlQuery query; -.br - query.prepare( "INSERT INTO atable (id, forename, surname) " -.br - "VALUES (:id, :forename, :surname)" ); -.br - query.bindValue( ":id", 1001 ); -.br - query.bindValue( ":forename", "Bart" ); -.br - query.bindValue( ":surname", "Simpson" ); -.br - query.exec(); -.br -.fi -.PP -\fBPositional binding using named placeholders\fR -.PP -.nf -.br - QSqlQuery query; -.br - query.prepare( "INSERT INTO atable (id, forename, surname) " -.br - "VALUES (:id, :forename, :surname)" ); -.br - query.bindValue( 0, 1001 ); -.br - query.bindValue( 1, "Bart" ); -.br - query.bindValue( 2, "Simpson" ); -.br - query.exec(); -.br -.fi -\fBNote:\fR Using positional binding with named placeholders will only work if the database supports prepared queries. This can be checked with QSqlDriver::hasFeature() using QSqlDriver::PreparedQueries as argument for driver feature. -.PP -\fBBinding values using positional placeholders #1\fR -.PP -.nf -.br - QSqlQuery query; -.br - query.prepare( "INSERT INTO atable (id, forename, surname) " -.br - "VALUES (?, ?, ?)" ); -.br - query.bindValue( 0, 1001 ); -.br - query.bindValue( 1, "Bart" ); -.br - query.bindValue( 2, "Simpson" ); -.br - query.exec(); -.br -.fi -.PP -\fBBinding values using positional placeholders #2\fR -.PP -.nf -.br - query.prepare( "INSERT INTO atable (id, forename, surname) " -.br - "VALUES (?, ?, ?)" ); -.br - query.addBindValue( 1001 ); -.br - query.addBindValue( "Bart" ); -.br - query.addBindValue( "Simpson" ); -.br - query.exec(); -.br -.fi -.PP -\fBBinding values to a stored procedure\fR This code calls a stored procedure called \fCAsciiToInt()\fR, passing it a character through its in parameter, and taking its result in the out parameter. -.PP -.nf -.br - QSqlQuery query; -.br - query.prepare( "call AsciiToInt(?, ?)" ); -.br - query.bindValue( 0, "A" ); -.br - query.bindValue( 1, 0, QSql::Out ); -.br - query.exec(); -.br - int i = query.boundValue( 1 ).toInt(); // i is 65. -.br -.fi -.PP -See also QSqlDatabase, QSqlCursor, QVariant, and Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlQuery::QSqlQuery ( QSqlResult * r )" -Creates a QSqlQuery object which uses the QSqlResult \fIr\fR to communicate with a database. -.SH "QSqlQuery::QSqlQuery ( const QString & query = QString::null, QSqlDatabase * db = 0 )" -Creates a QSqlQuery object using the SQL \fIquery\fR and the database \fIdb\fR. If \fIdb\fR is 0, (the default), the application's default database is used. If \fIquery\fR is not a null string, it will be executed. -.PP -See also QSqlDatabase. -.SH "explicit QSqlQuery::QSqlQuery ( QSqlDatabase * db )" -Creates a QSqlQuery object using the database \fIdb\fR. If \fIdb\fR is 0, the application's default database is used. -.PP -See also QSqlDatabase. -.SH "QSqlQuery::QSqlQuery ( const QSqlQuery & other )" -Constructs a copy of \fIother\fR. -.SH "QSqlQuery::~QSqlQuery ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "void QSqlQuery::addBindValue ( const QVariant & val, QSql::ParameterType type )" -Adds the value \fIval\fR to the list of values when using positional value binding. The order of the addBindValue() calls determines which placeholder a value will be bound to in the prepared query. If \fItype\fR is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call. -.PP -See also bindValue(), prepare(), and exec(). -.SH "void QSqlQuery::addBindValue ( const QVariant & val )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Binds the placeholder with type QSql::In. -.SH "void QSqlQuery::afterSeek ()\fC [virtual protected]\fR" -Protected virtual function called after the internal record pointer is moved to a new record. The default implementation does nothing. -.SH "int QSqlQuery::at () const" -Returns the current internal position of the query. The first record is at position zero. If the position is invalid, a QSql::Location will be returned indicating the invalid position. -.PP -See also prev(), next(), first(), last(), seek(), isActive(), and isValid(). -.PP -Example: sql/overview/navigating/main.cpp. -.SH "void QSqlQuery::beforeSeek ()\fC [virtual protected]\fR" -Protected virtual function called before the internal record pointer is moved to a new record. The default implementation does nothing. -.SH "void QSqlQuery::bindValue ( const QString & placeholder, const QVariant & val, QSql::ParameterType type )" -Set the placeholder \fIplaceholder\fR to be bound to value \fIval\fR in the prepared statement. Note that the placeholder mark (e.g \fC:\fR) must be included when specifying the placeholder name. If \fItype\fR is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call. -.PP -See also addBindValue(), prepare(), and exec(). -.SH "void QSqlQuery::bindValue ( const QString & placeholder, const QVariant & val )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Binds the placeholder with type QSql::In. -.SH "void QSqlQuery::bindValue ( int pos, const QVariant & val )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Binds the placeholder at position \fIpos\fR with type QSql::In. -.SH "void QSqlQuery::bindValue ( int pos, const QVariant & val, QSql::ParameterType type )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Set the placeholder in position \fIpos\fR to be bound to value \fIval\fR in the prepared statement. Field numbering starts at 0. If \fItype\fR is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call. -.PP -See also addBindValue(), prepare(), and exec(). -.SH "QVariant QSqlQuery::boundValue ( const QString & placeholder ) const" -Returns the value for the \fIplaceholder\fR. -.SH "QVariant QSqlQuery::boundValue ( int pos ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the value for the placeholder at position \fIpos\fR. -.SH "QMap QSqlQuery::boundValues () const" -Returns a map of the bound values. -.PP -The bound values can be examined in the following way: -.PP -.nf -.br - QSqlQuery query; -.br - ... -.br - // Examine the bound values - bound using named binding -.br - QMap::ConstIterator it; -.br - QMap vals = query.boundValues(); -.br - for ( it = vals.begin(); it != vals.end(); ++it ) -.br - tqWarning( "Placeholder: " + it.key() + ", Value: " + (*it).toString() ); -.br - ... -.br -.br - // Examine the bound values - bound using positional binding -.br - QValueList::ConstIterator it; -.br - QValueList list = query.boundValues().values(); -.br - int i = 0; -.br - for ( it = list.begin(); it != list.end(); ++it ) -.br - tqWarning( "Placeholder pos: %d, Value: " + (*it).toString(), i++ ); -.br - ... -.br -.br -.fi -.SH "const QSqlDriver * QSqlQuery::driver () const" -Returns the database driver associated with the query. -.SH "bool QSqlQuery::exec ( const QString & query )\fC [virtual]\fR" -Executes the SQL in \fIquery\fR. Returns TRUE and sets the query state to active if the query was successful; otherwise returns FALSE and sets the query state to inactive. The \fIquery\fR string must use syntax appropriate for the SQL database being queried, for example, standard SQL. -.PP -After the query is executed, the query is positioned on an \fIinvalid\fR record, and must be navigated to a valid record before data values can be retrieved, e.g. using next(). -.PP -Note that the last error for this query is reset when exec() is called. -.PP -See also isActive(), isValid(), next(), prev(), first(), last(), and seek(). -.PP -Examples: -.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/basicdatamanip/main.cpp, and sql/overview/connection.cpp. -.SH "bool QSqlQuery::exec ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Executes a previously prepared SQL query. Returns TRUE if the query executed successfully; otherwise returns FALSE. -.PP -See also prepare(), bindValue(), and addBindValue(). -.SH "QString QSqlQuery::executedQuery () const" -Returns the last query that was executed. -.PP -In most cases this function returns the same as lastQuery(). If a prepared query with placeholders is executed on a DBMS that does not support it, the preparation of this query is emulated. The placeholders in the original query are replaced with their bound values to form a new query. This function returns the modified query. Useful for debugging purposes. -.PP -See also lastQuery(). -.SH "bool QSqlQuery::first ()\fC [virtual]\fR" -Retrieves the first record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. Returns TRUE if successful. If unsuccessful the query position is set to an invalid position and FALSE is returned. -.PP -See also next(), prev(), last(), seek(), at(), isActive(), and isValid(). -.PP -Example: sql/overview/navigating/main.cpp. -.SH "bool QSqlQuery::isActive () const" -Returns TRUE if the query is currently active; otherwise returns FALSE. -.PP -Examples: -.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/basicdatamanip/main.cpp, sql/overview/navigating/main.cpp, and sql/overview/retrieve1/main.cpp. -.SH "bool QSqlQuery::isForwardOnly () const" -Returns TRUE if you can only scroll \fIforward\fR through a result set; otherwise returns FALSE. -.PP -See also setForwardOnly(). -.SH "bool QSqlQuery::isNull ( int field ) const" -Returns TRUE if the query is active and positioned on a valid record and the \fIfield\fR is NULL; otherwise returns FALSE. Note that for some drivers isNull() will not return accurate information until after an attempt is made to retrieve data. -.PP -See also isActive(), isValid(), and value(). -.SH "bool QSqlQuery::isSelect () const" -Returns TRUE if the current query is a \fCSELECT\fR statement; otherwise returns FALSE. -.SH "bool QSqlQuery::isValid () const" -Returns TRUE if the query is currently positioned on a valid record; otherwise returns FALSE. -.SH "bool QSqlQuery::last ()\fC [virtual]\fR" -Retrieves the last record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. Returns TRUE if successful. If unsuccessful the query position is set to an invalid position and FALSE is returned. -.PP -See also next(), prev(), first(), seek(), at(), isActive(), and isValid(). -.PP -Example: sql/overview/navigating/main.cpp. -.SH "QSqlError QSqlQuery::lastError () const" -Returns error information about the last error (if any) that occurred. -.PP -See also QSqlError. -.SH "QString QSqlQuery::lastQuery () const" -Returns the text of the current query being used, or QString::null if there is no current query text. -.PP -See also executedQuery(). -.SH "bool QSqlQuery::next ()\fC [virtual]\fR" -Retrieves the next record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. -.PP -The following rules apply: -.TP -If the result is currently located before the first record, e.g. immediately after a query is executed, an attempt is made to retrieve the first record. -.IP -.TP -If the result is currently located after the last record, there is no change and FALSE is returned. -.IP -.TP -If the result is located somewhere in the middle, an attempt is made to retrieve the next record. -.PP -If the record could not be retrieved, the result is positioned after the last record and FALSE is returned. If the record is successfully retrieved, TRUE is returned. -.PP -See also prev(), first(), last(), seek(), at(), isActive(), and isValid(). -.PP -Examples: -.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/delete/main.cpp, sql/overview/order1/main.cpp, sql/overview/retrieve1/main.cpp, sql/overview/subclass4/main.cpp, and sql/overview/subclass5/main.cpp. -.SH "int QSqlQuery::numRowsAffected () const" -Returns the number of rows affected by the result's SQL statement, or -1 if it cannot be determined. Note that for \fCSELECT\fR statements, the value is undefined; see size() instead. If the query is not active (isActive() returns FALSE), -1 is returned. -.PP -See also size() and QSqlDriver::hasFeature(). -.PP -Examples: -.)l sql/overview/basicbrowsing2/main.cpp and sql/overview/basicdatamanip/main.cpp. -.SH "QSqlQuery & QSqlQuery::operator= ( const QSqlQuery & other )" -Assigns \fIother\fR to the query. -.SH "bool QSqlQuery::prepare ( const QString & query )" -Prepares the SQL query \fIquery\fR for execution. The query may contain placeholders for binding values. Both Oracle style colon-name (e.g. \fC:surname\fR), and ODBC style (e.g. \fC?\fR) placeholders are supported; but they cannot be mixed in the same query. See the Description for examples. -.PP -See also exec(), bindValue(), and addBindValue(). -.SH "bool QSqlQuery::prev ()\fC [virtual]\fR" -Retrieves the previous record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. -.PP -The following rules apply: -.TP -If the result is currently located before the first record, there is no change and FALSE is returned. -.IP -.TP -If the result is currently located after the last record, an attempt is made to retrieve the last record. -.IP -.TP -If the result is somewhere in the middle, an attempt is made to retrieve the previous record. -.PP -If the record could not be retrieved, the result is positioned before the first record and FALSE is returned. If the record is successfully retrieved, TRUE is returned. -.PP -See also next(), first(), last(), seek(), at(), isActive(), and isValid(). -.SH "const QSqlResult * QSqlQuery::result () const" -Returns the result associated with the query. -.SH "bool QSqlQuery::seek ( int i, bool relative = FALSE )\fC [virtual]\fR" -Retrieves the record at position (offset) \fIi\fR, if available, and positions the query on the retrieved record. The first record is at position 0. Note that the query must be in an active state and isSelect() must return TRUE before calling this function. -.PP -If \fIrelative\fR is FALSE (the default), the following rules apply: -.TP -If \fIi\fR is negative, the result is positioned before the first record and FALSE is returned. -.TP -Otherwise, an attempt is made to move to the record at position \fIi\fR. If the record at position \fIi\fR could not be retrieved, the result is positioned after the last record and FALSE is returned. If the record is successfully retrieved, TRUE is returned. -.PP -If \fIrelative\fR is TRUE, the following rules apply: -.TP -If the result is currently positioned before the first record or on the first record, and \fIi\fR is negative, there is no change, and FALSE is returned. -.TP -If the result is currently located after the last record, and \fIi\fR is positive, there is no change, and FALSE is returned. -.TP -If the result is currently located somewhere in the middle, and the relative offset \fIi\fR moves the result below zero, the result is positioned before the first record and FALSE is returned. -.TP -Otherwise, an attempt is made to move to the record \fIi\fR records ahead of the current record (or \fIi\fR records behind the current record if \fIi\fR is negative). If the record at offset \fIi\fR could not be retrieved, the result is positioned after the last record if \fIi\fR >= 0, (or before the first record if \fIi\fR is negative), and FALSE is returned. If the record is successfully retrieved, TRUE is returned. -.PP -See also next(), prev(), first(), last(), at(), isActive(), and isValid(). -.PP -Example: sql/overview/navigating/main.cpp. -.SH "void QSqlQuery::setForwardOnly ( bool forward )" -Sets forward only mode to \fIforward\fR. If forward is TRUE only next(), and seek() with positive values, are allowed for navigating the results. Forward only mode needs far less memory since results do not need to be cached. -.PP -Forward only mode is off by default. -.PP -Forward only mode cannot be used with data aware widgets like QDataTable, since they must to be able to scroll backward as well as forward. -.PP -See also isForwardOnly(), next(), and seek(). -.SH "int QSqlQuery::size () const" -Returns the size of the result, (number of rows returned), or -1 if the size cannot be determined or if the database does not support reporting information about query sizes. Note that for non-\fCSELECT\fR statements (isSelect() returns FALSE), size() will return -1. If the query is not active (isActive() returns FALSE), -1 is returned. -.PP -To determine the number of rows affected by a non-SELECT statement, use numRowsAffected(). -.PP -See also isActive(), numRowsAffected(), and QSqlDriver::hasFeature(). -.PP -Example: sql/overview/navigating/main.cpp. -.SH "QVariant QSqlQuery::value ( int i ) const\fC [virtual]\fR" -Returns the value of the \fIi\fR-th field in the query (zero based). -.PP -The fields are numbered from left to right using the text of the \fCSELECT\fR statement, e.g. in \fCSELECT forename, surname FROM people\fR, field 0 is \fCforename\fR and field 1 is \fCsurname\fR. Using \fCSELECT *\fR is not recommended because the order of the fields in the query is undefined. -.PP -An invalid QVariant is returned if field \fIi\fR does not exist, if the query is inactive, or if the query is positioned on an invalid record. -.PP -See also prev(), next(), first(), last(), seek(), isActive(), and isValid(). -.PP -Examples: -.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/retrieve1/main.cpp, sql/overview/subclass3/main.cpp, sql/overview/subclass4/main.cpp, sql/overview/subclass5/main.cpp, and sql/overview/table4/main.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlquery.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlquery.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlrecord.3qt b/doc/man/man3/qsqlrecord.3qt deleted file mode 100644 index 2dfed667f..000000000 --- a/doc/man/man3/qsqlrecord.3qt +++ /dev/null @@ -1,268 +0,0 @@ -'\" t -.TH QSqlRecord 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 -QSqlRecord \- Encapsulates a database record, i.e. a set of database fields -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QSqlCursor and QSqlIndex. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlRecord\fR ()" -.br -.ti -1c -.BI "\fBQSqlRecord\fR ( const QSqlRecord & other )" -.br -.ti -1c -.BI "QSqlRecord & \fBoperator=\fR ( const QSqlRecord & other )" -.br -.ti -1c -.BI "virtual \fB~QSqlRecord\fR ()" -.br -.ti -1c -.BI "virtual QVariant \fBvalue\fR ( int i ) const" -.br -.ti -1c -.BI "virtual QVariant \fBvalue\fR ( const QString & name ) const" -.br -.ti -1c -.BI "virtual void \fBsetValue\fR ( int i, const QVariant & val )" -.br -.ti -1c -.BI "virtual void \fBsetValue\fR ( const QString & name, const QVariant & val )" -.br -.ti -1c -.BI "bool \fBisGenerated\fR ( int i ) const" -.br -.ti -1c -.BI "bool \fBisGenerated\fR ( const QString & name ) const" -.br -.ti -1c -.BI "virtual void \fBsetGenerated\fR ( const QString & name, bool generated )" -.br -.ti -1c -.BI "virtual void \fBsetGenerated\fR ( int i, bool generated )" -.br -.ti -1c -.BI "virtual void \fBsetNull\fR ( int i )" -.br -.ti -1c -.BI "virtual void \fBsetNull\fR ( const QString & name )" -.br -.ti -1c -.BI "bool \fBisNull\fR ( int i ) const" -.br -.ti -1c -.BI "bool \fBisNull\fR ( const QString & name ) const" -.br -.ti -1c -.BI "int \fBposition\fR ( const QString & name ) const" -.br -.ti -1c -.BI "QString \fBfieldName\fR ( int i ) const" -.br -.ti -1c -.BI "QSqlField * \fBfield\fR ( int i )" -.br -.ti -1c -.BI "QSqlField * \fBfield\fR ( const QString & name )" -.br -.ti -1c -.BI "const QSqlField * \fBfield\fR ( int i ) const" -.br -.ti -1c -.BI "const QSqlField * \fBfield\fR ( const QString & name ) const" -.br -.ti -1c -.BI "virtual void \fBappend\fR ( const QSqlField & field )" -.br -.ti -1c -.BI "virtual void \fBinsert\fR ( int pos, const QSqlField & field )" -.br -.ti -1c -.BI "virtual void \fBremove\fR ( int pos )" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const QString & name ) const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBclearValues\fR ( bool nullify = FALSE )" -.br -.ti -1c -.BI "uint \fBcount\fR () const" -.br -.ti -1c -.BI "virtual QString \fBtoString\fR ( const QString & prefix = QString::null, const QString & sep = "","" ) const" -.br -.ti -1c -.BI "virtual QStringList \fBtoStringList\fR ( const QString & prefix = QString::null ) const" -.br -.in -1c -.SH DESCRIPTION -The QSqlRecord class encapsulates a database record, i.e. a set of database fields. -.PP -The QSqlRecord class encapsulates the functionality and characteristics of a database record (usually a table or view within the database). QSqlRecords support adding and removing fields as well as setting and retrieving field values. -.PP -QSqlRecord is implicitly shared. This means you can make copies of the record in time O(1). If multiple QSqlRecord instances share the same data and one is modifying the record's data then this modifying instance makes a copy and modifies its private copy - thus it does not affect other instances. -.PP -See also QSqlRecordInfo and Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlRecord::QSqlRecord ()" -Constructs an empty record. -.SH "QSqlRecord::QSqlRecord ( const QSqlRecord & other )" -Constructs a copy of \fIother\fR. -.SH "QSqlRecord::~QSqlRecord ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "void QSqlRecord::append ( const QSqlField & field )\fC [virtual]\fR" -Append a copy of field \fIfield\fR to the end of the record. -.PP -Reimplemented in QSqlIndex. -.SH "void QSqlRecord::clear ()\fC [virtual]\fR" -Removes all the record's fields. -.PP -See also clearValues(). -.PP -Reimplemented in QSqlCursor. -.SH "void QSqlRecord::clearValues ( bool nullify = FALSE )\fC [virtual]\fR" -Clears the value of all fields in the record. If \fInullify\fR is TRUE, (the default is FALSE), each field is set to NULL. -.SH "bool QSqlRecord::contains ( const QString & name ) const" -Returns TRUE if there is a field in the record called \fIname\fR; otherwise returns FALSE. -.SH "uint QSqlRecord::count () const" -Returns the number of fields in the record. -.SH "QSqlField * QSqlRecord::field ( int i )" -Returns the field at position \fIi\fR within the record, or 0 if it cannot be found. -.SH "QSqlField * QSqlRecord::field ( const QString & name )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the field called \fIname\fR within the record, or 0 if it cannot be found. Field names are not case-sensitive. -.SH "const QSqlField * QSqlRecord::field ( int i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "const QSqlField * QSqlRecord::field ( const QString & name ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the field called \fIname\fR within the record, or 0 if it cannot be found. Field names are not case-sensitive. -.SH "QString QSqlRecord::fieldName ( int i ) const" -Returns the name of the field at position \fIi\fR. If the field does not exist, QString::null is returned. -.SH "void QSqlRecord::insert ( int pos, const QSqlField & field )\fC [virtual]\fR" -Insert a copy of \fIfield\fR at position \fIpos\fR. If a field already exists at \fIpos\fR, it is removed. -.SH "bool QSqlRecord::isEmpty () const" -Returns TRUE if there are no fields in the record; otherwise returns FALSE. -.SH "bool QSqlRecord::isGenerated ( const QString & name ) const" -Returns TRUE if the record has a field called \fIname\fR and this field is to be generated (the default); otherwise returns FALSE. -.PP -See also setGenerated(). -.SH "bool QSqlRecord::isGenerated ( int i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the record has a field at position \fIi\fR and this field is to be generated (the default); otherwise returns FALSE. -.PP -See also setGenerated(). -.SH "bool QSqlRecord::isNull ( const QString & name ) const" -Returns TRUE if the field called \fIname\fR is NULL or if there is no field called \fIname\fR; otherwise returns FALSE. -.PP -See also position(). -.SH "bool QSqlRecord::isNull ( int i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the field \fIi\fR is NULL or if there is no field at position \fIi\fR; otherwise returns FALSE. -.PP -See also fieldName(). -.SH "QSqlRecord & QSqlRecord::operator= ( const QSqlRecord & other )" -Sets the record equal to \fIother\fR. -.SH "int QSqlRecord::position ( const QString & name ) const" -Returns the position of the field called \fIname\fR within the record, or -1 if it cannot be found. Field names are not case-sensitive. If more than one field matches, the first one is returned. -.SH "void QSqlRecord::remove ( int pos )\fC [virtual]\fR" -Removes the field at \fIpos\fR. If \fIpos\fR does not exist, nothing happens. -.PP -Reimplemented in QSqlCursor. -.SH "void QSqlRecord::setGenerated ( const QString & name, bool generated )\fC [virtual]\fR" -Sets the generated flag for the field called \fIname\fR to \fIgenerated\fR. If the field does not exist, nothing happens. Only fields that have \fIgenerated\fR set to TRUE are included in the SQL that is generated, e.g. by QSqlCursor. -.PP -See also isGenerated(). -.PP -Reimplemented in QSqlCursor. -.SH "void QSqlRecord::setGenerated ( int i, bool generated )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the generated flag for the field \fIi\fR to \fIgenerated\fR. -.PP -See also isGenerated(). -.PP -Reimplemented in QSqlCursor. -.SH "void QSqlRecord::setNull ( int i )\fC [virtual]\fR" -Sets the value of field \fIi\fR to NULL. If the field does not exist, nothing happens. -.SH "void QSqlRecord::setNull ( const QString & name )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the value of the field called \fIname\fR to NULL. If the field does not exist, nothing happens. -.SH "void QSqlRecord::setValue ( int i, const QVariant & val )\fC [virtual]\fR" -Sets the value of the field at position \fIi\fR to \fIval\fR. If the field does not exist, nothing happens. -.PP -Examples: -.)l sql/overview/insert/main.cpp, sql/overview/insert2/main.cpp, sql/overview/subclass5/main.cpp, sql/overview/update/main.cpp, and sql/sqltable/main.cpp. -.SH "void QSqlRecord::setValue ( const QString & name, const QVariant & val )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the value of the field called \fIname\fR to \fIval\fR. If the field does not exist, nothing happens. -.SH "QString QSqlRecord::toString ( const QString & prefix = QString::null, const QString & sep = "," ) const\fC [virtual]\fR" -Returns a list of all the record's field names as a string separated by \fIsep\fR. -.PP -Note that fields which are not generated are \fInot\fR included (see isGenerated()). The returned string is suitable, for example, for generating SQL SELECT statements. If a \fIprefix\fR is specified, e.g. a table name, all fields are prefixed in the form: -.PP" -\fIprefix\fR." -.SH "QStringList QSqlRecord::toStringList ( const QString & prefix = QString::null ) const\fC [virtual]\fR" -Returns a list of all the record's field names, each having the prefix \fIprefix\fR. -.PP -Note that fields which have generated set to FALSE are \fInot\fR included. (See isGenerated()). If \fIprefix\fR is supplied, e.g. a table name, all fields are prefixed in the form: -.PP" -\fIprefix\fR." -.SH "QVariant QSqlRecord::value ( int i ) const\fC [virtual]\fR" -Returns the value of the field located at position \fIi\fR in the record. If field \fIi\fR does not exist the resultant behaviour is undefined. -.PP -This function should be used with QSqlQuerys. When working with a QSqlCursor the value(const QString&) overload which uses field names is more appropriate. -.PP -Example: sql/overview/update/main.cpp. -.SH "QVariant QSqlRecord::value ( const QString & name ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the value of the field called \fIname\fR in the record. If -field \fIname\fR does not exist the resultant behaviour is undefined. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlrecord.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlrecord.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlrecordinfo.3qt b/doc/man/man3/qsqlrecordinfo.3qt deleted file mode 100644 index d6a6f8b4a..000000000 --- a/doc/man/man3/qsqlrecordinfo.3qt +++ /dev/null @@ -1,79 +0,0 @@ -'\" t -.TH QSqlRecordInfo 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 -QSqlRecordInfo \- Encapsulates a set of database field meta data -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlRecordInfo\fR ()" -.br -.ti -1c -.BI "\fBQSqlRecordInfo\fR ( const QSqlFieldInfoList & other )" -.br -.ti -1c -.BI "\fBQSqlRecordInfo\fR ( const QSqlRecord & other )" -.br -.ti -1c -.BI "size_type \fBcontains\fR ( const QString & fieldName ) const" -.br -.ti -1c -.BI "QSqlFieldInfo \fBfind\fR ( const QString & fieldName ) const" -.br -.ti -1c -.BI "QSqlRecord \fBtoRecord\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QSqlRecordInfo class encapsulates a set of database field meta data. -.PP -This class is a QValueList that holds a set of database field meta data. Use contains() to see if a given field name exists in the record, and use find() to get a QSqlFieldInfo record for a named field. -.PP -See also QValueList, QSqlFieldInfo, and Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlRecordInfo::QSqlRecordInfo ()" -Constructs an empty record info object -.SH "QSqlRecordInfo::QSqlRecordInfo ( const QSqlFieldInfoList & other )" -Constructs a copy of \fIother\fR. -.SH "QSqlRecordInfo::QSqlRecordInfo ( const QSqlRecord & other )" -Constructs a QSqlRecordInfo object based on the fields in the QSqlRecord \fIother\fR. -.SH "size_type QSqlRecordInfo::contains ( const QString & fieldName ) const" -Returns the number of times a field called \fIfieldName\fR occurs in the record. Returns 0 if no field by that name could be found. -.SH "QSqlFieldInfo QSqlRecordInfo::find ( const QString & fieldName ) const" -Returns a QSqlFieldInfo object for the first field in the record which has the field name \fIfieldName\fR. If no matching field is found then an empty QSqlFieldInfo object is returned. -.SH "QSqlRecord QSqlRecordInfo::toRecord () const" -Returns an empty QSqlRecord based on the field information -in this QSqlRecordInfo. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qsqlrecordinfo.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlrecordinfo.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlresult.3qt b/doc/man/man3/qsqlresult.3qt deleted file mode 100644 index e8f41b5cf..000000000 --- a/doc/man/man3/qsqlresult.3qt +++ /dev/null @@ -1,189 +0,0 @@ -'\" t -.TH QSqlResult 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 -QSqlResult \- Abstract interface for accessing data from SQL databases -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QSqlResult\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQSqlResult\fR ( const QSqlDriver * db )" -.br -.ti -1c -.BI "int \fBat\fR () const" -.br -.ti -1c -.BI "QString \fBlastQuery\fR () const" -.br -.ti -1c -.BI "QSqlError \fBlastError\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBisActive\fR () const" -.br -.ti -1c -.BI "bool \fBisSelect\fR () const" -.br -.ti -1c -.BI "bool \fBisForwardOnly\fR () const" -.br -.ti -1c -.BI "const QSqlDriver * \fBdriver\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAt\fR ( int at )" -.br -.ti -1c -.BI "virtual void \fBsetActive\fR ( bool a )" -.br -.ti -1c -.BI "virtual void \fBsetLastError\fR ( const QSqlError & e )" -.br -.ti -1c -.BI "virtual void \fBsetQuery\fR ( const QString & query )" -.br -.ti -1c -.BI "virtual void \fBsetSelect\fR ( bool s )" -.br -.ti -1c -.BI "virtual void \fBsetForwardOnly\fR ( bool forward )" -.br -.ti -1c -.BI "virtual QVariant \fBdata\fR ( int i ) = 0" -.br -.ti -1c -.BI "virtual bool \fBisNull\fR ( int i ) = 0" -.br -.ti -1c -.BI "virtual bool \fBreset\fR ( const QString & query ) = 0" -.br -.ti -1c -.BI "virtual bool \fBfetch\fR ( int i ) = 0" -.br -.ti -1c -.BI "virtual bool \fBfetchNext\fR ()" -.br -.ti -1c -.BI "virtual bool \fBfetchPrev\fR ()" -.br -.ti -1c -.BI "virtual bool \fBfetchFirst\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBfetchLast\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBsize\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBnumRowsAffected\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QSqlResult class provides an abstract interface for accessing data from SQL databases. -.PP -Normally you would use QSqlQuery instead of QSqlResult since QSqlQuery provides a generic wrapper for database-specific implementations of QSqlResult. -.PP -See also QSql and Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlResult::QSqlResult ( const QSqlDriver * db )\fC [protected]\fR" -Protected constructor which creates a QSqlResult using database \fIdb\fR. The object is initialized to an inactive state. -.SH "QSqlResult::~QSqlResult ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "int QSqlResult::at () const\fC [protected]\fR" -Returns the current (zero-based) position of the result. -.SH "QVariant QSqlResult::data ( int i )\fC [pure virtual protected]\fR" -Returns the data for field \fIi\fR (zero-based) as a QVariant. This function is only called if the result is in an active state and is positioned on a valid record and \fIi\fR is non-negative. Derived classes must reimplement this function and return the value of field \fIi\fR, or QVariant() if it cannot be determined. -.SH "const QSqlDriver * QSqlResult::driver () const\fC [protected]\fR" -Returns the driver associated with the result. -.SH "bool QSqlResult::fetch ( int i )\fC [pure virtual protected]\fR" -Positions the result to an arbitrary (zero-based) index \fIi\fR. This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the index \fIi\fR, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. -.SH "bool QSqlResult::fetchFirst ()\fC [pure virtual protected]\fR" -Positions the result to the first record in the result. This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the first record, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. -.SH "bool QSqlResult::fetchLast ()\fC [pure virtual protected]\fR" -Positions the result to the last record in the result. This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the last record, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. -.SH "bool QSqlResult::fetchNext ()\fC [virtual protected]\fR" -Positions the result to the next available record in the result. This function is only called if the result is in an active state. The default implementation calls fetch() with the next index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. -.SH "bool QSqlResult::fetchPrev ()\fC [virtual protected]\fR" -Positions the result to the previous available record in the result. This function is only called if the result is in an active state. The default implementation calls fetch() with the previous index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. -.SH "bool QSqlResult::isActive () const\fC [protected]\fR" -Returns TRUE if the result has records to be retrieved; otherwise returns FALSE. -.SH "bool QSqlResult::isForwardOnly () const\fC [protected]\fR" -Returns TRUE if you can only scroll forward through a result set; otherwise returns FALSE. -.SH "bool QSqlResult::isNull ( int i )\fC [pure virtual protected]\fR" -Returns TRUE if the field at position \fIi\fR is NULL; otherwise returns FALSE. -.SH "bool QSqlResult::isSelect () const\fC [protected]\fR" -Returns TRUE if the current result is from a SELECT statement; otherwise returns FALSE. -.SH "bool QSqlResult::isValid () const\fC [protected]\fR" -Returns TRUE if the result is positioned on a valid record (that is, the result is not positioned before the first or after the last record); otherwise returns FALSE. -.SH "QSqlError QSqlResult::lastError () const\fC [protected]\fR" -Returns the last error associated with the result. -.SH "QString QSqlResult::lastQuery () const\fC [protected]\fR" -Returns the current SQL query text, or QString::null if there is none. -.SH "int QSqlResult::numRowsAffected ()\fC [pure virtual protected]\fR" -Returns the number of rows affected by the last query executed. -.SH "bool QSqlResult::reset ( const QString & query )\fC [pure virtual protected]\fR" -Sets the result to use the SQL statement \fIquery\fR for subsequent data retrieval. Derived classes must reimplement this function and apply the \fIquery\fR to the database. This function is called only after the result is set to an inactive state and is positioned before the first record of the new result. Derived classes should return TRUE if the query was successful and ready to be used, or FALSE otherwise. -.SH "void QSqlResult::setActive ( bool a )\fC [virtual protected]\fR" -Protected function provided for derived classes to set the internal active state to the value of \fIa\fR. -.PP -See also isActive(). -.SH "void QSqlResult::setAt ( int at )\fC [virtual protected]\fR" -Protected function provided for derived classes to set the internal (zero-based) result index to \fIat\fR. -.PP -See also at(). -.SH "void QSqlResult::setForwardOnly ( bool forward )\fC [virtual protected]\fR" -Sets forward only mode to \fIforward\fR. If forward is TRUE only fetchNext() is allowed for navigating the results. Forward only mode needs far less memory since results do not have to be cached. forward only mode is off by default. -.PP -See also fetchNext(). -.SH "void QSqlResult::setLastError ( const QSqlError & e )\fC [virtual protected]\fR" -Protected function provided for derived classes to set the last error to the value of \fIe\fR. -.PP -See also lastError(). -.SH "void QSqlResult::setQuery ( const QString & query )\fC [virtual protected]\fR" -Sets the current query for the result to \fIquery\fR. The result must be reset() in order to execute the query on the database. -.SH "void QSqlResult::setSelect ( bool s )\fC [virtual protected]\fR" -Protected function provided for derived classes to indicate whether or not the current statement is a SQL SELECT statement. The \fIs\fR parameter should be TRUE if the statement is a SELECT statement, or FALSE otherwise. -.SH "int QSqlResult::size ()\fC [pure virtual protected]\fR" -Returns the size of the result or -1 if it cannot be determined. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlresult.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlresult.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsqlselectcursor.3qt b/doc/man/man3/qsqlselectcursor.3qt deleted file mode 100644 index d5e50e0ad..000000000 --- a/doc/man/man3/qsqlselectcursor.3qt +++ /dev/null @@ -1,91 +0,0 @@ -'\" t -.TH QSqlSelectCursor 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 -QSqlSelectCursor \- Browsing of general SQL SELECT statements -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QSqlCursor. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSqlSelectCursor\fR ( const QString & query = QString::null, QSqlDatabase * db = 0 )" -.br -.ti -1c -.BI "\fBQSqlSelectCursor\fR ( const QSqlSelectCursor & other )" -.br -.ti -1c -.BI "\fB~QSqlSelectCursor\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QSqlSelectCursor class provides browsing of general SQL SELECT statements. -.PP -QSqlSelectCursor is a convenience class that makes it possible to display result sets from general SQL \fCSELECT\fR statements in data-aware Qt widgets. QSqlSelectCursor is read-only and does not support \fCINSERT\fR, \fCUPDATE\fR or \fCDELETE\fR operations. -.PP -Pass the query in at construction time, or use the QSqlSelectCursor::exec() function. -.PP -Example: -.PP -.nf -.br - ... -.br - QSqlSelectCursor* cur = new QSqlSelectCursor( "SELECT id, firstname, lastname FROM author" ); -.br - QDataTable* table = new QDataTable( this ); -.br - table->setSqlCursor( cur, TRUE, TRUE ); -.br - table->refresh(); -.br - ... -.br - cur->exec( "SELECT * FROM books" ); -.br - table->refresh(); -.br - ... -.br -.fi -.PP -See also Database Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSqlSelectCursor::QSqlSelectCursor ( const QString & query = QString::null, QSqlDatabase * db = 0 )" -Constructs a read only cursor on database \fIdb\fR using the query \fIquery\fR. -.SH "QSqlSelectCursor::QSqlSelectCursor ( const QSqlSelectCursor & other )" -Constructs a copy of \fIother\fR -.SH "QSqlSelectCursor::~QSqlSelectCursor ()" -Destroys the object and frees any allocated resources - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsqlselectcursor.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsqlselectcursor.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstatusbar.3qt b/doc/man/man3/qstatusbar.3qt deleted file mode 100644 index e24a1e912..000000000 --- a/doc/man/man3/qstatusbar.3qt +++ /dev/null @@ -1,209 +0,0 @@ -'\" t -.TH QStatusBar 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 -QStatusBar \- Horizontal bar suitable for presenting status information -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStatusBar\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QStatusBar\fR ()" -.br -.ti -1c -.BI "virtual void \fBaddWidget\fR ( QWidget * widget, int stretch = 0, bool permanent = FALSE )" -.br -.ti -1c -.BI "virtual void \fBremoveWidget\fR ( QWidget * widget )" -.br -.ti -1c -.BI "void \fBsetSizeGripEnabled\fR ( bool )" -.br -.ti -1c -.BI "bool \fBisSizeGripEnabled\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBmessage\fR ( const QString & message )" -.br -.ti -1c -.BI "void \fBmessage\fR ( const QString & message, int ms )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBmessageChanged\fR ( const QString & message )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBsizeGripEnabled\fR - whether the QSizeGrip in the bottom right of the status bar is enabled" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" -.br -.ti -1c -.BI "void \fBreformat\fR ()" -.br -.ti -1c -.BI "void \fBhideOrShow\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QStatusBar class provides a horizontal bar suitable for presenting status information. -.PP -Each status indicator falls into one of three categories: -.TP -\fITemporary\fR - briefly occupies most of the status bar. Used to explain tool tip texts or menu entries, for example. -.TP -\fINormal\fR - occupies part of the status bar and may be hidden by temporary messages. Used to display the page and line number in a word processor, for example. -.TP -\fIPermanent\fR - is never hidden. Used for important mode indications, for example, some applications put a Caps Lock indicator in the status bar. -.PP -QStatusBar lets you display all three types of indicators. -.PP -To display a \fItemporary\fR message, call message() (perhaps by connecting a suitable signal to it). To remove a temporary message, call clear(). There are two variants of message(): one that displays the message until the next clear() or message() and one that has a time limit: -.PP -.nf -.br - connect( loader, SIGNAL(progressMessage(const QString&)), -.br - statusBar(), SLOT(message(const QString&)) ); -.br -.br - statusBar()->message("Loading..."); // Initial message -.br - loader.loadStuff(); // Emits progress messages -.br - statusBar()->message("Done.", 2000); // Final message for 2 seconds -.br -.fi -.PP -\fINormal\fR and \fIPermanent\fR messages are displayed by creating a small widget and then adding it to the status bar with addWidget(). Widgets like QLabel, QProgressBar or even QToolButton are useful for adding to status bars. removeWidget() is used to remove widgets. -.PP -.nf -.br - statusBar()->addWidget(new MyReadWriteIndication(statusBar())); -.br -.fi -.PP -By default QStatusBar provides a QSizeGrip in the lower-right corner. You can disable it with setSizeGripEnabled(FALSE); -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QToolBar, QMainWindow, QLabel, GUI Design Handbook: Status Bar, Main Window and Related Classes, and Help System. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStatusBar::QStatusBar ( QWidget * parent = 0, const char * name = 0 )" -Constructs a status bar called \fIname\fR with parent \fIparent\fR and with a size grip. -.PP -See also sizeGripEnabled. -.SH "QStatusBar::~QStatusBar ()\fC [virtual]\fR" -Destroys the status bar and frees any allocated resources and child widgets. -.SH "void QStatusBar::addWidget ( QWidget * widget, int stretch = 0, bool permanent = FALSE )\fC [virtual]\fR" -Adds \fIwidget\fR to this status bar. \fIwidget\fR is reparented if it isn't already a child of the QStatusBar. -.PP -\fIwidget\fR is permanently visible if \fIpermanent\fR is TRUE and may be obscured by temporary messages if \fIpermanent\fR is FALSE. The default is FALSE. -.PP -If \fIpermanent\fR is TRUE, \fIwidget\fR is located at the far right of the status bar. If \fIpermanent\fR is FALSE (the default), \fIwidget\fR is located just to the left of the first permanent widget. -.PP -\fIstretch\fR is used to compute a suitable size for \fIwidget\fR as the status bar grows and shrinks. The default of 0 uses a minimum of space. -.PP -This function may cause some flicker. -.PP -See also removeWidget(). -.SH "void QStatusBar::clear ()\fC [slot]\fR" -Removes any temporary message being shown. -.PP -See also message(). -.SH "void QStatusBar::hideOrShow ()\fC [protected]\fR" -Ensures that the right widgets are visible. Used by message() and clear(). -.SH "bool QStatusBar::isSizeGripEnabled () const" -Returns TRUE if the QSizeGrip in the bottom right of the status bar is enabled; otherwise returns FALSE. See the "sizeGripEnabled" property for details. -.SH "void QStatusBar::message ( const QString & message )\fC [slot]\fR" -Hides the normal status indicators and displays \fImessage\fR until clear() or another message() is called. -.PP -See also clear(). -.PP -Example: regexptester/regexptester.cpp. -.SH "void QStatusBar::message ( const QString & message, int ms )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Hides the normal status indications and displays \fImessage\fR for \fIms\fR milli-seconds or until clear() or another message() is called, whichever occurs first. -.SH "void QStatusBar::messageChanged ( const QString & message )\fC [signal]\fR" -This signal is emitted when the temporary status messages changes. \fImessage\fR is the new temporary message, and is a null-string when the message has been removed. -.PP -See also message() and clear(). -.SH "void QStatusBar::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" -Shows the temporary message, if appropriate. -.PP -Reimplemented from QWidget. -.SH "void QStatusBar::reformat ()\fC [protected]\fR" -Changes the status bar's appearance to account for item changes. Special subclasses may need this, but geometry management will usually take care of any necessary rearrangements. -.SH "void QStatusBar::removeWidget ( QWidget * widget )\fC [virtual]\fR" -Removes \fIwidget\fR from the status bar. -.PP -This function may cause some flicker. -.PP -Note that \fIwidget\fR is not deleted. -.PP -See also addWidget(). -.SH "void QStatusBar::setSizeGripEnabled ( bool )" -Sets whether the QSizeGrip in the bottom right of the status bar is enabled. See the "sizeGripEnabled" property for details. -.SS "Property Documentation" -.SH "bool sizeGripEnabled" -This property holds whether the QSizeGrip in the bottom right of the status bar is enabled. -.PP -Enables or disables the QSizeGrip in the bottom right of the status bar. By default, the size grip is enabled. -.PP -Set this property's value with setSizeGripEnabled() and get this property's value with isSizeGripEnabled(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstatusbar.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstatusbar.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstoreddrag.3qt b/doc/man/man3/qstoreddrag.3qt deleted file mode 100644 index f54246ba8..000000000 --- a/doc/man/man3/qstoreddrag.3qt +++ /dev/null @@ -1,83 +0,0 @@ -'\" t -.TH QStoredDrag 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 -QStoredDrag \- Simple stored-value drag object for arbitrary MIME data -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDragObject. -.PP -Inherited by QUriDrag and QColorDrag. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStoredDrag\fR ( const char * mimeType, QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QStoredDrag\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetEncodedData\fR ( const QByteArray & encodedData )" -.br -.ti -1c -.BI "virtual QByteArray \fBencodedData\fR ( const char * m ) const" -.br -.in -1c -.SH DESCRIPTION -The QStoredDrag class provides a simple stored-value drag object for arbitrary MIME data. -.PP -When a block of data has only one representation, you can use a QStoredDrag to hold it. -.PP -For more information about drag and drop, see the QDragObject class and the drag and drop documentation. -.PP -See also Drag And Drop Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStoredDrag::QStoredDrag ( const char * mimeType, QWidget * dragSource = 0, const char * name = 0 )" -Constructs a QStoredDrag. The \fIdragSource\fR and \fIname\fR are passed to the QDragObject constructor, and the format is set to \fImimeType\fR. -.PP -The data will be unset. Use setEncodedData() to set it. -.SH "QStoredDrag::~QStoredDrag ()" -Destroys the drag object and frees up all allocated resources. -.SH "QByteArray QStoredDrag::encodedData ( const char * m ) const\fC [virtual]\fR" -Returns the stored data. \fIm\fR contains the data's format. -.PP -See also setEncodedData(). -.PP -Reimplemented from QMimeSource. -.SH "void QStoredDrag::setEncodedData ( const QByteArray & encodedData )\fC [virtual]\fR" -Sets the encoded data of this drag object to \fIencodedData\fR. The encoded data is what's delivered to the drop sites. It must be in a strictly defined and portable format. -.PP -The drag object can't be dropped (by the user) until this function -has been called. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qstoreddrag.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstoreddrag.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstrilist.3qt b/doc/man/man3/qstrilist.3qt deleted file mode 100644 index 3101da6ee..000000000 --- a/doc/man/man3/qstrilist.3qt +++ /dev/null @@ -1,64 +0,0 @@ -'\" t -.TH QStrIList 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 -QStrIList \- Doubly-linked list of char* with case-insensitive comparison -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QStrList. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStrIList\fR ( bool deepCopies = TRUE )" -.br -.ti -1c -.BI "\fB~QStrIList\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QStrIList class provides a doubly-linked list of char* with case-insensitive comparison. -.PP -This class is a QPtrList instance (a list of char*). -.PP -QStrIList is identical to QStrList except that the virtual compareItems() function is reimplemented to compare strings case-insensitively. The inSort() function inserts strings in a sorted order. In general it is fastest to insert the strings as they come and sort() at the end; inSort() is useful when you just have to add a few extra strings to an already sorted list. -.PP -The QStrListIterator class works for QStrIList. -.PP -See also QStringList, Collection Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStrIList::QStrIList ( bool deepCopies = TRUE )" -Constructs a list of strings. Will make deep copies of all inserted strings if \fIdeepCopies\fR is TRUE, or use shallow copies if \fIdeepCopies\fR is FALSE. -.SH "QStrIList::~QStrIList ()" -Destroys the list. All strings are removed. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qstrilist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstrilist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstring.3qt b/doc/man/man3/qstring.3qt deleted file mode 100644 index 00f736305..000000000 --- a/doc/man/man3/qstring.3qt +++ /dev/null @@ -1,2553 +0,0 @@ -'\" t -.TH QString 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 -QString \- Abstraction of Unicode text and the classic C '\0'-terminated char array -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                                            -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQString\fR ()" -.br -.ti -1c -.BI "\fBQString\fR ( QChar ch )" -.br -.ti -1c -.BI "\fBQString\fR ( const QString & s )" -.br -.ti -1c -.BI "\fBQString\fR ( const QByteArray & ba )" -.br -.ti -1c -.BI "\fBQString\fR ( const QChar * unicode, uint length )" -.br -.ti -1c -.BI "\fBQString\fR ( const char * str )" -.br -.ti -1c -.BI "\fBQString\fR ( const std::string & str )" -.br -.ti -1c -.BI "\fB~QString\fR ()" -.br -.ti -1c -.BI "QString & \fBoperator=\fR ( const QString & s )" -.br -.ti -1c -.BI "QString & \fBoperator=\fR ( const char * str )" -.br -.ti -1c -.BI "QString & \fBoperator=\fR ( const std::string & s )" -.br -.ti -1c -.BI "QString & \fBoperator=\fR ( const QCString & cstr )" -.br -.ti -1c -.BI "QString & \fBoperator=\fR ( QChar c )" -.br -.ti -1c -.BI "QString & \fBoperator=\fR ( char c )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "uint \fBlength\fR () const" -.br -.ti -1c -.BI "void \fBtruncate\fR ( uint newLen )" -.br -.ti -1c -.BI "QString & \fBfill\fR ( QChar c, int len = -1 )" -.br -.ti -1c -.BI "QString copy () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString \fBarg\fR ( long a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( ulong a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( TQ_LLONG a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( TQ_ULLONG a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( int a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( uint a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( short a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( ushort a, int fieldWidth = 0, int base = 10 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( double a, int fieldWidth = 0, char fmt = 'g', int prec = -1 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( char a, int fieldWidth = 0 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( QChar a, int fieldWidth = 0 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( const QString & a, int fieldWidth = 0 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( const QString & a1, const QString & a2 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( const QString & a1, const QString & a2, const QString & a3 ) const" -.br -.ti -1c -.BI "QString \fBarg\fR ( const QString & a1, const QString & a2, const QString & a3, const QString & a4 ) const" -.br -.ti -1c -.BI "QString & \fBsprintf\fR ( const char * cformat, ... )" -.br -.ti -1c -.BI "int \fBfind\fR ( QChar c, int index = 0, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( char c, int index = 0, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( const QString & str, int index = 0, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( const QRegExp & rx, int index = 0 ) const" -.br -.ti -1c -.BI "int \fBfind\fR ( const char * str, int index = 0 ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( QChar c, int index = -1, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( char c, int index = -1, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( const QString & str, int index = -1, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( const QRegExp & rx, int index = -1 ) const" -.br -.ti -1c -.BI "int \fBfindRev\fR ( const char * str, int index = -1 ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( QChar c, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( char c, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( const char * str, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( const QString & str, bool cs = TRUE ) const" -.br -.ti -1c -.BI "int \fBcontains\fR ( const QRegExp & rx ) const" -.br -.ti -1c -.BI "enum \fBSectionFlags\fR { SectionDefault = 0x00, SectionSkipEmpty = 0x01, SectionIncludeLeadingSep = 0x02, SectionIncludeTrailingSep = 0x04, SectionCaseInsensitiveSeps = 0x08 }" -.br -.ti -1c -.BI "QString \fBsection\fR ( QChar sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -.br -.ti -1c -.BI "QString \fBsection\fR ( char sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -.br -.ti -1c -.BI "QString \fBsection\fR ( const char * sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -.br -.ti -1c -.BI "QString \fBsection\fR ( const QString & sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -.br -.ti -1c -.BI "QString \fBsection\fR ( const QRegExp & reg, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -.br -.ti -1c -.BI "QString \fBleft\fR ( uint len ) const" -.br -.ti -1c -.BI "QString \fBright\fR ( uint len ) const" -.br -.ti -1c -.BI "QString \fBmid\fR ( uint index, uint len = 0xffffffff ) const" -.br -.ti -1c -.BI "QString \fBleftJustify\fR ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" -.br -.ti -1c -.BI "QString \fBrightJustify\fR ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" -.br -.ti -1c -.BI "QString \fBlower\fR () const" -.br -.ti -1c -.BI "QString \fBupper\fR () const" -.br -.ti -1c -.BI "QString \fBstripWhiteSpace\fR () const" -.br -.ti -1c -.BI "QString \fBsimplifyWhiteSpace\fR () const" -.br -.ti -1c -.BI "QString & \fBinsert\fR ( uint index, const QString & s )" -.br -.ti -1c -.BI "QString & \fBinsert\fR ( uint index, const QByteArray & s )" -.br -.ti -1c -.BI "QString & \fBinsert\fR ( uint index, const char * s )" -.br -.ti -1c -.BI "QString & \fBinsert\fR ( uint index, const QChar * s, uint len )" -.br -.ti -1c -.BI "QString & \fBinsert\fR ( uint index, QChar c )" -.br -.ti -1c -.BI "QString & \fBinsert\fR ( uint index, char c )" -.br -.ti -1c -.BI "QString & \fBappend\fR ( char ch )" -.br -.ti -1c -.BI "QString & \fBappend\fR ( QChar ch )" -.br -.ti -1c -.BI "QString & \fBappend\fR ( const QString & str )" -.br -.ti -1c -.BI "QString & \fBappend\fR ( const QByteArray & str )" -.br -.ti -1c -.BI "QString & \fBappend\fR ( const char * str )" -.br -.ti -1c -.BI "QString & \fBappend\fR ( const std::string & str )" -.br -.ti -1c -.BI "QString & \fBprepend\fR ( char ch )" -.br -.ti -1c -.BI "QString & \fBprepend\fR ( QChar ch )" -.br -.ti -1c -.BI "QString & \fBprepend\fR ( const QString & s )" -.br -.ti -1c -.BI "QString & \fBprepend\fR ( const QByteArray & s )" -.br -.ti -1c -.BI "QString & \fBprepend\fR ( const char * s )" -.br -.ti -1c -.BI "QString & \fBprepend\fR ( const std::string & s )" -.br -.ti -1c -.BI "QString & \fBremove\fR ( uint index, uint len )" -.br -.ti -1c -.BI "QString & \fBremove\fR ( const QString & str, bool cs = TRUE )" -.br -.ti -1c -.BI "QString & \fBremove\fR ( QChar c )" -.br -.ti -1c -.BI "QString & \fBremove\fR ( char c )" -.br -.ti -1c -.BI "QString & \fBremove\fR ( const char * str )" -.br -.ti -1c -.BI "QString & \fBremove\fR ( const QRegExp & rx )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( uint index, uint len, const QString & s )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( uint index, uint len, const QChar * s, uint slen )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( uint index, uint len, QChar c )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( uint index, uint len, char c )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( QChar c, const QString & after, bool cs = TRUE )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( char c, const QString & after, bool cs = TRUE )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( const QString & before, const QString & after, bool cs = TRUE )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( const QRegExp & rx, const QString & after )" -.br -.ti -1c -.BI "QString & \fBreplace\fR ( QChar c1, QChar c2 )" -.br -.ti -1c -.BI "short \fBtoShort\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "ushort \fBtoUShort\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "int \fBtoInt\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "uint \fBtoUInt\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "long \fBtoLong\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "ulong \fBtoULong\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "TQ_LLONG \fBtoLongLong\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "TQ_ULLONG \fBtoULongLong\fR ( bool * ok = 0, int base = 10 ) const" -.br -.ti -1c -.BI "float \fBtoFloat\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "double \fBtoDouble\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( short n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( ushort n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( int n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( uint n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( long n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( ulong n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( TQ_LLONG n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( TQ_ULLONG n, int base = 10 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( float n, char f = 'g', int prec = 6 )" -.br -.ti -1c -.BI "QString & \fBsetNum\fR ( double n, char f = 'g', int prec = 6 )" -.br -.ti -1c -.BI "void setExpand ( uint index, QChar c ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString & \fBoperator+=\fR ( const QString & str )" -.br -.ti -1c -.BI "QString & \fBoperator+=\fR ( const QByteArray & str )" -.br -.ti -1c -.BI "QString & \fBoperator+=\fR ( const char * str )" -.br -.ti -1c -.BI "QString & \fBoperator+=\fR ( const std::string & str )" -.br -.ti -1c -.BI "QString & \fBoperator+=\fR ( QChar c )" -.br -.ti -1c -.BI "QString & \fBoperator+=\fR ( char c )" -.br -.ti -1c -.BI "QChar \fBat\fR ( uint i ) const" -.br -.ti -1c -.BI "QChar \fBoperator[]\fR ( int i ) const" -.br -.ti -1c -.BI "QCharRef \fBat\fR ( uint i )" -.br -.ti -1c -.BI "QCharRef \fBoperator[]\fR ( int i )" -.br -.ti -1c -.BI "QChar \fBconstref\fR ( uint i ) const" -.br -.ti -1c -.BI "QChar & \fBref\fR ( uint i )" -.br -.ti -1c -.BI "const QChar * \fBunicode\fR () const" -.br -.ti -1c -.BI "const char * \fBascii\fR () const" -.br -.ti -1c -.BI "const char * \fBlatin1\fR () const" -.br -.ti -1c -.BI "QCString \fButf8\fR () const" -.br -.ti -1c -.BI "QCString \fBlocal8Bit\fR () const" -.br -.ti -1c -.BI "bool \fBoperator!\fR () const" -.br -.ti -1c -.BI "\fBoperator const char *\fR () const" -.br -.ti -1c -.BI "\fBoperator std::string\fR () const" -.br -.ti -1c -.BI "const unsigned short * \fBucs2\fR () const" -.br -.ti -1c -.BI "QString & \fBsetUnicode\fR ( const QChar * unicode, uint len )" -.br -.ti -1c -.BI "QString & \fBsetUnicodeCodes\fR ( const ushort * unicode_as_ushorts, uint len )" -.br -.ti -1c -.BI "QString & \fBsetAscii\fR ( const char * str, int len = -1 )" -.br -.ti -1c -.BI "QString & \fBsetLatin1\fR ( const char * str, int len = -1 )" -.br -.ti -1c -.BI "int \fBcompare\fR ( const QString & s ) const" -.br -.ti -1c -.BI "int \fBlocaleAwareCompare\fR ( const QString & s ) const" -.br -.ti -1c -.BI "void \fBcompose\fR ()" -.br -.ti -1c -.BI "const char * data () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBstartsWith\fR ( const QString & s, bool cs = TRUE ) const" -.br -.ti -1c -.BI "bool \fBendsWith\fR ( const QString & s, bool cs = TRUE ) const" -.br -.ti -1c -.BI "void \fBsetLength\fR ( uint newLen )" -.br -.ti -1c -.BI "uint \fBcapacity\fR () const" -.br -.ti -1c -.BI "void \fBreserve\fR ( uint minCapacity )" -.br -.ti -1c -.BI "void \fBsqueeze\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBnumber\fR ( long n, int base = 10 )" -.br -.ti -1c -.BI "QString \fBnumber\fR ( ulong n, int base = 10 )" -.br -.ti -1c -.BI "QString \fBnumber\fR ( TQ_LLONG n, int base = 10 )" -.br -.ti -1c -.BI "QString \fBnumber\fR ( TQ_ULLONG n, int base = 10 )" -.br -.ti -1c -.BI "QString \fBnumber\fR ( int n, int base = 10 )" -.br -.ti -1c -.BI "QString \fBnumber\fR ( uint n, int base = 10 )" -.br -.ti -1c -.BI "QString \fBnumber\fR ( double n, char f = 'g', int prec = 6 )" -.br -.ti -1c -.BI "QString \fBfromAscii\fR ( const char * ascii, int len = -1 )" -.br -.ti -1c -.BI "QString \fBfromLatin1\fR ( const char * chars, int len = -1 )" -.br -.ti -1c -.BI "QString \fBfromUtf8\fR ( const char * utf8, int len = -1 )" -.br -.ti -1c -.BI "QString \fBfromLocal8Bit\fR ( const char * local8Bit, int len = -1 )" -.br -.ti -1c -.BI "QString \fBfromUcs2\fR ( const unsigned short * str )" -.br -.ti -1c -.BI "int \fBcompare\fR ( const QString & s1, const QString & s2 )" -.br -.ti -1c -.BI "int \fBlocaleAwareCompare\fR ( const QString & s1, const QString & s2 )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "bool \fBoperator==\fR ( const QString & s1, const QString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const char * s1, const QString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QString & s1, const QString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const char * s1, const QString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const QString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const char * s1, const QString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const QString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const char * s1, const QString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const QString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const char * s1, const QString & s2 )" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const QString & s1, const char * s2 )" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const char * s1, const QString & s2 )" -.br -.ti -1c -.BI "const QString \fBoperator+\fR ( const QString & s1, const QString & s2 )" -.br -.ti -1c -.BI "const QString \fBoperator+\fR ( const QString & s1, const char * s2 )" -.br -.ti -1c -.BI "const QString \fBoperator+\fR ( const char * s1, const QString & s2 )" -.br -.ti -1c -.BI "const QString \fBoperator+\fR ( const QString & s, char c )" -.br -.ti -1c -.BI "const QString \fBoperator+\fR ( char c, const QString & s )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QString & str )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QString & str )" -.br -.in -1c -.SH DESCRIPTION -The QString class provides an abstraction of Unicode text and the classic C '\0'-terminated char array. -.PP -QString uses implicit sharing, which makes it very efficient and easy to use. -.PP -In all of the QString methods that take \fCconst char *\fR parameters, the \fCconst char *\fR is interpreted as a classic C-style '\0'-terminated ASCII string. It is legal for the \fCconst char *\fR parameter to be 0. If the \fCconst char *\fR is not '\0'-terminated, the results are undefined. Functions that copy classic C strings into a QString will not copy the terminating '\0' character. The QChar array of the QString (as returned by unicode()) is generally not terminated by a '\0'. If you need to pass a QString to a function that requires a C '\0'-terminated string use latin1(). -.PP -A QString that has not been assigned to anything is \fInull\fR, i.e. both the length and data pointer is 0. A QString that references the empty string ("", a single '\0' char) is \fIempty\fR. Both null and empty QStrings are legal parameters to the methods. Assigning \fC(const char *) 0\fR to QString gives a null QString. For convenience, QString::null is a null QString. When sorting, empty strings come first, followed by non-empty strings, followed by null strings. We recommend using \fCif ( !str.isNull() )\fR to check for a non-null string rather than \fCif ( !str )\fR; see operator!() for an explanation. -.PP -Note that if you find that you are mixing usage of QCString, QString, and QByteArray, this causes lots of unnecessary copying and might indicate that the true nature of the data you are dealing with is uncertain. If the data is '\0'-terminated 8-bit data, use QCString; if it is unterminated (i.e. contains '\0's) 8-bit data, use QByteArray; if it is text, use QString. -.PP -Lists of strings are handled by the QStringList class. You can split a string into a list of strings using QStringList::split(), and join a list of strings into a single string with an optional separator using QStringList::join(). You can obtain a list of strings from a string list that contain a particular substring or that match a particular regex using QStringList::grep(). -.PP -\fBNote for C programmers\fR -.PP -Due to C++'s type system and the fact that QString is implicitly shared, QStrings can be treated like ints or other simple base types. For example: -.PP -.nf -.br - QString boolToString( bool b ) -.br - { -.br - QString result; -.br - if ( b ) -.br - result = "True"; -.br - else -.br - result = "False"; -.br - return result; -.br - } -.br -.fi -.PP -The variable, result, is an auto variable allocated on the stack. When return is called, because we're returning by value, The copy constructor is called and a copy of the string is returned. (No actual copying takes place thanks to the implicit sharing, see below.) -.PP -Throughout Qt's source code you will encounter QString usages like this: -.PP -.nf -.br - QString func( const QString& input ) -.br - { -.br - QString output = input; -.br - // process output -.br - return output; -.br - } -.br -.fi -.PP -The 'copying' of input to output is almost as fast as copying a pointer because behind the scenes copying is achieved by incrementing a reference count. QString (like all Qt's implicitly shared classes) operates on a copy-on-write basis, only copying if an instance is actually changed. -.PP -If you wish to create a deep copy of a QString without losing any Unicode information then you should use QDeepCopy. -.PP -See also QChar, QCString, QByteArray, QConstString, Implicitly and Explicitly Shared Classes, Text Related Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QString::SectionFlags" -.TP -\fCQString::SectionDefault\fR - Empty fields are counted, leading and trailing separators are not included, and the separator is compared case sensitively. -.TP -\fCQString::SectionSkipEmpty\fR - Treat empty fields as if they don't exist, i.e. they are not considered as far as \fIstart\fR and \fIend\fR are concerned. -.TP -\fCQString::SectionIncludeLeadingSep\fR - Include the leading separator (if any) in the result string. -.TP -\fCQString::SectionIncludeTrailingSep\fR - Include the trailing separator (if any) in the result string. -.TP -\fCQString::SectionCaseInsensitiveSeps\fR - Compare the separator case-insensitively. -.PP -Any of the last four values can be OR-ed together to form a flag. -.PP -See also section(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QString::QString ()" -Constructs a null string, i.e. both the length and data pointer are 0. -.PP -See also isNull(). -.SH "QString::QString ( QChar ch )" -Constructs a string of length one, containing the character \fIch\fR. -.SH "QString::QString ( const QString & s )" -Constructs an implicitly shared copy of \fIs\fR. This is very fast since it only involves incrementing a reference count. -.SH "QString::QString ( const QByteArray & ba )" -Constructs a string that is a deep copy of \fIba\fR interpreted as a classic C string. -.SH "QString::QString ( const QChar * unicode, uint length )" -Constructs a string that is a deep copy of the first \fIlength\fR characters in the QChar array. -.PP -If \fIunicode\fR and \fIlength\fR are 0, then a null string is created. -.PP -If only \fIunicode\fR is 0, the string is empty but has \fIlength\fR characters of space preallocated: QString expands automatically anyway, but this may speed up some cases a little. We recommend using the plain constructor and setLength() for this purpose since it will result in more readable code. -.PP -See also isNull() and setLength(). -.SH "QString::QString ( const char * str )" -Constructs a string that is a deep copy of \fIstr\fR, interpreted as a classic C string. The encoding is assumed to be Latin-1, unless you change it using QTextCodec::setCodecForCStrings(). -.PP -If \fIstr\fR is 0, then a null string is created. -.PP -This is a cast constructor, but it is perfectly safe: converting a Latin-1 \fCconst char *\fR to QString preserves all the information. You can disable this constructor by defining \fCQT_NO_CAST_ASCII\fR when you compile your applications. You can also make QString objects by using setLatin1(), fromLatin1(), fromLocal8Bit(), and fromUtf8(). Or whatever encoding is appropriate for the 8-bit data you have. -.PP -See also isNull() and fromAscii(). -.SH "QString::QString ( const std::string & str )" -Constructs a string that is a deep copy of \fIstr\fR. -.PP -This is the same as fromAscii(\fIstr\fR). -.SH "QString::~QString ()" -Destroys the string and frees the string's data if this is the last reference to the string. -.SH "QString & QString::append ( const QString & str )" -Appends \fIstr\fR to the string and returns a reference to the result. -.PP -.nf -.br - string = "Test"; -.br - string.append( "ing" ); // string == "Testing" -.br -.fi -.PP -Equivalent to operator+=(). -.PP -Example: dirview/dirview.cpp. -.SH "QString & QString::append ( char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends character \fIch\fR to the string and returns a reference to the result. -.PP -Equivalent to operator+=(). -.SH "QString & QString::append ( QChar ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends character \fIch\fR to the string and returns a reference to the result. -.PP -Equivalent to operator+=(). -.SH "QString & QString::append ( const QByteArray & str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIstr\fR to the string and returns a reference to the result. -.PP -Equivalent to operator+=(). -.SH "QString & QString::append ( const char * str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIstr\fR to the string and returns a reference to the result. -.PP -Equivalent to operator+=(). -.SH "QString & QString::append ( const std::string & str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIstr\fR to the string and returns a reference to the result. -.PP -Equivalent to operator+=(). -.SH "QString QString::arg ( const QString & a, int fieldWidth = 0 ) const" -This function will return a string that replaces the lowest numbered occurrence of \fC%1\fR, \fC%2\fR, ..., \fC%9\fR with \fIa\fR. -.PP -The \fIfieldWidth\fR value specifies the minimum amount of space that \fIa\fR is padded to. A positive value will produce right-aligned text, whereas a negative value will produce left-aligned text. -.PP -The following example shows how we could create a 'status' string when processing a list of files: -.PP -.nf -.br - QString status = QString( "Processing file %1 of %2: %3" ) -.br - .arg( i ) // current file's number -.br - .arg( total ) // number of files to process -.br - .arg( fileName ); // current file's name -.br -.fi -.PP -It is generally fine to use filenames and numbers as we have done in the example above. But note that using arg() to construct natural language sentences does not usually translate well into other languages because sentence structure and word order often differ between languages. -.PP -If there is no place marker (\fC%1\fR, \fC%2\fR, etc.), a warning message (tqWarning()) is output and the result is undefined. -.PP -\fBWarning:\fR If any placeholder occurs more than once, the result is undefined. -.SH "QString QString::arg ( long a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The \fIfieldWidth\fR value specifies the minimum amount of space that \fIa\fR is padded to. A positive value will produce a right-aligned number, whereas a negative value will produce a left-aligned number. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. -.PP -The '%' can be followed by an 'L', in which case the sequence is replaced with a localized representation of \fIa\fR. The conversion uses the default locale. The default locale is determined from the system's locale settings at application startup. It can be changed using QLocale::setDefault(). The 'L' flag is ignored if \fIbase\fR is not 10. -.PP -.nf -.br - QString str; -.br - str = QString( "Decimal 63 is %1 in hexadecimal" ) -.br - .arg( 63, 0, 16 ); -.br - // str == "Decimal 63 is 3f in hexadecimal" -.br -.br - QLocale::setDefault(QLocale::English, QLocale::UnitedStates); -.br - str = QString( "%1 %L2 %L3" ) -.br - .arg( 12345 ) -.br - .arg( 12345 ) -.br - .arg( 12345, 0, 16 ); -.br - // str == "12345 12,345 3039" -.br -.fi -.SH "QString QString::arg ( ulong a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( TQ_LLONG a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( TQ_ULLONG a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( int a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( uint a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( short a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( ushort a, int fieldWidth = 0, int base = 10 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( double a, int fieldWidth = 0, char fmt = 'g', int prec = -1 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Argument \fIa\fR is formatted according to the \fIfmt\fR format specified, which is 'g' by default and can be any of the following: -.PP -
                                                            .nf -.TS -l - l. Format Meaning format as [-]9.9e[+|-]999 format as [-]9.9E[+|-]999 format as [-]9.9 use use -.TE -.fi -
                                                            -.PP -With 'e', 'E', and 'f', \fIprec\fR is the number of digits after the decimal point. With 'g' and 'G', \fIprec\fR is the maximum number of significant digits (trailing zeroes are omitted). -.PP -.nf -.br - double d = 12.34; -.br - QString ds = QString( "'E' format, precision 3, gives %1" ) -.br - .arg( d, 0, 'E', 3 ); -.br - // ds == "'E' format, precision 3, gives 1.234E+01" -.br -.fi -.PP -The '%L' syntax can be used to produce localized strings. -.SH "QString QString::arg ( char a, int fieldWidth = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR is assumed to be in the Latin-1 character set. -.SH "QString QString::arg ( QChar a, int fieldWidth = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QString QString::arg ( const QString & a1, const QString & a2 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is the same as str.arg(\fIa1\fR).arg(\fIa2\fR), except that the strings are replaced in one pass. This can make a difference if \fIa1\fR contains e.g. \fC%1\fR: -.PP -.nf -.br - QString str( "%1 %2" ); -.br - str.arg( "Hello", "world" ); // returns "Hello world" -.br - str.arg( "Hello" ).arg( "world" ); // returns "Hello world" -.br -.br - str.arg( "(%1)", "Hello" ); // returns "(%1) Hello" -.br - str.arg( "(%1)" ).arg( "Hello" ); // returns "(Hello) %2" -.br -.fi -.SH "QString QString::arg ( const QString & a1, const QString & a2, const QString & a3 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is the same as calling str.arg(\fIa1\fR).arg(\fIa2\fR).arg(\fIa3\fR), except that the strings are replaced in one pass. -.SH "QString QString::arg ( const QString & a1, const QString & a2, const QString & a3, const QString & a4 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is the same as calling str.arg(\fIa1\fR).arg(\fIa2\fR).arg(\fIa3\fR).arg(\fIa4\fR), except that the strings are replaced in one pass. -.SH "const char * QString::ascii () const" -Returns an 8-bit ASCII representation of the string. -.PP -If a codec has been set using QTextCodec::codecForCStrings(), it is used to convert Unicode to 8-bit char. Otherwise, this function does the same as latin1(). -.PP -See also fromAscii(), latin1(), utf8(), and local8Bit(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "QChar QString::at ( uint i ) const" -Returns the character at index \fIi\fR, or 0 if \fIi\fR is beyond the length of the string. -.PP -.nf -.br - const QString string( "abcdefgh" ); -.br - QChar ch = string.at( 4 ); -.br - // ch == 'e' -.br -.fi -.PP -If the QString is not const (i.e. const QString) or const& (i.e. const QString &), then the non-const overload of at() will be used instead. -.SH "QCharRef QString::at ( uint i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The function returns a reference to the character at index \fIi\fR. The resulting reference can then be assigned to, or used immediately, but it will become invalid once further modifications are made to the original string. -.PP -If \fIi\fR is beyond the length of the string then the string is expanded with QChar::null. -.SH "uint QString::capacity () const" -Returns the number of characters this string can hold in the allocated memory. -.PP -See also reserve() and squeeze(). -.SH "int QString::compare ( const QString & s1, const QString & s2 )\fC [static]\fR" -Lexically compares \fIs1\fR with \fIs2\fR and returns an integer less than, equal to, or greater than zero if \fIs1\fR is less than, equal to, or greater than \fIs2\fR. -.PP -The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with QString::localeAwareCompare(). -.PP -.nf -.br - int a = QString::compare( "def", "abc" ); // a > 0 -.br - int b = QString::compare( "abc", "def" ); // b < 0 -.br - int c = QString::compare( "abc", "abc" ); // c == 0 -.br -.fi -.SH "int QString::compare ( const QString & s ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Lexically compares this string with \fIs\fR and returns an integer less than, equal to, or greater than zero if it is less than, equal to, or greater than \fIs\fR. -.SH "void QString::compose ()" -\fBWarning:\fR This function is not supported in Qt 3.x. It is provided for experimental and illustrative purposes only. It is mainly of interest to those experimenting with Arabic and other composition-rich texts. -.PP -Applies possible ligatures to a QString. Useful when composition-rich text requires rendering with glyph-poor fonts, but it also makes compositions such as QChar(0x0041) ('A') and QChar(0x0308) (Unicode accent diaresis), giving QChar(0x00c4) (German A Umlaut). -.SH "QChar QString::constref ( uint i ) const" -Returns the QChar at index \fIi\fR by value. -.PP -Equivalent to at(\fIi\fR). -.PP -See also ref(). -.SH "int QString::contains ( QChar c, bool cs = TRUE ) const" -Returns the number of times the character \fIc\fR occurs in the string. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -.nf -.br - QString string( "Trolltech and Qt" ); -.br - int n = string.contains( 't', FALSE ); -.br - // n == 3 -.br -.fi -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and mdi/application.cpp. -.SH "int QString::contains ( char c, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "int QString::contains ( const char * str, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the number of times the string \fIstr\fR occurs in the string. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.SH "int QString::contains ( const QString & str, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the number of times \fIstr\fR occurs in the string. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -This function counts overlapping strings, so in the example below, there are two instances of "ana" in "bananas". -.PP -.nf -.br - QString str( "bananas" ); -.br - int i = str.contains( "ana" ); // i == 2 -.br -.fi -.PP -See also findRev(). -.SH "int QString::contains ( const QRegExp & rx ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the number of times the regexp, \fIrx\fR, matches in the string. -.PP -This function counts overlapping matches, so in the example below, there are four instances of "ana" or "ama". -.PP -.nf -.br - QString str = "banana and panama"; -.br - QRegExp rxp = QRegExp( "a[nm]a", TRUE, FALSE ); -.br - int i = str.contains( rxp ); // i == 4 -.br -.fi -.PP -See also find() and findRev(). -.SH "QString QString::copy () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -In Qt 2.0 and later, all calls to this function are needless. Just remove them. -.SH "const char * QString::data () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns a pointer to a '\0'-terminated classic C string. -.PP -In Qt 1.x, this returned a char* allowing direct manipulation of the string as a sequence of bytes. In Qt 2.x where QString is a Unicode string, char* conversion constructs a temporary string, and hence direct character operations are meaningless. -.SH "bool QString::endsWith ( const QString & s, bool cs = TRUE ) const" -Returns TRUE if the string ends with \fIs\fR; otherwise returns FALSE. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -.nf -.br - QString str( "Bananas" ); -.br - str.endsWith( "anas" ); // returns TRUE -.br - str.endsWith( "pple" ); // returns FALSE -.br -.fi -.PP -See also startsWith(). -.PP -Example: chart/main.cpp. -.SH "QString & QString::fill ( QChar c, int len = -1 )" -Fills the string with \fIlen\fR characters of value \fIc\fR, and returns a reference to the string. -.PP -If \fIlen\fR is negative (the default), the current string length is used. -.PP -.nf -.br - QString str; -.br - str.fill( 'g', 5 ); // string == "ggggg" -.br -.fi -.SH "int QString::find ( const QRegExp & rx, int index = 0 ) const" -Finds the first match of the regular expression \fIrx\fR, starting from position \fIindex\fR. If \fIindex\fR is -1, the search starts at the last character; if -2, at the next to last character and so on. (See findRev() for searching backwards.) -.PP -Returns the position of the first match of \fIrx\fR or -1 if no match was found. -.PP -.nf -.br - QString string( "bananas" ); -.br - int i = string.find( QRegExp("an"), 0 ); // i == 1 -.br -.fi -.PP -See also findRev(), replace(), and contains(). -.PP -Example: network/mail/smtp.cpp. -.SH "int QString::find ( QChar c, int index = 0, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR. If \fIindex\fR is -1, the search starts at the last character; if -2, at the next to last character and so on. (See findRev() for searching backwards.) -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -Returns the position of \fIc\fR or -1 if \fIc\fR could not be found. -.SH "int QString::find ( char c, int index = 0, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Find character \fIc\fR starting from position \fIindex\fR. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.SH "int QString::find ( const QString & str, int index = 0, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR. If \fIindex\fR is -1, the search starts at the last character, if it is -2, at the next to last character and so on. (See findRev() for searching backwards.) -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -Returns the position of \fIstr\fR or -1 if \fIstr\fR could not be found. -.SH "int QString::find ( const char * str, int index = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Equivalent to find(QString(\fIstr\fR), \fIindex\fR). -.SH "int QString::findRev ( const char * str, int index = -1 ) const" -Equivalent to findRev(QString(\fIstr\fR), \fIindex\fR). -.SH "int QString::findRev ( QChar c, int index = -1, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR and searching backwards. If the index is -1, the search starts at the last character, if it is -2, at the next to last character and so on. -.PP -Returns the position of \fIc\fR or -1 if \fIc\fR could not be found. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -.nf -.br - QString string( "bananas" ); -.br - int i = string.findRev( 'a' ); // i == 5 -.br -.fi -.SH "int QString::findRev ( char c, int index = -1, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Find character \fIc\fR starting from position \fIindex\fR and working backwards. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.SH "int QString::findRev ( const QString & str, int index = -1, bool cs = TRUE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR and searching backwards. If the index is -1, the search starts at the last character, if it is -2, at the next to last character and so on. -.PP -Returns the position of \fIstr\fR or -1 if \fIstr\fR could not be found. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -.nf -.br - QString string("bananas"); -.br - int i = string.findRev( "ana" ); // i == 3 -.br -.fi -.SH "int QString::findRev ( const QRegExp & rx, int index = -1 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first match of the regexp \fIrx\fR, starting at position \fIindex\fR and searching backwards. If the index is -1, the search starts at the last character, if it is -2, at the next to last character and so on. (See findRev() for searching backwards.) -.PP -Returns the position of the match or -1 if no match was found. -.PP -.nf -.br - QString string( "bananas" ); -.br - int i = string.findRev( QRegExp("an") ); // i == 3 -.br -.fi -.PP -See also find(). -.SH "QString QString::fromAscii ( const char * ascii, int len = -1 )\fC [static]\fR" -Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIascii\fR, ignoring the rest of \fIascii\fR. If \fIlen\fR is -1 then the length of \fIascii\fR is used. If \fIlen\fR is bigger than the length of \fIascii\fR then it will use the length of \fIascii\fR. -.PP -If a codec has been set using QTextCodec::codecForCStrings(), it is used to convert the string from 8-bit characters to Unicode. Otherwise, this function does the same as fromLatin1(). -.PP -This is the same as the QString(const char*) constructor, but you can make that constructor invisible if you compile with the define \fCQT_NO_CAST_ASCII\fR, in which case you can explicitly create a QString from 8-bit ASCII text using this function. -.PP -.nf -.br - QString str = QString::fromAscii( "123456789", 5 ); -.br - // str == "12345" -.br -.fi -.SH "QString QString::fromLatin1 ( const char * chars, int len = -1 )\fC [static]\fR" -Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIchars\fR, ignoring the rest of \fIchars\fR. If \fIlen\fR is -1 then the length of \fIchars\fR is used. If \fIlen\fR is bigger than the length of \fIchars\fR then it will use the length of \fIchars\fR. -.PP -See also fromAscii(). -.PP -Examples: -.)l listbox/listbox.cpp and network/mail/smtp.cpp. -.SH "QString QString::fromLocal8Bit ( const char * local8Bit, int len = -1 )\fC [static]\fR" -Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIlocal8Bit\fR, ignoring the rest of \fIlocal8Bit\fR. If \fIlen\fR is -1 then the length of \fIlocal8Bit\fR is used. If \fIlen\fR is bigger than the length of \fIlocal8Bit\fR then it will use the length of \fIlocal8Bit\fR. -.PP -.nf -.br - QString str = QString::fromLocal8Bit( "123456789", 5 ); -.br - // str == "12345" -.br -.fi -.PP -\fIlocal8Bit\fR is assumed to be encoded in a locale-specific format. -.PP -See QTextCodec for more diverse coding/decoding of Unicode strings. -.SH "QString QString::fromUcs2 ( const unsigned short * str )\fC [static]\fR" -Constructs a string that is a deep copy of \fIstr\fR, interpreted as a UCS2 encoded, zero terminated, Unicode string. -.PP -If \fIstr\fR is 0, then a null string is created. -.PP -See also isNull(). -.SH "QString QString::fromUtf8 ( const char * utf8, int len = -1 )\fC [static]\fR" -Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIutf8\fR, ignoring the rest of \fIutf8\fR. If \fIlen\fR is -1 then the length of \fIutf8\fR is used. If \fIlen\fR is bigger than the length of \fIutf8\fR then it will use the length of \fIutf8\fR. -.PP -.nf -.br - QString str = QString::fromUtf8( "123456789", 5 ); -.br - // str == "12345" -.br -.fi -.PP -See QTextCodec for more diverse coding/decoding of Unicode strings. -.PP -Example: fonts/simple-qfont-demo/viewer.cpp. -.SH "QString & QString::insert ( uint index, const QString & s )" -Inserts \fIs\fR into the string at position \fIindex\fR. -.PP -If \fIindex\fR is beyond the end of the string, the string is extended with spaces to length \fIindex\fR and \fIs\fR is then appended and returns a reference to the string. -.PP -.nf -.br - QString string( "I like fish" ); -.br - str = string.insert( 2, "don't " ); -.br - // str == "I don't like fish" -.br -.fi -.PP -See also remove() and replace(). -.PP -Examples: -.)l themes/themes.cpp and xform/xform.cpp. -.SH "QString & QString::insert ( uint index, const QByteArray & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIs\fR into the string at position \fIindex\fR and returns a reference to the string. -.SH "QString & QString::insert ( uint index, const char * s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIs\fR into the string at position \fIindex\fR and returns a reference to the string. -.SH "QString & QString::insert ( uint index, const QChar * s, uint len )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the first \fIlen\fR characters in \fIs\fR into the string at position \fIindex\fR and returns a reference to the string. -.SH "QString & QString::insert ( uint index, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Insert \fIc\fR into the string at position \fIindex\fR and returns a reference to the string. -.PP -If \fIindex\fR is beyond the end of the string, the string is extended with spaces (ASCII 32) to length \fIindex\fR and \fIc\fR is then appended. -.SH "QString & QString::insert ( uint index, char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Insert character \fIc\fR at position \fIindex\fR. -.SH "bool QString::isEmpty () const" -Returns TRUE if the string is empty, i.e. if length() == 0; otherwise returns FALSE. Null strings are also empty. -.PP -.nf -.br - QString a( "" ); -.br - a.isEmpty(); // TRUE -.br - a.isNull(); // FALSE -.br -.br - QString b; -.br - b.isEmpty(); // TRUE -.br - b.isNull(); // TRUE -.br -.fi -.PP -See also isNull() and length(). -.PP -Examples: -.)l addressbook/mainwindow.cpp, chart/chartform.cpp, chart/chartform_canvas.cpp, network/networkprotocol/nntp.cpp, qmag/qmag.cpp, and qwerty/qwerty.cpp. -.SH "bool QString::isNull () const" -Returns TRUE if the string is null; otherwise returns FALSE. A null string is always empty. -.PP -.nf -.br - QString a; // a.unicode() == 0, a.length() == 0 -.br - a.isNull(); // TRUE, because a.unicode() == 0 -.br - a.isEmpty(); // TRUE, because a.length() == 0 -.br -.fi -.PP -See also isEmpty() and length(). -.PP -Examples: -.)l i18n/main.cpp, network/ftpclient/ftpmainwindow.ui.h, and qdir/qdir.cpp. -.SH "const char * QString::latin1 () const" -Returns a Latin-1 representation of the string. The returned value is undefined if the string contains non-Latin-1 characters. If you want to convert strings into formats other than Unicode, see the QTextCodec classes. -.PP -This function is mainly useful for boot-strapping legacy code to use Unicode. -.PP -The result remains valid so long as one unmodified copy of the source string exists. -.PP -See also fromLatin1(), ascii(), utf8(), and local8Bit(). -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and network/networkprotocol/nntp.cpp. -.SH "QString QString::left ( uint len ) const" -Returns a substring that contains the \fIlen\fR leftmost characters of the string. -.PP -The whole string is returned if \fIlen\fR exceeds the length of the string. -.PP -.nf -.br - QString s = "Pineapple"; -.br - QString t = s.left( 4 ); // t == "Pine" -.br -.fi -.PP -See also right(), mid(), and isEmpty(). -.PP -Example: themes/themes.cpp. -.SH "QString QString::leftJustify ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" -Returns a string of length \fIwidth\fR that contains this string padded by the \fIfill\fR character. -.PP -If \fItruncate\fR is FALSE and the length of the string is more than \fIwidth\fR, then the returned string is a copy of the string. -.PP -If \fItruncate\fR is TRUE and the length of the string is more than \fIwidth\fR, then any characters in a copy of the string after length \fIwidth\fR are removed, and the copy is returned. -.PP -.nf -.br - QString s( "apple" ); -.br - QString t = s.leftJustify( 8, '.' ); // t == "apple..." -.br -.fi -.PP -See also rightJustify(). -.SH "uint QString::length () const" -Returns the length of the string. -.PP -Null strings and empty strings have zero length. -.PP -See also isNull() and isEmpty(). -.PP -Examples: -.)l dirview/dirview.cpp, fileiconview/qfileiconview.cpp, network/networkprotocol/nntp.cpp, rot13/rot13.cpp, and themes/themes.cpp. -.SH "QCString QString::local8Bit () const" -Returns the string encoded in a locale-specific format. On X11, this is the QTextCodec::codecForLocale(). On Windows, it is a system-defined encoding. On Mac OS X, this always uses UTF-8 as the encoding. -.PP -See QTextCodec for more diverse coding/decoding of Unicode strings. -.PP -See also fromLocal8Bit(), ascii(), latin1(), and utf8(). -.SH "int QString::localeAwareCompare ( const QString & s1, const QString & s2 )\fC [static]\fR" -Compares \fIs1\fR with \fIs2\fR and returns an integer less than, equal to, or greater than zero if \fIs1\fR is less than, equal to, or greater than \fIs2\fR. -.PP -The comparison is performed in a locale- and also platform-dependent manner. Use this function to present sorted lists of strings to the user. -.PP -See also QString::compare() and QTextCodec::locale(). -.SH "int QString::localeAwareCompare ( const QString & s ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Compares this string with \fIs\fR. -.SH "QString QString::lower () const" -Returns a lowercase copy of the string. -.PP -.nf -.br - QString string( "TROlltECH" ); -.br - str = string.lower(); // str == "trolltech" -.br -.fi -.PP -See also upper(). -.PP -Example: scribble/scribble.cpp. -.SH "QString QString::mid ( uint index, uint len = 0xffffffff ) const" -Returns a string that contains the \fIlen\fR characters of this string, starting at position \fIindex\fR. -.PP -Returns a null string if the string is empty or \fIindex\fR is out of range. Returns the whole string from \fIindex\fR if \fIindex\fR + \fIlen\fR exceeds the length of the string. -.PP -.nf -.br - QString s( "Five pineapples" ); -.br - QString t = s.mid( 5, 4 ); // t == "pine" -.br -.fi -.PP -See also left() and right(). -.PP -Examples: -.)l network/mail/smtp.cpp, qmag/qmag.cpp, and themes/themes.cpp. -.SH "QString QString::number ( long n, int base = 10 )\fC [static]\fR" -A convenience function that returns a string equivalent of the number \fIn\fR to base \fIbase\fR, which is 10 by default and must be between 2 and 36. The returned string is in "C" locale. -.PP -.nf -.br - long a = 63; -.br - QString str = QString::number( a, 16 ); // str == "3f" -.br - QString str = QString::number( a, 16 ).upper(); // str == "3F" -.br -.fi -.PP -See also setNum(). -.PP -Examples: -.)l application/application.cpp, chart/chartform.cpp, fonts/simple-qfont-demo/viewer.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, regexptester/regexptester.cpp, and sql/overview/extract/main.cpp. -.SH "QString QString::number ( ulong n, int base = 10 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also setNum(). -.SH "QString QString::number ( TQ_LLONG n, int base = 10 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also setNum(). -.SH "QString QString::number ( TQ_ULLONG n, int base = 10 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also setNum(). -.SH "QString QString::number ( int n, int base = 10 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -See also setNum(). -.SH "QString QString::number ( uint n, int base = 10 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -A convenience factory function that returns a string representation of the number \fIn\fR to the base \fIbase\fR, which is 10 by default and must be between 2 and 36. -.PP -See also setNum(). -.SH "QString QString::number ( double n, char f = 'g', int prec = 6 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Argument \fIn\fR is formatted according to the \fIf\fR format specified, which is \fCg\fR by default, and can be any of the following: -.PP -
                                                            .nf -.TS -l - l. Format Meaning format as [-]9.9e[+|-]999 format as [-]9.9E[+|-]999 format as [-]9.9 use use -.TE -.fi -
                                                            -.PP -With 'e', 'E', and 'f', \fIprec\fR is the number of digits after the decimal point. With 'g' and 'G', \fIprec\fR is the maximum number of significant digits (trailing zeroes are omitted). -.PP -.nf -.br - double d = 12.34; -.br - QString ds = QString( "'E' format, precision 3, gives %1" ) -.br - .arg( d, 0, 'E', 3 ); -.br - // ds == "1.234E+001" -.br -.fi -.PP -See also setNum(). -.SH "QString::operator const char * () const" -Returns ascii(). Be sure to see the warnings documented in the ascii() function. Note that for new code which you wish to be strictly Unicode-clean, you can define the macro \fCQT_NO_ASCII_CAST\fR when compiling your code to hide this function so that automatic casts are not done. This has the added advantage that you catch the programming error described in operator!(). -.SH "QString::operator std::string () const" -Returns ascii() as a std::string. -.PP -\fBWarning:\fR The function may cause an application to crash if a static C run-time is in use. This can happen in Microsoft Visual C++ if Qt is configured as single-threaded. A safe alternative is to call ascii() directly and construct a std::string manually. -.SH "bool QString::operator! () const" -Returns TRUE if this is a null string; otherwise returns FALSE. -.PP -.nf -.br - QString name = getName(); -.br - if ( !name ) -.br - name = "Rodney"; -.br -.fi -.PP -Note that if you say -.PP -.nf -.br - QString name = getName(); -.br - if ( name ) -.br - doSomethingWith(name); -.br -.fi -.PP -It will call "operator const char*()", which is inefficent; you may wish to define the macro \fCQT_NO_ASCII_CAST\fR when writing code which you wish to remain Unicode-clean. -.PP -When you want the above semantics, use: -.PP -.nf -.br - QString name = getName(); -.br - if ( !name.isNull() ) -.br - doSomethingWith(name); -.br -.fi -.PP -See also isEmpty(). -.SH "QString & QString::operator+= ( const QString & str )" -Appends \fIstr\fR to the string and returns a reference to the string. -.SH "QString & QString::operator+= ( const QByteArray & str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIstr\fR to the string and returns a reference to the string. -.SH "QString & QString::operator+= ( const char * str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIstr\fR to the string and returns a reference to the string. -.SH "QString & QString::operator+= ( const std::string & str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIstr\fR to the string and returns a reference to the string. -.SH "QString & QString::operator+= ( QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIc\fR to the string and returns a reference to the string. -.SH "QString & QString::operator+= ( char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends \fIc\fR to the string and returns a reference to the string. -.SH "QString & QString::operator= ( QChar c )" -Sets the string to contain just the single character \fIc\fR. -.SH "QString & QString::operator= ( const QString & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assigns a shallow copy of \fIs\fR to this string and returns a reference to this string. This is very fast because the string isn't actually copied. -.SH "QString & QString::operator= ( const char * str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assigns a deep copy of \fIstr\fR, interpreted as a classic C string to this string and returns a reference to this string. -.PP -If \fIstr\fR is 0, then a null string is created. -.PP -See also isNull(). -.SH "QString & QString::operator= ( const std::string & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Makes a deep copy of \fIs\fR and returns a reference to the deep copy. -.SH "QString & QString::operator= ( const QCString & cstr )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assigns a deep copy of \fIcstr\fR, interpreted as a classic C string, to this string. Returns a reference to this string. -.SH "QString & QString::operator= ( char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to contain just the single character \fIc\fR. -.SH "QChar QString::operator[] ( int i ) const" -Returns the character at index \fIi\fR, or QChar::null if \fIi\fR is beyond the length of the string. -.PP -If the QString is not const (i.e., const QString) or const& (i.e., const QString&), then the non-const overload of operator[] will be used instead. -.SH "QCharRef QString::operator[] ( int i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The function returns a reference to the character at index \fIi\fR. The resulting reference can then be assigned to, or used immediately, but it will become invalid once further modifications are made to the original string. -.PP -If \fIi\fR is beyond the length of the string then the string is expanded with QChar::nulls, so that the QCharRef references a valid (null) character in the string. -.PP -The QCharRef internal class can be used much like a constant QChar, but if you assign to it, you change the original string (which will detach itself because of QString's copy-on-write semantics). You will get compilation errors if you try to use the result as anything but a QChar. -.SH "QString & QString::prepend ( const QString & s )" -Inserts \fIs\fR at the beginning of the string and returns a reference to the string. -.PP -Equivalent to insert(0, \fIs\fR). -.PP -.nf -.br - QString string = "42"; -.br - string.prepend( "The answer is " ); -.br - // string == "The answer is 42" -.br -.fi -.PP -See also insert(). -.SH "QString & QString::prepend ( char ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIch\fR at the beginning of the string and returns a reference to the string. -.PP -Equivalent to insert(0, \fIch\fR). -.PP -See also insert(). -.SH "QString & QString::prepend ( QChar ch )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIch\fR at the beginning of the string and returns a reference to the string. -.PP -Equivalent to insert(0, \fIch\fR). -.PP -See also insert(). -.SH "QString & QString::prepend ( const QByteArray & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIs\fR at the beginning of the string and returns a reference to the string. -.PP -Equivalent to insert(0, \fIs\fR). -.PP -See also insert(). -.SH "QString & QString::prepend ( const char * s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIs\fR at the beginning of the string and returns a reference to the string. -.PP -Equivalent to insert(0, \fIs\fR). -.PP -See also insert(). -.SH "QString & QString::prepend ( const std::string & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIs\fR at the beginning of the string and returns a reference to the string. -.PP -Equivalent to insert(0, \fIs\fR). -.PP -See also insert(). -.SH "QChar & QString::ref ( uint i )" -Returns the QChar at index \fIi\fR by reference, expanding the string with QChar::null if necessary. The resulting reference can be assigned to, or otherwise used immediately, but becomes invalid once furher modifications are made to the string. -.PP -.nf -.br - QString string("ABCDEF"); -.br - QChar ch = string.ref( 3 ); // ch == 'D' -.br -.fi -.PP -See also constref(). -.SH "QString & QString::remove ( uint index, uint len )" -Removes \fIlen\fR characters from the string starting at position \fIindex\fR, and returns a reference to the string. -.PP -If \fIindex\fR is beyond the length of the string, nothing happens. If \fIindex\fR is within the string, but \fIindex\fR + \fIlen\fR is beyond the end of the string, the string is truncated at position \fIindex\fR. -.PP -.nf -.br - QString string( "Montreal" ); -.br - string.remove( 1, 4 ); // string == "Meal" -.br -.fi -.PP -See also insert() and replace(). -.SH "QString & QString::remove ( const QString & str, bool cs = TRUE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes every occurrence of \fIstr\fR in the string. Returns a reference to the string. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -This is the same as replace(\fIstr\fR, "", \fIcs\fR). -.SH "QString & QString::remove ( QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes every occurrence of the character \fIc\fR in the string. Returns a reference to the string. -.PP -This is the same as replace(\fIc\fR, ""). -.SH "QString & QString::remove ( char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes every occurrence of the character \fIc\fR in the string. Returns a reference to the string. -.PP -This is the same as replace(\fIc\fR, ""). -.SH "QString & QString::remove ( const char * str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes every occurrence of \fIstr\fR in the string. Returns a reference to the string. -.SH "QString & QString::remove ( const QRegExp & rx )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes every occurrence of the regular expression \fIrx\fR in the string. Returns a reference to the string. -.PP -This is the same as replace(\fIrx\fR, ""). -.SH "QString & QString::replace ( uint index, uint len, const QString & s )" -Replaces \fIlen\fR characters from the string with \fIs\fR, starting at position \fIindex\fR, and returns a reference to the string. -.PP -If \fIindex\fR is beyond the length of the string, nothing is deleted and \fIs\fR is appended at the end of the string. If \fIindex\fR is valid, but \fIindex\fR + \fIlen\fR is beyond the end of the string, the string is truncated at position \fIindex\fR, then \fIs\fR is appended at the end. -.PP -.nf -.br - QString string( "Say yes!" ); -.br - string = string.replace( 4, 3, "NO" ); -.br - // string == "Say NO!" -.br -.fi -.PP -\fBWarning:\fR Qt 3.3.3 and earlier had different semantics for the case \fIindex\fR >= length(), which contradicted the documentation. To avoid portability problems between Qt 3 versions and with Qt 4, we recommend that you never call the function with \fIindex\fR >= length(). -.PP -See also insert() and remove(). -.PP -Examples: -.)l listviews/listviews.cpp, network/networkprotocol/nntp.cpp, qmag/qmag.cpp, and regexptester/regexptester.cpp. -.SH "QString & QString::replace ( uint index, uint len, const QChar * s, uint slen )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces \fIlen\fR characters with \fIslen\fR characters of QChar data from \fIs\fR, starting at position \fIindex\fR, and returns a reference to the string. -.PP -See also insert() and remove(). -.SH "QString & QString::replace ( uint index, uint len, QChar c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is the same as replace(\fIindex\fR, \fIlen\fR, QString(\fIc\fR)). -.SH "QString & QString::replace ( uint index, uint len, char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is the same as replace(\fIindex\fR, \fIlen\fR, QChar(\fIc\fR)). -.SH "QString & QString::replace ( QChar c, const QString & after, bool cs = TRUE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of the character \fIc\fR in the string with \fIafter\fR. Returns a reference to the string. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -Example: -.PP -.nf -.br - QString s = "a,b,c"; -.br - s.replace( QChar(','), " or " ); -.br - // s == "a or b or c" -.br -.fi -.SH "QString & QString::replace ( char c, const QString & after, bool cs = TRUE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of the character \fIc\fR in the string with \fIafter\fR. Returns a reference to the string. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.SH "QString & QString::replace ( const QString & before, const QString & after, bool cs = TRUE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of the string \fIbefore\fR in the string with the string \fIafter\fR. Returns a reference to the string. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -Example: -.PP -.nf -.br - QString s = "Greek is Greek"; -.br - s.replace( "Greek", "English" ); -.br - // s == "English is English" -.br -.fi -.SH "QString & QString::replace ( const QRegExp & rx, const QString & after )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of the regexp \fIrx\fR in the string with \fIafter\fR. Returns a reference to the string. For example: -.PP -.nf -.br - QString s = "banana"; -.br - s.replace( QRegExp("an"), "" ); -.br - // s == "ba" -.br -.fi -.PP -For regexps containing capturing parentheses, occurrences of \fB\1\fR, \fB\2\fR, ..., in \fIafter\fR are replaced with \fIrx\fR.cap(1), cap(2), ... -.PP -.nf -.br - QString t = "A bon mot."; -.br - t.replace( QRegExp("([^<]*)"), "\\\\emph{\\\\1}" ); -.br - // t == "A \\\\emph{bon mot}." -.br -.fi -.PP -See also find(), findRev(), and QRegExp::cap(). -.SH "QString & QString::replace ( QChar c1, QChar c2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of \fIc1\fR with the char \fIc2\fR. Returns a reference to the string. -.SH "void QString::reserve ( uint minCapacity )" -Ensures that at least \fIminCapacity\fR characters are allocated to the string. -.PP -This function is useful for code that needs to build up a long string and wants to avoid repeated reallocation. In this example, we want to add to the string until some condition is true, and we're fairly sure that size is big enough: -.PP -.nf -.br - QString result; -.br - int len = 0; -.br - result.reserve(maxLen); -.br - while (...) { -.br - result[len++] = ... // fill part of the space -.br - } -.br - result.squeeze(); -.br -.fi -.PP -If \fImaxLen\fR is an underestimate, the worst that will happen is that the loop will slow down. -.PP -If it is not possible to allocate enough memory, the string remains unchanged. -.PP -See also capacity(), squeeze(), and setLength(). -.SH "QString QString::right ( uint len ) const" -Returns a string that contains the \fIlen\fR rightmost characters of the string. -.PP -If \fIlen\fR is greater than the length of the string then the whole string is returned. -.PP -.nf -.br - QString string( "Pineapple" ); -.br - QString t = string.right( 5 ); // t == "apple" -.br -.fi -.PP -See also left(), mid(), and isEmpty(). -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "QString QString::rightJustify ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" -Returns a string of length \fIwidth\fR that contains the \fIfill\fR character followed by the string. -.PP -If \fItruncate\fR is FALSE and the length of the string is more than \fIwidth\fR, then the returned string is a copy of the string. -.PP -If \fItruncate\fR is TRUE and the length of the string is more than \fIwidth\fR, then the resulting string is truncated at position \fIwidth\fR. -.PP -.nf -.br - QString string( "apple" ); -.br - QString t = string.rightJustify( 8, '.' ); // t == "...apple" -.br -.fi -.PP -See also leftJustify(). -.SH "QString QString::section ( QChar sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -This function returns a section of the string. -.PP -This string is treated as a sequence of fields separated by the character, \fIsep\fR. The returned string consists of the fields from position \fIstart\fR to position \fIend\fR inclusive. If \fIend\fR is not specified, all fields from position \fIstart\fR to the end of the string are included. Fields are numbered 0, 1, 2, etc., counting from the left, and -1, -2, etc., counting from right to left. -.PP -The \fIflags\fR argument can be used to affect some aspects of the function's behaviour, e.g. whether to be case sensitive, whether to skip empty fields and how to deal with leading and trailing separators; see SectionFlags. -.PP -.nf -.br - QString csv( "forename,middlename,surname,phone" ); -.br - QString s = csv.section( ',', 2, 2 ); // s == "surname" -.br -.br - QString path( "/usr/local/bin/myapp" ); // First field is empty -.br - QString s = path.section( '/', 3, 4 ); // s == "bin/myapp" -.br - QString s = path.section( '/', 3, 3, SectionSkipEmpty ); // s == "myapp" -.br -.fi -.PP -If \fIstart\fR or \fIend\fR is negative, we count fields from the right of the string, the right-most field being -1, the one from right-most field being -2, and so on. -.PP -.nf -.br - QString csv( "forename,middlename,surname,phone" ); -.br - QString s = csv.section( ',', -3, -2 ); // s == "middlename,surname" -.br -.br - QString path( "/usr/local/bin/myapp" ); // First field is empty -.br - QString s = path.section( '/', -1 ); // s == "myapp" -.br -.fi -.PP -See also QStringList::split(). -.PP -Examples: -.)l chart/element.cpp and network/ftpclient/ftpmainwindow.ui.h. -.SH "QString QString::section ( char sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QString QString::section ( const char * sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QString QString::section ( const QString & sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function returns a section of the string. -.PP -This string is treated as a sequence of fields separated by the string, \fIsep\fR. The returned string consists of the fields from position \fIstart\fR to position \fIend\fR inclusive. If \fIend\fR is not specified, all fields from position \fIstart\fR to the end of the string are included. Fields are numbered 0, 1, 2, etc., counting from the left, and -1, -2, etc., counting from right to left. -.PP -The \fIflags\fR argument can be used to affect some aspects of the function's behaviour, e.g. whether to be case sensitive, whether to skip empty fields and how to deal with leading and trailing separators; see SectionFlags. -.PP -.nf -.br - QString data( "forename**middlename**surname**phone" ); -.br - QString s = data.section( "**", 2, 2 ); // s == "surname" -.br -.fi -.PP -If \fIstart\fR or \fIend\fR is negative, we count fields from the right of the string, the right-most field being -1, the one from right-most field being -2, and so on. -.PP -.nf -.br - QString data( "forename**middlename**surname**phone" ); -.br - QString s = data.section( "**", -3, -2 ); // s == "middlename**surname" -.br -.fi -.PP -See also QStringList::split(). -.SH "QString QString::section ( const QRegExp & reg, int start, int end = 0xffffffff, int flags = SectionDefault ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function returns a section of the string. -.PP -This string is treated as a sequence of fields separated by the regular expression, \fIreg\fR. The returned string consists of the fields from position \fIstart\fR to position \fIend\fR inclusive. If \fIend\fR is not specified, all fields from position \fIstart\fR to the end of the string are included. Fields are numbered 0, 1, 2, etc., counting from the left, and -1, -2, etc., counting from right to left. -.PP -The \fIflags\fR argument can be used to affect some aspects of the function's behaviour, e.g. whether to be case sensitive, whether to skip empty fields and how to deal with leading and trailing separators; see SectionFlags. -.PP -.nf -.br - QString line( "forename\\tmiddlename surname \\t \\t phone" ); -.br - QRegExp sep( "\\s+" ); -.br - QString s = line.section( sep, 2, 2 ); // s == "surname" -.br -.fi -.PP -If \fIstart\fR or \fIend\fR is negative, we count fields from the right of the string, the right-most field being -1, the one from right-most field being -2, and so on. -.PP -.nf -.br - QString line( "forename\\tmiddlename surname \\t \\t phone" ); -.br - QRegExp sep( "\\\\s+" ); -.br - QString s = line.section( sep, -3, -2 ); // s == "middlename surname" -.br -.fi -.PP -\fBWarning:\fR Using this QRegExp version is much more expensive than the overloaded string and character versions. -.PP -See also QStringList::split() and simplifyWhiteSpace(). -.SH "QString & QString::setAscii ( const char * str, int len = -1 )" -Sets this string to \fIstr\fR, interpreted as a classic 8-bit ASCII C string. If \fIlen\fR is -1 (the default), then it is set to strlen(str). -.PP -If \fIstr\fR is 0 a null string is created. If \fIstr\fR is "", an empty string is created. -.PP -See also isNull() and isEmpty(). -.SH "void QString::setExpand ( uint index, QChar c )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the character at position \fIindex\fR to \fIc\fR and expands the string if necessary, filling with spaces. -.PP -This method is redundant in Qt 3.x, because operator[] will expand the string as necessary. -.SH "QString & QString::setLatin1 ( const char * str, int len = -1 )" -Sets this string to \fIstr\fR, interpreted as a classic Latin-1 C string. If \fIlen\fR is -1 (the default), then it is set to strlen(str). -.PP -If \fIstr\fR is 0 a null string is created. If \fIstr\fR is "", an empty string is created. -.PP -See also isNull() and isEmpty(). -.SH "void QString::setLength ( uint newLen )" -Ensures that at least \fInewLen\fR characters are allocated to the string, and sets the length of the string to \fInewLen\fR. Any new space allocated contains arbitrary data. -.PP -See also reserve() and truncate(). -.SH "QString & QString::setNum ( TQ_LLONG n, int base = 10 )" -Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. The returned string is in "C" locale. -.PP -The base is 10 by default and must be between 2 and 36. -.PP -.nf -.br - QString string; -.br - string = string.setNum( 1234 ); // string == "1234" -.br -.fi -.SH "QString & QString::setNum ( short n, int base = 10 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. -.PP -The base is 10 by default and must be between 2 and 36. -.SH "QString & QString::setNum ( ushort n, int base = 10 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. -.PP -The base is 10 by default and must be between 2 and 36. -.SH "QString & QString::setNum ( int n, int base = 10 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. -.PP -The base is 10 by default and must be between 2 and 36. -.SH "QString & QString::setNum ( uint n, int base = 10 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. -.PP -The base is 10 by default and must be between 2 and 36. -.SH "QString & QString::setNum ( long n, int base = 10 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QString & QString::setNum ( ulong n, int base = 10 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QString & QString::setNum ( TQ_ULLONG n, int base = 10 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. -.PP -The base is 10 by default and must be between 2 and 36. -.SH "QString & QString::setNum ( float n, char f = 'g', int prec = 6 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the printed value of \fIn\fR, formatted in format \fIf\fR with precision \fIprec\fR, and returns a reference to the string. -.PP -The format \fIf\fR can be 'f', 'F', 'e', 'E', 'g' or 'G'. See arg() for an explanation of the formats. -.SH "QString & QString::setNum ( double n, char f = 'g', int prec = 6 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the string to the printed value of \fIn\fR, formatted in format \fIf\fR with precision \fIprec\fR, and returns a reference to the string. -.PP -The format \fIf\fR can be 'f', 'F', 'e', 'E', 'g' or 'G'. See arg() for an explanation of the formats. -.SH "QString & QString::setUnicode ( const QChar * unicode, uint len )" -Resizes the string to \fIlen\fR characters and copies \fIunicode\fR into the string. If \fIunicode\fR is 0, nothing is copied, but the string is still resized to \fIlen\fR. If \fIlen\fR is zero, then the string becomes a null string. -.PP -See also setLatin1() and isNull(). -.SH "QString & QString::setUnicodeCodes ( const ushort * unicode_as_ushorts, uint len )" -Resizes the string to \fIlen\fR characters and copies \fIunicode_as_ushorts\fR into the string (on some X11 client platforms this will involve a byte-swapping pass). -.PP -If \fIunicode_as_ushorts\fR is 0, nothing is copied, but the string is still resized to \fIlen\fR. If \fIlen\fR is zero, the string becomes a null string. -.PP -See also setLatin1() and isNull(). -.SH "QString QString::simplifyWhiteSpace () const" -Returns a string that has whitespace removed from the start and the end, and which has each sequence of internal whitespace replaced with a single space. -.PP -Whitespace means any character for which QChar::isSpace() returns TRUE. This includes Unicode characters with decimal values 9 (TAB), 10 (LF), 11 (VT), 12 (FF), 13 (CR), and 32 (Space). -.PP -.nf -.br - QString string = " lots\\t of\\nwhite space "; -.br - QString t = string.simplifyWhiteSpace(); -.br - // t == "lots of white space" -.br -.fi -.PP -See also stripWhiteSpace(). -.SH "QString & QString::sprintf ( const char * cformat, ... )" -Safely builds a formatted string from the format string \fIcformat\fR and an arbitrary list of arguments. The format string supports all the escape sequences of printf() in the standard C library. -.PP -The %s escape sequence expects a utf8() encoded string. The format string \fIcformat\fR is expected to be in latin1. If you need a Unicode format string, use arg() instead. For typesafe string building, with full Unicode support, you can use QTextOStream like this: -.PP -.nf -.br - QString str; -.br - QString s = ...; -.br - int x = ...; -.br - QTextOStream( &str ) << s << " : " << x; -.br -.fi -.PP -For translations, especially if the strings contains more than one escape sequence, you should consider using the arg() function instead. This allows the order of the replacements to be controlled by the translator, and has Unicode support. -.PP -The %lc escape sequence expects a unicode character of type ushort (as returned by QChar::unicode()). The %ls escape sequence expects a pointer to a zero-terminated array of unicode characters of type ushort (as returned by QString::ucs2()). -.PP -See also arg(). -.PP -Examples: -.)l dclock/dclock.cpp, forever/forever.cpp, layout/layout.cpp, qmag/qmag.cpp, scrollview/scrollview.cpp, tooltip/tooltip.cpp, and xform/xform.cpp. -.SH "void QString::squeeze ()" -Squeezes the string's capacity to the current content. -.PP -See also capacity() and reserve(). -.SH "bool QString::startsWith ( const QString & s, bool cs = TRUE ) const" -Returns TRUE if the string starts with \fIs\fR; otherwise returns FALSE. -.PP -If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. -.PP -.nf -.br - QString str( "Bananas" ); -.br - str.startsWith( "Ban" ); // returns TRUE -.br - str.startsWith( "Car" ); // returns FALSE -.br -.fi -.PP -See also endsWith(). -.SH "QString QString::stripWhiteSpace () const" -Returns a string that has whitespace removed from the start and the end. -.PP -Whitespace means any character for which QChar::isSpace() returns TRUE. This includes Unicode characters with decimal values 9 (TAB), 10 (LF), 11 (VT), 12 (FF), 13 (CR) and 32 (Space), and may also include other Unicode characters. -.PP -.nf -.br - QString string = " white space "; -.br - QString s = string.stripWhiteSpace(); // s == "white space" -.br -.fi -.PP -See also simplifyWhiteSpace(). -.SH "double QString::toDouble ( bool * ok = 0 ) const" -Returns the string converted to a \fCdouble\fR value. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -.nf -.br - QString string( "1234.56" ); -.br - double a = string.toDouble(); // a == 1234.56 -.br -.fi -.PP -The string-to-number functions: -.TP -toShort() -.TP -toUShort() -.TP -toInt() -.TP -toUInt() -.TP -toLong() -.TP -toULong() -.TP -toLongLong() -.TP -toULongLong() -.TP -toFloat() -.TP -toDouble() can handle numbers represented in various locales. These representations may use different characters for the decimal point, thousands group sepearator and even individual digits. QString's functions try to interpret the string according to the current locale. The current locale is determined from the system at application startup and can be changed by calling QLocale::setDefault(). If the string cannot be interpreted according to the current locale, this function falls back on the "C" locale. -.PP -.nf -.br - bool ok; -.br - double d; -.br -.br - QLocale::setDefault(QLocale::C); -.br - d = QString( "1234,56" ).toDouble(&ok); // ok == false -.br - d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 -.br -.br - QLocale::setDefault(QLocale::German); -.br - d = QString( "1234,56" ).toDouble(&ok); // ok == true, d == 1234.56 -.br - d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 -.br -.fi -.PP -Due to the ambiguity between the decimal point and thousands group separator in various locales, these functions do not handle thousands group separators. If you need to convert such numbers, use the corresponding function in QLocale. -.PP -.nf -.br - bool ok; -.br - QLocale::setDefault(QLocale::C); -.br - double d = QString( "1,234,567.89" ).toDouble(&ok); // ok == false -.br -.fi -.PP -\fBWarning:\fR If the string contains trailing whitespace this function will fail, and set \fI*ok\fR to false if \fIok\fR is not 0. Leading whitespace is ignored. -.PP -See also number(), QLocale::setDefault(), QLocale::toDouble(), and stripWhiteSpace(). -.SH "float QString::toFloat ( bool * ok = 0 ) const" -Returns the string converted to a \fCfloat\fR value. -.PP -Returns 0.0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -\fBWarning:\fR If the string contains trailing whitespace this function will fail, settings \fI*ok\fR to false if \fIok\fR is not 0. Leading whitespace is ignored. -.PP -See also number(). -.SH "int QString::toInt ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to an \fCint\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -.nf -.br - QString str( "FF" ); -.br - bool ok; -.br - int hex = str.toInt( &ok, 16 ); // hex == 255, ok == TRUE -.br - int dec = str.toInt( &ok, 10 ); // dec == 0, ok == FALSE -.br -.fi -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "long QString::toLong ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to a \fClong\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "TQ_LLONG QString::toLongLong ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to a \fClong long\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "short QString::toShort ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to a \fCshort\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "uint QString::toUInt ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to an \fCunsigned int\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "ulong QString::toULong ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to an \fCunsigned long\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "TQ_ULLONG QString::toULongLong ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to an \fCunsigned long long\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "ushort QString::toUShort ( bool * ok = 0, int base = 10 ) const" -Returns the string converted to an \fCunsigned short\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: -.TP -If the string begins with "0x", it is assumed to be hexadecimal; -.TP -If it begins with "0", it is assumed to be octal; -.TP -Otherwise it is assumed to be decimal. -.PP -Returns 0 if the conversion fails. -.PP -If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. -.PP -Leading and trailing whitespace is ignored by this function. -.PP -For information on how string-to-number functions in QString handle localized input, see toDouble(). -.PP -See also number(). -.SH "void QString::truncate ( uint newLen )" -If \fInewLen\fR is less than the length of the string, then the string is truncated at position \fInewLen\fR. Otherwise nothing happens. -.PP -.nf -.br - QString s = "truncate me"; -.br - s.truncate( 5 ); // s == "trunc" -.br -.fi -.PP -See also setLength(). -.PP -Example: network/mail/smtp.cpp. -.SH "const unsigned short * QString::ucs2 () const" -Returns the QString as a zero terminated array of unsigned shorts if the string is not null; otherwise returns zero. -.PP -The result remains valid so long as one unmodified copy of the source string exists. -.PP -Example: dotnet/wrapper/lib/tools.cpp. -.SH "const QChar * QString::unicode () const" -Returns the Unicode representation of the string. The result remains valid until the string is modified. -.SH "QString QString::upper () const" -Returns an uppercase copy of the string. -.PP -.nf -.br - QString string( "TeXt" ); -.br - str = string.upper(); // t == "TEXT" -.br -.fi -.PP -See also lower(). -.PP -Examples: -.)l scribble/scribble.cpp and sql/overview/custom1/main.cpp. -.SH "QCString QString::utf8 () const" -Returns the string encoded in UTF-8 format. -.PP -See QTextCodec for more diverse coding/decoding of Unicode strings. -.PP -See also fromUtf8(), ascii(), latin1(), and local8Bit(). -.PP -Example: network/archivesearch/archivedialog.ui.h. -.SH RELATED FUNCTION DOCUMENTATION -.SH "bool operator!= ( const QString & s1, const QString & s2 )" -Returns TRUE if \fIs1\fR is not equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) != 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator!= ( const QString & s1, const char * s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is not equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) != 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator!= ( const char * s1, const QString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is not equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) != 0. -.PP -See also isNull() and isEmpty(). -.SH "const QString operator+ ( const QString & s1, const QString & s2 )" -Returns a string which is the result of concatenating the string \fIs1\fR and the string \fIs2\fR. -.PP -Equivalent to \fIs1\fR.append(\fIs2\fR). -.SH "const QString operator+ ( const QString & s1, const char * s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which is the result of concatenating the string \fIs1\fR and character \fIs2\fR. -.PP -Equivalent to \fIs1\fR.append(\fIs2\fR). -.SH "const QString operator+ ( const char * s1, const QString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which is the result of concatenating the character \fIs1\fR and string \fIs2\fR. -.SH "const QString operator+ ( const QString & s, char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which is the result of concatenating the string \fIs\fR and character \fIc\fR. -.PP -Equivalent to \fIs\fR.append(\fIc\fR). -.SH "const QString operator+ ( char c, const QString & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a string which is the result of concatenating the character \fIc\fR and string \fIs\fR. -.PP -Equivalent to \fIs\fR.prepend(\fIc\fR). -.SH "bool operator< ( const QString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is lexically less than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) < 0. -.SH "bool operator< ( const char * s1, const QString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is lexically less than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) < 0. -.SH "QDataStream & operator<< ( QDataStream & s, const QString & str )" -Writes the string \fIstr\fR to the stream \fIs\fR. -.PP -See also Format of the QDataStream operators -.SH "bool operator<= ( const QString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is lexically less than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR,\fIs2\fR) <= 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator<= ( const char * s1, const QString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is lexically less than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) <= 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator== ( const QString & s1, const QString & s2 )" -Returns TRUE if \fIs1\fR is equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) == 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator== ( const QString & s1, const char * s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) == 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator== ( const char * s1, const QString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) == 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator> ( const QString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is lexically greater than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) > 0. -.SH "bool operator> ( const char * s1, const QString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is lexically greater than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) > 0. -.SH "bool operator>= ( const QString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is lexically greater than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) >= 0. -.PP -See also isNull() and isEmpty(). -.SH "bool operator>= ( const char * s1, const QString & s2 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if \fIs1\fR is lexically greater than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. -.PP -Equivalent to compare(\fIs1\fR, \fIs2\fR) >= 0. -.PP -See also isNull() and isEmpty(). -.SH "QDataStream & operator>> ( QDataStream & s, QString & str )" -Reads a string from the stream \fIs\fR into string \fIstr\fR. -.PP -See also Format of the QDataStream operators - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstring.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstring.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstringlist.3qt b/doc/man/man3/qstringlist.3qt deleted file mode 100644 index 03cc75a9f..000000000 --- a/doc/man/man3/qstringlist.3qt +++ /dev/null @@ -1,336 +0,0 @@ -'\" t -.TH QStringList 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 -QStringList \- List of strings -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                                            -.PP -\fC#include \fR -.PP -Inherits QValueList. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStringList\fR ()" -.br -.ti -1c -.BI "\fBQStringList\fR ( const QStringList & l )" -.br -.ti -1c -.BI "\fBQStringList\fR ( const QValueList & l )" -.br -.ti -1c -.BI "\fBQStringList\fR ( const QString & i )" -.br -.ti -1c -.BI "\fBQStringList\fR ( const char * i )" -.br -.ti -1c -.BI "void \fBsort\fR ()" -.br -.ti -1c -.BI "QString \fBjoin\fR ( const QString & sep ) const" -.br -.ti -1c -.BI "QStringList \fBgrep\fR ( const QString & str, bool cs = TRUE ) const" -.br -.ti -1c -.BI "QStringList \fBgrep\fR ( const QRegExp & rx ) const" -.br -.ti -1c -.BI "QStringList & \fBgres\fR ( const QString & before, const QString & after, bool cs = TRUE )" -.br -.ti -1c -.BI "QStringList & \fBgres\fR ( const QRegExp & rx, const QString & after )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QStringList \fBfromStrList\fR ( const QStrList & ascii )" -.br -.ti -1c -.BI "QStringList \fBsplit\fR ( const QString & sep, const QString & str, bool allowEmptyEntries = FALSE )" -.br -.ti -1c -.BI "QStringList \fBsplit\fR ( const QChar & sep, const QString & str, bool allowEmptyEntries = FALSE )" -.br -.ti -1c -.BI "QStringList \fBsplit\fR ( const QRegExp & sep, const QString & str, bool allowEmptyEntries = FALSE )" -.br -.in -1c -.SH DESCRIPTION -The QStringList class provides a list of strings. -.PP -It is used to store and manipulate strings that logically belong together. Essentially QStringList is a QValueList of QString objects. Unlike QStrList, which stores pointers to characters, QStringList holds real QString objects. It is the class of choice whenever you work with Unicode strings. QStringList is part of the Qt Template Library. -.PP -Like QString itself, QStringList objects are implicitly shared, so passing them around as value-parameters is both fast and safe. -.PP -Strings can be added to a list using append(), operator+=() or operator<<(), e.g. -.PP -.nf -.br - QStringList fonts; -.br - fonts.append( "Times" ); -.br - fonts += "Courier"; -.br - fonts += "Courier New"; -.br - fonts << "Helvetica [Cronyx]" << "Helvetica [Adobe]"; -.br -.fi -.PP -String lists have an iterator, QStringList::Iterator(), e.g. -.PP -.nf -.br - for ( QStringList::Iterator it = fonts.begin(); it != fonts.end(); ++it ) { -.br - cout << *it << ":"; -.br - } -.br - cout << endl; -.br - // Output: -.br - // Times:Courier:Courier New:Helvetica [Cronyx]:Helvetica [Adobe]: -.br -.fi -.PP -Many Qt functions return string lists by value; to iterate over these you should make a copy and iterate over the copy. -.PP -You can concatenate all the strings in a string list into a single string (with an optional separator) using join(), e.g. -.PP -.nf -.br - QString allFonts = fonts.join( ", " ); -.br - cout << allFonts << endl; -.br - // Output: -.br - // Times, Courier, Courier New, Helvetica [Cronyx], Helvetica [Adobe] -.br -.fi -.PP -You can sort the list with sort(), and extract a new list which contains only those strings which contain a particular substring (or match a particular regular expression) using the grep() functions, e.g. -.PP -.nf -.br - fonts.sort(); -.br - cout << fonts.join( ", " ) << endl; -.br - // Output: -.br - // Courier, Courier New, Helvetica [Adobe], Helvetica [Cronyx], Times -.br -.br - QStringList helveticas = fonts.grep( "Helvetica" ); -.br - cout << helveticas.join( ", " ) << endl; -.br - // Output: -.br - // Helvetica [Adobe], Helvetica [Cronyx] -.br -.fi -.PP -Existing strings can be split into string lists with character, string or regular expression separators, e.g. -.PP -.nf -.br - QString s = "Red\\tGreen\\tBlue"; -.br - QStringList colors = QStringList::split( "\\t", s ); -.br - cout << colors.join( ", " ) << endl; -.br - // Output: -.br - // Red, Green, Blue -.br -.fi -.PP -See also Implicitly and Explicitly Shared Classes, Text Related Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStringList::QStringList ()" -Creates an empty string list. -.SH "QStringList::QStringList ( const QStringList & l )" -Creates a copy of the list \fIl\fR. This function is very fast because QStringList is implicitly shared. In most situations this acts like a deep copy, for example, if this list or the original one or some other list referencing the same shared data is modified, the modifying list first makes a copy, i.e. copy-on-write. In a threaded environment you may require a real deep copy -. -.SH "QStringList::QStringList ( const QValueList & l )" -Constructs a new string list that is a copy of \fIl\fR. -.SH "QStringList::QStringList ( const QString & i )" -Constructs a string list consisting of the single string \fIi\fR. Longer lists are easily created as follows: -.PP -.nf -.br - QStringList items; -.br - items << "Buy" << "Sell" << "Update" << "Value"; -.br -.fi -.SH "QStringList::QStringList ( const char * i )" -Constructs a string list consisting of the single Latin-1 string \fIi\fR. -.SH "QStringList QStringList::fromStrList ( const QStrList & ascii )\fC [static]\fR" -Converts from an ASCII-QStrList \fIascii\fR to a QStringList (Unicode). -.SH "QStringList QStringList::grep ( const QString & str, bool cs = TRUE ) const" -Returns a list of all the strings containing the substring \fIstr\fR. -.PP -If \fIcs\fR is TRUE, the grep is done case-sensitively; otherwise case is ignored. -.PP -.nf -.br - QStringList list; -.br - list << "Bill Gates" << "John Doe" << "Bill Clinton"; -.br - list = list.grep( "Bill" ); -.br - // list == ["Bill Gates", "Bill Clinton"] -.br -.fi -.PP -See also QString::find(). -.SH "QStringList QStringList::grep ( const QRegExp & rx ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a list of all the strings that match the regular expression \fIrx\fR. -.PP -See also QString::find(). -.SH "QStringList & QStringList::gres ( const QString & before, const QString & after, bool cs = TRUE )" -Replaces every occurrence of the string \fIbefore\fR in the strings that constitute the string list with the string \fIafter\fR. Returns a reference to the string list. -.PP -If \fIcs\fR is TRUE, the search is case sensitive; otherwise the search is case insensitive. -.PP -Example: -.PP -.nf -.br - QStringList list; -.br - list << "alpha" << "beta" << "gamma" << "epsilon"; -.br - list.gres( "a", "o" ); -.br - // list == ["olpho", "beto", "gommo", "epsilon"] -.br -.fi -.PP -See also QString::replace(). -.SH "QStringList & QStringList::gres ( const QRegExp & rx, const QString & after )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Replaces every occurrence of the regexp \fIrx\fR in the string with \fIafter\fR. Returns a reference to the string list. -.PP -Example: -.PP -.nf -.br - QStringList list; -.br - list << "alpha" << "beta" << "gamma" << "epsilon"; -.br - list.gres( QRegExp("^a"), "o" ); -.br - // list == ["olpha", "beta", "gamma", "epsilon"] -.br -.fi -.PP -For regexps containing capturing parentheses, occurrences of \fB\1\fR, \fB\2\fR, ..., in \fIafter\fR are replaced with \fIrx\fR.cap(1), cap(2), ... -.PP -Example: -.PP -.nf -.br - QStringList list; -.br - list << "Bill Clinton" << "Gates, Bill"; -.br - list.gres( QRegExp("^(.*), (.*)$"), "\\\\2 \\\\1" ); -.br - // list == ["Bill Clinton", "Bill Gates"] -.br -.fi -.PP -See also QString::replace(). -.SH "QString QStringList::join ( const QString & sep ) const" -Joins the string list into a single string with each element separated by the string \fIsep\fR (which can be empty). -.PP -See also split(). -.PP -Examples: -.)l fileiconview/qfileiconview.cpp and toplevel/options.ui.h. -.SH "void QStringList::sort ()" -Sorts the list of strings in ascending case-sensitive order. -.PP -Sorting is very fast. It uses the Qt Template Library's efficient HeapSort implementation that has a time complexity of O(n*log n). -.PP -If you want to sort your strings in an arbitrary order consider using a QMap. For example you could use a QMap to create a case-insensitive ordering (e.g. mapping the lowercase text to the text), or a QMap to sort the strings by some integer index, etc. -.PP -Example: themes/themes.cpp. -.SH "QStringList QStringList::split ( const QRegExp & sep, const QString & str, bool allowEmptyEntries = FALSE )\fC [static]\fR" -Splits the string \fIstr\fR into strings wherever the regular expression \fIsep\fR occurs, and returns the list of those strings. -.PP -If \fIallowEmptyEntries\fR is TRUE, a null string is inserted in the list wherever the separator matches twice without intervening text. -.PP -For example, if you split the string "a,,b,c" on commas, split() returns the three-item list "a", "b", "c" if \fIallowEmptyEntries\fR is FALSE (the default), and the four-item list "a", "", "b", "c" if \fIallowEmptyEntries\fR is TRUE. -.PP -If \fIsep\fR does not match anywhere in \fIstr\fR, split() returns a single element list with the element containing the single string \fIstr\fR. -.PP -See also join() and QString::section(). -.PP -Examples: -.)l chart/element.cpp, dirview/dirview.cpp, and network/httpd/httpd.cpp. -.SH "QStringList QStringList::split ( const QString & sep, const QString & str, bool allowEmptyEntries = FALSE )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version of the function uses a QString as separator, rather than a regular expression. -.PP -If \fIsep\fR is an empty string, the return value is a list of one-character strings: split( QString( "" ), "four" ) returns the four-item list, "f", "o", "u", "r". -.PP -If \fIallowEmptyEntries\fR is TRUE, a null string is inserted in the list wherever the separator matches twice without intervening text. -.PP -See also join() and QString::section(). -.SH "QStringList QStringList::split ( const QChar & sep, const QString & str, bool allowEmptyEntries = FALSE )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version of the function uses a QChar as separator, rather than a regular expression. -.PP -See also join() and QString::section(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstringlist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstringlist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstrlist.3qt b/doc/man/man3/qstrlist.3qt deleted file mode 100644 index ca3f52beb..000000000 --- a/doc/man/man3/qstrlist.3qt +++ /dev/null @@ -1,92 +0,0 @@ -'\" t -.TH QStrList 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 -QStrList \- Doubly-linked list of char* -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrList. -.PP -Inherited by QStrIList. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStrList\fR ( bool deepCopies = TRUE )" -.br -.ti -1c -.BI "\fBQStrList\fR ( const QStrList & list )" -.br -.ti -1c -.BI "\fB~QStrList\fR ()" -.br -.ti -1c -.BI "QStrList & \fBoperator=\fR ( const QStrList & list )" -.br -.in -1c -.SH DESCRIPTION -The QStrList class provides a doubly-linked list of char*. -.PP -If you want a string list of QStrings use QStringList. -.PP -This class is a QPtrList instance (a list of char*). -.PP -QStrList can make deep or shallow copies of the strings that are inserted. -.PP -A deep copy means that memory is allocated for the string and then the string data is copied into that memory. A shallow copy is just a copy of the pointer value and not of the string data itself. -.PP -The disadvantage of shallow copies is that because a pointer can be deleted only once, the program must put all strings in a central place and know when it is safe to delete them (i.e. when the strings are no longer referenced by other parts of the program). This can make the program more complex. The advantage of shallow copies is that they consume far less memory than deep copies. It is also much faster to copy a pointer (typically 4 or 8 bytes) than to copy string data. -.PP -A QStrList that operates on deep copies will, by default, turn on auto-deletion (see setAutoDelete()). Thus, by default QStrList will deallocate any string copies it allocates. -.PP -The virtual compareItems() function is reimplemented and does a case-sensitive string comparison. The inSort() function will insert strings in sorted order. In general it is fastest to insert the strings as they come and sort() at the end; inSort() is useful when you just have to add a few extra strings to an already sorted list. -.PP -The QStrListIterator class is an iterator for QStrList. -.PP -See also Collection Classes, Text Related Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStrList::QStrList ( bool deepCopies = TRUE )" -Constructs an empty list of strings. Will make deep copies of all inserted strings if \fIdeepCopies\fR is TRUE, or use shallow copies if \fIdeepCopies\fR is FALSE. -.SH "QStrList::QStrList ( const QStrList & list )" -Constructs a copy of \fIlist\fR. -.PP -If \fIlist\fR has deep copies, this list will also get deep copies. Only the pointers are copied (shallow copy) if the other list does not use deep copies. -.SH "QStrList::~QStrList ()" -Destroys the list. All strings are removed. -.SH "QStrList & QStrList::operator= ( const QStrList & list )" -Assigns \fIlist\fR to this list and returns a reference to this list. -.PP -If \fIlist\fR has deep copies, this list will also get deep copies. -Only the pointers are copied (shallow copy) if the other list does -not use deep copies. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstrlist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstrlist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstrlistiterator.3qt b/doc/man/man3/qstrlistiterator.3qt deleted file mode 100644 index 5a4b67194..000000000 --- a/doc/man/man3/qstrlistiterator.3qt +++ /dev/null @@ -1,46 +0,0 @@ -'\" t -.TH QStrListIterator 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 -QStrListIterator \- Iterator for the QStrList and QStrIList classes -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QPtrListIterator. -.PP -.SH DESCRIPTION -The QStrListIterator class is an iterator for the QStrList and QStrIList classes. -.PP -This class is a QPtrListIterator instance. It can traverse the strings in the QStrList and QStrIList classes. -.PP -See also Non-GUI Classes. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qstrlistiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstrlistiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstyle.3qt b/doc/man/man3/qstyle.3qt deleted file mode 100644 index a1471b082..000000000 --- a/doc/man/man3/qstyle.3qt +++ /dev/null @@ -1,1089 +0,0 @@ -'\" t -.TH QStyle 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 -QStyle \- The look and feel of a GUI -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -Inherited by QCommonStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStyle\fR ()" -.br -.ti -1c -.BI "virtual \fB~QStyle\fR ()" -.br -.ti -1c -.BI "virtual void \fBpolish\fR ( QWidget * )" -.br -.ti -1c -.BI "virtual void \fBunPolish\fR ( QWidget * )" -.br -.ti -1c -.BI "virtual void \fBpolish\fR ( QApplication * )" -.br -.ti -1c -.BI "virtual void \fBunPolish\fR ( QApplication * )" -.br -.ti -1c -.BI "virtual void \fBpolish\fR ( QPalette & )" -.br -.ti -1c -.BI "virtual void \fBpolishPopupMenu\fR ( QPopupMenu * ) = 0" -.br -.ti -1c -.BI "virtual QRect \fBitemRect\fR ( QPainter * p, const QRect & r, int flags, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1 ) const" -.br -.ti -1c -.BI "virtual void \fBdrawItem\fR ( QPainter * p, const QRect & r, int flags, const QColorGroup & g, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1, const QColor * penColor = 0 ) const" -.br -.ti -1c -.BI "enum \fBPrimitiveElement\fR { PE_ButtonCommand, PE_ButtonDefault, PE_ButtonBevel, PE_ButtonTool, PE_ButtonDropDown, PE_FocusRect, PE_ArrowUp, PE_ArrowDown, PE_ArrowRight, PE_ArrowLeft, PE_SpinWidgetUp, PE_SpinWidgetDown, PE_SpinWidgetPlus, PE_SpinWidgetMinus, PE_Indicator, PE_IndicatorMask, PE_ExclusiveIndicator, PE_ExclusiveIndicatorMask, PE_DockWindowHandle, PE_DockWindowSeparator, PE_DockWindowResizeHandle, PE_Splitter, PE_Panel, PE_PanelPopup, PE_PanelMenuBar, PE_PanelDockWindow, PE_TabBarBase, PE_HeaderSection, PE_HeaderArrow, PE_StatusBarSection, PE_GroupBoxFrame, PE_Separator, PE_SizeGrip, PE_CheckMark, PE_ScrollBarAddLine, PE_ScrollBarSubLine, PE_ScrollBarAddPage, PE_ScrollBarSubPage, PE_ScrollBarSlider, PE_ScrollBarFirst, PE_ScrollBarLast, PE_ProgressBarChunk, PE_PanelLineEdit, PE_PanelTabWidget, PE_WindowFrame, PE_CheckListController, PE_CheckListIndicator, PE_CheckListExclusiveIndicator, PE_PanelGroupBox, PE_RubberBand, PE_CustomBase = 0xf000000 }" -.br -.ti -1c -.BI "enum \fBStyleFlags\fR { Style_Default = 0x00000000, Style_Enabled = 0x00000001, Style_Raised = 0x00000002, Style_Sunken = 0x00000004, Style_Off = 0x00000008, Style_NoChange = 0x00000010, Style_On = 0x00000020, Style_Down = 0x00000040, Style_Horizontal = 0x00000080, Style_HasFocus = 0x00000100, Style_Top = 0x00000200, Style_Bottom = 0x00000400, Style_FocusAtBorder = 0x00000800, Style_AutoRaise = 0x00001000, Style_MouseOver = 0x00002000, Style_Up = 0x00004000, Style_Selected = 0x00008000, Style_Active = 0x00010000, Style_ButtonDefault = 0x00020000 }" -.br -.ti -1c -.BI "virtual void \fBdrawPrimitive\fR ( PrimitiveElement pe, QPainter * p, const QRect & r, const QColorGroup & cg, SFlags flags = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "enum \fBControlElement\fR { CE_PushButton, CE_PushButtonLabel, CE_CheckBox, CE_CheckBoxLabel, CE_RadioButton, CE_RadioButtonLabel, CE_TabBarTab, CE_TabBarLabel, CE_ProgressBarGroove, CE_ProgressBarContents, CE_ProgressBarLabel, CE_PopupMenuItem, CE_MenuBarItem, CE_ToolButtonLabel, CE_MenuBarEmptyArea, CE_PopupMenuScroller, CE_DockWindowEmptyArea, CE_PopupMenuVerticalExtra, CE_PopupMenuHorizontalExtra, CE_ToolBoxTab, CE_HeaderLabel, CE_CustomBase = 0xf0000000 }" -.br -.ti -1c -.BI "virtual void \fBdrawControl\fR ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "virtual void \fBdrawControlMask\fR ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "enum \fBSubRect\fR { SR_PushButtonContents, SR_PushButtonFocusRect, SR_CheckBoxIndicator, SR_CheckBoxContents, SR_CheckBoxFocusRect, SR_RadioButtonIndicator, SR_RadioButtonContents, SR_RadioButtonFocusRect, SR_ComboBoxFocusRect, SR_SliderFocusRect, SR_DockWindowHandleRect, SR_ProgressBarGroove, SR_ProgressBarContents, SR_ProgressBarLabel, SR_ToolButtonContents, SR_DialogButtonAccept, SR_DialogButtonReject, SR_DialogButtonApply, SR_DialogButtonHelp, SR_DialogButtonAll, SR_DialogButtonAbort, SR_DialogButtonIgnore, SR_DialogButtonRetry, SR_DialogButtonCustom, SR_ToolBoxTabContents, SR_CustomBase = 0xf0000000 }" -.br -.ti -1c -.BI "virtual QRect \fBsubRect\fR ( SubRect subrect, const QWidget * widget ) const = 0" -.br -.ti -1c -.BI "enum \fBComplexControl\fR { CC_SpinWidget, CC_ComboBox, CC_ScrollBar, CC_Slider, CC_ToolButton, CC_TitleBar, CC_ListView, CC_CustomBase = 0xf0000000 }" -.br -.ti -1c -.BI "enum \fBSubControl\fR { SC_None = 0x00000000, SC_ScrollBarAddLine = 0x00000001, SC_ScrollBarSubLine = 0x00000002, SC_ScrollBarAddPage = 0x00000004, SC_ScrollBarSubPage = 0x00000008, SC_ScrollBarFirst = 0x00000010, SC_ScrollBarLast = 0x00000020, SC_ScrollBarSlider = 0x00000040, SC_ScrollBarGroove = 0x00000080, SC_SpinWidgetUp = 0x00000001, SC_SpinWidgetDown = 0x00000002, SC_SpinWidgetFrame = 0x00000004, SC_SpinWidgetEditField = 0x00000008, SC_SpinWidgetButtonField = 0x00000010, SC_ComboBoxFrame = 0x00000001, SC_ComboBoxEditField = 0x00000002, SC_ComboBoxArrow = 0x00000004, SC_ComboBoxListBoxPopup = 0x00000008, SC_SliderGroove = 0x00000001, SC_SliderHandle = 0x00000002, SC_SliderTickmarks = 0x00000004, SC_ToolButton = 0x00000001, SC_ToolButtonMenu = 0x00000002, SC_TitleBarLabel = 0x00000001, SC_TitleBarSysMenu = 0x00000002, SC_TitleBarMinButton = 0x00000004, SC_TitleBarMaxButton = 0x00000008, SC_TitleBarCloseButton = 0x00000010, SC_TitleBarNormalButton = 0x00000020, SC_TitleBarShadeButton = 0x00000040, SC_TitleBarUnshadeButton = 0x00000080, SC_ListView = 0x00000001, SC_ListViewBranch = 0x00000002, SC_ListViewExpand = 0x00000004, SC_All = 0xffffffff }" -.br -.ti -1c -.BI "virtual void \fBdrawComplexControl\fR ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, SCFlags sub = SC_All, SCFlags subActive = SC_None, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "virtual void \fBdrawComplexControlMask\fR ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "virtual QRect \fBquerySubControlMetrics\fR ( ComplexControl control, const QWidget * widget, SubControl subcontrol, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "virtual SubControl \fBquerySubControl\fR ( ComplexControl control, const QWidget * widget, const QPoint & pos, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "enum \fBPixelMetric\fR { PM_ButtonMargin, PM_ButtonDefaultIndicator, PM_MenuButtonIndicator, PM_ButtonShiftHorizontal, PM_ButtonShiftVertical, PM_DefaultFrameWidth, PM_SpinBoxFrameWidth, PM_MaximumDragDistance, PM_ScrollBarExtent, PM_ScrollBarSliderMin, PM_SliderThickness, PM_SliderControlThickness, PM_SliderLength, PM_SliderTickmarkOffset, PM_SliderSpaceAvailable, PM_DockWindowSeparatorExtent, PM_DockWindowHandleExtent, PM_DockWindowFrameWidth, PM_MenuBarFrameWidth, PM_TabBarTabOverlap, PM_TabBarTabHSpace, PM_TabBarTabVSpace, PM_TabBarBaseHeight, PM_TabBarBaseOverlap, PM_ProgressBarChunkWidth, PM_SplitterWidth, PM_TitleBarHeight, PM_IndicatorWidth, PM_IndicatorHeight, PM_ExclusiveIndicatorWidth, PM_ExclusiveIndicatorHeight, PM_PopupMenuScrollerHeight, PM_CheckListButtonSize, PM_CheckListControllerSize, PM_PopupMenuFrameHorizontalExtra, PM_PopupMenuFrameVerticalExtra, PM_DialogButtonsSeparator, PM_DialogButtonsButtonWidth, PM_DialogButtonsButtonHeight, PM_MDIFrameWidth, PM_MDIMinimizedWidth, PM_HeaderMargin, PM_HeaderMarkSize, PM_HeaderGripMargin, PM_TabBarTabShiftHorizontal, PM_TabBarTabShiftVertical, PM_TabBarScrollButtonWidth, PM_MenuBarItemSpacing, PM_ToolBarItemSpacing, PM_CustomBase = 0xf0000000 }" -.br -.ti -1c -.BI "virtual int \fBpixelMetric\fR ( PixelMetric metric, const QWidget * widget = 0 ) const = 0" -.br -.ti -1c -.BI "enum \fBContentsType\fR { CT_PushButton, CT_CheckBox, CT_RadioButton, CT_ToolButton, CT_ComboBox, CT_Splitter, CT_DockWindow, CT_ProgressBar, CT_PopupMenuItem, CT_TabBarTab, CT_Slider, CT_Header, CT_LineEdit, CT_MenuBar, CT_SpinBox, CT_SizeGrip, CT_TabWidget, CT_DialogButtons, CT_CustomBase = 0xf0000000 }" -.br -.ti -1c -.BI "virtual QSize \fBsizeFromContents\fR ( ContentsType contents, const QWidget * widget, const QSize & contentsSize, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "enum \fBStyleHint\fR { SH_EtchDisabledText, SH_GUIStyle, SH_ScrollBar_BackgroundMode, SH_ScrollBar_MiddleClickAbsolutePosition, SH_ScrollBar_ScrollWhenPointerLeavesControl, SH_TabBar_SelectMouseType, SH_TabBar_Alignment, SH_Header_ArrowAlignment, SH_Slider_SnapToValue, SH_Slider_SloppyKeyEvents, SH_ProgressDialog_CenterCancelButton, SH_ProgressDialog_TextLabelAlignment, SH_PrintDialog_RightAlignButtons, SH_MainWindow_SpaceBelowMenuBar, SH_FontDialog_SelectAssociatedText, SH_PopupMenu_AllowActiveAndDisabled, SH_PopupMenu_SpaceActivatesItem, SH_PopupMenu_SubMenuPopupDelay, SH_ScrollView_FrameOnlyAroundContents, SH_MenuBar_AltKeyNavigation, SH_ComboBox_ListMouseTracking, SH_PopupMenu_MouseTracking, SH_MenuBar_MouseTracking, SH_ItemView_ChangeHighlightOnFocus, SH_Widget_ShareActivation, SH_Workspace_FillSpaceOnMaximize, SH_ComboBox_Popup, SH_TitleBar_NoBorder, SH_ScrollBar_StopMouseOverSlider, SH_BlinkCursorWhenTextSelected, SH_RichText_FullWidthSelection, SH_PopupMenu_Scrollable, SH_GroupBox_TextLabelVerticalAlignment, SH_GroupBox_TextLabelColor, SH_PopupMenu_SloppySubMenus, SH_Table_GridLineColor, SH_LineEdit_PasswordCharacter, SH_DialogButtons_DefaultButton, SH_ToolBox_SelectedPageTitleBold, SH_TabBar_PreferNoArrows, SH_ScrollBar_LeftClickAbsolutePosition, SH_ListViewExpand_SelectMouseType, SH_UnderlineAccelerator, SH_ToolButton_Uses3D, SH_CustomBase = 0xf0000000 }" -.br -.ti -1c -.BI "virtual int \fBstyleHint\fR ( StyleHint stylehint, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default, QStyleHintReturn * returnData = 0 ) const = 0" -.br -.ti -1c -.BI "enum \fBStylePixmap\fR { SP_TitleBarMinButton, SP_TitleBarMaxButton, SP_TitleBarCloseButton, SP_TitleBarNormalButton, SP_TitleBarShadeButton, SP_TitleBarUnshadeButton, SP_DockWindowCloseButton, SP_MessageBoxInformation, SP_MessageBoxWarning, SP_MessageBoxCritical, SP_MessageBoxQuestion, SP_CustomBase = 0xf0000000 }" -.br -.ti -1c -.BI "virtual QPixmap \fBstylePixmap\fR ( StylePixmap stylepixmap, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default ) const = 0" -.br -.ti -1c -.BI "int defaultFrameWidth () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void tabbarMetrics ( const QWidget * t, int & hf, int & vf, int & ov ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QSize scrollBarExtent () const \fI(obsolete)\fR" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QRect \fBvisualRect\fR ( const QRect & logical, const QWidget * w )" -.br -.ti -1c -.BI "QRect \fBvisualRect\fR ( const QRect & logical, const QRect & bounding )" -.br -.in -1c -.SH DESCRIPTION -The QStyle class specifies the look and feel of a GUI. -.PP -A large number of GUI elements are common to many widgets. The QStyle class allows the look of these elements to be modified across all widgets that use the QStyle functions. It also provides two feel options: Motif and Windows. -.PP -Although it is not possible to fully enumerate the look of graphical elements and the feel of widgets in a GUI, QStyle provides a considerable amount of control and customisability. -.PP -In Qt 1.x the look and feel option for widgets was specified by a single value: the GUIStyle. Starting with Qt 2.0, this notion was expanded to allow the look to be specified by virtual drawing functions. -.PP -Derived classes may reimplement some or all of the drawing functions to modify the look of all widgets that use those functions. -.PP -Languages written from right to left (such as Arabic and Hebrew) usually also mirror the whole layout of widgets. If you design a style, you should take special care when drawing asymmetric elements to make sure that they also look correct in a mirrored layout. You can start your application with \fC-reverse\fR to check the mirrored layout. Also notice, that for a reversed layout, the light usually comes from top right instead of top left. -.PP -The actual reverse layout is performed automatically when possible. However, for the sake of flexibility, the translation cannot be performed everywhere. The documentation for each function in the QStyle API states whether the function expects/returns logical or screen coordinates. Using logical coordinates (in ComplexControls, for example) provides great flexibility in controlling the look of a widget. Use visualRect() when necessary to translate logical coordinates into screen coordinates for drawing. -.PP -In Qt versions prior to 3.0, if you wanted a low level route into changing the appearance of a widget, you would reimplement polish(). With the new 3.0 style engine the recommended approach is to reimplement the draw functions, for example drawItem(), drawPrimitive(), drawControl(), drawControlMask(), drawComplexControl() and drawComplexControlMask(). Each of these functions is called with a range of parameters that provide information that you can use to determine how to draw them, e.g. style flags, rectangle, color group, etc. -.PP -For information on changing elements of an existing style or creating your own style see the Style overview. -.PP -Styles can also be created as plugins. -.PP -See also Widget Appearance and Style. -.SS "Member Type Documentation" -.SH "QStyle::ComplexControl" -This enum represents a ComplexControl. ComplexControls have different behaviour depending upon where the user clicks on them or which keys are pressed. -.TP -\fCQStyle::CC_SpinWidget\fR -.TP -\fCQStyle::CC_ComboBox\fR -.TP -\fCQStyle::CC_ScrollBar\fR -.TP -\fCQStyle::CC_Slider\fR -.TP -\fCQStyle::CC_ToolButton\fR -.TP -\fCQStyle::CC_TitleBar\fR -.TP -\fCQStyle::CC_ListView\fR -.TP -\fCQStyle::CC_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. -.PP -See also SubControl and drawComplexControl(). -.SH "QStyle::ContentsType" -This enum represents a ContentsType. It is used to calculate sizes for the contents of various widgets. -.TP -\fCQStyle::CT_PushButton\fR -.TP -\fCQStyle::CT_CheckBox\fR -.TP -\fCQStyle::CT_RadioButton\fR -.TP -\fCQStyle::CT_ToolButton\fR -.TP -\fCQStyle::CT_ComboBox\fR -.TP -\fCQStyle::CT_Splitter\fR -.TP -\fCQStyle::CT_DockWindow\fR -.TP -\fCQStyle::CT_ProgressBar\fR -.TP -\fCQStyle::CT_PopupMenuItem\fR -.TP -\fCQStyle::CT_TabBarTab\fR -.TP -\fCQStyle::CT_Slider\fR -.TP -\fCQStyle::CT_Header\fR -.TP -\fCQStyle::CT_LineEdit\fR -.TP -\fCQStyle::CT_MenuBar\fR -.TP -\fCQStyle::CT_SpinBox\fR -.TP -\fCQStyle::CT_SizeGrip\fR -.TP -\fCQStyle::CT_TabWidget\fR -.TP -\fCQStyle::CT_DialogButtons\fR -.TP -\fCQStyle::CT_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Custom values must be greater than this value. -.PP -See also sizeFromContents(). -.SH "QStyle::ControlElement" -This enum represents a ControlElement. A ControlElement is part of a widget that performs some action or displays information to the user. -.TP -\fCQStyle::CE_PushButton\fR - the bevel and default indicator of a QPushButton. -.TP -\fCQStyle::CE_PushButtonLabel\fR - the label (iconset with text or pixmap) of a QPushButton. -.TP -\fCQStyle::CE_CheckBox\fR - the indicator of a QCheckBox. -.TP -\fCQStyle::CE_CheckBoxLabel\fR - the label (text or pixmap) of a QCheckBox. -.TP -\fCQStyle::CE_RadioButton\fR - the indicator of a QRadioButton. -.TP -\fCQStyle::CE_RadioButtonLabel\fR - the label (text or pixmap) of a QRadioButton. -.TP -\fCQStyle::CE_TabBarTab\fR - the tab within a QTabBar (a QTab). -.TP -\fCQStyle::CE_TabBarLabel\fR - the label within a QTab. -.TP -\fCQStyle::CE_ProgressBarGroove\fR - the groove where the progress indicator is drawn in a QProgressBar. -.TP -\fCQStyle::CE_ProgressBarContents\fR - the progress indicator of a QProgressBar. -.TP -\fCQStyle::CE_ProgressBarLabel\fR - the text label of a QProgressBar. -.TP -\fCQStyle::CE_PopupMenuItem\fR - a menu item in a QPopupMenu. -.TP -\fCQStyle::CE_PopupMenuScroller\fR - scrolling areas in a popumenu when the style supports scrolling. -.TP -\fCQStyle::CE_PopupMenuHorizontalExtra\fR - extra frame area set aside with PM_PopupMenuFrameHorizontalExtra -.TP -\fCQStyle::CE_PopupMenuVerticalExtra\fR - extra frame area set aside with PM_PopupMenuFrameVerticalExtra -.TP -\fCQStyle::CE_MenuBarItem\fR - a menu item in a QMenuBar. -.TP -\fCQStyle::CE_ToolButtonLabel\fR - a tool button's label. -.TP -\fCQStyle::CE_MenuBarEmptyArea\fR - the empty area of a QMenuBar. -.TP -\fCQStyle::CE_DockWindowEmptyArea\fR - the empty area of a QDockWindow. -.TP -\fCQStyle::CE_ToolBoxTab\fR - the toolbox's tab area -.TP -\fCQStyle::CE_HeaderLabel\fR - the header's label -.TP -\fCQStyle::CE_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. -.PP -See also drawControl(). -.SH "QStyle::PixelMetric" -This enum represents a PixelMetric. A PixelMetric is a style dependent size represented as a single pixel value. -.TP -\fCQStyle::PM_ButtonMargin\fR - amount of whitespace between pushbutton labels and the frame. -.TP -\fCQStyle::PM_ButtonDefaultIndicator\fR - width of the default-button indicator frame. -.TP -\fCQStyle::PM_MenuButtonIndicator\fR - width of the menu button indicator proportional to the widget height. -.TP -\fCQStyle::PM_ButtonShiftHorizontal\fR - horizontal contents shift of a button when the button is down. -.TP -\fCQStyle::PM_ButtonShiftVertical\fR - vertical contents shift of a button when the button is down. -.TP -\fCQStyle::PM_DefaultFrameWidth\fR - default frame width, usually 2. -.TP -\fCQStyle::PM_SpinBoxFrameWidth\fR - frame width of a spin box. -.TP -\fCQStyle::PM_MDIFrameWidth\fR - frame width of an MDI window. -.TP -\fCQStyle::PM_MDIMinimizedWidth\fR - width of a minimized MSI window. -.TP -\fCQStyle::PM_MaximumDragDistance\fR - Some feels require the scrollbar or other sliders to jump back to the original position when the mouse pointer is too far away while dragging. A value of -1 disables this behavior. -.TP -\fCQStyle::PM_ScrollBarExtent\fR - width of a vertical scrollbar and the height of a horizontal scrollbar. -.TP -\fCQStyle::PM_ScrollBarSliderMin\fR - the minimum height of a vertical scrollbar's slider and the minimum width of a horiztonal scrollbar slider. -.TP -\fCQStyle::PM_SliderThickness\fR - total slider thickness. -.TP -\fCQStyle::PM_SliderControlThickness\fR - thickness of the slider handle. -.TP -\fCQStyle::PM_SliderLength\fR - length of the slider. -.TP -\fCQStyle::PM_SliderTickmarkOffset\fR - the offset between the tickmarks and the slider. -.TP -\fCQStyle::PM_SliderSpaceAvailable\fR - the available space for the slider to move. -.TP -\fCQStyle::PM_DockWindowSeparatorExtent\fR - width of a separator in a horiztonal dock window and the height of a separator in a vertical dock window. -.TP -\fCQStyle::PM_DockWindowHandleExtent\fR - width of the handle in a horizontal dock window and the height of the handle in a vertical dock window. -.TP -\fCQStyle::PM_DockWindowFrameWidth\fR - frame width of a dock window. -.TP -\fCQStyle::PM_MenuBarFrameWidth\fR - frame width of a menubar. -.TP -\fCQStyle::PM_MenuBarItemSpacing\fR - spacing between menubar items. -.TP -\fCQStyle::PM_ToolBarItemSpacing\fR - spacing between toolbar items. -.TP -\fCQStyle::PM_TabBarTabOverlap\fR - number of pixels the tabs should overlap. -.TP -\fCQStyle::PM_TabBarTabHSpace\fR - extra space added to the tab width. -.TP -\fCQStyle::PM_TabBarTabVSpace\fR - extra space added to the tab height. -.TP -\fCQStyle::PM_TabBarBaseHeight\fR - height of the area between the tab bar and the tab pages. -.TP -\fCQStyle::PM_TabBarBaseOverlap\fR - number of pixels the tab bar overlaps the tab bar base. -.TP -\fCQStyle::PM_TabBarScrollButtonWidth\fR -.TP -\fCQStyle::PM_TabBarTabShiftHorizontal\fR - horizontal pixel shift when a tab is selected. -.TP -\fCQStyle::PM_TabBarTabShiftVertical\fR - vertical pixel shift when a tab is selected. -.TP -\fCQStyle::PM_ProgressBarChunkWidth\fR - width of a chunk in a progress bar indicator. -.TP -\fCQStyle::PM_SplitterWidth\fR - width of a splitter. -.TP -\fCQStyle::PM_TitleBarHeight\fR - height of the title bar. -.TP -\fCQStyle::PM_PopupMenuFrameHorizontalExtra\fR - additional border, e.g. for panels -.TP -\fCQStyle::PM_PopupMenuFrameVerticalExtra\fR - additional border, e.g. for panels -.TP -\fCQStyle::PM_IndicatorWidth\fR - width of a check box indicator. -.TP -\fCQStyle::PM_IndicatorHeight\fR - height of a checkbox indicator. -.TP -\fCQStyle::PM_ExclusiveIndicatorWidth\fR - width of a radio button indicator. -.TP -\fCQStyle::PM_ExclusiveIndicatorHeight\fR - height of a radio button indicator. -.TP -\fCQStyle::PM_PopupMenuScrollerHeight\fR - height of the scroller area in a popupmenu. -.TP -\fCQStyle::PM_PopupMenuScrollerHeight\fR - height of the scroller area in a popupmenu. -.TP -\fCQStyle::PM_CheckListButtonSize\fR - area (width/height) of the checkbox/radiobutton in a QCheckListItem -.TP -\fCQStyle::PM_CheckListControllerSize\fR - area (width/height) of the controller in a QCheckListItem -.TP -\fCQStyle::PM_DialogButtonsSeparator\fR - distance between buttons in a dialog buttons widget. -.TP -\fCQStyle::PM_DialogButtonsButtonWidth\fR - minimum width of a button in a dialog buttons widget. -.TP -\fCQStyle::PM_DialogButtonsButtonHeight\fR - minimum height of a button in a dialog buttons widget. -.TP -\fCQStyle::PM_HeaderMarkSize\fR -.TP -\fCQStyle::PM_HeaderGripMargin\fR -.TP -\fCQStyle::PM_HeaderMargin\fR -.TP -\fCQStyle::PM_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. -.PP -See also pixelMetric(). -.SH "QStyle::PrimitiveElement" -This enum represents the PrimitiveElements of a style. A PrimitiveElement is a common GUI element, such as a checkbox indicator or pushbutton bevel. -.TP -\fCQStyle::PE_ButtonCommand\fR - button used to initiate an action, for example, a QPushButton. -.TP -\fCQStyle::PE_ButtonDefault\fR - this button is the default button, e.g. in a dialog. -.TP -\fCQStyle::PE_ButtonBevel\fR - generic button bevel. -.TP -\fCQStyle::PE_ButtonTool\fR - tool button, for example, a QToolButton. -.TP -\fCQStyle::PE_ButtonDropDown\fR - drop down button, for example, a tool button that displays a popup menu, for example, QPopupMenu. -.TP -\fCQStyle::PE_FocusRect\fR - generic focus indicator. -.TP -\fCQStyle::PE_ArrowUp\fR - up arrow. -.TP -\fCQStyle::PE_ArrowDown\fR - down arrow. -.TP -\fCQStyle::PE_ArrowRight\fR - right arrow. -.TP -\fCQStyle::PE_ArrowLeft\fR - left arrow. -.TP -\fCQStyle::PE_SpinWidgetUp\fR - up symbol for a spin widget, for example a QSpinBox. -.TP -\fCQStyle::PE_SpinWidgetDown\fR - down symbol for a spin widget. -.TP -\fCQStyle::PE_SpinWidgetPlus\fR - increase symbol for a spin widget. -.TP -\fCQStyle::PE_SpinWidgetMinus\fR - decrease symbol for a spin widget. -.TP -\fCQStyle::PE_Indicator\fR - on/off indicator, for example, a QCheckBox. -.TP -\fCQStyle::PE_IndicatorMask\fR - bitmap mask for an indicator. -.TP -\fCQStyle::PE_ExclusiveIndicator\fR - exclusive on/off indicator, for example, a QRadioButton. -.TP -\fCQStyle::PE_ExclusiveIndicatorMask\fR - bitmap mask for an exclusive indicator. -.TP -\fCQStyle::PE_DockWindowHandle\fR - tear off handle for dock windows and toolbars, for example QDockWindows and QToolBars. -.TP -\fCQStyle::PE_DockWindowSeparator\fR - item separator for dock window and toolbar contents. -.TP -\fCQStyle::PE_DockWindowResizeHandle\fR - resize handle for dock windows. -.TP -\fCQStyle::PE_Splitter\fR - splitter handle; see also QSplitter. -.TP -\fCQStyle::PE_Panel\fR - generic panel frame; see also QFrame. -.TP -\fCQStyle::PE_PanelPopup\fR - panel frame for popup windows/menus; see also QPopupMenu. -.TP -\fCQStyle::PE_PanelMenuBar\fR - panel frame for menu bars. -.TP -\fCQStyle::PE_PanelDockWindow\fR - panel frame for dock windows and toolbars. -.TP -\fCQStyle::PE_PanelTabWidget\fR - panel frame for tab widgets. -.TP -\fCQStyle::PE_PanelLineEdit\fR - panel frame for line edits. -.TP -\fCQStyle::PE_PanelGroupBox\fR - panel frame for group boxes. -.TP -\fCQStyle::PE_TabBarBase\fR - area below tabs in a tab widget, for example, QTab. -.TP -\fCQStyle::PE_HeaderSection\fR - section of a list or table header; see also QHeader. -.TP -\fCQStyle::PE_HeaderArrow\fR - arrow used to indicate sorting on a list or table header -.TP -\fCQStyle::PE_StatusBarSection\fR - section of a status bar; see also QStatusBar. -.TP -\fCQStyle::PE_GroupBoxFrame\fR - frame around a group box; see also QGroupBox. -.TP -\fCQStyle::PE_WindowFrame\fR - frame around a MDI window or a docking window -.TP -\fCQStyle::PE_Separator\fR - generic separator. -.TP -\fCQStyle::PE_SizeGrip\fR - window resize handle; see also QSizeGrip. -.TP -\fCQStyle::PE_CheckMark\fR - generic check mark; see also QCheckBox. -.TP -\fCQStyle::PE_ScrollBarAddLine\fR - scrollbar line increase indicator (i.e. scroll down); see also QScrollBar. -.TP -\fCQStyle::PE_ScrollBarSubLine\fR - scrollbar line decrease indicator (i.e. scroll up). -.TP -\fCQStyle::PE_ScrollBarAddPage\fR - scolllbar page increase indicator (i.e. page down). -.TP -\fCQStyle::PE_ScrollBarSubPage\fR - scrollbar page decrease indicator (i.e. page up). -.TP -\fCQStyle::PE_ScrollBarSlider\fR - scrollbar slider -.TP -\fCQStyle::PE_ScrollBarFirst\fR - scrollbar first line indicator (i.e. home). -.TP -\fCQStyle::PE_ScrollBarLast\fR - scrollbar last line indicator (i.e. end). -.TP -\fCQStyle::PE_ProgressBarChunk\fR - section of a progress bar indicator; see also QProgressBar. -.TP -\fCQStyle::PE_CheckListController\fR - controller part of a listview item -.TP -\fCQStyle::PE_CheckListIndicator\fR - checkbox part of a listview item -.TP -\fCQStyle::PE_CheckListExclusiveIndicator\fR - radiobutton part of a listview item -.TP -\fCQStyle::PE_RubberBand\fR - rubber band used in such things as iconview -.TP -\fCQStyle::PE_CustomBase\fR - base value for custom PrimitiveElements. All values above this are reserved for custom use. Custom values must be greater than this value. -.PP -See also drawPrimitive(). -.SH "QStyle::StyleFlags" -This enum represents flags for drawing PrimitiveElements. Not all primitives use all of these flags. Note that these flags may mean different things to different primitives. For an explanation of the relationship between primitives and their flags, as well as the different meanings of the flags, see the Style overview. -.TP -\fCQStyle::Style_Default\fR -.TP -\fCQStyle::Style_Enabled\fR -.TP -\fCQStyle::Style_Raised\fR -.TP -\fCQStyle::Style_Sunken\fR -.TP -\fCQStyle::Style_Off\fR -.TP -\fCQStyle::Style_NoChange\fR -.TP -\fCQStyle::Style_On\fR -.TP -\fCQStyle::Style_Down\fR -.TP -\fCQStyle::Style_Horizontal\fR -.TP -\fCQStyle::Style_HasFocus\fR -.TP -\fCQStyle::Style_Top\fR -.TP -\fCQStyle::Style_Bottom\fR -.TP -\fCQStyle::Style_FocusAtBorder\fR -.TP -\fCQStyle::Style_AutoRaise\fR -.TP -\fCQStyle::Style_MouseOver\fR -.TP -\fCQStyle::Style_Up\fR -.TP -\fCQStyle::Style_Selected\fR -.TP -\fCQStyle::Style_HasFocus\fR -.TP -\fCQStyle::Style_Active\fR -.TP -\fCQStyle::Style_ButtonDefault\fR -.PP -See also drawPrimitive(). -.SH "QStyle::StyleHint" -This enum represents a StyleHint. A StyleHint is a general look and/or feel hint. -.TP -\fCQStyle::SH_EtchDisabledText\fR - disabled text is "etched" like Windows. -.TP -\fCQStyle::SH_GUIStyle\fR - the GUI style to use. -.TP -\fCQStyle::SH_ScrollBar_BackgroundMode\fR - the background mode for a QScrollBar. Possible values are any of those in the BackgroundMode enum. -.TP -\fCQStyle::SH_ScrollBar_MiddleClickAbsolutePosition\fR - a boolean value. If TRUE, middle clicking on a scrollbar causes the slider to jump to that position. If FALSE, the middle clicking is ignored. -.TP -\fCQStyle::SH_ScrollBar_LeftClickAbsolutePosition\fR - a boolean value. If TRUE, left clicking on a scrollbar causes the slider to jump to that position. If FALSE, the left clicking will behave as appropriate for each control. -.TP -\fCQStyle::SH_ScrollBar_ScrollWhenPointerLeavesControl\fR - a boolean value. If TRUE, when clicking a scrollbar SubControl, holding the mouse button down and moving the pointer outside the SubControl, the scrollbar continues to scroll. If FALSE, the scollbar stops scrolling when the pointer leaves the SubControl. -.TP -\fCQStyle::SH_TabBar_Alignment\fR - the alignment for tabs in a QTabWidget. Possible values are Qt::AlignLeft, Qt::AlignCenter and Qt::AlignRight. -.TP -\fCQStyle::SH_Header_ArrowAlignment\fR - the placement of the sorting indicator may appear in list or table headers. Possible values are Qt::Left or Qt::Right. -.TP -\fCQStyle::SH_Slider_SnapToValue\fR - sliders snap to values while moving, like Windows -.TP -\fCQStyle::SH_Slider_SloppyKeyEvents\fR - key presses handled in a sloppy manner, i.e. left on a vertical slider subtracts a line. -.TP -\fCQStyle::SH_ProgressDialog_CenterCancelButton\fR - center button on progress dialogs, like Motif, otherwise right aligned. -.TP -\fCQStyle::SH_ProgressDialog_TextLabelAlignment\fR - Qt::AlignmentFlags -- text label alignment in progress dialogs; Center on windows, Auto|VCenter otherwise. -.TP -\fCQStyle::SH_PrintDialog_RightAlignButtons\fR - right align buttons in the print dialog, like Windows. -.TP -\fCQStyle::SH_MainWindow_SpaceBelowMenuBar\fR - 1 or 2 pixel space between the menubar and the dockarea, like Windows. -.TP -\fCQStyle::SH_FontDialog_SelectAssociatedText\fR - select the text in the line edit, or when selecting an item from the listbox, or when the line edit receives focus, like Windows. -.TP -\fCQStyle::SH_PopupMenu_AllowActiveAndDisabled\fR - allows disabled menu items to be active. -.TP -\fCQStyle::SH_PopupMenu_SpaceActivatesItem\fR - pressing Space activates the item, like Motif. -.TP -\fCQStyle::SH_PopupMenu_SubMenuPopupDelay\fR - the number of milliseconds to wait before opening a submenu; 256 on windows, 96 on Motif. -.TP -\fCQStyle::SH_PopupMenu_Scrollable\fR - whether popupmenu's must support scrolling. -.TP -\fCQStyle::SH_PopupMenu_SloppySubMenus\fR - whether popupmenu's must support sloppy submenu; as implemented on Mac OS. -.TP -\fCQStyle::SH_ScrollView_FrameOnlyAroundContents\fR - whether scrollviews draw their frame only around contents (like Motif), or around contents, scrollbars and corner widgets (like Windows). -.TP -\fCQStyle::SH_MenuBar_AltKeyNavigation\fR - menubars items are navigable by pressing Alt, followed by using the arrow keys to select the desired item. -.TP -\fCQStyle::SH_ComboBox_ListMouseTracking\fR - mouse tracking in combobox dropdown lists. -.TP -\fCQStyle::SH_PopupMenu_MouseTracking\fR - mouse tracking in popup menus. -.TP -\fCQStyle::SH_MenuBar_MouseTracking\fR - mouse tracking in menubars. -.TP -\fCQStyle::SH_ItemView_ChangeHighlightOnFocus\fR - gray out selected items when losing focus. -.TP -\fCQStyle::SH_Widget_ShareActivation\fR - turn on sharing activation with floating modeless dialogs. -.TP -\fCQStyle::SH_TabBar_SelectMouseType\fR - which type of mouse event should cause a tab to be selected. -.TP -\fCQStyle::SH_ListViewExpand_SelectMouseType\fR - which type of mouse event should cause a listview expansion to be selected. -.TP -\fCQStyle::SH_TabBar_PreferNoArrows\fR - whether a tabbar should suggest a size to prevent scoll arrows. -.TP -\fCQStyle::SH_ComboBox_Popup\fR - allows popups as a combobox dropdown menu. -.TP -\fCQStyle::SH_Workspace_FillSpaceOnMaximize\fR - the workspace should maximize the client area. -.TP -\fCQStyle::SH_TitleBar_NoBorder\fR - the titlebar has no border -.TP -\fCQStyle::SH_ScrollBar_StopMouseOverSlider\fR - stops autorepeat when slider reaches mouse -.TP -\fCQStyle::SH_BlinkCursorWhenTextSelected\fR - whether cursor should blink when text is selected -.TP -\fCQStyle::SH_RichText_FullWidthSelection\fR - whether richtext selections should extend the full width of the document. -.TP -\fCQStyle::SH_GroupBox_TextLabelVerticalAlignment\fR - how to vertically align a groupbox's text label. -.TP -\fCQStyle::SH_GroupBox_TextLabelColor\fR - how to paint a groupbox's text label. -.TP -\fCQStyle::SH_DialogButtons_DefaultButton\fR - which buttons gets the default status in a dialog's button widget. -.TP -\fCQStyle::SH_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. -.TP -\fCQStyle::SH_ToolButton_Uses3D\fR - indicates whether QToolButtons should use a 3D frame when the mouse is over them -.TP -\fCQStyle::SH_ToolBox_SelectedPageTitleBold\fR - Boldness of the selected page title in a QToolBox. -.TP -\fCQStyle::SH_LineEdit_PasswordCharacter\fR - The QChar Unicode character to be used for passwords. -.TP -\fCQStyle::SH_Table_GridLineColor\fR -.TP -\fCQStyle::SH_UnderlineAccelerator\fR - whether accelerators are underlined -.PP -See also styleHint(). -.SH "QStyle::StylePixmap" -This enum represents a StylePixmap. A StylePixmap is a pixmap that can follow some existing GUI style or guideline. -.TP -\fCQStyle::SP_TitleBarMinButton\fR - minimize button on titlebars. For example, in a QWorkspace. -.TP -\fCQStyle::SP_TitleBarMaxButton\fR - maximize button on titlebars. -.TP -\fCQStyle::SP_TitleBarCloseButton\fR - close button on titlebars. -.TP -\fCQStyle::SP_TitleBarNormalButton\fR - normal (restore) button on titlebars. -.TP -\fCQStyle::SP_TitleBarShadeButton\fR - shade button on titlebars. -.TP -\fCQStyle::SP_TitleBarUnshadeButton\fR - unshade button on titlebars. -.TP -\fCQStyle::SP_MessageBoxInformation\fR - the 'information' icon. -.TP -\fCQStyle::SP_MessageBoxWarning\fR - the 'warning' icon. -.TP -\fCQStyle::SP_MessageBoxCritical\fR - the 'critical' icon. -.TP -\fCQStyle::SP_MessageBoxQuestion\fR - the 'question' icon. -.TP -\fCQStyle::SP_DockWindowCloseButton\fR - close button on dock windows; see also QDockWindow. -.TP -\fCQStyle::SP_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. -.PP -See also stylePixmap(). -.SH "QStyle::SubControl" -This enum represents a SubControl within a ComplexControl. -.TP -\fCQStyle::SC_None\fR - special value that matches no other SubControl. -.TP -\fCQStyle::SC_ScrollBarAddLine\fR - scrollbar add line (i.e. down/right arrow); see also QScrollbar. -.TP -\fCQStyle::SC_ScrollBarSubLine\fR - scrollbar sub line (i.e. up/left arrow). -.TP -\fCQStyle::SC_ScrollBarAddPage\fR - scrollbar add page (i.e. page down). -.TP -\fCQStyle::SC_ScrollBarSubPage\fR - scrollbar sub page (i.e. page up). -.TP -\fCQStyle::SC_ScrollBarFirst\fR - scrollbar first line (i.e. home). -.TP -\fCQStyle::SC_ScrollBarLast\fR - scrollbar last line (i.e. end). -.TP -\fCQStyle::SC_ScrollBarSlider\fR - scrollbar slider handle. -.TP -\fCQStyle::SC_ScrollBarGroove\fR - special subcontrol which contains the area in which the slider handle may move. -.TP -\fCQStyle::SC_SpinWidgetUp\fR - spinwidget up/increase; see also QSpinBox. -.TP -\fCQStyle::SC_SpinWidgetDown\fR - spinwidget down/decrease. -.TP -\fCQStyle::SC_SpinWidgetFrame\fR - spinwidget frame. -.TP -\fCQStyle::SC_SpinWidgetEditField\fR - spinwidget edit field. -.TP -\fCQStyle::SC_SpinWidgetButtonField\fR - spinwidget button field. -.TP -\fCQStyle::SC_ComboBoxEditField\fR - combobox edit field; see also QComboBox. -.TP -\fCQStyle::SC_ComboBoxArrow\fR - combobox arrow -.TP -\fCQStyle::SC_ComboBoxFrame\fR - combobox frame -.TP -\fCQStyle::SC_ComboBoxListBoxPopup\fR - combobox list box -.TP -\fCQStyle::SC_SliderGroove\fR - special subcontrol which contains the area in which the slider handle may move. -.TP -\fCQStyle::SC_SliderHandle\fR - slider handle. -.TP -\fCQStyle::SC_SliderTickmarks\fR - slider tickmarks. -.TP -\fCQStyle::SC_ToolButton\fR - tool button; see also QToolbutton. -.TP -\fCQStyle::SC_ToolButtonMenu\fR - subcontrol for opening a popup menu in a tool button; see also QPopupMenu. -.TP -\fCQStyle::SC_TitleBarSysMenu\fR - system menu button (i.e. restore, close, etc.). -.TP -\fCQStyle::SC_TitleBarMinButton\fR - minimize button. -.TP -\fCQStyle::SC_TitleBarMaxButton\fR - maximize button. -.TP -\fCQStyle::SC_TitleBarCloseButton\fR - close button. -.TP -\fCQStyle::SC_TitleBarLabel\fR - window title label. -.TP -\fCQStyle::SC_TitleBarNormalButton\fR - normal (restore) button. -.TP -\fCQStyle::SC_TitleBarShadeButton\fR - shade button. -.TP -\fCQStyle::SC_TitleBarUnshadeButton\fR - unshade button. -.TP -\fCQStyle::SC_ListView\fR - the list view area. -.TP -\fCQStyle::SC_ListViewBranch\fR - (internal) -.TP -\fCQStyle::SC_ListViewExpand\fR - expand item (i.e. show/hide child items). -.TP -\fCQStyle::SC_All\fR - special value that matches all SubControls. -.PP -See also ComplexControl. -.SH "QStyle::SubRect" -This enum represents a sub-area of a widget. Style implementations would use these areas to draw the different parts of a widget. -.TP -\fCQStyle::SR_PushButtonContents\fR - area containing the label (iconset with text or pixmap). -.TP -\fCQStyle::SR_PushButtonFocusRect\fR - area for the focus rect (usually larger than the contents rect). -.TP -\fCQStyle::SR_CheckBoxIndicator\fR - area for the state indicator (e.g. check mark). -.TP -\fCQStyle::SR_CheckBoxContents\fR - area for the label (text or pixmap). -.TP -\fCQStyle::SR_CheckBoxFocusRect\fR - area for the focus indicator. -.TP -\fCQStyle::SR_RadioButtonIndicator\fR - area for the state indicator. -.TP -\fCQStyle::SR_RadioButtonContents\fR - area for the label. -.TP -\fCQStyle::SR_RadioButtonFocusRect\fR - area for the focus indicator. -.TP -\fCQStyle::SR_ComboBoxFocusRect\fR - area for the focus indicator. -.TP -\fCQStyle::SR_SliderFocusRect\fR - area for the focus indicator. -.TP -\fCQStyle::SR_DockWindowHandleRect\fR - area for the tear-off handle. -.TP -\fCQStyle::SR_ProgressBarGroove\fR - area for the groove. -.TP -\fCQStyle::SR_ProgressBarContents\fR - area for the progress indicator. -.TP -\fCQStyle::SR_ProgressBarLabel\fR - area for the text label. -.TP -\fCQStyle::SR_ToolButtonContents\fR - area for the tool button's label. -.TP -\fCQStyle::SR_DialogButtonAccept\fR - area for a dialog's accept button. -.TP -\fCQStyle::SR_DialogButtonReject\fR - area for a dialog's reject button. -.TP -\fCQStyle::SR_DialogButtonApply\fR - area for a dialog's apply button. -.TP -\fCQStyle::SR_DialogButtonHelp\fR - area for a dialog's help button. -.TP -\fCQStyle::SR_DialogButtonAll\fR - area for a dialog's all button. -.TP -\fCQStyle::SR_DialogButtonRetry\fR - area for a dialog's retry button. -.TP -\fCQStyle::SR_DialogButtonAbort\fR - area for a dialog's abort button. -.TP -\fCQStyle::SR_DialogButtonIgnore\fR - area for a dialog's ignore button. -.TP -\fCQStyle::SR_DialogButtonCustom\fR - area for a dialog's custom widget area (in button row). -.TP -\fCQStyle::SR_ToolBoxTabContents\fR - area for a toolbox tab's icon and label -.TP -\fCQStyle::SR_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. -.PP -See also subRect(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStyle::QStyle ()" -Constructs a QStyle. -.SH "QStyle::~QStyle ()\fC [virtual]\fR" -Destroys the style and frees all allocated resources. -.SH "int QStyle::defaultFrameWidth () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QStyle::drawComplexControl ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, SCFlags sub = SC_All, SCFlags subActive = SC_None, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Draws the ComplexControl \fIcontrol\fR using the painter \fIp\fR in the area \fIr\fR. Colors are used from the color group \fIcg\fR. The \fIsub\fR argument specifies which SubControls to draw. Multiple SubControls can be OR'ed together. The \fIsubActive\fR argument specifies which SubControl is active. -.PP -The rect \fIr\fR should be in logical coordinates. Reimplementations of this function should use visualRect() to change the logical coordinates into screen coordinates when using drawPrimitive() and drawControl(). -.PP -The \fIhow\fR argument is used to control how the ComplexControl is drawn. Multiple flags can OR'ed together. See the table below for an explanation of which flags are used with the various ComplexControls. -.PP -The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontrol\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ComplexControl. Note that \fIopt\fR may be the default value even for ComplexControls that can make use of the extra options. See the table below for the appropriate \fIwidget\fR and \fIopt\fR usage: -.PP -
                                                            .nf -.TS -l - l. ComplexControl -.br -& Widget Cast Style Flags Notes Options Notes CC_SpinWidget(const QSpinWidget *) Style_Enabled Set if the spinwidget is enabled. Unused. Style_HasFocus Set if the spinwidget has input focus. CC_ComboBox(const QComboBox *) Style_Enabled Set if the combobox is enabled. Unused. Style_HasFocus Set if the combobox has input focus. CC_ScrollBar(const QScrollBar *) Style_Enabled Set if the scrollbar is enabled. Unused. Style_HasFocus Set if the scrollbar has input focus. CC_Slider(const QSlider *) Style_Enabled Set if the slider is enabled. Unused. Style_HasFocus Set if the slider has input focus. CC_ToolButton(const QToolButton *) Style_Enabled Set if the toolbutton is enabled. QStyleOption ( ArrowType t ) -.TP -opt.arrowType() When the tool button only contains an arrow, \fIt\fR is the arrow's type. Style_HasFocus Set if the toolbutton has input focus. Style_Down Set if the toolbutton is down (ie. mouse button or space pressed). Style_On Set if the toolbutton is a toggle button and is toggled on. Style_AutoRaise Set if the toolbutton has auto-raise enabled. Style_Raised Set if the button is not down, not on and doesn't contain the mouse when auto-raise is enabled. CC_TitleBar(const QWidget *) Style_Enabled Set if the titlebar is enabled. Unused. CC_ListView(const QListView *) Style_Enabled Set if the titlebar is enabled. QStyleOption ( QListViewItem *item ) -.TP -opt.listViewItem() -.TE -.fi -
                                                            -.PP -See also ComplexControl and SubControl. -.SH "void QStyle::drawComplexControlMask ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Draw a bitmask for the ComplexControl \fIcontrol\fR using the painter \fIp\fR in the area \fIr\fR. See drawComplexControl() for an explanation of the use of the \fIwidget\fR and \fIopt\fR arguments. -.PP -The rect \fIr\fR should be in logical coordinates. Reimplementations of this function should use visualRect() to change the logical corrdinates into screen coordinates when using drawPrimitive() and drawControl(). -.PP -See also drawComplexControl() and ComplexControl. -.SH "void QStyle::drawControl ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Draws the ControlElement \fIelement\fR using the painter \fIp\fR in the area \fIr\fR. Colors are used from the color group \fIcg\fR. -.PP -The rect \fIr\fR should be in screen coordinates. -.PP -The \fIhow\fR argument is used to control how the ControlElement is drawn. Multiple flags can be OR'ed together. See the table below for an explanation of which flags are used with the various ControlElements. -.PP -The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIelement\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ControlElement. Note that \fIopt\fR may be the default value even for ControlElements that can make use of the extra options. See the table below for the appropriate \fIwidget\fR and \fIopt\fR usage: -.PP -
                                                            .nf -.TS -l - l. ControlElement -.br -& Widget Cast Style Flags Notes Options Notes CE_PushButton(const QPushButton *) -.PP -and -.PP -CE_PushButtonLabel(const QPushButton *) Style_Enabled Set if the button is enabled. Unused. Style_HasFocus Set if the button has input focus. Style_Raised Set if the button is not down, not on and not flat. Style_On Set if the button is a toggle button and toggled on. Style_Down Set if the button is down (i.e., the mouse button or space bar is pressed on the button). Style_ButtonDefault Set if the button is a default button. CE_CheckBox(const QCheckBox *) -.PP -and -.PP -CE_CheckBoxLabel(const QCheckBox *) -.PP Style_Enabled Set if the checkbox is enabled. Unused. -Style_HasFocus Set if the checkbox has input focus. Style_On Set if the checkbox is checked. Style_Off Set if the checkbox is not checked. Style_NoChange Set if the checkbox is in the NoChange state. Style_Down Set if the checkbox is down (i.e., the mouse button or space bar is pressed on the button). CE_RadioButton(const QRadioButton *) -.PP -and -.PP -CE_RadioButtonLabel(const QRadioButton *) Style_Enabled Set if the radiobutton is enabled. Unused. Style_HasFocus Set if the radiobutton has input focus. Style_On Set if the radiobutton is checked. Style_Off Set if the radiobutton is not checked. Style_Down Set if the radiobutton is down (i.e., the mouse button or space bar is pressed on the radiobutton). CE_TabBarTab(const QTabBar *) -.PP -and -.PP -CE_TabBarLabel(const QTabBar *) -.PP Style_Enabled Set if the tabbar and tab is enabled. QStyleOption ( QTab *t ) -.TP -opt.tab() \fIt\fR is the QTab being drawn. Style_Selected Set if the tab is the current tab. CE_ProgressBarGroove(const QProgressBar *) -.PP -and -.PP -CE_ProgressBarContents(const QProgressBar *) -.PP -and -.PP -CE_ProgressBarLabel(const QProgressBar *) -.PP Style_Enabled Set if the progressbar is enabled. Unused. -Style_HasFocus Set if the progressbar has input focus. CE_PopupMenuItem(const QPopupMenu *) Style_Enabled Set if the menuitem is enabled. QStyleOption ( QMenuItem *mi, int tabwidth, int maxpmwidth ) -.TP -opt.menuItem() -.TP -opt.tabWidth() -.TP -opt.maxIconWidth() \fImi\fR is the menu item being drawn. QMenuItem is currently an internal class. Style_Active Set if the menuitem is the current item. \fItabwidth\fR is the width of the tab column where key accelerators are drawn. Style_Down Set if the menuitem is down (i.e., the mouse button or space bar is pressed). \fImaxpmwidth\fR is the maximum width of the check column where checkmarks and iconsets are drawn. CE_MenuBarItem(const QMenuBar *) Style_Enabled Set if the menuitem is enabled QStyleOption ( QMenuItem *mi ) -.TP -opt.menuItem() \fImi\fR is the menu item being drawn. Style_Active Set if the menuitem is the current item. Style_Down Set if the menuitem is down (i.e., a mouse button or the space bar is pressed). Style_HasFocus Set if the menubar has input focus. CE_ToolButtonLabel(const QToolButton *) Style_Enabled Set if the toolbutton is enabled. QStyleOption ( ArrowType t ) -.TP -opt.arrowType() When the tool button only contains an arrow, \fIt\fR is the arrow's type. Style_HasFocus Set if the toolbutton has input focus. Style_Down Set if the toolbutton is down (i.e., a mouse button or the space is pressed). Style_On Set if the toolbutton is a toggle button and is toggled on. Style_AutoRaise Set if the toolbutton has auto-raise enabled. Style_MouseOver Set if the mouse pointer is over the toolbutton. Style_Raised -.TE -.fi -
                                                            -.PP -See also ControlElement and StyleFlags. -.SH "void QStyle::drawControlMask ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Draw a bitmask for the ControlElement \fIelement\fR using the painter \fIp\fR in the area \fIr\fR. See drawControl() for an explanation of the use of the \fIwidget\fR and \fIopt\fR arguments. -.PP -The rect \fIr\fR should be in screen coordinates. -.PP -See also drawControl() and ControlElement. -.SH "void QStyle::drawItem ( QPainter * p, const QRect & r, int flags, const QColorGroup & g, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1, const QColor * penColor = 0 ) const\fC [virtual]\fR" -Draws the \fItext\fR or \fIpixmap\fR in rectangle \fIr\fR using painter \fIp\fR and color group \fIg\fR. The pen color is specified with \fIpenColor\fR. The \fIenabled\fR bool indicates whether or not the item is enabled; when reimplementing this bool should influence how the item is drawn. If \fIlen\fR is -1 (the default) all the \fItext\fR is drawn; otherwise only the first \fIlen\fR characters of \fItext\fR are drawn. The text is aligned and wrapped according to the alignment \fIflags\fR (see Qt::AlignmentFlags). -.PP -By default, if both the text and the pixmap are not null, the pixmap is drawn and the text is ignored. -.SH "void QStyle::drawPrimitive ( PrimitiveElement pe, QPainter * p, const QRect & r, const QColorGroup & cg, SFlags flags = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Draws the style PrimitiveElement \fIpe\fR using the painter \fIp\fR in the area \fIr\fR. Colors are used from the color group \fIcg\fR. -.PP -The rect \fIr\fR should be in screen coordinates. -.PP -The \fIflags\fR argument is used to control how the PrimitiveElement is drawn. Multiple flags can be OR'ed together. -.PP -For example, a pressed button would be drawn with the flags Style_Enabled and Style_Down. -.PP -The \fIopt\fR argument can be used to control how various PrimitiveElements are drawn. Note that \fIopt\fR may be the default value even for PrimitiveElements that make use of extra options. When \fIopt\fR is non-default, it is used as follows: -.PP -
                                                            .nf -.TS -l - l. PrimitiveElement Options Notes PE_FocusRect QStyleOption ( const QColor & bg ) -.TP -opt.color() \fIbg\fR is the background color on which the focus rect is being drawn. PE_Panel QStyleOption ( int linewidth, int midlinewidth ) -.TP -opt.lineWidth() -.TP -opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_PanelPopup QStyleOption ( int linewidth, int midlinewidth ) -.TP -opt.lineWidth() -.TP -opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_PanelMenuBar QStyleOption ( int linewidth, int midlinewidth ) -.TP -opt.lineWidth() -.TP -opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_PanelDockWindow QStyleOption ( int linewidth, int midlinewidth ) -.TP -opt.lineWidth() -.TP -opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_GroupBoxFrame QStyleOption ( int linewidth, int midlinewidth, int shape, int shadow ) -.TP -opt.lineWidth() -.TP -opt.midLineWidth() -.TP -opt.frameShape() -.TP -opt.frameShadow() \fIlinewidth\fR is the line width for the group box. \fImidlinewidth\fR is the mid-line width for the group box. \fIshape\fR is the frame shape for the group box. -.TE -.fi -
                                                            -.PP -For all other PrimitiveElements, \fIopt\fR is unused. -.PP -See also StyleFlags. -.PP -Example: themes/wood.cpp. -.SH "QRect QStyle::itemRect ( QPainter * p, const QRect & r, int flags, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1 ) const\fC [virtual]\fR" -Returns the appropriate area (see below) within rectangle \fIr\fR in which to draw the \fItext\fR or \fIpixmap\fR using painter \fIp\fR. If \fIlen\fR is -1 (the default) all the \fItext\fR is drawn; otherwise only the first \fIlen\fR characters of \fItext\fR are drawn. The text is aligned in accordance with the alignment \fIflags\fR (see Qt::AlignmentFlags). The \fIenabled\fR bool indicates whether or not the item is enabled. -.PP -If \fIr\fR is larger than the area needed to render the \fItext\fR the rectangle that is returned will be offset within \fIr\fR in accordance with the alignment \fIflags\fR. For example if \fIflags\fR is AlignCenter the returned rectangle will be centered within \fIr\fR. If \fIr\fR is smaller than the area needed the rectangle that is returned will be \fIlarger\fR than \fIr\fR (the smallest rectangle large enough to render the \fItext\fR or \fIpixmap\fR). -.PP -By default, if both the text and the pixmap are not null, the pixmap is drawn and the text is ignored. -.SH "int QStyle::pixelMetric ( PixelMetric metric, const QWidget * widget = 0 ) const\fC [pure virtual]\fR" -Returns the pixel metric for \fImetric\fR. The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fImetric\fR. Note that \fIwidget\fR may be zero even for PixelMetrics that can make use of \fIwidget\fR. See the table below for the appropriate \fIwidget\fR casts: -.PP -
                                                            .nf -.TS -l - l. PixelMetric Widget Cast PM_SliderControlThickness (const QSlider *) PM_SliderLength (const QSlider *) PM_SliderTickmarkOffset (const QSlider *) PM_SliderSpaceAvailable (const QSlider *) PM_TabBarTabOverlap (const QTabBar *) PM_TabBarTabHSpace (const QTabBar *) PM_TabBarTabVSpace (const QTabBar *) PM_TabBarBaseHeight (const QTabBar *) PM_TabBarBaseOverlap -.TE -.fi -
                                                            -.SH "void QStyle::polish ( QWidget * )\fC [virtual]\fR" -Initializes the appearance of a widget. -.PP -This function is called for every widget at some point after it has been fully created but just \fIbefore\fR it is shown the very first time. -.PP -Reasonable actions in this function might be to call QWidget::setBackgroundMode() for the widget. An example of highly unreasonable use would be setting the geometry! Reimplementing this function gives you a back-door through which you can change the appearance of a widget. With Qt 3.0's style engine you will rarely need to write your own polish(); instead reimplement drawItem(), drawPrimitive(), etc. -.PP -The QWidget::inherits() function may provide enough information to allow class-specific customizations. But be careful not to hard-code things too much because new QStyle subclasses are expected to work reasonably with all current and \fIfuture\fR widgets. -.PP -See also unPolish(). -.SH "void QStyle::polish ( QApplication * )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Late initialization of the QApplication object. -.PP -See also unPolish(). -.SH "void QStyle::polish ( QPalette & )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The style may have certain requirements for color palettes. In this function it has the chance to change the palette according to these requirements. -.PP -See also QPalette and QApplication::setPalette(). -.SH "void QStyle::polishPopupMenu ( QPopupMenu * )\fC [pure virtual]\fR" -Polishes the popup menu according to the GUI style. This usually means setting the mouse tracking (QPopupMenu::setMouseTracking()) and whether the menu is checkable by default (QPopupMenu::setCheckable()). -.SH "SubControl QStyle::querySubControl ( ComplexControl control, const QWidget * widget, const QPoint & pos, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Returns the SubControl for \fIwidget\fR at the point \fIpos\fR. The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontrol\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ComplexControl. Note that \fIopt\fR may be the default value even for ComplexControls that can make use of the extra options. See drawComplexControl() for an explanation of the \fIwidget\fR and \fIopt\fR arguments. -.PP -Note that \fIpos\fR is passed in screen coordinates. When using querySubControlMetrics() to check for hits and misses, use visualRect() to change the logical coordinates into screen coordinates. -.PP -See also drawComplexControl(), ComplexControl, SubControl, and querySubControlMetrics(). -.SH "QRect QStyle::querySubControlMetrics ( ComplexControl control, const QWidget * widget, SubControl subcontrol, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Returns the rect for the SubControl \fIsubcontrol\fR for \fIwidget\fR in logical coordinates. -.PP -The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontrol\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ComplexControl. Note that \fIopt\fR may be the default value even for ComplexControls that can make use of the extra options. See drawComplexControl() for an explanation of the \fIwidget\fR and \fIopt\fR arguments. -.PP -See also drawComplexControl(), ComplexControl, and SubControl. -.SH "QSize QStyle::scrollBarExtent () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QSize QStyle::sizeFromContents ( ContentsType contents, const QWidget * widget, const QSize & contentsSize, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Returns the size of \fIwidget\fR based on the contents size \fIcontentsSize\fR. -.PP -The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontents\fR. The \fIopt\fR argument can be used to pass extra information required when calculating the size. Note that \fIopt\fR may be the default value even for ContentsTypes that can make use of the extra options. See the table below for the appropriate \fIwidget\fR and \fIopt\fR usage: -.PP -
                                                            .nf -.TS -l - l. ContentsType Widget Cast Options Notes CT_PushButton (const QPushButton *) Unused. CT_CheckBox (const QCheckBox *) Unused. CT_RadioButton (const QRadioButton *) Unused. CT_ToolButton (const QToolButton *) Unused. CT_ComboBox (const QComboBox *) Unused. CT_Splitter (const QSplitter *) Unused. CT_DockWindow (const QDockWindow *) Unused. CT_ProgressBar (const QProgressBar *) Unused. CT_PopupMenuItem (const QPopupMenu *) QStyleOption ( QMenuItem *mi ) -.TP -opt.menuItem() -.TE -.fi -
                                                            -.SH "int QStyle::styleHint ( StyleHint stylehint, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default, QStyleHintReturn * returnData = 0 ) const\fC [pure virtual]\fR" -Returns the style hint \fIstylehint\fR for \fIwidget\fR. Currently, \fIwidget\fR, \fIopt\fR, and \fIreturnData\fR are unused; they're included to allow for future enhancements. -.PP -For an explanation of the return value see StyleHint. -.SH "QPixmap QStyle::stylePixmap ( StylePixmap stylepixmap, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" -Returns a pixmap for \fIstylepixmap\fR. -.PP -The \fIopt\fR argument can be used to pass extra information required when drawing the ControlElement. Note that \fIopt\fR may be the default value even for StylePixmaps that can make use of the extra options. Currently, the \fIopt\fR argument is unused. -.PP -The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIstylepixmap\fR. See the table below for the appropriate \fIwidget\fR casts: -.PP -
                                                            .nf -.TS -l - l. StylePixmap Widget Cast SP_TitleBarMinButton (const QWidget *) SP_TitleBarMaxButton (const QWidget *) SP_TitleBarCloseButton (const QWidget *) SP_TitleBarNormalButton (const QWidget *) SP_TitleBarShadeButton (const QWidget *) SP_TitleBarUnshadeButton (const QWidget *) SP_DockWindowCloseButton -.TE -.fi -
                                                            -.PP -See also StylePixmap. -.SH "QRect QStyle::subRect ( SubRect subrect, const QWidget * widget ) const\fC [pure virtual]\fR" -Returns the sub-area \fIsubrect\fR for the \fIwidget\fR in logical coordinates. -.PP -The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIsubrect\fR. See the table below for the appropriate \fIwidget\fR casts: -.PP -
                                                            .nf -.TS -l - l. SubRect Widget Cast SR_PushButtonContents (const QPushButton *) SR_PushButtonFocusRect (const QPushButton *) SR_CheckBoxIndicator (const QCheckBox *) SR_CheckBoxContents (const QCheckBox *) SR_CheckBoxFocusRect (const QCheckBox *) SR_RadioButtonIndicator (const QRadioButton *) SR_RadioButtonContents (const QRadioButton *) SR_RadioButtonFocusRect (const QRadioButton *) SR_ComboBoxFocusRect (const QComboBox *) SR_DockWindowHandleRect (const QWidget *) SR_ProgressBarGroove (const QProgressBar *) SR_ProgressBarContents (const QProgressBar *) SR_ProgressBarLabel -.TE -.fi -
                                                            -.PP -The tear-off handle (SR_DockWindowHandleRect) for QDockWindow is a private class. Use QWidget::parentWidget() to access the QDockWindow: -.PP -.nf -.br - if ( !widget->parentWidget() ) -.br - return; -.br - const QDockWindow *dw = (const QDockWindow *) widget->parentWidget(); -.br -.fi -.PP -See also SubRect. -.SH "void QStyle::tabbarMetrics ( const QWidget * t, int & hf, int & vf, int & ov ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QStyle::unPolish ( QWidget * )\fC [virtual]\fR" -Undoes the initialization of a widget's appearance. -.PP -This function is the counterpart to polish. It is called for every polished widget when the style is dynamically changed. The former style has to unpolish its settings before the new style can polish them again. -.PP -See also polish(). -.SH "void QStyle::unPolish ( QApplication * )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Undoes the application polish. -.PP -See also polish(). -.SH "QRect QStyle::visualRect ( const QRect & logical, const QWidget * w )\fC [static]\fR" -Returns the rect \fIlogical\fR in screen coordinates. The bounding rect for widget \fIw\fR is used to perform the translation. This function is provided to aid style implementors in supporting right-to-left mode. -.PP -See also QApplication::reverseLayout(). -.SH "QRect QStyle::visualRect ( const QRect & logical, const QRect & bounding )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the rect \fIlogical\fR in screen coordinates. The rect \fIbounding\fR is used to perform the translation. This function is provided to aid style implementors in supporting right-to-left mode. -.PP -See also QApplication::reverseLayout(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstylefactory.3qt b/doc/man/man3/qstylefactory.3qt deleted file mode 100644 index 48d60f64e..000000000 --- a/doc/man/man3/qstylefactory.3qt +++ /dev/null @@ -1,61 +0,0 @@ -'\" t -.TH QStyleFactory 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 -QStyleFactory \- Creates QStyle objects -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Static Public Members" -
                                                          1. QStringList \fBkeys\fR ()
                                                          2. QStyle * \fBcreate\fR ( const QString & key ) -.SH DESCRIPTION -The QStyleFactory class creates QStyle objects. -.PP -The style factory creates a QStyle object for a given key with QStyleFactory::create(key). -.PP -The styles are either built-in or dynamically loaded from a style plugin (see QStylePlugin). -.PP -QStyleFactory::keys() returns a list of valid keys, typically including "Windows", "Motif", "CDE", "MotifPlus", "Platinum"," SGI" and "Compact". Depending on the platform, "WindowsXP"," Aqua" or "Macintosh" may be available. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStyle * QStyleFactory::create ( const QString & key )\fC [static]\fR" -Creates a QStyle object that matches \fIkey\fR case-insensitively. This is either a built-in style, or a style from a style plugin. -.PP -See also keys(). -.PP -Example: themes/wood.cpp. -.SH "QStringList QStyleFactory::keys ()\fC [static]\fR" -Returns the list of keys this factory can create styles for. -.PP -See also create(). -.PP -Example: themes/themes.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstylefactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstylefactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstyleoption.3qt b/doc/man/man3/qstyleoption.3qt deleted file mode 100644 index 917db501b..000000000 --- a/doc/man/man3/qstyleoption.3qt +++ /dev/null @@ -1,222 +0,0 @@ -'\" t -.TH QStyleOption 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 -QStyleOption \- Optional parameters for QStyle functions -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBStyleOptionDefault\fR { Default }" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( StyleOptionDefault = Default )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( int in1 )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( int in1, int in2 )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( int in1, int in2, int in3, int in4 )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( QMenuItem * m )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( QMenuItem * m, int in1 )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( QMenuItem * m, int in1, int in2 )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( const QColor & c )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( QTab * t )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( QListViewItem * i )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( QCheckListItem * i )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( Qt::ArrowType a )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( const QRect & r )" -.br -.ti -1c -.BI "\fBQStyleOption\fR ( QWidget * w )" -.br -.ti -1c -.BI "bool \fBisDefault\fR () const" -.br -.ti -1c -.BI "int \fBday\fR () const" -.br -.ti -1c -.BI "int \fBlineWidth\fR () const" -.br -.ti -1c -.BI "int \fBmidLineWidth\fR () const" -.br -.ti -1c -.BI "int \fBframeShape\fR () const" -.br -.ti -1c -.BI "int \fBframeShadow\fR () const" -.br -.ti -1c -.BI "int \fBheaderSection\fR () const" -.br -.ti -1c -.BI "QMenuItem * \fBmenuItem\fR () const" -.br -.ti -1c -.BI "int \fBmaxIconWidth\fR () const" -.br -.ti -1c -.BI "int \fBtabWidth\fR () const" -.br -.ti -1c -.BI "const QColor & \fBcolor\fR () const" -.br -.ti -1c -.BI "QTab * \fBtab\fR () const" -.br -.ti -1c -.BI "QCheckListItem * \fBcheckListItem\fR () const" -.br -.ti -1c -.BI "QListViewItem * \fBlistViewItem\fR () const" -.br -.ti -1c -.BI "Qt::ArrowType \fBarrowType\fR () const" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "QWidget * \fBwidget\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QStyleOption class specifies optional parameters for QStyle functions. -.PP -Some QStyle functions take an optional argument specifying extra information that is required for a paritical primitive or control. So that the QStyle class can be extended, QStyleOption is used to provide a variable-argument for these options. -.PP -The QStyleOption class has constructors for each type of optional argument, and this set of constructors may be extended in future Qt releases. There are also corresponding access functions that return the optional arguments: these too may be extended. -.PP -For each constructor, you should refer to the documentation of the QStyle functions to see the meaning of the arguments. -.PP -When calling QStyle functions from your own widgets, you must only pass the default QStyleOption or the argument that QStyle is documented to accept. For example, if the function expects QStyleOption(QMenuItem *, int), passing QStyleOption(QMenuItem *) leaves the optional integer argument uninitialized. -.PP -When subclassing QStyle, you must similarly only expect the default or documented arguments. The other arguments will have uninitialized values. -.PP -If you make your own QStyle subclasses and your own widgets, you can make a subclass of QStyleOption to pass additional arguments to your QStyle subclass. You will need to cast the "const QStyleOption&" argument to your subclass, so be sure your style has been called from your widget. -.PP -See also Widget Appearance and Style. -.SS "Member Type Documentation" -.SH "QStyleOption::StyleOptionDefault" -This enum value can be passed as the optional argument to any QStyle function. -.TP -\fCQStyleOption::Default\fR -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStyleOption::QStyleOption ( StyleOptionDefault = Default )" -The default option. This can always be passed as the optional argument to QStyle functions. -.SH "QStyleOption::QStyleOption ( int in1 )" -Pass one integer, \fIin1\fR. For example, headerSection. -.SH "QStyleOption::QStyleOption ( int in1, int in2 )" -Pass two integers, \fIin1\fR and \fIin2\fR. For example, linewidth and midlinewidth. -.SH "QStyleOption::QStyleOption ( int in1, int in2, int in3, int in4 )" -Pass four integers, \fIin1\fR, \fIin2\fR, \fIin3\fR and \fIin4\fR. -.SH "QStyleOption::QStyleOption ( QMenuItem * m )" -Pass a menu item, \fIm\fR. -.SH "QStyleOption::QStyleOption ( QMenuItem * m, int in1 )" -Pass a menu item and an integer, \fIm\fR and \fIin1\fR. -.SH "QStyleOption::QStyleOption ( QMenuItem * m, int in1, int in2 )" -Pass a menu item and two integers, \fIm\fR, \fIin1\fR and \fIin2\fR. -.SH "QStyleOption::QStyleOption ( const QColor & c )" -Pass a color, \fIc\fR. -.SH "QStyleOption::QStyleOption ( QTab * t )" -Pass a QTab, \fIt\fR. -.SH "QStyleOption::QStyleOption ( QListViewItem * i )" -Pass a QListViewItem, \fIi\fR. -.SH "QStyleOption::QStyleOption ( QCheckListItem * i )" -Pass a QCheckListItem, \fIi\fR. -.SH "QStyleOption::QStyleOption ( Qt::ArrowType a )" -Pass an Qt::ArrowType, \fIa\fR. -.SH "QStyleOption::QStyleOption ( const QRect & r )" -Pass a QRect, \fIr\fR. -.SH "QStyleOption::QStyleOption ( QWidget * w )" -Pass a QWidget, \fIw\fR. -.SH "Qt::ArrowType QStyleOption::arrowType () const" -Returns an arrow type if the appropriate constructor was called; otherwise the return value is undefined. -.SH "QCheckListItem * QStyleOption::checkListItem () const" -Returns a check list item if the appropriate constructor was called; otherwise the return value is undefined. -.SH "const QColor & QStyleOption::color () const" -Returns a color if the appropriate constructor was called; otherwise the return value is undefined. -.SH "int QStyleOption::day () const" -Returns the index of the day in the month if the appropriate constructor was called; otherwise the return value is undefined. -.SH "int QStyleOption::frameShadow () const" -Returns a QFrame::Shadow value if the appropriate constructor was called; otherwise the return value is undefined. -.SH "int QStyleOption::frameShape () const" -Returns a QFrame::Shape value if the appropriate constructor was called; otherwise the return value is undefined. -.SH "int QStyleOption::headerSection () const" -Returns the header section if the appropriate constructor was called; otherwise the return value is undefined. -.SH "bool QStyleOption::isDefault () const" -Returns TRUE if the option was constructed with the default constructor; otherwise returns FALSE. -.SH "int QStyleOption::lineWidth () const" -Returns the line width if the appropriate constructor was called; otherwise the return value is undefined. -.SH "QListViewItem * QStyleOption::listViewItem () const" -Returns a QListView item if the appropriate constructor was called; otherwise the return value is undefined. -.SH "int QStyleOption::maxIconWidth () const" -Returns the maximum width of the menu item check area if the appropriate constructor was called; otherwise the return value is undefined. -.SH "QMenuItem * QStyleOption::menuItem () const" -Returns a menu item if the appropriate constructor was called; otherwise the return value is undefined. -.SH "int QStyleOption::midLineWidth () const" -Returns the mid-line width if the appropriate constructor was called; otherwise the return value is undefined. -.SH "QRect QStyleOption::rect () const" -Returns a rectangle if the appropriate constructor was called; otherwise the return value is undefined. -.SH "QTab * QStyleOption::tab () const" -Returns a QTabBar tab if the appropriate constructor was called; otherwise the return value is undefined. -.SH "int QStyleOption::tabWidth () const" -Returns the tab indent width if the appropriate constructor was called; otherwise the return value is undefined. -.SH "QWidget * QStyleOption::widget () const" -Returns a pointer to a widget if the appropriate constructor was called; -otherwise the return value is undefined. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qstyleoption.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstyleoption.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstyleplugin.3qt b/doc/man/man3/qstyleplugin.3qt deleted file mode 100644 index 310c16f73..000000000 --- a/doc/man/man3/qstyleplugin.3qt +++ /dev/null @@ -1,78 +0,0 @@ -'\" t -.TH QStylePlugin 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 -QStylePlugin \- Abstract base for custom QStyle plugins -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStylePlugin\fR ()" -.br -.ti -1c -.BI "\fB~QStylePlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBkeys\fR () const = 0" -.br -.ti -1c -.BI "virtual QStyle * \fBcreate\fR ( const QString & key ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QStylePlugin class provides an abstract base for custom QStyle plugins. -.PP -The style plugin is a simple plugin interface that makes it easy to create custom styles that can be loaded dynamically into applications with a QStyleFactory. -.PP -Writing a style plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the plugins documentation for an example. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStylePlugin::QStylePlugin ()" -Constructs a style plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. -.SH "QStylePlugin::~QStylePlugin ()" -Destroys the style plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "QStyle * QStylePlugin::create ( const QString & key )\fC [pure virtual]\fR" -Creates and returns a QStyle object for the style key \fIkey\fR. The style key is usually the class name of the required style. -.PP -See also keys(). -.SH "QStringList QStylePlugin::keys () const\fC [pure virtual]\fR" -Returns the list of style keys this plugin supports. -.PP -These keys are usually the class names of the custom styles that are implemented in the plugin. -.PP -See also create(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstyleplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstyleplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstylesheet.3qt b/doc/man/man3/qstylesheet.3qt deleted file mode 100644 index 0c2070664..000000000 --- a/doc/man/man3/qstylesheet.3qt +++ /dev/null @@ -1,224 +0,0 @@ -'\" t -.TH QStyleSheet 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 -QStyleSheet \- Collection of styles for rich text rendering and a generator of tags -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStyleSheet\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual \fB~QStyleSheet\fR ()" -.br -.ti -1c -.BI "QStyleSheetItem * \fBitem\fR ( const QString & name )" -.br -.ti -1c -.BI "const QStyleSheetItem * \fBitem\fR ( const QString & name ) const" -.br -.ti -1c -.BI "virtual QTextCustomItem * \fBtag\fR ( const QString & name, const QMap & attr, const QString & context, const QMimeSourceFactory & factory, bool emptyTag, QTextDocument * doc ) const" -.br -.ti -1c -.BI "virtual void \fBscaleFont\fR ( QFont & font, int logicalSize ) const" -.br -.ti -1c -.BI "virtual void \fBerror\fR ( const QString & msg ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QStyleSheet * \fBdefaultSheet\fR ()" -.br -.ti -1c -.BI "void \fBsetDefaultSheet\fR ( QStyleSheet * sheet )" -.br -.ti -1c -.BI "QString \fBescape\fR ( const QString & plain )" -.br -.ti -1c -.BI "QString \fBconvertFromPlainText\fR ( const QString & plain, QStyleSheetItem::WhiteSpaceMode mode = QStyleSheetItem::WhiteSpacePre )" -.br -.ti -1c -.BI "bool \fBmightBeRichText\fR ( const QString & text )" -.br -.in -1c -.SH DESCRIPTION -The QStyleSheet class is a collection of styles for rich text rendering and a generator of tags. -.PP -By creating QStyleSheetItem objects for a style sheet you build a definition of a set of tags. This definition will be used by the internal rich text rendering system to parse and display text documents to which the style sheet applies. Rich text is normally visualized in a QTextEdit or a QTextBrowser. However, QLabel, QWhatsThis and QMessageBox also support it, and other classes are likely to follow. With QSimpleRichText it is possible to use the rich text renderer for custom widgets as well. -.PP -The default QStyleSheet object has the following style bindings, sorted by structuring bindings, anchors, character style bindings (i.e. inline styles), special elements such as horizontal lines or images, and other tags. In addition, rich text supports simple HTML tables. -.PP -The structuring tags are
                                                            .nf -.TS -l - l. Structuring tags Notes A Qt rich text document. It understands the following attributes: -.TP - A top-level heading. - A sublevel heading. - A sub-sublevel heading. - Headings of lesser importance. - A left-aligned paragraph. Adjust the alignment with the - A centered paragraph. - An indented paragraph that is useful for quotes. - An unordered list. You can also pass a type argument to -define the bullet style. The default is - An ordered list. You can also pass a type argument to -define the enumeration label style. The default is - A list item. This tag can be used only within the context -of - A list of definitions, consisting of terms and descriptions. - A term in a list of definitions. This tag can be used only -in the context of - A description in a list of definitions. This tag can be -used only in the context of - For larger chunks of code. Whitespaces in the contents are -preserved. For small bits of code use the inline-style - -.TE -.fi -
                                                            -.PP -Anchors and links are done with a single tag:
                                                            .nf -.TS -l - l. Anchor tags Notes An anchor or link. -.TP -A link is created by using an -.TE -.fi -
                                                            -.PP -The default character style bindings are
                                                            .nf -.TS -l - l. Style tags Notes Emphasized. By default this is the same as Strong. By default this is the same as Italic font style. Bold font style. Underlined font style. Strike out font style. A larger font size. A smaller font size. Subscripted text Superscripted text Indicates code. By default this is the same as Typewriter font style. Customizes the font size, family and text color. The tag understands the following attributes: -.TP -.TE -.fi -
                                                            -.PP -Special elements are:
                                                            .nf -.TS -l -- -l. -Special tags Notes - An image. The image name for the mime source factory is -given in the source attribute, for example - A horizontal line. - A line break. - -.TE -.fi -
                                                            -.PP -In addition, rich text supports simple HTML tables. A table consists of one or more rows each of which contains one or more cells. Cells are either data cells or header cells, depending on their content. Cells which span rows and columns are supported. -.PP -
                                                            .nf -.TS -l - l. Table tags Notes A table. Tables support the following attributes: -.TP -A table row. This is only valid within a A table header cell. Similar to A table data cell. This is only valid within a -.TE -.fi -
                                                            -.PP -See also Graphics Classes, Help System, and Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStyleSheet::QStyleSheet ( QObject * parent = 0, const char * name = 0 )" -Creates a style sheet called \fIname\fR, with parent \fIparent\fR. Like any QObject it will be deleted when its parent is destroyed (if the child still exists). -.PP -By default the style sheet has the tag definitions defined above. -.SH "QStyleSheet::~QStyleSheet ()\fC [virtual]\fR" -Destroys the style sheet. All styles inserted into the style sheet will be deleted. -.SH "QString QStyleSheet::convertFromPlainText ( const QString & plain, QStyleSheetItem::WhiteSpaceMode mode = QStyleSheetItem::WhiteSpacePre )\fC [static]\fR" -Auxiliary function. Converts the plain text string \fIplain\fR to a rich text formatted paragraph while preserving most of its look. -.PP -\fImode\fR defines the whitespace mode. Possible values are QStyleSheetItem::WhiteSpacePre (no wrapping, all whitespaces preserved) and QStyleSheetItem::WhiteSpaceNormal (wrapping, simplified whitespaces). -.PP -See also escape(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, and mdi/application.cpp. -.SH "QStyleSheet * QStyleSheet::defaultSheet ()\fC [static]\fR" -Returns the application-wide default style sheet. This style sheet is used by rich text rendering classes such as QSimpleRichText, QWhatsThis and QMessageBox to define the rendering style and available tags within rich text documents. It also serves as the initial style sheet for the more complex render widgets, QTextEdit and QTextBrowser. -.PP -See also setDefaultSheet(). -.SH "void QStyleSheet::error ( const QString & msg ) const\fC [virtual]\fR" -This virtual function is called when an error occurs when processing rich text. Reimplement it if you need to catch error messages. -.PP -Errors might occur if some rich text strings contain tags that are not understood by the stylesheet, if some tags are nested incorrectly, or if tags are not closed properly. -.PP -\fImsg\fR is the error message. -.SH "QString QStyleSheet::escape ( const QString & plain )\fC [static]\fR" -Auxiliary function. Converts the plain text string \fIplain\fR to a rich text formatted string with any HTML meta-characters escaped. -.PP -See also convertFromPlainText(). -.SH "QStyleSheetItem * QStyleSheet::item ( const QString & name )" -Returns the style called \fIname\fR or 0 if there is no such style. -.SH "const QStyleSheetItem * QStyleSheet::item ( const QString & name ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the style called \fIname\fR or 0 if there is no such style (const version) -.SH "bool QStyleSheet::mightBeRichText ( const QString & text )\fC [static]\fR" -Returns TRUE if the string \fItext\fR is likely to be rich text; otherwise returns FALSE. -.PP -This function uses a fast and therefore simple heuristic. It mainly checks whether there is something that looks like a tag before the first line break. Although the result may be correct for common cases, there is no guarantee. -.SH "void QStyleSheet::scaleFont ( QFont & font, int logicalSize ) const\fC [virtual]\fR" -Scales the font \fIfont\fR to the appropriate physical point size corresponding to the logical font size \fIlogicalSize\fR. -.PP -When calling this function, \fIfont\fR has a point size corresponding to the logical font size 3. -.PP -Logical font sizes range from 1 to 7, with 1 being the smallest. -.PP -See also QStyleSheetItem::logicalFontSize(), QStyleSheetItem::logicalFontSizeStep(), and QFont::setPointSize(). -.SH "void QStyleSheet::setDefaultSheet ( QStyleSheet * sheet )\fC [static]\fR" -Sets the application-wide default style sheet to \fIsheet\fR, deleting any style sheet previously set. The ownership is transferred to QStyleSheet. -.PP -See also defaultSheet(). -.SH "QTextCustomItem * QStyleSheet::tag ( const QString & name, const QMap & attr, const QString & context, const QMimeSourceFactory & factory, bool emptyTag, QTextDocument * doc ) const\fC [virtual]\fR" -\fBThis function is under development and is subject to change.\fR -.PP -Generates an internal object for the tag called \fIname\fR, given the attributes \fIattr\fR, and using additional information provided by the mime source factory \fIfactory\fR. -.PP -\fIcontext\fR is the optional context of the document, i.e. the path to look for relative links. This becomes important if the text contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see QMimeSourceFactory::defaultFactory()) to resolve these references. The context will then be used to calculate the absolute path. See QMimeSourceFactory::makeAbsolute() for details. -.PP -\fIemptyTag\fR and \fIdoc\fR are for internal use only. -.PP -This function should not be used in application code. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqstylesheet.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstylesheet.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qstylesheetitem.3qt b/doc/man/man3/qstylesheetitem.3qt deleted file mode 100644 index f3e5af904..000000000 --- a/doc/man/man3/qstylesheetitem.3qt +++ /dev/null @@ -1,484 +0,0 @@ -'\" t -.TH QStyleSheetItem 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 -QStyleSheetItem \- Encapsulation of a set of text styles -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQStyleSheetItem\fR ( QStyleSheet * parent, const QString & name )" -.br -.ti -1c -.BI "\fBQStyleSheetItem\fR ( const QStyleSheetItem & other )" -.br -.ti -1c -.BI "\fB~QStyleSheetItem\fR ()" -.br -.ti -1c -.BI "QStyleSheetItem & \fBoperator=\fR ( const QStyleSheetItem & other )" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "QStyleSheet * \fBstyleSheet\fR ()" -.br -.ti -1c -.BI "const QStyleSheet * \fBstyleSheet\fR () const" -.br -.ti -1c -.BI "enum \fBDisplayMode\fR { DisplayBlock, DisplayInline, DisplayListItem, DisplayNone }" -.br -.ti -1c -.BI "DisplayMode \fBdisplayMode\fR () const" -.br -.ti -1c -.BI "void \fBsetDisplayMode\fR ( DisplayMode m )" -.br -.ti -1c -.BI "int \fBalignment\fR () const" -.br -.ti -1c -.BI "void \fBsetAlignment\fR ( int f )" -.br -.ti -1c -.BI "enum \fBVerticalAlignment\fR { VAlignBaseline, VAlignSub, VAlignSuper }" -.br -.ti -1c -.BI "VerticalAlignment \fBverticalAlignment\fR () const" -.br -.ti -1c -.BI "void \fBsetVerticalAlignment\fR ( VerticalAlignment valign )" -.br -.ti -1c -.BI "int \fBfontWeight\fR () const" -.br -.ti -1c -.BI "void \fBsetFontWeight\fR ( int w )" -.br -.ti -1c -.BI "int \fBlogicalFontSize\fR () const" -.br -.ti -1c -.BI "void \fBsetLogicalFontSize\fR ( int s )" -.br -.ti -1c -.BI "int \fBlogicalFontSizeStep\fR () const" -.br -.ti -1c -.BI "void \fBsetLogicalFontSizeStep\fR ( int s )" -.br -.ti -1c -.BI "int \fBfontSize\fR () const" -.br -.ti -1c -.BI "void \fBsetFontSize\fR ( int s )" -.br -.ti -1c -.BI "QString \fBfontFamily\fR () const" -.br -.ti -1c -.BI "void \fBsetFontFamily\fR ( const QString & fam )" -.br -.ti -1c -.BI "int numberOfColumns () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setNumberOfColumns ( int ncols ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QColor \fBcolor\fR () const" -.br -.ti -1c -.BI "void \fBsetColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "bool \fBfontItalic\fR () const" -.br -.ti -1c -.BI "void \fBsetFontItalic\fR ( bool italic )" -.br -.ti -1c -.BI "bool \fBdefinesFontItalic\fR () const" -.br -.ti -1c -.BI "bool \fBfontUnderline\fR () const" -.br -.ti -1c -.BI "void \fBsetFontUnderline\fR ( bool underline )" -.br -.ti -1c -.BI "bool \fBdefinesFontUnderline\fR () const" -.br -.ti -1c -.BI "bool \fBfontStrikeOut\fR () const" -.br -.ti -1c -.BI "void \fBsetFontStrikeOut\fR ( bool strikeOut )" -.br -.ti -1c -.BI "bool \fBdefinesFontStrikeOut\fR () const" -.br -.ti -1c -.BI "bool \fBisAnchor\fR () const" -.br -.ti -1c -.BI "void \fBsetAnchor\fR ( bool anc )" -.br -.ti -1c -.BI "enum \fBWhiteSpaceMode\fR { WhiteSpaceNormal, WhiteSpacePre, WhiteSpaceNoWrap }" -.br -.ti -1c -.BI "WhiteSpaceMode \fBwhiteSpaceMode\fR () const" -.br -.ti -1c -.BI "void \fBsetWhiteSpaceMode\fR ( WhiteSpaceMode m )" -.br -.ti -1c -.BI "enum \fBMargin\fR { MarginLeft, MarginRight, MarginTop, MarginBottom, MarginFirstLine, MarginAll, MarginVertical, MarginHorizontal }" -.br -.ti -1c -.BI "int \fBmargin\fR ( Margin m ) const" -.br -.ti -1c -.BI "void \fBsetMargin\fR ( Margin m, int v )" -.br -.ti -1c -.BI "enum \fBListStyle\fR { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, ListUpperAlpha }" -.br -.ti -1c -.BI "ListStyle \fBlistStyle\fR () const" -.br -.ti -1c -.BI "void \fBsetListStyle\fR ( ListStyle s )" -.br -.ti -1c -.BI "QString \fBcontexts\fR () const" -.br -.ti -1c -.BI "void \fBsetContexts\fR ( const QString & c )" -.br -.ti -1c -.BI "bool \fBallowedInContext\fR ( const QStyleSheetItem * s ) const" -.br -.ti -1c -.BI "bool \fBselfNesting\fR () const" -.br -.ti -1c -.BI "void \fBsetSelfNesting\fR ( bool nesting )" -.br -.ti -1c -.BI "int lineSpacing () const \fI(obsolete)\fR" -.br -.in -1c -.SH DESCRIPTION -The QStyleSheetItem class provides an encapsulation of a set of text styles. -.PP -A style sheet item consists of a name and a set of attributes that specifiy its font, color, etc. When used in a style sheet (see styleSheet()), items define the name() of a rich text tag and the display property changes associated with it. -.PP -The display mode attribute indicates whether the item is a block, an inline element or a list element; see setDisplayMode(). The treatment of whitespace is controlled by the white space mode; see setWhiteSpaceMode(). An item's margins are set with setMargin(), In the case of list items, the list style is set with setListStyle(). An item may be a hypertext link anchor; see setAnchor(). Other attributes are set with setAlignment(), setVerticalAlignment(), setFontFamily(), setFontSize(), setFontWeight(), setFontItalic(), setFontUnderline(), setFontStrikeOut and setColor(). -.PP -See also Text Related Classes. -.SS "Member Type Documentation" -.SH "QStyleSheetItem::DisplayMode" -This enum type defines the way adjacent elements are displayed. -.TP -\fCQStyleSheetItem::DisplayBlock\fR - elements are displayed as a rectangular block (e.g. \fC

                                                            ...

                                                            \fR). -.TP -\fCQStyleSheetItem::DisplayInline\fR - elements are displayed in a horizontally flowing sequence (e.g. \fC...\fR). -.TP -\fCQStyleSheetItem::DisplayListItem\fR - elements are displayed in a vertical sequence (e.g. \fC
                                                          3. ...
                                                            4. \fR). -.TP -\fCQStyleSheetItem::DisplayNone\fR - elements are not displayed at all. -.SH "QStyleSheetItem::ListStyle" -This enum type defines how the items in a list are prefixed when displayed. -.TP -\fCQStyleSheetItem::ListDisc\fR - a filled circle (i.e. a bullet) -.TP -\fCQStyleSheetItem::ListCircle\fR - an unfilled circle -.TP -\fCQStyleSheetItem::ListSquare\fR - a filled square -.TP -\fCQStyleSheetItem::ListDecimal\fR - an integer in base 10: \fI1\fR, \fI2\fR, \fI3\fR, ... -.TP -\fCQStyleSheetItem::ListLowerAlpha\fR - a lowercase letter: \fIa\fR, \fIb\fR, \fIc\fR, ... -.TP -\fCQStyleSheetItem::ListUpperAlpha\fR - an uppercase letter: \fIA\fR, \fIB\fR, \fIC\fR, ... -.SH "QStyleSheetItem::Margin" -.TP -\fCQStyleSheetItem::MarginLeft\fR - left margin -.TP -\fCQStyleSheetItem::MarginRight\fR - right margin -.TP -\fCQStyleSheetItem::MarginTop\fR - top margin -.TP -\fCQStyleSheetItem::MarginBottom\fR - bottom margin -.TP -\fCQStyleSheetItem::MarginAll\fR - all margins (left, right, top and bottom) -.TP -\fCQStyleSheetItem::MarginVertical\fR - top and bottom margins -.TP -\fCQStyleSheetItem::MarginHorizontal\fR - left and right margins -.TP -\fCQStyleSheetItem::MarginFirstLine\fR - margin (indentation) of the first line of a paragarph (in addition to the MarginLeft of the paragraph) -.SH "QStyleSheetItem::VerticalAlignment" -This enum type defines the way elements are aligned vertically. This is only supported for text elements. -.TP -\fCQStyleSheetItem::VAlignBaseline\fR - align the baseline of the element (or the bottom, if the element doesn't have a baseline) with the baseline of the parent -.TP -\fCQStyleSheetItem::VAlignSub\fR - subscript the element -.TP -\fCQStyleSheetItem::VAlignSuper\fR - superscript the element -.SH "QStyleSheetItem::WhiteSpaceMode" -This enum defines the ways in which QStyleSheet can treat whitespace. -.TP -\fCQStyleSheetItem::WhiteSpaceNormal\fR - any sequence of whitespace (including line-breaks) is equivalent to a single space. -.TP -\fCQStyleSheetItem::WhiteSpacePre\fR - whitespace must be output exactly as given in the input. -.TP -\fCQStyleSheetItem::WhiteSpaceNoWrap\fR - multiple spaces are collapsed as with WhiteSpaceNormal, but no automatic line-breaks occur. To break lines manually, use the \fC
                                                            \fR tag. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QStyleSheetItem::QStyleSheetItem ( QStyleSheet * parent, const QString & name )" -Constructs a new style called \fIname\fR for the stylesheet \fIparent\fR. -.PP -All properties in QStyleSheetItem are initially in the "do not change" state, except display mode, which defaults to DisplayInline. -.SH "QStyleSheetItem::QStyleSheetItem ( const QStyleSheetItem & other )" -Copy constructor. Constructs a copy of \fIother\fR that is not bound to any style sheet. -.SH "QStyleSheetItem::~QStyleSheetItem ()" -Destroys the style. Note that QStyleSheetItem objects become owned by QStyleSheet when they are created. -.SH "int QStyleSheetItem::alignment () const" -Returns the alignment of this style. Possible values are AlignAuto, AlignLeft, AlignRight, AlignCenter or AlignJustify. -.PP -See also setAlignment() and Qt::AlignmentFlags. -.SH "bool QStyleSheetItem::allowedInContext ( const QStyleSheetItem * s ) const" -Returns TRUE if this style can be nested into an element of style \fIs\fR; otherwise returns FALSE. -.PP -See also contexts() and setContexts(). -.SH "QColor QStyleSheetItem::color () const" -Returns the text color of this style or an invalid color if no color has been set. -.PP -See also setColor() and QColor::isValid(). -.SH "QString QStyleSheetItem::contexts () const" -Returns a space-separated list of names of styles that may contain elements of this style. If nothing has been set, contexts() returns an empty string, which indicates that this style can be nested everywhere. -.PP -See also setContexts(). -.SH "bool QStyleSheetItem::definesFontItalic () const" -Returns TRUE if the style defines a font shape; otherwise returns FALSE. A style does not define any shape until setFontItalic() is called. -.PP -See also setFontItalic() and fontItalic(). -.SH "bool QStyleSheetItem::definesFontStrikeOut () const" -Returns TRUE if the style defines a setting for the strikeOut property of the font; otherwise returns FALSE. A style does not define this until setFontStrikeOut() is called. -.PP -See also setFontStrikeOut() and fontStrikeOut(). -.SH "bool QStyleSheetItem::definesFontUnderline () const" -Returns TRUE if the style defines a setting for the underline property of the font; otherwise returns FALSE. A style does not define this until setFontUnderline() is called. -.PP -See also setFontUnderline() and fontUnderline(). -.SH "DisplayMode QStyleSheetItem::displayMode () const" -Returns the display mode of the style. -.PP -See also setDisplayMode(). -.SH "QString QStyleSheetItem::fontFamily () const" -Returns the font family setting of the style. This is either a valid font family or QString::null if no family has been set. -.PP -See also setFontFamily(), QFont::family(), and QFont::setFamily(). -.SH "bool QStyleSheetItem::fontItalic () const" -Returns TRUE if the style sets an italic font; otherwise returns FALSE. -.PP -See also setFontItalic() and definesFontItalic(). -.SH "int QStyleSheetItem::fontSize () const" -Returns the font size setting of the style. This is either a valid point size or QStyleSheetItem::Undefined. -.PP -See also setFontSize(), QFont::pointSize(), and QFont::setPointSize(). -.SH "bool QStyleSheetItem::fontStrikeOut () const" -Returns TRUE if the style sets a strike out font; otherwise returns FALSE. -.PP -See also setFontStrikeOut() and definesFontStrikeOut(). -.SH "bool QStyleSheetItem::fontUnderline () const" -Returns TRUE if the style sets an underlined font; otherwise returns FALSE. -.PP -See also setFontUnderline() and definesFontUnderline(). -.SH "int QStyleSheetItem::fontWeight () const" -Returns the font weight setting of the style. This is either a valid QFont::Weight or the value QStyleSheetItem::Undefined. -.PP -See also setFontWeight() and QFont. -.SH "bool QStyleSheetItem::isAnchor () const" -Returns whether this style is an anchor. -.PP -See also setAnchor(). -.SH "int QStyleSheetItem::lineSpacing () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the linespacing -.SH "ListStyle QStyleSheetItem::listStyle () const" -Returns the list style of the style. -.PP -See also setListStyle() and ListStyle. -.SH "int QStyleSheetItem::logicalFontSize () const" -Returns the logical font size setting of the style. This is either a valid size between 1 and 7 or QStyleSheetItem::Undefined. -.PP -See also setLogicalFontSize(), setLogicalFontSizeStep(), QFont::pointSize(), and QFont::setPointSize(). -.SH "int QStyleSheetItem::logicalFontSizeStep () const" -Returns the logical font size step of this style. -.PP -The default is 0. Tags such as \fCbig\fR define \fC+1\fR; \fCsmall\fR defines \fC-1\fR. -.PP -See also setLogicalFontSizeStep(). -.SH "int QStyleSheetItem::margin ( Margin m ) const" -Returns the width of margin \fIm\fR in pixels. -.PP -The margin, \fIm\fR, can be MarginLeft, MarginRight, MarginTop, MarginBottom, or MarginFirstLine. -.PP -See also setMargin() and Margin. -.SH "QString QStyleSheetItem::name () const" -Returns the name of the style item. -.SH "int QStyleSheetItem::numberOfColumns () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the number of columns for this style. -.PP -See also setNumberOfColumns(), displayMode(), and setDisplayMode(). -.SH "QStyleSheetItem & QStyleSheetItem::operator= ( const QStyleSheetItem & other )" -Assignment. Assings a copy of \fIother\fR that is not bound to any style sheet. Unbounds first from previous style sheet. -.SH "bool QStyleSheetItem::selfNesting () const" -Returns TRUE if this style has self-nesting enabled; otherwise returns FALSE. -.PP -See also setSelfNesting(). -.SH "void QStyleSheetItem::setAlignment ( int f )" -Sets the alignment to \fIf\fR. This only makes sense for styles with a display mode of DisplayBlock. Possible values are AlignAuto, AlignLeft, AlignRight, AlignCenter or AlignJustify. -.PP -See also alignment(), displayMode(), and Qt::AlignmentFlags. -.SH "void QStyleSheetItem::setAnchor ( bool anc )" -If \fIanc\fR is TRUE, sets this style to be an anchor (hypertext link); otherwise sets it to not be an anchor. Elements in this style link to other documents or anchors. -.PP -See also isAnchor(). -.SH "void QStyleSheetItem::setColor ( const QColor & c )" -Sets the text color of this style to \fIc\fR. -.PP -See also color(). -.SH "void QStyleSheetItem::setContexts ( const QString & c )" -Sets a space-separated list of names of styles that may contain elements of this style. If \fIc\fR is empty, the style can be nested everywhere. -.PP -See also contexts(). -.SH "void QStyleSheetItem::setDisplayMode ( DisplayMode m )" -Sets the display mode of the style to \fIm\fR. -.PP -See also displayMode(). -.SH "void QStyleSheetItem::setFontFamily ( const QString & fam )" -Sets the font family setting of the style to \fIfam\fR. -.PP -See also fontFamily(), QFont::family(), and QFont::setFamily(). -.SH "void QStyleSheetItem::setFontItalic ( bool italic )" -If \fIitalic\fR is TRUE sets italic for the style; otherwise sets upright. -.PP -See also fontItalic() and definesFontItalic(). -.SH "void QStyleSheetItem::setFontSize ( int s )" -Sets the font size setting of the style to \fIs\fR points. -.PP -See also fontSize(), QFont::pointSize(), and QFont::setPointSize(). -.SH "void QStyleSheetItem::setFontStrikeOut ( bool strikeOut )" -If \fIstrikeOut\fR is TRUE, sets strike out for the style; otherwise sets no strike out. -.PP -See also fontStrikeOut() and definesFontStrikeOut(). -.SH "void QStyleSheetItem::setFontUnderline ( bool underline )" -If \fIunderline\fR is TRUE, sets underline for the style; otherwise sets no underline. -.PP -See also fontUnderline() and definesFontUnderline(). -.SH "void QStyleSheetItem::setFontWeight ( int w )" -Sets the font weight setting of the style to \fIw\fR. Valid values are those defined by QFont::Weight. -.PP -See also QFont and fontWeight(). -.SH "void QStyleSheetItem::setListStyle ( ListStyle s )" -Sets the list style of the style to \fIs\fR. -.PP -This is used by nested elements that have a display mode of DisplayListItem. -.PP -See also listStyle(), DisplayMode, and ListStyle. -.SH "void QStyleSheetItem::setLogicalFontSize ( int s )" -Sets the logical font size setting of the style to \fIs\fR. Valid logical sizes are 1 to 7. -.PP -See also logicalFontSize(), QFont::pointSize(), and QFont::setPointSize(). -.SH "void QStyleSheetItem::setLogicalFontSizeStep ( int s )" -Sets the logical font size step of this style to \fIs\fR. -.PP -See also logicalFontSizeStep(). -.SH "void QStyleSheetItem::setMargin ( Margin m, int v )" -Sets the width of margin \fIm\fR to \fIv\fR pixels. -.PP -The margin, \fIm\fR, can be MarginLeft, MarginRight, MarginTop, MarginBottom, MarginFirstLine, MarginAll, MarginVertical or MarginHorizontal. The value \fIv\fR must be >= 0. -.PP -See also margin(). -.SH "void QStyleSheetItem::setNumberOfColumns ( int ncols )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Sets the number of columns for this style. Elements in the style are divided into columns. -.PP -This makes sense only if the style uses a block display mode (see QStyleSheetItem::DisplayMode). -.PP -See also numberOfColumns(). -.SH "void QStyleSheetItem::setSelfNesting ( bool nesting )" -Sets the self-nesting property for this style to \fInesting\fR. -.PP -In order to support "dirty" HTML, paragraphs \fC

                                                            \fR and list items \fC

                                                          4. \fR are not self-nesting. This means that starting a new paragraph or list item automatically closes the previous one. -.PP -See also selfNesting(). -.SH "void QStyleSheetItem::setVerticalAlignment ( VerticalAlignment valign )" -Sets the vertical alignment to \fIvalign\fR. Possible values are VAlignBaseline, VAlignSub or VAlignSuper. -.PP -The vertical alignment property is not inherited. -.PP -See also verticalAlignment(). -.SH "void QStyleSheetItem::setWhiteSpaceMode ( WhiteSpaceMode m )" -Sets the whitespace mode to \fIm\fR. -.PP -See also WhiteSpaceMode. -.SH "QStyleSheet * QStyleSheetItem::styleSheet ()" -Returns the style sheet this item is in. -.SH "const QStyleSheet * QStyleSheetItem::styleSheet () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the style sheet this item is in. -.SH "VerticalAlignment QStyleSheetItem::verticalAlignment () const" -Returns the vertical alignment of the style. Possible values are VAlignBaseline, VAlignSub or VAlignSuper. -.PP -See also setVerticalAlignment(). -.SH "WhiteSpaceMode QStyleSheetItem::whiteSpaceMode () const" -Returns the whitespace mode. -.PP -See also setWhiteSpaceMode() and WhiteSpaceMode. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qstylesheetitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qstylesheetitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qsyntaxhighlighter.3qt b/doc/man/man3/qsyntaxhighlighter.3qt deleted file mode 100644 index 86d62b4dd..000000000 --- a/doc/man/man3/qsyntaxhighlighter.3qt +++ /dev/null @@ -1,120 +0,0 @@ -'\" t -.TH QSyntaxHighlighter 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 -QSyntaxHighlighter \- Base class for implementing QTextEdit syntax highlighters -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQSyntaxHighlighter\fR ( QTextEdit * textEdit )" -.br -.ti -1c -.BI "virtual \fB~QSyntaxHighlighter\fR ()" -.br -.ti -1c -.BI "virtual int \fBhighlightParagraph\fR ( const QString & text, int endStateOfLastPara ) = 0" -.br -.ti -1c -.BI "void \fBsetFormat\fR ( int start, int count, const QFont & font, const QColor & color )" -.br -.ti -1c -.BI "void \fBsetFormat\fR ( int start, int count, const QColor & color )" -.br -.ti -1c -.BI "void \fBsetFormat\fR ( int start, int count, const QFont & font )" -.br -.ti -1c -.BI "QTextEdit * \fBtextEdit\fR () const" -.br -.ti -1c -.BI "void \fBrehighlight\fR ()" -.br -.ti -1c -.BI "int \fBcurrentParagraph\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QSyntaxHighlighter class is a base class for implementing QTextEdit syntax highlighters. -.PP -A syntax highligher automatically highlights parts of the text in a QTextEdit. Syntax highlighters are often used when the user is entering text in a specific format (for example, source code) and help the user to read the text and identify syntax errors. -.PP -To provide your own syntax highlighting for QTextEdit, you must subclass QSyntaxHighlighter and reimplement highlightParagraph(). -.PP -When you create an instance of your QSyntaxHighlighter subclass, pass it the QTextEdit that you want the syntax highlighting to be applied to. After this your highlightParagraph() function will be called automatically whenever necessary. Use your highlightParagraph() function to apply formatting (e.g. setting the font and color) to the text that is passed to it. -.PP -See also Basic Widgets and Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QSyntaxHighlighter::QSyntaxHighlighter ( QTextEdit * textEdit )" -Constructs the QSyntaxHighlighter and installs it on \fItextEdit\fR. -.PP -It is the caller's responsibility to delete the QSyntaxHighlighter when it is no longer needed. -.SH "QSyntaxHighlighter::~QSyntaxHighlighter ()\fC [virtual]\fR" -Destructor. Uninstalls this syntax highlighter from the textEdit() -.SH "int QSyntaxHighlighter::currentParagraph () const" -Returns the id of the paragraph which is highlighted, or -1 of no paragraph is currently highlighted. -.PP -Usually this function is called from within highlightParagraph(). -.SH "int QSyntaxHighlighter::highlightParagraph ( const QString & text, int endStateOfLastPara )\fC [pure virtual]\fR" -This function is called when necessary by the rich text engine, i.e. on paragraphs which have changed. -.PP -In your reimplementation you should parse the paragraph's \fItext\fR and call setFormat() as often as necessary to apply any font and color changes that you require. Your function must return a value which indicates the paragraph's end state: see below. -.PP -Some syntaxes can have constructs that span paragraphs. For example, a C++ syntax highlighter should be able to cope with \fC/\fR\fC*...*\fR\fC/\fR comments that span paragraphs. To deal with these cases it is necessary to know the end state of the previous paragraph (e.g. "in comment"). -.PP -If your syntax does not have paragraph spanning constructs, simply ignore the \fIendStateOfLastPara\fR parameter and always return 0. -.PP -Whenever highlightParagraph() is called it is passed a value for \fIendStateOfLastPara\fR. For the very first paragraph this value is always -2. For any other paragraph the value is the value returned by the most recent highlightParagraph() call that applied to the preceding paragraph. -.PP -The value you return is up to you. We recommend only returning 0 (to signify that this paragraph's syntax highlighting does not affect the following paragraph), or a positive integer (to signify that this paragraph has ended in the middle of a paragraph spanning construct). -.PP -To find out which paragraph is highlighted, call currentParagraph(). -.PP -For example, if you're writing a simple C++ syntax highlighter, you might designate 1 to signify "in comment". For a paragraph that ended in the middle of a comment you'd return 1, and for other paragraphs you'd return 0. In your parsing code if \fIendStateOfLastPara\fR was 1, you would highlight the text as a C++ comment until you reached the closing \fC*\fR\fC/\fR. -.SH "void QSyntaxHighlighter::rehighlight ()" -Redoes the highlighting of the whole document. -.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const QFont & font, const QColor & color )" -This function is applied to the syntax highlighter's current paragraph (the text of which is passed to the highlightParagraph() function). -.PP -The specified \fIfont\fR and \fIcolor\fR are applied to the text from position \fIstart\fR for \fIcount\fR characters. (If \fIcount\fR is 0, nothing is done.) -.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const QColor & color )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const QFont & font )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QTextEdit * QSyntaxHighlighter::textEdit () const" -Returns the QTextEdit on which this syntax highlighter is -installed - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsyntaxhighlighter.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qsyntaxhighlighter.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qt.3qt b/doc/man/man3/qt.3qt deleted file mode 100644 index bce3ebb8b..000000000 --- a/doc/man/man3/qt.3qt +++ /dev/null @@ -1,1451 +0,0 @@ -'\" t -.TH Qt 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 -Qt \- Namespace for miscellaneous identifiers that need to be global-like -.SH SYNOPSIS -\fC#include \fR -.PP -Inherited by QObject, QPixmap, QBrush, QCanvasItem, QCursor, QPainter, QEvent, QIconViewItem, QKeySequence, QListViewItem, QCustomMenuItem, QPen, QStyleSheetItem, QSyntaxHighlighter, QTab, QTableItem, QThread, QToolTip, and QWhatsThis. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBButtonState\fR { NoButton = 0x0000, LeftButton = 0x0001, RightButton = 0x0002, MidButton = 0x0004, MouseButtonMask = 0x0007, ShiftButton = 0x0100, ControlButton = 0x0200, AltButton = 0x0400, MetaButton = 0x0800, KeyButtonMask = 0x0f00, Keypad = 0x4000 }" -.br -.ti -1c -.BI "enum \fBOrientation\fR { Horizontal = 0, Vertical }" -.br -.ti -1c -.BI "enum \fBSortOrder\fR { Ascending, Descending }" -.br -.ti -1c -.BI "enum \fBAlignmentFlags\fR { AlignAuto = 0x0000, AlignLeft = 0x0001, AlignRight = 0x0002, AlignHCenter = 0x0004, AlignJustify = 0x0008, AlignHorizontal_Mask = AlignLeft | AlignRight | AlignHCenter | AlignJustify, AlignTop = 0x0010, AlignBottom = 0x0020, AlignVCenter = 0x0040, AlignVertical_Mask = AlignTop | AlignBottom | AlignVCenter, AlignCenter = AlignVCenter | AlignHCenter }" -.br -.ti -1c -.BI "enum \fBTextFlags\fR { SingleLine = 0x0080, DontClip = 0x0100, ExpandTabs = 0x0200, ShowPrefix = 0x0400, WordBreak = 0x0800, BreakAnywhere = 0x1000, NoAccel = 0x4000 }" -.br -.ti -1c -.BI "enum \fBWidgetState\fR { WState_Created = 0x00000001, WState_Disabled = 0x00000002, WState_Visible = 0x00000004, WState_ForceHide = 0x00000008, WState_OwnCursor = 0x00000010, WState_MouseTracking = 0x00000020, WState_CompressKeys = 0x00000040, WState_BlockUpdates = 0x00000080, WState_InPaintEvent = 0x00000100, WState_Reparented = 0x00000200, WState_ConfigPending = 0x00000400, WState_Resized = 0x00000800, WState_AutoMask = 0x00001000, WState_Polished = 0x00002000, WState_DND = 0x00004000, WState_Reserved0 = 0x00008000, WState_FullScreen = 0x00010000, WState_OwnSizePolicy = 0x00020000, WState_CreatedHidden = 0x00040000, WState_Maximized = 0x00080000, WState_Minimized = 0x00100000, WState_ForceDisabled = 0x00200000, WState_Exposed = 0x00400000, WState_HasMouse = 0x00800000 }" -.br -.ti -1c -.BI "enum \fBWidgetFlags\fR { WType_TopLevel = 0x00000001, WType_Dialog = 0x00000002, WType_Popup = 0x00000004, WType_Desktop = 0x00000008, WType_Mask = 0x0000000f, WStyle_Customize = 0x00000010, WStyle_NormalBorder = 0x00000020, WStyle_DialogBorder = 0x00000040, WStyle_NoBorder = 0x00002000, WStyle_Title = 0x00000080, WStyle_SysMenu = 0x00000100, WStyle_Minimize = 0x00000200, WStyle_Maximize = 0x00000400, WStyle_MinMax = WStyle_Minimize | WStyle_Maximize, WStyle_Tool = 0x00000800, WStyle_StaysOnTop = 0x00001000, WStyle_ContextHelp = 0x00004000, WStyle_Reserved = 0x00008000, WStyle_Mask = 0x0000fff0, WDestructiveClose = 0x00010000, WPaintDesktop = 0x00020000, WPaintUnclipped = 0x00040000, WPaintClever = 0x00080000, WResizeNoErase = 0x00100000, WMouseNoMask = 0x00200000, WStaticContents = 0x00400000, WRepaintNoErase = 0x00800000, WX11BypassWM = 0x01000000, WWinOwnDC = 0x00000000, WMacNoSheet = 0x00000000, WMacDrawer = 0x00000000, WX11BypassWM = 0x00000000, WWinOwnDC = 0x01000000, WMacNoSheet = 0x00000000, WMacDrawer = 0x00000000, WGroupLeader = 0x02000000, WShowModal = 0x04000000, WNoMousePropagation = 0x08000000, WSubWindow = 0x10000000, WStyle_Splash = 0x20000000, WNoAutoErase = WRepaintNoErase | WResizeNoErase, WNorthWestGravity = WStaticContents, WType_Modal = WType_Dialog | WShowModal, WStyle_Dialog = WType_Dialog, WStyle_NoBorderEx = WStyle_NoBorder }" -.br -.ti -1c -.BI "enum \fBWindowState\fR { WindowNoState = 0x00000000, WindowMinimized = 0x00000001, WindowMaximized = 0x00000002, WindowFullScreen = 0x00000004, WindowActive = 0x00000008 }" -.br -.ti -1c -.BI "enum \fBImageConversionFlags\fR { ColorMode_Mask = 0x00000003, AutoColor = 0x00000000, ColorOnly = 0x00000003, MonoOnly = 0x00000002, AlphaDither_Mask = 0x0000000c, ThresholdAlphaDither = 0x00000000, OrderedAlphaDither = 0x00000004, DiffuseAlphaDither = 0x00000008, NoAlpha = 0x0000000c, Dither_Mask = 0x00000030, DiffuseDither = 0x00000000, OrderedDither = 0x00000010, ThresholdDither = 0x00000020, DitherMode_Mask = 0x000000c0, AutoDither = 0x00000000, PreferDither = 0x00000040, AvoidDither = 0x00000080 }" -.br -.ti -1c -.BI "enum \fBBGMode\fR { TransparentMode, OpaqueMode }" -.br -.ti -1c -.BI "enum \fBPaintUnit\fR { PixelUnit, LoMetricUnit, HiMetricUnit, LoEnglishUnit, HiEnglishUnit, TwipsUnit }" -.br -.ti -1c -.BI "enum GUIStyle { MacStyle, WindowsStyle, Win3Style, PMStyle, MotifStyle } \fI(obsolete)\fR" -.br -.ti -1c -.BI "enum \fBSequenceMatch\fR { NoMatch, PartialMatch, Identical }" -.br -.ti -1c -.BI "enum \fBModifier\fR { META = 0x00100000, SHIFT = 0x00200000, CTRL = 0x00400000, ALT = 0x00800000, MODIFIER_MASK = 0x00f00000, UNICODE_ACCEL = 0x10000000, ASCII_ACCEL = UNICODE_ACCEL }" -.br -.ti -1c -.BI "enum \fBKey\fR { Key_Escape = 0x1000, Key_Tab = 0x1001, Key_Backtab = 0x1002, Key_BackTab = Key_Backtab, Key_Backspace = 0x1003, Key_BackSpace = Key_Backspace, Key_Return = 0x1004, Key_Enter = 0x1005, Key_Insert = 0x1006, Key_Delete = 0x1007, Key_Pause = 0x1008, Key_Print = 0x1009, Key_SysReq = 0x100a, Key_Clear = 0x100b, Key_Home = 0x1010, Key_End = 0x1011, Key_Left = 0x1012, Key_Up = 0x1013, Key_Right = 0x1014, Key_Down = 0x1015, Key_Prior = 0x1016, Key_PageUp = Key_Prior, Key_Next = 0x1017, Key_PageDown = Key_Next, Key_Shift = 0x1020, Key_Control = 0x1021, Key_Meta = 0x1022, Key_Alt = 0x1023, Key_CapsLock = 0x1024, Key_NumLock = 0x1025, Key_ScrollLock = 0x1026, Key_F1 = 0x1030, Key_F2 = 0x1031, Key_F3 = 0x1032, Key_F4 = 0x1033, Key_F5 = 0x1034, Key_F6 = 0x1035, Key_F7 = 0x1036, Key_F8 = 0x1037, Key_F9 = 0x1038, Key_F10 = 0x1039, Key_F11 = 0x103a, Key_F12 = 0x103b, Key_F13 = 0x103c, Key_F14 = 0x103d, Key_F15 = 0x103e, Key_F16 = 0x103f, Key_F17 = 0x1040, Key_F18 = 0x1041, Key_F19 = 0x1042, Key_F20 = 0x1043, Key_F21 = 0x1044, Key_F22 = 0x1045, Key_F23 = 0x1046, Key_F24 = 0x1047, Key_F25 = 0x1048, Key_F26 = 0x1049, Key_F27 = 0x104a, Key_F28 = 0x104b, Key_F29 = 0x104c, Key_F30 = 0x104d, Key_F31 = 0x104e, Key_F32 = 0x104f, Key_F33 = 0x1050, Key_F34 = 0x1051, Key_F35 = 0x1052, Key_Super_L = 0x1053, Key_Super_R = 0x1054, Key_Menu = 0x1055, Key_Hyper_L = 0x1056, Key_Hyper_R = 0x1057, Key_Help = 0x1058, Key_Direction_L = 0x1059, Key_Direction_R = 0x1060, Key_Space = 0x20, Key_Any = Key_Space, Key_Exclam = 0x21, Key_QuoteDbl = 0x22, Key_NumberSign = 0x23, Key_Dollar = 0x24, Key_Percent = 0x25, Key_Ampersand = 0x26, Key_Apostrophe = 0x27, Key_ParenLeft = 0x28, Key_ParenRight = 0x29, Key_Asterisk = 0x2a, Key_Plus = 0x2b, Key_Comma = 0x2c, Key_Minus = 0x2d, Key_Period = 0x2e, Key_Slash = 0x2f, Key_0 = 0x30, Key_1 = 0x31, Key_2 = 0x32, Key_3 = 0x33, Key_4 = 0x34, Key_5 = 0x35, Key_6 = 0x36, Key_7 = 0x37, Key_8 = 0x38, Key_9 = 0x39, Key_Colon = 0x3a, Key_Semicolon = 0x3b, Key_Less = 0x3c, Key_Equal = 0x3d, Key_Greater = 0x3e, Key_Question = 0x3f, Key_At = 0x40, Key_A = 0x41, Key_B = 0x42, Key_C = 0x43, Key_D = 0x44, Key_E = 0x45, Key_F = 0x46, Key_G = 0x47, Key_H = 0x48, Key_I = 0x49, Key_J = 0x4a, Key_K = 0x4b, Key_L = 0x4c, Key_M = 0x4d, Key_N = 0x4e, Key_O = 0x4f, Key_P = 0x50, Key_Q = 0x51, Key_R = 0x52, Key_S = 0x53, Key_T = 0x54, Key_U = 0x55, Key_V = 0x56, Key_W = 0x57, Key_X = 0x58, Key_Y = 0x59, Key_Z = 0x5a, Key_BracketLeft = 0x5b, Key_Backslash = 0x5c, Key_BracketRight = 0x5d, Key_AsciiCircum = 0x5e, Key_Underscore = 0x5f, Key_QuoteLeft = 0x60, Key_BraceLeft = 0x7b, Key_Bar = 0x7c, Key_BraceRight = 0x7d, Key_AsciiTilde = 0x7e, Key_nobreakspace = 0x0a0, Key_exclamdown = 0x0a1, Key_cent = 0x0a2, Key_sterling = 0x0a3, Key_currency = 0x0a4, Key_yen = 0x0a5, Key_brokenbar = 0x0a6, Key_section = 0x0a7, Key_diaeresis = 0x0a8, Key_copyright = 0x0a9, Key_ordfeminine = 0x0aa, Key_guillemotleft = 0x0ab, Key_notsign = 0x0ac, Key_hyphen = 0x0ad, Key_registered = 0x0ae, Key_macron = 0x0af, Key_degree = 0x0b0, Key_plusminus = 0x0b1, Key_twosuperior = 0x0b2, Key_threesuperior = 0x0b3, Key_acute = 0x0b4, Key_mu = 0x0b5, Key_paragraph = 0x0b6, Key_periodcentered = 0x0b7, Key_cedilla = 0x0b8, Key_onesuperior = 0x0b9, Key_masculine = 0x0ba, Key_guillemotright = 0x0bb, Key_onequarter = 0x0bc, Key_onehalf = 0x0bd, Key_threequarters = 0x0be, Key_questiondown = 0x0bf, Key_Agrave = 0x0c0, Key_Aacute = 0x0c1, Key_Acircumflex = 0x0c2, Key_Atilde = 0x0c3, Key_Adiaeresis = 0x0c4, Key_Aring = 0x0c5, Key_AE = 0x0c6, Key_Ccedilla = 0x0c7, Key_Egrave = 0x0c8, Key_Eacute = 0x0c9, Key_Ecircumflex = 0x0ca, Key_Ediaeresis = 0x0cb, Key_Igrave = 0x0cc, Key_Iacute = 0x0cd, Key_Icircumflex = 0x0ce, Key_Idiaeresis = 0x0cf, Key_ETH = 0x0d0, Key_Ntilde = 0x0d1, Key_Ograve = 0x0d2, Key_Oacute = 0x0d3, Key_Ocircumflex = 0x0d4, Key_Otilde = 0x0d5, Key_Odiaeresis = 0x0d6, Key_multiply = 0x0d7, Key_Ooblique = 0x0d8, Key_Ugrave = 0x0d9, Key_Uacute = 0x0da, Key_Ucircumflex = 0x0db, Key_Udiaeresis = 0x0dc, Key_Yacute = 0x0dd, Key_THORN = 0x0de, Key_ssharp = 0x0df, Key_agrave = 0x0e0, Key_aacute = 0x0e1, Key_acircumflex = 0x0e2, Key_atilde = 0x0e3, Key_adiaeresis = 0x0e4, Key_aring = 0x0e5, Key_ae = 0x0e6, Key_ccedilla = 0x0e7, Key_egrave = 0x0e8, Key_eacute = 0x0e9, Key_ecircumflex = 0x0ea, Key_ediaeresis = 0x0eb, Key_igrave = 0x0ec, Key_iacute = 0x0ed, Key_icircumflex = 0x0ee, Key_idiaeresis = 0x0ef, Key_eth = 0x0f0, Key_ntilde = 0x0f1, Key_ograve = 0x0f2, Key_oacute = 0x0f3, Key_ocircumflex = 0x0f4, Key_otilde = 0x0f5, Key_odiaeresis = 0x0f6, Key_division = 0x0f7, Key_oslash = 0x0f8, Key_ugrave = 0x0f9, Key_uacute = 0x0fa, Key_ucircumflex = 0x0fb, Key_udiaeresis = 0x0fc, Key_yacute = 0x0fd, Key_thorn = 0x0fe, Key_ydiaeresis = 0x0ff, Key_Back = 0x1061, Key_Forward = 0x1062, Key_Stop = 0x1063, Key_Refresh = 0x1064, Key_VolumeDown = 0x1070, Key_VolumeMute = 0x1071, Key_VolumeUp = 0x1072, Key_BassBoost = 0x1073, Key_BassUp = 0x1074, Key_BassDown = 0x1075, Key_TrebleUp = 0x1076, Key_TrebleDown = 0x1077, Key_MediaPlay = 0x1080, Key_MediaStop = 0x1081, Key_MediaPrev = 0x1082, Key_MediaNext = 0x1083, Key_MediaRecord = 0x1084, Key_HomePage = 0x1090, Key_Favorites = 0x1091, Key_Search = 0x1092, Key_Standby = 0x1093, Key_OpenUrl = 0x1094, Key_LaunchMail = 0x10a0, Key_LaunchMedia = 0x10a1, Key_Launch0 = 0x10a2, Key_Launch1 = 0x10a3, Key_Launch2 = 0x10a4, Key_Launch3 = 0x10a5, Key_Launch4 = 0x10a6, Key_Launch5 = 0x10a7, Key_Launch6 = 0x10a8, Key_Launch7 = 0x10a9, Key_Launch8 = 0x10aa, Key_Launch9 = 0x10ab, Key_LaunchA = 0x10ac, Key_LaunchB = 0x10ad, Key_LaunchC = 0x10ae, Key_LaunchD = 0x10af, Key_LaunchE = 0x10b0, Key_LaunchF = 0x10b1, Key_MediaLast = 0x1fff, Key_unknown = 0xffff }" -.br -.ti -1c -.BI "enum \fBArrowType\fR { UpArrow, DownArrow, LeftArrow, RightArrow }" -.br -.ti -1c -.BI "enum \fBRasterOp\fR { CopyROP, OrROP, XorROP, NotAndROP, EraseROP = NotAndROP, NotCopyROP, NotOrROP, NotXorROP, AndROP, NotEraseROP = AndROP, NotROP, ClearROP, SetROP, NopROP, AndNotROP, OrNotROP, NandROP, NorROP, LastROP = NorROP }" -.br -.ti -1c -.BI "enum \fBPenStyle\fR { NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine, MPenStyle = 0x0f }" -.br -.ti -1c -.BI "enum \fBPenCapStyle\fR { FlatCap = 0x00, SquareCap = 0x10, RoundCap = 0x20, MPenCapStyle = 0x30 }" -.br -.ti -1c -.BI "enum \fBPenJoinStyle\fR { MiterJoin = 0x00, BevelJoin = 0x40, RoundJoin = 0x80, MPenJoinStyle = 0xc0 }" -.br -.ti -1c -.BI "enum \fBBrushStyle\fR { NoBrush, SolidPattern, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, HorPattern, VerPattern, CrossPattern, BDiagPattern, FDiagPattern, DiagCrossPattern, CustomPattern = 24 }" -.br -.ti -1c -.BI "enum \fBMacintoshVersion\fR { MV_Unknown = 0x0000, MV_9 = 0x0001, MV_10_DOT_0 = 0x0002, MV_10_DOT_1 = 0x0003, MV_10_DOT_2 = 0x0004, MV_10_DOT_3 = 0x0005, MV_10_DOT_4 = 0x0006, MV_CHEETAH = MV_10_DOT_0, MV_PUMA = MV_10_DOT_1, MV_JAGUAR = MV_10_DOT_2, MV_PANTHER = MV_10_DOT_3, MV_TIGER = MV_10_DOT_4 }" -.br -.ti -1c -.BI "enum \fBWindowsVersion\fR { WV_32s = 0x0001, WV_95 = 0x0002, WV_98 = 0x0003, WV_Me = 0x0004, WV_DOS_based = 0x000f, WV_NT = 0x0010, WV_2000 = 0x0020, WV_XP = 0x0030, WV_2003 = 0x0040, WV_VISTA = 0x0080, WV_NT_based = 0x00f0, WV_CE = 0x0100, WV_CENET = 0x0200, WV_CE_based = 0x0f00 }" -.br -.ti -1c -.BI "enum \fBUIEffect\fR { UI_General, UI_AnimateMenu, UI_FadeMenu, UI_AnimateCombo, UI_AnimateTooltip, UI_FadeTooltip, UI_AnimateToolBox }" -.br -.ti -1c -.BI "enum \fBCursorShape\fR { ArrowCursor, UpArrowCursor, CrossCursor, WaitCursor, IbeamCursor, SizeVerCursor, SizeHorCursor, SizeBDiagCursor, SizeFDiagCursor, SizeAllCursor, BlankCursor, SplitVCursor, SplitHCursor, PointingHandCursor, ForbiddenCursor, WhatsThisCursor, BusyCursor, LastCursor = BusyCursor, BitmapCursor = 24 }" -.br -.ti -1c -.BI "enum \fBTextFormat\fR { PlainText, RichText, AutoText, LogText }" -.br -.ti -1c -.BI "enum \fBAnchorAttribute\fR { AnchorName, AnchorHref }" -.br -.ti -1c -.BI "enum \fBDock\fR { DockUnmanaged, DockTornOff, DockTop, DockBottom, DockRight, DockLeft, DockMinimized, Unmanaged = DockUnmanaged, TornOff = DockTornOff, Top = DockTop, Bottom = DockBottom, Right = DockRight, Left = DockLeft, Minimized = DockMinimized }" -.br -.ti -1c -.BI "enum \fBDateFormat\fR { TextDate, ISODate, LocalDate }" -.br -.ti -1c -.BI "enum \fBTimeSpec\fR { LocalTime, UTC }" -.br -.ti -1c -.BI "enum \fBBackgroundMode\fR { FixedColor, FixedPixmap, NoBackground, PaletteForeground, PaletteButton, PaletteLight, PaletteMidlight, PaletteDark, PaletteMid, PaletteText, PaletteBrightText, PaletteBase, PaletteBackground, PaletteShadow, PaletteHighlight, PaletteHighlightedText, PaletteButtonText, PaletteLink, PaletteLinkVisited, X11ParentRelative }" -.br -.ti -1c -.BI "enum \fBStringComparisonMode\fR { CaseSensitive = 0x00001, BeginsWith = 0x00002, EndsWith = 0x00004, Contains = 0x00008, ExactMatch = 0x00010 }" -.br -.ti -1c -.BI "enum \fBCorner\fR { TopLeft = 0x00000, TopRight = 0x00001, BottomLeft = 0x00002, BottomRight = 0x00003 }" -.br -.ti -1c -.BI "typedef void * \fBHANDLE\fR" -.br -.in -1c -.SH DESCRIPTION -The Qt class is a namespace for miscellaneous identifiers that need to be global-like. -.PP -Normally, you can ignore this class. QObject and a few other classes inherit it, so all the identifiers in the Qt namespace are normally usable without qualification. -.PP -However, you may occasionally need to say \fCQt::black\fR instead of just \fCblack\fR, particularly in static utility functions (such as many class factories). -.PP -See also Miscellaneous Classes. -.SS "Member Type Documentation" -.SH "Qt::AlignmentFlags" -This enum type is used to describe alignment. It contains horizontal and vertical flags. -.PP -The horizontal flags are: -.TP -\fCQt::AlignAuto\fR - Aligns according to the language. Left for most, right for Arabic and Hebrew. -.TP -\fCQt::AlignLeft\fR - Aligns with the left edge. -.TP -\fCQt::AlignRight\fR - Aligns with the right edge. -.TP -\fCQt::AlignHCenter\fR - Centers horizontally in the available space. -.TP -\fCQt::AlignJustify\fR - Justifies the text in the available space. Does not work for everything and may be interpreted as AlignAuto in some cases. -.PP -The vertical flags are: -.TP -\fCQt::AlignTop\fR - Aligns with the top. -.TP -\fCQt::AlignBottom\fR - Aligns with the bottom. -.TP -\fCQt::AlignVCenter\fR - Centers vertically in the available space. -.PP -You can use only one of the horizontal flags at a time. There is one two-dimensional flag: -.TP -\fCQt::AlignCenter\fR - Centers in both dimensions. -.PP -You can use at most one horizontal and one vertical flag at a time. AlignCenter counts as both horizontal and vertical. -.PP -Masks: -.TP -\fCQt::AlignHorizontal_Mask\fR -.TP -\fCQt::AlignVertical_Mask\fR -.PP -Conflicting combinations of flags have undefined meanings. -.SH "Qt::AnchorAttribute" -An anchor has one or more of the following attributes: -.TP -\fCQt::AnchorName\fR - the name attribute of the anchor. This attribute is used when scrolling to an anchor in the document. -.TP -\fCQt::AnchorHref\fR - the href attribute of the anchor. This attribute is used when a link is clicked to determine what content to load. -.SH "Qt::ArrowType" -.TP -\fCQt::UpArrow\fR -.TP -\fCQt::DownArrow\fR -.TP -\fCQt::LeftArrow\fR -.TP -\fCQt::RightArrow\fR -.SH "Qt::BGMode" -Background mode -.TP -\fCQt::TransparentMode\fR -.TP -\fCQt::OpaqueMode\fR -.SH "Qt::BackgroundMode" -This enum describes how the background of a widget changes, as the widget's palette changes. -.PP -The background is what the widget contains when paintEvent() is called. To minimize flicker, this should be the most common color or pixmap in the widget. For PaletteBackground, use colorGroup().brush( QColorGroup::Background ), and so on. -.TP -\fCQt::PaletteForeground\fR -.TP -\fCQt::PaletteBackground\fR -.TP -\fCQt::PaletteButton\fR -.TP -\fCQt::PaletteLight\fR -.TP -\fCQt::PaletteMidlight\fR -.TP -\fCQt::PaletteDark\fR -.TP -\fCQt::PaletteMid\fR -.TP -\fCQt::PaletteText\fR -.TP -\fCQt::PaletteBrightText\fR -.TP -\fCQt::PaletteButtonText\fR -.TP -\fCQt::PaletteBase\fR -.TP -\fCQt::PaletteShadow\fR -.TP -\fCQt::PaletteHighlight\fR -.TP -\fCQt::PaletteHighlightedText\fR -.TP -\fCQt::PaletteLink\fR -.TP -\fCQt::PaletteLinkVisited\fR -.TP -\fCQt::X11ParentRelative\fR - (internal use only) -.PP -The final three values have special meaning: -.TP -\fCQt::NoBackground\fR - the widget is not cleared before paintEvent(). If the widget's paint event always draws on all the pixels, using this mode can be both fast and flicker-free. -.TP -\fCQt::FixedColor\fR - the widget is cleared to a fixed color, normally different from all the ones in the palette(). Set using setPaletteBackgroundColor(). -.TP -\fCQt::FixedPixmap\fR - the widget is cleared to a fixed pixmap, normally different from all the ones in the palette(). Set using setPaletteBackgroundPixmap(). -.PP -Although FixedColor and FixedPixmap are sometimes just right, if you use them, make sure that you test your application when the desktop color scheme has been changed. (On X11, a quick way to test this is e.g. "./myapp -bg paleblue". On Windows, you must use the control panel.) -.PP -See also QWidget::backgroundMode, QWidget::backgroundMode, QWidget::setBackgroundPixmap(), and QWidget::paletteBackgroundColor. -.SH "Qt::BrushStyle" -.TP -\fCQt::NoBrush\fR -.TP -\fCQt::SolidPattern\fR -.TP -\fCQt::Dense1Pattern\fR -.TP -\fCQt::Dense2Pattern\fR -.TP -\fCQt::Dense3Pattern\fR -.TP -\fCQt::Dense4Pattern\fR -.TP -\fCQt::Dense5Pattern\fR -.TP -\fCQt::Dense6Pattern\fR -.TP -\fCQt::Dense7Pattern\fR -.TP -\fCQt::HorPattern\fR -.TP -\fCQt::VerPattern\fR -.TP -\fCQt::CrossPattern\fR -.TP -\fCQt::BDiagPattern\fR -.TP -\fCQt::FDiagPattern\fR -.TP -\fCQt::DiagCrossPattern\fR -.TP -\fCQt::CustomPattern\fR -.PP -
                                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                                            -.SH "Qt::ButtonState" -This enum type describes the state of the mouse and the modifier buttons. -.TP -\fCQt::NoButton\fR - used when the button state does not refer to any button (see QMouseEvent::button()). -.TP -\fCQt::LeftButton\fR - set if the left button is pressed, or if this event refers to the left button. (The left button may be the right button on left-handed mice.) -.TP -\fCQt::RightButton\fR - the right button. -.TP -\fCQt::MidButton\fR - the middle button. -.TP -\fCQt::ShiftButton\fR - a Shift key on the keyboard is also pressed. -.TP -\fCQt::ControlButton\fR - a Ctrl key on the keyboard is also pressed. -.TP -\fCQt::AltButton\fR - an Alt key on the keyboard is also pressed. -.TP -\fCQt::MetaButton\fR - a Meta key on the keyboard is also pressed. -.TP -\fCQt::Keypad\fR - a keypad button is pressed. -.TP -\fCQt::KeyButtonMask\fR - a mask for ShiftButton, ControlButton, AltButton and MetaButton. -.TP -\fCQt::MouseButtonMask\fR - a mask for LeftButton, RightButton and MidButton. -.SH "Qt::Corner" -This enum type specifies a corner in a rectangle: -.TP -\fCQt::TopLeft\fR - top left corner -.TP -\fCQt::TopRight\fR - top right corner -.TP -\fCQt::BottomLeft\fR - bottom left corner -.TP -\fCQt::BottomRight\fR - bottom right corner -.SH "Qt::CursorShape" -This enum type defines the various cursors that can be used. -.TP -\fCQt::ArrowCursor\fR - standard arrow cursor -.TP -\fCQt::UpArrowCursor\fR - upwards arrow -.TP -\fCQt::CrossCursor\fR - crosshair -.TP -\fCQt::WaitCursor\fR - hourglass/watch -.TP -\fCQt::BusyCursor\fR - standard arrow with hourglass/watch -.TP -\fCQt::IbeamCursor\fR - ibeam/text entry -.TP -\fCQt::SizeVerCursor\fR - vertical resize -.TP -\fCQt::SizeHorCursor\fR - horizontal resize -.TP -\fCQt::SizeFDiagCursor\fR - diagonal resize (\) -.TP -\fCQt::SizeBDiagCursor\fR - diagonal resize (/) -.TP -\fCQt::SizeAllCursor\fR - all directions resize -.TP -\fCQt::BlankCursor\fR - blank/invisible cursor -.TP -\fCQt::SplitVCursor\fR - vertical splitting -.TP -\fCQt::SplitHCursor\fR - horizontal splitting -.TP -\fCQt::PointingHandCursor\fR - a pointing hand -.TP -\fCQt::ForbiddenCursor\fR - a slashed circle -.TP -\fCQt::WhatsThisCursor\fR - an arrow with a question mark -.TP -\fCQt::BitmapCursor\fR -.PP -ArrowCursor is the default for widgets in a normal state. -.PP -
                                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                                            -.SH "Qt::DateFormat" -.TP -\fCQt::TextDate\fR - (default) Qt format -.TP -\fCQt::ISODate\fR - ISO 8601 extended format (YYYY-MM-DD, or with time, YYYY-MM-DDTHH:MM:SS) -.TP -\fCQt::LocalDate\fR - locale dependent format -.SH "Qt::Dock" -Each dock window can be in one of the following positions: -.TP -\fCQt::DockTop\fR - above the central widget, below the menu bar. -.TP -\fCQt::DockBottom\fR - below the central widget, above the status bar. -.TP -\fCQt::DockLeft\fR - to the left of the central widget. -.TP -\fCQt::DockRight\fR - to the right of the central widget. -.TP -\fCQt::DockMinimized\fR - the dock window is not shown (this is effectively a 'hidden' dock area); the handles of all minimized dock windows are drawn in one row below the menu bar. -.TP -\fCQt::DockTornOff\fR - the dock window floats as its own top level window which always stays on top of the main window. -.TP -\fCQt::DockUnmanaged\fR - not managed by a QMainWindow. -.SH "Qt::GUIStyle" -\fBThis type is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.TP -\fCQt::WindowsStyle\fR -.TP -\fCQt::MotifStyle\fR -.TP -\fCQt::MacStyle\fR -.TP -\fCQt::Win3Style\fR -.TP -\fCQt::PMStyle\fR -.SH "Qt::ImageConversionFlags" -The conversion flag is a bitwise-OR of the following values. The options marked "(default)" are set if no other values from the list are included (since the defaults are zero): -.PP -Color/Mono preference (ignored for QBitmap) -.TP -\fCQt::AutoColor\fR - (default) - If the image has depth 1 and contains only black and white pixels, the pixmap becomes monochrome. -.TP -\fCQt::ColorOnly\fR - The pixmap is dithered/converted to the native display depth. -.TP -\fCQt::MonoOnly\fR - The pixmap becomes monochrome. If necessary, it is dithered using the chosen dithering algorithm. -.PP -Dithering mode preference for RGB channels -.TP -\fCQt::DiffuseDither\fR - (default) - A high-quality dither. -.TP -\fCQt::OrderedDither\fR - A faster, more ordered dither. -.TP -\fCQt::ThresholdDither\fR - No dithering; closest color is used. -.PP -Dithering mode preference for alpha channel -.TP -\fCQt::ThresholdAlphaDither\fR - (default) - No dithering. -.TP -\fCQt::OrderedAlphaDither\fR - A faster, more ordered dither. -.TP -\fCQt::DiffuseAlphaDither\fR - A high-quality dither. -.TP -\fCQt::NoAlpha\fR - Not supported. -.PP -Color matching versus dithering preference -.TP -\fCQt::PreferDither\fR - (default when converting to a pixmap) - Always dither 32-bit images when the image is converted to 8 bits. -.TP -\fCQt::AvoidDither\fR - (default when converting for the purpose of saving to file) - Dither 32-bit images only if the image has more than 256 colors and it is being converted to 8 bits. -.TP -\fCQt::AutoDither\fR - Not supported. -.PP -The following are not values that are used directly, but masks for the above classes: -.TP -\fCQt::ColorMode_Mask\fR - Mask for the color mode. -.TP -\fCQt::Dither_Mask\fR - Mask for the dithering mode for RGB channels. -.TP -\fCQt::AlphaDither_Mask\fR - Mask for the dithering mode for the alpha channel. -.TP -\fCQt::DitherMode_Mask\fR - Mask for the mode that determines the preference of color matching versus dithering. -.PP -Using 0 as the conversion flag sets all the default options. -.SH "Qt::Key" -The key names used by Qt. -.TP -\fCQt::Key_Escape\fR -.TP -\fCQt::Key_Tab\fR -.TP -\fCQt::Key_Backtab\fR -.TP -\fCQt::Key_Backspace\fR -.TP -\fCQt::Key_Return\fR -.TP -\fCQt::Key_Enter\fR -.TP -\fCQt::Key_Insert\fR -.TP -\fCQt::Key_Delete\fR -.TP -\fCQt::Key_Pause\fR -.TP -\fCQt::Key_Print\fR -.TP -\fCQt::Key_SysReq\fR -.TP -\fCQt::Key_Home\fR -.TP -\fCQt::Key_End\fR -.TP -\fCQt::Key_Left\fR -.TP -\fCQt::Key_Up\fR -.TP -\fCQt::Key_Right\fR -.TP -\fCQt::Key_Down\fR -.TP -\fCQt::Key_Prior\fR -.TP -\fCQt::Key_Next\fR -.TP -\fCQt::Key_Shift\fR -.TP -\fCQt::Key_Control\fR -.TP -\fCQt::Key_Meta\fR -.TP -\fCQt::Key_Alt\fR -.TP -\fCQt::Key_CapsLock\fR -.TP -\fCQt::Key_NumLock\fR -.TP -\fCQt::Key_ScrollLock\fR -.TP -\fCQt::Key_Clear\fR -.TP -\fCQt::Key_F1\fR -.TP -\fCQt::Key_F2\fR -.TP -\fCQt::Key_F3\fR -.TP -\fCQt::Key_F4\fR -.TP -\fCQt::Key_F5\fR -.TP -\fCQt::Key_F6\fR -.TP -\fCQt::Key_F7\fR -.TP -\fCQt::Key_F8\fR -.TP -\fCQt::Key_F9\fR -.TP -\fCQt::Key_F10\fR -.TP -\fCQt::Key_F11\fR -.TP -\fCQt::Key_F12\fR -.TP -\fCQt::Key_F13\fR -.TP -\fCQt::Key_F14\fR -.TP -\fCQt::Key_F15\fR -.TP -\fCQt::Key_F16\fR -.TP -\fCQt::Key_F17\fR -.TP -\fCQt::Key_F18\fR -.TP -\fCQt::Key_F19\fR -.TP -\fCQt::Key_F20\fR -.TP -\fCQt::Key_F21\fR -.TP -\fCQt::Key_F22\fR -.TP -\fCQt::Key_F23\fR -.TP -\fCQt::Key_F24\fR -.TP -\fCQt::Key_F25\fR -.TP -\fCQt::Key_F26\fR -.TP -\fCQt::Key_F27\fR -.TP -\fCQt::Key_F28\fR -.TP -\fCQt::Key_F29\fR -.TP -\fCQt::Key_F30\fR -.TP -\fCQt::Key_F31\fR -.TP -\fCQt::Key_F32\fR -.TP -\fCQt::Key_F33\fR -.TP -\fCQt::Key_F34\fR -.TP -\fCQt::Key_F35\fR -.TP -\fCQt::Key_Super_L\fR -.TP -\fCQt::Key_Super_R\fR -.TP -\fCQt::Key_Menu\fR -.TP -\fCQt::Key_Hyper_L\fR -.TP -\fCQt::Key_Hyper_R\fR -.TP -\fCQt::Key_Help\fR -.TP -\fCQt::Key_Space\fR -.TP -\fCQt::Key_Any\fR -.TP -\fCQt::Key_Exclam\fR -.TP -\fCQt::Key_QuoteDbl\fR -.TP -\fCQt::Key_NumberSign\fR -.TP -\fCQt::Key_Dollar\fR -.TP -\fCQt::Key_Percent\fR -.TP -\fCQt::Key_Ampersand\fR -.TP -\fCQt::Key_Apostrophe\fR -.TP -\fCQt::Key_ParenLeft\fR -.TP -\fCQt::Key_ParenRight\fR -.TP -\fCQt::Key_Asterisk\fR -.TP -\fCQt::Key_Plus\fR -.TP -\fCQt::Key_Comma\fR -.TP -\fCQt::Key_Minus\fR -.TP -\fCQt::Key_Period\fR -.TP -\fCQt::Key_Slash\fR -.TP -\fCQt::Key_0\fR -.TP -\fCQt::Key_1\fR -.TP -\fCQt::Key_2\fR -.TP -\fCQt::Key_3\fR -.TP -\fCQt::Key_4\fR -.TP -\fCQt::Key_5\fR -.TP -\fCQt::Key_6\fR -.TP -\fCQt::Key_7\fR -.TP -\fCQt::Key_8\fR -.TP -\fCQt::Key_9\fR -.TP -\fCQt::Key_Colon\fR -.TP -\fCQt::Key_Semicolon\fR -.TP -\fCQt::Key_Less\fR -.TP -\fCQt::Key_Equal\fR -.TP -\fCQt::Key_Greater\fR -.TP -\fCQt::Key_Question\fR -.TP -\fCQt::Key_At\fR -.TP -\fCQt::Key_A\fR -.TP -\fCQt::Key_B\fR -.TP -\fCQt::Key_C\fR -.TP -\fCQt::Key_D\fR -.TP -\fCQt::Key_E\fR -.TP -\fCQt::Key_F\fR -.TP -\fCQt::Key_G\fR -.TP -\fCQt::Key_H\fR -.TP -\fCQt::Key_I\fR -.TP -\fCQt::Key_J\fR -.TP -\fCQt::Key_K\fR -.TP -\fCQt::Key_L\fR -.TP -\fCQt::Key_M\fR -.TP -\fCQt::Key_N\fR -.TP -\fCQt::Key_O\fR -.TP -\fCQt::Key_P\fR -.TP -\fCQt::Key_Q\fR -.TP -\fCQt::Key_R\fR -.TP -\fCQt::Key_S\fR -.TP -\fCQt::Key_T\fR -.TP -\fCQt::Key_U\fR -.TP -\fCQt::Key_V\fR -.TP -\fCQt::Key_W\fR -.TP -\fCQt::Key_X\fR -.TP -\fCQt::Key_Y\fR -.TP -\fCQt::Key_Z\fR -.TP -\fCQt::Key_BracketLeft\fR -.TP -\fCQt::Key_Backslash\fR -.TP -\fCQt::Key_BracketRight\fR -.TP -\fCQt::Key_AsciiCircum\fR -.TP -\fCQt::Key_Underscore\fR -.TP -\fCQt::Key_QuoteLeft\fR -.TP -\fCQt::Key_BraceLeft\fR -.TP -\fCQt::Key_Bar\fR -.TP -\fCQt::Key_BraceRight\fR -.TP -\fCQt::Key_AsciiTilde\fR -.TP -\fCQt::Key_nobreakspace\fR -.TP -\fCQt::Key_exclamdown\fR -.TP -\fCQt::Key_cent\fR -.TP -\fCQt::Key_sterling\fR -.TP -\fCQt::Key_currency\fR -.TP -\fCQt::Key_yen\fR -.TP -\fCQt::Key_brokenbar\fR -.TP -\fCQt::Key_section\fR -.TP -\fCQt::Key_diaeresis\fR -.TP -\fCQt::Key_copyright\fR -.TP -\fCQt::Key_ordfeminine\fR -.TP -\fCQt::Key_guillemotleft\fR -.TP -\fCQt::Key_notsign\fR -.TP -\fCQt::Key_hyphen\fR -.TP -\fCQt::Key_registered\fR -.TP -\fCQt::Key_macron\fR -.TP -\fCQt::Key_degree\fR -.TP -\fCQt::Key_plusminus\fR -.TP -\fCQt::Key_twosuperior\fR -.TP -\fCQt::Key_threesuperior\fR -.TP -\fCQt::Key_acute\fR -.TP -\fCQt::Key_mu\fR -.TP -\fCQt::Key_paragraph\fR -.TP -\fCQt::Key_periodcentered\fR -.TP -\fCQt::Key_cedilla\fR -.TP -\fCQt::Key_onesuperior\fR -.TP -\fCQt::Key_masculine\fR -.TP -\fCQt::Key_guillemotright\fR -.TP -\fCQt::Key_onequarter\fR -.TP -\fCQt::Key_onehalf\fR -.TP -\fCQt::Key_threequarters\fR -.TP -\fCQt::Key_questiondown\fR -.TP -\fCQt::Key_Agrave\fR -.TP -\fCQt::Key_Aacute\fR -.TP -\fCQt::Key_Acircumflex\fR -.TP -\fCQt::Key_Atilde\fR -.TP -\fCQt::Key_Adiaeresis\fR -.TP -\fCQt::Key_Aring\fR -.TP -\fCQt::Key_AE\fR -.TP -\fCQt::Key_Ccedilla\fR -.TP -\fCQt::Key_Egrave\fR -.TP -\fCQt::Key_Eacute\fR -.TP -\fCQt::Key_Ecircumflex\fR -.TP -\fCQt::Key_Ediaeresis\fR -.TP -\fCQt::Key_Igrave\fR -.TP -\fCQt::Key_Iacute\fR -.TP -\fCQt::Key_Icircumflex\fR -.TP -\fCQt::Key_Idiaeresis\fR -.TP -\fCQt::Key_ETH\fR -.TP -\fCQt::Key_Ntilde\fR -.TP -\fCQt::Key_Ograve\fR -.TP -\fCQt::Key_Oacute\fR -.TP -\fCQt::Key_Ocircumflex\fR -.TP -\fCQt::Key_Otilde\fR -.TP -\fCQt::Key_Odiaeresis\fR -.TP -\fCQt::Key_multiply\fR -.TP -\fCQt::Key_Ooblique\fR -.TP -\fCQt::Key_Ugrave\fR -.TP -\fCQt::Key_Uacute\fR -.TP -\fCQt::Key_Ucircumflex\fR -.TP -\fCQt::Key_Udiaeresis\fR -.TP -\fCQt::Key_Yacute\fR -.TP -\fCQt::Key_THORN\fR -.TP -\fCQt::Key_ssharp\fR -.TP -\fCQt::Key_agrave\fR -.TP -\fCQt::Key_aacute\fR -.TP -\fCQt::Key_acircumflex\fR -.TP -\fCQt::Key_atilde\fR -.TP -\fCQt::Key_adiaeresis\fR -.TP -\fCQt::Key_aring\fR -.TP -\fCQt::Key_ae\fR -.TP -\fCQt::Key_ccedilla\fR -.TP -\fCQt::Key_egrave\fR -.TP -\fCQt::Key_eacute\fR -.TP -\fCQt::Key_ecircumflex\fR -.TP -\fCQt::Key_ediaeresis\fR -.TP -\fCQt::Key_igrave\fR -.TP -\fCQt::Key_iacute\fR -.TP -\fCQt::Key_icircumflex\fR -.TP -\fCQt::Key_idiaeresis\fR -.TP -\fCQt::Key_eth\fR -.TP -\fCQt::Key_ntilde\fR -.TP -\fCQt::Key_ograve\fR -.TP -\fCQt::Key_oacute\fR -.TP -\fCQt::Key_ocircumflex\fR -.TP -\fCQt::Key_otilde\fR -.TP -\fCQt::Key_odiaeresis\fR -.TP -\fCQt::Key_division\fR -.TP -\fCQt::Key_oslash\fR -.TP -\fCQt::Key_ugrave\fR -.TP -\fCQt::Key_uacute\fR -.TP -\fCQt::Key_ucircumflex\fR -.TP -\fCQt::Key_udiaeresis\fR -.TP -\fCQt::Key_yacute\fR -.TP -\fCQt::Key_thorn\fR -.TP -\fCQt::Key_ydiaeresis\fR -.PP -Multimedia keys -.TP -\fCQt::Key_Back\fR -.TP -\fCQt::Key_Forward\fR -.TP -\fCQt::Key_Stop\fR -.TP -\fCQt::Key_Refresh\fR -.TP -\fCQt::Key_VolumeDown\fR -.TP -\fCQt::Key_VolumeMute\fR -.TP -\fCQt::Key_VolumeUp\fR -.TP -\fCQt::Key_BassBoost\fR -.TP -\fCQt::Key_BassUp\fR -.TP -\fCQt::Key_BassDown\fR -.TP -\fCQt::Key_TrebleUp\fR -.TP -\fCQt::Key_TrebleDown\fR -.TP -\fCQt::Key_MediaPlay\fR -.TP -\fCQt::Key_MediaStop\fR -.TP -\fCQt::Key_MediaPrev\fR -.TP -\fCQt::Key_MediaNext\fR -.TP -\fCQt::Key_MediaRecord\fR -.TP -\fCQt::Key_HomePage\fR -.TP -\fCQt::Key_Favorites\fR -.TP -\fCQt::Key_Search\fR -.TP -\fCQt::Key_Standby\fR -.TP -\fCQt::Key_OpenUrl\fR -.TP -\fCQt::Key_LaunchMail\fR -.TP -\fCQt::Key_LaunchMedia\fR -.TP -\fCQt::Key_Launch0\fR -.TP -\fCQt::Key_Launch1\fR -.TP -\fCQt::Key_Launch2\fR -.TP -\fCQt::Key_Launch3\fR -.TP -\fCQt::Key_Launch4\fR -.TP -\fCQt::Key_Launch5\fR -.TP -\fCQt::Key_Launch6\fR -.TP -\fCQt::Key_Launch7\fR -.TP -\fCQt::Key_Launch8\fR -.TP -\fCQt::Key_Launch9\fR -.TP -\fCQt::Key_LaunchA\fR -.TP -\fCQt::Key_LaunchB\fR -.TP -\fCQt::Key_LaunchC\fR -.TP -\fCQt::Key_LaunchD\fR -.TP -\fCQt::Key_LaunchE\fR -.TP -\fCQt::Key_LaunchF\fR -.TP -\fCQt::Key_MediaLast\fR -.TP -\fCQt::Key_unknown\fR -.TP -\fCQt::Key_Direction_L\fR - internal use only -.TP -\fCQt::Key_Direction_R\fR - internal use only -.SH "Qt::MacintoshVersion" -.TP -\fCQt::MV_Unknown\fR - Version cannot be detected -.TP -\fCQt::MV_9\fR - Mac OS 9 -.TP -\fCQt::MV_10_DOT_3\fR - Mac OS X 10.3 -.TP -\fCQt::MV_10_DOT_2\fR - Mac OS X 10.2 -.TP -\fCQt::MV_10_DOT_1\fR - Mac OS X 10.1 -.TP -\fCQt::MV_10_DOT_0\fR - Mac OS X 10.0 -.TP -\fCQt::MV_10_DOT_4\fR - Mac OS X 10.4 -.TP -\fCQt::MV_CHEETAH\fR - 10.0 Codename -.TP -\fCQt::MV_PUMA\fR - 10.1 Codename -.TP -\fCQt::MV_JAGUAR\fR - 10.2 Codename -.TP -\fCQt::MV_PANTHER\fR - 10.3 Codename -.TP -\fCQt::MV_TIGER\fR - 10.4 Codename -.SH "Qt::Modifier" -This enum type describes the keyboard modifier keys supported by Qt. -.TP -\fCQt::SHIFT\fR - the Shift keys provided on all standard keyboards. -.TP -\fCQt::META\fR - the Meta keys. -.TP -\fCQt::CTRL\fR - the Ctrl keys. -.TP -\fCQt::ALT\fR - the normal Alt keys, but not e.g. AltGr. -.TP -\fCQt::MODIFIER_MASK\fR - is a mask of Shift, Ctrl, Alt and Meta. -.TP -\fCQt::UNICODE_ACCEL\fR - the accelerator is specified as a Unicode code point, not as a Qt Key. -.SH "Qt::Orientation" -This type is used to signify an object's orientation. -.TP -\fCQt::Horizontal\fR -.TP -\fCQt::Vertical\fR -.PP -Orientation is used with QScrollBar for example. -.SH "Qt::PaintUnit" -.TP -\fCQt::PixelUnit\fR -.TP -\fCQt::LoMetricUnit\fR - \fIobsolete\fR -.TP -\fCQt::HiMetricUnit\fR - \fIobsolete\fR -.TP -\fCQt::LoEnglishUnit\fR - \fIobsolete\fR -.TP -\fCQt::HiEnglishUnit\fR - \fIobsolete\fR -.TP -\fCQt::TwipsUnit\fR - \fIobsolete\fR -.SH "Qt::PenCapStyle" -This enum type defines the pen cap styles supported by Qt, i.e. the line end caps that can be drawn using QPainter. -.TP -\fCQt::FlatCap\fR - a square line end that does not cover the end point of the line. -.TP -\fCQt::SquareCap\fR - a square line end that covers the end point and extends beyond it with half the line width. -.TP -\fCQt::RoundCap\fR - a rounded line end. -.TP -\fCQt::MPenCapStyle\fR - mask of the pen cap styles. -.PP -
                                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                                            -.SH "Qt::PenJoinStyle" -This enum type defines the pen join styles supported by Qt, i.e. which joins between two connected lines can be drawn using QPainter. -.TP -\fCQt::MiterJoin\fR - The outer edges of the lines are extended to meet at an angle, and this area is filled. -.TP -\fCQt::BevelJoin\fR - The triangular notch between the two lines is filled. -.TP -\fCQt::RoundJoin\fR - A circular arc between the two lines is filled. -.TP -\fCQt::MPenJoinStyle\fR - mask of the pen join styles. -.PP -
                                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                                            -.SH "Qt::PenStyle" -This enum type defines the pen styles that can be drawn using QPainter. The styles are -.TP -\fCQt::NoPen\fR - no line at all. For example, QPainter::drawRect() fills but does not draw any boundary line. -.TP -\fCQt::SolidLine\fR - a simple line. -.TP -\fCQt::DashLine\fR - dashes separated by a few pixels. -.TP -\fCQt::DotLine\fR - dots separated by a few pixels. -.TP -\fCQt::DashDotLine\fR - alternate dots and dashes. -.TP -\fCQt::DashDotDotLine\fR - one dash, two dots, one dash, two dots. -.TP -\fCQt::MPenStyle\fR - mask of the pen styles. -.PP -
                                                            -.ce 1 -.B "[Image Omitted]" -.PP -
                                                            -.SH "Qt::RasterOp" -This enum type is used to describe the way things are written to the paint device. Each bit of the \fIsrc\fR (what you write) interacts with the corresponding bit of the \fIdst\fR pixel. -.TP -\fCQt::CopyROP\fR - dst = src -.TP -\fCQt::OrROP\fR - dst = src OR dst -.TP -\fCQt::XorROP\fR - dst = src XOR dst -.TP -\fCQt::NotAndROP\fR - dst = (NOT src) AND dst -.TP -\fCQt::EraseROP\fR - an alias for NotAndROP -.TP -\fCQt::NotCopyROP\fR - dst = NOT src -.TP -\fCQt::NotOrROP\fR - dst = (NOT src) OR dst -.TP -\fCQt::NotXorROP\fR - dst = (NOT src) XOR dst -.TP -\fCQt::AndROP\fR - dst = src AND dst -.TP -\fCQt::NotEraseROP\fR - an alias for AndROP -.TP -\fCQt::NotROP\fR - dst = NOT dst -.TP -\fCQt::ClearROP\fR - dst = 0 -.TP -\fCQt::SetROP\fR - dst = 1 -.TP -\fCQt::NopROP\fR - dst = dst -.TP -\fCQt::AndNotROP\fR - dst = src AND (NOT dst) -.TP -\fCQt::OrNotROP\fR - dst = src OR (NOT dst) -.TP -\fCQt::NandROP\fR - dst = NOT (src AND dst) -.TP -\fCQt::NorROP\fR - dst = NOT (src OR dst) -.PP -By far the most useful ones are CopyROP and XorROP. -.PP -On Qt/Embedded, only CopyROP, XorROP, and NotROP are supported. -.SH "Qt::SequenceMatch" -.TP -\fCQt::NoMatch\fR - Sequences have nothing in common -.TP -\fCQt::PartialMatch\fR - Sequences match partially, but are not complete -.TP -\fCQt::Identical\fR - Sequences do not differ -.SH "Qt::SortOrder" -This enum describes how the items in a widget are sorted. -.TP -\fCQt::Ascending\fR - The items are sorted ascending e.g. starts with 'AAA' ends with 'ZZZ' in Latin-1 locales -.TP -\fCQt::Descending\fR - The items are sorted descending e.g. starts with 'ZZZ' ends with 'AAA' in Latin-1 locales -.SH "Qt::StringComparisonMode" -This enum type is used to set the string comparison mode when searching for an item. It is used by QListBox, QListView and QIconView, for example. We'll refer to the string being searched as the 'target' string. -.TP -\fCQt::CaseSensitive\fR - The strings must match case sensitively. -.TP -\fCQt::ExactMatch\fR - The target and search strings must match exactly. -.TP -\fCQt::BeginsWith\fR - The target string begins with the search string. -.TP -\fCQt::EndsWith\fR - The target string ends with the search string. -.TP -\fCQt::Contains\fR - The target string contains the search string. -.PP -If you OR these flags together (excluding CaseSensitive), the search criteria be applied in the following order: ExactMatch, BeginsWith, EndsWith, Contains. -.PP -Matching is case-insensitive unless CaseSensitive is set. CaseSensitive can be OR-ed with any combination of the other flags. -.SH "Qt::TextFlags" -This enum type is used to define some modifier flags. Some of these flags only make sense in the context of printing: -.TP -\fCQt::SingleLine\fR - Treats all whitespace as spaces and prints just one line. -.TP -\fCQt::DontClip\fR - If it's impossible to stay within the given bounds, it prints outside. -.TP -\fCQt::ExpandTabs\fR - Makes the U+0009 (ASCII tab) character move to the next tab stop. -.TP -\fCQt::ShowPrefix\fR - Displays the string "&P" as P (see QButton for an example). For an ampersand, use "&&". -.TP -\fCQt::WordBreak\fR - Breaks lines at appropriate points, e.g. at word boundaries. -.TP -\fCQt::BreakAnywhere\fR - Breaks lines anywhere, even within words. -.TP -\fCQt::NoAccel\fR - Same as ShowPrefix but doesn't draw the underlines. -.PP -You can use as many modifier flags as you want, except that SingleLine and WordBreak cannot be combined. -.PP -Flags that are inappropriate for a given use (e.g. ShowPrefix to QGridLayout::addWidget()) are generally ignored. -.SH "Qt::TextFormat" -This enum is used in widgets that can display both plain text and rich text, e.g. QLabel. It is used for deciding whether a text string should be interpreted as one or the other. This is normally done by passing one of the enum values to a setTextFormat() function. -.TP -\fCQt::PlainText\fR - The text string is interpreted as a plain text string. -.TP -\fCQt::RichText\fR - The text string is interpreted as a rich text string using the current QStyleSheet::defaultSheet(). -.TP -\fCQt::AutoText\fR - The text string is interpreted as for RichText if QStyleSheet::mightBeRichText() returns TRUE, otherwise as PlainText. -.TP -\fCQt::LogText\fR - A special, limited text format which is only used by QTextEdit in an optimized mode. -.SH "Qt::TimeSpec" -.TP -\fCQt::LocalTime\fR - Locale dependent time (Timezones and Daylight Savings Time) -.TP -\fCQt::UTC\fR - Coordinated Universal Time, replaces Greenwich Time -.SH "Qt::UIEffect" -.TP -\fCQt::UI_General\fR -.TP -\fCQt::UI_AnimateMenu\fR -.TP -\fCQt::UI_FadeMenu\fR -.TP -\fCQt::UI_AnimateCombo\fR -.TP -\fCQt::UI_AnimateTooltip\fR -.TP -\fCQt::UI_FadeTooltip\fR -.TP -\fCQt::UI_AnimateToolBox\fR - Reserved -.SH "Qt::WidgetFlags" - -.PP -This enum type is used to specify various window-system properties for the widget. They are fairly unusual but necessary in a few cases. Some of these flags depend on whether the underlying window manager supports them. (See the toplevel example for an explanation and example of their use.) -.PP -The main types are -.TP -\fCQt::WType_TopLevel\fR - indicates that this widget is a top-level widget, usually with a window-system frame and so on. -.TP -\fCQt::WType_Dialog\fR - indicates that this widget is a top-level window that should be decorated as a dialog (i.e. typically no maximize or minimize buttons in the title bar). If you want to use it as a modal dialog it should be launched from another window, or have a parent and this flag should be combined with WShowModal. If you make it modal, the dialog will prevent other top-level windows in the application from getting any input. WType_Dialog implies WType_TopLevel. We refer to a top-level window that has a parent as a \fIsecondary\fR window. (See also WGroupLeader.) -.TP -\fCQt::WType_Popup\fR - indicates that this widget is a popup top-level window, i.e. that it is modal, but has a window system frame appropriate for popup menus. WType_Popup implies WType_TopLevel. -.TP -\fCQt::WType_Desktop\fR - indicates that this widget is the desktop. See also WPaintDesktop below. WType_Desktop implies WType_TopLevel. -.PP -There are also a number of flags which you can use to customize the appearance of top-level windows. These have no effect on other windows: -.TP -\fCQt::WStyle_Customize\fR - indicates that the \fCWStyle_*\fR flags should be used to build the window instead of the default flags. -.TP -\fCQt::WStyle_NormalBorder\fR - gives the window a normal border. This cannot be combined with WStyle_DialogBorder or WStyle_NoBorder. -.TP -\fCQt::WStyle_DialogBorder\fR - gives the window a thin dialog border. This cannot be combined with WStyle_NormalBorder or WStyle_NoBorder. -.TP -\fCQt::WStyle_NoBorder\fR - produces a borderless window. Note that the user cannot move or resize a borderless window via the window system. This cannot be combined with WStyle_NormalBorder or WStyle_DialogBorder. On Windows, the flag works fine. On X11, the result of the flag is dependent on the window manager and its ability to understand MOTIF and/or NETWM hints: most existing modern window managers can handle this. With WX11BypassWM, you can bypass the window manager completely. This results in a borderless window that is not managed at all (i.e. no keyboard input unless you call setActiveWindow() manually). -.TP -\fCQt::WStyle_NoBorderEx\fR - this value is obsolete. It has the same effect as using WStyle_NoBorder. -.TP -\fCQt::WStyle_Title\fR - gives the window a title bar. -.TP -\fCQt::WStyle_SysMenu\fR - adds a window system menu. -.TP -\fCQt::WStyle_Minimize\fR - adds a minimize button. Note that on Windows this has to be combined with WStyle_SysMenu for it to work. -.TP -\fCQt::WStyle_Maximize\fR - adds a maximize button. Note that on Windows this has to be combined with WStyle_SysMenu for it to work. -.TP -\fCQt::WStyle_MinMax\fR - is equal to \fCWStyle_Minimize|WStyle_Maximize\fR. Note that on Windows this has to be combined with WStyle_SysMenu to work. -.TP -\fCQt::WStyle_ContextHelp\fR - adds a context help button to dialogs. -.TP -\fCQt::WStyle_Tool\fR - makes the window a tool window. A tool window is often a small window with a smaller than usual title bar and decoration, typically used for collections of tool buttons. It there is a parent, the tool window will always be kept on top of it. If there isn't a parent, you may consider passing WStyle_StaysOnTop as well. If the window system supports it, a tool window can be decorated with a somewhat lighter frame. It can also be combined with WStyle_NoBorder. -.TP -\fCQt::WStyle_StaysOnTop\fR - informs the window system that the window should stay on top of all other windows. Note that on some window managers on X11 you also have to pass WX11BypassWM for this flag to work correctly. -.TP -\fCQt::WStyle_Dialog\fR - indicates that the window is a logical subwindow of its parent (i.e. a dialog). The window will not get its own taskbar entry and will be kept on top of its parent by the window system. Usually it will also be minimized when the parent is minimized. If not customized, the window is decorated with a slightly simpler title bar. This is the flag QDialog uses. -.TP -\fCQt::WStyle_Splash\fR - indicates that the window is a splash screen. On X11, we try to follow NETWM standard for a splash screen window if the window manager supports is otherwise it is equivalent to WX11BypassWM. On other platforms, it is equivalent to WStyle_NoBorder \fC|\fR WMacNoSheet \fC|\fR WStyle_Tool \fC|\fR WWinOwnDC -.PP -Modifier flags: -.TP -\fCQt::WDestructiveClose\fR - makes Qt delete this widget when the widget has accepted closeEvent(), or when the widget tried to ignore closeEvent() but could not. -.TP -\fCQt::WPaintDesktop\fR - gives this widget paint events for the desktop. -.TP -\fCQt::WPaintUnclipped\fR - makes all painters operating on this widget unclipped. Children of this widget or other widgets in front of it do not clip the area the painter can paint on. -.TP -\fCQt::WPaintClever\fR - indicates that Qt should \fInot\fR try to optimize repainting for the widget, but instead pass on window system repaint events directly. (This tends to produce more events and smaller repaint regions.) -.TP -\fCQt::WMouseNoMask\fR - indicates that even if the widget has a mask, it wants mouse events for its entire rectangle. -.TP -\fCQt::WStaticContents\fR - indicates that the widget contents are north-west aligned and static. On resize, such a widget will receive paint events only for the newly visible part of itself. -.TP -\fCQt::WNoAutoErase\fR - indicates that the widget paints all its pixels. Updating, resizing, scrolling and focus changes should therefore not erase the widget. This allows smart-repainting to avoid flicker. -.TP -\fCQt::WResizeNoErase\fR - this value is obsolete; use WNoAutoErase instead. -.TP -\fCQt::WRepaintNoErase\fR - this value is obsolete; use WNoAutoErase instead. -.TP -\fCQt::WGroupLeader\fR - makes this window a group leader. A group leader should \fInot\fR have a parent (i.e. it should be a top-level window). Any decendant windows (direct or indirect) of a group leader are in its group; other windows are not. If you show a secondary window from the group (i.e. show a window whose top-most parent is a group leader), that window will be modal with respect to the other windows in the group, but modeless with respect to windows in other groups. -.PP -Miscellaneous flags -.TP -\fCQt::WShowModal\fR - see WType_Dialog -.PP -Internal flags. -.TP -\fCQt::WNoMousePropagation\fR -.TP -\fCQt::WStaticContents\fR -.TP -\fCQt::WStyle_Reserved\fR -.TP -\fCQt::WSubWindow\fR -.TP -\fCQt::WType_Modal\fR -.TP -\fCQt::WWinOwnDC\fR -.TP -\fCQt::WX11BypassWM\fR -.TP -\fCQt::WMacNoSheet\fR -.TP -\fCQt::WMacDrawer\fR -.TP -\fCQt::WStyle_Mask\fR -.TP -\fCQt::WType_Mask\fR -.SH "Qt::WidgetState" -Internal flags. -.TP -\fCQt::WState_Created\fR -.TP -\fCQt::WState_Disabled\fR -.TP -\fCQt::WState_Visible\fR -.TP -\fCQt::WState_ForceHide\fR -.TP -\fCQt::WState_OwnCursor\fR -.TP -\fCQt::WState_MouseTracking\fR -.TP -\fCQt::WState_CompressKeys\fR -.TP -\fCQt::WState_BlockUpdates\fR -.TP -\fCQt::WState_InPaintEvent\fR -.TP -\fCQt::WState_Reparented\fR -.TP -\fCQt::WState_ConfigPending\fR -.TP -\fCQt::WState_Resized\fR -.TP -\fCQt::WState_AutoMask\fR -.TP -\fCQt::WState_Polished\fR -.TP -\fCQt::WState_DND\fR -.TP -\fCQt::WState_Reserved0\fR - \fIinternal\fR -.TP -\fCQt::WState_CreatedHidden\fR -.TP -\fCQt::WState_Maximized\fR -.TP -\fCQt::WState_Minimized\fR -.TP -\fCQt::WState_ForceDisabled\fR -.TP -\fCQt::WState_Exposed\fR -.TP -\fCQt::WState_HasMouse\fR -.TP -\fCQt::WState_CreatedHidden\fR -.TP -\fCQt::WState_OwnSizePolicy\fR -.TP -\fCQt::WState_FullScreen\fR -.SH "Qt::WindowState" - -.PP -This enum type is used to specify the current state of a top-level window. -.PP -The states are -.TP -\fCQt::WindowNoState\fR - The window has no state set (in normal state). -.TP -\fCQt::WindowMinimized\fR - The window is minimized (i.e. iconified). -.TP -\fCQt::WindowMaximized\fR - The window is maximized with a frame around it. -.TP -\fCQt::WindowFullScreen\fR - The window fills the entire screen without any frame around it. -.TP -\fCQt::WindowActive\fR - The window is the active window, i.e. it has keyboard focus. -.SH "Qt::WindowsVersion" -.TP -\fCQt::WV_32s\fR - Windows 3.1 with Win 32s -.TP -\fCQt::WV_95\fR - Windows 95 -.TP -\fCQt::WV_98\fR - Windows 98 -.TP -\fCQt::WV_Me\fR - Windows Me -.TP -\fCQt::WV_DOS_based\fR -.TP -\fCQt::WV_NT\fR - Windows NT -.TP -\fCQt::WV_2000\fR - Windows 2000 -.TP -\fCQt::WV_XP\fR - Windows XP -.TP -\fCQt::WV_2003\fR - Windows Server 2003 -.TP -\fCQt::WV_NT_based\fR -.TP -\fCQt::WV_VISTA\fR - Windows Vista -.TP -\fCQt::WV_CE\fR - Windows CE -.TP -\fCQt::WV_CENET\fR - Windows CE .NET -.TP -\fCQt::WV_CE_based\fR - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqt.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qt.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtab.3qt b/doc/man/man3/qtab.3qt deleted file mode 100644 index 6c1247a69..000000000 --- a/doc/man/man3/qtab.3qt +++ /dev/null @@ -1,120 +0,0 @@ -'\" t -.TH QTab 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 -QTab \- The structures in a QTabBar -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTab\fR ()" -.br -.ti -1c -.BI "virtual \fB~QTab\fR ()" -.br -.ti -1c -.BI "\fBQTab\fR ( const QString & text )" -.br -.ti -1c -.BI "\fBQTab\fR ( const QIconSet & icon, const QString & text = QString::null )" -.br -.ti -1c -.BI "void \fBsetText\fR ( const QString & text )" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "void \fBsetIconSet\fR ( const QIconSet & icon )" -.br -.ti -1c -.BI "QIconSet * \fBiconSet\fR () const" -.br -.ti -1c -.BI "void \fBsetRect\fR ( const QRect & rect )" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "void \fBsetEnabled\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "void \fBsetIdentifier\fR ( int i )" -.br -.ti -1c -.BI "int \fBidentifier\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QTab class provides the structures in a QTabBar. -.PP -This class is used for custom QTabBar tab headings. -.PP -See also QTabBar and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTab::QTab ()" -Constructs an empty tab. All fields are set to empty. -.SH "QTab::QTab ( const QString & text )" -Constructs a tab with the text \fItext\fR. -.SH "QTab::QTab ( const QIconSet & icon, const QString & text = QString::null )" -Constructs a tab with an \fIicon\fR and the text, \fItext\fR. -.SH "QTab::~QTab ()\fC [virtual]\fR" -Destroys the tab and frees up all allocated resources. -.SH "QIconSet * QTab::iconSet () const" -Return the QIconSet of the QTab. -.SH "int QTab::identifier () const" -Return the QTab's identifier. -.SH "bool QTab::isEnabled () const" -Returns TRUE if the QTab is enabled; otherwise returns FALSE. -.SH "QRect QTab::rect () const" -Return the QRect for the QTab. -.SH "void QTab::setEnabled ( bool enable )" -If \fIenable\fR is TRUE enable the QTab, otherwise disable it. -.SH "void QTab::setIconSet ( const QIconSet & icon )" -Sets the tab's iconset to \fIicon\fR -.SH "void QTab::setIdentifier ( int i )" -Set the identifier for the QTab to \fIi\fR. Each QTab's identifier within a QTabBar must be unique. -.SH "void QTab::setRect ( const QRect & rect )" -Set the QTab QRect to \fIrect\fR. -.SH "void QTab::setText ( const QString & text )" -Sets the text of the tab to \fItext\fR. -.SH "QString QTab::text () const" -Returns the text of the QTab label. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtab.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtab.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtabbar.3qt b/doc/man/man3/qtabbar.3qt deleted file mode 100644 index a953d3a4d..000000000 --- a/doc/man/man3/qtabbar.3qt +++ /dev/null @@ -1,332 +0,0 @@ -'\" t -.TH QTabBar 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 -QTabBar \- Tab bar, e.g. for use in tabbed dialogs -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTabBar\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QTabBar\fR ()" -.br -.ti -1c -.BI "enum \fBShape\fR { RoundedAbove, RoundedBelow, TriangularAbove, TriangularBelow }" -.br -.ti -1c -.BI "Shape \fBshape\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetShape\fR ( Shape )" -.br -.ti -1c -.BI "virtual int \fBaddTab\fR ( QTab * newTab )" -.br -.ti -1c -.BI "virtual int \fBinsertTab\fR ( QTab * newTab, int index = -1 )" -.br -.ti -1c -.BI "virtual void \fBremoveTab\fR ( QTab * t )" -.br -.ti -1c -.BI "virtual void \fBsetTabEnabled\fR ( int id, bool enabled )" -.br -.ti -1c -.BI "bool \fBisTabEnabled\fR ( int id ) const" -.br -.ti -1c -.BI "int \fBcurrentTab\fR () const" -.br -.ti -1c -.BI "int \fBkeyboardFocusTab\fR () const" -.br -.ti -1c -.BI "QTab * \fBtab\fR ( int id ) const" -.br -.ti -1c -.BI "QTab * \fBtabAt\fR ( int index ) const" -.br -.ti -1c -.BI "int \fBindexOf\fR ( int id ) const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "virtual void \fBlayoutTabs\fR ()" -.br -.ti -1c -.BI "virtual QTab * \fBselectTab\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "void \fBremoveToolTip\fR ( int index )" -.br -.ti -1c -.BI "void \fBsetToolTip\fR ( int index, const QString & tip )" -.br -.ti -1c -.BI "QString \fBtoolTip\fR ( int index ) const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetCurrentTab\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBsetCurrentTab\fR ( QTab * tab )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBselected\fR ( int id )" -.br -.ti -1c -.BI "void \fBlayoutChanged\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBcount\fR - the number of tabs in the tab bar \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcurrentTab\fR - the id of the tab bar's visible tab" -.br -.ti -1c -.BI "int \fBkeyboardFocusTab\fR - the id of the tab that has the keyboard focus \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "Shape \fBshape\fR - the shape of the tabs in the tab bar" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBpaint\fR ( QPainter * p, QTab * t, bool selected ) const" -.br -.ti -1c -.BI "virtual void \fBpaintLabel\fR ( QPainter * p, const QRect & br, QTab * t, bool has_focus ) const" -.br -.ti -1c -.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * e )" -.br -.ti -1c -.BI "QPtrList * \fBtabList\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs. -.PP -QTabBar is straightforward to use; it draws the tabs using one of the predefined shapes, and emits a signal when a tab is selected. It can be subclassed to tailor the look and feel. Qt also provides a ready-made QTabWidget and a QTabDialog. -.PP -The choice of tab shape is a matter of taste, although tab dialogs (for preferences and similar) invariably use RoundedAbove; nobody uses TriangularAbove. Tab controls in windows other than dialogs almost always use either RoundedBelow or TriangularBelow. Many spreadsheets and other tab controls in which all the pages are essentially similar use TriangularBelow, whereas RoundedBelow is used mostly when the pages are different (e.g. a multi-page tool palette). -.PP -The most important part of QTabBar's API is the selected() signal. This is emitted whenever the selected page changes (even at startup, when the selected page changes from 'none'). There is also a slot, setCurrentTab(), which can be used to select a page programmatically. -.PP -QTabBar creates automatic accelerator keys in the manner of QButton; e.g. if a tab's label is "&Graphics", Alt+G becomes an accelerator key for switching to that tab. -.PP -The following virtual functions may need to be reimplemented: -.TP -paint() paints a single tab. paintEvent() calls paint() for each tab so that any overlap will look right. -.TP -addTab() creates a new tab and adds it to the bar. -.TP -selectTab() decides which tab, if any, the user selects with the mouse. -.PP -The index of the current tab is returned by currentTab(). The tab with a particular index is returned by tabAt(), the tab with a particular id is returned by tab(). The index of a tab is returned by indexOf(). The current tab can be set by index or tab pointer using one of the setCurrentTab() functions. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also Advanced Widgets. -.SS "Member Type Documentation" -.SH "QTabBar::Shape" -This enum type lists the built-in shapes supported by QTabBar: -.TP -\fCQTabBar::RoundedAbove\fR - the normal rounded look above the pages -.TP -\fCQTabBar::RoundedBelow\fR - the normal rounded look below the pages -.TP -\fCQTabBar::TriangularAbove\fR - triangular tabs above the pages (very unusual; included for completeness) -.TP -\fCQTabBar::TriangularBelow\fR - triangular tabs similar to those used in the Excel spreadsheet, for example -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTabBar::QTabBar ( QWidget * parent = 0, const char * name = 0 )" -Constructs a new, empty tab bar; the \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. -.SH "QTabBar::~QTabBar ()" -Destroys the tab control, freeing memory used. -.SH "int QTabBar::addTab ( QTab * newTab )\fC [virtual]\fR" -Adds the tab, \fInewTab\fR, to the tab control. -.PP -Sets \fInewTab\fR's id to a new id and places the tab just to the right of the existing tabs. If the tab's label contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. Returns the id. -.PP -See also insertTab(). -.SH "int QTabBar::count () const" -Returns the number of tabs in the tab bar. See the "count" property for details. -.SH "int QTabBar::currentTab () const" -Returns the id of the tab bar's visible tab. See the "currentTab" property for details. -.SH "int QTabBar::indexOf ( int id ) const" -Returns the position index of the tab with id \fIid\fR or -1 if no tab has this \fIid\fR. -.PP -See also tabAt(). -.SH "int QTabBar::insertTab ( QTab * newTab, int index = -1 )\fC [virtual]\fR" -Inserts the tab, \fInewTab\fR, into the tab control. -.PP -If \fIindex\fR is not specified, the tab is simply appended. Otherwise it's inserted at the specified position. -.PP -Sets \fInewTab\fR's id to a new id. If the tab's label contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. Returns the id. -.PP -See also addTab(). -.SH "bool QTabBar::isTabEnabled ( int id ) const" -Returns TRUE if the tab with id \fIid\fR exists and is enabled; otherwise returns FALSE. -.PP -See also setTabEnabled(). -.SH "int QTabBar::keyboardFocusTab () const" -Returns the id of the tab that has the keyboard focus. See the "keyboardFocusTab" property for details. -.SH "void QTabBar::layoutChanged ()\fC [signal]\fR" -QTabBar emits the signal whenever the layout of the tab bar has been recalculated, for example when the contents of a tab change. -.SH "void QTabBar::layoutTabs ()\fC [virtual]\fR" -Lays out all existing tabs according to their label and their iconset. -.SH "void QTabBar::paint ( QPainter * p, QTab * t, bool selected ) const\fC [virtual protected]\fR" -Paints the tab \fIt\fR using painter \fIp\fR. If and only if \fIselected\fR is TRUE, \fIt\fR is drawn currently selected. -.PP -This virtual function may be reimplemented to change the look of QTabBar. If you decide to reimplement it, you may also need to reimplement sizeHint(). -.SH "void QTabBar::paintEvent ( QPaintEvent * e )\fC [virtual protected]\fR" -Repaints the tab row. All the painting is done by paint(); paintEvent() only decides which tabs need painting and in what order. The event is passed in \fIe\fR. -.PP -See also paint(). -.PP -Reimplemented from QWidget. -.SH "void QTabBar::paintLabel ( QPainter * p, const QRect & br, QTab * t, bool has_focus ) const\fC [virtual protected]\fR" -Paints the label of tab \fIt\fR centered in rectangle \fIbr\fR using painter \fIp\fR. A focus indication is drawn if \fIhas_focus\fR is TRUE. -.SH "void QTabBar::removeTab ( QTab * t )\fC [virtual]\fR" -Removes tab \fIt\fR from the tab control, and deletes the tab. -.SH "void QTabBar::removeToolTip ( int index )" -Removes the tool tip for the tab at index position \fIindex\fR. -.SH "QTab * QTabBar::selectTab ( const QPoint & p ) const\fC [virtual]\fR" -This virtual function is called by the mouse event handlers to determine which tab is pressed. The default implementation returns a pointer to the tab whose bounding rectangle contains \fIp\fR, if exactly one tab's bounding rectangle contains \fIp\fR. Otherwise it returns 0. -.PP -See also mousePressEvent() and mouseReleaseEvent(). -.SH "void QTabBar::selected ( int id )\fC [signal]\fR" -QTabBar emits this signal whenever any tab is selected, whether by the program or by the user. The argument \fIid\fR is the id of the tab as returned by addTab(). -.PP -show() is guaranteed to emit this signal; you can display your page in a slot connected to this signal. -.SH "void QTabBar::setCurrentTab ( int )\fC [virtual slot]\fR" -Sets the id of the tab bar's visible tab. See the "currentTab" property for details. -.SH "void QTabBar::setCurrentTab ( QTab * tab )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Raises \fItab\fR and emits the selected() signal unless the tab was already current. -.PP -See also currentTab and selected(). -.SH "void QTabBar::setShape ( Shape )\fC [virtual]\fR" -Sets the shape of the tabs in the tab bar. See the "shape" property for details. -.SH "void QTabBar::setTabEnabled ( int id, bool enabled )\fC [virtual]\fR" -Enables tab \fIid\fR if \fIenabled\fR is TRUE or disables it if \fIenabled\fR is FALSE. If \fIid\fR is currently selected, setTabEnabled(FALSE) makes another tab selected. -.PP -setTabEnabled() updates the display if this causes a change in \fIid\fR's status. -.PP -See also update() and isTabEnabled(). -.SH "void QTabBar::setToolTip ( int index, const QString & tip )" -Sets the tool tip for the tab at index position \fIindex\fR to \fItip\fR. -.SH "Shape QTabBar::shape () const" -Returns the shape of the tabs in the tab bar. See the "shape" property for details. -.SH "QTab * QTabBar::tab ( int id ) const" -Returns the tab with id \fIid\fR or 0 if there is no such tab. -.PP -See also count. -.SH "QTab * QTabBar::tabAt ( int index ) const" -Returns the tab at position \fIindex\fR. -.PP -See also indexOf(). -.SH "QPtrList * QTabBar::tabList ()\fC [protected]\fR" -The list of QTab objects in the tab bar. -.PP -This list is unlikely to be in the order that the QTab elements appear visually. One way of iterating over the tabs is like this: -.PP -.nf -.br - for ( uint i = 0; i < myTabBar->count(); ++i ) { -.br - nextTab = myTabBar->tabAt( i ); -.br - // do something with nextTab -.br - } -.br -.fi -.SH "QString QTabBar::toolTip ( int index ) const" -Returns the tool tip for the tab at index position \fIindex\fR. -.SS "Property Documentation" -.SH "int count" -This property holds the number of tabs in the tab bar. -.PP -Get this property's value with count(). -.PP -See also tab(). -.SH "int currentTab" -This property holds the id of the tab bar's visible tab. -.PP -If no tab page is currently visible, the property's value is -1. Even if the property's value is not -1, you cannot assume that the user can see the relevant page, or that the tab is enabled. When you need to display something the value of this property represents the best page to display. -.PP -When this property is set to \fIid\fR, it will raise the tab with the id \fIid\fR and emit the selected() signal. -.PP -See also selected() and isTabEnabled(). -.PP -Set this property's value with setCurrentTab() and get this property's value with currentTab(). -.SH "int keyboardFocusTab" -This property holds the id of the tab that has the keyboard focus. -.PP -This property contains the id of the tab that has the keyboard focus or -1 if the tab bar does not have the keyboard focus. -.PP -Get this property's value with keyboardFocusTab(). -.SH "Shape shape" -This property holds the shape of the tabs in the tab bar. -.PP -The value of this property is one of the following: RoundedAbove (default), RoundedBelow, TriangularAbove or TriangularBelow. -.PP -See also Shape. -.PP -Set this property's value with setShape() and get this property's value with shape(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtabbar.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtabbar.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtabdialog.3qt b/doc/man/man3/qtabdialog.3qt deleted file mode 100644 index 4ef7f2751..000000000 --- a/doc/man/man3/qtabdialog.3qt +++ /dev/null @@ -1,464 +0,0 @@ -'\" t -.TH QTabDialog 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 -QTabDialog \- Stack of tabbed widgets -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDialog. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTabDialog\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QTabDialog\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetFont\fR ( const QFont & font )" -.br -.ti -1c -.BI "void \fBaddTab\fR ( QWidget * child, const QString & label )" -.br -.ti -1c -.BI "void \fBaddTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label )" -.br -.ti -1c -.BI "void \fBaddTab\fR ( QWidget * child, QTab * tab )" -.br -.ti -1c -.BI "void \fBinsertTab\fR ( QWidget * child, const QString & label, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )" -.br -.ti -1c -.BI "void \fBinsertTab\fR ( QWidget * child, QTab * tab, int index = -1 )" -.br -.ti -1c -.BI "void \fBchangeTab\fR ( QWidget * w, const QString & label )" -.br -.ti -1c -.BI "void \fBchangeTab\fR ( QWidget * w, const QIconSet & iconset, const QString & label )" -.br -.ti -1c -.BI "bool \fBisTabEnabled\fR ( QWidget * w ) const" -.br -.ti -1c -.BI "void \fBsetTabEnabled\fR ( QWidget * w, bool enable )" -.br -.ti -1c -.BI "bool isTabEnabled ( const char * name ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setTabEnabled ( const char * name, bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBshowPage\fR ( QWidget * w )" -.br -.ti -1c -.BI "void \fBremovePage\fR ( QWidget * w )" -.br -.ti -1c -.BI "QString \fBtabLabel\fR ( QWidget * w )" -.br -.ti -1c -.BI "QWidget * \fBcurrentPage\fR () const" -.br -.ti -1c -.BI "void \fBsetDefaultButton\fR ( const QString & text )" -.br -.ti -1c -.BI "void \fBsetDefaultButton\fR ()" -.br -.ti -1c -.BI "bool \fBhasDefaultButton\fR () const" -.br -.ti -1c -.BI "void \fBsetHelpButton\fR ( const QString & text )" -.br -.ti -1c -.BI "void \fBsetHelpButton\fR ()" -.br -.ti -1c -.BI "bool \fBhasHelpButton\fR () const" -.br -.ti -1c -.BI "void \fBsetCancelButton\fR ( const QString & text )" -.br -.ti -1c -.BI "void \fBsetCancelButton\fR ()" -.br -.ti -1c -.BI "bool \fBhasCancelButton\fR () const" -.br -.ti -1c -.BI "void \fBsetApplyButton\fR ( const QString & text )" -.br -.ti -1c -.BI "void \fBsetApplyButton\fR ()" -.br -.ti -1c -.BI "bool \fBhasApplyButton\fR () const" -.br -.ti -1c -.BI "void \fBsetOkButton\fR ( const QString & text )" -.br -.ti -1c -.BI "void \fBsetOkButton\fR ()" -.br -.ti -1c -.BI "bool \fBhasOkButton\fR () const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBaboutToShow\fR ()" -.br -.ti -1c -.BI "void \fBapplyButtonPressed\fR ()" -.br -.ti -1c -.BI "void \fBcancelButtonPressed\fR ()" -.br -.ti -1c -.BI "void \fBdefaultButtonPressed\fR ()" -.br -.ti -1c -.BI "void \fBhelpButtonPressed\fR ()" -.br -.ti -1c -.BI "void \fBcurrentChanged\fR ( QWidget * )" -.br -.ti -1c -.BI "void selected ( const QString & ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsetTabBar\fR ( QTabBar * tb )" -.br -.ti -1c -.BI "QTabBar * \fBtabBar\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QTabDialog class provides a stack of tabbed widgets. -.PP -A tabbed dialog is one in which several "tab pages" are available. By clicking on a tab page's tab or by pressing the indicated Alt+\fIletter\fR key combination, the user can select which tab page they want to use. -.PP -QTabDialog provides a tab bar consisting of single row of tabs at the top; each tab has an associated widget which is that tab's tab page. In addition, QTabDialog provides an OK button and the following optional buttons: Apply, Cancel, Defaults and Help. -.PP -The normal way to use QTabDialog is to do the following in the constructor:
                                                              -.IP 1 -Create a QTabDialog. -.IP 2 -Create a QWidget for each of the pages in the tab dialog, insert children into it, set up geometry management for it, and use addTab() (or insertTab()) to set up a tab and keyboard accelerator for it. -.IP 3 -Set up the buttons for the tab dialog using setOkButton(), setApplyButton(), setDefaultsButton(), setCancelButton() and setHelpButton(). -.IP 4 -Connect to the signals and slots. -.PP -If you don't call addTab() the page you have created will not be visible. Don't confuse the object name you supply to the QWidget constructor and the tab label you supply to addTab(); addTab() takes user-visible name that appears on the widget's tab and may identify an accelerator, whereas the widget name is used primarily for debugging. -.PP -Almost all applications have to connect the applyButtonPressed() signal to something. applyButtonPressed() is emitted when either OK or Apply is clicked, and your slot must copy the dialog's state into the application. -.PP -There are also several other signals which may be useful: -.TP -cancelButtonPressed() is emitted when the user clicks Cancel. -.TP -defaultButtonPressed() is emitted when the user clicks Defaults; the slot it is connected to should reset the state of the dialog to the application defaults. -.TP -helpButtonPressed() is emitted when the user clicks Help. -.TP -aboutToShow() is emitted at the start of show(); if there is any chance that the state of the application may change between the creation of the tab dialog and the time show() is called, you must connect this signal to a slot that resets the state of the dialog. -.TP -currentChanged() is emitted when the user selects a page. -.PP -Each tab is either enabled or disabled at any given time (see setTabEnabled()). If a tab is enabled the tab text is drawn in black and the user can select that tab. If it is disabled the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible; for example, if all of the tabs happen to be disabled. -.PP -You can change a tab's label and iconset using changeTab(). A tab page can be removed with removePage() and shown with showPage(). The current page is given by currentPage(). -.PP -QTabDialog does not support tabs on the sides or bottom, nor can you set or retrieve the visible page. If you need more functionality than QTabDialog provides, consider creating a QDialog and using a QTabBar with QTabWidgets. -.PP -Most of the functionality in QTabDialog is provided by a QTabWidget. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QDialog and Dialog Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTabDialog::QTabDialog ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -Constructs a QTabDialog with only an OK button. The \fIparent\fR, \fIname\fR, \fImodal\fR and widget flag, \fIf\fR, arguments are passed on to the QDialog constructor. -.SH "QTabDialog::~QTabDialog ()" -Destroys the tab dialog. -.SH "void QTabDialog::aboutToShow ()\fC [signal]\fR" -This signal is emitted by show() when it is time to set the state of the dialog's contents. The dialog should reflect the current state of the application when it appears; if there is any possibility that the state of the application may change between the time you call QTabDialog::QTabDialog() and QTabDialog::show(), you should set the dialog's state in a slot and connect this signal to it. -.PP -This applies mainly to QTabDialog objects that are kept around hidden, rather than being created, shown, and deleted afterwards. -.PP -See also applyButtonPressed(), show(), and cancelButtonPressed(). -.SH "void QTabDialog::addTab ( QWidget * child, const QString & label )" -Adds another tab and page to the tab view. -.PP -The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. -.PP -If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. -.PP -If you call addTab() after show() the screen will flicker and the user may be confused. -.PP -See also insertTab(). -.SH "void QTabDialog::addTab ( QWidget * child, const QIconSet & iconset, const QString & label )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version of the function shows the \fIiconset\fR as well as the \fIlabel\fR on the tab of \fIchild\fR. -.SH "void QTabDialog::addTab ( QWidget * child, QTab * tab )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is a lower-level method for adding tabs, similar to the other addTab() method. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. -.PP -The \fIchild\fR is the widget to be placed on the new tab page. The \fItab\fR is the tab to display on the tab page -- normally this shows a label or an icon that identifies the tab page. -.SH "void QTabDialog::applyButtonPressed ()\fC [signal]\fR" -This signal is emitted when either the Apply or OK button is clicked. -.PP -It should be connected to a slot (or several slots) that change the application's state according to the state of the dialog. -.PP -See also cancelButtonPressed(), defaultButtonPressed(), and setApplyButton(). -.SH "void QTabDialog::cancelButtonPressed ()\fC [signal]\fR" -This signal is emitted when the Cancel button is clicked. It is automatically connected to QDialog::reject(), which will hide the dialog. -.PP -The Cancel button should not change the application's state at all, so you should generally not need to connect it to any slot. -.PP -See also applyButtonPressed(), defaultButtonPressed(), and setCancelButton(). -.SH "void QTabDialog::changeTab ( QWidget * w, const QIconSet & iconset, const QString & label )" -Changes tab page \fIw\fR's iconset to \fIiconset\fR and label to \fIlabel\fR. -.SH "void QTabDialog::changeTab ( QWidget * w, const QString & label )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Defines a new \fIlabel\fR for the tab of page \fIw\fR -.SH "void QTabDialog::currentChanged ( QWidget * )\fC [signal]\fR" -This signal is emitted whenever the current page changes. -.PP -See also currentPage(), showPage(), and tabLabel(). -.SH "QWidget * QTabDialog::currentPage () const" -Returns a pointer to the page currently being displayed by the tab dialog. The tab dialog does its best to make sure that this value is never 0 (but if you try hard enough, it can be). -.SH "void QTabDialog::defaultButtonPressed ()\fC [signal]\fR" -This signal is emitted when the Defaults button is pressed. It should reset the dialog (but not the application) to the "factory defaults". -.PP -The application's state should not be changed until the user clicks Apply or OK. -.PP -See also applyButtonPressed(), cancelButtonPressed(), and setDefaultButton(). -.SH "bool QTabDialog::hasApplyButton () const" -Returns TRUE if the tab dialog has an Apply button; otherwise returns FALSE. -.PP -See also setApplyButton(), applyButtonPressed(), hasCancelButton(), and hasDefaultButton(). -.SH "bool QTabDialog::hasCancelButton () const" -Returns TRUE if the tab dialog has a Cancel button; otherwise returns FALSE. -.PP -See also setCancelButton(), cancelButtonPressed(), hasApplyButton(), and hasDefaultButton(). -.SH "bool QTabDialog::hasDefaultButton () const" -Returns TRUE if the tab dialog has a Defaults button; otherwise returns FALSE. -.PP -See also setDefaultButton(), defaultButtonPressed(), hasApplyButton(), and hasCancelButton(). -.SH "bool QTabDialog::hasHelpButton () const" -Returns TRUE if the tab dialog has a Help button; otherwise returns FALSE. -.PP -See also setHelpButton(), helpButtonPressed(), hasApplyButton(), and hasCancelButton(). -.SH "bool QTabDialog::hasOkButton () const" -Returns TRUE if the tab dialog has an OK button; otherwise returns FALSE. -.PP -See also setOkButton(), hasApplyButton(), hasCancelButton(), and hasDefaultButton(). -.SH "void QTabDialog::helpButtonPressed ()\fC [signal]\fR" -This signal is emitted when the Help button is pressed. It could be used to present information about how to use the dialog. -.PP -See also applyButtonPressed(), cancelButtonPressed(), and setHelpButton(). -.SH "void QTabDialog::insertTab ( QWidget * child, const QString & label, int index = -1 )" -Inserts another tab and page to the tab view. -.PP -The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. -.PP -If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. -.PP -If \fIindex\fR is not specified, the tab is simply added. Otherwise it is inserted at the specified position. -.PP -If you call insertTab() after show(), the screen will flicker and the user may be confused. -.PP -See also addTab(). -.SH "void QTabDialog::insertTab ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version of the function shows the \fIiconset\fR as well as the \fIlabel\fR on the tab of \fIchild\fR. -.SH "void QTabDialog::insertTab ( QWidget * child, QTab * tab, int index = -1 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is a lower-level method for inserting tabs, similar to the other insertTab() method. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. -.PP -The \fIchild\fR is the widget to be placed on the new tab page. The \fItab\fR is the tab to display on the tab page -- normally this shows a label or an icon that identifies the tab page. The \fIindex\fR is the position where this tab page should be inserted. -.SH "bool QTabDialog::isTabEnabled ( QWidget * w ) const" -Returns TRUE if the page \fIw\fR is enabled; otherwise returns FALSE. -.PP -See also setTabEnabled() and QWidget::enabled. -.SH "bool QTabDialog::isTabEnabled ( const char * name ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns TRUE if the page with object name \fIname\fR is enabled and FALSE if it is disabled. -.PP -If \fIname\fR is 0 or not the name of any of the pages, isTabEnabled() returns FALSE. -.PP -See also setTabEnabled() and QWidget::enabled. -.SH "void QTabDialog::removePage ( QWidget * w )" -Removes page \fIw\fR from this stack of widgets. Does not delete \fIw\fR. -.PP -See also showPage(), QTabWidget::removePage(), and QWidgetStack::removeWidget(). -.SH "void QTabDialog::selected ( const QString & )\fC [signal]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This signal is emitted whenever a tab is selected (raised), including during the first show(). -.PP -See also raise(). -.SH "void QTabDialog::setApplyButton ( const QString & text )" -Adds an Apply button to the dialog. The button's text is set to \fItext\fR. -.PP -The Apply button should apply the current settings in the dialog box to the application while keeping the dialog visible. -.PP -When Apply is clicked, the applyButtonPressed() signal is emitted. -.PP -If \fItext\fR is a null string, no button is shown. -.PP -See also setCancelButton(), setDefaultButton(), and applyButtonPressed(). -.SH "void QTabDialog::setApplyButton ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds an Apply button to the dialog. The button's text is set to a localizable "Apply". -.SH "void QTabDialog::setCancelButton ( const QString & text )" -Adds a Cancel button to the dialog. The button's text is set to \fItext\fR. -.PP -The cancel button should always return the application to the state it was in before the tab view popped up, or if the user has clicked Apply, back to the state immediately after the last Apply. -.PP -When Cancel is clicked, the cancelButtonPressed() signal is emitted. The dialog is closed at the same time. -.PP -If \fItext\fR is a null string, no button is shown. -.PP -See also setApplyButton(), setDefaultButton(), and cancelButtonPressed(). -.SH "void QTabDialog::setCancelButton ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a Cancel button to the dialog. The button's text is set to a localizable "Cancel". -.SH "void QTabDialog::setDefaultButton ( const QString & text )" -Adds a Defaults button to the dialog. The button's text is set to \fItext\fR. -.PP -The Defaults button should set the dialog (but not the application) back to the application defaults. -.PP -When Defaults is clicked, the defaultButtonPressed() signal is emitted. -.PP -If \fItext\fR is a null string, no button is shown. -.PP -See also setApplyButton(), setCancelButton(), and defaultButtonPressed(). -.SH "void QTabDialog::setDefaultButton ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a Defaults button to the dialog. The button's text is set to a localizable "Defaults". -.SH "void QTabDialog::setFont ( const QFont & font )\fC [virtual]\fR" -Sets the font for the tabs to \fIfont\fR. -.PP -If the widget is visible, the display is updated with the new font immediately. There may be some geometry changes, depending on the size of the old and new fonts. -.PP -Reimplemented from QWidget. -.SH "void QTabDialog::setHelpButton ( const QString & text )" -Adds a Help button to the dialog. The button's text is set to \fItext\fR. -.PP -When Help is clicked, the helpButtonPressed() signal is emitted. -.PP -If \fItext\fR is a null string, no button is shown. -.PP -See also setApplyButton(), setCancelButton(), and helpButtonPressed(). -.SH "void QTabDialog::setHelpButton ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a Help button to the dialog. The button's text is set to a localizable "Help". -.SH "void QTabDialog::setOkButton ( const QString & text )" -Adds an OK button to the dialog and sets the button's text to \fItext\fR. -.PP -When the OK button is clicked, the applyButtonPressed() signal is emitted, and the current settings in the dialog box should be applied to the application. The dialog then closes. -.PP -If \fItext\fR is a null string, no button is shown. -.PP -See also setCancelButton(), setDefaultButton(), and applyButtonPressed(). -.SH "void QTabDialog::setOkButton ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds an OK button to the dialog. The button's text is set to a localizable "OK". -.SH "void QTabDialog::setTabBar ( QTabBar * tb )\fC [protected]\fR" -Replaces the QTabBar heading the dialog by the given tab bar, \fItb\fR. Note that this must be called \fIbefore\fR any tabs have been added, or the behavior is undefined. -.PP -See also tabBar(). -.SH "void QTabDialog::setTabEnabled ( QWidget * w, bool enable )" -If \fIenable\fR is TRUE the page \fIw\fR is enabled; otherwise \fIw\fR is disabled. The page's tab is redrawn appropriately. -.PP -QTabWidget uses QWidget::setEnabled() internally, rather than keeping a separate flag. -.PP -Note that even a disabled tab and tab page may be visible. If the page is already visible QTabWidget will not hide it; if all the pages are disabled QTabWidget will show one of them. -.PP -See also isTabEnabled() and QWidget::enabled. -.SH "void QTabDialog::setTabEnabled ( const char * name, bool enable )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Finds the page with object name \fIname\fR, enables/disables it according to the value of \fIenable\fR and redraws the page's tab appropriately. -.PP -QTabDialog uses QWidget::setEnabled() internally, rather than keeping a separate flag. -.PP -Note that even a disabled tab/page may be visible. If the page is already visible QTabDialog will not hide it; if all the pages are disabled QTabDialog will show one of them. -.PP -The object name is used (rather than the tab label) because the tab text may not be invariant in multi-language applications. -.PP -See also isTabEnabled() and QWidget::enabled. -.SH "void QTabDialog::showPage ( QWidget * w )" -Ensures that widget \fIw\fR is shown. This is mainly useful for accelerators. -.PP -\fBWarning:\fR If used carelessly, this function can easily surprise or confuse the user. -.PP -See also QTabBar::currentTab. -.SH "QTabBar * QTabDialog::tabBar () const\fC [protected]\fR" -Returns the currently set QTabBar. -.PP -See also setTabBar(). -.SH "QString QTabDialog::tabLabel ( QWidget * w )" -Returns the text in the tab for page \fIw\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtabdialog.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtabdialog.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtable.3qt b/doc/man/man3/qtable.3qt deleted file mode 100644 index d55d35570..000000000 --- a/doc/man/man3/qtable.3qt +++ /dev/null @@ -1,1382 +0,0 @@ -'\" t -.TH QTable 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 -QTable \- Flexible editable table widget -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QScrollView. -.PP -Inherited by QDataTable. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTable\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQTable\fR ( int numRows, int numCols, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QTable\fR ()" -.br -.ti -1c -.BI "QHeader * \fBhorizontalHeader\fR () const" -.br -.ti -1c -.BI "QHeader * \fBverticalHeader\fR () const" -.br -.ti -1c -.BI "enum \fBSelectionMode\fR { Single, Multi, SingleRow, MultiRow, NoSelection }" -.br -.ti -1c -.BI "virtual void \fBsetSelectionMode\fR ( SelectionMode mode )" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetItem\fR ( int row, int col, QTableItem * item )" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( int row, int col, const QString & text )" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( int row, int col, const QPixmap & pix )" -.br -.ti -1c -.BI "virtual QTableItem * \fBitem\fR ( int row, int col ) const" -.br -.ti -1c -.BI "virtual QString \fBtext\fR ( int row, int col ) const" -.br -.ti -1c -.BI "virtual QPixmap \fBpixmap\fR ( int row, int col ) const" -.br -.ti -1c -.BI "virtual void \fBclearCell\fR ( int row, int col )" -.br -.ti -1c -.BI "virtual QRect \fBcellGeometry\fR ( int row, int col ) const" -.br -.ti -1c -.BI "virtual int \fBcolumnWidth\fR ( int col ) const" -.br -.ti -1c -.BI "virtual int \fBrowHeight\fR ( int row ) const" -.br -.ti -1c -.BI "virtual int \fBcolumnPos\fR ( int col ) const" -.br -.ti -1c -.BI "virtual int \fBrowPos\fR ( int row ) const" -.br -.ti -1c -.BI "virtual int \fBcolumnAt\fR ( int x ) const" -.br -.ti -1c -.BI "virtual int \fBrowAt\fR ( int y ) const" -.br -.ti -1c -.BI "virtual int \fBnumRows\fR () const" -.br -.ti -1c -.BI "virtual int \fBnumCols\fR () const" -.br -.ti -1c -.BI "void \fBupdateCell\fR ( int row, int col )" -.br -.ti -1c -.BI "int \fBcurrentRow\fR () const" -.br -.ti -1c -.BI "int \fBcurrentColumn\fR () const" -.br -.ti -1c -.BI "void \fBensureCellVisible\fR ( int row, int col )" -.br -.ti -1c -.BI "bool \fBisSelected\fR ( int row, int col ) const" -.br -.ti -1c -.BI "bool \fBisRowSelected\fR ( int row, bool full = FALSE ) const" -.br -.ti -1c -.BI "bool \fBisColumnSelected\fR ( int col, bool full = FALSE ) const" -.br -.ti -1c -.BI "int \fBnumSelections\fR () const" -.br -.ti -1c -.BI "QTableSelection \fBselection\fR ( int num ) const" -.br -.ti -1c -.BI "virtual int \fBaddSelection\fR ( const QTableSelection & s )" -.br -.ti -1c -.BI "virtual void \fBremoveSelection\fR ( const QTableSelection & s )" -.br -.ti -1c -.BI "virtual void \fBremoveSelection\fR ( int num )" -.br -.ti -1c -.BI "virtual int \fBcurrentSelection\fR () const" -.br -.ti -1c -.BI "void \fBselectCells\fR ( int start_row, int start_col, int end_row, int end_col )" -.br -.ti -1c -.BI "void \fBselectRow\fR ( int row )" -.br -.ti -1c -.BI "void \fBselectColumn\fR ( int col )" -.br -.ti -1c -.BI "bool \fBshowGrid\fR () const" -.br -.ti -1c -.BI "bool \fBcolumnMovingEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBrowMovingEnabled\fR () const" -.br -.ti -1c -.BI "virtual void \fBsortColumn\fR ( int col, bool ascending = TRUE, bool wholeRows = FALSE )" -.br -.ti -1c -.BI "bool \fBsorting\fR () const" -.br -.ti -1c -.BI "virtual void \fBtakeItem\fR ( QTableItem * i )" -.br -.ti -1c -.BI "virtual void \fBsetCellWidget\fR ( int row, int col, QWidget * e )" -.br -.ti -1c -.BI "virtual QWidget * \fBcellWidget\fR ( int row, int col ) const" -.br -.ti -1c -.BI "virtual void \fBclearCellWidget\fR ( int row, int col )" -.br -.ti -1c -.BI "virtual QRect \fBcellRect\fR ( int row, int col ) const" -.br -.ti -1c -.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col, const QRect & cr, bool selected )" -.br -.ti -1c -.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col, const QRect & cr, bool selected, const QColorGroup & cg )" -.br -.ti -1c -.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QRect & cr )" -.br -.ti -1c -.BI "bool \fBisReadOnly\fR () const" -.br -.ti -1c -.BI "bool \fBisRowReadOnly\fR ( int row ) const" -.br -.ti -1c -.BI "bool \fBisColumnReadOnly\fR ( int col ) const" -.br -.ti -1c -.BI "void \fBrepaintSelections\fR ()" -.br -.ti -1c -.BI "enum \fBFocusStyle\fR { FollowStyle, SpreadSheet }" -.br -.ti -1c -.BI "virtual void \fBsetFocusStyle\fR ( FocusStyle fs )" -.br -.ti -1c -.BI "FocusStyle \fBfocusStyle\fR () const" -.br -.ti -1c -.BI "void \fBupdateHeaderStates\fR ()" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetNumRows\fR ( int r )" -.br -.ti -1c -.BI "virtual void \fBsetNumCols\fR ( int r )" -.br -.ti -1c -.BI "virtual void \fBsetShowGrid\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBhideRow\fR ( int row )" -.br -.ti -1c -.BI "virtual void \fBhideColumn\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBshowRow\fR ( int row )" -.br -.ti -1c -.BI "virtual void \fBshowColumn\fR ( int col )" -.br -.ti -1c -.BI "bool \fBisRowHidden\fR ( int row ) const" -.br -.ti -1c -.BI "bool \fBisColumnHidden\fR ( int col ) const" -.br -.ti -1c -.BI "virtual void \fBsetColumnWidth\fR ( int col, int w )" -.br -.ti -1c -.BI "virtual void \fBsetRowHeight\fR ( int row, int h )" -.br -.ti -1c -.BI "virtual void \fBadjustColumn\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBadjustRow\fR ( int row )" -.br -.ti -1c -.BI "virtual void \fBsetColumnStretchable\fR ( int col, bool stretch )" -.br -.ti -1c -.BI "virtual void \fBsetRowStretchable\fR ( int row, bool stretch )" -.br -.ti -1c -.BI "bool \fBisColumnStretchable\fR ( int col ) const" -.br -.ti -1c -.BI "bool \fBisRowStretchable\fR ( int row ) const" -.br -.ti -1c -.BI "virtual void \fBsetSorting\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBswapRows\fR ( int row1, int row2, bool swapHeader = FALSE )" -.br -.ti -1c -.BI "virtual void \fBswapColumns\fR ( int col1, int col2, bool swapHeader = FALSE )" -.br -.ti -1c -.BI "virtual void \fBswapCells\fR ( int row1, int col1, int row2, int col2 )" -.br -.ti -1c -.BI "virtual void \fBsetLeftMargin\fR ( int m )" -.br -.ti -1c -.BI "virtual void \fBsetTopMargin\fR ( int m )" -.br -.ti -1c -.BI "virtual void \fBsetCurrentCell\fR ( int row, int col )" -.br -.ti -1c -.BI "void \fBclearSelection\fR ( bool repaint = TRUE )" -.br -.ti -1c -.BI "virtual void \fBsetColumnMovingEnabled\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetRowMovingEnabled\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetReadOnly\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetRowReadOnly\fR ( int row, bool ro )" -.br -.ti -1c -.BI "virtual void \fBsetColumnReadOnly\fR ( int col, bool ro )" -.br -.ti -1c -.BI "virtual void \fBsetDragEnabled\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBdragEnabled\fR () const" -.br -.ti -1c -.BI "virtual void \fBinsertRows\fR ( int row, int count = 1 )" -.br -.ti -1c -.BI "virtual void \fBinsertColumns\fR ( int col, int count = 1 )" -.br -.ti -1c -.BI "virtual void \fBremoveRow\fR ( int row )" -.br -.ti -1c -.BI "virtual void \fBremoveRows\fR ( const QMemArray & rows )" -.br -.ti -1c -.BI "virtual void \fBremoveColumn\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBremoveColumns\fR ( const QMemArray & cols )" -.br -.ti -1c -.BI "virtual void \fBeditCell\fR ( int row, int col, bool replace = FALSE )" -.br -.ti -1c -.BI "void \fBsetRowLabels\fR ( const QStringList & labels )" -.br -.ti -1c -.BI "void \fBsetColumnLabels\fR ( const QStringList & labels )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBcurrentChanged\fR ( int row, int col )" -.br -.ti -1c -.BI "void \fBclicked\fR ( int row, int col, int button, const QPoint & mousePos )" -.br -.ti -1c -.BI "void \fBdoubleClicked\fR ( int row, int col, int button, const QPoint & mousePos )" -.br -.ti -1c -.BI "void \fBpressed\fR ( int row, int col, int button, const QPoint & mousePos )" -.br -.ti -1c -.BI "void \fBselectionChanged\fR ()" -.br -.ti -1c -.BI "void \fBvalueChanged\fR ( int row, int col )" -.br -.ti -1c -.BI "void \fBcontextMenuRequested\fR ( int row, int col, const QPoint & pos )" -.br -.ti -1c -.BI "void \fBdropped\fR ( QDropEvent * e )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBcolumnMovingEnabled\fR - whether columns can be moved by the user" -.br -.ti -1c -.BI "FocusStyle \fBfocusStyle\fR - how the current (focus) cell is drawn" -.br -.ti -1c -.BI "int \fBnumCols\fR - the number of columns in the table" -.br -.ti -1c -.BI "int \fBnumRows\fR - the number of rows in the table" -.br -.ti -1c -.BI "int \fBnumSelections\fR - the number of selections \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBreadOnly\fR - whether the table is read-only" -.br -.ti -1c -.BI "bool \fBrowMovingEnabled\fR - whether rows can be moved by the user" -.br -.ti -1c -.BI "SelectionMode \fBselectionMode\fR - the current selection mode" -.br -.ti -1c -.BI "bool \fBshowGrid\fR - whether the table's grid is displayed" -.br -.ti -1c -.BI "bool \fBsorting\fR - whether a click on the header of a column sorts that column" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "enum \fBEditMode\fR { NotEditing, Editing, Replacing }" -.br -.ti -1c -.BI "virtual void \fBdrawContents\fR ( QPainter * p, int cx, int cy, int cw, int ch )" -.br -.ti -1c -.BI "void \fBsetEditMode\fR ( EditMode mode, int row, int col )" -.br -.ti -1c -.BI "virtual void \fBcontentsDragEnterEvent\fR ( QDragEnterEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsDragMoveEvent\fR ( QDragMoveEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsDragLeaveEvent\fR ( QDragLeaveEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontentsDropEvent\fR ( QDropEvent * e )" -.br -.ti -1c -.BI "virtual QDragObject * \fBdragObject\fR ()" -.br -.ti -1c -.BI "virtual void \fBstartDrag\fR ()" -.br -.ti -1c -.BI "virtual void \fBpaintEmptyArea\fR ( QPainter * p, int cx, int cy, int cw, int ch )" -.br -.ti -1c -.BI "virtual void \fBactivateNextCell\fR ()" -.br -.ti -1c -.BI "virtual QWidget * \fBcreateEditor\fR ( int row, int col, bool initFromCell ) const" -.br -.ti -1c -.BI "virtual void \fBsetCellContentFromEditor\fR ( int row, int col )" -.br -.ti -1c -.BI "virtual QWidget * \fBbeginEdit\fR ( int row, int col, bool replace )" -.br -.ti -1c -.BI "virtual void \fBendEdit\fR ( int row, int col, bool accept, bool replace )" -.br -.ti -1c -.BI "virtual void \fBresizeData\fR ( int len )" -.br -.ti -1c -.BI "virtual void \fBinsertWidget\fR ( int row, int col, QWidget * w )" -.br -.ti -1c -.BI "int \fBindexOf\fR ( int row, int col ) const" -.br -.ti -1c -.BI "bool \fBisEditing\fR () const" -.br -.ti -1c -.BI "EditMode \fBeditMode\fR () const" -.br -.ti -1c -.BI "int \fBcurrEditRow\fR () const" -.br -.ti -1c -.BI "int \fBcurrEditCol\fR () const" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "virtual void \fBcolumnWidthChanged\fR ( int col )" -.br -.ti -1c -.BI "virtual void \fBrowHeightChanged\fR ( int row )" -.br -.ti -1c -.BI "virtual void \fBcolumnIndexChanged\fR ( int section, int fromIndex, int toIndex )" -.br -.ti -1c -.BI "virtual void \fBrowIndexChanged\fR ( int section, int fromIndex, int toIndex )" -.br -.ti -1c -.BI "virtual void \fBcolumnClicked\fR ( int col )" -.br -.in -1c -.SH DESCRIPTION -The QTable class provides a flexible editable table widget. -.PP -QTable is easy to use, although it does have a large API because of the comprehensive functionality that it provides. QTable includes functions for manipulating headers, rows and columns, cells and selections. QTable also provides in-place editing and drag and drop, as well as a useful set of signals. QTable efficiently supports very large tables, for example, tables one million by one million cells are perfectly possible. QTable is economical with memory, using none for unused cells. -.PP -.nf -.br - QTable *table = new QTable( 100, 250, this ); -.br - table->setPixmap( 3, 2, pix ); -.br - table->setText( 3, 2, "A pixmap" ); -.br -.fi -.PP -The first line constructs the table specifying its size in rows and columns. We then insert a pixmap and some text into the \fIsame\fR cell, with the pixmap appearing to the left of the text. QTable cells can be populated with QTableItems, QComboTableItems or by QCheckTableItems. By default a vertical header appears at the left of the table showing row numbers and a horizontal header appears at the top of the table showing column numbers. (The numbers displayed start at 1, although row and column numbers within QTable begin at 0.) -.PP -If you want to use mouse tracking call setMouseTracking( TRUE ) on the \fIviewport\fR; (see QScrollView). -.PP -
                                                              -.ce 1 -.B "[Image Omitted]" -.PP -
                                                              -.SH "Headers" -QTable supports a header column, e.g. to display row numbers, and a header row, e.g to display column titles. To set row or column labels use QHeader::setLabel() on the pointers returned by verticalHeader() and horizontalHeader() respectively. The vertical header is displayed within the table's left margin whose width is set with setLeftMargin(). The horizontal header is displayed within the table's top margin whose height is set with setTopMargin(). The table's grid can be switched off with setShowGrid(). If you want to hide a horizontal header call hide(), and call setTopMargin( 0 ) so that the area the header would have occupied is reduced to zero size. -.PP -Header labels are indexed via their section numbers. Note that the default behavior of QHeader regarding section numbers is overriden for QTable. See the explanation below in the Rows and Columns section in the discussion of moving columns and rows. -.SH "Rows and Columns" -Row and column sizes are set with setRowHeight() and setColumnWidth(). If you want a row high enough to show the tallest item in its entirety, use adjustRow(). Similarly, to make a column wide enough to show the widest item use adjustColumn(). If you want the row height and column width to adjust automatically as the height and width of the table changes use setRowStretchable() and setColumnStretchable(). -.PP -Rows and columns can be hidden and shown with hideRow(), hideColumn(), showRow() and showColumn(). New rows and columns are inserted using insertRows() and insertColumns(). Additional rows and columns are added at the bottom (rows) or right (columns) if you set setNumRows() or setNumCols() to be larger than numRows() or numCols(). Existing rows and columns are removed with removeRow() and removeColumn(). Multiple rows and columns can be removed with removeRows() and removeColumns(). -.PP -Rows and columns can be set to be moveable using rowMovingEnabled() and columnMovingEnabled(). The user can drag them to reorder them holding down the Ctrl key and dragging the mouse. For performance reasons, the default behavior of QHeader section numbers is overridden by QTable. Currently in QTable, when a row or column is dragged and reordered, the section number is also changed to its new position. Therefore, there is no difference between the section and the index fields in QHeader. The QTable QHeader classes do not provide a mechanism for indexing independently of the user interface ordering. -.PP -The table can be sorted using sortColumn(). Users can sort a column by clicking its header if setSorting() is set to TRUE. Rows can be swapped with swapRows(), columns with swapColumns() and cells with swapCells(). -.PP -For editable tables (see setReadOnly()) you can set the read-only property of individual rows and columns with setRowReadOnly() and setColumnReadOnly(). (Whether a cell is editable or read-only depends on these settings and the cell's QTableItem::EditType.) -.PP -The row and column which have the focus are returned by currentRow() and currentColumn() respectively. -.PP -Although many QTable functions operate in terms of rows and columns the indexOf() function returns a single integer identifying a particular cell. -.SH "Cells" -All of a QTable's cells are empty when the table is constructed. -.PP -There are two approaches to populating the table's cells. The first and simplest approach is to use QTableItems or QTableItem subclasses. The second approach doesn't use QTableItems at all which is useful for very large sparse tables but requires you to reimplement a number of functions. We'll look at each approach in turn. -.PP -To put a string in a cell use setText(). This function will create a new QTableItem for the cell if one doesn't already exist, and displays the text in it. By default the table item's widget will be a QLineEdit. A pixmap may be put in a cell with setPixmap(), which also creates a table item if required. A cell may contain \fIboth\fR a pixmap and text; the pixmap is displayed to the left of the text. Another approach is to construct a QTableItem or QTableItem subclass, set its properties, then insert it into a cell with setItem(). -.PP -If you want cells which contain comboboxes use the QComboTableItem class. Similarly if you require cells containing checkboxes use the QCheckTableItem class. These table items look and behave just like the combobox or checkbox widgets but consume far less memory. -.PP -.nf -.br - for ( int j = 0; j < numRows; ++j ) -.br - table.setItem( j, 1, new QCheckTableItem( &table, "Check me" ) ); -.fi -In the example above we create a column of QCheckTableItems and insert them into the table using setItem(). -.PP -QTable takes ownership of its QTableItems and will delete them when the table itself is destroyed. You can take ownership of a table item using takeItem() which you use to move a cell's contents from one cell to another, either within the same table, or from one table to another. (See also, swapCells()). -.PP -In-place editing of the text in QTableItems, and the values in QComboTableItems and QCheckTableItems works automatically. Cells may be editable or read-only, see QTableItem::EditType. If you want fine control over editing see beginEdit() and endEdit(). -.PP -The contents of a cell can be retrieved as a QTableItem using item(), or as a string with text() or as a pixmap (if there is one) with pixmap(). A cell's bounding rectangle is given by cellGeometry(). Use updateCell() to repaint a cell, for example to clear away a cell's visual representation after it has been deleted with clearCell(). The table can be forced to scroll to show a particular cell with ensureCellVisible(). The isSelected() function indicates if a cell is selected. -.PP -It is possible to use your own widget as a cell's widget using setCellWidget(), but subclassing QTableItem might be a simpler approach. The cell's widget (if there is one) can be removed with clearCellWidget(). -.PP - -

                                                              Large tables

                                                              -.PP -For large, sparse, tables using QTableItems or other widgets is inefficient. The solution is to \fIdraw\fR the cell as it should appear and to create and destroy cell editors on demand. -.PP -This approach requires that you reimplement various functions. Reimplement paintCell() to display your data, and createEditor() and setCellContentFromEditor() to support in-place editing. It is very important to reimplement resizeData() to have no functionality, to prevent QTable from attempting to create a huge array. You will also need to reimplement item(), setItem(), takeItem(), clearCell(), and insertWidget(), cellWidget() and clearCellWidget(). In almost every circumstance (for sorting, removing and inserting columns and rows, etc.), you also need to reimplement swapRows(), swapCells() and swapColumns(), including header handling. -.PP -If you represent active cells with a dictionary of QTableItems and QWidgets, i.e. only store references to cells that are actually used, many of the functions can be implemented with a single line of code. (See the table/bigtable/main.cpp example.) -.PP -For more information on cells see the QTableItem documenation. -.SH "Selections" -QTable's support single selection, multi-selection (multiple cells) or no selection. The selection mode is set with setSelectionMode(). Use isSelected() to determine if a particular cell is selected, and isRowSelected() and isColumnSelected() to see if a row or column is selected. -.PP -QTable's support many simultaneous selections. You can programmatically select cells with addSelection(). The number of selections is given by numSelections(). The current selection is returned by currentSelection(). You can remove a selection with removeSelection() and remove all selections with clearSelection(). Selections are QTableSelection objects. -.PP -To easily add a new selection use selectCells(), selectRow() or selectColumn(). -.PP -Alternatively, use addSelection() to add new selections using QTableSelection objects. The advantage of using QTableSelection objects is that you can call QTableSelection::expandTo() to resize the selection and can query and compare them. -.PP -The number of selections is given by numSelections(). The current selection is returned by currentSelection(). You can remove a selection with removeSelection() and remove all selections with clearSelection(). -.SH "Signals" -When the user clicks a cell the currentChanged() signal is emitted. You can also connect to the lower level clicked(), doubleClicked() and pressed() signals. If the user changes the selection the selectionChanged() signal is emitted; similarly if the user changes a cell's value the valueChanged() signal is emitted. If the user right-clicks (or presses the appropriate platform-specific key sequence) the contextMenuRequested() signal is emitted. If the user drops a drag and drop object the dropped() signal is emitted with the drop event. -.PP -See also Advanced Widgets. -.SS "Member Type Documentation" -.SH "QTable::EditMode" -.TP -\fCQTable::NotEditing\fR - No cell is currently being edited. -.TP -\fCQTable::Editing\fR - A cell is currently being edited. The editor was initialised with the cell's contents. -.TP -\fCQTable::Replacing\fR - A cell is currently being edited. The editor was not initialised with the cell's contents. -.SH "QTable::FocusStyle" -Specifies how the current cell (focus cell) is drawn. -.TP -\fCQTable::FollowStyle\fR - The current cell is drawn according to the current style and the cell's background is also drawn selected, if the current cell is within a selection -.TP -\fCQTable::SpreadSheet\fR - The current cell is drawn as in a spreadsheet. This means, it is signified by a black rectangle around the cell, and the background of the current cell is always drawn with the widget's base color - even when selected. -.SH "QTable::SelectionMode" -.TP -\fCQTable::NoSelection\fR - No cell can be selected by the user. -.TP -\fCQTable::Single\fR - The user may only select a single range of cells. -.TP -\fCQTable::Multi\fR - The user may select multiple ranges of cells. -.TP -\fCQTable::SingleRow\fR - The user may select one row at once. -.TP -\fCQTable::MultiRow\fR - The user may select multiple rows. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTable::QTable ( QWidget * parent = 0, const char * name = 0 )" -Creates an empty table object called \fIname\fR as a child of \fIparent\fR. -.PP -Call setNumRows() and setNumCols() to set the table size before populating the table if you're using QTableItems. -.PP -See also QWidget::clearWFlags() and Qt::WidgetFlags. -.SH "QTable::QTable ( int numRows, int numCols, QWidget * parent = 0, const char * name = 0 )" -Constructs an empty table called \fIname\fR with \fInumRows\fR rows and \fInumCols\fR columns. The table is a child of \fIparent\fR. -.PP -If you're using QTableItems to populate the table's cells, you can create QTableItem, QComboTableItem and QCheckTableItem items and insert them into the table using setItem(). (See the notes on large tables for an alternative to using QTableItems.) -.PP -See also QWidget::clearWFlags() and Qt::WidgetFlags. -.SH "QTable::~QTable ()" -Releases all the resources used by the QTable object, including all QTableItems and their widgets. -.SH "void QTable::activateNextCell ()\fC [virtual protected]\fR" -This function is called to activate the next cell if in-place editing was finished by pressing the Enter key. -.PP -The default behaviour is to move from top to bottom, i.e. move to the cell beneath the cell being edited. Reimplement this function if you want different behaviour, e.g. moving from left to right. -.SH "int QTable::addSelection ( const QTableSelection & s )\fC [virtual]\fR" -Adds a selection described by \fIs\fR to the table and returns its number or -1 if the selection is invalid. -.PP -Remember to call QTableSelection::init() and QTableSelection::expandTo() to make the selection valid (see also QTableSelection::isActive(), or use the QTableSelection(int,int,int,int) constructor). -.PP -See also numSelections, removeSelection(), and clearSelection(). -.SH "void QTable::adjustColumn ( int col )\fC [virtual slot]\fR" -Resizes column \fIcol\fR so that the column width is wide enough to display the widest item the column contains. -.PP -See also adjustRow(). -.PP -Example: regexptester/regexptester.cpp. -.PP -Reimplemented in QDataTable. -.SH "void QTable::adjustRow ( int row )\fC [virtual slot]\fR" -Resizes row \fIrow\fR so that the row height is tall enough to display the tallest item the row contains. -.PP -See also adjustColumn(). -.SH "QWidget * QTable::beginEdit ( int row, int col, bool replace )\fC [virtual protected]\fR" -This function is called to start in-place editing of the cell at \fIrow\fR, \fIcol\fR. Editing is achieved by creating an editor (createEditor() is called) and setting the cell's editor with setCellWidget() to the newly created editor. (After editing is complete endEdit() will be called to replace the cell's content with the editor's content.) If \fIreplace\fR is TRUE the editor will start empty; otherwise it will be initialized with the cell's content (if any), i.e. the user will be modifying the original cell content. -.PP -See also endEdit(). -.SH "QRect QTable::cellGeometry ( int row, int col ) const\fC [virtual]\fR" -Returns the bounding rectangle of the cell at \fIrow\fR, \fIcol\fR in content coordinates. -.SH "QRect QTable::cellRect ( int row, int col ) const\fC [virtual]\fR" -Returns the geometry of cell \fIrow\fR, \fIcol\fR in the cell's coordinate system. This is a convenience function useful in paintCell(). It is equivalent to QRect( QPoint(0,0), cellGeometry( row, col).size() ); -.PP -See also cellGeometry(). -.PP -Example: chart/setdataform.cpp. -.SH "QWidget * QTable::cellWidget ( int row, int col ) const\fC [virtual]\fR" -Returns the widget that has been set for the cell at \fIrow\fR, \fIcol\fR, or 0 if no widget has been set. -.PP -If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. -.PP -See also clearCellWidget() and setCellWidget(). -.PP -Example: chart/setdataform.cpp. -.SH "void QTable::clearCell ( int row, int col )\fC [virtual]\fR" -Removes the QTableItem at \fIrow\fR, \fIcol\fR. -.PP -If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. -.SH "void QTable::clearCellWidget ( int row, int col )\fC [virtual]\fR" -Removes the widget (if there is one) set for the cell at \fIrow\fR, \fIcol\fR. -.PP -If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. -.PP -This function deletes the widget at \fIrow\fR, \fIcol\fR. Note that the widget is not deleted immediately; instead QObject::deleteLater() is called on the widget to avoid problems with timing issues. -.PP -See also cellWidget() and setCellWidget(). -.SH "void QTable::clearSelection ( bool repaint = TRUE )\fC [slot]\fR" -Clears all selections and repaints the appropriate regions if \fIrepaint\fR is TRUE. -.PP -See also removeSelection(). -.SH "void QTable::clicked ( int row, int col, int button, const QPoint & mousePos )\fC [signal]\fR" -This signal is emitted when mouse button \fIbutton\fR is clicked. The cell where the event took place is at \fIrow\fR, \fIcol\fR, and the mouse's position is in \fImousePos\fR. -.PP -See also Qt::ButtonState. -.PP -Example: chart/setdataform.cpp. -.SH "int QTable::columnAt ( int x ) const\fC [virtual]\fR" -Returns the number of the column at position \fIx\fR. \fIx\fR must be given in content coordinates. -.PP -See also columnPos() and rowAt(). -.SH "void QTable::columnClicked ( int col )\fC [virtual protected slot]\fR" -This function is called when the column \fIcol\fR has been clicked. The default implementation sorts this column if sorting() is TRUE. -.SH "void QTable::columnIndexChanged ( int section, int fromIndex, int toIndex )\fC [virtual protected slot]\fR" -This function is called when column order is to be changed, i.e. when the user moved the column header \fIsection\fR from \fIfromIndex\fR to \fItoIndex\fR. -.PP -If you want to change the column order programmatically, call swapRows() or swapColumns(); -.PP -See also QHeader::indexChange() and rowIndexChanged(). -.SH "bool QTable::columnMovingEnabled () const" -Returns TRUE if columns can be moved by the user; otherwise returns FALSE. See the "columnMovingEnabled" property for details. -.SH "int QTable::columnPos ( int col ) const\fC [virtual]\fR" -Returns the x-coordinate of the column \fIcol\fR in content coordinates. -.PP -See also columnAt() and rowPos(). -.SH "int QTable::columnWidth ( int col ) const\fC [virtual]\fR" -Returns the width of column \fIcol\fR. -.PP -See also setColumnWidth() and rowHeight(). -.SH "void QTable::columnWidthChanged ( int col )\fC [virtual protected slot]\fR" -This function should be called whenever the column width of \fIcol\fR has been changed. It updates the geometry of any affected columns and repaints the table to reflect the changes it has made. -.SH "void QTable::contentsDragEnterEvent ( QDragEnterEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever a QTable object receives a QDragEnterEvent \fIe\fR, i.e. when the user pressed the mouse button to drag something. -.PP -The focus is moved to the cell where the QDragEnterEvent occurred. -.PP -Reimplemented from QScrollView. -.SH "void QTable::contentsDragLeaveEvent ( QDragLeaveEvent * e )\fC [virtual protected]\fR" -This event handler is called when a drag activity leaves \fIthis\fR QTable object with event \fIe\fR. -.PP -Reimplemented from QScrollView. -.SH "void QTable::contentsDragMoveEvent ( QDragMoveEvent * e )\fC [virtual protected]\fR" -This event handler is called whenever a QTable object receives a QDragMoveEvent \fIe\fR, i.e. when the user actually drags the mouse. -.PP -The focus is moved to the cell where the QDragMoveEvent occurred. -.PP -Reimplemented from QScrollView. -.SH "void QTable::contentsDropEvent ( QDropEvent * e )\fC [virtual protected]\fR" -This event handler is called when the user ends a drag and drop by dropping something onto \fIthis\fR QTable and thus triggers the drop event, \fIe\fR. -.PP -Reimplemented from QScrollView. -.SH "void QTable::contextMenuRequested ( int row, int col, const QPoint & pos )\fC [signal]\fR" -This signal is emitted when the user invokes a context menu with the right mouse button (or with a system-specific keypress). The cell where the event took place is at \fIrow\fR, \fIcol\fR. \fIpos\fR is the position where the context menu will appear in the global coordinate system. This signal is always emitted, even if the contents of the cell are disabled. -.SH "QWidget * QTable::createEditor ( int row, int col, bool initFromCell ) const\fC [virtual protected]\fR" -This function returns the widget which should be used as an editor for the contents of the cell at \fIrow\fR, \fIcol\fR. -.PP -If \fIinitFromCell\fR is TRUE, the editor is used to edit the current contents of the cell (so the editor widget should be initialized with this content). If \fIinitFromCell\fR is FALSE, the content of the cell is replaced with the new content which the user entered into the widget created by this function. -.PP -The default functionality is as follows: if \fIinitFromCell\fR is TRUE or the cell has a QTableItem and the table item's QTableItem::isReplaceable() is FALSE then the cell is asked to create an appropriate editor (using QTableItem::createEditor()). Otherwise a QLineEdit is used as the editor. -.PP -If you want to create your own editor for certain cells, implement a custom QTableItem subclass and reimplement QTableItem::createEditor(). -.PP -If you are not using QTableItems and you don't want to use a QLineEdit as the default editor, subclass QTable and reimplement this function with code like this: -.PP -.nf -.br - QTableItem *i = item( row, col ); -.br - if ( initFromCell || ( i && !i->isReplaceable() ) ) -.br - // If we had a QTableItem ask the base class to create the editor -.br - return QTable::createEditor( row, col, initFromCell ); -.br - else -.br - return ...(create your own editor) -.br -.fi -Ownership of the editor widget is transferred to the caller. -.PP -If you reimplement this function return 0 for read-only cells. You will need to reimplement setCellContentFromEditor() to retrieve the data the user entered. -.PP -See also QTableItem::createEditor(). -.SH "int QTable::currEditCol () const\fC [protected]\fR" -Returns the current edited column -.SH "int QTable::currEditRow () const\fC [protected]\fR" -Returns the current edited row -.SH "void QTable::currentChanged ( int row, int col )\fC [signal]\fR" -This signal is emitted when the current cell has changed to \fIrow\fR, \fIcol\fR. -.PP -Example: chart/setdataform.cpp. -.SH "int QTable::currentColumn () const" -Returns the current column. -.PP -See also currentRow(). -.PP -Example: chart/setdataform.cpp. -.SH "int QTable::currentRow () const" -Returns the current row. -.PP -See also currentColumn(). -.PP -Example: chart/setdataform.cpp. -.SH "int QTable::currentSelection () const\fC [virtual]\fR" -Returns the number of the current selection or -1 if there is no current selection. -.PP -See also numSelections. -.SH "void QTable::doubleClicked ( int row, int col, int button, const QPoint & mousePos )\fC [signal]\fR" -This signal is emitted when mouse button \fIbutton\fR is double-clicked. The cell where the event took place is at \fIrow\fR, \fIcol\fR, and the mouse's position is in \fImousePos\fR. -.PP -See also Qt::ButtonState. -.SH "bool QTable::dragEnabled () const\fC [slot]\fR" -If this function returns TRUE, the table supports dragging. -.PP -See also setDragEnabled(). -.SH "QDragObject * QTable::dragObject ()\fC [virtual protected]\fR" -If the user presses the mouse on a selected cell, starts moving (i.e. dragging), and dragEnabled() is TRUE, this function is called to obtain a drag object. A drag using this object begins immediately unless dragObject() returns 0. -.PP -By default this function returns 0. You might reimplement it and create a QDragObject depending on the selected items. -.PP -See also dropped(). -.SH "void QTable::drawContents ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" -Draws the table contents on the painter \fIp\fR. This function is optimized so that it only draws the cells inside the \fIcw\fR pixels wide and \fIch\fR pixels high clipping rectangle at position \fIcx\fR, \fIcy\fR. -.PP -Additionally, drawContents() highlights the current cell. -.PP -Reimplemented from QScrollView. -.SH "void QTable::dropped ( QDropEvent * e )\fC [signal]\fR" -This signal is emitted when a drop event occurred on the table. -.PP -\fIe\fR contains information about the drop. -.SH "void QTable::editCell ( int row, int col, bool replace = FALSE )\fC [virtual slot]\fR" -Starts editing the cell at \fIrow\fR, \fIcol\fR. -.PP -If \fIreplace\fR is TRUE the content of this cell will be replaced by the content of the editor when editing is finished, i.e. the user will be entering new data; otherwise the current content of the cell (if any) will be modified in the editor. -.PP -See also beginEdit(). -.SH "EditMode QTable::editMode () const\fC [protected]\fR" -Returns the current edit mode -.PP -See also QTable::EditMode. -.SH "void QTable::endEdit ( int row, int col, bool accept, bool replace )\fC [virtual protected]\fR" -This function is called when in-place editing of the cell at \fIrow\fR, \fIcol\fR is requested to stop. -.PP -If the cell is not being edited or \fIaccept\fR is FALSE the function returns and the cell's contents are left unchanged. -.PP -If \fIaccept\fR is TRUE the content of the editor must be transferred to the relevant cell. If \fIreplace\fR is TRUE the current content of this cell should be replaced by the content of the editor (this means removing the current QTableItem of the cell and creating a new one for the cell). Otherwise (if possible) the content of the editor should just be set to the existing QTableItem of this cell. -.PP -setCellContentFromEditor() is called to replace the contents of the cell with the contents of the cell's editor. -.PP -Finally clearCellWidget() is called to remove the editor widget. -.PP -See also setCellContentFromEditor() and beginEdit(). -.SH "void QTable::ensureCellVisible ( int row, int col )" -Scrolls the table until the cell at \fIrow\fR, \fIcol\fR becomes visible. -.SH "FocusStyle QTable::focusStyle () const" -Returns how the current (focus) cell is drawn. See the "focusStyle" property for details. -.SH "void QTable::hideColumn ( int col )\fC [virtual slot]\fR" -Hides column \fIcol\fR. -.PP -See also showColumn() and hideRow(). -.SH "void QTable::hideRow ( int row )\fC [virtual slot]\fR" -Hides row \fIrow\fR. -.PP -See also showRow() and hideColumn(). -.SH "QHeader * QTable::horizontalHeader () const" -Returns the table's top QHeader. -.PP -This header contains the column labels. -.PP -To modify a column label use QHeader::setLabel(), e.g. -.PP -.nf -.br - horizontalHeader()->setLabel( 0, tr( "File" ) ); -.fi -.PP -See also verticalHeader(), setTopMargin(), and QHeader. -.PP -Examples: -.)l chart/setdataform.cpp, helpsystem/mainwindow.cpp, regexptester/regexptester.cpp, and table/small-table-demo/main.cpp. -.SH "int QTable::indexOf ( int row, int col ) const\fC [protected]\fR" -Returns a single integer which identifies a particular \fIrow\fR and \fIcol\fR by mapping the 2D table to a 1D array. -.PP -This is useful, for example, if you have a sparse table and want to use a QIntDict to map integers to the cells that are used. -.SH "void QTable::insertColumns ( int col, int count = 1 )\fC [virtual slot]\fR" -Inserts \fIcount\fR empty columns at column \fIcol\fR. Also clears the selection(s). -.PP -See also insertRows() and removeColumn(). -.SH "void QTable::insertRows ( int row, int count = 1 )\fC [virtual slot]\fR" -Inserts \fIcount\fR empty rows at row \fIrow\fR. Also clears the selection(s). -.PP -See also insertColumns() and removeRow(). -.SH "void QTable::insertWidget ( int row, int col, QWidget * w )\fC [virtual protected]\fR" -Inserts widget \fIw\fR at \fIrow\fR, \fIcol\fR into the internal data structure. See the documentation of setCellWidget() for further details. -.PP -If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. -.SH "bool QTable::isColumnHidden ( int col ) const\fC [slot]\fR" -Returns TRUE if column \fIcol\fR is hidden; otherwise returns FALSE. -.PP -See also hideColumn() and isRowHidden(). -.SH "bool QTable::isColumnReadOnly ( int col ) const" -Returns TRUE if column \fIcol\fR is read-only; otherwise returns FALSE. -.PP -Whether a cell in this column is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. -.PP -See also setColumnReadOnly() and isRowReadOnly(). -.SH "bool QTable::isColumnSelected ( int col, bool full = FALSE ) const" -Returns TRUE if column \fIcol\fR is selected; otherwise returns FALSE. -.PP -If \fIfull\fR is FALSE (the default), 'column is selected' means that at least one cell in the column is selected. If \fIfull\fR is TRUE, then 'column is selected' means every cell in the column is selected. -.PP -See also isRowSelected() and isSelected(). -.SH "bool QTable::isColumnStretchable ( int col ) const\fC [slot]\fR" -Returns TRUE if column \fIcol\fR is stretchable; otherwise returns FALSE. -.PP -See also setColumnStretchable() and isRowStretchable(). -.SH "bool QTable::isEditing () const\fC [protected]\fR" -Returns TRUE if the EditMode is Editing or Replacing; otherwise (i.e. the EditMode is NotEditing) returns FALSE. -.PP -See also QTable::EditMode. -.SH "bool QTable::isReadOnly () const" -Returns TRUE if the table is read-only; otherwise returns FALSE. See the "readOnly" property for details. -.SH "bool QTable::isRowHidden ( int row ) const\fC [slot]\fR" -Returns TRUE if row \fIrow\fR is hidden; otherwise returns FALSE. -.PP -See also hideRow() and isColumnHidden(). -.SH "bool QTable::isRowReadOnly ( int row ) const" -Returns TRUE if row \fIrow\fR is read-only; otherwise returns FALSE. -.PP -Whether a cell in this row is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. -.PP -See also setRowReadOnly() and isColumnReadOnly(). -.SH "bool QTable::isRowSelected ( int row, bool full = FALSE ) const" -Returns TRUE if row \fIrow\fR is selected; otherwise returns FALSE. -.PP -If \fIfull\fR is FALSE (the default), 'row is selected' means that at least one cell in the row is selected. If \fIfull\fR is TRUE, then 'row is selected' means every cell in the row is selected. -.PP -See also isColumnSelected() and isSelected(). -.SH "bool QTable::isRowStretchable ( int row ) const\fC [slot]\fR" -Returns TRUE if row \fIrow\fR is stretchable; otherwise returns FALSE. -.PP -See also setRowStretchable() and isColumnStretchable(). -.SH "bool QTable::isSelected ( int row, int col ) const" -Returns TRUE if the cell at \fIrow\fR, \fIcol\fR is selected; otherwise returns FALSE. -.PP -See also isRowSelected() and isColumnSelected(). -.SH "QTableItem * QTable::item ( int row, int col ) const\fC [virtual]\fR" -Returns the QTableItem representing the contents of the cell at \fIrow\fR, \fIcol\fR. -.PP -If \fIrow\fR or \fIcol\fR are out of range or no content has been set for this cell, item() returns 0. -.PP -If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. -.PP -See also setItem(). -.PP -Example: regexptester/regexptester.cpp. -.SH "int QTable::numCols () const\fC [virtual]\fR" -Returns the number of columns in the table. See the "numCols" property for details. -.PP -Reimplemented in QDataTable. -.SH "int QTable::numRows () const\fC [virtual]\fR" -Returns the number of rows in the table. See the "numRows" property for details. -.PP -Reimplemented in QDataTable. -.SH "int QTable::numSelections () const" -Returns the number of selections. See the "numSelections" property for details. -.SH "void QTable::paintCell ( QPainter * p, int row, int col, const QRect & cr, bool selected, const QColorGroup & cg )\fC [virtual]\fR" -Paints the cell at \fIrow\fR, \fIcol\fR on the painter \fIp\fR. The painter has already been translated to the cell's origin. \fIcr\fR describes the cell coordinates in the content coordinate system. -.PP -If \fIselected\fR is TRUE the cell is highlighted. -.PP -\fIcg\fR is the colorgroup which should be used to draw the cell content. -.PP -If you want to draw custom cell content, for example right-aligned text, you must either reimplement paintCell(), or subclass QTableItem and reimplement QTableItem::paint() to do the custom drawing. -.PP -If you're using a QTableItem subclass, for example, to store a data structure, then reimplementing QTableItem::paint() may be the best approach. For data you want to draw immediately, e.g. data retrieved from a database, it is probably best to reimplement paintCell(). Note that if you reimplement paintCell(), i.e. don't use QTableItems, you must reimplement other functions: see the notes on large tables. -.PP -Note that the painter is not clipped by default in order to get maximum efficiency. If you want clipping, use code like this: -.PP -.nf -.br - p->setClipRect( cellRect(row, col), QPainter::CoordPainter ); -.br - //... your drawing code -.br - p->setClipping( FALSE ); -.br -.fi -.SH "void QTable::paintCell ( QPainter * p, int row, int col, const QRect & cr, bool selected )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Use the other paintCell() function. This function is only included for backwards compatibilty. -.SH "void QTable::paintEmptyArea ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" -This function fills the \fIcw\fR pixels wide and \fIch\fR pixels high rectangle starting at position \fIcx\fR, \fIcy\fR with the background color using the painter \fIp\fR. -.PP -paintEmptyArea() is invoked by drawContents() to erase or fill unused areas. -.SH "void QTable::paintFocus ( QPainter * p, const QRect & cr )\fC [virtual]\fR" -Draws the focus rectangle of the current cell (see currentRow(), currentColumn()). -.PP -The painter \fIp\fR is already translated to the cell's origin, while \fIcr\fR specifies the cell's geometry in content coordinates. -.SH "QPixmap QTable::pixmap ( int row, int col ) const\fC [virtual]\fR" -Returns the pixmap set for the cell at \fIrow\fR, \fIcol\fR, or a null-pixmap if the cell contains no pixmap. -.PP -See also setPixmap(). -.PP -Example: chart/setdataform.cpp. -.SH "void QTable::pressed ( int row, int col, int button, const QPoint & mousePos )\fC [signal]\fR" -This signal is emitted when mouse button \fIbutton\fR is pressed. The cell where the event took place is at \fIrow\fR, \fIcol\fR, and the mouse's position is in \fImousePos\fR. -.PP -See also Qt::ButtonState. -.SH "void QTable::removeColumn ( int col )\fC [virtual slot]\fR" -Removes column \fIcol\fR, and deletes all its cells including any table items and widgets the cells may contain. Also clears the selection(s). -.PP -See also removeColumns(), hideColumn(), insertColumns(), and removeRow(). -.SH "void QTable::removeColumns ( const QMemArray & cols )\fC [virtual slot]\fR" -Removes the columns listed in the array \fIcols\fR, and deletes all their cells including any table items and widgets the cells may contain. -.PP -The array passed in must only contain valid columns (in the range from 0 to numCols() - 1) with no duplicates, and must be sorted in ascending order. Also clears the selection(s). -.PP -See also removeColumn(), insertColumns(), and removeRows(). -.SH "void QTable::removeRow ( int row )\fC [virtual slot]\fR" -Removes row \fIrow\fR, and deletes all its cells including any table items and widgets the cells may contain. Also clears the selection(s). -.PP -See also hideRow(), insertRows(), removeColumn(), and removeRows(). -.SH "void QTable::removeRows ( const QMemArray & rows )\fC [virtual slot]\fR" -Removes the rows listed in the array \fIrows\fR, and deletes all their cells including any table items and widgets the cells may contain. -.PP -The array passed in must only contain valid rows (in the range from 0 to numRows() - 1) with no duplicates, and must be sorted in ascending order. Also clears the selection(s). -.PP -See also removeRow(), insertRows(), and removeColumns(). -.SH "void QTable::removeSelection ( const QTableSelection & s )\fC [virtual]\fR" -If the table has a selection, \fIs\fR, this selection is removed from the table. -.PP -See also addSelection() and numSelections. -.SH "void QTable::removeSelection ( int num )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes selection number \fInum\fR from the table. -.PP -See also numSelections, addSelection(), and clearSelection(). -.SH "void QTable::repaintSelections ()" -Repaints all selections -.SH "void QTable::resizeData ( int len )\fC [virtual protected]\fR" -This is called when QTable's internal array needs to be resized to \fIlen\fR elements. -.PP -If you don't use QTableItems you should reimplement this as an empty method to avoid wasting memory. See the notes on large tables for further details. -.SH "int QTable::rowAt ( int y ) const\fC [virtual]\fR" -Returns the number of the row at position \fIy\fR. \fIy\fR must be given in content coordinates. -.PP -See also rowPos() and columnAt(). -.SH "int QTable::rowHeight ( int row ) const\fC [virtual]\fR" -Returns the height of row \fIrow\fR. -.PP -See also setRowHeight() and columnWidth(). -.PP -Example: table/small-table-demo/main.cpp. -.SH "void QTable::rowHeightChanged ( int row )\fC [virtual protected slot]\fR" -This function should be called whenever the row height of \fIrow\fR has been changed. It updates the geometry of any affected rows and repaints the table to reflect the changes it has made. -.SH "void QTable::rowIndexChanged ( int section, int fromIndex, int toIndex )\fC [virtual protected slot]\fR" -This function is called when the order of the rows is to be changed, i.e. the user moved the row header section \fIsection\fR from \fIfromIndex\fR to \fItoIndex\fR. -.PP -If you want to change the order programmatically, call swapRows() or swapColumns(); -.PP -See also QHeader::indexChange() and columnIndexChanged(). -.SH "bool QTable::rowMovingEnabled () const" -Returns TRUE if rows can be moved by the user; otherwise returns FALSE. See the "rowMovingEnabled" property for details. -.SH "int QTable::rowPos ( int row ) const\fC [virtual]\fR" -Returns the y-coordinate of the row \fIrow\fR in content coordinates. -.PP -See also rowAt() and columnPos(). -.SH "void QTable::selectCells ( int start_row, int start_col, int end_row, int end_col )" -Selects the range starting at \fIstart_row\fR and \fIstart_col\fR and ending at \fIend_row\fR and \fIend_col\fR. -.PP -See also QTableSelection. -.SH "void QTable::selectColumn ( int col )" -Selects the column \fIcol\fR. -.PP -See also QTableSelection. -.SH "void QTable::selectRow ( int row )" -Selects the row \fIrow\fR. -.PP -See also QTableSelection. -.SH "QTableSelection QTable::selection ( int num ) const" -Returns selection number \fInum\fR, or an inactive QTableSelection if \fInum\fR is out of range (see QTableSelection::isActive()). -.SH "void QTable::selectionChanged ()\fC [signal]\fR" -This signal is emitted whenever a selection changes. -.PP -See also QTableSelection. -.SH "SelectionMode QTable::selectionMode () const" -Returns the current selection mode. See the "selectionMode" property for details. -.SH "void QTable::setCellContentFromEditor ( int row, int col )\fC [virtual protected]\fR" -This function is called to replace the contents of the cell at \fIrow\fR, \fIcol\fR with the contents of the cell's editor. -.PP -If there already exists a QTableItem for the cell, it calls QTableItem::setContentFromEditor() on this QTableItem. -.PP -If, for example, you want to create different QTableItems depending on the contents of the editor, you might reimplement this function. -.PP -If you want to work without QTableItems, you will need to reimplement this function to save the data the user entered into your data structure. (See the notes on large tables.) -.PP -See also QTableItem::setContentFromEditor() and createEditor(). -.SH "void QTable::setCellWidget ( int row, int col, QWidget * e )\fC [virtual]\fR" -Sets the widget \fIe\fR to the cell at \fIrow\fR, \fIcol\fR and takes care of placing and resizing the widget when the cell geometry changes. -.PP -By default widgets are inserted into a vector with numRows() * numCols() elements. In very large tables you will probably want to store the widgets in a data structure that consumes less memory (see the notes on large tables). To support the use of your own data structure this function calls insertWidget() to add the widget to the internal data structure. To use your own data structure reimplement insertWidget(), cellWidget() and clearCellWidget(). -.PP -Cell widgets are created dynamically with the \fCnew\fR operator. The cell widgets are destroyed automatically once the table is destroyed; the table takes ownership of the widget when using setCellWidget. -.PP -Example: chart/setdataform.cpp. -.SH "void QTable::setColumnLabels ( const QStringList & labels )\fC [slot]\fR" -Sets the section labels of the horizontalHeader() to \fIlabels\fR -.SH "void QTable::setColumnMovingEnabled ( bool b )\fC [virtual slot]\fR" -Sets whether columns can be moved by the user to \fIb\fR. See the "columnMovingEnabled" property for details. -.SH "void QTable::setColumnReadOnly ( int col, bool ro )\fC [virtual slot]\fR" -If \fIro\fR is TRUE, column \fIcol\fR is set to be read-only; otherwise the column is set to be editable. -.PP -Whether a cell in this column is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. -.PP -See also isColumnReadOnly(), setRowReadOnly(), and readOnly. -.PP -Example: chart/setdataform.cpp. -.SH "void QTable::setColumnStretchable ( int col, bool stretch )\fC [virtual slot]\fR" -If \fIstretch\fR is TRUE, column \fIcol\fR is set to be stretchable; otherwise column \fIcol\fR is set to be unstretchable. -.PP -If the table widget's width decreases or increases stretchable columns will grow narrower or wider to fit the space available as completely as possible. The user cannot manually resize stretchable columns. -.PP -See also isColumnStretchable(), setRowStretchable(), and adjustColumn(). -.SH "void QTable::setColumnWidth ( int col, int w )\fC [virtual slot]\fR" -Resizes column \fIcol\fR to be \fIw\fR pixels wide. -.PP -See also columnWidth() and setRowHeight(). -.PP -Example: chart/setdataform.cpp. -.PP -Reimplemented in QDataTable. -.SH "void QTable::setCurrentCell ( int row, int col )\fC [virtual slot]\fR" -Moves the focus to the cell at \fIrow\fR, \fIcol\fR. -.PP -See also currentRow() and currentColumn(). -.SH "void QTable::setDragEnabled ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE, the table starts a drag (see dragObject()) when the user presses and moves the mouse on a selected cell. -.SH "void QTable::setEditMode ( EditMode mode, int row, int col )\fC [protected]\fR" -Sets the current edit mode to \fImode\fR, the current edit row to \fIrow\fR and the current edit column to \fIcol\fR. -.PP -See also EditMode. -.SH "void QTable::setFocusStyle ( FocusStyle fs )\fC [virtual]\fR" -Sets how the current (focus) cell is drawn to \fIfs\fR. See the "focusStyle" property for details. -.SH "void QTable::setItem ( int row, int col, QTableItem * item )\fC [virtual]\fR" -Inserts the table item \fIitem\fR into the table at row \fIrow\fR, column \fIcol\fR, and repaints the cell. If a table item already exists in this cell it is deleted and replaced with \fIitem\fR. The table takes ownership of the table item. -.PP -If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. -.PP -See also item() and takeItem(). -.PP -Examples: -.)l helpsystem/mainwindow.cpp and table/small-table-demo/main.cpp. -.SH "void QTable::setLeftMargin ( int m )\fC [virtual slot]\fR" -Sets the left margin to be \fIm\fR pixels wide. -.PP -The verticalHeader(), which displays row labels, occupies this margin. -.PP -In an Arabic or Hebrew localization, the verticalHeader() will appear on the right side of the table, and this call will set the right margin. -.PP -See also leftMargin(), setTopMargin(), and verticalHeader(). -.PP -Example: regexptester/regexptester.cpp. -.SH "void QTable::setNumCols ( int r )\fC [virtual slot]\fR" -Sets the number of columns in the table to \fIr\fR. See the "numCols" property for details. -.SH "void QTable::setNumRows ( int r )\fC [virtual slot]\fR" -Sets the number of rows in the table to \fIr\fR. See the "numRows" property for details. -.SH "void QTable::setPixmap ( int row, int col, const QPixmap & pix )\fC [virtual]\fR" -Sets the pixmap in the cell at \fIrow\fR, \fIcol\fR to \fIpix\fR. -.PP -If the cell does not contain a table item a QTableItem is created with an EditType of \fCOnTyping\fR, otherwise the existing table item's pixmap (if any) is replaced with \fIpix\fR. -.PP -Note that QComboTableItems and QCheckTableItems don't show pixmaps. -.PP -See also pixmap(), setText(), setItem(), and QTableItem::setPixmap(). -.PP -Examples: -.)l chart/setdataform.cpp and table/small-table-demo/main.cpp. -.SH "void QTable::setReadOnly ( bool b )\fC [virtual slot]\fR" -Sets whether the table is read-only to \fIb\fR. See the "readOnly" property for details. -.SH "void QTable::setRowHeight ( int row, int h )\fC [virtual slot]\fR" -Resizes row \fIrow\fR to be \fIh\fR pixels high. -.PP -See also rowHeight() and setColumnWidth(). -.SH "void QTable::setRowLabels ( const QStringList & labels )\fC [slot]\fR" -Sets the section labels of the verticalHeader() to \fIlabels\fR -.SH "void QTable::setRowMovingEnabled ( bool b )\fC [virtual slot]\fR" -Sets whether rows can be moved by the user to \fIb\fR. See the "rowMovingEnabled" property for details. -.SH "void QTable::setRowReadOnly ( int row, bool ro )\fC [virtual slot]\fR" -If \fIro\fR is TRUE, row \fIrow\fR is set to be read-only; otherwise the row is set to be editable. -.PP -Whether a cell in this row is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. -.PP -See also isRowReadOnly(), setColumnReadOnly(), and readOnly. -.SH "void QTable::setRowStretchable ( int row, bool stretch )\fC [virtual slot]\fR" -If \fIstretch\fR is TRUE, row \fIrow\fR is set to be stretchable; otherwise row \fIrow\fR is set to be unstretchable. -.PP -If the table widget's height decreases or increases stretchable rows will grow shorter or taller to fit the space available as completely as possible. The user cannot manually resize stretchable rows. -.PP -See also isRowStretchable() and setColumnStretchable(). -.SH "void QTable::setSelectionMode ( SelectionMode mode )\fC [virtual]\fR" -Sets the current selection mode to \fImode\fR. See the "selectionMode" property for details. -.SH "void QTable::setShowGrid ( bool b )\fC [virtual slot]\fR" -Sets whether the table's grid is displayed to \fIb\fR. See the "showGrid" property for details. -.SH "void QTable::setSorting ( bool b )\fC [virtual slot]\fR" -Sets whether a click on the header of a column sorts that column to \fIb\fR. See the "sorting" property for details. -.SH "void QTable::setText ( int row, int col, const QString & text )\fC [virtual]\fR" -Sets the text in the cell at \fIrow\fR, \fIcol\fR to \fItext\fR. -.PP -If the cell does not contain a table item a QTableItem is created with an EditType of \fCOnTyping\fR, otherwise the existing table item's text (if any) is replaced with \fItext\fR. -.PP -See also text(), setPixmap(), setItem(), and QTableItem::setText(). -.PP -Examples: -.)l chart/setdataform.cpp, helpsystem/mainwindow.cpp, regexptester/regexptester.cpp, and table/small-table-demo/main.cpp. -.SH "void QTable::setTopMargin ( int m )\fC [virtual slot]\fR" -Sets the top margin to be \fIm\fR pixels high. -.PP -The horizontalHeader(), which displays column labels, occupies this margin. -.PP -See also topMargin() and setLeftMargin(). -.PP -Example: regexptester/regexptester.cpp. -.SH "void QTable::showColumn ( int col )\fC [virtual slot]\fR" -Shows column \fIcol\fR. -.PP -See also hideColumn() and showRow(). -.SH "bool QTable::showGrid () const" -Returns TRUE if the table's grid is displayed; otherwise returns FALSE. See the "showGrid" property for details. -.SH "void QTable::showRow ( int row )\fC [virtual slot]\fR" -Shows row \fIrow\fR. -.PP -See also hideRow() and showColumn(). -.SH "void QTable::sortColumn ( int col, bool ascending = TRUE, bool wholeRows = FALSE )\fC [virtual]\fR" -Sorts column \fIcol\fR. If \fIascending\fR is TRUE the sort is in ascending order, otherwise the sort is in descending order. -.PP -If \fIwholeRows\fR is TRUE, entire rows are sorted using swapRows(); otherwise only cells in the column are sorted using swapCells(). -.PP -Note that if you are not using QTableItems you will need to reimplement swapRows() and swapCells(). (See the notes on large tables.) -.PP -See also swapRows(). -.PP -Example: table/statistics/statistics.cpp. -.PP -Reimplemented in QDataTable. -.SH "bool QTable::sorting () const" -Returns TRUE if a click on the header of a column sorts that column; otherwise returns FALSE. See the "sorting" property for details. -.SH "void QTable::startDrag ()\fC [virtual protected]\fR" -Starts a drag. -.PP -Usually you don't need to call or reimplement this function yourself. -.PP -See also dragObject(). -.SH "void QTable::swapCells ( int row1, int col1, int row2, int col2 )\fC [virtual slot]\fR" -Swaps the contents of the cell at \fIrow1\fR, \fIcol1\fR with the contents of the cell at \fIrow2\fR, \fIcol2\fR. -.PP -This function is also called when the table is sorted. -.PP -If you don't use QTableItems and want your users to be able to swap cells, you will need to reimplement this function. (See the notes on large tables.) -.PP -See also swapColumns() and swapRows(). -.SH "void QTable::swapColumns ( int col1, int col2, bool swapHeader = FALSE )\fC [virtual slot]\fR" -Swaps the data in \fIcol1\fR with \fIcol2\fR. -.PP -This function is used to swap the positions of two columns. It is called when the user changes the order of columns (see setColumnMovingEnabled(), and when columns are sorted. -.PP -If you don't use QTableItems and want your users to be able to swap columns you will need to reimplement this function. (See the notes on large tables.) -.PP -If \fIswapHeader\fR is TRUE, the columns' header contents is also swapped. -.PP -See also swapCells(). -.SH "void QTable::swapRows ( int row1, int row2, bool swapHeader = FALSE )\fC [virtual slot]\fR" -Swaps the data in \fIrow1\fR and \fIrow2\fR. -.PP -This function is used to swap the positions of two rows. It is called when the user changes the order of rows (see setRowMovingEnabled()), and when rows are sorted. -.PP -If you don't use QTableItems and want your users to be able to swap rows, e.g. for sorting, you will need to reimplement this function. (See the notes on large tables.) -.PP -If \fIswapHeader\fR is TRUE, the rows' header contents is also swapped. -.PP -This function will not update the QTable, you will have to do this manually, e.g. by calling updateContents(). -.PP -See also swapColumns() and swapCells(). -.SH "void QTable::takeItem ( QTableItem * i )\fC [virtual]\fR" -Takes the table item \fIi\fR out of the table. This function does \fInot\fR delete the table item. You must either delete the table item yourself or put it into a table (using setItem()) which will then take ownership of it. -.PP -Use this function if you want to move an item from one cell in a table to another, or to move an item from one table to another, reinserting the item with setItem(). -.PP -If you want to exchange two cells use swapCells(). -.SH "QString QTable::text ( int row, int col ) const\fC [virtual]\fR" -Returns the text in the cell at \fIrow\fR, \fIcol\fR, or QString::null if the relevant item does not exist or has no text. -.PP -See also setText() and setPixmap(). -.PP -Example: chart/setdataform.cpp. -.PP -Reimplemented in QDataTable. -.SH "void QTable::updateCell ( int row, int col )" -Repaints the cell at \fIrow\fR, \fIcol\fR. -.SH "void QTable::updateHeaderStates ()" -This functions updates all the header states to be in sync with the current selections. This should be called after programatically changing, adding or removing selections, so that the headers are updated. -.SH "void QTable::valueChanged ( int row, int col )\fC [signal]\fR" -This signal is emitted when the user changed the value in the cell at \fIrow\fR, \fIcol\fR. -.PP -Example: chart/setdataform.cpp. -.SH "QHeader * QTable::verticalHeader () const" -Returns the table's vertical QHeader. -.PP -This header contains the row labels. -.PP -See also horizontalHeader(), setLeftMargin(), and QHeader. -.PP -Examples: -.)l helpsystem/mainwindow.cpp and regexptester/regexptester.cpp. -.SS "Property Documentation" -.SH "bool columnMovingEnabled" -This property holds whether columns can be moved by the user. -.PP -The default is FALSE. Columns are moved by dragging whilst holding down the Ctrl key. -.PP -\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping between header indexes and section exposed by QHeader will not reflect the order of the headers in the table; i.e., QTable does not call QHeader::moveSection() to move sections but handles move operations internally. -.PP -See also rowMovingEnabled. -.PP -Set this property's value with setColumnMovingEnabled() and get this property's value with columnMovingEnabled(). -.SH "FocusStyle focusStyle" -This property holds how the current (focus) cell is drawn. -.PP -The default style is SpreadSheet. -.PP -See also QTable::FocusStyle. -.PP -Set this property's value with setFocusStyle() and get this property's value with focusStyle(). -.SH "int numCols" -This property holds the number of columns in the table. -.PP -Set this property's value with setNumCols() and get this property's value with numCols(). -.PP -See also numRows. -.SH "int numRows" -This property holds the number of rows in the table. -.PP -Set this property's value with setNumRows() and get this property's value with numRows(). -.PP -See also numCols. -.SH "int numSelections" -This property holds the number of selections. -.PP -Get this property's value with numSelections(). -.PP -See also currentSelection(). -.SH "bool readOnly" -This property holds whether the table is read-only. -.PP -Whether a cell in the table is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. -.PP -See also QWidget::enabled, setColumnReadOnly(), and setRowReadOnly(). -.PP -Set this property's value with setReadOnly() and get this property's value with isReadOnly(). -.SH "bool rowMovingEnabled" -This property holds whether rows can be moved by the user. -.PP -The default is FALSE. Rows are moved by dragging whilst holding down the Ctrl key. -.PP -\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping between header indexes and section exposed by QHeader will not reflect the order of the headers in the table; i.e., QTable does not call QHeader::moveSection() to move sections but handles move operations internally. -.PP -See also columnMovingEnabled. -.PP -Set this property's value with setRowMovingEnabled() and get this property's value with rowMovingEnabled(). -.SH "SelectionMode selectionMode" -This property holds the current selection mode. -.PP -The default mode is Multi which allows the user to select multiple ranges of cells. -.PP -See also SelectionMode and selectionMode. -.PP -Set this property's value with setSelectionMode() and get this property's value with selectionMode(). -.SH "bool showGrid" -This property holds whether the table's grid is displayed. -.PP -The grid is shown by default. -.PP -Set this property's value with setShowGrid() and get this property's value with showGrid(). -.SH "bool sorting" -This property holds whether a click on the header of a column sorts that column. -.PP -Set this property's value with setSorting() and get this property's value with sorting(). -.PP -See also sortColumn(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtable.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtable.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtableitem.3qt b/doc/man/man3/qtableitem.3qt deleted file mode 100644 index 397f7403e..000000000 --- a/doc/man/man3/qtableitem.3qt +++ /dev/null @@ -1,466 +0,0 @@ -'\" t -.TH QTableItem 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 -QTableItem \- The cell content for QTable cells -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits Qt. -.PP -Inherited by QComboTableItem and QCheckTableItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBEditType\fR { Never, OnTyping, WhenCurrent, Always }" -.br -.ti -1c -.BI "\fBQTableItem\fR ( QTable * table, EditType et )" -.br -.ti -1c -.BI "\fBQTableItem\fR ( QTable * table, EditType et, const QString & text )" -.br -.ti -1c -.BI "\fBQTableItem\fR ( QTable * table, EditType et, const QString & text, const QPixmap & p )" -.br -.ti -1c -.BI "virtual \fB~QTableItem\fR ()" -.br -.ti -1c -.BI "virtual QPixmap \fBpixmap\fR () const" -.br -.ti -1c -.BI "virtual QString \fBtext\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPixmap\fR ( const QPixmap & p )" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & str )" -.br -.ti -1c -.BI "QTable * \fBtable\fR () const" -.br -.ti -1c -.BI "virtual int \fBalignment\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetWordWrap\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBwordWrap\fR () const" -.br -.ti -1c -.BI "EditType \fBeditType\fR () const" -.br -.ti -1c -.BI "virtual QWidget * \fBcreateEditor\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetContentFromEditor\fR ( QWidget * w )" -.br -.ti -1c -.BI "virtual void \fBsetReplaceable\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisReplaceable\fR () const" -.br -.ti -1c -.BI "virtual QString \fBkey\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSpan\fR ( int rs, int cs )" -.br -.ti -1c -.BI "int \fBrowSpan\fR () const" -.br -.ti -1c -.BI "int \fBcolSpan\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRow\fR ( int r )" -.br -.ti -1c -.BI "virtual void \fBsetCol\fR ( int c )" -.br -.ti -1c -.BI "int \fBrow\fR () const" -.br -.ti -1c -.BI "int \fBcol\fR () const" -.br -.ti -1c -.BI "virtual void \fBpaint\fR ( QPainter * p, const QColorGroup & cg, const QRect & cr, bool selected )" -.br -.ti -1c -.BI "virtual void \fBsetEnabled\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "virtual int \fBrtti\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QTableItem class provides the cell content for QTable cells. -.PP -For many applications QTableItems are ideal for presenting and editing the contents of QTable cells. In situations where you need to create very large tables you may prefer an alternative approach to using QTableItems: see the notes on large tables. -.PP -A QTableItem contains a cell's data, by default, a string and a pixmap. The table item also holds the cell's display size and how the data should be aligned. The table item specifies the cell's EditType and the editor used for in-place editing (by default a QLineEdit). If you want checkboxes use QCheckTableItem, and if you want comboboxes use QComboTableItem. The EditType (set in the constructor) determines whether the cell's contents may be edited. -.PP -If a pixmap is specified it is displayed to the left of any text. You can change the text or pixmap with setText() and setPixmap() respectively. For text you can use setWordWrap(). -.PP -When sorting table items the key() function is used; by default this returns the table item's text(). Reimplement key() to customize how your table items will sort. -.PP -Table items are inserted into a table using QTable::setItem(). If you insert an item into a cell that already contains a table item the original item will be deleted. -.PP -Example: -.PP -.nf -.br - for ( int row = 0; row < table->numRows(); row++ ) { -.br - for ( int col = 0; col < table->numCols(); col++ ) { -.br - table->setItem( row, col, -.br - new QTableItem( table, QTableItem::WhenCurrent, QString::number( row * col ) ) ); -.br - } -.br - } -.br -.fi -.PP -You can move a table item from one cell to another, in the same or a different table, using QTable::takeItem() and QTable::setItem() but see also QTable::swapCells(). -.PP -Table items can be deleted with delete in the standard way; the table and cell will be updated accordingly. -.PP -Note, that if you have a table item that is not currently in a table then anything you do to that item other than insert it into a table will result in undefined behaviour. -.PP -Reimplement createEditor() and setContentFromEditor() if you want to use your own widget instead of a QLineEdit for editing cell contents. Reimplement paint() if you want to display custom content. -.PP -It is important to ensure that your custom widget can accept the keyboard focus, so that the user can use the tab key to navigate the table as normal. Therefore, if the widget returned by createEditor() does not itself accept the keyboard focus, it is necessary to nominate a child widget to do so on its behalf. For example, a QHBox with two child QLineEdit widgets may use one of them to accept the keyboard focus: -.PP -.nf -.br - QWidget* MyTableItem::createEditor() const -.br - { -.br - QHBox* hbox = new QHBox( table()->viewport() ); -.br - hbox->setFocusProxy(new QLineEdit( hbox )); -.br - new QLineEdit( hbox ); -.br - return hbox; -.br - } -.br -.fi -.PP -By default, table items may be replaced by new QTableItems during the lifetime of a QTable. Therefore, if you create your own subclass of QTableItem, and you want to ensure that this does not happen, you must call setReplaceable(FALSE) in the constructor of your subclass. -.PP -
                                                              -.ce 1 -.B "[Image Omitted]" -.PP -
                                                              -.PP -See also QCheckTableItem, QComboTableItem, and Advanced Widgets. -.PP -.SS "Member Type Documentation" -.SH "QTableItem::EditType" -This enum is used to define whether a cell is editable or read-only (in conjunction with other settings), and how the cell should be displayed. -.TP -\fCQTableItem::Always\fR - The cell always \fIlooks\fR editable. -.PP -Using this EditType ensures that the editor created with createEditor() (by default a QLineEdit) is always visible. This has implications for the alignment of the content: the default editor aligns everything (even numbers) to the left whilst numerical values in the cell are by default aligned to the right. -.PP -If a cell with the edit type Always looks misaligned you could reimplement createEditor() for these items. -.TP -\fCQTableItem::WhenCurrent\fR - The cell \fIlooks\fR editable only when it has keyboard focus (see QTable::setCurrentCell()). -.TP -\fCQTableItem::OnTyping\fR - The cell \fIlooks\fR editable only when the user types in it or double-clicks it. It resembles the WhenCurrent functionality but is, perhaps, nicer. -.PP -The OnTyping edit type is the default when QTableItem objects are created by the convenience functions QTable::setText() and QTable::setPixmap(). -.TP -\fCQTableItem::Never\fR - The cell is not editable. -.PP -The cell is actually editable only if QTable::isRowReadOnly() is FALSE for its row, QTable::isColumnReadOnly() is FALSE for its column, and QTable::isReadOnly() is FALSE. -.PP -QComboTableItems have an isEditable() property. This property is used to indicate whether the user may enter their own text or are restricted to choosing one of the choices in the list. QComboTableItems may be interacted with only if they are editable in accordance with their EditType as described above. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTableItem::QTableItem ( QTable * table, EditType et )" -Creates a table item that is a child of table \fItable\fR with no text. The item has the EditType \fIet\fR. -.PP -The table item will use a QLineEdit for its editor, will not word-wrap and will occupy a single cell. Insert the table item into a table with QTable::setItem(). -.PP -The table takes ownership of the table item, so a table item should not be inserted into more than one table at a time. -.SH "QTableItem::QTableItem ( QTable * table, EditType et, const QString & text )" -Creates a table item that is a child of table \fItable\fR with text \fItext\fR. The item has the EditType \fIet\fR. -.PP -The table item will use a QLineEdit for its editor, will not word-wrap and will occupy a single cell. Insert the table item into a table with QTable::setItem(). -.PP -The table takes ownership of the table item, so a table item should not be inserted into more than one table at a time. -.SH "QTableItem::QTableItem ( QTable * table, EditType et, const QString & text, const QPixmap & p )" -Creates a table item that is a child of table \fItable\fR with text \fItext\fR and pixmap \fIp\fR. The item has the EditType \fIet\fR. -.PP -The table item will display the pixmap to the left of the text. It will use a QLineEdit for editing the text, will not word-wrap and will occupy a single cell. Insert the table item into a table with QTable::setItem(). -.PP -The table takes ownership of the table item, so a table item should not be inserted in more than one table at a time. -.SH "QTableItem::~QTableItem ()\fC [virtual]\fR" -The destructor deletes this item and frees all allocated resources. -.PP -If the table item is in a table (i.e. was inserted with setItem()), it will be removed from the table and the cell it occupied. -.SH "int QTableItem::alignment () const\fC [virtual]\fR" -The alignment function returns how the text contents of the cell are aligned when drawn. The default implementation aligns numbers to the right and any other text to the left. -.PP -See also Qt::AlignmentFlags. -.SH "int QTableItem::col () const" -Returns the column where the table item is located. If the cell spans multiple columns, this function returns the left-most column. -.PP -See also row() and setCol(). -.PP -Example: table/bigtable/main.cpp. -.SH "int QTableItem::colSpan () const" -Returns the column span of the table item, usually 1. -.PP -See also setSpan() and rowSpan(). -.SH "QWidget * QTableItem::createEditor () const\fC [virtual]\fR" -This virtual function creates an editor which the user can interact with to edit the cell's contents. The default implementation creates a QLineEdit. -.PP -If the function returns 0, the cell is read-only. -.PP -The returned widget should preferably be invisible, ideally with QTable::viewport() as parent. -.PP -If you reimplement this function you'll almost certainly need to reimplement setContentFromEditor(), and may need to reimplement sizeHint(). -.PP -.nf -.br - QWidget *ComboItem::createEditor() const -.br - { -.br - // create an editor - a combobox in our case -.br - ( (ComboItem*)this )->cb = new QComboBox( table()->viewport() ); -.br - QObject::connect( cb, SIGNAL( activated( int ) ), table(), SLOT( doValueChanged() ) ); -.br - cb->insertItem( "Yes" ); -.br - cb->insertItem( "No" ); -.br - // and initialize it -.br - cb->setCurrentItem( text() == "No" ? 1 : 0 ); -.br - return cb; -.fi -.PP -See also QTable::createEditor(), setContentFromEditor(), QTable::viewport(), and setReplaceable(). -.PP -Example: table/statistics/statistics.cpp. -.SH "EditType QTableItem::editType () const" -Returns the table item's edit type. -.PP -This is set when the table item is constructed. -.PP -See also EditType and QTableItem(). -.SH "bool QTableItem::isEnabled () const" -Returns TRUE if the table item is enabled; otherwise returns FALSE. -.PP -See also setEnabled(). -.SH "bool QTableItem::isReplaceable () const" -This function returns whether the contents of the cell may be replaced with the contents of another table item. Regardless of this setting, table items that span more than one cell may not have their contents replaced by another table item. -.PP -(This differs from EditType because EditType is concerned with whether the \fIuser\fR is able to change the contents of a cell.) -.PP -See also setReplaceable() and EditType. -.SH "QString QTableItem::key () const\fC [virtual]\fR" -This virtual function returns the key that should be used for sorting. The default implementation returns the text() of the relevant item. -.PP -See also QTable::sorting. -.SH "void QTableItem::paint ( QPainter * p, const QColorGroup & cg, const QRect & cr, bool selected )\fC [virtual]\fR" -This virtual function is used to paint the contents of an item using the painter \fIp\fR in the rectangular area \fIcr\fR using the color group \fIcg\fR. -.PP -If \fIselected\fR is TRUE the cell is displayed in a way that indicates that it is highlighted. -.PP -You don't usually need to use this function but if you want to draw custom content in a cell you will need to reimplement it. -.PP -The painter passed to this function is translated so that 0, 0 is the top-left corner of the item that is being painted. -.PP -Note that the painter is not clipped by default in order to get maximum efficiency. If you want clipping, use -.PP -.nf -.br - p->setClipRect( table()->cellRect(row, col), QPainter::ClipPainter ); -.br - //... your drawing code -.br - p->setClipping( FALSE ); -.br -.fi -.PP -Example: table/statistics/statistics.cpp. -.SH "QPixmap QTableItem::pixmap () const\fC [virtual]\fR" -Returns the table item's pixmap or a null pixmap if no pixmap has been set. -.PP -See also setPixmap() and text(). -.SH "int QTableItem::row () const" -Returns the row where the table item is located. If the cell spans multiple rows, this function returns the top-most row. -.PP -See also col() and setRow(). -.PP -Example: table/bigtable/main.cpp. -.SH "int QTableItem::rowSpan () const" -Returns the row span of the table item, usually 1. -.PP -See also setSpan() and colSpan(). -.SH "int QTableItem::rtti () const\fC [virtual]\fR" -Returns the Run Time Type Identification value for this table item which for QTableItems is 0. -.PP -When you create subclasses based on QTableItem make sure that each subclass returns a unique rtti() value. It is advisable to use values greater than 1000, preferably large random numbers, to allow for extensions to this class. -.PP -See also QCheckTableItem::rtti() and QComboTableItem::rtti(). -.PP -Reimplemented in QComboTableItem and QCheckTableItem. -.SH "void QTableItem::setCol ( int c )\fC [virtual]\fR" -Sets column \fIc\fR as the table item's column. Usually you will not need to call this function. -.PP -If the cell spans multiple columns, this function sets the left-most column and retains the width of the multi-cell table item. -.PP -See also col(), setRow(), and colSpan(). -.SH "void QTableItem::setContentFromEditor ( QWidget * w )\fC [virtual]\fR" -Whenever the content of a cell has been edited by the editor \fIw\fR, QTable calls this virtual function to copy the new values into the QTableItem. -.PP -If you reimplement createEditor() and return something that is not a QLineEdit you will need to reimplement this function. -.PP -.nf -.br - void ComboItem::setContentFromEditor( QWidget *w ) -.br - { -.br - // the user changed the value of the combobox, so synchronize the -.br - // value of the item (its text), with the value of the combobox -.br - if ( w->inherits( "QComboBox" ) ) -.br - setText( ( (QComboBox*)w )->currentText() ); -.br - else -.br - QTableItem::setContentFromEditor( w ); -.fi -.PP -See also QTable::setCellContentFromEditor(). -.PP -Example: table/statistics/statistics.cpp. -.SH "void QTableItem::setEnabled ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE, the table item is enabled; if \fIb\fR is FALSE the table item is disabled. -.PP -A disabled item doesn't respond to user interaction. -.PP -See also isEnabled(). -.SH "void QTableItem::setPixmap ( const QPixmap & p )\fC [virtual]\fR" -Sets pixmap \fIp\fR to be this item's pixmap. -.PP -Note that setPixmap() does not update the cell the table item belongs to. Use QTable::updateCell() to repaint the cell's contents. -.PP -For QComboTableItems and QCheckTableItems this function has no visible effect. -.PP -See also QTable::setPixmap(), pixmap(), and setText(). -.SH "void QTableItem::setReplaceable ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE it is acceptable to replace the contents of the cell with the contents of another QTableItem. If \fIb\fR is FALSE the contents of the cell may not be replaced by the contents of another table item. Table items that span more than one cell may not have their contents replaced by another table item. -.PP -(This differs from EditType because EditType is concerned with whether the \fIuser\fR is able to change the contents of a cell.) -.PP -See also isReplaceable(). -.SH "void QTableItem::setRow ( int r )\fC [virtual]\fR" -Sets row \fIr\fR as the table item's row. Usually you do not need to call this function. -.PP -If the cell spans multiple rows, this function sets the top row and retains the height of the multi-cell table item. -.PP -See also row(), setCol(), and rowSpan(). -.SH "void QTableItem::setSpan ( int rs, int cs )\fC [virtual]\fR" -Changes the extent of the QTableItem so that it spans multiple cells covering \fIrs\fR rows and \fIcs\fR columns. The top left cell is the original cell. -.PP -\fBWarning:\fR This function only works if the item has already been inserted into the table using e.g. QTable::setItem(). This function also checks to make sure if \fIrs\fR and \fIcs\fR are within the bounds of the table and returns without changing the span if they are not. In addition swapping, inserting or removing rows and columns that cross QTableItems spanning more than one cell is not supported. -.PP -See also rowSpan() and colSpan(). -.SH "void QTableItem::setText ( const QString & str )\fC [virtual]\fR" -Changes the table item's text to \fIstr\fR. -.PP -Note that setText() does not update the cell the table item belongs to. Use QTable::updateCell() to repaint the cell's contents. -.PP -See also QTable::setText(), text(), setPixmap(), and QTable::updateCell(). -.PP -Example: table/statistics/statistics.cpp. -.SH "void QTableItem::setWordWrap ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE, the cell's text will be wrapped over multiple lines, when necessary, to fit the width of the cell; otherwise the text will be written as a single line. -.PP -See also wordWrap(), QTable::adjustColumn(), and QTable::setColumnStretchable(). -.SH "QSize QTableItem::sizeHint () const\fC [virtual]\fR" -This virtual function returns the size a cell needs to show its entire content. -.PP -If you subclass QTableItem you will often need to reimplement this function. -.SH "QTable * QTableItem::table () const" -Returns the QTable the table item belongs to. -.PP -See also QTable::setItem() and QTableItem(). -.SH "QString QTableItem::text () const\fC [virtual]\fR" -Returns the text of the table item or QString::null if there is no text. -.PP -To ensure that the current value of the editor is returned, setContentFromEditor() is called:
                                                                -.TP -if the editMode() is Always, or -.TP -if editMode() is \fInot\fR Always but the editor of the cell is active and the editor is not a QLineEdit. -.PP -This means that text() returns the original text value of the item if the editor is a line edit, until the user commits an edit (e.g. by pressing Enter or Tab) in which case the new text is returned. For other editors (e.g. a combobox) setContentFromEditor() is always called so the currently display value is the one returned. -.PP -See also setText() and pixmap(). -.SH "bool QTableItem::wordWrap () const" -Returns TRUE if word wrap is enabled for the cell; otherwise returns FALSE. -.PP -See also setWordWrap(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtableitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtableitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtableselection.3qt b/doc/man/man3/qtableselection.3qt deleted file mode 100644 index b9a2cad91..000000000 --- a/doc/man/man3/qtableselection.3qt +++ /dev/null @@ -1,158 +0,0 @@ -'\" t -.TH QTableSelection 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 -QTableSelection \- Access to a selected area in a QTable -.SH SYNOPSIS -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTableSelection\fR ()" -.br -.ti -1c -.BI "\fBQTableSelection\fR ( int start_row, int start_col, int end_row, int end_col )" -.br -.ti -1c -.BI "void \fBinit\fR ( int row, int col )" -.br -.ti -1c -.BI "void \fBexpandTo\fR ( int row, int col )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QTableSelection & s ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QTableSelection & s ) const" -.br -.ti -1c -.BI "int \fBtopRow\fR () const" -.br -.ti -1c -.BI "int \fBbottomRow\fR () const" -.br -.ti -1c -.BI "int \fBleftCol\fR () const" -.br -.ti -1c -.BI "int \fBrightCol\fR () const" -.br -.ti -1c -.BI "int \fBanchorRow\fR () const" -.br -.ti -1c -.BI "int \fBanchorCol\fR () const" -.br -.ti -1c -.BI "int \fBnumRows\fR () const" -.br -.ti -1c -.BI "int \fBnumCols\fR () const" -.br -.ti -1c -.BI "bool \fBisActive\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QTableSelection class provides access to a selected area in a QTable. -.PP -The selection is a rectangular set of cells in a QTable. One of the rectangle's cells is called the anchor cell; this is the cell that was selected first. The init() function sets the anchor and the selection rectangle to exactly this cell; the expandTo() function expands the selection rectangle to include additional cells. -.PP -There are various access functions to find out about the area: anchorRow() and anchorCol() return the anchor's position; leftCol(), rightCol(), topRow() and bottomRow() return the rectangle's four edges. All four are part of the selection. -.PP -A newly created QTableSelection is inactive -- isActive() returns FALSE. You must use init() and expandTo() to activate it. -.PP -See also QTable, QTable::addSelection(), QTable::selection(), QTable::selectCells(), QTable::selectRow(), QTable::selectColumn(), and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTableSelection::QTableSelection ()" -Creates an inactive selection. Use init() and expandTo() to activate it. -.SH "QTableSelection::QTableSelection ( int start_row, int start_col, int end_row, int end_col )" -Creates an active selection, starting at \fIstart_row\fR and \fIstart_col\fR, ending at \fIend_row\fR and \fIend_col\fR. -.SH "int QTableSelection::anchorCol () const" -Returns the anchor column of the selection. -.PP -See also anchorRow() and expandTo(). -.SH "int QTableSelection::anchorRow () const" -Returns the anchor row of the selection. -.PP -See also anchorCol() and expandTo(). -.SH "int QTableSelection::bottomRow () const" -Returns the bottom row of the selection. -.PP -See also topRow(), leftCol(), and rightCol(). -.SH "void QTableSelection::expandTo ( int row, int col )" -Expands the selection to include cell \fIrow\fR, \fIcol\fR. The new selection rectangle is the bounding rectangle of \fIrow\fR, \fIcol\fR and the previous selection rectangle. After calling this function the selection is active. -.PP -If you haven't called init(), this function does nothing. -.PP -See also init() and isActive(). -.SH "void QTableSelection::init ( int row, int col )" -Sets the selection anchor to cell \fIrow\fR, \fIcol\fR and the selection to only contain this cell. The selection is not active until expandTo() is called. -.PP -To extend the selection to include additional cells, call expandTo(). -.PP -See also isActive(). -.SH "bool QTableSelection::isActive () const" -Returns whether the selection is active or not. A selection is active after init() \fIand\fR expandTo() have been called. -.SH "bool QTableSelection::isEmpty () const" -Returns whether the selection is empty or not. -.PP -See also numRows() and numCols(). -.SH "int QTableSelection::leftCol () const" -Returns the left column of the selection. -.PP -See also topRow(), bottomRow(), and rightCol(). -.SH "int QTableSelection::numCols () const" -Returns the number of columns in the selection. -.PP -See also numRows(). -.SH "int QTableSelection::numRows () const" -Returns the number of rows in the selection. -.PP -See also numCols(). -.SH "bool QTableSelection::operator!= ( const QTableSelection & s ) const" -Returns TRUE if \fIs\fR does not include the same cells as the selection; otherwise returns FALSE. -.SH "bool QTableSelection::operator== ( const QTableSelection & s ) const" -Returns TRUE if \fIs\fR includes the same cells as the selection; otherwise returns FALSE. -.SH "int QTableSelection::rightCol () const" -Returns the right column of the selection. -.PP -See also topRow(), bottomRow(), and leftCol(). -.SH "int QTableSelection::topRow () const" -Returns the top row of the selection. -.PP -See also bottomRow(), leftCol(), and rightCol(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtableselection.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtableselection.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtabletevent.3qt b/doc/man/man3/qtabletevent.3qt deleted file mode 100644 index e73757878..000000000 --- a/doc/man/man3/qtabletevent.3qt +++ /dev/null @@ -1,192 +0,0 @@ -'\" t -.TH QTabletEvent 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 -QTabletEvent \- Parameters that describe a Tablet event -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBTabletDevice\fR { NoDevice = -1, Puck, Stylus, Eraser }" -.br -.ti -1c -.BI "\fBQTabletEvent\fR ( Type t, const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair & uId )" -.br -.ti -1c -.BI "QTabletEvent ( const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair & uId ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBpressure\fR () const" -.br -.ti -1c -.BI "int \fBxTilt\fR () const" -.br -.ti -1c -.BI "int \fByTilt\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBpos\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBglobalPos\fR () const" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "int \fBglobalX\fR () const" -.br -.ti -1c -.BI "int \fBglobalY\fR () const" -.br -.ti -1c -.BI "TabletDevice \fBdevice\fR () const" -.br -.ti -1c -.BI "int \fBisAccepted\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.ti -1c -.BI "QPair \fBuniqueId\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QTabletEvent class contains parameters that describe a Tablet event. -.PP -Tablet Events are generated from a Wacom© tablet. Most of the time you will want to deal with events from the tablet as if they were events from a mouse, for example retrieving the position with x(), y(), pos(), globalX(), globalY() and globalPos(). In some situations you may wish to retrieve the extra information provided by the tablet device driver, for example, you might want to adjust color brightness based on pressure. QTabletEvent allows you to get the pressure(), the xTilt() and yTilt(), as well as the type of device being used with device() (see TabletDevice). -.PP -A tablet event contains a special accept flag that indicates whether the receiver wants the event. You should call QTabletEvent::accept() if you handle the tablet event; otherwise it will be sent to the parent widget. -.PP -The QWidget::setEnabled() function can be used to enable or disable mouse and keyboard events for a widget. -.PP -The event handler QWidget::tabletEvent() receives all three types of tablet events. Qt will first send a tabletEvent and then, if it is not accepted, it will send a mouse event. This allows applications that don't utilize tablets to use a tablet like a mouse while also enabling those who want to use both tablets and mouses differently. -.PP -See also Event Classes. -.SS "Member Type Documentation" -.SH "QTabletEvent::TabletDevice" -This enum defines what type of device is generating the event. -.TP -\fCQTabletEvent::NoDevice\fR - No device, or an unknown device. -.TP -\fCQTabletEvent::Puck\fR - A Puck (a device that is similar to a flat mouse with a transparent circle with cross-hairs). -.TP -\fCQTabletEvent::Stylus\fR - A Stylus (the narrow end of the pen). -.TP -\fCQTabletEvent::Eraser\fR - An Eraser (the broad end of the pen). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTabletEvent::QTabletEvent ( Type t, const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair & uId )" -Construct a tablet event of type \fIt\fR. The position of when the event occurred is given int \fIpos\fR and \fIglobalPos\fR. \fIdevice\fR contains the device type, \fIpressure\fR contains the pressure exerted on the \fIdevice\fR, \fIxTilt\fR and \fIyTilt\fR contain \fIdevice\fR's degree of tilt from the X and Y axis respectively. The \fIuId\fR contains an event id. -.PP -On Irix, \fIglobalPos\fR will contain the high-resolution coordinates received from the tablet device driver, instead of from the windowing system. -.PP -See also pos(), globalPos(), device(), pressure(), xTilt(), and yTilt(). -.SH "QTabletEvent::QTabletEvent ( const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair & uId )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Constructs a tablet event object. The position when the event occurred is is given in \fIpos\fR and \fIglobalPos\fR. \fIdevice\fR contains the device type, \fIpressure\fR contains the pressure exerted on the \fIdevice\fR, \fIxTilt\fR and \fIyTilt\fR contain the \fIdevice\fR's degrees of tilt from the X and Y axis respectively. The \fIuId\fR contains an event id. -.PP -On Irix, \fIglobalPos\fR will contain the high-resolution coordinates received from the tablet device driver, instead of from the windowing system. -.PP -See also pos(), globalPos(), device(), pressure(), xTilt(), and yTilt(). -.SH "void QTabletEvent::accept ()" -Sets the accept flag of the tablet event object. -.PP -Setting the accept flag indicates that the receiver of the event wants the tablet event. Unwanted tablet events are sent to the parent widget. -.PP -The accept flag is set by default. -.PP -See also ignore(). -.SH "TabletDevice QTabletEvent::device () const" -Returns the type of device that generated the event. Useful if you want one end of the pen to do something different than the other. -.PP -See also TabletDevice. -.SH "const QPoint & QTabletEvent::globalPos () const" -Returns the global position of the device \fIat the time of the event\fR. This is important on asynchronous windows systems like X11; whenever you move your widgets around in response to mouse events, globalPos() can differ significantly from the current position QCursor::pos(). -.PP -See also globalX() and globalY(). -.SH "int QTabletEvent::globalX () const" -Returns the global x-position of the mouse pointer at the time of the event. -.PP -See also globalY() and globalPos(). -.SH "int QTabletEvent::globalY () const" -Returns the global y-position of the mouse pointer at the time of the event. -.PP -See also globalX() and globalPos(). -.SH "void QTabletEvent::ignore ()" -Clears the accept flag parameter of the tablet event object. -.PP -Clearing the accept flag indicates that the event receiver does not want the tablet event. Unwanted tablet events are sent to the parent widget. -.PP -The accept flag is set by default. -.PP -See also accept(). -.SH "int QTabletEvent::isAccepted () const" -Returns TRUE if the receiver of the event handles the tablet event; otherwise returns FALSE. -.SH "const QPoint & QTabletEvent::pos () const" -Returns the position of the device, relative to the widget that received the event. -.PP -If you move widgets around in response to mouse events, use globalPos() instead of this function. -.PP -See also x(), y(), and globalPos(). -.SH "int QTabletEvent::pressure () const" -Returns the pressure that is exerted on the device. This number is a value from 0 (no pressure) to 255 (maximum pressure). The pressure is always scaled to be within this range no matter how many pressure levels the underlying hardware supports. -.SH "QPair QTabletEvent::uniqueId ()" -Returns a unique ID for the current device. It is possible to generate a unique ID for any Wacom© device. This makes it possible to differentiate between multiple devices being used at the same time on the tablet. The \fCfirst\fR member contains a value for the type, the \fCsecond\fR member contains a physical ID obtained from the device. Each combination of these values is unique. Note: for different platforms, the \fCfirst\fR value is different due to different driver implementations. -.SH "int QTabletEvent::x () const" -Returns the x-position of the device, relative to the widget that received the event. -.PP -See also y() and pos(). -.SH "int QTabletEvent::xTilt () const" -Returns the difference from the perpendicular in the X Axis. Positive values are towards the tablet's physical right. The angle is in the range -60 to +60 degrees. -.PP -See also yTilt(). -.SH "int QTabletEvent::y () const" -Returns the y-position of the device, relative to the widget that received the event. -.PP -See also x() and pos(). -.SH "int QTabletEvent::yTilt () const" -Returns the difference from the perpendicular in the Y Axis. Positive values are towards the bottom of the tablet. The angle is within the range -60 to +60 degrees. -.PP -See also xTilt(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtabletevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtabletevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtabwidget.3qt b/doc/man/man3/qtabwidget.3qt deleted file mode 100644 index c937ac649..000000000 --- a/doc/man/man3/qtabwidget.3qt +++ /dev/null @@ -1,424 +0,0 @@ -'\" t -.TH QTabWidget 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 -QTabWidget \- Stack of tabbed widgets -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTabWidget\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "virtual void \fBaddTab\fR ( QWidget * child, const QString & label )" -.br -.ti -1c -.BI "virtual void \fBaddTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label )" -.br -.ti -1c -.BI "virtual void \fBaddTab\fR ( QWidget * child, QTab * tab )" -.br -.ti -1c -.BI "virtual void \fBinsertTab\fR ( QWidget * child, const QString & label, int index = -1 )" -.br -.ti -1c -.BI "virtual void \fBinsertTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )" -.br -.ti -1c -.BI "virtual void \fBinsertTab\fR ( QWidget * child, QTab * tab, int index = -1 )" -.br -.ti -1c -.BI "void \fBchangeTab\fR ( QWidget * w, const QString & label )" -.br -.ti -1c -.BI "void \fBchangeTab\fR ( QWidget * w, const QIconSet & iconset, const QString & label )" -.br -.ti -1c -.BI "bool \fBisTabEnabled\fR ( QWidget * w ) const" -.br -.ti -1c -.BI "void \fBsetTabEnabled\fR ( QWidget * w, bool enable )" -.br -.ti -1c -.BI "void \fBsetCornerWidget\fR ( QWidget * w, Qt::Corner corner = Qt::TopRight )" -.br -.ti -1c -.BI "QWidget * \fBcornerWidget\fR ( Qt::Corner corner = Qt::TopRight ) const" -.br -.ti -1c -.BI "QString \fBtabLabel\fR ( QWidget * w ) const" -.br -.ti -1c -.BI "void \fBsetTabLabel\fR ( QWidget * w, const QString & l )" -.br -.ti -1c -.BI "QIconSet \fBtabIconSet\fR ( QWidget * w ) const" -.br -.ti -1c -.BI "void \fBsetTabIconSet\fR ( QWidget * w, const QIconSet & iconset )" -.br -.ti -1c -.BI "void \fBremoveTabToolTip\fR ( QWidget * w )" -.br -.ti -1c -.BI "void \fBsetTabToolTip\fR ( QWidget * w, const QString & tip )" -.br -.ti -1c -.BI "QString \fBtabToolTip\fR ( QWidget * w ) const" -.br -.ti -1c -.BI "QWidget * \fBcurrentPage\fR () const" -.br -.ti -1c -.BI "QWidget * \fBpage\fR ( int index ) const" -.br -.ti -1c -.BI "QString \fBlabel\fR ( int index ) const" -.br -.ti -1c -.BI "int \fBcurrentPageIndex\fR () const" -.br -.ti -1c -.BI "int \fBindexOf\fR ( QWidget * w ) const" -.br -.ti -1c -.BI "enum \fBTabPosition\fR { Top, Bottom }" -.br -.ti -1c -.BI "TabPosition \fBtabPosition\fR () const" -.br -.ti -1c -.BI "void \fBsetTabPosition\fR ( TabPosition )" -.br -.ti -1c -.BI "enum \fBTabShape\fR { Rounded, Triangular }" -.br -.ti -1c -.BI "TabShape \fBtabShape\fR () const" -.br -.ti -1c -.BI "void \fBsetTabShape\fR ( TabShape s )" -.br -.ti -1c -.BI "int \fBmargin\fR () const" -.br -.ti -1c -.BI "void \fBsetMargin\fR ( int )" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBsetCurrentPage\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBshowPage\fR ( QWidget * w )" -.br -.ti -1c -.BI "virtual void \fBremovePage\fR ( QWidget * w )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBcurrentChanged\fR ( QWidget * )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoMask\fR - whether the tab widget is automatically masked \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcount\fR - the number of tabs in the tab bar \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcurrentPage\fR - the index position of the current tab page" -.br -.ti -1c -.BI "int \fBmargin\fR - the margin in this tab widget" -.br -.ti -1c -.BI "TabPosition \fBtabPosition\fR - the position of the tabs in this tab widget" -.br -.ti -1c -.BI "TabShape \fBtabShape\fR - the shape of the tabs in this tab widget" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsetTabBar\fR ( QTabBar * tb )" -.br -.ti -1c -.BI "QTabBar * \fBtabBar\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QTabWidget class provides a stack of tabbed widgets. -.PP -A tab widget provides a tab bar of tabs and a `page area' below (or above, see TabPosition) the tabs. Each tab is associated with a different widget (called a `page'). Only the current tab's page is shown in the page area; all the other tabs' pages are hidden. The user can show a different page by clicking on its tab or by pressing its Alt+\fIletter\fR accelerator if it has one. -.PP -The normal way to use QTabWidget is to do the following in the constructor:
                                                                  -.IP 1 -Create a QTabWidget. -.IP 2 -Create a QWidget for each of the pages in the tab dialog, insert children into it, set up geometry management for it and use addTab() (or insertTab()) to set up a tab and keyboard accelerator for it. -.IP 3 -Connect to the signals and slots. -.PP -The position of the tabs is set with setTabPosition(), their shape with setTabShape(), and their margin with setMargin(). -.PP -If you don't call addTab() and the QTabWidget is already visible, then the page you have created will not be visible. Don't confuse the object name you supply to the QWidget constructor and the tab label you supply to addTab(). addTab() takes a name which indicates an accelerator and is meaningful and descriptive to the user, whereas the widget name is used primarily for debugging. -.PP -The signal currentChanged() is emitted when the user selects a page. -.PP -The current page is available as an index position with currentPageIndex() or as a wiget pointer with currentPage(). You can retrieve a pointer to a page with a given index using page(), and can find the index position of a page with indexOf(). Use setCurrentPage() to show a particular page by index, or showPage() to show a page by widget pointer. -.PP -You can change a tab's label and iconset using changeTab() or setTabLabel() and setTabIconSet(). A tab page can be removed with removePage(). -.PP -Each tab is either enabled or disabled at any given time (see setTabEnabled()). If a tab is enabled, the tab text is drawn normally and the user can select that tab. If it is disabled, the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible, for example if all of the tabs happen to be disabled. -.PP -Although tab widgets can be a very good way to split up a complex dialog, it's also very easy to get into a mess. See QTabDialog for some design hints. An alternative is to use a QWidgetStack for which you provide some means of navigating between pages, for example, a QToolBar or a QListBox. -.PP -Most of the functionality in QTabWidget is provided by a QTabBar (at the top, providing the tabs) and a QWidgetStack (most of the area, organizing the individual pages). -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also QTabDialog, QToolBox, Advanced Widgets, and Organizers. -.SS "Member Type Documentation" -.SH "QTabWidget::TabPosition" -This enum type defines where QTabWidget draws the tab row: -.TP -\fCQTabWidget::Top\fR - above the pages -.TP -\fCQTabWidget::Bottom\fR - below the pages -.SH "QTabWidget::TabShape" -This enum type defines the shape of the tabs: -.TP -\fCQTabWidget::Rounded\fR - rounded look (normal) -.TP -\fCQTabWidget::Triangular\fR - triangular look (very unusual, included for completeness) -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTabWidget::QTabWidget ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a tabbed widget called \fIname\fR with parent \fIparent\fR, and widget flags \fIf\fR. -.SH "void QTabWidget::addTab ( QWidget * child, const QString & label )\fC [virtual]\fR" -Adds another tab and page to the tab view. -.PP -The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. -.PP -If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. -.PP -If you call addTab() after show() the screen will flicker and the user may be confused. -.PP -Adding the same child twice will have undefined behavior. -.PP -See also insertTab(). -.PP -Examples: -.)l addressbook/centralwidget.cpp and themes/themes.cpp. -.SH "void QTabWidget::addTab ( QWidget * child, const QIconSet & iconset, const QString & label )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds another tab and page to the tab view. -.PP -This function is the same as addTab(), but with an additional \fIiconset\fR. -.SH "void QTabWidget::addTab ( QWidget * child, QTab * tab )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is a low-level function for adding tabs. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. The \fIchild\fR is the new page and \fItab\fR is the tab to put the \fIchild\fR on. -.SH "void QTabWidget::changeTab ( QWidget * w, const QString & label )" -Defines a new \fIlabel\fR for page \fIw\fR's tab. -.SH "void QTabWidget::changeTab ( QWidget * w, const QIconSet & iconset, const QString & label )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Defines a new \fIiconset\fR and a new \fIlabel\fR for page \fIw\fR's tab. -.SH "QWidget * QTabWidget::cornerWidget ( Qt::Corner corner = Qt::TopRight ) const" -Returns the widget shown in the \fIcorner\fR of the tab widget or 0. -.SH "int QTabWidget::count () const" -Returns the number of tabs in the tab bar. See the "count" property for details. -.SH "void QTabWidget::currentChanged ( QWidget * )\fC [signal]\fR" -This signal is emitted whenever the current page changes. The parameter is the new current page. -.PP -See also currentPage(), showPage(), and tabLabel(). -.SH "QWidget * QTabWidget::currentPage () const" -Returns a pointer to the page currently being displayed by the tab dialog. The tab dialog does its best to make sure that this value is never 0 (but if you try hard enough, it can be). -.SH "int QTabWidget::currentPageIndex () const" -Returns the index position of the current tab page. See the "currentPage" property for details. -.SH "int QTabWidget::indexOf ( QWidget * w ) const" -Returns the index position of page \fIw\fR, or -1 if the widget cannot be found. -.SH "void QTabWidget::insertTab ( QWidget * child, const QString & label, int index = -1 )\fC [virtual]\fR" -Inserts another tab and page to the tab view. -.PP -The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. -.PP -If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. -.PP -If \fIindex\fR is not specified, the tab is simply appended. Otherwise it is inserted at the specified position. -.PP -If you call insertTab() after show(), the screen will flicker and the user may be confused. -.PP -See also addTab(). -.SH "void QTabWidget::insertTab ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts another tab and page to the tab view. -.PP -This function is the same as insertTab(), but with an additional \fIiconset\fR. -.SH "void QTabWidget::insertTab ( QWidget * child, QTab * tab, int index = -1 )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This is a lower-level method for inserting tabs, similar to the other insertTab() method. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. The \fIchild\fR is the new page, \fItab\fR is the tab to put the \fIchild\fR on and \fIindex\fR is the position in the tab bar that this page should occupy. -.SH "bool QTabWidget::isTabEnabled ( QWidget * w ) const" -Returns TRUE if the page \fIw\fR is enabled; otherwise returns FALSE. -.PP -See also setTabEnabled() and QWidget::enabled. -.SH "QString QTabWidget::label ( int index ) const" -Returns the label of the tab at index position \fIindex\fR or QString::null if the \fIindex\fR is out of range. -.SH "int QTabWidget::margin () const" -Returns the margin in this tab widget. See the "margin" property for details. -.SH "QWidget * QTabWidget::page ( int index ) const" -Returns the tab page at index position \fIindex\fR or 0 if the \fIindex\fR is out of range. -.SH "void QTabWidget::removePage ( QWidget * w )\fC [virtual slot]\fR" -Removes page \fIw\fR from this stack of widgets. Does not delete \fIw\fR. -.PP -See also addTab(), showPage(), and QWidgetStack::removeWidget(). -.SH "void QTabWidget::removeTabToolTip ( QWidget * w )" -Removes the tab tool tip for page \fIw\fR. If the page does not have a tip, nothing happens. -.PP -See also setTabToolTip() and tabToolTip(). -.SH "void QTabWidget::setCornerWidget ( QWidget * w, Qt::Corner corner = Qt::TopRight )" -Sets widget \fIw\fR to be the shown in the specified \fIcorner\fR of the tab widget. -.PP -Only the horizontal element of the \fIcorner\fR will be used. -.PP -See also cornerWidget() and tabPosition. -.SH "void QTabWidget::setCurrentPage ( int )\fC [slot]\fR" -Sets the index position of the current tab page. See the "currentPage" property for details. -.SH "void QTabWidget::setMargin ( int )" -Sets the margin in this tab widget. See the "margin" property for details. -.SH "void QTabWidget::setTabBar ( QTabBar * tb )\fC [protected]\fR" -Replaces the dialog's QTabBar heading with the tab bar \fItb\fR. Note that this must be called \fIbefore\fR any tabs have been added, or the behavior is undefined. -.PP -See also tabBar(). -.SH "void QTabWidget::setTabEnabled ( QWidget * w, bool enable )" -If \fIenable\fR is TRUE, page \fIw\fR is enabled; otherwise page \fIw\fR is disabled. The page's tab is redrawn appropriately. -.PP -QTabWidget uses QWidget::setEnabled() internally, rather than keeping a separate flag. -.PP -Note that even a disabled tab/page may be visible. If the page is visible already, QTabWidget will not hide it; if all the pages are disabled, QTabWidget will show one of them. -.PP -See also isTabEnabled() and QWidget::enabled. -.SH "void QTabWidget::setTabIconSet ( QWidget * w, const QIconSet & iconset )" -Sets the iconset for page \fIw\fR to \fIiconset\fR. -.SH "void QTabWidget::setTabLabel ( QWidget * w, const QString & l )" -Sets the tab label for page \fIw\fR to \fIl\fR -.SH "void QTabWidget::setTabPosition ( TabPosition )" -Sets the position of the tabs in this tab widget. See the "tabPosition" property for details. -.SH "void QTabWidget::setTabShape ( TabShape s )" -Sets the shape of the tabs in this tab widget to \fIs\fR. See the "tabShape" property for details. -.SH "void QTabWidget::setTabToolTip ( QWidget * w, const QString & tip )" -Sets the tab tool tip for page \fIw\fR to \fItip\fR. -.PP -See also removeTabToolTip() and tabToolTip(). -.SH "void QTabWidget::showPage ( QWidget * w )\fC [virtual slot]\fR" -Ensures that page \fIw\fR is shown. This is useful mainly for accelerators. -.PP -\fBWarning:\fR Used carelessly, this function can easily surprise or confuse the user. -.PP -See also QTabBar::currentTab. -.SH "QTabBar * QTabWidget::tabBar () const\fC [protected]\fR" -Returns the current QTabBar. -.PP -See also setTabBar(). -.SH "QIconSet QTabWidget::tabIconSet ( QWidget * w ) const" -Returns the iconset of page \fIw\fR or a null iconset if \fIw\fR is not a tab page or does not have an iconset. -.SH "QString QTabWidget::tabLabel ( QWidget * w ) const" -Returns the label text for the tab on page \fIw\fR. -.SH "TabPosition QTabWidget::tabPosition () const" -Returns the position of the tabs in this tab widget. See the "tabPosition" property for details. -.SH "TabShape QTabWidget::tabShape () const" -Returns the shape of the tabs in this tab widget. See the "tabShape" property for details. -.SH "QString QTabWidget::tabToolTip ( QWidget * w ) const" -Returns the tab tool tip for page \fIw\fR or QString::null if no tool tip has been set. -.PP -See also setTabToolTip() and removeTabToolTip(). -.SS "Property Documentation" -.SH "bool autoMask" -This property holds whether the tab widget is automatically masked. -.PP -See also QWidget::autoMask. -.SH "int count" -This property holds the number of tabs in the tab bar. -.PP -Get this property's value with count(). -.SH "int currentPage" -This property holds the index position of the current tab page. -.PP -Set this property's value with setCurrentPage() and get this property's value with currentPageIndex(). -.PP -See also QTabBar::currentTab. -.SH "int margin" -This property holds the margin in this tab widget. -.PP -The margin is the distance between the innermost pixel of the frame and the outermost pixel of the pages. -.PP -Set this property's value with setMargin() and get this property's value with margin(). -.SH "TabPosition tabPosition" -This property holds the position of the tabs in this tab widget. -.PP -Possible values for this property are QTabWidget::Top and QTabWidget::Bottom. -.PP -See also TabPosition. -.PP -Set this property's value with setTabPosition() and get this property's value with tabPosition(). -.SH "TabShape tabShape" -This property holds the shape of the tabs in this tab widget. -.PP -Possible values for this property are QTabWidget::Rounded (default) or QTabWidget::Triangular. -.PP -See also TabShape. -.PP -Set this property's value with setTabShape() and get this property's value with tabShape(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtabwidget.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtabwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextbrowser.3qt b/doc/man/man3/qtextbrowser.3qt deleted file mode 100644 index e5eef241b..000000000 --- a/doc/man/man3/qtextbrowser.3qt +++ /dev/null @@ -1,231 +0,0 @@ -'\" t -.TH QTextBrowser 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 -QTextBrowser \- Rich text browser with hypertext navigation -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QTextEdit. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTextBrowser\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "QString \fBsource\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetSource\fR ( const QString & name )" -.br -.ti -1c -.BI "virtual void \fBbackward\fR ()" -.br -.ti -1c -.BI "virtual void \fBforward\fR ()" -.br -.ti -1c -.BI "virtual void \fBhome\fR ()" -.br -.ti -1c -.BI "virtual void \fBreload\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBbackwardAvailable\fR ( bool available )" -.br -.ti -1c -.BI "void \fBforwardAvailable\fR ( bool available )" -.br -.ti -1c -.BI "void \fBsourceChanged\fR ( const QString & src )" -.br -.ti -1c -.BI "void \fBhighlighted\fR ( const QString & link )" -.br -.ti -1c -.BI "void \fBlinkClicked\fR ( const QString & link )" -.br -.ti -1c -.BI "void \fBanchorClicked\fR ( const QString & name, const QString & link )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBmodified\fR - whether the contents have been modified \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBoverwriteMode\fR - this text browser's overwrite mode \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBreadOnly\fR - whether the contents are read only \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QString \fBsource\fR - the name of the displayed document" -.br -.ti -1c -.BI "int \fBundoDepth\fR - this text browser's undo depth \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBundoRedoEnabled\fR - whether undo and redo are enabled \fI(read " "only" ")\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" -.br -.in -1c -.SH DESCRIPTION -The QTextBrowser class provides a rich text browser with hypertext navigation. -.PP -This class extends QTextEdit (in read-only mode), adding some navigation functionality so that users can follow links in hypertext documents. The contents of QTextEdit is set with setText(), but QTextBrowser has an additional function, setSource(), which makes it possible to set the text to a named document. The name is looked up in the text view's mime source factory. If a document name ends with an anchor (for example, "\fC#anchor"\fR), the text browser automatically scrolls to that position (using scrollToAnchor()). When the user clicks on a hyperlink, the browser will call setSource() itself, with the link's \fChref\fR value as argument. You can track the current source by connetion to the sourceChanged() signal. -.PP -QTextBrowser provides backward() and forward() slots which you can use to implement Back and Forward buttons. The home() slot sets the text to the very first document displayed. The linkClicked() signal is emitted when the user clicks a link. -.PP -By using QTextEdit::setMimeSourceFactory() you can provide your own subclass of QMimeSourceFactory. This makes it possible to access data from anywhere, for example from a network or from a database. See QMimeSourceFactory::data() for details. -.PP -If you intend using the mime factory to read the data directly from the file system, you may have to specify the encoding for the file extension you are using. For example: -.PP -.nf -.br - mimeSourceFactory()->setExtensionType("qml", "text/utf8"); -.br -.fi -This is to ensure that the factory is able to resolve the document names. -.PP -QTextBrowser interprets the tags it processes in accordance with the default style sheet. Change the style sheet with setStyleSheet(); see QStyleSheet for details. -.PP -If you want to provide your users with editable rich text use QTextEdit. If you want a text browser without hypertext navigation use QTextEdit, and use QTextEdit::setReadOnly() to disable editing. If you just need to display a small piece of rich text use QSimpleRichText or QLabel. -.PP -.ce 1 -.B "[Image Omitted]" -.PP - -.ce 1 -.B "[Image Omitted]" -.PP -See also Advanced Widgets, Help System, and Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextBrowser::QTextBrowser ( QWidget * parent = 0, const char * name = 0 )" -Constructs an empty QTextBrowser called \fIname\fR, with parent \fIparent\fR. -.SH "void QTextBrowser::anchorClicked ( const QString & name, const QString & link )\fC [signal]\fR" -This signal is emitted when the user clicks an anchor. The \fIlink\fR is the value of the \fChref\fR i.e. the name of the target document. The \fIname\fR is the name of the anchor. -.PP -See also linkClicked(). -.SH "void QTextBrowser::backward ()\fC [virtual slot]\fR" -Changes the document displayed to the previous document in the list of documents built by navigating links. Does nothing if there is no previous document. -.PP -See also forward() and backwardAvailable(). -.PP -Example: helpviewer/helpwindow.cpp. -.SH "void QTextBrowser::backwardAvailable ( bool available )\fC [signal]\fR" -This signal is emitted when the availability of backward() changes. \fIavailable\fR is FALSE when the user is at home(); otherwise it is TRUE. -.PP -Example: helpviewer/helpwindow.cpp. -.SH "void QTextBrowser::forward ()\fC [virtual slot]\fR" -Changes the document displayed to the next document in the list of documents built by navigating links. Does nothing if there is no next document. -.PP -See also backward() and forwardAvailable(). -.PP -Example: helpviewer/helpwindow.cpp. -.SH "void QTextBrowser::forwardAvailable ( bool available )\fC [signal]\fR" -This signal is emitted when the availability of forward() changes. \fIavailable\fR is TRUE after the user navigates backward() and FALSE when the user navigates or goes forward(). -.PP -Example: helpviewer/helpwindow.cpp. -.SH "void QTextBrowser::highlighted ( const QString & link )\fC [signal]\fR" -This signal is emitted when the user has selected but not activated a link in the document. \fIlink\fR is the value of the \fChref\fR i.e. the name of the target document. -.PP -Example: helpviewer/helpwindow.cpp. -.SH "void QTextBrowser::home ()\fC [virtual slot]\fR" -Changes the document displayed to be the first document the browser displayed. -.PP -Example: helpviewer/helpwindow.cpp. -.SH "void QTextBrowser::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" -The event \fIe\fR is used to provide the following keyboard shortcuts:
                                                                  .nf -.TS -l - l. Keypress Action Alt+Left Arrow backward() Alt+Right Arrow forward() Alt+Up Arrow -.TE -.fi -
                                                                  -.PP -Reimplemented from QTextEdit. -.SH "void QTextBrowser::linkClicked ( const QString & link )\fC [signal]\fR" -This signal is emitted when the user clicks a link. The \fIlink\fR is the value of the \fChref\fR i.e. the name of the target document. -.PP -The \fIlink\fR will be the absolute location of the document, based on the value of the anchor's href tag and the current context of the document. -.PP -See also anchorClicked() and context(). -.SH "void QTextBrowser::reload ()\fC [virtual slot]\fR" -Reloads the current set source. -.SH "void QTextBrowser::setSource ( const QString & name )\fC [virtual slot]\fR" -Sets the name of the displayed document to \fIname\fR. See the "source" property for details. -.SH "QString QTextBrowser::source () const" -Returns the name of the displayed document. See the "source" property for details. -.SH "void QTextBrowser::sourceChanged ( const QString & src )\fC [signal]\fR" -This signal is emitted when the mime source has changed, \fIsrc\fR being the new source. -.PP -Source changes happen both programmatically when calling setSource(), forward(), backword() or home() or when the user clicks on links or presses the equivalent key sequences. -.PP -Example: helpviewer/helpwindow.cpp. -.SS "Property Documentation" -.SH "bool modified" -This property holds whether the contents have been modified. -.SH "bool overwriteMode" -This property holds this text browser's overwrite mode. -.SH "bool readOnly" -This property holds whether the contents are read only. -.SH "QString source" -This property holds the name of the displayed document. -.PP -This is a QString::null if no document is displayed or if the source is unknown. -.PP -Setting this property uses the mimeSourceFactory() to lookup the named document. It also checks for optional anchors and scrolls the document accordingly. -.PP -If the first tag in the document is \fC\fR, the document is displayed as a popup rather than as new document in the browser window itself. Otherwise, the document is displayed normally in the text browser with the text set to the contents of the named document with setText(). -.PP -If you are using the filesystem access capabilities of the mime source factory, you must ensure that the factory knows about the encoding of specified files; otherwise no data will be available. The default factory handles a couple of common file extensions such as \fC*.html\fR and \fC*.txt\fR with reasonable defaults. See QMimeSourceFactory::data() for details. -.PP -Set this property's value with setSource() and get this property's value with source(). -.SH "int undoDepth" -This property holds this text browser's undo depth. -.SH "bool undoRedoEnabled" -This property holds whether undo and redo are enabled. -.PP - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtextbrowser.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextbrowser.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextcodec.3qt b/doc/man/man3/qtextcodec.3qt deleted file mode 100644 index 6513fc491..000000000 --- a/doc/man/man3/qtextcodec.3qt +++ /dev/null @@ -1,586 +0,0 @@ -'\" t -.TH QTextCodec 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 -QTextCodec \- Conversion between text encodings -.SH SYNOPSIS -Almost all the functions in this class are reentrant when Qt is built with thread support. The exceptions are \fB~QTextCodec\fR(), \fBsetCodecForTr\fR(), \fBsetCodecForCStrings\fR(), and \fBQTextCodec\fR().

                                                                  -.PP -\fC#include \fR -.PP -Inherited by QBig5Codec, QBig5hkscsCodec, QEucJpCodec, QEucKrCodec, QGb18030Codec, QJisCodec, QHebrewCodec, QSjisCodec, and QTsciiCodec. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QTextCodec\fR ()" -.br -.ti -1c -.BI "virtual const char * \fBname\fR () const = 0" -.br -.ti -1c -.BI "virtual const char * \fBmimeName\fR () const" -.br -.ti -1c -.BI "virtual int \fBmibEnum\fR () const = 0" -.br -.ti -1c -.BI "virtual QTextDecoder * \fBmakeDecoder\fR () const" -.br -.ti -1c -.BI "virtual QTextEncoder * \fBmakeEncoder\fR () const" -.br -.ti -1c -.BI "virtual QString \fBtoUnicode\fR ( const char * chars, int len ) const" -.br -.ti -1c -.BI "virtual QCString \fBfromUnicode\fR ( const QString & uc, int & lenInOut ) const" -.br -.ti -1c -.BI "QCString \fBfromUnicode\fR ( const QString & uc ) const" -.br -.ti -1c -.BI "QString \fBtoUnicode\fR ( const QByteArray & a, int len ) const" -.br -.ti -1c -.BI "QString \fBtoUnicode\fR ( const QByteArray & a ) const" -.br -.ti -1c -.BI "QString \fBtoUnicode\fR ( const QCString & a, int len ) const" -.br -.ti -1c -.BI "QString \fBtoUnicode\fR ( const QCString & a ) const" -.br -.ti -1c -.BI "QString \fBtoUnicode\fR ( const char * chars ) const" -.br -.ti -1c -.BI "virtual bool \fBcanEncode\fR ( QChar ch ) const" -.br -.ti -1c -.BI "virtual bool \fBcanEncode\fR ( const QString & s ) const" -.br -.ti -1c -.BI "virtual int \fBheuristicContentMatch\fR ( const char * chars, int len ) const = 0" -.br -.ti -1c -.BI "virtual int \fBheuristicNameMatch\fR ( const char * hint ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QTextCodec * \fBloadCharmap\fR ( QIODevice * iod )" -.br -.ti -1c -.BI "QTextCodec * \fBloadCharmapFile\fR ( QString filename )" -.br -.ti -1c -.BI "QTextCodec * \fBcodecForMib\fR ( int mib )" -.br -.ti -1c -.BI "QTextCodec * \fBcodecForName\fR ( const char * name, int accuracy = 0 )" -.br -.ti -1c -.BI "QTextCodec * \fBcodecForContent\fR ( const char * chars, int len )" -.br -.ti -1c -.BI "QTextCodec * \fBcodecForIndex\fR ( int i )" -.br -.ti -1c -.BI "QTextCodec * \fBcodecForLocale\fR ()" -.br -.ti -1c -.BI "void \fBsetCodecForLocale\fR ( QTextCodec * c )" -.br -.ti -1c -.BI "QTextCodec * \fBcodecForTr\fR ()" -.br -.ti -1c -.BI "void \fBsetCodecForTr\fR ( QTextCodec * c )" -.br -.ti -1c -.BI "QTextCodec * \fBcodecForCStrings\fR ()" -.br -.ti -1c -.BI "void \fBsetCodecForCStrings\fR ( QTextCodec * c )" -.br -.ti -1c -.BI "void \fBdeleteAllCodecs\fR ()" -.br -.ti -1c -.BI "const char * \fBlocale\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "\fBQTextCodec\fR ()" -.br -.in -1c -.SS "Static Protected Members" -.in +1c -.ti -1c -.BI "int \fBsimpleHeuristicNameMatch\fR ( const char * name, const char * hint )" -.br -.in -1c -.SH DESCRIPTION -The QTextCodec class provides conversion between text encodings. -.PP -Qt uses Unicode to store, draw and manipulate strings. In many situations you may wish to deal with data that uses a different encoding. For example, most Japanese documents are still stored in Shift-JIS or ISO2022, while Russian users often have their documents in KOI8-R or CP1251. -.PP -Qt provides a set of QTextCodec classes to help with converting non-Unicode formats to and from Unicode. You can also create your own codec classes (see later). -.PP -The supported encodings are: -.TP -Latin1 -.TP -Big5 -- Chinese -.TP -Big5-HKSCS -- Chinese -.TP -eucJP -- Japanese -.TP -eucKR -- Korean -.TP -GB2312 -- Chinese -.TP -GBK -- Chinese -.TP -GB18030 -- Chinese -.TP -JIS7 -- Japanese -.TP -Shift-JIS -- Japanese -.TP -TSCII -- Tamil -.TP -utf8 -- Unicode, 8-bit -.TP -utf16 -- Unicode -.TP -KOI8-R -- Russian -.TP -KOI8-U -- Ukrainian -.TP -ISO8859-1 -- Western -.TP -ISO8859-2 -- Central European -.TP -ISO8859-3 -- Central European -.TP -ISO8859-4 -- Baltic -.TP -ISO8859-5 -- Cyrillic -.TP -ISO8859-6 -- Arabic -.TP -ISO8859-7 -- Greek -.TP -ISO8859-8 -- Hebrew, visually ordered -.TP -ISO8859-8-i -- Hebrew, logically ordered -.TP -ISO8859-9 -- Turkish -.TP -ISO8859-10 -.TP -ISO8859-13 -.TP -ISO8859-14 -.TP -ISO8859-15 -- Western -.TP -IBM 850 -.TP -IBM 866 -.TP -CP874 -.TP -CP1250 -- Central European -.TP -CP1251 -- Cyrillic -.TP -CP1252 -- Western -.TP -CP1253 -- Greek -.TP -CP1254 -- Turkish -.TP -CP1255 -- Hebrew -.TP -CP1256 -- Arabic -.TP -CP1257 -- Baltic -.TP -CP1258 -.TP -Apple Roman -.TP -TIS-620 -- Thai -.PP -QTextCodecs can be used as follows to convert some locally encoded string to Unicode. Suppose you have some string encoded in Russian KOI8-R encoding, and want to convert it to Unicode. The simple way to do this is: -.PP -.nf -.br - QCString locallyEncoded = "..."; // text to convert -.br - QTextCodec *codec = QTextCodec::codecForName("KOI8-R"); // get the codec for KOI8-R -.br - QString unicodeString = codec->toUnicode( locallyEncoded ); -.br -.fi -.PP -After this, \fCunicodeString\fR holds the text converted to Unicode. Converting a string from Unicode to the local encoding is just as easy: -.PP -.nf -.br - QString unicodeString = "..."; // any Unicode text -.br - QTextCodec *codec = QTextCodec::codecForName("KOI8-R"); // get the codec for KOI8-R -.br - QCString locallyEncoded = codec->fromUnicode( unicodeString ); -.br -.fi -.PP -Some care must be taken when trying to convert the data in chunks, for example, when receiving it over a network. In such cases it is possible that a multi-byte character will be split over two chunks. At best this might result in the loss of a character and at worst cause the entire conversion to fail. -.PP -The approach to use in these situations is to create a QTextDecoder object for the codec and use this QTextDecoder for the whole decoding process, as shown below: -.PP -.nf -.br - QTextCodec *codec = QTextCodec::codecForName( "Shift-JIS" ); -.br - QTextDecoder *decoder = codec->makeDecoder(); -.br -.br - QString unicodeString; -.br - while( receiving_data ) { -.br - QByteArray chunk = new_data; -.br - unicodeString += decoder->toUnicode( chunk.data(), chunk.length() ); -.br - } -.br -.fi -.PP -The QTextDecoder object maintains state between chunks and therefore works correctly even if a multi-byte character is split between chunks. -.SH "Creating your own Codec class" -Support for new text encodings can be added to Qt by creating QTextCodec subclasses. -.PP -Built-in codecs can be overridden by custom codecs since more recently created QTextCodec objects take precedence over earlier ones. -.PP -You may find it more convenient to make your codec class available as a plugin; see the plugin documentation for more details. -.PP -The abstract virtual functions describe the encoder to the system and the coder is used as required in the different text file formats supported by QTextStream, and under X11, for the locale-specific character input and output. -.PP -To add support for another 8-bit encoding to Qt, make a subclass of QTextCodec and implement at least the following methods: -.PP -.nf -.br - const char* name() const -.br -.fi -Return the official name for the encoding. -.PP -.nf -.br - int mibEnum() const -.br -.fi -Return the MIB enum for the encoding if it is listed in the IANA character-sets encoding file. -.PP -If the encoding is multi-byte then it will have "state"; that is, the interpretation of some bytes will be dependent on some preceding bytes. For such encodings, you must implement: -.PP -.nf -.br - QTextDecoder* makeDecoder() const -.br -.fi -Return a QTextDecoder that remembers incomplete multi-byte sequence prefixes or other required state. -.PP -If the encoding does \fInot\fR require state, you should implement: -.PP -.nf -.br - QString toUnicode(const char* chars, int len) const -.br -.fi -Converts \fIlen\fR characters from \fIchars\fR to Unicode. -.PP -The base QTextCodec class has default implementations of the above two functions, \fIbut they are mutually recursive\fR, so you must re-implement at least one of them, or both for improved efficiency. -.PP -For conversion from Unicode to 8-bit encodings, it is rarely necessary to maintain state. However, two functions similar to the two above are used for encoding: -.PP -.nf -.br - QTextEncoder* makeEncoder() const -.br -.fi -Return a QTextEncoder. -.PP -.nf -.br - QCString fromUnicode(const QString& uc, int& lenInOut ) const -.br -.fi -Converts \fIlenInOut\fR characters (of type QChar) from the start of the string \fIuc\fR, returning a QCString result, and also returning the length of the result in \fIlenInOut\fR. -.PP -Again, these are mutually recursive so only one needs to be implemented, or both if greater efficiency is possible. -.PP -Finally, you must implement: -.PP -.nf -.br - int heuristicContentMatch(const char* chars, int len) const -.br -.fi -Gives a value indicating how likely it is that \fIlen\fR characters from \fIchars\fR are in the encoding. -.PP -A good model for this function is the QWindowsLocalCodec::heuristicContentMatch function found in the Qt sources. -.PP -A QTextCodec subclass might have improved performance if you also re-implement: -.PP -.nf -.br - bool canEncode( QChar ) const -.br -.fi -Test if a Unicode character can be encoded. -.PP -.nf -.br - bool canEncode( const QString& ) const -.br -.fi -Test if a string of Unicode characters can be encoded. -.PP -.nf -.br - int heuristicNameMatch(const char* hint) const -.br -.fi -Test if a possibly non-standard name is referring to the codec. -.PP -Codecs can also be created as plugins. -.PP -See also Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextCodec::QTextCodec ()\fC [protected]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                                                                  -.PP -Constructs a QTextCodec, and gives it the highest precedence. The QTextCodec should always be constructed on the heap (i.e. with \fCnew\fR). Qt takes ownership and will delete it when the application terminates. -.SH "QTextCodec::~QTextCodec ()\fC [virtual]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                                                                  -.PP -Destroys the QTextCodec. Note that you should not delete codecs yourself: once created they become Qt's responsibility. -.SH "bool QTextCodec::canEncode ( QChar ch ) const\fC [virtual]\fR" -Returns TRUE if the Unicode character \fIch\fR can be fully encoded with this codec; otherwise returns FALSE. The default implementation tests if the result of toUnicode(fromUnicode(ch)) is the original \fIch\fR. Subclasses may be able to improve the efficiency. -.SH "bool QTextCodec::canEncode ( const QString & s ) const\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIs\fR contains the string being tested for encode-ability. -.SH "QTextCodec * QTextCodec::codecForCStrings ()\fC [static]\fR" -Returns the codec used by QString to convert to and from const char* and QCStrings. If this function returns 0 (the default), QString assumes Latin-1. -.PP -See also setCodecForCStrings(). -.SH "QTextCodec * QTextCodec::codecForContent ( const char * chars, int len )\fC [static]\fR" -Searches all installed QTextCodec objects, returning the one which most recognizes the given content. May return 0. -.PP -Note that this is often a poor choice, since character encodings often use most of the available character sequences, and so only by linguistic analysis could a true match be made. -.PP -\fIchars\fR contains the string to check, and \fIlen\fR contains the number of characters in the string to use. -.PP -See also heuristicContentMatch(). -.PP -Example: qwerty/qwerty.cpp. -.SH "QTextCodec * QTextCodec::codecForIndex ( int i )\fC [static]\fR" -Returns the QTextCodec \fIi\fR positions from the most recently inserted codec, or 0 if there is no such QTextCodec. Thus, codecForIndex(0) returns the most recently created QTextCodec. -.PP -Example: qwerty/qwerty.cpp. -.SH "QTextCodec * QTextCodec::codecForLocale ()\fC [static]\fR" -Returns a pointer to the codec most suitable for this locale. -.PP -Example: qwerty/qwerty.cpp. -.SH "QTextCodec * QTextCodec::codecForMib ( int mib )\fC [static]\fR" -Returns the QTextCodec which matches the MIBenum \fImib\fR. -.SH "QTextCodec * QTextCodec::codecForName ( const char * name, int accuracy = 0 )\fC [static]\fR" -Searches all installed QTextCodec objects and returns the one which best matches \fIname\fR; the match is case-insensitive. Returns 0 if no codec's heuristicNameMatch() reports a match better than \fIaccuracy\fR, or if \fIname\fR is a null string. -.PP -See also heuristicNameMatch(). -.SH "QTextCodec * QTextCodec::codecForTr ()\fC [static]\fR" -Returns the codec used by QObject::tr() on its argument. If this function returns 0 (the default), tr() assumes Latin-1. -.PP -See also setCodecForTr(). -.SH "void QTextCodec::deleteAllCodecs ()\fC [static]\fR" -Deletes all the created codecs. -.PP -\fBWarning:\fR Do not call this function. -.PP -QApplication calls this function just before exiting to delete any QTextCodec objects that may be lying around. Since various other classes hold pointers to QTextCodec objects, it is not safe to call this function earlier. -.PP -If you are using the utility classes (like QString) but not using QApplication, calling this function at the very end of your application may be helpful for chasing down memory leaks by eliminating any QTextCodec objects. -.SH "QCString QTextCodec::fromUnicode ( const QString & uc, int & lenInOut ) const\fC [virtual]\fR" -QTextCodec subclasses must reimplement either this function or makeEncoder(). It converts the first \fIlenInOut\fR characters of \fIuc\fR from Unicode to the encoding of the subclass. If \fIlenInOut\fR is negative or too large, the length of \fIuc\fR is used instead. -.PP -Converts \fIlenInOut\fR characters (not bytes) from \fIuc\fR, producing a QCString. \fIlenInOut\fR will be set to the length of the result (in bytes). -.PP -The default implementation makes an encoder with makeEncoder() and converts the input with that. Note that the default makeEncoder() implementation makes an encoder that simply calls this function, hence subclasses \fImust\fR reimplement one function or the other to avoid infinite recursion. -.PP -Reimplemented in QHebrewCodec. -.SH "QCString QTextCodec::fromUnicode ( const QString & uc ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIuc\fR is the unicode source string. -.SH "int QTextCodec::heuristicContentMatch ( const char * chars, int len ) const\fC [pure virtual]\fR" -QTextCodec subclasses must reimplement this function. It examines the first \fIlen\fR bytes of \fIchars\fR and returns a value indicating how likely it is that the string is a prefix of text encoded in the encoding of the subclass. A negative return value indicates that the text is detectably not in the encoding (e.g. it contains characters undefined in the encoding). A return value of 0 indicates that the text should be decoded with this codec rather than as ASCII, but there is no particular evidence. The value should range up to \fIlen\fR. Thus, most decoders will return -1, 0, or -\fIlen\fR. -.PP -The characters are not null terminated. -.PP -See also codecForContent(). -.SH "int QTextCodec::heuristicNameMatch ( const char * hint ) const\fC [virtual]\fR" -Returns a value indicating how likely it is that this decoder is appropriate for decoding some format that has the given name. The name is compared with the \fIhint\fR. -.PP -A good match returns a positive number around the length of the string. A bad match is negative. -.PP -The default implementation calls simpleHeuristicNameMatch() with the name of the codec. -.SH "QTextCodec * QTextCodec::loadCharmap ( QIODevice * iod )\fC [static]\fR" -Reads a POSIX2 charmap definition from \fIiod\fR. The parser recognizes the following lines: -.PP - \fIname\fR
                                                                  \fIcharacter\fR
                                                                  % alias \fIalias\fR
                                                                  CHARMAP
                                                                  <\fItoken\fR> /x\fIhexbyte\fR ...
                                                                  <\fItoken\fR> /d\fIdecbyte\fR ...
                                                                  <\fItoken\fR> /\fIoctbyte\fR ...
                                                                  <\fItoken\fR> /\fIany\fR/\fIany\fR... ...
                                                                  END CHARMAP
                                                                   -.PP -The resulting QTextCodec is returned (and also added to the global list of codecs). The name() of the result is taken from the code_set_name. -.PP -Note that a codec constructed in this way uses much more memory and is slower than a hand-written QTextCodec subclass, since tables in code are kept in memory shared by all Qt applications. -.PP -See also loadCharmapFile(). -.PP -Example: qwerty/qwerty.cpp. -.SH "QTextCodec * QTextCodec::loadCharmapFile ( QString filename )\fC [static]\fR" -A convenience function for loadCharmap() that loads the charmap definition from the file \fIfilename\fR. -.SH "const char * QTextCodec::locale ()\fC [static]\fR" -Returns a string representing the current language and sublanguage, e.g. "pt" for Portuguese, or "pt_br" for Portuguese/Brazil. -.PP -Example: i18n/main.cpp. -.SH "QTextDecoder * QTextCodec::makeDecoder () const\fC [virtual]\fR" -Creates a QTextDecoder which stores enough state to decode chunks of char* data to create chunks of Unicode data. The default implementation creates a stateless decoder, which is only sufficient for the simplest encodings where each byte corresponds to exactly one Unicode character. -.PP -The caller is responsible for deleting the returned object. -.SH "QTextEncoder * QTextCodec::makeEncoder () const\fC [virtual]\fR" -Creates a QTextEncoder which stores enough state to encode chunks of Unicode data as char* data. The default implementation creates a stateless encoder, which is only sufficient for the simplest encodings where each Unicode character corresponds to exactly one character. -.PP -The caller is responsible for deleting the returned object. -.SH "int QTextCodec::mibEnum () const\fC [pure virtual]\fR" -Subclasses of QTextCodec must reimplement this function. It returns the MIBenum (see the IANA character-sets encoding file for more information). It is important that each QTextCodec subclass returns the correct unique value for this function. -.PP -Reimplemented in QEucJpCodec. -.SH "const char * QTextCodec::mimeName () const\fC [virtual]\fR" -Returns the preferred mime name of the encoding as defined in the IANA character-sets encoding file. -.PP -Reimplemented in QEucJpCodec, QEucKrCodec, QJisCodec, QHebrewCodec, and QSjisCodec. -.SH "const char * QTextCodec::name () const\fC [pure virtual]\fR" -QTextCodec subclasses must reimplement this function. It returns the name of the encoding supported by the subclass. When choosing a name for an encoding, consider these points: -.TP -On X11, heuristicNameMatch( const char * hint ) is used to test if a the QTextCodec can convert between Unicode and the encoding of a font with encoding \fIhint\fR, such as "iso8859-1" for Latin-1 fonts," koi8-r" for Russian KOI8 fonts. The default algorithm of heuristicNameMatch() uses name(). -.TP -Some applications may use this function to present encodings to the end user. -.PP -Example: qwerty/qwerty.cpp. -.SH "void QTextCodec::setCodecForCStrings ( QTextCodec * c )\fC [static]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                                                                  -.PP -Sets the codec used by QString to convert to and from const char* and QCStrings. If \fIc\fR is 0 (the default), QString assumes Latin-1. -.PP -\fBWarning:\fR Some codecs do not preserve the characters in the ascii range (0x00 to 0x7f). For example, the Japanese Shift-JIS encoding maps the backslash character (0x5a) to the Yen character. This leads to unexpected results when using the backslash character to escape characters in strings used in e.g. regular expressions. Use QString::fromLatin1() to preserve characters in the ascii range when needed. -.PP -See also codecForCStrings() and setCodecForTr(). -.SH "void QTextCodec::setCodecForLocale ( QTextCodec * c )\fC [static]\fR" -Set the codec to \fIc\fR; this will be returned by codecForLocale(). This might be needed for some applications that want to use their own mechanism for setting the locale. -.PP -See also codecForLocale(). -.SH "void QTextCodec::setCodecForTr ( QTextCodec * c )\fC [static]\fR" -\fBWarning:\fR This function is \fInot\fR reentrant.

                                                                  -.PP -Sets the codec used by QObject::tr() on its argument to \fIc\fR. If \fIc\fR is 0 (the default), tr() assumes Latin-1. -.PP -If the literal quoted text in the program is not in the Latin-1 encoding, this function can be used to set the appropriate encoding. For example, software developed by Korean programmers might use eucKR for all the text in the program, in which case the main() function might look like this: -.PP -.nf -.br - int main(int argc, char** argv) -.br - { -.br - QApplication app(argc, argv); -.br - ... install any additional codecs ... -.br - QTextCodec::setCodecForTr( QTextCodec::codecForName("eucKR") ); -.br - ... -.br - } -.br -.fi -.PP -Note that this is not the way to select the encoding that the \fIuser\fR has chosen. For example, to convert an application containing literal English strings to Korean, all that is needed is for the English strings to be passed through tr() and for translation files to be loaded. For details of internationalization, see the Qt internationalization documentation. -.PP -See also codecForTr() and setCodecForCStrings(). -.SH "int QTextCodec::simpleHeuristicNameMatch ( const char * name, const char * hint )\fC [static protected]\fR" -A simple utility function for heuristicNameMatch(): it does some very minor character-skipping so that almost-exact matches score high. \fIname\fR is the text we're matching and \fIhint\fR is used for the comparison. -.SH "QString QTextCodec::toUnicode ( const char * chars, int len ) const\fC [virtual]\fR" -QTextCodec subclasses must reimplement this function or makeDecoder(). It converts the first \fIlen\fR characters of \fIchars\fR to Unicode. -.PP -The default implementation makes a decoder with makeDecoder() and converts the input with that. Note that the default makeDecoder() implementation makes a decoder that simply calls this function, hence subclasses \fImust\fR reimplement one function or the other to avoid infinite recursion. -.SH "QString QTextCodec::toUnicode ( const QByteArray & a, int len ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR contains the source characters; \fIlen\fR contains the number of characters in \fIa\fR to use. -.SH "QString QTextCodec::toUnicode ( const QByteArray & a ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR contains the source characters. -.SH "QString QTextCodec::toUnicode ( const QCString & a, int len ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR contains the source characters; \fIlen\fR contains the number of characters in \fIa\fR to use. -.SH "QString QTextCodec::toUnicode ( const QCString & a ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIa\fR contains the source characters. -.SH "QString QTextCodec::toUnicode ( const char * chars ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIchars\fR contains the source characters. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtextcodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextcodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextcodecplugin.3qt b/doc/man/man3/qtextcodecplugin.3qt deleted file mode 100644 index fbfbdb787..000000000 --- a/doc/man/man3/qtextcodecplugin.3qt +++ /dev/null @@ -1,96 +0,0 @@ -'\" t -.TH QTextCodecPlugin 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 -QTextCodecPlugin \- Abstract base for custom QTextCodec plugins -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                                                  -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTextCodecPlugin\fR ()" -.br -.ti -1c -.BI "\fB~QTextCodecPlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBnames\fR () const = 0" -.br -.ti -1c -.BI "virtual QTextCodec * \fBcreateForName\fR ( const QString & name ) = 0" -.br -.ti -1c -.BI "virtual QValueList \fBmibEnums\fR () const = 0" -.br -.ti -1c -.BI "virtual QTextCodec * \fBcreateForMib\fR ( int mib ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QTextCodecPlugin class provides an abstract base for custom QTextCodec plugins. -.PP -The text codec plugin is a simple plugin interface that makes it easy to create custom text codecs that can be loaded dynamically into applications. -.PP -Writing a text codec plugin is achieved by subclassing this base class, reimplementing the pure virtual functions names(), createForName(), mibEnums() and createForMib(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Qt Plugins documentation for details. -.PP -See the IANA character-sets encoding file for more information on mime names and mib enums. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextCodecPlugin::QTextCodecPlugin ()" -Constructs a text codec plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. -.SH "QTextCodecPlugin::~QTextCodecPlugin ()" -Destroys the text codec plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "QTextCodec * QTextCodecPlugin::createForMib ( int mib )\fC [pure virtual]\fR" -Creates a QTextCodec object for the mib enum \fImib\fR. -.PP -(See the IANA character-sets encoding file for more information) -.PP -See also mibEnums(). -.SH "QTextCodec * QTextCodecPlugin::createForName ( const QString & name )\fC [pure virtual]\fR" -Creates a QTextCodec object for the codec called \fIname\fR. -.PP -See also names(). -.SH "QValueList QTextCodecPlugin::mibEnums () const\fC [pure virtual]\fR" -Returns the list of mib enums supported by this plugin. -.PP -See also createForMib(). -.SH "QStringList QTextCodecPlugin::names () const\fC [pure virtual]\fR" -Returns the list of mime names supported by this plugin. -.PP -See also createForName(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtextcodecplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextcodecplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextdecoder.3qt b/doc/man/man3/qtextdecoder.3qt deleted file mode 100644 index 150775479..000000000 --- a/doc/man/man3/qtextdecoder.3qt +++ /dev/null @@ -1,64 +0,0 @@ -'\" t -.TH QTextDecoder 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 -QTextDecoder \- State-based decoder -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.

                                                                  -.PP -\fC#include \fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QTextDecoder\fR ()" -.br -.ti -1c -.BI "virtual QString \fBtoUnicode\fR ( const char * chars, int len ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QTextDecoder class provides a state-based decoder. -.PP -The decoder converts a text format into Unicode, remembering any state that is required between calls. -.PP -See also QTextCodec::makeEncoder() and Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextDecoder::~QTextDecoder ()\fC [virtual]\fR" -Destroys the decoder. -.SH "QString QTextDecoder::toUnicode ( const char * chars, int len )\fC [pure virtual]\fR" -Converts the first \fIlen\fR bytes in \fIchars\fR to Unicode, returning the result. -.PP -If not all characters are used (e.g. if only part of a multi-byte -encoding is at the end of the characters), the decoder remembers -enough state to continue with the next call to this function. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtextdecoder.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextdecoder.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextdrag.3qt b/doc/man/man3/qtextdrag.3qt deleted file mode 100644 index b2620f13f..000000000 --- a/doc/man/man3/qtextdrag.3qt +++ /dev/null @@ -1,110 +0,0 @@ -'\" t -.TH QTextDrag 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 -QTextDrag \- Drag and drop object for transferring plain and Unicode text -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QDragObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTextDrag\fR ( const QString & text, QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQTextDrag\fR ( QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QTextDrag\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & text )" -.br -.ti -1c -.BI "virtual void \fBsetSubtype\fR ( const QCString & st )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBcanDecode\fR ( const QMimeSource * e )" -.br -.ti -1c -.BI "bool \fBdecode\fR ( const QMimeSource * e, QString & str )" -.br -.ti -1c -.BI "bool \fBdecode\fR ( const QMimeSource * e, QString & str, QCString & subtype )" -.br -.in -1c -.SH DESCRIPTION -The QTextDrag class is a drag and drop object for transferring plain and Unicode text. -.PP -Plain text is passed in a QString which may contain multiple lines (i.e. may contain newline characters). The drag target will receive the newlines according to the runtime environment, e.g. LF on Unix, and CRLF on Windows. -.PP -Qt provides no built-in mechanism for delivering only a single-line. -.PP -For more information about drag and drop, see the QDragObject class and the drag and drop documentation. -.PP -See also Drag And Drop Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextDrag::QTextDrag ( const QString & text, QWidget * dragSource = 0, const char * name = 0 )" -Constructs a text drag object and sets its data to \fItext\fR. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. -.SH "QTextDrag::QTextDrag ( QWidget * dragSource = 0, const char * name = 0 )" -Constructs a default text drag object. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. -.SH "QTextDrag::~QTextDrag ()" -Destroys the text drag object and frees up all allocated resources. -.SH "bool QTextDrag::canDecode ( const QMimeSource * e )\fC [static]\fR" -Returns TRUE if the information in \fIe\fR can be decoded into a QString; otherwise returns FALSE. -.PP -See also decode(). -.PP -Example: iconview/simple_dd/main.cpp. -.SH "bool QTextDrag::decode ( const QMimeSource * e, QString & str )\fC [static]\fR" -Attempts to decode the dropped information in \fIe\fR into \fIstr\fR. Returns TRUE if successful; otherwise returns FALSE. -.PP -See also canDecode(). -.PP -Example: iconview/simple_dd/main.cpp. -.SH "bool QTextDrag::decode ( const QMimeSource * e, QString & str, QCString & subtype )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Attempts to decode the dropped information in \fIe\fR into \fIstr\fR. Returns TRUE if successful; otherwise returns FALSE. If \fIsubtype\fR is null, any text subtype is accepted; otherwise only the specified \fIsubtype\fR is accepted. -.PP -See also canDecode(). -.SH "void QTextDrag::setSubtype ( const QCString & st )\fC [virtual]\fR" -Sets the MIME subtype of the text being dragged to \fIst\fR. The default subtype is "plain", so the default MIME type of the text is "text/plain". You might use this to declare that the text is" text/html" by calling setSubtype("html"). -.SH "void QTextDrag::setText ( const QString & text )\fC [virtual]\fR" -Sets the text to be dragged to \fItext\fR. You will need to call this -if you did not pass the text during construction. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtextdrag.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextdrag.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextedit.3qt b/doc/man/man3/qtextedit.3qt deleted file mode 100644 index 0ae7b1ebf..000000000 --- a/doc/man/man3/qtextedit.3qt +++ /dev/null @@ -1,1452 +0,0 @@ -'\" t -.TH QTextEdit 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 -QTextEdit \- Powerful single-page rich text editor -.SH SYNOPSIS -\fC#include \fR -.PP -Inherits QScrollView. -.PP -Inherited by QMultiLineEdit, QTextBrowser, and QTextView. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBWordWrap\fR { NoWrap, WidgetWidth, FixedPixelWidth, FixedColumnWidth }" -.br -.ti -1c -.BI "enum \fBWrapPolicy\fR { AtWordBoundary, AtWhiteSpace = AtWordBoundary, Anywhere, AtWordOrDocumentBoundary }" -.br -.ti -1c -.BI "enum \fBAutoFormatting\fR { AutoNone = 0, AutoBulletList = 0x00000001, AutoAll = 0xffffffff }" -.br -.ti -1c -.BI "enum \fBKeyboardAction\fR { ActionBackspace, ActionDelete, ActionReturn, ActionKill, ActionWordBackspace, ActionWordDelete }" -.br -.ti -1c -.BI "enum \fBCursorAction\fR { MoveBackward, MoveForward, MoveWordBackward, MoveWordForward, MoveUp, MoveDown, MoveLineStart, MoveLineEnd, MoveHome, MoveEnd, MovePgUp, MovePgDown }" -.br -.ti -1c -.BI "enum \fBVerticalAlignment\fR { AlignNormal, AlignSuperScript, AlignSubScript }" -.br -.ti -1c -.BI "\fBQTextEdit\fR ( const QString & text, const QString & context = QString::null, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQTextEdit\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "QString \fBtext\fR () const" -.br -.ti -1c -.BI "QString \fBtext\fR ( int para ) const" -.br -.ti -1c -.BI "TextFormat \fBtextFormat\fR () const" -.br -.ti -1c -.BI "QString \fBcontext\fR () const" -.br -.ti -1c -.BI "QString \fBdocumentTitle\fR () const" -.br -.ti -1c -.BI "void \fBgetSelection\fR ( int * paraFrom, int * indexFrom, int * paraTo, int * indexTo, int selNum = 0 ) const" -.br -.ti -1c -.BI "virtual bool \fBfind\fR ( const QString & expr, bool cs, bool wo, bool forward = TRUE, int * para = 0, int * index = 0 )" -.br -.ti -1c -.BI "int \fBparagraphs\fR () const" -.br -.ti -1c -.BI "int \fBlines\fR () const" -.br -.ti -1c -.BI "int \fBlinesOfParagraph\fR ( int para ) const" -.br -.ti -1c -.BI "int \fBlineOfChar\fR ( int para, int index )" -.br -.ti -1c -.BI "int \fBlength\fR () const" -.br -.ti -1c -.BI "QRect \fBparagraphRect\fR ( int para ) const" -.br -.ti -1c -.BI "int \fBparagraphAt\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "int \fBcharAt\fR ( const QPoint & pos, int * para ) const" -.br -.ti -1c -.BI "int \fBparagraphLength\fR ( int para ) const" -.br -.ti -1c -.BI "QStyleSheet * \fBstyleSheet\fR () const" -.br -.ti -1c -.BI "QMimeSourceFactory * \fBmimeSourceFactory\fR () const" -.br -.ti -1c -.BI "QBrush \fBpaper\fR () const" -.br -.ti -1c -.BI "bool \fBlinkUnderline\fR () const" -.br -.ti -1c -.BI "virtual int \fBheightForWidth\fR ( int w ) const" -.br -.ti -1c -.BI "bool \fBhasSelectedText\fR () const" -.br -.ti -1c -.BI "QString \fBselectedText\fR () const" -.br -.ti -1c -.BI "bool \fBisUndoAvailable\fR () const" -.br -.ti -1c -.BI "bool \fBisRedoAvailable\fR () const" -.br -.ti -1c -.BI "WordWrap \fBwordWrap\fR () const" -.br -.ti -1c -.BI "int \fBwrapColumnOrWidth\fR () const" -.br -.ti -1c -.BI "WrapPolicy \fBwrapPolicy\fR () const" -.br -.ti -1c -.BI "int \fBtabStopWidth\fR () const" -.br -.ti -1c -.BI "QString \fBanchorAt\fR ( const QPoint & pos )" -.br -.ti -1c -.BI "QString \fBanchorAt\fR ( const QPoint & pos, AnchorAttribute attr )" -.br -.ti -1c -.BI "bool \fBisReadOnly\fR () const" -.br -.ti -1c -.BI "void \fBgetCursorPosition\fR ( int * para, int * index ) const" -.br -.ti -1c -.BI "bool \fBisModified\fR () const" -.br -.ti -1c -.BI "bool \fBitalic\fR () const" -.br -.ti -1c -.BI "bool \fBbold\fR () const" -.br -.ti -1c -.BI "bool \fBunderline\fR () const" -.br -.ti -1c -.BI "QString \fBfamily\fR () const" -.br -.ti -1c -.BI "int \fBpointSize\fR () const" -.br -.ti -1c -.BI "QColor \fBcolor\fR () const" -.br -.ti -1c -.BI "QFont font () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QFont \fBcurrentFont\fR () const" -.br -.ti -1c -.BI "int \fBalignment\fR () const" -.br -.ti -1c -.BI "int \fBundoDepth\fR () const" -.br -.ti -1c -.BI "bool \fBisOverwriteMode\fR () const" -.br -.ti -1c -.BI "QColor \fBparagraphBackgroundColor\fR ( int para ) const" -.br -.ti -1c -.BI "bool \fBisUndoRedoEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBtabChangesFocus\fR () const" -.br -.ti -1c -.BI "void \fBsetAutoFormatting\fR ( uint features )" -.br -.ti -1c -.BI "uint \fBautoFormatting\fR () const" -.br -.ti -1c -.BI "QSyntaxHighlighter * \fBsyntaxHighlighter\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetMimeSourceFactory\fR ( QMimeSourceFactory * factory )" -.br -.ti -1c -.BI "virtual void \fBsetStyleSheet\fR ( QStyleSheet * styleSheet )" -.br -.ti -1c -.BI "virtual void \fBscrollToAnchor\fR ( const QString & name )" -.br -.ti -1c -.BI "virtual void \fBsetPaper\fR ( const QBrush & pap )" -.br -.ti -1c -.BI "virtual void \fBsetLinkUnderline\fR ( bool )" -.br -.ti -1c -.BI "virtual void \fBsetWordWrap\fR ( WordWrap mode )" -.br -.ti -1c -.BI "virtual void \fBsetWrapColumnOrWidth\fR ( int )" -.br -.ti -1c -.BI "virtual void \fBsetWrapPolicy\fR ( WrapPolicy policy )" -.br -.ti -1c -.BI "virtual void \fBcopy\fR ()" -.br -.ti -1c -.BI "virtual void \fBappend\fR ( const QString & text )" -.br -.ti -1c -.BI "void \fBsetText\fR ( const QString & txt )" -.br -.ti -1c -.BI "virtual void \fBsetText\fR ( const QString & text, const QString & context )" -.br -.ti -1c -.BI "virtual void \fBsetTextFormat\fR ( TextFormat f )" -.br -.ti -1c -.BI "virtual void \fBselectAll\fR ( bool select = TRUE )" -.br -.ti -1c -.BI "virtual void \fBsetTabStopWidth\fR ( int ts )" -.br -.ti -1c -.BI "virtual void \fBzoomIn\fR ( int range )" -.br -.ti -1c -.BI "virtual void \fBzoomIn\fR ()" -.br -.ti -1c -.BI "virtual void \fBzoomOut\fR ( int range )" -.br -.ti -1c -.BI "virtual void \fBzoomOut\fR ()" -.br -.ti -1c -.BI "virtual void \fBzoomTo\fR ( int size )" -.br -.ti -1c -.BI "virtual void \fBsync\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetReadOnly\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBundo\fR ()" -.br -.ti -1c -.BI "virtual void \fBredo\fR ()" -.br -.ti -1c -.BI "virtual void \fBcut\fR ()" -.br -.ti -1c -.BI "virtual void \fBpaste\fR ()" -.br -.ti -1c -.BI "virtual void \fBpasteSubType\fR ( const QCString & subtype )" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "virtual void \fBdel\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetItalic\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetBold\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetUnderline\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetFamily\fR ( const QString & fontFamily )" -.br -.ti -1c -.BI "virtual void \fBsetPointSize\fR ( int s )" -.br -.ti -1c -.BI "virtual void \fBsetColor\fR ( const QColor & c )" -.br -.ti -1c -.BI "virtual void \fBsetVerticalAlignment\fR ( VerticalAlignment a )" -.br -.ti -1c -.BI "virtual void \fBsetAlignment\fR ( int a )" -.br -.ti -1c -.BI "virtual void \fBsetCursorPosition\fR ( int para, int index )" -.br -.ti -1c -.BI "virtual void \fBsetSelection\fR ( int paraFrom, int indexFrom, int paraTo, int indexTo, int selNum = 0 )" -.br -.ti -1c -.BI "virtual void \fBsetSelectionAttributes\fR ( int selNum, const QColor & back, bool invertText )" -.br -.ti -1c -.BI "virtual void \fBsetModified\fR ( bool m )" -.br -.ti -1c -.BI "virtual void \fBsetUndoDepth\fR ( int d )" -.br -.ti -1c -.BI "virtual void \fBensureCursorVisible\fR ()" -.br -.ti -1c -.BI "virtual void \fBplaceCursor\fR ( const QPoint & pos, QTextCursor * c = 0 )" -.br -.ti -1c -.BI "virtual void \fBmoveCursor\fR ( CursorAction action, bool select )" -.br -.ti -1c -.BI "virtual void \fBdoKeyboardAction\fR ( KeyboardAction action )" -.br -.ti -1c -.BI "virtual void \fBremoveSelectedText\fR ( int selNum = 0 )" -.br -.ti -1c -.BI "virtual void \fBremoveSelection\fR ( int selNum = 0 )" -.br -.ti -1c -.BI "virtual void \fBsetCurrentFont\fR ( const QFont & f )" -.br -.ti -1c -.BI "virtual void \fBsetOverwriteMode\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBscrollToBottom\fR ()" -.br -.ti -1c -.BI "void \fBinsert\fR ( const QString & text, uint insertionFlags = CheckNewLines | RemoveSelected )" -.br -.ti -1c -.BI "virtual void insert ( const QString & text, bool indent, bool checkNewLine = TRUE, bool removeSelected = TRUE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void \fBinsertAt\fR ( const QString & text, int para, int index )" -.br -.ti -1c -.BI "virtual void \fBremoveParagraph\fR ( int para )" -.br -.ti -1c -.BI "virtual void \fBinsertParagraph\fR ( const QString & text, int para )" -.br -.ti -1c -.BI "virtual void \fBsetParagraphBackgroundColor\fR ( int para, const QColor & bg )" -.br -.ti -1c -.BI "virtual void \fBclearParagraphBackground\fR ( int para )" -.br -.ti -1c -.BI "virtual void \fBsetUndoRedoEnabled\fR ( bool b )" -.br -.ti -1c -.BI "void \fBsetTabChangesFocus\fR ( bool b )" -.br -.ti -1c -.BI "void \fBsetMaxLogLines\fR ( int limit )" -.br -.ti -1c -.BI "int \fBmaxLogLines\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBtextChanged\fR ()" -.br -.ti -1c -.BI "void \fBselectionChanged\fR ()" -.br -.ti -1c -.BI "void \fBcopyAvailable\fR ( bool yes )" -.br -.ti -1c -.BI "void \fBundoAvailable\fR ( bool yes )" -.br -.ti -1c -.BI "void \fBredoAvailable\fR ( bool yes )" -.br -.ti -1c -.BI "void \fBcurrentFontChanged\fR ( const QFont & f )" -.br -.ti -1c -.BI "void \fBcurrentColorChanged\fR ( const QColor & c )" -.br -.ti -1c -.BI "void \fBcurrentAlignmentChanged\fR ( int a )" -.br -.ti -1c -.BI "void \fBcurrentVerticalAlignmentChanged\fR ( VerticalAlignment a )" -.br -.ti -1c -.BI "void \fBcursorPositionChanged\fR ( int para, int pos )" -.br -.ti -1c -.BI "void \fBreturnPressed\fR ()" -.br -.ti -1c -.BI "void \fBmodificationChanged\fR ( bool m )" -.br -.ti -1c -.BI "void \fBclicked\fR ( int para, int pos )" -.br -.ti -1c -.BI "void \fBdoubleClicked\fR ( int para, int pos )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "AutoFormatting \fBautoFormatting\fR - the enabled set of auto formatting features" -.br -.ti -1c -.BI "QString \fBdocumentTitle\fR - the title of the document parsed from the text \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBhasSelectedText\fR - whether some text is selected in selection 0 \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBlength\fR - the number of characters in the text \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBlinkUnderline\fR - whether hypertext links will be underlined" -.br -.ti -1c -.BI "bool \fBmodified\fR - whether the document has been modified by the user" -.br -.ti -1c -.BI "bool \fBoverwriteMode\fR - the text edit's overwrite mode" -.br -.ti -1c -.BI "QBrush \fBpaper\fR - the background (paper) brush" -.br -.ti -1c -.BI "bool \fBreadOnly\fR - whether the text edit is read-only" -.br -.ti -1c -.BI "QString \fBselectedText\fR - the selected text (from selection " "0" ") or an empty string if there is no currently selected text (in selection " "0" ") \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBtabChangesFocus\fR - whether TAB changes focus or is accepted as input" -.br -.ti -1c -.BI "int \fBtabStopWidth\fR - the tab stop width in pixels" -.br -.ti -1c -.BI "QString \fBtext\fR - the text edit's text" -.br -.ti -1c -.BI "TextFormat \fBtextFormat\fR - the text format: rich " "text" ", plain " "text" ", log text or auto text" -.br -.ti -1c -.BI "int \fBundoDepth\fR - the depth of the undo history" -.br -.ti -1c -.BI "bool \fBundoRedoEnabled\fR - whether undo/redo is enabled" -.br -.ti -1c -.BI "WordWrap \fBwordWrap\fR - the word wrap mode" -.br -.ti -1c -.BI "int \fBwrapColumnOrWidth\fR - the position (in pixels or columns depending on the wrap " "mode" ") where text will be wrapped" -.br -.ti -1c -.BI "WrapPolicy \fBwrapPolicy\fR - the word wrap " "policy" ", at whitespace or anywhere" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBrepaintChanged\fR ()" -.br -.ti -1c -.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" -.br -.ti -1c -.BI "virtual bool \fBfocusNextPrevChild\fR ( bool n )" -.br -.ti -1c -.BI "QTextCursor * \fBtextCursor\fR () const" -.br -.ti -1c -.BI "virtual QPopupMenu * \fBcreatePopupMenu\fR ( const QPoint & pos )" -.br -.ti -1c -.BI "virtual QPopupMenu * createPopupMenu () \fI(obsolete)\fR" -.br -.in -1c -.SH DESCRIPTION -The QTextEdit widget provides a powerful single-page rich text editor. -.PP - -.TP -Introduction and Concepts -.TP -Using QTextEdit as a Display Widget -.TP -Read-only key bindings -.TP -Using QTextEdit in LogText Mode -.TP -Using QTextEdit as an Editor -.TP - Editing key bindings - -.SH "Introduction and Concepts" -QTextEdit is an advanced WYSIWYG viewer/editor supporting rich text formatting using HTML-style tags. It is optimized to handle large documents and to respond quickly to user input. -.PP -QTextEdit has four modes of operation:
                                                                  .nf -.TS -l - l. Mode Command Notes Plain Text Editor setTextFormat(PlainText) Set text with setText(); text() returns plain text. Text attributes (e.g. colors) can be set, but plain text is always returned. Rich Text Editor setTextFormat(RichText) Set text with setText(); text() returns rich text. Rich text editing is fairly limited. You can't set margins or insert images for example (although you can read and correctly display files that have margins set and that include images). This mode is mostly useful for editing small amounts of rich text. Text Viewer setReadOnly(TRUE) Set text with setText() or append() (which has no undo history so is faster and uses less memory); text() returns plain or rich text depending on the textFormat(). This mode can correctly display a large subset of HTML tags. Log Viewer setTextFormat(LogText) -.TE -.fi -
                                                                  -.PP -1.A more complete API that supports setting margins, images, etc., is planned for a later Qt release. -.PP -QTextEdit can be used as a syntax highlighting editor when used in conjunction with QSyntaxHighlighter. -.PP -We recommend that you always call setTextFormat() to set the mode you want to use. If you use AutoText then setText() and append() will try to determine whether the text they are given is plain text or rich text. If you use RichText then setText() and append() will assume that the text they are given is rich text. insert() simply inserts the text it is given. -.PP -QTextEdit works on paragraphs and characters. A paragraph is a formatted string which is word-wrapped to fit into the width of the widget. By default when reading plain text, one newline signify a paragraph. A document consists of zero or more paragraphs, indexed from 0. Characters are indexed on a per-paragraph basis, also indexed from 0. The words in the paragraph are aligned in accordance with the paragraph's alignment(). Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color. -.PP -The text edit documentation uses the following concepts: -.TP -\fIcurrent format\fR -- this is the format at the current cursor position, \fIand\fR it is the format of the selected text if any. -.TP -\fIcurrent paragraph\fR -- the paragraph which contains the cursor. -.PP -QTextEdit can display images (using QMimeSourceFactory), lists and tables. If the text is too large to view within the text edit's viewport, scrollbars will appear. The text edit can load both plain text and HTML files (a subset of HTML 3.2 and 4). The rendering style and the set of valid tags are defined by a styleSheet(). Custom tags can be created and placed in a custom style sheet. Change the style sheet with setStyleSheet(); see QStyleSheet for details. The images identified by image tags are displayed if they can be interpreted using the text edit's QMimeSourceFactory; see setMimeSourceFactory(). -.PP -If you want a text browser with more navigation use QTextBrowser. If you just need to display a small piece of rich text use QLabel or QSimpleRichText. -.PP -If you create a new QTextEdit, and want to allow the user to edit rich text, call setTextFormat(Qt::RichText) to ensure that the text is treated as rich text. (Rich text uses HTML tags to set text formatting attributes. See QStyleSheet for information on the HTML tags that are supported.). If you don't call setTextFormat() explicitly the text edit will guess from the text itself whether it is rich text or plain text. This means that if the text looks like HTML or XML it will probably be interpreted as rich text, so you should call setTextFormat(Qt::PlainText) to preserve such text. -.PP -Note that we do not intend to add a full-featured web browser widget to Qt (because that would easily double Qt's size and only a few applications would benefit from it). The rich text support in Qt is designed to provide a fast, portable and efficient way to add reasonable online help facilities to applications, and to provide a basis for rich text editors. -.SH "Using QTextEdit as a Display Widget" -QTextEdit can display a large HTML subset, including tables and images. -.PP -The text is set or replaced using setText() which deletes any existing text and replaces it with the text passed in the setText() call. If you call setText() with legacy HTML (with setTextFormat(RichText) in force), and then call text(), the text that is returned may have different markup, but will render the same. Text can be inserted with insert(), paste(), pasteSubType() and append(). Text that is appended does not go into the undo history; this makes append() faster and consumes less memory. Text can also be cut(). The entire text is deleted with clear() and the selected text is deleted with removeSelectedText(). Selected (marked) text can also be deleted with del() (which will delete the character to the right of the cursor if no text is selected). -.PP -Loading and saving text is achieved using setText() and text(), for example: -.PP -.nf -.br - QFile file( fileName ); // Read the text from a file -.br - if ( file.open( IO_ReadOnly ) ) { -.br - QTextStream stream( &file ); -.br - textEdit->setText( stream.read() ); -.br - } -.br -.br - QFile file( fileName ); // Write the text to a file -.br - if ( file.open( IO_WriteOnly ) ) { -.br - QTextStream stream( &file ); -.br - stream << textEdit->text(); -.br - textEdit->setModified( FALSE ); -.br - } -.br -.fi -.PP -By default the text edit wraps words at whitespace to fit within the text edit widget. The setWordWrap() function is used to specify the kind of word wrap you want, or NoWrap if you don't want any wrapping. Call setWordWrap() to set a fixed pixel width FixedPixelWidth, or character column (e.g. 80 column) FixedColumnWidth with the pixels or columns specified with setWrapColumnOrWidth(). If you use word wrap to the widget's width WidgetWidth, you can specify whether to break on whitespace or anywhere with setWrapPolicy(). -.PP -The background color is set differently than other widgets, using setPaper(). You specify a brush style which could be a plain color or a complex pixmap. -.PP -Hypertext links are automatically underlined; this can be changed with setLinkUnderline(). The tab stop width is set with setTabStopWidth(). -.PP -The zoomIn() and zoomOut() functions can be used to resize the text by increasing (decreasing for zoomOut()) the point size used. Images are not affected by the zoom functions. -.PP -The lines() function returns the number of lines in the text and paragraphs() returns the number of paragraphs. The number of lines within a particular paragraph is returned by linesOfParagraph(). The length of the entire text in characters is returned by length(). -.PP -You can scroll to an anchor in the text, e.g. \fC\fR with scrollToAnchor(). The find() function can be used to find and select a given string within the text. -.PP -A read-only QTextEdit provides the same functionality as the (obsolete) QTextView. (QTextView is still supplied for compatibility with old code.) -.PP -

                                                                  Read-only key bindings

                                                                  -.PP -When QTextEdit is used read-only the key-bindings are limited to navigation, and text may only be selected with the mouse:
                                                                  .nf -.TS -l - l. Keypresses Action UpArrow Move one line up DownArrow Move one line down LeftArrow Move one character left RightArrow Move one character right PageUp Move one (viewport) page up PageDown Move one (viewport) page down Home Move to the beginning of the text End Move to the end of the text Shift+Wheel Scroll the page horizontally (the Wheel is the mouse wheel) Ctrl+Wheel -.TE -.fi -
                                                                  -.PP -The text edit may be able to provide some meta-information. For example, the documentTitle() function will return the text from within HTML \fC\fR tags. -.PP -The text displayed in a text edit has a \fIcontext\fR. The context is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. It is passed to the mimeSourceFactory() when quering data. (See QTextEdit() and context().) -.PP -<h4> Using QTextEdit in LogText Mode </h4> -.PP -Setting the text format to LogText puts the widget in a special mode which is optimized for very large texts. Editing, word wrap, and rich text support are disabled in this mode (the widget is explicitly made read-only). This allows the text to be stored in a different, more memory efficient manner. However, a certain degree of text formatting is supported through the use of formatting tags. A tag is delimited by \fC<\fR and \fC>\fR. The characters \fC<\fR, \fC>\fR and \fC&\fR are escaped by using \fC<\fR, \fC>\fR and \fC&\fR. A tag pair consists of a left and a right tag (or open/close tags). Left-tags mark the starting point for formatting, while right-tags mark the ending point. A right-tag always start with a \fC/\fR before the tag keyword. For example \fC<b>\fR and \fC</b>\fR are a tag pair. Tags can be nested, but they have to be closed in the same order as they are opened. For example, \fC<b><u></u></b>\fR is valid, while \fC<b><u></b></u>\fR will output an error message. -.PP -By using tags it is possible to change the color, bold, italic and underline settings for a piece of text. A color can be specified by using the HTML font tag \fC<font color=colorname>\fR. The color name can be one of the color names from the X11 color database, or a RGB hex value (e.g \fC#00ff00\fR). Example of valid color tags: \fC<font color=red>\fR, \fC<font color="light blue">\fR, \fC<font color="#223344">\fR. Bold, italic and underline settings can be specified by the tags \fC<b>\fR, \fC<i>\fR and \fC<u>\fR. Note that a tag does not necessarily have to be closed. A valid example: -.PP -.nf -.br - This is <font color=red>red</font> while <b>this</b> is <font color=blue>blue</font>. -.br - <font color=green><font color=yellow>Yellow,</font> and <u>green</u>. -.br -.fi -.PP -Stylesheets can also be used in LogText mode. To create and use a custom tag, you could do the following: -.PP -.nf -.br - QTextEdit * log = new QTextEdit( this ); -.br - log->setTextFormat( Qt::LogText ); -.br - QStyleSheetItem * item = new QStyleSheetItem( log->styleSheet(), "mytag" ); -.br - item->setColor( "red" ); -.br - item->setFontWeight( QFont::Bold ); -.br - item->setFontUnderline( TRUE ); -.br - log->append( "This is a <mytag>custom tag</mytag>!" ); -.br -.fi -Note that only the color, bold, underline and italic attributes of a QStyleSheetItem is used in LogText mode. -.PP -Note that you can use setMaxLogLines() to limit the number of lines the widget can hold in LogText mode. -.PP -There are a few things that you need to be aware of when the widget is in this mode: -.TP -Functions that deal with rich text formatting and cursor movement will not work or return anything valid. -.TP -Lines are equivalent to paragraphs. -.SH "Using QTextEdit as an Editor" -All the information about using QTextEdit as a display widget also applies here. -.PP -The current format's attributes are set with setItalic(), setBold(), setUnderline(), setFamily() (font family), setPointSize(), setColor() and setCurrentFont(). The current paragraph's alignment is set with setAlignment(). -.PP -Use setSelection() to select text. The setSelectionAttributes() function is used to indicate how selected text should be displayed. Use hasSelectedText() to find out if any text is selected. The currently selected text's position is available using getSelection() and the selected text itself is returned by selectedText(). The selection can be copied to the clipboard with copy(), or cut to the clipboard with cut(). It can be deleted with removeSelectedText(). The entire text can be selected (or unselected) using selectAll(). QTextEdit supports multiple selections. Most of the selection functions operate on the default selection, selection 0. If the user presses a non-selecting key, e.g. a cursor key without also holding down Shift, all selections are cleared. -.PP -Set and get the position of the cursor with setCursorPosition() and getCursorPosition() respectively. When the cursor is moved, the signals currentFontChanged(), currentColorChanged() and currentAlignmentChanged() are emitted to reflect the font, color and alignment at the new cursor position. -.PP -If the text changes, the textChanged() signal is emitted, and if the user inserts a new line by pressing Return or Enter, returnPressed() is emitted. The isModified() function will return TRUE if the text has been modified. -.PP -QTextEdit provides command-based undo and redo. To set the depth of the command history use setUndoDepth() which defaults to 100 steps. To undo or redo the last operation call undo() or redo(). The signals undoAvailable() and redoAvailable() indicate whether the undo and redo operations can be executed. -.PP -The indent() function is used to reindent a paragraph. It is useful for code editors, for example in Qt Designer's code editor \fICtrl+I\fR invokes the indent() function. -.PP -<h4> Editing key bindings </h4> -.PP -The list of key-bindings which are implemented for editing: <center>.nf -.TS -l - l. Keypresses Action Backspace Delete the character to the left of the cursor Delete Delete the character to the right of the cursor Ctrl+A Move the cursor to the beginning of the line Ctrl+B Move the cursor one character left Ctrl+C Copy the marked text to the clipboard (also Ctrl+Insert under Windows) Ctrl+D Delete the character to the right of the cursor Ctrl+E Move the cursor to the end of the line Ctrl+F Move the cursor one character right Ctrl+H Delete the character to the left of the cursor Ctrl+K Delete to end of line Ctrl+N Move the cursor one line down Ctrl+P Move the cursor one line up Ctrl+V Paste the clipboard text into line edit (also Shift+Insert under Windows) Ctrl+X Cut the marked text, copy to clipboard (also Shift+Delete under Windows) Ctrl+Z Undo the last operation Ctrl+Y Redo the last operation LeftArrow Move the cursor one character left Ctrl+LeftArrow Move the cursor one word left RightArrow Move the cursor one character right Ctrl+RightArrow Move the cursor one word right UpArrow Move the cursor one line up Ctrl+UpArrow Move the cursor one word up DownArrow Move the cursor one line down Ctrl+Down Arrow Move the cursor one word down PageUp Move the cursor one page up PageDown Move the cursor one page down Home Move the cursor to the beginning of the line Ctrl+Home Move the cursor to the beginning of the text End Move the cursor to the end of the line Ctrl+End Move the cursor to the end of the text Shift+Wheel Scroll the page horizontally (the Wheel is the mouse wheel) Ctrl+Wheel -.TE -.fi -</center> -.PP -To select (mark) text hold down the Shift key whilst pressing one of the movement keystrokes, for example, \fIShift+Right Arrow\fR will select the character to the right, and \fIShift+Ctrl+Right Arrow\fR will select the word to the right, etc. -.PP -By default the text edit widget operates in insert mode so all text that the user enters is inserted into the text edit and any text to the right of the cursor is moved out of the way. The mode can be changed to overwrite, where new text overwrites any text to the right of the cursor, using setOverwriteMode(). -.PP -See also Basic Widgets and Text Related Classes. -.SS "Member Type Documentation" -.SH "QTextEdit::AutoFormatting" -.TP -\fCQTextEdit::AutoNone\fR - Do not perform any automatic formatting -.TP -\fCQTextEdit::AutoBulletList\fR - Only automatically format bulletted lists -.TP -\fCQTextEdit::AutoAll\fR - Apply all available autoformatting -.SH "QTextEdit::CursorAction" -This enum is used by moveCursor() to specify in which direction the cursor should be moved: -.TP -\fCQTextEdit::MoveBackward\fR - Moves the cursor one character backward -.TP -\fCQTextEdit::MoveWordBackward\fR - Moves the cursor one word backward -.TP -\fCQTextEdit::MoveForward\fR - Moves the cursor one character forward -.TP -\fCQTextEdit::MoveWordForward\fR - Moves the cursor one word forward -.TP -\fCQTextEdit::MoveUp\fR - Moves the cursor up one line -.TP -\fCQTextEdit::MoveDown\fR - Moves the cursor down one line -.TP -\fCQTextEdit::MoveLineStart\fR - Moves the cursor to the beginning of the line -.TP -\fCQTextEdit::MoveLineEnd\fR - Moves the cursor to the end of the line -.TP -\fCQTextEdit::MoveHome\fR - Moves the cursor to the beginning of the document -.TP -\fCQTextEdit::MoveEnd\fR - Moves the cursor to the end of the document -.TP -\fCQTextEdit::MovePgUp\fR - Moves the cursor one viewport page up -.TP -\fCQTextEdit::MovePgDown\fR - Moves the cursor one viewport page down -.SH "QTextEdit::KeyboardAction" -This enum is used by doKeyboardAction() to specify which action should be executed: -.TP -\fCQTextEdit::ActionBackspace\fR - Delete the character to the left of the cursor. -.TP -\fCQTextEdit::ActionDelete\fR - Delete the character to the right of the cursor. -.TP -\fCQTextEdit::ActionReturn\fR - Split the paragraph at the cursor position. -.TP -\fCQTextEdit::ActionKill\fR - If the cursor is not at the end of the paragraph, delete the text from the cursor position until the end of the paragraph. If the cursor is at the end of the paragraph, delete the hard line break at the end of the paragraph: this will cause this paragraph to be joined with the following paragraph. -.TP -\fCQTextEdit::ActionWordBackspace\fR - Delete the word to the left of the cursor position. -.TP -\fCQTextEdit::ActionWordDelete\fR - Delete the word to the right of the cursor position -.SH "QTextEdit::VerticalAlignment" -This enum is used to set the vertical alignment of the text. -.TP -\fCQTextEdit::AlignNormal\fR - Normal alignment -.TP -\fCQTextEdit::AlignSuperScript\fR - Superscript -.TP -\fCQTextEdit::AlignSubScript\fR - Subscript -.SH "QTextEdit::WordWrap" -This enum defines the QTextEdit's word wrap modes. -.TP -\fCQTextEdit::NoWrap\fR - Do not wrap the text. -.TP -\fCQTextEdit::WidgetWidth\fR - Wrap the text at the current width of the widget (this is the default). Wrapping is at whitespace by default; this can be changed with setWrapPolicy(). -.TP -\fCQTextEdit::FixedPixelWidth\fR - Wrap the text at a fixed number of pixels from the widget's left side. The number of pixels is set with wrapColumnOrWidth(). -.TP -\fCQTextEdit::FixedColumnWidth\fR - Wrap the text at a fixed number of character columns from the widget's left side. The number of characters is set with wrapColumnOrWidth(). This is useful if you need formatted text that can also be displayed gracefully on devices with monospaced fonts, for example a standard VT100 terminal, where you might set wrapColumnOrWidth() to 80. -.PP -See also wordWrap and wordWrap. -.SH "QTextEdit::WrapPolicy" -This enum defines where text can be wrapped in word wrap mode. -.TP -\fCQTextEdit::AtWhiteSpace\fR - Don't use this deprecated value (it is a synonym for AtWordBoundary which you should use instead). -.TP -\fCQTextEdit::Anywhere\fR - Break anywhere, including within words. -.TP -\fCQTextEdit::AtWordBoundary\fR - Break lines at word boundaries, e.g. spaces or newlines -.TP -\fCQTextEdit::AtWordOrDocumentBoundary\fR - Break lines at whitespace, e.g. spaces or newlines if possible. Break it anywhere otherwise. -.PP -See also wrapPolicy. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextEdit::QTextEdit ( const QString & text, const QString & context = QString::null, QWidget * parent = 0, const char * name = 0 )" -Constructs a QTextEdit called \fIname\fR, with parent \fIparent\fR. The text edit will display the text \fItext\fR using context \fIcontext\fR. -.PP -The \fIcontext\fR is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. It is passed to the mimeSourceFactory() when quering data. -.PP -For example if the text contains an image tag, \fC<img src="image.png">\fR, and the context is "path/to/look/in", the QMimeSourceFactory will try to load the image from" path/to/look/in/image.png". If the tag was \fC<img src="/image.png">\fR, the context will not be used (because QMimeSourceFactory recognizes that we have used an absolute path) and will try to load "/image.png". The context is applied in exactly the same way to \fIhrefs\fR, for example, \fC<a href="target.html">Target</a>\fR, would resolve to" path/to/look/in/target.html". -.SH "QTextEdit::QTextEdit ( QWidget * parent = 0, const char * name = 0 )" -Constructs an empty QTextEdit called \fIname\fR, with parent \fIparent\fR. -.SH "int QTextEdit::alignment () const" -Returns the alignment of the current paragraph. -.PP -See also setAlignment(). -.SH "QString QTextEdit::anchorAt ( const QPoint & pos, AnchorAttribute attr )" -If there is an anchor at position \fIpos\fR (in contents coordinates), the text for attribute \fIattr\fR is returned, otherwise QString::null is returned. -.SH "QString QTextEdit::anchorAt ( const QPoint & pos )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -If there is an anchor at position \fIpos\fR (in contents coordinates), its \fChref\fR is returned, otherwise QString::null is returned. -.SH "void QTextEdit::append ( const QString & text )\fC [virtual slot]\fR" -Appends a new paragraph with \fItext\fR to the end of the text edit. Note that the undo/redo history is cleared by this function, and no undo history is kept for appends which makes them faster than insert()s. If you want to append text which is added to the undo/redo history as well, use insertParagraph(). -.PP -Examples: -.)l network/clientserver/client/client.cpp, network/clientserver/server/server.cpp, network/httpd/httpd.cpp, and process/process.cpp. -.SH "uint QTextEdit::autoFormatting () const" -Returns the enabled set of auto formatting features. See the "autoFormatting" property for details. -.SH "bool QTextEdit::bold () const" -Returns TRUE if the current format is bold; otherwise returns FALSE. -.PP -See also setBold(). -.SH "int QTextEdit::charAt ( const QPoint & pos, int * para ) const" -Returns the index of the character (relative to its paragraph) at position \fIpos\fR (in contents coordinates). If \fIpara\fR is not 0, \fI*para\fR is set to the character's paragraph. -.SH "void QTextEdit::clear ()\fC [virtual slot]\fR" -Deletes all the text in the text edit. -.PP -See also cut(), removeSelectedText(), and text. -.SH "void QTextEdit::clearParagraphBackground ( int para )\fC [virtual slot]\fR" -Clears the background color of the paragraph \fIpara\fR, so that the default color is used again. -.SH "void QTextEdit::clicked ( int para, int pos )\fC [signal]\fR" -This signal is emitted when the mouse is clicked on the paragraph \fIpara\fR at character position \fIpos\fR. -.PP -See also doubleClicked(). -.SH "QColor QTextEdit::color () const" -Returns the color of the current format. -.PP -See also setColor() and paper. -.SH "QString QTextEdit::context () const" -Returns the context of the text edit. The context is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. -.PP -See also text. -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qdir/qdir.cpp. -.SH "void QTextEdit::copy ()\fC [virtual slot]\fR" -Copies any selected text (from selection 0) to the clipboard. -.PP -See also hasSelectedText and copyAvailable(). -.SH "void QTextEdit::copyAvailable ( bool yes )\fC [signal]\fR" -This signal is emitted when text is selected or de-selected in the text edit. -.PP -When text is selected this signal will be emitted with \fIyes\fR set to TRUE. If no text has been selected or if the selected text is de-selected this signal is emitted with \fIyes\fR set to FALSE. -.PP -If \fIyes\fR is TRUE then copy() can be used to copy the selection to the clipboard. If \fIyes\fR is FALSE then copy() does nothing. -.PP -See also selectionChanged(). -.SH "QPopupMenu * QTextEdit::createPopupMenu ( const QPoint & pos )\fC [virtual protected]\fR" -This function is called to create a right mouse button popup menu at the document position \fIpos\fR. If you want to create a custom popup menu, reimplement this function and return the created popup menu. Ownership of the popup menu is transferred to the caller. -.PP -\fBWarning:\fR The QPopupMenu ID values 0-7 are reserved, and they map to the standard operations. When inserting items into your custom popup menu, be sure to specify ID values larger than 7. -.SH "QPopupMenu * QTextEdit::createPopupMenu ()\fC [virtual protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function is called to create a right mouse button popup menu. If you want to create a custom popup menu, reimplement this function and return the created popup menu. Ownership of the popup menu is transferred to the caller. -.PP -This function is only called if createPopupMenu( const QPoint & ) returns 0. -.SH "void QTextEdit::currentAlignmentChanged ( int a )\fC [signal]\fR" -This signal is emitted if the alignment of the current paragraph has changed. -.PP -The new alignment is \fIa\fR. -.PP -See also setAlignment(). -.SH "void QTextEdit::currentColorChanged ( const QColor & c )\fC [signal]\fR" -This signal is emitted if the color of the current format has changed. -.PP -The new color is \fIc\fR. -.PP -See also setColor(). -.SH "QFont QTextEdit::currentFont () const" -Returns the font of the current format. -.PP -See also setCurrentFont(), setFamily(), and setPointSize(). -.SH "void QTextEdit::currentFontChanged ( const QFont & f )\fC [signal]\fR" -This signal is emitted if the font of the current format has changed. -.PP -The new font is \fIf\fR. -.PP -See also setCurrentFont(). -.SH "void QTextEdit::currentVerticalAlignmentChanged ( VerticalAlignment a )\fC [signal]\fR" -This signal is emitted if the vertical alignment of the current format has changed. -.PP -The new vertical alignment is \fIa\fR. -.PP -See also setVerticalAlignment(). -.SH "void QTextEdit::cursorPositionChanged ( int para, int pos )\fC [signal]\fR" -This signal is emitted if the position of the cursor has changed. \fIpara\fR contains the paragraph index and \fIpos\fR contains the character position within the paragraph. -.PP -See also setCursorPosition(). -.SH "void QTextEdit::cut ()\fC [virtual slot]\fR" -Copies the selected text (from selection 0) to the clipboard and deletes it from the text edit. -.PP -If there is no selected text (in selection 0) nothing happens. -.PP -See also QTextEdit::copy(), paste(), and pasteSubType(). -.SH "void QTextEdit::del ()\fC [virtual slot]\fR" -If there is some selected text (in selection 0) it is deleted. If there is no selected text (in selection 0) the character to the right of the text cursor is deleted. -.PP -See also removeSelectedText() and cut(). -.SH "void QTextEdit::doKeyboardAction ( KeyboardAction action )\fC [virtual slot]\fR" -Executes keyboard action \fIaction\fR. This is normally called by a key event handler. -.SH "QString QTextEdit::documentTitle () const" -Returns the title of the document parsed from the text. See the "documentTitle" property for details. -.SH "void QTextEdit::doubleClicked ( int para, int pos )\fC [signal]\fR" -This signal is emitted when the mouse is double-clicked on the paragraph \fIpara\fR at character position \fIpos\fR. -.PP -See also clicked(). -.SH "void QTextEdit::ensureCursorVisible ()\fC [virtual slot]\fR" -Ensures that the cursor is visible by scrolling the text edit if necessary. -.PP -See also setCursorPosition(). -.SH "QString QTextEdit::family () const" -Returns the font family of the current format. -.PP -See also setFamily(), setCurrentFont(), and setPointSize(). -.SH "bool QTextEdit::find ( const QString & expr, bool cs, bool wo, bool forward = TRUE, int * para = 0, int * index = 0 )\fC [virtual]\fR" -Finds the next occurrence of the string, \fIexpr\fR. Returns TRUE if \fIexpr\fR was found; otherwise returns FALSE. -.PP -If \fIpara\fR and \fIindex\fR are both 0 the search begins from the current cursor position. If \fIpara\fR and \fIindex\fR are both not 0, the search begins from the \fI*index\fR character position in the \fI*para\fR paragraph. -.PP -If \fIcs\fR is TRUE the search is case sensitive, otherwise it is case insensitive. If \fIwo\fR is TRUE the search looks for whole word matches only; otherwise it searches for any matching text. If \fIforward\fR is TRUE (the default) the search works forward from the starting position to the end of the text, otherwise it works backwards to the beginning of the text. -.PP -If \fIexpr\fR is found the function returns TRUE. If \fIindex\fR and \fIpara\fR are not 0, the number of the paragraph in which the first character of the match was found is put into \fI*para\fR, and the index position of that character within the paragraph is put into \fI*index\fR. -.PP -If \fIexpr\fR is not found the function returns FALSE. If \fIindex\fR and \fIpara\fR are not 0 and \fIexpr\fR is not found, \fI*index\fR and \fI*para\fR are undefined. -.PP -Please note that this function will make the next occurrence of the string (if found) the current selection, and will thus modify the cursor position. -.PP -Using the \fIpara\fR and \fIindex\fR parameters will not work correctly in case the document contains tables. -.SH "bool QTextEdit::focusNextPrevChild ( bool n )\fC [virtual protected]\fR" -Reimplemented to allow tabbing through links. If \fIn\fR is TRUE the tab moves the focus to the next child; if \fIn\fR is FALSE the tab moves the focus to the previous child. Returns TRUE if the focus was moved; otherwise returns FALSE. -.SH "QFont QTextEdit::font () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns QScrollView::font() -.PP -\fBWarning:\fR In previous versions this function returned the font of the current format. This lead to confusion. Please use currentFont() instead. -.PP -Example: qwerty/qwerty.cpp. -.SH "void QTextEdit::getCursorPosition ( int * para, int * index ) const" -This function sets the \fI*para\fR and \fI*index\fR parameters to the current cursor position. \fIpara\fR and \fIindex\fR must not be 0. -.PP -See also setCursorPosition(). -.SH "void QTextEdit::getSelection ( int * paraFrom, int * indexFrom, int * paraTo, int * indexTo, int selNum = 0 ) const" -If there is a selection, \fI*paraFrom\fR is set to the number of the paragraph in which the selection begins and \fI*paraTo\fR is set to the number of the paragraph in which the selection ends. (They could be the same.) \fI*indexFrom\fR is set to the index at which the selection begins within \fI*paraFrom\fR, and \fI*indexTo\fR is set to the index at which the selection ends within \fI*paraTo\fR. -.PP -If there is no selection, \fI*paraFrom\fR, \fI*indexFrom\fR, \fI*paraTo\fR and \fI*indexTo\fR are all set to -1. -.PP -If \fIparaFrom\fR, \fIindexFrom\fR, \fIparaTo\fR or \fIindexTo\fR is 0 this function does nothing. -.PP -The \fIselNum\fR is the number of the selection (multiple selections are supported). It defaults to 0 (the default selection). -.PP -See also setSelection() and selectedText. -.SH "bool QTextEdit::hasSelectedText () const" -Returns TRUE if some text is selected in selection 0; otherwise returns FALSE. See the "hasSelectedText" property for details. -.SH "int QTextEdit::heightForWidth ( int w ) const\fC [virtual]\fR" -Returns how many pixels high the text edit needs to be to display all the text if the text edit is \fIw\fR pixels wide. -.PP -Reimplemented from QWidget. -.SH "void QTextEdit::insert ( const QString & text, uint insertionFlags = CheckNewLines | RemoveSelected )\fC [slot]\fR" -Inserts \fItext\fR at the current cursor position. -.PP -The \fIinsertionFlags\fR define how the text is inserted. If RedoIndentation is set, the paragraph is re-indented. If CheckNewLines is set, newline characters in \fItext\fR result in hard line breaks (i.e. new paragraphs). If \fCcheckNewLine\fR is not set, the behaviour of the editor is undefined if the \fItext\fR contains newlines. (It is not possible to change QTextEdit's newline handling behavior, but you can use QString::replace() to preprocess text before inserting it.) If RemoveSelected is set, any selected text (in selection 0) is removed before the text is inserted. -.PP -The default flags are CheckNewLines | RemoveSelected. -.PP -If the widget is in LogText mode this function will do nothing. -.PP -See also paste() and pasteSubType(). -.SH "void QTextEdit::insert ( const QString & text, bool indent, bool checkNewLine = TRUE, bool removeSelected = TRUE )\fC [virtual slot]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QTextEdit::insertAt ( const QString & text, int para, int index )\fC [virtual slot]\fR" -Inserts \fItext\fR in the paragraph \fIpara\fR at position \fIindex\fR. -.SH "void QTextEdit::insertParagraph ( const QString & text, int para )\fC [virtual slot]\fR" -Inserts \fItext\fR as a new paragraph at position \fIpara\fR. If \fIpara\fR is -1, the text is appended. Use append() if the append operation is performance critical. -.SH "bool QTextEdit::isModified () const" -Returns TRUE if the document has been modified by the user; otherwise returns FALSE. See the "modified" property for details. -.SH "bool QTextEdit::isOverwriteMode () const" -Returns the text edit's overwrite mode. See the "overwriteMode" property for details. -.SH "bool QTextEdit::isReadOnly () const" -Returns TRUE if the text edit is read-only; otherwise returns FALSE. See the "readOnly" property for details. -.SH "bool QTextEdit::isRedoAvailable () const" -Returns TRUE if redo is available; otherwise returns FALSE. -.SH "bool QTextEdit::isUndoAvailable () const" -Returns TRUE if undo is available; otherwise returns FALSE. -.SH "bool QTextEdit::isUndoRedoEnabled () const" -Returns TRUE if undo/redo is enabled; otherwise returns FALSE. See the "undoRedoEnabled" property for details. -.SH "bool QTextEdit::italic () const" -Returns TRUE if the current format is italic; otherwise returns FALSE. -.PP -See also setItalic(). -.SH "void QTextEdit::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" -Processes the key event, \fIe\fR. By default key events are used to provide keyboard navigation and text editing. -.PP -Reimplemented from QWidget. -.PP -Reimplemented in QTextBrowser. -.SH "int QTextEdit::length () const" -Returns the number of characters in the text. See the "length" property for details. -.SH "int QTextEdit::lineOfChar ( int para, int index )" -Returns the line number of the line in paragraph \fIpara\fR in which the character at position \fIindex\fR appears. The \fIindex\fR position is relative to the beginning of the paragraph. If there is no such paragraph or no such character at the \fIindex\fR position (e.g. the index is out of range) -1 is returned. -.SH "int QTextEdit::lines () const" -Returns the number of lines in the text edit; this could be 0. -.PP -\fBWarning:\fR This function may be slow. Lines change all the time during word wrapping, so this function has to iterate over all the paragraphs and get the number of lines from each one individually. -.SH "int QTextEdit::linesOfParagraph ( int para ) const" -Returns the number of lines in paragraph \fIpara\fR, or -1 if there is no paragraph with index \fIpara\fR. -.SH "bool QTextEdit::linkUnderline () const" -Returns TRUE if hypertext links will be underlined; otherwise returns FALSE. See the "linkUnderline" property for details. -.SH "int QTextEdit::maxLogLines ()\fC [slot]\fR" -Returns the maximum number of lines QTextEdit can hold in LogText mode. By default the number of lines is unlimited, which is signified by a value of -1. -.SH "QMimeSourceFactory * QTextEdit::mimeSourceFactory () const" -Returns the QMimeSourceFactory which is being used by this text edit. -.PP -See also setMimeSourceFactory(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qdir/qdir.cpp. -.SH "void QTextEdit::modificationChanged ( bool m )\fC [signal]\fR" -This signal is emitted when the modification status of the document has changed. If \fIm\fR is TRUE, the document was modified, otherwise the modification state has been reset to unmodified. -.PP -See also modified. -.SH "void QTextEdit::moveCursor ( CursorAction action, bool select )\fC [virtual slot]\fR" -Moves the text cursor according to \fIaction\fR. This is normally used by some key event handler. \fIselect\fR specifies whether the text between the current cursor position and the new position should be selected. -.SH "QBrush QTextEdit::paper () const" -Returns the background (paper) brush. See the "paper" property for details. -.SH "int QTextEdit::paragraphAt ( const QPoint & pos ) const" -Returns the paragraph which is at position \fIpos\fR (in contents coordinates). -.SH "QColor QTextEdit::paragraphBackgroundColor ( int para ) const" -Returns the background color of the paragraph \fIpara\fR or an invalid color if \fIpara\fR is out of range or the paragraph has no background set -.SH "int QTextEdit::paragraphLength ( int para ) const" -Returns the length of the paragraph \fIpara\fR (i.e. the number of characters), or -1 if there is no paragraph with index \fIpara\fR. -.PP -This function ignores newlines. -.SH "QRect QTextEdit::paragraphRect ( int para ) const" -Returns the rectangle of the paragraph \fIpara\fR in contents coordinates, or an invalid rectangle if \fIpara\fR is out of range. -.SH "int QTextEdit::paragraphs () const" -Returns the number of paragraphs in the text; an empty textedit is always considered to have one paragraph, so 1 is returned in this case. -.SH "void QTextEdit::paste ()\fC [virtual slot]\fR" -Pastes the text from the clipboard into the text edit at the current cursor position. Only plain text is pasted. -.PP -If there is no text in the clipboard nothing happens. -.PP -See also pasteSubType(), cut(), and QTextEdit::copy(). -.SH "void QTextEdit::pasteSubType ( const QCString & subtype )\fC [virtual slot]\fR" -Pastes the text with format \fIsubtype\fR from the clipboard into the text edit at the current cursor position. The \fIsubtype\fR can be" plain" or "html". -.PP -If there is no text with format \fIsubtype\fR in the clipboard nothing happens. -.PP -See also paste(), cut(), and QTextEdit::copy(). -.SH "void QTextEdit::placeCursor ( const QPoint & pos, QTextCursor * c = 0 )\fC [virtual slot]\fR" -Places the cursor \fIc\fR at the character which is closest to position \fIpos\fR (in contents coordinates). If \fIc\fR is 0, the default text cursor is used. -.PP -See also setCursorPosition(). -.SH "int QTextEdit::pointSize () const" -Returns the point size of the font of the current format. -.PP -See also setFamily(), setCurrentFont(), and setPointSize(). -.SH "void QTextEdit::redo ()\fC [virtual slot]\fR" -Redoes the last operation. -.PP -If there is no operation to redo, i.e. there is no redo step in the undo/redo history, nothing happens. -.PP -See also redoAvailable(), undo(), and undoDepth. -.SH "void QTextEdit::redoAvailable ( bool yes )\fC [signal]\fR" -This signal is emitted when the availability of redo changes. If \fIyes\fR is TRUE, then redo() will work until redoAvailable( FALSE ) is next emitted. -.PP -See also redo() and undoDepth. -.SH "void QTextEdit::removeParagraph ( int para )\fC [virtual slot]\fR" -Removes the paragraph \fIpara\fR. -.SH "void QTextEdit::removeSelectedText ( int selNum = 0 )\fC [virtual slot]\fR" -Deletes the text of selection \fIselNum\fR (by default, the default selection, 0). If there is no selected text nothing happens. -.PP -See also selectedText and removeSelection(). -.SH "void QTextEdit::removeSelection ( int selNum = 0 )\fC [virtual slot]\fR" -Removes the selection \fIselNum\fR (by default 0). This does not remove the selected text. -.PP -See also removeSelectedText(). -.SH "void QTextEdit::repaintChanged ()\fC [protected]\fR" -Repaints any paragraphs that have changed. -.PP -Although used extensively internally you shouldn't need to call this yourself. -.SH "void QTextEdit::returnPressed ()\fC [signal]\fR" -This signal is emitted if the user pressed the Return or the Enter key. -.SH "void QTextEdit::scrollToAnchor ( const QString & name )\fC [virtual slot]\fR" -Scrolls the text edit to make the text at the anchor called \fIname\fR visible, if it can be found in the document. If the anchor isn't found no scrolling will occur. An anchor is defined using the HTML anchor tag, e.g. \fC<a name="target">\fR. -.SH "void QTextEdit::scrollToBottom ()\fC [virtual slot]\fR" -Scrolls to the bottom of the document and does formatting if required. -.SH "void QTextEdit::selectAll ( bool select = TRUE )\fC [virtual slot]\fR" -If \fIselect\fR is TRUE (the default), all the text is selected as selection 0. If \fIselect\fR is FALSE any selected text is unselected, i.e. the default selection (selection 0) is cleared. -.PP -See also selectedText. -.SH "QString QTextEdit::selectedText () const" -Returns the selected text (from selection 0) or an empty string if there is no currently selected text (in selection 0). See the "selectedText" property for details. -.SH "void QTextEdit::selectionChanged ()\fC [signal]\fR" -This signal is emitted whenever the selection changes. -.PP -See also setSelection() and copyAvailable(). -.SH "void QTextEdit::setAlignment ( int a )\fC [virtual slot]\fR" -Sets the alignment of the current paragraph to \fIa\fR. Valid alignments are Qt::AlignLeft, Qt::AlignRight, Qt::AlignJustify and Qt::AlignCenter (which centers horizontally). -.PP -Reimplemented in QMultiLineEdit. -.SH "void QTextEdit::setAutoFormatting ( uint features )" -Sets the enabled set of auto formatting features to \fIfeatures\fR. See the "autoFormatting" property for details. -.SH "void QTextEdit::setBold ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE sets the current format to bold; otherwise sets the current format to non-bold. -.PP -See also bold(). -.SH "void QTextEdit::setColor ( const QColor & c )\fC [virtual slot]\fR" -Sets the color of the current format, i.e. of the text, to \fIc\fR. -.PP -See also color() and paper. -.SH "void QTextEdit::setCurrentFont ( const QFont & f )\fC [virtual slot]\fR" -Sets the font of the current format to \fIf\fR. -.PP -If the widget is in LogText mode this function will do nothing. Use setFont() instead. -.PP -See also currentFont(), setPointSize(), and setFamily(). -.SH "void QTextEdit::setCursorPosition ( int para, int index )\fC [virtual slot]\fR" -Sets the cursor to position \fIindex\fR in paragraph \fIpara\fR. -.PP -See also getCursorPosition(). -.SH "void QTextEdit::setFamily ( const QString & fontFamily )\fC [virtual slot]\fR" -Sets the font family of the current format to \fIfontFamily\fR. -.PP -See also family() and setCurrentFont(). -.SH "void QTextEdit::setItalic ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE sets the current format to italic; otherwise sets the current format to non-italic. -.PP -See also italic(). -.SH "void QTextEdit::setLinkUnderline ( bool )\fC [virtual slot]\fR" -Sets whether hypertext links will be underlined. See the "linkUnderline" property for details. -.SH "void QTextEdit::setMaxLogLines ( int limit )\fC [slot]\fR" -Sets the maximum number of lines a QTextEdit can hold in LogText mode to \fIlimit\fR. If \fIlimit\fR is -1 (the default), this signifies an unlimited number of lines. -.PP -\fBWarning:\fR Never use formatting tags that span more than one line when the maximum log lines is set. When lines are removed from the top of the buffer it could result in an unbalanced tag pair, i.e. the left formatting tag is removed before the right one. -.SH "void QTextEdit::setMimeSourceFactory ( QMimeSourceFactory * factory )\fC [virtual slot]\fR" -Sets the text edit's mimesource factory to \fIfactory\fR. See QMimeSourceFactory for further details. -.PP -See also mimeSourceFactory(). -.SH "void QTextEdit::setModified ( bool m )\fC [virtual slot]\fR" -Sets whether the document has been modified by the user to \fIm\fR. See the "modified" property for details. -.SH "void QTextEdit::setOverwriteMode ( bool b )\fC [virtual slot]\fR" -Sets the text edit's overwrite mode to \fIb\fR. See the "overwriteMode" property for details. -.SH "void QTextEdit::setPaper ( const QBrush & pap )\fC [virtual slot]\fR" -Sets the background (paper) brush to \fIpap\fR. See the "paper" property for details. -.SH "void QTextEdit::setParagraphBackgroundColor ( int para, const QColor & bg )\fC [virtual slot]\fR" -Sets the background color of the paragraph \fIpara\fR to \fIbg\fR. -.SH "void QTextEdit::setPointSize ( int s )\fC [virtual slot]\fR" -Sets the point size of the current format to \fIs\fR. -.PP -Note that if \fIs\fR is zero or negative, the behaviour of this function is not defined. -.PP -See also pointSize(), setCurrentFont(), and setFamily(). -.SH "void QTextEdit::setReadOnly ( bool b )\fC [virtual slot]\fR" -Sets whether the text edit is read-only to \fIb\fR. See the "readOnly" property for details. -.SH "void QTextEdit::setSelection ( int paraFrom, int indexFrom, int paraTo, int indexTo, int selNum = 0 )\fC [virtual slot]\fR" -Sets a selection which starts at position \fIindexFrom\fR in paragraph \fIparaFrom\fR and ends at position \fIindexTo\fR in paragraph \fIparaTo\fR. -.PP -Any existing selections which have a different id (\fIselNum\fR) are left alone, but if an existing selection has the same id as \fIselNum\fR it is removed and replaced by this selection. -.PP -Uses the selection settings of selection \fIselNum\fR. If \fIselNum\fR is 0, this is the default selection. -.PP -The cursor is moved to the end of the selection if \fIselNum\fR is 0, otherwise the cursor position remains unchanged. -.PP -See also getSelection() and selectedText. -.SH "void QTextEdit::setSelectionAttributes ( int selNum, const QColor & back, bool invertText )\fC [virtual slot]\fR" -Sets the background color of selection number \fIselNum\fR to \fIback\fR and specifies whether the text of this selection should be inverted with \fIinvertText\fR. -.PP -This only works for \fIselNum\fR > 0. The default selection (\fIselNum\fR == 0) gets its attributes from the text edit's colorGroup(). -.SH "void QTextEdit::setStyleSheet ( QStyleSheet * styleSheet )\fC [virtual slot]\fR" -Sets the stylesheet to use with this text edit to \fIstyleSheet\fR. Changes will only take effect for new text added with setText() or append(). -.PP -See also styleSheet(). -.SH "void QTextEdit::setTabChangesFocus ( bool b )\fC [slot]\fR" -Sets whether TAB changes focus or is accepted as input to \fIb\fR. See the "tabChangesFocus" property for details. -.SH "void QTextEdit::setTabStopWidth ( int ts )\fC [virtual slot]\fR" -Sets the tab stop width in pixels to \fIts\fR. See the "tabStopWidth" property for details. -.SH "void QTextEdit::setText ( const QString & txt )\fC [slot]\fR" -Sets the text edit's text to \fItxt\fR. See the "text" property for details. -.SH "void QTextEdit::setText ( const QString & text, const QString & context )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Changes the text of the text edit to the string \fItext\fR and the context to \fIcontext\fR. Any previous text is removed. -.PP -\fItext\fR may be interpreted either as plain text or as rich text, depending on the textFormat(). The default setting is AutoText, i.e. the text edit auto-detects the format from \fItext\fR. -.PP -For rich text the rendering style and available tags are defined by a styleSheet(); see QStyleSheet for details. -.PP -The optional \fIcontext\fR is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. (See QTextEdit::QTextEdit().) It is passed to the text edit's QMimeSourceFactory when quering data. -.PP -Note that the undo/redo history is cleared by this function. -.PP -See also text and textFormat. -.SH "void QTextEdit::setTextFormat ( TextFormat f )\fC [virtual slot]\fR" -Sets the text format: rich text, plain text, log text or auto text to \fIf\fR. See the "textFormat" property for details. -.SH "void QTextEdit::setUnderline ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE sets the current format to underline; otherwise sets the current format to non-underline. -.PP -See also underline(). -.SH "void QTextEdit::setUndoDepth ( int d )\fC [virtual slot]\fR" -Sets the depth of the undo history to \fId\fR. See the "undoDepth" property for details. -.SH "void QTextEdit::setUndoRedoEnabled ( bool b )\fC [virtual slot]\fR" -Sets whether undo/redo is enabled to \fIb\fR. See the "undoRedoEnabled" property for details. -.SH "void QTextEdit::setVerticalAlignment ( VerticalAlignment a )\fC [virtual slot]\fR" -Sets the vertical alignment of the current format, i.e. of the text, to \fIa\fR. -.PP -See also color() and paper. -.SH "void QTextEdit::setWordWrap ( WordWrap mode )\fC [virtual slot]\fR" -Sets the word wrap mode to \fImode\fR. See the "wordWrap" property for details. -.SH "void QTextEdit::setWrapColumnOrWidth ( int )\fC [virtual slot]\fR" -Sets the position (in pixels or columns depending on the wrap mode) where text will be wrapped. See the "wrapColumnOrWidth" property for details. -.SH "void QTextEdit::setWrapPolicy ( WrapPolicy policy )\fC [virtual slot]\fR" -Sets the word wrap policy, at whitespace or anywhere to \fIpolicy\fR. See the "wrapPolicy" property for details. -.SH "QStyleSheet * QTextEdit::styleSheet () const" -Returns the QStyleSheet which is being used by this text edit. -.PP -See also setStyleSheet(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "void QTextEdit::sync ()\fC [virtual slot]\fR" -QTextEdit is optimized for large amounts text. One of its optimizations is to format only the visible text, formatting the rest on demand, e.g. as the user scrolls, so you don't usually need to call this function. -.PP -In some situations you may want to force the whole text to be formatted. For example, if after calling setText(), you wanted to know the height of the document (using contentsHeight()), you would call this function first. -.SH "QSyntaxHighlighter * QTextEdit::syntaxHighlighter () const" -Returns the QSyntaxHighlighter set on this QTextEdit. 0 is returned if no syntax highlighter is set. -.SH "bool QTextEdit::tabChangesFocus () const" -Returns TRUE if TAB changes focus or is accepted as input; otherwise returns FALSE. See the "tabChangesFocus" property for details. -.SH "int QTextEdit::tabStopWidth () const" -Returns the tab stop width in pixels. See the "tabStopWidth" property for details. -.SH "QString QTextEdit::text () const" -Returns the text edit's text. See the "text" property for details. -.SH "QString QTextEdit::text ( int para ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the text of paragraph \fIpara\fR. -.PP -If textFormat() is RichText the text will contain HTML formatting tags. -.SH "void QTextEdit::textChanged ()\fC [signal]\fR" -This signal is emitted whenever the text in the text edit changes. -.PP -See also text and append(). -.PP -Examples: -.)l qwerty/qwerty.cpp and rot13/rot13.cpp. -.SH "QTextCursor * QTextEdit::textCursor () const\fC [protected]\fR" -Returns the text edit's text cursor. -.PP -\fBWarning:\fR QTextCursor is not in the public API, but in special circumstances you might wish to use it. -.SH "TextFormat QTextEdit::textFormat () const" -Returns the text format: rich text, plain text, log text or auto text. See the "textFormat" property for details. -.SH "bool QTextEdit::underline () const" -Returns TRUE if the current format is underlined; otherwise returns FALSE. -.PP -See also setUnderline(). -.SH "void QTextEdit::undo ()\fC [virtual slot]\fR" -Undoes the last operation. -.PP -If there is no operation to undo, i.e. there is no undo step in the undo/redo history, nothing happens. -.PP -See also undoAvailable(), redo(), and undoDepth. -.SH "void QTextEdit::undoAvailable ( bool yes )\fC [signal]\fR" -This signal is emitted when the availability of undo changes. If \fIyes\fR is TRUE, then undo() will work until undoAvailable( FALSE ) is next emitted. -.PP -See also undo() and undoDepth. -.SH "int QTextEdit::undoDepth () const" -Returns the depth of the undo history. See the "undoDepth" property for details. -.SH "WordWrap QTextEdit::wordWrap () const" -Returns the word wrap mode. See the "wordWrap" property for details. -.SH "int QTextEdit::wrapColumnOrWidth () const" -Returns the position (in pixels or columns depending on the wrap mode) where text will be wrapped. See the "wrapColumnOrWidth" property for details. -.SH "WrapPolicy QTextEdit::wrapPolicy () const" -Returns the word wrap policy, at whitespace or anywhere. See the "wrapPolicy" property for details. -.SH "void QTextEdit::zoomIn ( int range )\fC [virtual slot]\fR" -Zooms in on the text by making the base font size \fIrange\fR points larger and recalculating all font sizes to be the new size. This does not change the size of any images. -.PP -See also zoomOut(). -.SH "void QTextEdit::zoomIn ()\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Zooms in on the text by making the base font size one point larger and recalculating all font sizes to be the new size. This does not change the size of any images. -.PP -See also zoomOut(). -.SH "void QTextEdit::zoomOut ( int range )\fC [virtual slot]\fR" -Zooms out on the text by making the base font size \fIrange\fR points smaller and recalculating all font sizes to be the new size. This does not change the size of any images. -.PP -See also zoomIn(). -.SH "void QTextEdit::zoomOut ()\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Zooms out on the text by making the base font size one point smaller and recalculating all font sizes to be the new size. This does not change the size of any images. -.PP -See also zoomIn(). -.SH "void QTextEdit::zoomTo ( int size )\fC [virtual slot]\fR" -Zooms the text by making the base font size \fIsize\fR points and recalculating all font sizes to be the new size. This does not change the size of any images. -.SS "Property Documentation" -.SH "AutoFormatting autoFormatting" -This property holds the enabled set of auto formatting features. -.PP -The value can be any combination of the values in the AutoFormatting enum. The default is AutoAll. Choose AutoNone to disable all automatic formatting. -.PP -Currently, the only automatic formatting feature provided is AutoBulletList; future versions of Qt may offer more. -.PP -Set this property's value with setAutoFormatting() and get this property's value with autoFormatting(). -.SH "QString documentTitle" -This property holds the title of the document parsed from the text. -.PP -For PlainText the title will be an empty string. For RichText the title will be the text between the \fC<title>\fR tags, if present, otherwise an empty string. -.PP -Get this property's value with documentTitle(). -.SH "bool hasSelectedText" -This property holds whether some text is selected in selection 0. -.PP -Get this property's value with hasSelectedText(). -.SH "int length" -This property holds the number of characters in the text. -.PP -Get this property's value with length(). -.SH "bool linkUnderline" -This property holds whether hypertext links will be underlined. -.PP -If TRUE (the default) hypertext links will be displayed underlined. If FALSE links will not be displayed underlined. -.PP -Set this property's value with setLinkUnderline() and get this property's value with linkUnderline(). -.SH "bool modified" -This property holds whether the document has been modified by the user. -.PP -Set this property's value with setModified() and get this property's value with isModified(). -.SH "bool overwriteMode" -This property holds the text edit's overwrite mode. -.PP -If FALSE (the default) characters entered by the user are inserted with any characters to the right being moved out of the way. If TRUE, the editor is in overwrite mode, i.e. characters entered by the user overwrite any characters to the right of the cursor position. -.PP -Set this property's value with setOverwriteMode() and get this property's value with isOverwriteMode(). -.SH "QBrush paper" -This property holds the background (paper) brush. -.PP -The brush that is currently used to draw the background of the text edit. The initial setting is an empty brush. -.PP -Set this property's value with setPaper() and get this property's value with paper(). -.SH "bool readOnly" -This property holds whether the text edit is read-only. -.PP -In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible. -.PP -This property's default is FALSE. -.PP -Set this property's value with setReadOnly() and get this property's value with isReadOnly(). -.SH "QString selectedText" -This property holds the selected text (from selection 0) or an empty string if there is no currently selected text (in selection 0). -.PP -The text is always returned as PlainText if the textFormat() is PlainText or AutoText, otherwise it is returned as HTML. -.PP -See also hasSelectedText. -.PP -Get this property's value with selectedText(). -.SH "bool tabChangesFocus" -This property holds whether TAB changes focus or is accepted as input. -.PP -In some occasions text edits should not allow the user to input tabulators or change indentation using the TAB key, as this breaks the focus chain. The default is FALSE. -.PP -Set this property's value with setTabChangesFocus() and get this property's value with tabChangesFocus(). -.SH "int tabStopWidth" -This property holds the tab stop width in pixels. -.PP -Set this property's value with setTabStopWidth() and get this property's value with tabStopWidth(). -.SH "QString text" -This property holds the text edit's text. -.PP -There is no default text. -.PP -On setting, any previous text is deleted. -.PP -The text may be interpreted either as plain text or as rich text, depending on the textFormat(). The default setting is AutoText, i.e. the text edit auto-detects the format of the text. -.PP -For richtext, calling text() on an editable QTextEdit will cause the text to be regenerated from the textedit. This may mean that the QString returned may not be exactly the same as the one that was set. -.PP -See also textFormat. -.PP -Set this property's value with setText() and get this property's value with text(). -.SH "TextFormat textFormat" -This property holds the text format: rich text, plain text, log text or auto text. -.PP -The text format is one of the following: -.TP -PlainText - all characters, except newlines, are displayed verbatim, including spaces. Whenever a newline appears in the text the text edit inserts a hard line break and begins a new paragraph. -.TP -RichText - rich text rendering. The available styles are defined in the default stylesheet QStyleSheet::defaultSheet(). -.TP -LogText - optimized mode for very large texts. Supports a very limited set of formatting tags (color, bold, underline and italic settings). -.TP -AutoText - this is the default. The text edit autodetects which rendering style is best, PlainText or RichText. This is done by using the QStyleSheet::mightBeRichText() function. -.PP -Set this property's value with setTextFormat() and get this property's value with textFormat(). -.SH "int undoDepth" -This property holds the depth of the undo history. -.PP -The maximum number of steps in the undo/redo history. The default is 100. -.PP -See also undo() and redo(). -.PP -Set this property's value with setUndoDepth() and get this property's value with undoDepth(). -.SH "bool undoRedoEnabled" -This property holds whether undo/redo is enabled. -.PP -When changing this property, the undo/redo history is cleared. -.PP -The default is TRUE. -.PP -Set this property's value with setUndoRedoEnabled() and get this property's value with isUndoRedoEnabled(). -.SH "WordWrap wordWrap" -This property holds the word wrap mode. -.PP -The default mode is WidgetWidth which causes words to be wrapped at the right edge of the text edit. Wrapping occurs at whitespace, keeping whole words intact. If you want wrapping to occur within words use setWrapPolicy(). If you set a wrap mode of FixedPixelWidth or FixedColumnWidth you should also call setWrapColumnOrWidth() with the width you want. -.PP -See also WordWrap, wrapColumnOrWidth, and wrapPolicy. -.PP -Set this property's value with setWordWrap() and get this property's value with wordWrap(). -.SH "int wrapColumnOrWidth" -This property holds the position (in pixels or columns depending on the wrap mode) where text will be wrapped. -.PP -If the wrap mode is FixedPixelWidth, the value is the number of pixels from the left edge of the text edit at which text should be wrapped. If the wrap mode is FixedColumnWidth, the value is the column number (in character columns) from the left edge of the text edit at which text should be wrapped. -.PP -See also wordWrap. -.PP -Set this property's value with setWrapColumnOrWidth() and get this property's value with wrapColumnOrWidth(). -.SH "WrapPolicy wrapPolicy" -This property holds the word wrap policy, at whitespace or anywhere. -.PP -Defines where text can be wrapped when word wrap mode is not NoWrap. The choices are AtWordBoundary (the default), Anywhere and AtWordOrDocumentBoundary -.PP -See also wordWrap. -.PP -Set this property's value with setWrapPolicy() and get this property's value with wrapPolicy(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtextedit.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextedit.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextencoder.3qt b/doc/man/man3/qtextencoder.3qt deleted file mode 100644 index 28e369d8e..000000000 --- a/doc/man/man3/qtextencoder.3qt +++ /dev/null @@ -1,65 +0,0 @@ -'\" t -.TH QTextEncoder 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 -QTextEncoder \- State-based encoder -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqtextcodec.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual \fB~QTextEncoder\fR ()" -.br -.ti -1c -.BI "virtual QCString \fBfromUnicode\fR ( const QString & uc, int & lenInOut ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QTextEncoder class provides a state-based encoder. -.PP -The encoder converts Unicode into another format, remembering any state that is required between calls. -.PP -See also QTextCodec::makeEncoder() and Internationalization with Qt. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextEncoder::~QTextEncoder ()\fC [virtual]\fR" -Destroys the encoder. -.SH "QCString QTextEncoder::fromUnicode ( const QString & uc, int & lenInOut )\fC [pure virtual]\fR" -Converts \fIlenInOut\fR characters (not bytes) from \fIuc\fR, producing a QCString. \fIlenInOut\fR will be set to the length of the result (in bytes). -.PP -The encoder is free to record state to use when subsequent calls -are made to this function (for example, it might change modes with -escape sequences if needed during the encoding of one string, then -assume that mode applies when a subsequent call begins). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtextencoder.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextencoder.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextistream.3qt b/doc/man/man3/qtextistream.3qt deleted file mode 100644 index 07c62e38b..000000000 --- a/doc/man/man3/qtextistream.3qt +++ /dev/null @@ -1,79 +0,0 @@ -'\" t -.TH QTextIStream 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 -QTextIStream \- Convenience class for input streams -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqtextstream.h>\fR -.PP -Inherits QTextStream. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTextIStream\fR ( const QString * s )" -.br -.ti -1c -.BI "\fBQTextIStream\fR ( QByteArray ba )" -.br -.ti -1c -.BI "\fBQTextIStream\fR ( FILE * f )" -.br -.in -1c -.SH DESCRIPTION -The QTextIStream class is a convenience class for input streams. -.PP -This class provides a shorthand for creating simple input QTextStreams without having to pass a \fImode\fR argument to the constructor. -.PP -This class makes it easy, for example, to write things like this: -.PP -.nf -.br - QString data = "123 456"; -.br - int a, b; -.br - QTextIStream(&data) >> a >> b; -.br -.fi -.PP -See also QTextOStream, Input/Output and Networking, and Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextIStream::QTextIStream ( const QString * s )" -Constructs a stream to read from the string \fIs\fR. -.SH "QTextIStream::QTextIStream ( QByteArray ba )" -Constructs a stream to read from the array \fIba\fR. -.SH "QTextIStream::QTextIStream ( FILE * f )" -Constructs a stream to read from the file \fIf\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtextistream.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextistream.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextostream.3qt b/doc/man/man3/qtextostream.3qt deleted file mode 100644 index 65173391d..000000000 --- a/doc/man/man3/qtextostream.3qt +++ /dev/null @@ -1,77 +0,0 @@ -'\" t -.TH QTextOStream 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 -QTextOStream \- Convenience class for output streams -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqtextstream.h>\fR -.PP -Inherits QTextStream. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTextOStream\fR ( QString * s )" -.br -.ti -1c -.BI "\fBQTextOStream\fR ( QByteArray ba )" -.br -.ti -1c -.BI "\fBQTextOStream\fR ( FILE * f )" -.br -.in -1c -.SH DESCRIPTION -The QTextOStream class is a convenience class for output streams. -.PP -This class provides a shorthand for creating simple output QTextStreams without having to pass a \fImode\fR argument to the constructor. -.PP -This makes it easy for example, to write things like this: -.PP -.nf -.br - QString result; -.br - QTextOStream(&result) << "pi = " << 3.14; -.br -.fi -.PP -See also Input/Output and Networking and Text Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextOStream::QTextOStream ( QString * s )" -Constructs a stream to write to string \fIs\fR. -.SH "QTextOStream::QTextOStream ( QByteArray ba )" -Constructs a stream to write to the array \fIba\fR. -.SH "QTextOStream::QTextOStream ( FILE * f )" -Constructs a stream to write to the file \fIf\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtextostream.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextostream.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtextstream.3qt b/doc/man/man3/qtextstream.3qt deleted file mode 100644 index 102b20316..000000000 --- a/doc/man/man3/qtextstream.3qt +++ /dev/null @@ -1,642 +0,0 @@ -'\" t -.TH QTextStream 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 -QTextStream \- Basic functions for reading and writing text using a QIODevice -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqtextstream.h>\fR -.PP -Inherited by QTextIStream and QTextOStream. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBEncoding\fR { Locale, Latin1, Unicode, UnicodeNetworkOrder, UnicodeReverse, RawUnicode, UnicodeUTF8 }" -.br -.ti -1c -.BI "void \fBsetEncoding\fR ( Encoding e )" -.br -.ti -1c -.BI "void \fBsetCodec\fR ( QTextCodec * codec )" -.br -.ti -1c -.BI "QTextCodec * \fBcodec\fR ()" -.br -.ti -1c -.BI "\fBQTextStream\fR ()" -.br -.ti -1c -.BI "\fBQTextStream\fR ( QIODevice * iod )" -.br -.ti -1c -.BI "\fBQTextStream\fR ( QString * str, int filemode )" -.br -.ti -1c -.BI "QTextStream ( QString & str, int filemode ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "\fBQTextStream\fR ( QByteArray a, int mode )" -.br -.ti -1c -.BI "\fBQTextStream\fR ( FILE * fh, int mode )" -.br -.ti -1c -.BI "virtual \fB~QTextStream\fR ()" -.br -.ti -1c -.BI "QIODevice * \fBdevice\fR () const" -.br -.ti -1c -.BI "void \fBsetDevice\fR ( QIODevice * iod )" -.br -.ti -1c -.BI "void \fBunsetDevice\fR ()" -.br -.ti -1c -.BI "bool \fBatEnd\fR () const" -.br -.ti -1c -.BI "bool eof () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( QChar & c )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( char & c )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( signed short & i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( unsigned short & i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( signed int & i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( unsigned int & i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( signed long & i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( unsigned long & i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( float & f )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( double & f )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( char * s )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( QString & str )" -.br -.ti -1c -.BI "QTextStream & \fBoperator>>\fR ( QCString & str )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( QChar c )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( char c )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( signed short i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( unsigned short i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( signed int i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( unsigned int i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( signed long i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( unsigned long i )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( float f )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( double f )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( const char * s )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( const QString & s )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( const QCString & s )" -.br -.ti -1c -.BI "QTextStream & \fBoperator<<\fR ( void * ptr )" -.br -.ti -1c -.BI "QTextStream & \fBreadRawBytes\fR ( char * s, uint len )" -.br -.ti -1c -.BI "QTextStream & \fBwriteRawBytes\fR ( const char * s, uint len )" -.br -.ti -1c -.BI "QString \fBreadLine\fR ()" -.br -.ti -1c -.BI "QString \fBread\fR ()" -.br -.ti -1c -.BI "void \fBskipWhiteSpace\fR ()" -.br -.ti -1c -.BI "int \fBflags\fR () const" -.br -.ti -1c -.BI "int \fBflags\fR ( int f )" -.br -.ti -1c -.BI "int \fBsetf\fR ( int bits )" -.br -.ti -1c -.BI "int \fBsetf\fR ( int bits, int mask )" -.br -.ti -1c -.BI "int \fBunsetf\fR ( int bits )" -.br -.ti -1c -.BI "void \fBreset\fR ()" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR ( int w )" -.br -.ti -1c -.BI "int \fBfill\fR () const" -.br -.ti -1c -.BI "int \fBfill\fR ( int f )" -.br -.ti -1c -.BI "int \fBprecision\fR () const" -.br -.ti -1c -.BI "int \fBprecision\fR ( int p )" -.br -.in -1c -.SH DESCRIPTION -The QTextStream class provides basic functions for reading and writing text using a QIODevice. -.PP -The text stream class has a functional interface that is very similar to that of the standard C++ iostream class. -.PP -Qt provides several global functions similar to the ones in iostream: <center>.nf -.TS -l - l. Function Meaning bin sets the QTextStream to read/write binary numbers oct sets the QTextStream to read/write octal numbers dec sets the QTextStream to read/write decimal numbers hex sets the QTextStream to read/write hexadecimal numbers endl forces a line break flush forces the QIODevice to flush any buffered data ws eats any available whitespace (on input) reset resets the QTextStream to its default mode (see reset()) qSetW(int) sets the field width to the given argument qSetFill(int) sets the fill character to the given argument qSetPrecision(int) -.TE -.fi -</center> -.PP -\fBWarning:\fR By default QTextStream will automatically detect whether integers in the stream are in decimal, octal, hexadecimal or binary format when reading from the stream. In particular, a leading '0' signifies octal, i.e. the sequence "0100" will be interpreted as 64. -.PP -The QTextStream class reads and writes text; it is not appropriate for dealing with binary data (but QDataStream is). -.PP -By default, output of Unicode text (i.e. QString) is done using the local 8-bit encoding. This can be changed using the setEncoding() method. For input, the QTextStream will auto-detect standard Unicode "byte order marked" text files; otherwise the local 8-bit encoding is used. -.PP -The QIODevice is set in the constructor, or later using setDevice(). If the end of the input is reached atEnd() returns TRUE. Data can be read into variables of the appropriate type using the operator>>() overloads, or read in its entirety into a single string using read(), or read a line at a time using readLine(). Whitespace can be skipped over using skipWhiteSpace(). You can set flags for the stream using flags() or setf(). The stream also supports width(), precision() and fill(); use reset() to reset the defaults. -.PP -See also QDataStream, Input/Output and Networking, and Text Related Classes. -.SS "Member Type Documentation" -.SH "QTextStream::Encoding" -.TP -\fCQTextStream::Locale\fR -.TP -\fCQTextStream::Latin1\fR -.TP -\fCQTextStream::Unicode\fR -.TP -\fCQTextStream::UnicodeNetworkOrder\fR -.TP -\fCQTextStream::UnicodeReverse\fR -.TP -\fCQTextStream::RawUnicode\fR -.TP -\fCQTextStream::UnicodeUTF8\fR -.PP -See setEncoding() for an explanation of the encodings. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTextStream::QTextStream ()" -Constructs a data stream that has no IO device. -.SH "QTextStream::QTextStream ( QIODevice * iod )" -Constructs a text stream that uses the IO device \fIiod\fR. -.SH "QTextStream::QTextStream ( QString * str, int filemode )" -Constructs a text stream that operates on the Unicode QString, \fIstr\fR, through an internal device. The \fIfilemode\fR argument is passed to the device's open() function; see QIODevice::mode(). -.PP -If you set an encoding or codec with setEncoding() or setCodec(), this setting is ignored for text streams that operate on QString. -.PP -Example: -.PP -.nf -.br - QString str; -.br - QTextStream ts( &str, IO_WriteOnly ); -.br - ts << "pi = " << 3.14; // str == "pi = 3.14" -.br -.fi -.PP -Writing data to the text stream will modify the contents of the string. The string will be expanded when data is written beyond the end of the string. Note that the string will not be truncated: -.PP -.nf -.br - QString str = "pi = 3.14"; -.br - QTextStream ts( &str, IO_WriteOnly ); -.br - ts << "2+2 = " << 2+2; // str == "2+2 = 414" -.br -.fi -.PP -Note that because QString is Unicode, you should not use readRawBytes() or writeRawBytes() on such a stream. -.SH "QTextStream::QTextStream ( QString & str, int filemode )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This constructor is equivalent to the constructor taking a QString* parameter. -.SH "QTextStream::QTextStream ( QByteArray a, int mode )" -Constructs a text stream that operates on the byte array, \fIa\fR, through an internal QBuffer device. The \fImode\fR argument is passed to the device's open() function; see QIODevice::mode(). -.PP -Example: -.PP -.nf -.br - QByteArray array; -.br - QTextStream ts( array, IO_WriteOnly ); -.br - ts << "pi = " << 3.14 << '\\0'; // array == "pi = 3.14" -.br -.fi -.PP -Writing data to the text stream will modify the contents of the array. The array will be expanded when data is written beyond the end of the string. -.PP -Same example, using a QBuffer: -.PP -.nf -.br - QByteArray array; -.br - QBuffer buf( array ); -.br - buf.open( IO_WriteOnly ); -.br - QTextStream ts( &buf ); -.br - ts << "pi = " << 3.14 << '\\0'; // array == "pi = 3.14" -.br - buf.close(); -.br -.fi -.SH "QTextStream::QTextStream ( FILE * fh, int mode )" -Constructs a text stream that operates on an existing file handle \fIfh\fR through an internal QFile device. The \fImode\fR argument is passed to the device's open() function; see QIODevice::mode(). -.PP -Note that if you create a QTextStream \fCcout\fR or another name that is also used for another variable of a different type, some linkers may confuse the two variables, which will often cause crashes. -.SH "QTextStream::~QTextStream ()\fC [virtual]\fR" -Destroys the text stream. -.PP -The destructor does not affect the current IO device. -.SH "bool QTextStream::atEnd () const" -Returns TRUE if the IO device has reached the end position (end of the stream or file) or if there is no IO device set; otherwise returns FALSE. -.PP -See also QIODevice::atEnd(). -.PP -Examples: -.)l addressbook/centralwidget.cpp and grapher/grapher.cpp. -.SH "QTextCodec * QTextStream::codec ()" -Returns the codec actually used for this stream. -.PP -If Unicode is automatically detected in input, a codec with name() "ISO-10646-UCS-2" is returned. -.PP -See also setCodec(). -.SH "QIODevice * QTextStream::device () const" -Returns the IO device currently set. -.PP -See also setDevice() and unsetDevice(). -.SH "bool QTextStream::eof () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function has been renamed to atEnd(). -.PP -See also QIODevice::atEnd(). -.PP -Example: chart/chartform_files.cpp. -.SH "int QTextStream::fill () const" -Returns the fill character. The default value is ' ' (space). -.SH "int QTextStream::fill ( int f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the fill character to \fIf\fR. Returns the previous fill character. -.SH "int QTextStream::flags () const" -Returns the current stream flags. The default value is 0. -.PP -<center>.nf -.TS -l -- -l. -Flag Meaning - Not currently used; whitespace always skipped - Numeric fields are left-aligned - Not currently used (by default, numerics are right-aligned) - Puts any padding spaces between +/- and value - Output \fIand\fR input only in binary - Output \fIand\fR input only in octal - Output \fIand\fR input only in decimal - Output \fIand\fR input only in hexadecimal - Annotates numeric outputs with 0b, 0, or 0x if in - Not currently used - Uses 0B and 0X rather than 0b and 0x - Shows + for positive numeric values - Uses scientific notation for floating point values - -.TE -.fi -</center> -.PP -Note that unless \fCbin\fR, \fCoct\fR, \fCdec\fR, or \fChex\fR is set, the input base is octal if the value starts with 0, hexadecimal if it starts with 0x, binary if it starts with 0b, and decimal otherwise. -.PP -See also setf() and unsetf(). -.SH "int QTextStream::flags ( int f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the stream flags to \fIf\fR. Returns the previous stream flags. -.PP -See also setf() and unsetf(). -.SH "QTextStream & QTextStream::operator<< ( QChar c )" -Writes character \fCchar\fR to the stream and returns a reference to the stream. -.PP -The character \fIc\fR is assumed to be Latin1 encoded independent of the Encoding set for the QTextStream. -.SH "QTextStream & QTextStream::operator<< ( char c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes character \fIc\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( signed short i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a \fCshort\fR integer \fIi\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( unsigned short i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an \fCunsigned\fR \fCshort\fR integer \fIi\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( signed int i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an \fCint\fR \fIi\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( unsigned int i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an \fCunsigned\fR \fCint\fR \fIi\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( signed long i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a \fClong\fR \fCint\fR \fIi\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( unsigned long i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes an \fCunsigned\fR \fClong\fR \fCint\fR \fIi\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( float f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a \fCfloat\fR \fIf\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( double f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a \fCdouble\fR \fIf\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( const char * s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a string to the stream and returns a reference to the stream. -.PP -The string \fIs\fR is assumed to be Latin1 encoded independent of the Encoding set for the QTextStream. -.SH "QTextStream & QTextStream::operator<< ( const QString & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes \fIs\fR to the stream and returns a reference to the stream. -.SH "QTextStream & QTextStream::operator<< ( const QCString & s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes \fIs\fR to the stream and returns a reference to the stream. -.PP -The string \fIs\fR is assumed to be Latin1 encoded independent of the Encoding set for the QTextStream. -.SH "QTextStream & QTextStream::operator<< ( void * ptr )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a pointer to the stream and returns a reference to the stream. -.PP -The \fIptr\fR is output as an unsigned long hexadecimal integer. -.SH "QTextStream & QTextStream::operator>> ( QChar & c )" -Reads a char \fIc\fR from the stream and returns a reference to the stream. Note that whitespace is \fInot\fR skipped. -.SH "QTextStream & QTextStream::operator>> ( char & c )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a char \fIc\fR from the stream and returns a reference to the stream. Note that whitespace is skipped. -.SH "QTextStream & QTextStream::operator>> ( signed short & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a signed \fCshort\fR integer \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( unsigned short & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned \fCshort\fR integer \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( signed int & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a signed \fCint\fR \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( unsigned int & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned \fCint\fR \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( signed long & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a signed \fClong\fR int \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( unsigned long & i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads an unsigned \fClong\fR int \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( float & f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a \fCfloat\fR \fIf\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( double & f )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a \fCdouble\fR \fIf\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. -.SH "QTextStream & QTextStream::operator>> ( char * s )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a "word" from the stream into \fIs\fR and returns a reference to the stream. -.PP -A word consists of characters for which isspace() returns FALSE. -.SH "QTextStream & QTextStream::operator>> ( QString & str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a "word" from the stream into \fIstr\fR and returns a reference to the stream. -.PP -A word consists of characters for which isspace() returns FALSE. -.SH "QTextStream & QTextStream::operator>> ( QCString & str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Reads a "word" from the stream into \fIstr\fR and returns a reference to the stream. -.PP -A word consists of characters for which isspace() returns FALSE. -.SH "int QTextStream::precision () const" -Returns the precision. The default value is 6. -.SH "int QTextStream::precision ( int p )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the precision to \fIp\fR. Returns the previous precision setting. -.SH "QString QTextStream::read ()" -Reads the entire stream from the current position, and returns a string containing the text. -.PP -See also QIODevice::readLine(). -.PP -Examples: -.)l action/application.cpp, application/application.cpp, mdi/application.cpp, qdir/qdir.cpp, and qwerty/qwerty.cpp. -.SH "QString QTextStream::readLine ()" -Reads a line from the stream and returns a string containing the text. -.PP -The returned string does not contain any trailing newline or carriage return. Note that this is different from QIODevice::readLine(), which does not strip the newline at the end of the line. -.PP -On EOF you will get a QString that is null. On reading an empty line the returned QString is empty but not null. -.PP -See also QIODevice::readLine(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, chart/element.cpp, and network/clientserver/server/server.cpp. -.SH "QTextStream & QTextStream::readRawBytes ( char * s, uint len )" -Reads \fIlen\fR bytes from the stream into \fIs\fR and returns a reference to the stream. -.PP -The buffer \fIs\fR must be preallocated. -.PP -Note that no encoding is done by this function. -.PP -\fBWarning:\fR The behavior of this function is undefined unless the stream's encoding is set to Unicode or Latin1. -.PP -See also QIODevice::readBlock(). -.SH "void QTextStream::reset ()" -Resets the text stream. -.TP -All flags are set to 0. -.TP -The field width is set to 0. -.TP -The fill character is set to ' ' (Space). -.TP -The precision is set to 6. -.PP -See also setf(), width(), fill(), and precision(). -.SH "void QTextStream::setCodec ( QTextCodec * codec )" -Sets the codec for this stream to \fIcodec\fR. Will not try to autodetect Unicode. -.PP -Note that this function should be called before any data is read to/written from the stream. -.PP -See also setEncoding() and codec(). -.PP -Example: qwerty/qwerty.cpp. -.SH "void QTextStream::setDevice ( QIODevice * iod )" -Sets the IO device to \fIiod\fR. -.PP -See also device() and unsetDevice(). -.SH "void QTextStream::setEncoding ( Encoding e )" -Sets the encoding of this stream to \fIe\fR, where \fIe\fR is one of the following values: <center>.nf -.TS -l - l. Encoding Meaning Locale Uses local file format (Latin1 if locale is not set), but autodetecting Unicode(utf16) on input. Unicode Uses Unicode(utf16) for input and output. Output will be written in the order most efficient for the current platform (i.e. the order used internally in QString). UnicodeUTF8 Using Unicode(utf8) for input and output. If you use it for input it will autodetect utf16 and use it instead of utf8. Latin1 ISO-8859-1. Will not autodetect utf16. UnicodeNetworkOrder Uses network order Unicode(utf16) for input and output. Useful when reading Unicode data that does not start with the byte order marker. UnicodeReverse Uses reverse network order Unicode(utf16) for input and output. Useful when reading Unicode data that does not start with the byte order marker or when writing data that should be read by buggy Windows applications. RawUnicode -.TE -.fi -</center> -.PP -Locale and all Unicode encodings, except RawUnicode, will look at the first two bytes in an input stream to determine the byte order. The initial byte order marker will be stripped off before data is read. -.PP -Note that this function should be called before any data is read to or written from the stream. -.PP -See also setCodec(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, network/httpd/httpd.cpp, and qwerty/qwerty.cpp. -.SH "int QTextStream::setf ( int bits )" -Sets the stream flag bits \fIbits\fR. Returns the previous stream flags. -.PP -Equivalent to \fCflags( flags() | bits )\fR. -.PP -See also unsetf(). -.SH "int QTextStream::setf ( int bits, int mask )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the stream flag bits \fIbits\fR with a bit mask \fImask\fR. Returns the previous stream flags. -.PP -Equivalent to \fCflags( (flags() & ~mask) | (bits & mask) )\fR. -.PP -See also unsetf(). -.SH "void QTextStream::skipWhiteSpace ()" -Positions the read pointer at the first non-whitespace character. -.SH "void QTextStream::unsetDevice ()" -Unsets the IO device. Equivalent to setDevice( 0 ). -.PP -See also device() and setDevice(). -.SH "int QTextStream::unsetf ( int bits )" -Clears the stream flag bits \fIbits\fR. Returns the previous stream flags. -.PP -Equivalent to \fCflags( flags() & ~mask )\fR. -.PP -See also setf(). -.SH "int QTextStream::width () const" -Returns the field width. The default value is 0. -.SH "int QTextStream::width ( int w )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the field width to \fIw\fR. Returns the previous field width. -.SH "QTextStream & QTextStream::writeRawBytes ( const char * s, uint len )" -Writes the \fIlen\fR bytes from \fIs\fR to the stream and returns a reference to the stream. -.PP -Note that no encoding is done by this function. -.PP -See also QIODevice::writeBlock(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtextstream.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtextstream.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qthread.3qt b/doc/man/man3/qthread.3qt deleted file mode 100644 index 69538e5c4..000000000 --- a/doc/man/man3/qthread.3qt +++ /dev/null @@ -1,230 +0,0 @@ -'\" t -.TH QThread 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 -QThread \- Platform-independent threads -.SH SYNOPSIS -All the functions in this class are thread-safe when Qt is built with thread support.</p> -.PP -\fC#include <ntqthread.h>\fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQThread\fR ( unsigned int stackSize = 0 )" -.br -.ti -1c -.BI "virtual \fB~QThread\fR ()" -.br -.ti -1c -.BI "bool \fBwait\fR ( unsigned long time = ULONG_MAX )" -.br -.ti -1c -.BI "enum \fBPriority\fR { IdlePriority, LowestPriority, LowPriority, NormalPriority, HighPriority, HighestPriority, TimeCriticalPriority, InheritPriority }" -.br -.ti -1c -.BI "void \fBstart\fR ( Priority priority = InheritPriority )" -.br -.ti -1c -.BI "void \fBterminate\fR ()" -.br -.ti -1c -.BI "bool \fBfinished\fR () const" -.br -.ti -1c -.BI "bool \fBrunning\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "Qt::HANDLE \fBcurrentThread\fR ()" -.br -.ti -1c -.BI "void postEvent ( QObject * receiver, QEvent * event ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBexit\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBrun\fR () = 0" -.br -.in -1c -.SS "Static Protected Members" -.in +1c -.ti -1c -.BI "void \fBsleep\fR ( unsigned long secs )" -.br -.ti -1c -.BI "void \fBmsleep\fR ( unsigned long msecs )" -.br -.ti -1c -.BI "void \fBusleep\fR ( unsigned long usecs )" -.br -.in -1c -.SH DESCRIPTION -The QThread class provides platform-independent threads. -.PP -A QThread represents a separate thread of control within the program; it shares data with all the other threads within the process but executes independently in the way that a separate program does on a multitasking operating system. Instead of starting in main(), QThreads begin executing in run(). You inherit run() to include your code. For example: -.PP -.nf -.br - class MyThread : public QThread { -.br -.br - public: -.br -.br - virtual void run(); -.br -.br - }; -.br -.br - void MyThread::run() -.br - { -.br - for( int count = 0; count < 20; count++ ) { -.br - sleep( 1 ); -.br - tqDebug( "Ping!" ); -.br - } -.br - } -.br -.br - int main() -.br - { -.br - MyThread a; -.br - MyThread b; -.br - a.start(); -.br - b.start(); -.br - a.wait(); -.br - b.wait(); -.br - } -.br -.fi -.PP -This will start two threads, each of which writes Ping! 20 times to the screen and exits. The wait() calls at the end of main() are necessary because exiting main() ends the program, unceremoniously killing all other threads. Each MyThread stops executing when it reaches the end of MyThread::run(), just as an application does when it leaves main(). -.PP -See also Thread Support in Qt, Environment Classes, and Threading. -.SS "Member Type Documentation" -.SH "QThread::Priority" -This enum type indicates how the operating system should schedule newly created threads. -.TP -\fCQThread::IdlePriority\fR - scheduled only when no other threads are running. -.TP -\fCQThread::LowestPriority\fR - scheduled less often than LowPriority. -.TP -\fCQThread::LowPriority\fR - scheduled less often than NormalPriority. -.TP -\fCQThread::NormalPriority\fR - the default priority of the operating system. -.TP -\fCQThread::HighPriority\fR - scheduled more often than NormalPriority. -.TP -\fCQThread::HighestPriority\fR - scheduled more often then HighPriority. -.TP -\fCQThread::TimeCriticalPriority\fR - scheduled as often as possible. -.TP -\fCQThread::InheritPriority\fR - use the same priority as the creating thread. This is the default. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QThread::QThread ( unsigned int stackSize = 0 )" -Constructs a new thread. The thread does not begin executing until start() is called. -.PP -If \fIstackSize\fR is greater than zero, the maximum stack size is set to \fIstackSize\fR bytes, otherwise the maximum stack size is automatically determined by the operating system. -.PP -\fBWarning:\fR Most operating systems place minimum and maximum limits on thread stack sizes. The thread will fail to start if the stack size is outside these limits. -.SH "QThread::~QThread ()\fC [virtual]\fR" -QThread destructor. -.PP -Note that deleting a QThread object will not stop the execution of the thread it represents. Deleting a running QThread (i.e. finished() returns FALSE) will probably result in a program crash. You can wait() on a thread to make sure that it has finished. -.SH "Qt::HANDLE QThread::currentThread ()\fC [static]\fR" -This returns the thread handle of the currently executing thread. -.PP -\fBWarning:\fR The handle returned by this function is used for internal purposes and should \fInot\fR be used in any application code. On Windows, the returned value is a pseudo handle for the current thread, and it cannot be used for numerical comparison. -.SH "void QThread::exit ()\fC [static]\fR" -Ends the execution of the calling thread and wakes up any threads waiting for its termination. -.SH "bool QThread::finished () const" -Returns TRUE if the thread is finished; otherwise returns FALSE. -.SH "void QThread::msleep ( unsigned long msecs )\fC [static protected]\fR" -System independent sleep. This causes the current thread to sleep for \fImsecs\fR milliseconds -.SH "void QThread::postEvent ( QObject * receiver, QEvent * event )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use QApplication::postEvent() instead. -.SH "void QThread::run ()\fC [pure virtual protected]\fR" -This method is pure virtual, and must be implemented in derived classes in order to do useful work. Returning from this method will end the execution of the thread. -.PP -See also wait(). -.SH "bool QThread::running () const" -Returns TRUE if the thread is running; otherwise returns FALSE. -.SH "void QThread::sleep ( unsigned long secs )\fC [static protected]\fR" -System independent sleep. This causes the current thread to sleep for \fIsecs\fR seconds. -.SH "void QThread::start ( Priority priority = InheritPriority )" -Begins execution of the thread by calling run(), which should be reimplemented in a QThread subclass to contain your code. The operating system will schedule the thread according to the \fIpriority\fR argument. -.PP -If you try to start a thread that is already running, this function will wait until the the thread has finished and then restart the thread. -.PP -See also Priority. -.SH "void QThread::terminate ()" -This function terminates the execution of the thread. The thread may or may not be terminated immediately, depending on the operating system's scheduling policies. Use QThread::wait() after terminate() for synchronous termination. -.PP -When the thread is terminated, all threads waiting for the the thread to finish will be woken up. -.PP -\fBWarning:\fR This function is dangerous, and its use is discouraged. The thread can be terminated at any point in its code path. Threads can be terminated while modifying data. There is no chance for the thread to cleanup after itself, unlock any held mutexes, etc. In short, use this function only if \fIabsolutely\fR necessary. -.SH "void QThread::usleep ( unsigned long usecs )\fC [static protected]\fR" -System independent sleep. This causes the current thread to sleep for \fIusecs\fR microseconds -.SH "bool QThread::wait ( unsigned long time = ULONG_MAX )" -A thread calling this function will block until either of these conditions is met: -.TP -The thread associated with this QThread object has finished execution (i.e. when it returns from run()). This function will return TRUE if the thread has finished. It also returns TRUE if the thread has not been started yet. -.TP -\fItime\fR milliseconds has elapsed. If \fItime\fR is ULONG_MAX (the default), then the wait will never timeout (the thread must return from run()). This function will return FALSE if the wait timed out. -.PP -This provides similar functionality to the POSIX \fCpthread_join()\fR function. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqthread.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qthread.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qthreadstorage.3qt b/doc/man/man3/qthreadstorage.3qt deleted file mode 100644 index 9f88eec2f..000000000 --- a/doc/man/man3/qthreadstorage.3qt +++ /dev/null @@ -1,166 +0,0 @@ -'\" t -.TH QThreadStorage 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 -QThreadStorage \- Per-thread data storage -.SH SYNOPSIS -All the functions in this class are thread-safe when Qt is built with thread support.</p> -.PP -\fC#include <ntqthreadstorage.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQThreadStorage\fR ()" -.br -.ti -1c -.BI "\fB~QThreadStorage\fR ()" -.br -.ti -1c -.BI "bool \fBhasLocalData\fR () const" -.br -.ti -1c -.BI "T & \fBlocalData\fR ()" -.br -.ti -1c -.BI "T \fBlocalData\fR () const" -.br -.ti -1c -.BI "void \fBsetLocalData\fR ( T data )" -.br -.in -1c -.SH DESCRIPTION -The QThreadStorage class provides per-thread data storage. -.PP -QThreadStorage is a template class that provides per-thread data storage. -.PP -\fINote that due to compiler limitations, QThreadStorage can only store pointers.\fR -.PP -The setLocalData() function stores a single thread-specific value for the calling thread. The data can be accessed later using the localData() functions. QThreadStorage takes ownership of the data (which must be created on the heap with \fInew\fR) and deletes it when the thread exits (either normally or via termination). -.PP -The hasLocalData() function allows the programmer to determine if data has previously been set using the setLocalData() function. This is useful for lazy initializiation. -.PP -For example, the following code uses QThreadStorage to store a single cache for each thread that calls the \fIcacheObject()\fR and \fIremoveFromCache()\fR functions. The cache is automatically deleted when the calling thread exits (either normally or via termination). -.PP -.nf -.br - QThreadStorage<QCache<SomeClass> *> caches; -.br -.br - void cacheObject( const QString &key, SomeClass *object ) -.br - { -.br - if ( ! caches.hasLocalData() ) -.br - caches.setLocalData( new QCache<SomeClass> ); -.br -.br - caches.localData()->insert( key, object ); -.br - } -.br -.br - void removeFromCache( const QString &key ) -.br - { -.br - if ( ! caches.hasLocalData() ) -.br - return; // nothing to do -.br -.br - caches.localData()->remove( key ); -.br - } -.br -.fi -.SH "Caveats" -.IP -.TP -As noted above, QThreadStorage can only store pointers due to compiler limitations. Support for value-based objects will be added when the majority of compilers are able to support partial template specialization. -.IP -.TP -The destructor does \fInot\fR delete per-thread data. QThreadStorage only deletes per-thread data when the thread exits or when setLocalData() is called multiple times. -.IP -.TP -QThreadStorage can only be used with threads started with QThread. It \fIcannot\fR be used with threads started with platform-specific APIs. -.IP -.TP -As a corollary to the above, platform-specific APIs cannot be used to exit or terminate a QThread using QThreadStorage. Doing so will cause all per-thread data to be leaked. See QThread::exit() and QThread::terminate(). -.IP -.TP -QThreadStorage \fIcan\fR be used to store data for the \fImain()\fR thread \fIafter\fR QApplication has been constructed. QThreadStorage deletes all data set for the \fImain()\fR thread when QApplication is destroyed, regardless of whether or not the \fImain()\fR thread has actually finished. -.IP -.TP -The implementation of QThreadStorage limits the total number of QThreadStorage objects to 256. An unlimited number of threads can store per-thread data in each QThreadStorage object. -.IP -.PP -See also Environment Classes and Threading. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QThreadStorage::QThreadStorage ()" -Constructs a new per-thread data storage object. -.SH "QThreadStorage::~QThreadStorage ()" -Destroys the per-thread data storage object. -.PP -Note: The per-thread data stored is \fInot\fR deleted. Any data left in QThreadStorage is leaked. Make sure that all threads using QThreadStorage have exited before deleting the QThreadStorage. -.PP -See also hasLocalData(). -.SH "bool QThreadStorage::hasLocalData () const" -Returns TRUE if the calling thread has non-zero data available; otherwise returns FALSE. -.PP -See also localData(). -.SH "T & QThreadStorage::localData ()" -Returns a reference to the data that was set by the calling thread. -.PP -Note: QThreadStorage can only store pointers. This function returns a \fIreference\fR to the pointer that was set by the calling thread. The value of this reference is 0 if no data was set by the calling thread, -.PP -See also hasLocalData(). -.SH "T QThreadStorage::localData () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a copy of the data that was set by the calling thread. -.PP -Note: QThreadStorage can only store pointers. This function returns a pointer to the data that was set by the calling thread. If no data was set by the calling thread, this function returns 0. -.PP -See also hasLocalData(). -.SH "void QThreadStorage::setLocalData ( T data )" -Sets the local data for the calling thread to \fIdata\fR. It can be accessed later using the localData() functions. -.PP -If \fIdata\fR is 0, this function deletes the previous data (if any) and returns immediately. -.PP -If \fIdata\fR is non-zero, QThreadStorage takes ownership of the \fIdata\fR and deletes it automatically either when the thread exits (either normally or via termination) or when setLocalData() is called again. -.PP -Note: QThreadStorage can only store pointers. The \fIdata\fR argument must be either a pointer to an object created on the heap (i.e. using \fInew\fR) or 0. You should not delete \fIdata\fR yourself; QThreadStorage takes ownership and will delete the \fIdata\fR itself. -.PP -See also localData() and hasLocalData(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqthreadstorage.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qthreadstorage.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtime.3qt b/doc/man/man3/qtime.3qt deleted file mode 100644 index b409e4089..000000000 --- a/doc/man/man3/qtime.3qt +++ /dev/null @@ -1,372 +0,0 @@ -'\" t -.TH QTime 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 -QTime \- Clock time functions -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqdatetime.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTime\fR ()" -.br -.ti -1c -.BI "\fBQTime\fR ( int h, int m, int s = 0, int ms = 0 )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "int \fBhour\fR () const" -.br -.ti -1c -.BI "int \fBminute\fR () const" -.br -.ti -1c -.BI "int \fBsecond\fR () const" -.br -.ti -1c -.BI "int \fBmsec\fR () const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( Qt::DateFormat f = Qt::TextDate ) const" -.br -.ti -1c -.BI "QString \fBtoString\fR ( const QString & format ) const" -.br -.ti -1c -.BI "bool \fBsetHMS\fR ( int h, int m, int s, int ms = 0 )" -.br -.ti -1c -.BI "QTime \fBaddSecs\fR ( int nsecs ) const" -.br -.ti -1c -.BI "int \fBsecsTo\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "QTime \fBaddMSecs\fR ( int ms ) const" -.br -.ti -1c -.BI "int \fBmsecsTo\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const QTime & t ) const" -.br -.ti -1c -.BI "void \fBstart\fR ()" -.br -.ti -1c -.BI "int \fBrestart\fR ()" -.br -.ti -1c -.BI "int \fBelapsed\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QTime \fBcurrentTime\fR ()" -.br -.ti -1c -.BI "QTime \fBcurrentTime\fR ( Qt::TimeSpec ts )" -.br -.ti -1c -.BI "QTime \fBfromString\fR ( const QString & s, Qt::DateFormat f = Qt::TextDate )" -.br -.ti -1c -.BI "bool \fBisValid\fR ( int h, int m, int s, int ms = 0 )" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QTime & t )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QTime & t )" -.br -.in -1c -.SH DESCRIPTION -The QTime class provides clock time functions. -.PP -A QTime object contains a clock time, i.e. the number of hours, minutes, seconds, and milliseconds since midnight. It can read the current time from the system clock and measure a span of elapsed time. It provides functions for comparing times and for manipulating a time by adding a number of (milli)seconds. -.PP -QTime uses the 24-hour clock format; it has no concept of AM/PM. It operates in local time; it knows nothing about time zones or daylight savings time. -.PP -A QTime object is typically created either by giving the number of hours, minutes, seconds, and milliseconds explicitly, or by using the static function currentTime(), which creates a QTime object that contains the system's clock time. Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. -.PP -The hour(), minute(), second(), and msec() functions provide access to the number of hours, minutes, seconds, and milliseconds of the time. The same information is provided in textual format by the toString() function. -.PP -QTime provides a full set of operators to compare two QTime objects. One time is considered smaller than another if it is earlier than the other. -.PP -The time a given number of seconds or milliseconds later than a given time can be found using the addSecs() or addMSecs() functions. Correspondingly, the number of (milli)seconds between two times can be found using the secsTo() or msecsTo() functions. -.PP -QTime can be used to measure a span of elapsed time using the start(), restart(), and elapsed() functions. -.PP -See also QDate, QDateTime, and Time and Date. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTime::QTime ()" -Constructs the time 0 hours, minutes, seconds and milliseconds, i.e. 00:00:00.000 (midnight). This is a valid time. -.PP -See also isValid(). -.SH "QTime::QTime ( int h, int m, int s = 0, int ms = 0 )" -Constructs a time with hour \fIh\fR, minute \fIm\fR, seconds \fIs\fR and milliseconds \fIms\fR. -.PP -\fIh\fR must be in the range 0..23, \fIm\fR and \fIs\fR must be in the range 0..59, and \fIms\fR must be in the range 0..999. -.PP -See also isValid(). -.SH "QTime QTime::addMSecs ( int ms ) const" -Returns a QTime object containing a time \fIms\fR milliseconds later than the time of this object (or earlier if \fIms\fR is negative). -.PP -Note that the time will wrap if it passes midnight. See addSecs() for an example. -.PP -See also addSecs() and msecsTo(). -.SH "QTime QTime::addSecs ( int nsecs ) const" -Returns a QTime object containing a time \fInsecs\fR seconds later than the time of this object (or earlier if \fInsecs\fR is negative). -.PP -Note that the time will wrap if it passes midnight. -.PP -Example: -.PP -.nf -.br - QTime n( 14, 0, 0 ); // n == 14:00:00 -.br - QTime t; -.br - t = n.addSecs( 70 ); // t == 14:01:10 -.br - t = n.addSecs( -70 ); // t == 13:58:50 -.br - t = n.addSecs( 10*60*60 + 5 ); // t == 00:00:05 -.br - t = n.addSecs( -15*60*60 ); // t == 23:00:00 -.br -.fi -.PP -See also addMSecs(), secsTo(), and QDateTime::addSecs(). -.SH "QTime QTime::currentTime ( Qt::TimeSpec ts )\fC [static]\fR" -Returns the current time as reported by the system clock, for the TimeSpec \fIts\fR. The default TimeSpec is LocalTime. -.PP -Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. -.PP -See also Qt::TimeSpec. -.PP -Examples: -.)l aclock/aclock.cpp, dclock/dclock.cpp, t12/cannon.cpp, and tictac/tictac.cpp. -.SH "QTime QTime::currentTime ()\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the current time as reported by the system clock. -.PP -Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. -.SH "int QTime::elapsed () const" -Returns the number of milliseconds that have elapsed since the last time start() or restart() was called. -.PP -Note that the counter wraps to zero 24 hours after the last call to start() or restart. -.PP -Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. -.PP -\fBWarning:\fR If the system's clock setting has been changed since the last time start() or restart() was called, the result is undefined. This can happen when daylight savings time is turned on or off. -.PP -See also start() and restart(). -.SH "QTime QTime::fromString ( const QString & s, Qt::DateFormat f = Qt::TextDate )\fC [static]\fR" -Returns the representation \fIs\fR as a QTime using the format \fIf\fR, or an invalid time if this is not possible. -.PP -\fBWarning:\fR Note that Qt::LocalDate cannot be used here. -.SH "int QTime::hour () const" -Returns the hour part (0..23) of the time. -.PP -Examples: -.)l aclock/aclock.cpp and tictac/tictac.cpp. -.SH "bool QTime::isNull () const" -Returns TRUE if the time is equal to 00:00:00.000; otherwise returns FALSE. A null time is valid. -.PP -See also isValid(). -.SH "bool QTime::isValid () const" -Returns TRUE if the time is valid; otherwise returns FALSE. The time 23:30:55.746 is valid, whereas 24:12:30 is invalid. -.PP -See also isNull(). -.SH "bool QTime::isValid ( int h, int m, int s, int ms = 0 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if the specified time is valid; otherwise returns FALSE. -.PP -The time is valid if \fIh\fR is in the range 0..23, \fIm\fR and \fIs\fR are in the range 0..59, and \fIms\fR is in the range 0..999. -.PP -Example: -.PP -.nf -.br - QTime::isValid(21, 10, 30); // returns TRUE -.br - QTime::isValid(22, 5, 62); // returns FALSE -.br -.fi -.SH "int QTime::minute () const" -Returns the minute part (0..59) of the time. -.PP -Examples: -.)l aclock/aclock.cpp and tictac/tictac.cpp. -.SH "int QTime::msec () const" -Returns the millisecond part (0..999) of the time. -.SH "int QTime::msecsTo ( const QTime & t ) const" -Returns the number of milliseconds from this time to \fIt\fR (which is negative if \fIt\fR is earlier than this time). -.PP -Because QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400000 and 86400000 msec. -.PP -See also secsTo(). -.SH "bool QTime::operator!= ( const QTime & t ) const" -Returns TRUE if this time is different from \fIt\fR; otherwise returns FALSE. -.SH "bool QTime::operator< ( const QTime & t ) const" -Returns TRUE if this time is earlier than \fIt\fR; otherwise returns FALSE. -.SH "bool QTime::operator<= ( const QTime & t ) const" -Returns TRUE if this time is earlier than or equal to \fIt\fR; otherwise returns FALSE. -.SH "bool QTime::operator== ( const QTime & t ) const" -Returns TRUE if this time is equal to \fIt\fR; otherwise returns FALSE. -.SH "bool QTime::operator> ( const QTime & t ) const" -Returns TRUE if this time is later than \fIt\fR; otherwise returns FALSE. -.SH "bool QTime::operator>= ( const QTime & t ) const" -Returns TRUE if this time is later than or equal to \fIt\fR; otherwise returns FALSE. -.SH "int QTime::restart ()" -Sets this time to the current time and returns the number of milliseconds that have elapsed since the last time start() or restart() was called. -.PP -This function is guaranteed to be atomic and is thus very handy for repeated measurements. Call start() to start the first measurement and then restart() for each later measurement. -.PP -Note that the counter wraps to zero 24 hours after the last call to start() or restart(). -.PP -\fBWarning:\fR If the system's clock setting has been changed since the last time start() or restart() was called, the result is undefined. This can happen when daylight savings time is turned on or off. -.PP -See also start(), elapsed(), and currentTime(). -.SH "int QTime::second () const" -Returns the second part (0..59) of the time. -.PP -Example: tictac/tictac.cpp. -.SH "int QTime::secsTo ( const QTime & t ) const" -Returns the number of seconds from this time to \fIt\fR (which is negative if \fIt\fR is earlier than this time). -.PP -Because QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400 and 86400. -.PP -See also addSecs() and QDateTime::secsTo(). -.PP -Example: t12/cannon.cpp. -.SH "bool QTime::setHMS ( int h, int m, int s, int ms = 0 )" -Sets the time to hour \fIh\fR, minute \fIm\fR, seconds \fIs\fR and milliseconds \fIms\fR. -.PP -\fIh\fR must be in the range 0..23, \fIm\fR and \fIs\fR must be in the range 0..59, and \fIms\fR must be in the range 0..999. Returns TRUE if the set time is valid; otherwise returns FALSE. -.PP -See also isValid(). -.SH "void QTime::start ()" -Sets this time to the current time. This is practical for timing: -.PP -.nf -.br - QTime t; -.br - t.start(); -.br - some_lengthy_task(); -.br - tqDebug( "Time elapsed: %d ms", t.elapsed() ); -.br -.fi -.PP -See also restart(), elapsed(), and currentTime(). -.SH "QString QTime::toString ( const QString & format ) const" -Returns the time as a string. The \fIformat\fR parameter determines the format of the result string. -.PP -These expressions may be used: -.PP -<center>.nf -.TS -l - l. Expression Output h the hour without a leading zero (0..23 or 1..12 if AM/PM display) hh the hour with a leading zero (00..23 or 01..12 if AM/PM display) m the minute without a leading zero (0..59) mm the minute with a leading zero (00..59) s the second whithout a leading zero (0..59) ss the second whith a leading zero (00..59) z the milliseconds without leading zeroes (0..999) zzz the milliseconds with leading zeroes (000..999) AP use AM/PM display. \fIAP\fR will be replaced by either "AM" or "PM". ap -.TE -.fi -</center> -.PP -All other input characters will be ignored. -.PP -Example format strings (assuming that the QTime is 14:13:09.042) -.PP -<center>.nf -.TS -l - l. Format Result hh:mm:ss.zzz 14:13:09.042 h:m:s ap -.TE -.fi -</center> -.PP -If the time is an invalid time, then QString::null will be returned. -.PP -See also QDate::toString() and QDateTime::toString(). -.SH "QString QTime::toString ( Qt::DateFormat f = Qt::TextDate ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the time as a string. Milliseconds are not included. The \fIf\fR parameter determines the format of the string. -.PP -If \fIf\fR is Qt::TextDate, the string format is HH:MM:SS; e.g. 1 second before midnight would be "23:59:59". -.PP -If \fIf\fR is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates, which is also HH:MM:SS. -.PP -If \fIf\fR is Qt::LocalDate, the string format depends on the locale settings of the system. -.PP -If the time is an invalid time, then QString::null will be returned. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QTime & t )" -Writes time \fIt\fR to the stream \fIs\fR. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QTime & t )" -Reads a time from the stream \fIs\fR into \fIt\fR. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtime.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtime.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtimeedit.3qt b/doc/man/man3/qtimeedit.3qt deleted file mode 100644 index 79d7717ec..000000000 --- a/doc/man/man3/qtimeedit.3qt +++ /dev/null @@ -1,256 +0,0 @@ -'\" t -.TH QTimeEdit 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 -QTimeEdit \- Time editor -.SH SYNOPSIS -\fC#include <ntqdatetimeedit.h>\fR -.PP -Inherits QDateTimeEditBase. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBDisplay\fR { Hours = 0x01, Minutes = 0x02, Seconds = 0x04, AMPM = 0x10 }" -.br -.ti -1c -.BI "\fBQTimeEdit\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQTimeEdit\fR ( const QTime & time, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QTimeEdit\fR ()" -.br -.ti -1c -.BI "QTime \fBtime\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAutoAdvance\fR ( bool advance )" -.br -.ti -1c -.BI "bool \fBautoAdvance\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMinValue\fR ( const QTime & d )" -.br -.ti -1c -.BI "QTime \fBminValue\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMaxValue\fR ( const QTime & d )" -.br -.ti -1c -.BI "QTime \fBmaxValue\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRange\fR ( const QTime & min, const QTime & max )" -.br -.ti -1c -.BI "QString \fBseparator\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSeparator\fR ( const QString & s )" -.br -.ti -1c -.BI "uint \fBdisplay\fR () const" -.br -.ti -1c -.BI "void \fBsetDisplay\fR ( uint disp )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetTime\fR ( const QTime & time )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBvalueChanged\fR ( const QTime & time )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoAdvance\fR - whether the editor automatically advances to the next section" -.br -.ti -1c -.BI "Display \fBdisplay\fR - the sections that are displayed in the time edit" -.br -.ti -1c -.BI "QTime \fBmaxValue\fR - the maximum time value" -.br -.ti -1c -.BI "QTime \fBminValue\fR - the minimum time value" -.br -.ti -1c -.BI "QTime \fBtime\fR - the editor's time value" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QString \fBsectionFormattedText\fR ( int sec )" -.br -.ti -1c -.BI "virtual void \fBsetHour\fR ( int h )" -.br -.ti -1c -.BI "virtual void \fBsetMinute\fR ( int m )" -.br -.ti -1c -.BI "virtual void \fBsetSecond\fR ( int s )" -.br -.in -1c -.SH DESCRIPTION -The QTimeEdit class provides a time editor. -.PP -QTimeEdit allows the user to edit times by using the keyboard or the arrow keys to increase/decrease time values. The arrow keys can be used to move from section to section within the QTimeEdit box. The user can automatically be moved to the next section once they complete a section using setAutoAdvance(). Times appear in hour, minute, second order. It is recommended that the QTimeEdit is initialised with a time, e.g. -.PP -.nf -.br - QTime timeNow = QTime::currentTime(); -.br - QTimeEdit *timeEdit = new QTimeEdit( timeNow, this ); -.br - timeEdit->setRange( timeNow, timeNow.addSecs( 60 * 60 ) ); -.br -.fi -Here we've created a QTimeEdit widget set to the current time. We've also set the minimum value to the current time and the maximum time to one hour from now. -.PP -The maximum and minimum values for a time value in the time editor default to the maximum and minimum values for a QTime. You can change this by calling setMinValue(), setMaxValue() or setRange(). -.PP -Terminology: A QTimeWidget consists of three sections, one each for the hour, minute and second. You can change the separator character using setSeparator(), by default the separator is read from the system's settings. -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> -.PP -See also QTime, QDateEdit, QDateTimeEdit, Advanced Widgets, and Time and Date. -.SS "Member Type Documentation" -.SH "QTimeEdit::Display" -This enum defines the sections that comprise a time -.TP -\fCQTimeEdit::Hours\fR - The hours section -.TP -\fCQTimeEdit::Minutes\fR - The minutes section -.TP -\fCQTimeEdit::Seconds\fR - The seconds section -.TP -\fCQTimeEdit::AMPM\fR - The AM/PM section -.PP -The values can be or'ed together to show any combination. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTimeEdit::QTimeEdit ( QWidget * parent = 0, const char * name = 0 )" -Constructs an empty time edit with parent \fIparent\fR and called \fIname\fR. -.SH "QTimeEdit::QTimeEdit ( const QTime & time, QWidget * parent = 0, const char * name = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a time edit with the initial time value, \fItime\fR, parent \fIparent\fR and called \fIname\fR. -.SH "QTimeEdit::~QTimeEdit ()" -Destroys the object and frees any allocated resources. -.SH "bool QTimeEdit::autoAdvance () const" -Returns TRUE if the editor automatically advances to the next section; otherwise returns FALSE. See the "autoAdvance" property for details. -.SH "uint QTimeEdit::display () const" -Returns the sections that are displayed in the time edit. See the "display" property for details. -.SH "QTime QTimeEdit::maxValue () const" -Returns the maximum time value. See the "maxValue" property for details. -.SH "QTime QTimeEdit::minValue () const" -Returns the minimum time value. See the "minValue" property for details. -.SH "QString QTimeEdit::sectionFormattedText ( int sec )\fC [virtual protected]\fR" -Returns the formatted number for section \fIsec\fR. This will correspond to either the hour, minute or second section, depending on \fIsec\fR. -.SH "QString QTimeEdit::separator () const" -Returns the editor's separator. -.SH "void QTimeEdit::setAutoAdvance ( bool advance )\fC [virtual]\fR" -Sets whether the editor automatically advances to the next section to \fIadvance\fR. See the "autoAdvance" property for details. -.SH "void QTimeEdit::setDisplay ( uint disp )" -Sets the sections that are displayed in the time edit to \fIdisp\fR. See the "display" property for details. -.SH "void QTimeEdit::setHour ( int h )\fC [virtual protected]\fR" -Sets the hour to \fIh\fR, which must be a valid hour, i.e. in the range 0..24. -.SH "void QTimeEdit::setMaxValue ( const QTime & d )\fC [virtual]\fR" -Sets the maximum time value to \fId\fR. See the "maxValue" property for details. -.SH "void QTimeEdit::setMinValue ( const QTime & d )\fC [virtual]\fR" -Sets the minimum time value to \fId\fR. See the "minValue" property for details. -.SH "void QTimeEdit::setMinute ( int m )\fC [virtual protected]\fR" -Sets the minute to \fIm\fR, which must be a valid minute, i.e. in the range 0..59. -.SH "void QTimeEdit::setRange ( const QTime & min, const QTime & max )\fC [virtual]\fR" -Sets the valid input range for the editor to be from \fImin\fR to \fImax\fR inclusive. If \fImin\fR is invalid no minimum time is set. Similarly, if \fImax\fR is invalid no maximum time is set. -.SH "void QTimeEdit::setSecond ( int s )\fC [virtual protected]\fR" -Sets the second to \fIs\fR, which must be a valid second, i.e. in the range 0..59. -.SH "void QTimeEdit::setSeparator ( const QString & s )\fC [virtual]\fR" -Sets the separator to \fIs\fR. Note that currently only the first character of \fIs\fR is used. -.SH "void QTimeEdit::setTime ( const QTime & time )\fC [virtual slot]\fR" -Sets the editor's time value to \fItime\fR. See the "time" property for details. -.SH "QTime QTimeEdit::time () const" -Returns the editor's time value. See the "time" property for details. -.SH "void QTimeEdit::valueChanged ( const QTime & time )\fC [signal]\fR" -This signal is emitted whenever the editor's value changes. The \fItime\fR parameter is the new value. -.SS "Property Documentation" -.SH "bool autoAdvance" -This property holds whether the editor automatically advances to the next section. -.PP -If autoAdvance is TRUE, the editor will automatically advance focus to the next time section if a user has completed a section. The default is FALSE. -.PP -Set this property's value with setAutoAdvance() and get this property's value with autoAdvance(). -.SH "Display display" -This property holds the sections that are displayed in the time edit. -.PP -The value can be any combination of the values in the Display enum. By default, the widget displays hours, minutes and seconds. -.PP -Set this property's value with setDisplay() and get this property's value with display(). -.SH "QTime maxValue" -This property holds the maximum time value. -.PP -Setting the maximum time value is equivalent to calling QTimeEdit::setRange( minValue(), \fIt\fR ), where \fIt\fR is the maximum time. The default maximum time is 23:59:59. -.PP -See also minValue and setRange(). -.PP -Set this property's value with setMaxValue() and get this property's value with maxValue(). -.SH "QTime minValue" -This property holds the minimum time value. -.PP -Setting the minimum time value is equivalent to calling QTimeEdit::setRange( \fIt\fR, maxValue() ), where \fIt\fR is the minimum time. The default minimum time is 00:00:00. -.PP -See also maxValue and setRange(). -.PP -Set this property's value with setMinValue() and get this property's value with minValue(). -.SH "QTime time" -This property holds the editor's time value. -.PP -When changing the time property, if the time is less than minValue(), or is greater than maxValue(), nothing happens. -.PP -Set this property's value with setTime() and get this property's value with time(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtimeedit.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtimeedit.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtimer.3qt b/doc/man/man3/qtimer.3qt deleted file mode 100644 index 4aae0dedf..000000000 --- a/doc/man/man3/qtimer.3qt +++ /dev/null @@ -1,196 +0,0 @@ -'\" t -.TH QTimer 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 -QTimer \- Timer signals and single-shot timers -.SH SYNOPSIS -\fC#include <ntqtimer.h>\fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTimer\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QTimer\fR ()" -.br -.ti -1c -.BI "bool \fBisActive\fR () const" -.br -.ti -1c -.BI "int \fBstart\fR ( int msec, bool sshot = FALSE )" -.br -.ti -1c -.BI "void \fBchangeInterval\fR ( int msec )" -.br -.ti -1c -.BI "void \fBstop\fR ()" -.br -.ti -1c -.BI "int \fBtimerId\fR () const" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBtimeout\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBsingleShot\fR ( int msec, QObject * receiver, const char * member )" -.br -.in -1c -.SH DESCRIPTION -The QTimer class provides timer signals and single-shot timers. -.PP -It uses timer events internally to provide a more versatile timer. QTimer is very easy to use: create a QTimer, call start() to start it and connect its timeout() to the appropriate slots. When the time is up it will emit the timeout() signal. -.PP -Note that a QTimer object is destroyed automatically when its parent object is destroyed. -.PP -Example: -.PP -.nf -.br - QTimer *timer = new QTimer( myObject ); -.br - connect( timer, SIGNAL(timeout()), myObject, SLOT(timerDone()) ); -.br - timer->start( 2000, TRUE ); // 2 seconds single-shot timer -.br -.fi -.PP -You can also use the static singleShot() function to create a single shot timer. -.PP -As a special case, a QTimer with timeout 0 times out as soon as all the events in the window system's event queue have been processed. -.PP -This can be used to do heavy work while providing a snappy user interface: -.PP -.nf -.br - QTimer *t = new QTimer( myObject ); -.br - connect( t, SIGNAL(timeout()), SLOT(processOneThing()) ); -.br - t->start( 0, FALSE ); -.br -.fi -.PP -myObject->processOneThing() will be called repeatedly and should return quickly (typically after processing one data item) so that Qt can deliver events to widgets and stop the timer as soon as it has done all its work. This is the traditional way of implementing heavy work in GUI applications; multi-threading is now becoming available on more and more platforms, and we expect that null events will eventually be replaced by threading. -.PP -Note that QTimer's accuracy depends on the underlying operating system and hardware. Most platforms support an accuracy of 20ms; some provide more. If Qt is unable to deliver the requested number of timer clicks, it will silently discard some. -.PP -An alternative to using QTimer is to call QObject::startTimer() for your object and reimplement the QObject::timerEvent() event handler in your class (which must, of course, inherit QObject). The disadvantage is that timerEvent() does not support such high-level features as single-shot timers or signals. -.PP -Some operating systems limit the number of timers that may be used; Qt tries to work around these limitations. -.PP -See also Event Classes and Time and Date. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTimer::QTimer ( QObject * parent = 0, const char * name = 0 )" -Constructs a timer called \fIname\fR, with the parent \fIparent\fR. -.PP -Note that the parent object's destructor will destroy this timer object. -.SH "QTimer::~QTimer ()" -Destroys the timer. -.SH "void QTimer::changeInterval ( int msec )" -Changes the timeout interval to \fImsec\fR milliseconds. -.PP -If the timer signal is pending, it will be stopped and restarted; otherwise it will be started. -.PP -See also start() and isActive(). -.SH "bool QTimer::isActive () const" -Returns TRUE if the timer is running (pending); otherwise returns FALSE. -.PP -Example: t11/cannon.cpp. -.SH "void QTimer::singleShot ( int msec, QObject * receiver, const char * member )\fC [static]\fR" -This static function calls a slot after a given time interval. -.PP -It is very convenient to use this function because you do not need to bother with a timerEvent or to create a local QTimer object. -.PP -Example: -.PP -.nf -.br - #include <ntqapplication.h> -.br - #include <ntqtimer.h> -.br -.br - int main( int argc, char **argv ) -.br - { -.br - QApplication a( argc, argv ); -.br - QTimer::singleShot( 10*60*1000, &a, SLOT(quit()) ); -.br - ... // create and show your widgets -.br - return a.exec(); -.br - } -.br -.fi -.PP -This sample program automatically terminates after 10 minutes (i.e. 600000 milliseconds). -.PP -The \fIreceiver\fR is the receiving object and the \fImember\fR is the slot. The time interval is \fImsec\fR. -.SH "int QTimer::start ( int msec, bool sshot = FALSE )" -Starts the timer with a \fImsec\fR milliseconds timeout, and returns the ID of the timer, or zero when starting the timer failed. -.PP -If \fIsshot\fR is TRUE, the timer will be activated only once; otherwise it will continue until it is stopped. -.PP -Any pending timer will be stopped. -.PP -See also singleShot(), stop(), changeInterval(), and isActive(). -.PP -Examples: -.)l aclock/aclock.cpp, dirview/dirview.cpp, distributor/distributor.ui.h, forever/forever.cpp, hello/hello.cpp, t11/cannon.cpp, and t13/cannon.cpp. -.SH "void QTimer::stop ()" -Stops the timer. -.PP -See also start(). -.PP -Examples: -.)l dirview/dirview.cpp, t11/cannon.cpp, t12/cannon.cpp, and t13/cannon.cpp. -.SH "void QTimer::timeout ()\fC [signal]\fR" -This signal is emitted when the timer is activated. -.PP -Examples: -.)l aclock/aclock.cpp, dirview/dirview.cpp, distributor/distributor.ui.h, forever/forever.cpp, hello/hello.cpp, and t11/cannon.cpp. -.SH "int QTimer::timerId () const" -Returns the ID of the timer if the timer is running; otherwise returns --1. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtimer.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtimer.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtimerevent.3qt b/doc/man/man3/qtimerevent.3qt deleted file mode 100644 index 91be554f5..000000000 --- a/doc/man/man3/qtimerevent.3qt +++ /dev/null @@ -1,66 +0,0 @@ -'\" t -.TH QTimerEvent 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 -QTimerEvent \- Parameters that describe a timer event -.SH SYNOPSIS -\fC#include <ntqevent.h>\fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTimerEvent\fR ( int timerId )" -.br -.ti -1c -.BI "int \fBtimerId\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QTimerEvent class contains parameters that describe a timer event. -.PP -Timer events are sent at regular intervals to objects that have started one or more timers. Each timer has a unique identifier. A timer is started with QObject::startTimer(). -.PP -The QTimer class provides a high-level programming interface that uses signals instead of events. It also provides one-shot timers. -.PP -The event handler QObject::timerEvent() receives timer events. -.PP -See also QTimer, QObject::timerEvent(), QObject::startTimer(), QObject::killTimer(), QObject::killTimers(), and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTimerEvent::QTimerEvent ( int timerId )" -Constructs a timer event object with the timer identifier set to \fItimerId\fR. -.SH "int QTimerEvent::timerId () const" -Returns the unique timer identifier, which is the same identifier as returned from QObject::startTimer(). -.PP -Example: dclock/dclock.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtimerevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtimerevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtoolbar.3qt b/doc/man/man3/qtoolbar.3qt deleted file mode 100644 index fc753db5a..000000000 --- a/doc/man/man3/qtoolbar.3qt +++ /dev/null @@ -1,163 +0,0 @@ -'\" t -.TH QToolBar 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 -QToolBar \- Movable panel containing widgets such as tool buttons -.SH SYNOPSIS -\fC#include <ntqtoolbar.h>\fR -.PP -Inherits QDockWindow. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "QToolBar ( const QString & label, QMainWindow *, ToolBarDock = DockTop, bool newLine = FALSE, const char * name = 0 ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "\fBQToolBar\fR ( const QString & label, QMainWindow * mainWindow, QWidget * parent, bool newLine = FALSE, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQToolBar\fR ( QMainWindow * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "void \fBaddSeparator\fR ()" -.br -.ti -1c -.BI "QMainWindow * \fBmainWindow\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetStretchableWidget\fR ( QWidget * w )" -.br -.ti -1c -.BI "virtual void \fBsetLabel\fR ( const QString & )" -.br -.ti -1c -.BI "QString \fBlabel\fR () const" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QString \fBlabel\fR - the toolbar's label" -.br -.in -1c -.SH DESCRIPTION -The QToolBar class provides a movable panel containing widgets such as tool buttons. -.PP -A toolbar is a panel that contains a set of controls, usually represented by small icons. It's purpose is to provide quick access to frequently used commands or options. Within a QMainWindow the user can drag toolbars within and between the dock areas. Toolbars can also be dragged out of any dock area to float freely as top-level windows. -.PP -QToolBar is a specialization of QDockWindow, and so provides all the functionality of a QDockWindow. -.PP -To use QToolBar you simply create a QToolBar as a child of a QMainWindow, create a number of QToolButton widgets (or other widgets) in left to right (or top to bottom) order and call addSeparator() when you want a separator. When a toolbar is floated the caption used is the label given in the constructor call. This can be changed with setLabel(). -.PP -.nf -.br - QToolBar * fileTools = new QToolBar( this, "file operations" ); -.br - fileTools->setLabel( "File Operations" ); -.br - fileOpenAction->addTo( fileTools ); -.br - fileSaveAction->addTo( fileTools ); -.fi -.PP -This extract from the application/application.cpp example shows the creation of a new toolbar as a child of a QMainWindow and adding two QActions. -.PP -You may use most widgets within a toolbar, with QToolButton and QComboBox being the most common. -.PP -If you create a new widget on an already visible QToolBar, this widget will automatically become visible without needing a show() call. (This differs from every other Qt widget container. We recommend calling show() anyway since we hope to fix this anomaly in a future release.) -.PP -QToolBars, like QDockWindows, are located in QDockAreas or float as top-level windows. QMainWindow provides four QDockAreas (top, left, right and bottom). When you create a new toolbar (as in the example above) as a child of a QMainWindow the toolbar will be added to the top dock area. You can move it to another dock area (or float it) by calling QMainWindow::moveDockWindow(). QDock areas lay out their windows in Lines. -.PP -If the main window is resized so that the area occupied by the toolbar is too small to show all its widgets a little arrow button (which looks like a right-pointing chevron, '»') will appear at the right or bottom of the toolbar depending on its orientation. Clicking this button pops up a menu that shows the 'overflowing' items. QToolButtons are represented in the menu using their textLabel property, other QButton subclasses are represented using their text property, and QComboBoxes are represented as submenus, with the caption text being used in the submenu item. -.PP -Usually a toolbar will get precisely the space it needs. However, with setHorizontalStretchable(), setVerticalStretchable() or setStretchableWidget() you can tell the main window to expand the toolbar to fill all available space in the specified orientation. -.PP -The toolbar arranges its buttons either horizontally or vertically (see orientation() for details). Generally, QDockArea will set the orientation correctly for you, but you can set it yourself with setOrientation() and track any changes by connecting to the orientationChanged() signal. -.PP -You can use the clear() method to remove all items from a toolbar. -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> <blockquote><p align="center">\fI A floating QToolbar (dock window) \fR</p> </blockquote> -.PP -See also QToolButton, QMainWindow, Parts of Isys on Visual Design, GUI Design Handbook: Tool Bar, and Main Window and Related Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QToolBar::QToolBar ( const QString & label, QMainWindow *, ToolBarDock = DockTop, bool newLine = FALSE, const char * name = 0 )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QToolBar::QToolBar ( const QString & label, QMainWindow * mainWindow, QWidget * parent, bool newLine = FALSE, const char * name = 0, WFlags f = 0 )" -Constructs an empty horizontal toolbar. -.PP -The toolbar is called \fIname\fR and is a child of \fIparent\fR and is managed by \fImainWindow\fR. The \fIlabel\fR and \fInewLine\fR parameters are passed straight to QMainWindow::addDockWindow(). \fIname\fR and the widget flags \fIf\fR are passed on to the QDockWindow constructor. -.PP -Use this constructor if you want to create torn-off (undocked, floating) toolbars or toolbars in the status bar. -.SH "QToolBar::QToolBar ( QMainWindow * parent = 0, const char * name = 0 )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs an empty toolbar called \fIname\fR, with parent \fIparent\fR, in its \fIparent\fR's top dock area, without any label and without requiring a newline. -.SH "void QToolBar::addSeparator ()" -Adds a separator to the right/bottom of the toolbar. -.PP -Examples: -.)l chart/chartform.cpp, fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, qfd/fontdisplayer.cpp, and scribble/scribble.cpp. -.SH "void QToolBar::clear ()\fC [virtual]\fR" -Deletes all the toolbar's child widgets. -.SH "QString QToolBar::label () const" -Returns the toolbar's label. See the "label" property for details. -.SH "QMainWindow * QToolBar::mainWindow () const" -Returns a pointer to the QMainWindow which manages this toolbar. -.SH "void QToolBar::setLabel ( const QString & )\fC [virtual]\fR" -Sets the toolbar's label. See the "label" property for details. -.SH "void QToolBar::setStretchableWidget ( QWidget * w )\fC [virtual]\fR" -Sets the widget \fIw\fR to be expanded if this toolbar is requested to stretch. -.PP -The request to stretch might occur because QMainWindow right-justifies the dock area the toolbar is in, or because this toolbar's isVerticalStretchable() or isHorizontalStretchable() is set to TRUE. -.PP -If you call this function and the toolbar is not yet stretchable, setStretchable() is called. -.PP -See also QMainWindow::rightJustification, setVerticalStretchable(), and setHorizontalStretchable(). -.PP -Examples: -.)l fileiconview/mainwindow.cpp and helpviewer/helpwindow.cpp. -.SS "Property Documentation" -.SH "QString label" -This property holds the toolbar's label. -.PP -If the toolbar is floated the label becomes the toolbar window's caption. There is no default label text. -.PP -Set this property's value with setLabel() and get this property's value with label(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtoolbar.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtoolbar.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtoolbox.3qt b/doc/man/man3/qtoolbox.3qt deleted file mode 100644 index c7f961423..000000000 --- a/doc/man/man3/qtoolbox.3qt +++ /dev/null @@ -1,211 +0,0 @@ -'\" t -.TH QToolBox 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 -QToolBox \- Column of tabbed widget items -.SH SYNOPSIS -\fC#include <ntqtoolbox.h>\fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQToolBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "int \fBaddItem\fR ( QWidget * w, const QString & label )" -.br -.ti -1c -.BI "int \fBaddItem\fR ( QWidget * item, const QIconSet & iconSet, const QString & label )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( int index, QWidget * item, const QString & label )" -.br -.ti -1c -.BI "int \fBinsertItem\fR ( int index, QWidget * item, const QIconSet & iconSet, const QString & label )" -.br -.ti -1c -.BI "int \fBremoveItem\fR ( QWidget * item )" -.br -.ti -1c -.BI "void \fBsetItemEnabled\fR ( int index, bool enabled )" -.br -.ti -1c -.BI "bool \fBisItemEnabled\fR ( int index ) const" -.br -.ti -1c -.BI "void \fBsetItemLabel\fR ( int index, const QString & label )" -.br -.ti -1c -.BI "QString \fBitemLabel\fR ( int index ) const" -.br -.ti -1c -.BI "void \fBsetItemIconSet\fR ( int index, const QIconSet & iconSet )" -.br -.ti -1c -.BI "QIconSet \fBitemIconSet\fR ( int index ) const" -.br -.ti -1c -.BI "void \fBsetItemToolTip\fR ( int index, const QString & toolTip )" -.br -.ti -1c -.BI "QString \fBitemToolTip\fR ( int index ) const" -.br -.ti -1c -.BI "QWidget * \fBcurrentItem\fR () const" -.br -.ti -1c -.BI "void \fBsetCurrentItem\fR ( QWidget * item )" -.br -.ti -1c -.BI "int \fBcurrentIndex\fR () const" -.br -.ti -1c -.BI "QWidget * \fBitem\fR ( int index ) const" -.br -.ti -1c -.BI "int \fBindexOf\fR ( QWidget * item ) const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBsetCurrentIndex\fR ( int index )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBcurrentChanged\fR ( int index )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "int \fBcount\fR - the number of items contained in the toolbox \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBcurrentIndex\fR - the index of the current " "item" ", or -1 if the toolbox is empty" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBitemInserted\fR ( int index )" -.br -.ti -1c -.BI "virtual void \fBitemRemoved\fR ( int index )" -.br -.in -1c -.SH DESCRIPTION -The QToolBox class provides a column of tabbed widget items. -.PP -A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. Every tab has an index position within the column of tabs. A tab's item is a QWidget. -.PP -Each item has an itemLabel(), an optional icon, itemIconSet(), an optional itemToolTip(), and a widget. The item's attributes can be changed with setItemLabel(), setItemIconSet() and setItemToolTip(). -.PP -Items are added using addItem(), or inserted at particular positions using insertItem(). The total number of items is given by count(). Items can be deleted with delete, or removed from the toolbox with removeItem(). Combining removeItem() and insertItem() allows to move items to different positions. -.PP -The current item widget is returned by currentItem() and set with setCurrentItem(). If you prefer you can work in terms of indexes using currentIndex(), setCurrentIndex(), indexOf() and item(). -.PP -The currentChanged() signal is emitted when the current item is changed. -.PP -See also QTabWidget and Advanced Widgets. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QToolBox::QToolBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a toolbox called \fIname\fR with parent \fIparent\fR and flags \fIf\fR. -.SH "int QToolBox::addItem ( QWidget * item, const QIconSet & iconSet, const QString & label )" -Adds the widget \fIitem\fR in a new tab at bottom of the toolbox. The new tab's label is set to \fIlabel\fR, and the \fIiconSet\fR is displayed to the left of the \fIlabel\fR. Returns the new tab's index. -.SH "int QToolBox::addItem ( QWidget * w, const QString & label )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds the widget \fIw\fR in a new tab at bottom of the toolbox. The new tab's label is set to \fIlabel\fR. Returns the new tab's index. -.SH "int QToolBox::count () const" -Returns the number of items contained in the toolbox. See the "count" property for details. -.SH "void QToolBox::currentChanged ( int index )\fC [signal]\fR" -This signal is emitted when the current item changed. The new current item's index is passed in \fIindex\fR, or -1 if there is no current item. -.SH "int QToolBox::currentIndex () const" -Returns the index of the current item, or -1 if the toolbox is empty. See the "currentIndex" property for details. -.SH "QWidget * QToolBox::currentItem () const" -Returns the toolbox's current item, or 0 if the toolbox is empty. -.SH "int QToolBox::indexOf ( QWidget * item ) const" -Returns the index of item \fIitem\fR, or -1 if the item does not exist. -.SH "int QToolBox::insertItem ( int index, QWidget * item, const QIconSet & iconSet, const QString & label )" -Inserts the widget \fIitem\fR at position \fIindex\fR, or at the bottom of the toolbox if \fIindex\fR is out of range. The new item's label is set to \fIlabel\fR, and the \fIiconSet\fR is displayed to the left of the \fIlabel\fR. Returns the new item's index. -.SH "int QToolBox::insertItem ( int index, QWidget * item, const QString & label )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts the widget \fIitem\fR at position \fIindex\fR, or at the bottom of the toolbox if \fIindex\fR is out of range. The new item's label is set to \fIlabel\fR. Returns the new item's index. -.SH "bool QToolBox::isItemEnabled ( int index ) const" -Returns TRUE if the item at position \fIindex\fR is enabled; otherwise returns FALSE. -.SH "QWidget * QToolBox::item ( int index ) const" -Returns the item at position \fIindex\fR, or 0 if there is no such item. -.SH "QIconSet QToolBox::itemIconSet ( int index ) const" -Returns the icon of the item at position \fIindex\fR, or a null icon if \fIindex\fR is out of range. -.SH "void QToolBox::itemInserted ( int index )\fC [virtual protected]\fR" -This virtual handler is called after a new item was added or inserted at position \fIindex\fR. -.SH "QString QToolBox::itemLabel ( int index ) const" -Returns the label of the item at position \fIindex\fR, or a null string if \fIindex\fR is out of range. -.SH "void QToolBox::itemRemoved ( int index )\fC [virtual protected]\fR" -This virtual handler is called after an item was removed from position \fIindex\fR. -.SH "QString QToolBox::itemToolTip ( int index ) const" -Returns the tooltip of the item at position \fIindex\fR, or a null string if \fIindex\fR is out of range. -.SH "int QToolBox::removeItem ( QWidget * item )" -Removes the widget \fIitem\fR from the toolbox. Note that the widget is \fInot\fR deleted. Returns the removed widget's index, or -1 if the widget was not in this tool box. -.SH "void QToolBox::setCurrentIndex ( int index )\fC [slot]\fR" -Sets the index of the current item, or -1 if the toolbox is empty to \fIindex\fR. See the "currentIndex" property for details. -.SH "void QToolBox::setCurrentItem ( QWidget * item )" -Sets the current item to be \fIitem\fR. -.SH "void QToolBox::setItemEnabled ( int index, bool enabled )" -If \fIenabled\fR is TRUE then the item at position \fIindex\fR is enabled; otherwise item \fIindex\fR is disabled. -.SH "void QToolBox::setItemIconSet ( int index, const QIconSet & iconSet )" -Sets the icon of the item at position \fIindex\fR to \fIiconSet\fR. -.SH "void QToolBox::setItemLabel ( int index, const QString & label )" -Sets the label of the item at position \fIindex\fR to \fIlabel\fR. -.SH "void QToolBox::setItemToolTip ( int index, const QString & toolTip )" -Sets the tooltip of the item at position \fIindex\fR to \fItoolTip\fR. -.SS "Property Documentation" -.SH "int count" -This property holds the number of items contained in the toolbox. -.PP -Get this property's value with count(). -.SH "int currentIndex" -This property holds the index of the current item, or -1 if the toolbox is empty. -.PP -Set this property's value with setCurrentIndex() and get this property's value with currentIndex(). -.PP -See also currentItem(), indexOf(), and item(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtoolbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtoolbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtoolbutton.3qt b/doc/man/man3/qtoolbutton.3qt deleted file mode 100644 index 94d0c49c8..000000000 --- a/doc/man/man3/qtoolbutton.3qt +++ /dev/null @@ -1,419 +0,0 @@ -'\" t -.TH QToolButton 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 -QToolButton \- Quick-access button to commands or options, usually used inside a QToolBar -.SH SYNOPSIS -\fC#include <ntqtoolbutton.h>\fR -.PP -Inherits QButton. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBTextPosition\fR { BesideIcon, BelowIcon, Right = BesideIcon, Under = BelowIcon }" -.br -.ti -1c -.BI "\fBQToolButton\fR ( QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQToolButton\fR ( const QIconSet & iconSet, const QString & textLabel, const QString & grouptext, QObject * receiver, const char * slot, QToolBar * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQToolButton\fR ( ArrowType type, QWidget * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QToolButton\fR ()" -.br -.ti -1c -.BI "void setOnIconSet ( const QIconSet & ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setOffIconSet ( const QIconSet & ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setIconSet ( const QIconSet & set, bool on ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QIconSet onIconSet () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QIconSet offIconSet () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QIconSet iconSet ( bool on ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void \fBsetIconSet\fR ( const QIconSet & )" -.br -.ti -1c -.BI "QIconSet \fBiconSet\fR () const" -.br -.ti -1c -.BI "bool \fBusesBigPixmap\fR () const" -.br -.ti -1c -.BI "bool \fBusesTextLabel\fR () const" -.br -.ti -1c -.BI "QString \fBtextLabel\fR () const" -.br -.ti -1c -.BI "void \fBsetPopup\fR ( QPopupMenu * popup )" -.br -.ti -1c -.BI "QPopupMenu * \fBpopup\fR () const" -.br -.ti -1c -.BI "void \fBsetPopupDelay\fR ( int delay )" -.br -.ti -1c -.BI "int \fBpopupDelay\fR () const" -.br -.ti -1c -.BI "void \fBopenPopup\fR ()" -.br -.ti -1c -.BI "void \fBsetAutoRaise\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBautoRaise\fR () const" -.br -.ti -1c -.BI "TextPosition \fBtextPosition\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetUsesBigPixmap\fR ( bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetUsesTextLabel\fR ( bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetTextLabel\fR ( const QString & newLabel, bool tipToo )" -.br -.ti -1c -.BI "virtual void \fBsetToggleButton\fR ( bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetOn\fR ( bool enable )" -.br -.ti -1c -.BI "void \fBtoggle\fR ()" -.br -.ti -1c -.BI "void \fBsetTextLabel\fR ( const QString & )" -.br -.ti -1c -.BI "void \fBsetTextPosition\fR ( TextPosition pos )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBautoRaise\fR - whether auto-raising is enabled" -.br -.ti -1c -.BI "BackgroundMode \fBbackgroundMode\fR - the toolbutton's background mode \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QIconSet \fBiconSet\fR - the icon set providing the icon shown on the button" -.br -.ti -1c -.BI "QIconSet offIconSet - the icon set that is used when the button is in an ""off"" state \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBon\fR - whether this tool button is on" -.br -.ti -1c -.BI "QIconSet onIconSet - the icon set that is used when the button is in an ""on"" state \fI(obsolete)\fR" -.br -.ti -1c -.BI "QPixmap \fBpixmap\fR - the pixmap of the button \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBpopupDelay\fR - the time delay between pressing the button and the appearance of the associated popup menu in milliseconds" -.br -.ti -1c -.BI "QString \fBtextLabel\fR - the label of this button" -.br -.ti -1c -.BI "TextPosition \fBtextPosition\fR - the position of the text label of this button" -.br -.ti -1c -.BI "bool \fBtoggleButton\fR - whether this tool button is a toggle button" -.br -.ti -1c -.BI "bool \fBusesBigPixmap\fR - whether this toolbutton uses big pixmaps" -.br -.ti -1c -.BI "bool \fBusesTextLabel\fR - whether the toolbutton displays a text label below the button pixmap" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "bool \fBuses3D\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QToolButton class provides a quick-access button to commands or options, usually used inside a QToolBar. -.PP -A tool button is a special button that provides quick-access to specific commands or options. As opposed to a normal command button, a tool button usually doesn't show a text label, but shows an icon instead. Its classic usage is to select tools, for example the "pen" tool in a drawing program. This would be implemented with a QToolButton as toggle button (see setToggleButton() ). -.PP -QToolButton supports auto-raising. In auto-raise mode, the button draws a 3D frame only when the mouse points at it. The feature is automatically turned on when a button is used inside a QToolBar. Change it with setAutoRaise(). -.PP -A tool button's icon is set as QIconSet. This makes it possible to specify different pixmaps for the disabled and active state. The disabled pixmap is used when the button's functionality is not available. The active pixmap is displayed when the button is auto-raised because the mouse pointer is hovering over it. -.PP -The button's look and dimension is adjustable with setUsesBigPixmap() and setUsesTextLabel(). When used inside a QToolBar in a QMainWindow, the button automatically adjusts to QMainWindow's settings (see QMainWindow::setUsesTextLabel() and QMainWindow::setUsesBigPixmaps()). The pixmap set on a QToolButton will be set to 22x22 if it is bigger than this size. If usesBigPixmap() is TRUE, then the pixmap will be set to 32x32. -.PP -A tool button can offer additional choices in a popup menu. The feature is sometimes used with the "Back" button in a web browser. After pressing and holding the button down for a while, a menu pops up showing a list of possible pages to jump to. With QToolButton you can set a popup menu using setPopup(). The default delay is 600ms; you can adjust it with setPopupDelay(). -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> QToolbar with QToolbuttons -.PP -See also QPushButton, QToolBar, QMainWindow, GUI Design Handbook: Push Button, and Basic Widgets. -.SS "Member Type Documentation" -.SH "QToolButton::TextPosition" -The position of the tool button's textLabel in relation to the tool button's icon. -.TP -\fCQToolButton::BesideIcon\fR - The text appears beside the icon. -.TP -\fCQToolButton::BelowIcon\fR - The text appears below the icon. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QToolButton::QToolButton ( QWidget * parent, const char * name = 0 )" -Constructs an empty tool button called \fIname\fR, with parent \fIparent\fR. -.SH "QToolButton::QToolButton ( const QIconSet & iconSet, const QString & textLabel, const QString & grouptext, QObject * receiver, const char * slot, QToolBar * parent, const char * name = 0 )" -Constructs a tool button called \fIname\fR, that is a child of \fIparent\fR (which must be a QToolBar). -.PP -The tool button will display \fIiconSet\fR, with its text label and tool tip set to \fItextLabel\fR and its status bar message set to \fIgrouptext\fR. It will be connected to the \fIslot\fR in object \fIreceiver\fR. -.SH "QToolButton::QToolButton ( ArrowType type, QWidget * parent, const char * name = 0 )" -Constructs a tool button as an arrow button. The ArrowType \fItype\fR defines the arrow direction. Possible values are LeftArrow, RightArrow, UpArrow and DownArrow. -.PP -An arrow button has auto-repeat turned on by default. -.PP -The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. -.SH "QToolButton::~QToolButton ()" -Destroys the object and frees any allocated resources. -.SH "bool QToolButton::autoRaise () const" -Returns TRUE if auto-raising is enabled; otherwise returns FALSE. See the "autoRaise" property for details. -.SH "QIconSet QToolButton::iconSet () const" -Returns the icon set providing the icon shown on the button. See the "iconSet" property for details. -.SH "QIconSet QToolButton::iconSet ( bool on ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Since Qt 3.0, QIconSet contains both the On and Off icons. -.PP -For ease of porting, this function ignores the \fIon\fR parameter and returns the iconSet property. If you relied on the \fIon\fR parameter, you probably want to update your code to use the QIconSet On/Off mechanism. -.SH "QIconSet QToolButton::offIconSet () const" -Returns the icon set that is used when the button is in an "off" state. See the "offIconSet" property for details. -.SH "QIconSet QToolButton::onIconSet () const" -Returns the icon set that is used when the button is in an "on" state. See the "onIconSet" property for details. -.SH "void QToolButton::openPopup ()" -Opens (pops up) the associated popup menu. If there is no such menu, this function does nothing. This function does not return until the popup menu has been closed by the user. -.SH "QPopupMenu * QToolButton::popup () const" -Returns the associated popup menu, or 0 if no popup menu has been defined. -.PP -See also setPopup(). -.SH "int QToolButton::popupDelay () const" -Returns the time delay between pressing the button and the appearance of the associated popup menu in milliseconds. See the "popupDelay" property for details. -.SH "void QToolButton::setAutoRaise ( bool enable )" -Sets whether auto-raising is enabled to \fIenable\fR. See the "autoRaise" property for details. -.SH "void QToolButton::setIconSet ( const QIconSet & )\fC [virtual]\fR" -Sets the icon set providing the icon shown on the button. See the "iconSet" property for details. -.SH "void QToolButton::setIconSet ( const QIconSet & set, bool on )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Since Qt 3.0, QIconSet contains both the On and Off icons. -.PP -For ease of porting, this function ignores the \fIon\fR parameter and sets the iconSet property. If you relied on the \fIon\fR parameter, you probably want to update your code to use the QIconSet On/Off mechanism. -.PP -See also iconSet and QIconSet::State. -.SH "void QToolButton::setOffIconSet ( const QIconSet & )" -Sets the icon set that is used when the button is in an "off" state. See the "offIconSet" property for details. -.SH "void QToolButton::setOn ( bool enable )\fC [virtual slot]\fR" -Sets whether this tool button is on to \fIenable\fR. See the "on" property for details. -.SH "void QToolButton::setOnIconSet ( const QIconSet & )" -Sets the icon set that is used when the button is in an "on" state. See the "onIconSet" property for details. -.SH "void QToolButton::setPopup ( QPopupMenu * popup )" -Associates the popup menu \fIpopup\fR with this tool button. -.PP -The popup will be shown each time the tool button has been pressed down for a certain amount of time. A typical application example is the "back" button in some web browsers's tool bars. If the user clicks it, the browser simply browses back to the previous page. If the user presses and holds the button down for a while, the tool button shows a menu containing the current history list. -.PP -Ownership of the popup menu is not transferred to the tool button. -.PP -See also popup(). -.SH "void QToolButton::setPopupDelay ( int delay )" -Sets the time delay between pressing the button and the appearance of the associated popup menu in milliseconds to \fIdelay\fR. See the "popupDelay" property for details. -.SH "void QToolButton::setTextLabel ( const QString & )\fC [slot]\fR" -Sets the label of this button. See the "textLabel" property for details. -.SH "void QToolButton::setTextLabel ( const QString & newLabel, bool tipToo )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the label of this button to \fInewLabel\fR and automatically sets it as a tool tip if \fItipToo\fR is TRUE. -.SH "void QToolButton::setTextPosition ( TextPosition pos )\fC [slot]\fR" -Sets the position of the text label of this button to \fIpos\fR. See the "textPosition" property for details. -.SH "void QToolButton::setToggleButton ( bool enable )\fC [virtual slot]\fR" -Sets whether this tool button is a toggle button to \fIenable\fR. See the "toggleButton" property for details. -.SH "void QToolButton::setUsesBigPixmap ( bool enable )\fC [virtual slot]\fR" -Sets whether this toolbutton uses big pixmaps to \fIenable\fR. See the "usesBigPixmap" property for details. -.SH "void QToolButton::setUsesTextLabel ( bool enable )\fC [virtual slot]\fR" -Sets whether the toolbutton displays a text label below the button pixmap to \fIenable\fR. See the "usesTextLabel" property for details. -.SH "QString QToolButton::textLabel () const" -Returns the label of this button. See the "textLabel" property for details. -.SH "TextPosition QToolButton::textPosition () const" -Returns the position of the text label of this button. See the "textPosition" property for details. -.SH "void QToolButton::toggle ()\fC [slot]\fR" -Toggles the state of this tool button. -.PP -This function has no effect on non-toggling buttons. -.PP -See also toggleButton and toggled(). -.SH "bool QToolButton::uses3D () const\fC [protected]\fR" -Returns TRUE if this button should be drawn using raised edges; otherwise returns FALSE. -.PP -See also drawButton(). -.SH "bool QToolButton::usesBigPixmap () const" -Returns TRUE if this toolbutton uses big pixmaps; otherwise returns FALSE. See the "usesBigPixmap" property for details. -.SH "bool QToolButton::usesTextLabel () const" -Returns TRUE if the toolbutton displays a text label below the button pixmap; otherwise returns FALSE. See the "usesTextLabel" property for details. -.SS "Property Documentation" -.SH "bool autoRaise" -This property holds whether auto-raising is enabled. -.PP -The default is disabled (i.e. FALSE). -.PP -Set this property's value with setAutoRaise() and get this property's value with autoRaise(). -.SH "BackgroundMode backgroundMode" -This property holds the toolbutton's background mode. -.PP -Get this property with backgroundMode(). -.PP -See also QWidget::backgroundMode. -.SH "QIconSet iconSet" -This property holds the icon set providing the icon shown on the button. -.PP -Setting this property sets QToolButton::pixmap to a null pixmap. There is no default iconset. -.PP -See also pixmap, toggleButton, and on. -.PP -Set this property's value with setIconSet() and get this property's value with iconSet(). -.SH "QIconSet offIconSet" -This property holds the icon set that is used when the button is in an "off" state. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Since Qt 3.0, QIconSet contains both the On and Off icons. There is now an QToolButton::iconSet property that replaces both QToolButton::onIconSet and QToolButton::offIconSet. -.PP -For ease of porting, this property is a synonym for QToolButton::iconSet. You probably want to go over your application code and use the QIconSet On/Off mechanism. -.PP -See also iconSet and QIconSet::State. -.PP -Set this property's value with setOffIconSet() and get this property's value with offIconSet(). -.SH "bool on" -This property holds whether this tool button is on. -.PP -This property has no effect on non-toggling buttons. The default is FALSE (i.e. off). -.PP -See also toggleButton and toggle(). -.PP -Set this property's value with setOn(). -.SH "QIconSet onIconSet" -This property holds the icon set that is used when the button is in an "on" state. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Since Qt 3.0, QIconSet contains both the On and Off icons. There is now an QToolButton::iconSet property that replaces both QToolButton::onIconSet and QToolButton::offIconSet. -.PP -For ease of porting, this property is a synonym for QToolButton::iconSet. You probably want to go over your application code and use the QIconSet On/Off mechanism. -.PP -See also iconSet and QIconSet::State. -.PP -Set this property's value with setOnIconSet() and get this property's value with onIconSet(). -.SH "QPixmap pixmap" -This property holds the pixmap of the button. -.PP -The pixmap property has no meaning for tool buttons. Use the iconSet property instead. -.SH "int popupDelay" -This property holds the time delay between pressing the button and the appearance of the associated popup menu in milliseconds. -.PP -Usually this is around half a second. A value of 0 draws the down arrow button to the side of the button which can be used to open up the popup menu. -.PP -See also setPopup(). -.PP -Set this property's value with setPopupDelay() and get this property's value with popupDelay(). -.SH "QString textLabel" -This property holds the label of this button. -.PP -Setting this property automatically sets the text as a tool tip too. There is no default text. -.PP -Set this property's value with setTextLabel() and get this property's value with textLabel(). -.SH "TextPosition textPosition" -This property holds the position of the text label of this button. -.PP -Set this property's value with setTextPosition() and get this property's value with textPosition(). -.SH "bool toggleButton" -This property holds whether this tool button is a toggle button. -.PP -Toggle buttons have an on/off state similar to check boxes. A tool button is not a toggle button by default. -.PP -See also on and toggle(). -.PP -Set this property's value with setToggleButton(). -.SH "bool usesBigPixmap" -This property holds whether this toolbutton uses big pixmaps. -.PP -QToolButton automatically connects this property to the relevant signal in the QMainWindow in which it resides. We strongly recommend that you use QMainWindow::setUsesBigPixmaps() instead. -.PP -This property's default is TRUE. -.PP -\fBWarning:\fR If you set some buttons (in a QMainWindow) to have big pixmaps and others to have small pixmaps, QMainWindow may not get the geometry right. -.PP -Set this property's value with setUsesBigPixmap() and get this property's value with usesBigPixmap(). -.SH "bool usesTextLabel" -This property holds whether the toolbutton displays a text label below the button pixmap. -.PP -The default is FALSE. -.PP -QToolButton automatically connects this slot to the relevant signal in the QMainWindow in which is resides. -.PP -Set this property's value with setUsesTextLabel() and get this property's value with usesTextLabel(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtoolbutton.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtoolbutton.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtooltip.3qt b/doc/man/man3/qtooltip.3qt deleted file mode 100644 index b9a8bd878..000000000 --- a/doc/man/man3/qtooltip.3qt +++ /dev/null @@ -1,354 +0,0 @@ -'\" t -.TH QToolTip 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 -QToolTip \- Tool tips (balloon help) for any widget or rectangular part of a widget -.SH SYNOPSIS -\fC#include <ntqtooltip.h>\fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQToolTip\fR ( QWidget * widget, QToolTipGroup * group = 0 )" -.br -.ti -1c -.BI "QWidget * \fBparentWidget\fR () const" -.br -.ti -1c -.BI "QToolTipGroup * \fBgroup\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBadd\fR ( QWidget * widget, const QString & text )" -.br -.ti -1c -.BI "void \fBadd\fR ( QWidget * widget, const QString & text, QToolTipGroup * group, const QString & longText )" -.br -.ti -1c -.BI "void \fBremove\fR ( QWidget * widget )" -.br -.ti -1c -.BI "void \fBadd\fR ( QWidget * widget, const QRect & rect, const QString & text )" -.br -.ti -1c -.BI "void \fBadd\fR ( QWidget * widget, const QRect & rect, const QString & text, QToolTipGroup * group, const QString & groupText )" -.br -.ti -1c -.BI "void \fBremove\fR ( QWidget * widget, const QRect & rect )" -.br -.ti -1c -.BI "QString \fBtextFor\fR ( QWidget * widget, const QPoint & pos = QPoint ( ) )" -.br -.ti -1c -.BI "void \fBhide\fR ()" -.br -.ti -1c -.BI "QFont \fBfont\fR ()" -.br -.ti -1c -.BI "void \fBsetFont\fR ( const QFont & font )" -.br -.ti -1c -.BI "QPalette \fBpalette\fR ()" -.br -.ti -1c -.BI "void \fBsetPalette\fR ( const QPalette & palette )" -.br -.ti -1c -.BI "void setEnabled ( bool enable ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool enabled () \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetGloballyEnabled\fR ( bool enable )" -.br -.ti -1c -.BI "bool \fBisGloballyEnabled\fR ()" -.br -.ti -1c -.BI "void \fBsetWakeUpDelay\fR ( int i )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBmaybeTip\fR ( const QPoint & p ) = 0" -.br -.ti -1c -.BI "void \fBtip\fR ( const QRect & rect, const QString & text )" -.br -.ti -1c -.BI "void \fBtip\fR ( const QRect & rect, const QString & text, const QString & groupText )" -.br -.ti -1c -.BI "void \fBtip\fR ( const QRect & rect, const QString & text, const QRect & geometry )" -.br -.ti -1c -.BI "void \fBtip\fR ( const QRect & rect, const QString & text, const QString & groupText, const QRect & geometry )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QToolTip class provides tool tips (balloon help) for any widget or rectangular part of a widget. -.PP -The tip is a short, single line of text reminding the user of the widget's or rectangle's function. It is drawn immediately below the region in a distinctive black-on-yellow combination. -.PP -The tip can be any Rich-Text formatted string. -.PP -QToolTipGroup provides a way for tool tips to display another text elsewhere (most often in a status bar). -.PP -At any point in time, QToolTip is either dormant or active. In dormant mode the tips are not shown and in active mode they are. The mode is global, not particular to any one widget. -.PP -QToolTip switches from dormant to active mode when the user hovers the mouse on a tip-equipped region for a second or so and remains active until the user either clicks a mouse button, presses a key, lets the mouse hover for five seconds or moves the mouse outside \fIall\fR tip-equipped regions for at least a second. -.PP -The QToolTip class can be used in three different ways: <ol type=1> -.IP 1 -Adding a tip to an entire widget. -.IP 2 -Adding a tip to a fixed rectangle within a widget. -.IP 3 -Adding a tip to a dynamic rectangle within a widget. -.PP -To add a tip to a widget, call the \fIstatic\fR function QToolTip::add() with the widget and tip as arguments: -.PP -.nf -.br - QToolTip::add( quitButton, "Leave the application" ); -.br -.fi -.PP -This is the simplest and most common use of QToolTip. The tip will be deleted automatically when \fIquitButton\fR is deleted, but you can remove it yourself, too: -.PP -.nf -.br - QToolTip::remove( quitButton ); -.br -.fi -.PP -You can also display another text (typically in a status bar), courtesy of QToolTipGroup. This example assumes that \fIgrp\fR is a \fCQToolTipGroup *\fR and is already connected to the appropriate status bar: -.PP -.nf -.br - QToolTip::add( quitButton, "Leave the application", grp, -.br - "Leave the application, prompting to save if necessary" ); -.br - QToolTip::add( closeButton, "Close this window", grp, -.br - "Close this window, prompting to save if necessary" ); -.br -.fi -.PP -To add a tip to a fixed rectangle within a widget, call the static function QToolTip::add() with the widget, rectangle and tip as arguments. (See the tooltip/tooltip.cpp example.) Again, you can supply a \fCQToolTipGroup *\fR and another text if you want. -.PP -Both of these are one-liners and cover the majority of cases. The third and most general way to use QToolTip requires you to reimplement a pure virtual function to decide whether to pop up a tool tip. The tooltip/tooltip.cpp example demonstrates this too. This mode can be used to implement tips for text that can move as the user scrolls, for example. -.PP -To use QToolTip like this, you must subclass QToolTip and reimplement maybeTip(). QToolTip calls maybeTip() when a tip should pop up, and maybeTip() decides whether to show a tip. -.PP -Tool tips can be globally disabled using QToolTip::setGloballyEnabled() or disabled in groups with QToolTipGroup::setEnabled(). -.PP -You can retrieve the text of a tooltip for a given position within a widget using textFor(). -.PP -The global tooltip font and palette can be set with the static setFont() and setPalette() functions respectively. -.PP -See also QStatusBar, QWhatsThis, QToolTipGroup, GUI Design Handbook: Tool Tip, and Help System. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QToolTip::QToolTip ( QWidget * widget, QToolTipGroup * group = 0 )" -Constructs a tool tip object. This is only necessary if you need tool tips on regions that can move within the widget (most often because the widget's contents can scroll). -.PP -\fIwidget\fR is the widget you want to add dynamic tool tips to and \fIgroup\fR (optional) is the tool tip group they should belong to. -.PP -\fBWarning:\fR QToolTip is not a subclass of QObject, so the instance of QToolTip is not deleted when \fIwidget\fR is deleted. -.PP -\fBWarning:\fR If you delete the tool tip before you have deleted \fIwidget\fR then you need to make sure you call remove() yourself from \fIwidget\fR in your reimplemented QToolTip destructor. -.PP -.nf -.br - MyToolTip::~MyToolTip() -.br - { -.br - remove( widget ); -.br - } -.br -.fi -.PP -See also maybeTip(). -.SH "void QToolTip::add ( QWidget * widget, const QString & text )\fC [static]\fR" -Adds a tool tip to \fIwidget\fR. \fItext\fR is the text to be shown in the tool tip. -.PP -This is the most common entry point to the QToolTip class; it is suitable for adding tool tips to buttons, checkboxes, comboboxes and so on. -.PP -Examples: -.)l helpsystem/mainwindow.cpp, qdir/qdir.cpp, scribble/scribble.cpp, and tooltip/tooltip.cpp. -.SH "void QToolTip::add ( QWidget * widget, const QString & text, QToolTipGroup * group, const QString & longText )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a tool tip to \fIwidget\fR and to tool tip group \fIgroup\fR. -.PP -\fItext\fR is the text shown in the tool tip and \fIlongText\fR is the text emitted from \fIgroup\fR. -.PP -Normally, \fIlongText\fR is shown in a status bar or similar. -.SH "void QToolTip::add ( QWidget * widget, const QRect & rect, const QString & text )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a tool tip to a fixed rectangle, \fIrect\fR, within \fIwidget\fR. \fItext\fR is the text shown in the tool tip. -.SH "void QToolTip::add ( QWidget * widget, const QRect & rect, const QString & text, QToolTipGroup * group, const QString & groupText )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a tool tip to an entire \fIwidget\fR and to tool tip group \fIgroup\fR. The tooltip will disappear when the mouse leaves the \fIrect\fR. -.PP -\fItext\fR is the text shown in the tool tip and \fIgroupText\fR is the text emitted from \fIgroup\fR. -.PP -Normally, \fIgroupText\fR is shown in a status bar or similar. -.SH "void QToolTip::clear ()\fC [protected]\fR" -Immediately removes all tool tips for this tooltip's parent widget. -.SH "bool QToolTip::enabled ()\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "QFont QToolTip::font ()\fC [static]\fR" -Returns the font common to all tool tips. -.PP -See also setFont(). -.SH "QToolTipGroup * QToolTip::group () const" -Returns the tool tip group this QToolTip is a member of or 0 if it isn't a member of any group. -.PP -The tool tip group is the object responsible for maintaining contact between tool tips and a status bar or something else which can show the longer help text. -.PP -See also parentWidget() and QToolTipGroup. -.SH "void QToolTip::hide ()\fC [static]\fR" -Hides any tip that is currently being shown. -.PP -Normally, there is no need to call this function; QToolTip takes care of showing and hiding the tips as the user moves the mouse. -.SH "bool QToolTip::isGloballyEnabled ()\fC [static]\fR" -Returns whether tool tips are enabled globally. -.PP -See also setGloballyEnabled(). -.SH "void QToolTip::maybeTip ( const QPoint & p )\fC [pure virtual protected]\fR" -This pure virtual function is half of the most versatile interface QToolTip offers. -.PP -It is called when there is a possibility that a tool tip should be shown and must decide whether there is a tool tip for the point \fIp\fR in the widget that this QToolTip object relates to. If so, maybeTip() must call tip() with the rectangle the tip applies to, the tip's text and optionally the QToolTipGroup details and the geometry in screen coordinates. -.PP -\fIp\fR is given in that widget's local coordinates. Most maybeTip() implementations will be of the form: -.PP -.nf -.br - if ( <something> ) { -.br - tip( <something>, <something> ); -.br - } -.br -.fi -.PP -The first argument to tip() (a rectangle) must encompass \fIp\fR, i.e. the tip must apply to the current mouse position; otherwise QToolTip's operation is undefined. -.PP -Note that the tip will disappear once the mouse moves outside the rectangle you give to tip(), and will not reappear if the mouse moves back in: maybeTip() is called again instead. -.PP -See also tip(). -.PP -Examples: -.)l helpsystem/tooltip.cpp and tooltip/tooltip.cpp. -.SH "QPalette QToolTip::palette ()\fC [static]\fR" -Returns the palette common to all tool tips. -.PP -See also setPalette(). -.SH "QWidget * QToolTip::parentWidget () const" -Returns the widget this QToolTip applies to. -.PP -The tool tip is destroyed automatically when the parent widget is destroyed. -.PP -See also group(). -.SH "void QToolTip::remove ( QWidget * widget )\fC [static]\fR" -Removes the tool tip from \fIwidget\fR. -.PP -If there is more than one tool tip on \fIwidget\fR, only the one covering the entire widget is removed. -.SH "void QToolTip::remove ( QWidget * widget, const QRect & rect )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes any tool tip for \fIrect\fR from \fIwidget\fR. -.PP -If there is more than one tool tip on \fIwidget\fR, only the one covering rectangle \fIrect\fR is removed. -.SH "void QToolTip::setEnabled ( bool enable )\fC [static]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QToolTip::setFont ( const QFont & font )\fC [static]\fR" -Sets the font for all tool tips to \fIfont\fR. -.PP -See also font(). -.SH "void QToolTip::setGloballyEnabled ( bool enable )\fC [static]\fR" -If \fIenable\fR is TRUE sets all tool tips to be enabled (shown when needed); if \fIenable\fR is FALSE sets all tool tips to be disabled (never shown). -.PP -By default, tool tips are enabled. Note that this function affects all tool tips in the entire application. -.PP -See also QToolTipGroup::enabled. -.SH "void QToolTip::setPalette ( const QPalette & palette )\fC [static]\fR" -Sets the palette for all tool tips to \fIpalette\fR. -.PP -See also palette(). -.SH "void QToolTip::setWakeUpDelay ( int i )\fC [static]\fR" -Sets the wakeup delay for all tooltips to \fIi\fR milliseconds. -.SH "QString QToolTip::textFor ( QWidget * widget, const QPoint & pos = QPoint ( ) )\fC [static]\fR" -Returns the tool tip text for \fIwidget\fR at position \fIpos\fR, or QString::null if there is no tool tip for the given widget and position. -.SH "void QToolTip::tip ( const QRect & rect, const QString & text )\fC [protected]\fR" -Immediately pops up a tip saying \fItext\fR and removes the tip once the cursor moves out of rectangle \fIrect\fR (which is given in the coordinate system of the widget this QToolTip relates to). -.PP -The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. -.SH "void QToolTip::tip ( const QRect & rect, const QString & text, const QString & groupText )\fC [protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Immediately pops up a tip saying \fItext\fR and removes that tip once the cursor moves out of rectangle \fIrect\fR (which is given in the coordinate system of the widget this QToolTip relates to). \fIgroupText\fR is the text emitted from the group. -.PP -The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. -.SH "void QToolTip::tip ( const QRect & rect, const QString & text, const QRect & geometry )\fC [protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Immediately pops up a tip within the rectangle \fIgeometry\fR, saying \fItext\fR and removes the tip once the cursor moves out of rectangle \fIrect\fR. Both rectangles are given in the coordinate system of the widget this QToolTip relates to. -.PP -The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. -.PP -If the tip does not fit inside \fIgeometry\fR, the tip expands. -.SH "void QToolTip::tip ( const QRect & rect, const QString & text, const QString & groupText, const QRect & geometry )\fC [protected]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Immediately pops up a tip within the rectangle \fIgeometry\fR, saying \fItext\fR and removes the tip once the cursor moves out of rectangle \fIrect\fR. \fIgroupText\fR is the text emitted from the group. Both rectangles are given in the coordinate system of the widget this QToolTip relates to. -.PP -The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. -.PP -If the tip does not fit inside \fIgeometry\fR, the tip expands. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtooltip.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtooltip.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtooltipgroup.3qt b/doc/man/man3/qtooltipgroup.3qt deleted file mode 100644 index e3e0108c5..000000000 --- a/doc/man/man3/qtooltipgroup.3qt +++ /dev/null @@ -1,154 +0,0 @@ -'\" t -.TH QToolTipGroup 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 -QToolTipGroup \- Collects tool tips into related groups -.SH SYNOPSIS -\fC#include <ntqtooltip.h>\fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQToolTipGroup\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QToolTipGroup\fR ()" -.br -.ti -1c -.BI "bool \fBdelay\fR () const" -.br -.ti -1c -.BI "bool \fBenabled\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBsetDelay\fR ( bool )" -.br -.ti -1c -.BI "void \fBsetEnabled\fR ( bool )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBshowTip\fR ( const QString & longText )" -.br -.ti -1c -.BI "void \fBremoveTip\fR ()" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBdelay\fR - whether the display of the group text is delayed" -.br -.ti -1c -.BI "bool \fBenabled\fR - whether tool tips in the group are enabled" -.br -.in -1c -.SH DESCRIPTION -The QToolTipGroup class collects tool tips into related groups. -.PP -Tool tips can display \fItwo\fR texts: one in the tip and (optionally) one that is typically in a status bar. QToolTipGroup provides a way to link tool tips to this status bar. -.PP -QToolTipGroup has practically no API; it is only used as an argument to QToolTip's member functions, for example like this: -.PP -.nf -.br - QToolTipGroup * grp = new QToolTipGroup( this, "tool tip relay" ); -.br - connect( grp, SIGNAL(showTip(const QString&)), -.br - myLabel, SLOT(setText(const QString&)) ); -.br - connect( grp, SIGNAL(removeTip()), -.br - myLabel, SLOT(clear()) ); -.br - QToolTip::add( giraffeButton, "feed giraffe", -.br - grp, "Give the giraffe a meal" ); -.br - QToolTip::add( gorillaButton, "feed gorilla", -.br - grp, "Give the gorilla a meal" ); -.br -.fi -.PP -This example makes the object myLabel (which you must supply) display (one assumes, though you can make myLabel do anything, of course) the strings "Give the giraffe a meal" and "Give the gorilla a meal" while the relevant tool tips are being displayed. -.PP -Deleting a tool tip group removes the tool tips in it. -.PP -See also Help System. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QToolTipGroup::QToolTipGroup ( QObject * parent, const char * name = 0 )" -Constructs a tool tip group called \fIname\fR, with parent \fIparent\fR. -.SH "QToolTipGroup::~QToolTipGroup ()" -Destroys this tool tip group and all tool tips in it. -.SH "bool QToolTipGroup::delay () const" -Returns TRUE if the display of the group text is delayed; otherwise returns FALSE. See the "delay" property for details. -.SH "bool QToolTipGroup::enabled () const" -Returns TRUE if tool tips in the group are enabled; otherwise returns FALSE. See the "enabled" property for details. -.SH "void QToolTipGroup::removeTip ()\fC [signal]\fR" -This signal is emitted when a tool tip in this group is hidden. See the QToolTipGroup documentation for an example of use. -.PP -See also showTip(). -.PP -Example: helpsystem/mainwindow.cpp. -.SH "void QToolTipGroup::setDelay ( bool )\fC [slot]\fR" -Sets whether the display of the group text is delayed. See the "delay" property for details. -.SH "void QToolTipGroup::setEnabled ( bool )\fC [slot]\fR" -Sets whether tool tips in the group are enabled. See the "enabled" property for details. -.SH "void QToolTipGroup::showTip ( const QString & longText )\fC [signal]\fR" -This signal is emitted when one of the tool tips in the group is displayed. \fIlongText\fR is the extra text for the displayed tool tip. -.PP -See also removeTip(). -.PP -Example: helpsystem/mainwindow.cpp. -.SS "Property Documentation" -.SH "bool delay" -This property holds whether the display of the group text is delayed. -.PP -If set to TRUE (the default), the group text is displayed at the same time as the tool tip. Otherwise, the group text is displayed immediately when the cursor enters the widget. -.PP -Set this property's value with setDelay() and get this property's value with delay(). -.SH "bool enabled" -This property holds whether tool tips in the group are enabled. -.PP -This property's default is TRUE. -.PP -Set this property's value with setEnabled() and get this property's value with enabled(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtooltipgroup.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtooltipgroup.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtranslator.3qt b/doc/man/man3/qtranslator.3qt deleted file mode 100644 index 8c237907d..000000000 --- a/doc/man/man3/qtranslator.3qt +++ /dev/null @@ -1,297 +0,0 @@ -'\" t -.TH QTranslator 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 -QTranslator \- -.SH SYNOPSIS -\fC#include <ntqtranslator.h>\fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTranslator\fR ( QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QTranslator\fR ()" -.br -.ti -1c -.BI "QString find ( const char * context, const char * sourceText, const char * comment = 0 ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual QTranslatorMessage \fBfindMessage\fR ( const char * context, const char * sourceText, const char * comment = 0 ) const" -.br -.ti -1c -.BI "bool \fBload\fR ( const QString & filename, const QString & directory = QString::null, const QString & search_delimiters = QString::null, const QString & suffix = QString::null )" -.br -.ti -1c -.BI "bool \fBload\fR ( const uchar * data, int len )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "enum \fBSaveMode\fR { Everything, Stripped }" -.br -.ti -1c -.BI "bool \fBsave\fR ( const QString & filename, SaveMode mode = Everything )" -.br -.ti -1c -.BI "void \fBinsert\fR ( const QTranslatorMessage & message )" -.br -.ti -1c -.BI "void insert ( const char * context, const char * sourceText, const QString & translation ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBremove\fR ( const QTranslatorMessage & message )" -.br -.ti -1c -.BI "void remove ( const char * context, const char * sourceText ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBcontains\fR ( const char * context, const char * sourceText, const char * comment = 0 ) const" -.br -.ti -1c -.BI "void \fBsqueeze\fR ( SaveMode mode = Everything )" -.br -.ti -1c -.BI "void \fBunsqueeze\fR ()" -.br -.ti -1c -.BI "QValueList<QTranslatorMessage> \fBmessages\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QTranslator class provides internationalization support for text output. -.PP -An object of this class contains a set of QTranslatorMessage objects, each of which specifies a translation from a source language to a target language. QTranslator provides functions to look up translations, add new ones, remove them, load and save them, etc. -.PP -The most common use of QTranslator is to: load a translator file created with Qt Linguist, install it using QApplication::installTranslator(), and use it via QObject::tr(). For example: -.PP -.nf -.br - int main( int argc, char ** argv ) -.br - { -.br - QApplication app( argc, argv ); -.br -.br - QTranslator translator( 0 ); -.br - translator.load( "french.qm", "." ); -.br - app.installTranslator( &translator ); -.br -.br - MyWidget m; -.br - app.setMainWidget( &m ); -.br - m.show(); -.br -.br - return app.exec(); -.br - } -.br -.fi -Note that the translator must be created \fIbefore\fR the application's main window. -.PP -Most applications will never need to do anything else with this class. The other functions provided by this class are useful for applications that work on translator files. -.PP -We call a translation a "messsage". For this reason, translation files are sometimes referred to as "message files". -.PP -It is possible to lookup a translation using findMessage() (as tr() and QApplication::translate() do) and contains(), to insert a new translation messsage using insert(), and to remove one using remove(). -.PP -Translation tools often need more information than the bare source text and translation, for example, context information to help the translator. But end-user programs that are using translations usually only need lookup. To cater for these different needs, QTranslator can use stripped translator files that use the minimum of memory and which support little more functionality than findMessage(). -.PP -Thus, load() may not load enough information to make anything more than findMessage() work. save() has an argument indicating whether to save just this minimum of information or to save everything. -.PP" -Everything" means that for each translation item the following information is kept: -.TP -The \fItranslated text\fR - the return value from tr(). -.TP -The input key: -.TP -The \fIsource text\fR - usually the argument to tr(). -.TP -The \fIcontext\fR - usually the class name for the tr() caller. -.TP -The \fIcomment\fR - a comment that helps disambiguate different uses of the same text in the same context. -.PP -The minimum for each item is just the information necessary for findMessage() to return the right text. This may include the source, context and comment, but usually it is just a hash value and the translated text. -.PP -For example, the "Cancel" in a dialog might have "Anuluj" when the program runs in Polish (in this case the source text would be" Cancel"). The context would (normally) be the dialog's class name; there would normally be no comment, and the translated text would be "Anuluj". -.PP -But it's not always so simple. The Spanish version of a printer dialog with settings for two-sided printing and binding would probably require both "Activado" and "Activada" as translations for "Enabled". In this case the source text would be "Enabled" in both cases, and the context would be the dialog's class name, but the two items would have disambiguating comments such as" two-sided printing" for one and "binding" for the other. The comment enables the translator to choose the appropriate gender for the Spanish version, and enables Qt to distinguish between translations. -.PP -Note that when QTranslator loads a stripped file, most functions do not work. The functions that do work with stripped files are explicitly documented as such. -.PP -See also QTranslatorMessage, QApplication::installTranslator(), QApplication::removeTranslator(), QObject::tr(), QApplication::translate(), Environment Classes, and Internationalization with Qt. -.SS "Member Type Documentation" -.SH "QTranslator::SaveMode" -This enum type defines how QTranslator writes translation files. There are two modes: -.TP -\fCQTranslator::Everything\fR - files are saved with all available information -.TP -\fCQTranslator::Stripped\fR - files are saved with just enough information for end-user applications -.PP -Note that when QTranslator loads a stripped file, most functions do not work. The functions that do work with stripped files are explicitly documented as such. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTranslator::QTranslator ( QObject * parent = 0, const char * name = 0 )" -Constructs an empty message file object that is not connected to any file. The object is called \fIname\fR with parent \fIparent\fR. -.SH "QTranslator::~QTranslator ()" -Destroys the object and frees any allocated resources. -.SH "void QTranslator::clear ()" -Empties this translator of all contents. -.PP -This function works with stripped translator files. -.SH "bool QTranslator::contains ( const char * context, const char * sourceText, const char * comment = 0 ) const" -Returns TRUE if this message file contains a message with the key (\fIcontext\fR, \fIsourceText\fR, \fIcomment\fR); otherwise returns FALSE. -.PP -This function works with stripped translator files. -.PP -(This is is a one-liner that calls findMessage().) -.SH "QString QTranslator::find ( const char * context, const char * sourceText, const char * comment = 0 ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Please use findMessage() instead. -.PP -Returns the translation for the key (\fIcontext\fR, \fIsourceText\fR, \fIcomment\fR) or QString::null if there is none in this translator. -.SH "QTranslatorMessage QTranslator::findMessage ( const char * context, const char * sourceText, const char * comment = 0 ) const\fC [virtual]\fR" -Returns the QTranslatorMessage for the key (\fIcontext\fR, \fIsourceText\fR, \fIcomment\fR). If none is found, also tries (\fIcontext\fR, \fIsourceText\fR, ""). -.SH "void QTranslator::insert ( const QTranslatorMessage & message )" -Inserts \fImessage\fR into this message file. -.PP -This function does \fInot\fR work with stripped translator files. It may appear to, but that is not dependable. -.PP -See also remove(). -.SH "void QTranslator::insert ( const char * context, const char * sourceText, const QString & translation )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "bool QTranslator::isEmpty () const" -Returns TRUE if this translator is empty, otherwise returns FALSE. This function works with stripped and unstripped translation files. -.SH "bool QTranslator::load ( const QString & filename, const QString & directory = QString::null, const QString & search_delimiters = QString::null, const QString & suffix = QString::null )" -Loads \fIfilename\fR, which may be an absolute file name or relative to \fIdirectory\fR. The previous contents of this translator object is discarded. Returns TRUE if the file is loaded successfully; otherwise returns FALSE. -.PP -If the full file name does not exist, other file names are tried in the following order: -.PP -<ol type=1> -.TP -File name with \fIsuffix\fR appended (".qm" if the \fIsuffix\fR is QString::null). -.TP -File name with text after a character in \fIsearch_delimiters\fR stripped ("_." is the default for \fIsearch_delimiters\fR if it is QString::null). -.TP -File name stripped and \fIsuffix\fR appended. -.TP -File name stripped further, etc. -.PP -For example, an application running in the fr_CA locale (French-speaking Canada) might call load("foo.fr_ca"," /opt/foolib"). load() would then try to open the first existing readable file from this list: -.PP -<ol type=1> -.TP -/opt/foolib/foo.fr_ca -.TP -/opt/foolib/foo.fr_ca.qm -.TP -/opt/foolib/foo.fr -.TP -/opt/foolib/foo.fr.qm -.TP -/opt/foolib/foo -.TP -/opt/foolib/foo.qm -.PP -See also save(). -.PP -Example: i18n/main.cpp. -.SH "bool QTranslator::load ( const uchar * data, int len )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads the .qm file data \fIdata\fR of length \fIlen\fR into the translator. Returns TRUE if the data is loaded successfully; otherwise returns FALSE. -.PP -The data is not copied. The caller must be able to guarantee that \fIdata\fR will not be deleted or modified. -.SH "QValueList<QTranslatorMessage> QTranslator::messages () const" -Returns a list of the messages in the translator. This function is rather slow. Because it is seldom called, it's optimized for simplicity and small size, rather than speed. -.PP -If you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList<QTranslatorMessage> list = myTranslator.messages(); -.br - QValueList<QTranslatorMessage>::Iterator it = list.begin(); -.br - while ( it != list.end() ) { -.br - process_message( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "void QTranslator::remove ( const QTranslatorMessage & message )" -Removes \fImessage\fR from this translator. -.PP -This function works with stripped translator files. -.PP -See also insert(). -.SH "void QTranslator::remove ( const char * context, const char * sourceText )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Removes the translation associated to the key (\fIcontext\fR, \fIsourceText\fR," ") from this translator. -.SH "bool QTranslator::save ( const QString & filename, SaveMode mode = Everything )" -Saves this message file to \fIfilename\fR, overwriting the previous contents of \fIfilename\fR. If \fImode\fR is Everything (the default), all the information is preserved. If \fImode\fR is Stripped, any information that is not necessary for findMessage() is stripped away. -.PP -See also load(). -.SH "void QTranslator::squeeze ( SaveMode mode = Everything )" -Converts this message file to the compact format used to store message files on disk. -.PP -You should never need to call this directly; save() and other functions call it as necessary. \fImode\fR is for internal use. -.PP -See also save() and unsqueeze(). -.SH "void QTranslator::unsqueeze ()" -Converts this message file into an easily modifiable data structure, less compact than the format used in the files. -.PP -You should never need to call this function; it is called by insert() and friends as necessary. -.PP -See also squeeze(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtranslator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtranslator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtranslatormessage.3qt b/doc/man/man3/qtranslatormessage.3qt deleted file mode 100644 index 82c0471e0..000000000 --- a/doc/man/man3/qtranslatormessage.3qt +++ /dev/null @@ -1,185 +0,0 @@ -'\" t -.TH QTranslatorMessage 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 -QTranslatorMessage \- Translator message and its properties -.SH SYNOPSIS -\fC#include <ntqtranslator.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQTranslatorMessage\fR ()" -.br -.ti -1c -.BI "\fBQTranslatorMessage\fR ( const char * context, const char * sourceText, const char * comment, const QString & translation = QString::null )" -.br -.ti -1c -.BI "\fBQTranslatorMessage\fR ( QDataStream & stream )" -.br -.ti -1c -.BI "\fBQTranslatorMessage\fR ( const QTranslatorMessage & m )" -.br -.ti -1c -.BI "QTranslatorMessage & \fBoperator=\fR ( const QTranslatorMessage & m )" -.br -.ti -1c -.BI "uint \fBhash\fR () const" -.br -.ti -1c -.BI "const char * \fBcontext\fR () const" -.br -.ti -1c -.BI "const char * \fBsourceText\fR () const" -.br -.ti -1c -.BI "const char * \fBcomment\fR () const" -.br -.ti -1c -.BI "void \fBsetTranslation\fR ( const QString & translation )" -.br -.ti -1c -.BI "QString \fBtranslation\fR () const" -.br -.ti -1c -.BI "enum \fBPrefix\fR { NoPrefix, Hash, HashContext, HashContextSourceText, HashContextSourceTextComment }" -.br -.ti -1c -.BI "void \fBwrite\fR ( QDataStream & stream, bool strip = FALSE, Prefix prefix = HashContextSourceTextComment ) const" -.br -.ti -1c -.BI "Prefix \fBcommonPrefix\fR ( const QTranslatorMessage & m ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QTranslatorMessage & m ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QTranslatorMessage & m ) const" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const QTranslatorMessage & m ) const" -.br -.ti -1c -.BI "bool \fBoperator<=\fR ( const QTranslatorMessage & m ) const" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const QTranslatorMessage & m ) const" -.br -.ti -1c -.BI "bool \fBoperator>=\fR ( const QTranslatorMessage & m ) const" -.br -.in -1c -.SH DESCRIPTION -The QTranslatorMessage class contains a translator message and its properties. -.PP -This class is of no interest to most applications. It is useful for translation tools such as Qt Linguist. It is provided simply to make the API complete and regular. -.PP -For a QTranslator object, a lookup key is a triple (\fIcontext\fR, \fIsource text\fR, \fIcomment\fR) that uniquely identifies a message. An extended key is a quadruple (\fIhash\fR, \fIcontext\fR, \fIsource text\fR, \fIcomment\fR), where \fIhash\fR is computed from the source text and the comment. Unless you plan to read and write messages yourself, you need not worry about the hash value. -.PP -QTranslatorMessage stores this triple or quadruple and the relevant translation if there is any. -.PP -See also QTranslator, Environment Classes, and Internationalization with Qt. -.SS "Member Type Documentation" -.SH "QTranslatorMessage::Prefix" -Let (\fIh\fR, \fIc\fR, \fIs\fR, \fIm\fR) be the extended key. The possible prefixes are -.TP -\fCQTranslatorMessage::NoPrefix\fR - no prefix -.TP -\fCQTranslatorMessage::Hash\fR - only (\fIh\fR) -.TP -\fCQTranslatorMessage::HashContext\fR - only (\fIh\fR, \fIc\fR) -.TP -\fCQTranslatorMessage::HashContextSourceText\fR - only (\fIh\fR, \fIc\fR, \fIs\fR) -.TP -\fCQTranslatorMessage::HashContextSourceTextComment\fR - the whole extended key, (\fIh\fR, \fIc\fR, \fIs\fR, \fIm\fR) -.PP -See also write() and commonPrefix(). -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QTranslatorMessage::QTranslatorMessage ()" -Constructs a translator message with the extended key (0, 0, 0, 0) and QString::null as translation. -.SH "QTranslatorMessage::QTranslatorMessage ( const char * context, const char * sourceText, const char * comment, const QString & translation = QString::null )" -Constructs an translator message with the extended key (\fIh\fR, \fIcontext\fR, \fIsourceText\fR, \fIcomment\fR), where \fIh\fR is computed from \fIsourceText\fR and \fIcomment\fR, and possibly with a \fItranslation\fR. -.SH "QTranslatorMessage::QTranslatorMessage ( QDataStream & stream )" -Constructs a translator message read from the \fIstream\fR. The resulting message may have any combination of content. -.PP -See also QTranslator::save(). -.SH "QTranslatorMessage::QTranslatorMessage ( const QTranslatorMessage & m )" -Constructs a copy of translator message \fIm\fR. -.SH "const char * QTranslatorMessage::comment () const" -Returns the comment for this message (e.g. "File|Save"). -.PP -\fBWarning:\fR This may return 0 if the QTranslator object is stripped (compressed). -.SH "Prefix QTranslatorMessage::commonPrefix ( const QTranslatorMessage & m ) const" -Returns the widest lookup prefix that is common to this translator message and to message \fIm\fR. -.PP -For example, if the extended key is for this message is (71," PrintDialog", "Yes", "Print?") and that for \fIm\fR is (71," PrintDialog", "No", "Print?"), this function returns HashContext. -.PP -See also write(). -.SH "const char * QTranslatorMessage::context () const" -Returns the context for this message (e.g. "MyDialog"). -.PP -\fBWarning:\fR This may return 0 if the QTranslator object is stripped (compressed). -.SH "uint QTranslatorMessage::hash () const" -Returns the hash value used internally to represent the lookup key. This value is zero only if this translator message was constructed from a stream containing invalid data. -.PP -The hashing function is unspecified, but it will remain unchanged in future versions of Qt. -.SH "bool QTranslatorMessage::operator!= ( const QTranslatorMessage & m ) const" -Returns TRUE if the extended key of this object is different from that of \fIm\fR; otherwise returns FALSE. -.SH "bool QTranslatorMessage::operator< ( const QTranslatorMessage & m ) const" -Returns TRUE if the extended key of this object is lexicographically before than that of \fIm\fR; otherwise returns FALSE. -.SH "bool QTranslatorMessage::operator<= ( const QTranslatorMessage & m ) const" -Returns TRUE if the extended key of this object is lexicographically before that of \fIm\fR or if they are equal; otherwise returns FALSE. -.SH "QTranslatorMessage & QTranslatorMessage::operator= ( const QTranslatorMessage & m )" -Assigns message \fIm\fR to this translator message and returns a reference to this translator message. -.SH "bool QTranslatorMessage::operator== ( const QTranslatorMessage & m ) const" -Returns TRUE if the extended key of this object is equal to that of \fIm\fR; otherwise returns FALSE. -.SH "bool QTranslatorMessage::operator> ( const QTranslatorMessage & m ) const" -Returns TRUE if the extended key of this object is lexicographically after that of \fIm\fR; otherwise returns FALSE. -.SH "bool QTranslatorMessage::operator>= ( const QTranslatorMessage & m ) const" -Returns TRUE if the extended key of this object is lexicographically after that of \fIm\fR or if they are equal; otherwise returns FALSE. -.SH "void QTranslatorMessage::setTranslation ( const QString & translation )" -Sets the translation of the source text to \fItranslation\fR. -.PP -See also translation(). -.SH "const char * QTranslatorMessage::sourceText () const" -Returns the source text of this message (e.g. "&Save"). -.PP -\fBWarning:\fR This may return 0 if the QTranslator object is stripped (compressed). -.SH "QString QTranslatorMessage::translation () const" -Returns the translation of the source text (e.g., "&Sauvegarder"). -.PP -See also setTranslation(). -.SH "void QTranslatorMessage::write ( QDataStream & stream, bool strip = FALSE, Prefix prefix = HashContextSourceTextComment ) const" -Writes this translator message to the \fIstream\fR. If \fIstrip\fR is FALSE (the default), all the information in the message is written. If \fIstrip\fR is TRUE, only the part of the extended key specified by \fIprefix\fR is written with the translation (HashContextSourceTextComment by default). -.PP -See also commonPrefix(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qtranslatormessage.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtranslatormessage.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qtsciicodec.3qt b/doc/man/man3/qtsciicodec.3qt deleted file mode 100644 index 02c6545b7..000000000 --- a/doc/man/man3/qtsciicodec.3qt +++ /dev/null @@ -1,62 +0,0 @@ -'\" t -.TH QTsciiCodec 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 -QTsciiCodec \- Conversion to and from the Tamil TSCII encoding -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqtsciicodec.h>\fR -.PP -Inherits QTextCodec. -.PP -.SH DESCRIPTION -The QTsciiCodec class provides conversion to and from the Tamil TSCII encoding. -.PP -TSCII, formally the Tamil Standard Code Information Interchange specification, is a commonly used charset for Tamils. The official page for the standard is at http://www.tamil.net/tscii/ -.PP -This codec uses the mapping table found at http://www.geocities.com/Athens/5180/tsciiset.html. Tamil uses composed Unicode which might cause some problems if you are using Unicode fonts instead of TSCII fonts. -.PP -Most of the code here was written by Hans Petter Bieker and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for the code as it was at the point of contribution. Trolltech's subsequent modifications are covered by the usual copyright for Qt. -.PP -Copyright (C) 2000 Hans Petter Bieker. All rights reserved. -.PP -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> -.IP 1 -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.IP 2 -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -.PP -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.PP -See also Internationalization with Qt. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtsciicodec.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qtsciicodec.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/quridrag.3qt b/doc/man/man3/quridrag.3qt deleted file mode 100644 index c17749e3f..000000000 --- a/doc/man/man3/quridrag.3qt +++ /dev/null @@ -1,168 +0,0 @@ -'\" t -.TH QUriDrag 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 -QUriDrag \- Drag object for a list of URI references -.SH SYNOPSIS -\fC#include <ntqdragobject.h>\fR -.PP -Inherits QStoredDrag. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQUriDrag\fR ( QStrList uris, QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQUriDrag\fR ( QWidget * dragSource = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QUriDrag\fR ()" -.br -.ti -1c -.BI "void setFilenames ( const QStringList & fnames ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBsetFileNames\fR ( const QStringList & fnames )" -.br -.ti -1c -.BI "void \fBsetUnicodeUris\fR ( const QStringList & uuris )" -.br -.ti -1c -.BI "virtual void \fBsetUris\fR ( QStrList uris )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QString \fBuriToLocalFile\fR ( const char * uri )" -.br -.ti -1c -.BI "QCString \fBlocalFileToUri\fR ( const QString & filename )" -.br -.ti -1c -.BI "QString \fBuriToUnicodeUri\fR ( const char * uri )" -.br -.ti -1c -.BI "QCString \fBunicodeUriToUri\fR ( const QString & uuri )" -.br -.ti -1c -.BI "bool \fBcanDecode\fR ( const QMimeSource * e )" -.br -.ti -1c -.BI "bool \fBdecode\fR ( const QMimeSource * e, QStrList & l )" -.br -.ti -1c -.BI "bool \fBdecodeToUnicodeUris\fR ( const QMimeSource * e, QStringList & l )" -.br -.ti -1c -.BI "bool \fBdecodeLocalFiles\fR ( const QMimeSource * e, QStringList & l )" -.br -.in -1c -.SH DESCRIPTION -The QUriDrag class provides a drag object for a list of URI references. -.PP -URIs are a useful way to refer to files that may be distributed across multiple machines. A URI will often refer to a file on a machine local to both the drag source and the drop target, so the URI can be equivalent to passing a file name but is more extensible. -.PP -Use URIs in Unicode form so that the user can comfortably edit and view them. For use in HTTP or other protocols, use the correctly escaped ASCII form. -.PP -You can convert a list of file names to file URIs using setFileNames(), or into human-readble form with setUnicodeUris(). -.PP -Static functions are provided to convert between filenames and URIs, e.g. uriToLocalFile() and localFileToUri(), and to and from human-readable form, e.g. uriToUnicodeUri(), unicodeUriToUri(). You can also decode URIs from a mimesource into a list with decodeLocalFiles() and decodeToUnicodeUris(). -.PP -See also Drag And Drop Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QUriDrag::QUriDrag ( QStrList uris, QWidget * dragSource = 0, const char * name = 0 )" -Constructs an object to drag the list of URIs in \fIuris\fR. The \fIdragSource\fR and \fIname\fR arguments are passed on to QStoredDrag. Note that URIs are always in escaped UTF8 encoding. -.SH "QUriDrag::QUriDrag ( QWidget * dragSource = 0, const char * name = 0 )" -Constructs an object to drag. You must call setUris() before you start the drag(). Passes \fIdragSource\fR and \fIname\fR to the QStoredDrag constructor. -.SH "QUriDrag::~QUriDrag ()" -Destroys the object. -.SH "bool QUriDrag::canDecode ( const QMimeSource * e )\fC [static]\fR" -Returns TRUE if decode() would be able to decode \fIe\fR; otherwise returns FALSE. -.SH "bool QUriDrag::decode ( const QMimeSource * e, QStrList & l )\fC [static]\fR" -Decodes URIs from \fIe\fR, placing the result in \fIl\fR (which is first cleared). -.PP -Returns TRUE if \fIe\fR contained a valid list of URIs; otherwise returns FALSE. -.PP -Example: dirview/dirview.cpp. -.SH "bool QUriDrag::decodeLocalFiles ( const QMimeSource * e, QStringList & l )\fC [static]\fR" -Decodes URIs from the mime source event \fIe\fR, converts them to local files if they refer to local files, and places them in \fIl\fR (which is first cleared). -.PP -Returns TRUE if \fIcontained\fR a valid list of URIs; otherwise returns FALSE. The list will be empty if no URIs were local files. -.PP -Example: fileiconview/qfileiconview.cpp. -.SH "bool QUriDrag::decodeToUnicodeUris ( const QMimeSource * e, QStringList & l )\fC [static]\fR" -Decodes URIs from the mime source event \fIe\fR, converts them to Unicode URIs (only useful for displaying to humans), placing them in \fIl\fR (which is first cleared). -.PP -Returns TRUE if \fIcontained\fR a valid list of URIs; otherwise returns FALSE. -.SH "QCString QUriDrag::localFileToUri ( const QString & filename )\fC [static]\fR" -Returns the URI equivalent to the absolute local file \fIfilename\fR. -.PP -See also uriToLocalFile(). -.SH "void QUriDrag::setFileNames ( const QStringList & fnames )" -Sets the URIs to be the local-file URIs equivalent to \fIfnames\fR. -.PP -See also localFileToUri() and setUris(). -.PP -Example: dirview/dirview.cpp. -.SH "void QUriDrag::setFilenames ( const QStringList & fnames )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use setFileNames() instead (notice the N). -.SH "void QUriDrag::setUnicodeUris ( const QStringList & uuris )" -Sets the URIs in \fIuuris\fR to be the Unicode URIs (only useful for displaying to humans). -.PP -See also localFileToUri() and setUris(). -.SH "void QUriDrag::setUris ( QStrList uris )\fC [virtual]\fR" -Changes the list of \fIuris\fR to be dragged. -.PP -Note that URIs are always in escaped UTF8 encoding. -.SH "QCString QUriDrag::unicodeUriToUri ( const QString & uuri )\fC [static]\fR" -Returns the URI equivalent of the Unicode URI given in \fIuuri\fR (only useful for displaying to humans). -.PP -See also uriToLocalFile(). -.SH "QString QUriDrag::uriToLocalFile ( const char * uri )\fC [static]\fR" -Returns the name of a local file equivalent to \fIuri\fR or a null string if \fIuri\fR is not a local file. -.PP -Note that URIs are always in escaped UTF8 encoding. -.PP -See also localFileToUri(). -.PP -Example: dirview/dirview.cpp. -.SH "QString QUriDrag::uriToUnicodeUri ( const char * uri )\fC [static]\fR" -Returns the Unicode URI (only useful for displaying to humans) equivalent of \fIuri\fR. -.PP -Note that URIs are always in escaped UTF8 encoding. -.PP -See also localFileToUri(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/quridrag.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 qt-bugs@trolltech.com . -Please include the name of the manual page (quridrag.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qurl.3qt b/doc/man/man3/qurl.3qt deleted file mode 100644 index c28766e58..000000000 --- a/doc/man/man3/qurl.3qt +++ /dev/null @@ -1,496 +0,0 @@ -'\" t -.TH QUrl 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 -QUrl \- URL parser and simplifies working with URLs -.SH SYNOPSIS -\fC#include <ntqurl.h>\fR -.PP -Inherited by QUrlOperator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQUrl\fR ()" -.br -.ti -1c -.BI "\fBQUrl\fR ( const QString & url )" -.br -.ti -1c -.BI "\fBQUrl\fR ( const QUrl & url )" -.br -.ti -1c -.BI "\fBQUrl\fR ( const QUrl & url, const QString & relUrl, bool checkSlash = FALSE )" -.br -.ti -1c -.BI "virtual \fB~QUrl\fR ()" -.br -.ti -1c -.BI "QString \fBprotocol\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetProtocol\fR ( const QString & protocol )" -.br -.ti -1c -.BI "QString \fBuser\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetUser\fR ( const QString & user )" -.br -.ti -1c -.BI "bool \fBhasUser\fR () const" -.br -.ti -1c -.BI "QString \fBpassword\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPassword\fR ( const QString & pass )" -.br -.ti -1c -.BI "bool \fBhasPassword\fR () const" -.br -.ti -1c -.BI "QString \fBhost\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetHost\fR ( const QString & host )" -.br -.ti -1c -.BI "bool \fBhasHost\fR () const" -.br -.ti -1c -.BI "int \fBport\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPort\fR ( int port )" -.br -.ti -1c -.BI "bool \fBhasPort\fR () const" -.br -.ti -1c -.BI "QString \fBpath\fR ( bool correct = TRUE ) const" -.br -.ti -1c -.BI "virtual void \fBsetPath\fR ( const QString & path )" -.br -.ti -1c -.BI "bool \fBhasPath\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetEncodedPathAndQuery\fR ( const QString & pathAndQuery )" -.br -.ti -1c -.BI "QString \fBencodedPathAndQuery\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetQuery\fR ( const QString & txt )" -.br -.ti -1c -.BI "QString \fBquery\fR () const" -.br -.ti -1c -.BI "QString \fBref\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetRef\fR ( const QString & txt )" -.br -.ti -1c -.BI "bool \fBhasRef\fR () const" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBisLocalFile\fR () const" -.br -.ti -1c -.BI "virtual void \fBaddPath\fR ( const QString & pa )" -.br -.ti -1c -.BI "virtual void \fBsetFileName\fR ( const QString & name )" -.br -.ti -1c -.BI "QString \fBfileName\fR () const" -.br -.ti -1c -.BI "QString \fBdirPath\fR () const" -.br -.ti -1c -.BI "QUrl & \fBoperator=\fR ( const QUrl & url )" -.br -.ti -1c -.BI "QUrl & \fBoperator=\fR ( const QString & url )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QUrl & url ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QString & url ) const" -.br -.ti -1c -.BI "\fBoperator QString\fR () const" -.br -.ti -1c -.BI "virtual QString \fBtoString\fR ( bool encodedPath = FALSE, bool forcePrependProtocol = TRUE ) const" -.br -.ti -1c -.BI "virtual bool \fBcdUp\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBdecode\fR ( QString & url )" -.br -.ti -1c -.BI "void \fBencode\fR ( QString & url )" -.br -.ti -1c -.BI "bool \fBisRelativeUrl\fR ( const QString & url )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBreset\fR ()" -.br -.ti -1c -.BI "virtual bool \fBparse\fR ( const QString & url )" -.br -.in -1c -.SH DESCRIPTION -The QUrl class provides a URL parser and simplifies working with URLs. -.PP -The QUrl class is provided for simple work with URLs. It can parse, decode, encode, etc. -.PP -QUrl works with the decoded path and encoded query in turn. -.PP -Example: -.PP -\fChttp://www.trolltech.com:80/cgi-bin/test%20me.pl?cmd=Hello%20you\fR -.PP -<center>.nf -.TS -l - l. Function Returns protocol() "http" host() "www.trolltech.com" port() 80 path() "/cgi-bin/testme.pl" fileName() "testme.pl" query() -.TE -.fi -</center> -.PP -Example: -.PP -\fChttp://doc.trolltech.com/ntqdockarea.html#lines\fR -.PP -<center>.nf -.TS -l - l. Function Returns protocol() "http" host() "doc.trolltech.com" fileName() "ntqdockarea.html" ref() -.TE -.fi -</center> -.PP -The individual parts of a URL can be set with setProtocol(), setHost(), setPort(), setPath(), setFileName(), setRef() and setQuery(). A URL could contain, for example, an ftp address which requires a user name and password; these can be set with setUser() and setPassword(). -.PP -Because path is always encoded internally you must not use "%00" in the path, although this is okay (but not recommended) for the query. -.PP -QUrl is normally used like this: -.PP -.nf -.br - QUrl url( "http://www.trolltech.com" ); -.br - // or -.br - QUrl url( "file:/home/myself/Mail", "Inbox" ); -.br -.fi -.PP -You can then access and manipulate the various parts of the URL. -.PP -To make it easy to work with QUrls and QStrings, QUrl implements the necessary cast and assignment operators so you can do following: -.PP -.nf -.br - QUrl url( "http://www.trolltech.com" ); -.br - QString s = url; -.br - // or -.br - QString s( "http://www.trolltech.com" ); -.br - QUrl url( s ); -.br -.fi -.PP -Use the static functions, encode() and decode() to encode or decode a URL in a string. (They operate on the string in-place.) The isRelativeUrl() static function returns TRUE if the given string is a relative URL. -.PP -If you want to use a URL to work on a hierarchical structure (e.g. a local or remote filesystem), you might want to use the subclass QUrlOperator. -.PP -See also QUrlOperator, Input/Output and Networking, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QUrl::QUrl ()" -Constructs an empty URL that is invalid. -.SH "QUrl::QUrl ( const QString & url )" -Constructs a URL by parsing the string \fIurl\fR. -.PP -If you pass a string like "/home/qt", the "file" protocol is assumed. -.SH "QUrl::QUrl ( const QUrl & url )" -Copy constructor. Copies the data of \fIurl\fR. -.SH "QUrl::QUrl ( const QUrl & url, const QString & relUrl, bool checkSlash = FALSE )" -Constructs an URL taking \fIurl\fR as the base (context) and \fIrelUrl\fR as a relative URL to \fIurl\fR. If \fIrelUrl\fR is not relative, \fIrelUrl\fR is taken as the new URL. -.PP -For example, the path of -.PP -.nf -.br - QUrl url( "ftp://ftp.trolltech.com/qt/source", "qt-2.1.0.tar.gz" ); -.br -.fi -will be "/qt/srource/qt-2.1.0.tar.gz". -.PP -On the other hand, -.PP -.nf -.br - QUrl url( "ftp://ftp.trolltech.com/qt/source", "/usr/local" ); -.br -.fi -will result in a new URL, "ftp://ftp.trolltech.com/usr/local", because "/usr/local" isn't relative. -.PP -Similarly, -.PP -.nf -.br - QUrl url( "ftp://ftp.trolltech.com/qt/source", "file:/usr/local" ); -.br -.fi -will result in a new URL, with "/usr/local" as the path and "file" as the protocol. -.PP -Normally it is expected that the path of \fIurl\fR points to a directory, even if the path has no slash at the end. But if you want the constructor to handle the last part of the path as a file name if there is no slash at the end, and to let it be replaced by the file name of \fIrelUrl\fR (if it contains one), set \fIcheckSlash\fR to TRUE. -.SH "QUrl::~QUrl ()\fC [virtual]\fR" -Destructor. -.SH "void QUrl::addPath ( const QString & pa )\fC [virtual]\fR" -Adds the path \fIpa\fR to the path of the URL. -.PP -See also setPath() and hasPath(). -.SH "bool QUrl::cdUp ()\fC [virtual]\fR" -Changes the directory to one directory up. -.PP -See also setPath(). -.SH "void QUrl::decode ( QString & url )\fC [static]\fR" -Decodes the \fIurl\fR in-place into UTF-8. For example -.PP -.nf -.br - QString url = "http%3A//www%20trolltech%20com" -.br - QUrl::decode( url ); -.br - // url is now "http://www.trolltech.com" -.br -.fi -.PP -See also encode(). -.SH "QString QUrl::dirPath () const" -Returns the directory path of the URL. This is the part of the path of the URL without the fileName(). See the documentation of fileName() for a discussion of what is handled as file name and what is handled as directory path. -.PP -See also setPath() and hasPath(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QUrl::encode ( QString & url )\fC [static]\fR" -Encodes the \fIurl\fR in-place into UTF-8. For example -.PP -.nf -.br - QString url = http://www.trolltech.com -.br - QUrl::encode( url ); -.br - // url is now "http%3A//www%20trolltech%20com" -.br -.fi -.PP -See also decode(). -.PP -Example: network/archivesearch/archivedialog.ui.h. -.SH "QString QUrl::encodedPathAndQuery ()" -Returns the encoded path and query. -.PP -See also decode(). -.SH "QString QUrl::fileName () const" -Returns the file name of the URL. If the path of the URL doesn't have a slash at the end, the part between the last slash and the end of the path string is considered to be the file name. If the path has a slash at the end, an empty string is returned here. -.PP -See also setFileName(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "bool QUrl::hasHost () const" -Returns TRUE if the URL contains a hostname; otherwise returns FALSE. -.PP -See also setHost(). -.SH "bool QUrl::hasPassword () const" -Returns TRUE if the URL contains a password; otherwise returns FALSE. -.PP -\fBWarning:\fR Passwords passed in URLs are normally \fIinsecure\fR; this is due to the mechanism, not because of Qt. -.PP -See also setPassword() and setUser(). -.SH "bool QUrl::hasPath () const" -Returns TRUE if the URL contains a path; otherwise returns FALSE. -.PP -See also path() and setPath(). -.SH "bool QUrl::hasPort () const" -Returns TRUE if the URL contains a port; otherwise returns FALSE. -.PP -See also setPort(). -.SH "bool QUrl::hasRef () const" -Returns TRUE if the URL has a reference; otherwise returns FALSE. -.PP -See also setRef(). -.SH "bool QUrl::hasUser () const" -Returns TRUE if the URL contains a username; otherwise returns FALSE. -.PP -See also setUser() and setPassword(). -.SH "QString QUrl::host () const" -Returns the hostname of the URL. -.PP -See also setHost() and hasHost(). -.PP -Example: network/archivesearch/archivedialog.ui.h. -.SH "bool QUrl::isLocalFile () const" -Returns TRUE if the URL is a local file; otherwise returns FALSE. -.PP -Example: qdir/qdir.cpp. -.SH "bool QUrl::isRelativeUrl ( const QString & url )\fC [static]\fR" -Returns TRUE if \fIurl\fR is relative; otherwise returns FALSE. -.SH "bool QUrl::isValid () const" -Returns TRUE if the URL is valid; otherwise returns FALSE. A URL is invalid if it cannot be parsed, for example. -.SH "QUrl::operator QString () const" -Composes a string version of the URL and returns it. -.PP -See also QUrl::toString(). -.SH "QUrl & QUrl::operator= ( const QUrl & url )" -Assigns the data of \fIurl\fR to this class. -.SH "QUrl & QUrl::operator= ( const QString & url )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Parses \fIurl\fR and assigns the resulting data to this class. -.PP -If you pass a string like "/home/qt" the "file" protocol will be assumed. -.SH "bool QUrl::operator== ( const QUrl & url ) const" -Compares this URL with \fIurl\fR and returns TRUE if they are equal; otherwise returns FALSE. -.SH "bool QUrl::operator== ( const QString & url ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Compares this URL with \fIurl\fR. \fIurl\fR is parsed first. Returns TRUE if \fIurl\fR is equal to this url; otherwise returns FALSE. -.SH "bool QUrl::parse ( const QString & url )\fC [virtual protected]\fR" -Parses the \fIurl\fR. -.SH "QString QUrl::password () const" -Returns the password of the URL. -.PP -\fBWarning:\fR Passwords passed in URLs are normally \fIinsecure\fR; this is due to the mechanism, not because of Qt. -.PP -See also setPassword() and setUser(). -.SH "QString QUrl::path ( bool correct = TRUE ) const" -Returns the path of the URL. If \fIcorrect\fR is TRUE, the path is cleaned (deals with too many or too few slashes, cleans things like "/../..", etc). Otherwise path() returns exactly the path that was parsed or set. -.PP -See also setPath() and hasPath(). -.PP -Example: qdir/qdir.cpp. -.SH "int QUrl::port () const" -Returns the port of the URL or -1 if no port has been set. -.PP -See also setPort(). -.SH "QString QUrl::protocol () const" -Returns the protocol of the URL. Typically, "file", "http", "ftp", etc. -.PP -See also setProtocol(). -.SH "QString QUrl::query () const" -Returns the (encoded) query of the URL. -.PP -See also setQuery() and decode(). -.SH "QString QUrl::ref () const" -Returns the (encoded) reference of the URL. -.PP -See also setRef(), hasRef(), and decode(). -.SH "void QUrl::reset ()\fC [virtual protected]\fR" -Resets all parts of the URL to their default values and invalidates it. -.SH "void QUrl::setEncodedPathAndQuery ( const QString & pathAndQuery )\fC [virtual]\fR" -Parses \fIpathAndQuery\fR for a path and query and sets those values. The whole string must be encoded. -.PP -See also encode(). -.SH "void QUrl::setFileName ( const QString & name )\fC [virtual]\fR" -Sets the file name of the URL to \fIname\fR. If this URL contains a fileName(), the original file name is replaced by \fIname\fR. -.PP -See the documentation of fileName() for a more detailed discussion of what is handled as file name and what is handled as a directory path. -.PP -See also fileName(). -.SH "void QUrl::setHost ( const QString & host )\fC [virtual]\fR" -Sets the hostname of the URL to \fIhost\fR. -.PP -See also host() and hasHost(). -.SH "void QUrl::setPassword ( const QString & pass )\fC [virtual]\fR" -Sets the password of the URL to \fIpass\fR. -.PP -\fBWarning:\fR Passwords passed in URLs are normally \fIinsecure\fR; this is due to the mechanism, not because of Qt. -.PP -See also password() and setUser(). -.SH "void QUrl::setPath ( const QString & path )\fC [virtual]\fR" -Sets the path of the URL to \fIpath\fR. -.PP -See also path() and hasPath(). -.SH "void QUrl::setPort ( int port )\fC [virtual]\fR" -Sets the port of the URL to \fIport\fR. -.PP -See also port(). -.SH "void QUrl::setProtocol ( const QString & protocol )\fC [virtual]\fR" -Sets the protocol of the URL to \fIprotocol\fR. Typically, "file"," http", "ftp", etc. -.PP -See also protocol(). -.SH "void QUrl::setQuery ( const QString & txt )\fC [virtual]\fR" -Sets the query of the URL to \fItxt\fR. \fItxt\fR must be encoded. -.PP -See also query() and encode(). -.SH "void QUrl::setRef ( const QString & txt )\fC [virtual]\fR" -Sets the reference of the URL to \fItxt\fR. \fItxt\fR must be encoded. -.PP -See also ref(), hasRef(), and encode(). -.SH "void QUrl::setUser ( const QString & user )\fC [virtual]\fR" -Sets the username of the URL to \fIuser\fR. -.PP -See also user() and setPassword(). -.SH "QString QUrl::toString ( bool encodedPath = FALSE, bool forcePrependProtocol = TRUE ) const\fC [virtual]\fR" -Composes a string version of the URL and returns it. If \fIencodedPath\fR is TRUE the path in the returned string is encoded. If \fIforcePrependProtocol\fR is TRUE and \fIencodedPath\fR looks like a local filename, the "file:/" protocol is also prepended. -.PP -See also encode() and decode(). -.SH "QString QUrl::user () const" -Returns the username of the URL. -.PP -See also setUser() and setPassword(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqurl.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qurl.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qurlinfo.3qt b/doc/man/man3/qurlinfo.3qt deleted file mode 100644 index 63c54347e..000000000 --- a/doc/man/man3/qurlinfo.3qt +++ /dev/null @@ -1,366 +0,0 @@ -'\" t -.TH QUrlInfo 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 -QUrlInfo \- Stores information about URLs -.SH SYNOPSIS -\fC#include <ntqurlinfo.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBPermissionSpec\fR { ReadOwner = 00400, WriteOwner = 00200, ExeOwner = 00100, ReadGroup = 00040, WriteGroup = 00020, ExeGroup = 00010, ReadOther = 00004, WriteOther = 00002, ExeOther = 00001 }" -.br -.ti -1c -.BI "\fBQUrlInfo\fR ()" -.br -.ti -1c -.BI "\fBQUrlInfo\fR ( const QUrlOperator & path, const QString & file )" -.br -.ti -1c -.BI "\fBQUrlInfo\fR ( const QUrlInfo & ui )" -.br -.ti -1c -.BI "\fBQUrlInfo\fR ( const QString & name, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" -.br -.ti -1c -.BI "\fBQUrlInfo\fR ( const QUrl & url, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" -.br -.ti -1c -.BI "QUrlInfo & \fBoperator=\fR ( const QUrlInfo & ui )" -.br -.ti -1c -.BI "virtual \fB~QUrlInfo\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetName\fR ( const QString & name )" -.br -.ti -1c -.BI "virtual void \fBsetDir\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetFile\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetSymLink\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetOwner\fR ( const QString & s )" -.br -.ti -1c -.BI "virtual void \fBsetGroup\fR ( const QString & s )" -.br -.ti -1c -.BI "virtual void \fBsetSize\fR ( uint size )" -.br -.ti -1c -.BI "virtual void \fBsetWritable\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetReadable\fR ( bool b )" -.br -.ti -1c -.BI "virtual void \fBsetPermissions\fR ( int p )" -.br -.ti -1c -.BI "virtual void \fBsetLastModified\fR ( const QDateTime & dt )" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "QString \fBname\fR () const" -.br -.ti -1c -.BI "int \fBpermissions\fR () const" -.br -.ti -1c -.BI "QString \fBowner\fR () const" -.br -.ti -1c -.BI "QString \fBgroup\fR () const" -.br -.ti -1c -.BI "uint \fBsize\fR () const" -.br -.ti -1c -.BI "QDateTime \fBlastModified\fR () const" -.br -.ti -1c -.BI "QDateTime \fBlastRead\fR () const" -.br -.ti -1c -.BI "bool \fBisDir\fR () const" -.br -.ti -1c -.BI "bool \fBisFile\fR () const" -.br -.ti -1c -.BI "bool \fBisSymLink\fR () const" -.br -.ti -1c -.BI "bool \fBisWritable\fR () const" -.br -.ti -1c -.BI "bool \fBisReadable\fR () const" -.br -.ti -1c -.BI "bool \fBisExecutable\fR () const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QUrlInfo & i ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBgreaterThan\fR ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )" -.br -.ti -1c -.BI "bool \fBlessThan\fR ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )" -.br -.ti -1c -.BI "bool \fBequal\fR ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )" -.br -.in -1c -.SH DESCRIPTION -The QUrlInfo class stores information about URLs. -.PP -This class is just a container for storing information about URLs, which is why all information must be passed in the constructor. -.PP -Unless you're reimplementing a network protocol you're unlikely to create QUrlInfo objects yourself, but you may receive QUrlInfo objects from functions, e.g. QUrlOperator::info(). -.PP -The information that can be retrieved includes name(), permissions(), owner(), group(), size(), lastModified(), lastRead(), isDir(), isFile(), isSymLink(), isWritable(), isReadable() and isExecutable(). -.PP -See also Input/Output and Networking and Miscellaneous Classes. -.SS "Member Type Documentation" -.SH "QUrlInfo::PermissionSpec" -This enum is used by the permissions() function to report the permissions of a file. -.TP -\fCQUrlInfo::ReadOwner\fR - The file is readable by the owner of the file. -.TP -\fCQUrlInfo::WriteOwner\fR - The file is writable by the owner of the file. -.TP -\fCQUrlInfo::ExeOwner\fR - The file is executable by the owner of the file. -.TP -\fCQUrlInfo::ReadGroup\fR - The file is readable by the group. -.TP -\fCQUrlInfo::WriteGroup\fR - The file is writable by the group. -.TP -\fCQUrlInfo::ExeGroup\fR - The file is executable by the group. -.TP -\fCQUrlInfo::ReadOther\fR - The file is readable by anyone. -.TP -\fCQUrlInfo::WriteOther\fR - The file is writable by anyone. -.TP -\fCQUrlInfo::ExeOther\fR - The file is executable by anyone. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QUrlInfo::QUrlInfo ()" -Constructs an invalid QUrlInfo object with default values. -.PP -See also isValid(). -.SH "QUrlInfo::QUrlInfo ( const QUrlOperator & path, const QString & file )" -Constructs a QUrlInfo object with information about the file \fIfile\fR in the \fIpath\fR. It tries to find the information about the \fIfile\fR in the QUrlOperator \fIpath\fR. -.PP -If the information is not found, this constructor creates an invalid QUrlInfo, i.e. isValid() returns FALSE. You should always check if the URL info is valid before relying on the return values of any getter functions. -.PP -If \fIfile\fR is empty, it defaults to the QUrlOperator \fIpath\fR, i.e. to the directory. -.PP -See also isValid() and QUrlOperator::info(). -.SH "QUrlInfo::QUrlInfo ( const QUrlInfo & ui )" -Copy constructor, copies \fIui\fR to this URL info object. -.SH "QUrlInfo::QUrlInfo ( const QString & name, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" -Constructs a QUrlInfo object by specifying all the URL's information. -.PP -The information that is passed is the \fIname\fR, file \fIpermissions\fR, \fIowner\fR and \fIgroup\fR and the file's \fIsize\fR. Also passed is the \fIlastModified\fR date/time and the \fIlastRead\fR date/time. Flags are also passed, specifically, \fIisDir\fR, \fIisFile\fR, \fIisSymLink\fR, \fIisWritable\fR, \fIisReadable\fR and \fIisExecutable\fR. -.SH "QUrlInfo::QUrlInfo ( const QUrl & url, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" -Constructs a QUrlInfo object by specifying all the URL's information. -.PP -The information that is passed is the \fIurl\fR, file \fIpermissions\fR, \fIowner\fR and \fIgroup\fR and the file's \fIsize\fR. Also passed is the \fIlastModified\fR date/time and the \fIlastRead\fR date/time. Flags are also passed, specifically, \fIisDir\fR, \fIisFile\fR, \fIisSymLink\fR, \fIisWritable\fR, \fIisReadable\fR and \fIisExecutable\fR. -.SH "QUrlInfo::~QUrlInfo ()\fC [virtual]\fR" -Destroys the URL info object. -.PP -The QUrlOperator object to which this URL referred (if any) is not affected. -.SH "bool QUrlInfo::equal ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )\fC [static]\fR" -Returns TRUE if \fIi1\fR equals to \fIi2\fR; otherwise returns FALSE. The objects are compared by the value, which is specified by \fIsortBy\fR. This must be one of QDir::Name, QDir::Time or QDir::Size. -.SH "bool QUrlInfo::greaterThan ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )\fC [static]\fR" -Returns TRUE if \fIi1\fR is greater than \fIi2\fR; otherwise returns FALSE. The objects are compared by the value, which is specified by \fIsortBy\fR. This must be one of QDir::Name, QDir::Time or QDir::Size. -.SH "QString QUrlInfo::group () const" -Returns the group of the URL. -.PP -See also isValid(). -.SH "bool QUrlInfo::isDir () const" -Returns TRUE if the URL is a directory; otherwise returns FALSE. -.PP -See also isValid(). -.PP -Examples: -.)l network/ftpclient/ftpmainwindow.ui.h and network/networkprotocol/nntp.cpp. -.SH "bool QUrlInfo::isExecutable () const" -Returns TRUE if the URL is executable; otherwise returns FALSE. -.PP -See also isValid(). -.SH "bool QUrlInfo::isFile () const" -Returns TRUE if the URL is a file; otherwise returns FALSE. -.PP -See also isValid(). -.SH "bool QUrlInfo::isReadable () const" -Returns TRUE if the URL is readable; otherwise returns FALSE. -.PP -See also isValid(). -.SH "bool QUrlInfo::isSymLink () const" -Returns TRUE if the URL is a symbolic link; otherwise returns FALSE. -.PP -See also isValid(). -.SH "bool QUrlInfo::isValid () const" -Returns TRUE if the URL info is valid; otherwise returns FALSE. Valid means that the QUrlInfo contains real information. For example, a call to QUrlOperator::info() might return a an invalid QUrlInfo, if no information about the requested entry is available. -.PP -You should always check if the URL info is valid before relying on the values. -.SH "bool QUrlInfo::isWritable () const" -Returns TRUE if the URL is writable; otherwise returns FALSE. -.PP -See also isValid(). -.SH "QDateTime QUrlInfo::lastModified () const" -Returns the last modification date of the URL. -.PP -See also isValid(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "QDateTime QUrlInfo::lastRead () const" -Returns the date when the URL was last read. -.PP -See also isValid(). -.SH "bool QUrlInfo::lessThan ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )\fC [static]\fR" -Returns TRUE if \fIi1\fR is less than \fIi2\fR; otherwise returns FALSE. The objects are compared by the value, which is specified by \fIsortBy\fR. This must be one of QDir::Name, QDir::Time or QDir::Size. -.SH "QString QUrlInfo::name () const" -Returns the file name of the URL. -.PP -See also isValid(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "QUrlInfo & QUrlInfo::operator= ( const QUrlInfo & ui )" -Assigns the values of \fIui\fR to this QUrlInfo object. -.SH "bool QUrlInfo::operator== ( const QUrlInfo & i ) const" -Compares this QUrlInfo with \fIi\fR and returns TRUE if they are equal; otherwise returns FALSE. -.SH "QString QUrlInfo::owner () const" -Returns the owner of the URL. -.PP -See also isValid(). -.SH "int QUrlInfo::permissions () const" -Returns the permissions of the URL. You can use the PermissionSpec flags to test for certain permissions. -.PP -See also isValid(). -.SH "void QUrlInfo::setDir ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE then the URL is set to be a directory; if \\b is FALSE then the URL is set not to be a directory (which normally means it is a file). (Note that a URL can refer to both a file and a directory even though most file systems do not support this.) -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QUrlInfo::setFile ( bool b )\fC [virtual]\fR" -If \fIb\fR is TRUE then the URL is set to be a file; if \\b is FALSE then the URL is set not to be a file (which normally means it is a directory). (Note that a URL can refer to both a file and a directory even though most file systems do not support this.) -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QUrlInfo::setGroup ( const QString & s )\fC [virtual]\fR" -Specifies that the owning group of the URL is called \fIs\fR. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.SH "void QUrlInfo::setLastModified ( const QDateTime & dt )\fC [virtual]\fR" -Specifies that the object the URL refers to was last modified at \fIdt\fR. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.SH "void QUrlInfo::setName ( const QString & name )\fC [virtual]\fR" -Sets the name of the URL to \fIname\fR. The name is the full text, for example, "http://doc.trolltech.com/ntqurlinfo.html". -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QUrlInfo::setOwner ( const QString & s )\fC [virtual]\fR" -Specifies that the owner of the URL is called \fIs\fR. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.SH "void QUrlInfo::setPermissions ( int p )\fC [virtual]\fR" -Specifies that the URL has access permisions, \fIp\fR. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.SH "void QUrlInfo::setReadable ( bool b )\fC [virtual]\fR" -Specifies that the URL is readable if \fIb\fR is TRUE and not readable if \fIb\fR is FALSE. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QUrlInfo::setSize ( uint size )\fC [virtual]\fR" -Specifies the \fIsize\fR of the URL. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.SH "void QUrlInfo::setSymLink ( bool b )\fC [virtual]\fR" -Specifies that the URL refers to a symbolic link if \fIb\fR is TRUE and that it does not if \fIb\fR is FALSE. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "void QUrlInfo::setWritable ( bool b )\fC [virtual]\fR" -Specifies that the URL is writable if \fIb\fR is TRUE and not writable if \fIb\fR is FALSE. -.PP -If you call this function for an invalid URL info, this function turns it into a valid one. -.PP -See also isValid(). -.PP -Example: network/networkprotocol/nntp.cpp. -.SH "uint QUrlInfo::size () const" -Returns the size of the URL. -.PP -See also isValid(). -.PP -Example: network/ftpclient/ftpmainwindow.ui.h. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqurlinfo.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qurlinfo.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qurloperator.3qt b/doc/man/man3/qurloperator.3qt deleted file mode 100644 index a38dc990f..000000000 --- a/doc/man/man3/qurloperator.3qt +++ /dev/null @@ -1,379 +0,0 @@ -'\" t -.TH QUrlOperator 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 -QUrlOperator \- Common operations on URLs -.SH SYNOPSIS -\fC#include <ntqurloperator.h>\fR -.PP -Inherits QObject and QUrl. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQUrlOperator\fR ()" -.br -.ti -1c -.BI "\fBQUrlOperator\fR ( const QString & url )" -.br -.ti -1c -.BI "\fBQUrlOperator\fR ( const QUrlOperator & url )" -.br -.ti -1c -.BI "\fBQUrlOperator\fR ( const QUrlOperator & url, const QString & relUrl, bool checkSlash = FALSE )" -.br -.ti -1c -.BI "virtual \fB~QUrlOperator\fR ()" -.br -.ti -1c -.BI "virtual const QNetworkOperation * \fBlistChildren\fR ()" -.br -.ti -1c -.BI "virtual const QNetworkOperation * \fBmkdir\fR ( const QString & dirname )" -.br -.ti -1c -.BI "virtual const QNetworkOperation * \fBremove\fR ( const QString & filename )" -.br -.ti -1c -.BI "virtual const QNetworkOperation * \fBrename\fR ( const QString & oldname, const QString & newname )" -.br -.ti -1c -.BI "virtual const QNetworkOperation * \fBget\fR ( const QString & location = QString::null )" -.br -.ti -1c -.BI "virtual const QNetworkOperation * \fBput\fR ( const QByteArray & data, const QString & location = QString::null )" -.br -.ti -1c -.BI "virtual QPtrList<QNetworkOperation> \fBcopy\fR ( const QString & from, const QString & to, bool move = FALSE, bool toPath = TRUE )" -.br -.ti -1c -.BI "virtual void \fBcopy\fR ( const QStringList & files, const QString & dest, bool move = FALSE )" -.br -.ti -1c -.BI "virtual bool \fBisDir\fR ( bool * ok = 0 )" -.br -.ti -1c -.BI "virtual void \fBsetNameFilter\fR ( const QString & nameFilter )" -.br -.ti -1c -.BI "QString \fBnameFilter\fR () const" -.br -.ti -1c -.BI "virtual QUrlInfo \fBinfo\fR ( const QString & entry ) const" -.br -.ti -1c -.BI "virtual void \fBstop\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBnewChildren\fR ( const QValueList<QUrlInfo> & i, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBfinished\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBstart\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBcreatedDirectory\fR ( const QUrlInfo & i, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBremoved\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBitemChanged\fR ( QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBdata\fR ( const QByteArray & data, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBdataTransferProgress\fR ( int bytesDone, int bytesTotal, QNetworkOperation * op )" -.br -.ti -1c -.BI "void \fBstartedNextCopy\fR ( const QPtrList<QNetworkOperation> & lst )" -.br -.ti -1c -.BI "void \fBconnectionStateChanged\fR ( int state, const QString & data )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBclearEntries\fR ()" -.br -.ti -1c -.BI "void \fBgetNetworkProtocol\fR ()" -.br -.ti -1c -.BI "void \fBdeleteNetworkProtocol\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "void \fBqInitNetworkProtocols\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QUrlOperator class provides common operations on URLs. -.PP -This class operates on hierarchical structures (such as filesystems) using URLs. Its API facilitates all the common operations: <center>.nf -.TS -l - l. Operation Function List files listChildren() Make a directory mkdir() Remove a file remove() Rename a file rename() Get a file get() Put a file put() Copy a file -.TE -.fi -</center> -.PP -You can obtain additional information about the URL with isDir() and info(). If a directory is to be traversed using listChildren(), a name filter can be set with setNameFilter(). -.PP -A QUrlOperator can be used like this, for example to download a file (and assuming that the FTP protocol is registered): -.PP -.nf -.br - QUrlOperator *op = new QUrlOperator(); -.br - op->copy( QString("ftp://ftp.trolltech.com/qt/source/qt-2.1.0.tar.gz"), -.br - "file:/tmp" ); -.br -.fi -.PP -If you want to be notified about success/failure, progress, etc., you can connect to QUrlOperator's signals, e.g. to start(), newChildren(), createdDirectory(), removed(), data(), dataTransferProgress(), startedNextCopy(), connectionStateChanged(), finished(), etc. A network operation can be stopped with stop(). -.PP -The class uses the functionality of registered network protocols to perform these operations. Depending of the protocol of the URL, it uses an appropriate network protocol class for the operations. Each of the operation functions of QUrlOperator creates a QNetworkOperation object that describes the operation and puts it into the operation queue for the network protocol used. If no suitable protocol could be found (because no implementation of the necessary network protocol is registered), the URL operator emits errors. Not every protocol supports every operation, but error handling deals with this problem. -.PP -To register the available network protocols, use the tqInitNetworkProtocols() function. The protocols currently supported are: -.TP -FTP, -.TP -HTTP, -.TP -local file system. -.PP -For more information about the Qt Network Architecture see the Qt Network Documentation. -.PP -See also QNetworkProtocol, QNetworkOperation, Input/Output and Networking, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QUrlOperator::QUrlOperator ()" -Constructs a QUrlOperator with an empty (i.e. invalid) URL. -.SH "QUrlOperator::QUrlOperator ( const QString & url )" -Constructs a QUrlOperator using \fIurl\fR and parses this string. -.PP -If you pass strings like "/home/qt" the "file" protocol is assumed. -.SH "QUrlOperator::QUrlOperator ( const QUrlOperator & url )" -Constructs a copy of \fIurl\fR. -.SH "QUrlOperator::QUrlOperator ( const QUrlOperator & url, const QString & relUrl, bool checkSlash = FALSE )" -Constructs a QUrlOperator. The URL on which this QUrlOperator operates is constructed out of the arguments \fIurl\fR, \fIrelUrl\fR and \fIcheckSlash\fR: see the corresponding QUrl constructor for an explanation of these arguments. -.SH "QUrlOperator::~QUrlOperator ()\fC [virtual]\fR" -Destructor. -.SH "void QUrlOperator::clearEntries ()\fC [virtual protected]\fR" -Clears the cache of children. -.SH "void QUrlOperator::connectionStateChanged ( int state, const QString & data )\fC [signal]\fR" -This signal is emitted whenever the URL operator's connection state changes. \fIstate\fR describes the new state, which is a QNetworkProtocol::ConnectionState value. -.PP -\fIdata\fR is a string that describes the change of the connection. This can be used to display a message to the user. -.SH "QPtrList<QNetworkOperation> QUrlOperator::copy ( const QString & from, const QString & to, bool move = FALSE, bool toPath = TRUE )\fC [virtual]\fR" -Copies the file \fIfrom\fR to \fIto\fR. If \fImove\fR is TRUE, the file is moved (copied and removed). \fIfrom\fR must point to a file and \fIto\fR must point to a directory (into which \fIfrom\fR is copied) unless \fItoPath\fR is set to FALSE. If \fItoPath\fR is set to FALSE then the \fIto\fR variable is assumed to be the absolute file path (destination file path + file name). The copying is done using the get() and put() operations. If you want to be notified about the progress of the operation, connect to the dataTransferProgress() signal. Bear in mind that the get() and put() operations emit this signal through the QUrlOperator. The number of transferred bytes and the total bytes that you receive as arguments in this signal do not relate to the the whole copy operation; they relate first to the get() and then to the put() operation. Always check what type of operation the signal comes from; this is given in the signal's last argument. -.PP -At the end, finished() (with success or failure) is emitted, so check the state of the network operation object to see whether or not the operation was successful. -.PP -Because a move or copy operation consists of multiple operations (get(), put() and maybe remove()), this function doesn't return a single QNetworkOperation, but rather a list of them. They are in the order: get(), put() and (if applicable) remove(). -.PP -See also get() and put(). -.SH "void QUrlOperator::copy ( const QStringList & files, const QString & dest, bool move = FALSE )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Copies the \fIfiles\fR to the directory \fIdest\fR. If \fImove\fR is TRUE the files are moved, not copied. \fIdest\fR must point to a directory. -.PP -This function calls copy() for each entry in \fIfiles\fR in turn. You don't get a result from this function; each time a new copy begins, startedNextCopy() is emitted, with a list of QNetworkOperations that describe the new copy operation. -.SH "void QUrlOperator::createdDirectory ( const QUrlInfo & i, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when mkdir() succeeds and the directory has been created. \fIi\fR holds the information about the new directory. -.PP -\fIop\fR is a pointer to the operation object, which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the new directory's name. -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "void QUrlOperator::data ( const QByteArray & data, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when new \fIdata\fR has been received after calling get() or put(). \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the name of the file whose data is retrieved and op->rawArg(1) holds the (raw) data. -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "void QUrlOperator::dataTransferProgress ( int bytesDone, int bytesTotal, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted during data transfer (using put() or get()). \fIbytesDone\fR specifies how many bytes of \fIbytesTotal\fR have been transferred. More information about the operation is stored in \fIop\fR, a pointer to the network operation that is processed. \fIbytesTotal\fR may be -1, which means that the total number of bytes is not known. -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "void QUrlOperator::deleteNetworkProtocol ()\fC [protected]\fR" -Deletes the currently used network protocol. -.SH "void QUrlOperator::finished ( QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when an operation of some sort finishes, whether with success or failure. \fIop\fR is a pointer to the operation object, which contains all the information, including the state, of the operation which has been finished. Check the state and error code of the operation object to see whether or not the operation was successful. -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "const QNetworkOperation * QUrlOperator::get ( const QString & location = QString::null )\fC [virtual]\fR" -Tells the network protocol to get data from \fIlocation\fR or, if this is QString::null, to get data from the location to which this URL points (see QUrl::fileName() and QUrl::encodedPathAndQuery()). What happens then depends on the network protocol. The data() signal is emitted when data comes in. Because it's unlikely that all data will come in at once, it is common for multiple data() signals to be emitted. The dataTransferProgress() signal is emitted while processing the operation. At the end, finished() (with success or failure) is emitted, so check the state of the network operation object to see whether or not the operation was successful. -.PP -If \fIlocation\fR is QString::null, the path of this QUrlOperator should point to a file when you use this operation. If \fIlocation\fR is not empty, it can be a relative URL (a child of the path to which the QUrlOperator points) or an absolute URL. -.PP -For example, to get a web page you might do something like this: -.PP -.nf -.br - QUrlOperator op( "http://www.whatever.org/cgi-bin/search.pl?cmd=Hello" ); -.br - op.get(); -.br -.fi -.PP -For most other operations, the path of the QUrlOperator must point to a directory. If you want to download a file you could do the following: -.PP -.nf -.br - QUrlOperator op( "ftp://ftp.whatever.org/pub" ); -.br - // do some other stuff like op.listChildren() or op.mkdir( "new_dir" ) -.br - op.get( "a_file.txt" ); -.br -.fi -.PP -This will get the data of ftp://ftp.whatever.org/pub/a_file.txt. -.PP -\fINever\fR do anything like this: -.PP -.nf -.br - QUrlOperator op( "http://www.whatever.org/cgi-bin" ); -.br - op.get( "search.pl?cmd=Hello" ); // WRONG! -.br -.fi -.PP -If \fIlocation\fR is not empty and relative it must not contain any queries or references, just the name of a child. So if you need to specify a query or reference, do it as shown in the first example or specify the full URL (such as http://www.whatever.org/cgi-bin/search.pl?cmd=Hello) as \fIlocation\fR. -.PP -See also copy(). -.SH "void QUrlOperator::getNetworkProtocol ()\fC [protected]\fR" -Finds a network protocol for the URL and deletes the old network protocol. -.SH "QUrlInfo QUrlOperator::info ( const QString & entry ) const\fC [virtual]\fR" -Returns the URL information for the child \fIentry\fR, or returns an empty QUrlInfo object if there is no information available about \fIentry\fR. Information about \fIentry\fR is only available after a successfully finished listChildren() operation. -.SH "bool QUrlOperator::isDir ( bool * ok = 0 )\fC [virtual]\fR" -Returns TRUE if the URL is a directory; otherwise returns FALSE. This may not always work correctly, if the protocol of the URL is something other than file (local filesystem). If you pass a bool pointer as the \fIok\fR argument, \fI*ok\fR is set to TRUE if the result of this function is known to be correct, and to FALSE otherwise. -.SH "void QUrlOperator::itemChanged ( QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted whenever a file which is a child of the URL has been changed, for example by successfully calling rename(). \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the original file name and \fCop->arg(1)\fR holds the new file name (if it was changed). -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "const QNetworkOperation * QUrlOperator::listChildren ()\fC [virtual]\fR" -Starts listing the children of this URL (e.g. the files in the directory). The start() signal is emitted before the first entry is listed and finished() is emitted after the last one. The newChildren() signal is emitted for each list of new entries. If an error occurs, the signal finished() is emitted, so be sure to check the state of the network operation pointer. -.PP -Because the operation may not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. -.PP -The path of this QUrlOperator must to point to a directory (because the children of this directory will be listed), not to a file. -.SH "const QNetworkOperation * QUrlOperator::mkdir ( const QString & dirname )\fC [virtual]\fR" -Tries to create a directory (child) with the name \fIdirname\fR. If it is successful, a newChildren() signal with the new child is emitted, and the createdDirectory() signal with the information about the new child is also emitted. The finished() signal (with success or failure) is emitted after the operation has been processed, so check the state of the network operation object to see whether or not the operation was successful. -.PP -Because the operation will not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. -.PP -The path of this QUrlOperator must to point to a directory (not a file) because the new directory will be created in this path. -.SH "QString QUrlOperator::nameFilter () const" -Returns the name filter of the URL. -.PP -See also QUrlOperator::setNameFilter() and QDir::nameFilter(). -.SH "void QUrlOperator::newChildren ( const QValueList<QUrlInfo> & i, QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted after listChildren() was called and new children (i.e. files) have been read from a list of files. \fIi\fR holds the information about the new files. \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "const QNetworkOperation * QUrlOperator::put ( const QByteArray & data, const QString & location = QString::null )\fC [virtual]\fR" -This function tells the network protocol to put \fIdata\fR in \fIlocation\fR. If \fIlocation\fR is empty (QString::null), it puts the \fIdata\fR in the location to which the URL points. What happens depends on the network protocol. Depending on the network protocol, some data might come back after putting data, in which case the data() signal is emitted. The dataTransferProgress() signal is emitted during processing of the operation. At the end, finished() (with success or failure) is emitted, so check the state of the network operation object to see whether or not the operation was successful. -.PP -If \fIlocation\fR is QString::null, the path of this QUrlOperator should point to a file when you use this operation. If \fIlocation\fR is not empty, it can be a relative (a child of the path to which the QUrlOperator points) or an absolute URL. -.PP -For putting some data to a file you can do the following: -.PP -.nf -.br - QUrlOperator op( "ftp://ftp.whatever.com/home/me/filename.dat" ); -.br - op.put( data ); -.br -.fi -.PP -For most other operations, the path of the QUrlOperator must point to a directory. If you want to upload data to a file you could do the following: -.PP -.nf -.br - QUrlOperator op( "ftp://ftp.whatever.com/home/me" ); -.br - // do some other stuff like op.listChildren() or op.mkdir( "new_dir" ) -.br - op.put( data, "filename.dat" ); -.br -.fi -.PP -This will upload the data to ftp://ftp.whatever.com/home/me/filename.dat. -.PP -See also copy(). -.SH "const QNetworkOperation * QUrlOperator::remove ( const QString & filename )\fC [virtual]\fR" -Tries to remove the file (child) \fIfilename\fR. If it succeeds the removed() signal is emitted. finished() (with success or failure) is also emitted after the operation has been processed, so check the state of the network operation object to see whether or not the operation was successful. -.PP -Because the operation will not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. -.PP -The path of this QUrlOperator must point to a directory; because if \fIfilename\fR is relative, it will try to remove it in this directory. -.SH "void QUrlOperator::removed ( QNetworkOperation * op )\fC [signal]\fR" -This signal is emitted when remove() has been succesful and the file has been removed. -.PP -\fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the name of the file that was removed. -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "const QNetworkOperation * QUrlOperator::rename ( const QString & oldname, const QString & newname )\fC [virtual]\fR" -Tries to rename the file (child) called \fIoldname\fR to \fInewname\fR. If it succeeds, the itemChanged() signal is emitted. finished() (with success or failure) is also emitted after the operation has been processed, so check the state of the network operation object to see whether or not the operation was successful. -.PP -Because the operation may not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. -.PP -This path of this QUrlOperator must to point to a directory because \fIoldname\fR and \fInewname\fR are handled relative to this directory. -.SH "void QUrlOperator::setNameFilter ( const QString & nameFilter )\fC [virtual]\fR" -Sets the name filter of the URL to \fInameFilter\fR. -.PP -See also QDir::setNameFilter(). -.SH "void QUrlOperator::start ( QNetworkOperation * op )\fC [signal]\fR" -Some operations (such as listChildren()) emit this signal when they start processing the operation. \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. -.PP -See also QNetworkOperation and QNetworkProtocol. -.SH "void QUrlOperator::startedNextCopy ( const QPtrList<QNetworkOperation> & lst )\fC [signal]\fR" -This signal is emitted if copy() starts a new copy operation. \fIlst\fR contains all QNetworkOperations related to this copy operation. -.PP -See also copy(). -.SH "void QUrlOperator::stop ()\fC [virtual]\fR" -Stops the current network operation and removes all this QUrlOperator's waiting network operations. -.SH RELATED FUNCTION DOCUMENTATION -.SH "void tqInitNetworkProtocols ()" -This function registers the network protocols for FTP and HTTP. You must call this function before you use QUrlOperator for these protocols. -.PP -This function is declared in ntqnetwork.h. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqurloperator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qurloperator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/quuid.3qt b/doc/man/man3/quuid.3qt deleted file mode 100644 index d19fa5129..000000000 --- a/doc/man/man3/quuid.3qt +++ /dev/null @@ -1,203 +0,0 @@ -'\" t -.TH QUuid 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 -QUuid \- Defines a Universally Unique Identifier (UUID) -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntquuid.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBVariant\fR { VarUnknown = -1, NCS = 0, DCE = 2, Microsoft = 6, Reserved = 7 }" -.br -.ti -1c -.BI "enum \fBVersion\fR { VerUnknown = -1, Time = 1, EmbeddedPOSIX = 2, Name = 3, Random = 4 }" -.br -.ti -1c -.BI "\fBQUuid\fR ()" -.br -.ti -1c -.BI "\fBQUuid\fR ( uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8 )" -.br -.ti -1c -.BI "\fBQUuid\fR ( const QUuid & orig )" -.br -.ti -1c -.BI "\fBQUuid\fR ( const QString & text )" -.br -.ti -1c -.BI "QString \fBtoString\fR () const" -.br -.ti -1c -.BI "\fBoperator QString\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "QUuid & \fBoperator=\fR ( const QUuid & uuid )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QUuid & other ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QUuid & other ) const" -.br -.ti -1c -.BI "bool \fBoperator<\fR ( const QUuid & other ) const" -.br -.ti -1c -.BI "bool \fBoperator>\fR ( const QUuid & other ) const" -.br -.ti -1c -.BI "QUuid::Variant \fBvariant\fR () const" -.br -.ti -1c -.BI "QUuid::Version \fBversion\fR () const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QUuid \fBcreateUuid\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QUuid & id )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QUuid & id )" -.br -.in -1c -.SH DESCRIPTION -The QUuid class defines a Universally Unique Identifier (UUID). -.PP -For objects or declarations that must be uniquely identified, UUIDs (also known as GUIDs) are widely used in order to assign a fixed and easy to compare value to the object or declaration. The 128-bit value of a UUID is generated by an algorithm that guarantees that the value is unique. -.PP -In Qt, UUIDs are wrapped by the QUuid struct which provides convenience functions for handling UUIDs. Most platforms provide a tool to generate new UUIDs, for example, uuidgen and guidgen. -.PP -UUIDs generated by QUuid, are based on the Random version of the DCE (Distributed Computing Environment) standard. -.PP -UUIDs can be constructed from numeric values or from strings, or using the static createUuid() function. They can be converted to a string with toString(). UUIDs have a variant() and a version(), and null UUIDs return TRUE from isNull(). -.SS "Member Type Documentation" -.SH "QUuid::Variant" -This enum defines the variant of the UUID, which is the scheme which defines the layout of the 128-bits value. -.TP -\fCQUuid::VarUnknown\fR - Variant is unknown -.TP -\fCQUuid::NCS\fR - Reserved for NCS (Network Computing System) backward compatibility -.TP -\fCQUuid::DCE\fR - Distributed Computing Environment, the scheme used by QUuid -.TP -\fCQUuid::Microsoft\fR - Reserved for Microsoft backward compatibility (GUID) -.TP -\fCQUuid::Reserved\fR - Reserved for future definition -.SH "QUuid::Version" -This enum defines the version of the UUID. -.TP -\fCQUuid::VerUnknown\fR - Version is unknown -.TP -\fCQUuid::Time\fR - Time-based, by using timestamp, clock sequence, and MAC network card address (if available) for the node sections -.TP -\fCQUuid::EmbeddedPOSIX\fR - DCE Security version, with embedded POSIX UUIDs -.TP -\fCQUuid::Name\fR - Name-based, by using values from a name for all sections -.TP -\fCQUuid::Random\fR - Random-based, by using random numbers for all sections -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QUuid::QUuid ()" -Creates the null UUID {00000000-0000-0000-0000-000000000000}. -.SH "QUuid::QUuid ( uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8 )" -Creates a UUID with the value specified by the parameters, \fIl\fR, \fIw1\fR, \fIw2\fR, \fIb1\fR, \fIb2\fR, \fIb3\fR, \fIb4\fR, \fIb5\fR, \fIb6\fR, \fIb7\fR, \fIb8\fR. -.PP -Example: -.PP -.nf -.br - // {67C8770B-44F1-410A-AB9A-F9B5446F13EE} -.br - QUuid IID_MyInterface( 0x67c8770b, 0x44f1, 0x410a, 0xab, 0x9a, 0xf9, 0xb5, 0x44, 0x6f, 0x13, 0xee ) -.br -.fi -.SH "QUuid::QUuid ( const QUuid & orig )" -Creates a copy of the QUuid \fIorig\fR. -.SH "QUuid::QUuid ( const QString & text )" -Creates a QUuid object from the string \fItext\fR. The function can only convert a string in the format {HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHH} (where 'H' stands for a hex digit). If the conversion fails a null UUID is created. -.SH "QUuid QUuid::createUuid ()\fC [static]\fR" -Returns a new UUID of DCE variant, and Random type. The UUIDs generated are based on the platform specific pseudo-random generator, which is usually not a cryptographic-quality random number generator. Therefore, a UUID is not guaranteed to be unique cross application instances. -.PP -On Windows, the new UUID is extremely likely to be unique on the same or any other system, networked or not. -.PP -See also variant() and version(). -.SH "bool QUuid::isNull () const" -Returns TRUE if this is the null UUID {00000000-0000-0000-0000-000000000000}; otherwise returns FALSE. -.SH "QUuid::operator QString () const" -Returns the string representation of the uuid. -.PP -See also toString(). -.SH "bool QUuid::operator!= ( const QUuid & other ) const" -Returns TRUE if this QUuid and the \fIother\fR QUuid are different; otherwise returns FALSE. -.SH "bool QUuid::operator< ( const QUuid & other ) const" -Returns TRUE if this QUuid is of the same variant, and lexicographically before the \fIother\fR QUuid; otherwise returns FALSE. -.PP -See also variant(). -.SH "QUuid & QUuid::operator= ( const QUuid & uuid )" -Assigns the value of \fIuuid\fR to this QUuid object. -.SH "bool QUuid::operator== ( const QUuid & other ) const" -Returns TRUE if this QUuid and the \fIother\fR QUuid are identical; otherwise returns FALSE. -.SH "bool QUuid::operator> ( const QUuid & other ) const" -Returns TRUE if this QUuid is of the same variant, and lexicographically after the \fIother\fR QUuid; otherwise returns FALSE. -.PP -See also variant(). -.SH "QString QUuid::toString () const" -QString QUuid::toString() const -.PP -Returns the string representation of the uuid. -.SH "QUuid::Variant QUuid::variant () const" -Returns the variant of the UUID. The null UUID is considered to be of an unknown variant. -.PP -See also version(). -.SH "QUuid::Version QUuid::version () const" -Returns the version of the UUID, if the UUID is of the DCE variant; otherwise returns VerUnknown. -.PP -See also variant(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QUuid & id )" -Writes the uuid \fIid\fR to the datastream \fIs\fR. -.SH "QDataStream & operator>> ( QDataStream & s, QUuid & id )" -Reads uuid from from the stream \fIs\fR into \fIid\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntquuid.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 qt-bugs@trolltech.com . -Please include the name of the manual page (quuid.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvalidator.3qt b/doc/man/man3/qvalidator.3qt deleted file mode 100644 index d58796375..000000000 --- a/doc/man/man3/qvalidator.3qt +++ /dev/null @@ -1,112 +0,0 @@ -'\" t -.TH QValidator 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 -QValidator \- Validation of input text -.SH SYNOPSIS -\fC#include <ntqvalidator.h>\fR -.PP -Inherits QObject. -.PP -Inherited by QIntValidator, QDoubleValidator, and QRegExpValidator. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQValidator\fR ( QObject * parent, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QValidator\fR ()" -.br -.ti -1c -.BI "enum \fBState\fR { Invalid, Intermediate, Valid = Intermediate, Acceptable }" -.br -.ti -1c -.BI "virtual State \fBvalidate\fR ( QString & input, int & pos ) const = 0" -.br -.ti -1c -.BI "virtual void \fBfixup\fR ( QString & input ) const" -.br -.in -1c -.SH DESCRIPTION -The QValidator class provides validation of input text. -.PP -The class itself is abstract. Two subclasses, QIntValidator and QDoubleValidator, provide basic numeric-range checking, and QRegExpValidator provides general checking using a custom regular expression. -.PP -If the built-in validators aren't sufficient, you can subclass QValidator. The class has two virtual functions: validate() and fixup(). -.PP -validate() must be implemented by every subclass. It returns Invalid, Intermediate or Acceptable depending on whether its argument is valid (for the subclass's definition of valid). -.PP -These three states require some explanation. An Invalid string is \fIclearly\fR invalid. Intermediate is less obvious: the concept of validity is slippery when the string is incomplete (still being edited). QValidator defines Intermediate as the property of a string that is neither clearly invalid nor acceptable as a final result. Acceptable means that the string is acceptable as a final result. One might say that any string that is a plausible intermediate state during entry of an Acceptable string is Intermediate. -.PP -Here are some examples: -.IP -.TP -For a line edit that accepts integers from 0 to 999 inclusive, 42 and 123 are Acceptable, the empty string and 1114 are Intermediate and asdf is Invalid. -.IP -.TP -For an editable combobox that accepts URLs, any well-formed URL is Acceptable, "http://www.trolltech.com/," is Intermediate (it might be a cut and paste operation that accidentally took in a comma at the end), the empty string is Intermediate (the user might select and delete all of the text in preparation for entering a new URL), and "http:///./" is Invalid. -.IP -.TP -For a spin box that accepts lengths, "11cm" and "1in" are Acceptable, "11" and the empty string are Intermediate and" http://www.trolltech.com" and "hour" are Invalid. -.IP -.PP -fixup() is provided for validators that can repair some user errors. The default implementation does nothing. QLineEdit, for example, will call fixup() if the user presses Enter (or Return) and the content is not currently valid. This allows the fixup() function the opportunity of performing some magic to make an Invalid string Acceptable. -.PP -QValidator is typically used with QLineEdit, QSpinBox and QComboBox. -.PP -See also Miscellaneous Classes. -.SS "Member Type Documentation" -.SH "QValidator::State" -This enum type defines the states in which a validated string can exist. -.TP -\fCQValidator::Invalid\fR - the string is \fIclearly\fR invalid. -.TP -\fCQValidator::Intermediate\fR - the string is a plausible intermediate value during editing. -.TP -\fCQValidator::Acceptable\fR - the string is acceptable as a final result, i.e. it is valid. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QValidator::QValidator ( QObject * parent, const char * name = 0 )" -Sets up the validator. The \fIparent\fR and \fIname\fR parameters are passed on to the QObject constructor. -.SH "QValidator::~QValidator ()" -Destroys the validator, freeing any storage and other resources used. -.SH "void QValidator::fixup ( QString & input ) const\fC [virtual]\fR" -This function attempts to change \fIinput\fR to be valid according to this validator's rules. It need not result in a valid string: callers of this function must re-test afterwards; the default does nothing. -.PP -Reimplementations of this function can change \fIinput\fR even if they do not produce a valid string. For example, an ISBN validator might want to delete every character except digits and "-", even if the result is still not a valid ISBN; a surname validator might want to remove whitespace from the start and end of the string, even if the resulting string is not in the list of accepted surnames. -.SH "State QValidator::validate ( QString & input, int & pos ) const\fC [pure virtual]\fR" -This pure virtual function returns Invalid if \fIinput\fR is invalid according to this validator's rules, Intermediate if it is likely that a little more editing will make the input acceptable (e.g. the user types '4' into a widget which accepts integers between 10 and 99) and Acceptable if the input is valid. -.PP -The function can change \fIinput\fR and \fIpos\fR (the cursor position) if it wants to. -.PP -Reimplemented in QIntValidator, QDoubleValidator, and QRegExpValidator. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvalidator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvalidator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvaluelist.3qt b/doc/man/man3/qvaluelist.3qt deleted file mode 100644 index c42a7677c..000000000 --- a/doc/man/man3/qvaluelist.3qt +++ /dev/null @@ -1,756 +0,0 @@ -'\" t -.TH QValueList 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 -QValueList \- Value-based template class that provides lists -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqvaluelist.h>\fR -.PP -Inherited by QCanvasItemList, QStringList, and QValueStack. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef QValueListIterator<T> \fBiterator\fR" -.br -.ti -1c -.BI "typedef QValueListConstIterator<T> \fBconst_iterator\fR" -.br -.ti -1c -.BI "typedef T \fBvalue_type\fR" -.br -.ti -1c -.BI "typedef value_type * \fBpointer\fR" -.br -.ti -1c -.BI "typedef const value_type * \fBconst_pointer\fR" -.br -.ti -1c -.BI "typedef value_type & \fBreference\fR" -.br -.ti -1c -.BI "typedef const value_type & \fBconst_reference\fR" -.br -.ti -1c -.BI "typedef size_t \fBsize_type\fR" -.br -.ti -1c -.BI "\fBQValueList\fR ()" -.br -.ti -1c -.BI "\fBQValueList\fR ( const QValueList<T> & l )" -.br -.ti -1c -.BI "\fBQValueList\fR ( const std::list<T> & l )" -.br -.ti -1c -.BI "\fB~QValueList\fR ()" -.br -.ti -1c -.BI "QValueList<T> & \fBoperator=\fR ( const QValueList<T> & l )" -.br -.ti -1c -.BI "QValueList<T> & \fBoperator=\fR ( const std::list<T> & l )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const std::list<T> & l ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QValueList<T> & l ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QValueList<T> & l ) const" -.br -.ti -1c -.BI "iterator \fBbegin\fR ()" -.br -.ti -1c -.BI "const_iterator \fBbegin\fR () const" -.br -.ti -1c -.BI "const_iterator \fBconstBegin\fR () const" -.br -.ti -1c -.BI "iterator \fBend\fR ()" -.br -.ti -1c -.BI "const_iterator \fBend\fR () const" -.br -.ti -1c -.BI "const_iterator \fBconstEnd\fR () const" -.br -.ti -1c -.BI "iterator \fBinsert\fR ( iterator it, const T & x )" -.br -.ti -1c -.BI "uint \fBremove\fR ( const T & x )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "QValueList<T> & \fBoperator<<\fR ( const T & x )" -.br -.ti -1c -.BI "size_type \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBempty\fR () const" -.br -.ti -1c -.BI "void \fBpush_front\fR ( const T & x )" -.br -.ti -1c -.BI "void \fBpush_back\fR ( const T & x )" -.br -.ti -1c -.BI "iterator \fBerase\fR ( iterator it )" -.br -.ti -1c -.BI "iterator \fBerase\fR ( iterator first, iterator last )" -.br -.ti -1c -.BI "reference \fBfront\fR ()" -.br -.ti -1c -.BI "const_reference \fBfront\fR () const" -.br -.ti -1c -.BI "reference \fBback\fR ()" -.br -.ti -1c -.BI "const_reference \fBback\fR () const" -.br -.ti -1c -.BI "void \fBpop_front\fR ()" -.br -.ti -1c -.BI "void \fBpop_back\fR ()" -.br -.ti -1c -.BI "void \fBinsert\fR ( iterator pos, size_type n, const T & x )" -.br -.ti -1c -.BI "QValueList<T> \fBoperator+\fR ( const QValueList<T> & l ) const" -.br -.ti -1c -.BI "QValueList<T> & \fBoperator+=\fR ( const QValueList<T> & l )" -.br -.ti -1c -.BI "iterator \fBfromLast\fR ()" -.br -.ti -1c -.BI "const_iterator \fBfromLast\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "iterator \fBappend\fR ( const T & x )" -.br -.ti -1c -.BI "iterator \fBprepend\fR ( const T & x )" -.br -.ti -1c -.BI "iterator \fBremove\fR ( iterator it )" -.br -.ti -1c -.BI "T & \fBfirst\fR ()" -.br -.ti -1c -.BI "const T & \fBfirst\fR () const" -.br -.ti -1c -.BI "T & \fBlast\fR ()" -.br -.ti -1c -.BI "const T & \fBlast\fR () const" -.br -.ti -1c -.BI "T & \fBoperator[]\fR ( size_type i )" -.br -.ti -1c -.BI "const T & \fBoperator[]\fR ( size_type i ) const" -.br -.ti -1c -.BI "iterator \fBat\fR ( size_type i )" -.br -.ti -1c -.BI "const_iterator \fBat\fR ( size_type i ) const" -.br -.ti -1c -.BI "iterator \fBfind\fR ( const T & x )" -.br -.ti -1c -.BI "const_iterator \fBfind\fR ( const T & x ) const" -.br -.ti -1c -.BI "iterator \fBfind\fR ( iterator it, const T & x )" -.br -.ti -1c -.BI "const_iterator \fBfind\fR ( const_iterator it, const T & x ) const" -.br -.ti -1c -.BI "int \fBfindIndex\fR ( const T & x ) const" -.br -.ti -1c -.BI "size_type \fBcontains\fR ( const T & x ) const" -.br -.ti -1c -.BI "size_type \fBcount\fR () const" -.br -.ti -1c -.BI "QValueList<T> & \fBoperator+=\fR ( const T & x )" -.br -.ti -1c -.BI "typedef QValueListIterator<T> \fBIterator\fR" -.br -.ti -1c -.BI "typedef QValueListConstIterator<T> \fBConstIterator\fR" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QValueList<T> & l )" -.br -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QValueList<T> & l )" -.br -.in -1c -.SH DESCRIPTION -The QValueList class is a value-based template class that provides lists. -.PP -QValueList is a Qt implementation of an STL-like list container. It can be used in your application if the standard \fClist\fR is not available for your target platform(s). QValueList is part of the Qt Template Library. -.PP -QValueList<T> defines a template instance to create a list of values that all have the class T. Note that QValueList does not store pointers to the members of the list; it holds a copy of every member. This is why these kinds of classes are called "value based"; QPtrList and QDict are "pointer based". -.PP -QValueList contains and manages a collection of objects of type T and provides iterators that allow the contained objects to be addressed. QValueList owns the contained items. For more relaxed ownership semantics, see QPtrCollection and friends which are pointer-based containers. -.PP -Some classes cannot be used within a QValueList, for example, all classes derived from QObject and thus all classes that implement widgets. Only values can be used in a QValueList. To qualify as a value the class must provide: -.TP -a copy constructor; -.TP -an assignment operator; -.TP -a default constructor, i.e. a constructor that does not take any arguments. -.PP -Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. -.PP -In addition, some compilers (e.g. Sun CC) might require that the class provides an equality operator (operator==()). -.PP -QValueList's function naming is consistent with the other Qt classes (e.g. count(), isEmpty()). QValueList also provides extra functions for compatibility with STL algorithms, such as size() and empty(). Programmers already familiar with the STL \fClist\fR may prefer to use the STL-compatible functions. -.PP -Example: -.PP -.nf -.br - class Employee -.br - { -.br - public: -.br - Employee(): sn(0) {} -.br - Employee( const QString& forename, const QString& surname, int salary ) -.br - : fn(forename), sn(surname), sal(salary) -.br - {} -.br -.br - QString forename() const { return fn; } -.br - QString surname() const { return sn; } -.br - int salary() const { return sal; } -.br - void setSalary( int salary ) { sal = salary; } -.br -.br - private: -.br - QString fn; -.br - QString sn; -.br - int sal; -.br - }; -.br -.br - typedef QValueList<Employee> EmployeeList; -.br - EmployeeList list; -.br -.br - list.append( Employee("John", "Doe", 50000) ); -.br - list.append( Employee("Jane", "Williams", 80000) ); -.br - list.append( Employee("Tom", "Jones", 60000) ); -.br -.br - Employee mary( "Mary", "Hawthorne", 90000 ); -.br - list.append( mary ); -.br - mary.setSalary( 100000 ); -.br -.br - EmployeeList::iterator it; -.br - for ( it = list.begin(); it != list.end(); ++it ) -.br - cout << (*it).surname().latin1() << ", " << -.br - (*it).forename().latin1() << " earns " << -.br - (*it).salary() << endl; -.br -.br - // Output: -.br - // Doe, John earns 50000 -.br - // Williams, Jane earns 80000 -.br - // Hawthorne, Mary earns 90000 -.br - // Jones, Tom earns 60000 -.br -.fi -.PP -Notice that the latest changes to Mary's salary did not affect the value in the list because the list created a copy of Mary's entry. -.PP -There are several ways to find items in the list. The begin() and end() functions return iterators to the beginning and end of the list. The advantage of getting an iterator is that you can move forward or backward from this position by incrementing/decrementing the iterator. The iterator returned by end() points to the item which is one \fIpast\fR the last item in the container. The past-the-end iterator is still associated with the list it belongs to, however it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. If the list is empty(), the iterator returned by begin() will equal the iterator returned by end(). -.PP -Another way to find an item in the list is by using the tqFind() algorithm. For example: -.PP -.nf -.br - QValueList<int> list; -.br - ... -.br - QValueList<int>::iterator it = tqFind( list.begin(), list.end(), 3 ); -.br - if ( it != list.end() ) -.br - // it points to the found item -.br -.fi -.PP -It is safe to have multiple iterators a the list at the same time. If some member of the list is removed, only iterators pointing to the removed member become invalid. Inserting into the list does not invalidate any iterator. For convenience, the function last() returns a reference to the last item in the list, and first() returns a reference to the the first item. If the list is empty(), both last() and first() have undefined behavior (your application will crash or do unpredictable things). Use last() and first() with caution, for example: -.PP -.nf -.br - QValueList<int> list; -.br - list.append( 1 ); -.br - list.append( 2 ); -.br - list.append( 3 ); -.br - ... -.br - if ( !list.empty() ) { -.br - // OK, modify the first item -.br - int& i = list.first(); -.br - i = 18; -.br - } -.br - ... -.br - QValueList<double> dlist; -.br - double d = dlist.last(); // undefined -.br -.fi -.PP -Because QValueList is value-based there is no need to be careful about deleting items in the list. The list holds its own copies and will free them if the corresponding member or the list itself is deleted. You can force the list to free all of its items with clear(). -.PP -QValueList is shared implicitly, which means it can be copied in constant time, i.e. O(1). If multiple QValueList instances share the same data and one needs to modify its contents, this modifying instance makes a copy and modifies its private copy; therefore it does not affect the other instances; this takes O(n) time. This is often called "copy on write". If a QValueList is being used in a multi-threaded program, you must protect all access to the list. See QMutex. -.PP -There are several ways to insert items into the list. The prepend() and append() functions insert items at the beginning and the end of the list respectively. The insert() function comes in several flavors and can be used to add one or more items at specific positions within the list. -.PP -Items can also be removed from the list in several ways. There are several variants of the remove() function, which removes a specific item from the list. The remove() function will find and remove items according to a specific item value. -.PP -Lists can also be sorted using the Qt Template Library. For example with qHeapSort(): -.PP -Example: -.PP -.nf -.br - QValueList<int> list; -.br - list.append( 5 ); -.br - list.append( 8 ); -.br - list.append( 3 ); -.br - list.append( 4 ); -.br - qHeapSort( list ); -.br -.fi -.PP -See also QValueListIterator, Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QValueList::ConstIterator" -This iterator is an instantiation of QValueListConstIterator for the same type as this QValueList. In other words, if you instantiate QValueList<int>, ConstIterator is a QValueListConstIterator<int>. Several member function use it, such as QValueList::begin(), which returns an iterator pointing to the first item in the list. -.PP -Functionally, this is almost the same as Iterator. The only difference is you cannot use ConstIterator for non-const operations, and that the compiler can often generate better code if you use ConstIterator. -.PP -See also QValueListIterator and Iterator. -.SH "QValueList::Iterator" -This iterator is an instantiation of QValueListIterator for the same type as this QValueList. In other words, if you instantiate QValueList<int>, Iterator is a QValueListIterator<int>. Several member function use it, such as QValueList::begin(), which returns an iterator pointing to the first item in the list. -.PP -Functionally, this is almost the same as ConstIterator. The only difference is that you cannot use ConstIterator for non-const operations, and that the compiler can often generate better code if you use ConstIterator. -.PP -See also QValueListIterator and ConstIterator. -.SH "QValueList::const_iterator" -The list's const iterator type, QValueListConstIterator. -.SH "QValueList::const_pointer" -The const pointer to T type. -.SH "QValueList::const_reference" -The const reference to T type. -.SH "QValueList::iterator" -The list's iterator type, QValueListIterator. -.SH "QValueList::pointer" -The pointer to T type. -.SH "QValueList::reference" -The reference to T type. -.SH "QValueList::size_type" -An unsigned integral type, used to represent various sizes. -.SH "QValueList::value_type" -The type of the object stored in the list, T. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QValueList::QValueList ()" -Constructs an empty list. -.SH "QValueList::QValueList ( const QValueList<T> & l )" -Constructs a copy of \fIl\fR. -.PP -This operation takes O(1) time because QValueList is implicitly shared. -.PP -The first modification to a list will take O(n) time. -.SH "QValueList::QValueList ( const std::list<T> & l )" -Contructs a copy of \fIl\fR. -.PP -This constructor is provided for compatibility with STL containers. -.SH "QValueList::~QValueList ()" -Destroys the list. References to the values in the list and all iterators of this list become invalidated. Note that it is impossible for an iterator to check whether or not it is valid: QValueList is highly tuned for performance, not for error checking. -.SH "iterator QValueList::append ( const T & x )" -Inserts \fIx\fR at the end of the list. -.PP -See also insert() and prepend(). -.PP -Examples: -.)l checklists/checklists.cpp and fonts/simple-qfont-demo/viewer.cpp. -.SH "const_iterator QValueList::at ( size_type i ) const" -Returns an iterator pointing to the item at position \fIi\fR in the list, or an undefined value if the index is out of range. -.PP -\fBWarning:\fR This function uses a linear search and can be extremely slow for large lists. QValueList is not optimized for random item access. If you need random access use a different container, such as QValueVector. -.SH "iterator QValueList::at ( size_type i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an iterator pointing to the item at position \fIi\fR in the list, or an undefined value if the index is out of range. -.SH "reference QValueList::back ()" -Returns a reference to the last item. If the list contains no last item (i.e. empty() returns TRUE), the return value is undefined. -.PP -This function is provided for STL compatibility. It is equivalent to last(). -.PP -See also front(). -.SH "const_reference QValueList::back () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "const_iterator QValueList::begin () const" -Returns an iterator pointing to the first item in the list. This iterator equals end() if the list is empty. -.PP -See also first(), end(), and constBegin(). -.PP -Examples: -.)l canvas/canvas.cpp, chart/canvasview.cpp, chart/element.cpp, checklists/checklists.cpp, sql/overview/insert/main.cpp, table/statistics/statistics.cpp, and themes/themes.cpp. -.SH "iterator QValueList::begin ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an iterator pointing to the first item in the list. This iterator equals end() if the list is empty. -.PP -See also first() and end(). -.SH "void QValueList::clear ()" -Removes all items from the list. -.PP -See also remove(). -.SH "const_iterator QValueList::constBegin () const" -Returns an iterator pointing to the first item in the list. This iterator equals constEnd() if the list is empty. -.PP -See also begin(). -.SH "const_iterator QValueList::constEnd () const" -Returns an iterator pointing \fIpast\fR the last item in the list. This iterator equals constBegin() if the list is empty. -.PP -See also end(). -.SH "size_type QValueList::contains ( const T & x ) const" -Returns the number of occurrences of the value \fIx\fR in the list. -.SH "size_type QValueList::count () const" -Returns the number of items in the list. -.PP -See also isEmpty(). -.PP -Examples: -.)l chart/element.cpp, fileiconview/qfileiconview.cpp, and table/statistics/statistics.cpp. -.SH "bool QValueList::empty () const" -Returns TRUE if the list contains no items; otherwise returns FALSE. -.PP -See also size(). -.SH "iterator QValueList::end ()" -Returns an iterator pointing \fIpast\fR the last item in the list. This iterator equals begin() if the list is empty. -.PP -See also last(), begin(), and constEnd(). -.PP -Examples: -.)l canvas/canvas.cpp, chart/canvasview.cpp, chart/element.cpp, checklists/checklists.cpp, sql/overview/insert/main.cpp, table/statistics/statistics.cpp, and themes/themes.cpp. -.SH "const_iterator QValueList::end () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an iterator pointing \fIpast\fR the last item in the list. This iterator equals begin() if the list is empty. -.PP -See also last() and begin(). -.SH "iterator QValueList::erase ( iterator it )" -Removes the item pointed to by \fIit\fR from the list. No iterators other than \fIit\fR or other iterators pointing at the same item as \fIit\fR are invalidated. Returns an iterator to the next item after \fIit\fR, or end() if there is no such item. -.PP -This function is provided for STL compatibility. It is equivalent to remove(). -.SH "iterator QValueList::erase ( iterator first, iterator last )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Deletes all items from \fIfirst\fR to \fIlast\fR (not including \fIlast\fR). No iterators are invalidated, except those pointing to the removed items themselves. Returns \fIlast\fR. -.SH "iterator QValueList::find ( const T & x )" -Returns an iterator pointing to the first occurrence of \fIx\fR in the list. -.PP -Returns end() is no item matched. -.SH "const_iterator QValueList::find ( const T & x ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an iterator pointing to the first occurrence of \fIx\fR in the list. -.PP -Returns end() if no item matched. -.SH "iterator QValueList::find ( iterator it, const T & x )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of \fIx\fR in the list starting at the position given by \fIit\fR. -.PP -Returns end() if no item matched. -.SH "const_iterator QValueList::find ( const_iterator it, const T & x ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Finds the first occurrence of \fIx\fR in the list starting at the position given by \fIit\fR. -.PP -Returns end() if no item matched. -.SH "int QValueList::findIndex ( const T & x ) const" -Returns the index of the first occurrence of the value \fIx\fR. Returns -1 if no item matched. -.SH "T & QValueList::first ()" -Returns a reference to the first item. If the list contains no first item (i.e. isEmpty() returns TRUE), the return value is undefined. -.PP -See also last(). -.PP -Example: network/mail/smtp.cpp. -.SH "const T & QValueList::first () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "const_iterator QValueList::fromLast () const" -Returns an iterator to the last item in the list, or end() if there is no last item. -.PP -Use the end() function instead. For example: -.PP -.nf -.br - QValueList<int> l; -.br - ... -.br - QValueList<int>::iterator it = l.end(); -.br - --it; -.br - if ( it != end() ) -.br - // ... -.br -.fi -.SH "iterator QValueList::fromLast ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns an iterator to the last item in the list, or end() if there is no last item. -.PP -Use the end() function instead. For example: -.PP -.nf -.br - QValueList<int> l; -.br - ... -.br - QValueList<int>::iterator it = l.end(); -.br - --it; -.br - if ( it != end() ) -.br - // ... -.br -.fi -.SH "reference QValueList::front ()" -Returns a reference to the first item. If the list contains no first item (i.e. empty() returns TRUE), the return value is undefined. -.PP -This function is provided for STL compatibility. It is equivalent to first(). -.PP -See also back(). -.SH "const_reference QValueList::front () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "iterator QValueList::insert ( iterator it, const T & x )" -Inserts the value \fIx\fR in front of the item pointed to by the iterator, \fIit\fR. -.PP -Returns an iterator pointing at the inserted item. -.PP -See also append() and prepend(). -.PP -Example: themes/themes.cpp. -.SH "void QValueList::insert ( iterator pos, size_type n, const T & x )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIn\fR copies of \fIx\fR before position \fIpos\fR. -.SH "bool QValueList::isEmpty () const" -Returns TRUE if the list contains no items; otherwise returns FALSE. -.PP -See also count(). -.PP -Examples: -.)l fonts/simple-qfont-demo/viewer.cpp and network/mail/smtp.cpp. -.SH "T & QValueList::last ()" -Returns a reference to the last item. If the list contains no last item (i.e. empty() returns TRUE), the return value is undefined. -.SH "const T & QValueList::last () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "bool QValueList::operator!= ( const QValueList<T> & l ) const" -Compares both lists. -.PP -Returns TRUE if this list and \fIl\fR are unequal; otherwise returns FALSE. -.SH "QValueList<T> QValueList::operator+ ( const QValueList<T> & l ) const" -Creates a new list and fills it with the items of this list. Then the items of \fIl\fR are appended. Returns the new list. -.SH "QValueList<T> & QValueList::operator+= ( const QValueList<T> & l )" -Appends the items of \fIl\fR to this list. Returns a reference to this list. -.SH "QValueList<T> & QValueList::operator+= ( const T & x )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Appends the value \fIx\fR to the list. Returns a reference to the list. -.SH "QValueList<T> & QValueList::operator<< ( const T & x )" -Adds the value \fIx\fR to the end of the list. -.PP -Returns a reference to the list. -.SH "QValueList<T> & QValueList::operator= ( const QValueList<T> & l )" -Assigns \fIl\fR to this list and returns a reference to this list. -.PP -All iterators of the current list become invalidated by this operation. The cost of such an assignment is O(1) since QValueList is implicitly shared. -.SH "QValueList<T> & QValueList::operator= ( const std::list<T> & l )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assigns the contents of \fIl\fR to the list. -.PP -All iterators of the current list become invalidated by this operation. -.SH "bool QValueList::operator== ( const QValueList<T> & l ) const" -Compares both lists. -.PP -Returns TRUE if this list and \fIl\fR are equal; otherwise returns FALSE. -.SH "bool QValueList::operator== ( const std::list<T> & l ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if this list and \fIl\fR are equal; otherwise returns FALSE. -.PP -This operator is provided for compatibility with STL containers. -.SH "const T & QValueList::operator[] ( size_type i ) const" -Returns a const reference to the item with index \fIi\fR in the list. It is up to you to check whether this item really exists. You can do that easily with the count() function. However this operator does not check whether \fIi\fR is in range and will deliver undefined results if it does not exist. -.PP -\fBWarning:\fR This function uses a linear search and can be extremely slow for large lists. QValueList is not optimized for random item access. If you need random access use a different container, such as QValueVector. -.SH "T & QValueList::operator[] ( size_type i )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a non-const reference to the item with index \fIi\fR. -.SH "void QValueList::pop_back ()" -Removes the last item. If there is no last item, this operation is undefined. -.PP -This function is provided for STL compatibility. -.SH "void QValueList::pop_front ()" -Removes the first item. If there is no first item, this operation is undefined. -.PP -This function is provided for STL compatibility. -.SH "iterator QValueList::prepend ( const T & x )" -Inserts \fIx\fR at the beginning of the list. -.PP -See also insert() and append(). -.SH "void QValueList::push_back ( const T & x )" -Inserts \fIx\fR at the end of the list. -.PP -This function is provided for STL compatibility. It is equivalent to append(). -.SH "void QValueList::push_front ( const T & x )" -Inserts \fIx\fR at the beginning of the list. -.PP -This function is provided for STL compatibility. It is equivalent to prepend(). -.PP -Example: toplevel/options.ui.h. -.SH "iterator QValueList::remove ( iterator it )" -Removes the item pointed to by \fIit\fR from the list. No iterators other than \fIit\fR or other iterators pointing at the same item as \fIit\fR are invalidated. Returns an iterator to the next item after \fIit\fR, or end() if there is no such item. -.PP -See also clear(). -.SH "uint QValueList::remove ( const T & x )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes all items that have value \fIx\fR and returns the number of removed items. -.SH "size_type QValueList::size () const" -Returns the number of items in the list. -.PP -This function is provided for STL compatibility. It is equivalent to count(). -.PP -See also empty(). -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QValueList<T> & l )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Writes a list, \fIl\fR, to the stream \fIs\fR. The type T stored in the list must implement the streaming operator. -.SH "QDataStream & operator>> ( QDataStream & s, QValueList<T> & l )" -Reads a list, \fIl\fR, from the stream \fIs\fR. The type T stored in the -list must implement the streaming operator. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvaluelist.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvaluelist.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvaluelistconstiterator.3qt b/doc/man/man3/qvaluelistconstiterator.3qt deleted file mode 100644 index 434256abf..000000000 --- a/doc/man/man3/qvaluelistconstiterator.3qt +++ /dev/null @@ -1,127 +0,0 @@ -'\" t -.TH QValueListConstIterator 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 -QValueListConstIterator \- Const iterator for QValueList -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqvaluelist.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef T \fBvalue_type\fR" -.br -.ti -1c -.BI "typedef const T * \fBpointer\fR" -.br -.ti -1c -.BI "typedef const T & \fBreference\fR" -.br -.ti -1c -.BI "\fBQValueListConstIterator\fR ()" -.br -.ti -1c -.BI "\fBQValueListConstIterator\fR ( const QValueListConstIterator<T> & it )" -.br -.ti -1c -.BI "\fBQValueListConstIterator\fR ( const QValueListIterator<T> & it )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QValueListConstIterator<T> & it ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QValueListConstIterator<T> & it ) const" -.br -.ti -1c -.BI "const T & \fBoperator*\fR () const" -.br -.ti -1c -.BI "QValueListConstIterator<T> & \fBoperator++\fR ()" -.br -.ti -1c -.BI "QValueListConstIterator<T> \fBoperator++\fR ( int )" -.br -.ti -1c -.BI "QValueListConstIterator<T> & \fBoperator--\fR ()" -.br -.ti -1c -.BI "QValueListConstIterator<T> \fBoperator--\fR ( int )" -.br -.in -1c -.SH DESCRIPTION -The QValueListConstIterator class provides a const iterator for QValueList. -.PP -In contrast to QValueListIterator, this class is used to iterate over a const list. It does not allow modification of the values of the list since that would break const semantics. -.PP -You can create the appropriate const iterator type by using the \fCconst_iterator\fR typedef provided by QValueList. -.PP -For more information on QValueList iterators, see QValueListIterator. -.PP -See also QValueListIterator, QValueList, Qt Template Library Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QValueListConstIterator::pointer" -Pointer to value_type. -.SH "QValueListConstIterator::reference" -Reference to value_type. -.SH "QValueListConstIterator::value_type" -The type of value. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QValueListConstIterator::QValueListConstIterator ()" -Creates un uninitialized iterator. -.SH "QValueListConstIterator::QValueListConstIterator ( const QValueListConstIterator<T> & it )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a copy of the iterator \fIit\fR. -.SH "QValueListConstIterator::QValueListConstIterator ( const QValueListIterator<T> & it )" -Constructs a copy of the iterator \fIit\fR. -.SH "bool QValueListConstIterator::operator!= ( const QValueListConstIterator<T> & it ) const" -Compares this iterator with \fIit\fR and returns TRUE if they point to different items; otherwise returns FALSE. -.SH "const T & QValueListConstIterator::operator* () const" -Asterisk operator. Returns a reference to the current iterator item. -.SH "QValueListConstIterator<T> & QValueListConstIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. -.SH "QValueListConstIterator<T> QValueListConstIterator::operator++ ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. -.SH "QValueListConstIterator<T> & QValueListConstIterator::operator-- ()" -Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. -.SH "QValueListConstIterator<T> QValueListConstIterator::operator-- ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. -.SH "bool QValueListConstIterator::operator== ( const QValueListConstIterator<T> & it ) const" -Compares this iterator with \fIit\fR and returns TRUE if they point -to the same item; otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qvaluelistconstiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvaluelistconstiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvaluelistiterator.3qt b/doc/man/man3/qvaluelistiterator.3qt deleted file mode 100644 index 0459f7999..000000000 --- a/doc/man/man3/qvaluelistiterator.3qt +++ /dev/null @@ -1,172 +0,0 @@ -'\" t -.TH QValueListIterator 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 -QValueListIterator \- Iterator for QValueList -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqvaluelist.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef T \fBvalue_type\fR" -.br -.ti -1c -.BI "typedef T * \fBpointer\fR" -.br -.ti -1c -.BI "typedef T & \fBreference\fR" -.br -.ti -1c -.BI "\fBQValueListIterator\fR ()" -.br -.ti -1c -.BI "\fBQValueListIterator\fR ( const QValueListIterator<T> & it )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QValueListIterator<T> & it ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QValueListIterator<T> & it ) const" -.br -.ti -1c -.BI "const T & \fBoperator*\fR () const" -.br -.ti -1c -.BI "T & \fBoperator*\fR ()" -.br -.ti -1c -.BI "QValueListIterator<T> & \fBoperator++\fR ()" -.br -.ti -1c -.BI "QValueListIterator<T> \fBoperator++\fR ( int )" -.br -.ti -1c -.BI "QValueListIterator<T> & \fBoperator--\fR ()" -.br -.ti -1c -.BI "QValueListIterator<T> \fBoperator--\fR ( int )" -.br -.ti -1c -.BI "QValueListIterator<T> & \fBoperator+=\fR ( int j )" -.br -.ti -1c -.BI "QValueListIterator<T> & \fBoperator-=\fR ( int j )" -.br -.in -1c -.SH DESCRIPTION -The QValueListIterator class provides an iterator for QValueList. -.PP -An iterator is a class for accessing the items of a container class: a generalization of the index in an array. A pointer into a "const char *" and an index into an "int[]" are both iterators, and the general idea is to provide that functionality for any data structure. -.PP -The QValueListIterator class is an iterator for QValueList instantiations. You can create the appropriate iterator type by using the \fCiterator\fR typedef provided by QValueList. -.PP -The only way to access the items in a QValueList is to use an iterator. -.PP -Example (see QValueList for the complete code): -.PP -.nf -.br - EmployeeList::iterator it; -.br - for ( it = list.begin(); it != list.end(); ++it ) -.br - cout << (*it).surname().latin1() << ", " << -.br - (*it).forename().latin1() << " earns " << -.br - (*it).salary() << endl; -.br -.br - // Output: -.br - // Doe, John earns 50000 -.br - // Williams, Jane earns 80000 -.br - // Hawthorne, Mary earns 90000 -.br - // Jones, Tom earns 60000 -.br -.fi -.PP -QValueList is highly optimized for performance and memory usage. This means that you must be careful: QValueList does not know about all its iterators and the iterators don't know to which list they belong. This makes things very fast, but if you're not careful, you can get spectacular bugs. Always make sure iterators are valid before dereferencing them or using them as parameters to generic algorithms in the STL or the QTL. -.PP -Using an invalid iterator is undefined (your application will probably crash). Many Qt functions return const value lists; to iterate over these you should make a copy and iterate over the copy. -.PP -For every Iterator there is a ConstIterator. When accessing a QValueList in a const environment or if the reference or pointer to the list is itself const, then you must use the ConstIterator. Its semantics are the same as the Iterator, but it only returns const references. -.PP -See also QValueList, QValueListConstIterator, Qt Template Library Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QValueListIterator::pointer" -Pointer to value_type. -.SH "QValueListIterator::reference" -Reference to value_type. -.SH "QValueListIterator::value_type" -The type of value, T. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QValueListIterator::QValueListIterator ()" -Creates un uninitialized iterator. -.SH "QValueListIterator::QValueListIterator ( const QValueListIterator<T> & it )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Constructs a copy of the iterator \fIit\fR. -.SH "bool QValueListIterator::operator!= ( const QValueListIterator<T> & it ) const" -Compares this iterator and \fIit\fR and returns TRUE if they point to different items; otherwise returns FALSE. -.SH "T & QValueListIterator::operator* ()" -Asterisk operator. Returns a reference to the current iterator item. -.SH "const T & QValueListIterator::operator* () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Asterisk operator. Returns a reference to the current iterator item. -.SH "QValueListIterator<T> & QValueListIterator::operator++ ()" -Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. -.SH "QValueListIterator<T> QValueListIterator::operator++ ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. -.SH "QValueListIterator<T> & QValueListIterator::operator+= ( int j )" -Postfix -- jumps \fIj\fR steps forward in the list. The iterator cannot check whether it reached the end of the list. Jumping past the end() causes undefined results. -.SH "QValueListIterator<T> & QValueListIterator::operator-- ()" -Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. -.SH "QValueListIterator<T> QValueListIterator::operator-- ( int )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. -.SH "QValueListIterator<T> & QValueListIterator::operator-= ( int j )" -Postfix -- jumps \fIj\fR steps backward in the list. The iterator cannot check whether it reached the beginning of the list. Jumping past begin() causes undefined results. -.SH "bool QValueListIterator::operator== ( const QValueListIterator<T> & it ) const" -Compares this iterator and \fIit\fR and returns TRUE if they point to -the same item; otherwise returns FALSE. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qvaluelistiterator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvaluelistiterator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvaluestack.3qt b/doc/man/man3/qvaluestack.3qt deleted file mode 100644 index cda2a6072..000000000 --- a/doc/man/man3/qvaluestack.3qt +++ /dev/null @@ -1,141 +0,0 @@ -'\" t -.TH QValueStack 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 -QValueStack \- Value-based template class that provides a stack -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqvaluestack.h>\fR -.PP -Inherits QValueList<T>. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQValueStack\fR ()" -.br -.ti -1c -.BI "\fB~QValueStack\fR ()" -.br -.ti -1c -.BI "void \fBpush\fR ( const T & d )" -.br -.ti -1c -.BI "T \fBpop\fR ()" -.br -.ti -1c -.BI "T & \fBtop\fR ()" -.br -.ti -1c -.BI "const T & \fBtop\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QValueStack class is a value-based template class that provides a stack. -.PP -Define a template instance QValueStack<X> to create a stack of values that all have the class X. QValueStack is part of the Qt Template Library. -.PP -Note that QValueStack does not store pointers to the members of the stack; it holds a copy of every member. That is why these kinds of classes are called "value based"; QPtrStack, QPtrList, QDict, etc., are "pointer based". -.PP -A stack is a last in, first out (LIFO) structure. Items are added to the top of the stack with push() and retrieved from the top with pop(). The top() function provides access to the topmost item without removing it. -.PP -Example: -.PP -.nf -.br - QValueStack<int> stack; -.br - stack.push( 1 ); -.br - stack.push( 2 ); -.br - stack.push( 3 ); -.br - while ( ! stack.isEmpty() ) -.br - cout << "Item: " << stack.pop() << endl; -.br -.br - // Output: -.br - // Item: 3 -.br - // Item: 2 -.br - // Item: 1 -.br -.fi -.PP -QValueStack is a specialized QValueList provided for convenience. All of QValueList's functionality also applies to QPtrStack, for example the facility to iterate over all elements using QValueStack<T>::Iterator. See QValueListIterator for further details. -.PP -Some classes cannot be used within a QValueStack, for example everything derived from QObject and thus all classes that implement widgets. Only values can be used in a QValueStack. To qualify as a value, the class must provide -.TP -a copy constructor; -.TP -an assignment operator; -.TP -a default constructor, i.e. a constructor that does not take any arguments. -.PP -Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. -.PP -See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QValueStack::QValueStack ()" -Constructs an empty stack. -.SH "QValueStack::~QValueStack ()" -Destroys the stack. References to the values in the stack and all iterators of this stack become invalidated. Because QValueStack is highly tuned for performance, you won't see warnings if you use invalid iterators because it is impossible for an iterator to check whether or not it is valid. -.SH "T QValueStack::pop ()" -Removes the top item from the stack and returns it. -.PP -See also top() and push(). -.SH "void QValueStack::push ( const T & d )" -Adds element, \fId\fR, to the top of the stack. Last in, first out. -.PP -This function is equivalent to append(). -.PP -See also pop() and top(). -.SH "T & QValueStack::top ()" -Returns a reference to the top item of the stack or the item referenced by end() if no such item exists. Note that you must not change the value the end() iterator points to. -.PP -This function is equivalent to last(). -.PP -See also pop(), push(), and QValueList::fromLast(). -.SH "const T & QValueStack::top () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a reference to the top item of the stack or the item referenced by end() if no such item exists. -.PP -This function is equivalent to last(). -.PP -See also pop(), push(), and QValueList::fromLast(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvaluestack.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvaluestack.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvaluevector.3qt b/doc/man/man3/qvaluevector.3qt deleted file mode 100644 index 8999a4be2..000000000 --- a/doc/man/man3/qvaluevector.3qt +++ /dev/null @@ -1,635 +0,0 @@ -'\" t -.TH QValueVector 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 -QValueVector \- Value-based template class that provides a dynamic array -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqvaluevector.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "typedef T \fBvalue_type\fR" -.br -.ti -1c -.BI "typedef value_type * \fBpointer\fR" -.br -.ti -1c -.BI "typedef const value_type * \fBconst_pointer\fR" -.br -.ti -1c -.BI "typedef value_type * \fBiterator\fR" -.br -.ti -1c -.BI "typedef const value_type * \fBconst_iterator\fR" -.br -.ti -1c -.BI "typedef value_type & \fBreference\fR" -.br -.ti -1c -.BI "typedef const value_type & \fBconst_reference\fR" -.br -.ti -1c -.BI "typedef size_t \fBsize_type\fR" -.br -.ti -1c -.BI "typedef ptrdiff_t \fBdifference_type\fR" -.br -.ti -1c -.BI "\fBQValueVector\fR ()" -.br -.ti -1c -.BI "\fBQValueVector\fR ( const QValueVector<T> & v )" -.br -.ti -1c -.BI "\fBQValueVector\fR ( size_type n, const T & val = T ( ) )" -.br -.ti -1c -.BI "\fBQValueVector\fR ( std::vector<T> & v )" -.br -.ti -1c -.BI "\fBQValueVector\fR ( const std::vector<T> & v )" -.br -.ti -1c -.BI "\fB~QValueVector\fR ()" -.br -.ti -1c -.BI "QValueVector<T> & \fBoperator=\fR ( const QValueVector<T> & v )" -.br -.ti -1c -.BI "QValueVector<T> & \fBoperator=\fR ( const std::vector<T> & v )" -.br -.ti -1c -.BI "size_type \fBsize\fR () const" -.br -.ti -1c -.BI "bool \fBempty\fR () const" -.br -.ti -1c -.BI "size_type \fBcapacity\fR () const" -.br -.ti -1c -.BI "iterator \fBbegin\fR ()" -.br -.ti -1c -.BI "const_iterator \fBbegin\fR () const" -.br -.ti -1c -.BI "const_iterator \fBconstBegin\fR () const" -.br -.ti -1c -.BI "iterator \fBend\fR ()" -.br -.ti -1c -.BI "const_iterator \fBend\fR () const" -.br -.ti -1c -.BI "const_iterator \fBconstEnd\fR () const" -.br -.ti -1c -.BI "reference \fBat\fR ( size_type i, bool * ok = 0 )" -.br -.ti -1c -.BI "const_reference \fBat\fR ( size_type i, bool * ok = 0 ) const" -.br -.ti -1c -.BI "reference \fBoperator[]\fR ( size_type i )" -.br -.ti -1c -.BI "const_reference \fBoperator[]\fR ( size_type i ) const" -.br -.ti -1c -.BI "reference \fBfront\fR ()" -.br -.ti -1c -.BI "const_reference \fBfront\fR () const" -.br -.ti -1c -.BI "reference \fBback\fR ()" -.br -.ti -1c -.BI "const_reference \fBback\fR () const" -.br -.ti -1c -.BI "void \fBpush_back\fR ( const T & x )" -.br -.ti -1c -.BI "void \fBpop_back\fR ()" -.br -.ti -1c -.BI "iterator \fBinsert\fR ( iterator pos, const T & x )" -.br -.ti -1c -.BI "iterator \fBinsert\fR ( iterator pos, size_type n, const T & x )" -.br -.ti -1c -.BI "void \fBreserve\fR ( size_type n )" -.br -.ti -1c -.BI "void \fBresize\fR ( size_type n, const T & val = T ( ) )" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "iterator \fBerase\fR ( iterator pos )" -.br -.ti -1c -.BI "iterator \fBerase\fR ( iterator first, iterator last )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QValueVector<T> & x )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QValueVector<T> & x ) const" -.br -.ti -1c -.BI "typedef T \fBValueType\fR" -.br -.ti -1c -.BI "typedef ValueType * \fBIterator\fR" -.br -.ti -1c -.BI "typedef const ValueType * \fBConstIterator\fR" -.br -.ti -1c -.BI "size_type \fBcount\fR () const" -.br -.ti -1c -.BI "bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "reference \fBfirst\fR ()" -.br -.ti -1c -.BI "const_reference \fBfirst\fR () const" -.br -.ti -1c -.BI "reference \fBlast\fR ()" -.br -.ti -1c -.BI "const_reference \fBlast\fR () const" -.br -.ti -1c -.BI "void \fBappend\fR ( const T & x )" -.br -.in -1c -.SH DESCRIPTION -The QValueVector class is a value-based template class that provides a dynamic array. -.PP -QValueVector is a Qt implementation of an STL-like vector container. It can be used in your application if the standard \fCvector\fR is not available for your target platforms. QValueVector is part of the Qt Template Library. -.PP -QValueVector<T> defines a template instance to create a vector of values that all have the class T. QValueVector does not store pointers to the members of the vector; it holds a copy of every member. QValueVector is said to be value based; in contrast, QPtrList and QDict are pointer based. -.PP -QValueVector contains and manages a collection of objects of type T and provides random access iterators that allow the contained objects to be addressed. QValueVector owns the contained elements. For more relaxed ownership semantics, see QPtrCollection and friends, which are pointer-based containers. -.PP -QValueVector provides good performance if you append or remove elements from the end of the vector. If you insert or remove elements from anywhere but the end, performance is very bad. The reason for this is that elements must to be copied into new positions. -.PP -Some classes cannot be used within a QValueVector: for example, all classes derived from QObject and thus all classes that implement widgets. Only values can be used in a QValueVector. To qualify as a value the class must provide: -.TP -a copy constructor; -.TP -an assignment operator; -.TP -a default constructor, i.e., a constructor that does not take any arguments. -.PP -Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. -.PP -QValueVector uses an STL-like syntax to manipulate and address the objects it contains. See this document for more information. -.PP -Example: -.PP -.nf -.br - #include <ntqvaluevector.h> -.br - #include <ntqstring.h> -.br - #include <stdio.h> -.br -.br - class Employee -.br - { -.br - public: -.br - Employee(): s(0) {} -.br - Employee( const QString& name, int salary ) -.br - : n( name ), s( salary ) -.br - { } -.br -.br - QString name() const { return n; } -.br - int salary() const { return s; } -.br - void setSalary( int salary ) { s = salary; } -.br - private: -.br - QString n; -.br - int s; -.br - }; -.br -.br - int main() -.br - { -.br - typedef QValueVector<Employee> EmployeeVector; -.br - EmployeeVector vec( 3 ); // vector of 3 Employees -.br -.br - vec[0] = Employee( "Bill", 50000 ); -.br - vec[1] = Employee( "Steve", 80000 ); -.br - vec[2] = Employee( "Ron", 60000 ); -.br -.br - Employee joe( "Joe", 50000 ); -.br - vec.push_back( joe ); // vector expands to accommodate 4 Employees -.br - joe.setSalary( 70000 ); -.br -.br -.br - EmployeeVector::iterator it; -.br - for( it = vec.begin(); it != vec.end(); ++it ) -.br - printf( "%s earns %d\\n", (*it).name().latin1(), (*it).salary() ); -.br -.br - return 0; -.br - } -.br -.fi -.PP -Program output: -.PP -.nf -.br - Bill earns 50000 -.br - Steve earns 80000 -.br - Ron earns 60000 -.br - Joe earns 50000 -.br -.fi -.PP -As you can see, the most recent change to Joe's salary did not affect the value in the vector because the vector created a copy of Joe's entry. -.PP -Many Qt functions return const value vectors; to iterate over these you should make a copy and iterate over the copy. -.PP -There are several ways to find items in the vector. The begin() and end() functions return iterators to the beginning and end of the vector. The advantage of getting an iterator is that you can move forward or backward from this position by incrementing/decrementing the iterator. The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the vector it belongs to, however it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. If the vector is empty(), the iterator returned by begin() will equal the iterator returned by end(). -.PP -The fastest way to access an element of a vector is by using operator[]. This function provides random access and will return a reference to the element located at the specified index. Thus, you can access every element directly, in constant time, providing you know the location of the element. It is undefined to access an element that does not exist (your application will probably crash). For example: -.PP -.nf -.br - QValueVector<int> vec1; // an empty vector -.br - vec1[10] = 4; // WARNING: undefined, probably a crash -.br -.br - QValueVector<QString> vec2(25); // initialize with 25 elements -.br - vec2[10] = "Dave"; // OK -.br -.fi -.PP -Whenever inserting, removing or referencing elements in a vector, always make sure you are referring to valid positions. For example: -.PP -.nf -.br - void func( QValueVector<int>& vec ) -.br - { -.br - if ( vec.size() > 10 ) { -.br - vec[9] = 99; // OK -.br - } -.br - }; -.br -.fi -.PP -The iterators provided by vector are random access iterators, therefore you can use them with many generic algorithms, for example, algorithms provided by the STL or the QTL. -.PP -Another way to find an element in the vector is by using the std::find() or tqFind() algorithms. For example: -.PP -.nf -.br - QValueVector<int> vec; -.br - ... -.br - QValueVector<int>::const_iterator it = tqFind( vec.begin(), vec.end(), 3 ); -.br - if ( it != vector.end() ) -.br - // 'it' points to the found element -.br -.fi -.PP -It is safe to have multiple iterators on the vector at the same time. Since QValueVector manages memory dynamically, all iterators can become invalid if a memory reallocation occurs. For example, if some member of the vector is removed, iterators that point to the removed element and to all following elements become invalidated. Inserting into the middle of the vector will invalidate all iterators. For convenience, the function back() returns a reference to the last element in the vector, and front() returns a reference to the first element. If the vector is empty(), both back() and front() have undefined behavior (your application will crash or do unpredictable things). Use back() and front() with caution, for example: -.PP -.nf -.br - QValueVector<int> vec( 3 ); -.br - vec.push_back( 1 ); -.br - vec.push_back( 2 ); -.br - vec.push_back( 3 ); -.br - ... -.br - if ( !vec.empty() ) { -.br - // OK: modify the first element -.br - int& i = vec.front(); -.br - i = 18; -.br - } -.br - ... -.br - QValueVector<double> dvec; -.br - double d = dvec.back(); // undefined behavior -.br -.fi -.PP -Because QValueVector manages memory dynamically, it is recommended that you contruct a vector with an initial size. Inserting and removing elements happens fastest when: -.TP -Inserting or removing elements happens at the end() of the vector; -.TP -The vector does not need to allocate additional memory. -.PP -By creating a QValueVector with a sufficiently large initial size, there will be less memory allocations. Do not use an initial size that is too big, since it will still take time to construct all the empty entries, and the extra space will be wasted if it is never used. -.PP -Because QValueVector is value-based there is no need to be careful about deleting elements in the vector. The vector holds its own copies and will free them if the corresponding member or the vector itself is deleted. You can force the vector to free all of its items with clear(). -.PP -QValueVector is shared implicitly, which means it can be copied in constant time. If multiple QValueVector instances share the same data and one needs to modify its contents, this modifying instance makes a copy and modifies its private copy; it thus does not affect the other instances. This is often called "copy on write". If a QValueVector is being used in a multi-threaded program, you must protect all access to the vector. See QMutex. -.PP -There are several ways to insert elements into the vector. The push_back() function insert elements into the end of the vector, and is usually fastest. The insert() function can be used to add elements at specific positions within the vector. -.PP -Items can be also be removed from the vector in several ways. There are several variants of the erase() function which removes a specific element, or range of elements, from the vector. -.PP -Vectors can be also sorted with various STL algorithms , or it can be sorted using the Qt Template Library. For example with qHeapSort(): -.PP -Example: -.PP -.nf -.br - QValueVector<int> v( 4 ); -.br - v.push_back( 5 ); -.br - v.push_back( 8 ); -.br - v.push_back( 3 ); -.br - v.push_back( 4 ); -.br - qHeapSort( v ); -.br -.fi -.PP -QValueVector stores its elements in contiguous memory. This means that you can use a QValueVector in any situation that requires an array. -.PP -See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. -.SS "Member Type Documentation" -.SH "QValueVector::ConstIterator" -The vector's const iterator type. -.SH "QValueVector::Iterator" -The vector's iterator type. -.SH "QValueVector::ValueType" -The type of the object stored in the vector. -.SH "QValueVector::const_iterator" -The vector's const iterator type. -.SH "QValueVector::const_pointer" -The const pointer to T type. -.SH "QValueVector::const_reference" -The const reference to T type. -.SH "QValueVector::difference_type" -A signed integral type used to represent the distance between two iterators. -.SH "QValueVector::iterator" -The vector's iterator type. -.SH "QValueVector::pointer" -The pointer to T type. -.SH "QValueVector::reference" -The reference to T type. -.SH "QValueVector::size_type" -An unsigned integral type, used to represent various sizes. -.SH "QValueVector::value_type" -The type of the object stored in the vector. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QValueVector::QValueVector ()" -Constructs an empty vector without any elements. To create a vector which reserves an initial amount of space for elements, use \fCQValueVector(size_type n)\fR. -.SH "QValueVector::QValueVector ( const QValueVector<T> & v )" -Constructs a copy of \fIv\fR. -.PP -This operation costs O(1) time because QValueVector is implicitly shared. -.PP -The first modification to the vector does takes O(n) time, because the elements must be copied. -.SH "QValueVector::QValueVector ( size_type n, const T & val = T ( ) )" -Constructs a vector with an initial size of \fIn\fR elements. Each element is initialized with the value of \fIval\fR. -.SH "QValueVector::QValueVector ( std::vector<T> & v )" -Constructs a copy of \fIv\fR. -.SH "QValueVector::QValueVector ( const std::vector<T> & v )" -This operation costs O(n) time because \fIv\fR is copied. -.SH "QValueVector::~QValueVector ()" -Destroys the vector, destroying all elements and freeing the allocated memory. References to the values in the vector and all iterators of this vector become invalidated. Note that it is impossible for an iterator to check whether or not it is valid: QValueVector is tuned for performance, not for error checking. -.SH "void QValueVector::append ( const T & x )" -Appends a copy of \fIx\fR to the end of the vector. -.PP -See also push_back() and insert(). -.SH "reference QValueVector::at ( size_type i, bool * ok = 0 )" -Returns a reference to the element with index \fIi\fR. If \fIok\fR is non-null, and the index \fIi\fR is out of range, *\fIok\fR is set to FALSE and the returned reference is undefined. If the index \fIi\fR is within the range of the vector, and \fIok\fR is non-null, *\fIok\fR is set to TRUE and the returned reference is well defined. -.SH "const_reference QValueVector::at ( size_type i, bool * ok = 0 ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const reference to the element with index \fIi\fR. If \fIok\fR is non-null, and the index \fIi\fR is out of range, *\fIok\fR is set to FALSE and the returned reference is undefined. If the index \fIi\fR is within the range of the vector, and \fIok\fR is non-null, *\fIok\fR is set to TRUE and the returned reference is well defined. -.SH "reference QValueVector::back ()" -Returns a reference to the last element in the vector. If there is no last element, this function has undefined behavior. -.PP -See also empty() and front(). -.SH "const_reference QValueVector::back () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const reference to the last element in the vector. If there is no last element, this function has undefined behavior. -.PP -See also empty() and front(). -.SH "iterator QValueVector::begin ()" -Returns an iterator pointing to the beginning of the vector. If the vector is empty(), the returned iterator will equal end(). -.SH "const_iterator QValueVector::begin () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const iterator pointing to the beginning of the vector. If the vector is empty(), the returned iterator will equal end(). -.SH "size_type QValueVector::capacity () const" -Returns the maximum number of elements that can be stored in the vector without forcing memory reallocation. If memory reallocation takes place, some or all iterators may become invalidated. -.SH "void QValueVector::clear ()" -Removes all the elements from the vector. -.SH "const_iterator QValueVector::constBegin () const" -Returns a const iterator pointing to the beginning of the vector. If the vector is empty(), the returned iterator will equal end(). -.PP -See also constEnd(). -.SH "const_iterator QValueVector::constEnd () const" -Returns a const iterator pointing behind the last element of the vector. -.PP -See also constBegin(). -.SH "size_type QValueVector::count () const" -Returns the number of items in the vector. -.PP -See also isEmpty(). -.SH "bool QValueVector::empty () const" -Returns TRUE if the vector is empty; otherwise returns FALSE. Equivalent to size()==0, only faster. -.PP -This function is provided for STL compatibility. It is equivalent to isEmpty(). -.PP -See also size(). -.SH "iterator QValueVector::end ()" -Returns an iterator pointing behind the last element of the vector. -.SH "const_iterator QValueVector::end () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const iterator pointing behind the last element of the vector. -.SH "iterator QValueVector::erase ( iterator pos )" -Removes the element at position \fIpos\fR and returns the position of the next element. -.SH "iterator QValueVector::erase ( iterator first, iterator last )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Removes all elements from \fIfirst\fR up to but not including \fIlast\fR and returns the position of the next element. -.SH "reference QValueVector::first ()" -Returns a reference to the first item in the vector. If there is no first item, this function has undefined behavior. -.PP -See also empty() and last(). -.SH "const_reference QValueVector::first () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "reference QValueVector::front ()" -Returns a reference to the first element in the vector. If there is no first element, this function has undefined behavior. -.PP -See also empty() and back(). -.SH "const_reference QValueVector::front () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const reference to the first element in the vector. If there is no first element, this function has undefined behavior. -.PP -See also empty() and back(). -.SH "iterator QValueVector::insert ( iterator pos, const T & x )" -Inserts a copy of \fIx\fR at the position immediately before \fIpos\fR. -.PP -See also push_back(). -.SH "iterator QValueVector::insert ( iterator pos, size_type n, const T & x )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Inserts \fIn\fR copies of \fIx\fR immediately before position x. -.PP -See also push_back(). -.SH "bool QValueVector::isEmpty () const" -Returns TRUE if the vector is empty; returns FALSE otherwise. -.PP -See also count(). -.SH "reference QValueVector::last ()" -Returns a reference to the last item in the vector. If there is no last item, this function has undefined behavior. -.PP -See also empty() and first(). -.SH "const_reference QValueVector::last () const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "QValueVector<T> & QValueVector::operator= ( const QValueVector<T> & v )" -Assigns \fIv\fR to this vector and returns a reference to this vector. -.PP -All iterators of the current vector become invalidated by this operation. The cost of such an assignment is O(1) since QValueVector is implicitly shared. -.SH "QValueVector<T> & QValueVector::operator= ( const std::vector<T> & v )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Assigns \fIv\fR to this vector and returns a reference to this vector. -.PP -All iterators of the current vector become invalidated by this operation. The cost of this assignment is O(n) since \fIv\fR is copied. -.SH "bool QValueVector::operator== ( const QValueVector<T> & x ) const" -Returns TRUE if each element in this vector equals each corresponding element in \fIx\fR; otherwise returns FALSE. -.SH "bool QValueVector::operator== ( const QValueVector<T> & x )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns TRUE if each element in this vector equals each corresponding element in \fIx\fR; otherwise returns FALSE. -.SH "reference QValueVector::operator[] ( size_type i )" -Returns a reference to the element at index \fIi\fR. If \fIi\fR is out of range, this function has undefined behavior. -.PP -See also at(). -.SH "const_reference QValueVector::operator[] ( size_type i ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a const reference to the element at index \fIi\fR. If \fIi\fR is out of range, this function has undefined behavior. -.PP -See also at(). -.SH "void QValueVector::pop_back ()" -Removes the last item from the vector. -.PP -This function is provided for STL compatibility. -.SH "void QValueVector::push_back ( const T & x )" -Appends a copy of \fIx\fR to the end of the vector. This is the fastest way to add new elements. -.PP -This function is provided for STL compatibility. It is equivalent to append(). -.PP -See also insert(). -.SH "void QValueVector::reserve ( size_type n )" -Increases the vector's capacity. If \fIn\fR is less than or equal to capacity(), nothing happens. Otherwise, additional memory is allocated so that capacity() will be increased to a value greater than or equal to \fIn\fR. All iterators will then become invalidated. Note that the vector's size() and the values of existing elements remain unchanged. -.SH "void QValueVector::resize ( size_type n, const T & val = T ( ) )" -Changes the size of the vector to \fIn\fR. If \fIn\fR is greater than the current size(), elements are added to the end and initialized with the value of \fIval\fR. If \fIn\fR is less than size(), elements are removed from the end. If \fIn\fR is equal to size() nothing happens. -.SH "size_type QValueVector::size () const" -Returns the number of elements in the vector. -.PP -This function is provided for STL compatibility. It is equivalent to count(). -.PP -See also empty(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvaluevector.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvaluevector.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvariant.3qt b/doc/man/man3/qvariant.3qt deleted file mode 100644 index 99bd38a83..000000000 --- a/doc/man/man3/qvariant.3qt +++ /dev/null @@ -1,1155 +0,0 @@ -'\" t -.TH QVariant 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 -QVariant \- Acts like a union for the most common Qt data types -.SH SYNOPSIS -\fC#include <ntqvariant.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBType\fR { Invalid, Map, List, String, StringList, Font, Pixmap, Brush, Rect, Size, Color, Palette, ColorGroup, IconSet, Point, Image, Int, UInt, Bool, Double, CString, PointArray, Region, Bitmap, Cursor, SizePolicy, Date, Time, DateTime, ByteArray, BitArray, KeySequence, Pen, LongLong, ULongLong }" -.br -.ti -1c -.BI "\fBQVariant\fR ()" -.br -.ti -1c -.BI "\fB~QVariant\fR ()" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QVariant & p )" -.br -.ti -1c -.BI "\fBQVariant\fR ( QDataStream & s )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QString & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QCString & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const char * val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QStringList & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QFont & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QPixmap & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QImage & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QBrush & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QPoint & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QRect & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QSize & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QColor & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QPalette & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QColorGroup & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QIconSet & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QPointArray & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QRegion & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QBitmap & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QCursor & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QDate & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QTime & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QDateTime & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QByteArray & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QBitArray & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QKeySequence & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QPen & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QValueList<QVariant> & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( const QMap<QString, QVariant> & val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( int val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( uint val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( TQ_LLONG val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( TQ_ULLONG val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( bool val, int )" -.br -.ti -1c -.BI "\fBQVariant\fR ( double val )" -.br -.ti -1c -.BI "\fBQVariant\fR ( QSizePolicy val )" -.br -.ti -1c -.BI "QVariant & \fBoperator=\fR ( const QVariant & variant )" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QVariant & v ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QVariant & v ) const" -.br -.ti -1c -.BI "Type \fBtype\fR () const" -.br -.ti -1c -.BI "const char * \fBtypeName\fR () const" -.br -.ti -1c -.BI "bool \fBcanCast\fR ( Type t ) const" -.br -.ti -1c -.BI "bool \fBcast\fR ( Type t )" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "const QString \fBtoString\fR () const" -.br -.ti -1c -.BI "const QCString \fBtoCString\fR () const" -.br -.ti -1c -.BI "const QStringList \fBtoStringList\fR () const" -.br -.ti -1c -.BI "const QFont \fBtoFont\fR () const" -.br -.ti -1c -.BI "const QPixmap \fBtoPixmap\fR () const" -.br -.ti -1c -.BI "const QImage \fBtoImage\fR () const" -.br -.ti -1c -.BI "const QBrush \fBtoBrush\fR () const" -.br -.ti -1c -.BI "const QPoint \fBtoPoint\fR () const" -.br -.ti -1c -.BI "const QRect \fBtoRect\fR () const" -.br -.ti -1c -.BI "const QSize \fBtoSize\fR () const" -.br -.ti -1c -.BI "const QColor \fBtoColor\fR () const" -.br -.ti -1c -.BI "const QPalette \fBtoPalette\fR () const" -.br -.ti -1c -.BI "const QColorGroup \fBtoColorGroup\fR () const" -.br -.ti -1c -.BI "const QIconSet \fBtoIconSet\fR () const" -.br -.ti -1c -.BI "const QPointArray \fBtoPointArray\fR () const" -.br -.ti -1c -.BI "const QBitmap \fBtoBitmap\fR () const" -.br -.ti -1c -.BI "const QRegion \fBtoRegion\fR () const" -.br -.ti -1c -.BI "const QCursor \fBtoCursor\fR () const" -.br -.ti -1c -.BI "const QDate \fBtoDate\fR () const" -.br -.ti -1c -.BI "const QTime \fBtoTime\fR () const" -.br -.ti -1c -.BI "const QDateTime \fBtoDateTime\fR () const" -.br -.ti -1c -.BI "const QByteArray \fBtoByteArray\fR () const" -.br -.ti -1c -.BI "const QBitArray \fBtoBitArray\fR () const" -.br -.ti -1c -.BI "const QKeySequence \fBtoKeySequence\fR () const" -.br -.ti -1c -.BI "const QPen \fBtoPen\fR () const" -.br -.ti -1c -.BI "int \fBtoInt\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "uint \fBtoUInt\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "TQ_LLONG \fBtoLongLong\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "TQ_ULLONG \fBtoULongLong\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "bool \fBtoBool\fR () const" -.br -.ti -1c -.BI "double \fBtoDouble\fR ( bool * ok = 0 ) const" -.br -.ti -1c -.BI "const QValueList<QVariant> \fBtoList\fR () const" -.br -.ti -1c -.BI "const QMap<QString, QVariant> \fBtoMap\fR () const" -.br -.ti -1c -.BI "QSizePolicy \fBtoSizePolicy\fR () const" -.br -.ti -1c -.BI "QValueListConstIterator<QString> stringListBegin () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QValueListConstIterator<QString> stringListEnd () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QValueListConstIterator<QVariant> listBegin () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QValueListConstIterator<QVariant> listEnd () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QMapConstIterator<QString, QVariant> mapBegin () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QMapConstIterator<QString, QVariant> mapEnd () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QMapConstIterator<QString, QVariant> mapFind ( const QString & key ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QString & \fBasString\fR ()" -.br -.ti -1c -.BI "QCString & \fBasCString\fR ()" -.br -.ti -1c -.BI "QStringList & \fBasStringList\fR ()" -.br -.ti -1c -.BI "QFont & \fBasFont\fR ()" -.br -.ti -1c -.BI "QPixmap & \fBasPixmap\fR ()" -.br -.ti -1c -.BI "QImage & \fBasImage\fR ()" -.br -.ti -1c -.BI "QBrush & \fBasBrush\fR ()" -.br -.ti -1c -.BI "QPoint & \fBasPoint\fR ()" -.br -.ti -1c -.BI "QRect & \fBasRect\fR ()" -.br -.ti -1c -.BI "QSize & \fBasSize\fR ()" -.br -.ti -1c -.BI "QColor & \fBasColor\fR ()" -.br -.ti -1c -.BI "QPalette & \fBasPalette\fR ()" -.br -.ti -1c -.BI "QColorGroup & \fBasColorGroup\fR ()" -.br -.ti -1c -.BI "QIconSet & \fBasIconSet\fR ()" -.br -.ti -1c -.BI "QPointArray & \fBasPointArray\fR ()" -.br -.ti -1c -.BI "QBitmap & \fBasBitmap\fR ()" -.br -.ti -1c -.BI "QRegion & \fBasRegion\fR ()" -.br -.ti -1c -.BI "QCursor & \fBasCursor\fR ()" -.br -.ti -1c -.BI "QDate & \fBasDate\fR ()" -.br -.ti -1c -.BI "QTime & \fBasTime\fR ()" -.br -.ti -1c -.BI "QDateTime & \fBasDateTime\fR ()" -.br -.ti -1c -.BI "QByteArray & \fBasByteArray\fR ()" -.br -.ti -1c -.BI "QBitArray & \fBasBitArray\fR ()" -.br -.ti -1c -.BI "QKeySequence & \fBasKeySequence\fR ()" -.br -.ti -1c -.BI "QPen & \fBasPen\fR ()" -.br -.ti -1c -.BI "int & \fBasInt\fR ()" -.br -.ti -1c -.BI "uint & \fBasUInt\fR ()" -.br -.ti -1c -.BI "TQ_LLONG & \fBasLongLong\fR ()" -.br -.ti -1c -.BI "TQ_ULLONG & \fBasULongLong\fR ()" -.br -.ti -1c -.BI "bool & \fBasBool\fR ()" -.br -.ti -1c -.BI "double & \fBasDouble\fR ()" -.br -.ti -1c -.BI "QValueList<QVariant> & \fBasList\fR ()" -.br -.ti -1c -.BI "QMap<QString, QVariant> & \fBasMap\fR ()" -.br -.ti -1c -.BI "QSizePolicy & \fBasSizePolicy\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "const char * \fBtypeToName\fR ( Type typ )" -.br -.ti -1c -.BI "Type \fBnameToType\fR ( const char * name )" -.br -.in -1c -.SH DESCRIPTION -The QVariant class acts like a union for the most common Qt data types. -.PP -Because C++ forbids unions from including types that have non-default constructors or destructors, most interesting Qt classes cannot be used in unions. Without QVariant, this would be a problem for QObject::property() and for database work, etc. -.PP -A QVariant object holds a single value of a single type() at a time. (Some type()s are multi-valued, for example a string list.) You can find out what type, T, the variant holds, convert it to a different type using one of the asT() functions, e.g. asSize(), get its value using one of the toT() functions, e.g. toSize(), and check whether the type can be converted to a particular type using canCast(). -.PP -The methods named toT() (for any supported T, see the Type documentation for a list) are const. If you ask for the stored type, they return a copy of the stored object. If you ask for a type that can be generated from the stored type, toT() copies and converts and leaves the object itself unchanged. If you ask for a type that cannot be generated from the stored type, the result depends on the type (see the function documentation for details). -.PP -Note that three data types supported by QVariant are explicitly shared, namely QImage, QPointArray, and QCString, and in these cases the toT() methods return a shallow copy. In almost all cases you must make a deep copy of the returned values before modifying them. -.PP -The asT() functions are not const. They do conversion like the toT() methods, set the variant to hold the converted value, and return a reference to the new contents of the variant. -.PP -Here is some example code to demonstrate the use of QVariant: -.PP -.nf -.br - QDataStream out(...); -.br - QVariant v(123); // The variant now contains an int -.br - int x = v.toInt(); // x = 123 -.br - out << v; // Writes a type tag and an int to out -.br - v = QVariant("hello"); // The variant now contains a QCString -.br - v = QVariant(tr("hello"));// The variant now contains a QString -.br - int y = v.toInt(); // y = 0 since v cannot be converted to an int -.br - QString s = v.toString(); // s = tr("hello") (see QObject::tr()) -.br - out << v; // Writes a type tag and a QString to out -.br - ... -.br - QDataStream in(...); // (opening the previously written stream) -.br - in >> v; // Reads an Int variant -.br - int z = v.toInt(); // z = 123 -.br - tqDebug("Type is %s", // prints "Type is int" -.br - v.typeName()); -.br - v.asInt() += 100; // The variant now hold the value 223. -.br - v = QVariant( QStringList() ); -.br - v.asStringList().append( "Hello" ); -.br -.fi -.PP -You can even store QValueList<QVariant>s and QMap<QString,QVariant>s in a variant, so you can easily construct arbitrarily complex data structures of arbitrary types. This is very powerful and versatile, but may prove less memory and speed efficient than storing specific types in standard data structures. -.PP -QVariant also supports the notion of NULL values, where you have a defined type with no value set. -.PP -.nf -.br - QVariant x, y( QString() ), z( QString("") ); -.br - x.asInt(); -.br - // x.isNull() == TRUE, y.isNull() == TRUE, z.isNull() == FALSE -.br -.fi -.PP -See the Collection Classes. -.PP -See also Miscellaneous Classes and Object Model. -.SS "Member Type Documentation" -.SH "QVariant::Type" -This enum type defines the types of variable that a QVariant can contain. -.TP -\fCQVariant::Invalid\fR - no type -.TP -\fCQVariant::BitArray\fR - a QBitArray -.TP -\fCQVariant::ByteArray\fR - a QByteArray -.TP -\fCQVariant::Bitmap\fR - a QBitmap -.TP -\fCQVariant::Bool\fR - a bool -.TP -\fCQVariant::Brush\fR - a QBrush -.TP -\fCQVariant::Color\fR - a QColor -.TP -\fCQVariant::ColorGroup\fR - a QColorGroup -.TP -\fCQVariant::Cursor\fR - a QCursor -.TP -\fCQVariant::Date\fR - a QDate -.TP -\fCQVariant::DateTime\fR - a QDateTime -.TP -\fCQVariant::Double\fR - a double -.TP -\fCQVariant::Font\fR - a QFont -.TP -\fCQVariant::IconSet\fR - a QIconSet -.TP -\fCQVariant::Image\fR - a QImage -.TP -\fCQVariant::Int\fR - an int -.TP -\fCQVariant::KeySequence\fR - a QKeySequence -.TP -\fCQVariant::List\fR - a QValueList<QVariant> -.TP -\fCQVariant::LongLong\fR - a long long -.TP -\fCQVariant::ULongLong\fR - an unsigned long long -.TP -\fCQVariant::Map\fR - a QMap<QString,QVariant> -.TP -\fCQVariant::Palette\fR - a QPalette -.TP -\fCQVariant::Pen\fR - a QPen -.TP -\fCQVariant::Pixmap\fR - a QPixmap -.TP -\fCQVariant::Point\fR - a QPoint -.TP -\fCQVariant::PointArray\fR - a QPointArray -.TP -\fCQVariant::Rect\fR - a QRect -.TP -\fCQVariant::Region\fR - a QRegion -.TP -\fCQVariant::Size\fR - a QSize -.TP -\fCQVariant::SizePolicy\fR - a QSizePolicy -.TP -\fCQVariant::String\fR - a QString -.TP -\fCQVariant::CString\fR - a QCString -.TP -\fCQVariant::StringList\fR - a QStringList -.TP -\fCQVariant::Time\fR - a QTime -.TP -\fCQVariant::UInt\fR - an unsigned int -.PP -Note that Qt's definition of bool depends on the compiler. ntqglobal.h has the system-dependent definition of bool. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QVariant::QVariant ()" -Constructs an invalid variant. -.SH "QVariant::QVariant ( bool val, int )" -Constructs a new variant with a boolean value, \fIval\fR. The integer argument is a dummy, necessary for compatibility with some compilers. -.SH "QVariant::QVariant ( double val )" -Constructs a new variant with a floating point value, \fIval\fR. -.SH "QVariant::QVariant ( QSizePolicy val )" -Constructs a new variant with a size policy value, \fIval\fR. -.SH "QVariant::QVariant ( const QVariant & p )" -Constructs a copy of the variant, \fIp\fR, passed as the argument to this constructor. Usually this is a deep copy, but a shallow copy is made if the stored data type is explicitly shared, as e.g. QImage is. -.SH "QVariant::QVariant ( QDataStream & s )" -Reads the variant from the data stream, \fIs\fR. -.SH "QVariant::QVariant ( const QString & val )" -Constructs a new variant with a string value, \fIval\fR. -.SH "QVariant::QVariant ( const QCString & val )" -Constructs a new variant with a C-string value, \fIval\fR. -.PP -If you want to modify the QCString after you've passed it to this constructor, we recommend passing a deep copy (see QCString::copy()). -.SH "QVariant::QVariant ( const char * val )" -Constructs a new variant with a C-string value of \fIval\fR if \fIval\fR is non-null. The variant creates a deep copy of \fIval\fR. -.PP -If \fIval\fR is null, the resulting variant has type Invalid. -.SH "QVariant::QVariant ( const QStringList & val )" -Constructs a new variant with a string list value, \fIval\fR. -.SH "QVariant::QVariant ( const QFont & val )" -Constructs a new variant with a font value, \fIval\fR. -.SH "QVariant::QVariant ( const QPixmap & val )" -Constructs a new variant with a pixmap value, \fIval\fR. -.SH "QVariant::QVariant ( const QImage & val )" -Constructs a new variant with an image value, \fIval\fR. -.PP -Because QImage is explicitly shared, you may need to pass a deep copy to the variant using QImage::copy(), e.g. if you intend changing the image you've passed later on. -.SH "QVariant::QVariant ( const QBrush & val )" -Constructs a new variant with a brush value, \fIval\fR. -.SH "QVariant::QVariant ( const QPoint & val )" -Constructs a new variant with a point value, \fIval\fR. -.SH "QVariant::QVariant ( const QRect & val )" -Constructs a new variant with a rect value, \fIval\fR. -.SH "QVariant::QVariant ( const QSize & val )" -Constructs a new variant with a size value, \fIval\fR. -.SH "QVariant::QVariant ( const QColor & val )" -Constructs a new variant with a color value, \fIval\fR. -.SH "QVariant::QVariant ( const QPalette & val )" -Constructs a new variant with a color palette value, \fIval\fR. -.SH "QVariant::QVariant ( const QColorGroup & val )" -Constructs a new variant with a color group value, \fIval\fR. -.SH "QVariant::QVariant ( const QIconSet & val )" -Constructs a new variant with an icon set value, \fIval\fR. -.SH "QVariant::QVariant ( const QPointArray & val )" -Constructs a new variant with a point array value, \fIval\fR. -.PP -Because QPointArray is explicitly shared, you may need to pass a deep copy to the variant using QPointArray::copy(), e.g. if you intend changing the point array you've passed later on. -.SH "QVariant::QVariant ( const QRegion & val )" -Constructs a new variant with a region value, \fIval\fR. -.SH "QVariant::QVariant ( const QBitmap & val )" -Constructs a new variant with a bitmap value, \fIval\fR. -.SH "QVariant::QVariant ( const QCursor & val )" -Constructs a new variant with a cursor value, \fIval\fR. -.SH "QVariant::QVariant ( const QDate & val )" -Constructs a new variant with a date value, \fIval\fR. -.SH "QVariant::QVariant ( const QTime & val )" -Constructs a new variant with a time value, \fIval\fR. -.SH "QVariant::QVariant ( const QDateTime & val )" -Constructs a new variant with a date/time value, \fIval\fR. -.SH "QVariant::QVariant ( const QByteArray & val )" -Constructs a new variant with a bytearray value, \fIval\fR. -.SH "QVariant::QVariant ( const QBitArray & val )" -Constructs a new variant with a bitarray value, \fIval\fR. -.SH "QVariant::QVariant ( const QKeySequence & val )" -Constructs a new variant with a key sequence value, \fIval\fR. -.SH "QVariant::QVariant ( const QPen & val )" -Constructs a new variant with a pen value, \fIval\fR. -.SH "QVariant::QVariant ( const QValueList<QVariant> & val )" -Constructs a new variant with a list value, \fIval\fR. -.SH "QVariant::QVariant ( const QMap<QString, QVariant> & val )" -Constructs a new variant with a map of QVariants, \fIval\fR. -.SH "QVariant::QVariant ( int val )" -Constructs a new variant with an integer value, \fIval\fR. -.SH "QVariant::QVariant ( uint val )" -Constructs a new variant with an unsigned integer value, \fIval\fR. -.SH "QVariant::QVariant ( TQ_LLONG val )" -Constructs a new variant with a long long integer value, \fIval\fR. -.SH "QVariant::QVariant ( TQ_ULLONG val )" -Constructs a new variant with an unsigned long long integer value, \fIval\fR. -.SH "QVariant::~QVariant ()" -Destroys the QVariant and the contained object. -.PP -Note that subclasses that reimplement clear() should reimplement the destructor to call clear(). This destructor calls clear(), but because it is the destructor, QVariant::clear() is called rather than a subclass's clear(). -.SH "QBitArray & QVariant::asBitArray ()" -Tries to convert the variant to hold a QBitArray value. If that is not possible then the variant is set to an empty bitarray. -.PP -Returns a reference to the stored bitarray. -.PP -See also toBitArray(). -.SH "QBitmap & QVariant::asBitmap ()" -Tries to convert the variant to hold a bitmap value. If that is not possible the variant is set to a null bitmap. -.PP -Returns a reference to the stored bitmap. -.PP -See also toBitmap(). -.SH "bool & QVariant::asBool ()" -Returns the variant's value as bool reference. -.SH "QBrush & QVariant::asBrush ()" -Tries to convert the variant to hold a brush value. If that is not possible the variant is set to a default black brush. -.PP -Returns a reference to the stored brush. -.PP -See also toBrush(). -.SH "QByteArray & QVariant::asByteArray ()" -Tries to convert the variant to hold a QByteArray value. If that is not possible then the variant is set to an empty bytearray. -.PP -Returns a reference to the stored bytearray. -.PP -See also toByteArray(). -.SH "QCString & QVariant::asCString ()" -Tries to convert the variant to hold a string value. If that is not possible the variant is set to an empty string. -.PP -Returns a reference to the stored string. -.PP -See also toCString(). -.SH "QColor & QVariant::asColor ()" -Tries to convert the variant to hold a QColor value. If that is not possible the variant is set to an invalid color. -.PP -Returns a reference to the stored color. -.PP -See also toColor() and QColor::isValid(). -.SH "QColorGroup & QVariant::asColorGroup ()" -Tries to convert the variant to hold a QColorGroup value. If that is not possible the variant is set to a color group of all black colors. -.PP -Returns a reference to the stored color group. -.PP -See also toColorGroup(). -.SH "QCursor & QVariant::asCursor ()" -Tries to convert the variant to hold a QCursor value. If that is not possible the variant is set to a default arrow cursor. -.PP -Returns a reference to the stored cursor. -.PP -See also toCursor(). -.SH "QDate & QVariant::asDate ()" -Tries to convert the variant to hold a QDate value. If that is not possible then the variant is set to an invalid date. -.PP -Returns a reference to the stored date. -.PP -See also toDate(). -.SH "QDateTime & QVariant::asDateTime ()" -Tries to convert the variant to hold a QDateTime value. If that is not possible then the variant is set to an invalid date/time. -.PP -Returns a reference to the stored date/time. -.PP -See also toDateTime(). -.SH "double & QVariant::asDouble ()" -Returns the variant's value as double reference. -.SH "QFont & QVariant::asFont ()" -Tries to convert the variant to hold a QFont. If that is not possible the variant is set to the application's default font. -.PP -Returns a reference to the stored font. -.PP -See also toFont(). -.SH "QIconSet & QVariant::asIconSet ()" -Tries to convert the variant to hold a QIconSet value. If that is not possible the variant is set to an empty iconset. -.PP -Returns a reference to the stored iconset. -.PP -See also toIconSet(). -.SH "QImage & QVariant::asImage ()" -Tries to convert the variant to hold an image value. If that is not possible the variant is set to a null image. -.PP -Returns a reference to the stored image. -.PP -See also toImage(). -.SH "int & QVariant::asInt ()" -Returns the variant's value as int reference. -.SH "QKeySequence & QVariant::asKeySequence ()" -Tries to convert the variant to hold a QKeySequence value. If that is not possible then the variant is set to an empty key sequence. -.PP -Returns a reference to the stored key sequence. -.PP -See also toKeySequence(). -.SH "QValueList<QVariant> & QVariant::asList ()" -Returns the variant's value as variant list reference. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList<QVariant> list = myVariant.asList(); -.br - QValueList<QVariant>::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "TQ_LLONG & QVariant::asLongLong ()" -Returns the variant's value as long long reference. -.SH "QMap<QString, QVariant> & QVariant::asMap ()" -Returns the variant's value as variant map reference. -.PP -Note that if you want to iterate over the map, you should iterate over a copy, e.g. -.PP -.nf -.br - QMap<QString, QVariant> map = myVariant.asMap(); -.br - QMap<QString, QVariant>::Iterator it = map.begin(); -.br - while( it != map.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "QPalette & QVariant::asPalette ()" -Tries to convert the variant to hold a QPalette value. If that is not possible the variant is set to a palette of black colors. -.PP -Returns a reference to the stored palette. -.PP -See also toString(). -.SH "QPen & QVariant::asPen ()" -Tries to convert the variant to hold a QPen value. If that is not possible then the variant is set to an empty pen. -.PP -Returns a reference to the stored pen. -.PP -See also toPen(). -.SH "QPixmap & QVariant::asPixmap ()" -Tries to convert the variant to hold a pixmap value. If that is not possible the variant is set to a null pixmap. -.PP -Returns a reference to the stored pixmap. -.PP -See also toPixmap(). -.SH "QPoint & QVariant::asPoint ()" -Tries to convert the variant to hold a point value. If that is not possible the variant is set to a (0, 0) point. -.PP -Returns a reference to the stored point. -.PP -See also toPoint(). -.SH "QPointArray & QVariant::asPointArray ()" -Tries to convert the variant to hold a QPointArray value. If that is not possible the variant is set to an empty point array. -.PP -Returns a reference to the stored point array. -.PP -See also toPointArray(). -.SH "QRect & QVariant::asRect ()" -Tries to convert the variant to hold a rectangle value. If that is not possible the variant is set to an empty rectangle. -.PP -Returns a reference to the stored rectangle. -.PP -See also toRect(). -.SH "QRegion & QVariant::asRegion ()" -Tries to convert the variant to hold a QRegion value. If that is not possible the variant is set to a null region. -.PP -Returns a reference to the stored region. -.PP -See also toRegion(). -.SH "QSize & QVariant::asSize ()" -Tries to convert the variant to hold a QSize value. If that is not possible the variant is set to an invalid size. -.PP -Returns a reference to the stored size. -.PP -See also toSize() and QSize::isValid(). -.SH "QSizePolicy & QVariant::asSizePolicy ()" -Tries to convert the variant to hold a QSizePolicy value. If that fails, the variant is set to an arbitrary (valid) size policy. -.SH "QString & QVariant::asString ()" -Tries to convert the variant to hold a string value. If that is not possible the variant is set to an empty string. -.PP -Returns a reference to the stored string. -.PP -See also toString(). -.SH "QStringList & QVariant::asStringList ()" -Tries to convert the variant to hold a QStringList value. If that is not possible the variant is set to an empty string list. -.PP -Returns a reference to the stored string list. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myVariant.asStringList(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also toStringList(). -.SH "QTime & QVariant::asTime ()" -Tries to convert the variant to hold a QTime value. If that is not possible then the variant is set to an invalid time. -.PP -Returns a reference to the stored time. -.PP -See also toTime(). -.SH "uint & QVariant::asUInt ()" -Returns the variant's value as unsigned int reference. -.SH "TQ_ULLONG & QVariant::asULongLong ()" -Returns the variant's value as unsigned long long reference. -.SH "bool QVariant::canCast ( Type t ) const" -Returns TRUE if the variant's type can be cast to the requested type, \fIt\fR. Such casting is done automatically when calling the toInt(), toBool(), ... or asInt(), asBool(), ... methods. -.PP -The following casts are done automatically: <center>.nf -.TS -l - l. Type Automatically Cast To Bool Double, Int, UInt, LongLong, ULongLong, String, CString, ByteArray Color String. CString. ByteArray Date String, CString, ByteArray, DateTime DateTime String, CString, ByteArray, Date, Time Double String, CString, ByteArray, Int, Bool, UInt, LongLong, ULongLong Font String, CString, ByteArray Int String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence LongLong String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence ULongLong String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence List StringList (if the list contains only strings or something that can be cast to a string) String CString, ByteArray, CString, Int, UInt, Bool, Double, Date, Time, DateTime, KeySequence, Font, Color CString String, ByteArray, Int, UInt, Bool, Double, Date, ULongLong, LongLong ByteArray String, CString, Int, UInt, Bool, Double, Date, ULongLong, LongLong StringList List Time String Int String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence KeySequence -.TE -.fi -</center> -.SH "bool QVariant::cast ( Type t )" -Casts the variant to the requested type. If the cast cannot be done, the variant is set to the default value of the requested type (e.g. an empty string if the requested type \fIt\fR is QVariant::String, an empty point array if the requested type \fIt\fR is QVariant::PointArray, etc). Returns TRUE if the current type of the variant was successfully cast; otherwise returns FALSE. -.PP -See also canCast(). -.SH "void QVariant::clear ()" -Convert this variant to type Invalid and free up any resources used. -.SH "bool QVariant::isNull () const" -Returns TRUE if this is a NULL variant, FALSE otherwise. -.SH "bool QVariant::isValid () const" -Returns TRUE if the storage type of this variant is not QVariant::Invalid; otherwise returns FALSE. -.SH "QValueListConstIterator<QVariant> QVariant::listBegin () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns an iterator to the first item in the list if the variant's type is appropriate; otherwise returns a null iterator. -.SH "QValueListConstIterator<QVariant> QVariant::listEnd () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the end iterator for the list if the variant's type is appropriate; otherwise returns a null iterator. -.SH "QMapConstIterator<QString, QVariant> QVariant::mapBegin () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns an iterator to the first item in the map, if the variant's type is appropriate; otherwise returns a null iterator. -.SH "QMapConstIterator<QString, QVariant> QVariant::mapEnd () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the end iterator for the map, if the variant's type is appropriate; otherwise returns a null iterator. -.SH "QMapConstIterator<QString, QVariant> QVariant::mapFind ( const QString & key ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns an iterator to the item in the map with \fIkey\fR as key, if the variant's type is appropriate and \fIkey\fR is a valid key; otherwise returns a null iterator. -.SH "Type QVariant::nameToType ( const char * name )\fC [static]\fR" -Converts the string representation of the storage type given in \fIname\fR, to its enum representation. -.PP -If the string representation cannot be converted to any enum representation, the variant is set to Invalid. -.SH "bool QVariant::operator!= ( const QVariant & v ) const" -Compares this QVariant with \fIv\fR and returns TRUE if they are not equal; otherwise returns FALSE. -.SH "QVariant & QVariant::operator= ( const QVariant & variant )" -Assigns the value of the variant \fIvariant\fR to this variant. -.PP -This is a deep copy of the variant, but note that if the variant holds an explicitly shared type such as QImage, a shallow copy is performed. -.SH "bool QVariant::operator== ( const QVariant & v ) const" -Compares this QVariant with \fIv\fR and returns TRUE if they are equal; otherwise returns FALSE. -.SH "QValueListConstIterator<QString> QVariant::stringListBegin () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns an iterator to the first string in the list if the variant's type is StringList; otherwise returns a null iterator. -.SH "QValueListConstIterator<QString> QVariant::stringListEnd () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Returns the end iterator for the list if the variant's type is StringList; otherwise returns a null iterator. -.SH "const QBitArray QVariant::toBitArray () const" -Returns the variant as a QBitArray if the variant has type() BitArray; otherwise returns an empty bitarray. -.PP -See also asBitArray(). -.SH "const QBitmap QVariant::toBitmap () const" -Returns the variant as a QBitmap if the variant has type() Bitmap; otherwise returns a null QBitmap. -.PP -See also asBitmap(). -.SH "bool QVariant::toBool () const" -Returns the variant as a bool if the variant can be cast to Bool; otherWise returns FALSE. -.PP -Returns TRUE if the variant has a numeric type and its value is non-zero, or if the variant has type String, ByteArray or CString and its lower-case content is not empty, "0" or "false"; otherwise returns FALSE. -.PP -See also asBool() and canCast(). -.SH "const QBrush QVariant::toBrush () const" -Returns the variant as a QBrush if the variant has type() Brush; otherwise returns a default brush (with all black colors). -.PP -See also asBrush(). -.SH "const QByteArray QVariant::toByteArray () const" -Returns the variant as a QByteArray if the variant can be cast to a ByteArray; otherwise returns an empty bytearray. -.PP -See also asByteArray() and canCast(). -.SH "const QCString QVariant::toCString () const" -Returns the variant as a QCString if the variant can be cast to a CString; otherwise returns 0. -.PP -See also asCString() and canCast(). -.SH "const QColor QVariant::toColor () const" -Returns the variant as a QColor if the variant can be cast to Color; otherwise returns an invalid color. -.PP -See also asColor() and canCast(). -.SH "const QColorGroup QVariant::toColorGroup () const" -Returns the variant as a QColorGroup if the variant has type() ColorGroup; otherwise returns a completely black color group. -.PP -See also asColorGroup(). -.SH "const QCursor QVariant::toCursor () const" -Returns the variant as a QCursor if the variant has type() Cursor; otherwise returns the default arrow cursor. -.PP -See also asCursor(). -.SH "const QDate QVariant::toDate () const" -Returns the variant as a QDate if the variant can be cast to Date; otherwise returns an invalid date. -.PP -Note that if the type() is String, CString or ByteArray an invalid date will be returned if the string cannot be parsed as a Qt::ISODate format date. -.PP -See also asDate() and canCast(). -.SH "const QDateTime QVariant::toDateTime () const" -Returns the variant as a QDateTime if the variant can be cast to DateTime; otherwise returns an invalid QDateTime. -.PP -Note that if the type() is String, CString or ByteArray an invalid QDateTime will be returned if the string cannot be parsed as a Qt::ISODate format date/time. -.PP -See also asDateTime(). -.SH "double QVariant::toDouble ( bool * ok = 0 ) const" -Returns the variant as a double if the variant can be cast to Double; otherwise returns 0.0. -.PP -If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to a double; otherwise \fI*ok\fR is set to FALSE. -.PP -See also asDouble() and canCast(). -.SH "const QFont QVariant::toFont () const" -Returns the variant as a QFont if the variant can be cast to Font; otherwise returns the application's default font. -.PP -See also asFont() and canCast(). -.SH "const QIconSet QVariant::toIconSet () const" -Returns the variant as a QIconSet if the variant has type() IconSet; otherwise returns an icon set of null pixmaps. -.PP -See also asIconSet(). -.SH "const QImage QVariant::toImage () const" -Returns the variant as a QImage if the variant has type() Image; otherwise returns a null image. -.PP -See also asImage(). -.SH "int QVariant::toInt ( bool * ok = 0 ) const" -Returns the variant as an int if the variant can be cast to Int; otherwise returns 0. -.PP -If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an int; otherwise \fI*ok\fR is set to FALSE. -.PP -See also asInt() and canCast(). -.SH "const QKeySequence QVariant::toKeySequence () const" -Returns the variant as a QKeySequence if the variant can be cast to a KeySequence; otherwise returns an empty key sequence. -.PP -See also asKeySequence() and canCast(). -.SH "const QValueList<QVariant> QVariant::toList () const" -Returns the variant as a QValueList<QVariant> if the variant has type() List or StringList; otherwise returns an empty list. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QValueList<QVariant> list = myVariant.toList(); -.br - QValueList<QVariant>::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also asList(). -.SH "TQ_LLONG QVariant::toLongLong ( bool * ok = 0 ) const" -Returns the variant as a long long int if the variant can be cast to LongLong; otherwise returns 0. -.PP -If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an int; otherwise \fI*ok\fR is set to FALSE. -.PP -See also asLongLong() and canCast(). -.SH "const QMap<QString, QVariant> QVariant::toMap () const" -Returns the variant as a QMap<QString,QVariant> if the variant has type() Map; otherwise returns an empty map. -.PP -Note that if you want to iterate over the map, you should iterate over a copy, e.g. -.PP -.nf -.br - QMap<QString, QVariant> map = myVariant.toMap(); -.br - QMap<QString, QVariant>::Iterator it = map.begin(); -.br - while( it != map.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also asMap(). -.SH "const QPalette QVariant::toPalette () const" -Returns the variant as a QPalette if the variant has type() Palette; otherwise returns a completely black palette. -.PP -See also asPalette(). -.SH "const QPen QVariant::toPen () const" -Returns the variant as a QPen if the variant has type() Pen; otherwise returns an empty QPen. -.PP -See also asPen(). -.SH "const QPixmap QVariant::toPixmap () const" -Returns the variant as a QPixmap if the variant has type() Pixmap; otherwise returns a null pixmap. -.PP -See also asPixmap(). -.SH "const QPoint QVariant::toPoint () const" -Returns the variant as a QPoint if the variant has type() Point; otherwise returns a point (0, 0). -.PP -See also asPoint(). -.SH "const QPointArray QVariant::toPointArray () const" -Returns the variant as a QPointArray if the variant has type() PointArray; otherwise returns an empty QPointArray. -.PP -See also asPointArray(). -.SH "const QRect QVariant::toRect () const" -Returns the variant as a QRect if the variant has type() Rect; otherwise returns an empty rectangle. -.PP -See also asRect(). -.SH "const QRegion QVariant::toRegion () const" -Returns the variant as a QRegion if the variant has type() Region; otherwise returns an empty QRegion. -.PP -See also asRegion(). -.SH "const QSize QVariant::toSize () const" -Returns the variant as a QSize if the variant has type() Size; otherwise returns an invalid size. -.PP -See also asSize(). -.SH "QSizePolicy QVariant::toSizePolicy () const" -Returns the variant as a QSizePolicy if the variant has type() SizePolicy; otherwise returns an undefined (but legal) size policy. -.SH "const QString QVariant::toString () const" -Returns the variant as a QString if the variant can be cast to String, otherwise returns QString::null. -.PP -See also asString() and canCast(). -.SH "const QStringList QVariant::toStringList () const" -Returns the variant as a QStringList if the variant has type() StringList or List of a type that can be converted to QString; otherwise returns an empty list. -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myVariant.toStringList(); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.PP -See also asStringList(). -.SH "const QTime QVariant::toTime () const" -Returns the variant as a QTime if the variant can be cast to Time; otherwise returns an invalid date. -.PP -Note that if the type() is String, CString or ByteArray an invalid time will be returned if the string cannot be parsed as a Qt::ISODate format time. -.PP -See also asTime(). -.SH "uint QVariant::toUInt ( bool * ok = 0 ) const" -Returns the variant as an unsigned int if the variant can be cast to UInt; otherwise returns 0. -.PP -If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an unsigned int; otherwise \fI*ok\fR is set to FALSE. -.PP -See also asUInt() and canCast(). -.SH "TQ_ULLONG QVariant::toULongLong ( bool * ok = 0 ) const" -Returns the variant as as an unsigned long long int if the variant can be cast to ULongLong; otherwise returns 0. -.PP -If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an int; otherwise \fI*ok\fR is set to FALSE. -.PP -See also asULongLong() and canCast(). -.SH "Type QVariant::type () const" -Returns the storage type of the value stored in the variant. Usually it's best to test with canCast() whether the variant can deliver the data type you are interested in. -.SH "const char * QVariant::typeName () const" -Returns the name of the type stored in the variant. The returned strings describe the C++ datatype used to store the data: for example, "QFont", "QString", or "QValueList<QVariant>". An Invalid variant returns 0. -.SH "const char * QVariant::typeToName ( Type typ )\fC [static]\fR" -Converts the enum representation of the storage type, \fItyp\fR, to -its string representation. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvariant.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvariant.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvbox.3qt b/doc/man/man3/qvbox.3qt deleted file mode 100644 index 30ea80c0d..000000000 --- a/doc/man/man3/qvbox.3qt +++ /dev/null @@ -1,62 +0,0 @@ -'\" t -.TH QVBox 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 -QVBox \- Vertical geometry management of its child widgets -.SH SYNOPSIS -\fC#include <ntqvbox.h>\fR -.PP -Inherits QHBox. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQVBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QVBox widget provides vertical geometry management of its child widgets. -.PP -All its child widgets will be placed vertically and sized according to their sizeHint()s. -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> -.PP -See also QHBox, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QVBox::QVBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a vbox widget called \fIname\fR with parent \fIparent\fR and -widget flags \fIf\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvboxlayout.3qt b/doc/man/man3/qvboxlayout.3qt deleted file mode 100644 index 11066aa7e..000000000 --- a/doc/man/man3/qvboxlayout.3qt +++ /dev/null @@ -1,96 +0,0 @@ -'\" t -.TH QVBoxLayout 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 -QVBoxLayout \- Lines up widgets vertically -.SH SYNOPSIS -\fC#include <ntqlayout.h>\fR -.PP -Inherits QBoxLayout. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQVBoxLayout\fR ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQVBoxLayout\fR ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQVBoxLayout\fR ( int spacing = -1, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QVBoxLayout\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QVBoxLayout class lines up widgets vertically. -.PP -This class is used to construct vertical box layout objects. See QBoxLayout for more details. -.PP -The simplest use of the class is like this: -.PP -.nf -.br - QBoxLayout * l = new QVBoxLayout( widget ); -.br - l->addWidget( aWidget ); -.br - l->addWidget( anotherWidget ); -.br -.fi -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> -.PP -See also QHBoxLayout, QGridLayout, the Layout overview, Widget Appearance and Style, and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QVBoxLayout::QVBoxLayout ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" -Constructs a new top-level vertical box called \fIname\fR, with parent \fIparent\fR. -.PP -The \fImargin\fR is the number of pixels between the edge of the widget and its managed children. The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1 the value of \fImargin\fR is used for \fIspacing\fR. -.SH "QVBoxLayout::QVBoxLayout ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" -Constructs a new vertical box called name \fIname\fR and adds it to \fIparentLayout\fR. -.PP -The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QVBoxLayout will inherit its parent's spacing(). -.SH "QVBoxLayout::QVBoxLayout ( int spacing = -1, const char * name = 0 )" -Constructs a new vertical box called name \fIname\fR. You must add it to another layout. -.PP -The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QVBoxLayout will inherit its parent's spacing(). -.SH "QVBoxLayout::~QVBoxLayout ()" -Destroys this box layout. -.PP -The layout's widgets aren't destroyed. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qvboxlayout.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvboxlayout.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvbuttongroup.3qt b/doc/man/man3/qvbuttongroup.3qt deleted file mode 100644 index 24bec46b7..000000000 --- a/doc/man/man3/qvbuttongroup.3qt +++ /dev/null @@ -1,75 +0,0 @@ -'\" t -.TH QVButtonGroup 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 -QVButtonGroup \- Organizes QButton widgets in a vertical column -.SH SYNOPSIS -\fC#include <ntqvbuttongroup.h>\fR -.PP -Inherits QButtonGroup. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQVButtonGroup\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQVButtonGroup\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QVButtonGroup\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QVButtonGroup widget organizes QButton widgets in a vertical column. -.PP -QVButtonGroup is a convenience class that offers a thin layer on top of QButtonGroup. Think of it as a QVBox that offers a frame with a title and is specifically designed for buttons. -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> -.PP -See also QHButtonGroup, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QVButtonGroup::QVButtonGroup ( QWidget * parent = 0, const char * name = 0 )" -Constructs a vertical button group with no title. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. -.SH "QVButtonGroup::QVButtonGroup ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a vertical button group with the title \fItitle\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. -.SH "QVButtonGroup::~QVButtonGroup ()" -Destroys the vertical button group, deleting its child widgets. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvbuttongroup.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvbuttongroup.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qvgroupbox.3qt b/doc/man/man3/qvgroupbox.3qt deleted file mode 100644 index 2d69d6040..000000000 --- a/doc/man/man3/qvgroupbox.3qt +++ /dev/null @@ -1,75 +0,0 @@ -'\" t -.TH QVGroupBox 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 -QVGroupBox \- Organizes a group of widgets in a vertical column -.SH SYNOPSIS -\fC#include <ntqvgroupbox.h>\fR -.PP -Inherits QGroupBox. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQVGroupBox\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQVGroupBox\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QVGroupBox\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QVGroupBox widget organizes a group of widgets in a vertical column. -.PP -QVGroupBox is a convenience class that offers a thin layer on top of QGroupBox. Think of it as a QVBox that offers a frame with a title. -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> -.PP -See also QHGroupBox, Widget Appearance and Style, Layout Management, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QVGroupBox::QVGroupBox ( QWidget * parent = 0, const char * name = 0 )" -Constructs a vertical group box with no title. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. -.SH "QVGroupBox::QVGroupBox ( const QString & title, QWidget * parent = 0, const char * name = 0 )" -Constructs a vertical group box with the title \fItitle\fR. -.PP -The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. -.SH "QVGroupBox::~QVGroupBox ()" -Destroys the vertical group box, deleting its child widgets. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqvgroupbox.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qvgroupbox.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwaitcondition.3qt b/doc/man/man3/qwaitcondition.3qt deleted file mode 100644 index 355650507..000000000 --- a/doc/man/man3/qwaitcondition.3qt +++ /dev/null @@ -1,202 +0,0 @@ -'\" t -.TH QWaitCondition 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 -QWaitCondition \- Allows waiting/waking for conditions between threads -.SH SYNOPSIS -All the functions in this class are thread-safe when Qt is built with thread support.</p> -.PP -\fC#include <ntqwaitcondition.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWaitCondition\fR ()" -.br -.ti -1c -.BI "virtual \fB~QWaitCondition\fR ()" -.br -.ti -1c -.BI "bool \fBwait\fR ( unsigned long time = ULONG_MAX )" -.br -.ti -1c -.BI "bool \fBwait\fR ( QMutex * mutex, unsigned long time = ULONG_MAX )" -.br -.ti -1c -.BI "void \fBwakeOne\fR ()" -.br -.ti -1c -.BI "void \fBwakeAll\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWaitCondition class allows waiting/waking for conditions between threads. -.PP -QWaitConditions allow a thread to tell other threads that some sort of condition has been met; one or many threads can block waiting for a QWaitCondition to set a condition with wakeOne() or wakeAll(). Use wakeOne() to wake one randomly selected event or wakeAll() to wake them all. For example, say we have three tasks that should be performed every time the user presses a key; each task could be split into a thread, each of which would have a run() body like this: -.PP -.nf -.br - QWaitCondition key_pressed; -.br -.br - for (;;) { -.br - key_pressed.wait(); // This is a QWaitCondition global variable -.br - // Key was pressed, do something interesting -.br - do_something(); -.br - } -.br -.fi -.PP -A fourth thread would read key presses and wake the other three threads up every time it receives one, like this: -.PP -.nf -.br - QWaitCondition key_pressed; -.br -.br - for (;;) { -.br - getchar(); -.br - // Causes any thread in key_pressed.wait() to return from -.br - // that method and continue processing -.br - key_pressed.wakeAll(); -.br - } -.br -.fi -.PP -Note that the order the three threads are woken up in is undefined, and that if some or all of the threads are still in do_something() when the key is pressed, they won't be woken up (since they're not waiting on the condition variable) and so the task will not be performed for that key press. This can be avoided by, for example, doing something like this: -.PP -.nf -.br - QMutex mymutex; -.br - QWaitCondition key_pressed; -.br - int mycount=0; -.br -.br - // Worker thread code -.br - for (;;) { -.br - key_pressed.wait(); // This is a QWaitCondition global variable -.br - mymutex.lock(); -.br - mycount++; -.br - mymutex.unlock(); -.br - do_something(); -.br - mymutex.lock(); -.br - mycount--; -.br - mymutex.unlock(); -.br - } -.br -.br - // Key reading thread code -.br - for (;;) { -.br - getchar(); -.br - mymutex.lock(); -.br - // Sleep until there are no busy worker threads -.br - while( mycount > 0 ) { -.br - mymutex.unlock(); -.br - sleep( 1 ); -.br - mymutex.lock(); -.br - } -.br - mymutex.unlock(); -.br - key_pressed.wakeAll(); -.br - } -.br -.fi -.PP -The mutexes are necessary because the results of two threads attempting to change the value of the same variable simultaneously are unpredictable. -.PP -See also Environment Classes and Threading. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWaitCondition::QWaitCondition ()" -Constructs a new event signalling, i.e. wait condition, object. -.SH "QWaitCondition::~QWaitCondition ()\fC [virtual]\fR" -Deletes the event signalling, i.e. wait condition, object. -.SH "bool QWaitCondition::wait ( unsigned long time = ULONG_MAX )" -Wait on the thread event object. The thread calling this will block until either of these conditions is met: -.TP -Another thread signals it using wakeOne() or wakeAll(). This function will return TRUE in this case. -.TP -\fItime\fR milliseconds has elapsed. If \fItime\fR is ULONG_MAX (the default), then the wait will never timeout (the event must be signalled). This function will return FALSE if the wait timed out. -.PP -See also wakeOne() and wakeAll(). -.SH "bool QWaitCondition::wait ( QMutex * mutex, unsigned long time = ULONG_MAX )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Release the locked \fImutex\fR and wait on the thread event object. The \fImutex\fR must be initially locked by the calling thread. If \fImutex\fR is not in a locked state, this function returns immediately. If \fImutex\fR is a recursive mutex, this function returns immediately. The \fImutex\fR will be unlocked, and the calling thread will block until either of these conditions is met: -.TP -Another thread signals it using wakeOne() or wakeAll(). This function will return TRUE in this case. -.TP -\fItime\fR milliseconds has elapsed. If \fItime\fR is ULONG_MAX (the default), then the wait will never timeout (the event must be signalled). This function will return FALSE if the wait timed out. -.PP -The mutex will be returned to the same locked state. This function is provided to allow the atomic transition from the locked state to the wait state. -.PP -See also wakeOne() and wakeAll(). -.SH "void QWaitCondition::wakeAll ()" -This wakes all threads waiting on the QWaitCondition. The order in which the threads are woken up depends on the operating system's scheduling policies, and cannot be controlled or predicted. -.PP -See also wakeOne(). -.SH "void QWaitCondition::wakeOne ()" -This wakes one thread waiting on the QWaitCondition. The thread that is woken up depends on the operating system's scheduling policies, and cannot be controlled or predicted. -.PP -See also wakeAll(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwaitcondition.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwaitcondition.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwhatsthis.3qt b/doc/man/man3/qwhatsthis.3qt deleted file mode 100644 index f19c74b9b..000000000 --- a/doc/man/man3/qwhatsthis.3qt +++ /dev/null @@ -1,207 +0,0 @@ -'\" t -.TH QWhatsThis 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 -QWhatsThis \- Simple description of any widget, i.e. answering the question "What's this?" -.SH SYNOPSIS -\fC#include <ntqwhatsthis.h>\fR -.PP -Inherits Qt. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWhatsThis\fR ( QWidget * widget )" -.br -.ti -1c -.BI "virtual \fB~QWhatsThis\fR ()" -.br -.ti -1c -.BI "virtual QString \fBtext\fR ( const QPoint & )" -.br -.ti -1c -.BI "virtual bool \fBclicked\fR ( const QString & href )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBsetFont\fR ( const QFont & font )" -.br -.ti -1c -.BI "void \fBadd\fR ( QWidget * widget, const QString & text )" -.br -.ti -1c -.BI "void \fBremove\fR ( QWidget * widget )" -.br -.ti -1c -.BI "QString \fBtextFor\fR ( QWidget * w, const QPoint & pos = QPoint ( ), bool includeParents = FALSE )" -.br -.ti -1c -.BI "QToolButton * \fBwhatsThisButton\fR ( QWidget * parent )" -.br -.ti -1c -.BI "void \fBenterWhatsThisMode\fR ()" -.br -.ti -1c -.BI "bool \fBinWhatsThisMode\fR ()" -.br -.ti -1c -.BI "void \fBleaveWhatsThisMode\fR ( const QString & text = QString::null, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )" -.br -.ti -1c -.BI "void \fBdisplay\fR ( const QString & text, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QWhatsThis class provides a simple description of any widget, i.e. answering the question "What's this?". -.PP -.PP" -What's this?" help is part of an application's online help system that provides users with information about functionality, usage, background etc., in various levels of detail from short tool tips to full text browsing help windows. -.PP -QWhatsThis provides a single window with an explanatory text that pops up when the user asks "What's this?". The default way to do this is to focus the relevant widget and press Shift+F1. The help text appears immediately; it goes away as soon as the user does something else. -.PP -(Note that if there is an accelerator for Shift+F1, this mechanism will not work.) -.PP -To add "What's this?" text to a widget you simply call QWhatsThis::add() for the widget. For example, to assign text to a menu item, call QMenuData::setWhatsThis(); for a global accelerator key, call QAccel::setWhatsThis() and If you're using actions, use QAction::setWhatsThis(). -.PP -The text can be either rich text or plain text. If you specify a rich text formatted string, it will be rendered using the default stylesheet. This makes it possible to embed images. See QStyleSheet::defaultSheet() for details. -.PP -.nf -.br - const char * fileOpenText = "<p><img source=\\"fileopen\\"> " -.br - "Click this button to open a <em>new file</em>. <br>" -.br - "You can also select the <b>Open</b> command " -.br - "from the <b>File</b> menu.</p>"; -.br - QMimeSourceFactory::defaultFactory()->setPixmap( "fileopen", -.br - fileOpenAction->iconSet().pixmap() ); -.br - fileOpenAction->setWhatsThis( fileOpenText ); -.fi -.PP -An alternative way to enter "What's this?" mode is to use the ready-made tool bar tool button from QWhatsThis::whatsThisButton(). By invoking this context help button (in the picture below the first one from the right) the user switches into "What's this?" mode. If they now click on a widget the appropriate help text is shown. The mode is left when help is given or when the user presses Esc. -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> -.PP -If you are using QMainWindow you can also use the QMainWindow::whatsThis() slot to invoke the mode from a menu item. -.PP -For more control you can create a dedicated QWhatsThis object for a special widget. By subclassing and reimplementing QWhatsThis::text() it is possible to have different help texts, depending on the position of the mouse click. By reimplementing QWhatsThis::clicked() it is possible to have hyperlinks inside the help texts. -.PP -If you wish to control the "What's this?" behavior of a widget manually see QWidget::customWhatsThis(). -.PP -The What's This object can be removed using QWhatsThis::remove(), although this is rarely necessary because it is automatically removed when the widget is destroyed. -.PP -See also QToolTip and Help System. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWhatsThis::QWhatsThis ( QWidget * widget )" -Constructs a dynamic "What's this?" object for \fIwidget\fR. The object is deleted when the \fIwidget\fR is destroyed. -.PP -When the widget is queried by the user the text() function of this QWhatsThis will be called to provide the appropriate text, rather than using the text assigned by add(). -.SH "QWhatsThis::~QWhatsThis ()\fC [virtual]\fR" -Destroys the object and frees any allocated resources. -.SH "void QWhatsThis::add ( QWidget * widget, const QString & text )\fC [static]\fR" -Adds \fItext\fR as "What's this" help for \fIwidget\fR. If the text is rich text formatted (i.e. it contains markup) it will be rendered with the default stylesheet QStyleSheet::defaultSheet(). -.PP -The text is destroyed if the widget is later destroyed, so it need not be explicitly removed. -.PP -See also remove(). -.PP -Examples: -.)l application/application.cpp, helpsystem/mainwindow.cpp, and mdi/application.cpp. -.SH "bool QWhatsThis::clicked ( const QString & href )\fC [virtual]\fR" -This virtual function is called when the user clicks inside the" What's this?" window. \fIhref\fR is the link the user clicked on, or QString::null if there was no link. -.PP -If the function returns TRUE (the default), the "What's this?" window is closed, otherwise it remains visible. -.PP -The default implementation ignores \fIhref\fR and returns TRUE. -.SH "void QWhatsThis::display ( const QString & text, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )\fC [static]\fR" -Display \fItext\fR in a help window at the global screen position \fIpos\fR. -.PP -If widget \fIw\fR is not 0 and has its own dedicated QWhatsThis object, this object will receive clicked() messages when the user clicks on hyperlinks inside the help text. -.PP -See also QWhatsThis::clicked(). -.SH "void QWhatsThis::enterWhatsThisMode ()\fC [static]\fR" -Enters "What's this?" mode and returns immediately. -.PP -Qt will install a special cursor and take over mouse input until the user clicks somewhere. It then shows any help available and ends "What's this?" mode. Finally, Qt removes the special cursor and help window and then restores ordinary event processing, at which point the left mouse button is no longer pressed. -.PP -The user can also use the Esc key to leave "What's this?" mode. -.PP -See also inWhatsThisMode() and leaveWhatsThisMode(). -.SH "bool QWhatsThis::inWhatsThisMode ()\fC [static]\fR" -Returns TRUE if the application is in "What's this?" mode; otherwise returns FALSE. -.PP -See also enterWhatsThisMode() and leaveWhatsThisMode(). -.SH "void QWhatsThis::leaveWhatsThisMode ( const QString & text = QString::null, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )\fC [static]\fR" -Leaves "What's this?" question mode. -.PP -This function is used internally by widgets that support QWidget::customWhatsThis(); applications do not usually call it. An example of such a widget is QPopupMenu: menus still work normally in "What's this?" mode but also provide help texts for individual menu items. -.PP -If \fItext\fR is not QString::null, a "What's this?" help window is displayed at the global screen position \fIpos\fR. If widget \fIw\fR is not 0 and has its own dedicated QWhatsThis object, this object will receive clicked() messages when the user clicks on hyperlinks inside the help text. -.PP -See also inWhatsThisMode(), enterWhatsThisMode(), and QWhatsThis::clicked(). -.SH "void QWhatsThis::remove ( QWidget * widget )\fC [static]\fR" -Removes the "What's this?" help associated with the \fIwidget\fR. This happens automatically if the widget is destroyed. -.PP -See also add(). -.SH "void QWhatsThis::setFont ( const QFont & font )\fC [static]\fR" -Sets the font for all "What's this?" helps to \fIfont\fR. -.SH "QString QWhatsThis::text ( const QPoint & )\fC [virtual]\fR" -This virtual function returns the text for position \fIp\fR in the widget that this "What's this?" object documents. If there is no" What's this?" text for the position, QString::null is returned. -.PP -The default implementation returns QString::null. -.SH "QString QWhatsThis::textFor ( QWidget * w, const QPoint & pos = QPoint ( ), bool includeParents = FALSE )\fC [static]\fR" -Returns the what's this text for widget \fIw\fR or QString::null if there is no "What's this?" help for the widget. \fIpos\fR contains the mouse position; this is useful, for example, if you've subclassed to make the text that is displayed position dependent. -.PP -If \fIincludeParents\fR is TRUE, parent widgets are taken into consideration as well when looking for what's this help text. -.PP -See also add(). -.SH "QToolButton * QWhatsThis::whatsThisButton ( QWidget * parent )\fC [static]\fR" -Creates a QToolButton preconfigured to enter "What's this?" mode when clicked. You will often use this with a tool bar as \fIparent\fR: -.PP -.nf -.br - (void) QWhatsThis::whatsThisButton( my_help_tool_bar ); -.br -.fi -.PP -Example: helpsystem/mainwindow.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwhatsthis.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwhatsthis.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwheelevent.3qt b/doc/man/man3/qwheelevent.3qt deleted file mode 100644 index e37232fda..000000000 --- a/doc/man/man3/qwheelevent.3qt +++ /dev/null @@ -1,160 +0,0 @@ -'\" t -.TH QWheelEvent 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 -QWheelEvent \- Parameters that describe a wheel event -.SH SYNOPSIS -\fC#include <ntqevent.h>\fR -.PP -Inherits QEvent. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWheelEvent\fR ( const QPoint & pos, int delta, int state, Orientation orient = Vertical )" -.br -.ti -1c -.BI "\fBQWheelEvent\fR ( const QPoint & pos, const QPoint & globalPos, int delta, int state, Orientation orient = Vertical )" -.br -.ti -1c -.BI "int \fBdelta\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBpos\fR () const" -.br -.ti -1c -.BI "const QPoint & \fBglobalPos\fR () const" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "int \fBglobalX\fR () const" -.br -.ti -1c -.BI "int \fBglobalY\fR () const" -.br -.ti -1c -.BI "ButtonState \fBstate\fR () const" -.br -.ti -1c -.BI "Orientation \fBorientation\fR () const" -.br -.ti -1c -.BI "bool \fBisAccepted\fR () const" -.br -.ti -1c -.BI "void \fBaccept\fR ()" -.br -.ti -1c -.BI "void \fBignore\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWheelEvent class contains parameters that describe a wheel event. -.PP -Wheel events are sent to the widget under the mouse, and if that widget does not handle the event they are sent to the focus widget. The rotation distance is provided by delta(). The functions pos() and globalPos() return the mouse pointer location at the time of the event. -.PP -A wheel event contains a special accept flag that indicates whether the receiver wants the event. You should call QWheelEvent::accept() if you handle the wheel event; otherwise it will be sent to the parent widget. -.PP -The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget. -.PP -The event handler QWidget::wheelEvent() receives wheel events. -.PP -See also QMouseEvent, QWidget::grabMouse(), and Event Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWheelEvent::QWheelEvent ( const QPoint & pos, int delta, int state, Orientation orient = Vertical )" -Constructs a wheel event object. -.PP -The globalPos() is initialized to QCursor::pos(), i.e. \fIpos\fR, which is usually (but not always) right. Use the other constructor if you need to specify the global position explicitly. \fIdelta\fR contains the rotation distance, \fIstate\fR holds the keyboard modifier flags at the time of the event and \fIorient\fR holds the wheel's orientation. -.PP -See also pos(), delta(), and state(). -.SH "QWheelEvent::QWheelEvent ( const QPoint & pos, const QPoint & globalPos, int delta, int state, Orientation orient = Vertical )" -Constructs a wheel event object. The position when the event occurred is given in \fIpos\fR and \fIglobalPos\fR. \fIdelta\fR contains the rotation distance, \fIstate\fR holds the keyboard modifier flags at the time of the event and \fIorient\fR holds the wheel's orientation. -.PP -See also pos(), globalPos(), delta(), and state(). -.SH "void QWheelEvent::accept ()" -Sets the accept flag of the wheel event object. -.PP -Setting the accept parameter indicates that the receiver of the event wants the wheel event. Unwanted wheel events are sent to the parent widget. -.PP -The accept flag is set by default. -.PP -See also ignore(). -.SH "int QWheelEvent::delta () const" -Returns the distance that the wheel is rotated expressed in multiples or divisions of the \fIwheel delta\fR, which is currently defined to be 120. A positive value indicates that the wheel was rotated forwards away from the user; a negative value indicates that the wheel was rotated backwards toward the user. -.PP -The \fIwheel delta\fR constant was defined to be 120 by wheel mouse vendors to allow building finer-resolution wheels in the future, including perhaps a freely rotating wheel with no notches. The expectation is that such a device would send more messages per rotation but with a smaller value in each message. -.SH "const QPoint & QWheelEvent::globalPos () const" -Returns the global position of the mouse pointer \fIat the time of the event\fR. This is important on asynchronous window systems such as X11; whenever you move your widgets around in response to mouse events, globalPos() can differ a lot from the current pointer position QCursor::pos(). -.PP -See also globalX() and globalY(). -.SH "int QWheelEvent::globalX () const" -Returns the global x-position of the mouse pointer at the time of the event. -.PP -See also globalY() and globalPos(). -.SH "int QWheelEvent::globalY () const" -Returns the global y-position of the mouse pointer at the time of the event. -.PP -See also globalX() and globalPos(). -.SH "void QWheelEvent::ignore ()" -Clears the accept flag parameter of the wheel event object. -.PP -Clearing the accept parameter indicates that the event receiver does not want the wheel event. Unwanted wheel events are sent to the parent widget. The accept flag is set by default. -.PP -See also accept(). -.SH "bool QWheelEvent::isAccepted () const" -Returns TRUE if the receiver of the event handles the wheel event; otherwise returns FALSE. -.SH "Orientation QWheelEvent::orientation () const" -Returns the wheel's orientation. -.SH "const QPoint & QWheelEvent::pos () const" -Returns the position of the mouse pointer, relative to the widget that received the event. -.PP -If you move your widgets around in response to mouse events, use globalPos() instead of this function. -.PP -See also x(), y(), and globalPos(). -.SH "ButtonState QWheelEvent::state () const" -Returns the keyboard modifier flags of the event. -.PP -The returned value is ShiftButton, ControlButton, and AltButton OR'ed together. -.SH "int QWheelEvent::x () const" -Returns the x-position of the mouse pointer, relative to the widget that received the event. -.PP -See also y() and pos(). -.SH "int QWheelEvent::y () const" -Returns the y-position of the mouse pointer, relative to the widget that received the event. -.PP -See also x() and pos(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwheelevent.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwheelevent.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwidget.3qt b/doc/man/man3/qwidget.3qt deleted file mode 100644 index 2e49ff955..000000000 --- a/doc/man/man3/qwidget.3qt +++ /dev/null @@ -1,3219 +0,0 @@ -'\" t -.TH QWidget 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 -QWidget \- The base class of all user interface objects -.SH SYNOPSIS -\fC#include <ntqwidget.h>\fR -.PP -Inherits QObject and QPaintDevice. -.PP -Inherited by QAxWidget, QButton, QFrame, QDialog, QComboBox, QDataBrowser, QDataView, QDateTimeEditBase, QDateTimeEdit, QDesktopWidget, QDial, QDockArea, QGLWidget, QHeader, QMainWindow, QMotifWidget, QNPWidget, QScrollBar, QSizeGrip, QSlider, QSpinBox, QSplashScreen, QStatusBar, QTabBar, QTabWidget, QWorkspace, and QXtWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "explicit \fBQWidget\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QWidget\fR ()" -.br -.ti -1c -.BI "WId \fBwinId\fR () const" -.br -.ti -1c -.BI "QStyle & \fBstyle\fR () const" -.br -.ti -1c -.BI "void \fBsetStyle\fR ( QStyle * style )" -.br -.ti -1c -.BI "QStyle * \fBsetStyle\fR ( const QString & style )" -.br -.ti -1c -.BI "bool \fBisTopLevel\fR () const" -.br -.ti -1c -.BI "bool \fBisDialog\fR () const" -.br -.ti -1c -.BI "bool \fBisPopup\fR () const" -.br -.ti -1c -.BI "bool \fBisDesktop\fR () const" -.br -.ti -1c -.BI "bool \fBisModal\fR () const" -.br -.ti -1c -.BI "bool \fBisEnabled\fR () const" -.br -.ti -1c -.BI "bool \fBisEnabledTo\fR ( QWidget * ancestor ) const" -.br -.ti -1c -.BI "bool isEnabledToTLW () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QRect \fBframeGeometry\fR () const" -.br -.ti -1c -.BI "const QRect & \fBgeometry\fR () const" -.br -.ti -1c -.BI "int \fBx\fR () const" -.br -.ti -1c -.BI "int \fBy\fR () const" -.br -.ti -1c -.BI "QPoint \fBpos\fR () const" -.br -.ti -1c -.BI "QSize \fBframeSize\fR () const" -.br -.ti -1c -.BI "QSize \fBsize\fR () const" -.br -.ti -1c -.BI "int \fBwidth\fR () const" -.br -.ti -1c -.BI "int \fBheight\fR () const" -.br -.ti -1c -.BI "QRect \fBrect\fR () const" -.br -.ti -1c -.BI "QRect \fBchildrenRect\fR () const" -.br -.ti -1c -.BI "QRegion \fBchildrenRegion\fR () const" -.br -.ti -1c -.BI "QSize \fBminimumSize\fR () const" -.br -.ti -1c -.BI "QSize \fBmaximumSize\fR () const" -.br -.ti -1c -.BI "int \fBminimumWidth\fR () const" -.br -.ti -1c -.BI "int \fBminimumHeight\fR () const" -.br -.ti -1c -.BI "int \fBmaximumWidth\fR () const" -.br -.ti -1c -.BI "int \fBmaximumHeight\fR () const" -.br -.ti -1c -.BI "void \fBsetMinimumSize\fR ( const QSize & )" -.br -.ti -1c -.BI "virtual void \fBsetMinimumSize\fR ( int minw, int minh )" -.br -.ti -1c -.BI "void \fBsetMaximumSize\fR ( const QSize & )" -.br -.ti -1c -.BI "virtual void \fBsetMaximumSize\fR ( int maxw, int maxh )" -.br -.ti -1c -.BI "void \fBsetMinimumWidth\fR ( int minw )" -.br -.ti -1c -.BI "void \fBsetMinimumHeight\fR ( int minh )" -.br -.ti -1c -.BI "void \fBsetMaximumWidth\fR ( int maxw )" -.br -.ti -1c -.BI "void \fBsetMaximumHeight\fR ( int maxh )" -.br -.ti -1c -.BI "QSize \fBsizeIncrement\fR () const" -.br -.ti -1c -.BI "void \fBsetSizeIncrement\fR ( const QSize & )" -.br -.ti -1c -.BI "virtual void \fBsetSizeIncrement\fR ( int w, int h )" -.br -.ti -1c -.BI "QSize \fBbaseSize\fR () const" -.br -.ti -1c -.BI "void \fBsetBaseSize\fR ( const QSize & )" -.br -.ti -1c -.BI "void \fBsetBaseSize\fR ( int basew, int baseh )" -.br -.ti -1c -.BI "void \fBsetFixedSize\fR ( const QSize & s )" -.br -.ti -1c -.BI "void \fBsetFixedSize\fR ( int w, int h )" -.br -.ti -1c -.BI "void \fBsetFixedWidth\fR ( int w )" -.br -.ti -1c -.BI "void \fBsetFixedHeight\fR ( int h )" -.br -.ti -1c -.BI "QPoint \fBmapToGlobal\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "QPoint \fBmapFromGlobal\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "QPoint \fBmapToParent\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "QPoint \fBmapFromParent\fR ( const QPoint & pos ) const" -.br -.ti -1c -.BI "QPoint \fBmapTo\fR ( QWidget * parent, const QPoint & pos ) const" -.br -.ti -1c -.BI "QPoint \fBmapFrom\fR ( QWidget * parent, const QPoint & pos ) const" -.br -.ti -1c -.BI "QWidget * \fBtopLevelWidget\fR () const" -.br -.ti -1c -.BI "BackgroundMode \fBbackgroundMode\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetBackgroundMode\fR ( BackgroundMode )" -.br -.ti -1c -.BI "void \fBsetBackgroundMode\fR ( BackgroundMode m, BackgroundMode visual )" -.br -.ti -1c -.BI "const QColor & \fBforegroundColor\fR () const" -.br -.ti -1c -.BI "const QColor & \fBeraseColor\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetEraseColor\fR ( const QColor & color )" -.br -.ti -1c -.BI "const QPixmap * \fBerasePixmap\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetErasePixmap\fR ( const QPixmap & pixmap )" -.br -.ti -1c -.BI "const QColorGroup & \fBcolorGroup\fR () const" -.br -.ti -1c -.BI "const QPalette & \fBpalette\fR () const" -.br -.ti -1c -.BI "bool \fBownPalette\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPalette\fR ( const QPalette & )" -.br -.ti -1c -.BI "void \fBunsetPalette\fR ()" -.br -.ti -1c -.BI "const QColor & \fBpaletteForegroundColor\fR () const" -.br -.ti -1c -.BI "void \fBsetPaletteForegroundColor\fR ( const QColor & )" -.br -.ti -1c -.BI "const QColor & \fBpaletteBackgroundColor\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPaletteBackgroundColor\fR ( const QColor & )" -.br -.ti -1c -.BI "const QPixmap * \fBpaletteBackgroundPixmap\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetPaletteBackgroundPixmap\fR ( const QPixmap & )" -.br -.ti -1c -.BI "const QBrush & \fBbackgroundBrush\fR () const" -.br -.ti -1c -.BI "QFont \fBfont\fR () const" -.br -.ti -1c -.BI "bool \fBownFont\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFont\fR ( const QFont & )" -.br -.ti -1c -.BI "void \fBunsetFont\fR ()" -.br -.ti -1c -.BI "QFontMetrics \fBfontMetrics\fR () const" -.br -.ti -1c -.BI "QFontInfo \fBfontInfo\fR () const" -.br -.ti -1c -.BI "const QCursor & \fBcursor\fR () const" -.br -.ti -1c -.BI "bool \fBownCursor\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetCursor\fR ( const QCursor & )" -.br -.ti -1c -.BI "virtual void \fBunsetCursor\fR ()" -.br -.ti -1c -.BI "QString \fBcaption\fR () const" -.br -.ti -1c -.BI "const QPixmap * \fBicon\fR () const" -.br -.ti -1c -.BI "QString \fBiconText\fR () const" -.br -.ti -1c -.BI "bool \fBhasMouseTracking\fR () const" -.br -.ti -1c -.BI "bool \fBhasMouse\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetMask\fR ( const QBitmap & bitmap )" -.br -.ti -1c -.BI "virtual void \fBsetMask\fR ( const QRegion & region )" -.br -.ti -1c -.BI "void \fBclearMask\fR ()" -.br -.ti -1c -.BI "const QColor & backgroundColor () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void setBackgroundColor ( const QColor & c ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "const QPixmap * backgroundPixmap () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void setBackgroundPixmap ( const QPixmap & pm ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "enum \fBFocusPolicy\fR { NoFocus = 0, TabFocus = 0x1, ClickFocus = 0x2, StrongFocus = TabFocus | ClickFocus | 0x8, WheelFocus = StrongFocus | 0x4 }" -.br -.ti -1c -.BI "bool \fBisActiveWindow\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetActiveWindow\fR ()" -.br -.ti -1c -.BI "bool \fBisFocusEnabled\fR () const" -.br -.ti -1c -.BI "FocusPolicy \fBfocusPolicy\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFocusPolicy\fR ( FocusPolicy )" -.br -.ti -1c -.BI "bool \fBhasFocus\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetFocusProxy\fR ( QWidget * w )" -.br -.ti -1c -.BI "QWidget * \fBfocusProxy\fR () const" -.br -.ti -1c -.BI "void \fBsetInputMethodEnabled\fR ( bool b )" -.br -.ti -1c -.BI "bool \fBisInputMethodEnabled\fR () const" -.br -.ti -1c -.BI "void \fBgrabMouse\fR ()" -.br -.ti -1c -.BI "void \fBgrabMouse\fR ( const QCursor & cursor )" -.br -.ti -1c -.BI "void \fBreleaseMouse\fR ()" -.br -.ti -1c -.BI "void \fBgrabKeyboard\fR ()" -.br -.ti -1c -.BI "void \fBreleaseKeyboard\fR ()" -.br -.ti -1c -.BI "bool \fBisUpdatesEnabled\fR () const" -.br -.ti -1c -.BI "virtual bool \fBclose\fR ( bool alsoDelete )" -.br -.ti -1c -.BI "bool \fBisVisible\fR () const" -.br -.ti -1c -.BI "bool \fBisVisibleTo\fR ( QWidget * ancestor ) const" -.br -.ti -1c -.BI "bool isVisibleToTLW () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QRect visibleRect () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "bool \fBisHidden\fR () const" -.br -.ti -1c -.BI "bool \fBisShown\fR () const" -.br -.ti -1c -.BI "bool \fBisMinimized\fR () const" -.br -.ti -1c -.BI "bool \fBisMaximized\fR () const" -.br -.ti -1c -.BI "bool \fBisFullScreen\fR () const" -.br -.ti -1c -.BI "uint \fBwindowState\fR () const" -.br -.ti -1c -.BI "void \fBsetWindowState\fR ( uint windowState )" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBminimumSizeHint\fR () const" -.br -.ti -1c -.BI "virtual QSizePolicy \fBsizePolicy\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetSizePolicy\fR ( QSizePolicy )" -.br -.ti -1c -.BI "void \fBsetSizePolicy\fR ( QSizePolicy::SizeType hor, QSizePolicy::SizeType ver, bool hfw = FALSE )" -.br -.ti -1c -.BI "virtual int \fBheightForWidth\fR ( int w ) const" -.br -.ti -1c -.BI "QRegion \fBclipRegion\fR () const" -.br -.ti -1c -.BI "QLayout * \fBlayout\fR () const" -.br -.ti -1c -.BI "void \fBupdateGeometry\fR ()" -.br -.ti -1c -.BI "virtual void \fBreparent\fR ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE )" -.br -.ti -1c -.BI "void \fBreparent\fR ( QWidget * parent, const QPoint & p, bool showIt = FALSE )" -.br -.ti -1c -.BI "void recreate ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void \fBerase\fR ()" -.br -.ti -1c -.BI "void \fBerase\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBerase\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBerase\fR ( const QRegion & reg )" -.br -.ti -1c -.BI "void \fBscroll\fR ( int dx, int dy )" -.br -.ti -1c -.BI "void \fBscroll\fR ( int dx, int dy, const QRect & r )" -.br -.ti -1c -.BI "void \fBdrawText\fR ( int x, int y, const QString & str )" -.br -.ti -1c -.BI "void \fBdrawText\fR ( const QPoint & pos, const QString & str )" -.br -.ti -1c -.BI "QWidget * \fBfocusWidget\fR () const" -.br -.ti -1c -.BI "QRect \fBmicroFocusHint\fR () const" -.br -.ti -1c -.BI "bool \fBacceptDrops\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetAcceptDrops\fR ( bool on )" -.br -.ti -1c -.BI "virtual void \fBsetAutoMask\fR ( bool )" -.br -.ti -1c -.BI "bool \fBautoMask\fR () const" -.br -.ti -1c -.BI "enum \fBBackgroundOrigin\fR { WidgetOrigin, ParentOrigin, WindowOrigin, AncestorOrigin }" -.br -.ti -1c -.BI "virtual void \fBsetBackgroundOrigin\fR ( BackgroundOrigin )" -.br -.ti -1c -.BI "BackgroundOrigin \fBbackgroundOrigin\fR () const" -.br -.ti -1c -.BI "virtual bool \fBcustomWhatsThis\fR () const" -.br -.ti -1c -.BI "QWidget * \fBparentWidget\fR ( bool sameWindow = FALSE ) const" -.br -.ti -1c -.BI "WFlags \fBtestWFlags\fR ( WFlags f ) const" -.br -.ti -1c -.BI "QWidget * \fBchildAt\fR ( int x, int y, bool includeThis = FALSE ) const" -.br -.ti -1c -.BI "QWidget * \fBchildAt\fR ( const QPoint & p, bool includeThis = FALSE ) const" -.br -.ti -1c -.BI "void \fBsetWindowOpacity\fR ( double level )" -.br -.ti -1c -.BI "double \fBwindowOpacity\fR () const" -.br -.ti -1c -.BI "void setPalette ( const QPalette & p, bool ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "void setFont ( const QFont & f, bool ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetEnabled\fR ( bool )" -.br -.ti -1c -.BI "void \fBsetDisabled\fR ( bool disable )" -.br -.ti -1c -.BI "virtual void \fBsetCaption\fR ( const QString & )" -.br -.ti -1c -.BI "virtual void \fBsetIcon\fR ( const QPixmap & )" -.br -.ti -1c -.BI "virtual void \fBsetIconText\fR ( const QString & )" -.br -.ti -1c -.BI "virtual void \fBsetMouseTracking\fR ( bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetFocus\fR ()" -.br -.ti -1c -.BI "void \fBclearFocus\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetUpdatesEnabled\fR ( bool enable )" -.br -.ti -1c -.BI "void \fBupdate\fR ()" -.br -.ti -1c -.BI "void \fBupdate\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "void \fBupdate\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBrepaint\fR ()" -.br -.ti -1c -.BI "void \fBrepaint\fR ( bool erase )" -.br -.ti -1c -.BI "void \fBrepaint\fR ( int x, int y, int w, int h, bool erase = TRUE )" -.br -.ti -1c -.BI "void \fBrepaint\fR ( const QRect & r, bool erase = TRUE )" -.br -.ti -1c -.BI "void \fBrepaint\fR ( const QRegion & reg, bool erase = TRUE )" -.br -.ti -1c -.BI "virtual void \fBshow\fR ()" -.br -.ti -1c -.BI "virtual void \fBhide\fR ()" -.br -.ti -1c -.BI "void \fBsetShown\fR ( bool show )" -.br -.ti -1c -.BI "void \fBsetHidden\fR ( bool hide )" -.br -.ti -1c -.BI "void iconify () \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual void \fBshowMinimized\fR ()" -.br -.ti -1c -.BI "virtual void \fBshowMaximized\fR ()" -.br -.ti -1c -.BI "void \fBshowFullScreen\fR ()" -.br -.ti -1c -.BI "virtual void \fBshowNormal\fR ()" -.br -.ti -1c -.BI "virtual void \fBpolish\fR ()" -.br -.ti -1c -.BI "void \fBconstPolish\fR () const" -.br -.ti -1c -.BI "bool \fBclose\fR ()" -.br -.ti -1c -.BI "void \fBraise\fR ()" -.br -.ti -1c -.BI "void \fBlower\fR ()" -.br -.ti -1c -.BI "void \fBstackUnder\fR ( QWidget * w )" -.br -.ti -1c -.BI "virtual void \fBmove\fR ( int x, int y )" -.br -.ti -1c -.BI "void \fBmove\fR ( const QPoint & )" -.br -.ti -1c -.BI "virtual void \fBresize\fR ( int w, int h )" -.br -.ti -1c -.BI "void \fBresize\fR ( const QSize & )" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( int x, int y, int w, int h )" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( const QRect & )" -.br -.ti -1c -.BI "virtual void \fBadjustSize\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBsetTabOrder\fR ( QWidget * first, QWidget * second )" -.br -.ti -1c -.BI "QWidget * \fBmouseGrabber\fR ()" -.br -.ti -1c -.BI "QWidget * \fBkeyboardGrabber\fR ()" -.br -.ti -1c -.BI "QWidget * \fBfind\fR ( WId id )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBacceptDrops\fR - whether drop events are enabled for this widget" -.br -.ti -1c -.BI "bool \fBautoMask\fR - whether the auto mask feature is enabled for the widget" -.br -.ti -1c -.BI "QBrush \fBbackgroundBrush\fR - the widget's background brush \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "BackgroundMode \fBbackgroundMode\fR - the color role used for painting the background of the widget" -.br -.ti -1c -.BI "BackgroundOrigin \fBbackgroundOrigin\fR - the origin of the widget's background" -.br -.ti -1c -.BI "QSize \fBbaseSize\fR - the base size of the widget" -.br -.ti -1c -.BI "QString \fBcaption\fR - the window caption (title)" -.br -.ti -1c -.BI "QRect \fBchildrenRect\fR - the bounding rectangle of the widget's children \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QRegion \fBchildrenRegion\fR - the combined region occupied by the widget's children \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QColorGroup \fBcolorGroup\fR - the current color group of the widget palette \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QCursor \fBcursor\fR - the cursor shape for this widget" -.br -.ti -1c -.BI "bool \fBcustomWhatsThis\fR - whether the widget wants to handle What's This help manually \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBenabled\fR - whether the widget is enabled" -.br -.ti -1c -.BI "bool \fBfocus\fR - whether this widget (or its focus " "proxy" ") has the keyboard input focus \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBfocusEnabled\fR - whether the widget accepts keyboard focus \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "FocusPolicy \fBfocusPolicy\fR - the way the widget accepts keyboard focus" -.br -.ti -1c -.BI "QFont \fBfont\fR - the font currently set for the widget" -.br -.ti -1c -.BI "QRect \fBframeGeometry\fR - geometry of the widget relative to its parent including any window frame \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QSize \fBframeSize\fR - the size of the widget including any window frame \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBfullScreen\fR - whether the widget is full screen \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QRect \fBgeometry\fR - the geometry of the widget relative to its parent and excluding the window frame" -.br -.ti -1c -.BI "int \fBheight\fR - the height of the widget excluding any window frame \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBhidden\fR - whether the widget is explicitly hidden" -.br -.ti -1c -.BI "QPixmap \fBicon\fR - the widget's icon" -.br -.ti -1c -.BI "QString \fBiconText\fR - the widget's icon text" -.br -.ti -1c -.BI "bool \fBinputMethodEnabled\fR - enables or disables the use of input methods for this widget" -.br -.ti -1c -.BI "bool \fBisActiveWindow\fR - whether this widget is the active window \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBisDesktop\fR - whether the widget is a desktop " "widget" ", i.e. represents the desktop \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBisDialog\fR - whether the widget is a dialog widget \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBisModal\fR - whether the widget is a modal widget \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBisPopup\fR - whether the widget is a popup widget \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBisTopLevel\fR - whether the widget is a top-level widget \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBmaximized\fR - whether this widget is maximized \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBmaximumHeight\fR - the widget's maximum height" -.br -.ti -1c -.BI "QSize \fBmaximumSize\fR - the widget's maximum size" -.br -.ti -1c -.BI "int \fBmaximumWidth\fR - the widget's maximum width" -.br -.ti -1c -.BI "QRect \fBmicroFocusHint\fR - the currently set micro focus hint for this widget \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBminimized\fR - whether this widget is minimized (iconified) \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBminimumHeight\fR - the widget's minimum height" -.br -.ti -1c -.BI "QSize \fBminimumSize\fR - the widget's minimum size" -.br -.ti -1c -.BI "QSize \fBminimumSizeHint\fR - the recommended minimum size for the widget \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBminimumWidth\fR - the widget's minimum width" -.br -.ti -1c -.BI "bool \fBmouseTracking\fR - whether mouse tracking is enabled for the widget" -.br -.ti -1c -.BI "bool \fBownCursor\fR - whether the widget uses its own cursor \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBownFont\fR - whether the widget uses its own font \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBownPalette\fR - whether the widget uses its own palette \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QPalette \fBpalette\fR - the widget's palette" -.br -.ti -1c -.BI "QColor \fBpaletteBackgroundColor\fR - the background color of the widget" -.br -.ti -1c -.BI "QPixmap \fBpaletteBackgroundPixmap\fR - the background pixmap of the widget" -.br -.ti -1c -.BI "QColor \fBpaletteForegroundColor\fR - the foreground color of the widget" -.br -.ti -1c -.BI "QPoint \fBpos\fR - the position of the widget within its parent widget" -.br -.ti -1c -.BI "QRect \fBrect\fR - the internal geometry of the widget excluding any window frame \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBshown\fR - whether the widget is shown" -.br -.ti -1c -.BI "QSize \fBsize\fR - the size of the widget excluding any window frame" -.br -.ti -1c -.BI "QSize \fBsizeHint\fR - the recommended size for the widget \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QSize \fBsizeIncrement\fR - the size increment of the widget" -.br -.ti -1c -.BI "QSizePolicy \fBsizePolicy\fR - the default layout behavior of the widget" -.br -.ti -1c -.BI "bool \fBunderMouse\fR - whether the widget is under the mouse cursor \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "bool \fBupdatesEnabled\fR - whether updates are enabled" -.br -.ti -1c -.BI "bool \fBvisible\fR - whether the widget is visible \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "QRect visibleRect - the visible rectangle \fI(read " "only" ")\fR \fI(obsolete)\fR" -.br -.ti -1c -.BI "int \fBwidth\fR - the width of the widget excluding any window frame \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "double \fBwindowOpacity\fR - the level of opacity for the window" -.br -.ti -1c -.BI "int \fBx\fR - the x coordinate of the widget relative to its parent including any window frame \fI(read " "only" ")\fR" -.br -.ti -1c -.BI "int \fBy\fR - the y coordinate of the widget relative to its parent and including any window frame \fI(read " "only" ")\fR" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBevent\fR ( QEvent * e )" -.br -.ti -1c -.BI "virtual void \fBmousePressEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBmouseReleaseEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBmouseDoubleClickEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBmouseMoveEvent\fR ( QMouseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBwheelEvent\fR ( QWheelEvent * e )" -.br -.ti -1c -.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" -.br -.ti -1c -.BI "virtual void \fBkeyReleaseEvent\fR ( QKeyEvent * e )" -.br -.ti -1c -.BI "virtual void \fBfocusInEvent\fR ( QFocusEvent * )" -.br -.ti -1c -.BI "virtual void \fBfocusOutEvent\fR ( QFocusEvent * )" -.br -.ti -1c -.BI "virtual void \fBenterEvent\fR ( QEvent * )" -.br -.ti -1c -.BI "virtual void \fBleaveEvent\fR ( QEvent * )" -.br -.ti -1c -.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" -.br -.ti -1c -.BI "virtual void \fBmoveEvent\fR ( QMoveEvent * )" -.br -.ti -1c -.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * )" -.br -.ti -1c -.BI "virtual void \fBcloseEvent\fR ( QCloseEvent * e )" -.br -.ti -1c -.BI "virtual void \fBcontextMenuEvent\fR ( QContextMenuEvent * e )" -.br -.ti -1c -.BI "virtual void \fBimStartEvent\fR ( QIMEvent * e )" -.br -.ti -1c -.BI "virtual void \fBimComposeEvent\fR ( QIMEvent * e )" -.br -.ti -1c -.BI "virtual void \fBimEndEvent\fR ( QIMEvent * e )" -.br -.ti -1c -.BI "virtual void \fBtabletEvent\fR ( QTabletEvent * e )" -.br -.ti -1c -.BI "virtual void \fBdragEnterEvent\fR ( QDragEnterEvent * )" -.br -.ti -1c -.BI "virtual void \fBdragMoveEvent\fR ( QDragMoveEvent * )" -.br -.ti -1c -.BI "virtual void \fBdragLeaveEvent\fR ( QDragLeaveEvent * )" -.br -.ti -1c -.BI "virtual void \fBdropEvent\fR ( QDropEvent * )" -.br -.ti -1c -.BI "virtual void \fBshowEvent\fR ( QShowEvent * )" -.br -.ti -1c -.BI "virtual void \fBhideEvent\fR ( QHideEvent * )" -.br -.ti -1c -.BI "virtual bool \fBmacEvent\fR ( MSG * )" -.br -.ti -1c -.BI "virtual bool \fBwinEvent\fR ( MSG * )" -.br -.ti -1c -.BI "virtual bool \fBx11Event\fR ( XEvent * )" -.br -.ti -1c -.BI "virtual bool \fBqwsEvent\fR ( QWSEvent * )" -.br -.ti -1c -.BI "virtual void \fBupdateMask\fR ()" -.br -.ti -1c -.BI "virtual void \fBstyleChange\fR ( QStyle & oldStyle )" -.br -.ti -1c -.BI "virtual void \fBenabledChange\fR ( bool oldEnabled )" -.br -.ti -1c -.BI "virtual void \fBpaletteChange\fR ( const QPalette & oldPalette )" -.br -.ti -1c -.BI "virtual void \fBfontChange\fR ( const QFont & oldFont )" -.br -.ti -1c -.BI "virtual void \fBwindowActivationChange\fR ( bool oldActive )" -.br -.ti -1c -.BI "virtual int \fBmetric\fR ( int m ) const" -.br -.ti -1c -.BI "void \fBresetInputContext\fR ()" -.br -.ti -1c -.BI "virtual void \fBcreate\fR ( WId window = 0, bool initializeWindow = TRUE, bool destroyOldWindow = TRUE )" -.br -.ti -1c -.BI "virtual void \fBdestroy\fR ( bool destroyWindow = TRUE, bool destroySubWindows = TRUE )" -.br -.ti -1c -.BI "WFlags \fBgetWFlags\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetWFlags\fR ( WFlags f )" -.br -.ti -1c -.BI "void \fBclearWFlags\fR ( WFlags f )" -.br -.ti -1c -.BI "virtual bool \fBfocusNextPrevChild\fR ( bool next )" -.br -.ti -1c -.BI "QFocusData * \fBfocusData\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetKeyCompression\fR ( bool compress )" -.br -.ti -1c -.BI "virtual void \fBsetMicroFocusHint\fR ( int x, int y, int width, int height, bool text = TRUE, QFont * f = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QWidget class is the base class of all user interface objects. -.PP -The widget is the atom of the user interface: it receives mouse, keyboard and other events from the window system, and paints a representation of itself on the screen. Every widget is rectangular, and they are sorted in a Z-order. A widget is clipped by its parent and by the widgets in front of it. -.PP -A widget that isn't embedded in a parent widget is called a top-level widget. Usually, top-level widgets are windows with a frame and a title bar (although it is also possible to create top-level widgets without such decoration if suitable widget flags are used). In Qt, QMainWindow and the various subclasses of QDialog are the most common top-level windows. -.PP -A widget without a parent widget is always a top-level widget. -.PP -Non-top-level widgets are child widgets. These are child windows in their parent widgets. You cannot usually distinguish a child widget from its parent visually. Most other widgets in Qt are useful only as child widgets. (It is possible to make, say, a button into a top-level widget, but most people prefer to put their buttons inside other widgets, e.g. QDialog.) -.PP -If you want to use a QWidget to hold child widgets you will probably want to add a layout to the parent QWidget. (See Layouts.) -.PP -QWidget has many member functions, but some of them have little direct functionality: for example, QWidget has a font property, but never uses this itself. There are many subclasses which provide real functionality, such as QPushButton, QListBox and QTabDialog, etc. -.SH "Groups of functions:" -<center>.nf -.TS -l - l. Context Functions Window functions show(), hide(), raise(), lower(), close(). Top level windows caption(), setCaption(), icon(), setIcon(), iconText(), setIconText(), isActiveWindow(), setActiveWindow(), showMinimized(). showMaximized(), showFullScreen(), showNormal(). Window contents update(), repaint(), erase(), scroll(), updateMask(). Geometry pos(), size(), rect(), x(), y(), width(), height(), sizePolicy(), setSizePolicy(), sizeHint(), updateGeometry(), layout(), move(), resize(), setGeometry(), frameGeometry(), geometry(), childrenRect(), adjustSize(), mapFromGlobal(), mapFromParent() mapToGlobal(), mapToParent(), maximumSize(), minimumSize(), sizeIncrement(), setMaximumSize(), setMinimumSize(), setSizeIncrement(), setBaseSize(), setFixedSize() Mode isVisible(), isVisibleTo(), isMinimized(), isDesktop(), isEnabled(), isEnabledTo(), isModal(), isPopup(), isTopLevel(), setEnabled(), hasMouseTracking(), setMouseTracking(), isUpdatesEnabled(), setUpdatesEnabled(), clipRegion(). Look and feel style(), setStyle(), cursor(), setCursor() font(), setFont(), palette(), setPalette(), backgroundMode(), setBackgroundMode(), colorGroup(), fontMetrics(), fontInfo(). Keyboard focus -.br -functions isFocusEnabled(), setFocusPolicy(), focusPolicy(), hasFocus(), setFocus(), clearFocus(), setTabOrder(), setFocusProxy(). Mouse and -.br -keyboard grabbing grabMouse(), releaseMouse(), grabKeyboard(), releaseKeyboard(), mouseGrabber(), keyboardGrabber(). Event handlers event(), mousePressEvent(), mouseReleaseEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), keyPressEvent(), keyReleaseEvent(), focusInEvent(), focusOutEvent(), wheelEvent(), enterEvent(), leaveEvent(), paintEvent(), moveEvent(), resizeEvent(), closeEvent(), dragEnterEvent(), dragMoveEvent(), dragLeaveEvent(), dropEvent(), childEvent(), showEvent(), hideEvent(), customEvent(). Change handlers enabledChange(), fontChange(), paletteChange(), styleChange(), windowActivationChange(). System functions parentWidget(), topLevelWidget(), reparent(), polish(), winId(), find(), metric(). What's this help customWhatsThis() Internal kernel -.br -functions -.TE -.fi -</center> -.PP -Every widget's constructor accepts two or three standard arguments: <ol type=1> -.IP 1 -\fCQWidget *parent = 0\fR is the parent of the new widget. If it is 0 (the default), the new widget will be a top-level window. If not, it will be a child of \fIparent\fR, and be constrained by \fIparent\fR's geometry (unless you specify WType_TopLevel as widget flag). -.IP 2 -\fCconst char *name = 0\fR is the widget name of the new widget. You can access it using name(). The widget name is little used by programmers but is quite useful with GUI builders such as \fIQt Designer\fR (you can name a widget in \fIQt Designer\fR, and connect() to it using the name in your code). The dumpObjectTree() debugging function also uses it. -.IP 3 -\fCWFlags f = 0\fR (where available) sets the widget flags; the default is suitable for almost all widgets, but to get, for example, a top-level widget without a window system frame, you must use special flags. -.PP -The tictac/tictac.cpp example program is good example of a simple widget. It contains a few event handlers (as all widgets must), a few custom routines that are specific to it (as all useful widgets do), and has a few children and connections. Everything it does is done in response to an event: this is by far the most common way to design GUI applications. -.PP -You will need to supply the content for your widgets yourself, but here is a brief run-down of the events, starting with the most common ones: -.IP -.TP -paintEvent() - called whenever the widget needs to be repainted. Every widget which displays output must implement it, and it is wise \fInot\fR to paint on the screen outside paintEvent(). -.IP -.TP -resizeEvent() - called when the widget has been resized. -.IP -.TP -mousePressEvent() - called when a mouse button is pressed. There are six mouse-related events, but the mouse press and mouse release events are by far the most important. A widget receives mouse press events when the mouse is inside it, or when it has grabbed the mouse using grabMouse(). -.IP -.TP -mouseReleaseEvent() - called when a mouse button is released. A widget receives mouse release events when it has received the corresponding mouse press event. This means that if the user presses the mouse inside \fIyour\fR widget, then drags the mouse to somewhere else, then releases, \fIyour\fR widget receives the release event. There is one exception: if a popup menu appears while the mouse button is held down, this popup immediately steals the mouse events. -.IP -.TP -mouseDoubleClickEvent() - not quite as obvious as it might seem. If the user double-clicks, the widget receives a mouse press event (perhaps a mouse move event or two if they don't hold the mouse quite steady), a mouse release event and finally this event. It is \fInot possible\fR to distinguish a click from a double click until you've seen whether the second click arrives. (This is one reason why most GUI books recommend that double clicks be an extension of single clicks, rather than trigger a different action.) -.IP -.PP -If your widget only contains child widgets, you probably do not need to implement any event handlers. If you want to detect a mouse click in a child widget call the child's hasMouse() function inside the parent widget's mousePressEvent(). -.PP -Widgets that accept keyboard input need to reimplement a few more event handlers: -.IP -.TP -keyPressEvent() - called whenever a key is pressed, and again when a key has been held down long enough for it to auto-repeat. Note that the Tab and Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement QWidget::event(). -.IP -.TP -focusInEvent() - called when the widget gains keyboard focus (assuming you have called setFocusPolicy()). Well written widgets indicate that they own the keyboard focus in a clear but discreet way. -.IP -.TP -focusOutEvent() - called when the widget loses keyboard focus. -.IP -.PP -Some widgets will also need to reimplement some of the less common event handlers: -.IP -.TP -mouseMoveEvent() - called whenever the mouse moves while a button is held down. This is useful for, for example, dragging. If you call setMouseTracking(TRUE), you get mouse move events even when no buttons are held down. (Note that applications which make use of mouse tracking are often not very useful on low-bandwidth X connections.) (See also the drag and drop information.) -.IP -.TP -keyReleaseEvent() - called whenever a key is released, and also while it is held down if the key is auto-repeating. In that case the widget receives a key release event and immediately a key press event for every repeat. Note that the Tab and Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement QWidget::event(). -.IP -.TP -wheelEvent() -- called whenever the user turns the mouse wheel while the widget has the focus. -.IP -.TP -enterEvent() - called when the mouse enters the widget's screen space. (This excludes screen space owned by any children of the widget.) -.IP -.TP -leaveEvent() - called when the mouse leaves the widget's screen space. -.IP -.TP -moveEvent() - called when the widget has been moved relative to its parent. -.IP -.TP -closeEvent() - called when the user closes the widget (or when close() is called). -.IP -.PP -There are also some rather obscure events. They are listed in ntqevent.h and you need to reimplement event() to handle them. The default implementation of event() handles Tab and Shift+Tab (to move the keyboard focus), and passes on most other events to one of the more specialized handlers above. -.PP -When implementing a widget, there are a few more things to consider. -.IP -.TP -In the constructor, be sure to set up your member variables early on, before there's any chance that you might receive an event. -.IP -.TP -It is almost always useful to reimplement sizeHint() and to set the correct size policy with setSizePolicy(), so users of your class can set up layout management more easily. A size policy lets you supply good defaults for the layout management handling, so that other widgets can contain and manage yours easily. sizeHint() indicates a "good" size for the widget. -.IP -.TP -If your widget is a top-level window, setCaption() and setIcon() set the title bar and icon respectively. -.IP -.PP -See also QEvent, QPainter, QGridLayout, QBoxLayout, and Abstract Widget Classes. -.SS "Member Type Documentation" -.SH "QWidget::BackgroundOrigin" -This enum defines the origin used to draw a widget's background pixmap. -.PP -The pixmap is drawn using the: -.TP -\fCQWidget::WidgetOrigin\fR - widget's coordinate system. -.TP -\fCQWidget::ParentOrigin\fR - parent's coordinate system. -.TP -\fCQWidget::WindowOrigin\fR - top-level window's coordinate system. -.TP -\fCQWidget::AncestorOrigin\fR - same origin as the parent uses. -.SH "QWidget::FocusPolicy" -This enum type defines the various policies a widget can have with respect to acquiring keyboard focus. -.TP -\fCQWidget::TabFocus\fR - the widget accepts focus by tabbing. -.TP -\fCQWidget::ClickFocus\fR - the widget accepts focus by clicking. -.TP -\fCQWidget::StrongFocus\fR - the widget accepts focus by both tabbing and clicking. On Mac OS X this will also be indicate that the widget accepts tab focus when in 'Text/List focus mode'. -.TP -\fCQWidget::WheelFocus\fR - like StrongFocus plus the widget accepts focus by using the mouse wheel. -.TP -\fCQWidget::NoFocus\fR - the widget does not accept focus. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "explicit QWidget::QWidget ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Constructs a widget which is a child of \fIparent\fR, with the name \fIname\fR and widget flags set to \fIf\fR. -.PP -If \fIparent\fR is 0, the new widget becomes a top-level window. If \fIparent\fR is another widget, this widget becomes a child window inside \fIparent\fR. The new widget is deleted when its \fIparent\fR is deleted. -.PP -The \fIname\fR is sent to the QObject constructor. -.PP -The widget flags argument, \fIf\fR, is normally 0, but it can be set to customize the window frame of a top-level widget (i.e. \fIparent\fR must be 0). To customize the frame, set the WStyle_Customize flag OR'ed with any of the Qt::WidgetFlags. -.PP -If you add a child widget to an already visible widget you must explicitly show the child to make it visible. -.PP -Note that the X11 version of Qt may not be able to deliver all combinations of style flags on all systems. This is because on X11, Qt can only ask the window manager, and the window manager can override the application's settings. On Windows, Qt can set whatever flags you want. -.PP -Example: -.PP -.nf -.br - QLabel *splashScreen = new QLabel( 0, "mySplashScreen", -.br - WStyle_Customize | WStyle_Splash ); -.br -.fi -.SH "QWidget::~QWidget ()" -Destroys the widget. -.PP -All this widget's children are deleted first. The application exits if this widget is the main widget. -.SH "bool QWidget::acceptDrops () const" -Returns TRUE if drop events are enabled for this widget; otherwise returns FALSE. See the "acceptDrops" property for details. -.SH "void QWidget::adjustSize ()\fC [virtual slot]\fR" -Adjusts the size of the widget to fit the contents. -.PP -Uses sizeHint() if valid (i.e if the size hint's width and height are >= 0), otherwise sets the size to the children rectangle (the union of all child widget geometries). -.PP -See also sizeHint and childrenRect. -.PP -Example: xform/xform.cpp. -.PP -Reimplemented in QMessageBox. -.SH "bool QWidget::autoMask () const" -Returns TRUE if the auto mask feature is enabled for the widget; otherwise returns FALSE. See the "autoMask" property for details. -.SH "const QBrush & QWidget::backgroundBrush () const" -Returns the widget's background brush. See the "backgroundBrush" property for details. -.SH "const QColor & QWidget::backgroundColor () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use paletteBackgroundColor() or eraseColor() instead. -.SH "BackgroundMode QWidget::backgroundMode () const" -Returns the color role used for painting the background of the widget. See the "backgroundMode" property for details. -.SH "BackgroundOrigin QWidget::backgroundOrigin () const" -Returns the origin of the widget's background. See the "backgroundOrigin" property for details. -.SH "const QPixmap * QWidget::backgroundPixmap () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use paletteBackgroundPixmap() or erasePixmap() instead. -.PP -Examples: -.)l themes/metal.cpp and themes/wood.cpp. -.SH "QSize QWidget::baseSize () const" -Returns the base size of the widget. See the "baseSize" property for details. -.SH "QString QWidget::caption () const" -Returns the window caption (title). See the "caption" property for details. -.SH "QWidget * QWidget::childAt ( int x, int y, bool includeThis = FALSE ) const" -Returns the visible child widget at pixel position \fI(x, y)\fR in the widget's own coordinate system. -.PP -If \fIincludeThis\fR is TRUE, and there is no child visible at \fI(x, y)\fR, the widget itself is returned. -.SH "QWidget * QWidget::childAt ( const QPoint & p, bool includeThis = FALSE ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the visible child widget at point \fIp\fR in the widget's own coordinate system. -.PP -If \fIincludeThis\fR is TRUE, and there is no child visible at \fIp\fR, the widget itself is returned. -.SH "QRect QWidget::childrenRect () const" -Returns the bounding rectangle of the widget's children. See the "childrenRect" property for details. -.SH "QRegion QWidget::childrenRegion () const" -Returns the combined region occupied by the widget's children. See the "childrenRegion" property for details. -.SH "void QWidget::clearFocus ()\fC [slot]\fR" -Takes keyboard input focus from the widget. -.PP -If the widget has active focus, a focus out event is sent to this widget to tell it that it is about to lose the focus. -.PP -This widget must enable focus setting in order to get the keyboard input focus, i.e. it must call setFocusPolicy(). -.PP -See also focus, setFocus(), focusInEvent(), focusOutEvent(), focusPolicy, and QApplication::focusWidget(). -.SH "void QWidget::clearMask ()" -Removes any mask set by setMask(). -.PP -See also setMask(). -.SH "void QWidget::clearWFlags ( WFlags f )\fC [protected]\fR" -Clears the widget flags \fIf\fR. -.PP -Widget flags are a combination of Qt::WidgetFlags. -.PP -See also testWFlags(), getWFlags(), and setWFlags(). -.SH "QRegion QWidget::clipRegion () const" -Returns the unobscured region where paint events can occur. -.PP -For visible widgets, this is an approximation of the area not covered by other widgets; otherwise, this is an empty region. -.PP -The repaint() function calls this function if necessary, so in general you do not need to call it. -.SH "bool QWidget::close ()\fC [slot]\fR" -Closes this widget. Returns TRUE if the widget was closed; otherwise returns FALSE. -.PP -First it sends the widget a QCloseEvent. The widget is hidden if it accepts the close event. The default implementation of QWidget::closeEvent() accepts the close event. -.PP -The QApplication::lastWindowClosed() signal is emitted when the last visible top level widget is closed. -.PP -Examples: -.)l dialog/mainwindow.cpp, mdi/application.cpp, popup/popup.cpp, and toplevel/options.ui.h. -.SH "bool QWidget::close ( bool alsoDelete )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Closes this widget. Returns TRUE if the widget was closed; otherwise returns FALSE. -.PP -If \fIalsoDelete\fR is TRUE or the widget has the WDestructiveClose widget flag, the widget is also deleted. The widget can prevent itself from being closed by rejecting the QCloseEvent it gets. A close events is delivered to the widget no matter if the widget is visible or not. -.PP -The QApplication::lastWindowClosed() signal is emitted when the last visible top level widget is closed. -.PP -Note that closing the QApplication::mainWidget() terminates the application. -.PP -See also closeEvent(), QCloseEvent, hide(), QApplication::quit(), QApplication::setMainWidget(), and QApplication::lastWindowClosed(). -.SH "void QWidget::closeEvent ( QCloseEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive widget close events. -.PP -The default implementation calls e->accept(), which hides this widget. See the QCloseEvent documentation for more details. -.PP -See also event(), hide(), close(), and QCloseEvent. -.PP -Examples: -.)l action/application.cpp, application/application.cpp, chart/chartform.cpp, i18n/mywidget.cpp, mdi/application.cpp, popup/popup.cpp, and qwerty/qwerty.cpp. -.SH "const QColorGroup & QWidget::colorGroup () const" -Returns the current color group of the widget palette. See the "colorGroup" property for details. -.SH "void QWidget::constPolish () const\fC [slot]\fR" -Ensures that the widget is properly initialized by calling polish(). -.PP -Call constPolish() from functions like sizeHint() that depends on the widget being initialized, and that may be called before show(). -.PP -\fBWarning:\fR Do not call constPolish() on a widget from inside that widget's constructor. -.PP -See also polish(). -.SH "void QWidget::contextMenuEvent ( QContextMenuEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive widget context menu events. -.PP -The default implementation calls e->ignore(), which rejects the context event. See the QContextMenuEvent documentation for more details. -.PP -See also event() and QContextMenuEvent. -.PP -Example: menu/menu.cpp. -.SH "void QWidget::create ( WId window = 0, bool initializeWindow = TRUE, bool destroyOldWindow = TRUE )\fC [virtual protected]\fR" -Creates a new widget window if \fIwindow\fR is 0, otherwise sets the widget's window to \fIwindow\fR. -.PP -Initializes the window (sets the geometry etc.) if \fIinitializeWindow\fR is TRUE. If \fIinitializeWindow\fR is FALSE, no initialization is performed. This parameter only makes sense if \fIwindow\fR is a valid window. -.PP -Destroys the old window if \fIdestroyOldWindow\fR is TRUE. If \fIdestroyOldWindow\fR is FALSE, you are responsible for destroying the window yourself (using platform native code). -.PP -The QWidget constructor calls create(0,TRUE,TRUE) to create a window for this widget. -.SH "const QCursor & QWidget::cursor () const" -Returns the cursor shape for this widget. See the "cursor" property for details. -.SH "bool QWidget::customWhatsThis () const\fC [virtual]\fR" -Returns TRUE if the widget wants to handle What's This help manually; otherwise returns FALSE. See the "customWhatsThis" property for details. -.SH "void QWidget::destroy ( bool destroyWindow = TRUE, bool destroySubWindows = TRUE )\fC [virtual protected]\fR" -Frees up window system resources. Destroys the widget window if \fIdestroyWindow\fR is TRUE. -.PP -destroy() calls itself recursively for all the child widgets, passing \fIdestroySubWindows\fR for the \fIdestroyWindow\fR parameter. To have more control over destruction of subwidgets, destroy subwidgets selectively first. -.PP -This function is usually called from the QWidget destructor. -.SH "void QWidget::dragEnterEvent ( QDragEnterEvent * )\fC [virtual protected]\fR" -This event handler is called when a drag is in progress and the mouse enters this widget. -.PP -See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. -.PP -See also QTextDrag, QImageDrag, and QDragEnterEvent. -.PP -Example: iconview/simple_dd/main.cpp. -.SH "void QWidget::dragLeaveEvent ( QDragLeaveEvent * )\fC [virtual protected]\fR" -This event handler is called when a drag is in progress and the mouse leaves this widget. -.PP -See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. -.PP -See also QTextDrag, QImageDrag, and QDragLeaveEvent. -.SH "void QWidget::dragMoveEvent ( QDragMoveEvent * )\fC [virtual protected]\fR" -This event handler is called when a drag is in progress and the mouse enters this widget, and whenever it moves within the widget. -.PP -See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. -.PP -See also QTextDrag, QImageDrag, and QDragMoveEvent. -.SH "void QWidget::drawText ( int x, int y, const QString & str )" -Draws the string \fIstr\fR at position \fI(x, y)\fR. -.PP -The \fIy\fR position is the base line position of the text. The text is drawn using the default font and the default foreground color. -.PP -This function is provided for convenience. You will generally get more flexible results and often higher speed by using a a painter instead. -.PP -See also font, foregroundColor(), and QPainter::drawText(). -.SH "void QWidget::drawText ( const QPoint & pos, const QString & str )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Draws the string \fIstr\fR at position \fIpos\fR. -.SH "void QWidget::dropEvent ( QDropEvent * )\fC [virtual protected]\fR" -This event handler is called when the drag is dropped on this widget. -.PP -See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. -.PP -See also QTextDrag, QImageDrag, and QDropEvent. -.PP -Example: iconview/simple_dd/main.cpp. -.SH "void QWidget::enabledChange ( bool oldEnabled )\fC [virtual protected]\fR" -This virtual function is called from setEnabled(). \fIoldEnabled\fR is the previous setting; you can get the new setting from isEnabled(). -.PP -Reimplement this function if your widget needs to know when it becomes enabled or disabled. You will almost certainly need to update the widget using update(). -.PP -The default implementation repaints the visible part of the widget. -.PP -See also enabled, enabled, repaint(), update(), and clipRegion(). -.SH "void QWidget::enterEvent ( QEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive widget enter events. -.PP -An event is sent to the widget when the mouse cursor enters the widget. -.PP -See also leaveEvent(), mouseMoveEvent(), and event(). -.SH "void QWidget::erase ( int x, int y, int w, int h )" -Erases the specified area \fI(x, y, w, h)\fR in the widget without generating a paint event. -.PP -If \fIw\fR is negative, it is replaced with \fCwidth() - x\fR. If \fIh\fR is negative, it is replaced width \fCheight() - y\fR. -.PP -Child widgets are not affected. -.PP -See also repaint(). -.SH "void QWidget::erase ()" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version erases the entire widget. -.SH "void QWidget::erase ( const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Erases the specified area \fIr\fR in the widget without generating a paint event. -.SH "void QWidget::erase ( const QRegion & reg )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Erases the area defined by \fIreg\fR, without generating a paint event. -.PP -Child widgets are not affected. -.SH "const QColor & QWidget::eraseColor () const" -Returns the erase color of the widget. -.PP -See also setEraseColor(), setErasePixmap(), and backgroundColor(). -.SH "const QPixmap * QWidget::erasePixmap () const" -Returns the widget's erase pixmap. -.PP -See also setErasePixmap() and eraseColor(). -.SH "bool QWidget::event ( QEvent * e )\fC [virtual protected]\fR" -This is the main event handler; it handles event \fIe\fR. You can reimplement this function in a subclass, but we recommend using one of the specialized event handlers instead. -.PP -The main event handler first passes an event through all event filters that have been installed. If none of the filters intercept the event, it calls one of the specialized event handlers. -.PP -Key press and release events are treated differently from other events. event() checks for Tab and Shift+Tab and tries to move the focus appropriately. If there is no widget to move the focus to (or the key press is not Tab or Shift+Tab), event() calls keyPressEvent(). -.PP -This function returns TRUE if it is able to pass the event over to someone (i.e. someone wanted the event); otherwise returns FALSE. -.PP -See also closeEvent(), focusInEvent(), focusOutEvent(), enterEvent(), keyPressEvent(), keyReleaseEvent(), leaveEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), moveEvent(), paintEvent(), resizeEvent(), QObject::event(), and QObject::timerEvent(). -.PP -Reimplemented from QObject. -.SH "QWidget * QWidget::find ( WId id )\fC [static]\fR" -Returns a pointer to the widget with window identifer/handle \fIid\fR. -.PP -The window identifier type depends on the underlying window system, see ntqwindowdefs.h for the actual definition. If there is no widget with this identifier, 0 is returned. -.SH "QFocusData * QWidget::focusData ()\fC [protected]\fR" -Returns the focus data for this widget's top-level widget. -.PP -Focus data always belongs to the top-level widget. The focus data list contains all the widgets in this top-level widget that can accept focus, in tab order. An iterator points to the current focus widget (focusWidget() returns a pointer to this widget). -.PP -This information is useful for implementing advanced versions of focusNextPrevChild(). -.SH "void QWidget::focusInEvent ( QFocusEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget. -.PP -A widget normally must setFocusPolicy() to something other than NoFocus in order to receive focus events. (Note that the application programmer can call setFocus() on any widget, even those that do not normally accept focus.) -.PP -The default implementation updates the widget (except for toplevel widgets that do not specify a focusPolicy() ). It also calls setMicroFocusHint(), hinting any system-specific input tools about the focus of the user's attention. -.PP -See also focusOutEvent(), focusPolicy, keyPressEvent(), keyReleaseEvent(), event(), and QFocusEvent. -.SH "bool QWidget::focusNextPrevChild ( bool next )\fC [virtual protected]\fR" -Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns TRUE if is can find a new widget and FALSE if it can't, -.PP -If \fInext\fR is TRUE, this function searches "forwards", if \fInext\fR is FALSE, it searches "backwards". -.PP -Sometimes, you will want to reimplement this function. For example, a web browser might reimplement it to move its "current active link" forwards or backwards, and call QWidget::focusNextPrevChild() only when it reaches the last or first link on the "page". -.PP -Child widgets call focusNextPrevChild() on their parent widgets, but only the top-level widget decides where to redirect focus. By overriding this method for an object, you thus gain control of focus traversal for all child widgets. -.PP -\fBWarning:\fR QScrollView uses it own logic for this function, which does the right thing in most cases. But if you are using a QScrollView and want complete control of the focus chain you'll need to override QScrollView::focusNextPrevChild() and your top-level widgets' focusNextPrevChild() functions. -.PP -See also focusData(). -.SH "void QWidget::focusOutEvent ( QFocusEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget. -.PP -A widget normally must setFocusPolicy() to something other than NoFocus in order to receive focus events. (Note that the application programmer can call setFocus() on any widget, even those that do not normally accept focus.) -.PP -The default implementation updates the widget (except for toplevel widgets that do not specify a focusPolicy() ). It also calls setMicroFocusHint(), hinting any system-specific input tools about the focus of the user's attention. -.PP -See also focusInEvent(), focusPolicy, keyPressEvent(), keyReleaseEvent(), event(), and QFocusEvent. -.PP -Example: qmag/qmag.cpp. -.SH "FocusPolicy QWidget::focusPolicy () const" -Returns the way the widget accepts keyboard focus. See the "focusPolicy" property for details. -.SH "QWidget * QWidget::focusProxy () const" -Returns the focus proxy, or 0 if there is no focus proxy. -.PP -See also setFocusProxy(). -.SH "QWidget * QWidget::focusWidget () const" -Returns the focus widget in this widget's window. This is not the same as QApplication::focusWidget(), which returns the focus widget in the currently active window. -.SH "QFont QWidget::font () const" -Returns the font currently set for the widget. See the "font" property for details. -.SH "void QWidget::fontChange ( const QFont & oldFont )\fC [virtual protected]\fR" -This virtual function is called from setFont(). \fIoldFont\fR is the previous font; you can get the new font from font(). -.PP -Reimplement this function if your widget needs to know when its font changes. You will almost certainly need to update the widget using update(). -.PP -The default implementation updates the widget including its geometry. -.PP -See also font, font, update(), and updateGeometry(). -.SH "QFontInfo QWidget::fontInfo () const" -Returns the font info for the widget's current font. Equivalent to QFontInto(widget->font()). -.PP -See also font, fontMetrics(), and font. -.SH "QFontMetrics QWidget::fontMetrics () const" -Returns the font metrics for the widget's current font. Equivalent to QFontMetrics(widget->font()). -.PP -See also font, fontInfo(), and font. -.PP -Examples: -.)l drawdemo/drawdemo.cpp and qmag/qmag.cpp. -.SH "const QColor & QWidget::foregroundColor () const" -Same as paletteForegroundColor() -.SH "QRect QWidget::frameGeometry () const" -Returns geometry of the widget relative to its parent including any window frame. See the "frameGeometry" property for details. -.SH "QSize QWidget::frameSize () const" -Returns the size of the widget including any window frame. See the "frameSize" property for details. -.SH "const QRect & QWidget::geometry () const" -Returns the geometry of the widget relative to its parent and excluding the window frame. See the "geometry" property for details. -.SH "WFlags QWidget::getWFlags () const\fC [protected]\fR" -Returns the widget flags for this this widget. -.PP -Widget flags are a combination of Qt::WidgetFlags. -.PP -See also testWFlags(), setWFlags(), and clearWFlags(). -.SH "void QWidget::grabKeyboard ()" -Grabs the keyboard input. -.PP -This widget reveives all keyboard events until releaseKeyboard() is called; other widgets get no keyboard events at all. Mouse events are not affected. Use grabMouse() if you want to grab that. -.PP -The focus widget is not affected, except that it doesn't receive any keyboard events. setFocus() moves the focus as usual, but the new focus widget receives keyboard events only after releaseKeyboard() is called. -.PP -If a different widget is currently grabbing keyboard input, that widget's grab is released first. -.PP -See also releaseKeyboard(), grabMouse(), releaseMouse(), and focusWidget(). -.SH "void QWidget::grabMouse ()" -Grabs the mouse input. -.PP -This widget receives all mouse events until releaseMouse() is called; other widgets get no mouse events at all. Keyboard events are not affected. Use grabKeyboard() if you want to grab that. -.PP -\fBWarning:\fR Bugs in mouse-grabbing applications very often lock the terminal. Use this function with extreme caution, and consider using the \fC-nograb\fR command line option while debugging. -.PP -It is almost never necessary to grab the mouse when using Qt, as Qt grabs and releases it sensibly. In particular, Qt grabs the mouse when a mouse button is pressed and keeps it until the last button is released. -.PP -Note that only visible widgets can grab mouse input. If isVisible() returns FALSE for a widget, that widget cannot call grabMouse(). -.PP -See also releaseMouse(), grabKeyboard(), releaseKeyboard(), grabKeyboard(), and focusWidget(). -.SH "void QWidget::grabMouse ( const QCursor & cursor )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Grabs the mouse input and changes the cursor shape. -.PP -The cursor will assume shape \fIcursor\fR (for as long as the mouse focus is grabbed) and this widget will be the only one to receive mouse events until releaseMouse() is called(). -.PP -\fBWarning:\fR Grabbing the mouse might lock the terminal. -.PP -See also releaseMouse(), grabKeyboard(), releaseKeyboard(), and cursor. -.SH "bool QWidget::hasFocus () const" -Returns TRUE if this widget (or its focus proxy) has the keyboard input focus; otherwise returns FALSE. See the "focus" property for details. -.SH "bool QWidget::hasMouse () const" -Returns TRUE if the widget is under the mouse cursor; otherwise returns FALSE. See the "underMouse" property for details. -.SH "bool QWidget::hasMouseTracking () const" -Returns TRUE if mouse tracking is enabled for the widget; otherwise returns FALSE. See the "mouseTracking" property for details. -.SH "int QWidget::height () const" -Returns the height of the widget excluding any window frame. See the "height" property for details. -.SH "int QWidget::heightForWidth ( int w ) const\fC [virtual]\fR" -Returns the preferred height for this widget, given the width \fIw\fR. The default implementation returns 0, indicating that the preferred height does not depend on the width. -.PP -\fBWarning:\fR Does not look at the widget's layout. -.PP -Reimplemented in QMenuBar and QTextEdit. -.SH "void QWidget::hide ()\fC [virtual slot]\fR" -Hides the widget. -.PP -You almost never have to reimplement this function. If you need to do something after a widget is hidden, use hideEvent() instead. -.PP -See also hideEvent(), hidden, show(), showMinimized(), visible, and close(). -.PP -Examples: -.)l mdi/application.cpp, popup/popup.cpp, progress/progress.cpp, scrollview/scrollview.cpp, webbrowser/mainwindow.ui.h, and xform/xform.cpp. -.PP -Reimplemented in QMenuBar. -.SH "void QWidget::hideEvent ( QHideEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive widget hide events. -.PP -Hide events are sent to widgets immediately after they have been hidden. -.PP -See also event() and QHideEvent. -.PP -Reimplemented in QScrollBar. -.SH "const QPixmap * QWidget::icon () const" -Returns the widget's icon. See the "icon" property for details. -.SH "QString QWidget::iconText () const" -Returns the widget's icon text. See the "iconText" property for details. -.SH "void QWidget::iconify ()\fC [slot]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void QWidget::imComposeEvent ( QIMEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the user has entered some text using an Input Method. -.PP -The default implementation calls e->ignore(), which rejects the Input Method event. See the QIMEvent documentation for more details. -.PP -See also event() and QIMEvent. -.SH "void QWidget::imEndEvent ( QIMEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the user has finished inputting text via an Input Method. -.PP -The default implementation calls e->ignore(), which rejects the Input Method event. See the QIMEvent documentation for more details. -.PP -See also event() and QIMEvent. -.SH "void QWidget::imStartEvent ( QIMEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the user begins entering text using an Input Method. -.PP -The default implementation calls e->ignore(), which rejects the Input Method event. See the QIMEvent documentation for more details. -.PP -See also event() and QIMEvent. -.SH "bool QWidget::isActiveWindow () const" -Returns TRUE if this widget is the active window; otherwise returns FALSE. See the "isActiveWindow" property for details. -.SH "bool QWidget::isDesktop () const" -Returns TRUE if the widget is a desktop widget, i.e. represents the desktop; otherwise returns FALSE. See the "isDesktop" property for details. -.SH "bool QWidget::isDialog () const" -Returns TRUE if the widget is a dialog widget; otherwise returns FALSE. See the "isDialog" property for details. -.SH "bool QWidget::isEnabled () const" -Returns TRUE if the widget is enabled; otherwise returns FALSE. See the "enabled" property for details. -.SH "bool QWidget::isEnabledTo ( QWidget * ancestor ) const" -Returns TRUE if this widget would become enabled if \fIancestor\fR is enabled; otherwise returns FALSE. -.PP -This is the case if neither the widget itself nor every parent up to but excluding \fIancestor\fR has been explicitly disabled. -.PP -isEnabledTo(0) is equivalent to isEnabled(). -.PP -See also enabled and enabled. -.SH "bool QWidget::isEnabledToTLW () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function is deprecated. It is equivalent to isEnabled() -.SH "bool QWidget::isFocusEnabled () const" -Returns TRUE if the widget accepts keyboard focus; otherwise returns FALSE. See the "focusEnabled" property for details. -.SH "bool QWidget::isFullScreen () const" -Returns TRUE if the widget is full screen; otherwise returns FALSE. See the "fullScreen" property for details. -.SH "bool QWidget::isHidden () const" -Returns TRUE if the widget is explicitly hidden; otherwise returns FALSE. See the "hidden" property for details. -.SH "bool QWidget::isInputMethodEnabled () const" -Returns enables or disables the use of input methods for this widget. See the "inputMethodEnabled" property for details. -.SH "bool QWidget::isMaximized () const" -Returns TRUE if this widget is maximized; otherwise returns FALSE. See the "maximized" property for details. -.SH "bool QWidget::isMinimized () const" -Returns TRUE if this widget is minimized (iconified); otherwise returns FALSE. See the "minimized" property for details. -.SH "bool QWidget::isModal () const" -Returns TRUE if the widget is a modal widget; otherwise returns FALSE. See the "isModal" property for details. -.SH "bool QWidget::isPopup () const" -Returns TRUE if the widget is a popup widget; otherwise returns FALSE. See the "isPopup" property for details. -.SH "bool QWidget::isShown () const" -Returns TRUE if the widget is shown; otherwise returns FALSE. See the "shown" property for details. -.SH "bool QWidget::isTopLevel () const" -Returns TRUE if the widget is a top-level widget; otherwise returns FALSE. See the "isTopLevel" property for details. -.SH "bool QWidget::isUpdatesEnabled () const" -Returns TRUE if updates are enabled; otherwise returns FALSE. See the "updatesEnabled" property for details. -.SH "bool QWidget::isVisible () const" -Returns TRUE if the widget is visible; otherwise returns FALSE. See the "visible" property for details. -.SH "bool QWidget::isVisibleTo ( QWidget * ancestor ) const" -Returns TRUE if this widget would become visible if \fIancestor\fR is shown; otherwise returns FALSE. -.PP -The TRUE case occurs if neither the widget itself nor any parent up to but excluding \fIancestor\fR has been explicitly hidden. -.PP -This function will still return TRUE if the widget is obscured by other windows on the screen, but could be physically visible if it or they were to be moved. -.PP -isVisibleTo(0) is identical to isVisible(). -.PP -See also show(), hide(), and visible. -.SH "bool QWidget::isVisibleToTLW () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This function is deprecated. It is equivalent to isVisible() -.SH "void QWidget::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive key press events for the widget. -.PP -A widget must call setFocusPolicy() to accept focus initially and have focus in order to receive a key press event. -.PP -If you reimplement this handler, it is very important that you explicitly ignore the event if you do not understand it, so that the widget's parent can interpret it; otherwise, the event will be implicitly accepted. Although top-level widgets are able to choose whether to accept or ignore unknown events because they have no parent widgets that could otherwise handle them, it is good practice to explicitly ignore events to make widgets as reusable as possible. -.PP -The default implementation closes popup widgets if the user presses \fBEsc\fR. Otherwise the event is ignored. -.PP -See also keyReleaseEvent(), QKeyEvent::ignore(), focusPolicy, focusInEvent(), focusOutEvent(), event(), and QKeyEvent. -.PP -Example: picture/picture.cpp. -.PP -Reimplemented in QLineEdit and QTextEdit. -.SH "void QWidget::keyReleaseEvent ( QKeyEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive key release events for the widget. -.PP -A widget must accept focus initially and have focus in order to receive a key release event. -.PP -If you reimplement this handler, it is very important that you ignore() the release if you do not understand it, so that the widget's parent can interpret it. -.PP -The default implementation ignores the event. -.PP -See also keyPressEvent(), QKeyEvent::ignore(), focusPolicy, focusInEvent(), focusOutEvent(), event(), and QKeyEvent. -.SH "QWidget * QWidget::keyboardGrabber ()\fC [static]\fR" -Returns the widget that is currently grabbing the keyboard input. -.PP -If no widget in this application is currently grabbing the keyboard, 0 is returned. -.PP -See also grabMouse() and mouseGrabber(). -.SH "QLayout * QWidget::layout () const" -Returns the layout engine that manages the geometry of this widget's children. -.PP -If the widget does not have a layout, layout() returns 0. -.PP -See also sizePolicy. -.PP -Examples: -.)l chart/optionsform.cpp and fonts/simple-qfont-demo/viewer.cpp. -.SH "void QWidget::leaveEvent ( QEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive widget leave events. -.PP -A leave event is sent to the widget when the mouse cursor leaves the widget. -.PP -See also enterEvent(), mouseMoveEvent(), and event(). -.SH "void QWidget::lower ()\fC [slot]\fR" -Lowers the widget to the bottom of the parent widget's stack. -.PP -After this call the widget will be visually behind (and therefore obscured by) any overlapping sibling widgets. -.PP -See also raise() and stackUnder(). -.SH "bool QWidget::macEvent ( MSG * )\fC [virtual protected]\fR" -This special event handler can be reimplemented in a subclass to receive native Macintosh events. -.PP -In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. -.PP -\fBWarning:\fR This function is not portable. -.PP -See also QApplication::macEventFilter(). -.SH "QPoint QWidget::mapFrom ( QWidget * parent, const QPoint & pos ) const" -Translates the widget coordinate \fIpos\fR from the coordinate system of \fIparent\fR to this widget's coordinate system. The \fIparent\fR must not be 0 and must be a parent of the calling widget. -.PP -See also mapTo(), mapFromParent(), mapFromGlobal(), and underMouse. -.SH "QPoint QWidget::mapFromGlobal ( const QPoint & pos ) const" -Translates the global screen coordinate \fIpos\fR to widget coordinates. -.PP -See also mapToGlobal(), mapFrom(), and mapFromParent(). -.SH "QPoint QWidget::mapFromParent ( const QPoint & pos ) const" -Translates the parent widget coordinate \fIpos\fR to widget coordinates. -.PP -Same as mapFromGlobal() if the widget has no parent. -.PP -See also mapToParent(), mapFrom(), mapFromGlobal(), and underMouse. -.SH "QPoint QWidget::mapTo ( QWidget * parent, const QPoint & pos ) const" -Translates the widget coordinate \fIpos\fR to the coordinate system of \fIparent\fR. The \fIparent\fR must not be 0 and must be a parent of the calling widget. -.PP -See also mapFrom(), mapToParent(), mapToGlobal(), and underMouse. -.SH "QPoint QWidget::mapToGlobal ( const QPoint & pos ) const" -Translates the widget coordinate \fIpos\fR to global screen coordinates. For example, \fCmapToGlobal(QPoint(0,0))\fR would give the global coordinates of the top-left pixel of the widget. -.PP -See also mapFromGlobal(), mapTo(), and mapToParent(). -.PP -Example: scribble/scribble.cpp. -.SH "QPoint QWidget::mapToParent ( const QPoint & pos ) const" -Translates the widget coordinate \fIpos\fR to a coordinate in the parent widget. -.PP -Same as mapToGlobal() if the widget has no parent. -.PP -See also mapFromParent(), mapTo(), mapToGlobal(), and underMouse. -.SH "int QWidget::maximumHeight () const" -Returns the widget's maximum height. See the "maximumHeight" property for details. -.SH "QSize QWidget::maximumSize () const" -Returns the widget's maximum size. See the "maximumSize" property for details. -.SH "int QWidget::maximumWidth () const" -Returns the widget's maximum width. See the "maximumWidth" property for details. -.SH "int QWidget::metric ( int m ) const\fC [virtual protected]\fR" -Internal implementation of the virtual QPaintDevice::metric() function. -.PP -Use the QPaintDeviceMetrics class instead. -.PP -\fIm\fR is the metric to get. -.SH "QRect QWidget::microFocusHint () const" -Returns the currently set micro focus hint for this widget. See the "microFocusHint" property for details. -.SH "int QWidget::minimumHeight () const" -Returns the widget's minimum height. See the "minimumHeight" property for details. -.SH "QSize QWidget::minimumSize () const" -Returns the widget's minimum size. See the "minimumSize" property for details. -.SH "QSize QWidget::minimumSizeHint () const\fC [virtual]\fR" -Returns the recommended minimum size for the widget. See the "minimumSizeHint" property for details. -.PP -Reimplemented in QLineEdit. -.SH "int QWidget::minimumWidth () const" -Returns the widget's minimum width. See the "minimumWidth" property for details. -.SH "void QWidget::mouseDoubleClickEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse double click events for the widget. -.PP -The default implementation generates a normal mouse press event. -.PP -Note that the widgets gets a mousePressEvent() and a mouseReleaseEvent() before the mouseDoubleClickEvent(). -.PP -See also mousePressEvent(), mouseReleaseEvent(), mouseMoveEvent(), event(), and QMouseEvent. -.SH "QWidget * QWidget::mouseGrabber ()\fC [static]\fR" -Returns the widget that is currently grabbing the mouse input. -.PP -If no widget in this application is currently grabbing the mouse, 0 is returned. -.PP -See also grabMouse() and keyboardGrabber(). -.SH "void QWidget::mouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse move events for the widget. -.PP -If mouse tracking is switched off, mouse move events only occur if a mouse button is pressed while the mouse is being moved. If mouse tracking is switched on, mouse move events occur even if no mouse button is pressed. -.PP -QMouseEvent::pos() reports the position of the mouse cursor, relative to this widget. For press and release events, the position is usually the same as the position of the last mouse move event, but it might be different if the user's hand shakes. This is a feature of the underlying window system, not Qt. -.PP -See also mouseTracking, mousePressEvent(), mouseReleaseEvent(), mouseDoubleClickEvent(), event(), and QMouseEvent. -.PP -Examples: -.)l aclock/aclock.cpp, drawlines/connect.cpp, iconview/simple_dd/main.cpp, life/life.cpp, popup/popup.cpp, qmag/qmag.cpp, and scribble/scribble.cpp. -.PP -Reimplemented in QSizeGrip. -.SH "void QWidget::mousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse press events for the widget. -.PP -If you create new widgets in the mousePressEvent() the mouseReleaseEvent() may not end up where you expect, depending on the underlying window system (or X11 window manager), the widgets' location and maybe more. -.PP -The default implementation implements the closing of popup widgets when you click outside the window. For other widget types it does nothing. -.PP -See also mouseReleaseEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), event(), and QMouseEvent. -.PP -Examples: -.)l biff/biff.cpp, drawlines/connect.cpp, iconview/simple_dd/main.cpp, life/life.cpp, qmag/qmag.cpp, scribble/scribble.cpp, and tooltip/tooltip.cpp. -.PP -Reimplemented in QSizeGrip. -.SH "void QWidget::mouseReleaseEvent ( QMouseEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse release events for the widget. -.PP -See also mouseDoubleClickEvent(), mouseMoveEvent(), event(), and QMouseEvent. -.PP -Examples: -.)l drawlines/connect.cpp, hello/hello.cpp, popup/popup.cpp, qmag/qmag.cpp, scribble/scribble.cpp, showimg/showimg.cpp, and t14/cannon.cpp. -.SH "void QWidget::move ( const QPoint & )\fC [slot]\fR" -Sets the position of the widget within its parent widget. See the "pos" property for details. -.SH "void QWidget::move ( int x, int y )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This corresponds to move( QPoint(\fIx\fR, \fIy\fR) ). -.SH "void QWidget::moveEvent ( QMoveEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive widget move events. When the widget receives this event, it is already at the new position. -.PP -The old position is accessible through QMoveEvent::oldPos(). -.PP -See also resizeEvent(), event(), pos, and QMoveEvent. -.SH "bool QWidget::ownCursor () const" -Returns TRUE if the widget uses its own cursor; otherwise returns FALSE. See the "ownCursor" property for details. -.SH "bool QWidget::ownFont () const" -Returns TRUE if the widget uses its own font; otherwise returns FALSE. See the "ownFont" property for details. -.SH "bool QWidget::ownPalette () const" -Returns TRUE if the widget uses its own palette; otherwise returns FALSE. See the "ownPalette" property for details. -.SH "void QWidget::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive paint events. -.PP -A paint event is a request to repaint all or part of the widget. It can happen as a result of repaint() or update(), or because the widget was obscured and has now been uncovered, or for many other reasons. -.PP -Many widgets can simply repaint their entire surface when asked to, but some slow widgets need to optimize by painting only the requested region: QPaintEvent::region(). This speed optimization does not change the result, as painting is clipped to that region during event processing. QListView and QCanvas do this, for example. -.PP -Qt also tries to speed up painting by merging multiple paint events into one. When update() is called several times or the window system sends several paint events, Qt merges these events into one event with a larger region (see QRegion::unite()). repaint() does not permit this optimization, so we suggest using update() when possible. -.PP -When the paint event occurs, the update region has normally been erased, so that you're painting on the widget's background. There are a couple of exceptions and QPaintEvent::erased() tells you whether the widget has been erased or not. -.PP -The background can be set using setBackgroundMode(), setPaletteBackgroundColor() or setBackgroundPixmap(). The documentation for setBackgroundMode() elaborates on the background; we recommend reading it. -.PP -See also event(), repaint(), update(), QPainter, QPixmap, and QPaintEvent. -.PP -Examples: -.)l drawlines/connect.cpp, forever/forever.cpp, qmag/qmag.cpp, scribble/scribble.cpp, splitter/splitter.cpp, t8/cannon.cpp, and t9/cannon.cpp. -.PP -Reimplemented in QButton, QFrame, QGLWidget, QSizeGrip, QStatusBar, and QTabBar. -.SH "const QPalette & QWidget::palette () const" -Returns the widget's palette. See the "palette" property for details. -.SH "const QColor & QWidget::paletteBackgroundColor () const" -Returns the background color of the widget. See the "paletteBackgroundColor" property for details. -.SH "const QPixmap * QWidget::paletteBackgroundPixmap () const" -Returns the background pixmap of the widget. See the "paletteBackgroundPixmap" property for details. -.SH "void QWidget::paletteChange ( const QPalette & oldPalette )\fC [virtual protected]\fR" -This virtual function is called from setPalette(). \fIoldPalette\fR is the previous palette; you can get the new palette from palette(). -.PP -Reimplement this function if your widget needs to know when its palette changes. -.PP -See also palette and palette. -.SH "const QColor & QWidget::paletteForegroundColor () const" -Returns the foreground color of the widget. See the "paletteForegroundColor" property for details. -.SH "QWidget * QWidget::parentWidget ( bool sameWindow = FALSE ) const" -Returns the parent of this widget, or 0 if it does not have any parent widget. If \fIsameWindow\fR is TRUE and the widget is top level returns 0; otherwise returns the widget's parent. -.PP -Example: mdi/application.cpp. -.SH "void QWidget::polish ()\fC [virtual slot]\fR" -Delayed initialization of a widget. -.PP -This function will be called \fIafter\fR a widget has been fully created and \fIbefore\fR it is shown the very first time. -.PP -Polishing is useful for final initialization which depends on having an instantiated widget. This is something a constructor cannot guarantee since the initialization of the subclasses might not be finished. -.PP -After this function, the widget has a proper font and palette and QApplication::polish() has been called. -.PP -Remember to call QWidget's implementation first when reimplementing this function to ensure that your program does not end up in infinite recursion. -.PP -See also constPolish() and QApplication::polish(). -.PP -Example: menu/menu.cpp. -.SH "QPoint QWidget::pos () const" -Returns the position of the widget within its parent widget. See the "pos" property for details. -.SH "bool QWidget::qwsEvent ( QWSEvent * )\fC [virtual protected]\fR" -This special event handler can be reimplemented in a subclass to receive native Qt/Embedded events. -.PP -In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. -.PP -\fBWarning:\fR This function is not portable. -.PP -See also QApplication::qwsEventFilter(). -.SH "void QWidget::raise ()\fC [slot]\fR" -Raises this widget to the top of the parent widget's stack. -.PP -After this call the widget will be visually in front of any overlapping sibling widgets. -.PP -See also lower() and stackUnder(). -.PP -Example: showimg/showimg.cpp. -.SH "void QWidget::recreate ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This method is provided to aid porting from Qt 1.0 to 2.0. It has been renamed reparent() in Qt 2.0. -.SH "QRect QWidget::rect () const" -Returns the internal geometry of the widget excluding any window frame. See the "rect" property for details. -.SH "void QWidget::releaseKeyboard ()" -Releases the keyboard grab. -.PP -See also grabKeyboard(), grabMouse(), and releaseMouse(). -.SH "void QWidget::releaseMouse ()" -Releases the mouse grab. -.PP -See also grabMouse(), grabKeyboard(), and releaseKeyboard(). -.SH "void QWidget::repaint ( int x, int y, int w, int h, bool erase = TRUE )\fC [slot]\fR" -Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. -.PP -If \fIerase\fR is TRUE, Qt erases the area \fI(x, y, w, h)\fR before the paintEvent() call. -.PP -If \fIw\fR is negative, it is replaced with \fCwidth() - x\fR, and if \fIh\fR is negative, it is replaced width \fCheight() - y\fR. -.PP -We suggest only using repaint() if you need an immediate repaint, for example during animation. In almost all circumstances update() is better, as it permits Qt to optimize for speed and minimize flicker. -.PP -\fBWarning:\fR If you call repaint() in a function which may itself be called from paintEvent(), you may get infinite recursion. The update() function never causes recursion. -.PP -See also update(), paintEvent(), updatesEnabled, and erase(). -.PP -Example: qwerty/qwerty.cpp. -.SH "void QWidget::repaint ()\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version erases and repaints the entire widget. -.SH "void QWidget::repaint ( bool erase )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version repaints the entire widget. -.SH "void QWidget::repaint ( const QRect & r, bool erase = TRUE )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Repaints the widget directly by calling paintEvent() directly, unless updates are disabled or the widget is hidden. -.PP -Erases the widget region \fIr\fR if \fIerase\fR is TRUE. -.SH "void QWidget::repaint ( const QRegion & reg, bool erase = TRUE )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Repaints the widget directly by calling paintEvent() directly, unless updates are disabled or the widget is hidden. -.PP -Erases the widget region \fIreg\fR if \fIerase\fR is TRUE. -.PP -Only use repaint if your widget needs to be repainted immediately, for example when doing some animation. In all other cases, use update(). Calling update() many times in a row will generate a single paint event. -.PP -\fBWarning:\fR If you call repaint() in a function which may itself be called from paintEvent(), you may get infinite recursion. The update() function never causes recursion. -.PP -See also update(), paintEvent(), updatesEnabled, and erase(). -.SH "void QWidget::reparent ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE )\fC [virtual]\fR" -Reparents the widget. The widget gets a new \fIparent\fR, new widget flags (\fIf\fR, but as usual, use 0) at a new position in its new parent (\fIp\fR). -.PP -If \fIshowIt\fR is TRUE, show() is called once the widget has been reparented. -.PP -If the new parent widget is in a different top-level widget, the reparented widget and its children are appended to the end of the tab chain of the new parent widget, in the same internal order as before. If one of the moved widgets had keyboard focus, reparent() calls clearFocus() for that widget. -.PP -If the new parent widget is in the same top-level widget as the old parent, reparent doesn't change the tab order or keyboard focus. -.PP -\fBWarning:\fR It is extremely unlikely that you will ever need this function. If you have a widget that changes its content dynamically, it is far easier to use QWidgetStack or QWizard. -.PP -See also getWFlags(). -.PP -Example: toplevel/options.ui.h. -.SH "void QWidget::reparent ( QWidget * parent, const QPoint & p, bool showIt = FALSE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -A convenience version of reparent that does not take widget flags as argument. -.PP -Calls reparent(\fIparent\fR, getWFlags() & ~WType_Mask, \fIp\fR, \fIshowIt\fR). -.SH "void QWidget::resetInputContext ()\fC [protected]\fR" -This function is called when the user finishes input composition, e.g. changes focus to another widget, moves the cursor, etc. -.SH "void QWidget::resize ( const QSize & )\fC [slot]\fR" -Sets the size of the widget excluding any window frame. See the "size" property for details. -.SH "void QWidget::resize ( int w, int h )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This corresponds to resize( QSize(\fIw\fR, \fIh\fR) ). -.SH "void QWidget::resizeEvent ( QResizeEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive widget resize events. When resizeEvent() is called, the widget already has its new geometry. The old size is accessible through QResizeEvent::oldSize(). -.PP -The widget will be erased and receive a paint event immediately after processing the resize event. No drawing need be (or should be) done inside this handler. -.PP -Widgets that have been created with the WNoAutoErase flag will not be erased. Nevertheless, they will receive a paint event for their entire area afterwards. Again, no drawing needs to be done inside this handler. -.PP -The default implementation calls updateMask() if the widget has automatic masking enabled. -.PP -See also moveEvent(), event(), size, QResizeEvent, and paintEvent(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp, menu/menu.cpp, qmag/qmag.cpp, scribble/scribble.cpp, showimg/showimg.cpp, tooltip/tooltip.cpp, and xform/xform.cpp. -.PP -Reimplemented in QFrame and QGLWidget. -.SH "void QWidget::scroll ( int dx, int dy )" -Scrolls the widget including its children \fIdx\fR pixels to the right and \fIdy\fR downwards. Both \fIdx\fR and \fIdy\fR may be negative. -.PP -After scrolling, scroll() sends a paint event for the the part that is read but not written. For example, when scrolling 10 pixels rightwards, the leftmost ten pixels of the widget need repainting. The paint event may be delivered immediately or later, depending on some heuristics (note that you might have to force processing of paint events using QApplication::sendPostedEvents() when using scroll() and move() in combination). -.PP -See also QScrollView, erase(), and bitBlt(). -.SH "void QWidget::scroll ( int dx, int dy, const QRect & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This version only scrolls \fIr\fR and does not move the children of the widget. -.PP -If \fIr\fR is empty or invalid, the result is undefined. -.PP -See also QScrollView, erase(), and bitBlt(). -.SH "void QWidget::setAcceptDrops ( bool on )\fC [virtual]\fR" -Sets whether drop events are enabled for this widget to \fIon\fR. See the "acceptDrops" property for details. -.SH "void QWidget::setActiveWindow ()\fC [virtual]\fR" -Sets the top-level widget containing this widget to be the active window. -.PP -An active window is a visible top-level window that has the keyboard input focus. -.PP -This function performs the same operation as clicking the mouse on the title bar of a top-level window. On X11, the result depends on the Window Manager. If you want to ensure that the window is stacked on top as well you should also call raise(). Note that the window must be visible, otherwise setActiveWindow() has no effect. -.PP -On Windows, if you are calling this when the application is not currently the active one then it will not make it the active window. It will flash the task bar entry blue to indicate that the window has done something. This is because Microsoft do not allow an application to interrupt what the user is currently doing in another application. -.PP -See also isActiveWindow, topLevelWidget(), and show(). -.PP -Reimplemented in QXtWidget. -.SH "void QWidget::setAutoMask ( bool )\fC [virtual]\fR" -Sets whether the auto mask feature is enabled for the widget. See the "autoMask" property for details. -.SH "void QWidget::setBackgroundColor ( const QColor & c )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use setPaletteBackgroundColor() or setEraseColor() instead. -.PP -Examples: -.)l customlayout/main.cpp, desktop/desktop.cpp, hello/main.cpp, movies/main.cpp, and splitter/splitter.cpp. -.SH "void QWidget::setBackgroundMode ( BackgroundMode )\fC [virtual]\fR" -Sets the color role used for painting the background of the widget. See the "backgroundMode" property for details. -.SH "void QWidget::setBackgroundMode ( BackgroundMode m, BackgroundMode visual )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the widget's own background mode to \fIm\fR and the visual background mode to \fIvisual\fR. The visual background mode is used with the designable properties \fCbackgroundColor\fR, \fCforegroundColor\fR and \fCbackgroundPixmap\fR. -.PP -For complex controls, the logical background mode sometimes differs from a widget's own background mode. A spinbox for example has PaletteBackground as background mode (typically dark gray), while it's embedded lineedit control uses PaletteBase (typically white). Since the lineedit covers most of the visual area of a spinbox, it defines PaletteBase to be its \fIvisual\fR background mode. Changing the \fCbackgroundColor\fR property thus changes the lineedit control's background, which is exactly what the user expects in \fIQt Designer\fR. -.SH "void QWidget::setBackgroundOrigin ( BackgroundOrigin )\fC [virtual]\fR" -Sets the origin of the widget's background. See the "backgroundOrigin" property for details. -.SH "void QWidget::setBackgroundPixmap ( const QPixmap & pm )\fC [virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use setPaletteBackgroundPixmap() or setErasePixmap() instead. -.PP -Example: desktop/desktop.cpp. -.SH "void QWidget::setBaseSize ( const QSize & )" -Sets the base size of the widget. See the "baseSize" property for details. -.SH "void QWidget::setBaseSize ( int basew, int baseh )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This corresponds to setBaseSize( QSize(\fIbasew\fR, \fIbaseh\fR) ). Sets the widgets base size to width \fIbasew\fR and height \fIbaseh\fR. -.SH "void QWidget::setCaption ( const QString & )\fC [virtual slot]\fR" -Sets the window caption (title). See the "caption" property for details. -.SH "void QWidget::setCursor ( const QCursor & )\fC [virtual]\fR" -Sets the cursor shape for this widget. See the "cursor" property for details. -.SH "void QWidget::setDisabled ( bool disable )\fC [slot]\fR" -Disables widget input events if \fIdisable\fR is TRUE; otherwise enables input events. -.PP -See the enabled documentation for more information. -.PP -See also isEnabledTo(), QKeyEvent, QMouseEvent, and enabledChange(). -.SH "void QWidget::setEnabled ( bool )\fC [virtual slot]\fR" -Sets whether the widget is enabled. See the "enabled" property for details. -.SH "void QWidget::setEraseColor ( const QColor & color )\fC [virtual]\fR" -Sets the erase color of the widget to \fIcolor\fR. -.PP -The erase color is the color the widget is to be cleared to before paintEvent() is called. If there is an erase pixmap (set using setErasePixmap()), then this property has an indeterminate value. -.PP -See also erasePixmap(), backgroundColor(), backgroundMode, and palette. -.SH "void QWidget::setErasePixmap ( const QPixmap & pixmap )\fC [virtual]\fR" -Sets the widget's erase pixmap to \fIpixmap\fR. -.PP -This pixmap is used to clear the widget before paintEvent() is called. -.SH "void QWidget::setFixedHeight ( int h )" -Sets both the minimum and maximum heights of the widget to \fIh\fR without changing the widths. Provided for convenience. -.PP -See also sizeHint, minimumSize, maximumSize, and setFixedSize(). -.PP -Examples: -.)l fonts/simple-qfont-demo/viewer.cpp, layout/layout.cpp, qdir/qdir.cpp, and showimg/showimg.cpp. -.SH "void QWidget::setFixedSize ( const QSize & s )" -Sets both the minimum and maximum sizes of the widget to \fIs\fR, thereby preventing it from ever growing or shrinking. -.PP -See also maximumSize and minimumSize. -.SH "void QWidget::setFixedSize ( int w, int h )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the width of the widget to \fIw\fR and the height to \fIh\fR. -.SH "void QWidget::setFixedWidth ( int w )" -Sets both the minimum and maximum width of the widget to \fIw\fR without changing the heights. Provided for convenience. -.PP -See also sizeHint, minimumSize, maximumSize, and setFixedSize(). -.PP -Examples: -.)l progressbar/progressbar.cpp and qdir/qdir.cpp. -.SH "void QWidget::setFocus ()\fC [virtual slot]\fR" -Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. -.PP -First, a focus out event is sent to the focus widget (if any) to tell it that it is about to lose the focus. Then a focus in event is sent to this widget to tell it that it just received the focus. (Nothing happens if the focus in and focus out widgets are the same.) -.PP -setFocus() gives focus to a widget regardless of its focus policy, but does not clear any keyboard grab (see grabKeyboard()). -.PP -Be aware that if the widget is hidden, it will not accept focus. -.PP -\fBWarning:\fR If you call setFocus() in a function which may itself be called from focusOutEvent() or focusInEvent(), you may get an infinite recursion. -.PP -See also focus, clearFocus(), focusInEvent(), focusOutEvent(), focusPolicy, QApplication::focusWidget(), grabKeyboard(), and grabMouse(). -.PP -Examples: -.)l addressbook/centralwidget.cpp, lineedits/lineedits.cpp, mdi/application.cpp, popup/popup.cpp, rot13/rot13.cpp, t8/main.cpp, and wizard/wizard.cpp. -.SH "void QWidget::setFocusPolicy ( FocusPolicy )\fC [virtual]\fR" -Sets the way the widget accepts keyboard focus. See the "focusPolicy" property for details. -.SH "void QWidget::setFocusProxy ( QWidget * w )\fC [virtual]\fR" -Sets the widget's focus proxy to widget \fIw\fR. If \fIw\fR is 0, the function resets this widget to have no focus proxy. -.PP -Some widgets, such as QComboBox, can "have focus", but create a child widget to actually handle the focus. QComboBox, for example, creates a QLineEdit which handles the focus. -.PP -setFocusProxy() sets the widget which will actually get focus when" this widget" gets it. If there is a focus proxy, focusPolicy(), setFocusPolicy(), setFocus() and hasFocus() all operate on the focus proxy. -.PP -See also focusProxy(). -.SH "void QWidget::setFont ( const QFont & )\fC [virtual]\fR" -Sets the font currently set for the widget. See the "font" property for details. -.PP -Reimplemented in QComboBox, QLabel, and QTabDialog. -.SH "void QWidget::setFont ( const QFont & f, bool )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use setFont(const QFont& font) instead. -.SH "void QWidget::setGeometry ( const QRect & )\fC [virtual slot]\fR" -Sets the geometry of the widget relative to its parent and excluding the window frame. See the "geometry" property for details. -.SH "void QWidget::setGeometry ( int x, int y, int w, int h )\fC [virtual slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This corresponds to setGeometry( QRect(\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) ). -.SH "void QWidget::setHidden ( bool hide )\fC [slot]\fR" -Sets whether the widget is explicitly hidden to \fIhide\fR. See the "hidden" property for details. -.SH "void QWidget::setIcon ( const QPixmap & )\fC [virtual slot]\fR" -Sets the widget's icon. See the "icon" property for details. -.SH "void QWidget::setIconText ( const QString & )\fC [virtual slot]\fR" -Sets the widget's icon text. See the "iconText" property for details. -.SH "void QWidget::setInputMethodEnabled ( bool b )" -Sets enables or disables the use of input methods for this widget to \fIb\fR. See the "inputMethodEnabled" property for details. -.SH "void QWidget::setKeyCompression ( bool compress )\fC [virtual protected]\fR" -Enables key event compression, if \fIcompress\fR is TRUE, and disables it if \fIcompress\fR is FALSE. -.PP -Key compression is off by default (except for QLineEdit and QTextEdit), so widgets receive one key press event for each key press (or more, since autorepeat is usually on). If you turn it on and your program doesn't keep up with key input, Qt may try to compress key events so that more than one character can be processed in each event. -.PP -For example, a word processor widget might receive 2, 3 or more characters in each QKeyEvent::text(), if the layout recalculation takes too long for the CPU. -.PP -If a widget supports multiple character unicode input, it is always safe to turn the compression on. -.PP -Qt performs key event compression only for printable characters. Modifier keys, cursor movement keys, function keys and miscellaneous action keys (e.g. Escape, Enter, Backspace, PrintScreen) will stop key event compression, even if there are more compressible key events available. -.PP -Not all platforms support this compression, in which case turning it on will have no effect. -.PP -See also QKeyEvent::text(). -.SH "void QWidget::setMask ( const QBitmap & bitmap )\fC [virtual]\fR" -Causes only the pixels of the widget for which \fIbitmap\fR has a corresponding 1 bit to be visible. Use Qt::color0 to draw transparent regions and Qt::color1 to draw opaque regions of the bitmap. -.PP -If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform. -.PP -Note that this effect can be slow if the region is particularly complex. -.PP -See \fCexamples/tux\fR for an example of masking for transparency. -.PP -See also clearMask(). -.SH "void QWidget::setMask ( const QRegion & region )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Causes only the parts of the widget which overlap \fIregion\fR to be visible. If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform. -.PP -Note that this effect can be slow if the region is particularly complex. -.PP -See also clearMask(). -.SH "void QWidget::setMaximumHeight ( int maxh )" -Sets the widget's maximum height to \fImaxh\fR. See the "maximumHeight" property for details. -.SH "void QWidget::setMaximumSize ( const QSize & )" -Sets the widget's maximum size. See the "maximumSize" property for details. -.SH "void QWidget::setMaximumSize ( int maxw, int maxh )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function corresponds to setMaximumSize( QSize(\fImaxw\fR, \fImaxh\fR) ). Sets the maximum width to \fImaxw\fR and the maximum height to \fImaxh\fR. -.SH "void QWidget::setMaximumWidth ( int maxw )" -Sets the widget's maximum width to \fImaxw\fR. See the "maximumWidth" property for details. -.SH "void QWidget::setMicroFocusHint ( int x, int y, int width, int height, bool text = TRUE, QFont * f = 0 )\fC [virtual protected]\fR" -When a widget gets focus, it should call setMicroFocusHint() with some appropriate position and size, \fIx\fR, \fIy\fR, \fIwidth\fR and \fIheight\fR. This has no \fIvisual\fR effect, it just provides hints to any system-specific input handling tools. -.PP -The \fItext\fR argument should be TRUE if this is a position for text input. -.PP -In the Windows version of Qt, this method sets the system caret, which is used for user Accessibility focus handling. If \fItext\fR is TRUE, it also sets the IME composition window in Far East Asian language input systems. -.PP -In the X11 version of Qt, if \fItext\fR is TRUE, this method sets the XIM "spot" point for complex language input handling. -.PP -The font \fIf\fR is a rendering hint to the currently active input method. If \fIf\fR is 0 the widget's font is used. -.PP -See also microFocusHint. -.SH "void QWidget::setMinimumHeight ( int minh )" -Sets the widget's minimum height to \fIminh\fR. See the "minimumHeight" property for details. -.SH "void QWidget::setMinimumSize ( const QSize & )" -Sets the widget's minimum size. See the "minimumSize" property for details. -.SH "void QWidget::setMinimumSize ( int minw, int minh )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This function corresponds to setMinimumSize( QSize(minw, minh) ). Sets the minimum width to \fIminw\fR and the minimum height to \fIminh\fR. -.SH "void QWidget::setMinimumWidth ( int minw )" -Sets the widget's minimum width to \fIminw\fR. See the "minimumWidth" property for details. -.SH "void QWidget::setMouseTracking ( bool enable )\fC [virtual slot]\fR" -Sets whether mouse tracking is enabled for the widget to \fIenable\fR. See the "mouseTracking" property for details. -.SH "void QWidget::setPalette ( const QPalette & )\fC [virtual]\fR" -Sets the widget's palette. See the "palette" property for details. -.PP -Reimplemented in QComboBox, QScrollBar, and QSlider. -.SH "void QWidget::setPalette ( const QPalette & p, bool )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use setPalette( const QPalette& p ) instead. -.SH "void QWidget::setPaletteBackgroundColor ( const QColor & )\fC [virtual]\fR" -Sets the background color of the widget. See the "paletteBackgroundColor" property for details. -.SH "void QWidget::setPaletteBackgroundPixmap ( const QPixmap & )\fC [virtual]\fR" -Sets the background pixmap of the widget. See the "paletteBackgroundPixmap" property for details. -.SH "void QWidget::setPaletteForegroundColor ( const QColor & )" -Sets the foreground color of the widget. See the "paletteForegroundColor" property for details. -.SH "void QWidget::setShown ( bool show )\fC [slot]\fR" -Sets whether the widget is shown to \fIshow\fR. See the "shown" property for details. -.SH "void QWidget::setSizeIncrement ( const QSize & )" -Sets the size increment of the widget. See the "sizeIncrement" property for details. -.SH "void QWidget::setSizeIncrement ( int w, int h )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the x (width) size increment to \fIw\fR and the y (height) size increment to \fIh\fR. -.SH "void QWidget::setSizePolicy ( QSizePolicy )\fC [virtual]\fR" -Sets the default layout behavior of the widget. See the "sizePolicy" property for details. -.SH "void QWidget::setSizePolicy ( QSizePolicy::SizeType hor, QSizePolicy::SizeType ver, bool hfw = FALSE )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the size policy of the widget to \fIhor\fR, \fIver\fR and \fIhfw\fR (height for width). -.PP -See also QSizePolicy::QSizePolicy(). -.SH "void QWidget::setStyle ( QStyle * style )" -Sets the widget's GUI style to \fIstyle\fR. Ownership of the style object is not transferred. -.PP -If no style is set, the widget uses the application's style, QApplication::style() instead. -.PP -Setting a widget's style has no effect on existing or future child widgets. -.PP -\fBWarning:\fR This function is particularly useful for demonstration purposes, where you want to show Qt's styling capabilities. Real applications should avoid it and use one consistent GUI style instead. -.PP -See also style(), QStyle, QApplication::style(), and QApplication::setStyle(). -.PP -Examples: -.)l grapher/grapher.cpp and progressbar/progressbar.cpp. -.SH "QStyle * QWidget::setStyle ( const QString & style )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the widget's GUI style to \fIstyle\fR using the QStyleFactory. -.SH "void QWidget::setTabOrder ( QWidget * first, QWidget * second )\fC [static]\fR" -Moves the \fIsecond\fR widget around the ring of focus widgets so that keyboard focus moves from the \fIfirst\fR widget to the \fIsecond\fR widget when the Tab key is pressed. -.PP -Note that since the tab order of the \fIsecond\fR widget is changed, you should order a chain like this: -.PP -.nf -.br - setTabOrder( a, b ); // a to b -.br - setTabOrder( b, c ); // a to b to c -.br - setTabOrder( c, d ); // a to b to c to d -.br -.fi -.PP -\fInot\fR like this: -.PP -.nf -.br - setTabOrder( c, d ); // c to d WRONG -.br - setTabOrder( a, b ); // a to b AND c to d -.br - setTabOrder( b, c ); // a to b to c, but not c to d -.br -.fi -.PP -If \fIfirst\fR or \fIsecond\fR has a focus proxy, setTabOrder() correctly substitutes the proxy. -.PP -See also focusPolicy and setFocusProxy(). -.PP -Example: customlayout/main.cpp. -.SH "void QWidget::setUpdatesEnabled ( bool enable )\fC [virtual slot]\fR" -Sets whether updates are enabled to \fIenable\fR. See the "updatesEnabled" property for details. -.SH "void QWidget::setWFlags ( WFlags f )\fC [virtual protected]\fR" -Sets the widget flags \fIf\fR. -.PP -Widget flags are a combination of Qt::WidgetFlags. -.PP -See also testWFlags(), getWFlags(), and clearWFlags(). -.SH "void QWidget::setWindowOpacity ( double level )" -Sets the level of opacity for the window to \fIlevel\fR. See the "windowOpacity" property for details. -.SH "void QWidget::setWindowState ( uint windowState )" -Sets the window state to \fIwindowState\fR. The window state is a OR'ed combination of Qt::WindowState: WindowMinimized, WindowMaximized, WindowFullScreen and WindowActive. -.PP -If the window is not visible (i.e. isVisible() returns FALSE), the window state will take effect when show() is called. For visible windows, the change is immediate. For example, to toggle between full-screen and mormal mode, use the following code: -.PP -.nf -.br - w->setWindowState(w->windowState() ^ WindowFullScreen); -.br -.fi -.PP -In order to restore and activate a minimized window (while preserving its maximized and/or full-screen state), use the following: -.PP -.nf -.br - w->setWindowState(w->windowState() & ~WindowMinimized | WindowActive); -.br -.fi -.PP -Note: On some window systems WindowActive is not immediate, and may be ignored in certain cases. -.PP -See also Qt::WindowState and windowState(). -.SH "void QWidget::show ()\fC [virtual slot]\fR" -Shows the widget and its child widgets. -.PP -If its size or position has changed, Qt guarantees that a widget gets move and resize events just before it is shown. -.PP -You almost never have to reimplement this function. If you need to change some settings before a widget is shown, use showEvent() instead. If you need to do some delayed initialization use polish(). -.PP -See also showEvent(), hide(), showMinimized(), showMaximized(), showNormal(), visible, and polish(). -.PP -Examples: -.)l aclock/main.cpp, life/main.cpp, popup/popup.cpp, t1/main.cpp, t3/main.cpp, t4/main.cpp, and toplevel/options.ui.h. -.PP -Reimplemented in QDialog and QMenuBar. -.SH "void QWidget::showEvent ( QShowEvent * )\fC [virtual protected]\fR" -This event handler can be reimplemented in a subclass to receive widget show events. -.PP -Non-spontaneous show events are sent to widgets immediately before they are shown. The spontaneous show events of top-level widgets are delivered afterwards. -.PP -See also event() and QShowEvent. -.PP -Example: qdir/qdir.cpp. -.SH "void QWidget::showFullScreen ()\fC [slot]\fR" -Shows the widget in full-screen mode. -.PP -Calling this function only affects top-level widgets. -.PP -To return from full-screen mode, call showNormal(). -.PP -Full-screen mode works fine under Windows, but has certain problems under X. These problems are due to limitations of the ICCCM protocol that specifies the communication between X11 clients and the window manager. ICCCM simply does not understand the concept of non-decorated full-screen windows. Therefore, the best we can do is to request a borderless window and place and resize it to fill the entire screen. Depending on the window manager, this may or may not work. The borderless window is requested using MOTIF hints, which are at least partially supported by virtually all modern window managers. -.PP -An alternative would be to bypass the window manager entirely and create a window with the WX11BypassWM flag. This has other severe problems though, like totally broken keyboard focus and very strange effects on desktop changes or when the user raises other windows. -.PP -X11 window managers that follow modern post-ICCCM specifications support full-screen mode properly. -.PP -See also showNormal(), showMaximized(), show(), hide(), and visible. -.SH "void QWidget::showMaximized ()\fC [virtual slot]\fR" -Shows the widget maximized. -.PP -Calling this function only affects top-level widgets. -.PP -On X11, this function may not work properly with certain window managers. See the Window Geometry documentation for an explanation. -.PP -See also setWindowState(), showNormal(), showMinimized(), show(), hide(), and visible. -.PP -Examples: -.)l canvas/main.cpp, helpviewer/main.cpp, mdi/application.cpp, qwerty/main.cpp, qwerty/qwerty.cpp, and scribble/main.cpp. -.SH "void QWidget::showMinimized ()\fC [virtual slot]\fR" -Shows the widget minimized, as an icon. -.PP -Calling this function only affects top-level widgets. -.PP -See also showNormal(), showMaximized(), show(), hide(), visible, and minimized. -.SH "void QWidget::showNormal ()\fC [virtual slot]\fR" -Restores the widget after it has been maximized or minimized. -.PP -Calling this function only affects top-level widgets. -.PP -See also setWindowState(), showMinimized(), showMaximized(), show(), hide(), and visible. -.PP -Example: mdi/application.cpp. -.SH "QSize QWidget::size () const" -Returns the size of the widget excluding any window frame. See the "size" property for details. -.SH "QSize QWidget::sizeHint () const\fC [virtual]\fR" -Returns the recommended size for the widget. See the "sizeHint" property for details. -.PP -Reimplemented in QSizeGrip. -.SH "QSize QWidget::sizeIncrement () const" -Returns the size increment of the widget. See the "sizeIncrement" property for details. -.SH "QSizePolicy QWidget::sizePolicy () const\fC [virtual]\fR" -Returns the default layout behavior of the widget. See the "sizePolicy" property for details. -.SH "void QWidget::stackUnder ( QWidget * w )\fC [slot]\fR" -Places the widget under \fIw\fR in the parent widget's stack. -.PP -To make this work, the widget itself and \fIw\fR must be siblings. -.PP -See also raise() and lower(). -.SH "QStyle & QWidget::style () const" -Returns the GUI style for this widget -.PP -See also QWidget::setStyle(), QApplication::setStyle(), and QApplication::style(). -.SH "void QWidget::styleChange ( QStyle & oldStyle )\fC [virtual protected]\fR" -This virtual function is called when the style of the widgets changes. \fIoldStyle\fR is the previous GUI style; you can get the new style from style(). -.PP -Reimplement this function if your widget needs to know when its GUI style changes. You will almost certainly need to update the widget using update(). -.PP -The default implementation updates the widget including its geometry. -.PP -See also QApplication::setStyle(), style(), update(), and updateGeometry(). -.SH "void QWidget::tabletEvent ( QTabletEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive tablet events for the widget. -.PP -If you reimplement this handler, it is very important that you ignore() the event if you do not handle it, so that the widget's parent can interpret it. -.PP -The default implementation ignores the event. -.PP -See also QTabletEvent::ignore(), QTabletEvent::accept(), event(), and QTabletEvent. -.SH "WFlags QWidget::testWFlags ( WFlags f ) const" -Returns the bitwise AND of the widget flags and \fIf\fR. -.PP -Widget flags are a combination of Qt::WidgetFlags. -.PP -If you want to test for the presence of multiple flags (or composite flags such as WStyle_Splash), test the return value for equality against the argument. For example: -.PP -.nf -.br - int flags = WStyle_Tool | WStyle_NoBorder; -.br - if ( testWFlags(flags) ) -.br - ... // WStyle_Tool or WStyle_NoBorder or both are set -.br - if ( testWFlags(flags) == flags ) -.br - ... // both WStyle_Tool and WStyle_NoBorder are set -.br -.fi -.PP -See also getWFlags(), setWFlags(), and clearWFlags(). -.SH "QWidget * QWidget::topLevelWidget () const" -Returns the top-level widget for this widget, i.e. the next ancestor widget that has (or could have) a window-system frame. -.PP -If the widget is a top-level, the widget itself is returned. -.PP -Typical usage is changing the window caption: -.PP -.nf -.br - aWidget->topLevelWidget()->setCaption( "New Caption" ); -.br -.fi -.PP -See also isTopLevel. -.SH "void QWidget::unsetCursor ()\fC [virtual]\fR" -Resets the cursor shape for this widget. See the "cursor" property for details. -.SH "void QWidget::unsetFont ()" -Resets the font currently set for the widget. See the "font" property for details. -.SH "void QWidget::unsetPalette ()" -Resets the widget's palette. See the "palette" property for details. -.SH "void QWidget::update ()\fC [slot]\fR" -Updates the widget unless updates are disabled or the widget is hidden. -.PP -This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker than a call to repaint() does. -.PP -Calling update() several times normally results in just one paintEvent() call. -.PP -Qt normally erases the widget's area before the paintEvent() call. If the WRepaintNoErase widget flag is set, the widget is responsible for painting all its pixels itself. -.PP -See also repaint(), paintEvent(), updatesEnabled, erase(), and setWFlags(). -.PP -Examples: -.)l desktop/desktop.cpp and scrollview/scrollview.cpp. -.SH "void QWidget::update ( int x, int y, int w, int h )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Updates a rectangle (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) inside the widget unless updates are disabled or the widget is hidden. -.PP -This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker and a call to repaint() does. -.PP -Calling update() several times normally results in just one paintEvent() call. -.PP -If \fIw\fR is negative, it is replaced with \fCwidth() - x\fR. If \fIh\fR is negative, it is replaced width \fCheight() - y\fR. -.PP -Qt normally erases the specified area before the paintEvent() call. If the WRepaintNoErase widget flag is set, the widget is responsible for painting all its pixels itself. -.PP -See also repaint(), paintEvent(), updatesEnabled, and erase(). -.SH "void QWidget::update ( const QRect & r )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Updates a rectangle \fIr\fR inside the widget unless updates are disabled or the widget is hidden. -.PP -This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker and a call to repaint() does. -.PP -Calling update() several times normally results in just one paintEvent() call. -.SH "void QWidget::updateGeometry ()" -Notifies the layout system that this widget has changed and may need to change geometry. -.PP -Call this function if the sizeHint() or sizePolicy() have changed. -.PP -For explicitly hidden widgets, updateGeometry() is a no-op. The layout system will be notified as soon as the widget is shown. -.SH "void QWidget::updateMask ()\fC [virtual protected]\fR" -This function can be reimplemented in a subclass to support transparent widgets. It should be called whenever a widget changes state in a way that means that the shape mask must be recalculated. -.PP -See also autoMask, setMask(), and clearMask(). -.SH "QRect QWidget::visibleRect () const" -Returns the visible rectangle. See the "visibleRect" property for details. -.SH "void QWidget::wheelEvent ( QWheelEvent * e )\fC [virtual protected]\fR" -This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive wheel events for the widget. -.PP -If you reimplement this handler, it is very important that you ignore() the event if you do not handle it, so that the widget's parent can interpret it. -.PP -The default implementation ignores the event. -.PP -See also QWheelEvent::ignore(), QWheelEvent::accept(), event(), and QWheelEvent. -.SH "int QWidget::width () const" -Returns the width of the widget excluding any window frame. See the "width" property for details. -.SH "bool QWidget::winEvent ( MSG * )\fC [virtual protected]\fR" -This special event handler can be reimplemented in a subclass to receive native Windows events. -.PP -In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. -.PP -\fBWarning:\fR This function is not portable. -.PP -See also QApplication::winEventFilter(). -.SH "WId QWidget::winId () const" -Returns the window system identifier of the widget. -.PP -Portable in principle, but if you use it you are probably about to do something non-portable. Be careful. -.PP -See also find(). -.SH "void QWidget::windowActivationChange ( bool oldActive )\fC [virtual protected]\fR" -This virtual function is called for a widget when its window is activated or deactivated by the window system. \fIoldActive\fR is the previous state; you can get the new setting from isActiveWindow(). -.PP -Reimplement this function if your widget needs to know when its window becomes activated or deactivated. -.PP -The default implementation updates the visible part of the widget if the inactive and the active colorgroup are different for colors other than the highlight and link colors. -.PP -See also setActiveWindow(), isActiveWindow, update(), and palette. -.SH "double QWidget::windowOpacity () const" -Returns the level of opacity for the window. See the "windowOpacity" property for details. -.SH "uint QWidget::windowState () const" -Returns the current window state. The window state is a OR'ed combination of Qt::WindowState: WindowMinimized, WindowMaximized, WindowFullScreen and WindowActive. -.PP -See also Qt::WindowState and setWindowState(). -.SH "int QWidget::x () const" -Returns the x coordinate of the widget relative to its parent including any window frame. See the "x" property for details. -.SH "bool QWidget::x11Event ( XEvent * )\fC [virtual protected]\fR" -This special event handler can be reimplemented in a subclass to receive native X11 events. -.PP -In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. -.PP -\fBWarning:\fR This function is not portable. -.PP -See also QApplication::x11EventFilter(). -.PP -Reimplemented in QXtWidget. -.SH "int QWidget::y () const" -Returns the y coordinate of the widget relative to its parent and including any window frame. See the "y" property for details. -.SS "Property Documentation" -.SH "bool acceptDrops" -This property holds whether drop events are enabled for this widget. -.PP -Setting this property to TRUE announces to the system that this widget \fImay\fR be able to accept drop events. -.PP -If the widget is the desktop (QWidget::isDesktop()), this may fail if another application is using the desktop; you can call acceptDrops() to test if this occurs. -.PP -\fBWarning:\fR Do not modify this property in a Drag&Drop event handler. -.PP -Set this property's value with setAcceptDrops() and get this property's value with acceptDrops(). -.SH "bool autoMask" -This property holds whether the auto mask feature is enabled for the widget. -.PP -Transparent widgets use a mask to define their visible region. QWidget has some built-in support to make the task of recalculating the mask easier. When setting auto mask to TRUE, updateMask() will be called whenever the widget is resized or changes its focus state. Note that you must reimplement updateMask() (which should include a call to setMask()) or nothing will happen. -.PP -Note: when you re-implement resizeEvent(), focusInEvent() or focusOutEvent() in your custom widgets and still want to ensure that the auto mask calculation works, you should add: -.PP -.nf -.br - if ( autoMask() ) -.br - updateMask(); -.br -.fi -.PP -at the end of your event handlers. This is true for all member functions that change the appearance of the widget in a way that requires a recalculation of the mask. -.PP -While being a technically appealing concept, masks have a big drawback: when using complex masks that cannot be expressed easily with relatively simple regions, they can be very slow on some window systems. The classic example is a transparent label. The complex shape of its contents makes it necessary to represent its mask by a bitmap, which consumes both memory and time. If all you want is to blend the background of several neighboring widgets together seamlessly, you will probably want to use setBackgroundOrigin() rather than a mask. -.PP -See also updateMask(), setMask(), clearMask(), and backgroundOrigin. -.PP -Set this property's value with setAutoMask() and get this property's value with autoMask(). -.SH "QBrush backgroundBrush" -This property holds the widget's background brush. -.PP -The background brush depends on a widget's palette and its background mode. -.PP -See also backgroundColor(), backgroundPixmap(), eraseColor(), palette, and QApplication::setPalette(). -.PP -Get this property's value with backgroundBrush(). -.SH "BackgroundMode backgroundMode" -This property holds the color role used for painting the background of the widget. -.PP -setPaletteBackgroundColor() reads this property to determine which entry of the palette to set. -.PP -For most widgets the default suffices (PaletteBackground, typically gray), but some need to use PaletteBase (the background color for text output, typically white) or another role. -.PP -QListBox, which is "sunken" and uses the base color to contrast with its environment, does this in its constructor: -.PP -.nf -.br - setBackgroundMode( PaletteBase ); -.br -.fi -.PP -You will never need to set the background mode of a built-in widget in Qt, but you might consider setting it in your custom widgets, so that setPaletteBackgroundColor() works as expected. -.PP -Note that two of the BackgroundMode values make no sense for setBackgroundMode(), namely FixedPixmap and FixedColor. You must call setBackgroundPixmap() and setPaletteBackgroundColor() instead. -.PP -Set this property's value with setBackgroundMode() and get this property's value with backgroundMode(). -.SH "BackgroundOrigin backgroundOrigin" -This property holds the origin of the widget's background. -.PP -The origin is either WidgetOrigin (the default), ParentOrigin, WindowOrigin or AncestorOrigin. -.PP -This only makes a difference if the widget has a background pixmap, in which case positioning matters. Using WindowOrigin for several neighboring widgets makes the background blend together seamlessly. AncestorOrigin allows blending backgrounds seamlessly when an ancestor of the widget has an origin other than WindowOrigin. -.PP -See also backgroundPixmap() and backgroundMode. -.PP -Set this property's value with setBackgroundOrigin() and get this property's value with backgroundOrigin(). -.SH "QSize baseSize" -This property holds the base size of the widget. -.PP -The base size is used to calculate a proper widget size if the widget defines sizeIncrement(). -.PP -See also sizeIncrement. -.PP -Set this property's value with setBaseSize() and get this property's value with baseSize(). -.SH "QString caption" -This property holds the window caption (title). -.PP -This property only makes sense for top-level widgets. If no caption has been set, the caption is QString::null. -.PP -See also icon and iconText. -.PP -Set this property's value with setCaption() and get this property's value with caption(). -.SH "QRect childrenRect" -This property holds the bounding rectangle of the widget's children. -.PP -Hidden children are excluded. -.PP -See also childrenRegion and geometry. -.PP -Get this property's value with childrenRect(). -.SH "QRegion childrenRegion" -This property holds the combined region occupied by the widget's children. -.PP -Hidden children are excluded. -.PP -See also childrenRect and geometry. -.PP -Get this property's value with childrenRegion(). -.SH "QColorGroup colorGroup" -This property holds the current color group of the widget palette. -.PP -The color group is determined by the state of the widget. A disabled widget has the QPalette::disabled() color group, a widget with keyboard focus has the QPalette::active() color group, and an inactive widget has the QPalette::inactive() color group. -.PP -See also palette. -.PP -Get this property's value with colorGroup(). -.SH "QCursor cursor" -This property holds the cursor shape for this widget. -.PP -The mouse cursor will assume this shape when it's over this widget. See the list of predefined cursor objects for a range of useful shapes. -.PP -An editor widget might use an I-beam cursor: -.PP -.nf -.br - setCursor( IbeamCursor ); -.br -.fi -.PP -If no cursor has been set, or after a call to unsetCursor(), the parent's cursor is used. The function unsetCursor() has no effect on top-level widgets. -.PP -See also QApplication::setOverrideCursor(). -.PP -Set this property's value with setCursor(), get this property's value with cursor(), and reset this property's value with unsetCursor(). -.SH "bool customWhatsThis" -This property holds whether the widget wants to handle What's This help manually. -.PP -The default implementation of customWhatsThis() returns FALSE, which means the widget will not receive any events in Whats This mode. -.PP -The widget may leave What's This mode by calling QWhatsThis::leaveWhatsThisMode(), with or without actually displaying any help text. -.PP -You can also reimplement customWhatsThis() if your widget is a" passive interactor" supposed to work under all circumstances. Simply don't call QWhatsThis::leaveWhatsThisMode() in that case. -.PP -See also QWhatsThis::inWhatsThisMode() and QWhatsThis::leaveWhatsThisMode(). -.PP -Get this property's value with customWhatsThis(). -.SH "bool enabled" -This property holds whether the widget is enabled. -.PP -An enabled widget receives keyboard and mouse events; a disabled widget does not. In fact, an enabled widget only receives keyboard events when it is in focus. -.PP -Some widgets display themselves differently when they are disabled. For example a button might draw its label grayed out. If your widget needs to know when it becomes enabled or disabled, you can reimplement the enabledChange() function. -.PP -Disabling a widget implicitly disables all its children. Enabling respectively enables all child widgets unless they have been explicitly disabled. -.PP -See also enabled, isEnabledTo(), QKeyEvent, QMouseEvent, and enabledChange(). -.PP -Set this property's value with setEnabled() and get this property's value with isEnabled(). -.SH "bool focus" -This property holds whether this widget (or its focus proxy) has the keyboard input focus. -.PP -Effectively equivalent to \fCqApp->focusWidget() == this\fR. -.PP -See also setFocus(), clearFocus(), focusPolicy, and QApplication::focusWidget(). -.PP -Get this property's value with hasFocus(). -.SH "bool focusEnabled" -This property holds whether the widget accepts keyboard focus. -.PP -Keyboard focus is initially disabled (i.e. focusPolicy() == QWidget::NoFocus). -.PP -You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget's constructor. For instance, the QLineEdit constructor calls setFocusPolicy(QWidget::StrongFocus). -.PP -See also focusPolicy, focusInEvent(), focusOutEvent(), keyPressEvent(), keyReleaseEvent(), and enabled. -.PP -Get this property's value with isFocusEnabled(). -.SH "FocusPolicy focusPolicy" -This property holds the way the widget accepts keyboard focus. -.PP -The policy is QWidget::TabFocus if the widget accepts keyboard focus by tabbing, QWidget::ClickFocus if the widget accepts focus by clicking, QWidget::StrongFocus if it accepts both, and QWidget::NoFocus (the default) if it does not accept focus at all. -.PP -You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget's constructor. For instance, the QLineEdit constructor calls setFocusPolicy(QWidget::StrongFocus). -.PP -See also focusEnabled, focusInEvent(), focusOutEvent(), keyPressEvent(), keyReleaseEvent(), and enabled. -.PP -Set this property's value with setFocusPolicy() and get this property's value with focusPolicy(). -.SH "QFont font" -This property holds the font currently set for the widget. -.PP -The fontInfo() function reports the actual font that is being used by the widget. -.PP -As long as no special font has been set, or after unsetFont() is called, this is either a special font for the widget class, the parent's font or (if this widget is a top level widget), the default application font. -.PP -This code fragment sets a 12 point helvetica bold font: -.PP -.nf -.br - QFont f( "Helvetica", 12, QFont::Bold ); -.br - setFont( f ); -.br -.fi -.PP -In addition to setting the font, setFont() informs all children about the change. -.PP -See also fontChange(), fontInfo(), fontMetrics(), and ownFont. -.PP -Set this property's value with setFont(), get this property's value with font(), and reset this property's value with unsetFont(). -.SH "QRect frameGeometry" -This property holds geometry of the widget relative to its parent including any window frame. -.PP -See the Window Geometry documentation for an overview of geometry issues with top-level widgets. -.PP -See also geometry, x, y, and pos. -.PP -Get this property's value with frameGeometry(). -.SH "QSize frameSize" -This property holds the size of the widget including any window frame. -.PP -Get this property's value with frameSize(). -.SH "bool fullScreen" -This property holds whether the widget is full screen. -.PP -Get this property's value with isFullScreen(). -.PP -See also windowState(), minimized, and maximized. -.SH "QRect geometry" -This property holds the geometry of the widget relative to its parent and excluding the window frame. -.PP -When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive appropriate events before it is shown. -.PP -The size component is adjusted if it lies outside the range defined by minimumSize() and maximumSize(). -.PP -setGeometry() is virtual, and all other overloaded setGeometry() implementations in Qt call it. -.PP -\fBWarning:\fR Calling setGeometry() inside resizeEvent() or moveEvent() can lead to infinite recursion. -.PP -See the Window Geometry documentation for an overview of top-level widget geometry. -.PP -See also frameGeometry, rect, pos, size, moveEvent(), resizeEvent(), minimumSize, and maximumSize. -.PP -Set this property's value with setGeometry() and get this property's value with geometry(). -.SH "int height" -This property holds the height of the widget excluding any window frame. -.PP -See the Window Geometry documentation for an overview of top-level widget geometry. -.PP -See also geometry, width, and size. -.PP -Get this property's value with height(). -.SH "bool hidden" -This property holds whether the widget is explicitly hidden. -.PP -If FALSE, the widget is visible or would become visible if all its ancestors became visible. -.PP -See also hide(), show(), visible, isVisibleTo(), and shown. -.PP -Set this property's value with setHidden() and get this property's value with isHidden(). -.SH "QPixmap icon" -This property holds the widget's icon. -.PP -This property only makes sense for top-level widgets. If no icon has been set, icon() returns 0. -.PP -See also iconText, caption, and Setting the Application Icon. -.PP -Set this property's value with setIcon() and get this property's value with icon(). -.SH "QString iconText" -This property holds the widget's icon text. -.PP -This property only makes sense for top-level widgets. If no icon text has been set, this functions returns QString::null. -.PP -See also icon and caption. -.PP -Set this property's value with setIconText() and get this property's value with iconText(). -.SH "bool inputMethodEnabled" -This property holds enables or disables the use of input methods for this widget. -.PP -Most Widgets (as eg. buttons) that do not handle text input should have the input method disabled if they have focus. This is the default. -.PP -If a widget handles text input it should set this property to TRUE. -.PP -Set this property's value with setInputMethodEnabled() and get this property's value with isInputMethodEnabled(). -.SH "bool isActiveWindow" -This property holds whether this widget is the active window. -.PP -The active window is the window that contains the widget that has keyboard focus. -.PP -When popup windows are visible, this property is TRUE for both the active window \fIand\fR for the popup. -.PP -See also setActiveWindow() and QApplication::activeWindow(). -.PP -Get this property's value with isActiveWindow(). -.SH "bool isDesktop" -This property holds whether the widget is a desktop widget, i.e. represents the desktop. -.PP -A desktop widget is also a top-level widget. -.PP -See also isTopLevel and QApplication::desktop(). -.PP -Get this property's value with isDesktop(). -.SH "bool isDialog" -This property holds whether the widget is a dialog widget. -.PP -A dialog widget is a secondary top-level widget, i.e. a top-level widget with a parent. -.PP -See also isTopLevel and QDialog. -.PP -Get this property's value with isDialog(). -.SH "bool isModal" -This property holds whether the widget is a modal widget. -.PP -This property only makes sense for top-level widgets. A modal widget prevents widgets in all other top-level widgets from getting any input. -.PP -See also isTopLevel, isDialog, and QDialog. -.PP -Get this property's value with isModal(). -.SH "bool isPopup" -This property holds whether the widget is a popup widget. -.PP -A popup widget is created by specifying the widget flag WType_Popup to the widget constructor. A popup widget is also a top-level widget. -.PP -See also isTopLevel. -.PP -Get this property's value with isPopup(). -.SH "bool isTopLevel" -This property holds whether the widget is a top-level widget. -.PP -A top-level widget is a widget which usually has a frame and a caption (title). Popup and desktop widgets are also top-level widgets. -.PP -A top-level widget can have a parent widget. It will then be grouped with its parent and deleted when the parent is deleted, minimized when the parent is minimized etc. If supported by the window manager, it will also have a common taskbar entry with its parent. -.PP -QDialog and QMainWindow widgets are by default top-level, even if a parent widget is specified in the constructor. This behavior is specified by the WType_TopLevel widget flag. -.PP -See also topLevelWidget(), isDialog, isModal, isPopup, isDesktop, and parentWidget(). -.PP -Get this property's value with isTopLevel(). -.SH "bool maximized" -This property holds whether this widget is maximized. -.PP -This property is only relevant for top-level widgets. -.PP -Note that due to limitations in some window-systems, this does not always report the expected results (e.g. if the user on X11 maximizes the window via the window manager, Qt has no way of distinguishing this from any other resize). This is expected to improve as window manager protocols evolve. -.PP -See also windowState(), showMaximized(), visible, show(), hide(), showNormal(), and minimized. -.PP -Get this property's value with isMaximized(). -.SH "int maximumHeight" -This property holds the widget's maximum height. -.PP -This property corresponds to maximumSize().height(). -.PP -See also maximumSize and maximumWidth. -.PP -Set this property's value with setMaximumHeight() and get this property's value with maximumHeight(). -.SH "QSize maximumSize" -This property holds the widget's maximum size. -.PP -The widget cannot be resized to a larger size than the maximum widget size. -.PP -See also maximumWidth, maximumHeight, maximumSize, minimumSize, and sizeIncrement. -.PP -Set this property's value with setMaximumSize() and get this property's value with maximumSize(). -.SH "int maximumWidth" -This property holds the widget's maximum width. -.PP -This property corresponds to maximumSize().width(). -.PP -See also maximumSize and maximumHeight. -.PP -Set this property's value with setMaximumWidth() and get this property's value with maximumWidth(). -.SH "QRect microFocusHint" -This property holds the currently set micro focus hint for this widget. -.PP -See the documentation of setMicroFocusHint() for more information. -.PP -Get this property's value with microFocusHint(). -.SH "bool minimized" -This property holds whether this widget is minimized (iconified). -.PP -This property is only relevant for top-level widgets. -.PP -See also showMinimized(), visible, show(), hide(), showNormal(), and maximized. -.PP -Get this property's value with isMinimized(). -.SH "int minimumHeight" -This property holds the widget's minimum height. -.PP -This property corresponds to minimumSize().height(). -.PP -See also minimumSize and minimumWidth. -.PP -Set this property's value with setMinimumHeight() and get this property's value with minimumHeight(). -.SH "QSize minimumSize" -This property holds the widget's minimum size. -.PP -The widget cannot be resized to a smaller size than the minimum widget size. The widget's size is forced to the minimum size if the current size is smaller. -.PP -If you use a layout inside the widget, the minimum size will be set by the layout and not by setMinimumSize(), unless you set the layout's resize mode to QLayout::FreeResize. -.PP -See also minimumWidth, minimumHeight, maximumSize, sizeIncrement, and QLayout::resizeMode. -.PP -Set this property's value with setMinimumSize() and get this property's value with minimumSize(). -.SH "QSize minimumSizeHint" -This property holds the recommended minimum size for the widget. -.PP -If the value of this property is an invalid size, no minimum size is recommended. -.PP -The default implementation of minimumSizeHint() returns an invalid size if there is no layout for this widget, and returns the layout's minimum size otherwise. Most built-in widgets reimplement minimumSizeHint(). -.PP -QLayout will never resize a widget to a size smaller than minimumSizeHint. -.PP -See also QSize::isValid(), size, minimumSize, and sizePolicy. -.PP -Get this property's value with minimumSizeHint(). -.SH "int minimumWidth" -This property holds the widget's minimum width. -.PP -This property corresponds to minimumSize().width(). -.PP -See also minimumSize and minimumHeight. -.PP -Set this property's value with setMinimumWidth() and get this property's value with minimumWidth(). -.SH "bool mouseTracking" -This property holds whether mouse tracking is enabled for the widget. -.PP -If mouse tracking is disabled (the default), the widget only receives mouse move events when at least one mouse button is pressed while the mouse is being moved. -.PP -If mouse tracking is enabled, the widget receives mouse move events even if no buttons are pressed. -.PP -See also mouseMoveEvent() and QApplication::setGlobalMouseTracking(). -.PP -Set this property's value with setMouseTracking() and get this property's value with hasMouseTracking(). -.SH "bool ownCursor" -This property holds whether the widget uses its own cursor. -.PP -If FALSE, the widget uses its parent widget's cursor. -.PP -See also cursor. -.PP -Get this property's value with ownCursor(). -.SH "bool ownFont" -This property holds whether the widget uses its own font. -.PP -If FALSE, the widget uses its parent widget's font. -.PP -See also font. -.PP -Get this property's value with ownFont(). -.SH "bool ownPalette" -This property holds whether the widget uses its own palette. -.PP -If FALSE, the widget uses its parent widget's palette. -.PP -See also palette. -.PP -Get this property's value with ownPalette(). -.SH "QPalette palette" -This property holds the widget's palette. -.PP -As long as no special palette has been set, or after unsetPalette() has been called, this is either a special palette for the widget class, the parent's palette or (if this widget is a top level widget), the default application palette. -.PP -Instead of defining an entirely new palette, you can also use the paletteBackgroundColor, paletteBackgroundPixmap and paletteForegroundColor convenience properties to change a widget's background and foreground appearance only. -.PP -See also ownPalette, colorGroup, and QApplication::palette(). -.PP -Set this property's value with setPalette(), get this property's value with palette(), and reset this property's value with unsetPalette(). -.SH "QColor paletteBackgroundColor" -This property holds the background color of the widget. -.PP -The palette background color is usually set implicitly by setBackgroundMode(), although it can also be set explicitly by setPaletteBackgroundColor(). setPaletteBackgroundColor() is a convenience function that creates and sets a modified QPalette with setPalette(). The palette is modified according to the widget's background mode. For example, if the background mode is PaletteButton the color used for the palette's QColorGroup::Button color entry is set. -.PP -If there is a background pixmap (set using setPaletteBackgroundPixmap()), then the return value of this function is indeterminate. -.PP -See also paletteBackgroundPixmap, paletteForegroundColor, palette, and colorGroup. -.PP -Set this property's value with setPaletteBackgroundColor(), get this property's value with paletteBackgroundColor(), and reset this property's value with unsetPalette(). -.SH "QPixmap paletteBackgroundPixmap" -This property holds the background pixmap of the widget. -.PP -The palette background pixmap is usually set implicitly by setBackgroundMode(), although it can also be set explicitly by setPaletteBackgroundPixmap(). setPaletteBackgroundPixmap() is a convenience function that creates and sets a modified QPalette with setPalette(). The palette is modified according to the widget's background mode. For example, if the background mode is PaletteButton the pixmap used for the palette's QColorGroup::Button color entry is set. -.PP -If there is a plain background color (set using setPaletteBackgroundColor()), then this function returns 0. -.PP -See also paletteBackgroundColor, paletteForegroundColor, palette, and colorGroup. -.PP -Set this property's value with setPaletteBackgroundPixmap(), get this property's value with paletteBackgroundPixmap(), and reset this property's value with unsetPalette(). -.SH "QColor paletteForegroundColor" -This property holds the foreground color of the widget. -.PP -setPaletteForegroundColor() is a convenience function that creates and sets a modified QPalette with setPalette(). The palette is modified according to the widget's \fIbackground mode\fR. For example, if the background mode is PaletteButton the palette entry QColorGroup::ButtonText is set to color. -.PP -See also palette, QApplication::setPalette(), backgroundMode, foregroundColor(), backgroundMode, and setEraseColor(). -.PP -Set this property's value with setPaletteForegroundColor(), get this property's value with paletteForegroundColor(), and reset this property's value with unsetPalette(). -.SH "QPoint pos" -This property holds the position of the widget within its parent widget. -.PP -If the widget is a top-level widget, the position is that of the widget on the desktop, including its frame. -.PP -When changing the position, the widget, if visible, receives a move event (moveEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown. -.PP -move() is virtual, and all other overloaded move() implementations in Qt call it. -.PP -\fBWarning:\fR Calling move() or setGeometry() inside moveEvent() can lead to infinite recursion. -.PP -See the Window Geometry documentation for an overview of top-level widget geometry. -.PP -See also frameGeometry, size, x, and y. -.PP -Set this property's value with move() and get this property's value with pos(). -.SH "QRect rect" -This property holds the internal geometry of the widget excluding any window frame. -.PP -The rect property equals QRect(0, 0, width(), height()). -.PP -See the Window Geometry documentation for an overview of top-level widget geometry. -.PP -See also size. -.PP -Get this property's value with rect(). -.SH "bool shown" -This property holds whether the widget is shown. -.PP -If TRUE, the widget is visible or would become visible if all its ancestors became visible. -.PP -See also hide(), show(), visible, isVisibleTo(), and hidden. -.PP -Set this property's value with setShown() and get this property's value with isShown(). -.SH "QSize size" -This property holds the size of the widget excluding any window frame. -.PP -When resizing, the widget, if visible, receives a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown. -.PP -The size is adjusted if it lies outside the range defined by minimumSize() and maximumSize(). Furthermore, the size is always at least QSize(1, 1). For toplevel widgets, the minimum size might be larger, depending on the window manager. -.PP -If you want a top-level window to have a fixed size, call setResizeMode( QLayout::FreeResize ) on its layout. -.PP -resize() is virtual, and all other overloaded resize() implementations in Qt call it. -.PP -\fBWarning:\fR Calling resize() or setGeometry() inside resizeEvent() can lead to infinite recursion. -.PP -See also pos, geometry, minimumSize, maximumSize, and resizeEvent(). -.PP -Set this property's value with resize() and get this property's value with size(). -.SH "QSize sizeHint" -This property holds the recommended size for the widget. -.PP -If the value of this property is an invalid size, no size is recommended. -.PP -The default implementation of sizeHint() returns an invalid size if there is no layout for this widget, and returns the layout's preferred size otherwise. -.PP -See also QSize::isValid(), minimumSizeHint, sizePolicy, minimumSize, and updateGeometry(). -.PP -Get this property's value with sizeHint(). -.SH "QSize sizeIncrement" -This property holds the size increment of the widget. -.PP -When the user resizes the window, the size will move in steps of sizeIncrement().width() pixels horizontally and sizeIncrement.height() pixels vertically, with baseSize() as the basis. Preferred widget sizes are for non-negative integers \fIi\fR and \fIj\fR: -.PP -.nf -.br - width = baseSize().width() + i * sizeIncrement().width(); -.br - height = baseSize().height() + j * sizeIncrement().height(); -.br -.fi -.PP -Note that while you can set the size increment for all widgets, it only affects top-level widgets. -.PP -\fBWarning:\fR The size increment has no effect under Windows, and may be disregarded by the window manager on X. -.PP -See also size, minimumSize, and maximumSize. -.PP -Set this property's value with setSizeIncrement() and get this property's value with sizeIncrement(). -.SH "QSizePolicy sizePolicy" -This property holds the default layout behavior of the widget. -.PP -If there is a QLayout that manages this widget's children, the size policy specified by that layout is used. If there is no such QLayout, the result of this function is used. -.PP -The default policy is Preferred/Preferred, which means that the widget can be freely resized, but prefers to be the size sizeHint() returns. Button-like widgets set the size policy to specify that they may stretch horizontally, but are fixed vertically. The same applies to lineedit controls (such as QLineEdit, QSpinBox or an editable QComboBox) and other horizontally orientated widgets (such as QProgressBar). QToolButton's are normally square, so they allow growth in both directions. Widgets that support different directions (such as QSlider, QScrollBar or QHeader) specify stretching in the respective direction only. Widgets that can provide scrollbars (usually subclasses of QScrollView) tend to specify that they can use additional space, and that they can make do with less than sizeHint(). -.PP -See also sizeHint, QLayout, QSizePolicy, and updateGeometry(). -.PP -Set this property's value with setSizePolicy() and get this property's value with sizePolicy(). -.SH "bool underMouse" -This property holds whether the widget is under the mouse cursor. -.PP -This value is not updated properly during drag and drop operations. -.PP -See also QEvent::Enter and QEvent::Leave. -.PP -Get this property's value with hasMouse(). -.SH "bool updatesEnabled" -This property holds whether updates are enabled. -.PP -Calling update() and repaint() has no effect if updates are disabled. Paint events from the window system are processed normally even if updates are disabled. -.PP -setUpdatesEnabled() is normally used to disable updates for a short period of time, for instance to avoid screen flicker during large changes. -.PP -Example: -.PP -.nf -.br - setUpdatesEnabled( FALSE ); -.br - bigVisualChanges(); -.br - setUpdatesEnabled( TRUE ); -.br - repaint(); -.br -.fi -.PP -See also update(), repaint(), and paintEvent(). -.PP -Set this property's value with setUpdatesEnabled() and get this property's value with isUpdatesEnabled(). -.SH "bool visible" -This property holds whether the widget is visible. -.PP -Calling show() sets the widget to visible status if all its parent widgets up to the top-level widget are visible. If an ancestor is not visible, the widget won't become visible until all its ancestors are shown. -.PP -Calling hide() hides a widget explicitly. An explicitly hidden widget will never become visible, even if all its ancestors become visible, unless you show it. -.PP -A widget receives show and hide events when its visibility status changes. Between a hide and a show event, there is no need to waste CPU cycles preparing or displaying information to the user. A video application, for example, might simply stop generating new frames. -.PP -A widget that happens to be obscured by other windows on the screen is considered to be visible. The same applies to iconified top-level widgets and windows that exist on another virtual desktop (on platforms that support this concept). A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again. -.PP -See also show(), hide(), hidden, isVisibleTo(), minimized, showEvent(), and hideEvent(). -.PP -Get this property's value with isVisible(). -.SH "QRect visibleRect" -This property holds the visible rectangle. -.PP -\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -No longer necessary, you can simply call repaint(). If you do not need the rectangle for repaint(), use clipRegion() instead. -.PP -Get this property's value with visibleRect(). -.SH "int width" -This property holds the width of the widget excluding any window frame. -.PP -See the Window Geometry documentation for an overview of top-level widget geometry. -.PP -See also geometry, height, and size. -.PP -Get this property's value with width(). -.SH "double windowOpacity" -This property holds the level of opacity for the window. -.PP -The valid range of opacity is from 1.0 (completely opaque) to 0.0 (completely transparent). -.PP -By default the value of this property is 1.0. -.PP -This feature is only present on Mac OS X and Windows 2000 and up. -.PP -\fBWarning:\fR Changing this property from opaque to transparent might issue a paint event that needs to be processed before the window is displayed correctly. This affects mainly the use of QPixmap::grabWindow(). Also note that semi-transparent windows update and resize significantely slower than opaque windows. -.PP -Set this property's value with setWindowOpacity() and get this property's value with windowOpacity(). -.SH "int x" -This property holds the x coordinate of the widget relative to its parent including any window frame. -.PP -See the Window Geometry documentation for an overview of top-level widget geometry. -.PP -See also frameGeometry, y, and pos. -.PP -Get this property's value with x(). -.SH "int y" -This property holds the y coordinate of the widget relative to its parent and including any window frame. -.PP -See the Window Geometry documentation for an overview of top-level widget geometry. -.PP -See also frameGeometry, x, and pos. -.PP -Get this property's value with y(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwidget.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwidgetfactory.3qt b/doc/man/man3/qwidgetfactory.3qt deleted file mode 100644 index f0f4e75be..000000000 --- a/doc/man/man3/qwidgetfactory.3qt +++ /dev/null @@ -1,135 +0,0 @@ -'\" t -.TH QWidgetFactory 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 -QWidgetFactory \- For the dynamic creation of widgets from Qt Designer .ui files -.SH SYNOPSIS -\fC#include <ntqwidgetfactory.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWidgetFactory\fR ()" -.br -.ti -1c -.BI "virtual \fB~QWidgetFactory\fR ()" -.br -.ti -1c -.BI "virtual QWidget * \fBcreateWidget\fR ( const QString & className, QWidget * parent, const char * name ) const" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "QWidget * \fBcreate\fR ( const QString & uiFile, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "QWidget * \fBcreate\fR ( QIODevice * dev, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "void \fBaddWidgetFactory\fR ( QWidgetFactory * factory )" -.br -.ti -1c -.BI "void \fBloadImages\fR ( const QString & dir )" -.br -.ti -1c -.BI "QStringList \fBwidgets\fR ()" -.br -.ti -1c -.BI "bool \fBsupportsWidget\fR ( const QString & widget )" -.br -.in -1c -.SH DESCRIPTION -The QWidgetFactory class provides for the dynamic creation of widgets from Qt Designer .ui files. -.PP -This class basically offers two things: -.IP -.TP -Dynamically creating widgets from Qt Designer user interface description files. You can do this using the static function QWidgetFactory::create(). This function also performs signal and slot connections, tab ordering, etc., as defined in the .ui file, and returns the top-level widget in the .ui file. After creating the widget you can use QObject::child() and QObject::queryList() to access child widgets of this returned widget. -.IP -.TP -Adding additional widget factories to be able to create custom widgets. See createWidget() for details. -.IP -.PP -This class is not included in the Qt library itself. To use it you must link against \fClibtqui.so\fR (Unix) or \fCtqui.lib\fR (Windows), which is built into \fCINSTALL/lib\fR if you built \fIQt Designer\fR (\fCINSTALL\fR is the directory where Qt is installed ). -.PP -If you create a QMainWindow using a QWidgetFactory, be aware that it already has a central widget. Therefore, you need to delete this one before setting another one. -.PP -See the "Creating Dynamic Dialogs from .ui Files" section of the Qt Designer manual for an example. See also the QWidgetPlugin class and the Plugins documentation. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWidgetFactory::QWidgetFactory ()" -Constructs a QWidgetFactory. -.SH "QWidgetFactory::~QWidgetFactory ()\fC [virtual]\fR" -Destructor. -.SH "void QWidgetFactory::addWidgetFactory ( QWidgetFactory * factory )\fC [static]\fR" -Installs a widget factory \fIfactory\fR, which normally contains additional widgets that can then be created using a QWidgetFactory. See createWidget() for further details. -.SH "QWidget * QWidgetFactory::create ( const QString & uiFile, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -Loads the \fIQt Designer\fR user interface description file \fIuiFile\fR and returns the top-level widget in that description. \fIparent\fR and \fIname\fR are passed to the constructor of the top-level widget. -.PP -This function also performs signal and slot connections, tab ordering, etc., as described in the .ui file. In \fIQt Designer\fR it is possible to add custom slots to a form and connect to them. If you want these connections to be made, you must create a class derived from QObject, which implements all these slots. Then pass an instance of the object as \fIconnector\fR to this function. If you do this, the connections to the custom slots will be done using the \fIconnector\fR as slot. -.PP -If something fails, 0 is returned. -.PP -The ownership of the returned widget is passed to the caller. -.SH "QWidget * QWidgetFactory::create ( QIODevice * dev, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads the user interface description from device \fIdev\fR. -.SH "QWidget * QWidgetFactory::createWidget ( const QString & className, QWidget * parent, const char * name ) const\fC [virtual]\fR" -Creates a widget of the type \fIclassName\fR passing \fIparent\fR and \fIname\fR to its constructor. -.PP -If \fIclassName\fR is a widget in the Qt library, it is directly created by this function. If the widget isn't in the Qt library, each of the installed widget plugins is asked, in turn, to create the widget. As soon as a plugin says it can create the widget it is asked to do so. It may occur that none of the plugins can create the widget, in which case each installed widget factory is asked to create the widget (see addWidgetFactory()). If the widget cannot be created by any of these means, 0 is returned. -.PP -If you have a custom widget, and want it to be created using the widget factory, there are two approaches you can use: -.PP -<ol type=1> -.IP -.TP -Write a widget plugin. This allows you to use the widget in \fIQt Designer\fR and in this QWidgetFactory. See the widget plugin documentation for further details. (See the "Creating Custom Widgets with Plugins" section of the Qt Designer manual for an example. -.IP -.TP -Subclass QWidgetFactory. Then reimplement this function to create and return an instance of your custom widget if \fIclassName\fR equals the name of your widget, otherwise return 0. Then at the beginning of your program where you want to use the widget factory to create widgets do a: -.IP -.nf -.br - QWidgetFactory::addWidgetFactory( new MyWidgetFactory ); -.br -.fi -where MyWidgetFactory is your QWidgetFactory subclass. -.IP -.SH "void QWidgetFactory::loadImages ( const QString & dir )\fC [static]\fR" -If you use a pixmap collection (which is the default for new projects) rather than saving the pixmaps within the .ui XML file, you must load the pixmap collection. QWidgetFactory looks in the default QMimeSourceFactory for the pixmaps. Either add it there manually, or call this function and specify the directory where the images can be found, as \fIdir\fR. This is normally the directory called \fCimages\fR in the project's directory. -.SH "bool QWidgetFactory::supportsWidget ( const QString & widget )\fC [static]\fR" -Returns TRUE if the widget factory can create the specified \fIwidget\fR; otherwise returns FALSE. -.SH "QStringList QWidgetFactory::widgets ()\fC [static]\fR" -Returns the names of the widgets this factory can create. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwidgetfactory.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwidgetfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwidgetitem.3qt b/doc/man/man3/qwidgetitem.3qt deleted file mode 100644 index 8a8220bba..000000000 --- a/doc/man/man3/qwidgetitem.3qt +++ /dev/null @@ -1,104 +0,0 @@ -'\" t -.TH QWidgetItem 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 -QWidgetItem \- Layout item that represents a widget -.SH SYNOPSIS -\fC#include <ntqlayout.h>\fR -.PP -Inherits QLayoutItem. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWidgetItem\fR ( QWidget * w )" -.br -.ti -1c -.BI "virtual QSize \fBsizeHint\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBminimumSize\fR () const" -.br -.ti -1c -.BI "virtual QSize \fBmaximumSize\fR () const" -.br -.ti -1c -.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" -.br -.ti -1c -.BI "virtual bool \fBisEmpty\fR () const" -.br -.ti -1c -.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" -.br -.ti -1c -.BI "virtual QWidget * \fBwidget\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWidgetItem class is a layout item that represents a widget. -.PP -This is used by custom layouts. -.PP -See also QLayout, QLayout::widget(), Widget Appearance and Style, and Layout Management. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWidgetItem::QWidgetItem ( QWidget * w )" -Creates an item containing widget \fIw\fR. -.SH "QSizePolicy::ExpandData QWidgetItem::expanding () const\fC [virtual]\fR" -Returns whether this item's widget can make use of more space than sizeHint(). A value of \fCVertical\fR or \fCHorizontal\fR means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions and \fCNoDirection\fR means that it doesn't want to grow at all. -.PP -Reimplemented from QLayoutItem. -.SH "bool QWidgetItem::isEmpty () const\fC [virtual]\fR" -Returns TRUE if the widget has been hidden; otherwise returns FALSE. -.PP -Reimplemented from QLayoutItem. -.SH "QSize QWidgetItem::maximumSize () const\fC [virtual]\fR" -Returns the maximum size of this item. -.PP -Reimplemented from QLayoutItem. -.SH "QSize QWidgetItem::minimumSize () const\fC [virtual]\fR" -Returns the minimum size of this item. -.PP -Reimplemented from QLayoutItem. -.SH "void QWidgetItem::setGeometry ( const QRect & r )\fC [virtual]\fR" -Sets the geometry of this item's widget to be contained within rect \fIr\fR, taking alignment and maximum size into account. -.PP -Reimplemented from QLayoutItem. -.SH "QSize QWidgetItem::sizeHint () const\fC [virtual]\fR" -Returns the preferred size of this item. -.PP -Reimplemented from QLayoutItem. -.SH "QWidget * QWidgetItem::widget ()\fC [virtual]\fR" -Returns the widget managed by this item. -.PP -Reimplemented from QLayoutItem. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwidgetitem.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwidgetitem.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwidgetplugin.3qt b/doc/man/man3/qwidgetplugin.3qt deleted file mode 100644 index 1059b066b..000000000 --- a/doc/man/man3/qwidgetplugin.3qt +++ /dev/null @@ -1,124 +0,0 @@ -'\" t -.TH QWidgetPlugin 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 -QWidgetPlugin \- Abstract base for custom QWidget plugins -.SH SYNOPSIS -\fC#include <ntqwidgetplugin.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWidgetPlugin\fR ()" -.br -.ti -1c -.BI "\fB~QWidgetPlugin\fR ()" -.br -.ti -1c -.BI "virtual QStringList \fBkeys\fR () const = 0" -.br -.ti -1c -.BI "virtual QWidget * \fBcreate\fR ( const QString & key, QWidget * parent = 0, const char * name = 0 ) = 0" -.br -.ti -1c -.BI "virtual QString \fBgroup\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual QIconSet \fBiconSet\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual QString \fBincludeFile\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual QString \fBtoolTip\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual QString \fBwhatsThis\fR ( const QString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBisContainer\fR ( const QString & key ) const" -.br -.in -1c -.SH DESCRIPTION -The QWidgetPlugin class provides an abstract base for custom QWidget plugins. -.PP -The widget plugin is a simple plugin interface that makes it easy to create custom widgets that can be included in forms using Qt Designer and used by applications. -.PP -Writing a widget plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys(), create(), group(), iconSet(), includeFile(), toolTip(), whatsThis() and isContainer(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. -.PP -See the Qt Designer manual's, 'Creating Custom Widgets' section in the 'Creating Custom Widgets' chapter, for a complete example of a QWidgetPlugin. -.PP -See also the Plugins documentation and the QWidgetFactory class that is supplied with Qt Designer. -.PP -See also Plugins. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWidgetPlugin::QWidgetPlugin ()" -Constructs a widget plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. -.SH "QWidgetPlugin::~QWidgetPlugin ()" -Destroys the widget plugin. -.PP -You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. -.SH "QWidget * QWidgetPlugin::create ( const QString & key, QWidget * parent = 0, const char * name = 0 )\fC [pure virtual]\fR" -Creates and returns a QWidget object for the widget key \fIkey\fR. The widget key is the class name of the required widget. The \fIname\fR and \fIparent\fR arguments are passed to the custom widget's constructor. -.PP -See also keys(). -.SH "QString QWidgetPlugin::group ( const QString & key ) const\fC [virtual]\fR" -Returns the group (toolbar name) that the custom widget of class \fIkey\fR should be part of when \fIQt Designer\fR loads it. -.PP -The default implementation returns QString::null. -.SH "QIconSet QWidgetPlugin::iconSet ( const QString & key ) const\fC [virtual]\fR" -Returns the iconset that \fIQt Designer\fR should use to represent the custom widget of class \fIkey\fR in the toolbar. -.PP -The default implementation returns an null iconset. -.SH "QString QWidgetPlugin::includeFile ( const QString & key ) const\fC [virtual]\fR" -Returns the name of the include file that \fIQt Designer\fR and \fCuic\fR should use to include the custom widget of class \fIkey\fR in generated code. -.PP -The default implementation returns QString::null. -.SH "bool QWidgetPlugin::isContainer ( const QString & key ) const\fC [virtual]\fR" -Returns TRUE if the custom widget of class \fIkey\fR can contain other widgets, e.g. like QFrame; otherwise returns FALSE. -.PP -The default implementation returns FALSE. -.SH "QStringList QWidgetPlugin::keys () const\fC [pure virtual]\fR" -Returns the list of widget keys this plugin supports. -.PP -These keys must be the class names of the custom widgets that are implemented in the plugin. -.PP -See also create(). -.SH "QString QWidgetPlugin::toolTip ( const QString & key ) const\fC [virtual]\fR" -Returns the text of the tooltip that \fIQt Designer\fR should use for the custom widget of class \fIkey\fR's toolbar button. -.PP -The default implementation returns QString::null. -.SH "QString QWidgetPlugin::whatsThis ( const QString & key ) const\fC [virtual]\fR" -Returns the text of the whatsThis text that \fIQt Designer\fR should use when the user requests whatsThis help for the custom widget of class \fIkey\fR. -.PP -The default implementation returns QString::null. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwidgetplugin.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwidgetplugin.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwidgetstack.3qt b/doc/man/man3/qwidgetstack.3qt deleted file mode 100644 index 7465aa21a..000000000 --- a/doc/man/man3/qwidgetstack.3qt +++ /dev/null @@ -1,166 +0,0 @@ -'\" t -.TH QWidgetStack 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 -QWidgetStack \- Stack of widgets of which only the top widget is user-visible -.SH SYNOPSIS -\fC#include <ntqwidgetstack.h>\fR -.PP -Inherits QFrame. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWidgetStack\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQWidgetStack\fR ( QWidget * parent, const char * name, WFlags f )" -.br -.ti -1c -.BI "\fB~QWidgetStack\fR ()" -.br -.ti -1c -.BI "int \fBaddWidget\fR ( QWidget * w, int id = -1 )" -.br -.ti -1c -.BI "void \fBremoveWidget\fR ( QWidget * w )" -.br -.ti -1c -.BI "QWidget * \fBwidget\fR ( int id ) const" -.br -.ti -1c -.BI "int \fBid\fR ( QWidget * widget ) const" -.br -.ti -1c -.BI "QWidget * \fBvisibleWidget\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBraiseWidget\fR ( int id )" -.br -.ti -1c -.BI "void \fBraiseWidget\fR ( QWidget * w )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBaboutToShow\fR ( int )" -.br -.ti -1c -.BI "void \fBaboutToShow\fR ( QWidget * )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBsetChildGeometries\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWidgetStack class provides a stack of widgets of which only the top widget is user-visible. -.PP -The application programmer can move any widget to the top of the stack at any time using raiseWidget(), and add or remove widgets using addWidget() and removeWidget(). It is not sufficient to pass the widget stack as parent to a widget which should be inserted into the widgetstack. -.PP -visibleWidget() is the \fIget\fR equivalent of raiseWidget(); it returns a pointer to the widget that is currently at the top of the stack. -.PP -QWidgetStack also provides the ability to manipulate widgets through application-specified integer IDs. You can also translate from widget pointers to IDs using id() and from IDs to widget pointers using widget(). These numeric IDs are unique (per QWidgetStack, not globally), but QWidgetStack does not attach any additional meaning to them. -.PP -The default widget stack is frameless, but you can use the usual QFrame functions (such as setFrameStyle()) to add a frame. -.PP -QWidgetStack provides a signal, aboutToShow(), which is emitted just before a managed widget is shown. -.PP -See also QTabDialog, QTabBar, QFrame, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWidgetStack::QWidgetStack ( QWidget * parent = 0, const char * name = 0 )" -Constructs an empty widget stack. -.PP -The \fIparent\fR and \fIname\fR arguments are passed to the QFrame constructor. -.SH "QWidgetStack::QWidgetStack ( QWidget * parent, const char * name, WFlags f )" -Constructs an empty widget stack. -.PP -The \fIparent\fR, \fIname\fR and \fIf\fR arguments are passed to the QFrame constructor. -.SH "QWidgetStack::~QWidgetStack ()" -Destroys the object and frees any allocated resources. -.SH "void QWidgetStack::aboutToShow ( int )\fC [signal]\fR" -This signal is emitted just before a managed widget is shown if that managed widget has an ID != -1. The argument is the numeric ID of the widget. -.PP -If you call visibleWidget() in a slot connected to aboutToShow(), the widget it returns is the one that is currently visible, not the one that is about to be shown. -.SH "void QWidgetStack::aboutToShow ( QWidget * )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -This signal is emitted just before a managed widget is shown. The argument is a pointer to the widget. -.PP -If you call visibleWidget() in a slot connected to aboutToShow(), the widget returned is the one that is currently visible, not the one that is about to be shown. -.SH "int QWidgetStack::addWidget ( QWidget * w, int id = -1 )" -Adds widget \fIw\fR to this stack of widgets, with ID \fIid\fR. -.PP -If you pass an id >= 0 this ID is used. If you pass an \fIid\fR of -1 (the default), the widgets will be numbered automatically. If you pass -2 a unique negative integer will be generated. No widget has an ID of -1. Returns the ID or -1 on failure (e.g. \fIw\fR is 0). -.PP -If you pass an id that is already used, then a unique negative integer will be generated to prevent two widgets having the same id. -.PP -If \fIw\fR already exists in the stack the widget will be removed first. -.PP -If \fIw\fR is not a child of this QWidgetStack moves it using reparent(). -.PP -Example: xform/xform.cpp. -.SH "int QWidgetStack::id ( QWidget * widget ) const" -Returns the ID of the \fIwidget\fR. Returns -1 if \fIwidget\fR is 0 or is not being managed by this widget stack. -.PP -See also widget() and addWidget(). -.SH "void QWidgetStack::raiseWidget ( int id )\fC [slot]\fR" -Raises the widget with ID \fIid\fR to the top of the widget stack. -.PP -See also visibleWidget(). -.PP -Example: xform/xform.cpp. -.SH "void QWidgetStack::raiseWidget ( QWidget * w )\fC [slot]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Raises widget \fIw\fR to the top of the widget stack. -.SH "void QWidgetStack::removeWidget ( QWidget * w )" -Removes widget \fIw\fR from this stack of widgets. Does not delete \fIw\fR. If \fIw\fR is the currently visible widget, no other widget is substituted. -.PP -See also visibleWidget() and raiseWidget(). -.SH "void QWidgetStack::setChildGeometries ()\fC [virtual protected]\fR" -Fixes up the children's geometries. -.SH "QWidget * QWidgetStack::visibleWidget () const" -Returns the currently visible widget (the one at the top of the stack), or 0 if nothing is currently being shown. -.PP -See also aboutToShow(), id(), and raiseWidget(). -.SH "QWidget * QWidgetStack::widget ( int id ) const" -Returns the widget with ID \fIid\fR. Returns 0 if this widget stack does not manage a widget with ID \fIid\fR. -.PP -See also id() and addWidget(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwidgetstack.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwidgetstack.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwindowsmime.3qt b/doc/man/man3/qwindowsmime.3qt deleted file mode 100644 index df7d7f6c3..000000000 --- a/doc/man/man3/qwindowsmime.3qt +++ /dev/null @@ -1,157 +0,0 @@ -'\" t -.TH QWindowsMime 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 -QWindowsMime \- Maps open-standard MIME to Window Clipboard formats -.SH SYNOPSIS -\fC#include <ntqmime.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWindowsMime\fR ()" -.br -.ti -1c -.BI "virtual \fB~QWindowsMime\fR ()" -.br -.ti -1c -.BI "virtual const char * \fBconvertorName\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBcountCf\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBcf\fR ( int index ) = 0" -.br -.ti -1c -.BI "virtual bool \fBcanConvert\fR ( const char * mime, int cf ) = 0" -.br -.ti -1c -.BI "virtual const char * \fBmimeFor\fR ( int cf ) = 0" -.br -.ti -1c -.BI "virtual int \fBcfFor\fR ( const char * mime ) = 0" -.br -.ti -1c -.BI "virtual QByteArray \fBconvertToMime\fR ( QByteArray data, const char * mime, int cf ) = 0" -.br -.ti -1c -.BI "virtual QByteArray \fBconvertFromMime\fR ( QByteArray data, const char * mime, int cf ) = 0" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBinitialize\fR ()" -.br -.ti -1c -.BI "QPtrList<QWindowsMime> \fBall\fR ()" -.br -.ti -1c -.BI "QWindowsMime * \fBconvertor\fR ( const char * mime, int cf )" -.br -.ti -1c -.BI "const char * \fBcfToMime\fR ( int cf )" -.br -.in -1c -.SH DESCRIPTION -The QWindowsMime class maps open-standard MIME to Window Clipboard formats. -.PP -Qt's drag-and-drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol, but on Windows although some applications use MIME types to describe clipboard formats, others use arbitrary non-standardized naming conventions, or unnamed built-in formats of Windows. -.PP -By instantiating subclasses of QWindowsMime that provide conversions between Windows Clipboard and MIME formats, you can convert proprietary clipboard formats to MIME formats. -.PP -Qt has predefined support for the following Windows Clipboard formats: -.TP -CF_UNICODETEXT - converted to "text/plain;charset=ISO-10646-UCS-2" and supported by QTextDrag. -.TP -CF_TEXT - converted to "text/plain;charset=system" or "text/plain" and supported by QTextDrag. -.TP -CF_DIB - converted to "image/*", where * is a Qt image format, and supported by QImageDrag. -.TP -CF_HDROP - converted to "text/uri-list", and supported by QUriDrag. -.PP -An example use of this class would be to map the Windows Metafile clipboard format (CF_METAFILEPICT) to and from the MIME type "image/x-wmf". This conversion might simply be adding or removing a header, or even just passing on the data. See the Drag-and-Drop documentation for more information on choosing and definition MIME types. -.PP -You can check if a MIME type is convertible using canConvert() and can perform conversions with convertToMime() and convertFromMime(). -.PP -See also Drag And Drop Classes, Input/Output and Networking, and Miscellaneous Classes. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWindowsMime::QWindowsMime ()" -Constructs a new conversion object, adding it to the globally accessed list of available convertors. -.SH "QWindowsMime::~QWindowsMime ()\fC [virtual]\fR" -Destroys a conversion object, removing it from the global list of available convertors. -.SH "QPtrList<QWindowsMime> QWindowsMime::all ()\fC [static]\fR" -Returns a list of all currently defined QWindowsMime objects. -.SH "bool QWindowsMime::canConvert ( const char * mime, int cf )\fC [pure virtual]\fR" -Returns TRUE if the convertor can convert (both ways) between \fImime\fR and \fIcf\fR; otherwise returns FALSE. -.PP -All subclasses must reimplement this pure virtual function. -.SH "int QWindowsMime::cf ( int index )\fC [pure virtual]\fR" -Returns the Windows Clipboard format supported by this convertor that is ordinarily at position \fIindex\fR. This means that cf(0) returns the first Windows Clipboard format supported, and cf(countCf()-1) returns the last. If \fIindex\fR is out of range the return value is undefined. -.PP -All subclasses must reimplement this pure virtual function. -.SH "int QWindowsMime::cfFor ( const char * mime )\fC [pure virtual]\fR" -Returns the Windows Clipboard type used for MIME type \fImime\fR, or 0 if this convertor does not support \fImime\fR. -.PP -All subclasses must reimplement this pure virtual function. -.SH "const char * QWindowsMime::cfToMime ( int cf )\fC [static]\fR" -Returns a MIME type for \fIcf\fR, or 0 if none exists. -.SH "QByteArray QWindowsMime::convertFromMime ( QByteArray data, const char * mime, int cf )\fC [pure virtual]\fR" -Returns \fIdata\fR converted from MIME type \fImime\fR to Windows Clipboard format \fIcf\fR. -.PP -Note that Windows Clipboard formats must all be self-terminating. The return value may contain trailing data. -.PP -All subclasses must reimplement this pure virtual function. -.SH "QByteArray QWindowsMime::convertToMime ( QByteArray data, const char * mime, int cf )\fC [pure virtual]\fR" -Returns \fIdata\fR converted from Windows Clipboard format \fIcf\fR to MIME type \fImime\fR. -.PP -Note that Windows Clipboard formats must all be self-terminating. The input \fIdata\fR may contain trailing data. -.PP -All subclasses must reimplement this pure virtual function. -.SH "QWindowsMime * QWindowsMime::convertor ( const char * mime, int cf )\fC [static]\fR" -Returns the most-recently created QWindowsMime that can convert between the \fImime\fR and \fIcf\fR formats. Returns 0 if no such convertor exists. -.SH "const char * QWindowsMime::convertorName ()\fC [pure virtual]\fR" -Returns a name for the convertor. -.PP -All subclasses must reimplement this pure virtual function. -.SH "int QWindowsMime::countCf ()\fC [pure virtual]\fR" -Returns the number of Windows Clipboard formats supported by this convertor. -.PP -All subclasses must reimplement this pure virtual function. -.SH "void QWindowsMime::initialize ()\fC [static]\fR" -This is an internal function. -.SH "const char * QWindowsMime::mimeFor ( int cf )\fC [pure virtual]\fR" -Returns the MIME type used for Windows Clipboard format \fIcf\fR, or 0 if this convertor does not support \fIcf\fR. -.PP -All subclasses must reimplement this pure virtual function. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwindowsmime.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwindowsmime.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwindowsstyle.3qt b/doc/man/man3/qwindowsstyle.3qt deleted file mode 100644 index e113ca861..000000000 --- a/doc/man/man3/qwindowsstyle.3qt +++ /dev/null @@ -1,57 +0,0 @@ -'\" t -.TH QWindowsStyle 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 -QWindowsStyle \- Microsoft Windows-like look and feel -.SH SYNOPSIS -\fC#include <ntqwindowsstyle.h>\fR -.PP -Inherits QCommonStyle. -.PP -Inherited by QMacStyle and QPlatinumStyle. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWindowsStyle\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWindowsStyle class provides a Microsoft Windows-like look and feel. -.PP -This style is Qt's default GUI style on Windows. -.PP -See also Widget Appearance and Style. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWindowsStyle::QWindowsStyle ()" -Constructs a QWindowsStyle - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwindowsstyle.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwindowsstyle.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwizard.3qt b/doc/man/man3/qwizard.3qt deleted file mode 100644 index 750f5e574..000000000 --- a/doc/man/man3/qwizard.3qt +++ /dev/null @@ -1,289 +0,0 @@ -'\" t -.TH QWizard 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 -QWizard \- Framework for wizard dialogs -.SH SYNOPSIS -\fC#include <ntqwizard.h>\fR -.PP -Inherits QDialog. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWizard\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QWizard\fR ()" -.br -.ti -1c -.BI "virtual void \fBaddPage\fR ( QWidget * page, const QString & title )" -.br -.ti -1c -.BI "virtual void \fBinsertPage\fR ( QWidget * page, const QString & title, int index )" -.br -.ti -1c -.BI "virtual void \fBremovePage\fR ( QWidget * page )" -.br -.ti -1c -.BI "QString \fBtitle\fR ( QWidget * page ) const" -.br -.ti -1c -.BI "void \fBsetTitle\fR ( QWidget * page, const QString & title )" -.br -.ti -1c -.BI "QFont \fBtitleFont\fR () const" -.br -.ti -1c -.BI "void \fBsetTitleFont\fR ( const QFont & )" -.br -.ti -1c -.BI "virtual void \fBshowPage\fR ( QWidget * page )" -.br -.ti -1c -.BI "QWidget * \fBcurrentPage\fR () const" -.br -.ti -1c -.BI "QWidget * \fBpage\fR ( int index ) const" -.br -.ti -1c -.BI "int \fBpageCount\fR () const" -.br -.ti -1c -.BI "int \fBindexOf\fR ( QWidget * page ) const" -.br -.ti -1c -.BI "virtual bool \fBappropriate\fR ( QWidget * page ) const" -.br -.ti -1c -.BI "virtual void \fBsetAppropriate\fR ( QWidget * page, bool appropriate )" -.br -.ti -1c -.BI "QPushButton * \fBbackButton\fR () const" -.br -.ti -1c -.BI "QPushButton * \fBnextButton\fR () const" -.br -.ti -1c -.BI "QPushButton * \fBfinishButton\fR () const" -.br -.ti -1c -.BI "QPushButton * \fBcancelButton\fR () const" -.br -.ti -1c -.BI "QPushButton * \fBhelpButton\fR () const" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "virtual void \fBsetBackEnabled\fR ( QWidget * page, bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetNextEnabled\fR ( QWidget * page, bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetFinishEnabled\fR ( QWidget * page, bool enable )" -.br -.ti -1c -.BI "virtual void \fBsetHelpEnabled\fR ( QWidget * page, bool enable )" -.br -.ti -1c -.BI "virtual void setFinish ( QWidget *, bool ) \fI(obsolete)\fR" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBhelpClicked\fR ()" -.br -.ti -1c -.BI "void \fBselected\fR ( const QString & )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "QFont \fBtitleFont\fR - the font used for page titles" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBlayOutButtonRow\fR ( QHBoxLayout * layout )" -.br -.ti -1c -.BI "virtual void \fBlayOutTitleRow\fR ( QHBoxLayout * layout, const QString & title )" -.br -.in -1c -.SS "Protected Slots" -.in +1c -.ti -1c -.BI "virtual void \fBback\fR ()" -.br -.ti -1c -.BI "virtual void \fBnext\fR ()" -.br -.ti -1c -.BI "virtual void \fBhelp\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWizard class provides a framework for wizard dialogs. -.PP -A wizard is a special type of input dialog that consists of a sequence of dialog pages. A wizard's purpose is to walk the user through a process step by step. Wizards are useful for complex or infrequently occurring tasks that people may find difficult to learn or do. -.PP -QWizard provides page titles and displays Next, Back, Finish, Cancel, and Help push buttons, as appropriate to the current position in the page sequence. These buttons can be enabled/disabled using setBackEnabled(), setNextEnabled(), setFinishEnabled() and setHelpEnabled(). -.PP -Create and populate dialog pages that inherit from QWidget and add them to the wizard using addPage(). Use insertPage() to add a dialog page at a certain position in the page sequence. Use removePage() to remove a page from the page sequence. -.PP -Use currentPage() to retrieve a pointer to the currently displayed page. page() returns a pointer to the page at a certain position in the page sequence. -.PP -Use pageCount() to retrieve the total number of pages in the page sequence. indexOf() will return the index of a page in the page sequence. -.PP -QWizard provides functionality to mark pages as appropriate (or not) in the current context with setAppropriate(). The idea is that a page may be irrelevant and should be skipped depending on the data entered by the user on a preceding page. -.PP -It is generally considered good design to provide a greater number of simple pages with fewer choices rather than a smaller number of complex pages. -.PP -Example code is available here: wizard/wizard.cpp wizard/wizard.h -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> <blockquote><p align="center">\fI A QWizard page \fR</p> </blockquote> -.PP -See also Abstract Widget Classes, Dialog Classes, and Organizers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWizard::QWizard ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" -Constructs an empty wizard dialog. The \fIparent\fR, \fIname\fR, \fImodal\fR and \fIf\fR arguments are passed to the QDialog constructor. -.SH "QWizard::~QWizard ()" -Destroys the object and frees any allocated resources, including all pages and controllers. -.SH "void QWizard::addPage ( QWidget * page, const QString & title )\fC [virtual]\fR" -Adds \fIpage\fR to the end of the page sequence, with the title, \fItitle\fR. -.SH "bool QWizard::appropriate ( QWidget * page ) const\fC [virtual]\fR" -Called when the Next button is clicked; this virtual function returns TRUE if \fIpage\fR is relevant for display in the current context; otherwise it is ignored by QWizard and returns FALSE. The default implementation returns the value set using setAppropriate(). The ultimate default is TRUE. -.PP -\fBWarning:\fR The last page of the wizard will be displayed if no page is relevant in the current context. -.SH "void QWizard::back ()\fC [virtual protected slot]\fR" -Called when the user clicks the Back button; this function shows the preceding relevant page in the sequence. -.PP -See also appropriate(). -.SH "QPushButton * QWizard::backButton () const" -Returns a pointer to the dialog's Back button -.PP -By default, this button is connected to the back() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setBackEnabled() to enable/disable this button. -.SH "QPushButton * QWizard::cancelButton () const" -Returns a pointer to the dialog's Cancel button -.PP -By default, this button is connected to the QDialog::reject() slot, which is virtual so you can reimplement it in a QWizard subclass. -.SH "QWidget * QWizard::currentPage () const" -Returns a pointer to the current page in the sequence. Although the wizard does its best to make sure that this value is never 0, it can be if you try hard enough. -.SH "QPushButton * QWizard::finishButton () const" -Returns a pointer to the dialog's Finish button -.PP -By default, this button is connected to the QDialog::accept() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setFinishEnabled() to enable/disable this button. -.SH "void QWizard::help ()\fC [virtual protected slot]\fR" -Called when the user clicks the Help button, this function emits the helpClicked() signal. -.SH "QPushButton * QWizard::helpButton () const" -Returns a pointer to the dialog's Help button -.PP -By default, this button is connected to the help() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setHelpEnabled() to enable/disable this button. -.SH "void QWizard::helpClicked ()\fC [signal]\fR" -This signal is emitted when the user clicks on the Help button. -.SH "int QWizard::indexOf ( QWidget * page ) const" -Returns the position of page \fIpage\fR. If the page is not part of the wizard -1 is returned. -.SH "void QWizard::insertPage ( QWidget * page, const QString & title, int index )\fC [virtual]\fR" -Inserts \fIpage\fR at position \fIindex\fR into the page sequence, with title \fItitle\fR. If \fIindex\fR is -1, the page will be appended to the end of the wizard's page sequence. -.SH "void QWizard::layOutButtonRow ( QHBoxLayout * layout )\fC [virtual protected]\fR" -This virtual function is responsible for adding the buttons below the bottom divider. -.PP -\fIlayout\fR is the horizontal layout of the entire wizard. -.SH "void QWizard::layOutTitleRow ( QHBoxLayout * layout, const QString & title )\fC [virtual protected]\fR" -This virtual function is responsible for laying out the title row. -.PP -\fIlayout\fR is the horizontal layout for the wizard, and \fItitle\fR is the title for this page. This function is called every time \fItitle\fR changes. -.SH "void QWizard::next ()\fC [virtual protected slot]\fR" -Called when the user clicks the Next button, this function shows the next relevant page in the sequence. -.PP -See also appropriate(). -.SH "QPushButton * QWizard::nextButton () const" -Returns a pointer to the dialog's Next button -.PP -By default, this button is connected to the next() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setNextEnabled() to enable/disable this button. -.SH "QWidget * QWizard::page ( int index ) const" -Returns a pointer to the page at position \fIindex\fR in the sequence, or 0 if \fIindex\fR is out of range. The first page has index 0. -.SH "int QWizard::pageCount () const" -Returns the number of pages in the wizard. -.SH "void QWizard::removePage ( QWidget * page )\fC [virtual]\fR" -Removes \fIpage\fR from the page sequence but does not delete the page. If \fIpage\fR is currently being displayed, QWizard will display the page that precedes it, or the first page if this was the first page. -.SH "void QWizard::selected ( const QString & )\fC [signal]\fR" -This signal is emitted when the current page changes. The parameter contains the title of the selected page. -.SH "void QWizard::setAppropriate ( QWidget * page, bool appropriate )\fC [virtual]\fR" -If \fIappropriate\fR is TRUE then page \fIpage\fR is considered relevant in the current context and should be displayed in the page sequence; otherwise \fIpage\fR should not be displayed in the page sequence. -.PP -See also appropriate(). -.SH "void QWizard::setBackEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" -If \fIenable\fR is TRUE, page \fIpage\fR has a Back button; otherwise \fIpage\fR has no Back button. By default all pages have this button. -.SH "void QWizard::setFinish ( QWidget *, bool )\fC [virtual slot]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Use setFinishEnabled instead -.SH "void QWizard::setFinishEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" -If \fIenable\fR is TRUE, page \fIpage\fR has a Finish button; otherwise \fIpage\fR has no Finish button. By default \fIno\fR page has this button. -.SH "void QWizard::setHelpEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" -If \fIenable\fR is TRUE, page \fIpage\fR has a Help button; otherwise \fIpage\fR has no Help button. By default all pages have this button. -.SH "void QWizard::setNextEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" -If \fIenable\fR is TRUE, page \fIpage\fR has a Next button; otherwise the Next button on \fIpage\fR is disabled. By default all pages have this button. -.SH "void QWizard::setTitle ( QWidget * page, const QString & title )" -Sets the title for page \fIpage\fR to \fItitle\fR. -.SH "void QWizard::setTitleFont ( const QFont & )" -Sets the font used for page titles. See the "titleFont" property for details. -.SH "void QWizard::showPage ( QWidget * page )\fC [virtual]\fR" -Makes \fIpage\fR the current page and emits the selected() signal. -.PP -This virtual function is called whenever a different page is to be shown, including the first time the QWizard is shown. By reimplementing it (and calling QWizard::showPage()), you can prepare each page prior to it being shown. -.PP -Examples: -.)l distributor/distributor.ui.h and wizard/wizard.cpp. -.SH "QString QWizard::title ( QWidget * page ) const" -Returns the title of page \fIpage\fR. -.SH "QFont QWizard::titleFont () const" -Returns the font used for page titles. See the "titleFont" property for details. -.SS "Property Documentation" -.SH "QFont titleFont" -This property holds the font used for page titles. -.PP -The default is QApplication::font(). -.PP -Set this property's value with setTitleFont() and get this property's value with titleFont(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwizard.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwizard.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwmatrix.3qt b/doc/man/man3/qwmatrix.3qt deleted file mode 100644 index 2e2f3f400..000000000 --- a/doc/man/man3/qwmatrix.3qt +++ /dev/null @@ -1,473 +0,0 @@ -'\" t -.TH QWMatrix 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 -QWMatrix \- 2D transformations of a coordinate system -.SH SYNOPSIS -\fC#include <ntqwmatrix.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWMatrix\fR ()" -.br -.ti -1c -.BI "\fBQWMatrix\fR ( double m11, double m12, double m21, double m22, double dx, double dy )" -.br -.ti -1c -.BI "void \fBsetMatrix\fR ( double m11, double m12, double m21, double m22, double dx, double dy )" -.br -.ti -1c -.BI "double \fBm11\fR () const" -.br -.ti -1c -.BI "double \fBm12\fR () const" -.br -.ti -1c -.BI "double \fBm21\fR () const" -.br -.ti -1c -.BI "double \fBm22\fR () const" -.br -.ti -1c -.BI "double \fBdx\fR () const" -.br -.ti -1c -.BI "double \fBdy\fR () const" -.br -.ti -1c -.BI "void \fBmap\fR ( int x, int y, int * tx, int * ty ) const" -.br -.ti -1c -.BI "void \fBmap\fR ( double x, double y, double * tx, double * ty ) const" -.br -.ti -1c -.BI "QRect \fBmapRect\fR ( const QRect & rect ) const" -.br -.ti -1c -.BI "QPoint \fBmap\fR ( const QPoint & p ) const" -.br -.ti -1c -.BI "QRect map ( const QRect & r ) const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QPointArray \fBmap\fR ( const QPointArray & a ) const" -.br -.ti -1c -.BI "QRegion \fBmap\fR ( const QRegion & r ) const" -.br -.ti -1c -.BI "QRegion \fBmapToRegion\fR ( const QRect & rect ) const" -.br -.ti -1c -.BI "QPointArray \fBmapToPolygon\fR ( const QRect & rect ) const" -.br -.ti -1c -.BI "void \fBreset\fR ()" -.br -.ti -1c -.BI "bool \fBisIdentity\fR () const" -.br -.ti -1c -.BI "QWMatrix & \fBtranslate\fR ( double dx, double dy )" -.br -.ti -1c -.BI "QWMatrix & \fBscale\fR ( double sx, double sy )" -.br -.ti -1c -.BI "QWMatrix & \fBshear\fR ( double sh, double sv )" -.br -.ti -1c -.BI "QWMatrix & \fBrotate\fR ( double a )" -.br -.ti -1c -.BI "bool \fBisInvertible\fR () const" -.br -.ti -1c -.BI "double \fBdet\fR () const" -.br -.ti -1c -.BI "QWMatrix \fBinvert\fR ( bool * invertible = 0 ) const" -.br -.ti -1c -.BI "bool \fBoperator==\fR ( const QWMatrix & m ) const" -.br -.ti -1c -.BI "bool \fBoperator!=\fR ( const QWMatrix & m ) const" -.br -.ti -1c -.BI "QWMatrix & \fBoperator*=\fR ( const QWMatrix & m )" -.br -.ti -1c -.BI "enum \fBTransformationMode\fR { Points, Areas }" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBsetTransformationMode\fR ( QWMatrix::TransformationMode m )" -.br -.ti -1c -.BI "TransformationMode \fBtransformationMode\fR ()" -.br -.in -1c -.SH RELATED FUNCTION DOCUMENTATION -.in +1c -.ti -1c -.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QWMatrix & m )" -.br -.ti -1c -.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QWMatrix & m )" -.br -.in -1c -.SH DESCRIPTION -The QWMatrix class specifies 2D transformations of a coordinate system. -.PP -The standard coordinate system of a paint device has the origin located at the top-left position. X values increase to the right; Y values increase downward. -.PP -This coordinate system is the default for the QPainter, which renders graphics in a paint device. A user-defined coordinate system can be specified by setting a QWMatrix for the painter. -.PP -Example: -.PP -.nf -.br - MyWidget::paintEvent( QPaintEvent * ) -.br - { -.br - QPainter p; // our painter -.br - QWMatrix m; // our transformation matrix -.br - m.rotate( 22.5 ); // rotated coordinate system -.br - p.begin( this ); // start painting -.br - p.setWorldMatrix( m ); // use rotated coordinate system -.br - p.drawText( 30,20, "detator" ); // draw rotated text at 30,20 -.br - p.end(); // painting done -.br - } -.br -.fi -.PP -A matrix specifies how to translate, scale, shear or rotate the graphics; the actual transformation is performed by the drawing routines in QPainter and by QPixmap::xForm(). -.PP -The QWMatrix class contains a 3x3 matrix of the form: -.nf -.TS -l -- -l. -m11 m12 0 -m21 m22 0 -dx dy 1 -.TE -.fi - -.PP -A matrix transforms a point in the plane to another point: -.PP -.nf -.br - x' = m11*x + m21*y + dx -.br - y' = m22*y + m12*x + dy -.br -.fi -.PP -The point \fI(x, y)\fR is the original point, and \fI(x', y')\fR is the transformed point. \fI(x', y')\fR can be transformed back to \fI(x, y)\fR by performing the same operation on the inverted matrix. -.PP -The elements \fIdx\fR and \fIdy\fR specify horizontal and vertical translation. The elements \fIm11\fR and \fIm22\fR specify horizontal and vertical scaling. The elements \fIm12\fR and \fIm21\fR specify horizontal and vertical shearing. -.PP -The identity matrix has \fIm11\fR and \fIm22\fR set to 1; all others are set to 0. This matrix maps a point to itself. -.PP -Translation is the simplest transformation. Setting \fIdx\fR and \fIdy\fR will move the coordinate system \fIdx\fR units along the X axis and \fIdy\fR units along the Y axis. -.PP -Scaling can be done by setting \fIm11\fR and \fIm22\fR. For example, setting \fIm11\fR to 2 and \fIm22\fR to 1.5 will double the height and increase the width by 50%. -.PP -Shearing is controlled by \fIm12\fR and \fIm21\fR. Setting these elements to values different from zero will twist the coordinate system. -.PP -Rotation is achieved by carefully setting both the shearing factors and the scaling factors. The QWMatrix also has a function that sets rotation directly. -.PP -QWMatrix lets you combine transformations like this: -.PP -.nf -.br - QWMatrix m; // identity matrix -.br - m.translate(10, -20); // first translate (10,-20) -.br - m.rotate(25); // then rotate 25 degrees -.br - m.scale(1.2, 0.7); // finally scale it -.br -.fi -.PP -Here's the same example using basic matrix operations: -.PP -.nf -.br - double a = pi/180 * 25; // convert 25 to radians -.br - double sina = sin(a); -.br - double cosa = cos(a); -.br - QWMatrix m1(1, 0, 0, 1, 10, -20); // translation matrix -.br - QWMatrix m2( cosa, sina, // rotation matrix -.br - -sina, cosa, 0, 0 ); -.br - QWMatrix m3(1.2, 0, 0, 0.7, 0, 0); // scaling matrix -.br - QWMatrix m; -.br - m = m3 * m2 * m1; // combine all transformations -.br -.fi -.PP -QPainter has functions to translate, scale, shear and rotate the coordinate system without using a QWMatrix. Although these functions are very convenient, it can be more efficient to build a QWMatrix and call QPainter::setWorldMatrix() if you want to perform more than a single transform operation. -.PP -See also QPainter::setWorldMatrix(), QPixmap::xForm(), Graphics Classes, and Image Processing Classes. -.SS "Member Type Documentation" -.SH "QWMatrix::TransformationMode" - -.PP -QWMatrix offers two transformation modes. Calculations can either be done in terms of points (Points mode, the default), or in terms of area (Area mode). -.PP -In Points mode the transformation is applied to the points that mark out the shape's bounding line. In Areas mode the transformation is applied in such a way that the area of the contained region is correctly transformed under the matrix. -.TP -\fCQWMatrix::Points\fR - transformations are applied to the shape's points. -.TP -\fCQWMatrix::Areas\fR - transformations are applied (e.g. to the width and height) so that the area is transformed. -.PP -Example: -.PP -Suppose we have a rectangle, \fCQRect( 10, 20, 30, 40 )\fR and a transformation matrix \fCQWMatrix( 2, 0, 0, 2, 0, 0 )\fR to double the rectangle's size. -.PP -In Points mode, the matrix will transform the top-left (10,20) and the bottom-right (39,59) points producing a rectangle with its top-left point at (20,40) and its bottom-right point at (78,118), i.e. with a width of 59 and a height of 79. -.PP -In Areas mode, the matrix will transform the top-left point in the same way as in Points mode to (20/40), and double the width and height, so the bottom-right will become (69,99), i.e. a width of 60 and a height of 80. -.PP -Because integer arithmetic is used (for speed), rounding differences mean that the modes will produce slightly different results given the same shape and the same transformation, especially when scaling up. This also means that some operations are not commutative. -.PP -Under Points mode, \fCmatrix * ( region1 | region2 )\fR is not equal to \fCmatrix * region1 | matrix * region2\fR. Under Area mode, \fCmatrix * (pointarray[i])\fR is not neccesarily equal to \fC(matrix * pointarry)[i]\fR. -.PP -<center> -.ce 1 -.B "[Image Omitted]" -.PP -</center> -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWMatrix::QWMatrix ()" -Constructs an identity matrix. All elements are set to zero except \fIm11\fR and \fIm22\fR (scaling), which are set to 1. -.SH "QWMatrix::QWMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" -Constructs a matrix with the elements, \fIm11\fR, \fIm12\fR, \fIm21\fR, \fIm22\fR, \fIdx\fR and \fIdy\fR. -.SH "double QWMatrix::det () const" -Returns the matrix's determinant. -.SH "double QWMatrix::dx () const" -Returns the horizontal translation. -.SH "double QWMatrix::dy () const" -Returns the vertical translation. -.SH "QWMatrix QWMatrix::invert ( bool * invertible = 0 ) const" -Returns the inverted matrix. -.PP -If the matrix is singular (not invertible), the identity matrix is returned. -.PP -If \fIinvertible\fR is not 0: the value of \fI*invertible\fR is set to TRUE if the matrix is invertible; otherwise \fI*invertible\fR is set to FALSE. -.PP -See also isInvertible(). -.PP -Example: t14/cannon.cpp. -.SH "bool QWMatrix::isIdentity () const" -Returns TRUE if the matrix is the identity matrix; otherwise returns FALSE. -.PP -See also reset(). -.SH "bool QWMatrix::isInvertible () const" -Returns TRUE if the matrix is invertible; otherwise returns FALSE. -.PP -See also invert(). -.SH "double QWMatrix::m11 () const" -Returns the X scaling factor. -.SH "double QWMatrix::m12 () const" -Returns the vertical shearing factor. -.SH "double QWMatrix::m21 () const" -Returns the horizontal shearing factor. -.SH "double QWMatrix::m22 () const" -Returns the Y scaling factor. -.SH "void QWMatrix::map ( int x, int y, int * tx, int * ty ) const" -Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the formulae: -.PP -.nf -.br - *tx = m11*x + m21*y + dx (rounded to the nearest integer) -.br - *ty = m22*y + m12*x + dy (rounded to the nearest integer) -.br -.fi -.PP -Examples: -.)l t14/cannon.cpp and xform/xform.cpp. -.SH "void QWMatrix::map ( double x, double y, double * tx, double * ty ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the following formulae: -.PP -.nf -.br - *tx = m11*x + m21*y + dx -.br - *ty = m22*y + m12*x + dy -.br -.fi -.SH "QPoint QWMatrix::map ( const QPoint & p ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Transforms \fIp\fR to using the formulae: -.PP -.nf -.br - retx = m11*px + m21*py + dx (rounded to the nearest integer) -.br - rety = m22*py + m12*px + dy (rounded to the nearest integer) -.br -.fi -.SH "QRect QWMatrix::map ( const QRect & r ) const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Please use QWMatrix::mapRect() instead. -.PP -Note that this method does return the bounding rectangle of the \fIr\fR, when shearing or rotations are used. -.SH "QPointArray QWMatrix::map ( const QPointArray & a ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns the point array \fIa\fR transformed by calling map for each point. -.SH "QRegion QWMatrix::map ( const QRegion & r ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Transforms the region \fIr\fR. -.PP -Calling this method can be rather expensive, if rotations or shearing are used. -.SH "QRect QWMatrix::mapRect ( const QRect & rect ) const" -Returns the transformed rectangle \fIrect\fR. -.PP -The bounding rectangle is returned if rotation or shearing has been specified. -.PP -If you need to know the exact region \fIrect\fR maps to use operator*(). -.PP -See also operator*(). -.PP -Example: xform/xform.cpp. -.SH "QPointArray QWMatrix::mapToPolygon ( const QRect & rect ) const" -Returns the transformed rectangle \fIrect\fR as a polygon. -.PP -Polygons and rectangles behave slightly differently when transformed (due to integer rounding), so \fCmatrix.map( QPointArray( rect ) )\fR is not always the same as \fCmatrix.mapToPolygon( rect )\fR. -.SH "QRegion QWMatrix::mapToRegion ( const QRect & rect ) const" -Returns the transformed rectangle \fIrect\fR. -.PP -A rectangle which has been rotated or sheared may result in a non-rectangular region being returned. -.PP -Calling this method can be expensive, if rotations or shearing are used. If you just need to know the bounding rectangle of the returned region, use mapRect() which is a lot faster than this function. -.PP -See also QWMatrix::mapRect(). -.SH "bool QWMatrix::operator!= ( const QWMatrix & m ) const" -Returns TRUE if this matrix is not equal to \fIm\fR; otherwise returns FALSE. -.SH "QWMatrix & QWMatrix::operator*= ( const QWMatrix & m )" -Returns the result of multiplying this matrix by matrix \fIm\fR. -.SH "bool QWMatrix::operator== ( const QWMatrix & m ) const" -Returns TRUE if this matrix is equal to \fIm\fR; otherwise returns FALSE. -.SH "void QWMatrix::reset ()" -Resets the matrix to an identity matrix. -.PP -All elements are set to zero, except \fIm11\fR and \fIm22\fR (scaling) which are set to 1. -.PP -See also isIdentity(). -.SH "QWMatrix & QWMatrix::rotate ( double a )" -Rotates the coordinate system \fIa\fR degrees counterclockwise. -.PP -Returns a reference to the matrix. -.PP -See also translate(), scale(), and shear(). -.PP -Examples: -.)l canvas/canvas.cpp, desktop/desktop.cpp, drawdemo/drawdemo.cpp, t14/cannon.cpp, and xform/xform.cpp. -.SH "QWMatrix & QWMatrix::scale ( double sx, double sy )" -Scales the coordinate system unit by \fIsx\fR horizontally and \fIsy\fR vertically. -.PP -Returns a reference to the matrix. -.PP -See also translate(), shear(), and rotate(). -.PP -Examples: -.)l canvas/canvas.cpp, fileiconview/qfileiconview.cpp, movies/main.cpp, qmag/qmag.cpp, showimg/showimg.cpp, and xform/xform.cpp. -.SH "void QWMatrix::setMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" -Sets the matrix elements to the specified values, \fIm11\fR, \fIm12\fR, \fIm21\fR, \fIm22\fR, \fIdx\fR and \fIdy\fR. -.SH "void QWMatrix::setTransformationMode ( QWMatrix::TransformationMode m )\fC [static]\fR" -Sets the transformation mode that QWMatrix and painter transformations use to \fIm\fR. -.PP -See also QWMatrix::TransformationMode. -.SH "QWMatrix & QWMatrix::shear ( double sh, double sv )" -Shears the coordinate system by \fIsh\fR horizontally and \fIsv\fR vertically. -.PP -Returns a reference to the matrix. -.PP -See also translate(), scale(), and rotate(). -.PP -Examples: -.)l drawdemo/drawdemo.cpp and xform/xform.cpp. -.SH "TransformationMode QWMatrix::transformationMode ()\fC [static]\fR" -Returns the current transformation mode. -.PP -See also QWMatrix::TransformationMode. -.SH "QWMatrix & QWMatrix::translate ( double dx, double dy )" -Moves the coordinate system \fIdx\fR along the X-axis and \fIdy\fR along the Y-axis. -.PP -Returns a reference to the matrix. -.PP -See also scale(), shear(), and rotate(). -.PP -Examples: -.)l canvas/canvas.cpp, drawdemo/drawdemo.cpp, t14/cannon.cpp, and xform/xform.cpp. -.SH RELATED FUNCTION DOCUMENTATION -.SH "QDataStream & operator<< ( QDataStream & s, const QWMatrix & m )" -Writes the matrix \fIm\fR to the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. -.SH "QDataStream & operator>> ( QDataStream & s, QWMatrix & m )" -Reads the matrix \fIm\fR from the stream \fIs\fR and returns a reference to the stream. -.PP -See also Format of the QDataStream operators. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwmatrix.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwmatrix.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qworkspace.3qt b/doc/man/man3/qworkspace.3qt deleted file mode 100644 index 1ff1a5877..000000000 --- a/doc/man/man3/qworkspace.3qt +++ /dev/null @@ -1,196 +0,0 @@ -'\" t -.TH QWorkspace 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 -QWorkspace \- Workspace window that can contain decorated windows, e.g. for MDI -.SH SYNOPSIS -\fC#include <ntqworkspace.h>\fR -.PP -Inherits QWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWorkspace\fR ( QWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QWorkspace\fR ()" -.br -.ti -1c -.BI "enum \fBWindowOrder\fR { CreationOrder, StackingOrder }" -.br -.ti -1c -.BI "QWidget * \fBactiveWindow\fR () const" -.br -.ti -1c -.BI "QWidgetList windowList () const \fI(obsolete)\fR" -.br -.ti -1c -.BI "QWidgetList \fBwindowList\fR ( WindowOrder order ) const" -.br -.ti -1c -.BI "bool \fBscrollBarsEnabled\fR () const" -.br -.ti -1c -.BI "void \fBsetScrollBarsEnabled\fR ( bool enable )" -.br -.in -1c -.SS "Public Slots" -.in +1c -.ti -1c -.BI "void \fBcascade\fR ()" -.br -.ti -1c -.BI "void \fBtile\fR ()" -.br -.ti -1c -.BI "void \fBcloseActiveWindow\fR ()" -.br -.ti -1c -.BI "void \fBcloseAllWindows\fR ()" -.br -.ti -1c -.BI "void \fBactivateNextWindow\fR ()" -.br -.ti -1c -.BI "void \fBactivatePrevWindow\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBwindowActivated\fR ( QWidget * w )" -.br -.in -1c -.SS "Properties" -.in +1c -.ti -1c -.BI "bool \fBscrollBarsEnabled\fR - whether the workspace provides scrollbars" -.br -.in -1c -.SH DESCRIPTION -The QWorkspace widget provides a workspace window that can contain decorated windows, e.g. for MDI. -.PP -MDI (multiple document interface) applications typically have one main window with a menu bar and toolbar, and a central widget that is a QWorkspace. The workspace itself contains zero, one or more document windows, each of which is a widget. -.PP -The workspace itself is an ordinary Qt widget. It has a standard constructor that takes a parent widget and an object name. The parent window is usually a QMainWindow, but it need not be. -.PP -Document windows (i.e. MDI windows) are also ordinary Qt widgets which have the workspace as their parent widget. When you call show(), hide(), showMaximized(), setCaption(), etc. on a document window, it is shown, hidden, etc. with a frame, caption, icon and icon text, just as you'd expect. You can provide widget flags which will be used for the layout of the decoration or the behaviour of the widget itself. -.PP -To change or retrieve the geometry of MDI windows you must operate on the MDI widget's parentWidget(). (The parentWidget() provides access to the decorated window in which the MDI window's widget is shown.) -.PP -A document window becomes active when it gets the keyboard focus. You can also activate a window in code using setFocus(). The user can activate a window by moving focus in the usual ways, for example by clicking a window or by pressing Tab. The workspace emits a signal windowActivated() when it detects the activation change, and the function activeWindow() always returns a pointer to the active document window. -.PP -The convenience function windowList() returns a list of all document windows. This is useful to create a popup menu" <u>W</u>indows" on the fly, for example. -.PP -QWorkspace provides two built-in layout strategies for child windows: cascade() and tile(). Both are slots so you can easily connect menu entries to them. -.PP -If you want your users to be able to work with document windows larger than the actual workspace, set the scrollBarsEnabled property to TRUE. -.PP -If the top-level window contains a menu bar and a document window is maximised, QWorkspace moves the document window's minimize, restore and close buttons from the document window's frame to the workspace window's menu bar. It then inserts a window operations menu at the far left of the menu bar. -.PP -See also Main Window and Related Classes and Organizers. -.SS "Member Type Documentation" -.SH "QWorkspace::WindowOrder" -Specifies the order in which windows are returned from windowList(). -.TP -\fCQWorkspace::CreationOrder\fR - The windows are returned in the order of their creation -.TP -\fCQWorkspace::StackingOrder\fR - The windows are returned in the order of their stacking -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWorkspace::QWorkspace ( QWidget * parent = 0, const char * name = 0 )" -Constructs a workspace with a \fIparent\fR and a \fIname\fR. -.SH "QWorkspace::~QWorkspace ()" -Destroys the workspace and frees any allocated resources. -.SH "void QWorkspace::activateNextWindow ()\fC [slot]\fR" -Activates the next window in the child window chain. -.PP -See also activatePrevWindow(). -.SH "void QWorkspace::activatePrevWindow ()\fC [slot]\fR" -Activates the previous window in the child window chain. -.PP -See also activateNextWindow(). -.SH "QWidget * QWorkspace::activeWindow () const" -Returns the active window, or 0 if no window is active. -.PP -Example: mdi/application.cpp. -.SH "void QWorkspace::cascade ()\fC [slot]\fR" -Arranges all the child windows in a cascade pattern. -.PP -See also tile(). -.PP -Example: mdi/application.cpp. -.SH "void QWorkspace::closeActiveWindow ()\fC [slot]\fR" -Closes the child window that is currently active. -.PP -See also closeAllWindows(). -.SH "void QWorkspace::closeAllWindows ()\fC [slot]\fR" -Closes all child windows. -.PP -The windows are closed in random order. The operation stops if a window does not accept the close event. -.PP -See also closeActiveWindow(). -.SH "bool QWorkspace::scrollBarsEnabled () const" -Returns TRUE if the workspace provides scrollbars; otherwise returns FALSE. See the "scrollBarsEnabled" property for details. -.SH "void QWorkspace::setScrollBarsEnabled ( bool enable )" -Sets whether the workspace provides scrollbars to \fIenable\fR. See the "scrollBarsEnabled" property for details. -.SH "void QWorkspace::tile ()\fC [slot]\fR" -Arranges all child windows in a tile pattern. -.PP -See also cascade(). -.PP -Example: mdi/application.cpp. -.SH "void QWorkspace::windowActivated ( QWidget * w )\fC [signal]\fR" -This signal is emitted when the window widget \fIw\fR becomes active. Note that \fIw\fR can be null, and that more than one signal may be emitted for a single activation event. -.PP -See also activeWindow() and windowList(). -.SH "QWidgetList QWorkspace::windowList ( WindowOrder order ) const" -Returns a list of all windows. If \fIorder\fR is CreationOrder (the default) the windows are listed in the order in which they had been inserted into the workspace. If \fIorder\fR is StackingOrder the windows are listed in their stacking order, with the topmost window being the last window in the list. -.PP -QWidgetList is the same as QPtrList<QWidget>. -.PP -See also QPtrList. -.PP -Example: mdi/application.cpp. -.SH "QWidgetList QWorkspace::windowList () const" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -.SS "Property Documentation" -.SH "bool scrollBarsEnabled" -This property holds whether the workspace provides scrollbars. -.PP -If this property is set to TRUE, it is possible to resize child windows over the right or the bottom edge out of the visible area of the workspace. The workspace shows scrollbars to make it possible for the user to access those windows. If this property is set to FALSE (the default), resizing windows out of the visible area of the workspace is not permitted. -.PP -Set this property's value with setScrollBarsEnabled() and get this property's value with scrollBarsEnabled(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqworkspace.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qworkspace.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwsdecoration.3qt b/doc/man/man3/qwsdecoration.3qt deleted file mode 100644 index 63bc8e039..000000000 --- a/doc/man/man3/qwsdecoration.3qt +++ /dev/null @@ -1,156 +0,0 @@ -'\" t -.TH QWSDecoration 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 -QWSDecoration \- Allows the appearance of the Qt/Embedded Window Manager to be customized -.SH SYNOPSIS -\fC#include <qwsdecoration_qws.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWSDecoration\fR ()" -.br -.ti -1c -.BI "virtual \fB~QWSDecoration\fR ()" -.br -.ti -1c -.BI "enum \fBRegion\fR { None = 0, All = 1, Title = 2, Top = 3, Bottom = 4, Left = 5, Right = 6, TopLeft = 7, TopRight = 8, BottomLeft = 9, BottomRight = 10, Close = 11, Minimize = 12, Maximize = 13, Normalize = 14, Menu = 15, LastRegion = Menu }" -.br -.ti -1c -.BI "virtual QRegion \fBregion\fR ( const QWidget * widget, const QRect & rect, Region type = All ) = 0" -.br -.ti -1c -.BI "virtual void \fBclose\fR ( QWidget * widget )" -.br -.ti -1c -.BI "virtual void \fBminimize\fR ( QWidget * widget )" -.br -.ti -1c -.BI "virtual void \fBmaximize\fR ( QWidget * widget )" -.br -.ti -1c -.BI "virtual QPopupMenu * \fBmenu\fR ( const QWidget *, const QPoint & )" -.br -.ti -1c -.BI "virtual void \fBpaint\fR ( QPainter * painter, const QWidget * widget ) = 0" -.br -.ti -1c -.BI "virtual void \fBpaintButton\fR ( QPainter * painter, const QWidget * widget, Region type, int state ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QWSDecoration class allows the appearance of the Qt/Embedded Window Manager to be customized. -.PP -Qt/Embedded provides window management to top level windows. The appearance of the borders and buttons (the decoration) around the managed windows can be customized by creating your own class derived from QWSDecoration and overriding a few methods. -.PP -This class is non-portable. It is available \fIonly\fR in Qt/Embedded. -.PP -See also QApplication::qwsSetDecoration() and Qt/Embedded. -.SS "Member Type Documentation" -.SH "QWSDecoration::Region" -This enum describes the regions in the window decorations. -.TP -\fCQWSDecoration::None\fR - used internally. -.TP -\fCQWSDecoration::All\fR - the entire region used by the window decoration. -.TP -\fCQWSDecoration::Title\fR - Displays the window title and allows the window to be moved by dragging. -.TP -\fCQWSDecoration::Top\fR - allows the top of the window to be resized. -.TP -\fCQWSDecoration::Bottom\fR - allows the bottom of the window to be resized. -.TP -\fCQWSDecoration::Left\fR - allows the left edge of the window to be resized. -.TP -\fCQWSDecoration::Right\fR - allows the right edge of the window to be resized. -.TP -\fCQWSDecoration::TopLeft\fR - allows the top-left of the window to be resized. -.TP -\fCQWSDecoration::TopRight\fR - allows the top-right of the window to be resized. -.TP -\fCQWSDecoration::BottomLeft\fR - allows the bottom-left of the window to be resized. -.TP -\fCQWSDecoration::BottomRight\fR - allows the bottom-right of the window to be resized. -.TP -\fCQWSDecoration::Close\fR - clicking in this region closes the window. -.TP -\fCQWSDecoration::Minimize\fR - clicking in this region minimizes the window. -.TP -\fCQWSDecoration::Maximize\fR - clicking in this region maximizes the window. -.TP -\fCQWSDecoration::Normalize\fR - returns a maximized window to its previous size. -.TP -\fCQWSDecoration::Menu\fR - clicking in this region opens the window operations (system) menu. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSDecoration::QWSDecoration ()" -Constructs a decorator. -.SH "QWSDecoration::~QWSDecoration ()\fC [virtual]\fR" -Destroys a decorator. -.SH "void QWSDecoration::close ( QWidget * widget )\fC [virtual]\fR" -Called when the user clicks in the Close region. -.PP -\fIwidget\fR is the widget to be closed. -.PP -The default behaviour is to close the widget. -.SH "void QWSDecoration::maximize ( QWidget * widget )\fC [virtual]\fR" -Called when the user clicks in the Maximize region. -.PP -\fIwidget\fR is the widget to be maximized. -.PP -The default behaviour is to resize the widget to be full-screen. This method can be overridden e.g. to allow room for launch panels. -.SH "QPopupMenu * QWSDecoration::menu ( const QWidget *, const QPoint & )\fC [virtual]\fR" -Called to create a QPopupMenu containing the valid menu operations. -.PP -The default implementation adds all possible window operations. -.SH "void QWSDecoration::minimize ( QWidget * widget )\fC [virtual]\fR" -Called when the user clicks in the Minimize region. -.PP -\fIwidget\fR is the widget to be minimized. -.PP -The default behaviour is to ignore this action. -.SH "void QWSDecoration::paint ( QPainter * painter, const QWidget * widget )\fC [pure virtual]\fR" -Override to paint the border and title decoration around \fIwidget\fR using \fIpainter\fR. -.SH "void QWSDecoration::paintButton ( QPainter * painter, const QWidget * widget, Region type, int state )\fC [pure virtual]\fR" -Override to paint a button of type \fItype\fR using \fIpainter\fR. -.PP -\fIwidget\fR is the widget whose button is to be drawn. \fIstate\fR is the state of the button. It can be a combination of the following OR-ed together: -.TP -\fCQWSButton::MouseOver\fR -.TP -\fCQWSButton::Clicked\fR -.TP -\fCQWSButton::On\fR -.SH "QRegion QWSDecoration::region ( const QWidget * widget, const QRect & rect, Region type = All )\fC [pure virtual]\fR" -Returns the requested region \fItype\fR which will contain \fIwidget\fR -with geometry \fIrect\fR. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwsdecoration.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwsdecoration.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwsinputmethod.3qt b/doc/man/man3/qwsinputmethod.3qt deleted file mode 100644 index 138ebbc40..000000000 --- a/doc/man/man3/qwsinputmethod.3qt +++ /dev/null @@ -1,105 +0,0 @@ -'\" t -.TH QWSInputMethod 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 -QWSInputMethod \- International input methods for Qt/Embedded -.SH SYNOPSIS -\fC#include <qwindowsystem_qws.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWSInputMethod\fR ()" -.br -.ti -1c -.BI "virtual \fB~QWSInputMethod\fR ()" -.br -.ti -1c -.BI "virtual bool \fBfilter\fR ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat ) = 0" -.br -.ti -1c -.BI "virtual void \fBreset\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetMicroFocus\fR ( int x, int y )" -.br -.ti -1c -.BI "virtual void \fBsetFont\fR ( const QFont & )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "void \fBsendIMEvent\fR ( QWSServer::IMState state, const QString & txt, int cpos, int selLen = 0 )" -.br -.in -1c -.SH DESCRIPTION -The QWSInputMethod class provides international input methods for Qt/Embedded. -.PP -Subclass this class to implement your own input method. -.PP -An input methods consists of a keyboard filter and optionally a graphical interface. The keyboard filter intercepts key events from physical or virtual keyboards by implementing the filter() function. -.PP -Use sendIMEvent() to send composition events. Composition starts with the input method sending an \fCIMStart\fR event, followed by a number of \fCIMCompose\fR events and ending with an \fCIMEnd\fR event or when the virtual reset() function is called. -.PP -The functions setMicroFocus() and setFont() can be reimplemented to receive more information about the state of the focus widget. -.PP -Use QWSServer::setCurrentInputMethod() to install an input method. -.PP -See also Qt/Embedded. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSInputMethod::QWSInputMethod ()" -Constructs a new input method -.SH "QWSInputMethod::~QWSInputMethod ()\fC [virtual]\fR" -Destructs the input method uninstalling it if it is currently installed. -.SH "bool QWSInputMethod::filter ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )\fC [pure virtual]\fR" -This function must be implemented in subclasses to handle key input from physical or virtual keyboards. Returning TRUE will block the event from further processing. -.PP -The Unicode value is given in \fIunicode\fR and the key code in \fIkeycode\fR. Keyboard modifiers are OR-ed together in \fImodifiers\fR. If \fIisPress\fR is TRUE this is a key press; otherwise it is a key release. If \fIautoRepeat\fR is TRUE this is an auto-repeated key press. -.PP -All normal key events should be blocked while in compose mode (i.e., between \fCIMStart\fR and \fCIMEnd\fR). -.SH "void QWSInputMethod::reset ()\fC [virtual]\fR" -Implemented in subclasses to reset the state of the input method. -.SH "void QWSInputMethod::sendIMEvent ( QWSServer::IMState state, const QString & txt, int cpos, int selLen = 0 )\fC [protected]\fR" -Causes a QIMEvent to be sent to the focus widget. \fIstate\fR may be one of QWSServer::IMStart, QWSServer::IMCompose or QWSServer::IMEnd. -.PP -\fItxt\fR is the text being composed (or the finished text if state is \fCIMEnd\fR). \fIcpos\fR is the current cursor position. -.PP -If state is \fCIMCompose\fR, \fIselLen\fR is the number of characters in the composition string (starting at \fIcpos\fR) that should be marked as selected by the input widget receiving the event. -.SH "void QWSInputMethod::setFont ( const QFont & )\fC [virtual]\fR" -Implemented in subclasses to handle font changes in the focus widget. -.PP -This functionality is provided for future expansion; it is not used in this version of Qt/Embedded. -.SH "void QWSInputMethod::setMicroFocus ( int x, int y )\fC [virtual]\fR" -Implemented in subclasses to handle microFocusHint changes in the focus widget. \fIx\fR and \fIy\fR are the global coordinates of the text cursor. -.PP - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwsinputmethod.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwsinputmethod.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwskeyboardhandler.3qt b/doc/man/man3/qwskeyboardhandler.3qt deleted file mode 100644 index bd5226677..000000000 --- a/doc/man/man3/qwskeyboardhandler.3qt +++ /dev/null @@ -1,77 +0,0 @@ -'\" t -.TH QWSKeyboardHandler 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 -QWSKeyboardHandler \- Implements the keyboard driver for Qt/Embedded -.SH SYNOPSIS -\fC#include <qkeyboard_qws.h>\fR -.PP -Inherits QObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWSKeyboardHandler\fR ()" -.br -.ti -1c -.BI "virtual \fB~QWSKeyboardHandler\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual void \fBprocessKeyEvent\fR ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )" -.br -.in -1c -.SH DESCRIPTION -The QWSKeyboardHandler class implements the keyboard driver for Qt/Embedded. -.PP -The keyboard driver handles events from system devices and generates key events. -.PP -A QWSKeyboardHandler will usually open some system device in its constructor, create a QSocketNotifier on that opened device and when it receives data, it will call processKeyEvent() to send the event to Qt/Embedded for relaying to clients. -.PP -See also Qt/Embedded. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSKeyboardHandler::QWSKeyboardHandler ()" -Constructs a keyboard handler. The handler \fImay\fR be passed to the system for later destruction with QWSServer::setKeyboardHandler(), although even without doing this, the handler can function, calling processKeyEvent() to emit events. -.SH "QWSKeyboardHandler::~QWSKeyboardHandler ()\fC [virtual]\fR" -Destroys a keyboard handler. Note that if you have called QWSServer::setKeyboardHandler(), you must not delete the handler. -.SH "void QWSKeyboardHandler::processKeyEvent ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )\fC [virtual protected]\fR" -Subclasses call this function to send a key event. The server may additionally filter the event before sending it on to applications. -.PP -<center>.nf -.TS -l - l. Parameter Meaning \fIunicode\fR The Unicode value for the key, or 0xFFFF is none is appropriate. \fIkeycode\fR The Qt keycode for the key (see Qt::Key for the list of codes). \fImodifiers\fR The set of modifier keys (see Qt::Modifier). \fIisPress\fR Whether this is a press or a release. \fIautoRepeat\fR -.TE -.fi -</center> - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwskeyboardhandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwskeyboardhandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwsmousehandler.3qt b/doc/man/man3/qwsmousehandler.3qt deleted file mode 100644 index cfa4c8cba..000000000 --- a/doc/man/man3/qwsmousehandler.3qt +++ /dev/null @@ -1,89 +0,0 @@ -'\" t -.TH QWSMouseHandler 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 -QWSMouseHandler \- Mouse driver for Qt/Embedded -.SH SYNOPSIS -\fC#include <qmouse_qws.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWSMouseHandler\fR ( const QString & driver = QString::null, const QString & device = QString::null )" -.br -.ti -1c -.BI "virtual \fB~QWSMouseHandler\fR ()" -.br -.ti -1c -.BI "virtual void \fBclearCalibration\fR ()" -.br -.ti -1c -.BI "virtual void \fBcalibrate\fR ( QWSPointerCalibrationData * )" -.br -.ti -1c -.BI "void \fBlimitToScreen\fR ( QPoint & pt )" -.br -.ti -1c -.BI "void \fBmouseChanged\fR ( const QPoint & pos, int bstate )" -.br -.ti -1c -.BI "const QPoint & \fBpos\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QWSMouseHandler class is a mouse driver for Qt/Embedded. -.PP -The mouse driver handles events from system devices and generates mouse events. -.PP -A QWSMouseHandler will usually open some system device in its constructor, create a QSocketNotifier on that opened device and when it receives data, it will call mouseChanged() to send the event to Qt/Embedded for relaying to clients. -.PP -See also Qt/Embedded. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSMouseHandler::QWSMouseHandler ( const QString & driver = QString::null, const QString & device = QString::null )" -Constructs a mouse handler. This becomes the primary mouse handler. -.PP -Note that once created, mouse handlers are controlled by the system and should not be deleted. -.PP -The \fIdriver\fR and \fIdevice\fR arguments are not used by this base class. -.SH "QWSMouseHandler::~QWSMouseHandler ()\fC [virtual]\fR" -Destroys the mouse handler. You should not call this directly. -.SH "void QWSMouseHandler::calibrate ( QWSPointerCalibrationData * )\fC [virtual]\fR" -This method is reimplemented in the calibrated mouse handler to set calibration information (from, for instance, the Qtopia calibration screen). This version does nothing. -.SH "void QWSMouseHandler::clearCalibration ()\fC [virtual]\fR" -This method is reimplemented in the calibrated mouse handler to clear calibration information. This version does nothing. -.SH "void QWSMouseHandler::limitToScreen ( QPoint & pt )" -Ensures that the given point, \fIpt\fR is within the screen's boundaries, changing \fIpt\fR if necessary. -.SH "void QWSMouseHandler::mouseChanged ( const QPoint & pos, int bstate )" -When a mouse event occurs this function is called with the mouse's position in \fIpos\fR, and the state of its buttons in \fIbstate\fR. -.SH "const QPoint & QWSMouseHandler::pos () const" -Returns the mouse position. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwsmousehandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwsmousehandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwsserver.3qt b/doc/man/man3/qwsserver.3qt deleted file mode 100644 index 2d68e2fd0..000000000 --- a/doc/man/man3/qwsserver.3qt +++ /dev/null @@ -1,311 +0,0 @@ -'\" t -.TH QWSServer 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 -QWSServer \- Server-specific functionality in Qt/Embedded -.SH SYNOPSIS -\fC#include <qwindowsystem_qws.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWSServer\fR ( int flags = 0, QObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QWSServer\fR ()" -.br -.ti -1c -.BI "enum \fBServerFlags\fR { DisableKeyboard = 0x01, DisableMouse = 0x02 }" -.br -.ti -1c -.BI "enum \fBGUIMode\fR { NoGui = FALSE, NormalGUI = TRUE, Server }" -.br -.ti -1c -.BI "void \fBsendIMEvent\fR ( IMState state, const QString & txt, int cpos, int selLen )" -.br -.ti -1c -.BI "class \fBKeyMap\fR { }" -.br -.ti -1c -.BI "class \fBKeyOverride\fR { }" -.br -.ti -1c -.BI "class \fBKeyboardFilter\fR { }" -.br -.ti -1c -.BI "QWSWindow * \fBwindowAt\fR ( const QPoint & pos )" -.br -.ti -1c -.BI "const QPtrList<QWSWindow> & \fBclientWindows\fR ()" -.br -.ti -1c -.BI "void \fBopenMouse\fR ()" -.br -.ti -1c -.BI "void \fBcloseMouse\fR ()" -.br -.ti -1c -.BI "void \fBopenKeyboard\fR ()" -.br -.ti -1c -.BI "void \fBcloseKeyboard\fR ()" -.br -.ti -1c -.BI "void \fBrefresh\fR ()" -.br -.ti -1c -.BI "void \fBrefresh\fR ( QRegion & r )" -.br -.ti -1c -.BI "void \fBenablePainting\fR ( bool e )" -.br -.ti -1c -.BI "QWSPropertyManager * \fBmanager\fR ()" -.br -.ti -1c -.BI "enum \fBWindowEvent\fR { Create = 0x0001, Destroy = 0x0002, Hide = 0x0004, Show = 0x0008, Raise = 0x0010, Lower = 0x0020, Geometry = 0x0040, Active = 0x0080, Name = 0x0100 }" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBwindowEvent\fR ( QWSWindow * w, QWSServer::WindowEvent e )" -.br -.ti -1c -.BI "void \fBnewChannel\fR ( const QString & channel )" -.br -.ti -1c -.BI "void \fBremovedChannel\fR ( const QString & channel )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBsendKeyEvent\fR ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )" -.br -.ti -1c -.BI "const KeyMap * \fBkeyMap\fR ()" -.br -.ti -1c -.BI "void \fBsetOverrideKeys\fR ( const KeyOverride * )" -.br -.ti -1c -.BI "void \fBsetKeyboardFilter\fR ( KeyboardFilter * f )" -.br -.ti -1c -.BI "void \fBsetDefaultMouse\fR ( const char * m )" -.br -.ti -1c -.BI "void \fBsetDefaultKeyboard\fR ( const char * k )" -.br -.ti -1c -.BI "void \fBsetMaxWindowRect\fR ( const QRect & r )" -.br -.ti -1c -.BI "void \fBsetDesktopBackground\fR ( const QImage & img )" -.br -.ti -1c -.BI "void \fBsetDesktopBackground\fR ( const QColor & c )" -.br -.ti -1c -.BI "QWSMouseHandler * \fBmouseHandler\fR ()" -.br -.ti -1c -.BI "QWSKeyboardHandler * \fBkeyboardHandler\fR ()" -.br -.ti -1c -.BI "void \fBsetKeyboardHandler\fR ( QWSKeyboardHandler * kh )" -.br -.ti -1c -.BI "void \fBsetScreenSaverIntervals\fR ( int * ms )" -.br -.ti -1c -.BI "void \fBsetScreenSaverInterval\fR ( int ms )" -.br -.ti -1c -.BI "bool \fBscreenSaverActive\fR ()" -.br -.ti -1c -.BI "void \fBscreenSaverActivate\fR ( bool activate )" -.br -.ti -1c -.BI "void \fBsetCursorVisible\fR ( bool vis )" -.br -.ti -1c -.BI "bool \fBisCursorVisible\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWSServer class provides server-specific functionality in Qt/Embedded. -.PP -When you run a Qt/Embedded application, it either runs as a server or connects to an existing server. If it runs as a server, some additional operations are provided by this class. -.PP -This class is instantiated by QApplication for Qt/Embedded server processes. You should never construct this class yourself. -.PP -A pointer to the QWSServer instance can be obtained via the global \fCqwsServer\fR variable. -.PP -The mouse and keyboard devices can be opened with openMouse() and openKeyboard(). (Close them with closeMouse() and closeKeyboard().) -.PP -The display is refreshed with refresh(), and painting can be enabled or disabled with enablePainting(). -.PP -Obtain the list of client windows with clientWindows() and find out which window is at a particular point with windowAt(). -.PP -Many static functions are provided, for example, setKeyboardFilter(), setKeyboardHandler(), setDefaultKeyboard() and setDefaultMouse(). -.PP -The size of the window rectangle can be set with setMaxWindowRect(), and the desktop's background can be set with setDesktopBackground(). -.PP -The screen saver is controlled with setScreenSaverInterval() and screenSaverActivate(). -.PP -See also Qt/Embedded. -.SS "Member Type Documentation" -.SH "QWSServer::GUIMode" -This determines what sort of QWS server to create: -.TP -\fCQWSServer::NoGui\fR - This is used for non-graphical Qt applications. -.TP -\fCQWSServer::NormalGUI\fR - A normal Qt/Embedded application (not the server). -.TP -\fCQWSServer::Server\fR - A Qt/Embedded server (e.g. if \fC-qws\fR has been specified on the command line. -.SH "QWSServer::ServerFlags" -This enum is used to pass various options to the window system server. -.TP -\fCQWSServer::DisableKeyboard\fR - Ignore all keyboard input. -.TP -\fCQWSServer::DisableMouse\fR - Ignore all mouse input. -.SH "QWSServer::WindowEvent" -This specifies what sort of event has occurred to a top-level window: -.TP -\fCQWSServer::Create\fR - A new window has been created (QWidget constructor). -.TP -\fCQWSServer::Destroy\fR - The window has been closed and deleted (QWidget destructor). -.TP -\fCQWSServer::Hide\fR - The window has been hidden with QWidget::hide(). -.TP -\fCQWSServer::Show\fR - The window has been shown with QWidget::show() or similar. -.TP -\fCQWSServer::Raise\fR - The window has been raised to the top of the desktop. -.TP -\fCQWSServer::Lower\fR - The window has been lowered. -.TP -\fCQWSServer::Geometry\fR - The window has changed size or position. -.TP -\fCQWSServer::Active\fR - The window has become the active window (has keyboard focus). -.TP -\fCQWSServer::Name\fR - The window has been named. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSServer::QWSServer ( int flags = 0, QObject * parent = 0, const char * name = 0 )" -Construct a QWSServer object. -.PP -\fBWarning:\fR This class is instantiated by QApplication for Qt/Embedded server processes. You should never construct this class yourself. -.PP -The \fIflags\fR are used for keyboard and mouse setting. The server's parent is \fIparent\fR and it is called \fIname\fR. -.SH "QWSServer::~QWSServer ()" -Destruct QWSServer -.SH "const QPtrList<QWSWindow> & QWSServer::clientWindows ()" -Returns the list of top-level windows. This list will change as applications add and remove wigdets so it should not be stored for future use. The windows are sorted in stacking order from top-most to bottom-most. -.SH "void QWSServer::closeKeyboard ()" -Closes keyboard device(s). -.SH "void QWSServer::closeMouse ()" -Closes the pointer device(s). -.SH "void QWSServer::enablePainting ( bool e )" -If \fIe\fR is TRUE, painting on the display is enabled; if \fIe\fR is FALSE, painting is disabled. -.SH "bool QWSServer::isCursorVisible ()\fC [static]\fR" -Returns TRUE if the cursor is visible; otherwise returns FALSE. -.PP -See also setCursorVisible(). -.SH "const KeyMap * QWSServer::keyMap ()\fC [static]\fR" -Returns the keyboard mapping table used to convert keyboard scancodes to Qt keycodes and Unicode values. It's used by the keyboard driver in \fCqkeyboard_qws.cpp\fR. -.SH "QWSKeyboardHandler * QWSServer::keyboardHandler ()\fC [static]\fR" -Returns the primary keyboard handler. -.SH "QWSPropertyManager * QWSServer::manager ()" -Returns the QWSPropertyManager, which is used for implementing X11-style window properties. -.SH "QWSMouseHandler * QWSServer::mouseHandler ()\fC [static]\fR" -Returns the primary mouse handler. -.SH "void QWSServer::newChannel ( const QString & channel )\fC [signal]\fR" -This signal is emitted when the QCopChannel \fIchannel\fR is created. -.SH "void QWSServer::openKeyboard ()" -Opens the keyboard device(s). -.SH "void QWSServer::openMouse ()" -Opens the mouse device(s). -.SH "void QWSServer::refresh ()" -Refreshes the entire display. -.SH "void QWSServer::refresh ( QRegion & r )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Refreshes the region \fIr\fR. -.SH "void QWSServer::removedChannel ( const QString & channel )\fC [signal]\fR" -This signal is emitted immediately after the QCopChannel \fIchannel\fR is destroyed. Note that a channel is not destroyed until all its listeners have unregistered. -.SH "void QWSServer::screenSaverActivate ( bool activate )\fC [static]\fR" -If \fIactivate\fR is TRUE the screensaver is activated immediately; if \fIactivate\fR is FALSE the screensaver is deactivated. -.SH "bool QWSServer::screenSaverActive ()\fC [static]\fR" -Returns TRUE if the screensaver is active (i.e. the screen is blanked); otherwise returns FALSE. -.SH "void QWSServer::sendIMEvent ( IMState state, const QString & txt, int cpos, int selLen )" -This function sends an input method event to the server. The current state is passed in \fIstate\fR and the current text in \fItxt\fR. The cursor's position in the text is given by \fIcpos\fR, and the selection length (which could be 0) is given in \fIselLen\fR. -.SH "void QWSServer::sendKeyEvent ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )\fC [static]\fR" -Send a key event. You can use this to send key events generated by" virtual keyboards". \fIunicode\fR is the Unicode value of the key to send, \fIkeycode\fR the Qt keycode (e.g. \fCKey_Left\fR), \fImodifiers\fR indicates whether, Shift/Alt/Ctrl keys are pressed, \fIisPress\fR is TRUE if this is a key down event and FALSE if it's a key up event, and \fIautoRepeat\fR is TRUE if this is an autorepeat event (i.e. the user has held the key down and this is the second or subsequent key event being sent). -.SH "void QWSServer::setCursorVisible ( bool vis )\fC [static]\fR" -If \fIvis\fR is TRUE, makes the cursor visible; if \fIvis\fR is FALSE, makes the cursor invisible. -.PP -See also isCursorVisible(). -.SH "void QWSServer::setDefaultKeyboard ( const char * k )\fC [static]\fR" -Set the keyboard driver to \fIk\fR, e.g. if \fC$QWS_KEYBOARD\fR is not defined. The default is platform-dependent. -.SH "void QWSServer::setDefaultMouse ( const char * m )\fC [static]\fR" -Set the mouse driver \fIm\fR to use if \fC$QWS_MOUSE_PROTO\fR is not defined. The default is platform-dependent. -.SH "void QWSServer::setDesktopBackground ( const QImage & img )\fC [static]\fR" -Sets the image \fIimg\fR to be used as the background in the absence of obscuring windows. -.SH "void QWSServer::setDesktopBackground ( const QColor & c )\fC [static]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Sets the color \fIc\fR to be used as the background in the absence of obscuring windows. -.SH "void QWSServer::setKeyboardFilter ( KeyboardFilter * f )\fC [static]\fR" -Adds a filter \fIf\fR to be invoked for all key events from physical keyboard drivers (events sent via processKeyEvent()). -.PP -The filter is not invoked for keys generated by virtual keyboard drivers (events sent via sendKeyEvent()). -.PP -If \fIf\fR is 0, the most-recently added filter is removed and deleted. The caller is responsible for matching each addition with a corresponding removal. -.SH "void QWSServer::setKeyboardHandler ( QWSKeyboardHandler * kh )\fC [static]\fR" -Sets the primary keyboard handler to \fIkh\fR. -.SH "void QWSServer::setMaxWindowRect ( const QRect & r )\fC [static]\fR" -Sets the area of the screen which Qt/Embedded applications will consider to be the maximum area to use for windows to \fIr\fR. -.PP -See also QWidget::showMaximized(). -.SH "void QWSServer::setScreenSaverInterval ( int ms )\fC [static]\fR" -Sets the timeout for the screensaver to \fIms\fR milliseconds. A setting of zero turns off the screensaver. -.SH "void QWSServer::setScreenSaverIntervals ( int * ms )\fC [static]\fR" -Sets an array of timeouts for the screensaver to a list of \fIms\fR milliseconds. A setting of zero turns off the screensaver. The array must be 0-terminated. -.SH "QWSWindow * QWSServer::windowAt ( const QPoint & pos )" -Returns the window containing the point \fIpos\fR or 0 if there is no window under the point. -.SH "void QWSServer::windowEvent ( QWSWindow * w, QWSServer::WindowEvent e )\fC [signal]\fR" -This signal is emitted whenever something happens to a top-level -window (e.g. it's created or destroyed). \fIw\fR is the window to -which the event of type \fIe\fR has occurred. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwsserver.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwsserver.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qwswindow.3qt b/doc/man/man3/qwswindow.3qt deleted file mode 100644 index abc89721c..000000000 --- a/doc/man/man3/qwswindow.3qt +++ /dev/null @@ -1,140 +0,0 @@ -'\" t -.TH QWSWindow 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 -QWSWindow \- Server-specific functionality in Qt/Embedded -.SH SYNOPSIS -\fC#include <qwindowsystem_qws.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQWSWindow\fR ( int i, QWSClient * client )" -.br -.ti -1c -.BI "\fB~QWSWindow\fR ()" -.br -.ti -1c -.BI "int \fBwinId\fR () const" -.br -.ti -1c -.BI "const QString & \fBname\fR () const" -.br -.ti -1c -.BI "const QString & \fBcaption\fR () const" -.br -.ti -1c -.BI "QWSClient * \fBclient\fR () const" -.br -.ti -1c -.BI "QRegion \fBrequested\fR () const" -.br -.ti -1c -.BI "QRegion \fBallocation\fR () const" -.br -.ti -1c -.BI "bool \fBisVisible\fR () const" -.br -.ti -1c -.BI "bool \fBisPartiallyObscured\fR () const" -.br -.ti -1c -.BI "bool \fBisFullyObscured\fR () const" -.br -.ti -1c -.BI "void \fBraise\fR ()" -.br -.ti -1c -.BI "void \fBlower\fR ()" -.br -.ti -1c -.BI "void \fBshow\fR ()" -.br -.ti -1c -.BI "void \fBhide\fR ()" -.br -.ti -1c -.BI "void \fBsetActiveWindow\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QWSWindow class provides server-specific functionality in Qt/Embedded. -.PP -When you run a Qt/Embedded application, it either runs as a server or connects to an existing server. If it runs as a server, some additional functionality is provided by the QWSServer class. -.PP -This class maintains information about each window and allows operations to be performed on the windows. -.PP -You can get the window's name(), caption() and winId(), along with the client() that owns the window. -.PP -The region the window wants to draw on is returned by requested(); the region that the window is allowed to draw on is returned by allocation(). -.PP -The visibility of the window can be determined using isVisible(), isPartiallyObscured() and isFullyObscured(). Visibility can be changed using raise(), lower(), show(), hide() and setActiveWindow(). -.PP -See also Qt/Embedded. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QWSWindow::QWSWindow ( int i, QWSClient * client )" -Constructs a new top-level window, associated with the client \fIclient\fR and giving it the id \fIi\fR. -.SH "QWSWindow::~QWSWindow ()" -Destructor. -.SH "QRegion QWSWindow::allocation () const" -Returns the region that the window is allowed to draw onto, including any window decorations but excluding regions covered by other windows. -.PP -See also requested(). -.SH "const QString & QWSWindow::caption () const" -Returns the window's caption. -.SH "QWSClient * QWSWindow::client () const" -Returns the QWSClient that owns this window. -.SH "void QWSWindow::hide ()" -Hides the window. -.SH "bool QWSWindow::isFullyObscured () const" -Returns TRUE if the window is completely obsured by another window or by the bounds of the screen; otherwise returns FALSE. -.SH "bool QWSWindow::isPartiallyObscured () const" -Returns TRUE if the window is partially obsured by another window or by the bounds of the screen; otherwise returns FALSE. -.SH "bool QWSWindow::isVisible () const" -Returns TRUE if the window is visible; otherwise returns FALSE. -.SH "void QWSWindow::lower ()" -Lowers the window below other windows. -.SH "const QString & QWSWindow::name () const" -Returns the window's name. -.SH "void QWSWindow::raise ()" -Raises the window above all other windows except "Stay on top" windows. -.SH "QRegion QWSWindow::requested () const" -Returns the region that the window has requested to draw onto, including any window decorations. -.PP -See also allocation(). -.SH "void QWSWindow::setActiveWindow ()" -Make this the active window (i.e. sets the keyboard focus to this window). -.SH "void QWSWindow::show ()" -Shows the window. -.SH "int QWSWindow::winId () const" -Returns the window's Id. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qwswindow.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qwswindow.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlattributes.3qt b/doc/man/man3/qxmlattributes.3qt deleted file mode 100644 index f7dece288..000000000 --- a/doc/man/man3/qxmlattributes.3qt +++ /dev/null @@ -1,189 +0,0 @@ -'\" t -.TH QXmlAttributes 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 -QXmlAttributes \- XML attributes -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQXmlAttributes\fR ()" -.br -.ti -1c -.BI "virtual \fB~QXmlAttributes\fR ()" -.br -.ti -1c -.BI "int \fBindex\fR ( const QString & qName ) const" -.br -.ti -1c -.BI "int \fBindex\fR ( const QString & uri, const QString & localPart ) const" -.br -.ti -1c -.BI "int \fBlength\fR () const" -.br -.ti -1c -.BI "int \fBcount\fR () const" -.br -.ti -1c -.BI "QString \fBlocalName\fR ( int index ) const" -.br -.ti -1c -.BI "QString \fBqName\fR ( int index ) const" -.br -.ti -1c -.BI "QString \fBuri\fR ( int index ) const" -.br -.ti -1c -.BI "QString \fBtype\fR ( int index ) const" -.br -.ti -1c -.BI "QString \fBtype\fR ( const QString & qName ) const" -.br -.ti -1c -.BI "QString \fBtype\fR ( const QString & uri, const QString & localName ) const" -.br -.ti -1c -.BI "QString \fBvalue\fR ( int index ) const" -.br -.ti -1c -.BI "QString \fBvalue\fR ( const QString & qName ) const" -.br -.ti -1c -.BI "QString \fBvalue\fR ( const QString & uri, const QString & localName ) const" -.br -.ti -1c -.BI "void \fBclear\fR ()" -.br -.ti -1c -.BI "void \fBappend\fR ( const QString & qName, const QString & uri, const QString & localPart, const QString & value )" -.br -.in -1c -.SH DESCRIPTION -The QXmlAttributes class provides XML attributes. -.PP -If attributes are reported by QXmlContentHandler::startElement() this class is used to pass the attribute values. -.PP -Use index() to locate the position of an attribute in the list, count() to retrieve the number of attributes, and clear() to remove the attributes. New attributes can be added with append(). Use type() to get an attribute's type and value() to get its value. The attribute's name is available from localName() or qName(), and its namespace URI from uri(). -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlAttributes::QXmlAttributes ()" -Constructs an empty attribute list. -.SH "QXmlAttributes::~QXmlAttributes ()\fC [virtual]\fR" -Destroys the attributes object. -.SH "void QXmlAttributes::append ( const QString & qName, const QString & uri, const QString & localPart, const QString & value )" -Appends a new attribute entry to the list of attributes. The qualified name of the attribute is \fIqName\fR, the namespace URI is \fIuri\fR and the local name is \fIlocalPart\fR. The value of the attribute is \fIvalue\fR. -.PP -See also qName(), uri(), localName(), and value(). -.SH "void QXmlAttributes::clear ()" -Clears the list of attributes. -.PP -See also append(). -.SH "int QXmlAttributes::count () const" -Returns the number of attributes in the list. This function is equivalent to length(). -.SH "int QXmlAttributes::index ( const QString & qName ) const" -Looks up the index of an attribute by the qualified name \fIqName\fR. -.PP -Returns the index of the attribute or -1 if it wasn't found. -.PP -See also the namespace description. -.SH "int QXmlAttributes::index ( const QString & uri, const QString & localPart ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Looks up the index of an attribute by a namespace name. -.PP -\fIuri\fR specifies the namespace URI, or an empty string if the name has no namespace URI. \fIlocalPart\fR specifies the attribute's local name. -.PP -Returns the index of the attribute, or -1 if it wasn't found. -.PP -See also the namespace description. -.SH "int QXmlAttributes::length () const" -Returns the number of attributes in the list. -.PP -See also count(). -.PP -Example: xml/tagreader-with-features/structureparser.cpp. -.SH "QString QXmlAttributes::localName ( int index ) const" -Looks up an attribute's local name for the attribute at position \fIindex\fR. If no namespace processing is done, the local name is QString::null. -.PP -See also the namespace description. -.SH "QString QXmlAttributes::qName ( int index ) const" -Looks up an attribute's XML 1.0 qualified name for the attribute at position \fIindex\fR. -.PP -See also the namespace description. -.PP -Example: xml/tagreader-with-features/structureparser.cpp. -.SH "QString QXmlAttributes::type ( int index ) const" -Looks up an attribute's type for the attribute at position \fIindex\fR. -.PP -Currently only "CDATA" is returned. -.SH "QString QXmlAttributes::type ( const QString & qName ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Looks up an attribute's type for the qualified name \fIqName\fR. -.PP -Currently only "CDATA" is returned. -.SH "QString QXmlAttributes::type ( const QString & uri, const QString & localName ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Looks up an attribute's type by namespace name. -.PP -\fIuri\fR specifies the namespace URI and \fIlocalName\fR specifies the local name. If the name has no namespace URI, use an empty string for \fIuri\fR. -.PP -Currently only "CDATA" is returned. -.SH "QString QXmlAttributes::uri ( int index ) const" -Looks up an attribute's namespace URI for the attribute at position \fIindex\fR. If no namespace processing is done or if the attribute has no namespace, the namespace URI is QString::null. -.PP -See also the namespace description. -.PP -Example: xml/tagreader-with-features/structureparser.cpp. -.SH "QString QXmlAttributes::value ( int index ) const" -Looks up an attribute's value for the attribute at position \fIindex\fR. -.SH "QString QXmlAttributes::value ( const QString & qName ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Looks up an attribute's value for the qualified name \fIqName\fR. -.PP -See also the namespace description. -.SH "QString QXmlAttributes::value ( const QString & uri, const QString & localName ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Looks up an attribute's value by namespace name. -.PP -\fIuri\fR specifies the namespace URI, or an empty string if the name has no namespace URI. \fIlocalName\fR specifies the attribute's local name. -.PP -See also the namespace description. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlattributes.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlattributes.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlcontenthandler.3qt b/doc/man/man3/qxmlcontenthandler.3qt deleted file mode 100644 index a48309111..000000000 --- a/doc/man/man3/qxmlcontenthandler.3qt +++ /dev/null @@ -1,184 +0,0 @@ -'\" t -.TH QXmlContentHandler 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 -QXmlContentHandler \- Interface to report the logical content of XML data -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherited by QXmlDefaultHandler. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual void \fBsetDocumentLocator\fR ( QXmlLocator * locator ) = 0" -.br -.ti -1c -.BI "virtual bool \fBstartDocument\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBendDocument\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBstartPrefixMapping\fR ( const QString & prefix, const QString & uri ) = 0" -.br -.ti -1c -.BI "virtual bool \fBendPrefixMapping\fR ( const QString & prefix ) = 0" -.br -.ti -1c -.BI "virtual bool \fBstartElement\fR ( const QString & namespaceURI, const QString & localName, const QString & qName, const QXmlAttributes & atts ) = 0" -.br -.ti -1c -.BI "virtual bool \fBendElement\fR ( const QString & namespaceURI, const QString & localName, const QString & qName ) = 0" -.br -.ti -1c -.BI "virtual bool \fBcharacters\fR ( const QString & ch ) = 0" -.br -.ti -1c -.BI "virtual bool \fBignorableWhitespace\fR ( const QString & ch ) = 0" -.br -.ti -1c -.BI "virtual bool \fBprocessingInstruction\fR ( const QString & target, const QString & data ) = 0" -.br -.ti -1c -.BI "virtual bool \fBskippedEntity\fR ( const QString & name ) = 0" -.br -.ti -1c -.BI "virtual QString \fBerrorString\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlContentHandler class provides an interface to report the logical content of XML data. -.PP -If the application needs to be informed of basic parsing events, it can implement this interface and activate it using QXmlReader::setContentHandler(). The reader can then report basic document-related events like the start and end of elements and character data through this interface. -.PP -The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, all of an element's content (character data, processing instructions, and sub-elements) appears, in order, between the startElement() event and the corresponding endElement() event. -.PP -The class QXmlDefaultHandler provides a default implementation for this interface; subclassing from the QXmlDefaultHandler class is very convenient if you only want to be informed of some parsing events. -.PP -The startDocument() function is called at the start of the document, and endDocument() is called at the end. Before parsing begins setDocumentLocator() is called. For each element startElement() is called, with endElement() being called at the end of each element. The characters() function is called with chunks of character data; ignorableWhitespace() is called with chunks of whitespace and processingInstruction() is called with processing instructions. If an entity is skipped skippedEntity() is called. At the beginning of prefix-URI scopes startPrefixMapping() is called. -.PP -See also the Introduction to SAX2. -.PP -See also QXmlDTDHandler, QXmlDeclHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "bool QXmlContentHandler::characters ( const QString & ch )\fC [pure virtual]\fR" -The reader calls this function when it has parsed a chunk of character data (either normal character data or character data inside a CDATA section; if you need to distinguish between those two types you must use QXmlLexicalHandler::startCDATA() and QXmlLexicalHandler::endCDATA()). The character data is reported in \fIch\fR. -.PP -Some readers report whitespace in element content using the ignorableWhitespace() function rather than using this one. -.PP -A reader may report the character data of an element in more than one chunk; e.g. a reader might want to report "a<b" in three characters() events ("a ", "<" and " b"). -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "bool QXmlContentHandler::endDocument ()\fC [pure virtual]\fR" -The reader calls this function after it has finished parsing. It is called just once, and is the last handler function called. It is called after the reader has read all input or has abandoned parsing because of a fatal error. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also startDocument(). -.SH "bool QXmlContentHandler::endElement ( const QString & namespaceURI, const QString & localName, const QString & qName )\fC [pure virtual]\fR" -The reader calls this function when it has parsed an end element tag with the qualified name \fIqName\fR, the local name \fIlocalName\fR and the namespace URI \fInamespaceURI\fR. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also the namespace description. -.PP -See also startElement(). -.PP -Example: xml/tagreader/structureparser.cpp. -.SH "bool QXmlContentHandler::endPrefixMapping ( const QString & prefix )\fC [pure virtual]\fR" -The reader calls this function to signal the end of a prefix mapping for the prefix \fIprefix\fR. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also the namespace description. -.PP -See also startPrefixMapping(). -.SH "QString QXmlContentHandler::errorString ()\fC [pure virtual]\fR" -The reader calls this function to get an error string, e.g. if any of the handler functions returns FALSE. -.SH "bool QXmlContentHandler::ignorableWhitespace ( const QString & ch )\fC [pure virtual]\fR" -Some readers may use this function to report each chunk of whitespace in element content. The whitespace is reported in \fIch\fR. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "bool QXmlContentHandler::processingInstruction ( const QString & target, const QString & data )\fC [pure virtual]\fR" -The reader calls this function when it has parsed a processing instruction. -.PP -\fItarget\fR is the target name of the processing instruction and \fIdata\fR is the data in the processing instruction. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "void QXmlContentHandler::setDocumentLocator ( QXmlLocator * locator )\fC [pure virtual]\fR" -The reader calls this function before it starts parsing the document. The argument \fIlocator\fR is a pointer to a QXmlLocator which allows the application to get the parsing position within the document. -.PP -Do not destroy the \fIlocator\fR; it is destroyed when the reader is destroyed. (Do not use the \fIlocator\fR after the reader is destroyed). -.SH "bool QXmlContentHandler::skippedEntity ( const QString & name )\fC [pure virtual]\fR" -Some readers may skip entities if they have not seen the declarations (e.g. because they are in an external DTD). If they do so they report that they skipped the entity called \fIname\fR by calling this function. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "bool QXmlContentHandler::startDocument ()\fC [pure virtual]\fR" -The reader calls this function when it starts parsing the document. The reader calls this function just once, after the call to setDocumentLocator(), and before any other functions in this class or in the QXmlDTDHandler class are called. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also endDocument(). -.PP -Example: xml/tagreader/structureparser.cpp. -.SH "bool QXmlContentHandler::startElement ( const QString & namespaceURI, const QString & localName, const QString & qName, const QXmlAttributes & atts )\fC [pure virtual]\fR" -The reader calls this function when it has parsed a start element tag. -.PP -There is a corresponding endElement() call when the corresponding end element tag is read. The startElement() and endElement() calls are always nested correctly. Empty element tags (e.g. \fC<x/>\fR) cause a startElement() call to be immediately followed by an endElement() call. -.PP -The attribute list provided only contains attributes with explicit values. The attribute list contains attributes used for namespace declaration (i.e. attributes starting with xmlns) only if the namespace-prefix property of the reader is TRUE. -.PP -The argument \fInamespaceURI\fR is the namespace URI, or QString::null if the element has no namespace URI or if no namespace processing is done. \fIlocalName\fR is the local name (without prefix), or QString::null if no namespace processing is done, \fIqName\fR is the qualified name (with prefix) and \fIatts\fR are the attributes attached to the element. If there are no attributes, \fIatts\fR is an empty attributes object. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also the namespace description. -.PP -See also endElement(). -.PP -Example: xml/tagreader/structureparser.cpp. -.SH "bool QXmlContentHandler::startPrefixMapping ( const QString & prefix, const QString & uri )\fC [pure virtual]\fR" -The reader calls this function to signal the begin of a prefix-URI namespace mapping scope. This information is not necessary for normal namespace processing since the reader automatically replaces prefixes for element and attribute names. -.PP -Note that startPrefixMapping() and endPrefixMapping() calls are not guaranteed to be properly nested relative to each other: all startPrefixMapping() events occur before the corresponding startElement() event, and all endPrefixMapping() events occur after the corresponding endElement() event, but their order is not otherwise guaranteed. -.PP -The argument \fIprefix\fR is the namespace prefix being declared and the argument \fIuri\fR is the namespace URI the prefix is mapped to. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also the namespace description. -.PP -See also endPrefixMapping(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlcontenthandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlcontenthandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmldeclhandler.3qt b/doc/man/man3/qxmldeclhandler.3qt deleted file mode 100644 index 6ebd02479..000000000 --- a/doc/man/man3/qxmldeclhandler.3qt +++ /dev/null @@ -1,92 +0,0 @@ -'\" t -.TH QXmlDeclHandler 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 -QXmlDeclHandler \- Interface to report declaration content of XML data -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherited by QXmlDefaultHandler. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual bool \fBattributeDecl\fR ( const QString & eName, const QString & aName, const QString & type, const QString & valueDefault, const QString & value ) = 0" -.br -.ti -1c -.BI "virtual bool \fBinternalEntityDecl\fR ( const QString & name, const QString & value ) = 0" -.br -.ti -1c -.BI "virtual bool \fBexternalEntityDecl\fR ( const QString & name, const QString & publicId, const QString & systemId ) = 0" -.br -.ti -1c -.BI "virtual QString \fBerrorString\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlDeclHandler class provides an interface to report declaration content of XML data. -.PP -You can set the declaration handler with QXmlReader::setDeclHandler(). -.PP -This interface is based on the SAX2 extension DeclHandler. -.PP -The interface provides attributeDecl(), internalEntityDecl() and externalEntityDecl() functions. -.PP -See also the Introduction to SAX2. -.PP -See also QXmlDTDHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "bool QXmlDeclHandler::attributeDecl ( const QString & eName, const QString & aName, const QString & type, const QString & valueDefault, const QString & value )\fC [pure virtual]\fR" -The reader calls this function to report an attribute type declaration. Only the effective (first) declaration for an attribute is reported. -.PP -The reader passes the name of the associated element in \fIeName\fR and the name of the attribute in \fIaName\fR. It passes a string that represents the attribute type in \fItype\fR and a string that represents the attribute default in \fIvalueDefault\fR. This string is one of "#IMPLIED", "#REQUIRED", "#FIXED" or QString::null (if none of the others applies). The reader passes the attribute's default value in \fIvalue\fR. If no default value is specified in the XML file, \fIvalue\fR is QString::null. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "QString QXmlDeclHandler::errorString ()\fC [pure virtual]\fR" -The reader calls this function to get an error string if any of the handler functions returns FALSE. -.SH "bool QXmlDeclHandler::externalEntityDecl ( const QString & name, const QString & publicId, const QString & systemId )\fC [pure virtual]\fR" -The reader calls this function to report a parsed external entity declaration. Only the effective (first) declaration for each entity is reported. -.PP -The reader passes the name of the entity in \fIname\fR, the public identifier in \fIpublicId\fR and the system identifier in \fIsystemId\fR. If there is no public identifier specified, it passes QString::null in \fIpublicId\fR. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "bool QXmlDeclHandler::internalEntityDecl ( const QString & name, const QString & value )\fC [pure virtual]\fR" -The reader calls this function to report an internal entity declaration. Only the effective (first) declaration is reported. -.PP -The reader passes the name of the entity in \fIname\fR and the value of the entity in \fIvalue\fR. -.PP -If this function returns FALSE the reader stops parsing and -reports an error. The reader uses the function errorString() to -get the error message. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmldeclhandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmldeclhandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmldefaulthandler.3qt b/doc/man/man3/qxmldefaulthandler.3qt deleted file mode 100644 index 7d36f33d7..000000000 --- a/doc/man/man3/qxmldefaulthandler.3qt +++ /dev/null @@ -1,64 +0,0 @@ -'\" t -.TH QXmlDefaultHandler 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 -QXmlDefaultHandler \- Default implementation of all the XML handler classes -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherits QXmlContentHandler, QXmlErrorHandler, QXmlDTDHandler, QXmlEntityResolver, QXmlLexicalHandler, and QXmlDeclHandler. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQXmlDefaultHandler\fR ()" -.br -.ti -1c -.BI "virtual \fB~QXmlDefaultHandler\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QXmlDefaultHandler class provides a default implementation of all the XML handler classes. -.PP -Very often we are only interested in parts of the things that the reader reports. This class implements a default behaviour for the handler classes (i.e. most of the time do nothing). Usually this is the class you subclass for implementing your own customized handler. -.PP -See also the Introduction to SAX2. -.PP -See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlDefaultHandler::QXmlDefaultHandler ()" -Constructor. -.SH "QXmlDefaultHandler::~QXmlDefaultHandler ()\fC [virtual]\fR" -Destructor. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmldefaulthandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmldefaulthandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmldtdhandler.3qt b/doc/man/man3/qxmldtdhandler.3qt deleted file mode 100644 index 4b998fa09..000000000 --- a/doc/man/man3/qxmldtdhandler.3qt +++ /dev/null @@ -1,81 +0,0 @@ -'\" t -.TH QXmlDTDHandler 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 -QXmlDTDHandler \- Interface to report DTD content of XML data -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherited by QXmlDefaultHandler. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual bool \fBnotationDecl\fR ( const QString & name, const QString & publicId, const QString & systemId ) = 0" -.br -.ti -1c -.BI "virtual bool \fBunparsedEntityDecl\fR ( const QString & name, const QString & publicId, const QString & systemId, const QString & notationName ) = 0" -.br -.ti -1c -.BI "virtual QString \fBerrorString\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlDTDHandler class provides an interface to report DTD content of XML data. -.PP -If an application needs information about notations and unparsed entities, it can implement this interface and register an instance with QXmlReader::setDTDHandler(). -.PP -Note that this interface includes only those DTD events that the XML recommendation requires processors to report, i.e. notation and unparsed entity declarations using notationDecl() and unparsedEntityDecl() respectively. -.PP -See also the Introduction to SAX2. -.PP -See also QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QString QXmlDTDHandler::errorString ()\fC [pure virtual]\fR" -The reader calls this function to get an error string if any of the handler functions returns FALSE. -.SH "bool QXmlDTDHandler::notationDecl ( const QString & name, const QString & publicId, const QString & systemId )\fC [pure virtual]\fR" -The reader calls this function when it has parsed a notation declaration. -.PP -The argument \fIname\fR is the notation name, \fIpublicId\fR is the notation's public identifier and \fIsystemId\fR is the notation's system identifier. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "bool QXmlDTDHandler::unparsedEntityDecl ( const QString & name, const QString & publicId, const QString & systemId, const QString & notationName )\fC [pure virtual]\fR" -The reader calls this function when it finds an unparsed entity declaration. -.PP -The argument \fIname\fR is the unparsed entity's name, \fIpublicId\fR is the entity's public identifier, \fIsystemId\fR is the entity's system identifier and \fInotationName\fR is the name of the associated notation. -.PP -If this function returns FALSE the reader stops parsing and -reports an error. The reader uses the function errorString() to -get the error message. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmldtdhandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmldtdhandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlentityresolver.3qt b/doc/man/man3/qxmlentityresolver.3qt deleted file mode 100644 index 88cc5c201..000000000 --- a/doc/man/man3/qxmlentityresolver.3qt +++ /dev/null @@ -1,72 +0,0 @@ -'\" t -.TH QXmlEntityResolver 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 -QXmlEntityResolver \- Interface to resolve external entities contained in XML data -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherited by QXmlDefaultHandler. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual bool \fBresolveEntity\fR ( const QString & publicId, const QString & systemId, QXmlInputSource *& ret ) = 0" -.br -.ti -1c -.BI "virtual QString \fBerrorString\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlEntityResolver class provides an interface to resolve external entities contained in XML data. -.PP -If an application needs to implement customized handling for external entities, it must implement this interface, i.e. resolveEntity(), and register it with QXmlReader::setEntityResolver(). -.PP -See also the Introduction to SAX2. -.PP -See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlErrorHandler, QXmlLexicalHandler, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QString QXmlEntityResolver::errorString ()\fC [pure virtual]\fR" -The reader calls this function to get an error string if any of the handler functions returns FALSE. -.SH "bool QXmlEntityResolver::resolveEntity ( const QString & publicId, const QString & systemId, QXmlInputSource *& ret )\fC [pure virtual]\fR" -The reader calls this function before it opens any external entity, except the top-level document entity. The application may request the reader to resolve the entity itself (\fIret\fR is 0) or to use an entirely different input source (\fIret\fR points to the input source). -.PP -The reader deletes the input source \fIret\fR when it no longer needs it, so you should allocate it on the heap with \fCnew\fR. -.PP -The argument \fIpublicId\fR is the public identifier of the external entity, \fIsystemId\fR is the system identifier of the external entity and \fIret\fR is the return value of this function. If \fIret\fR is 0 the reader should resolve the entity itself, if it is non-zero it must point to an input source which the reader uses instead. -.PP -If this function returns FALSE the reader stops parsing and -reports an error. The reader uses the function errorString() to -get the error message. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlentityresolver.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlentityresolver.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlerrorhandler.3qt b/doc/man/man3/qxmlerrorhandler.3qt deleted file mode 100644 index 5f7e41c3d..000000000 --- a/doc/man/man3/qxmlerrorhandler.3qt +++ /dev/null @@ -1,88 +0,0 @@ -'\" t -.TH QXmlErrorHandler 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 -QXmlErrorHandler \- Interface to report errors in XML data -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherited by QXmlDefaultHandler. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual bool \fBwarning\fR ( const QXmlParseException & exception ) = 0" -.br -.ti -1c -.BI "virtual bool \fBerror\fR ( const QXmlParseException & exception ) = 0" -.br -.ti -1c -.BI "virtual bool \fBfatalError\fR ( const QXmlParseException & exception ) = 0" -.br -.ti -1c -.BI "virtual QString \fBerrorString\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlErrorHandler class provides an interface to report errors in XML data. -.PP -If you want your application to report errors to the user or to perform customized error handling, you should subclass this class. -.PP -You can set the error handler with QXmlReader::setErrorHandler(). -.PP -Errors can be reported using warning(), error() and fatalError(), with the error text being reported with errorString(). -.PP -See also the Introduction to SAX2. -.PP -See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlLexicalHandler, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "bool QXmlErrorHandler::error ( const QXmlParseException & exception )\fC [pure virtual]\fR" -A reader might use this function to report a recoverable error. A recoverable error corresponds to the definiton of "error" in section 1.2 of the XML 1.0 specification. Details of the error are stored in \fIexception\fR. -.PP -The reader must continue to provide normal parsing events after invoking this function. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "QString QXmlErrorHandler::errorString ()\fC [pure virtual]\fR" -The reader calls this function to get an error string if any of the handler functions returns FALSE. -.SH "bool QXmlErrorHandler::fatalError ( const QXmlParseException & exception )\fC [pure virtual]\fR" -A reader must use this function to report a non-recoverable error. Details of the error are stored in \fIexception\fR. -.PP -If this function returns TRUE the reader might try to go on parsing and reporting further errors; but no regular parsing events are reported. -.SH "bool QXmlErrorHandler::warning ( const QXmlParseException & exception )\fC [pure virtual]\fR" -A reader might use this function to report a warning. Warnings are conditions that are not errors or fatal errors as defined by the XML 1.0 specification. Details of the warning are stored in \fIexception\fR. -.PP -If this function returns FALSE the reader stops parsing and -reports an error. The reader uses the function errorString() to -get the error message. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlerrorhandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlerrorhandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlinputsource.3qt b/doc/man/man3/qxmlinputsource.3qt deleted file mode 100644 index d3e79472d..000000000 --- a/doc/man/man3/qxmlinputsource.3qt +++ /dev/null @@ -1,156 +0,0 @@ -'\" t -.TH QXmlInputSource 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 -QXmlInputSource \- The input data for the QXmlReader subclasses -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQXmlInputSource\fR ()" -.br -.ti -1c -.BI "\fBQXmlInputSource\fR ( QIODevice * dev )" -.br -.ti -1c -.BI "QXmlInputSource ( QFile & file ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "QXmlInputSource ( QTextStream & stream ) \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual \fB~QXmlInputSource\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetData\fR ( const QString & dat )" -.br -.ti -1c -.BI "virtual void \fBsetData\fR ( const QByteArray & dat )" -.br -.ti -1c -.BI "virtual void \fBfetchData\fR ()" -.br -.ti -1c -.BI "virtual QString \fBdata\fR ()" -.br -.ti -1c -.BI "virtual QChar \fBnext\fR ()" -.br -.ti -1c -.BI "virtual void \fBreset\fR ()" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual QString \fBfromRawData\fR ( const QByteArray & data, bool beginning = FALSE )" -.br -.in -1c -.SH DESCRIPTION -The QXmlInputSource class provides the input data for the QXmlReader subclasses. -.PP -All subclasses of QXmlReader read the input XML document from this class. -.PP -This class recognizes the encoding of the data by reading the encoding declaration in the XML file if it finds one, and reading the data using the corresponding encoding. If it does not find an encoding declaration, then it assumes that the data is either in UTF-8 or UTF-16, depending on whether it can find a byte-order mark. -.PP -There are two ways to populate the input source with data: you can construct it with a QIODevice* so that the input source reads the data from that device. Or you can set the data explicitly with one of the setData() functions. -.PP -Usually you either construct a QXmlInputSource that works on a QIODevice* or you construct an empty QXmlInputSource and set the data with setData(). There are only rare occasions where you would want to mix both methods. -.PP -The QXmlReader subclasses use the next() function to read the input character by character. If you want to start from the beginning again, use reset(). -.PP -The functions data() and fetchData() are useful if you want to do something with the data other than parsing, e.g. displaying the raw XML file. The benefit of using the QXmlInputClass in such cases is that it tries to use the correct encoding. -.PP -See also QXmlReader, QXmlSimpleReader, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlInputSource::QXmlInputSource ()" -Constructs an input source which contains no data. -.PP -See also setData(). -.SH "QXmlInputSource::QXmlInputSource ( QIODevice * dev )" -Constructs an input source and gets the data from device \fIdev\fR. If \fIdev\fR is not open, it is opened in read-only mode. If \fIdev\fR is 0 or it is not possible to read from the device, the input source will contain no data. -.PP -See also setData(), fetchData(), and QIODevice. -.SH "QXmlInputSource::QXmlInputSource ( QFile & file )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Constructs an input source and gets the data from the file \fIfile\fR. If the file cannot be read the input source is empty. -.SH "QXmlInputSource::QXmlInputSource ( QTextStream & stream )" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.PP -Constructs an input source and gets the data from the text stream \fIstream\fR. -.SH "QXmlInputSource::~QXmlInputSource ()\fC [virtual]\fR" -Destructor. -.SH "QString QXmlInputSource::data ()\fC [virtual]\fR" -Returns the data the input source contains or QString::null if the input source does not contain any data. -.PP -See also setData(), QXmlInputSource(), and fetchData(). -.SH "void QXmlInputSource::fetchData ()\fC [virtual]\fR" -This function reads more data from the device that was set during construction. If the input source already contained data, this function deletes that data first. -.PP -This object contains no data after a call to this function if the object was constructed without a device to read data from or if this function was not able to get more data from the device. -.PP -There are two occasions where a fetch is done implicitly by another function call: during construction (so that the object starts out with some initial data where available), and during a call to next() (if the data had run out). -.PP -You don't normally need to use this function if you use next(). -.PP -See also data(), next(), and QXmlInputSource(). -.SH "QString QXmlInputSource::fromRawData ( const QByteArray & data, bool beginning = FALSE )\fC [virtual protected]\fR" -This function reads the XML file from \fIdata\fR and tries to recognize the encoding. It converts the raw data \fIdata\fR into a QString and returns it. It tries its best to get the correct encoding for the XML file. -.PP -If \fIbeginning\fR is TRUE, this function assumes that the data starts at the beginning of a new XML document and looks for an encoding declaration. If \fIbeginning\fR is FALSE, it converts the raw data using the encoding determined from prior calls. -.SH "QChar QXmlInputSource::next ()\fC [virtual]\fR" -Returns the next character of the input source. If this function reaches the end of available data, it returns QXmlInputSource::EndOfData. If you call next() after that, it tries to fetch more data by calling fetchData(). If the fetchData() call results in new data, this function returns the first character of that data; otherwise it returns QXmlInputSource::EndOfDocument. -.PP -See also reset(), fetchData(), QXmlSimpleReader::parse(), and QXmlSimpleReader::parseContinue(). -.SH "void QXmlInputSource::reset ()\fC [virtual]\fR" -This function sets the position used by next() to the beginning of the data returned by data(). This is useful if you want to use the input source for more than one parse. -.PP -See also next(). -.PP -Example: xml/tagreader-with-features/tagreader.cpp. -.SH "void QXmlInputSource::setData ( const QString & dat )\fC [virtual]\fR" -Sets the data of the input source to \fIdat\fR. -.PP -If the input source already contains data, this function deletes that data first. -.PP -See also data(). -.SH "void QXmlInputSource::setData ( const QByteArray & dat )\fC [virtual]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -The data \fIdat\fR is passed through the correct text-codec, before -it is set. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlinputsource.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlinputsource.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmllexicalhandler.3qt b/doc/man/man3/qxmllexicalhandler.3qt deleted file mode 100644 index eef4f91f9..000000000 --- a/doc/man/man3/qxmllexicalhandler.3qt +++ /dev/null @@ -1,134 +0,0 @@ -'\" t -.TH QXmlLexicalHandler 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 -QXmlLexicalHandler \- Interface to report the lexical content of XML data -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherited by QXmlDefaultHandler. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual bool \fBstartDTD\fR ( const QString & name, const QString & publicId, const QString & systemId ) = 0" -.br -.ti -1c -.BI "virtual bool \fBendDTD\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBstartEntity\fR ( const QString & name ) = 0" -.br -.ti -1c -.BI "virtual bool \fBendEntity\fR ( const QString & name ) = 0" -.br -.ti -1c -.BI "virtual bool \fBstartCDATA\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBendCDATA\fR () = 0" -.br -.ti -1c -.BI "virtual bool \fBcomment\fR ( const QString & ch ) = 0" -.br -.ti -1c -.BI "virtual QString \fBerrorString\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlLexicalHandler class provides an interface to report the lexical content of XML data. -.PP -The events in the lexical handler apply to the entire document, not just to the document element, and all lexical handler events appear between the content handler's startDocument and endDocument events. -.PP -You can set the lexical handler with QXmlReader::setLexicalHandler(). -.PP -This interface's design is based on the the SAX2 extension LexicalHandler. -.PP -The interface provides the startDTD(), endDTD(), startEntity(), endEntity(), startCDATA(), endCDATA() and comment() functions. -.PP -See also the Introduction to SAX2. -.PP -See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "bool QXmlLexicalHandler::comment ( const QString & ch )\fC [pure virtual]\fR" -The reader calls this function to report an XML comment anywhere in the document. It reports the text of the comment in \fIch\fR. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.SH "bool QXmlLexicalHandler::endCDATA ()\fC [pure virtual]\fR" -The reader calls this function to report the end of a CDATA section. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also startCDATA() and QXmlContentHandler::characters(). -.SH "bool QXmlLexicalHandler::endDTD ()\fC [pure virtual]\fR" -The reader calls this function to report the end of a DTD declaration, if any. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also startDTD(). -.SH "bool QXmlLexicalHandler::endEntity ( const QString & name )\fC [pure virtual]\fR" -The reader calls this function to report the end of an entity called \fIname\fR. -.PP -For every startEntity() call, there is a corresponding endEntity() call. The calls to startEntity() and endEntity() are properly nested. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also startEntity(), QXmlContentHandler::skippedEntity(), and QXmlSimpleReader::setFeature(). -.SH "QString QXmlLexicalHandler::errorString ()\fC [pure virtual]\fR" -The reader calls this function to get an error string if any of the handler functions returns FALSE. -.SH "bool QXmlLexicalHandler::startCDATA ()\fC [pure virtual]\fR" -The reader calls this function to report the start of a CDATA section. The content of the CDATA section is reported through the QXmlContentHandler::characters() function. This function is intended only to report the boundary. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also endCDATA(). -.SH "bool QXmlLexicalHandler::startDTD ( const QString & name, const QString & publicId, const QString & systemId )\fC [pure virtual]\fR" -The reader calls this function to report the start of a DTD declaration, if any. It reports the name of the document type in \fIname\fR, the public identifier in \fIpublicId\fR and the system identifier in \fIsystemId\fR. -.PP -If the public identifier is missing, \fIpublicId\fR is set to QString::null. If the system identifier is missing, \fIsystemId\fR is set to QString::null. Note that it is not valid XML to have a public identifier but no system identifier; in such cases a parse error will occur. -.PP -All declarations reported through QXmlDTDHandler or QXmlDeclHandler appear between the startDTD() and endDTD() calls. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also endDTD(). -.SH "bool QXmlLexicalHandler::startEntity ( const QString & name )\fC [pure virtual]\fR" -The reader calls this function to report the start of an entity called \fIname\fR. -.PP -Note that if the entity is unknown, the reader reports it through QXmlContentHandler::skippedEntity() and not through this function. -.PP -If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. -.PP -See also endEntity() and QXmlSimpleReader::setFeature(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmllexicalhandler.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmllexicalhandler.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmllocator.3qt b/doc/man/man3/qxmllocator.3qt deleted file mode 100644 index 0277a07ac..000000000 --- a/doc/man/man3/qxmllocator.3qt +++ /dev/null @@ -1,71 +0,0 @@ -'\" t -.TH QXmlLocator 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 -QXmlLocator \- The XML handler classes with information about the parsing position within a file -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQXmlLocator\fR ()" -.br -.ti -1c -.BI "virtual \fB~QXmlLocator\fR ()" -.br -.ti -1c -.BI "virtual int \fBcolumnNumber\fR () = 0" -.br -.ti -1c -.BI "virtual int \fBlineNumber\fR () = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlLocator class provides the XML handler classes with information about the parsing position within a file. -.PP -The reader reports a QXmlLocator to the content handler before it starts to parse the document. This is done with the QXmlContentHandler::setDocumentLocator() function. The handler classes can now use this locator to get the position (lineNumber() and columnNumber()) that the reader has reached. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlLocator::QXmlLocator ()" -Constructor. -.SH "QXmlLocator::~QXmlLocator ()\fC [virtual]\fR" -Destructor. -.SH "int QXmlLocator::columnNumber ()\fC [pure virtual]\fR" -Returns the column number (starting at 1) or -1 if there is no column number available. -.SH "int QXmlLocator::lineNumber ()\fC [pure virtual]\fR" -Returns the line number (starting at 1) or -1 if there is no line -number available. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmllocator.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmllocator.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlnamespacesupport.3qt b/doc/man/man3/qxmlnamespacesupport.3qt deleted file mode 100644 index f0f01bdfe..000000000 --- a/doc/man/man3/qxmlnamespacesupport.3qt +++ /dev/null @@ -1,180 +0,0 @@ -'\" t -.TH QXmlNamespaceSupport 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 -QXmlNamespaceSupport \- Helper class for XML readers which want to include namespace support -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQXmlNamespaceSupport\fR ()" -.br -.ti -1c -.BI "\fB~QXmlNamespaceSupport\fR ()" -.br -.ti -1c -.BI "void \fBsetPrefix\fR ( const QString & pre, const QString & uri )" -.br -.ti -1c -.BI "QString \fBprefix\fR ( const QString & uri ) const" -.br -.ti -1c -.BI "QString \fBuri\fR ( const QString & prefix ) const" -.br -.ti -1c -.BI "void \fBsplitName\fR ( const QString & qname, QString & prefix, QString & localname ) const" -.br -.ti -1c -.BI "void \fBprocessName\fR ( const QString & qname, bool isAttribute, QString & nsuri, QString & localname ) const" -.br -.ti -1c -.BI "QStringList \fBprefixes\fR () const" -.br -.ti -1c -.BI "QStringList \fBprefixes\fR ( const QString & uri ) const" -.br -.ti -1c -.BI "void \fBpushContext\fR ()" -.br -.ti -1c -.BI "void \fBpopContext\fR ()" -.br -.ti -1c -.BI "void \fBreset\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QXmlNamespaceSupport class is a helper class for XML readers which want to include namespace support. -.PP -You can set the prefix for the current namespace with setPrefix(), and get the list of current prefixes (or those for a given URI) with prefixes(). The namespace URI is available from uri(). Use pushContext() to start a new namespace context, and popContext() to return to the previous namespace context. Use splitName() or processName() to split a name into its prefix and local name. -.PP -See also the namespace description. -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlNamespaceSupport::QXmlNamespaceSupport ()" -Constructs a QXmlNamespaceSupport. -.SH "QXmlNamespaceSupport::~QXmlNamespaceSupport ()" -Destroys a QXmlNamespaceSupport. -.SH "void QXmlNamespaceSupport::popContext ()" -Reverts to the previous namespace context. -.PP -Normally, you should pop the context at the end of each XML element. After popping the context, all namespace prefix mappings that were previously in force are restored. -.PP -See also pushContext(). -.SH "QString QXmlNamespaceSupport::prefix ( const QString & uri ) const" -Returns one of the prefixes mapped to the namespace URI \fIuri\fR. -.PP -If more than one prefix is currently mapped to the same URI, this function makes an arbitrary selection; if you want all of the prefixes, use prefixes() instead. -.PP -Note: to check for a default prefix, use the uri() function with an argument of "". -.SH "QStringList QXmlNamespaceSupport::prefixes () const" -Returns a list of all the prefixes currently declared. -.PP -If there is a default prefix, this function does not return it in the list; check for the default prefix using uri() with an argument of "". -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myXmlNamespaceSupport.prefixes(); -.br - QStringList::iterator it = list.begin(); -.br - while ( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "QStringList QXmlNamespaceSupport::prefixes ( const QString & uri ) const" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Returns a list of all prefixes currently declared for the namespace URI \fIuri\fR. -.PP -The "xml:" prefix is included. If you only want one prefix that is mapped to the namespace URI, and you don't care which one you get, use the prefix() function instead. -.PP -Note: the empty (default) prefix is never included in this list; to check for the presence of a default namespace, use uri() with an argument of "". -.PP -Note that if you want to iterate over the list, you should iterate over a copy, e.g. -.PP -.nf -.br - QStringList list = myXmlNamespaceSupport.prefixes( "" ); -.br - QStringList::Iterator it = list.begin(); -.br - while( it != list.end() ) { -.br - myProcessing( *it ); -.br - ++it; -.br - } -.br -.fi -.SH "void QXmlNamespaceSupport::processName ( const QString & qname, bool isAttribute, QString & nsuri, QString & localname ) const" -Processes a raw XML 1.0 name in the current context by removing the prefix and looking it up among the prefixes currently declared. -.PP -\fIqname\fR is the raw XML 1.0 name to be processed. \fIisAttribute\fR is TRUE if the name is an attribute name. -.PP -This function stores the namespace URI in \fInsuri\fR (which will be set to QString::null if the raw name has an undeclared prefix), and stores the local name (without prefix) in \fIlocalname\fR (which will be set to QString::null if no namespace is in use). -.PP -Note that attribute names are processed differently than element names: an unprefixed element name gets the default namespace (if any), while an unprefixed element name does not. -.SH "void QXmlNamespaceSupport::pushContext ()" -Starts a new namespace context. -.PP -Normally, you should push a new context at the beginning of each XML element: the new context automatically inherits the declarations of its parent context, and it also keeps track of which declarations were made within this context. -.PP -See also popContext(). -.SH "void QXmlNamespaceSupport::reset ()" -Resets this namespace support object ready for reuse. -.SH "void QXmlNamespaceSupport::setPrefix ( const QString & pre, const QString & uri )" -This function declares a prefix \fIpre\fR in the current namespace context to be the namespace URI \fIuri\fR. The prefix remains in force until this context is popped, unless it is shadowed in a descendant context. -.PP -Note that there is an asymmetry in this library. prefix() does not return the default "" prefix, even if you have declared one; to check for a default prefix, you must look it up explicitly using uri(). This asymmetry exists to make it easier to look up prefixes for attribute names, where the default prefix is not allowed. -.SH "void QXmlNamespaceSupport::splitName ( const QString & qname, QString & prefix, QString & localname ) const" -Splits the name \fIqname\fR at the ':' and returns the prefix in \fIprefix\fR and the local name in \fIlocalname\fR. -.PP -See also processName(). -.SH "QString QXmlNamespaceSupport::uri ( const QString & prefix ) const" -Looks up the prefix \fIprefix\fR in the current context and returns -the currently-mapped namespace URI. Use the empty string ("") for -the default namespace. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlnamespacesupport.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlnamespacesupport.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlparseexception.3qt b/doc/man/man3/qxmlparseexception.3qt deleted file mode 100644 index b850367b7..000000000 --- a/doc/man/man3/qxmlparseexception.3qt +++ /dev/null @@ -1,80 +0,0 @@ -'\" t -.TH QXmlParseException 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 -QXmlParseException \- Used to report errors with the QXmlErrorHandler interface -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQXmlParseException\fR ( const QString & name = """", int c = -1, int l = -1, const QString & p = """", const QString & s = """" )" -.br -.ti -1c -.BI "int \fBcolumnNumber\fR () const" -.br -.ti -1c -.BI "int \fBlineNumber\fR () const" -.br -.ti -1c -.BI "QString \fBpublicId\fR () const" -.br -.ti -1c -.BI "QString \fBsystemId\fR () const" -.br -.ti -1c -.BI "QString \fBmessage\fR () const" -.br -.in -1c -.SH DESCRIPTION -The QXmlParseException class is used to report errors with the QXmlErrorHandler interface. -.PP -The XML subsystem constructs an instance of this class when it detects an error. You can retrieve the place where the error occurred using systemId(), publicId(), lineNumber() and columnNumber(), along with the error message(). -.PP -See also QXmlErrorHandler, QXmlReader, and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlParseException::QXmlParseException ( const QString & name = "", int c = -1, int l = -1, const QString & p = "", const QString & s = "" )" -Constructs a parse exception with the error string \fIname\fR for column \fIc\fR and line \fIl\fR for the public identifier \fIp\fR and the system identifier \fIs\fR. -.SH "int QXmlParseException::columnNumber () const" -Returns the column number where the error occurred. -.SH "int QXmlParseException::lineNumber () const" -Returns the line number where the error occurred. -.SH "QString QXmlParseException::message () const" -Returns the error message. -.SH "QString QXmlParseException::publicId () const" -Returns the public identifier where the error occurred. -.SH "QString QXmlParseException::systemId () const" -Returns the system identifier where the error occurred. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlparseexception.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlparseexception.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlreader.3qt b/doc/man/man3/qxmlreader.3qt deleted file mode 100644 index 583f7c72d..000000000 --- a/doc/man/man3/qxmlreader.3qt +++ /dev/null @@ -1,206 +0,0 @@ -'\" t -.TH QXmlReader 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 -QXmlReader \- Interface for XML readers (i.e. parsers) -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherited by QXmlSimpleReader. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual bool \fBfeature\fR ( const QString & name, bool * ok = 0 ) const = 0" -.br -.ti -1c -.BI "virtual void \fBsetFeature\fR ( const QString & name, bool value ) = 0" -.br -.ti -1c -.BI "virtual bool \fBhasFeature\fR ( const QString & name ) const = 0" -.br -.ti -1c -.BI "virtual void * \fBproperty\fR ( const QString & name, bool * ok = 0 ) const = 0" -.br -.ti -1c -.BI "virtual void \fBsetProperty\fR ( const QString & name, void * value ) = 0" -.br -.ti -1c -.BI "virtual bool \fBhasProperty\fR ( const QString & name ) const = 0" -.br -.ti -1c -.BI "virtual void \fBsetEntityResolver\fR ( QXmlEntityResolver * handler ) = 0" -.br -.ti -1c -.BI "virtual QXmlEntityResolver * \fBentityResolver\fR () const = 0" -.br -.ti -1c -.BI "virtual void \fBsetDTDHandler\fR ( QXmlDTDHandler * handler ) = 0" -.br -.ti -1c -.BI "virtual QXmlDTDHandler * \fBDTDHandler\fR () const = 0" -.br -.ti -1c -.BI "virtual void \fBsetContentHandler\fR ( QXmlContentHandler * handler ) = 0" -.br -.ti -1c -.BI "virtual QXmlContentHandler * \fBcontentHandler\fR () const = 0" -.br -.ti -1c -.BI "virtual void \fBsetErrorHandler\fR ( QXmlErrorHandler * handler ) = 0" -.br -.ti -1c -.BI "virtual QXmlErrorHandler * \fBerrorHandler\fR () const = 0" -.br -.ti -1c -.BI "virtual void \fBsetLexicalHandler\fR ( QXmlLexicalHandler * handler ) = 0" -.br -.ti -1c -.BI "virtual QXmlLexicalHandler * \fBlexicalHandler\fR () const = 0" -.br -.ti -1c -.BI "virtual void \fBsetDeclHandler\fR ( QXmlDeclHandler * handler ) = 0" -.br -.ti -1c -.BI "virtual QXmlDeclHandler * \fBdeclHandler\fR () const = 0" -.br -.ti -1c -.BI "virtual bool parse ( const QXmlInputSource & input ) = 0 \fI(obsolete)\fR" -.br -.ti -1c -.BI "virtual bool \fBparse\fR ( const QXmlInputSource * input ) = 0" -.br -.in -1c -.SH DESCRIPTION -The QXmlReader class provides an interface for XML readers (i.e. parsers). -.PP -This abstract class provides an interface for all of Qt's XML readers. Currently there is only one implementation of a reader included in Qt's XML module: QXmlSimpleReader. In future releases there might be more readers with different properties available (e.g. a validating parser). -.PP -The design of the XML classes follows the SAX2 Java interface, with the names adapted to fit Qt naming conventions. It should be very easy for anybody who has worked with SAX2 to get started with the Qt XML classes. -.PP -All readers use the class QXmlInputSource to read the input document. Since you are normally interested in particular content in the XML document, the reader reports the content through special handler classes (QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler and QXmlLexicalHandler), which you must subclass, if you want to process the contents. -.PP -Since the handler classes only describe interfaces you must implement all the functions. We provide the QXmlDefaultHandler class to make this easier: it implements a default behaviour (do nothing) for all functions, so you can subclass it and just implement the functions you are interested in. -.PP -Features and properties of the reader can be set with setFeature() and setProperty() respectively. You can set the reader to use your own subclasses with setEntityResolver(), setDTDHandler(), setContentHandler(), setErrorHandler(), setLexicalHandler() and setDeclHandler(). The parse itself is started with a call to parse(). -.PP -See also QXmlSimpleReader and XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlDTDHandler * QXmlReader::DTDHandler () const\fC [pure virtual]\fR" -Returns the DTD handler or 0 if none was set. -.PP -See also setDTDHandler(). -.SH "QXmlContentHandler * QXmlReader::contentHandler () const\fC [pure virtual]\fR" -Returns the content handler or 0 if none was set. -.PP -See also setContentHandler(). -.SH "QXmlDeclHandler * QXmlReader::declHandler () const\fC [pure virtual]\fR" -Returns the declaration handler or 0 if none was set. -.PP -See also setDeclHandler(). -.SH "QXmlEntityResolver * QXmlReader::entityResolver () const\fC [pure virtual]\fR" -Returns the entity resolver or 0 if none was set. -.PP -See also setEntityResolver(). -.SH "QXmlErrorHandler * QXmlReader::errorHandler () const\fC [pure virtual]\fR" -Returns the error handler or 0 if none is set. -.PP -See also setErrorHandler(). -.SH "bool QXmlReader::feature ( const QString & name, bool * ok = 0 ) const\fC [pure virtual]\fR" -If the reader has the feature called \fIname\fR, the feature's value is returned. If no such feature exists the return value is undefined. -.PP -If \fIok\fR is not 0: \fI*ok\fR is set to TRUE if the reader has the feature called \fIname\fR; otherwise \fI*ok\fR is set to FALSE. -.PP -See also setFeature() and hasFeature(). -.SH "bool QXmlReader::hasFeature ( const QString & name ) const\fC [pure virtual]\fR" -Returns \fCTRUE\fR if the reader has the feature called \fIname\fR; otherwise returns FALSE. -.PP -See also feature() and setFeature(). -.SH "bool QXmlReader::hasProperty ( const QString & name ) const\fC [pure virtual]\fR" -Returns TRUE if the reader has the property \fIname\fR; otherwise returns FALSE. -.PP -See also property() and setProperty(). -.SH "QXmlLexicalHandler * QXmlReader::lexicalHandler () const\fC [pure virtual]\fR" -Returns the lexical handler or 0 if none was set. -.PP -See also setLexicalHandler(). -.SH "bool QXmlReader::parse ( const QXmlInputSource * input )\fC [pure virtual]\fR" -Reads an XML document from \fIinput\fR and parses it. Returns TRUE if the parsing was successful; otherwise returns FALSE. -.PP -Example: xml/tagreader/tagreader.cpp. -.SH "bool QXmlReader::parse ( const QXmlInputSource & input )\fC [pure virtual]\fR" -\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. -.SH "void * QXmlReader::property ( const QString & name, bool * ok = 0 ) const\fC [pure virtual]\fR" -If the reader has the property \fIname\fR, this function returns the value of the property; otherwise the return value is undefined. -.PP -If \fIok\fR is not 0: if the reader has the \fIname\fR property \fI*ok\fR is set to TRUE; otherwise \fI*ok\fR is set to FALSE. -.PP -See also setProperty() and hasProperty(). -.SH "void QXmlReader::setContentHandler ( QXmlContentHandler * handler )\fC [pure virtual]\fR" -Sets the content handler to \fIhandler\fR. -.PP -See also contentHandler(). -.PP -Example: xml/tagreader/tagreader.cpp. -.SH "void QXmlReader::setDTDHandler ( QXmlDTDHandler * handler )\fC [pure virtual]\fR" -Sets the DTD handler to \fIhandler\fR. -.PP -See also DTDHandler(). -.SH "void QXmlReader::setDeclHandler ( QXmlDeclHandler * handler )\fC [pure virtual]\fR" -Sets the declaration handler to \fIhandler\fR. -.PP -See also declHandler(). -.SH "void QXmlReader::setEntityResolver ( QXmlEntityResolver * handler )\fC [pure virtual]\fR" -Sets the entity resolver to \fIhandler\fR. -.PP -See also entityResolver(). -.SH "void QXmlReader::setErrorHandler ( QXmlErrorHandler * handler )\fC [pure virtual]\fR" -Sets the error handler to \fIhandler\fR. Clears the error handler if \fIhandler\fR is 0. -.PP -See also errorHandler(). -.SH "void QXmlReader::setFeature ( const QString & name, bool value )\fC [pure virtual]\fR" -Sets the feature called \fIname\fR to the given \fIvalue\fR. If the reader doesn't have the feature nothing happens. -.PP -See also feature() and hasFeature(). -.PP -Reimplemented in QXmlSimpleReader. -.SH "void QXmlReader::setLexicalHandler ( QXmlLexicalHandler * handler )\fC [pure virtual]\fR" -Sets the lexical handler to \fIhandler\fR. -.PP -See also lexicalHandler(). -.SH "void QXmlReader::setProperty ( const QString & name, void * value )\fC [pure virtual]\fR" -Sets the property \fIname\fR to \fIvalue\fR. If the reader doesn't have the property nothing happens. -.PP -See also property() and hasProperty(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlreader.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlreader.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/qxmlsimplereader.3qt b/doc/man/man3/qxmlsimplereader.3qt deleted file mode 100644 index 894225a7a..000000000 --- a/doc/man/man3/qxmlsimplereader.3qt +++ /dev/null @@ -1,142 +0,0 @@ -'\" t -.TH QXmlSimpleReader 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 -QXmlSimpleReader \- Implementation of a simple XML reader (parser) -.SH SYNOPSIS -All the functions in this class are reentrant when Qt is built with thread support.</p> -.PP -\fC#include <ntqxml.h>\fR -.PP -Inherits QXmlReader. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQXmlSimpleReader\fR ()" -.br -.ti -1c -.BI "virtual \fB~QXmlSimpleReader\fR ()" -.br -.ti -1c -.BI "virtual void \fBsetFeature\fR ( const QString & name, bool value )" -.br -.ti -1c -.BI "virtual bool \fBparse\fR ( const QXmlInputSource * input, bool incremental )" -.br -.ti -1c -.BI "virtual bool \fBparseContinue\fR ()" -.br -.in -1c -.SH DESCRIPTION -The QXmlSimpleReader class provides an implementation of a simple XML reader (parser). -.PP -This XML reader is sufficient for simple parsing tasks. The reader: -.TP -provides a well-formed parser; -.TP -does not parse any external entities; -.TP -can do namespace processing. -.PP -Documents are parsed with a call to parse(). -.PP -See also XML. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QXmlSimpleReader::QXmlSimpleReader ()" -Constructs a simple XML reader with the following feature settings: <center>.nf -.TS -l - l. Feature Setting \fIhttp://xml.org/sax/features/namespaces\fR TRUE \fIhttp://xml.org/sax/features/namespace-prefixes\fR FALSE \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR TRUE \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR -.TE -.fi -</center> -.PP -More information about features can be found in the Qt SAX2 overview. -.PP -See also setFeature(). -.SH "QXmlSimpleReader::~QXmlSimpleReader ()\fC [virtual]\fR" -Destroys the simple XML reader. -.SH "bool QXmlSimpleReader::parse ( const QXmlInputSource * input, bool incremental )\fC [virtual]\fR" -Reads an XML document from \fIinput\fR and parses it. Returns FALSE if the parsing detects an error; otherwise returns TRUE. -.PP -If \fIincremental\fR is TRUE, the parser does not return FALSE when it reaches the end of the \fIinput\fR without reaching the end of the XML file. Instead it stores the state of the parser so that parsing can be continued at a later stage when more data is available. You can use the function parseContinue() to continue with parsing. This class stores a pointer to the input source \fIinput\fR and the parseContinue() function tries to read from that input souce. This means that you should not delete the input source \fIinput\fR until you've finished your calls to parseContinue(). If you call this function with \fIincremental\fR TRUE whilst an incremental parse is in progress a new parsing session will be started and the previous session lost. -.PP -If \fIincremental\fR is FALSE, this function behaves like the normal parse function, i.e. it returns FALSE when the end of input is reached without reaching the end of the XML file and the parsing cannot be continued. -.PP -See also parseContinue() and QSocket. -.PP -Examples: -.)l xml/tagreader-with-features/tagreader.cpp and xml/tagreader/tagreader.cpp. -.SH "bool QXmlSimpleReader::parseContinue ()\fC [virtual]\fR" -Continues incremental parsing; this function reads the input from the QXmlInputSource that was specified with the last parse() command. To use this function, you \fImust\fR have called parse() with the incremental argument set to TRUE. -.PP -Returns FALSE if a parsing error occurs; otherwise returns TRUE. -.PP -If the input source returns an empty string for the function QXmlInputSource::data(), then this means that the end of the XML file has been reached; this is quite important, especially if you want to use the reader to parse more than one XML file. -.PP -The case of the end of the XML file being reached without having finished parsing is not considered to be an error: you can continue parsing at a later stage by calling this function again when there is more data available to parse. -.PP -This function assumes that the end of the XML document is reached if the QXmlInputSource::next() function returns QXmlInputSource::EndOfDocument. If the parser has not finished parsing when it encounters this symbol, it is an error and FALSE is returned. -.PP -See also parse() and QXmlInputSource::next(). -.SH "void QXmlSimpleReader::setFeature ( const QString & name, bool value )\fC [virtual]\fR" -Sets the state of the feature \fIname\fR to \fIvalue\fR: -.PP -If the feature is not recognized, it is ignored. -.PP -The following features are supported: <center>.nf -.TS -l - l. Feature Notes \fIhttp://xml.org/sax/features/namespaces\fR If this feature is TRUE, namespace processing is performed. \fIhttp://xml.org/sax/features/namespace-prefixes\fR If this feature is TRUE, the the original prefixed names and attributes used for namespace declarations are reported. \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR If this feature is TRUE, CharData that only contain whitespace are not ignored, but are reported via QXmlContentHandler::characters(). \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR -.TE -.fi -</center> -.PP -.nf -.br - ** $Id: qt/tagreader.cpp 3.3.8 edited Jan 11 14:46 $ -.fi -.PP -.nf -.br - reader.setFeature( "http://xml.org/sax/features/namespace-prefixes", -.br - TRUE ); -.fi -.PP -(Code taken from xml/tagreader-with-features/tagreader.cpp) -.PP -See also feature() and hasFeature(). -.PP -Example: xml/tagreader-with-features/tagreader.cpp. -.PP -Reimplemented from QXmlReader. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qxmlsimplereader.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 qt-bugs@trolltech.com . -Please include the name of the manual page (qxmlsimplereader.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaccel.3qt b/doc/man/man3/tqaccel.3qt new file mode 100644 index 000000000..d5dd5420d --- /dev/null +++ b/doc/man/man3/tqaccel.3qt @@ -0,0 +1,324 @@ +'\" t +.TH QAccel 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 +QAccel \- Handles keyboard accelerator and shortcut keys +.SH SYNOPSIS +\fC#include <ntqaccel.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAccel\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQAccel\fR ( QWidget * watch, QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QAccel\fR ()" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "void \fBsetEnabled\fR ( bool enable )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QKeySequence & key, int id = -1 )" +.br +.ti -1c +.BI "void \fBremoveItem\fR ( int id )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "QKeySequence \fBkey\fR ( int id )" +.br +.ti -1c +.BI "int \fBfindKey\fR ( const QKeySequence & key ) const" +.br +.ti -1c +.BI "bool \fBisItemEnabled\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" +.br +.ti -1c +.BI "bool \fBconnectItem\fR ( int id, const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "bool \fBdisconnectItem\fR ( int id, const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "void repairEventFilter () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetWhatsThis\fR ( int id, const QString & text )" +.br +.ti -1c +.BI "QString \fBwhatsThis\fR ( int id ) const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBactivated\fR ( int id )" +.br +.ti -1c +.BI "void \fBactivatedAmbiguously\fR ( int id )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QKeySequence \fBshortcutKey\fR ( const QString & str )" +.br +.ti -1c +.BI "QString keyToString ( QKeySequence k ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QKeySequence stringToKey ( const QString & s ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool eventFilter ( QObject *, QEvent * ) \fI(obsolete)\fR" +.br +.in -1c +.SH DESCRIPTION +The QAccel class handles keyboard accelerator and shortcut keys. +.PP +A keyboard accelerator triggers an action when a certain key combination is pressed. The accelerator handles all keyboard activity for all the children of one top-level widget, so it is not affected by the keyboard focus. +.PP +In most cases, you will not need to use this class directly. Use the QAction class to create actions with accelerators that can be used in both menus and toolbars. If you're only interested in menus use QMenuData::insertItem() or QMenuData::setAccel() to make accelerators for operations that are also available on menus. Many widgets automatically generate accelerators, such as QButton, QGroupBox, QLabel (with QLabel::setBuddy()), QMenuBar and QTabBar. Example: +.PP +.nf +.br + QPushButton p( "&Exit", parent ); // automatic shortcut ALT+Key_E +.br + QPopupMenu *fileMenu = new fileMenu( parent ); +.br + fileMenu->insertItem( "Undo", parent, SLOT(undo()), CTRL+Key_Z ); +.br +.fi +.PP +A QAccel contains a list of accelerator items that can be manipulated using insertItem(), removeItem(), clear(), key() and findKey(). +.PP +Each accelerator item consists of an identifier and a QKeySequence. A single key sequence consists of a keyboard code combined with modifiers (SHIFT, CTRL, ALT or UNICODE_ACCEL). For example, \fCCTRL + Key_P\fR could be a shortcut for printing a document. The key codes are listed in ntqnamespace.h. As an alternative, use UNICODE_ACCEL with the unicode code point of the character. For example, \fCUNICODE_ACCEL + 'A'\fR gives the same accelerator as Key_A. +.PP +When an accelerator key is pressed, the accelerator sends out the signal activated() with a number that identifies this particular accelerator item. Accelerator items can also be individually connected, so that two different keys will activate two different slots (see connectItem() and disconnectItem()). +.PP +The activated() signal is \fInot\fR emitted when two or more accelerators match the same key. Instead, the first matching accelerator sends out the activatedAmbiguously() signal. By pressing the key multiple times, users can navigate between all matching accelerators. Some standard controls like QPushButton and QCheckBox connect the activatedAmbiguously() signal to the harmless setFocus() slot, whereas activated() is connected to a slot invoking the button's action. Most controls, like QLabel and QTabBar, treat activated() and activatedAmbiguously() as equivalent. +.PP +Use setEnabled() to enable or disable all the items in an accelerator, or setItemEnabled() to enable or disable individual items. An item is active only when both the QAccel and the item itself are enabled. +.PP +The function setWhatsThis() specifies a help text that appears when the user presses an accelerator key in What's This mode. +.PP +The accelerator will be deleted when \fIparent\fR is deleted, and will consume relevant key events until then. +.PP +Please note that the accelerator +.PP +.nf +.br + accelerator->insertItem( QKeySequence("M") ); +.br +.fi +can be triggered with both the 'M' key, and with Shift+M, unless a second accelerator is defined for the Shift+M combination. +.PP +Example: +.PP +.nf +.br + QAccel *a = new QAccel( myWindow ); // create accels for myWindow +.br + a->connectItem( a->insertItem(Key_P+CTRL), // adds Ctrl+P accelerator +.br + myWindow, // connected to myWindow's +.br + SLOT(printDoc()) ); // printDoc() slot +.br +.fi +.PP +See also QKeyEvent, QWidget::keyPressEvent(), QMenuData::setAccel(), QButton::accel, QLabel::setBuddy(), QKeySequence, GUI Design Handbook: Keyboard Shortcuts, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAccel::QAccel ( QWidget * parent, const char * name = 0 )" +Constructs a QAccel object called \fIname\fR, with parent \fIparent\fR. The accelerator operates on \fIparent\fR. +.SH "QAccel::QAccel ( QWidget * watch, QObject * parent, const char * name = 0 )" +Constructs a QAccel object called \fIname\fR, that operates on \fIwatch\fR, and is a child of \fIparent\fR. +.PP +This constructor is not needed for normal application programming. +.SH "QAccel::~QAccel ()" +Destroys the accelerator object and frees all allocated resources. +.SH "void QAccel::activated ( int id )\fC [signal]\fR" +This signal is emitted when an accelerator key is pressed. \fIid\fR is a number that identifies this particular accelerator item. +.PP +See also activatedAmbiguously(). +.SH "void QAccel::activatedAmbiguously ( int id )\fC [signal]\fR" +This signal is emitted when an accelerator key is pressed. \fIid\fR is a number that identifies this particular accelerator item. +.PP +See also activated(). +.SH "void QAccel::clear ()" +Removes all accelerator items. +.SH "bool QAccel::connectItem ( int id, const QObject * receiver, const char * member )" +Connects the accelerator item \fIid\fR to the slot \fImember\fR of \fIreceiver\fR. +.PP +.nf +.br + a->connectItem( 201, mainView, SLOT(quit()) ); +.br +.fi +.PP +Of course, you can also send a signal as \fImember\fR. +.PP +Normally accelerators are connected to slots which then receive the \fCactivated(int id)\fR signal with the id of the accelerator item that was activated. If you choose to connect a specific accelerator item using this function, the activated() signal is emitted if the associated key sequence is pressed but no \fCactivated(int id)\fR signal is emitted. +.PP +See also disconnectItem(). +.PP +Example: t14/gamebrd.cpp. +.SH "uint QAccel::count () const" +Returns the number of accelerator items in this accelerator. +.SH "bool QAccel::disconnectItem ( int id, const QObject * receiver, const char * member )" +Disconnects an accelerator item with id \fIid\fR from the function called \fImember\fR in the \fIreceiver\fR object. +.PP +See also connectItem(). +.SH "bool QAccel::eventFilter ( QObject *, QEvent * )\fC [virtual protected]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. serves no purpose anymore +.PP +Reimplemented from QObject. +.SH "int QAccel::findKey ( const QKeySequence & key ) const" +Returns the identifier of the accelerator item with the key code \fIkey\fR, or -1 if the item cannot be found. +.SH "int QAccel::insertItem ( const QKeySequence & key, int id = -1 )" +Inserts an accelerator item and returns the item's identifier. +.PP +\fIkey\fR is a key code and an optional combination of SHIFT, CTRL and ALT. \fIid\fR is the accelerator item id. +.PP +If \fIid\fR is negative, then the item will be assigned a unique negative identifier less than -1. +.PP +.nf +.br + QAccel *a = new QAccel( myWindow ); // create accels for myWindow +.br + a->insertItem( CTRL + Key_P, 200 ); // Ctrl+P, e.g. to print document +.br + a->insertItem( ALT + Key_X, 201 ); // Alt+X, e.g. to quit +.br + a->insertItem( UNICODE_ACCEL + 'q', 202 ); // Unicode 'q', e.g. to quit +.br + a->insertItem( Key_D ); // gets a unique negative id < -1 +.br + a->insertItem( CTRL + SHIFT + Key_P ); // gets a unique negative id < -1 +.br +.fi +.PP +Example: t14/gamebrd.cpp. +.SH "bool QAccel::isEnabled () const" +Returns TRUE if the accelerator is enabled; otherwise returns FALSE. +.PP +See also setEnabled() and isItemEnabled(). +.SH "bool QAccel::isItemEnabled ( int id ) const" +Returns TRUE if the accelerator item with the identifier \fIid\fR is enabled. Returns FALSE if the item is disabled or cannot be found. +.PP +See also setItemEnabled() and isEnabled(). +.SH "QKeySequence QAccel::key ( int id )" +Returns the key sequence of the accelerator item with identifier \fIid\fR, or an invalid key sequence (0) if the id cannot be found. +.SH "QString QAccel::keyToString ( QKeySequence k )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Creates an accelerator string for the key \fIk\fR. For instance CTRL+Key_O gives "Ctrl+O". The "Ctrl" etc. are translated (using QObject::tr()) in the "QAccel" context. +.PP +The function is superfluous. Cast the QKeySequence \fIk\fR to a QString for the same effect. +.SH "void QAccel::removeItem ( int id )" +Removes the accelerator item with the identifier \fIid\fR. +.SH "void QAccel::repairEventFilter ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. serves no purpose anymore +.SH "void QAccel::setEnabled ( bool enable )" +Enables the accelerator if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. +.PP +Individual keys can also be enabled or disabled using setItemEnabled(). To work, a key must be an enabled item in an enabled QAccel. +.PP +See also isEnabled() and setItemEnabled(). +.SH "void QAccel::setItemEnabled ( int id, bool enable )" +Enables the accelerator item with the identifier \fIid\fR if \fIenable\fR is TRUE, and disables item \fIid\fR if \fIenable\fR is FALSE. +.PP +To work, an item must be enabled and be in an enabled QAccel. +.PP +See also isItemEnabled() and isEnabled(). +.SH "void QAccel::setWhatsThis ( int id, const QString & text )" +Sets a What's This help text for the accelerator item \fIid\fR to \fItext\fR. +.PP +The text will be shown when the application is in What's This mode and the user hits the accelerator key. +.PP +To set What's This help on a menu item (with or without an accelerator key), use QMenuData::setWhatsThis(). +.PP +See also whatsThis(), QWhatsThis::inWhatsThisMode(), QMenuData::setWhatsThis(), and QAction::whatsThis. +.SH "QKeySequence QAccel::shortcutKey ( const QString & str )\fC [static]\fR" +Returns the shortcut key sequence for \fIstr\fR, or an invalid key sequence (0) if \fIstr\fR has no shortcut sequence. +.PP +For example, shortcutKey("E&xit") returns ALT+Key_X, shortcutKey("&Quit") returns ALT+Key_Q and shortcutKey("Quit") returns 0. (In code that does not inherit the Qt namespace class, you must write e.g. Qt::ALT+Qt::Key_Q.) +.PP +We provide a list of common accelerators in English. At the time of writing, Microsoft and Open Group do not appear to have issued equivalent recommendations for other languages. +.SH "QKeySequence QAccel::stringToKey ( const QString & s )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns an accelerator code for the string \fIs\fR. For example" Ctrl+O" gives CTRL+UNICODE_ACCEL+'O'. The strings "Ctrl"," Shift", "Alt" are recognized, as well as their translated equivalents in the "QAccel" context (using QObject::tr()). Returns 0 if \fIs\fR is not recognized. +.PP +This function is typically used with tr(), so that accelerator keys can be replaced in translations: +.PP +.nf +.br + QPopupMenu *file = new QPopupMenu( this ); +.br + file->insertItem( p1, tr("&Open..."), this, SLOT(open()), +.br + QAccel::stringToKey(tr("Ctrl+O", "File|Open")) ); +.br +.fi +.PP +Notice the \fC"File|Open"\fR translator comment. It is by no means necessary, but it provides some context for the human translator. +.PP +The function is superfluous. Construct a QKeySequence from the string \fIs\fR for the same effect. +.PP +See also QObject::tr() and Internationalization with Qt. +.PP +Example: i18n/mywidget.cpp. +.SH "QString QAccel::whatsThis ( int id ) const" +Returns the What's This help text for the specified item \fIid\fR or QString::null if no text has been specified. +.PP +See also setWhatsThis(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqaccel.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaccel.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaccessible.3qt b/doc/man/man3/tqaccessible.3qt new file mode 100644 index 000000000..df9aab76c --- /dev/null +++ b/doc/man/man3/tqaccessible.3qt @@ -0,0 +1,399 @@ +'\" t +.TH QAccessible 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 +QAccessible \- Enums and static functions relating to accessibility +.SH SYNOPSIS +\fC#include <ntqaccessible.h>\fR +.PP +Inherited by QAccessibleInterface. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBEvent\fR { SoundPlayed = 0x0001, Alert = 0x0002, ForegroundChanged = 0x0003, MenuStart = 0x0004, MenuEnd = 0x0005, PopupMenuStart = 0x0006, PopupMenuEnd = 0x0007, ContextHelpStart = 0x000C, ContextHelpEnd = 0x000D, DragDropStart = 0x000E, DragDropEnd = 0x000F, DialogStart = 0x0010, DialogEnd = 0x0011, ScrollingStart = 0x0012, ScrollingEnd = 0x0013, MenuCommand = 0x0018, ObjectCreated = 0x8000, ObjectDestroyed = 0x8001, ObjectShow = 0x8002, ObjectHide = 0x8003, ObjectReorder = 0x8004, Focus = 0x8005, Selection = 0x8006, SelectionAdd = 0x8007, SelectionRemove = 0x8008, SelectionWithin = 0x8009, StateChanged = 0x800A, LocationChanged = 0x800B, NameChanged = 0x800C, DescriptionChanged = 0x800D, ValueChanged = 0x800E, ParentChanged = 0x800F, HelpChanged = 0x80A0, DefaultActionChanged = 0x80B0, AcceleratorChanged = 0x80C0 }" +.br +.ti -1c +.BI "enum \fBState\fR { Normal = 0x00000000, Unavailable = 0x00000001, Selected = 0x00000002, Focused = 0x00000004, Pressed = 0x00000008, Checked = 0x00000010, Mixed = 0x00000020, ReadOnly = 0x00000040, HotTracked = 0x00000080, Default = 0x00000100, Expanded = 0x00000200, Collapsed = 0x00000400, Busy = 0x00000800, Floating = 0x00001000, Marqueed = 0x00002000, Animated = 0x00004000, Invisible = 0x00008000, Offscreen = 0x00010000, Sizeable = 0x00020000, Moveable = 0x00040000, SelfVoicing = 0x00080000, Focusable = 0x00100000, Selectable = 0x00200000, Linked = 0x00400000, Traversed = 0x00800000, MultiSelectable = 0x01000000, ExtSelectable = 0x02000000, AlertLow = 0x04000000, AlertMedium = 0x08000000, AlertHigh = 0x10000000, Protected = 0x20000000, Valid = 0x3fffffff }" +.br +.ti -1c +.BI "enum \fBRole\fR { NoRole = 0x00000000, TitleBar = 0x00000001, MenuBar = 0x00000002, ScrollBar = 0x00000003, Grip = 0x00000004, Sound = 0x00000005, Cursor = 0x00000006, Caret = 0x00000007, AlertMessage = 0x00000008, Window = 0x00000009, Client = 0x0000000A, PopupMenu = 0x0000000B, MenuItem = 0x0000000C, ToolTip = 0x0000000D, Application = 0x0000000E, Document = 0x0000000F, Pane = 0x00000010, Chart = 0x00000011, Dialog = 0x00000012, Border = 0x00000013, Grouping = 0x00000014, Separator = 0x00000015, ToolBar = 0x00000016, StatusBar = 0x00000017, Table = 0x00000018, ColumnHeader = 0x00000019, RowHeader = 0x0000001A, Column = 0x0000001B, Row = 0x0000001C, Cell = 0x0000001D, Link = 0x0000001E, HelpBalloon = 0x0000001F, Character = 0x00000020, List = 0x00000021, ListItem = 0x00000022, Outline = 0x00000023, OutlineItem = 0x00000024, PageTab = 0x00000025, PropertyPage = 0x00000026, Indicator = 0x00000027, Graphic = 0x00000028, StaticText = 0x00000029, EditableText = 0x0000002A, PushButton = 0x0000002B, CheckBox = 0x0000002C, RadioButton = 0x0000002D, ComboBox = 0x0000002E, DropLest = 0x0000002F, ProgressBar = 0x00000030, Dial = 0x00000031, HotkeyField = 0x00000032, Slider = 0x00000033, SpinBox = 0x00000034, Diagram = 0x00000035, Animation = 0x00000036, Equation = 0x00000037, ButtonDropDown = 0x00000038, ButtonMenu = 0x00000039, ButtonDropGrid = 0x0000003A, Whitespace = 0x0000003B, PageTabList = 0x0000003C, Clock = 0x0000003D }" +.br +.ti -1c +.BI "enum \fBNavDirection\fR { NavUp = 0x00000001, NavDown = 0x00000002, NavLeft = 0x00000003, NavRight = 0x00000004, NavNext = 0x00000005, NavPrevious = 0x00000006, NavFirstChild = 0x00000007, NavLastChild = 0x00000008, NavFocusChild = 0x00000009 }" +.br +.ti -1c +.BI "enum \fBText\fR { Name = 0, Description, Value, Help, Accelerator, DefaultAction }" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QRESULT \fBqueryAccessibleInterface\fR ( QObject * object, QAccessibleInterface ** iface )" +.br +.ti -1c +.BI "void \fBupdateAccessibility\fR ( QObject * object, int control, Event reason )" +.br +.ti -1c +.BI "bool \fBisActive\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QAccessible class provides enums and static functions relating to accessibility. +.PP +Accessibility clients use implementations of the QAccessibleInterface to read the information an accessible object exposes, or to call functions to manipulate the accessible object. +.PP +See the plugin documentation for more details about how to redistribute Qt plugins. +.PP +See also Miscellaneous Classes. +.SS "Member Type Documentation" +.SH "QAccessible::Event" +This enum type defines event types when the state of the accessible object has changed. The event types are: +.TP +\fCQAccessible::SoundPlayed\fR +.TP +\fCQAccessible::Alert\fR +.TP +\fCQAccessible::ForegroundChanged\fR +.TP +\fCQAccessible::MenuStart\fR +.TP +\fCQAccessible::MenuEnd\fR +.TP +\fCQAccessible::PopupMenuStart\fR +.TP +\fCQAccessible::PopupMenuEnd\fR +.TP +\fCQAccessible::ContextHelpStart\fR +.TP +\fCQAccessible::ContextHelpEnd\fR +.TP +\fCQAccessible::DragDropStart\fR +.TP +\fCQAccessible::DragDropEnd\fR +.TP +\fCQAccessible::DialogStart\fR +.TP +\fCQAccessible::DialogEnd\fR +.TP +\fCQAccessible::ScrollingStart\fR +.TP +\fCQAccessible::ScrollingEnd\fR +.TP +\fCQAccessible::ObjectCreated\fR +.TP +\fCQAccessible::ObjectDestroyed\fR +.TP +\fCQAccessible::ObjectShow\fR +.TP +\fCQAccessible::ObjectHide\fR +.TP +\fCQAccessible::ObjectReorder\fR +.TP +\fCQAccessible::Focus\fR +.TP +\fCQAccessible::Selection\fR +.TP +\fCQAccessible::SelectionAdd\fR +.TP +\fCQAccessible::SelectionRemove\fR +.TP +\fCQAccessible::SelectionWithin\fR +.TP +\fCQAccessible::StateChanged\fR +.TP +\fCQAccessible::LocationChanged\fR +.TP +\fCQAccessible::NameChanged\fR +.TP +\fCQAccessible::DescriptionChanged\fR +.TP +\fCQAccessible::ValueChanged\fR +.TP +\fCQAccessible::ParentChanged\fR +.TP +\fCQAccessible::HelpChanged\fR +.TP +\fCQAccessible::DefaultActionChanged\fR +.TP +\fCQAccessible::AcceleratorChanged\fR +.TP +\fCQAccessible::MenuCommand\fR +.SH "QAccessible::NavDirection" +This enum specifies which item to move to when navigating. +.TP +\fCQAccessible::NavUp\fR - sibling above +.TP +\fCQAccessible::NavDown\fR - sibling below +.TP +\fCQAccessible::NavLeft\fR - left sibling +.TP +\fCQAccessible::NavRight\fR - right sibling +.TP +\fCQAccessible::NavNext\fR - next sibling +.TP +\fCQAccessible::NavPrevious\fR - previous sibling +.TP +\fCQAccessible::NavFirstChild\fR - first child +.TP +\fCQAccessible::NavLastChild\fR - last child +.TP +\fCQAccessible::NavFocusChild\fR - child with focus +.SH "QAccessible::Role" +This enum defines a number of roles an accessible object can have. The roles are: +.TP +\fCQAccessible::NoRole\fR +.TP +\fCQAccessible::TitleBar\fR +.TP +\fCQAccessible::MenuBar\fR +.TP +\fCQAccessible::ScrollBar\fR +.TP +\fCQAccessible::Grip\fR +.TP +\fCQAccessible::Sound\fR +.TP +\fCQAccessible::Cursor\fR +.TP +\fCQAccessible::Caret\fR +.TP +\fCQAccessible::AlertMessage\fR +.TP +\fCQAccessible::Window\fR +.TP +\fCQAccessible::Client\fR +.TP +\fCQAccessible::PopupMenu\fR +.TP +\fCQAccessible::MenuItem\fR +.TP +\fCQAccessible::ToolTip\fR +.TP +\fCQAccessible::Application\fR +.TP +\fCQAccessible::Document\fR +.TP +\fCQAccessible::Pane\fR +.TP +\fCQAccessible::Chart\fR +.TP +\fCQAccessible::Dialog\fR +.TP +\fCQAccessible::Border\fR +.TP +\fCQAccessible::Grouping\fR +.TP +\fCQAccessible::Separator\fR +.TP +\fCQAccessible::ToolBar\fR +.TP +\fCQAccessible::StatusBar\fR +.TP +\fCQAccessible::Table\fR +.TP +\fCQAccessible::ColumnHeader\fR +.TP +\fCQAccessible::RowHeader\fR +.TP +\fCQAccessible::Column\fR +.TP +\fCQAccessible::Row\fR +.TP +\fCQAccessible::Cell\fR +.TP +\fCQAccessible::Link\fR +.TP +\fCQAccessible::HelpBalloon\fR +.TP +\fCQAccessible::Character\fR +.TP +\fCQAccessible::List\fR +.TP +\fCQAccessible::ListItem\fR +.TP +\fCQAccessible::Outline\fR +.TP +\fCQAccessible::OutlineItem\fR +.TP +\fCQAccessible::PageTab\fR +.TP +\fCQAccessible::PropertyPage\fR +.TP +\fCQAccessible::Indicator\fR +.TP +\fCQAccessible::Graphic\fR +.TP +\fCQAccessible::StaticText\fR +.TP +\fCQAccessible::EditableText\fR +.TP +\fCQAccessible::PushButton\fR +.TP +\fCQAccessible::CheckBox\fR +.TP +\fCQAccessible::RadioButton\fR +.TP +\fCQAccessible::ComboBox\fR +.TP +\fCQAccessible::DropLest\fR +.TP +\fCQAccessible::ProgressBar\fR +.TP +\fCQAccessible::Dial\fR +.TP +\fCQAccessible::HotkeyField\fR +.TP +\fCQAccessible::Slider\fR +.TP +\fCQAccessible::SpinBox\fR +.TP +\fCQAccessible::Diagram\fR +.TP +\fCQAccessible::Animation\fR +.TP +\fCQAccessible::Equation\fR +.TP +\fCQAccessible::ButtonDropDown\fR +.TP +\fCQAccessible::ButtonMenu\fR +.TP +\fCQAccessible::ButtonDropGrid\fR +.TP +\fCQAccessible::Whitespace\fR +.TP +\fCQAccessible::PageTabList\fR +.TP +\fCQAccessible::Clock\fR +.SH "QAccessible::State" +This enum type defines bitflags that can be combined to indicate the state of the accessible object. The values are: +.TP +\fCQAccessible::Normal\fR +.TP +\fCQAccessible::Unavailable\fR +.TP +\fCQAccessible::Selected\fR +.TP +\fCQAccessible::Focused\fR +.TP +\fCQAccessible::Pressed\fR +.TP +\fCQAccessible::Checked\fR +.TP +\fCQAccessible::Mixed\fR +.TP +\fCQAccessible::ReadOnly\fR +.TP +\fCQAccessible::HotTracked\fR +.TP +\fCQAccessible::Default\fR +.TP +\fCQAccessible::Expanded\fR +.TP +\fCQAccessible::Collapsed\fR +.TP +\fCQAccessible::Busy\fR +.TP +\fCQAccessible::Floating\fR +.TP +\fCQAccessible::Marqueed\fR +.TP +\fCQAccessible::Animated\fR +.TP +\fCQAccessible::Invisible\fR +.TP +\fCQAccessible::Offscreen\fR +.TP +\fCQAccessible::Sizeable\fR +.TP +\fCQAccessible::Moveable\fR +.TP +\fCQAccessible::SelfVoicing\fR +.TP +\fCQAccessible::Focusable\fR +.TP +\fCQAccessible::Selectable\fR +.TP +\fCQAccessible::Linked\fR +.TP +\fCQAccessible::Traversed\fR +.TP +\fCQAccessible::MultiSelectable\fR +.TP +\fCQAccessible::ExtSelectable\fR +.TP +\fCQAccessible::AlertLow\fR +.TP +\fCQAccessible::AlertMedium\fR +.TP +\fCQAccessible::AlertHigh\fR +.TP +\fCQAccessible::Protected\fR +.TP +\fCQAccessible::Valid\fR +.SH "QAccessible::Text" +This enum specifies string information that an accessible object returns. +.TP +\fCQAccessible::Name\fR - The name of the object +.TP +\fCQAccessible::Description\fR - A short text describing the object +.TP +\fCQAccessible::Value\fR - The value of the object +.TP +\fCQAccessible::Help\fR - A longer text giving information about how to use the object +.TP +\fCQAccessible::DefaultAction\fR - The default method to interact with the object +.TP +\fCQAccessible::Accelerator\fR - The keyboard shortcut that executes the default action +.SH MEMBER FUNCTION DOCUMENTATION +.SH "bool QAccessible::isActive ()\fC [static]\fR" +Returns TRUE if an accessibility implementation has been requested, during the runtime of the application, otherwise returns FALSE. +.PP +Use this function to prevent potentially expensive notifications via updateAccessibility(). +.SH "QRESULT QAccessible::queryAccessibleInterface ( QObject * object, QAccessibleInterface ** iface )\fC [static]\fR" +Sets \fIiface\fR to point to the implementation of the QAccessibleInterface for \fIobject\fR, and returns \fCQS_OK\fR if successfull, or sets \fIiface\fR to 0 and returns \fCQE_NOCOMPONENT\fR if no accessibility implementation for \fIobject\fR exists. +.PP +The function uses the classname of \fIobject\fR to find a suitable implementation. If no implementation for the object's class is available the function tries to find an implementation for the object's parent class. +.PP +This function is called to answer an accessibility client's request for object information. You should never need to call this function yourself. +.SH "void QAccessible::updateAccessibility ( QObject * object, int control, Event reason )\fC [static]\fR" +Notifies accessibility clients about a change in \fIobject\fR's accessibility information. +.PP +\fIreason\fR specifies the cause of the change, for example, ValueChange when the position of a slider has been changed. \fIcontrol\fR is the ID of the child element that has changed. When \fIcontrol\fR is 0, the object itself has changed. +.PP +Call this function whenever the state of your accessible object or one of it's sub-elements has been changed either programmatically (e.g. by calling QLabel::setText()) or by user interaction. +.PP +If there are no accessibility tools listening to this event, the +performance penalty for calling this function is minor, but if determining +the parameters of the call is expensive you can use isActive() to +avoid unnecessary performance penalties if no client is listening. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqaccessible.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaccessible.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaccessibleinterface.3qt b/doc/man/man3/tqaccessibleinterface.3qt new file mode 100644 index 000000000..53dd6c712 --- /dev/null +++ b/doc/man/man3/tqaccessibleinterface.3qt @@ -0,0 +1,178 @@ +'\" t +.TH QAccessibleInterface 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 +QAccessibleInterface \- Defines an interface that exposes information about accessible objects +.SH SYNOPSIS +\fC#include <ntqaccessible.h>\fR +.PP +Inherits QAccessible. +.PP +Inherited by QAccessibleObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual bool \fBisValid\fR () const = 0" +.br +.ti -1c +.BI "virtual int \fBchildCount\fR () const = 0" +.br +.ti -1c +.BI "virtual QRESULT \fBqueryChild\fR ( int control, QAccessibleInterface ** iface ) const = 0" +.br +.ti -1c +.BI "virtual QRESULT \fBqueryParent\fR ( QAccessibleInterface ** iface ) const = 0" +.br +.ti -1c +.BI "virtual int \fBcontrolAt\fR ( int x, int y ) const = 0" +.br +.ti -1c +.BI "virtual QRect \fBrect\fR ( int control ) const = 0" +.br +.ti -1c +.BI "virtual int \fBnavigate\fR ( NavDirection direction, int startControl ) const = 0" +.br +.ti -1c +.BI "virtual QString \fBtext\fR ( Text t, int control ) const = 0" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( Text t, int control, const QString & text ) = 0" +.br +.ti -1c +.BI "virtual Role \fBrole\fR ( int control ) const = 0" +.br +.ti -1c +.BI "virtual State \fBstate\fR ( int control ) const = 0" +.br +.ti -1c +.BI "virtual QMemArray<int> \fBselection\fR () const = 0" +.br +.ti -1c +.BI "virtual bool \fBdoDefaultAction\fR ( int control ) = 0" +.br +.ti -1c +.BI "virtual bool \fBsetFocus\fR ( int control ) = 0" +.br +.ti -1c +.BI "virtual bool \fBsetSelected\fR ( int control, bool on, bool extend ) = 0" +.br +.ti -1c +.BI "virtual void \fBclearSelection\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QAccessibleInterface class defines an interface that exposes information about accessible objects. +.PP +See also Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "int QAccessibleInterface::childCount () const\fC [pure virtual]\fR" +Returns the number of children that belong to this object. A child can provide accessibility information on it's own (e.g. a child widget), or be a sub-element of this accessible object. +.PP +All objects provide this information. +.PP +See also queryChild(). +.SH "void QAccessibleInterface::clearSelection ()\fC [pure virtual]\fR" +Removes any selection from the object. +.PP +See also setSelected(). +.SH "int QAccessibleInterface::controlAt ( int x, int y ) const\fC [pure virtual]\fR" +Returns the ID of the child that contains the screen coordinates (\fIx\fR, \fIy\fR). This function returns 0 if the point is positioned on the object itself. If the tested point is outside the boundaries of the object this function returns -1. +.PP +All visual objects provide this information. +.SH "bool QAccessibleInterface::doDefaultAction ( int control )\fC [pure virtual]\fR" +Calling this function performs the default action of the child object specified by \fIcontrol\fR, or the default action of the object itself if \fIcontrol\fR is 0. +.SH "bool QAccessibleInterface::isValid () const\fC [pure virtual]\fR" +Returns TRUE if all the data necessary to use this interface implementation is valid (e.g. all pointers are non-null), otherwise returns FALSE. +.SH "int QAccessibleInterface::navigate ( NavDirection direction, int startControl ) const\fC [pure virtual]\fR" +This function traverses to another object, or to a sub-element of the current object. \fIdirection\fR specifies in which direction to navigate, and \fIstartControl\fR specifies the start point of the navigation, which is either 0 if the navigation starts at the object itself, or an ID of one of the object's sub-elements. +.PP +The function returns the ID of the sub-element located in the \fIdirection\fR specified. If there is nothing in the navigated \fIdirection\fR, this function returns -1. +.PP +All objects support navigation. +.SH "QRESULT QAccessibleInterface::queryChild ( int control, QAccessibleInterface ** iface ) const\fC [pure virtual]\fR" +Sets \fIiface\fR to point to the implementation of the QAccessibleInterface for the child specified with \fIcontrol\fR. If the child doesn't provide accessibility information on it's own, the value of \fIiface\fR is set to 0. For those elements, this object is responsible for exposing the child's properties. +.PP +All objects provide this information. +.PP +See also childCount() and queryParent(). +.SH "QRESULT QAccessibleInterface::queryParent ( QAccessibleInterface ** iface ) const\fC [pure virtual]\fR" +Sets \fIiface\fR to point to the implementation of the QAccessibleInterface for the parent object, or to 0 if there is no such implementation or object. +.PP +All objects provide this information. +.PP +See also queryChild(). +.SH "QRect QAccessibleInterface::rect ( int control ) const\fC [pure virtual]\fR" +Returns the location of the child specified with \fIcontrol\fR in screen coordinates. This function returns the location of the object itself if \fIcontrol\fR is 0. +.PP +All visual objects provide this information. +.SH "Role QAccessibleInterface::role ( int control ) const\fC [pure virtual]\fR" +Returns the role of the object if \fIcontrol\fR is 0, or the role of the object's sub-element with ID \fIcontrol\fR. The role of an object is usually static. All accessible objects have a role. +.PP +See also text(), state(), and selection(). +.SH "QMemArray<int> QAccessibleInterface::selection () const\fC [pure virtual]\fR" +Returns the list of all the element IDs that are selected. +.PP +See also text(), role(), and state(). +.SH "bool QAccessibleInterface::setFocus ( int control )\fC [pure virtual]\fR" +Gives the focus to the child object specified by \fIcontrol\fR, or to the object itself if \fIcontrol\fR is 0. +.PP +Returns TRUE if the focus could be set; otherwise returns FALSE. +.SH "bool QAccessibleInterface::setSelected ( int control, bool on, bool extend )\fC [pure virtual]\fR" +Sets the selection of the child object with ID \fIcontrol\fR to \fIon\fR. If \fIextend\fR is TRUE, all child elements between the focused item and the specified child object have their selection set to \fIon\fR. +.PP +Returns TRUE if the selection could be set; otherwise returns FALSE. +.PP +See also setFocus() and clearSelection(). +.SH "void QAccessibleInterface::setText ( Text t, int control, const QString & text )\fC [pure virtual]\fR" +Sets the text property \fIt\fR of the child object \fIcontrol\fR to \fItext\fR. If \fIcontrol\fR is 0, the text property of the object itself is set. +.SH "State QAccessibleInterface::state ( int control ) const\fC [pure virtual]\fR" +Returns the current state of the object if \fIcontrol\fR is 0, or the state of the object's sub-element element with ID \fIcontrol\fR. All objects have a state. +.PP +See also text(), role(), and selection(). +.SH "QString QAccessibleInterface::text ( Text t, int control ) const\fC [pure virtual]\fR" +Returns a string property \fIt\fR of the child object specified by \fIcontrol\fR, or the string property of the object itself if \fIcontrol\fR is 0. +.PP +The \fIName\fR is a string used by clients to identify, find or announce an accessible object for the user. All objects must have a name that is unique within their container. +.PP +An accessible object's \fIDescription\fR provides textual information about an object's visual appearance. The description is primarily used to provide greater context for low-vision or blind users, but is also used for context searching or other applications. Not all objects have a description. An "OK" button would not need a description, but a toolbutton that shows a picture of a smiley would. +.PP +The \fIValue\fR of an accessible object represents visual information contained by the object, e.g. the text in a line edit. Usually, the value can be modified by the user. Not all objects have a value, e.g. static text labels don't, and some objects have a state that already is the value, e.g. toggle buttons. +.PP +The \fIHelp\fR text provides information about the function and usage of an accessible object. Not all objects provide this information. +.PP +An accessible object's \fIDefaultAction\fR describes the object's primary method of manipulation, and should be a verb or a short phrase, e.g. "Press" for a button. +.PP +The accelerator is a keyboard shortcut that activates the default action of the object. A keyboard shortcut is the underlined character in the text of a menu, menu item or control, and is either the character itself, or a combination of this character and a modifier key like ALT, CTRL or SHIFT. Command controls like tool buttons also have shortcut keys and usually display them in their tooltip. +.PP +See also role(), state(), and selection(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaccessibleinterface.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaccessibleinterface.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaccessibleobject.3qt b/doc/man/man3/tqaccessibleobject.3qt new file mode 100644 index 000000000..23ddd99b3 --- /dev/null +++ b/doc/man/man3/tqaccessibleobject.3qt @@ -0,0 +1,72 @@ +'\" t +.TH QAccessibleObject 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 +QAccessibleObject \- Implements parts of the QAccessibleInterface for QObjects +.SH SYNOPSIS +\fC#include <ntqaccessible.h>\fR +.PP +Inherits QObject and QAccessibleInterface. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAccessibleObject\fR ( QObject * object )" +.br +.ti -1c +.BI "virtual \fB~QAccessibleObject\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "QObject * \fBobject\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QAccessibleObject class implements parts of the QAccessibleInterface for QObjects. +.PP +This class is mainly provided for convenience. All subclasses of the QAccessibleInterface should use this class as the base class. +.PP +See also Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAccessibleObject::QAccessibleObject ( QObject * object )" +Creates a QAccessibleObject for \fIobject\fR. +.SH "QAccessibleObject::~QAccessibleObject ()\fC [virtual]\fR" +Destroys the QAccessibleObject. +.PP +This only happens when a call to release() decrements the internal reference counter to zero. +.SH "QObject * QAccessibleObject::object () const\fC [protected]\fR" +Returns the QObject for which this QAccessibleInterface +implementation provides information. Use isValid() to make sure +the object pointer is safe to use. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaccessibleobject.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaccessibleobject.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaction.3qt b/doc/man/man3/tqaction.3qt new file mode 100644 index 000000000..7f2abfa0e --- /dev/null +++ b/doc/man/man3/tqaction.3qt @@ -0,0 +1,536 @@ +'\" t +.TH QAction 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 +QAction \- Abstract user interface action that can appear both in menus and tool bars +.SH SYNOPSIS +\fC#include <ntqaction.h>\fR +.PP +Inherits QObject. +.PP +Inherited by QActionGroup. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAction\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQAction\fR ( const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQAction\fR ( const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "QAction ( const QString & text, const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QAction ( const QString & text, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QAction ( QObject * parent, const char * name, bool toggle ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "\fB~QAction\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetIconSet\fR ( const QIconSet & )" +.br +.ti -1c +.BI "QIconSet \fBiconSet\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMenuText\fR ( const QString & )" +.br +.ti -1c +.BI "QString \fBmenuText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetToolTip\fR ( const QString & )" +.br +.ti -1c +.BI "QString \fBtoolTip\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetStatusTip\fR ( const QString & )" +.br +.ti -1c +.BI "QString \fBstatusTip\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetWhatsThis\fR ( const QString & )" +.br +.ti -1c +.BI "QString \fBwhatsThis\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAccel\fR ( const QKeySequence & key )" +.br +.ti -1c +.BI "QKeySequence \fBaccel\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetToggleAction\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisToggleAction\fR () const" +.br +.ti -1c +.BI "bool \fBisOn\fR () const" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBisVisible\fR () const" +.br +.ti -1c +.BI "virtual bool \fBaddTo\fR ( QWidget * w )" +.br +.ti -1c +.BI "virtual bool \fBremoveFrom\fR ( QWidget * w )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBactivate\fR ()" +.br +.ti -1c +.BI "void \fBtoggle\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetOn\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetEnabled\fR ( bool )" +.br +.ti -1c +.BI "void \fBsetDisabled\fR ( bool disable )" +.br +.ti -1c +.BI "void \fBsetVisible\fR ( bool )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBactivated\fR ()" +.br +.ti -1c +.BI "void \fBtoggled\fR ( bool on )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QKeySequence \fBaccel\fR - the action's accelerator key" +.br +.ti -1c +.BI "bool \fBenabled\fR - whether the action is enabled" +.br +.ti -1c +.BI "QIconSet \fBiconSet\fR - the action's icon" +.br +.ti -1c +.BI "QString \fBmenuText\fR - the action's menu text" +.br +.ti -1c +.BI "bool \fBon\fR - whether a toggle action is on" +.br +.ti -1c +.BI "QString \fBstatusTip\fR - the action's status tip" +.br +.ti -1c +.BI "QString \fBtext\fR - the action's descriptive text" +.br +.ti -1c +.BI "bool \fBtoggleAction\fR - whether the action is a toggle action" +.br +.ti -1c +.BI "QString \fBtoolTip\fR - the action's tool tip" +.br +.ti -1c +.BI "bool \fBvisible\fR - whether the action can be seen (e.g. in menus and " "toolbars" ")" +.br +.ti -1c +.BI "QString \fBwhatsThis\fR - the action's ""What's This?"" help text" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBaddedTo\fR ( QWidget * actionWidget, QWidget * container )" +.br +.ti -1c +.BI "virtual void \fBaddedTo\fR ( int index, QPopupMenu * menu )" +.br +.in -1c +.SH DESCRIPTION +The QAction class provides an abstract user interface action that can appear both in menus and tool bars. +.PP +In GUI applications many commands can be invoked via a menu option, a toolbar button and a keyboard accelerator. Since the same action must be performed regardless of how the action was invoked, and since the menu and toolbar should be kept in sync, it is useful to represent a command as an \fIaction\fR. An action can be added to a menu and a toolbar and will automatically keep them in sync. For example, if the user presses a Bold toolbar button the Bold menu item will automatically be checked. +.PP +A QAction may contain an icon, a menu text, an accelerator, a status text, a whats this text and a tool tip. Most of these can be set in the constructor. They can also be set independently with setIconSet(), setText(), setMenuText(), setToolTip(), setStatusTip(), setWhatsThis() and setAccel(). +.PP +An action may be a toggle action e.g. a Bold toolbar button, or a command action, e.g. 'Open File' to invoke an open file dialog. Toggle actions emit the toggled() signal when their state changes. Both command and toggle actions emit the activated() signal when they are invoked. Use setToggleAction() to set an action's toggled status. To see if an action is a toggle action use isToggleAction(). A toggle action may be "on", isOn() returns TRUE, or "off", isOn() returns FALSE. +.PP +Actions are added to widgets (menus or toolbars) using addTo(), and removed using removeFrom(). +.PP +Once a QAction has been created it should be added to the relevant menu and toolbar and then connected to the slot which will perform the action. For example: +.PP +.nf +.br + fileOpenAction = new QAction( QPixmap( fileopen ), "&Open...", +.br + CTRL+Key_O, this, "open" ); +.br + connect( fileOpenAction, SIGNAL( activated() ) , this, SLOT( choose() ) ); +.fi +.PP +We create a "File Save" action with a menu text of "&Save" and \fICtrl+S\fR as the keyboard accelerator. We connect the fileSaveAction's activated() signal to our own save() slot. Note that at this point there is no menu or toolbar action, we'll add them next: +.PP +.nf +.br + QToolBar * fileTools = new QToolBar( this, "file operations" ); +.fi +.PP +.nf +.br + fileSaveAction->addTo( fileTools ); +.fi +.PP +.nf +.br + QPopupMenu * file = new QPopupMenu( this ); +.br + menuBar()->insertItem( "&File", file ); +.fi +.PP +.nf +.br + fileSaveAction->addTo( file ); +.fi +.PP +We create a toolbar and add our fileSaveAction to it. Similarly we create a menu, add a top-level menu item, and add our fileSaveAction. +.PP +We recommend that actions are created as children of the window that they are used in. In most cases actions will be children of the application's main window. +.PP +To prevent recursion, don't create an action as a child of a widget that the action is later added to. +.PP +See also Main Window and Related Classes and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAction::QAction ( QObject * parent, const char * name = 0 )" +Constructs an action called \fIname\fR with parent \fIparent\fR. +.PP +If \fIparent\fR is a QActionGroup, the new action inserts itself into \fIparent\fR. +.PP +For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. +.PP +\fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. +.SH "QAction::QAction ( const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" +This constructor results in an icon-less action with the the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. +.PP +If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. +.PP +For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. +.PP +The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for toolbuttons. You can override this by setting a specific description with setText(). The same text and \fIaccel\fR will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip(). +.PP +Call setToggleAction(TRUE) to make the action a toggle action. +.PP +\fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. +.SH "QAction::QAction ( const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )" +This constructor creates an action with the following properties: the icon or iconset \fIicon\fR, the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. +.PP +If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. +.PP +For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. +.PP +The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for toolbuttons. You can override this by setting a specific description with setText(). The same text and \fIaccel\fR will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip(). +.PP +Call setToggleAction(TRUE) to make the action a toggle action. +.PP +\fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. +.SH "QAction::QAction ( const QString & text, const QIconSet & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This constructor creates an action with the following properties: the description \fItext\fR, the icon or iconset \fIicon\fR, the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. +.PP +If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. +.PP +For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. +.PP +The \fItext\fR and \fIaccel\fR will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip(). +.SH "QAction::QAction ( const QString & text, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This constructor results in an icon-less action with the description \fItext\fR, the menu text \fImenuText\fR and the keyboard accelerator \fIaccel\fR. Its parent is \fIparent\fR and it is called \fIname\fR. If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. +.PP +The action automatically becomes a member of \fIparent\fR if \fIparent\fR is a QActionGroup. +.PP +For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. +.PP +The \fItext\fR and \fIaccel\fR will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip(). +.SH "QAction::QAction ( QObject * parent, const char * name, bool toggle )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Constructs an action called \fIname\fR with parent \fIparent\fR. +.PP +If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. +.PP +If \fIparent\fR is a QActionGroup, the new action inserts itself into \fIparent\fR. +.PP +For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. +.SH "QAction::~QAction ()" +Destroys the object and frees allocated resources. +.SH "QKeySequence QAction::accel () const" +Returns the action's accelerator key. See the "accel" property for details. +.SH "void QAction::activate ()\fC [slot]\fR" +Activates the action and executes all connected slots. This only works for actions that are not toggle action. +.PP +See also toggle(). +.SH "void QAction::activated ()\fC [signal]\fR" +This signal is emitted when an action is activated by the user, e.g. when the user clicks a menu option or a toolbar button or presses an action's accelerator key combination. +.PP +Connect to this signal for command actions. Connect to the toggled() signal for toggle actions. +.PP +Examples: +.)l action/application.cpp, chart/chartform.cpp, and themes/themes.cpp. +.SH "bool QAction::addTo ( QWidget * w )\fC [virtual]\fR" +Adds this action to widget \fIw\fR. +.PP +Currently actions may be added to QToolBar and QPopupMenu widgets. +.PP +An action added to a tool bar is automatically displayed as a tool button; an action added to a pop up menu appears as a menu option. +.PP +addTo() returns TRUE if the action was added successfully and FALSE otherwise. (If \fIw\fR is not a QToolBar or QPopupMenu the action will not be added and FALSE will be returned.) +.PP +See also removeFrom(). +.PP +Examples: +.)l action/application.cpp, action/toggleaction/toggleaction.cpp, and chart/chartform.cpp. +.PP +Reimplemented in QActionGroup. +.SH "void QAction::addedTo ( QWidget * actionWidget, QWidget * container )\fC [virtual protected]\fR" +This function is called from the addTo() function when it has created a widget (\fIactionWidget\fR) for the action in the \fIcontainer\fR. +.SH "void QAction::addedTo ( int index, QPopupMenu * menu )\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function is called from the addTo() function when it has created a menu item at the index position \fIindex\fR in the popup menu \fImenu\fR. +.SH "QIconSet QAction::iconSet () const" +Returns the action's icon. See the "iconSet" property for details. +.SH "bool QAction::isEnabled () const" +Returns TRUE if the action is enabled; otherwise returns FALSE. See the "enabled" property for details. +.SH "bool QAction::isOn () const" +Returns TRUE if a toggle action is on; otherwise returns FALSE. See the "on" property for details. +.SH "bool QAction::isToggleAction () const" +Returns TRUE if the action is a toggle action; otherwise returns FALSE. See the "toggleAction" property for details. +.SH "bool QAction::isVisible () const" +Returns TRUE if the action can be seen (e.g. in menus and toolbars); otherwise returns FALSE. See the "visible" property for details. +.SH "QString QAction::menuText () const" +Returns the action's menu text. See the "menuText" property for details. +.SH "bool QAction::removeFrom ( QWidget * w )\fC [virtual]\fR" +Removes the action from widget \fIw\fR. +.PP +Returns TRUE if the action was removed successfully; otherwise returns FALSE. +.PP +See also addTo(). +.SH "void QAction::setAccel ( const QKeySequence & key )\fC [virtual]\fR" +Sets the action's accelerator key to \fIkey\fR. See the "accel" property for details. +.SH "void QAction::setDisabled ( bool disable )\fC [slot]\fR" +Disables the action if \fIdisable\fR is TRUE; otherwise enables the action. +.PP +See the enabled documentation for more information. +.SH "void QAction::setEnabled ( bool )\fC [virtual slot]\fR" +Sets whether the action is enabled. See the "enabled" property for details. +.SH "void QAction::setIconSet ( const QIconSet & )\fC [virtual]\fR" +Sets the action's icon. See the "iconSet" property for details. +.SH "void QAction::setMenuText ( const QString & )\fC [virtual]\fR" +Sets the action's menu text. See the "menuText" property for details. +.SH "void QAction::setOn ( bool )\fC [virtual slot]\fR" +Sets whether a toggle action is on. See the "on" property for details. +.SH "void QAction::setStatusTip ( const QString & )\fC [virtual]\fR" +Sets the action's status tip. See the "statusTip" property for details. +.SH "void QAction::setText ( const QString & )\fC [virtual]\fR" +Sets the action's descriptive text. See the "text" property for details. +.SH "void QAction::setToggleAction ( bool )\fC [virtual]\fR" +Sets whether the action is a toggle action. See the "toggleAction" property for details. +.SH "void QAction::setToolTip ( const QString & )\fC [virtual]\fR" +Sets the action's tool tip. See the "toolTip" property for details. +.SH "void QAction::setVisible ( bool )\fC [slot]\fR" +Sets whether the action can be seen (e.g. in menus and toolbars). See the "visible" property for details. +.SH "void QAction::setWhatsThis ( const QString & )\fC [virtual]\fR" +Sets the action's "What's This?" help text. See the "whatsThis" property for details. +.SH "QString QAction::statusTip () const" +Returns the action's status tip. See the "statusTip" property for details. +.SH "QString QAction::text () const" +Returns the action's descriptive text. See the "text" property for details. +.SH "void QAction::toggle ()\fC [slot]\fR" +Toggles the state of a toggle action. +.PP +See also on, activate(), toggled(), and toggleAction. +.SH "void QAction::toggled ( bool on )\fC [signal]\fR" +This signal is emitted when a toggle action changes state; command actions and QActionGroups don't emit toggled(). +.PP +The \fIon\fR argument denotes the new state: If \fIon\fR is TRUE the toggle action is switched on, and if \fIon\fR is FALSE the toggle action is switched off. +.PP +To trigger a user command depending on whether a toggle action has been switched on or off connect it to a slot that takes a bool to indicate the state, e.g. +.PP +.nf +.br + QMainWindow * window = new QMainWindow; +.fi +.PP +.nf +.br + QAction * labelonoffaction = new QAction( window, "labelonoff" ); +.fi +.PP +.nf +.br + QObject::connect( labelonoffaction, SIGNAL( toggled( bool ) ), +.br + window, SLOT( setUsesTextLabel( bool ) ) ); +.fi +.PP +See also activated(), toggleAction, and on. +.PP +Example: action/toggleaction/toggleaction.cpp. +.SH "QString QAction::toolTip () const" +Returns the action's tool tip. See the "toolTip" property for details. +.SH "QString QAction::whatsThis () const" +Returns the action's "What's This?" help text. See the "whatsThis" property for details. +.SS "Property Documentation" +.SH "QKeySequence accel" +This property holds the action's accelerator key. +.PP +The keycodes can be found in Qt::Key and Qt::Modifier. There is no default accelerator key. +.PP +Set this property's value with setAccel() and get this property's value with accel(). +.SH "bool enabled" +This property holds whether the action is enabled. +.PP +Disabled actions can't be chosen by the user. They don't disappear from the menu/tool bar but are displayed in a way which indicates that they are unavailable, e.g. they might be displayed grayed out. +.PP +What's this? help on disabled actions is still available provided the QAction::whatsThis property is set. +.PP +Set this property's value with setEnabled() and get this property's value with isEnabled(). +.SH "QIconSet iconSet" +This property holds the action's icon. +.PP +The icon is used as the tool button icon and in the menu to the left of the menu text. There is no default icon. +.PP +If a null icon (QIconSet::isNull() is passed into this function, the icon of the action is cleared. +.PP +(See the action/toggleaction/toggleaction.cpp example.) +.PP +Set this property's value with setIconSet() and get this property's value with iconSet(). +.SH "QString menuText" +This property holds the action's menu text. +.PP +If the action is added to a menu the menu option will consist of the icon (if there is one), the menu text and the accelerator (if there is one). If the menu text is not explicitly set in the constructor or by using setMenuText() the action's description text will be used as the menu text. There is no default menu text. +.PP +See also text. +.PP +Set this property's value with setMenuText() and get this property's value with menuText(). +.SH "bool on" +This property holds whether a toggle action is on. +.PP +This property is always on (TRUE) for command actions and QActionGroups; setOn() has no effect on them. For action's where isToggleAction() is TRUE, this property's default value is off (FALSE). +.PP +See also toggleAction. +.PP +Set this property's value with setOn() and get this property's value with isOn(). +.SH "QString statusTip" +This property holds the action's status tip. +.PP +The statusTip is displayed on all status bars that this action's toplevel parent widget provides. +.PP +If no status tip is defined, the action uses the tool tip text. +.PP +There is no default statusTip text. +.PP +See also statusTip and toolTip. +.PP +Set this property's value with setStatusTip() and get this property's value with statusTip(). +.SH "QString text" +This property holds the action's descriptive text. +.PP +If QMainWindow::usesTextLabel is TRUE, the text appears as a label in the relevant tool button. It also serves as the default text in menus and tool tips if these have not been specifically defined. There is no default text. +.PP +See also menuText, toolTip, and statusTip. +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "bool toggleAction" +This property holds whether the action is a toggle action. +.PP +A toggle action is one which has an on/off state. For example a Bold toolbar button is either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. This property's default is FALSE. +.PP +In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and" Right Align" toggle actions are mutually exclusive. To achieve exclusive toggling, add the relevant toggle actions to a QActionGroup with the QActionGroup::exclusive property set to TRUE. +.PP +Set this property's value with setToggleAction() and get this property's value with isToggleAction(). +.SH "QString toolTip" +This property holds the action's tool tip. +.PP +This text is used for the tool tip. If no status tip has been set the tool tip will be used for the status tip. +.PP +If no tool tip is specified the action's text is used, and if that hasn't been specified the description text is used as the tool tip text. +.PP +There is no default tool tip text. +.PP +See also statusTip and accel. +.PP +Set this property's value with setToolTip() and get this property's value with toolTip(). +.SH "bool visible" +This property holds whether the action can be seen (e.g. in menus and toolbars). +.PP +If \fIvisible\fR is TRUE the action can be seen (e.g. in menus and toolbars) and chosen by the user; if \fIvisible\fR is FALSE the action cannot be seen or chosen by the user. +.PP +Actions which are not visible are \fInot\fR grayed out; they do not appear at all. +.PP +Set this property's value with setVisible() and get this property's value with isVisible(). +.SH "QString whatsThis" +This property holds the action's "What's This?" help text. +.PP +The whats this text is used to provide a brief description of the action. The text may contain rich text (HTML-like tags -- see QStyleSheet for the list of supported tags). There is no default" What's This" text. +.PP +See also QWhatsThis. +.PP +Set this property's value with setWhatsThis() and get this property's value with whatsThis(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqaction.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaction.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqactiongroup.3qt b/doc/man/man3/tqactiongroup.3qt new file mode 100644 index 000000000..e11b6e96d --- /dev/null +++ b/doc/man/man3/tqactiongroup.3qt @@ -0,0 +1,206 @@ +'\" t +.TH QActionGroup 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 +QActionGroup \- Groups actions together +.SH SYNOPSIS +\fC#include <ntqaction.h>\fR +.PP +Inherits QAction. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQActionGroup\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQActionGroup\fR ( QObject * parent, const char * name, bool exclusive )" +.br +.ti -1c +.BI "\fB~QActionGroup\fR ()" +.br +.ti -1c +.BI "void \fBsetExclusive\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisExclusive\fR () const" +.br +.ti -1c +.BI "void \fBadd\fR ( QAction * action )" +.br +.ti -1c +.BI "void \fBaddSeparator\fR ()" +.br +.ti -1c +.BI "virtual bool \fBaddTo\fR ( QWidget * w )" +.br +.ti -1c +.BI "void \fBsetUsesDropDown\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBusesDropDown\fR () const" +.br +.ti -1c +.BI "void insert ( QAction * a ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBselected\fR ( QAction * )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBexclusive\fR - whether the action group does exclusive toggling" +.br +.ti -1c +.BI "bool \fBusesDropDown\fR - whether the group's actions are displayed in a subwidget of the widgets the action group is added to" +.br +.in -1c +.SH DESCRIPTION +The QActionGroup class groups actions together. +.PP +In some situations it is useful to group actions together. For example, if you have a left justify action, a right justify action and a center action, only one of these actions should be active at any one time, and one simple way of achieving this is to group the actions together in an action group. +.PP +An action group can also be added to a menu or a toolbar as a single unit, with all the actions within the action group appearing as separate menu options and toolbar buttons. +.PP +Here's an example from examples/textedit: +.PP +.nf +.br + QActionGroup *grp = new QActionGroup( this ); +.br + connect( grp, SIGNAL( selected( QAction* ) ), this, SLOT( textAlign( QAction* ) ) ); +.fi +.PP +Here we create a new action group. Since the action group is exclusive by default, only one of the actions in the group is ever active at any one time. We then connect the group's selected() signal to our textAlign() slot. +.PP +.nf +.br + actionAlignLeft = new QAction( QPixmap::fromMimeSource( "textleft.xpm" ), tr( "&Left" ), CTRL + Key_L, grp, "textLeft" ); +.br + actionAlignLeft->setToggleAction( TRUE ); +.fi +.PP +We create a left align action, add it to the toolbar and the menu and make it a toggle action. We create center and right align actions in exactly the same way. +.PP +The actions in an action group emit their activated() (and for toggle actions, toggled()) signals as usual. +.PP +The setExclusive() function is used to ensure that only one action is active at any one time: it should be used with actions which have their toggleAction set to TRUE. +.PP +Action group actions appear as individual menu options and toolbar buttons. For exclusive action groups use setUsesDropDown() to display the actions in a subwidget of any widget the action group is added to. For example, the actions would appear in a combobox in a toolbar or as a submenu in a menu. +.PP +Actions can be added to an action group using add(), but normally they are added by creating the action with the action group as parent. Actions can have separators dividing them using addSeparator(). Action groups are added to widgets with addTo(). +.PP +See also Main Window and Related Classes and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QActionGroup::QActionGroup ( QObject * parent, const char * name = 0 )" +Constructs an action group called \fIname\fR, with parent \fIparent\fR. +.PP +The action group is exclusive by default. Call setExclusive(FALSE) to make the action group non-exclusive. +.SH "QActionGroup::QActionGroup ( QObject * parent, const char * name, bool exclusive )" +Constructs an action group called \fIname\fR, with parent \fIparent\fR. +.PP +If \fIexclusive\fR is TRUE only one toggle action in the group will ever be active. +.PP +See also exclusive. +.SH "QActionGroup::~QActionGroup ()" +Destroys the object and frees allocated resources. +.SH "void QActionGroup::add ( QAction * action )" +Adds action \fIaction\fR to this group. +.PP +Normally an action is added to a group by creating it with the group as parent, so this function is not usually used. +.PP +See also addTo(). +.SH "void QActionGroup::addSeparator ()" +Adds a separator to the group. +.SH "bool QActionGroup::addTo ( QWidget * w )\fC [virtual]\fR" +Adds this action group to the widget \fIw\fR. +.PP +If isExclusive() is FALSE or usesDropDown() is FALSE, the actions within the group are added to the widget individually. For example, if the widget is a menu, the actions will appear as individual menu options, and if the widget is a toolbar, the actions will appear as toolbar buttons. +.PP +If both isExclusive() and usesDropDown() are TRUE, the actions are presented either in a combobox (if \fIw\fR is a toolbar) or in a submenu (if \fIw\fR is a menu). +.PP +All actions should be added to the action group \fIbefore\fR the action group is added to the widget. If actions are added to the action group \fIafter\fR the action group has been added to the widget these later actions will \fInot\fR appear. +.PP +See also exclusive, usesDropDown, and removeFrom(). +.PP +Example: themes/themes.cpp. +.PP +Reimplemented from QAction. +.SH "void QActionGroup::insert ( QAction * a )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use add() instead, or better still create the action with the action group as its parent. +.SH "bool QActionGroup::isExclusive () const" +Returns TRUE if the action group does exclusive toggling; otherwise returns FALSE. See the "exclusive" property for details. +.SH "void QActionGroup::selected ( QAction * )\fC [signal]\fR" +This signal is emitted from exclusive groups when toggle actions change state. +.PP +The argument is the action whose state changed to "on". +.PP +See also exclusive, on, and QAction::toggled(). +.PP +Examples: +.)l chart/chartform.cpp and textedit/textedit.cpp. +.SH "void QActionGroup::setExclusive ( bool )" +Sets whether the action group does exclusive toggling. See the "exclusive" property for details. +.SH "void QActionGroup::setUsesDropDown ( bool enable )" +Sets whether the group's actions are displayed in a subwidget of the widgets the action group is added to to \fIenable\fR. See the "usesDropDown" property for details. +.SH "bool QActionGroup::usesDropDown () const" +Returns TRUE if the group's actions are displayed in a subwidget of the widgets the action group is added to; otherwise returns FALSE. See the "usesDropDown" property for details. +.SS "Property Documentation" +.SH "bool exclusive" +This property holds whether the action group does exclusive toggling. +.PP +If exclusive is TRUE only one toggle action in the action group can ever be active at any one time. If the user chooses another toggle action in the group the one they chose becomes active and the one that was active becomes inactive. +.PP +See also QAction::toggleAction. +.PP +Set this property's value with setExclusive() and get this property's value with isExclusive(). +.SH "bool usesDropDown" +This property holds whether the group's actions are displayed in a subwidget of the widgets the action group is added to. +.PP +Exclusive action groups added to a toolbar display their actions in a combobox with the action's QAction::text and QAction::iconSet properties shown. Non-exclusive groups are represented by a tool button showing their QAction::iconSet and -- depending on QMainWindow::usesTextLabel() -- text() property. +.PP +In a popup menu the member actions are displayed in a submenu. +.PP +Changing usesDropDown only affects \fIsubsequent\fR calls to addTo(). +.PP +Note that setting this property for actions in a combobox causes calls to their QAction::setVisible(), QAction::setEnabled(), and QAction::setDisabled() functions to have no effect. +.PP +This property's default is FALSE. +.PP +Set this property's value with setUsesDropDown() and get this property's value with usesDropDown(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qactiongroup.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqactiongroup.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqapplication.3qt b/doc/man/man3/tqapplication.3qt new file mode 100644 index 000000000..90a960b60 --- /dev/null +++ b/doc/man/man3/tqapplication.3qt @@ -0,0 +1,1990 @@ +'\" t +.TH QApplication 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 +QApplication \- Manages the GUI application's control flow and main settings +.SH SYNOPSIS +\fC#include <ntqapplication.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQApplication\fR ( int & argc, char ** argv )" +.br +.ti -1c +.BI "\fBQApplication\fR ( int & argc, char ** argv, bool GUIenabled )" +.br +.ti -1c +.BI "enum \fBType\fR { Tty, GuiClient, GuiServer }" +.br +.ti -1c +.BI "\fBQApplication\fR ( int & argc, char ** argv, Type type )" +.br +.ti -1c +.BI "\fBQApplication\fR ( Display * dpy, HANDLE visual = 0, HANDLE colormap = 0 )" +.br +.ti -1c +.BI "\fBQApplication\fR ( Display * dpy, int argc, char ** argv, HANDLE visual = 0, HANDLE colormap = 0 )" +.br +.ti -1c +.BI "virtual \fB~QApplication\fR ()" +.br +.ti -1c +.BI "int \fBargc\fR () const" +.br +.ti -1c +.BI "char ** \fBargv\fR () const" +.br +.ti -1c +.BI "Type \fBtype\fR () const" +.br +.ti -1c +.BI "enum \fBColorSpec\fR { NormalColor = 0, CustomColor = 1, ManyColor = 2 }" +.br +.ti -1c +.BI "QWidget * \fBmainWidget\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMainWidget\fR ( QWidget * mainWidget )" +.br +.ti -1c +.BI "virtual void \fBpolish\fR ( QWidget * w )" +.br +.ti -1c +.BI "QWidget * \fBfocusWidget\fR () const" +.br +.ti -1c +.BI "QWidget * \fBactiveWindow\fR () const" +.br +.ti -1c +.BI "int \fBexec\fR ()" +.br +.ti -1c +.BI "void \fBprocessEvents\fR ()" +.br +.ti -1c +.BI "void \fBprocessEvents\fR ( int maxtime )" +.br +.ti -1c +.BI "void processOneEvent () \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBhasPendingEvents\fR ()" +.br +.ti -1c +.BI "int enter_loop () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void exit_loop () \fI(obsolete)\fR" +.br +.ti -1c +.BI "int loopLevel () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual bool \fBnotify\fR ( QObject * receiver, QEvent * e )" +.br +.ti -1c +.BI "void setDefaultCodec ( QTextCodec * codec ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QTextCodec * defaultCodec () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBinstallTranslator\fR ( QTranslator * mf )" +.br +.ti -1c +.BI "void \fBremoveTranslator\fR ( QTranslator * mf )" +.br +.ti -1c +.BI "enum \fBEncoding\fR { DefaultCodec, UnicodeUTF8 }" +.br +.ti -1c +.BI "QString \fBtranslate\fR ( const char * context, const char * sourceText, const char * comment = 0, Encoding encoding = DefaultCodec ) const" +.br +.ti -1c +.BI "QString \fBapplicationDirPath\fR ()" +.br +.ti -1c +.BI "QString \fBapplicationFilePath\fR ()" +.br +.ti -1c +.BI "virtual bool \fBmacEventFilter\fR ( EventHandlerCallRef, EventRef )" +.br +.ti -1c +.BI "virtual bool \fBwinEventFilter\fR ( MSG * )" +.br +.ti -1c +.BI "virtual bool \fBx11EventFilter\fR ( XEvent * )" +.br +.ti -1c +.BI "int \fBx11ProcessEvent\fR ( XEvent * event )" +.br +.ti -1c +.BI "virtual bool \fBqwsEventFilter\fR ( QWSEvent * )" +.br +.ti -1c +.BI "void \fBqwsSetCustomColors\fR ( QRgb * colorTable, int start, int numColors )" +.br +.ti -1c +.BI "void \fBwinFocus\fR ( QWidget * widget, bool gotFocus )" +.br +.ti -1c +.BI "bool \fBisSessionRestored\fR () const" +.br +.ti -1c +.BI "QString \fBsessionId\fR () const" +.br +.ti -1c +.BI "QString \fBsessionKey\fR () const" +.br +.ti -1c +.BI "virtual void \fBcommitData\fR ( QSessionManager & sm )" +.br +.ti -1c +.BI "virtual void \fBsaveState\fR ( QSessionManager & sm )" +.br +.ti -1c +.BI "void \fBwakeUpGuiThread\fR ()" +.br +.ti -1c +.BI "void \fBlock\fR ()" +.br +.ti -1c +.BI "void \fBunlock\fR ( bool wakeUpGui = TRUE )" +.br +.ti -1c +.BI "bool \fBlocked\fR ()" +.br +.ti -1c +.BI "bool \fBtryLock\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBquit\fR ()" +.br +.ti -1c +.BI "void \fBcloseAllWindows\fR ()" +.br +.ti -1c +.BI "void \fBaboutTQt\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBlastWindowClosed\fR ()" +.br +.ti -1c +.BI "void \fBaboutToQuit\fR ()" +.br +.ti -1c +.BI "void \fBguiThreadAwake\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QStyle & \fBstyle\fR ()" +.br +.ti -1c +.BI "void \fBsetStyle\fR ( QStyle * style )" +.br +.ti -1c +.BI "QStyle * \fBsetStyle\fR ( const QString & style )" +.br +.ti -1c +.BI "int \fBcolorSpec\fR ()" +.br +.ti -1c +.BI "void \fBsetColorSpec\fR ( int spec )" +.br +.ti -1c +.BI "QCursor * \fBoverrideCursor\fR ()" +.br +.ti -1c +.BI "void \fBsetOverrideCursor\fR ( const QCursor & cursor, bool replace = FALSE )" +.br +.ti -1c +.BI "void \fBrestoreOverrideCursor\fR ()" +.br +.ti -1c +.BI "bool \fBhasGlobalMouseTracking\fR ()" +.br +.ti -1c +.BI "void \fBsetGlobalMouseTracking\fR ( bool enable )" +.br +.ti -1c +.BI "QPalette \fBpalette\fR ( const QWidget * w = 0 )" +.br +.ti -1c +.BI "void \fBsetPalette\fR ( const QPalette & palette, bool informWidgets = FALSE, const char * className = 0 )" +.br +.ti -1c +.BI "QFont \fBfont\fR ( const QWidget * w = 0 )" +.br +.ti -1c +.BI "void \fBsetFont\fR ( const QFont & font, bool informWidgets = FALSE, const char * className = 0 )" +.br +.ti -1c +.BI "QFontMetrics \fBfontMetrics\fR ()" +.br +.ti -1c +.BI "QWidgetList * \fBallWidgets\fR ()" +.br +.ti -1c +.BI "QWidgetList * \fBtopLevelWidgets\fR ()" +.br +.ti -1c +.BI "QDesktopWidget * \fBdesktop\fR ()" +.br +.ti -1c +.BI "QWidget * \fBactivePopupWidget\fR ()" +.br +.ti -1c +.BI "QWidget * \fBactiveModalWidget\fR ()" +.br +.ti -1c +.BI "QClipboard * \fBclipboard\fR ()" +.br +.ti -1c +.BI "QWidget * \fBwidgetAt\fR ( int x, int y, bool child = FALSE )" +.br +.ti -1c +.BI "QWidget * \fBwidgetAt\fR ( const QPoint & pos, bool child = FALSE )" +.br +.ti -1c +.BI "QEventLoop * \fBeventLoop\fR ()" +.br +.ti -1c +.BI "void \fBexit\fR ( int retcode = 0 )" +.br +.ti -1c +.BI "bool \fBsendEvent\fR ( QObject * receiver, QEvent * event )" +.br +.ti -1c +.BI "void \fBpostEvent\fR ( QObject * receiver, QEvent * event )" +.br +.ti -1c +.BI "void \fBsendPostedEvents\fR ( QObject * receiver, int event_type )" +.br +.ti -1c +.BI "void \fBsendPostedEvents\fR ()" +.br +.ti -1c +.BI "void \fBremovePostedEvents\fR ( QObject * receiver )" +.br +.ti -1c +.BI "bool \fBstartingUp\fR ()" +.br +.ti -1c +.BI "bool \fBclosingDown\fR ()" +.br +.ti -1c +.BI "void \fBflushX\fR ()" +.br +.ti -1c +.BI "void \fBflush\fR ()" +.br +.ti -1c +.BI "void \fBsyncX\fR ()" +.br +.ti -1c +.BI "void \fBbeep\fR ()" +.br +.ti -1c +.BI "void setWinStyleHighlightColor ( const QColor & c ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "const QColor & winStyleHighlightColor () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetDesktopSettingsAware\fR ( bool on )" +.br +.ti -1c +.BI "bool \fBdesktopSettingsAware\fR ()" +.br +.ti -1c +.BI "void \fBsetCursorFlashTime\fR ( int msecs )" +.br +.ti -1c +.BI "int \fBcursorFlashTime\fR ()" +.br +.ti -1c +.BI "void \fBsetDoubleClickInterval\fR ( int ms )" +.br +.ti -1c +.BI "int \fBdoubleClickInterval\fR ()" +.br +.ti -1c +.BI "void \fBsetWheelScrollLines\fR ( int n )" +.br +.ti -1c +.BI "int \fBwheelScrollLines\fR ()" +.br +.ti -1c +.BI "void \fBsetGlobalStrut\fR ( const QSize & strut )" +.br +.ti -1c +.BI "QSize \fBglobalStrut\fR ()" +.br +.ti -1c +.BI "void \fBsetLibraryPaths\fR ( const QStringList & paths )" +.br +.ti -1c +.BI "QStringList \fBlibraryPaths\fR ()" +.br +.ti -1c +.BI "void \fBaddLibraryPath\fR ( const QString & path )" +.br +.ti -1c +.BI "void \fBremoveLibraryPath\fR ( const QString & path )" +.br +.ti -1c +.BI "void \fBsetStartDragTime\fR ( int ms )" +.br +.ti -1c +.BI "int \fBstartDragTime\fR ()" +.br +.ti -1c +.BI "void \fBsetStartDragDistance\fR ( int l )" +.br +.ti -1c +.BI "int \fBstartDragDistance\fR ()" +.br +.ti -1c +.BI "void \fBsetReverseLayout\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBreverseLayout\fR ()" +.br +.ti -1c +.BI "int \fBhorizontalAlignment\fR ( int align )" +.br +.ti -1c +.BI "bool \fBisEffectEnabled\fR ( Qt::UIEffect effect )" +.br +.ti -1c +.BI "void \fBsetEffectEnabled\fR ( Qt::UIEffect effect, bool enable = TRUE )" +.br +.ti -1c +.BI "QWSDecoration & \fBqwsDecoration\fR ()" +.br +.ti -1c +.BI "void \fBqwsSetDecoration\fR ( QWSDecoration * d )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "void \fBqAddPostRoutine\fR ( QtCleanUpFunction p )" +.br +.ti -1c +.BI "const char * \fBqVersion\fR ()" +.br +.ti -1c +.BI "bool \fBqSysInfo\fR ( int * wordSize, bool * bigEndian )" +.br +.ti -1c +.BI "void \fBqDebug\fR ( const char * msg, ... )" +.br +.ti -1c +.BI "void \fBqWarning\fR ( const char * msg, ... )" +.br +.ti -1c +.BI "void \fBqFatal\fR ( const char * msg, ... )" +.br +.ti -1c +.BI "void \fBqSystemWarning\fR ( const char * msg, int code )" +.br +.ti -1c +.BI "void \fBQ_ASSERT\fR ( bool test )" +.br +.ti -1c +.BI "void \fBTQ_CHECK_PTR\fR ( void * p )" +.br +.ti -1c +.BI "QtMsgHandler \fBqInstallMsgHandler\fR ( QtMsgHandler h )" +.br +.in -1c +.SH DESCRIPTION +The QApplication class manages the GUI application's control flow and main settings. +.PP +It contains the main event loop, where all events from the window system and other sources are processed and dispatched. It also handles the application's initialization and finalization, and provides session management. It also handles most system-wide and application-wide settings. +.PP +For any GUI application that uses Qt, there is precisely one QApplication object, no matter whether the application has 0, 1, 2 or more windows at any time. +.PP +The QApplication object is accessible through the global pointer \fCqApp\fR. Its main areas of responsibility are: +.IP +.TP +It initializes the application with the user's desktop settings such as palette(), font() and doubleClickInterval(). It keeps track of these properties in case the user changes the desktop globally, for example through some kind of control panel. +.IP +.TP +It performs event handling, meaning that it receives events from the underlying window system and dispatches them to the relevant widgets. By using sendEvent() and postEvent() you can send your own events to widgets. +.IP +.TP +It parses common command line arguments and sets its internal state accordingly. See the constructor documentation below for more details about this. +.IP +.TP +It defines the application's look and feel, which is encapsulated in a QStyle object. This can be changed at runtime with setStyle(). +.IP +.TP +It specifies how the application is to allocate colors. See setColorSpec() for details. +.IP +.TP +It provides localization of strings that are visible to the user via translate(). +.IP +.TP +It provides some magical objects like the desktop() and the clipboard(). +.IP +.TP +It knows about the application's windows. You can ask which widget is at a certain position using widgetAt(), get a list of topLevelWidgets() and closeAllWindows(), etc. +.IP +.TP +It manages the application's mouse cursor handling, see setOverrideCursor() and setGlobalMouseTracking(). +.IP +.TP +On the X window system, it provides functions to flush and sync the communication stream, see flushX() and syncX(). +.IP +.TP +It provides support for sophisticated session management. This makes it possible for applications to terminate gracefully when the user logs out, to cancel a shutdown process if termination isn't possible and even to preserve the entire application's state for a future session. See isSessionRestored(), sessionId() and commitData() and saveState() for details. +.IP +.PP +The Application walk-through example contains a typical complete main() that does the usual things with QApplication. +.PP +Since the QApplication object does so much initialization, it \fBmust\fR be created before any other objects related to the user interface are created. +.PP +Since it also deals with common command line arguments, it is usually a good idea to create it \fIbefore\fR any interpretation or modification of \fCargv\fR is done in the application itself. (Note also that for X11, setMainWidget() may change the main widget according to the \fC-geometry\fR option. To preserve this functionality, you must set your defaults before setMainWidget() and any overrides after.) +.PP +<center>.nf +.TS +l - l. Groups of functions System settings desktopSettingsAware(), setDesktopSettingsAware(), cursorFlashTime(), setCursorFlashTime(), doubleClickInterval(), setDoubleClickInterval(), wheelScrollLines(), setWheelScrollLines(), palette(), setPalette(), font(), setFont(), fontMetrics(). Event handling exec(), processEvents(), enter_loop(), exit_loop(), exit(), quit(). sendEvent(), postEvent(), sendPostedEvents(), removePostedEvents(), hasPendingEvents(), notify(), macEventFilter(), qwsEventFilter(), x11EventFilter(), x11ProcessEvent(), winEventFilter(). GUI Styles style(), setStyle(), polish(). Color usage colorSpec(), setColorSpec(), qwsSetCustomColors(). Text handling installTranslator(), removeTranslator() translate(). Widgets mainWidget(), setMainWidget(), allWidgets(), topLevelWidgets(), desktop(), activePopupWidget(), activeModalWidget(), clipboard(), focusWidget(), winFocus(), activeWindow(), widgetAt(). Advanced cursor handling hasGlobalMouseTracking(), setGlobalMouseTracking(), overrideCursor(), setOverrideCursor(), restoreOverrideCursor(). X Window System synchronization flushX(), syncX(). Session management isSessionRestored(), sessionId(), commitData(), saveState(). Threading lock(), unlock(), locked(), tryLock(), wakeUpGuiThread() Miscellaneous +.TE +.fi +</center> +.PP +\fINon-GUI programs:\fR While Qt is not optimized or designed for writing non-GUI programs, it's possible to use some of its classes without creating a QApplication. This can be useful if you wish to share code between a non-GUI server and a GUI client. +.PP +See also Main Window and Related Classes. +.SS "Member Type Documentation" +.SH "QApplication::ColorSpec" +.TP +\fCQApplication::NormalColor\fR - the default color allocation policy +.TP +\fCQApplication::CustomColor\fR - the same as NormalColor for X11; allocates colors to a palette on demand under Windows +.TP +\fCQApplication::ManyColor\fR - the right choice for applications that use thousands of colors +.PP +See setColorSpec() for full details. +.SH "QApplication::Encoding" +This enum type defines the 8-bit encoding of character string arguments to translate(): +.TP +\fCQApplication::DefaultCodec\fR - the encoding specified by QTextCodec::codecForTr() (Latin-1 if none has been set) +.TP +\fCQApplication::UnicodeUTF8\fR - UTF-8 +.PP +See also QObject::tr(), QObject::trUtf8(), and QString::fromUtf8(). +.SH "QApplication::Type" +.TP +\fCQApplication::Tty\fR - a console application +.TP +\fCQApplication::GuiClient\fR - a GUI client application +.TP +\fCQApplication::GuiServer\fR - a GUI server application +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QApplication::QApplication ( int & argc, char ** argv )" +Initializes the window system and constructs an application object with \fIargc\fR command line arguments in \fIargv\fR. +.PP +The global \fCqApp\fR pointer refers to this application object. Only one application object should be created. +.PP +This application object must be constructed before any paint devices (including widgets, pixmaps, bitmaps etc.). +.PP +Note that \fIargc\fR and \fIargv\fR might be changed. Qt removes command line arguments that it recognizes. The modified \fIargc\fR and \fIargv\fR can also be accessed later with \fCqApp->argc()\fR and \fCqApp->argv()\fR. The documentation for argv() contains a detailed description of how to process command line arguments. +.PP +Qt debugging options (not available if Qt was compiled with the QT_NO_DEBUG flag defined): +.TP +-nograb, tells Qt that it must never grab the mouse or the keyboard. +.TP +-dograb (only under X11), running under a debugger can cause an implicit -nograb, use -dograb to override. +.TP +-sync (only under X11), switches to synchronous mode for debugging. +.PP +See Debugging Techniques for a more detailed explanation. +.PP +All Qt programs automatically support the following command line options: +.TP +-reverse causes text to be formatted for right-to-left languages rather than in the usual left-to-right direction. +.TP +-style= \fIstyle\fR, sets the application GUI style. Possible values are \fCmotif\fR, \fCwindows\fR, and \fCplatinum\fR. If you compiled Qt with additional styles or have additional styles as plugins these will be available to the \fC-style\fR command line option. +.TP +-style \fIstyle\fR, is the same as listed above. +.TP +-session= \fIsession\fR, restores the application from an earlier session. +.TP +-session \fIsession\fR, is the same as listed above. +.TP +-widgetcount, prints debug message at the end about number of widgets left undestroyed and maximum number of widgets existed at the same time +.PP +The X11 version of Qt also supports some traditional X11 command line options: +.TP +-display \fIdisplay\fR, sets the X display (default is $DISPLAY). +.TP +-geometry \fIgeometry\fR, sets the client geometry of the main widget. +.TP +-fn or \fC-font\fR \fIfont\fR, defines the application font. The font should be specified using an X logical font description. +.TP +-bg or \fC-background\fR \fIcolor\fR, sets the default background color and an application palette (light and dark shades are calculated). +.TP +-fg or \fC-foreground\fR \fIcolor\fR, sets the default foreground color. +.TP +-btn or \fC-button\fR \fIcolor\fR, sets the default button color. +.TP +-name \fIname\fR, sets the application name. +.TP +-title \fItitle\fR, sets the application title (caption). +.TP +-visual \fCTrueColor\fR, forces the application to use a TrueColor visual on an 8-bit display. +.TP +-ncols \fIcount\fR, limits the number of colors allocated in the color cube on an 8-bit display, if the application is using the QApplication::ManyColor color specification. If \fIcount\fR is 216 then a 6x6x6 color cube is used (i.e. 6 levels of red, 6 of green, and 6 of blue); for other values, a cube approximately proportional to a 2x3x1 cube is used. +.TP +-cmap, causes the application to install a private color map on an 8-bit display. +.PP +See also argc() and argv(). +.SH "QApplication::QApplication ( int & argc, char ** argv, bool GUIenabled )" +Constructs an application object with \fIargc\fR command line arguments in \fIargv\fR. If \fIGUIenabled\fR is TRUE, a GUI application is constructed, otherwise a non-GUI (console) application is created. +.PP +Set \fIGUIenabled\fR to FALSE for programs without a graphical user interface that should be able to run without a window system. +.PP +On X11, the window system is initialized if \fIGUIenabled\fR is TRUE. If \fIGUIenabled\fR is FALSE, the application does not connect to the X-server. On Windows and Macintosh, currently the window system is always initialized, regardless of the value of GUIenabled. This may change in future versions of Qt. +.PP +The following example shows how to create an application that uses a graphical interface when available. +.PP +.nf +.br + int main( int argc, char **argv ) +.br + { +.br +#ifdef Q_WS_X11 +.br + bool useGUI = getenv( "DISPLAY" ) != 0; +.br +#else +.br + bool useGUI = TRUE; +.br +#endif +.br + QApplication app(argc, argv, useGUI); +.br +.br + if ( useGUI ) { +.br + //start GUI version +.br + ... +.br + } else { +.br + //start non-GUI version +.br + ... +.br + } +.br + return app.exec(); +.br + } +.fi +.SH "QApplication::QApplication ( int & argc, char ** argv, Type type )" +Constructs an application object with \fIargc\fR command line arguments in \fIargv\fR. +.PP +For Qt/Embedded, passing QApplication::GuiServer for \fItype\fR makes this application the server (equivalent to running with the -qws option). +.SH "QApplication::QApplication ( Display * dpy, HANDLE visual = 0, HANDLE colormap = 0 )" +Create an application, given an already open display \fIdpy\fR. If \fIvisual\fR and \fIcolormap\fR are non-zero, the application will use those as the default Visual and Colormap contexts. +.PP +\fBWarning:\fR Qt only supports TrueColor visuals at depths higher than 8 bits-per-pixel. +.PP +This is available only on X11. +.SH "QApplication::QApplication ( Display * dpy, int argc, char ** argv, HANDLE visual = 0, HANDLE colormap = 0 )" +Create an application, given an already open display \fIdpy\fR and using \fIargc\fR command line arguments in \fIargv\fR. If \fIvisual\fR and \fIcolormap\fR are non-zero, the application will use those as the default Visual and Colormap contexts. +.PP +\fBWarning:\fR Qt only supports TrueColor visuals at depths higher than 8 bits-per-pixel. +.PP +This is available only on X11. +.SH "QApplication::~QApplication ()\fC [virtual]\fR" +Cleans up any window system resources that were allocated by this application. Sets the global variable \fCqApp\fR to 0. +.SH "void QApplication::aboutTQt ()\fC [slot]\fR" +Displays a simple message box about Qt. The message includes the version number of Qt being used by the application. +.PP +This is useful for inclusion in the Help menu of an application. See the examples/menu/menu.cpp example. +.PP +This function is a convenience slot for QMessageBox::aboutTQt(). +.SH "void QApplication::aboutToQuit ()\fC [signal]\fR" +This signal is emitted when the application is about to quit the main event loop, e.g. when the event loop level drops to zero. This may happen either after a call to quit() from inside the application or when the users shuts down the entire desktop session. +.PP +The signal is particularly useful if your application has to do some last-second cleanup. Note that no user interaction is possible in this state. +.PP +See also quit(). +.SH "QWidget * QApplication::activeModalWidget ()\fC [static]\fR" +Returns the active modal widget. +.PP +A modal widget is a special top level widget which is a subclass of QDialog that specifies the modal parameter of the constructor as TRUE. A modal widget must be closed before the user can continue with other parts of the program. +.PP +Modal widgets are organized in a stack. This function returns the active modal widget at the top of the stack. +.PP +See also activePopupWidget() and topLevelWidgets(). +.SH "QWidget * QApplication::activePopupWidget ()\fC [static]\fR" +Returns the active popup widget. +.PP +A popup widget is a special top level widget that sets the WType_Popup widget flag, e.g. the QPopupMenu widget. When the application opens a popup widget, all events are sent to the popup. Normal widgets and modal widgets cannot be accessed before the popup widget is closed. +.PP +Only other popup widgets may be opened when a popup widget is shown. The popup widgets are organized in a stack. This function returns the active popup widget at the top of the stack. +.PP +See also activeModalWidget() and topLevelWidgets(). +.SH "QWidget * QApplication::activeWindow () const" +Returns the application top-level window that has the keyboard input focus, or 0 if no application window has the focus. Note that there might be an activeWindow() even if there is no focusWidget(), for example if no widget in that window accepts key events. +.PP +See also QWidget::setFocus(), QWidget::focus, and focusWidget(). +.PP +Example: network/mail/smtp.cpp. +.SH "void QApplication::addLibraryPath ( const QString & path )\fC [static]\fR" +Append \fIpath\fR to the end of the library path list. If \fIpath\fR is empty or already in the path list, the path list is not changed. +.PP +The default path list consists of a single entry, the installation directory for plugins. The default installation directory for plugins is \fCINSTALL/plugins\fR, where \fCINSTALL\fR is the directory where Qt was installed. +.PP +See also removeLibraryPath(), libraryPaths(), and setLibraryPaths(). +.SH "QWidgetList * QApplication::allWidgets ()\fC [static]\fR" +Returns a list of all the widgets in the application. +.PP +The list is created using \fCnew\fR and must be deleted by the caller. +.PP +The list is empty (QPtrList::isEmpty()) if there are no widgets. +.PP +Note that some of the widgets may be hidden. +.PP +Example that updates all widgets: +.PP +.nf +.br + QWidgetList *list = QApplication::allWidgets(); +.br + QWidgetListIt it( *list ); // iterate over the widgets +.br + QWidget * w; +.br + while ( (w=it.current()) != 0 ) { // for each widget... +.br + ++it; +.br + w->update(); +.br + } +.br + delete list; // delete the list, not the widgets +.br +.fi +.PP +The QWidgetList class is defined in the \fCntqwidgetlist.h\fR header file. +.PP +\fBWarning:\fR Delete the list as soon as you have finished using it. The widgets in the list may be deleted by someone else at any time. +.PP +See also topLevelWidgets(), QWidget::visible, and QPtrList::isEmpty(). +.SH "QString QApplication::applicationDirPath ()" +Returns the directory that contains the application executable. +.PP +For example, if you have installed Qt in the \fCC:\Trolltech\Qt\fR directory, and you run the \fCdemo\fR example, this function will return "C:/Trolltech/Qt/examples/demo". +.PP +On Mac OS X this will point to the directory actually containing the executable, which may be inside of an application bundle (if the application is bundled). +.PP +\fBWarning:\fR On Unix, this function assumes that argv[0] contains the file name of the executable (which it normally does). It also assumes that the current directory hasn't been changed by the application. +.PP +See also applicationFilePath(). +.SH "QString QApplication::applicationFilePath ()" +Returns the file path of the application executable. +.PP +For example, if you have installed Qt in the \fCC:\Trolltech\Qt\fR directory, and you run the \fCdemo\fR example, this function will return "C:/Trolltech/Qt/examples/demo/demo.exe". +.PP +\fBWarning:\fR On Unix, this function assumes that argv[0] contains the file name of the executable (which it normally does). It also assumes that the current directory hasn't been changed by the application. +.PP +See also applicationDirPath(). +.SH "int QApplication::argc () const" +Returns the number of command line arguments. +.PP +The documentation for argv() describes how to process command line arguments. +.PP +See also argv() and QApplication::QApplication(). +.PP +Examples: +.)l chart/main.cpp and scribble/scribble.cpp. +.SH "char ** QApplication::argv () const" +Returns the command line argument vector. +.PP +\fCargv()[0]\fR is the program name, \fCargv()[1]\fR is the first argument and \fCargv()[argc()-1]\fR is the last argument. +.PP +A QApplication object is constructed by passing \fIargc\fR and \fIargv\fR from the \fCmain()\fR function. Some of the arguments may be recognized as Qt options and removed from the argument vector. For example, the X11 version of Qt knows about \fC-display\fR, \fC-font\fR and a few more options. +.PP +Example: +.PP +.nf +.br + // showargs.cpp - displays program arguments in a list box +.br +.br + #include <ntqapplication.h> +.br + #include <ntqlistbox.h> +.br +.br + int main( int argc, char **argv ) +.br + { +.br + QApplication a( argc, argv ); +.br + QListBox b; +.br + a.setMainWidget( &b ); +.br + for ( int i = 0; i < a.argc(); i++ ) // a.argc() == argc +.br + b.insertItem( a.argv()[i] ); // a.argv()[i] == argv[i] +.br + b.show(); +.br + return a.exec(); +.br + } +.br +.fi +.PP +If you run \fCshowargs -display unix:0 -font 9x15bold hello world\fR under X11, the list box contains the three strings "showargs"," hello" and "world". +.PP +Qt provides a global pointer, \fCqApp\fR, that points to the QApplication object, and through which you can access argc() and argv() in functions other than main(). +.PP +See also argc() and QApplication::QApplication(). +.PP +Examples: +.)l chart/main.cpp and scribble/scribble.cpp. +.SH "void QApplication::beep ()\fC [static]\fR" +Sounds the bell, using the default volume and sound. +.SH "QClipboard * QApplication::clipboard ()\fC [static]\fR" +Returns a pointer to the application global clipboard. +.PP +Examples: +.)l regexptester/regexptester.cpp and showimg/showimg.cpp. +.SH "void QApplication::closeAllWindows ()\fC [slot]\fR" +Closes all top-level windows. +.PP +This function is particularly useful for applications with many top-level windows. It could, for example, be connected to a "Quit" entry in the file menu as shown in the following code example: +.PP +.nf +.br + // the "Quit" menu entry should try to close all windows +.br + QPopupMenu* file = new QPopupMenu( this ); +.br + file->insertItem( "&Quit", tqApp, SLOT(closeAllWindows()), CTRL+Key_Q ); +.br +.br + // when the last window is closed, the application should quit +.br + connect( tqApp, SIGNAL( lastWindowClosed() ), tqApp, SLOT( quit() ) ); +.br +.fi +.PP +The windows are closed in random order, until one window does not accept the close event. +.PP +See also QWidget::close(), QWidget::closeEvent(), lastWindowClosed(), quit(), topLevelWidgets(), and QWidget::isTopLevel. +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. +.SH "bool QApplication::closingDown ()\fC [static]\fR" +Returns TRUE if the application objects are being destroyed; otherwise returns FALSE. +.PP +See also startingUp(). +.SH "int QApplication::colorSpec ()\fC [static]\fR" +Returns the color specification. +.PP +See also QApplication::setColorSpec(). +.PP +Example: showimg/showimg.cpp. +.SH "void QApplication::commitData ( QSessionManager & sm )\fC [virtual]\fR" +This function deals with session management. It is invoked when the QSessionManager wants the application to commit all its data. +.PP +Usually this means saving all open files, after getting permission from the user. Furthermore you may want to provide a means by which the user can cancel the shutdown. +.PP +Note that you should not exit the application within this function. Instead, the session manager may or may not do this afterwards, depending on the context. +.PP +\fBWarning:\fR Within this function, no user interaction is possible, \fIunless\fR you ask the session manager \fIsm\fR for explicit permission. See QSessionManager::allowsInteraction() and QSessionManager::allowsErrorInteraction() for details and example usage. +.PP +The default implementation requests interaction and sends a close event to all visible top level widgets. If any event was rejected, the shutdown is canceled. +.PP +See also isSessionRestored(), sessionId(), saveState(), and the Session Management overview. +.SH "int QApplication::cursorFlashTime ()\fC [static]\fR" +Returns the text cursor's flash (blink) time in milliseconds. The flash time is the time required to display, invert and restore the caret display. +.PP +The default value on X11 is 1000 milliseconds. On Windows, the control panel value is used. +.PP +Widgets should not cache this value since it may be changed at any time by the user changing the global desktop settings. +.PP +See also setCursorFlashTime(). +.SH "QTextCodec * QApplication::defaultCodec () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns QTextCodec::codecForTr(). +.SH "QDesktopWidget * QApplication::desktop ()\fC [static]\fR" +Returns the desktop widget (also called the root window). +.PP +The desktop widget is useful for obtaining the size of the screen. It may also be possible to draw on the desktop. We recommend against assuming that it's possible to draw on the desktop, since this does not work on all operating systems. +.PP +.nf +.br + QDesktopWidget *d = QApplication::desktop(); +.br + int w = d->width(); // returns desktop width +.br + int h = d->height(); // returns desktop height +.br +.fi +.PP +Examples: +.)l canvas/main.cpp, desktop/desktop.cpp, helpviewer/main.cpp, i18n/main.cpp, qmag/qmag.cpp, qwerty/main.cpp, and scribble/main.cpp. +.SH "bool QApplication::desktopSettingsAware ()\fC [static]\fR" +Returns the value set by setDesktopSettingsAware(); by default TRUE. +.PP +See also setDesktopSettingsAware(). +.SH "int QApplication::doubleClickInterval ()\fC [static]\fR" +Returns the maximum duration for a double click. +.PP +The default value on X11 is 400 milliseconds. On Windows, the control panel value is used. +.PP +See also setDoubleClickInterval(). +.SH "int QApplication::enter_loop ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function enters the main event loop (recursively). Do not call it unless you really know what you are doing. +.PP +Use QApplication::eventLoop()->enterLoop() instead. +.SH "QEventLoop * QApplication::eventLoop ()\fC [static]\fR" +Returns the application event loop. This function will return zero if called during and after destroying QApplication. +.PP +To create your own instance of QEventLoop or QEventLoop subclass create it before you create the QApplication object. +.PP +See also QEventLoop. +.PP +Example: distributor/distributor.ui.h. +.SH "int QApplication::exec ()" +Enters the main event loop and waits until exit() is called or the main widget is destroyed, and returns the value that was set to exit() (which is 0 if exit() is called via quit()). +.PP +It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets. +.PP +Generally speaking, no user interaction can take place before calling exec(). As a special case, modal widgets like QMessageBox can be used before calling exec(), because modal widgets call exec() to start a local event loop. +.PP +To make your application perform idle processing, i.e. executing a special function whenever there are no pending events, use a QTimer with 0 timeout. More advanced idle processing schemes can be achieved using processEvents(). +.PP +See also quit(), exit(), processEvents(), and setMainWidget(). +.PP +Examples: +.)l helpsystem/main.cpp, life/main.cpp, network/archivesearch/main.cpp, network/ftpclient/main.cpp, opengl/main.cpp, t1/main.cpp, and t4/main.cpp. +.SH "void QApplication::exit ( int retcode = 0 )\fC [static]\fR" +Tells the application to exit with a return code. +.PP +After this function has been called, the application leaves the main event loop and returns from the call to exec(). The exec() function returns \fIretcode\fR. +.PP +By convention, a \fIretcode\fR of 0 means success, and any non-zero value indicates an error. +.PP +Note that unlike the C library function of the same name, this function \fIdoes\fR return to the caller -- it is event processing that stops. +.PP +See also quit() and exec(). +.PP +Examples: +.)l chart/chartform.cpp, extension/mainform.ui.h, and picture/picture.cpp. +.SH "void QApplication::exit_loop ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function exits from a recursive call to the main event loop. Do not call it unless you are an expert. +.PP +Use QApplication::eventLoop()->exitLoop() instead. +.SH "void QApplication::flush ()\fC [static]\fR" +Flushes the window system specific event queues. +.PP +If you are doing graphical changes inside a loop that does not return to the event loop on asynchronous window systems like X11 or double buffered window systems like MacOS X, and you want to visualize these changes immediately (e.g. Splash Screens), call this function. +.PP +See also flushX(), sendPostedEvents(), and QPainter::flush(). +.SH "void QApplication::flushX ()\fC [static]\fR" +Flushes the X event queue in the X11 implementation. This normally returns almost immediately. Does nothing on other platforms. +.PP +See also syncX(). +.PP +Example: xform/xform.cpp. +.SH "QWidget * QApplication::focusWidget () const" +Returns the application widget that has the keyboard input focus, or 0 if no widget in this application has the focus. +.PP +See also QWidget::setFocus(), QWidget::focus, and activeWindow(). +.SH "QFont QApplication::font ( const QWidget * w = 0 )\fC [static]\fR" +Returns the default font for the widget \fIw\fR, or the default application font if \fIw\fR is 0. +.PP +See also setFont(), fontMetrics(), and QWidget::font. +.PP +Examples: +.)l qfd/fontdisplayer.cpp, themes/metal.cpp, and themes/themes.cpp. +.SH "QFontMetrics QApplication::fontMetrics ()\fC [static]\fR" +Returns display (screen) font metrics for the application font. +.PP +See also font(), setFont(), QWidget::fontMetrics(), and QPainter::fontMetrics(). +.SH "QSize QApplication::globalStrut ()\fC [static]\fR" +Returns the application's global strut. +.PP +The strut is a size object whose dimensions are the minimum that any GUI element that the user can interact with should have. For example no button should be resized to be smaller than the global strut size. +.PP +See also setGlobalStrut(). +.SH "void QApplication::guiThreadAwake ()\fC [signal]\fR" +This signal is emitted after the event loop returns from a function that could block. +.PP +See also wakeUpGuiThread(). +.SH "bool QApplication::hasGlobalMouseTracking ()\fC [static]\fR" +Returns TRUE if global mouse tracking is enabled; otherwise returns FALSE. +.PP +See also setGlobalMouseTracking(). +.SH "bool QApplication::hasPendingEvents ()" +This function returns TRUE if there are pending events; otherwise returns FALSE. Pending events can be either from the window system or posted events using QApplication::postEvent(). +.SH "int QApplication::horizontalAlignment ( int align )\fC [static]\fR" +Strips out vertical alignment flags and transforms an alignment \fIalign\fR of AlignAuto into AlignLeft or AlignRight according to the language used. The other horizontal alignment flags are left untouched. +.SH "void QApplication::installTranslator ( QTranslator * mf )" +Adds the message file \fImf\fR to the list of message files to be used for translations. +.PP +Multiple message files can be installed. Translations are searched for in the last installed message file, then the one from last, and so on, back to the first installed message file. The search stops as soon as a matching translation is found. +.PP +See also removeTranslator(), translate(), and QTranslator::load(). +.PP +Example: i18n/main.cpp. +.SH "bool QApplication::isEffectEnabled ( Qt::UIEffect effect )\fC [static]\fR" +Returns TRUE if \fIeffect\fR is enabled; otherwise returns FALSE. +.PP +By default, Qt will try to use the desktop settings. Call setDesktopSettingsAware(FALSE) to prevent this. +.PP +Note: All effects are disabled on screens running at less than 16-bit color depth. +.PP +See also setEffectEnabled() and Qt::UIEffect. +.SH "bool QApplication::isSessionRestored () const" +Returns TRUE if the application has been restored from an earlier session; otherwise returns FALSE. +.PP +See also sessionId(), commitData(), and saveState(). +.SH "void QApplication::lastWindowClosed ()\fC [signal]\fR" +This signal is emitted when the user has closed the last top level window. +.PP +The signal is very useful when your application has many top level widgets but no main widget. You can then connect it to the quit() slot. +.PP +For convenience, this signal is \fInot\fR emitted for transient top level widgets such as popup menus and dialogs. +.PP +See also mainWidget(), topLevelWidgets(), QWidget::isTopLevel, and QWidget::close(). +.PP +Examples: +.)l addressbook/main.cpp, extension/main.cpp, helpviewer/main.cpp, mdi/main.cpp, network/archivesearch/main.cpp, qwerty/main.cpp, and regexptester/main.cpp. +.SH "QStringList QApplication::libraryPaths ()\fC [static]\fR" +Returns a list of paths that the application will search when dynamically loading libraries. The installation directory for plugins is the only entry if no paths have been set. The default installation directory for plugins is \fCINSTALL/plugins\fR, where \fCINSTALL\fR is the directory where Qt was installed. The directory of the application executable (NOT the working directory) is also added to the plugin paths. +.PP +If you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = app.libraryPaths(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See the plugins documentation for a description of how the library paths are used. +.PP +See also setLibraryPaths(), addLibraryPath(), removeLibraryPath(), and QLibrary. +.SH "void QApplication::lock ()" +Lock the Qt Library Mutex. If another thread has already locked the mutex, the calling thread will block until the other thread has unlocked the mutex. +.PP +See also unlock(), locked(), and Thread Support in Qt. +.SH "bool QApplication::locked ()" +Returns TRUE if the Qt Library Mutex is locked by a different thread; otherwise returns FALSE. +.PP +\fBWarning:\fR Due to different implementations of recursive mutexes on the supported platforms, calling this function from the same thread that previously locked the mutex will give undefined results. +.PP +See also lock(), unlock(), and Thread Support in Qt. +.SH "int QApplication::loopLevel () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the current loop level. +.PP +Use QApplication::eventLoop()->loopLevel() instead. +.SH "bool QApplication::macEventFilter ( EventHandlerCallRef, EventRef )\fC [virtual]\fR" +This virtual function is only implemented under Macintosh. +.PP +If you create an application that inherits QApplication and reimplement this function, you get direct access to all Carbon Events that are received from the MacOS. +.PP +Return TRUE if you want to stop the event from being processed. Return FALSE for normal event dispatching. +.SH "QWidget * QApplication::mainWidget () const" +Returns the main application widget, or 0 if there is no main widget. +.PP +See also setMainWidget(). +.SH "bool QApplication::notify ( QObject * receiver, QEvent * e )\fC [virtual]\fR" +Sends event \fIe\fR to \fIreceiver\fR: \fIreceiver\fR->event(\fIe\fR). Returns the value that is returned from the receiver's event handler. +.PP +For certain types of events (e.g. mouse and key events), the event will be propagated to the receiver's parent and so on up to the top-level object if the receiver is not interested in the event (i.e., it returns FALSE). +.PP +There are five different ways that events can be processed; reimplementing this virtual function is just one of them. All five approaches are listed below: <ol type=1> +.TP +Reimplementing this function. This is very powerful, providing complete control; but only one subclass can be tqApp. +.IP +.TP +Installing an event filter on tqApp. Such an event filter is able to process all events for all widgets, so it's just as powerful as reimplementing notify(); furthermore, it's possible to have more than one application-global event filter. Global event filters even see mouse events for disabled widgets, and if global mouse tracking is enabled, as well as mouse move events for all widgets. +.IP +.TP +Reimplementing QObject::event() (as QWidget does). If you do this you get Tab key presses, and you get to see the events before any widget-specific event filters. +.IP +.TP +Installing an event filter on the object. Such an event filter gets all the events except Tab and Shift-Tab key presses. +.IP +.TP +Reimplementing paintEvent(), mousePressEvent() and so on. This is the commonest, easiest and least powerful way. +.PP +See also QObject::event() and installEventFilter(). +.SH "QCursor * QApplication::overrideCursor ()\fC [static]\fR" +Returns the active application override cursor. +.PP +This function returns 0 if no application cursor has been defined (i.e. the internal cursor stack is empty). +.PP +See also setOverrideCursor() and restoreOverrideCursor(). +.SH "QPalette QApplication::palette ( const QWidget * w = 0 )\fC [static]\fR" +Returns the application palette. +.PP +If a widget is passed in \fIw\fR, the default palette for the widget's class is returned. This may or may not be the application palette. In most cases there isn't a special palette for certain types of widgets, but one notable exception is the popup menu under Windows, if the user has defined a special background color for menus in the display settings. +.PP +See also setPalette() and QWidget::palette. +.PP +Examples: +.)l desktop/desktop.cpp, themes/metal.cpp, and themes/wood.cpp. +.SH "void QApplication::polish ( QWidget * w )\fC [virtual]\fR" +Initialization of the appearance of the widget \fIw\fR \fIbefore\fR it is first shown. +.PP +Usually widgets call this automatically when they are polished. It may be used to do some style-based central customization of widgets. +.PP +Note that you are not limited to the public functions of QWidget. Instead, based on meta information like QObject::className() you are able to customize any kind of widget. +.PP +See also QStyle::polish(), QWidget::polish(), setPalette(), and setFont(). +.SH "void QApplication::postEvent ( QObject * receiver, QEvent * event )\fC [static]\fR" +\fBNote:\fR This function is thread-safe when Qt is built withthread support.</p> Adds the event \fIevent\fR with the object \fIreceiver\fR as the receiver of the event, to an event queue and returns immediately. +.PP +The event must be allocated on the heap since the post event queue will take ownership of the event and delete it once it has been posted. +.PP +When control returns to the main event loop, all events that are stored in the queue will be sent using the notify() function. +.PP +See also sendEvent() and notify(). +.SH "void QApplication::processEvents ()" +Processes pending events, for 3 seconds or until there are no more events to process, whichever is shorter. +.PP +You can call this function occasionally when your program is busy performing a long operation (e.g. copying a file). +.PP +See also exec(), QTimer, and QEventLoop::processEvents(). +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and network/ftpclient/main.cpp. +.SH "void QApplication::processEvents ( int maxtime )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Processes pending events for \fImaxtime\fR milliseconds or until there are no more events to process, whichever is shorter. +.PP +You can call this function occasionally when you program is busy doing a long operation (e.g. copying a file). +.PP +See also exec(), QTimer, and QEventLoop::processEvents(). +.SH "void QApplication::processOneEvent ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Waits for an event to occur, processes it, then returns. +.PP +This function is useful for adapting Qt to situations where the event processing must be grafted onto existing program loops. +.PP +Using this function in new applications may be an indication of design problems. +.PP +See also processEvents(), exec(), and QTimer. +.SH "void QApplication::quit ()\fC [slot]\fR" +Tells the application to exit with return code 0 (success). Equivalent to calling QApplication::exit( 0 ). +.PP +It's common to connect the lastWindowClosed() signal to quit(), and you also often connect e.g. QButton::clicked() or signals in QAction, QPopupMenu or QMenuBar to it. +.PP +Example: +.PP +.nf +.br + QPushButton *quitButton = new QPushButton( "Quit" ); +.br + connect( quitButton, SIGNAL(clicked()), tqApp, SLOT(quit()) ); +.br +.fi +.PP +See also exit(), aboutToQuit(), lastWindowClosed(), and QAction. +.PP +Examples: +.)l addressbook/main.cpp, mdi/main.cpp, network/archivesearch/main.cpp, regexptester/main.cpp, t2/main.cpp, t4/main.cpp, and t6/main.cpp. +.SH "QWSDecoration & QApplication::qwsDecoration ()\fC [static]\fR" +Return the QWSDecoration used for decorating windows. +.PP +This method is non-portable. It is available \fIonly\fR in Qt/Embedded. +.PP +See also QWSDecoration. +.SH "bool QApplication::qwsEventFilter ( QWSEvent * )\fC [virtual]\fR" +This virtual function is only implemented under Qt/Embedded. +.PP +If you create an application that inherits QApplication and reimplement this function, you get direct access to all QWS (Q Window System) events that the are received from the QWS master process. +.PP +Return TRUE if you want to stop the event from being processed. Return FALSE for normal event dispatching. +.SH "void QApplication::qwsSetCustomColors ( QRgb * colorTable, int start, int numColors )" +Set Qt/Embedded custom color table. +.PP +Qt/Embedded on 8-bpp displays allocates a standard 216 color cube. The remaining 40 colors may be used by setting a custom color table in the QWS master process before any clients connect. +.PP +\fIcolorTable\fR is an array of up to 40 custom colors. \fIstart\fR is the starting index (0-39) and \fInumColors\fR is the number of colors to be set (1-40). +.PP +This method is non-portable. It is available \fIonly\fR in Qt/Embedded. +.SH "void QApplication::qwsSetDecoration ( QWSDecoration * d )\fC [static]\fR" +Set the QWSDecoration derived class to use for decorating the Qt/Embedded windows to \fId\fR. +.PP +This method is non-portable. It is available \fIonly\fR in Qt/Embedded. +.PP +See also QWSDecoration. +.SH "void QApplication::removeLibraryPath ( const QString & path )\fC [static]\fR" +Removes \fIpath\fR from the library path list. If \fIpath\fR is empty or not in the path list, the list is not changed. +.PP +See also addLibraryPath(), libraryPaths(), and setLibraryPaths(). +.SH "void QApplication::removePostedEvents ( QObject * receiver )\fC [static]\fR" +\fBNote:\fR This function is thread-safe when Qt is built withthread support.</p> Removes all events posted using postEvent() for \fIreceiver\fR. +.PP +The events are \fInot\fR dispatched, instead they are removed from the queue. You should never need to call this function. If you do call it, be aware that killing events may cause \fIreceiver\fR to break one or more invariants. +.SH "void QApplication::removeTranslator ( QTranslator * mf )" +Removes the message file \fImf\fR from the list of message files used by this application. (It does not delete the message file from the file system.) +.PP +See also installTranslator(), translate(), and QObject::tr(). +.PP +Example: i18n/main.cpp. +.SH "void QApplication::restoreOverrideCursor ()\fC [static]\fR" +Undoes the last setOverrideCursor(). +.PP +If setOverrideCursor() has been called twice, calling restoreOverrideCursor() will activate the first cursor set. Calling this function a second time restores the original widgets' cursors. +.PP +See also setOverrideCursor() and overrideCursor(). +.PP +Examples: +.)l distributor/distributor.ui.h, network/archivesearch/archivedialog.ui.h, network/ftpclient/ftpmainwindow.ui.h, and showimg/showimg.cpp. +.SH "bool QApplication::reverseLayout ()\fC [static]\fR" +Returns TRUE if all dialogs and widgets will be laid out in a mirrored (right to left) fashion. Returns FALSE if dialogs and widgets will be laid out left to right. +.PP +See also setReverseLayout(). +.SH "void QApplication::saveState ( QSessionManager & sm )\fC [virtual]\fR" +This function deals with session management. It is invoked when the session manager wants the application to preserve its state for a future session. +.PP +For example, a text editor would create a temporary file that includes the current contents of its edit buffers, the location of the cursor and other aspects of the current editing session. +.PP +Note that you should never exit the application within this function. Instead, the session manager may or may not do this afterwards, depending on the context. Futhermore, most session managers will very likely request a saved state immediately after the application has been started. This permits the session manager to learn about the application's restart policy. +.PP +\fBWarning:\fR Within this function, no user interaction is possible, \fIunless\fR you ask the session manager \fIsm\fR for explicit permission. See QSessionManager::allowsInteraction() and QSessionManager::allowsErrorInteraction() for details. +.PP +See also isSessionRestored(), sessionId(), commitData(), and the Session Management overview. +.SH "bool QApplication::sendEvent ( QObject * receiver, QEvent * event )\fC [static]\fR" +Sends event \fIevent\fR directly to receiver \fIreceiver\fR, using the notify() function. Returns the value that was returned from the event handler. +.PP +The event is \fInot\fR deleted when the event has been sent. The normal approach is to create the event on the stack, e.g. +.PP +.nf +.br + QMouseEvent me( QEvent::MouseButtonPress, pos, 0, 0 ); +.br + QApplication::sendEvent( mainWindow, &me ); +.br +.fi +If you create the event on the heap you must delete it. +.PP +See also postEvent() and notify(). +.PP +Example: popup/popup.cpp. +.SH "void QApplication::sendPostedEvents ( QObject * receiver, int event_type )\fC [static]\fR" +Immediately dispatches all events which have been previously queued with QApplication::postEvent() and which are for the object \fIreceiver\fR and have the event type \fIevent_type\fR. +.PP +Note that events from the window system are \fInot\fR dispatched by this function, but by processEvents(). +.PP +If \fIreceiver\fR is null, the events of \fIevent_type\fR are sent for all objects. If \fIevent_type\fR is 0, all the events are sent for \fIreceiver\fR. +.SH "void QApplication::sendPostedEvents ()\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Dispatches all posted events, i.e. empties the event queue. +.SH "QString QApplication::sessionId () const" +Returns the current session's identifier. +.PP +If the application has been restored from an earlier session, this identifier is the same as it was in that previous session. +.PP +The session identifier is guaranteed to be unique both for different applications and for different instances of the same application. +.PP +See also isSessionRestored(), sessionKey(), commitData(), and saveState(). +.SH "QString QApplication::sessionKey () const" +Returns the session key in the current session. +.PP +If the application has been restored from an earlier session, this key is the same as it was when the previous session ended. +.PP +The session key changes with every call of commitData() or saveState(). +.PP +See also isSessionRestored(), sessionId(), commitData(), and saveState(). +.SH "void QApplication::setColorSpec ( int spec )\fC [static]\fR" +Sets the color specification for the application to \fIspec\fR. +.PP +The color specification controls how the application allocates colors when run on a display with a limited amount of colors, e.g. 8 bit / 256 color displays. +.PP +The color specification must be set before you create the QApplication object. +.PP +The options are: +.TP +QApplication::NormalColor. This is the default color allocation strategy. Use this option if your application uses buttons, menus, texts and pixmaps with few colors. With this option, the application uses system global colors. This works fine for most applications under X11, but on Windows machines it may cause dithering of non-standard colors. +.TP +QApplication::CustomColor. Use this option if your application needs a small number of custom colors. On X11, this option is the same as NormalColor. On Windows, Qt creates a Windows palette, and allocates colors to it on demand. +.TP +QApplication::ManyColor. Use this option if your application is very color hungry (e.g. it requires thousands of colors). Under X11 the effect is: +.TP +For 256-color displays which have at best a 256 color true color visual, the default visual is used, and colors are allocated from a color cube. The color cube is the 6x6x6 (216 color) "Web palette"<sup>*</sup>, but the number of colors can be changed by the \fI-ncols\fR option. The user can force the application to use the true color visual with the -visual option. +.TP +For 256-color displays which have a true color visual with more than 256 colors, use that visual. Silicon Graphics X servers have this feature, for example. They provide an 8 bit visual by default but can deliver true color when asked. On Windows, Qt creates a Windows palette, and fills it with a color cube. +.PP +Be aware that the CustomColor and ManyColor choices may lead to colormap flashing: The foreground application gets (most) of the available colors, while the background windows will look less attractive. +.PP +Example: +.PP +.nf +.br + int main( int argc, char **argv ) +.br + { +.br + QApplication::setColorSpec( QApplication::ManyColor ); +.br + QApplication a( argc, argv ); +.br + ... +.br + } +.br +.fi +.PP +QColor provides more functionality for controlling color allocation and freeing up certain colors. See QColor::enterAllocContext() for more information. +.PP +To check what mode you end up with, call QColor::numBitPlanes() once the QApplication object exists. A value greater than 8 (typically 16, 24 or 32) means true color. +.PP +<sup>*</sup> The color cube used by Qt has 216 colors whose red, green, and blue components always have one of the following values: 0x00, 0x33, 0x66, 0x99, 0xCC, or 0xFF. +.PP +See also colorSpec(), QColor::numBitPlanes(), and QColor::enterAllocContext(). +.PP +Examples: +.)l helpviewer/main.cpp, opengl/main.cpp, showimg/main.cpp, t9/main.cpp, tetrax/tetrax.cpp, tetrix/tetrix.cpp, and themes/main.cpp. +.SH "void QApplication::setCursorFlashTime ( int msecs )\fC [static]\fR" +Sets the text cursor's flash (blink) time to \fImsecs\fR milliseconds. The flash time is the time required to display, invert and restore the caret display. Usually the text cursor is displayed for \fImsecs/2\fR milliseconds, then hidden for \fImsecs/2\fR milliseconds, but this may vary. +.PP +Note that on Microsoft Windows, calling this function sets the cursor flash time for all windows. +.PP +See also cursorFlashTime(). +.SH "void QApplication::setDefaultCodec ( QTextCodec * codec )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is the same as QTextCodec::setCodecForTr(). +.SH "void QApplication::setDesktopSettingsAware ( bool on )\fC [static]\fR" +By default, Qt will try to use the current standard colors, fonts etc., from the underlying window system's desktop settings, and use them for all relevant widgets. This behavior can be switched off by calling this function with \fIon\fR set to FALSE. +.PP +This static function must be called before creating the QApplication object, like this: +.PP +.nf +.br + int main( int argc, char** argv ) { +.br + QApplication::setDesktopSettingsAware( FALSE ); // I know better than the user +.br + QApplication myApp( argc, argv ); // Use default fonts & colors +.br + ... +.br + } +.br +.fi +.PP +See also desktopSettingsAware(). +.SH "void QApplication::setDoubleClickInterval ( int ms )\fC [static]\fR" +Sets the time limit that distinguishes a double click from two consecutive mouse clicks to \fIms\fR milliseconds. +.PP +Note that on Microsoft Windows, calling this function sets the double click interval for all windows. +.PP +See also doubleClickInterval(). +.SH "void QApplication::setEffectEnabled ( Qt::UIEffect effect, bool enable = TRUE )\fC [static]\fR" +Enables the UI effect \fIeffect\fR if \fIenable\fR is TRUE, otherwise the effect will not be used. +.PP +Note: All effects are disabled on screens running at less than 16-bit color depth. +.PP +See also isEffectEnabled(), Qt::UIEffect, and setDesktopSettingsAware(). +.SH "void QApplication::setFont ( const QFont & font, bool informWidgets = FALSE, const char * className = 0 )\fC [static]\fR" +Changes the default application font to \fIfont\fR. If \fIinformWidgets\fR is TRUE, then existing widgets are informed about the change and may adjust themselves to the new application setting. If \fIinformWidgets\fR is FALSE, the change only affects newly created widgets. If \fIclassName\fR is passed, the change applies only to classes that inherit \fIclassName\fR (as reported by QObject::inherits()). +.PP +On application start-up, the default font depends on the window system. It can vary depending on both the window system version and the locale. This function lets you override the default font; but overriding may be a bad idea because, for example, some locales need extra-large fonts to support their special characters. +.PP +See also font(), fontMetrics(), and QWidget::font. +.PP +Examples: +.)l desktop/desktop.cpp, themes/metal.cpp, and themes/themes.cpp. +.SH "void QApplication::setGlobalMouseTracking ( bool enable )\fC [static]\fR" +Enables global mouse tracking if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. +.PP +Enabling global mouse tracking makes it possible for widget event filters or application event filters to get all mouse move events, even when no button is depressed. This is useful for special GUI elements, e.g. tooltips. +.PP +Global mouse tracking does not affect widgets and their mouseMoveEvent(). For a widget to get mouse move events when no button is depressed, it must do QWidget::setMouseTracking(TRUE). +.PP +This function uses an internal counter. Each setGlobalMouseTracking(TRUE) must have a corresponding setGlobalMouseTracking(FALSE): +.PP +.nf +.br + // at this point global mouse tracking is off +.br + QApplication::setGlobalMouseTracking( TRUE ); +.br + QApplication::setGlobalMouseTracking( TRUE ); +.br + QApplication::setGlobalMouseTracking( FALSE ); +.br + // at this point it's still on +.br + QApplication::setGlobalMouseTracking( FALSE ); +.br + // but now it's off +.br +.fi +.PP +See also hasGlobalMouseTracking() and QWidget::mouseTracking. +.SH "void QApplication::setGlobalStrut ( const QSize & strut )\fC [static]\fR" +Sets the application's global strut to \fIstrut\fR. +.PP +The strut is a size object whose dimensions are the minimum that any GUI element that the user can interact with should have. For example no button should be resized to be smaller than the global strut size. +.PP +The strut size should be considered when reimplementing GUI controls that may be used on touch-screens or similar IO-devices. +.PP +Example: +.PP +.nf +.br + QSize& WidgetClass::sizeHint() const +.br + { +.br + return QSize( 80, 25 ).expandedTo( QApplication::globalStrut() ); +.br + } +.br +.fi +.PP +See also globalStrut(). +.SH "void QApplication::setLibraryPaths ( const QStringList & paths )\fC [static]\fR" +Sets the list of directories to search when loading libraries to \fIpaths\fR. All existing paths will be deleted and the path list will consist of the paths given in \fIpaths\fR. +.PP +See also libraryPaths(), addLibraryPath(), removeLibraryPath(), and QLibrary. +.SH "void QApplication::setMainWidget ( QWidget * mainWidget )\fC [virtual]\fR" +Sets the application's main widget to \fImainWidget\fR. +.PP +In most respects the main widget is like any other widget, except that if it is closed, the application exits. Note that QApplication does \fInot\fR take ownership of the \fImainWidget\fR, so if you create your main widget on the heap you must delete it yourself. +.PP +You need not have a main widget; connecting lastWindowClosed() to quit() is an alternative. +.PP +For X11, this function also resizes and moves the main widget according to the \fI-geometry\fR command-line option, so you should set the default geometry (using QWidget::setGeometry()) before calling setMainWidget(). +.PP +See also mainWidget(), exec(), and quit(). +.PP +Examples: +.)l chart/main.cpp, helpsystem/main.cpp, life/main.cpp, network/ftpclient/main.cpp, opengl/main.cpp, t1/main.cpp, and t4/main.cpp. +.SH "void QApplication::setOverrideCursor ( const QCursor & cursor, bool replace = FALSE )\fC [static]\fR" +Sets the application override cursor to \fIcursor\fR. +.PP +Application override cursors are intended for showing the user that the application is in a special state, for example during an operation that might take some time. +.PP +This cursor will be displayed in all the application's widgets until restoreOverrideCursor() or another setOverrideCursor() is called. +.PP +Application cursors are stored on an internal stack. setOverrideCursor() pushes the cursor onto the stack, and restoreOverrideCursor() pops the active cursor off the stack. Every setOverrideCursor() must eventually be followed by a corresponding restoreOverrideCursor(), otherwise the stack will never be emptied. +.PP +If \fIreplace\fR is TRUE, the new cursor will replace the last override cursor (the stack keeps its depth). If \fIreplace\fR is FALSE, the new stack is pushed onto the top of the stack. +.PP +Example: +.PP +.nf +.br + QApplication::setOverrideCursor( QCursor(Qt::WaitCursor) ); +.br + calculateHugeMandelbrot(); // lunch time... +.br + QApplication::restoreOverrideCursor(); +.br +.fi +.PP +See also overrideCursor(), restoreOverrideCursor(), and QWidget::cursor. +.PP +Examples: +.)l distributor/distributor.ui.h, network/archivesearch/archivedialog.ui.h, network/ftpclient/ftpmainwindow.ui.h, and showimg/showimg.cpp. +.SH "void QApplication::setPalette ( const QPalette & palette, bool informWidgets = FALSE, const char * className = 0 )\fC [static]\fR" +Changes the default application palette to \fIpalette\fR. If \fIinformWidgets\fR is TRUE, then existing widgets are informed about the change and may adjust themselves to the new application setting. If \fIinformWidgets\fR is FALSE, the change only affects newly created widgets. +.PP +If \fIclassName\fR is passed, the change applies only to widgets that inherit \fIclassName\fR (as reported by QObject::inherits()). If \fIclassName\fR is left 0, the change affects all widgets, thus overriding any previously set class specific palettes. +.PP +The palette may be changed according to the current GUI style in QStyle::polish(). +.PP +See also QWidget::palette, palette(), and QStyle::polish(). +.PP +Examples: +.)l i18n/main.cpp, themes/metal.cpp, themes/themes.cpp, and themes/wood.cpp. +.SH "void QApplication::setReverseLayout ( bool b )\fC [static]\fR" +If \fIb\fR is TRUE, all dialogs and widgets will be laid out in a mirrored fashion, as required by right to left languages such as Arabic and Hebrew. If \fIb\fR is FALSE, dialogs and widgets are laid out left to right. +.PP +Changing this flag in runtime does not cause a relayout of already instantiated widgets. +.PP +See also reverseLayout(). +.SH "void QApplication::setStartDragDistance ( int l )\fC [static]\fR" +Sets the distance after which a drag should start to \fIl\fR pixels. +.PP +See also startDragDistance(). +.SH "void QApplication::setStartDragTime ( int ms )\fC [static]\fR" +Sets the time after which a drag should start to \fIms\fR ms. +.PP +See also startDragTime(). +.SH "void QApplication::setStyle ( QStyle * style )\fC [static]\fR" +Sets the application's GUI style to \fIstyle\fR. Ownership of the style object is transferred to QApplication, so QApplication will delete the style object on application exit or when a new style is set. +.PP +Example usage: +.PP +.nf +.br + QApplication::setStyle( new QWindowsStyle ); +.br +.fi +.PP +When switching application styles, the color palette is set back to the initial colors or the system defaults. This is necessary since certain styles have to adapt the color palette to be fully style-guide compliant. +.PP +See also style(), QStyle, setPalette(), and desktopSettingsAware(). +.PP +Example: themes/themes.cpp. +.SH "QStyle * QApplication::setStyle ( const QString & style )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Requests a QStyle object for \fIstyle\fR from the QStyleFactory. +.PP +The string must be one of the QStyleFactory::keys(), typically one of "windows", "motif", "cde", "motifplus", "platinum", "sgi" and" compact". Depending on the platform, "windowsxp", "aqua" or" macintosh" may be available. +.PP +A later call to the QApplication constructor will override the requested style when a "-style" option is passed in as a commandline parameter. +.PP +Returns 0 if an unknown \fIstyle\fR is passed, otherwise the QStyle object returned is set as the application's GUI style. +.SH "void QApplication::setWheelScrollLines ( int n )\fC [static]\fR" +Sets the number of lines to scroll when the mouse wheel is rotated to \fIn\fR. +.PP +If this number exceeds the number of visible lines in a certain widget, the widget should interpret the scroll operation as a single page up / page down operation instead. +.PP +See also wheelScrollLines(). +.SH "void QApplication::setWinStyleHighlightColor ( const QColor & c )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the color used to mark selections in windows style for all widgets in the application. Will repaint all widgets if the color is changed. +.PP +The default color is \fCdarkBlue\fR. +.PP +See also winStyleHighlightColor(). +.SH "int QApplication::startDragDistance ()\fC [static]\fR" +If you support drag and drop in you application and a drag should start after a mouse click and after moving the mouse a certain distance, you should use the value which this method returns as the distance. +.PP +For example, if the mouse position of the click is stored in \fCstartPos\fR and the current position (e.g. in the mouse move event) is \fCcurrPos\fR, you can find out if a drag should be started with code like this: +.PP +.nf +.br + if ( ( startPos - currPos ).manhattanLength() > +.br + QApplication::startDragDistance() ) +.br + startTheDrag(); +.br +.fi +.PP +Qt uses this value internally, e.g. in QFileDialog. +.PP +The default value is 4 pixels. +.PP +See also setStartDragDistance(), startDragTime(), and QPoint::manhattanLength(). +.SH "int QApplication::startDragTime ()\fC [static]\fR" +If you support drag and drop in you application and a drag should start after a mouse click and after a certain time elapsed, you should use the value which this method returns as the delay (in ms). +.PP +Qt also uses this delay internally, e.g. in QTextEdit and QLineEdit, for starting a drag. +.PP +The default value is 500 ms. +.PP +See also setStartDragTime() and startDragDistance(). +.SH "bool QApplication::startingUp ()\fC [static]\fR" +Returns TRUE if an application object has not been created yet; otherwise returns FALSE. +.PP +See also closingDown(). +.SH "QStyle & QApplication::style ()\fC [static]\fR" +Returns the application's style object. +.PP +See also setStyle() and QStyle. +.SH "void QApplication::syncX ()\fC [static]\fR" +Synchronizes with the X server in the X11 implementation. This normally takes some time. Does nothing on other platforms. +.PP +See also flushX(). +.SH "QWidgetList * QApplication::topLevelWidgets ()\fC [static]\fR" +Returns a list of the top level widgets in the application. +.PP +The list is created using \fCnew\fR and must be deleted by the caller. +.PP +The list is empty (QPtrList::isEmpty()) if there are no top level widgets. +.PP +Note that some of the top level widgets may be hidden, for example the tooltip if no tooltip is currently shown. +.PP +Example: +.PP +.nf +.br + // Show all hidden top level widgets. +.br + QWidgetList *list = QApplication::topLevelWidgets(); +.br + QWidgetListIt it( *list ); // iterate over the widgets +.br + QWidget * w; +.br + while ( (w=it.current()) != 0 ) { // for each top level widget... +.br + ++it; +.br + if ( !w->isVisible() ) +.br + w->show(); +.br + } +.br + delete list; // delete the list, not the widgets +.br +.fi +.PP +\fBWarning:\fR Delete the list as soon you have finished using it. The widgets in the list may be deleted by someone else at any time. +.PP +See also allWidgets(), QWidget::isTopLevel, QWidget::visible, and QPtrList::isEmpty(). +.SH "QString QApplication::translate ( const char * context, const char * sourceText, const char * comment = 0, Encoding encoding = DefaultCodec ) const" +\fBNote:\fR This function is reentrant when Qt is built with thread support.</p> Returns the translation text for \fIsourceText\fR, by querying the installed messages files. The message files are searched from the most recently installed message file back to the first installed message file. +.PP +QObject::tr() and QObject::trUtf8() provide this functionality more conveniently. +.PP +\fIcontext\fR is typically a class name (e.g., "MyDialog") and \fIsourceText\fR is either English text or a short identifying text, if the output text will be very long (as for help texts). +.PP +\fIcomment\fR is a disambiguating comment, for when the same \fIsourceText\fR is used in different roles within the same context. By default, it is null. \fIencoding\fR indicates the 8-bit encoding of character stings +.PP +See the QTranslator documentation for more information about contexts and comments. +.PP +If none of the message files contain a translation for \fIsourceText\fR in \fIcontext\fR, this function returns a QString equivalent of \fIsourceText\fR. The encoding of \fIsourceText\fR is specified by \fIencoding\fR; it defaults to DefaultCodec. +.PP +This function is not virtual. You can use alternative translation techniques by subclassing QTranslator. +.PP +\fBWarning:\fR This method is reentrant only if all translators are installed \fIbefore\fR calling this method. Installing or removing translators while performing translations is not supported. Doing so will most likely result in crashes or other undesirable behavior. +.PP +See also QObject::tr(), installTranslator(), and defaultCodec(). +.SH "bool QApplication::tryLock ()" +Attempts to lock the Qt Library Mutex, and returns immediately. If the lock was obtained, this function returns TRUE. If another thread has locked the mutex, this function returns FALSE, instead of waiting for the lock to become available. +.PP +The mutex must be unlocked with unlock() before another thread can successfully lock it. +.PP +See also lock(), unlock(), and Thread Support in Qt. +.SH "Type QApplication::type () const" +Returns the type of application, Tty, GuiClient or GuiServer. +.SH "void QApplication::unlock ( bool wakeUpGui = TRUE )" +Unlock the Qt Library Mutex. If \fIwakeUpGui\fR is TRUE (the default), then the GUI thread will be woken with QApplication::wakeUpGuiThread(). +.PP +See also lock(), locked(), and Thread Support in Qt. +.SH "void QApplication::wakeUpGuiThread ()" +Wakes up the GUI thread. +.PP +See also guiThreadAwake() and Thread Support in Qt. +.SH "int QApplication::wheelScrollLines ()\fC [static]\fR" +Returns the number of lines to scroll when the mouse wheel is rotated. +.PP +See also setWheelScrollLines(). +.SH "QWidget * QApplication::widgetAt ( int x, int y, bool child = FALSE )\fC [static]\fR" +Returns a pointer to the widget at global screen position \fI(x, y)\fR, or 0 if there is no Qt widget there. +.PP +If \fIchild\fR is FALSE and there is a child widget at position \fI(x, y)\fR, the top-level widget containing it is returned. If \fIchild\fR is TRUE the child widget at position \fI(x, y)\fR is returned. +.PP +This function is normally rather slow. +.PP +See also QCursor::pos(), QWidget::grabMouse(), and QWidget::grabKeyboard(). +.SH "QWidget * QApplication::widgetAt ( const QPoint & pos, bool child = FALSE )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a pointer to the widget at global screen position \fIpos\fR, or 0 if there is no Qt widget there. +.PP +If \fIchild\fR is FALSE and there is a child widget at position \fIpos\fR, the top-level widget containing it is returned. If \fIchild\fR is TRUE the child widget at position \fIpos\fR is returned. +.SH "bool QApplication::winEventFilter ( MSG * )\fC [virtual]\fR" +This virtual function is only implemented under Windows. +.PP +The message procedure calls this function for every message received. Reimplement this function if you want to process window messages that are not processed by Qt. If you don't want the event to be processed by Qt, then return TRUE; otherwise return FALSE. +.SH "void QApplication::winFocus ( QWidget * widget, bool gotFocus )" +This function is available only on Windows. +.PP +If \fIgotFocus\fR is TRUE, \fIwidget\fR will become the active window. Otherwise the active window is reset to NULL. +.SH "const QColor & QApplication::winStyleHighlightColor ()\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the color used to mark selections in windows style. +.PP +See also setWinStyleHighlightColor(). +.SH "bool QApplication::x11EventFilter ( XEvent * )\fC [virtual]\fR" +This virtual function is only implemented under X11. +.PP +If you create an application that inherits QApplication and reimplement this function, you get direct access to all X events that the are received from the X server. +.PP +Return TRUE if you want to stop the event from being processed. Return FALSE for normal event dispatching. +.PP +See also x11ProcessEvent(). +.SH "int QApplication::x11ProcessEvent ( XEvent * event )" +This function does the core processing of individual X \fIevent\fRs, normally by dispatching Qt events to the right destination. +.PP +It returns 1 if the event was consumed by special handling, 0 if the \fIevent\fR was consumed by normal handling, and -1 if the \fIevent\fR was for an unrecognized widget. +.PP +See also x11EventFilter(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "void Q_ASSERT ( bool test )" +Prints a warning message containing the source code file name and line number if \fItest\fR is FALSE. +.PP +This is really a macro defined in ntqglobal.h. +.PP +Q_ASSERT is useful for testing pre- and post-conditions. +.PP +Example: +.PP +.nf +.br + // +.br + // File: div.cpp +.br + // +.br +.br + #include <ntqglobal.h> +.br +.br + int divide( int a, int b ) +.br + { +.br + Q_ASSERT( b != 0 ); // this is line 9 +.br + return a/b; +.br + } +.br +.fi +.PP +If \fCb\fR is zero, the Q_ASSERT statement will output the following message using the tqWarning() function: +.PP +.nf +.br + ASSERT: "b != 0" in div.cpp (9) +.br +.fi +.PP +See also tqWarning() and Debugging. +.SH "void TQ_CHECK_PTR ( void * p )" +If \fIp\fR is 0, prints a warning message containing the source code file name and line number, saying that the program ran out of memory. +.PP +This is really a macro defined in ntqglobal.h. +.PP +Example: +.PP +.nf +.br + int *a; +.br +.br + TQ_CHECK_PTR( a = new int[80] ); // WRONG! +.br +.br + a = new (nothrow) int[80]; // Right +.br + TQ_CHECK_PTR( a ); +.br +.fi +.PP +See also tqWarning() and Debugging. +.SH "void tqAddPostRoutine ( QtCleanUpFunction p )" +Adds a global routine that will be called from the QApplication destructor. This function is normally used to add cleanup routines for program-wide functionality. +.PP +The function given by \fIp\fR should take no arguments and return nothing, like this: +.PP +.nf +.br + static int *global_ptr = 0; +.br +.br + static void cleanup_ptr() +.br + { +.br + delete [] global_ptr; +.br + global_ptr = 0; +.br + } +.br +.br + void init_ptr() +.br + { +.br + global_ptr = new int[100]; // allocate data +.br + tqAddPostRoutine( cleanup_ptr ); // delete later +.br + } +.br +.fi +.PP +Note that for an application- or module-wide cleanup, tqAddPostRoutine() is often not suitable. People have a tendency to make such modules dynamically loaded, and then unload those modules long before the QApplication destructor is called, for example. +.PP +For modules and libraries, using a reference-counted initialization manager or Qt' parent-child delete mechanism may be better. Here is an example of a private class which uses the parent-child mechanism to call a cleanup function at the right time: +.PP +.nf +.br + class MyPrivateInitStuff: public QObject { +.br + private: +.br + MyPrivateInitStuff( QObject * parent ): QObject( parent) { +.br + // initialization goes here +.br + } +.br + MyPrivateInitStuff * p; +.br +.br + public: +.br + static MyPrivateInitStuff * initStuff( QObject * parent ) { +.br + if ( !p ) +.br + p = new MyPrivateInitStuff( parent ); +.br + return p; +.br + } +.br +.br + ~MyPrivateInitStuff() { +.br + // cleanup (the "post routine") goes here +.br + } +.br + } +.br +.fi +.PP +By selecting the right parent widget/object, this can often be made to clean up the module's data at the exact right moment. +.SH "void tqDebug ( const char * msg, ... )" +Prints a debug message \fImsg\fR, or calls the message handler (if it has been installed). +.PP +This function takes a format string and a list of arguments, similar to the C printf() function. +.PP +Example: +.PP +.nf +.br + tqDebug( "my window handle = %x", myWidget->id() ); +.br +.fi +.PP +Under X11, the text is printed to stderr. Under Windows, the text is sent to the debugger. +.PP +\fBWarning:\fR The internal buffer is limited to 8196 bytes (including the '\0'-terminator). +.PP +\fBWarning:\fR Passing (const char *)0 as argument to tqDebug might lead to crashes on certain platforms due to the platforms printf implementation. +.PP +See also tqWarning(), tqFatal(), qInstallMsgHandler(), and Debugging. +.SH "void tqFatal ( const char * msg, ... )" +Prints a fatal error message \fImsg\fR and exits, or calls the message handler (if it has been installed). +.PP +This function takes a format string and a list of arguments, similar to the C printf() function. +.PP +Example: +.PP +.nf +.br + int divide( int a, int b ) +.br + { +.br + if ( b == 0 ) // program error +.br + tqFatal( "divide: cannot divide by zero" ); +.br + return a/b; +.br + } +.br +.fi +.PP +Under X11, the text is printed to stderr. Under Windows, the text is sent to the debugger. +.PP +\fBWarning:\fR The internal buffer is limited to 8196 bytes (including the '\0'-terminator). +.PP +\fBWarning:\fR Passing (const char *)0 as argument to tqFatal might lead to crashes on certain platforms due to the platforms printf implementation. +.PP +See also tqDebug(), tqWarning(), qInstallMsgHandler(), and Debugging. +.SH "QtMsgHandler qInstallMsgHandler ( QtMsgHandler h )" +Installs a Qt message handler \fIh\fR. Returns a pointer to the message handler previously defined. +.PP +The message handler is a function that prints out debug messages, warnings and fatal error messages. The Qt library (debug version) contains hundreds of warning messages that are printed when internal errors (usually invalid function arguments) occur. If you implement your own message handler, you get total control of these messages. +.PP +The default message handler prints the message to the standard output under X11 or to the debugger under Windows. If it is a fatal message, the application aborts immediately. +.PP +Only one message handler can be defined, since this is usually done on an application-wide basis to control debug output. +.PP +To restore the message handler, call \fCqInstallMsgHandler(0)\fR. +.PP +Example: +.PP +.nf +.br + #include <ntqapplication.h> +.br + #include <stdio.h> +.br + #include <stdlib.h> +.br +.br + void myMessageOutput( QtMsgType type, const char *msg ) +.br + { +.br + switch ( type ) { +.br + case QtDebugMsg: +.br + fprintf( stderr, "Debug: %s\\n", msg ); +.br + break; +.br + case QtWarningMsg: +.br + fprintf( stderr, "Warning: %s\\n", msg ); +.br + break; +.br + case QtFatalMsg: +.br + fprintf( stderr, "Fatal: %s\\n", msg ); +.br + abort(); // deliberately core dump +.br + } +.br + } +.br +.br + int main( int argc, char **argv ) +.br + { +.br + qInstallMsgHandler( myMessageOutput ); +.br + QApplication a( argc, argv ); +.br + ... +.br + return a.exec(); +.br + } +.br +.fi +.PP +See also tqDebug(), tqWarning(), tqFatal(), and Debugging. +.SH "bool tqSysInfo ( int * wordSize, bool * bigEndian )" +Obtains information about the system. +.PP +The system's word size in bits (typically 32) is returned in \fI*wordSize\fR. The \fI*bigEndian\fR is set to TRUE if this is a big-endian machine, or to FALSE if this is a little-endian machine. +.PP +In debug mode, this function calls tqFatal() with a message if the computer is truly weird (i.e. different endianness for 16 bit and 32 bit integers); in release mode it returns FALSE. +.SH "void tqSystemWarning ( const char * msg, int code )" +Prints the message \fImsg\fR and uses \fIcode\fR to get a system specific error message. When \fIcode\fR is -1 (the default), the system's last error code will be used if possible. Use this method to handle failures in platform specific API calls. +.PP +This function does nothing when Qt is built with \fCQT_NO_DEBUG\fR defined. +.SH "const char * tqVersion ()" +Returns the Qt version number as a string, for example, "2.3.0" or" 3.0.5". +.PP +The \fCTQT_VERSION\fR define has the numeric value in the form: 0xmmiibb (m = major, i = minor, b = bugfix). For example, Qt 3.0.5's \fCTQT_VERSION\fR is 0x030005. +.SH "void tqWarning ( const char * msg, ... )" +Prints a warning message \fImsg\fR, or calls the message handler (if it has been installed). +.PP +This function takes a format string and a list of arguments, similar to the C printf() function. +.PP +Example: +.PP +.nf +.br + void f( int c ) +.br + { +.br + if ( c > 200 ) +.br + tqWarning( "f: bad argument, c == %d", c ); +.br + } +.br +.fi +.PP +Under X11, the text is printed to stderr. Under Windows, the text is sent to the debugger. +.PP +\fBWarning:\fR The internal buffer is limited to 8196 bytes (including the '\0'-terminator). +.PP +\fBWarning:\fR Passing (const char *)0 as argument to tqWarning might lead to crashes on certain platforms due to the platforms printf implementation. +.PP +See also tqDebug(), tqFatal(), qInstallMsgHandler(), and Debugging. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqapplication.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqapplication.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqasciicache.3qt b/doc/man/man3/tqasciicache.3qt new file mode 100644 index 000000000..ac053ef43 --- /dev/null +++ b/doc/man/man3/tqasciicache.3qt @@ -0,0 +1,191 @@ +'\" t +.TH QAsciiCache 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 +QAsciiCache \- Template class that provides a cache based on char* keys +.SH SYNOPSIS +\fC#include <ntqasciicache.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAsciiCache\fR ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" +.br +.ti -1c +.BI "\fB~QAsciiCache\fR ()" +.br +.ti -1c +.BI "int \fBmaxCost\fR () const" +.br +.ti -1c +.BI "int \fBtotalCost\fR () const" +.br +.ti -1c +.BI "void \fBsetMaxCost\fR ( int m )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "bool \fBinsert\fR ( const char * k, const type * d, int c = 1, int p = 0 )" +.br +.ti -1c +.BI "bool \fBremove\fR ( const char * k )" +.br +.ti -1c +.BI "type * \fBtake\fR ( const char * k )" +.br +.ti -1c +.BI "type * \fBfind\fR ( const char * k, bool ref = TRUE ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( const char * k ) const" +.br +.ti -1c +.BI "void \fBstatistics\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QAsciiCache class is a template class that provides a cache based on char* keys. +.PP +QAsciiCache is implemented as a template class. Define a template instance QAsciiCache<X> to create a cache that operates on pointers to X (X*). +.PP +A cache is a least recently used (LRU) list of cache items. The cache items are accessed via \fCchar*\fR keys. For Unicode keys use the QCache template instead, which uses QString keys. A QCache has the same performace as a QAsciiCache. +.PP +Each cache item has a cost. The sum of item costs, totalCost(), will not exceed the maximum cache cost, maxCost(). If inserting a new item would cause the total cost to exceed the maximum cost, the least recently used items in the cache are removed. +.PP +Apart from insert(), by far the most important function is find() (which also exists as operator[]()). This function looks up an item, returns it, and by default marks it as being the most recently used item. +.PP +There are also methods to remove() or take() an object from the cache. Calling setAutoDelete(TRUE) tells the cache to delete items that are removed. The default is to not delete items when then are removed (i.e., remove() and take() are equivalent). +.PP +When inserting an item into the cache, only the pointer is copied, not the item itself. This is called a shallow copy. It is possible to make the cache copy all of the item's data (known as a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a cache and reimplement newItem() if you want deep copies. +.PP +When removing a cache item the virtual function QPtrCollection::deleteItem() is called. Its default implementation in QAsciiCache is to delete the item if auto-deletion is enabled. +.PP +There is a QAsciiCacheIterator which may be used to traverse the items in the cache in arbitrary order. +.PP +See also QAsciiCacheIterator, QCache, QIntCache, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAsciiCache::QAsciiCache ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" +Constructs a cache whose contents will never have a total cost greater than \fImaxCost\fR and which is expected to contain less than \fIsize\fR items. +.PP +\fIsize\fR is actually the size of an internal hash array; it's usually best to make it prime and at least 50% bigger than the largest expected number of items in the cache. +.PP +Each inserted item has an associated cost. When inserting a new item, if the total cost of all items in the cache will exceed \fImaxCost\fR, the cache will start throwing out the older (least recently used) items until there is enough room for the new item to be inserted. +.PP +If \fIcaseSensitive\fR is TRUE (the default), the cache keys are case sensitive; if it is FALSE, they are case-insensitive. Case-insensitive comparison only affects the 26 letters in US-ASCII. If \fIcopyKeys\fR is TRUE (the default), QAsciiCache makes a copy of the cache keys, otherwise it copies just the const char * pointer - slightly faster if you can guarantee that the keys will never change, but very risky. +.SH "QAsciiCache::~QAsciiCache ()" +Removes all items from the cache and destroys it. All iterators that access this cache will be reset. +.SH "void QAsciiCache::clear ()\fC [virtual]\fR" +Removes all items from the cache, and deletes them if auto-deletion has been enabled. +.PP +All cache iterators that operate on this cache are reset. +.PP +See also remove() and take(). +.PP +Reimplemented from QPtrCollection. +.SH "uint QAsciiCache::count () const\fC [virtual]\fR" +Returns the number of items in the cache. +.PP +See also totalCost() and size(). +.PP +Reimplemented from QPtrCollection. +.SH "type * QAsciiCache::find ( const char * k, bool ref = TRUE ) const" +Returns the item with key \fIk\fR, or 0 if the key does not exist in the cache. If \fIref\fR is TRUE (the default), the item is moved to the front of the least recently used list. +.PP +If there are two or more items with equal keys, the one that was inserted last is returned. +.SH "bool QAsciiCache::insert ( const char * k, const type * d, int c = 1, int p = 0 )" +Inserts the item \fId\fR into the cache using key \fIk\fR, and with an associated cost of \fIc\fR. Returns TRUE if the item is successfully inserted. Returns FALSE if the item is not inserted, for example, if the cost of the item exceeds maxCost(). +.PP +The cache's size is limited, and if the total cost is too high, QAsciiCache will remove old, least recently used items until there is room for this new item. +.PP +Items with duplicate keys can be inserted. +.PP +The parameter \fIp\fR is internal and should be left at the default value (0). +.PP +\fBWarning:\fR If this function returns FALSE, you must delete \fId\fR yourself. Additionally, be very careful about using \fId\fR after calling this function, because any other insertions into the cache, from anywhere in the application or within Qt itself, could cause the object to be discarded from the cache and the pointer to become invalid. +.SH "bool QAsciiCache::isEmpty () const" +Returns TRUE if the cache is empty; otherwise returns FALSE. +.SH "int QAsciiCache::maxCost () const" +Returns the maximum allowed total cost of the cache. +.PP +See also setMaxCost() and totalCost(). +.SH "type * QAsciiCache::operator[] ( const char * k ) const" +Returns the item with key \fIk\fR, or 0 if \fIk\fR does not exist in the cache, and moves the item to the front of the least recently used list. +.PP +If there are two or more items with equal keys, the one that was inserted last is returned. +.PP +This is the same as find( k, TRUE ). +.PP +See also find(). +.SH "bool QAsciiCache::remove ( const char * k )" +Removes the item with key \fIk\fR and returns TRUE if the item was present in the cache; otherwise returns FALSE. +.PP +The item is deleted if auto-deletion has been enabled, i.e., if you have called setAutoDelete(TRUE). +.PP +If there are two or more items with equal keys, the one that was inserted last is removed. +.PP +All iterators that refer to the removed item are set to point to the next item in the cache's traversal order. +.PP +See also take() and clear(). +.SH "void QAsciiCache::setMaxCost ( int m )" +Sets the maximum allowed total cost of the cache to \fIm\fR. If the current total cost is greater than \fIm\fR, some items are removed immediately. +.PP +See also maxCost() and totalCost(). +.SH "uint QAsciiCache::size () const" +Returns the size of the hash array used to implement the cache. This should be a bit bigger than count() is likely to be. +.SH "void QAsciiCache::statistics () const" +A debug-only utility function. Prints out cache usage, hit/miss, and distribution information using tqDebug(). This function does nothing in the release library. +.SH "type * QAsciiCache::take ( const char * k )" +Takes the item associated with \fIk\fR out of the cache without deleting it and returns a pointer to the item taken out, or 0 if the key does not exist in the cache. +.PP +If there are two or more items with equal keys, the one that was inserted last is taken. +.PP +All iterators that refer to the taken item are set to point to the next item in the cache's traversal order. +.PP +See also remove() and clear(). +.SH "int QAsciiCache::totalCost () const" +Returns the total cost of the items in the cache. This is an integer in the range 0 to maxCost(). +.PP +See also setMaxCost(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqasciicache.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqasciicache.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqasciicacheiterator.3qt b/doc/man/man3/tqasciicacheiterator.3qt new file mode 100644 index 000000000..30d4548ee --- /dev/null +++ b/doc/man/man3/tqasciicacheiterator.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QAsciiCacheIterator 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 +QAsciiCacheIterator \- Iterator for QAsciiCache collections +.SH SYNOPSIS +\fC#include <ntqasciicache.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAsciiCacheIterator\fR ( const QAsciiCache<type> & cache )" +.br +.ti -1c +.BI "\fBQAsciiCacheIterator\fR ( const QAsciiCacheIterator<type> & ci )" +.br +.ti -1c +.BI "QAsciiCacheIterator<type> & \fBoperator=\fR ( const QAsciiCacheIterator<type> & ci )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBatFirst\fR () const" +.br +.ti -1c +.BI "bool \fBatLast\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "type * \fBtoLast\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "const char * \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.ti -1c +.BI "type * \fBoperator--\fR ()" +.br +.ti -1c +.BI "type * \fBoperator-=\fR ( uint jump )" +.br +.in -1c +.SH DESCRIPTION +The QAsciiCacheIterator class provides an iterator for QAsciiCache collections. +.PP +Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them. +.PP +Multiple iterators are completely independent, even when they operate on the same QAsciiCache. QAsciiCache updates all iterators that refer an item when that item is removed. +.PP +QAsciiCacheIterator provides an operator++() and an operator+=() to traverse the cache; current() and currentKey() to access the current cache item and its key. It also provides atFirst() and atLast(), which return TRUE if the iterator points to the first or last item in the cache respectively. The isEmpty() function returns TRUE if the cache is empty; and count() returns the number of items in the cache. +.PP +Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also QAsciiCache, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCache<type> & cache )" +Constructs an iterator for \fIcache\fR. The current iterator item is set to point to the first item in the \fIcache\fR. +.SH "QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCacheIterator<type> & ci )" +Constructs an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current() but moves independently from there on. +.SH "bool QAsciiCacheIterator::atFirst () const" +Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toFirst() and atLast(). +.SH "bool QAsciiCacheIterator::atLast () const" +Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toLast() and atFirst(). +.SH "uint QAsciiCacheIterator::count () const" +Returns the number of items in the cache over which this iterator operates. +.PP +See also isEmpty(). +.SH "type * QAsciiCacheIterator::current () const" +Returns a pointer to the current iterator item. +.SH "const char * QAsciiCacheIterator::currentKey () const" +Returns the key for the current iterator item. +.SH "bool QAsciiCacheIterator::isEmpty () const" +Returns TRUE if the cache is empty, i.e. count() == 0; otherwise returns FALSE. +.PP +See also count(). +.SH "QAsciiCacheIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QAsciiCacheIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the cache or if it was 0, 0 is returned. +.SH "type * QAsciiCacheIterator::operator++ ()" +Prefix ++ makes the iterator point to the item just after current(), and makes that the new current item for the iterator. If current() was the last item, operator++() returns 0. +.SH "type * QAsciiCacheIterator::operator+= ( uint jump )" +Returns the item \fIjump\fR positions after the current item, or 0 if it is beyond the last item. Makes this the current item. +.SH "type * QAsciiCacheIterator::operator-- ()" +Prefix -- makes the iterator point to the item just before current(), and makes that the new current item for the iterator. If current() was the first item, operator--() returns 0. +.SH "type * QAsciiCacheIterator::operator-= ( uint jump )" +Returns the item \fIjump\fR positions before the current item, or 0 if it is before the first item. Makes this the current item. +.SH "QAsciiCacheIterator<type> & QAsciiCacheIterator::operator= ( const QAsciiCacheIterator<type> & ci )" +Makes this an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently thereafter. +.SH "type * QAsciiCacheIterator::toFirst ()" +Sets the iterator to point to the first item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0 and returns 0 if the cache is empty. +.PP +See also toLast() and isEmpty(). +.SH "type * QAsciiCacheIterator::toLast ()" +Sets the iterator to point to the last item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0 and returns 0 if the cache is empty. +.PP +See also isEmpty(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qasciicacheiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqasciicacheiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqasciidict.3qt b/doc/man/man3/tqasciidict.3qt new file mode 100644 index 000000000..5c0e34f69 --- /dev/null +++ b/doc/man/man3/tqasciidict.3qt @@ -0,0 +1,317 @@ +'\" t +.TH QAsciiDict 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 +QAsciiDict \- Template class that provides a dictionary based on char* keys +.SH SYNOPSIS +\fC#include <ntqasciidict.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAsciiDict\fR ( int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" +.br +.ti -1c +.BI "\fBQAsciiDict\fR ( const QAsciiDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QAsciiDict\fR ()" +.br +.ti -1c +.BI "QAsciiDict<type> & \fBoperator=\fR ( const QAsciiDict<type> & dict )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "void \fBinsert\fR ( const char * key, const type * item )" +.br +.ti -1c +.BI "void \fBreplace\fR ( const char * key, const type * item )" +.br +.ti -1c +.BI "bool \fBremove\fR ( const char * key )" +.br +.ti -1c +.BI "type * \fBtake\fR ( const char * key )" +.br +.ti -1c +.BI "type * \fBfind\fR ( const char * key ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( const char * key ) const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "void \fBresize\fR ( uint newsize )" +.br +.ti -1c +.BI "void \fBstatistics\fR () const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" +.br +.in -1c +.SH DESCRIPTION +The QAsciiDict class is a template class that provides a dictionary based on char* keys. +.PP +QAsciiDict is implemented as a template class. Define a template instance QAsciiDict<X> to create a dictionary that operates on pointers to X (X*). +.PP +A dictionary is a collection of key-value pairs. The key is a char* used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. +.PP +QAsciiDict cannot handle Unicode keys; use the QDict template instead, which uses QString keys. A QDict has the same performace as a QAsciiDict. +.PP +Example: +.PP +.nf +.br + QAsciiDict<QLineEdit> fields; // char* keys, QLineEdit* values +.br + fields.insert( "forename", new QLineEdit( this ) ); +.br + fields.insert( "surname", new QLineEdit( this ) ); +.br +.br + fields["forename"]->setText( "Homer" ); +.br + fields["surname"]->setText( "Simpson" ); +.br +.br + QAsciiDictIterator<QLineEdit> it( fields ); // See QAsciiDictIterator +.br + for( ; it.current(); ++it ) +.br + cout << it.currentKey() << ": " << it.current()->text() << endl; +.br + cout << endl; +.br +.br + if ( fields["forename"] && fields["surname"] ) +.br + cout << fields["forename"]->text() << " " +.br +.br + << fields["surname"]->text() << endl; // Prints "Homer Simpson" +.br +.br + fields.remove( "forename" ); // Does not delete the line edit +.br + if ( ! fields["forename"] ) +.br + cout << "forename is not in the dictionary" << endl; +.br +.fi +In this example we use a dictionary to keep track of the line edits we're using. We insert each line edit into the dictionary with a unique name and then access the line edits via the dictionary. See QPtrDict, QIntDict and QDict. +.PP +See QDict for full details, including the choice of dictionary size, and how deletions are handled. +.PP +See also QAsciiDictIterator, QDict, QIntDict, QPtrDict, Collection Classes, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAsciiDict::QAsciiDict ( int size = 17, bool caseSensitive = TRUE, bool copyKeys = TRUE )" +Constructs a dictionary optimized for less than \fIsize\fR entries. +.PP +We recommend setting \fIsize\fR to a suitably large prime number (a bit larger than the expected number of entries). This makes the hash distribution better and will improve lookup performance. +.PP +When \fIcaseSensitive\fR is TRUE (the default) QAsciiDict treats" abc" and "Abc" as different keys; when it is FALSE "abc" and" Abc" are the same. Case-insensitive comparison only considers the 26 letters in US-ASCII. +.PP +If \fIcopyKeys\fR is TRUE (the default), the dictionary copies keys using strcpy(); if it is FALSE, the dictionary just copies the pointers. +.SH "QAsciiDict::QAsciiDict ( const QAsciiDict<type> & dict )" +Constructs a copy of \fIdict\fR. +.PP +Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). +.SH "QAsciiDict::~QAsciiDict ()" +Removes all items from the dictionary and destroys it. +.PP +The items are deleted if auto-delete is enabled. +.PP +All iterators that access this dictionary will be reset. +.PP +See also setAutoDelete(). +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QAsciiDict::clear ()\fC [virtual]\fR" +Removes all items from the dictionary. +.PP +The removed items are deleted if auto-deletion is enabled. +.PP +All dictionary iterators that operate on dictionary are reset. +.PP +See also remove(), take(), and setAutoDelete(). +.PP +Reimplemented from QPtrCollection. +.SH "uint QAsciiDict::count () const\fC [virtual]\fR" +Returns the number of items in the dictionary. +.PP +See also isEmpty(). +.PP +Reimplemented from QPtrCollection. +.SH "type * QAsciiDict::find ( const char * key ) const" +Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +This function uses an internal hashing algorithm to optimize lookup. +.PP +If there are two or more items with equal keys, then the item that was most recently inserted will be found. +.PP +Equivalent to the [] operator. +.PP +See also operator[](). +.SH "void QAsciiDict::insert ( const char * key, const type * item )" +Inserts the \fIkey\fR with the \fIitem\fR into the dictionary. +.PP +Multiple items can have the same key, in which case only the last item will be accessible using operator[](). +.PP +\fIitem\fR may not be 0. +.PP +See also replace(). +.SH "bool QAsciiDict::isEmpty () const" +Returns TRUE if the dictionary is empty, i.e. count() == 0; otherwise it returns FALSE. +.PP +See also count(). +.SH "QAsciiDict<type> & QAsciiDict::operator= ( const QAsciiDict<type> & dict )" +Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. +.PP +This dictionary is first cleared and then each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy) unless newItem() has been reimplemented(). +.SH "type * QAsciiDict::operator[] ( const char * key ) const" +Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +This function uses an internal hashing algorithm to optimize lookup. +.PP +If there are two or more items with equal keys, then the item that was most recently inserted will be found. +.PP +Equivalent to the find() function. +.PP +See also find(). +.SH "QDataStream & QAsciiDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QAsciiDict::remove ( const char * key )" +Removes the item associated with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if the key existed in the dictionary; otherwise returns FALSE. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be removed. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary traversal order. +.PP +See also take(), clear(), and setAutoDelete(). +.SH "void QAsciiDict::replace ( const char * key, const type * item )" +Replaces an item that has a key equal to \fIkey\fR with \fIitem\fR. +.PP +If the item does not already exist, it will be inserted. +.PP +\fIitem\fR may not be 0. +.PP +Equivalent to: +.PP +.nf +.br + QAsciiDict<char> dict; +.br + ... +.br + if ( dict.find(key) ) +.br + dict.remove( key ); +.br + dict.insert( key, item ); +.br +.fi +.PP +If there are two or more items with equal keys, then the most recently inserted item will be replaced. +.PP +See also insert(). +.SH "void QAsciiDict::resize ( uint newsize )" +Changes the size of the hashtable to \fInewsize\fR. The contents of the dictionary are preserved but all iterators on the dictionary become invalid. +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. +.SH "uint QAsciiDict::size () const" +Returns the size of the internal hash array (as specified in the constructor). +.PP +See also count(). +.SH "void QAsciiDict::statistics () const" +Debugging-only function that prints out the dictionary distribution using tqDebug(). +.SH "type * QAsciiDict::take ( const char * key )" +Takes the item associated with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). +.PP +If there are two or more items with equal keys, then the most recently inserted item will be taken. +.PP +Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. +.PP +All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary traversal order. +.PP +See also remove(), clear(), and setAutoDelete(). +.SH "QDataStream & QAsciiDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" +Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqasciidict.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqasciidict.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqasciidictiterator.3qt b/doc/man/man3/tqasciidictiterator.3qt new file mode 100644 index 000000000..c458518ba --- /dev/null +++ b/doc/man/man3/tqasciidictiterator.3qt @@ -0,0 +1,159 @@ +'\" t +.TH QAsciiDictIterator 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 +QAsciiDictIterator \- Iterator for QAsciiDict collections +.SH SYNOPSIS +\fC#include <ntqasciidict.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAsciiDictIterator\fR ( const QAsciiDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QAsciiDictIterator\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "const char * \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.in -1c +.SH DESCRIPTION +The QAsciiDictIterator class provides an iterator for QAsciiDict collections. +.PP +QAsciiDictIterator is implemented as a template class. Define a template instance QAsciiDictIterator<X> to create a dictionary iterator that operates on QAsciiDict<X> (dictionary of X*). +.PP +Example: +.PP +.nf +.br + QAsciiDict<QLineEdit> fields; +.br + fields.insert( "forename", new QLineEdit( this ) ); +.br + fields.insert( "surname", new QLineEdit( this ) ); +.br + fields.insert( "age", new QLineEdit( this ) ); +.br +.br + fields["forename"]->setText( "Homer" ); +.br + fields["surname"]->setText( "Simpson" ); +.br + fields["age"]->setText( "45" ); +.br +.br + QAsciiDictIterator<QLineEdit> it( fields ); +.br + for( ; it.current(); ++it ) +.br + cout << it.currentKey() << ": " << it.current()->text() << endl; +.br + cout << endl; +.br +.br + // Output (random order): +.br + // age: 45 +.br + // surname: Simpson +.br + // forename: Homer +.br +.fi +In the example we insert some line edits into a dictionary, then iterate over the dictionary printing the strings associated with those line edits. +.PP +Note that the traversal order is arbitrary; you are not guaranteed any particular order. +.PP +Multiple iterators may independently traverse the same dictionary. A QAsciiDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QAsciiDict updates all the iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order. +.PP +See also QAsciiDict, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAsciiDictIterator::QAsciiDictIterator ( const QAsciiDict<type> & dict )" +Constructs an iterator for \fIdict\fR. The current iterator item is set to point on the first item in the \fIdict\fR. +.SH "QAsciiDictIterator::~QAsciiDictIterator ()" +Destroys the iterator. +.SH "uint QAsciiDictIterator::count () const" +Returns the number of items in the dictionary this iterator operates over. +.PP +See also isEmpty(). +.SH "type * QAsciiDictIterator::current () const" +Returns a pointer to the current iterator item. +.SH "const char * QAsciiDictIterator::currentKey () const" +Returns a pointer to the key for the current iterator item. +.SH "bool QAsciiDictIterator::isEmpty () const" +Returns TRUE if the dictionary is empty, i.e. count() == 0, otherwise returns FALSE. +.PP +See also count(). +.SH "QAsciiDictIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QAsciiDictIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QAsciiDictIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns the new current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QAsciiDictIterator::operator+= ( uint jump )" +Sets the current item to the item \fIjump\fR positions after the current item, and returns a pointer to that item. +.PP +If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0. +.SH "type * QAsciiDictIterator::toFirst ()" +Sets the current iterator item to point to the first item in the +dictionary and returns a pointer to the item. If the dictionary is +empty it sets the current item to 0 and returns 0. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qasciidictiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqasciidictiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqassistantclient.3qt b/doc/man/man3/tqassistantclient.3qt new file mode 100644 index 000000000..cc4b10c42 --- /dev/null +++ b/doc/man/man3/tqassistantclient.3qt @@ -0,0 +1,143 @@ +'\" t +.TH QAssistantClient 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 +QAssistantClient \- Means of using Qt Assistant as an application's help tool +.SH SYNOPSIS +\fC#include <ntqassistantclient.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAssistantClient\fR ( const QString & path, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QAssistantClient\fR ()" +.br +.ti -1c +.BI "bool \fBisOpen\fR () const" +.br +.ti -1c +.BI "void \fBsetArguments\fR ( const QStringList & args )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBopenAssistant\fR ()" +.br +.ti -1c +.BI "virtual void \fBcloseAssistant\fR ()" +.br +.ti -1c +.BI "virtual void \fBshowPage\fR ( const QString & page )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBassistantOpened\fR ()" +.br +.ti -1c +.BI "void \fBassistantClosed\fR ()" +.br +.ti -1c +.BI "void \fBerror\fR ( const QString & msg )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBopen\fR - whether Qt Assistant is open \fI(read " "only" ")\fR" +.br +.in -1c +.SH DESCRIPTION +The QAssistantClient class provides a means of using Qt Assistant as an application's help tool. +.PP +Using Qt Assistant is simple: Create a QAssistantClient instance, then call showPage() as often as necessary to show your help pages. When you call showPage(), Qt Assistant will be launched if it isn't already running. +.PP +The QAssistantClient instance can open (openAssistant()) or close (closeAssistant()) Qt Assistant whenever required. If Qt Assistant is open, isOpen() returns TRUE. +.PP +One QAssistantClient instance interacts with one Qt Assistant instance, so every time you call openAssistant(), showPage() or closeAssistant() they are applied to the particular Qt Assistant instance associated with the QAssistantClient. +.PP +When you call openAssistant() the assistantOpened() signal is emitted. Similarly when closeAssistant() is called, assistantClosed() is emitted. In either case, if an error occurs, error() is emitted. +.PP +This class is not included in the Qt library itself. To use it you must link against \fClibqassistantclient.a\fR (Unix) or \fCqassistantclient.lib\fR (Windows), which is built into \fCINSTALL/lib\fR if you built the Qt tools (\fCINSTALL\fR is the directory where Qt is installed). If you use qmake, then you can simply add the following line to your pro file: +.PP +.nf +.br + LIBS += -lqassistantclient +.br +.fi +.PP +See also "Adding Documentation to Qt Assistant" in the Qt Assistant manual. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAssistantClient::QAssistantClient ( const QString & path, QObject * parent = 0, const char * name = 0 )" +Constructs an assistant client object. The \fIpath\fR specifies the path to the Qt Assistant executable. If \fIpath\fR is an empty string the system path (\fC%PATH%\fR or \fC$PATH\fR) is used. +.PP +The assistant client object is a child of \fIparent\fR and is called \fIname\fR. +.SH "QAssistantClient::~QAssistantClient ()" +Destroys the assistant client object and frees up all allocated resources. +.SH "void QAssistantClient::assistantClosed ()\fC [signal]\fR" +This signal is emitted when the connection to Qt Assistant is closed. This happens when the user exits Qt Assistant, or when an error in the server or client occurs, or if closeAssistant() is called. +.SH "void QAssistantClient::assistantOpened ()\fC [signal]\fR" +This signal is emitted when Qt Assistant is open and the client-server communication is set up. +.SH "void QAssistantClient::closeAssistant ()\fC [virtual slot]\fR" +Use this function to close Qt Assistant. +.PP +See also assistantClosed(). +.SH "void QAssistantClient::error ( const QString & msg )\fC [signal]\fR" +This signal is emitted if Qt Assistant cannot be started or if an error occurs during the initialization of the connection between Qt Assistant and the calling application. The \fImsg\fR provides an explanation of the error. +.SH "bool QAssistantClient::isOpen () const" +Returns TRUE if Qt Assistant is open; otherwise returns FALSE. See the "open" property for details. +.SH "void QAssistantClient::openAssistant ()\fC [virtual slot]\fR" +This function opens Qt Assistant and sets up the client-server communiction between the application and Qt Assistant. If it is already open, this function does nothing. If an error occurs, error() is emitted. +.PP +See also assistantOpened(). +.SH "void QAssistantClient::setArguments ( const QStringList & args )" +Sets the command line arguments used when Qt Assistant is started to \fIargs\fR. +.SH "void QAssistantClient::showPage ( const QString & page )\fC [virtual slot]\fR" +Call this function to make Qt Assistant show a particular \fIpage\fR. The \fIpage\fR is a filename (e.g. \fCmyhelpfile.html\fR). See "Adding Documentation to Qt Assistant" in the Qt Assistant manual for further information. +.PP +If Qt Assistant hasn't been opened yet, this function will do nothing. You can use isOpen() to determine whether Qt Assistant is up and running, or you can connect to the asssistantOpened() signal. +.PP +See also open and assistantOpened(). +.PP +Example: helpsystem/mainwindow.cpp. +.SS "Property Documentation" +.SH "bool open" +This property holds whether Qt Assistant is open. +.PP +Get this property's value with isOpen(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqassistantclient.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqassistantclient.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxaggregated.3qt b/doc/man/man3/tqaxaggregated.3qt new file mode 100644 index 000000000..d0fa5e07d --- /dev/null +++ b/doc/man/man3/tqaxaggregated.3qt @@ -0,0 +1,143 @@ +'\" t +.TH QAxAggregated 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 +QAxAggregated \- Abstract base class for implementations of additional COM interfaces +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxbindable.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual long \fBqueryInterface\fR ( const QUuid & iid, void ** iface ) = 0" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "IUnknown * \fBcontrollingUnknown\fR () const" +.br +.ti -1c +.BI "QWidget * \fBwidget\fR () const" +.br +.ti -1c +.BI "QObject * \fBobject\fR () const" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxAggregated class is an abstract base class for implementations of additional COM interfaces. +.PP +Create a subclass of QAxAggregated and reimplement queryInterface() to support additional COM interfaces. Use multiple inheritance from those COM interfaces. Implement the IUnknown interface of those COM interfaces by delegating the calls to QueryInterface(), AddRef() and Release() to the interface provided by controllingUnknown(). +.PP +Use the widget() method if you need to make calls to the QWidget implementing the ActiveX control. You must not store that pointer in your subclass (unless you use QGuardedPtr), as the QWidget can be destroyed by the ActiveQt framework at any time. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "IUnknown * QAxAggregated::controllingUnknown () const\fC [protected]\fR" +Returns the IUnknown interface of the ActiveX control. Implement the IUnknown interface in your QAxAggregated subclass to delegate calls to QueryInterface(), AddRef() and Release() to the interface provided by this function. +.PP +.nf +.br + HRESULT AxImpl::QueryInterface( REFIID iid, void **iface ) +.br + { +.br + return controllingUnknown()->QueryInterface( iid, iface ); +.br + } +.br +.br + unsigned long AxImpl::AddRef() +.br + { +.br + return controllingUnknown()->AddRef(); +.br + } +.br +.br + unsigned long AxImpl::Release() +.br + { +.br + return controllingUnknown()->Release(); +.br + } +.br +.fi +.PP +The QAXAGG_IUNKNOWN macro expands to the code above, and you can use it in the class declaration of your subclass. +.SH "QObject * QAxAggregated::object () const\fC [protected]\fR" +Returns a pointer to the QObject subclass implementing the COM object. This function might return 0. +.PP +\fBWarning:\fR You must not store the returned pointer, unless you use a QGuardedPtr, since the QObject can be destroyed by ActiveQt at any time. +.SH "long QAxAggregated::queryInterface ( const QUuid & iid, void ** iface )\fC [pure virtual]\fR" +Reimplement this pure virtual function to support additional COM interfaces. Set the value of \fIiface\fR to point to this object to support the interface \fIiid\fR. Note that you must cast the \fCthis\fR pointer to the appropriate superclass. +.PP +.nf +.br + long AxImpl::queryInterface( const QUuid &iid, void **iface ) +.br + { +.br + *iface = 0; +.br + if ( iid == IID_ISomeCOMInterface ) +.br + *iface = (ISomeCOMInterface*)this; +.br + else +.br + return E_NOINTERFACE; +.br +.br + AddRef(); +.br + return S_OK; +.br + } +.br +.fi +.PP +Return the standard COM results S_OK (interface is supported) or E_NOINTERFACE (requested interface is not supported). +.PP +\fBWarning:\fR Even though you must implement the IUnknown interface if you implement any COM interface you must not support the IUnknown interface in your queryInterface() implementation. +.SH "QWidget * QAxAggregated::widget () const\fC [protected]\fR" +Returns a pointer to the QWidget subclass implementing the ActiveX control. This function might return 0. +.PP +\fBWarning:\fR +You must not store the returned pointer, unless you use a +QGuardedPtr, since the QWidget can be destroyed by ActiveQt at any +time. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxaggregated.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxaggregated.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxbase.3qt b/doc/man/man3/tqaxbase.3qt new file mode 100644 index 000000000..1bc7b193e --- /dev/null +++ b/doc/man/man3/tqaxbase.3qt @@ -0,0 +1,561 @@ +'\" t +.TH QAxBase 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 +QAxBase \- Abstract class that provides an API to initalize and access a COM object +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxbase.h>\fR +.PP +Inherited by QAxObject and QAxWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAxBase\fR ( IUnknown * iface = 0 )" +.br +.ti -1c +.BI "virtual \fB~QAxBase\fR ()" +.br +.ti -1c +.BI "QString \fBcontrol\fR () const" +.br +.ti -1c +.BI "long \fBqueryInterface\fR ( const QUuid & uuid, void ** iface ) const" +.br +.ti -1c +.BI "QVariant \fBdynamicCall\fR ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.ti -1c +.BI "QVariant \fBdynamicCall\fR ( const QCString & function, QValueList<QVariant> & vars )" +.br +.ti -1c +.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.ti -1c +.BI "PropertyBag \fBpropertyBag\fR () const" +.br +.ti -1c +.BI "void \fBsetPropertyBag\fR ( const PropertyBag & bag )" +.br +.ti -1c +.BI "QString \fBgenerateDocumentation\fR ()" +.br +.ti -1c +.BI "virtual bool \fBpropertyWritable\fR ( const char * prop ) const" +.br +.ti -1c +.BI "virtual void \fBsetPropertyWritable\fR ( const char * prop, bool ok )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "QVariant \fBasVariant\fR () const" +.br +.ti -1c +.BI "enum \fBPropertyBag\fR { }" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "bool \fBsetControl\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBdisableMetaObject\fR ()" +.br +.ti -1c +.BI "void \fBdisableClassInfo\fR ()" +.br +.ti -1c +.BI "void \fBdisableEventSink\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBsignal\fR ( const QString & name, int argc, void * argv )" +.br +.ti -1c +.BI "void \fBpropertyChanged\fR ( const QString & name )" +.br +.ti -1c +.BI "void \fBexception\fR ( int code, const QString & source, const QString & desc, const QString & help )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QString \fBcontrol\fR - the name of the COM object wrapped by this QAxBase object" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBinitialize\fR ( IUnknown ** ptr )" +.br +.ti -1c +.BI "bool \fBinitializeRemote\fR ( IUnknown ** ptr )" +.br +.ti -1c +.BI "bool \fBinitializeLicensed\fR ( IUnknown ** ptr )" +.br +.ti -1c +.BI "bool \fBinitializeActive\fR ( IUnknown ** ptr )" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxBase class is an abstract class that provides an API to initalize and access a COM object. +.PP +QAxBase is an abstract class that cannot be used directly, and is instantiated through the subclasses QAxObject and QAxWidget. This class provides the API to access the COM object directly through its IUnknown implementation. If the COM object implements the IDispatch interface, the properties and methods of that object become available as Qt properties and slots. +.PP +.nf +.br + connect( buttonBack, SIGNAL(clicked()), webBrowser, SLOT(GoBack()) ); +.br +.fi +.PP +Properties exposed by the object's IDispatch implementation can be read and written through the property system provided by the Qt Object Model (both subclasses are QObjects, so you can use setProperty() and property() as with QObject). Properties with multiple parameters are not supported. +.PP +.nf +.br + activeX->setProperty( "text", "some text" ); +.br + int value = activeX->property( "value" ); +.br +.fi +.PP +Write-functions for properties and other methods exposed by the object's IDispatch implementation can be called directly using dynamicCall(), or indirectly as slots connected to a signal. +.PP +.nf +.br + webBrowser->dynamicCall( "GoHome()" ); +.br +.fi +.PP +Outgoing events supported by the COM object are emitted as standard Qt signals. +.PP +.nf +.br + connect( webBrowser, SIGNAL(TitleChanged(const QString&)), +.br + this, SLOT(setCaption(const QString&)) ); +.br +.fi +.PP +QAxBase transparently converts between COM data types and the equivalent Qt data types. Some COM types have no equivalent Qt data structure. +.PP +Supported COM datatypes are listed in the first column of following table. The second column is the Qt type that can be used with the QObject property functions. The third column is the Qt type that is used in the prototype of generated signals and slots for in-parameters, and the last column is the Qt type that is used in the prototype of signals and slots for out-parameters. <center>.nf +.TS +l - l. COM type Qt property in-parameter out-parameter VARIANT_BOOL bool bool bool& BSTR QString const QString& QString& char, short, int, long int int int& uchar, ushort, uint, ulong uint uint uint& float, double double double double& DATE QDateTime const QDateTime& QDateTime& CY TQ_LLONG TQ_LLONG TQ_LLONG& OLE_COLOR QColor const QColor& QColor& SAFEARRAY(VARIANT) QValueList<QVariant> const QValueList<QVariant>& QValueList<QVariant>& SAFEARRAY(BYTE) QByteArray const QByteArray& QByteArray& SAFEARRAY(BSTR) QStringList const QStringList& QStringList& VARIANT type-dependent const QVariant& QVariant& IFontDisp* QFont const QFont& QFont& IPictureDisp* QPixmap const QPixmap& QPixmap& IDispatch* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) IUnknown* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) SCODE, DECIMAL \fIunsupported\fR \fIunsupported\fR +.TE +.fi +</center> +.PP +Supported are also enumerations, and typedefs to supported types. +.PP +To call the methods of a COM interface described by the following IDL +.PP +.nf +.br + dispinterface IControl +.br + { +.br + properties: +.br + [id(1)] BSTR text; +.br + [id(2)] IFontDisp *font; +.br +.br + methods: +.br + [id(6)] void showColumn( [in] int i ); +.br + [id(3)] bool addColumn( [in] BSTR t ); +.br + [id(4)] int fillList( [in, out] SAFEARRAY(VARIANT) *list ); +.br + [id(5)] IDispatch *item( [in] int i ); +.br + }; +.br +.fi +use the QAxBase API like this: +.PP +.nf +.br + QAxObject object( "<CLSID>" ); +.br +.br + QString text = object.property( "text" ).toString(); +.br + object.setProperty( "font", QFont( "Times New Roman", 12 ) ); +.br +.br + connect( this, SIGNAL(clicked(int)), &object, SLOT(showColumn(int)) ); +.br + bool ok = object.dynamicCall( "addColumn(const QString&)", "Column 1" ).toBool(); +.br +.br + QValueList<QVariant> varlist; +.br + QValueList<QVariant> parameters; +.br + parameters << QVariant( varlist ); +.br + int n = object.dynamicCall( "fillList(QValueList<QVariant>&)", parameters ).toInt(); +.br +.br + QAxObject *item = object.querySubItem( "item(int)", 5 ); +.br +.fi +.PP +Note that the QValueList the object should fill has to be provided as an element in the parameter list of QVariants. +.PP +If you need to access properties or pass parameters of unsupported datatypes you must access the COM object directly through its IDispatch implementation or other interfaces. Those interfaces can be retrieved through queryInterface(). +.PP +.nf +.br + IUnknown *iface = 0; +.br + activeX->queryInterface( IID_IUnknown, (void**)&iface ); +.br + if ( iface ) { +.br + // use the interface +.br + iface->Release(); +.br + } +.br +.fi +.PP +To get the definition of the COM interfaces you will have to use the header files provided with the component you want to use. Some compilers can also import type libraries using the #import compiler directive. See the component documentation to find out which type libraries you have to import, and how to use them. +.PP +If you need to react to events that pass parameters of unsupported datatypes you can use the generic signal that delivers the event data as provided by the COM event. +.SS "Member Type Documentation" +.SH "QAxBase::PropertyBag" +A QMap<QString,QVariant> that can store properties as name:value pairs. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxBase::QAxBase ( IUnknown * iface = 0 )" +Creates a QAxBase object that wraps the COM object \fIiface\fR. If \fIiface\fR is 0 (the default), use setControl() to instantiate a COM object. +.SH "QAxBase::~QAxBase ()\fC [virtual]\fR" +Shuts down the COM object and destroys the QAxBase object. +.PP +See also clear(). +.SH "QVariant QAxBase::asVariant () const" +Returns a QVariant that wraps the COM object. The variant can then be used as a parameter in e.g. dynamicCall(). +.SH "void QAxBase::clear ()\fC [virtual]\fR" +Disconnects and destroys the COM object. +.PP +If you reimplement this function you must also reimplement the destructor to call clear(), and call this implementation at the end of your clear() function. +.SH "QString QAxBase::control () const" +Returns the name of the COM object wrapped by this QAxBase object. See the "control" property for details. +.SH "void QAxBase::disableClassInfo ()" +Disables the class info generation for this ActiveX container. If you don't require any class information about the ActiveX control use this function to speed up the meta object generation. +.PP +Note that this function must be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). +.SH "void QAxBase::disableEventSink ()" +Disables the event sink implementation for this ActiveX container. If you don't intend to listen to the ActiveX control's events use this function to speed up the meta object generation. +.PP +Some ActiveX controls might be unstable when connected to an event sink. To get OLE events you must use standard COM methods to register your own event sink. Use queryInterface() to get access to the raw COM object. +.PP +Note that this function should be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). +.SH "void QAxBase::disableMetaObject ()" +Disables the meta object generation for this ActiveX container. This also disables the event sink and class info generation. If you don't intend to use the Qt meta object implementation call this function to speed up the meta object generation. +.PP +Some ActiveX controls might be unstable when used with OLE automation. Use standard COM methods to use those controls through the COM interfaces provided by queryInterface(). +.PP +Note that this function must be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). +.SH "QVariant QAxBase::dynamicCall ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Calls the COM object's method \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed. +.PP +If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call. +.PP +.nf +.br + activeX->dynamicCall( "Navigate(const QString&)", "www.trolltech.com" ); +.br +.fi +.PP +Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using +.PP +.nf +.br + activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); +.br +.fi +All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. +.PP +If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. +.PP +.nf +.br + activeX->dynamicCall( "Value", 5 ); +.br + QString text = activeX->dynamicCall( "Text" ).toString(); +.br +.fi +Note that it is faster to get and set properties using QObject::property() and QObject::setProperty(). +.PP +It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly. +.PP +.nf +.br + IWebBrowser2 *webBrowser = 0; +.br + activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); +.br + if ( webBrowser ) { +.br + webBrowser->Navigate2( pvarURL ); +.br + webBrowser->Release(); +.br + } +.br +.fi +.PP +This is also more efficient. +.PP +Example: qutlook/centralwidget.cpp. +.SH "QVariant QAxBase::dynamicCall ( const QCString & function, QValueList<QVariant> & vars )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Calls the COM object's method \fIfunction\fR, passing the parameters in \fIvars\fR, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object. +.PP +The QVariant objects in \fIvars\fR are updated when the method has out-parameters. +.SH "void QAxBase::exception ( int code, const QString & source, const QString & desc, const QString & help )\fC [signal]\fR" +This signal is emitted when the COM object throws an exception while called using the OLE automation interface IDispatch. \fIcode\fR, \fIsource\fR, \fIdesc\fR and \fIhelp\fR provide information about the exception as provided by the COM server and can be used to provide useful feedback to the end user. \fIhelp\fR includes the help file, and the help context ID in brackets, e.g. "filename [id]". +.SH "QString QAxBase::generateDocumentation ()" +Returns a rich text string with documentation for the wrapped COM object. Dump the string to an HTML-file, or use it in e.g. a QTextBrowser widget. +.SH "bool QAxBase::initialize ( IUnknown ** ptr )\fC [virtual protected]\fR" +This virtual function is called by setControl() and creates the requested COM object. \fIptr\fR is set to the object's IUnknown implementation. The function returns TRUE if the object initialization succeeded; otherwise the function returns FALSE. +.PP +The default implementation interprets the string returned by control(), and calls initializeRemote(), initializeLicensed() or initializeActive() if the string matches the respective patterns. If no pattern is matched, or if remote or licensed initialization fails, CoCreateInstance is used directly to create the object. +.PP +See the control property documentation for details about supported patterns. +.PP +The interface returned in \fIptr\fR must be referenced exactly once when this function returns. The interface provided by e.g. CoCreateInstance is already referenced, and there is no need to reference it again. +.SH "bool QAxBase::initializeActive ( IUnknown ** ptr )\fC [protected]\fR" +Returns an active instance running on the current machine, and returns the IUnknown interface to the running object in \fIptr\fR. This function returns TRUE if successful, otherwise returns FALSE. +.PP +This function is called by initialize() if the control string contains the substring "}&". +.PP +See also initialize(). +.SH "bool QAxBase::initializeLicensed ( IUnknown ** ptr )\fC [protected]\fR" +Creates an instance of a licensed control, and returns the IUnknown interface to the object in \fIptr\fR. This functions returns TRUE if successful, otherwise returns FALSE. +.PP +This function is called by initialize() if the control string contains the substring "}:". The license key needs to follow this substring. +.PP +See also initialize(). +.SH "bool QAxBase::initializeRemote ( IUnknown ** ptr )\fC [protected]\fR" +Creates the instance on a remote server, and returns the IUnknown interface to the object in \fIptr\fR. This function returns TRUE if successful, otherwise returns FALSE. +.PP +This function is called by initialize() if the control string contains the substring "/{". The information about the remote machine needs to be provided in front of the substring. +.PP +See also initialize(). +.SH "bool QAxBase::isNull () const" +Returns TRUE if there is no COM object loaded by this wrapper; otherwise return FALSE. +.PP +See also control. +.SH "PropertyBag QAxBase::propertyBag () const" +Returns a name:value map of all the properties exposed by the COM object. +.PP +This is more efficient than getting multiple properties individually if the COM object supports property bags. +.PP +\fBWarning:\fR It is not guaranteed that the property bag implementation of the COM object returns all properties, or that the properties returned are the same as those available through the IDispatch interface. +.SH "void QAxBase::propertyChanged ( const QString & name )\fC [signal]\fR" +If the COM object supports property notification, this signal gets emitted when the property called \fIname\fR is changed. +.SH "bool QAxBase::propertyWritable ( const char * prop ) const\fC [virtual]\fR" +Returns TRUE if the property \fIprop\fR is writable; otherwise returns FALSE. By default, all properties are writable. +.PP +\fBWarning:\fR Depending on the control implementation this setting might be ignored for some properties. +.PP +See also setPropertyWritable() and propertyChanged(). +.SH "long QAxBase::queryInterface ( const QUuid & uuid, void ** iface ) const" +Requests the interface \fIuuid\fR from the COM object and sets the value of \fIiface\fR to the provided interface, or to 0 if the requested interface could not be provided. +.PP +Returns the result of the QueryInterface implementation of the COM object. +.PP +See also control. +.SH "QAxObject * QAxBase::querySubObject ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. +.PP +If \fIname\fR is provided by a method the string must include the full function prototype. +.PP +If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. +.PP +The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. +.PP +COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. +.PP +.nf +.br + QAxWidget outlook( "Outlook.Application" ); +.br + QAxObject *session = outlook.querySubObject( "Session" ); +.br + if ( session ) { +.br + QAxObject *defFolder = session->querySubObject( +.br + "GetDefaultFolder(OlDefaultFolders)", +.br + "olFolderContacts" ); +.br + //... +.br + } +.br +.fi +.PP +Example: qutlook/centralwidget.cpp. +.SH "bool QAxBase::setControl ( const QString & )" +Sets the name of the COM object wrapped by this QAxBase object. See the "control" property for details. +.SH "void QAxBase::setPropertyBag ( const PropertyBag & bag )" +Sets the properties of the COM object to the corresponding values in \fIbag\fR. +.PP +\fBWarning:\fR You should only set property bags that have been returned by the propertyBag function, as it cannot be guaranteed that the property bag implementation of the COM object supports the same properties that are available through the IDispatch interface. +.PP +See also propertyBag(). +.SH "void QAxBase::setPropertyWritable ( const char * prop, bool ok )\fC [virtual]\fR" +Sets the property \fIprop\fR to writable if \fIok\fR is TRUE, otherwise sets \fIprop\fR to be read-only. By default, all properties are writable. +.PP +\fBWarning:\fR Depending on the control implementation this setting might be ignored for some properties. +.PP +See also propertyWritable() and propertyChanged(). +.SH "void QAxBase::signal ( const QString & name, int argc, void * argv )\fC [signal]\fR" +This generic signal gets emitted when the COM object issues the event \fIname\fR. \fIargc\fR is the number of parameters provided by the event (DISPPARAMS.cArgs), and \fIargv\fR is the pointer to the parameter values (DISPPARAMS.rgvarg). Note that the order of parameter values is turned around, ie. the last element of the array is the first parameter in the function. +.PP +.nf +.br + void Receiver::slot( const QString &name, int argc, void *argv ) +.br + { +.br + VARIANTARG *params = (VARIANTARG*)argv; +.br + if ( name.startsWith( "BeforeNavigate2(" ) ) { +.br + IDispatch *pDisp = params[argc-1].pdispVal; +.br + VARIANTARG URL = *params[argc-2].pvarVal; +.br + VARIANTARG Flags = *params[argc-3].pvarVal; +.br + VARIANTARG TargetFrameName = *params[argc-4].pvarVal; +.br + VARIANTARG PostData = *params[argc-5].pvarVal; +.br + VARIANTARG Headers = *params[argc-6].pvarVal; +.br + bool *Cancel = params[argc-7].pboolVal; +.br + } +.br + } +.br +.fi +.PP +Use this signal if the event has parameters of unsupported data types. Otherwise, connect directly to the signal \fIname\fR. +.SS "Property Documentation" +.SH "QString control" +This property holds the name of the COM object wrapped by this QAxBase object. +.PP +Setting this property initilializes the COM object. Any COM object previously set is shut down. +.PP +The most efficient way to set this property is by using the registered component's UUID, e.g. +.PP +.nf +.br + ctrl->setControl( "{8E27C92B-1264-101C-8A2F-040224009C02}" ); +.br +.fi +The second fastest way is to use the registered control's class name (with or without version number), e.g. +.PP +.nf +.br + ctrl->setControl( "MSCal.Calendar" ); +.br +.fi +The slowest, but easiest way to use is to use the control's full name, e.g. +.PP +.nf +.br + ctrl->setControl( "Calendar Control 9.0" ); +.br +.fi +.PP +If the component's UUID is used the following patterns can be used to initialize the control on a remote machine, to initialize a licensed control or to connect to a running object: +.TP +To initialize the control on a different machine use the following pattern: +.IP +.nf +.br + <domain/username>:<password>@server/{8E27C92B-1264-101C-8A2F-040224009C02} +.br +.fi +.TP +To initialize a licensed control use the following pattern: +.IP +.nf +.br + {8E27C92B-1264-101C-8A2F-040224009C02}:<LicenseKey> +.br +.fi +.TP +To connect to an already running object use the following pattern: +.IP +.nf +.br + {8E27C92B-1264-101C-8A2F-040224009C02}& +.br +.fi +The first two patterns can be combined, e.g. to initialize a licensed control on a remote machine: +.PP +.nf +.br + ctrl->setControl("DOMAIN/user:password@server/{8E27C92B-1264-101C-8A2F-040224009C02}:LicenseKey"); +.br +.fi +.PP +The control's read function always returns the control's UUID, if provided including the license key, and the name of the server, but not including the username, the domain or the password. +.PP +Set this property's value with setControl() and get this property's value with control(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxbase.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxbase.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxbindable.3qt b/doc/man/man3/tqaxbindable.3qt new file mode 100644 index 000000000..8415d9dcb --- /dev/null +++ b/doc/man/man3/tqaxbindable.3qt @@ -0,0 +1,152 @@ +'\" t +.TH QAxBindable 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 +QAxBindable \- Interface between a QWidget and an ActiveX client +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxbindable.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAxBindable\fR ()" +.br +.ti -1c +.BI "virtual \fB~QAxBindable\fR ()" +.br +.ti -1c +.BI "virtual QAxAggregated * \fBcreateAggregate\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBreportError\fR ( int code, const QString & src, const QString & desc, const QString & context = QString::null )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "bool \fBrequestPropertyChange\fR ( const char * property )" +.br +.ti -1c +.BI "void \fBpropertyChanged\fR ( const char * property )" +.br +.ti -1c +.BI "IUnknown * \fBclientSite\fR () const" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxBindable class provides an interface between a QWidget and an ActiveX client. +.PP +The functions provided by this class allow an ActiveX control to communicate property changes to a client application. Inherit your control class from both QWidget (directly or indirectly) and this class to get access to this class's functions. The meta object compiler requires you to inherit from QWidget \fIfirst\fR. +.PP +.nf +.br + class MyActiveX : public QWidget, public QAxBindable +.br + { +.br + TQ_OBJECT +.br + TQ_PROPERTY( int value READ value WRITE setValue ) +.br + public: +.br + MyActiveX( QWidget *parent = 0, const char *name = 0 ); +.br + ... +.br +.br + int value() const; +.br + void setValue( int ); +.br + }; +.br +.fi +.PP +When implementing the property write function, use requestPropertyChange() to get permission from the ActiveX client application to change this property. When the property changes, call propertyChanged() to notify the ActiveX client application about the change. If a fatal error occurs in the control, use the static reportError() function to notify the client. +.PP +Use the interface returned by clientSite() to call the ActiveX client. To implement additional COM interfaces in your ActiveX control, reimplement createAggregate() to return a new object of a QAxAggregated subclass. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxBindable::QAxBindable ()" +Constructs an empty QAxBindable object. +.SH "QAxBindable::~QAxBindable ()\fC [virtual]\fR" +Destroys the QAxBindable object. +.SH "IUnknown * QAxBindable::clientSite () const\fC [protected]\fR" +Returns a pointer to the client site interface for this ActiveX object, or null if no client site has been set. +.PP +Call QueryInterface() on the returned interface to get the interface you want to call. +.SH "QAxAggregated * QAxBindable::createAggregate ()\fC [virtual]\fR" +Reimplement this function when you want to implement additional COM interfaces in the ActiveX control, or when you want to provide alternative implementations of COM interfaces. Return a new object of a QAxAggregated subclass. +.PP +The default implementation returns the null pointer. +.SH "void QAxBindable::propertyChanged ( const char * property )\fC [protected]\fR" +Call this function to notify the client that is hosting this ActiveX control that the property \fIproperty\fR has been changed. +.PP +This function is usually called at the end of the property's write function. +.PP +See also requestPropertyChange(). +.SH "void QAxBindable::reportError ( int code, const QString & src, const QString & desc, const QString & context = QString::null )\fC [static]\fR" +Reports an error to the client application. \fIcode\fR is a control-defined error code. \fIdesc\fR is a human-readable description of the error intended for the application user. \fIsrc\fR is the name of the source for the error, typically the ActiveX server name. \fIcontext\fR can be the location of a help file with more information about the error. If \fIcontext\fR ends with a number in brackets, e.g. [12], this number will be interpreted as the context ID in the help file. +.SH "bool QAxBindable::requestPropertyChange ( const char * property )\fC [protected]\fR" +Call this function to request permission to change the property \fIproperty\fR from the client that is hosting this ActiveX control. Returns TRUE if the client allows the change; otherwise returns FALSE. +.PP +This function is usually called first in the write function for \fIproperty\fR, and writing is abandoned if the function returns FALSE. +.PP +.nf +.br + void MyActiveQt::setText( const QString &text ) +.br + { +.br + if ( !requestPropertyChange( "text" ) ) +.br + return; +.br +.br + // update property +.br +.br + propertyChanged( "text" ); +.br + } +.br +.fi +.PP +See also propertyChanged(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxbindable.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxbindable.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxfactory.3qt b/doc/man/man3/tqaxfactory.3qt new file mode 100644 index 000000000..59b4a0822 --- /dev/null +++ b/doc/man/man3/tqaxfactory.3qt @@ -0,0 +1,436 @@ +'\" t +.TH QAxFactory 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 +QAxFactory \- Defines a factory for the creation of COM components +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxfactory.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAxFactory\fR ( const QUuid & libid, const QUuid & appid )" +.br +.ti -1c +.BI "virtual \fB~QAxFactory\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBfeatureList\fR () const = 0" +.br +.ti -1c +.BI "virtual QWidget * \fBcreate\fR ( const QString & key, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual QObject * \fBcreateObject\fR ( const QString & key, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual QMetaObject * \fBmetaObject\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual bool \fBcreateObjectWrapper\fR ( QObject * object, IDispatch ** wrapper )" +.br +.ti -1c +.BI "virtual QUuid \fBclassID\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual QUuid \fBinterfaceID\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual QUuid \fBeventsID\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual QUuid \fBtypeLibID\fR () const" +.br +.ti -1c +.BI "virtual QUuid \fBappID\fR () const" +.br +.ti -1c +.BI "virtual void \fBregisterClass\fR ( const QString & key, QSettings * settings ) const" +.br +.ti -1c +.BI "virtual void \fBunregisterClass\fR ( const QString & key, QSettings * settings ) const" +.br +.ti -1c +.BI "virtual bool \fBvalidateLicenseKey\fR ( const QString & key, const QString & licenseKey ) const" +.br +.ti -1c +.BI "virtual QString \fBexposeToSuperClass\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual bool \fBstayTopLevel\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual bool \fBhasStockEvents\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual bool \fBisService\fR () const" +.br +.ti -1c +.BI "enum \fBServerType\fR { SingleInstance, MultipleInstances }" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBisServer\fR ()" +.br +.ti -1c +.BI "QString \fBserverDirPath\fR ()" +.br +.ti -1c +.BI "QString \fBserverFilePath\fR ()" +.br +.ti -1c +.BI "bool \fBstartServer\fR ( ServerType type = MultipleInstances )" +.br +.ti -1c +.BI "bool \fBstopServer\fR ()" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxFactory class defines a factory for the creation of COM components. +.PP + +.PP +Implement this factory once in your ActiveX server to provide information about the components the server can create. If your server supports just a single ActiveX control, you can use the default factory implementation instead of implementing the factory yourself. Use the QAXFACTORY_DEFAULT macro in any implementation file (e.g. main.cpp) to instantiate and export the default factory: +.PP +.nf +.br + #include <ntqapplication.h> +.br + #include <qaxfactory.h> +.br +.br + #include "theactivex.h" +.br +.br + QAXFACTORY_DEFAULT( +.br + TheActiveX, // widget class +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}", // class ID +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}", // interface ID +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}", // event interface ID +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID +.br + ) +.br +.fi +.PP +If you implement your own factory reimplement the pure virtual functions, provide the unique identifiers for the ActiveX controls, and use the QAXFACTORY_EXPORT macro to instantiate and export it: +.PP +.nf +.br + QStringList ActiveQtFactory::featureList() const +.br + { +.br + QStringList list; +.br + list << "ActiveX1"; +.br + list << "ActiveX2"; +.br + ... +.br + return list; +.br + } +.br +.br + QWidget *ActiveQtFactory::create( const QString &key, QWidget *parent, const char *name ) +.br + { +.br + if ( key == "ActiveX1" ) +.br + return new ActiveX1( parent, name ); +.br + if ( key == "ActiveX2" ) +.br + return new ActiveX2( parent, name ); +.br + ... +.br + return 0; +.br + } +.br +.br + QUuid ActiveQtFactory::classID( const QString &key ) const +.br + { +.br + if ( key == "ActiveX1" ) +.br + return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; +.br + ... +.br + return QUuid(); +.br + } +.br +.br + QUuid ActiveQtFactory::interfaceID( const QString &key ) const +.br + { +.br + if ( key == "ActiveX1" ) +.br + return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; +.br + ... +.br + return QUuid(); +.br + } +.br +.br + QUuid ActiveQtFactory::eventsID( const QString &key ) const +.br + { +.br + if ( key == "ActiveX1" ) +.br + return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; +.br + ... +.br + return QUuid(); +.br + } +.br +.br + QAXFACTORY_EXPORT( +.br + MyFactory, // factory class +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID +.br + ) +.br +.fi +.PP +If you use the \fCTQ_CLASSINFO\fR macro to provide the unique identifiers or other attributes for your class you can use the QAXFACTORY_BEGIN, QAXCLASS and QAXFACTORY_END macros to expose one or more classes as COM objects. +.PP +.nf +.br + QAXFACTORY_BEGIN( +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID +.br + "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID +.br + ) +.br + QAXCLASS(Class1) +.br + QAXCLASS(Class2) +.br + QAXFACTORY_END() +.br +.fi +.PP +Only one QAxFactory implementation may be instantiated and exported by an ActiveX server application. This instance is accessible through the global qAxFactory() function. +.PP +A factory can also reimplement the registerClass() and unregisterClass() functions to set additional flags for an ActiveX control in the registry. To limit the number of methods or properties a widget class exposes from its parent classes reimplement exposeToSuperClass(). +.SS "Member Type Documentation" +.SH "QAxFactory::ServerType" +This enum specifies the different types of servers that can be started with startServer. +.TP +\fCQAxFactory::SingleInstance\fR - The server can create only one instance of each supplied class. +.TP +\fCQAxFactory::MultipleInstances\fR - The server can create multiple instances of each supplied class. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxFactory::QAxFactory ( const QUuid & libid, const QUuid & appid )" +Constructs a QAxFactory object that returns \fIlibid\fR and \fIappid\fR in the implementation of the respective interface functions. +.SH "QAxFactory::~QAxFactory ()\fC [virtual]\fR" +Destroys the QAxFactory object. +.SH "QUuid QAxFactory::appID () const\fC [virtual]\fR" +Reimplement this function to return the ActiveX server's application identifier. +.SH "QUuid QAxFactory::classID ( const QString & key ) const\fC [virtual]\fR" +Reimplement this function to return the class identifier for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. +.PP +The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "ClassID". +.SH "QWidget * QAxFactory::create ( const QString & key, QWidget * parent = 0, const char * name = 0 )\fC [virtual]\fR" +Reimplement this function to return a new widget for \fIkey\fR. Propagate \fIparent\fR and \fIname\fR to the QWidget constructor. Return 0 if this factory doesn't support the value of \fIkey\fR. +.PP +The returned widget will be exposed as an ActiveX control, e.g. a COM object that can be embedded as a control into applications. +.PP +The default implementation returns 0. +.SH "QObject * QAxFactory::createObject ( const QString & key, QObject * parent = 0, const char * name = 0 )\fC [virtual]\fR" +Reimplement this function to return a new object for \fIkey\fR. Propagate \fIparent\fR and \fIname\fR to the QWidget constructor. Return 0 if this factory doesn't support the value of \fIkey\fR. +.PP +If the object returned is a QWidget it will be exposed as an ActiveX control, otherwise the returned object will be exposed as a COM object. +.PP +The default implementation returns the result QAxFactory::create() if \fIparent\fR is 0 or a widget, otherwise returns 0. +.SH "bool QAxFactory::createObjectWrapper ( QObject * object, IDispatch ** wrapper )\fC [virtual]\fR" +Reimplement this function to provide the COM object for \fIobject\fR in \fIwrapper\fR. Return TRUE if the function was successfull, otherwise return FALSE. +.PP +The default implementation creates a generic automation wrapper based on the meta object information of \fIobject\fR. +.SH "QUuid QAxFactory::eventsID ( const QString & key ) const\fC [virtual]\fR" +Reimplement this function to return the identifier of the event interface for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. +.PP +The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "EventsID". +.SH "QString QAxFactory::exposeToSuperClass ( const QString & key ) const\fC [virtual]\fR" +Reimplement this function to return the name of the super class of \fIkey\fR up to which methods and properties should be exposed by the ActiveX control. +.PP +The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "ToSuperClass". If no such value is set the null-string is returned, and the functions and properties of all the super classes including QWidget will be exposed. +.PP +To only expose the functions and properties of the class itself, reimplement this function to return \fIkey\fR. +.SH "QStringList QAxFactory::featureList () const\fC [pure virtual]\fR" +Reimplement this function to return a list of the widgets (class names) supported by this factory. +.SH "bool QAxFactory::hasStockEvents ( const QString & key ) const\fC [virtual]\fR" +Reimplement this function to return TRUE if the ActiveX control \fIkey\fR should support the standard ActiveX events +.TP +Click +.TP +DblClick +.TP +KeyDown +.TP +KeyPress +.TP +KeyUp +.TP +MouseDown +.TP +MouseUp +.TP +MouseMove +.PP +The default implementation interprets \fIkey\fR as the class name, and returns TRUE if the value of the TQ_CLASSINFO entry "StockEvents" is "yes". Otherwise this function returns FALSE. +.SH "QUuid QAxFactory::interfaceID ( const QString & key ) const\fC [virtual]\fR" +Reimplement this function to return the interface identifier for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. +.PP +The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "InterfaceID". +.SH "bool QAxFactory::isServer ()\fC [static]\fR" +Returns TRUE if the application has been started (by COM) as an ActiveX server, otherwise returns FALSE. +.PP +.nf +.br + int main( int argc, char**argv ) +.br + { +.br + QApplication app( argc, argv ); +.br +.br + if ( !QAxFactory::isServer() ) { +.br + // initialize for stand-alone execution +.br + } +.br +.br + return app.exec() // standard event processing +.br + } +.br +.fi +.SH "bool QAxFactory::isService () const\fC [virtual]\fR" +Reimplement this function to return TRUE if the server is running as a persistent service (e.g. an NT service) and should not terminate even when all objects provided have been released. +.PP +The default implementation returns FALSE. +.SH "QMetaObject * QAxFactory::metaObject ( const QString & key ) const\fC [virtual]\fR" +Reimplement this function to return the QMetaObject corresponding to \fIkey\fR, or 0 if this factory doesn't support the value of \fIkey\fR. +.PP +The default implementation returns the QMetaObject for the class \fIkey\fR. +.SH "void QAxFactory::registerClass ( const QString & key, QSettings * settings ) const\fC [virtual]\fR" +Registers additional values for the class \fIkey\fR in the system registry using the \fIsettings\fR object. The standard values have already been registed by the framework, but additional values, e.g. implemented categories, can be added in an implementation of this function. +.PP +.nf +.br + settings->writeEntry( "/CLSID/" + classID(key) + "/Implemented Categories/{00000000-0000-0000-000000000000}/.", QString::null ); +.br +.fi +.PP +If you reimplement this function you must also reimplement unregisterClass() to remove the additional registry values. +.PP +See also QSettings. +.SH "QString QAxFactory::serverDirPath ()\fC [static]\fR" +Returns the directory that contains the server binary. +.PP +For out-of-process servers this is the same as QApplication::applicationDirPath(). For in-process servers that function returns the directory that contains the hosting application. +.SH "QString QAxFactory::serverFilePath ()\fC [static]\fR" +Returns the file path of the server binary. +.PP +For out-of-process servers this is the same as QApplication::applicationFilePath(). For in-process servers that function returns the file path of the hosting application. +.SH "bool QAxFactory::startServer ( ServerType type = MultipleInstances )\fC [static]\fR" +Starts the COM server with \fItype\fR and returns TRUE if successful, otherwise returns FALSE. +.PP +Calling this function if the server is already running (or for an in-process server) does nothing and returns TRUE. +.PP +The server is started automatically with \fItype\fR set to MultipleUse if the server executable has been started with the \fC-activex\fR command line parameter. +.SH "bool QAxFactory::stayTopLevel ( const QString & key ) const\fC [virtual]\fR" +Reimplement this function to return TRUE if the ActiveX control \fIkey\fR should be a top level window, e.g. a dialog. The default implementation returns FALSE. +.SH "bool QAxFactory::stopServer ()\fC [static]\fR" +Stops the COM server and returns TRUE if successful, otherwise returns FALSE. +.PP +Calling this function if the server is not running (or for an in-process server) does nothing and returns TRUE. +.PP +Stopping the server will not invalidate existing objects, but no new objects can be created from the existing server process. Usually COM will start a new server process if additional objects are requested. +.PP +The server is stopped automatically when the main() function returns. +.SH "QUuid QAxFactory::typeLibID () const\fC [virtual]\fR" +Reimplement this function to return the ActiveX server's type library identifier. +.SH "void QAxFactory::unregisterClass ( const QString & key, QSettings * settings ) const\fC [virtual]\fR" +Unregisters any additional values for the class \fIkey\fR from the system registry using the \fIsettings\fR object. +.PP +.nf +.br + settings->removeEntry( "/CLSID/" + classID(key) + "/Implemented Categories/{00000000-0000-0000-000000000000}/." ); +.br +.fi +.PP +See also registerClass() and QSettings. +.SH "bool QAxFactory::validateLicenseKey ( const QString & key, const QString & licenseKey ) const\fC [virtual]\fR" +Reimplement this function to return TRUE if \fIlicenseKey\fR is a valid license for the class \fIkey\fR, or if the current machine is licensed. +.PP +The default implementation returns TRUE if the class \fIkey\fR is not +licensed (ie. no TQ_CLASSINFO attribute "LicenseKey"), or if +\fIlicenseKey\fR matches the value of the "LicenseKey" attribute, or +if the machine is licensed through a .LIC file with the same filename +as this COM server. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxobject.3qt b/doc/man/man3/tqaxobject.3qt new file mode 100644 index 000000000..d42203cf3 --- /dev/null +++ b/doc/man/man3/tqaxobject.3qt @@ -0,0 +1,183 @@ +'\" t +.TH QAxObject 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 +QAxObject \- QObject that wraps a COM object +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxobject.h>\fR +.PP +Inherits QObject and QAxBase. +.PP +Inherited by QAxScriptEngine. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAxObject\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQAxObject\fR ( const QString & c, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQAxObject\fR ( IUnknown * iface, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QAxObject\fR ()" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "QVariant \fBdynamicCall\fR ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.ti -1c +.BI "QVariant \fBdynamicCall\fR ( const QCString & function, QValueList<QVariant> & vars )" +.br +.ti -1c +.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxObject class provides a QObject that wraps a COM object. +.PP +A QAxObject can be instantiated as an empty object, with the name of the COM object it should wrap, or with a pointer to the IUnknown that represents an existing COM object. If the COM object implements the IDispatch interface, the properties, methods and events of that object become available as Qt properties, slots and signals. The base class, QAxBase, provides an API to access the COM object directly through the IUnknown pointer. +.PP +QAxObject is a QObject and can be used as such, e.g. it can be organized in an object hierarchy, receive events and connect to signals and slots. +.PP +\fBWarning:\fR You can subclass QAxObject, but you cannot use the TQ_OBJECT macro in the subclass (the generated moc-file will not compile), so you cannot add further signals, slots or properties. This limitation is due to the metaobject information generated in runtime. To work around this problem, aggregate the QAxObject as a member of the QObject subclass. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxObject::QAxObject ( QObject * parent = 0, const char * name = 0 )" +Creates an empty COM object and propagates \fIparent\fR and \fIname\fR to the QObject constructor. To initialize the object, call setControl. +.SH "QAxObject::QAxObject ( const QString & c, QObject * parent = 0, const char * name = 0 )" +Creates a QAxObject that wraps the COM object \fIc\fR. \fIparent\fR and \fIname\fR are propagated to the QWidget contructor. +.PP +See also control. +.SH "QAxObject::QAxObject ( IUnknown * iface, QObject * parent = 0, const char * name = 0 )" +Creates a QAxObject that wraps the COM object referenced by \fIiface\fR. \fIparent\fR and \fIname\fR are propagated to the QObject contructor. +.SH "QAxObject::~QAxObject ()" +Releases the COM object and destroys the QAxObject, cleaning up all allocated resources. +.SH "QVariant QAxBase::dynamicCall ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Calls the COM object's method \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed. +.PP +If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call. +.PP +.nf +.br + activeX->dynamicCall( "Navigate(const QString&)", "www.trolltech.com" ); +.br +.fi +.PP +Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using +.PP +.nf +.br + activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); +.br +.fi +All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. +.PP +If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. +.PP +.nf +.br + activeX->dynamicCall( "Value", 5 ); +.br + QString text = activeX->dynamicCall( "Text" ).toString(); +.br +.fi +Note that it is faster to get and set properties using QObject::property() and QObject::setProperty(). +.PP +It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly. +.PP +.nf +.br + IWebBrowser2 *webBrowser = 0; +.br + activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); +.br + if ( webBrowser ) { +.br + webBrowser->Navigate2( pvarURL ); +.br + webBrowser->Release(); +.br + } +.br +.fi +.PP +This is also more efficient. +.PP +Example: qutlook/centralwidget.cpp. +.SH "QVariant QAxBase::dynamicCall ( const QCString & function, QValueList<QVariant> & vars )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Calls the COM object's method \fIfunction\fR, passing the parameters in \fIvars\fR, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object. +.PP +The QVariant objects in \fIvars\fR are updated when the method has out-parameters. +.SH "QAxObject * QAxBase::querySubObject ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. +.PP +If \fIname\fR is provided by a method the string must include the full function prototype. +.PP +If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. +.PP +The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. +.PP +COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. +.PP +.nf +.br + QAxWidget outlook( "Outlook.Application" ); +.br + QAxObject *session = outlook.querySubObject( "Session" ); +.br + if ( session ) { +.br + QAxObject *defFolder = session->querySubObject( +.br + "GetDefaultFolder(OlDefaultFolders)", +.br + "olFolderContacts" ); +.br + //... +.br + } +.br +.fi +.PP +Example: qutlook/centralwidget.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxobject.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxobject.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxscript.3qt b/doc/man/man3/tqaxscript.3qt new file mode 100644 index 000000000..5b7d776e1 --- /dev/null +++ b/doc/man/man3/tqaxscript.3qt @@ -0,0 +1,169 @@ +'\" t +.TH QAxScript 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 +QAxScript \- Wrapper around script code +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxscript.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBFunctionFlags\fR { FunctionNames = 0, FunctionSignatures }" +.br +.ti -1c +.BI "\fBQAxScript\fR ( const QString & name, QAxScriptManager * manager )" +.br +.ti -1c +.BI "\fB~QAxScript\fR ()" +.br +.ti -1c +.BI "bool \fBload\fR ( const QString & code, const QString & language = QString::null )" +.br +.ti -1c +.BI "QStringList \fBfunctions\fR ( FunctionFlags flags = FunctionNames ) const" +.br +.ti -1c +.BI "QString \fBscriptCode\fR () const" +.br +.ti -1c +.BI "QString \fBscriptName\fR () const" +.br +.ti -1c +.BI "QAxScriptEngine * \fBscriptEngine\fR () const" +.br +.ti -1c +.BI "QVariant \fBcall\fR ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.ti -1c +.BI "QVariant \fBcall\fR ( const QString & function, QValueList<QVariant> & arguments )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBentered\fR ()" +.br +.ti -1c +.BI "void \fBfinished\fR ()" +.br +.ti -1c +.BI "void \fBfinished\fR ( const QVariant & result )" +.br +.ti -1c +.BI "void \fBfinished\fR ( int code, const QString & source, const QString & description, const QString & help )" +.br +.ti -1c +.BI "void \fBstateChanged\fR ( int state )" +.br +.ti -1c +.BI "void \fBerror\fR ( int code, const QString & description, int sourcePosition, const QString & sourceText )" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxScript class provides a wrapper around script code. +.PP +Every instance of the QAxScript class represents a piece of scripting code in a particular scripting language. The code is loaded into the script engine using load(). Functions declared in the code can be called using call(). +.PP +The script provides scriptEngine() provides feedback to the application through signals. The most important signal is the error() signal. Direct access to the QAxScriptEngine is provided through the scriptEngine() function. +.PP +\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. +.SS "Member Type Documentation" +.SH "QAxScript::FunctionFlags" +This FunctionFlags enum describes formatting for function introspection. +.TP +\fCQAxScript::FunctionNames\fR - Only function names are returned. +.TP +\fCQAxScript::FunctionSignatures\fR - Returns the functions with signatures. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxScript::QAxScript ( const QString & name, QAxScriptManager * manager )" +Constructs a QAxScript object called \fIname\fR and registers it with the QAxScriptManager \fImanager\fR. This is usually done by the QAxScriptManager class when loading a script. +.PP +A script should always have a name. A manager is necessary to allow the script code to reference objects in the application. The \fImanager\fR takes ownership of the object. +.SH "QAxScript::~QAxScript ()" +Destroys the object, releasing all allocated resources. +.SH "QVariant QAxScript::call ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Calls \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR as arguments and returns the value returned by the function, or an invalid QVariant if the function does not return a value or when the function call failed. +.PP +See QAxScriptManager::call() for more information about how to call script functions. +.SH "QVariant QAxScript::call ( const QString & function, QValueList<QVariant> & arguments )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Calls \fIfunction\fR passing \fIarguments\fR as parameters, and returns the result. Returns when the script's execution has finished. +.PP +See QAxScriptManager::call() for more information about how to call script functions. +.SH "void QAxScript::entered ()\fC [signal]\fR" +This signal is emitted when a script engine has started executing code. +.SH "void QAxScript::error ( int code, const QString & description, int sourcePosition, const QString & sourceText )\fC [signal]\fR" +This signal is emitted when an execution error occured while running a script. +.PP +\fIcode\fR, \fIdescription\fR, \fIsourcePosition\fR and \fIsourceText\fR contain information about the execution error. +.SH "void QAxScript::finished ()\fC [signal]\fR" +This signal is emitted when a script engine has finished executing code. +.SH "void QAxScript::finished ( const QVariant & result )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIresult\fR contains the script's result. This will be an invalid QVariant if the script has no return value. +.SH "void QAxScript::finished ( int code, const QString & source, const QString & description, const QString & help )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIcode\fR, \fIsource\fR, \fIdescription\fR and \fIhelp\fR contain exception information when the script terminated. +.SH "QStringList QAxScript::functions ( FunctionFlags flags = FunctionNames ) const" +Returns a list of all the functions in this script if the respective script engine supports introspection; otherwise returns an empty list. The functions are either provided with full prototypes or only as names, depending on the value of \fIflags\fR. +.PP +See also QAxScriptEngine::hasIntrospection(). +.SH "bool QAxScript::load ( const QString & code, const QString & language = QString::null )" +Loads the script source \fIcode\fR written in language \fIlanguage\fR into the script engine. Returns TRUE if \fIcode\fR was successfully entered into the script engine; otherwise returns FALSE. +.PP +If \fIlanguage\fR is empty (the default) it will be determined heuristically. If \fIcode\fR contains the string \fCEnd Sub\fR it will be interpreted as VBScript, otherwise as JScript. Additional scripting languages can be registered using QAxScript::registerEngine(). +.PP +This function can only be called once for each QAxScript object, which is done automatically when using QAxScriptManager::load(). +.SH "QString QAxScript::scriptCode () const" +Returns the script's code, or the null-string if no code has been loaded yet. +.PP +See also load(). +.SH "QAxScriptEngine * QAxScript::scriptEngine () const" +Returns a pointer to the script engine. +.PP +You can use the object returned to connect signals to the script functions, or to access the script engine directly. +.SH "QString QAxScript::scriptName () const" +Returns the name of the script. +.SH "void QAxScript::stateChanged ( int state )\fC [signal]\fR" +This signal is emitted when a script engine changes state. +\fIstate\fR can be any value in the QAxScriptEngineState enumeration. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxscript.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxscript.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxscriptengine.3qt b/doc/man/man3/tqaxscriptengine.3qt new file mode 100644 index 000000000..b4b8f9ee9 --- /dev/null +++ b/doc/man/man3/tqaxscriptengine.3qt @@ -0,0 +1,123 @@ +'\" t +.TH QAxScriptEngine 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 +QAxScriptEngine \- Wrapper around a script engine +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxscript.h>\fR +.PP +Inherits QAxObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBState\fR { Uninitialized = 0, Initialized = 5, Started = 1, Connected = 2, Disconnected = 3, Closed = 4 }" +.br +.ti -1c +.BI "\fBQAxScriptEngine\fR ( const QString & language, QAxScript * script )" +.br +.ti -1c +.BI "\fB~QAxScriptEngine\fR ()" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "bool \fBhasIntrospection\fR () const" +.br +.ti -1c +.BI "QString \fBscriptLanguage\fR () const" +.br +.ti -1c +.BI "State \fBstate\fR () const" +.br +.ti -1c +.BI "void \fBsetState\fR ( State st )" +.br +.ti -1c +.BI "void \fBaddItem\fR ( const QString & name )" +.br +.ti -1c +.BI "long \fBqueryInterface\fR ( const QUuid & uuid, void ** iface ) const" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxScriptEngine class provides a wrapper around a script engine. +.PP +Every instance of the QAxScriptEngine class represents an interpreter for script code in a particular scripting language. The class is usually not used directly. The QAxScript and QAxScriptManager classes provide convenient functions to handle and call script code. +.PP +Direct access to the script engine is provided through queryInterface(). +.PP +\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. +.SS "Member Type Documentation" +.SH "QAxScriptEngine::State" +The State enumeration defines the different states a script engine can be in. +.TP +\fCQAxScriptEngine::Uninitialized\fR - The script has been created, but not yet initialized +.TP +\fCQAxScriptEngine::Initialized\fR - The script has been initialized, but is not running +.TP +\fCQAxScriptEngine::Started\fR - The script can execute code, but does not yet handle events +.TP +\fCQAxScriptEngine::Connected\fR - The script can execute code and is connected so that it can handle events +.TP +\fCQAxScriptEngine::Disconnected\fR - The script is loaded, but is not connected to event sources +.TP +\fCQAxScriptEngine::Closed\fR - The script has been closed. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxScriptEngine::QAxScriptEngine ( const QString & language, QAxScript * script )" +Constructs a QAxScriptEngine object interpreting script code in \fIlanguage\fR provided by the code in \fIscript\fR. This is usually done by the QAxScript class when loading a script. +.PP +Instances of QAxScriptEngine should always have both a language and a script. +.SH "QAxScriptEngine::~QAxScriptEngine ()" +Destroys the QAxScriptEngine object, releasing all allocated resources. +.SH "void QAxScriptEngine::addItem ( const QString & name )" +Registers an item with the script engine. Script code can refer to this item using \fIname\fR. +.SH "bool QAxScriptEngine::hasIntrospection () const" +Returns TRUE if the script engine supports introspection; otherwise returns FALSE. +.SH "bool QAxScriptEngine::isValid () const" +Returns TRUE if the script engine has been initialized correctly; otherwise returns FALSE. +.SH "long QAxScriptEngine::queryInterface ( const QUuid & uuid, void ** iface ) const" +Requests the interface \fIuuid\fR from the script engine object and sets the value of \fIiface\fR to the provided interface, or to 0 if the requested interface could not be provided. +.PP +Returns the result of the QueryInterface implementation of the COM object. +.SH "QString QAxScriptEngine::scriptLanguage () const" +Returns the scripting language, for example "VBScript", or "JScript". +.SH "void QAxScriptEngine::setState ( State st )" +Sets the state of the script engine to \fIst\fR. Calling this function is usually not necessary. +.SH "State QAxScriptEngine::state () const" +Returns the state of the script engine. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxscriptengine.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxscriptengine.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxscriptmanager.3qt b/doc/man/man3/tqaxscriptmanager.3qt new file mode 100644 index 000000000..f7d59d273 --- /dev/null +++ b/doc/man/man3/tqaxscriptmanager.3qt @@ -0,0 +1,197 @@ +'\" t +.TH QAxScriptManager 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 +QAxScriptManager \- Bridge between application objects and script code +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxscript.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAxScriptManager\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QAxScriptManager\fR ()" +.br +.ti -1c +.BI "void \fBaddObject\fR ( QAxBase * object )" +.br +.ti -1c +.BI "void \fBaddObject\fR ( QObject * object )" +.br +.ti -1c +.BI "QStringList \fBfunctions\fR ( QAxScript::FunctionFlags flags = QAxScript::FunctionNames ) const" +.br +.ti -1c +.BI "QStringList \fBscriptNames\fR () const" +.br +.ti -1c +.BI "QAxScript * \fBscript\fR ( const QString & name ) const" +.br +.ti -1c +.BI "QAxScript * \fBload\fR ( const QString & code, const QString & name, const QString & language )" +.br +.ti -1c +.BI "QAxScript * \fBload\fR ( const QString & file, const QString & name )" +.br +.ti -1c +.BI "QVariant \fBcall\fR ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.ti -1c +.BI "QVariant \fBcall\fR ( const QString & function, QValueList<QVariant> & arguments )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBerror\fR ( QAxScript * script, int code, const QString & description, int sourcePosition, const QString & sourceText )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBregisterEngine\fR ( const QString & name, const QString & extension, const QString & code = QString ( ) )" +.br +.ti -1c +.BI "QString \fBscriptFileFilter\fR ()" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxScriptManager class provides a bridge between application objects and script code. +.PP +The QAxScriptManager acts as a bridge between the COM objects embedded in the Qt application through QAxObject or QAxWidget, and the scripting languages available through the Windows Script technologies, usually JScript and VBScript. +.PP +Create one QAxScriptManager for each separate document in your application, and add the COM objects the scripts need to access using addObject(). Then load() the script sources and invoke the functions using call(). +.PP +\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxScriptManager::QAxScriptManager ( QObject * parent = 0, const char * name = 0 )" +Creates a QAxScriptManager object. \fIparent\fR and \fIname\fR are passed on to the QObject constructor. +.PP +It is usual to create one QAxScriptManager for each document in an application. +.SH "QAxScriptManager::~QAxScriptManager ()" +Destroys the objects, releasing all allocated resources. +.SH "void QAxScriptManager::addObject ( QAxBase * object )" +Adds \fIobject\fR to the manager. Scripts handled by this manager can access the object in the code using the object's name property. +.PP +You must add all the necessary objects before loading any scripts. +.SH "void QAxScriptManager::addObject ( QObject * object )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a generic COM wrapper for \fIobject\fR to the manager. \fIobject\fR must be exposed as a COM object using the functionality provided by the QAxServer module.. Applications using this function you must link against the qaxserver library. +.SH "QVariant QAxScriptManager::call ( const QString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Calls \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR as arguments and returns the value returned by the function, or an invalid QVariant if the function does not return a value or when the function call failed. The call returns when the script's execution has finished. +.PP +In most script engines the only supported parameter type is "const QVariant&", for example, to call a JavaScript function +.PP +.nf +.br + function setNumber(number) +.br + { +.br + n = number; +.br + } +.br +.fi +use +.PP +.nf +.br + QValueList args; +.br + args << 5; +.br + script->call("setNumber(const QVariant&)", args); +.br +.fi +As with dynamicCall the parameters can directly be embedded in the function string. +.PP +.nf +.br + script->call("setNumber(5)"); +.br +.fi +However, this is slower. +.PP +Functions provided by script engines that don't support introspection are not available and must be called directly using QAxScript::call() on the respective script object. +.PP +Note that calling this function can be significantely slower than using call() on the respective QAxScript directly. +.SH "QVariant QAxScriptManager::call ( const QString & function, QValueList<QVariant> & arguments )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Calls \fIfunction\fR passing \fIarguments\fR as parameters, and returns the result. Returns when the script's execution has finished. +.SH "void QAxScriptManager::error ( QAxScript * script, int code, const QString & description, int sourcePosition, const QString & sourceText )\fC [signal]\fR" +This signal is emitted when an execution error occured while running \fIscript\fR. +.PP +\fIcode\fR, \fIdescription\fR, \fIsourcePosition\fR and \fIsourceText\fR contain information about the execution error. +.SH "QStringList QAxScriptManager::functions ( QAxScript::FunctionFlags flags = QAxScript::FunctionNames ) const" +Returns a list with all the functions that are available. Functions provided by script engines that don't support introspection are not included in the list. The functions are either provided with full prototypes or only as names, depending on the value of \fIflags\fR. +.SH "QAxScript * QAxScriptManager::load ( const QString & code, const QString & name, const QString & language )" +Loads the script source \fIcode\fR using the script engine for \fIlanguage\fR. The script can later be referred to using its \fIname\fR which should not be empty. +.PP +The function returns a pointer to the script for the given \fIcode\fR if the \fIcode\fR was loaded successfully; otherwise it returns 0. +.PP +If \fIlanguage\fR is empty it will be determined heuristically. If \fIcode\fR contains the string "End Sub" it will be interpreted as VBScript, otherwise as JScript. Additional script engines can be registered using registerEngine(). +.PP +You must add all the objects necessary (using addObject()) \fIbefore\fR loading any scripts. If \fIcode\fR declares a function that is already available (no matter in which language) the first function is overloaded and can no longer be called via call(); but it will still be available by calling its script directly. +.PP +See also addObject(), scriptNames(), and functions(). +.SH "QAxScript * QAxScriptManager::load ( const QString & file, const QString & name )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Loads the source code from the \fIfile\fR. The script can later be referred to using its \fIname\fR which should not be empty. +.PP +The function returns a pointer to the script engine for the code in \fIfile\fR if \fIfile\fR was loaded successfully; otherwise it returns 0. +.PP +The script engine used is determined from the file's extension. By default ".js" files are interpreted as JScript files, and ".vbs" and ".dsm" files are interpreted as VBScript. Additional script engines can be registered using registerEngine(). +.SH "bool QAxScriptManager::registerEngine ( const QString & name, const QString & extension, const QString & code = QString ( ) )\fC [static]\fR" +Registers the script engine called \fIname\fR and returns TRUE if the engine was found; otherwise does nothing and returns FALSE. +.PP +The script engine will be used when loading files with the given \fIextension\fR, or when loading source code that contains the string \fIcode\fR. +.SH "QAxScript * QAxScriptManager::script ( const QString & name ) const" +Returns the script called \fIname\fR. +.PP +You can use the returned pointer to call functions directly through QAxScript::call(), to access the script engine directly, or to delete and thus unload the script. +.SH "QString QAxScriptManager::scriptFileFilter ()\fC [static]\fR" +Returns a file filter listing all the supported script languages. This filter string is convenient for use with QFileDialog. +.SH "QStringList QAxScriptManager::scriptNames () const" +Returns a list with the names of all the scripts. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxscriptmanager.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxscriptmanager.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqaxwidget.3qt b/doc/man/man3/tqaxwidget.3qt new file mode 100644 index 000000000..73af41d9c --- /dev/null +++ b/doc/man/man3/tqaxwidget.3qt @@ -0,0 +1,215 @@ +'\" t +.TH QAxWidget 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 +QAxWidget \- QWidget that wraps an ActiveX control +.SH SYNOPSIS +This class is part of the \fBQt ActiveQt Extension\fR. +.PP +\fC#include <qaxwidget.h>\fR +.PP +Inherits QWidget and QAxBase. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAxWidget\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQAxWidget\fR ( const QString & c, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQAxWidget\fR ( IUnknown * iface, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QAxWidget\fR ()" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "QVariant \fBdynamicCall\fR ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.ti -1c +.BI "QVariant \fBdynamicCall\fR ( const QCString & function, QValueList<QVariant> & vars )" +.br +.ti -1c +.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBcreateHostWindow\fR ( bool initialized )" +.br +.ti -1c +.BI "virtual bool \fBtranslateKeyEvent\fR ( int message, int keycode ) const" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QAxWidget class is a QWidget that wraps an ActiveX control. +.PP +A QAxWidget can be instantiated as an empty object, with the name of the ActiveX control it should wrap, or with an existing interface pointer to the ActiveX control. The ActiveX control's properties, methods and events which only use supported data types, become available as Qt properties, slots and signals. The base class QAxBase provides an API to access the ActiveX directly through the IUnknown pointer. +.PP +QAxWidget is a QWidget and can be used as such, e.g. it can be organized in a widget hierarchy, receive events or act as an event filter. Standard widget properties, e.g. enabled are supported, but it depends on the ActiveX control to implement support for ambient properties like e.g. palette or font. QAxWidget tries to provide the necessary hints. +.PP +\fBWarning:\fR You can subclass QAxWidget, but you cannot use the TQ_OBJECT macro in the subclass (the generated moc-file will not compile), so you cannot add further signals, slots or properties. This limitation is due to the metaobject information generated in runtime. To work around this problem, aggregate the QAxWidget as a member of the QObject subclass. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAxWidget::QAxWidget ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Creates an empty QAxWidget widget and propagates \fIparent\fR, \fIname\fR and \fIf\fR to the QWidget constructor. To initialize a control, call setControl. +.SH "QAxWidget::QAxWidget ( const QString & c, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Creates an QAxWidget widget and initializes the ActiveX control \fIc\fR. \fIparent\fR, \fIname\fR and \fIf\fR are propagated to the QWidget contructor. +.PP +See also control. +.SH "QAxWidget::QAxWidget ( IUnknown * iface, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Creates a QAxWidget that wraps the COM object referenced by \fIiface\fR. \fIparent\fR, \fIname\fR and \fIf\fR are propagated to the QWidget contructor. +.SH "QAxWidget::~QAxWidget ()" +Shuts down the ActiveX control and destroys the QAxWidget widget, cleaning up all allocated resources. +.PP +See also clear(). +.SH "bool QAxWidget::createHostWindow ( bool initialized )\fC [virtual protected]\fR" +Creates the client site for the ActiveX control, and returns TRUE if the control could be embedded successfully, otherwise returns FALSE. If \fIinitialized\fR is TRUE the control has already been initialized. +.PP +This function is called by initialize(). If you reimplement initialize to customize the actual control instantiation, call this function in your reimplementation to have the control embedded by the default client side. Creates the client site for the ActiveX control, and returns TRUE if the control could be embedded successfully, otherwise returns FALSE. +.SH "QVariant QAxBase::dynamicCall ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Calls the COM object's method \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed. +.PP +If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call. +.PP +.nf +.br + activeX->dynamicCall( "Navigate(const QString&)", "www.trolltech.com" ); +.br +.fi +.PP +Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using +.PP +.nf +.br + activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); +.br +.fi +All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. +.PP +If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. +.PP +.nf +.br + activeX->dynamicCall( "Value", 5 ); +.br + QString text = activeX->dynamicCall( "Text" ).toString(); +.br +.fi +Note that it is faster to get and set properties using QObject::property() and QObject::setProperty(). +.PP +It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly. +.PP +.nf +.br + IWebBrowser2 *webBrowser = 0; +.br + activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); +.br + if ( webBrowser ) { +.br + webBrowser->Navigate2( pvarURL ); +.br + webBrowser->Release(); +.br + } +.br +.fi +.PP +This is also more efficient. +.PP +Example: qutlook/centralwidget.cpp. +.SH "QVariant QAxBase::dynamicCall ( const QCString & function, QValueList<QVariant> & vars )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Calls the COM object's method \fIfunction\fR, passing the parameters in \fIvars\fR, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object. +.PP +The QVariant objects in \fIvars\fR are updated when the method has out-parameters. +.SH "QAxObject * QAxBase::querySubObject ( const QCString & name, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" +Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. +.PP +If \fIname\fR is provided by a method the string must include the full function prototype. +.PP +If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. +.PP +The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. +.PP +COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. +.PP +.nf +.br + QAxWidget outlook( "Outlook.Application" ); +.br + QAxObject *session = outlook.querySubObject( "Session" ); +.br + if ( session ) { +.br + QAxObject *defFolder = session->querySubObject( +.br + "GetDefaultFolder(OlDefaultFolders)", +.br + "olFolderContacts" ); +.br + //... +.br + } +.br +.fi +.PP +Example: qutlook/centralwidget.cpp. +.SH "bool QAxWidget::translateKeyEvent ( int message, int keycode ) const\fC [virtual protected]\fR" +Reimplement this function to pass certain key events to the ActiveX control. \fImessage\fR is the Window message identifier specifying the message type (ie. WM_KEYDOWN), and \fIkeycode\fR is the virtual keycode (ie. VK_TAB). +.PP +If the function returns TRUE the key event is passed on to the ActiveX control, which then either processes the event or passes the event on to Qt. +.PP +If the function returns FALSE the processing of the key event is ignored by ActiveQt, ie. the ActiveX control might handle it or not. +.PP +The default implementation returns TRUE for the following cases: +.PP +<center>.nf +.TS +l - l. WM_SYSKEYDOWN WM_SYSKEYUP WM_KEYDOWN All keycodes VK_MENU +.TE +.fi +</center> +.PP +This table is the result of experimenting with popular ActiveX controls, +ie. Internet Explorer and Microsoft Office applications, but for some +controls it might require modification. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qaxwidget.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqaxwidget.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbig5codec.3qt b/doc/man/man3/tqbig5codec.3qt new file mode 100644 index 000000000..11eda01f8 --- /dev/null +++ b/doc/man/man3/tqbig5codec.3qt @@ -0,0 +1,62 @@ +'\" t +.TH QBig5Codec 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 +QBig5Codec \- Conversion to and from the Big5 encoding +.SH SYNOPSIS +\fC#include <ntqbig5codec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SH DESCRIPTION +The QBig5Codec class provides conversion to and from the Big5 encoding. +.PP +QBig5Codec was originally contributed by Ming-Che Chuang <mingche@cobra.ee.ntu.edu.tw> for the Big-5+ encoding, and was included in Qt with the author's permission, and the grateful thanks of the Trolltech team. (Note: Ming-Che's code is QPL'd, as per an mail to info@trolltech.com.) +.PP +However, since Big-5+ was never formally approved, and was never used by anyone, the Taiwan Free Software community and the Li18nux Big5 Standard Subgroup agree that the de-facto standard Big5-ETen (zh_TW.Big5 or zh_TW.TW-Big5) be used instead. +.PP +QBig5Codec is currently implemented as a pure subset of QBig5hkscsCodec, so more fine-tuning is needed to make it identical to the standard Big5 mapping as determined by Li18nux-Big5. See http://www.autrijus.org/xml/ for the draft Big5 (2002) standard. +.PP +James Su <suzhe@turbolinux.com.cn> <suzhe@gnuchina.org> generated the Big5-HKSCS<->Unicode tables with a very space-efficient algorithm. He generously donated his code to glibc in May 2002. Subsequently, James has kindly allowed Anthony Fok <anthony@thizlinux.com> <foka@debian.org> to adapt the code for Qt. +.PP +Copyright (C) 2000 Ming-Che Chuang Copyright (C) 2002 James Su, Turbolinux Inc. Copyright (C) 2002 Anthony Fok, ThizLinux Laboratory Ltd. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> +.IP 1 +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.IP 2 +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.PP +See also Internationalization with Qt. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqbig5codec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbig5codec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbig5hkscscodec.3qt b/doc/man/man3/tqbig5hkscscodec.3qt new file mode 100644 index 000000000..9e01490cc --- /dev/null +++ b/doc/man/man3/tqbig5hkscscodec.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QBig5hkscsCodec 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 +QBig5hkscsCodec \- Conversion to and from the Big5-HKSCS encoding +.SH SYNOPSIS +\fC#include <ntqbig5codec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SH DESCRIPTION +The QBig5hkscsCodec class provides conversion to and from the Big5-HKSCS encoding. +.PP +QBig5hkscsCodec grew out of the QBig5Codec originally contributed by Ming-Che Chuang <mingche@cobra.ee.ntu.edu.tw>. James Su <suzhe@turbolinux.com.cn> <suzhe@gnuchina.org> and Anthony Fok <anthony@thizlinux.com> <foka@debian.org> implemented HKSCS-1999 QBig5hkscsCodec for Qt-2.3.x, but it was too late in Qt development schedule to be officially included in the Qt-2.3.x series. +.PP +Wu Yi <wuyi@hancom.com> ported the HKSCS-1999 QBig5hkscsCodec to Qt-3.0.1 in March 2002. +.PP +With the advent of the new HKSCS-2001 standard, James Su <suzhe@turbolinux.com.cn> <suzhe@gnuchina.org> generated the Big5-HKSCS<->Unicode tables with a very space-efficient algorithm. He generously donated his code to glibc in May 2002. Subsequently, James has generously allowed Anthony Fok to adapt the code for Qt-3.0.5. +.PP +Currently, the Big5-HKSCS tables are generated from the following sources, and with the Euro character added: <ol type=1> +.IP 1 +http://www.microsoft.com/typography/unicode/950.txt +.IP 2 +http://www.info.gov.hk/digital21/chi/hkscs/download/big5-iso.txt +.IP 3 +http://www.info.gov.hk/digital21/chi/hkscs/download/big5cmp.txt +.PP +There may be more fine-tuning to the QBig5hkscsCodec to maximize its compatibility with the standard Big5 (2002) mapping as determined by Li18nux Big5 Standard Subgroup. See http://www.autrijus.org/xml/ for the various Big5 CharMapML tables. +.PP +Copyright (C) 2000 Ming-Che Chuang Copyright (C) 2001, 2002 James Su, Turbolinux Inc. Copyright (C) 2002 WU Yi, HancomLinux Inc. Copyright (C) 2001, 2002 Anthony Fok, ThizLinux Laboratory Ltd. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> +.IP 4 +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.IP 5 +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qbig5hkscscodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbig5hkscscodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbitarray.3qt b/doc/man/man3/tqbitarray.3qt new file mode 100644 index 000000000..4f656c235 --- /dev/null +++ b/doc/man/man3/tqbitarray.3qt @@ -0,0 +1,372 @@ +'\" t +.TH QBitArray 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 +QBitArray \- Array of bits +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqbitarray.h>\fR +.PP +Inherits QByteArray. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQBitArray\fR ()" +.br +.ti -1c +.BI "\fBQBitArray\fR ( uint size )" +.br +.ti -1c +.BI "\fBQBitArray\fR ( const QBitArray & a )" +.br +.ti -1c +.BI "QBitArray & \fBoperator=\fR ( const QBitArray & a )" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBresize\fR ( uint size )" +.br +.ti -1c +.BI "bool \fBfill\fR ( bool v, int size = -1 )" +.br +.ti -1c +.BI "virtual void \fBdetach\fR ()" +.br +.ti -1c +.BI "QBitArray \fBcopy\fR () const" +.br +.ti -1c +.BI "bool \fBtestBit\fR ( uint index ) const" +.br +.ti -1c +.BI "void \fBsetBit\fR ( uint index )" +.br +.ti -1c +.BI "void \fBsetBit\fR ( uint index, bool value )" +.br +.ti -1c +.BI "void \fBclearBit\fR ( uint index )" +.br +.ti -1c +.BI "bool \fBtoggleBit\fR ( uint index )" +.br +.ti -1c +.BI "bool \fBat\fR ( uint index ) const" +.br +.ti -1c +.BI "QBitVal \fBoperator[]\fR ( int index )" +.br +.ti -1c +.BI "bool \fBoperator[]\fR ( int index ) const" +.br +.ti -1c +.BI "QBitArray & \fBoperator&=\fR ( const QBitArray & a )" +.br +.ti -1c +.BI "QBitArray & \fBoperator|=\fR ( const QBitArray & a )" +.br +.ti -1c +.BI "QBitArray & \fBoperator^=\fR ( const QBitArray & a )" +.br +.ti -1c +.BI "QBitArray \fBoperator~\fR () const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QBitArray \fBoperator&\fR ( const QBitArray & a1, const QBitArray & a2 )" +.br +.ti -1c +.BI "QBitArray \fBoperator|\fR ( const QBitArray & a1, const QBitArray & a2 )" +.br +.ti -1c +.BI "QBitArray \fBoperator^\fR ( const QBitArray & a1, const QBitArray & a2 )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QBitArray & a )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QBitArray & a )" +.br +.in -1c +.SH DESCRIPTION +The QBitArray class provides an array of bits. +.PP +Because QBitArray is a QMemArray, it uses explicit sharing with a reference count. +.PP +A QBitArray is a special byte array that can access individual bits and perform bit-operations (AND, OR, XOR and NOT) on entire arrays or bits. +.PP +Bits can be manipulated by the setBit() and clearBit() functions, but it is also possible to use the indexing [] operator to test and set individual bits. The [] operator is a little slower than setBit() and clearBit() because some tricks are required to implement single-bit assignments. +.PP +Example: +.PP +.nf +.br + QBitArray a(3); +.br + a.setBit( 0 ); +.br + a.clearBit( 1 ); +.br + a.setBit( 2 ); // a = [1 0 1] +.br +.br + QBitArray b(3); +.br + b[0] = 1; +.br + b[1] = 1; +.br + b[2] = 0; // b = [1 1 0] +.br +.br + QBitArray c; +.br + c = ~a & b; // c = [0 1 0] +.br +.fi +.PP +When a QBitArray is constructed the bits are uninitialized. Use fill() to set all the bits to 0 or 1. The array can be resized with resize() and copied with copy(). Bits can be set with setBit() and cleared with clearBit(). Bits can be toggled with toggleBit(). A bit's value can be obtained with testBit() and with at(). +.PP +QBitArray supports the & (AND), | (OR), ^ (XOR) and ~ (NOT) operators. +.PP +See also Collection Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QBitArray::QBitArray ()" +Constructs an empty bit array. +.SH "QBitArray::QBitArray ( uint size )" +Constructs a bit array of \fIsize\fR bits. The bits are uninitialized. +.PP +See also fill(). +.SH "QBitArray::QBitArray ( const QBitArray & a )" +Constructs a shallow copy of \fIa\fR. +.SH "bool QBitArray::at ( uint index ) const" +Returns the value (0 or 1) of the bit at position \fIindex\fR. +.PP +See also operator[](). +.SH "void QBitArray::clearBit ( uint index )" +Clears the bit at position \fIindex\fR, i.e. sets it to 0. +.PP +See also setBit() and toggleBit(). +.SH "QBitArray QBitArray::copy () const" +Returns a deep copy of the bit array. +.PP +See also detach(). +.SH "void QBitArray::detach ()\fC [virtual]\fR" +Detaches from shared bit array data and makes sure that this bit array is the only one referring to the data. +.PP +If multiple bit arrays share common data, this bit array dereferences the data and gets a copy of the data. Nothing happens if there is only a single reference. +.PP +See also copy(). +.PP +Reimplemented from QMemArray. +.SH "bool QBitArray::fill ( bool v, int size = -1 )" +Fills the bit array with \fIv\fR (1's if \fIv\fR is TRUE, or 0's if \fIv\fR is FALSE). +.PP +fill() resizes the bit array to \fIsize\fR bits if \fIsize\fR is nonnegative. +.PP +Returns FALSE if a nonnegative \fIsize\fR was specified and the bit array could not be resized; otherwise returns TRUE. +.PP +See also resize(). +.SH "QBitArray & QBitArray::operator&= ( const QBitArray & a )" +Performs the AND operation between all bits in this bit array and \fIa\fR. Returns a reference to this bit array. +.PP +The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. +.PP +.nf +.br + QBitArray a( 3 ), b( 2 ); +.br + a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] +.br + b[0] = 1; b[1] = 0; // b = [1 0] +.br + a &= b; // a = [1 0 0] +.br +.fi +.PP +See also operator|=(), operator^=(), and operator~(). +.SH "QBitArray & QBitArray::operator= ( const QBitArray & a )" +Assigns a shallow copy of \fIa\fR to this bit array and returns a reference to this array. +.SH "QBitVal QBitArray::operator[] ( int index )" +Implements the [] operator for bit arrays. +.PP +The returned QBitVal is a context object. It makes it possible to get and set a single bit value by its \fIindex\fR position. +.PP +Example: +.PP +.nf +.br + QBitArray a( 3 ); +.br + a[0] = 0; +.br + a[1] = 1; +.br + a[2] = a[0] ^ a[1]; +.br +.fi +.PP +The functions testBit(), setBit() and clearBit() are faster. +.PP +See also at(). +.SH "bool QBitArray::operator[] ( int index ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Implements the [] operator for constant bit arrays. +.SH "QBitArray & QBitArray::operator^= ( const QBitArray & a )" +Performs the XOR operation between all bits in this bit array and \fIa\fR. Returns a reference to this bit array. +.PP +The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. +.PP +.nf +.br + QBitArray a( 3 ), b( 2 ); +.br + a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] +.br + b[0] = 1; b[1] = 0; // b = [1 0] +.br + a ^= b; // a = [0 0 1] +.br +.fi +.PP +See also operator&=(), operator|=(), and operator~(). +.SH "QBitArray & QBitArray::operator|= ( const QBitArray & a )" +Performs the OR operation between all bits in this bit array and \fIa\fR. Returns a reference to this bit array. +.PP +The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. +.PP +.nf +.br + QBitArray a( 3 ), b( 2 ); +.br + a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] +.br + b[0] = 1; b[1] = 0; // b = [1 0] +.br + a |= b; // a = [1 0 1] +.br +.fi +.PP +See also operator&=(), operator^=(), and operator~(). +.SH "QBitArray QBitArray::operator~ () const" +Returns a bit array that contains the inverted bits of this bit array. +.PP +Example: +.PP +.nf +.br + QBitArray a( 3 ), b; +.br + a[0] = 1; a[1] = 0; a[2] = 1; // a = [1 0 1] +.br + b = ~a; // b = [0 1 0] +.br +.fi +.SH "bool QBitArray::resize ( uint size )" +Resizes the bit array to \fIsize\fR bits and returns TRUE if the bit array could be resized; otherwise returns FALSE. The array becomes a null array if \fIsize\fR == 0. +.PP +If the array is expanded, the new bits are set to 0. +.PP +See also size(). +.SH "void QBitArray::setBit ( uint index, bool value )" +Sets the bit at position \fIindex\fR to \fIvalue\fR. +.PP +Equivalent to: +.PP +.nf +.br + if ( value ) +.br + setBit( index ); +.br + else +.br + clearBit( index ); +.br +.fi +.PP +See also clearBit() and toggleBit(). +.SH "void QBitArray::setBit ( uint index )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the bit at position \fIindex\fR to 1. +.PP +See also clearBit() and toggleBit(). +.SH "uint QBitArray::size () const" +Returns the bit array's size (number of bits). +.PP +See also resize(). +.SH "bool QBitArray::testBit ( uint index ) const" +Returns TRUE if the bit at position \fIindex\fR is set, i.e. is 1; otherwise returns FALSE. +.PP +See also setBit() and clearBit(). +.SH "bool QBitArray::toggleBit ( uint index )" +Toggles the bit at position \fIindex\fR. +.PP +If the previous value was 0, the new value will be 1. If the previous value was 1, the new value will be 0. +.PP +See also setBit() and clearBit(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QBitArray operator& ( const QBitArray & a1, const QBitArray & a2 )" +Returns the AND result between the bit arrays \fIa1\fR and \fIa2\fR. +.PP +The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. +.PP +See also QBitArray::operator&=(). +.SH "QDataStream & operator<< ( QDataStream & s, const QBitArray & a )" +Writes bit array \fIa\fR to stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QBitArray & a )" +Reads a bit array into \fIa\fR from stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QBitArray operator^ ( const QBitArray & a1, const QBitArray & a2 )" +Returns the XOR result between the bit arrays \fIa1\fR and \fIa2\fR. +.PP +The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. +.PP +See also QBitArray::operator^(). +.SH "QBitArray operator| ( const QBitArray & a1, const QBitArray & a2 )" +Returns the OR result between the bit arrays \fIa1\fR and \fIa2\fR. +.PP +The result has the length of the longest of the two bit arrays, with any missing bits (i.e. if one array is shorter than the other), taken to be 0. +.PP +See also QBitArray::operator|=(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqbitarray.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbitarray.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbitmap.3qt b/doc/man/man3/tqbitmap.3qt new file mode 100644 index 000000000..a4c067a3a --- /dev/null +++ b/doc/man/man3/tqbitmap.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 <ntqbitmap.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/ntqbitmap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbitmap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbitval.3qt b/doc/man/man3/tqbitval.3qt new file mode 100644 index 000000000..5d41d91ed --- /dev/null +++ b/doc/man/man3/tqbitval.3qt @@ -0,0 +1,72 @@ +'\" t +.TH QBitVal 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 +QBitVal \- Internal class, used with QBitArray +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqbitarray.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQBitVal\fR ( QBitArray * a, uint i )" +.br +.ti -1c +.BI "\fBoperator int\fR ()" +.br +.ti -1c +.BI "QBitVal & \fBoperator=\fR ( const QBitVal & v )" +.br +.ti -1c +.BI "QBitVal & \fBoperator=\fR ( bool v )" +.br +.in -1c +.SH DESCRIPTION +The QBitVal class is an internal class, used with QBitArray. +.PP +The QBitVal is required by the indexing [] operator on bit arrays. It is not for use in any other context. +.PP +See also Collection Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QBitVal::QBitVal ( QBitArray * a, uint i )" +Constructs a reference to element \fIi\fR in the QBitArray \fIa\fR. This is what QBitArray::operator[] constructs its return value with. +.SH "QBitVal::operator int ()" +Returns the value referenced by the QBitVal. +.SH "QBitVal & QBitVal::operator= ( const QBitVal & v )" +Sets the value referenced by the QBitVal to that referenced by QBitVal \fIv\fR. +.SH "QBitVal & QBitVal::operator= ( bool v )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the value referenced by the QBitVal to \fIv\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qbitval.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbitval.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqboxlayout.3qt b/doc/man/man3/tqboxlayout.3qt new file mode 100644 index 000000000..318cf83d3 --- /dev/null +++ b/doc/man/man3/tqboxlayout.3qt @@ -0,0 +1,354 @@ +'\" t +.TH QBoxLayout 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 +QBoxLayout \- Lines up child widgets horizontally or vertically +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherits QLayout. +.PP +Inherited by QHBoxLayout and QVBoxLayout. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBDirection\fR { LeftToRight, RightToLeft, TopToBottom, BottomToTop, Down = TopToBottom, Up = BottomToTop }" +.br +.ti -1c +.BI "\fBQBoxLayout\fR ( QWidget * parent, Direction d, int margin = 0, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQBoxLayout\fR ( QLayout * parentLayout, Direction d, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQBoxLayout\fR ( Direction d, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QBoxLayout\fR ()" +.br +.ti -1c +.BI "virtual void \fBaddItem\fR ( QLayoutItem * item )" +.br +.ti -1c +.BI "Direction \fBdirection\fR () const" +.br +.ti -1c +.BI "void \fBsetDirection\fR ( Direction direction )" +.br +.ti -1c +.BI "void \fBaddSpacing\fR ( int size )" +.br +.ti -1c +.BI "void \fBaddStretch\fR ( int stretch = 0 )" +.br +.ti -1c +.BI "void \fBaddWidget\fR ( QWidget * widget, int stretch = 0, int alignment = 0 )" +.br +.ti -1c +.BI "void \fBaddLayout\fR ( QLayout * layout, int stretch = 0 )" +.br +.ti -1c +.BI "void \fBaddStrut\fR ( int size )" +.br +.ti -1c +.BI "void \fBinsertSpacing\fR ( int index, int size )" +.br +.ti -1c +.BI "void \fBinsertStretch\fR ( int index, int stretch = 0 )" +.br +.ti -1c +.BI "void \fBinsertWidget\fR ( int index, QWidget * widget, int stretch = 0, int alignment = 0 )" +.br +.ti -1c +.BI "void \fBinsertLayout\fR ( int index, QLayout * layout, int stretch = 0 )" +.br +.ti -1c +.BI "bool \fBsetStretchFactor\fR ( QWidget * w, int stretch )" +.br +.ti -1c +.BI "bool \fBsetStretchFactor\fR ( QLayout * l, int stretch )" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBminimumSize\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBmaximumSize\fR () const" +.br +.ti -1c +.BI "virtual bool \fBhasHeightForWidth\fR () const" +.br +.ti -1c +.BI "virtual int \fBheightForWidth\fR ( int w ) const" +.br +.ti -1c +.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" +.br +.ti -1c +.BI "virtual void \fBinvalidate\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" +.br +.ti -1c +.BI "int \fBfindWidget\fR ( QWidget * w )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBinsertItem\fR ( int index, QLayoutItem * item )" +.br +.in -1c +.SH DESCRIPTION +The QBoxLayout class lines up child widgets horizontally or vertically. +.PP +QBoxLayout takes the space it gets (from its parent layout or from the mainWidget()), divides it up into a row of boxes, and makes each managed widget fill one box. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +If the QBoxLayout's orientation is Horizontal the boxes are placed in a row, with suitable sizes. Each widget (or other box) will get at least its minimum size and at most its maximum size. Any excess space is shared according to the stretch factors (more about that below). +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +If the QBoxLayout's orientation is Vertical, the boxes are placed in a column, again with suitable sizes. +.PP +The easiest way to create a QBoxLayout is to use one of the convenience classes, e.g. QHBoxLayout (for Horizontal boxes) or QVBoxLayout (for Vertical boxes). You can also use the QBoxLayout constructor directly, specifying its direction as LeftToRight, Down, RightToLeft or Up. +.PP +If the QBoxLayout is not the top-level layout (i.e. it is not managing all of the widget's area and children), you must add it to its parent layout before you can do anything with it. The normal way to add a layout is by calling parentLayout->addLayout(). +.PP +Once you have done this, you can add boxes to the QBoxLayout using one of four functions: +.TP +addWidget() to add a widget to the QBoxLayout and set the widget's stretch factor. (The stretch factor is along the row of boxes.) +.IP +.TP +addSpacing() to create an empty box; this is one of the functions you use to create nice and spacious dialogs. See below for ways to set margins. +.IP +.TP +addStretch() to create an empty, stretchable box. +.IP +.TP +addLayout() to add a box containing another QLayout to the row and set that layout's stretch factor. +.PP +Use insertWidget(), insertSpacing(), insertStretch() or insertLayout() to insert a box at a specified position in the layout. +.PP +QBoxLayout also includes two margin widths: +.TP +setMargin() sets the width of the outer border. This is the width of the reserved space along each of the QBoxLayout's four sides. +.TP +setSpacing() sets the width between neighboring boxes. (You can use addSpacing() to get more space at a particular spot.) +.PP +The margin defaults to 0. The spacing defaults to the same as the margin width for a top-level layout, or to the same as the parent layout. Both are parameters to the constructor. +.PP +To remove a widget from a layout, call remove(). Calling QWidget::hide() on a widget also effectively removes the widget from the layout until QWidget::show() is called. +.PP +You will almost always want to use QVBoxLayout and QHBoxLayout rather than QBoxLayout because of their convenient constructors. +.PP +See also QGrid, Layout Overview, Widget Appearance and Style, and Layout Management. +.SS "Member Type Documentation" +.SH "QBoxLayout::Direction" +This type is used to determine the direction of a box layout. +.TP +\fCQBoxLayout::LeftToRight\fR - Horizontal, from left to right +.TP +\fCQBoxLayout::RightToLeft\fR - Horizontal, from right to left +.TP +\fCQBoxLayout::TopToBottom\fR - Vertical, from top to bottom +.TP +\fCQBoxLayout::Down\fR - The same as TopToBottom +.TP +\fCQBoxLayout::BottomToTop\fR - Vertical, from bottom to top +.TP +\fCQBoxLayout::Up\fR - The same as BottomToTop +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QBoxLayout::QBoxLayout ( QWidget * parent, Direction d, int margin = 0, int spacing = -1, const char * name = 0 )" +Constructs a new QBoxLayout with direction \fId\fR and main widget \fIparent\fR. \fIparent\fR may not be 0. +.PP +The \fImargin\fR is the number of pixels between the edge of the widget and its managed children. The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1 the value of \fImargin\fR is used for \fIspacing\fR. +.PP +\fIname\fR is the internal object name. +.PP +See also direction(). +.SH "QBoxLayout::QBoxLayout ( QLayout * parentLayout, Direction d, int spacing = -1, const char * name = 0 )" +Constructs a new QBoxLayout called \fIname\fR, with direction \fId\fR, and inserts it into \fIparentLayout\fR. +.PP +The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, the layout will inherit its parent's spacing(). +.SH "QBoxLayout::QBoxLayout ( Direction d, int spacing = -1, const char * name = 0 )" +Constructs a new QBoxLayout called \fIname\fR, with direction \fId\fR. +.PP +If \fIspacing\fR is -1, the layout will inherit its parent's spacing(); otherwise \fIspacing\fR is used. +.PP +You must insert this box into another layout. +.SH "QBoxLayout::~QBoxLayout ()" +Destroys this box layout. +.PP +The layout's widgets aren't destroyed. +.SH "void QBoxLayout::addItem ( QLayoutItem * item )\fC [virtual]\fR" +Adds \fIitem\fR to the end of this box layout. +.PP +Examples: +.)l chart/optionsform.cpp and chart/setdataform.cpp. +.PP +Reimplemented from QLayout. +.SH "void QBoxLayout::addLayout ( QLayout * layout, int stretch = 0 )" +Adds \fIlayout\fR to the end of the box, with serial stretch factor \fIstretch\fR. +.PP +When a layout is constructed with another layout as its parent, you don't need to call addLayout(); the child layout is automatically added to the parent layout as it is constructed. +.PP +See also insertLayout(), setAutoAdd(), addWidget(), and addSpacing(). +.PP +Examples: +.)l chart/optionsform.cpp, chart/setdataform.cpp, fonts/simple-qfont-demo/viewer.cpp, listbox/listbox.cpp, regexptester/regexptester.cpp, and tictac/tictac.cpp. +.SH "void QBoxLayout::addSpacing ( int size )" +Adds a non-stretchable space with size \fIsize\fR to the end of this box layout. QBoxLayout provides default margin and spacing. This function adds additional space. +.PP +See also insertSpacing() and addStretch(). +.PP +Example: listbox/listbox.cpp. +.SH "void QBoxLayout::addStretch ( int stretch = 0 )" +Adds a stretchable space with zero minimum size and stretch factor \fIstretch\fR to the end of this box layout. +.PP +See also addSpacing(). +.PP +Examples: +.)l layout/layout.cpp, listbox/listbox.cpp, regexptester/regexptester.cpp, and t13/gamebrd.cpp. +.SH "void QBoxLayout::addStrut ( int size )" +Limits the perpendicular dimension of the box (e.g. height if the box is LeftToRight) to a minimum of \fIsize\fR. Other constraints may increase the limit. +.SH "void QBoxLayout::addWidget ( QWidget * widget, int stretch = 0, int alignment = 0 )" +Adds \fIwidget\fR to the end of this box layout, with a stretch factor of \fIstretch\fR and alignment \fIalignment\fR. +.PP +The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more. +.PP +If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved. +.PP +Alignment is specified by \fIalignment\fR which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. +.PP +From Qt 3.0, the \fIalignment\fR parameter is interpreted more aggressively than in previous versions of Qt. A non-default alignment now indicates that the widget should not grow to fill the available space, but should be sized according to sizeHint(). +.PP +See also insertWidget(), setAutoAdd(), addLayout(), and addSpacing(). +.PP +Examples: +.)l chart/optionsform.cpp, checklists/checklists.cpp, layout/layout.cpp, lineedits/lineedits.cpp, listbox/listbox.cpp, t13/gamebrd.cpp, and t13/lcdrange.cpp. +.SH "Direction QBoxLayout::direction () const" +Returns the direction of the box. addWidget() and addSpacing() work in this direction; the stretch stretches in this direction. +.PP +See also QBoxLayout::Direction, addWidget(), and addSpacing(). +.SH "QSizePolicy::ExpandData QBoxLayout::expanding () const\fC [virtual]\fR" +Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions. +.PP +Reimplemented from QLayout. +.SH "int QBoxLayout::findWidget ( QWidget * w )" +Searches for widget \fIw\fR in this layout (not including child layouts). +.PP +Returns the index of \fIw\fR, or -1 if \fIw\fR is not found. +.SH "bool QBoxLayout::hasHeightForWidth () const\fC [virtual]\fR" +Returns TRUE if this layout's preferred height depends on its width; otherwise returns FALSE. +.PP +Reimplemented from QLayoutItem. +.SH "int QBoxLayout::heightForWidth ( int w ) const\fC [virtual]\fR" +Returns the layout's preferred height when it is \fIw\fR pixels wide. +.PP +Reimplemented from QLayoutItem. +.SH "void QBoxLayout::insertItem ( int index, QLayoutItem * item )\fC [protected]\fR" +Inserts \fIitem\fR into this box layout at position \fIindex\fR. If \fIindex\fR is negative, the item is added at the end. +.PP +\fBWarning:\fR Does not call QLayout::insertChildLayout() if \fIitem\fR is a QLayout. +.PP +See also addItem() and findWidget(). +.SH "void QBoxLayout::insertLayout ( int index, QLayout * layout, int stretch = 0 )" +Inserts \fIlayout\fR at position \fIindex\fR, with stretch factor \fIstretch\fR. If \fIindex\fR is negative, the layout is added at the end. +.PP +\fIlayout\fR becomes a child of the box layout. +.PP +See also setAutoAdd(), insertWidget(), and insertSpacing(). +.SH "void QBoxLayout::insertSpacing ( int index, int size )" +Inserts a non-stretchable space at position \fIindex\fR, with size \fIsize\fR. If \fIindex\fR is negative the space is added at the end. +.PP +The box layout has default margin and spacing. This function adds additional space. +.PP +See also insertStretch(). +.SH "void QBoxLayout::insertStretch ( int index, int stretch = 0 )" +Inserts a stretchable space at position \fIindex\fR, with zero minimum size and stretch factor \fIstretch\fR. If \fIindex\fR is negative the space is added at the end. +.PP +See also insertSpacing(). +.SH "void QBoxLayout::insertWidget ( int index, QWidget * widget, int stretch = 0, int alignment = 0 )" +Inserts \fIwidget\fR at position \fIindex\fR, with stretch factor \fIstretch\fR and alignment \fIalignment\fR. If \fIindex\fR is negative, the widget is added at the end. +.PP +The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more. +.PP +If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved. +.PP +Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. +.PP +From Qt 3.0, the \fIalignment\fR parameter is interpreted more aggressively than in previous versions of Qt. A non-default alignment now indicates that the widget should not grow to fill the available space, but should be sized according to sizeHint(). +.PP +See also setAutoAdd(), insertLayout(), and insertSpacing(). +.SH "void QBoxLayout::invalidate ()\fC [virtual]\fR" +Resets cached information. +.PP +Reimplemented from QLayout. +.SH "QSize QBoxLayout::maximumSize () const\fC [virtual]\fR" +Returns the maximum size needed by this box layout. +.PP +Reimplemented from QLayout. +.SH "QSize QBoxLayout::minimumSize () const\fC [virtual]\fR" +Returns the minimum size needed by this box layout. +.PP +Reimplemented from QLayout. +.SH "void QBoxLayout::setDirection ( Direction direction )" +Sets the direction of this layout to \fIdirection\fR. +.SH "void QBoxLayout::setGeometry ( const QRect & r )\fC [virtual]\fR" +Resizes managed widgets within the rectangle \fIr\fR. +.PP +Reimplemented from QLayout. +.SH "bool QBoxLayout::setStretchFactor ( QWidget * w, int stretch )" +Sets the stretch factor for widget \fIw\fR to \fIstretch\fR and returns TRUE if \fIw\fR is found in this layout (not including child layouts); otherwise returns FALSE. +.SH "bool QBoxLayout::setStretchFactor ( QLayout * l, int stretch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the stretch factor for the layout \fIl\fR to \fIstretch\fR and returns TRUE if \fIl\fR is found in this layout (not including child layouts); otherwise returns FALSE. +.SH "QSize QBoxLayout::sizeHint () const\fC [virtual]\fR" +Returns the preferred size of this box layout. +.PP +Reimplemented from QLayoutItem. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qboxlayout.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqboxlayout.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbrush.3qt b/doc/man/man3/tqbrush.3qt new file mode 100644 index 000000000..1e31c6f6c --- /dev/null +++ b/doc/man/man3/tqbrush.3qt @@ -0,0 +1,234 @@ +'\" t +.TH QBrush 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 +QBrush \- Defines the fill pattern of shapes drawn by a QPainter +.SH SYNOPSIS +\fC#include <ntqbrush.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQBrush\fR ()" +.br +.ti -1c +.BI "\fBQBrush\fR ( BrushStyle style )" +.br +.ti -1c +.BI "\fBQBrush\fR ( const QColor & color, BrushStyle style = SolidPattern )" +.br +.ti -1c +.BI "\fBQBrush\fR ( const QColor & color, const QPixmap & pixmap )" +.br +.ti -1c +.BI "\fBQBrush\fR ( const QBrush & b )" +.br +.ti -1c +.BI "\fB~QBrush\fR ()" +.br +.ti -1c +.BI "QBrush & \fBoperator=\fR ( const QBrush & b )" +.br +.ti -1c +.BI "BrushStyle \fBstyle\fR () const" +.br +.ti -1c +.BI "void \fBsetStyle\fR ( BrushStyle s )" +.br +.ti -1c +.BI "const QColor & \fBcolor\fR () const" +.br +.ti -1c +.BI "void \fBsetColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QBrush & b ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QBrush & b ) const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QBrush & b )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QBrush & b )" +.br +.in -1c +.SH DESCRIPTION +The QBrush class defines the fill pattern of shapes drawn by a QPainter. +.PP +A brush has a style and a color. One of the brush styles is a custom pattern, which is defined by a QPixmap. +.PP +The brush style defines the fill pattern. The default brush style is NoBrush (depending on how you construct a brush). This style tells the painter to not fill shapes. The standard style for filling is SolidPattern. +.PP +The brush color defines the color of the fill pattern. The QColor documentation lists the predefined colors. +.PP +Use the QPen class for specifying line/outline styles. +.PP +Example: +.PP +.nf +.br + QPainter painter; +.br + QBrush brush( yellow ); // yellow solid pattern +.br + painter.begin( &anyPaintDevice ); // paint something +.br + painter.setBrush( brush ); // set the yellow brush +.br + painter.setPen( NoPen ); // do not draw outline +.br + painter.drawRect( 40,30, 200,100 ); // draw filled rectangle +.br + painter.setBrush( NoBrush ); // do not fill +.br + painter.setPen( black ); // set black pen, 0 pixel width +.br + painter.drawRect( 10,10, 30,20 ); // draw rectangle outline +.br + painter.end(); // painting done +.br +.fi +.PP +See the setStyle() function for a complete list of brush styles. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QPainter, QPainter::setBrush(), QPainter::setBrushOrigin(), Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QBrush::QBrush ()" +Constructs a default black brush with the style NoBrush (will not fill shapes). +.SH "QBrush::QBrush ( BrushStyle style )" +Constructs a black brush with the style \fIstyle\fR. +.PP +See also setStyle(). +.SH "QBrush::QBrush ( const QColor & color, BrushStyle style = SolidPattern )" +Constructs a brush with the color \fIcolor\fR and the style \fIstyle\fR. +.PP +See also setColor() and setStyle(). +.SH "QBrush::QBrush ( const QColor & color, const QPixmap & pixmap )" +Constructs a brush with the color \fIcolor\fR and a custom pattern stored in \fIpixmap\fR. +.PP +The color will only have an effect for monochrome pixmaps, i.e. for QPixmap::depth() == 1. +.PP +Pixmap brushes are currently not supported when printing on X11. +.PP +See also setColor() and setPixmap(). +.SH "QBrush::QBrush ( const QBrush & b )" +Constructs a brush that is a shallow copy of \fIb\fR. +.SH "QBrush::~QBrush ()" +Destroys the brush. +.SH "const QColor & QBrush::color () const" +Returns the brush color. +.PP +See also setColor(). +.SH "bool QBrush::operator!= ( const QBrush & b ) const" +Returns TRUE if the brush is different from \fIb\fR; otherwise returns FALSE. +.PP +Two brushes are different if they have different styles, colors or pixmaps. +.PP +See also operator==(). +.SH "QBrush & QBrush::operator= ( const QBrush & b )" +Assigns \fIb\fR to this brush and returns a reference to this brush. +.SH "bool QBrush::operator== ( const QBrush & b ) const" +Returns TRUE if the brush is equal to \fIb\fR; otherwise returns FALSE. +.PP +Two brushes are equal if they have equal styles, colors and pixmaps. +.PP +See also operator!=(). +.SH "QPixmap * QBrush::pixmap () const" +Returns a pointer to the custom brush pattern, or 0 if no custom brush pattern has been set. +.PP +See also setPixmap(). +.PP +Example: richtext/richtext.cpp. +.SH "void QBrush::setColor ( const QColor & c )" +Sets the brush color to \fIc\fR. +.PP +See also color() and setStyle(). +.PP +Example: picture/picture.cpp. +.SH "void QBrush::setPixmap ( const QPixmap & pixmap )" +Sets the brush pixmap to \fIpixmap\fR. The style is set to CustomPattern. +.PP +The current brush color will only have an effect for monochrome pixmaps, i.e. for QPixmap::depth() == 1. +.PP +Pixmap brushes are currently not supported when printing on X11. +.PP +See also pixmap() and color(). +.PP +Example: richtext/richtext.cpp. +.SH "void QBrush::setStyle ( BrushStyle s )" +Sets the brush style to \fIs\fR. +.PP +The brush styles are: <center>.nf +.TS +l - l. Pattern Meaning NoBrush will not fill shapes (default). SolidPattern solid (100%) fill pattern. Dense1Pattern 94% fill pattern. Dense2Pattern 88% fill pattern. Dense3Pattern 63% fill pattern. Dense4Pattern 50% fill pattern. Dense5Pattern 37% fill pattern. Dense6Pattern 12% fill pattern. Dense7Pattern 6% fill pattern. HorPattern horizontal lines pattern. VerPattern vertical lines pattern. CrossPattern crossing lines pattern. BDiagPattern diagonal lines (directed /) pattern. FDiagPattern diagonal lines (directed \) pattern. DiagCrossPattern diagonal crossing lines pattern. CustomPattern +.TE +.fi +</center> +.PP +On Windows, dense and custom patterns cannot be transparent. +.PP +See the Detailed Description for a picture of all the styles. +.PP +See also style(). +.SH "BrushStyle QBrush::style () const" +Returns the brush style. +.PP +See also setStyle(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QBrush & b )" +Writes the brush \fIb\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QBrush & b )" +Reads the brush \fIb\fR from the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqbrush.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbrush.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbuffer.3qt b/doc/man/man3/tqbuffer.3qt new file mode 100644 index 000000000..139e74cfd --- /dev/null +++ b/doc/man/man3/tqbuffer.3qt @@ -0,0 +1,138 @@ +'\" t +.TH QBuffer 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 +QBuffer \- I/O device that operates on a QByteArray +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqbuffer.h>\fR +.PP +Inherits QIODevice. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQBuffer\fR ()" +.br +.ti -1c +.BI "\fBQBuffer\fR ( QByteArray buf )" +.br +.ti -1c +.BI "\fB~QBuffer\fR ()" +.br +.ti -1c +.BI "QByteArray \fBbuffer\fR () const" +.br +.ti -1c +.BI "bool \fBsetBuffer\fR ( QByteArray buf )" +.br +.ti -1c +.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * p, TQ_ULONG len )" +.br +.ti -1c +.BI "TQ_LONG \fBwriteBlock\fR ( const QByteArray & data )" +.br +.in -1c +.SH DESCRIPTION +The QBuffer class is an I/O device that operates on a QByteArray. +.PP +QBuffer is used to read and write to a memory buffer. It is normally used with a QTextStream or a QDataStream. QBuffer has an associated QByteArray which holds the buffer data. The size() of the buffer is automatically adjusted as data is written. +.PP +The constructor \fCQBuffer(QByteArray)\fR creates a QBuffer using an existing byte array. The byte array can also be set with setBuffer(). Writing to the QBuffer will modify the original byte array because QByteArray is explicitly shared. +.PP +Use open() to open the buffer before use and to set the mode (read-only, write-only, etc.). close() closes the buffer. The buffer must be closed before reopening or calling setBuffer(). +.PP +A common way to use QBuffer is through QDataStream or QTextStream, which have constructors that take a QBuffer parameter. For convenience, there are also QDataStream and QTextStream constructors that take a QByteArray parameter. These constructors create and open an internal QBuffer. +.PP +Note that QTextStream can also operate on a QString (a Unicode string); a QBuffer cannot. +.PP +You can also use QBuffer directly through the standard QIODevice functions readBlock(), writeBlock() readLine(), at(), getch(), putch() and ungetch(). +.PP +See also QFile, QDataStream, QTextStream, QByteArray, Shared Classes, Collection Classes, and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QBuffer::QBuffer ()" +Constructs an empty buffer. +.SH "QBuffer::QBuffer ( QByteArray buf )" +Constructs a buffer that operates on \fIbuf\fR. +.PP +If you open the buffer in write mode (<a href="ntqfile.html#open">IO_WriteOnly</a> or IO_ReadWrite) and write something into the buffer, \fIbuf\fR will be modified. +.PP +Example: +.PP +.nf +.br + QCString str = "abc"; +.br + QBuffer b( str ); +.br + b.open( IO_WriteOnly ); +.br + b.at( 3 ); // position at the 4th character (the terminating \\0) +.br + b.writeBlock( "def", 4 ); // write "def" including the terminating \\0 +.br + b.close(); +.br + // Now, str == "abcdef" with a terminating \\0 +.br +.fi +.PP +See also setBuffer(). +.SH "QBuffer::~QBuffer ()" +Destroys the buffer. +.SH "QByteArray QBuffer::buffer () const" +Returns this buffer's byte array. +.PP +See also setBuffer(). +.SH "bool QBuffer::setBuffer ( QByteArray buf )" +Replaces the buffer's contents with \fIbuf\fR and returns TRUE. +.PP +Does nothing (and returns FALSE) if isOpen() is TRUE. +.PP +Note that if you open the buffer in write mode (<a href="ntqfile.html#open">IO_WriteOnly</a> or IO_ReadWrite) and write something into the buffer, \fIbuf\fR is also modified because QByteArray is an explicitly shared class. +.PP +See also buffer(), open(), and close(). +.SH "TQ_LONG QBuffer::writeBlock ( const char * p, TQ_ULONG len )\fC [virtual]\fR" +Writes \fIlen\fR bytes from \fIp\fR into the buffer at the current index position, overwriting any characters there and extending the buffer if necessary. Returns the number of bytes actually written. +.PP +Returns -1 if an error occurred. +.PP +See also readBlock(). +.PP +Reimplemented from QIODevice. +.SH "TQ_LONG QBuffer::writeBlock ( const QByteArray & data )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This convenience function is the same as calling +\fCwriteBlock( data.data(), data.size() )\fR with \fIdata\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqbuffer.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbuffer.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbutton.3qt b/doc/man/man3/tqbutton.3qt new file mode 100644 index 000000000..2677a0000 --- /dev/null +++ b/doc/man/man3/tqbutton.3qt @@ -0,0 +1,490 @@ +'\" t +.TH QButton 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 +QButton \- The abstract base class of button widgets, providing functionality common to buttons +.SH SYNOPSIS +\fC#include <ntqbutton.h>\fR +.PP +Inherits QWidget. +.PP +Inherited by QCheckBox, QPushButton, QRadioButton, and QToolButton. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQButton\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QButton\fR ()" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "const QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" +.br +.ti -1c +.BI "QKeySequence \fBaccel\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" +.br +.ti -1c +.BI "bool \fBisToggleButton\fR () const" +.br +.ti -1c +.BI "enum \fBToggleType\fR { SingleShot, Toggle, Tristate }" +.br +.ti -1c +.BI "ToggleType \fBtoggleType\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDown\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisDown\fR () const" +.br +.ti -1c +.BI "bool \fBisOn\fR () const" +.br +.ti -1c +.BI "enum \fBToggleState\fR { Off, NoChange, On }" +.br +.ti -1c +.BI "ToggleState \fBstate\fR () const" +.br +.ti -1c +.BI "bool autoResize () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setAutoResize ( bool ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBautoRepeat\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoRepeat\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisExclusiveToggle\fR () const" +.br +.ti -1c +.BI "QButtonGroup * \fBgroup\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBanimateClick\fR ()" +.br +.ti -1c +.BI "void \fBtoggle\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBpressed\fR ()" +.br +.ti -1c +.BI "void \fBreleased\fR ()" +.br +.ti -1c +.BI "void \fBclicked\fR ()" +.br +.ti -1c +.BI "void \fBtoggled\fR ( bool on )" +.br +.ti -1c +.BI "void \fBstateChanged\fR ( int state )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QKeySequence \fBaccel\fR - the accelerator associated with the button" +.br +.ti -1c +.BI "bool \fBautoRepeat\fR - whether autoRepeat is enabled" +.br +.ti -1c +.BI "bool autoResize - whether autoResize is enabled \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBdown\fR - whether the button is pressed" +.br +.ti -1c +.BI "bool \fBexclusiveToggle\fR - whether the button is an exclusive toggle \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBon\fR - whether the button is toggled \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR - the pixmap shown on the button" +.br +.ti -1c +.BI "QString \fBtext\fR - the text shown on the button" +.br +.ti -1c +.BI "bool \fBtoggleButton\fR - whether the button is a toggle button \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "ToggleState \fBtoggleState\fR - the state of the toggle button \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "ToggleType \fBtoggleType\fR - the type of toggle on the button \fI(read " "only" ")\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsetToggleButton\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetToggleType\fR ( ToggleType type )" +.br +.ti -1c +.BI "void \fBsetOn\fR ( bool on )" +.br +.ti -1c +.BI "virtual void \fBsetState\fR ( ToggleState s )" +.br +.ti -1c +.BI "virtual bool \fBhitButton\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "virtual void \fBdrawButton\fR ( QPainter * )" +.br +.ti -1c +.BI "virtual void \fBdrawButtonLabel\fR ( QPainter * )" +.br +.ti -1c +.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" +.br +.in -1c +.SH DESCRIPTION +The QButton class is the abstract base class of button widgets, providing functionality common to buttons. +.PP +\fBIf you want to create a button use QPushButton.\fR +.PP +The QButton class implements an \fIabstract\fR button, and lets subclasses specify how to reply to user actions and how to draw the button. +.PP +QButton provides both push and toggle buttons. The QRadioButton and QCheckBox classes provide only toggle buttons; QPushButton and QToolButton provide both toggle and push buttons. +.PP +Any button can have either a text or pixmap label. setText() sets the button to be a text button and setPixmap() sets it to be a pixmap button. The text/pixmap is manipulated as necessary to create the "disabled" appearance when the button is disabled. +.PP +QButton provides most of the states used for buttons: +.TP +isDown() indicates whether the button is \fIpressed\fR down. +.TP +isOn() indicates whether the button is \fIon\fR. Only toggle buttons can be switched on and off (see below). +.TP +isEnabled() indicates whether the button can be pressed by the user. +.TP +setAutoRepeat() sets whether the button will auto-repeat if the user holds it down. +.TP +setToggleButton() sets whether the button is a toggle button or not. +.PP +The difference between isDown() and isOn() is as follows: When the user clicks a toggle button to toggle it on, the button is first \fIpressed\fR and then released into the \fIon\fR state. When the user clicks it again (to toggle it off), the button moves first to the \fIpressed\fR state, then to the \fIoff\fR state (isOn() and isDown() are both FALSE). +.PP +Default buttons (as used in many dialogs) are provided by QPushButton::setDefault() and QPushButton::setAutoDefault(). +.PP +QButton provides five signals: <ol type=1> +.TP +pressed() is emitted when the button is pressed. E.g. with the mouse or when animateClick() is called. +.TP +released() is emitted when the button is released. E.g. when the mouse is released or the cursor is moved outside the widget. +.TP +clicked() is emitted when the button is first pressed and then released when the accelerator key is typed, or when animateClick() is called. +.TP +toggled(bool) is emitted when the state of a toggle button changes. +.TP +stateChanged(int) is emitted when the state of a tristate toggle button changes. +.PP +If the button is a text button with an ampersand (&) in its text, QButton creates an automatic accelerator key. This code creates a push button labelled "Ro<u>c</u>k & Roll" (where the c is underlined). The button gets an automatic accelerator key, Alt+C: +.PP +.nf +.br + QPushButton *p = new QPushButton( "Ro&ck && Roll", this ); +.br +.fi +.PP +In this example, when the user presses Alt+C the button will call animateClick(). +.PP +You can also set a custom accelerator using the setAccel() function. This is useful mostly for pixmap buttons because they have no automatic accelerator. +.PP +.nf +.br + p->setPixmap( QPixmap("print.png") ); +.br + p->setAccel( ALT+Key_F7 ); +.br +.fi +.PP +All of the buttons provided by Qt (QPushButton, QToolButton, QCheckBox and QRadioButton) can display both text and pixmaps. +.PP +To subclass QButton, you must reimplement at least drawButton() (to draw the button's outline) and drawButtonLabel() (to draw its text or pixmap). It is generally advisable to reimplement sizeHint() as well, and sometimes hitButton() (to determine whether a button press is within the button). +.PP +To reduce flickering, QButton::paintEvent() sets up a pixmap that the drawButton() function draws in. You should not reimplement paintEvent() for a subclass of QButton unless you want to take over all drawing. +.PP +See also QButtonGroup and Abstract Widget Classes. +.SS "Member Type Documentation" +.SH "QButton::ToggleState" +This enum defines the state of a toggle button. +.TP +\fCQButton::Off\fR - the button is in the "off" state +.TP +\fCQButton::NoChange\fR - the button is in the default/unchanged state +.TP +\fCQButton::On\fR - the button is in the "on" state +.SH "QButton::ToggleType" +This enum type defines what a button can do in response to a mouse/keyboard press: +.TP +\fCQButton::SingleShot\fR - pressing the button causes an action, then the button returns to the unpressed state. +.TP +\fCQButton::Toggle\fR - pressing the button toggles it between an On and an Off state. +.TP +\fCQButton::Tristate\fR - pressing the button cycles between the three states On, Off and NoChange +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QButton::QButton ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a standard button called \fIname\fR with parent \fIparent\fR, using the widget flags \fIf\fR. +.PP +If \fIparent\fR is a QButtonGroup, this constructor calls QButtonGroup::insert(). +.SH "QButton::~QButton ()" +Destroys the button. +.SH "QKeySequence QButton::accel () const" +Returns the accelerator associated with the button. See the "accel" property for details. +.SH "void QButton::animateClick ()\fC [slot]\fR" +Performs an animated click: the button is pressed and released a short while later. +.PP +The pressed(), released(), clicked(), toggled(), and stateChanged() signals are emitted as appropriate. +.PP +This function does nothing if the button is disabled. +.PP +See also accel. +.SH "bool QButton::autoRepeat () const" +Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. +.SH "bool QButton::autoResize () const" +Returns TRUE if autoResize is enabled; otherwise returns FALSE. See the "autoResize" property for details. +.SH "void QButton::clicked ()\fC [signal]\fR" +This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). +.PP +The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. +.PP +\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. +.PP +See also pressed(), released(), toggled(), autoRepeat, and down. +.PP +Examples: +.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. +.SH "void QButton::drawButton ( QPainter * )\fC [virtual protected]\fR" +Draws the button. The default implementation does nothing. +.PP +This virtual function is reimplemented by subclasses to draw real buttons. At some point, these reimplementations should call drawButtonLabel(). +.PP +See also drawButtonLabel() and paintEvent(). +.SH "void QButton::drawButtonLabel ( QPainter * )\fC [virtual protected]\fR" +Draws the button text or pixmap. +.PP +This virtual function is reimplemented by subclasses to draw real buttons. It is invoked by drawButton(). +.PP +See also drawButton() and paintEvent(). +.SH "QButtonGroup * QButton::group () const" +Returns the group that this button belongs to. +.PP +If the button is not a member of any QButtonGroup, this function returns 0. +.PP +See also QButtonGroup. +.SH "bool QButton::hitButton ( const QPoint & pos ) const\fC [virtual protected]\fR" +Returns TRUE if \fIpos\fR is inside the clickable button rectangle; otherwise returns FALSE. +.PP +By default, the clickable area is the entire widget. Subclasses may reimplement it, though. +.SH "bool QButton::isDown () const" +Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. +.SH "bool QButton::isExclusiveToggle () const" +Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. +.SH "bool QButton::isOn () const" +Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. +.SH "bool QButton::isToggleButton () const" +Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. +.SH "void QButton::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" +Handles paint events for buttons. Small and typically complex buttons are painted double-buffered to reduce flicker. The actually drawing is done in the virtual functions drawButton() and drawButtonLabel(). +.PP +See also drawButton() and drawButtonLabel(). +.PP +Reimplemented from QWidget. +.SH "const QPixmap * QButton::pixmap () const" +Returns the pixmap shown on the button. See the "pixmap" property for details. +.SH "void QButton::pressed ()\fC [signal]\fR" +This signal is emitted when the button is pressed down. +.PP +See also released() and clicked(). +.PP +Examples: +.)l network/httpd/httpd.cpp and popup/popup.cpp. +.SH "void QButton::released ()\fC [signal]\fR" +This signal is emitted when the button is released. +.PP +See also pressed(), clicked(), and toggled(). +.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" +Sets the accelerator associated with the button. See the "accel" property for details. +.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" +Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. +.SH "void QButton::setAutoResize ( bool )" +Sets whether autoResize is enabled. See the "autoResize" property for details. +.SH "void QButton::setDown ( bool )\fC [virtual]\fR" +Sets whether the button is pressed. See the "down" property for details. +.SH "void QButton::setOn ( bool on )\fC [protected]\fR" +Sets the state of this button to On if \fIon\fR is TRUE; otherwise to Off. +.PP +See also toggleState. +.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" +Sets the pixmap shown on the button. See the "pixmap" property for details. +.SH "void QButton::setState ( ToggleState s )\fC [virtual protected]\fR" +Sets the toggle state of the button to \fIs\fR. \fIs\fR can be Off, NoChange or On. +.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" +Sets the text shown on the button. See the "text" property for details. +.SH "void QButton::setToggleButton ( bool b )\fC [protected]\fR" +If \fIb\fR is TRUE, this button becomes a toggle button; if \fIb\fR is FALSE, this button becomes a command button. +.PP +See also toggleButton. +.SH "void QButton::setToggleType ( ToggleType type )\fC [virtual protected]\fR" +Sets the toggle type of the button to \fItype\fR. +.PP +\fItype\fR can be set to SingleShot, Toggle and Tristate. +.SH "ToggleState QButton::state () const" +Returns the state of the toggle button. See the "toggleState" property for details. +.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. +.PP +See also clicked() and QButton::ToggleState. +.SH "QString QButton::text () const" +Returns the text shown on the button. See the "text" property for details. +.SH "void QButton::toggle ()\fC [slot]\fR" +Toggles the state of a toggle button. +.PP +See also on, setOn(), toggled(), and toggleButton. +.SH "ToggleType QButton::toggleType () const" +Returns the type of toggle on the button. See the "toggleType" property for details. +.SH "void QButton::toggled ( bool on )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, or because setOn() was called. +.PP +See also clicked(). +.PP +Example: listbox/listbox.cpp. +.SS "Property Documentation" +.SH "QKeySequence accel" +This property holds the accelerator associated with the button. +.PP +This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. +.PP +Set this property's value with setAccel() and get this property's value with accel(). +.SH "bool autoRepeat" +This property holds whether autoRepeat is enabled. +.PP +If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. +.PP +Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). +.SH "bool autoResize" +This property holds whether autoResize is enabled. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +If autoResize is enabled then the button will resize itself whenever the contents are changed. +.PP +Set this property's value with setAutoResize() and get this property's value with autoResize(). +.SH "bool down" +This property holds whether the button is pressed. +.PP +If this property is TRUE, the button is pressed down. The signals pressed() and clicked() are not emitted if you set this property to TRUE. The default is FALSE. +.PP +Set this property's value with setDown() and get this property's value with isDown(). +.SH "bool exclusiveToggle" +This property holds whether the button is an exclusive toggle. +.PP +If this property is TRUE and the button is in a QButtonGroup, the button can only be toggled off by another one being toggled on. The default is FALSE. +.PP +Get this property's value with isExclusiveToggle(). +.SH "bool on" +This property holds whether the button is toggled. +.PP +This property should only be set for toggle buttons. +.PP +Get this property's value with isOn(). +.SH "QPixmap pixmap" +This property holds the pixmap shown on the button. +.PP +If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. +.PP +pixmap() returns 0 if no pixmap was set. +.PP +Set this property's value with setPixmap() and get this property's value with pixmap(). +.SH "QString text" +This property holds the text shown on the button. +.PP +This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. +.PP +There is no default text. +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "bool toggleButton" +This property holds whether the button is a toggle button. +.PP +The default value is FALSE. +.PP +Get this property's value with isToggleButton(). +.SH "ToggleState toggleState" +This property holds the state of the toggle button. +.PP +If this property is changed then it does not cause the button to be repainted. +.PP +Get this property's value with state(). +.SH "ToggleType toggleType" +This property holds the type of toggle on the button. +.PP +The default toggle type is SingleShot. +.PP +See also QButton::ToggleType. +.PP +Get this property's value with toggleType(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqbutton.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbutton.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbuttongroup.3qt b/doc/man/man3/tqbuttongroup.3qt new file mode 100644 index 000000000..47152394b --- /dev/null +++ b/doc/man/man3/tqbuttongroup.3qt @@ -0,0 +1,243 @@ +'\" t +.TH QButtonGroup 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 +QButtonGroup \- Organizes QButton widgets in a group +.SH SYNOPSIS +\fC#include <ntqbuttongroup.h>\fR +.PP +Inherits QGroupBox. +.PP +Inherited by QHButtonGroup and QVButtonGroup. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQButtonGroup\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQButtonGroup\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQButtonGroup\fR ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQButtonGroup\fR ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "bool \fBisExclusive\fR () const" +.br +.ti -1c +.BI "bool \fBisRadioButtonExclusive\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetExclusive\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetRadioButtonExclusive\fR ( bool )" +.br +.ti -1c +.BI "int \fBinsert\fR ( QButton * button, int id = -1 )" +.br +.ti -1c +.BI "void \fBremove\fR ( QButton * button )" +.br +.ti -1c +.BI "QButton * \fBfind\fR ( int id ) const" +.br +.ti -1c +.BI "int \fBid\fR ( QButton * button ) const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetButton\fR ( int id )" +.br +.ti -1c +.BI "virtual void \fBmoveFocus\fR ( int key )" +.br +.ti -1c +.BI "QButton * \fBselected\fR () const" +.br +.ti -1c +.BI "int \fBselectedId\fR () const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBpressed\fR ( int id )" +.br +.ti -1c +.BI "void \fBreleased\fR ( int id )" +.br +.ti -1c +.BI "void \fBclicked\fR ( int id )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBexclusive\fR - whether the button group is exclusive" +.br +.ti -1c +.BI "bool \fBradioButtonExclusive\fR - whether the radio buttons in the group are exclusive" +.br +.ti -1c +.BI "int \fBselectedId\fR - the selected toggle button" +.br +.in -1c +.SH DESCRIPTION +The QButtonGroup widget organizes QButton widgets in a group. +.PP +A button group widget makes it easier to deal with groups of buttons. Each button in a button group has a unique identifier. The button group emits a clicked() signal with this identifier when a button in the group is clicked. This makes a button group particularly useful when you have several similar buttons and want to connect all their clicked() signals to a single slot. +.PP +An exclusive button group switches off all toggle buttons except the one that was clicked. A button group is, by default, non-exclusive. Note that all radio buttons that are inserted into a button group are mutually exclusive even if the button group is non-exclusive. (See setRadioButtonExclusive().) +.PP +There are two ways of using a button group: +.TP +The button group is the parent widget of a number of buttons, i.e. the button group is the parent argument in the button constructor. The buttons are assigned identifiers 0, 1, 2, etc., in the order they are created. A QButtonGroup can display a frame and a title because it inherits QGroupBox. +.TP +The button group is an invisible widget and the contained buttons have some other parent widget. In this usage, each button must be manually inserted, using insert(), into the button group and given an identifier. +.PP +A button can be removed from the group with remove(). A pointer to a button with a given id can be obtained using find(). The id of a button is available using id(). A button can be set \fIon\fR with setButton(). The number of buttons in the group is returned by count(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QPushButton, QCheckBox, QRadioButton, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QButtonGroup::QButtonGroup ( QWidget * parent = 0, const char * name = 0 )" +Constructs a button group with no title. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QButtonGroup::QButtonGroup ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a button group with the title \fItitle\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QButtonGroup::QButtonGroup ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" +Constructs a button group with no title. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QButtonGroup::QButtonGroup ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a button group with title \fItitle\fR. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "void QButtonGroup::clicked ( int id )\fC [signal]\fR" +This signal is emitted when a button in the group is clicked. The \fIid\fR argument is the button's identifier. +.PP +See also insert(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp and xform/xform.cpp. +.SH "int QButtonGroup::count () const" +Returns the number of buttons in the group. +.SH "QButton * QButtonGroup::find ( int id ) const" +Returns the button with the specified identifier \fIid\fR, or 0 if the button was not found. +.SH "int QButtonGroup::id ( QButton * button ) const" +Returns the id of \fIbutton\fR, or -1 if \fIbutton\fR is not a member of this group. +.PP +See also selectedId. +.SH "int QButtonGroup::insert ( QButton * button, int id = -1 )" +Inserts the \fIbutton\fR with the identifier \fIid\fR into the button group. Returns the button identifier. +.PP +Buttons are normally inserted into a button group automatically by passing the button group as the parent when the button is constructed. So it is not necessary to manually insert buttons that have this button group as their parent widget. An exception is when you want custom identifiers instead of the default 0, 1, 2, etc., or if you want the buttons to have some other parent. +.PP +The button is assigned the identifier \fIid\fR or an automatically generated identifier. It works as follows: If \fIid\fR >= 0, this identifier is assigned. If \fIid\fR == -1 (default), the identifier is equal to the number of buttons in the group. If \fIid\fR is any other negative integer, for instance -2, a unique identifier (negative integer <= -2) is generated. No button has an id of -1. +.PP +See also find(), remove(), and exclusive. +.PP +Examples: +.)l listbox/listbox.cpp and xform/xform.cpp. +.SH "bool QButtonGroup::isExclusive () const" +Returns TRUE if the button group is exclusive; otherwise returns FALSE. See the "exclusive" property for details. +.SH "bool QButtonGroup::isRadioButtonExclusive () const" +Returns TRUE if the radio buttons in the group are exclusive; otherwise returns FALSE. See the "radioButtonExclusive" property for details. +.SH "void QButtonGroup::moveFocus ( int key )\fC [virtual]\fR" +Moves the keyboard focus according to \fIkey\fR, and if appropriate checks the new focus item. +.PP +This function does nothing unless the keyboard focus points to one of the button group members and \fIkey\fR is one of Key_Up, Key_Down, Key_Left and Key_Right. +.SH "void QButtonGroup::pressed ( int id )\fC [signal]\fR" +This signal is emitted when a button in the group is pressed. The \fIid\fR argument is the button's identifier. +.PP +See also insert(). +.SH "void QButtonGroup::released ( int id )\fC [signal]\fR" +This signal is emitted when a button in the group is released. The \fIid\fR argument is the button's identifier. +.PP +See also insert(). +.SH "void QButtonGroup::remove ( QButton * button )" +Removes the \fIbutton\fR from the button group. +.PP +See also insert(). +.SH "QButton * QButtonGroup::selected () const" +Returns the selected toggle button if exactly one is selected; otherwise returns 0. +.PP +See also selectedId. +.SH "int QButtonGroup::selectedId () const" +Returns the selected toggle button. See the "selectedId" property for details. +.SH "void QButtonGroup::setButton ( int id )\fC [virtual]\fR" +Sets the selected toggle button to \fIid\fR. See the "selectedId" property for details. +.SH "void QButtonGroup::setExclusive ( bool )\fC [virtual]\fR" +Sets whether the button group is exclusive. See the "exclusive" property for details. +.SH "void QButtonGroup::setRadioButtonExclusive ( bool )\fC [virtual]\fR" +Sets whether the radio buttons in the group are exclusive. See the "radioButtonExclusive" property for details. +.SS "Property Documentation" +.SH "bool exclusive" +This property holds whether the button group is exclusive. +.PP +If this property is TRUE, then the buttons in the group are toggled, and to untoggle a button you must click on another button in the group. The default value is FALSE. +.PP +Set this property's value with setExclusive() and get this property's value with isExclusive(). +.SH "bool radioButtonExclusive" +This property holds whether the radio buttons in the group are exclusive. +.PP +If this property is TRUE (the default), the radiobuttons in the group are treated exclusively. +.PP +Set this property's value with setRadioButtonExclusive() and get this property's value with isRadioButtonExclusive(). +.SH "int selectedId" +This property holds the selected toggle button. +.PP +The toggle button is specified as an ID. +.PP +If no toggle button is selected, this property holds -1. +.PP +If setButton() is called on an exclusive group, the button with the given id will be set to on and all the others will be set to off. +.PP +See also selected(). +.PP +Set this property's value with setButton() and get this property's value with selectedId(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqbuttongroup.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbuttongroup.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqbytearray.3qt b/doc/man/man3/tqbytearray.3qt new file mode 100644 index 000000000..b768a055e --- /dev/null +++ b/doc/man/man3/tqbytearray.3qt @@ -0,0 +1,99 @@ +'\" t +.TH QByteArray 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 +QByteArray \- Array of bytes +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqcstring.h>\fR +.PP +Inherits QMemArray<char>. +.PP +Inherited by QBitArray and QCString. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQByteArray\fR ()" +.br +.ti -1c +.BI "\fBQByteArray\fR ( int size )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QByteArray \fBqCompress\fR ( const QByteArray & data )" +.br +.ti -1c +.BI "QByteArray \fBqCompress\fR ( const uchar * data, int nbytes )" +.br +.ti -1c +.BI "QByteArray \fBqUncompress\fR ( const QByteArray & data )" +.br +.ti -1c +.BI "QByteArray \fBqUncompress\fR ( const uchar * data, int nbytes )" +.br +.in -1c +.SH DESCRIPTION +The QByteArray class provides an array of bytes. +.PP +The QByteArray class provides an explicitly shared array of bytes. It is useful for manipulating memory areas with custom data. QByteArray is implemented as a QMemArray<char>. See the QMemArray documentation for further information. +.PP +See also Collection Classes and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QByteArray::QByteArray ()" +Constructs an empty QByteArray. +.SH "QByteArray::QByteArray ( int size )" +Constructs a QByteArray of size \fIsize\fR. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QByteArray tqCompress ( const QByteArray & data )" +Compresses the array \fIdata\fR and returns the compressed byte array using zlib. +.PP +See also tqUncompress(). +.SH "QByteArray tqCompress ( const uchar * data, int nbytes )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Compresses the array \fIdata\fR which is \fInbytes\fR long and returns the compressed byte array. +.SH "QByteArray tqUncompress ( const QByteArray & data )" +Uncompresses the array \fIdata\fR and returns the uncompressed byte array. +.PP +Returns an empty QByteArray if the input data was corrupt. +.PP +See also tqCompress(). +.SH "QByteArray tqUncompress ( const uchar * data, int nbytes )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Uncompresses the array \fIdata\fR which is \fInbytes\fR long and returns +the uncompressed byte array. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qbytearray.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqbytearray.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcache.3qt b/doc/man/man3/tqcache.3qt new file mode 100644 index 000000000..d6a1cfa93 --- /dev/null +++ b/doc/man/man3/tqcache.3qt @@ -0,0 +1,215 @@ +'\" t +.TH QCache 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 +QCache \- Template class that provides a cache based on QString keys +.SH SYNOPSIS +\fC#include <ntqcache.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCache\fR ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE )" +.br +.ti -1c +.BI "\fB~QCache\fR ()" +.br +.ti -1c +.BI "int \fBmaxCost\fR () const" +.br +.ti -1c +.BI "int \fBtotalCost\fR () const" +.br +.ti -1c +.BI "void \fBsetMaxCost\fR ( int m )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "bool \fBinsert\fR ( const QString & k, const type * d, int c = 1, int p = 0 )" +.br +.ti -1c +.BI "bool \fBremove\fR ( const QString & k )" +.br +.ti -1c +.BI "type * \fBtake\fR ( const QString & k )" +.br +.ti -1c +.BI "type * \fBfind\fR ( const QString & k, bool ref = TRUE ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( const QString & k ) const" +.br +.ti -1c +.BI "void \fBstatistics\fR () const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.in -1c +.SH DESCRIPTION +The QCache class is a template class that provides a cache based on QString keys. +.PP +A cache is a least recently used (LRU) list of cache items. Each cache item has a key and a certain cost. The sum of item costs, totalCost(), never exceeds the maximum cache cost, maxCost(). If inserting a new item would cause the total cost to exceed the maximum cost, the least recently used items in the cache are removed. +.PP +QCache is a template class. QCache<X> defines a cache that operates on pointers to X, or X*. +.PP +Apart from insert(), by far the most important function is find() (which also exists as operator[]()). This function looks up an item, returns it, and by default marks it as being the most recently used item. +.PP +There are also methods to remove() or take() an object from the cache. Calling setAutoDelete(TRUE) for a cache tells it to delete items that are removed. The default is to not delete items when they are removed (i.e., remove() and take() are equivalent). +.PP +When inserting an item into the cache, only the pointer is copied, not the item itself. This is called a shallow copy. It is possible to make the cache copy all of the item's data (known as a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a cache and reimplement newItem() if you want deep copies. +.PP +When removing a cache item, the virtual function QPtrCollection::deleteItem() is called. The default implementation deletes the item if auto-deletion is enabled, and does nothing otherwise. +.PP +There is a QCacheIterator that can be used to traverse the items in the cache in arbitrary order. +.PP +In QCache, the cache items are accessed via QString keys, which are Unicode strings. If you want to use non-Unicode, plain 8-bit \fCchar*\fR keys, use the QAsciiCache template. A QCache has the same performance as a QAsciiCache. +.PP +See also QCacheIterator, QAsciiCache, QIntCache, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCache::QCache ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE )" +Constructs a cache whose contents will never have a total cost greater than \fImaxCost\fR and which is expected to contain less than \fIsize\fR items. +.PP +\fIsize\fR is actually the size of an internal hash array; it's usually best to make it a prime number and at least 50% bigger than the largest expected number of items in the cache. +.PP +Each inserted item has an associated cost. When inserting a new item, if the total cost of all items in the cache will exceed \fImaxCost\fR, the cache will start throwing out the older (least recently used) items until there is enough room for the new item to be inserted. +.PP +If \fIcaseSensitive\fR is TRUE (the default), the cache keys are case sensitive; if it is FALSE, they are case-insensitive. Case-insensitive comparison considers all Unicode letters. +.SH "QCache::~QCache ()" +Removes all items from the cache and destroys it. All iterators that access this cache will be reset. +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QCache::clear ()\fC [virtual]\fR" +Removes all items from the cache and deletes them if auto-deletion has been enabled. +.PP +All cache iterators that operate this on cache are reset. +.PP +See also remove() and take(). +.PP +Reimplemented from QPtrCollection. +.SH "uint QCache::count () const\fC [virtual]\fR" +Returns the number of items in the cache. +.PP +See also totalCost(). +.PP +Reimplemented from QPtrCollection. +.SH "type * QCache::find ( const QString & k, bool ref = TRUE ) const" +Returns the item associated with key \fIk\fR, or 0 if the key does not exist in the cache. If \fIref\fR is TRUE (the default), the item is moved to the front of the least recently used list. +.PP +If there are two or more items with equal keys, the one that was inserted last is returned. +.SH "bool QCache::insert ( const QString & k, const type * d, int c = 1, int p = 0 )" +Inserts the item \fId\fR into the cache with key \fIk\fR and associated cost, \fIc\fR. Returns TRUE if it is successfully inserted; otherwise returns FALSE. +.PP +The cache's size is limited, and if the total cost is too high, QCache will remove old, least recently used items until there is room for this new item. +.PP +The parameter \fIp\fR is internal and should be left at the default value (0). +.PP +\fBWarning:\fR If this function returns FALSE (which could happen, e.g. if the cost of this item alone exceeds maxCost()) you must delete \fId\fR yourself. Additionally, be very careful about using \fId\fR after calling this function because any other insertions into the cache, from anywhere in the application or within Qt itself, could cause the object to be discarded from the cache and the pointer to become invalid. +.SH "bool QCache::isEmpty () const" +Returns TRUE if the cache is empty; otherwise returns FALSE. +.SH "int QCache::maxCost () const" +Returns the maximum allowed total cost of the cache. +.PP +See also setMaxCost() and totalCost(). +.SH "type * QCache::operator[] ( const QString & k ) const" +Returns the item associated with key \fIk\fR, or 0 if \fIk\fR does not exist in the cache, and moves the item to the front of the least recently used list. +.PP +If there are two or more items with equal keys, the one that was inserted last is returned. +.PP +This is the same as find( k, TRUE ). +.PP +See also find(). +.SH "bool QCache::remove ( const QString & k )" +Removes the item associated with \fIk\fR, and returns TRUE if the item was present in the cache; otherwise returns FALSE. +.PP +The item is deleted if auto-deletion has been enabled, i.e., if you have called setAutoDelete(TRUE). +.PP +If there are two or more items with equal keys, the one that was inserted last is removed. +.PP +All iterators that refer to the removed item are set to point to the next item in the cache's traversal order. +.PP +See also take() and clear(). +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. +.SH "void QCache::setMaxCost ( int m )" +Sets the maximum allowed total cost of the cache to \fIm\fR. If the current total cost is greater than \fIm\fR, some items are deleted immediately. +.PP +See also maxCost() and totalCost(). +.SH "uint QCache::size () const" +Returns the size of the hash array used to implement the cache. This should be a bit bigger than count() is likely to be. +.SH "void QCache::statistics () const" +A debug-only utility function. Prints out cache usage, hit/miss, and distribution information using tqDebug(). This function does nothing in the release library. +.SH "type * QCache::take ( const QString & k )" +Takes the item associated with \fIk\fR out of the cache without deleting it, and returns a pointer to the item taken out, or 0 if the key does not exist in the cache. +.PP +If there are two or more items with equal keys, the one that was inserted last is taken. +.PP +All iterators that refer to the taken item are set to point to the next item in the cache's traversal order. +.PP +See also remove() and clear(). +.SH "int QCache::totalCost () const" +Returns the total cost of the items in the cache. This is an integer in the range 0 to maxCost(). +.PP +See also setMaxCost(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcache.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcache.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcacheiterator.3qt b/doc/man/man3/tqcacheiterator.3qt new file mode 100644 index 000000000..bbe481cad --- /dev/null +++ b/doc/man/man3/tqcacheiterator.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QCacheIterator 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 +QCacheIterator \- Iterator for QCache collections +.SH SYNOPSIS +\fC#include <ntqcache.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCacheIterator\fR ( const QCache<type> & cache )" +.br +.ti -1c +.BI "\fBQCacheIterator\fR ( const QCacheIterator<type> & ci )" +.br +.ti -1c +.BI "QCacheIterator<type> & \fBoperator=\fR ( const QCacheIterator<type> & ci )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBatFirst\fR () const" +.br +.ti -1c +.BI "bool \fBatLast\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "type * \fBtoLast\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "QString \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.ti -1c +.BI "type * \fBoperator--\fR ()" +.br +.ti -1c +.BI "type * \fBoperator-=\fR ( uint jump )" +.br +.in -1c +.SH DESCRIPTION +The QCacheIterator class provides an iterator for QCache collections. +.PP +Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them. +.PP +Multiple iterators are completely independent, even when they operate on the same QCache. QCache updates all iterators that refer an item when that item is removed. +.PP +QCacheIterator provides an operator++(), and an operator+=() to traverse the cache. The current() and currentKey() functions are used to access the current cache item and its key. The atFirst() and atLast() return TRUE if the iterator points to the first or last item in the cache respectively. The isEmpty() function returns TRUE if the cache is empty, and count() returns the number of items in the cache. +.PP +Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also QCache, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCacheIterator::QCacheIterator ( const QCache<type> & cache )" +Constructs an iterator for \fIcache\fR. The current iterator item is set to point to the first item in the \fIcache\fR. +.SH "QCacheIterator::QCacheIterator ( const QCacheIterator<type> & ci )" +Constructs an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently from there on. +.SH "bool QCacheIterator::atFirst () const" +Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toFirst() and atLast(). +.SH "bool QCacheIterator::atLast () const" +Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toLast() and atFirst(). +.SH "uint QCacheIterator::count () const" +Returns the number of items in the cache on which this iterator operates. +.PP +See also isEmpty(). +.SH "type * QCacheIterator::current () const" +Returns a pointer to the current iterator item. +.SH "QString QCacheIterator::currentKey () const" +Returns the key for the current iterator item. +.SH "bool QCacheIterator::isEmpty () const" +Returns TRUE if the cache is empty, i.e. count() == 0; otherwise it returns FALSE. +.PP +See also count(). +.SH "QCacheIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QCacheIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the cache or if it was 0, 0 is returned. +.SH "type * QCacheIterator::operator++ ()" +Prefix++ makes the iterator point to the item just after current() and makes that the new current item for the iterator. If current() was the last item, operator++() returns 0. +.SH "type * QCacheIterator::operator+= ( uint jump )" +Returns the item \fIjump\fR positions after the current item, or 0 if it is beyond the last item. Makes this the current item. +.SH "type * QCacheIterator::operator-- ()" +Prefix-- makes the iterator point to the item just before current() and makes that the new current item for the iterator. If current() was the first item, operator--() returns 0. +.SH "type * QCacheIterator::operator-= ( uint jump )" +Returns the item \fIjump\fR positions before the current item, or 0 if it is before the first item. Makes this the current item. +.SH "QCacheIterator<type> & QCacheIterator::operator= ( const QCacheIterator<type> & ci )" +Makes this an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently thereafter. +.SH "type * QCacheIterator::toFirst ()" +Sets the iterator to point to the first item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0 and returns 0 if the cache is empty. +.PP +See also toLast() and isEmpty(). +.SH "type * QCacheIterator::toLast ()" +Sets the iterator to point to the last item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0 and returns 0 if the cache is empty. +.PP +See also toFirst() and isEmpty(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcacheiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcacheiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvas.3qt b/doc/man/man3/tqcanvas.3qt new file mode 100644 index 000000000..b766b758f --- /dev/null +++ b/doc/man/man3/tqcanvas.3qt @@ -0,0 +1,457 @@ +'\" t +.TH QCanvas 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 +QCanvas \- 2D area that can contain QCanvasItem objects +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvas\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQCanvas\fR ( int w, int h )" +.br +.ti -1c +.BI "\fBQCanvas\fR ( QPixmap p, int h, int v, int tilewidth, int tileheight )" +.br +.ti -1c +.BI "virtual \fB~QCanvas\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetTiles\fR ( QPixmap p, int h, int v, int tilewidth, int tileheight )" +.br +.ti -1c +.BI "virtual void \fBsetBackgroundPixmap\fR ( const QPixmap & p )" +.br +.ti -1c +.BI "QPixmap \fBbackgroundPixmap\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetBackgroundColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "QColor \fBbackgroundColor\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTile\fR ( int x, int y, int tilenum )" +.br +.ti -1c +.BI "int \fBtile\fR ( int x, int y ) const" +.br +.ti -1c +.BI "int \fBtilesHorizontally\fR () const" +.br +.ti -1c +.BI "int \fBtilesVertically\fR () const" +.br +.ti -1c +.BI "int \fBtileWidth\fR () const" +.br +.ti -1c +.BI "int \fBtileHeight\fR () const" +.br +.ti -1c +.BI "virtual void \fBresize\fR ( int w, int h )" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "bool \fBonCanvas\fR ( int x, int y ) const" +.br +.ti -1c +.BI "bool \fBonCanvas\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "bool \fBvalidChunk\fR ( int x, int y ) const" +.br +.ti -1c +.BI "bool \fBvalidChunk\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "int \fBchunkSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBretune\fR ( int chunksze, int mxclusters = 100 )" +.br +.ti -1c +.BI "virtual void \fBsetAllChanged\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetChanged\fR ( const QRect & area )" +.br +.ti -1c +.BI "virtual void \fBsetUnchanged\fR ( const QRect & area )" +.br +.ti -1c +.BI "QCanvasItemList \fBallItems\fR ()" +.br +.ti -1c +.BI "QCanvasItemList \fBcollisions\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "QCanvasItemList \fBcollisions\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "QCanvasItemList \fBcollisions\fR ( const QPointArray & chunklist, const QCanvasItem * item, bool exact ) const" +.br +.ti -1c +.BI "void \fBdrawArea\fR ( const QRect & clip, QPainter * painter, bool dbuf = FALSE )" +.br +.ti -1c +.BI "virtual void \fBsetAdvancePeriod\fR ( int ms )" +.br +.ti -1c +.BI "virtual void \fBsetUpdatePeriod\fR ( int ms )" +.br +.ti -1c +.BI "virtual void \fBsetDoubleBuffering\fR ( bool y )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBadvance\fR ()" +.br +.ti -1c +.BI "virtual void \fBupdate\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBresized\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawBackground\fR ( QPainter & painter, const QRect & clip )" +.br +.ti -1c +.BI "virtual void \fBdrawForeground\fR ( QPainter & painter, const QRect & clip )" +.br +.in -1c +.SH DESCRIPTION +The QCanvas class provides a 2D area that can contain QCanvasItem objects. +.PP +The QCanvas class manages its 2D graphic area and all the canvas items the area contains. The canvas has no visual appearance of its own. Instead, it is displayed on screen using a QCanvasView. Multiple QCanvasView widgets may be associated with a canvas to provide multiple views of the same canvas. +.PP +The canvas is optimized for large numbers of items, particularly where only a small percentage of the items change at any one time. If the entire display changes very frequently, you should consider using your own custom QScrollView subclass. +.PP +Qt provides a rich set of canvas item classes, e.g. QCanvasEllipse, QCanvasLine, QCanvasPolygon, QCanvasPolygonalItem, QCanvasRectangle, QCanvasSpline, QCanvasSprite and QCanvasText. You can subclass to create your own canvas items; QCanvasPolygonalItem is the most common base class used for this purpose. +.PP +Items appear on the canvas after their show() function has been called (or setVisible(TRUE)), and \fIafter\fR update() has been called. The canvas only shows items that are visible, and then only if update() is called. (By default the canvas is white and so are canvas items, so if nothing appears try changing colors.) +.PP +If you created the canvas without passing a width and height to the constructor you must also call resize(). +.PP +Although a canvas may appear to be similar to a widget with child widgets, there are several notable differences: +.TP +Canvas items are usually much faster to manipulate and redraw than child widgets, with the speed advantage becoming especially great when there are \fImany\fR canvas items and non-rectangular items. In most situations canvas items are also a lot more memory efficient than child widgets. +.IP +.TP +It's easy to detect overlapping items (collision detection). +.IP +.TP +The canvas can be larger than a widget. A million-by-million canvas is perfectly possible. At such a size a widget might be very inefficient, and some window systems might not support it at all, whereas QCanvas scales well. Even with a billion pixels and a million items, finding a particular canvas item, detecting collisions, etc., is still fast (though the memory consumption may be prohibitive at such extremes). +.IP +.TP +Two or more QCanvasView objects can view the same canvas. +.IP +.TP +An arbitrary transformation matrix can be set on each QCanvasView which makes it easy to zoom, rotate or shear the viewed canvas. +.IP +.TP +Widgets provide a lot more functionality, such as input (QKeyEvent, QMouseEvent etc.) and layout management (QGridLayout etc.). +.IP +.PP +A canvas consists of a background, a number of canvas items organized by x, y and z coordinates, and a foreground. A canvas item's z coordinate can be treated as a layer number -- canvas items with a higher z coordinate appear in front of canvas items with a lower z coordinate. +.PP +The background is white by default, but can be set to a different color using setBackgroundColor(), or to a repeated pixmap using setBackgroundPixmap() or to a mosaic of smaller pixmaps using setTiles(). Individual tiles can be set with setTile(). There are corresponding get functions, e.g. backgroundColor() and backgroundPixmap(). +.PP +Note that QCanvas does not inherit from QWidget, even though it has some functions which provide the same functionality as those in QWidget. One of these is setBackgroundPixmap(); some others are resize(), size(), width() and height(). QCanvasView is the widget used to display a canvas on the screen. +.PP +Canvas items are added to a canvas by constructing them and passing the canvas to the canvas item's constructor. An item can be moved to a different canvas using QCanvasItem::setCanvas(). +.PP +Canvas items are movable (and in the case of QCanvasSprites, animated) objects that inherit QCanvasItem. Each canvas item has a position on the canvas (x, y coordinates) and a height (z coordinate), all of which are held as floating-point numbers. Moving canvas items also have x and y velocities. It's possible for a canvas item to be outside the canvas (for example QCanvasItem::x() is greater than width()). When a canvas item is off the canvas, onCanvas() returns FALSE and the canvas disregards the item. (Canvas items off the canvas do not slow down any of the common operations on the canvas.) +.PP +Canvas items can be moved with QCanvasItem::move(). The advance() function moves all QCanvasItem::animated() canvas items and setAdvancePeriod() makes QCanvas move them automatically on a periodic basis. In the context of the QCanvas classes, to `animate' a canvas item is to set it in motion, i.e. using QCanvasItem::setVelocity(). Animation of a canvas item itself, i.e. items which change over time, is enabled by calling QCanvasSprite::setFrameAnimation(), or more generally by subclassing and reimplementing QCanvasItem::advance(). To detect collisions use one of the QCanvasItem::collisions() functions. +.PP +The changed parts of the canvas are redrawn (if they are visible in a canvas view) whenever update() is called. You can either call update() manually after having changed the contents of the canvas, or force periodic updates using setUpdatePeriod(). If you have moving objects on the canvas, you must call advance() every time the objects should move one step further. Periodic calls to advance() can be forced using setAdvancePeriod(). The advance() function will call QCanvasItem::advance() on every item that is animated and trigger an update of the affected areas afterwards. (A canvas item that is `animated' is simply a canvas item that is in motion.) +.PP +QCanvas organizes its canvas items into \fIchunks\fR; these are areas on the canvas that are used to speed up most operations. Many operations start by eliminating most chunks (i.e. those which haven't changed) and then process only the canvas items that are in the few interesting (i.e. changed) chunks. A valid chunk, validChunk(), is one which is on the canvas. +.PP +The chunk size is a key factor to QCanvas's speed: if there are too many chunks, the speed benefit of grouping canvas items into chunks is reduced. If the chunks are too large, it takes too long to process each one. The QCanvas constructor tries to pick a suitable size, but you can call retune() to change it at any time. The chunkSize() function returns the current chunk size. The canvas items always make sure they're in the right chunks; all you need to make sure of is that the canvas uses the right chunk size. A good rule of thumb is that the size should be a bit smaller than the average canvas item size. If you have moving objects, the chunk size should be a bit smaller than the average size of the moving items. +.PP +The foreground is normally nothing, but if you reimplement drawForeground(), you can draw things in front of all the canvas items. +.PP +Areas can be set as changed with setChanged() and set unchanged with setUnchanged(). The entire canvas can be set as changed with setAllChanged(). A list of all the items on the canvas is returned by allItems(). +.PP +An area can be copied (painted) to a QPainter with drawArea(). +.PP +If the canvas is resized it emits the resized() signal. +.PP +The examples/canvas application and the 2D graphics page of the examples/demo application demonstrate many of QCanvas's facilities. +.PP +See also QCanvasView, QCanvasItem, Abstract Widget Classes, Graphics Classes, and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvas::QCanvas ( QObject * parent = 0, const char * name = 0 )" +Create a QCanvas with no size. \fIparent\fR and \fIname\fR are passed to the QObject superclass. +.PP +\fBWarning:\fR You \fImust\fR call resize() at some time after creation to be able to use the canvas. +.SH "QCanvas::QCanvas ( int w, int h )" +Constructs a QCanvas that is \fIw\fR pixels wide and \fIh\fR pixels high. +.SH "QCanvas::QCanvas ( QPixmap p, int h, int v, int tilewidth, int tileheight )" +Constructs a QCanvas which will be composed of \fIh\fR tiles horizontally and \fIv\fR tiles vertically. Each tile will be an image \fItilewidth\fR by \fItileheight\fR pixels taken from pixmap \fIp\fR. +.PP +The pixmap \fIp\fR is a list of tiles, arranged left to right, (and in the case of pixmaps that have multiple rows of tiles, top to bottom), with tile 0 in the top-left corner, tile 1 next to the right, and so on, e.g. +.PP +<center>.nf +.TS +l - l. 0 1 2 3 4 5 6 +.TE +.fi +</center> +.PP +The QCanvas is initially sized to show exactly the given number of tiles horizontally and vertically. If it is resized to be larger, the entire matrix of tiles will be repeated as often as necessary to cover the area. If it is smaller, tiles to the right and bottom will not be visible. +.PP +See also setTiles(). +.SH "QCanvas::~QCanvas ()\fC [virtual]\fR" +Destroys the canvas and all the canvas's canvas items. +.SH "void QCanvas::advance ()\fC [virtual slot]\fR" +Moves all QCanvasItem::animated() canvas items on the canvas and refreshes all changes to all views of the canvas. (An `animated' item is an item that is in motion; see setVelocity().) +.PP +The advance takes place in two phases. In phase 0, the QCanvasItem::advance() function of each QCanvasItem::animated() canvas item is called with paramater 0. Then all these canvas items are called again, with parameter 1. In phase 0, the canvas items should not change position, merely examine other items on the canvas for which special processing is required, such as collisions between items. In phase 1, all canvas items should change positions, ignoring any other items on the canvas. This two-phase approach allows for considerations of "fairness", although no QCanvasItem subclasses supplied with Qt do anything interesting in phase 0. +.PP +The canvas can be configured to call this function periodically with setAdvancePeriod(). +.PP +See also update(). +.SH "QCanvasItemList QCanvas::allItems ()" +Returns a list of all the items in the canvas. +.SH "QColor QCanvas::backgroundColor () const" +Returns the color set by setBackgroundColor(). By default, this is white. +.PP +This function is not a reimplementation of QWidget::backgroundColor() (QCanvas is not a subclass of QWidget), but all QCanvasViews that are viewing the canvas will set their backgrounds to this color. +.PP +See also setBackgroundColor() and backgroundPixmap(). +.SH "QPixmap QCanvas::backgroundPixmap () const" +Returns the pixmap set by setBackgroundPixmap(). By default, this is a null pixmap. +.PP +See also setBackgroundPixmap() and backgroundColor(). +.SH "int QCanvas::chunkSize () const" +Returns the chunk size of the canvas. +.PP +See also retune(). +.SH "QCanvasItemList QCanvas::collisions ( const QPoint & p ) const" +Returns a list of canvas items that collide with the point \fIp\fR. The list is ordered by z coordinates, from highest z coordinate (front-most item) to lowest z coordinate (rear-most item). +.SH "QCanvasItemList QCanvas::collisions ( const QRect & r ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a list of items which collide with the rectangle \fIr\fR. The list is ordered by z coordinates, from highest z coordinate (front-most item) to lowest z coordinate (rear-most item). +.SH "QCanvasItemList QCanvas::collisions ( const QPointArray & chunklist, const QCanvasItem * item, bool exact ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a list of canvas items which intersect with the chunks listed in \fIchunklist\fR, excluding \fIitem\fR. If \fIexact\fR is TRUE, only those which actually collide with \fIitem\fR are returned; otherwise canvas items are included just for being in the chunks. +.PP +This is a utility function mainly used to implement the simpler QCanvasItem::collisions() function. +.SH "void QCanvas::drawArea ( const QRect & clip, QPainter * painter, bool dbuf = FALSE )" +Paints all canvas items that are in the area \fIclip\fR to \fIpainter\fR, using double-buffering if \fIdbuf\fR is TRUE. +.PP +e.g. to print the canvas to a printer: +.PP +.nf +.br + QPrinter pr; +.br + if ( pr.setup() ) { +.br + QPainter p(&pr); +.br + canvas.drawArea( canvas.rect(), &p ); +.br + } +.br +.fi +.PP +Example: canvas/canvas.cpp. +.SH "void QCanvas::drawBackground ( QPainter & painter, const QRect & clip )\fC [virtual protected]\fR" +This virtual function is called for all updates of the canvas. It renders any background graphics using the painter \fIpainter\fR, in the area \fIclip\fR. If the canvas has a background pixmap or a tiled background, that graphic is used, otherwise the canvas is cleared using the background color. +.PP +If the graphics for an area change, you must explicitly call setChanged(const QRect&) for the result to be visible when update() is next called. +.PP +See also setBackgroundColor(), setBackgroundPixmap(), and setTiles(). +.SH "void QCanvas::drawForeground ( QPainter & painter, const QRect & clip )\fC [virtual protected]\fR" +This virtual function is called for all updates of the canvas. It renders any foreground graphics using the painter \fIpainter\fR, in the area \fIclip\fR. +.PP +If the graphics for an area change, you must explicitly call setChanged(const QRect&) for the result to be visible when update() is next called. +.PP +The default is to draw nothing. +.SH "int QCanvas::height () const" +Returns the height of the canvas, in pixels. +.PP +Example: canvas/canvas.cpp. +.SH "bool QCanvas::onCanvas ( int x, int y ) const" +Returns TRUE if the pixel position (\fIx\fR, \fIy\fR) is on the canvas; otherwise returns FALSE. +.PP +See also validChunk(). +.SH "bool QCanvas::onCanvas ( const QPoint & p ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the pixel position \fIp\fR is on the canvas; otherwise returns FALSE. +.PP +See also validChunk(). +.SH "QRect QCanvas::rect () const" +Returns a rectangle the size of the canvas. +.SH "void QCanvas::resize ( int w, int h )\fC [virtual]\fR" +Changes the size of the canvas to have a width of \fIw\fR and a height of \fIh\fR. This is a slow operation. +.PP +Examples: +.)l canvas/canvas.cpp and chart/chartform.cpp. +.SH "void QCanvas::resized ()\fC [signal]\fR" +This signal is emitted whenever the canvas is resized. Each QCanvasView connects to this signal to keep the scrollview's size correct. +.SH "void QCanvas::retune ( int chunksze, int mxclusters = 100 )\fC [virtual]\fR" +Change the efficiency tuning parameters to \fImxclusters\fR clusters, each of size \fIchunksze\fR. This is a slow operation if there are many objects on the canvas. +.PP +The canvas is divided into chunks which are rectangular areas \fIchunksze\fR wide by \fIchunksze\fR high. Use a chunk size which is about the average size of the canvas items. If you choose a chunk size which is too small it will increase the amount of calculation required when drawing since each change will affect many chunks. If you choose a chunk size which is too large the amount of drawing required will increase because for each change, a lot of drawing will be required since there will be many (unchanged) canvas items which are in the same chunk as the changed canvas items. +.PP +Internally, a canvas uses a low-resolution "chunk matrix" to keep track of all the items in the canvas. A 64x64 chunk matrix is the default for a 1024x1024 pixel canvas, where each chunk collects canvas items in a 16x16 pixel square. This default is also affected by setTiles(). You can tune this default using this function. For example if you have a very large canvas and want to trade off speed for memory then you might set the chunk size to 32 or 64. +.PP +The \fImxclusters\fR argument is the number of rectangular groups of chunks that will be separately drawn. If the canvas has a large number of small, dispersed items, this should be about that number. Our testing suggests that a large number of clusters is almost always best. +.SH "void QCanvas::setAdvancePeriod ( int ms )\fC [virtual]\fR" +Sets the canvas to call advance() every \fIms\fR milliseconds. Any previous setting by setAdvancePeriod() or setUpdatePeriod() is overridden. +.PP +If \fIms\fR is less than 0 advancing will be stopped. +.PP +Example: canvas/main.cpp. +.SH "void QCanvas::setAllChanged ()\fC [virtual]\fR" +Marks the whole canvas as changed. All views of the canvas will be entirely redrawn when update() is called next. +.SH "void QCanvas::setBackgroundColor ( const QColor & c )\fC [virtual]\fR" +Sets the solid background to be the color \fIc\fR. +.PP +See also backgroundColor(), setBackgroundPixmap(), and setTiles(). +.SH "void QCanvas::setBackgroundPixmap ( const QPixmap & p )\fC [virtual]\fR" +Sets the solid background to be the pixmap \fIp\fR repeated as necessary to cover the entire canvas. +.PP +See also backgroundPixmap(), setBackgroundColor(), and setTiles(). +.SH "void QCanvas::setChanged ( const QRect & area )\fC [virtual]\fR" +Marks \fIarea\fR as changed. This \fIarea\fR will be redrawn in all views that are showing it when update() is called next. +.SH "void QCanvas::setDoubleBuffering ( bool y )\fC [virtual]\fR" +If \fIy\fR is TRUE (the default) double-buffering is switched on; otherwise double-buffering is switched off. +.PP +Turning off double-buffering causes the redrawn areas to flicker a little and also gives a (usually small) performance improvement. +.PP +Example: canvas/canvas.cpp. +.SH "void QCanvas::setTile ( int x, int y, int tilenum )\fC [virtual]\fR" +Sets the tile at (\fIx\fR, \fIy\fR) to use tile number \fItilenum\fR, which is an index into the tile pixmaps. The canvas will update appropriately when update() is next called. +.PP +The images are taken from the pixmap set by setTiles() and are arranged left to right, (and in the case of pixmaps that have multiple rows of tiles, top to bottom), with tile 0 in the top-left corner, tile 1 next to the right, and so on, e.g. +.PP +<center>.nf +.TS +l - l. 0 1 2 3 4 5 6 +.TE +.fi +</center> +.PP +See also tile() and setTiles(). +.SH "void QCanvas::setTiles ( QPixmap p, int h, int v, int tilewidth, int tileheight )\fC [virtual]\fR" +Sets the QCanvas to be composed of \fIh\fR tiles horizontally and \fIv\fR tiles vertically. Each tile will be an image \fItilewidth\fR by \fItileheight\fR pixels from pixmap \fIp\fR. +.PP +The pixmap \fIp\fR is a list of tiles, arranged left to right, (and in the case of pixmaps that have multiple rows of tiles, top to bottom), with tile 0 in the top-left corner, tile 1 next to the right, and so on, e.g. +.PP +<center>.nf +.TS +l - l. 0 1 2 3 4 5 6 +.TE +.fi +</center> +.PP +If the canvas is larger than the matrix of tiles, the entire matrix is repeated as necessary to cover the whole canvas. If it is smaller, tiles to the right and bottom are not visible. +.PP +The width and height of \fIp\fR must be a multiple of \fItilewidth\fR and \fItileheight\fR. If they are not the function will do nothing. +.PP +If you want to unset any tiling set, then just pass in a null pixmap and 0 for \fIh\fR, \fIv\fR, \fItilewidth\fR, and \fItileheight\fR. +.SH "void QCanvas::setUnchanged ( const QRect & area )\fC [virtual]\fR" +Marks \fIarea\fR as \fIunchanged\fR. The area will \fInot\fR be redrawn in the views for the next update(), unless it is marked or changed again before the next call to update(). +.SH "void QCanvas::setUpdatePeriod ( int ms )\fC [virtual]\fR" +Sets the canvas to call update() every \fIms\fR milliseconds. Any previous setting by setAdvancePeriod() or setUpdatePeriod() is overridden. +.PP +If \fIms\fR is less than 0 automatic updating will be stopped. +.SH "QSize QCanvas::size () const" +Returns the size of the canvas, in pixels. +.SH "int QCanvas::tile ( int x, int y ) const" +Returns the tile at position (\fIx\fR, \fIy\fR). Initially, all tiles are 0. +.PP +The parameters must be within range, i.e. 0 < \fIx\fR < tilesHorizontally() and 0 < \fIy\fR < tilesVertically(). +.PP +See also setTile(). +.SH "int QCanvas::tileHeight () const" +Returns the height of each tile. +.SH "int QCanvas::tileWidth () const" +Returns the width of each tile. +.SH "int QCanvas::tilesHorizontally () const" +Returns the number of tiles horizontally. +.SH "int QCanvas::tilesVertically () const" +Returns the number of tiles vertically. +.SH "void QCanvas::update ()\fC [virtual slot]\fR" +Repaints changed areas in all views of the canvas. +.PP +See also advance(). +.SH "bool QCanvas::validChunk ( int x, int y ) const" +Returns TRUE if the chunk position (\fIx\fR, \fIy\fR) is on the canvas; otherwise returns FALSE. +.PP +See also onCanvas(). +.SH "bool QCanvas::validChunk ( const QPoint & p ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the chunk position \fIp\fR is on the canvas; otherwise returns FALSE. +.PP +See also onCanvas(). +.SH "int QCanvas::width () const" +Returns the width of the canvas, in pixels. +.PP +Example: canvas/canvas.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcanvas.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvas.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvasellipse.3qt b/doc/man/man3/tqcanvasellipse.3qt new file mode 100644 index 000000000..ecb8402aa --- /dev/null +++ b/doc/man/man3/tqcanvasellipse.3qt @@ -0,0 +1,145 @@ +'\" t +.TH QCanvasEllipse 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 +QCanvasEllipse \- Ellipse or ellipse segment on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasPolygonalItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasEllipse\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "\fBQCanvasEllipse\fR ( int width, int height, QCanvas * canvas )" +.br +.ti -1c +.BI "\fBQCanvasEllipse\fR ( int width, int height, int startangle, int angle, QCanvas * canvas )" +.br +.ti -1c +.BI "\fB~QCanvasEllipse\fR ()" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "void \fBsetSize\fR ( int width, int height )" +.br +.ti -1c +.BI "void \fBsetAngles\fR ( int start, int length )" +.br +.ti -1c +.BI "int \fBangleStart\fR () const" +.br +.ti -1c +.BI "int \fBangleLength\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawShape\fR ( QPainter & p )" +.br +.in -1c +.SH DESCRIPTION +The QCanvasEllipse class provides an ellipse or ellipse segment on a QCanvas. +.PP +A canvas item that paints an ellipse or ellipse segment with a QBrush. The ellipse's height, width, start angle and angle length can be set at construction time. The size can be changed at runtime with setSize(), and the angles can be changed (if you're displaying an ellipse segment rather than a whole ellipse) with setAngles(). +.PP +Note that angles are specified in 16ths of a degree. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +If a start angle and length angle are set then an ellipse segment will be drawn. The start angle is the angle that goes from zero in a counter-clockwise direction (shown in green in the diagram). The length angle is the angle from the start angle in a counter-clockwise direction (shown in blue in the diagram). The blue segment is the segment of the ellipse that would be drawn. If no start angle and length angle are specified the entire ellipse is drawn. +.PP +The ellipse can be drawn on a painter with drawShape(). +.PP +Like any other canvas item ellipses can be moved with move() and moveBy(), or by setting coordinates with setX(), setY() and setZ(). +.PP +Note: QCanvasEllipse does not use the pen. +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasEllipse::QCanvasEllipse ( QCanvas * canvas )" +Constructs a 32x32 ellipse, centered at (0, 0) on \fIcanvas\fR. +.SH "QCanvasEllipse::QCanvasEllipse ( int width, int height, QCanvas * canvas )" +Constructs a \fIwidth\fR by \fIheight\fR pixel ellipse, centered at (0, 0) on \fIcanvas\fR. +.SH "QCanvasEllipse::QCanvasEllipse ( int width, int height, int startangle, int angle, QCanvas * canvas )" +Constructs a \fIwidth\fR by \fIheight\fR pixel ellipse, centered at (0, 0) on \fIcanvas\fR. Only a segment of the ellipse is drawn, starting at angle \fIstartangle\fR, and extending for angle \fIangle\fR (the angle length). +.PP +Note that angles are specified in <small><sup>1</sup>/<sub>16</sub></small>ths of a degree. +.SH "QCanvasEllipse::~QCanvasEllipse ()" +Destroys the ellipse. +.SH "int QCanvasEllipse::angleLength () const" +Returns the length angle (the extent of the ellipse segment) in 16ths of a degree. Initially this will be 360 * 16 (a complete ellipse). +.PP +See also setAngles() and angleStart(). +.SH "int QCanvasEllipse::angleStart () const" +Returns the start angle in 16ths of a degree. Initially this will be 0. +.PP +See also setAngles() and angleLength(). +.SH "void QCanvasEllipse::drawShape ( QPainter & p )\fC [virtual protected]\fR" +Draws the ellipse, centered at x(), y() using the painter \fIp\fR. +.PP +Note that QCanvasEllipse does not support an outline (the pen is always NoPen). +.PP +Reimplemented from QCanvasPolygonalItem. +.SH "int QCanvasEllipse::height () const" +Returns the height of the ellipse. +.SH "int QCanvasEllipse::rtti () const\fC [virtual]\fR" +Returns 6 (QCanvasItem::Rtti_Ellipse). +.PP +See also QCanvasItem::rtti(). +.PP +Reimplemented from QCanvasPolygonalItem. +.SH "void QCanvasEllipse::setAngles ( int start, int length )" +Sets the angles for the ellipse. The start angle is \fIstart\fR and the extent of the segment is \fIlength\fR (the angle length) from the \fIstart\fR. The angles are specified in 16ths of a degree. By default the ellipse will start at 0 and have an angle length of 360 * 16 (a complete ellipse). +.PP +See also angleStart() and angleLength(). +.SH "void QCanvasEllipse::setSize ( int width, int height )" +Sets the \fIwidth\fR and \fIheight\fR of the ellipse. +.SH "int QCanvasEllipse::width () const" +Returns the width of the ellipse. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvasellipse.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvasellipse.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvasitem.3qt b/doc/man/man3/tqcanvasitem.3qt new file mode 100644 index 000000000..8e4dc23ad --- /dev/null +++ b/doc/man/man3/tqcanvasitem.3qt @@ -0,0 +1,426 @@ +'\" t +.TH QCanvasItem 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 +QCanvasItem \- Abstract graphic object on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits Qt. +.PP +Inherited by QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasItem\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "virtual \fB~QCanvasItem\fR ()" +.br +.ti -1c +.BI "double \fBx\fR () const" +.br +.ti -1c +.BI "double \fBy\fR () const" +.br +.ti -1c +.BI "double \fBz\fR () const" +.br +.ti -1c +.BI "virtual void \fBmoveBy\fR ( double dx, double dy )" +.br +.ti -1c +.BI "void \fBmove\fR ( double x, double y )" +.br +.ti -1c +.BI "void \fBsetX\fR ( double x )" +.br +.ti -1c +.BI "void \fBsetY\fR ( double y )" +.br +.ti -1c +.BI "void \fBsetZ\fR ( double z )" +.br +.ti -1c +.BI "bool \fBanimated\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAnimated\fR ( bool y )" +.br +.ti -1c +.BI "virtual void \fBsetVelocity\fR ( double vx, double vy )" +.br +.ti -1c +.BI "void \fBsetXVelocity\fR ( double vx )" +.br +.ti -1c +.BI "void \fBsetYVelocity\fR ( double vy )" +.br +.ti -1c +.BI "double \fBxVelocity\fR () const" +.br +.ti -1c +.BI "double \fByVelocity\fR () const" +.br +.ti -1c +.BI "virtual void \fBadvance\fR ( int phase )" +.br +.ti -1c +.BI "virtual bool \fBcollidesWith\fR ( const QCanvasItem * other ) const = 0" +.br +.ti -1c +.BI "QCanvasItemList \fBcollisions\fR ( bool exact ) const" +.br +.ti -1c +.BI "virtual void \fBsetCanvas\fR ( QCanvas * c )" +.br +.ti -1c +.BI "virtual void \fBdraw\fR ( QPainter & painter ) = 0" +.br +.ti -1c +.BI "void \fBshow\fR ()" +.br +.ti -1c +.BI "void \fBhide\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetVisible\fR ( bool yes )" +.br +.ti -1c +.BI "bool \fBisVisible\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSelected\fR ( bool yes )" +.br +.ti -1c +.BI "bool \fBisSelected\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetEnabled\fR ( bool yes )" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetActive\fR ( bool yes )" +.br +.ti -1c +.BI "bool \fBisActive\fR () const" +.br +.ti -1c +.BI "bool visible () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool selected () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool enabled () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool active () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "enum \fBRttiValues\fR { Rtti_Item = 0, Rtti_Sprite = 1, Rtti_PolygonalItem = 2, Rtti_Text = 3, Rtti_Polygon = 4, Rtti_Rectangle = 5, Rtti_Ellipse = 6, Rtti_Line = 7, Rtti_Spline = 8 }" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.ti -1c +.BI "virtual QRect \fBboundingRect\fR () const = 0" +.br +.ti -1c +.BI "virtual QRect \fBboundingRectAdvanced\fR () const" +.br +.ti -1c +.BI "QCanvas * \fBcanvas\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBupdate\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QCanvasItem class provides an abstract graphic object on a QCanvas. +.PP +A variety of QCanvasItem subclasses provide immediately usable behaviour. This class is a pure abstract superclass providing the behaviour that is shared among all the concrete canvas item classes. QCanvasItem is not intended for direct subclassing. It is much easier to subclass one of its subclasses, e.g. QCanvasPolygonalItem (the commonest base class), QCanvasRectangle, QCanvasSprite, QCanvasEllipse or QCanvasText. +.PP +Canvas items are added to a canvas by constructing them and passing the canvas to the canvas item's constructor. An item can be moved to a different canvas using setCanvas(). +.PP +Items appear on the canvas after their show() function has been called (or setVisible(TRUE)), and \fIafter\fR update() has been called. The canvas only shows items that are visible, and then only if update() is called. If you created the canvas without passing a width and height to the constructor you'll also need to call resize(). Since the canvas background defaults to white and canvas items default to white, you may need to change colors to see your items. +.PP +A QCanvasItem object can be moved in the x(), y() and z() dimensions using functions such as move(), moveBy(), setX(), setY() and setZ(). A canvas item can be set in motion, `animated', using setAnimated() and given a velocity in the x and y directions with setXVelocity() and setYVelocity() -- the same effect can be achieved by calling setVelocity(). Use the collidesWith() function to see if the canvas item will collide on the \fInext\fR advance(1) and use collisions() to see what collisions have occurred. +.PP +Use QCanvasSprite or your own subclass of QCanvasSprite to create canvas items which are animated, i.e. which change over time. +.PP +The size of a canvas item is given by boundingRect(). Use boundingRectAdvanced() to see what the size of the canvas item will be \fIafter\fR the next advance(1) call. +.PP +The rtti() function is used for identifying subclasses of QCanvasItem. The canvas() function returns a pointer to the canvas which contains the canvas item. +.PP +QCanvasItem provides the show() and isVisible() functions like those in QWidget. +.PP +QCanvasItem also provides the setEnabled(), setActive() and setSelected() functions; these functions set the relevant boolean and cause a repaint but the boolean values they set are not used in QCanvasItem itself. You can make use of these booleans in your subclasses. +.PP +By default, canvas items have no velocity, no size, and are not in motion. The subclasses provided in Qt do not change these defaults except where noted. +.PP +See also Graphics Classes and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QCanvasItem::RttiValues" +This enum is used to name the different types of canvas item. +.TP +\fCQCanvasItem::Rtti_Item\fR - Canvas item abstract base class +.TP +\fCQCanvasItem::Rtti_Ellipse\fR +.TP +\fCQCanvasItem::Rtti_Line\fR +.TP +\fCQCanvasItem::Rtti_Polygon\fR +.TP +\fCQCanvasItem::Rtti_PolygonalItem\fR +.TP +\fCQCanvasItem::Rtti_Rectangle\fR +.TP +\fCQCanvasItem::Rtti_Spline\fR +.TP +\fCQCanvasItem::Rtti_Sprite\fR +.TP +\fCQCanvasItem::Rtti_Text\fR +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasItem::QCanvasItem ( QCanvas * canvas )" +Constructs a QCanvasItem on canvas \fIcanvas\fR. +.PP +See also setCanvas(). +.SH "QCanvasItem::~QCanvasItem ()\fC [virtual]\fR" +Destroys the QCanvasItem and removes it from its canvas. +.SH "bool QCanvasItem::active () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use isActive() instead. +.SH "void QCanvasItem::advance ( int phase )\fC [virtual]\fR" +The default implementation moves the canvas item, if it is animated(), by the preset velocity if \fIphase\fR is 1, and does nothing if \fIphase\fR is 0. +.PP +Note that if you reimplement this function, the reimplementation must not change the canvas in any way, for example it must not add or remove items. +.PP +See also QCanvas::advance() and setVelocity(). +.PP +Example: canvas/canvas.cpp. +.PP +Reimplemented in QCanvasSprite. +.SH "bool QCanvasItem::animated () const" +Returns TRUE if the canvas item is in motion; otherwise returns FALSE. +.PP +See also setVelocity() and setAnimated(). +.SH "QRect QCanvasItem::boundingRect () const\fC [pure virtual]\fR" +Returns the bounding rectangle in pixels that the canvas item covers. +.PP +See also boundingRectAdvanced(). +.PP +Reimplemented in QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. +.SH "QRect QCanvasItem::boundingRectAdvanced () const\fC [virtual]\fR" +Returns the bounding rectangle of pixels that the canvas item \fIwill\fR cover after advance(1) is called. +.PP +See also boundingRect(). +.SH "QCanvas * QCanvasItem::canvas () const" +Returns the canvas containing the canvas item. +.SH "bool QCanvasItem::collidesWith ( const QCanvasItem * other ) const\fC [pure virtual]\fR" +Returns TRUE if the canvas item will collide with the \fIother\fR item \fIafter\fR they have moved by their current velocities; otherwise returns FALSE. +.PP +See also collisions(). +.PP +Example: canvas/canvas.cpp. +.SH "QCanvasItemList QCanvasItem::collisions ( bool exact ) const" +Returns the list of canvas items that this canvas item has collided with. +.PP +A collision is generally defined as occurring when the pixels of one item draw on the pixels of another item, but not all subclasses are so precise. Also, since pixel-wise collision detection can be slow, this function works in either exact or inexact mode, according to the \fIexact\fR parameter. +.PP +If \fIexact\fR is TRUE, the canvas items returned have been accurately tested for collision with the canvas item. +.PP +If \fIexact\fR is FALSE, the canvas items returned are \fInear\fR the canvas item. You can test the canvas items returned using collidesWith() if any are interesting collision candidates. By using this approach, you can ignore some canvas items for which collisions are not relevant. +.PP +The returned list is a list of QCanvasItems, but often you will need to cast the items to their subclass types. The safe way to do this is to use rtti() before casting. This provides some of the functionality of the standard C++ dynamic cast operation even on compilers where dynamic casts are not available. +.PP +Note that a canvas item may be `on' a canvas, e.g. it was created with the canvas as parameter, even though its coordinates place it beyond the edge of the canvas's area. Collision detection only works for canvas items which are wholly or partly within the canvas's area. +.PP +Note that if items have a velocity (see setVelocity()), then collision testing is done based on where the item \fIwill\fR be when it moves, not its current location. For example, a "ball" item doesn't need to actually embed into a "wall" item before a collision is detected. For items without velocity, plain intersection is used. +.SH "void QCanvasItem::draw ( QPainter & painter )\fC [pure virtual]\fR" +This abstract virtual function draws the canvas item using \fIpainter\fR. +.PP +\fBWarning:\fR When you reimplement this function, make sure that you leave the painter in the same state as you found it. For example, if you start by calling QPainter::translate(50, 50), end your code by calling QPainter::translate(-50, -50). Be also aware that the painter might already have some transformations set (i.e., don't call QPainter::resetXForm() when you're done). +.PP +Reimplemented in QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. +.SH "bool QCanvasItem::enabled () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use isEnabled() instead. +.SH "void QCanvasItem::hide ()" +Shorthand for setVisible(FALSE). +.SH "bool QCanvasItem::isActive () const" +Returns TRUE if the QCanvasItem is active; otherwise returns FALSE. +.SH "bool QCanvasItem::isEnabled () const" +Returns TRUE if the QCanvasItem is enabled; otherwise returns FALSE. +.SH "bool QCanvasItem::isSelected () const" +Returns TRUE if the canvas item is selected; otherwise returns FALSE. +.SH "bool QCanvasItem::isVisible () const" +Returns TRUE if the canvas item is visible; otherwise returns FALSE. +.PP +Note that in this context TRUE does \fInot\fR mean that the canvas item is currently in a view, merely that if a view is showing the area where the canvas item is positioned, and the item is not obscured by items with higher z values, and the view is not obscured by overlaying windows, it would be visible. +.PP +See also setVisible() and z(). +.SH "void QCanvasItem::move ( double x, double y )" +Moves the canvas item to the absolute position (\fIx\fR, \fIy\fR). +.PP +Example: canvas/canvas.cpp. +.SH "void QCanvasItem::moveBy ( double dx, double dy )\fC [virtual]\fR" +Moves the canvas item relative to its current position by (\fIdx\fR, \fIdy\fR). +.PP +Example: canvas/canvas.cpp. +.SH "int QCanvasItem::rtti () const\fC [virtual]\fR" +Returns 0 (QCanvasItem::Rtti_Item). +.PP +Make your derived classes return their own values for rtti(), so that you can distinguish between objects returned by QCanvas::at(). You should use values greater than 1000 to allow for extensions to this class. +.PP +Overuse of this functionality can damage it's extensibility. For example, once you have identified a base class of a QCanvasItem found by QCanvas::at(), cast it to that type and call meaningful methods rather than acting upon the object based on its rtti value. +.PP +For example: +.PP +.nf +.br + QCanvasItem* item; +.br + // Find an item, e.g. with QCanvasItem::collisions(). +.br + ... +.br + if (item->rtti() == MySprite::RTTI ) { +.br + MySprite* s = (MySprite*)item; +.br + if (s->isDamagable()) s->loseHitPoints(1000); +.br + if (s->isHot()) myself->loseHitPoints(1000); +.br + ... +.br + } +.br +.fi +.PP +Example: canvas/canvas.cpp. +.PP +Reimplemented in QCanvasSprite, QCanvasPolygonalItem, and QCanvasText. +.SH "bool QCanvasItem::selected () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use isSelected() instead. +.SH "void QCanvasItem::setActive ( bool yes )\fC [virtual]\fR" +Sets the active flag of the item to \fIyes\fR. If this changes the item's active state the item will be redrawn when QCanvas::update() is next called. +.PP +The QCanvas, QCanvasItem and the Qt-supplied QCanvasItem subclasses do not make use of this value. The setActive() function is supplied because many applications need it, but it is up to you how you use the isActive() value. +.SH "void QCanvasItem::setAnimated ( bool y )\fC [virtual]\fR" +Sets the canvas item to be in motion if \fIy\fR is TRUE, or not if \fIy\fR is FALSE. The speed and direction of the motion is set with setVelocity(), or with setXVelocity() and setYVelocity(). +.PP +See also advance() and QCanvas::advance(). +.SH "void QCanvasItem::setCanvas ( QCanvas * c )\fC [virtual]\fR" +Sets the QCanvas upon which the canvas item is to be drawn to \fIc\fR. +.PP +See also canvas(). +.SH "void QCanvasItem::setEnabled ( bool yes )\fC [virtual]\fR" +Sets the enabled flag of the item to \fIyes\fR. If this changes the item's enabled state the item will be redrawn when QCanvas::update() is next called. +.PP +The QCanvas, QCanvasItem and the Qt-supplied QCanvasItem subclasses do not make use of this value. The setEnabled() function is supplied because many applications need it, but it is up to you how you use the isEnabled() value. +.SH "void QCanvasItem::setSelected ( bool yes )\fC [virtual]\fR" +Sets the selected flag of the item to \fIyes\fR. If this changes the item's selected state the item will be redrawn when QCanvas::update() is next called. +.PP +The QCanvas, QCanvasItem and the Qt-supplied QCanvasItem subclasses do not make use of this value. The setSelected() function is supplied because many applications need it, but it is up to you how you use the isSelected() value. +.SH "void QCanvasItem::setVelocity ( double vx, double vy )\fC [virtual]\fR" +Sets the canvas item to be in motion, moving by \fIvx\fR and \fIvy\fR pixels in the horizontal and vertical directions respectively. +.PP +See also advance(), setXVelocity(), and setYVelocity(). +.SH "void QCanvasItem::setVisible ( bool yes )\fC [virtual]\fR" +Makes the canvas item visible if \fIyes\fR is TRUE, or invisible if \fIyes\fR is FALSE. The change takes effect when QCanvas::update() is next called. +.SH "void QCanvasItem::setX ( double x )" +Moves the canvas item so that its x-position is \fIx\fR. +.PP +See also x() and move(). +.PP +Example: chart/chartform_canvas.cpp. +.SH "void QCanvasItem::setXVelocity ( double vx )" +Sets the horizontal component of the canvas item's velocity to \fIvx\fR. +.PP +See also setYVelocity() and setVelocity(). +.SH "void QCanvasItem::setY ( double y )" +Moves the canvas item so that its y-position is \fIy\fR. +.PP +See also y() and move(). +.PP +Example: chart/chartform_canvas.cpp. +.SH "void QCanvasItem::setYVelocity ( double vy )" +Sets the vertical component of the canvas item's velocity to \fIvy\fR. +.PP +See also setXVelocity() and setVelocity(). +.SH "void QCanvasItem::setZ ( double z )" +Sets the z index of the canvas item to \fIz\fR. Higher-z items obscure (are in front of) lower-z items. +.PP +See also z() and move(). +.PP +Examples: +.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. +.SH "void QCanvasItem::show ()" +Shorthand for setVisible(TRUE). +.PP +Examples: +.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. +.SH "void QCanvasItem::update ()\fC [protected]\fR" +Call this function to repaint the canvas's changed chunks. +.SH "bool QCanvasItem::visible () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use isVisible() instead. +.SH "double QCanvasItem::x () const" +Returns the horizontal position of the canvas item. Note that subclasses often have an origin other than the top-left corner. +.PP +Example: canvas/canvas.cpp. +.SH "double QCanvasItem::xVelocity () const" +Returns the horizontal velocity component of the canvas item. +.SH "double QCanvasItem::y () const" +Returns the vertical position of the canvas item. Note that subclasses often have an origin other than the top-left corner. +.PP +Example: canvas/canvas.cpp. +.SH "double QCanvasItem::yVelocity () const" +Returns the vertical velocity component of the canvas item. +.SH "double QCanvasItem::z () const" +Returns the z index of the canvas item, which is used for visual +order: higher-z items obscure (are in front of) lower-z items. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvasitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvasitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvasitemlist.3qt b/doc/man/man3/tqcanvasitemlist.3qt new file mode 100644 index 000000000..6363040d8 --- /dev/null +++ b/doc/man/man3/tqcanvasitemlist.3qt @@ -0,0 +1,57 @@ +'\" t +.TH QCanvasItemList 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 +QCanvasItemList \- List of QCanvasItems +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QValueList<QCanvasItem * >. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "QCanvasItemList \fBoperator+\fR ( const QCanvasItemList & l ) const" +.br +.in -1c +.SH DESCRIPTION +The QCanvasItemList class is a list of QCanvasItems. +.PP +QCanvasItemList is a QValueList of pointers to QCanvasItems. This class is used by some methods in QCanvas that need to return a list of canvas items. +.PP +The QValueList documentation describes how to use this list. +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasItemList QCanvasItemList::operator+ ( const QCanvasItemList & l ) const" +Returns the concatenation of this list and list \fIl\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvasitemlist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvasitemlist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvasline.3qt b/doc/man/man3/tqcanvasline.3qt new file mode 100644 index 000000000..b9fc8f8ec --- /dev/null +++ b/doc/man/man3/tqcanvasline.3qt @@ -0,0 +1,94 @@ +'\" t +.TH QCanvasLine 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 +QCanvasLine \- Line on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasPolygonalItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasLine\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "\fB~QCanvasLine\fR ()" +.br +.ti -1c +.BI "void \fBsetPoints\fR ( int xa, int ya, int xb, int yb )" +.br +.ti -1c +.BI "QPoint \fBstartPoint\fR () const" +.br +.ti -1c +.BI "QPoint \fBendPoint\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QCanvasLine class provides a line on a QCanvas. +.PP +The line inherits functionality from QCanvasPolygonalItem, for example the setPen() function. The start and end points of the line are set with setPoints(). +.PP +Like any other canvas item lines can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasLine::QCanvasLine ( QCanvas * canvas )" +Constructs a line from (0,0) to (0,0) on \fIcanvas\fR. +.PP +See also setPoints(). +.SH "QCanvasLine::~QCanvasLine ()" +Destroys the line. +.SH "QPoint QCanvasLine::endPoint () const" +Returns the end point of the line. +.PP +See also setPoints() and startPoint(). +.SH "int QCanvasLine::rtti () const\fC [virtual]\fR" +Returns 7 (QCanvasItem::Rtti_Line). +.PP +See also QCanvasItem::rtti(). +.PP +Reimplemented from QCanvasPolygonalItem. +.SH "void QCanvasLine::setPoints ( int xa, int ya, int xb, int yb )" +Sets the line's start point to (\fIxa\fR, \fIya\fR) and its end point to (\fIxb\fR, \fIyb\fR). +.PP +Example: canvas/canvas.cpp. +.SH "QPoint QCanvasLine::startPoint () const" +Returns the start point of the line. +.PP +See also setPoints() and endPoint(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvasline.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvasline.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvaspixmap.3qt b/doc/man/man3/tqcanvaspixmap.3qt new file mode 100644 index 000000000..6109b89dd --- /dev/null +++ b/doc/man/man3/tqcanvaspixmap.3qt @@ -0,0 +1,100 @@ +'\" t +.TH QCanvasPixmap 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 +QCanvasPixmap \- Pixmaps for QCanvasSprites +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QPixmap. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasPixmap\fR ( const QString & datafilename )" +.br +.ti -1c +.BI "\fBQCanvasPixmap\fR ( const QImage & image )" +.br +.ti -1c +.BI "\fBQCanvasPixmap\fR ( const QPixmap & pm, const QPoint & offset )" +.br +.ti -1c +.BI "\fB~QCanvasPixmap\fR ()" +.br +.ti -1c +.BI "int \fBoffsetX\fR () const" +.br +.ti -1c +.BI "int \fBoffsetY\fR () const" +.br +.ti -1c +.BI "void \fBsetOffset\fR ( int x, int y )" +.br +.in -1c +.SH DESCRIPTION +The QCanvasPixmap class provides pixmaps for QCanvasSprites. +.PP +If you want to show a single pixmap on a QCanvas use a QCanvasSprite with just one pixmap. +.PP +When pixmaps are inserted into a QCanvasPixmapArray they are held as QCanvasPixmaps. QCanvasSprites are used to show pixmaps on QCanvases and hold their pixmaps in a QCanvasPixmapArray. If you retrieve a frame (pixmap) from a QCanvasSprite it will be returned as a QCanvasPixmap. +.PP +The pixmap is a QPixmap and can only be set in the constructor. There are three different constructors, one taking a QPixmap, one a QImage and one a file name that refers to a file in any supported file format (see QImageIO). +.PP +QCanvasPixmap can have a hotspot which is defined in terms of an (x, y) offset. When you create a QCanvasPixmap from a PNG file or from a QImage that has a QImage::offset(), the offset() is initialized appropriately, otherwise the constructor leaves it at (0, 0). You can set it later using setOffset(). When the QCanvasPixmap is used in a QCanvasSprite, the offset position is the point at QCanvasItem::x() and QCanvasItem::y(), not the top-left corner of the pixmap. +.PP +Note that for QCanvasPixmap objects created by a QCanvasSprite, the position of each QCanvasPixmap object is set so that the hotspot stays in the same position. +.PP +See also QCanvasPixmapArray, QCanvasItem, QCanvasSprite, Graphics Classes, and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasPixmap::QCanvasPixmap ( const QString & datafilename )" +Constructs a QCanvasPixmap that uses the image stored in \fIdatafilename\fR. +.SH "QCanvasPixmap::QCanvasPixmap ( const QImage & image )" +Constructs a QCanvasPixmap from the image \fIimage\fR. +.SH "QCanvasPixmap::QCanvasPixmap ( const QPixmap & pm, const QPoint & offset )" +Constructs a QCanvasPixmap from the pixmap \fIpm\fR using the offset \fIoffset\fR. +.SH "QCanvasPixmap::~QCanvasPixmap ()" +Destroys the pixmap. +.SH "int QCanvasPixmap::offsetX () const" +Returns the x-offset of the pixmap's hotspot. +.PP +See also setOffset(). +.SH "int QCanvasPixmap::offsetY () const" +Returns the y-offset of the pixmap's hotspot. +.PP +See also setOffset(). +.SH "void QCanvasPixmap::setOffset ( int x, int y )" +Sets the offset of the pixmap's hotspot to (\fIx\fR, \fIy\fR). +.PP +\fBWarning:\fR Do not call this function if any QCanvasSprites are +currently showing this pixmap. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvaspixmap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvaspixmap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvaspixmaparray.3qt b/doc/man/man3/tqcanvaspixmaparray.3qt new file mode 100644 index 000000000..461efe40e --- /dev/null +++ b/doc/man/man3/tqcanvaspixmaparray.3qt @@ -0,0 +1,156 @@ +'\" t +.TH QCanvasPixmapArray 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 +QCanvasPixmapArray \- Array of QCanvasPixmaps +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasPixmapArray\fR ()" +.br +.ti -1c +.BI "\fBQCanvasPixmapArray\fR ( const QString & datafilenamepattern, int fc = 0 )" +.br +.ti -1c +.BI "QCanvasPixmapArray ( QPtrList<QPixmap> list, QPtrList<QPoint> hotspots ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "\fBQCanvasPixmapArray\fR ( QValueList<QPixmap> list, QPointArray hotspots = QPointArray ( ) )" +.br +.ti -1c +.BI "\fB~QCanvasPixmapArray\fR ()" +.br +.ti -1c +.BI "bool \fBreadPixmaps\fR ( const QString & filenamepattern, int fc = 0 )" +.br +.ti -1c +.BI "bool \fBreadCollisionMasks\fR ( const QString & filename )" +.br +.ti -1c +.BI "bool operator! () \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "QCanvasPixmap * \fBimage\fR ( int i ) const" +.br +.ti -1c +.BI "void \fBsetImage\fR ( int i, QCanvasPixmap * p )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QCanvasPixmapArray class provides an array of QCanvasPixmaps. +.PP +This class is used by QCanvasSprite to hold an array of pixmaps. It is used to implement animated sprites, i.e. images that change over time, with each pixmap in the array holding one frame. +.PP +Depending on the constructor you use you can load multiple pixmaps into the array either from a directory (specifying a wildcard pattern for the files), or from a list of QPixmaps. You can also read in a set of pixmaps after construction using readPixmaps(). +.PP +Individual pixmaps can be set with setImage() and retrieved with image(). The number of pixmaps in the array is returned by count(). +.PP +QCanvasSprite uses an image's mask for collision detection. You can change this by reading in a separate set of image masks using readCollisionMasks(). +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasPixmapArray::QCanvasPixmapArray ()" +Constructs an invalid array (i.e. isValid() will return FALSE). You must call readPixmaps() before being able to use this QCanvasPixmapArray. +.SH "QCanvasPixmapArray::QCanvasPixmapArray ( const QString & datafilenamepattern, int fc = 0 )" +Constructs a QCanvasPixmapArray from files. +.PP +The \fIfc\fR parameter sets the number of frames to be loaded for this image. +.PP +If \fIfc\fR is not 0, \fIdatafilenamepattern\fR should contain "%1", e.g. "foo%1.png". The actual filenames are formed by replacing the %1 with four-digit integers from 0 to (fc - 1), e.g. foo0000.png, foo0001.png, foo0002.png, etc. +.PP +If \fIfc\fR is 0, \fIdatafilenamepattern\fR is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame. +.PP +If \fIdatafilenamepattern\fR does not exist, is not readable, isn't an image, or some other error occurs, the array ends up empty and isValid() returns FALSE. +.SH "QCanvasPixmapArray::QCanvasPixmapArray ( QPtrList<QPixmap> list, QPtrList<QPoint> hotspots )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use QCanvasPixmapArray::QCanvasPixmapArray( QValueList<QPixmap>, QPointArray ) instead. +.PP +Constructs a QCanvasPixmapArray from the list of QPixmaps \fIlist\fR. The \fIhotspots\fR list has to be of the same size as \fIlist\fR. +.SH "QCanvasPixmapArray::QCanvasPixmapArray ( QValueList<QPixmap> list, QPointArray hotspots = QPointArray ( ) )" +Constructs a QCanvasPixmapArray from the list of QPixmaps in the \fIlist\fR. Each pixmap will get a hotspot according to the \fIhotspots\fR array. If no hotspots are specified, each one is set to be at position (0, 0). +.PP +If an error occurs, isValid() will return FALSE. +.SH "QCanvasPixmapArray::~QCanvasPixmapArray ()" +Destroys the pixmap array and all the pixmaps it contains. +.SH "uint QCanvasPixmapArray::count () const" +Returns the number of pixmaps in the array. +.SH "QCanvasPixmap * QCanvasPixmapArray::image ( int i ) const" +Returns pixmap \fIi\fR in the array, if \fIi\fR is non-negative and less than than count(), and returns an unspecified value otherwise. +.SH "bool QCanvasPixmapArray::isValid () const" +Returns TRUE if the pixmap array is valid; otherwise returns FALSE. +.SH "bool QCanvasPixmapArray::operator! ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use isValid() instead. +.PP +This returns FALSE if the array is valid, and TRUE if it is not. +.SH "bool QCanvasPixmapArray::readCollisionMasks ( const QString & filename )" +Reads new collision masks for the array. +.PP +By default, QCanvasSprite uses the image mask of a sprite to detect collisions. Use this function to set your own collision image masks. +.PP +If count() is 1 \fIfilename\fR must specify a real filename to read the mask from. If count() is greater than 1, the \fIfilename\fR must contain a "%1" that will get replaced by the number of the mask to be loaded, just like QCanvasPixmapArray::readPixmaps(). +.PP +All collision masks must be 1-bit images or this function call will fail. +.PP +If the file isn't readable, contains the wrong number of images, or there is some other error, this function will return FALSE, and the array will be flagged as invalid; otherwise this function returns TRUE. +.PP +See also isValid(). +.SH "bool QCanvasPixmapArray::readPixmaps ( const QString & filenamepattern, int fc = 0 )" +Reads one or more pixmaps into the pixmap array. +.PP +If \fIfc\fR is not 0, \fIfilenamepattern\fR should contain "%1", e.g." foo%1.png". The actual filenames are formed by replacing the %1 with four-digit integers from 0 to (fc - 1), e.g. foo0000.png, foo0001.png, foo0002.png, etc. +.PP +If \fIfc\fR is 0, \fIfilenamepattern\fR is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame. +.PP +If \fIfilenamepattern\fR does not exist, is not readable, isn't an image, or some other error occurs, this function will return FALSE, and isValid() will return FALSE; otherwise this function will return TRUE. +.PP +See also isValid(). +.SH "void QCanvasPixmapArray::setImage ( int i, QCanvasPixmap * p )" +Replaces the pixmap at index \fIi\fR with pixmap \fIp\fR. +.PP +The array takes ownership of \fIp\fR and will delete \fIp\fR when the array itself is deleted. +.PP +If \fIi\fR is beyond the end of the array the array is extended to at +least i+1 elements, with elements count() to i-1 being initialized +to 0. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvaspixmaparray.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvaspixmaparray.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvaspolygon.3qt b/doc/man/man3/tqcanvaspolygon.3qt new file mode 100644 index 000000000..b10b01bb3 --- /dev/null +++ b/doc/man/man3/tqcanvaspolygon.3qt @@ -0,0 +1,114 @@ +'\" t +.TH QCanvasPolygon 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 +QCanvasPolygon \- Polygon on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasPolygonalItem. +.PP +Inherited by QCanvasSpline. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasPolygon\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "\fB~QCanvasPolygon\fR ()" +.br +.ti -1c +.BI "void \fBsetPoints\fR ( QPointArray pa )" +.br +.ti -1c +.BI "QPointArray \fBpoints\fR () const" +.br +.ti -1c +.BI "virtual QPointArray \fBareaPoints\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawShape\fR ( QPainter & p )" +.br +.in -1c +.SH DESCRIPTION +The QCanvasPolygon class provides a polygon on a QCanvas. +.PP +Paints a polygon with a QBrush. The polygon's points can be set in the constructor or set or changed later using setPoints(). Use points() to retrieve the points, or areaPoints() to retrieve the points relative to the canvas's origin. +.PP +The polygon can be drawn on a painter with drawShape(). +.PP +Like any other canvas item polygons can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). +.PP +Note: QCanvasPolygon does not use the pen. +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasPolygon::QCanvasPolygon ( QCanvas * canvas )" +Constructs a point-less polygon on the canvas \fIcanvas\fR. You should call setPoints() before using it further. +.SH "QCanvasPolygon::~QCanvasPolygon ()" +Destroys the polygon. +.SH "QPointArray QCanvasPolygon::areaPoints () const\fC [virtual]\fR" +Returns the vertices of the polygon translated by the polygon's current x(), y() position, i.e. relative to the canvas's origin. +.PP +See also setPoints() and points(). +.PP +Reimplemented from QCanvasPolygonalItem. +.SH "void QCanvasPolygon::drawShape ( QPainter & p )\fC [virtual protected]\fR" +Draws the polygon using the painter \fIp\fR. +.PP +Note that QCanvasPolygon does not support an outline (the pen is always NoPen). +.PP +Reimplemented from QCanvasPolygonalItem. +.SH "QPointArray QCanvasPolygon::points () const" +Returns the vertices of the polygon, not translated by the position. +.PP +See also setPoints() and areaPoints(). +.SH "int QCanvasPolygon::rtti () const\fC [virtual]\fR" +Returns 4 (QCanvasItem::Rtti_Polygon). +.PP +See also QCanvasItem::rtti(). +.PP +Reimplemented from QCanvasPolygonalItem. +.PP +Reimplemented in QCanvasSpline. +.SH "void QCanvasPolygon::setPoints ( QPointArray pa )" +Sets the points of the polygon to be \fIpa\fR. These points will have +their x and y coordinates automatically translated by x(), y() as +the polygon is moved. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvaspolygon.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvaspolygon.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvaspolygonalitem.3qt b/doc/man/man3/tqcanvaspolygonalitem.3qt new file mode 100644 index 000000000..ad997f53a --- /dev/null +++ b/doc/man/man3/tqcanvaspolygonalitem.3qt @@ -0,0 +1,193 @@ +'\" t +.TH QCanvasPolygonalItem 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 +QCanvasPolygonalItem \- Polygonal canvas item on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasItem. +.PP +Inherited by QCanvasRectangle, QCanvasPolygon, QCanvasLine, and QCanvasEllipse. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasPolygonalItem\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "virtual \fB~QCanvasPolygonalItem\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetPen\fR ( QPen p )" +.br +.ti -1c +.BI "virtual void \fBsetBrush\fR ( QBrush b )" +.br +.ti -1c +.BI "QPen \fBpen\fR () const" +.br +.ti -1c +.BI "QBrush \fBbrush\fR () const" +.br +.ti -1c +.BI "virtual QPointArray \fBareaPoints\fR () const = 0" +.br +.ti -1c +.BI "virtual QPointArray \fBareaPointsAdvanced\fR () const" +.br +.ti -1c +.BI "virtual QRect \fBboundingRect\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdraw\fR ( QPainter & p )" +.br +.ti -1c +.BI "virtual void \fBdrawShape\fR ( QPainter & p ) = 0" +.br +.ti -1c +.BI "bool \fBwinding\fR () const" +.br +.ti -1c +.BI "void \fBsetWinding\fR ( bool enable )" +.br +.ti -1c +.BI "void \fBinvalidate\fR ()" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QCanvasPolygonalItem class provides a polygonal canvas item on a QCanvas. +.PP +The mostly rectangular classes, such as QCanvasSprite and QCanvasText, use the object's bounding rectangle for movement, repainting and collision calculations. For most other items, the bounding rectangle can be far too large -- a diagonal line being the worst case, and there are many other cases which are also bad. QCanvasPolygonalItem provides polygon-based bounding rectangle handling, etc., which is much faster for non-rectangular items. +.PP +Derived classes should try to define as small an area as possible to maximize efficiency, but the polygon must \fIdefinitely\fR be contained completely within the polygonal area. Calculating the exact requirements is usually difficult, but if you allow a small overestimate it can be easy and quick, while still getting almost all of QCanvasPolygonalItem's speed. +.PP +Note that all subclasses \fImust\fR call hide() in their destructor since hide() needs to be able to access areaPoints(). +.PP +Normally, QCanvasPolygonalItem uses the odd-even algorithm for determining whether an object intersects this object. You can change this to the winding algorithm using setWinding(). +.PP +The bounding rectangle is available using boundingRect(). The points bounding the polygonal item are retrieved with areaPoints(). Use areaPointsAdvanced() to retrieve the bounding points the polygonal item \fIwill\fR have after QCanvasItem::advance(1) has been called. +.PP +If the shape of the polygonal item is about to change while the item is visible, call invalidate() before updating with a different result from areaPoints(). +.PP +By default, QCanvasPolygonalItem objects have a black pen and no brush (the default QPen and QBrush constructors). You can change this with setPen() and setBrush(), but note that some QCanvasPolygonalItem subclasses only use the brush, ignoring the pen setting. +.PP +The polygonal item can be drawn on a painter with draw(). Subclasses must reimplement drawShape() to draw themselves. +.PP +Like any other canvas item polygonal items can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasPolygonalItem::QCanvasPolygonalItem ( QCanvas * canvas )" +Constructs a QCanvasPolygonalItem on the canvas \fIcanvas\fR. +.SH "QCanvasPolygonalItem::~QCanvasPolygonalItem ()\fC [virtual]\fR" +Note that all subclasses \fImust\fR call hide() in their destructor since hide() needs to be able to access areaPoints(). +.SH "QPointArray QCanvasPolygonalItem::areaPoints () const\fC [pure virtual]\fR" +This function must be reimplemented by subclasses. It \fImust\fR return the points bounding (i.e. outside and not touching) the shape or drawing errors will occur. +.PP +Reimplemented in QCanvasPolygon. +.SH "QPointArray QCanvasPolygonalItem::areaPointsAdvanced () const\fC [virtual]\fR" +Returns the points the polygonal item \fIwill\fR have after QCanvasItem::advance(1) is called, i.e. what the points are when advanced by the current xVelocity() and yVelocity(). +.SH "QRect QCanvasPolygonalItem::boundingRect () const\fC [virtual]\fR" +Returns the bounding rectangle of the polygonal item, based on areaPoints(). +.PP +Reimplemented from QCanvasItem. +.SH "QBrush QCanvasPolygonalItem::brush () const" +Returns the QBrush used to fill the item, if filled. +.PP +See also setBrush(). +.SH "void QCanvasPolygonalItem::draw ( QPainter & p )\fC [virtual protected]\fR" +Reimplemented from QCanvasItem, this draws the polygonal item by setting the pen and brush for the item on the painter \fIp\fR and calling drawShape(). +.PP +Reimplemented from QCanvasItem. +.SH "void QCanvasPolygonalItem::drawShape ( QPainter & p )\fC [pure virtual protected]\fR" +Subclasses must reimplement this function to draw their shape. The pen and brush of \fIp\fR are already set to pen() and brush() prior to calling this function. +.PP +\fBWarning:\fR When you reimplement this function, make sure that you leave the painter in the same state as you found it. For example, if you start by calling QPainter::translate(50, 50), end your code by calling QPainter::translate(-50, -50). Be also aware that the painter might already have some transformations set (i.e., don't call QPainter::resetXForm() when you're done). +.PP +See also draw(). +.PP +Reimplemented in QCanvasRectangle, QCanvasPolygon, and QCanvasEllipse. +.SH "void QCanvasPolygonalItem::invalidate ()\fC [protected]\fR" +Invalidates all information about the area covered by the canvas item. The item will be updated automatically on the next call that changes the item's status, for example, move() or update(). Call this function if you are going to change the shape of the item (as returned by areaPoints()) while the item is visible. +.SH "bool QCanvasPolygonalItem::isValid () const\fC [protected]\fR" +Returns TRUE if the polygonal item's area information has not been invalidated; otherwise returns FALSE. +.PP +See also invalidate(). +.SH "QPen QCanvasPolygonalItem::pen () const" +Returns the QPen used to draw the outline of the item, if any. +.PP +See also setPen(). +.SH "int QCanvasPolygonalItem::rtti () const\fC [virtual]\fR" +Returns 2 (QCanvasItem::Rtti_PolygonalItem). +.PP +See also QCanvasItem::rtti(). +.PP +Reimplemented from QCanvasItem. +.PP +Reimplemented in QCanvasRectangle, QCanvasPolygon, QCanvasLine, and QCanvasEllipse. +.SH "void QCanvasPolygonalItem::setBrush ( QBrush b )\fC [virtual]\fR" +Sets the QBrush used when drawing the polygonal item to the brush \fIb\fR. +.PP +See also setPen(), brush(), and drawShape(). +.PP +Examples: +.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. +.SH "void QCanvasPolygonalItem::setPen ( QPen p )\fC [virtual]\fR" +Sets the QPen used when drawing the item to the pen \fIp\fR. Note that many QCanvasPolygonalItems do not use the pen value. +.PP +See also setBrush(), pen(), and drawShape(). +.PP +Examples: +.)l canvas/canvas.cpp and chart/chartform_canvas.cpp. +.SH "void QCanvasPolygonalItem::setWinding ( bool enable )\fC [protected]\fR" +If \fIenable\fR is TRUE, the polygonal item will use the winding algorithm to determine the "inside" of the polygon; otherwise the odd-even algorithm will be used. +.PP +The default is to use the odd-even algorithm. +.PP +See also winding(). +.SH "bool QCanvasPolygonalItem::winding () const\fC [protected]\fR" +Returns TRUE if the polygonal item uses the winding algorithm to determine the "inside" of the polygon. Returns FALSE if it uses the odd-even algorithm. +.PP +The default is to use the odd-even algorithm. +.PP +See also setWinding(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvaspolygonalitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvaspolygonalitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvasrectangle.3qt b/doc/man/man3/tqcanvasrectangle.3qt new file mode 100644 index 000000000..513049147 --- /dev/null +++ b/doc/man/man3/tqcanvasrectangle.3qt @@ -0,0 +1,129 @@ +'\" t +.TH QCanvasRectangle 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 +QCanvasRectangle \- Rectangle on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasPolygonalItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasRectangle\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "\fBQCanvasRectangle\fR ( const QRect & r, QCanvas * canvas )" +.br +.ti -1c +.BI "\fBQCanvasRectangle\fR ( int x, int y, int width, int height, QCanvas * canvas )" +.br +.ti -1c +.BI "\fB~QCanvasRectangle\fR ()" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "void \fBsetSize\fR ( int width, int height )" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawShape\fR ( QPainter & p )" +.br +.ti -1c +.BI "virtual QPointArray \fBchunks\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QCanvasRectangle class provides a rectangle on a QCanvas. +.PP +This item paints a single rectangle which may have any pen() and brush(), but may not be tilted/rotated. For rotated rectangles, use QCanvasPolygon. +.PP +The rectangle's size and initial position can be set in the constructor. The size can be set or changed later using setSize(). Use height() and width() to retrieve the rectangle's dimensions. +.PP +The rectangle can be drawn on a painter with drawShape(). +.PP +Like any other canvas item rectangles can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasRectangle::QCanvasRectangle ( QCanvas * canvas )" +Constructs a rectangle at position (0,0) with both width and height set to 32 pixels on \fIcanvas\fR. +.SH "QCanvasRectangle::QCanvasRectangle ( const QRect & r, QCanvas * canvas )" +Constructs a rectangle positioned and sized by \fIr\fR on \fIcanvas\fR. +.SH "QCanvasRectangle::QCanvasRectangle ( int x, int y, int width, int height, QCanvas * canvas )" +Constructs a rectangle at position (\fIx\fR, \fIy\fR) and size \fIwidth\fR by \fIheight\fR, on \fIcanvas\fR. +.SH "QCanvasRectangle::~QCanvasRectangle ()" +Destroys the rectangle. +.SH "QPointArray QCanvasRectangle::chunks () const\fC [virtual protected]\fR" +Simply calls QCanvasItem::chunks(). +.SH "void QCanvasRectangle::drawShape ( QPainter & p )\fC [virtual protected]\fR" +Draws the rectangle on painter \fIp\fR. +.PP +Example: canvas/canvas.cpp. +.PP +Reimplemented from QCanvasPolygonalItem. +.SH "int QCanvasRectangle::height () const" +Returns the height of the rectangle. +.SH "QRect QCanvasRectangle::rect () const" +Returns the integer-converted x(), y() position and size() of the rectangle as a QRect. +.SH "int QCanvasRectangle::rtti () const\fC [virtual]\fR" +Returns 5 (QCanvasItem::Rtti_Rectangle). +.PP +See also QCanvasItem::rtti(). +.PP +Reimplemented from QCanvasPolygonalItem. +.SH "void QCanvasRectangle::setSize ( int width, int height )" +Sets the \fIwidth\fR and \fIheight\fR of the rectangle. +.SH "QSize QCanvasRectangle::size () const" +Returns the width() and height() of the rectangle. +.PP +See also rect() and setSize(). +.SH "int QCanvasRectangle::width () const" +Returns the width of the rectangle. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvasrectangle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvasrectangle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvasspline.3qt b/doc/man/man3/tqcanvasspline.3qt new file mode 100644 index 000000000..4a4df1313 --- /dev/null +++ b/doc/man/man3/tqcanvasspline.3qt @@ -0,0 +1,102 @@ +'\" t +.TH QCanvasSpline 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 +QCanvasSpline \- Multi-bezier splines on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasPolygon. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasSpline\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "\fB~QCanvasSpline\fR ()" +.br +.ti -1c +.BI "void \fBsetControlPoints\fR ( QPointArray ctrl, bool close = TRUE )" +.br +.ti -1c +.BI "QPointArray \fBcontrolPoints\fR () const" +.br +.ti -1c +.BI "bool \fBclosed\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QCanvasSpline class provides multi-bezier splines on a QCanvas. +.PP +A QCanvasSpline is a sequence of 4-point bezier curves joined together to make a curved shape. +.PP +You set the control points of the spline with setControlPoints(). +.PP +If the bezier is closed(), then the first control point will be re-used as the last control point. Therefore, a closed bezier must have a multiple of 3 control points and an open bezier must have one extra point. +.PP +The beziers are not necessarily joined "smoothly". To ensure this, set control points appropriately (general reference texts about beziers will explain this in detail). +.PP +Like any other canvas item splines can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasSpline::QCanvasSpline ( QCanvas * canvas )" +Create a spline with no control points on the canvas \fIcanvas\fR. +.PP +See also setControlPoints(). +.SH "QCanvasSpline::~QCanvasSpline ()" +Destroy the spline. +.SH "bool QCanvasSpline::closed () const" +Returns TRUE if the control points are a closed set; otherwise returns FALSE. +.SH "QPointArray QCanvasSpline::controlPoints () const" +Returns the current set of control points. +.PP +See also setControlPoints() and closed(). +.SH "int QCanvasSpline::rtti () const\fC [virtual]\fR" +Returns 8 (QCanvasItem::Rtti_Spline). +.PP +See also QCanvasItem::rtti(). +.PP +Reimplemented from QCanvasPolygon. +.SH "void QCanvasSpline::setControlPoints ( QPointArray ctrl, bool close = TRUE )" +Set the spline control points to \fIctrl\fR. +.PP +If \fIclose\fR is TRUE, then the first point in \fIctrl\fR will be re-used as the last point, and the number of control points must be a multiple of 3. If \fIclose\fR is FALSE, one additional control point is required, and the number of control points must be one of (4, 7, 10, 13, ...). +.PP +If the number of control points doesn't meet the above conditions, the number of points will be truncated to the largest number of points that do meet the requirement. +.PP +Example: canvas/canvas.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvasspline.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvasspline.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvassprite.3qt b/doc/man/man3/tqcanvassprite.3qt new file mode 100644 index 000000000..a941615fd --- /dev/null +++ b/doc/man/man3/tqcanvassprite.3qt @@ -0,0 +1,263 @@ +'\" t +.TH QCanvasSprite 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 +QCanvasSprite \- Animated canvas item on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasSprite\fR ( QCanvasPixmapArray * a, QCanvas * canvas )" +.br +.ti -1c +.BI "void \fBsetSequence\fR ( QCanvasPixmapArray * a )" +.br +.ti -1c +.BI "virtual \fB~QCanvasSprite\fR ()" +.br +.ti -1c +.BI "virtual void \fBmove\fR ( double nx, double ny, int nf )" +.br +.ti -1c +.BI "void \fBsetFrame\fR ( int f )" +.br +.ti -1c +.BI "enum \fBFrameAnimationType\fR { Cycle, Oscillate }" +.br +.ti -1c +.BI "virtual void \fBsetFrameAnimation\fR ( FrameAnimationType type = Cycle, int step = 1, int state = 0 )" +.br +.ti -1c +.BI "int \fBframe\fR () const" +.br +.ti -1c +.BI "int \fBframeCount\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.ti -1c +.BI "virtual QRect \fBboundingRect\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "int \fBleftEdge\fR () const" +.br +.ti -1c +.BI "int \fBtopEdge\fR () const" +.br +.ti -1c +.BI "int \fBrightEdge\fR () const" +.br +.ti -1c +.BI "int \fBbottomEdge\fR () const" +.br +.ti -1c +.BI "int \fBleftEdge\fR ( int nx ) const" +.br +.ti -1c +.BI "int \fBtopEdge\fR ( int ny ) const" +.br +.ti -1c +.BI "int \fBrightEdge\fR ( int nx ) const" +.br +.ti -1c +.BI "int \fBbottomEdge\fR ( int ny ) const" +.br +.ti -1c +.BI "QCanvasPixmap * \fBimage\fR () const" +.br +.ti -1c +.BI "virtual QCanvasPixmap * \fBimageAdvanced\fR () const" +.br +.ti -1c +.BI "QCanvasPixmap * \fBimage\fR ( int f ) const" +.br +.ti -1c +.BI "virtual void \fBadvance\fR ( int phase )" +.br +.ti -1c +.BI "virtual void \fBdraw\fR ( QPainter & painter )" +.br +.in -1c +.SH DESCRIPTION +The QCanvasSprite class provides an animated canvas item on a QCanvas. +.PP +A canvas sprite is an object which can contain any number of images (referred to as frames), only one of which is current, i.e. displayed, at any one time. The images can be passed in the constructor or set or changed later with setSequence(). If you subclass QCanvasSprite you can change the frame that is displayed periodically, e.g. whenever QCanvasItem::advance(1) is called to create the effect of animation. +.PP +The current frame can be set with setFrame() or with move(). The number of frames available is given by frameCount(). The bounding rectangle of the current frame is returned by boundingRect(). +.PP +The current frame's image can be retrieved with image(); use imageAdvanced() to retrieve the image for the frame that will be shown after advance(1) is called. Use the image() overload passing it an integer index to retrieve a particular image from the list of frames. +.PP +Use width() and height() to retrieve the dimensions of the current frame. +.PP +Use leftEdge() and rightEdge() to retrieve the current frame's left-hand and right-hand x-coordinates respectively. Use bottomEdge() and topEdge() to retrieve the current frame's bottom and top y-coordinates respectively. These functions have an overload which will accept an integer frame number to retrieve the coordinates of a particular frame. +.PP +QCanvasSprite draws very quickly, at the expense of memory. +.PP +The current frame's image can be drawn on a painter with draw(). +.PP +Like any other canvas item, canvas sprites can be moved with move() which sets the x and y coordinates and the frame number, as well as with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). +.PP +See also Graphics Classes and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QCanvasSprite::FrameAnimationType" +This enum is used to identify the different types of frame animation offered by QCanvasSprite. +.TP +\fCQCanvasSprite::Cycle\fR - at each advance the frame number will be incremented by 1 (modulo the frame count). +.TP +\fCQCanvasSprite::Oscillate\fR - at each advance the frame number will be incremented by 1 up to the frame count then decremented to by 1 to 0, repeating this sequence forever. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasSprite::QCanvasSprite ( QCanvasPixmapArray * a, QCanvas * canvas )" +Constructs a QCanvasSprite which uses images from the QCanvasPixmapArray \fIa\fR. +.PP +The sprite in initially positioned at (0, 0) on \fIcanvas\fR, using frame 0. +.SH "QCanvasSprite::~QCanvasSprite ()\fC [virtual]\fR" +Destroys the sprite and removes it from the canvas. Does \fInot\fR delete the images. +.SH "void QCanvasSprite::advance ( int phase )\fC [virtual]\fR" +Extends the default QCanvasItem implementation to provide the functionality of setFrameAnimation(). +.PP +The \fIphase\fR is 0 or 1: see QCanvasItem::advance() for details. +.PP +See also QCanvasItem::advance() and setVelocity(). +.PP +Example: canvas/canvas.cpp. +.PP +Reimplemented from QCanvasItem. +.SH "int QCanvasSprite::bottomEdge () const" +Returns the y-coordinate of the current bottom edge of the sprite. (This may change as the sprite animates since different frames may have different bottom edges.) +.PP +See also leftEdge(), rightEdge(), and topEdge(). +.SH "int QCanvasSprite::bottomEdge ( int ny ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns what the y-coordinate of the top edge of the sprite would be if the sprite (actually its hotspot) were moved to y-position \fIny\fR. +.PP +See also leftEdge(), rightEdge(), and topEdge(). +.SH "QRect QCanvasSprite::boundingRect () const\fC [virtual]\fR" +Returns the bounding rectangle for the image in the sprite's current frame. This assumes that the images are tightly cropped (i.e. do not have transparent pixels all along a side). +.PP +Reimplemented from QCanvasItem. +.SH "void QCanvasSprite::draw ( QPainter & painter )\fC [virtual]\fR" +Draws the current frame's image at the sprite's current position on painter \fIpainter\fR. +.PP +Reimplemented from QCanvasItem. +.SH "int QCanvasSprite::frame () const" +Returns the index of the current animation frame in the QCanvasSprite's QCanvasPixmapArray. +.PP +See also setFrame() and move(). +.SH "int QCanvasSprite::frameCount () const" +Returns the number of frames in the QCanvasSprite's QCanvasPixmapArray. +.SH "int QCanvasSprite::height () const" +The height of the sprite for the current frame's image. +.PP +See also frame(). +.SH "QCanvasPixmap * QCanvasSprite::image () const" +Returns the current frame's image. +.PP +See also frame() and setFrame(). +.SH "QCanvasPixmap * QCanvasSprite::image ( int f ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the image for frame \fIf\fR. Does not do any bounds checking on \fIf\fR. +.SH "QCanvasPixmap * QCanvasSprite::imageAdvanced () const\fC [virtual]\fR" +Returns the image the sprite \fIwill\fR have after advance(1) is called. By default this is the same as image(). +.SH "int QCanvasSprite::leftEdge () const" +Returns the x-coordinate of the current left edge of the sprite. (This may change as the sprite animates since different frames may have different left edges.) +.PP +See also rightEdge(), bottomEdge(), and topEdge(). +.SH "int QCanvasSprite::leftEdge ( int nx ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns what the x-coordinate of the left edge of the sprite would be if the sprite (actually its hotspot) were moved to x-position \fInx\fR. +.PP +See also rightEdge(), bottomEdge(), and topEdge(). +.SH "void QCanvasSprite::move ( double nx, double ny, int nf )\fC [virtual]\fR" +Set the position of the sprite to \fInx\fR, \fIny\fR and the current frame to \fInf\fR. \fInf\fR will be ignored if it is larger than frameCount() or smaller than 0. +.SH "int QCanvasSprite::rightEdge () const" +Returns the x-coordinate of the current right edge of the sprite. (This may change as the sprite animates since different frames may have different right edges.) +.PP +See also leftEdge(), bottomEdge(), and topEdge(). +.SH "int QCanvasSprite::rightEdge ( int nx ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns what the x-coordinate of the right edge of the sprite would be if the sprite (actually its hotspot) were moved to x-position \fInx\fR. +.PP +See also leftEdge(), bottomEdge(), and topEdge(). +.SH "int QCanvasSprite::rtti () const\fC [virtual]\fR" +Returns 1 (QCanvasItem::Rtti_Sprite). +.PP +See also QCanvasItem::rtti(). +.PP +Example: canvas/canvas.cpp. +.PP +Reimplemented from QCanvasItem. +.SH "void QCanvasSprite::setFrame ( int f )" +Sets the animation frame used for displaying the sprite to \fIf\fR, an index into the QCanvasSprite's QCanvasPixmapArray. The call will be ignored if \fIf\fR is larger than frameCount() or smaller than 0. +.PP +See also frame() and move(). +.SH "void QCanvasSprite::setFrameAnimation ( FrameAnimationType type = Cycle, int step = 1, int state = 0 )\fC [virtual]\fR" +Sets the animation characteristics for the sprite. +.PP +For \fItype\fR == Cycle, the frames will increase by \fIstep\fR at each advance, modulo the frameCount(). +.PP +For \fItype\fR == Oscillate, the frames will increase by \fIstep\fR at each advance, up to the frameCount(), then decrease by \fIstep\fR back to 0, repeating forever. +.PP +The \fIstate\fR parameter is for internal use. +.SH "void QCanvasSprite::setSequence ( QCanvasPixmapArray * a )" +Set the array of images used for displaying the sprite to the QCanvasPixmapArray \fIa\fR. +.PP +If the current frame() is larger than the number of images in \fIa\fR, the current frame will be reset to 0. +.SH "int QCanvasSprite::topEdge () const" +Returns the y-coordinate of the top edge of the sprite. (This may change as the sprite animates since different frames may have different top edges.) +.PP +See also leftEdge(), rightEdge(), and bottomEdge(). +.SH "int QCanvasSprite::topEdge ( int ny ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns what the y-coordinate of the top edge of the sprite would be if the sprite (actually its hotspot) were moved to y-position \fIny\fR. +.PP +See also leftEdge(), rightEdge(), and bottomEdge(). +.SH "int QCanvasSprite::width () const" +The width of the sprite for the current frame's image. +.PP +See also frame(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvassprite.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvassprite.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvastext.3qt b/doc/man/man3/tqcanvastext.3qt new file mode 100644 index 000000000..3d5d1088e --- /dev/null +++ b/doc/man/man3/tqcanvastext.3qt @@ -0,0 +1,160 @@ +'\" t +.TH QCanvasText 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 +QCanvasText \- Text object on a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QCanvasItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasText\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "\fBQCanvasText\fR ( const QString & t, QCanvas * canvas )" +.br +.ti -1c +.BI "\fBQCanvasText\fR ( const QString & t, QFont f, QCanvas * canvas )" +.br +.ti -1c +.BI "virtual \fB~QCanvasText\fR ()" +.br +.ti -1c +.BI "void \fBsetText\fR ( const QString & t )" +.br +.ti -1c +.BI "void \fBsetFont\fR ( const QFont & f )" +.br +.ti -1c +.BI "void \fBsetColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "QFont \fBfont\fR () const" +.br +.ti -1c +.BI "QColor \fBcolor\fR () const" +.br +.ti -1c +.BI "int \fBtextFlags\fR () const" +.br +.ti -1c +.BI "void \fBsetTextFlags\fR ( int f )" +.br +.ti -1c +.BI "virtual QRect \fBboundingRect\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdraw\fR ( QPainter & painter )" +.br +.in -1c +.SH DESCRIPTION +The QCanvasText class provides a text object on a QCanvas. +.PP +A canvas text item has text with font, color and alignment attributes. The text and font can be set in the constructor or set or changed later with setText() and setFont(). The color is set with setColor() and the alignment with setTextFlags(). The text item's bounding rectangle is retrieved with boundingRect(). +.PP +The text can be drawn on a painter with draw(). +.PP +Like any other canvas item text items can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ(). +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasText::QCanvasText ( QCanvas * canvas )" +Constructs a QCanvasText with the text "<text>", on \fIcanvas\fR. +.SH "QCanvasText::QCanvasText ( const QString & t, QCanvas * canvas )" +Constructs a QCanvasText with the text \fIt\fR, on canvas \fIcanvas\fR. +.SH "QCanvasText::QCanvasText ( const QString & t, QFont f, QCanvas * canvas )" +Constructs a QCanvasText with the text \fIt\fR and font \fIf\fR, on the canvas \fIcanvas\fR. +.SH "QCanvasText::~QCanvasText ()\fC [virtual]\fR" +Destroys the canvas text item. +.SH "QRect QCanvasText::boundingRect () const\fC [virtual]\fR" +Returns the bounding rectangle of the text. +.PP +Reimplemented from QCanvasItem. +.SH "QColor QCanvasText::color () const" +Returns the color of the text. +.PP +See also setColor(). +.SH "void QCanvasText::draw ( QPainter & painter )\fC [virtual protected]\fR" +Draws the text using the painter \fIpainter\fR. +.PP +Reimplemented from QCanvasItem. +.SH "QFont QCanvasText::font () const" +Returns the font in which the text is drawn. +.PP +See also setFont(). +.SH "int QCanvasText::rtti () const\fC [virtual]\fR" +Returns 3 (QCanvasItem::Rtti_Text). +.PP +See also QCanvasItem::rtti(). +.PP +Reimplemented from QCanvasItem. +.SH "void QCanvasText::setColor ( const QColor & c )" +Sets the color of the text to the color \fIc\fR. +.PP +See also color() and setFont(). +.PP +Example: chart/chartform_canvas.cpp. +.SH "void QCanvasText::setFont ( const QFont & f )" +Sets the font in which the text is drawn to font \fIf\fR. +.PP +See also font(). +.SH "void QCanvasText::setText ( const QString & t )" +Sets the text item's text to \fIt\fR. The text may contain newlines. +.PP +See also text(), setFont(), setColor(), and setTextFlags(). +.PP +Example: canvas/canvas.cpp. +.SH "void QCanvasText::setTextFlags ( int f )" +Sets the alignment flags to \fIf\fR. These are a bitwise OR of the flags available to QPainter::drawText() -- see the Qt::AlignmentFlags. +.PP +See also setFont() and setColor(). +.SH "QString QCanvasText::text () const" +Returns the text item's text. +.PP +See also setText(). +.SH "int QCanvasText::textFlags () const" +Returns the currently set alignment flags. +.PP +See also setTextFlags() and Qt::AlignmentFlags. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvastext.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvastext.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcanvasview.3qt b/doc/man/man3/tqcanvasview.3qt new file mode 100644 index 000000000..1a82b19cd --- /dev/null +++ b/doc/man/man3/tqcanvasview.3qt @@ -0,0 +1,188 @@ +'\" t +.TH QCanvasView 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 +QCanvasView \- On-screen view of a QCanvas +.SH SYNOPSIS +\fC#include <ntqcanvas.h>\fR +.PP +Inherits QScrollView. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCanvasView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQCanvasView\fR ( QCanvas * canvas, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QCanvasView\fR ()" +.br +.ti -1c +.BI "QCanvas * \fBcanvas\fR () const" +.br +.ti -1c +.BI "void \fBsetCanvas\fR ( QCanvas * canvas )" +.br +.ti -1c +.BI "const QWMatrix & \fBworldMatrix\fR () const" +.br +.ti -1c +.BI "const QWMatrix & \fBinverseWorldMatrix\fR () const" +.br +.ti -1c +.BI "bool \fBsetWorldMatrix\fR ( const QWMatrix & wm )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * p, int cx, int cy, int cw, int ch )" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QCanvasView class provides an on-screen view of a QCanvas. +.PP +A QCanvasView is widget which provides a view of a QCanvas. +.PP +If you want users to be able to interact with a canvas view, subclass QCanvasView. You might then reimplement QScrollView::contentsMousePressEvent(). For example, assuming no transformation matrix is set: +.PP +.nf +.br + void MyCanvasView::contentsMousePressEvent( QMouseEvent* e ) +.br + { +.br + QCanvasItemList l = canvas()->collisions(e->pos()); +.br + for (QCanvasItemList::Iterator it=l.begin(); it!=l.end(); ++it) { +.br + if ( (*it)->rtti() == QCanvasRectangle::RTTI ) +.br + tqDebug("A QCanvasRectangle lies somewhere at this point"); +.br + } +.br + } +.br +.fi +.PP +The canvas view shows canvas canvas(); this can be changed using setCanvas(). +.PP +A transformation matrix can be used to transform the view of the canvas in various ways, for example, zooming in or out or rotating. For example: +.PP +.nf +.br + QWMatrix wm; +.br + wm.scale( 2, 2 ); // Zooms in by 2 times +.br + wm.rotate( 90 ); // Rotates 90 degrees counter clockwise +.br + // around the origin. +.br + wm.translate( 0, -canvas->height() ); +.br + // moves the canvas down so what was visible +.br + // before is still visible. +.br + myCanvasView->setWorldMatrix( wm ); +.br +.fi +.PP +Use setWorldMatrix() to set the canvas view's world matrix: you must ensure that the world matrix is invertible. The current world matrix is retrievable with worldMatrix(), and its inversion is retrievable with inverseWorldMatrix(). +.PP +Example: +.PP +The following code finds the part of the canvas that is visible in this view, i.e. the bounding rectangle of the view in canvas coordinates. +.PP +.nf +.br + QRect rc = QRect( myCanvasView->contentsX(), myCanvasView->contentsY(), +.br + myCanvasView->visibleWidth(), myCanvasView->visibleHeight() ); +.br + QRect canvasRect = myCanvasView->inverseWorldMatrix().mapRect(rc); +.br +.fi +.PP +See also QWMatrix, QPainter::setWorldMatrix(), Graphics Classes, and Image Processing Classes. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCanvasView::QCanvasView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a QCanvasView with parent \fIparent\fR, and name \fIname\fR, using the widget flags \fIf\fR. The canvas view is not associated with a canvas, so you must to call setCanvas() to view a canvas. +.SH "QCanvasView::QCanvasView ( QCanvas * canvas, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a QCanvasView which views canvas \fIcanvas\fR, with parent \fIparent\fR, and name \fIname\fR, using the widget flags \fIf\fR. +.SH "QCanvasView::~QCanvasView ()" +Destroys the canvas view. The associated canvas is \fInot\fR deleted. +.SH "QCanvas * QCanvasView::canvas () const" +Returns a pointer to the canvas which the QCanvasView is currently showing. +.SH "void QCanvasView::drawContents ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" +Repaints part of the QCanvas that the canvas view is showing starting at \fIcx\fR by \fIcy\fR, with a width of \fIcw\fR and a height of \fIch\fR using the painter \fIp\fR. +.PP +\fBWarning:\fR When double buffering is enabled, drawContents() will not respect the current settings of the painter when setting up the painter for the double buffer (e.g., viewport() and window()). Also, be aware that QCanvas::update() bypasses drawContents(), which means any reimplementation of drawContents() is not called. +.PP +See also QCanvas::setDoubleBuffering(). +.PP +Reimplemented from QScrollView. +.SH "const QWMatrix & QCanvasView::inverseWorldMatrix () const" +Returns a reference to the inverse of the canvas view's current transformation matrix. +.PP +See also setWorldMatrix() and worldMatrix(). +.SH "void QCanvasView::setCanvas ( QCanvas * canvas )" +Sets the canvas that the QCanvasView is showing to the canvas \fIcanvas\fR. +.SH "bool QCanvasView::setWorldMatrix ( const QWMatrix & wm )" +Sets the transformation matrix of the QCanvasView to \fIwm\fR. The matrix must be invertible (i.e. if you create a world matrix that zooms out by 2 times, then the inverse of this matrix is one that will zoom in by 2 times). +.PP +When you use this, you should note that the performance of the QCanvasView will decrease considerably. +.PP +Returns FALSE if \fIwm\fR is not invertable; otherwise returns TRUE. +.PP +See also worldMatrix(), inverseWorldMatrix(), and QWMatrix::isInvertible(). +.PP +Example: canvas/canvas.cpp. +.SH "QSize QCanvasView::sizeHint () const\fC [virtual protected]\fR" +Suggests a size sufficient to view the entire canvas. +.SH "const QWMatrix & QCanvasView::worldMatrix () const" +Returns a reference to the canvas view's current transformation matrix. +.PP +See also setWorldMatrix() and inverseWorldMatrix(). +.PP +Example: canvas/canvas.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcanvasview.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcanvasview.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcdestyle.3qt b/doc/man/man3/tqcdestyle.3qt new file mode 100644 index 000000000..4a7126bc0 --- /dev/null +++ b/doc/man/man3/tqcdestyle.3qt @@ -0,0 +1,64 @@ +'\" t +.TH QCDEStyle 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 +QCDEStyle \- CDE look and feel +.SH SYNOPSIS +\fC#include <ntqcdestyle.h>\fR +.PP +Inherits QMotifStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCDEStyle\fR ( bool useHighlightCols = FALSE )" +.br +.ti -1c +.BI "virtual \fB~QCDEStyle\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QCDEStyle class provides a CDE look and feel. +.PP +This style provides a slightly improved Motif look similar to some versions of the Common Desktop Environment (CDE). The main differences are thinner frames and more modern radio buttons and checkboxes. Together with a dark background and a bright text/foreground color, the style looks quite attractive (at least for Motif fans). +.PP +Note that the functions provided by QCDEStyle are reimplementations of QStyle functions; see QStyle for their documentation. +.PP +See also Widget Appearance and Style. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCDEStyle::QCDEStyle ( bool useHighlightCols = FALSE )" +Constructs a QCDEStyle. +.PP +If \fIuseHighlightCols\fR is FALSE (the default), then the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. +.SH "QCDEStyle::~QCDEStyle ()\fC [virtual]\fR" +Destroys the style. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcdestyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcdestyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqchar.3qt b/doc/man/man3/tqchar.3qt new file mode 100644 index 000000000..0aa39faca --- /dev/null +++ b/doc/man/man3/tqchar.3qt @@ -0,0 +1,490 @@ +'\" t +.TH QChar 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 +QChar \- Lightweight Unicode character +.SH SYNOPSIS +Almost all the functions in this class are reentrant when Qt is built with thread support. The exception is \fBdecomposition\fR(). </p> +.PP +\fC#include <ntqstring.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQChar\fR ()" +.br +.ti -1c +.BI "\fBQChar\fR ( char c )" +.br +.ti -1c +.BI "\fBQChar\fR ( uchar c )" +.br +.ti -1c +.BI "\fBQChar\fR ( uchar c, uchar r )" +.br +.ti -1c +.BI "\fBQChar\fR ( const QChar & c )" +.br +.ti -1c +.BI "\fBQChar\fR ( ushort rc )" +.br +.ti -1c +.BI "\fBQChar\fR ( short rc )" +.br +.ti -1c +.BI "\fBQChar\fR ( uint rc )" +.br +.ti -1c +.BI "\fBQChar\fR ( int rc )" +.br +.ti -1c +.BI "enum \fBCategory\fR { NoCategory, Mark_NonSpacing, Mark_SpacingCombining, Mark_Enclosing, Number_DecimalDigit, Number_Letter, Number_Other, Separator_Space, Separator_Line, Separator_Paragraph, Other_Control, Other_Format, Other_Surrogate, Other_PrivateUse, Other_NotAssigned, Letter_Uppercase, Letter_Lowercase, Letter_Titlecase, Letter_Modifier, Letter_Other, Punctuation_Connector, Punctuation_Dash, Punctuation_Dask = Punctuation_Dash, Punctuation_Open, Punctuation_Close, Punctuation_InitialQuote, Punctuation_FinalQuote, Punctuation_Other, Symbol_Math, Symbol_Currency, Symbol_Modifier, Symbol_Other }" +.br +.ti -1c +.BI "enum \fBDirection\fR { DirL, DirR, DirEN, DirES, DirET, DirAN, DirCS, DirB, DirS, DirWS, DirON, DirLRE, DirLRO, DirAL, DirRLE, DirRLO, DirPDF, DirNSM, DirBN }" +.br +.ti -1c +.BI "enum \fBDecomposition\fR { Single, Canonical, Font, NoBreak, Initial, Medial, Final, Isolated, Circle, Super, Sub, Vertical, Wide, Narrow, Small, Square, Compat, Fraction }" +.br +.ti -1c +.BI "enum \fBJoining\fR { OtherJoining, Dual, Right, Center }" +.br +.ti -1c +.BI "enum \fBCombiningClass\fR { Combining_BelowLeftAttached = 200, Combining_BelowAttached = 202, Combining_BelowRightAttached = 204, Combining_LeftAttached = 208, Combining_RightAttached = 210, Combining_AboveLeftAttached = 212, Combining_AboveAttached = 214, Combining_AboveRightAttached = 216, Combining_BelowLeft = 218, Combining_Below = 220, Combining_BelowRight = 222, Combining_Left = 224, Combining_Right = 226, Combining_AboveLeft = 228, Combining_Above = 230, Combining_AboveRight = 232, Combining_DoubleBelow = 233, Combining_DoubleAbove = 234, Combining_IotaSubscript = 240 }" +.br +.ti -1c +.BI "int \fBdigitValue\fR () const" +.br +.ti -1c +.BI "QChar \fBlower\fR () const" +.br +.ti -1c +.BI "QChar \fBupper\fR () const" +.br +.ti -1c +.BI "Category \fBcategory\fR () const" +.br +.ti -1c +.BI "Direction \fBdirection\fR () const" +.br +.ti -1c +.BI "Joining \fBjoining\fR () const" +.br +.ti -1c +.BI "bool \fBmirrored\fR () const" +.br +.ti -1c +.BI "QChar \fBmirroredChar\fR () const" +.br +.ti -1c +.BI "const QString & \fBdecomposition\fR () const" +.br +.ti -1c +.BI "Decomposition \fBdecompositionTag\fR () const" +.br +.ti -1c +.BI "unsigned char \fBcombiningClass\fR () const" +.br +.ti -1c +.BI "char \fBlatin1\fR () const" +.br +.ti -1c +.BI "ushort \fBunicode\fR () const" +.br +.ti -1c +.BI "ushort & \fBunicode\fR ()" +.br +.ti -1c +.BI "\fBoperator char\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisPrint\fR () const" +.br +.ti -1c +.BI "bool \fBisPunct\fR () const" +.br +.ti -1c +.BI "bool \fBisSpace\fR () const" +.br +.ti -1c +.BI "bool \fBisMark\fR () const" +.br +.ti -1c +.BI "bool \fBisLetter\fR () const" +.br +.ti -1c +.BI "bool \fBisNumber\fR () const" +.br +.ti -1c +.BI "bool \fBisLetterOrNumber\fR () const" +.br +.ti -1c +.BI "bool \fBisDigit\fR () const" +.br +.ti -1c +.BI "bool \fBisSymbol\fR () const" +.br +.ti -1c +.BI "uchar \fBcell\fR () const" +.br +.ti -1c +.BI "uchar \fBrow\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool networkOrdered () \fI(obsolete)\fR" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "bool \fBoperator==\fR ( QChar c1, QChar c2 )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( char ch, QChar c )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( QChar c, char ch )" +.br +.ti -1c +.BI "int \fBoperator!=\fR ( QChar c1, QChar c2 )" +.br +.ti -1c +.BI "int \fBoperator!=\fR ( char ch, QChar c )" +.br +.ti -1c +.BI "int \fBoperator!=\fR ( QChar c, char ch )" +.br +.ti -1c +.BI "int \fBoperator<=\fR ( QChar c1, QChar c2 )" +.br +.ti -1c +.BI "int \fBoperator<=\fR ( QChar c, char ch )" +.br +.ti -1c +.BI "int \fBoperator<=\fR ( char ch, QChar c )" +.br +.ti -1c +.BI "int \fBoperator>=\fR ( QChar c1, QChar c2 )" +.br +.ti -1c +.BI "int \fBoperator>=\fR ( QChar c, char ch )" +.br +.ti -1c +.BI "int \fBoperator>=\fR ( char ch, QChar c )" +.br +.ti -1c +.BI "int \fBoperator<\fR ( QChar c1, QChar c2 )" +.br +.ti -1c +.BI "int \fBoperator<\fR ( QChar c, char ch )" +.br +.ti -1c +.BI "int \fBoperator<\fR ( char ch, QChar c )" +.br +.ti -1c +.BI "int \fBoperator>\fR ( QChar c1, QChar c2 )" +.br +.ti -1c +.BI "int \fBoperator>\fR ( QChar c, char ch )" +.br +.ti -1c +.BI "int \fBoperator>\fR ( char ch, QChar c )" +.br +.in -1c +.SH DESCRIPTION +The QChar class provides a lightweight Unicode character. +.PP +Unicode characters are (so far) 16-bit entities without any markup or structure. This class represents such an entity. It is lightweight, so it can be used everywhere. Most compilers treat it like a "short int". (In a few years it may be necessary to make QChar 32-bit when more than 65536 Unicode code points have been defined and come into use.) +.PP +QChar provides a full complement of testing/classification functions, converting to and from other formats, converting from composed to decomposed Unicode, and trying to compare and case-convert if you ask it to. +.PP +The classification functions include functions like those in ctype.h, but operating on the full range of Unicode characters. They all return TRUE if the character is a certain type of character; otherwise they return FALSE. These classification functions are isNull() (returns TRUE if the character is U+0000), isPrint() (TRUE if the character is any sort of printable character, including whitespace), isPunct() (any sort of punctation), isMark() (Unicode Mark), isLetter (a letter), isNumber() (any sort of numeric character), isLetterOrNumber(), and isDigit() (decimal digits). All of these are wrappers around category() which return the Unicode-defined category of each character. +.PP +QChar further provides direction(), which indicates the "natural" writing direction of this character. The joining() function indicates how the character joins with its neighbors (needed mostly for Arabic) and finally mirrored(), which indicates whether the character needs to be mirrored when it is printed in its" unnatural" writing direction. +.PP +Composed Unicode characters (like å) can be converted to decomposed Unicode ("a" followed by "ring above") by using decomposition(). +.PP +In Unicode, comparison is not necessarily possible and case conversion is very difficult at best. Unicode, covering the" entire" world, also includes most of the world's case and sorting problems. Qt tries, but not very hard: operator==() and friends will do comparison based purely on the numeric Unicode value (code point) of the characters, and upper() and lower() will do case changes when the character has a well-defined upper/lower-case equivalent. There is no provision for locale-dependent case folding rules or comparison; these functions are meant to be fast so they can be used unambiguously in data structures. (See QString::localeAwareCompare() though.) +.PP +The conversion functions include unicode() (to a scalar), latin1() (to scalar, but converts all non-Latin-1 characters to 0), row() (gives the Unicode row), cell() (gives the Unicode cell), digitValue() (gives the integer value of any of the numerous digit characters), and a host of constructors. +.PP +More information can be found in the document About Unicode. +.PP +See also QString, QCharRef, and Text Related Classes. +.SS "Member Type Documentation" +.SH "QChar::Category" +This enum maps the Unicode character categories. +.PP +The following characters are normative in Unicode: +.TP +\fCQChar::Mark_NonSpacing\fR - Unicode class name Mn +.TP +\fCQChar::Mark_SpacingCombining\fR - Unicode class name Mc +.TP +\fCQChar::Mark_Enclosing\fR - Unicode class name Me +.TP +\fCQChar::Number_DecimalDigit\fR - Unicode class name Nd +.TP +\fCQChar::Number_Letter\fR - Unicode class name Nl +.TP +\fCQChar::Number_Other\fR - Unicode class name No +.TP +\fCQChar::Separator_Space\fR - Unicode class name Zs +.TP +\fCQChar::Separator_Line\fR - Unicode class name Zl +.TP +\fCQChar::Separator_Paragraph\fR - Unicode class name Zp +.TP +\fCQChar::Other_Control\fR - Unicode class name Cc +.TP +\fCQChar::Other_Format\fR - Unicode class name Cf +.TP +\fCQChar::Other_Surrogate\fR - Unicode class name Cs +.TP +\fCQChar::Other_PrivateUse\fR - Unicode class name Co +.TP +\fCQChar::Other_NotAssigned\fR - Unicode class name Cn +.PP +The following categories are informative in Unicode: +.TP +\fCQChar::Letter_Uppercase\fR - Unicode class name Lu +.TP +\fCQChar::Letter_Lowercase\fR - Unicode class name Ll +.TP +\fCQChar::Letter_Titlecase\fR - Unicode class name Lt +.TP +\fCQChar::Letter_Modifier\fR - Unicode class name Lm +.TP +\fCQChar::Letter_Other\fR - Unicode class name Lo +.TP +\fCQChar::Punctuation_Connector\fR - Unicode class name Pc +.TP +\fCQChar::Punctuation_Dash\fR - Unicode class name Pd +.TP +\fCQChar::Punctuation_Open\fR - Unicode class name Ps +.TP +\fCQChar::Punctuation_Close\fR - Unicode class name Pe +.TP +\fCQChar::Punctuation_InitialQuote\fR - Unicode class name Pi +.TP +\fCQChar::Punctuation_FinalQuote\fR - Unicode class name Pf +.TP +\fCQChar::Punctuation_Other\fR - Unicode class name Po +.TP +\fCQChar::Symbol_Math\fR - Unicode class name Sm +.TP +\fCQChar::Symbol_Currency\fR - Unicode class name Sc +.TP +\fCQChar::Symbol_Modifier\fR - Unicode class name Sk +.TP +\fCQChar::Symbol_Other\fR - Unicode class name So +.PP +There are two categories that are specific to Qt: +.TP +\fCQChar::NoCategory\fR - used when Qt is dazed and confused and cannot make sense of anything. +.TP +\fCQChar::Punctuation_Dask\fR - old typo alias for Punctuation_Dash +.SH "QChar::CombiningClass" +This enum type defines names for some of the Unicode combining classes. See the Unicode Standard for a description of the values. +.SH "QChar::Decomposition" +This enum type defines the Unicode decomposition attributes. See the Unicode Standard for a description of the values. +.SH "QChar::Direction" +This enum type defines the Unicode direction attributes. See the Unicode Standard for a description of the values. +.PP +In order to conform to C/C++ naming conventions "Dir" is prepended to the codes used in the Unicode Standard. +.SH "QChar::Joining" +This enum type defines the Unicode joining attributes. See the Unicode Standard for a description of the values. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QChar::QChar ()" +Constructs a null QChar (one that isNull()). +.SH "QChar::QChar ( char c )" +Constructs a QChar corresponding to ASCII/Latin-1 character \fIc\fR. +.SH "QChar::QChar ( uchar c )" +Constructs a QChar corresponding to ASCII/Latin-1 character \fIc\fR. +.SH "QChar::QChar ( uchar c, uchar r )" +Constructs a QChar for Unicode cell \fIc\fR in row \fIr\fR. +.SH "QChar::QChar ( const QChar & c )" +Constructs a copy of \fIc\fR. This is a deep copy, if such a lightweight object can be said to have deep copies. +.SH "QChar::QChar ( ushort rc )" +Constructs a QChar for the character with Unicode code point \fIrc\fR. +.SH "QChar::QChar ( short rc )" +Constructs a QChar for the character with Unicode code point \fIrc\fR. +.SH "QChar::QChar ( uint rc )" +Constructs a QChar for the character with Unicode code point \fIrc\fR. +.SH "QChar::QChar ( int rc )" +Constructs a QChar for the character with Unicode code point \fIrc\fR. +.SH "Category QChar::category () const" +Returns the character category. +.PP +See also Category. +.SH "uchar QChar::cell () const" +Returns the cell (least significant byte) of the Unicode character. +.SH "unsigned char QChar::combiningClass () const" +Returns the combining class for the character as defined in the Unicode standard. This is mainly useful as a positioning hint for marks attached to a base character. +.PP +The Qt text rendering engine uses this information to correctly position non spacing marks around a base character. +.SH "const QString & QChar::decomposition () const" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Decomposes a character into its parts. Returns QString::null if no decomposition exists. +.SH "Decomposition QChar::decompositionTag () const" +Returns the tag defining the composition of the character. Returns QChar::Single if no decomposition exists. +.SH "int QChar::digitValue () const" +Returns the numeric value of the digit, or -1 if the character is not a digit. +.SH "Direction QChar::direction () const" +Returns the character's direction. +.PP +See also Direction. +.SH "bool QChar::isDigit () const" +Returns TRUE if the character is a decimal digit (Number_DecimalDigit); otherwise returns FALSE. +.SH "bool QChar::isLetter () const" +Returns TRUE if the character is a letter (Letter_* categories); otherwise returns FALSE. +.SH "bool QChar::isLetterOrNumber () const" +Returns TRUE if the character is a letter or number (Letter_* or Number_* categories); otherwise returns FALSE. +.SH "bool QChar::isMark () const" +Returns TRUE if the character is a mark (Mark_* categories); otherwise returns FALSE. +.SH "bool QChar::isNull () const" +Returns TRUE if the character is the Unicode character 0x0000 (ASCII NUL); otherwise returns FALSE. +.SH "bool QChar::isNumber () const" +Returns TRUE if the character is a number (of any sort - Number_* categories); otherwise returns FALSE. +.PP +See also isDigit(). +.SH "bool QChar::isPrint () const" +Returns TRUE if the character is a printable character; otherwise returns FALSE. This is any character not of category Cc or Cn. +.PP +Note that this gives no indication of whether the character is available in a particular font. +.SH "bool QChar::isPunct () const" +Returns TRUE if the character is a punctuation mark (Punctuation_* categories); otherwise returns FALSE. +.SH "bool QChar::isSpace () const" +Returns TRUE if the character is a separator character (Separator_* categories); otherwise returns FALSE. +.SH "bool QChar::isSymbol () const" +Returns TRUE if the character is a symbol (Symbol_* categories); otherwise returns FALSE. +.SH "Joining QChar::joining () const" +\fBWarning:\fR This function is not supported (it may change to use Unicode character classes). +.PP +Returns information about the joining properties of the character (needed for example, for Arabic). +.SH "char QChar::latin1 () const" +Returns the Latin-1 value of this character, or 0 if it cannot be represented in Latin-1. +.SH "QChar QChar::lower () const" +Returns the lowercase equivalent if the character is uppercase; otherwise returns the character itself. +.SH "bool QChar::mirrored () const" +Returns TRUE if the character is a mirrored character (one that should be reversed if the text direction is reversed); otherwise returns FALSE. +.SH "QChar QChar::mirroredChar () const" +Returns the mirrored character if this character is a mirrored character, otherwise returns the character itself. +.SH "bool QChar::networkOrdered ()\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if this character is in network byte order (MSB first); otherwise returns FALSE. This is platform dependent. +.SH "QChar::operator char () const" +Returns the Latin-1 character equivalent to the QChar, or 0. This is mainly useful for non-internationalized software. +.PP +See also unicode(). +.SH "uchar QChar::row () const" +Returns the row (most significant byte) of the Unicode character. +.SH "ushort QChar::unicode () const" +Returns the numeric Unicode value equal to the QChar. Normally, you should use QChar objects as they are equivalent, but for some low-level tasks (e.g. indexing into an array of Unicode information), this function is useful. +.SH "ushort & QChar::unicode ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a reference to the numeric Unicode value equal to the QChar. +.SH "QChar QChar::upper () const" +Returns the uppercase equivalent if the character is lowercase; otherwise returns the character itself. +.SH RELATED FUNCTION DOCUMENTATION +.SH "int operator!= ( QChar c1, QChar c2 )" +Returns TRUE if \fIc1\fR and \fIc2\fR are not the same Unicode character; otherwise returns FALSE. +.SH "int operator!= ( char ch, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIc\fR is not the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "int operator!= ( QChar c, char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIc\fR is not the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "int operator< ( QChar c1, QChar c2 )" +Returns TRUE if the numeric Unicode value of \fIc1\fR is less than that of \fIc2\fR; otherwise returns FALSE. +.SH "int operator< ( QChar c, char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of \fIc\fR is less than that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "int operator< ( char ch, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 character \fIch\fR is less than that of \fIc\fR; otherwise returns FALSE. +.SH "int operator<= ( QChar c1, QChar c2 )" +Returns TRUE if the numeric Unicode value of \fIc1\fR is less than that of \fIc2\fR, or they are the same Unicode character; otherwise returns FALSE. +.SH "int operator<= ( QChar c, char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of \fIc\fR is less than or equal to that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "int operator<= ( char ch, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 character \fIch\fR is less than or equal to that of \fIc\fR; otherwise returns FALSE. +.SH "bool operator== ( QChar c1, QChar c2 )" +Returns TRUE if \fIc1\fR and \fIc2\fR are the same Unicode character; otherwise returns FALSE. +.SH "bool operator== ( char ch, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIc\fR is the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "bool operator== ( QChar c, char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIc\fR is the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "int operator> ( QChar c1, QChar c2 )" +Returns TRUE if the numeric Unicode value of \fIc1\fR is greater than that of \fIc2\fR; otherwise returns FALSE. +.SH "int operator> ( QChar c, char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of \fIc\fR is greater than that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "int operator> ( char ch, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 character \fIch\fR is greater than that of \fIc\fR; otherwise returns FALSE. +.SH "int operator>= ( QChar c1, QChar c2 )" +Returns TRUE if the numeric Unicode value of \fIc1\fR is greater than that of \fIc2\fR, or they are the same Unicode character; otherwise returns FALSE. +.SH "int operator>= ( QChar c, char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of \fIc\fR is greater than or equal to that of the ASCII/Latin-1 character \fIch\fR; otherwise returns FALSE. +.SH "int operator>= ( char ch, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the numeric Unicode value of the ASCII/Latin-1 +character \fIch\fR is greater than or equal to that of \fIc\fR; +otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qchar.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqchar.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcharref.3qt b/doc/man/man3/tqcharref.3qt new file mode 100644 index 000000000..bfc667bac --- /dev/null +++ b/doc/man/man3/tqcharref.3qt @@ -0,0 +1,48 @@ +'\" t +.TH QCharRef 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 +QCharRef \- Helper class for QString +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqstring.h>\fR +.PP +.SH DESCRIPTION +The QCharRef class is a helper class for QString. +.PP +When you get an object of type QCharRef, if you can assign to it, the assignment will apply to the character in the string from which you got the reference. That is its whole purpose in life. The QCharRef becomes invalid once modifications are made to the string: if you want to keep the character, copy it into a QChar. +.PP +Most of the QChar member functions also exist in QCharRef. However, they are not explicitly documented here. +.PP +See also QString::operator[](), QString::at(), QChar, and Text Related Classes. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcharref.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcharref.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcheckbox.3qt b/doc/man/man3/tqcheckbox.3qt new file mode 100644 index 000000000..3f331d73c --- /dev/null +++ b/doc/man/man3/tqcheckbox.3qt @@ -0,0 +1,308 @@ +'\" t +.TH QCheckBox 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 +QCheckBox \- Checkbox with a text label +.SH SYNOPSIS +\fC#include <ntqcheckbox.h>\fR +.PP +Inherits QButton. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCheckBox\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQCheckBox\fR ( const QString & text, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "bool \fBisChecked\fR () const" +.br +.ti -1c +.BI "void \fBsetNoChange\fR ()" +.br +.ti -1c +.BI "void \fBsetTristate\fR ( bool y = TRUE )" +.br +.ti -1c +.BI "bool \fBisTristate\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBsetChecked\fR ( bool check )" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "const QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" +.br +.ti -1c +.BI "QKeySequence \fBaccel\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" +.br +.ti -1c +.BI "bool \fBisToggleButton\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDown\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisDown\fR () const" +.br +.ti -1c +.BI "bool \fBisOn\fR () const" +.br +.ti -1c +.BI "ToggleState \fBstate\fR () const" +.br +.ti -1c +.BI "bool \fBautoRepeat\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoRepeat\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisExclusiveToggle\fR () const" +.br +.ti -1c +.BI "QButtonGroup * \fBgroup\fR () const" +.br +.ti -1c +.BI "void \fBtoggle\fR ()" +.br +.ti -1c +.BI "void \fBpressed\fR ()" +.br +.ti -1c +.BI "void \fBreleased\fR ()" +.br +.ti -1c +.BI "void \fBclicked\fR ()" +.br +.ti -1c +.BI "void \fBtoggled\fR ( bool on )" +.br +.ti -1c +.BI "void \fBstateChanged\fR ( int state )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoMask\fR - whether the checkbox is automatically masked \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBchecked\fR - whether the checkbox is checked" +.br +.ti -1c +.BI "bool \fBtristate\fR - whether the checkbox is a tri-state checkbox" +.br +.in -1c +.SH DESCRIPTION +The QCheckBox widget provides a checkbox with a text label. +.PP +QCheckBox and QRadioButton are both option buttons. That is, they can be switched on (checked) or off (unchecked). The classes differ in how the choices for the user are restricted. Radio buttons define a "one of many" choice, whereas checkboxes provide" many of many" choices. +.PP +A QButtonGroup can be used to group check buttons visually. +.PP +Whenever a checkbox is checked or cleared it emits the signal toggled(). Connect to this signal if you want to trigger an action each time the checkbox changes state. You can use isChecked() to query whether or not a checkbox is checked. +.PP +\fBWarning:\fR The toggled() signal can not be trusted for tristate checkboxes. +.PP +In addition to the usual checked and unchecked states, QCheckBox optionally provides a third state to indicate "no change". This is useful whenever you need to give the user the option of neither checking nor unchecking a checkbox. If you need this third state, enable it with setTristate() and use state() to query the current toggle state. When a tristate checkbox changes state, it emits the stateChanged() signal. +.PP +Just like QPushButton, a checkbox can display text or a pixmap. The text can be set in the constructor or with setText(); the pixmap is set with setPixmap(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QButton, QRadioButton, Fowler: Check Box, and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCheckBox::QCheckBox ( QWidget * parent, const char * name = 0 )" +Constructs a checkbox with no text. +.PP +The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. +.SH "QCheckBox::QCheckBox ( const QString & text, QWidget * parent, const char * name = 0 )" +Constructs a checkbox with text \fItext\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. +.SH "QKeySequence QButton::accel () const" +Returns the accelerator associated with the button. See the "accel" property for details. +.SH "bool QButton::autoRepeat () const" +Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. +.SH "void QButton::clicked ()\fC [signal]\fR" +This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). +.PP +The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. +.PP +\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. +.PP +See also pressed(), released(), toggled(), autoRepeat, and down. +.PP +Examples: +.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. +.SH "QButtonGroup * QButton::group () const" +Returns the group that this button belongs to. +.PP +If the button is not a member of any QButtonGroup, this function returns 0. +.PP +See also QButtonGroup. +.SH "bool QCheckBox::isChecked () const" +Returns TRUE if the checkbox is checked; otherwise returns FALSE. See the "checked" property for details. +.SH "bool QButton::isDown () const" +Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. +.SH "bool QButton::isExclusiveToggle () const" +Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. +.SH "bool QButton::isOn () const" +Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. +.SH "bool QButton::isToggleButton () const" +Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. +.SH "bool QCheckBox::isTristate () const" +Returns TRUE if the checkbox is a tri-state checkbox; otherwise returns FALSE. See the "tristate" property for details. +.SH "const QPixmap * QButton::pixmap () const" +Returns the pixmap shown on the button. See the "pixmap" property for details. +.SH "void QButton::pressed ()\fC [signal]\fR" +This signal is emitted when the button is pressed down. +.PP +See also released() and clicked(). +.PP +Examples: +.)l network/httpd/httpd.cpp and popup/popup.cpp. +.SH "void QButton::released ()\fC [signal]\fR" +This signal is emitted when the button is released. +.PP +See also pressed(), clicked(), and toggled(). +.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" +Sets the accelerator associated with the button. See the "accel" property for details. +.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" +Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. +.SH "void QCheckBox::setChecked ( bool check )\fC [slot]\fR" +Sets whether the checkbox is checked to \fIcheck\fR. See the "checked" property for details. +.SH "void QButton::setDown ( bool )\fC [virtual]\fR" +Sets whether the button is pressed. See the "down" property for details. +.SH "void QCheckBox::setNoChange ()" +Sets the checkbox to the "no change" state. +.PP +See also tristate. +.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" +Sets the pixmap shown on the button. See the "pixmap" property for details. +.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" +Sets the text shown on the button. See the "text" property for details. +.SH "void QCheckBox::setTristate ( bool y = TRUE )" +Sets whether the checkbox is a tri-state checkbox to \fIy\fR. See the "tristate" property for details. +.SH "ToggleState QButton::state () const" +Returns the state of the toggle button. See the "toggleState" property for details. +.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. +.PP +See also clicked() and QButton::ToggleState. +.SH "QString QButton::text () const" +Returns the text shown on the button. See the "text" property for details. +.SH "void QButton::toggle ()\fC [slot]\fR" +Toggles the state of a toggle button. +.PP +See also on, setOn(), toggled(), and toggleButton. +.SH "void QButton::toggled ( bool on )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, or because setOn() was called. +.PP +See also clicked(). +.PP +Example: listbox/listbox.cpp. +.SS "Property Documentation" +.SH "QKeySequence accel" +This property holds the accelerator associated with the button. +.PP +This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. +.PP +Set this property's value with setAccel() and get this property's value with accel(). +.SH "bool autoMask" +This property holds whether the checkbox is automatically masked. +.PP +See also QWidget::autoMask. +.SH "bool autoRepeat" +This property holds whether autoRepeat is enabled. +.PP +If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. +.PP +Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). +.SH "bool checked" +This property holds whether the checkbox is checked. +.PP +The default is unchecked, i.e. FALSE. +.PP +Set this property's value with setChecked() and get this property's value with isChecked(). +.SH "QPixmap pixmap" +This property holds the pixmap shown on the button. +.PP +If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. +.PP +pixmap() returns 0 if no pixmap was set. +.PP +Set this property's value with setPixmap() and get this property's value with pixmap(). +.SH "QString text" +This property holds the text shown on the button. +.PP +This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. +.PP +There is no default text. +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "bool tristate" +This property holds whether the checkbox is a tri-state checkbox. +.PP +The default is two-state, i.e. tri-state is FALSE. +.PP +Set this property's value with setTristate() and get this property's value with isTristate(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcheckbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcheckbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqchecklistitem.3qt b/doc/man/man3/tqchecklistitem.3qt new file mode 100644 index 000000000..d46a037c5 --- /dev/null +++ b/doc/man/man3/tqchecklistitem.3qt @@ -0,0 +1,229 @@ +'\" t +.TH QCheckListItem 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 +QCheckListItem \- Checkable list view items +.SH SYNOPSIS +\fC#include <ntqlistview.h>\fR +.PP +Inherits QListViewItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBType\fR { RadioButton, CheckBox, Controller, RadioButtonController = Controller, CheckBoxController }" +.br +.ti -1c +.BI "enum \fBToggleState\fR { Off, NoChange, On }" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QCheckListItem * parent, const QString & text, Type tt = RadioButtonController )" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QCheckListItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QListViewItem * parent, const QString & text, Type tt = RadioButtonController )" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QListViewItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QListView * parent, const QString & text, Type tt = RadioButtonController )" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QListView * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QListViewItem * parent, const QString & text, const QPixmap & p )" +.br +.ti -1c +.BI "\fBQCheckListItem\fR ( QListView * parent, const QString & text, const QPixmap & p )" +.br +.ti -1c +.BI "\fB~QCheckListItem\fR ()" +.br +.ti -1c +.BI "virtual void \fBpaintCell\fR ( QPainter * p, const QColorGroup & cg, int column, int width, int align )" +.br +.ti -1c +.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QColorGroup & cg, const QRect & r )" +.br +.ti -1c +.BI "virtual void \fBsetOn\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisOn\fR () const" +.br +.ti -1c +.BI "Type \fBtype\fR () const" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "void \fBsetTristate\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisTristate\fR () const" +.br +.ti -1c +.BI "ToggleState \fBstate\fR () const" +.br +.ti -1c +.BI "void \fBsetState\fR ( ToggleState s )" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBactivate\fR ()" +.br +.ti -1c +.BI "void \fBturnOffChild\fR ()" +.br +.ti -1c +.BI "virtual void \fBstateChange\fR ( bool )" +.br +.in -1c +.SH DESCRIPTION +The QCheckListItem class provides checkable list view items. +.PP +QCheckListItems are used in QListViews to provide QListViewItems that are checkboxes, radio buttons or controllers. +.PP +Checkbox and controller check list items may be inserted at any level in a list view. Radio button check list items must be children of a controller check list item. +.PP +The item can be checked or unchecked with setOn(). Its type can be retrieved with type() and its text retrieved with text(). +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QListViewItem, QListView, and Advanced Widgets. +.SS "Member Type Documentation" +.SH "QCheckListItem::ToggleState" +This enum specifies a QCheckListItem's toggle state. +.TP +\fCQCheckListItem::Off\fR +.TP +\fCQCheckListItem::NoChange\fR +.TP +\fCQCheckListItem::On\fR +.SH "QCheckListItem::Type" +This enum type specifies a QCheckListItem's type: +.TP +\fCQCheckListItem::RadioButton\fR +.TP +\fCQCheckListItem::CheckBox\fR +.TP +\fCQCheckListItem::Controller\fR - \fIobsolete\fR (use RadioButtonController instead) +.TP +\fCQCheckListItem::RadioButtonController\fR +.TP +\fCQCheckListItem::CheckBoxController\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCheckListItem::QCheckListItem ( QCheckListItem * parent, const QString & text, Type tt = RadioButtonController )" +Constructs a checkable item with parent \fIparent\fR, text \fItext\fR and of type \fItt\fR. Note that a RadioButton must be the child of a RadioButtonController, otherwise it will not toggle. +.SH "QCheckListItem::QCheckListItem ( QCheckListItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" +Constructs a checkable item with parent \fIparent\fR, which is after \fIafter\fR in the parent's list of children, and with text \fItext\fR and of type \fItt\fR. Note that a RadioButton must be the child of a RadioButtonController, otherwise it will not toggle. +.SH "QCheckListItem::QCheckListItem ( QListViewItem * parent, const QString & text, Type tt = RadioButtonController )" +Constructs a checkable item with parent \fIparent\fR, text \fItext\fR and of type \fItt\fR. Note that this item must \fInot\fR be a RadioButton. Radio buttons must be children of a RadioButtonController. +.SH "QCheckListItem::QCheckListItem ( QListViewItem * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" +Constructs a checkable item with parent \fIparent\fR, which is after \fIafter\fR in the parent's list of children, with text \fItext\fR and of type \fItt\fR. Note that this item must \fInot\fR be a RadioButton. Radio buttons must be children of a RadioButtonController. +.SH "QCheckListItem::QCheckListItem ( QListView * parent, const QString & text, Type tt = RadioButtonController )" +Constructs a checkable item with parent \fIparent\fR, text \fItext\fR and of type \fItt\fR. Note that \fItt\fR must \fInot\fR be RadioButton. Radio buttons must be children of a RadioButtonController. +.SH "QCheckListItem::QCheckListItem ( QListView * parent, QListViewItem * after, const QString & text, Type tt = RadioButtonController )" +Constructs a checkable item with parent \fIparent\fR, which is after \fIafter\fR in the parent's list of children, with text \fItext\fR and of type \fItt\fR. Note that \fItt\fR must \fInot\fR be RadioButton. Radio buttons must be children of a RadioButtonController. +.SH "QCheckListItem::QCheckListItem ( QListViewItem * parent, const QString & text, const QPixmap & p )" +Constructs a RadioButtonController item with parent \fIparent\fR, text \fItext\fR and pixmap \fIp\fR. +.SH "QCheckListItem::QCheckListItem ( QListView * parent, const QString & text, const QPixmap & p )" +Constructs a RadioButtonController item with parent \fIparent\fR, text \fItext\fR and pixmap \fIp\fR. +.SH "QCheckListItem::~QCheckListItem ()" +Destroys the item, and all its children to any depth, freeing up all allocated resources. +.SH "void QCheckListItem::activate ()\fC [virtual protected]\fR" +Toggle check box or set radio button to on. +.PP +Reimplemented from QListViewItem. +.SH "bool QCheckListItem::isOn () const" +Returns TRUE if the item is toggled on; otherwise returns FALSE. +.SH "bool QCheckListItem::isTristate () const" +Returns TRUE if the item is tristate; otherwise returns FALSE. +.PP +See also setTristate(). +.SH "void QCheckListItem::paintCell ( QPainter * p, const QColorGroup & cg, int column, int width, int align )\fC [virtual]\fR" +Paints the item using the painter \fIp\fR and the color group \fIcg\fR. The item is in column \fIcolumn\fR, has width \fIwidth\fR and has alignment \fIalign\fR. (See Qt::AlignmentFlags for valid alignments.) +.PP +Reimplemented from QListViewItem. +.SH "void QCheckListItem::paintFocus ( QPainter * p, const QColorGroup & cg, const QRect & r )\fC [virtual]\fR" +Draws the focus rectangle \fIr\fR using the color group \fIcg\fR on the painter \fIp\fR. +.PP +Reimplemented from QListViewItem. +.SH "int QCheckListItem::rtti () const\fC [virtual]\fR" +Returns 1. +.PP +Make your derived classes return their own values for rtti(), and you can distinguish between list view items. You should use values greater than 1000, to allow for extensions to this class. +.PP +Reimplemented from QListViewItem. +.SH "void QCheckListItem::setOn ( bool b )\fC [virtual]\fR" +Sets the button on if \fIb\fR is TRUE, otherwise sets it off. Maintains radio button exclusivity. +.SH "void QCheckListItem::setState ( ToggleState s )" +Sets the toggle state of the checklistitem to \fIs\fR. \fIs\fR can be Off, NoChange or On. +.PP +Tristate can only be enabled for CheckBox or CheckBoxController, therefore the NoChange only applies to them. +.PP +Setting the state to On or Off on a CheckBoxController will recursivly set the states of its children to the same state. +.PP +Setting the state to NoChange on a CheckBoxController will make it recursivly recall the previous stored state of its children. If there was no previous stored state the children are all set to On. +.SH "void QCheckListItem::setTristate ( bool b )" +Sets tristate to \fIb\fR if the Type is either a CheckBoxController or a CheckBox. +.PP +\fCCheckBoxControllers\fR are tristate by default. +.PP +See also state() and isTristate(). +.SH "ToggleState QCheckListItem::state () const" +Returns the state of the item. +.PP +See also QCheckListItem::ToggleState. +.SH "void QCheckListItem::stateChange ( bool )\fC [virtual protected]\fR" +This virtual function is called when the item changes its state. NoChange (if tristate is enabled and the type is either CheckBox or CheckBoxController) reports the same as Off, so use state() to determine if the state is actually Off or NoChange. +.SH "QString QCheckListItem::text () const" +Returns the item's text. +.SH "void QCheckListItem::turnOffChild ()\fC [protected]\fR" +If this is a RadioButtonController that has RadioButton children, turn off the child that is on. +.SH "Type QCheckListItem::type () const" +Returns the type of this item. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qchecklistitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqchecklistitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqchecktableitem.3qt b/doc/man/man3/tqchecktableitem.3qt new file mode 100644 index 000000000..4c9a47bfe --- /dev/null +++ b/doc/man/man3/tqchecktableitem.3qt @@ -0,0 +1,94 @@ +'\" t +.TH QCheckTableItem 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 +QCheckTableItem \- Checkboxes in QTables +.SH SYNOPSIS +\fC#include <ntqtable.h>\fR +.PP +Inherits QTableItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCheckTableItem\fR ( QTable * table, const QString & txt )" +.br +.ti -1c +.BI "virtual void \fBsetChecked\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisChecked\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QCheckTableItem class provides checkboxes in QTables. +.PP +A QCheckTableItem is a table item which looks and behaves like a checkbox. The advantage of using QCheckTableItems rather than real checkboxes is that a QCheckTableItem uses far less resources than a real checkbox would in a QTable. When the cell has the focus it displays a real checkbox which the user can interact with. When the cell does not have the focus the cell \fIlooks\fR like a checkbox. Pixmaps may not be used in QCheckTableItems. +.PP +QCheckTableItem items have the edit type WhenCurrent (see EditType). +.PP +To change the checkbox's label use setText(). The checkbox can be checked and unchecked with setChecked() and its state retrieved using isChecked(). +.PP +To populate a table cell with a QCheckTableItem use QTable::setItem(). +.PP +QCheckTableItems can be distinguished from QTableItems and QComboTableItems using their Run Time Type Identification (rtti) value. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also rtti(), EditType, QComboTableItem, QTableItem, QCheckBox, and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCheckTableItem::QCheckTableItem ( QTable * table, const QString & txt )" +Creates a QCheckTableItem with an EditType of WhenCurrent as a child of \fItable\fR. The checkbox is initially unchecked and its label is set to the string \fItxt\fR. +.SH "bool QCheckTableItem::isChecked () const" +Returns TRUE if the checkbox table item is checked; otherwise returns FALSE. +.PP +See also setChecked(). +.SH "int QCheckTableItem::rtti () const\fC [virtual]\fR" +Returns 2. +.PP +Make your derived classes return their own values for rtti()to distinguish between different table item subclasses. You should use values greater than 1000, preferably a large random number, to allow for extensions to this class. +.PP +See also QTableItem::rtti(). +.PP +Reimplemented from QTableItem. +.SH "void QCheckTableItem::setChecked ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE the checkbox is checked; if \fIb\fR is FALSE the checkbox is unchecked. +.PP +See also isChecked(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qchecktableitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqchecktableitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqchildevent.3qt b/doc/man/man3/tqchildevent.3qt new file mode 100644 index 000000000..96904643c --- /dev/null +++ b/doc/man/man3/tqchildevent.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QChildEvent 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 +QChildEvent \- Event parameters for child object events +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQChildEvent\fR ( Type type, QObject * child )" +.br +.ti -1c +.BI "QObject * \fBchild\fR () const" +.br +.ti -1c +.BI "bool \fBinserted\fR () const" +.br +.ti -1c +.BI "bool \fBremoved\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QChildEvent class contains event parameters for child object events. +.PP +Child events are sent to objects when children are inserted or removed. +.PP +A ChildRemoved event is sent immediately, but a ChildInserted event is \fIposted\fR (with QApplication::postEvent()). +.PP +Note that if a child is removed immediately after it is inserted, the ChildInserted event may be suppressed, but the ChildRemoved event will always be sent. In this case there will be a ChildRemoved event without a corresponding ChildInserted event. +.PP +The handler for these events is QObject::childEvent(). +.PP +See also Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QChildEvent::QChildEvent ( Type type, QObject * child )" +Constructs a child event object. The \fIchild\fR is the object that is to be removed or inserted. +.PP +The \fItype\fR parameter must be either QEvent::ChildInserted or QEvent::ChildRemoved. +.SH "QObject * QChildEvent::child () const" +Returns the child widget that was inserted or removed. +.SH "bool QChildEvent::inserted () const" +Returns TRUE if the widget received a new child; otherwise returns FALSE. +.SH "bool QChildEvent::removed () const" +Returns TRUE if the object lost a child; otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qchildevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqchildevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqclipboard.3qt b/doc/man/man3/tqclipboard.3qt new file mode 100644 index 000000000..c206f8afc --- /dev/null +++ b/doc/man/man3/tqclipboard.3qt @@ -0,0 +1,357 @@ +'\" t +.TH QClipboard 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 +QClipboard \- Access to the window system clipboard +.SH SYNOPSIS +\fC#include <ntqclipboard.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBMode\fR { Clipboard, Selection }" +.br +.ti -1c +.BI "void \fBclear\fR ( Mode mode )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "bool \fBsupportsSelection\fR () const" +.br +.ti -1c +.BI "bool \fBownsSelection\fR () const" +.br +.ti -1c +.BI "bool \fBownsClipboard\fR () const" +.br +.ti -1c +.BI "void setSelectionMode ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool selectionModeEnabled () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString \fBtext\fR ( Mode mode ) const" +.br +.ti -1c +.BI "QString \fBtext\fR ( QCString & subtype, Mode mode ) const" +.br +.ti -1c +.BI "void \fBsetText\fR ( const QString & text, Mode mode )" +.br +.ti -1c +.BI "QMimeSource * \fBdata\fR ( Mode mode ) const" +.br +.ti -1c +.BI "void \fBsetData\fR ( QMimeSource * src, Mode mode )" +.br +.ti -1c +.BI "QImage \fBimage\fR ( Mode mode ) const" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR ( Mode mode ) const" +.br +.ti -1c +.BI "void \fBsetImage\fR ( const QImage & image, Mode mode )" +.br +.ti -1c +.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap, Mode mode )" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "QString \fBtext\fR ( QCString & subtype ) const" +.br +.ti -1c +.BI "void \fBsetText\fR ( const QString & text )" +.br +.ti -1c +.BI "QMimeSource * \fBdata\fR () const" +.br +.ti -1c +.BI "void \fBsetData\fR ( QMimeSource * src )" +.br +.ti -1c +.BI "QImage \fBimage\fR () const" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR () const" +.br +.ti -1c +.BI "void \fBsetImage\fR ( const QImage & image )" +.br +.ti -1c +.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBselectionChanged\fR ()" +.br +.ti -1c +.BI "void \fBdataChanged\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QClipboard class provides access to the window system clipboard. +.PP +The clipboard offers a simple mechanism to copy and paste data between applications. +.PP +QClipboard supports the same data types that QDragObject does, and uses similar mechanisms. For advanced clipboard usage read the drag-and-drop documentation. +.PP +There is a single QClipboard object in an application, and you can access it using QApplication::clipboard(). +.PP +Example: +.PP +.nf +.br + QClipboard *cb = QApplication::clipboard(); +.br +.br + // Copy text from the clipboard (paste) +.br + QString text = cb->text(QClipboard::Clipboard); +.br + if ( !text.isNull() ) +.br + tqDebug( "The clipboard contains: " + text ); +.br +.br + // Copy text into the clipboard +.br + cb->setText( "This text can be pasted by other programs", +.br + QClipboard::Clipboard ); +.br +.fi +.PP +QClipboard features some convenience functions to access common data types: setText() allows the exchange of Unicode text and setPixmap() and setImage() allows the exchange of QPixmaps and QImages between applications. The setData() function is the ultimate in flexibility: it allows you to add any QMimeSource into the clipboard. There are corresponding getters for each of these, e.g. text(), image() and pixmap(). +.PP +You can clear the clipboard by calling clear(). +.SH "Platform Specific Information" +<h4> X11 </h4> +.IP +.TP +The X11 Window System has the concept of a separate selection and clipboard. When text is selected, it is immediately available as the global mouse selection. The global mouse selection may later be copied to the clipboard. By convention, the middle mouse button is used to paste the global mouse selection. +.IP +.TP +X11 also has the concept of ownership; if you change the selection within a window, X11 will only notify the owner and the previous owner of the change, i.e. it will not notify all applications that the selection or clipboard data changed. +.IP +.TP +Lastly, the X11 clipboard is event driven, i.e. the clipboard will not function properly if the event loop is not running. Similarly, it is recommended that the contents of the clipboard are stored or retrieved in direct response to user-input events, e.g. mouse button or key presses and releases. You should not store or retrieve the clipboard contents in response to timer or non-user-input events. +.IP +.PP +<h4> Windows </h4> +.IP +.TP +Microsoft Windows does not support the global mouse selection; it only supports the global clipboard, e.g. Windows only adds text to the clipboard when an explicit copy or cut is made. +.IP +.TP +Windows does not have the concept of ownership; the clipboard is a fully global resource so all applications are notified of changes. +.IP +.PP +See the multiclip example in the \fIQt Designer\fR examples directory for an example of a multiplatform clipboard application that also demonstrates selection handling. +.PP +See also Environment Classes and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QClipboard::Mode" + +.PP +This enum type is used to control which part of the system clipboard is used by QClipboard::data(), QClipboard::setData() and related functions. +.TP +\fCQClipboard::Clipboard\fR - indicates that data should be stored and retrieved from the global clipboard. +.TP +\fCQClipboard::Selection\fR - indicates that data should be stored and retrieved from the global mouse selection. +.PP +\fINote\fR: Support for Selection is provided only on systems with a global mouse selection (e.g. X11). +.PP +See also QClipboard::supportsSelection(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "void QClipboard::clear ( Mode mode )" +Clear the clipboard contents. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, this function clears the the global clipboard contents. If \fImode\fR is QClipboard::Selection, this function clears the global mouse selection contents. +.PP +See also QClipboard::Mode and supportsSelection(). +.SH "void QClipboard::clear ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::clear() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "QMimeSource * QClipboard::data ( Mode mode ) const" +Returns a reference to a QMimeSource representation of the current clipboard data. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the data is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the data is retrieved from the global mouse selection. +.PP +See also setData(). +.SH "QMimeSource * QClipboard::data () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::data() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "void QClipboard::dataChanged ()\fC [signal]\fR" +This signal is emitted when the clipboard data is changed. +.SH "QImage QClipboard::image ( Mode mode ) const" +Returns the clipboard image, or returns a null image if the clipboard does not contain an image or if it contains an image in an unsupported image format. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the image is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the image is retrieved from the global mouse selection. +.PP +See also setImage(), pixmap(), data(), and QImage::isNull(). +.SH "QImage QClipboard::image () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::image() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "bool QClipboard::ownsClipboard () const" +Returns TRUE if this clipboard object owns the clipboard data; otherwise returns FALSE. +.SH "bool QClipboard::ownsSelection () const" +Returns TRUE if this clipboard object owns the mouse selection data; otherwise returns FALSE. +.SH "QPixmap QClipboard::pixmap ( Mode mode ) const" +Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. Note that this can lose information. For example, if the image is 24-bit and the display is 8-bit, the result is converted to 8 bits, and if the image has an alpha channel, the result just has a mask. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the pixmap is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the pixmap is retrieved from the global mouse selection. +.PP +See also setPixmap(), image(), data(), and QPixmap::convertFromImage(). +.SH "QPixmap QClipboard::pixmap () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::pixmap() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "void QClipboard::selectionChanged ()\fC [signal]\fR" +This signal is emitted when the selection is changed. This only applies to windowing systems that support selections, e.g. X11. Windows doesn't support selections. +.SH "bool QClipboard::selectionModeEnabled () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use the QClipboard::data(), QClipboard::setData() and related functions which take a QClipboard::Mode argument. +.PP +Returns the selection mode. +.PP +See also setSelectionMode() and supportsSelection(). +.SH "void QClipboard::setData ( QMimeSource * src, Mode mode )" +Sets the clipboard data to \fIsrc\fR. Ownership of the data is transferred to the clipboard. If you want to remove the data either call clear() or call setData() again with new data. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the data is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the data is retrieved from the global mouse selection. +.PP +The QDragObject subclasses are reasonable objects to put into the clipboard (but do not try to call QDragObject::drag() on the same object). Any QDragObject placed in the clipboard should have a parent of 0. Do not put QDragMoveEvent or QDropEvent subclasses in the clipboard, as they do not belong to the event handler which receives them. +.PP +The setText(), setImage() and setPixmap() functions are simpler wrappers for setting text, image and pixmap data respectively. +.PP +See also data(). +.SH "void QClipboard::setData ( QMimeSource * src )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::setData() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "void QClipboard::setImage ( const QImage & image, Mode mode )" +Copies \fIimage\fR into the clipboard. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the image is stored in the global clipboard. If \fImode\fR is QClipboard::Selection, the data is stored in the global mouse selection. +.PP +This is shorthand for: +.PP +.nf +.br + setData( new QImageDrag(image), mode ) +.br +.fi +.PP +See also image(), setPixmap(), and setData(). +.SH "void QClipboard::setImage ( const QImage & image )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::setImage() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "void QClipboard::setPixmap ( const QPixmap & pixmap, Mode mode )" +Copies \fIpixmap\fR into the clipboard. Note that this is slower than setImage() because it needs to convert the QPixmap to a QImage first. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the pixmap is stored in the global clipboard. If \fImode\fR is QClipboard::Selection, the pixmap is stored in the global mouse selection. +.PP +See also pixmap(), setImage(), and setData(). +.SH "void QClipboard::setPixmap ( const QPixmap & pixmap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::setPixmap() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "void QClipboard::setSelectionMode ( bool enable )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use the QClipboard::data(), QClipboard::setData() and related functions which take a QClipboard::Mode argument. +.PP +Sets the clipboard selection mode. If \fIenable\fR is TRUE, then subsequent calls to QClipboard::setData() and other functions which put data into the clipboard will put the data into the mouse selection, otherwise the data will be put into the clipboard. +.PP +See also supportsSelection() and selectionModeEnabled(). +.SH "void QClipboard::setText ( const QString & text, Mode mode )" +Copies \fItext\fR into the clipboard as plain text. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the text is stored in the global clipboard. If \fImode\fR is QClipboard::Selection, the text is stored in the global mouse selection. +.PP +See also text() and setData(). +.PP +Example: regexptester/regexptester.cpp. +.SH "void QClipboard::setText ( const QString & text )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::setText() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "bool QClipboard::supportsSelection () const" +Returns TRUE if the clipboard supports mouse selection; otherwise returns FALSE. +.PP +Example: regexptester/regexptester.cpp. +.SH "QString QClipboard::text ( Mode mode ) const" +Returns the clipboard text as plain text, or a null string if the clipboard does not contain any text. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the text is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the text is retrieved from the global mouse selection. +.PP +See also setText(), data(), and QString::operator!(). +.SH "QString QClipboard::text ( QCString & subtype, Mode mode ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the clipboard text in subtype \fIsubtype\fR, or a null string if the clipboard does not contain any text. If \fIsubtype\fR is null, any subtype is acceptable, and \fIsubtype\fR is set to the chosen subtype. +.PP +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is QClipboard::Clipboard, the text is retrieved from the global clipboard. If \fImode\fR is QClipboard::Selection, the text is retrieved from the global mouse selection. +.PP +Common values for \fIsubtype\fR are "plain" and "html". +.PP +See also setText(), data(), and QString::operator!(). +.SH "QString QClipboard::text () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses the QClipboard::text() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard. +.SH "QString QClipboard::text ( QCString & subtype ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the clipboard text in subtype \fIsubtype\fR, or a null string +if the clipboard does not contain any text. This function uses the +QClipboard::text() function which takes a QClipboard::Mode +argument. The value of the mode argument is determined by the +return value of selectionModeEnabled(). If selectionModeEnabled() +returns TRUE, the mode argument is QClipboard::Selection, +otherwise the mode argument is QClipboard::Clipboard. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqclipboard.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqclipboard.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcloseevent.3qt b/doc/man/man3/tqcloseevent.3qt new file mode 100644 index 000000000..6836b74c8 --- /dev/null +++ b/doc/man/man3/tqcloseevent.3qt @@ -0,0 +1,110 @@ +'\" t +.TH QCloseEvent 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 +QCloseEvent \- Parameters that describe a close event +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCloseEvent\fR ()" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QCloseEvent class contains parameters that describe a close event. +.PP +Close events are sent to widgets that the user wants to close, usually by choosing "Close" from the window menu, or by clicking the `X' titlebar button. They are also sent when you call QWidget::close() to close a widget programmatically. +.PP +Close events contain a flag that indicates whether the receiver wants the widget to be closed or not. When a widget accepts the close event, it is hidden (and destroyed if it was created with the WDestructiveClose flag). If it refuses to accept the close event nothing happens. (Under X11 it is possible that the window manager will forcibly close the window; but at the time of writing we are not aware of any window manager that does this.) +.PP +The application's main widget -- QApplication::mainWidget() -- is a special case. When it accepts the close event, Qt leaves the main event loop and the application is immediately terminated (i.e. it returns from the call to QApplication::exec() in the main() function). +.PP +The event handler QWidget::closeEvent() receives close events. The default implementation of this event handler accepts the close event. If you do not want your widget to be hidden, or want some special handing, you should reimplement the event handler. +.PP +The closeEvent() in the Application Walkthrough shows a close event handler that asks whether to save a document before closing. +.PP +If you want the widget to be deleted when it is closed, create it with the WDestructiveClose widget flag. This is very useful for independent top-level windows in a multi-window application. +.PP +QObjects emits the destroyed() signal when they are deleted. +.PP +If the last top-level window is closed, the QApplication::lastWindowClosed() signal is emitted. +.PP +The isAccepted() function returns TRUE if the event's receiver has agreed to close the widget; call accept() to agree to close the widget and call ignore() if the receiver of this event does not want the widget to be closed. +.PP +See also QWidget::close(), QWidget::hide(), QObject::destroyed(), QApplication::setMainWidget(), QApplication::lastWindowClosed(), QApplication::exec(), QApplication::quit(), and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCloseEvent::QCloseEvent ()" +Constructs a close event object with the accept parameter flag set to FALSE. +.PP +See also accept(). +.SH "void QCloseEvent::accept ()" +Sets the accept flag of the close event object. +.PP +Setting the accept flag indicates that the receiver of this event agrees to close the widget. +.PP +The accept flag is \fInot\fR set by default. +.PP +If you choose to accept in QWidget::closeEvent(), the widget will be hidden. If the widget's WDestructiveClose flag is set, it will also be destroyed. +.PP +See also ignore() and QWidget::hide(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, mdi/application.cpp, popup/popup.cpp, and qwerty/qwerty.cpp. +.SH "void QCloseEvent::ignore ()" +Clears the accept flag of the close event object. +.PP +Clearing the accept flag indicates that the receiver of this event does not want the widget to be closed. +.PP +The close event is constructed with the accept flag cleared. +.PP +See also accept(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. +.SH "bool QCloseEvent::isAccepted () const" +Returns TRUE if the receiver of the event has agreed to close the widget; otherwise returns FALSE. +.PP +See also accept() and ignore(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcloseevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcloseevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcolor.3qt b/doc/man/man3/tqcolor.3qt new file mode 100644 index 000000000..041778daa --- /dev/null +++ b/doc/man/man3/tqcolor.3qt @@ -0,0 +1,592 @@ +'\" t +.TH QColor 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 +QColor \- Colors based on RGB or HSV values +.SH SYNOPSIS +\fC#include <ntqcolor.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBSpec\fR { Rgb, Hsv }" +.br +.ti -1c +.BI "\fBQColor\fR ()" +.br +.ti -1c +.BI "\fBQColor\fR ( int r, int g, int b )" +.br +.ti -1c +.BI "\fBQColor\fR ( int x, int y, int z, Spec colorSpec )" +.br +.ti -1c +.BI "\fBQColor\fR ( QRgb rgb, uint pixel = 0xffffffff )" +.br +.ti -1c +.BI "\fBQColor\fR ( const QString & name )" +.br +.ti -1c +.BI "\fBQColor\fR ( const char * name )" +.br +.ti -1c +.BI "\fBQColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "QColor & \fBoperator=\fR ( const QColor & c )" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "void \fBsetNamedColor\fR ( const QString & name )" +.br +.ti -1c +.BI "QRgb \fBrgb\fR () const" +.br +.ti -1c +.BI "void \fBsetRgb\fR ( int r, int g, int b )" +.br +.ti -1c +.BI "void \fBsetRgb\fR ( QRgb rgb )" +.br +.ti -1c +.BI "void \fBgetRgb\fR ( int * r, int * g, int * b ) const" +.br +.ti -1c +.BI "void rgb ( int * r, int * g, int * b ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBred\fR () const" +.br +.ti -1c +.BI "int \fBgreen\fR () const" +.br +.ti -1c +.BI "int \fBblue\fR () const" +.br +.ti -1c +.BI "void \fBsetHsv\fR ( int h, int s, int v )" +.br +.ti -1c +.BI "void \fBgetHsv\fR ( int * h, int * s, int * v ) const" +.br +.ti -1c +.BI "void hsv ( int * h, int * s, int * v ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void getHsv ( int & h, int & s, int & v ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QColor \fBlight\fR ( int factor = 150 ) const" +.br +.ti -1c +.BI "QColor \fBdark\fR ( int factor = 200 ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QColor & c ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QColor & c ) const" +.br +.ti -1c +.BI "uint \fBalloc\fR ()" +.br +.ti -1c +.BI "uint \fBpixel\fR () const" +.br +.ti -1c +.BI "uint \fBpixel\fR ( int screen ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "int \fBmaxColors\fR ()" +.br +.ti -1c +.BI "int \fBnumBitPlanes\fR ()" +.br +.ti -1c +.BI "int \fBenterAllocContext\fR ()" +.br +.ti -1c +.BI "void \fBleaveAllocContext\fR ()" +.br +.ti -1c +.BI "int \fBcurrentAllocContext\fR ()" +.br +.ti -1c +.BI "void \fBdestroyAllocContext\fR ( int context )" +.br +.ti -1c +.BI "void \fBinitialize\fR ()" +.br +.ti -1c +.BI "void \fBcleanup\fR ()" +.br +.ti -1c +.BI "QStringList \fBcolorNames\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QColor & c )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QColor & c )" +.br +.ti -1c +.BI "int \fBqRed\fR ( QRgb rgb )" +.br +.ti -1c +.BI "int \fBqGreen\fR ( QRgb rgb )" +.br +.ti -1c +.BI "int \fBqBlue\fR ( QRgb rgb )" +.br +.ti -1c +.BI "int \fBqAlpha\fR ( QRgb rgba )" +.br +.ti -1c +.BI "QRgb \fBqRgb\fR ( int r, int g, int b )" +.br +.ti -1c +.BI "QRgb \fBqRgba\fR ( int r, int g, int b, int a )" +.br +.ti -1c +.BI "int \fBqGray\fR ( int r, int g, int b )" +.br +.ti -1c +.BI "int \fBqGray\fR ( tqRgb rgb )" +.br +.in -1c +.SH DESCRIPTION +The QColor class provides colors based on RGB or HSV values. +.PP +A color is normally specified in terms of RGB (red, green and blue) components, but it is also possible to specify HSV (hue, saturation and value) or set a color name (the names are copied from from the X11 color database). +.PP +In addition to the RGB value, a QColor also has a pixel value and a validity. The pixel value is used by the underlying window system to refer to a color. It can be thought of as an index into the display hardware's color table. +.PP +The validity (isValid()) indicates whether the color is legal at all. For example, a RGB color with RGB values out of range is illegal. For performance reasons, QColor mostly disregards illegal colors. The result of using an invalid color is unspecified and will usually be surprising. +.PP +There are 19 predefined QColor objects: \fCwhite\fR, \fCblack\fR, \fCred\fR, \fCdarkRed\fR, \fCgreen\fR, \fCdarkGreen\fR, \fCblue\fR, \fCdarkBlue\fR, \fCcyan\fR, \fCdarkCyan\fR, \fCmagenta\fR, \fCdarkMagenta\fR, \fCyellow\fR, \fCdarkYellow\fR, \fCgray\fR, \fCdarkGray\fR, \fClightGray\fR, \fCcolor0\fR and \fCcolor1\fR, accessible as members of the Qt namespace (ie. \fCQt::red\fR). +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The colors \fCcolor0\fR (zero pixel value) and \fCcolor1\fR (non-zero pixel value) are special colors for drawing in bitmaps. Painting with \fCcolor0\fR sets the bitmap bits to 0 (transparent, i.e. background), and painting with \fCcolor1\fR sets the bits to 1 (opaque, i.e. foreground). +.PP +The QColor class has an efficient, dynamic color allocation strategy. A color is normally allocated the first time it is used (lazy allocation), that is, whenever the pixel() function is called. The following steps are taken to allocate a color. If, at any point, a suitable color is found then the appropriate pixel value is returned and the subsequent steps are not taken: +.PP +<ol type=1> +.IP 1 +Is the pixel value valid? If it is, just return it; otherwise, allocate a pixel value. +.IP 2 +Check an internal hash table to see if we allocated an equal RGB value earlier. If we did, set the corresponding pixel value for the color and return it. +.IP 3 +Try to allocate the RGB value. If we succeed, we get a pixel value that we save in the internal table with the RGB value. Return the pixel value. +.IP 4 +The color could not be allocated. Find the closest matching color, save it in the internal table, and return it. +.PP +A color can be set by passing setNamedColor() an RGB string like" #112233", or a color name, e.g. "blue". The names are taken from X11's rgb.txt database but can also be used under Windows. To get a lighter or darker color use light() and dark() respectively. Colors can also be set using setRgb() and setHsv(). The color components can be accessed in one go with rgb() and hsv(), or individually with red(), green() and blue(). +.PP +Use maxColors() and numBitPlanes() to determine the maximum number of colors and the number of bit planes supported by the underlying window system, +.PP +If you need to allocate many colors temporarily, for example in an image viewer application, enterAllocContext(), leaveAllocContext() and destroyAllocContext() will prove useful. +.SH "HSV Colors" +Because many people don't know the HSV color model very well, we'll cover it briefly here. +.PP +The RGB model is hardware-oriented. Its representation is close to what most monitors show. In contrast, HSV represents color in a way more suited to the human perception of color. For example, the relationships "stronger than", "darker than" and "the opposite of" are easily expressed in HSV but are much harder to express in RGB. +.PP +HSV, like RGB, has three components: +.IP +.TP +H, for hue, is either 0-359 if the color is chromatic (not gray), or meaningless if it is gray. It represents degrees on the color wheel familiar to most people. Red is 0 (degrees), green is 120 and blue is 240. +.IP +.TP +S, for saturation, is 0-255, and the bigger it is, the stronger the color is. Grayish colors have saturation near 0; very strong colors have saturation near 255. +.IP +.TP +V, for value, is 0-255 and represents lightness or brightness of the color. 0 is black; 255 is as far from black as possible. +.IP +.PP +Here are some examples: Pure red is H=0, S=255, V=255. A dark red, moving slightly towards the magenta, could be H=350 (equivalent to -10), S=255, V=180. A grayish light red could have H about 0 (say 350-359 or 0-10), S about 50-100, and S=255. +.PP +Qt returns a hue value of -1 for achromatic colors. If you pass a too-big hue value, Qt forces it into range. Hue 360 or 720 is treated as 0; hue 540 is treated as 180. +.PP +See also QPalette, QColorGroup, QApplication::setColorSpec(), Color FAQ, Widget Appearance and Style, Graphics Classes, and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QColor::Spec" +The type of color specified, either RGB or HSV, e.g. in the \fCQColor::QColor( x, y, z, colorSpec)\fR constructor. +.TP +\fCQColor::Rgb\fR +.TP +\fCQColor::Hsv\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QColor::QColor ()" +Constructs an invalid color with the RGB value (0, 0, 0). An invalid color is a color that is not properly set up for the underlying window system. +.PP +The alpha value of an invalid color is unspecified. +.PP +See also isValid(). +.SH "QColor::QColor ( int r, int g, int b )" +Constructs a color with the RGB value \fIr\fR, \fIg\fR, \fIb\fR, in the same way as setRgb(). +.PP +The color is left invalid if any or the arguments are illegal. +.PP +See also setRgb(). +.SH "QColor::QColor ( int x, int y, int z, Spec colorSpec )" +Constructs a color with the RGB or HSV value \fIx\fR, \fIy\fR, \fIz\fR. +.PP +The arguments are an RGB value if \fIcolorSpec\fR is QColor::Rgb. \fIx\fR (red), \fIy\fR (green), and \fIz\fR (blue). All of them must be in the range 0-255. +.PP +The arguments are an HSV value if \fIcolorSpec\fR is QColor::Hsv. \fIx\fR (hue) must be -1 for achromatic colors and 0-359 for chromatic colors; \fIy\fR (saturation) and \fIz\fR (value) must both be in the range 0-255. +.PP +See also setRgb() and setHsv(). +.SH "QColor::QColor ( QRgb rgb, uint pixel = 0xffffffff )" +Constructs a color with the RGB value \fIrgb\fR and a custom pixel value \fIpixel\fR. +.PP +If \fIpixel\fR == 0xffffffff (the default), then the color uses the RGB value in a standard way. If \fIpixel\fR is something else, then the pixel value is set directly to \fIpixel\fR, skipping the normal allocation procedure. +.SH "QColor::QColor ( const QString & name )" +Constructs a named color in the same way as setNamedColor() using name \fIname\fR. +.PP +The color is left invalid if \fIname\fR cannot be parsed. +.PP +See also setNamedColor(). +.SH "QColor::QColor ( const char * name )" +Constructs a named color in the same way as setNamedColor() using name \fIname\fR. +.PP +The color is left invalid if \fIname\fR cannot be parsed. +.PP +See also setNamedColor(). +.SH "QColor::QColor ( const QColor & c )" +Constructs a color that is a copy of \fIc\fR. +.SH "uint QColor::alloc ()" +Allocates the RGB color and returns the pixel value. +.PP +Allocating a color means to obtain a pixel value from the RGB specification. The pixel value is an index into the global color table, but should be considered an arbitrary platform-dependent value. +.PP +The pixel() function calls alloc() if necessary, so in general you don't need to call this function. +.PP +See also enterAllocContext(). +.SH "int QColor::blue () const" +Returns the B (blue) component of the RGB value. +.SH "void QColor::cleanup ()\fC [static]\fR" +Internal clean up required for QColor. This function is called from the QApplication destructor. +.PP +See also initialize(). +.SH "QStringList QColor::colorNames ()\fC [static]\fR" +Returns a QStringList containing the color names Qt knows about. +.SH "int QColor::currentAllocContext ()\fC [static]\fR" +Returns the current color allocation context. +.PP +The default context is 0. +.PP +See also enterAllocContext() and leaveAllocContext(). +.SH "QColor QColor::dark ( int factor = 200 ) const" +Returns a darker (or lighter) color, but does not change this object. +.PP +Returns a darker color if \fIfactor\fR is greater than 100. Setting \fIfactor\fR to 300 returns a color that has one-third the brightness. +.PP +Returns a lighter color if \fIfactor\fR is less than 100. We recommend using lighter() for this purpose. If \fIfactor\fR is 0 or negative, the return value is unspecified. +.PP +(This function converts the current RGB color to HSV, divides V by \fIfactor\fR and converts back to RGB.) +.PP +See also light(). +.PP +Examples: +.)l desktop/desktop.cpp and themes/wood.cpp. +.SH "void QColor::destroyAllocContext ( int context )\fC [static]\fR" +Destroys a color allocation context, \fIcontext\fR. +.PP +This function deallocates all colors that were allocated in the specified \fIcontext\fR. If \fIcontext\fR == -1, it frees up all colors that the application has allocated. If \fIcontext\fR == -2, it frees up all colors that the application has allocated, except those in the default context. +.PP +The function does nothing for true color displays. +.PP +See also enterAllocContext() and alloc(). +.PP +Example: showimg/showimg.cpp. +.SH "int QColor::enterAllocContext ()\fC [static]\fR" +Enters a color allocation context and returns a non-zero unique identifier. +.PP +Color allocation contexts are useful for programs that need to allocate many colors and throw them away later, like image viewers. The allocation context functions work for true color displays as well as for colormap displays, except that QColor::destroyAllocContext() does nothing for true color. +.PP +Example: +.PP +.nf +.br + QPixmap loadPixmap( QString fileName ) +.br + { +.br + static int alloc_context = 0; +.br + if ( alloc_context ) +.br + QColor::destroyAllocContext( alloc_context ); +.br + alloc_context = QColor::enterAllocContext(); +.br + QPixmap pm( fileName ); +.br + QColor::leaveAllocContext(); +.br + return pm; +.br + } +.br +.fi +.PP +The example code loads a pixmap from file. It frees up all colors that were allocated the last time loadPixmap() was called. +.PP +The initial/default context is 0. Qt keeps a list of colors associated with their allocation contexts. You can call destroyAllocContext() to get rid of all colors that were allocated in a specific context. +.PP +Calling enterAllocContext() enters an allocation context. The allocation context lasts until you call leaveAllocContext(). QColor has an internal stack of allocation contexts. Each call to enterAllocContex() must have a corresponding leaveAllocContext(). +.PP +.nf +.br + // context 0 active +.br + int c1 = QColor::enterAllocContext(); // enter context c1 +.br + // context c1 active +.br + int c2 = QColor::enterAllocContext(); // enter context c2 +.br + // context c2 active +.br + QColor::leaveAllocContext(); // leave context c2 +.br + // context c1 active +.br + QColor::leaveAllocContext(); // leave context c1 +.br + // context 0 active +.br + // Now, free all colors that were allocated in context c2 +.br + QColor::destroyAllocContext( c2 ); +.br +.fi +.PP +You may also want to set the application's color specification. See QApplication::setColorSpec() for more information. +.PP +See also leaveAllocContext(), currentAllocContext(), destroyAllocContext(), and QApplication::setColorSpec(). +.PP +Example: showimg/showimg.cpp. +.SH "void QColor::getHsv ( int * h, int * s, int * v ) const" +Returns the current RGB value as HSV. The contents of the \fIh\fR, \fIs\fR and \fIv\fR pointers are set to the HSV values. If any of the three pointers are null, the function does nothing. +.PP +The hue (which \fIh\fR points to) is set to -1 if the color is achromatic. +.PP +\fBWarning:\fR Colors are stored internally as RGB values, so getHSv() may return slightly different values to those set by setHsv(). +.PP +See also setHsv() and rgb(). +.SH "void QColor::getHsv ( int & h, int & s, int & v ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QColor::getRgb ( int * r, int * g, int * b ) const" +Sets the contents pointed to by \fIr\fR, \fIg\fR and \fIb\fR to the red, green and blue components of the RGB value respectively. The value range for a component is 0..255. +.PP +See also rgb(), setRgb(), and getHsv(). +.SH "int QColor::green () const" +Returns the G (green) component of the RGB value. +.SH "void QColor::hsv ( int * h, int * s, int * v ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use getHsv() instead. +.PP +Example: themes/metal.cpp. +.SH "void QColor::initialize ()\fC [static]\fR" +Internal initialization required for QColor. This function is called from the QApplication constructor. +.PP +See also cleanup(). +.SH "bool QColor::isValid () const" +Returns FALSE if the color is invalid, i.e. it was constructed using the default constructor; otherwise returns TRUE. +.PP +Examples: +.)l chart/element.cpp, chart/setdataform.cpp, and scribble/scribble.cpp. +.SH "void QColor::leaveAllocContext ()\fC [static]\fR" +Leaves a color allocation context. +.PP +See enterAllocContext() for a detailed explanation. +.PP +See also enterAllocContext() and currentAllocContext(). +.PP +Example: showimg/showimg.cpp. +.SH "QColor QColor::light ( int factor = 150 ) const" +Returns a lighter (or darker) color, but does not change this object. +.PP +Returns a lighter color if \fIfactor\fR is greater than 100. Setting \fIfactor\fR to 150 returns a color that is 50% brighter. +.PP +Returns a darker color if \fIfactor\fR is less than 100. We recommend using dark() for this purpose. If \fIfactor\fR is 0 or negative, the return value is unspecified. +.PP +(This function converts the current RGB color to HSV, multiplies V by \fIfactor\fR, and converts the result back to RGB.) +.PP +See also dark(). +.PP +Examples: +.)l desktop/desktop.cpp and themes/wood.cpp. +.SH "int QColor::maxColors ()\fC [static]\fR" +Returns the maximum number of colors supported by the underlying window system if the window system uses a palette. +.PP +Otherwise returns -1. Use numBitPlanes() to calculate the available colors in that case. +.SH "QString QColor::name () const" +Returns the name of the color in the format "#RRGGBB", i.e. a "#" character followed by three two-digit hexadecimal numbers. +.PP +See also setNamedColor(). +.PP +Example: chart/setdataform.cpp. +.SH "int QColor::numBitPlanes ()\fC [static]\fR" +Returns the number of color bit planes for the underlying window system. +.PP +The returned value is equal to the default pixmap depth. +.PP +See also QPixmap::defaultDepth(). +.SH "bool QColor::operator!= ( const QColor & c ) const" +Returns TRUE if this color has a different RGB value from \fIc\fR; otherwise returns FALSE. +.SH "QColor & QColor::operator= ( const QColor & c )" +Assigns a copy of the color \fIc\fR and returns a reference to this color. +.SH "bool QColor::operator== ( const QColor & c ) const" +Returns TRUE if this color has the same RGB value as \fIc\fR; otherwise returns FALSE. +.SH "uint QColor::pixel () const" +Returns the pixel value. +.PP +This value is used by the underlying window system to refer to a color. It can be thought of as an index into the display hardware's color table, but the value is an arbitrary 32-bit value. +.PP +See also alloc(). +.SH "uint QColor::pixel ( int screen ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the pixel value for screen \fIscreen\fR. +.PP +This value is used by the underlying window system to refer to a color. It can be thought of as an index into the display hardware's color table, but the value is an arbitrary 32-bit value. +.PP +See also alloc(). +.SH "int QColor::red () const" +Returns the R (red) component of the RGB value. +.SH "QRgb QColor::rgb () const" +Returns the RGB value. +.PP +The return type \fIQRgb\fR is equivalent to \fCunsigned\fR \fCint\fR. +.PP +For an invalid color, the alpha value of the returned color is unspecified. +.PP +See also setRgb(), hsv(), tqRed(), tqBlue(), tqGreen(), and isValid(). +.SH "void QColor::rgb ( int * r, int * g, int * b ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use getRgb() instead +.SH "void QColor::setHsv ( int h, int s, int v )" +Sets a HSV color value. \fIh\fR is the hue, \fIs\fR is the saturation and \fIv\fR is the value of the HSV color. +.PP +If \fIs\fR or \fIv\fR are not in the range 0-255, or \fIh\fR is < -1, the color is not changed. +.PP +\fBWarning:\fR Colors are stored internally as RGB values, so getHSv() may return slightly different values to those set by setHsv(). +.PP +See also hsv() and setRgb(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp, grapher/grapher.cpp, and progress/progress.cpp. +.SH "void QColor::setNamedColor ( const QString & name )" +Sets the RGB value to \fIname\fR, which may be in one of these formats: +.TP +#RGB (each of R, G and B is a single hex digit) +.TP +#RRGGBB +.TP +#RRRGGGBBB +.TP +#RRRRGGGGBBBB +.TP +A name from the X color database (rgb.txt) (e.g." steelblue" or "gainsboro"). These color names also work under Windows. +.PP +The color is invalid if \fIname\fR cannot be parsed. +.SH "void QColor::setRgb ( int r, int g, int b )" +Sets the RGB value to \fIr\fR, \fIg\fR, \fIb\fR. The arguments, \fIr\fR, \fIg\fR and \fIb\fR must all be in the range 0..255. If any of them are outside the legal range, the color is not changed. +.PP +See also rgb() and setHsv(). +.SH "void QColor::setRgb ( QRgb rgb )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the RGB value to \fIrgb\fR. +.PP +The type \fIQRgb\fR is equivalent to \fCunsigned\fR \fCint\fR. +.PP +See also rgb() and setHsv(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QColor & c )" +Writes a color object, \fIc\fR to the stream, \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QColor & c )" +Reads a color object, \fIc\fR, from the stream, \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "int tqAlpha ( QRgb rgba )" +Returns the alpha component of the RGBA quadruplet \fIrgba\fR. +.SH "int tqBlue ( QRgb rgb )" +Returns the blue component of the RGB triplet \fIrgb\fR. +.PP +See also tqRgb() and QColor::blue(). +.SH "int tqGray ( int r, int g, int b )" +Returns a gray value 0..255 from the (\fIr\fR, \fIg\fR, \fIb\fR) triplet. +.PP +The gray value is calculated using the formula (r*11 + g*16 + b*5)/32. +.SH "int tqGray ( tqRgb rgb )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a gray value 0..255 from the given \fIrgb\fR colour. +.SH "int tqGreen ( QRgb rgb )" +Returns the green component of the RGB triplet \fIrgb\fR. +.PP +See also tqRgb() and QColor::green(). +.SH "int tqRed ( QRgb rgb )" +Returns the red component of the RGB triplet \fIrgb\fR. +.PP +See also tqRgb() and QColor::red(). +.SH "QRgb tqRgb ( int r, int g, int b )" +Returns the RGB triplet \fI(r,g,b)\fR. +.PP +The return type QRgb is equivalent to \fCunsigned\fR \fCint\fR. +.PP +See also tqRgba(), tqRed(), tqGreen(), and tqBlue(). +.SH "QRgb tqRgba ( int r, int g, int b, int a )" +Returns the RGBA quadruplet \fI(r,g,b,a)\fR. +.PP +The return type QRgba is equivalent to \fCunsigned\fR \fCint\fR. +.PP +See also tqRgb(), tqRed(), tqGreen(), and tqBlue(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcolor.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcolor.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcolordialog.3qt b/doc/man/man3/tqcolordialog.3qt new file mode 100644 index 000000000..e5ff5b283 --- /dev/null +++ b/doc/man/man3/tqcolordialog.3qt @@ -0,0 +1,80 @@ +'\" t +.TH QColorDialog 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 +QColorDialog \- Dialog widget for specifying colors +.SH SYNOPSIS +\fC#include <ntqcolordialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Static Public Members" +<li class=fn>QColor \fBgetColor\fR ( const QColor & initial = white, QWidget * parent = 0, const char * name = 0 ) <li class=fn>QRgb \fBgetRgba\fR ( QRgb initial, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) <li class=fn>int \fBcustomCount\fR () <li class=fn>QRgb \fBcustomColor\fR ( int i ) <li class=fn>void \fBsetCustomColor\fR ( int i, QRgb c ) <li class=fn>void \fBsetStandardColor\fR ( int i, QRgb c ) +.SH DESCRIPTION +The QColorDialog class provides a dialog widget for specifying colors. +.PP +The color dialog's function is to allow users to choose colors. For example, you might use this in a drawing program to allow the user to set the brush color. +.PP +The static functions provide modal color dialogs. +.PP +The static getColor() function shows the dialog and allows the user to specify a color. The getRgba() function does the same but also allows the user to specify a color with an alpha channel (transparency) value. +.PP +The user can store customCount() different custom colors. The custom colors are shared by all color dialogs, and remembered during the execution of the program. Use setCustomColor() to set the custom colors, and use customColor() to get them. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also Dialog Classes and Graphics Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRgb QColorDialog::customColor ( int i )\fC [static]\fR" +Returns custom color number \fIi\fR as a QRgb. +.SH "int QColorDialog::customCount ()\fC [static]\fR" +Returns the number of custom colors supported by QColorDialog. All color dialogs share the same custom colors. +.SH "QColor QColorDialog::getColor ( const QColor & initial = white, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Pops up a modal color dialog, lets the user choose a color, and returns that color. The color is initially set to \fIinitial\fR. The dialog is a child of \fIparent\fR and is called \fIname\fR. It returns an invalid (see QColor::isValid()) color if the user cancels the dialog. All colors allocated by the dialog will be deallocated before this function returns. +.PP +Examples: +.)l chart/setdataform.cpp and scribble/scribble.cpp. +.SH "QRgb QColorDialog::getRgba ( QRgb initial, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Pops up a modal color dialog to allow the user to choose a color and an alpha channel (transparency) value. The color+alpha is initially set to \fIinitial\fR. The dialog is a child of \fIparent\fR and called \fIname\fR. +.PP +If \fIok\fR is non-null, \fI*\fR\fIok\fR is set to TRUE if the user clicked OK, and to FALSE if the user clicked Cancel. +.PP +If the user clicks Cancel, the \fIinitial\fR value is returned. +.SH "void QColorDialog::setCustomColor ( int i, QRgb c )\fC [static]\fR" +Sets custom color number \fIi\fR to the QRgb value \fIc\fR. +.SH "void QColorDialog::setStandardColor ( int i, QRgb c )\fC [static]\fR" +Sets standard color number \fIi\fR to the QRgb value \fIc\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcolordialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcolordialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcolordrag.3qt b/doc/man/man3/tqcolordrag.3qt new file mode 100644 index 000000000..b9ca18dfe --- /dev/null +++ b/doc/man/man3/tqcolordrag.3qt @@ -0,0 +1,82 @@ +'\" t +.TH QColorDrag 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 +QColorDrag \- Drag and drop object for transferring colors +.SH SYNOPSIS +\fC#include <ntqdragobject.h>\fR +.PP +Inherits QStoredDrag. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQColorDrag\fR ( const QColor & col, QWidget * dragsource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQColorDrag\fR ( QWidget * dragsource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "void \fBsetColor\fR ( const QColor & col )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBcanDecode\fR ( QMimeSource * e )" +.br +.ti -1c +.BI "bool \fBdecode\fR ( QMimeSource * e, QColor & col )" +.br +.in -1c +.SH DESCRIPTION +The QColorDrag class provides a drag and drop object for transferring colors. +.PP +This class provides a drag object which can be used to transfer data about colors for drag and drop and in the clipboard. For example, it is used in QColorDialog. +.PP +The color is set in the constructor but can be changed with setColor(). +.PP +For more information about drag and drop, see the QDragObject class and the drag and drop documentation. +.PP +See also Drag And Drop Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QColorDrag::QColorDrag ( const QColor & col, QWidget * dragsource = 0, const char * name = 0 )" +Constructs a color drag object with the color \fIcol\fR. Passes \fIdragsource\fR and \fIname\fR to the QStoredDrag constructor. +.SH "QColorDrag::QColorDrag ( QWidget * dragsource = 0, const char * name = 0 )" +Constructs a color drag object with a white color. Passes \fIdragsource\fR and \fIname\fR to the QStoredDrag constructor. +.SH "bool QColorDrag::canDecode ( QMimeSource * e )\fC [static]\fR" +Returns TRUE if the color drag object can decode the mime source \fIe\fR; otherwise returns FALSE. +.SH "bool QColorDrag::decode ( QMimeSource * e, QColor & col )\fC [static]\fR" +Decodes the mime source \fIe\fR and sets the decoded values to \fIcol\fR. +.SH "void QColorDrag::setColor ( const QColor & col )" +Sets the color of the color drag to \fIcol\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcolordrag.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcolordrag.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcolorgroup.3qt b/doc/man/man3/tqcolorgroup.3qt new file mode 100644 index 000000000..6607ba7e8 --- /dev/null +++ b/doc/man/man3/tqcolorgroup.3qt @@ -0,0 +1,358 @@ +'\" t +.TH QColorGroup 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 +QColorGroup \- Group of widget colors +.SH SYNOPSIS +\fC#include <ntqpalette.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQColorGroup\fR ()" +.br +.ti -1c +.BI "QColorGroup ( const QColor & foreground, const QColor & background, const QColor & light, const QColor & dark, const QColor & mid, const QColor & text, const QColor & base ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "\fBQColorGroup\fR ( const QBrush & foreground, const QBrush & button, const QBrush & light, const QBrush & dark, const QBrush & mid, const QBrush & text, const QBrush & bright_text, const QBrush & base, const QBrush & background )" +.br +.ti -1c +.BI "\fBQColorGroup\fR ( const QColorGroup & other )" +.br +.ti -1c +.BI "\fB~QColorGroup\fR ()" +.br +.ti -1c +.BI "QColorGroup & \fBoperator=\fR ( const QColorGroup & other )" +.br +.ti -1c +.BI "enum \fBColorRole\fR { Foreground, Button, Light, Midlight, Dark, Mid, Text, BrightText, ButtonText, Base, Background, Shadow, Highlight, HighlightedText, Link, LinkVisited, NColorRoles }" +.br +.ti -1c +.BI "const QColor & \fBcolor\fR ( ColorRole r ) const" +.br +.ti -1c +.BI "const QBrush & \fBbrush\fR ( ColorRole r ) const" +.br +.ti -1c +.BI "void \fBsetColor\fR ( ColorRole r, const QColor & c )" +.br +.ti -1c +.BI "void \fBsetBrush\fR ( ColorRole r, const QBrush & b )" +.br +.ti -1c +.BI "const QColor & \fBforeground\fR () const" +.br +.ti -1c +.BI "const QColor & \fBbutton\fR () const" +.br +.ti -1c +.BI "const QColor & \fBlight\fR () const" +.br +.ti -1c +.BI "const QColor & \fBdark\fR () const" +.br +.ti -1c +.BI "const QColor & \fBmid\fR () const" +.br +.ti -1c +.BI "const QColor & \fBtext\fR () const" +.br +.ti -1c +.BI "const QColor & \fBbase\fR () const" +.br +.ti -1c +.BI "const QColor & \fBbackground\fR () const" +.br +.ti -1c +.BI "const QColor & \fBmidlight\fR () const" +.br +.ti -1c +.BI "const QColor & \fBbrightText\fR () const" +.br +.ti -1c +.BI "const QColor & \fBbuttonText\fR () const" +.br +.ti -1c +.BI "const QColor & \fBshadow\fR () const" +.br +.ti -1c +.BI "const QColor & \fBhighlight\fR () const" +.br +.ti -1c +.BI "const QColor & \fBhighlightedText\fR () const" +.br +.ti -1c +.BI "const QColor & \fBlink\fR () const" +.br +.ti -1c +.BI "const QColor & \fBlinkVisited\fR () const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QColorGroup & g ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QColorGroup & g ) const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QColorGroup & g )" +.br +.in -1c +.SH DESCRIPTION +The QColorGroup class contains a group of widget colors. +.PP +A color group contains a group of colors used by widgets for drawing themselves. We recommend that widgets use color group roles such as "foreground" and "base" rather than literal colors like "red" or "turquoise". The color roles are enumerated and defined in the ColorRole documentation. +.PP +The most common use of QColorGroup is like this: +.PP +.nf +.br + QPainter p; +.br + ... +.br + p.setPen( colorGroup().foreground() ); +.br + p.drawLine( ... ) +.br +.fi +.PP +It is also possible to modify color groups or create new color groups from scratch. +.PP +The color group class can be created using three different constructors or by modifying one supplied by Qt. The default constructor creates an all-black color group, which can then be modified using set functions; there's also a constructor for specifying all the color group colors. And there is also a copy constructor. +.PP +We strongly recommend using a system-supplied color group and modifying that as necessary. +.PP +You modify a color group by calling the access functions setColor() and setBrush(), depending on whether you want a pure color or a pixmap pattern. +.PP +There are also corresponding color() and brush() getters, and a commonly used convenience function to get each ColorRole: background(), foreground(), base(), etc. +.PP +See also QColor, QPalette, QWidget::colorGroup, Widget Appearance and Style, Graphics Classes, and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QColorGroup::ColorRole" +The ColorRole enum defines the different symbolic color roles used in current GUIs. +.PP +The central roles are: +.TP +\fCQColorGroup::Background\fR - general background color. +.TP +\fCQColorGroup::Foreground\fR - general foreground color. +.TP +\fCQColorGroup::Base\fR - used as background color for text entry widgets, for example; usually white or another light color. +.TP +\fCQColorGroup::Text\fR - the foreground color used with Base. Usually this is the same as the Foreground, in which case it must provide good contrast with Background and Base. +.TP +\fCQColorGroup::Button\fR - general button background color in which buttons need a background different from Background, as in the Macintosh style. +.TP +\fCQColorGroup::ButtonText\fR - a foreground color used with the Button color. +.PP +There are some color roles used mostly for 3D bevel and shadow effects: +.TP +\fCQColorGroup::Light\fR - lighter than Button color. +.TP +\fCQColorGroup::Midlight\fR - between Button and Light. +.TP +\fCQColorGroup::Dark\fR - darker than Button. +.TP +\fCQColorGroup::Mid\fR - between Button and Dark. +.TP +\fCQColorGroup::Shadow\fR - a very dark color. By default, the shadow color is \fCQt::black\fR. +.PP +All of these are normally derived from Background and used in ways that depend on that relationship. For example, buttons depend on it to make the bevels look attractive, and Motif scroll bars depend on Mid to be slightly different from Background. +.PP +Selected (marked) items have two roles: +.TP +\fCQColorGroup::Highlight\fR - a color to indicate a selected item or the current item. By default, the highlight color is \fCQt::darkBlue\fR. +.TP +\fCQColorGroup::HighlightedText\fR - a text color that contrasts with Highlight. By default, the highlighted text color is \fCQt::white\fR. +.PP +Finally, there is a special role for text that needs to be drawn where Text or Foreground would give poor contrast, such as on pressed push buttons: +.TP +\fCQColorGroup::BrightText\fR - a text color that is very different from Foreground and contrasts well with e.g. Dark. +.TP +\fCQColorGroup::Link\fR - a text color used for unvisited hyperlinks. By default, the link color is \fCQt::blue\fR. +.TP +\fCQColorGroup::LinkVisited\fR - a text color used for already visited hyperlinks. By default, the linkvisited color is \fCQt::magenta\fR. +.TP +\fCQColorGroup::NColorRoles\fR - Internal. +.PP +Note that text colors can be used for things other than just words; text colors are \fIusually\fR used for text, but it's quite common to use the text color roles for lines, icons, etc. +.PP +This image shows most of the color roles in use: <center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QColorGroup::QColorGroup ()" +Constructs a color group with all colors set to black. +.SH "QColorGroup::QColorGroup ( const QColor & foreground, const QColor & background, const QColor & light, const QColor & dark, const QColor & mid, const QColor & text, const QColor & base )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Constructs a color group with the specified colors. The button color will be set to the background color. +.SH "QColorGroup::QColorGroup ( const QBrush & foreground, const QBrush & button, const QBrush & light, const QBrush & dark, const QBrush & mid, const QBrush & text, const QBrush & bright_text, const QBrush & base, const QBrush & background )" +Constructs a color group. You can pass either brushes, pixmaps or plain colors for \fIforeground\fR, \fIbutton\fR, \fIlight\fR, \fIdark\fR, \fImid\fR, \fItext\fR, \fIbright_text\fR, \fIbase\fR and \fIbackground\fR. +.PP +See also QBrush. +.SH "QColorGroup::QColorGroup ( const QColorGroup & other )" +Constructs a color group that is an independent copy of \fIother\fR. +.SH "QColorGroup::~QColorGroup ()" +Destroys the color group. +.SH "const QColor & QColorGroup::background () const" +Returns the background color of the color group. +.PP +See also ColorRole. +.SH "const QColor & QColorGroup::base () const" +Returns the base color of the color group. +.PP +See also ColorRole. +.SH "const QColor & QColorGroup::brightText () const" +Returns the bright text foreground color of the color group. +.PP +See also ColorRole. +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QBrush & QColorGroup::brush ( ColorRole r ) const" +Returns the brush that has been set for color role \fIr\fR. +.PP +See also color(), setBrush(), and ColorRole. +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QColor & QColorGroup::button () const" +Returns the button color of the color group. +.PP +See also ColorRole. +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QColor & QColorGroup::buttonText () const" +Returns the button text foreground color of the color group. +.PP +See also ColorRole. +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QColor & QColorGroup::color ( ColorRole r ) const" +Returns the color that has been set for color role \fIr\fR. +.PP +See also brush() and ColorRole. +.SH "const QColor & QColorGroup::dark () const" +Returns the dark color of the color group. +.PP +See also ColorRole. +.PP +Example: themes/wood.cpp. +.SH "const QColor & QColorGroup::foreground () const" +Returns the foreground color of the color group. +.PP +See also ColorRole. +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QColor & QColorGroup::highlight () const" +Returns the highlight color of the color group. +.PP +See also ColorRole. +.SH "const QColor & QColorGroup::highlightedText () const" +Returns the highlighted text color of the color group. +.PP +See also ColorRole. +.SH "const QColor & QColorGroup::light () const" +Returns the light color of the color group. +.PP +See also ColorRole. +.PP +Example: themes/wood.cpp. +.SH "const QColor & QColorGroup::link () const" +Returns the unvisited link text color of the color group. +.PP +See also ColorRole. +.SH "const QColor & QColorGroup::linkVisited () const" +Returns the visited link text color of the color group. +.PP +See also ColorRole. +.SH "const QColor & QColorGroup::mid () const" +Returns the mid color of the color group. +.PP +See also ColorRole. +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QColor & QColorGroup::midlight () const" +Returns the midlight color of the color group. +.PP +See also ColorRole. +.SH "bool QColorGroup::operator!= ( const QColorGroup & g ) const" +Returns TRUE if this color group is different from \fIg\fR; otherwise returns FALSE. +.PP +See also +.SH "QColorGroup & QColorGroup::operator= ( const QColorGroup & other )" +Copies the colors of \fIother\fR to this color group. +.SH "bool QColorGroup::operator== ( const QColorGroup & g ) const" +Returns TRUE if this color group is equal to \fIg\fR; otherwise returns FALSE. +.PP +See also +.SH "void QColorGroup::setBrush ( ColorRole r, const QBrush & b )" +Sets the brush used for color role \fIr\fR to \fIb\fR. +.PP +See also brush(), setColor(), and ColorRole. +.PP +Example: themes/wood.cpp. +.SH "void QColorGroup::setColor ( ColorRole r, const QColor & c )" +Sets the brush used for color role \fIr\fR to a solid color \fIc\fR. +.PP +See also brush() and ColorRole. +.PP +Examples: +.)l listviews/listviews.cpp, table/statistics/statistics.cpp, and themes/metal.cpp. +.SH "const QColor & QColorGroup::shadow () const" +Returns the shadow color of the color group. +.PP +See also ColorRole. +.SH "const QColor & QColorGroup::text () const" +Returns the text foreground color of the color group. +.PP +See also ColorRole. +.PP +Example: listviews/listviews.cpp. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QColorGroup & g )" +Writes color group, \fIg\fR to the stream \fIs\fR. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcolorgroup.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcolorgroup.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcombobox.3qt b/doc/man/man3/tqcombobox.3qt new file mode 100644 index 000000000..d96595a5e --- /dev/null +++ b/doc/man/man3/tqcombobox.3qt @@ -0,0 +1,603 @@ +'\" t +.TH QComboBox 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 +QComboBox \- Combined button and popup list +.SH SYNOPSIS +\fC#include <ntqcombobox.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQComboBox\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQComboBox\fR ( bool rw, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QComboBox\fR ()" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "void \fBinsertStringList\fR ( const QStringList & list, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertStrList\fR ( const QStrList & list, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertStrList\fR ( const QStrList * list, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertStrList\fR ( const char ** strings, int numStrings = -1, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QString & t, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, const QString & text, int index = -1 )" +.br +.ti -1c +.BI "void \fBremoveItem\fR ( int index )" +.br +.ti -1c +.BI "int \fBcurrentItem\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCurrentItem\fR ( int index )" +.br +.ti -1c +.BI "QString \fBcurrentText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCurrentText\fR ( const QString & )" +.br +.ti -1c +.BI "QString \fBtext\fR ( int index ) const" +.br +.ti -1c +.BI "const QPixmap * \fBpixmap\fR ( int index ) const" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( const QString & t, int index )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( const QPixmap & im, int index )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( const QPixmap & im, const QString & t, int index )" +.br +.ti -1c +.BI "bool autoResize () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void setAutoResize ( bool ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void \fBsetPalette\fR ( const QPalette & palette )" +.br +.ti -1c +.BI "virtual void \fBsetFont\fR ( const QFont & font )" +.br +.ti -1c +.BI "virtual void \fBsetSizeLimit\fR ( int )" +.br +.ti -1c +.BI "int \fBsizeLimit\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMaxCount\fR ( int )" +.br +.ti -1c +.BI "int \fBmaxCount\fR () const" +.br +.ti -1c +.BI "enum \fBPolicy\fR { NoInsertion, AtTop, AtCurrent, AtBottom, AfterCurrent, BeforeCurrent }" +.br +.ti -1c +.BI "virtual void \fBsetInsertionPolicy\fR ( Policy policy )" +.br +.ti -1c +.BI "Policy \fBinsertionPolicy\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetValidator\fR ( const QValidator * v )" +.br +.ti -1c +.BI "const QValidator * \fBvalidator\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetListBox\fR ( QListBox * newListBox )" +.br +.ti -1c +.BI "QListBox * \fBlistBox\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetLineEdit\fR ( QLineEdit * edit )" +.br +.ti -1c +.BI "QLineEdit * \fBlineEdit\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoCompletion\fR ( bool )" +.br +.ti -1c +.BI "bool \fBautoCompletion\fR () const" +.br +.ti -1c +.BI "void \fBsetDuplicatesEnabled\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBduplicatesEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBeditable\fR () const" +.br +.ti -1c +.BI "void \fBsetEditable\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBpopup\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "void \fBclearValidator\fR ()" +.br +.ti -1c +.BI "void \fBclearEdit\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetEditText\fR ( const QString & newText )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBactivated\fR ( int index )" +.br +.ti -1c +.BI "void \fBhighlighted\fR ( int index )" +.br +.ti -1c +.BI "void \fBactivated\fR ( const QString & string )" +.br +.ti -1c +.BI "void \fBhighlighted\fR ( const QString & string )" +.br +.ti -1c +.BI "void \fBtextChanged\fR ( const QString & string )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoCompletion\fR - whether auto-completion is enabled" +.br +.ti -1c +.BI "bool \fBautoMask\fR - whether the combobox is automatically masked \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool autoResize - whether auto resize is enabled \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBcount\fR - the number of items in the combobox \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcurrentItem\fR - the index of the current item in the combobox" +.br +.ti -1c +.BI "QString \fBcurrentText\fR - the text of the combobox's current item" +.br +.ti -1c +.BI "bool \fBduplicatesEnabled\fR - whether duplicates are allowed" +.br +.ti -1c +.BI "bool \fBeditable\fR - whether the combobox is editable" +.br +.ti -1c +.BI "Policy \fBinsertionPolicy\fR - the position of the items inserted by the user" +.br +.ti -1c +.BI "int \fBmaxCount\fR - the maximum number of items allowed in the combobox" +.br +.ti -1c +.BI "int \fBsizeLimit\fR - the maximum on-screen size of the combobox" +.br +.in -1c +.SH DESCRIPTION +The QComboBox widget is a combined button and popup list. +.PP +A combobox is a selection widget which displays the current item and can pop up a list of items. A combobox may be editable in which case the user can enter arbitrary strings. +.PP +Comboboxes provide a means of showing the user's current choice out of a list of options in a way that takes up the minimum amount of screen space. +.PP +QComboBox supports three different display styles: Aqua/Motif 1.x, Motif 2.0 and Windows. In Motif 1.x, a combobox was called XmOptionMenu. In Motif 2.0, OSF introduced an improved combobox and named that XmComboBox. QComboBox provides both. +.PP +QComboBox provides two different constructors. The simplest constructor creates an "old-style" combobox in Motif (or Aqua) style: +.PP +.nf +.br + QComboBox *c = new QComboBox( this, "read-only combobox" ); +.br +.fi +.PP +The other constructor creates a new-style combobox in Motif style, and can create both read-only and editable comboboxes: +.PP +.nf +.br + QComboBox *c1 = new QComboBox( FALSE, this, "read-only combobox" ); +.br + QComboBox *c2 = new QComboBox( TRUE, this, "editable combobox" ); +.br +.fi +.PP +New-style comboboxes use a list box in both Motif and Windows styles, and both the content size and the on-screen size of the list box can be limited with sizeLimit() and setMaxCount() respectively. Old-style comboboxes use a popup in Aqua and Motif style, and that popup will happily grow larger than the desktop if you put enough data into it. +.PP +The two constructors create identical-looking comboboxes in Windows style. +.PP +Comboboxes can contain pixmaps as well as strings; the insertItem() and changeItem() functions are suitably overloaded. For editable comboboxes, the function clearEdit() is provided, to clear the displayed string without changing the combobox's contents. +.PP +A combobox emits two signals, activated() and highlighted(), when a new item has been activated (selected) or highlighted (made current). Both signals exist in two versions, one with a QString argument and one with an \fCint\fR argument. If the user highlights or activates a pixmap, only the \fCint\fR signals are emitted. Whenever the text of an editable combobox is changed the textChanged() signal is emitted. +.PP +When the user enters a new string in an editable combobox, the widget may or may not insert it, and it can insert it in several locations. The default policy is is AtBottom but you can change this using setInsertionPolicy(). +.PP +It is possible to constrain the input to an editable combobox using QValidator; see setValidator(). By default, any input is accepted. +.PP +If the combobox is not editable then it has a default focusPolicy() of TabFocus, i.e. it will not grab focus if clicked. This differs from both Windows and Motif. If the combobox is editable then it has a default focusPolicy() of StrongFocus, i.e. it will grab focus if clicked. +.PP +A combobox can be populated using the insert functions, insertStringList() and insertItem() for example. Items can be changed with changeItem(). An item can be removed with removeItem() and all items can be removed with clear(). The text of the current item is returned by currentText(), and the text of a numbered item is returned with text(). The current item can be set with setCurrentItem() or setCurrentText(). The number of items in the combobox is returned by count(); the maximum number of items can be set with setMaxCount(). You can allow editing using setEditable(). For editable comboboxes you can set auto-completion using setAutoCompletion() and whether or not the user can add duplicates is set with setDuplicatesEnabled(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP +(Motif 1, read-only) +.br +.ce 1 +.B "[Image Omitted]" +.PP +(Motif 2, editable) +.br +.ce 1 +.B "[Image Omitted]" +.PP +(Motif 2, read-only) +.br +.ce 1 +.B "[Image Omitted]" +.PP +(Windows style) +.PP +Depending on the style, QComboBox will use a QListBox or a QPopupMenu to display the list of items. See setListBox() for more information. +.PP +See also QLineEdit, QListBox, QSpinBox, QRadioButton, QButtonGroup, GUI Design Handbook: Combo Box, GUI Design Handbook: Drop-Down List Box, and Basic Widgets. +.SS "Member Type Documentation" +.SH "QComboBox::Policy" +This enum specifies what the QComboBox should do when a new string is entered by the user. +.TP +\fCQComboBox::NoInsertion\fR - the string will not be inserted into the combobox. +.TP +\fCQComboBox::AtTop\fR - insert the string as the first item in the combobox. +.TP +\fCQComboBox::AtCurrent\fR - replace the previously selected item with the string the user has entered. +.TP +\fCQComboBox::AtBottom\fR - insert the string as the last item in the combobox. +.TP +\fCQComboBox::AfterCurrent\fR - insert the string after the previously selected item. +.TP +\fCQComboBox::BeforeCurrent\fR - insert the string before the previously selected item. +.PP +activated() is always emitted when the string is entered. +.PP +If inserting the new string would cause the combobox to breach its content size limit, the item at the other end of the list is deleted. The definition of "other end" is implementation-dependent. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QComboBox::QComboBox ( QWidget * parent = 0, const char * name = 0 )" +Constructs a combobox widget with parent \fIparent\fR called \fIname\fR. +.PP +This constructor creates a popup list if the program uses Motif (or Aqua) look and feel; this is compatible with Motif 1.x and Aqua. +.PP +Note: If you use this constructor to create your QComboBox, then the pixmap() function will always return 0. To workaround this, use the other constructor. +.SH "QComboBox::QComboBox ( bool rw, QWidget * parent = 0, const char * name = 0 )" +Constructs a combobox with a maximum size and either Motif 2.0 or Windows look and feel. +.PP +The input field can be edited if \fIrw\fR is TRUE, otherwise the user may only choose one of the items in the combobox. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. +.SH "QComboBox::~QComboBox ()" +Destroys the combobox. +.SH "void QComboBox::activated ( int index )\fC [signal]\fR" +This signal is emitted when a new item has been activated (selected). The \fIindex\fR is the position of the item in the combobox. +.PP +This signal is not emitted if the item is changed programmatically, e.g. using setCurrentItem(). +.PP +Examples: +.)l fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, lineedits/lineedits.cpp, listboxcombo/listboxcombo.cpp, and qmag/qmag.cpp. +.SH "void QComboBox::activated ( const QString & string )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when a new item has been activated (selected). \fIstring\fR is the selected string. +.PP +You can also use the activated(int) signal, but be aware that its argument is meaningful only for selected strings, not for user entered strings. +.SH "bool QComboBox::autoCompletion () const" +Returns TRUE if auto-completion is enabled; otherwise returns FALSE. See the "autoCompletion" property for details. +.SH "bool QComboBox::autoResize () const" +Returns TRUE if auto resize is enabled; otherwise returns FALSE. See the "autoResize" property for details. +.SH "void QComboBox::changeItem ( const QString & t, int index )" +Replaces the item at position \fIindex\fR with the text \fIt\fR. +.SH "void QComboBox::changeItem ( const QPixmap & im, int index )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces the item at position \fIindex\fR with the pixmap \fIim\fR, unless the combobox is editable. +.PP +See also insertItem(). +.SH "void QComboBox::changeItem ( const QPixmap & im, const QString & t, int index )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces the item at position \fIindex\fR with the pixmap \fIim\fR and the text \fIt\fR. +.PP +See also insertItem(). +.SH "void QComboBox::clear ()\fC [slot]\fR" +Removes all combobox items. +.SH "void QComboBox::clearEdit ()\fC [slot]\fR" +Clears the line edit without changing the combobox's contents. Does nothing if the combobox isn't editable. +.PP +This is particularly useful when using a combobox as a line edit with history. For example you can connect the combobox's activated() signal to clearEdit() in order to present the user with a new, empty line as soon as Enter is pressed. +.PP +See also setEditText(). +.SH "void QComboBox::clearValidator ()\fC [slot]\fR" +This slot is equivalent to setValidator( 0 ). +.SH "int QComboBox::count () const" +Returns the number of items in the combobox. See the "count" property for details. +.SH "int QComboBox::currentItem () const" +Returns the index of the current item in the combobox. See the "currentItem" property for details. +.SH "QString QComboBox::currentText () const" +Returns the text of the combobox's current item. See the "currentText" property for details. +.SH "bool QComboBox::duplicatesEnabled () const" +Returns TRUE if duplicates are allowed; otherwise returns FALSE. See the "duplicatesEnabled" property for details. +.SH "bool QComboBox::editable () const" +Returns TRUE if the combobox is editable; otherwise returns FALSE. See the "editable" property for details. +.SH "void QComboBox::highlighted ( int index )\fC [signal]\fR" +This signal is emitted when a new item has been set to be the current item. The \fIindex\fR is the position of the item in the combobox. +.PP +This signal is not emitted if the item is changed programmatically, e.g. using setCurrentItem(). +.SH "void QComboBox::highlighted ( const QString & string )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when a new item has been set to be the current item. \fIstring\fR is the item's text. +.PP +You can also use the highlighted(int) signal. +.SH "void QComboBox::insertItem ( const QString & t, int index = -1 )" +Inserts a text item with text \fIt\fR, at position \fIindex\fR. The item will be appended if \fIindex\fR is negative. +.PP +Examples: +.)l chart/optionsform.cpp, fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, lineedits/lineedits.cpp, listboxcombo/listboxcombo.cpp, regexptester/regexptester.cpp, and tictac/tictac.cpp. +.SH "void QComboBox::insertItem ( const QPixmap & pixmap, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a \fIpixmap\fR item at position \fIindex\fR. The item will be appended if \fIindex\fR is negative. +.SH "void QComboBox::insertItem ( const QPixmap & pixmap, const QString & text, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a \fIpixmap\fR item with additional text \fItext\fR at position \fIindex\fR. The item will be appended if \fIindex\fR is negative. +.SH "void QComboBox::insertStrList ( const char ** strings, int numStrings = -1, int index = -1 )" +Inserts the array of char * \fIstrings\fR at position \fIindex\fR in the combobox. +.PP +The \fInumStrings\fR argument is the number of strings. If \fInumStrings\fR is -1 (default), the \fIstrings\fR array must be terminated with 0. +.PP +Example: +.PP +.nf +.br + static const char* items[] = { "red", "green", "blue", 0 }; +.br + combo->insertStrList( items ); +.br +.fi +.PP +See also insertStringList(). +.PP +Example: qmag/qmag.cpp. +.SH "void QComboBox::insertStrList ( const QStrList & list, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the \fIlist\fR of strings at position \fIindex\fR in the combobox. +.PP +This is only for compatibility since it does not support Unicode strings. See insertStringList(). +.SH "void QComboBox::insertStrList ( const QStrList * list, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the \fIlist\fR of strings at position \fIindex\fR in the combobox. +.PP +This is only for compatibility since it does not support Unicode strings. See insertStringList(). +.SH "void QComboBox::insertStringList ( const QStringList & list, int index = -1 )" +Inserts the \fIlist\fR of strings at position \fIindex\fR in the combobox. +.SH "Policy QComboBox::insertionPolicy () const" +Returns the position of the items inserted by the user. See the "insertionPolicy" property for details. +.SH "QLineEdit * QComboBox::lineEdit () const" +Returns the line edit, or 0 if there is no line edit. +.PP +Only editable listboxes have a line editor. +.SH "QListBox * QComboBox::listBox () const" +Returns the current list box, or 0 if there is no list box. (QComboBox can use QPopupMenu instead of QListBox.) Provided to match setListBox(). +.PP +See also setListBox(). +.PP +Example: listboxcombo/listboxcombo.cpp. +.SH "int QComboBox::maxCount () const" +Returns the maximum number of items allowed in the combobox. See the "maxCount" property for details. +.SH "const QPixmap * QComboBox::pixmap ( int index ) const" +Returns the pixmap item at position \fIindex\fR, or 0 if the item is not a pixmap. +.SH "void QComboBox::popup ()\fC [virtual]\fR" +Pops up the combobox popup list. +.PP +If the list is empty, no items appear. +.SH "void QComboBox::removeItem ( int index )" +Removes the item at position \fIindex\fR. +.SH "void QComboBox::setAutoCompletion ( bool )\fC [virtual]\fR" +Sets whether auto-completion is enabled. See the "autoCompletion" property for details. +.SH "void QComboBox::setAutoResize ( bool )\fC [virtual]\fR" +Sets whether auto resize is enabled. See the "autoResize" property for details. +.SH "void QComboBox::setCurrentItem ( int index )\fC [virtual]\fR" +Sets the index of the current item in the combobox to \fIindex\fR. See the "currentItem" property for details. +.SH "void QComboBox::setCurrentText ( const QString & )\fC [virtual]\fR" +Sets the text of the combobox's current item. See the "currentText" property for details. +.SH "void QComboBox::setDuplicatesEnabled ( bool enable )" +Sets whether duplicates are allowed to \fIenable\fR. See the "duplicatesEnabled" property for details. +.SH "void QComboBox::setEditText ( const QString & newText )\fC [virtual slot]\fR" +Sets the text in the line edit to \fInewText\fR without changing the combobox's contents. Does nothing if the combobox isn't editable. +.PP +This is useful e.g. for providing a good starting point for the user's editing and entering the change in the combobox only when the user presses Enter. +.PP +See also clearEdit() and insertItem(). +.SH "void QComboBox::setEditable ( bool )" +Sets whether the combobox is editable. See the "editable" property for details. +.SH "void QComboBox::setFont ( const QFont & font )\fC [virtual]\fR" +Sets the font for both the combobox button and the combobox popup list to \fIfont\fR. +.PP +Reimplemented from QWidget. +.SH "void QComboBox::setInsertionPolicy ( Policy policy )\fC [virtual]\fR" +Sets the position of the items inserted by the user to \fIpolicy\fR. See the "insertionPolicy" property for details. +.SH "void QComboBox::setLineEdit ( QLineEdit * edit )\fC [virtual]\fR" +Sets the line edit to use \fIedit\fR instead of the current line edit. +.SH "void QComboBox::setListBox ( QListBox * newListBox )\fC [virtual]\fR" +Sets the combobox to use \fInewListBox\fR instead of the current list box or popup. As a side effect, it clears the combobox of its current contents. +.PP +\fBWarning:\fR QComboBox assumes that newListBox->text(n) returns non-null for 0 <= n < newListbox->count(). This assumption is necessary because of the line edit in QComboBox. +.SH "void QComboBox::setMaxCount ( int )\fC [virtual]\fR" +Sets the maximum number of items allowed in the combobox. See the "maxCount" property for details. +.SH "void QComboBox::setPalette ( const QPalette & palette )\fC [virtual]\fR" +Sets the palette for both the combobox button and the combobox popup list to \fIpalette\fR. +.PP +Reimplemented from QWidget. +.SH "void QComboBox::setSizeLimit ( int )\fC [virtual]\fR" +Sets the maximum on-screen size of the combobox. See the "sizeLimit" property for details. +.SH "void QComboBox::setValidator ( const QValidator * v )\fC [virtual]\fR" +Applies the validator \fIv\fR to the combobox so that only text which is valid according to \fIv\fR is accepted. +.PP +This function does nothing if the combobox is not editable. +.PP +See also validator(), clearValidator(), and QValidator. +.SH "int QComboBox::sizeLimit () const" +Returns the maximum on-screen size of the combobox. See the "sizeLimit" property for details. +.SH "QString QComboBox::text ( int index ) const" +Returns the text item at position \fIindex\fR, or QString::null if the item is not a string. +.PP +See also currentText. +.PP +Examples: +.)l fileiconview/mainwindow.cpp and helpviewer/helpwindow.cpp. +.SH "void QComboBox::textChanged ( const QString & string )\fC [signal]\fR" +This signal is used for editable comboboxes. It is emitted whenever the contents of the text entry field changes. \fIstring\fR contains the new text. +.SH "const QValidator * QComboBox::validator () const" +Returns the validator which constrains editing for this combobox if there is one; otherwise returns 0. +.PP +See also setValidator(), clearValidator(), and QValidator. +.SS "Property Documentation" +.SH "bool autoCompletion" +This property holds whether auto-completion is enabled. +.PP +This property can only be set for editable comboboxes, for non-editable comboboxes it has no effect. It is FALSE by default. +.PP +Set this property's value with setAutoCompletion() and get this property's value with autoCompletion(). +.SH "bool autoMask" +This property holds whether the combobox is automatically masked. +.PP +See also QWidget::autoMask. +.SH "bool autoResize" +This property holds whether auto resize is enabled. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +If this property is set to TRUE then the combobox will resize itself whenever its contents change. The default is FALSE. +.PP +Set this property's value with setAutoResize() and get this property's value with autoResize(). +.SH "int count" +This property holds the number of items in the combobox. +.PP +Get this property's value with count(). +.SH "int currentItem" +This property holds the index of the current item in the combobox. +.PP +Note that the activated() and highlighted() signals are only emitted when the user changes the current item, not when it is changed programmatically. +.PP +Set this property's value with setCurrentItem() and get this property's value with currentItem(). +.SH "QString currentText" +This property holds the text of the combobox's current item. +.PP +Set this property's value with setCurrentText() and get this property's value with currentText(). +.SH "bool duplicatesEnabled" +This property holds whether duplicates are allowed. +.PP +If the combobox is editable and the user enters some text in the combobox's lineedit and presses Enter (and the insertionPolicy() is not NoInsertion), then what happens is this: +.TP +If the text is not already in the list, the text is inserted. +.TP +If the text is in the list and this property is TRUE (the default), the text is inserted. +.TP +If the text is in the list and this property is FALSE, the text is \fInot\fR inserted; instead the item which has matching text becomes the current item. +.PP +This property only affects user-interaction. You can use insertItem() to insert duplicates if you wish regardless of this setting. +.PP +Set this property's value with setDuplicatesEnabled() and get this property's value with duplicatesEnabled(). +.SH "bool editable" +This property holds whether the combobox is editable. +.PP +This property's default is FALSE. Note that the combobox will be cleared if this property is set to TRUE for a 1.x Motif style combobox. To avoid this, use setEditable() before inserting any items. Also note that the 1.x version of Motif didn't have any editable comboboxes, so the combobox will change it's appearance to a 2.0 style Motif combobox is it is set to be editable. +.PP +Set this property's value with setEditable() and get this property's value with editable(). +.SH "Policy insertionPolicy" +This property holds the position of the items inserted by the user. +.PP +The default insertion policy is AtBottom. See Policy. +.PP +Set this property's value with setInsertionPolicy() and get this property's value with insertionPolicy(). +.SH "int maxCount" +This property holds the maximum number of items allowed in the combobox. +.PP +Set this property's value with setMaxCount() and get this property's value with maxCount(). +.SH "int sizeLimit" +This property holds the maximum on-screen size of the combobox. +.PP +This property is ignored for both Motif 1.x style and non-editable comboboxes in Mac style. The default limit is ten lines. If the number of items in the combobox is or grows larger than lines, a scrollbar is added. +.PP +Set this property's value with setSizeLimit() and get this property's value with sizeLimit(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcombobox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcombobox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcombotableitem.3qt b/doc/man/man3/tqcombotableitem.3qt new file mode 100644 index 000000000..9a5e5d67a --- /dev/null +++ b/doc/man/man3/tqcombotableitem.3qt @@ -0,0 +1,156 @@ +'\" t +.TH QComboTableItem 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 +QComboTableItem \- Means of using comboboxes in QTables +.SH SYNOPSIS +\fC#include <ntqtable.h>\fR +.PP +Inherits QTableItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQComboTableItem\fR ( QTable * table, const QStringList & list, bool editable = FALSE )" +.br +.ti -1c +.BI "\fB~QComboTableItem\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetCurrentItem\fR ( int i )" +.br +.ti -1c +.BI "virtual void \fBsetCurrentItem\fR ( const QString & s )" +.br +.ti -1c +.BI "int \fBcurrentItem\fR () const" +.br +.ti -1c +.BI "QString \fBcurrentText\fR () const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "QString \fBtext\fR ( int i ) const" +.br +.ti -1c +.BI "virtual void \fBsetEditable\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisEditable\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetStringList\fR ( const QStringList & l )" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QComboTableItem class provides a means of using comboboxes in QTables. +.PP +A QComboTableItem is a table item which looks and behaves like a combobox. The advantage of using QComboTableItems rather than real comboboxes is that a QComboTableItem uses far less resources than real comboboxes in QTables. When the cell has the focus it displays a real combobox which the user can interact with. When the cell does not have the focus the cell \fIlooks\fR like a combobox. Only text items (i.e. no pixmaps) may be used in QComboTableItems. +.PP +QComboTableItem items have the edit type WhenCurrent (see EditType). The QComboTableItem's list of items is provided by a QStringList passed to the constructor. +.PP +The list of items may be changed using setStringList(). The current item can be set with setCurrentItem() and retrieved with currentItem(). The text of the current item can be obtained with currentText(), and the text of a particular item can be retrieved with text(). +.PP +If isEditable() is TRUE the QComboTableItem will permit the user to either choose an existing list item, or create a new list item by entering their own text; otherwise the user may only choose one of the existing list items. +.PP +To populate a table cell with a QComboTableItem use QTable::setItem(). +.PP +QComboTableItems may be deleted with QTable::clearCell(). +.PP +QComboTableItems can be distinguished from QTableItems and QCheckTableItems using their Run Time Type Identification number (see rtti()). +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QCheckTableItem, QTableItem, QComboBox, and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QComboTableItem::QComboTableItem ( QTable * table, const QStringList & list, bool editable = FALSE )" +Creates a combo table item for the table \fItable\fR. The combobox's list of items is passed in the \fIlist\fR argument. If \fIeditable\fR is TRUE the user may type in new list items; if \fIeditable\fR is FALSE the user may only select from the list of items provided. +.PP +By default QComboTableItems cannot be replaced by other table items since isReplaceable() returns FALSE by default. +.PP +See also QTable::clearCell() and EditType. +.SH "QComboTableItem::~QComboTableItem ()" +QComboTableItem destructor. +.SH "int QComboTableItem::count () const" +Returns the total number of list items in the combo table item. +.SH "int QComboTableItem::currentItem () const" +Returns the index of the combo table item's current list item. +.PP +See also setCurrentItem(). +.SH "QString QComboTableItem::currentText () const" +Returns the text of the combo table item's current list item. +.PP +See also currentItem() and text(). +.SH "bool QComboTableItem::isEditable () const" +Returns TRUE if the user can add their own list items to the combobox's list of items; otherwise returns FALSE. +.PP +See also setEditable(). +.SH "int QComboTableItem::rtti () const\fC [virtual]\fR" +Returns 1. +.PP +Make your derived classes return their own values for rtti()to distinguish between different table item subclasses. You should use values greater than 1000, preferably a large random number, to allow for extensions to this class. +.PP +See also QTableItem::rtti(). +.PP +Reimplemented from QTableItem. +.SH "void QComboTableItem::setCurrentItem ( int i )\fC [virtual]\fR" +Sets the list item \fIi\fR to be the combo table item's current list item. +.PP +See also currentItem(). +.PP +Example: table/small-table-demo/main.cpp. +.SH "void QComboTableItem::setCurrentItem ( const QString & s )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the list item whose text is \fIs\fR to be the combo table item's current list item. Does nothing if no list item has the text \fIs\fR. +.PP +See also currentItem(). +.SH "void QComboTableItem::setEditable ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE the combo table item can be edited, i.e. the user may enter a new text item themselves. If \fIb\fR is FALSE the user may may only choose one of the existing items. +.PP +See also isEditable(). +.SH "void QComboTableItem::setStringList ( const QStringList & l )\fC [virtual]\fR" +Sets the list items of this QComboTableItem to the strings in the string list \fIl\fR. +.SH "QString QComboTableItem::text ( int i ) const" +Returns the text of the combo's list item at index \fIi\fR. +.PP +See also currentText(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcombotableitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcombotableitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcommonstyle.3qt b/doc/man/man3/tqcommonstyle.3qt new file mode 100644 index 000000000..a709fbc92 --- /dev/null +++ b/doc/man/man3/tqcommonstyle.3qt @@ -0,0 +1,59 @@ +'\" t +.TH QCommonStyle 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 +QCommonStyle \- Encapsulates the common Look and Feel of a GUI +.SH SYNOPSIS +\fC#include <ntqcommonstyle.h>\fR +.PP +Inherits QStyle. +.PP +Inherited by QMotifStyle and QWindowsStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCommonStyle\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QCommonStyle class encapsulates the common Look and Feel of a GUI. +.PP +This abstract class implements some of the widget's look and feel that is common to all GUI styles provided and shipped as part of Qt. +.PP +All the functions are documented in QStyle. +.PP +See also Widget Appearance and Style. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCommonStyle::QCommonStyle ()" +Constructs a QCommonStyle. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcommonstyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcommonstyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqconststring.3qt b/doc/man/man3/tqconststring.3qt new file mode 100644 index 000000000..db48b2dfb --- /dev/null +++ b/doc/man/man3/tqconststring.3qt @@ -0,0 +1,70 @@ +'\" t +.TH QConstString 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 +QConstString \- String objects using constant Unicode data +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqstring.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQConstString\fR ( const QChar * unicode, uint length )" +.br +.ti -1c +.BI "\fB~QConstString\fR ()" +.br +.ti -1c +.BI "const QString & \fBstring\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QConstString class provides string objects using constant Unicode data. +.PP +In order to minimize copying, highly optimized applications can use QConstString to provide a QString-compatible object from existing Unicode data. It is then the programmer's responsibility to ensure that the Unicode data exists for the entire lifetime of the QConstString object. +.PP +A QConstString is created with the QConstString constructor. The string held by the object can be obtained by calling string(). +.PP +See also Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QConstString::QConstString ( const QChar * unicode, uint length )" +Constructs a QConstString that uses the first \fIlength\fR Unicode characters in the array \fIunicode\fR. Any attempt to modify copies of the string will cause it to create a copy of the data, thus it remains forever unmodified. +.PP +The data in \fIunicode\fR is not copied. The caller must be able to guarantee that \fIunicode\fR will not be deleted or modified. +.SH "QConstString::~QConstString ()" +Destroys the QConstString, creating a copy of the data if other strings are still using it. +.SH "const QString & QConstString::string () const" +Returns a constant string referencing the data passed during +construction. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qconststring.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqconststring.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcontextmenuevent.3qt b/doc/man/man3/tqcontextmenuevent.3qt new file mode 100644 index 000000000..76678267d --- /dev/null +++ b/doc/man/man3/tqcontextmenuevent.3qt @@ -0,0 +1,187 @@ +'\" t +.TH QContextMenuEvent 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 +QContextMenuEvent \- Parameters that describe a context menu event +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBReason\fR { Mouse, Keyboard, Other }" +.br +.ti -1c +.BI "\fBQContextMenuEvent\fR ( Reason reason, const QPoint & pos, const QPoint & globalPos, int state )" +.br +.ti -1c +.BI "\fBQContextMenuEvent\fR ( Reason reason, const QPoint & pos, int state )" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "int \fBglobalX\fR () const" +.br +.ti -1c +.BI "int \fBglobalY\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBpos\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBglobalPos\fR () const" +.br +.ti -1c +.BI "ButtonState \fBstate\fR () const" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "bool \fBisConsumed\fR () const" +.br +.ti -1c +.BI "void \fBconsume\fR ()" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.ti -1c +.BI "Reason \fBreason\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QContextMenuEvent class contains parameters that describe a context menu event. +.PP +Context menu events are sent to widgets when a user triggers a context menu. What triggers this is platform dependent. For example, on Windows, pressing the menu button or releasing the right mouse button will cause this event to be sent. +.PP +When this event occurs it is customary to show a QPopupMenu with a context menu, if this is relevant to the context. +.PP +Context menu events contain a special accept flag that indicates whether the receiver accepted the event. If the event handler does not accept the event, then whatever triggered the event will be handled as a regular input event if possible. +.PP +See also QPopupMenu and Event Classes. +.SS "Member Type Documentation" +.SH "QContextMenuEvent::Reason" +This enum describes the reason the ContextMenuEvent was sent. The values are: +.TP +\fCQContextMenuEvent::Mouse\fR - The mouse caused the event to be sent. Normally this means the right mouse button was clicked, but this is platform specific. +.TP +\fCQContextMenuEvent::Keyboard\fR - The keyboard caused this event to be sent. On Windows this means the menu button was pressed. +.TP +\fCQContextMenuEvent::Other\fR - The event was sent by some other means (i.e. not by the mouse or keyboard). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, const QPoint & globalPos, int state )" +Constructs a context menu event object with the accept parameter flag set to FALSE. +.PP +The \fIreason\fR parameter must be QContextMenuEvent::Mouse or QContextMenuEvent::Keyboard. +.PP +The \fIpos\fR parameter specifies the mouse position relative to the receiving widget. \fIglobalPos\fR is the mouse position in absolute coordinates. \fIstate\fR is the ButtonState at the time of the event. +.SH "QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, int state )" +Constructs a context menu event object with the accept parameter flag set to FALSE. +.PP +The \fIreason\fR parameter must be QContextMenuEvent::Mouse or QContextMenuEvent::Keyboard. +.PP +The \fIpos\fR parameter specifies the mouse position relative to the receiving widget. \fIstate\fR is the ButtonState at the time of the event. +.PP +The globalPos() is initialized to QCursor::pos(), which may not be appropriate. Use the other constructor to specify the global position explicitly. +.SH "void QContextMenuEvent::accept ()" +Sets the accept flag of the context event object. +.PP +Setting the accept flag indicates that the receiver of this event has processed the event. Processing the event means you did something with it and it will be implicitly consumed. +.PP +The accept flag is not set by default. +.PP +See also ignore() and consume(). +.SH "void QContextMenuEvent::consume ()" +Sets the consume flag of the context event object. +.PP +Setting the consume flag indicates that the receiver of this event does not want the event to be propagated further (i.e. not sent to parent classes.) +.PP +The consumed flag is not set by default. +.PP +See also ignore() and accept(). +.SH "const QPoint & QContextMenuEvent::globalPos () const" +Returns the global position of the mouse pointer at the time of the event. +.PP +See also x(), y(), and pos(). +.SH "int QContextMenuEvent::globalX () const" +Returns the global x-position of the mouse pointer at the time of the event. +.PP +See also globalY() and globalPos(). +.SH "int QContextMenuEvent::globalY () const" +Returns the global y-position of the mouse pointer at the time of the event. +.PP +See also globalX() and globalPos(). +.SH "void QContextMenuEvent::ignore ()" +Clears the accept flag of the context event object. +.PP +Clearing the accept flag indicates that the receiver of this event does not need to show a context menu. This will implicitly remove the consumed flag as well. +.PP +The accept flag is not set by default. +.PP +See also accept() and consume(). +.SH "bool QContextMenuEvent::isAccepted () const" +Returns TRUE if the receiver has processed the event; otherwise returns FALSE. +.PP +See also accept(), ignore(), and consume(). +.SH "bool QContextMenuEvent::isConsumed () const" +Returns TRUE (which stops propagation of the event) if the receiver has blocked the event; otherwise returns FALSE. +.PP +See also accept(), ignore(), and consume(). +.SH "const QPoint & QContextMenuEvent::pos () const" +Returns the position of the mouse pointer relative to the widget that received the event. +.PP +See also x(), y(), and globalPos(). +.SH "Reason QContextMenuEvent::reason () const" +Returns the reason for this context event. +.SH "ButtonState QContextMenuEvent::state () const" +Returns the button state (a combination of mouse buttons and keyboard modifiers), i.e. what buttons and keys were being pressed immediately before the event was generated. +.PP +The returned value is LeftButton, RightButton, MidButton, ShiftButton, ControlButton and AltButton OR'ed together. +.SH "int QContextMenuEvent::x () const" +Returns the x-position of the mouse pointer, relative to the widget that received the event. +.PP +See also y() and pos(). +.SH "int QContextMenuEvent::y () const" +Returns the y-position of the mouse pointer, relative to the widget that received the event. +.PP +See also x() and pos(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcontextmenuevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcontextmenuevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcopchannel.3qt b/doc/man/man3/tqcopchannel.3qt new file mode 100644 index 000000000..08c15f76f --- /dev/null +++ b/doc/man/man3/tqcopchannel.3qt @@ -0,0 +1,170 @@ +'\" t +.TH QCopChannel 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 +QCopChannel \- Communication capabilities between several clients +.SH SYNOPSIS +\fC#include <qcopchannel_qws.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCopChannel\fR ( const QCString & channel, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QCopChannel\fR ()" +.br +.ti -1c +.BI "QCString \fBchannel\fR () const" +.br +.ti -1c +.BI "virtual void \fBreceive\fR ( const QCString & msg, const QByteArray & data )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBreceived\fR ( const QCString & msg, const QByteArray & data )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBisRegistered\fR ( const QCString & channel )" +.br +.ti -1c +.BI "bool \fBsend\fR ( const QCString & channel, const QCString & msg )" +.br +.ti -1c +.BI "bool \fBsend\fR ( const QCString & channel, const QCString & msg, const QByteArray & data )" +.br +.in -1c +.SH DESCRIPTION +The QCopChannel class provides communication capabilities between several clients. +.PP +The Qt Cop (QCOP) is a COmmunication Protocol, allowing clients to communicate both within the same address space and between different processes. +.PP +Currently, this facility is only available on Qt/Embedded. On X11 and Windows we are exploring the use of existing standards such as DCOP and COM. +.PP +QCopChannel provides send() and isRegistered() which are static functions usable without an object. +.PP +The channel() function returns the name of the channel. +.PP +In order to \fIlisten\fR to the traffic on a channel, you should either subclass QCopChannel and reimplement receive(), or connect() to the received() signal. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCopChannel::QCopChannel ( const QCString & channel, QObject * parent = 0, const char * name = 0 )" +Constructs a QCop channel and registers it with the server using the name \fIchannel\fR. The standard \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. +.SH "QCopChannel::~QCopChannel ()\fC [virtual]\fR" +Destroys the client's end of the channel and notifies the server that the client has closed its connection. The server will keep the channel open until the last registered client detaches. +.SH "QCString QCopChannel::channel () const" +Returns the name of the channel. +.SH "bool QCopChannel::isRegistered ( const QCString & channel )\fC [static]\fR" +Queries the server for the existence of \fIchannel\fR. +.PP +Returns TRUE if \fIchannel\fR is registered; otherwise returns FALSE. +.SH "void QCopChannel::receive ( const QCString & msg, const QByteArray & data )\fC [virtual]\fR" +This virtual function allows subclasses of QCopChannel to process data received from their channel. +.PP +The default implementation emits the received() signal. +.PP +Note that the format of \fIdata\fR has to be well defined in order to extract the information it contains. +.PP +Example: +.PP +.nf +.br + void MyClass::receive( const QCString &msg, const QByteArray &data ) +.br + { +.br + QDataStream stream( data, IO_ReadOnly ); +.br + if ( msg == "execute(QString,QString)" ) { +.br + QString cmd, arg; +.br + stream >> cmd >> arg; +.br + ... +.br + } else if ( msg == "delete(QString)" ) { +.br + QString filenname; +.br + stream >> filename; +.br + ... +.br + } else ... +.br + } +.br +.fi +This example assumes that the \fImsg\fR is a DCOP-style function signature and the \fIdata\fR contains the function's arguments. (See send().) +.PP +Using the DCOP convention is a recommendation, but not a requirement. Whatever convention you use the sender and receiver \fImust\fR agree on the argument types. +.PP +See also send(). +.SH "void QCopChannel::received ( const QCString & msg, const QByteArray & data )\fC [signal]\fR" +This signal is emitted with the \fImsg\fR and \fIdata\fR whenever the receive() function gets incoming data. +.SH "bool QCopChannel::send ( const QCString & channel, const QCString & msg, const QByteArray & data )\fC [static]\fR" +Send the message \fImsg\fR on channel \fIchannel\fR with data \fIdata\fR. The message will be distributed to all clients subscribed to the channel. +.PP +Note that QDataStream provides a convenient way to fill the byte array with auxiliary data. +.PP +Example: +.PP +.nf +.br + QByteArray ba; +.br + QDataStream stream( ba, IO_WriteOnly ); +.br + stream << QString("cat") << QString("file.txt"); +.br + QCopChannel::send( "System/Shell", "execute(QString,QString)", ba ); +.br +.fi +Here the channel is "System/Shell". The \fImsg\fR is an arbitrary string, but in the example we've used the DCOP convention of passing a function signature. Such a signature is formatted as functionname(types) where types is a list of zero or more comma-separated type names, with no whitespace, no consts and no pointer or reference marks, i.e. no "*" or "&". +.PP +Using the DCOP convention is a recommendation, but not a requirement. Whatever convention you use the sender and receiver \fImust\fR agree on the argument types. +.PP +See also receive(). +.SH "bool QCopChannel::send ( const QCString & channel, const QCString & msg )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Send the message \fImsg\fR on channel \fIchannel\fR. The message will be distributed to all clients subscribed to the \fIchannel\fR. +.PP +See also receive(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcopchannel.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcopchannel.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcstring.3qt b/doc/man/man3/tqcstring.3qt new file mode 100644 index 000000000..4433a13ae --- /dev/null +++ b/doc/man/man3/tqcstring.3qt @@ -0,0 +1,1138 @@ +'\" t +.TH QCString 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 +QCString \- Abstraction of the classic C zero-terminated char array (char *) +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqcstring.h>\fR +.PP +Inherits QByteArray. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCString\fR ()" +.br +.ti -1c +.BI "\fBQCString\fR ( int size )" +.br +.ti -1c +.BI "\fBQCString\fR ( const QCString & s )" +.br +.ti -1c +.BI "\fBQCString\fR ( const char * str )" +.br +.ti -1c +.BI "\fBQCString\fR ( const char * str, uint maxsize )" +.br +.ti -1c +.BI "QCString & \fBoperator=\fR ( const QCString & s )" +.br +.ti -1c +.BI "QCString & \fBoperator=\fR ( const char * str )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "uint \fBlength\fR () const" +.br +.ti -1c +.BI "bool \fBresize\fR ( uint len )" +.br +.ti -1c +.BI "bool \fBtruncate\fR ( uint pos )" +.br +.ti -1c +.BI "bool \fBfill\fR ( char c, int len = -1 )" +.br +.ti -1c +.BI "QCString \fBcopy\fR () const" +.br +.ti -1c +.BI "QCString & \fBsprintf\fR ( const char * format, ... )" +.br +.ti -1c +.BI "int \fBfind\fR ( char c, int index = 0, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( const char * str, int index = 0, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( const QRegExp & rx, int index = 0 ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( char c, int index = -1, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( const char * str, int index = -1, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( const QRegExp & rx, int index = -1 ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( char c, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( const char * str, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( const QRegExp & rx ) const" +.br +.ti -1c +.BI "QCString \fBleft\fR ( uint len ) const" +.br +.ti -1c +.BI "QCString \fBright\fR ( uint len ) const" +.br +.ti -1c +.BI "QCString \fBmid\fR ( uint index, uint len = 0xffffffff ) const" +.br +.ti -1c +.BI "QCString \fBleftJustify\fR ( uint width, char fill = ' ', bool truncate = FALSE ) const" +.br +.ti -1c +.BI "QCString \fBrightJustify\fR ( uint width, char fill = ' ', bool truncate = FALSE ) const" +.br +.ti -1c +.BI "QCString \fBlower\fR () const" +.br +.ti -1c +.BI "QCString \fBupper\fR () const" +.br +.ti -1c +.BI "QCString \fBstripWhiteSpace\fR () const" +.br +.ti -1c +.BI "QCString \fBsimplifyWhiteSpace\fR () const" +.br +.ti -1c +.BI "QCString & \fBinsert\fR ( uint index, const char * s )" +.br +.ti -1c +.BI "QCString & \fBinsert\fR ( uint index, char c )" +.br +.ti -1c +.BI "QCString & \fBappend\fR ( const char * str )" +.br +.ti -1c +.BI "QCString & \fBprepend\fR ( const char * s )" +.br +.ti -1c +.BI "QCString & \fBremove\fR ( uint index, uint len )" +.br +.ti -1c +.BI "QCString & \fBreplace\fR ( uint index, uint len, const char * str )" +.br +.ti -1c +.BI "QCString & \fBreplace\fR ( const QRegExp & rx, const char * str )" +.br +.ti -1c +.BI "QCString & \fBreplace\fR ( char c, const char * after )" +.br +.ti -1c +.BI "QCString & \fBreplace\fR ( const char * before, const char * after )" +.br +.ti -1c +.BI "QCString & \fBreplace\fR ( char c1, char c2 )" +.br +.ti -1c +.BI "short \fBtoShort\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "ushort \fBtoUShort\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "int \fBtoInt\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "uint \fBtoUInt\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "long \fBtoLong\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "ulong \fBtoULong\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "float \fBtoFloat\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "double \fBtoDouble\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "QCString & \fBsetStr\fR ( const char * str )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( short n )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( ushort n )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( int n )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( uint n )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( long n )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( ulong n )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( float n, char f = 'g', int prec = 6 )" +.br +.ti -1c +.BI "QCString & \fBsetNum\fR ( double n, char f = 'g', int prec = 6 )" +.br +.ti -1c +.BI "bool \fBsetExpand\fR ( uint index, char c )" +.br +.ti -1c +.BI "\fBoperator const char *\fR () const" +.br +.ti -1c +.BI "QCString & \fBoperator+=\fR ( const char * str )" +.br +.ti -1c +.BI "QCString & \fBoperator+=\fR ( char c )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "void * \fBqmemmove\fR ( void * dst, const void * src, uint len )" +.br +.ti -1c +.BI "char * \fBqstrdup\fR ( const char * src )" +.br +.ti -1c +.BI "char * \fBqstrcpy\fR ( char * dst, const char * src )" +.br +.ti -1c +.BI "char * \fBqstrncpy\fR ( char * dst, const char * src, uint len )" +.br +.ti -1c +.BI "uint \fBqstrlen\fR ( const char * str )" +.br +.ti -1c +.BI "int \fBqstrcmp\fR ( const char * str1, const char * str2 )" +.br +.ti -1c +.BI "int \fBqstrncmp\fR ( const char * str1, const char * str2, uint len )" +.br +.ti -1c +.BI "int \fBqstricmp\fR ( const char * str1, const char * str2 )" +.br +.ti -1c +.BI "int \fBqstrnicmp\fR ( const char * str1, const char * str2, uint len )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QCString & str )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QCString & str )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QCString & s1, const QCString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QCString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const char * s1, const QCString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QCString & s1, const QCString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QCString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const char * s1, const QCString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const QCString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const char * s1, const QCString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const QCString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const char * s1, const QCString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const QCString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const char * s1, const QCString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const QCString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const char * s1, const QCString & s2 )" +.br +.ti -1c +.BI "const QCString \fBoperator+\fR ( const QCString & s1, const QCString & s2 )" +.br +.ti -1c +.BI "const QCString \fBoperator+\fR ( const QCString & s1, const char * s2 )" +.br +.ti -1c +.BI "const QCString \fBoperator+\fR ( const char * s1, const QCString & s2 )" +.br +.ti -1c +.BI "const QCString \fBoperator+\fR ( const QCString & s, char c )" +.br +.ti -1c +.BI "const QCString \fBoperator+\fR ( char c, const QCString & s )" +.br +.in -1c +.SH DESCRIPTION +The QCString class provides an abstraction of the classic C zero-terminated char array (char *). +.PP +QCString inherits QByteArray, which is defined as QMemArray<char>. Since QCString is a QMemArray, it uses explicit sharing with a reference count. +.PP +QCString tries to behave like a more convenient \fCconst char *\fR. The price of doing this is that some algorithms will perform badly. For example, append() is O(length()) since it scans for a null terminator. Although you might use QCString for text that is never exposed to the user, for most purposes, and especially for user-visible text, you should use QString. QString provides implicit sharing, Unicode and other internationalization support, and is well optimized. +.PP +Note that for the QCString methods that take a \fCconst char *\fR parameter the \fCconst char *\fR must either be 0 (null) or not-null and '\0' (NUL byte) terminated; otherwise the results are undefined. +.PP +A QCString that has not been assigned to anything is \fInull\fR, i.e. both the length and the data pointer is 0. A QCString that references the empty string ("", a single '\0' char) is \fIempty\fR. Both null and empty QCStrings are legal parameters to the methods. Assigning \fCconst char *\fR 0 to QCString produces a null QCString. +.PP +The length() function returns the length of the string; resize() resizes the string and truncate() truncates the string. A string can be filled with a character using fill(). Strings can be left or right padded with characters using leftJustify() and rightJustify(). Characters, strings and regular expressions can be searched for using find() and findRev(), and counted using contains(). +.PP +Strings and characters can be inserted with insert() and appended with append(). A string can be prepended with prepend(). Characters can be removed from the string with remove() and replaced with replace(). +.PP +Portions of a string can be extracted using left(), right() and mid(). Whitespace can be removed using stripWhiteSpace() and simplifyWhiteSpace(). Strings can be converted to uppercase or lowercase with upper() and lower() respectively. +.PP +Strings that contain numbers can be converted to numbers with toShort(), toInt(), toLong(), toULong(), toFloat() and toDouble(). Numbers can be converted to strings with setNum(). +.PP +Many operators are overloaded to work with QCStrings. QCString also supports some more obscure functions, e.g. sprintf(), setStr() and setExpand(). +.PP +<blockquote><p align="center">\fB Note on Character Comparisons \fR +.PP +In QCString the notion of uppercase and lowercase and of which character is greater than or less than another character is locale dependent. This affects functions which support a case insensitive option or which compare or lowercase or uppercase their arguments. Case insensitive operations and comparisons will be accurate if both strings contain only ASCII characters. (If \fC$LC_CTYPE\fR is set, most Unix systems do "the right thing".) Functions that this affects include contains(), find(), findRev(), operator<(), operator<=(), operator>(), operator>=(), lower() and upper(). +.PP +This issue does not apply to QStrings since they represent characters using Unicode. </blockquote> +.PP +Performance note: The QCString methods for QRegExp searching are implemented by converting the QCString to a QString and performing the search on that. This implies a deep copy of the QCString data. If you are going to perform many QRegExp searches on a large QCString, you will get better performance by converting the QCString to a QString yourself, and then searching in the QString. +.PP +See also Collection Classes, Implicitly and Explicitly Shared Classes, Text Related Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCString::QCString ()" +Constructs a null string. +.PP +See also isNull(). +.SH "QCString::QCString ( int size )" +Constructs a string with room for \fIsize\fR characters, including the '\0'-terminator. Makes a null string if \fIsize\fR == 0. +.PP +If \fIsize\fR > 0, then the first and last characters in the string are initialized to '\0'. All other characters are uninitialized. +.PP +See also resize() and isNull(). +.SH "QCString::QCString ( const QCString & s )" +Constructs a shallow copy \fIs\fR. +.PP +See also assign(). +.SH "QCString::QCString ( const char * str )" +Constructs a string that is a deep copy of \fIstr\fR. +.PP +If \fIstr\fR is 0 a null string is created. +.PP +See also isNull(). +.SH "QCString::QCString ( const char * str, uint maxsize )" +Constructs a string that is a deep copy of \fIstr\fR. The copy will be at most \fImaxsize\fR bytes long including the '\0'-terminator. +.PP +Example: +.PP +.nf +.br + QCString str( "helloworld", 6 ); // assigns "hello" to str +.br +.fi +.PP +If \fIstr\fR contains a 0 byte within the first \fImaxsize\fR bytes, the resulting QCString will be terminated by this 0. If \fIstr\fR is 0 a null string is created. +.PP +See also isNull(). +.SH "QCString & QCString::append ( const char * str )" +Appends string \fIstr\fR to the string and returns a reference to the string. Equivalent to operator+=(). +.SH "int QCString::contains ( char c, bool cs = TRUE ) const" +Returns the number of times the character \fIc\fR occurs in the string. +.PP +The match is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR if FALSE. +.PP +See also Note on character comparisons. +.SH "int QCString::contains ( const char * str, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the number of times \fIstr\fR occurs in the string. +.PP +The match is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR if FALSE. +.PP +This function counts overlapping substrings, for example, "banana" contains two occurrences of "ana". +.PP +See also findRev() and Note on character comparisons. +.SH "int QCString::contains ( const QRegExp & rx ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Counts the number of overlapping occurrences of \fIrx\fR in the string. +.PP +Example: +.PP +.nf +.br + QString s = "banana and panama"; +.br + QRegExp r = QRegExp( "a[nm]a", TRUE, FALSE ); +.br + s.contains( r ); // 4 matches +.br +.fi +.PP +See also find() and findRev(). +.PP +\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. +.SH "QCString QCString::copy () const" +Returns a deep copy of this string. +.PP +See also detach(). +.SH "bool QCString::fill ( char c, int len = -1 )" +Fills the string with \fIlen\fR bytes of character \fIc\fR, followed by a '\0'-terminator. +.PP +If \fIlen\fR is negative, then the current string length is used. +.PP +Returns FALSE is \fIlen\fR is nonnegative and there is not enough memory to resize the string; otherwise returns TRUE. +.SH "int QCString::find ( char c, int index = 0, bool cs = TRUE ) const" +Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR. +.PP +The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +.PP +Returns the position of \fIc\fR, or -1 if \fIc\fR could not be found. +.PP +See also Note on character comparisons. +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "int QCString::find ( const char * str, int index = 0, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR. +.PP +The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +.PP +Returns the position of \fIstr\fR, or -1 if \fIstr\fR could not be found. +.PP +See also Note on character comparisons. +.SH "int QCString::find ( const QRegExp & rx, int index = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the regular expression \fIrx\fR, starting at position \fIindex\fR. +.PP +Returns the position of the next match, or -1 if \fIrx\fR was not found. +.PP +\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. +.SH "int QCString::findRev ( char c, int index = -1, bool cs = TRUE ) const" +Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR and searching backwards. +.PP +The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +.PP +Returns the position of \fIc\fR, or -1 if \fIc\fR could not be found. +.PP +See also Note on character comparisons. +.SH "int QCString::findRev ( const char * str, int index = -1, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR and searching backwards. +.PP +The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +.PP +Returns the position of \fIstr\fR, or -1 if \fIstr\fR could not be found. +.PP +See also Note on character comparisons. +.SH "int QCString::findRev ( const QRegExp & rx, int index = -1 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the regular expression \fIrx\fR, starting at position \fIindex\fR and searching backwards. +.PP +Returns the position of the next match (backwards), or -1 if \fIrx\fR was not found. +.PP +\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. +.SH "QCString & QCString::insert ( uint index, char c )" +Inserts character \fIc\fR into the string at position \fIindex\fR and returns a reference to the string. +.PP +If \fIindex\fR is beyond the end of the string, the string is padded with spaces (ASCII 32) to length \fIindex\fR and then \fIc\fR is appended. +.PP +Example: +.PP +.nf +.br + QCString s = "Yes"; +.br + s.insert( 3, '!'); // s == "Yes!" +.br +.fi +.PP +See also remove() and replace(). +.SH "QCString & QCString::insert ( uint index, const char * s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts string \fIs\fR into the string at position \fIindex\fR. +.PP +If \fIindex\fR is beyond the end of the string, the string is padded with spaces (ASCII 32) to length \fIindex\fR and then \fIs\fR is appended. +.PP +.nf +.br + QCString s = "I like fish"; +.br + s.insert( 2, "don't "); // s == "I don't like fish" +.br +.br + s = "x"; // index 01234 +.br + s.insert( 3, "yz" ); // s == "x yz" +.br +.fi +.SH "bool QCString::isEmpty () const" +Returns TRUE if the string is empty, i.e. if length() == 0; otherwise returns FALSE. An empty string is not always a null string. +.PP +See example in isNull(). +.PP +See also isNull(), length(), and size(). +.SH "bool QCString::isNull () const" +Returns TRUE if the string is null, i.e. if data() == 0; otherwise returns FALSE. A null string is also an empty string. +.PP +Example: +.PP +.nf +.br + QCString a; // a.data() == 0, a.size() == 0, a.length() == 0 +.br + QCString b == ""; // b.data() == "", b.size() == 1, b.length() == 0 +.br + a.isNull(); // TRUE because a.data() == 0 +.br + a.isEmpty(); // TRUE because a.length() == 0 +.br + b.isNull(); // FALSE because b.data() == "" +.br + b.isEmpty(); // TRUE because b.length() == 0 +.br +.fi +.PP +See also isEmpty(), length(), and size(). +.SH "QCString QCString::left ( uint len ) const" +Returns a substring that contains the \fIlen\fR leftmost characters of the string. +.PP +The whole string is returned if \fIlen\fR exceeds the length of the string. +.PP +Example: +.PP +.nf +.br + QCString s = "Pineapple"; +.br + QCString t = s.left( 4 ); // t == "Pine" +.br +.fi +.PP +See also right() and mid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QCString QCString::leftJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const" +Returns a string of length \fIwidth\fR (plus one for the terminating '\0') that contains this string padded with the \fIfill\fR character. +.PP +If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is FALSE (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is TRUE, then the returned string is a left(\fIwidth\fR). +.PP +Example: +.PP +.nf +.br + QCString s("apple"); +.br + QCString t = s.leftJustify(8, '.'); // t == "apple..." +.br +.fi +.PP +See also rightJustify(). +.SH "uint QCString::length () const" +Returns the length of the string, excluding the '\0'-terminator. Equivalent to calling \fCstrlen(data())\fR. +.PP +Null strings and empty strings have zero length. +.PP +See also size(), isNull(), and isEmpty(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QCString QCString::lower () const" +Returns a new string that is a copy of this string converted to lower case. +.PP +Example: +.PP +.nf +.br + QCString s("Credit"); +.br + QCString t = s.lower(); // t == "credit" +.br +.fi +.PP +See also upper() and Note on character comparisons. +.SH "QCString QCString::mid ( uint index, uint len = 0xffffffff ) const" +Returns a substring that contains at most \fIlen\fR characters from this string, starting at position \fIindex\fR. +.PP +Returns a null string if the string is empty or if \fIindex\fR is out of range. Returns the whole string from \fIindex\fR if \fIindex+len\fR exceeds the length of the string. +.PP +Example: +.PP +.nf +.br + QCString s = "Two pineapples"; +.br + QCString t = s.mid( 4, 3 ); // t == "pin" +.br +.fi +.PP +See also left() and right(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QCString::operator const char * () const" +Returns the string data. +.SH "QCString & QCString::operator+= ( const char * str )" +Appends string \fIstr\fR to the string and returns a reference to the string. +.SH "QCString & QCString::operator+= ( char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends character \fIc\fR to the string and returns a reference to the string. +.SH "QCString & QCString::operator= ( const QCString & s )" +Assigns a shallow copy of \fIs\fR to this string and returns a reference to this string. +.SH "QCString & QCString::operator= ( const char * str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns a deep copy of \fIstr\fR to this string and returns a reference to this string. +.PP +If \fIstr\fR is 0 a null string is created. +.PP +See also isNull(). +.SH "QCString & QCString::prepend ( const char * s )" +Prepend \fIs\fR to the string. Equivalent to insert(0, s). +.PP +See also insert(). +.SH "QCString & QCString::remove ( uint index, uint len )" +Removes \fIlen\fR characters from the string, starting at position \fIindex\fR, and returns a reference to the string. +.PP +If \fIindex\fR is out of range, nothing happens. If \fIindex\fR is valid, but \fIindex\fR + \fIlen\fR is larger than the length of the string, the string is truncated at position \fIindex\fR. +.PP +.nf +.br + QCString s = "Montreal"; +.br + s.remove( 1, 4 ); // s == "Meal" +.br +.fi +.PP +See also insert() and replace(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QCString & QCString::replace ( uint index, uint len, const char * str )" +Replaces \fIlen\fR characters from the string, starting at position \fIindex\fR, with \fIstr\fR, and returns a reference to the string. +.PP +If \fIindex\fR is out of range, nothing is removed and \fIstr\fR is appended at the end of the string. If \fIindex\fR is valid, but \fIindex\fR + \fIlen\fR is larger than the length of the string, \fIstr\fR replaces the rest of the string from position \fIindex\fR. +.PP +.nf +.br + QCString s = "Say yes!"; +.br + s.replace( 4, 3, "NO" ); // s == "Say NO!" +.br +.fi +.PP +See also insert() and remove(). +.SH "QCString & QCString::replace ( const QRegExp & rx, const char * str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of \fIrx\fR in the string with \fIstr\fR. Returns a reference to the string. +.PP +Example: +.PP +.nf +.br + QString s = "banana"; +.br + s.replace( QRegExp("a.*a"), "" ); // becomes "b" +.br +.br + s = "banana"; +.br + s.replace( QRegExp("^[bn]a"), "X" ); // becomes "Xnana" +.br +.br + s = "banana"; +.br + s.replace( QRegExp("^[bn]a"), "" ); // becomes "nana" +.br +.fi +.PP +\fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a QString and apply the function to that. +.SH "QCString & QCString::replace ( char c, const char * after )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of the character \fIc\fR in the string with \fIafter\fR. Returns a reference to the string. +.PP +Example: +.PP +.nf +.br + QCString s = "a,b,c"; +.br + s.replace( ',', " or " ); +.br + // s == "a or b or c" +.br +.fi +.SH "QCString & QCString::replace ( const char * before, const char * after )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of the string \fIbefore\fR in the string with the string \fIafter\fR. Returns a reference to the string. +.PP +Example: +.PP +.nf +.br + QCString s = "Greek is Greek"; +.br + s.replace( "Greek", "English" ); +.br + // s == "English is English" +.br +.fi +.SH "QCString & QCString::replace ( char c1, char c2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of \fIc1\fR with the char \fIc2\fR. Returns a reference to the string. +.SH "bool QCString::resize ( uint len )" +Extends or shrinks the string to \fIlen\fR bytes, including the '\0'-terminator. +.PP +A '\0'-terminator is set at position \fClen - 1\fR unless \fClen == 0\fR. +.PP +Example: +.PP +.nf +.br + QCString s = "resize this string"; +.br + s.resize( 7 ); // s == "resize" +.br +.fi +.PP +See also truncate(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QCString QCString::right ( uint len ) const" +Returns a substring that contains the \fIlen\fR rightmost characters of the string. +.PP +The whole string is returned if \fIlen\fR exceeds the length of the string. +.PP +Example: +.PP +.nf +.br + QCString s = "Pineapple"; +.br + QCString t = s.right( 5 ); // t == "apple" +.br +.fi +.PP +See also left() and mid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QCString QCString::rightJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const" +Returns a string of length \fIwidth\fR (plus one for the terminating '\0') that contains zero or more of the \fIfill\fR character followed by this string. +.PP +If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is FALSE (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is TRUE, then the returned string is a left(\fIwidth\fR). +.PP +Example: +.PP +.nf +.br + QCString s("pie"); +.br + QCString t = s.rightJustify(8, '.'); // t == ".....pie" +.br +.fi +.PP +See also leftJustify(). +.SH "bool QCString::setExpand ( uint index, char c )" +Sets the character at position \fIindex\fR to \fIc\fR and expands the string if necessary, padding with spaces. +.PP +Returns FALSE if \fIindex\fR was out of range and the string could not be expanded; otherwise returns TRUE. +.SH "QCString & QCString::setNum ( double n, char f = 'g', int prec = 6 )" +Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. +.PP +The format of the string representation is specified by the format character \fIf\fR, and the precision (number of digits after the decimal point) is specified with \fIprec\fR. +.PP +The valid formats for \fIf\fR are 'e', 'E', 'f', 'g' and 'G'. The formats are the same as for sprintf(); they are explained in QString::arg(). +.SH "QCString & QCString::setNum ( short n )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. +.SH "QCString & QCString::setNum ( ushort n )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. +.SH "QCString & QCString::setNum ( int n )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. +.SH "QCString & QCString::setNum ( uint n )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. +.SH "QCString & QCString::setNum ( long n )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. +.SH "QCString & QCString::setNum ( ulong n )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. +.SH "QCString & QCString::setNum ( float n, char f = 'g', int prec = 6 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QCString & QCString::setStr ( const char * str )" +Makes a deep copy of \fIstr\fR. Returns a reference to the string. +.SH "QCString QCString::simplifyWhiteSpace () const" +Returns a new string that has white space removed from the start and the end, plus any sequence of internal white space replaced with a single space (ASCII 32). +.PP +White space means the decimal ASCII codes 9, 10, 11, 12, 13 and 32. +.PP +.nf +.br + QCString s = " lots\\t of\\nwhite space "; +.br + QCString t = s.simplifyWhiteSpace(); // t == "lots of white space" +.br +.fi +.PP +See also stripWhiteSpace(). +.SH "QCString & QCString::sprintf ( const char * format, ... )" +Implemented as a call to the native vsprintf() (see the manual for your C library). +.PP +If the string is shorter than 256 characters, this sprintf() calls resize(256) to decrease the chance of memory corruption. The string is resized back to its actual length before sprintf() returns. +.PP +Example: +.PP +.nf +.br + QCString s; +.br + s.sprintf( "%d - %s", 1, "first" ); // result < 256 chars +.br +.br + QCString big( 25000 ); // very long string +.br + big.sprintf( "%d - %s", 2, longString ); // result < 25000 chars +.br +.fi +.PP +\fBWarning:\fR All vsprintf() implementations will write past the end of the target string (*this) if the \fIformat\fR specification and arguments happen to be longer than the target string, and some will also fail if the target string is longer than some arbitrary implementation limit. +.PP +Giving user-supplied arguments to sprintf() is risky: Sooner or later someone will paste a huge line into your application. +.SH "QCString QCString::stripWhiteSpace () const" +Returns a new string that has white space removed from the start and the end. +.PP +White space means the decimal ASCII codes 9, 10, 11, 12, 13 and 32. +.PP +Example: +.PP +.nf +.br + QCString s = " space "; +.br + QCString t = s.stripWhiteSpace(); // t == "space" +.br +.fi +.PP +See also simplifyWhiteSpace(). +.SH "double QCString::toDouble ( bool * ok = 0 ) const" +Returns the string converted to a \fCdouble\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "float QCString::toFloat ( bool * ok = 0 ) const" +Returns the string converted to a \fCfloat\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "int QCString::toInt ( bool * ok = 0 ) const" +Returns the string converted to a \fCint\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "long QCString::toLong ( bool * ok = 0 ) const" +Returns the string converted to a \fClong\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "short QCString::toShort ( bool * ok = 0 ) const" +Returns the string converted to a \fCshort\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "uint QCString::toUInt ( bool * ok = 0 ) const" +Returns the string converted to an \fCunsigned int\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "ulong QCString::toULong ( bool * ok = 0 ) const" +Returns the string converted to an \fCunsigned long\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "ushort QCString::toUShort ( bool * ok = 0 ) const" +Returns the string converted to an \fCunsigned short\fR value. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +.SH "bool QCString::truncate ( uint pos )" +Truncates the string at position \fIpos\fR. +.PP +Equivalent to calling \fCresize(pos+1)\fR. +.PP +Example: +.PP +.nf +.br + QCString s = "truncate this string"; +.br + s.truncate( 5 ); // s == "trunc" +.br +.fi +.PP +See also resize(). +.SH "QCString QCString::upper () const" +Returns a new string that is a copy of this string converted to upper case. +.PP +Example: +.PP +.nf +.br + QCString s( "Debit" ); +.br + QCString t = s.upper(); // t == "DEBIT" +.br +.fi +.PP +See also lower() and Note on character comparisons. +.SH RELATED FUNCTION DOCUMENTATION +.SH "bool operator!= ( const QCString & s1, const QCString & s2 )" +Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. +.SH "bool operator!= ( const QCString & s1, const char * s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. +.SH "bool operator!= ( const char * s1, const QCString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. +.SH "const QCString operator+ ( const QCString & s1, const QCString & s2 )" +Returns a string which consists of the concatenation of \fIs1\fR and \fIs2\fR. +.SH "const QCString operator+ ( const QCString & s1, const char * s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which consists of the concatenation of \fIs1\fR and \fIs2\fR. +.SH "const QCString operator+ ( const char * s1, const QCString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which consists of the concatenation of \fIs1\fR and \fIs2\fR. +.SH "const QCString operator+ ( const QCString & s, char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which consists of the concatenation of \fIs\fR and \fIc\fR. +.SH "const QCString operator+ ( char c, const QCString & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which consists of the concatenation of \fIc\fR and \fIs\fR. +.SH "bool operator< ( const QCString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is less than \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) < 0. +.PP +See also Note on character comparisons. +.SH "bool operator< ( const char * s1, const QCString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is less than \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) < 0. +.PP +See also Note on character comparisons. +.SH "QDataStream & operator<< ( QDataStream & s, const QCString & str )" +Writes string \fIstr\fR to the stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "bool operator<= ( const QCString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) <= 0. +.PP +See also Note on character comparisons. +.SH "bool operator<= ( const char * s1, const QCString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) <= 0. +.PP +See also Note on character comparisons. +.SH "bool operator== ( const QCString & s1, const QCString & s2 )" +Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. +.SH "bool operator== ( const QCString & s1, const char * s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. +.SH "bool operator== ( const char * s1, const QCString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. +.SH "bool operator> ( const QCString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is greater than \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) > 0. +.PP +See also Note on character comparisons. +.SH "bool operator> ( const char * s1, const QCString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is greater than \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) > 0. +.PP +See also Note on character comparisons. +.SH "bool operator>= ( const QCString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) >= 0. +.PP +See also Note on character comparisons. +.SH "bool operator>= ( const char * s1, const QCString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns FALSE. +.PP +Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) >= 0. +.PP +See also Note on character comparisons. +.SH "QDataStream & operator>> ( QDataStream & s, QCString & str )" +Reads a string into \fIstr\fR from the stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "void * tqmemmove ( void * dst, const void * src, uint len )" +This function is normally part of the C library. Qt implements memmove() for platforms that do not provide it. +.PP +memmove() copies \fIlen\fR bytes from \fIsrc\fR into \fIdst\fR. The data is copied correctly even if \fIsrc\fR and \fIdst\fR overlap. +.SH "int qstrcmp ( const char * str1, const char * str2 )" +A safe strcmp() function. +.PP +Compares \fIstr1\fR and \fIstr2\fR. Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. +.PP +Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. +.PP +Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). +.PP +See also tqstrncmp(), tqstricmp(), tqstrnicmp(), and Note on character comparisons. +.SH "char * qstrcpy ( char * dst, const char * src )" +A safe strcpy() function. +.PP +Copies all characters up to and including the '\0' from \fIsrc\fR into \fIdst\fR and returns a pointer to \fIdst\fR. +.SH "char * tqstrdup ( const char * src )" +Returns a duplicate string. +.PP +Allocates space for a copy of \fIsrc\fR, copies it, and returns a pointer to the copy. If \fIsrc\fR is 0, it immediately returns 0. +.PP +The returned string must be deleted using \fCdelete[]\fR. +.SH "int tqstricmp ( const char * str1, const char * str2 )" +A safe stricmp() function. +.PP +Compares \fIstr1\fR and \fIstr2\fR ignoring the case. +.PP +Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. +.PP +Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. +.PP +Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). +.PP +See also qstrcmp(), tqstrncmp(), tqstrnicmp(), and Note on character comparisons. +.SH "uint tqstrlen ( const char * str )" +A safe strlen function. +.PP +Returns the number of characters that precede the terminating '\0'. or 0 if \fIstr\fR is 0. +.SH "int tqstrncmp ( const char * str1, const char * str2, uint len )" +A safe strncmp() function. +.PP +Compares at most \fIlen\fR bytes of \fIstr1\fR and \fIstr2\fR. +.PP +Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. +.PP +Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. +.PP +Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). +.PP +See also qstrcmp(), tqstricmp(), tqstrnicmp(), and Note on character comparisons. +.SH "char * tqstrncpy ( char * dst, const char * src, uint len )" +A safe strncpy() function. +.PP +Copies at most \fIlen\fR bytes from \fIsrc\fR (stopping at \fIlen\fR or the terminating '\0' whichever comes first) into \fIdst\fR and returns a pointer to \fIdst\fR. Guarantees that \fIdst\fR is '\0'-terminated. If \fIsrc\fR or \fIdst\fR is 0, returns 0 immediately. +.PP +See also qstrcpy(). +.SH "int tqstrnicmp ( const char * str1, const char * str2, uint len )" +A safe strnicmp() function. +.PP +Compares at most \fIlen\fR bytes of \fIstr1\fR and \fIstr2\fR ignoring the case. +.PP +Returns a negative value if \fIstr1\fR is less than \fIstr2\fR, 0 if \fIstr1\fR is equal to \fIstr2\fR or a positive value if \fIstr1\fR is greater than \fIstr2\fR. +.PP +Special case I: Returns 0 if \fIstr1\fR and \fIstr2\fR are both 0. +.PP +Special case II: Returns a random nonzero value if \fIstr1\fR is 0 or \fIstr2\fR is 0 (but not both). +.PP +See also qstrcmp(), tqstrncmp(), tqstricmp(), and Note on character comparisons. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcstring.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcstring.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcursor.3qt b/doc/man/man3/tqcursor.3qt new file mode 100644 index 000000000..1639690e8 --- /dev/null +++ b/doc/man/man3/tqcursor.3qt @@ -0,0 +1,253 @@ +'\" t +.TH QCursor 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 +QCursor \- Mouse cursor with an arbitrary shape +.SH SYNOPSIS +\fC#include <ntqcursor.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCursor\fR ()" +.br +.ti -1c +.BI "\fBQCursor\fR ( int shape )" +.br +.ti -1c +.BI "\fBQCursor\fR ( const QBitmap & bitmap, const QBitmap & mask, int hotX = -1, int hotY = -1 )" +.br +.ti -1c +.BI "\fBQCursor\fR ( const QPixmap & pixmap, int hotX = -1, int hotY = -1 )" +.br +.ti -1c +.BI "\fBQCursor\fR ( const QCursor & c )" +.br +.ti -1c +.BI "\fB~QCursor\fR ()" +.br +.ti -1c +.BI "QCursor & \fBoperator=\fR ( const QCursor & c )" +.br +.ti -1c +.BI "int \fBshape\fR () const" +.br +.ti -1c +.BI "void \fBsetShape\fR ( int shape )" +.br +.ti -1c +.BI "const QBitmap * \fBbitmap\fR () const" +.br +.ti -1c +.BI "const QBitmap * \fBmask\fR () const" +.br +.ti -1c +.BI "QPoint \fBhotSpot\fR () const" +.br +.ti -1c +.BI "HCURSOR \fBhandle\fR () const" +.br +.ti -1c +.BI "\fBQCursor\fR ( HCURSOR handle )" +.br +.ti -1c +.BI "HANDLE \fBhandle\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QPoint \fBpos\fR ()" +.br +.ti -1c +.BI "void \fBsetPos\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBsetPos\fR ( const QPoint & )" +.br +.ti -1c +.BI "void \fBinitialize\fR ()" +.br +.ti -1c +.BI "void \fBcleanup\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QCursor & c )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QCursor & c )" +.br +.in -1c +.SH DESCRIPTION +The QCursor class provides a mouse cursor with an arbitrary shape. +.PP +This class is mainly used to create mouse cursors that are associated with particular widgets and to get and set the position of the mouse cursor. +.PP +Qt has a number of standard cursor shapes, but you can also make custom cursor shapes based on a QBitmap, a mask and a hotspot. +.PP +To associate a cursor with a widget, use QWidget::setCursor(). To associate a cursor with all widgets (normally for a short period of time), use QApplication::setOverrideCursor(). +.PP +To set a cursor shape use QCursor::setShape() or use the QCursor constructor which takes the shape as argument, or you can use one of the predefined cursors defined in the CursorShape enum. +.PP +If you want to create a cursor with your own bitmap, either use the QCursor constructor which takes a bitmap and a mask or the constructor which takes a pixmap as arguments. +.PP +To set or get the position of the mouse cursor use the static methods QCursor::pos() and QCursor::setPos(). +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QWidget, GUI Design Handbook: Cursors, Widget Appearance and Style, and Implicitly and Explicitly Shared Classes. +.PP +On X11, Qt supports the Xcursor library, which allows for full color icon themes. The table below shows the cursor name used for each Qt::CursorShape value. If a cursor cannot be found using the name shown below, a standard X11 cursor will be used instead. Note: X11 does not provide appropriate cursors for all possible Qt::CursorShape values. It is possible that some cursors will be taken from the Xcursor theme, while others will use an internal bitmap cursor. +.PP +<center>.nf +.TS +l - l. Qt::CursorShape Values Cursor Names Qt::ArrowCursor left_ptr Qt::UpArrowCursor up_arrow Qt::CrossCursor cross Qt::WaitCursor wait Qt::BusyCursor left_ptr_watch Qt::IbeamCursor ibeam Qt::SizeVerCursor size_ver Qt::SizeHorCursor size_hor Qt::SizeBDiagCursor size_bdiag Qt::SizeFDiagCursor size_fdiag Qt::SizeAllCursor size_all Qt::SplitVCursor split_v Qt::SplitHCursor split_h Qt::PointingHandCursor pointing_hand Qt::ForbiddenCursor forbidden Qt::WhatsThisCursor +.TE +.fi +</center> +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCursor::QCursor ()" +Constructs a cursor with the default arrow shape. +.SH "QCursor::QCursor ( int shape )" +Constructs a cursor with the specified \fIshape\fR. +.PP +See CursorShape for a list of shapes. +.PP +See also setShape(). +.SH "QCursor::QCursor ( const QBitmap & bitmap, const QBitmap & mask, int hotX = -1, int hotY = -1 )" +Constructs a custom bitmap cursor. +.PP +\fIbitmap\fR and \fImask\fR make up the bitmap. \fIhotX\fR and \fIhotY\fR define the cursor's hot spot. +.PP +If \fIhotX\fR is negative, it is set to the \fCbitmap().width()/2\fR. If \fIhotY\fR is negative, it is set to the \fCbitmap().height()/2\fR. +.PP +The cursor \fIbitmap\fR (B) and \fImask\fR (M) bits are combined like this: +.TP +B=1 and M=1 gives black. +.TP +B=0 and M=1 gives white. +.TP +B=0 and M=0 gives transparent. +.TP +B=1 and M=0 gives an undefined result. +.PP +Use the global Qt color \fCcolor0\fR to draw 0-pixels and \fCcolor1\fR to draw 1-pixels in the bitmaps. +.PP +Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors. +.PP +See also QBitmap::QBitmap() and QBitmap::setMask(). +.SH "QCursor::QCursor ( const QPixmap & pixmap, int hotX = -1, int hotY = -1 )" +Constructs a custom pixmap cursor. +.PP +\fIpixmap\fR is the image. It is usual to give it a mask (set using QPixmap::setMask()). \fIhotX\fR and \fIhotY\fR define the cursor's hot spot. +.PP +If \fIhotX\fR is negative, it is set to the \fCpixmap().width()/2\fR. If \fIhotY\fR is negative, it is set to the \fCpixmap().height()/2\fR. +.PP +Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors. +.PP +Currently, only black-and-white pixmaps can be used. +.PP +See also QPixmap::QPixmap() and QPixmap::setMask(). +.SH "QCursor::QCursor ( const QCursor & c )" +Constructs a copy of the cursor \fIc\fR. +.SH "QCursor::QCursor ( HCURSOR handle )" +Creates a cursor with the specified window system handle \fIhandle\fR. +.PP +\fBWarning:\fR Portable in principle, but if you use it you are probably about to do something non-portable. Be careful. +.SH "QCursor::~QCursor ()" +Destroys the cursor. +.SH "const QBitmap * QCursor::bitmap () const" +Returns the cursor bitmap, or 0 if it is one of the standard cursors. +.SH "void QCursor::cleanup ()\fC [static]\fR" +Internal function that deinitializes the predefined cursors. This function is called from the QApplication destructor. +.PP +See also initialize(). +.SH "HANDLE QCursor::handle () const" +Returns the window system cursor handle. +.PP +\fBWarning:\fR Portable in principle, but if you use it you are probably about to do something non-portable. Be careful. +.SH "QPoint QCursor::hotSpot () const" +Returns the cursor hot spot, or (0, 0) if it is one of the standard cursors. +.SH "void QCursor::initialize ()\fC [static]\fR" +Internal function that initializes the predefined cursors. This function is called from the QApplication constructor. +.PP +See also cleanup(). +.SH "const QBitmap * QCursor::mask () const" +Returns the cursor bitmap mask, or 0 if it is one of the standard cursors. +.SH "QCursor & QCursor::operator= ( const QCursor & c )" +Assigns \fIc\fR to this cursor and returns a reference to this cursor. +.SH "QPoint QCursor::pos ()\fC [static]\fR" +Returns the position of the cursor (hot spot) in global screen coordinates. +.PP +You can call QWidget::mapFromGlobal() to translate it to widget coordinates. +.PP +See also setPos(), QWidget::mapFromGlobal(), and QWidget::mapToGlobal(). +.PP +Examples: +.)l chart/canvasview.cpp, fileiconview/qfileiconview.cpp, and menu/menu.cpp. +.SH "void QCursor::setPos ( int x, int y )\fC [static]\fR" +Moves the cursor (hot spot) to the global screen position (\fIx\fR, \fIy\fR). +.PP +You can call QWidget::mapToGlobal() to translate widget coordinates to global screen coordinates. +.PP +See also pos(), QWidget::mapFromGlobal(), and QWidget::mapToGlobal(). +.SH "void QCursor::setPos ( const QPoint & )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QCursor::setShape ( int shape )" +Sets the cursor to the shape identified by \fIshape\fR. +.PP +See CursorShape for the list of cursor shapes. +.PP +See also shape(). +.SH "int QCursor::shape () const" +Returns the cursor shape identifier. The return value is one of the CursorShape enum values (cast to an int). +.PP +See also setShape(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QCursor & c )" +Writes the cursor \fIc\fR to the stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QCursor & c )" +Reads a cursor from the stream \fIs\fR and sets \fIc\fR to the read data. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqcursor.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcursor.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcustomevent.3qt b/doc/man/man3/tqcustomevent.3qt new file mode 100644 index 000000000..b07740dc3 --- /dev/null +++ b/doc/man/man3/tqcustomevent.3qt @@ -0,0 +1,130 @@ +'\" t +.TH QCustomEvent 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 +QCustomEvent \- Support for custom events +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCustomEvent\fR ( int type )" +.br +.ti -1c +.BI "\fBQCustomEvent\fR ( Type type, void * data )" +.br +.ti -1c +.BI "void * \fBdata\fR () const" +.br +.ti -1c +.BI "void \fBsetData\fR ( void * data )" +.br +.in -1c +.SH DESCRIPTION +The QCustomEvent class provides support for custom events. +.PP +QCustomEvent is a generic event class for user-defined events. User defined events can be sent to widgets or other QObject instances using QApplication::postEvent() or QApplication::sendEvent(). Subclasses of QObject can easily receive custom events by implementing the QObject::customEvent() event handler function. +.PP +QCustomEvent objects should be created with a type ID that uniquely identifies the event type. To avoid clashes with the Qt-defined events types, the value should be at least as large as the value of the "User" entry in the QEvent::Type enum. +.PP +QCustomEvent contains a generic void* data member that may be used for transferring event-specific data to the receiver. Note that since events are normally delivered asynchronously, the data pointer, if used, must remain valid until the event has been received and processed. +.PP +QCustomEvent can be used as-is for simple user-defined event types, but normally you will want to make a subclass of it for your event types. In a subclass, you can add data members that are suitable for your event type. +.PP +Example: +.PP +.nf +.br + class ColorChangeEvent : public QCustomEvent +.br + { +.br + public: +.br + ColorChangeEvent( QColor color ) +.br + : QCustomEvent( 65432 ), c( color ) {} +.br + QColor color() const { return c; } +.br + private: +.br + QColor c; +.br + }; +.br +.br + // To send an event of this custom event type: +.br +.br + ColorChangeEvent* ce = new ColorChangeEvent( blue ); +.br + QApplication::postEvent( receiver, ce ); // Qt will delete it when done +.br +.br + // To receive an event of this custom event type: +.br +.br + void MyWidget::customEvent( QCustomEvent * e ) +.br + { +.br + if ( e->type() == 65432 ) { // It must be a ColorChangeEvent +.br + ColorChangeEvent* ce = (ColorChangeEvent*)e; +.br + newColor = ce->color(); +.br + } +.br + } +.br +.fi +.PP +See also QWidget::customEvent(), QApplication::notify(), and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCustomEvent::QCustomEvent ( int type )" +Constructs a custom event object with event type \fItype\fR. The value of \fItype\fR must be at least as large as QEvent::User. The data pointer is set to 0. +.SH "QCustomEvent::QCustomEvent ( Type type, void * data )" +Constructs a custom event object with the event type \fItype\fR and a pointer to \fIdata\fR. (Note that any int value may safely be cast to QEvent::Type). +.SH "void * QCustomEvent::data () const" +Returns a pointer to the generic event data. +.PP +See also setData(). +.SH "void QCustomEvent::setData ( void * data )" +Sets the generic data pointer to \fIdata\fR. +.PP +See also data(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcustomevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcustomevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqcustommenuitem.3qt b/doc/man/man3/tqcustommenuitem.3qt new file mode 100644 index 000000000..c267a7897 --- /dev/null +++ b/doc/man/man3/tqcustommenuitem.3qt @@ -0,0 +1,106 @@ +'\" t +.TH QCustomMenuItem 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 +QCustomMenuItem \- Abstract base class for custom menu items in popup menus +.SH SYNOPSIS +\fC#include <ntqmenudata.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQCustomMenuItem\fR ()" +.br +.ti -1c +.BI "virtual \fB~QCustomMenuItem\fR ()" +.br +.ti -1c +.BI "virtual bool \fBfullSpan\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisSeparator\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFont\fR ( const QFont & font )" +.br +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * p, const QColorGroup & cg, bool act, bool enabled, int x, int y, int w, int h ) = 0" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QCustomMenuItem class is an abstract base class for custom menu items in popup menus. +.PP +A custom menu item is a menu item that is defined by two pure virtual functions, paint() and sizeHint(). The size hint tells the menu how much space it needs to reserve for this item, and paint is called whenever the item needs painting. +.PP +This simple mechanism allows you to create all kinds of application specific menu items. Examples are items showing different fonts in a word processor or menus that allow the selection of drawing utilities in a vector drawing program. +.PP +A custom item is inserted into a popup menu with QPopupMenu::insertItem(). +.PP +By default, a custom item can also have an icon and a keyboard accelerator. You can reimplement fullSpan() to return TRUE if you want the item to span the entire popup menu width. This is particularly useful for labels. +.PP +If you want the custom item to be treated just as a separator, reimplement isSeparator() to return TRUE. +.PP +Note that you can insert pixmaps or bitmaps as items into a popup menu without needing to create a QCustomMenuItem. However, custom menu items offer more flexibility, and -- especially important with Windows style -- provide the possibility of drawing the item with a different color when it is highlighted. +.PP +menu/menu.cpp shows a simple example how custom menu items can be used. +.PP +Note: the current implementation of QCustomMenuItem will not recognize shortcut keys that are from text with ampersands. Normal accelerators work though. +.PP +.ce 1 +.B "[Image Omitted]" +.PP +See also QMenuData, QPopupMenu, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCustomMenuItem::QCustomMenuItem ()" +Constructs a QCustomMenuItem +.SH "QCustomMenuItem::~QCustomMenuItem ()\fC [virtual]\fR" +Destroys a QCustomMenuItem +.SH "bool QCustomMenuItem::fullSpan () const\fC [virtual]\fR" +Returns TRUE if this item wants to span the entire popup menu width; otherwise returns FALSE. The default is FALSE, meaning that the menu may show an icon and an accelerator key for this item as well. +.SH "bool QCustomMenuItem::isSeparator () const\fC [virtual]\fR" +Returns TRUE if this item is just a separator; otherwise returns FALSE. +.SH "void QCustomMenuItem::paint ( QPainter * p, const QColorGroup & cg, bool act, bool enabled, int x, int y, int w, int h )\fC [pure virtual]\fR" +Paints this item. When this function is invoked, the painter \fIp\fR is set to a font and foreground color suitable for a menu item text using color group \fIcg\fR. The item is active if \fIact\fR is TRUE and enabled if \fIenabled\fR is TRUE. The geometry values \fIx\fR, \fIy\fR, \fIw\fR and \fIh\fR specify where to draw the item. +.PP +Do not draw any background, this has already been done by the popup menu according to the current GUI style. +.SH "void QCustomMenuItem::setFont ( const QFont & font )\fC [virtual]\fR" +Sets the font of the custom menu item to \fIfont\fR. +.PP +This function is called whenever the font in the popup menu changes. For menu items that show their own individual font entry, you want to ignore this. +.SH "QSize QCustomMenuItem::sizeHint ()\fC [pure virtual]\fR" +Returns the item's size hint. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcustommenuitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqcustommenuitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdatabrowser.3qt b/doc/man/man3/tqdatabrowser.3qt new file mode 100644 index 000000000..c564cc465 --- /dev/null +++ b/doc/man/man3/tqdatabrowser.3qt @@ -0,0 +1,593 @@ +'\" t +.TH QDataBrowser 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 +QDataBrowser \- Data manipulation and navigation for data entry forms +.SH SYNOPSIS +\fC#include <ntqdatabrowser.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDataBrowser\fR ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" +.br +.ti -1c +.BI "\fB~QDataBrowser\fR ()" +.br +.ti -1c +.BI "enum \fBBoundary\fR { Unknown, None, BeforeBeginning, Beginning, End, AfterEnd }" +.br +.ti -1c +.BI "Boundary \fBboundary\fR ()" +.br +.ti -1c +.BI "void \fBsetBoundaryChecking\fR ( bool active )" +.br +.ti -1c +.BI "bool \fBboundaryChecking\fR () const" +.br +.ti -1c +.BI "void \fBsetSort\fR ( const QSqlIndex & sort )" +.br +.ti -1c +.BI "void \fBsetSort\fR ( const QStringList & sort )" +.br +.ti -1c +.BI "QStringList \fBsort\fR () const" +.br +.ti -1c +.BI "void \fBsetFilter\fR ( const QString & filter )" +.br +.ti -1c +.BI "QString \fBfilter\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSqlCursor\fR ( QSqlCursor * cursor, bool autoDelete = FALSE )" +.br +.ti -1c +.BI "QSqlCursor * \fBsqlCursor\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetForm\fR ( QSqlForm * form )" +.br +.ti -1c +.BI "QSqlForm * \fBform\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetConfirmEdits\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmInsert\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmUpdate\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmDelete\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmCancels\fR ( bool confirm )" +.br +.ti -1c +.BI "bool \fBconfirmEdits\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmInsert\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmUpdate\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmDelete\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmCancels\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetReadOnly\fR ( bool active )" +.br +.ti -1c +.BI "bool \fBisReadOnly\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoEdit\fR ( bool autoEdit )" +.br +.ti -1c +.BI "bool \fBautoEdit\fR () const" +.br +.ti -1c +.BI "virtual bool \fBseek\fR ( int i, bool relative = FALSE )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBrefresh\fR ()" +.br +.ti -1c +.BI "virtual void \fBinsert\fR ()" +.br +.ti -1c +.BI "virtual void \fBupdate\fR ()" +.br +.ti -1c +.BI "virtual void \fBdel\fR ()" +.br +.ti -1c +.BI "virtual void \fBfirst\fR ()" +.br +.ti -1c +.BI "virtual void \fBlast\fR ()" +.br +.ti -1c +.BI "virtual void \fBnext\fR ()" +.br +.ti -1c +.BI "virtual void \fBprev\fR ()" +.br +.ti -1c +.BI "virtual void \fBreadFields\fR ()" +.br +.ti -1c +.BI "virtual void \fBwriteFields\fR ()" +.br +.ti -1c +.BI "virtual void \fBclearValues\fR ()" +.br +.ti -1c +.BI "void \fBupdateBoundary\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBfirstRecordAvailable\fR ( bool available )" +.br +.ti -1c +.BI "void \fBlastRecordAvailable\fR ( bool available )" +.br +.ti -1c +.BI "void \fBnextRecordAvailable\fR ( bool available )" +.br +.ti -1c +.BI "void \fBprevRecordAvailable\fR ( bool available )" +.br +.ti -1c +.BI "void \fBcurrentChanged\fR ( const QSqlRecord * record )" +.br +.ti -1c +.BI "void \fBprimeInsert\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBprimeUpdate\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBprimeDelete\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBbeforeInsert\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBbeforeUpdate\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBbeforeDelete\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBcursorChanged\fR ( QSqlCursor::Mode mode )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoEdit\fR - whether the browser automatically applies edits" +.br +.ti -1c +.BI "bool \fBboundaryChecking\fR - whether boundary checking is active" +.br +.ti -1c +.BI "bool \fBconfirmCancels\fR - whether the browser confirms cancel operations" +.br +.ti -1c +.BI "bool \fBconfirmDelete\fR - whether the browser confirms deletions" +.br +.ti -1c +.BI "bool \fBconfirmEdits\fR - whether the browser confirms edits" +.br +.ti -1c +.BI "bool \fBconfirmInsert\fR - whether the data browser confirms insertions" +.br +.ti -1c +.BI "bool \fBconfirmUpdate\fR - whether the browser confirms updates" +.br +.ti -1c +.BI "QString \fBfilter\fR - the data browser's filter" +.br +.ti -1c +.BI "bool \fBreadOnly\fR - whether the browser is read-only" +.br +.ti -1c +.BI "QStringList \fBsort\fR - the data browser's sort" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBinsertCurrent\fR ()" +.br +.ti -1c +.BI "virtual bool \fBupdateCurrent\fR ()" +.br +.ti -1c +.BI "virtual bool \fBdeleteCurrent\fR ()" +.br +.ti -1c +.BI "virtual bool \fBcurrentEdited\fR ()" +.br +.ti -1c +.BI "virtual QSql::Confirm \fBconfirmEdit\fR ( QSql::Op m )" +.br +.ti -1c +.BI "virtual QSql::Confirm \fBconfirmCancel\fR ( QSql::Op m )" +.br +.ti -1c +.BI "virtual void \fBhandleError\fR ( const QSqlError & error )" +.br +.in -1c +.SH DESCRIPTION +The QDataBrowser class provides data manipulation and navigation for data entry forms. +.PP +A high-level API is provided for navigating through data records in a cursor, for inserting, updating and deleting records, and for refreshing data in the display. +.PP +If you want a read-only form to present database data use QDataView; if you want a table-based presentation of your data use QDataTable. +.PP +A QDataBrowser is used to associate a dataset with a form in much the same way as a QDataTable associates a dataset with a table. Once the data browser has been constructed it can be associated with a dataset with setSqlCursor(), and with a form with setForm(). Boundary checking, sorting and filtering can be set with setBoundaryChecking(), setSort() and setFilter(), respectively. +.PP +The insertCurrent() function reads the fields from the default form into the default cursor and performs the insert. The updateCurrent() and deleteCurrent() functions perform similarly to update and delete the current record respectively. +.PP +The user can be asked to confirm all edits with setConfirmEdits(). For more precise control use setConfirmInsert(), setConfirmUpdate(), setConfirmDelete() and setConfirmCancels(). Use setAutoEdit() to control the behaviour of the form when the user edits a record and then navigates. +.PP +The record set is navigated using first(), next(), prev(), last() and seek(). The form's display is updated with refresh(). When navigation takes place the firstRecordAvailable(), lastRecordAvailable(), nextRecordAvailable() and prevRecordAvailable() signals are emitted. When the cursor record is changed due to navigation the cursorChanged() signal is emitted. +.PP +If you want finer control of the insert, update and delete processes then you can use the lower level functions to perform these operations as described below. +.PP +The form is populated with data from the database with readFields(). If the user is allowed to edit, (see setReadOnly()), write the form's data back to the cursor's edit buffer with writeFields(). You can clear the values in the form with clearValues(). Editing is performed as follows: +.TP +\fIinsert\fR When the data browser enters insertion mode it emits the primeInsert() signal which you can connect to, for example to pre-populate fields. Call writeFields() to write the user's edits to the cursor's edit buffer then call insert() to insert the record into the database. The beforeInsert() signal is emitted just before the cursor's edit buffer is inserted into the database; connect to this for example, to populate fields such as an auto-generated primary key. +.TP +\fIupdate\fR For updates the primeUpdate() signal is emitted when the data browser enters update mode. After calling writeFields() call update() to update the record and connect to the beforeUpdate() signal to manipulate the user's data before the update takes place. +.TP +\fIdelete\fR For deletion the primeDelete() signal is emitted when the data browser enters deletion mode. After calling writeFields() call del() to delete the record and connect to the beforeDelete() signal, for example to record an audit of the deleted record. +.PP +See also Database Classes. +.SS "Member Type Documentation" +.SH "QDataBrowser::Boundary" +This enum describes where the data browser is positioned. +.TP +\fCQDataBrowser::Unknown\fR - the boundary cannot be determined (usually because there is no default cursor, or the default cursor is not active). +.TP +\fCQDataBrowser::None\fR - the browser is not positioned on a boundary, but it is positioned on a record somewhere in the middle. +.TP +\fCQDataBrowser::BeforeBeginning\fR - the browser is positioned before the first available record. +.TP +\fCQDataBrowser::Beginning\fR - the browser is positioned at the first record. +.TP +\fCQDataBrowser::End\fR - the browser is positioned at the last record. +.TP +\fCQDataBrowser::AfterEnd\fR - the browser is positioned after the last available record. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDataBrowser::QDataBrowser ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" +Constructs a data browser which is a child of \fIparent\fR, with the name \fIname\fR and widget flags set to \fIfl\fR. +.SH "QDataBrowser::~QDataBrowser ()" +Destroys the object and frees any allocated resources. +.SH "bool QDataBrowser::autoEdit () const" +Returns TRUE if the browser automatically applies edits; otherwise returns FALSE. See the "autoEdit" property for details. +.SH "void QDataBrowser::beforeDelete ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted just before the cursor's edit buffer is deleted from the database. The \fIbuf\fR parameter points to the edit buffer being deleted. You might connect to this signal to capture some auditing information about the deletion. +.SH "void QDataBrowser::beforeInsert ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted just before the cursor's edit buffer is inserted into the database. The \fIbuf\fR parameter points to the edit buffer being inserted. You might connect to this signal to populate a generated primary key for example. +.SH "void QDataBrowser::beforeUpdate ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted just before the cursor's edit buffer is updated in the database. The \fIbuf\fR parameter points to the edit buffer being updated. You might connect to this signal to capture some auditing information about the update. +.SH "Boundary QDataBrowser::boundary ()" +Returns an enum indicating the boundary status of the browser. +.PP +This is achieved by moving the default cursor and checking the position, however the current default form values will not be altered. After checking for the boundary, the cursor is moved back to its former position. See QDataBrowser::Boundary. +.PP +See also Boundary. +.SH "bool QDataBrowser::boundaryChecking () const" +Returns TRUE if boundary checking is active; otherwise returns FALSE. See the "boundaryChecking" property for details. +.SH "void QDataBrowser::clearValues ()\fC [virtual slot]\fR" +Clears all the values in the form. +.PP +All the edit buffer field values are set to their 'zero state', e.g. 0 for numeric fields and "" for string fields. Then the widgets are updated using the property map. For example, a combobox that is property-mapped to integers would scroll to the first item. See the QSqlPropertyMap constructor for the default mappings of widgets to properties. +.SH "QSql::Confirm QDataBrowser::confirmCancel ( QSql::Op m )\fC [virtual protected]\fR" +Protected virtual function which returns a confirmation for cancelling an edit mode \fIm\fR. Derived classes can reimplement this function and provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action. +.SH "bool QDataBrowser::confirmCancels () const" +Returns TRUE if the browser confirms cancel operations; otherwise returns FALSE. See the "confirmCancels" property for details. +.SH "bool QDataBrowser::confirmDelete () const" +Returns TRUE if the browser confirms deletions; otherwise returns FALSE. See the "confirmDelete" property for details. +.SH "QSql::Confirm QDataBrowser::confirmEdit ( QSql::Op m )\fC [virtual protected]\fR" +Protected virtual function which returns a confirmation for an edit of mode \fIm\fR. Derived classes can reimplement this function and provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action. +.SH "bool QDataBrowser::confirmEdits () const" +Returns TRUE if the browser confirms edits; otherwise returns FALSE. See the "confirmEdits" property for details. +.SH "bool QDataBrowser::confirmInsert () const" +Returns TRUE if the data browser confirms insertions; otherwise returns FALSE. See the "confirmInsert" property for details. +.SH "bool QDataBrowser::confirmUpdate () const" +Returns TRUE if the browser confirms updates; otherwise returns FALSE. See the "confirmUpdate" property for details. +.SH "void QDataBrowser::currentChanged ( const QSqlRecord * record )\fC [signal]\fR" +This signal is emitted whenever the current cursor position changes. The \fIrecord\fR parameter points to the contents of the current cursor's record. +.SH "bool QDataBrowser::currentEdited ()\fC [virtual protected]\fR" +Returns TRUE if the form's edit buffer differs from the current cursor buffer; otherwise returns FALSE. +.SH "void QDataBrowser::cursorChanged ( QSqlCursor::Mode mode )\fC [signal]\fR" +This signal is emitted whenever the cursor record was changed due to navigation. The \fImode\fR parameter is the edit that just took place, e.g. Insert, Update or Delete. See QSqlCursor::Mode. +.SH "void QDataBrowser::del ()\fC [virtual slot]\fR" +Performs a delete operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens. +.PP +Otherwise, the following happens: +.PP +The current form's record is deleted from the database, providing that the data browser is not in insert mode. If the data browser is actively inserting a record (see insert()), the insert action is canceled, and the browser navigates to the last valid record that was current. If there is an error, handleError() is called. +.SH "bool QDataBrowser::deleteCurrent ()\fC [virtual protected]\fR" +Performs a delete on the default cursor using the values from the default form and updates the default form. If there is no default form or no default cursor, nothing happens. If the deletion was successful, the cursor is repositioned to the nearest record and TRUE is returned. The nearest record is the next record if there is one otherwise the previous record if there is one. If an error occurred during the deletion from the database, handleError() is called and FALSE is returned. +.PP +See also cursor, form(), and handleError(). +.SH "QString QDataBrowser::filter () const" +Returns the data browser's filter. See the "filter" property for details. +.SH "void QDataBrowser::first ()\fC [virtual slot]\fR" +Moves the default cursor to the first record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the first record, the default cursor is primed for update and the primeUpdate() signal is emitted. +.PP +If the browser is already positioned on the first record nothing happens. +.SH "void QDataBrowser::firstRecordAvailable ( bool available )\fC [signal]\fR" +This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the first record in the default cursor is available. +.SH "QSqlForm * QDataBrowser::form ()" +Returns the data browser's default form or 0 if no form has been set. +.SH "void QDataBrowser::handleError ( const QSqlError & error )\fC [virtual protected]\fR" +Virtual function which handles the error \fIerror\fR. The default implementation warns the user with a message box. +.SH "void QDataBrowser::insert ()\fC [virtual slot]\fR" +Performs an insert operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens. +.PP +If auto-editing is on (see setAutoEdit()), the following happens: +.TP +If the browser is already actively inserting a record, the current form's data is inserted into the database. +.TP +If the browser is not inserting a record, but the current record was changed by the user, the record is updated in the database with the current form's data (i.e. with the changes). +.PP +If there is an error handling any of the above auto-edit actions, handleError() is called and no insert or update is performed. +.PP +If no error occurred, or auto-editing is not enabled, the data browser begins actively inserting a record into the database by performing the following actions: +.TP +The default cursor is primed for insert using QSqlCursor::primeInsert(). +.TP +The primeInsert() signal is emitted. +.TP +The form is updated with the values in the default cursor's. edit buffer so that the user can fill in the values to be inserted. +.SH "bool QDataBrowser::insertCurrent ()\fC [virtual protected]\fR" +Reads the fields from the default form into the default cursor and performs an insert on the default cursor. If there is no default form or no default cursor, nothing happens. If an error occurred during the insert into the database, handleError() is called and FALSE is returned. If the insert was successfull, the cursor is refreshed and relocated to the newly inserted record, the cursorChanged() signal is emitted, and TRUE is returned. +.PP +See also cursorChanged(), sqlCursor(), form(), and handleError(). +.SH "bool QDataBrowser::isReadOnly () const" +Returns TRUE if the browser is read-only; otherwise returns FALSE. See the "readOnly" property for details. +.SH "void QDataBrowser::last ()\fC [virtual slot]\fR" +Moves the default cursor to the last record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the last record, the default cursor is primed for update and the primeUpdate() signal is emitted. +.PP +If the browser is already positioned on the last record nothing happens. +.SH "void QDataBrowser::lastRecordAvailable ( bool available )\fC [signal]\fR" +This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the last record in the default cursor is available. +.SH "void QDataBrowser::next ()\fC [virtual slot]\fR" +Moves the default cursor to the next record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the next record, the default cursor is primed for update and the primeUpdate() signal is emitted. +.PP +If the browser is positioned on the last record nothing happens. +.SH "void QDataBrowser::nextRecordAvailable ( bool available )\fC [signal]\fR" +This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the next record in the default cursor is available. +.SH "void QDataBrowser::prev ()\fC [virtual slot]\fR" +Moves the default cursor to the previous record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the previous record, the default cursor is primed for update and the primeUpdate() signal is emitted. +.PP +If the browser is positioned on the first record nothing happens. +.SH "void QDataBrowser::prevRecordAvailable ( bool available )\fC [signal]\fR" +This signal is emitted whenever the position of the cursor changes. The \fIavailable\fR parameter indicates whether or not the previous record in the default cursor is available. +.SH "void QDataBrowser::primeDelete ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted when the data browser enters deletion mode. The \fIbuf\fR parameter points to the record buffer being deleted. (Note that QSqlCursor::primeDelete() is \fInot\fR called on the default cursor, as this would corrupt values in the form.) Connect to this signal in order to, for example, save a copy of the deleted record for auditing purposes. +.PP +See also del(). +.SH "void QDataBrowser::primeInsert ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted when the data browser enters insertion mode. The \fIbuf\fR parameter points to the record buffer that is to be inserted. Connect to this signal to, for example, prime the record buffer with default data values, auto-numbered fields etc. (Note that QSqlCursor::primeInsert() is \fInot\fR called on the default cursor, as this would corrupt values in the form.) +.PP +See also insert(). +.SH "void QDataBrowser::primeUpdate ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted when the data browser enters update mode. Note that during navigation (first(), last(), next(), prev()), each record that is shown in the default form is primed for update. The \fIbuf\fR parameter points to the record buffer being updated. (Note that QSqlCursor::primeUpdate() is \fInot\fR called on the default cursor, as this would corrupt values in the form.) Connect to this signal in order to, for example, keep track of which records have been updated, perhaps for auditing purposes. +.PP +See also update(). +.SH "void QDataBrowser::readFields ()\fC [virtual slot]\fR" +Reads the fields from the default cursor's edit buffer and displays them in the form. If there is no default cursor or no default form, nothing happens. +.SH "void QDataBrowser::refresh ()\fC [virtual slot]\fR" +Refreshes the data browser's data using the default cursor. The browser's current filter and sort are applied if they have been set. +.PP +See also filter and sort. +.SH "bool QDataBrowser::seek ( int i, bool relative = FALSE )\fC [virtual]\fR" +Moves the default cursor to the record specified by the index \fIi\fR and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If \fIrelative\fR is TRUE (the default is FALSE), the cursor is moved relative to its current position. If the data browser successfully navigated to the desired record, the default cursor is primed for update and the primeUpdate() signal is emitted. +.PP +If the browser is already positioned on the desired record nothing happens. +.SH "void QDataBrowser::setAutoEdit ( bool autoEdit )\fC [virtual]\fR" +Sets whether the browser automatically applies edits to \fIautoEdit\fR. See the "autoEdit" property for details. +.SH "void QDataBrowser::setBoundaryChecking ( bool active )" +Sets whether boundary checking is active to \fIactive\fR. See the "boundaryChecking" property for details. +.SH "void QDataBrowser::setConfirmCancels ( bool confirm )\fC [virtual]\fR" +Sets whether the browser confirms cancel operations to \fIconfirm\fR. See the "confirmCancels" property for details. +.SH "void QDataBrowser::setConfirmDelete ( bool confirm )\fC [virtual]\fR" +Sets whether the browser confirms deletions to \fIconfirm\fR. See the "confirmDelete" property for details. +.SH "void QDataBrowser::setConfirmEdits ( bool confirm )\fC [virtual]\fR" +Sets whether the browser confirms edits to \fIconfirm\fR. See the "confirmEdits" property for details. +.SH "void QDataBrowser::setConfirmInsert ( bool confirm )\fC [virtual]\fR" +Sets whether the data browser confirms insertions to \fIconfirm\fR. See the "confirmInsert" property for details. +.SH "void QDataBrowser::setConfirmUpdate ( bool confirm )\fC [virtual]\fR" +Sets whether the browser confirms updates to \fIconfirm\fR. See the "confirmUpdate" property for details. +.SH "void QDataBrowser::setFilter ( const QString & filter )" +Sets the data browser's filter to \fIfilter\fR. See the "filter" property for details. +.SH "void QDataBrowser::setForm ( QSqlForm * form )\fC [virtual]\fR" +Sets the browser's default form to \fIform\fR. The cursor and all navigation and data manipulation functions that the browser provides become available to the \fIform\fR. +.SH "void QDataBrowser::setReadOnly ( bool active )\fC [virtual]\fR" +Sets whether the browser is read-only to \fIactive\fR. See the "readOnly" property for details. +.SH "void QDataBrowser::setSort ( const QStringList & sort )" +Sets the data browser's sort to \fIsort\fR. See the "sort" property for details. +.SH "void QDataBrowser::setSort ( const QSqlIndex & sort )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the data browser's sort to the QSqlIndex \fIsort\fR. To apply the new sort, use refresh(). +.SH "void QDataBrowser::setSqlCursor ( QSqlCursor * cursor, bool autoDelete = FALSE )\fC [virtual]\fR" +Sets the default cursor used by the data browser to \fIcursor\fR. If \fIautoDelete\fR is TRUE (the default is FALSE), the data browser takes ownership of the \fIcursor\fR pointer, which will be deleted when the browser is destroyed, or when setSqlCursor() is called again. To activate the \fIcursor\fR use refresh(). The cursor's edit buffer is used in the default form to browse and edit records. +.PP +See also sqlCursor(), form(), and setForm(). +.SH "QStringList QDataBrowser::sort () const" +Returns the data browser's sort. See the "sort" property for details. +.SH "QSqlCursor * QDataBrowser::sqlCursor () const" +Returns the default cursor used for navigation, or 0 if there is no default cursor. +.PP +See also setSqlCursor(). +.SH "void QDataBrowser::update ()\fC [virtual slot]\fR" +Performs an update operation on the data browser's cursor. +.PP +If there is no default cursor or no default form, nothing happens. Otherwise, the following happens: +.PP +If the data browser is actively inserting a record (see insert()), that record is inserted into the database using insertCurrent(). Otherwise, the database is updated with the current form's data using updateCurrent(). If there is an error handling either action, handleError() is called. +.SH "void QDataBrowser::updateBoundary ()\fC [slot]\fR" +If boundaryChecking() is TRUE, checks the boundary of the current default cursor and emits signals which indicate the position of the cursor. +.SH "bool QDataBrowser::updateCurrent ()\fC [virtual protected]\fR" +Reads the fields from the default form into the default cursor and performs an update on the default cursor. If there is no default form or no default cursor, nothing happens. If an error occurred during the update on the database, handleError() is called and FALSE is returned. If the update was successfull, the cursor is refreshed and relocated to the updated record, the cursorChanged() signal is emitted, and TRUE is returned. +.PP +See also cursor, form(), and handleError(). +.SH "void QDataBrowser::writeFields ()\fC [virtual slot]\fR" +Writes the form's data to the default cursor's edit buffer. If there is no default cursor or no default form, nothing happens. +.SS "Property Documentation" +.SH "bool autoEdit" +This property holds whether the browser automatically applies edits. +.PP +The default value for this property is TRUE. When the user begins an insertion or an update on a form there are two possible outcomes when they navigate to another record: +.TP +the insert or update is is performed -- this occurs if autoEdit is TRUE +.TP +the insert or update is discarded -- this occurs if autoEdit is FALSE +.PP +Set this property's value with setAutoEdit() and get this property's value with autoEdit(). +.SH "bool boundaryChecking" +This property holds whether boundary checking is active. +.PP +When boundary checking is active (the default), signals are emitted indicating the current position of the default cursor. +.PP +See also boundary(). +.PP +Set this property's value with setBoundaryChecking() and get this property's value with boundaryChecking(). +.SH "bool confirmCancels" +This property holds whether the browser confirms cancel operations. +.PP +If this property is TRUE, all cancels must be confirmed by the user through a message box (this behavior can be changed by overriding the confirmCancel() function), otherwise all cancels occur immediately. The default is FALSE. +.PP +See also confirmEdits and confirmCancel(). +.PP +Set this property's value with setConfirmCancels() and get this property's value with confirmCancels(). +.SH "bool confirmDelete" +This property holds whether the browser confirms deletions. +.PP +If this property is TRUE, the browser confirms deletions, otherwise deletions happen immediately. +.PP +See also confirmCancels, confirmEdits, confirmUpdate, confirmInsert, and confirmEdit(). +.PP +Set this property's value with setConfirmDelete() and get this property's value with confirmDelete(). +.SH "bool confirmEdits" +This property holds whether the browser confirms edits. +.PP +If this property is TRUE, the browser confirms all edit operations (insertions, updates and deletions), otherwise all edit operations happen immediately. Confirmation is achieved by presenting the user with a message box -- this behavior can be changed by reimplementing the confirmEdit() function, +.PP +See also confirmEdit(), confirmCancels, confirmInsert, confirmUpdate, and confirmDelete. +.PP +Set this property's value with setConfirmEdits() and get this property's value with confirmEdits(). +.SH "bool confirmInsert" +This property holds whether the data browser confirms insertions. +.PP +If this property is TRUE, the browser confirms insertions, otherwise insertions happen immediately. +.PP +See also confirmCancels, confirmEdits, confirmUpdate, confirmDelete, and confirmEdit(). +.PP +Set this property's value with setConfirmInsert() and get this property's value with confirmInsert(). +.SH "bool confirmUpdate" +This property holds whether the browser confirms updates. +.PP +If this property is TRUE, the browser confirms updates, otherwise updates happen immediately. +.PP +See also confirmCancels, confirmEdits, confirmInsert, confirmDelete, and confirmEdit(). +.PP +Set this property's value with setConfirmUpdate() and get this property's value with confirmUpdate(). +.SH "QString filter" +This property holds the data browser's filter. +.PP +The filter applies to the data shown in the browser. Call refresh() to apply the new filter. A filter is a string containing a SQL WHERE clause without the WHERE keyword, e.g. "id>1000"," name LIKE 'A%'", etc. +.PP +There is no default filter. +.PP +See also sort. +.PP +Set this property's value with setFilter() and get this property's value with filter(). +.SH "bool readOnly" +This property holds whether the browser is read-only. +.PP +The default is FALSE, i.e. data can be edited. If the data browser is read-only, no database edits will be allowed. +.PP +Set this property's value with setReadOnly() and get this property's value with isReadOnly(). +.SH "QStringList sort" +This property holds the data browser's sort. +.PP +The data browser's sort affects the order in which records are viewed in the browser. Call refresh() to apply the new sort. +.PP +When retrieving the sort property, a string list is returned in the form 'fieldname order', e.g. 'id ASC', 'surname DESC'. +.PP +There is no default sort. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myDataBrowser.sort(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +Set this property's value with setSort() and get this property's value with sort(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdatabrowser.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdatabrowser.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdatastream.3qt b/doc/man/man3/tqdatastream.3qt new file mode 100644 index 000000000..dcd294d73 --- /dev/null +++ b/doc/man/man3/tqdatastream.3qt @@ -0,0 +1,563 @@ +'\" t +.TH QDataStream 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 +QDataStream \- Serialization of binary data to a QIODevice +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdatastream.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDataStream\fR ()" +.br +.ti -1c +.BI "\fBQDataStream\fR ( QIODevice * d )" +.br +.ti -1c +.BI "\fBQDataStream\fR ( QByteArray a, int mode )" +.br +.ti -1c +.BI "virtual \fB~QDataStream\fR ()" +.br +.ti -1c +.BI "QIODevice * \fBdevice\fR () const" +.br +.ti -1c +.BI "void \fBsetDevice\fR ( QIODevice * d )" +.br +.ti -1c +.BI "void \fBunsetDevice\fR ()" +.br +.ti -1c +.BI "bool \fBatEnd\fR () const" +.br +.ti -1c +.BI "bool eof () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "enum \fBByteOrder\fR { BigEndian, LittleEndian }" +.br +.ti -1c +.BI "int \fBbyteOrder\fR () const" +.br +.ti -1c +.BI "void \fBsetByteOrder\fR ( int bo )" +.br +.ti -1c +.BI "bool \fBisPrintableData\fR () const" +.br +.ti -1c +.BI "void \fBsetPrintableData\fR ( bool enable )" +.br +.ti -1c +.BI "int \fBversion\fR () const" +.br +.ti -1c +.BI "void \fBsetVersion\fR ( int v )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_INT8 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT8 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_INT16 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT16 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_INT32 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT32 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_INT64 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT64 & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_LONG & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( TQ_ULONG & i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( float & f )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( double & f )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( char *& s )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_INT8 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT8 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_INT16 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT16 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_INT32 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT32 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_INT64 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT64 i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_LONG i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( TQ_ULONG i )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( float f )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( double f )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( const char * s )" +.br +.ti -1c +.BI "QDataStream & \fBreadBytes\fR ( char *& s, uint & l )" +.br +.ti -1c +.BI "QDataStream & \fBreadRawBytes\fR ( char * s, uint len )" +.br +.ti -1c +.BI "QDataStream & \fBwriteBytes\fR ( const char * s, uint len )" +.br +.ti -1c +.BI "QDataStream & \fBwriteRawBytes\fR ( const char * s, uint len )" +.br +.in -1c +.SH DESCRIPTION +The QDataStream class provides serialization of binary data to a QIODevice. +.PP +A data stream is a binary stream of encoded information which is 100% independent of the host computer's operating system, CPU or byte order. For example, a data stream that is written by a PC under Windows can be read by a Sun SPARC running Solaris. +.PP +You can also use a data stream to read/write raw unencoded binary data. If you want a "parsing" input stream, see QTextStream. +.PP +The QDataStream class implements the serialization of C++'s basic data types, like \fCchar\fR, \fCshort\fR, \fCint\fR, \fCchar*\fR, etc. Serialization of more complex data is accomplished by breaking up the data into primitive units. +.PP +A data stream cooperates closely with a QIODevice. A QIODevice represents an input/output medium one can read data from and write data to. The QFile class is an example of an IO device. +.PP +Example (write binary data to a stream): +.PP +.nf +.br + QFile file( "file.dat" ); +.br + file.open( IO_WriteOnly ); +.br + QDataStream stream( &file ); // we will serialize the data into the file +.br + stream << "the answer is"; // serialize a string +.br + stream << (TQ_INT32)42; // serialize an integer +.br +.fi +.PP +Example (read binary data from a stream): +.PP +.nf +.br + QFile file( "file.dat" ); +.br + file.open( IO_ReadOnly ); +.br + QDataStream stream( &file ); // read the data serialized from the file +.br + QString str; +.br + TQ_INT32 a; +.br + stream >> str >> a; // extract "the answer is" and 42 +.br +.fi +.PP +Each item written to the stream is written in a predefined binary format that varies depending on the item's type. Supported Qt types include QBrush, QColor, QDateTime, QFont, QPixmap, QString, QVariant and many others. For the complete list of all Qt types supporting data streaming see the Format of the QDataStream operators. +.PP +For integers it is best to always cast to a Qt integer type for writing, and to read back into the same Qt integer type. This ensures that you get integers of the size you want and insulates you from compiler and platform differences. +.PP +To take one example, a \fCchar*\fR string is written as a 32-bit integer equal to the length of the string including the NUL byte ('\0'), followed by all the characters of the string including the NUL byte. When reading a \fCchar*\fR string, 4 bytes are read to create the 32-bit length value, then that many characters for the \fCchar*\fR string including the NUL are read. +.PP +The initial IODevice is usually set in the constructor, but can be changed with setDevice(). If you've reached the end of the data (or if there is no IODevice set) atEnd() will return TRUE. +.PP +If you want the data to be compatible with an earlier version of Qt use setVersion(). +.PP +If you want the data to be human-readable, e.g. for debugging, you can set the data stream into printable data mode with setPrintableData(). The data is then written slower, in a bloated but human readable format. +.PP +If you are producing a new binary data format, such as a file format for documents created by your application, you could use a QDataStream to write the data in a portable format. Typically, you would write a brief header containing a magic string and a version number to give yourself room for future expansion. For example: +.PP +.nf +.br + QFile file( "file.xxx" ); +.br + file.open( IO_WriteOnly ); +.br + QDataStream stream( &file ); +.br +.br + // Write a header with a "magic number" and a version +.br + stream << (TQ_UINT32)0xA0B0C0D0; +.br + stream << (TQ_INT32)123; +.br +.br + // Write the data +.br + stream << [lots of interesting data] +.br +.fi +.PP +Then read it in with: +.PP +.nf +.br + QFile file( "file.xxx" ); +.br + file.open( IO_ReadOnly ); +.br + QDataStream stream( &file ); +.br +.br + // Read and check the header +.br + TQ_UINT32 magic; +.br + stream >> magic; +.br + if ( magic != 0xA0B0C0D0 ) +.br + return XXX_BAD_FILE_FORMAT; +.br +.br + // Read the version +.br + TQ_INT32 version; +.br + stream >> version; +.br + if ( version < 100 ) +.br + return XXX_BAD_FILE_TOO_OLD; +.br + if ( version > 123 ) +.br + return XXX_BAD_FILE_TOO_NEW; +.br + if ( version <= 110 ) +.br + stream.setVersion(1); +.br +.br + // Read the data +.br + stream >> [lots of interesting data]; +.br + if ( version > 120 ) +.br + stream >> [data new in XXX version 1.2]; +.br + stream >> [other interesting data]; +.br +.fi +.PP +You can select which byte order to use when serializing data. The default setting is big endian (MSB first). Changing it to little endian breaks the portability (unless the reader also changes to little endian). We recommend keeping this setting unless you have special requirements. +.SH "Reading and writing raw binary data" +You may wish to read/write your own raw binary data to/from the data stream directly. Data may be read from the stream into a preallocated char* using readRawBytes(). Similarly data can be written to the stream using writeRawBytes(). Notice that any encoding/decoding of the data must be done by you. +.PP +A similar pair of functions is readBytes() and writeBytes(). These differ from their \fIraw\fR counterparts as follows: readBytes() reads a TQ_UINT32 which is taken to be the length of the data to be read, then that number of bytes is read into the preallocated char*; writeBytes() writes a TQ_UINT32 containing the length of the data, followed by the data. Notice that any encoding/decoding of the data (apart from the length TQ_UINT32) must be done by you. +.PP +See also QTextStream, QVariant, and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QDataStream::ByteOrder" +The byte order used for reading/writing the data. +.TP +\fCQDataStream::BigEndian\fR - the default +.TP +\fCQDataStream::LittleEndian\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDataStream::QDataStream ()" +Constructs a data stream that has no IO device. +.PP +See also setDevice(). +.SH "QDataStream::QDataStream ( QIODevice * d )" +Constructs a data stream that uses the IO device \fId\fR. +.PP +\fBWarning:\fR If you use QSocket or QSocketDevice as the IO device \fId\fR for reading data, you must make sure that enough data is available on the socket for the operation to successfully proceed; QDataStream does not have any means to handle or recover from short-reads. +.PP +See also setDevice() and device(). +.SH "QDataStream::QDataStream ( QByteArray a, int mode )" +Constructs a data stream that operates on a byte array, \fIa\fR, through an internal QBuffer device. The \fImode\fR is a QIODevice::mode(), usually either IO_ReadOnly or IO_WriteOnly. +.PP +Example: +.PP +.nf +.br + static char bindata[] = { 231, 1, 44, ... }; +.br + QByteArray a; +.br + a.setRawData( bindata, sizeof(bindata) ); // a points to bindata +.br + QDataStream stream( a, IO_ReadOnly ); // open on a's data +.br + stream >> [something]; // read raw bindata +.br + a.resetRawData( bindata, sizeof(bindata) ); // finished +.br +.fi +.PP +The QByteArray::setRawData() function is not for the inexperienced. +.SH "QDataStream::~QDataStream ()\fC [virtual]\fR" +Destroys the data stream. +.PP +The destructor will not affect the current IO device, unless it is an internal IO device processing a QByteArray passed in the \fIconstructor\fR, in which case the internal IO device is destroyed. +.SH "bool QDataStream::atEnd () const" +Returns TRUE if the IO device has reached the end position (end of the stream or file) or if there is no IO device set; otherwise returns FALSE, i.e. if the current position of the IO device is before the end position. +.PP +See also QIODevice::atEnd(). +.SH "int QDataStream::byteOrder () const" +Returns the current byte order setting -- either BigEndian or LittleEndian. +.PP +See also setByteOrder(). +.SH "QIODevice * QDataStream::device () const" +Returns the IO device currently set. +.PP +See also setDevice() and unsetDevice(). +.SH "bool QDataStream::eof () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if the IO device has reached the end position (end of stream or file) or if there is no IO device set. +.PP +Returns FALSE if the current position of the read/write head of the IO device is somewhere before the end position. +.PP +See also QIODevice::atEnd(). +.SH "bool QDataStream::isPrintableData () const" +Returns TRUE if the printable data flag has been set; otherwise returns FALSE. +.PP +See also setPrintableData(). +.SH "QDataStream & QDataStream::operator<< ( TQ_INT8 i )" +Writes a signed byte, \fIi\fR, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_UINT8 i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an unsigned byte, \fIi\fR, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_INT16 i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a signed 16-bit integer, \fIi\fR, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_UINT16 i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an unsigned 16-bit integer, \fIi\fR, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_INT32 i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a signed 32-bit integer, \fIi\fR, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_UINT32 i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an unsigned integer, \fIi\fR, to the stream as a 32-bit unsigned integer (TQ_UINT32). Returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_INT64 i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a signed 64-bit integer, \fIi\fR, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_UINT64 i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an unsigned 64-bit integer, \fIi\fR, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_LONG i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a signed integer \fIi\fR, of the system's word length, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( TQ_ULONG i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an unsigned integer \fIi\fR, of the system's word length, to the stream and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( float f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a 32-bit floating point number, \fIf\fR, to the stream using the standard IEEE754 format. Returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( double f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a 64-bit floating point number, \fIf\fR, to the stream using the standard IEEE754 format. Returns a reference to the stream. +.SH "QDataStream & QDataStream::operator<< ( const char * s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes the '\0'-terminated string \fIs\fR to the stream and returns a reference to the stream. +.PP +The string is serialized using writeBytes(). +.SH "QDataStream & QDataStream::operator>> ( TQ_INT8 & i )" +Reads a signed byte from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_UINT8 & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned byte from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_INT16 & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a signed 16-bit integer from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_UINT16 & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned 16-bit integer from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_INT32 & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a signed 32-bit integer from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_UINT32 & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned 32-bit integer from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_INT64 & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a signed 64-bit integer from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_UINT64 & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned 64-bit integer from the stream, into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_LONG & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a signed integer of the system's word length from the stream into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( TQ_ULONG & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned integer of the system's word length from the stream, into \fIi\fR, and returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( float & f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a 32-bit floating point number from the stream into \fIf\fR, using the standard IEEE754 format. Returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( double & f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a 64-bit floating point number from the stream into \fIf\fR, using the standard IEEE754 format. Returns a reference to the stream. +.SH "QDataStream & QDataStream::operator>> ( char *& s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads the '\0'-terminated string \fIs\fR from the stream and returns a reference to the stream. +.PP +Space for the string is allocated using \fCnew\fR -- the caller must destroy it with delete[]. +.SH "QDataStream & QDataStream::readBytes ( char *& s, uint & l )" +Reads the buffer \fIs\fR from the stream and returns a reference to the stream. +.PP +The buffer \fIs\fR is allocated using \fCnew\fR. Destroy it with the \fCdelete[]\fR operator. If the length is zero or \fIs\fR cannot be allocated, \fIs\fR is set to 0. +.PP +The \fIl\fR parameter will be set to the length of the buffer. +.PP +The serialization format is a TQ_UINT32 length specifier first, then \fIl\fR bytes of data. Note that the data is \fInot\fR encoded. +.PP +See also readRawBytes() and writeBytes(). +.SH "QDataStream & QDataStream::readRawBytes ( char * s, uint len )" +Reads \fIlen\fR bytes from the stream into \fIs\fR and returns a reference to the stream. +.PP +The buffer \fIs\fR must be preallocated. The data is \fInot\fR encoded. +.PP +See also readBytes(), QIODevice::readBlock(), and writeRawBytes(). +.SH "void QDataStream::setByteOrder ( int bo )" +Sets the serialization byte order to \fIbo\fR. +.PP +The \fIbo\fR parameter can be QDataStream::BigEndian or QDataStream::LittleEndian. +.PP +The default setting is big endian. We recommend leaving this setting unless you have special requirements. +.PP +See also byteOrder(). +.SH "void QDataStream::setDevice ( QIODevice * d )" +void QDataStream::setDevice(QIODevice *d ) +.PP +Sets the IO device to \fId\fR. +.PP +See also device() and unsetDevice(). +.SH "void QDataStream::setPrintableData ( bool enable )" +If \fIenable\fR is TRUE, data will be output in a human readable format. If \fIenable\fR is FALSE, data will be output in a binary format. +.PP +If \fIenable\fR is TRUE, the write functions will generate output that consists of printable characters (7 bit ASCII). This output will typically be a lot larger than the default binary output, and consequently slower to write. +.PP +We recommend only enabling printable data for debugging purposes. +.SH "void QDataStream::setVersion ( int v )" +Sets the version number of the data serialization format to \fIv\fR. +.PP +You don't need to set a version if you are using the current version of Qt. +.PP +In order to accommodate new functionality, the datastream serialization format of some Qt classes has changed in some versions of Qt. If you want to read data that was created by an earlier version of Qt, or write data that can be read by a program that was compiled with an earlier version of Qt, use this function to modify the serialization format of QDataStream. +.PP +<center>.nf +.TS +l - l. Qt Version QDataStream Version Qt 3.3 6 Qt 3.2 5 Qt 3.1 5 Qt 3.0 4 Qt 2.1.x and Qt 2.2.x 3 Qt 2.0.x 2 Qt 1.x +.TE +.fi +</center> +.PP +See also version(). +.SH "void QDataStream::unsetDevice ()" +Unsets the IO device. This is the same as calling setDevice( 0 ). +.PP +See also device() and setDevice(). +.SH "int QDataStream::version () const" +Returns the version number of the data serialization format. In Qt 3.1, this number is 5. +.PP +See also setVersion(). +.SH "QDataStream & QDataStream::writeBytes ( const char * s, uint len )" +Writes the length specifier \fIlen\fR and the buffer \fIs\fR to the stream and returns a reference to the stream. +.PP +The \fIlen\fR is serialized as a TQ_UINT32, followed by \fIlen\fR bytes from \fIs\fR. Note that the data is \fInot\fR encoded. +.PP +See also writeRawBytes() and readBytes(). +.SH "QDataStream & QDataStream::writeRawBytes ( const char * s, uint len )" +Writes \fIlen\fR bytes from \fIs\fR to the stream and returns a reference to the stream. The data is \fInot\fR encoded. +.PP +See also writeBytes(), QIODevice::writeBlock(), and readRawBytes(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdatastream.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdatastream.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdatatable.3qt b/doc/man/man3/tqdatatable.3qt new file mode 100644 index 000000000..fbeea8b2b --- /dev/null +++ b/doc/man/man3/tqdatatable.3qt @@ -0,0 +1,700 @@ +'\" t +.TH QDataTable 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 +QDataTable \- Flexible SQL table widget that supports browsing and editing +.SH SYNOPSIS +\fC#include <ntqdatatable.h>\fR +.PP +Inherits QTable. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDataTable\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQDataTable\fR ( QSqlCursor * cursor, bool autoPopulate = FALSE, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QDataTable\fR ()" +.br +.ti -1c +.BI "virtual void \fBaddColumn\fR ( const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )" +.br +.ti -1c +.BI "virtual void \fBremoveColumn\fR ( uint col )" +.br +.ti -1c +.BI "virtual void \fBsetColumn\fR ( uint col, const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )" +.br +.ti -1c +.BI "QString \fBnullText\fR () const" +.br +.ti -1c +.BI "QString \fBtrueText\fR () const" +.br +.ti -1c +.BI "QString \fBfalseText\fR () const" +.br +.ti -1c +.BI "DateFormat \fBdateFormat\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmEdits\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmInsert\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmUpdate\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmDelete\fR () const" +.br +.ti -1c +.BI "bool \fBconfirmCancels\fR () const" +.br +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "bool \fBautoEdit\fR () const" +.br +.ti -1c +.BI "QString \fBfilter\fR () const" +.br +.ti -1c +.BI "QStringList \fBsort\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSqlCursor\fR ( QSqlCursor * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )" +.br +.ti -1c +.BI "QSqlCursor * \fBsqlCursor\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNullText\fR ( const QString & nullText )" +.br +.ti -1c +.BI "virtual void \fBsetTrueText\fR ( const QString & trueText )" +.br +.ti -1c +.BI "virtual void \fBsetFalseText\fR ( const QString & falseText )" +.br +.ti -1c +.BI "virtual void \fBsetDateFormat\fR ( const DateFormat f )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmEdits\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmInsert\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmUpdate\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmDelete\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetConfirmCancels\fR ( bool confirm )" +.br +.ti -1c +.BI "virtual void \fBsetAutoDelete\fR ( bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetAutoEdit\fR ( bool autoEdit )" +.br +.ti -1c +.BI "virtual void \fBsetFilter\fR ( const QString & filter )" +.br +.ti -1c +.BI "virtual void \fBsetSort\fR ( const QStringList & sort )" +.br +.ti -1c +.BI "virtual void \fBsetSort\fR ( const QSqlIndex & sort )" +.br +.ti -1c +.BI "enum \fBRefresh\fR { RefreshData = 1, RefreshColumns = 2, RefreshAll = 3 }" +.br +.ti -1c +.BI "void \fBrefresh\fR ( Refresh mode )" +.br +.ti -1c +.BI "virtual void \fBsortColumn\fR ( int col, bool ascending = TRUE, bool wholeRows = FALSE )" +.br +.ti -1c +.BI "virtual QString \fBtext\fR ( int row, int col ) const" +.br +.ti -1c +.BI "QVariant \fBvalue\fR ( int row, int col ) const" +.br +.ti -1c +.BI "QSqlRecord * \fBcurrentRecord\fR () const" +.br +.ti -1c +.BI "void \fBinstallEditorFactory\fR ( QSqlEditorFactory * f )" +.br +.ti -1c +.BI "void \fBinstallPropertyMap\fR ( QSqlPropertyMap * m )" +.br +.ti -1c +.BI "virtual int \fBnumCols\fR () const" +.br +.ti -1c +.BI "virtual int \fBnumRows\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBfind\fR ( const QString & str, bool caseSensitive, bool backwards )" +.br +.ti -1c +.BI "virtual void \fBsortAscending\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBsortDescending\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBrefresh\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetColumnWidth\fR ( int col, int w )" +.br +.ti -1c +.BI "virtual void \fBadjustColumn\fR ( int col )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBcurrentChanged\fR ( QSqlRecord * record )" +.br +.ti -1c +.BI "void \fBprimeInsert\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBprimeUpdate\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBprimeDelete\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBbeforeInsert\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBbeforeUpdate\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBbeforeDelete\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "void \fBcursorChanged\fR ( QSql::Op mode )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoEdit\fR - whether the data table automatically applies edits" +.br +.ti -1c +.BI "bool \fBconfirmCancels\fR - whether the data table confirms cancel operations" +.br +.ti -1c +.BI "bool \fBconfirmDelete\fR - whether the data table confirms delete operations" +.br +.ti -1c +.BI "bool \fBconfirmEdits\fR - whether the data table confirms edit operations" +.br +.ti -1c +.BI "bool \fBconfirmInsert\fR - whether the data table confirms insert operations" +.br +.ti -1c +.BI "bool \fBconfirmUpdate\fR - whether the data table confirms update operations" +.br +.ti -1c +.BI "DateFormat \fBdateFormat\fR - the format used for displaying date/time values" +.br +.ti -1c +.BI "QString \fBfalseText\fR - the text used to represent false values" +.br +.ti -1c +.BI "QString \fBfilter\fR - the data filter for the data table" +.br +.ti -1c +.BI "QString \fBnullText\fR - the text used to represent NULL values" +.br +.ti -1c +.BI "int \fBnumCols\fR - the number of columns in the table \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBnumRows\fR - the number of rows in the table \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QStringList \fBsort\fR - the data table's sort" +.br +.ti -1c +.BI "QString \fBtrueText\fR - the text used to represent true values" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBinsertCurrent\fR ()" +.br +.ti -1c +.BI "virtual bool \fBupdateCurrent\fR ()" +.br +.ti -1c +.BI "virtual bool \fBdeleteCurrent\fR ()" +.br +.ti -1c +.BI "virtual QSql::Confirm \fBconfirmEdit\fR ( QSql::Op m )" +.br +.ti -1c +.BI "virtual QSql::Confirm \fBconfirmCancel\fR ( QSql::Op m )" +.br +.ti -1c +.BI "virtual void \fBhandleError\fR ( const QSqlError & e )" +.br +.ti -1c +.BI "virtual bool \fBbeginInsert\fR ()" +.br +.ti -1c +.BI "virtual QWidget * \fBbeginUpdate\fR ( int row, int col, bool replace )" +.br +.ti -1c +.BI "int \fBindexOf\fR ( uint i ) const" +.br +.ti -1c +.BI "void \fBreset\fR ()" +.br +.ti -1c +.BI "void \fBsetSize\fR ( QSqlCursor * sql )" +.br +.ti -1c +.BI "virtual void \fBpaintField\fR ( QPainter * p, const QSqlField * field, const QRect & cr, bool selected )" +.br +.ti -1c +.BI "virtual int \fBfieldAlignment\fR ( const QSqlField * field )" +.br +.in -1c +.SH DESCRIPTION +The QDataTable class provides a flexible SQL table widget that supports browsing and editing. +.PP +QDataTable supports various functions for presenting and editing SQL data from a QSqlCursor in a table. +.PP +If you want a to present your data in a form use QDataBrowser, or for read-only forms, QDataView. +.PP +When displaying data, QDataTable only retrieves data for visible rows. If the driver supports the 'query size' property the QDataTable will have the correct number of rows and the vertical scrollbar will accurately reflect the number of rows displayed in proportion to the number of rows in the dataset. If the driver does not support the 'query size' property, rows are dynamically fetched from the database on an as-needed basis with the scrollbar becoming more accurate as the user scrolls down through the records. This allows extremely large queries to be displayed as quickly as possible, with minimum memory usage. +.PP +QDataTable inherits QTable's API and extends it with functions to sort and filter the data and sort columns. See setSqlCursor(), setFilter(), setSort(), setSorting(), sortColumn() and refresh(). +.PP +When displaying editable cursors, cell editing will be enabled. (For more information on editable cursors, see QSqlCursor). QDataTable can be used to modify existing data and to add new records. When a user makes changes to a field in the table, the cursor's edit buffer is used. The table will not send changes in the edit buffer to the database until the user moves to a different record in the grid or presses Enter. Cell editing is initiated by pressing F2 (or right clicking and then clicking the appropriate popup menu item) and canceled by pressing Esc. If there is a problem updating or adding data, errors are handled automatically (see handleError() to change this behavior). Note that if autoEdit() is FALSE navigating to another record will cancel the insert or update. +.PP +The user can be asked to confirm all edits with setConfirmEdits(). For more precise control use setConfirmInsert(), setConfirmUpdate(), setConfirmDelete() and setConfirmCancels(). Use setAutoEdit() to control the behaviour of the table when the user edits a record and then navigates. (Note that setAutoDelete() is unrelated; it is used to set whether the QSqlCursor is deleted when the table is deleted.) +.PP +Since the data table can perform edits, it must be able to uniquely identify every record so that edits are correctly applied. Because of this the underlying cursor must have a valid primary index to ensure that a unique record is inserted, updated or deleted within the database otherwise the database may be changed to an inconsistent state. +.PP +QDataTable creates editors using the default QSqlEditorFactory. Different editor factories can be used by calling installEditorFactory(). A property map is used to map between the cell's value and the editor. You can use your own property map with installPropertyMap(). +.PP +The contents of a cell is available as a QString with text() or as a QVariant with value(). The current record is returned by currentRecord(). Use the find() function to search for a string in the table. +.PP +Editing actions can be applied programatically. For example, the insertCurrent() function reads the fields from the current record into the cursor and performs the insert. The updateCurrent() and deleteCurrent() functions perform similarly to update and delete the current record respectively. +.PP +Columns in the table can be created automatically based on the cursor (see setSqlCursor()). Columns can be manipulated manually using addColumn(), removeColumn() and setColumn(). +.PP +The table automatically copies many of the properties of the cursor to format the display of data within cells (alignment, visibility, etc.). The cursor can be changed with setSqlCursor(). The filter (see setFilter()) and sort defined within the table are used instead of the filter and sort set on the cursor. For sorting options see setSort(), sortColumn(), sortAscending() and sortDescending(). Note that sorting operations will not behave as expected if you are using a QSqlSelectCursor because it uses user-defined SQL queries to obtain data. +.PP +The text used to represent NULL, TRUE and FALSE values can be changed with setNullText(), setTrueText() and setFalseText() respectively. You can change the appearance of cells by reimplementing paintField(). +.PP +Whenever a new row is selected in the table the currentChanged() signal is emitted. The primeInsert() signal is emitted when an insert is initiated. The primeUpdate() and primeDelete() signals are emitted when update and deletion are initiated respectively. Just before the database is updated a signal is emitted; beforeInsert(), beforeUpdate() or beforeDelete() as appropriate. +.PP +See also Database Classes. +.SS "Member Type Documentation" +.SH "QDataTable::Refresh" +This enum describes the refresh options. +.TP +\fCQDataTable::RefreshData\fR - refresh the data, i.e. read it from the database +.TP +\fCQDataTable::RefreshColumns\fR - refresh the list of fields, e.g. the column headings +.TP +\fCQDataTable::RefreshAll\fR - refresh both the data and the list of fields +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDataTable::QDataTable ( QWidget * parent = 0, const char * name = 0 )" +Constructs a data table which is a child of \fIparent\fR, called name \fIname\fR. +.SH "QDataTable::QDataTable ( QSqlCursor * cursor, bool autoPopulate = FALSE, QWidget * parent = 0, const char * name = 0 )" +Constructs a data table which is a child of \fIparent\fR, called name \fIname\fR using the cursor \fIcursor\fR. +.PP +If \fIautoPopulate\fR is TRUE (the default is FALSE), columns are automatically created based upon the fields in the \fIcursor\fR record. Note that \fIautoPopulate\fR only governs the creation of columns; to load the cursor's data into the table use refresh(). +.PP +If the \fIcursor\fR is read-only, the table also becomes read-only. In addition, the table adopts the cursor's driver's definition for representing NULL values as strings. +.SH "QDataTable::~QDataTable ()" +Destroys the object and frees any allocated resources. +.SH "void QDataTable::addColumn ( const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )\fC [virtual]\fR" +Adds the next column to be displayed using the field \fIfieldName\fR, column label \fIlabel\fR, width \fIwidth\fR and iconset \fIiconset\fR. +.PP +If \fIlabel\fR is specified, it is used as the column's header label, otherwise the field's display label is used when setSqlCursor() is called. The \fIiconset\fR is used to set the icon used by the column header; by default there is no icon. +.PP +See also setSqlCursor() and refresh(). +.PP +Examples: +.)l sql/overview/subclass1/main.cpp, sql/overview/subclass3/main.cpp, sql/overview/table2/main.cpp, and sql/sqltable/main.cpp. +.SH "void QDataTable::adjustColumn ( int col )\fC [virtual slot]\fR" +Resizes column \fIcol\fR so that the column width is wide enough to display the widest item the column contains (including the column label). If the table's QSqlCursor is not currently active, the cursor will be refreshed before the column width is calculated. Be aware that this function may be slow on tables that contain large result sets. +.PP +Reimplemented from QTable. +.SH "bool QDataTable::autoDelete () const" +Returns TRUE if the table will automatically delete the cursor specified by setSqlCursor(); otherwise returns FALSE. +.SH "bool QDataTable::autoEdit () const" +Returns TRUE if the data table automatically applies edits; otherwise returns FALSE. See the "autoEdit" property for details. +.SH "void QDataTable::beforeDelete ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted just before the currently selected record is deleted from the database. The \fIbuf\fR parameter points to the edit buffer being deleted. Connect to this signal to, for example, copy some of the fields for later use. +.SH "void QDataTable::beforeInsert ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted just before the cursor's edit buffer is inserted into the database. The \fIbuf\fR parameter points to the edit buffer being inserted. Connect to this signal to, for example, populate a key field with a unique sequence number. +.SH "void QDataTable::beforeUpdate ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted just before the cursor's edit buffer is updated in the database. The \fIbuf\fR parameter points to the edit buffer being updated. Connect to this signal when you want to transform the user's data behind-the-scenes. +.SH "bool QDataTable::beginInsert ()\fC [virtual protected]\fR" +Protected virtual function called when editing is about to begin on a new record. If the table is read-only, or if there's no cursor or the cursor does not allow inserts, nothing happens. +.PP +Editing takes place using the cursor's edit buffer(see QSqlCursor::editBuffer()). +.PP +When editing begins, a new row is created in the table marked with an asterisk '*' in the row's vertical header column, i.e. at the left of the row. +.SH "QWidget * QDataTable::beginUpdate ( int row, int col, bool replace )\fC [virtual protected]\fR" +Protected virtual function called when editing is about to begin on an existing row. If the table is read-only, or if there's no cursor, nothing happens. +.PP +Editing takes place using the cursor's edit buffer (see QSqlCursor::editBuffer()). +.PP +\fIrow\fR and \fIcol\fR refer to the row and column in the QDataTable. +.PP +(\fIreplace\fR is provided for reimplementors and reflects the API of QTable::beginEdit().) +.SH "QSql::Confirm QDataTable::confirmCancel ( QSql::Op m )\fC [virtual protected]\fR" +Protected virtual function which returns a confirmation for cancelling an edit mode of \fIm\fR. Derived classes can reimplement this function to provide their own cancel dialog. The default implementation uses a message box which prompts the user to confirm the cancel. +.SH "bool QDataTable::confirmCancels () const" +Returns TRUE if the data table confirms cancel operations; otherwise returns FALSE. See the "confirmCancels" property for details. +.SH "bool QDataTable::confirmDelete () const" +Returns TRUE if the data table confirms delete operations; otherwise returns FALSE. See the "confirmDelete" property for details. +.SH "QSql::Confirm QDataTable::confirmEdit ( QSql::Op m )\fC [virtual protected]\fR" +Protected virtual function which returns a confirmation for an edit of mode \fIm\fR. Derived classes can reimplement this function to provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action. +.SH "bool QDataTable::confirmEdits () const" +Returns TRUE if the data table confirms edit operations; otherwise returns FALSE. See the "confirmEdits" property for details. +.SH "bool QDataTable::confirmInsert () const" +Returns TRUE if the data table confirms insert operations; otherwise returns FALSE. See the "confirmInsert" property for details. +.SH "bool QDataTable::confirmUpdate () const" +Returns TRUE if the data table confirms update operations; otherwise returns FALSE. See the "confirmUpdate" property for details. +.SH "void QDataTable::currentChanged ( QSqlRecord * record )\fC [signal]\fR" +This signal is emitted whenever a new row is selected in the table. The \fIrecord\fR parameter points to the contents of the newly selected record. +.SH "QSqlRecord * QDataTable::currentRecord () const" +Returns the currently selected record, or 0 if there is no current selection. The table owns the pointer, so do \fInot\fR delete it or otherwise modify it or the cursor it points to. +.SH "void QDataTable::cursorChanged ( QSql::Op mode )\fC [signal]\fR" +This signal is emitted whenever the cursor record was changed due to an edit. The \fImode\fR parameter is the type of edit that just took place. +.SH "DateFormat QDataTable::dateFormat () const" +Returns the format used for displaying date/time values. See the "dateFormat" property for details. +.SH "bool QDataTable::deleteCurrent ()\fC [virtual protected]\fR" +For an editable table, issues a delete on the current cursor's primary index using the values of the currently selected row. If there is no current cursor or there is no current selection, nothing happens. If confirmEdits() or confirmDelete() is TRUE, confirmEdit() is called to confirm the delete. Returns TRUE if the delete succeeded; otherwise FALSE. +.PP +The underlying cursor must have a valid primary index to ensure that a unique record is deleted within the database otherwise the database may be changed to an inconsistent state. +.SH "QString QDataTable::falseText () const" +Returns the text used to represent false values. See the "falseText" property for details. +.SH "int QDataTable::fieldAlignment ( const QSqlField * field )\fC [virtual protected]\fR" +Returns the alignment for \fIfield\fR. +.SH "QString QDataTable::filter () const" +Returns the data filter for the data table. See the "filter" property for details. +.SH "void QDataTable::find ( const QString & str, bool caseSensitive, bool backwards )\fC [virtual slot]\fR" +Searches the current cursor for a cell containing the string \fIstr\fR starting at the current cell and working forwards (or backwards if \fIbackwards\fR is TRUE). If the string is found, the cell containing the string is set as the current cell. If \fIcaseSensitive\fR is FALSE the case of \fIstr\fR will be ignored. +.PP +The search will wrap, i.e. if the first (or if backwards is TRUE, last) cell is reached without finding \fIstr\fR the search will continue until it reaches the starting cell. If \fIstr\fR is not found the search will fail and the current cell will remain unchanged. +.SH "void QDataTable::handleError ( const QSqlError & e )\fC [virtual protected]\fR" +Protected virtual function which is called when an error \fIe\fR has occurred on the current cursor(). The default implementation displays a warning message to the user with information about the error. +.SH "int QDataTable::indexOf ( uint i ) const\fC [protected]\fR" +Returns the index of the field within the current SQL query that is displayed in column \fIi\fR. +.SH "bool QDataTable::insertCurrent ()\fC [virtual protected]\fR" +For an editable table, issues an insert on the current cursor using the values in the cursor's edit buffer. If there is no current cursor or there is no current "insert" row, nothing happens. If confirmEdits() or confirmInsert() is TRUE, confirmEdit() is called to confirm the insert. Returns TRUE if the insert succeeded; otherwise returns FALSE. +.PP +The underlying cursor must have a valid primary index to ensure that a unique record is inserted within the database otherwise the database may be changed to an inconsistent state. +.SH "void QDataTable::installEditorFactory ( QSqlEditorFactory * f )" +Installs a new SQL editor factory \fIf\fR. This enables the user to create and instantiate their own editors for use in cell editing. Note that QDataTable takes ownership of this pointer, and will delete it when it is no longer needed or when installEditorFactory() is called again. +.PP +See also QSqlEditorFactory. +.SH "void QDataTable::installPropertyMap ( QSqlPropertyMap * m )" +Installs a new property map \fIm\fR. This enables the user to create and instantiate their own property maps for use in cell editing. Note that QDataTable takes ownership of this pointer, and will delete it when it is no longer needed or when installPropertMap() is called again. +.PP +See also QSqlPropertyMap. +.SH "QString QDataTable::nullText () const" +Returns the text used to represent NULL values. See the "nullText" property for details. +.SH "int QDataTable::numCols () const\fC [virtual]\fR" +Returns the number of columns in the table. See the "numCols" property for details. +.PP +Reimplemented from QTable. +.SH "int QDataTable::numRows () const\fC [virtual]\fR" +Returns the number of rows in the table. See the "numRows" property for details. +.PP +Reimplemented from QTable. +.SH "void QDataTable::paintField ( QPainter * p, const QSqlField * field, const QRect & cr, bool selected )\fC [virtual protected]\fR" +Paints the \fIfield\fR on the painter \fIp\fR. The painter has already been translated to the appropriate cell's origin where the \fIfield\fR is to be rendered. \fIcr\fR describes the cell coordinates in the content coordinate system. The \fIselected\fR parameter is ignored. +.PP +If you want to draw custom field content you must reimplement paintField() to do the custom drawing. The default implementation renders the \fIfield\fR value as text. If the field is NULL, nullText() is displayed in the cell. If the field is Boolean, trueText() or falseText() is displayed as appropriate. +.PP +Example: sql/overview/table4/main.cpp. +.SH "void QDataTable::primeDelete ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted after the cursor is primed for delete by the table, when a delete action is beginning on the table. The \fIbuf\fR parameter points to the edit buffer being deleted. Connect to this signal in order to, for example, record auditing information on deletions. +.SH "void QDataTable::primeInsert ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted after the cursor is primed for insert by the table, when an insert action is beginning on the table. The \fIbuf\fR parameter points to the edit buffer being inserted. Connect to this signal in order to, for example, prime the record buffer with default data values. +.SH "void QDataTable::primeUpdate ( QSqlRecord * buf )\fC [signal]\fR" +This signal is emitted after the cursor is primed for update by the table, when an update action is beginning on the table. The \fIbuf\fR parameter points to the edit buffer being updated. Connect to this signal in order to, for example, provide some visual feedback that the user is in 'edit mode'. +.SH "void QDataTable::refresh ()\fC [virtual slot]\fR" +Refreshes the table. The cursor is refreshed using the current filter, the current sort, and the currently defined columns. Equivalent to calling refresh( QDataTable::RefreshData ). +.PP +Examples: +.)l sql/overview/subclass1/main.cpp, sql/overview/table1/main.cpp, sql/overview/table2/main.cpp, and sql/sqltable/main.cpp. +.SH "void QDataTable::refresh ( Refresh mode )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Refreshes the table. If there is no currently defined cursor (see setSqlCursor()), nothing happens. The \fImode\fR parameter determines which type of refresh will take place. +.PP +See also Refresh, setSqlCursor(), and addColumn(). +.SH "void QDataTable::removeColumn ( uint col )\fC [virtual]\fR" +Removes column \fIcol\fR from the list of columns to be displayed. If \fIcol\fR does not exist, nothing happens. +.PP +See also QSqlField. +.SH "void QDataTable::reset ()\fC [protected]\fR" +Resets the table so that it displays no data. +.PP +See also setSqlCursor(). +.SH "void QDataTable::setAutoDelete ( bool enable )\fC [virtual]\fR" +Sets the cursor auto-delete flag to \fIenable\fR. If \fIenable\fR is TRUE, the table will automatically delete the cursor specified by setSqlCursor(). If \fIenable\fR is FALSE (the default), the cursor will not be deleted. +.SH "void QDataTable::setAutoEdit ( bool autoEdit )\fC [virtual]\fR" +Sets whether the data table automatically applies edits to \fIautoEdit\fR. See the "autoEdit" property for details. +.SH "void QDataTable::setColumn ( uint col, const QString & fieldName, const QString & label = QString::null, int width = -1, const QIconSet & iconset = QIconSet ( ) )\fC [virtual]\fR" +Sets the \fIcol\fR column to display using the field \fIfieldName\fR, column label \fIlabel\fR, width \fIwidth\fR and iconset \fIiconset\fR. +.PP +If \fIlabel\fR is specified, it is used as the column's header label, otherwise the field's display label is used when setSqlCursor() is called. The \fIiconset\fR is used to set the icon used by the column header; by default there is no icon. +.PP +See also setSqlCursor() and refresh(). +.SH "void QDataTable::setColumnWidth ( int col, int w )\fC [virtual slot]\fR" +Sets the column \fIcol\fR to the width \fIw\fR. Note that unlike QTable the QDataTable is not immediately redrawn, you must call refresh(QDataTable::RefreshColumns) yourself. +.PP +See also refresh(). +.PP +Reimplemented from QTable. +.SH "void QDataTable::setConfirmCancels ( bool confirm )\fC [virtual]\fR" +Sets whether the data table confirms cancel operations to \fIconfirm\fR. See the "confirmCancels" property for details. +.SH "void QDataTable::setConfirmDelete ( bool confirm )\fC [virtual]\fR" +Sets whether the data table confirms delete operations to \fIconfirm\fR. See the "confirmDelete" property for details. +.SH "void QDataTable::setConfirmEdits ( bool confirm )\fC [virtual]\fR" +Sets whether the data table confirms edit operations to \fIconfirm\fR. See the "confirmEdits" property for details. +.SH "void QDataTable::setConfirmInsert ( bool confirm )\fC [virtual]\fR" +Sets whether the data table confirms insert operations to \fIconfirm\fR. See the "confirmInsert" property for details. +.SH "void QDataTable::setConfirmUpdate ( bool confirm )\fC [virtual]\fR" +Sets whether the data table confirms update operations to \fIconfirm\fR. See the "confirmUpdate" property for details. +.SH "void QDataTable::setDateFormat ( const DateFormat f )\fC [virtual]\fR" +Sets the format used for displaying date/time values to \fIf\fR. See the "dateFormat" property for details. +.SH "void QDataTable::setFalseText ( const QString & falseText )\fC [virtual]\fR" +Sets the text used to represent false values to \fIfalseText\fR. See the "falseText" property for details. +.SH "void QDataTable::setFilter ( const QString & filter )\fC [virtual]\fR" +Sets the data filter for the data table to \fIfilter\fR. See the "filter" property for details. +.SH "void QDataTable::setNullText ( const QString & nullText )\fC [virtual]\fR" +Sets the text used to represent NULL values to \fInullText\fR. See the "nullText" property for details. +.SH "void QDataTable::setSize ( QSqlCursor * sql )\fC [protected]\fR" +If the cursor's \fIsql\fR driver supports query sizes, the number of rows in the table is set to the size of the query. Otherwise, the table dynamically resizes itself as it is scrolled. If \fIsql\fR is not active, it is made active by issuing a select() on the cursor using the \fIsql\fR cursor's current filter and current sort. +.SH "void QDataTable::setSort ( const QStringList & sort )\fC [virtual]\fR" +Sets the data table's sort to \fIsort\fR. See the "sort" property for details. +.SH "void QDataTable::setSort ( const QSqlIndex & sort )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the sort to be applied to the displayed data to \fIsort\fR. If there is no current cursor, nothing happens. A QSqlIndex contains field names and their ordering (ASC or DESC); these are used to compose the ORDER BY clause. +.PP +See also sort. +.SH "void QDataTable::setSqlCursor ( QSqlCursor * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )\fC [virtual]\fR" +Sets \fIcursor\fR as the data source for the table. To force the display of the data from \fIcursor\fR, use refresh(). If \fIautoPopulate\fR is TRUE, columns are automatically created based upon the fields in the \fIcursor\fR record. If \fIautoDelete\fR is TRUE (the default is FALSE), the table will take ownership of the \fIcursor\fR and delete it when appropriate. If the \fIcursor\fR is read-only, the table becomes read-only. The table adopts the cursor's driver's definition for representing NULL values as strings. +.PP +See also refresh(), readOnly, setAutoDelete(), and QSqlDriver::nullText(). +.SH "void QDataTable::setTrueText ( const QString & trueText )\fC [virtual]\fR" +Sets the text used to represent true values to \fItrueText\fR. See the "trueText" property for details. +.SH "QStringList QDataTable::sort () const" +Returns the data table's sort. See the "sort" property for details. +.SH "void QDataTable::sortAscending ( int col )\fC [virtual slot]\fR" +Sorts column \fIcol\fR in ascending order. +.PP +See also sorting. +.SH "void QDataTable::sortColumn ( int col, bool ascending = TRUE, bool wholeRows = FALSE )\fC [virtual]\fR" +Sorts column \fIcol\fR in ascending order if \fIascending\fR is TRUE (the default); otherwise sorts in descending order. +.PP +The \fIwholeRows\fR parameter is ignored; QDataTable always sorts whole rows by the specified column. +.PP +Reimplemented from QTable. +.SH "void QDataTable::sortDescending ( int col )\fC [virtual slot]\fR" +Sorts column \fIcol\fR in descending order. +.PP +See also sorting. +.SH "QSqlCursor * QDataTable::sqlCursor () const" +Returns the cursor used by the data table. +.SH "QString QDataTable::text ( int row, int col ) const\fC [virtual]\fR" +Returns the text in cell \fIrow\fR, \fIcol\fR, or an empty string if the cell is empty. If the cell's value is NULL then nullText() will be returned. If the cell does not exist then QString::null is returned. +.PP +Reimplemented from QTable. +.SH "QString QDataTable::trueText () const" +Returns the text used to represent true values. See the "trueText" property for details. +.SH "bool QDataTable::updateCurrent ()\fC [virtual protected]\fR" +For an editable table, issues an update using the cursor's edit buffer. If there is no current cursor or there is no current selection, nothing happens. If confirmEdits() or confirmUpdate() is TRUE, confirmEdit() is called to confirm the update. Returns TRUE if the update succeeded; otherwise returns FALSE. +.PP +The underlying cursor must have a valid primary index to ensure that a unique record is updated within the database otherwise the database may be changed to an inconsistent state. +.SH "QVariant QDataTable::value ( int row, int col ) const" +Returns the value in cell \fIrow\fR, \fIcol\fR, or an invalid value if the cell does not exist or has no value. +.SS "Property Documentation" +.SH "bool autoEdit" +This property holds whether the data table automatically applies edits. +.PP +The default value for this property is TRUE. When the user begins an insert or update in the table there are two possible outcomes when they navigate to another record: +.PP +<ol type=1> +.TP +the insert or update is is performed -- this occurs if autoEdit is TRUE +.TP +the insert or update is abandoned -- this occurs if autoEdit is FALSE +.PP +Set this property's value with setAutoEdit() and get this property's value with autoEdit(). +.SH "bool confirmCancels" +This property holds whether the data table confirms cancel operations. +.PP +If the confirmCancel property is TRUE, all cancels must be confirmed by the user through a message box (this behavior can be changed by overriding the confirmCancel() function), otherwise all cancels occur immediately. The default is FALSE. +.PP +See also confirmEdits and confirmCancel(). +.PP +Set this property's value with setConfirmCancels() and get this property's value with confirmCancels(). +.SH "bool confirmDelete" +This property holds whether the data table confirms delete operations. +.PP +If the confirmDelete property is TRUE, all deletions must be confirmed by the user through a message box (this behaviour can be changed by overriding the confirmEdit() function), otherwise all delete operations occur immediately. +.PP +See also confirmCancels, confirmEdits, confirmUpdate, and confirmInsert. +.PP +Set this property's value with setConfirmDelete() and get this property's value with confirmDelete(). +.SH "bool confirmEdits" +This property holds whether the data table confirms edit operations. +.PP +If the confirmEdits property is TRUE, the data table confirms all edit operations (inserts, updates and deletes). Finer control of edit confirmation can be achieved using confirmCancels, confirmInsert, confirmUpdate and confirmDelete. +.PP +See also confirmCancels, confirmInsert, confirmUpdate, and confirmDelete. +.PP +Set this property's value with setConfirmEdits() and get this property's value with confirmEdits(). +.SH "bool confirmInsert" +This property holds whether the data table confirms insert operations. +.PP +If the confirmInsert property is TRUE, all insertions must be confirmed by the user through a message box (this behaviour can be changed by overriding the confirmEdit() function), otherwise all insert operations occur immediately. +.PP +See also confirmCancels, confirmEdits, confirmUpdate, and confirmDelete. +.PP +Set this property's value with setConfirmInsert() and get this property's value with confirmInsert(). +.SH "bool confirmUpdate" +This property holds whether the data table confirms update operations. +.PP +If the confirmUpdate property is TRUE, all updates must be confirmed by the user through a message box (this behaviour can be changed by overriding the confirmEdit() function), otherwise all update operations occur immediately. +.PP +See also confirmCancels, confirmEdits, confirmInsert, and confirmDelete. +.PP +Set this property's value with setConfirmUpdate() and get this property's value with confirmUpdate(). +.SH "DateFormat dateFormat" +This property holds the format used for displaying date/time values. +.PP +The dateFormat property is used for displaying date/time values in the table. The default value is Qt::LocalDate. +.PP +Set this property's value with setDateFormat() and get this property's value with dateFormat(). +.SH "QString falseText" +This property holds the text used to represent false values. +.PP +The falseText property will be used to represent NULL values in the table. The default value is "False". +.PP +Set this property's value with setFalseText() and get this property's value with falseText(). +.SH "QString filter" +This property holds the data filter for the data table. +.PP +The filter applies to the data shown in the table. To view data with a new filter, use refresh(). A filter string is an SQL WHERE clause without the WHERE keyword. +.PP +There is no default filter. +.PP +See also sort. +.PP +Set this property's value with setFilter() and get this property's value with filter(). +.SH "QString nullText" +This property holds the text used to represent NULL values. +.PP +The nullText property will be used to represent NULL values in the table. The default value is provided by the cursor's driver. +.PP +Set this property's value with setNullText() and get this property's value with nullText(). +.SH "int numCols" +This property holds the number of columns in the table. +.PP +Get this property's value with numCols(). +.SH "int numRows" +This property holds the number of rows in the table. +.PP +Get this property's value with numRows(). +.SH "QStringList sort" +This property holds the data table's sort. +.PP +The table's sort affects the order in which data records are displayed in the table. To apply a sort, use refresh(). +.PP +When examining the sort property, a string list is returned with each item having the form 'fieldname order' (e.g., 'id ASC', 'surname DESC'). +.PP +There is no default sort. +.PP +Note that if you want to iterate over the sort list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myDataTable.sort(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also filter and refresh(). +.PP +Set this property's value with setSort() and get this property's value with sort(). +.SH "QString trueText" +This property holds the text used to represent true values. +.PP +The trueText property will be used to represent NULL values in the table. The default value is "True". +.PP +Set this property's value with setTrueText() and get this property's value with trueText(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdatatable.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdatatable.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdataview.3qt b/doc/man/man3/tqdataview.3qt new file mode 100644 index 000000000..f3f7cfa23 --- /dev/null +++ b/doc/man/man3/tqdataview.3qt @@ -0,0 +1,129 @@ +'\" t +.TH QDataView 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 +QDataView \- Read-only SQL forms +.SH SYNOPSIS +\fC#include <ntqdataview.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDataView\fR ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" +.br +.ti -1c +.BI "\fB~QDataView\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetForm\fR ( QSqlForm * form )" +.br +.ti -1c +.BI "QSqlForm * \fBform\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetRecord\fR ( QSqlRecord * record )" +.br +.ti -1c +.BI "QSqlRecord * \fBrecord\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBrefresh\fR ( QSqlRecord * buf )" +.br +.ti -1c +.BI "virtual void \fBreadFields\fR ()" +.br +.ti -1c +.BI "virtual void \fBwriteFields\fR ()" +.br +.ti -1c +.BI "virtual void \fBclearValues\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QDataView class provides read-only SQL forms. +.PP +This class provides a form which displays SQL field data from a record buffer. Because QDataView does not support editing it uses less resources than a QDataBrowser. This class is well suited for displaying read-only data from a SQL database. +.PP +If you want a to present your data in an editable form use QDataBrowser; if you want a table-based presentation of your data use QDataTable. +.PP +The form is associated with the data view with setForm() and the record is associated with setRecord(). You can also pass a QSqlRecord to the refresh() function which will set the record to the given record and read the record's fields into the form. +.PP +See also Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDataView::QDataView ( QWidget * parent = 0, const char * name = 0, WFlags fl = 0 )" +Constructs a data view which is a child of \fIparent\fR, called \fIname\fR, and with widget flags \fIfl\fR. +.SH "QDataView::~QDataView ()" +Destroys the object and frees any allocated resources. +.SH "void QDataView::clearValues ()\fC [virtual slot]\fR" +Clears the default form's values. If there is no default form, nothing happens. All the values are set to their 'zero state', e.g. 0 for numeric fields, "" for string fields. +.SH "QSqlForm * QDataView::form ()" +Returns the default form used by the data view, or 0 if there is none. +.PP +See also setForm(). +.SH "void QDataView::readFields ()\fC [virtual slot]\fR" +Causes the default form to read its fields from the record buffer. If there is no default form, or no record, nothing happens. +.PP +See also setForm(). +.SH "QSqlRecord * QDataView::record ()" +Returns the default record used by the data view, or 0 if there is none. +.PP +See also setRecord(). +.SH "void QDataView::refresh ( QSqlRecord * buf )\fC [virtual slot]\fR" +Causes the default form to display the contents of \fIbuf\fR. If there is no default form, nothing happens.The \fIbuf\fR also becomes the default record for all subsequent calls to readFields() and writefields(). This slot is equivalant to calling: +.PP +.nf +.br + myView.setRecord( record ); +.br + myView.readFields(); +.br +.fi +.PP +See also setRecord() and readFields(). +.SH "void QDataView::setForm ( QSqlForm * form )\fC [virtual]\fR" +Sets the form used by the data view to \fIform\fR. If a record has already been assigned to the data view, the form will display that record's data. +.PP +See also form(). +.SH "void QDataView::setRecord ( QSqlRecord * record )\fC [virtual]\fR" +Sets the record used by the data view to \fIrecord\fR. If a form has already been assigned to the data view, the form will display the data from \fIrecord\fR in that form. +.PP +See also record(). +.SH "void QDataView::writeFields ()\fC [virtual slot]\fR" +Causes the default form to write its fields to the record buffer. If there is no default form, or no record, nothing happens. +.PP +See also setForm(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdataview.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdataview.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdate.3qt b/doc/man/man3/tqdate.3qt new file mode 100644 index 000000000..02dd9977f --- /dev/null +++ b/doc/man/man3/tqdate.3qt @@ -0,0 +1,429 @@ +'\" t +.TH QDate 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 +QDate \- Date functions +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdatetime.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDate\fR ()" +.br +.ti -1c +.BI "\fBQDate\fR ( int y, int m, int d )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "int \fByear\fR () const" +.br +.ti -1c +.BI "int \fBmonth\fR () const" +.br +.ti -1c +.BI "int \fBday\fR () const" +.br +.ti -1c +.BI "int \fBdayOfWeek\fR () const" +.br +.ti -1c +.BI "int \fBdayOfYear\fR () const" +.br +.ti -1c +.BI "int \fBdaysInMonth\fR () const" +.br +.ti -1c +.BI "int \fBdaysInYear\fR () const" +.br +.ti -1c +.BI "int \fBweekNumber\fR ( int * yearNumber = 0 ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( Qt::DateFormat f = Qt::TextDate ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( const QString & format ) const" +.br +.ti -1c +.BI "bool \fBsetYMD\fR ( int y, int m, int d )" +.br +.ti -1c +.BI "QDate \fBaddDays\fR ( int ndays ) const" +.br +.ti -1c +.BI "QDate \fBaddMonths\fR ( int nmonths ) const" +.br +.ti -1c +.BI "QDate \fBaddYears\fR ( int nyears ) const" +.br +.ti -1c +.BI "int \fBdaysTo\fR ( const QDate & d ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QDate & d ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QDate & d ) const" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const QDate & d ) const" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const QDate & d ) const" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const QDate & d ) const" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const QDate & d ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString monthName ( int month ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString dayName ( int weekday ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString \fBshortMonthName\fR ( int month )" +.br +.ti -1c +.BI "QString \fBshortDayName\fR ( int weekday )" +.br +.ti -1c +.BI "QString \fBlongMonthName\fR ( int month )" +.br +.ti -1c +.BI "QString \fBlongDayName\fR ( int weekday )" +.br +.ti -1c +.BI "QDate \fBcurrentDate\fR ()" +.br +.ti -1c +.BI "QDate \fBcurrentDate\fR ( Qt::TimeSpec ts )" +.br +.ti -1c +.BI "QDate \fBfromString\fR ( const QString & s, Qt::DateFormat f = Qt::TextDate )" +.br +.ti -1c +.BI "bool \fBisValid\fR ( int y, int m, int d )" +.br +.ti -1c +.BI "bool \fBleapYear\fR ( int y )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QDate & d )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QDate & d )" +.br +.in -1c +.SH DESCRIPTION +The QDate class provides date functions. +.PP +A QDate object contains a calendar date, i.e. year, month, and day numbers, in the modern Western (Gregorian) calendar. It can read the current date from the system clock. It provides functions for comparing dates and for manipulating dates, e.g. by adding a number of days or months or years. +.PP +A QDate object is typically created either by giving the year, month and day numbers explicitly, or by using the static function currentDate(), which creates a QDate object containing the system clock's date. An explicit date can also be set using setYMD(). The fromString() function returns a QDate given a string and a date format which is used to interpret the date within the string. +.PP +The year(), month(), and day() functions provide access to the year, month, and day numbers. Also, dayOfWeek() and dayOfYear() functions are provided. The same information is provided in textual format by the toString(), shortDayName(), longDayName(), shortMonthName() and longMonthName() functions. +.PP +QDate provides a full set of operators to compare two QDate objects where smaller means earlier and larger means later. +.PP +You can increment (or decrement) a date by a given number of days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two dates. +.PP +The daysInMonth() and daysInYear() functions return how many days there are in this date's month and year, respectively. The leapYear() function indicates whether this date is in a leap year. +.PP +Note that QDate should not be used for date calculations for dates prior to the introduction of the Gregorian calendar. This calendar was adopted by England from the 14<sup><small>th</small></sup> September 1752 (hence this is the earliest valid QDate), and subsequently by most other Western countries, until 1923. +.PP +The end of time is reached around the year 8000, by which time we expect Qt to be obsolete. +.PP +See also QTime, QDateTime, QDateEdit, QDateTimeEdit, and Time and Date. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDate::QDate ()" +Constructs a null date. Null dates are invalid. +.PP +See also isNull() and isValid(). +.SH "QDate::QDate ( int y, int m, int d )" +Constructs a date with year \fIy\fR, month \fIm\fR and day \fId\fR. +.PP +\fIy\fR must be in the range 1752..8000, \fIm\fR must be in the range 1..12, and \fId\fR must be in the range 1..31. +.PP +\fBWarning:\fR If \fIy\fR is in the range 0..99, it is interpreted as 1900..1999. +.PP +See also isValid(). +.SH "QDate QDate::addDays ( int ndays ) const" +Returns a QDate object containing a date \fIndays\fR later than the date of this object (or earlier if \fIndays\fR is negative). +.PP +See also addMonths(), addYears(), and daysTo(). +.SH "QDate QDate::addMonths ( int nmonths ) const" +Returns a QDate object containing a date \fInmonths\fR later than the date of this object (or earlier if \fInmonths\fR is negative). +.PP +See also addDays() and addYears(). +.SH "QDate QDate::addYears ( int nyears ) const" +Returns a QDate object containing a date \fInyears\fR later than the date of this object (or earlier if \fInyears\fR is negative). +.PP +See also addDays() and addMonths(). +.SH "QDate QDate::currentDate ( Qt::TimeSpec ts )\fC [static]\fR" +Returns the current date, as reported by the system clock, for the TimeSpec \fIts\fR. The default TimeSpec is LocalTime. +.PP +See also QTime::currentTime(), QDateTime::currentDateTime(), and Qt::TimeSpec. +.PP +Example: dclock/dclock.cpp. +.SH "QDate QDate::currentDate ()\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the current date, as reported by the system clock. +.PP +See also QTime::currentTime() and QDateTime::currentDateTime(). +.SH "int QDate::day () const" +Returns the day of the month (1..31) of this date. +.PP +See also year(), month(), and dayOfWeek(). +.PP +Example: dclock/dclock.cpp. +.SH "QString QDate::dayName ( int weekday )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use shortDayName() instead. +.SH "int QDate::dayOfWeek () const" +Returns the weekday (Monday=1..Sunday=7) for this date. +.PP +See also day() and dayOfYear(). +.SH "int QDate::dayOfYear () const" +Returns the day of the year (1..365) for this date. +.PP +See also day() and dayOfWeek(). +.SH "int QDate::daysInMonth () const" +Returns the number of days in the month (28..31) for this date. +.PP +See also day() and daysInYear(). +.SH "int QDate::daysInYear () const" +Returns the number of days in the year (365 or 366) for this date. +.PP +See also day() and daysInMonth(). +.SH "int QDate::daysTo ( const QDate & d ) const" +Returns the number of days from this date to \fId\fR (which is negative if \fId\fR is earlier than this date). +.PP +Example: +.PP +.nf +.br + QDate d1( 1995, 5, 17 ); // May 17th 1995 +.br + QDate d2( 1995, 5, 20 ); // May 20th 1995 +.br + d1.daysTo( d2 ); // returns 3 +.br + d2.daysTo( d1 ); // returns -3 +.br +.fi +.PP +See also addDays(). +.SH "QDate QDate::fromString ( const QString & s, Qt::DateFormat f = Qt::TextDate )\fC [static]\fR" +Returns the QDate represented by the string \fIs\fR, using the format \fIf\fR, or an invalid date if the string cannot be parsed. +.PP +Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used, they depend on the user's locale settings. +.PP +\fBWarning:\fR Qt::LocalDate cannot be used here. +.SH "bool QDate::isNull () const" +Returns TRUE if the date is null; otherwise returns FALSE. A null date is invalid. +.PP +See also isValid(). +.SH "bool QDate::isValid () const" +Returns TRUE if this date is valid; otherwise returns FALSE. +.PP +See also isNull(). +.SH "bool QDate::isValid ( int y, int m, int d )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the specified date (year \fIy\fR, month \fIm\fR and day \fId\fR) is valid; otherwise returns FALSE. +.PP +Example: +.PP +.nf +.br + QDate::isValid( 2002, 5, 17 ); // TRUE May 17th 2002 is valid +.br + QDate::isValid( 2002, 2, 30 ); // FALSE Feb 30th does not exist +.br + QDate::isValid( 2004, 2, 29 ); // TRUE 2004 is a leap year +.br + QDate::isValid( 1202, 6, 6 ); // FALSE 1202 is pre-Gregorian +.br +.fi +.PP +\fBWarning:\fR A \fIy\fR value in the range 00..99 is interpreted as 1900..1999. +.PP +See also isNull() and setYMD(). +.SH "bool QDate::leapYear ( int y )\fC [static]\fR" +Returns TRUE if the specified year \fIy\fR is a leap year; otherwise returns FALSE. +.SH "QString QDate::longDayName ( int weekday )\fC [static]\fR" +Returns the long name of the \fIweekday\fR. +.PP +1 = "Monday", 2 = "Tuesday", ... 7 = "Sunday" +.PP +The day names will be localized according to the system's locale settings. +.PP +See also toString(), shortDayName(), shortMonthName(), and longMonthName(). +.SH "QString QDate::longMonthName ( int month )\fC [static]\fR" +Returns the long name of the \fImonth\fR. +.PP +1 = "January", 2 = "February", ... 12 = "December" +.PP +The month names will be localized according to the system's locale settings. +.PP +See also toString(), shortMonthName(), shortDayName(), and longDayName(). +.SH "int QDate::month () const" +Returns the month (January=1..December=12) of this date. +.PP +See also year() and day(). +.PP +Example: dclock/dclock.cpp. +.SH "QString QDate::monthName ( int month )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use shortMonthName() instead. +.SH "bool QDate::operator!= ( const QDate & d ) const" +Returns TRUE if this date is different from \fId\fR; otherwise returns FALSE. +.SH "bool QDate::operator< ( const QDate & d ) const" +Returns TRUE if this date is earlier than \fId\fR, otherwise returns FALSE. +.SH "bool QDate::operator<= ( const QDate & d ) const" +Returns TRUE if this date is earlier than or equal to \fId\fR, otherwise returns FALSE. +.SH "bool QDate::operator== ( const QDate & d ) const" +Returns TRUE if this date is equal to \fId\fR; otherwise returns FALSE. +.SH "bool QDate::operator> ( const QDate & d ) const" +Returns TRUE if this date is later than \fId\fR, otherwise returns FALSE. +.SH "bool QDate::operator>= ( const QDate & d ) const" +Returns TRUE if this date is later than or equal to \fId\fR, otherwise returns FALSE. +.SH "bool QDate::setYMD ( int y, int m, int d )" +Sets the date's year \fIy\fR, month \fIm\fR and day \fId\fR. +.PP +\fIy\fR must be in the range 1752..8000, \fIm\fR must be in the range 1..12, and \fId\fR must be in the range 1..31. +.PP +\fBWarning:\fR If \fIy\fR is in the range 0..99, it is interpreted as 1900..1999. +.PP +Returns TRUE if the date is valid; otherwise returns FALSE. +.SH "QString QDate::shortDayName ( int weekday )\fC [static]\fR" +Returns the name of the \fIweekday\fR. +.PP +1 = "Mon", 2 = "Tue", ... 7 = "Sun" +.PP +The day names will be localized according to the system's locale settings. +.PP +See also toString(), shortMonthName(), longMonthName(), and longDayName(). +.SH "QString QDate::shortMonthName ( int month )\fC [static]\fR" +Returns the name of the \fImonth\fR. +.PP +1 = "Jan", 2 = "Feb", ... 12 = "Dec" +.PP +The month names will be localized according to the system's locale settings. +.PP +See also toString(), longMonthName(), shortDayName(), and longDayName(). +.SH "QString QDate::toString ( const QString & format ) const" +Returns the date as a string. The \fIformat\fR parameter determines the format of the result string. +.PP +These expressions may be used: +.PP +<center>.nf +.TS +l - l. Expression Output d the day as number without a leading zero (1-31) dd the day as number with a leading zero (01-31) ddd the abbreviated localized day name (e.g. 'Mon'..'Sun'). Uses QDate::shortDayName(). dddd the long localized day name (e.g. 'Monday'..'Sunday'). Uses QDate::longDayName(). M the month as number without a leading zero (1-12) MM the month as number with a leading zero (01-12) MMM the abbreviated localized month name (e.g. 'Jan'..'Dec'). Uses QDate::shortMonthName(). MMMM the long localized month name (e.g. 'January'..'December'). Uses QDate::longMonthName(). yy the year as two digit number (00-99) yyyy +.TE +.fi +</center> +.PP +All other input characters will be ignored. +.PP +Example format strings (assuming that the QDate is the 20<sup><small>th</small></sup> July 1969): <center>.nf +.TS +l - l. Format Result dd.MM.yyyy 20.07.1969 ddd MMMM d yy +.TE +.fi +</center> +.PP +If the date is an invalid date, then QString::null will be returned. +.PP +See also QDateTime::toString() and QTime::toString(). +.SH "QString QDate::toString ( Qt::DateFormat f = Qt::TextDate ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the date as a string. The \fIf\fR parameter determines the format of the string. +.PP +If \fIf\fR is Qt::TextDate, the string format is "Sat May 20 1995" (using the shortDayName() and shortMonthName() functions to generate the string, so the day and month names are locale specific). +.PP +If \fIf\fR is Qt::ISODate, the string format corresponds to the ISO 8601 specification for representations of dates, which is YYYY-MM-DD where YYYY is the year, MM is the month of the year (between 01 and 12), and DD is the day of the month between 01 and 31. +.PP +If \fIf\fR is Qt::LocalDate, the string format depends on the locale settings of the system. +.PP +If the date is an invalid date, then QString::null will be returned. +.PP +See also shortDayName() and shortMonthName(). +.SH "int QDate::weekNumber ( int * yearNumber = 0 ) const" +Returns the week number (1 to 53), and stores the year in \fI*yearNumber\fR unless \fIyearNumber\fR is null (the default). +.PP +Returns 0 if the date is invalid. +.PP +In accordance with ISO 8601, weeks start on Monday and the first Thursday of a year is always in week 1 of that year. Most years have 52 weeks, but some have 53. +.PP +\fI*yearNumber\fR is not always the same as year(). For example, 1 January 2000 has week number 52 in the year 1999, and 31 December 2002 has week number 1 in the year 2003. +.PP +Copyright (c) 1989 The Regents of the University of California. All rights reserved. +.PP +Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. +.PP +See also isValid(). +.SH "int QDate::year () const" +Returns the year (1752..8000) of this date. +.PP +See also month() and day(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QDate & d )" +Writes the date, \fId\fR, to the data stream, \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QDate & d )" +Reads a date from the stream \fIs\fR into \fId\fR. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdate.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdate.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdateedit.3qt b/doc/man/man3/tqdateedit.3qt new file mode 100644 index 000000000..2583af845 --- /dev/null +++ b/doc/man/man3/tqdateedit.3qt @@ -0,0 +1,292 @@ +'\" t +.TH QDateEdit 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 +QDateEdit \- Date editor +.SH SYNOPSIS +\fC#include <ntqdatetimeedit.h>\fR +.PP +Inherits QDateTimeEditBase. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDateEdit\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQDateEdit\fR ( const QDate & date, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QDateEdit\fR ()" +.br +.ti -1c +.BI "enum \fBOrder\fR { DMY, MDY, YMD, YDM }" +.br +.ti -1c +.BI "QDate \fBdate\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetOrder\fR ( Order order )" +.br +.ti -1c +.BI "Order \fBorder\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoAdvance\fR ( bool advance )" +.br +.ti -1c +.BI "bool \fBautoAdvance\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMinValue\fR ( const QDate & d )" +.br +.ti -1c +.BI "QDate \fBminValue\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMaxValue\fR ( const QDate & d )" +.br +.ti -1c +.BI "QDate \fBmaxValue\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRange\fR ( const QDate & min, const QDate & max )" +.br +.ti -1c +.BI "QString \fBseparator\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSeparator\fR ( const QString & s )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetDate\fR ( const QDate & date )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBvalueChanged\fR ( const QDate & date )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoAdvance\fR - whether the editor automatically advances to the next section" +.br +.ti -1c +.BI "QDate \fBdate\fR - the editor's date value" +.br +.ti -1c +.BI "QDate \fBmaxValue\fR - the editor's maximum value" +.br +.ti -1c +.BI "QDate \fBminValue\fR - the editor's minimum value" +.br +.ti -1c +.BI "Order \fBorder\fR - the order in which the " "year" ", month and day appear" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QString \fBsectionFormattedText\fR ( int sec )" +.br +.ti -1c +.BI "virtual void \fBsetYear\fR ( int year )" +.br +.ti -1c +.BI "virtual void \fBsetMonth\fR ( int month )" +.br +.ti -1c +.BI "virtual void \fBsetDay\fR ( int day )" +.br +.ti -1c +.BI "virtual void \fBfix\fR ()" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "void \fBupdateButtons\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QDateEdit class provides a date editor. +.PP +QDateEdit allows the user to edit dates by using the keyboard or the arrow keys to increase/decrease date values. The arrow keys can be used to move from section to section within the QDateEdit box. Dates appear in accordance with the local date/time settings or in year, month, day order if the system doesn't provide this information. It is recommended that the QDateEdit be initialised with a date, e.g. +.PP +.nf +.br + QDateEdit *dateEdit = new QDateEdit( QDate::currentDate(), this ); +.br + dateEdit->setRange( QDate::currentDate().addDays( -365 ), +.br + QDate::currentDate().addDays( 365 ) ); +.br + dateEdit->setOrder( QDateEdit::MDY ); +.br + dateEdit->setAutoAdvance( TRUE ); +.br +.fi +.PP +Here we've created a new QDateEdit object initialised with today's date and restricted the valid date range to today plus or minus 365 days. We've set the order to month, day, year. If the auto advance property is TRUE (as we've set it here) when the user completes a section of the date, e.g. enters two digits for the month, they are automatically taken to the next section. +.PP +The maximum and minimum values for a date value in the date editor default to the maximum and minimum values for a QDate. You can change this by calling setMinValue(), setMaxValue() or setRange(). +.PP +Terminology: A QDateEdit widget comprises three 'sections', one each for the year, month and day. You can change the separator character using QDateTimeEditor::setSeparator(), by default the separator will be taken from the systems settings. If that is not possible, it defaults to "-". +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QDate, QTimeEdit, QDateTimeEdit, Advanced Widgets, and Time and Date. +.SS "Member Type Documentation" +.SH "QDateEdit::Order" +This enum defines the order in which the sections that comprise a date appear. +.TP +\fCQDateEdit::MDY\fR - month-day-year +.TP +\fCQDateEdit::DMY\fR - day-month-year +.TP +\fCQDateEdit::YMD\fR - year-month-day (the default) +.TP +\fCQDateEdit::YDM\fR - year-day-month (included for completeness; but should not be used) +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDateEdit::QDateEdit ( QWidget * parent = 0, const char * name = 0 )" +Constructs an empty date editor which is a child of \fIparent\fR and called name \fIname\fR. +.SH "QDateEdit::QDateEdit ( const QDate & date, QWidget * parent = 0, const char * name = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a date editor with the initial value \fIdate\fR, parent \fIparent\fR and called \fIname\fR. +.PP +The date editor is initialized with \fIdate\fR. +.SH "QDateEdit::~QDateEdit ()" +Destroys the object and frees any allocated resources. +.SH "bool QDateEdit::autoAdvance () const" +Returns TRUE if the editor automatically advances to the next section; otherwise returns FALSE. See the "autoAdvance" property for details. +.SH "QDate QDateEdit::date () const" +Returns the editor's date value. See the "date" property for details. +.SH "void QDateEdit::fix ()\fC [virtual protected]\fR" +Attempts to fix any invalid date entries. +.PP +The rules applied are as follows: +.TP +If the year has four digits it is left unchanged. +.TP +If the year has two digits, the year will be changed to four digits in the range current year - 70 to current year + 29. +.TP +If the year has three digits in the range 100..999, the current millennium, i.e. 2000, will be added giving a year in the range 2100..2999. +.TP +If the day or month is 0 then it will be set to 1 or the minimum valid day\\month in the range. +.SH "QDate QDateEdit::maxValue () const" +Returns the editor's maximum value. See the "maxValue" property for details. +.SH "QDate QDateEdit::minValue () const" +Returns the editor's minimum value. See the "minValue" property for details. +.SH "Order QDateEdit::order () const" +Returns the order in which the year, month and day appear. See the "order" property for details. +.SH "QString QDateEdit::sectionFormattedText ( int sec )\fC [virtual protected]\fR" +Returns the formatted number for section \fIsec\fR. This will correspond to either the year, month or day section, depending on the current display order. +.PP +See also order. +.SH "QString QDateEdit::separator () const" +Returns the editor's separator. +.SH "void QDateEdit::setAutoAdvance ( bool advance )\fC [virtual]\fR" +Sets whether the editor automatically advances to the next section to \fIadvance\fR. See the "autoAdvance" property for details. +.SH "void QDateEdit::setDate ( const QDate & date )\fC [virtual slot]\fR" +Sets the editor's date value to \fIdate\fR. See the "date" property for details. +.SH "void QDateEdit::setDay ( int day )\fC [virtual protected]\fR" +Sets the day to \fIday\fR, which must be a valid day. The function will ensure that the \fIday\fR set is valid for the month and year. +.SH "void QDateEdit::setMaxValue ( const QDate & d )\fC [virtual]\fR" +Sets the editor's maximum value to \fId\fR. See the "maxValue" property for details. +.SH "void QDateEdit::setMinValue ( const QDate & d )\fC [virtual]\fR" +Sets the editor's minimum value to \fId\fR. See the "minValue" property for details. +.SH "void QDateEdit::setMonth ( int month )\fC [virtual protected]\fR" +Sets the month to \fImonth\fR, which must be a valid month, i.e. between 1 and 12. +.SH "void QDateEdit::setOrder ( Order order )\fC [virtual]\fR" +Sets the order in which the year, month and day appear to \fIorder\fR. See the "order" property for details. +.SH "void QDateEdit::setRange ( const QDate & min, const QDate & max )\fC [virtual]\fR" +Sets the valid input range for the editor to be from \fImin\fR to \fImax\fR inclusive. If \fImin\fR is invalid no minimum date will be set. Similarly, if \fImax\fR is invalid no maximum date will be set. +.SH "void QDateEdit::setSeparator ( const QString & s )\fC [virtual]\fR" +Sets the separator to \fIs\fR. Note that currently only the first character of \fIs\fR is used. +.SH "void QDateEdit::setYear ( int year )\fC [virtual protected]\fR" +Sets the year to \fIyear\fR, which must be a valid year. The range currently supported is from 1752 to 8000. +.PP +See also QDate. +.SH "void QDateEdit::updateButtons ()\fC [protected slot]\fR" +Enables/disables the push buttons according to the min/max date for this widget. +.SH "void QDateEdit::valueChanged ( const QDate & date )\fC [signal]\fR" +This signal is emitted whenever the editor's value changes. The \fIdate\fR parameter is the new value. +.SS "Property Documentation" +.SH "bool autoAdvance" +This property holds whether the editor automatically advances to the next section. +.PP +If autoAdvance is TRUE, the editor will automatically advance focus to the next date section if a user has completed a section. The default is FALSE. +.PP +Set this property's value with setAutoAdvance() and get this property's value with autoAdvance(). +.SH "QDate date" +This property holds the editor's date value. +.PP +If the date property is not valid, the editor displays all zeroes and QDateEdit::date() will return an invalid date. It is strongly recommended that the editor is given a default date value (e.g. currentDate()). That way, attempts to set the date property to an invalid date will fail. +.PP +When changing the date property, if the date is less than minValue(), or is greater than maxValue(), nothing happens. +.PP +Set this property's value with setDate() and get this property's value with date(). +.SH "QDate maxValue" +This property holds the editor's maximum value. +.PP +Setting the maximum date value for the editor is equivalent to calling QDateEdit::setRange( minValue(), \fId\fR ), where \fId\fR is the maximum date. The default maximum date is 8000-12-31. +.PP +See also minValue and setRange(). +.PP +Set this property's value with setMaxValue() and get this property's value with maxValue(). +.SH "QDate minValue" +This property holds the editor's minimum value. +.PP +Setting the minimum date value is equivalent to calling QDateEdit::setRange( \fId\fR, maxValue() ), where \fId\fR is the minimum date. The default minimum date is 1752-09-14. +.PP +See also maxValue and setRange(). +.PP +Set this property's value with setMinValue() and get this property's value with minValue(). +.SH "Order order" +This property holds the order in which the year, month and day appear. +.PP +The default order is locale dependent. +.PP +See also Order. +.PP +Set this property's value with setOrder() and get this property's value with order(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdateedit.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdateedit.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdatetime.3qt b/doc/man/man3/tqdatetime.3qt new file mode 100644 index 000000000..3b7ff1bfe --- /dev/null +++ b/doc/man/man3/tqdatetime.3qt @@ -0,0 +1,337 @@ +'\" t +.TH QDateTime 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 +QDateTime \- Date and time functions +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdatetime.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDateTime\fR ()" +.br +.ti -1c +.BI "\fBQDateTime\fR ( const QDate & date )" +.br +.ti -1c +.BI "\fBQDateTime\fR ( const QDate & date, const QTime & time )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "QDate \fBdate\fR () const" +.br +.ti -1c +.BI "QTime \fBtime\fR () const" +.br +.ti -1c +.BI "uint \fBtoTime_t\fR () const" +.br +.ti -1c +.BI "void \fBsetDate\fR ( const QDate & date )" +.br +.ti -1c +.BI "void \fBsetTime\fR ( const QTime & time )" +.br +.ti -1c +.BI "void \fBsetTime_t\fR ( uint secsSince1Jan1970UTC )" +.br +.ti -1c +.BI "void \fBsetTime_t\fR ( uint secsSince1Jan1970UTC, Qt::TimeSpec ts )" +.br +.ti -1c +.BI "QString \fBtoString\fR ( Qt::DateFormat f = Qt::TextDate ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( const QString & format ) const" +.br +.ti -1c +.BI "QDateTime \fBaddDays\fR ( int ndays ) const" +.br +.ti -1c +.BI "QDateTime \fBaddMonths\fR ( int nmonths ) const" +.br +.ti -1c +.BI "QDateTime \fBaddYears\fR ( int nyears ) const" +.br +.ti -1c +.BI "QDateTime \fBaddSecs\fR ( int nsecs ) const" +.br +.ti -1c +.BI "int \fBdaysTo\fR ( const QDateTime & dt ) const" +.br +.ti -1c +.BI "int \fBsecsTo\fR ( const QDateTime & dt ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QDateTime & dt ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QDateTime & dt ) const" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const QDateTime & dt ) const" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const QDateTime & dt ) const" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const QDateTime & dt ) const" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const QDateTime & dt ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QDateTime \fBcurrentDateTime\fR ()" +.br +.ti -1c +.BI "QDateTime \fBcurrentDateTime\fR ( Qt::TimeSpec ts )" +.br +.ti -1c +.BI "QDateTime \fBfromString\fR ( const QString & s, Qt::DateFormat f = Qt::TextDate )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QDateTime & dt )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QDateTime & dt )" +.br +.in -1c +.SH DESCRIPTION +The QDateTime class provides date and time functions. +.PP +A QDateTime object contains a calendar date and a clock time (a" datetime"). It is a combination of the QDate and QTime classes. It can read the current datetime from the system clock. It provides functions for comparing datetimes and for manipulating a datetime by adding a number of seconds, days, months or years. +.PP +A QDateTime object is typically created either by giving a date and time explicitly in the constructor, or by using the static function currentDateTime(), which returns a QDateTime object set to the system clock's time. The date and time can be changed with setDate() and setTime(). A datetime can also be set using the setTime_t() function, which takes a POSIX-standard "number of seconds since 00:00:00 on January 1, 1970" value. The fromString() function returns a QDateTime given a string and a date format which is used to interpret the date within the string. +.PP +The date() and time() functions provide access to the date and time parts of the datetime. The same information is provided in textual format by the toString() function. +.PP +QDateTime provides a full set of operators to compare two QDateTime objects where smaller means earlier and larger means later. +.PP +You can increment (or decrement) a datetime by a given number of seconds using addSecs() or days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two datetimes, and secsTo() returns the number of seconds between two datetimes. +.PP +The range of a datetime object is constrained to the ranges of the QDate and QTime objects which it embodies. +.PP +See also QDate, QTime, QDateTimeEdit, and Time and Date. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDateTime::QDateTime ()" +Constructs a null datetime (i.e. null date and null time). A null datetime is invalid, since the date is invalid. +.PP +See also isValid(). +.SH "QDateTime::QDateTime ( const QDate & date )" +Constructs a datetime with date \fIdate\fR and null (but valid) time (00:00:00.000). +.SH "QDateTime::QDateTime ( const QDate & date, const QTime & time )" +Constructs a datetime with date \fIdate\fR and time \fItime\fR. +.SH "QDateTime QDateTime::addDays ( int ndays ) const" +Returns a QDateTime object containing a datetime \fIndays\fR days later than the datetime of this object (or earlier if \fIndays\fR is negative). +.PP +See also daysTo(), addMonths(), addYears(), and addSecs(). +.SH "QDateTime QDateTime::addMonths ( int nmonths ) const" +Returns a QDateTime object containing a datetime \fInmonths\fR months later than the datetime of this object (or earlier if \fInmonths\fR is negative). +.PP +See also daysTo(), addDays(), addYears(), and addSecs(). +.SH "QDateTime QDateTime::addSecs ( int nsecs ) const" +Returns a QDateTime object containing a datetime \fInsecs\fR seconds later than the datetime of this object (or earlier if \fInsecs\fR is negative). +.PP +See also secsTo(), addDays(), addMonths(), and addYears(). +.PP +Example: listviews/listviews.cpp. +.SH "QDateTime QDateTime::addYears ( int nyears ) const" +Returns a QDateTime object containing a datetime \fInyears\fR years later than the datetime of this object (or earlier if \fInyears\fR is negative). +.PP +See also daysTo(), addDays(), addMonths(), and addSecs(). +.SH "QDateTime QDateTime::currentDateTime ( Qt::TimeSpec ts )\fC [static]\fR" +Returns the current datetime, as reported by the system clock, for the TimeSpec \fIts\fR. The default TimeSpec is LocalTime. +.PP +See also QDate::currentDate(), QTime::currentTime(), and Qt::TimeSpec. +.PP +Example: listviews/listviews.cpp. +.SH "QDateTime QDateTime::currentDateTime ()\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the current datetime, as reported by the system clock. +.PP +See also QDate::currentDate() and QTime::currentTime(). +.SH "QDate QDateTime::date () const" +Returns the date part of the datetime. +.PP +See also setDate() and time(). +.SH "int QDateTime::daysTo ( const QDateTime & dt ) const" +Returns the number of days from this datetime to \fIdt\fR (which is negative if \fIdt\fR is earlier than this datetime). +.PP +See also addDays() and secsTo(). +.SH "QDateTime QDateTime::fromString ( const QString & s, Qt::DateFormat f = Qt::TextDate )\fC [static]\fR" +Returns the QDateTime represented by the string \fIs\fR, using the format \fIf\fR, or an invalid datetime if this is not possible. +.PP +Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used, they depend on the user's locale settings. +.PP +\fBWarning:\fR Note that Qt::LocalDate cannot be used here. +.SH "bool QDateTime::isNull () const" +Returns TRUE if both the date and the time are null; otherwise returns FALSE. A null datetime is invalid. +.PP +See also QDate::isNull() and QTime::isNull(). +.SH "bool QDateTime::isValid () const" +Returns TRUE if both the date and the time are valid; otherwise returns FALSE. +.PP +See also QDate::isValid() and QTime::isValid(). +.SH "bool QDateTime::operator!= ( const QDateTime & dt ) const" +Returns TRUE if this datetime is different from \fIdt\fR; otherwise returns FALSE. +.PP +See also operator==(). +.SH "bool QDateTime::operator< ( const QDateTime & dt ) const" +Returns TRUE if this datetime is earlier than \fIdt\fR; otherwise returns FALSE. +.SH "bool QDateTime::operator<= ( const QDateTime & dt ) const" +Returns TRUE if this datetime is earlier than or equal to \fIdt\fR; otherwise returns FALSE. +.SH "bool QDateTime::operator== ( const QDateTime & dt ) const" +Returns TRUE if this datetime is equal to \fIdt\fR; otherwise returns FALSE. +.PP +See also operator!=(). +.SH "bool QDateTime::operator> ( const QDateTime & dt ) const" +Returns TRUE if this datetime is later than \fIdt\fR; otherwise returns FALSE. +.SH "bool QDateTime::operator>= ( const QDateTime & dt ) const" +Returns TRUE if this datetime is later than or equal to \fIdt\fR; otherwise returns FALSE. +.SH "int QDateTime::secsTo ( const QDateTime & dt ) const" +Returns the number of seconds from this datetime to \fIdt\fR (which is negative if \fIdt\fR is earlier than this datetime). +.PP +Example: +.PP +.nf +.br + QDateTime dt = QDateTime::currentDateTime(); +.br + QDateTime xmas( QDate(dt.date().year(),12,24), QTime(17,00) ); +.br + tqDebug( "There are %d seconds to Christmas", dt.secsTo(xmas) ); +.br +.fi +.PP +See also addSecs(), daysTo(), and QTime::secsTo(). +.SH "void QDateTime::setDate ( const QDate & date )" +Sets the date part of this datetime to \fIdate\fR. +.PP +See also date() and setTime(). +.SH "void QDateTime::setTime ( const QTime & time )" +Sets the time part of this datetime to \fItime\fR. +.PP +See also time() and setDate(). +.SH "void QDateTime::setTime_t ( uint secsSince1Jan1970UTC, Qt::TimeSpec ts )" +Sets the date and time to \fIts\fR time (Qt::LocalTime or Qt::UTC) given the number of seconds that have passed since 1970-01-01T00:00:00, Coordinated Universal Time (UTC). On systems that do not support timezones this function will behave as if local time were UTC. +.PP +On Windows, only a subset of \fIsecsSince1Jan1970UTC\fR values are supported, as Windows starts counting from 1980. +.PP +See also toTime_t(). +.SH "void QDateTime::setTime_t ( uint secsSince1Jan1970UTC )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Convenience function that sets the date and time to local time based on the given UTC time. +.SH "QTime QDateTime::time () const" +Returns the time part of the datetime. +.PP +See also setTime() and date(). +.SH "QString QDateTime::toString ( const QString & format ) const" +Returns the datetime as a string. The \fIformat\fR parameter determines the format of the result string. +.PP +These expressions may be used for the date: +.PP +<center>.nf +.TS +l - l. Expression Output d the day as number without a leading zero (1-31) dd the day as number with a leading zero (01-31) ddd the abbreviated localized day name (e.g. 'Mon'..'Sun'). Uses QDate::shortDayName(). dddd the long localized day name (e.g. 'Monday'..'Sunday'). Uses QDate::longDayName(). M the month as number without a leading zero (1-12) MM the month as number with a leading zero (01-12) MMM the abbreviated localized month name (e.g. 'Jan'..'Dec'). Uses QDate::shortMonthName(). MMMM the long localized month name (e.g. 'January'..'December'). Uses QDate::longMonthName(). yy the year as two digit number (00-99) yyyy +.TE +.fi +</center> +.PP +These expressions may be used for the time: +.PP +<center>.nf +.TS +l - l. Expression Output h the hour without a leading zero (0..23 or 1..12 if AM/PM display) hh the hour with a leading zero (00..23 or 01..12 if AM/PM display) m the minute without a leading zero (0..59) mm the minute with a leading zero (00..59) s the second whithout a leading zero (0..59) ss the second whith a leading zero (00..59) z the milliseconds without leading zeroes (0..999) zzz the milliseconds with leading zeroes (000..999) AP use AM/PM display. \fIAP\fR will be replaced by either "AM" or "PM". ap +.TE +.fi +</center> +.PP +All other input characters will be ignored. +.PP +Example format strings (assumed that the QDateTime is 21<small><sup>st</sup></small> May 2001 14:13:09) +.PP +<center>.nf +.TS +l - l. Format Result dd.MM.yyyy 21.05.2001 ddd MMMM d yy Tue May 21 01 hh:mm:ss.zzz 14:13:09.042 h:m:s ap +.TE +.fi +</center> +.PP +If the datetime is an invalid datetime, then QString::null will be returned. +.PP +See also QDate::toString() and QTime::toString(). +.SH "QString QDateTime::toString ( Qt::DateFormat f = Qt::TextDate ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the datetime as a string. The \fIf\fR parameter determines the format of the string. +.PP +If \fIf\fR is Qt::TextDate, the string format is "Wed May 20 03:40:13 1998" (using QDate::shortDayName(), QDate::shortMonthName(), and QTime::toString() to generate the string, so the day and month names will have localized names). +.PP +If \fIf\fR is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, which is YYYY-MM-DDTHH:MM:SS. +.PP +If \fIf\fR is Qt::LocalDate, the string format depends on the locale settings of the system. +.PP +If the format \fIf\fR is invalid or the datetime is invalid, toString() returns a null string. +.PP +See also QDate::toString() and QTime::toString(). +.SH "uint QDateTime::toTime_t () const" +Returns the datetime as the number of seconds that have passed since 1970-01-01T00:00:00, Coordinated Universal Time (UTC). +.PP +On systems that do not support timezones, this function will behave as if local time were UTC. +.PP +See also setTime_t(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QDateTime & dt )" +Writes the datetime \fIdt\fR to the stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QDateTime & dt )" +Reads a datetime from the stream \fIs\fR into \fIdt\fR. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdatetime.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdatetime.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdatetimeedit.3qt b/doc/man/man3/tqdatetimeedit.3qt new file mode 100644 index 000000000..d4e1a0ba2 --- /dev/null +++ b/doc/man/man3/tqdatetimeedit.3qt @@ -0,0 +1,146 @@ +'\" t +.TH QDateTimeEdit 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 +QDateTimeEdit \- Combines a QDateEdit and QTimeEdit widget into a single widget for editing datetimes +.SH SYNOPSIS +\fC#include <ntqdatetimeedit.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDateTimeEdit\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQDateTimeEdit\fR ( const QDateTime & datetime, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QDateTimeEdit\fR ()" +.br +.ti -1c +.BI "QDateTime \fBdateTime\fR () const" +.br +.ti -1c +.BI "QDateEdit * \fBdateEdit\fR ()" +.br +.ti -1c +.BI "QTimeEdit * \fBtimeEdit\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetAutoAdvance\fR ( bool advance )" +.br +.ti -1c +.BI "bool \fBautoAdvance\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetDateTime\fR ( const QDateTime & dt )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBvalueChanged\fR ( const QDateTime & datetime )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QDateTime \fBdateTime\fR - the editor's datetime value" +.br +.in -1c +.SH DESCRIPTION +The QDateTimeEdit class combines a QDateEdit and QTimeEdit widget into a single widget for editing datetimes. +.PP +QDateTimeEdit consists of a QDateEdit and QTimeEdit widget placed side by side and offers the functionality of both. The user can edit the date and time by using the keyboard or the arrow keys to increase/decrease date or time values. The Tab key can be used to move from section to section within the QDateTimeEdit widget, and the user can be moved automatically when they complete a section using setAutoAdvance(). The datetime can be set with setDateTime(). +.PP +The date format is read from the system's locale settings. It is set to year, month, day order if that is not possible. See QDateEdit::setOrder() to change this. Times appear in the order hours, minutes, seconds using the 24 hour clock. +.PP +It is recommended that the QDateTimeEdit is initialised with a datetime, e.g. +.PP +.nf +.br + QDateTimeEdit *dateTimeEdit = new QDateTimeEdit( QDateTime::currentDateTime(), this ); +.br + dateTimeEdit->dateEdit()->setRange( QDateTime::currentDate(), +.br + QDateTime::currentDate().addDays( 7 ) ); +.br +.fi +Here we've created a new QDateTimeEdit set to the current date and time, and set the date to have a minimum date of now and a maximum date of a week from now. +.PP +Terminology: A QDateEdit widget consists of three 'sections', one each for the year, month and day. Similarly a QTimeEdit consists of three sections, one each for the hour, minute and second. The character that separates each date section is specified with setDateSeparator(); similarly setTimeSeparator() is used for the time sections. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QDateEdit, QTimeEdit, Advanced Widgets, and Time and Date. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDateTimeEdit::QDateTimeEdit ( QWidget * parent = 0, const char * name = 0 )" +Constructs an empty datetime edit with parent \fIparent\fR and called \fIname\fR. +.SH "QDateTimeEdit::QDateTimeEdit ( const QDateTime & datetime, QWidget * parent = 0, const char * name = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a datetime edit with the initial value \fIdatetime\fR, parent \fIparent\fR and called \fIname\fR. +.SH "QDateTimeEdit::~QDateTimeEdit ()" +Destroys the object and frees any allocated resources. +.SH "bool QDateTimeEdit::autoAdvance () const" +Returns TRUE if auto-advance is enabled, otherwise returns FALSE. +.PP +See also setAutoAdvance(). +.SH "QDateEdit * QDateTimeEdit::dateEdit ()" +Returns the internal widget used for editing the date part of the datetime. +.SH "QDateTime QDateTimeEdit::dateTime () const" +Returns the editor's datetime value. See the "dateTime" property for details. +.SH "void QDateTimeEdit::setAutoAdvance ( bool advance )\fC [virtual]\fR" +Sets the auto advance property of the editor to \fIadvance\fR. If set to TRUE, the editor will automatically advance focus to the next date or time section if the user has completed a section. +.SH "void QDateTimeEdit::setDateTime ( const QDateTime & dt )\fC [virtual slot]\fR" +Sets the editor's datetime value to \fIdt\fR. See the "dateTime" property for details. +.SH "QTimeEdit * QDateTimeEdit::timeEdit ()" +Returns the internal widget used for editing the time part of the datetime. +.SH "void QDateTimeEdit::valueChanged ( const QDateTime & datetime )\fC [signal]\fR" +This signal is emitted every time the date or time changes. The \fIdatetime\fR argument is the new datetime. +.SS "Property Documentation" +.SH "QDateTime dateTime" +This property holds the editor's datetime value. +.PP +The datetime edit's datetime which may be an invalid datetime. +.PP +Set this property's value with setDateTime() and get this property's value with dateTime(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdatetimeedit.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdatetimeedit.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdatetimeeditbase.3qt b/doc/man/man3/tqdatetimeeditbase.3qt new file mode 100644 index 000000000..ce95fc901 --- /dev/null +++ b/doc/man/man3/tqdatetimeeditbase.3qt @@ -0,0 +1,48 @@ +'\" t +.TH QDateTimeEditBase 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 +QDateTimeEditBase \- Abstraction for date and edit editors +.SH SYNOPSIS +\fC#include <ntqdatetimeedit.h>\fR +.PP +Inherits QWidget. +.PP +Inherited by QDateEdit and QTimeEdit. +.PP +.SH DESCRIPTION +The QDateTimeEditBase class provides an abstraction for date and edit editors. +.PP +Small abstract class that provides some functions that are common +for both QDateEdit and QTimeEdit. It is used internally by +QDateTimeEditor. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdatetimeeditbase.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdatetimeeditbase.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdeepcopy.3qt b/doc/man/man3/tqdeepcopy.3qt new file mode 100644 index 000000000..578f7ed61 --- /dev/null +++ b/doc/man/man3/tqdeepcopy.3qt @@ -0,0 +1,190 @@ +'\" t +.TH QDeepCopy 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 +QDeepCopy \- Template class which ensures that +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdeepcopy.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDeepCopy\fR ()" +.br +.ti -1c +.BI "\fBQDeepCopy\fR ( const T & t )" +.br +.ti -1c +.BI "QDeepCopy<T> & \fBoperator=\fR ( const T & t )" +.br +.ti -1c +.BI "\fBoperator T\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QDeepCopy class is a template class which ensures that implicitly shared and explicitly shared classes reference unique data. +.PP +Normally, shared copies reference the same data to optimize memory use and for maximum speed. In the example below, \fCs1\fR, \fCs2\fR, \fCs3\fR, \fCs4\fR and \fCs5\fR share data. +.PP +.nf +.br + // all 5 strings share the same data +.br + QString s1 = "abcd"; +.br + QString s2 = s1; +.br + QString s3 = s2; +.br + QString s4 = s3; +.br + QString s5 = s2; +.br +.fi +.PP +QDeepCopy can be used several ways to ensure that an object references unique, unshared data. In the example below, \fCs1\fR, \fCs2\fR and \fCs5\fR share data, while neither \fCs3\fR nor \fCs4\fR share data. +.PP +.nf +.br + // s1, s2 and s5 share the same data, neither s3 nor s4 are shared +.br + QString s1 = "abcd"; +.br + QString s2 = s1; +.br + QDeepCopy<QString> s3 = s2; // s3 is a deep copy of s2 +.br + QString s4 = s3; // s4 is a deep copy of s3 +.br + QString s5 = s2; +.br +.fi +.PP +In the example below, \fCs1\fR, \fCs2\fR and \fCs5\fR share data, and \fCs3\fR and \fCs4\fR share data. +.PP +.nf +.br + // s1, s2 and s5 share the same data, s3 and s4 share the same data +.br + QString s1 = "abcd"; +.br + QString s2 = s1; +.br + QString s3 = QDeepCopy<QString>( s2 ); // s3 is a deep copy of s2 +.br + QString s4 = s3; // s4 is a shallow copy of s3 +.br + QString s5 = s2; +.br +.fi +.PP +QDeepCopy can also provide safety in multithreaded applications that use shared classes. In the example below, the variable \fCglobal_string\fR is used safely since the data contained in \fCglobal_string\fR is always a deep copy. This ensures that all threads get a unique copy of the data, and that any assignments to \fCglobal_string\fR will result in a deep copy. +.PP +.nf +.br + QDeepCopy<QString> global_string; // global string data +.br + QMutex global_mutex; // mutex to protext global_string +.br +.br + ... +.br +.br + void setGlobalString( const QString &str ) +.br + { +.br + global_mutex.lock(); +.br + global_string = str; // global_string is a deep copy of str +.br + global_mutex.unlock(); +.br + } +.br +.br + ... +.br +.br + void MyThread::run() +.br + { +.br + global_mutex.lock(); +.br + QString str = global_string; // str is a deep copy of global_string +.br + global_mutex.unlock(); +.br +.br + // process the string data +.br + ... +.br +.br + // update global_string +.br + setGlobalString( str ); +.br + } +.br +.fi +.PP +\fBWarning:\fR It is the application developer's responsibility to protect the object shared across multiple threads. +.PP +The examples above use QString, which is an implicitly shared class. The behavior of QDeepCopy is the same when using explicitly shared classes like QByteArray. +.PP +Currently, QDeepCopy works with the following classes: +.TP +QMemArray (including subclasses like QByteArray and QCString) +.TP +QMap +.TP +QString +.TP +QValueList (including subclasses like QStringList and QValueStack) +.TP +QValueVector +.PP +See also Thread Support in Qt, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDeepCopy::QDeepCopy ()" +Constructs an empty instance of type \fIT\fR. +.SH "QDeepCopy::QDeepCopy ( const T & t )" +Constructs a deep copy of \fIt\fR. +.SH "QDeepCopy::operator T ()" +Returns a deep copy of the encapsulated data. +.SH "QDeepCopy<T> & QDeepCopy::operator= ( const T & t )" +Assigns a deep copy of \fIt\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdeepcopy.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdeepcopy.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdesktopwidget.3qt b/doc/man/man3/tqdesktopwidget.3qt new file mode 100644 index 000000000..235b11f46 --- /dev/null +++ b/doc/man/man3/tqdesktopwidget.3qt @@ -0,0 +1,190 @@ +'\" t +.TH QDesktopWidget 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 +QDesktopWidget \- Access to screen information on multi-head systems +.SH SYNOPSIS +\fC#include <ntqdesktopwidget.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDesktopWidget\fR ()" +.br +.ti -1c +.BI "\fB~QDesktopWidget\fR ()" +.br +.ti -1c +.BI "bool \fBisVirtualDesktop\fR () const" +.br +.ti -1c +.BI "int \fBnumScreens\fR () const" +.br +.ti -1c +.BI "int \fBprimaryScreen\fR () const" +.br +.ti -1c +.BI "int \fBscreenNumber\fR ( QWidget * widget = 0 ) const" +.br +.ti -1c +.BI "int \fBscreenNumber\fR ( const QPoint & point ) const" +.br +.ti -1c +.BI "QWidget * \fBscreen\fR ( int screen = -1 )" +.br +.ti -1c +.BI "const QRect & \fBscreenGeometry\fR ( int screen = -1 ) const" +.br +.ti -1c +.BI "const QRect & \fBscreenGeometry\fR ( QWidget * widget ) const" +.br +.ti -1c +.BI "const QRect & \fBscreenGeometry\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "const QRect & \fBavailableGeometry\fR ( int screen = -1 ) const" +.br +.ti -1c +.BI "const QRect & \fBavailableGeometry\fR ( QWidget * widget ) const" +.br +.ti -1c +.BI "const QRect & \fBavailableGeometry\fR ( const QPoint & p ) const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBresized\fR ( int screen )" +.br +.in -1c +.SH DESCRIPTION +The QDesktopWidget class provides access to screen information on multi-head systems. +.PP +Systems with more than one graphics card and monitor can manage the physical screen space available either as multiple desktops, or as a large virtual desktop, which usually has the size of the bounding rectangle of all the screens (see isVirtualDesktop()). For an application, one of the available screens is the primary screen, i.e. the screen where the main widget resides (see primaryScreen()). All windows opened in the context of the application must be constrained to the boundaries of the primary screen; for example, it would be inconvenient if a dialog box popped up on a different screen, or split over two screens. +.PP +The QDesktopWidget provides information about the geometry of the available screens with screenGeometry(). The number of screens available is returned by numScreens(). The screen number that a particular point or widget is located in is returned by screenNumber(). +.PP +Widgets provided by Qt use this class, for example, to place tooltips, menus and dialog boxes according to the parent or application widget. +.PP +Applications can use this class to save window positions, or to place child widgets on one screen. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +In the illustration above, Application One's primary screen is screen 0, and App Two's primary screen is screen 1. +.PP +See also Advanced Widgets and Environment Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDesktopWidget::QDesktopWidget ()" +Creates the desktop widget. +.PP +If the system supports a virtual desktop, this widget will have the size of the virtual desktop; otherwise this widget will have the size of the primary screen. +.PP +Instead of using QDesktopWidget directly, use QApplication::desktop(). +.SH "QDesktopWidget::~QDesktopWidget ()" +Destroy the object and free allocated resources. +.SH "const QRect & QDesktopWidget::availableGeometry ( int screen = -1 ) const" +Returns the available geometry of the screen with index \fIscreen\fR. What is available will be subrect of screenGeometry() based on what the platform decides is available (for example excludes the Dock and Menubar on Mac OS X, or the taskbar on Windows). +.PP +See also screenNumber() and screenGeometry(). +.SH "const QRect & QDesktopWidget::availableGeometry ( QWidget * widget ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the available geometry of the screen which contains \fIwidget\fR. +.PP +See also screenGeometry(). +.SH "const QRect & QDesktopWidget::availableGeometry ( const QPoint & p ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the available geometry of the screen which contains \fIp\fR. +.PP +See also screenGeometry(). +.SH "bool QDesktopWidget::isVirtualDesktop () const" +Returns TRUE if the system manages the available screens in a virtual desktop; otherwise returns FALSE. +.PP +For virtual desktops, screen() will always return the same widget. The size of the virtual desktop is the size of this desktop widget. +.SH "int QDesktopWidget::numScreens () const" +Returns the number of available screens. +.PP +See also primaryScreen(). +.SH "int QDesktopWidget::primaryScreen () const" +Returns the index of the primary screen. +.PP +See also numScreens(). +.SH "void QDesktopWidget::resized ( int screen )\fC [signal]\fR" +This signal is emitted when the size of \fIscreen\fR changes. +.SH "QWidget * QDesktopWidget::screen ( int screen = -1 )" +Returns a widget that represents the screen with index \fIscreen\fR. This widget can be used to draw directly on the desktop, using an unclipped painter like this: +.PP +.nf +.br + QPainter paint( QApplication::desktop()->screen( 0 ), TRUE ); +.br + paint.draw... +.br + ... +.br + paint.end(); +.br +.fi +.PP +If the system uses a virtual desktop, the returned widget will have the geometry of the entire virtual desktop i.e. bounding every \fIscreen\fR. +.PP +See also primaryScreen(), numScreens(), and isVirtualDesktop(). +.SH "const QRect & QDesktopWidget::screenGeometry ( int screen = -1 ) const" +Returns the geometry of the screen with index \fIscreen\fR. +.PP +See also screenNumber(). +.SH "const QRect & QDesktopWidget::screenGeometry ( QWidget * widget ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the geometry of the screen which contains \fIwidget\fR. +.SH "const QRect & QDesktopWidget::screenGeometry ( const QPoint & p ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the geometry of the screen which contains \fIp\fR. +.SH "int QDesktopWidget::screenNumber ( QWidget * widget = 0 ) const" +Returns the index of the screen that contains the largest part of \fIwidget\fR, or -1 if the widget not on a screen. +.PP +See also primaryScreen(). +.SH "int QDesktopWidget::screenNumber ( const QPoint & point ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the index of the screen that contains \fIpoint\fR, or -1 if no screen contains the point. +.PP +See also primaryScreen(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdesktopwidget.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdesktopwidget.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdial.3qt b/doc/man/man3/tqdial.3qt new file mode 100644 index 000000000..49bcb96e1 --- /dev/null +++ b/doc/man/man3/tqdial.3qt @@ -0,0 +1,365 @@ +'\" t +.TH QDial 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 +QDial \- Rounded range control (like a speedometer or potentiometer) +.SH SYNOPSIS +\fC#include <ntqdial.h>\fR +.PP +Inherits QWidget and QRangeControl. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDial\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQDial\fR ( int minValue, int maxValue, int pageStep, int value, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QDial\fR ()" +.br +.ti -1c +.BI "bool \fBtracking\fR () const" +.br +.ti -1c +.BI "bool \fBwrapping\fR () const" +.br +.ti -1c +.BI "int \fBnotchSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNotchTarget\fR ( double )" +.br +.ti -1c +.BI "double \fBnotchTarget\fR () const" +.br +.ti -1c +.BI "bool \fBnotchesVisible\fR () const" +.br +.ti -1c +.BI "int \fBminValue\fR () const" +.br +.ti -1c +.BI "int \fBmaxValue\fR () const" +.br +.ti -1c +.BI "void \fBsetMinValue\fR ( int )" +.br +.ti -1c +.BI "void \fBsetMaxValue\fR ( int )" +.br +.ti -1c +.BI "int \fBlineStep\fR () const" +.br +.ti -1c +.BI "int \fBpageStep\fR () const" +.br +.ti -1c +.BI "void \fBsetLineStep\fR ( int )" +.br +.ti -1c +.BI "void \fBsetPageStep\fR ( int )" +.br +.ti -1c +.BI "int \fBvalue\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetValue\fR ( int )" +.br +.ti -1c +.BI "void \fBaddLine\fR ()" +.br +.ti -1c +.BI "void \fBsubtractLine\fR ()" +.br +.ti -1c +.BI "void \fBaddPage\fR ()" +.br +.ti -1c +.BI "void \fBsubtractPage\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetNotchesVisible\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetWrapping\fR ( bool on )" +.br +.ti -1c +.BI "virtual void \fBsetTracking\fR ( bool enable )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBvalueChanged\fR ( int value )" +.br +.ti -1c +.BI "void \fBdialPressed\fR ()" +.br +.ti -1c +.BI "void \fBdialMoved\fR ( int value )" +.br +.ti -1c +.BI "void \fBdialReleased\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBlineStep\fR - the current line step" +.br +.ti -1c +.BI "int \fBmaxValue\fR - the current maximum value" +.br +.ti -1c +.BI "int \fBminValue\fR - the current minimum value" +.br +.ti -1c +.BI "int \fBnotchSize\fR - the current notch size \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "double \fBnotchTarget\fR - the target number of pixels between notches" +.br +.ti -1c +.BI "bool \fBnotchesVisible\fR - whether the notches are shown" +.br +.ti -1c +.BI "int \fBpageStep\fR - the current page step" +.br +.ti -1c +.BI "bool \fBtracking\fR - whether tracking is enabled" +.br +.ti -1c +.BI "int \fBvalue\fR - the current dial value" +.br +.ti -1c +.BI "bool \fBwrapping\fR - whether wrapping is enabled" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBvalueChange\fR ()" +.br +.ti -1c +.BI "virtual void \fBrangeChange\fR ()" +.br +.ti -1c +.BI "virtual void \fBrepaintScreen\fR ( const QRect * cr = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QDial class provides a rounded range control (like a speedometer or potentiometer). +.PP +QDial is used when the user needs to control a value within a program-definable range, and the range either wraps around (typically, 0..359 degrees) or the dialog layout needs a square widget. +.PP +Both API- and UI-wise, the dial is very similar to a slider. Indeed, when wrapping() is FALSE (the default) there is no real difference between a slider and a dial. They have the same signals, slots and member functions, all of which do the same things. Which one you use depends only on your taste and on the application. +.PP +The dial initially emits valueChanged() signals continuously while the slider is being moved; you can make it emit the signal less often by calling setTracking(FALSE). dialMoved() is emitted continuously even when tracking() is FALSE. +.PP +The slider also emits dialPressed() and dialReleased() signals when the mouse button is pressed and released. But note that the dial's value can change without these signals being emitted; the keyboard and wheel can be used to change the value. +.PP +Unlike the slider, QDial attempts to draw a "nice" number of notches rather than one per lineStep(). If possible, the number of notches drawn is one per lineStep(), but if there aren't enough pixels to draw every one, QDial will draw every second, third etc., notch. notchSize() returns the number of units per notch, hopefully a multiple of lineStep(); setNotchTarget() sets the target distance between neighbouring notches in pixels. The default is 3.75 pixels. +.PP +Like the slider, the dial makes the QRangeControl functions setValue(), addLine(), subtractLine(), addPage() and subtractPage() available as slots. +.PP +The dial's keyboard interface is fairly simple: The left/up and right/down arrow keys move by lineStep(), page up and page down by pageStep() and Home and End to minValue() and maxValue(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QScrollBar, QSpinBox, GUI Design Handbook: Slider, and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDial::QDial ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a dial called \fIname\fR with parent \fIparent\fR. \fIf\fR is propagated to the QWidget constructor. It has the default range of a QRangeControl. +.SH "QDial::QDial ( int minValue, int maxValue, int pageStep, int value, QWidget * parent = 0, const char * name = 0 )" +Constructs a dial called \fIname\fR with parent \fIparent\fR. The dial's value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR. Its page step size is \fIpageStep\fR, and its initial value is \fIvalue\fR. +.PP +\fIvalue\fR is forced to be within the legal range. +.SH "QDial::~QDial ()" +Destroys the dial. +.SH "void QDial::addLine ()\fC [slot]\fR" +Increments the dial's value() by one lineStep(). +.SH "void QDial::addPage ()\fC [slot]\fR" +Increments the dial's value() by one pageStep() of steps. +.SH "void QDial::dialMoved ( int value )\fC [signal]\fR" +This signal is emitted whenever the dial \fIvalue\fR changes. The frequency of this signal is \fInot\fR influenced by setTracking(). +.PP +See also valueChanged(). +.SH "void QDial::dialPressed ()\fC [signal]\fR" +This signal is emitted when the user begins mouse interaction with the dial. +.PP +See also dialReleased(). +.SH "void QDial::dialReleased ()\fC [signal]\fR" +This signal is emitted when the user ends mouse interaction with the dial. +.PP +See also dialPressed(). +.SH "int QDial::lineStep () const" +Returns the current line step. See the "lineStep" property for details. +.SH "int QDial::maxValue () const" +Returns the current maximum value. See the "maxValue" property for details. +.SH "int QDial::minValue () const" +Returns the current minimum value. See the "minValue" property for details. +.SH "int QDial::notchSize () const" +Returns the current notch size. See the "notchSize" property for details. +.SH "double QDial::notchTarget () const" +Returns the target number of pixels between notches. See the "notchTarget" property for details. +.SH "bool QDial::notchesVisible () const" +Returns TRUE if the notches are shown; otherwise returns FALSE. See the "notchesVisible" property for details. +.SH "int QDial::pageStep () const" +Returns the current page step. See the "pageStep" property for details. +.SH "void QDial::rangeChange ()\fC [virtual protected]\fR" +Reimplemented to ensure tick-marks are consistent with the new range. +.PP +Reimplemented from QRangeControl. +.SH "void QDial::repaintScreen ( const QRect * cr = 0 )\fC [virtual protected]\fR" +Paints the dial using clip region \fIcr\fR. +.SH "void QDial::setLineStep ( int )" +Sets the current line step. See the "lineStep" property for details. +.SH "void QDial::setMaxValue ( int )" +Sets the current maximum value. See the "maxValue" property for details. +.SH "void QDial::setMinValue ( int )" +Sets the current minimum value. See the "minValue" property for details. +.SH "void QDial::setNotchTarget ( double )\fC [virtual]\fR" +Sets the target number of pixels between notches. See the "notchTarget" property for details. +.SH "void QDial::setNotchesVisible ( bool b )\fC [virtual slot]\fR" +Sets whether the notches are shown to \fIb\fR. See the "notchesVisible" property for details. +.SH "void QDial::setPageStep ( int )" +Sets the current page step. See the "pageStep" property for details. +.SH "void QDial::setTracking ( bool enable )\fC [virtual slot]\fR" +Sets whether tracking is enabled to \fIenable\fR. See the "tracking" property for details. +.SH "void QDial::setValue ( int )\fC [virtual slot]\fR" +Sets the current dial value. See the "value" property for details. +.SH "void QDial::setWrapping ( bool on )\fC [virtual slot]\fR" +Sets whether wrapping is enabled to \fIon\fR. See the "wrapping" property for details. +.SH "void QDial::subtractLine ()\fC [slot]\fR" +Decrements the dial's value() by one lineStep(). +.SH "void QDial::subtractPage ()\fC [slot]\fR" +Decrements the dial's value() by one pageStep() of steps. +.SH "bool QDial::tracking () const" +Returns TRUE if tracking is enabled; otherwise returns FALSE. See the "tracking" property for details. +.SH "int QDial::value () const" +Returns the current dial value. See the "value" property for details. +.SH "void QDial::valueChange ()\fC [virtual protected]\fR" +Reimplemented to ensure the display is correct and to emit the valueChanged(int) signal when appropriate. +.PP +Reimplemented from QRangeControl. +.SH "void QDial::valueChanged ( int value )\fC [signal]\fR" +This signal is emitted whenever the dial's \fIvalue\fR changes. The frequency of this signal is influenced by setTracking(). +.SH "bool QDial::wrapping () const" +Returns TRUE if wrapping is enabled; otherwise returns FALSE. See the "wrapping" property for details. +.SS "Property Documentation" +.SH "int lineStep" +This property holds the current line step. +.PP +setLineStep() calls the virtual stepChange() function if the new line step is different from the previous setting. +.PP +See also QRangeControl::setSteps(), pageStep, and setRange(). +.PP +Set this property's value with setLineStep() and get this property's value with lineStep(). +.SH "int maxValue" +This property holds the current maximum value. +.PP +When setting this property, the QDial::minValue is adjusted if necessary to ensure that the range remains valid. +.PP +See also setRange(). +.PP +Set this property's value with setMaxValue() and get this property's value with maxValue(). +.SH "int minValue" +This property holds the current minimum value. +.PP +When setting this property, the QDial::maxValue is adjusted if necessary to ensure that the range remains valid. +.PP +See also setRange(). +.PP +Set this property's value with setMinValue() and get this property's value with minValue(). +.SH "int notchSize" +This property holds the current notch size. +.PP +The notch size is in range control units, not pixels, and if possible it is a multiple of lineStep() that results in an on-screen notch size near notchTarget(). +.PP +See also notchTarget and lineStep. +.PP +Get this property's value with notchSize(). +.SH "double notchTarget" +This property holds the target number of pixels between notches. +.PP +The notch target is the number of pixels QDial attempts to put between each notch. +.PP +The actual size may differ from the target size. +.PP +Set this property's value with setNotchTarget() and get this property's value with notchTarget(). +.SH "bool notchesVisible" +This property holds whether the notches are shown. +.PP +If TRUE, the notches are shown. If FALSE (the default) notches are not shown. +.PP +Set this property's value with setNotchesVisible() and get this property's value with notchesVisible(). +.SH "int pageStep" +This property holds the current page step. +.PP +setPageStep() calls the virtual stepChange() function if the new page step is different from the previous setting. +.PP +See also stepChange(). +.PP +Set this property's value with setPageStep() and get this property's value with pageStep(). +.SH "bool tracking" +This property holds whether tracking is enabled. +.PP +If TRUE (the default), tracking is enabled. This means that the arrow can be moved using the mouse; otherwise the arrow cannot be moved with the mouse. +.PP +Set this property's value with setTracking() and get this property's value with tracking(). +.SH "int value" +This property holds the current dial value. +.PP +This is guaranteed to be within the range QDial::minValue..QDial::maxValue. +.PP +See also minValue and maxValue. +.PP +Set this property's value with setValue() and get this property's value with value(). +.SH "bool wrapping" +This property holds whether wrapping is enabled. +.PP +If TRUE, wrapping is enabled. This means that the arrow can be turned around 360°. Otherwise there is some space at the bottom of the dial which is skipped by the arrow. +.PP +This property's default is FALSE. +.PP +Set this property's value with setWrapping() and get this property's value with wrapping(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdial.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdial.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdialog.3qt b/doc/man/man3/tqdialog.3qt new file mode 100644 index 000000000..5dce01ddd --- /dev/null +++ b/doc/man/man3/tqdialog.3qt @@ -0,0 +1,322 @@ +'\" t +.TH QDialog 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 +QDialog \- The base class of dialog windows +.SH SYNOPSIS +\fC#include <ntqdialog.h>\fR +.PP +Inherits QWidget. +.PP +Inherited by QColorDialog, QErrorMessage, QFileDialog, QFontDialog, QInputDialog, QMessageBox, QMotifDialog, QProgressDialog, QTabDialog, and QWizard. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "explicit \fBQDialog\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QDialog\fR ()" +.br +.ti -1c +.BI "enum \fBDialogCode\fR { Rejected, Accepted }" +.br +.ti -1c +.BI "int \fBresult\fR () const" +.br +.ti -1c +.BI "virtual void \fBshow\fR ()" +.br +.ti -1c +.BI "void \fBsetOrientation\fR ( Orientation orientation )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "void \fBsetExtension\fR ( QWidget * extension )" +.br +.ti -1c +.BI "QWidget * \fBextension\fR () const" +.br +.ti -1c +.BI "void \fBsetSizeGripEnabled\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisSizeGripEnabled\fR () const" +.br +.ti -1c +.BI "void \fBsetModal\fR ( bool modal )" +.br +.ti -1c +.BI "bool \fBisModal\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "int \fBexec\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBmodal\fR - whether show() should pop up the dialog as modal or modeless" +.br +.ti -1c +.BI "bool \fBsizeGripEnabled\fR - whether the size grip is enabled" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsetResult\fR ( int i )" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "virtual void \fBdone\fR ( int r )" +.br +.ti -1c +.BI "virtual void \fBaccept\fR ()" +.br +.ti -1c +.BI "virtual void \fBreject\fR ()" +.br +.ti -1c +.BI "void \fBshowExtension\fR ( bool showIt )" +.br +.in -1c +.SH DESCRIPTION +The QDialog class is the base class of dialog windows. +.PP +A dialog window is a top-level window mostly used for short-term tasks and brief communications with the user. QDialogs may be modal or modeless. QDialogs support extensibility and can provide a return value. They can have default buttons. QDialogs can also have a QSizeGrip in their lower-right corner, using setSizeGripEnabled(). +.PP +Note that QDialog uses the parent widget slightly differently from other classes in Qt. A dialog is always a top-level widget, but if it has a parent, its default location is centered on top of the parent's top-level widget (if it is not top-level itself). It will also share the parent's taskbar entry. +.SH "Modal Dialogs" +A \fBmodal\fR dialog is a dialog that blocks input to other visible windows in the same application. Users must finish interacting with the dialog and close it before they can access any other window in the application. Dialogs that are used to request a file name from the user or that are used to set application preferences are usually modal. +.PP +The most common way to display a modal dialog is to call its exec() function. When the user closes the dialog, exec() will provide a useful return value. Typically we connect a default button, e.g. "OK", to the accept() slot and a" Cancel" button to the reject() slot, to get the dialog to close and return the appropriate value. Alternatively you can connect to the done() slot, passing it Accepted or Rejected. +.PP +An alternative is to call setModal(TRUE), then show(). Unlike exec(), show() returns control to the caller immediately. Calling setModal(TRUE) is especially useful for progress dialogs, where the user must have the ability to interact with the dialog, e.g. to cancel a long running operation. If you use show() and setModal(TRUE) together you must call QApplication::processEvents() periodically during processing to enable the user to interact with the dialog. (See QProgressDialog.) +.SH "Modeless Dialogs" +A \fBmodeless\fR dialog is a dialog that operates independently of other windows in the same application. Find and replace dialogs in word-processors are often modeless to allow the user to interact with both the application's main window and with the dialog. +.PP +Modeless dialogs are displayed using show(), which returns control to the caller immediately. +.SH "Default button" +A dialog's \fIdefault\fR button is the button that's pressed when the user presses Enter (Return). This button is used to signify that the user accepts the dialog's settings and wants to close the dialog. Use QPushButton::setDefault(), QPushButton::isDefault() and QPushButton::autoDefault() to set and control the dialog's default button. +.SH "Escape Key" +If the user presses the Esc key in a dialog, QDialog::reject() will be called. This will cause the window to close: the closeEvent cannot be ignored. +.SH "Extensibility" +Extensibility is the ability to show the dialog in two ways: a partial dialog that shows the most commonly used options, and a full dialog that shows all the options. Typically an extensible dialog will initially appear as a partial dialog, but with a" More" toggle button. If the user presses the "More" button down, the full dialog will appear. The extension widget will be resized to its sizeHint(). If orientation is Horizontal the extension widget's height() will be expanded to the height() of the dialog. If the orientation is Vertical the extension widget's width() will be expanded to the width() of the dialog. Extensibility is controlled with setExtension(), setOrientation() and showExtension(). +.SH "Return value (modal dialogs)" +Modal dialogs are often used in situations where a return value is required, e.g. to indicate whether the user pressed "OK" or" Cancel". A dialog can be closed by calling the accept() or the reject() slots, and exec() will return Accepted or Rejected as appropriate. The exec() call returns the result of the dialog. The result is also available from result() if the dialog has not been destroyed. If the WDestructiveClose flag is set, the dialog is deleted after exec() returns. +.SH "Examples" +A modal dialog. +.PP +.nf +.br + QFileDialog *dlg = new QFileDialog( workingDirectory, +.br + QString::null, 0, 0, TRUE ); +.br + dlg->setCaption( QFileDialog::tr( "Open" ) ); +.br + dlg->setMode( QFileDialog::ExistingFile ); +.br + QString result; +.br + if ( dlg->exec() == QDialog::Accepted ) { +.br + result = dlg->selectedFile(); +.br + workingDirectory = dlg->url(); +.br + } +.br + delete dlg; +.br + return result; +.fi +.PP +A modeless dialog. After the show() call, control returns to the main event loop. +.PP +.nf +.br + int main( int argc, char **argv ) +.br + { +.br + QApplication a( argc, argv ); +.fi +.PP +.nf +.br + int scale = 10; +.fi +.PP +.nf +.br + LifeDialog *life = new LifeDialog( scale ); +.br + a.setMainWidget( life ); +.br + life->setCaption("Qt Example - Life"); +.br + life->show(); +.fi +.PP +.nf +.br + return a.exec(); +.br + } +.fi +.PP +See also QTabDialog, QWidget, QProgressDialog, GUI Design Handbook: Dialogs, Standard, Abstract Widget Classes, and Dialog Classes. +.SS "Member Type Documentation" +.SH "QDialog::DialogCode" +The value returned by a modal dialog. +.TP +\fCQDialog::Accepted\fR +.TP +\fCQDialog::Rejected\fR +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "explicit QDialog::QDialog ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +Constructs a dialog called \fIname\fR, with parent \fIparent\fR. +.PP +A dialog is always a top-level widget, but if it has a parent, its default location is centered on top of the parent. It will also share the parent's taskbar entry. +.PP +The widget flags \fIf\fR are passed on to the QWidget constructor. If, for example, you don't want a What's This button in the titlebar of the dialog, pass WStyle_Customize | WStyle_NormalBorder | WStyle_Title | WStyle_SysMenu in \fIf\fR. +.PP +\fBWarning:\fR In Qt 3.2, the \fImodal\fR flag is obsolete. There is now a setModal() function that can be used for obtaining a modal behavior when calling show(). This is rarely needed, because modal dialogs are usually invoked using exec(), which ignores the \fImodal\fR flag. +.PP +See also QWidget::setWFlags() and Qt::WidgetFlags. +.SH "QDialog::~QDialog ()" +Destroys the QDialog, deleting all its children. +.SH "void QDialog::accept ()\fC [virtual protected slot]\fR" +Hides the modal dialog and sets the result code to Accepted. +.PP +See also reject() and done(). +.PP +Examples: +.)l chart/setdataform.cpp and distributor/distributor.ui.h. +.SH "void QDialog::done ( int r )\fC [virtual protected slot]\fR" +Closes the dialog and sets its result code to \fIr\fR. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return \fIr\fR. +.PP +As with QWidget::close(), done() deletes the dialog if the WDestructiveClose flag is set. If the dialog is the application's main widget, the application terminates. If the dialog is the last window closed, the QApplication::lastWindowClosed() signal is emitted. +.PP +See also accept(), reject(), QApplication::mainWidget(), and QApplication::quit(). +.SH "int QDialog::exec ()\fC [slot]\fR" +Shows the dialog as a modal dialog, blocking until the user closes it. The function returns a DialogCode result. +.PP +Users cannot interact with any other window in the same application until they close the dialog. +.PP +See also show() and result(). +.PP +Examples: +.)l chart/chartform.cpp, dialog/mainwindow.cpp, i18n/main.cpp, network/ftpclient/ftpmainwindow.ui.h, network/networkprotocol/view.cpp, qdir/qdir.cpp, and wizard/main.cpp. +.SH "QWidget * QDialog::extension () const" +Returns the dialog's extension or 0 if no extension has been defined. +.PP +See also setExtension(). +.SH "bool QDialog::isModal () const" +Returns TRUE if show() should pop up the dialog as modal or modeless; otherwise returns FALSE. See the "modal" property for details. +.SH "bool QDialog::isSizeGripEnabled () const" +Returns TRUE if the size grip is enabled; otherwise returns FALSE. See the "sizeGripEnabled" property for details. +.SH "Orientation QDialog::orientation () const" +Returns the dialog's extension orientation. +.PP +See also setOrientation(). +.SH "void QDialog::reject ()\fC [virtual protected slot]\fR" +Hides the modal dialog and sets the result code to Rejected. +.PP +See also accept() and done(). +.SH "int QDialog::result () const" +Returns the modal dialog's result code, Accepted or Rejected. +.PP +Do not call this function if the dialog was constructed with the WDestructiveClose flag. +.SH "void QDialog::setExtension ( QWidget * extension )" +Sets the widget, \fIextension\fR, to be the dialog's extension, deleting any previous extension. The dialog takes ownership of the extension. Note that if 0 is passed any existing extension will be deleted. +.PP +This function must only be called while the dialog is hidden. +.PP +See also showExtension(), setOrientation(), and extension(). +.SH "void QDialog::setModal ( bool modal )" +Sets whether show() should pop up the dialog as modal or modeless to \fImodal\fR. See the "modal" property for details. +.SH "void QDialog::setOrientation ( Orientation orientation )" +If \fIorientation\fR is Horizontal, the extension will be displayed to the right of the dialog's main area. If \fIorientation\fR is Vertical, the extension will be displayed below the dialog's main area. +.PP +See also orientation() and setExtension(). +.SH "void QDialog::setResult ( int i )\fC [protected]\fR" +Sets the modal dialog's result code to \fIi\fR. +.SH "void QDialog::setSizeGripEnabled ( bool )" +Sets whether the size grip is enabled. See the "sizeGripEnabled" property for details. +.SH "void QDialog::show ()\fC [virtual]\fR" +Shows the dialog as a modeless dialog. Control returns immediately to the calling code. +.PP +The dialog will be modal or modeless according to the value of the modal property. +.PP +See also exec() and modal. +.PP +Examples: +.)l movies/main.cpp, regexptester/main.cpp, showimg/showimg.cpp, and sql/overview/form1/main.cpp. +.PP +Reimplemented from QWidget. +.SH "void QDialog::showExtension ( bool showIt )\fC [protected slot]\fR" +If \fIshowIt\fR is TRUE, the dialog's extension is shown; otherwise the extension is hidden. +.PP +This slot is usually connected to the QButton::toggled() signal of a QPushButton. +.PP +A dialog with a visible extension is not resizeable. +.PP +See also show(), setExtension(), and setOrientation(). +.SS "Property Documentation" +.SH "bool modal" +This property holds whether show() should pop up the dialog as modal or modeless. +.PP +By default, this property is false and show() pops up the dialog as modeless. +.PP +exec() ignores the value of this property and always pops up the dialog as modal. +.PP +See also show() and exec(). +.PP +Set this property's value with setModal() and get this property's value with isModal(). +.SH "bool sizeGripEnabled" +This property holds whether the size grip is enabled. +.PP +A QSizeGrip is placed in the bottom right corner of the dialog when this property is enabled. By default, the size grip is disabled. +.PP +Set this property's value with setSizeGripEnabled() and get this property's value with isSizeGripEnabled(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdict.3qt b/doc/man/man3/tqdict.3qt new file mode 100644 index 000000000..3f11daee1 --- /dev/null +++ b/doc/man/man3/tqdict.3qt @@ -0,0 +1,374 @@ +'\" t +.TH QDict 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 +QDict \- Template class that provides a dictionary based on QString keys +.SH SYNOPSIS +\fC#include <ntqdict.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDict\fR ( int size = 17, bool caseSensitive = TRUE )" +.br +.ti -1c +.BI "\fBQDict\fR ( const QDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QDict\fR ()" +.br +.ti -1c +.BI "QDict<type> & \fBoperator=\fR ( const QDict<type> & dict )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "void \fBinsert\fR ( const QString & key, const type * item )" +.br +.ti -1c +.BI "void \fBreplace\fR ( const QString & key, const type * item )" +.br +.ti -1c +.BI "bool \fBremove\fR ( const QString & key )" +.br +.ti -1c +.BI "type * \fBtake\fR ( const QString & key )" +.br +.ti -1c +.BI "type * \fBfind\fR ( const QString & key ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "void \fBresize\fR ( uint newsize )" +.br +.ti -1c +.BI "void \fBstatistics\fR () const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" +.br +.in -1c +.SH DESCRIPTION +The QDict class is a template class that provides a dictionary based on QString keys. +.PP +QMap is an STL-compatible alternative to this class. +.PP +QDict is implemented as a template class. Define a template instance QDict<X> to create a dictionary that operates on pointers to X (X *). +.PP +A dictionary is a collection of key-value pairs. The key is a QString used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. +.PP +If you want to use non-Unicode, plain 8-bit \fCchar*\fR keys, use the QAsciiDict template. A QDict has the same performance as a QAsciiDict. If you want to have a dictionary that maps QStrings to QStrings use QMap. +.PP +The size() of the dictionary is very important. In order to get good performance, you should use a suitably large prime number. Suitable means equal to or larger than the maximum expected number of dictionary items. Size is set in the constructor but may be changed with resize(). +.PP +Items are inserted with insert(); 0 pointers cannot be inserted. Items are removed with remove(). All the items in a dictionary can be removed with clear(). The number of items in the dictionary is returned by count(). If the dictionary contains no items isEmpty() returns TRUE. You can change an item's value with replace(). Items are looked up with operator[](), or with find() which return a pointer to the value or 0 if the given key does not exist. You can take an item out of the dictionary with take(). +.PP +Calling setAutoDelete(TRUE) for a dictionary tells it to delete items that are removed. The default behaviour is not to delete items when they are removed. +.PP +When an item is inserted, the key is converted (hashed) to an integer index into an internal hash array. This makes lookup very fast. +.PP +Items with equal keys are allowed. When inserting two items with the same key, only the last inserted item will be accessible (last in, first out) until it is removed. +.PP +The QDictIterator class can traverse the dictionary, but only in an arbitrary order. Multiple iterators may independently traverse the same dictionary. +.PP +When inserting an item into a dictionary, only the pointer is copied, not the item itself, i.e. a shallow copy is made. It is possible to make the dictionary copy all of the item's data (a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a dictionary and reimplement newItem() if you want deep copies. +.PP +When removing a dictionary item, the virtual function QPtrCollection::deleteItem() is called. QDict's default implementation is to delete the item if auto-deletion is enabled. +.PP +Example #1: +.PP +.nf +.br + QDict<QLineEdit> fields; // QString keys, QLineEdit* values +.br + fields.insert( "forename", new QLineEdit( this ) ); +.br + fields.insert( "surname", new QLineEdit( this ) ); +.br +.br + fields["forename"]->setText( "Homer" ); +.br + fields["surname"]->setText( "Simpson" ); +.br +.br + QDictIterator<QLineEdit> it( fields ); // See QDictIterator +.br + for( ; it.current(); ++it ) +.br + cout << it.currentKey() << ": " << it.current()->text() << endl; +.br + cout << endl; +.br +.br + if ( fields["forename"] && fields["surname"] ) +.br + cout << fields["forename"]->text() << " " +.br +.br + << fields["surname"]->text() << endl; // Prints "Homer Simpson" +.br +.br + fields.remove( "forename" ); // Does not delete the line edit +.br + if ( ! fields["forename"] ) +.br + cout << "forename is not in the dictionary" << endl; +.br +.fi +In this example we use a dictionary to keep track of the line edits we're using. We insert each line edit into the dictionary with a unique name and then access the line edits via the dictionary. +.PP +Example #2: +.PP +.nf +.br + QStringList styleList = QStyleFactory::styles(); +.br + styleList.sort(); +.br + QDict<int> letterDict( 17, FALSE ); +.br + for ( QStringList::Iterator it = styleList.begin(); it != styleList.end(); ++it ) { +.br + QString styleName = *it; +.br + QString styleAccel = styleName; +.br + if ( letterDict[styleAccel.left(1)] ) { +.br + for ( uint i = 0; i < styleAccel.length(); i++ ) { +.br + if ( ! letterDict[styleAccel.mid( i, 1 )] ) { +.br + styleAccel = styleAccel.insert( i, '&' ); +.br + letterDict.insert(styleAccel.mid( i, 1 ), (const int *)1); +.br + break; +.br + } +.br + } +.br + } else { +.br + styleAccel = "&" + styleAccel; +.br + letterDict.insert(styleAccel.left(1), (const int *)1); +.br + } +.br + (void) new QAction( styleName, QIconSet(), styleAccel, parent ); +.br + } +.br +.fi +In the example we are using the dictionary to provide fast random access to the keys, and we don't care what the values are. The example is used to generate a menu of QStyles, each with a unique accelerator key (or no accelerator if there are no unused letters left). +.PP +We first obtain the list of available styles, then sort them so that the menu items will be ordered alphabetically. Next we create a dictionary of int pointers. The keys in the dictionary are each one character long, representing letters that have been used for accelerators. We iterate through our list of style names. If the first letter of the style name is in the dictionary, i.e. has been used, we iterate over all the characters in the style name to see if we can find a letter that hasn't been used. If we find an unused letter we put the accelerator ampersand (&) in front of it and add that letter to the dictionary. If we can't find an unused letter the style will simply have no accelerator. If the first letter of the style name is not in the dictionary we use it for the accelerator and add it to the dictionary. Finally we create a QAction for each style. +.PP +See also QDictIterator, QAsciiDict, QIntDict, QPtrDict, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDict::QDict ( int size = 17, bool caseSensitive = TRUE )" +Constructs a dictionary optimized for less than \fIsize\fR entries. +.PP +We recommend setting \fIsize\fR to a suitably large prime number (e.g. a prime that's slightly larger than the expected number of entries). This makes the hash distribution better which will lead to faster lookup. +.PP +If \fIcaseSensitive\fR is TRUE (the default), keys which differ only by case are considered different. +.SH "QDict::QDict ( const QDict<type> & dict )" +Constructs a copy of \fIdict\fR. +.PP +Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). +.SH "QDict::~QDict ()" +Removes all items from the dictionary and destroys it. If setAutoDelete() is TRUE, each value is deleted. All iterators that access this dictionary will be reset. +.PP +See also setAutoDelete(). +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QDict::clear ()\fC [virtual]\fR" +Removes all items from the dictionary. +.PP +The removed items are deleted if auto-deletion is enabled. +.PP +All dictionary iterators that operate on the dictionary are reset. +.PP +See also remove(), take(), and setAutoDelete(). +.PP +Reimplemented from QPtrCollection. +.SH "uint QDict::count () const\fC [virtual]\fR" +Returns the number of items in the dictionary. +.PP +See also isEmpty(). +.PP +Reimplemented from QPtrCollection. +.SH "type * QDict::find ( const QString & key ) const" +Returns the item with key \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be found. +.PP +Equivalent to the [] operator. +.PP +See also operator[](). +.SH "void QDict::insert ( const QString & key, const type * item )" +Inserts the key \fIkey\fR with value \fIitem\fR into the dictionary. +.PP +Multiple items can have the same key, in which case only the last item will be accessible using operator[](). +.PP +\fIitem\fR may not be 0. +.PP +See also replace(). +.PP +Example: themes/themes.cpp. +.SH "bool QDict::isEmpty () const" +Returns TRUE if the dictionary is empty, i.e. count() == 0; otherwise returns FALSE. +.PP +See also count(). +.SH "QDict<type> & QDict::operator= ( const QDict<type> & dict )" +Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. +.PP +This dictionary is first cleared, then each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy), unless newItem() has been reimplemented. +.SH "type * QDict::operator[] ( const QString & key ) const" +Returns the item with key \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be found. +.PP +Equivalent to the find() function. +.PP +See also find(). +.SH "QDataStream & QDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QDict::remove ( const QString & key )" +Removes the item with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if the item is in the dictionary; otherwise returns FALSE. +.PP +If there are two or more items with equal keys, then the last item that was inserted will be removed. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary's traversal order. +.PP +See also take(), clear(), and setAutoDelete(). +.SH "void QDict::replace ( const QString & key, const type * item )" +Replaces the value of the key, \fIkey\fR with \fIitem\fR. +.PP +If the item does not already exist, it will be inserted. +.PP +\fIitem\fR may not be 0. +.PP +Equivalent to: +.PP +.nf +.br + QDict<char> dict; +.br + ... +.br + if ( dict.find( key ) ) +.br + dict.remove( key ); +.br + dict.insert( key, item ); +.br +.fi +.PP +If there are two or more items with equal keys, then the last item that was inserted will be replaced. +.PP +See also insert(). +.SH "void QDict::resize ( uint newsize )" +Changes the size of the hash table to \fInewsize\fR. The contents of the dictionary are preserved, but all iterators on the dictionary become invalid. +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. +.SH "uint QDict::size () const" +Returns the size of the internal hash array (as specified in the constructor). +.PP +See also count(). +.SH "void QDict::statistics () const" +Debugging-only function that prints out the dictionary distribution using tqDebug(). +.SH "type * QDict::take ( const QString & key )" +Takes the item with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). +.PP +If there are two or more items with equal keys, then the last item that was inserted will be taken. +.PP +Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. +.PP +All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary traversal order. +.PP +See also remove(), clear(), and setAutoDelete(). +.SH "QDataStream & QDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" +Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdict.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdict.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdictiterator.3qt b/doc/man/man3/tqdictiterator.3qt new file mode 100644 index 000000000..c95d3f473 --- /dev/null +++ b/doc/man/man3/tqdictiterator.3qt @@ -0,0 +1,153 @@ +'\" t +.TH QDictIterator 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 +QDictIterator \- Iterator for QDict collections +.SH SYNOPSIS +\fC#include <ntqdict.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDictIterator\fR ( const QDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QDictIterator\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "QString \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QDictIterator class provides an iterator for QDict collections. +.PP +QDictIterator is implemented as a template class. Define a template instance QDictIterator<X> to create a dictionary iterator that operates on QDict<X> (dictionary of X*). +.PP +The traversal order is arbitrary; when we speak of the "first"," last" and "next" item we are talking in terms of this arbitrary order. +.PP +Multiple iterators may independently traverse the same dictionary. A QDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QDict updates all iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order. +.PP +Example: +.PP +.nf +.br + QDict<QLineEdit> fields; +.br + fields.insert( "forename", new QLineEdit( this ) ); +.br + fields.insert( "surname", new QLineEdit( this ) ); +.br + fields.insert( "age", new QLineEdit( this ) ); +.br +.br + fields["forename"]->setText( "Homer" ); +.br + fields["surname"]->setText( "Simpson" ); +.br + fields["age"]->setText( "45" ); +.br +.br + QDictIterator<QLineEdit> it( fields ); +.br + for( ; it.current(); ++it ) +.br + cout << it.currentKey() << ": " << it.current()->text() << endl; +.br + cout << endl; +.br +.br + // Output (random order): +.br + // age: 45 +.br + // surname: Simpson +.br + // forename: Homer +.br +.fi +In the example we insert some pointers to line edits into a dictionary, then iterate over the dictionary printing the strings associated with the line edits. +.PP +See also QDict, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDictIterator::QDictIterator ( const QDict<type> & dict )" +Constructs an iterator for \fIdict\fR. The current iterator item is set to point to the first item in the dictionary, \fIdict\fR. First in this context means first in the arbitrary traversal order. +.SH "QDictIterator::~QDictIterator ()" +Destroys the iterator. +.SH "uint QDictIterator::count () const" +Returns the number of items in the dictionary over which the iterator is operating. +.PP +See also isEmpty(). +.SH "type * QDictIterator::current () const" +Returns a pointer to the current iterator item's value. +.SH "QString QDictIterator::currentKey () const" +Returns the current iterator item's key. +.SH "bool QDictIterator::isEmpty () const" +Returns TRUE if the dictionary is empty, i.e. count() == 0; otherwise returns FALSE. +.PP +See also count(). +.SH "QDictIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QDictIterator::operator() ()" +Makes the next item current and returns the original current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QDictIterator::operator++ ()" +Prefix ++ makes the next item current and returns the new current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QDictIterator::toFirst ()" +Resets the iterator, making the first item the first current item. First in this context means first in the arbitrary traversal order. Returns a pointer to this item. +.PP +If the dictionary is empty it sets the current item to 0 and +returns 0. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdictiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdictiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdir.3qt b/doc/man/man3/tqdir.3qt new file mode 100644 index 000000000..2a4e045ef --- /dev/null +++ b/doc/man/man3/tqdir.3qt @@ -0,0 +1,807 @@ +'\" t +.TH QDir 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 +QDir \- Access to directory structures and their contents in a platform-independent way +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdir.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBFilterSpec\fR { Dirs = 0x001, Files = 0x002, Drives = 0x004, NoSymLinks = 0x008, All = 0x007, TypeMask = 0x00F, Readable = 0x010, Writable = 0x020, Executable = 0x040, RWEMask = 0x070, Modified = 0x080, Hidden = 0x100, System = 0x200, AccessMask = 0x3F0, DefaultFilter = -1 }" +.br +.ti -1c +.BI "enum \fBSortSpec\fR { Name = 0x00, Time = 0x01, Size = 0x02, Unsorted = 0x03, SortByMask = 0x03, DirsFirst = 0x04, Reversed = 0x08, IgnoreCase = 0x10, LocaleAware = 0x20, DefaultSort = -1 }" +.br +.ti -1c +.BI "\fBQDir\fR ()" +.br +.ti -1c +.BI "\fBQDir\fR ( const QString & path, const QString & nameFilter = QString::null, int sortSpec = Name | IgnoreCase, int filterSpec = All )" +.br +.ti -1c +.BI "\fBQDir\fR ( const QDir & d )" +.br +.ti -1c +.BI "virtual \fB~QDir\fR ()" +.br +.ti -1c +.BI "QDir & \fBoperator=\fR ( const QDir & d )" +.br +.ti -1c +.BI "QDir & \fBoperator=\fR ( const QString & path )" +.br +.ti -1c +.BI "virtual void \fBsetPath\fR ( const QString & path )" +.br +.ti -1c +.BI "virtual QString \fBpath\fR () const" +.br +.ti -1c +.BI "virtual QString \fBabsPath\fR () const" +.br +.ti -1c +.BI "virtual QString \fBcanonicalPath\fR () const" +.br +.ti -1c +.BI "virtual QString \fBdirName\fR () const" +.br +.ti -1c +.BI "virtual QString \fBfilePath\fR ( const QString & fileName, bool acceptAbsPath = TRUE ) const" +.br +.ti -1c +.BI "virtual QString \fBabsFilePath\fR ( const QString & fileName, bool acceptAbsPath = TRUE ) const" +.br +.ti -1c +.BI "virtual bool \fBcd\fR ( const QString & dirName, bool acceptAbsPath = TRUE )" +.br +.ti -1c +.BI "virtual bool \fBcdUp\fR ()" +.br +.ti -1c +.BI "QString \fBnameFilter\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNameFilter\fR ( const QString & nameFilter )" +.br +.ti -1c +.BI "FilterSpec \fBfilter\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFilter\fR ( int filterSpec )" +.br +.ti -1c +.BI "SortSpec \fBsorting\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSorting\fR ( int sortSpec )" +.br +.ti -1c +.BI "bool \fBmatchAllDirs\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMatchAllDirs\fR ( bool enable )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "QString \fBoperator[]\fR ( int index ) const" +.br +.ti -1c +.BI "virtual QStrList encodedEntryList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual QStrList encodedEntryList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual QStringList \fBentryList\fR ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" +.br +.ti -1c +.BI "virtual QStringList \fBentryList\fR ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" +.br +.ti -1c +.BI "virtual const QFileInfoList * \fBentryInfoList\fR ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" +.br +.ti -1c +.BI "virtual const QFileInfoList * \fBentryInfoList\fR ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" +.br +.ti -1c +.BI "virtual bool \fBmkdir\fR ( const QString & dirName, bool acceptAbsPath = TRUE ) const" +.br +.ti -1c +.BI "virtual bool \fBrmdir\fR ( const QString & dirName, bool acceptAbsPath = TRUE ) const" +.br +.ti -1c +.BI "virtual bool \fBisReadable\fR () const" +.br +.ti -1c +.BI "virtual bool \fBexists\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisRoot\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisRelative\fR () const" +.br +.ti -1c +.BI "virtual void \fBconvertToAbs\fR ()" +.br +.ti -1c +.BI "virtual bool \fBoperator==\fR ( const QDir & d ) const" +.br +.ti -1c +.BI "virtual bool \fBoperator!=\fR ( const QDir & d ) const" +.br +.ti -1c +.BI "virtual bool \fBremove\fR ( const QString & fileName, bool acceptAbsPath = TRUE )" +.br +.ti -1c +.BI "virtual bool \fBrename\fR ( const QString & oldName, const QString & newName, bool acceptAbsPaths = TRUE )" +.br +.ti -1c +.BI "virtual bool \fBexists\fR ( const QString & name, bool acceptAbsPath = TRUE )" +.br +.ti -1c +.BI "void \fBrefresh\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBconvertSeparators\fR ( const QString & pathName )" +.br +.ti -1c +.BI "const QFileInfoList * \fBdrives\fR ()" +.br +.ti -1c +.BI "char \fBseparator\fR ()" +.br +.ti -1c +.BI "bool \fBsetCurrent\fR ( const QString & path )" +.br +.ti -1c +.BI "QDir \fBcurrent\fR ()" +.br +.ti -1c +.BI "QDir \fBhome\fR ()" +.br +.ti -1c +.BI "QDir \fBroot\fR ()" +.br +.ti -1c +.BI "QString \fBcurrentDirPath\fR ()" +.br +.ti -1c +.BI "QString \fBhomeDirPath\fR ()" +.br +.ti -1c +.BI "QString \fBrootDirPath\fR ()" +.br +.ti -1c +.BI "bool \fBmatch\fR ( const QStringList & filters, const QString & fileName )" +.br +.ti -1c +.BI "bool \fBmatch\fR ( const QString & filter, const QString & fileName )" +.br +.ti -1c +.BI "QString \fBcleanDirPath\fR ( const QString & filePath )" +.br +.ti -1c +.BI "bool \fBisRelativePath\fR ( const QString & path )" +.br +.in -1c +.SH DESCRIPTION +The QDir class provides access to directory structures and their contents in a platform-independent way. +.PP +A QDir is used to manipulate path names, access information regarding paths and files, and manipulate the underlying file system. +.PP +A QDir can point to a file using either a relative or an absolute path. Absolute paths begin with the directory separator "/" (optionally preceded by a drive specification under Windows). If you always use "/" as a directory separator, Qt will translate your paths to conform to the underlying operating system. Relative file names begin with a directory name or a file name and specify a path relative to the current directory. +.PP +The "current" path refers to the application's working directory. A QDir's own path is set and retrieved with setPath() and path(). +.PP +An example of an absolute path is the string "/tmp/quartz", a relative path might look like "src/fatlib". You can use the function isRelative() to check if a QDir is using a relative or an absolute file path. Call convertToAbs() to convert a relative QDir to an absolute one. For a simplified path use cleanDirPath(). To obtain a path which has no symbolic links or redundant ".." elements use canonicalPath(). The path can be set with setPath(), and changed with cd() and cdUp(). +.PP +QDir provides several static functions, for example, setCurrent() to set the application's working directory and currentDirPath() to retrieve the application's working directory. Access to some common paths is provided with the static functions, current(), home() and root() which return QDir objects or currentDirPath(), homeDirPath() and rootDirPath() which return the path as a string. If you want to know about your application's path use QApplication::applicationDirPath(). +.PP +The number of entries in a directory is returned by count(). Obtain a string list of the names of all the files and directories in a directory with entryList(). If you prefer a list of QFileInfo pointers use entryInfoList(). Both these functions can apply a name filter, an attributes filter (e.g. read-only, files not directories, etc.), and a sort order. The filters and sort may be set with calls to setNameFilter(), setFilter() and setSorting(). They may also be specified in the entryList() and entryInfoList()'s arguments. +.PP +Create a new directory with mkdir(), rename a directory with rename() and remove an existing directory with rmdir(). Remove a file with remove(). You can interrogate a directory with exists(), isReadable() and isRoot(). +.PP +To get a path with a filename use filePath(), and to get a directory name use dirName(); neither of these functions checks for the existence of the file or directory. +.PP +The list of root directories is provided by drives(); on Unix systems this returns a list containing one root directory, "/"; on Windows the list will usually contain "C:/", and possibly "D:/", etc. +.PP +It is easiest to work with "/" separators in Qt code. If you need to present a path to the user or need a path in a form suitable for a function in the underlying operating system use convertSeparators(). +.PP +Examples: +.)l +.PP +See if a directory exists. +.PP +.nf +.br + QDir d( "example" ); // "./example" +.br + if ( !d.exists() ) +.br + tqWarning( "Cannot find the example directory" ); +.br +.fi +.PP +Traversing directories and reading a file. +.PP +.nf +.br + QDir d = QDir::root(); // "/" +.br + if ( !d.cd("tmp") ) { // "/tmp" +.br + tqWarning( "Cannot find the \\"/tmp\\" directory" ); +.br + } else { +.br + QFile f( d.filePath("ex1.txt") ); // "/tmp/ex1.txt" +.br + if ( !f.open(IO_ReadWrite) ) +.br + tqWarning( "Cannot create the file %s", f.name() ); +.br + } +.br +.fi +.PP +A program that lists all the files in the current directory (excluding symbolic links), sorted by size, smallest first: +.PP +.nf +.br + #include <stdio.h> +.br + #include <ntqdir.h> +.br +.br + int main( int argc, char **argv ) +.br + { +.br + QDir d; +.br + d.setFilter( QDir::Files | QDir::Hidden | QDir::NoSymLinks ); +.br + d.setSorting( QDir::Size | QDir::Reversed ); +.br +.br + const QFileInfoList *list = d.entryInfoList(); +.br + QFileInfoListIterator it( *list ); +.br + QFileInfo *fi; +.br +.br + printf( " Bytes Filename\\n" ); +.br + while ( (fi = it.current()) != 0 ) { +.br + printf( "%10li %s\\n", fi->size(), fi->fileName().latin1() ); +.br + ++it; +.br + } +.br + return 0; +.br + } +.br +.fi +.PP +See also QApplication::applicationDirPath() and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QDir::FilterSpec" +This enum describes the filtering options available to QDir, e.g. for entryList() and entryInfoList(). The filter value is specified by OR-ing together values from the following list: +.TP +\fCQDir::Dirs\fR - List directories only. +.TP +\fCQDir::Files\fR - List files only. +.TP +\fCQDir::Drives\fR - List disk drives (ignored under Unix). +.TP +\fCQDir::NoSymLinks\fR - Do not list symbolic links (ignored by operating systems that don't support symbolic links). +.TP +\fCQDir::All\fR - List directories, files, drives and symlinks (this does not list broken symlinks unless you specify System). +.TP +\fCQDir::TypeMask\fR - A mask for the the Dirs, Files, Drives and NoSymLinks flags. +.TP +\fCQDir::Readable\fR - List files for which the application has read access. +.TP +\fCQDir::Writable\fR - List files for which the application has write access. +.TP +\fCQDir::Executable\fR - List files for which the application has execute access. Executables needs to be combined with Dirs or Files. +.TP +\fCQDir::RWEMask\fR - A mask for the Readable, Writable and Executable flags. +.TP +\fCQDir::Modified\fR - Only list files that have been modified (ignored under Unix). +.TP +\fCQDir::Hidden\fR - List hidden files (on Unix, files starting with a .). +.TP +\fCQDir::System\fR - List system files (on Unix, FIFOs, sockets and device files) +.TP +\fCQDir::AccessMask\fR - A mask for the Readable, Writable, Executable Modified, Hidden and System flags +.TP +\fCQDir::DefaultFilter\fR - Internal flag. +.PP +If you do not set any of Readable, Writable or Executable, QDir will set all three of them. This makes the default easy to write and at the same time useful. +.PP +Examples: +.)l \fCReadable|Writable\fR means list all files for which the +application has read access, write access or both. \fCDirs|Drives\fR means list drives, directories, all files that the application can read, write or execute, and also symlinks to such files/directories. +.SH "QDir::SortSpec" +This enum describes the sort options available to QDir, e.g. for entryList() and entryInfoList(). The sort value is specified by OR-ing together values from the following list: +.TP +\fCQDir::Name\fR - Sort by name. +.TP +\fCQDir::Time\fR - Sort by time (modification time). +.TP +\fCQDir::Size\fR - Sort by file size. +.TP +\fCQDir::Unsorted\fR - Do not sort. +.TP +\fCQDir::SortByMask\fR - A mask for Name, Time and Size. +.TP +\fCQDir::DirsFirst\fR - Put the directories first, then the files. +.TP +\fCQDir::Reversed\fR - Reverse the sort order. +.TP +\fCQDir::IgnoreCase\fR - Sort case-insensitively. +.TP +\fCQDir::LocaleAware\fR - Sort names using locale aware compares +.TP +\fCQDir::DefaultSort\fR - Internal flag. +.PP +You can only specify one of the first four. +.PP +If you specify both DirsFirst and Reversed, directories are still put first, but in reverse order; the files will be listed after the directories, again in reverse order. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDir::QDir ()" +Constructs a QDir pointing to the current directory ("."). +.PP +See also currentDirPath(). +.SH "QDir::QDir ( const QString & path, const QString & nameFilter = QString::null, int sortSpec = Name | IgnoreCase, int filterSpec = All )" +Constructs a QDir with path \fIpath\fR, that filters its entries by name using \fInameFilter\fR and by attributes using \fIfilterSpec\fR. It also sorts the names using \fIsortSpec\fR. +.PP +The default \fInameFilter\fR is an empty string, which excludes nothing; the default \fIfilterSpec\fR is All, which also means exclude nothing. The default \fIsortSpec\fR is \fCName|IgnoreCase\fR, i.e. sort by name case-insensitively. +.PP +Example that lists all the files in "/tmp": +.PP +.nf +.br + QDir d( "/tmp" ); +.br + for ( int i = 0; i < d.count(); i++ ) +.br + printf( "%s\\n", d[i] ); +.br +.fi +.PP +If \fIpath\fR is "" or QString::null, QDir uses "." (the current directory). If \fInameFilter\fR is "" or QString::null, QDir uses the name filter "*" (all files). +.PP +Note that \fIpath\fR need not exist. +.PP +See also exists(), setPath(), setNameFilter(), setFilter(), and setSorting(). +.SH "QDir::QDir ( const QDir & d )" +Constructs a QDir that is a copy of the directory \fId\fR. +.PP +See also operator=(). +.SH "QDir::~QDir ()\fC [virtual]\fR" +Destroys the QDir frees up its resources. +.SH "QString QDir::absFilePath ( const QString & fileName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +Returns the absolute path name of a file in the directory. Does \fInot\fR check if the file actually exists in the directory. Redundant multiple separators or "." and ".." directories in \fIfileName\fR will not be removed (see cleanDirPath()). +.PP +If \fIacceptAbsPath\fR is TRUE a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is FALSE an absolute path will be prepended to the fileName and the resultant string returned. +.PP +See also filePath(). +.SH "QString QDir::absPath () const\fC [virtual]\fR" +Returns the absolute path (a path that starts with "/" or with a drive specification), which may contain symbolic links, but never contains redundant ".", ".." or multiple separators. +.PP +See also setPath(), canonicalPath(), exists(), cleanDirPath(), dirName(), and absFilePath(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QString QDir::canonicalPath () const\fC [virtual]\fR" +Returns the canonical path, i.e. a path without symbolic links or redundant "." or ".." elements. +.PP +On systems that do not have symbolic links this function will always return the same string that absPath() returns. If the canonical path does not exist (normally due to dangling symbolic links) canonicalPath() returns QString::null. +.PP +See also path(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), and QString::isNull(). +.SH "bool QDir::cd ( const QString & dirName, bool acceptAbsPath = TRUE )\fC [virtual]\fR" +Changes the QDir's directory to \fIdirName\fR. +.PP +If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will cause the function to change to the absolute directory. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed and the function will descend into \fIdirName\fR. +.PP +Returns TRUE if the new directory exists and is readable; otherwise returns FALSE. Note that the logical cd() operation is not performed if the new directory does not exist. +.PP +Calling cd( ".." ) is equivalent to calling cdUp(). +.PP +See also cdUp(), isReadable(), exists(), and path(). +.PP +Example: fileiconview/mainwindow.cpp. +.SH "bool QDir::cdUp ()\fC [virtual]\fR" +Changes directory by moving one directory up from the QDir's current directory. +.PP +Returns TRUE if the new directory exists and is readable; otherwise returns FALSE. Note that the logical cdUp() operation is not performed if the new directory does not exist. +.PP +See also cd(), isReadable(), exists(), and path(). +.SH "QString QDir::cleanDirPath ( const QString & filePath )\fC [static]\fR" +Removes all multiple directory separators "/" and resolves any" +."s or ".."s found in the path, \fIfilePath\fR. +.PP +Symbolic links are kept. This function does not return the canonical path, but rather the simplest version of the input. For example, "./local" becomes "local", "local/../bin" becomes" bin" and "/local/usr/../bin" becomes "/local/bin". +.PP +See also absPath() and canonicalPath(). +.SH "QString QDir::convertSeparators ( const QString & pathName )\fC [static]\fR" +Returns \fIpathName\fR with the '/' separators converted to separators that are appropriate for the underlying operating system. +.PP +On Windows, convertSeparators("c:/winnt/system32") returns" c:\\winnt\\system32". +.PP +The returned string may be the same as the argument on some operating systems, for example on Unix. +.PP +Examples: +.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. +.SH "void QDir::convertToAbs ()\fC [virtual]\fR" +Converts the directory path to an absolute path. If it is already absolute nothing is done. +.PP +See also isRelative(). +.SH "uint QDir::count () const" +Returns the total number of directories and files that were found. +.PP +Equivalent to entryList().count(). +.PP +See also operator[]() and entryList(). +.SH "QDir QDir::current ()\fC [static]\fR" +Returns the application's current directory. +.PP +Use path() to access a QDir object's path. +.PP +See also currentDirPath() and QDir::QDir(). +.SH "QString QDir::currentDirPath ()\fC [static]\fR" +Returns the absolute path of the application's current directory. +.PP +See also current(). +.PP +Examples: +.)l dirview/dirview.cpp, helpviewer/helpwindow.cpp, and qdir/qdir.cpp. +.SH "QString QDir::dirName () const\fC [virtual]\fR" +Returns the name of the directory; this is \fInot\fR the same as the path, e.g. a directory with the name "mail", might have the path" /var/spool/mail". If the directory has no name (e.g. it is the root directory) QString::null is returned. +.PP +No check is made to ensure that a directory with this name actually exists. +.PP +See also path(), absPath(), absFilePath(), exists(), and QString::isNull(). +.SH "const QFileInfoList * QDir::drives ()\fC [static]\fR" +Returns a list of the root directories on this system. On Windows this returns a number of QFileInfo objects containing "C:/", "D:/" etc. On other operating systems, it returns a list containing just one root directory (e.g. "/"). +.PP +The returned pointer is owned by Qt. Callers should \fInot\fR delete or modify it. +.PP +Example: dirview/main.cpp. +.SH "QStrList QDir::encodedEntryList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function is included to easy porting from Qt 1.x to Qt 2.0, it is the same as entryList(), but encodes the filenames as 8-bit strings using QFile::encodedName(). +.PP +It is more efficient to use entryList(). +.SH "QStrList QDir::encodedEntryList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function is included to easy porting from Qt 1.x to Qt 2.0, it is the same as entryList(), but encodes the filenames as 8-bit strings using QFile::encodedName(). +.PP +It is more efficient to use entryList(). +.SH "const QFileInfoList * QDir::entryInfoList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" +Returns a list of QFileInfo objects for all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). +.PP +The filter and sorting specifications can be overridden using the \fInameFilter\fR, \fIfilterSpec\fR and \fIsortSpec\fR arguments. +.PP +Returns 0 if the directory is unreadable or does not exist. +.PP +The returned pointer is a const pointer to a QFileInfoList. The list is owned by the QDir object and will be reused on the next call to entryInfoList() for the same QDir instance. If you want to keep the entries of the list after a subsequent call to this function you must copy them. +.PP +Note: QFileInfoList is really a QPtrList<QFileInfo>. +.PP +See also entryList(), setNameFilter(), setSorting(), and setFilter(). +.PP +Examples: +.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. +.SH "const QFileInfoList * QDir::entryInfoList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a list of QFileInfo objects for all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). +.PP +The filter and sorting specifications can be overridden using the \fIfilterSpec\fR and \fIsortSpec\fR arguments. +.PP +Returns 0 if the directory is unreadable or does not exist. +.PP +The returned pointer is a const pointer to a QFileInfoList. The list is owned by the QDir object and will be reused on the next call to entryInfoList() for the same QDir instance. If you want to keep the entries of the list after a subsequent call to this function you must copy them. +.PP +Note: QFileInfoList is really a QPtrList<QFileInfo>. +.PP +See also entryList(), setNameFilter(), setSorting(), and setFilter(). +.SH "QStringList QDir::entryList ( const QString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" +Returns a list of the names of all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). +.PP +The filter and sorting specifications can be overridden using the \fInameFilter\fR, \fIfilterSpec\fR and \fIsortSpec\fR arguments. +.PP +Returns an empty list if the directory is unreadable or does not exist. +.PP +See also entryInfoList(), setNameFilter(), setSorting(), and setFilter(). +.PP +Example: table/statistics/statistics.cpp. +.SH "QStringList QDir::entryList ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a list of the names of all the files and directories in the directory, ordered in accordance with setSorting() and filtered in accordance with setFilter() and setNameFilter(). +.PP +The filter and sorting specifications can be overridden using the \fIfilterSpec\fR and \fIsortSpec\fR arguments. +.PP +Returns an empty list if the directory is unreadable or does not exist. +.PP +See also entryInfoList(), setNameFilter(), setSorting(), and setFilter(). +.SH "bool QDir::exists ( const QString & name, bool acceptAbsPath = TRUE )\fC [virtual]\fR" +Checks for the existence of the file \fIname\fR. +.PP +If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will check the file with the absolute path. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIname\fR will be removed and the resultant file name will be checked. +.PP +Returns TRUE if the file exists; otherwise returns FALSE. +.PP +See also QFileInfo::exists() and QFile::exists(). +.SH "bool QDir::exists () const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the \fIdirectory\fR exists; otherwise returns FALSE. (If a file with the same name is found this function will return FALSE). +.PP +See also QFileInfo::exists() and QFile::exists(). +.SH "QString QDir::filePath ( const QString & fileName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +Returns the path name of a file in the directory. Does \fInot\fR check if the file actually exists in the directory. If the QDir is relative the returned path name will also be relative. Redundant multiple separators or "." and ".." directories in \fIfileName\fR will not be removed (see cleanDirPath()). +.PP +If \fIacceptAbsPath\fR is TRUE a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is FALSE an absolute path will be prepended to the fileName and the resultant string returned. +.PP +See also absFilePath(), isRelative(), and canonicalPath(). +.SH "FilterSpec QDir::filter () const" +Returns the value set by setFilter() +.SH "QDir QDir::home ()\fC [static]\fR" +Returns the home directory. +.PP +Under Windows the \fCHOME\fR environment variable is used. If this does not exist the \fCUSERPROFILE\fR environment variable is used. If that does not exist the path is formed by concatenating the \fCHOMEDRIVE\fR and \fCHOMEPATH\fR environment variables. If they don't exist the rootDirPath() is used (this uses the \fCSystemDrive\fR environment variable). If none of these exist "C:\" is used. +.PP +Under non-Windows operating systems the \fCHOME\fR environment variable is used if it exists, otherwise rootDirPath() is used. +.PP +See also homeDirPath(). +.SH "QString QDir::homeDirPath ()\fC [static]\fR" +Returns the absolute path of the user's home directory. +.PP +See also home(). +.SH "bool QDir::isReadable () const\fC [virtual]\fR" +Returns TRUE if the directory is readable \fIand\fR we can open files by name; otherwise returns FALSE. +.PP +\fBWarning:\fR A FALSE value from this function is not a guarantee that files in the directory are not accessible. +.PP +See also QFileInfo::isReadable(). +.PP +Examples: +.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. +.SH "bool QDir::isRelative () const\fC [virtual]\fR" +Returns TRUE if the directory path is relative to the current directory and returns FALSE if the path is absolute (e.g. under UNIX a path is relative if it does not start with a "/"). +.PP +See also convertToAbs(). +.SH "bool QDir::isRelativePath ( const QString & path )\fC [static]\fR" +Returns TRUE if \fIpath\fR is relative; returns FALSE if it is absolute. +.PP +See also isRelative(). +.SH "bool QDir::isRoot () const\fC [virtual]\fR" +Returns TRUE if the directory is the root directory; otherwise returns FALSE. +.PP +Note: If the directory is a symbolic link to the root directory this function returns FALSE. If you want to test for this use canonicalPath(), e.g. +.PP +.nf +.br + QDir d( "/tmp/root_link" ); +.br + d = d.canonicalPath(); +.br + if ( d.isRoot() ) +.br + tqWarning( "It is a root link" ); +.br +.fi +.PP +See also root() and rootDirPath(). +.SH "bool QDir::match ( const QString & filter, const QString & fileName )\fC [static]\fR" +Returns TRUE if the \fIfileName\fR matches the wildcard (glob) pattern \fIfilter\fR; otherwise returns FALSE. The \fIfilter\fR may contain multiple patterns separated by spaces or semicolons. +.PP +(See QRegExp wildcard matching.) +.PP +See also QRegExp::match(). +.SH "bool QDir::match ( const QStringList & filters, const QString & fileName )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the \fIfileName\fR matches any of the wildcard (glob) patterns in the list of \fIfilters\fR; otherwise returns FALSE. +.PP +(See QRegExp wildcard matching.) +.PP +See also QRegExp::match(). +.SH "bool QDir::matchAllDirs () const" +Returns the value set by setMatchAllDirs() +.PP +See also setMatchAllDirs(). +.SH "bool QDir::mkdir ( const QString & dirName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +Creates a directory. +.PP +If \fIacceptAbsPath\fR is TRUE a path starting with a separator ('/') will create the absolute directory; if \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed. +.PP +Returns TRUE if successful; otherwise returns FALSE. +.PP +See also rmdir(). +.SH "QString QDir::nameFilter () const" +Returns the string set by setNameFilter() +.SH "bool QDir::operator!= ( const QDir & d ) const\fC [virtual]\fR" +Returns TRUE if directory \fId\fR and this directory have different paths or different sort or filter settings; otherwise returns FALSE. +.PP +Example: +.PP +.nf +.br + // The current directory is "/usr/local" +.br + QDir d1( "/usr/local/bin" ); +.br + QDir d2( "bin" ); +.br + if ( d1 != d2 ) +.br + tqDebug( "They differ" ); +.br +.fi +.SH "QDir & QDir::operator= ( const QDir & d )" +Makes a copy of QDir \fId\fR and assigns it to this QDir. +.SH "QDir & QDir::operator= ( const QString & path )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the directory path to be the given \fIpath\fR. +.SH "bool QDir::operator== ( const QDir & d ) const\fC [virtual]\fR" +Returns TRUE if directory \fId\fR and this directory have the same path and their sort and filter settings are the same; otherwise returns FALSE. +.PP +Example: +.PP +.nf +.br + // The current directory is "/usr/local" +.br + QDir d1( "/usr/local/bin" ); +.br + QDir d2( "bin" ); +.br + d2.convertToAbs(); +.br + if ( d1 == d2 ) +.br + tqDebug( "They're the same" ); +.br +.fi +.SH "QString QDir::operator[] ( int index ) const" +Returns the file name at position \fIindex\fR in the list of file names. Equivalent to entryList().at(index). +.PP +Returns a QString::null if the \fIindex\fR is out of range or if the entryList() function failed. +.PP +See also count() and entryList(). +.SH "QString QDir::path () const\fC [virtual]\fR" +Returns the path, this may contain symbolic links, but never contains redundant ".", ".." or multiple separators. +.PP +The returned path can be either absolute or relative (see setPath()). +.PP +See also setPath(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), and convertSeparators(). +.SH "void QDir::refresh () const" +Refreshes the directory information. +.SH "bool QDir::remove ( const QString & fileName, bool acceptAbsPath = TRUE )\fC [virtual]\fR" +Removes the file, \fIfileName\fR. +.PP +If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will remove the file with the absolute path. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIfileName\fR will be removed and the resultant file name will be removed. +.PP +Returns TRUE if the file is removed successfully; otherwise returns FALSE. +.SH "bool QDir::rename ( const QString & oldName, const QString & newName, bool acceptAbsPaths = TRUE )\fC [virtual]\fR" +Renames a file or directory. +.PP +If \fIacceptAbsPaths\fR is TRUE a path starting with a separator ('/') will rename the file with the absolute path; if \fIacceptAbsPaths\fR is FALSE any number of separators at the beginning of the names will be removed. +.PP +Returns TRUE if successful; otherwise returns FALSE. +.PP +On most file systems, rename() fails only if \fIoldName\fR does not exist or if \fInewName\fR and \fIoldName\fR are not on the same partition. On Windows, rename() will fail if \fInewName\fR already exists. However, there are also other reasons why rename() can fail. For example, on at least one file system rename() fails if \fInewName\fR points to an open file. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QDir::rmdir ( const QString & dirName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +Removes a directory. +.PP +If \fIacceptAbsPath\fR is TRUE a path starting with a separator ('/') will remove the absolute directory; if \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed. +.PP +The directory must be empty for rmdir() to succeed. +.PP +Returns TRUE if successful; otherwise returns FALSE. +.PP +See also mkdir(). +.SH "QDir QDir::root ()\fC [static]\fR" +Returns the root directory. +.PP +See also rootDirPath() and drives(). +.SH "QString QDir::rootDirPath ()\fC [static]\fR" +Returns the absolute path for the root directory. +.PP +For UNIX operating systems this returns "/". For Windows file systems this normally returns "c:/". +.PP +See also root() and drives(). +.SH "char QDir::separator ()\fC [static]\fR" +Returns the native directory separator; "/" under UNIX (including Mac OS X) and "\" under Windows. +.PP +You do not need to use this function to build file paths. If you always use "/", Qt will translate your paths to conform to the underlying operating system. +.SH "bool QDir::setCurrent ( const QString & path )\fC [static]\fR" +Sets the application's current working directory to \fIpath\fR. Returns TRUE if the directory was successfully changed; otherwise returns FALSE. +.SH "void QDir::setFilter ( int filterSpec )\fC [virtual]\fR" +Sets the filter used by entryList() and entryInfoList() to \fIfilterSpec\fR. The filter is used to specify the kind of files that should be returned by entryList() and entryInfoList(). See QDir::FilterSpec. +.PP +See also filter() and setNameFilter(). +.SH "void QDir::setMatchAllDirs ( bool enable )\fC [virtual]\fR" +If \fIenable\fR is TRUE then all directories are included (e.g. in entryList()), and the nameFilter() is only applied to the files. If \fIenable\fR is FALSE then the nameFilter() is applied to both directories and files. +.PP +See also matchAllDirs(). +.SH "void QDir::setNameFilter ( const QString & nameFilter )\fC [virtual]\fR" +Sets the name filter used by entryList() and entryInfoList() to \fInameFilter\fR. +.PP +The \fInameFilter\fR is a wildcard (globbing) filter that understands" *" and "?" wildcards. (See QRegExp wildcard matching.) You may specify several filter entries all separated by a single space " " or by a semi-colon" ;". +.PP +For example, if you want entryList() and entryInfoList() to list all files ending with either ".cpp" or ".h", you would use either dir.setNameFilter("*.cpp *.h") or dir.setNameFilter("*.cpp;*.h"). +.PP +See also nameFilter() and setFilter(). +.SH "void QDir::setPath ( const QString & path )\fC [virtual]\fR" +Sets the path of the directory to \fIpath\fR. The path is cleaned of redundant ".", ".." and of multiple separators. No check is made to ensure that a directory with this path exists. +.PP +The path can be either absolute or relative. Absolute paths begin with the directory separator "/" (optionally preceded by a drive specification under Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current directory. An example of an absolute path is the string" /tmp/quartz", a relative path might look like "src/fatlib". +.PP +See also path(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), isRelative(), and convertToAbs(). +.SH "void QDir::setSorting ( int sortSpec )\fC [virtual]\fR" +Sets the sort order used by entryList() and entryInfoList(). +.PP +The \fIsortSpec\fR is specified by OR-ing values from the enum QDir::SortSpec. +.PP +See also sorting() and SortSpec. +.SH "SortSpec QDir::sorting () const" +Returns the value set by setSorting() +.PP +See also setSorting() and SortSpec. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdir.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdir.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdirectpainter.3qt b/doc/man/man3/tqdirectpainter.3qt new file mode 100644 index 000000000..a2d491a86 --- /dev/null +++ b/doc/man/man3/tqdirectpainter.3qt @@ -0,0 +1,178 @@ +'\" t +.TH QDirectPainter 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 +QDirectPainter \- Direct access to the video hardware +.SH SYNOPSIS +\fC#include <qdirectpainter_qws.h>\fR +.PP +Inherits QPainter. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDirectPainter\fR ( const QWidget * w )" +.br +.ti -1c +.BI "\fB~QDirectPainter\fR ()" +.br +.ti -1c +.BI "uchar * \fBframeBuffer\fR ()" +.br +.ti -1c +.BI "int \fBlineStep\fR ()" +.br +.ti -1c +.BI "int \fBtransformOrientation\fR ()" +.br +.ti -1c +.BI "int \fBnumRects\fR () const" +.br +.ti -1c +.BI "const QRect & \fBrect\fR ( int i ) const" +.br +.ti -1c +.BI "QRegion \fBregion\fR () const" +.br +.ti -1c +.BI "int \fBdepth\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "int \fBxOffset\fR () const" +.br +.ti -1c +.BI "int \fByOffset\fR () const" +.br +.ti -1c +.BI "QPoint \fBoffset\fR () const" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "void \fBsetAreaChanged\fR ( const QRect & r )" +.br +.in -1c +.SH DESCRIPTION +The QDirectPainter class provides direct access to the video hardware. +.PP +Only available in Qt/Embedded. +.PP +When the hardware is known and well defined, as is often the case with software for embedded devices, it may be useful to manipulate the underlying video hardware directly. In order to do this in a way that is co-operative with other applications, you must lock the video hardware for exclusive use for a small time while you write to it, and you must know the clipping region which is allocated to a widget. +.PP +QDirectPainter provides this functionality. +.PP +In the simplest case, you make a QDirectPainter on a widget and then, observing the clip region, perform some platform-specific operation. For example: +.PP +.nf +.br + void MyWidget::updatePlatformGraphics() +.br + { +.br + QDirectPainter dp( this ); +.br + for ( int i = 0; i < dp.numRects; i++ ) { +.br + const QRect& clip = dp.rect(i); +.br + ... // platform specific operation +.br + } +.br + } +.br +.fi +.PP +The platform-specific code has access to the display, but should only modify graphics in the rectangles specified by numRects() and rect(). Note that these rectangles are relative to the entire display. +.PP +The offset() function returns the position of the widget relative to the entire display, allowing you to offset platform-specific operations appropriately. The xOffset() and yOffset() functions merely return the component values of offset(). +.PP +For simple frame-buffer hardware, the frameBuffer(), lineStep(), and depth() functions provide basic access, though some hardware configurations are insufficiently specified by such simple parameters. +.PP +Note that while a QDirectPainter exists, the entire Qt/Embedded window system is locked from use by other applications. Always construct the QDirectPainter as an auto (stack) variable, and be very careful to write robust and stable code within its scope. +.PP +See also Graphics Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDirectPainter::QDirectPainter ( const QWidget * w )" +Construct a direct painter on \fIw\fR. The display is locked and the mouse cursor is hidden if it is above \fIw\fR. +.SH "QDirectPainter::~QDirectPainter ()" +Destroys the direct painter. The mouse cursor is revealed if necessary and the display is unlocked. +.SH "int QDirectPainter::depth () const" +Returns the bit-depth of the display. +.SH "uchar * QDirectPainter::frameBuffer ()" +Returns a pointer to the framebuffer memory if available. +.SH "int QDirectPainter::height () const" +Returns the height of the widget drawn upon. +.SH "int QDirectPainter::lineStep ()" +Returns the spacing in bytes from one framebuffer line to the next. +.SH "int QDirectPainter::numRects () const" +Returns the number of rectangles in the drawable region. +.PP +See also rect() and region(). +.SH "QPoint QDirectPainter::offset () const" +Returns the position of the widget relative to the entire display. +.SH "const QRect & QDirectPainter::rect ( int i ) const" +Returns a reference to rectangle \fIi\fR of the drawable region. Valid values for \fIi\fR are 0..numRects()-1. +.PP +See also region(). +.SH "QRegion QDirectPainter::region () const" +Returns the region of the framebuffer which represents the exposed area of the widget being painted on. Note that this may be a sub-area of the clip region, because of child widgets and overlapping cousin widgets. +.PP +See also numRects() and rect(). +.SH "void QDirectPainter::setAreaChanged ( const QRect & r )" +Sets the area changed by the transaction to \fIr\fR. By default, the entire widget is assumed to have changed. The area changed is only used by some graphics drivers, so often calling this function for a smaller area will make no difference to performance. +.SH "QSize QDirectPainter::size () const" +Returns the size of the widget drawn upon. +.PP +See also width() and height(). +.SH "int QDirectPainter::transformOrientation ()" +Returns a number that signifies the orientation of the framebuffer. <center>.nf +.TS +l - l. 0 no rotation 1 90 degrees rotation 2 180 degrees rotation 3 +.TE +.fi +</center> +.SH "int QDirectPainter::width () const" +Returns the width of the widget drawn upon. +.SH "int QDirectPainter::xOffset () const" +Returns the X-position of the widget relative to the entire display. +.SH "int QDirectPainter::yOffset () const" +Returns the Y-position of the widget relative to the entire +display. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdirectpainter.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdirectpainter.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdns.3qt b/doc/man/man3/tqdns.3qt new file mode 100644 index 000000000..89e4e5e8e --- /dev/null +++ b/doc/man/man3/tqdns.3qt @@ -0,0 +1,331 @@ +'\" t +.TH QDns 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 +QDns \- Asynchronous DNS lookups +.SH SYNOPSIS +\fC#include <ntqdns.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBRecordType\fR { None, A, Aaaa, Mx, Srv, Cname, Ptr, Txt }" +.br +.ti -1c +.BI "\fBQDns\fR ()" +.br +.ti -1c +.BI "\fBQDns\fR ( const QString & label, RecordType rr = A )" +.br +.ti -1c +.BI "\fBQDns\fR ( const QHostAddress & address, RecordType rr = Ptr )" +.br +.ti -1c +.BI "virtual \fB~QDns\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetLabel\fR ( const QString & label )" +.br +.ti -1c +.BI "virtual void \fBsetLabel\fR ( const QHostAddress & address )" +.br +.ti -1c +.BI "QString \fBlabel\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRecordType\fR ( RecordType rr = A )" +.br +.ti -1c +.BI "RecordType \fBrecordType\fR () const" +.br +.ti -1c +.BI "bool \fBisWorking\fR () const" +.br +.ti -1c +.BI "QValueList<QHostAddress> \fBaddresses\fR () const" +.br +.ti -1c +.BI "QValueList<MailServer> \fBmailServers\fR () const" +.br +.ti -1c +.BI "QValueList<Server> \fBservers\fR () const" +.br +.ti -1c +.BI "QStringList \fBhostNames\fR () const" +.br +.ti -1c +.BI "QStringList \fBtexts\fR () const" +.br +.ti -1c +.BI "QString \fBcanonicalName\fR () const" +.br +.ti -1c +.BI "QStringList \fBqualifiedNames\fR () const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBresultsReady\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QDns class provides asynchronous DNS lookups. +.PP +Both Windows and Unix provide synchronous DNS lookups; Windows provides some asynchronous support too. At the time of writing neither operating system provides asynchronous support for anything other than hostname-to-address mapping. +.PP +QDns rectifies this shortcoming, by providing asynchronous caching lookups for the record types that we expect modern GUI applications to need in the near future. +.PP +The class is \fInot\fR straightforward to use (although it is much simpler than the native APIs); QSocket provides much easier to use TCP connection facilities. The aim of QDns is to provide a correct and small API to the DNS and nothing more. (We use "correctness" to mean that the DNS information is correctly cached, and correctly timed out.) +.PP +The API comprises a constructor, functions to set the DNS node (the domain in DNS terminology) and record type (setLabel() and setRecordType()), the corresponding get functions, an isWorking() function to determine whether QDns is working or reading, a resultsReady() signal and query functions for the result. +.PP +There is one query function for each RecordType, namely addresses(), mailServers(), servers(), hostNames() and texts(). There are also two generic query functions: canonicalName() returns the name you'll presumably end up using (the exact meaning of this depends on the record type) and qualifiedNames() returns a list of the fully qualified names label() maps to. +.PP +See also QSocket and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QDns::RecordType" +This enum type defines the record types QDns can handle. The DNS provides many more; these are the ones we've judged to be in current use, useful for GUI programs and important enough to support right away: +.TP +\fCQDns::None\fR - No information. This exists only so that QDns can have a default. +.TP +\fCQDns::A\fR - IPv4 addresses. By far the most common type. +.TP +\fCQDns::Aaaa\fR - IPv6 addresses. So far mostly unused. +.TP +\fCQDns::Mx\fR - Mail eXchanger names. Used for mail delivery. +.TP +\fCQDns::Srv\fR - SeRVer names. Generic record type for finding servers. So far mostly unused. +.TP +\fCQDns::Cname\fR - Canonical names. Maps from nicknames to the true name (the canonical name) for a host. +.TP +\fCQDns::Ptr\fR - name PoinTeRs. Maps from IPv4 or IPv6 addresses to hostnames. +.TP +\fCQDns::Txt\fR - arbitrary TeXT for domains. +.PP +We expect that some support for the RFC-2535 extensions will be added in future versions. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDns::QDns ()" +Constructs a DNS query object with invalid settings for both the label and the search type. +.SH "QDns::QDns ( const QString & label, RecordType rr = A )" +Constructs a DNS query object that will return record type \fIrr\fR information about \fIlabel\fR. +.PP +The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. +.PP +\fIrr\fR defaults to A, IPv4 addresses. +.SH "QDns::QDns ( const QHostAddress & address, RecordType rr = Ptr )" +Constructs a DNS query object that will return record type \fIrr\fR information about host address \fIaddress\fR. The label is set to the IN-ADDR.ARPA domain name. This is useful in combination with the Ptr record type (e.g. if you want to look up a hostname for a given address). +.PP +The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. +.PP +\fIrr\fR defaults to Ptr, that maps addresses to hostnames. +.SH "QDns::~QDns ()\fC [virtual]\fR" +Destroys the DNS query object and frees its allocated resources. +.SH "QValueList<QHostAddress> QDns::addresses () const" +Returns a list of the addresses for this name if this QDns object has a recordType() of QDns::A or QDns::Aaaa and the answer is available; otherwise returns an empty list. +.PP +As a special case, if label() is a valid numeric IP address, this function returns that address. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<QHostAddress> list = myDns.addresses(); +.br + QValueList<QHostAddress>::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "QString QDns::canonicalName () const" +Returns the canonical name for this DNS node. (This works regardless of what recordType() is set to.) +.PP +If the canonical name isn't known, this function returns a null string. +.PP +The canonical name of a DNS node is its full name, or the full name of the target of its CNAME. For example, if l.trolltech.com is a CNAME to lillian.troll.no, and the search path for QDns is" trolltech.com", then the canonical name for all of "lillian"," l", "lillian.troll.no." and "l.trolltech.com" is" lillian.troll.no.". +.SH "QStringList QDns::hostNames () const" +Returns a list of host names if the record type is Ptr. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myDns.hostNames(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "bool QDns::isWorking () const" +Returns TRUE if QDns is doing a lookup for this object (i.e. if it does not already have the necessary information); otherwise returns FALSE. +.PP +QDns emits the resultsReady() signal when the status changes to FALSE. +.PP +Example: network/mail/smtp.cpp. +.SH "QString QDns::label () const" +Returns the domain name for which this object returns information. +.PP +See also setLabel(). +.SH "QValueList<MailServer> QDns::mailServers () const" +Returns a list of mail servers if the record type is Mx. The class \fCQDns::MailServer\fR contains the following public variables: +.TP +QString QDns::MailServer::name +.TP +TQ_UINT16 QDns::MailServer::priority +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<QDns::MailServer> list = myDns.mailServers(); +.br + QValueList<QDns::MailServer>::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +Example: network/mail/smtp.cpp. +.SH "QStringList QDns::qualifiedNames () const" +Returns a list of the fully qualified names label() maps to. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myDns.qualifiedNames(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "RecordType QDns::recordType () const" +Returns the record type of this DNS query object. +.PP +See also setRecordType() and RecordType. +.SH "void QDns::resultsReady ()\fC [signal]\fR" +This signal is emitted when results are available for one of the qualifiedNames(). +.PP +Example: network/mail/smtp.cpp. +.SH "QValueList<Server> QDns::servers () const" +Returns a list of servers if the record type is Srv. The class \fCQDns::Server\fR contains the following public variables: +.TP +QString QDns::Server::name +.TP +TQ_UINT16 QDns::Server::priority +.TP +TQ_UINT16 QDns::Server::weight +.TP +TQ_UINT16 QDns::Server::port +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<QDns::Server> list = myDns.servers(); +.br + QValueList<QDns::Server>::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "void QDns::setLabel ( const QString & label )\fC [virtual]\fR" +Sets this DNS query object to query for information about \fIlabel\fR. +.PP +This does not change the recordType(), but its isWorking() status will probably change as a result. +.PP +The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. +.SH "void QDns::setLabel ( const QHostAddress & address )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets this DNS query object to query for information about the host address \fIaddress\fR. The label is set to the IN-ADDR.ARPA domain name. This is useful in combination with the Ptr record type (e.g. if you want to look up a hostname for a given address). +.SH "void QDns::setRecordType ( RecordType rr = A )\fC [virtual]\fR" +Sets this object to query for record type \fIrr\fR records. +.PP +The DNS lookup is started the next time the application enters the event loop. When the result is found the signal resultsReady() is emitted. +.PP +See also RecordType. +.SH "QStringList QDns::texts () const" +Returns a list of texts if the record type is Txt. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myDns.texts(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdns.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdns.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdockarea.3qt b/doc/man/man3/tqdockarea.3qt new file mode 100644 index 000000000..8c2307415 --- /dev/null +++ b/doc/man/man3/tqdockarea.3qt @@ -0,0 +1,233 @@ +'\" t +.TH QDockArea 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 +QDockArea \- Manages and lays out QDockWindows +.SH SYNOPSIS +\fC#include <ntqdockarea.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBHandlePosition\fR { Normal, Reverse }" +.br +.ti -1c +.BI "\fBQDockArea\fR ( Orientation o, HandlePosition h = Normal, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QDockArea\fR ()" +.br +.ti -1c +.BI "void \fBmoveDockWindow\fR ( QDockWindow * w, const QPoint & p, const QRect & r, bool swap )" +.br +.ti -1c +.BI "void \fBremoveDockWindow\fR ( QDockWindow * w, bool makeFloating, bool swap, bool fixNewLines = TRUE )" +.br +.ti -1c +.BI "void \fBmoveDockWindow\fR ( QDockWindow * w, int index = -1 )" +.br +.ti -1c +.BI "bool \fBhasDockWindow\fR ( QDockWindow * w, int * index = 0 )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "HandlePosition \fBhandlePosition\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "QPtrList<QDockWindow> \fBdockWindowList\fR () const" +.br +.ti -1c +.BI "bool \fBisDockWindowAccepted\fR ( QDockWindow * dw )" +.br +.ti -1c +.BI "void \fBsetAcceptDockWindow\fR ( QDockWindow * dw, bool accept )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBlineUp\fR ( bool keepNewLines )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBcount\fR - the number of dock windows in the dock area \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBempty\fR - whether the dock area is empty \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "HandlePosition \fBhandlePosition\fR - where the dock window splitter handle is placed in the dock area \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "Orientation \fBorientation\fR - the dock area's orientation \fI(read " "only" ")\fR" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( QTextStream & ts, const QDockArea & dockArea )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( QTextStream & ts, QDockArea & dockArea )" +.br +.in -1c +.SH DESCRIPTION +The QDockArea class manages and lays out QDockWindows. +.PP +A QDockArea is a container which manages a list of QDockWindows which it lays out within its area. In cooperation with the QDockWindows it is responsible for the docking and undocking of QDockWindows and moving them inside the dock area. QDockAreas also handle the wrapping of QDockWindows to fill the available space as compactly as possible. QDockAreas can contain QToolBars since QToolBar is a QDockWindow subclass. +.PP +QMainWindow contains four QDockAreas which you can use for your QToolBars and QDockWindows, so in most situations you do not need to use the QDockArea class directly. Although QMainWindow contains support for its own dock areas it isn't convenient for adding new QDockAreas. If you need to create your own dock areas we suggest that you create a subclass of QWidget and add your QDockAreas to your subclass. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +\fILines\fR. QDockArea uses the concept of lines. A line is a horizontal region which may contain dock windows side-by-side. A dock area may have room for more than one line. When dock windows are docked into a dock area they are usually added at the right hand side of the top-most line that has room (unless manually placed by the user). When users move dock windows they may leave empty lines or gaps in non-empty lines. Dock windows can be lined up to minimize wasted space using the lineUp() function. +.PP +The QDockArea class maintains a position list of all its child dock windows. Dock windows are added to a dock area from position 0 onwards. Dock windows are laid out sequentially in position order from left to right, and in the case of multiple lines of dock windows, from top to bottom. If a dock window is floated it still retains its position since this is where the window will return if the user double clicks its caption. A dock window's position can be determined with hasDockWindow(). The position can be changed with moveDockWindow(). +.PP +To dock or undock a dock window use QDockWindow::dock() and QDockWindow::undock() respectively. If you want to control which dock windows can dock in a dock area use setAcceptDockWindow(). To see if a dock area contains a particular dock window use hasDockWindow(); to see how many dock windows a dock area contains use count(). +.PP +The streaming operators can write the positions of the dock windows in the dock area to a QTextStream. The positions can be read back later to restore the saved positions. +.PP +Save the positions to a QTextStream: +.PP +.nf +.br + ts << *myDockArea; +.br +.fi +.PP +Restore the positions from a QTextStream: +.PP +.nf +.br + ts >> *myDockArea; +.br +.fi +.PP +See also Main Window and Related Classes. +.SS "Member Type Documentation" +.SH "QDockArea::HandlePosition" +A dock window has two kinds of handles, the dock window handle used for dragging the dock window, and the splitter handle used to resize the dock window in relation to other dock windows using a splitter. (The splitter handle is only visible for docked windows.) +.PP +This enum specifies where the dock window splitter handle is placed in the dock area. +.TP +\fCQDockArea::Normal\fR - The splitter handles of dock windows are placed at the right or bottom. +.TP +\fCQDockArea::Reverse\fR - The splitter handles of dock windows are placed at the left or top. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDockArea::QDockArea ( Orientation o, HandlePosition h = Normal, QWidget * parent = 0, const char * name = 0 )" +Constructs a QDockArea with orientation \fIo\fR, HandlePosition \fIh\fR, parent \fIparent\fR and called \fIname\fR. +.SH "QDockArea::~QDockArea ()" +Destroys the dock area and all the dock windows docked in the dock area. +.PP +Does not affect any floating dock windows or dock windows in other dock areas, even if they first appeared in this dock area. Floating dock windows are effectively top level windows and are not child windows of the dock area. When a floating dock window is docked (dragged into a dock area) its parent becomes the dock area. +.SH "int QDockArea::count () const" +Returns the number of dock windows in the dock area. See the "count" property for details. +.SH "QPtrList<QDockWindow> QDockArea::dockWindowList () const" +Returns a list of the dock windows in the dock area. +.SH "HandlePosition QDockArea::handlePosition () const" +Returns where the dock window splitter handle is placed in the dock area. See the "handlePosition" property for details. +.SH "bool QDockArea::hasDockWindow ( QDockWindow * w, int * index = 0 )" +Returns TRUE if the dock area contains the dock window \fIw\fR; otherwise returns FALSE. If \fIindex\fR is not 0 it will be set as follows: if the dock area contains the dock window \fI*index\fR is set to \fIw\fR's index position; otherwise \fI*index\fR is set to -1. +.SH "bool QDockArea::isDockWindowAccepted ( QDockWindow * dw )" +Returns TRUE if dock window \fIdw\fR could be docked into the dock area; otherwise returns FALSE. +.PP +See also setAcceptDockWindow(). +.SH "bool QDockArea::isEmpty () const" +Returns TRUE if the dock area is empty; otherwise returns FALSE. See the "empty" property for details. +.SH "void QDockArea::lineUp ( bool keepNewLines )\fC [slot]\fR" +Lines up the dock windows in this dock area to minimize wasted space. If \fIkeepNewLines\fR is TRUE, only space within lines is cleaned up. If \fIkeepNewLines\fR is FALSE the number of lines might be changed. +.SH "void QDockArea::moveDockWindow ( QDockWindow * w, int index = -1 )" +Moves the QDockWindow \fIw\fR within the dock area. If \fIw\fR is not already docked in this area, \fIw\fR is docked first. If \fIindex\fR is -1 or larger than the number of docked widgets, \fIw\fR is appended at the end, otherwise it is inserted at the position \fIindex\fR. +.SH "void QDockArea::moveDockWindow ( QDockWindow * w, const QPoint & p, const QRect & r, bool swap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Moves the dock window \fIw\fR inside the dock area where \fIp\fR is the new position (in global screen coordinates), \fIr\fR is the suggested rectangle of the dock window and \fIswap\fR specifies whether or not the orientation of the docked widget needs to be changed. +.PP +This function is used internally by QDockWindow. You shouldn't need to call it yourself. +.SH "Orientation QDockArea::orientation () const" +Returns the dock area's orientation. See the "orientation" property for details. +.SH "void QDockArea::removeDockWindow ( QDockWindow * w, bool makeFloating, bool swap, bool fixNewLines = TRUE )" +Removes the dock window \fIw\fR from the dock area. If \fImakeFloating\fR is TRUE, \fIw\fR gets floated, and if \fIswap\fR is TRUE, the orientation of \fIw\fR gets swapped. If \fIfixNewLines\fR is TRUE (the default) newlines in the area will be fixed. +.PP +You should never need to call this function yourself. Use QDockWindow::dock() and QDockWindow::undock() instead. +.SH "void QDockArea::setAcceptDockWindow ( QDockWindow * dw, bool accept )" +If \fIaccept\fR is TRUE, dock window \fIdw\fR can be docked in the dock area. If \fIaccept\fR is FALSE, dock window \fIdw\fR cannot be docked in the dock area. +.PP +See also isDockWindowAccepted(). +.SS "Property Documentation" +.SH "int count" +This property holds the number of dock windows in the dock area. +.PP +Get this property's value with count(). +.SH "bool empty" +This property holds whether the dock area is empty. +.PP +Get this property's value with isEmpty(). +.SH "HandlePosition handlePosition" +This property holds where the dock window splitter handle is placed in the dock area. +.PP +The default position is Normal. +.PP +Get this property's value with handlePosition(). +.SH "Orientation orientation" +This property holds the dock area's orientation. +.PP +There is no default value; the orientation is specified in the constructor. +.PP +Get this property's value with orientation(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QTextStream & operator<< ( QTextStream & ts, const QDockArea & dockArea )" +Writes the layout of the dock windows in dock area \fIdockArea\fR to the text stream \fIts\fR. +.PP +See also operator>>(). +.SH "QTextStream & operator>> ( QTextStream & ts, QDockArea & dockArea )" +Reads the layout description of the dock windows in dock area \fIdockArea\fR from the text stream \fIts\fR and restores it. The layout description must have been previously written by the operator<<() function. +.PP +See also operator<<(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdockarea.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdockarea.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdockwindow.3qt b/doc/man/man3/tqdockwindow.3qt new file mode 100644 index 000000000..9ea2e27a6 --- /dev/null +++ b/doc/man/man3/tqdockwindow.3qt @@ -0,0 +1,470 @@ +'\" t +.TH QDockWindow 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 +QDockWindow \- Widget which can be docked inside a QDockArea or floated as a top level window on the desktop +.SH SYNOPSIS +\fC#include <ntqdockwindow.h>\fR +.PP +Inherits QFrame. +.PP +Inherited by QToolBar. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBPlace\fR { InDock, OutsideDock }" +.br +.ti -1c +.BI "enum \fBCloseMode\fR { Never = 0, Docked = 1, Undocked = 2, Always = Docked | Undocked }" +.br +.ti -1c +.BI "\fBQDockWindow\fR ( Place p = InDock, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQDockWindow\fR ( QWidget * parent, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "virtual void \fBsetWidget\fR ( QWidget * w )" +.br +.ti -1c +.BI "QWidget * \fBwidget\fR () const" +.br +.ti -1c +.BI "Place \fBplace\fR () const" +.br +.ti -1c +.BI "QDockArea * \fBarea\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCloseMode\fR ( int m )" +.br +.ti -1c +.BI "bool \fBisCloseEnabled\fR () const" +.br +.ti -1c +.BI "int \fBcloseMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetResizeEnabled\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetMovingEnabled\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisResizeEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBisMovingEnabled\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetHorizontallyStretchable\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetVerticallyStretchable\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisHorizontallyStretchable\fR () const" +.br +.ti -1c +.BI "bool \fBisVerticallyStretchable\fR () const" +.br +.ti -1c +.BI "void setHorizontalStretchable ( bool b ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setVerticalStretchable ( bool b ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isHorizontalStretchable () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isVerticalStretchable () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBisStretchable\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetOffset\fR ( int o )" +.br +.ti -1c +.BI "int \fBoffset\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFixedExtentWidth\fR ( int w )" +.br +.ti -1c +.BI "virtual void \fBsetFixedExtentHeight\fR ( int h )" +.br +.ti -1c +.BI "QSize \fBfixedExtent\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNewLine\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBnewLine\fR () const" +.br +.ti -1c +.BI "Qt::Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "QBoxLayout * \fBboxLayout\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetOpaqueMoving\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBopaqueMoving\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBundock\fR ()" +.br +.ti -1c +.BI "virtual void \fBdock\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetOrientation\fR ( Orientation o )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBorientationChanged\fR ( Orientation o )" +.br +.ti -1c +.BI "void \fBplaceChanged\fR ( QDockWindow::Place p )" +.br +.ti -1c +.BI "void \fBvisibilityChanged\fR ( bool visible )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBcloseMode\fR - the close mode of a dock window" +.br +.ti -1c +.BI "bool \fBhorizontallyStretchable\fR - whether the dock window is horizontally stretchable" +.br +.ti -1c +.BI "bool \fBmovingEnabled\fR - whether the user can move the dock window within the dock " "area" ", move the dock window to another dock " "area" ", or float the dock window" +.br +.ti -1c +.BI "bool \fBnewLine\fR - whether the dock window prefers to start a new line in the dock area" +.br +.ti -1c +.BI "int \fBoffset\fR - the dock window's preferred offset from the dock area's left edge (top edge for vertical dock " "areas" ")" +.br +.ti -1c +.BI "bool \fBopaqueMoving\fR - whether the dock window will be shown normally whilst it is being moved" +.br +.ti -1c +.BI "Place \fBplace\fR \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBresizeEnabled\fR - whether the dock window is resizeable" +.br +.ti -1c +.BI "bool \fBstretchable\fR - whether the dock window is stretchable in the current orientation() \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBverticallyStretchable\fR - whether the dock window is vertically stretchable" +.br +.in -1c +.SH DESCRIPTION +The QDockWindow class provides a widget which can be docked inside a QDockArea or floated as a top level window on the desktop. +.PP +This class handles moving, resizing, docking and undocking dock windows. QToolBar is a subclass of QDockWindow so the functionality provided for dock windows is available with the same API for toolbars. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> <blockquote><p align="center">\fI Two QDockWindows (QToolBars) in a QDockArea \fR</p> </blockquote> +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> <blockquote><p align="center">\fI A Floating QDockWindow \fR</p> </blockquote> +.PP +If the user drags the dock window into the dock area the dock window will be docked. If the user drags the dock area outside any dock areas the dock window will be undocked (floated) and will become a top level window. Double clicking a floating dock window's titlebar will dock the dock window to the last dock area it was docked in. Double clicking a docked dock window's handle will undock (float) the dock window. If the user clicks the close button (which does not appear on dock windows by default - see closeMode) the dock window will disappear. You can control whether or not a dock window has a close button with setCloseMode(). +.PP +QMainWindow provides four dock areas (top, left, right and bottom) which can be used by dock windows. For many applications using the dock areas provided by QMainWindow is sufficient. (See the QDockArea documentation if you want to create your own dock areas.) In QMainWindow a right-click popup menu (the dock window menu) is available which lists dock windows and can be used to show or hide them. (The popup menu only lists dock windows that have a caption.) +.PP +When you construct a dock window you \fImust\fR pass it a QDockArea or a QMainWindow as its parent if you want it docked. Pass 0 for the parent if you want it floated. +.PP +.nf +.br + QToolBar *fileTools = new QToolBar( this, "File Actions" ); +.br + moveDockWindow( fileTools, Left ); +.br +.fi +.PP +In the example above we create a new QToolBar in the constructor of a QMainWindow subclass (so that the \fIthis\fR pointer points to the QMainWindow). By default the toolbar will be added to the Top dock area, but we've moved it to the Left dock area. +.PP +A dock window is often used to contain a single widget. In these cases the widget can be set by calling setWidget(). If you're constructing a dock window that contains multiple widgets, e.g. a toolbar, arrange the widgets within a box layout inside the dock window. To do this use the boxLayout() function to get a pointer to the dock window's box layout, then add widgets to the layout using the box layout's QBoxLayout::addWidget() function. The dock window will dynamically set the orientation of the layout to be vertical or horizontal as necessary, although you can control this yourself with setOrientation(). +.PP +Although a common use of dock windows is for toolbars, they can be used with any widgets. (See the Qt Designer and Qt Linguist applications, for example.) When using larger widgets it may make sense for the dock window to be resizable by calling setResizeEnabled(). Resizable dock windows are given splitter-like handles to allow the user to resize them within their dock area. When resizable dock windows are undocked they become top level windows and can be resized like any other top level windows, e.g. by dragging a corner or edge. +.PP +Dock windows can be docked and undocked using dock() and undock(). A dock window's orientation can be set with setOrientation(). You can also use QDockArea::moveDockWindow(). If you're using a QMainWindow, QMainWindow::moveDockWindow() and QMainWindow::removeDockWindow() are available. +.PP +A dock window can have some preferred settings, for example, you can set a preferred offset from the left edge (or top edge for vertical dock areas) of the dock area using setOffset(). If you'd prefer a dock window to start on a new line when it is docked use setNewLine(). The setFixedExtentWidth() and setFixedExtentHeight() functions can be used to define the dock window's preferred size, and the setHorizontallyStretchable() and setVerticallyStretchable() functions set whether the dock window can be stretched or not. Dock windows can be moved by default, but this can be changed with setMovingEnabled(). When a dock window is moved it is shown as a rectangular outline, but it can be shown normally using setOpaqueMoving(). +.PP +When a dock window's visibility changes, i.e. it is shown or hidden, the visibilityChanged() signal is emitted. When a dock window is docked, undocked or moved inside the dock area the placeChanged() signal is emitted. +.PP +See also Main Window and Related Classes. +.SS "Member Type Documentation" +.SH "QDockWindow::CloseMode" +This enum type specifies when (if ever) a dock window has a close button. +.TP +\fCQDockWindow::Never\fR - The dock window never has a close button and cannot be closed by the user. +.TP +\fCQDockWindow::Docked\fR - The dock window has a close button only when docked. +.TP +\fCQDockWindow::Undocked\fR - The dock window has a close button only when floating. +.TP +\fCQDockWindow::Always\fR - The dock window always has a close button. +.SH "QDockWindow::Place" +This enum specifies the possible locations for a QDockWindow: +.TP +\fCQDockWindow::InDock\fR - Inside a QDockArea. +.TP +\fCQDockWindow::OutsideDock\fR - Floating as a top level window on the desktop. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDockWindow::QDockWindow ( Place p = InDock, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a QDockWindow with parent \fIparent\fR, called \fIname\fR and with widget flags \fIf\fR. +.PP +If \fIp\fR is InDock, the dock window is docked into a dock area and \fIparent\fR \fImust\fR be a QDockArea or a QMainWindow. If the \fIparent\fR is a QMainWindow the dock window will be docked in the main window's Top dock area. +.PP +If \fIp\fR is OutsideDock, the dock window is created as a floating window. +.PP +We recommend creating the dock area InDock with a QMainWindow as parent then calling QMainWindow::moveDockWindow() to move the dock window where you want it. +.SH "QDockWindow::QDockWindow ( QWidget * parent, const char * name = 0, WFlags f = 0 )" +Constructs a QDockWindow with parent \fIparent\fR, called \fIname\fR and with widget flags \fIf\fR. +.SH "QDockArea * QDockWindow::area () const" +Returns the dock area in which this dock window is docked, or 0 if the dock window is floating. +.SH "QBoxLayout * QDockWindow::boxLayout ()" +Returns the layout which is used for adding widgets to the dock window. The layout's orientation is set automatically to match the orientation of the dock window. You can add widgets to the layout using the box layout's QBoxLayout::addWidget() function. +.PP +If the dock window only needs to contain a single widget use setWidget() instead. +.PP +See also setWidget() and setOrientation(). +.SH "int QDockWindow::closeMode () const" +Returns the close mode of a dock window. See the "closeMode" property for details. +.SH "void QDockWindow::dock ()\fC [virtual slot]\fR" +Docks the dock window into the last dock area in which it was docked. +.PP +If the dock window has no last dock area (e.g. it was created as a floating window and has never been docked), or if the last dock area it was docked in does not exist (e.g. the dock area has been deleted), nothing happens. +.PP +The dock window will dock with the dock area regardless of the return value of QDockArea::isDockWindowAccepted(). +.PP +See also undock(), QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), QMainWindow::removeDockWindow(), and QDockArea::isDockWindowAccepted(). +.SH "QSize QDockWindow::fixedExtent () const" +Returns the dock window's preferred size (fixed extent). +.PP +See also setFixedExtentWidth() and setFixedExtentHeight(). +.SH "bool QDockWindow::isCloseEnabled () const" +Returns TRUE if the dock window has a close button; otherwise returns FALSE. The result depends on the dock window's Place and its CloseMode. +.PP +See also closeMode. +.SH "bool QDockWindow::isHorizontalStretchable () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QDockWindow::isHorizontallyStretchable () const" +Returns TRUE if the dock window is horizontally stretchable; otherwise returns FALSE. See the "horizontallyStretchable" property for details. +.SH "bool QDockWindow::isMovingEnabled () const" +Returns TRUE if the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window; otherwise returns FALSE. See the "movingEnabled" property for details. +.SH "bool QDockWindow::isResizeEnabled () const" +Returns TRUE if the dock window is resizeable; otherwise returns FALSE. See the "resizeEnabled" property for details. +.SH "bool QDockWindow::isStretchable () const" +Returns TRUE if the dock window is stretchable in the current orientation(); otherwise returns FALSE. See the "stretchable" property for details. +.SH "bool QDockWindow::isVerticalStretchable () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QDockWindow::isVerticallyStretchable () const" +Returns TRUE if the dock window is vertically stretchable; otherwise returns FALSE. See the "verticallyStretchable" property for details. +.SH "bool QDockWindow::newLine () const" +Returns TRUE if the dock window prefers to start a new line in the dock area; otherwise returns FALSE. See the "newLine" property for details. +.SH "int QDockWindow::offset () const" +Returns the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas). See the "offset" property for details. +.SH "bool QDockWindow::opaqueMoving () const" +Returns TRUE if the dock window will be shown normally whilst it is being moved; otherwise returns FALSE. See the "opaqueMoving" property for details. +.SH "Qt::Orientation QDockWindow::orientation () const" +Returns the orientation of the dock window. +.PP +See also orientationChanged(). +.SH "void QDockWindow::orientationChanged ( Orientation o )\fC [signal]\fR" +This signal is emitted when the orientation of the dock window is changed. The new orientation is \fIo\fR. +.SH "Place QDockWindow::place () const" +This function returns where the dock window is placed. This is either InDock or OutsideDock. +.PP +See also QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), and QMainWindow::removeDockWindow(). +.SH "void QDockWindow::placeChanged ( QDockWindow::Place p )\fC [signal]\fR" +This signal is emitted when the dock window is docked (\fIp\fR is InDock), undocked (\fIp\fR is OutsideDock) or moved inside the the dock area. +.PP +See also QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), and QMainWindow::removeDockWindow(). +.SH "void QDockWindow::setCloseMode ( int m )\fC [virtual]\fR" +Sets the close mode of a dock window to \fIm\fR. See the "closeMode" property for details. +.SH "void QDockWindow::setFixedExtentHeight ( int h )\fC [virtual]\fR" +Sets the dock window's preferred height for its fixed extent (size) to \fIh\fR. +.PP +See also setFixedExtentWidth(). +.SH "void QDockWindow::setFixedExtentWidth ( int w )\fC [virtual]\fR" +Sets the dock window's preferred width for its fixed extent (size) to \fIw\fR. +.PP +See also setFixedExtentHeight(). +.SH "void QDockWindow::setHorizontalStretchable ( bool b )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QDockWindow::setHorizontallyStretchable ( bool b )\fC [virtual]\fR" +Sets whether the dock window is horizontally stretchable to \fIb\fR. See the "horizontallyStretchable" property for details. +.SH "void QDockWindow::setMovingEnabled ( bool b )\fC [virtual]\fR" +Sets whether the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window to \fIb\fR. See the "movingEnabled" property for details. +.SH "void QDockWindow::setNewLine ( bool b )\fC [virtual]\fR" +Sets whether the dock window prefers to start a new line in the dock area to \fIb\fR. See the "newLine" property for details. +.SH "void QDockWindow::setOffset ( int o )\fC [virtual]\fR" +Sets the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas) to \fIo\fR. See the "offset" property for details. +.SH "void QDockWindow::setOpaqueMoving ( bool b )\fC [virtual]\fR" +Sets whether the dock window will be shown normally whilst it is being moved to \fIb\fR. See the "opaqueMoving" property for details. +.SH "void QDockWindow::setOrientation ( Orientation o )\fC [virtual slot]\fR" +Sets the orientation of the dock window to \fIo\fR. The orientation is propagated to the layout boxLayout(). +.PP +\fBWarning:\fR All undocked QToolBars will always have a horizontal orientation. +.SH "void QDockWindow::setResizeEnabled ( bool b )\fC [virtual]\fR" +Sets whether the dock window is resizeable to \fIb\fR. See the "resizeEnabled" property for details. +.SH "void QDockWindow::setVerticalStretchable ( bool b )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QDockWindow::setVerticallyStretchable ( bool b )\fC [virtual]\fR" +Sets whether the dock window is vertically stretchable to \fIb\fR. See the "verticallyStretchable" property for details. +.SH "void QDockWindow::setWidget ( QWidget * w )\fC [virtual]\fR" +Sets the dock window's main widget to \fIw\fR. +.PP +See also boxLayout(). +.SH "void QDockWindow::undock ()\fC [virtual slot]\fR" +Undocks the QDockWindow from its current dock area if it is docked; otherwise does nothing. +.PP +See also dock(), QDockArea::moveDockWindow(), QDockArea::removeDockWindow(), QMainWindow::moveDockWindow(), and QMainWindow::removeDockWindow(). +.SH "void QDockWindow::visibilityChanged ( bool visible )\fC [signal]\fR" +This signal is emitted when the visibility of the dock window relatively to its dock area is changed. If \fIvisible\fR is TRUE, the QDockWindow is now visible to the dock area, otherwise it has been hidden. +.PP +A dock window can be hidden if it has a close button which the user has clicked. In the case of a QMainWindow a dock window can have its visibility changed (hidden or shown) by clicking its name in the dock window menu that lists the QMainWindow's dock windows. +.SH "QWidget * QDockWindow::widget () const" +Returns the dock window's main widget. +.PP +See also setWidget(). +.SS "Property Documentation" +.SH "int closeMode" +This property holds the close mode of a dock window. +.PP +Defines when (if ever) the dock window has a close button. The choices are Never, Docked (i.e. only when docked), Undocked (only when undocked, i.e. floated) or Always. +.PP +The default is Never. +.PP +Set this property's value with setCloseMode() and get this property's value with closeMode(). +.SH "bool horizontallyStretchable" +This property holds whether the dock window is horizontally stretchable. +.PP +A dock window is horizontally stretchable if you call setHorizontallyStretchable(TRUE) or setResizeEnabled(TRUE). +.PP +See also resizeEnabled. +.PP +Bugs and limitations: +.TP +Strecthability is broken. You must call setResizeEnabled(TRUE) to get proper behavior and even then QDockWindow does not limit stretchablilty. +.PP +Set this property's value with setHorizontallyStretchable() and get this property's value with isHorizontallyStretchable(). +.SH "bool movingEnabled" +This property holds whether the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window. +.PP +This property is TRUE by default. +.PP +Set this property's value with setMovingEnabled() and get this property's value with isMovingEnabled(). +.SH "bool newLine" +This property holds whether the dock window prefers to start a new line in the dock area. +.PP +The default is FALSE, i.e. the dock window doesn't require a new line in the dock area. +.PP +Set this property's value with setNewLine() and get this property's value with newLine(). +.SH "int offset" +This property holds the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas). +.PP +The default is 0. +.PP +Set this property's value with setOffset() and get this property's value with offset(). +.SH "bool opaqueMoving" +This property holds whether the dock window will be shown normally whilst it is being moved. +.PP +If this property is FALSE, (the default), the dock window will be represented by an outline rectangle whilst it is being moved. +.PP +\fBWarning:\fR Currently opaque moving has some problems and we do not recommend using it at this time. We expect to fix these problems in a future release. +.PP +Set this property's value with setOpaqueMoving() and get this property's value with opaqueMoving(). +.SH "bool resizeEnabled" +This property holds whether the dock window is resizeable. +.PP +A resizeable dock window can be resized using splitter-like handles inside a dock area and like every other top level window when floating. +.PP +A dock window is both horizontally and vertically stretchable if you call setResizeEnabled(TRUE). +.PP +This property is FALSE by default. +.PP +See also verticallyStretchable and horizontallyStretchable. +.PP +Set this property's value with setResizeEnabled() and get this property's value with isResizeEnabled(). +.SH "bool stretchable" +This property holds whether the dock window is stretchable in the current orientation(). +.PP +This property can be set using setHorizontallyStretchable() and setVerticallyStretchable(), or with setResizeEnabled(). +.PP +See also resizeEnabled. +.PP +Bugs and limitations: +.TP +Strecthability is broken. You must call setResizeEnabled(TRUE) to get proper behavior and even then QDockWindow does not limit stretchablilty. +.PP +Get this property's value with isStretchable(). +.SH "bool verticallyStretchable" +This property holds whether the dock window is vertically stretchable. +.PP +A dock window is vertically stretchable if you call setVerticallyStretchable(TRUE) or setResizeEnabled(TRUE). +.PP +See also resizeEnabled. +.PP +Bugs and limitations: +.TP +Strecthability is broken. You must call setResizeEnabled(TRUE) to get proper behavior and even then QDockWindow does not limit stretchablilty. +.PP +Set this property's value with setVerticallyStretchable() and get this property's value with isVerticallyStretchable(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdockwindow.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdockwindow.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomattr.3qt b/doc/man/man3/tqdomattr.3qt new file mode 100644 index 000000000..f316dd147 --- /dev/null +++ b/doc/man/man3/tqdomattr.3qt @@ -0,0 +1,153 @@ +'\" t +.TH QDomAttr 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 +QDomAttr \- Represents one attribute of a QDomElement +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomAttr\fR ()" +.br +.ti -1c +.BI "\fBQDomAttr\fR ( const QDomAttr & x )" +.br +.ti -1c +.BI "QDomAttr & \fBoperator=\fR ( const QDomAttr & x )" +.br +.ti -1c +.BI "\fB~QDomAttr\fR ()" +.br +.ti -1c +.BI "virtual QString \fBname\fR () const" +.br +.ti -1c +.BI "virtual bool \fBspecified\fR () const" +.br +.ti -1c +.BI "virtual QDomElement \fBownerElement\fR () const" +.br +.ti -1c +.BI "virtual QString \fBvalue\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetValue\fR ( const QString & v )" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisAttr\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomAttr class represents one attribute of a QDomElement. +.PP +For example, the following piece of XML produces an element with no children, but two attributes: +.PP +.nf +.br + <link href="http://www.trolltech.com" color="red" /> +.br +.fi +.PP +You can access the attributes of an element with code like this: +.PP +.nf +.br + QDomElement e = //... +.br + //... +.br + QDomAttr a = e.attributeNode( "href" ); +.br + cout << a.value() << endl; // prints "http://www.trolltech.com" +.br + a.setValue( "http://doc.trolltech.com" ); // change the node's attribute +.br + QDomAttr a2 = e.attributeNode( "href" ); +.br + cout << a2.value() << endl; // prints "http://doc.trolltech.com" +.br +.fi +.PP +This example also shows that changing an attribute received from an element changes the attribute of the element. If you do not want to change the value of the element's attribute you must use cloneNode() to get an independent copy of the attribute. +.PP +QDomAttr can return the name() and value() of an attribute. An attribute's value is set with setValue(). If specified() returns TRUE the value was either set in the document or set with setValue(); otherwise the value hasn't been set. The node this attribute is attached to (if any) is returned by ownerElement(). +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomAttr::QDomAttr ()" +Constructs an empty attribute. +.SH "QDomAttr::QDomAttr ( const QDomAttr & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomAttr::~QDomAttr ()" +Destroys the object and frees its resources. +.SH "bool QDomAttr::isAttr () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QString QDomAttr::name () const\fC [virtual]\fR" +Returns the attribute's name. +.SH "QDomNode::NodeType QDomAttr::nodeType () const\fC [virtual]\fR" +Returns AttributeNode. +.PP +Reimplemented from QDomNode. +.SH "QDomAttr & QDomAttr::operator= ( const QDomAttr & x )" +Assigns \fIx\fR to this DOM attribute. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomElement QDomAttr::ownerElement () const\fC [virtual]\fR" +Returns the element node this attribute is attached to or a null node if this attribute is not attached to any element. +.SH "void QDomAttr::setValue ( const QString & v )\fC [virtual]\fR" +Sets the attribute's value to \fIv\fR. +.PP +See also value(). +.SH "bool QDomAttr::specified () const\fC [virtual]\fR" +Returns TRUE if the attribute has either been expicitly specified in the XML document or was set by the user with setValue(). Returns FALSE if the value hasn't been specified or set. +.PP +See also setValue(). +.SH "QString QDomAttr::value () const\fC [virtual]\fR" +Returns the value of the attribute or QString::null if the attribute has not been specified. +.PP +See also specified() and setValue(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomattr.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomattr.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomcdatasection.3qt b/doc/man/man3/tqdomcdatasection.3qt new file mode 100644 index 000000000..c238ac6f9 --- /dev/null +++ b/doc/man/man3/tqdomcdatasection.3qt @@ -0,0 +1,96 @@ +'\" t +.TH QDomCDATASection 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 +QDomCDATASection \- Represents an XML CDATA section +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomText. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomCDATASection\fR ()" +.br +.ti -1c +.BI "\fBQDomCDATASection\fR ( const QDomCDATASection & x )" +.br +.ti -1c +.BI "QDomCDATASection & \fBoperator=\fR ( const QDomCDATASection & x )" +.br +.ti -1c +.BI "\fB~QDomCDATASection\fR ()" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisCDATASection\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomCDATASection class represents an XML CDATA section. +.PP +CDATA sections are used to escape blocks of text containing characters that would otherwise be regarded as markup. The only delimiter that is recognized in a CDATA section is the "]]>" string that terminates the CDATA section. CDATA sections cannot be nested. Their primary purpose is for including material such as XML fragments, without needing to escape all the delimiters. +.PP +Adjacent QDomCDATASection nodes are not merged by the QDomNode::normalize() function. +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomCDATASection::QDomCDATASection ()" +Constructs an empty CDATA section. To create a CDATA section with content, use the QDomDocument::createCDATASection() function. +.SH "QDomCDATASection::QDomCDATASection ( const QDomCDATASection & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomCDATASection::~QDomCDATASection ()" +Destroys the object and frees its resources. +.SH "bool QDomCDATASection::isCDATASection () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomCDATASection::nodeType () const\fC [virtual]\fR" +Returns \fCCDATASection\fR. +.PP +Reimplemented from QDomText. +.SH "QDomCDATASection & QDomCDATASection::operator= ( const QDomCDATASection & x )" +Assigns \fIx\fR to this CDATA section. +.PP +The data of the copy is shared (shallow copy): modifying one node +will also change the other. If you want to make a deep copy, use +cloneNode(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomcdatasection.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomcdatasection.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomcharacterdata.3qt b/doc/man/man3/tqdomcharacterdata.3qt new file mode 100644 index 000000000..d8002911e --- /dev/null +++ b/doc/man/man3/tqdomcharacterdata.3qt @@ -0,0 +1,140 @@ +'\" t +.TH QDomCharacterData 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 +QDomCharacterData \- Represents a generic string in the DOM +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +Inherited by QDomText and QDomComment. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomCharacterData\fR ()" +.br +.ti -1c +.BI "\fBQDomCharacterData\fR ( const QDomCharacterData & x )" +.br +.ti -1c +.BI "QDomCharacterData & \fBoperator=\fR ( const QDomCharacterData & x )" +.br +.ti -1c +.BI "\fB~QDomCharacterData\fR ()" +.br +.ti -1c +.BI "virtual QString \fBsubstringData\fR ( unsigned long offset, unsigned long count )" +.br +.ti -1c +.BI "virtual void \fBappendData\fR ( const QString & arg )" +.br +.ti -1c +.BI "virtual void \fBinsertData\fR ( unsigned long offset, const QString & arg )" +.br +.ti -1c +.BI "virtual void \fBdeleteData\fR ( unsigned long offset, unsigned long count )" +.br +.ti -1c +.BI "virtual void \fBreplaceData\fR ( unsigned long offset, unsigned long count, const QString & arg )" +.br +.ti -1c +.BI "virtual uint \fBlength\fR () const" +.br +.ti -1c +.BI "virtual QString \fBdata\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetData\fR ( const QString & v )" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisCharacterData\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomCharacterData class represents a generic string in the DOM. +.PP +Character data as used in XML specifies a generic data string. More specialized versions of this class are QDomText, QDomComment and QDomCDATASection. +.PP +The data string is set with setData() and retrieved with data(). You can retrieve a portion of the data string using substringData(). Extra data can be appended with appendData(), or inserted with insertData(). Portions of the data string can be deleted with deleteData() or replaced with replaceData(). The length of the data string is returned by length(). +.PP +The node type of the node containing this character data is returned by nodeType(). +.PP +See also QDomText, QDomComment, QDomCDATASection, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomCharacterData::QDomCharacterData ()" +Constructs an empty character data object. +.SH "QDomCharacterData::QDomCharacterData ( const QDomCharacterData & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomCharacterData::~QDomCharacterData ()" +Destroys the object and frees its resources. +.SH "void QDomCharacterData::appendData ( const QString & arg )\fC [virtual]\fR" +Appends the string \fIarg\fR to the stored string. +.SH "QString QDomCharacterData::data () const\fC [virtual]\fR" +Returns the string stored in this object. +.PP +If the node is a null node, it will return QString::null. +.SH "void QDomCharacterData::deleteData ( unsigned long offset, unsigned long count )\fC [virtual]\fR" +Deletes a substring of length \fIcount\fR from position \fIoffset\fR. +.SH "void QDomCharacterData::insertData ( unsigned long offset, const QString & arg )\fC [virtual]\fR" +Inserts the string \fIarg\fR into the stored string at position \fIoffset\fR. +.SH "bool QDomCharacterData::isCharacterData () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "uint QDomCharacterData::length () const\fC [virtual]\fR" +Returns the length of the stored string. +.SH "QDomNode::NodeType QDomCharacterData::nodeType () const\fC [virtual]\fR" +Returns the type of node this object refers to (i.e. TextNode, CDATASectionNode, CommentNode or CharacterDataNode). For a null node CharacterDataNode is returned. +.PP +Reimplemented from QDomNode. +.PP +Reimplemented in QDomText and QDomComment. +.SH "QDomCharacterData & QDomCharacterData::operator= ( const QDomCharacterData & x )" +Assigns \fIx\fR to this character data. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "void QDomCharacterData::replaceData ( unsigned long offset, unsigned long count, const QString & arg )\fC [virtual]\fR" +Replaces the substring of length \fIcount\fR starting at position \fIoffset\fR with the string \fIarg\fR. +.SH "void QDomCharacterData::setData ( const QString & v )\fC [virtual]\fR" +Sets this object's string to \fIv\fR. +.SH "QString QDomCharacterData::substringData ( unsigned long offset, unsigned long count )\fC [virtual]\fR" +Returns the substring of length \fIcount\fR from position \fIoffset\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomcharacterdata.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomcharacterdata.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomcomment.3qt b/doc/man/man3/tqdomcomment.3qt new file mode 100644 index 000000000..a9aea72f1 --- /dev/null +++ b/doc/man/man3/tqdomcomment.3qt @@ -0,0 +1,101 @@ +'\" t +.TH QDomComment 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 +QDomComment \- Represents an XML comment +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomCharacterData. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomComment\fR ()" +.br +.ti -1c +.BI "\fBQDomComment\fR ( const QDomComment & x )" +.br +.ti -1c +.BI "QDomComment & \fBoperator=\fR ( const QDomComment & x )" +.br +.ti -1c +.BI "\fB~QDomComment\fR ()" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisComment\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomComment class represents an XML comment. +.PP +A comment in the parsed XML such as this: +.PP +.nf +.br + <!-- this is a comment --> +.br +.fi +is represented by QDomComment objects in the parsed Dom tree. +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomComment::QDomComment ()" +Constructs an empty comment. To construct a comment with content, use the QDomDocument::createComment() function. +.SH "QDomComment::QDomComment ( const QDomComment & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomComment::~QDomComment ()" +Destroys the object and frees its resources. +.SH "bool QDomComment::isComment () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomComment::nodeType () const\fC [virtual]\fR" +Returns CommentNode. +.PP +Reimplemented from QDomCharacterData. +.SH "QDomComment & QDomComment::operator= ( const QDomComment & x )" +Assigns \fIx\fR to this DOM comment. +.PP +The data of the copy is shared (shallow copy): modifying one node +will also change the other. If you want to make a deep copy, use +cloneNode(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomcomment.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomcomment.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomdocument.3qt b/doc/man/man3/tqdomdocument.3qt new file mode 100644 index 000000000..0f67e3d30 --- /dev/null +++ b/doc/man/man3/tqdomdocument.3qt @@ -0,0 +1,448 @@ +'\" t +.TH QDomDocument 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 +QDomDocument \- Represents an XML document +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomDocument\fR ()" +.br +.ti -1c +.BI "explicit \fBQDomDocument\fR ( const QString & name )" +.br +.ti -1c +.BI "explicit \fBQDomDocument\fR ( const QDomDocumentType & doctype )" +.br +.ti -1c +.BI "\fBQDomDocument\fR ( const QDomDocument & x )" +.br +.ti -1c +.BI "QDomDocument & \fBoperator=\fR ( const QDomDocument & x )" +.br +.ti -1c +.BI "\fB~QDomDocument\fR ()" +.br +.ti -1c +.BI "QDomElement \fBcreateElement\fR ( const QString & tagName )" +.br +.ti -1c +.BI "QDomDocumentFragment \fBcreateDocumentFragment\fR ()" +.br +.ti -1c +.BI "QDomText \fBcreateTextNode\fR ( const QString & value )" +.br +.ti -1c +.BI "QDomComment \fBcreateComment\fR ( const QString & value )" +.br +.ti -1c +.BI "QDomCDATASection \fBcreateCDATASection\fR ( const QString & value )" +.br +.ti -1c +.BI "QDomProcessingInstruction \fBcreateProcessingInstruction\fR ( const QString & target, const QString & data )" +.br +.ti -1c +.BI "QDomAttr \fBcreateAttribute\fR ( const QString & name )" +.br +.ti -1c +.BI "QDomEntityReference \fBcreateEntityReference\fR ( const QString & name )" +.br +.ti -1c +.BI "QDomNodeList \fBelementsByTagName\fR ( const QString & tagname ) const" +.br +.ti -1c +.BI "QDomNode \fBimportNode\fR ( const QDomNode & importedNode, bool deep )" +.br +.ti -1c +.BI "QDomElement \fBcreateElementNS\fR ( const QString & nsURI, const QString & qName )" +.br +.ti -1c +.BI "QDomAttr \fBcreateAttributeNS\fR ( const QString & nsURI, const QString & qName )" +.br +.ti -1c +.BI "QDomNodeList \fBelementsByTagNameNS\fR ( const QString & nsURI, const QString & localName )" +.br +.ti -1c +.BI "QDomElement \fBelementById\fR ( const QString & elementId )" +.br +.ti -1c +.BI "QDomDocumentType \fBdoctype\fR () const" +.br +.ti -1c +.BI "QDomImplementation \fBimplementation\fR () const" +.br +.ti -1c +.BI "QDomElement \fBdocumentElement\fR () const" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( const QCString & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( const QByteArray & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( const QString & text, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( QIODevice * dev, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( const QCString & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( const QByteArray & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( const QString & text, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( QIODevice * dev, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "bool \fBsetContent\fR ( QXmlInputSource * source, QXmlReader * reader, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisDocument\fR () const" +.br +.ti -1c +.BI "QString \fBtoString\fR () const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( int indent ) const" +.br +.ti -1c +.BI "QCString \fBtoCString\fR () const" +.br +.ti -1c +.BI "QCString \fBtoCString\fR ( int indent ) const" +.br +.in -1c +.SH DESCRIPTION +The QDomDocument class represents an XML document. +.PP +The QDomDocument class represents the entire XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data. +.PP +Since elements, text nodes, comments, processing instructions, etc., cannot exist outside the context of a document, the document class also contains the factory functions needed to create these objects. The node objects created have an ownerDocument() function which associates them with the document within whose context they were created. The DOM classes that will be used most often are QDomNode, QDomDocument, QDomElement and QDomText. +.PP +The parsed XML is represented internally by a tree of objects that can be accessed using the various QDom classes. All QDom classes only \fIreference\fR objects in the internal tree. The internal objects in the DOM tree will get deleted once the last QDom object referencing them and the QDomDocument itself are deleted. +.PP +Creation of elements, text nodes, etc. is done using the various factory functions provided in this class. Using the default constructors of the QDom classes will only result in empty objects that cannot be manipulated or inserted into the Document. +.PP +The QDomDocument class has several functions for creating document data, for example, createElement(), createTextNode(), createComment(), createCDATASection(), createProcessingInstruction(), createAttribute() and createEntityReference(). Some of these functions have versions that support namespaces, i.e. createElementNS() and createAttributeNS(). The createDocumentFragment() function is used to hold parts of the document; this is useful for manipulating for complex documents. +.PP +The entire content of the document is set with setContent(). This function parses the string it is passed as an XML document and creates the DOM tree that represents the document. The root element is available using documentElement(). The textual representation of the document can be obtained using toString(). +.PP +It is possible to insert a node from another document into the document using importNode(). +.PP +You can obtain a list of all the elements that have a particular tag with elementsByTagName() or with elementsByTagNameNS(). +.PP +The QDom classes are typically used as follows: +.PP +.nf +.br + QDomDocument doc( "mydocument" ); +.br + QFile file( "mydocument.xml" ); +.br + if ( !file.open( IO_ReadOnly ) ) +.br + return; +.br + if ( !doc.setContent( &file ) ) { +.br + file.close(); +.br + return; +.br + } +.br + file.close(); +.br +.br + // print out the element names of all elements that are direct children +.br + // of the outermost element. +.br + QDomElement docElem = doc.documentElement(); +.br +.br + QDomNode n = docElem.firstChild(); +.br + while( !n.isNull() ) { +.br + QDomElement e = n.toElement(); // try to convert the node to an element. +.br + if( !e.isNull() ) { +.br + cout << e.tagName() << endl; // the node really is an element. +.br + } +.br + n = n.nextSibling(); +.br + } +.br +.br + // Here we append a new element to the end of the document +.br + QDomElement elem = doc.createElement( "img" ); +.br + elem.setAttribute( "src", "myimage.png" ); +.br + docElem.appendChild( elem ); +.br +.fi +.PP +Once \fCdoc\fR and \fCelem\fR go out of scope, the whole internal tree representing the XML document is deleted. +.PP +To create a document using DOM use code like this: +.PP +.nf +.br + QDomDocument doc( "MyML" ); +.br + QDomElement root = doc.createElement( "MyML" ); +.br + doc.appendChild( root ); +.br +.br + QDomElement tag = doc.createElement( "Greeting" ); +.br + root.appendChild( tag ); +.br +.br + QDomText t = doc.createTextNode( "Hello World" ); +.br + tag.appendChild( t ); +.br +.br + QString xml = doc.toString(); +.br +.fi +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomDocument::QDomDocument ()" +Constructs an empty document. +.SH "explicit QDomDocument::QDomDocument ( const QString & name )" +Creates a document and sets the name of the document type to \fIname\fR. +.SH "explicit QDomDocument::QDomDocument ( const QDomDocumentType & doctype )" +Creates a document with the document type \fIdoctype\fR. +.PP +See also QDomImplementation::createDocumentType(). +.SH "QDomDocument::QDomDocument ( const QDomDocument & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomDocument::~QDomDocument ()" +Destroys the object and frees its resources. +.SH "QDomAttr QDomDocument::createAttribute ( const QString & name )" +Creates a new attribute called \fIname\fR that can be inserted into an element, e.g. using QDomElement::setAttributeNode(). +.PP +See also createAttributeNS(). +.SH "QDomAttr QDomDocument::createAttributeNS ( const QString & nsURI, const QString & qName )" +Creates a new attribute with namespace support that can be inserted into an element. The name of the attribute is \fIqName\fR and the namespace URI is \fInsURI\fR. This function also sets QDomNode::prefix() and QDomNode::localName() to appropriate values (depending on \fIqName\fR). +.PP +See also createAttribute(). +.SH "QDomCDATASection QDomDocument::createCDATASection ( const QString & value )" +Creates a new CDATA section for the string \fIvalue\fR that can be inserted into the document, e.g. using QDomNode::appendChild(). +.PP +See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). +.SH "QDomComment QDomDocument::createComment ( const QString & value )" +Creates a new comment for the string \fIvalue\fR that can be inserted into the document, e.g. using QDomNode::appendChild(). +.PP +See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). +.SH "QDomDocumentFragment QDomDocument::createDocumentFragment ()" +Creates a new document fragment, that can be used to hold parts of the document, e.g. when doing complex manipulations of the document tree. +.SH "QDomElement QDomDocument::createElement ( const QString & tagName )" +Creates a new element called \fItagName\fR that can be inserted into the DOM tree, e.g. using QDomNode::appendChild(). +.PP +See also createElementNS(), QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). +.SH "QDomElement QDomDocument::createElementNS ( const QString & nsURI, const QString & qName )" +Creates a new element with namespace support that can be inserted into the DOM tree. The name of the element is \fIqName\fR and the namespace URI is \fInsURI\fR. This function also sets QDomNode::prefix() and QDomNode::localName() to appropriate values (depending on \fIqName\fR). +.PP +See also createElement(). +.SH "QDomEntityReference QDomDocument::createEntityReference ( const QString & name )" +Creates a new entity reference called \fIname\fR that can be inserted into the document, e.g. using QDomNode::appendChild(). +.PP +See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). +.SH "QDomProcessingInstruction QDomDocument::createProcessingInstruction ( const QString & target, const QString & data )" +Creates a new processing instruction that can be inserted into the document, e.g. using QDomNode::appendChild(). This function sets the target for the processing instruction to \fItarget\fR and the data to \fIdata\fR. +.PP +See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). +.SH "QDomText QDomDocument::createTextNode ( const QString & value )" +Creates a text node for the string \fIvalue\fR that can be inserted into the document tree, e.g. using QDomNode::appendChild(). +.PP +\fBWarning:\fR All characters within an XML document must be in the range: +.PP +#x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] +.PP +This rule also applies to characters encoded as character entities and characters in CDATA sections. If you use this function to insert characters outside of this range, the document will not be well-formed. +.PP +If you want to store binary data in an XML document you must either use your own scheme to escape illegal characters, or you must store it in an external unparsed entity. +.PP +See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter(). +.SH "QDomDocumentType QDomDocument::doctype () const" +Returns the document type of this document. +.SH "QDomElement QDomDocument::documentElement () const" +Returns the root element of the document. +.SH "QDomElement QDomDocument::elementById ( const QString & elementId )" +Returns the element whose ID is equal to \fIelementId\fR. If no element with the ID was found, this function returns a null element. +.PP +Since the QDomClasses do not know which attributes are element IDs, this function returns always a null element. This may change in a future version. +.SH "QDomNodeList QDomDocument::elementsByTagName ( const QString & tagname ) const" +Returns a QDomNodeList, that contains all the elements in the document with the name \fItagname\fR. The order of the node list is the order they are encountered in a preorder traversal of the element tree. +.PP +See also elementsByTagNameNS() and QDomElement::elementsByTagName(). +.SH "QDomNodeList QDomDocument::elementsByTagNameNS ( const QString & nsURI, const QString & localName )" +Returns a QDomNodeList that contains all the elements in the document with the local name \fIlocalName\fR and a namespace URI of \fInsURI\fR. The order of the node list is the order they are encountered in a preorder traversal of the element tree. +.PP +See also elementsByTagName() and QDomElement::elementsByTagNameNS(). +.SH "QDomImplementation QDomDocument::implementation () const" +Returns a QDomImplementation object. +.SH "QDomNode QDomDocument::importNode ( const QDomNode & importedNode, bool deep )" +Imports the node \fIimportedNode\fR from another document to this document. \fIimportedNode\fR remains in the original document; this function creates a copy that can be used within this document. +.PP +This function returns the imported node that belongs to this document. The returned node has no parent. It is not possible to import QDomDocument and QDomDocumentType nodes. In those cases this function returns a null node. +.PP +If \fIdeep\fR is TRUE, this function imports not only the node \fIimportedNode\fR but its whole subtree; if it is FALSE, only the \fIimportedNode\fR is imported. The argument \fIdeep\fR has no effect on QDomAttr and QDomEntityReference nodes, since the descendents of QDomAttr nodes are always imported and those of QDomEntityReference nodes are never imported. +.PP +The behavior of this function is slightly different depending on the node types: <center>.nf +.TS +l - l. Node Type Behaviour QDomAttr The owner element is set to 0 and the specified flag is set to TRUE in the generated attribute. The whole subtree of \fIimportedNode\fR is always imported for attribute nodes: \fIdeep\fR has no effect. QDomDocument Document nodes cannot be imported. QDomDocumentFragment If \fIdeep\fR is TRUE, this function imports the whole document fragment; otherwise it only generates an empty document fragment. QDomDocumentType Document type nodes cannot be imported. QDomElement Attributes for which QDomAttr::specified() is TRUE are also imported, other attributes are not imported. If \fIdeep\fR is TRUE, this function also imports the subtree of \fIimportedNode\fR; otherwise it imports only the element node (and some attributes, see above). QDomEntity Entity nodes can be imported, but at the moment there is no way to use them since the document type is read-only in DOM level 2. QDomEntityReference Descendents of entity reference nodes are never imported: \fIdeep\fR has no effect. QDomNotation Notation nodes can be imported, but at the moment there is no way to use them since the document type is read-only in DOM level 2. QDomProcessingInstruction The target and value of the processing instruction is copied to the new node. QDomText The text is copied to the new node. QDomCDATASection The text is copied to the new node. QDomComment +.TE +.fi +</center> +.PP +See also QDomElement::setAttribute(), QDomNode::insertBefore(), QDomNode::insertAfter(), QDomNode::replaceChild(), QDomNode::removeChild(), and QDomNode::appendChild(). +.SH "bool QDomDocument::isDocument () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomDocument::nodeType () const\fC [virtual]\fR" +Returns DocumentNode. +.PP +Reimplemented from QDomNode. +.SH "QDomDocument & QDomDocument::operator= ( const QDomDocument & x )" +Assigns \fIx\fR to this DOM document. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "bool QDomDocument::setContent ( const QByteArray & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This function parses the XML document from the byte array \fIbuffer\fR and sets it as the content of the document. It tries to detect the encoding of the document as required by the XML specification. +.PP +If \fInamespaceProcessing\fR is TRUE, the parser recognizes namespaces in the XML file and sets the prefix name, local name and namespace URI to appropriate values. If \fInamespaceProcessing\fR is FALSE, the parser does no namespace processing when it reads the XML file. +.PP +If a parse error occurs, the function returns FALSE; otherwise it returns TRUE. If a parse error occurs and \fIerrorMsg\fR, \fIerrorLine\fR and \fIerrorColumn\fR are not 0, the error message is placed in \fI*errorMsg\fR, the line number \fI*errorLine\fR and the column number in \fI*errorColumn\fR. +.PP +If \fInamespaceProcessing\fR is TRUE, the function QDomNode::prefix() returns a string for all elements and attributes. It returns an empty string if the element or attribute has no prefix. +.PP +If \fInamespaceProcessing\fR is FALSE, the functions QDomNode::prefix(), QDomNode::localName() and QDomNode::namespaceURI() return QString::null. +.PP +See also QDomNode::namespaceURI(), QDomNode::localName(), QDomNode::prefix(), QString::isNull(), and QString::isEmpty(). +.SH "bool QDomDocument::setContent ( const QCString & buffer, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the C string \fIbuffer\fR. +.PP +\fBWarning:\fR This function does not try to detect the encoding: instead it assumes that the C string is UTF-8 encoded. +.SH "bool QDomDocument::setContent ( const QString & text, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the string \fItext\fR. Since \fItext\fR is already a Unicode string, no encoding detection is done. +.SH "bool QDomDocument::setContent ( QIODevice * dev, bool namespaceProcessing, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the IO device \fIdev\fR. +.SH "bool QDomDocument::setContent ( const QCString & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the C string \fIbuffer\fR. +.PP +No namespace processing is performed. +.PP +\fBWarning:\fR This function does not try to detect the encoding: instead it assumes that the C string is UTF-8 encoded. +.SH "bool QDomDocument::setContent ( const QByteArray & buffer, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the byte array \fIbuffer\fR. +.PP +No namespace processing is performed. +.SH "bool QDomDocument::setContent ( const QString & text, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the string \fItext\fR. Since \fItext\fR is already a Unicode string, no encoding detection is performed. +.PP +No namespace processing is performed either. +.SH "bool QDomDocument::setContent ( QIODevice * dev, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the IO device \fIdev\fR. +.PP +No namespace processing is performed. +.SH "bool QDomDocument::setContent ( QXmlInputSource * source, QXmlReader * reader, QString * errorMsg = 0, int * errorLine = 0, int * errorColumn = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function reads the XML document from the QXmlInputSource \fIsource\fR and parses it with the QXmlReader \fIreader\fR. +.PP +This function doesn't change the features of the \fIreader\fR. If you want to use certain features for parsing you can use this function to set up the reader appropriate. +.PP +See also QXmlSimpleReader. +.SH "QCString QDomDocument::toCString () const" +Converts the parsed document back to its textual representation and returns a QCString for that is encoded in UTF-8. +.PP +See also toString(). +.SH "QCString QDomDocument::toCString ( int indent ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses \fIindent\fR as the amount of space to indent subelements. +.SH "QString QDomDocument::toString () const" +Converts the parsed document back to its textual representation. +.PP +See also toCString(). +.SH "QString QDomDocument::toString ( int indent ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function uses \fIindent\fR as the amount of space to indent +subelements. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomdocument.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomdocument.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomdocumentfragment.3qt b/doc/man/man3/tqdomdocumentfragment.3qt new file mode 100644 index 000000000..ebfd17ec7 --- /dev/null +++ b/doc/man/man3/tqdomdocumentfragment.3qt @@ -0,0 +1,100 @@ +'\" t +.TH QDomDocumentFragment 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 +QDomDocumentFragment \- Tree of QDomNodes which is not usually a complete QDomDocument +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomDocumentFragment\fR ()" +.br +.ti -1c +.BI "\fBQDomDocumentFragment\fR ( const QDomDocumentFragment & x )" +.br +.ti -1c +.BI "QDomDocumentFragment & \fBoperator=\fR ( const QDomDocumentFragment & x )" +.br +.ti -1c +.BI "\fB~QDomDocumentFragment\fR ()" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisDocumentFragment\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomDocumentFragment class is a tree of QDomNodes which is not usually a complete QDomDocument. +.PP +If you want to do complex tree operations it is useful to have a lightweight class to store nodes and their relations. QDomDocumentFragment stores a subtree of a document which does not necessarily represent a well-formed XML document. +.PP +QDomDocumentFragment is also useful if you want to group several nodes in a list and insert them all together as children of some node. In these cases QDomDocumentFragment can be used as a temporary container for this list of children. +.PP +The most important feature of QDomDocumentFragment is that it is treated in a special way by QDomNode::insertAfter(), QDomNode::insertBefore(), QDomNode::replaceChild() and QDomNode::appendChild(): instead of inserting the fragment itself, all the fragment's children are inserted. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomDocumentFragment::QDomDocumentFragment ()" +Constructs an empty document fragment. +.SH "QDomDocumentFragment::QDomDocumentFragment ( const QDomDocumentFragment & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomDocumentFragment::~QDomDocumentFragment ()" +Destroys the object and frees its resources. +.SH "bool QDomDocumentFragment::isDocumentFragment () const\fC [virtual]\fR" +This function reimplements QDomNode::isDocumentFragment(). +.PP +See also nodeType() and QDomNode::toDocumentFragment(). +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomDocumentFragment::nodeType () const\fC [virtual]\fR" +Returns \fCDocumentFragment\fR. +.PP +See also isDocumentFragment() and QDomNode::toDocumentFragment(). +.PP +Reimplemented from QDomNode. +.SH "QDomDocumentFragment & QDomDocumentFragment::operator= ( const QDomDocumentFragment & x )" +Assigns \fIx\fR to this DOM document fragment. +.PP +The data of the copy is shared (shallow copy): modifying one node +will also change the other. If you want to make a deep copy, use +cloneNode(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomdocumentfragment.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomdocumentfragment.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomdocumenttype.3qt b/doc/man/man3/tqdomdocumenttype.3qt new file mode 100644 index 000000000..1729131e4 --- /dev/null +++ b/doc/man/man3/tqdomdocumenttype.3qt @@ -0,0 +1,132 @@ +'\" t +.TH QDomDocumentType 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 +QDomDocumentType \- The representation of the DTD in the document tree +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomDocumentType\fR ()" +.br +.ti -1c +.BI "\fBQDomDocumentType\fR ( const QDomDocumentType & n )" +.br +.ti -1c +.BI "QDomDocumentType & \fBoperator=\fR ( const QDomDocumentType & n )" +.br +.ti -1c +.BI "\fB~QDomDocumentType\fR ()" +.br +.ti -1c +.BI "virtual QString \fBname\fR () const" +.br +.ti -1c +.BI "virtual QDomNamedNodeMap \fBentities\fR () const" +.br +.ti -1c +.BI "virtual QDomNamedNodeMap \fBnotations\fR () const" +.br +.ti -1c +.BI "virtual QString \fBpublicId\fR () const" +.br +.ti -1c +.BI "virtual QString \fBsystemId\fR () const" +.br +.ti -1c +.BI "virtual QString \fBinternalSubset\fR () const" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisDocumentType\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomDocumentType class is the representation of the DTD in the document tree. +.PP +The QDomDocumentType class allows read-only access to some of the data structures in the DTD: it can return a map of all entities() and notations(). In addition the function name() returns the name of the document type as specified in the <!DOCTYPE name> tag. This class also provides the publicId(), systemId() and internalSubset() functions. +.PP +See also QDomDocument and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomDocumentType::QDomDocumentType ()" +Creates an empty QDomDocumentType object. +.SH "QDomDocumentType::QDomDocumentType ( const QDomDocumentType & n )" +Constructs a copy of \fIn\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomDocumentType::~QDomDocumentType ()" +Destroys the object and frees its resources. +.SH "QDomNamedNodeMap QDomDocumentType::entities () const\fC [virtual]\fR" +Returns a map of all entities described in the DTD. +.SH "QString QDomDocumentType::internalSubset () const\fC [virtual]\fR" +Returns the internal subset of the document type or QString::null if there is no internal subset. +.PP +See also publicId() and systemId(). +.SH "bool QDomDocumentType::isDocumentType () const\fC [virtual]\fR" +This function overloads QDomNode::isDocumentType(). +.PP +See also nodeType() and QDomNode::toDocumentType(). +.PP +Reimplemented from QDomNode. +.SH "QString QDomDocumentType::name () const\fC [virtual]\fR" +Returns the name of the document type as specified in the <!DOCTYPE name> tag. +.PP +See also nodeName(). +.SH "QDomNode::NodeType QDomDocumentType::nodeType () const\fC [virtual]\fR" +Returns DocumentTypeNode. +.PP +See also isDocumentType() and QDomNode::toDocumentType(). +.PP +Reimplemented from QDomNode. +.SH "QDomNamedNodeMap QDomDocumentType::notations () const\fC [virtual]\fR" +Returns a map of all notations described in the DTD. +.SH "QDomDocumentType & QDomDocumentType::operator= ( const QDomDocumentType & n )" +Assigns \fIn\fR to this document type. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QString QDomDocumentType::publicId () const\fC [virtual]\fR" +Returns the public identifier of the external DTD subset or QString::null if there is no public identifier. +.PP +See also systemId(), internalSubset(), and QDomImplementation::createDocumentType(). +.SH "QString QDomDocumentType::systemId () const\fC [virtual]\fR" +Returns the system identifier of the external DTD subset or QString::null if there is no system identifier. +.PP +See also publicId(), internalSubset(), and QDomImplementation::createDocumentType(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomdocumenttype.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomdocumenttype.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomelement.3qt b/doc/man/man3/tqdomelement.3qt new file mode 100644 index 000000000..7e8aa7c5c --- /dev/null +++ b/doc/man/man3/tqdomelement.3qt @@ -0,0 +1,335 @@ +'\" t +.TH QDomElement 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 +QDomElement \- Represents one element in the DOM tree +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomElement\fR ()" +.br +.ti -1c +.BI "\fBQDomElement\fR ( const QDomElement & x )" +.br +.ti -1c +.BI "QDomElement & \fBoperator=\fR ( const QDomElement & x )" +.br +.ti -1c +.BI "\fB~QDomElement\fR ()" +.br +.ti -1c +.BI "QString \fBattribute\fR ( const QString & name, const QString & defValue = QString::null ) const" +.br +.ti -1c +.BI "void \fBsetAttribute\fR ( const QString & name, const QString & value )" +.br +.ti -1c +.BI "void \fBsetAttribute\fR ( const QString & name, int value )" +.br +.ti -1c +.BI "void \fBsetAttribute\fR ( const QString & name, uint value )" +.br +.ti -1c +.BI "void \fBsetAttribute\fR ( const QString & name, long value )" +.br +.ti -1c +.BI "void \fBsetAttribute\fR ( const QString & name, ulong value )" +.br +.ti -1c +.BI "void \fBsetAttribute\fR ( const QString & name, double value )" +.br +.ti -1c +.BI "void \fBremoveAttribute\fR ( const QString & name )" +.br +.ti -1c +.BI "QDomAttr \fBattributeNode\fR ( const QString & name )" +.br +.ti -1c +.BI "QDomAttr \fBsetAttributeNode\fR ( const QDomAttr & newAttr )" +.br +.ti -1c +.BI "QDomAttr \fBremoveAttributeNode\fR ( const QDomAttr & oldAttr )" +.br +.ti -1c +.BI "virtual QDomNodeList \fBelementsByTagName\fR ( const QString & tagname ) const" +.br +.ti -1c +.BI "bool \fBhasAttribute\fR ( const QString & name ) const" +.br +.ti -1c +.BI "QString \fBattributeNS\fR ( const QString nsURI, const QString & localName, const QString & defValue ) const" +.br +.ti -1c +.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, const QString & value )" +.br +.ti -1c +.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, int value )" +.br +.ti -1c +.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, uint value )" +.br +.ti -1c +.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, long value )" +.br +.ti -1c +.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, ulong value )" +.br +.ti -1c +.BI "void \fBsetAttributeNS\fR ( const QString nsURI, const QString & qName, double value )" +.br +.ti -1c +.BI "void \fBremoveAttributeNS\fR ( const QString & nsURI, const QString & localName )" +.br +.ti -1c +.BI "QDomAttr \fBattributeNodeNS\fR ( const QString & nsURI, const QString & localName )" +.br +.ti -1c +.BI "QDomAttr \fBsetAttributeNodeNS\fR ( const QDomAttr & newAttr )" +.br +.ti -1c +.BI "virtual QDomNodeList \fBelementsByTagNameNS\fR ( const QString & nsURI, const QString & localName ) const" +.br +.ti -1c +.BI "bool \fBhasAttributeNS\fR ( const QString & nsURI, const QString & localName ) const" +.br +.ti -1c +.BI "QString \fBtagName\fR () const" +.br +.ti -1c +.BI "void \fBsetTagName\fR ( const QString & name )" +.br +.ti -1c +.BI "virtual QDomNamedNodeMap \fBattributes\fR () const" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisElement\fR () const" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomElement class represents one element in the DOM tree. +.PP +Elements have a tagName() and zero or more attributes associated with them. The tag name can be changed with setTagName(). +.PP +Element attributes are represented by QDomAttr objects that can be queried using the attribute() and attributeNode() functions. You can set attributes with the setAttribute() and setAttributeNode() functions. Attributes can be removed with removeAttribute(). There are namespace-aware equivalents to these functions, i.e. setAttributeNS(), setAttributeNodeNS() and removeAttributeNS(). +.PP +If you want to access the text of a node use text(), e.g. +.PP +.nf +.br + QDomElement e = //... +.br + //... +.br + QString s = e.text() +.br +.fi +The text() function operates recursively to find the text (since not all elements contain text). If you want to find all the text in all of a node's children, iterate over the children looking for QDomText nodes, e.g. +.PP +.nf +.br + QString text; +.br + QDomElement element = doc.documentElement(); +.br + for( QDomNode n = element.firstChild(); !n.isNull(); n = n.nextSibling() ) +.br + { +.br + QDomText t = n.toText(); +.br + if ( !t.isNull() ) +.br + text += t.data(); +.br + } +.br +.fi +Note that we attempt to convert each node to a text node and use text() rather than using firstChild().toText().data() or n.toText().data() directly on the node, because the node may not be a text element. +.PP +You can get a list of all the decendents of an element which have a specified tag name with elementsByTagName() or elementsByTagNameNS(). +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomElement::QDomElement ()" +Constructs an empty element. Use the QDomDocument::createElement() function to construct elements with content. +.SH "QDomElement::QDomElement ( const QDomElement & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomElement::~QDomElement ()" +Destroys the object and frees its resources. +.SH "QString QDomElement::attribute ( const QString & name, const QString & defValue = QString::null ) const" +Returns the attribute called \fIname\fR. If the attribute does not exist \fIdefValue\fR is returned. +.PP +See also setAttribute(), attributeNode(), setAttributeNode(), and attributeNS(). +.SH "QString QDomElement::attributeNS ( const QString nsURI, const QString & localName, const QString & defValue ) const" +Returns the attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. If the attribute does not exist \fIdefValue\fR is returned. +.PP +See also setAttributeNS(), attributeNodeNS(), setAttributeNodeNS(), and attribute(). +.SH "QDomAttr QDomElement::attributeNode ( const QString & name )" +Returns the QDomAttr object that corresponds to the attribute called \fIname\fR. If no such attribute exists a null attribute is returned. +.PP +See also setAttributeNode(), attribute(), setAttribute(), and attributeNodeNS(). +.SH "QDomAttr QDomElement::attributeNodeNS ( const QString & nsURI, const QString & localName )" +Returns the QDomAttr object that corresponds to the attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. If no such attribute exists a null attribute is returned. +.PP +See also setAttributeNode(), attribute(), and setAttribute(). +.SH "QDomNamedNodeMap QDomElement::attributes () const\fC [virtual]\fR" +Returns a QDomNamedNodeMap containing all this element's attributes. +.PP +See also attribute(), setAttribute(), attributeNode(), and setAttributeNode(). +.PP +Reimplemented from QDomNode. +.SH "QDomNodeList QDomElement::elementsByTagName ( const QString & tagname ) const\fC [virtual]\fR" +Returns a QDomNodeList containing all descendent elements of this element that are called \fItagname\fR. The order they are in the node list is the order they are encountered in a preorder traversal of the element tree. +.PP +See also elementsByTagNameNS() and QDomDocument::elementsByTagName(). +.SH "QDomNodeList QDomElement::elementsByTagNameNS ( const QString & nsURI, const QString & localName ) const\fC [virtual]\fR" +Returns a QDomNodeList containing all the descendent elements of this element with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. The order they are in the node list is the order they are encountered in a preorder traversal of the element tree. +.PP +See also elementsByTagName() and QDomDocument::elementsByTagNameNS(). +.SH "bool QDomElement::hasAttribute ( const QString & name ) const" +Returns TRUE if this element has an attribute called \fIname\fR; otherwise returns FALSE. +.SH "bool QDomElement::hasAttributeNS ( const QString & nsURI, const QString & localName ) const" +Returns TRUE if this element has an attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR; otherwise returns FALSE. +.SH "bool QDomElement::isElement () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomElement::nodeType () const\fC [virtual]\fR" +Returns ElementNode. +.PP +Reimplemented from QDomNode. +.SH "QDomElement & QDomElement::operator= ( const QDomElement & x )" +Assigns \fIx\fR to this DOM element. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "void QDomElement::removeAttribute ( const QString & name )" +Removes the attribute called name \fIname\fR from this element. +.PP +See also setAttribute(), attribute(), and removeAttributeNS(). +.SH "void QDomElement::removeAttributeNS ( const QString & nsURI, const QString & localName )" +Removes the attribute with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR from this element. +.PP +See also setAttributeNS(), attributeNS(), and removeAttribute(). +.SH "QDomAttr QDomElement::removeAttributeNode ( const QDomAttr & oldAttr )" +Removes the attribute \fIoldAttr\fR from the element and returns it. +.PP +See also attributeNode() and setAttributeNode(). +.SH "void QDomElement::setAttribute ( const QString & name, const QString & value )" +Adds an attribute called \fIname\fR with value \fIvalue\fR. If an attribute with the same name exists, its value is replaced by \fIvalue\fR. +.PP +See also attribute(), setAttributeNode(), and setAttributeNS(). +.SH "void QDomElement::setAttribute ( const QString & name, int value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttribute ( const QString & name, uint value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttribute ( const QString & name, long value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttribute ( const QString & name, ulong value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttribute ( const QString & name, double value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, const QString & value )" +Adds an attribute with the qualified name \fIqName\fR and the namespace URI \fInsURI\fR with the value \fIvalue\fR. If an attribute with the same local name and namespace URI exists, its prefix is replaced by the prefix of \fIqName\fR and its value is repaced by \fIvalue\fR. +.PP +Although \fIqName\fR is the qualified name, the local name is used to decide if an existing attribute's value should be replaced. +.PP +See also attributeNS(), setAttributeNodeNS(), and setAttribute(). +.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, int value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, uint value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, long value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, ulong value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, double value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QDomAttr QDomElement::setAttributeNode ( const QDomAttr & newAttr )" +Adds the attribute \fInewAttr\fR to this element. +.PP +If the element has another attribute that has the same name as \fInewAttr\fR, this function replaces that attribute and returns it; otherwise the function returns a null attribute. +.PP +See also attributeNode(), setAttribute(), and setAttributeNodeNS(). +.SH "QDomAttr QDomElement::setAttributeNodeNS ( const QDomAttr & newAttr )" +Adds the attribute \fInewAttr\fR to this element. +.PP +If the element has another attribute that has the same local name and namespace URI as \fInewAttr\fR, this function replaces that attribute and returns it; otherwise the function returns a null attribute. +.PP +See also attributeNodeNS(), setAttributeNS(), and setAttributeNode(). +.SH "void QDomElement::setTagName ( const QString & name )" +Sets this element's tag name to \fIname\fR. +.PP +See also tagName(). +.SH "QString QDomElement::tagName () const" +Returns the tag name of this element. For an XML element like this: +.PP +.nf +.br + <img src="myimg.png"> +.br +.fi +the tagname would return "img". +.PP +See also setTagName(). +.SH "QString QDomElement::text () const" +Returns the element's text or QString::null. +.PP +Example: +.PP +.nf +.br + <h1>Hello <b>Qt</b> <![CDATA[<xml is cool>]]></h1> +.br +.fi +.PP +The function text() of the QDomElement for the <h1> tag, will return "Hello Qt <xml is cool>". +.PP +Comments are ignored by this function. It only evaluates QDomText +and QDomCDATASection objects. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomelement.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomelement.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomentity.3qt b/doc/man/man3/tqdomentity.3qt new file mode 100644 index 000000000..00835d1c8 --- /dev/null +++ b/doc/man/man3/tqdomentity.3qt @@ -0,0 +1,114 @@ +'\" t +.TH QDomEntity 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 +QDomEntity \- Represents an XML entity +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomEntity\fR ()" +.br +.ti -1c +.BI "\fBQDomEntity\fR ( const QDomEntity & x )" +.br +.ti -1c +.BI "QDomEntity & \fBoperator=\fR ( const QDomEntity & x )" +.br +.ti -1c +.BI "\fB~QDomEntity\fR ()" +.br +.ti -1c +.BI "virtual QString \fBpublicId\fR () const" +.br +.ti -1c +.BI "virtual QString \fBsystemId\fR () const" +.br +.ti -1c +.BI "virtual QString \fBnotationName\fR () const" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisEntity\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomEntity class represents an XML entity. +.PP +This class represents an entity in an XML document, either parsed or unparsed. Note that this models the entity itself not the entity declaration. +.PP +DOM does not support editing entity nodes; if a user wants to make changes to the contents of an entity, every related QDomEntityReference node must be replaced in the DOM tree by a clone of the entity's contents, and then the desired changes must be made to each of the clones instead. All the descendents of an entity node are read-only. +.PP +An entity node does not have any parent. +.PP +You can access the entity's publicId(), systemId() and notationName() when available. +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomEntity::QDomEntity ()" +Constructs an empty entity. +.SH "QDomEntity::QDomEntity ( const QDomEntity & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomEntity::~QDomEntity ()" +Destroys the object and frees its resources. +.SH "bool QDomEntity::isEntity () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomEntity::nodeType () const\fC [virtual]\fR" +Returns EntityNode. +.PP +Reimplemented from QDomNode. +.SH "QString QDomEntity::notationName () const\fC [virtual]\fR" +For unparsed entities this function returns the name of the notation for the entity. For parsed entities this function returns QString::null. +.SH "QDomEntity & QDomEntity::operator= ( const QDomEntity & x )" +Assigns \fIx\fR to this DOM entity. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QString QDomEntity::publicId () const\fC [virtual]\fR" +Returns the public identifier associated with this entity. If the public identifier was not specified QString::null is returned. +.SH "QString QDomEntity::systemId () const\fC [virtual]\fR" +Returns the system identifier associated with this entity. If the +system identifier was not specified QString::null is returned. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomentity.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomentity.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomentityreference.3qt b/doc/man/man3/tqdomentityreference.3qt new file mode 100644 index 000000000..256ee28ce --- /dev/null +++ b/doc/man/man3/tqdomentityreference.3qt @@ -0,0 +1,100 @@ +'\" t +.TH QDomEntityReference 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 +QDomEntityReference \- Represents an XML entity reference +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomEntityReference\fR ()" +.br +.ti -1c +.BI "\fBQDomEntityReference\fR ( const QDomEntityReference & x )" +.br +.ti -1c +.BI "QDomEntityReference & \fBoperator=\fR ( const QDomEntityReference & x )" +.br +.ti -1c +.BI "\fB~QDomEntityReference\fR ()" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisEntityReference\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomEntityReference class represents an XML entity reference. +.PP +A QDomEntityReference object may be inserted into the DOM tree when an entity reference is in the source document, or when the user wishes to insert an entity reference. +.PP +Note that character references and references to predefined entities are expanded by the XML processor so that characters are represented by their Unicode equivalent rather than by an entity reference. +.PP +Moreover, the XML processor may completely expand references to entities while building the DOM tree, instead of providing QDomEntityReference objects. +.PP +If it does provide such objects, then for a given entity reference node, it may be that there is no entity node representing the referenced entity; but if such an entity exists, then the child list of the entity reference node is the same as that of the entity node. As with the entity node, all descendents of the entity reference are read-only. +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomEntityReference::QDomEntityReference ()" +Constructs an empty entity reference. Use QDomDocument::createEntityReference() to create a entity reference with content. +.SH "QDomEntityReference::QDomEntityReference ( const QDomEntityReference & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomEntityReference::~QDomEntityReference ()" +Destroys the object and frees its resources. +.SH "bool QDomEntityReference::isEntityReference () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomEntityReference::nodeType () const\fC [virtual]\fR" +Returns \fCEntityReference\fR. +.PP +Reimplemented from QDomNode. +.SH "QDomEntityReference & QDomEntityReference::operator= ( const QDomEntityReference & x )" +Assigns \fIx\fR to this entity reference. +.PP +The data of the copy is shared (shallow copy): modifying one node +will also change the other. If you want to make a deep copy, use +cloneNode(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomentityreference.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomentityreference.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomimplementation.3qt b/doc/man/man3/tqdomimplementation.3qt new file mode 100644 index 000000000..24e2a6b7f --- /dev/null +++ b/doc/man/man3/tqdomimplementation.3qt @@ -0,0 +1,126 @@ +'\" t +.TH QDomImplementation 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 +QDomImplementation \- Information about the features of the DOM implementation +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomImplementation\fR ()" +.br +.ti -1c +.BI "\fBQDomImplementation\fR ( const QDomImplementation & x )" +.br +.ti -1c +.BI "virtual \fB~QDomImplementation\fR ()" +.br +.ti -1c +.BI "QDomImplementation & \fBoperator=\fR ( const QDomImplementation & x )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QDomImplementation & x ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QDomImplementation & x ) const" +.br +.ti -1c +.BI "virtual bool \fBhasFeature\fR ( const QString & feature, const QString & version )" +.br +.ti -1c +.BI "virtual QDomDocumentType \fBcreateDocumentType\fR ( const QString & qName, const QString & publicId, const QString & systemId )" +.br +.ti -1c +.BI "virtual QDomDocument \fBcreateDocument\fR ( const QString & nsURI, const QString & qName, const QDomDocumentType & doctype )" +.br +.ti -1c +.BI "bool \fBisNull\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QDomImplementation class provides information about the features of the DOM implementation. +.PP +This class describes the features that are supported by the DOM implementation. Currently the XML subset of DOM Level 1 and DOM Level 2 Core are supported. +.PP +Normally you will use the function QDomDocument::implementation() to get the implementation object. +.PP +You can create a new document type with createDocumentType() and a new document with createDocument(). +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also hasFeature() and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomImplementation::QDomImplementation ()" +Constructs a QDomImplementation object. +.SH "QDomImplementation::QDomImplementation ( const QDomImplementation & x )" +Constructs a copy of \fIx\fR. +.SH "QDomImplementation::~QDomImplementation ()\fC [virtual]\fR" +Destroys the object and frees its resources. +.SH "QDomDocument QDomImplementation::createDocument ( const QString & nsURI, const QString & qName, const QDomDocumentType & doctype )\fC [virtual]\fR" +Creates a DOM document with the document type \fIdoctype\fR. This function also adds a root element node with the qualified name \fIqName\fR and the namespace URI \fInsURI\fR. +.SH "QDomDocumentType QDomImplementation::createDocumentType ( const QString & qName, const QString & publicId, const QString & systemId )\fC [virtual]\fR" +Creates a document type node for the name \fIqName\fR. +.PP +\fIpublicId\fR specifies the public identifier of the external subset. If you specify QString::null as the \fIpublicId\fR, this means that the document type has no public identifier. +.PP +\fIsystemId\fR specifies the system identifier of the external subset. If you specify QString::null as the \fIsystemId\fR, this means that the document type has no system identifier. +.PP +Since you cannot have a public identifier without a system identifier, the public identifier is set to QString::null if there is no system identifier. +.PP +DOM level 2 does not support any other document type declaration features. +.PP +The only way you can use a document type that was created this way, is in combination with the createDocument() function to create a QDomDocument with this document type. +.PP +See also createDocument(). +.SH "bool QDomImplementation::hasFeature ( const QString & feature, const QString & version )\fC [virtual]\fR" +The function returns TRUE if QDom implements the requested \fIversion\fR of a \fIfeature\fR; otherwise returns FALSE. +.PP +The currently supported features and their versions: <center>.nf +.TS +l - l. Feature Version XML +.TE +.fi +</center> +.SH "bool QDomImplementation::isNull ()" +Returns FALSE if the object was created by QDomDocument::implementation(); otherwise returns TRUE. +.SH "bool QDomImplementation::operator!= ( const QDomImplementation & x ) const" +Returns TRUE if \fIx\fR and this DOM implementation object were created from different QDomDocuments; otherwise returns FALSE. +.SH "QDomImplementation & QDomImplementation::operator= ( const QDomImplementation & x )" +Assigns \fIx\fR to this DOM implementation. +.SH "bool QDomImplementation::operator== ( const QDomImplementation & x ) const" +Returns TRUE if \fIx\fR and this DOM implementation object were +created from the same QDomDocument; otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomimplementation.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomimplementation.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomnamednodemap.3qt b/doc/man/man3/tqdomnamednodemap.3qt new file mode 100644 index 000000000..04ea59635 --- /dev/null +++ b/doc/man/man3/tqdomnamednodemap.3qt @@ -0,0 +1,172 @@ +'\" t +.TH QDomNamedNodeMap 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 +QDomNamedNodeMap \- Collection of nodes that can be accessed by name +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomNamedNodeMap\fR ()" +.br +.ti -1c +.BI "\fBQDomNamedNodeMap\fR ( const QDomNamedNodeMap & n )" +.br +.ti -1c +.BI "QDomNamedNodeMap & \fBoperator=\fR ( const QDomNamedNodeMap & n )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QDomNamedNodeMap & n ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QDomNamedNodeMap & n ) const" +.br +.ti -1c +.BI "\fB~QDomNamedNodeMap\fR ()" +.br +.ti -1c +.BI "QDomNode \fBnamedItem\fR ( const QString & name ) const" +.br +.ti -1c +.BI "QDomNode \fBsetNamedItem\fR ( const QDomNode & newNode )" +.br +.ti -1c +.BI "QDomNode \fBremoveNamedItem\fR ( const QString & name )" +.br +.ti -1c +.BI "QDomNode \fBitem\fR ( int index ) const" +.br +.ti -1c +.BI "QDomNode \fBnamedItemNS\fR ( const QString & nsURI, const QString & localName ) const" +.br +.ti -1c +.BI "QDomNode \fBsetNamedItemNS\fR ( const QDomNode & newNode )" +.br +.ti -1c +.BI "QDomNode \fBremoveNamedItemNS\fR ( const QString & nsURI, const QString & localName )" +.br +.ti -1c +.BI "uint \fBlength\fR () const" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QString & name ) const" +.br +.in -1c +.SH DESCRIPTION +The QDomNamedNodeMap class contains a collection of nodes that can be accessed by name. +.PP +Note that QDomNamedNodeMap does not inherit from QDomNodeList. QDomNamedNodeMaps do not provide any specific node ordering. Although nodes in a QDomNamedNodeMap may be accessed by an ordinal index, this is simply to allow a convenient enumeration of the contents of a QDomNamedNodeMap, and does not imply that the DOM specifies an ordering of the nodes. +.PP +The QDomNamedNodeMap is used in three places: <ol type=1> +.IP 1 +QDomDocumentType::entities() returns a map of all entities described in the DTD. +.IP 2 +QDomDocumentType::notations() returns a map of all notations described in the DTD. +.IP 3 +QDomNode::attributes() returns a map of all attributes of an element. +.PP +Items in the map are identified by the name which QDomNode::name() returns. Nodes are retrieved using namedItem(), namedItemNS() or item(). New nodes are inserted with setNamedItem() or setNamedItemNS() and removed with removeNamedItem() or removeNamedItemNS(). Use contains() to see if an item with the given name is in the named node map. The number of items is returned by length(). +.PP +Terminology: in this class we use "item" and "node" interchangeably. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomNamedNodeMap::QDomNamedNodeMap ()" +Constructs an empty named node map. +.SH "QDomNamedNodeMap::QDomNamedNodeMap ( const QDomNamedNodeMap & n )" +Constructs a copy of \fIn\fR. +.SH "QDomNamedNodeMap::~QDomNamedNodeMap ()" +Destroys the object and frees its resources. +.SH "bool QDomNamedNodeMap::contains ( const QString & name ) const" +Returns TRUE if the map contains a node called \fIname\fR; otherwise returns FALSE. +.SH "uint QDomNamedNodeMap::count () const" +Returns the number of nodes in the map. +.PP +This function is the same as length(). +.SH "QDomNode QDomNamedNodeMap::item ( int index ) const" +Retrieves the node at position \fIindex\fR. +.PP +This can be used to iterate over the map. Note that the nodes in the map are ordered arbitrarily. +.PP +See also length(). +.SH "uint QDomNamedNodeMap::length () const" +Returns the number of nodes in the map. +.PP +See also item(). +.SH "QDomNode QDomNamedNodeMap::namedItem ( const QString & name ) const" +Returns the node called \fIname\fR. +.PP +If the named node map does not contain such a node, a null node is returned. A node's name is the name returned by QDomNode::nodeName(). +.PP +See also setNamedItem() and namedItemNS(). +.SH "QDomNode QDomNamedNodeMap::namedItemNS ( const QString & nsURI, const QString & localName ) const" +Returns the node associated with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. +.PP +If the map does not contain such a node, a null node is returned. +.PP +See also setNamedItemNS() and namedItem(). +.SH "bool QDomNamedNodeMap::operator!= ( const QDomNamedNodeMap & n ) const" +Returns TRUE if \fIn\fR and this named node map are not equal; otherwise returns FALSE. +.SH "QDomNamedNodeMap & QDomNamedNodeMap::operator= ( const QDomNamedNodeMap & n )" +Assigns \fIn\fR to this named node map. +.SH "bool QDomNamedNodeMap::operator== ( const QDomNamedNodeMap & n ) const" +Returns TRUE if \fIn\fR and this named node map are equal; otherwise returns FALSE. +.SH "QDomNode QDomNamedNodeMap::removeNamedItem ( const QString & name )" +Removes the node called \fIname\fR from the map. +.PP +The function returns the removed node or a null node if the map did not contain a node called \fIname\fR. +.PP +See also setNamedItem(), namedItem(), and removeNamedItemNS(). +.SH "QDomNode QDomNamedNodeMap::removeNamedItemNS ( const QString & nsURI, const QString & localName )" +Removes the node with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR from the map. +.PP +The function returns the removed node or a null node if the map did not contain a node with the local name \fIlocalName\fR and the namespace URI \fInsURI\fR. +.PP +See also setNamedItemNS(), namedItemNS(), and removeNamedItem(). +.SH "QDomNode QDomNamedNodeMap::setNamedItem ( const QDomNode & newNode )" +Inserts the node \fInewNode\fR into the named node map. The name used by the map is the node name of \fInewNode\fR as returned by QDomNode::nodeName(). +.PP +If the new node replaces an existing node, i.e. the map contains a node with the same name, the replaced node is returned. +.PP +See also namedItem(), removeNamedItem(), and setNamedItemNS(). +.SH "QDomNode QDomNamedNodeMap::setNamedItemNS ( const QDomNode & newNode )" +Inserts the node \fInewNode\fR in the map. If a node with the same namespace URI and the same local name already exists in the map, it is replaced by \fInewNode\fR. If the new node replaces an existing node, the replaced node is returned. +.PP +See also namedItemNS(), removeNamedItemNS(), and setNamedItem(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomnamednodemap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomnamednodemap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomnode.3qt b/doc/man/man3/tqdomnode.3qt new file mode 100644 index 000000000..c5595b62b --- /dev/null +++ b/doc/man/man3/tqdomnode.3qt @@ -0,0 +1,733 @@ +'\" t +.TH QDomNode 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 +QDomNode \- The base class for all the nodes in a DOM tree +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherited by QDomDocumentType, QDomDocument, QDomDocumentFragment, QDomCharacterData, QDomAttr, QDomElement, QDomNotation, QDomEntity, QDomEntityReference, and QDomProcessingInstruction. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBNodeType\fR { ElementNode = 1, AttributeNode = 2, TextNode = 3, CDATASectionNode = 4, EntityReferenceNode = 5, EntityNode = 6, ProcessingInstructionNode = 7, CommentNode = 8, DocumentNode = 9, DocumentTypeNode = 10, DocumentFragmentNode = 11, NotationNode = 12, BaseNode = 21, CharacterDataNode = 22 }" +.br +.ti -1c +.BI "\fBQDomNode\fR ()" +.br +.ti -1c +.BI "\fBQDomNode\fR ( const QDomNode & n )" +.br +.ti -1c +.BI "QDomNode & \fBoperator=\fR ( const QDomNode & n )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QDomNode & n ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QDomNode & n ) const" +.br +.ti -1c +.BI "virtual \fB~QDomNode\fR ()" +.br +.ti -1c +.BI "virtual QDomNode \fBinsertBefore\fR ( const QDomNode & newChild, const QDomNode & refChild )" +.br +.ti -1c +.BI "virtual QDomNode \fBinsertAfter\fR ( const QDomNode & newChild, const QDomNode & refChild )" +.br +.ti -1c +.BI "virtual QDomNode \fBreplaceChild\fR ( const QDomNode & newChild, const QDomNode & oldChild )" +.br +.ti -1c +.BI "virtual QDomNode \fBremoveChild\fR ( const QDomNode & oldChild )" +.br +.ti -1c +.BI "virtual QDomNode \fBappendChild\fR ( const QDomNode & newChild )" +.br +.ti -1c +.BI "virtual bool \fBhasChildNodes\fR () const" +.br +.ti -1c +.BI "virtual QDomNode \fBcloneNode\fR ( bool deep = TRUE ) const" +.br +.ti -1c +.BI "virtual void \fBnormalize\fR ()" +.br +.ti -1c +.BI "virtual bool \fBisSupported\fR ( const QString & feature, const QString & version ) const" +.br +.ti -1c +.BI "virtual QString \fBnodeName\fR () const" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual QDomNode \fBparentNode\fR () const" +.br +.ti -1c +.BI "virtual QDomNodeList \fBchildNodes\fR () const" +.br +.ti -1c +.BI "virtual QDomNode \fBfirstChild\fR () const" +.br +.ti -1c +.BI "virtual QDomNode \fBlastChild\fR () const" +.br +.ti -1c +.BI "virtual QDomNode \fBpreviousSibling\fR () const" +.br +.ti -1c +.BI "virtual QDomNode \fBnextSibling\fR () const" +.br +.ti -1c +.BI "virtual QDomNamedNodeMap \fBattributes\fR () const" +.br +.ti -1c +.BI "virtual QDomDocument \fBownerDocument\fR () const" +.br +.ti -1c +.BI "virtual QString \fBnamespaceURI\fR () const" +.br +.ti -1c +.BI "virtual QString \fBlocalName\fR () const" +.br +.ti -1c +.BI "virtual bool \fBhasAttributes\fR () const" +.br +.ti -1c +.BI "virtual QString \fBnodeValue\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNodeValue\fR ( const QString & v )" +.br +.ti -1c +.BI "virtual QString \fBprefix\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPrefix\fR ( const QString & pre )" +.br +.ti -1c +.BI "virtual bool \fBisAttr\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisCDATASection\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisDocumentFragment\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisDocument\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisDocumentType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisElement\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisEntityReference\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisText\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisEntity\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisNotation\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisProcessingInstruction\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisCharacterData\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisComment\fR () const" +.br +.ti -1c +.BI "QDomNode \fBnamedItem\fR ( const QString & name ) const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "QDomAttr \fBtoAttr\fR ()" +.br +.ti -1c +.BI "QDomCDATASection \fBtoCDATASection\fR ()" +.br +.ti -1c +.BI "QDomDocumentFragment \fBtoDocumentFragment\fR ()" +.br +.ti -1c +.BI "QDomDocument \fBtoDocument\fR ()" +.br +.ti -1c +.BI "QDomDocumentType \fBtoDocumentType\fR ()" +.br +.ti -1c +.BI "QDomElement \fBtoElement\fR ()" +.br +.ti -1c +.BI "QDomEntityReference \fBtoEntityReference\fR ()" +.br +.ti -1c +.BI "QDomText \fBtoText\fR ()" +.br +.ti -1c +.BI "QDomEntity \fBtoEntity\fR ()" +.br +.ti -1c +.BI "QDomNotation \fBtoNotation\fR ()" +.br +.ti -1c +.BI "QDomProcessingInstruction \fBtoProcessingInstruction\fR ()" +.br +.ti -1c +.BI "QDomCharacterData \fBtoCharacterData\fR ()" +.br +.ti -1c +.BI "QDomComment \fBtoComment\fR ()" +.br +.ti -1c +.BI "void \fBsave\fR ( QTextStream & str, int indent ) const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( QTextStream & str, const QDomNode & node )" +.br +.in -1c +.SH DESCRIPTION +The QDomNode class is the base class for all the nodes in a DOM tree. +.PP +Many functions in the DOM return a QDomNode. +.PP +You can find out the type of a node using isAttr(), isCDATASection(), isDocumentFragment(), isDocument(), isDocumentType(), isElement(), isEntityReference(), isText(), isEntity(), isNotation(), isProcessingInstruction(), isCharacterData() and isComment(). +.PP +A QDomNode can be converted into one of its subclasses using toAttr(), toCDATASection(), toDocumentFragment(), toDocument(), toDocumentType(), toElement(), toEntityReference(), toText(), toEntity(), toNotation(), toProcessingInstruction(), toCharacterData() or toComment(). You can convert a node to a null node with clear(). +.PP +Copies of the QDomNode class share their data using explicit sharing. This means that modifying one node will change all copies. This is especially useful in combination with functions which return a QDomNode, e.g. firstChild(). You can make an independent (deep) copy of the node with cloneNode(). +.PP +Nodes are inserted with insertBefore(), insertAfter() or appendChild(). You can replace one node with another using replaceChild() and remove a node with removeChild(). +.PP +To traverse nodes use firstChild() to get a node's first child (if any), and nextSibling() to traverse. QDomNode also provides lastChild(), previousSibling() and parentNode(). To find the first child node with a particular node name use namedItem(). +.PP +To find out if a node has children use hasChildNodes() and to get a list of all of a node's children use childNodes(). +.PP +The node's name and value (the meaning of which varies depending on its type) is returned by nodeName() and nodeValue() respectively. The node's type is returned by nodeType(). The node's value can be set with setNodeValue(). +.PP +The document to which the node belongs is returned by ownerDocument(). +.PP +Adjacent QDomText nodes can be merged into a single node with normalize(). +.PP +QDomElement nodes have attributes which can be retrieved with attributes(). +.PP +QDomElement and QDomAttr nodes can have namespaces which can be retrieved with namespaceURI(). Their local name is retrieved with localName(), and their prefix with prefix(). The prefix can be set with setPrefix(). +.PP +You can write the XML representation of the node to a text stream with save(). +.PP +The following example looks for the first element in an XML document and prints the names of all the elements that are its direct children. +.PP +.nf +.br + QDomDocument d; +.br + d.setContent( someXML ); +.br + QDomNode n = d.firstChild(); +.br + while ( !n.isNull() ) { +.br + if ( n.isElement() ) { +.br + QDomElement e = n.toElement(); +.br + cout << "Element name: " << e.tagName() << endl; +.br + break; +.br + } +.br + n = n.nextSibling(); +.br + } +.br +.fi +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SS "Member Type Documentation" +.SH "QDomNode::NodeType" +This enum defines the type of the node: +.TP +\fCQDomNode::ElementNode\fR +.TP +\fCQDomNode::AttributeNode\fR +.TP +\fCQDomNode::TextNode\fR +.TP +\fCQDomNode::CDATASectionNode\fR +.TP +\fCQDomNode::EntityReferenceNode\fR +.TP +\fCQDomNode::EntityNode\fR +.TP +\fCQDomNode::ProcessingInstructionNode\fR +.TP +\fCQDomNode::CommentNode\fR +.TP +\fCQDomNode::DocumentNode\fR +.TP +\fCQDomNode::DocumentTypeNode\fR +.TP +\fCQDomNode::DocumentFragmentNode\fR +.TP +\fCQDomNode::NotationNode\fR +.TP +\fCQDomNode::BaseNode\fR - A QDomNode object, i.e. not a QDomNode subclass. +.TP +\fCQDomNode::CharacterDataNode\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomNode::QDomNode ()" +Constructs a null node. +.SH "QDomNode::QDomNode ( const QDomNode & n )" +Constructs a copy of \fIn\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomNode::~QDomNode ()\fC [virtual]\fR" +Destroys the object and frees its resources. +.SH "QDomNode QDomNode::appendChild ( const QDomNode & newChild )\fC [virtual]\fR" +Appends \fInewChild\fR as the node's last child. +.PP +If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. +.PP +If \fInewChild\fR is a QDomDocumentFragment, then the children of the fragment are removed from the fragment and appended. +.PP +Returns a new reference to \fInewChild\fR. +.PP +See also insertBefore(), insertAfter(), replaceChild(), and removeChild(). +.SH "QDomNamedNodeMap QDomNode::attributes () const\fC [virtual]\fR" +Returns a named node map of all attributes. Attributes are only provided for QDomElements. +.PP +Changing the attributes in the map will also change the attributes of this QDomNode. +.PP +Reimplemented in QDomElement. +.SH "QDomNodeList QDomNode::childNodes () const\fC [virtual]\fR" +Returns a list of all direct child nodes. +.PP +Most often you will call this function on a QDomElement object. +.PP +For example, if the XML document looks like this: +.PP +.nf +.br + <body> +.br + <h1>Heading</h1> +.br + <p>Hello <b>you</b></p> +.br + </body> +.br +.fi +Then the list of child nodes for the "body"-element will contain the node created by the <h1> tag and the node created by the <p> tag. +.PP +The nodes in the list are not copied; so changing the nodes in the list will also change the children of this node. +.PP +See also firstChild() and lastChild(). +.SH "void QDomNode::clear ()" +Converts the node into a null node; if it was not a null node before, its type and contents are deleted. +.PP +See also isNull(). +.SH "QDomNode QDomNode::cloneNode ( bool deep = TRUE ) const\fC [virtual]\fR" +Creates a deep (not shallow) copy of the QDomNode. +.PP +If \fIdeep\fR is TRUE, then the cloning is done recursively which means that all the node's children are deep copied too. If \fIdeep\fR is FALSE only the node itself is copied and the copy will have no child nodes. +.SH "QDomNode QDomNode::firstChild () const\fC [virtual]\fR" +Returns the first child of the node. If there is no child node, a null node is returned. Changing the returned node will also change the node in the document tree. +.PP +See also lastChild() and childNodes(). +.PP +Example: xml/outliner/outlinetree.cpp. +.SH "bool QDomNode::hasAttributes () const\fC [virtual]\fR" +Returns TRUE if the node has attributes; otherwise returns FALSE. +.PP +See also attributes(). +.SH "bool QDomNode::hasChildNodes () const\fC [virtual]\fR" +Returns TRUE if the node has one or more children; otherwise returns FALSE. +.SH "QDomNode QDomNode::insertAfter ( const QDomNode & newChild, const QDomNode & refChild )\fC [virtual]\fR" +Inserts the node \fInewChild\fR after the child node \fIrefChild\fR. \fIrefChild\fR must be a direct child of this node. If \fIrefChild\fR is null then \fInewChild\fR is appended as this node's last child. +.PP +If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. +.PP +If \fInewChild\fR is a QDomDocumentFragment, then the children of the fragment are removed from the fragment and inserted after \fIrefChild\fR. +.PP +Returns a new reference to \fInewChild\fR on success or a null node on failure. +.PP +See also insertBefore(), replaceChild(), removeChild(), and appendChild(). +.SH "QDomNode QDomNode::insertBefore ( const QDomNode & newChild, const QDomNode & refChild )\fC [virtual]\fR" +Inserts the node \fInewChild\fR before the child node \fIrefChild\fR. \fIrefChild\fR must be a direct child of this node. If \fIrefChild\fR is null then \fInewChild\fR is inserted as the node's first child. +.PP +If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. +.PP +If \fInewChild\fR is a QDomDocumentFragment, then the children of the fragment are removed from the fragment and inserted before \fIrefChild\fR. +.PP +Returns a new reference to \fInewChild\fR on success or a null node on failure. +.PP +See also insertAfter(), replaceChild(), removeChild(), and appendChild(). +.SH "bool QDomNode::isAttr () const\fC [virtual]\fR" +Returns TRUE if the node is an attribute; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomAttribute; you can get the QDomAttribute with toAttribute(). +.PP +See also toAttr(). +.PP +Reimplemented in QDomAttr. +.SH "bool QDomNode::isCDATASection () const\fC [virtual]\fR" +Returns TRUE if the node is a CDATA section; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomCDATASection; you can get the QDomCDATASection with toCDATASection(). +.PP +See also toCDATASection(). +.PP +Reimplemented in QDomCDATASection. +.SH "bool QDomNode::isCharacterData () const\fC [virtual]\fR" +Returns TRUE if the node is a character data node; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomCharacterData; you can get the QDomCharacterData with toCharacterData(). +.PP +See also toCharacterData(). +.PP +Reimplemented in QDomCharacterData. +.SH "bool QDomNode::isComment () const\fC [virtual]\fR" +Returns TRUE if the node is a comment; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomComment; you can get the QDomComment with toComment(). +.PP +See also toComment(). +.PP +Reimplemented in QDomComment. +.SH "bool QDomNode::isDocument () const\fC [virtual]\fR" +Returns TRUE if the node is a document; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomDocument; you can get the QDomDocument with toDocument(). +.PP +See also toDocument(). +.PP +Reimplemented in QDomDocument. +.SH "bool QDomNode::isDocumentFragment () const\fC [virtual]\fR" +Returns TRUE if the node is a document fragment; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomDocumentFragment; you can get the QDomDocumentFragment with toDocumentFragment(). +.PP +See also toDocumentFragment(). +.PP +Reimplemented in QDomDocumentFragment. +.SH "bool QDomNode::isDocumentType () const\fC [virtual]\fR" +Returns TRUE if the node is a document type; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomDocumentType; you can get the QDomDocumentType with toDocumentType(). +.PP +See also toDocumentType(). +.PP +Reimplemented in QDomDocumentType. +.SH "bool QDomNode::isElement () const\fC [virtual]\fR" +Returns TRUE if the node is an element; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomElement; you can get the QDomElement with toElement(). +.PP +See also toElement(). +.PP +Example: xml/outliner/outlinetree.cpp. +.PP +Reimplemented in QDomElement. +.SH "bool QDomNode::isEntity () const\fC [virtual]\fR" +Returns TRUE if the node is an entity; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomEntity; you can get the QDomEntity with toEntity(). +.PP +See also toEntity(). +.PP +Reimplemented in QDomEntity. +.SH "bool QDomNode::isEntityReference () const\fC [virtual]\fR" +Returns TRUE if the node is an entity reference; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomEntityReference; you can get the QDomEntityReference with toEntityReference(). +.PP +See also toEntityReference(). +.PP +Reimplemented in QDomEntityReference. +.SH "bool QDomNode::isNotation () const\fC [virtual]\fR" +Returns TRUE if the node is a notation; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomNotation; you can get the QDomNotation with toNotation(). +.PP +See also toNotation(). +.PP +Reimplemented in QDomNotation. +.SH "bool QDomNode::isNull () const" +Returns TRUE if this node is null (i.e. if it has no type or contents); otherwise returns FALSE. +.PP +Example: xml/outliner/outlinetree.cpp. +.SH "bool QDomNode::isProcessingInstruction () const\fC [virtual]\fR" +Returns TRUE if the node is a processing instruction; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomProcessingInstruction; you can get the QProcessingInstruction with toProcessingInstruction(). +.PP +See also toProcessingInstruction(). +.PP +Reimplemented in QDomProcessingInstruction. +.SH "bool QDomNode::isSupported ( const QString & feature, const QString & version ) const\fC [virtual]\fR" +Returns TRUE if the DOM implementation implements the feature \fIfeature\fR and this feature is supported by this node in the version \fIversion\fR; otherwise returns FALSE. +.PP +See also QDomImplementation::hasFeature(). +.SH "bool QDomNode::isText () const\fC [virtual]\fR" +Returns TRUE if the node is a text node; otherwise returns FALSE. +.PP +If this function returns TRUE, it does not imply that this object is a QDomText; you can get the QDomText with toText(). +.PP +See also toText(). +.PP +Reimplemented in QDomText. +.SH "QDomNode QDomNode::lastChild () const\fC [virtual]\fR" +Returns the last child of the node. If there is no child node, a null node is returned. Changing the returned node will also change the node in the document tree. +.PP +See also firstChild() and childNodes(). +.SH "QString QDomNode::localName () const\fC [virtual]\fR" +If the node uses namespaces, this function returns the local name of the node; otherwise it returns QString::null. +.PP +Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace must have been specified at creation time; it is not possible to add a namespace afterwards. +.PP +See also prefix(), namespaceURI(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). +.SH "QDomNode QDomNode::namedItem ( const QString & name ) const" +Returns the first direct child node for which nodeName() equals \fIname\fR. +.PP +If no such direct child exists, a null node is returned. +.PP +See also nodeName(). +.SH "QString QDomNode::namespaceURI () const\fC [virtual]\fR" +Returns the namespace URI of this node or QString::null if the node has no namespace URI. +.PP +Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace URI must be specified at creation time and cannot be changed later. +.PP +See also prefix(), localName(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). +.SH "QDomNode QDomNode::nextSibling () const\fC [virtual]\fR" +Returns the next sibling in the document tree. Changing the returned node will also change the node in the document tree. +.PP +If you have XML like this: +.PP +.nf +.br + <h1>Heading</h1> +.br + <p>The text...</p> +.br + <h2>Next heading</h2> +.br +.fi +and this QDomNode represents the <p> tag, nextSibling() will return the node representing the <h2> tag. +.PP +See also previousSibling(). +.PP +Example: xml/outliner/outlinetree.cpp. +.SH "QString QDomNode::nodeName () const\fC [virtual]\fR" +Returns the name of the node. +.PP +The meaning of the name depends on the subclass: <center>.nf +.TS +l - l. Name Meaning QDomAttr The name of the attribute QDomCDATASection The string "#cdata-section" QDomComment The string "#comment" QDomDocument The string "#document" QDomDocumentFragment The string "#document-fragment" QDomDocumentType The name of the document type QDomElement The tag name QDomEntity The name of the entity QDomEntityReference The name of the referenced entity QDomNotation The name of the notation QDomProcessingInstruction The target of the processing instruction QDomText +.TE +.fi +</center> +.PP +See also nodeValue(). +.PP +Example: xml/outliner/outlinetree.cpp. +.SH "QDomNode::NodeType QDomNode::nodeType () const\fC [virtual]\fR" +Returns the type of the node. +.PP +See also toAttr(), toCDATASection(), toDocumentFragment(), toDocument(), toDocumentType(), toElement(), toEntityReference(), toText(), toEntity(), toNotation(), toProcessingInstruction(), toCharacterData(), and toComment(). +.PP +Reimplemented in QDomDocumentType, QDomDocument, QDomDocumentFragment, QDomCharacterData, QDomAttr, QDomElement, QDomNotation, QDomEntity, QDomEntityReference, and QDomProcessingInstruction. +.SH "QString QDomNode::nodeValue () const\fC [virtual]\fR" +Returns the value of the node. +.PP +The meaning of the value depends on the subclass: <center>.nf +.TS +l - l. Name Meaning QDomAttr The attribute value QDomCDATASection The content of the CDATA section QDomComment The comment QDomProcessingInstruction The data of the processing intruction QDomText +.TE +.fi +</center> +.PP +All the other subclasses do not have a node value and will return QString::null. +.PP +See also setNodeValue() and nodeName(). +.PP +Example: xml/outliner/outlinetree.cpp. +.SH "void QDomNode::normalize ()\fC [virtual]\fR" +Calling normalize() on an element converts all its children into a standard form. This means that adjacent QDomText objects will be merged into a single text object (QDomCDATASection nodes are not merged). +.SH "bool QDomNode::operator!= ( const QDomNode & n ) const" +Returns TRUE if \fIn\fR and this DOM node are not equal; otherwise returns FALSE. +.SH "QDomNode & QDomNode::operator= ( const QDomNode & n )" +Assigns a copy of \fIn\fR to this DOM node. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "bool QDomNode::operator== ( const QDomNode & n ) const" +Returns TRUE if \fIn\fR and this DOM node are equal; otherwise returns FALSE. +.SH "QDomDocument QDomNode::ownerDocument () const\fC [virtual]\fR" +Returns the document to which this node belongs. +.SH "QDomNode QDomNode::parentNode () const\fC [virtual]\fR" +Returns the parent node. If this node has no parent, a null node is returned (i.e. a node for which isNull() returns TRUE). +.SH "QString QDomNode::prefix () const\fC [virtual]\fR" +Returns the namespace prefix of the node or QString::null if the node has no namespace prefix. +.PP +Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace prefix must be specified at creation time. If a node was created with a namespace prefix, you can change it later with setPrefix(). +.PP +If you create an element or attribute with QDomDocument::createElement() or QDomDocument::createAttribute(), the prefix will be QString::null. If you use QDomDocument::createElementNS() or QDomDocument::createAttributeNS() instead, the prefix will not be QString::null; but it might be an empty string if the name does not have a prefix. +.PP +See also setPrefix(), localName(), namespaceURI(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). +.SH "QDomNode QDomNode::previousSibling () const\fC [virtual]\fR" +Returns the previous sibling in the document tree. Changing the returned node will also change the node in the document tree. +.PP +For example, if you have XML like this: +.PP +.nf +.br + <h1>Heading</h1> +.br + <p>The text...</p> +.br + <h2>Next heading</h2> +.br +.fi +and this QDomNode represents the <p> tag, previousSibling() will return the node representing the <h1> tag. +.PP +See also nextSibling(). +.SH "QDomNode QDomNode::removeChild ( const QDomNode & oldChild )\fC [virtual]\fR" +Removes \fIoldChild\fR from the list of children. \fIoldChild\fR must be a direct child of this node. +.PP +Returns a new reference to \fIoldChild\fR on success or a null node on failure. +.PP +See also insertBefore(), insertAfter(), replaceChild(), and appendChild(). +.SH "QDomNode QDomNode::replaceChild ( const QDomNode & newChild, const QDomNode & oldChild )\fC [virtual]\fR" +Replaces \fIoldChild\fR with \fInewChild\fR. \fIoldChild\fR must be a direct child of this node. +.PP +If \fInewChild\fR is the child of another node, it is reparented to this node. If \fInewChild\fR is a child of this node, then its position in the list of children is changed. +.PP +If \fInewChild\fR is a QDomDocumentFragment, then \fIoldChild\fR is replaced by all of the children of the fragment. +.PP +Returns a new reference to \fIoldChild\fR on success or a null node an failure. +.PP +See also insertBefore(), insertAfter(), removeChild(), and appendChild(). +.SH "void QDomNode::save ( QTextStream & str, int indent ) const" +Writes the XML representation of the node and all its children to the stream \fIstr\fR. This function uses \fIindent\fR as the amount of space to indent the node. +.SH "void QDomNode::setNodeValue ( const QString & v )\fC [virtual]\fR" +Sets the node's value to \fIv\fR. +.PP +See also nodeValue(). +.SH "void QDomNode::setPrefix ( const QString & pre )\fC [virtual]\fR" +If the node has a namespace prefix, this function changes the namespace prefix of the node to \fIpre\fR. Otherwise this function does nothing. +.PP +Only nodes of type ElementNode or AttributeNode can have namespaces. A namespace prefix must have be specified at creation time; it is not possible to add a namespace prefix afterwards. +.PP +See also prefix(), localName(), namespaceURI(), QDomDocument::createElementNS(), and QDomDocument::createAttributeNS(). +.SH "QDomAttr QDomNode::toAttr ()" +Converts a QDomNode into a QDomAttr. If the node is not an attribute, the returned object will be null. +.PP +See also isAttr(). +.SH "QDomCDATASection QDomNode::toCDATASection ()" +Converts a QDomNode into a QDomCDATASection. If the node is not a CDATA section, the returned object will be null. +.PP +See also isCDATASection(). +.SH "QDomCharacterData QDomNode::toCharacterData ()" +Converts a QDomNode into a QDomCharacterData. If the node is not a character data node the returned object will be null. +.PP +See also isCharacterData(). +.SH "QDomComment QDomNode::toComment ()" +Converts a QDomNode into a QDomComment. If the node is not a comment the returned object will be null. +.PP +See also isComment(). +.SH "QDomDocument QDomNode::toDocument ()" +Converts a QDomNode into a QDomDocument. If the node is not a document the returned object will be null. +.PP +See also isDocument(). +.SH "QDomDocumentFragment QDomNode::toDocumentFragment ()" +Converts a QDomNode into a QDomDocumentFragment. If the node is not a document fragment the returned object will be null. +.PP +See also isDocumentFragment(). +.SH "QDomDocumentType QDomNode::toDocumentType ()" +Converts a QDomNode into a QDomDocumentType. If the node is not a document type the returned object will be null. +.PP +See also isDocumentType(). +.SH "QDomElement QDomNode::toElement ()" +Converts a QDomNode into a QDomElement. If the node is not an element the returned object will be null. +.PP +See also isElement(). +.PP +Example: xml/outliner/outlinetree.cpp. +.SH "QDomEntity QDomNode::toEntity ()" +Converts a QDomNode into a QDomEntity. If the node is not an entity the returned object will be null. +.PP +See also isEntity(). +.SH "QDomEntityReference QDomNode::toEntityReference ()" +Converts a QDomNode into a QDomEntityReference. If the node is not an entity reference, the returned object will be null. +.PP +See also isEntityReference(). +.SH "QDomNotation QDomNode::toNotation ()" +Converts a QDomNode into a QDomNotation. If the node is not a notation the returned object will be null. +.PP +See also isNotation(). +.SH "QDomProcessingInstruction QDomNode::toProcessingInstruction ()" +Converts a QDomNode into a QDomProcessingInstruction. If the node is not a processing instruction the returned object will be null. +.PP +See also isProcessingInstruction(). +.SH "QDomText QDomNode::toText ()" +Converts a QDomNode into a QDomText. If the node is not a text, the returned object will be null. +.PP +See also isText(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QTextStream & operator<< ( QTextStream & str, const QDomNode & node )" +Writes the XML representation of the node \fInode\fR and all its +children to the stream \fIstr\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomnode.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomnode.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomnodelist.3qt b/doc/man/man3/tqdomnodelist.3qt new file mode 100644 index 000000000..08970e3be --- /dev/null +++ b/doc/man/man3/tqdomnodelist.3qt @@ -0,0 +1,108 @@ +'\" t +.TH QDomNodeList 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 +QDomNodeList \- List of QDomNode objects +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomNodeList\fR ()" +.br +.ti -1c +.BI "\fBQDomNodeList\fR ( const QDomNodeList & n )" +.br +.ti -1c +.BI "QDomNodeList & \fBoperator=\fR ( const QDomNodeList & n )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QDomNodeList & n ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QDomNodeList & n ) const" +.br +.ti -1c +.BI "virtual \fB~QDomNodeList\fR ()" +.br +.ti -1c +.BI "virtual QDomNode \fBitem\fR ( int index ) const" +.br +.ti -1c +.BI "virtual uint \fBlength\fR () const" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomNodeList class is a list of QDomNode objects. +.PP +Lists can be obtained by QDomDocument::elementsByTagName() and QDomNode::childNodes(). The Document Object Model (DOM) requires these lists to be "live": whenever you change the underlying document, the contents of the list will get updated. +.PP +You can get a particular node from the list with item(). The number of items in the list is returned by count() (and by length()). +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also QDomNode::childNodes(), QDomDocument::elementsByTagName(), and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomNodeList::QDomNodeList ()" +Creates an empty node list. +.SH "QDomNodeList::QDomNodeList ( const QDomNodeList & n )" +Constructs a copy of \fIn\fR. +.SH "QDomNodeList::~QDomNodeList ()\fC [virtual]\fR" +Destroys the object and frees its resources. +.SH "uint QDomNodeList::count () const" +Returns the number of nodes in the list. +.PP +This function is the same as length(). +.SH "QDomNode QDomNodeList::item ( int index ) const\fC [virtual]\fR" +Returns the node at position \fIindex\fR. +.PP +If \fIindex\fR is negative or if \fIindex\fR >= length() then a null node is returned (i.e. a node for which QDomNode::isNull() returns TRUE). +.PP +See also count(). +.SH "uint QDomNodeList::length () const\fC [virtual]\fR" +Returns the number of nodes in the list. +.PP +This function is the same as count(). +.SH "bool QDomNodeList::operator!= ( const QDomNodeList & n ) const" +Returns TRUE the node list \fIn\fR and this node list are not equal; otherwise returns FALSE. +.SH "QDomNodeList & QDomNodeList::operator= ( const QDomNodeList & n )" +Assigns \fIn\fR to this node list. +.SH "bool QDomNodeList::operator== ( const QDomNodeList & n ) const" +Returns TRUE if the node list \fIn\fR and this node list are equal; +otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomnodelist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomnodelist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomnotation.3qt b/doc/man/man3/tqdomnotation.3qt new file mode 100644 index 000000000..cc30ce86a --- /dev/null +++ b/doc/man/man3/tqdomnotation.3qt @@ -0,0 +1,108 @@ +'\" t +.TH QDomNotation 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 +QDomNotation \- Represents an XML notation +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomNotation\fR ()" +.br +.ti -1c +.BI "\fBQDomNotation\fR ( const QDomNotation & x )" +.br +.ti -1c +.BI "QDomNotation & \fBoperator=\fR ( const QDomNotation & x )" +.br +.ti -1c +.BI "\fB~QDomNotation\fR ()" +.br +.ti -1c +.BI "QString \fBpublicId\fR () const" +.br +.ti -1c +.BI "QString \fBsystemId\fR () const" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisNotation\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomNotation class represents an XML notation. +.PP +A notation either declares, by name, the format of an unparsed entity (see section 4.7 of the XML 1.0 specification), or is used for formal declaration of processing instruction targets (see section 2.6 of the XML 1.0 specification). +.PP +DOM does not support editing notation nodes; they are therefore read-only. +.PP +A notation node does not have any parent. +.PP +You can retrieve the publicId() and systemId() from a notation node. +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomNotation::QDomNotation ()" +Constructor. +.SH "QDomNotation::QDomNotation ( const QDomNotation & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomNotation::~QDomNotation ()" +Destroys the object and frees its resources. +.SH "bool QDomNotation::isNotation () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomNotation::nodeType () const\fC [virtual]\fR" +Returns NotationNode. +.PP +Reimplemented from QDomNode. +.SH "QDomNotation & QDomNotation::operator= ( const QDomNotation & x )" +Assigns \fIx\fR to this DOM notation. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QString QDomNotation::publicId () const" +Returns the public identifier of this notation. +.SH "QString QDomNotation::systemId () const" +Returns the system identifier of this notation. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomnotation.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomnotation.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomprocessinginstruction.3qt b/doc/man/man3/tqdomprocessinginstruction.3qt new file mode 100644 index 000000000..33f266262 --- /dev/null +++ b/doc/man/man3/tqdomprocessinginstruction.3qt @@ -0,0 +1,115 @@ +'\" t +.TH QDomProcessingInstruction 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 +QDomProcessingInstruction \- Represents an XML processing instruction +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomNode. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomProcessingInstruction\fR ()" +.br +.ti -1c +.BI "\fBQDomProcessingInstruction\fR ( const QDomProcessingInstruction & x )" +.br +.ti -1c +.BI "QDomProcessingInstruction & \fBoperator=\fR ( const QDomProcessingInstruction & x )" +.br +.ti -1c +.BI "\fB~QDomProcessingInstruction\fR ()" +.br +.ti -1c +.BI "virtual QString \fBtarget\fR () const" +.br +.ti -1c +.BI "virtual QString \fBdata\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetData\fR ( const QString & d )" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisProcessingInstruction\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomProcessingInstruction class represents an XML processing instruction. +.PP +Processing instructions are used in XML to keep processor-specific information in the text of the document. +.PP +The content of the processing instruction is retrieved with data() and set with setData(). The processing instruction's target is retrieved with target(). +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomProcessingInstruction::QDomProcessingInstruction ()" +Constructs an empty processing instruction. Use QDomDocument::createProcessingInstruction() to create a processing instruction with content. +.SH "QDomProcessingInstruction::QDomProcessingInstruction ( const QDomProcessingInstruction & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomProcessingInstruction::~QDomProcessingInstruction ()" +Destroys the object and frees its resources. +.SH "QString QDomProcessingInstruction::data () const\fC [virtual]\fR" +Returns the content of this processing instruction. +.PP +See also setData() and target(). +.SH "bool QDomProcessingInstruction::isProcessingInstruction () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomProcessingInstruction::nodeType () const\fC [virtual]\fR" +Returns ProcessingInstructionNode. +.PP +Reimplemented from QDomNode. +.SH "QDomProcessingInstruction & QDomProcessingInstruction::operator= ( const QDomProcessingInstruction & x )" +Assigns \fIx\fR to this processing instruction. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "void QDomProcessingInstruction::setData ( const QString & d )\fC [virtual]\fR" +Sets the data contained in the processing instruction to \fId\fR. +.PP +See also data(). +.SH "QString QDomProcessingInstruction::target () const\fC [virtual]\fR" +Returns the target of this processing instruction. +.PP +See also data(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomprocessinginstruction.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomprocessinginstruction.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdomtext.3qt b/doc/man/man3/tqdomtext.3qt new file mode 100644 index 000000000..f98585f83 --- /dev/null +++ b/doc/man/man3/tqdomtext.3qt @@ -0,0 +1,107 @@ +'\" t +.TH QDomText 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 +QDomText \- Represents text data in the parsed XML document +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdom.h>\fR +.PP +Inherits QDomCharacterData. +.PP +Inherited by QDomCDATASection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDomText\fR ()" +.br +.ti -1c +.BI "\fBQDomText\fR ( const QDomText & x )" +.br +.ti -1c +.BI "QDomText & \fBoperator=\fR ( const QDomText & x )" +.br +.ti -1c +.BI "\fB~QDomText\fR ()" +.br +.ti -1c +.BI "QDomText \fBsplitText\fR ( int offset )" +.br +.ti -1c +.BI "virtual QDomNode::NodeType \fBnodeType\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisText\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QDomText class represents text data in the parsed XML document. +.PP +You can split the text in a QDomText object over two QDomText objecs with splitText(). +.PP +For further information about the Document Object Model see http://www.w3.org/TR/REC-DOM-Level-1/ and http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDomText::QDomText ()" +Constructs an empty QDomText object. +.PP +To construct a QDomText with content, use QDomDocument::createTextNode(). +.SH "QDomText::QDomText ( const QDomText & x )" +Constructs a copy of \fIx\fR. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomText::~QDomText ()" +Destroys the object and frees its resources. +.SH "bool QDomText::isText () const\fC [virtual]\fR" +Returns TRUE. +.PP +Reimplemented from QDomNode. +.SH "QDomNode::NodeType QDomText::nodeType () const\fC [virtual]\fR" +Returns TextNode. +.PP +Reimplemented from QDomCharacterData. +.PP +Reimplemented in QDomCDATASection. +.SH "QDomText & QDomText::operator= ( const QDomText & x )" +Assigns \fIx\fR to this DOM text. +.PP +The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode(). +.SH "QDomText QDomText::splitText ( int offset )" +Splits this DOM text object into two QDomText objects. This object keeps its first \fIoffset\fR characters and the second (newly created) object is inserted into the document tree after this object with the remaining characters. +.PP +The function returns the newly created object. +.PP +See also QDomNode::normalize(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdomtext.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdomtext.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdoublevalidator.3qt b/doc/man/man3/tqdoublevalidator.3qt new file mode 100644 index 000000000..5a7475ebf --- /dev/null +++ b/doc/man/man3/tqdoublevalidator.3qt @@ -0,0 +1,146 @@ +'\" t +.TH QDoubleValidator 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 +QDoubleValidator \- Range checking of floating-point numbers +.SH SYNOPSIS +\fC#include <ntqvalidator.h>\fR +.PP +Inherits QValidator. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDoubleValidator\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQDoubleValidator\fR ( double bottom, double top, int decimals, QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QDoubleValidator\fR ()" +.br +.ti -1c +.BI "virtual QValidator::State \fBvalidate\fR ( QString & input, int & ) const" +.br +.ti -1c +.BI "virtual void \fBsetRange\fR ( double minimum, double maximum, int decimals = 0 )" +.br +.ti -1c +.BI "void \fBsetBottom\fR ( double )" +.br +.ti -1c +.BI "void \fBsetTop\fR ( double )" +.br +.ti -1c +.BI "void \fBsetDecimals\fR ( int )" +.br +.ti -1c +.BI "double \fBbottom\fR () const" +.br +.ti -1c +.BI "double \fBtop\fR () const" +.br +.ti -1c +.BI "int \fBdecimals\fR () const" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "double \fBbottom\fR - the validator's minimum acceptable value" +.br +.ti -1c +.BI "int \fBdecimals\fR - the validator's maximum number of digits after the decimal point" +.br +.ti -1c +.BI "double \fBtop\fR - the validator's maximum acceptable value" +.br +.in -1c +.SH DESCRIPTION +The QDoubleValidator class provides range checking of floating-point numbers. +.PP +QDoubleValidator provides an upper bound, a lower bound and a limit on the number of digits after the decimal point. It does not provide a fixup() function. +.PP +You can set the acceptable range in one call with setRange(), or with setBottom() and setTop(). Set the number of decimal places with setDecimals(). The validate() function returns the validation state. +.PP +See also QIntValidator, QRegExpValidator, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDoubleValidator::QDoubleValidator ( QObject * parent, const char * name = 0 )" +Constructs a validator object with parent \fIparent\fR, called \fIname\fR, which accepts any double. +.SH "QDoubleValidator::QDoubleValidator ( double bottom, double top, int decimals, QObject * parent, const char * name = 0 )" +Constructs a validator object with parent \fIparent\fR, called \fIname\fR. This validator will accept doubles from \fIbottom\fR to \fItop\fR inclusive, with up to \fIdecimals\fR digits after the decimal point. +.SH "QDoubleValidator::~QDoubleValidator ()" +Destroys the validator, freeing any resources used. +.SH "double QDoubleValidator::bottom () const" +Returns the validator's minimum acceptable value. See the "bottom" property for details. +.SH "int QDoubleValidator::decimals () const" +Returns the validator's maximum number of digits after the decimal point. See the "decimals" property for details. +.SH "void QDoubleValidator::setBottom ( double )" +Sets the validator's minimum acceptable value. See the "bottom" property for details. +.SH "void QDoubleValidator::setDecimals ( int )" +Sets the validator's maximum number of digits after the decimal point. See the "decimals" property for details. +.SH "void QDoubleValidator::setRange ( double minimum, double maximum, int decimals = 0 )\fC [virtual]\fR" +Sets the validator to accept doubles from \fIminimum\fR to \fImaximum\fR inclusive, with at most \fIdecimals\fR digits after the decimal point. +.SH "void QDoubleValidator::setTop ( double )" +Sets the validator's maximum acceptable value. See the "top" property for details. +.SH "double QDoubleValidator::top () const" +Returns the validator's maximum acceptable value. See the "top" property for details. +.SH "QValidator::State QDoubleValidator::validate ( QString & input, int & ) const\fC [virtual]\fR" +Returns Acceptable if the string \fIinput\fR contains a double that is within the valid range and is in the correct format. +.PP +Returns Intermediate if \fIinput\fR contains a double that is outside the range or is in the wrong format, e.g. with too many digits after the decimal point or is empty. +.PP +Returns Invalid if the \fIinput\fR is not a double. +.PP +Note: If the valid range consists of just positive doubles (e.g. 0.0 - 100.0) and \fIinput\fR is a negative double then Invalid is returned. +.PP +Reimplemented from QValidator. +.SS "Property Documentation" +.SH "double bottom" +This property holds the validator's minimum acceptable value. +.PP +Set this property's value with setBottom() and get this property's value with bottom(). +.PP +See also setRange(). +.SH "int decimals" +This property holds the validator's maximum number of digits after the decimal point. +.PP +Set this property's value with setDecimals() and get this property's value with decimals(). +.PP +See also setRange(). +.SH "double top" +This property holds the validator's maximum acceptable value. +.PP +Set this property's value with setTop() and get this property's value with top(). +.PP +See also setRange(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdoublevalidator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdoublevalidator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdragenterevent.3qt b/doc/man/man3/tqdragenterevent.3qt new file mode 100644 index 000000000..8fd5eac62 --- /dev/null +++ b/doc/man/man3/tqdragenterevent.3qt @@ -0,0 +1,58 @@ +'\" t +.TH QDragEnterEvent 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 +QDragEnterEvent \- Event which is sent to the widget when a drag and drop first drags onto the widget +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QDragMoveEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDragEnterEvent\fR ( const QPoint & pos )" +.br +.in -1c +.SH DESCRIPTION +The QDragEnterEvent class provides an event which is sent to the widget when a drag and drop first drags onto the widget. +.PP +This event is always immediately followed by a QDragMoveEvent, so you only need to respond to one or the other event. This class inherits most of its functionality from QDragMoveEvent, which in turn inherits most of its functionality from QDropEvent. +.PP +See also QDragLeaveEvent, QDragMoveEvent, QDropEvent, Drag And Drop Classes, and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDragEnterEvent::QDragEnterEvent ( const QPoint & pos )" +Constructs a QDragEnterEvent entering at the given point, \fIpos\fR. +.PP +\fBWarning:\fR Do not create a QDragEnterEvent yourself since these +objects rely on Qt's internal state. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdragenterevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdragenterevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdragleaveevent.3qt b/doc/man/man3/tqdragleaveevent.3qt new file mode 100644 index 000000000..3311c3fef --- /dev/null +++ b/doc/man/man3/tqdragleaveevent.3qt @@ -0,0 +1,58 @@ +'\" t +.TH QDragLeaveEvent 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 +QDragLeaveEvent \- Event which is sent to the widget when a drag and drop leaves the widget +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDragLeaveEvent\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QDragLeaveEvent class provides an event which is sent to the widget when a drag and drop leaves the widget. +.PP +This event is always preceded by a QDragEnterEvent and a series of QDragMoveEvents. It is not sent if a QDropEvent is sent instead. +.PP +See also QDragEnterEvent, QDragMoveEvent, QDropEvent, Drag And Drop Classes, and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDragLeaveEvent::QDragLeaveEvent ()" +Constructs a QDragLeaveEvent. +.PP +\fBWarning:\fR Do not create a QDragLeaveEvent yourself since these +objects rely on Qt's internal state. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdragleaveevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdragleaveevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdragmoveevent.3qt b/doc/man/man3/tqdragmoveevent.3qt new file mode 100644 index 000000000..b778bb3c9 --- /dev/null +++ b/doc/man/man3/tqdragmoveevent.3qt @@ -0,0 +1,83 @@ +'\" t +.TH QDragMoveEvent 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 +QDragMoveEvent \- Event which is sent while a drag and drop is in progress +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QDropEvent. +.PP +Inherited by QDragEnterEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDragMoveEvent\fR ( const QPoint & pos, Type type = DragMove )" +.br +.ti -1c +.BI "QRect \fBanswerRect\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBignore\fR ( const QRect & r )" +.br +.in -1c +.SH DESCRIPTION +The QDragMoveEvent class provides an event which is sent while a drag and drop is in progress. +.PP +When a widget accepts drop events, it will receive this event repeatedly while the drag is within the widget's boundaries. The widget should examine the event to see what data it provides, and accept() the drop if appropriate. +.PP +Note that this class inherits most of its functionality from QDropEvent. +.PP +See also Drag And Drop Classes and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDragMoveEvent::QDragMoveEvent ( const QPoint & pos, Type type = DragMove )" +Creates a QDragMoveEvent for which the mouse is at point \fIpos\fR, and the event is of type \fItype\fR. +.PP +\fBWarning:\fR Do not create a QDragMoveEvent yourself since these objects rely on Qt's internal state. +.SH "void QDragMoveEvent::accept ( const QRect & r )" +The same as accept(), but also notifies that future moves will also be acceptable if they remain within the rectangle \fIr\fR on the widget: this can improve performance, but may also be ignored by the underlying system. +.PP +If the rectangle is empty, then drag move events will be sent continuously. This is useful if the source is scrolling in a timer event. +.PP +Examples: +.)l desktop/desktop.cpp and dirview/dirview.cpp. +.SH "QRect QDragMoveEvent::answerRect () const" +Returns the rectangle for which the acceptance of the move event applies. +.SH "void QDragMoveEvent::ignore ( const QRect & r )" +The opposite of accept(const QRect&), i.e. says that moves within rectangle \fIr\fR are not acceptable (will be ignored). +.PP +Example: dirview/dirview.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdragmoveevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdragmoveevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdragobject.3qt b/doc/man/man3/tqdragobject.3qt new file mode 100644 index 000000000..4264593a4 --- /dev/null +++ b/doc/man/man3/tqdragobject.3qt @@ -0,0 +1,182 @@ +'\" t +.TH QDragObject 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 +QDragObject \- Encapsulates MIME-based data transfer +.SH SYNOPSIS +\fC#include <ntqdragobject.h>\fR +.PP +Inherits QObject and QMimeSource. +.PP +Inherited by QStoredDrag, QTextDrag, QImageDrag, and QIconDrag. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDragObject\fR ( QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QDragObject\fR ()" +.br +.ti -1c +.BI "bool \fBdrag\fR ()" +.br +.ti -1c +.BI "bool \fBdragMove\fR ()" +.br +.ti -1c +.BI "void \fBdragCopy\fR ()" +.br +.ti -1c +.BI "void \fBdragLink\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( QPixmap pm )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( QPixmap pm, const QPoint & hotspot )" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR () const" +.br +.ti -1c +.BI "QPoint \fBpixmapHotSpot\fR () const" +.br +.ti -1c +.BI "QWidget * \fBsource\fR ()" +.br +.ti -1c +.BI "enum \fBDragMode\fR { DragDefault, DragCopy, DragMove, DragLink, DragCopyOrMove }" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QWidget * \fBtarget\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBdrag\fR ( DragMode mode )" +.br +.in -1c +.SH DESCRIPTION +The QDragObject class encapsulates MIME-based data transfer. +.PP +QDragObject is the base class for all data that needs to be transferred between and within applications, both for drag and drop and for the clipboard. +.PP +See the Drag-and-drop documentation for an overview of how to provide drag and drop in your application. +.PP +See the QClipboard documentation for an overview of how to provide cut-and-paste in your application. +.PP +The drag() function is used to start a drag operation. You can specify the DragMode in the call or use one of the convenience functions dragCopy(), dragMove() or dragLink(). The drag source where the data originated is retrieved with source(). If the data was dropped on a widget within the application, target() will return a pointer to that widget. Specify the pixmap to display during the drag with setPixmap(). +.PP +See also Drag And Drop Classes. +.SS "Member Type Documentation" +.SH "QDragObject::DragMode" +This enum describes the possible drag modes. +.TP +\fCQDragObject::DragDefault\fR - The mode is determined heuristically. +.TP +\fCQDragObject::DragCopy\fR - The data is copied, never moved. +.TP +\fCQDragObject::DragMove\fR - The data is moved, if dragged at all. +.TP +\fCQDragObject::DragLink\fR - The data is linked, if dragged at all. +.TP +\fCQDragObject::DragCopyOrMove\fR - The user chooses the mode by using a control key to switch from the default. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDragObject::QDragObject ( QWidget * dragSource = 0, const char * name = 0 )" +Constructs a drag object called \fIname\fR, which is a child of \fIdragSource\fR. +.PP +Note that the drag object will be deleted when \fIdragSource\fR is deleted. +.SH "QDragObject::~QDragObject ()\fC [virtual]\fR" +Destroys the drag object, canceling any drag and drop operation in which it is involved, and frees up the storage used. +.SH "bool QDragObject::drag ()" +Starts a drag operation using the contents of this object, using DragDefault mode. +.PP +The function returns TRUE if the caller should delete the original copy of the dragged data (but see target()); otherwise returns FALSE. +.PP +If the drag contains \fIreferences\fR to information (e.g. file names in a QUriDrag are references) then the return value should always be ignored, as the target is expected to manipulate the referred-to content directly. On X11 the return value should always be correct anyway, but on Windows this is not necessarily the case (e.g. the file manager starts a background process to move files, so the source \fImust not\fR delete the files!) +.PP +Note that on Windows the drag operation will spin a blocking modal event loop that will not dispatch any QTimers. +.PP +Example: dirview/dirview.cpp. +.SH "bool QDragObject::drag ( DragMode mode )\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Starts a drag operation using the contents of this object. +.PP +At this point, the object becomes owned by Qt, not the application. You should not delete the drag object or anything it references. The actual transfer of data to the target application will be done during future event processing - after that time the drag object will be deleted. +.PP +Returns TRUE if the dragged data was dragged as a \fImove\fR, indicating that the caller should remove the original source of the data (the drag object must continue to have a copy); otherwise returns FALSE. +.PP +The \fImode\fR specifies the drag mode (see QDragObject::DragMode.) Normally one of the simpler drag(), dragMove(), or dragCopy() functions would be used instead. +.SH "void QDragObject::dragCopy ()" +Starts a drag operation using the contents of this object, using DragCopy mode. Be sure to read the constraints described in drag(). +.PP +See also drag(), dragMove(), and dragLink(). +.PP +Example: iconview/simple_dd/main.cpp. +.SH "void QDragObject::dragLink ()" +Starts a drag operation using the contents of this object, using DragLink mode. Be sure to read the constraints described in drag(). +.PP +See also drag(), dragCopy(), and dragMove(). +.SH "bool QDragObject::dragMove ()" +Starts a drag operation using the contents of this object, using DragMove mode. Be sure to read the constraints described in drag(). +.PP +See also drag(), dragCopy(), and dragLink(). +.SH "QPixmap QDragObject::pixmap () const" +Returns the currently set pixmap (which isNull() if none is set). +.SH "QPoint QDragObject::pixmapHotSpot () const" +Returns the currently set pixmap hotspot. +.SH "void QDragObject::setPixmap ( QPixmap pm, const QPoint & hotspot )\fC [virtual]\fR" +Set the pixmap \fIpm\fR to display while dragging the object. The platform-specific implementation will use this where it can - so provide a small masked pixmap, and do not assume that the user will actually see it. For example, cursors on Windows 95 are of limited size. +.PP +The \fIhotspot\fR is the point on (or off) the pixmap that should be under the cursor as it is dragged. It is relative to the top-left pixel of the pixmap. +.PP +\fBWarning:\fR We have seen problems with drag cursors on different graphics hardware and driver software on Windows. Setting the graphics acceleration in the display settings down one tick solved the problems in all cases. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "void QDragObject::setPixmap ( QPixmap pm )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Uses a hotspot that positions the pixmap below and to the right of the mouse pointer. This allows the user to clearly see the point on the window which they are dragging the data onto. +.SH "QWidget * QDragObject::source ()" +Returns a pointer to the drag source where this object originated. +.SH "QWidget * QDragObject::target ()\fC [static]\fR" +After the drag completes, this function will return the QWidget which received the drop, or 0 if the data was dropped on another application. +.PP +This can be useful for detecting the case where drag and drop is +to and from the same widget. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqdragobject.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdragobject.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqdropevent.3qt b/doc/man/man3/tqdropevent.3qt new file mode 100644 index 000000000..66fcb2d52 --- /dev/null +++ b/doc/man/man3/tqdropevent.3qt @@ -0,0 +1,189 @@ +'\" t +.TH QDropEvent 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 +QDropEvent \- Event which is sent when a drag and drop is completed +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent and QMimeSource. +.PP +Inherited by QDragMoveEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQDropEvent\fR ( const QPoint & pos, Type typ = Drop )" +.br +.ti -1c +.BI "const QPoint & \fBpos\fR () const" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ( bool y = TRUE )" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.ti -1c +.BI "bool \fBisActionAccepted\fR () const" +.br +.ti -1c +.BI "void \fBacceptAction\fR ( bool y = TRUE )" +.br +.ti -1c +.BI "enum \fBAction\fR { Copy, Link, Move, Private, UserAction = 100 }" +.br +.ti -1c +.BI "void \fBsetAction\fR ( Action a )" +.br +.ti -1c +.BI "Action \fBaction\fR () const" +.br +.ti -1c +.BI "QWidget * \fBsource\fR () const" +.br +.ti -1c +.BI "virtual const char * \fBformat\fR ( int n = 0 ) const" +.br +.ti -1c +.BI "virtual QByteArray \fBencodedData\fR ( const char * format ) const" +.br +.ti -1c +.BI "virtual bool \fBprovides\fR ( const char * mimeType ) const" +.br +.ti -1c +.BI "QByteArray data ( const char * f ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetPoint\fR ( const QPoint & np )" +.br +.in -1c +.SH DESCRIPTION +The QDropEvent class provides an event which is sent when a drag and drop is completed. +.PP +When a widget accepts drop events, it will receive this event if it has accepted the most recent QDragEnterEvent or QDragMoveEvent sent to it. +.PP +The widget should use data() to extract the data in an appropriate format. +.PP +See also Drag And Drop Classes and Event Classes. +.SS "Member Type Documentation" +.SH "QDropEvent::Action" +This enum describes the action which a source requests that a target perform with dropped data. +.TP +\fCQDropEvent::Copy\fR - The default action. The source simply uses the data provided in the operation. +.TP +\fCQDropEvent::Link\fR - The source should somehow create a link to the location specified by the data. +.TP +\fCQDropEvent::Move\fR - The source should somehow move the object from the location specified by the data to a new location. +.TP +\fCQDropEvent::Private\fR - The target has special knowledge of the MIME type, which the source should respond to in a similar way to a Copy. +.TP +\fCQDropEvent::UserAction\fR - The source and target can co-operate using special actions. This feature is not currently supported. +.PP +The Link and Move actions only makes sense if the data is a reference, for example, text/uri-list file lists (see QUriDrag). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QDropEvent::QDropEvent ( const QPoint & pos, Type typ = Drop )" +Constructs a drop event that drops a drop of type \fItyp\fR on point \fIpos\fR. +.SH "void QDropEvent::accept ( bool y = TRUE )" +Call this function to indicate whether the event provided data which your widget processed. Set \fIy\fR to TRUE (the default) if your widget could process the data, otherwise set \fIy\fR to FALSE. To get the data, use encodedData(), or preferably, the decode() methods of existing QDragObject subclasses, such as QTextDrag::decode(), or your own subclasses. +.PP +See also acceptAction(). +.PP +Example: iconview/simple_dd/main.cpp. +.SH "void QDropEvent::acceptAction ( bool y = TRUE )" +Call this to indicate that the action described by action() is accepted (i.e. if \fIy\fR is TRUE, which is the default), not merely the default copy action. If you call acceptAction(TRUE), there is no need to also call accept(TRUE). +.PP +Examples: +.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. +.SH "Action QDropEvent::action () const" +Returns the Action which the target is requesting to be performed with the data. If your application understands the action and can process the supplied data, call acceptAction(); if your application can process the supplied data but can only perform the Copy action, call accept(). +.PP +Examples: +.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. +.SH "QByteArray QDropEvent::data ( const char * f ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use QDropEvent::encodedData(). +.SH "QByteArray QDropEvent::encodedData ( const char * format ) const\fC [virtual]\fR" +Returns a byte array containing the drag's data, in \fIformat\fR. +.PP +data() normally needs to get the data from the drag source, which is potentially very slow, so it's advisable to call this function only if you're sure that you will need the data in \fIformat\fR. +.PP +The resulting data will have a size of 0 if the format was not available. +.PP +See also format() and QByteArray::size(). +.PP +Reimplemented from QMimeSource. +.SH "const char * QDropEvent::format ( int n = 0 ) const\fC [virtual]\fR" +Returns a string describing one of the available data types for this drag. Common examples are "text/plain" and "image/gif". If \fIn\fR is less than zero or greater than the number of available data types, format() returns 0. +.PP +This function is provided mainly for debugging. Most drop targets will use provides(). +.PP +See also data() and provides(). +.PP +Example: iconview/main.cpp. +.PP +Reimplemented from QMimeSource. +.SH "void QDropEvent::ignore ()" +The opposite of accept(), i.e. you have ignored the drop event. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QDropEvent::isAccepted () const" +Returns TRUE if the drop target accepts the event; otherwise returns FALSE. +.SH "bool QDropEvent::isActionAccepted () const" +Returns TRUE if the drop action was accepted by the drop site; otherwise returns FALSE. +.SH "const QPoint & QDropEvent::pos () const" +Returns the position where the drop was made. +.PP +Example: dirview/dirview.cpp. +.SH "bool QDropEvent::provides ( const char * mimeType ) const\fC [virtual]\fR" +Returns TRUE if this event provides format \fImimeType\fR; otherwise returns FALSE. +.PP +See also data(). +.PP +Example: fileiconview/qfileiconview.cpp. +.PP +Reimplemented from QMimeSource. +.SH "void QDropEvent::setAction ( Action a )" +Sets the action to \fIa\fR. This is used internally, you should not need to call this in your code: the \fIsource\fR decides the action, not the target. +.SH "void QDropEvent::setPoint ( const QPoint & np )" +Sets the drop to happen at point \fInp\fR. You do not normally need to use this as it will be set internally before your widget receives the drop event. +.SH "QWidget * QDropEvent::source () const" +If the source of the drag operation is a widget in this application, this function returns that source, otherwise it returns 0. The source of the operation is the first parameter to drag object subclasses. +.PP +This is useful if your widget needs special behavior when dragging to itself, etc. +.PP +See QDragObject::QDragObject() and subclasses. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qdropevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqdropevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqeditorfactory.3qt b/doc/man/man3/tqeditorfactory.3qt new file mode 100644 index 000000000..da2bf76c2 --- /dev/null +++ b/doc/man/man3/tqeditorfactory.3qt @@ -0,0 +1,85 @@ +'\" t +.TH QEditorFactory 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 +QEditorFactory \- Used to create editor widgets for QVariant data types +.SH SYNOPSIS +\fC#include <ntqeditorfactory.h>\fR +.PP +Inherits QObject. +.PP +Inherited by QSqlEditorFactory. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQEditorFactory\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QEditorFactory\fR ()" +.br +.ti -1c +.BI "virtual QWidget * \fBcreateEditor\fR ( QWidget * parent, const QVariant & v )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QEditorFactory * \fBdefaultFactory\fR ()" +.br +.ti -1c +.BI "void \fBinstallDefaultFactory\fR ( QEditorFactory * factory )" +.br +.in -1c +.SH DESCRIPTION +The QEditorFactory class is used to create editor widgets for QVariant data types. +.PP +Each editor factory provides the createEditor() function which given a QVariant will create and return a QWidget that can edit that QVariant. For example if you have a QVariant::String type, a QLineEdit would be the default editor returned, whereas a QVariant::Int's default editor would be a QSpinBox. +.PP +If you want to create different editors for fields with the same data type, subclass QEditorFactory and reimplement the createEditor() function. +.PP +See also Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QEditorFactory::QEditorFactory ( QObject * parent = 0, const char * name = 0 )" +Constructs an editor factory with parent \fIparent\fR, called \fIname\fR. +.SH "QEditorFactory::~QEditorFactory ()" +Destroys the object and frees any allocated resources. +.SH "QWidget * QEditorFactory::createEditor ( QWidget * parent, const QVariant & v )\fC [virtual]\fR" +Creates and returns the appropriate editor for the QVariant \fIv\fR. If the QVariant is invalid, 0 is returned. The \fIparent\fR is passed to the appropriate editor's constructor. +.PP +Reimplemented in QSqlEditorFactory. +.SH "QEditorFactory * QEditorFactory::defaultFactory ()\fC [static]\fR" +Returns an instance of a default editor factory. +.SH "void QEditorFactory::installDefaultFactory ( QEditorFactory * factory )\fC [static]\fR" +Replaces the default editor factory with \fIfactory\fR. +\fIQEditorFactory takes ownership of factory, and destroys it when it is no longer needed.\fR + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqeditorfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqeditorfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqerrormessage.3qt b/doc/man/man3/tqerrormessage.3qt new file mode 100644 index 000000000..8532e3891 --- /dev/null +++ b/doc/man/man3/tqerrormessage.3qt @@ -0,0 +1,94 @@ +'\" t +.TH QErrorMessage 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 +QErrorMessage \- Error message display dialog +.SH SYNOPSIS +\fC#include <ntqerrormessage.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQErrorMessage\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QErrorMessage\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBmessage\fR ( const QString & m )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QErrorMessage * \fBqtHandler\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QErrorMessage class provides an error message display dialog. +.PP +This is basically a QLabel and a "show this message again" checkbox which remembers what not to show. +.PP +There are two ways to use this class: <ol type=1> +.IP 1 +For production applications. In this context the class can be used to display messages which you don't need the user to see more than once. To use QErrorMessage like this, you create the dialog in the usual way and call the message() slot, or connect signals to it. +.IP 2 +For developers. In this context the static qtHandler() installs a message handler using qInstallMsgHandler() and creates a QErrorMessage that displays tqDebug(), tqWarning() and tqFatal() messages. +.PP +In both cases QErrorMessage will queue pending messages, and display them (or not) in order, as soon as the user presses Enter or clicks OK after seeing each message. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QMessageBox, QStatusBar::message(), Dialog Classes, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QErrorMessage::QErrorMessage ( QWidget * parent, const char * name = 0 )" +Constructs and installs an error handler window. The parent \fIparent\fR and name \fIname\fR are passed on to the QDialog constructor. +.SH "QErrorMessage::~QErrorMessage ()" +Destroys the object and frees any allocated resources. Notably, the list of "do not show again" messages is deleted. +.SH "void QErrorMessage::message ( const QString & m )\fC [slot]\fR" +Shows message \fIm\fR and returns immediately. If the user has requested that \fIm\fR not be shown, this function does nothing. +.PP +Normally, \fIm\fR is shown at once, but if there are pending messages, \fIm\fR is queued for later display. +.SH "QErrorMessage * QErrorMessage::qtHandler ()\fC [static]\fR" +Returns a pointer to a QErrorMessage object that outputs the +default Qt messages. This function creates such an object, if there +isn't one already. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqerrormessage.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqerrormessage.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqeucjpcodec.3qt b/doc/man/man3/tqeucjpcodec.3qt new file mode 100644 index 000000000..ea9078d38 --- /dev/null +++ b/doc/man/man3/tqeucjpcodec.3qt @@ -0,0 +1,90 @@ +'\" t +.TH QEucJpCodec 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 +QEucJpCodec \- Conversion to and from EUC-JP character sets +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqeucjpcodec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual int \fBmibEnum\fR () const" +.br +.ti -1c +.BI "virtual const char * \fBmimeName\fR () const" +.br +.ti -1c +.BI "\fBQEucJpCodec\fR ()" +.br +.ti -1c +.BI "\fB~QEucJpCodec\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QEucJpCodec class provides conversion to and from EUC-JP character sets. +.PP +More precisely, the QEucJpCodec class subclasses QTextCodec to provide support for EUC-JP, the main legacy encoding for Unix machines in Japan. +.PP +The environment variable \fCUNICODEMAP_JP\fR can be used to fine-tune QJisCodec, QSjisCodec and QEucJpCodec. The QJisCodec documentation describes how to use this variable. +.PP +Most of the code here was written by Serika Kurusugawa, a.k.a. Junji Takagi, and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for that code: +.PP +Copyright (C) 1999 Serika Kurusugawa. All rights reserved. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> +.IP 1 +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.IP 2 +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS". ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.PP +See also Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QEucJpCodec::QEucJpCodec ()" +Constructs a QEucJpCodec. +.SH "QEucJpCodec::~QEucJpCodec ()" +Destroys the codec. +.SH "int QEucJpCodec::mibEnum () const\fC [virtual]\fR" +Returns 18. +.PP +Reimplemented from QTextCodec. +.SH "const char * QEucJpCodec::mimeName () const\fC [virtual]\fR" +Returns the codec's mime name. +.PP +Reimplemented from QTextCodec. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqeucjpcodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqeucjpcodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqeuckrcodec.3qt b/doc/man/man3/tqeuckrcodec.3qt new file mode 100644 index 000000000..8fcd2f11b --- /dev/null +++ b/doc/man/man3/tqeuckrcodec.3qt @@ -0,0 +1,71 @@ +'\" t +.TH QEucKrCodec 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 +QEucKrCodec \- Conversion to and from EUC-KR character sets +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqeuckrcodec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual const char * \fBmimeName\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QEucKrCodec class provides conversion to and from EUC-KR character sets. +.PP +The QEucKrCodec class subclasses QTextCodec to provide support for EUC-KR, the main legacy encoding for UNIX machines in Korea. +.PP +It was largely written by Mizi Research Inc. Here is the copyright statement for the code as it was at the point of contribution. Trolltech's subsequent modifications are covered by the usual copyright for Qt. +.PP +Copyright (C) 1999-2000 Mizi Research Inc. All rights reserved. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +.IP 1 +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.IP 2 +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.PP +See also Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "const char * QEucKrCodec::mimeName () const\fC [virtual]\fR" +Returns the codec's mime name. +.PP +Reimplemented from QTextCodec. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqeuckrcodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqeuckrcodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqevent.3qt b/doc/man/man3/tqevent.3qt new file mode 100644 index 000000000..43868097d --- /dev/null +++ b/doc/man/man3/tqevent.3qt @@ -0,0 +1,238 @@ +'\" t +.TH QEvent 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 +QEvent \- The base class of all event classes. Event objects contain event parameters +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits Qt. +.PP +Inherited by QTimerEvent, QMouseEvent, QWheelEvent, QTabletEvent, QKeyEvent, QFocusEvent, QPaintEvent, QMoveEvent, QResizeEvent, QCloseEvent, QIconDragEvent, QShowEvent, QHideEvent, QContextMenuEvent, QIMEvent, QDropEvent, QDragLeaveEvent, QChildEvent, and QCustomEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBType\fR { None = 0, Timer = 1, MouseButtonPress = 2, MouseButtonRelease = 3, MouseButtonDblClick = 4, MouseMove = 5, KeyPress = 6, KeyRelease = 7, FocusIn = 8, FocusOut = 9, Enter = 10, Leave = 11, Paint = 12, Move = 13, Resize = 14, Create = 15, Destroy = 16, Show = 17, Hide = 18, Close = 19, Quit = 20, Reparent = 21, ShowMinimized = 22, ShowNormal = 23, WindowActivate = 24, WindowDeactivate = 25, ShowToParent = 26, HideToParent = 27, ShowMaximized = 28, ShowFullScreen = 29, Accel = 30, Wheel = 31, AccelAvailable = 32, CaptionChange = 33, IconChange = 34, ParentFontChange = 35, ApplicationFontChange = 36, ParentPaletteChange = 37, ApplicationPaletteChange = 38, PaletteChange = 39, Clipboard = 40, Speech = 42, SockAct = 50, AccelOverride = 51, DeferredDelete = 52, DragEnter = 60, DragMove = 61, DragLeave = 62, Drop = 63, DragResponse = 64, ChildInserted = 70, ChildRemoved = 71, LayoutHint = 72, ShowWindowRequest = 73, WindowBlocked = 74, WindowUnblocked = 75, ActivateControl = 80, DeactivateControl = 81, ContextMenu = 82, IMStart = 83, IMCompose = 84, IMEnd = 85, Accessibility = 86, TabletMove = 87, LocaleChange = 88, LanguageChange = 89, LayoutDirectionChange = 90, Style = 91, TabletPress = 92, TabletRelease = 93, OkRequest = 94, HelpRequest = 95, WindowStateChange = 96, IconDrag = 97, User = 1000, MaxUser = 65535 }" +.br +.ti -1c +.BI "\fBQEvent\fR ( Type type )" +.br +.ti -1c +.BI "virtual \fB~QEvent\fR ()" +.br +.ti -1c +.BI "Type \fBtype\fR () const" +.br +.ti -1c +.BI "bool \fBspontaneous\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QEvent class is the base class of all event classes. Event objects contain event parameters. +.PP +Qt's main event loop (QApplication::exec()) fetches native window system events from the event queue, translates them into QEvents and sends the translated events to QObjects. +.PP +In general, events come from the underlying window system (spontaneous() returns TRUE) but it is also possible to manually send events using QApplication::sendEvent() and QApplication::postEvent() (spontaneous() returns FALSE). +.PP +QObjects receive events by having their QObject::event() function called. The function can be reimplemented in subclasses to customize event handling and add additional event types; QWidget::event() is a notable example. By default, events are dispatched to event handlers like QObject::timerEvent() and QWidget::mouseMoveEvent(). QObject::installEventFilter() allows an object to intercept events destined for another object. +.PP +The basic QEvent contains only an event type parameter. Subclasses of QEvent contain additional parameters that describe the particular event. +.PP +See also QObject::event(), QObject::installEventFilter(), QWidget::event(), QApplication::sendEvent(), QApplication::postEvent(), QApplication::processEvents(), Environment Classes, and Event Classes. +.SS "Member Type Documentation" +.SH "QEvent::Type" +This enum type defines the valid event types in Qt. The event types and the specialized classes for each type are these: +.TP +\fCQEvent::None\fR - Not an event. +.TP +\fCQEvent::Accessibility\fR - Accessibility information is requested +.TP +\fCQEvent::Timer\fR - Regular timer events, QTimerEvent. +.TP +\fCQEvent::MouseButtonPress\fR - Mouse press, QMouseEvent. +.TP +\fCQEvent::MouseButtonRelease\fR - Mouse release, QMouseEvent. +.TP +\fCQEvent::MouseButtonDblClick\fR - Mouse press again, QMouseEvent. +.TP +\fCQEvent::MouseMove\fR - Mouse move, QMouseEvent. +.TP +\fCQEvent::KeyPress\fR - Key press (including Shift, for example), QKeyEvent. +.TP +\fCQEvent::KeyRelease\fR - Key release, QKeyEvent. +.TP +\fCQEvent::IMStart\fR - The start of input method composition, QIMEvent. +.TP +\fCQEvent::IMCompose\fR - Input method composition is taking place, QIMEvent. +.TP +\fCQEvent::IMEnd\fR - The end of input method composition, QIMEvent. +.TP +\fCQEvent::FocusIn\fR - Widget gains keyboard focus, QFocusEvent. +.TP +\fCQEvent::FocusOut\fR - Widget loses keyboard focus, QFocusEvent. +.TP +\fCQEvent::Enter\fR - Mouse enters widget's boundaries. +.TP +\fCQEvent::Leave\fR - Mouse leaves widget's boundaries. +.TP +\fCQEvent::Paint\fR - Screen update necessary, QPaintEvent. +.TP +\fCQEvent::Move\fR - Widget's position changed, QMoveEvent. +.TP +\fCQEvent::Resize\fR - Widget's size changed, QResizeEvent. +.TP +\fCQEvent::Show\fR - Widget was shown on screen, QShowEvent. +.TP +\fCQEvent::Hide\fR - Widget was hidden, QHideEvent. +.TP +\fCQEvent::ShowToParent\fR - A child widget has been shown. +.TP +\fCQEvent::HideToParent\fR - A child widget has been hidden. +.TP +\fCQEvent::Close\fR - Widget was closed (permanently), QCloseEvent. +.TP +\fCQEvent::ShowNormal\fR - Widget should be shown normally (obsolete). +.TP +\fCQEvent::ShowMaximized\fR - Widget should be shown maximized (obsolete). +.TP +\fCQEvent::ShowMinimized\fR - Widget should be shown minimized (obsolete). +.TP +\fCQEvent::ShowFullScreen\fR - Widget should be shown full-screen (obsolete). +.TP +\fCQEvent::ShowWindowRequest\fR - Widget's window should be shown (obsolete). +.TP +\fCQEvent::DeferredDelete\fR - The object will be deleted after it has cleaned up. +.TP +\fCQEvent::Accel\fR - Key press in child for shortcut key handling, QKeyEvent. +.TP +\fCQEvent::Wheel\fR - Mouse wheel rolled, QWheelEvent. +.TP +\fCQEvent::ContextMenu\fR - Context popup menu, QContextMenuEvent +.TP +\fCQEvent::AccelOverride\fR - Key press in child, for overriding shortcut key handling, QKeyEvent. +.TP +\fCQEvent::AccelAvailable\fR - internal. +.TP +\fCQEvent::WindowActivate\fR - Window was activated. +.TP +\fCQEvent::WindowDeactivate\fR - Window was deactivated. +.TP +\fCQEvent::CaptionChange\fR - Widget's caption changed. +.TP +\fCQEvent::IconChange\fR - Widget's icon changed. +.TP +\fCQEvent::ParentFontChange\fR - Font of the parent widget changed. +.TP +\fCQEvent::ApplicationFontChange\fR - Default application font changed. +.TP +\fCQEvent::PaletteChange\fR - Palette of the widget changed. +.TP +\fCQEvent::ParentPaletteChange\fR - Palette of the parent widget changed. +.TP +\fCQEvent::ApplicationPaletteChange\fR - Default application palette changed. +.TP +\fCQEvent::Clipboard\fR - Clipboard contents have changed. +.TP +\fCQEvent::SockAct\fR - Socket activated, used to implement QSocketNotifier. +.TP +\fCQEvent::DragEnter\fR - A drag-and-drop enters widget, QDragEnterEvent. +.TP +\fCQEvent::DragMove\fR - A drag-and-drop is in progress, QDragMoveEvent. +.TP +\fCQEvent::DragLeave\fR - A drag-and-drop leaves widget, QDragLeaveEvent. +.TP +\fCQEvent::Drop\fR - A drag-and-drop is completed, QDropEvent. +.TP +\fCQEvent::DragResponse\fR - Internal event used by Qt on some platforms. +.TP +\fCQEvent::ChildInserted\fR - Object gets a child, QChildEvent. +.TP +\fCQEvent::ChildRemoved\fR - Object loses a child, QChildEvent. +.TP +\fCQEvent::LayoutHint\fR - Widget child has changed layout properties. +.TP +\fCQEvent::ActivateControl\fR - Internal event used by Qt on some platforms. +.TP +\fCQEvent::DeactivateControl\fR - Internal event used by Qt on some platforms. +.TP +\fCQEvent::LanguageChange\fR - The application translation changed, QTranslator +.TP +\fCQEvent::LayoutDirectionChange\fR - The direction of layouts changed +.TP +\fCQEvent::LocaleChange\fR - The system locale changed +.TP +\fCQEvent::Quit\fR - Reserved. +.TP +\fCQEvent::Create\fR - Reserved. +.TP +\fCQEvent::Destroy\fR - Reserved. +.TP +\fCQEvent::Reparent\fR - Reserved. +.TP +\fCQEvent::Speech\fR - Reserved for speech input. +.TP +\fCQEvent::TabletMove\fR - A Wacom Tablet Move Event. +.TP +\fCQEvent::Style\fR - Internal use only +.TP +\fCQEvent::TabletPress\fR - A Wacom Tablet Press Event +.TP +\fCQEvent::TabletRelease\fR - A Wacom Tablet Release Event +.TP +\fCQEvent::OkRequest\fR - Internal event used by Qt on some platforms. +.TP +\fCQEvent::HelpRequest\fR - Internal event used by Qt on some platforms. +.TP +\fCQEvent::IconDrag\fR - Internal event used by Qt on some platforms when proxy icon is dragged. +.TP +\fCQEvent::WindowStateChange\fR - The window's state, i.e. minimized, maximized or full-screen, has changed. See QWidget::windowState(). +.TP +\fCQEvent::WindowBlocked\fR - The window is modally blocked +.TP +\fCQEvent::WindowUnblocked\fR - The window leaves modal blocking +.TP +\fCQEvent::User\fR - User defined event. +.TP +\fCQEvent::MaxUser\fR - Last user event id. +.PP +User events should have values between User and MaxUser inclusive. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QEvent::QEvent ( Type type )" +Contructs an event object of type \fItype\fR. +.SH "QEvent::~QEvent ()\fC [virtual]\fR" +Destroys the event. If it was posted, it will be removed from the list of events to be posted. +.SH "bool QEvent::spontaneous () const" +Returns TRUE if the event originated outside the application, i.e. it is a system event; otherwise returns FALSE. +.SH "Type QEvent::type () const" +Returns the event type. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqeventloop.3qt b/doc/man/man3/tqeventloop.3qt new file mode 100644 index 000000000..909eaf8d9 --- /dev/null +++ b/doc/man/man3/tqeventloop.3qt @@ -0,0 +1,240 @@ +'\" t +.TH QEventLoop 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 +QEventLoop \- Manages the event queue +.SH SYNOPSIS +\fC#include <ntqeventloop.h>\fR +.PP +Inherits QObject. +.PP +Inherited by QMotif. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQEventLoop\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QEventLoop\fR ()" +.br +.ti -1c +.BI "enum \fBProcessEvents\fR { AllEvents = 0x00, ExcludeUserInput = 0x01, ExcludeSocketNotifiers = 0x02, WaitForMore = 0x04 }" +.br +.ti -1c +.BI "typedef uint \fBProcessEventsFlags\fR" +.br +.ti -1c +.BI "void \fBprocessEvents\fR ( ProcessEventsFlags flags, int maxTime )" +.br +.ti -1c +.BI "virtual bool \fBprocessEvents\fR ( ProcessEventsFlags flags )" +.br +.ti -1c +.BI "virtual bool \fBhasPendingEvents\fR () const" +.br +.ti -1c +.BI "virtual void \fBregisterSocketNotifier\fR ( QSocketNotifier * notifier )" +.br +.ti -1c +.BI "virtual void \fBunregisterSocketNotifier\fR ( QSocketNotifier * notifier )" +.br +.ti -1c +.BI "void \fBsetSocketNotifierPending\fR ( QSocketNotifier * notifier )" +.br +.ti -1c +.BI "int \fBactivateSocketNotifiers\fR ()" +.br +.ti -1c +.BI "int \fBactivateTimers\fR ()" +.br +.ti -1c +.BI "int \fBtimeToWait\fR () const" +.br +.ti -1c +.BI "virtual int \fBexec\fR ()" +.br +.ti -1c +.BI "virtual void \fBexit\fR ( int retcode = 0 )" +.br +.ti -1c +.BI "virtual int \fBenterLoop\fR ()" +.br +.ti -1c +.BI "virtual void \fBexitLoop\fR ()" +.br +.ti -1c +.BI "virtual int \fBloopLevel\fR () const" +.br +.ti -1c +.BI "virtual void \fBwakeUp\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBawake\fR ()" +.br +.ti -1c +.BI "void \fBaboutToBlock\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QEventLoop class manages the event queue. +.PP +It receives events from the window system and other sources. It then sends them to QApplication for processing and delivery. +.PP +QEventLoop allows the application programmer to have more control over event delivery. Programs that perform long operations can call either processOneEvent() or processEvents() with various ProcessEvent values OR'ed together to control which events should be delivered. +.PP +QEventLoop also allows the integration of an external event loop with the Qt event loop. The Motif Extension included with Qt includes a reimplementation of QEventLoop for merging Qt and Motif events together. +.PP +To use your own instance of QEventLoop or QEventLoop subclass create it before you create the QApplication object. +.PP +See also Main Window and Related Classes and Event Classes. +.SS "Member Type Documentation" +.SH "QEventLoop::ProcessEvents" +This enum controls the types of events processed by the processEvents() functions. +.TP +\fCQEventLoop::AllEvents\fR - All events are processed +.TP +\fCQEventLoop::ExcludeUserInput\fR - Do not process user input events. ( ButtonPress, KeyPress, etc. ) +.TP +\fCQEventLoop::ExcludeSocketNotifiers\fR - Do not process socket notifier events. +.TP +\fCQEventLoop::WaitForMore\fR - Wait for events if no pending events are available. +.PP +See also processEvents(). +.SH "QEventLoop::ProcessEventsFlags" +A \fCtypedef\fR to allow various ProcessEvents values to be OR'ed together. +.PP +See also ProcessEvents. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QEventLoop::QEventLoop ( QObject * parent = 0, const char * name = 0 )" +Creates a QEventLoop object, this object becomes the global event loop object. There can only be one event loop object. The QEventLoop is usually constructed by calling QApplication::eventLoop(). To create your own event loop object create it before you instantiate the QApplication object. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. +.SH "QEventLoop::~QEventLoop ()" +Destructs the QEventLoop object. +.SH "void QEventLoop::aboutToBlock ()\fC [signal]\fR" +This signal is emitted before the event loop calls a function that could block. +.PP +See also awake(). +.SH "int QEventLoop::activateSocketNotifiers ()" +Activates all pending socket notifiers and returns the number of socket notifiers that were activated. +.SH "int QEventLoop::activateTimers ()" +Activates all Qt timers and returns the number of timers that were activated. +.PP +QEventLoop subclasses that do their own timer handling need to call this after the time returned by timeToWait() has elapsed. +.PP +Note: This function is only useful on systems where \fCselect()\fR is used to block the eventloop. On Windows, this function always returns 0. On MacOS X, this function always returns 0 when the GUI is enabled. On MacOS X, this function returns the documented value when the GUI is disabled. +.SH "void QEventLoop::awake ()\fC [signal]\fR" +This signal is emitted after the event loop returns from a function that could block. +.PP +See also wakeUp() and aboutToBlock(). +.SH "int QEventLoop::enterLoop ()\fC [virtual]\fR" +This function enters the main event loop (recursively). Do not call it unless you really know what you are doing. +.SH "int QEventLoop::exec ()\fC [virtual]\fR" +Enters the main event loop and waits until exit() is called, and returns the value that was set to exit(). +.PP +It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets. +.PP +Generally speaking, no user interaction can take place before calling exec(). As a special case, modal widgets like QMessageBox can be used before calling exec(), because modal widgets call exec() to start a local event loop. +.PP +To make your application perform idle processing, i.e. executing a special function whenever there are no pending events, use a QTimer with 0 timeout. More advanced idle processing schemes can be achieved using processEvents(). +.PP +See also QApplication::quit(), exit(), and processEvents(). +.SH "void QEventLoop::exit ( int retcode = 0 )\fC [virtual]\fR" +Tells the event loop to exit with a return code. +.PP +After this function has been called, the event loop returns from the call to exec(). The exec() function returns \fIretcode\fR. +.PP +By convention, a \fIretcode\fR of 0 means success, and any non-zero value indicates an error. +.PP +Note that unlike the C library function of the same name, this function \fIdoes\fR return to the caller -- it is event processing that stops. +.PP +See also QApplication::quit() and exec(). +.SH "void QEventLoop::exitLoop ()\fC [virtual]\fR" +This function exits from a recursive call to the main event loop. Do not call it unless you really know what you are doing. +.SH "bool QEventLoop::hasPendingEvents () const\fC [virtual]\fR" +Returns TRUE if there is an event waiting, otherwise it returns FALSE. +.SH "int QEventLoop::loopLevel () const\fC [virtual]\fR" +Returns the current loop level. +.SH "void QEventLoop::processEvents ( ProcessEventsFlags flags, int maxTime )" +Process pending events that match \fIflags\fR for a maximum of \fImaxTime\fR milliseconds, or until there are no more events to process, which ever is shorter. +.PP +This function is especially useful if you have a long running operation and want to show its progress without allowing user input, i.e. by using the ExcludeUserInput flag. +.PP +NOTE: This function will not process events continuously; it returns after all available events are processed. +.PP +NOTE: Specifying the WaitForMore flag makes no sense and will be ignored. +.SH "bool QEventLoop::processEvents ( ProcessEventsFlags flags )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Processes pending events that match \fIflags\fR until there are no more events to process. +.PP +This function is especially useful if you have a long running operation and want to show its progress without allowing user input, i.e. by using the ExcludeUserInput flag. +.PP +If the WaitForMore flag is set in \fIflags\fR, the behavior of this function is as follows: +.IP +.TP +If events are available, this function returns after processing them. +.IP +.TP +If no events are available, this function will wait until more are available and return after processing newly available events. +.IP +.PP +If the WaitForMore flag is \fInot\fR set in \fIflags\fR, and no events are available, this function will return immediately. +.PP +NOTE: This function will not process events continuously; it returns after all available events are processed. +.PP +This function returns TRUE if an event was processed; otherwise it returns FALSE. +.PP +See also ProcessEvents and hasPendingEvents(). +.SH "void QEventLoop::registerSocketNotifier ( QSocketNotifier * notifier )\fC [virtual]\fR" +Registers \fInotifier\fR with the event loop. Subclasses need to reimplement this method to tie a socket notifier into another event loop. Reimplementations \fIMUST\fR call the base implementation. +.SH "void QEventLoop::setSocketNotifierPending ( QSocketNotifier * notifier )" +Marks \fInotifier\fR as pending. The socket notifier will be activated the next time activateSocketNotifiers() is called. +.SH "int QEventLoop::timeToWait () const" +Returns the number of milliseconds that Qt needs to handle its timers or -1 if there are no timers running. +.PP +QEventLoop subclasses that do their own timer handling need to use this to make sure that Qt's timers continue to work. +.PP +Note: This function is only useful on systems where \fCselect()\fR is used to block the eventloop. On Windows, this function always returns -1. On MacOS X, this function always returns -1 when the GUI is enabled. On MacOS X, this function returns the documented value when the GUI is disabled. +.SH "void QEventLoop::unregisterSocketNotifier ( QSocketNotifier * notifier )\fC [virtual]\fR" +Unregisters \fInotifier\fR from the event loop. Subclasses need to reimplement this method to tie a socket notifier into another event loop. Reimplementations \fIMUST\fR call the base implementation. +.SH "void QEventLoop::wakeUp ()\fC [virtual]\fR" +\fBNote:\fR This function is thread-safe when Qt is built withthread support.</p> +.PP +Wakes up the event loop. +.PP +See also awake(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqeventloop.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqeventloop.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfile.3qt b/doc/man/man3/tqfile.3qt new file mode 100644 index 000000000..50bc69940 --- /dev/null +++ b/doc/man/man3/tqfile.3qt @@ -0,0 +1,526 @@ +'\" t +.TH QFile 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 +QFile \- I/O device that operates on files +.SH SYNOPSIS +Almost all the functions in this class are reentrant when Qt is built with thread support. The exceptions are \fBsetEncodingFunction\fR(), \fBsetDecodingFunction\fR(), and \fBsetErrorString\fR(). </p> +.PP +\fC#include <ntqfile.h>\fR +.PP +Inherits QIODevice. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFile\fR ()" +.br +.ti -1c +.BI "\fBQFile\fR ( const QString & name )" +.br +.ti -1c +.BI "\fB~QFile\fR ()" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "void \fBsetName\fR ( const QString & name )" +.br +.ti -1c +.BI "typedef QCString (* \fBEncoderFn\fR ) ( const QString & fileName )" +.br +.ti -1c +.BI "typedef QString (* \fBDecoderFn\fR ) ( const QCString & localfileName )" +.br +.ti -1c +.BI "bool \fBexists\fR () const" +.br +.ti -1c +.BI "bool \fBremove\fR ()" +.br +.ti -1c +.BI "virtual bool \fBopen\fR ( int m )" +.br +.ti -1c +.BI "bool \fBopen\fR ( int m, FILE * f )" +.br +.ti -1c +.BI "bool \fBopen\fR ( int m, int f )" +.br +.ti -1c +.BI "virtual void \fBclose\fR ()" +.br +.ti -1c +.BI "virtual void \fBflush\fR ()" +.br +.ti -1c +.BI "virtual Offset \fBsize\fR () const" +.br +.ti -1c +.BI "virtual bool \fBatEnd\fR () const" +.br +.ti -1c +.BI "virtual TQ_LONG \fBreadLine\fR ( char * p, TQ_ULONG maxlen )" +.br +.ti -1c +.BI "TQ_LONG \fBreadLine\fR ( QString & s, TQ_ULONG maxlen )" +.br +.ti -1c +.BI "virtual int \fBgetch\fR ()" +.br +.ti -1c +.BI "virtual int \fBputch\fR ( int ch )" +.br +.ti -1c +.BI "virtual int \fBungetch\fR ( int ch )" +.br +.ti -1c +.BI "int \fBhandle\fR () const" +.br +.ti -1c +.BI "QString \fBerrorString\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QCString \fBencodeName\fR ( const QString & fileName )" +.br +.ti -1c +.BI "QString \fBdecodeName\fR ( const QCString & localFileName )" +.br +.ti -1c +.BI "void \fBsetEncodingFunction\fR ( EncoderFn f )" +.br +.ti -1c +.BI "void \fBsetDecodingFunction\fR ( DecoderFn f )" +.br +.ti -1c +.BI "bool \fBexists\fR ( const QString & fileName )" +.br +.ti -1c +.BI "bool \fBremove\fR ( const QString & fileName )" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "virtual QByteArray \fBreadAll\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsetErrorString\fR ( const QString & str )" +.br +.in -1c +.SH DESCRIPTION +The QFile class is an I/O device that operates on files. +.PP +QFile is an I/O device for reading and writing binary and text files. A QFile may be used by itself or more conveniently with a QDataStream or QTextStream. +.PP +The file name is usually passed in the constructor but can be changed with setName(). You can check for a file's existence with exists() and remove a file with remove(). +.PP +The file is opened with open(), closed with close() and flushed with flush(). Data is usually read and written using QDataStream or QTextStream, but you can read with readBlock() and readLine() and write with writeBlock(). QFile also supports getch(), ungetch() and putch(). +.PP +The size of the file is returned by size(). You can get the current file position or move to a new file position using the at() functions. If you've reached the end of the file, atEnd() returns TRUE. The file handle is returned by handle(). +.PP +Here is a code fragment that uses QTextStream to read a text file line by line. It prints each line with a line number. +.PP +.nf +.br + QStringList lines; +.br + QFile file( "file.txt" ); +.br + if ( file.open( IO_ReadOnly ) ) { +.br + QTextStream stream( &file ); +.br + QString line; +.br + int i = 1; +.br + while ( !stream.atEnd() ) { +.br + line = stream.readLine(); // line of text excluding '\\n' +.br + printf( "%3d: %s\\n", i++, line.latin1() ); +.br + lines += line; +.br + } +.br + file.close(); +.br + } +.br +.fi +.PP +Writing text is just as easy. The following example shows how to write the data we read into the string list from the previous example: +.PP +.nf +.br + QFile file( "file.txt" ); +.br + if ( file.open( IO_WriteOnly ) ) { +.br + QTextStream stream( &file ); +.br + for ( QStringList::Iterator it = lines.begin(); it != lines.end(); ++it ) +.br + stream << *it << "\\n"; +.br + file.close(); +.br + } +.br +.fi +.PP +The QFileInfo class holds detailed information about a file, such as access permissions, file dates and file types. +.PP +The QDir class manages directories and lists of file names. +.PP +Qt uses Unicode file names. If you want to do your own I/O on Unix systems you may want to use encodeName() (and decodeName()) to convert the file name into the local encoding. +.PP +See also QDataStream, QTextStream, and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QFile::DecoderFn" +This is used by QFile::setDecodingFunction(). +.SH "QFile::EncoderFn" +This is used by QFile::setEncodingFunction(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFile::QFile ()" +Constructs a QFile with no name. +.SH "QFile::QFile ( const QString & name )" +Constructs a QFile with a file name \fIname\fR. +.PP +See also setName(). +.SH "QFile::~QFile ()" +Destroys a QFile. Calls close(). +.SH "bool QFile::atEnd () const\fC [virtual]\fR" +Returns TRUE if the end of file has been reached; otherwise returns FALSE. If QFile has not been open()'d, then the behavior is undefined. +.PP +See also size(). +.PP +Example: distributor/distributor.ui.h. +.PP +Reimplemented from QIODevice. +.SH "void QFile::close ()\fC [virtual]\fR" +Closes an open file. +.PP +The file is not closed if it was opened with an existing file handle. If the existing file handle is a \fCFILE*\fR, the file is flushed. If the existing file handle is an \fCint\fR file descriptor, nothing is done to the file. +.PP +Some "write-behind" filesystems may report an unspecified error on closing the file. These errors only indicate that something may have gone wrong since the previous open(). In such a case status() reports IO_UnspecifiedError after close(), otherwise IO_Ok. +.PP +See also open() and flush(). +.PP +Examples: +.)l chart/chartform_files.cpp, distributor/distributor.ui.h, helpviewer/helpwindow.cpp, mdi/application.cpp, qdir/qdir.cpp, qwerty/qwerty.cpp, and xml/outliner/outlinetree.cpp. +.PP +Reimplemented from QIODevice. +.SH "QString QFile::decodeName ( const QCString & localFileName )\fC [static]\fR" +This does the reverse of QFile::encodeName() using \fIlocalFileName\fR. +.PP +See also setDecodingFunction(). +.PP +Example: distributor/distributor.ui.h. +.SH "QCString QFile::encodeName ( const QString & fileName )\fC [static]\fR" +When you use QFile, QFileInfo, and QDir to access the file system with Qt, you can use Unicode file names. On Unix, these file names are converted to an 8-bit encoding. If you want to do your own file I/O on Unix, you should convert the file name using this function. On Windows NT/2000, Unicode file names are supported directly in the file system and this function should be avoided. On Windows 95, non-Latin1 locales are not supported. +.PP +By default, this function converts \fIfileName\fR to the local 8-bit encoding determined by the user's locale. This is sufficient for file names that the user chooses. File names hard-coded into the application should only use 7-bit ASCII filename characters. +.PP +The conversion scheme can be changed using setEncodingFunction(). This might be useful if you wish to give the user an option to store file names in UTF-8, etc., but be aware that such file names would probably then be unrecognizable when seen by other programs. +.PP +See also decodeName(). +.PP +Example: distributor/distributor.ui.h. +.SH "QString QFile::errorString () const" +Returns a human-readable description of the reason of an error that occurred on the device. The error described by the string corresponds to changes of QIODevice::status(). If the status is reset, the error string is also reset. +.PP +The returned strings are not translated with the QObject::tr() or QApplication::translate() functions. They are marked as translatable strings in the "QFile" context. Before you show the string to the user you should translate it first, for example: +.PP +.nf +.br + QFile f( "address.dat" ); +.br + if ( !f.open( IO_ReadOnly ) { +.br + QMessageBox::critical( +.br + this, +.br + tr("Open failed"), +.br + tr("Could not open file for reading: %1").arg( tqApp->translate("QFile",f.errorString()) ) +.br + ); +.br + return; +.br + } +.br +.fi +.PP +See also QIODevice::status(), QIODevice::resetStatus(), and setErrorString(). +.SH "bool QFile::exists ( const QString & fileName )\fC [static]\fR" +Returns TRUE if the file given by \fIfileName\fR exists; otherwise returns FALSE. +.PP +Examples: +.)l chart/chartform.cpp, dirview/dirview.cpp, and helpviewer/helpwindow.cpp. +.SH "bool QFile::exists () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if this file exists; otherwise returns FALSE. +.PP +See also name(). +.SH "void QFile::flush ()\fC [virtual]\fR" +Flushes the file buffer to the disk. +.PP +close() also flushes the file buffer. +.PP +Reimplemented from QIODevice. +.SH "int QFile::getch ()\fC [virtual]\fR" +Reads a single byte/character from the file. +.PP +Returns the byte/character read, or -1 if the end of the file has been reached. +.PP +See also putch() and ungetch(). +.PP +Reimplemented from QIODevice. +.SH "int QFile::handle () const" +Returns the file handle of the file. +.PP +This is a small positive integer, suitable for use with C library functions such as fdopen() and fcntl(). On systems that use file descriptors for sockets (ie. Unix systems, but not Windows) the handle can be used with QSocketNotifier as well. +.PP +If the file is not open or there is an error, handle() returns -1. +.PP +See also QSocketNotifier. +.SH "QString QFile::name () const" +Returns the name set by setName(). +.PP +See also setName() and QFileInfo::fileName(). +.SH "bool QFile::open ( int m )\fC [virtual]\fR" +Opens the file specified by the file name currently set, using the mode \fIm\fR. Returns TRUE if successful, otherwise FALSE. +.PP + +.PP +The mode parameter \fIm\fR must be a combination of the following flags: <center>.nf +.TS +l - l. Flag Meaning IO_Raw Raw (non-buffered) file access. IO_ReadOnly Opens the file in read-only mode. IO_WriteOnly Opens the file in write-only mode. If this flag is used with another flag, e.g. IO_ReadOnly or IO_Raw or IO_Append, the file is \fInot\fR truncated; but if used on its own (or with IO_Truncate), the file is truncated. IO_ReadWrite Opens the file in read/write mode, equivalent to IO_Append Opens the file in append mode. (You must actually use IO_Truncate Truncates the file. IO_Translate +.TE +.fi +</center> +.PP +The raw access mode is best when I/O is block-operated using a 4KB block size or greater. Buffered access works better when reading small portions of data at a time. +.PP +\fBWarning:\fR When working with buffered files, data may not be written to the file at once. Call flush() to make sure that the data is really written. +.PP +\fBWarning:\fR If you have a buffered file opened for both reading and writing you must not perform an input operation immediately after an output operation or vice versa. You should always call flush() or a file positioning operation, e.g. at(), between input and output operations, otherwise the buffer may contain garbage. +.PP +If the file does not exist and IO_WriteOnly or IO_ReadWrite is specified, it is created. +.PP +Example: +.PP +.nf +.br + QFile f1( "/tmp/data.bin" ); +.br + f1.open( IO_Raw | IO_ReadWrite ); +.br +.br + QFile f2( "readme.txt" ); +.br + f2.open( IO_ReadOnly | IO_Translate ); +.br +.br + QFile f3( "audit.log" ); +.br + f3.open( IO_WriteOnly | IO_Append ); +.br +.fi +.PP +See also name(), close(), isOpen(), and flush(). +.PP +Examples: +.)l application/application.cpp, chart/chartform_files.cpp, distributor/distributor.ui.h, helpviewer/helpwindow.cpp, qdir/qdir.cpp, qwerty/qwerty.cpp, and xml/outliner/outlinetree.cpp. +.PP +Reimplemented from QIODevice. +.SH "bool QFile::open ( int m, FILE * f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Opens a file in the mode \fIm\fR using an existing file handle \fIf\fR. Returns TRUE if successful, otherwise FALSE. +.PP +Example: +.PP +.nf +.br + #include <stdio.h> +.br +.br + void printError( const char* msg ) +.br + { +.br + QFile f; +.br + f.open( IO_WriteOnly, stderr ); +.br + f.writeBlock( msg, tqstrlen(msg) ); // write to stderr +.br + f.close(); +.br + } +.br +.fi +.PP +When a QFile is opened using this function, close() does not actually close the file, only flushes it. +.PP +\fBWarning:\fR If \fIf\fR is \fCstdin\fR, \fCstdout\fR, \fCstderr\fR, you may not be able to seek. See QIODevice::isSequentialAccess() for more information. +.PP +See also close(). +.SH "bool QFile::open ( int m, int f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Opens a file in the mode \fIm\fR using an existing file descriptor \fIf\fR. Returns TRUE if successful, otherwise FALSE. +.PP +When a QFile is opened using this function, close() does not actually close the file. +.PP +The QFile that is opened using this function, is automatically set to be in raw mode; this means that the file input/output functions are slow. If you run into performance issues, you should try to use one of the other open functions. +.PP +\fBWarning:\fR If \fIf\fR is one of 0 (stdin), 1 (stdout) or 2 (stderr), you may not be able to seek. size() is set to \fCINT_MAX\fR (in limits.h). +.PP +See also close(). +.SH "int QFile::putch ( int ch )\fC [virtual]\fR" +Writes the character \fIch\fR to the file. +.PP +Returns \fIch\fR, or -1 if some error occurred. +.PP +See also getch() and ungetch(). +.PP +Reimplemented from QIODevice. +.SH "QByteArray QIODevice::readAll ()\fC [virtual]\fR" +This convenience function returns all of the remaining data in the device. +.SH "TQ_LONG QFile::readLine ( char * p, TQ_ULONG maxlen )\fC [virtual]\fR" +Reads a line of text. +.PP +Reads bytes from the file into the char* \fIp\fR, until end-of-line or \fImaxlen\fR bytes have been read, whichever occurs first. Returns the number of bytes read, or -1 if there was an error. Any terminating newline is not stripped. +.PP +This function is only efficient for buffered files. Avoid readLine() for files that have been opened with the IO_Raw flag. +.PP +See also readBlock() and QTextStream::readLine(). +.PP +Reimplemented from QIODevice. +.SH "TQ_LONG QFile::readLine ( QString & s, TQ_ULONG maxlen )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a line of text. +.PP +Reads bytes from the file into string \fIs\fR, until end-of-line or \fImaxlen\fR bytes have been read, whichever occurs first. Returns the number of bytes read, or -1 if there was an error, e.g. end of file. Any terminating newline is not stripped. +.PP +This function is only efficient for buffered files. Avoid using readLine() for files that have been opened with the IO_Raw flag. +.PP +Note that the string is read as plain Latin1 bytes, not Unicode. +.PP +See also readBlock() and QTextStream::readLine(). +.SH "bool QFile::remove ()" +Removes the file specified by the file name currently set. Returns TRUE if successful; otherwise returns FALSE. +.PP +The file is closed before it is removed. +.SH "bool QFile::remove ( const QString & fileName )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes the file \fIfileName\fR. Returns TRUE if successful, otherwise FALSE. +.SH "void QFile::setDecodingFunction ( DecoderFn f )\fC [static]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Sets the function for decoding 8-bit file names to \fIf\fR. The default uses the locale-specific 8-bit encoding. +.PP +See also encodeName() and decodeName(). +.SH "void QFile::setEncodingFunction ( EncoderFn f )\fC [static]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Sets the function for encoding Unicode file names to \fIf\fR. The default encodes in the locale-specific 8-bit encoding. +.PP +See also encodeName(). +.SH "void QFile::setErrorString ( const QString & str )\fC [protected]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Sets the error string returned by the errorString() function to \fIstr\fR. +.PP +See also errorString() and QIODevice::status(). +.SH "void QFile::setName ( const QString & name )" +Sets the name of the file to \fIname\fR. The name can have no path, a relative path or an absolute absolute path. +.PP +Do not call this function if the file has already been opened. +.PP +If the file name has no path or a relative path, the path used will be whatever the application's current directory path is \fIat the time of the open()\fR call. +.PP +Example: +.PP +.nf +.br + QFile file; +.br + QDir::setCurrent( "/tmp" ); +.br + file.setName( "readme.txt" ); +.br + QDir::setCurrent( "/home" ); +.br + file.open( IO_ReadOnly ); // opens "/home/readme.txt" under Unix +.br +.fi +.PP +Note that the directory separator "/" works for all operating systems supported by Qt. +.PP +See also name(), QFileInfo, and QDir. +.SH "Offset QFile::size () const\fC [virtual]\fR" +Returns the file size. +.PP +See also at(). +.PP +Example: table/statistics/statistics.cpp. +.PP +Reimplemented from QIODevice. +.SH "int QFile::ungetch ( int ch )\fC [virtual]\fR" +Puts the character \fIch\fR back into the file and decrements the index if it is not zero. +.PP +This function is normally called to "undo" a getch() operation. +.PP +Returns \fIch\fR, or -1 if an error occurred. +.PP +See also getch() and putch(). +.PP +Reimplemented from QIODevice. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfile.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfile.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfiledialog.3qt b/doc/man/man3/tqfiledialog.3qt new file mode 100644 index 000000000..108cf357a --- /dev/null +++ b/doc/man/man3/tqfiledialog.3qt @@ -0,0 +1,1025 @@ +'\" t +.TH QFileDialog 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 +QFileDialog \- Dialogs that allow users to select files or directories +.SH SYNOPSIS +\fC#include <ntqfiledialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFileDialog\fR ( const QString & dirName, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" +.br +.ti -1c +.BI "\fBQFileDialog\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" +.br +.ti -1c +.BI "\fB~QFileDialog\fR ()" +.br +.ti -1c +.BI "QString \fBselectedFile\fR () const" +.br +.ti -1c +.BI "QString \fBselectedFilter\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSelectedFilter\fR ( const QString & mask )" +.br +.ti -1c +.BI "virtual void \fBsetSelectedFilter\fR ( int n )" +.br +.ti -1c +.BI "void \fBsetSelection\fR ( const QString & filename )" +.br +.ti -1c +.BI "void \fBselectAll\fR ( bool b )" +.br +.ti -1c +.BI "QStringList \fBselectedFiles\fR () const" +.br +.ti -1c +.BI "QString \fBdirPath\fR () const" +.br +.ti -1c +.BI "void \fBsetDir\fR ( const QDir & dir )" +.br +.ti -1c +.BI "const QDir * \fBdir\fR () const" +.br +.ti -1c +.BI "void \fBsetShowHiddenFiles\fR ( bool s )" +.br +.ti -1c +.BI "bool \fBshowHiddenFiles\fR () const" +.br +.ti -1c +.BI "void \fBrereadDir\fR ()" +.br +.ti -1c +.BI "void \fBresortDir\fR ()" +.br +.ti -1c +.BI "enum \fBMode\fR { AnyFile, ExistingFile, Directory, ExistingFiles, DirectoryOnly }" +.br +.ti -1c +.BI "void \fBsetMode\fR ( Mode )" +.br +.ti -1c +.BI "Mode \fBmode\fR () const" +.br +.ti -1c +.BI "enum \fBViewMode\fR { Detail, List }" +.br +.ti -1c +.BI "enum \fBPreviewMode\fR { NoPreview, Contents, Info }" +.br +.ti -1c +.BI "void \fBsetViewMode\fR ( ViewMode m )" +.br +.ti -1c +.BI "ViewMode \fBviewMode\fR () const" +.br +.ti -1c +.BI "void \fBsetPreviewMode\fR ( PreviewMode m )" +.br +.ti -1c +.BI "PreviewMode \fBpreviewMode\fR () const" +.br +.ti -1c +.BI "bool \fBisInfoPreviewEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBisContentsPreviewEnabled\fR () const" +.br +.ti -1c +.BI "void \fBsetInfoPreviewEnabled\fR ( bool )" +.br +.ti -1c +.BI "void \fBsetContentsPreviewEnabled\fR ( bool )" +.br +.ti -1c +.BI "void \fBsetInfoPreview\fR ( QWidget * w, QFilePreview * preview )" +.br +.ti -1c +.BI "void \fBsetContentsPreview\fR ( QWidget * w, QFilePreview * preview )" +.br +.ti -1c +.BI "QUrl \fBurl\fR () const" +.br +.ti -1c +.BI "void \fBaddFilter\fR ( const QString & filter )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBsetDir\fR ( const QString & pathstr )" +.br +.ti -1c +.BI "void \fBsetUrl\fR ( const QUrlOperator & url )" +.br +.ti -1c +.BI "void \fBsetFilter\fR ( const QString & newFilter )" +.br +.ti -1c +.BI "void \fBsetFilters\fR ( const QString & filters )" +.br +.ti -1c +.BI "void \fBsetFilters\fR ( const char ** types )" +.br +.ti -1c +.BI "void \fBsetFilters\fR ( const QStringList & )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBfileHighlighted\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBfileSelected\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBfilesSelected\fR ( const QStringList & )" +.br +.ti -1c +.BI "void \fBdirEntered\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBfilterSelected\fR ( const QString & )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBgetOpenFileName\fR ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )" +.br +.ti -1c +.BI "QString \fBgetSaveFileName\fR ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )" +.br +.ti -1c +.BI "QString \fBgetExistingDirectory\fR ( const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, bool dirOnly = TRUE, bool resolveSymlinks = TRUE )" +.br +.ti -1c +.BI "QStringList \fBgetOpenFileNames\fR ( const QString & filter = QString::null, const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )" +.br +.ti -1c +.BI "void \fBsetIconProvider\fR ( QFileIconProvider * provider )" +.br +.ti -1c +.BI "QFileIconProvider * \fBiconProvider\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBcontentsPreview\fR - whether the file dialog can provide a contents preview of the currently selected file" +.br +.ti -1c +.BI "QString \fBdirPath\fR - the file dialog's working directory \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBinfoPreview\fR - whether the file dialog can provide preview information about the currently selected file" +.br +.ti -1c +.BI "Mode \fBmode\fR - the file dialog's mode" +.br +.ti -1c +.BI "PreviewMode \fBpreviewMode\fR - the preview mode for the file dialog" +.br +.ti -1c +.BI "QString \fBselectedFile\fR - the name of the selected file \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QStringList \fBselectedFiles\fR - the list of selected files \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QString \fBselectedFilter\fR - the filter which the user has selected in the file dialog \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBshowHiddenFiles\fR - whether hidden files are shown in the file dialog" +.br +.ti -1c +.BI "ViewMode \fBviewMode\fR - the file dialog's view mode" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBaddWidgets\fR ( QLabel * l, QWidget * w, QPushButton * b )" +.br +.ti -1c +.BI "void \fBaddToolButton\fR ( QButton * b, bool separator = FALSE )" +.br +.ti -1c +.BI "void \fBaddLeftWidget\fR ( QWidget * w )" +.br +.ti -1c +.BI "void \fBaddRightWidget\fR ( QWidget * w )" +.br +.in -1c +.SH DESCRIPTION +The QFileDialog class provides dialogs that allow users to select files or directories. +.PP +The QFileDialog class enables a user to traverse their file system in order to select one or many files or a directory. +.PP +The easiest way to create a QFileDialog is to use the static functions. On Windows, these static functions will call the native Windows file dialog and on Mac OS X, these static function will call the native Mac OS X file dialog. +.PP +.nf +.br + QString s = QFileDialog::getOpenFileName( +.br + "/home", +.br + "Images (*.png *.xpm *.jpg)", +.br + this, +.br + "open file dialog", +.br + "Choose a file" ); +.br +.fi +.PP +In the above example, a modal QFileDialog is created using a static function. The startup directory is set to "/home". The file filter is set to "Images (*.png *.xpm *.jpg)". The parent of the file dialog is set to \fIthis\fR and it is given the identification name - "open file dialog". The caption at the top of file dialog is set to "Choose a file". If you want to use multiple filters, separate each one with \fItwo\fR semi-colons, e.g. +.PP +.nf +.br + "Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)" +.br +.fi +.PP +You can create your own QFileDialog without using the static functions. By calling setMode(), you can set what can be returned by the QFileDialog. +.PP +.nf +.br + QFileDialog* fd = new QFileDialog( this, "file dialog", TRUE ); +.br + fd->setMode( QFileDialog::AnyFile ); +.br +.fi +.PP +In the above example, the mode of the file dialog is set to AnyFile, meaning that the user can select any file, or even specify a file that doesn't exist. This mode is useful for creating a "File Save As" file dialog. Use ExistingFile if the user must select an existing file or Directory if only a directory may be selected. (See the QFileDialog::Mode enum for the complete list of modes.) +.PP +You can retrieve the dialog's mode with mode(). Use setFilter() to set the dialog's file filter, e.g. +.PP +.nf +.br + fd->setFilter( "Images (*.png *.xpm *.jpg)" ); +.br +.fi +.PP +In the above example, the filter is set to "Images (*.png *.xpm *.jpg)", this means that only files with the extension \fCpng\fR, \fCxpm\fR or \fCjpg\fR will be shown in the QFileDialog. You can apply several filters by using setFilters() and add additional filters with addFilter(). Use setSelectedFilter() to select one of the filters you've given as the file dialog's default filter. Whenever the user changes the filter the filterSelected() signal is emitted. +.PP +The file dialog has two view modes, QFileDialog::List which simply lists file and directory names and QFileDialog::Detail which displays additional information alongside each name, e.g. file size, modification date, etc. Set the mode with setViewMode(). +.PP +.nf +.br + fd->setViewMode( QFileDialog::Detail ); +.br +.fi +.PP +The last important function you will need to use when creating your own file dialog is selectedFile(). +.PP +.nf +.br + QString fileName; +.br + if ( fd->exec() == QDialog::Accepted ) +.br + fileName = fd->selectedFile(); +.br +.fi +.PP +In the above example, a modal file dialog is created and shown. If the user clicked OK, then the file they selected is put in \fCfileName\fR. +.PP +If you are using the ExistingFiles mode then you will need to use selectedFiles() which will return the selected files in a QStringList. +.PP +The dialog's working directory can be set with setDir(). The display of hidden files is controlled with setShowHiddenFiles(). The dialog can be forced to re-read the directory with rereadDir() and re-sort the directory with resortDir(). All the files in the current directory can be selected with selectAll(). +.SH "Creating and using preview widgets" +There are two kinds of preview widgets that can be used with QFileDialogs: \fIcontent\fR preview widgets and \fIinformation\fR preview widgets. They are created and used in the same way except that the function names differ, e.g. setContentsPreview() and setInfoPreview(). +.PP +A preview widget is a widget that is placed inside a QFileDialog so that the user can see either the contents of the file, or information about the file. +.PP +.nf +.br + class Preview : public QLabel, public QFilePreview +.br + { +.br + public: +.br + Preview( QWidget *parent=0 ) : QLabel( parent ) {} +.br +.br + void previewUrl( const QUrl &u ) +.br + { +.br + QString path = u.path(); +.br + QPixmap pix( path ); +.br + if ( pix.isNull() ) +.br + setText( "This is not a pixmap" ); +.br + else +.br + setPixmap( pix ); +.br + } +.br + }; +.br +.fi +.PP +In the above snippet, we create a preview widget which inherits from QLabel and QFilePreview. File preview widgets \fImust\fR inherit from QFilePreview. +.PP +Inside the class we reimplement QFilePreview::previewUrl(), this is where we determine what happens when a file is selected. In the above example we only show a preview of the file if it is a valid pixmap. Here's how to make a file dialog use a preview widget: +.PP +.nf +.br + Preview* p = new Preview; +.br +.br + QFileDialog* fd = new QFileDialog( this ); +.br + fd->setContentsPreviewEnabled( TRUE ); +.br + fd->setContentsPreview( p, p ); +.br + fd->setPreviewMode( QFileDialog::Contents ); +.br + fd->show(); +.br +.fi +.PP +The first line creates an instance of our preview widget. We then create our file dialog and call setContentsPreviewEnabled( TRUE ), this tell the file dialog to preview the contents of the currently selected file. We then call setContentsPreview() -- note that we pass the same preview widget twice. Finally, before showing the file dialog, we call setPreviewMode() setting the mode to \fIContents\fR which will show the contents preview of the file that the user has selected. +.PP +If you create another preview widget that is used for displaying information about a file, create it in the same way as the contents preview widget and call setInfoPreviewEnabled(), and setInfoPreview(). Then the user will be able to switch between the two preview modes. +.PP +For more information about creating a QFilePreview widget see QFilePreview. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also Dialog Classes. +.SS "Member Type Documentation" +.SH "QFileDialog::Mode" +This enum is used to indicate what the user may select in the file dialog, i.e. what the dialog will return if the user clicks OK. +.TP +\fCQFileDialog::AnyFile\fR - The name of a file, whether it exists or not. +.TP +\fCQFileDialog::ExistingFile\fR - The name of a single existing file. +.TP +\fCQFileDialog::Directory\fR - The name of a directory. Both files and directories are displayed. +.TP +\fCQFileDialog::DirectoryOnly\fR - The name of a directory. The file dialog will only display directories. +.TP +\fCQFileDialog::ExistingFiles\fR - The names of zero or more existing files. +.PP +See setMode(). +.SH "QFileDialog::PreviewMode" +This enum describes the preview mode of the file dialog. +.TP +\fCQFileDialog::NoPreview\fR - No preview is shown at all. +.TP +\fCQFileDialog::Contents\fR - Show a preview of the contents of the current file using the contents preview widget. +.TP +\fCQFileDialog::Info\fR - Show information about the current file using the info preview widget. +.PP +See setPreviewMode(), setContentsPreview() and setInfoPreview(). +.SH "QFileDialog::ViewMode" +This enum describes the view mode of the file dialog, i.e. what information about each file will be displayed. +.TP +\fCQFileDialog::List\fR - Display file and directory names with icons. +.TP +\fCQFileDialog::Detail\fR - Display file and directory names with icons plus additional information, such as file size and modification date. +.PP +See setViewMode(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFileDialog::QFileDialog ( const QString & dirName, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" +Constructs a file dialog called \fIname\fR with the parent, \fIparent\fR. If \fImodal\fR is TRUE then the file dialog is modal; otherwise it is modeless. +.PP +If \fIdirName\fR is specified then it will be used as the dialog's working directory, i.e. it will be the directory that is shown when the dialog appears. If \fIfilter\fR is specified it will be used as the dialog's file filter. +.SH "QFileDialog::QFileDialog ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE )" +Constructs a file dialog called \fIname\fR, with the parent, \fIparent\fR. If \fImodal\fR is TRUE then the file dialog is modal; otherwise it is modeless. +.SH "QFileDialog::~QFileDialog ()" +Destroys the file dialog. +.SH "void QFileDialog::addFilter ( const QString & filter )" +Adds the filter \fIfilter\fR to the list of filters and makes it the current filter. +.PP +.nf +.br + QFileDialog* fd = new QFileDialog( this ); +.br + fd->addFilter( "Images (*.png *.jpg *.xpm)" ); +.br + fd->show(); +.br +.fi +.PP +In the above example, a file dialog is created, and the file filter "Images (*.png *.jpg *.xpm)" is added and is set as the current filter. The original filter, "All Files (*)", is still available. +.PP +See also setFilter() and setFilters(). +.SH "void QFileDialog::addLeftWidget ( QWidget * w )\fC [protected]\fR" +Adds the widget \fIw\fR to the left-hand side of the file dialog. +.PP +See also addRightWidget(), addWidgets(), and addToolButton(). +.SH "void QFileDialog::addRightWidget ( QWidget * w )\fC [protected]\fR" +Adds the widget \fIw\fR to the right-hand side of the file dialog. +.PP +See also addLeftWidget(), addWidgets(), and addToolButton(). +.SH "void QFileDialog::addToolButton ( QButton * b, bool separator = FALSE )\fC [protected]\fR" +Adds the tool button \fIb\fR to the row of tool buttons at the top of the file dialog. The button is appended to the right of this row. If \fIseparator\fR is TRUE, a small space is inserted between the last button of the row and the new button \fIb\fR. +.PP +See also addWidgets(), addLeftWidget(), and addRightWidget(). +.SH "void QFileDialog::addWidgets ( QLabel * l, QWidget * w, QPushButton * b )\fC [protected]\fR" +Adds the specified widgets to the bottom of the file dialog. The label \fIl\fR is placed underneath the "file name" and the "file types" labels. The widget \fIw\fR is placed underneath the file types combobox. The button \fIb\fR is placed underneath the Cancel pushbutton. +.PP +.nf +.br + MyFileDialog::MyFileDialog( QWidget* parent, const char* name ) : +.br + QFileDialog( parent, name ) +.br + { +.br + QLabel* label = new QLabel( "Added widgets", this ); +.br + QLineEdit* lineedit = new QLineEdit( this ); +.br + QPushButton* pushbutton = new QPushButton( this ); +.br +.br + addWidgets( label, lineedit, pushbutton ); +.br + } +.br +.fi +.PP +If you don't want to have one of the widgets added, pass 0 in that widget's position. +.PP +Every time you call this function, a new row of widgets will be added to the bottom of the file dialog. +.PP +See also addToolButton(), addLeftWidget(), and addRightWidget(). +.SH "const QDir * QFileDialog::dir () const" +Returns the current directory shown in the file dialog. +.PP +The ownership of the QDir pointer is transferred to the caller, so it must be deleted by the caller when no longer required. +.PP +See also setDir(). +.SH "void QFileDialog::dirEntered ( const QString & )\fC [signal]\fR" +This signal is emitted when the user enters a directory. +.PP +See also dir(). +.SH "QString QFileDialog::dirPath () const" +Returns the file dialog's working directory. See the "dirPath" property for details. +.SH "void QFileDialog::fileHighlighted ( const QString & )\fC [signal]\fR" +This signal is emitted when the user highlights a file, i.e. makes it the current file. +.PP +See also fileSelected() and filesSelected(). +.SH "void QFileDialog::fileSelected ( const QString & )\fC [signal]\fR" +This signal is emitted when the user selects a file. +.PP +See also filesSelected(), fileHighlighted(), and selectedFile. +.SH "void QFileDialog::filesSelected ( const QStringList & )\fC [signal]\fR" +This signal is emitted when the user selects one or more files in \fIExistingFiles\fR mode. +.PP +See also fileSelected(), fileHighlighted(), and selectedFiles. +.SH "void QFileDialog::filterSelected ( const QString & )\fC [signal]\fR" +This signal is emitted when the user selects a filter. +.PP +See also selectedFilter. +.SH "QString QFileDialog::getExistingDirectory ( const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, bool dirOnly = TRUE, bool resolveSymlinks = TRUE )\fC [static]\fR" +This is a convenience static function that will return an existing directory selected by the user. +.PP +.nf +.br + QString s = QFileDialog::getExistingDirectory( +.br + "/home", +.br + this, +.br + "get existing directory", +.br + "Choose a directory", +.br + TRUE ); +.br +.fi +.PP +This function creates a modal file dialog called \fIname\fR, with parent, \fIparent\fR. If parent is not 0, the dialog will be shown centered over the parent. +.PP +The dialog's working directory is set to \fIdir\fR, and the caption is set to \fIcaption\fR. Either of these may be QString::null in which case the current directory and a default caption will be used respectively. +.PP +Note on Windows that if \fIdir\fR is QString::null then the dialog's working directory will be set to the user's My Documents directory. +.PP +If \fIdirOnly\fR is TRUE, then only directories will be shown in the file dialog; otherwise both directories and files will be shown. +.PP +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +.PP +Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). +.PP +See also getOpenFileName(), getOpenFileNames(), and getSaveFileName(). +.SH "QString QFileDialog::getOpenFileName ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" +This is a convenience static function that returns an existing file selected by the user. If the user pressed Cancel, it returns a null string. +.PP +.nf +.br + QString s = QFileDialog::getOpenFileName( +.br + "/home", +.br + "Images (*.png *.xpm *.jpg)", +.br + this, +.br + "open file dialog", +.br + "Choose a file to open" ); +.br +.fi +.PP +The function creates a modal file dialog called \fIname\fR, with parent, \fIparent\fR. If a parent is not 0, the dialog will be shown centered over the parent. +.PP +The file dialog's working directory will be set to \fIstartWith\fR. If \fIstartWith\fR includes a file name, the file will be selected. The filter is set to \fIfilter\fR so that only those files which match the filter are shown. The filter selected is set to \fIselectedFilter\fR. The parameters \fIstartWith\fR, \fIselectedFilter\fR and \fIfilter\fR may be QString::null. +.PP +The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified then a default caption will be used. +.PP +Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). +.PP +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +.PP +See also getOpenFileNames(), getSaveFileName(), and getExistingDirectory(). +.PP +Examples: +.)l action/application.cpp, addressbook/mainwindow.cpp, application/application.cpp, distributor/distributor.ui.h, network/ftpclient/ftpmainwindow.ui.h, qwerty/qwerty.cpp, and showimg/showimg.cpp. +.SH "QStringList QFileDialog::getOpenFileNames ( const QString & filter = QString::null, const QString & dir = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" +This is a convenience static function that will return one or more existing files selected by the user. +.PP +.nf +.br + QStringList files = QFileDialog::getOpenFileNames( +.br + "Images (*.png *.xpm *.jpg)", +.br + "/home", +.br + this, +.br + "open files dialog", +.br + "Select one or more files to open" ); +.br +.fi +.PP +This function creates a modal file dialog called \fIname\fR, with parent \fIparent\fR. If \fIparent\fR is not 0, the dialog will be shown centered over the parent. +.PP +The file dialog's working directory will be set to \fIdir\fR. If \fIdir\fR includes a file name, the file will be selected. The filter is set to \fIfilter\fR so that only those files which match the filter are shown. The filter selected is set to \fIselectedFilter\fR. The parameters \fIdir\fR, \fIselectedFilter\fR and \fIfilter\fR may be QString::null. +.PP +The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified then a default caption will be used. +.PP +Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). +.PP +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +.PP +Note that if you want to iterate over the list of files, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = files; +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also getOpenFileName(), getSaveFileName(), and getExistingDirectory(). +.SH "QString QFileDialog::getSaveFileName ( const QString & startWith = QString::null, const QString & filter = QString::null, QWidget * parent = 0, const char * name = 0, const QString & caption = QString::null, QString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" +This is a convenience static function that will return a file name selected by the user. The file does not have to exist. +.PP +It creates a modal file dialog called \fIname\fR, with parent, \fIparent\fR. If a parent is not 0, the dialog will be shown centered over the parent. +.PP +.nf +.br + QString s = QFileDialog::getSaveFileName( +.br + "/home", +.br + "Images (*.png *.xpm *.jpg)", +.br + this, +.br + "save file dialog", +.br + "Choose a filename to save under" ); +.br +.fi +.PP +The file dialog's working directory will be set to \fIstartWith\fR. If \fIstartWith\fR includes a file name, the file will be selected. The filter is set to \fIfilter\fR so that only those files which match the filter are shown. The filter selected is set to \fIselectedFilter\fR. The parameters \fIstartWith\fR, \fIselectedFilter\fR and \fIfilter\fR may be QString::null. +.PP +The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified then a default caption will be used. +.PP +Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar. +.PP +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +.PP +See also getOpenFileName(), getOpenFileNames(), and getExistingDirectory(). +.PP +Examples: +.)l action/application.cpp, addressbook/mainwindow.cpp, application/application.cpp, network/ftpclient/ftpmainwindow.ui.h, qmag/qmag.cpp, qwerty/qwerty.cpp, and showimg/showimg.cpp. +.SH "QFileIconProvider * QFileDialog::iconProvider ()\fC [static]\fR" +Returns a pointer to the icon provider currently set on the file dialog. By default there is no icon provider, and this function returns 0. +.PP +See also setIconProvider() and QFileIconProvider. +.SH "bool QFileDialog::isContentsPreviewEnabled () const" +Returns TRUE if the file dialog can provide a contents preview of the currently selected file; otherwise returns FALSE. See the "contentsPreview" property for details. +.SH "bool QFileDialog::isInfoPreviewEnabled () const" +Returns TRUE if the file dialog can provide preview information about the currently selected file; otherwise returns FALSE. See the "infoPreview" property for details. +.SH "Mode QFileDialog::mode () const" +Returns the file dialog's mode. See the "mode" property for details. +.SH "PreviewMode QFileDialog::previewMode () const" +Returns the preview mode for the file dialog. See the "previewMode" property for details. +.SH "void QFileDialog::rereadDir ()" +Rereads the current directory shown in the file dialog. +.PP +The only time you will need to call this function is if the contents of the directory change and you wish to refresh the file dialog to reflect the change. +.PP +See also resortDir(). +.SH "void QFileDialog::resortDir ()" +Re-sorts the displayed directory. +.PP +See also rereadDir(). +.SH "void QFileDialog::selectAll ( bool b )" +If \fIb\fR is TRUE then all the files in the current directory are selected; otherwise, they are deselected. +.SH "QString QFileDialog::selectedFile () const" +Returns the name of the selected file. See the "selectedFile" property for details. +.SH "QStringList QFileDialog::selectedFiles () const" +Returns the list of selected files. See the "selectedFiles" property for details. +.SH "QString QFileDialog::selectedFilter () const" +Returns the filter which the user has selected in the file dialog. See the "selectedFilter" property for details. +.SH "void QFileDialog::setContentsPreview ( QWidget * w, QFilePreview * preview )" +Sets the widget to be used for displaying the contents of the file to the widget \fIw\fR and a preview of those contents to the QFilePreview \fIpreview\fR. +.PP +Normally you would create a preview widget that derives from both QWidget and QFilePreview, so you should pass the same widget twice. If you don't, you must remember to delete the preview object in order to avoid memory leaks. +.PP +.nf +.br + class Preview : public QLabel, public QFilePreview +.br + { +.br + public: +.br + Preview( QWidget *parent=0 ) : QLabel( parent ) {} +.br +.br + void previewUrl( const QUrl &u ) +.br + { +.br + QString path = u.path(); +.br + QPixmap pix( path ); +.br + if ( pix.isNull() ) +.br + setText( "This is not a pixmap" ); +.br + else +.br + setPixmap( pix ); +.br + } +.br + }; +.br +.br + //... +.br +.br + int main( int argc, char** argv ) +.br + { +.br + Preview* p = new Preview; +.br +.br + QFileDialog* fd = new QFileDialog( this ); +.br + fd->setContentsPreviewEnabled( TRUE ); +.br + fd->setContentsPreview( p, p ); +.br + fd->setPreviewMode( QFileDialog::Contents ); +.br + fd->show(); +.br + } +.br +.fi +.PP +See also contentsPreview, setInfoPreview(), and previewMode. +.PP +Example: qdir/qdir.cpp. +.SH "void QFileDialog::setContentsPreviewEnabled ( bool )" +Sets whether the file dialog can provide a contents preview of the currently selected file. See the "contentsPreview" property for details. +.SH "void QFileDialog::setDir ( const QDir & dir )" +Sets the file dialog's working directory to \fIdir\fR. +.PP +See also dir(). +.SH "void QFileDialog::setDir ( const QString & pathstr )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the file dialog's working directory to \fIpathstr\fR. +.PP +See also dir(). +.SH "void QFileDialog::setFilter ( const QString & newFilter )\fC [slot]\fR" +Sets the filter used in the file dialog to \fInewFilter\fR. +.PP +If \fInewFilter\fR contains a pair of parentheses containing one or more of \fI\fBanything*something\fR\fR separated by spaces or by semi-colons then only the text contained in the parentheses is used as the filter. This means that these calls are all equivalent: +.PP +.nf +.br + fd->setFilter( "All C++ files (*.cpp *.cc *.C *.cxx *.c++)" ); +.br + fd->setFilter( "*.cpp *.cc *.C *.cxx *.c++" ); +.br + fd->setFilter( "All C++ files (*.cpp;*.cc;*.C;*.cxx;*.c++)" ); +.br + fd->setFilter( "*.cpp;*.cc;*.C;*.cxx;*.c++" ); +.br +.fi +.PP +See also setFilters(). +.SH "void QFileDialog::setFilters ( const QString & filters )\fC [slot]\fR" +Sets the filters used in the file dialog to \fIfilters\fR. Each group of filters must be separated by \fC;;\fR (\fItwo\fR semi-colons). +.PP +.nf +.br + QString types("Image files (*.png *.xpm *.jpg);;" +.br + "Text files (*.txt);;" +.br + "Any files (*)"); +.br + QFileDialog fd = new QFileDialog( this ); +.br + fd->setFilters( types ); +.br + fd->show(); +.br +.fi +.SH "void QFileDialog::setFilters ( const char ** types )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fItypes\fR must be a null-terminated list of strings. +.SH "void QFileDialog::setFilters ( const QStringList & )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QFileDialog::setIconProvider ( QFileIconProvider * provider )\fC [static]\fR" +Sets the QFileIconProvider used by the file dialog to \fIprovider\fR. +.PP +The default is that there is no QFileIconProvider and QFileDialog just draws a folder icon next to each directory and nothing next to files. +.PP +See also QFileIconProvider and iconProvider(). +.PP +Example: showimg/main.cpp. +.SH "void QFileDialog::setInfoPreview ( QWidget * w, QFilePreview * preview )" +Sets the widget to be used for displaying information about the file to the widget \fIw\fR and a preview of that information to the QFilePreview \fIpreview\fR. +.PP +Normally you would create a preview widget that derives from both QWidget and QFilePreview, so you should pass the same widget twice. If you don't, you must remember to delete the preview object in order to avoid memory leaks. +.PP +.nf +.br + class Preview : public QLabel, public QFilePreview +.br + { +.br + public: +.br + Preview( QWidget *parent=0 ) : QLabel( parent ) {} +.br +.br + void previewUrl( const QUrl &u ) +.br + { +.br + QString path = u.path(); +.br + QPixmap pix( path ); +.br + if ( pix.isNull() ) +.br + setText( "This is not a pixmap" ); +.br + else +.br + setText( "This is a pixmap" ); +.br + } +.br + }; +.br +.br + //... +.br +.br + int main( int argc, char** argv ) +.br + { +.br + Preview* p = new Preview; +.br +.br + QFileDialog* fd = new QFileDialog( this ); +.br + fd->setInfoPreviewEnabled( TRUE ); +.br + fd->setInfoPreview( p, p ); +.br + fd->setPreviewMode( QFileDialog::Info ); +.br + fd->show(); +.br + } +.br +.br +.fi +.PP +See also setContentsPreview(), infoPreview, and previewMode. +.SH "void QFileDialog::setInfoPreviewEnabled ( bool )" +Sets whether the file dialog can provide preview information about the currently selected file. See the "infoPreview" property for details. +.SH "void QFileDialog::setMode ( Mode )" +Sets the file dialog's mode. See the "mode" property for details. +.SH "void QFileDialog::setPreviewMode ( PreviewMode m )" +Sets the preview mode for the file dialog to \fIm\fR. See the "previewMode" property for details. +.SH "void QFileDialog::setSelectedFilter ( const QString & mask )\fC [virtual]\fR" +Sets the current filter selected in the file dialog to the first one that contains the text \fImask\fR. +.SH "void QFileDialog::setSelectedFilter ( int n )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the current filter selected in the file dialog to the \fIn\fR-th filter in the filter list. +.PP +See also filterSelected(), selectedFilter, selectedFiles, and selectedFile. +.SH "void QFileDialog::setSelection ( const QString & filename )" +Sets the default selection to \fIfilename\fR. If \fIfilename\fR is absolute, setDir() is also called to set the file dialog's working directory to the filename's directory. +.PP +Example: qdir/qdir.cpp. +.SH "void QFileDialog::setShowHiddenFiles ( bool s )" +Sets whether hidden files are shown in the file dialog to \fIs\fR. See the "showHiddenFiles" property for details. +.SH "void QFileDialog::setUrl ( const QUrlOperator & url )\fC [slot]\fR" +Sets the file dialog's working directory to the directory specified at \fIurl\fR. +.PP +See also url(). +.SH "void QFileDialog::setViewMode ( ViewMode m )" +Sets the file dialog's view mode to \fIm\fR. See the "viewMode" property for details. +.SH "bool QFileDialog::showHiddenFiles () const" +Returns TRUE if hidden files are shown in the file dialog; otherwise returns FALSE. See the "showHiddenFiles" property for details. +.SH "QUrl QFileDialog::url () const" +Returns the URL of the current working directory in the file dialog. +.PP +See also setUrl(). +.PP +Example: network/networkprotocol/view.cpp. +.SH "ViewMode QFileDialog::viewMode () const" +Returns the file dialog's view mode. See the "viewMode" property for details. +.SS "Property Documentation" +.SH "bool contentsPreview" +This property holds whether the file dialog can provide a contents preview of the currently selected file. +.PP +The default is FALSE. +.PP +See also setContentsPreview() and infoPreview. +.PP +Set this property's value with setContentsPreviewEnabled() and get this property's value with isContentsPreviewEnabled(). +.SH "QString dirPath" +This property holds the file dialog's working directory. +.PP +Get this property's value with dirPath(). +.PP +See also dir() and setDir(). +.SH "bool infoPreview" +This property holds whether the file dialog can provide preview information about the currently selected file. +.PP +The default is FALSE. +.PP +Set this property's value with setInfoPreviewEnabled() and get this property's value with isInfoPreviewEnabled(). +.SH "Mode mode" +This property holds the file dialog's mode. +.PP +The default mode is ExistingFile. +.PP +Set this property's value with setMode() and get this property's value with mode(). +.SH "PreviewMode previewMode" +This property holds the preview mode for the file dialog. +.PP +If you set the mode to be a mode other than \fINoPreview\fR, you must use setInfoPreview() or setContentsPreview() to set the dialog's preview widget to your preview widget and enable the preview widget(s) with setInfoPreviewEnabled() or setContentsPreviewEnabled(). +.PP +See also infoPreview, contentsPreview, and viewMode. +.PP +Set this property's value with setPreviewMode() and get this property's value with previewMode(). +.SH "QString selectedFile" +This property holds the name of the selected file. +.PP +If a file was selected selectedFile contains the file's name including its absolute path; otherwise selectedFile is empty. +.PP +See also QString::isEmpty(), selectedFiles, and selectedFilter. +.PP +Get this property's value with selectedFile(). +.SH "QStringList selectedFiles" +This property holds the list of selected files. +.PP +If one or more files are selected, selectedFiles contains their names including their absolute paths. If no files are selected or the mode isn't ExistingFiles selectedFiles is an empty list. +.PP +It is more convenient to use selectedFile() if the mode is ExistingFile, Directory or DirectoryOnly. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myFileDialog.selectedFiles(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also selectedFile, selectedFilter, and QValueList::empty(). +.PP +Get this property's value with selectedFiles(). +.SH "QString selectedFilter" +This property holds the filter which the user has selected in the file dialog. +.PP +Get this property's value with selectedFilter(). +.PP +See also filterSelected(), selectedFiles, and selectedFile. +.SH "bool showHiddenFiles" +This property holds whether hidden files are shown in the file dialog. +.PP +The default is FALSE, i.e. don't show hidden files. +.PP +Set this property's value with setShowHiddenFiles() and get this property's value with showHiddenFiles(). +.SH "ViewMode viewMode" +This property holds the file dialog's view mode. +.PP +If you set the view mode to be \fIDetail\fR (the default), then you will see the file's details, such as the size of the file and the date the file was last modified in addition to the file's name. +.PP +If you set the view mode to be \fIList\fR, then you will just see a list of the files and folders. +.PP +See QFileDialog::ViewMode +.PP +Set this property's value with setViewMode() and get this property's value with viewMode(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfiledialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfiledialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfileiconprovider.3qt b/doc/man/man3/tqfileiconprovider.3qt new file mode 100644 index 000000000..395323bc9 --- /dev/null +++ b/doc/man/man3/tqfileiconprovider.3qt @@ -0,0 +1,68 @@ +'\" t +.TH QFileIconProvider 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 +QFileIconProvider \- Icons for QFileDialog to use +.SH SYNOPSIS +\fC#include <ntqfiledialog.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFileIconProvider\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual const QPixmap * \fBpixmap\fR ( const QFileInfo & info )" +.br +.in -1c +.SH DESCRIPTION +The QFileIconProvider class provides icons for QFileDialog to use. +.PP +By default QFileIconProvider is not used, but any application or library can subclass it, reimplement pixmap() to return a suitable icon, and make all QFileDialog objects use it by calling the static function QFileDialog::setIconProvider(). +.PP +It is advisable to make all the icons that QFileIconProvider returns be the same size or at least the same width. This makes the list view look much better. +.PP +See also QFileDialog and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFileIconProvider::QFileIconProvider ( QObject * parent = 0, const char * name = 0 )" +Constructs an empty file icon provider called \fIname\fR, with the parent \fIparent\fR. +.SH "const QPixmap * QFileIconProvider::pixmap ( const QFileInfo & info )\fC [virtual]\fR" +Returns a pointer to a pixmap that should be used to signify the file with the information \fIinfo\fR. +.PP +If pixmap() returns 0, QFileDialog draws the default pixmap. +.PP +The default implementation returns particular icons for files, directories, link-files and link-directories. It returns a blank "icon" for other types. +.PP +If you return a pixmap here, it should measure 16x16 pixels. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qfileiconprovider.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfileiconprovider.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfileinfo.3qt b/doc/man/man3/tqfileinfo.3qt new file mode 100644 index 000000000..c99285715 --- /dev/null +++ b/doc/man/man3/tqfileinfo.3qt @@ -0,0 +1,537 @@ +'\" t +.TH QFileInfo 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 +QFileInfo \- System-independent file information +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqfileinfo.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBPermissionSpec\fR { ReadOwner = 04000, WriteOwner = 02000, ExeOwner = 01000, ReadUser = 00400, WriteUser = 00200, ExeUser = 00100, ReadGroup = 00040, WriteGroup = 00020, ExeGroup = 00010, ReadOther = 00004, WriteOther = 00002, ExeOther = 00001 }" +.br +.ti -1c +.BI "\fBQFileInfo\fR ()" +.br +.ti -1c +.BI "\fBQFileInfo\fR ( const QString & file )" +.br +.ti -1c +.BI "\fBQFileInfo\fR ( const QFile & file )" +.br +.ti -1c +.BI "\fBQFileInfo\fR ( const QDir & d, const QString & fileName )" +.br +.ti -1c +.BI "\fBQFileInfo\fR ( const QFileInfo & fi )" +.br +.ti -1c +.BI "\fB~QFileInfo\fR ()" +.br +.ti -1c +.BI "QFileInfo & \fBoperator=\fR ( const QFileInfo & fi )" +.br +.ti -1c +.BI "void \fBsetFile\fR ( const QString & file )" +.br +.ti -1c +.BI "void \fBsetFile\fR ( const QFile & file )" +.br +.ti -1c +.BI "void \fBsetFile\fR ( const QDir & d, const QString & fileName )" +.br +.ti -1c +.BI "bool \fBexists\fR () const" +.br +.ti -1c +.BI "void \fBrefresh\fR () const" +.br +.ti -1c +.BI "bool \fBcaching\fR () const" +.br +.ti -1c +.BI "void \fBsetCaching\fR ( bool enable )" +.br +.ti -1c +.BI "QString \fBfilePath\fR () const" +.br +.ti -1c +.BI "QString \fBfileName\fR () const" +.br +.ti -1c +.BI "QString \fBabsFilePath\fR () const" +.br +.ti -1c +.BI "QString \fBbaseName\fR ( bool complete = FALSE ) const" +.br +.ti -1c +.BI "QString \fBextension\fR ( bool complete = TRUE ) const" +.br +.ti -1c +.BI "QString \fBdirPath\fR ( bool absPath = FALSE ) const" +.br +.ti -1c +.BI "QDir \fBdir\fR ( bool absPath = FALSE ) const" +.br +.ti -1c +.BI "bool \fBisReadable\fR () const" +.br +.ti -1c +.BI "bool \fBisWritable\fR () const" +.br +.ti -1c +.BI "bool \fBisExecutable\fR () const" +.br +.ti -1c +.BI "bool \fBisHidden\fR () const" +.br +.ti -1c +.BI "bool \fBisRelative\fR () const" +.br +.ti -1c +.BI "bool \fBconvertToAbs\fR ()" +.br +.ti -1c +.BI "bool \fBisFile\fR () const" +.br +.ti -1c +.BI "bool \fBisDir\fR () const" +.br +.ti -1c +.BI "bool \fBisSymLink\fR () const" +.br +.ti -1c +.BI "QString \fBreadLink\fR () const" +.br +.ti -1c +.BI "QString \fBowner\fR () const" +.br +.ti -1c +.BI "uint \fBownerId\fR () const" +.br +.ti -1c +.BI "QString \fBgroup\fR () const" +.br +.ti -1c +.BI "uint \fBgroupId\fR () const" +.br +.ti -1c +.BI "bool \fBpermission\fR ( int permissionSpec ) const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "QDateTime \fBcreated\fR () const" +.br +.ti -1c +.BI "QDateTime \fBlastModified\fR () const" +.br +.ti -1c +.BI "QDateTime \fBlastRead\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QFileInfo class provides system-independent file information. +.PP +QFileInfo provides information about a file's name and position (path) in the file system, its access rights and whether it is a directory or symbolic link, etc. The file's size and last modified/read times are also available. +.PP +A QFileInfo can point to a file with either a relative or an absolute file path. Absolute file paths begin with the directory separator "/" (or with a drive specification on Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current working directory. An example of an absolute path is the string "/tmp/quartz". A relative path might look like "src/fatlib". You can use the function isRelative() to check whether a QFileInfo is using a relative or an absolute file path. You can call the function convertToAbs() to convert a relative QFileInfo's path to an absolute path. +.PP +The file that the QFileInfo works on is set in the constructor or later with setFile(). Use exists() to see if the file exists and size() to get its size. +.PP +To speed up performance, QFileInfo caches information about the file. Because files can be changed by other users or programs, or even by other parts of the same program, there is a function that refreshes the file information: refresh(). If you want to switch off a QFileInfo's caching and force it to access the file system every time you request information from it call setCaching(FALSE). +.PP +The file's type is obtained with isFile(), isDir() and isSymLink(). The readLink() function provides the name of the file the symlink points to. +.PP +Elements of the file's name can be extracted with dirPath() and fileName(). The fileName()'s parts can be extracted with baseName() and extension(). +.PP +The file's dates are returned by created(), lastModified() and lastRead(). Information about the file's access permissions is obtained with isReadable(), isWritable() and isExecutable(). The file's ownership is available from owner(), ownerId(), group() and groupId(). You can examine a file's permissions and ownership in a single statement using the permission() function. +.PP +If you need to read and traverse directories, see the QDir class. +.PP +See also Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QFileInfo::PermissionSpec" +This enum is used by the permission() function to report the permissions and ownership of a file. The values may be OR-ed together to test multiple permissions and ownership values. +.TP +\fCQFileInfo::ReadOwner\fR - The file is readable by the owner of the file. +.TP +\fCQFileInfo::WriteOwner\fR - The file is writable by the owner of the file. +.TP +\fCQFileInfo::ExeOwner\fR - The file is executable by the owner of the file. +.TP +\fCQFileInfo::ReadUser\fR - The file is readable by the user. +.TP +\fCQFileInfo::WriteUser\fR - The file is writable by the user. +.TP +\fCQFileInfo::ExeUser\fR - The file is executable by the user. +.TP +\fCQFileInfo::ReadGroup\fR - The file is readable by the group. +.TP +\fCQFileInfo::WriteGroup\fR - The file is writable by the group. +.TP +\fCQFileInfo::ExeGroup\fR - The file is executable by the group. +.TP +\fCQFileInfo::ReadOther\fR - The file is readable by anyone. +.TP +\fCQFileInfo::WriteOther\fR - The file is writable by anyone. +.TP +\fCQFileInfo::ExeOther\fR - The file is executable by anyone. +.PP +\fBWarning:\fR The semantics of ReadUser, WriteUser and ExeUser are unfortunately not platform independent: on Unix, the rights of the owner of the file are returned and on Windows the rights of the current user are returned. This behavior might change in a future Qt version. If you want to find the rights of the owner of the file, you should use the flags ReadOwner, WriteOwner and ExeOwner. If you want to find out the rights of the current user, you should use isReadable(), isWritable() and isExecutable(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFileInfo::QFileInfo ()" +Constructs a new empty QFileInfo. +.SH "QFileInfo::QFileInfo ( const QString & file )" +Constructs a new QFileInfo that gives information about the given file. The \fIfile\fR can also include an absolute or relative path. +.PP +\fBWarning:\fR Some functions might behave in a counter-intuitive way if \fIfile\fR has a trailing directory separator. +.PP +See also setFile(), isRelative(), QDir::setCurrent(), and QDir::isRelativePath(). +.SH "QFileInfo::QFileInfo ( const QFile & file )" +Constructs a new QFileInfo that gives information about file \fIfile\fR. +.PP +If the \fIfile\fR has a relative path, the QFileInfo will also have a relative path. +.PP +See also isRelative(). +.SH "QFileInfo::QFileInfo ( const QDir & d, const QString & fileName )" +Constructs a new QFileInfo that gives information about the file called \fIfileName\fR in the directory \fId\fR. +.PP +If \fId\fR has a relative path, the QFileInfo will also have a relative path. +.PP +See also isRelative(). +.SH "QFileInfo::QFileInfo ( const QFileInfo & fi )" +Constructs a new QFileInfo that is a copy of \fIfi\fR. +.SH "QFileInfo::~QFileInfo ()" +Destroys the QFileInfo and frees its resources. +.SH "QString QFileInfo::absFilePath () const" +Returns the absolute path including the file name. +.PP +The absolute path name consists of the full path and the file name. On Unix this will always begin with the root, '/', directory. On Windows this will always begin 'D:/' where D is a drive letter, except for network shares that are not mapped to a drive letter, in which case the path will begin '//sharename/'. +.PP +This function returns the same as filePath(), unless isRelative() is TRUE. +.PP +If the QFileInfo is empty it returns QDir::currentDirPath(). +.PP +This function can be time consuming under Unix (in the order of milliseconds). +.PP +See also isRelative() and filePath(). +.PP +Examples: +.)l biff/biff.cpp and fileiconview/qfileiconview.cpp. +.SH "QString QFileInfo::baseName ( bool complete = FALSE ) const" +Returns the base name of the file. +.PP +If \fIcomplete\fR is FALSE (the default) the base name consists of all characters in the file name up to (but not including) the \fIfirst\fR '.' character. +.PP +If \fIcomplete\fR is TRUE the base name consists of all characters in the file up to (but not including) the \fIlast\fR '.' character. +.PP +The path is not included in either case. +.PP +Example: +.PP +.nf +.br + QFileInfo fi( "/tmp/archive.tar.gz" ); +.br + QString base = fi.baseName(); // base = "archive" +.br + base = fi.baseName( TRUE ); // base = "archive.tar" +.br +.fi +.PP +See also fileName() and extension(). +.SH "bool QFileInfo::caching () const" +Returns TRUE if caching is enabled; otherwise returns FALSE. +.PP +See also setCaching() and refresh(). +.SH "bool QFileInfo::convertToAbs ()" +Converts the file's path to an absolute path. +.PP +If it is already absolute, nothing is done. +.PP +See also filePath() and isRelative(). +.SH "QDateTime QFileInfo::created () const" +Returns the date and time when the file was created. +.PP +On platforms where this information is not available, returns the same as lastModified(). +.PP +See also lastModified() and lastRead(). +.SH "QDir QFileInfo::dir ( bool absPath = FALSE ) const" +Returns the file's path as a QDir object. +.PP +If the QFileInfo is relative and \fIabsPath\fR is FALSE, the QDir will be relative; otherwise it will be absolute. +.PP +See also dirPath(), filePath(), fileName(), and isRelative(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QString QFileInfo::dirPath ( bool absPath = FALSE ) const" +Returns the file's path. +.PP +If \fIabsPath\fR is TRUE an absolute path is returned. +.PP +See also dir(), filePath(), fileName(), and isRelative(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QFileInfo::exists () const" +Returns TRUE if the file exists; otherwise returns FALSE. +.PP +Examples: +.)l biff/biff.cpp, distributor/distributor.ui.h, and i18n/main.cpp. +.SH "QString QFileInfo::extension ( bool complete = TRUE ) const" +Returns the file's extension name. +.PP +If \fIcomplete\fR is TRUE (the default), extension() returns the string of all characters in the file name after (but not including) the first '.' character. +.PP +If \fIcomplete\fR is FALSE, extension() returns the string of all characters in the file name after (but not including) the last '.' character. +.PP +Example: +.PP +.nf +.br + QFileInfo fi( "/tmp/archive.tar.gz" ); +.br + QString ext = fi.extension(); // ext = "tar.gz" +.br + ext = fi.extension( FALSE ); // ext = "gz" +.br +.fi +.PP +See also fileName() and baseName(). +.PP +Example: qdir/qdir.cpp. +.SH "QString QFileInfo::fileName () const" +Returns the name of the file, excluding the path. +.PP +Example: +.PP +.nf +.br + QFileInfo fi( "/tmp/archive.tar.gz" ); +.br + QString name = fi.fileName(); // name = "archive.tar.gz" +.br +.fi +.PP +See also isRelative(), filePath(), baseName(), and extension(). +.PP +Examples: +.)l dirview/dirview.cpp, fileiconview/qfileiconview.cpp, and network/ftpclient/ftpmainwindow.ui.h. +.SH "QString QFileInfo::filePath () const" +Returns the file name, including the path (which may be absolute or relative). +.PP +See also isRelative() and absFilePath(). +.PP +Examples: +.)l dirview/main.cpp and fileiconview/qfileiconview.cpp. +.SH "QString QFileInfo::group () const" +Returns the group of the file. On Windows, on systems where files do not have groups, or if an error occurs, QString::null is returned. +.PP +This function can be time consuming under Unix (in the order of milliseconds). +.PP +See also groupId(), owner(), and ownerId(). +.SH "uint QFileInfo::groupId () const" +Returns the id of the group the file belongs to. +.PP +On Windows and on systems where files do not have groups this function always returns (uint) -2. +.PP +See also group(), owner(), and ownerId(). +.SH "bool QFileInfo::isDir () const" +Returns TRUE if this object points to a directory or to a symbolic link to a directory; otherwise returns FALSE. +.PP +See also isFile() and isSymLink(). +.PP +Examples: +.)l dirview/dirview.cpp and fileiconview/qfileiconview.cpp. +.SH "bool QFileInfo::isExecutable () const" +Returns TRUE if the file is executable; otherwise returns FALSE. +.PP +See also isReadable(), isWritable(), and permission(). +.SH "bool QFileInfo::isFile () const" +Returns TRUE if this object points to a file. Returns FALSE if the object points to something which isn't a file, e.g. a directory or a symlink. +.PP +See also isDir() and isSymLink(). +.PP +Examples: +.)l dirview/dirview.cpp, distributor/distributor.ui.h, fileiconview/qfileiconview.cpp, and qdir/qdir.cpp. +.SH "bool QFileInfo::isHidden () const" +Returns TRUE if the file is hidden; otherwise returns FALSE. +.PP +On Unix-like operating systems, including Mac OS X, a file is hidden if its name begins with ".". On Windows a file is hidden if its hidden attribute is set. +.SH "bool QFileInfo::isReadable () const" +Returns TRUE if the file is readable; otherwise returns FALSE. +.PP +See also isWritable(), isExecutable(), and permission(). +.PP +Example: distributor/distributor.ui.h. +.SH "bool QFileInfo::isRelative () const" +Returns TRUE if the file path name is relative. Returns FALSE if the path is absolute (e.g. under Unix a path is absolute if it begins with a "/"). +.SH "bool QFileInfo::isSymLink () const" +Returns TRUE if this object points to a symbolic link (or to a shortcut on Windows, or an alias on Mac OS X); otherwise returns FALSE. +.PP +See also isFile(), isDir(), and readLink(). +.PP +Examples: +.)l dirview/dirview.cpp, distributor/distributor.ui.h, and fileiconview/qfileiconview.cpp. +.SH "bool QFileInfo::isWritable () const" +Returns TRUE if the file is writable; otherwise returns FALSE. +.PP +See also isReadable(), isExecutable(), and permission(). +.PP +Example: distributor/distributor.ui.h. +.SH "QDateTime QFileInfo::lastModified () const" +Returns the date and time when the file was last modified. +.PP +See also created() and lastRead(). +.PP +Example: biff/biff.cpp. +.SH "QDateTime QFileInfo::lastRead () const" +Returns the date and time when the file was last read (accessed). +.PP +On platforms where this information is not available, returns the same as lastModified(). +.PP +See also created() and lastModified(). +.PP +Example: biff/biff.cpp. +.SH "QFileInfo & QFileInfo::operator= ( const QFileInfo & fi )" +Makes a copy of \fIfi\fR and assigns it to this QFileInfo. +.SH "QString QFileInfo::owner () const" +Returns the owner of the file. On systems where files do not have owners, or if an error occurs, QString::null is returned. +.PP +This function can be time consuming under Unix (in the order of milliseconds). +.PP +See also ownerId(), group(), and groupId(). +.SH "uint QFileInfo::ownerId () const" +Returns the id of the owner of the file. +.PP +On Windows and on systems where files do not have owners this function returns ((uint) -2). +.PP +See also owner(), group(), and groupId(). +.SH "bool QFileInfo::permission ( int permissionSpec ) const" +Tests for file permissions. The \fIpermissionSpec\fR argument can be several flags of type PermissionSpec OR-ed together to check for permission combinations. +.PP +On systems where files do not have permissions this function always returns TRUE. +.PP +Example: +.PP +.nf +.br + QFileInfo fi( "/tmp/archive.tar.gz" ); +.br + if ( fi.permission( QFileInfo::WriteUser | QFileInfo::ReadGroup ) ) +.br + tqWarning( "I can change the file; my group can read the file" ); +.br + if ( fi.permission( QFileInfo::WriteGroup | QFileInfo::WriteOther ) ) +.br + tqWarning( "The group or others can change the file" ); +.br +.fi +.PP +See also isReadable(), isWritable(), and isExecutable(). +.SH "QString QFileInfo::readLink () const" +Returns the name a symlink (or shortcut on Windows) points to, or a QString::null if the object isn't a symbolic link. +.PP +This name may not represent an existing file; it is only a string. QFileInfo::exists() returns TRUE if the symlink points to an existing file. +.PP +See also exists(), isSymLink(), isDir(), and isFile(). +.SH "void QFileInfo::refresh () const" +Refreshes the information about the file, i.e. reads in information from the file system the next time a cached property is fetched. +.PP +See also setCaching(). +.SH "void QFileInfo::setCaching ( bool enable )" +If \fIenable\fR is TRUE, enables caching of file information. If \fIenable\fR is FALSE caching is disabled. +.PP +When caching is enabled, QFileInfo reads the file information from the file system the first time it's needed, but generally not later. +.PP +Caching is enabled by default. +.PP +See also refresh() and caching(). +.SH "void QFileInfo::setFile ( const QString & file )" +Sets the file that the QFileInfo provides information about to \fIfile\fR. +.PP +The \fIfile\fR can also include an absolute or relative file path. Absolute paths begin with the directory separator (e.g. "/" under Unix) or a drive specification (under Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current directory. +.PP +Example: +.PP +.nf +.br + QString absolute = "/local/bin"; +.br + QString relative = "local/bin"; +.br + QFileInfo absFile( absolute ); +.br + QFileInfo relFile( relative ); +.br +.br + QDir::setCurrent( QDir::rootDirPath() ); +.br + // absFile and relFile now point to the same file +.br +.br + QDir::setCurrent( "/tmp" ); +.br + // absFile now points to "/local/bin", +.br + // while relFile points to "/tmp/local/bin" +.br +.fi +.PP +See also isRelative(), QDir::setCurrent(), and QDir::isRelativePath(). +.PP +Example: biff/biff.cpp. +.SH "void QFileInfo::setFile ( const QFile & file )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the file that the QFileInfo provides information about to \fIfile\fR. +.PP +If \fIfile\fR includes a relative path, the QFileInfo will also have a relative path. +.PP +See also isRelative(). +.SH "void QFileInfo::setFile ( const QDir & d, const QString & fileName )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the file that the QFileInfo provides information about to \fIfileName\fR in directory \fId\fR. +.PP +If \fIfileName\fR includes a relative path, the QFileInfo will also have a relative path. +.PP +See also isRelative(). +.SH "uint QFileInfo::size () const" +Returns the file size in bytes, or 0 if the file does not exist or if the size is 0 or if the size cannot be fetched. +.PP +Example: qdir/qdir.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfileinfo.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfileinfo.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfilepreview.3qt b/doc/man/man3/tqfilepreview.3qt new file mode 100644 index 000000000..07f0caddc --- /dev/null +++ b/doc/man/man3/tqfilepreview.3qt @@ -0,0 +1,66 @@ +'\" t +.TH QFilePreview 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 +QFilePreview \- File previewing in QFileDialog +.SH SYNOPSIS +\fC#include <ntqfiledialog.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFilePreview\fR ()" +.br +.ti -1c +.BI "virtual void \fBpreviewUrl\fR ( const QUrl & url ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QFilePreview class provides file previewing in QFileDialog. +.PP +This class is an abstract base class which is used to implement widgets that can display a preview of a file in a QFileDialog. +.PP +You must derive the preview widget from both QWidget and from this class. Then you must reimplement this class's previewUrl() function, which is called by the file dialog if the preview of a file (specified as a URL) should be shown. +.PP +See also QFileDialog::setPreviewMode(), QFileDialog::setContentsPreview(), QFileDialog::setInfoPreview(), QFileDialog::setInfoPreviewEnabled(), QFileDialog::setContentsPreviewEnabled(). +.PP +For an example of a preview widget see qt/examples/qdir/qdir.cpp. +.PP +See also Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFilePreview::QFilePreview ()" +Constructs the QFilePreview. +.SH "void QFilePreview::previewUrl ( const QUrl & url )\fC [pure virtual]\fR" +This function is called by QFileDialog if a preview +for the \fIurl\fR should be shown. Reimplement this +function to provide file previewing. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qfilepreview.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfilepreview.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfocusdata.3qt b/doc/man/man3/tqfocusdata.3qt new file mode 100644 index 000000000..53e65a756 --- /dev/null +++ b/doc/man/man3/tqfocusdata.3qt @@ -0,0 +1,92 @@ +'\" t +.TH QFocusData 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 +QFocusData \- Maintains the list of widgets in the focus chain +.SH SYNOPSIS +\fC#include <ntqfocusdata.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "QWidget * \fBfocusWidget\fR () const" +.br +.ti -1c +.BI "QWidget * \fBhome\fR ()" +.br +.ti -1c +.BI "QWidget * \fBnext\fR ()" +.br +.ti -1c +.BI "QWidget * \fBprev\fR ()" +.br +.ti -1c +.BI "QWidget * \fBfirst\fR () const" +.br +.ti -1c +.BI "QWidget * \fBlast\fR () const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QFocusData class maintains the list of widgets in the focus chain. +.PP +This read-only list always contains at least one widget (i.e. the top-level widget). It provides a simple cursor which can be reset to the current focus widget using home(), or moved to its neighboring widgets using next() and prev(). You can also retrieve the count() of the number of widgets in the list. The list is a loop, so if you keep iterating, for example using next(), you will never come to the end. +.PP +Some widgets in the list may not accept focus. Widgets are added to the list as necessary, but not removed from it. This lets widgets change focus policy dynamically without disrupting the focus chain the user experiences. When a widget disables and re-enables tab focus, its position in the focus chain does not change. +.PP +When reimplementing QWidget::focusNextPrevChild() to provide special focus flow, you will usually call QWidget::focusData() to retrieve the focus data stored at the top-level widget. A top-level widget's focus data contains the focus list for its hierarchy of widgets. +.PP +The cursor may change at any time. +.PP +This class is \fInot\fR thread-safe. +.PP +See also QWidget::focusNextPrevChild(), QWidget::setTabOrder(), QWidget::focusPolicy, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "int QFocusData::count () const" +Returns the number of widgets in the focus chain. +.SH "QWidget * QFocusData::first () const" +Returns the first widget in the focus chain. The cursor is not modified. +.SH "QWidget * QFocusData::focusWidget () const" +Returns the widgets in the hierarchy that are in the focus chain. +.SH "QWidget * QFocusData::home ()" +Moves the cursor to the focusWidget() and returns that widget. You must call this before next() or prev() to iterate meaningfully. +.SH "QWidget * QFocusData::last () const" +Returns the last widget in the focus chain. The cursor is not modified. +.SH "QWidget * QFocusData::next ()" +Moves the cursor to the next widget in the focus chain. There is \fIalways\fR a next widget because the list is a loop. +.SH "QWidget * QFocusData::prev ()" +Moves the cursor to the previous widget in the focus chain. There +is \fIalways\fR a previous widget because the list is a loop. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfocusdata.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfocusdata.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfocusevent.3qt b/doc/man/man3/tqfocusevent.3qt new file mode 100644 index 000000000..fe5edcd44 --- /dev/null +++ b/doc/man/man3/tqfocusevent.3qt @@ -0,0 +1,117 @@ +'\" t +.TH QFocusEvent 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 +QFocusEvent \- Event parameters for widget focus events +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFocusEvent\fR ( Type type )" +.br +.ti -1c +.BI "bool \fBgotFocus\fR () const" +.br +.ti -1c +.BI "bool \fBlostFocus\fR () const" +.br +.ti -1c +.BI "enum \fBReason\fR { Mouse, Tab, Backtab, ActiveWindow, Popup, Shortcut, Other }" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "Reason \fBreason\fR ()" +.br +.ti -1c +.BI "void \fBsetReason\fR ( Reason reason )" +.br +.ti -1c +.BI "void \fBresetReason\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QFocusEvent class contains event parameters for widget focus events. +.PP +Focus events are sent to widgets when the keyboard input focus changes. Focus events occur due to mouse actions, keypresses (e.g. Tab or Backtab), the window system, popup menus, keyboard shortcuts or other application specific reasons. The reason for a particular focus event is returned by reason() in the appropriate event handler. +.PP +The event handlers QWidget::focusInEvent() and QWidget::focusOutEvent() receive focus events. +.PP +Use setReason() to set the reason for all focus events, and resetReason() to set the reason for all focus events to the reason in force before the last setReason() call. +.PP +See also QWidget::setFocus(), QWidget::focusPolicy, and Event Classes. +.SS "Member Type Documentation" +.SH "QFocusEvent::Reason" +This enum specifies why the focus changed. +.TP +\fCQFocusEvent::Mouse\fR - because of a mouse action. +.TP +\fCQFocusEvent::Tab\fR - because of a Tab press. +.TP +\fCQFocusEvent::Backtab\fR - because of a Backtab press (possibly including Shift/Control, e.g. Shift+Tab). +.TP +\fCQFocusEvent::ActiveWindow\fR - because the window system made this window (in)active. +.TP +\fCQFocusEvent::Popup\fR - because the application opened/closed a popup that grabbed/released focus. +.TP +\fCQFocusEvent::Shortcut\fR - because of a keyboard shortcut. +.TP +\fCQFocusEvent::Other\fR - any other reason, usually application-specific. +.PP +See the keyboard focus overview for more about focus. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFocusEvent::QFocusEvent ( Type type )" +Constructs a focus event object. +.PP +The \fItype\fR parameter must be either QEvent::FocusIn or QEvent::FocusOut. +.SH "bool QFocusEvent::gotFocus () const" +Returns TRUE if the widget received the text input focus; otherwise returns FALSE. +.SH "bool QFocusEvent::lostFocus () const" +Returns TRUE if the widget lost the text input focus; otherwise returns FALSE. +.SH "Reason QFocusEvent::reason ()\fC [static]\fR" +Returns the reason for this focus event. +.PP +See also setReason(). +.SH "void QFocusEvent::resetReason ()\fC [static]\fR" +Resets the reason for all future focus events to the value before the last setReason() call. +.PP +See also reason() and setReason(). +.SH "void QFocusEvent::setReason ( Reason reason )\fC [static]\fR" +Sets the reason for all future focus events to \fIreason\fR. +.PP +See also reason() and resetReason(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qfocusevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfocusevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfont.3qt b/doc/man/man3/tqfont.3qt new file mode 100644 index 000000000..29f56ed73 --- /dev/null +++ b/doc/man/man3/tqfont.3qt @@ -0,0 +1,906 @@ +'\" t +.TH QFont 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 +QFont \- Font used for drawing text +.SH SYNOPSIS +\fC#include <ntqfont.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBStyleHint\fR { Helvetica, SansSerif = Helvetica, Times, Serif = Times, Courier, TypeWriter = Courier, OldEnglish, Decorative = OldEnglish, System, AnyStyle }" +.br +.ti -1c +.BI "enum \fBStyleStrategy\fR { PreferDefault = 0x0001, PreferBitmap = 0x0002, PreferDevice = 0x0004, PreferOutline = 0x0008, ForceOutline = 0x0010, PreferMatch = 0x0020, PreferQuality = 0x0040, PreferAntialias = 0x0080, NoAntialias = 0x0100, OpenGLCompatible = 0x0200 }" +.br +.ti -1c +.BI "enum \fBWeight\fR { Light = 25, Normal = 50, DemiBold = 63, Bold = 75, Black = 87 }" +.br +.ti -1c +.BI "enum \fBStretch\fR { UltraCondensed = 50, ExtraCondensed = 62, Condensed = 75, SemiCondensed = 87, Unstretched = 100, SemiExpanded = 112, Expanded = 125, ExtraExpanded = 150, UltraExpanded = 200 }" +.br +.ti -1c +.BI "\fBQFont\fR ()" +.br +.ti -1c +.BI "\fBQFont\fR ( const QString & family, int pointSize = 12, int weight = Normal, bool italic = FALSE )" +.br +.ti -1c +.BI "\fBQFont\fR ( const QFont & font )" +.br +.ti -1c +.BI "\fB~QFont\fR ()" +.br +.ti -1c +.BI "QString \fBfamily\fR () const" +.br +.ti -1c +.BI "void \fBsetFamily\fR ( const QString & family )" +.br +.ti -1c +.BI "int \fBpointSize\fR () const" +.br +.ti -1c +.BI "float \fBpointSizeFloat\fR () const" +.br +.ti -1c +.BI "void \fBsetPointSize\fR ( int pointSize )" +.br +.ti -1c +.BI "void \fBsetPointSizeFloat\fR ( float pointSize )" +.br +.ti -1c +.BI "int \fBpixelSize\fR () const" +.br +.ti -1c +.BI "void \fBsetPixelSize\fR ( int pixelSize )" +.br +.ti -1c +.BI "void setPixelSizeFloat ( float pixelSize ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBweight\fR () const" +.br +.ti -1c +.BI "void \fBsetWeight\fR ( int weight )" +.br +.ti -1c +.BI "bool \fBbold\fR () const" +.br +.ti -1c +.BI "void \fBsetBold\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBitalic\fR () const" +.br +.ti -1c +.BI "void \fBsetItalic\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBunderline\fR () const" +.br +.ti -1c +.BI "void \fBsetUnderline\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBoverline\fR () const" +.br +.ti -1c +.BI "void \fBsetOverline\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBstrikeOut\fR () const" +.br +.ti -1c +.BI "void \fBsetStrikeOut\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBfixedPitch\fR () const" +.br +.ti -1c +.BI "void \fBsetFixedPitch\fR ( bool enable )" +.br +.ti -1c +.BI "StyleHint \fBstyleHint\fR () const" +.br +.ti -1c +.BI "StyleStrategy \fBstyleStrategy\fR () const" +.br +.ti -1c +.BI "void \fBsetStyleHint\fR ( StyleHint hint, StyleStrategy strategy = PreferDefault )" +.br +.ti -1c +.BI "void \fBsetStyleStrategy\fR ( StyleStrategy s )" +.br +.ti -1c +.BI "int \fBstretch\fR () const" +.br +.ti -1c +.BI "void \fBsetStretch\fR ( int factor )" +.br +.ti -1c +.BI "bool \fBrawMode\fR () const" +.br +.ti -1c +.BI "void \fBsetRawMode\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBexactMatch\fR () const" +.br +.ti -1c +.BI "QFont & \fBoperator=\fR ( const QFont & font )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QFont & f ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QFont & f ) const" +.br +.ti -1c +.BI "bool \fBisCopyOf\fR ( const QFont & f ) const" +.br +.ti -1c +.BI "HFONT \fBhandle\fR () const" +.br +.ti -1c +.BI "void \fBsetRawName\fR ( const QString & name )" +.br +.ti -1c +.BI "QString \fBrawName\fR () const" +.br +.ti -1c +.BI "QString \fBkey\fR () const" +.br +.ti -1c +.BI "QString \fBtoString\fR () const" +.br +.ti -1c +.BI "bool \fBfromString\fR ( const QString & descrip )" +.br +.ti -1c +.BI "void \fBqwsRenderToDisk\fR ( bool all = TRUE )" +.br +.ti -1c +.BI "enum \fBScript\fR { Latin, Greek, Cyrillic, Armenian, Georgian, Runic, Ogham, SpacingModifiers, CombiningMarks, Hebrew, Arabic, Syriac, Thaana, Devanagari, Bengali, Gurmukhi, Gujarati, Oriya, Tamil, Telugu, Kannada, Malayalam, Sinhala, Thai, Lao, Tibetan, Myanmar, Khmer, Han, Hiragana, Katakana, Hangul, Bopomofo, Yi, Ethiopic, Cherokee, CanadianAboriginal, Mongolian, CurrencySymbols, LetterlikeSymbols, NumberForms, MathematicalOperators, TechnicalSymbols, GeometricSymbols, MiscellaneousSymbols, EnclosedAndSquare, Braille, Unicode, Tagalog, Hanunoo, Buhid, Tagbanwa, KatakanaHalfWidth, Limbu, TaiLe }" +.br +.ti -1c +.BI "QString \fBdefaultFamily\fR () const" +.br +.ti -1c +.BI "QString \fBlastResortFamily\fR () const" +.br +.ti -1c +.BI "QString \fBlastResortFont\fR () const" +.br +.ti -1c +.BI "QFont \fBresolve\fR ( const QFont & other ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBsubstitute\fR ( const QString & familyName )" +.br +.ti -1c +.BI "QStringList \fBsubstitutes\fR ( const QString & familyName )" +.br +.ti -1c +.BI "QStringList \fBsubstitutions\fR ()" +.br +.ti -1c +.BI "void \fBinsertSubstitution\fR ( const QString & familyName, const QString & substituteName )" +.br +.ti -1c +.BI "void \fBinsertSubstitutions\fR ( const QString & familyName, const QStringList & substituteNames )" +.br +.ti -1c +.BI "void \fBremoveSubstitution\fR ( const QString & familyName )" +.br +.ti -1c +.BI "QFont defaultFont () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setDefaultFont ( const QFont & f ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "bool \fBdirty\fR () const" +.br +.ti -1c +.BI "int \fBdeciPointSize\fR () const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QFont & font )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QFont & font )" +.br +.in -1c +.SH DESCRIPTION +The QFont class specifies a font used for drawing text. +.PP +When you create a QFont object you specify various attributes that you want the font to have. Qt will use the font with the specified attributes, or if no matching font exists, Qt will use the closest matching installed font. The attributes of the font that is actually used are retrievable from a QFontInfo object. If the window system provides an exact match exactMatch() returns TRUE. Use QFontMetrics to get measurements, e.g. the pixel length of a string using QFontMetrics::width(). +.PP +Use QApplication::setFont() to set the application's default font. +.PP +If a choosen X11 font does not include all the characters that need to be displayed, QFont will try to find the characters in the nearest equivalent fonts. When a QPainter draws a character from a font the QFont will report whether or not it has the character; if it does not, QPainter will draw an unfilled square. +.PP +Create QFonts like this: +.PP +.nf +.br + QFont serifFont( "Times", 10, Bold ); +.br + QFont sansFont( "Helvetica [Cronyx]", 12 ); +.br +.fi +.PP +The attributes set in the constructor can also be set later, e.g. setFamily(), setPointSize(), setPointSizeFloat(), setWeight() and setItalic(). The remaining attributes must be set after contstruction, e.g. setBold(), setUnderline(), setOverline(), setStrikeOut() and setFixedPitch(). QFontInfo objects should be created \fIafter\fR the font's attributes have been set. A QFontInfo object will not change, even if you change the font's attributes. The corresponding "get" functions, e.g. family(), pointSize(), etc., return the values that were set, even though the values used may differ. The actual values are available from a QFontInfo object. +.PP +If the requested font family is unavailable you can influence the font matching algorithm by choosing a particular QFont::StyleHint and QFont::StyleStrategy with setStyleHint(). The default family (corresponding to the current style hint) is returned by defaultFamily(). +.PP +The font-matching algorithm has a lastResortFamily() and lastResortFont() in cases where a suitable match cannot be found. You can provide substitutions for font family names using insertSubstitution() and insertSubstitutions(). Substitutions can be removed with removeSubstitution(). Use substitute() to retrieve a family's first substitute, or the family name itself if it has no substitutes. Use substitutes() to retrieve a list of a family's substitutes (which may be empty). +.PP +Every QFont has a key() which you can use, for example, as the key in a cache or dictionary. If you want to store a user's font preferences you could use QSettings, writing the font information with toString() and reading it back with fromString(). The operator<<() and operator>>() functions are also available, but they work on a data stream. +.PP +It is possible to set the height of characters shown on the screen to a specified number of pixels with setPixelSize(); however using setPointSize() has a similar effect and provides device independence. +.PP +Under the X Window System you can set a font using its system specific name with setRawName(). +.PP +Loading fonts can be expensive, especially on X11. QFont contains extensive optimizations to make the copying of QFont objects fast, and to cache the results of the slow window system functions it depends upon. +.PP +The font matching algorithm works as follows: <ol type=1> +.IP 1 +The specified font family is searched for. +.IP 2 +If not found, the styleHint() is used to select a replacement family. +.IP 3 +Each replacement font family is searched for. +.IP 4 +If none of these are found or there was no styleHint(), "helvetica" will be searched for. +.IP 5 +If "helvetica" isn't found Qt will try the lastResortFamily(). +.IP 6 +If the lastResortFamily() isn't found Qt will try the lastResortFont() which will always return a name of some kind. +.PP +Once a font is found, the remaining attributes are matched in order of priority: <ol type=1> +.IP 7 +fixedPitch() +.IP 8 +pointSize() (see below) +.IP 9 +weight() +.IP 10 +italic() +.PP +If you have a font which matches on family, even if none of the other attributes match, this font will be chosen in preference to a font which doesn't match on family but which does match on the other attributes. This is because font family is the dominant search criteria. +.PP +The point size is defined to match if it is within 20% of the requested point size. When several fonts match and are only distinguished by point size, the font with the closest point size to the one requested will be chosen. +.PP +The actual family, font size, weight and other font attributes used for drawing text will depend on what's available for the chosen family under the window system. A QFontInfo object can be used to determine the actual values used for drawing the text. +.PP +Examples: +.)l +.PP +.nf +.br + QFont f("Helvetica"); +.br +.fi +If you had both an Adobe and a Cronyx Helvetica, you might get either. +.PP +.nf +.br + QFont f1( "Helvetica [Cronyx]" ); // Qt 3.x +.br + QFont f2( "Cronyx-Helvetica" ); // Qt 2.x compatibility +.br +.fi +You can specify the foundry you want in the family name. Both fonts, f1 and f2, in the above example will be set to "Helvetica [Cronyx]". +.PP +To determine the attributes of the font actually used in the window system, use a QFontInfo object, e.g. +.PP +.nf +.br + QFontInfo info( f1 ); +.br + QString family = info.family(); +.br +.fi +.PP +To find out font metrics use a QFontMetrics object, e.g. +.PP +.nf +.br + QFontMetrics fm( f1 ); +.br + int pixelWidth = fm.width( "How many pixels wide is this text?" ); +.br + int pixelHeight = fm.height(); +.br +.fi +.PP +For more general information on fonts, see the comp.fonts FAQ. Information on encodings can be found from Roman Czyborra's page. +.PP +See also QFontMetrics, QFontInfo, QFontDatabase, QApplication::setFont(), QWidget::font, QPainter::setFont(), QFont::StyleHint, QFont::Weight, Widget Appearance and Style, Graphics Classes, and Implicitly and Explicitly Shared Classes. +.SS "Member Type Documentation" +.SH "QFont::Script" +This enum represents Unicode allocated scripts. For exhaustive coverage see The Unicode Standard Version 3.0. The following scripts are supported: +.PP +Modern European alphabetic scripts (left to right): +.TP +\fCQFont::Latin\fR - consists of most alphabets based on the original Latin alphabet. +.TP +\fCQFont::Greek\fR - covers ancient and modern Greek and Coptic. +.TP +\fCQFont::Cyrillic\fR - covers the Slavic and non-Slavic languages using cyrillic alphabets. +.TP +\fCQFont::Armenian\fR - contains the Armenian alphabet used with the Armenian language. +.TP +\fCQFont::Georgian\fR - covers at least the language Georgian. +.TP +\fCQFont::Runic\fR - covers the known constituents of the Runic alphabets used by the early and medieval societies in the Germanic, Scandinavian, and Anglo-Saxon areas. +.TP +\fCQFont::Ogham\fR - is an alphabetical script used to write a very early form of Irish. +.TP +\fCQFont::SpacingModifiers\fR - are small signs indicating modifications to the preceeding letter. +.TP +\fCQFont::CombiningMarks\fR - consist of diacritical marks not specific to a particular alphabet, diacritical marks used in combination with mathematical and technical symbols, and glyph encodings applied to multiple letterforms. +.PP +Middle Eastern scripts (right to left): +.TP +\fCQFont::Hebrew\fR - is used for writing Hebrew, Yiddish, and some other languages. +.TP +\fCQFont::Arabic\fR - covers the Arabic language as well as Persian, Urdu, Kurdish and some others. +.TP +\fCQFont::Syriac\fR - is used to write the active liturgical languages and dialects of several Middle Eastern and Southeast Indian communities. +.TP +\fCQFont::Thaana\fR - is used to write the Maledivian Dhivehi language. +.PP +South and Southeast Asian scripts (left to right with few historical exceptions): +.TP +\fCQFont::Devanagari\fR - covers classical Sanskrit and modern Hindi as well as several other languages. +.TP +\fCQFont::Bengali\fR - is a relative to Devanagari employed to write the Bengali language used in West Bengal/India and Bangladesh as well as several minority languages. +.TP +\fCQFont::Gurmukhi\fR - is another Devanagari relative used to write Punjabi. +.TP +\fCQFont::Gujarati\fR - is closely related to Devanagari and used to write the Gujarati language of the Gujarat state in India. +.TP +\fCQFont::Oriya\fR - is used to write the Oriya language of Orissa state/India. +.TP +\fCQFont::Tamil\fR - is used to write the Tamil language of Tamil Nadu state/India, Sri Lanka, Singapore and parts of Malaysia as well as some minority languages. +.TP +\fCQFont::Telugu\fR - is used to write the Telugu language of Andhra Pradesh state/India and some minority languages. +.TP +\fCQFont::Kannada\fR - is another South Indian script used to write the Kannada language of Karnataka state/India and some minority languages. +.TP +\fCQFont::Malayalam\fR - is used to write the Malayalam language of Kerala state/India. +.TP +\fCQFont::Sinhala\fR - is used for Sri Lanka's majority language Sinhala and is also employed to write Pali, Sanskrit, and Tamil. +.TP +\fCQFont::Thai\fR - is used to write Thai and other Southeast Asian languages. +.TP +\fCQFont::Lao\fR - is a language and script quite similar to Thai. +.TP +\fCQFont::Tibetan\fR - is the script used to write Tibetan in several countries like Tibet, the bordering Indian regions and Nepal. It is also used in the Buddist philosophy and liturgy of the Mongolian cultural area. +.TP +\fCQFont::Myanmar\fR - is mainly used to write the Burmese language of Myanmar (former Burma). +.TP +\fCQFont::Khmer\fR - is the official language of Kampuchea. +.PP +East Asian scripts (traditionally top-down, right to left, modern often horizontal left to right): +.TP +\fCQFont::Han\fR - consists of the CJK (Chinese, Japanese, Korean) idiographic characters. +.TP +\fCQFont::Hiragana\fR - is a cursive syllabary used to indicate phonetics and pronounciation of Japanese words. +.TP +\fCQFont::Katakana\fR - is a non-cursive syllabic script used to write Japanese words with visual emphasis and non-Japanese words in a phonetical manner. +.TP +\fCQFont::Hangul\fR - is a Korean script consisting of alphabetic components. +.TP +\fCQFont::Bopomofo\fR - is a phonetic alphabet for Chinese (mainly Mandarin). +.TP +\fCQFont::Yi\fR - (also called Cuan or Wei) is a syllabary used to write the Yi language of Southwestern China, Myanmar, Laos, and Vietnam. +.PP +Additional scripts that do not fit well into the script categories above: +.TP +\fCQFont::Ethiopic\fR - is a syllabary used by several Central East African languages. +.TP +\fCQFont::Cherokee\fR - is a left-to-right syllabic script used to write the Cherokee language. +.TP +\fCQFont::CanadianAboriginal\fR - consists of the syllabics used by some Canadian aboriginal societies. +.TP +\fCQFont::Mongolian\fR - is the traditional (and recently reintroduced) script used to write Mongolian. +.PP +Symbols: +.TP +\fCQFont::CurrencySymbols\fR - contains currency symbols not encoded in other scripts. +.TP +\fCQFont::LetterlikeSymbols\fR - consists of symbols derived from ordinary letters of an alphabetical script. +.TP +\fCQFont::NumberForms\fR - are provided for compatibility with other existing character sets. +.TP +\fCQFont::MathematicalOperators\fR - consists of encodings for operators, relations and other symbols like arrows used in a mathematical context. +.TP +\fCQFont::TechnicalSymbols\fR - contains representations for control codes, the space symbol, APL symbols and other symbols mainly used in the context of electronic data processing. +.TP +\fCQFont::GeometricSymbols\fR - covers block elements and geometric shapes. +.TP +\fCQFont::MiscellaneousSymbols\fR - consists of a heterogeneous collection of symbols that do not fit any other Unicode character block, e.g. Dingbats. +.TP +\fCQFont::EnclosedAndSquare\fR - is provided for compatibility with some East Asian standards. +.TP +\fCQFont::Braille\fR - is an international writing system used by blind people. This script encodes the 256 eight-dot patterns with the 64 six-dot patterns as a subset. +.TP +\fCQFont::Tagalog\fR +.TP +\fCQFont::Hanunoo\fR +.TP +\fCQFont::Buhid\fR +.TP +\fCQFont::Tagbanwa\fR +.TP +\fCQFont::KatakanaHalfWidth\fR +.TP +\fCQFont::Limbu\fR - (Unicode 4.0) +.TP +\fCQFont::TaiLe\fR - (Unicode 4.0) +.TP +\fCQFont::Unicode\fR - includes all the above scripts. +.SH "QFont::Stretch" +Predefined stretch values that follow the CSS naming convention. +.TP +\fCQFont::UltraCondensed\fR - 50 +.TP +\fCQFont::ExtraCondensed\fR - 62 +.TP +\fCQFont::Condensed\fR - 75 +.TP +\fCQFont::SemiCondensed\fR - 87 +.TP +\fCQFont::Unstretched\fR - 100 +.TP +\fCQFont::SemiExpanded\fR - 112 +.TP +\fCQFont::Expanded\fR - 125 +.TP +\fCQFont::ExtraExpanded\fR - 150 +.TP +\fCQFont::UltraExpanded\fR - 200 +.PP +See also setStretch() and stretch(). +.SH "QFont::StyleHint" +Style hints are used by the font matching algorithm to find an appropriate default family if a selected font family is not available. +.TP +\fCQFont::AnyStyle\fR - leaves the font matching algorithm to choose the family. This is the default. +.TP +\fCQFont::SansSerif\fR - the font matcher prefer sans serif fonts. +.TP +\fCQFont::Helvetica\fR - is a synonym for SansSerif. +.TP +\fCQFont::Serif\fR - the font matcher prefers serif fonts. +.TP +\fCQFont::Times\fR - is a synonym for Serif. +.TP +\fCQFont::TypeWriter\fR - the font matcher prefers fixed pitch fonts. +.TP +\fCQFont::Courier\fR - a synonym for TypeWriter. +.TP +\fCQFont::OldEnglish\fR - the font matcher prefers decorative fonts. +.TP +\fCQFont::Decorative\fR - is a synonym for OldEnglish. +.TP +\fCQFont::System\fR - the font matcher prefers system fonts. +.SH "QFont::StyleStrategy" +The style strategy tells the font matching algorithm what type of fonts should be used to find an appropriate default family. +.PP +The following strategies are available: +.TP +\fCQFont::PreferDefault\fR - the default style strategy. It does not prefer any type of font. +.TP +\fCQFont::PreferBitmap\fR - prefers bitmap fonts (as opposed to outline fonts). +.TP +\fCQFont::PreferDevice\fR - prefers device fonts. +.TP +\fCQFont::PreferOutline\fR - prefers outline fonts (as opposed to bitmap fonts). +.TP +\fCQFont::ForceOutline\fR - forces the use of outline fonts. +.TP +\fCQFont::NoAntialias\fR - don't antialias the fonts. +.TP +\fCQFont::PreferAntialias\fR - antialias if possible. +.TP +\fCQFont::OpenGLCompatible\fR - forces the use of OpenGL compatible fonts. +.PP +Any of these may be OR-ed with one of these flags: +.TP +\fCQFont::PreferMatch\fR - prefer an exact match. The font matcher will try to use the exact font size that has been specified. +.TP +\fCQFont::PreferQuality\fR - prefer the best quality font. The font matcher will use the nearest standard point size that the font supports. +.SH "QFont::Weight" +Qt uses a weighting scale from 0 to 99 similar to, but not the same as, the scales used in Windows or CSS. A weight of 0 is ultralight, whilst 99 will be an extremely black. +.PP +This enum contains the predefined font weights: +.TP +\fCQFont::Light\fR - 25 +.TP +\fCQFont::Normal\fR - 50 +.TP +\fCQFont::DemiBold\fR - 63 +.TP +\fCQFont::Bold\fR - 75 +.TP +\fCQFont::Black\fR - 87 +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFont::QFont ()" +Constructs a font object that uses the application's default font. +.PP +See also QApplication::setFont() and QApplication::font(). +.SH "QFont::QFont ( const QString & family, int pointSize = 12, int weight = Normal, bool italic = FALSE )" +Constructs a font object with the specified \fIfamily\fR, \fIpointSize\fR, \fIweight\fR and \fIitalic\fR settings. +.PP +If \fIpointSize\fR is <= 0 it is set to 1. +.PP +The \fIfamily\fR name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". (The Qt 2.x syntax, i.e." Cronyx-Helvetica", is also supported.) If the \fIfamily\fR is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm. +.PP +See also Weight, setFamily(), setPointSize(), setWeight(), setItalic(), setStyleHint(), and QApplication::font(). +.SH "QFont::QFont ( const QFont & font )" +Constructs a font that is a copy of \fIfont\fR. +.SH "QFont::~QFont ()" +Destroys the font object and frees all allocated resources. +.SH "bool QFont::bold () const" +Returns TRUE if weight() is a value greater than QFont::Normal; otherwise returns FALSE. +.PP +See also weight(), setBold(), and QFontInfo::bold(). +.PP +Example: chart/optionsform.cpp. +.SH "int QFont::deciPointSize () const\fC [protected]\fR" +Returns the point size in 1/10ths of a point. +.PP +The returned value will be -1 if the font size has been specified in pixels. +.PP +See also pointSize() and pointSizeFloat(). +.SH "QString QFont::defaultFamily () const" +Returns the family name that corresponds to the current style hint. +.PP +See also StyleHint, styleHint(), and setStyleHint(). +.SH "QFont QFont::defaultFont ()\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Please use QApplication::font() instead. +.SH "bool QFont::dirty () const\fC [protected]\fR" +Returns TRUE if the font attributes have been changed and the font has to be (re)loaded; otherwise returns FALSE. +.SH "bool QFont::exactMatch () const" +Returns TRUE if a window system font exactly matching the settings of this font is available. +.PP +See also QFontInfo. +.SH "QString QFont::family () const" +Returns the requested font family name, i.e. the name set in the constructor or the last setFont() call. +.PP +See also setFamily(), substitutes(), and substitute(). +.PP +Examples: +.)l chart/optionsform.cpp and fonts/simple-qfont-demo/viewer.cpp. +.SH "bool QFont::fixedPitch () const" +Returns TRUE if fixed pitch has been set; otherwise returns FALSE. +.PP +See also setFixedPitch() and QFontInfo::fixedPitch(). +.SH "bool QFont::fromString ( const QString & descrip )" +Sets this font to match the description \fIdescrip\fR. The description is a comma-separated list of the font attributes, as returned by toString(). +.PP +See also toString() and operator>>(). +.SH "HFONT QFont::handle () const" +Returns the window system handle to the font, for low-level access. Using this function is \fInot\fR portable. +.SH "void QFont::insertSubstitution ( const QString & familyName, const QString & substituteName )\fC [static]\fR" +Inserts the family name \fIsubstituteName\fR into the substitution table for \fIfamilyName\fR. +.PP +See also insertSubstitutions(), removeSubstitution(), substitutions(), substitute(), and substitutes(). +.PP +Example: fonts/simple-qfont-demo/viewer.cpp. +.SH "void QFont::insertSubstitutions ( const QString & familyName, const QStringList & substituteNames )\fC [static]\fR" +Inserts the list of families \fIsubstituteNames\fR into the substitution list for \fIfamilyName\fR. +.PP +See also insertSubstitution(), removeSubstitution(), substitutions(), and substitute(). +.PP +Example: fonts/simple-qfont-demo/viewer.cpp. +.SH "bool QFont::isCopyOf ( const QFont & f ) const" +Returns TRUE if this font and \fIf\fR are copies of each other, i.e. one of them was created as a copy of the other and neither has been modified since. This is much stricter than equality. +.PP +See also operator=() and operator==(). +.SH "bool QFont::italic () const" +Returns TRUE if italic has been set; otherwise returns FALSE. +.PP +See also setItalic(). +.PP +Example: chart/optionsform.cpp. +.SH "QString QFont::key () const" +Returns the font's key, a textual representation of a font. It is typically used as the key for a cache or dictionary of fonts. +.PP +See also QMap. +.SH "QString QFont::lastResortFamily () const" +Returns the "last resort" font family name. +.PP +The current implementation tries a wide variety of common fonts, returning the first one it finds. Is is possible that no family is found in which case a null string is returned. +.PP +See also lastResortFont(). +.SH "QString QFont::lastResortFont () const" +Returns a "last resort" font name for the font matching algorithm. This is used if the last resort family is not available. It will always return a name, if necessary returning something like" fixed" or "system". +.PP +The current implementation tries a wide variety of common fonts, returning the first one it finds. The implementation may change at any time, but this function will always return a string containing something. +.PP +It is theoretically possible that there really isn't a lastResortFont() in which case Qt will abort with an error message. We have not been able to identify a case where this happens. Please report it as a bug if it does, preferably with a list of the fonts you have installed. +.PP +See also lastResortFamily() and rawName(). +.SH "bool QFont::operator!= ( const QFont & f ) const" +Returns TRUE if this font is different from \fIf\fR; otherwise returns FALSE. +.PP +Two QFonts are considered to be different if their font attributes are different. If rawMode() is enabled for both fonts, only the family fields are compared. +.PP +See also operator==(). +.SH "QFont & QFont::operator= ( const QFont & font )" +Assigns \fIfont\fR to this font and returns a reference to it. +.SH "bool QFont::operator== ( const QFont & f ) const" +Returns TRUE if this font is equal to \fIf\fR; otherwise returns FALSE. +.PP +Two QFonts are considered equal if their font attributes are equal. If rawMode() is enabled for both fonts, only the family fields are compared. +.PP +See also operator!=() and isCopyOf(). +.SH "bool QFont::overline () const" +Returns TRUE if overline has been set; otherwise returns FALSE. +.PP +See also setOverline(). +.SH "int QFont::pixelSize () const" +Returns the pixel size of the font if it was set with setPixelSize(). Returns -1 if the size was set with setPointSize() or setPointSizeFloat(). +.PP +See also setPixelSize(), pointSize(), QFontInfo::pointSize(), and QFontInfo::pixelSize(). +.SH "int QFont::pointSize () const" +Returns the point size of the font. Returns -1 if the font size was specified in pixels. +.PP +See also setPointSize(), deciPointSize(), and pointSizeFloat(). +.PP +Examples: +.)l chart/optionsform.cpp and fonts/simple-qfont-demo/viewer.cpp. +.SH "float QFont::pointSizeFloat () const" +Returns the point size of the font. Returns -1 if the font size was specified in pixels. +.PP +See also pointSize(), setPointSizeFloat(), pixelSize(), QFontInfo::pointSize(), and QFontInfo::pixelSize(). +.SH "void QFont::qwsRenderToDisk ( bool all = TRUE )" +Saves the glyphs in the font that have previously been accessed as a QPF file. If \fIall\fR is TRUE (the default), then before saving, all glyphs are marked as used. +.PP +If the font is large and you are sure that only a subset of characters will ever be required on the target device, passing FALSE for the \fIall\fR parameter can save a significant amount of disk space. +.PP +Note that this function is only applicable on Qt/Embedded. +.SH "bool QFont::rawMode () const" +Returns TRUE if raw mode is used for font name matching; otherwise returns FALSE. +.PP +See also setRawMode() and rawName(). +.SH "QString QFont::rawName () const" +Returns the name of the font within the underlying window system. +.PP +On Windows, this is usually just the family name of a TrueType font. +.PP +On X11, it is an XLFD (X Logical Font Description). When Qt is build with Xft support on X11, the return value can be an Xft pattern or an XLFD. +.PP +Using the return value of this function is usually \fInot\fR \fIportable\fR. +.PP +See also setRawName(). +.SH "void QFont::removeSubstitution ( const QString & familyName )\fC [static]\fR" +Removes all the substitutions for \fIfamilyName\fR. +.PP +See also insertSubstitutions(), insertSubstitution(), substitutions(), and substitute(). +.SH "QFont QFont::resolve ( const QFont & other ) const" +Returns a new QFont that has attributes copied from \fIother\fR. +.SH "void QFont::setBold ( bool enable )" +If \fIenable\fR is true sets the font's weight to QFont::Bold; otherwise sets the weight to QFont::Normal. +.PP +For finer boldness control use setWeight(). +.PP +See also bold() and setWeight(). +.PP +Examples: +.)l menu/menu.cpp and themes/metal.cpp. +.SH "void QFont::setDefaultFont ( const QFont & f )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Please use QApplication::setFont() instead. +.SH "void QFont::setFamily ( const QString & family )" +Sets the family name of the font. The name is case insensitive and may include a foundry name. +.PP +The \fIfamily\fR name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". (The Qt 2.x syntax, i.e." Cronyx-Helvetica", is also supported.) If the \fIfamily\fR is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm. +.PP +See also family(), setStyleHint(), and QFontInfo. +.SH "void QFont::setFixedPitch ( bool enable )" +If \fIenable\fR is TRUE, sets fixed pitch on; otherwise sets fixed pitch off. +.PP +See also fixedPitch() and QFontInfo. +.SH "void QFont::setItalic ( bool enable )" +If \fIenable\fR is TRUE, italic is set on; otherwise italic is set off. +.PP +See also italic() and QFontInfo. +.PP +Examples: +.)l fileiconview/qfileiconview.cpp, fonts/simple-qfont-demo/viewer.cpp, and themes/metal.cpp. +.SH "void QFont::setOverline ( bool enable )" +If \fIenable\fR is TRUE, sets overline on; otherwise sets overline off. +.PP +See also overline() and QFontInfo. +.SH "void QFont::setPixelSize ( int pixelSize )" +Sets the font size to \fIpixelSize\fR pixels. +.PP +Using this function makes the font device dependent. Use setPointSize() or setPointSizeFloat() to set the size of the font in a device independent manner. +.PP +See also pixelSize(). +.PP +Example: qwerty/qwerty.cpp. +.SH "void QFont::setPixelSizeFloat ( float pixelSize )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the logical pixel height of font characters when shown on the screen to \fIpixelSize\fR. +.SH "void QFont::setPointSize ( int pointSize )" +Sets the point size to \fIpointSize\fR. The point size must be greater than zero. +.PP +See also pointSize() and setPointSizeFloat(). +.PP +Example: fonts/simple-qfont-demo/viewer.cpp. +.SH "void QFont::setPointSizeFloat ( float pointSize )" +Sets the point size to \fIpointSize\fR. The point size must be greater than zero. The requested precision may not be achieved on all platforms. +.PP +See also pointSizeFloat(), setPointSize(), and setPixelSize(). +.SH "void QFont::setRawMode ( bool enable )" +If \fIenable\fR is TRUE, turns raw mode on; otherwise turns raw mode off. This function only has an effect under X11. +.PP +If raw mode is enabled, Qt will search for an X font with a complete font name matching the family name, ignoring all other values set for the QFont. If the font name matches several fonts, Qt will use the first font returned by X. QFontInfo \fIcannot\fR be used to fetch information about a QFont using raw mode (it will return the values set in the QFont for all parameters, including the family name). +.PP +\fBWarning:\fR Do not use raw mode unless you really, really need it! In most (if not all) cases, setRawName() is a much better choice. +.PP +See also rawMode() and setRawName(). +.SH "void QFont::setRawName ( const QString & name )" +Sets a font by its system specific name. The function is particularly useful under X, where system font settings (for example X resources) are usually available in XLFD (X Logical Font Description) form only. You can pass an XLFD as \fIname\fR to this function. +.PP +A font set with setRawName() is still a full-featured QFont. It can be queried (for example with italic()) or modified (for example with setItalic()) and is therefore also suitable for rendering rich text. +.PP +If Qt's internal font database cannot resolve the raw name, the font becomes a raw font with \fIname\fR as its family. +.PP +Note that the present implementation does not handle wildcards in XLFDs well, and that font aliases (file \fCfonts.alias\fR in the font directory on X11) are not supported. +.PP +See also rawName(), setRawMode(), and setFamily(). +.SH "void QFont::setStretch ( int factor )" +Sets the stretch factor for the font. +.PP +The stretch factor changes the width of all characters in the font by \fIfactor\fR percent. For example, setting \fIfactor\fR to 150 results in all characters in the font being 1.5 times ( ie. 150% ) wider. The default stretch factor is 100. The minimum stretch factor is 1, and the maximum stretch factor is 4000. +.PP +The stretch factor is only applied to outline fonts. The stretch factor is ignored for bitmap fonts. +.PP +NOTE: QFont cannot stretch XLFD fonts. When loading XLFD fonts on X11, the stretch factor is matched against a predefined set of values for the SETWIDTH_NAME field of the XLFD. +.PP +See also stretch() and QFont::StyleStrategy. +.SH "void QFont::setStrikeOut ( bool enable )" +If \fIenable\fR is TRUE, sets strikeout on; otherwise sets strikeout off. +.PP +See also strikeOut() and QFontInfo. +.SH "void QFont::setStyleHint ( StyleHint hint, StyleStrategy strategy = PreferDefault )" +Sets the style hint and strategy to \fIhint\fR and \fIstrategy\fR, respectively. +.PP +If these aren't set explicitly the style hint will default to AnyStyle and the style strategy to PreferDefault. +.PP +Qt does not support style hints on X11 since this information is not provided by the window system. +.PP +See also StyleHint, styleHint(), StyleStrategy, styleStrategy(), and QFontInfo. +.PP +Examples: +.)l desktop/desktop.cpp and fonts/simple-qfont-demo/viewer.cpp. +.SH "void QFont::setStyleStrategy ( StyleStrategy s )" +Sets the style strategy for the font to \fIs\fR. +.PP +See also QFont::StyleStrategy. +.SH "void QFont::setUnderline ( bool enable )" +If \fIenable\fR is TRUE, sets underline on; otherwise sets underline off. +.PP +See also underline() and QFontInfo. +.PP +Examples: +.)l fonts/simple-qfont-demo/viewer.cpp and menu/menu.cpp. +.SH "void QFont::setWeight ( int weight )" +Sets the weight the font to \fIweight\fR, which should be a value from the QFont::Weight enumeration. +.PP +See also weight() and QFontInfo. +.PP +Example: fonts/simple-qfont-demo/viewer.cpp. +.SH "int QFont::stretch () const" +Returns the stretch factor for the font. +.PP +See also setStretch(). +.SH "bool QFont::strikeOut () const" +Returns TRUE if strikeout has been set; otherwise returns FALSE. +.PP +See also setStrikeOut(). +.SH "StyleHint QFont::styleHint () const" +Returns the StyleHint. +.PP +The style hint affects the font matching algorithm. See QFont::StyleHint for the list of strategies. +.PP +See also setStyleHint(), QFont::StyleStrategy, and QFontInfo::styleHint(). +.SH "StyleStrategy QFont::styleStrategy () const" +Returns the StyleStrategy. +.PP +The style strategy affects the font matching algorithm. See QFont::StyleStrategy for the list of strategies. +.PP +See also setStyleHint() and QFont::StyleHint. +.SH "QString QFont::substitute ( const QString & familyName )\fC [static]\fR" +Returns the first family name to be used whenever \fIfamilyName\fR is specified. The lookup is case insensitive. +.PP +If there is no substitution for \fIfamilyName\fR, \fIfamilyName\fR is returned. +.PP +To obtain a list of substitutions use substitutes(). +.PP +See also setFamily(), insertSubstitutions(), insertSubstitution(), and removeSubstitution(). +.SH "QStringList QFont::substitutes ( const QString & familyName )\fC [static]\fR" +Returns a list of family names to be used whenever \fIfamilyName\fR is specified. The lookup is case insensitive. +.PP +If there is no substitution for \fIfamilyName\fR, an empty list is returned. +.PP +See also substitute(), insertSubstitutions(), insertSubstitution(), and removeSubstitution(). +.PP +Example: fonts/simple-qfont-demo/viewer.cpp. +.SH "QStringList QFont::substitutions ()\fC [static]\fR" +Returns a sorted list of substituted family names. +.PP +See also insertSubstitution(), removeSubstitution(), and substitute(). +.SH "QString QFont::toString () const" +Returns a description of the font. The description is a comma-separated list of the attributes, perfectly suited for use in QSettings. +.PP +See also fromString() and operator<<(). +.SH "bool QFont::underline () const" +Returns TRUE if underline has been set; otherwise returns FALSE. +.PP +See also setUnderline(). +.SH "int QFont::weight () const" +Returns the weight of the font which is one of the enumerated values from QFont::Weight. +.PP +See also setWeight(), Weight, and QFontInfo. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QFont & font )" +Writes the font \fIfont\fR to the data stream \fIs\fR. (toString() writes to a text stream.) +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QFont & font )" +Reads the font \fIfont\fR from the data stream \fIs\fR. (fromString() reads from a text stream.) +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfont.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfont.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfontdatabase.3qt b/doc/man/man3/tqfontdatabase.3qt new file mode 100644 index 000000000..590297270 --- /dev/null +++ b/doc/man/man3/tqfontdatabase.3qt @@ -0,0 +1,303 @@ +'\" t +.TH QFontDatabase 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 +QFontDatabase \- Information about the fonts available in the underlying window system +.SH SYNOPSIS +\fC#include <ntqfontdatabase.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFontDatabase\fR ()" +.br +.ti -1c +.BI "QStringList \fBfamilies\fR () const" +.br +.ti -1c +.BI "QStringList \fBfamilies\fR ( QFont::Script script ) const" +.br +.ti -1c +.BI "QStringList \fBstyles\fR ( const QString & family ) const" +.br +.ti -1c +.BI "QValueList<int> \fBpointSizes\fR ( const QString & family, const QString & style = QString::null )" +.br +.ti -1c +.BI "QValueList<int> \fBsmoothSizes\fR ( const QString & family, const QString & style )" +.br +.ti -1c +.BI "QString \fBstyleString\fR ( const QFont & f )" +.br +.ti -1c +.BI "QFont \fBfont\fR ( const QString & family, const QString & style, int pointSize )" +.br +.ti -1c +.BI "bool \fBisBitmapScalable\fR ( const QString & family, const QString & style = QString::null ) const" +.br +.ti -1c +.BI "bool \fBisSmoothlyScalable\fR ( const QString & family, const QString & style = QString::null ) const" +.br +.ti -1c +.BI "bool \fBisScalable\fR ( const QString & family, const QString & style = QString::null ) const" +.br +.ti -1c +.BI "bool \fBisFixedPitch\fR ( const QString & family, const QString & style = QString::null ) const" +.br +.ti -1c +.BI "bool \fBitalic\fR ( const QString & family, const QString & style ) const" +.br +.ti -1c +.BI "bool \fBbold\fR ( const QString & family, const QString & style ) const" +.br +.ti -1c +.BI "int \fBweight\fR ( const QString & family, const QString & style ) const" +.br +.ti -1c +.BI "QStringList families ( bool ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QStringList styles ( const QString & family, const QString & ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QValueList<int> pointSizes ( const QString & family, const QString & style, const QString & ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QValueList<int> smoothSizes ( const QString & family, const QString & style, const QString & ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QFont font ( const QString & familyName, const QString & style, int pointSize, const QString & ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isBitmapScalable ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isSmoothlyScalable ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isScalable ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isFixedPitch ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool italic ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool bold ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int weight ( const QString & family, const QString & style, const QString & ) const \fI(obsolete)\fR" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QValueList<int> \fBstandardSizes\fR ()" +.br +.ti -1c +.BI "QString \fBscriptName\fR ( QFont::Script script )" +.br +.ti -1c +.BI "QString \fBscriptSample\fR ( QFont::Script script )" +.br +.in -1c +.SH DESCRIPTION +The QFontDatabase class provides information about the fonts available in the underlying window system. +.PP +The most common uses of this class are to query the database for the list of font families() and for the pointSizes() and styles() that are available for each family. An alternative to pointSizes() is smoothSizes() which returns the sizes at which a given family and style will look attractive. +.PP +If the font family is available from two or more foundries the foundry name is included in the family name, e.g. "Helvetica [Adobe]" and "Helvetica [Cronyx]". When you specify a family you can either use the old hyphenated Qt 2.x "foundry-family" format, e.g. "Cronyx-Helvetica", or the new bracketed Qt 3.x "family [foundry]" format e.g. "Helvetica [Cronyx]". If the family has a foundry it is always returned, e.g. by families(), using the bracketed format. +.PP +The font() function returns a QFont given a family, style and point size. +.PP +A family and style combination can be checked to see if it is italic() or bold(), and to retrieve its weight(). Similarly we can call isBitmapScalable(), isSmoothlyScalable(), isScalable() and isFixedPitch(). +.PP +A text version of a style is given by styleString(). +.PP +The QFontDatabase class also supports some static functions, for example, standardSizes(). You can retrieve the Unicode 3.0 description of a script using scriptName(), and a sample of characters in a script with scriptSample(). +.PP +Example: +.PP +.nf +.br +#include <ntqapplication.h> +.br +#include <ntqfontdatabase.h> +.br +#include <else.h> +.br +.br +int main( int argc, char **argv ) +.br +{ +.br + QApplication app( argc, argv ); +.br + QFontDatabase fdb; +.br + QStringList families = fdb.families(); +.br + for ( QStringList::Iterator f = families.begin(); f != families.end(); ++f ) { +.br + QString family = *f; +.br + tqDebug( family ); +.br + QStringList styles = fdb.styles( family ); +.br + for ( QStringList::Iterator s = styles.begin(); s != styles.end(); ++s ) { +.br + QString style = *s; +.br + QString dstyle = "\\t" + style + " ("; +.br + QValueList<int> smoothies = fdb.smoothSizes( family, style ); +.br + for ( QValueList<int>::Iterator points = smoothies.begin(); +.br + points != smoothies.end(); ++points ) { +.br + dstyle += QString::number( *points ) + " "; +.br + } +.br + dstyle = dstyle.left( dstyle.length() - 1 ) + ")"; +.br + tqDebug( dstyle ); +.br + } +.br + } +.br + return 0; +.br +} +.fi +This example gets the list of font families, then the list of styles for each family and the point sizes that are available for each family/style combination. +.PP +See also Environment Classes and Graphics Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFontDatabase::QFontDatabase ()" +Creates a font database object. +.SH "bool QFontDatabase::bold ( const QString & family, const QString & style ) const" +Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is bold; otherwise returns FALSE. +.PP +See also italic() and weight(). +.SH "bool QFontDatabase::bold ( const QString & family, const QString & style, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QStringList QFontDatabase::families () const" +Returns a sorted list of the names of the available font families. +.PP +If a family exists in several foundries, the returned name for that font is in the form "family [foundry]". Examples: +.)l "Times +[Adobe]", "Times [Cronyx]", "Palatino". +.SH "QStringList QFontDatabase::families ( QFont::Script script ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a sorted list of the available font families which support the Unicode script \fIscript\fR. +.PP +If a family exists in several foundries, the returned name for that font is in the form "family [foundry]". Examples: +.)l "Times +[Adobe]", "Times [Cronyx]", "Palatino". +.SH "QStringList QFontDatabase::families ( bool ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QFont QFontDatabase::font ( const QString & family, const QString & style, int pointSize )" +Returns a QFont object that has family \fIfamily\fR, style \fIstyle\fR and point size \fIpointSize\fR. If no matching font could be created, a QFont object that uses the application's default font is returned. +.SH "QFont QFontDatabase::font ( const QString & familyName, const QString & style, int pointSize, const QString & )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QFontDatabase::isBitmapScalable ( const QString & family, const QString & style = QString::null ) const" +Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is a scalable bitmap font; otherwise returns FALSE. Scaling a bitmap font usually produces an unattractive hardly readable result, because the pixels of the font are scaled. If you need to scale a bitmap font it is better to scale it to one of the fixed sizes returned by smoothSizes(). +.PP +See also isScalable() and isSmoothlyScalable(). +.SH "bool QFontDatabase::isBitmapScalable ( const QString & family, const QString & style, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QFontDatabase::isFixedPitch ( const QString & family, const QString & style = QString::null ) const" +Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is fixed pitch; otherwise returns FALSE. +.SH "bool QFontDatabase::isFixedPitch ( const QString & family, const QString & style, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QFontDatabase::isScalable ( const QString & family, const QString & style = QString::null ) const" +Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is scalable; otherwise returns FALSE. +.PP +See also isBitmapScalable() and isSmoothlyScalable(). +.SH "bool QFontDatabase::isScalable ( const QString & family, const QString & style, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QFontDatabase::isSmoothlyScalable ( const QString & family, const QString & style = QString::null ) const" +Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is smoothly scalable; otherwise returns FALSE. If this function returns TRUE, it's safe to scale this font to any size, and the result will always look attractive. +.PP +See also isScalable() and isBitmapScalable(). +.SH "bool QFontDatabase::isSmoothlyScalable ( const QString & family, const QString & style, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QFontDatabase::italic ( const QString & family, const QString & style ) const" +Returns TRUE if the font that has family \fIfamily\fR and style \fIstyle\fR is italic; otherwise returns FALSE. +.PP +See also weight() and bold(). +.SH "bool QFontDatabase::italic ( const QString & family, const QString & style, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QValueList<int> QFontDatabase::pointSizes ( const QString & family, const QString & style = QString::null )" +Returns a list of the point sizes available for the font that has family \fIfamily\fR and style \fIstyle\fR. The list may be empty. +.PP +See also smoothSizes() and standardSizes(). +.SH "QValueList<int> QFontDatabase::pointSizes ( const QString & family, const QString & style, const QString & )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QString QFontDatabase::scriptName ( QFont::Script script )\fC [static]\fR" +Returns a string that gives a default description of the \fIscript\fR (e.g. for displaying to the user in a dialog). The name matches the name of the script as defined by the Unicode 3.0 standard. +.PP +See also QFont::Script. +.SH "QString QFontDatabase::scriptSample ( QFont::Script script )\fC [static]\fR" +Returns a string with sample characters from \fIscript\fR. +.PP +See also QFont::Script. +.SH "QValueList<int> QFontDatabase::smoothSizes ( const QString & family, const QString & style )" +Returns the point sizes of a font that has family \fIfamily\fR and style \fIstyle\fR that will look attractive. The list may be empty. For non-scalable fonts and bitmap scalable fonts, this function is equivalent to pointSizes(). +.PP +See also pointSizes() and standardSizes(). +.SH "QValueList<int> QFontDatabase::smoothSizes ( const QString & family, const QString & style, const QString & )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QValueList<int> QFontDatabase::standardSizes ()\fC [static]\fR" +Returns a list of standard font sizes. +.PP +See also smoothSizes() and pointSizes(). +.SH "QString QFontDatabase::styleString ( const QFont & f )" +Returns a string that describes the style of the font \fIf\fR. For example, "Bold Italic", "Bold", "Italic" or "Normal". An empty string may be returned. +.SH "QStringList QFontDatabase::styles ( const QString & family ) const" +Returns a list of the styles available for the font family \fIfamily\fR. Some example styles: "Light", "Light Italic", "Bold"," Oblique", "Demi". The list may be empty. +.SH "QStringList QFontDatabase::styles ( const QString & family, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "int QFontDatabase::weight ( const QString & family, const QString & style ) const" +Returns the weight of the font that has family \fIfamily\fR and style \fIstyle\fR. If there is no such family and style combination, returns -1. +.PP +See also italic() and bold(). +.SH "int QFontDatabase::weight ( const QString & family, const QString & style, const QString & ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfontdatabase.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfontdatabase.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfontdialog.3qt b/doc/man/man3/tqfontdialog.3qt new file mode 100644 index 000000000..11d6a1d32 --- /dev/null +++ b/doc/man/man3/tqfontdialog.3qt @@ -0,0 +1,163 @@ +'\" t +.TH QFontDialog 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 +QFontDialog \- Dialog widget for selecting a font +.SH SYNOPSIS +\fC#include <ntqfontdialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Static Public Members" +<li class=fn>QFont \fBgetFont\fR ( bool * ok, const QFont & initial, QWidget * parent = 0, const char * name = 0 ) <li class=fn>QFont \fBgetFont\fR ( bool * ok, QWidget * parent = 0, const char * name = 0 ) +.SH DESCRIPTION +The QFontDialog class provides a dialog widget for selecting a font. +.PP +The usual way to use this class is to call one of the static convenience functions, e.g. getFont(). +.PP +Examples: +.)l +.PP +.nf +.br + bool ok; +.br + QFont font = QFontDialog::getFont( +.br + &ok, QFont( "Helvetica [Cronyx]", 10 ), this ); +.br + if ( ok ) { +.br + // font is set to the font the user selected +.br + } else { +.br + // the user canceled the dialog; font is set to the initial +.br + // value, in this case Helvetica [Cronyx], 10 +.br + } +.br +.fi +.PP +The dialog can also be used to set a widget's font directly: +.PP +.nf +.br + myWidget.setFont( QFontDialog::getFont( 0, myWidget.font() ) ); +.br +.fi +If the user clicks OK the font they chose will be used for myWidget, and if they click Cancel the original font is used. +.PP +See also QFont, QFontInfo, QFontMetrics, and Dialog Classes. +.PP +.ce 1 +.B "[Image Omitted]" +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFont QFontDialog::getFont ( bool * ok, const QFont & initial, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Executes a modal font dialog and returns a font. +.PP +If the user clicks OK, the selected font is returned. If the user clicks Cancel, the \fIinitial\fR font is returned. +.PP +The dialog is called \fIname\fR, with the parent \fIparent\fR. \fIinitial\fR is the initially selected font. If the \fIok\fR parameter is not-null, \fI*\fR\fIok\fR is set to TRUE if the user clicked OK, and set to FALSE if the user clicked Cancel. +.PP +This static function is less flexible than the full QFontDialog object, but is convenient and easy to use. +.PP +Examples: +.)l +.PP +.nf +.br + bool ok; +.br + QFont font = QFontDialog::getFont( &ok, QFont( "Times", 12 ), this ); +.br + if ( ok ) { +.br + // font is set to the font the user selected +.br + } else { +.br + // the user canceled the dialog; font is set to the initial +.br + // value, in this case Times, 12. +.br + } +.br +.fi +.PP +The dialog can also be used to set a widget's font directly: +.PP +.nf +.br + myWidget.setFont( QFontDialog::getFont( 0, myWidget.font() ) ); +.br +.fi +In this example, if the user clicks OK the font they chose will be used, and if they click Cancel the original font is used. +.PP +Examples: +.)l chart/chartform.cpp, chart/optionsform.cpp, qfd/fontdisplayer.cpp, qwerty/qwerty.cpp, and xform/xform.cpp. +.SH "QFont QFontDialog::getFont ( bool * ok, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Executes a modal font dialog and returns a font. +.PP +If the user clicks OK, the selected font is returned. If the user clicks Cancel, the Qt default font is returned. +.PP +The dialog is called \fIname\fR, with parent \fIparent\fR. If the \fIok\fR parameter is not-null, \fI*\fR\fIok\fR is set to TRUE if the user clicked OK, and FALSE if the user clicked Cancel. +.PP +This static function is less functional than the full QFontDialog object, but is convenient and easy to use. +.PP +Example: +.PP +.nf +.br + bool ok; +.br + QFont font = QFontDialog::getFont( &ok, this ); +.br + if ( ok ) { +.br + // font is set to the font the user selected +.br + } else { +.br + // the user canceled the dialog; font is set to the default +.br + // application font, QApplication::font() +.br + } +.br +.fi +.PP + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfontdialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfontdialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfontinfo.3qt b/doc/man/man3/tqfontinfo.3qt new file mode 100644 index 000000000..9f6964da6 --- /dev/null +++ b/doc/man/man3/tqfontinfo.3qt @@ -0,0 +1,175 @@ +'\" t +.TH QFontInfo 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 +QFontInfo \- General information about fonts +.SH SYNOPSIS +\fC#include <ntqfontinfo.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFontInfo\fR ( const QFont & font )" +.br +.ti -1c +.BI "\fBQFontInfo\fR ( const QFont & font, QFont::Script script )" +.br +.ti -1c +.BI "\fBQFontInfo\fR ( const QFontInfo & fi )" +.br +.ti -1c +.BI "\fB~QFontInfo\fR ()" +.br +.ti -1c +.BI "QFontInfo & \fBoperator=\fR ( const QFontInfo & fi )" +.br +.ti -1c +.BI "QString \fBfamily\fR () const" +.br +.ti -1c +.BI "int \fBpixelSize\fR () const" +.br +.ti -1c +.BI "int \fBpointSize\fR () const" +.br +.ti -1c +.BI "bool \fBitalic\fR () const" +.br +.ti -1c +.BI "int \fBweight\fR () const" +.br +.ti -1c +.BI "bool \fBbold\fR () const" +.br +.ti -1c +.BI "bool \fBfixedPitch\fR () const" +.br +.ti -1c +.BI "QFont::StyleHint \fBstyleHint\fR () const" +.br +.ti -1c +.BI "bool \fBrawMode\fR () const" +.br +.ti -1c +.BI "bool \fBexactMatch\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QFontInfo class provides general information about fonts. +.PP +The QFontInfo class provides the same access functions as QFont, e.g. family(), pointSize(), italic(), weight(), fixedPitch(), styleHint() etc. But whilst the QFont access functions return the values that were set, a QFontInfo object returns the values that apply to the font that will actually be used to draw the text. +.PP +For example, when the program asks for a 25pt Courier font on a machine that has a non-scalable 24pt Courier font, QFont will (normally) use the 24pt Courier for rendering. In this case, QFont::pointSize() returns 25 and QFontInfo::pointSize() returns 24. +.PP +There are three ways to create a QFontInfo object. <ol type=1> +.IP 1 +Calling the QFontInfo constructor with a QFont creates a font info object for a screen-compatible font, i.e. the font cannot be a printer font<sup>*</sup>. If the font is changed later, the font info object is \fInot\fR updated. +.IP 2 +QWidget::fontInfo() returns the font info for a widget's font. This is equivalent to calling QFontInfo(widget->font()). If the widget's font is changed later, the font info object is \fInot\fR updated. +.IP 3 +QPainter::fontInfo() returns the font info for a painter's current font. If the painter's font is changed later, the font info object is \fInot\fR updated. +.PP +<sup>*</sup> If you use a printer font the values returned may be inaccurate. Printer fonts are not always accessible so the nearest screen font is used if a printer font is supplied. +.PP +See also QFont, QFontMetrics, QFontDatabase, Graphics Classes, and Implicitly and Explicitly Shared Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFontInfo::QFontInfo ( const QFont & font )" +Constructs a font info object for \fIfont\fR. +.PP +The font must be screen-compatible, i.e. a font you use when drawing text in widgets or pixmaps, not QPicture or QPrinter. +.PP +The font info object holds the information for the font that is passed in the constructor at the time it is created, and is not updated if the font's attributes are changed later. +.PP +Use QPainter::fontInfo() to get the font info when painting. This will give correct results also when painting on paint device that is not screen-compatible. +.SH "QFontInfo::QFontInfo ( const QFont & font, QFont::Script script )" +Constructs a font info object for \fIfont\fR using the specified \fIscript\fR. +.SH "QFontInfo::QFontInfo ( const QFontInfo & fi )" +Constructs a copy of \fIfi\fR. +.SH "QFontInfo::~QFontInfo ()" +Destroys the font info object. +.SH "bool QFontInfo::bold () const" +Returns TRUE if weight() would return a value greater than QFont::Normal; otherwise returns FALSE. +.PP +See also weight() and QFont::bold(). +.PP +Example: qfd/fontdisplayer.cpp. +.SH "bool QFontInfo::exactMatch () const" +Returns TRUE if the matched window system font is exactly the same as the one specified by the font; otherwise returns FALSE. +.PP +See also QFont::exactMatch(). +.SH "QString QFontInfo::family () const" +Returns the family name of the matched window system font. +.PP +See also QFont::family(). +.PP +Examples: +.)l fonts/simple-qfont-demo/viewer.cpp and qfd/fontdisplayer.cpp. +.SH "bool QFontInfo::fixedPitch () const" +Returns the fixed pitch value of the matched window system font. +.PP +See also QFont::fixedPitch(). +.SH "bool QFontInfo::italic () const" +Returns the italic value of the matched window system font. +.PP +See also QFont::italic(). +.PP +Example: qfd/fontdisplayer.cpp. +.SH "QFontInfo & QFontInfo::operator= ( const QFontInfo & fi )" +Assigns the font info in \fIfi\fR. +.SH "int QFontInfo::pixelSize () const" +Returns the pixel size of the matched window system font. +.PP +See also QFont::pointSize(). +.SH "int QFontInfo::pointSize () const" +Returns the point size of the matched window system font. +.PP +See also QFont::pointSize(). +.PP +Examples: +.)l fonts/simple-qfont-demo/viewer.cpp and qfd/fontdisplayer.cpp. +.SH "bool QFontInfo::rawMode () const" +Returns TRUE if the font is a raw mode font; otherwise returns FALSE. +.PP +If it is a raw mode font, all other functions in QFontInfo will return the same values set in the QFont, regardless of the font actually used. +.PP +See also QFont::rawMode(). +.SH "QFont::StyleHint QFontInfo::styleHint () const" +Returns the style of the matched window system font. +.PP +Currently only returns the style hint set in QFont. +.PP +See also QFont::styleHint() and QFont::StyleHint. +.SH "int QFontInfo::weight () const" +Returns the weight of the matched window system font. +.PP +See also QFont::weight() and bold(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfontinfo.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfontinfo.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfontmanager.3qt b/doc/man/man3/tqfontmanager.3qt new file mode 100644 index 000000000..8f6031338 --- /dev/null +++ b/doc/man/man3/tqfontmanager.3qt @@ -0,0 +1,76 @@ +'\" t +.TH QFontManager 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 +QFontManager \- Implements font management in Qt/Embedded +.SH SYNOPSIS +\fC#include <qfontmanager_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFontManager\fR ()" +.br +.ti -1c +.BI "\fB~QFontManager\fR ()" +.br +.ti -1c +.BI "QDiskFont * \fBget\fR ( const QFontDef & f )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBinitialize\fR ()" +.br +.ti -1c +.BI "void \fBcleanup\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QFontManager class implements font management in Qt/Embedded. +.PP +There is one and only one QFontManager per Qt/Embedded application. The \fCqt_fontmanager\fR global variable points to it. It keeps a list of font factories, a cache of rendered fonts and a list of fonts available on disk. QFontManager is called when a new font needs to be rendered from a Freetype-compatible or BDF font on disk; this only happens if there isn't an appropriate QPF font already available. +.PP +See also Qt/Embedded. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFontManager::QFontManager ()" +Creates a font manager. This method reads in the font definition file from \fCINSTALL/lib/fonts/fontdir\fR, where \fCINSTALL\fR is the directory where Qt/Embedded was installed, and creates a list of QDiskFonts to hold the information in the file. It also constructs any defined font factories. +.SH "QFontManager::~QFontManager ()" +Destroys the QFontManager and sets \fCqt_fontmanager\fR to 0. +.SH "void QFontManager::cleanup ()\fC [static]\fR" +Destroys the font manager +.SH "QDiskFont * QFontManager::get ( const QFontDef & f )" +Returns the QDiskFont that best matches \fIf\fR, based on family, weight, italicity and font size. +.SH "void QFontManager::initialize ()\fC [static]\fR" +Creates a new QFontManager and points \fCqt_fontmanager\fR to it + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qfontmanager.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfontmanager.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqfontmetrics.3qt b/doc/man/man3/tqfontmetrics.3qt new file mode 100644 index 000000000..7215a4c59 --- /dev/null +++ b/doc/man/man3/tqfontmetrics.3qt @@ -0,0 +1,416 @@ +'\" t +.TH QFontMetrics 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 +QFontMetrics \- Font metrics information +.SH SYNOPSIS +\fC#include <ntqfontmetrics.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFontMetrics\fR ( const QFont & font )" +.br +.ti -1c +.BI "\fBQFontMetrics\fR ( const QFont & font, QFont::Script script )" +.br +.ti -1c +.BI "\fBQFontMetrics\fR ( const QFontMetrics & fm )" +.br +.ti -1c +.BI "\fB~QFontMetrics\fR ()" +.br +.ti -1c +.BI "QFontMetrics & \fBoperator=\fR ( const QFontMetrics & fm )" +.br +.ti -1c +.BI "int \fBascent\fR () const" +.br +.ti -1c +.BI "int \fBdescent\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "int \fBleading\fR () const" +.br +.ti -1c +.BI "int \fBlineSpacing\fR () const" +.br +.ti -1c +.BI "int \fBminLeftBearing\fR () const" +.br +.ti -1c +.BI "int \fBminRightBearing\fR () const" +.br +.ti -1c +.BI "int \fBmaxWidth\fR () const" +.br +.ti -1c +.BI "bool \fBinFont\fR ( QChar ch ) const" +.br +.ti -1c +.BI "int \fBleftBearing\fR ( QChar ch ) const" +.br +.ti -1c +.BI "int \fBrightBearing\fR ( QChar ch ) const" +.br +.ti -1c +.BI "int \fBwidth\fR ( const QString & str, int len = -1 ) const" +.br +.ti -1c +.BI "int \fBwidth\fR ( QChar ch ) const" +.br +.ti -1c +.BI "int width ( char c ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBcharWidth\fR ( const QString & str, int pos ) const" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR ( const QString & str, int len = -1 ) const" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR ( QChar ch ) const" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR ( int x, int y, int w, int h, int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" +.br +.ti -1c +.BI "QSize \fBsize\fR ( int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" +.br +.ti -1c +.BI "int \fBunderlinePos\fR () const" +.br +.ti -1c +.BI "int \fBoverlinePos\fR () const" +.br +.ti -1c +.BI "int \fBstrikeOutPos\fR () const" +.br +.ti -1c +.BI "int \fBlineWidth\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QFontMetrics class provides font metrics information. +.PP +QFontMetrics functions calculate the size of characters and strings for a given font. There are three ways you can create a QFontMetrics object: +.PP +<ol type=1> +.IP 1 +Calling the QFontMetrics constructor with a QFont creates a font metrics object for a screen-compatible font, i.e. the font cannot be a printer font<sup>*</sup>. If the font is changed later, the font metrics object is \fInot\fR updated. +.IP 2 +QWidget::fontMetrics() returns the font metrics for a widget's font. This is equivalent to QFontMetrics(widget->font()). If the widget's font is changed later, the font metrics object is \fInot\fR updated. +.IP 3 +QPainter::fontMetrics() returns the font metrics for a painter's current font. If the painter's font is changed later, the font metrics object is \fInot\fR updated. +.PP +<sup>*</sup> If you use a printer font the values returned may be inaccurate. Printer fonts are not always accessible so the nearest screen font is used if a printer font is supplied. +.PP +Once created, the object provides functions to access the individual metrics of the font, its characters, and for strings rendered in the font. +.PP +There are several functions that operate on the font: ascent(), descent(), height(), leading() and lineSpacing() return the basic size properties of the font. The underlinePos(), overlinePos(), strikeOutPos() and lineWidth() functions, return the properties of the line that underlines, overlines or strikes out the characters. These functions are all fast. +.PP +There are also some functions that operate on the set of glyphs in the font: minLeftBearing(), minRightBearing() and maxWidth(). These are by necessity slow, and we recommend avoiding them if possible. +.PP +For each character, you can get its width(), leftBearing() and rightBearing() and find out whether it is in the font using inFont(). You can also treat the character as a string, and use the string functions on it. +.PP +The string functions include width(), to return the width of a string in pixels (or points, for a printer), boundingRect(), to return a rectangle large enough to contain the rendered string, and size(), to return the size of that rectangle. +.PP +Example: +.PP +.nf +.br + QFont font( "times", 24 ); +.br + QFontMetrics fm( font ); +.br + int pixelsWide = fm.width( "What's the width of this text?" ); +.br + int pixelsHigh = fm.height(); +.br +.fi +.PP +See also QFont, QFontInfo, QFontDatabase, Graphics Classes, and Implicitly and Explicitly Shared Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFontMetrics::QFontMetrics ( const QFont & font )" +Constructs a font metrics object for \fIfont\fR. +.PP +The font must be screen-compatible, i.e. a font you use when drawing text in widgets or pixmaps, not QPicture or QPrinter. +.PP +The font metrics object holds the information for the font that is passed in the constructor at the time it is created, and is not updated if the font's attributes are changed later. +.PP +Use QPainter::fontMetrics() to get the font metrics when painting. This will give correct results also when painting on paint device that is not screen-compatible. +.SH "QFontMetrics::QFontMetrics ( const QFont & font, QFont::Script script )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a font metrics object for \fIfont\fR using the given \fIscript\fR. +.SH "QFontMetrics::QFontMetrics ( const QFontMetrics & fm )" +Constructs a copy of \fIfm\fR. +.SH "QFontMetrics::~QFontMetrics ()" +Destroys the font metrics object and frees all allocated resources. +.SH "int QFontMetrics::ascent () const" +Returns the ascent of the font. +.PP +The ascent of a font is the distance from the baseline to the highest position characters extend to. In practice, some font designers break this rule, e.g. when they put more than one accent on top of a character, or to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small. +.PP +See also descent(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp and scrollview/scrollview.cpp. +.SH "QRect QFontMetrics::boundingRect ( QChar ch ) const" +Returns the rectangle that is covered by ink if the character specified by \fIch\fR were to be drawn at the origin of the coordinate system. +.PP +Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts, and that the text output may cover \fIall\fR pixels in the bounding rectangle. For a space character the rectangle will usually be empty. +.PP +Note that the rectangle usually extends both above and below the base line. +.PP +\fBWarning:\fR The width of the returned rectangle is not the advance width of the character. Use boundingRect(const QString &) or width() instead. +.PP +See also width(). +.PP +Example: xform/xform.cpp. +.SH "QRect QFontMetrics::boundingRect ( const QString & str, int len = -1 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the bounding rectangle that contains the first \fIlen\fR characters of string \fIstr\fR. +.SH "QRect QFontMetrics::boundingRect ( int x, int y, int w, int h, int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the bounding rectangle of the first \fIlen\fR characters of \fIstr\fR, which is the set of pixels the text would cover if drawn at (0, 0). The drawing, and hence the bounding rectangle, is constrained to the rectangle (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR). +.PP +If \fIlen\fR is negative (which is the default), the entire string is used. +.PP +The \fIflgs\fR argument is the bitwise OR of the following flags: +.TP +\fCAlignAuto\fR aligns to the left border for all languages except Arabic and Hebrew where it aligns to the right. +.TP +\fCAlignLeft\fR aligns to the left border. +.TP +\fCAlignRight\fR aligns to the right border. +.TP +\fCAlignJustify\fR produces justified text. +.TP +\fCAlignHCenter\fR aligns horizontally centered. +.TP +\fCAlignTop\fR aligns to the top border. +.TP +\fCAlignBottom\fR aligns to the bottom border. +.TP +\fCAlignVCenter\fR aligns vertically centered +.TP +\fCAlignCenter\fR (== \fCAlignHCenter | AlignVCenter\fR) +.TP +\fCSingleLine\fR ignores newline characters in the text. +.TP +\fCExpandTabs\fR expands tabs (see below) +.TP +\fCShowPrefix\fR interprets "&x" as "<u>x</u>", i.e. underlined. +.TP +\fCWordBreak\fR breaks the text to fit the rectangle. +.PP +Horizontal alignment defaults to \fCAlignAuto\fR and vertical alignment defaults to \fCAlignTop\fR. +.PP +If several of the horizontal or several of the vertical alignment flags are set, the resulting alignment is undefined. +.PP +These flags are defined in ntqnamespace.h. +.PP +If \fCExpandTabs\fR is set in \fIflgs\fR, then: if \fItabarray\fR is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs; otherwise if \fItabstops\fR is non-zero, it is used as the tab spacing (in pixels). +.PP +Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts, and that the text output may cover \fIall\fR pixels in the bounding rectangle. +.PP +Newline characters are processed as linebreaks. +.PP +Despite the different actual character heights, the heights of the bounding rectangles of "Yes" and "yes" are the same. +.PP +The bounding rectangle given by this function is somewhat larger than that calculated by the simpler boundingRect() function. This function uses the maximum left and right font bearings as is necessary for multi-line text to align correctly. Also, fontHeight() and lineSpacing() are used to calculate the height, rather than individual character heights. +.PP +The \fIintern\fR argument should not be used. +.PP +See also width(), QPainter::boundingRect(), and Qt::AlignmentFlags. +.SH "int QFontMetrics::charWidth ( const QString & str, int pos ) const" +Returns the width of the character at position \fIpos\fR in the string \fIstr\fR. +.PP +The whole string is needed, as the glyph drawn may change depending on the context (the letter before and after the current one) for some languages (e.g. Arabic). +.PP +This function also takes non spacing marks and ligatures into account. +.SH "int QFontMetrics::descent () const" +Returns the descent of the font. +.PP +The descent is the distance from the base line to the lowest point characters extend to. (Note that this is different from X, which adds 1 pixel.) In practice, some font designers break this rule, e.g. to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small. +.PP +See also ascent(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp and hello/hello.cpp. +.SH "int QFontMetrics::height () const" +Returns the height of the font. +.PP +This is always equal to ascent()+descent()+1 (the 1 is for the base line). +.PP +See also leading() and lineSpacing(). +.PP +Examples: +.)l grapher/grapher.cpp, hello/hello.cpp, and qfd/fontdisplayer.cpp. +.SH "bool QFontMetrics::inFont ( QChar ch ) const" +Returns TRUE if character \fIch\fR is a valid character in the font; otherwise returns FALSE. +.PP +Example: qfd/fontdisplayer.cpp. +.SH "int QFontMetrics::leading () const" +Returns the leading of the font. +.PP +This is the natural inter-line spacing. +.PP +See also height() and lineSpacing(). +.SH "int QFontMetrics::leftBearing ( QChar ch ) const" +Returns the left bearing of character \fIch\fR in the font. +.PP +The left bearing is the right-ward distance of the left-most pixel of the character from the logical origin of the character. This value is negative if the pixels of the character extend to the left of the logical origin. +.PP +See width(QChar) for a graphical description of this metric. +.PP +See also rightBearing(), minLeftBearing(), and width(). +.PP +Example: qfd/fontdisplayer.cpp. +.SH "int QFontMetrics::lineSpacing () const" +Returns the distance from one base line to the next. +.PP +This value is always equal to leading()+height(). +.PP +See also height() and leading(). +.PP +Examples: +.)l qfd/fontdisplayer.cpp, qwerty/qwerty.cpp, and scrollview/scrollview.cpp. +.SH "int QFontMetrics::lineWidth () const" +Returns the width of the underline and strikeout lines, adjusted for the point size of the font. +.PP +See also underlinePos(), overlinePos(), and strikeOutPos(). +.SH "int QFontMetrics::maxWidth () const" +Returns the width of the widest character in the font. +.PP +Example: qfd/fontdisplayer.cpp. +.SH "int QFontMetrics::minLeftBearing () const" +Returns the minimum left bearing of the font. +.PP +This is the smallest leftBearing(char) of all characters in the font. +.PP +Note that this function can be very slow if the font is large. +.PP +See also minRightBearing() and leftBearing(). +.PP +Example: qfd/fontdisplayer.cpp. +.SH "int QFontMetrics::minRightBearing () const" +Returns the minimum right bearing of the font. +.PP +This is the smallest rightBearing(char) of all characters in the font. +.PP +Note that this function can be very slow if the font is large. +.PP +See also minLeftBearing() and rightBearing(). +.PP +Example: qfd/fontdisplayer.cpp. +.SH "QFontMetrics & QFontMetrics::operator= ( const QFontMetrics & fm )" +Assigns the font metrics \fIfm\fR. +.SH "int QFontMetrics::overlinePos () const" +Returns the distance from the base line to where an overline should be drawn. +.PP +See also underlinePos(), strikeOutPos(), and lineWidth(). +.SH "int QFontMetrics::rightBearing ( QChar ch ) const" +Returns the right bearing of character \fIch\fR in the font. +.PP +The right bearing is the left-ward distance of the right-most pixel of the character from the logical origin of a subsequent character. This value is negative if the pixels of the character extend to the right of the width() of the character. +.PP +See width() for a graphical description of this metric. +.PP +See also leftBearing(), minRightBearing(), and width(). +.PP +Example: qfd/fontdisplayer.cpp. +.SH "QSize QFontMetrics::size ( int flgs, const QString & str, int len = -1, int tabstops = 0, int * tabarray = 0, QTextParag ** intern = 0 ) const" +Returns the size in pixels of the first \fIlen\fR characters of \fIstr\fR. +.PP +If \fIlen\fR is negative (the default), the entire string is used. +.PP +The \fIflgs\fR argument is the bitwise OR of the following flags: +.TP +\fCSingleLine\fR ignores newline characters. +.TP +\fCExpandTabs\fR expands tabs (see below) +.TP +\fCShowPrefix\fR interprets "&x" as "<u>x</u>", i.e. underlined. +.TP +\fCWordBreak\fR breaks the text to fit the rectangle. +.PP +These flags are defined in ntqnamespace.h. +.PP +If \fCExpandTabs\fR is set in \fIflgs\fR, then: if \fItabarray\fR is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs; otherwise if \fItabstops\fR is non-zero, it is used as the tab spacing (in pixels). +.PP +Newline characters are processed as linebreaks. +.PP +Despite the different actual character heights, the heights of the bounding rectangles of "Yes" and "yes" are the same. +.PP +The \fIintern\fR argument should not be used. +.PP +See also boundingRect(). +.SH "int QFontMetrics::strikeOutPos () const" +Returns the distance from the base line to where the strikeout line should be drawn. +.PP +See also underlinePos(), overlinePos(), and lineWidth(). +.SH "int QFontMetrics::underlinePos () const" +Returns the distance from the base line to where an underscore should be drawn. +.PP +See also overlinePos(), strikeOutPos(), and lineWidth(). +.SH "int QFontMetrics::width ( QChar ch ) const" +.ce 1 +.B "[Image Omitted]" +.PP +Returns the logical width of character \fIch\fR in pixels. This is a distance appropriate for drawing a subsequent character after \fIch\fR. +.PP +Some of the metrics are described in the image to the right. The central dark rectangles cover the logical width() of each character. The outer pale rectangles cover the leftBearing() and rightBearing() of each character. Notice that the bearings of "f" in this particular font are both negative, while the bearings of" o" are both positive. +.PP +\fBWarning:\fR This function will produce incorrect results for Arabic characters or non spacing marks in the middle of a string, as the glyph shaping and positioning of marks that happens when processing strings cannot be taken into account. Use charWidth() instead if you aren't looking for the width of isolated characters. +.PP +See also boundingRect() and charWidth(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp, hello/hello.cpp, movies/main.cpp, qfd/fontdisplayer.cpp, and scrollview/scrollview.cpp. +.SH "int QFontMetrics::width ( const QString & str, int len = -1 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the width of the first \fIlen\fR characters of string \fIstr\fR. +.SH "int QFontMetrics::width ( char c ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Provided to aid porting from Qt 1.x. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqfontmetrics.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqfontmetrics.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqframe.3qt b/doc/man/man3/tqframe.3qt new file mode 100644 index 000000000..1e1fb6298 --- /dev/null +++ b/doc/man/man3/tqframe.3qt @@ -0,0 +1,405 @@ +'\" t +.TH QFrame 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 +QFrame \- The base class of widgets that can have a frame +.SH SYNOPSIS +\fC#include <ntqframe.h>\fR +.PP +Inherits QWidget. +.PP +Inherited by QGroupBox, QScrollView, QDockWindow, QGrid, QHBox, QLabel, QLCDNumber, QLineEdit, QMenuBar, QPopupMenu, QProgressBar, QSplitter, QToolBox, and QWidgetStack. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFrame\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "int \fBframeStyle\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFrameStyle\fR ( int style )" +.br +.ti -1c +.BI "int \fBframeWidth\fR () const" +.br +.ti -1c +.BI "QRect \fBcontentsRect\fR () const" +.br +.ti -1c +.BI "enum \fBShape\fR { NoFrame = 0, Box = 0x0001, Panel = 0x0002, WinPanel = 0x0003, HLine = 0x0004, VLine = 0x0005, StyledPanel = 0x0006, PopupPanel = 0x0007, MenuBarPanel = 0x0008, ToolBarPanel = 0x0009, LineEditPanel = 0x000a, TabWidgetPanel = 0x000b, GroupBoxPanel = 0x000c, MShape = 0x000f }" +.br +.ti -1c +.BI "enum \fBShadow\fR { Plain = 0x0010, Raised = 0x0020, Sunken = 0x0030, MShadow = 0x00f0 }" +.br +.ti -1c +.BI "Shape \fBframeShape\fR () const" +.br +.ti -1c +.BI "void \fBsetFrameShape\fR ( Shape )" +.br +.ti -1c +.BI "Shadow \fBframeShadow\fR () const" +.br +.ti -1c +.BI "void \fBsetFrameShadow\fR ( Shadow )" +.br +.ti -1c +.BI "int \fBlineWidth\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetLineWidth\fR ( int )" +.br +.ti -1c +.BI "int \fBmargin\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMargin\fR ( int )" +.br +.ti -1c +.BI "int \fBmidLineWidth\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMidLineWidth\fR ( int )" +.br +.ti -1c +.BI "QRect \fBframeRect\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFrameRect\fR ( const QRect & )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QRect \fBcontentsRect\fR - the rectangle inside the frame \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QRect \fBframeRect\fR - the frame rectangle" +.br +.ti -1c +.BI "Shadow \fBframeShadow\fR - the frame shadow value from the frame style" +.br +.ti -1c +.BI "Shape \fBframeShape\fR - the frame shape value from the frame style" +.br +.ti -1c +.BI "int \fBframeWidth\fR - the width of the frame that is drawn \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBlineWidth\fR - the line width" +.br +.ti -1c +.BI "int \fBmargin\fR - the width of the margin" +.br +.ti -1c +.BI "int \fBmidLineWidth\fR - the width of the mid-line" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * event )" +.br +.ti -1c +.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * e )" +.br +.ti -1c +.BI "virtual void \fBdrawFrame\fR ( QPainter * p )" +.br +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * )" +.br +.ti -1c +.BI "virtual void \fBframeChanged\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QFrame class is the base class of widgets that can have a frame. +.PP +It draws a frame and calls a virtual function, drawContents(), to fill in the frame. This function is reimplemented by subclasses. There are also two other less useful functions: drawFrame() and frameChanged(). +.PP +QPopupMenu uses this to "raise" the menu above the surrounding screen. QProgressBar has a "sunken" look. QLabel has a flat look. The frames of widgets like these can be changed. +.PP +.nf +.br + QLabel label(...); +.br + label.setFrameStyle( QFrame::Panel | QFrame::Raised ); +.br + label.setLineWidth( 2 ); +.br +.br + QProgressBar pbar(...); +.br + label.setFrameStyle( QFrame::NoFrame ); +.br +.fi +.PP +The QFrame class can also be used directly for creating simple frames without any contents, although usually you would use a QHBox or QVBox because they automatically lay out the widgets you put inside the frame. +.PP +A frame widget has four attributes: frameStyle(), lineWidth(), midLineWidth(), and margin(). +.PP +The frame style is specified by a frame shape and a shadow style. The frame shapes are NoFrame, Box, Panel, StyledPanel, PopupPanel, WinPanel, ToolBarPanel, MenuBarPanel, HLine and VLine; the shadow styles are Plain, Raised and Sunken. +.PP +The line width is the width of the frame border. +.PP +The mid-line width specifies the width of an extra line in the middle of the frame, which uses a third color to obtain a special 3D effect. Notice that a mid-line is only drawn for Box, HLine and VLine frames that are raised or sunken. +.PP +The margin is the gap between the frame and the contents of the frame. +.PP +This table shows the most useful combinations of styles and widths (and some rather useless ones): +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also Abstract Widget Classes. +.SS "Member Type Documentation" +.SH "QFrame::Shadow" +This enum type defines the 3D effect used for QFrame's frame. +.TP +\fCQFrame::Plain\fR - the frame and contents appear level with the surroundings; draws using the palette foreground color (without any 3D effect) +.TP +\fCQFrame::Raised\fR - the frame and contents appear raised; draws a 3D raised line using the light and dark colors of the current color group +.TP +\fCQFrame::Sunken\fR - the frame and contents appear sunken; draws a 3D sunken line using the light and dark colors of the current color group +.TP +\fCQFrame::MShadow\fR - internal; mask for the shadow +.PP +Shadow interacts with QFrame::Shape, the lineWidth() and the midLineWidth(). See the picture of the frames in the class description. +.PP +See also QFrame::Shape, lineWidth, and midLineWidth. +.SH "QFrame::Shape" +This enum type defines the shapes of a QFrame's frame. +.TP +\fCQFrame::NoFrame\fR - QFrame draws nothing +.TP +\fCQFrame::Box\fR - QFrame draws a box around its contents +.TP +\fCQFrame::Panel\fR - QFrame draws a panel to make the contents appear raised or sunken +.TP +\fCQFrame::StyledPanel\fR - draws a rectangular panel with a look that depends on the current GUI style. It can be raised or sunken. +.TP +\fCQFrame::HLine\fR - QFrame draws a horizontal line that frames nothing (useful as separator) +.TP +\fCQFrame::VLine\fR - QFrame draws a vertical line that frames nothing (useful as separator) +.TP +\fCQFrame::GroupBoxPanel\fR - draws a rectangular panel +.TP +\fCQFrame::WinPanel\fR - draws a rectangular panel that can be raised or sunken like those in Windows 95. Specifying this shape sets the line width to 2 pixels. WinPanel is provided for compatibility. For GUI style independence we recommend using StyledPanel instead. +.TP +\fCQFrame::ToolBarPanel\fR +.TP +\fCQFrame::MenuBarPanel\fR +.TP +\fCQFrame::PopupPanel\fR +.TP +\fCQFrame::LineEditPanel\fR - is used to draw a frame suitable for line edits. The look depends upon the current GUI style. +.TP +\fCQFrame::TabWidgetPanel\fR - is used to draw a frame suitable for tab widgets. The look depends upon the current GUI style. +.TP +\fCQFrame::MShape\fR - internal mask +.PP +When it does not call QStyle, Shape interacts with QFrame::Shadow, the lineWidth() and the midLineWidth() to create the total result. See the picture of the frames in the class description. +.PP +See also QFrame::Shadow, QFrame::style(), and QStyle::drawPrimitive(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFrame::QFrame ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a frame widget with frame style NoFrame and a 1-pixel frame width. +.PP +The \fIparent\fR, \fIname\fR and \fIf\fR arguments are passed to the QWidget constructor. +.SH "QRect QFrame::contentsRect () const" +Returns the rectangle inside the frame. See the "contentsRect" property for details. +.SH "void QFrame::drawContents ( QPainter * )\fC [virtual protected]\fR" +Virtual function that draws the contents of the frame. +.PP +The QPainter is already open when you get it, and you must leave it open. Painter transformations are switched off on entry. If you transform the painter, remember to take the frame into account and reset transformation before returning. +.PP +This function is reimplemented by subclasses that draw something inside the frame. It should only draw inside contentsRect(). The default function does nothing. +.PP +See also contentsRect and QPainter::setClipRect(). +.PP +Reimplemented in QLabel, QLCDNumber, QMenuBar, and QPopupMenu. +.SH "void QFrame::drawFrame ( QPainter * p )\fC [virtual protected]\fR" +Draws the frame using the painter \fIp\fR and the current frame attributes and color group. The rectangle inside the frame is not affected. +.PP +This function is virtual, but in general you do not need to reimplement it. If you do, note that the QPainter is already open and must remain open. +.PP +See also frameRect, contentsRect, drawContents(), frameStyle(), and palette. +.SH "void QFrame::frameChanged ()\fC [virtual protected]\fR" +Virtual function that is called when the frame style, line width or mid-line width changes. +.PP +This function can be reimplemented by subclasses that need to know when the frame attributes change. +.PP +The default implementation calls update(). +.SH "QRect QFrame::frameRect () const" +Returns the frame rectangle. See the "frameRect" property for details. +.SH "Shadow QFrame::frameShadow () const" +Returns the frame shadow value from the frame style. See the "frameShadow" property for details. +.SH "Shape QFrame::frameShape () const" +Returns the frame shape value from the frame style. See the "frameShape" property for details. +.SH "int QFrame::frameStyle () const" +Returns the frame style. +.PP +The default value is QFrame::NoFrame. +.PP +See also setFrameStyle(), frameShape, and frameShadow. +.PP +Example: scrollview/scrollview.cpp. +.SH "int QFrame::frameWidth () const" +Returns the width of the frame that is drawn. See the "frameWidth" property for details. +.SH "int QFrame::lineWidth () const" +Returns the line width. See the "lineWidth" property for details. +.SH "int QFrame::margin () const" +Returns the width of the margin. See the "margin" property for details. +.SH "int QFrame::midLineWidth () const" +Returns the width of the mid-line. See the "midLineWidth" property for details. +.SH "void QFrame::paintEvent ( QPaintEvent * event )\fC [virtual protected]\fR" +Processes the paint event \fIevent\fR. +.PP +Paints the frame and the contents. +.PP +Opens the painter on the frame and calls drawFrame(), then drawContents(). +.PP +Examples: +.)l life/life.cpp and qfd/fontdisplayer.cpp. +.PP +Reimplemented from QWidget. +.SH "void QFrame::resizeEvent ( QResizeEvent * e )\fC [virtual protected]\fR" +Processes the resize event \fIe\fR. +.PP +Adjusts the frame rectangle for the resized widget. The frame rectangle is elastic, and the surrounding area is static. +.PP +The resulting frame rectangle may be null or invalid. You can use setMinimumSize() to avoid those possibilities. +.PP +Nothing is done if the frame rectangle is a null rectangle already. +.PP +Example: life/life.cpp. +.PP +Reimplemented from QWidget. +.SH "void QFrame::setFrameRect ( const QRect & )\fC [virtual]\fR" +Sets the frame rectangle. See the "frameRect" property for details. +.SH "void QFrame::setFrameShadow ( Shadow )" +Sets the frame shadow value from the frame style. See the "frameShadow" property for details. +.SH "void QFrame::setFrameShape ( Shape )" +Sets the frame shape value from the frame style. See the "frameShape" property for details. +.SH "void QFrame::setFrameStyle ( int style )\fC [virtual]\fR" +Sets the frame style to \fIstyle\fR. +.PP +The \fIstyle\fR is the bitwise OR between a frame shape and a frame shadow style. See the illustration in the class documentation. +.PP +The frame shapes are given in QFrame::Shape and the shadow styles in QFrame::Shadow. +.PP +If a mid-line width greater than 0 is specified, an additional line is drawn for Raised or Sunken Box, HLine, and VLine frames. The mid-color of the current color group is used for drawing middle lines. +.PP +See also Illustration, frameStyle(), colorGroup, and QColorGroup. +.PP +Examples: +.)l cursor/cursor.cpp, layout/layout.cpp, listboxcombo/listboxcombo.cpp, rangecontrols/rangecontrols.cpp, scrollview/scrollview.cpp, tabdialog/tabdialog.cpp, and tictac/tictac.cpp. +.SH "void QFrame::setLineWidth ( int )\fC [virtual]\fR" +Sets the line width. See the "lineWidth" property for details. +.SH "void QFrame::setMargin ( int )\fC [virtual]\fR" +Sets the width of the margin. See the "margin" property for details. +.SH "void QFrame::setMidLineWidth ( int )\fC [virtual]\fR" +Sets the width of the mid-line. See the "midLineWidth" property for details. +.SS "Property Documentation" +.SH "QRect contentsRect" +This property holds the rectangle inside the frame. +.PP +Get this property's value with contentsRect(). +.PP +See also frameRect and drawContents(). +.SH "QRect frameRect" +This property holds the frame rectangle. +.PP +The frame rectangle is the rectangle the frame is drawn in. By default, this is the entire widget. Setting this property does \fInot\fR cause a widget update. +.PP +If this property is set to a null rectangle (for example \fCQRect(0, 0, 0, 0)\fR), then the frame rectangle is equivalent to the widget rectangle. +.PP +See also contentsRect. +.PP +Set this property's value with setFrameRect() and get this property's value with frameRect(). +.SH "Shadow frameShadow" +This property holds the frame shadow value from the frame style. +.PP +Set this property's value with setFrameShadow() and get this property's value with frameShadow(). +.PP +See also frameStyle() and frameShape. +.SH "Shape frameShape" +This property holds the frame shape value from the frame style. +.PP +Set this property's value with setFrameShape() and get this property's value with frameShape(). +.PP +See also frameStyle() and frameShadow. +.SH "int frameWidth" +This property holds the width of the frame that is drawn. +.PP +Note that the frame width depends on the frame style, not only the line width and the mid-line width. For example, the style NoFrame always has a frame width of 0, whereas the style Panel has a frame width equivalent to the line width. The frame width also includes the margin. +.PP +See also lineWidth, midLineWidth, frameStyle(), and margin. +.PP +Get this property's value with frameWidth(). +.SH "int lineWidth" +This property holds the line width. +.PP +Note that the \fItotal\fR line width for HLine and VLine is given by frameWidth(), not lineWidth(). +.PP +The default value is 1. +.PP +See also midLineWidth and frameWidth. +.PP +Set this property's value with setLineWidth() and get this property's value with lineWidth(). +.SH "int margin" +This property holds the width of the margin. +.PP +The margin is the distance between the innermost pixel of the frame and the outermost pixel of contentsRect(). It is included in frameWidth(). +.PP +The margin is filled according to backgroundMode(). +.PP +The default value is 0. +.PP +See also margin, lineWidth, and frameWidth. +.PP +Set this property's value with setMargin() and get this property's value with margin(). +.SH "int midLineWidth" +This property holds the width of the mid-line. +.PP +The default value is 0. +.PP +See also lineWidth and frameWidth. +.PP +Set this property's value with setMidLineWidth() and get this property's value with midLineWidth(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqframe.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqframe.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqftp.3qt b/doc/man/man3/tqftp.3qt new file mode 100644 index 000000000..6622021ed --- /dev/null +++ b/doc/man/man3/tqftp.3qt @@ -0,0 +1,649 @@ +'\" t +.TH QFtp 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 +QFtp \- Implementation of the FTP protocol +.SH SYNOPSIS +\fC#include <ntqftp.h>\fR +.PP +Inherits QNetworkProtocol. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQFtp\fR ()" +.br +.ti -1c +.BI "\fBQFtp\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QFtp\fR ()" +.br +.ti -1c +.BI "enum \fBState\fR { Unconnected, HostLookup, Connecting, Connected, LoggedIn, Closing }" +.br +.ti -1c +.BI "enum \fBError\fR { NoError, UnknownError, HostNotFound, ConnectionRefused, NotConnected }" +.br +.ti -1c +.BI "enum \fBCommand\fR { None, ConnectToHost, Login, Close, List, Cd, Get, Put, Remove, Mkdir, Rmdir, Rename, RawCommand }" +.br +.ti -1c +.BI "int \fBconnectToHost\fR ( const QString & host, TQ_UINT16 port = 21 )" +.br +.ti -1c +.BI "int \fBlogin\fR ( const QString & user = QString::null, const QString & password = QString::null )" +.br +.ti -1c +.BI "int \fBclose\fR ()" +.br +.ti -1c +.BI "int \fBlist\fR ( const QString & dir = QString::null )" +.br +.ti -1c +.BI "int \fBcd\fR ( const QString & dir )" +.br +.ti -1c +.BI "int \fBget\fR ( const QString & file, QIODevice * dev = 0 )" +.br +.ti -1c +.BI "int \fBput\fR ( const QByteArray & data, const QString & file )" +.br +.ti -1c +.BI "int \fBput\fR ( QIODevice * dev, const QString & file )" +.br +.ti -1c +.BI "int \fBremove\fR ( const QString & file )" +.br +.ti -1c +.BI "int \fBmkdir\fR ( const QString & dir )" +.br +.ti -1c +.BI "int \fBrmdir\fR ( const QString & dir )" +.br +.ti -1c +.BI "int \fBrename\fR ( const QString & oldname, const QString & newname )" +.br +.ti -1c +.BI "int \fBrawCommand\fR ( const QString & command )" +.br +.ti -1c +.BI "TQ_ULONG \fBbytesAvailable\fR () const" +.br +.ti -1c +.BI "TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" +.br +.ti -1c +.BI "QByteArray \fBreadAll\fR ()" +.br +.ti -1c +.BI "int \fBcurrentId\fR () const" +.br +.ti -1c +.BI "QIODevice * \fBcurrentDevice\fR () const" +.br +.ti -1c +.BI "Command \fBcurrentCommand\fR () const" +.br +.ti -1c +.BI "bool \fBhasPendingCommands\fR () const" +.br +.ti -1c +.BI "void \fBclearPendingCommands\fR ()" +.br +.ti -1c +.BI "State \fBstate\fR () const" +.br +.ti -1c +.BI "Error \fBerror\fR () const" +.br +.ti -1c +.BI "QString \fBerrorString\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBabort\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBstateChanged\fR ( int state )" +.br +.ti -1c +.BI "void \fBlistInfo\fR ( const QUrlInfo & i )" +.br +.ti -1c +.BI "void \fBreadyRead\fR ()" +.br +.ti -1c +.BI "void \fBdataTransferProgress\fR ( int done, int total )" +.br +.ti -1c +.BI "void \fBrawCommandReply\fR ( int replyCode, const QString & detail )" +.br +.ti -1c +.BI "void \fBcommandStarted\fR ( int id )" +.br +.ti -1c +.BI "void \fBcommandFinished\fR ( int id, bool error )" +.br +.ti -1c +.BI "void \fBdone\fR ( bool error )" +.br +.in -1c +.SH DESCRIPTION +The QFtp class provides an implementation of the FTP protocol. +.PP +This class provides two different interfaces: one is the QNetworkProtocol interface that allows you to use FTP through the QUrlOperator abstraction. The other is a direct interface to FTP that gives you lower-level access to the FTP protocol for finer control. Using the direct interface you can also execute arbitrary FTP commands. +.PP +Don't mix the two interfaces, since the behavior is not well-defined. +.PP +If you want to use QFtp with the QNetworkProtocol interface, you do not use it directly, but rather through a QUrlOperator, for example: +.PP +.nf +.br + QUrlOperator op( "ftp://ftp.trolltech.com" ); +.br + op.listChildren(); // Asks the server to provide a directory listing +.br +.fi +.PP +This code will only work if the QFtp class is registered; to register the class, you must call tqInitNetworkProtocols() before using a QUrlOperator with QFtp. +.PP +The rest of this descrption describes the direct interface to FTP. +.PP +The class works asynchronously, so there are no blocking functions. If an operation cannot be executed immediately, the function will still return straight away and the operation will be scheduled for later execution. The results of scheduled operations are reported via signals. This approach depends on the event loop being in operation. +.PP +The operations that can be scheduled (they are called "commands" in the rest of the documentation) are the following: connectToHost(), login(), close(), list(), cd(), get(), put(), remove(), mkdir(), rmdir(), rename() and rawCommand(). +.PP +All of these commands return a unique identifier that allows you to keep track of the command that is currently being executed. When the execution of a command starts, the commandStarted() signal with the command's identifier is emitted. When the command is finished, the commandFinished() signal is emitted with the command's identifier and a bool that indicates whether the command finished with an error. +.PP +In some cases, you might want to execute a sequence of commands, e.g. if you want to connect and login to a FTP server. This is simply achieved: +.PP +.nf +.br + QFtp *ftp = new QFtp( this ); // this is an optional QObject parent +.br + ftp->connectToHost( "ftp.trolltech.com" ); +.br + ftp->login(); +.br +.fi +.PP +In this case two FTP commands have been scheduled. When the last scheduled command has finished, a done() signal is emitted with a bool argument that tells you whether the sequence finished with an error. +.PP +If an error occurs during the execution of one of the commands in a sequence of commands, all the pending commands (i.e. scheduled, but not yet executed commands) are cleared and no signals are emitted for them. +.PP +Some commands, e.g. list(), emit additional signals to report their results. +.PP +Example: If you want to download the INSTALL file from Trolltech's FTP server, you would write this: +.PP +.nf +.br + ftp->connectToHost( "ftp.trolltech.com" ); // id == 1 +.br + ftp->login(); // id == 2 +.br + ftp->cd( "qt" ); // id == 3 +.br + ftp->get( "INSTALL" ); // id == 4 +.br + ftp->close(); // id == 5 +.br +.fi +.PP +For this example the following sequence of signals is emitted (with small variations, depending on network traffic, etc.): +.PP +.nf +.br + start( 1 ) +.br + stateChanged( HostLookup ) +.br + stateChanged( Connecting ) +.br + stateChanged( Connected ) +.br + finished( 1, FALSE ) +.br +.br + start( 2 ) +.br + stateChanged( LoggedIn ) +.br + finished( 2, FALSE ) +.br +.br + start( 3 ) +.br + finished( 3, FALSE ) +.br +.br + start( 4 ) +.br + dataTransferProgress( 0, 3798 ) +.br + dataTransferProgress( 2896, 3798 ) +.br + readyRead() +.br + dataTransferProgress( 3798, 3798 ) +.br + readyRead() +.br + finished( 4, FALSE ) +.br +.br + start( 5 ) +.br + stateChanged( Closing ) +.br + stateChanged( Unconnected ) +.br + finished( 5, FALSE ) +.br +.br + done( FALSE ) +.br +.fi +.PP +The dataTransferProgress() signal in the above example is useful if you want to show a progressbar to inform the user about the progress of the download. The readyRead() signal tells you that there is data ready to be read. The amount of data can be queried then with the bytesAvailable() function and it can be read with the readBlock() or readAll() function. +.PP +If the login fails for the above example, the signals would look like this: +.PP +.nf +.br + start( 1 ) +.br + stateChanged( HostLookup ) +.br + stateChanged( Connecting ) +.br + stateChanged( Connected ) +.br + finished( 1, FALSE ) +.br +.br + start( 2 ) +.br + finished( 2, TRUE ) +.br +.br + done( TRUE ) +.br +.fi +.PP +You can then get details about the error with the error() and errorString() functions. +.PP +The functions currentId() and currentCommand() provide more information about the currently executing command. +.PP +The functions hasPendingCommands() and clearPendingCommands() allow you to query and clear the list of pending commands. +.PP +The safest and easiest way to use the FTP protocol is to use QUrlOperator() or the FTP commands described above. If you are an experienced network programmer and want to have complete control you can use rawCommand() to execute arbitrary FTP commands. +.PP +See also Qt Network Documentation, QNetworkProtocol, QUrlOperator, QHttp, and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QFtp::Command" +This enum is used as the return value for the currentCommand() function. This allows you to perform specific actions for particular commands, e.g. in a FTP client, you might want to clear the directory view when a list() command is started; in this case you can simply check in the slot connected to the start() signal if the currentCommand() is List. +.TP +\fCQFtp::None\fR - No command is being executed. +.TP +\fCQFtp::ConnectToHost\fR - connectToHost() is being executed. +.TP +\fCQFtp::Login\fR - login() is being executed. +.TP +\fCQFtp::Close\fR - close() is being executed. +.TP +\fCQFtp::List\fR - list() is being executed. +.TP +\fCQFtp::Cd\fR - cd() is being executed. +.TP +\fCQFtp::Get\fR - get() is being executed. +.TP +\fCQFtp::Put\fR - put() is being executed. +.TP +\fCQFtp::Remove\fR - remove() is being executed. +.TP +\fCQFtp::Mkdir\fR - mkdir() is being executed. +.TP +\fCQFtp::Rmdir\fR - rmdir() is being executed. +.TP +\fCQFtp::Rename\fR - rename() is being executed. +.TP +\fCQFtp::RawCommand\fR - rawCommand() is being executed. +.PP +See also currentCommand(). +.SH "QFtp::Error" +This enum identifies the error that occurred. +.TP +\fCQFtp::NoError\fR - No error occurred. +.TP +\fCQFtp::HostNotFound\fR - The host name lookup failed. +.TP +\fCQFtp::ConnectionRefused\fR - The server refused the connection. +.TP +\fCQFtp::NotConnected\fR - Tried to send a command, but there is no connection to a server. +.TP +\fCQFtp::UnknownError\fR - An error other than those specified above occurred. +.PP +See also error(). +.SH "QFtp::State" +This enum defines the connection state: +.TP +\fCQFtp::Unconnected\fR - There is no connection to the host. +.TP +\fCQFtp::HostLookup\fR - A host name lookup is in progress. +.TP +\fCQFtp::Connecting\fR - An attempt to connect to the host is in progress. +.TP +\fCQFtp::Connected\fR - Connection to the host has been achieved. +.TP +\fCQFtp::LoggedIn\fR - Connection and user login have been achieved. +.TP +\fCQFtp::Closing\fR - The connection is closing down, but it is not yet closed. (The state will be Unconnected when the connection is closed.) +.PP +See also stateChanged() and state(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QFtp::QFtp ()" +Constructs a QFtp object. +.SH "QFtp::QFtp ( QObject * parent, const char * name = 0 )" +Constructs a QFtp object. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. +.SH "QFtp::~QFtp ()\fC [virtual]\fR" +Destructor. +.SH "void QFtp::abort ()\fC [slot]\fR" +Aborts the current command and deletes all scheduled commands. +.PP +If there is an unfinished command (i.e. a command for which the commandStarted() signal has been emitted, but for which the commandFinished() signal has not been emitted), this function sends an \fCABORT\fR command to the server. When the server replies that the command is aborted, the commandFinished() signal with the \fCerror\fR argument set to \fCTRUE\fR is emitted for the command. Due to timing issues, it is possible that the command had already finished before the abort request reached the server, in which case, the commandFinished() signal is emitted with the \fCerror\fR argument set to \fCFALSE\fR. +.PP +For all other commands that are affected by the abort(), no signals are emitted. +.PP +If you don't start further FTP commands directly after the abort(), there won't be any scheduled commands and the done() signal is emitted. +.PP +\fBWarning:\fR Some FTP servers, for example the BSD FTP daemon (version 0.3), wrongly return a positive reply even when an abort has occurred. For these servers the commandFinished() signal has its error flag set to \fCFALSE\fR, even though the command did not complete successfully. +.PP +See also clearPendingCommands(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "TQ_ULONG QFtp::bytesAvailable () const" +Returns the number of bytes that can be read from the data socket at the moment. +.PP +See also get(), readyRead(), readBlock(), and readAll(). +.SH "int QFtp::cd ( const QString & dir )" +Changes the working directory of the server to \fIdir\fR. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also commandStarted() and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QFtp::clearPendingCommands ()" +Deletes all pending commands from the list of scheduled commands. This does not affect the command that is being executed. If you want to stop this this as well, use abort(). +.PP +See also hasPendingCommands() and abort(). +.SH "int QFtp::close ()" +Closes the connection to the FTP server. +.PP +The stateChanged() signal is emitted when the state of the connecting process changes, e.g. to Closing, then Unconnected. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also stateChanged(), commandStarted(), and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QFtp::commandFinished ( int id, bool error )\fC [signal]\fR" +This signal is emitted when processing the command identified by \fIid\fR has finished. \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. +.PP +See also commandStarted(), done(), error(), and errorString(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QFtp::commandStarted ( int id )\fC [signal]\fR" +This signal is emitted when processing the command identified by \fIid\fR starts. +.PP +See also commandFinished() and done(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "int QFtp::connectToHost ( const QString & host, TQ_UINT16 port = 21 )" +Connects to the FTP server \fIhost\fR using port \fIport\fR. +.PP +The stateChanged() signal is emitted when the state of the connecting process changes, e.g. to HostLookup, then Connecting, then Connected. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also stateChanged(), commandStarted(), and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "Command QFtp::currentCommand () const" +Returns the command type of the FTP command being executed or None if there is no command being executed. +.PP +See also currentId(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "QIODevice * QFtp::currentDevice () const" +Returns the QIODevice pointer that is used by the FTP command to read data from or store data to. If there is no current FTP command being executed or if the command does not use an IO device, this function returns 0. +.PP +This function can be used to delete the QIODevice in the slot connected to the commandFinished() signal. +.PP +See also get() and put(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "int QFtp::currentId () const" +Returns the identifier of the FTP command that is being executed or 0 if there is no command being executed. +.PP +See also currentCommand(). +.SH "void QFtp::dataTransferProgress ( int done, int total )\fC [signal]\fR" +This signal is emitted in response to a get() or put() request to indicate the current progress of the download or upload. +.PP +\fIdone\fR is the amount of data that has already been transferred and \fItotal\fR is the total amount of data to be read or written. It is possible that the QFtp class is not able to determine the total amount of data that should be transferred, in which case \fItotal\fR is 0. (If you connect this signal to a QProgressBar, the progress bar shows a busy indicator if the total is 0). +.PP +\fBWarning:\fR \fIdone\fR and \fItotal\fR are not necessarily the size in bytes, since for large files these values might need to be" scaled" to avoid overflow. +.PP +See also get(), put(), and QProgressBar::progress. +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QFtp::done ( bool error )\fC [signal]\fR" +This signal is emitted when the last pending command has finished; (it is emitted after the last command's commandFinished() signal). \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. +.PP +See also commandFinished(), error(), and errorString(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "Error QFtp::error () const" +Returns the last error that occurred. This is useful to find out what when wrong when receiving a commandFinished() or a done() signal with the \fCerror\fR argument set to \fCTRUE\fR. +.PP +If you start a new command, the error status is reset to NoError. +.SH "QString QFtp::errorString () const" +Returns a human-readable description of the last error that occurred. This is useful for presenting a error message to the user when receiving a commandFinished() or a done() signal with the \fCerror\fR argument set to \fCTRUE\fR. +.PP +The error string is often (but not always) the reply from the server, so it is not always possible to translate the string. If the message comes from Qt, the string has already passed through tr(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "int QFtp::get ( const QString & file, QIODevice * dev = 0 )" +Downloads the file \fIfile\fR from the server. +.PP +If \fIdev\fR is 0, then the readyRead() signal is emitted when there is data available to read. You can then read the data with the readBlock() or readAll() functions. +.PP +If \fIdev\fR is not 0, the data is written directly to the device \fIdev\fR. Make sure that the \fIdev\fR pointer is valid for the duration of the operation (it is safe to delete it when the commandFinished() signal is emitted). In this case the readyRead() signal is \fInot\fR emitted and you cannot read data with the readBlock() or readAll() functions. +.PP +If you don't read the data immediately it becomes available, i.e. when the readyRead() signal is emitted, it is still available until the next command is started. +.PP +For example, if you want to present the data to the user as soon as there is something available, connect to the readyRead() signal and read the data immediately. On the other hand, if you only want to work with the complete data, you can connect to the commandFinished() signal and read the data when the get() command is finished. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also readyRead(), dataTransferProgress(), commandStarted(), and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "bool QFtp::hasPendingCommands () const" +Returns TRUE if there are any commands scheduled that have not yet been executed; otherwise returns FALSE. +.PP +The command that is being executed is \fInot\fR considered as a scheduled command. +.PP +See also clearPendingCommands(), currentId(), and currentCommand(). +.SH "int QFtp::list ( const QString & dir = QString::null )" +Lists the contents of directory \fIdir\fR on the FTP server. If \fIdir\fR is empty, it lists the contents of the current directory. +.PP +The listInfo() signal is emitted for each directory entry found. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also listInfo(), commandStarted(), and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QFtp::listInfo ( const QUrlInfo & i )\fC [signal]\fR" +This signal is emitted for each directory entry the list() command finds. The details of the entry are stored in \fIi\fR. +.PP +See also list(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "int QFtp::login ( const QString & user = QString::null, const QString & password = QString::null )" +Logs in to the FTP server with the username \fIuser\fR and the password \fIpassword\fR. +.PP +The stateChanged() signal is emitted when the state of the connecting process changes, e.g. to LoggedIn. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also commandStarted() and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "int QFtp::mkdir ( const QString & dir )" +Creates a directory called \fIdir\fR on the server. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also commandStarted() and commandFinished(). +.SH "int QFtp::put ( QIODevice * dev, const QString & file )" +Reads the data from the IO device \fIdev\fR, and writes it to the file called \fIfile\fR on the server. The data is read in chunks from the IO device, so this overload allows you to transmit large amounts of data without the need to read all the data into memory at once. +.PP +Make sure that the \fIdev\fR pointer is valid for the duration of the operation (it is safe to delete it when the commandFinished() is emitted). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "int QFtp::put ( const QByteArray & data, const QString & file )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes the data \fIdata\fR to the file called \fIfile\fR on the server. The progress of the upload is reported by the dataTransferProgress() signal. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also dataTransferProgress(), commandStarted(), and commandFinished(). +.SH "int QFtp::rawCommand ( const QString & command )" +Sends the raw FTP command \fIcommand\fR to the FTP server. This is useful for low-level FTP access. If the operation you wish to perform has an equivalent QFtp function, we recommend using the function instead of raw FTP commands since the functions are easier and safer. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also rawCommandReply(), commandStarted(), and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QFtp::rawCommandReply ( int replyCode, const QString & detail )\fC [signal]\fR" +This signal is emitted in response to the rawCommand() function. \fIreplyCode\fR is the 3 digit reply code and \fIdetail\fR is the text that follows the reply code. +.PP +See also rawCommand(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "QByteArray QFtp::readAll ()" +Reads all the bytes available from the data socket and returns them. +.PP +See also get(), readyRead(), bytesAvailable(), and readBlock(). +.SH "TQ_LONG QFtp::readBlock ( char * data, TQ_ULONG maxlen )" +Reads \fImaxlen\fR bytes from the data socket into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. +.PP +See also get(), readyRead(), bytesAvailable(), and readAll(). +.SH "void QFtp::readyRead ()\fC [signal]\fR" +This signal is emitted in response to a get() command when there is new data to read. +.PP +If you specify a device as the second argument in the get() command, this signal is \fInot\fR emitted; instead the data is written directly to the device. +.PP +You can read the data with the readAll() or readBlock() functions. +.PP +This signal is useful if you want to process the data in chunks as soon as it becomes available. If you are only interested in the complete data, just connect to the commandFinished() signal and read the data then instead. +.PP +See also get(), readBlock(), readAll(), and bytesAvailable(). +.SH "int QFtp::remove ( const QString & file )" +Deletes the file called \fIfile\fR from the server. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also commandStarted() and commandFinished(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "int QFtp::rename ( const QString & oldname, const QString & newname )" +Renames the file called \fIoldname\fR to \fInewname\fR on the server. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also commandStarted() and commandFinished(). +.SH "int QFtp::rmdir ( const QString & dir )" +Removes the directory called \fIdir\fR from the server. +.PP +The function does not block and returns immediately. The command is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by commandStarted() and commandFinished(). +.PP +When the command is started the commandStarted() signal is emitted. When it is finished the commandFinished() signal is emitted. +.PP +See also commandStarted() and commandFinished(). +.SH "State QFtp::state () const" +Returns the current state of the object. When the state changes, the stateChanged() signal is emitted. +.PP +See also State and stateChanged(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QFtp::stateChanged ( int state )\fC [signal]\fR" +This signal is emitted when the state of the connection changes. The argument \fIstate\fR is the new state of the connection; it is one of the State values. +.PP +It is usually emitted in response to a connectToHost() or close() command, but it can also be emitted "spontaneously", e.g. when the server closes the connection unexpectedly. +.PP +See also connectToHost(), close(), state(), and State. +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqftp.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqftp.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgb18030codec.3qt b/doc/man/man3/tqgb18030codec.3qt new file mode 100644 index 000000000..6c89d170b --- /dev/null +++ b/doc/man/man3/tqgb18030codec.3qt @@ -0,0 +1,80 @@ +'\" t +.TH QGb18030Codec 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 +QGb18030Codec \- Conversion to and from the Chinese GB18030/GBK/GB2312 encoding +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqgb18030codec.h>\fR +.PP +Inherits QTextCodec. +.PP +Inherited by QGbkCodec and QGb2312Codec. +.PP +.SH DESCRIPTION +The QGb18030Codec class provides conversion to and from the Chinese GB18030/GBK/GB2312 encoding. +.PP +GBK, formally the Chinese Internal Code Specification, is a commonly used extension of GB 2312-80. Microsoft Windows uses it under the name codepage 936. +.PP +GBK has been superceded by the new Chinese national standard GB 18030-2000, which added a 4-byte encoding while remaining compatible with GB2312 and GBK. The new GB 18030-2000 may be described as a special encoding of Unicode 3.x and ISO-10646-1. +.PP +Special thanks to charset gurus Markus Scherer (IBM), Dirk Meyer (Adobe Systems) and Ken Lunde (Adobe Systems) for publishing an excellent GB 18030-2000 summary and specification on the Internet. Some must-read documents are: +.TP +ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/pdf/GB18030_Summary.pdf +.TP +http://oss.software.ibm.com/cvs/icu/~checkout~/charset/source/gb18030/gb18030.html +.TP +http://oss.software.ibm.com/cvs/icu/~checkout~/charset/data/xml/gb-18030-2000.xml +.PP +The GBK codec was contributed to Qt by Justin Yu <justiny@turbolinux.com.cn> and Sean Chen <seanc@turbolinux.com.cn>. They may also be reached at Yu Mingjian <yumj@sun.ihep.ac.cn>, <yumingjian@china.com> Chen Xiangyang <chenxy@sun.ihep.ac.cn> +.PP +The GB18030 codec Qt functions were contributed to Qt by James Su <suzhe@gnuchina.org>, <suzhe@turbolinux.com.cn> who pioneered much of GB18030 development on GNU/Linux systems. +.PP +The GB18030 codec was contributed to Qt by Anthony Fok <anthony@thizlinux.com>, <foka@debian.org> using a Perl script to generate C++ tables from gb-18030-2000.xml while merging contributions from James Su, Justin Yu and Sean Chen. A copy of the source Perl script is available at: +.PP +http://people.debian.org/~foka/gb18030/gen-qgb18030codec.pl +.PP +The copyright notice for their code follows: +.PP +Copyright (C) 2000 TurboLinux, Inc. Written by Justin Yu and Sean Chen. Copyright (C) 2001, 2002 Turbolinux, Inc. Written by James Su. Copyright (C) 2001, 2002 ThizLinux Laboratory Ltd. Written by Anthony Fok. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> +.TP +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.TP +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.PP +See also Internationalization with Qt. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqgb18030codec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgb18030codec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgb2312codec.3qt b/doc/man/man3/tqgb2312codec.3qt new file mode 100644 index 000000000..4a96113c8 --- /dev/null +++ b/doc/man/man3/tqgb2312codec.3qt @@ -0,0 +1,48 @@ +'\" t +.TH QGb2312Codec 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 +QGb2312Codec \- Conversion to and from the Chinese GB2312 encoding +.SH SYNOPSIS +\fC#include <ntqgb18030codec.h>\fR +.PP +Inherits QGb18030Codec. +.PP +.SH DESCRIPTION +The QGb2312Codec class provides conversion to and from the Chinese GB2312 encoding. +.PP +The GB2312 encoding has been superceded by the GB18030 encoding and GB18030 is backward compatible to GB2312. For this reason the QGb2312Codec class is implemented in terms of the GB18030 codec and uses its 0xA1A1-0xFEFE subset for conversion from and to Unicode. +.PP +The QGb2312Codec is kept mainly for compatibility reasons with older software. +.PP +See also Internationalization with Qt. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qgb2312codec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgb2312codec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgbkcodec.3qt b/doc/man/man3/tqgbkcodec.3qt new file mode 100644 index 000000000..f33a57cea --- /dev/null +++ b/doc/man/man3/tqgbkcodec.3qt @@ -0,0 +1,52 @@ +'\" t +.TH QGbkCodec 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 +QGbkCodec \- Conversion to and from the Chinese GBK encoding +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqgb18030codec.h>\fR +.PP +Inherits QGb18030Codec. +.PP +.SH DESCRIPTION +The QGbkCodec class provides conversion to and from the Chinese GBK encoding. +.PP +GBK, formally the Chinese Internal Code Specification, is a commonly used extension of GB 2312-80. Microsoft Windows uses it under the name code page 936. +.PP +The GBK encoding has been superceded by the GB18030 encoding and GB18030 is backward compatible to GBK. For this reason the QGbkCodec class is implemented in terms of the GB18030 codec and uses its 1-byte and 2-byte portion for conversion from and to Unicode. +.PP +The QGbkCodec is kept mainly for compatibility reasons with older software. +.PP +See also Internationalization with Qt. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqgbkcodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgbkcodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgfxdriverfactory.3qt b/doc/man/man3/tqgfxdriverfactory.3qt new file mode 100644 index 000000000..0f9cb6c8e --- /dev/null +++ b/doc/man/man3/tqgfxdriverfactory.3qt @@ -0,0 +1,59 @@ +'\" t +.TH QGfxDriverFactory 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 +QGfxDriverFactory \- Creates QScreen objects for Qt/Embedded +.SH SYNOPSIS +\fC#include <qgfxdriverfactory_qws.h>\fR +.PP +.SS "Static Public Members" +<li class=fn>QStringList \fBkeys\fR () <li class=fn>QScreen * \fBcreate\fR ( const QString & key, int displayId ) +.SH DESCRIPTION +The QGfxDriverFactory class creates QScreen objects for Qt/Embedded. +.PP +The graphics driver factory creates a QScreen object for a given key with QGfxDriverFactory::create(key). +.PP +The drivers are either built-in or dynamically loaded from a driver plugin (see QGfxDriverPlugin). +.PP +QGfxDriverFactory::keys() returns a list of valid keys. Qt currently ships with "LinuxFb". +.PP +This class is only available in Qt/Embedded. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QScreen * QGfxDriverFactory::create ( const QString & key, int displayId )\fC [static]\fR" +Creates a QScreen object of a type that matches \fIkey\fR, and with the ID, \fIdisplayId\fR. The QScreen object returned may be from a built-in driver, or from a driver plugin. +.PP +See also keys(). +.SH "QStringList QGfxDriverFactory::keys ()\fC [static]\fR" +Returns the list of keys this factory can create drivers for. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qgfxdriverfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgfxdriverfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgfxdriverplugin.3qt b/doc/man/man3/tqgfxdriverplugin.3qt new file mode 100644 index 000000000..6ffad6658 --- /dev/null +++ b/doc/man/man3/tqgfxdriverplugin.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QGfxDriverPlugin 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 +QGfxDriverPlugin \- Abstract base for Qt/Embedded graphics driver plugins +.SH SYNOPSIS +\fC#include <qgfxdriverplugin_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGfxDriverPlugin\fR ()" +.br +.ti -1c +.BI "\fB~QGfxDriverPlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBkeys\fR () const = 0" +.br +.ti -1c +.BI "virtual QScreen * \fBcreate\fR ( const QString & driver, int displayId ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QGfxDriverPlugin class provides an abstract base for Qt/Embedded graphics driver plugins. +.PP +The graphics driver plugin is a simple plugin interface that makes it easy to create custom graphics drivers. +.PP +Writing a graphics driver plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Plugins documentation for details. +.PP +This class is only available in Qt/Embedded. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGfxDriverPlugin::QGfxDriverPlugin ()" +Constructs a graphics driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. +.SH "QGfxDriverPlugin::~QGfxDriverPlugin ()" +Destroys the graphics driver plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "QScreen * QGfxDriverPlugin::create ( const QString & driver, int displayId )\fC [pure virtual]\fR" +Creates a driver matching the type specified by \fIdriver\fR, that will use display \fIdisplayId\fR. +.PP +See also keys(). +.SH "QStringList QGfxDriverPlugin::keys () const\fC [pure virtual]\fR" +Returns the list of graphics drivers this plugin supports. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qgfxdriverplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgfxdriverplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgl.3qt b/doc/man/man3/tqgl.3qt new file mode 100644 index 000000000..a337c2ed4 --- /dev/null +++ b/doc/man/man3/tqgl.3qt @@ -0,0 +1,95 @@ +'\" t +.TH QGL 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 +QGL \- Namespace for miscellaneous identifiers in the Qt OpenGL module +.SH SYNOPSIS +\fC#include <ntqgl.h>\fR +.PP +Inherited by QGLFormat, QGLContext, and QGLWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBFormatOption\fR { DoubleBuffer = 0x0001, DepthBuffer = 0x0002, Rgba = 0x0004, AlphaChannel = 0x0008, AccumBuffer = 0x0010, StencilBuffer = 0x0020, StereoBuffers = 0x0040, DirectRendering = 0x0080, HasOverlay = 0x0100, SingleBuffer = DoubleBuffer<<16, NoDepthBuffer = DepthBuffer<<16, ColorIndex = Rgba<<16, NoAlphaChannel = AlphaChannel<<16, NoAccumBuffer = AccumBuffer<<16, NoStencilBuffer = StencilBuffer<<16, NoStereoBuffers = StereoBuffers<<16, IndirectRendering = DirectRendering<<16, NoOverlay = HasOverlay<<16 }" +.br +.in -1c +.SH DESCRIPTION +The QGL class is a namespace for miscellaneous identifiers in the Qt OpenGL module. +.PP +Normally you can ignore this class. QGLWidget and the other OpenGL<sup>*</sup> module classes inherit it, so when you make your own QGLWidget subclass you can use the identifiers in the QGL namespace without qualification. +.PP +However, you may occasionally find yourself in situations where you need to refer to these identifiers from outside the QGL namespace's scope, e.g. in static functions. In such cases, simply write e.g. QGL::DoubleBuffer instead of just DoubleBuffer. +.PP +<sup>*</sup> OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. +.PP +See also Graphics Classes and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QGL::FormatOption" +This enum specifies the format options. +.TP +\fCQGL::DoubleBuffer\fR +.TP +\fCQGL::DepthBuffer\fR +.TP +\fCQGL::Rgba\fR +.TP +\fCQGL::AlphaChannel\fR +.TP +\fCQGL::AccumBuffer\fR +.TP +\fCQGL::StencilBuffer\fR +.TP +\fCQGL::StereoBuffers\fR +.TP +\fCQGL::DirectRendering\fR +.TP +\fCQGL::HasOverlay\fR +.TP +\fCQGL::SingleBuffer\fR +.TP +\fCQGL::NoDepthBuffer\fR +.TP +\fCQGL::ColorIndex\fR +.TP +\fCQGL::NoAlphaChannel\fR +.TP +\fCQGL::NoAccumBuffer\fR +.TP +\fCQGL::NoStencilBuffer\fR +.TP +\fCQGL::NoStereoBuffers\fR +.TP +\fCQGL::IndirectRendering\fR +.TP +\fCQGL::NoOverlay\fR + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqgl.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgl.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqglayoutiterator.3qt b/doc/man/man3/tqglayoutiterator.3qt new file mode 100644 index 000000000..8d15612ca --- /dev/null +++ b/doc/man/man3/tqglayoutiterator.3qt @@ -0,0 +1,81 @@ +'\" t +.TH QGLayoutIterator 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 +QGLayoutIterator \- Abstract base class of internal layout iterators +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QGLayoutIterator\fR ()" +.br +.ti -1c +.BI "virtual QLayoutItem * \fBnext\fR () = 0" +.br +.ti -1c +.BI "virtual QLayoutItem * \fBcurrent\fR () = 0" +.br +.ti -1c +.BI "virtual QLayoutItem * \fBtakeCurrent\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QGLayoutIterator class is an abstract base class of internal layout iterators. +.PP +(This class is \fInot\fR OpenGL related, it just happens to start with the letters QGL...) +.PP +Subclass this class to create a custom layout. The functions that must be implemented are next(), current(), and takeCurrent(). +.PP +The QGLayoutIterator implements the functionality of QLayoutIterator. Each subclass of QLayout needs a QGLayoutIterator subclass. +.PP +See also Widget Appearance and Style and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGLayoutIterator::~QGLayoutIterator ()\fC [virtual]\fR" +Destroys the iterator +.SH "QLayoutItem * QGLayoutIterator::current ()\fC [pure virtual]\fR" +Implemented in subclasses to return the current item, or 0 if there is no current item. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.SH "QLayoutItem * QGLayoutIterator::next ()\fC [pure virtual]\fR" +Implemented in subclasses to move the iterator to the next item and return that item, or 0 if there is no next item. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.SH "QLayoutItem * QGLayoutIterator::takeCurrent ()\fC [pure virtual]\fR" +Implemented in subclasses. The function must remove the current item from the layout without deleting it, move the iterator to the next item and return the removed item, or 0 if no item was removed. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qglayoutiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqglayoutiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqglcolormap.3qt b/doc/man/man3/tqglcolormap.3qt new file mode 100644 index 000000000..75d12727b --- /dev/null +++ b/doc/man/man3/tqglcolormap.3qt @@ -0,0 +1,166 @@ +'\" t +.TH QGLColormap 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 +QGLColormap \- Used for installing custom colormaps into QGLWidgets +.SH SYNOPSIS +\fC#include <ntqglcolormap.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGLColormap\fR ()" +.br +.ti -1c +.BI "\fBQGLColormap\fR ( const QGLColormap & map )" +.br +.ti -1c +.BI "\fB~QGLColormap\fR ()" +.br +.ti -1c +.BI "QGLColormap & \fBoperator=\fR ( const QGLColormap & map )" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "int \fBsize\fR () const" +.br +.ti -1c +.BI "void \fBdetach\fR ()" +.br +.ti -1c +.BI "void \fBsetEntries\fR ( int count, const QRgb * colors, int base = 0 )" +.br +.ti -1c +.BI "void \fBsetEntry\fR ( int idx, QRgb color )" +.br +.ti -1c +.BI "void \fBsetEntry\fR ( int idx, const QColor & color )" +.br +.ti -1c +.BI "QRgb \fBentryRgb\fR ( int idx ) const" +.br +.ti -1c +.BI "QColor \fBentryColor\fR ( int idx ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( QRgb color ) const" +.br +.ti -1c +.BI "int \fBfindNearest\fR ( QRgb color ) const" +.br +.in -1c +.SH DESCRIPTION +The QGLColormap class is used for installing custom colormaps into QGLWidgets. +.PP +QGLColormap provides a platform independent way of specifying and installing indexed colormaps into QGLWidgets. QGLColormap is especially useful when using the OpenGL color-index mode. +.PP +Under X11 you must use an X server that supports either a \fCPseudoColor\fR or \fCDirectColor\fR visual class. If your X server currently only provides a \fCGrayScale\fR, \fCTrueColor\fR, \fCStaticColor\fR or \fCStaticGray\fR visual, you will not be able to allocate colorcells for writing. If this is the case, try setting your X server to 8 bit mode. It should then provide you with at least a \fCPseudoColor\fR visual. Note that you may experience colormap flashing if your X server is running in 8 bit mode. +.PP +Under Windows the size of the colormap is always set to 256 colors. Note that under Windows you can also install colormaps in child widgets. +.PP +This class uses explicit sharing (see Shared Classes). +.PP +Example of use: +.PP +.nf +.br + #include <ntqapplication.h> +.br + #include <ntqglcolormap.h> +.br +.br + int main() +.br + { +.br + QApplication a( argc, argv ); +.br +.br + MySuperGLWidget widget( 0 ); // A QGLWidget in color-index mode +.br + QGLColormap colormap; +.br +.br + // This will fill the colormap with colors ranging from +.br + // black to white. +.br + for ( int i = 0; i < colormap.size(); i++ ) +.br + colormap.setEntry( i, tqRgb( i, i, i ) ); +.br +.br + widget.setColormap( colormap ); +.br + widget.show(); +.br + return a.exec(); +.br + } +.br +.fi +.PP +See also QGLWidget::setColormap(), QGLWidget::colormap(), Graphics Classes, and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGLColormap::QGLColormap ()" +Construct a QGLColormap. +.SH "QGLColormap::QGLColormap ( const QGLColormap & map )" +Construct a shallow copy of \fImap\fR. +.SH "QGLColormap::~QGLColormap ()" +Dereferences the QGLColormap and deletes it if this was the last reference to it. +.SH "void QGLColormap::detach ()" +Detaches this QGLColormap from the shared block. +.SH "QColor QGLColormap::entryColor ( int idx ) const" +Returns the QRgb value in the colorcell with index \fIidx\fR. +.SH "QRgb QGLColormap::entryRgb ( int idx ) const" +Returns the QRgb value in the colorcell with index \fIidx\fR. +.SH "int QGLColormap::find ( QRgb color ) const" +Returns the index of the color \fIcolor\fR. If \fIcolor\fR is not in the map, -1 is returned. +.SH "int QGLColormap::findNearest ( QRgb color ) const" +Returns the index of the color that is the closest match to color \fIcolor\fR. +.SH "bool QGLColormap::isEmpty () const" +Returns TRUE if the colormap is empty; otherwise returns FALSE. A colormap with no color values set is considered to be empty. +.SH "QGLColormap & QGLColormap::operator= ( const QGLColormap & map )" +Assign a shallow copy of \fImap\fR to this QGLColormap. +.SH "void QGLColormap::setEntries ( int count, const QRgb * colors, int base = 0 )" +Set an array of cells in this colormap. \fIcount\fR is the number of colors that should be set, \fIcolors\fR is the array of colors, and \fIbase\fR is the starting index. +.SH "void QGLColormap::setEntry ( int idx, QRgb color )" +Set cell at index \fIidx\fR in the colormap to color \fIcolor\fR. +.SH "void QGLColormap::setEntry ( int idx, const QColor & color )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Set the cell with index \fIidx\fR in the colormap to color \fIcolor\fR. +.SH "int QGLColormap::size () const" +Returns the number of colorcells in the colormap. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqglcolormap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqglcolormap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqglcontext.3qt b/doc/man/man3/tqglcontext.3qt new file mode 100644 index 000000000..2fcebe68d --- /dev/null +++ b/doc/man/man3/tqglcontext.3qt @@ -0,0 +1,273 @@ +'\" t +.TH QGLContext 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 +QGLContext \- Encapsulates an OpenGL rendering context +.SH SYNOPSIS +\fC#include <ntqgl.h>\fR +.PP +Inherits QGL. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGLContext\fR ( const QGLFormat & format, QPaintDevice * device )" +.br +.ti -1c +.BI "virtual \fB~QGLContext\fR ()" +.br +.ti -1c +.BI "virtual bool \fBcreate\fR ( const QGLContext * shareContext = 0 )" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "bool \fBisSharing\fR () const" +.br +.ti -1c +.BI "virtual void \fBreset\fR ()" +.br +.ti -1c +.BI "QGLFormat \fBformat\fR () const" +.br +.ti -1c +.BI "QGLFormat \fBrequestedFormat\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFormat\fR ( const QGLFormat & format )" +.br +.ti -1c +.BI "virtual void \fBmakeCurrent\fR ()" +.br +.ti -1c +.BI "virtual void \fBswapBuffers\fR () const" +.br +.ti -1c +.BI "QPaintDevice * \fBdevice\fR () const" +.br +.ti -1c +.BI "QColor \fBoverlayTransparentColor\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "const QGLContext * \fBcurrentContext\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBchooseContext\fR ( const QGLContext * shareContext = 0 )" +.br +.ti -1c +.BI "virtual void \fBdoneCurrent\fR ()" +.br +.ti -1c +.BI "virtual int \fBchoosePixelFormat\fR ( void * dummyPfd, HDC pdc )" +.br +.ti -1c +.BI "virtual void * \fBchooseVisual\fR ()" +.br +.ti -1c +.BI "virtual void * \fBchooseMacVisual\fR ( GDHandle device )" +.br +.ti -1c +.BI "bool \fBdeviceIsPixmap\fR () const" +.br +.ti -1c +.BI "bool \fBwindowCreated\fR () const" +.br +.ti -1c +.BI "void \fBsetWindowCreated\fR ( bool on )" +.br +.ti -1c +.BI "bool \fBinitialized\fR () const" +.br +.ti -1c +.BI "void \fBsetInitialized\fR ( bool on )" +.br +.ti -1c +.BI "void \fBgenerateFontDisplayLists\fR ( const QFont & font, int listBase )" +.br +.in -1c +.SH DESCRIPTION +The QGLContext class encapsulates an OpenGL rendering context. +.PP +An OpenGL<sup>*</sup> rendering context is a complete set of OpenGL state variables. +.PP +The context's format is set in the constructor or later with setFormat(). The format options that are actually set are returned by format(); the options you asked for are returned by requestedFormat(). Note that after a QGLContext object has been constructed, the actual OpenGL context must be created by explicitly calling the create() function. The makeCurrent() function makes this context the current rendering context. You can make \fIno\fR context current using doneCurrent(). The reset() function will reset the context and make it invalid. +.PP +You can examine properties of the context with, e.g. isValid(), isSharing(), initialized(), windowCreated() and overlayTransparentColor(). +.PP +If you're using double buffering you can swap the screen contents with the off-screen buffer using swapBuffers(). +.PP +Please note that QGLContext is not thread safe. +.PP +<sup>*</sup> OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGLContext::QGLContext ( const QGLFormat & format, QPaintDevice * device )" +Constructs an OpenGL context for the paint device \fIdevice\fR, which can be a widget or a pixmap. The \fIformat\fR specifies several display options for the context. +.PP +If the underlying OpenGL/Window system cannot satisfy all the features requested in \fIformat\fR, the nearest subset of features will be used. After creation, the format() method will return the actual format obtained. +.PP +Note that after a QGLContext object has been constructed, create() must be called explicitly to create the actual OpenGL context. The context will be invalid if it was not possible to obtain a GL context at all. +.PP +See also format() and isValid(). +.SH "QGLContext::~QGLContext ()\fC [virtual]\fR" +Destroys the OpenGL context and frees its resources. +.SH "bool QGLContext::chooseContext ( const QGLContext * shareContext = 0 )\fC [virtual protected]\fR" +This semi-internal function is called by create(). It creates a system-dependent OpenGL handle that matches the format() of \fIshareContext\fR as closely as possible. +.PP +On Windows, it calls the virtual function choosePixelFormat(), which finds a matching pixel format identifier. On X11, it calls the virtual function chooseVisual() which finds an appropriate X visual. On other platforms it may work differently. +.SH "void * QGLContext::chooseMacVisual ( GDHandle device )\fC [virtual protected]\fR" +\fBMac only\fR: This virtual function tries to find a visual that matches the format using the given \fIdevice\fR handle, reducing the demands if the original request cannot be met. +.PP +The algorithm for reducing the demands of the format is quite simple-minded, so override this method in your subclass if your application has specific requirements on visual selection. +.PP +See also chooseContext(). +.SH "int QGLContext::choosePixelFormat ( void * dummyPfd, HDC pdc )\fC [virtual protected]\fR" +\fBWin32 only\fR This virtual function chooses a pixel format that matches the OpenGL format. Reimplement this function in a subclass if you need a custom context. +.PP +\fBWarning:\fR The \fIdummyPfd\fR pointer and \fIpdc\fR are used as a \fCPIXELFORMATDESCRIPTOR*\fR. We use \fCvoid\fR to avoid using Windows-specific types in our header files. +.PP +See also chooseContext(). +.SH "void * QGLContext::chooseVisual ()\fC [virtual protected]\fR" +\fBX11 only\fR: This virtual function tries to find a visual that matches the format, reducing the demands if the original request cannot be met. +.PP +The algorithm for reducing the demands of the format is quite simple-minded, so override this method in your subclass if your application has spcific requirements on visual selection. +.PP +See also chooseContext(). +.SH "bool QGLContext::create ( const QGLContext * shareContext = 0 )\fC [virtual]\fR" +Creates the GL context. Returns TRUE if it was successful in creating a valid GL rendering context on the paint device specified in the constructor; otherwise returns FALSE (i.e. the context is invalid). +.PP +After successful creation, format() returns the set of features of the created GL rendering context. +.PP +If \fIshareContext\fR points to a valid QGLContext, this method will try to establish OpenGL display list sharing between this context and the \fIshareContext\fR. Note that this may fail if the two contexts have different formats. Use isSharing() to see if sharing succeeded. +.PP +\fBWarning:\fR Implementation note: initialization of C++ class members usually takes place in the class constructor. QGLContext is an exception because it must be simple to customize. The virtual functions chooseContext() (and chooseVisual() for X11) can be reimplemented in a subclass to select a particular context. The problem is that virtual functions are not properly called during construction (even though this is correct C++) because C++ constructs class hierarchies from the bottom up. For this reason we need a create() function. +.PP +See also chooseContext(), format(), and isValid(). +.SH "const QGLContext * QGLContext::currentContext ()\fC [static]\fR" +Returns the current context, i.e. the context to which any OpenGL commands will currently be directed. Returns 0 if no context is current. +.PP +See also makeCurrent(). +.SH "QPaintDevice * QGLContext::device () const" +Returns the paint device set for this context. +.PP +See also QGLContext::QGLContext(). +.SH "bool QGLContext::deviceIsPixmap () const\fC [protected]\fR" +Returns TRUE if the paint device of this context is a pixmap; otherwise returns FALSE. +.SH "void QGLContext::doneCurrent ()\fC [virtual protected]\fR" +Makes no GL context the current context. Normally, you do not need to call this function; QGLContext calls it as necessary. +.SH "QGLFormat QGLContext::format () const" +Returns the frame buffer format that was obtained (this may be a subset of what was requested). +.PP +See also requestedFormat(). +.SH "void QGLContext::generateFontDisplayLists ( const QFont & font, int listBase )\fC [protected]\fR" +Generates a set of 256 display lists for the 256 first characters in the font \fIfont\fR. The first list will start at index \fIlistBase\fR. +.PP +See also QGLWidget::renderText(). +.SH "bool QGLContext::initialized () const\fC [protected]\fR" +Returns TRUE if this context has been initialized, i.e. if QGLWidget::initializeGL() has been performed on it; otherwise returns FALSE. +.PP +See also setInitialized(). +.SH "bool QGLContext::isSharing () const" +Returns TRUE if display list sharing with another context was requested in the create() call and the GL system was able to fulfill this request; otherwise returns FALSE. Note that display list sharing might not be supported between contexts with different formats. +.SH "bool QGLContext::isValid () const" +Returns TRUE if a GL rendering context has been successfully created; otherwise returns FALSE. +.SH "void QGLContext::makeCurrent ()\fC [virtual]\fR" +Makes this context the current OpenGL rendering context. All GL functions you call operate on this context until another context is made current. +.PP +In some very rare cases the underlying call may fail. If this occurs an error message is output to stderr. +.SH "QColor QGLContext::overlayTransparentColor () const" +If this context is a valid context in an overlay plane, returns the plane's transparent color. Otherwise returns an invalid color. +.PP +The returned color's pixel value is the index of the transparent color in the colormap of the overlay plane. (Naturally, the color's RGB values are meaningless.) +.PP +The returned QColor object will generally work as expected only when passed as the argument to QGLWidget::qglColor() or QGLWidget::qglClearColor(). Under certain circumstances it can also be used to draw transparent graphics with a QPainter. See the examples/opengl/overlay_x11 example for details. +.SH "QGLFormat QGLContext::requestedFormat () const" +Returns the frame buffer format that was originally requested in the constructor or setFormat(). +.PP +See also format(). +.SH "void QGLContext::reset ()\fC [virtual]\fR" +Resets the context and makes it invalid. +.PP +See also create() and isValid(). +.SH "void QGLContext::setFormat ( const QGLFormat & format )\fC [virtual]\fR" +Sets a \fIformat\fR for this context. The context is reset. +.PP +Call create() to create a new GL context that tries to match the new format. +.PP +.nf +.br + QGLContext *cx; +.br + // ... +.br + QGLFormat f; +.br + f.setStereo( TRUE ); +.br + cx->setFormat( f ); +.br + if ( !cx->create() ) +.br + exit(); // no OpenGL support, or cannot render on the specified paintdevice +.br + if ( !cx->format().stereo() ) +.br + exit(); // could not create stereo context +.br +.fi +.PP +See also format(), reset(), and create(). +.SH "void QGLContext::setInitialized ( bool on )\fC [protected]\fR" +If \fIon\fR is TRUE the context has been initialized, i.e. QGLContext::setInitialized() has been called on it. If \fIon\fR is FALSE the context has not been initialized. +.PP +See also initialized(). +.SH "void QGLContext::setWindowCreated ( bool on )\fC [protected]\fR" +If \fIon\fR is TRUE the context has had a window created for it. If \fIon\fR is FALSE no window has been created for the context. +.PP +See also windowCreated(). +.SH "void QGLContext::swapBuffers () const\fC [virtual]\fR" +Swaps the screen contents with an off-screen buffer. Only works if the context is in double buffer mode. +.PP +See also QGLFormat::setDoubleBuffer(). +.SH "bool QGLContext::windowCreated () const\fC [protected]\fR" +Returns TRUE if a window has been created for this context; otherwise returns FALSE. +.PP +See also setWindowCreated(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qglcontext.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqglcontext.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqglformat.3qt b/doc/man/man3/tqglformat.3qt new file mode 100644 index 000000000..09d64e24a --- /dev/null +++ b/doc/man/man3/tqglformat.3qt @@ -0,0 +1,511 @@ +'\" t +.TH QGLFormat 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 +QGLFormat \- The display format of an OpenGL rendering context +.SH SYNOPSIS +\fC#include <ntqgl.h>\fR +.PP +Inherits QGL. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGLFormat\fR ()" +.br +.ti -1c +.BI "\fBQGLFormat\fR ( int options, int plane = 0 )" +.br +.ti -1c +.BI "bool \fBdoubleBuffer\fR () const" +.br +.ti -1c +.BI "void \fBsetDoubleBuffer\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBdepth\fR () const" +.br +.ti -1c +.BI "void \fBsetDepth\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBrgba\fR () const" +.br +.ti -1c +.BI "void \fBsetRgba\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBalpha\fR () const" +.br +.ti -1c +.BI "void \fBsetAlpha\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBaccum\fR () const" +.br +.ti -1c +.BI "void \fBsetAccum\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBstencil\fR () const" +.br +.ti -1c +.BI "void \fBsetStencil\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBstereo\fR () const" +.br +.ti -1c +.BI "void \fBsetStereo\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBdirectRendering\fR () const" +.br +.ti -1c +.BI "void \fBsetDirectRendering\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBhasOverlay\fR () const" +.br +.ti -1c +.BI "void \fBsetOverlay\fR ( bool enable )" +.br +.ti -1c +.BI "int \fBplane\fR () const" +.br +.ti -1c +.BI "void \fBsetPlane\fR ( int plane )" +.br +.ti -1c +.BI "void \fBsetOption\fR ( FormatOption opt )" +.br +.ti -1c +.BI "bool \fBtestOption\fR ( FormatOption opt ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QGLFormat \fBdefaultFormat\fR ()" +.br +.ti -1c +.BI "void \fBsetDefaultFormat\fR ( const QGLFormat & f )" +.br +.ti -1c +.BI "QGLFormat \fBdefaultOverlayFormat\fR ()" +.br +.ti -1c +.BI "void \fBsetDefaultOverlayFormat\fR ( const QGLFormat & f )" +.br +.ti -1c +.BI "bool \fBhasOpenGL\fR ()" +.br +.ti -1c +.BI "bool \fBhasOpenGLOverlays\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QGLFormat class specifies the display format of an OpenGL rendering context. +.PP +A display format has several characteristics: +.TP +Double or single buffering. +.TP +Depth buffer. +.TP +RGBA or color index mode. +.TP +Alpha channel. +.TP +Accumulation buffer. +.TP +Stencil buffer. +.TP +Stereo buffers. +.TP +Direct rendering. +.TP +Presence of an overlay. +.TP +The plane of an overlay format. +.PP +You create and tell a QGLFormat object what rendering options you want from an OpenGL<sup>*</sup> rendering context. +.PP +OpenGL drivers or accelerated hardware may or may not support advanced features such as alpha channel or stereographic viewing. If you request some features that the driver/hardware does not provide when you create a QGLWidget, you will get a rendering context with the nearest subset of features. +.PP +There are different ways to define the display characteristics of a rendering context. One is to create a QGLFormat and make it the default for the entire application: +.PP +.nf +.br + QGLFormat f; +.br + f.setAlpha( TRUE ); +.br + f.setStereo( TRUE ); +.br + QGLFormat::setDefaultFormat( f ); +.br +.fi +.PP +Or you can specify the desired format when creating an object of your QGLWidget subclass: +.PP +.nf +.br + QGLFormat f; +.br + f.setDoubleBuffer( FALSE ); // single buffer +.br + f.setDirectRendering( FALSE ); // software rendering +.br + MyGLWidget* myWidget = new MyGLWidget( f, ... ); +.br +.fi +.PP +After the widget has been created, you can find out which of the requested features the system was able to provide: +.PP +.nf +.br + QGLFormat f; +.br + f.setOverlay( TRUE ); +.br + f.setStereo( TRUE ); +.br + MyGLWidget* myWidget = new MyGLWidget( f, ... ); +.br + if ( !w->format().stereo() ) { +.br + // ok, goggles off +.br + if ( !w->format().hasOverlay() ) { +.br + tqFatal( "Cool hardware required" ); +.br + } +.br + } +.br +.fi +.PP +<sup>*</sup> OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. +.PP +See also QGLContext, QGLWidget, Graphics Classes, and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGLFormat::QGLFormat ()" +Constructs a QGLFormat object with the factory default settings: +.TP +Double buffer: Enabled. +.TP +Depth buffer: Enabled. +.TP +RGBA: Enabled (i.e., color index disabled). +.TP +Alpha channel: Disabled. +.TP +Accumulator buffer: Disabled. +.TP +Stencil buffer: Disabled. +.TP +Stereo: Disabled. +.TP +Direct rendering: Enabled. +.TP +Overlay: Disabled. +.TP +Plane: 0 (i.e., normal plane). +.SH "QGLFormat::QGLFormat ( int options, int plane = 0 )" +Creates a QGLFormat object that is a copy of the current application default format. +.PP +If \fIoptions\fR is not 0, this copy is modified by these format options. The \fIoptions\fR parameter should be FormatOption values OR'ed together. +.PP +This constructor makes it easy to specify a certain desired format in classes derived from QGLWidget, for example: +.PP +.nf +.br + // The rendering in MyGLWidget depends on using +.br + // stencil buffer and alpha channel +.br + MyGLWidget::MyGLWidget( QWidget* parent, const char* name ) +.br + : QGLWidget( QGLFormat( StencilBuffer | AlphaChannel ), parent, name ) +.br + { +.br + if ( !format().stencil() ) +.br + tqWarning( "Could not get stencil buffer; results will be suboptimal" ); +.br + if ( !format().alphaChannel() ) +.br + tqWarning( "Could not get alpha channel; results will be suboptimal" ); +.br + ... +.br + } +.br +.fi +.PP +Note that there are FormatOption values to turn format settings both on and off, e.g. DepthBuffer and NoDepthBuffer, DirectRendering and IndirectRendering, etc. +.PP +The \fIplane\fR parameter defaults to 0 and is the plane which this format should be associated with. Not all OpenGL implmentations supports overlay/underlay rendering planes. +.PP +See also defaultFormat() and setOption(). +.SH "bool QGLFormat::accum () const" +Returns TRUE if the accumulation buffer is enabled; otherwise returns FALSE. The accumulation buffer is disabled by default. +.PP +See also setAccum(). +.SH "bool QGLFormat::alpha () const" +Returns TRUE if the alpha channel of the framebuffer is enabled; otherwise returns FALSE. The alpha channel is disabled by default. +.PP +See also setAlpha(). +.SH "QGLFormat QGLFormat::defaultFormat ()\fC [static]\fR" +Returns the default QGLFormat for the application. All QGLWidgets that are created use this format unless another format is specified, e.g. when they are constructed. +.PP +If no special default format has been set using setDefaultFormat(), the default format is the same as that created with QGLFormat(). +.PP +See also setDefaultFormat(). +.SH "QGLFormat QGLFormat::defaultOverlayFormat ()\fC [static]\fR" +Returns the default QGLFormat for overlay contexts. +.PP +The factory default overlay format is: +.TP +Double buffer: Disabled. +.TP +Depth buffer: Disabled. +.TP +RGBA: Disabled (i.e., color index enabled). +.TP +Alpha channel: Disabled. +.TP +Accumulator buffer: Disabled. +.TP +Stencil buffer: Disabled. +.TP +Stereo: Disabled. +.TP +Direct rendering: Enabled. +.TP +Overlay: Disabled. +.TP +Plane: 1 (i.e., first overlay plane). +.PP +See also setDefaultFormat(). +.SH "bool QGLFormat::depth () const" +Returns TRUE if the depth buffer is enabled; otherwise returns FALSE. The depth buffer is enabled by default. +.PP +See also setDepth(). +.SH "bool QGLFormat::directRendering () const" +Returns TRUE if direct rendering is enabled; otherwise returns FALSE. +.PP +Direct rendering is enabled by default. +.PP +See also setDirectRendering(). +.SH "bool QGLFormat::doubleBuffer () const" +Returns TRUE if double buffering is enabled; otherwise returns FALSE. Double buffering is enabled by default. +.PP +See also setDoubleBuffer(). +.SH "bool QGLFormat::hasOpenGL ()\fC [static]\fR" +Returns TRUE if the window system has any OpenGL support; otherwise returns FALSE. +.PP +\fBWarning:\fR This function must not be called until the QApplication object has been created. +.SH "bool QGLFormat::hasOpenGLOverlays ()\fC [static]\fR" +Returns TRUE if the window system supports OpenGL overlays; otherwise returns FALSE. +.PP +\fBWarning:\fR This function must not be called until the QApplication object has been created. +.SH "bool QGLFormat::hasOverlay () const" +Returns TRUE if overlay plane is enabled; otherwise returns FALSE. +.PP +Overlay is disabled by default. +.PP +See also setOverlay(). +.SH "int QGLFormat::plane () const" +Returns the plane of this format. The default for normal formats is 0, which means the normal plane. The default for overlay formats is 1, which is the first overlay plane. +.PP +See also setPlane(). +.SH "bool QGLFormat::rgba () const" +Returns TRUE if RGBA color mode is set. Returns FALSE if color index mode is set. The default color mode is RGBA. +.PP +See also setRgba(). +.SH "void QGLFormat::setAccum ( bool enable )" +If \fIenable\fR is TRUE enables the accumulation buffer; otherwise disables the accumulation buffer. +.PP +The accumulation buffer is disabled by default. +.PP +The accumulation buffer is used to create blur effects and multiple exposures. +.PP +See also accum(). +.SH "void QGLFormat::setAlpha ( bool enable )" +If \fIenable\fR is TRUE enables the alpha channel; otherwise disables the alpha channel. +.PP +The alpha buffer is disabled by default. +.PP +The alpha channel is typically used for implementing transparency or translucency. The A in RGBA specifies the transparency of a pixel. +.PP +See also alpha(). +.SH "void QGLFormat::setDefaultFormat ( const QGLFormat & f )\fC [static]\fR" +Sets a new default QGLFormat for the application to \fIf\fR. For example, to set single buffering as the default instead of double buffering, your main() might contain code like this: +.PP +.nf +.br + QApplication a(argc, argv); +.br + QGLFormat f; +.br + f.setDoubleBuffer( FALSE ); +.br + QGLFormat::setDefaultFormat( f ); +.br +.fi +.PP +See also defaultFormat(). +.SH "void QGLFormat::setDefaultOverlayFormat ( const QGLFormat & f )\fC [static]\fR" +Sets a new default QGLFormat for overlay contexts to \fIf\fR. This format is used whenever a QGLWidget is created with a format that hasOverlay() enabled. +.PP +For example, to get a double buffered overlay context (if available), use code like this: +.PP +.nf +.br + QGLFormat f = QGLFormat::defaultOverlayFormat(); +.br + f.setDoubleBuffer( TRUE ); +.br + QGLFormat::setDefaultOverlayFormat( f ); +.br +.fi +.PP +As usual, you can find out after widget creation whether the underlying OpenGL system was able to provide the requested specification: +.PP +.nf +.br + // ...continued from above +.br + MyGLWidget* myWidget = new MyGLWidget( QGLFormat( QGL::HasOverlay ), ... ); +.br + if ( myWidget->format().hasOverlay() ) { +.br + // Yes, we got an overlay, let's check _its_ format: +.br + QGLContext* olContext = myWidget->overlayContext(); +.br + if ( olContext->format().doubleBuffer() ) +.br + ; // yes, we got a double buffered overlay +.br + else +.br + ; // no, only single buffered overlays are available +.br + } +.br +.fi +.PP +See also defaultOverlayFormat(). +.SH "void QGLFormat::setDepth ( bool enable )" +If \fIenable\fR is TRUE enables the depth buffer; otherwise disables the depth buffer. +.PP +The depth buffer is enabled by default. +.PP +The purpose of a depth buffer (or Z-buffering) is to remove hidden surfaces. Pixels are assigned Z values based on the distance to the viewer. A pixel with a high Z value is closer to the viewer than a pixel with a low Z value. This information is used to decide whether to draw a pixel or not. +.PP +See also depth(). +.SH "void QGLFormat::setDirectRendering ( bool enable )" +If \fIenable\fR is TRUE enables direct rendering; otherwise disables direct rendering. +.PP +Direct rendering is enabled by default. +.PP +Enabling this option will make OpenGL bypass the underlying window system and render directly from hardware to the screen, if this is supported by the system. +.PP +See also directRendering(). +.SH "void QGLFormat::setDoubleBuffer ( bool enable )" +If \fIenable\fR is TRUE sets double buffering; otherwise sets single buffering. +.PP +Double buffering is enabled by default. +.PP +Double buffering is a technique where graphics are rendered on an off-screen buffer and not directly to the screen. When the drawing has been completed, the program calls a swapBuffers() function to exchange the screen contents with the buffer. The result is flicker-free drawing and often better performance. +.PP +See also doubleBuffer(), QGLContext::swapBuffers(), and QGLWidget::swapBuffers(). +.SH "void QGLFormat::setOption ( FormatOption opt )" +Sets the format option to \fIopt\fR. +.PP +See also testOption(). +.SH "void QGLFormat::setOverlay ( bool enable )" +If \fIenable\fR is TRUE enables an overlay plane; otherwise disables the overlay plane. +.PP +Enabling the overlay plane will cause QGLWidget to create an additional context in an overlay plane. See the QGLWidget documentation for further information. +.PP +See also hasOverlay(). +.SH "void QGLFormat::setPlane ( int plane )" +Sets the requested plane to \fIplane\fR. 0 is the normal plane, 1 is the first overlay plane, 2 is the second overlay plane, etc.; -1, -2, etc. are underlay planes. +.PP +Note that in contrast to other format specifications, the plane specifications will be matched exactly. This means that if you specify a plane that the underlying OpenGL system cannot provide, an invalid QGLWidget will be created. +.PP +See also plane(). +.SH "void QGLFormat::setRgba ( bool enable )" +If \fIenable\fR is TRUE sets RGBA mode. If \fIenable\fR is FALSE sets color index mode. +.PP +The default color mode is RGBA. +.PP +RGBA is the preferred mode for most OpenGL applications. In RGBA color mode you specify colors as red + green + blue + alpha quadruplets. +.PP +In color index mode you specify an index into a color lookup table. +.PP +See also rgba(). +.SH "void QGLFormat::setStencil ( bool enable )" +If \fIenable\fR is TRUE enables the stencil buffer; otherwise disables the stencil buffer. +.PP +The stencil buffer is disabled by default. +.PP +The stencil buffer masks certain parts of the drawing area so that masked parts are not drawn on. +.PP +See also stencil(). +.SH "void QGLFormat::setStereo ( bool enable )" +If \fIenable\fR is TRUE enables stereo buffering; otherwise disables stereo buffering. +.PP +Stereo buffering is disabled by default. +.PP +Stereo buffering provides extra color buffers to generate left-eye and right-eye images. +.PP +See also stereo(). +.SH "bool QGLFormat::stencil () const" +Returns TRUE if the stencil buffer is enabled; otherwise returns FALSE. The stencil buffer is disabled by default. +.PP +See also setStencil(). +.SH "bool QGLFormat::stereo () const" +Returns TRUE if stereo buffering is enabled; otherwise returns FALSE. Stereo buffering is disabled by default. +.PP +See also setStereo(). +.SH "bool QGLFormat::testOption ( FormatOption opt ) const" +Returns TRUE if format option \fIopt\fR is set; otherwise returns FALSE. +.PP +See also setOption(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qglformat.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqglformat.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqglwidget.3qt b/doc/man/man3/tqglwidget.3qt new file mode 100644 index 000000000..5dff77432 --- /dev/null +++ b/doc/man/man3/tqglwidget.3qt @@ -0,0 +1,512 @@ +'\" t +.TH QGLWidget 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 +QGLWidget \- Widget for rendering OpenGL graphics +.SH SYNOPSIS +\fC#include <ntqgl.h>\fR +.PP +Inherits QWidget and QGL. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGLWidget\fR ( QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQGLWidget\fR ( QGLContext * context, QWidget * parent, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQGLWidget\fR ( const QGLFormat & format, QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QGLWidget\fR ()" +.br +.ti -1c +.BI "void \fBqglColor\fR ( const QColor & c ) const" +.br +.ti -1c +.BI "void \fBqglClearColor\fR ( const QColor & c ) const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "bool \fBisSharing\fR () const" +.br +.ti -1c +.BI "virtual void \fBmakeCurrent\fR ()" +.br +.ti -1c +.BI "void \fBdoneCurrent\fR ()" +.br +.ti -1c +.BI "bool \fBdoubleBuffer\fR () const" +.br +.ti -1c +.BI "virtual void \fBswapBuffers\fR ()" +.br +.ti -1c +.BI "QGLFormat \fBformat\fR () const" +.br +.ti -1c +.BI "const QGLContext * \fBcontext\fR () const" +.br +.ti -1c +.BI "virtual QPixmap \fBrenderPixmap\fR ( int w = 0, int h = 0, bool useContext = FALSE )" +.br +.ti -1c +.BI "virtual QImage \fBgrabFrameBuffer\fR ( bool withAlpha = FALSE )" +.br +.ti -1c +.BI "virtual void \fBmakeOverlayCurrent\fR ()" +.br +.ti -1c +.BI "const QGLContext * \fBoverlayContext\fR () const" +.br +.ti -1c +.BI "const QGLColormap & \fBcolormap\fR () const" +.br +.ti -1c +.BI "void \fBsetColormap\fR ( const QGLColormap & cmap )" +.br +.ti -1c +.BI "void \fBrenderText\fR ( int x, int y, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" +.br +.ti -1c +.BI "void \fBrenderText\fR ( double x, double y, double z, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBupdateGL\fR ()" +.br +.ti -1c +.BI "virtual void \fBupdateOverlayGL\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QImage \fBconvertToGLFormat\fR ( const QImage & img )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBinitializeGL\fR ()" +.br +.ti -1c +.BI "virtual void \fBresizeGL\fR ( int width, int height )" +.br +.ti -1c +.BI "virtual void \fBpaintGL\fR ()" +.br +.ti -1c +.BI "virtual void \fBinitializeOverlayGL\fR ()" +.br +.ti -1c +.BI "virtual void \fBresizeOverlayGL\fR ( int width, int height )" +.br +.ti -1c +.BI "virtual void \fBpaintOverlayGL\fR ()" +.br +.ti -1c +.BI "void \fBsetAutoBufferSwap\fR ( bool on )" +.br +.ti -1c +.BI "bool \fBautoBufferSwap\fR () const" +.br +.ti -1c +.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" +.br +.ti -1c +.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * )" +.br +.ti -1c +.BI "virtual void \fBglInit\fR ()" +.br +.ti -1c +.BI "virtual void \fBglDraw\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QGLWidget class is a widget for rendering OpenGL graphics. +.PP +QGLWidget provides functionality for displaying OpenGL<sup>*</sup> graphics integrated into a Qt application. It is very simple to use. You inherit from it and use the subclass like any other QWidget, except that instead of drawing the widget's contents using QPainter etc. you use the standard OpenGL rendering commands. +.PP +QGLWidget provides three convenient virtual functions that you can reimplement in your subclass to perform the typical OpenGL tasks: +.TP +paintGL() - Renders the OpenGL scene. Gets called whenever the widget needs to be updated. +.TP +resizeGL() - Sets up the OpenGL viewport, projection, etc. Gets called whenever the the widget has been resized (and also when it is shown for the first time because all newly created widgets get a resize event automatically). +.TP +initializeGL() - Sets up the OpenGL rendering context, defines display lists, etc. Gets called once before the first time resizeGL() or paintGL() is called. +.PP +Here is a rough outline of how a QGLWidget subclass might look: +.PP +.nf +.br + class MyGLDrawer : public QGLWidget +.br + { +.br + TQ_OBJECT // must include this if you use Qt signals/slots +.br +.br + public: +.br + MyGLDrawer( QWidget *parent, const char *name ) +.br + : QGLWidget(parent, name) {} +.br +.br + protected: +.br +.br + void initializeGL() +.br + { +.br + // Set up the rendering context, define display lists etc.: +.br + ... +.br + glClearColor( 0.0, 0.0, 0.0, 0.0 ); +.br + glEnable(GL_DEPTH_TEST); +.br + ... +.br + } +.br +.br + void resizeGL( int w, int h ) +.br + { +.br + // setup viewport, projection etc.: +.br + glViewport( 0, 0, (GLint)w, (GLint)h ); +.br + ... +.br + glFrustum( ... ); +.br + ... +.br + } +.br +.br + void paintGL() +.br + { +.br + // draw the scene: +.br + ... +.br + glRotatef( ... ); +.br + glMaterialfv( ... ); +.br + glBegin( GL_QUADS ); +.br + glVertex3f( ... ); +.br + glVertex3f( ... ); +.br + ... +.br + glEnd(); +.br + ... +.br + } +.br +.br + }; +.br +.fi +.PP +If you need to trigger a repaint from places other than paintGL() (a typical example is when using timers to animate scenes), you should call the widget's updateGL() function. +.PP +Your widget's OpenGL rendering context is made current when paintGL(), resizeGL(), or initializeGL() is called. If you need to call the standard OpenGL API functions from other places (e.g. in your widget's constructor or in your own paint functions), you must call makeCurrent() first. +.PP +QGLWidget provides functions for requesting a new display format and you can also create widgets with customized rendering contexts. +.PP +You can also share OpenGL display lists between QGLWidgets (see the documentation of the QGLWidget constructors for details). +.SH "Overlays" +The QGLWidget creates a GL overlay context in addition to the normal context if overlays are supported by the underlying system. +.PP +If you want to use overlays, you specify it in the format. (Note: Overlay must be requested in the format passed to the QGLWidget constructor.) Your GL widget should also implement some or all of these virtual methods: +.TP +paintOverlayGL() +.TP +resizeOverlayGL() +.TP +initializeOverlayGL() +.PP +These methods work in the same way as the normal paintGL() etc. functions, except that they will be called when the overlay context is made current. You can explicitly make the overlay context current by using makeOverlayCurrent(), and you can access the overlay context directly (e.g. to ask for its transparent color) by calling overlayContext(). +.PP +On X servers in which the default visual is in an overlay plane, non-GL Qt windows can also be used for overlays. See the examples/opengl/overlay_x11 example program for details. +.PP +<sup>*</sup> OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGLWidget::QGLWidget ( QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" +Constructs an OpenGL widget with a \fIparent\fR widget and a \fIname\fR. +.PP +The default format is used. The widget will be invalid if the system has no OpenGL support. +.PP +The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QWidget constructor. +.PP +If the \fIshareWidget\fR parameter points to a valid QGLWidget, this widget will share OpenGL display lists with \fIshareWidget\fR. If this widget and \fIshareWidget\fR have different formats, display list sharing may fail. You can check whether display list sharing succeeded by calling isSharing(). +.PP +The initialization of OpenGL rendering state, etc. should be done by overriding the initializeGL() function, rather than in the constructor of your QGLWidget subclass. +.PP +See also QGLFormat::defaultFormat(). +.SH "QGLWidget::QGLWidget ( QGLContext * context, QWidget * parent, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" +Constructs an OpenGL widget with parent \fIparent\fR, called \fIname\fR. +.PP +The \fIcontext\fR argument is a pointer to the QGLContext that you wish to be bound to this widget. This allows you to pass in your own QGLContext sub-classes. +.PP +The widget will be invalid if the system has no OpenGL support. +.PP +The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QWidget constructor. +.PP +If the \fIshareWidget\fR parameter points to a valid QGLWidget, this widget will share OpenGL display lists with \fIshareWidget\fR. If this widget and \fIshareWidget\fR have different formats, display list sharing may fail. You can check whether display list sharing succeeded by calling isSharing(). +.PP +The initialization of OpenGL rendering state, etc. should be done by overriding the initializeGL() function, rather than in the constructor of your QGLWidget subclass. +.PP +See also QGLFormat::defaultFormat() and isValid(). +.SH "QGLWidget::QGLWidget ( const QGLFormat & format, QWidget * parent = 0, const char * name = 0, const QGLWidget * shareWidget = 0, WFlags f = 0 )" +Constructs an OpenGL widget with parent \fIparent\fR, called \fIname\fR. +.PP +The \fIformat\fR argument specifies the desired rendering options. If the underlying OpenGL/Window system cannot satisfy all the features requested in \fIformat\fR, the nearest subset of features will be used. After creation, the format() method will return the actual format obtained. +.PP +The widget will be invalid if the system has no OpenGL support. +.PP +The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QWidget constructor. +.PP +If the \fIshareWidget\fR parameter points to a valid QGLWidget, this widget will share OpenGL display lists with \fIshareWidget\fR. If this widget and \fIshareWidget\fR have different formats, display list sharing may fail. You can check whether display list sharing succeeded by calling isSharing(). +.PP +The initialization of OpenGL rendering state, etc. should be done by overriding the initializeGL() function, rather than in the constructor of your QGLWidget subclass. +.PP +See also QGLFormat::defaultFormat() and isValid(). +.SH "QGLWidget::~QGLWidget ()" +Destroys the widget. +.SH "bool QGLWidget::autoBufferSwap () const\fC [protected]\fR" +Returns TRUE if the widget is doing automatic GL buffer swapping; otherwise returns FALSE. +.PP +See also setAutoBufferSwap(). +.SH "const QGLColormap & QGLWidget::colormap () const" +Returns the colormap for this widget. +.PP +Usually it is only top-level widgets that can have different colormaps installed. Asking for the colormap of a child widget will return the colormap for the child's top-level widget. +.PP +If no colormap has been set for this widget, the QColormap returned will be empty. +.PP +See also setColormap(). +.SH "const QGLContext * QGLWidget::context () const" +Returns the context of this widget. +.PP +It is possible that the context is not valid (see isValid()), for example, if the underlying hardware does not support the format attributes that were requested. +.SH "QImage QGLWidget::convertToGLFormat ( const QImage & img )\fC [static]\fR" +Converts the image \fIimg\fR into the unnamed format expected by OpenGL functions such as glTexImage2D(). The returned image is not usable as a QImage, but QImage::width(), QImage::height() and QImage::bits() may be used with OpenGL. The following few lines are from the texture example. Most of the code is irrelevant, so we just quote the relevant bits: +.PP +.nf +.br + QImage tex1, tex2, buf; +.br + if ( !buf.load( "gllogo.bmp" ) ) { // Load first image from file +.fi +.PP +We create \fItex1\fR (and another variable) for OpenGL, and load a real image into \fIbuf\fR. +.PP +.nf +.br + tex1 = QGLWidget::convertToGLFormat( buf ); // flipped 32bit RGBA +.fi +.PP +A few lines later, we convert \fIbuf\fR into OpenGL format and store it in \fItex1\fR. +.PP +.nf +.br + glTexImage2D( GL_TEXTURE_2D, 0, 3, tex1.width(), tex1.height(), 0, +.br + GL_RGBA, GL_UNSIGNED_BYTE, tex1.bits() ); +.fi +.PP +Note the dimension restrictions for texture images as described in the glTexImage2D() documentation. The width must be 2^m + 2*border and the height 2^n + 2*border where m and n are integers and border is either 0 or 1. +.PP +Another function in the same example uses \fItex1\fR with OpenGL. +.PP +Example: opengl/texture/gltexobj.cpp. +.SH "void QGLWidget::doneCurrent ()" +Makes no GL context the current context. Normally, you do not need to call this function; QGLContext calls it as necessary. However, it may be useful in multithreaded environments. +.SH "bool QGLWidget::doubleBuffer () const" +Returns TRUE if the contained GL rendering context has double buffering; otherwise returns FALSE. +.PP +See also QGLFormat::doubleBuffer(). +.SH "QGLFormat QGLWidget::format () const" +Returns the format of the contained GL rendering context. +.SH "void QGLWidget::glDraw ()\fC [virtual protected]\fR" +Executes the virtual function paintGL(). +.PP +The widget's rendering context will become the current context and initializeGL() will be called if it hasn't already been called. +.SH "void QGLWidget::glInit ()\fC [virtual protected]\fR" +Initializes OpenGL for this widget's context. Calls the virtual function initializeGL(). +.SH "QImage QGLWidget::grabFrameBuffer ( bool withAlpha = FALSE )\fC [virtual]\fR" +Returns an image of the frame buffer. If \fIwithAlpha\fR is TRUE the alpha channel is included. +.PP +Depending on your hardware, you can explicitly select which color buffer to grab with a glReadBuffer() call before calling this function. +.SH "void QGLWidget::initializeGL ()\fC [virtual protected]\fR" +This virtual function is called once before the first call to paintGL() or resizeGL(), and then once whenever the widget has been assigned a new QGLContext. Reimplement it in a subclass. +.PP +This function should set up any required OpenGL context rendering flags, defining display lists, etc. +.PP +There is no need to call makeCurrent() because this has already been done when this function is called. +.SH "void QGLWidget::initializeOverlayGL ()\fC [virtual protected]\fR" +This virtual function is used in the same manner as initializeGL() except that it operates on the widget's overlay context instead of the widget's main context. This means that initializeOverlayGL() is called once before the first call to paintOverlayGL() or resizeOverlayGL(). Reimplement it in a subclass. +.PP +This function should set up any required OpenGL context rendering flags, defining display lists, etc. for the overlay context. +.PP +There is no need to call makeOverlayCurrent() because this has already been done when this function is called. +.SH "bool QGLWidget::isSharing () const" +Returns TRUE if display list sharing with another QGLWidget was requested in the constructor, and the GL system was able to provide it; otherwise returns FALSE. The GL system may fail to provide display list sharing if the two QGLWidgets use different formats. +.PP +See also format(). +.SH "bool QGLWidget::isValid () const" +Returns TRUE if the widget has a valid GL rendering context; otherwise returns FALSE. A widget will be invalid if the system has no OpenGL support. +.SH "void QGLWidget::makeCurrent ()\fC [virtual]\fR" +Makes this widget the current widget for OpenGL operations, i.e. makes the widget's rendering context the current OpenGL rendering context. +.SH "void QGLWidget::makeOverlayCurrent ()\fC [virtual]\fR" +Makes the overlay context of this widget current. Use this if you need to issue OpenGL commands to the overlay context outside of initializeOverlayGL(), resizeOverlayGL(), and paintOverlayGL(). +.PP +Does nothing if this widget has no overlay. +.PP +See also makeCurrent(). +.SH "const QGLContext * QGLWidget::overlayContext () const" +Returns the overlay context of this widget, or 0 if this widget has no overlay. +.PP +See also context(). +.SH "void QGLWidget::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" +Handles paint events. Will cause the virtual paintGL() function to be called. +.PP +The widget's rendering context will become the current context and initializeGL() will be called if it hasn't already been called. +.PP +Reimplemented from QWidget. +.SH "void QGLWidget::paintGL ()\fC [virtual protected]\fR" +This virtual function is called whenever the widget needs to be painted. Reimplement it in a subclass. +.PP +There is no need to call makeCurrent() because this has already been done when this function is called. +.SH "void QGLWidget::paintOverlayGL ()\fC [virtual protected]\fR" +This virtual function is used in the same manner as paintGL() except that it operates on the widget's overlay context instead of the widget's main context. This means that paintOverlayGL() is called whenever the widget's overlay needs to be painted. Reimplement it in a subclass. +.PP +There is no need to call makeOverlayCurrent() because this has already been done when this function is called. +.SH "void QGLWidget::qglClearColor ( const QColor & c ) const" +Convenience function for specifying the clearing color to OpenGL. Calls glClearColor (in RGBA mode) or glClearIndex (in color-index mode) with the color \fIc\fR. Applies to the current GL context. +.PP +See also qglColor(), QGLContext::currentContext(), and QColor. +.SH "void QGLWidget::qglColor ( const QColor & c ) const" +Convenience function for specifying a drawing color to OpenGL. Calls glColor3 (in RGBA mode) or glIndex (in color-index mode) with the color \fIc\fR. Applies to the current GL context. +.PP +See also qglClearColor(), QGLContext::currentContext(), and QColor. +.SH "QPixmap QGLWidget::renderPixmap ( int w = 0, int h = 0, bool useContext = FALSE )\fC [virtual]\fR" +Renders the current scene on a pixmap and returns the pixmap. +.PP +You can use this method on both visible and invisible QGLWidgets. +.PP +This method will create a pixmap and a temporary QGLContext to render on the pixmap. It will then call initializeGL(), resizeGL(), and paintGL() on this context. Finally, the widget's original GL context is restored. +.PP +The size of the pixmap will be \fIw\fR pixels wide and \fIh\fR pixels high unless one of these parameters is 0 (the default), in which case the pixmap will have the same size as the widget. +.PP +If \fIuseContext\fR is TRUE, this method will try to be more efficient by using the existing GL context to render the pixmap. The default is FALSE. Only use TRUE if you understand the risks. +.PP +Overlays are not rendered onto the pixmap. +.PP +If the GL rendering context and the desktop have different bit depths, the result will most likely look surprising. +.PP +Note that the creation of display lists, modifications of the view frustum etc. should be done from within initializeGL(). If this is not done, the temporary QGLContext will not be initialized properly, and the rendered pixmap may be incomplete/corrupted. +.SH "void QGLWidget::renderText ( int x, int y, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" +Renders the string \fIstr\fR into the GL context of this widget. +.PP +\fIx\fR and \fIy\fR are specified in window coordinates, with the origin in the upper left-hand corner of the window. If \fIfnt\fR is not specified, the currently set application font will be used to render the string. To change the color of the rendered text you can use the glColor() call (or the qglColor() convenience function), just before the renderText() call. Note that if you have GL_LIGHTING enabled, the string will not appear in the color you want. You should therefore switch lighting off before using renderText(). +.PP +\fIlistBase\fR specifies the index of the first display list that is generated by this function. The default value is 2000. 256 display lists will be generated, one for each of the first 256 characters in the font that is used to render the string. If several fonts are used in the same widget, the display lists for these fonts will follow the last generated list. You would normally not have to change this value unless you are using lists in the same range. The lists are deleted when the widget is destroyed. +.PP +Note: This function only works reliably with ASCII strings. +.SH "void QGLWidget::renderText ( double x, double y, double z, const QString & str, const QFont & fnt = QFont ( ), int listBase = 2000 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIx\fR, \fIy\fR and \fIz\fR are specified in scene or object coordinates relative to the currently set projection and model matrices. This can be useful if you want to annotate models with text labels and have the labels move with the model as it is rotated etc. +.SH "void QGLWidget::resizeEvent ( QResizeEvent * )\fC [virtual protected]\fR" +Handles resize events. Calls the virtual function resizeGL(). +.PP +Reimplemented from QWidget. +.SH "void QGLWidget::resizeGL ( int width, int height )\fC [virtual protected]\fR" +This virtual function is called whenever the widget has been resized. The new size is passed in \fIwidth\fR and \fIheight\fR. Reimplement it in a subclass. +.PP +There is no need to call makeCurrent() because this has already been done when this function is called. +.SH "void QGLWidget::resizeOverlayGL ( int width, int height )\fC [virtual protected]\fR" +This virtual function is used in the same manner as paintGL() except that it operates on the widget's overlay context instead of the widget's main context. This means that resizeOverlayGL() is called whenever the widget has been resized. The new size is passed in \fIwidth\fR and \fIheight\fR. Reimplement it in a subclass. +.PP +There is no need to call makeOverlayCurrent() because this has already been done when this function is called. +.SH "void QGLWidget::setAutoBufferSwap ( bool on )\fC [protected]\fR" +If \fIon\fR is TRUE automatic GL buffer swapping is switched on; otherwise it is switched off. +.PP +If \fIon\fR is TRUE and the widget is using a double-buffered format, the background and foreground GL buffers will automatically be swapped after each paintGL() call. +.PP +The buffer auto-swapping is on by default. +.PP +See also autoBufferSwap(), doubleBuffer(), and swapBuffers(). +.SH "void QGLWidget::setColormap ( const QGLColormap & cmap )" +Set the colormap for this widget to \fIcmap\fR. Usually it is only top-level widgets that can have colormaps installed. +.PP +See also colormap(). +.SH "void QGLWidget::swapBuffers ()\fC [virtual]\fR" +Swaps the screen contents with an off-screen buffer. This only works if the widget's format specifies double buffer mode. +.PP +Normally, there is no need to explicitly call this function because it is done automatically after each widget repaint, i.e. each time after paintGL() has been executed. +.PP +See also doubleBuffer(), setAutoBufferSwap(), and QGLFormat::setDoubleBuffer(). +.SH "void QGLWidget::updateGL ()\fC [virtual slot]\fR" +Updates the widget by calling glDraw(). +.SH "void QGLWidget::updateOverlayGL ()\fC [virtual slot]\fR" +Updates the widget's overlay (if any). Will cause the virtual function paintOverlayGL() to be executed. +.PP +The widget's rendering context will become the current context and +initializeGL() will be called if it hasn't already been called. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qglwidget.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqglwidget.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgrid.3qt b/doc/man/man3/tqgrid.3qt new file mode 100644 index 000000000..08cc8e46d --- /dev/null +++ b/doc/man/man3/tqgrid.3qt @@ -0,0 +1,75 @@ +'\" t +.TH QGrid 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 +QGrid \- Simple geometry management of its children +.SH SYNOPSIS +\fC#include <ntqgrid.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGrid\fR ( int n, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQGrid\fR ( int n, Orientation orient, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "void \fBsetSpacing\fR ( int space )" +.br +.in -1c +.SH DESCRIPTION +The QGrid widget provides simple geometry management of its children. +.PP +The grid places its widgets either in columns or in rows depending on its orientation. +.PP +The number of rows \fIor\fR columns is defined in the constructor. All the grid's children will be placed and sized in accordance with their sizeHint() and sizePolicy(). +.PP +Use setMargin() to add space around the grid itself, and setSpacing() to add space between the widgets. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QVBox, QHBox, QGridLayout, Widget Appearance and Style, and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGrid::QGrid ( int n, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a grid widget with parent \fIparent\fR, called \fIname\fR. \fIn\fR specifies the number of columns. The widget flags \fIf\fR are passed to the QFrame constructor. +.SH "QGrid::QGrid ( int n, Orientation orient, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a grid widget with parent \fIparent\fR, called \fIname\fR. If \fIorient\fR is Horizontal, \fIn\fR specifies the number of columns. If \fIorient\fR is Vertical, \fIn\fR specifies the number of rows. The widget flags \fIf\fR are passed to the QFrame constructor. +.SH "void QGrid::setSpacing ( int space )" +Sets the spacing between the child widgets to \fIspace\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqgrid.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgrid.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgridlayout.3qt b/doc/man/man3/tqgridlayout.3qt new file mode 100644 index 000000000..7a5ce8a5a --- /dev/null +++ b/doc/man/man3/tqgridlayout.3qt @@ -0,0 +1,390 @@ +'\" t +.TH QGridLayout 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 +QGridLayout \- Lays out widgets in a grid +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherits QLayout. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGridLayout\fR ( QWidget * parent, int nRows = 1, int nCols = 1, int margin = 0, int space = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQGridLayout\fR ( int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQGridLayout\fR ( QLayout * parentLayout, int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QGridLayout\fR ()" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBminimumSize\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBmaximumSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRowStretch\fR ( int row, int stretch )" +.br +.ti -1c +.BI "virtual void \fBsetColStretch\fR ( int col, int stretch )" +.br +.ti -1c +.BI "int \fBrowStretch\fR ( int row ) const" +.br +.ti -1c +.BI "int \fBcolStretch\fR ( int col ) const" +.br +.ti -1c +.BI "void \fBsetRowSpacing\fR ( int row, int minSize )" +.br +.ti -1c +.BI "void \fBsetColSpacing\fR ( int col, int minSize )" +.br +.ti -1c +.BI "int \fBrowSpacing\fR ( int row ) const" +.br +.ti -1c +.BI "int \fBcolSpacing\fR ( int col ) const" +.br +.ti -1c +.BI "int \fBnumRows\fR () const" +.br +.ti -1c +.BI "int \fBnumCols\fR () const" +.br +.ti -1c +.BI "QRect \fBcellGeometry\fR ( int row, int col ) const" +.br +.ti -1c +.BI "virtual bool \fBhasHeightForWidth\fR () const" +.br +.ti -1c +.BI "virtual int \fBheightForWidth\fR ( int w ) const" +.br +.ti -1c +.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" +.br +.ti -1c +.BI "virtual void \fBinvalidate\fR ()" +.br +.ti -1c +.BI "virtual void \fBaddItem\fR ( QLayoutItem * item )" +.br +.ti -1c +.BI "void \fBaddItem\fR ( QLayoutItem * item, int row, int col )" +.br +.ti -1c +.BI "void \fBaddMultiCell\fR ( QLayoutItem * item, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" +.br +.ti -1c +.BI "void \fBaddWidget\fR ( QWidget * w, int row, int col, int alignment = 0 )" +.br +.ti -1c +.BI "void \fBaddMultiCellWidget\fR ( QWidget * w, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" +.br +.ti -1c +.BI "void \fBaddLayout\fR ( QLayout * layout, int row, int col )" +.br +.ti -1c +.BI "void \fBaddMultiCellLayout\fR ( QLayout * layout, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" +.br +.ti -1c +.BI "void addRowSpacing ( int row, int minsize ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void addColSpacing ( int col, int minsize ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBexpand\fR ( int nRows, int nCols )" +.br +.ti -1c +.BI "enum \fBCorner\fR { TopLeft, TopRight, BottomLeft, BottomRight }" +.br +.ti -1c +.BI "void \fBsetOrigin\fR ( Corner c )" +.br +.ti -1c +.BI "Corner \fBorigin\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "bool \fBfindWidget\fR ( QWidget * w, int * row, int * col )" +.br +.ti -1c +.BI "void \fBadd\fR ( QLayoutItem * item, int row, int col )" +.br +.in -1c +.SH DESCRIPTION +The QGridLayout class lays out widgets in a grid. +.PP +QGridLayout takes the space made available to it (by its parent layout or by the mainWidget()), divides it up into rows and columns, and puts each widget it manages into the correct cell. +.PP +Columns and rows behave identically; we will discuss columns, but there are equivalent functions for rows. +.PP +Each column has a minimum width and a stretch factor. The minimum width is the greatest of that set using addColSpacing() and the minimum width of each widget in that column. The stretch factor is set using setColStretch() and determines how much of the available space the column will get over and above its necessary minimum. +.PP +Normally, each managed widget or layout is put into a cell of its own using addWidget(), addLayout() or by the auto-add facility. It is also possible for a widget to occupy multiple cells using addMultiCellWidget(). If you do this, QGridLayout will guess how to distribute the size over the columns/rows (based on the stretch factors). +.PP +To remove a widget from a layout, call remove(). Calling QWidget::hide() on a widget also effectively removes the widget from the layout until QWidget::show() is called. +.PP +This illustration shows a fragment of a dialog with a five-column, three-row grid (the grid is shown overlaid in magenta): +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +Columns 0, 2 and 4 in this dialog fragment are made up of a QLabel, a QLineEdit, and a QListBox. Columns 1 and 3 are placeholders made with addColSpacing(). Row 0 consists of three QLabel objects, row 1 of three QLineEdit objects and row 2 of three QListBox objects. We used placeholder columns (1 and 3) to get the right amount of space between the columns. +.PP +Note that the columns and rows are not equally wide or tall. If you want two columns to have the same width, you must set their minimum widths and stretch factors to be the same yourself. You do this using addColSpacing() and setColStretch(). +.PP +If the QGridLayout is not the top-level layout (i.e. does not manage all of the widget's area and children), you must add it to its parent layout when you create it, but before you do anything with it. The normal way to add a layout is by calling parentLayout->addLayout(). +.PP +Once you have added your layout you can start putting widgets and other layouts into the cells of your grid layout using addWidget(), addLayout() and addMultiCellWidget(). +.PP +QGridLayout also includes two margin widths: the border and the spacing. The border is the width of the reserved space along each of the QGridLayout's four sides. The spacing is the width of the automatically allocated spacing between neighboring boxes. +.PP +Both the border and the spacing are parameters of the constructor and default to 0. +.PP +See also QGrid, Layout Overview, Widget Appearance and Style, and Layout Management. +.SS "Member Type Documentation" +.SH "QGridLayout::Corner" +This enum identifies which corner is the origin (0, 0) of the layout. +.TP +\fCQGridLayout::TopLeft\fR - the top-left corner +.TP +\fCQGridLayout::TopRight\fR - the top-right corner +.TP +\fCQGridLayout::BottomLeft\fR - the bottom-left corner +.TP +\fCQGridLayout::BottomRight\fR - the bottom-right corner +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGridLayout::QGridLayout ( QWidget * parent, int nRows = 1, int nCols = 1, int margin = 0, int space = -1, const char * name = 0 )" +Constructs a new QGridLayout with \fInRows\fR rows, \fInCols\fR columns and parent widget, \fIparent\fR. \fIparent\fR may not be 0. The grid layout is called \fIname\fR. +.PP +\fImargin\fR is the number of pixels between the edge of the widget and its managed children. \fIspace\fR is the default number of pixels between cells. If \fIspace\fR is -1, the value of \fImargin\fR is used. +.SH "QGridLayout::QGridLayout ( int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" +Constructs a new grid with \fInRows\fR rows and \fInCols\fR columns. If \fIspacing\fR is -1, this QGridLayout inherits its parent's spacing(); otherwise \fIspacing\fR is used. The grid layout is called \fIname\fR. +.PP +You must insert this grid into another layout. You can insert widgets and layouts into this layout at any time, but laying out will not be performed before this is inserted into another layout. +.SH "QGridLayout::QGridLayout ( QLayout * parentLayout, int nRows = 1, int nCols = 1, int spacing = -1, const char * name = 0 )" +Constructs a new grid that is placed inside \fIparentLayout\fR with \fInRows\fR rows and \fInCols\fR columns. If \fIspacing\fR is -1, this QGridLayout inherits its parent's spacing(); otherwise \fIspacing\fR is used. The grid layout is called \fIname\fR. +.PP +This grid is placed according to \fIparentLayout\fR's default placement rules. +.SH "QGridLayout::~QGridLayout ()" +Destroys the grid layout. Geometry management is terminated if this is a top-level grid. +.PP +The layout's widgets aren't destroyed. +.SH "void QGridLayout::add ( QLayoutItem * item, int row, int col )\fC [protected]\fR" +Adds \fIitem\fR at position \fIrow\fR, \fIcol\fR. The layout takes ownership of the \fIitem\fR. +.SH "void QGridLayout::addColSpacing ( int col, int minsize )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the minimum width of column \fIcol\fR to \fIminsize\fR pixels. +.PP +Use setColSpacing() instead. +.SH "void QGridLayout::addItem ( QLayoutItem * item, int row, int col )" +Adds \fIitem\fR at position \fIrow\fR, \fIcol\fR. The layout takes ownership of the \fIitem\fR. +.SH "void QGridLayout::addItem ( QLayoutItem * item )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds \fIitem\fR to the next free position of this layout. +.PP +Reimplemented from QLayout. +.SH "void QGridLayout::addLayout ( QLayout * layout, int row, int col )" +Places the \fIlayout\fR at position (\fIrow\fR, \fIcol\fR) in the grid. The top-left position is (0, 0). +.PP +\fIlayout\fR becomes a child of the grid layout. +.PP +When a layout is constructed with another layout as its parent, you don't need to call addLayout(); the child layout is automatically added to the parent layout as it is constructed. +.PP +See also addMultiCellLayout(). +.PP +Examples: +.)l listbox/listbox.cpp, progressbar/progressbar.cpp, t10/main.cpp, and t13/gamebrd.cpp. +.SH "void QGridLayout::addMultiCell ( QLayoutItem * item, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" +Adds the \fIitem\fR to the cell grid, spanning multiple rows/columns. +.PP +The cell will span from \fIfromRow\fR, \fIfromCol\fR to \fItoRow\fR, \fItoCol\fR. Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. +.SH "void QGridLayout::addMultiCellLayout ( QLayout * layout, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" +Adds the layout \fIlayout\fR to the cell grid, spanning multiple rows/columns. The cell will span from \fIfromRow\fR, \fIfromCol\fR to \fItoRow\fR, \fItoCol\fR. +.PP +Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. +.PP +A non-zero alignment indicates that the layout should not grow to fill the available space but should be sized according to sizeHint(). +.PP +\fIlayout\fR becomes a child of the grid layout. +.PP +See also addLayout(). +.SH "void QGridLayout::addMultiCellWidget ( QWidget * w, int fromRow, int toRow, int fromCol, int toCol, int alignment = 0 )" +Adds the widget \fIw\fR to the cell grid, spanning multiple rows/columns. The cell will span from \fIfromRow\fR, \fIfromCol\fR to \fItoRow\fR, \fItoCol\fR. +.PP +Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. +.PP +A non-zero alignment indicates that the widget should not grow to fill the available space but should be sized according to sizeHint(). +.PP +See also addWidget(). +.PP +Examples: +.)l cursor/cursor.cpp, layout/layout.cpp, and progressbar/progressbar.cpp. +.SH "void QGridLayout::addRowSpacing ( int row, int minsize )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the minimum height of row \fIrow\fR to \fIminsize\fR pixels. +.PP +Use setRowSpacing() instead. +.SH "void QGridLayout::addWidget ( QWidget * w, int row, int col, int alignment = 0 )" +Adds the widget \fIw\fR to the cell grid at \fIrow\fR, \fIcol\fR. The top-left position is (0, 0) by default. +.PP +Alignment is specified by \fIalignment\fR, which is a bitwise OR of Qt::AlignmentFlags values. The default alignment is 0, which means that the widget fills the entire cell. +.TP +You should not call this if you have enabled the auto-add facility of the layout. +.IP +.TP +From Qt 3.0, the \fIalignment\fR parameter is interpreted more aggressively than in previous versions of Qt. A non-default alignment now indicates that the widget should not grow to fill the available space, but should be sized according to sizeHint(). +.PP +See also addMultiCellWidget(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, layout/layout.cpp, rot13/rot13.cpp, sql/overview/form1/main.cpp, sql/overview/form2/main.cpp, t14/gamebrd.cpp, and t8/main.cpp. +.SH "QRect QGridLayout::cellGeometry ( int row, int col ) const" +Returns the geometry of the cell with row \fIrow\fR and column \fIcol\fR in the grid. Returns an invalid rectangle if \fIrow\fR or \fIcol\fR is outside the grid. +.PP +\fBWarning:\fR in the current version of Qt this function does not return valid results until setGeometry() has been called, i.e. after the mainWidget() is visible. +.SH "int QGridLayout::colSpacing ( int col ) const" +Returns the column spacing for column \fIcol\fR. +.PP +See also setColSpacing(). +.SH "int QGridLayout::colStretch ( int col ) const" +Returns the stretch factor for column \fIcol\fR. +.PP +See also setColStretch(). +.SH "void QGridLayout::expand ( int nRows, int nCols )" +Expands this grid so that it will have \fInRows\fR rows and \fInCols\fR columns. Will not shrink the grid. You should not need to call this function because QGridLayout expands automatically as new items are inserted. +.SH "QSizePolicy::ExpandData QGridLayout::expanding () const\fC [virtual]\fR" +Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions. +.PP +Reimplemented from QLayout. +.SH "bool QGridLayout::findWidget ( QWidget * w, int * row, int * col )\fC [protected]\fR" +Searches for widget \fIw\fR in this layout (not including child layouts). If \fIw\fR is found, it sets \fC<em>row</em>\fR and \fC<em>col</em>\fR to the row and column and returns TRUE; otherwise returns FALSE. +.PP +Note: if a widget spans multiple rows/columns, the top-left cell is returned. +.SH "bool QGridLayout::hasHeightForWidth () const\fC [virtual]\fR" +Returns TRUE if this layout's preferred height depends on its width; otherwise returns FALSE. +.PP +Reimplemented from QLayoutItem. +.SH "int QGridLayout::heightForWidth ( int w ) const\fC [virtual]\fR" +Returns the layout's preferred height when it is \fIw\fR pixels wide. +.PP +Reimplemented from QLayoutItem. +.SH "void QGridLayout::invalidate ()\fC [virtual]\fR" +Resets cached information. +.PP +Reimplemented from QLayout. +.SH "QSize QGridLayout::maximumSize () const\fC [virtual]\fR" +Returns the maximum size needed by this grid. +.PP +Reimplemented from QLayout. +.SH "QSize QGridLayout::minimumSize () const\fC [virtual]\fR" +Returns the minimum size needed by this grid. +.PP +Reimplemented from QLayout. +.SH "int QGridLayout::numCols () const" +Returns the number of columns in this grid. +.SH "int QGridLayout::numRows () const" +Returns the number of rows in this grid. +.SH "Corner QGridLayout::origin () const" +Returns the corner that's used for the grid's origin, i.e. for position (0, 0). +.SH "int QGridLayout::rowSpacing ( int row ) const" +Returns the row spacing for row \fIrow\fR. +.PP +See also setRowSpacing(). +.SH "int QGridLayout::rowStretch ( int row ) const" +Returns the stretch factor for row \fIrow\fR. +.PP +See also setRowStretch(). +.SH "void QGridLayout::setColSpacing ( int col, int minSize )" +Sets the minimum width of column \fIcol\fR to \fIminSize\fR pixels. +.PP +See also colSpacing() and setRowSpacing(). +.SH "void QGridLayout::setColStretch ( int col, int stretch )\fC [virtual]\fR" +Sets the stretch factor of column \fIcol\fR to \fIstretch\fR. The first column is number 0. +.PP +The stretch factor is relative to the other columns in this grid. Columns with a higher stretch factor take more of the available space. +.PP +The default stretch factor is 0. If the stretch factor is 0 and no other column in this table can grow at all, the column may still grow. +.PP +See also colStretch(), addColSpacing(), and setRowStretch(). +.PP +Examples: +.)l layout/layout.cpp, t14/gamebrd.cpp, and t8/main.cpp. +.SH "void QGridLayout::setGeometry ( const QRect & r )\fC [virtual]\fR" +Resizes managed widgets within the rectangle \fIr\fR. +.PP +Reimplemented from QLayout. +.SH "void QGridLayout::setOrigin ( Corner c )" +Sets the grid's origin corner, i.e. position (0, 0), to \fIc\fR. +.SH "void QGridLayout::setRowSpacing ( int row, int minSize )" +Sets the minimum height of row \fIrow\fR to \fIminSize\fR pixels. +.PP +See also rowSpacing() and setColSpacing(). +.SH "void QGridLayout::setRowStretch ( int row, int stretch )\fC [virtual]\fR" +Sets the stretch factor of row \fIrow\fR to \fIstretch\fR. The first row is number 0. +.PP +The stretch factor is relative to the other rows in this grid. Rows with a higher stretch factor take more of the available space. +.PP +The default stretch factor is 0. If the stretch factor is 0 and no other row in this table can grow at all, the row may still grow. +.PP +See also rowStretch(), setRowSpacing(), and setColStretch(). +.PP +Examples: +.)l addressbook/centralwidget.cpp and qutlook/centralwidget.cpp. +.SH "QSize QGridLayout::sizeHint () const\fC [virtual]\fR" +Returns the preferred size of this grid. +.PP +Reimplemented from QLayoutItem. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qgridlayout.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgridlayout.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgridview.3qt b/doc/man/man3/tqgridview.3qt new file mode 100644 index 000000000..7ec8b9f0d --- /dev/null +++ b/doc/man/man3/tqgridview.3qt @@ -0,0 +1,245 @@ +'\" t +.TH QGridView 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 +QGridView \- Abstract base for fixed-size grids +.SH SYNOPSIS +\fC#include <ntqgridview.h>\fR +.PP +Inherits QScrollView. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGridView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QGridView\fR ()" +.br +.ti -1c +.BI "int \fBnumRows\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNumRows\fR ( int )" +.br +.ti -1c +.BI "int \fBnumCols\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNumCols\fR ( int )" +.br +.ti -1c +.BI "int \fBcellWidth\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCellWidth\fR ( int )" +.br +.ti -1c +.BI "int \fBcellHeight\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCellHeight\fR ( int )" +.br +.ti -1c +.BI "QRect \fBcellRect\fR () const" +.br +.ti -1c +.BI "QRect \fBcellGeometry\fR ( int row, int column )" +.br +.ti -1c +.BI "QSize \fBgridSize\fR () const" +.br +.ti -1c +.BI "int \fBrowAt\fR ( int y ) const" +.br +.ti -1c +.BI "int \fBcolumnAt\fR ( int x ) const" +.br +.ti -1c +.BI "void \fBrepaintCell\fR ( int row, int column, bool erase = TRUE )" +.br +.ti -1c +.BI "void \fBupdateCell\fR ( int row, int column )" +.br +.ti -1c +.BI "void \fBensureCellVisible\fR ( int row, int column )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBcellHeight\fR - the height of a grid row" +.br +.ti -1c +.BI "int \fBcellWidth\fR - the width of a grid column" +.br +.ti -1c +.BI "int \fBnumCols\fR - the number of columns in the grid" +.br +.ti -1c +.BI "int \fBnumRows\fR - the number of rows in the grid" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col ) = 0" +.br +.ti -1c +.BI "virtual void \fBpaintEmptyArea\fR ( QPainter * p, int cx, int cy, int cw, int ch )" +.br +.ti -1c +.BI "virtual void \fBdimensionChange\fR ( int oldNumRows, int oldNumCols )" +.br +.in -1c +.SH DESCRIPTION +The QGridView class provides an abstract base for fixed-size grids. +.PP +A grid view consists of a number of abstract cells organized in rows and columns. The cells have a fixed size and are identified with a row index and a column index. The top-left cell is in row 0, column 0. The bottom-right cell is in row numRows()-1, column numCols()-1. +.PP +You can define numRows, numCols, cellWidth and cellHeight. Reimplement the pure virtual function paintCell() to draw the contents of a cell. +.PP +With ensureCellVisible(), you can ensure a certain cell is visible. With rowAt() and columnAt() you can find a cell based on the given x- and y-coordinates. +.PP +If you need to monitor changes to the grid's dimensions (i.e. when numRows or numCols is changed), reimplement the dimensionChange() change handler. +.PP +Note: the row and column indices are always given in the order, row (vertical offset) then column (horizontal offset). This order is the opposite of all pixel operations, which are given in the order x (horizontal offset), y (vertical offset). +.PP +QGridView is a very simple abstract class based on QScrollView. It is designed to simplify the task of drawing many cells of the same size in a potentially scrollable canvas. If you need rows and columns with different sizes, use a QTable instead. If you need a simple list of items, use a QListBox. If you need to present hierachical data use a QListView, and if you need random objects at random positions, consider using either a QIconView or a QCanvas. +.PP +See also Abstract Widget Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGridView::QGridView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a grid view. +.PP +The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QScrollView constructor. +.SH "QGridView::~QGridView ()" +Destroys the grid view. +.SH "QRect QGridView::cellGeometry ( int row, int column )" +Returns the geometry of cell (\fIrow\fR, \fIcolumn\fR) in the content coordinate system. +.PP +See also cellRect(). +.SH "int QGridView::cellHeight () const" +Returns the height of a grid row. See the "cellHeight" property for details. +.SH "QRect QGridView::cellRect () const" +Returns the geometry of a cell in a cell's coordinate system. This is a convenience function useful in paintCell(). It is equivalent to QRect( 0, 0, cellWidth(), cellHeight() ). +.PP +See also cellGeometry(). +.SH "int QGridView::cellWidth () const" +Returns the width of a grid column. See the "cellWidth" property for details. +.SH "int QGridView::columnAt ( int x ) const" +Returns the number of the column at position \fIx\fR. \fIx\fR must be given in content coordinates. +.PP +See also rowAt(). +.SH "void QGridView::dimensionChange ( int oldNumRows, int oldNumCols )\fC [virtual protected]\fR" +This change handler is called whenever any of the grid's dimensions change. \fIoldNumRows\fR and \fIoldNumCols\fR contain the old dimensions, numRows() and numCols() contain the new dimensions. +.SH "void QGridView::ensureCellVisible ( int row, int column )" +Ensures cell (\fIrow\fR, \fIcolumn\fR) is visible, scrolling the grid view if necessary. +.SH "QSize QGridView::gridSize () const" +Returns the size of the grid in pixels. +.SH "int QGridView::numCols () const" +Returns the number of columns in the grid. See the "numCols" property for details. +.SH "int QGridView::numRows () const" +Returns the number of rows in the grid. See the "numRows" property for details. +.SH "void QGridView::paintCell ( QPainter * p, int row, int col )\fC [pure virtual protected]\fR" +This pure virtual function is called to paint the single cell at (\fIrow\fR, \fIcol\fR) using painter \fIp\fR. The painter must be open when paintCell() is called and must remain open. +.PP +The coordinate system is translated so that the origin is at the top-left corner of the cell to be painted, i.e. \fIcell\fR coordinates. Do not scale or shear the coordinate system (or if you do, restore the transformation matrix before you return). +.PP +The painter is not clipped by default in order to get maximum efficiency. If you want clipping, use +.PP +.nf +.br + p->setClipRect( cellRect(), QPainter::CoordPainter ); +.br + //... your drawing code +.br + p->setClipping( FALSE ); +.br +.br +.fi +.SH "void QGridView::paintEmptyArea ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" +This function fills the \fIcw\fR pixels wide and \fIch\fR pixels high rectangle starting at position (\fIcx\fR, \fIcy\fR) with the background color using the painter \fIp\fR. +.PP +paintEmptyArea() is invoked by drawContents() to erase or fill unused areas. +.SH "void QGridView::repaintCell ( int row, int column, bool erase = TRUE )" +Repaints cell (\fIrow\fR, \fIcolumn\fR). +.PP +If \fIerase\fR is TRUE, Qt erases the area of the cell before the paintCell() call; otherwise no erasing takes place. +.PP +See also QWidget::repaint(). +.SH "int QGridView::rowAt ( int y ) const" +Returns the number of the row at position \fIy\fR. \fIy\fR must be given in content coordinates. +.PP +See also columnAt(). +.SH "void QGridView::setCellHeight ( int )\fC [virtual]\fR" +Sets the height of a grid row. See the "cellHeight" property for details. +.SH "void QGridView::setCellWidth ( int )\fC [virtual]\fR" +Sets the width of a grid column. See the "cellWidth" property for details. +.SH "void QGridView::setNumCols ( int )\fC [virtual]\fR" +Sets the number of columns in the grid. See the "numCols" property for details. +.SH "void QGridView::setNumRows ( int )\fC [virtual]\fR" +Sets the number of rows in the grid. See the "numRows" property for details. +.SH "void QGridView::updateCell ( int row, int column )" +Updates cell (\fIrow\fR, \fIcolumn\fR). +.PP +See also QWidget::update(). +.SS "Property Documentation" +.SH "int cellHeight" +This property holds the height of a grid row. +.PP +All rows in a grid view have the same height. +.PP +See also cellWidth. +.PP +Set this property's value with setCellHeight() and get this property's value with cellHeight(). +.SH "int cellWidth" +This property holds the width of a grid column. +.PP +All columns in a grid view have the same width. +.PP +See also cellHeight. +.PP +Set this property's value with setCellWidth() and get this property's value with cellWidth(). +.SH "int numCols" +This property holds the number of columns in the grid. +.PP +Set this property's value with setNumCols() and get this property's value with numCols(). +.PP +See also numRows. +.SH "int numRows" +This property holds the number of rows in the grid. +.PP +Set this property's value with setNumRows() and get this property's value with numRows(). +.PP +See also numCols. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqgridview.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgridview.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqgroupbox.3qt b/doc/man/man3/tqgroupbox.3qt new file mode 100644 index 000000000..d99054aa1 --- /dev/null +++ b/doc/man/man3/tqgroupbox.3qt @@ -0,0 +1,329 @@ +'\" t +.TH QGroupBox 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 +QGroupBox \- Group box frame with a title +.SH SYNOPSIS +\fC#include <ntqgroupbox.h>\fR +.PP +Inherits QFrame. +.PP +Inherited by QButtonGroup, QHGroupBox, and QVGroupBox. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGroupBox\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQGroupBox\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQGroupBox\fR ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQGroupBox\fR ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QGroupBox\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetColumnLayout\fR ( int strips, Orientation direction )" +.br +.ti -1c +.BI "QString \fBtitle\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTitle\fR ( const QString & )" +.br +.ti -1c +.BI "int \fBalignment\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAlignment\fR ( int )" +.br +.ti -1c +.BI "int \fBcolumns\fR () const" +.br +.ti -1c +.BI "void \fBsetColumns\fR ( int )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "void \fBsetOrientation\fR ( Orientation )" +.br +.ti -1c +.BI "int \fBinsideMargin\fR () const" +.br +.ti -1c +.BI "int \fBinsideSpacing\fR () const" +.br +.ti -1c +.BI "void \fBsetInsideMargin\fR ( int m )" +.br +.ti -1c +.BI "void \fBsetInsideSpacing\fR ( int s )" +.br +.ti -1c +.BI "void \fBaddSpace\fR ( int size )" +.br +.ti -1c +.BI "bool \fBisFlat\fR () const" +.br +.ti -1c +.BI "void \fBsetFlat\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisCheckable\fR () const" +.br +.ti -1c +.BI "void \fBsetCheckable\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisChecked\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBsetChecked\fR ( bool b )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBtoggled\fR ( bool on )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "Alignment \fBalignment\fR - the alignment of the group box title" +.br +.ti -1c +.BI "bool \fBcheckable\fR - whether the group box has a checkbox in its title" +.br +.ti -1c +.BI "bool \fBchecked\fR - whether the group box's checkbox is checked" +.br +.ti -1c +.BI "int \fBcolumns\fR - the number of columns or rows (depending on \\l QGroupBox::orientation) in the group box" +.br +.ti -1c +.BI "bool \fBflat\fR - whether the group box is painted flat or has a frame" +.br +.ti -1c +.BI "Orientation \fBorientation\fR - the group box's orientation" +.br +.ti -1c +.BI "QString \fBtitle\fR - the group box title text" +.br +.in -1c +.SH DESCRIPTION +The QGroupBox widget provides a group box frame with a title. +.PP +A group box provides a frame, a title and a keyboard shortcut, and displays various other widgets inside itself. The title is on top, the keyboard shortcut moves keyboard focus to one of the group box's child widgets, and the child widgets are usually laid out horizontally (or vertically) inside the frame. +.PP +The simplest way to use it is to create a group box with the desired number of columns (or rows) and orientation, and then just create widgets with the group box as parent. +.PP +It is also possible to change the orientation() and number of columns() after construction, or to ignore all the automatic layout support and manage the layout yourself. You can add 'empty' spaces to the group box with addSpace(). +.PP +QGroupBox also lets you set the title() (normally set in the constructor) and the title's alignment(). +.PP +You can change the spacing used by the group box with setInsideMargin() and setInsideSpacing(). To minimize space consumption, you can remove the right, left and bottom edges of the frame with setFlat(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP +See also QButtonGroup, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGroupBox::QGroupBox ( QWidget * parent = 0, const char * name = 0 )" +Constructs a group box widget with no title. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.PP +This constructor does not do automatic layout. +.SH "QGroupBox::QGroupBox ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a group box with the title \fItitle\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.PP +This constructor does not do automatic layout. +.SH "QGroupBox::QGroupBox ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )" +Constructs a group box with no title. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QGroupBox::QGroupBox ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a group box titled \fItitle\fR. Child widgets will be arranged in \fIstrips\fR rows or columns (depending on \fIorientation\fR). +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QGroupBox::~QGroupBox ()" +Destroys the group box. +.SH "void QGroupBox::addSpace ( int size )" +Adds an empty cell at the next free position. If \fIsize\fR is greater than 0, the empty cell takes \fIsize\fR to be its fixed width (if orientation() is Horizontal) or height (if orientation() is Vertical). +.PP +Use this method to separate the widgets in the group box or to skip the next free cell. For performance reasons, call this method after calling setColumnLayout() or by changing the QGroupBox::columns or QGroupBox::orientation properties. It is generally a good idea to call these methods first (if needed at all), and insert the widgets and spaces afterwards. +.SH "int QGroupBox::alignment () const" +Returns the alignment of the group box title. See the "alignment" property for details. +.SH "int QGroupBox::columns () const" +Returns the number of columns or rows (depending on QGroupBox::orientation) in the group box. See the "columns" property for details. +.SH "int QGroupBox::insideMargin () const" +Returns the width of the empty space between the items in the group and the frame of the group. +.PP +Only applies if the group box has a defined orientation. +.PP +The default is usually 11, by may vary depending on the platform and style. +.PP +See also setInsideMargin() and orientation. +.SH "int QGroupBox::insideSpacing () const" +Returns the width of the empty space between each of the items in the group. +.PP +Only applies if the group box has a defined orientation. +.PP +The default is usually 5, by may vary depending on the platform and style. +.PP +See also setInsideSpacing() and orientation. +.SH "bool QGroupBox::isCheckable () const" +Returns TRUE if the group box has a checkbox in its title; otherwise returns FALSE. See the "checkable" property for details. +.SH "bool QGroupBox::isChecked () const" +Returns TRUE if the group box's checkbox is checked; otherwise returns FALSE. See the "checked" property for details. +.SH "bool QGroupBox::isFlat () const" +Returns TRUE if the group box is painted flat or has a frame; otherwise returns FALSE. See the "flat" property for details. +.SH "Orientation QGroupBox::orientation () const" +Returns the group box's orientation. See the "orientation" property for details. +.SH "void QGroupBox::setAlignment ( int )\fC [virtual]\fR" +Sets the alignment of the group box title. See the "alignment" property for details. +.SH "void QGroupBox::setCheckable ( bool b )" +Sets whether the group box has a checkbox in its title to \fIb\fR. See the "checkable" property for details. +.SH "void QGroupBox::setChecked ( bool b )\fC [slot]\fR" +Sets whether the group box's checkbox is checked to \fIb\fR. See the "checked" property for details. +.SH "void QGroupBox::setColumnLayout ( int strips, Orientation direction )\fC [virtual]\fR" +Changes the layout of the group box. This function is only useful in combination with the default constructor that does not take any layout information. This function will put all existing children in the new layout. It is not good Qt programming style to call this function after children have been inserted. Sets the number of columns or rows to be \fIstrips\fR, depending on \fIdirection\fR. +.PP +See also orientation and columns. +.PP +Example: chart/optionsform.cpp. +.SH "void QGroupBox::setColumns ( int )" +Sets the number of columns or rows (depending on QGroupBox::orientation) in the group box. See the "columns" property for details. +.SH "void QGroupBox::setFlat ( bool b )" +Sets whether the group box is painted flat or has a frame to \fIb\fR. See the "flat" property for details. +.SH "void QGroupBox::setInsideMargin ( int m )" +Sets the the width of the inside margin to \fIm\fR pixels. +.PP +See also insideMargin(). +.SH "void QGroupBox::setInsideSpacing ( int s )" +Sets the width of the empty space between each of the items in the group to \fIs\fR pixels. +.PP +See also insideSpacing(). +.SH "void QGroupBox::setOrientation ( Orientation )" +Sets the group box's orientation. See the "orientation" property for details. +.SH "void QGroupBox::setTitle ( const QString & )\fC [virtual]\fR" +Sets the group box title text. See the "title" property for details. +.SH "QString QGroupBox::title () const" +Returns the group box title text. See the "title" property for details. +.SH "void QGroupBox::toggled ( bool on )\fC [signal]\fR" +If the group box has a check box (see isCheckable()) this signal is emitted when the check box is toggled. \fIon\fR is TRUE if the check box is checked; otherwise it is FALSE. +.SS "Property Documentation" +.SH "Alignment alignment" +This property holds the alignment of the group box title. +.PP +The title is always placed on the upper frame line. The horizontal alignment can be specified by the alignment parameter. +.PP +The alignment is one of the following flags: +.TP +AlignAuto aligns the title according to the language, usually to the left. +.TP +AlignLeft aligns the title text to the left. +.TP +AlignRight aligns the title text to the right. +.TP +AlignHCenter aligns the title text centered. +.PP +The default alignment is AlignAuto. +.PP +See also Qt::AlignmentFlags. +.PP +Set this property's value with setAlignment() and get this property's value with alignment(). +.SH "bool checkable" +This property holds whether the group box has a checkbox in its title. +.PP +If this property is TRUE, the group box has a checkbox. If the checkbox is checked (which is the default), the group box's children are enabled. +.PP +setCheckable() controls whether or not the group box has a checkbox, and isCheckable() controls whether the checkbox is checked or not. +.PP +Set this property's value with setCheckable() and get this property's value with isCheckable(). +.SH "bool checked" +This property holds whether the group box's checkbox is checked. +.PP +If the group box has a check box (see isCheckable()), and the check box is checked (see isChecked()), the group box's children are enabled. If the checkbox is unchecked the children are disabled. +.PP +Set this property's value with setChecked() and get this property's value with isChecked(). +.SH "int columns" +This property holds the number of columns or rows (depending on QGroupBox::orientation) in the group box. +.PP +Usually it is not a good idea to set this property because it is slow (it does a complete layout). It is best to set the number of columns directly in the constructor. +.PP +Set this property's value with setColumns() and get this property's value with columns(). +.SH "bool flat" +This property holds whether the group box is painted flat or has a frame. +.PP +By default a group box has a surrounding frame, with the title being placed on the upper frame line. In flat mode the right, left and bottom frame lines are omitted, and only the thin line at the top is drawn. +.PP +See also title. +.PP +Set this property's value with setFlat() and get this property's value with isFlat(). +.SH "Orientation orientation" +This property holds the group box's orientation. +.PP +A horizontal group box arranges it's children in columns, while a vertical group box arranges them in rows. +.PP +Usually it is not a good idea to set this property because it is slow (it does a complete layout). It is better to set the orientation directly in the constructor. +.PP +Set this property's value with setOrientation() and get this property's value with orientation(). +.SH "QString title" +This property holds the group box title text. +.PP +The group box title text will have a focus-change keyboard accelerator if the title contains &, followed by a letter. +.PP +.nf +.br + g->setTitle( "&User information" ); +.br +.fi +This produces "<u>U</u>ser information"; Alt+U moves the keyboard focus to the group box. +.PP +There is no default title text. +.PP +Set this property's value with setTitle() and get this property's value with title(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqgroupbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqgroupbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqguardedptr.3qt b/doc/man/man3/tqguardedptr.3qt new file mode 100644 index 000000000..f646c8b32 --- /dev/null +++ b/doc/man/man3/tqguardedptr.3qt @@ -0,0 +1,148 @@ +'\" t +.TH QGuardedPtr 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 +QGuardedPtr \- Template class that provides guarded pointers to QObjects +.SH SYNOPSIS +\fC#include <ntqguardedptr.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQGuardedPtr\fR ()" +.br +.ti -1c +.BI "\fBQGuardedPtr\fR ( T * p )" +.br +.ti -1c +.BI "\fBQGuardedPtr\fR ( const QGuardedPtr<T> & p )" +.br +.ti -1c +.BI "\fB~QGuardedPtr\fR ()" +.br +.ti -1c +.BI "QGuardedPtr<T> & \fBoperator=\fR ( const QGuardedPtr<T> & p )" +.br +.ti -1c +.BI "QGuardedPtr<T> & \fBoperator=\fR ( T * p )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QGuardedPtr<T> & p ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QGuardedPtr<T> & p ) const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "T * \fBoperator->\fR () const" +.br +.ti -1c +.BI "T & \fBoperator*\fR () const" +.br +.ti -1c +.BI "\fBoperator T *\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QGuardedPtr class is a template class that provides guarded pointers to QObjects. +.PP +A guarded pointer, \fCQGuardedPtr<X>\fR, behaves like a normal C++ pointer \fCX*\fR, except that it is automatically set to 0 when the referenced object is destroyed (unlike normal C++ pointers, which become "dangling pointers" in such cases). \fCX\fR must be a subclass of QObject. +.PP +Guarded pointers are useful whenever you need to store a pointer to a QObject that is owned by someone else and therefore might be destroyed while you still hold a reference to it. You can safely test the pointer for validity. +.PP +Example: +.PP +.nf +.br + QGuardedPtr<QLabel> label = new QLabel( 0, "label" ); +.br + label->setText( "I like guarded pointers" ); +.br +.br + delete (QLabel*) label; // simulate somebody destroying the label +.br +.br + if ( label) +.br + label->show(); +.br + else +.br + tqDebug("The label has been destroyed"); +.br +.fi +.PP +The program will output \fCThe label has been destroyed\fR rather than dereferencing an invalid address in \fClabel->show()\fR. +.PP +The functions and operators available with a QGuardedPtr are the same as those available with a normal unguarded pointer, except the pointer arithmetic operators (++, --, -, and +), which are normally used only with arrays of objects. Use them like normal pointers and you will not need to read this class documentation. +.PP +For creating guarded pointers, you can construct or assign to them from an X* or from another guarded pointer of the same type. You can compare them with each other using operator==() and operator!=(), or test for 0 with isNull(). And you can dereference them using either the \fC*x\fR or the \fCx->member\fR notation. +.PP +A guarded pointer will automatically cast to an X*, so you can freely mix guarded and unguarded pointers. This means that if you have a QGuardedPtr<QWidget>, you can pass it to a function that requires a QWidget*. For this reason, it is of little value to declare functions to take a QGuardedPtr as a parameter; just use normal pointers. Use a QGuardedPtr when you are storing a pointer over time. +.PP +Note again that class \fIX\fR must inherit QObject, or a compilation or link error will result. +.PP +See also Object Model. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QGuardedPtr::QGuardedPtr ()" +Constructs a 0 guarded pointer. +.PP +See also isNull(). +.SH "QGuardedPtr::QGuardedPtr ( T * p )" +Constructs a guarded pointer that points to same object as \fIp\fR points to. +.SH "QGuardedPtr::QGuardedPtr ( const QGuardedPtr<T> & p )" +Copy one guarded pointer from another. The constructed guarded pointer points to the same object that \fIp\fR points to (which may be 0). +.SH "QGuardedPtr::~QGuardedPtr ()" +Destroys the guarded pointer. Just like a normal pointer, destroying a guarded pointer does \fInot\fR destroy the object being pointed to. +.SH "bool QGuardedPtr::isNull () const" +Returns \fCTRUE\fR if the referenced object has been destroyed or if there is no referenced object; otherwise returns FALSE. +.SH "QGuardedPtr::operator T * () const" +Cast operator; implements pointer semantics. Because of this function you can pass a QGuardedPtr<X> to a function where an X* is required. +.SH "bool QGuardedPtr::operator!= ( const QGuardedPtr<T> & p ) const" +Inequality operator; implements pointer semantics, the negation of operator==(). Returns TRUE if \fIp\fR and this guarded pointer are not pointing to the same object; otherwise returns FALSE. +.SH "T & QGuardedPtr::operator* () const" +Dereference operator; implements pointer semantics. Just use this operator as you would with a normal C++ pointer. +.SH "T * QGuardedPtr::operator-> () const" +Overloaded arrow operator; implements pointer semantics. Just use this operator as you would with a normal C++ pointer. +.SH "QGuardedPtr<T> & QGuardedPtr::operator= ( const QGuardedPtr<T> & p )" +Assignment operator. This guarded pointer then points to the same object as \fIp\fR points to. +.SH "QGuardedPtr<T> & QGuardedPtr::operator= ( T * p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assignment operator. This guarded pointer then points to the same object as \fIp\fR points to. +.SH "bool QGuardedPtr::operator== ( const QGuardedPtr<T> & p ) const" +Equality operator; implements traditional pointer semantics. Returns TRUE if both \fIp\fR and this guarded pointer are 0, or if both \fIp\fR and this pointer point to the same object; otherwise returns FALSE. +.PP +See also operator!=(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqguardedptr.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqguardedptr.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhbox.3qt b/doc/man/man3/tqhbox.3qt new file mode 100644 index 000000000..218e4e2fa --- /dev/null +++ b/doc/man/man3/tqhbox.3qt @@ -0,0 +1,92 @@ +'\" t +.TH QHBox 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 +QHBox \- Horizontal geometry management for its child widgets +.SH SYNOPSIS +\fC#include <ntqhbox.h>\fR +.PP +Inherits QFrame. +.PP +Inherited by QVBox. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "void \fBsetSpacing\fR ( int space )" +.br +.ti -1c +.BI "bool \fBsetStretchFactor\fR ( QWidget * w, int stretch )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQHBox\fR ( bool horizontal, QWidget * parent, const char * name, WFlags f = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QHBox widget provides horizontal geometry management for its child widgets. +.PP +All the horizontal box's child widgets will be placed alongside each other and sized according to their sizeHint()s. +.PP +Use setMargin() to add space around the edges, and use setSpacing() to add space between the widgets. Use setStretchFactor() if you want the widgets to be different sizes in proportion to one another. (See Layouts for more information on stretch factors.) +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QHBoxLayout, QVBox, QGrid, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHBox::QHBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs an hbox widget with parent \fIparent\fR, called \fIname\fR. The parent, name and widget flags, \fIf\fR, are passed to the QFrame constructor. +.SH "QHBox::QHBox ( bool horizontal, QWidget * parent, const char * name, WFlags f = 0 )\fC [protected]\fR" +Constructs a horizontal hbox if \fIhorizontal\fR is TRUE, otherwise constructs a vertical hbox (also known as a vbox). +.PP +This constructor is provided for the QVBox class. You should never need to use it directly. +.PP +The \fIparent\fR, \fIname\fR and widget flags, \fIf\fR, are passed to the QFrame constructor. +.SH "void QHBox::setSpacing ( int space )" +Sets the spacing between the child widgets to \fIspace\fR. +.PP +Examples: +.)l i18n/mywidget.cpp, listboxcombo/listboxcombo.cpp, qdir/qdir.cpp, tabdialog/tabdialog.cpp, wizard/wizard.cpp, and xform/xform.cpp. +.SH "bool QHBox::setStretchFactor ( QWidget * w, int stretch )" +Sets the stretch factor of widget \fIw\fR to \fIstretch\fR. Returns TRUE if \fIw\fR is found. Otherwise returns FALSE. +.PP +See also QBoxLayout::setStretchFactor() and Layouts. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqhbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhboxlayout.3qt b/doc/man/man3/tqhboxlayout.3qt new file mode 100644 index 000000000..464bac304 --- /dev/null +++ b/doc/man/man3/tqhboxlayout.3qt @@ -0,0 +1,112 @@ +'\" t +.TH QHBoxLayout 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 +QHBoxLayout \- Lines up widgets horizontally +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherits QBoxLayout. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHBoxLayout\fR ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQHBoxLayout\fR ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQHBoxLayout\fR ( int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QHBoxLayout\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QHBoxLayout class lines up widgets horizontally. +.PP +This class is used to construct horizontal box layout objects. See QBoxLayout for more details. +.PP +The simplest use of the class is like this: +.PP +.nf +.br + QBoxLayout * l = new QHBoxLayout( widget ); +.br + l->setAutoAdd( TRUE ); +.br + new QSomeWidget( widget ); +.br + new QSomeOtherWidget( widget ); +.br + new QAnotherWidget( widget ); +.br +.fi +.PP +or like this: +.PP +.nf +.br + QBoxLayout * l = new QHBoxLayout( widget ); +.br + l->addWidget( existingChildOfWidget ); +.br + l->addWidget( anotherChildOfWidget ); +.br +.fi +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QVBoxLayout, QGridLayout, the Layout overview, Widget Appearance and Style, and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHBoxLayout::QHBoxLayout ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" +Constructs a new top-level horizontal box called \fIname\fR, with parent \fIparent\fR. +.PP +The \fImargin\fR is the number of pixels between the edge of the widget and its managed children. The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1 the value of \fImargin\fR is used for \fIspacing\fR. +.SH "QHBoxLayout::QHBoxLayout ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" +Constructs a new horizontal box called name \fIname\fR and adds it to \fIparentLayout\fR. +.PP +The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QHBoxLayout will inherit its parent's spacing(). +.SH "QHBoxLayout::QHBoxLayout ( int spacing = -1, const char * name = 0 )" +Constructs a new horizontal box called name \fIname\fR. You must add it to another layout. +.PP +The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QHBoxLayout will inherit its parent's spacing(). +.SH "QHBoxLayout::~QHBoxLayout ()" +Destroys this box layout. +.PP +The layout's widgets aren't destroyed. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qhboxlayout.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhboxlayout.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhbuttongroup.3qt b/doc/man/man3/tqhbuttongroup.3qt new file mode 100644 index 000000000..f68ebbf79 --- /dev/null +++ b/doc/man/man3/tqhbuttongroup.3qt @@ -0,0 +1,75 @@ +'\" t +.TH QHButtonGroup 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 +QHButtonGroup \- Organizes QButton widgets in a group with one horizontal row +.SH SYNOPSIS +\fC#include <ntqhbuttongroup.h>\fR +.PP +Inherits QButtonGroup. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHButtonGroup\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQHButtonGroup\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QHButtonGroup\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QHButtonGroup widget organizes QButton widgets in a group with one horizontal row. +.PP +QHButtonGroup is a convenience class that offers a thin layer on top of QButtonGroup. From a layout point of view it is effectively a QHBox that offers a frame with a title and is specifically designed for buttons. From a functionality point of view it is a QButtonGroup. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QVButtonGroup, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHButtonGroup::QHButtonGroup ( QWidget * parent = 0, const char * name = 0 )" +Constructs a horizontal button group with no title. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QHButtonGroup::QHButtonGroup ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a horizontal button group with the title \fItitle\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QHButtonGroup::~QHButtonGroup ()" +Destroys the horizontal button group, deleting its child widgets. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqhbuttongroup.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhbuttongroup.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqheader.3qt b/doc/man/man3/tqheader.3qt new file mode 100644 index 000000000..97a2cc759 --- /dev/null +++ b/doc/man/man3/tqheader.3qt @@ -0,0 +1,584 @@ +'\" t +.TH QHeader 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 +QHeader \- Header row or column, e.g. for tables and listviews +.SH SYNOPSIS +\fC#include <ntqheader.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHeader\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQHeader\fR ( int n, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QHeader\fR ()" +.br +.ti -1c +.BI "int \fBaddLabel\fR ( const QString & s, int size = -1 )" +.br +.ti -1c +.BI "int \fBaddLabel\fR ( const QIconSet & iconset, const QString & s, int size = -1 )" +.br +.ti -1c +.BI "void \fBremoveLabel\fR ( int section )" +.br +.ti -1c +.BI "virtual void \fBsetLabel\fR ( int section, const QString & s, int size = -1 )" +.br +.ti -1c +.BI "virtual void \fBsetLabel\fR ( int section, const QIconSet & iconset, const QString & s, int size = -1 )" +.br +.ti -1c +.BI "QString \fBlabel\fR ( int section ) const" +.br +.ti -1c +.BI "QIconSet * \fBiconSet\fR ( int section ) const" +.br +.ti -1c +.BI "virtual void \fBsetOrientation\fR ( Orientation )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTracking\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBtracking\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetClickEnabled\fR ( bool enable, int section = -1 )" +.br +.ti -1c +.BI "virtual void \fBsetResizeEnabled\fR ( bool enable, int section = -1 )" +.br +.ti -1c +.BI "virtual void \fBsetMovingEnabled\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetStretchEnabled\fR ( bool b, int section )" +.br +.ti -1c +.BI "void \fBsetStretchEnabled\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisClickEnabled\fR ( int section = -1 ) const" +.br +.ti -1c +.BI "bool \fBisResizeEnabled\fR ( int section = -1 ) const" +.br +.ti -1c +.BI "bool \fBisMovingEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBisStretchEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBisStretchEnabled\fR ( int section ) const" +.br +.ti -1c +.BI "void \fBresizeSection\fR ( int section, int s )" +.br +.ti -1c +.BI "int \fBsectionSize\fR ( int section ) const" +.br +.ti -1c +.BI "int \fBsectionPos\fR ( int section ) const" +.br +.ti -1c +.BI "int \fBsectionAt\fR ( int pos ) const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "int \fBheaderWidth\fR () const" +.br +.ti -1c +.BI "QRect \fBsectionRect\fR ( int section ) const" +.br +.ti -1c +.BI "virtual void setCellSize ( int section, int s ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int cellSize ( int i ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int cellPos ( int i ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int cellAt ( int pos ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBoffset\fR () const" +.br +.ti -1c +.BI "int \fBmapToSection\fR ( int index ) const" +.br +.ti -1c +.BI "int \fBmapToIndex\fR ( int section ) const" +.br +.ti -1c +.BI "int mapToLogical ( int a ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int mapToActual ( int l ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBmoveSection\fR ( int section, int toIndex )" +.br +.ti -1c +.BI "virtual void moveCell ( int fromIdx, int toIdx ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setSortIndicator ( int section, bool ascending = TRUE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetSortIndicator\fR ( int section, SortOrder order )" +.br +.ti -1c +.BI "int \fBsortIndicatorSection\fR () const" +.br +.ti -1c +.BI "SortOrder \fBsortIndicatorOrder\fR () const" +.br +.ti -1c +.BI "void \fBadjustHeaderSize\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetOffset\fR ( int pos )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBclicked\fR ( int section )" +.br +.ti -1c +.BI "void \fBpressed\fR ( int section )" +.br +.ti -1c +.BI "void \fBreleased\fR ( int section )" +.br +.ti -1c +.BI "void \fBsizeChange\fR ( int section, int oldSize, int newSize )" +.br +.ti -1c +.BI "void \fBindexChange\fR ( int section, int fromIndex, int toIndex )" +.br +.ti -1c +.BI "void sectionClicked ( int index ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void moved ( int fromIndex, int toIndex ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsectionHandleDoubleClicked\fR ( int section )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBcount\fR - the number of sections in the header \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBmoving\fR - whether the header sections can be moved" +.br +.ti -1c +.BI "int \fBoffset\fR - the header's left-most (or top-most) visible pixel" +.br +.ti -1c +.BI "Orientation \fBorientation\fR - the header's orientation" +.br +.ti -1c +.BI "bool \fBstretching\fR - whether the header sections always take up the full width (or " "height" ") of the header" +.br +.ti -1c +.BI "bool \fBtracking\fR - whether the sizeChange() signal is emitted continuously" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "QRect \fBsRect\fR ( int index )" +.br +.ti -1c +.BI "virtual void \fBpaintSection\fR ( QPainter * p, int index, const QRect & fr )" +.br +.ti -1c +.BI "virtual void \fBpaintSectionLabel\fR ( QPainter * p, int index, const QRect & fr )" +.br +.in -1c +.SH DESCRIPTION +The QHeader class provides a header row or column, e.g. for tables and listviews. +.PP +This class provides a header, e.g. a vertical header to display row labels, or a horizontal header to display column labels. It is used by QTable and QListView for example. +.PP +A header is composed of one or more \fIsections\fR, each of which can display a text label and an iconset. A sort indicator (an arrow) can also be displayed using setSortIndicator(). +.PP +Sections are added with addLabel() and removed with removeLabel(). The label and iconset are set in addLabel() and can be changed later with setLabel(). Use count() to retrieve the number of sections in the header. +.PP +The orientation of the header is set with setOrientation(). If setStretchEnabled() is TRUE, the sections will expand to take up the full width (height for vertical headers) of the header. The user can resize the sections manually if setResizeEnabled() is TRUE. Call adjustHeaderSize() to have the sections resize to occupy the full width (or height). +.PP +A section can be moved with moveSection(). If setMovingEnabled() is TRUE (the default)the user may drag a section from one position to another. If a section is moved, the index positions at which sections were added (with addLabel()), may not be the same after the move. You don't have to worry about this in practice because the QHeader API works in terms of section numbers, so it doesn't matter where a particular section has been moved to. +.PP +If you want the current index position of a section call mapToIndex() giving it the section number. (This is the number returned by the addLabel() call which created the section.) If you want to get the section number of a section at a particular index position call mapToSection() giving it the index number. +.PP +Here's an example to clarify mapToSection() and mapToIndex(): +.PP +<center>.nf +.TS +l - l. Index positions 0 1 2 3 Original section ordering Sect 0 Sect 1 Sect 2 Sect 3 Ordering after the user moves a section Sect 0 Sect 2 Sect 3 +.TE +.fi +</center> +.PP +<center>.nf +.TS +l - l. \fIk\fR mapToSection(\fIk\fR) mapToIndex(\fIk\fR) 0 0 0 1 2 3 2 3 1 3 1 +.TE +.fi +</center> +.PP +In the example above, if we wanted to find out which section is at index position 3 we'd call mapToSection(3) and get a section number of 1 since section 1 was moved. Similarly, if we wanted to know which index position section 2 occupied we'd call mapToIndex(2) and get an index of 1. +.PP +QHeader provides the clicked(), pressed() and released() signals. If the user changes the size of a section, the sizeChange() signal is emitted. If you want to have a sizeChange() signal emitted continuously whilst the user is resizing (rather than just after the resizing is finished), use setTracking(). If the user moves a section the indexChange() signal is emitted. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QListView, QTable, and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHeader::QHeader ( QWidget * parent = 0, const char * name = 0 )" +Constructs a horizontal header called \fIname\fR, with parent \fIparent\fR. +.SH "QHeader::QHeader ( int n, QWidget * parent = 0, const char * name = 0 )" +Constructs a horizontal header called \fIname\fR, with \fIn\fR sections and parent \fIparent\fR. +.SH "QHeader::~QHeader ()" +Destroys the header and all its sections. +.SH "int QHeader::addLabel ( const QString & s, int size = -1 )" +Adds a new section with label text \fIs\fR. Returns the index position where the section was added (at the right for horizontal headers, at the bottom for vertical headers). The section's width is set to \fIsize\fR. If \fIsize\fR < 0, an appropriate size for the text \fIs\fR is chosen. +.SH "int QHeader::addLabel ( const QIconSet & iconset, const QString & s, int size = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a new section with iconset \fIiconset\fR and label text \fIs\fR. Returns the index position where the section was added (at the right for horizontal headers, at the bottom for vertical headers). The section's width is set to \fIsize\fR, unless size is negative in which case the size is calculated taking account of the size of the text. +.SH "void QHeader::adjustHeaderSize ()" +Adjusts the size of the sections to fit the size of the header as completely as possible. Only sections for which isStretchEnabled() is TRUE will be resized. +.SH "int QHeader::cellAt ( int pos ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use sectionAt() instead. +.PP +Returns the index at which the section is displayed, which contains \fIpos\fR in widget coordinates, or -1 if \fIpos\fR is outside the header sections. +.SH "int QHeader::cellPos ( int i ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use sectionPos() instead. +.PP +Returns the position in pixels of the section that is displayed at the index \fIi\fR. The position is measured from the start of the header. +.SH "int QHeader::cellSize ( int i ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use sectionSize() instead. +.PP +Returns the size in pixels of the section that is displayed at the index \fIi\fR. +.SH "void QHeader::clicked ( int section )\fC [signal]\fR" +If isClickEnabled() is TRUE, this signal is emitted when the user clicks section \fIsection\fR. +.PP +See also pressed() and released(). +.SH "int QHeader::count () const" +Returns the number of sections in the header. See the "count" property for details. +.SH "int QHeader::headerWidth () const" +Returns the total width of all the header columns. +.SH "QIconSet * QHeader::iconSet ( int section ) const" +Returns the icon set for section \fIsection\fR. If the section does not exist, 0 is returned. +.SH "void QHeader::indexChange ( int section, int fromIndex, int toIndex )\fC [signal]\fR" +This signal is emitted when the user moves section \fIsection\fR from index position \fIfromIndex\fR, to index position \fItoIndex\fR. +.SH "bool QHeader::isClickEnabled ( int section = -1 ) const" +Returns TRUE if section \fIsection\fR is clickable; otherwise returns FALSE. +.PP +If \fIsection\fR is out of range (negative or larger than count() - 1): returns TRUE if all sections are clickable; otherwise returns FALSE. +.PP +See also setClickEnabled(). +.SH "bool QHeader::isMovingEnabled () const" +Returns TRUE if the header sections can be moved; otherwise returns FALSE. See the "moving" property for details. +.SH "bool QHeader::isResizeEnabled ( int section = -1 ) const" +Returns TRUE if section \fIsection\fR is resizeable; otherwise returns FALSE. +.PP +If \fIsection\fR is -1 then this function applies to all sections, i.e. returns TRUE if all sections are resizeable; otherwise returns FALSE. +.PP +See also setResizeEnabled(). +.SH "bool QHeader::isStretchEnabled () const" +Returns TRUE if the header sections always take up the full width (or height) of the header; otherwise returns FALSE. See the "stretching" property for details. +.SH "bool QHeader::isStretchEnabled ( int section ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if section \fIsection\fR will resize to take up the full width (or height) of the header; otherwise returns FALSE. If at least one section has stretch enabled the sections will always take up the full width of the header. +.PP +See also setStretchEnabled(). +.SH "QString QHeader::label ( int section ) const" +Returns the text for section \fIsection\fR. If the section does not exist, a QString::null is returned. +.PP +Example: helpsystem/tooltip.cpp. +.SH "int QHeader::mapToActual ( int l ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use mapToIndex() instead. +.PP +Translates from logical index \fIl\fR to actual index (index at which the section \fIl\fR is displayed) . Returns -1 if \fIl\fR is outside the legal range. +.PP +See also mapToLogical(). +.SH "int QHeader::mapToIndex ( int section ) const" +Returns the index position corresponding to the specified \fIsection\fR number. +.PP +\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping exposed by this function will not reflect the order of the headers in the table; i.e., QTable does not call moveSection() to move sections but handles move operations internally. +.PP +See also mapToSection(). +.SH "int QHeader::mapToLogical ( int a ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use mapToSection() instead. +.PP +Translates from actual index \fIa\fR (index at which the section is displayed) to logical index of the section. Returns -1 if \fIa\fR is outside the legal range. +.PP +See also mapToActual(). +.SH "int QHeader::mapToSection ( int index ) const" +Returns the number of the section that corresponds to the specified \fIindex\fR. +.PP +\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping exposed by this function will not reflect the order of the headers in the table; i.e., QTable does not call moveSection() to move sections but handles move operations internally. +.PP +See also mapToIndex(). +.SH "void QHeader::moveCell ( int fromIdx, int toIdx )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use moveSection() instead. +.PP +Moves the section that is currently displayed at index \fIfromIdx\fR to index \fItoIdx\fR. +.SH "void QHeader::moveSection ( int section, int toIndex )" +Moves section \fIsection\fR to index position \fItoIndex\fR. +.SH "void QHeader::moved ( int fromIndex, int toIndex )\fC [signal]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use indexChange() instead. +.PP +This signal is emitted when the user has moved the section which is displayed at the index \fIfromIndex\fR to the index \fItoIndex\fR. +.SH "int QHeader::offset () const" +Returns the header's left-most (or top-most) visible pixel. See the "offset" property for details. +.SH "Orientation QHeader::orientation () const" +Returns the header's orientation. See the "orientation" property for details. +.SH "void QHeader::paintSection ( QPainter * p, int index, const QRect & fr )\fC [virtual protected]\fR" +Paints the section at position \fIindex\fR, inside rectangle \fIfr\fR (which uses widget coordinates) using painter \fIp\fR. +.PP +Calls paintSectionLabel(). +.SH "void QHeader::paintSectionLabel ( QPainter * p, int index, const QRect & fr )\fC [virtual protected]\fR" +Paints the label of the section at position \fIindex\fR, inside rectangle \fIfr\fR (which uses widget coordinates) using painter \fIp\fR. +.PP +Called by paintSection() +.SH "void QHeader::pressed ( int section )\fC [signal]\fR" +This signal is emitted when the user presses section \fIsection\fR down. +.PP +See also released(). +.SH "void QHeader::released ( int section )\fC [signal]\fR" +This signal is emitted when section \fIsection\fR is released. +.PP +See also pressed(). +.SH "void QHeader::removeLabel ( int section )" +Removes section \fIsection\fR. If the section does not exist, nothing happens. +.SH "void QHeader::resizeSection ( int section, int s )" +Resizes section \fIsection\fR to \fIs\fR pixels wide (or high). +.SH "QRect QHeader::sRect ( int index )\fC [protected]\fR" +Returns the rectangle covered by the section at index \fIindex\fR. +.SH "int QHeader::sectionAt ( int pos ) const" +Returns the index of the section which contains the position \fIpos\fR given in pixels from the left (or top). +.PP +See also offset. +.PP +Example: helpsystem/tooltip.cpp. +.SH "void QHeader::sectionClicked ( int index )\fC [signal]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use clicked() instead. +.PP +This signal is emitted when a part of the header is clicked. \fIindex\fR is the index at which the section is displayed. +.PP +In a list view this signal would typically be connected to a slot that sorts the specified column (or row). +.SH "void QHeader::sectionHandleDoubleClicked ( int section )\fC [signal]\fR" +This signal is emitted when the user doubleclicks on the edge (handle) of section \fIsection\fR. +.SH "int QHeader::sectionPos ( int section ) const" +Returns the position (in pixels) at which the \fIsection\fR starts. +.PP +See also offset. +.SH "QRect QHeader::sectionRect ( int section ) const" +Returns the rectangle covered by section \fIsection\fR. +.PP +Example: helpsystem/tooltip.cpp. +.SH "int QHeader::sectionSize ( int section ) const" +Returns the width (or height) of the \fIsection\fR in pixels. +.SH "void QHeader::setCellSize ( int section, int s )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use resizeSection() instead. +.PP +Sets the size of the section \fIsection\fR to \fIs\fR pixels. +.PP +\fBWarning:\fR does not repaint or send out signals +.SH "void QHeader::setClickEnabled ( bool enable, int section = -1 )\fC [virtual]\fR" +If \fIenable\fR is TRUE, any clicks on section \fIsection\fR will result in clicked() signals being emitted; otherwise the section will ignore clicks. +.PP +If \fIsection\fR is -1 (the default) then the \fIenable\fR value is set for all existing sections and will be applied to any new sections that are added. +.PP +See also moving and setResizeEnabled(). +.SH "void QHeader::setLabel ( int section, const QString & s, int size = -1 )\fC [virtual]\fR" +Sets the text of section \fIsection\fR to \fIs\fR. The section's width is set to \fIsize\fR if \fIsize\fR >= 0; otherwise it is left unchanged. Any icon set that has been set for this section remains unchanged. +.PP +If the section does not exist, nothing happens. +.PP +Examples: +.)l chart/setdataform.cpp and table/small-table-demo/main.cpp. +.SH "void QHeader::setLabel ( int section, const QIconSet & iconset, const QString & s, int size = -1 )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the icon for section \fIsection\fR to \fIiconset\fR and the text to \fIs\fR. The section's width is set to \fIsize\fR if \fIsize\fR >= 0; otherwise it is left unchanged. +.PP +If the section does not exist, nothing happens. +.SH "void QHeader::setMovingEnabled ( bool )\fC [virtual]\fR" +Sets whether the header sections can be moved. See the "moving" property for details. +.SH "void QHeader::setOffset ( int pos )\fC [virtual slot]\fR" +Sets the header's left-most (or top-most) visible pixel to \fIpos\fR. See the "offset" property for details. +.SH "void QHeader::setOrientation ( Orientation )\fC [virtual]\fR" +Sets the header's orientation. See the "orientation" property for details. +.SH "void QHeader::setResizeEnabled ( bool enable, int section = -1 )\fC [virtual]\fR" +If \fIenable\fR is TRUE the user may resize section \fIsection\fR; otherwise the section may not be manually resized. +.PP +If \fIsection\fR is negative (the default) then the \fIenable\fR value is set for all existing sections and will be applied to any new sections that are added. Example: +.PP +.nf +.br + // Allow resizing of all current and future sections +.br + header->setResizeEnabled(TRUE); +.br + // Disable resizing of section 3, (the fourth section added) +.br + header->setResizeEnabled(FALSE, 3); +.br +.fi +.PP +If the user resizes a section, a sizeChange() signal is emitted. +.PP +See also moving, setClickEnabled(), and tracking. +.SH "void QHeader::setSortIndicator ( int section, SortOrder order )" +Sets a sort indicator onto the specified \fIsection\fR. The indicator's \fIorder\fR is either Ascending or Descending. +.PP +Only one section can show a sort indicator at any one time. If you don't want any section to show a sort indicator pass a \fIsection\fR number of -1. +.PP +See also sortIndicatorSection() and sortIndicatorOrder(). +.SH "void QHeader::setSortIndicator ( int section, bool ascending = TRUE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use the other overload instead. +.SH "void QHeader::setStretchEnabled ( bool b, int section )\fC [virtual]\fR" +If \fIb\fR is TRUE, section \fIsection\fR will be resized when the header is resized, so that the sections take up the full width (or height for vertical headers) of the header; otherwise section \fIsection\fR will be set to be unstretchable and will not resize when the header is resized. +.PP +If \fIsection\fR is -1, and if \fIb\fR is TRUE, then all sections will be resized equally when the header is resized so that they take up the full width (or height for vertical headers) of the header; otherwise all the sections will be set to be unstretchable and will not resize when the header is resized. +.PP +See also adjustHeaderSize(). +.SH "void QHeader::setStretchEnabled ( bool b )" +Sets whether the header sections always take up the full width (or height) of the header to \fIb\fR. See the "stretching" property for details. +.SH "void QHeader::setTracking ( bool enable )\fC [virtual]\fR" +Sets whether the sizeChange() signal is emitted continuously to \fIenable\fR. See the "tracking" property for details. +.SH "void QHeader::sizeChange ( int section, int oldSize, int newSize )\fC [signal]\fR" +This signal is emitted when the user has changed the size of a \fIsection\fR from \fIoldSize\fR to \fInewSize\fR. This signal is typically connected to a slot that repaints the table or list that contains the header. +.SH "SortOrder QHeader::sortIndicatorOrder () const" +Returns the implied sort order of the QHeaders sort indicator. +.PP +See also setSortIndicator() and sortIndicatorSection(). +.SH "int QHeader::sortIndicatorSection () const" +Returns the section showing the sort indicator or -1 if there is no sort indicator. +.PP +See also setSortIndicator() and sortIndicatorOrder(). +.SH "bool QHeader::tracking () const" +Returns TRUE if the sizeChange() signal is emitted continuously; otherwise returns FALSE. See the "tracking" property for details. +.SS "Property Documentation" +.SH "int count" +This property holds the number of sections in the header. +.PP +Get this property's value with count(). +.SH "bool moving" +This property holds whether the header sections can be moved. +.PP +If this property is TRUE (the default) the user can move sections. If the user moves a section the indexChange() signal is emitted. +.PP +See also setClickEnabled() and setResizeEnabled(). +.PP +Set this property's value with setMovingEnabled() and get this property's value with isMovingEnabled(). +.SH "int offset" +This property holds the header's left-most (or top-most) visible pixel. +.PP +Setting this property will scroll the header so that \fIoffset\fR becomes the left-most (or top-most for vertical headers) visible pixel. +.PP +Set this property's value with setOffset() and get this property's value with offset(). +.SH "Orientation orientation" +This property holds the header's orientation. +.PP +The orientation is either Vertical or Horizontal (the default). +.PP +Call setOrientation() before adding labels if you don't provide a size parameter otherwise the sizes will be incorrect. +.PP +Set this property's value with setOrientation() and get this property's value with orientation(). +.SH "bool stretching" +This property holds whether the header sections always take up the full width (or height) of the header. +.PP +Set this property's value with setStretchEnabled() and get this property's value with isStretchEnabled(). +.SH "bool tracking" +This property holds whether the sizeChange() signal is emitted continuously. +.PP +If tracking is on, the sizeChange() signal is emitted continuously while the mouse is moved (i.e. when the header is resized), otherwise it is only emitted when the mouse button is released at the end of resizing. +.PP +Tracking defaults to FALSE. +.PP +Set this property's value with setTracking() and get this property's value with tracking(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqheader.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqheader.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhebrewcodec.3qt b/doc/man/man3/tqhebrewcodec.3qt new file mode 100644 index 000000000..2d6a4dd8a --- /dev/null +++ b/doc/man/man3/tqhebrewcodec.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QHebrewCodec 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 +QHebrewCodec \- Conversion to and from visually ordered Hebrew +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqrtlcodec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual const char * \fBmimeName\fR () const" +.br +.ti -1c +.BI "virtual QCString \fBfromUnicode\fR ( const QString & uc, int & lenInOut ) const" +.br +.in -1c +.SH DESCRIPTION +The QHebrewCodec class provides conversion to and from visually ordered Hebrew. +.PP +Hebrew as a semitic language is written from right to left. Because older computer systems couldn't handle reordering a string so that the first letter appears on the right, many older documents were encoded in visual order, so that the first letter of a line is the rightmost one in the string. +.PP +In contrast to this, Unicode defines characters to be in logical order (the order you would read the string). This codec tries to convert visually ordered Hebrew (8859-8) to Unicode. This might not always work perfectly, because reversing the \fIbidi\fR (bi-directional) algorithm that transforms from logical to visual order is non-trivial. +.PP +Transformation from Unicode to visual Hebrew (8859-8) is done using the bidi algorithm in Qt, and will produce correct results, so long as the codec is given the text a whole paragraph at a time. Places where newlines are supposed to go can be indicated by a newline character ('\\n'). Note that these newline characters change the reordering behaviour of the algorithm, since the bidi reordering only takes place within one line of text, whereas line breaks are determined in visual order. +.PP +Visually ordered Hebrew is still used quite often in some places, mainly in email communication (since most email programs still don't understand logically ordered Hebrew) and on web pages. The use on web pages is rapidly decreasing, due to the availability of browsers that correctly support logically ordered Hebrew. +.PP +This codec has the name "iso8859-8". If you don't want any bidi reordering to happen during conversion, use the "iso8859-8-i" codec, which assumes logical order for the 8-bit string. +.PP +See also Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QCString QHebrewCodec::fromUnicode ( const QString & uc, int & lenInOut ) const\fC [virtual]\fR" +Transforms the logically ordered QString, \fIuc\fR, into a visually ordered string in the 8859-8 encoding. Qt's bidi algorithm is used to perform this task. Note that newline characters affect the reordering, since reordering is done on a line by line basis. +.PP +The algorithm is designed to work on whole paragraphs of text, so processing a line at a time may produce incorrect results. This approach is taken because the reordering of the contents of a particular line in a paragraph may depend on the previous line in the same paragraph. +.PP +Some encodings (for example Japanese or UTF-8) are multibyte (so one input character is mapped to two output characters). The \fIlenInOut\fR argument specifies the number of QChars that should be converted and is set to the number of characters returned. +.PP +Reimplemented from QTextCodec. +.SH "const char * QHebrewCodec::mimeName () const\fC [virtual]\fR" +Returns the codec's mime name. +.PP +Reimplemented from QTextCodec. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qhebrewcodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhebrewcodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhgroupbox.3qt b/doc/man/man3/tqhgroupbox.3qt new file mode 100644 index 000000000..32d945285 --- /dev/null +++ b/doc/man/man3/tqhgroupbox.3qt @@ -0,0 +1,75 @@ +'\" t +.TH QHGroupBox 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 +QHGroupBox \- Organizes widgets in a group with one horizontal row +.SH SYNOPSIS +\fC#include <ntqhgroupbox.h>\fR +.PP +Inherits QGroupBox. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHGroupBox\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQHGroupBox\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QHGroupBox\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QHGroupBox widget organizes widgets in a group with one horizontal row. +.PP +QHGroupBox is a convenience class that offers a thin layer on top of QGroupBox. Think of it as a QHBox that offers a frame with a title. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QVGroupBox, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHGroupBox::QHGroupBox ( QWidget * parent = 0, const char * name = 0 )" +Constructs a horizontal group box with no title. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QHGroupBox::QHGroupBox ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a horizontal group box with the title \fItitle\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QWidget constructor. +.SH "QHGroupBox::~QHGroupBox ()" +Destroys the horizontal group box, deleting its child widgets. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqhgroupbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhgroupbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhideevent.3qt b/doc/man/man3/tqhideevent.3qt new file mode 100644 index 000000000..1175b7de4 --- /dev/null +++ b/doc/man/man3/tqhideevent.3qt @@ -0,0 +1,57 @@ +'\" t +.TH QHideEvent 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 +QHideEvent \- Event which is sent after a widget is hidden +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHideEvent\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QHideEvent class provides an event which is sent after a widget is hidden. +.PP +This event is sent just before QWidget::hide() returns, and also when a top-level window has been hidden (iconified) by the user. +.PP +If spontaneous() is TRUE the event originated outside the application, i.e. the user hid the window using the window manager controls, either by iconifying the window or by switching to another virtual desktop where the window isn't visible. The window will become hidden but not withdrawn. If the window was iconified, QWidget::isMinimized() returns TRUE. +.PP +See also QShowEvent and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHideEvent::QHideEvent ()" +Constructs a QHideEvent. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qhideevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhideevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhostaddress.3qt b/doc/man/man3/tqhostaddress.3qt new file mode 100644 index 000000000..b3e0f87f6 --- /dev/null +++ b/doc/man/man3/tqhostaddress.3qt @@ -0,0 +1,188 @@ +'\" t +.TH QHostAddress 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 +QHostAddress \- IP address +.SH SYNOPSIS +\fC#include <ntqhostaddress.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHostAddress\fR ()" +.br +.ti -1c +.BI "\fBQHostAddress\fR ( TQ_UINT32 ip4Addr )" +.br +.ti -1c +.BI "\fBQHostAddress\fR ( TQ_UINT8 * ip6Addr )" +.br +.ti -1c +.BI "\fBQHostAddress\fR ( const Q_IPV6ADDR & ip6Addr )" +.br +.ti -1c +.BI "\fBQHostAddress\fR ( const QHostAddress & address )" +.br +.ti -1c +.BI "virtual \fB~QHostAddress\fR ()" +.br +.ti -1c +.BI "QHostAddress & \fBoperator=\fR ( const QHostAddress & address )" +.br +.ti -1c +.BI "void \fBsetAddress\fR ( TQ_UINT32 ip4Addr )" +.br +.ti -1c +.BI "void \fBsetAddress\fR ( TQ_UINT8 * ip6Addr )" +.br +.ti -1c +.BI "bool \fBsetAddress\fR ( const QString & address )" +.br +.ti -1c +.BI "bool isIp4Addr () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "TQ_UINT32 ip4Addr () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBisIPv4Address\fR () const" +.br +.ti -1c +.BI "TQ_UINT32 \fBtoIPv4Address\fR () const" +.br +.ti -1c +.BI "bool \fBisIPv6Address\fR () const" +.br +.ti -1c +.BI "Q_IPV6ADDR \fBtoIPv6Address\fR () const" +.br +.ti -1c +.BI "QString \fBtoString\fR () const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QHostAddress & other ) const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QHostAddress class provides an IP address. +.PP +This class contains an IP address in a platform and protocol independent manner. It stores both IPv4 and IPv6 addresses in a way that you can easily access on any platform. +.PP +QHostAddress is normally used with the classes QSocket, QServerSocket and QSocketDevice to set up a server or to connect to a host. +.PP +Host addresses may be set with setAddress() and retrieved with ip4Addr() or toString(). +.PP +See also QSocket, QServerSocket, QSocketDevice, and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHostAddress::QHostAddress ()" +Creates a host address object with the IP address 0.0.0.0. +.SH "QHostAddress::QHostAddress ( TQ_UINT32 ip4Addr )" +Creates a host address object for the IPv4 address \fIip4Addr\fR. +.SH "QHostAddress::QHostAddress ( TQ_UINT8 * ip6Addr )" +Creates a host address object with the specified IPv6 address. +.PP +\fIip6Addr\fR must be a 16 byte array in network byte order (high-order byte first). +.SH "QHostAddress::QHostAddress ( const Q_IPV6ADDR & ip6Addr )" +Creates a host address object with the IPv6 address, \fIip6Addr\fR. +.SH "QHostAddress::QHostAddress ( const QHostAddress & address )" +Creates a copy of \fIaddress\fR. +.SH "QHostAddress::~QHostAddress ()\fC [virtual]\fR" +Destroys the host address object. +.SH "TQ_UINT32 QHostAddress::ip4Addr () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use toIPv4Address() instead. +.SH "bool QHostAddress::isIPv4Address () const" +Returns TRUE if the host address represents an IPv4 address; otherwise returns FALSE. +.SH "bool QHostAddress::isIPv6Address () const" +Returns TRUE if the host address represents an IPv6 address; otherwise returns FALSE. +.SH "bool QHostAddress::isIp4Addr () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use isIPv4Address() instead. +.SH "bool QHostAddress::isNull () const" +Returns TRUE if this host address is null (INADDR_ANY or in6addr_any). The default constructor creates a null address, and that address isn't valid for any particular host or interface. +.SH "QHostAddress & QHostAddress::operator= ( const QHostAddress & address )" +Assigns another host address object \fIaddress\fR to this object and returns a reference to this object. +.SH "bool QHostAddress::operator== ( const QHostAddress & other ) const" +Returns TRUE if this host address is the same as \fIother\fR; otherwise returns FALSE. +.SH "void QHostAddress::setAddress ( TQ_UINT32 ip4Addr )" +Set the IPv4 address specified by \fIip4Addr\fR. +.SH "void QHostAddress::setAddress ( TQ_UINT8 * ip6Addr )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Set the IPv6 address specified by \fIip6Addr\fR. +.PP +\fIip6Addr\fR must be a 16 byte array in network byte order (high-order byte first). +.SH "bool QHostAddress::setAddress ( const QString & address )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the IPv4 or IPv6 address specified by the string representation \fIaddress\fR (e.g. "127.0.0.1"). Returns TRUE and sets the address if the address was successfully parsed; otherwise returns FALSE and leaves the address unchanged. +.SH "TQ_UINT32 QHostAddress::toIPv4Address () const" +Returns the IPv4 address as a number. +.PP +For example, if the address is 127.0.0.1, the returned value is 2130706433 (i.e. 0x7f000001). +.PP +This value is only valid when isIp4Addr() returns TRUE. +.PP +See also toString(). +.SH "Q_IPV6ADDR QHostAddress::toIPv6Address () const" +Returns the IPv6 address as a Q_IPV6ADDR structure. The structure consists of 16 unsigned characters. +.PP +.nf +.br + Q_IPV6ADDR addr = hostAddr.ip6Addr(); +.br + // addr.c[] contains 16 unsigned characters +.br +.br + for (int i = 0; i < 16; ++i) { +.br + // process addr.c[i] +.br + } +.br +.fi +.PP +This value is only valid when isIPv6Address() returns TRUE. +.PP +See also toString(). +.SH "QString QHostAddress::toString () const" +Returns the address as a string. +.PP +For example, if the address is the IPv4 address 127.0.0.1, the returned string is "127.0.0.1". +.PP +See also ip4Addr(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqhostaddress.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhostaddress.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhttp.3qt b/doc/man/man3/tqhttp.3qt new file mode 100644 index 000000000..885e8bac2 --- /dev/null +++ b/doc/man/man3/tqhttp.3qt @@ -0,0 +1,542 @@ +'\" t +.TH QHttp 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 +QHttp \- Implementation of the HTTP protocol +.SH SYNOPSIS +\fC#include <ntqhttp.h>\fR +.PP +Inherits QNetworkProtocol. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHttp\fR ()" +.br +.ti -1c +.BI "\fBQHttp\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQHttp\fR ( const QString & hostname, TQ_UINT16 port = 80, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QHttp\fR ()" +.br +.ti -1c +.BI "enum \fBState\fR { Unconnected, HostLookup, Connecting, Sending, Reading, Connected, Closing }" +.br +.ti -1c +.BI "enum \fBError\fR { NoError, UnknownError, HostNotFound, ConnectionRefused, UnexpectedClose, InvalidResponseHeader, WrongContentLength, Aborted }" +.br +.ti -1c +.BI "int \fBsetHost\fR ( const QString & hostname, TQ_UINT16 port = 80 )" +.br +.ti -1c +.BI "int \fBget\fR ( const QString & path, QIODevice * to = 0 )" +.br +.ti -1c +.BI "int \fBpost\fR ( const QString & path, QIODevice * data, QIODevice * to = 0 )" +.br +.ti -1c +.BI "int \fBpost\fR ( const QString & path, const QByteArray & data, QIODevice * to = 0 )" +.br +.ti -1c +.BI "int \fBhead\fR ( const QString & path )" +.br +.ti -1c +.BI "int \fBrequest\fR ( const QHttpRequestHeader & header, QIODevice * data = 0, QIODevice * to = 0 )" +.br +.ti -1c +.BI "int \fBrequest\fR ( const QHttpRequestHeader & header, const QByteArray & data, QIODevice * to = 0 )" +.br +.ti -1c +.BI "int \fBcloseConnection\fR ()" +.br +.ti -1c +.BI "TQ_ULONG \fBbytesAvailable\fR () const" +.br +.ti -1c +.BI "TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" +.br +.ti -1c +.BI "QByteArray \fBreadAll\fR ()" +.br +.ti -1c +.BI "int \fBcurrentId\fR () const" +.br +.ti -1c +.BI "QIODevice * \fBcurrentSourceDevice\fR () const" +.br +.ti -1c +.BI "QIODevice * \fBcurrentDestinationDevice\fR () const" +.br +.ti -1c +.BI "QHttpRequestHeader \fBcurrentRequest\fR () const" +.br +.ti -1c +.BI "bool \fBhasPendingRequests\fR () const" +.br +.ti -1c +.BI "void \fBclearPendingRequests\fR ()" +.br +.ti -1c +.BI "State \fBstate\fR () const" +.br +.ti -1c +.BI "Error \fBerror\fR () const" +.br +.ti -1c +.BI "QString \fBerrorString\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBabort\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBstateChanged\fR ( int state )" +.br +.ti -1c +.BI "void \fBresponseHeaderReceived\fR ( const QHttpResponseHeader & resp )" +.br +.ti -1c +.BI "void \fBreadyRead\fR ( const QHttpResponseHeader & resp )" +.br +.ti -1c +.BI "void \fBdataSendProgress\fR ( int done, int total )" +.br +.ti -1c +.BI "void \fBdataReadProgress\fR ( int done, int total )" +.br +.ti -1c +.BI "void \fBrequestStarted\fR ( int id )" +.br +.ti -1c +.BI "void \fBrequestFinished\fR ( int id, bool error )" +.br +.ti -1c +.BI "void \fBdone\fR ( bool error )" +.br +.in -1c +.SH DESCRIPTION +The QHttp class provides an implementation of the HTTP protocol. +.PP +This class provides two different interfaces: one is the QNetworkProtocol interface that allows you to use HTTP through the QUrlOperator abstraction. The other is a direct interface to HTTP that allows you to have more control over the requests and that allows you to access the response header fields. +.PP +Don't mix the two interfaces, since the behavior is not well-defined. +.PP +If you want to use QHttp with the QNetworkProtocol interface, you do not use it directly, but rather through a QUrlOperator, for example: +.PP +.nf +.br + QUrlOperator op( "http://www.trolltech.com" ); +.br + op.get( "index.html" ); +.br +.fi +.PP +This code will only work if the QHttp class is registered; to register the class, you must call tqInitNetworkProtocols() before using a QUrlOperator with HTTP. +.PP +The QNetworkProtocol interface for HTTP only supports the operations operationGet() and operationPut(), i.e. QUrlOperator::get() and QUrlOperator::put(), if you use it with a QUrlOperator. +.PP +The rest of this descrption describes the direct interface to HTTP. +.PP +The class works asynchronously, so there are no blocking functions. If an operation cannot be executed immediately, the function will still return straight away and the operation will be scheduled for later execution. The results of scheduled operations are reported via signals. This approach depends on the event loop being in operation. +.PP +The operations that can be scheduled (they are called "requests" in the rest of the documentation) are the following: setHost(), get(), post(), head() and request(). +.PP +All of these requests return a unique identifier that allows you to keep track of the request that is currently executed. When the execution of a request starts, the requestStarted() signal with the identifier is emitted and when the request is finished, the requestFinished() signal is emitted with the identifier and a bool that indicates if the request finished with an error. +.PP +To make an HTTP request you must set up suitable HTTP headers. The following example demonstrates, how to request the main HTML page from the Trolltech home page (i.e. the URL http://www.trolltech.com/index.html): +.PP +.nf +.br + QHttpRequestHeader header( "GET", "/index.html" ); +.br + header.setValue( "Host", "www.trolltech.com" ); +.br + http->setHost( "www.trolltech.com" ); +.br + http->request( header ); +.br +.fi +.PP +For the common HTTP requests \fCGET\fR, \fCPOST\fR and \fCHEAD\fR, QHttp provides the convenience functions get(), post() and head(). They already use a reasonable header and if you don't have to set special header fields, they are easier to use. The above example can also be written as: +.PP +.nf +.br + http->setHost( "www.trolltech.com" ); // id == 1 +.br + http->get( "/index.html" ); // id == 2 +.br +.fi +.PP +For this example the following sequence of signals is emitted (with small variations, depending on network traffic, etc.): +.PP +.nf +.br + requestStarted( 1 ) +.br + requestFinished( 1, FALSE ) +.br +.br + requestStarted( 2 ) +.br + stateChanged( Connecting ) +.br + stateChanged( Sending ) +.br + dataSendProgress( 77, 77 ) +.br + stateChanged( Reading ) +.br + responseHeaderReceived( responseheader ) +.br + dataReadProgress( 5388, 0 ) +.br + readyRead( responseheader ) +.br + dataReadProgress( 18300, 0 ) +.br + readyRead( responseheader ) +.br + stateChanged( Connected ) +.br + requestFinished( 2, FALSE ) +.br +.br + done( FALSE ) +.br +.br + stateChanged( Closing ) +.br + stateChanged( Unconnected ) +.br +.fi +.PP +The dataSendProgress() and dataReadProgress() signals in the above example are useful if you want to show a progressbar to inform the user about the progress of the download. The second argument is the total size of data. In certain cases it is not possible to know the total amount in advance, in which case the second argument is 0. (If you connect to a QProgressBar a total of 0 results in a busy indicator.) +.PP +When the response header is read, it is reported with the responseHeaderReceived() signal. +.PP +The readyRead() signal tells you that there is data ready to be read. The amount of data can then be queried with the bytesAvailable() function and it can be read with the readBlock() or readAll() functions. +.PP +If an error occurs during the execution of one of the commands in a sequence of commands, all the pending commands (i.e. scheduled, but not yet executed commands) are cleared and no signals are emitted for them. +.PP +For example, if you have the following sequence of reqeusts +.PP +.nf +.br + http->setHost( "www.foo.bar" ); // id == 1 +.br + http->get( "/index.html" ); // id == 2 +.br + http->post( "register.html", data ); // id == 3 +.br +.fi +.PP +and the get() request fails because the host lookup fails, then the post() request is never executed and the signals would look like this: +.PP +.nf +.br + requestStarted( 1 ) +.br + requestFinished( 1, FALSE ) +.br +.br + requestStarted( 2 ) +.br + stateChanged( HostLookup ) +.br + requestFinished( 2, TRUE ) +.br +.br + done( TRUE ) +.br +.br + stateChanged( Unconnected ) +.br +.fi +.PP +You can then get details about the error with the error() and errorString() functions. Note that only unexpected behaviour, like network failure is considered as an error. If the server response contains an error status, like a 404 response, this is reported as a normal response case. So you should always check the status code of the response header. +.PP +The functions currentId() and currentRequest() provide more information about the currently executing request. +.PP +The functions hasPendingRequests() and clearPendingRequests() allow you to query and clear the list of pending requests. +.PP +See also Qt Network Documentation, QNetworkProtocol, QUrlOperator, QFtp, and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QHttp::Error" +This enum identifies the error that occurred. +.TP +\fCQHttp::NoError\fR - No error occurred. +.TP +\fCQHttp::HostNotFound\fR - The host name lookup failed. +.TP +\fCQHttp::ConnectionRefused\fR - The server refused the connection. +.TP +\fCQHttp::UnexpectedClose\fR - The server closed the connection unexpectedly. +.TP +\fCQHttp::InvalidResponseHeader\fR - The server sent an invalid response header. +.TP +\fCQHttp::WrongContentLength\fR - The client could not read the content correctly because an error with respect to the content length occurred. +.TP +\fCQHttp::Aborted\fR - The request was aborted with abort(). +.TP +\fCQHttp::UnknownError\fR - An error other than those specified above occurred. +.PP +See also error(). +.SH "QHttp::State" +This enum is used to specify the state the client is in: +.TP +\fCQHttp::Unconnected\fR - There is no connection to the host. +.TP +\fCQHttp::HostLookup\fR - A host name lookup is in progress. +.TP +\fCQHttp::Connecting\fR - An attempt to connect to the host is in progress. +.TP +\fCQHttp::Sending\fR - The client is sending its request to the server. +.TP +\fCQHttp::Reading\fR - The client's request has been sent and the client is reading the server's response. +.TP +\fCQHttp::Connected\fR - The connection to the host is open, but the client is neither sending a request, nor waiting for a response. +.TP +\fCQHttp::Closing\fR - The connection is closing down, but is not yet closed. (The state will be Unconnected when the connection is closed.) +.PP +See also stateChanged() and state(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHttp::QHttp ()" +Constructs a QHttp object. +.SH "QHttp::QHttp ( QObject * parent, const char * name = 0 )" +Constructs a QHttp object. The parameters \fIparent\fR and \fIname\fR are passed on to the QObject constructor. +.SH "QHttp::QHttp ( const QString & hostname, TQ_UINT16 port = 80, QObject * parent = 0, const char * name = 0 )" +Constructs a QHttp object. Subsequent requests are done by connecting to the server \fIhostname\fR on port \fIport\fR. The parameters \fIparent\fR and \fIname\fR are passed on to the QObject constructor. +.PP +See also setHost(). +.SH "QHttp::~QHttp ()\fC [virtual]\fR" +Destroys the QHttp object. If there is an open connection, it is closed. +.SH "void QHttp::abort ()\fC [slot]\fR" +Aborts the current request and deletes all scheduled requests. +.PP +For the current request, the requestFinished() signal with the \fCerror\fR argument \fCTRUE\fR is emitted. For all other requests that are affected by the abort(), no signals are emitted. +.PP +Since this slot also deletes the scheduled requests, there are no requests left and the done() signal is emitted (with the \fCerror\fR argument \fCTRUE\fR). +.PP +See also clearPendingRequests(). +.SH "TQ_ULONG QHttp::bytesAvailable () const" +Returns the number of bytes that can be read from the response content at the moment. +.PP +See also get(), post(), request(), readyRead(), readBlock(), and readAll(). +.SH "void QHttp::clearPendingRequests ()" +Deletes all pending requests from the list of scheduled requests. This does not affect the request that is being executed. If you want to stop this this as well, use abort(). +.PP +See also hasPendingRequests() and abort(). +.SH "int QHttp::closeConnection ()" +Closes the connection; this is useful if you have a keep-alive connection and want to close it. +.PP +For the requests issued with get(), post() and head(), QHttp sets the connection to be keep-alive. You can also do this using the header you pass to the request() function. QHttp only closes the connection to the HTTP server if the response header requires it to do so. +.PP +The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). +.PP +When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. +.PP +If you want to close the connection immediately, you have to use abort() instead. +.PP +See also stateChanged(), abort(), requestStarted(), requestFinished(), and done(). +.SH "QIODevice * QHttp::currentDestinationDevice () const" +Returns the QIODevice pointer that is used as to store the data of the HTTP request being executed. If there is no current request or if the request does not store the data to an IO device, this function returns 0. +.PP +This function can be used to delete the QIODevice in the slot connected to the requestFinished() signal. +.PP +See also get(), post(), and request(). +.SH "int QHttp::currentId () const" +Returns the identifier of the HTTP request being executed or 0 if there is no request being executed (i.e. they've all finished). +.PP +See also currentRequest(). +.SH "QHttpRequestHeader QHttp::currentRequest () const" +Returns the request header of the HTTP request being executed. If the request is one issued by setHost() or closeConnection(), it returns an invalid request header, i.e. QHttpRequestHeader::isValid() returns FALSE. +.PP +See also currentId(). +.SH "QIODevice * QHttp::currentSourceDevice () const" +Returns the QIODevice pointer that is used as the data source of the HTTP request being executed. If there is no current request or if the request does not use an IO device as the data source, this function returns 0. +.PP +This function can be used to delete the QIODevice in the slot connected to the requestFinished() signal. +.PP +See also currentDestinationDevice(), post(), and request(). +.SH "void QHttp::dataReadProgress ( int done, int total )\fC [signal]\fR" +This signal is emitted when this object reads data from a HTTP server to indicate the current progress of the download. +.PP +\fIdone\fR is the amount of data that has already arrived and \fItotal\fR is the total amount of data. It is possible that the total amount of data that should be transferred cannot be determined, in which case \fItotal\fR is 0.(If you connect to a QProgressBar, the progress bar shows a busy indicator if the total is 0). +.PP +\fBWarning:\fR \fIdone\fR and \fItotal\fR are not necessarily the size in bytes, since for large files these values might need to be" scaled" to avoid overflow. +.PP +See also dataSendProgress(), get(), post(), request(), and QProgressBar::progress. +.SH "void QHttp::dataSendProgress ( int done, int total )\fC [signal]\fR" +This signal is emitted when this object sends data to a HTTP server to inform it about the progress of the upload. +.PP +\fIdone\fR is the amount of data that has already arrived and \fItotal\fR is the total amount of data. It is possible that the total amount of data that should be transferred cannot be determined, in which case \fItotal\fR is 0.(If you connect to a QProgressBar, the progress bar shows a busy indicator if the total is 0). +.PP +\fBWarning:\fR \fIdone\fR and \fItotal\fR are not necessarily the size in bytes, since for large files these values might need to be" scaled" to avoid overflow. +.PP +See also dataReadProgress(), post(), request(), and QProgressBar::progress. +.SH "void QHttp::done ( bool error )\fC [signal]\fR" +This signal is emitted when the last pending request has finished; (it is emitted after the last request's requestFinished() signal). \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. +.PP +See also requestFinished(), error(), and errorString(). +.SH "Error QHttp::error () const" +Returns the last error that occurred. This is useful to find out what happened when receiving a requestFinished() or a done() signal with the \fCerror\fR argument \fCTRUE\fR. +.PP +If you start a new request, the error status is reset to NoError. +.SH "QString QHttp::errorString () const" +Returns a human-readable description of the last error that occurred. This is useful to present a error message to the user when receiving a requestFinished() or a done() signal with the \fCerror\fR argument \fCTRUE\fR. +.SH "int QHttp::get ( const QString & path, QIODevice * to = 0 )" +Sends a get request for \fIpath\fR to the server set by setHost() or as specified in the constructor. +.PP +\fIpath\fR must be an absolute path like \fC/index.html\fR or an absolute URI like http://www.trolltech.com/index.html. +.PP +If the IO device \fIto\fR is 0 the readyRead() signal is emitted every time new content data is available to read. +.PP +If the IO device \fIto\fR is not 0, the content data of the response is written directly to the device. Make sure that the \fIto\fR pointer is valid for the duration of the operation (it is safe to delete it when the requestFinished() signal is emitted). +.PP +The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). +.PP +When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. +.PP +See also setHost(), post(), head(), request(), requestStarted(), requestFinished(), and done(). +.SH "bool QHttp::hasPendingRequests () const" +Returns TRUE if there are any requests scheduled that have not yet been executed; otherwise returns FALSE. +.PP +The request that is being executed is \fInot\fR considered as a scheduled request. +.PP +See also clearPendingRequests(), currentId(), and currentRequest(). +.SH "int QHttp::head ( const QString & path )" +Sends a header request for \fIpath\fR to the server set by setHost() or as specified in the constructor. +.PP +\fIpath\fR must be an absolute path like \fC/index.html\fR or an absolute URI like http://www.trolltech.com/index.html. +.PP +The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). +.PP +When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. +.PP +See also setHost(), get(), post(), request(), requestStarted(), requestFinished(), and done(). +.SH "int QHttp::post ( const QString & path, QIODevice * data, QIODevice * to = 0 )" +Sends a post request for \fIpath\fR to the server set by setHost() or as specified in the constructor. +.PP +\fIpath\fR must be an absolute path like \fC/index.html\fR or an absolute URI like http://www.trolltech.com/index.html. +.PP +The incoming data comes via the \fIdata\fR IO device. +.PP +If the IO device \fIto\fR is 0 the readyRead() signal is emitted every time new content data is available to read. +.PP +If the IO device \fIto\fR is not 0, the content data of the response is written directly to the device. Make sure that the \fIto\fR pointer is valid for the duration of the operation (it is safe to delete it when the requestFinished() signal is emitted). +.PP +The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). +.PP +When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. +.PP +See also setHost(), get(), head(), request(), requestStarted(), requestFinished(), and done(). +.SH "int QHttp::post ( const QString & path, const QByteArray & data, QIODevice * to = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIdata\fR is used as the content data of the HTTP request. +.SH "QByteArray QHttp::readAll ()" +Reads all the bytes from the response content and returns them. +.PP +See also get(), post(), request(), readyRead(), bytesAvailable(), and readBlock(). +.SH "TQ_LONG QHttp::readBlock ( char * data, TQ_ULONG maxlen )" +Reads \fImaxlen\fR bytes from the response content into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. +.PP +See also get(), post(), request(), readyRead(), bytesAvailable(), and readAll(). +.SH "void QHttp::readyRead ( const QHttpResponseHeader & resp )\fC [signal]\fR" +This signal is emitted when there is new response data to read. +.PP +If you specified a device in the request where the data should be written to, then this signal is \fInot\fR emitted; instead the data is written directly to the device. +.PP +The response header is passed in \fIresp\fR. +.PP +You can read the data with the readAll() or readBlock() functions +.PP +This signal is useful if you want to process the data in chunks as soon as it becomes available. If you are only interested in the complete data, just connect to the requestFinished() signal and read the data then instead. +.PP +See also get(), post(), request(), readAll(), readBlock(), and bytesAvailable(). +.SH "int QHttp::request ( const QHttpRequestHeader & header, QIODevice * data = 0, QIODevice * to = 0 )" +Sends a request to the server set by setHost() or as specified in the constructor. Uses the \fIheader\fR as the HTTP request header. You are responsible for setting up a header that is appropriate for your request. +.PP +The incoming data comes via the \fIdata\fR IO device. +.PP +If the IO device \fIto\fR is 0 the readyRead() signal is emitted every time new content data is available to read. +.PP +If the IO device \fIto\fR is not 0, the content data of the response is written directly to the device. Make sure that the \fIto\fR pointer is valid for the duration of the operation (it is safe to delete it when the requestFinished() signal is emitted). +.PP +The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). +.PP +When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. +.PP +See also setHost(), get(), post(), head(), requestStarted(), requestFinished(), and done(). +.SH "int QHttp::request ( const QHttpRequestHeader & header, const QByteArray & data, QIODevice * to = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIdata\fR is used as the content data of the HTTP request. +.SH "void QHttp::requestFinished ( int id, bool error )\fC [signal]\fR" +This signal is emitted when processing the request identified by \fIid\fR has finished. \fIerror\fR is TRUE if an error occurred during the processing; otherwise \fIerror\fR is FALSE. +.PP +See also requestStarted(), done(), error(), and errorString(). +.SH "void QHttp::requestStarted ( int id )\fC [signal]\fR" +This signal is emitted when processing the request identified by \fIid\fR starts. +.PP +See also requestFinished() and done(). +.SH "void QHttp::responseHeaderReceived ( const QHttpResponseHeader & resp )\fC [signal]\fR" +This signal is emitted when the HTTP header of a server response is available. The header is passed in \fIresp\fR. +.PP +See also get(), post(), head(), request(), and readyRead(). +.SH "int QHttp::setHost ( const QString & hostname, TQ_UINT16 port = 80 )" +Sets the HTTP server that is used for requests to \fIhostname\fR on port \fIport\fR. +.PP +The function does not block and returns immediately. The request is scheduled, and its execution is performed asynchronously. The function returns a unique identifier which is passed by requestStarted() and requestFinished(). +.PP +When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. +.PP +See also get(), post(), head(), request(), requestStarted(), requestFinished(), and done(). +.SH "State QHttp::state () const" +Returns the current state of the object. When the state changes, the stateChanged() signal is emitted. +.PP +See also State and stateChanged(). +.SH "void QHttp::stateChanged ( int state )\fC [signal]\fR" +This signal is emitted when the state of the QHttp object changes. The argument \fIstate\fR is the new state of the connection; it is one of the State values. +.PP +This usually happens when a request is started, but it can also happen when the server closes the connection or when a call to closeConnection() succeeded. +.PP +See also get(), post(), head(), request(), closeConnection(), state(), and State. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqhttp.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhttp.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhttpheader.3qt b/doc/man/man3/tqhttpheader.3qt new file mode 100644 index 000000000..e1e0e4548 --- /dev/null +++ b/doc/man/man3/tqhttpheader.3qt @@ -0,0 +1,210 @@ +'\" t +.TH QHttpHeader 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 +QHttpHeader \- Header information for HTTP +.SH SYNOPSIS +\fC#include <ntqhttp.h>\fR +.PP +Inherited by QHttpResponseHeader and QHttpRequestHeader. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHttpHeader\fR ()" +.br +.ti -1c +.BI "\fBQHttpHeader\fR ( const QHttpHeader & header )" +.br +.ti -1c +.BI "\fBQHttpHeader\fR ( const QString & str )" +.br +.ti -1c +.BI "virtual \fB~QHttpHeader\fR ()" +.br +.ti -1c +.BI "QHttpHeader & \fBoperator=\fR ( const QHttpHeader & h )" +.br +.ti -1c +.BI "QString \fBvalue\fR ( const QString & key ) const" +.br +.ti -1c +.BI "void \fBsetValue\fR ( const QString & key, const QString & value )" +.br +.ti -1c +.BI "void \fBremoveValue\fR ( const QString & key )" +.br +.ti -1c +.BI "QStringList \fBkeys\fR () const" +.br +.ti -1c +.BI "bool \fBhasKey\fR ( const QString & key ) const" +.br +.ti -1c +.BI "bool \fBhasContentLength\fR () const" +.br +.ti -1c +.BI "uint \fBcontentLength\fR () const" +.br +.ti -1c +.BI "void \fBsetContentLength\fR ( int len )" +.br +.ti -1c +.BI "bool \fBhasContentType\fR () const" +.br +.ti -1c +.BI "QString \fBcontentType\fR () const" +.br +.ti -1c +.BI "void \fBsetContentType\fR ( const QString & type )" +.br +.ti -1c +.BI "virtual QString \fBtoString\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "virtual int \fBmajorVersion\fR () const = 0" +.br +.ti -1c +.BI "virtual int \fBminorVersion\fR () const = 0" +.br +.in -1c +.SH DESCRIPTION +The QHttpHeader class contains header information for HTTP. +.PP +In most cases you should use the more specialized derivatives of this class, QHttpResponseHeader and QHttpRequestHeader, rather than directly using QHttpHeader. +.PP +QHttpHeader provides the HTTP header fields. A HTTP header field consists of a name followed by a colon, a single space, and the field value. (See RFC 1945.) Field names are case-insensitive. A typical header field looks like this: +.PP +.nf +.br + content-type: text/html +.br +.fi +.PP +In the API the header field name is called the "key" and the content is called the "value". You can get and set a header field's value by using its key with value() and setValue(), e.g. +.PP +.nf +.br + header.setValue( "content-type", "text/html" ); +.br + QString contentType = header.value( "content-type" ); +.br +.fi +.PP +Some fields are so common that getters and setters are provided for them as a convenient alternative to using value() and setValue(), e.g. contentLength() and contentType(), setContentLength() and setContentType(). +.PP +Each header key has a \fIsingle\fR value associated with it. If you set the value for a key which already exists the previous value will be discarded. +.PP +See also QHttpRequestHeader, QHttpResponseHeader, and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHttpHeader::QHttpHeader ()" +Constructs an empty HTTP header. +.SH "QHttpHeader::QHttpHeader ( const QHttpHeader & header )" +Constructs a copy of \fIheader\fR. +.SH "QHttpHeader::QHttpHeader ( const QString & str )" +Constructs a HTTP header for \fIstr\fR. +.PP +This constructor parses the string \fIstr\fR for header fields and adds this information. The \fIstr\fR should consist of one or more" \\r\\n" delimited lines; each of these lines should have the format key, colon, space, value. +.SH "QHttpHeader::~QHttpHeader ()\fC [virtual]\fR" +Destructor. +.SH "uint QHttpHeader::contentLength () const" +Returns the value of the special HTTP header field \fCcontent-length\fR. +.PP +See also setContentLength() and hasContentLength(). +.SH "QString QHttpHeader::contentType () const" +Returns the value of the special HTTP header field \fCcontent-type\fR. +.PP +See also setContentType() and hasContentType(). +.SH "bool QHttpHeader::hasContentLength () const" +Returns TRUE if the header has an entry for the special HTTP header field \fCcontent-length\fR; otherwise returns FALSE. +.PP +See also contentLength() and setContentLength(). +.SH "bool QHttpHeader::hasContentType () const" +Returns TRUE if the header has an entry for the the special HTTP header field \fCcontent-type\fR; otherwise returns FALSE. +.PP +See also contentType() and setContentType(). +.SH "bool QHttpHeader::hasKey ( const QString & key ) const" +Returns TRUE if the HTTP header has an entry with the given \fIkey\fR; otherwise returns FALSE. +.PP +See also value(), setValue(), and keys(). +.SH "bool QHttpHeader::isValid () const" +Returns TRUE if the HTTP header is valid; otherwise returns FALSE. +.PP +A QHttpHeader is invalid if it was created by parsing a malformed string. +.SH "QStringList QHttpHeader::keys () const" +Returns a list of the keys in the HTTP header. +.PP +See also hasKey(). +.SH "int QHttpHeader::majorVersion () const\fC [pure virtual]\fR" +Returns the major protocol-version of the HTTP header. +.PP +Reimplemented in QHttpResponseHeader and QHttpRequestHeader. +.SH "int QHttpHeader::minorVersion () const\fC [pure virtual]\fR" +Returns the minor protocol-version of the HTTP header. +.PP +Reimplemented in QHttpResponseHeader and QHttpRequestHeader. +.SH "QHttpHeader & QHttpHeader::operator= ( const QHttpHeader & h )" +Assigns \fIh\fR and returns a reference to this http header. +.SH "void QHttpHeader::removeValue ( const QString & key )" +Removes the entry with the key \fIkey\fR from the HTTP header. +.PP +See also value() and setValue(). +.SH "void QHttpHeader::setContentLength ( int len )" +Sets the value of the special HTTP header field \fCcontent-length\fR to \fIlen\fR. +.PP +See also contentLength() and hasContentLength(). +.SH "void QHttpHeader::setContentType ( const QString & type )" +Sets the value of the special HTTP header field \fCcontent-type\fR to \fItype\fR. +.PP +See also contentType() and hasContentType(). +.PP +Example: network/archivesearch/archivedialog.ui.h. +.SH "void QHttpHeader::setValue ( const QString & key, const QString & value )" +Sets the value of the entry with the \fIkey\fR to \fIvalue\fR. +.PP +If no entry with \fIkey\fR exists, a new entry with the given \fIkey\fR and \fIvalue\fR is created. If an entry with the \fIkey\fR already exists, its value is discarded and replaced with the given \fIvalue\fR. +.PP +See also value(), hasKey(), and removeValue(). +.PP +Example: network/archivesearch/archivedialog.ui.h. +.SH "QString QHttpHeader::toString () const\fC [virtual]\fR" +Returns a string representation of the HTTP header. +.PP +The string is suitable for use by the constructor that takes a QString. It consists of lines with the format: key, colon, space, value, "\\r\\n". +.SH "QString QHttpHeader::value ( const QString & key ) const" +Returns the value for the entry with the given \fIkey\fR. If no entry has this \fIkey\fR, an empty string is returned. +.PP +See also setValue(), removeValue(), hasKey(), and keys(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qhttpheader.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhttpheader.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhttprequestheader.3qt b/doc/man/man3/tqhttprequestheader.3qt new file mode 100644 index 000000000..1c925f3cc --- /dev/null +++ b/doc/man/man3/tqhttprequestheader.3qt @@ -0,0 +1,137 @@ +'\" t +.TH QHttpRequestHeader 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 +QHttpRequestHeader \- Request header information for HTTP +.SH SYNOPSIS +\fC#include <ntqhttp.h>\fR +.PP +Inherits QHttpHeader. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHttpRequestHeader\fR ()" +.br +.ti -1c +.BI "\fBQHttpRequestHeader\fR ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" +.br +.ti -1c +.BI "\fBQHttpRequestHeader\fR ( const QHttpRequestHeader & header )" +.br +.ti -1c +.BI "\fBQHttpRequestHeader\fR ( const QString & str )" +.br +.ti -1c +.BI "void \fBsetRequest\fR ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" +.br +.ti -1c +.BI "QString \fBmethod\fR () const" +.br +.ti -1c +.BI "QString \fBpath\fR () const" +.br +.ti -1c +.BI "virtual int \fBmajorVersion\fR () const" +.br +.ti -1c +.BI "virtual int \fBminorVersion\fR () const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "QString \fBvalue\fR ( const QString & key ) const" +.br +.ti -1c +.BI "void \fBsetValue\fR ( const QString & key, const QString & value )" +.br +.in -1c +.SH DESCRIPTION +The QHttpRequestHeader class contains request header information for HTTP. +.PP +This class is used in the QHttp class to report the header information if the client requests something from the server. +.PP +HTTP requests have a method which describes the request's action. The most common requests are "GET" and "POST". In addition to the request method the header also includes a request-URI to specify the location for the method to use. +.PP +The method, request-URI and protocol-version can be set using a constructor or later using setRequest(). The values can be obtained using method(), path(), majorVersion() and minorVersion(). +.PP +This class is a QHttpHeader subclass so that class's functions, e.g. setValue(), value(), etc. are also available. +.PP +See also QHttpResponseHeader, QHttp, and Input/Output and Networking. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHttpRequestHeader::QHttpRequestHeader ()" +Constructs an empty HTTP request header. +.SH "QHttpRequestHeader::QHttpRequestHeader ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" +Constructs a HTTP request header for the method \fImethod\fR, the request-URI \fIpath\fR and the protocol-version \fImajorVer\fR and \fIminorVer\fR. +.SH "QHttpRequestHeader::QHttpRequestHeader ( const QHttpRequestHeader & header )" +Constructs a copy of \fIheader\fR. +.SH "QHttpRequestHeader::QHttpRequestHeader ( const QString & str )" +Constructs a HTTP request header from the string \fIstr\fR. The \fIstr\fR should consist of one or more "\\r\\n" delimited lines; the first line should be the request-line (format: method, space, request-URI, space HTTP-version); each of the remaining lines should have the format key, colon, space, value. +.SH "int QHttpRequestHeader::majorVersion () const\fC [virtual]\fR" +Returns the major protocol-version of the HTTP request header. +.PP +See also minorVersion(), method(), path(), and setRequest(). +.PP +Reimplemented from QHttpHeader. +.SH "QString QHttpRequestHeader::method () const" +Returns the method of the HTTP request header. +.PP +See also path(), majorVersion(), minorVersion(), and setRequest(). +.SH "int QHttpRequestHeader::minorVersion () const\fC [virtual]\fR" +Returns the minor protocol-version of the HTTP request header. +.PP +See also majorVersion(), method(), path(), and setRequest(). +.PP +Reimplemented from QHttpHeader. +.SH "QString QHttpRequestHeader::path () const" +Returns the request-URI of the HTTP request header. +.PP +See also method(), majorVersion(), minorVersion(), and setRequest(). +.SH "void QHttpRequestHeader::setRequest ( const QString & method, const QString & path, int majorVer = 1, int minorVer = 1 )" +This function sets the request method to \fImethod\fR, the request-URI to \fIpath\fR and the protocol-version to \fImajorVer\fR and \fIminorVer\fR. +.PP +See also method(), path(), majorVersion(), and minorVersion(). +.SH "void QHttpHeader::setValue ( const QString & key, const QString & value )" +Sets the value of the entry with the \fIkey\fR to \fIvalue\fR. +.PP +If no entry with \fIkey\fR exists, a new entry with the given \fIkey\fR and \fIvalue\fR is created. If an entry with the \fIkey\fR already exists, its value is discarded and replaced with the given \fIvalue\fR. +.PP +See also value(), hasKey(), and removeValue(). +.PP +Example: network/archivesearch/archivedialog.ui.h. +.SH "QString QHttpHeader::value ( const QString & key ) const" +Returns the value for the entry with the given \fIkey\fR. If no entry has this \fIkey\fR, an empty string is returned. +.PP +See also setValue(), removeValue(), hasKey(), and keys(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qhttprequestheader.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhttprequestheader.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqhttpresponseheader.3qt b/doc/man/man3/tqhttpresponseheader.3qt new file mode 100644 index 000000000..000e3351b --- /dev/null +++ b/doc/man/man3/tqhttpresponseheader.3qt @@ -0,0 +1,94 @@ +'\" t +.TH QHttpResponseHeader 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 +QHttpResponseHeader \- Response header information for HTTP +.SH SYNOPSIS +\fC#include <ntqhttp.h>\fR +.PP +Inherits QHttpHeader. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQHttpResponseHeader\fR ()" +.br +.ti -1c +.BI "\fBQHttpResponseHeader\fR ( const QHttpResponseHeader & header )" +.br +.ti -1c +.BI "int \fBstatusCode\fR () const" +.br +.ti -1c +.BI "QString \fBreasonPhrase\fR () const" +.br +.ti -1c +.BI "virtual int \fBmajorVersion\fR () const" +.br +.ti -1c +.BI "virtual int \fBminorVersion\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QHttpResponseHeader class contains response header information for HTTP. +.PP +This class is used by the QHttp class to report the header information that the client received from the server. +.PP +HTTP responses have a status code that indicates the status of the response. This code is a 3-digit integer result code (for details see to RFC 1945). In addition to the status code, you can also specify a human-readable text that describes the reason for the code ("reason phrase"). This class allows you to get the status code and the reason phrase. +.PP +See also QHttpRequestHeader, QHttp, and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QHttpResponseHeader::QHttpResponseHeader ()" +Constructs an empty HTTP response header. +.SH "QHttpResponseHeader::QHttpResponseHeader ( const QHttpResponseHeader & header )" +Constructs a copy of \fIheader\fR. +.SH "int QHttpResponseHeader::majorVersion () const\fC [virtual]\fR" +Returns the major protocol-version of the HTTP response header. +.PP +See also minorVersion(), statusCode(), and reasonPhrase(). +.PP +Reimplemented from QHttpHeader. +.SH "int QHttpResponseHeader::minorVersion () const\fC [virtual]\fR" +Returns the minor protocol-version of the HTTP response header. +.PP +See also majorVersion(), statusCode(), and reasonPhrase(). +.PP +Reimplemented from QHttpHeader. +.SH "QString QHttpResponseHeader::reasonPhrase () const" +Returns the reason phrase of the HTTP response header. +.PP +See also statusCode(), majorVersion(), and minorVersion(). +.SH "int QHttpResponseHeader::statusCode () const" +Returns the status code of the HTTP response header. +.PP +See also reasonPhrase(), majorVersion(), and minorVersion(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qhttpresponseheader.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqhttpresponseheader.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqicondrag.3qt b/doc/man/man3/tqicondrag.3qt new file mode 100644 index 000000000..7525d532b --- /dev/null +++ b/doc/man/man3/tqicondrag.3qt @@ -0,0 +1,96 @@ +'\" t +.TH QIconDrag 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 +QIconDrag \- Supports drag and drop operations within a QIconView +.SH SYNOPSIS +\fC#include <ntqiconview.h>\fR +.PP +Inherits QDragObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIconDrag\fR ( QWidget * dragSource, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QIconDrag\fR ()" +.br +.ti -1c +.BI "void \fBappend\fR ( const QIconDragItem & i, const QRect & pr, const QRect & tr )" +.br +.ti -1c +.BI "virtual QByteArray \fBencodedData\fR ( const char * mime ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBcanDecode\fR ( QMimeSource * e )" +.br +.in -1c +.SH DESCRIPTION +The QIconDrag class supports drag and drop operations within a QIconView. +.PP +A QIconDrag object is used to maintain information about the positions of dragged items and the data associated with the dragged items. QIconViews are able to use this information to paint the dragged items in the correct positions. Internally QIconDrag stores the data associated with drag items in QIconDragItem objects. +.PP +If you want to use the extended drag-and-drop functionality of QIconView, create a QIconDrag object in a reimplementation of QIconView::dragObject(). Then create a QIconDragItem for each item which should be dragged, set the data it represents with QIconDragItem::setData(), and add each QIconDragItem to the drag object using append(). +.PP +The data in QIconDragItems is stored in a QByteArray and is mime-typed (see QMimeSource and the Drag and Drop overview). If you want to use your own mime-types derive a class from QIconDrag and reimplement format(), encodedData() and canDecode(). +.PP +The fileiconview example program demonstrates the use of the QIconDrag class including subclassing and reimplementing dragObject(), format(), encodedData() and canDecode(). See the files \fCqt/examples/fileiconview/qfileiconview.h\fR and \fCqt/examples/fileiconview/qfileiconview.cpp\fR. +.PP +See also QMimeSource::format() and Drag And Drop Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIconDrag::QIconDrag ( QWidget * dragSource, const char * name = 0 )" +Constructs a drag object called \fIname\fR, which is a child of \fIdragSource\fR. +.PP +Note that the drag object will be deleted when \fIdragSource\fR is deleted. +.SH "QIconDrag::~QIconDrag ()\fC [virtual]\fR" +Destructor. +.SH "void QIconDrag::append ( const QIconDragItem & i, const QRect & pr, const QRect & tr )" +Append the QIconDragItem, \fIi\fR, to the QIconDrag object's list of items. You must also supply the geometry of the pixmap, \fIpr\fR, and the textual caption, \fItr\fR. +.PP +See also QIconDragItem. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QIconDrag::canDecode ( QMimeSource * e )\fC [static]\fR" +Returns TRUE if \fIe\fR can be decoded by the QIconDrag, otherwise return FALSE. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QByteArray QIconDrag::encodedData ( const char * mime ) const\fC [virtual]\fR" +Returns the encoded data of the drag object if \fImime\fR is application/x-qiconlist. +.PP +Example: fileiconview/qfileiconview.cpp. +.PP +Reimplemented from QMimeSource. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qicondrag.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqicondrag.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqicondragevent.3qt b/doc/man/man3/tqicondragevent.3qt new file mode 100644 index 000000000..33ec3aa4a --- /dev/null +++ b/doc/man/man3/tqicondragevent.3qt @@ -0,0 +1,86 @@ +'\" t +.TH QIconDragEvent 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 +QIconDragEvent \- Signals that a main icon drag has begun +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIconDragEvent\fR ()" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QIconDragEvent class signals that a main icon drag has begun. +.PP +Icon drag events are sent to widgets when the main icon of a window has been dragged away. On Mac OS X this is fired when the proxy icon of a window is dragged off titlebar, in response to this event is is normal to begin using drag and drop. +.PP +See also Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIconDragEvent::QIconDragEvent ()" +Constructs an icon drag event object with the accept parameter flag set to FALSE. +.PP +See also accept(). +.SH "void QIconDragEvent::accept ()" +Sets the accept flag of the icon drag event object. +.PP +Setting the accept flag indicates that the receiver of this event has started a drag and drop oeration. +.PP +The accept flag is \fInot\fR set by default. +.PP +See also ignore() and QWidget::hide(). +.SH "void QIconDragEvent::ignore ()" +Clears the accept flag of the icon drag object. +.PP +Clearing the accept flag indicates that the receiver of this event has not handled the icon drag as a result other events can be sent. +.PP +The icon drag event is constructed with the accept flag cleared. +.PP +See also accept(). +.SH "bool QIconDragEvent::isAccepted () const" +Returns TRUE if the receiver of the event has started a drag and drop operation; otherwise returns FALSE. +.PP +See also accept() and ignore(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qicondragevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqicondragevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqicondragitem.3qt b/doc/man/man3/tqicondragitem.3qt new file mode 100644 index 000000000..daa5a70d6 --- /dev/null +++ b/doc/man/man3/tqicondragitem.3qt @@ -0,0 +1,76 @@ +'\" t +.TH QIconDragItem 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 +QIconDragItem \- Encapsulates a drag item +.SH SYNOPSIS +\fC#include <ntqiconview.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIconDragItem\fR ()" +.br +.ti -1c +.BI "virtual \fB~QIconDragItem\fR ()" +.br +.ti -1c +.BI "virtual QByteArray \fBdata\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetData\fR ( const QByteArray & d )" +.br +.in -1c +.SH DESCRIPTION +The QIconDragItem class encapsulates a drag item. +.PP +The QIconDrag class uses a list of QIconDragItems to support drag and drop operations. +.PP +In practice a QIconDragItem object (or an object of a class derived from QIconDragItem) is created for each icon view item which is dragged. Each of these QIconDragItems is stored in a QIconDrag object. +.PP +See QIconView::dragObject() for more information. +.PP +See the fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp examples. +.PP +See also Drag And Drop Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIconDragItem::QIconDragItem ()" +Constructs a QIconDragItem with no data. +.SH "QIconDragItem::~QIconDragItem ()\fC [virtual]\fR" +Destructor. +.SH "QByteArray QIconDragItem::data () const\fC [virtual]\fR" +Returns the data contained in the QIconDragItem. +.SH "void QIconDragItem::setData ( const QByteArray & d )\fC [virtual]\fR" +Sets the data for the QIconDragItem to the data stored in the QByteArray \fId\fR. +.PP +Example: fileiconview/qfileiconview.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qicondragitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqicondragitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqiconfactory.3qt b/doc/man/man3/tqiconfactory.3qt new file mode 100644 index 000000000..8eca46a8e --- /dev/null +++ b/doc/man/man3/tqiconfactory.3qt @@ -0,0 +1,98 @@ +'\" t +.TH QIconFactory 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 +QIconFactory \- Used to create pixmaps for a QIconSet +.SH SYNOPSIS +\fC#include <ntqiconset.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIconFactory\fR ()" +.br +.ti -1c +.BI "virtual \fB~QIconFactory\fR ()" +.br +.ti -1c +.BI "virtual QPixmap * \fBcreatePixmap\fR ( const QIconSet & iconSet, QIconSet::Size size, QIconSet::Mode mode, QIconSet::State state )" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool autoDelete )" +.br +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QIconFactory * \fBdefaultFactory\fR ()" +.br +.ti -1c +.BI "void \fBinstallDefaultFactory\fR ( QIconFactory * factory )" +.br +.in -1c +.SH DESCRIPTION +The QIconFactory class is used to create pixmaps for a QIconSet. +.PP +By reimplementing createPixmap(), you can override QIconSet's default algorithm for computing pixmaps not supplied by the user. +.PP +Call setAutoDelete(TRUE) if you want the factory to automatically delete itself when it is no longer needed by QIconSet. +.PP +See also QIconSet and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIconFactory::QIconFactory ()" +Constructs an icon factory. +.SH "QIconFactory::~QIconFactory ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "bool QIconFactory::autoDelete () const" +Returns TRUE if auto-deletion is enabled; otherwise returns FALSE. +.PP +See also setAutoDelete(). +.SH "QPixmap * QIconFactory::createPixmap ( const QIconSet & iconSet, QIconSet::Size size, QIconSet::Mode mode, QIconSet::State state )\fC [virtual]\fR" +Ceates a pixmap for \fIiconSet\fR with a certain \fIsize\fR, \fImode\fR, and \fIstate\fR. Returns 0 if the default QIconSet algorithm should be used to create a pixmap that wasn't supplied by the user. +.PP +It is the caller's responsibility to delete the returned pixmap. +.PP +The default implementation always returns 0. +.SH "QIconFactory * QIconFactory::defaultFactory ()\fC [static]\fR" +Returns the default icon factory. +.PP +See also installDefaultFactory(). +.SH "void QIconFactory::installDefaultFactory ( QIconFactory * factory )\fC [static]\fR" +Replaces the default icon factory with \fIfactory\fR. +.SH "void QIconFactory::setAutoDelete ( bool autoDelete )" +If \fIautoDelete\fR is TRUE, sets the icon factory to automatically delete itself when it is no longer referenced by any QIconSet and isn't the default factory. If \fIautoDelete\fR is FALSE (the default) auto-deletion is disabled. +.PP +See also autoDelete() and defaultFactory(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qiconfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqiconfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqiconset.3qt b/doc/man/man3/tqiconset.3qt new file mode 100644 index 000000000..2f8ec2515 --- /dev/null +++ b/doc/man/man3/tqiconset.3qt @@ -0,0 +1,284 @@ +'\" t +.TH QIconSet 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 +QIconSet \- Set of icons with different styles and sizes +.SH SYNOPSIS +\fC#include <ntqiconset.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBSize\fR { Automatic, Small, Large }" +.br +.ti -1c +.BI "enum \fBMode\fR { Normal, Disabled, Active }" +.br +.ti -1c +.BI "enum \fBState\fR { On, Off }" +.br +.ti -1c +.BI "\fBQIconSet\fR ()" +.br +.ti -1c +.BI "\fBQIconSet\fR ( const QPixmap & pixmap, Size size = Automatic )" +.br +.ti -1c +.BI "\fBQIconSet\fR ( const QPixmap & smallPix, const QPixmap & largePix )" +.br +.ti -1c +.BI "\fBQIconSet\fR ( const QIconSet & other )" +.br +.ti -1c +.BI "virtual \fB~QIconSet\fR ()" +.br +.ti -1c +.BI "void \fBreset\fR ( const QPixmap & pixmap, Size size )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & pixmap, Size size, Mode mode = Normal, State state = Off )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QString & fileName, Size size, Mode mode = Normal, State state = Off )" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR ( Size size, Mode mode, State state = Off ) const" +.br +.ti -1c +.BI "QPixmap pixmap ( Size size, bool enabled, State state = Off ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR () const" +.br +.ti -1c +.BI "bool \fBisGenerated\fR ( Size size, Mode mode, State state = Off ) const" +.br +.ti -1c +.BI "void \fBclearGenerated\fR ()" +.br +.ti -1c +.BI "void \fBinstallIconFactory\fR ( QIconFactory * factory )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "void \fBdetach\fR ()" +.br +.ti -1c +.BI "QIconSet & \fBoperator=\fR ( const QIconSet & other )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBsetIconSize\fR ( Size which, const QSize & size )" +.br +.ti -1c +.BI "const QSize & \fBiconSize\fR ( Size which )" +.br +.in -1c +.SH DESCRIPTION +The QIconSet class provides a set of icons with different styles and sizes. +.PP +A QIconSet can generate smaller, larger, active, and disabled pixmaps from the set of icons it is given. Such pixmaps are used by QToolButton, QHeader, QPopupMenu, etc. to show an icon representing a particular action. +.PP +The simplest use of QIconSet is to create one from a QPixmap and then use it, allowing Qt to work out all the required icon styles and sizes. For example: +.PP +.nf +.br + QToolButton *but = new QToolButton( QIconSet( QPixmap("open.xpm") ), ... ); +.br +.fi +.PP +Using whichever pixmaps you specify as a base, QIconSet provides a set of six icons, each with a Size and a Mode: Small Normal, Small Disabled, Small Active, Large Normal, Large Disabled, and Large Active. +.PP +An additional set of six icons can be provided for widgets that have an "On" or "Off" state, like checkable menu items or toggleable toolbuttons. If you provide pixmaps for the "On" state, but not for the "Off" state, the QIconSet will provide the "Off" pixmaps. You may specify icons for both states in you wish. +.PP +You can set any of the icons using setPixmap(). +.PP +When you retrieve a pixmap using pixmap(Size, Mode, State), QIconSet will return the icon that has been set or previously generated for that size, mode and state combination. If none is available, QIconSet will ask the icon factory. If the icon factory cannot provide any (the default), QIconSet generates a pixmap based on the pixmaps it has been given and returns it. +.PP +The Disabled appearance is computed using an algorithm that produces results very similar to those used in Microsoft Windows 95. The Active appearance is identical to the Normal appearance unless you use setPixmap() to set it to something special. +.PP +When scaling icons, QIconSet uses smooth scaling, which can partially blend the color component of pixmaps. If the results look poor, the best solution is to supply pixmaps in both large and small sizes. +.PP +You can use the static function setIconSize() to set the preferred size of the generated large/small icons. The default small size is 22 x 22, while the default large size is 32 x 32. These sizes only affect generated icons. +.PP +The isGenerated() function returns TRUE if an icon was generated by QIconSet or by a factory; clearGenerated() clears all cached pixmaps. +.SH "Making Classes that Use QIconSet" +If you write your own widgets that have an option to set a small pixmap, consider allowing a QIconSet to be set for that pixmap. The Qt class QToolButton is an example of such a widget. +.PP +Provide a method to set a QIconSet, and when you draw the icon, choose whichever icon is appropriate for the current state of your widget. For example: +.PP +.nf +.br + void MyWidget::drawIcon( QPainter* p, QPoint pos ) +.br + { +.br + p->drawPixmap( pos, icons->pixmap( +.br + QIconSet::Small, +.br + isEnabled() ? QIconSet::Normal : +.br + QIconSet::Disabled, +.br + isEnabled() ? QIconSet::On : +.br + QIconSet::Off)); +.br + } +.br +.fi +.PP +You might also make use of the Active mode, perhaps making your widget Active when the mouse is over the widget (see QWidget::enterEvent()), while the mouse is pressed pending the release that will activate the function, or when it is the currently selected item. If the widget can be toggled, the "On" mode might be used to draw a different icon. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QIconFactory, QPixmap, QMainWindow::usesBigPixmaps, GUI Design Handbook: Iconic Label, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SS "Member Type Documentation" +.SH "QIconSet::Mode" +This enum type describes the mode for which a pixmap is intended to be used. The currently defined modes are: +.TP +\fCQIconSet::Normal\fR - Display the pixmap when the user is not interacting with the icon, but the functionality represented by the icon is available. +.TP +\fCQIconSet::Disabled\fR - Display the pixmap when the functionality represented by the icon is not available. +.TP +\fCQIconSet::Active\fR - Display the pixmap when the functionality represented by the icon is available and the user is interacting with the icon, for example, moving the mouse over it or clicking it. +.SH "QIconSet::Size" +This enum type describes the size at which a pixmap is intended to be used. The currently defined sizes are: +.TP +\fCQIconSet::Automatic\fR - The size of the pixmap is determined from its pixel size. This is a useful default. +.TP +\fCQIconSet::Small\fR - The pixmap is the smaller of two. +.TP +\fCQIconSet::Large\fR - The pixmap is the larger of two. +.PP +If a Small pixmap is not set by QIconSet::setPixmap(), the Large pixmap will be automatically scaled down to the size of a small pixmap to generate the Small pixmap when required. Similarly, a Small pixmap will be automatically scaled up to generate a Large pixmap. The preferred sizes for large/small generated icons can be set using setIconSize(). +.PP +See also setIconSize(), iconSize(), setPixmap(), pixmap(), and QMainWindow::usesBigPixmaps. +.SH "QIconSet::State" +This enum describes the state for which a pixmap is intended to be used. The \fIstate\fR can be: +.TP +\fCQIconSet::Off\fR - Display the pixmap when the widget is in an "off" state +.TP +\fCQIconSet::On\fR - Display the pixmap when the widget is in an "on" state +.PP +See also setPixmap() and pixmap(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIconSet::QIconSet ()" +Constructs a null icon set. +.PP +See also setPixmap() and reset(). +.SH "QIconSet::QIconSet ( const QPixmap & pixmap, Size size = Automatic )" +Constructs an icon set for which the Normal pixmap is \fIpixmap\fR, which is assumed to be of size \fIsize\fR. +.PP +The default for \fIsize\fR is Automatic, which means that QIconSet will determine whether the pixmap is Small or Large from its pixel size. Pixmaps less than the width of a small generated icon are considered to be Small. You can use setIconSize() to set the preferred size of a generated icon. +.PP +See also setIconSize() and reset(). +.SH "QIconSet::QIconSet ( const QPixmap & smallPix, const QPixmap & largePix )" +Creates an iconset which uses the pixmap \fIsmallPix\fR for for displaying a small icon, and the pixmap \fIlargePix\fR for displaying a large icon. +.SH "QIconSet::QIconSet ( const QIconSet & other )" +Constructs a copy of \fIother\fR. This is very fast. +.SH "QIconSet::~QIconSet ()\fC [virtual]\fR" +Destroys the icon set and frees any allocated resources. +.SH "void QIconSet::clearGenerated ()" +Clears all cached pixmaps, including those obtained from an eventual QIconFactory. +.SH "void QIconSet::detach ()" +Detaches this icon set from others with which it may share data. +.PP +You will never need to call this function; other QIconSet functions call it as necessary. +.SH "const QSize & QIconSet::iconSize ( Size which )\fC [static]\fR" +If \fIwhich\fR is Small, returns the preferred size of a small generated icon; if \fIwhich\fR is Large, returns the preferred size of a large generated icon. +.PP +See also setIconSize(). +.SH "void QIconSet::installIconFactory ( QIconFactory * factory )" +Installs \fIfactory\fR as the icon factory for this iconset. The icon factory is used to generates pixmaps not set by the user. +.PP +If no icon factory is installed, QIconFactory::defaultFactory() is used. +.SH "bool QIconSet::isGenerated ( Size size, Mode mode, State state = Off ) const" +Returns TRUE if the pixmap with size \fIsize\fR, mode \fImode\fR and state \fIstate\fR is generated from other pixmaps; otherwise returns FALSE. +.PP +A pixmap obtained from a QIconFactory is considered non-generated. +.SH "bool QIconSet::isNull () const" +Returns TRUE if the icon set is empty; otherwise returns FALSE. +.SH "QIconSet & QIconSet::operator= ( const QIconSet & other )" +Assigns \fIother\fR to this icon set and returns a reference to this icon set. +.PP +See also detach(). +.SH "QPixmap QIconSet::pixmap ( Size size, Mode mode, State state = Off ) const" +Returns a pixmap with size \fIsize\fR, mode \fImode\fR and state \fIstate\fR, generating one if necessary. Generated pixmaps are cached. +.SH "QPixmap QIconSet::pixmap ( Size size, bool enabled, State state = Off ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is the same as pixmap(\fIsize\fR, \fIenabled\fR, \fIstate\fR). +.SH "QPixmap QIconSet::pixmap () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the pixmap originally provided to the constructor or to reset(). This is the Normal pixmap of unspecified Size. +.PP +See also reset(). +.SH "void QIconSet::reset ( const QPixmap & pixmap, Size size )" +Sets this icon set to use pixmap \fIpixmap\fR for the Normal pixmap, assuming it to be of size \fIsize\fR. +.PP +This is equivalent to assigning QIconSet(\fIpixmap\fR, \fIsize\fR) to this icon set. +.PP +This function does nothing if \fIpixmap\fR is a null pixmap. +.SH "void QIconSet::setIconSize ( Size which, const QSize & size )\fC [static]\fR" +Set the preferred size for all small or large icons that are generated after this call. If \fIwhich\fR is Small, sets the preferred size of small generated icons to \fIsize\fR. Similarly, if \fIwhich\fR is Large, sets the preferred size of large generated icons to \fIsize\fR. +.PP +Note that cached icons will not be regenerated, so it is recommended that you set the preferred icon sizes before generating any icon sets. Also note that the preferred icon sizes will be ignored for icon sets that have been created using both small and large pixmaps. +.PP +See also iconSize(). +.SH "void QIconSet::setPixmap ( const QPixmap & pixmap, Size size, Mode mode = Normal, State state = Off )\fC [virtual]\fR" +Sets this icon set to provide pixmap \fIpixmap\fR for size \fIsize\fR, mode \fImode\fR and state \fIstate\fR. The icon set may also use \fIpixmap\fR for generating other pixmaps if they are not explicitly set. +.PP +The \fIsize\fR can be one of Automatic, Large or Small. If Automatic is used, QIconSet will determine if the pixmap is Small or Large from its pixel size. +.PP +Pixmaps less than the width of a small generated icon are considered to be Small. You can use setIconSize() to set the preferred size of a generated icon. +.PP +This function does nothing if \fIpixmap\fR is a null pixmap. +.PP +See also reset(). +.SH "void QIconSet::setPixmap ( const QString & fileName, Size size, Mode mode = Normal, State state = Off )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The pixmap is loaded from \fIfileName\fR when it becomes necessary. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqiconset.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqiconset.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqiconview.3qt b/doc/man/man3/tqiconview.3qt new file mode 100644 index 000000000..1613f1f9a --- /dev/null +++ b/doc/man/man3/tqiconview.3qt @@ -0,0 +1,961 @@ +'\" t +.TH QIconView 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 +QIconView \- Area with movable labelled icons +.SH SYNOPSIS +\fC#include <ntqiconview.h>\fR +.PP +Inherits QScrollView. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBSelectionMode\fR { Single = 0, Multi, Extended, NoSelection }" +.br +.ti -1c +.BI "enum \fBArrangement\fR { LeftToRight = 0, TopToBottom }" +.br +.ti -1c +.BI "enum \fBResizeMode\fR { Fixed = 0, Adjust }" +.br +.ti -1c +.BI "enum \fBItemTextPos\fR { Bottom = 0, Right }" +.br +.ti -1c +.BI "\fBQIconView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "virtual \fB~QIconView\fR ()" +.br +.ti -1c +.BI "virtual void \fBinsertItem\fR ( QIconViewItem * item, QIconViewItem * after = 0L )" +.br +.ti -1c +.BI "virtual void \fBtakeItem\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "int \fBindex\fR ( const QIconViewItem * item ) const" +.br +.ti -1c +.BI "QIconViewItem * \fBfirstItem\fR () const" +.br +.ti -1c +.BI "QIconViewItem * \fBlastItem\fR () const" +.br +.ti -1c +.BI "QIconViewItem * \fBcurrentItem\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCurrentItem\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "virtual void \fBsetSelected\fR ( QIconViewItem * item, bool s, bool cb = FALSE )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSelectionMode\fR ( SelectionMode m )" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR () const" +.br +.ti -1c +.BI "QIconViewItem * \fBfindItem\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "QIconViewItem * \fBfindItem\fR ( const QString & text, ComparisonFlags compare = BeginsWith ) const" +.br +.ti -1c +.BI "virtual void \fBselectAll\fR ( bool select )" +.br +.ti -1c +.BI "virtual void \fBclearSelection\fR ()" +.br +.ti -1c +.BI "virtual void \fBinvertSelection\fR ()" +.br +.ti -1c +.BI "virtual void \fBrepaintItem\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBrepaintSelectedItems\fR ()" +.br +.ti -1c +.BI "void \fBensureItemVisible\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "QIconViewItem * \fBfindFirstVisibleItem\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "QIconViewItem * \fBfindLastVisibleItem\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetGridX\fR ( int rx )" +.br +.ti -1c +.BI "virtual void \fBsetGridY\fR ( int ry )" +.br +.ti -1c +.BI "int \fBgridX\fR () const" +.br +.ti -1c +.BI "int \fBgridY\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSpacing\fR ( int sp )" +.br +.ti -1c +.BI "int \fBspacing\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetItemTextPos\fR ( ItemTextPos pos )" +.br +.ti -1c +.BI "ItemTextPos \fBitemTextPos\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetItemTextBackground\fR ( const QBrush & b )" +.br +.ti -1c +.BI "QBrush \fBitemTextBackground\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetArrangement\fR ( Arrangement am )" +.br +.ti -1c +.BI "Arrangement \fBarrangement\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetResizeMode\fR ( ResizeMode am )" +.br +.ti -1c +.BI "ResizeMode \fBresizeMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMaxItemWidth\fR ( int w )" +.br +.ti -1c +.BI "int \fBmaxItemWidth\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMaxItemTextLength\fR ( int w )" +.br +.ti -1c +.BI "int \fBmaxItemTextLength\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoArrange\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBautoArrange\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetShowToolTips\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBshowToolTips\fR () const" +.br +.ti -1c +.BI "void \fBsetSorting\fR ( bool sort, bool ascending = TRUE )" +.br +.ti -1c +.BI "bool \fBsorting\fR () const" +.br +.ti -1c +.BI "bool \fBsortDirection\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetItemsMovable\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBitemsMovable\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetWordWrapIconText\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBwordWrapIconText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsort\fR ( bool ascending = TRUE )" +.br +.ti -1c +.BI "bool \fBisRenaming\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBarrangeItemsInGrid\fR ( const QSize & grid, bool update = TRUE )" +.br +.ti -1c +.BI "virtual void \fBarrangeItemsInGrid\fR ( bool update = TRUE )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBselectionChanged\fR ()" +.br +.ti -1c +.BI "void \fBselectionChanged\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBcurrentChanged\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBclicked\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBclicked\fR ( QIconViewItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBpressed\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBpressed\fR ( QIconViewItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBdoubleClicked\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBreturnPressed\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBrightButtonClicked\fR ( QIconViewItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBrightButtonPressed\fR ( QIconViewItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBmouseButtonPressed\fR ( int button, QIconViewItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBmouseButtonClicked\fR ( int button, QIconViewItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBcontextMenuRequested\fR ( QIconViewItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBdropped\fR ( QDropEvent * e, const QValueList<QIconDragItem> & lst )" +.br +.ti -1c +.BI "void \fBmoved\fR ()" +.br +.ti -1c +.BI "void \fBonItem\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "void \fBonViewport\fR ()" +.br +.ti -1c +.BI "void \fBitemRenamed\fR ( QIconViewItem * item, const QString & name )" +.br +.ti -1c +.BI "void \fBitemRenamed\fR ( QIconViewItem * item )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "Arrangement \fBarrangement\fR - the arrangement mode of the icon view" +.br +.ti -1c +.BI "bool \fBautoArrange\fR - whether the icon view rearranges its items when a new item is inserted" +.br +.ti -1c +.BI "uint \fBcount\fR - the number of items in the icon view \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBgridX\fR - the horizontal grid of the icon view" +.br +.ti -1c +.BI "int \fBgridY\fR - the vertical grid of the icon view" +.br +.ti -1c +.BI "QBrush \fBitemTextBackground\fR - the brush to use when drawing the background of an item's text" +.br +.ti -1c +.BI "ItemTextPos \fBitemTextPos\fR - the position where the text of each item is drawn" +.br +.ti -1c +.BI "bool \fBitemsMovable\fR - whether the user is allowed to move items around in the icon view" +.br +.ti -1c +.BI "int \fBmaxItemTextLength\fR - the maximum length (in " "characters" ") that an item's text may have" +.br +.ti -1c +.BI "int \fBmaxItemWidth\fR - the maximum width that an item may have" +.br +.ti -1c +.BI "ResizeMode \fBresizeMode\fR - the resize mode of the icon view" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR - the selection mode of the icon view" +.br +.ti -1c +.BI "bool \fBshowToolTips\fR - whether the icon view will display a tool tip with the complete text for any truncated item text" +.br +.ti -1c +.BI "bool \fBsortDirection\fR - whether the sort direction for inserting new items is ascending; \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBsorting\fR - whether the icon view sorts on insertion \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBspacing\fR - the space in pixels between icon view items" +.br +.ti -1c +.BI "bool \fBwordWrapIconText\fR - whether the item text will be word-wrapped if it is too long" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawRubber\fR ( QPainter * p )" +.br +.ti -1c +.BI "virtual QDragObject * \fBdragObject\fR ()" +.br +.ti -1c +.BI "virtual void \fBstartDrag\fR ()" +.br +.ti -1c +.BI "virtual void \fBinsertInGrid\fR ( QIconViewItem * item )" +.br +.ti -1c +.BI "virtual void \fBdrawBackground\fR ( QPainter * p, const QRect & r )" +.br +.ti -1c +.BI "void \fBemitSelectionChanged\fR ( QIconViewItem * i = 0 )" +.br +.ti -1c +.BI "QIconViewItem * \fBmakeRowLayout\fR ( QIconViewItem * begin, int & y, bool & changed )" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "virtual void \fBdoAutoScroll\fR ()" +.br +.ti -1c +.BI "virtual void \fBadjustItems\fR ()" +.br +.ti -1c +.BI "virtual void \fBslotUpdate\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QIconView class provides an area with movable labelled icons. +.PP +A QIconView can display and manage a grid or other 2D layout of labelled icons. Each labelled icon is a QIconViewItem. Items (QIconViewItems) can be added or deleted at any time; items can be moved within the QIconView. Single or multiple items can be selected. Items can be renamed in-place. QIconView also supports drag and drop. +.PP +Each item contains a label string, a pixmap or picture (the icon itself) and optionally a sort key. The sort key is used for sorting the items and defaults to the label string. The label string can be displayed below or to the right of the icon (see ItemTextPos). +.PP +The simplest way to create a QIconView is to create a QIconView object and create some QIconViewItems with the QIconView as their parent, set the icon view's geometry and show it. For example: +.PP +.nf +.br + QIconView *iv = new QIconView( this ); +.br + QDir dir( path, "*.xpm" ); +.br + for ( uint i = 0; i < dir.count(); i++ ) { +.br + (void) new QIconViewItem( iv, dir[i], QPixmap( path + dir[i] ) ); +.br + } +.br + iv->resize( 600, 400 ); +.br + iv->show(); +.br +.fi +.PP +The QIconViewItem call passes a pointer to the QIconView we wish to populate, along with the label text and a QPixmap. +.PP +When an item is inserted the QIconView allocates a position for it. Existing items are rearranged if autoArrange() is TRUE. The default arrangement is LeftToRight -- the QIconView fills up the \fIleft-most\fR column from top to bottom, then moves one column \fIright\fR and fills that from top to bottom and so on. The arrangement can be modified with any of the following approaches: +.TP +Call setArrangement(), e.g. with TopToBottom which will fill the \fItop-most\fR row from left to right, then moves one row \fIdown\fR and fills that row from left to right and so on. +.TP +Construct each QIconViewItem using a constructor which allows you to specify which item the new one is to follow. +.TP +Call setSorting() or sort() to sort the items. +.PP +The spacing between items is set with setSpacing(). Items can be laid out using a fixed grid using setGridX() and setGridY(); by default the QIconView calculates a grid dynamically. The position of items' label text is set with setItemTextPos(). The text's background can be set with setItemTextBackground(). The maximum width of an item and of its text are set with setMaxItemWidth() and setMaxItemTextLength(). The label text will be word-wrapped if it is too long; this is controlled by setWordWrapIconText(). If the label text is truncated, the user can still see the entire text in a tool tip if they hover the mouse over the item. This is controlled with setShowToolTips(). +.PP +Items which are selectable may be selected depending on the SelectionMode; the default is Single. Because QIconView offers multiple selection it must display keyboard focus and selection state separately. Therefore there are functions to set the selection state of an item (setSelected()) and to select which item displays keyboard focus (setCurrentItem()). When multiple items may be selected the icon view provides a rubberband, too. +.PP +When in-place renaming is enabled (it is disabled by default), the user may change the item's label. They do this by selecting the item (single clicking it or navigating to it with the arrow keys), then single clicking it (or pressing F2), and entering their text. If no key has been set with QIconViewItem::setKey() the new text will also serve as the key. (See QIconViewItem::setRenameEnabled().) +.PP +You can control whether users can move items themselves with setItemsMovable(). +.PP +Because the internal structure used to store the icon view items is linear, no iterator class is needed to iterate over all the items. Instead we iterate by getting the first item from the \fIicon view\fR and then each subsequent (QIconViewItem::nextItem()) from each \fIitem\fR in turn: +.PP +.nf +.br + for ( QIconViewItem *item = iv->firstItem(); item; item = item->nextItem() ) +.br + do_something( item ); +.br +.fi +QIconView also provides currentItem(). You can search for an item using findItem() (searching by position or for label text) and with findFirstVisibleItem() and findLastVisibleItem(). The number of items is returned by count(). An item can be removed from an icon view using takeItem(); to delete an item use \fCdelete\fR. All the items can be deleted with clear(). +.PP +The QIconView emits a wide range of useful signals, including selectionChanged(), currentChanged(), clicked(), moved() and itemRenamed(). +.SH "Drag and Drop" +QIconView supports the drag and drop of items within the QIconView itself. It also supports the drag and drop of items out of or into the QIconView and drag and drop onto items themselves. The drag and drop of items outside the QIconView can be achieved in a simple way with basic functionality, or in a more sophisticated way which provides more power and control. +.PP +The simple approach to dragging items out of the icon view is to subclass QIconView and reimplement QIconView::dragObject(). +.PP +.nf +.br + QDragObject *MyIconView::dragObject() +.br + { +.br + return new QTextDrag( currentItem()->text(), this ); +.br + } +.br +.fi +.PP +In this example we create a QTextDrag object, (derived from QDragObject), containing the item's label and return it as the drag object. We could just as easily have created a QImageDrag from the item's pixmap and returned that instead. +.PP +QIconViews and their QIconViewItems can also be the targets of drag and drops. To make the QIconView itself able to accept drops connect to the dropped() signal. When a drop occurs this signal will be emitted with a QDragEvent and a QValueList of QIconDragItems. To make a QIconViewItem into a drop target subclass QIconViewItem and reimplement QIconViewItem::acceptDrop() and QIconViewItem::dropped(). +.PP +.nf +.br + bool MyIconViewItem::acceptDrop( const QMimeSource *mime ) const +.br + { +.br + if ( mime->provides( "text/plain" ) ) +.br + return TRUE; +.br + return FALSE; +.br + } +.br +.br + void MyIconViewItem::dropped( QDropEvent *evt, const QValueList<QIconDragItem>& ) +.br + { +.br + QString label; +.br + if ( QTextDrag::decode( evt, label ) ) +.br + setText( label ); +.br + } +.br +.fi +.PP +See iconview/simple_dd/main.h and iconview/simple_dd/main.cpp for a simple drag and drop example which demonstrates drag and drop between a QIconView and a QListBox. +.PP +If you want to use extended drag-and-drop or have drag shapes drawn you must take a more sophisticated approach. +.PP +The first part is starting drags -- you should use a QIconDrag (or a class derived from it) for the drag object. In dragObject() create the drag object, populate it with QIconDragItems and return it. Normally such a drag should offer each selected item's data. So in dragObject() you should iterate over all the items, and create a QIconDragItem for each selected item, and append these items with QIconDrag::append() to the QIconDrag object. You can use QIconDragItem::setData() to set the data of each item that should be dragged. If you want to offer the data in additional mime-types, it's best to use a class derived from QIconDrag, which implements additional encoding and decoding functions. +.PP +When a drag enters the icon view, there is little to do. Simply connect to the dropped() signal and reimplement QIconViewItem::acceptDrop() and QIconViewItem::dropped(). If you've used a QIconDrag (or a subclass of it) the second argument to the dropped signal contains a QValueList of QIconDragItems -- you can access their data by calling QIconDragItem::data() on each one. +.PP +For an example implementation of complex drag-and-drop look at the fileiconview example (qt/examples/fileiconview). +.PP +See also QIconViewItem::setDragEnabled(), QIconViewItem::setDropEnabled(), QIconViewItem::acceptDrop(), QIconViewItem::dropped(), and Advanced Widgets. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +.SS "Member Type Documentation" +.SH "QIconView::Arrangement" +This enum type determines in which direction the items flow when the view runs out of space. +.TP +\fCQIconView::LeftToRight\fR - Items which don't fit into the view cause the viewport to extend vertically (you get a vertical scrollbar). +.TP +\fCQIconView::TopToBottom\fR - Items which don't fit into the view cause the viewport to extend horizontally (you get a horizontal scrollbar). +.SH "QIconView::ItemTextPos" +This enum type specifies the position of the item text in relation to the icon. +.TP +\fCQIconView::Bottom\fR - The text is drawn below the icon. +.TP +\fCQIconView::Right\fR - The text is drawn to the right of the icon. +.SH "QIconView::ResizeMode" +This enum type is used to tell QIconView how it should treat the positions of its icons when the widget is resized. The modes are: +.TP +\fCQIconView::Fixed\fR - The icons' positions are not changed. +.TP +\fCQIconView::Adjust\fR - The icons' positions are adjusted to be within the new geometry, if possible. +.SH "QIconView::SelectionMode" +This enumerated type is used by QIconView to indicate how it reacts to selection by the user. It has four values: +.TP +\fCQIconView::Single\fR - When the user selects an item, any already-selected item becomes unselected and the user cannot unselect the selected item. This means that the user can never clear the selection. (The application programmer can, using QIconView::clearSelection().) +.TP +\fCQIconView::Multi\fR - When the user selects an item, e.g. by navigating to it with the keyboard arrow keys or by clicking it, the selection status of that item is toggled and the other items are left alone. Also, multiple items can be selected by dragging the mouse while the left mouse button stays pressed. +.TP +\fCQIconView::Extended\fR - When the user selects an item the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item get selected or unselected, depending on the state of the clicked item. Also, multiple items can be selected by dragging the mouse while the left mouse button stays pressed. +.TP +\fCQIconView::NoSelection\fR - Items cannot be selected. +.PP +To summarise: Single is a real single-selection icon view; Multi a real multi-selection icon view; Extended is an icon view in which users can select multiple items but usually want to select either just one or a range of contiguous items; and NoSelection mode is for an icon view where the user can look but not touch. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIconView::QIconView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs an empty icon view called \fIname\fR, with parent \fIparent\fR and using the widget flags \fIf\fR. +.SH "QIconView::~QIconView ()\fC [virtual]\fR" +Destroys the icon view and deletes all items. +.SH "void QIconView::adjustItems ()\fC [virtual protected slot]\fR" +Adjusts the positions of the items to the geometry of the icon view. +.SH "void QIconView::arrangeItemsInGrid ( const QSize & grid, bool update = TRUE )\fC [virtual slot]\fR" +This variant uses \fIgrid\fR instead of (gridX(), gridY()). If \fIgrid\fR is invalid (see QSize::isValid()), arrangeItemsInGrid() calculates a valid grid itself and uses that. +.PP +If \fIupdate\fR is TRUE (the default) the viewport is repainted. +.PP +Example: fileiconview/qfileiconview.h. +.SH "void QIconView::arrangeItemsInGrid ( bool update = TRUE )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Arranges all the items in the grid given by gridX() and gridY(). +.PP +Even if sorting() is enabled, the items are not sorted by this function. If you want to sort or rearrange the items, use iconview->sort(iconview->sortDirection()). +.PP +If \fIupdate\fR is TRUE (the default), the viewport is repainted as well. +.PP +See also QIconView::gridX, QIconView::gridY, and QIconView::sort(). +.SH "Arrangement QIconView::arrangement () const" +Returns the arrangement mode of the icon view. See the "arrangement" property for details. +.SH "bool QIconView::autoArrange () const" +Returns TRUE if the icon view rearranges its items when a new item is inserted; otherwise returns FALSE. See the "autoArrange" property for details. +.SH "void QIconView::clear ()\fC [virtual]\fR" +Clears the icon view. All items are deleted. +.SH "void QIconView::clearSelection ()\fC [virtual]\fR" +Unselects all the items. +.SH "void QIconView::clicked ( QIconViewItem * item )\fC [signal]\fR" +This signal is emitted when the user clicks any mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. +.PP +See also mouseButtonClicked(), rightButtonClicked(), and pressed(). +.SH "void QIconView::clicked ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user clicks any mouse button on an icon view item. \fIitem\fR is a pointer to the item that has been clicked. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) +.PP +See also mouseButtonClicked(), rightButtonClicked(), and pressed(). +.SH "void QIconView::contextMenuRequested ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user invokes a context menu with the right mouse button or with special system keys, with \fIitem\fR being the item under the mouse cursor or the current item, respectively. +.PP +\fIpos\fR is the position for the context menu in the global coordinate system. +.SH "uint QIconView::count () const" +Returns the number of items in the icon view. See the "count" property for details. +.SH "void QIconView::currentChanged ( QIconViewItem * item )\fC [signal]\fR" +This signal is emitted when a new item becomes current. \fIitem\fR is the new current item (or 0 if no item is now current). +.PP +See also currentItem(). +.SH "QIconViewItem * QIconView::currentItem () const" +Returns a pointer to the current item of the icon view, or 0 if no item is current. +.PP +See also setCurrentItem(), firstItem(), and lastItem(). +.SH "void QIconView::doAutoScroll ()\fC [virtual protected slot]\fR" +Performs autoscrolling when selecting multiple icons with the rubber band. +.SH "void QIconView::doubleClicked ( QIconViewItem * item )\fC [signal]\fR" +This signal is emitted when the user double-clicks on \fIitem\fR. +.SH "QDragObject * QIconView::dragObject ()\fC [virtual protected]\fR" +Returns the QDragObject that should be used for drag-and-drop. This function is called by the icon view when starting a drag to get the dragobject that should be used for the drag. Subclasses may reimplement this. +.PP +See also QIconDrag. +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp. +.SH "void QIconView::drawBackground ( QPainter * p, const QRect & r )\fC [virtual protected]\fR" +This function is called to draw the rectangle \fIr\fR of the background using the painter \fIp\fR. +.PP +The default implementation fills \fIr\fR with the viewport's backgroundBrush(). Subclasses may reimplement this to draw custom backgrounds. +.PP +See also contentsX, contentsY, and drawContents(). +.SH "void QIconView::drawRubber ( QPainter * p )\fC [virtual protected]\fR" +Draws the rubber band using the painter \fIp\fR. +.SH "void QIconView::dropped ( QDropEvent * e, const QValueList<QIconDragItem> & lst )\fC [signal]\fR" +This signal is emitted when a drop event occurs in the viewport (but not on any icon) which the icon view itself can't handle. +.PP +\fIe\fR provides all the information about the drop. If the drag object of the drop was a QIconDrag, \fIlst\fR contains the list of the dropped items. You can get the data using QIconDragItem::data() on each item. If the \fIlst\fR is empty, i.e. the drag was not a QIconDrag, you have to decode the data in \fIe\fR and work with that. +.PP +Note QIconViewItems may be drop targets; if a drop event occurs on an item the item handles the drop. +.PP +Examples: +.)l iconview/main.cpp and iconview/simple_dd/main.cpp. +.SH "void QIconView::emitSelectionChanged ( QIconViewItem * i = 0 )\fC [protected]\fR" +Emits a signal to indicate selection changes. \fIi\fR is the QIconViewItem that was selected or de-selected. +.PP +\fIYou should never need to call this function.\fR +.SH "void QIconView::ensureItemVisible ( QIconViewItem * item )" +Makes sure that \fIitem\fR is entirely visible. If necessary, ensureItemVisible() scrolls the icon view. +.PP +See also ensureVisible(). +.SH "QIconViewItem * QIconView::findFirstVisibleItem ( const QRect & r ) const" +Finds the first item whose bounding rectangle overlaps \fIr\fR and returns a pointer to that item. \fIr\fR is given in content coordinates. Returns 0 if no item overlaps \fIr\fR. +.PP +If you want to find all items that touch \fIr\fR, you will need to use this function and nextItem() in a loop ending at findLastVisibleItem() and test QIconViewItem::rect() for each of these items. +.PP +See also findLastVisibleItem() and QIconViewItem::rect(). +.SH "QIconViewItem * QIconView::findItem ( const QPoint & pos ) const" +Returns a pointer to the item that contains point \fIpos\fR, which is given in contents coordinates, or 0 if no item contains point \fIpos\fR. +.SH "QIconViewItem * QIconView::findItem ( const QString & text, ComparisonFlags compare = BeginsWith ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a pointer to the first item whose text begins with \fItext\fR, or 0 if no such item could be found. Use the \fIcompare\fR flag to control the comparison behaviour. (See Qt::StringComparisonMode.) +.SH "QIconViewItem * QIconView::findLastVisibleItem ( const QRect & r ) const" +Finds the last item whose bounding rectangle overlaps \fIr\fR and returns a pointer to that item. \fIr\fR is given in content coordinates. Returns 0 if no item overlaps \fIr\fR. +.PP +See also findFirstVisibleItem(). +.SH "QIconViewItem * QIconView::firstItem () const" +Returns a pointer to the first item of the icon view, or 0 if there are no items in the icon view. +.PP +See also lastItem() and currentItem(). +.SH "int QIconView::gridX () const" +Returns the horizontal grid of the icon view. See the "gridX" property for details. +.SH "int QIconView::gridY () const" +Returns the vertical grid of the icon view. See the "gridY" property for details. +.SH "int QIconView::index ( const QIconViewItem * item ) const" +Returns the index of \fIitem\fR, or -1 if \fIitem\fR doesn't exist in this icon view. +.SH "void QIconView::insertInGrid ( QIconViewItem * item )\fC [virtual protected]\fR" +Inserts the QIconViewItem \fIitem\fR in the icon view's grid. \fIYou should never need to call this function.\fR Instead, insert QIconViewItems by creating them with a pointer to the QIconView that they are to be inserted into. +.SH "void QIconView::insertItem ( QIconViewItem * item, QIconViewItem * after = 0L )\fC [virtual]\fR" +Inserts the icon view item \fIitem\fR after \fIafter\fR. If \fIafter\fR is 0, \fIitem\fR is appended after the last item. +.PP +\fIYou should never need to call this function.\fR Instead create QIconViewItem's and associate them with your icon view like this: +.PP +.nf +.br + (void) new QIconViewItem( myIconview, "The text of the item", aPixmap ); +.br +.fi +.SH "void QIconView::invertSelection ()\fC [virtual]\fR" +Inverts the selection. Works only in Multi and Extended selection mode. +.SH "bool QIconView::isRenaming () const" +Returns TRUE if an iconview item is being renamed; otherwise returns FALSE. +.SH "void QIconView::itemRenamed ( QIconViewItem * item, const QString & name )\fC [signal]\fR" +This signal is emitted when \fIitem\fR has been renamed to \fIname\fR, usually by in-place renaming. +.PP +See also QIconViewItem::setRenameEnabled() and QIconViewItem::rename(). +.SH "void QIconView::itemRenamed ( QIconViewItem * item )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when \fIitem\fR has been renamed, usually by in-place renaming. +.PP +See also QIconViewItem::setRenameEnabled() and QIconViewItem::rename(). +.SH "QBrush QIconView::itemTextBackground () const" +Returns the brush to use when drawing the background of an item's text. See the "itemTextBackground" property for details. +.SH "ItemTextPos QIconView::itemTextPos () const" +Returns the position where the text of each item is drawn. See the "itemTextPos" property for details. +.SH "bool QIconView::itemsMovable () const" +Returns TRUE if the user is allowed to move items around in the icon view; otherwise returns FALSE. See the "itemsMovable" property for details. +.SH "QIconViewItem * QIconView::lastItem () const" +Returns a pointer to the last item of the icon view, or 0 if there are no items in the icon view. +.PP +See also firstItem() and currentItem(). +.SH "QIconViewItem * QIconView::makeRowLayout ( QIconViewItem * begin, int & y, bool & changed )\fC [protected]\fR" +Lays out a row of icons (if Arrangement == TopToBottom this is a column). Starts laying out with the item \fIbegin\fR. \fIy\fR is the starting coordinate. Returns the last item of the row (column) and sets the new starting coordinate to \fIy\fR. The \fIchanged\fR parameter is used internally. +.PP +\fBWarning:\fR This function may be made private in a future version of Qt. We do not recommend calling it. +.SH "int QIconView::maxItemTextLength () const" +Returns the maximum length (in characters) that an item's text may have. See the "maxItemTextLength" property for details. +.SH "int QIconView::maxItemWidth () const" +Returns the maximum width that an item may have. See the "maxItemWidth" property for details. +.SH "void QIconView::mouseButtonClicked ( int button, QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user clicks mouse button \fIbutton\fR. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) +.PP +See also mouseButtonPressed(), rightButtonClicked(), and clicked(). +.SH "void QIconView::mouseButtonPressed ( int button, QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user presses mouse button \fIbutton\fR. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). +.PP +See also rightButtonClicked() and pressed(). +.SH "void QIconView::moved ()\fC [signal]\fR" +This signal is emitted after successfully dropping one (or more) items of the icon view. If the items should be removed, it's best to do so in a slot connected to this signal. +.PP +Example: iconview/main.cpp. +.SH "void QIconView::onItem ( QIconViewItem * item )\fC [signal]\fR" +This signal is emitted when the user moves the mouse cursor onto an \fIitem\fR, similar to the QWidget::enterEvent() function. +.SH "void QIconView::onViewport ()\fC [signal]\fR" +This signal is emitted when the user moves the mouse cursor from an item to an empty part of the icon view. +.PP +See also onItem(). +.SH "void QIconView::pressed ( QIconViewItem * item )\fC [signal]\fR" +This signal is emitted when the user presses any mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. +.PP +See also mouseButtonPressed(), rightButtonPressed(), and clicked(). +.SH "void QIconView::pressed ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user presses any mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) +.PP +See also mouseButtonPressed(), rightButtonPressed(), and clicked(). +.SH "void QIconView::repaintItem ( QIconViewItem * item )\fC [virtual]\fR" +Repaints the \fIitem\fR. +.SH "void QIconView::repaintSelectedItems ()" +Repaints the selected items. +.SH "ResizeMode QIconView::resizeMode () const" +Returns the resize mode of the icon view. See the "resizeMode" property for details. +.SH "void QIconView::returnPressed ( QIconViewItem * item )\fC [signal]\fR" +This signal is emitted if the user presses the Return or Enter key. \fIitem\fR is the currentItem() at the time of the keypress. +.SH "void QIconView::rightButtonClicked ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user clicks the right mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differ by a pixel or two, \fIpos\fR is the position at release time.) +.PP +See also rightButtonPressed(), mouseButtonClicked(), and clicked(). +.SH "void QIconView::rightButtonPressed ( QIconViewItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user presses the right mouse button. If \fIitem\fR is non-null, the cursor is on \fIitem\fR. If \fIitem\fR is null, the mouse cursor isn't on any item. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). +.SH "void QIconView::selectAll ( bool select )\fC [virtual]\fR" +In Multi and Extended modes, this function sets all items to be selected if \fIselect\fR is TRUE, and to be unselected if \fIselect\fR is FALSE. +.PP +In Single and NoSelection modes, this function only changes the selection status of currentItem(). +.SH "void QIconView::selectionChanged ()\fC [signal]\fR" +This signal is emitted when the selection has been changed. It's emitted in each selection mode. +.SH "void QIconView::selectionChanged ( QIconViewItem * item )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the selection changes. \fIitem\fR is the newly selected item. This signal is emitted only in single selection mode. +.SH "SelectionMode QIconView::selectionMode () const" +Returns the selection mode of the icon view. See the "selectionMode" property for details. +.SH "void QIconView::setArrangement ( Arrangement am )\fC [virtual]\fR" +Sets the arrangement mode of the icon view to \fIam\fR. See the "arrangement" property for details. +.SH "void QIconView::setAutoArrange ( bool b )\fC [virtual]\fR" +Sets whether the icon view rearranges its items when a new item is inserted to \fIb\fR. See the "autoArrange" property for details. +.SH "void QIconView::setCurrentItem ( QIconViewItem * item )\fC [virtual]\fR" +Makes \fIitem\fR the new current item of the icon view. +.SH "void QIconView::setGridX ( int rx )\fC [virtual]\fR" +Sets the horizontal grid of the icon view to \fIrx\fR. See the "gridX" property for details. +.SH "void QIconView::setGridY ( int ry )\fC [virtual]\fR" +Sets the vertical grid of the icon view to \fIry\fR. See the "gridY" property for details. +.SH "void QIconView::setItemTextBackground ( const QBrush & b )\fC [virtual]\fR" +Sets the brush to use when drawing the background of an item's text to \fIb\fR. See the "itemTextBackground" property for details. +.SH "void QIconView::setItemTextPos ( ItemTextPos pos )\fC [virtual]\fR" +Sets the position where the text of each item is drawn to \fIpos\fR. See the "itemTextPos" property for details. +.SH "void QIconView::setItemsMovable ( bool b )\fC [virtual]\fR" +Sets whether the user is allowed to move items around in the icon view to \fIb\fR. See the "itemsMovable" property for details. +.SH "void QIconView::setMaxItemTextLength ( int w )\fC [virtual]\fR" +Sets the maximum length (in characters) that an item's text may have to \fIw\fR. See the "maxItemTextLength" property for details. +.SH "void QIconView::setMaxItemWidth ( int w )\fC [virtual]\fR" +Sets the maximum width that an item may have to \fIw\fR. See the "maxItemWidth" property for details. +.SH "void QIconView::setResizeMode ( ResizeMode am )\fC [virtual]\fR" +Sets the resize mode of the icon view to \fIam\fR. See the "resizeMode" property for details. +.SH "void QIconView::setSelected ( QIconViewItem * item, bool s, bool cb = FALSE )\fC [virtual]\fR" +Selects or unselects \fIitem\fR depending on \fIs\fR, and may also unselect other items, depending on QIconView::selectionMode() and \fIcb\fR. +.PP +If \fIs\fR is FALSE, \fIitem\fR is unselected. +.PP +If \fIs\fR is TRUE and QIconView::selectionMode() is Single, \fIitem\fR is selected, and the item which was selected is unselected. +.PP +If \fIs\fR is TRUE and QIconView::selectionMode() is Extended, \fIitem\fR is selected. If \fIcb\fR is TRUE, the selection state of the icon view's other items is left unchanged. If \fIcb\fR is FALSE (the default) all other items are unselected. +.PP +If \fIs\fR is TRUE and QIconView::selectionMode() is Multi \fIitem\fR is selected. +.PP +Note that \fIcb\fR is used only if QIconView::selectionMode() is Extended. \fIcb\fR defaults to FALSE. +.PP +All items whose selection status is changed repaint themselves. +.SH "void QIconView::setSelectionMode ( SelectionMode m )\fC [virtual]\fR" +Sets the selection mode of the icon view to \fIm\fR. See the "selectionMode" property for details. +.SH "void QIconView::setShowToolTips ( bool b )\fC [virtual]\fR" +Sets whether the icon view will display a tool tip with the complete text for any truncated item text to \fIb\fR. See the "showToolTips" property for details. +.SH "void QIconView::setSorting ( bool sort, bool ascending = TRUE )" +If \fIsort\fR is TRUE, this function sets the icon view to sort items when a new item is inserted. If \fIsort\fR is FALSE, the icon view will not be sorted. +.PP +Note that autoArrange() must be TRUE for sorting to take place. +.PP +If \fIascending\fR is TRUE (the default), items are sorted in ascending order. If \fIascending\fR is FALSE, items are sorted in descending order. +.PP +QIconViewItem::compare() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' text unless specifically set to something else. +.PP +See also QIconView::autoArrange, QIconView::autoArrange, sortDirection, sort(), and QIconViewItem::setKey(). +.SH "void QIconView::setSpacing ( int sp )\fC [virtual]\fR" +Sets the space in pixels between icon view items to \fIsp\fR. See the "spacing" property for details. +.SH "void QIconView::setWordWrapIconText ( bool b )\fC [virtual]\fR" +Sets whether the item text will be word-wrapped if it is too long to \fIb\fR. See the "wordWrapIconText" property for details. +.SH "bool QIconView::showToolTips () const" +Returns TRUE if the icon view will display a tool tip with the complete text for any truncated item text; otherwise returns FALSE. See the "showToolTips" property for details. +.SH "void QIconView::slotUpdate ()\fC [virtual protected slot]\fR" +This slot is used for a slightly-delayed update. +.PP +The icon view is not redrawn immediately after inserting a new item but after a very small delay using a QTimer. This means that when many items are inserted in a loop the icon view is probably redrawn only once at the end of the loop. This makes the insertions both flicker-free and faster. +.SH "void QIconView::sort ( bool ascending = TRUE )\fC [virtual]\fR" +Sorts and rearranges all the items in the icon view. If \fIascending\fR is TRUE, the items are sorted in increasing order, otherwise they are sorted in decreasing order. +.PP +QIconViewItem::compare() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' text unless specifically set to something else. +.PP +Note that this function sets the sort order to \fIascending\fR. +.PP +See also QIconViewItem::key(), QIconViewItem::setKey(), QIconViewItem::compare(), QIconView::setSorting(), and QIconView::sortDirection. +.SH "bool QIconView::sortDirection () const" +Returns TRUE if the sort direction for inserting new items is ascending;; otherwise returns FALSE. See the "sortDirection" property for details. +.SH "bool QIconView::sorting () const" +Returns TRUE if the icon view sorts on insertion; otherwise returns FALSE. See the "sorting" property for details. +.SH "int QIconView::spacing () const" +Returns the space in pixels between icon view items. See the "spacing" property for details. +.SH "void QIconView::startDrag ()\fC [virtual protected]\fR" +Starts a drag. +.SH "void QIconView::takeItem ( QIconViewItem * item )\fC [virtual]\fR" +Takes the icon view item \fIitem\fR out of the icon view and causes an update of the screen display. The item is not deleted. You should normally not need to call this function because QIconViewItem::~QIconViewItem() calls it. The normal way to delete an item is to delete it. +.SH "bool QIconView::wordWrapIconText () const" +Returns TRUE if the item text will be word-wrapped if it is too long; otherwise returns FALSE. See the "wordWrapIconText" property for details. +.SS "Property Documentation" +.SH "Arrangement arrangement" +This property holds the arrangement mode of the icon view. +.PP +This can be LeftToRight or TopToBottom. The default is LeftToRight. +.PP +Set this property's value with setArrangement() and get this property's value with arrangement(). +.SH "bool autoArrange" +This property holds whether the icon view rearranges its items when a new item is inserted. +.PP +The default is TRUE. +.PP +Note that if the icon view is not visible at the time of insertion, QIconView defers all position-related work until it is shown and then calls arrangeItemsInGrid(). +.PP +Set this property's value with setAutoArrange() and get this property's value with autoArrange(). +.SH "uint count" +This property holds the number of items in the icon view. +.PP +Get this property's value with count(). +.SH "int gridX" +This property holds the horizontal grid of the icon view. +.PP +If the value is -1, (the default), QIconView computes suitable column widths based on the icon view's contents. +.PP +Note that setting a grid width overrides setMaxItemWidth(). +.PP +Set this property's value with setGridX() and get this property's value with gridX(). +.SH "int gridY" +This property holds the vertical grid of the icon view. +.PP +If the value is -1, (the default), QIconView computes suitable column heights based on the icon view's contents. +.PP +Set this property's value with setGridY() and get this property's value with gridY(). +.SH "QBrush itemTextBackground" +This property holds the brush to use when drawing the background of an item's text. +.PP +By default this brush is set to NoBrush, meaning that only the normal icon view background is used. +.PP +Set this property's value with setItemTextBackground() and get this property's value with itemTextBackground(). +.SH "ItemTextPos itemTextPos" +This property holds the position where the text of each item is drawn. +.PP +Valid values are Bottom or Right. The default is Bottom. +.PP +Set this property's value with setItemTextPos() and get this property's value with itemTextPos(). +.SH "bool itemsMovable" +This property holds whether the user is allowed to move items around in the icon view. +.PP +The default is TRUE. +.PP +Set this property's value with setItemsMovable() and get this property's value with itemsMovable(). +.SH "int maxItemTextLength" +This property holds the maximum length (in characters) that an item's text may have. +.PP +The default is 255 characters. +.PP +Set this property's value with setMaxItemTextLength() and get this property's value with maxItemTextLength(). +.SH "int maxItemWidth" +This property holds the maximum width that an item may have. +.PP +The default is 100 pixels. +.PP +Note that if the gridX() value is set QIconView will ignore this property. +.PP +Set this property's value with setMaxItemWidth() and get this property's value with maxItemWidth(). +.SH "ResizeMode resizeMode" +This property holds the resize mode of the icon view. +.PP +This can be Fixed or Adjust. The default is Fixed. See ResizeMode. +.PP +Set this property's value with setResizeMode() and get this property's value with resizeMode(). +.SH "SelectionMode selectionMode" +This property holds the selection mode of the icon view. +.PP +This can be Single (the default), Extended, Multi or NoSelection. +.PP +Set this property's value with setSelectionMode() and get this property's value with selectionMode(). +.SH "bool showToolTips" +This property holds whether the icon view will display a tool tip with the complete text for any truncated item text. +.PP +The default is TRUE. Note that this has no effect if setWordWrapIconText() is TRUE, as it is by default. +.PP +Set this property's value with setShowToolTips() and get this property's value with showToolTips(). +.SH "bool sortDirection" +This property holds whether the sort direction for inserting new items is ascending;. +.PP +The default is TRUE (i.e. ascending). This sort direction is only meaningful if both sorting() and autoArrange() are TRUE. +.PP +To set the sort direction, use setSorting() +.PP +Get this property's value with sortDirection(). +.SH "bool sorting" +This property holds whether the icon view sorts on insertion. +.PP +The default is FALSE, i.e. no sorting on insertion. +.PP +To set the sorting, use setSorting(). +.PP +Get this property's value with sorting(). +.SH "int spacing" +This property holds the space in pixels between icon view items. +.PP +The default is 5 pixels. +.PP +Negative values for spacing are illegal. +.PP +Set this property's value with setSpacing() and get this property's value with spacing(). +.SH "bool wordWrapIconText" +This property holds whether the item text will be word-wrapped if it is too long. +.PP +The default is TRUE. +.PP +If this property is FALSE, icon text that is too long is truncated, and an ellipsis (...) appended to indicate that truncation has occurred. The full text can still be seen by the user if they hover the mouse because the full text is shown in a tooltip; see setShowToolTips(). +.PP +Set this property's value with setWordWrapIconText() and get this property's value with wordWrapIconText(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqiconview.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqiconview.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqiconviewitem.3qt b/doc/man/man3/tqiconviewitem.3qt new file mode 100644 index 000000000..d1e3733a1 --- /dev/null +++ b/doc/man/man3/tqiconviewitem.3qt @@ -0,0 +1,576 @@ +'\" t +.TH QIconViewItem 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 +QIconViewItem \- Single item in a QIconView +.SH SYNOPSIS +\fC#include <ntqiconview.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent )" +.br +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after )" +.br +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent, const QString & text )" +.br +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after, const QString & text )" +.br +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent, const QString & text, const QPixmap & icon )" +.br +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after, const QString & text, const QPixmap & icon )" +.br +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent, const QString & text, const QPicture & picture )" +.br +.ti -1c +.BI "\fBQIconViewItem\fR ( QIconView * parent, QIconViewItem * after, const QString & text, const QPicture & picture )" +.br +.ti -1c +.BI "virtual \fB~QIconViewItem\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetRenameEnabled\fR ( bool allow )" +.br +.ti -1c +.BI "virtual void \fBsetDragEnabled\fR ( bool allow )" +.br +.ti -1c +.BI "virtual void \fBsetDropEnabled\fR ( bool allow )" +.br +.ti -1c +.BI "virtual QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual QPicture * \fBpicture\fR () const" +.br +.ti -1c +.BI "virtual QString \fBkey\fR () const" +.br +.ti -1c +.BI "bool \fBrenameEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBdragEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBdropEnabled\fR () const" +.br +.ti -1c +.BI "QIconView * \fBiconView\fR () const" +.br +.ti -1c +.BI "QIconViewItem * \fBprevItem\fR () const" +.br +.ti -1c +.BI "QIconViewItem * \fBnextItem\fR () const" +.br +.ti -1c +.BI "int \fBindex\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSelected\fR ( bool s, bool cb )" +.br +.ti -1c +.BI "virtual void \fBsetSelected\fR ( bool s )" +.br +.ti -1c +.BI "virtual void \fBsetSelectable\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBisSelected\fR () const" +.br +.ti -1c +.BI "bool \fBisSelectable\fR () const" +.br +.ti -1c +.BI "virtual void \fBrepaint\fR ()" +.br +.ti -1c +.BI "virtual bool \fBmove\fR ( int x, int y )" +.br +.ti -1c +.BI "virtual void \fBmoveBy\fR ( int dx, int dy )" +.br +.ti -1c +.BI "virtual bool \fBmove\fR ( const QPoint & pnt )" +.br +.ti -1c +.BI "virtual void \fBmoveBy\fR ( const QPoint & pnt )" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "QPoint \fBpos\fR () const" +.br +.ti -1c +.BI "QRect \fBtextRect\fR ( bool relative = TRUE ) const" +.br +.ti -1c +.BI "QRect \fBpixmapRect\fR ( bool relative = TRUE ) const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QPoint & pnt ) const" +.br +.ti -1c +.BI "bool \fBintersects\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "virtual bool \fBacceptDrop\fR ( const QMimeSource * mime ) const" +.br +.ti -1c +.BI "void \fBrename\fR ()" +.br +.ti -1c +.BI "virtual int \fBcompare\fR ( QIconViewItem * i ) const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & text )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & icon )" +.br +.ti -1c +.BI "virtual void \fBsetPicture\fR ( const QPicture & icon )" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & text, bool recalc, bool redraw = TRUE )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & icon, bool recalc, bool redraw = TRUE )" +.br +.ti -1c +.BI "virtual void \fBsetKey\fR ( const QString & k )" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBremoveRenameBox\fR ()" +.br +.ti -1c +.BI "virtual void \fBcalcRect\fR ( const QString & text_ = QString::null )" +.br +.ti -1c +.BI "virtual void \fBpaintItem\fR ( QPainter * p, const QColorGroup & cg )" +.br +.ti -1c +.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QColorGroup & cg )" +.br +.ti -1c +.BI "virtual void \fBdropped\fR ( QDropEvent * e, const QValueList<QIconDragItem> & lst )" +.br +.ti -1c +.BI "virtual void \fBdragEntered\fR ()" +.br +.ti -1c +.BI "virtual void \fBdragLeft\fR ()" +.br +.ti -1c +.BI "void \fBsetItemRect\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBsetTextRect\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBsetPixmapRect\fR ( const QRect & r )" +.br +.in -1c +.SH DESCRIPTION +The QIconViewItem class provides a single item in a QIconView. +.PP +A QIconViewItem contains an icon, a string and optionally a sort key, and can display itself in a QIconView. The class is designed to be very similar to QListView and QListBox in use, both via instantiation and subclassing. +.PP +The simplest way to create a QIconViewItem and insert it into a QIconView is to construct the item passing the constructor a pointer to the icon view, a string and an icon: +.PP +.nf +.br + (void) new QIconViewItem( +.br + iconView, // A pointer to a QIconView +.br + "This is the text of the item", +.br + aPixmap ); +.br +.fi +.PP +By default the text of an icon view item may not be edited by the user but calling setRenameEnabled(TRUE) will allow the user to perform in-place editing of the item's text. +.PP +When the icon view is deleted all items in it are deleted automatically. +.PP +The QIconView::firstItem() and QIconViewItem::nextItem() functions provide a means of iterating over all the items in a QIconView: +.PP +.nf +.br + QIconViewItem *item; +.br + for ( item = iconView->firstItem(); item; item = item->nextItem() ) +.br + do_something_with( item ); +.br +.fi +.PP +The item's icon view is available from iconView(), and its position in the icon view from index(). +.PP +The item's selection status is available from isSelected() and is set and controlled by setSelected() and isSelectable(). +.PP +The text and icon can be set with setText() and setPixmap() and retrieved with text() and pixmap(). The item's sort key defaults to text() but may be set with setKey() and retrieved with key(). The comparison function, compare() uses key(). +.PP +Items may be repositioned with move() and moveBy(). An item's geometry is available from rect(), x(), y(), width(), height(), size(), pos(), textRect() and pixmapRect(). You can also test against the position of a point with contains() and intersects(). +.PP +To remove an item from an icon view, just delete the item. The QIconViewItem destructor removes it cleanly from its icon view. +.PP +Because the icon view is designed to use drag-and-drop, the icon view item also has functions for drag-and-drop which may be reimplemented. +.PP +\fBNote:\fR Pixmaps with individual dimensions larger than 300 pixels may not be displayed properly, depending on the arrangement in use. For example, pixmaps wider than 300 pixels will not be arranged correctly if the icon view uses a QIconView::TopToBottom arrangement, and pixmaps taller than 300 pixels will not be arranged correctly if the icon view uses a QIconView::LeftToRight arrangement. +.PP +See also Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIconViewItem::QIconViewItem ( QIconView * parent )" +Constructs a QIconViewItem and inserts it into icon view \fIparent\fR with no text and a default icon. +.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after )" +Constructs a QIconViewItem and inserts it into the icon view \fIparent\fR with no text and a default icon, after the icon view item \fIafter\fR. +.SH "QIconViewItem::QIconViewItem ( QIconView * parent, const QString & text )" +Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and a default icon. +.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after, const QString & text )" +Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and a default icon, after the icon view item \fIafter\fR. +.SH "QIconViewItem::QIconViewItem ( QIconView * parent, const QString & text, const QPixmap & icon )" +Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIicon\fR as the icon. +.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after, const QString & text, const QPixmap & icon )" +Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIicon\fR as the icon, after the icon view item \fIafter\fR. +.PP +See also setPixmap(). +.SH "QIconViewItem::QIconViewItem ( QIconView * parent, const QString & text, const QPicture & picture )" +Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIpicture\fR as the icon. +.SH "QIconViewItem::QIconViewItem ( QIconView * parent, QIconViewItem * after, const QString & text, const QPicture & picture )" +Constructs an icon view item and inserts it into the icon view \fIparent\fR using \fItext\fR as the text and \fIpicture\fR as the icon, after the icon view item \fIafter\fR. +.SH "QIconViewItem::~QIconViewItem ()\fC [virtual]\fR" +Destroys the icon view item and tells the parent icon view that the item has been destroyed. +.SH "bool QIconViewItem::acceptDrop ( const QMimeSource * mime ) const\fC [virtual]\fR" +Returns TRUE if you can drop things with a QMimeSource of \fImime\fR onto this item; otherwise returns FALSE. +.PP +The default implementation always returns FALSE. You must subclass QIconViewItem and reimplement acceptDrop() to accept drops. +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp. +.SH "void QIconViewItem::calcRect ( const QString & text_ = QString::null )\fC [virtual protected]\fR" +This virtual function is responsible for calculating the rectangles returned by rect(), textRect() and pixmapRect(). setRect(), setTextRect() and setPixmapRect() are provided mainly for reimplementations of this function. +.PP +\fItext_\fR is an internal parameter which defaults to QString::null. +.SH "int QIconViewItem::compare ( QIconViewItem * i ) const\fC [virtual]\fR" +Compares this icon view item to \fIi\fR. Returns -1 if this item is less than \fIi\fR, 0 if they are equal, and 1 if this icon view item is greater than \fIi\fR. +.PP +The default implementation compares the item keys (key()) using QString::localeAwareCompare(). A reimplementation may use different values and a different comparison function. Here is a reimplementation that uses plain Unicode comparison: +.PP +.nf +.br + int MyIconViewItem::compare( QIconViewItem *i ) const +.br + { +.br + return key().compare( i->key() ); +.br + } +.br +.fi +.PP +See also key(), QString::localeAwareCompare(), and QString::compare(). +.SH "bool QIconViewItem::contains ( const QPoint & pnt ) const" +Returns TRUE if the item contains the point \fIpnt\fR (in contents coordinates); otherwise returns FALSE. +.SH "bool QIconViewItem::dragEnabled () const" +Returns TRUE if the user is allowed to drag the icon view item; otherwise returns FALSE. +.PP +See also setDragEnabled(). +.SH "void QIconViewItem::dragEntered ()\fC [virtual protected]\fR" +This function is called when a drag enters the item's bounding rectangle. +.PP +The default implementation does nothing; subclasses may reimplement this function. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "void QIconViewItem::dragLeft ()\fC [virtual protected]\fR" +This function is called when a drag leaves the item's bounding rectangle. +.PP +The default implementation does nothing; subclasses may reimplement this function. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QIconViewItem::dropEnabled () const" +Returns TRUE if the user is allowed to drop something onto the item; otherwise returns FALSE. +.PP +See also setDropEnabled(). +.SH "void QIconViewItem::dropped ( QDropEvent * e, const QValueList<QIconDragItem> & lst )\fC [virtual protected]\fR" +This function is called when something is dropped on the item. \fIe\fR provides all the information about the drop. If the drag object of the drop was a QIconDrag, \fIlst\fR contains the list of the dropped items. You can get the data by calling QIconDragItem::data() on each item. If the \fIlst\fR is empty, i.e. the drag was not a QIconDrag, you must decode the data in \fIe\fR and work with that. +.PP +The default implementation does nothing; subclasses may reimplement this function. +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and iconview/simple_dd/main.cpp. +.SH "int QIconViewItem::height () const" +Returns the height of the item. +.SH "QIconView * QIconViewItem::iconView () const" +Returns a pointer to this item's icon view parent. +.SH "int QIconViewItem::index () const" +Returns the index of this item in the icon view, or -1 if an error occurred. +.SH "bool QIconViewItem::intersects ( const QRect & r ) const" +Returns TRUE if the item intersects the rectangle \fIr\fR (in contents coordinates); otherwise returns FALSE. +.SH "bool QIconViewItem::isSelectable () const" +Returns TRUE if the item is selectable; otherwise returns FALSE. +.PP +See also setSelectable(). +.SH "bool QIconViewItem::isSelected () const" +Returns TRUE if the item is selected; otherwise returns FALSE. +.PP +See also setSelected(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QString QIconViewItem::key () const\fC [virtual]\fR" +Returns the key of the icon view item or text() if no key has been explicitly set. +.PP +See also setKey() and compare(). +.SH "bool QIconViewItem::move ( int x, int y )\fC [virtual]\fR" +Moves the item to position (\fIx\fR, \fIy\fR) in the icon view (these are contents coordinates). +.SH "bool QIconViewItem::move ( const QPoint & pnt )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Moves the item to the point \fIpnt\fR. +.SH "void QIconViewItem::moveBy ( int dx, int dy )\fC [virtual]\fR" +Moves the item \fIdx\fR pixels in the x-direction and \fIdy\fR pixels in the y-direction. +.SH "void QIconViewItem::moveBy ( const QPoint & pnt )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Moves the item by the x, y values in point \fIpnt\fR. +.SH "QIconViewItem * QIconViewItem::nextItem () const" +Returns a pointer to the next item, or 0 if this is the last item in the icon view. +.PP +To find the first item use QIconView::firstItem(). +.PP +Example: +.PP +.nf +.br + QIconViewItem *item; +.br + for ( item = iconView->firstItem(); item; item = item->nextItem() ) +.br + do_something_with( item ); +.br +.fi +.PP +See also prevItem(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "void QIconViewItem::paintFocus ( QPainter * p, const QColorGroup & cg )\fC [virtual protected]\fR" +Paints the focus rectangle of the item using the painter \fIp\fR and the color group \fIcg\fR. +.SH "void QIconViewItem::paintItem ( QPainter * p, const QColorGroup & cg )\fC [virtual protected]\fR" +Paints the item using the painter \fIp\fR and the color group \fIcg\fR. If you want the item to be drawn with a different font or color, reimplement this function, change the values of the color group or the painter's font, and then call the QIconViewItem::paintItem() with the changed values. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QPicture * QIconViewItem::picture () const\fC [virtual]\fR" +Returns the icon of the icon view item if it is a picture, or 0 if it is a pixmap. In the latter case use pixmap() instead. Normally you set the picture of the item with setPicture(), but sometimes it's inconvenient to call setPicture() for every item. So you can subclass QIconViewItem, reimplement this function and return a pointer to the item's picture. If you do this, you \fImust\fR call calcRect() manually each time the size of this picture changes. +.PP +See also setPicture(). +.SH "QPixmap * QIconViewItem::pixmap () const\fC [virtual]\fR" +Returns the icon of the icon view item if it is a pixmap, or 0 if it is a picture. In the latter case use picture() instead. Normally you set the pixmap of the item with setPixmap(), but sometimes it's inconvenient to call setPixmap() for every item. So you can subclass QIconViewItem, reimplement this function and return a pointer to the item's pixmap. If you do this, you \fImust\fR call calcRect() manually each time the size of this pixmap changes. +.PP +See also setPixmap(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QRect QIconViewItem::pixmapRect ( bool relative = TRUE ) const" +Returns the bounding rectangle of the item's icon. +.PP +If \fIrelative\fR is TRUE, (the default), the rectangle is relative to the origin of the item's rectangle. If \fIrelative\fR is FALSE, the returned rectangle is relative to the origin of the icon view's contents coordinate system. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QPoint QIconViewItem::pos () const" +Returns the position of the item (in contents coordinates). +.SH "QIconViewItem * QIconViewItem::prevItem () const" +Returns a pointer to the previous item, or 0 if this is the first item in the icon view. +.PP +See also nextItem() and QIconView::firstItem(). +.SH "QRect QIconViewItem::rect () const" +Returns the bounding rectangle of the item (in contents coordinates). +.SH "void QIconViewItem::removeRenameBox ()\fC [virtual protected]\fR" +Removes the editbox that is used for in-place renaming. +.SH "void QIconViewItem::rename ()" +Starts in-place renaming of an icon, if allowed. +.PP +This function sets up the icon view so that the user can edit the item text, and then returns. When the user is done, setText() will be called and QIconView::itemRenamed() will be emitted (unless the user canceled, e.g. by pressing the Escape key). +.PP +See also setRenameEnabled(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QIconViewItem::renameEnabled () const" +Returns TRUE if the item can be renamed by the user with in-place renaming; otherwise returns FALSE. +.PP +See also setRenameEnabled(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "void QIconViewItem::repaint ()\fC [virtual]\fR" +Repaints the item. +.SH "int QIconViewItem::rtti () const\fC [virtual]\fR" +Returns 0. +.PP +Make your derived classes return their own values for rtti(), so that you can distinguish between icon view item types. You should use values greater than 1000, preferably a large random number, to allow for extensions to this class. +.SH "void QIconViewItem::setDragEnabled ( bool allow )\fC [virtual]\fR" +If \fIallow\fR is TRUE, the icon view permits the user to drag the icon view item either to another position within the icon view or to somewhere outside of it. If \fIallow\fR is FALSE, the item cannot be dragged. +.SH "void QIconViewItem::setDropEnabled ( bool allow )\fC [virtual]\fR" +If \fIallow\fR is TRUE, the icon view lets the user drop something on this icon view item. +.SH "void QIconViewItem::setItemRect ( const QRect & r )\fC [protected]\fR" +Sets the bounding rectangle of the whole item to \fIr\fR. This function is provided for subclasses which reimplement calcRect(), so that they can set the calculated rectangle. \fIAny other use is discouraged.\fR +.PP +See also calcRect(), textRect(), setTextRect(), pixmapRect(), and setPixmapRect(). +.SH "void QIconViewItem::setKey ( const QString & k )\fC [virtual]\fR" +Sets \fIk\fR as the sort key of the icon view item. By default text() is used for sorting. +.PP +See also compare(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "void QIconViewItem::setPicture ( const QPicture & icon )\fC [virtual]\fR" +Sets \fIicon\fR as the item's icon in the icon view. This function might be a no-op if you reimplement picture(). +.PP +See also picture(). +.SH "void QIconViewItem::setPixmap ( const QPixmap & icon )\fC [virtual]\fR" +Sets \fIicon\fR as the item's icon in the icon view. This function might be a no-op if you reimplement pixmap(). +.PP +\fBNote:\fR Pixmaps with individual dimensions larger than 300 pixels may not be displayed properly, depending on the arrangement in use. See the main class documentation for details. +.PP +See also pixmap(). +.SH "void QIconViewItem::setPixmap ( const QPixmap & icon, bool recalc, bool redraw = TRUE )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets \fIicon\fR as the item's icon in the icon view. If \fIrecalc\fR is TRUE, the icon view's layout is recalculated. If \fIredraw\fR is TRUE (the default), the icon view is repainted. +.PP +\fBNote:\fR Pixmaps with individual dimensions larger than 300 pixels may not be displayed properly, depending on the arrangement in use. See the main class documentation for details. +.PP +See also pixmap(). +.SH "void QIconViewItem::setPixmapRect ( const QRect & r )\fC [protected]\fR" +Sets the bounding rectangle of the item's icon to \fIr\fR. This function is provided for subclasses which reimplement calcRect(), so that they can set the calculated rectangle. \fIAny other use is discouraged.\fR +.PP +See also calcRect(), pixmapRect(), setItemRect(), and setTextRect(). +.SH "void QIconViewItem::setRenameEnabled ( bool allow )\fC [virtual]\fR" +If \fIallow\fR is TRUE, the user can rename the icon view item by clicking on the text (or pressing F2) while the item is selected (in-place renaming). If \fIallow\fR is FALSE, in-place renaming is not possible. +.PP +Examples: +.)l fileiconview/qfileiconview.cpp, iconview/main.cpp, and iconview/simple_dd/main.cpp. +.SH "void QIconViewItem::setSelectable ( bool enable )\fC [virtual]\fR" +Sets this item to be selectable if \fIenable\fR is TRUE (the default) or unselectable if \fIenable\fR is FALSE. +.PP +The user is unable to select a non-selectable item using either the keyboard or the mouse. (The application programmer can select an item in code regardless of this setting.) +.PP +See also isSelectable(). +.SH "void QIconViewItem::setSelected ( bool s, bool cb )\fC [virtual]\fR" +Selects or unselects the item, depending on \fIs\fR; it may also unselect other items, depending on QIconView::selectionMode() and \fIcb\fR. +.PP +If \fIs\fR is FALSE, the item is unselected. +.PP +If \fIs\fR is TRUE and QIconView::selectionMode() is \fCSingle\fR, the item is selected and the item previously selected is unselected. +.PP +If \fIs\fR is TRUE and QIconView::selectionMode() is \fCExtended\fR, the item is selected. If \fIcb\fR is TRUE, the selection state of the other items is left unchanged. If \fIcb\fR is FALSE (the default) all other items are unselected. +.PP +If \fIs\fR is TRUE and QIconView::selectionMode() is \fCMulti\fR, the item is selected. +.PP +Note that \fIcb\fR is used only if QIconView::selectionMode() is \fCExtended\fR; cb defaults to FALSE. +.PP +All items whose selection status changes repaint themselves. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "void QIconViewItem::setSelected ( bool s )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This variant is equivalent to calling the other variant with \fIcb\fR set to FALSE. +.SH "void QIconViewItem::setText ( const QString & text )\fC [virtual]\fR" +Sets \fItext\fR as the text of the icon view item. This function might be a no-op if you reimplement text(). +.PP +See also text(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "void QIconViewItem::setText ( const QString & text, bool recalc, bool redraw = TRUE )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets \fItext\fR as the text of the icon view item. If \fIrecalc\fR is TRUE, the icon view's layout is recalculated. If \fIredraw\fR is TRUE (the default), the icon view is repainted. +.PP +See also text(). +.SH "void QIconViewItem::setTextRect ( const QRect & r )\fC [protected]\fR" +Sets the bounding rectangle of the item's text to \fIr\fR. This function is provided for subclasses which reimplement calcRect(), so that they can set the calculated rectangle. \fIAny other use is discouraged.\fR +.PP +See also calcRect(), textRect(), setItemRect(), and setPixmapRect(). +.SH "QSize QIconViewItem::size () const" +Returns the size of the item. +.SH "QString QIconViewItem::text () const\fC [virtual]\fR" +Returns the text of the icon view item. Normally you set the text of the item with setText(), but sometimes it's inconvenient to call setText() for every item; so you can subclass QIconViewItem, reimplement this function, and return the text of the item. If you do this, you must call calcRect() manually each time the text (and therefore its size) changes. +.PP +See also setText(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QRect QIconViewItem::textRect ( bool relative = TRUE ) const" +Returns the bounding rectangle of the item's text. +.PP +If \fIrelative\fR is TRUE, (the default), the returned rectangle is relative to the origin of the item's rectangle. If \fIrelative\fR is FALSE, the returned rectangle is relative to the origin of the icon view's contents coordinate system. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "int QIconViewItem::width () const" +Returns the width of the item. +.SH "int QIconViewItem::x () const" +Returns the x-coordinate of the item (in contents coordinates). +.SH "int QIconViewItem::y () const" +Returns the y-coordinate of the item (in contents coordinates). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qiconviewitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqiconviewitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimage.3qt b/doc/man/man3/tqimage.3qt new file mode 100644 index 000000000..95b7ce51f --- /dev/null +++ b/doc/man/man3/tqimage.3qt @@ -0,0 +1,1095 @@ +'\" t +.TH QImage 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 +QImage \- Hardware-independent pixmap representation with direct access to the pixel data +.SH SYNOPSIS +\fC#include <ntqimage.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBEndian\fR { IgnoreEndian, BigEndian, LittleEndian }" +.br +.ti -1c +.BI "\fBQImage\fR ()" +.br +.ti -1c +.BI "\fBQImage\fR ( int w, int h, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" +.br +.ti -1c +.BI "\fBQImage\fR ( const QSize & size, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" +.br +.ti -1c +.BI "\fBQImage\fR ( const QString & fileName, const char * format = 0 )" +.br +.ti -1c +.BI "\fBQImage\fR ( const char * const xpm[] )" +.br +.ti -1c +.BI "\fBQImage\fR ( const QByteArray & array )" +.br +.ti -1c +.BI "\fBQImage\fR ( uchar * yourdata, int w, int h, int depth, QRgb * colortable, int numColors, Endian bitOrder )" +.br +.ti -1c +.BI "\fBQImage\fR ( uchar * yourdata, int w, int h, int depth, int bpl, QRgb * colortable, int numColors, Endian bitOrder )" +.br +.ti -1c +.BI "\fBQImage\fR ( const QImage & image )" +.br +.ti -1c +.BI "\fB~QImage\fR ()" +.br +.ti -1c +.BI "QImage & \fBoperator=\fR ( const QImage & image )" +.br +.ti -1c +.BI "QImage & \fBoperator=\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QImage & i ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QImage & i ) const" +.br +.ti -1c +.BI "void \fBdetach\fR ()" +.br +.ti -1c +.BI "QImage \fBcopy\fR () const" +.br +.ti -1c +.BI "QImage \fBcopy\fR ( int x, int y, int w, int h, int conversion_flags = 0 ) const" +.br +.ti -1c +.BI "QImage \fBcopy\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "int \fBdepth\fR () const" +.br +.ti -1c +.BI "int \fBnumColors\fR () const" +.br +.ti -1c +.BI "Endian \fBbitOrder\fR () const" +.br +.ti -1c +.BI "QRgb \fBcolor\fR ( int i ) const" +.br +.ti -1c +.BI "void \fBsetColor\fR ( int i, QRgb c )" +.br +.ti -1c +.BI "void \fBsetNumColors\fR ( int numColors )" +.br +.ti -1c +.BI "bool \fBhasAlphaBuffer\fR () const" +.br +.ti -1c +.BI "void \fBsetAlphaBuffer\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBallGray\fR () const" +.br +.ti -1c +.BI "bool \fBisGrayscale\fR () const" +.br +.ti -1c +.BI "uchar * \fBbits\fR () const" +.br +.ti -1c +.BI "uchar * \fBscanLine\fR ( int i ) const" +.br +.ti -1c +.BI "uchar ** \fBjumpTable\fR () const" +.br +.ti -1c +.BI "QRgb * \fBcolorTable\fR () const" +.br +.ti -1c +.BI "int \fBnumBytes\fR () const" +.br +.ti -1c +.BI "int \fBbytesPerLine\fR () const" +.br +.ti -1c +.BI "bool \fBcreate\fR ( int width, int height, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" +.br +.ti -1c +.BI "bool \fBcreate\fR ( const QSize &, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" +.br +.ti -1c +.BI "void \fBreset\fR ()" +.br +.ti -1c +.BI "void \fBfill\fR ( uint pixel )" +.br +.ti -1c +.BI "void \fBinvertPixels\fR ( bool invertAlpha = TRUE )" +.br +.ti -1c +.BI "QImage \fBconvertDepth\fR ( int depth ) const" +.br +.ti -1c +.BI "QImage \fBconvertDepthWithPalette\fR ( int d, QRgb * palette, int palette_count, int conversion_flags = 0 ) const" +.br +.ti -1c +.BI "QImage \fBconvertDepth\fR ( int depth, int conversion_flags ) const" +.br +.ti -1c +.BI "QImage \fBconvertBitOrder\fR ( Endian bitOrder ) const" +.br +.ti -1c +.BI "enum \fBScaleMode\fR { ScaleFree, ScaleMin, ScaleMax }" +.br +.ti -1c +.BI "QImage \fBsmoothScale\fR ( int w, int h, ScaleMode mode = ScaleFree ) const" +.br +.ti -1c +.BI "QImage \fBsmoothScale\fR ( const QSize & s, ScaleMode mode = ScaleFree ) const" +.br +.ti -1c +.BI "QImage \fBscale\fR ( int w, int h, ScaleMode mode = ScaleFree ) const" +.br +.ti -1c +.BI "QImage \fBscale\fR ( const QSize & s, ScaleMode mode = ScaleFree ) const" +.br +.ti -1c +.BI "QImage \fBscaleWidth\fR ( int w ) const" +.br +.ti -1c +.BI "QImage \fBscaleHeight\fR ( int h ) const" +.br +.ti -1c +.BI "QImage \fBxForm\fR ( const QWMatrix & matrix ) const" +.br +.ti -1c +.BI "QImage \fBcreateAlphaMask\fR ( int conversion_flags = 0 ) const" +.br +.ti -1c +.BI "QImage \fBcreateHeuristicMask\fR ( bool clipTight = TRUE ) const" +.br +.ti -1c +.BI "QImage \fBmirror\fR () const" +.br +.ti -1c +.BI "QImage \fBmirror\fR ( bool horizontal, bool vertical ) const" +.br +.ti -1c +.BI "QImage \fBswapRGB\fR () const" +.br +.ti -1c +.BI "bool \fBload\fR ( const QString & fileName, const char * format = 0 )" +.br +.ti -1c +.BI "bool \fBloadFromData\fR ( const uchar * buf, uint len, const char * format = 0 )" +.br +.ti -1c +.BI "bool \fBloadFromData\fR ( QByteArray buf, const char * format = 0 )" +.br +.ti -1c +.BI "bool \fBsave\fR ( const QString & fileName, const char * format, int quality = -1 ) const" +.br +.ti -1c +.BI "bool \fBsave\fR ( QIODevice * device, const char * format, int quality = -1 ) const" +.br +.ti -1c +.BI "bool \fBvalid\fR ( int x, int y ) const" +.br +.ti -1c +.BI "int \fBpixelIndex\fR ( int x, int y ) const" +.br +.ti -1c +.BI "QRgb \fBpixel\fR ( int x, int y ) const" +.br +.ti -1c +.BI "void \fBsetPixel\fR ( int x, int y, uint index_or_rgb )" +.br +.ti -1c +.BI "int \fBdotsPerMeterX\fR () const" +.br +.ti -1c +.BI "int \fBdotsPerMeterY\fR () const" +.br +.ti -1c +.BI "void \fBsetDotsPerMeterX\fR ( int x )" +.br +.ti -1c +.BI "void \fBsetDotsPerMeterY\fR ( int y )" +.br +.ti -1c +.BI "QPoint \fBoffset\fR () const" +.br +.ti -1c +.BI "void \fBsetOffset\fR ( const QPoint & p )" +.br +.ti -1c +.BI "QValueList<QImageTextKeyLang> \fBtextList\fR () const" +.br +.ti -1c +.BI "QStringList \fBtextLanguages\fR () const" +.br +.ti -1c +.BI "QStringList \fBtextKeys\fR () const" +.br +.ti -1c +.BI "QString \fBtext\fR ( const char * key, const char * lang = 0 ) const" +.br +.ti -1c +.BI "QString \fBtext\fR ( const QImageTextKeyLang & kl ) const" +.br +.ti -1c +.BI "void \fBsetText\fR ( const char * key, const char * lang, const QString & s )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QImage \fBfromMimeSource\fR ( const QString & abs_name )" +.br +.ti -1c +.BI "Endian \fBsystemBitOrder\fR ()" +.br +.ti -1c +.BI "Endian \fBsystemByteOrder\fR ()" +.br +.ti -1c +.BI "const char * \fBimageFormat\fR ( const QString & fileName )" +.br +.ti -1c +.BI "QStrList \fBinputFormats\fR ()" +.br +.ti -1c +.BI "QStrList \fBoutputFormats\fR ()" +.br +.ti -1c +.BI "QStringList \fBinputFormatList\fR ()" +.br +.ti -1c +.BI "QStringList \fBoutputFormatList\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QImage & image )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QImage & image )" +.br +.ti -1c +.BI "void \fBbitBlt\fR ( QImage * dst, int dx, int dy, const QImage * src, int sx, int sy, int sw, int sh, int conversion_flags )" +.br +.in -1c +.SH DESCRIPTION +The QImage class provides a hardware-independent pixmap representation with direct access to the pixel data. +.PP +It is one of the two classes Qt provides for dealing with images, the other being QPixmap. QImage is designed and optimized for I/O and for direct pixel access/manipulation. QPixmap is designed and optimized for drawing. There are (slow) functions to convert between QImage and QPixmap: QPixmap::convertToImage() and QPixmap::convertFromImage(). +.PP +An image has the parameters width, height and depth (bits per pixel, bpp), a color table and the actual pixels. QImage supports 1-bpp, 8-bpp and 32-bpp image data. 1-bpp and 8-bpp images use a color lookup table; the pixel value is a color table index. +.PP +32-bpp images encode an RGB value in 24 bits and ignore the color table. The most significant byte is used for the alpha buffer. +.PP +An entry in the color table is an RGB triplet encoded as a \fCuint\fR. Use the tqRed(), tqGreen() and tqBlue() functions (ntqcolor.h) to access the components, and tqRgb to make an RGB triplet (see the QColor class documentation). +.PP +1-bpp (monochrome) images have a color table with a most two colors. There are two different formats: big endian (MSB first) or little endian (LSB first) bit order. To access a single bit you will must do some bit shifts: +.PP +.nf +.br + QImage image; +.br + // sets bit at (x,y) to 1 +.br + if ( image.bitOrder() == QImage::LittleEndian ) +.br + *(image.scanLine(y) + (x >> 3)) |= 1 << (x & 7); +.br + else +.br + *(image.scanLine(y) + (x >> 3)) |= 1 << (7 - (x & 7)); +.br +.fi +.PP +If this looks complicated, it might be a good idea to convert the 1-bpp image to an 8-bpp image using convertDepth(). +.PP +8-bpp images are much easier to work with than 1-bpp images because they have a single byte per pixel: +.PP +.nf +.br + QImage image; +.br + // set entry 19 in the color table to yellow +.br + image.setColor( 19, tqRgb(255,255,0) ); +.br + // set 8 bit pixel at (x,y) to value yellow (in color table) +.br + *(image.scanLine(y) + x) = 19; +.br +.fi +.PP +32-bpp images ignore the color table; instead, each pixel contains the RGB triplet. 24 bits contain the RGB value; the most significant byte is reserved for the alpha buffer. +.PP +.nf +.br + QImage image; +.br + // sets 32 bit pixel at (x,y) to yellow. +.br + uint *p = (uint *)image.scanLine(y) + x; +.br + *p = tqRgb(255,255,0); +.br +.fi +.PP +On Qt/Embedded, scanlines are aligned to the pixel depth and may be padded to any degree, while on all other platforms, the scanlines are 32-bit aligned for all depths. The constructor taking a \fCuchar*\fR argument always expects 32-bit aligned data. On Qt/Embedded, an additional constructor allows the number of bytes-per-line to be specified. +.PP +QImage supports a variety of methods for getting information about the image, for example, colorTable(), allGray(), isGrayscale(), bitOrder(), bytesPerLine(), depth(), dotsPerMeterX() and dotsPerMeterY(), hasAlphaBuffer(), numBytes(), numColors(), and width() and height(). +.PP +Pixel colors are retrieved with pixel() and set with setPixel(). +.PP +QImage also supports a number of functions for creating a new image that is a transformed version of the original. For example, copy(), convertBitOrder(), convertDepth(), createAlphaMask(), createHeuristicMask(), mirror(), scale(), smoothScale(), swapRGB() and xForm(). There are also functions for changing attributes of an image in-place, for example, setAlphaBuffer(), setColor(), setDotsPerMeterX() and setDotsPerMeterY() and setNumColors(). +.PP +Images can be loaded and saved in the supported formats. Images are saved to a file with save(). Images are loaded from a file with load() (or in the constructor) or from an array of data with loadFromData(). The lists of supported formats are available from inputFormatList() and outputFormatList(). +.PP +Strings of text may be added to images using setText(). +.PP +The QImage class uses explicit sharing, similar to that used by QMemArray. +.PP +New image formats can be added as plugins. +.PP +See also QImageIO, QPixmap, Shared Classes, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SS "Member Type Documentation" +.SH "QImage::Endian" +This enum type is used to describe the endianness of the CPU and graphics hardware. +.TP +\fCQImage::IgnoreEndian\fR - Endianness does not matter. Useful for some operations that are independent of endianness. +.TP +\fCQImage::BigEndian\fR - Network byte order, as on SPARC and Motorola CPUs. +.TP +\fCQImage::LittleEndian\fR - PC/Alpha byte order. +.SH "QImage::ScaleMode" +The functions scale() and smoothScale() use different modes for scaling the image. The purpose of these modes is to retain the ratio of the image if this is required. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.TP +\fCQImage::ScaleFree\fR - The image is scaled freely: the resulting image fits exactly into the specified size; the ratio will not necessarily be preserved. +.TP +\fCQImage::ScaleMin\fR - The ratio of the image is preserved and the resulting image is guaranteed to fit into the specified size (it is as large as possible within these constraints) - the image might be smaller than the requested size. +.TP +\fCQImage::ScaleMax\fR - The ratio of the image is preserved and the resulting image fills the whole specified rectangle (it is as small as possible within these constraints) - the image might be larger than the requested size. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QImage::QImage ()" +Constructs a null image. +.PP +See also isNull(). +.SH "QImage::QImage ( int w, int h, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" +Constructs an image with \fIw\fR width, \fIh\fR height, \fIdepth\fR bits per pixel, \fInumColors\fR colors and bit order \fIbitOrder\fR. +.PP +Using this constructor is the same as first constructing a null image and then calling the create() function. +.PP +See also create(). +.SH "QImage::QImage ( const QSize & size, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" +Constructs an image with size \fIsize\fR pixels, depth \fIdepth\fR bits, \fInumColors\fR and \fIbitOrder\fR endianness. +.PP +Using this constructor is the same as first constructing a null image and then calling the create() function. +.PP +See also create(). +.SH "QImage::QImage ( const QString & fileName, const char * format = 0 )" +Constructs an image and tries to load the image from the file \fIfileName\fR. +.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 +If the loading of the image failed, this object is a null image. +.PP +The QImageIO documentation lists the supported image formats and explains how to add extra formats. +.PP +See also load(), isNull(), and QImageIO. +.SH "QImage::QImage ( const char * const xpm[] )" +Constructs an image from \fIxpm\fR, which must be a valid XPM image. +.PP +Errors are silently ignored. +.PP +Note that it's possible to squeeze the XPM variable a little bit by using an unusual declaration: +.PP +.nf +.br + static const char * const start_xpm[]={ +.br + "16 15 8 1", +.br + "a c #cec6bd", +.br + .... +.br +.fi +.PP +The extra \fCconst\fR makes the entire definition read-only, which is slightly more efficient (e.g. when the code is in a shared library) and ROMable when the application is to be stored in ROM. +.SH "QImage::QImage ( const QByteArray & array )" +Constructs an image from the binary data \fIarray\fR. It tries to guess the file format. +.PP +If the loading of the image failed, this object is a null image. +.PP +See also loadFromData(), isNull(), and imageFormat(). +.SH "QImage::QImage ( uchar * yourdata, int w, int h, int depth, QRgb * colortable, int numColors, Endian bitOrder )" +Constructs an image \fIw\fR pixels wide, \fIh\fR pixels high with a color depth of \fIdepth\fR, that uses an existing memory buffer, \fIyourdata\fR. The buffer must remain valid throughout the life of the QImage. The image does not delete the buffer at destruction. +.PP +If \fIcolortable\fR is 0, a color table sufficient for \fInumColors\fR will be allocated (and destructed later). +.PP +Note that \fIyourdata\fR must be 32-bit aligned. +.PP +The endianness is given in \fIbitOrder\fR. +.SH "QImage::QImage ( uchar * yourdata, int w, int h, int depth, int bpl, QRgb * colortable, int numColors, Endian bitOrder )" +Constructs an image that uses an existing memory buffer. The buffer must remain valid for the life of the QImage. The image does not delete the buffer at destruction. The buffer is passed as \fIyourdata\fR. The image's width is \fIw\fR and its height is \fIh\fR. The color depth is \fIdepth\fR. \fIbpl\fR specifies the number of bytes per line. +.PP +If \fIcolortable\fR is 0, a color table sufficient for \fInumColors\fR will be allocated (and destructed later). +.PP +The endianness is specified by \fIbitOrder\fR. +.PP +\fBWarning:\fR This constructor is only available on Qt/Embedded. +.SH "QImage::QImage ( const QImage & image )" +Constructs a shallow copy of \fIimage\fR. +.SH "QImage::~QImage ()" +Destroys the image and cleans up. +.SH "bool QImage::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. +.PP +This function is slow for large 16-bit (Qt/Embedded only) and 32-bit images. +.PP +See also isGrayscale(). +.SH "Endian QImage::bitOrder () const" +Returns the bit order for the image. +.PP +If it is a 1-bpp image, this function returns either QImage::BigEndian or QImage::LittleEndian. +.PP +If it is not a 1-bpp image, this function returns QImage::IgnoreEndian. +.PP +See also depth(). +.SH "uchar * QImage::bits () const" +Returns a pointer to the first pixel data. This is equivalent to scanLine(0). +.PP +See also numBytes(), scanLine(), and jumpTable(). +.PP +Example: opengl/texture/gltexobj.cpp. +.SH "int QImage::bytesPerLine () const" +Returns the number of bytes per image scanline. This is equivalent to numBytes()/height(). +.PP +See also numBytes() and scanLine(). +.SH "QRgb QImage::color ( int i ) const" +Returns the color in the color table at index \fIi\fR. The first color is at index 0. +.PP +A color value is an RGB triplet. Use the tqRed(), tqGreen() and tqBlue() functions (defined in ntqcolor.h) to get the color value components. +.PP +See also setColor(), numColors(), and QColor. +.PP +Example: themes/wood.cpp. +.SH "QRgb * QImage::colorTable () const" +Returns a pointer to the color table. +.PP +See also numColors(). +.SH "QImage QImage::convertBitOrder ( Endian bitOrder ) const" +Converts the bit order of the image to \fIbitOrder\fR and returns the converted image. The original image is not changed. +.PP +Returns \fC*this\fR if the \fIbitOrder\fR is equal to the image bit order, or a null image if this image cannot be converted. +.PP +See also bitOrder(), systemBitOrder(), and isNull(). +.SH "QImage QImage::convertDepth ( int depth, int conversion_flags ) const" +Converts the depth (bpp) of the image to \fIdepth\fR and returns the converted image. The original image is not changed. +.PP +The \fIdepth\fR argument must be 1, 8, 16 (Qt/Embedded only) or 32. +.PP +Returns \fC*this\fR if \fIdepth\fR is equal to the image depth, or a null image if this image cannot be converted. +.PP +If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. +.PP +See also Qt::ImageConversionFlags, depth(), and isNull(). +.SH "QImage QImage::convertDepth ( int depth ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QImage QImage::convertDepthWithPalette ( int d, QRgb * palette, int palette_count, int conversion_flags = 0 ) const" +Returns an image with depth \fId\fR, using the \fIpalette_count\fR colors pointed to by \fIpalette\fR. If \fId\fR is 1 or 8, the returned image will have its color table ordered the same as \fIpalette\fR. +.PP +If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. +.PP +Note: currently no closest-color search is made. If colors are found that are not in the palette, the palette may not be used at all. This result should not be considered valid because it may change in future implementations. +.PP +Currently inefficient for non-32-bit images. +.PP +See also Qt::ImageConversionFlags. +.SH "QImage QImage::copy () const" +Returns a deep copy of the image. +.PP +See also detach(). +.SH "QImage QImage::copy ( int x, int y, int w, int h, int conversion_flags = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a deep copy of a sub-area of the image. +.PP +The returned image is always \fIw\fR by \fIh\fR pixels in size, and is copied from position \fIx\fR, \fIy\fR in this image. In areas beyond this image pixels are filled with pixel 0. +.PP +If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. +.PP +See also bitBlt() and Qt::ImageConversionFlags. +.SH "QImage QImage::copy ( const QRect & r ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +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 QImage::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. +.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 QImage::LittleEndian or QImage::BigEndian. For other depths \fIbitOrder\fR must be QImage::IgnoreEndian. +.PP +This function allocates a color table and a buffer for the image data. The image data is not initialized. +.PP +The image buffer is allocated as a single block that consists of a table of scanline pointers (jumpTable()) and the image data (bits()). +.PP +See also fill(), width(), height(), depth(), numColors(), bitOrder(), jumpTable(), scanLine(), bits(), bytesPerLine(), and numBytes(). +.SH "bool QImage::create ( const QSize &, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QImage QImage::createAlphaMask ( int conversion_flags = 0 ) const" +Builds and returns a 1-bpp mask from the alpha buffer in this image. Returns a null image if alpha buffer mode is disabled. +.PP +See QPixmap::convertFromImage() for a description of the \fIconversion_flags\fR argument. +.PP +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 "QImage QImage::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. +.PP +This function disregards the alpha buffer. +.PP +See also createAlphaMask(). +.SH "int QImage::depth () const" +Returns the depth of the image. +.PP +The image depth is the number of bits used to encode a single pixel, also called bits per pixel (bpp) or bit planes of an image. +.PP +The supported depths are 1, 8, 16 (Qt/Embedded only) and 32. +.PP +See also convertDepth(). +.SH "void QImage::detach ()" +Detaches from shared image data and makes sure that this image is the only one referring to the data. +.PP +If multiple images share common data, this image makes a copy of the data and detaches itself from the sharing mechanism. Nothing is done if there is just a single reference. +.PP +See also copy(). +.PP +Example: themes/wood.cpp. +.SH "int QImage::dotsPerMeterX () const" +Returns the number of pixels that fit horizontally in a physical meter. This and dotsPerMeterY() define the intended scale and aspect ratio of the image. +.PP +See also setDotsPerMeterX(). +.SH "int QImage::dotsPerMeterY () const" +Returns the number of pixels that fit vertically in a physical meter. This and dotsPerMeterX() define the intended scale and aspect ratio of the image. +.PP +See also setDotsPerMeterY(). +.SH "void QImage::fill ( uint pixel )" +Fills the entire image with the pixel value \fIpixel\fR. +.PP +If the depth of this image is 1, only the lowest bit is used. If you say fill(0), fill(2), etc., the image is filled with 0s. If you say fill(1), fill(3), etc., the image is filled with 1s. If the depth is 8, the lowest 8 bits are used. +.PP +If the depth is 32 and the image has no alpha buffer, the \fIpixel\fR value is written to each pixel in the image. If the image has an alpha buffer, only the 24 RGB bits are set and the upper 8 bits (alpha value) are left unchanged. +.PP +Note: QImage::pixel() returns the color of the pixel at the given coordinates; QColor::pixel() returns the pixel value of the underlying window system (essentially an index value), so normally you will want to use QImage::pixel() to use a color from an existing image or QColor::rgb() to use a specific color. +.PP +See also invertPixels(), depth(), hasAlphaBuffer(), and create(). +.SH "QImage QImage::fromMimeSource ( const QString & abs_name )\fC [static]\fR" +Convenience function. Gets the data associated with the absolute name \fIabs_name\fR from the default mime source factory and decodes it to an image. +.PP +See also QMimeSourceFactory, QImage::fromMimeSource(), and QImageDrag::decode(). +.SH "bool QImage::hasAlphaBuffer () const" +Returns TRUE if alpha buffer mode is enabled; otherwise returns FALSE. +.PP +See also setAlphaBuffer(). +.SH "int QImage::height () const" +Returns the height of the image. +.PP +See also width(), size(), and rect(). +.PP +Examples: +.)l canvas/canvas.cpp and opengl/texture/gltexobj.cpp. +.SH "const char * QImage::imageFormat ( const QString & fileName )\fC [static]\fR" +Returns a string that specifies the image format of the file \fIfileName\fR, or 0 if the file cannot be read or if the format is not recognized. +.PP +The QImageIO documentation lists the guaranteed supported image formats, or use QImage::inputFormats() and QImage::outputFormats() to get lists that include the installed formats. +.PP +See also load() and save(). +.SH "QStringList QImage::inputFormatList ()\fC [static]\fR" +Returns a list of image formats that are supported for image input. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myImage.inputFormatList(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also outputFormatList(), inputFormats(), and QImageIO. +.PP +Example: showimg/showimg.cpp. +.SH "QStrList QImage::inputFormats ()\fC [static]\fR" +Returns a list of image formats that are supported for image input. +.PP +See also outputFormats(), inputFormatList(), and QImageIO. +.SH "void QImage::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. +.PP +If the depth is not 32, the argument \fIinvertAlpha\fR has no meaning. +.PP +Note that inverting an 8-bit image means to replace all pixels using color index \fIi\fR with a pixel using color index 255 minus \fIi\fR. Similarly for a 1-bit image. The color table is not changed. +.PP +See also fill(), depth(), and hasAlphaBuffer(). +.SH "bool QImage::isGrayscale () const" +For 16-bit (Qt/Embedded only) and 32-bit images, this function is equivalent to allGray(). +.PP +For 8-bpp images, this function returns TRUE if color(i) is QRgb(i,i,i) for all indices of the color table; otherwise returns FALSE. +.PP +See also allGray() and depth(). +.SH "bool QImage::isNull () const" +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 +Example: showimg/showimg.cpp. +.SH "uchar ** QImage::jumpTable () const" +Returns a pointer to the scanline pointer table. +.PP +This is the beginning of the data block for the image. +.PP +See also bits() and scanLine(). +.SH "bool QImage::load ( const QString & fileName, const char * format = 0 )" +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 +The QImageIO documentation lists the supported image formats and explains how to add extra formats. +.PP +See also loadFromData(), save(), imageFormat(), QPixmap::load(), and QImageIO. +.SH "bool QImage::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. +.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 +The QImageIO documentation lists the supported image formats and explains how to add extra formats. +.PP +See also load(), save(), imageFormat(), QPixmap::loadFromData(), and QImageIO. +.SH "bool QImage::loadFromData ( QByteArray buf, const char * format = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Loads an image from the QByteArray \fIbuf\fR. +.SH "QImage QImage::mirror () const" +Returns a QImage which is a vertically mirrored copy of this image. The original QImage is not changed. +.SH "QImage QImage::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. +.PP +See also smoothScale(). +.SH "int QImage::numBytes () const" +Returns the number of bytes occupied by the image data. +.PP +See also bytesPerLine() and bits(). +.SH "int QImage::numColors () const" +Returns the size of the color table for the image. +.PP +Notice that numColors() returns 0 for 16-bpp (Qt/Embedded only) and 32-bpp images because these images do not use color tables, but instead encode pixel values as RGB triplets. +.PP +See also setNumColors() and colorTable(). +.PP +Example: themes/wood.cpp. +.SH "QPoint QImage::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 QImage::operator!= ( const QImage & 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. +.PP +See also operator=(). +.SH "QImage & QImage::operator= ( const QImage & image )" +Assigns a shallow copy of \fIimage\fR to this image and returns a reference to this image. +.PP +See also copy(). +.SH "QImage & QImage::operator= ( const QPixmap & pixmap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the image bits to the \fIpixmap\fR contents and returns a reference to the image. +.PP +If the image shares data with other images, it will first dereference the shared data. +.PP +Makes a call to QPixmap::convertToImage(). +.SH "bool QImage::operator== ( const QImage & 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. +.PP +See also operator=(). +.SH "QStringList QImage::outputFormatList ()\fC [static]\fR" +Returns a list of image formats that are supported for image output. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myImage.outputFormatList(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also inputFormatList(), outputFormats(), and QImageIO. +.SH "QStrList QImage::outputFormats ()\fC [static]\fR" +Returns a list of image formats that are supported for image output. +.PP +See also inputFormats(), outputFormatList(), and QImageIO. +.PP +Example: showimg/showimg.cpp. +.SH "QRgb QImage::pixel ( int x, int y ) const" +Returns the color of the pixel at the coordinates (\fIx\fR, \fIy\fR). +.PP +If (\fIx\fR, \fIy\fR) is not on the image, the results are undefined. +.PP +See also setPixel(), tqRed(), tqGreen(), tqBlue(), and valid(). +.PP +Examples: +.)l canvas/canvas.cpp and qmag/qmag.cpp. +.SH "int QImage::pixelIndex ( int x, int y ) const" +Returns the pixel index at the given coordinates. +.PP +If (\fIx\fR, \fIy\fR) is not valid, or if the image is not a paletted image (depth() > 8), the results are undefined. +.PP +See also valid() and depth(). +.SH "QRect QImage::rect () const" +Returns the enclosing rectangle (0, 0, width(), height()) of the image. +.PP +See also width(), height(), and size(). +.SH "void QImage::reset ()" +Resets all image parameters and deallocates the image data. +.SH "bool QImage::save ( const QString & 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. +.PP +See also load(), loadFromData(), imageFormat(), QPixmap::save(), and QImageIO. +.SH "bool QImage::save ( QIODevice * device, const char * format, int quality = -1 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function writes a QImage to the QIODevice, \fIdevice\fR. This can be used, for example, to save an image directly into a QByteArray: +.PP +.nf +.br + QImage image; +.br + QByteArray ba; +.br + QBuffer buffer( ba ); +.br + buffer.open( IO_WriteOnly ); +.br + image.save( &buffer, "PNG" ); // writes image into ba in PNG format +.br +.fi +.SH "QImage QImage::scale ( int w, int h, ScaleMode mode = ScaleFree ) const" +Returns a copy of the image scaled to a rectangle of width \fIw\fR and height \fIh\fR according to the ScaleMode \fImode\fR. +.TP +If \fImode\fR is ScaleFree, the image is scaled to (\fIw\fR, \fIh\fR). +.TP +If \fImode\fR is ScaleMin, the image is scaled to a rectangle as large as possible inside (\fIw\fR, \fIh\fR), preserving the aspect ratio. +.TP +If \fImode\fR is ScaleMax, the image is scaled to a rectangle as small as possible outside (\fIw\fR, \fIh\fR), preserving the aspect ratio. +.PP +If either the width \fIw\fR or the height \fIh\fR is 0 or negative, this function returns a null image. +.PP +This function uses a simple, fast algorithm. If you need better quality, use smoothScale() instead. +.PP +See also scaleWidth(), scaleHeight(), smoothScale(), and xForm(). +.SH "QImage QImage::scale ( const QSize & s, ScaleMode mode = ScaleFree ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The requested size of the image is \fIs\fR. +.SH "QImage QImage::scaleHeight ( int h ) const" +Returns a scaled copy of the image. The returned image has a height of \fIh\fR pixels. This function automatically calculates the width of the image so that the ratio of the image is preserved. +.PP +If \fIh\fR is 0 or negative a null image is returned. +.PP +See also scale(), scaleWidth(), smoothScale(), and xForm(). +.PP +Example: table/small-table-demo/main.cpp. +.SH "QImage QImage::scaleWidth ( int w ) const" +Returns a scaled copy of the image. The returned image has a width of \fIw\fR pixels. This function automatically calculates the height of the image so that the ratio of the image is preserved. +.PP +If \fIw\fR is 0 or negative a null image is returned. +.PP +See also scale(), scaleHeight(), smoothScale(), and xForm(). +.SH "uchar * QImage::scanLine ( int i ) const" +Returns a pointer to the pixel data at the scanline with index \fIi\fR. The first scanline is at index 0. +.PP +The scanline data is aligned on a 32-bit boundary. +.PP +\fBWarning:\fR If you are accessing 32-bpp image data, cast the returned pointer to \fCQRgb*\fR (QRgb has a 32-bit size) and use it to read/write the pixel value. You cannot use the \fCuchar*\fR pointer directly, because the pixel format depends on the byte order on the underlying platform. Hint: use tqRed(), tqGreen() and tqBlue(), etc. (ntqcolor.h) to access the pixels. +.PP +\fBWarning:\fR If you are accessing 16-bpp image data, you must handle endianness yourself. (Qt/Embedded only) +.PP +See also bytesPerLine(), bits(), and jumpTable(). +.PP +Example: desktop/desktop.cpp. +.SH "void QImage::setAlphaBuffer ( bool enable )" +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 +This 32-bit value is encoded as follows: The lower 24 bits are used for the red, green, and blue components. The upper 8 bits contain the alpha component. +.PP +The alpha component specifies the transparency of a pixel. 0 means completely transparent and 255 means opaque. The alpha component is ignored if you do not enable alpha buffer mode. +.PP +The alpha buffer is used to set a mask when a QImage is translated to a QPixmap. +.PP +See also hasAlphaBuffer() and createAlphaMask(). +.SH "void QImage::setColor ( int i, QRgb c )" +Sets a color in the color table at index \fIi\fR to \fIc\fR. +.PP +A color value is an RGB triplet. Use the tqRgb() function (defined in ntqcolor.h) to make RGB triplets. +.PP +See also color(), setNumColors(), and numColors(). +.PP +Examples: +.)l desktop/desktop.cpp and themes/wood.cpp. +.SH "void QImage::setDotsPerMeterX ( int x )" +Sets the value returned by dotsPerMeterX() to \fIx\fR. +.SH "void QImage::setDotsPerMeterY ( int y )" +Sets the value returned by dotsPerMeterY() to \fIy\fR. +.SH "void QImage::setNumColors ( int numColors )" +Resizes the color table to \fInumColors\fR colors. +.PP +If the color table is expanded all the extra colors will be set to black (RGB 0,0,0). +.PP +See also numColors(), color(), setColor(), and colorTable(). +.SH "void QImage::setOffset ( const QPoint & p )" +Sets the value returned by offset() to \fIp\fR. +.SH "void QImage::setPixel ( int x, int y, uint index_or_rgb )" +Sets the pixel index or color at the coordinates (\fIx\fR, \fIy\fR) to \fIindex_or_rgb\fR. +.PP +If (\fIx\fR, \fIy\fR) is not valid, the result is undefined. +.PP +If the image is a paletted image (depth() <= 8) and \fIindex_or_rgb\fR >= numColors(), the result is undefined. +.PP +See also pixelIndex(), pixel(), tqRgb(), tqRgba(), and valid(). +.SH "void QImage::setText ( const char * key, const char * lang, const QString & s )" +Records string \fIs\fR for the keyword \fIkey\fR. The \fIkey\fR should be a portable keyword recognizable by other software - some suggested values can be found in the PNG specification. \fIs\fR can be any text. \fIlang\fR should specify the language code (see RFC 1766) or 0. +.SH "QSize QImage::size () const" +Returns the size of the image, i.e. its width and height. +.PP +See also width(), height(), and rect(). +.SH "QImage QImage::smoothScale ( int w, int h, ScaleMode mode = ScaleFree ) const" +Returns a smoothly scaled copy of the image. The returned image has a size of width \fIw\fR by height \fIh\fR pixels if \fImode\fR is ScaleFree. The modes ScaleMin and ScaleMax may be used to preserve the ratio of the image: if \fImode\fR is ScaleMin, the returned image is guaranteed to fit into the rectangle specified by \fIw\fR and \fIh\fR (it is as large as possible within the constraints); if \fImode\fR is ScaleMax, the returned image fits at least into the specified rectangle (it is a small as possible within the constraints). +.PP +For 32-bpp images and 1-bpp/8-bpp color images the result will be 32-bpp, whereas all-gray images (including black-and-white 1-bpp) will produce 8-bit grayscale images with the palette spanning 256 grays from black to white. +.PP +This function uses code based on pnmscale.c by Jef Poskanzer. +.PP +pnmscale.c - read a portable anymap and scale it +.PP +Copyright (C) 1989, 1991 by Jef Poskanzer. +.PP +Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. This software is provided "as is" without express or implied warranty. +.PP +See also scale() and mirror(). +.SH "QImage QImage::smoothScale ( const QSize & s, ScaleMode mode = ScaleFree ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The requested size of the image is \fIs\fR. +.SH "QImage QImage::swapRGB () const" +Returns a QImage in which the values of the red and blue components of all pixels have been swapped, effectively converting an RGB image to a BGR image. The original QImage is not changed. +.SH "Endian QImage::systemBitOrder ()\fC [static]\fR" +Determines the bit order of the display hardware. Returns QImage::LittleEndian (LSB first) or QImage::BigEndian (MSB first). +.PP +See also systemByteOrder(). +.SH "Endian QImage::systemByteOrder ()\fC [static]\fR" +Determines the host computer byte order. Returns QImage::LittleEndian (LSB first) or QImage::BigEndian (MSB first). +.PP +See also systemBitOrder(). +.SH "QString QImage::text ( const char * key, const char * lang = 0 ) const" +Returns the string recorded for the keyword \fIkey\fR in language \fIlang\fR, or in a default language if \fIlang\fR is 0. +.SH "QString QImage::text ( const QImageTextKeyLang & kl ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the string recorded for the keyword and language \fIkl\fR. +.SH "QStringList QImage::textKeys () const" +Returns the keywords for which some texts are recorded. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myImage.textKeys(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also textList(), text(), setText(), and textLanguages(). +.SH "QStringList QImage::textLanguages () const" +Returns the language identifiers for which some texts are recorded. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myImage.textLanguages(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also textList(), text(), setText(), and textKeys(). +.SH "QValueList<QImageTextKeyLang> QImage::textList () const" +Returns a list of QImageTextKeyLang objects that enumerate all the texts key/language pairs set by setText() for this image. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<QImageTextKeyLang> list = myImage.textList(); +.br + QValueList<QImageTextKeyLang>::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "bool QImage::valid ( int x, int y ) const" +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 +Examples: +.)l canvas/canvas.cpp and qmag/qmag.cpp. +.SH "int QImage::width () const" +Returns the width of the image. +.PP +See also height(), size(), and rect(). +.PP +Examples: +.)l canvas/canvas.cpp and opengl/texture/gltexobj.cpp. +.SH "QImage QImage::xForm ( const QWMatrix & matrix ) const" +Returns a copy of the image that is transformed using the transformation matrix, \fImatrix\fR. +.PP +The transformation \fImatrix\fR is internally adjusted to compensate for unwanted translation, i.e. xForm() returns the smallest image that contains all the transformed points of the original image. +.PP +See also scale(), QPixmap::xForm(), QPixmap::trueMatrix(), and QWMatrix. +.SH RELATED FUNCTION DOCUMENTATION +.SH "void bitBlt ( QImage * dst, int dx, int dy, const QImage * src, int sx, int sy, int sw, int sh, int conversion_flags )" +Copies a block of pixels from \fIsrc\fR to \fIdst\fR. The pixels copied from source (src) are converted according to \fIconversion_flags\fR if it is incompatible with the destination (\fIdst\fR). +.PP +\fIsx\fR, \fIsy\fR is the top-left pixel in \fIsrc\fR, \fIdx\fR, \fIdy\fR is the top-left position in \fIdst\fR and \fIsw\fR, \\sh is the size of the copied block. +.PP +The copying is clipped if areas outside \fIsrc\fR or \fIdst\fR are specified. +.PP +If \fIsw\fR is -1, it is adjusted to src->width(). Similarly, if \fIsh\fR is -1, it is adjusted to src->height(). +.PP +Currently inefficient for non 32-bit images. +.SH "QDataStream & operator<< ( QDataStream & s, const QImage & image )" +Writes the image \fIimage\fR to the stream \fIs\fR as a PNG image, or as a BMP image if the stream's version is 1. +.PP +Note that writing the stream to a file will not produce a valid image file. +.PP +See also QImage::save() and Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QImage & image )" +Reads an image from the stream \fIs\fR and stores it in \fIimage\fR. +.PP +See also QImage::load() and Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqimage.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimage.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimageconsumer.3qt b/doc/man/man3/tqimageconsumer.3qt new file mode 100644 index 000000000..59c8a1415 --- /dev/null +++ b/doc/man/man3/tqimageconsumer.3qt @@ -0,0 +1,108 @@ +'\" t +.TH QImageConsumer 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 +QImageConsumer \- Abstraction used by QImageDecoder +.SH SYNOPSIS +\fC#include <ntqasyncimageio.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual void \fBend\fR () = 0" +.br +.ti -1c +.BI "virtual void \fBchanged\fR ( const QRect & ) = 0" +.br +.ti -1c +.BI "virtual void \fBframeDone\fR () = 0" +.br +.ti -1c +.BI "virtual void \fBframeDone\fR ( const QPoint & offset, const QRect & rect ) = 0" +.br +.ti -1c +.BI "virtual void \fBsetLooping\fR ( int n ) = 0" +.br +.ti -1c +.BI "virtual void \fBsetFramePeriod\fR ( int milliseconds ) = 0" +.br +.ti -1c +.BI "virtual void \fBsetSize\fR ( int, int ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QImageConsumer class is an abstraction used by QImageDecoder. +.PP +The QMovie class, or QLabel::setMovie(), are easy to use and for most situations do what you want with regards animated images. +.PP +A QImageConsumer consumes information about changes to the QImage maintained by a QImageDecoder. Think of the QImage as the model or source of the image data, with the QImageConsumer as a view of that data and the QImageDecoder being the controller that orchestrates the relationship between the model and the view. +.PP +You'd use the QImageConsumer class, for example, if you were implementing a web browser with your own image loaders. +.PP +See also QImageDecoder, Graphics Classes, Image Processing Classes, and Multimedia Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "void QImageConsumer::changed ( const QRect & )\fC [pure virtual]\fR" +Called when the given area of the image has changed. +.SH "void QImageConsumer::end ()\fC [pure virtual]\fR" +Called when all the data from all the frames has been decoded and revealed as changed(). +.SH "void QImageConsumer::frameDone ()\fC [pure virtual]\fR" +One of the two frameDone() functions will be called when a frame of an animated image has ended and been revealed as changed(). +.PP +When this function is called, the current image should be displayed. +.PP +The decoder will not make any further changes to the image until the next call to QImageFormat::decode(). +.SH "void QImageConsumer::frameDone ( const QPoint & offset, const QRect & rect )\fC [pure virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +One of the two frameDone() functions will be called when a frame of an animated image has ended and been revealed as changed(). +.PP +When this function is called, the area \fIrect\fR in the current image should be moved by \fIoffset\fR and displayed. +.PP +The decoder will not make any further changes to the image until the next call to QImageFormat::decode(). +.SH "void QImageConsumer::setFramePeriod ( int milliseconds )\fC [pure virtual]\fR" +Notes that the frame about to be decoded should not be displayed until the given number of \fImilliseconds\fR after the time that this function is called. Of course, the image may not have been decoded by then, in which case the frame should not be displayed until it is complete. A value of -1 (the assumed default) indicates that the image should be displayed even while it is only partially loaded. +.SH "void QImageConsumer::setLooping ( int n )\fC [pure virtual]\fR" +Called to indicate that the sequence of frames in the image should be repeated \fIn\fR times, including the sequence during decoding. +.TP +0 = Forever +.TP +1 = Only display frames the first time through +.TP +2 = Repeat once after first pass through images +.TP +etc. +.PP +To make the QImageDecoder do this, just delete it and pass the information to it again for decoding (setLooping() will be called again, of course, but that can be ignored), or keep copies of the changed areas at the ends of frames. +.SH "void QImageConsumer::setSize ( int, int )\fC [pure virtual]\fR" +This function is called as soon as the size of the image has been +determined. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimageconsumer.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimageconsumer.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimagedecoder.3qt b/doc/man/man3/tqimagedecoder.3qt new file mode 100644 index 000000000..bd8957eee --- /dev/null +++ b/doc/man/man3/tqimagedecoder.3qt @@ -0,0 +1,111 @@ +'\" t +.TH QImageDecoder 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 +QImageDecoder \- Incremental image decoder for all supported image formats +.SH SYNOPSIS +\fC#include <ntqasyncimageio.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQImageDecoder\fR ( QImageConsumer * c )" +.br +.ti -1c +.BI "\fB~QImageDecoder\fR ()" +.br +.ti -1c +.BI "const QImage & \fBimage\fR ()" +.br +.ti -1c +.BI "int \fBdecode\fR ( const uchar * buffer, int length )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "const char * \fBformatName\fR ( const uchar * buffer, int length )" +.br +.ti -1c +.BI "QImageFormatType * \fBformat\fR ( const char * name )" +.br +.ti -1c +.BI "QStrList \fBinputFormats\fR ()" +.br +.ti -1c +.BI "void \fBregisterDecoderFactory\fR ( QImageFormatType * f )" +.br +.ti -1c +.BI "void \fBunregisterDecoderFactory\fR ( QImageFormatType * f )" +.br +.in -1c +.SH DESCRIPTION +The QImageDecoder class is an incremental image decoder for all supported image formats. +.PP +New formats are installed by creating objects of class QImageFormatType; the QMovie class can be used for all installed incremental image formats. QImageDecoder is only useful for creating new ways of feeding data to an QImageConsumer. +.PP +A QImageDecoder is a machine that decodes images. It takes encoded image data via its decode() method and expresses its decoding by supplying information to a QImageConsumer. It implements its decoding by using a QImageFormat created by one of the currently-existing QImageFormatType factory objects. +.PP +QImageFormatType and QImageFormat are the classes that you might need to implement support for additional image formats. +.PP +Qt supports GIF reading if it is configured that way during installation (see ntqgif.h). If it is, we are required to state that" The Graphics Interchange Format(c) is the Copyright property of CompuServe Incorporated. GIF(sm) is a Service Mark property of CompuServe Incorporated." +.PP +\fBWarning:\fR If you are in a country that recognizes software patents and in which Unisys holds a patent on LZW compression and/or decompression and you want to use GIF, Unisys may require you to license that technology. Such countries include Canada, Japan, the USA, France, Germany, Italy and the UK. +.PP +GIF support may be removed completely in a future version of Qt. We recommend using the MNG or PNG format. +.PP +See also Graphics Classes, Image Processing Classes, and Multimedia Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QImageDecoder::QImageDecoder ( QImageConsumer * c )" +Constructs a QImageDecoder that will send change information to the QImageConsumer \fIc\fR. +.SH "QImageDecoder::~QImageDecoder ()" +Destroys a QImageDecoder. The image it built is destroyed. The decoder built by the factory for the file format is destroyed. The consumer for which it decoded the image is \fInot\fR destroyed. +.SH "int QImageDecoder::decode ( const uchar * buffer, int length )" +Call this function to decode some data into image changes. The data in \fIbuffer\fR will be decoded, sending change information to the QImageConsumer of this QImageDecoder until one of the change functions of the consumer returns FALSE. The length of the data is given in \fIlength\fR. +.PP +Returns the number of bytes consumed: 0 if consumption is complete, and -1 if decoding fails due to invalid data. +.SH "QImageFormatType * QImageDecoder::format ( const char * name )\fC [static]\fR" +Returns a QImageFormatType by name. This might be used when the user needs to force data to be interpreted as being in a certain format. \fIname\fR is one of the formats listed by QImageDecoder::inputFormats(). Note that you will still need to supply decodable data to result->decoderFor() before you can begin decoding the data. +.SH "const char * QImageDecoder::formatName ( const uchar * buffer, int length )\fC [static]\fR" +Call this function to find the name of the format of the given header. The returned string is statically allocated. The function will look at the first \fIlength\fR characters in the \fIbuffer\fR. +.PP +Returns 0 if the format is not recognized. +.SH "const QImage & QImageDecoder::image ()" +Returns the image currently being decoded. +.SH "QStrList QImageDecoder::inputFormats ()\fC [static]\fR" +Returns a sorted list of formats for which asynchronous loading is supported. +.SH "void QImageDecoder::registerDecoderFactory ( QImageFormatType * f )\fC [static]\fR" +Registers the new QImageFormatType \fIf\fR. This is not needed in application code because factories call this themselves. +.SH "void QImageDecoder::unregisterDecoderFactory ( QImageFormatType * f )\fC [static]\fR" +Unregisters the QImageFormatType \fIf\fR. This is not needed in +application code because factories call this themselves. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimagedecoder.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimagedecoder.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimagedrag.3qt b/doc/man/man3/tqimagedrag.3qt new file mode 100644 index 000000000..c50e55a09 --- /dev/null +++ b/doc/man/man3/tqimagedrag.3qt @@ -0,0 +1,105 @@ +'\" t +.TH QImageDrag 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 +QImageDrag \- Drag and drop object for transferring images +.SH SYNOPSIS +\fC#include <ntqdragobject.h>\fR +.PP +Inherits QDragObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQImageDrag\fR ( QImage image, QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQImageDrag\fR ( QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QImageDrag\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetImage\fR ( QImage image )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBcanDecode\fR ( const QMimeSource * e )" +.br +.ti -1c +.BI "bool \fBdecode\fR ( const QMimeSource * e, QImage & img )" +.br +.ti -1c +.BI "bool \fBdecode\fR ( const QMimeSource * e, QPixmap & pm )" +.br +.in -1c +.SH DESCRIPTION +The QImageDrag class provides a drag and drop object for transferring images. +.PP +Images are offered to the receiving application in multiple formats, determined by Qt's output formats. +.PP +For more information about drag and drop, see the QDragObject class and the drag and drop documentation. +.PP +See also Drag And Drop Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QImageDrag::QImageDrag ( QImage image, QWidget * dragSource = 0, const char * name = 0 )" +Constructs an image drag object and sets its data to \fIimage\fR. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. +.SH "QImageDrag::QImageDrag ( QWidget * dragSource = 0, const char * name = 0 )" +Constructs a default image drag object. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. +.SH "QImageDrag::~QImageDrag ()" +Destroys the image drag object and frees up all allocated resources. +.SH "bool QImageDrag::canDecode ( const QMimeSource * e )\fC [static]\fR" +Returns TRUE if the information in mime source \fIe\fR can be decoded into an image; otherwise returns FALSE. +.PP +See also decode(). +.PP +Example: desktop/desktop.cpp. +.SH "bool QImageDrag::decode ( const QMimeSource * e, QImage & img )\fC [static]\fR" +Attempts to decode the dropped information in mime source \fIe\fR into \fIimg\fR. Returns TRUE if successful; otherwise returns FALSE. +.PP +See also canDecode(). +.PP +Example: desktop/desktop.cpp. +.SH "bool QImageDrag::decode ( const QMimeSource * e, QPixmap & pm )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Attempts to decode the dropped information in mime source \fIe\fR into pixmap \fIpm\fR. Returns TRUE if successful; otherwise returns FALSE. +.PP +This is a convenience function that converts to a QPixmap via a QImage. +.PP +See also canDecode(). +.SH "void QImageDrag::setImage ( QImage image )\fC [virtual]\fR" +Sets the image to be dragged to \fIimage\fR. You will need to call +this if you did not pass the image during construction. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimagedrag.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimagedrag.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimageformat.3qt b/doc/man/man3/tqimageformat.3qt new file mode 100644 index 000000000..9590ac32f --- /dev/null +++ b/doc/man/man3/tqimageformat.3qt @@ -0,0 +1,63 @@ +'\" t +.TH QImageFormat 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 +QImageFormat \- Incremental image decoder for a specific image format +.SH SYNOPSIS +\fC#include <ntqasyncimageio.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual int \fBdecode\fR ( QImage & img, QImageConsumer * consumer, const uchar * buffer, int length ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QImageFormat class is an incremental image decoder for a specific image format. +.PP +By making a derived class of QImageFormatType, which in turn creates objects that are a subclass of QImageFormat, you can add support for more incremental image formats, allowing such formats to be sources for a QMovie or for the first frame of the image stream to be loaded as a QImage or QPixmap. +.PP +Your new subclass must reimplement the decode() function in order to process your new format. +.PP +New QImageFormat objects are generated by new QImageFormatType factories. +.PP +See also Graphics Classes, Image Processing Classes, and Multimedia Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "int QImageFormat::decode ( QImage & img, QImageConsumer * consumer, const uchar * buffer, int length )\fC [pure virtual]\fR" +New subclasses must reimplement this method. +.PP +It should decode some or all of the bytes from \fIbuffer\fR into \fIimg\fR, calling the methods of \fIconsumer\fR as the decoding proceeds to inform that consumer of changes to the image. The length of the data is given in \fIlength\fR. The consumer may be 0, in which case the function should just process the data into \fIimg\fR without telling any consumer about the changes. Note that the decoder must store enough state to be able to continue in subsequent calls to this method - this is the essence of the incremental image loading. +.PP +The function should return without processing all the data if it reaches the end of a frame in the input. +.PP +The function must return the number of bytes it has processed. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimageformat.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimageformat.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimageformatplugin.3qt b/doc/man/man3/tqimageformatplugin.3qt new file mode 100644 index 000000000..147486ef1 --- /dev/null +++ b/doc/man/man3/tqimageformatplugin.3qt @@ -0,0 +1,76 @@ +'\" t +.TH QImageFormatPlugin 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 +QImageFormatPlugin \- Abstract base for custom image format plugins +.SH SYNOPSIS +\fC#include <ntqimageformatplugin.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQImageFormatPlugin\fR ()" +.br +.ti -1c +.BI "\fB~QImageFormatPlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBkeys\fR () const = 0" +.br +.ti -1c +.BI "virtual bool \fBinstallIOHandler\fR ( const QString & format ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QImageFormatPlugin class provides an abstract base for custom image format plugins. +.PP +The image format plugin is a simple plugin interface that makes it easy to create custom image formats that can be used transparently by applications. +.PP +Writing an image format plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and installIOHandler(), and exporting the class with the Q_EXPORT_PLUGIN macro. See the Plugins documentation for details. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QImageFormatPlugin::QImageFormatPlugin ()" +Constructs an image format plugin. This is invoked automatically by the Q_EXPORT_PLUGIN macro. +.SH "QImageFormatPlugin::~QImageFormatPlugin ()" +Destroys the image format plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "bool QImageFormatPlugin::installIOHandler ( const QString & format )\fC [pure virtual]\fR" +Installs a QImageIO image I/O handler for the image format \fIformat\fR. +.PP +See also keys(). +.SH "QStringList QImageFormatPlugin::keys () const\fC [pure virtual]\fR" +Returns the list of image formats this plugin supports. +.PP +See also installIOHandler(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqimageformatplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimageformatplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimageformattype.3qt b/doc/man/man3/tqimageformattype.3qt new file mode 100644 index 000000000..c4902cc62 --- /dev/null +++ b/doc/man/man3/tqimageformattype.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QImageFormatType 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 +QImageFormatType \- Factory that makes QImageFormat objects +.SH SYNOPSIS +\fC#include <ntqasyncimageio.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QImageFormatType\fR ()" +.br +.ti -1c +.BI "virtual QImageFormat * \fBdecoderFor\fR ( const uchar * buffer, int length ) = 0" +.br +.ti -1c +.BI "virtual const char * \fBformatName\fR () const = 0" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQImageFormatType\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QImageFormatType class is a factory that makes QImageFormat objects. +.PP +Whereas the QImageIO class allows for \fIcomplete\fR loading of images, QImageFormatType allows for \fIincremental\fR loading of images. +.PP +New image file formats are installed by creating objects of derived classes of QImageFormatType. They must implement decoderFor() and formatName(). +.PP +QImageFormatType is a very simple class. Its only task is to recognize image data in some format and make a new object, subclassed from QImageFormat, which can decode that format. +.PP +The factories for formats built into Qt are automatically defined before any other factory is initialized. If two factories would recognize an image format, the factory created last will override the earlier one; you can thus override current and future built-in formats. +.PP +See also Graphics Classes, Image Processing Classes, and Multimedia Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QImageFormatType::QImageFormatType ()\fC [protected]\fR" +Constructs a factory. It automatically registers itself with QImageDecoder. +.SH "QImageFormatType::~QImageFormatType ()\fC [virtual]\fR" +Destroys a factory. It automatically unregisters itself from QImageDecoder. +.SH "QImageFormat * QImageFormatType::decoderFor ( const uchar * buffer, int length )\fC [pure virtual]\fR" +Returns a decoder for decoding an image that starts with the bytes in \fIbuffer\fR. The length of the data is given in \fIlength\fR. This function should only return a decoder if it is certain that the decoder applies to data with the given header. Returns 0 if there is insufficient data in the header to make a positive identification or if the data is not recognized. +.SH "const char * QImageFormatType::formatName () const\fC [pure virtual]\fR" +Returns the name of the format supported by decoders from this +factory. The string is statically allocated. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimageformattype.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimageformattype.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimageio.3qt b/doc/man/man3/tqimageio.3qt new file mode 100644 index 000000000..d92c822af --- /dev/null +++ b/doc/man/man3/tqimageio.3qt @@ -0,0 +1,365 @@ +'\" t +.TH QImageIO 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 +QImageIO \- Parameters for loading and saving images +.SH SYNOPSIS +\fC#include <ntqimage.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQImageIO\fR ()" +.br +.ti -1c +.BI "\fBQImageIO\fR ( QIODevice * ioDevice, const char * format )" +.br +.ti -1c +.BI "\fBQImageIO\fR ( const QString & fileName, const char * format )" +.br +.ti -1c +.BI "\fB~QImageIO\fR ()" +.br +.ti -1c +.BI "const QImage & \fBimage\fR () const" +.br +.ti -1c +.BI "int \fBstatus\fR () const" +.br +.ti -1c +.BI "const char * \fBformat\fR () const" +.br +.ti -1c +.BI "QIODevice * \fBioDevice\fR () const" +.br +.ti -1c +.BI "QString \fBfileName\fR () const" +.br +.ti -1c +.BI "int \fBquality\fR () const" +.br +.ti -1c +.BI "QString \fBdescription\fR () const" +.br +.ti -1c +.BI "const char * \fBparameters\fR () const" +.br +.ti -1c +.BI "float \fBgamma\fR () const" +.br +.ti -1c +.BI "void \fBsetImage\fR ( const QImage & image )" +.br +.ti -1c +.BI "void \fBsetStatus\fR ( int status )" +.br +.ti -1c +.BI "void \fBsetFormat\fR ( const char * format )" +.br +.ti -1c +.BI "void \fBsetIODevice\fR ( QIODevice * ioDevice )" +.br +.ti -1c +.BI "void \fBsetFileName\fR ( const QString & fileName )" +.br +.ti -1c +.BI "void \fBsetQuality\fR ( int q )" +.br +.ti -1c +.BI "void \fBsetDescription\fR ( const QString & description )" +.br +.ti -1c +.BI "void \fBsetParameters\fR ( const char * parameters )" +.br +.ti -1c +.BI "void \fBsetGamma\fR ( float gamma )" +.br +.ti -1c +.BI "bool \fBread\fR ()" +.br +.ti -1c +.BI "bool \fBwrite\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "const char * \fBimageFormat\fR ( const QString & fileName )" +.br +.ti -1c +.BI "const char * \fBimageFormat\fR ( QIODevice * d )" +.br +.ti -1c +.BI "QStrList \fBinputFormats\fR ()" +.br +.ti -1c +.BI "QStrList \fBoutputFormats\fR ()" +.br +.ti -1c +.BI "void \fBdefineIOHandler\fR ( const char * format, const char * header, const char * flags, image_io_handler readImage, image_io_handler writeImage )" +.br +.in -1c +.SH DESCRIPTION +The QImageIO class contains parameters for loading and saving images. +.PP +QImageIO contains a QIODevice object that is used for image data I/O. The programmer can install new image file formats in addition to those that Qt provides. +.PP +Qt 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). +.PP +You don't normally need to use this class; QPixmap::load(), QPixmap::save(), and QImage contain sufficient functionality. +.PP +For image files that contain sequences of images, only the first is read. See QMovie for loading multiple images. +.PP +PBM, PGM, and PPM format \fIoutput\fR is always in the more condensed raw format. PPM and PGM files with more than 256 levels of intensity are scaled down when reading. +.PP +\fBWarning:\fR 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 require you to license the technology. Such countries include Canada, Japan, the USA, France, Germany, Italy and the UK. +.PP +GIF support may be removed completely in a future version of Qt. We recommend using the PNG format. +.PP +See also QImage, QPixmap, QFile, QMovie, Graphics Classes, Image Processing Classes, and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QImageIO::QImageIO ()" +Constructs a QImageIO object with all parameters set to zero. +.SH "QImageIO::QImageIO ( QIODevice * ioDevice, const char * format )" +Constructs a QImageIO object with the I/O device \fIioDevice\fR and a \fIformat\fR tag. +.SH "QImageIO::QImageIO ( const QString & fileName, const char * format )" +Constructs a QImageIO object with the file name \fIfileName\fR and a \fIformat\fR tag. +.SH "QImageIO::~QImageIO ()" +Destroys the object and all related data. +.SH "void QImageIO::defineIOHandler ( const char * format, const char * header, const char * flags, image_io_handler readImage, image_io_handler writeImage )\fC [static]\fR" +Defines an image I/O handler for the image format called \fIformat\fR, which is recognized using the regular expression \fIheader\fR, read using \fIreadImage\fR and written using \fIwriteImage\fR. +.PP +\fIflags\fR 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 \fIflags\fR are "T" and the empty string. The "T" flag means that the image file is a text file, and Qt should treat all newline conventions as equivalent. (XPM files and some PPM files are text files for example.) +.PP +\fIformat\fR is used to select a handler to write a QImage; \fIheader\fR is used to select a handler to read an image file. +.PP +If \fIreadImage\fR is a null pointer, the QImageIO will not be able to read images in \fIformat\fR. If \fIwriteImage\fR is a null pointer, the QImageIO will not be able to write images in \fIformat\fR. If both are null, the QImageIO object is valid but useless. +.PP +Example: +.PP +.nf +.br + void readGIF( QImageIO *image ) +.br + { +.br + // read the image using the image->ioDevice() +.br + } +.br +.br + void writeGIF( QImageIO *image ) +.br + { +.br + // write the image using the image->ioDevice() +.br + } +.br +.br + // add the GIF image handler +.br +.br + QImageIO::defineIOHandler( "GIF", +.br + "^GIF[0-9][0-9][a-z]", +.br + 0, +.br + readGIF, +.br + writeGIF ); +.br +.fi +.PP +Before the regex test, all the 0 bytes in the file header are converted to 1 bytes. This is done because when Qt was ASCII-based, QRegExp could not handle 0 bytes in strings. +.PP +The regexp is only applied on the first 14 bytes of the file. +.PP +Note that Qt assumes that there is only one handler per format; if two handlers support the same format, Qt will choose one arbitrarily. It is not possible to have one handler support reading, and another support writing. +.SH "QString QImageIO::description () const" +Returns the image description string. +.PP +See also setDescription(). +.SH "QString QImageIO::fileName () const" +Returns the file name currently set. +.PP +See also setFileName(). +.SH "const char * QImageIO::format () const" +Returns the image format string or 0 if no format has been explicitly set. +.SH "float QImageIO::gamma () const" +Returns the gamma value at which the image will be viewed. +.PP +See also setGamma(). +.SH "const QImage & QImageIO::image () const" +Returns the image currently set. +.PP +See also setImage(). +.SH "const char * QImageIO::imageFormat ( const QString & fileName )\fC [static]\fR" +Returns a string that specifies the image format of the file \fIfileName\fR, or null if the file cannot be read or if the format is not recognized. +.SH "const char * QImageIO::imageFormat ( QIODevice * d )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string that specifies the image format of the image read from IO device \fId\fR, or 0 if the device cannot be read or if the format is not recognized. +.PP +Make sure that \fId\fR is at the right position in the device (for example, at the beginning of the file). +.PP +See also QIODevice::at(). +.SH "QStrList QImageIO::inputFormats ()\fC [static]\fR" +Returns a sorted list of image formats that are supported for image input. +.SH "QIODevice * QImageIO::ioDevice () const" +Returns the IO device currently set. +.PP +See also setIODevice(). +.SH "QStrList QImageIO::outputFormats ()\fC [static]\fR" +Returns a sorted list of image formats that are supported for image output. +.PP +Example: scribble/scribble.cpp. +.SH "const char * QImageIO::parameters () const" +Returns the image's parameters string. +.PP +See also setParameters(). +.SH "int QImageIO::quality () const" +Returns the quality of the written image, related to the compression ratio. +.PP +See also setQuality() and QImage::save(). +.SH "bool QImageIO::read ()" +Reads an image into memory and returns TRUE if the image was successfully read; otherwise returns FALSE. +.PP +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. +.PP +Setting the image file format string is optional. +.PP +Note that this function does \fInot\fR set the format used to read the image. If you need that information, use the imageFormat() static functions. +.PP +Example: +.PP +.nf +.br + QImageIO iio; +.br + QPixmap pixmap; +.br + iio.setFileName( "vegeburger.bmp" ); +.br + if ( image.read() ) // ok +.br + pixmap = iio.image(); // convert to pixmap +.br +.fi +.PP +See also setIODevice(), setFileName(), setFormat(), write(), and QPixmap::load(). +.SH "void QImageIO::setDescription ( const QString & description )" +Sets the image description string for image handlers that support image descriptions to \fIdescription\fR. +.PP +Currently, no image format supported by Qt uses the description string. +.SH "void QImageIO::setFileName ( const QString & fileName )" +Sets the name of the file to read or write an image from to \fIfileName\fR. +.PP +See also setIODevice(). +.SH "void QImageIO::setFormat ( const char * format )" +Sets the image format to \fIformat\fR for the image to be read or written. +.PP +It is necessary to specify a format before writing an image, but it is not necessary to specify a format before reading an image. +.PP +If no format has been set, Qt guesses the image format before reading it. If a format is set the image will only be read if it has that format. +.PP +See also read(), write(), and format(). +.SH "void QImageIO::setGamma ( float gamma )" +Sets the gamma value at which the image will be viewed to \fIgamma\fR. 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). +.PP +The default value is 0.0. +.PP +See also gamma(). +.SH "void QImageIO::setIODevice ( QIODevice * ioDevice )" +Sets the IO device to be used for reading or writing an image. +.PP +Setting the IO device allows images to be read/written to any block-oriented QIODevice. +.PP +If \fIioDevice\fR is not null, this IO device will override file name settings. +.PP +See also setFileName(). +.SH "void QImageIO::setImage ( const QImage & image )" +Sets the image to \fIimage\fR. +.PP +See also image(). +.SH "void QImageIO::setParameters ( const char * parameters )" +Sets the image's parameter string to \fIparameters\fR. This is for image handlers that require special parameters. +.PP +Although the current image formats supported by Qt ignore the parameters string, it may be used in future extensions or by contributions (for example, JPEG). +.PP +See also parameters(). +.SH "void QImageIO::setQuality ( int q )" +Sets the quality of the written image to \fIq\fR, related to the compression ratio. +.PP +\fIq\fR must be in the range -1..100. Specify 0 to obtain small compressed files, 100 for large uncompressed files. (-1 signifies the default compression.) +.PP +See also quality() and QImage::save(). +.SH "void QImageIO::setStatus ( int status )" +Sets the image IO status to \fIstatus\fR. A non-zero value indicates an error, whereas 0 means that the IO operation was successful. +.PP +See also status(). +.SH "int QImageIO::status () const" +Returns the image's IO status. A non-zero value indicates an error, whereas 0 means that the IO operation was successful. +.PP +See also setStatus(). +.SH "bool QImageIO::write ()" +Writes an image to an IO device and returns TRUE if the image was successfully written; otherwise returns FALSE. +.PP +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. +.PP +The image will be written using the specified image format. +.PP +Example: +.PP +.nf +.br + QImageIO iio; +.br + QImage im; +.br + im = pixmap; // convert to image +.br + iio.setImage( im ); +.br + iio.setFileName( "vegeburger.bmp" ); +.br + iio.setFormat( "BMP" ); +.br + if ( iio.write() ) +.br + // returned TRUE if written successfully +.br +.fi +.PP +See also setIODevice(), setFileName(), setFormat(), read(), and QPixmap::save(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimageio.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimageio.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqimevent.3qt b/doc/man/man3/tqimevent.3qt new file mode 100644 index 000000000..994d8822d --- /dev/null +++ b/doc/man/man3/tqimevent.3qt @@ -0,0 +1,127 @@ +'\" t +.TH QIMEvent 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 +QIMEvent \- Parameters for input method events +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIMEvent\fR ( Type type, const QString & text, int cursorPosition )" +.br +.ti -1c +.BI "const QString & \fBtext\fR () const" +.br +.ti -1c +.BI "int \fBcursorPos\fR () const" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.ti -1c +.BI "int \fBselectionLength\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QIMEvent class provides parameters for input method events. +.PP +Input method events are sent to widgets when an input method is used to enter text into a widget. Input methods are widely used to enter text in Asian and other complex languages. +.PP +The events are of interest to widgets that accept keyboard input and want to be able to correctly handle complex languages. Text input in such languages is usually a three step process. +.PP +<ol type=1> +.IP 1 +\fBStarting to Compose\fR +.br +When the user presses the first key on a keyboard an input context is created. This input context will contain a string with the typed characters. +.IP 2 +\fBComposing\fR +.br +With every new key pressed, the input method will try to create a matching string for the text typed so far. While the input context is active, the user can only move the cursor inside the string belonging to this input context. +.IP 3 +\fBCompleting\fR +.br +At some point, e.g. when the user presses the Spacebar, they get to this stage, where they can choose from a number of strings that match the text they have typed so far. The user can press Enter to confirm their choice or Escape to cancel the input; in either case the input context will be closed. +.PP +Note that the particular key presses used for a given input context may differ from those we've mentioned here, i.e. they may not be Spacebar, Enter and Escape. +.PP +These three stages are represented by three different types of events. The IMStartEvent, IMComposeEvent and IMEndEvent. When a new input context is created, an IMStartEvent will be sent to the widget and delivered to the QWidget::imStartEvent() function. The widget can then update internal data structures to reflect this. +.PP +After this, an IMComposeEvent will be sent to the widget for every key the user presses. It will contain the current composition string the widget has to show and the current cursor position within the composition string. This string is temporary and can change with every key the user types, so the widget will need to store the state before the composition started (the state it had when it received the IMStartEvent). IMComposeEvents will be delivered to the QWidget::imComposeEvent() function. +.PP +Usually, widgets try to mark the part of the text that is part of the current composition in a way that is visible to the user. A commonly used visual cue is to use a dotted underline. +.PP +After the user has selected the final string, an IMEndEvent will be sent to the widget. The event contains the final string the user selected, and could be empty if they canceled the composition. This string should be accepted as the final text the user entered, and the intermediate composition string should be cleared. These events are delivered to QWidget::imEndEvent(). +.PP +If the user clicks another widget, taking the focus out of the widget where the composition is taking place the IMEndEvent will be sent and the string it holds will be the result of the composition up to that point (which may be an empty string). +.PP +See also Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIMEvent::QIMEvent ( Type type, const QString & text, int cursorPosition )" +Constructs a new QIMEvent with the accept flag set to FALSE. \fItype\fR can be one of QEvent::IMStartEvent, QEvent::IMComposeEvent or QEvent::IMEndEvent. \fItext\fR contains the current compostion string and \fIcursorPosition\fR the current position of the cursor inside \fItext\fR. +.SH "void QIMEvent::accept ()" +Sets the accept flag of the input method event object. +.PP +Setting the accept parameter indicates that the receiver of the event processed the input method event. +.PP +The accept flag is not set by default. +.PP +See also ignore(). +.SH "int QIMEvent::cursorPos () const" +Returns the current cursor position inside the composition string. Will return -1 for IMStartEvent and IMEndEvent. +.SH "void QIMEvent::ignore ()" +Clears the accept flag parameter of the input method event object. +.PP +Clearing the accept parameter indicates that the event receiver does not want the input method event. +.PP +The accept flag is cleared by default. +.PP +See also accept(). +.SH "bool QIMEvent::isAccepted () const" +Returns TRUE if the receiver of the event processed the event; otherwise returns FALSE. +.SH "int QIMEvent::selectionLength () const" +Returns the number of characters in the composition string ( starting at cursorPos() ) that should be marked as selected by the input widget receiving the event. Will return 0 for IMStartEvent and IMEndEvent. +.SH "const QString & QIMEvent::text () const" +Returns the composition text. This is a null string for an +IMStartEvent, and contains the final accepted string (which may be +empty) in the IMEndEvent. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqimevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqinputdialog.3qt b/doc/man/man3/tqinputdialog.3qt new file mode 100644 index 000000000..a31f165e4 --- /dev/null +++ b/doc/man/man3/tqinputdialog.3qt @@ -0,0 +1,201 @@ +'\" t +.TH QInputDialog 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 +QInputDialog \- Simple convenience dialog to get a single value from the user +.SH SYNOPSIS +\fC#include <ntqinputdialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Static Public Members" +<li class=fn>QString \fBgetText\fR ( const QString & caption, const QString & label, QLineEdit::EchoMode mode = QLineEdit::Normal, const QString & text = QString::null, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) <li class=fn>int \fBgetInteger\fR ( const QString & caption, const QString & label, int value = 0, int minValue = -2147483647, int maxValue = 2147483647, int step = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) <li class=fn>double \fBgetDouble\fR ( const QString & caption, const QString & label, double value = 0, double minValue = -2147483647, double maxValue = 2147483647, int decimals = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) <li class=fn>QString \fBgetItem\fR ( const QString & caption, const QString & label, const QStringList & list, int current = 0, bool editable = TRUE, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) +.SH DESCRIPTION +The QInputDialog class provides a simple convenience dialog to get a single value from the user. +.PP +The input value can be a string, a number or an item from a list. A label must be set to tell the user what they should enter. +.PP +Four static convenience functions are provided: getText(), getInteger(), getDouble() and getItem(). All the functions can be used in a similar way, for example: +.PP +.nf +.br + bool ok; +.br + QString text = QInputDialog::getText( +.br + "MyApp 3000", "Enter your name:", QLineEdit::Normal, +.br + QString::null, &ok, this ); +.br + if ( ok && !text.isEmpty() ) { +.br + // user entered something and pressed OK +.br + } else { +.br + // user entered nothing or pressed Cancel +.br + } +.br +.fi +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also Dialog Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "double QInputDialog::getDouble ( const QString & caption, const QString & label, double value = 0, double minValue = -2147483647, double maxValue = 2147483647, int decimals = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Static convenience function to get a floating point number from the user. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fIvalue\fR is the default floating point number that the line edit will be set to. \fIminValue\fR and \fImaxValue\fR are the minimum and maximum values the user may choose, and \fIdecimals\fR is the maximum number of decimal places the number may have. +.PP +If \fIok\fR is not-null \fI*\fR\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. +.PP +This function returns the floating point number which has been entered by the user. +.PP +Use this static function like this: +.PP +.nf +.br + bool ok; +.br + double res = QInputDialog::getDouble( +.br + "MyApp 3000", "Enter a decimal number:", 33.7, 0, +.br + 1000, 2, &ok, this ); +.br + if ( ok ) { +.br + // user entered something and pressed OK +.br + } else { +.br + // user pressed Cancel +.br + } +.br +.fi +.SH "int QInputDialog::getInteger ( const QString & caption, const QString & label, int value = 0, int minValue = -2147483647, int maxValue = 2147483647, int step = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Static convenience function to get an integer input from the user. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fIvalue\fR is the default integer which the spinbox will be set to. \fIminValue\fR and \fImaxValue\fR are the minimum and maximum values the user may choose, and \fIstep\fR is the amount by which the values change as the user presses the arrow buttons to increment or decrement the value. +.PP +If \fIok\fR is not-null *\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. +.PP +This function returns the integer which has been entered by the user. +.PP +Use this static function like this: +.PP +.nf +.br + bool ok; +.br + int res = QInputDialog::getInteger( +.br + "MyApp 3000", "Enter a number:", 22, 0, 1000, 2, +.br + &ok, this ); +.br + if ( ok ) { +.br + // user entered something and pressed OK +.br + } else { +.br + // user pressed Cancel +.br + } +.br +.fi +.SH "QString QInputDialog::getItem ( const QString & caption, const QString & label, const QStringList & list, int current = 0, bool editable = TRUE, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Static convenience function to let the user select an item from a string list. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fIlist\fR is the string list which is inserted into the combobox, and \fIcurrent\fR is the number of the item which should be the current item. If \fIeditable\fR is TRUE the user can enter their own text; if \fIeditable\fR is FALSE the user may only select one of the existing items. +.PP +If \fIok\fR is not-null \fI*\fR\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. +.PP +This function returns the text of the current item, or if \fIeditable\fR is TRUE, the current text of the combobox. +.PP +Use this static function like this: +.PP +.nf +.br + QStringList lst; +.br + lst << "First" << "Second" << "Third" << "Fourth" << "Fifth"; +.br + bool ok; +.br + QString res = QInputDialog::getItem( +.br + "MyApp 3000", "Select an item:", lst, 1, TRUE, &ok, +.br + this ); +.br + if ( ok ) { +.br + // user selected an item and pressed OK +.br + } else { +.br + // user pressed Cancel +.br + } +.br +.fi +.SH "QString QInputDialog::getText ( const QString & caption, const QString & label, QLineEdit::EchoMode mode = QLineEdit::Normal, const QString & text = QString::null, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Static convenience function to get a string from the user. \fIcaption\fR is the text which is displayed in the title bar of the dialog. \fIlabel\fR is the text which is shown to the user (it should say what should be entered). \fItext\fR is the default text which is placed in the line edit. The \fImode\fR is the echo mode the line edit will use. If \fIok\fR is not-null \fI*\fR\fIok\fR will be set to TRUE if the user pressed OK and to FALSE if the user pressed Cancel. The dialog's parent is \fIparent\fR; the dialog is called \fIname\fR. The dialog will be modal. +.PP +This function returns the text which has been entered in the line edit. It will not return an empty string. +.PP +Use this static function like this: +.PP +.nf +.br + bool ok; +.br + QString text = QInputDialog::getText( +.br + "MyApp 3000", "Enter your name:", QLineEdit::Normal, +.br + QString::null, &ok, this ); +.br + if ( ok && !text.isEmpty() ) { +.br + // user entered something and pressed OK +.br + } else { +.br + // user entered nothing or pressed Cancel +.br + } +.br +.fi + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqinputdialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqinputdialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqintcache.3qt b/doc/man/man3/tqintcache.3qt new file mode 100644 index 000000000..a80006e47 --- /dev/null +++ b/doc/man/man3/tqintcache.3qt @@ -0,0 +1,185 @@ +'\" t +.TH QIntCache 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 +QIntCache \- Template class that provides a cache based on long keys +.SH SYNOPSIS +\fC#include <ntqintcache.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIntCache\fR ( int maxCost = 100, int size = 17 )" +.br +.ti -1c +.BI "\fB~QIntCache\fR ()" +.br +.ti -1c +.BI "int \fBmaxCost\fR () const" +.br +.ti -1c +.BI "int \fBtotalCost\fR () const" +.br +.ti -1c +.BI "void \fBsetMaxCost\fR ( int m )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBinsert\fR ( long k, const type * d, int c = 1, int p = 0 )" +.br +.ti -1c +.BI "bool \fBremove\fR ( long k )" +.br +.ti -1c +.BI "type * \fBtake\fR ( long k )" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "type * \fBfind\fR ( long k, bool ref = TRUE ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( long k ) const" +.br +.ti -1c +.BI "void \fBstatistics\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QIntCache class is a template class that provides a cache based on long keys. +.PP +QIntCache is implemented as a template class. Define a template instance QIntCache<X> to create a cache that operates on pointers to X, or X*. +.PP +A cache is a least recently used (LRU) list of cache items, accessed via \fClong\fR keys. Each cache item has a cost. The sum of item costs, totalCost(), will not exceed the maximum cache cost, maxCost(). If inserting a new item would cause the total cost to exceed the maximum cost, the least recently used items in the cache are removed. +.PP +Apart from insert(), by far the most important function is find() (which also exists as operator[]). This function looks up an item, returns it, and by default marks it as being the most recently used item. +.PP +There are also methods to remove() or take() an object from the cache. Calling setAutoDelete(TRUE) for a cache tells it to delete items that are removed. The default is to not delete items when they are removed (i.e. remove() and take() are equivalent). +.PP +When inserting an item into the cache, only the pointer is copied, not the item itself. This is called a shallow copy. It is possible to make the cache copy all of the item's data (known as a deep copy) when an item is inserted. insert() calls the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a dictionary and reimplement newItem() if you want deep copies. +.PP +When removing a cache item, the item will be automatically deleted if auto-deletion is enabled. +.PP +There is a QIntCacheIterator which may be used to traverse the items in the cache in arbitrary order. +.PP +See also QIntCacheIterator, QCache, QAsciiCache, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIntCache::QIntCache ( int maxCost = 100, int size = 17 )" +Constructs a cache whose contents will never have a total cost greater than \fImaxCost\fR and which is expected to contain less than \fIsize\fR items. +.PP +\fIsize\fR is actually the size of an internal hash array; it's usually best to make it prime and at least 50% bigger than the largest expected number of items in the cache. +.PP +Each inserted item is associated with a cost. When inserting a new item, if the total cost of all items in the cache will exceed \fImaxCost\fR, the cache will start throwing out the older (least recently used) items until there is enough room for the new item to be inserted. +.SH "QIntCache::~QIntCache ()" +Removes all items from the cache and then destroys the int cache. If auto-deletion is enabled the cache's items are deleted. All iterators that access this cache will be reset. +.SH "void QIntCache::clear ()\fC [virtual]\fR" +Removes all items from the cache, and deletes them if auto-deletion has been enabled. +.PP +All cache iterators that operate this on cache are reset. +.PP +See also remove() and take(). +.PP +Reimplemented from QPtrCollection. +.SH "uint QIntCache::count () const\fC [virtual]\fR" +Returns the number of items in the cache. +.PP +See also totalCost(). +.PP +Reimplemented from QPtrCollection. +.SH "type * QIntCache::find ( long k, bool ref = TRUE ) const" +Returns the item associated with \fIk\fR, or 0 if the key does not exist in the cache. If \fIref\fR is TRUE (the default), the item is moved to the front of the least recently used list. +.PP +If there are two or more items with equal keys, the one that was inserted most recently is returned. +.SH "bool QIntCache::insert ( long k, const type * d, int c = 1, int p = 0 )" +Inserts the item \fId\fR into the cache with key \fIk\fR and assigns it a cost of \fIc\fR (default 1). Returns TRUE if it succeeds; otherwise returns FALSE. +.PP +The cache's size is limited, and if the total cost is too high, QIntCache will remove old, least-used items until there is room for this new item. +.PP +The parameter \fIp\fR is internal and should be left at the default value (0). +.PP +\fBWarning:\fR If this function returns FALSE (for example, the cost \fC,\fR exceeds maxCost()), you must delete \fId\fR yourself. Additionally, be very careful about using \fId\fR after calling this function. Any other insertions into the cache, from anywhere in the application or within Qt itself, could cause the object to be discarded from the cache and the pointer to become invalid. +.SH "bool QIntCache::isEmpty () const" +Returns TRUE if the cache is empty; otherwise returns FALSE. +.SH "int QIntCache::maxCost () const" +Returns the maximum allowed total cost of the cache. +.PP +See also setMaxCost() and totalCost(). +.SH "type * QIntCache::operator[] ( long k ) const" +Returns the item associated with \fIk\fR, or 0 if \fIk\fR does not exist in the cache, and moves the item to the front of the least recently used list. +.PP +If there are two or more items with equal keys, the one that was inserted most recently is returned. +.PP +This is the same as find( k, TRUE ). +.PP +See also find(). +.SH "bool QIntCache::remove ( long k )" +Removes the item associated with \fIk\fR, and returns TRUE if the item was present in the cache; otherwise returns FALSE. +.PP +The item is deleted if auto-deletion has been enabled, i.e. if you have called setAutoDelete(TRUE). +.PP +If there are two or more items with equal keys, the one that was inserted most recently is removed. +.PP +All iterators that refer to the removed item are set to point to the next item in the cache's traversal order. +.PP +See also take() and clear(). +.SH "void QIntCache::setMaxCost ( int m )" +Sets the maximum allowed total cost of the cache to \fIm\fR. If the current total cost is greater than \fIm\fR, some items are removed immediately. +.PP +See also maxCost() and totalCost(). +.SH "uint QIntCache::size () const" +Returns the size of the hash array used to implement the cache. This should be a bit larger than count() is likely to be. +.SH "void QIntCache::statistics () const" +A debug-only utility function. Prints out cache usage, hit/miss, and distribution information using tqDebug(). This function does nothing in the release library. +.SH "type * QIntCache::take ( long k )" +Takes the item associated with \fIk\fR out of the cache without deleting it, and returns a pointer to the item taken out or 0 if the key does not exist in the cache. +.PP +If there are two or more items with equal keys, the one that was inserted most recently is taken. +.PP +All iterators that refer to the taken item are set to point to the next item in the cache's traversal order. +.PP +See also remove() and clear(). +.SH "int QIntCache::totalCost () const" +Returns the total cost of the items in the cache. This is an integer in the range 0 to maxCost(). +.PP +See also setMaxCost(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqintcache.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqintcache.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqintcacheiterator.3qt b/doc/man/man3/tqintcacheiterator.3qt new file mode 100644 index 000000000..4d6362693 --- /dev/null +++ b/doc/man/man3/tqintcacheiterator.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QIntCacheIterator 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 +QIntCacheIterator \- Iterator for QIntCache collections +.SH SYNOPSIS +\fC#include <ntqintcache.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIntCacheIterator\fR ( const QIntCache<type> & cache )" +.br +.ti -1c +.BI "\fBQIntCacheIterator\fR ( const QIntCacheIterator<type> & ci )" +.br +.ti -1c +.BI "QIntCacheIterator<type> & \fBoperator=\fR ( const QIntCacheIterator<type> & ci )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBatFirst\fR () const" +.br +.ti -1c +.BI "bool \fBatLast\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "type * \fBtoLast\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "long \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.ti -1c +.BI "type * \fBoperator--\fR ()" +.br +.ti -1c +.BI "type * \fBoperator-=\fR ( uint jump )" +.br +.in -1c +.SH DESCRIPTION +The QIntCacheIterator class provides an iterator for QIntCache collections. +.PP +Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them. +.PP +Multiple iterators are completely independent, even when they operate on the same QIntCache. QIntCache updates all iterators that refer an item when that item is removed. +.PP +QIntCacheIterator provides an operator++(), and an operator+=() to traverse the cache; current() and currentKey() to access the current cache item and its key; atFirst() atLast(), which return TRUE if the iterator points to the first/last item in the cache; isEmpty(), which returns TRUE if the cache is empty; and count(), which returns the number of items in the cache. +.PP +Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also QIntCache, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIntCacheIterator::QIntCacheIterator ( const QIntCache<type> & cache )" +Constructs an iterator for \fIcache\fR. The current iterator item is set to point to the first item in the \fIcache\fR (or rather, the first item is defined to be the item at which this constructor sets the iterator to point). +.SH "QIntCacheIterator::QIntCacheIterator ( const QIntCacheIterator<type> & ci )" +Constructs an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently from there on. +.SH "bool QIntCacheIterator::atFirst () const" +Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toFirst() and atLast(). +.SH "bool QIntCacheIterator::atLast () const" +Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toLast() and atFirst(). +.SH "uint QIntCacheIterator::count () const" +Returns the number of items in the cache on which this iterator operates. +.PP +See also isEmpty(). +.SH "type * QIntCacheIterator::current () const" +Returns a pointer to the current iterator item. +.SH "long QIntCacheIterator::currentKey () const" +Returns the key for the current iterator item. +.SH "bool QIntCacheIterator::isEmpty () const" +Returns TRUE if the cache is empty; otherwise returns FALSE. +.PP +See also count(). +.SH "QIntCacheIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QIntCacheIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the cache or if it was 0, 0 is returned. +.SH "type * QIntCacheIterator::operator++ ()" +Prefix ++ makes the iterator point to the item just after current(), and makes it the new current item for the iterator. If current() was the last item, operator--() returns 0. +.SH "type * QIntCacheIterator::operator+= ( uint jump )" +Returns the item \fIjump\fR positions after the current item, or 0 if it is beyond the last item. Makes this the current item. +.SH "type * QIntCacheIterator::operator-- ()" +Prefix -- makes the iterator point to the item just before current(), and makes it the new current item for the iterator. If current() was the first item, operator--() returns 0. +.SH "type * QIntCacheIterator::operator-= ( uint jump )" +Returns the item \fIjump\fR positions before the current item, or 0 if it is beyond the first item. Makes this the current item. +.SH "QIntCacheIterator<type> & QIntCacheIterator::operator= ( const QIntCacheIterator<type> & ci )" +Makes this an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently thereafter. +.SH "type * QIntCacheIterator::toFirst ()" +Sets the iterator to point to the first item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0, and returns 0, if the cache is empty. +.PP +See also toLast() and isEmpty(). +.SH "type * QIntCacheIterator::toLast ()" +Sets the iterator to point to the last item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0, and returns 0, if the cache is empty. +.PP +See also toFirst() and isEmpty(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qintcacheiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqintcacheiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqintdict.3qt b/doc/man/man3/tqintdict.3qt new file mode 100644 index 000000000..bd0301c16 --- /dev/null +++ b/doc/man/man3/tqintdict.3qt @@ -0,0 +1,315 @@ +'\" t +.TH QIntDict 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 +QIntDict \- Template class that provides a dictionary based on long keys +.SH SYNOPSIS +\fC#include <ntqintdict.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIntDict\fR ( int size = 17 )" +.br +.ti -1c +.BI "\fBQIntDict\fR ( const QIntDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QIntDict\fR ()" +.br +.ti -1c +.BI "QIntDict<type> & \fBoperator=\fR ( const QIntDict<type> & dict )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "void \fBinsert\fR ( long key, const type * item )" +.br +.ti -1c +.BI "void \fBreplace\fR ( long key, const type * item )" +.br +.ti -1c +.BI "bool \fBremove\fR ( long key )" +.br +.ti -1c +.BI "type * \fBtake\fR ( long key )" +.br +.ti -1c +.BI "type * \fBfind\fR ( long key ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( long key ) const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "void \fBresize\fR ( uint newsize )" +.br +.ti -1c +.BI "void \fBstatistics\fR () const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" +.br +.in -1c +.SH DESCRIPTION +The QIntDict class is a template class that provides a dictionary based on long keys. +.PP +QMap is an STL-compatible alternative to this class. +.PP +QIntDict is implemented as a template class. Define a template instance QIntDict<X> to create a dictionary that operates on pointers to X (X*). +.PP +A dictionary is a collection of key-value pairs. The key is an \fClong\fR used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. +.PP +Example: +.PP +.nf +.br + QIntDict<QLineEdit> fields; // long int keys, QLineEdit* values +.br + for ( int i = 0; i < 3; i++ ) +.br + fields.insert( i, new QLineEdit( this ) ); +.br +.br + fields[0]->setText( "Homer" ); +.br + fields[1]->setText( "Simpson" ); +.br + fields[2]->setText( "45" ); +.br +.br + QIntDictIterator<QLineEdit> it( fields ); +.br + for ( ; it.current(); ++it ) +.br + cout << it.currentKey() << ": " << it.current()->text() << endl; +.br +.br + for ( int i = 0; i < 3; i++ ) +.br + cout << fields[i]->text() << " "; // Prints "Homer Simpson 45" +.br + cout << endl; +.br +.br + fields.remove( 1 ); // Does not delete the line edit +.br + for ( int i = 0; i < 3; i++ ) +.br + if ( fields[i] ) +.br + cout << fields[i]->text() << " "; // Prints "Homer 45" +.br +.fi +.PP +See QDict for full details, including the choice of dictionary size, and how deletions are handled. +.PP +See also QIntDictIterator, QDict, QAsciiDict, QPtrDict, Collection Classes, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIntDict::QIntDict ( int size = 17 )" +Constructs a dictionary using an internal hash array of size \fIsize\fR. +.PP +Setting \fIsize\fR to a suitably large prime number (equal to or greater than the expected number of entries) makes the hash distribution better which leads to faster lookup. +.SH "QIntDict::QIntDict ( const QIntDict<type> & dict )" +Constructs a copy of \fIdict\fR. +.PP +Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). +.SH "QIntDict::~QIntDict ()" +Removes all items from the dictionary and destroys it. +.PP +All iterators that access this dictionary will be reset. +.PP +See also setAutoDelete(). +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QIntDict::clear ()\fC [virtual]\fR" +Removes all items from the dictionary. +.PP +The removed items are deleted if auto-deletion is enabled. +.PP +All dictionary iterators that access this dictionary will be reset. +.PP +See also remove(), take(), and setAutoDelete(). +.PP +Reimplemented from QPtrCollection. +.SH "uint QIntDict::count () const\fC [virtual]\fR" +Returns the number of items in the dictionary. +.PP +See also isEmpty(). +.PP +Reimplemented from QPtrCollection. +.SH "type * QIntDict::find ( long key ) const" +Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be found. +.PP +Equivalent to operator[]. +.PP +See also operator[](). +.PP +Example: table/bigtable/main.cpp. +.SH "void QIntDict::insert ( long key, const type * item )" +Insert item \fIitem\fR into the dictionary using key \fIkey\fR. +.PP +Multiple items can have the same key, in which case only the last item will be accessible using operator[](). +.PP +\fIitem\fR may not be 0. +.PP +See also replace(). +.PP +Example: scribble/scribble.cpp. +.SH "bool QIntDict::isEmpty () const" +Returns TRUE if the dictionary is empty; otherwise returns FALSE. +.PP +See also count(). +.SH "QIntDict<type> & QIntDict::operator= ( const QIntDict<type> & dict )" +Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. +.PP +This dictionary is first cleared and then each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy), unless newItem() has been reimplemented. +.SH "type * QIntDict::operator[] ( long key ) const" +Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be found. +.PP +Equivalent to the find() function. +.PP +See also find(). +.SH "QDataStream & QIntDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QIntDict::remove ( long key )" +Removes the item associated with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if the \fIkey\fR is in the dictionary; otherwise returns FALSE. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be removed. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary's traversal order. +.PP +See also take(), clear(), and setAutoDelete(). +.PP +Example: table/bigtable/main.cpp. +.SH "void QIntDict::replace ( long key, const type * item )" +If the dictionary has key \fIkey\fR, this key's item is replaced with \fIitem\fR. If the dictionary doesn't contain key \fIkey\fR, \fIitem\fR is inserted into the dictionary using key \fIkey\fR. +.PP +\fIitem\fR may not be 0. +.PP +Equivalent to: +.PP +.nf +.br + QIntDict<char> dict; +.br + // ... +.br + if ( dict.find(key) ) +.br + dict.remove( key ); +.br + dict.insert( key, item ); +.br +.fi +.PP +If there are two or more items with equal keys, then the most recently inserted item will be replaced. +.PP +See also insert(). +.PP +Example: table/bigtable/main.cpp. +.SH "void QIntDict::resize ( uint newsize )" +Changes the size of the hashtable to \fInewsize\fR. The contents of the dictionary are preserved, but all iterators on the dictionary become invalid. +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. +.SH "uint QIntDict::size () const" +Returns the size of the internal hash array (as specified in the constructor). +.PP +See also count(). +.SH "void QIntDict::statistics () const" +Debugging-only function that prints out the dictionary distribution using tqDebug(). +.SH "type * QIntDict::take ( long key )" +Takes the item associated with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). +.PP +If there are two or more items with equal keys, then the most recently inserted item will be taken. +.PP +Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. +.PP +All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary's traversing order. +.PP +See also remove(), clear(), and setAutoDelete(). +.PP +Example: table/bigtable/main.cpp. +.SH "QDataStream & QIntDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" +Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqintdict.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqintdict.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqintdictiterator.3qt b/doc/man/man3/tqintdictiterator.3qt new file mode 100644 index 000000000..e260df860 --- /dev/null +++ b/doc/man/man3/tqintdictiterator.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QIntDictIterator 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 +QIntDictIterator \- Iterator for QIntDict collections +.SH SYNOPSIS +\fC#include <ntqintdict.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIntDictIterator\fR ( const QIntDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QIntDictIterator\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "long \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.in -1c +.SH DESCRIPTION +The QIntDictIterator class provides an iterator for QIntDict collections. +.PP +QIntDictIterator is implemented as a template class. Define a template instance QIntDictIterator<X> to create a dictionary iterator that operates on QIntDict<X> (dictionary of X*). +.PP +Example: +.PP +.nf +.br + QIntDict<QLineEdit> fields; +.br + for ( int i = 0; i < 3; i++ ) +.br + fields.insert( i, new QLineEdit( this ) ); +.br +.br + fields[0]->setText( "Homer" ); +.br + fields[1]->setText( "Simpson" ); +.br + fields[2]->setText( "45" ); +.br +.br + QIntDictIterator<QLineEdit> it( fields ); +.br +.br + for ( ; it.current(); ++it ) +.br + cout << it.currentKey() << ": " << it.current()->text() << endl; +.br +.br + // Output (random order): +.br + // 0: Homer +.br + // 1: Simpson +.br + // 2: 45 +.br +.fi +.PP +Note that the traversal order is arbitrary; you are not guaranteed the order shown above. +.PP +Multiple iterators may independently traverse the same dictionary. A QIntDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QIntDict updates all iterators that refer the removed item to point to the next item in the traversal order. +.PP +See also QIntDict, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIntDictIterator::QIntDictIterator ( const QIntDict<type> & dict )" +Constructs an iterator for \fIdict\fR. The current iterator item is set to point to the 'first' item in the \fIdict\fR. The first item refers to the first item in the dictionary's arbitrary internal ordering. +.SH "QIntDictIterator::~QIntDictIterator ()" +Destroys the iterator. +.SH "uint QIntDictIterator::count () const" +Returns the number of items in the dictionary this iterator operates over. +.PP +See also isEmpty(). +.SH "type * QIntDictIterator::current () const" +Returns a pointer to the current iterator item. +.SH "long QIntDictIterator::currentKey () const" +Returns the key for the current iterator item. +.SH "bool QIntDictIterator::isEmpty () const" +Returns TRUE if the dictionary is empty; otherwise eturns FALSE. +.PP +See also count(). +.SH "QIntDictIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QIntDictIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QIntDictIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns the new current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QIntDictIterator::operator+= ( uint jump )" +Sets the current item to the item \fIjump\fR positions after the current item, and returns a pointer to that item. +.PP +If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0. +.SH "type * QIntDictIterator::toFirst ()" +Sets the current iterator item to point to the first item in the +dictionary and returns a pointer to the item. The first item +refers to the first item in the dictionary's arbitrary internal +ordering. If the dictionary is empty it sets the current item to +0 and returns 0. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qintdictiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqintdictiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqintvalidator.3qt b/doc/man/man3/tqintvalidator.3qt new file mode 100644 index 000000000..e9201af78 --- /dev/null +++ b/doc/man/man3/tqintvalidator.3qt @@ -0,0 +1,203 @@ +'\" t +.TH QIntValidator 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 +QIntValidator \- Validator which ensures that a string contains a valid integer within a specified range +.SH SYNOPSIS +\fC#include <ntqvalidator.h>\fR +.PP +Inherits QValidator. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQIntValidator\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQIntValidator\fR ( int minimum, int maximum, QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QIntValidator\fR ()" +.br +.ti -1c +.BI "virtual QValidator::State \fBvalidate\fR ( QString & input, int & ) const" +.br +.ti -1c +.BI "void \fBsetBottom\fR ( int )" +.br +.ti -1c +.BI "void \fBsetTop\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBsetRange\fR ( int bottom, int top )" +.br +.ti -1c +.BI "int \fBbottom\fR () const" +.br +.ti -1c +.BI "int \fBtop\fR () const" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBbottom\fR - the validator's lowest acceptable value" +.br +.ti -1c +.BI "int \fBtop\fR - the validator's highest acceptable value" +.br +.in -1c +.SH DESCRIPTION +The QIntValidator class provides a validator which ensures that a string contains a valid integer within a specified range. +.PP +Example of use: +.PP +.nf +.br + QValidator* validator = new QIntValidator( 100, 999, this ); +.br + QLineEdit* edit = new QLineEdit( this ); +.br +.br + // the edit lineedit will only accept integers between 100 and 999 +.br + edit->setValidator( validator ); +.br +.fi +.PP +Below we present some examples of validators. In practice they would normally be associated with a widget as in the example above. +.PP +.nf +.br + QString str; +.br + int pos = 0; +.br + QIntValidator v( 100, 999, this ); +.br +.br + str = "1"; +.br + v.validate( str, pos ); // returns Intermediate +.br + str = "12"; +.br + v.validate( str, pos ); // returns Intermediate +.br +.br + str = "123"; +.br + v.validate( str, pos ); // returns Acceptable +.br + str = "678"; +.br + v.validate( str, pos ); // returns Acceptable +.br +.br + str = "1234"; +.br + v.validate( str, pos ); // returns Invalid +.br + str = "-123"; +.br + v.validate( str, pos ); // returns Invalid +.br + str = "abc"; +.br + v.validate( str, pos ); // returns Invalid +.br + str = "12cm"; +.br + v.validate( str, pos ); // returns Invalid +.br +.fi +.PP +The minimum and maximum values are set in one call with setRange() or individually with setBottom() and setTop(). +.PP +See also QDoubleValidator, QRegExpValidator, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIntValidator::QIntValidator ( QObject * parent, const char * name = 0 )" +Constructs a validator called \fIname\fR with parent \fIparent\fR, that accepts all integers. +.SH "QIntValidator::QIntValidator ( int minimum, int maximum, QObject * parent, const char * name = 0 )" +Constructs a validator called \fIname\fR with parent \fIparent\fR, that accepts integers from \fIminimum\fR to \fImaximum\fR inclusive. +.SH "QIntValidator::~QIntValidator ()" +Destroys the validator, freeing any resources allocated. +.SH "int QIntValidator::bottom () const" +Returns the validator's lowest acceptable value. See the "bottom" property for details. +.SH "void QIntValidator::setBottom ( int )" +Sets the validator's lowest acceptable value. See the "bottom" property for details. +.SH "void QIntValidator::setRange ( int bottom, int top )\fC [virtual]\fR" +Sets the range of the validator to only accept integers between \fIbottom\fR and \fItop\fR inclusive. +.SH "void QIntValidator::setTop ( int )" +Sets the validator's highest acceptable value. See the "top" property for details. +.SH "int QIntValidator::top () const" +Returns the validator's highest acceptable value. See the "top" property for details. +.SH "QValidator::State QIntValidator::validate ( QString & input, int & ) const\fC [virtual]\fR" +Returns Acceptable if the \fIinput\fR is an integer within the valid range, Intermediate if the \fIinput\fR is an integer outside the valid range and Invalid if the \fIinput\fR is not an integer. +.PP +Note: If the valid range consists of just positive integers (e.g. 32 - 100) and \fIinput\fR is a negative integer then Invalid is returned. +.PP +.nf +.br + int pos = 0; +.br + s = "abc"; +.br + v.validate( s, pos ); // returns Invalid +.br +.br + s = "5"; +.br + v.validate( s, pos ); // returns Intermediate +.br +.br + s = "50"; +.br + v.validate( s, pos ); // returns Valid +.br +.fi +.PP +Reimplemented from QValidator. +.SS "Property Documentation" +.SH "int bottom" +This property holds the validator's lowest acceptable value. +.PP +Set this property's value with setBottom() and get this property's value with bottom(). +.PP +See also setRange(). +.SH "int top" +This property holds the validator's highest acceptable value. +.PP +Set this property's value with setTop() and get this property's value with top(). +.PP +See also setRange(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qintvalidator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqintvalidator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqiodevice.3qt b/doc/man/man3/tqiodevice.3qt new file mode 100644 index 000000000..31a2b88c4 --- /dev/null +++ b/doc/man/man3/tqiodevice.3qt @@ -0,0 +1,551 @@ +'\" t +.TH QIODevice 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 +QIODevice \- The base class of I/O devices +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqiodevice.h>\fR +.PP +Inherited by QBuffer, QFile, QSocket, and QSocketDevice. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef TQ_ULONG \fBOffset\fR" +.br +.ti -1c +.BI "\fBQIODevice\fR ()" +.br +.ti -1c +.BI "virtual \fB~QIODevice\fR ()" +.br +.ti -1c +.BI "int \fBflags\fR () const" +.br +.ti -1c +.BI "int \fBmode\fR () const" +.br +.ti -1c +.BI "int \fBstate\fR () const" +.br +.ti -1c +.BI "bool \fBisDirectAccess\fR () const" +.br +.ti -1c +.BI "bool \fBisSequentialAccess\fR () const" +.br +.ti -1c +.BI "bool \fBisCombinedAccess\fR () const" +.br +.ti -1c +.BI "bool \fBisBuffered\fR () const" +.br +.ti -1c +.BI "bool \fBisRaw\fR () const" +.br +.ti -1c +.BI "bool \fBisSynchronous\fR () const" +.br +.ti -1c +.BI "bool \fBisAsynchronous\fR () const" +.br +.ti -1c +.BI "bool \fBisTranslated\fR () const" +.br +.ti -1c +.BI "bool \fBisReadable\fR () const" +.br +.ti -1c +.BI "bool \fBisWritable\fR () const" +.br +.ti -1c +.BI "bool \fBisReadWrite\fR () const" +.br +.ti -1c +.BI "bool \fBisInactive\fR () const" +.br +.ti -1c +.BI "bool \fBisOpen\fR () const" +.br +.ti -1c +.BI "int \fBstatus\fR () const" +.br +.ti -1c +.BI "void \fBresetStatus\fR ()" +.br +.ti -1c +.BI "virtual bool \fBopen\fR ( int mode ) = 0" +.br +.ti -1c +.BI "virtual void \fBclose\fR () = 0" +.br +.ti -1c +.BI "virtual void \fBflush\fR () = 0" +.br +.ti -1c +.BI "virtual Offset \fBsize\fR () const = 0" +.br +.ti -1c +.BI "virtual Offset \fBat\fR () const" +.br +.ti -1c +.BI "virtual bool \fBat\fR ( Offset pos )" +.br +.ti -1c +.BI "virtual bool \fBatEnd\fR () const" +.br +.ti -1c +.BI "bool \fBreset\fR ()" +.br +.ti -1c +.BI "virtual TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen ) = 0" +.br +.ti -1c +.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len ) = 0" +.br +.ti -1c +.BI "virtual TQ_LONG \fBreadLine\fR ( char * data, TQ_ULONG maxlen )" +.br +.ti -1c +.BI "TQ_LONG \fBwriteBlock\fR ( const QByteArray & data )" +.br +.ti -1c +.BI "virtual QByteArray \fBreadAll\fR ()" +.br +.ti -1c +.BI "virtual int \fBgetch\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBputch\fR ( int ch ) = 0" +.br +.ti -1c +.BI "virtual int \fBungetch\fR ( int ch ) = 0" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsetFlags\fR ( int flags )" +.br +.ti -1c +.BI "void \fBsetType\fR ( int type )" +.br +.ti -1c +.BI "void \fBsetMode\fR ( int mode )" +.br +.ti -1c +.BI "void \fBsetState\fR ( int state )" +.br +.ti -1c +.BI "void \fBsetStatus\fR ( int s )" +.br +.in -1c +.SH DESCRIPTION +The QIODevice class is the base class of I/O devices. +.PP +An I/O device represents a medium that one can read bytes from and/or write bytes to. The QIODevice class is the abstract superclass of all such devices; classes such as QFile, QBuffer and QSocket inherit QIODevice and implement virtual functions such as write() appropriately. +.PP +Although applications sometimes use QIODevice directly, it is usually better to use QTextStream and QDataStream, which provide stream operations on any QIODevice subclass. QTextStream provides text-oriented stream functionality (for human-readable ASCII files, for example), whereas QDataStream deals with binary data in a totally platform-independent manner. +.PP +The public member functions in QIODevice roughly fall into two groups: the action functions and the state access functions. The most important action functions are: +.IP +.TP +open() opens a device for reading and/or writing, depending on the mode argument. +.IP +.TP +close() closes the device and tidies up (e.g. flushes buffered data) +.IP +.TP +readBlock() reads a block of data from the device. +.IP +.TP +writeBlock() writes a block of data to the device. +.IP +.TP +readLine() reads a line (of text, usually) from the device. +.IP +.TP +flush() ensures that all buffered data are written to the real device. +.IP +.PP +There are also some other, less used, action functions: +.IP +.TP +getch() reads a single character. +.IP +.TP +ungetch() forgets the last call to getch(), if possible. +.IP +.TP +putch() writes a single character. +.IP +.TP +size() returns the size of the device, if there is one. +.IP +.TP +at() returns the current read/write pointer's position, if there is one for this device, or it moves the pointer if given an offset. +.IP +.TP +atEnd() indicates whether there is more to read, if this is meaningful for this device. +.IP +.TP +reset() moves the read/write pointer to the start of the device, if that is possible for this device. +.IP +.PP +The state access are all "get" functions. The QIODevice subclass calls setState() to update the state, and simple access functions tell the user of the device what the device's state is. Here are the settings, and their associated access functions: +.IP +.TP +Access type. Some devices are direct access (it is possible to read/write anywhere), whereas others are sequential. QIODevice provides the access functions (isDirectAccess(), isSequentialAccess(), and isCombinedAccess()) to tell users what a given I/O device supports. +.IP +.TP +Buffering. Some devices are accessed in raw mode, whereas others are buffered. Buffering usually provides greater efficiency, particularly for small read/write operations. isBuffered() tells the user whether a given device is buffered. (This can often be set by the application in the call to open().) +.IP +.TP +Synchronicity. Synchronous devices work immediately (for example, files). When you read from a file, the file delivers its data straight away. Other kinds of device, such as a socket connected to a HTTP server, may not deliver the data until seconds after you ask to read it. isSynchronous() and isAsynchronous() tell the user how this device operates. +.IP +.TP +CR/LF translation. For simplicity, applications often like to see just a single CR/LF style, and QIODevice subclasses can provide this. isTranslated() returns TRUE if this object translates CR/LF to just LF. (This can often be set by the application in the call to open().) +.IP +.TP +Permissions. Some files cannot be written. For example, isReadable(), isWritable() and isReadWrite() tell the application whether it can read from and write to a given device. (This can often be set by the application in the call to open().) +.IP +.TP +Finally, isOpen() returns TRUE if the device is open, i.e. after an open() call. +.IP +.PP +QIODevice provides numerous pure virtual functions that you need to implement when subclassing it. Here is a skeleton subclass with all the members you are sure to need and some that you will probably need: +.PP +.nf +.br + class MyDevice : public QIODevice +.br + { +.br + public: +.br + MyDevice(); +.br + ~MyDevice(); +.br +.br + bool open( int mode ); +.br + void close(); +.br + void flush(); +.br +.br + uint size() const; +.br + int at() const; // non-pure virtual +.br + bool at( int ); // non-pure virtual +.br + bool atEnd() const; // non-pure virtual +.br +.br + int readBlock( char *data, uint maxlen ); +.br + int writeBlock( const char *data, uint len ); +.br + int readLine( char *data, uint maxlen ); +.br +.br + int getch(); +.br + int putch( int ); +.br + int ungetch( int ); +.br + }; +.br +.fi +.PP +The three non-pure virtual functions need not be reimplemented for sequential devices. +.PP +See also QDataStream, QTextStream, and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QIODevice::Offset" +The offset within the device. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QIODevice::QIODevice ()" +Constructs an I/O device. +.SH "QIODevice::~QIODevice ()\fC [virtual]\fR" +Destroys the I/O device. +.SH "Offset QIODevice::at () const\fC [virtual]\fR" +Virtual function that returns the current I/O device position. +.PP +This is the position of the data read/write head of the I/O device. +.PP +See also size(). +.PP +Example: distributor/distributor.ui.h. +.PP +Reimplemented in QSocket. +.SH "bool QIODevice::at ( Offset pos )\fC [virtual]\fR" +Virtual function that sets the I/O device position to \fIpos\fR. Returns TRUE if the position was successfully set, i.e. \fIpos\fR is within range and the seek was successful; otherwise returns FALSE. +.PP +See also size(). +.PP +Reimplemented in QSocket. +.SH "bool QIODevice::atEnd () const\fC [virtual]\fR" +Virtual function that returns TRUE if the I/O device position is at the end of the input; otherwise returns FALSE. +.PP +Reimplemented in QFile and QSocket. +.SH "void QIODevice::close ()\fC [pure virtual]\fR" +Closes the I/O device. +.PP +This virtual function must be reimplemented by all subclasses. +.PP +See also open(). +.PP +Example: grapher/grapher.cpp. +.PP +Reimplemented in QFile and QSocket. +.SH "int QIODevice::flags () const" +Returns the current I/O device flags setting. +.PP +Flags consists of mode flags and state flags. +.PP +See also mode() and state(). +.SH "void QIODevice::flush ()\fC [pure virtual]\fR" +Flushes an open I/O device. +.PP +This virtual function must be reimplemented by all subclasses. +.PP +Reimplemented in QFile and QSocket. +.SH "int QIODevice::getch ()\fC [pure virtual]\fR" +Reads a single byte/character from the I/O device. +.PP +Returns the byte/character read, or -1 if the end of the I/O device has been reached. +.PP +This virtual function must be reimplemented by all subclasses. +.PP +See also putch() and ungetch(). +.PP +Reimplemented in QFile and QSocket. +.SH "bool QIODevice::isAsynchronous () const" +Returns TRUE if the device is an asynchronous device; otherwise returns FALSE, i.e. if the device is a synchronous device. +.PP +This mode is currently not in use. +.PP +See also isSynchronous(). +.SH "bool QIODevice::isBuffered () const" +Returns TRUE if the I/O device is a buffered device; otherwise returns FALSE, i.e. the device is a raw device. +.PP +See also isRaw(). +.SH "bool QIODevice::isCombinedAccess () const" +Returns TRUE if the I/O device is a combined access (both direct and sequential) device; otherwise returns FALSE. +.PP +This access method is currently not in use. +.SH "bool QIODevice::isDirectAccess () const" +Returns TRUE if the I/O device is a direct access device; otherwise returns FALSE, i.e. if the device is a sequential access device. +.PP +See also isSequentialAccess(). +.SH "bool QIODevice::isInactive () const" +Returns TRUE if the I/O device state is 0, i.e. the device is not open; otherwise returns FALSE. +.PP +See also isOpen(). +.SH "bool QIODevice::isOpen () const" +Returns TRUE if the I/O device has been opened; otherwise returns FALSE. +.PP +See also isInactive(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "bool QIODevice::isRaw () const" +Returns TRUE if the device is a raw device; otherwise returns FALSE, i.e. if the device is a buffered device. +.PP +See also isBuffered(). +.SH "bool QIODevice::isReadWrite () const" +Returns TRUE if the I/O device was opened using IO_ReadWrite mode; otherwise returns FALSE. +.PP +See also isReadable() and isWritable(). +.SH "bool QIODevice::isReadable () const" +Returns TRUE if the I/O device was opened using IO_ReadOnly or IO_ReadWrite mode; otherwise returns FALSE. +.PP +See also isWritable() and isReadWrite(). +.SH "bool QIODevice::isSequentialAccess () const" +Returns TRUE if the device is a sequential access device; otherwise returns FALSE, i.e. if the device is a direct access device. +.PP +Operations involving size() and at(int) are not valid on sequential devices. +.PP +See also isDirectAccess(). +.SH "bool QIODevice::isSynchronous () const" +Returns TRUE if the I/O device is a synchronous device; otherwise returns FALSE, i.e. the device is an asynchronous device. +.PP +See also isAsynchronous(). +.SH "bool QIODevice::isTranslated () const" +Returns TRUE if the I/O device translates carriage-return and linefeed characters; otherwise returns FALSE. +.PP +A QFile is translated if it is opened with the IO_Translate mode flag. +.SH "bool QIODevice::isWritable () const" +Returns TRUE if the I/O device was opened using IO_WriteOnly or IO_ReadWrite mode; otherwise returns FALSE. +.PP +See also isReadable() and isReadWrite(). +.SH "int QIODevice::mode () const" +Returns bits OR'ed together that specify the current operation mode. +.PP +These are the flags that were given to the open() function. +.PP +The flags are IO_ReadOnly, IO_WriteOnly, IO_ReadWrite, IO_Append, IO_Truncate and IO_Translate. +.SH "bool QIODevice::open ( int mode )\fC [pure virtual]\fR" +Opens the I/O device using the specified \fImode\fR. Returns TRUE if the device was successfully opened; otherwise returns FALSE. +.PP +The mode parameter \fImode\fR must be an OR'ed combination of the following flags. <center>.nf +.TS +l - l. Mode flags Meaning IO_Raw specifies raw (unbuffered) file access. IO_ReadOnly opens a file in read-only mode. IO_WriteOnly opens a file in write-only mode. IO_ReadWrite opens a file in read/write mode. IO_Append sets the file index to the end of the file. IO_Truncate truncates the file. IO_Translate +.TE +.fi +</center> +.PP +This virtual function must be reimplemented by all subclasses. +.PP +See also close(). +.PP +Example: grapher/grapher.cpp. +.PP +Reimplemented in QFile and QSocket. +.SH "int QIODevice::putch ( int ch )\fC [pure virtual]\fR" +Writes the character \fIch\fR to the I/O device. +.PP +Returns \fIch\fR, or -1 if an error occurred. +.PP +This virtual function must be reimplemented by all subclasses. +.PP +See also getch() and ungetch(). +.PP +Example: grapher/grapher.cpp. +.PP +Reimplemented in QFile and QSocket. +.SH "QByteArray QIODevice::readAll ()\fC [virtual]\fR" +This convenience function returns all of the remaining data in the device. +.SH "TQ_LONG QIODevice::readBlock ( char * data, TQ_ULONG maxlen )\fC [pure virtual]\fR" +Reads at most \fImaxlen\fR bytes from the I/O device into \fIdata\fR and returns the number of bytes actually read. +.PP +This function should return -1 if a fatal error occurs and should return 0 if there are no bytes to read. +.PP +The device must be opened for reading, and \fIdata\fR must not be 0. +.PP +This virtual function must be reimplemented by all subclasses. +.PP +See also writeBlock(), isOpen(), and isReadable(). +.PP +Example: distributor/distributor.ui.h. +.PP +Reimplemented in QSocket and QSocketDevice. +.SH "TQ_LONG QIODevice::readLine ( char * data, TQ_ULONG maxlen )\fC [virtual]\fR" +Reads a line of text, (or up to \fImaxlen\fR bytes if a newline isn't encountered) plus a terminating '\0' into \fIdata\fR. If there is a newline at the end if the line, it is not stripped. +.PP +Returns the number of bytes read including the terminating '\0', or -1 if an error occurred. +.PP +This virtual function can be reimplemented much more efficiently by the most subclasses. +.PP +See also readBlock() and QTextStream::readLine(). +.PP +Reimplemented in QFile. +.SH "bool QIODevice::reset ()" +Sets the device index position to 0. +.PP +See also at(). +.SH "void QIODevice::resetStatus ()" +Sets the I/O device status to IO_Ok. +.PP +See also status(). +.SH "void QIODevice::setFlags ( int flags )\fC [protected]\fR" +Used by subclasses to set the device flags to the \fIflags\fR specified. +.SH "void QIODevice::setMode ( int mode )\fC [protected]\fR" +Used by subclasses to set the device mode to the \fImode\fR specified. +.SH "void QIODevice::setState ( int state )\fC [protected]\fR" +Used by subclasses to set the device state to the \fIstate\fR specified. +.SH "void QIODevice::setStatus ( int s )\fC [protected]\fR" +Used by subclasses to set the device status (not state) to \fIs\fR. +.SH "void QIODevice::setType ( int type )\fC [protected]\fR" +Used by subclasses to set the device type to the \fItype\fR specified. +.SH "Offset QIODevice::size () const\fC [pure virtual]\fR" +Virtual function that returns the size of the I/O device. +.PP +See also at(). +.PP +Reimplemented in QFile and QSocket. +.SH "int QIODevice::state () const" +Returns bits OR'ed together that specify the current state. +.PP +The flags are: \fCIO_Open\fR. +.PP +Subclasses may define additional flags. +.SH "int QIODevice::status () const" +Returns the I/O device status. +.PP +The I/O device status returns an error code. If open() returns FALSE or readBlock() or writeBlock() return -1, this function can be called to find out the reason why the operation failed. +.PP + +.PP +The status codes are: <center>.nf +.TS +l - l. Status code Meaning IO_Ok The operation was successful. IO_ReadError Could not read from the device. IO_WriteError Could not write to the device. IO_FatalError A fatal unrecoverable error occurred. IO_OpenError Could not open the device. IO_ConnectError Could not connect to the device. IO_AbortError The operation was unexpectedly aborted. IO_TimeOutError The operation timed out. IO_UnspecifiedError +.TE +.fi +</center> +.PP +See also resetStatus(). +.SH "int QIODevice::ungetch ( int ch )\fC [pure virtual]\fR" +Puts the character \fIch\fR back into the I/O device and decrements the index position if it is not zero. +.PP +This function is normally called to "undo" a getch() operation. +.PP +Returns \fIch\fR, or -1 if an error occurred. +.PP +This virtual function must be reimplemented by all subclasses. +.PP +See also getch() and putch(). +.PP +Reimplemented in QFile and QSocket. +.SH "TQ_LONG QIODevice::writeBlock ( const char * data, TQ_ULONG len )\fC [pure virtual]\fR" +Writes \fIlen\fR bytes from \fIdata\fR to the I/O device and returns the number of bytes actually written. +.PP +This function should return -1 if a fatal error occurs. +.PP +This virtual function must be reimplemented by all subclasses. +.PP +See also readBlock(). +.PP +Example: distributor/distributor.ui.h. +.PP +Reimplemented in QBuffer, QSocket, and QSocketDevice. +.SH "TQ_LONG QIODevice::writeBlock ( const QByteArray & data )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This convenience function is the same as calling writeBlock( +data.data(), data.size() ). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqiodevice.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqiodevice.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqjiscodec.3qt b/doc/man/man3/tqjiscodec.3qt new file mode 100644 index 000000000..7a973faf2 --- /dev/null +++ b/doc/man/man3/tqjiscodec.3qt @@ -0,0 +1,96 @@ +'\" t +.TH QJisCodec 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 +QJisCodec \- Conversion to and from JIS character sets +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqjiscodec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual const char * \fBmimeName\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QJisCodec class provides conversion to and from JIS character sets. +.PP +More precisely, the QJisCodec class subclasses QTextCodec to provide support for JIS X 0201 Latin, JIS X 0201 Kana, JIS X 0208 and JIS X 0212. +.PP +The environment variable UNICODEMAP_JP can be used to fine-tune QJisCodec, QSjisCodec and QEucJpCodec. The mapping names are as for the Japanese XML working group's XML Japanese Profile, because it names and explains all the widely used mappings. Here are brief descriptions, written by Serika Kurusugawa: +.IP +.TP +"unicode-0.9" or "unicode-0201" for Unicode style. This assumes JISX0201 for 0x00-0x7f. (0.9 is a table version of jisx02xx mapping used for Uniocde spec version 1.1.) +.IP +.TP +"unicode-ascii" This assumes US-ASCII for 0x00-0x7f; some chars (JISX0208 0x2140 and JISX0212 0x2237) are different from Unicode 1.1 to avoid conflict. +.IP +.TP +"open-19970715-0201" ("open-0201" for convenience) or" jisx0221-1995" for JISX0221-JISX0201 style. JIS X 0221 is JIS version of Unicode, but a few chars (0x5c, 0x7e, 0x2140, 0x216f, 0x2131) are different from Unicode 1.1. This is used when 0x5c is treated as YEN SIGN. +.IP +.TP +"open-19970715-ascii" ("open-ascii" for convenience) for JISX0221-ASCII style. This is used when 0x5c is treated as REVERSE SOLIDUS. +.IP +.TP +"open-19970715-ms" ("open-ms" for convenience) or "cp932" for Microsoft Windows style. Windows Code Page 932. Some chars (0x2140, 0x2141, 0x2142, 0x215d, 0x2171, 0x2172) are different from Unicode 1.1. +.IP +.TP +"jdk1.1.7" for Sun's JDK style. Same as Unicode 1.1, except that JIS 0x2140 is mapped to UFF3C. Either ASCII or JISX0201 can be used for 0x00-0x7f. +.IP +.PP +In addition, the extensions "nec-vdc", "ibm-vdc" and "udc" are supported. +.PP +For example, if you want to use Unicode style conversion but with NEC's extension, set \fCUNICODEMAP_JP\fR to <nobr>\fCunicode-0.9, nec-vdc\fR.</nobr> (You will probably need to quote that in a shell command.) +.PP +Most of the code here was written by Serika Kurusugawa, a.k.a. Junji Takagi, and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for that code: +.PP +Copyright (C) 1999 Serika Kurusugawa. All rights reserved. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> +.TP +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.TP +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS". ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.PP +See also Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "const char * QJisCodec::mimeName () const\fC [virtual]\fR" +Returns the codec's mime name. +.PP +Reimplemented from QTextCodec. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqjiscodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqjiscodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqkbddriverfactory.3qt b/doc/man/man3/tqkbddriverfactory.3qt new file mode 100644 index 000000000..ccc6fdf50 --- /dev/null +++ b/doc/man/man3/tqkbddriverfactory.3qt @@ -0,0 +1,59 @@ +'\" t +.TH QKbdDriverFactory 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 +QKbdDriverFactory \- Creates QWSKeyboardHandler objects for Qt/Embedded +.SH SYNOPSIS +\fC#include <qkbddriverfactory_qws.h>\fR +.PP +.SS "Static Public Members" +<li class=fn>QStringList \fBkeys\fR () <li class=fn>QWSKeyboardHandler * \fBcreate\fR ( const QString & key, const QString & device ) +.SH DESCRIPTION +The QKbdDriverFactory class creates QWSKeyboardHandler objects for Qt/Embedded. +.PP +The graphics driver factory creates a QWSKeyboardHandler object for a given key with QKbdDriverFactory::create(key). +.PP +The drivers are either built-in or dynamically loaded from a driver plugin (see QKbdDriverPlugin). +.PP +This class is only available in Qt/Embedded. +.PP +QKbdDriverFactory::keys() returns a list of valid keys. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSKeyboardHandler * QKbdDriverFactory::create ( const QString & key, const QString & device )\fC [static]\fR" +Creates a QWSKeyboardHandler object that matches \fIkey\fR for device \fIdevice\fR. This is either a built-in driver, or a driver from a driver plugin. +.PP +See also keys(). +.SH "QStringList QKbdDriverFactory::keys ()\fC [static]\fR" +Returns the list of keys this factory can create drivers for. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qkbddriverfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqkbddriverfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqkbddriverplugin.3qt b/doc/man/man3/tqkbddriverplugin.3qt new file mode 100644 index 000000000..2b5d06eeb --- /dev/null +++ b/doc/man/man3/tqkbddriverplugin.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QKbdDriverPlugin 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 +QKbdDriverPlugin \- Abstract base for Qt/Embedded keyboard driver plugins +.SH SYNOPSIS +\fC#include <qkbddriverplugin_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQKbdDriverPlugin\fR ()" +.br +.ti -1c +.BI "\fB~QKbdDriverPlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBkeys\fR () const = 0" +.br +.ti -1c +.BI "virtual QWSKeyboardHandler * \fBcreate\fR ( const QString & driver, const QString & device ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QKbdDriverPlugin class provides an abstract base for Qt/Embedded keyboard driver plugins. +.PP +The keyboard driver plugin is a simple plugin interface that makes it easy to create custom keyboard drivers. +.PP +Writing a keyboard driver plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Plugins documentation for details. +.PP +This class is only available in Qt/Embedded. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QKbdDriverPlugin::QKbdDriverPlugin ()" +Constructs a keyboard driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. +.SH "QKbdDriverPlugin::~QKbdDriverPlugin ()" +Destroys the keyboard driver plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "QWSKeyboardHandler * QKbdDriverPlugin::create ( const QString & driver, const QString & device )\fC [pure virtual]\fR" +Creates a driver matching the type specified by \fIdriver\fR and \fIdevice\fR. +.PP +See also keys(). +.SH "QStringList QKbdDriverPlugin::keys () const\fC [pure virtual]\fR" +Returns the list of keyboard drivers this plugin supports. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qkbddriverplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqkbddriverplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqkeyevent.3qt b/doc/man/man3/tqkeyevent.3qt new file mode 100644 index 000000000..1a7faeef4 --- /dev/null +++ b/doc/man/man3/tqkeyevent.3qt @@ -0,0 +1,155 @@ +'\" t +.TH QKeyEvent 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 +QKeyEvent \- Describes a key event +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQKeyEvent\fR ( Type type, int key, int ascii, int state, const QString & text = QString::null, bool autorep = FALSE, ushort count = 1 )" +.br +.ti -1c +.BI "int \fBkey\fR () const" +.br +.ti -1c +.BI "int \fBascii\fR () const" +.br +.ti -1c +.BI "ButtonState \fBstate\fR () const" +.br +.ti -1c +.BI "ButtonState \fBstateAfter\fR () const" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "bool \fBisAutoRepeat\fR () const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QKeyEvent class contains describes a key event. +.PP +Key events occur when a key is pressed or released when a widget has keyboard input focus. +.PP +A key event contains a special accept flag that indicates whether the receiver wants the key event. You should call QKeyEvent::ignore() if the key press or release event is not handled by your widget. A key event is propagated up the parent widget chain until a widget accepts it with QKeyEvent::accept() or an event filter consumes it. Key events for multi media keys are ignored by default. You should call QKeyEvent::accept() if your widget handles those events. +.PP +The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget. +.PP +The event handlers QWidget::keyPressEvent() and QWidget::keyReleaseEvent() receive key events. +.PP +See also QFocusEvent, QWidget::grabKeyboard(), and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QKeyEvent::QKeyEvent ( Type type, int key, int ascii, int state, const QString & text = QString::null, bool autorep = FALSE, ushort count = 1 )" +Constructs a key event object. +.PP +The \fItype\fR parameter must be QEvent::KeyPress or QEvent::KeyRelease. If \fIkey\fR is 0 the event is not a result of a known key (e.g. it may be the result of a compose sequence or keyboard macro). \fIascii\fR is the ASCII code of the key that was pressed or released. \fIstate\fR holds the keyboard modifiers. \fItext\fR is the Unicode text that the key generated. If \fIautorep\fR is TRUE, isAutoRepeat() will be TRUE. \fIcount\fR is the number of single keys. +.PP +The accept flag is set to TRUE. +.SH "void QKeyEvent::accept ()" +Sets the accept flag of the key event object. +.PP +Setting the accept parameter indicates that the receiver of the event wants the key event. Unwanted key events are sent to the parent widget. +.PP +The accept flag is set by default. +.PP +See also ignore(). +.SH "int QKeyEvent::ascii () const" +Returns the ASCII code of the key that was pressed or released. We recommend using text() instead. +.PP +See also text(). +.PP +Example: picture/picture.cpp. +.SH "int QKeyEvent::count () const" +Returns the number of single keys for this event. If text() is not empty, this is simply the length of the string. +.PP +See also QWidget::setKeyCompression(). +.SH "void QKeyEvent::ignore ()" +Clears the accept flag parameter of the key event object. +.PP +Clearing the accept parameter indicates that the event receiver does not want the key event. Unwanted key events are sent to the parent widget. +.PP +The accept flag is set by default. +.PP +See also accept(). +.SH "bool QKeyEvent::isAccepted () const" +Returns TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE +.SH "bool QKeyEvent::isAutoRepeat () const" +Returns TRUE if this event comes from an auto-repeating key and FALSE if it comes from an initial key press. +.PP +Note that if the event is a multiple-key compressed event that is partly due to auto-repeat, this function could return either TRUE or FALSE indeterminately. +.SH "int QKeyEvent::key () const" +Returns the code of the key that was pressed or released. +.PP +See Qt::Key for the list of keyboard codes. These codes are independent of the underlying window system. +.PP +A value of either 0 or Key_unknown means that the event is not the result of a known key (e.g. it may be the result of a compose sequence or a keyboard macro, or due to key event compression). +.PP +See also QWidget::setKeyCompression(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "ButtonState QKeyEvent::state () const" +Returns the keyboard modifier flags that existed immediately before the event occurred. +.PP +The returned value is ShiftButton, ControlButton, AltButton and MetaButton OR'ed together. +.PP +See also stateAfter(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "ButtonState QKeyEvent::stateAfter () const" +Returns the keyboard modifier flags that existed immediately after the event occurred. +.PP +\fBWarning:\fR This function cannot be trusted. +.PP +See also state(). +.SH "QString QKeyEvent::text () const" +Returns the Unicode text that this key generated. The text returned migth be empty, which is the case when pressing or releasing modifying keys as Shift, Control, Alt and Meta. In these cases key() will contain a valid value. +.PP +See also QWidget::setKeyCompression(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qkeyevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqkeyevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqkeysequence.3qt b/doc/man/man3/tqkeysequence.3qt new file mode 100644 index 000000000..b93c22f65 --- /dev/null +++ b/doc/man/man3/tqkeysequence.3qt @@ -0,0 +1,169 @@ +'\" t +.TH QKeySequence 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 +QKeySequence \- Encapsulates a key sequence as used by accelerators +.SH SYNOPSIS +\fC#include <ntqkeysequence.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQKeySequence\fR ()" +.br +.ti -1c +.BI "\fBQKeySequence\fR ( const QString & key )" +.br +.ti -1c +.BI "\fBQKeySequence\fR ( int key )" +.br +.ti -1c +.BI "\fBQKeySequence\fR ( int k1, int k2, int k3 = 0, int k4 = 0 )" +.br +.ti -1c +.BI "\fBQKeySequence\fR ( const QKeySequence & keysequence )" +.br +.ti -1c +.BI "\fB~QKeySequence\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "Qt::SequenceMatch \fBmatches\fR ( const QKeySequence & seq ) const" +.br +.ti -1c +.BI "\fBoperator QString\fR () const" +.br +.ti -1c +.BI "operator int () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBoperator[]\fR ( uint index ) const" +.br +.ti -1c +.BI "QKeySequence & \fBoperator=\fR ( const QKeySequence & keysequence )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QKeySequence & keysequence ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QKeySequence & keysequence ) const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QKeySequence & keysequence )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QKeySequence & keysequence )" +.br +.in -1c +.SH DESCRIPTION +The QKeySequence class encapsulates a key sequence as used by accelerators. +.PP +A key sequence consists of up to four keyboard codes, each optionally combined with modifiers, e.g. SHIFT, CTRL, ALT, META, or UNICODE_ACCEL. For example, \fCCTRL + Key_P\fR might be a sequence used as a shortcut for printing a document. The key codes are listed in ntqnamespace.h. As an alternative, use UNICODE_ACCEL with the unicode code point of the character. For example, \fCUNICODE_ACCEL + 'A'\fR gives the same key sequence as Key_A. +.PP +Key sequences can be constructed either from an integer key code, or from a human readable translatable string such as" Ctrl+X,Alt+Space". A key sequence can be cast to a QString to obtain a human readable translated version of the sequence. Translations are done in the "QAccel" context. +.PP +See also QAccel and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QKeySequence::QKeySequence ()" +Constructs an empty key sequence. +.SH "QKeySequence::QKeySequence ( const QString & key )" +Creates a key sequence from the string \fIkey\fR. For example" Ctrl+O" gives CTRL+UNICODE_ACCEL+'O'. The strings "Ctrl"," Shift", "Alt" and "Meta" are recognized, as well as their translated equivalents in the "QAccel" context (using QObject::tr()). +.PP +Multiple key codes (up to four) may be entered by separating them with commas, e.g. "Alt+X,Ctrl+S,Q". +.PP +This contructor is typically used with tr(), so that accelerator keys can be replaced in translations: +.PP +.nf +.br + QPopupMenu *file = new QPopupMenu( this ); +.br + file->insertItem( tr("&Open..."), this, SLOT(open()), +.br + QKeySequence( tr("Ctrl+O", "File|Open") ) ); +.br +.fi +.PP +Note the \fC"File|Open"\fR translator comment. It is by no means necessary, but it provides some context for the human translator. +.SH "QKeySequence::QKeySequence ( int key )" +Constructs a key sequence that has a single \fIkey\fR. +.PP +The key codes are listed in ntqnamespace.h and can be combined with modifiers, e.g. with SHIFT, CTRL, ALT, META or UNICODE_ACCEL. +.SH "QKeySequence::QKeySequence ( int k1, int k2, int k3 = 0, int k4 = 0 )" +Constructs a key sequence with up to 4 keys \fIk1\fR, \fIk2\fR, \fIk3\fR and \fIk4\fR. +.PP +The key codes are listed in ntqnamespace.h and can be combined with modifiers, e.g. with SHIFT, CTRL, ALT, META or UNICODE_ACCEL. +.SH "QKeySequence::QKeySequence ( const QKeySequence & keysequence )" +Copy constructor. Makes a copy of \fIkeysequence\fR. +.SH "QKeySequence::~QKeySequence ()" +Destroys the key sequence. +.SH "uint QKeySequence::count () const" +Returns the number of keys in the key sequence. The maximum is 4. +.SH "bool QKeySequence::isEmpty () const" +Returns TRUE if the key sequence is empty; otherwise returns FALSE. +.SH "Qt::SequenceMatch QKeySequence::matches ( const QKeySequence & seq ) const" +Matches the sequence with \fIseq\fR. Returns Qt::Identical if successful, Qt::PartialMatch for matching but incomplete \fIseq\fR, and Qt::NoMatch if the sequences have nothing in common. Returns Qt::NoMatch if \fIseq\fR is shorter. +.SH "QKeySequence::operator QString () const" +Creates an accelerator string for the key sequence. For instance CTRL+Key_O gives "Ctrl+O". If the key sequence has multiple key codes they are returned comma-separated, e.g." Alt+X, Ctrl+Y, Z". The strings, "Ctrl", "Shift", etc. are translated (using QObject::tr()) in the "QAccel" scope. If the key sequence has no keys, QString::null is returned. +.PP +On Mac OS X, the string returned resembles the sequence that is shown in the menubar. +.SH "QKeySequence::operator int () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +For backward compatibility: returns the first keycode as integer. If the key sequence is empty, 0 is returned. +.SH "bool QKeySequence::operator!= ( const QKeySequence & keysequence ) const" +Returns TRUE if \fIkeysequence\fR is not equal to this key sequence; otherwise returns FALSE. +.SH "QKeySequence & QKeySequence::operator= ( const QKeySequence & keysequence )" +Assignment operator. Assigns \fIkeysequence\fR to this object. +.SH "bool QKeySequence::operator== ( const QKeySequence & keysequence ) const" +Returns TRUE if \fIkeysequence\fR is equal to this key sequence; otherwise returns FALSE. +.SH "int QKeySequence::operator[] ( uint index ) const" +Returns a reference to the element at position \fIindex\fR in the key sequence. This can only be used to read an element. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QKeySequence & keysequence )" +Writes the key sequence \fIkeysequence\fR to the stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QKeySequence & keysequence )" +Reads a key sequence from the stream \fIs\fR into the key sequence \fIkeysequence\fR. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqkeysequence.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqkeysequence.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlabel.3qt b/doc/man/man3/tqlabel.3qt new file mode 100644 index 000000000..03f382615 --- /dev/null +++ b/doc/man/man3/tqlabel.3qt @@ -0,0 +1,435 @@ +'\" t +.TH QLabel 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 +QLabel \- Text or image display +.SH SYNOPSIS +\fC#include <ntqlabel.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQLabel\fR ( QWidget * parent, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQLabel\fR ( const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQLabel\fR ( QWidget * buddy, const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QLabel\fR ()" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "QPicture * \fBpicture\fR () const" +.br +.ti -1c +.BI "QMovie * \fBmovie\fR () const" +.br +.ti -1c +.BI "TextFormat \fBtextFormat\fR () const" +.br +.ti -1c +.BI "void \fBsetTextFormat\fR ( TextFormat )" +.br +.ti -1c +.BI "int \fBalignment\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAlignment\fR ( int )" +.br +.ti -1c +.BI "int \fBindent\fR () const" +.br +.ti -1c +.BI "void \fBsetIndent\fR ( int )" +.br +.ti -1c +.BI "bool autoResize () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void setAutoResize ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBhasScaledContents\fR () const" +.br +.ti -1c +.BI "void \fBsetScaledContents\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetBuddy\fR ( QWidget * buddy )" +.br +.ti -1c +.BI "QWidget * \fBbuddy\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFont\fR ( const QFont & f )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" +.br +.ti -1c +.BI "virtual void \fBsetPicture\fR ( const QPicture & picture )" +.br +.ti -1c +.BI "virtual void \fBsetMovie\fR ( const QMovie & movie )" +.br +.ti -1c +.BI "virtual void \fBsetNum\fR ( int num )" +.br +.ti -1c +.BI "virtual void \fBsetNum\fR ( double num )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "Alignment \fBalignment\fR - the alignment of the label's contents" +.br +.ti -1c +.BI "BackgroundMode \fBbackgroundMode\fR - the label's background mode \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBindent\fR - the label's text indent in pixels" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR - the label's pixmap" +.br +.ti -1c +.BI "bool \fBscaledContents\fR - whether the label will scale its contents to fill all available space" +.br +.ti -1c +.BI "QString \fBtext\fR - the label's text" +.br +.ti -1c +.BI "TextFormat \fBtextFormat\fR - the label's text format" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * p )" +.br +.in -1c +.SH DESCRIPTION +The QLabel widget provides a text or image display. +.PP +QLabel is used for displaying text or an image. No user interaction functionality is provided. The visual appearance of the label can be configured in various ways, and it can be used for specifying a focus accelerator key for another widget. +.PP +A QLabel can contain any of the following content types: <center>.nf +.TS +l - l. Content Setting Plain text Pass a QString to setText(). Rich text Pass a QString that contains rich text to setText(). A pixmap Pass a QPixmap to setPixmap(). A movie Pass a QMovie to setMovie(). A number Pass an \fIint\fR or a \fIdouble\fR to setNum(), which converts the number to plain text. Nothing +.TE +.fi +</center> +.PP +When the content is changed using any of these functions, any previous content is cleared. +.PP +The look of a QLabel can be tuned in several ways. All the settings of QFrame are available for specifying a widget frame. The positioning of the content within the QLabel widget area can be tuned with setAlignment() and setIndent(). For example, this code sets up a sunken panel with a two-line text in the bottom right corner (both lines being flush with the right side of the label): +.PP +.nf +.br + QLabel *label = new QLabel( this ); +.br + label->setFrameStyle( QFrame::Panel | QFrame::Sunken ); +.br + label->setText( "first line\\nsecond line" ); +.br + label->setAlignment( AlignBottom | AlignRight ); +.br +.fi +.PP +A QLabel is often used as a label for an interactive widget. For this use QLabel provides a useful mechanism for adding an accelerator key (see QAccel) that will set the keyboard focus to the other widget (called the QLabel's "buddy"). For example: +.PP +.nf +.br + QLineEdit* phoneEdit = new QLineEdit( this, "phoneEdit" ); +.br + QLabel* phoneLabel = new QLabel( phoneEdit, "&Phone:", this, "phoneLabel" ); +.br +.fi +.PP +In this example, keyboard focus is transferred to the label's buddy (the QLineEdit) when the user presses Alt+P. You can also use the setBuddy() function to accomplish the same thing. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QLineEdit, QTextEdit, QPixmap, QMovie, GUI Design Handbook: Label, Basic Widgets, and Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLabel::QLabel ( QWidget * parent, const char * name = 0, WFlags f = 0 )" +Constructs an empty label. +.PP +The \fIparent\fR, \fIname\fR and widget flag \fIf\fR, arguments are passed to the QFrame constructor. +.PP +See also alignment, setFrameStyle(), and indent. +.SH "QLabel::QLabel ( const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" +Constructs a label that displays the text, \fItext\fR. +.PP +The \fIparent\fR, \fIname\fR and widget flag \fIf\fR, arguments are passed to the QFrame constructor. +.PP +See also text, alignment, setFrameStyle(), and indent. +.SH "QLabel::QLabel ( QWidget * buddy, const QString & text, QWidget * parent, const char * name = 0, WFlags f = 0 )" +Constructs a label that displays the text \fItext\fR. The label has a buddy widget, \fIbuddy\fR. +.PP +If the \fItext\fR contains an underlined letter (a letter preceded by an ampersand, &), and the text is in plain text format, when the user presses Alt+ the underlined letter, focus is passed to the buddy widget. +.PP +The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QFrame constructor. +.PP +See also text, setBuddy(), alignment, setFrameStyle(), and indent. +.SH "QLabel::~QLabel ()" +Destroys the label. +.SH "int QLabel::alignment () const" +Returns the alignment of the label's contents. See the "alignment" property for details. +.SH "bool QLabel::autoResize () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if auto-resizing is enabled, or FALSE if auto-resizing is disabled. +.PP +Auto-resizing is disabled by default. +.PP +See also setAutoResize(). +.SH "QWidget * QLabel::buddy () const" +Returns this label's buddy, or 0 if no buddy is currently set. +.PP +See also setBuddy(). +.SH "void QLabel::clear ()\fC [slot]\fR" +Clears any label contents. Equivalent to setText( "" ). +.SH "void QLabel::drawContents ( QPainter * p )\fC [virtual protected]\fR" +Draws the label contents using the painter \fIp\fR. +.PP +Reimplemented from QFrame. +.SH "bool QLabel::hasScaledContents () const" +Returns TRUE if the label will scale its contents to fill all available space; otherwise returns FALSE. See the "scaledContents" property for details. +.SH "int QLabel::indent () const" +Returns the label's text indent in pixels. See the "indent" property for details. +.SH "QMovie * QLabel::movie () const" +Returns a pointer to the label's movie, or 0 if no movie has been set. +.PP +See also setMovie(). +.SH "QPicture * QLabel::picture () const" +Returns the label's picture or 0 if the label doesn't have a picture. +.SH "QPixmap * QLabel::pixmap () const" +Returns the label's pixmap. See the "pixmap" property for details. +.SH "void QLabel::setAlignment ( int )\fC [virtual]\fR" +Sets the alignment of the label's contents. See the "alignment" property for details. +.SH "void QLabel::setAutoResize ( bool enable )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Enables auto-resizing if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. +.PP +When auto-resizing is enabled the label will resize itself to fit the contents whenever the contents change. The top-left corner is not moved. This is useful for QLabel widgets that are not managed by a QLayout (e.g., top-level widgets). +.PP +Auto-resizing is disabled by default. +.PP +See also autoResize(), adjustSize(), and sizeHint. +.SH "void QLabel::setBuddy ( QWidget * buddy )\fC [virtual]\fR" +Sets this label's buddy to \fIbuddy\fR. +.PP +When the user presses the accelerator key indicated by this label, the keyboard focus is transferred to the label's buddy widget. +.PP +The buddy mechanism is only available for QLabels that contain plain text in which one letter is prefixed with an ampersand, &. This letter is set as the accelerator key. The letter is displayed underlined, and the '&' is not displayed (i.e. the ShowPrefix alignment flag is turned on; see setAlignment()). +.PP +In a dialog, you might create two data entry widgets and a label for each, and set up the geometry layout so each label is just to the left of its data entry widget (its "buddy"), for example: +.PP +.nf +.br + QLineEdit *nameEd = new QLineEdit( this ); +.br + QLabel *nameLb = new QLabel( "&Name:", this ); +.br + nameLb->setBuddy( nameEd ); +.br + QLineEdit *phoneEd = new QLineEdit( this ); +.br + QLabel *phoneLb = new QLabel( "&Phone:", this ); +.br + phoneLb->setBuddy( phoneEd ); +.br + // ( layout setup not shown ) +.br +.fi +.PP +With the code above, the focus jumps to the Name field when the user presses Alt+N, and to the Phone field when the user presses Alt+P. +.PP +To unset a previously set buddy, call this function with \fIbuddy\fR set to 0. +.PP +See also buddy(), text, QAccel, and alignment. +.PP +Examples: +.)l addressbook/centralwidget.cpp, chart/optionsform.cpp, and regexptester/regexptester.cpp. +.SH "void QLabel::setFont ( const QFont & f )\fC [virtual]\fR" +Sets the font used on the QLabel to font \fIf\fR. +.PP +Example: menu/menu.cpp. +.PP +Reimplemented from QWidget. +.SH "void QLabel::setIndent ( int )" +Sets the label's text indent in pixels. See the "indent" property for details. +.SH "void QLabel::setMovie ( const QMovie & movie )\fC [virtual slot]\fR" +Sets the label contents to \fImovie\fR. Any previous content is cleared. +.PP +The buddy accelerator, if any, is disabled. +.PP +The label resizes itself if auto-resizing is enabled. +.PP +See also movie() and setBuddy(). +.SH "void QLabel::setNum ( int num )\fC [virtual slot]\fR" +Sets the label contents to plain text containing the textual representation of integer \fInum\fR. Any previous content is cleared. Does nothing if the integer's string representation is the same as the current contents of the label. +.PP +The buddy accelerator, if any, is disabled. +.PP +The label resizes itself if auto-resizing is enabled. +.PP +See also text, QString::setNum(), and setBuddy(). +.SH "void QLabel::setNum ( double num )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the label contents to plain text containing the textual representation of double \fInum\fR. Any previous content is cleared. Does nothing if the double's string representation is the same as the current contents of the label. +.PP +The buddy accelerator, if any, is disabled. +.PP +The label resizes itself if auto-resizing is enabled. +.PP +See also text, QString::setNum(), and setBuddy(). +.SH "void QLabel::setPicture ( const QPicture & picture )\fC [virtual slot]\fR" +Sets the label contents to \fIpicture\fR. Any previous content is cleared. +.PP +The buddy accelerator, if any, is disabled. +.PP +See also picture() and setBuddy(). +.SH "void QLabel::setPixmap ( const QPixmap & )\fC [virtual slot]\fR" +Sets the label's pixmap. See the "pixmap" property for details. +.SH "void QLabel::setScaledContents ( bool )" +Sets whether the label will scale its contents to fill all available space. See the "scaledContents" property for details. +.SH "void QLabel::setText ( const QString & )\fC [virtual slot]\fR" +Sets the label's text. See the "text" property for details. +.SH "void QLabel::setTextFormat ( TextFormat )" +Sets the label's text format. See the "textFormat" property for details. +.SH "QString QLabel::text () const" +Returns the label's text. See the "text" property for details. +.SH "TextFormat QLabel::textFormat () const" +Returns the label's text format. See the "textFormat" property for details. +.SS "Property Documentation" +.SH "Alignment alignment" +This property holds the alignment of the label's contents. +.PP +The alignment is a bitwise OR of Qt::AlignmentFlags and Qt::TextFlags values. The ExpandTabs, SingleLine and ShowPrefix flags apply only if the label contains plain text; otherwise they are ignored. The DontClip flag is always ignored. WordBreak applies to both rich text and plain text labels. The BreakAnywhere flag is not supported in QLabel. +.PP +If the label has a buddy, the ShowPrefix flag is forced to TRUE. +.PP +The default alignment is \fCAlignAuto | AlignVCenter | ExpandTabs\fR if the label doesn't have a buddy and \fCAlignAuto | AlignVCenter | ExpandTabs | ShowPrefix\fR if the label has a buddy. If the label contains rich text, additionally WordBreak is turned on. +.PP +See also Qt::AlignmentFlags, setBuddy(), and text. +.PP +Set this property's value with setAlignment() and get this property's value with alignment(). +.SH "BackgroundMode backgroundMode" +This property holds the label's background mode. +.PP +Get this property with backgroundMode(). +.PP +See also QWidget::backgroundMode. +.SH "int indent" +This property holds the label's text indent in pixels. +.PP +If a label displays text, the indent applies to the left edge if alignment() is AlignLeft, to the right edge if alignment() is AlignRight, to the top edge if alignment() is AlignTop, and to to the bottom edge if alignment() is AlignBottom. +.PP +If indent is negative, or if no indent has been set, the label computes the effective indent as follows: If frameWidth() is 0, the effective indent becomes 0. If frameWidth() is greater than 0, the effective indent becomes half the width of the "x" character of the widget's current font(). +.PP +See also alignment, frameWidth, and font. +.PP +Set this property's value with setIndent() and get this property's value with indent(). +.SH "QPixmap pixmap" +This property holds the label's pixmap. +.PP +If no pixmap has been set this will return an invalid pixmap. +.PP +Setting the pixmap clears any previous content, and resizes the label if QLabel::autoResize() is TRUE. The buddy accelerator, if any, is disabled. +.PP +Set this property's value with setPixmap() and get this property's value with pixmap(). +.SH "bool scaledContents" +This property holds whether the label will scale its contents to fill all available space. +.PP +When enabled and the label shows a pixmap, it will scale the pixmap to fill the available space. +.PP +This property's default is FALSE. +.PP +See also scaledContents. +.PP +Set this property's value with setScaledContents() and get this property's value with hasScaledContents(). +.SH "QString text" +This property holds the label's text. +.PP +If no text has been set this will return an empty string. Setting the text clears any previous content, unless they are the same. +.PP +The text will be interpreted either as a plain text or as a rich text, depending on the text format setting; see setTextFormat(). The default setting is AutoText, i.e. QLabel will try to auto-detect the format of the text set. +.PP +If the text is interpreted as a plain text and a buddy has been set, the buddy accelerator key is updated from the new text. +.PP +The label resizes itself if auto-resizing is enabled. +.PP +Note that Qlabel is well-suited to display small rich text documents, i.e. those small documents that get their document specific settings (font, text color, link color) from the label's palette and font properties. For large documents, use QTextEdit in read-only mode instead. QTextEdit will flicker less on resize and can also provide a scrollbar when necessary. +.PP +See also textFormat, setBuddy(), and alignment. +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "TextFormat textFormat" +This property holds the label's text format. +.PP +See the Qt::TextFormat enum for an explanation of the possible options. +.PP +The default format is AutoText. +.PP +See also text. +.PP +Set this property's value with setTextFormat() and get this property's value with textFormat(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlabel.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlabel.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlayout.3qt b/doc/man/man3/tqlayout.3qt new file mode 100644 index 000000000..50270d089 --- /dev/null +++ b/doc/man/man3/tqlayout.3qt @@ -0,0 +1,408 @@ +'\" t +.TH QLayout 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 +QLayout \- The base class of geometry managers +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherits QObject and QLayoutItem. +.PP +Inherited by QGridLayout and QBoxLayout. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBResizeMode\fR { FreeResize, Minimum, Fixed, Auto }" +.br +.ti -1c +.BI "\fBQLayout\fR ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQLayout\fR ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQLayout\fR ( int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "int \fBmargin\fR () const" +.br +.ti -1c +.BI "int \fBspacing\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMargin\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBsetSpacing\fR ( int )" +.br +.ti -1c +.BI "void \fBsetResizeMode\fR ( ResizeMode )" +.br +.ti -1c +.BI "ResizeMode \fBresizeMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMenuBar\fR ( QMenuBar * w )" +.br +.ti -1c +.BI "QMenuBar * \fBmenuBar\fR () const" +.br +.ti -1c +.BI "QWidget * \fBmainWidget\fR ()" +.br +.ti -1c +.BI "bool \fBisTopLevel\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoAdd\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBautoAdd\fR () const" +.br +.ti -1c +.BI "virtual void \fBinvalidate\fR ()" +.br +.ti -1c +.BI "bool \fBactivate\fR ()" +.br +.ti -1c +.BI "void \fBadd\fR ( QWidget * w )" +.br +.ti -1c +.BI "virtual void \fBaddItem\fR ( QLayoutItem * item ) = 0" +.br +.ti -1c +.BI "void \fBremove\fR ( QWidget * widget )" +.br +.ti -1c +.BI "void \fBremoveItem\fR ( QLayoutItem * item )" +.br +.ti -1c +.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBminimumSize\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBmaximumSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( const QRect & r ) = 0" +.br +.ti -1c +.BI "virtual QLayoutIterator \fBiterator\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBsupportsMargin\fR () const" +.br +.ti -1c +.BI "void \fBsetEnabled\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBmargin\fR - the width of the outside border of the layout" +.br +.ti -1c +.BI "ResizeMode \fBresizeMode\fR - the resize mode of the layout" +.br +.ti -1c +.BI "int \fBspacing\fR - the spacing between widgets inside the layout" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBaddChildLayout\fR ( QLayout * l )" +.br +.ti -1c +.BI "void \fBdeleteAllItems\fR ()" +.br +.ti -1c +.BI "void \fBsetSupportsMargin\fR ( bool b )" +.br +.ti -1c +.BI "QRect \fBalignmentRect\fR ( const QRect & r ) const" +.br +.in -1c +.SH DESCRIPTION +The QLayout class is the base class of geometry managers. +.PP +This is an abstract base class inherited by the concrete classes, QBoxLayout and QGridLayout. +.PP +For users of QLayout subclasses or of QMainWindow there is seldom any need to use the basic functions provided by QLayout, such as setResizeMode() or setMenuBar(). See the layout overview page for more information. +.PP +To make your own layout manager, subclass QGLayoutIterator and implement the functions addItem(), sizeHint(), setGeometry(), and iterator(). You should also implement minimumSize() to ensure your layout isn't resized to zero size if there is too little space. To support children whose heights depend on their widths, implement hasHeightForWidth() and heightForWidth(). See the custom layout page for an in-depth description. +.PP +Geometry management stops when the layout manager is deleted. +.PP +See also Widget Appearance and Style and Layout Management. +.SS "Member Type Documentation" +.SH "QLayout::ResizeMode" +The possible values are: +.TP +\fCQLayout::Auto\fR - If the main widget is a top-level widget with no height-for-width (hasHeightForWidth()), this is the same as \fCMinimium\fR; otherwise, this is the same as FreeResize. +.TP +\fCQLayout::Fixed\fR - The main widget's size is set to sizeHint(); it cannot be resized at all. +.TP +\fCQLayout::Minimum\fR - The main widget's minimum size is set to minimumSize(); it cannot be smaller. +.TP +\fCQLayout::FreeResize\fR - The widget is not constrained. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLayout::QLayout ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" +Constructs a new top-level QLayout called \fIname\fR, with main widget \fIparent\fR. \fIparent\fR may not be 0. +.PP +The \fImargin\fR is the number of pixels between the edge of the widget and the managed children. The \fIspacing\fR sets the value of spacing(), which gives the spacing between the managed widgets. If \fIspacing\fR is -1 (the default), spacing is set to the value of \fImargin\fR. +.PP +There can be only one top-level layout for a widget. It is returned by QWidget::layout() +.SH "QLayout::QLayout ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" +Constructs a new child QLayout called \fIname\fR, and places it inside \fIparentLayout\fR by using the default placement defined by addItem(). +.PP +If \fIspacing\fR is -1, this QLayout inherits \fIparentLayout\fR's spacing(), otherwise the value of \fIspacing\fR is used. +.SH "QLayout::QLayout ( int spacing = -1, const char * name = 0 )" +Constructs a new child QLayout called \fIname\fR. If \fIspacing\fR is -1, this QLayout inherits its parent's spacing(); otherwise the value of \fIspacing\fR is used. +.PP +This layout has to be inserted into another layout before geometry management will work. +.SH "bool QLayout::activate ()" +Redoes the layout for mainWidget(). You should generally not need to call this because it is automatically called at the most appropriate times. +.PP +However, if you set up a QLayout for a visible widget without resizing that widget, you will need to call this function in order to lay it out. +.PP +See also QWidget::updateGeometry(). +.PP +Examples: +.)l layout/layout.cpp, popup/popup.cpp, scrollview/scrollview.cpp, and sql/overview/form1/main.cpp. +.SH "void QLayout::add ( QWidget * w )" +Adds widget \fIw\fR to this layout in a manner specific to the layout. This function uses addItem(). +.PP +Examples: +.)l customlayout/border.cpp and customlayout/main.cpp. +.SH "void QLayout::addChildLayout ( QLayout * l )\fC [protected]\fR" +This function is called from addLayout() functions in subclasses to add layout \fIl\fR as a sub-layout. +.SH "void QLayout::addItem ( QLayoutItem * item )\fC [pure virtual]\fR" +Implemented in subclasses to add an \fIitem\fR. How it is added is specific to each subclass. +.PP +The ownership of \fIitem\fR is transferred to the layout, and it's the layout's responsibility to delete it. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "QRect QLayout::alignmentRect ( const QRect & r ) const\fC [protected]\fR" +Returns the rectangle that should be covered when the geometry of this layout is set to \fIr\fR, provided that this layout supports setAlignment(). +.PP +The result is derived from sizeHint() and expanding(). It is never larger than \fIr\fR. +.SH "bool QLayout::autoAdd () const" +Returns TRUE if this layout automatically grabs all new mainWidget()'s new children and adds them as defined by addItem(); otherwise returns FALSE. This has effect only for top-level layouts, i.e. layouts that are direct children of their mainWidget(). +.PP +autoAdd() is disabled by default. +.PP +Note that a top-level layout is not necessarily associated with the top-level widget. +.PP +See also setAutoAdd(). +.SH "void QLayout::deleteAllItems ()\fC [protected]\fR" +Removes and deletes all items in this layout. +.SH "QSizePolicy::ExpandData QLayout::expanding () const\fC [virtual]\fR" +Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions. +.PP +The default implementation returns \fCBothDirections\fR. +.PP +Examples: +.)l customlayout/border.cpp and customlayout/flow.cpp. +.PP +Reimplemented from QLayoutItem. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "void QLayout::invalidate ()\fC [virtual]\fR" +Invalidates cached information. Reimplementations must call this. +.PP +Reimplemented from QLayoutItem. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "bool QLayout::isEmpty () const\fC [virtual]\fR" +Returns TRUE if this layout is empty. The default implementation returns FALSE. +.PP +Reimplemented from QLayoutItem. +.SH "bool QLayout::isEnabled () const" +Returns TRUE if the layout is enabled; otherwise returns FALSE. +.PP +See also setEnabled(). +.SH "bool QLayout::isTopLevel () const" +Returns TRUE if this layout is a top-level layout, i.e. not a child of another layout; otherwise returns FALSE. +.SH "QLayoutIterator QLayout::iterator ()\fC [pure virtual]\fR" +Implemented in subclasses to return an iterator that iterates over this layout's children. +.PP +A typical implementation will be: +.PP +.nf +.br + QLayoutIterator MyLayout::iterator() +.br + { +.br + QGLayoutIterator *i = new MyLayoutIterator( internal_data ); +.br + return QLayoutIterator( i ); +.br + } +.br +.fi +where MyLayoutIterator is a subclass of QGLayoutIterator. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.PP +Reimplemented from QLayoutItem. +.SH "QWidget * QLayout::mainWidget ()" +Returns the main widget (parent widget) of this layout, or 0 if this layout is a sub-layout that is not yet inserted. +.SH "int QLayout::margin () const" +Returns the width of the outside border of the layout. See the "margin" property for details. +.SH "QSize QLayout::maximumSize () const\fC [virtual]\fR" +Returns the maximum size of this layout. This is the largest size that the layout can have while still respecting the specifications. Does not include what's needed by margin() or menuBar(). +.PP +The default implementation allows unlimited resizing. +.PP +Reimplemented from QLayoutItem. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "QMenuBar * QLayout::menuBar () const" +Returns the menu bar set for this layout, or 0 if no menu bar is set. +.SH "QSize QLayout::minimumSize () const\fC [virtual]\fR" +Returns the minimum size of this layout. This is the smallest size that the layout can have while still respecting the specifications. Does not include what's needed by margin() or menuBar(). +.PP +The default implementation allows unlimited resizing. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.PP +Reimplemented from QLayoutItem. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "void QLayout::remove ( QWidget * widget )" +Removes the widget \fIwidget\fR from the layout. After this call, it is the caller's responsibility to give the widget a reasonable geometry or to put the widget back into a layout. +.PP +See also removeItem(), QWidget::geometry, and add(). +.SH "void QLayout::removeItem ( QLayoutItem * item )" +Removes the layout item \fIitem\fR from the layout. It is the caller's responsibility to delete the item. +.PP +Notice that \fIitem\fR can be a layout (since QLayout inherits QLayoutItem). +.PP +See also remove() and addItem(). +.SH "ResizeMode QLayout::resizeMode () const" +Returns the resize mode of the layout. See the "resizeMode" property for details. +.SH "void QLayout::setAutoAdd ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE, auto-add is enabled; otherwise auto-add is disabled. +.PP +\fBWarning:\fR If auto-add is enabled, you cannot set stretch factors on the child widgets until the widgets are actually inserted in the layout (after control returned to the event loop). We therefore recommend that you avoid the auto-add feature in new programs. +.PP +See also autoAdd(). +.PP +Examples: +.)l hierarchy/objects.cpp and i18n/main.cpp. +.SH "void QLayout::setEnabled ( bool enable )" +Enables this layout if \fIenable\fR is TRUE, otherwise disables it. +.PP +An enabled layout adjusts dynamically to changes; a disabled layout acts as if it did not exist. +.PP +By default all layouts are enabled. +.PP +See also isEnabled(). +.SH "void QLayout::setGeometry ( const QRect & r )\fC [pure virtual]\fR" +This function is reimplemented in subclasses to perform layout. +.PP +The default implementation maintains the geometry() information given by rect \fIr\fR. Reimplementors must call this function. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.PP +Reimplemented from QLayoutItem. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "void QLayout::setMargin ( int )\fC [virtual]\fR" +Sets the width of the outside border of the layout. See the "margin" property for details. +.SH "void QLayout::setMenuBar ( QMenuBar * w )\fC [virtual]\fR" +Makes the geometry manager take account of the menu bar \fIw\fR. All child widgets are placed below the bottom edge of the menu bar. +.PP +A menu bar does its own geometry management: never do addWidget() on a QMenuBar. +.PP +Examples: +.)l layout/layout.cpp and scrollview/scrollview.cpp. +.SH "void QLayout::setResizeMode ( ResizeMode )" +Sets the resize mode of the layout. See the "resizeMode" property for details. +.SH "void QLayout::setSpacing ( int )\fC [virtual]\fR" +Sets the spacing between widgets inside the layout. See the "spacing" property for details. +.SH "void QLayout::setSupportsMargin ( bool b )\fC [protected]\fR" +Sets the value returned by supportsMargin(). If \fIb\fR is TRUE, margin() handling is implemented by the subclass. If \fIb\fR is FALSE (the default), QLayout will add margin() around top-level layouts. +.PP +If \fIb\fR is TRUE, margin handling needs to be implemented in setGeometry(), maximumSize(), minimumSize(), sizeHint() and heightForWidth(). +.PP +See also supportsMargin(). +.SH "int QLayout::spacing () const" +Returns the spacing between widgets inside the layout. See the "spacing" property for details. +.SH "bool QLayout::supportsMargin () const" +Returns TRUE if this layout supports QLayout::margin on non-top-level layouts; otherwise returns FALSE. +.PP +See also margin. +.SS "Property Documentation" +.SH "int margin" +This property holds the width of the outside border of the layout. +.PP +For some layout classes this property has an effect only on top-level layouts; QBoxLayout and QGridLayout support margins for child layouts. The default value is 0. +.PP +See also spacing. +.PP +Set this property's value with setMargin() and get this property's value with margin(). +.SH "ResizeMode resizeMode" +This property holds the resize mode of the layout. +.PP +The default mode is Auto. +.PP +See also QLayout::ResizeMode. +.PP +Set this property's value with setResizeMode() and get this property's value with resizeMode(). +.SH "int spacing" +This property holds the spacing between widgets inside the layout. +.PP +The default value is -1, which signifies that the layout's spacing should not override the widget's spacing. +.PP +See also margin. +.PP +Set this property's value with setSpacing() and get this property's value with spacing(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlayout.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlayout.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlayoutitem.3qt b/doc/man/man3/tqlayoutitem.3qt new file mode 100644 index 000000000..58dda2b4a --- /dev/null +++ b/doc/man/man3/tqlayoutitem.3qt @@ -0,0 +1,226 @@ +'\" t +.TH QLayoutItem 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 +QLayoutItem \- Abstract item that a QLayout manipulates +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherited by QLayout, QSpacerItem, and QWidgetItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQLayoutItem\fR ( int alignment = 0 )" +.br +.ti -1c +.BI "virtual \fB~QLayoutItem\fR ()" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const = 0" +.br +.ti -1c +.BI "virtual QSize \fBminimumSize\fR () const = 0" +.br +.ti -1c +.BI "virtual QSize \fBmaximumSize\fR () const = 0" +.br +.ti -1c +.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const = 0" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( const QRect & r ) = 0" +.br +.ti -1c +.BI "virtual QRect \fBgeometry\fR () const = 0" +.br +.ti -1c +.BI "virtual bool \fBisEmpty\fR () const = 0" +.br +.ti -1c +.BI "virtual bool \fBhasHeightForWidth\fR () const" +.br +.ti -1c +.BI "virtual int \fBheightForWidth\fR ( int w ) const" +.br +.ti -1c +.BI "virtual void \fBinvalidate\fR ()" +.br +.ti -1c +.BI "virtual QWidget * \fBwidget\fR ()" +.br +.ti -1c +.BI "virtual QLayoutIterator \fBiterator\fR ()" +.br +.ti -1c +.BI "virtual QLayout * \fBlayout\fR ()" +.br +.ti -1c +.BI "virtual QSpacerItem * \fBspacerItem\fR ()" +.br +.ti -1c +.BI "int \fBalignment\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAlignment\fR ( int a )" +.br +.in -1c +.SH DESCRIPTION +The QLayoutItem class provides an abstract item that a QLayout manipulates. +.PP +This is used by custom layouts. +.PP +Pure virtual functions are provided to return information about the layout, including, sizeHint(), minimumSize(), maximumSize() and expanding(). +.PP +The layout's geometry can be set and retrieved with setGeometry() and geometry(), and its alignment with setAlignment() and alignment(). +.PP +isEmpty() returns whether the layout is empty. iterator() returns an iterator for the layout's children. If the concrete item is a QWidget, it can be retrieved using widget(). Similarly for layout() and spacerItem(). +.PP +See also QLayout, Widget Appearance and Style, and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLayoutItem::QLayoutItem ( int alignment = 0 )" +Constructs a layout item with an \fIalignment\fR that is a bitwise OR of the Qt::AlignmentFlags. Not all subclasses support alignment. +.SH "QLayoutItem::~QLayoutItem ()\fC [virtual]\fR" +Destroys the QLayoutItem. +.SH "int QLayoutItem::alignment () const" +Returns the alignment of this item. +.SH "QSizePolicy::ExpandData QLayoutItem::expanding () const\fC [pure virtual]\fR" +Implemented in subclasses to return the direction(s) this item" wants" to expand in (if any). +.PP +Reimplemented in QLayout, QSpacerItem, and QWidgetItem. +.SH "QRect QLayoutItem::geometry () const\fC [pure virtual]\fR" +Returns the rectangle covered by this layout item. +.PP +Example: customlayout/border.cpp. +.SH "bool QLayoutItem::hasHeightForWidth () const\fC [virtual]\fR" +Returns TRUE if this layout's preferred height depends on its width; otherwise returns FALSE. The default implementation returns FALSE. +.PP +Reimplement this function in layout managers that support height for width. +.PP +See also heightForWidth() and QWidget::heightForWidth(). +.PP +Examples: +.)l customlayout/border.cpp and customlayout/flow.cpp. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "int QLayoutItem::heightForWidth ( int w ) const\fC [virtual]\fR" +Returns the preferred height for this layout item, given the width \fIw\fR. +.PP +The default implementation returns -1, indicating that the preferred height is independent of the width of the item. Using the function hasHeightForWidth() will typically be much faster than calling this function and testing for -1. +.PP +Reimplement this function in layout managers that support height for width. A typical implementation will look like this: +.PP +.nf +.br + int MyLayout::heightForWidth( int w ) const +.br + { +.br + if ( cache_dirty || cached_width != w ) { +.br + // not all C++ compilers support "mutable" +.br + MyLayout *that = (MyLayout*)this; +.br + int h = calculateHeightForWidth( w ); +.br + that->cached_hfw = h; +.br + return h; +.br + } +.br + return cached_hfw; +.br + } +.br +.fi +.PP +Caching is strongly recommended; without it layout will take exponential time. +.PP +See also hasHeightForWidth(). +.PP +Example: customlayout/flow.cpp. +.PP +Reimplemented in QGridLayout and QBoxLayout. +.SH "void QLayoutItem::invalidate ()\fC [virtual]\fR" +Invalidates any cached information in this layout item. +.PP +Reimplemented in QLayout. +.SH "bool QLayoutItem::isEmpty () const\fC [pure virtual]\fR" +Implemented in subclasses to return whether this item is empty, i.e. whether it contains any widgets. +.PP +Reimplemented in QLayout, QSpacerItem, and QWidgetItem. +.SH "QLayoutIterator QLayoutItem::iterator ()\fC [virtual]\fR" +Returns an iterator over this item's QLayoutItem children. The default implementation returns an empty iterator. +.PP +Reimplement this function in subclasses that can have children. +.PP +Reimplemented in QLayout. +.SH "QLayout * QLayoutItem::layout ()\fC [virtual]\fR" +If this item is a QLayout, it is returned as a QLayout; otherwise 0 is returned. This function provides type-safe casting. +.SH "QSize QLayoutItem::maximumSize () const\fC [pure virtual]\fR" +Implemented in subclasses to return the maximum size of this item. +.PP +Reimplemented in QLayout, QSpacerItem, and QWidgetItem. +.SH "QSize QLayoutItem::minimumSize () const\fC [pure virtual]\fR" +Implemented in subclasses to return the minimum size of this item. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.PP +Reimplemented in QLayout, QSpacerItem, and QWidgetItem. +.SH "void QLayoutItem::setAlignment ( int a )\fC [virtual]\fR" +Sets the alignment of this item to \fIa\fR, which is a bitwise OR of the Qt::AlignmentFlags. Not all subclasses support alignment. +.PP +Example: chart/optionsform.cpp. +.SH "void QLayoutItem::setGeometry ( const QRect & r )\fC [pure virtual]\fR" +Implemented in subclasses to set this item's geometry to \fIr\fR. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.PP +Reimplemented in QLayout, QSpacerItem, and QWidgetItem. +.SH "QSize QLayoutItem::sizeHint () const\fC [pure virtual]\fR" +Implemented in subclasses to return the preferred size of this item. +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.PP +Reimplemented in QSpacerItem, QWidgetItem, QGridLayout, and QBoxLayout. +.SH "QSpacerItem * QLayoutItem::spacerItem ()\fC [virtual]\fR" +If this item is a QSpacerItem, it is returned as a QSpacerItem; otherwise 0 is returned. This function provides type-safe casting. +.SH "QWidget * QLayoutItem::widget ()\fC [virtual]\fR" +If this item is a QWidget, it is returned as a QWidget; otherwise 0 is returned. This function provides type-safe casting. +.PP +Reimplemented in QWidgetItem. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qlayoutitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlayoutitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlayoutiterator.3qt b/doc/man/man3/tqlayoutiterator.3qt new file mode 100644 index 000000000..c43945859 --- /dev/null +++ b/doc/man/man3/tqlayoutiterator.3qt @@ -0,0 +1,140 @@ +'\" t +.TH QLayoutIterator 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 +QLayoutIterator \- Iterators over QLayoutItem +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQLayoutIterator\fR ( QGLayoutIterator * gi )" +.br +.ti -1c +.BI "\fBQLayoutIterator\fR ( const QLayoutIterator & i )" +.br +.ti -1c +.BI "\fB~QLayoutIterator\fR ()" +.br +.ti -1c +.BI "QLayoutIterator & \fBoperator=\fR ( const QLayoutIterator & i )" +.br +.ti -1c +.BI "QLayoutItem * \fBoperator++\fR ()" +.br +.ti -1c +.BI "QLayoutItem * \fBcurrent\fR ()" +.br +.ti -1c +.BI "QLayoutItem * \fBtakeCurrent\fR ()" +.br +.ti -1c +.BI "void \fBdeleteCurrent\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QLayoutIterator class provides iterators over QLayoutItem. +.PP +Use QLayoutItem::iterator() to create an iterator over a layout. +.PP +QLayoutIterator uses \fIexplicit\fR sharing with a reference count. If an iterator is copied and one of the copies is modified, both iterators will be modified. +.PP +A QLayoutIterator is not protected against changes in its layout. If the layout is modified or deleted the iterator will become invalid. It is not possible to test for validity. It is safe to delete an invalid layout; any other access may lead to an illegal memory reference and the abnormal termination of the program. +.PP +Calling takeCurrent() or deleteCurrent() leaves the iterator in a valid state, but may invalidate any other iterators that access the same layout. +.PP +The following code will draw a rectangle for each layout item in the layout structure of the widget. +.PP +.nf +.br + static void paintLayout( QPainter *p, QLayoutItem *lay ) +.br + { +.br + QLayoutIterator it = lay->iterator(); +.br + QLayoutItem *child; +.br + while ( (child = it.current()) != 0 ) { +.br + paintLayout( p, child ); +.br + ++it; +.br + } +.br + p->drawRect( lay->geometry() ); +.br + } +.br + void ExampleWidget::paintEvent( QPaintEvent * ) +.br + { +.br + QPainter p( this ); +.br + if ( layout() ) +.br + paintLayout( &p, layout() ); +.br + } +.br +.fi +.PP +All the functionality of QLayoutIterator is implemented by subclasses of QGLayoutIterator. QLayoutIterator itself is not designed to be subclassed. +.PP +See also Widget Appearance and Style and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLayoutIterator::QLayoutIterator ( QGLayoutIterator * gi )" +Constructs an iterator based on \fIgi\fR. The constructed iterator takes ownership of \fIgi\fR and will delete it. +.PP +This constructor is provided for layout implementors. Application programmers should use QLayoutItem::iterator() to create an iterator over a layout. +.SH "QLayoutIterator::QLayoutIterator ( const QLayoutIterator & i )" +Creates a shallow copy of \fIi\fR, i.e. if the copy is modified, then the original will also be modified. +.SH "QLayoutIterator::~QLayoutIterator ()" +Destroys the iterator. +.SH "QLayoutItem * QLayoutIterator::current ()" +Returns the current item, or 0 if there is no current item. +.SH "void QLayoutIterator::deleteCurrent ()" +Removes and deletes the current child item from the layout and moves the iterator to the next item. This iterator will still be valid, but any other iterator over the same layout may become invalid. +.SH "QLayoutItem * QLayoutIterator::operator++ ()" +Moves the iterator to the next child item and returns that item, or 0 if there is no such item. +.SH "QLayoutIterator & QLayoutIterator::operator= ( const QLayoutIterator & i )" +Assigns \fIi\fR to this iterator and returns a reference to this iterator. +.SH "QLayoutItem * QLayoutIterator::takeCurrent ()" +Removes the current child item from the layout without deleting +it, and moves the iterator to the next item. Returns the removed +item, or 0 if there was no item to be removed. This iterator will +still be valid, but any other iterator over the same layout may +become invalid. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qlayoutiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlayoutiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlcdnumber.3qt b/doc/man/man3/tqlcdnumber.3qt new file mode 100644 index 000000000..ea4eb9e97 --- /dev/null +++ b/doc/man/man3/tqlcdnumber.3qt @@ -0,0 +1,335 @@ +'\" t +.TH QLCDNumber 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 +QLCDNumber \- Displays a number with LCD-like digits +.SH SYNOPSIS +\fC#include <ntqlcdnumber.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQLCDNumber\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQLCDNumber\fR ( uint numDigits, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QLCDNumber\fR ()" +.br +.ti -1c +.BI "enum \fBMode\fR { Hex, Dec, Oct, Bin, HEX = Hex, DEC = Dec, OCT = Oct, BIN = Bin }" +.br +.ti -1c +.BI "enum \fBSegmentStyle\fR { Outline, Filled, Flat }" +.br +.ti -1c +.BI "bool \fBsmallDecimalPoint\fR () const" +.br +.ti -1c +.BI "int \fBnumDigits\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNumDigits\fR ( int nDigits )" +.br +.ti -1c +.BI "bool \fBcheckOverflow\fR ( double num ) const" +.br +.ti -1c +.BI "bool \fBcheckOverflow\fR ( int num ) const" +.br +.ti -1c +.BI "Mode \fBmode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMode\fR ( Mode )" +.br +.ti -1c +.BI "SegmentStyle \fBsegmentStyle\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSegmentStyle\fR ( SegmentStyle )" +.br +.ti -1c +.BI "double \fBvalue\fR () const" +.br +.ti -1c +.BI "int \fBintValue\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBdisplay\fR ( const QString & s )" +.br +.ti -1c +.BI "void \fBdisplay\fR ( int num )" +.br +.ti -1c +.BI "void \fBdisplay\fR ( double num )" +.br +.ti -1c +.BI "virtual void \fBsetHexMode\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetDecMode\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetOctMode\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetBinMode\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetSmallDecimalPoint\fR ( bool )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBoverflow\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBintValue\fR - the displayed value rounded to the nearest integer" +.br +.ti -1c +.BI "Mode \fBmode\fR - the current display mode (number " "base" ")" +.br +.ti -1c +.BI "int \fBnumDigits\fR - the current number of digits displayed" +.br +.ti -1c +.BI "SegmentStyle \fBsegmentStyle\fR - the style of the LCDNumber" +.br +.ti -1c +.BI "bool \fBsmallDecimalPoint\fR - the style of the decimal point" +.br +.ti -1c +.BI "double \fBvalue\fR - the displayed value" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * p )" +.br +.in -1c +.SH DESCRIPTION +The QLCDNumber widget displays a number with LCD-like digits. +.PP +It can display a number in just about any size. It can display decimal, hexadecimal, octal or binary numbers. It is easy to connect to data sources using the display() slot, which is overloaded to take any of five argument types. +.PP +There are also slots to change the base with setMode() and the decimal point with setSmallDecimalPoint(). +.PP +QLCDNumber emits the overflow() signal when it is asked to display something beyond its range. The range is set by setNumDigits(), but setSmallDecimalPoint() also influences it. If the display is set to hexadecimal, octal or binary, the integer equivalent of the value is displayed. +.PP +These digits and other symbols can be shown: 0/O, 1, 2, 3, 4, 5/S, 6, 7, 8, 9/g, minus, decimal point, A, B, C, D, E, F, h, H, L, o, P, r, u, U, Y, colon, degree sign (which is specified as single quote in the string) and space. QLCDNumber substitutes spaces for illegal characters. +.PP +It is not possible to retrieve the contents of a QLCDNumber object, although you can retrieve the numeric value with value(). If you really need the text, we recommend that you connect the signals that feed the display() slot to another slot as well and store the value there. +.PP +Incidentally, QLCDNumber is the very oldest part of Qt, tracing back to a BASIC program on the Sinclair Spectrum. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QLabel, QFrame, and Basic Widgets. +.SS "Member Type Documentation" +.SH "QLCDNumber::Mode" +This type determines how numbers are shown. +.TP +\fCQLCDNumber::Hex\fR - Hexadecimal +.TP +\fCQLCDNumber::Dec\fR - Decimal +.TP +\fCQLCDNumber::Oct\fR - Octal +.TP +\fCQLCDNumber::Bin\fR - Binary +.PP +If the display is set to hexadecimal, octal or binary, the integer equivalent of the value is displayed. +.SH "QLCDNumber::SegmentStyle" +This type determines the visual appearance of the QLCDNumber widget. +.TP +\fCQLCDNumber::Outline\fR - gives raised segments filled with the background brush. +.TP +\fCQLCDNumber::Filled\fR - gives raised segments filled with the foreground brush. +.TP +\fCQLCDNumber::Flat\fR - gives flat segments filled with the foreground brush. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLCDNumber::QLCDNumber ( QWidget * parent = 0, const char * name = 0 )" +Constructs an LCD number, sets the number of digits to 5, the base to decimal, the decimal point mode to 'small' and the frame style to a raised box. The segmentStyle() is set to Outline. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QFrame constructor. +.PP +See also numDigits and smallDecimalPoint. +.SH "QLCDNumber::QLCDNumber ( uint numDigits, QWidget * parent = 0, const char * name = 0 )" +Constructs an LCD number, sets the number of digits to \fInumDigits\fR, the base to decimal, the decimal point mode to 'small' and the frame style to a raised box. The segmentStyle() is set to Outline. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QFrame constructor. +.PP +See also numDigits and smallDecimalPoint. +.SH "QLCDNumber::~QLCDNumber ()" +Destroys the LCD number. +.SH "bool QLCDNumber::checkOverflow ( double num ) const" +Returns TRUE if \fInum\fR is too big to be displayed in its entirety; otherwise returns FALSE. +.PP +See also display(), numDigits, and smallDecimalPoint. +.SH "bool QLCDNumber::checkOverflow ( int num ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fInum\fR is too big to be displayed in its entirety; otherwise returns FALSE. +.PP +See also display(), numDigits, and smallDecimalPoint. +.SH "void QLCDNumber::display ( const QString & s )\fC [slot]\fR" +Displays the number represented by the string \fIs\fR. +.PP +This version of the function disregards mode() and smallDecimalPoint(). +.PP +These digits and other symbols can be shown: 0/O, 1, 2, 3, 4, 5/S, 6, 7, 8, 9/g, minus, decimal point, A, B, C, D, E, F, h, H, L, o, P, r, u, U, Y, colon, degree sign (which is specified as single quote in the string) and space. QLCDNumber substitutes spaces for illegal characters. +.PP +Examples: +.)l rangecontrols/rangecontrols.cpp, t12/lcdrange.cpp, t13/gamebrd.cpp, t5/main.cpp, t6/main.cpp, t7/lcdrange.cpp, and xform/xform.cpp. +.SH "void QLCDNumber::display ( int num )\fC [slot]\fR" +Sets the displayed value rounded to the nearest integer to \fInum\fR. See the "intValue" property for details. +.SH "void QLCDNumber::display ( double num )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Displays the number \fInum\fR. +.SH "void QLCDNumber::drawContents ( QPainter * p )\fC [virtual protected]\fR" +Draws the LCD number using painter \fIp\fR. This function is called from QFrame::paintEvent(). +.PP +Reimplemented from QFrame. +.SH "int QLCDNumber::intValue () const" +Returns the displayed value rounded to the nearest integer. See the "intValue" property for details. +.SH "Mode QLCDNumber::mode () const" +Returns the current display mode (number base). See the "mode" property for details. +.SH "int QLCDNumber::numDigits () const" +Returns the current number of digits displayed. See the "numDigits" property for details. +.SH "void QLCDNumber::overflow ()\fC [signal]\fR" +This signal is emitted whenever the QLCDNumber is asked to display a too-large number or a too-long string. +.PP +It is never emitted by setNumDigits(). +.SH "SegmentStyle QLCDNumber::segmentStyle () const" +Returns the style of the LCDNumber. See the "segmentStyle" property for details. +.SH "void QLCDNumber::setBinMode ()\fC [virtual slot]\fR" +Calls setMode( BIN ). Provided for convenience (e.g. for connecting buttons to it). +.PP +See also mode, setHexMode(), setDecMode(), setOctMode(), and mode. +.SH "void QLCDNumber::setDecMode ()\fC [virtual slot]\fR" +Calls setMode( DEC ). Provided for convenience (e.g. for connecting buttons to it). +.PP +See also mode, setHexMode(), setOctMode(), setBinMode(), and mode. +.SH "void QLCDNumber::setHexMode ()\fC [virtual slot]\fR" +Calls setMode( HEX ). Provided for convenience (e.g. for connecting buttons to it). +.PP +See also mode, setDecMode(), setOctMode(), setBinMode(), and mode. +.SH "void QLCDNumber::setMode ( Mode )\fC [virtual]\fR" +Sets the current display mode (number base). See the "mode" property for details. +.SH "void QLCDNumber::setNumDigits ( int nDigits )\fC [virtual]\fR" +Sets the current number of digits displayed to \fInDigits\fR. See the "numDigits" property for details. +.SH "void QLCDNumber::setOctMode ()\fC [virtual slot]\fR" +Calls setMode( OCT ). Provided for convenience (e.g. for connecting buttons to it). +.PP +See also mode, setHexMode(), setDecMode(), setBinMode(), and mode. +.SH "void QLCDNumber::setSegmentStyle ( SegmentStyle )\fC [virtual]\fR" +Sets the style of the LCDNumber. See the "segmentStyle" property for details. +.SH "void QLCDNumber::setSmallDecimalPoint ( bool )\fC [virtual slot]\fR" +Sets the style of the decimal point. See the "smallDecimalPoint" property for details. +.SH "bool QLCDNumber::smallDecimalPoint () const" +Returns the style of the decimal point. See the "smallDecimalPoint" property for details. +.SH "double QLCDNumber::value () const" +Returns the displayed value. See the "value" property for details. +.SS "Property Documentation" +.SH "int intValue" +This property holds the displayed value rounded to the nearest integer. +.PP +This property corresponds to the nearest integer to the current value displayed by the LCDNumber. This is the value used for hexadecimal, octal and binary modes. +.PP +If the displayed value is not a number, the property has a value of 0. +.PP +Set this property's value with display() and get this property's value with intValue(). +.SH "Mode mode" +This property holds the current display mode (number base). +.PP +Corresponds to the current display mode, which is one of BIN, OCT, DEC (the default) and HEX. DEC mode can display floating point values, the other modes display the integer equivalent. +.PP +See also smallDecimalPoint, setHexMode(), setDecMode(), setOctMode(), and setBinMode(). +.PP +Set this property's value with setMode() and get this property's value with mode(). +.SH "int numDigits" +This property holds the current number of digits displayed. +.PP +Corresponds to the current number of digits. If QLCDNumber::smallDecimalPoint is FALSE, the decimal point occupies one digit position. +.PP +See also smallDecimalPoint. +.PP +Set this property's value with setNumDigits() and get this property's value with numDigits(). +.SH "SegmentStyle segmentStyle" +This property holds the style of the LCDNumber. +.PP +<center>.nf +.TS +l - l. Style Result Outline Produces raised segments filled with the background color (this is the default). Filled Produces raised segments filled with the foreground color. Flat +.TE +.fi +</center> +.PP +Outline and Filled will additionally use QColorGroup::light() and QColorGroup::dark() for shadow effects. +.PP +Set this property's value with setSegmentStyle() and get this property's value with segmentStyle(). +.SH "bool smallDecimalPoint" +This property holds the style of the decimal point. +.PP +If TRUE the decimal point is drawn between two digit positions. Otherwise it occupies a digit position of its own, i.e. is drawn in a digit position. The default is FALSE. +.PP +The inter-digit space is made slightly wider when the decimal point is drawn between the digits. +.PP +See also mode. +.PP +Set this property's value with setSmallDecimalPoint() and get this property's value with smallDecimalPoint(). +.SH "double value" +This property holds the displayed value. +.PP +This property corresponds to the current value displayed by the LCDNumber. +.PP +If the displayed value is not a number, the property has a value of 0. +.PP +Set this property's value with display() and get this property's value with value(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlcdnumber.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlcdnumber.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlibrary.3qt b/doc/man/man3/tqlibrary.3qt new file mode 100644 index 000000000..5a9293043 --- /dev/null +++ b/doc/man/man3/tqlibrary.3qt @@ -0,0 +1,280 @@ +'\" t +.TH QLibrary 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 +QLibrary \- Wrapper for handling shared libraries +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqlibrary.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQLibrary\fR ( const QString & filename )" +.br +.ti -1c +.BI "virtual \fB~QLibrary\fR ()" +.br +.ti -1c +.BI "void * \fBresolve\fR ( const char * symb )" +.br +.ti -1c +.BI "bool \fBload\fR ()" +.br +.ti -1c +.BI "virtual bool \fBunload\fR ()" +.br +.ti -1c +.BI "bool \fBisLoaded\fR () const" +.br +.ti -1c +.BI "bool \fBautoUnload\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoUnload\fR ( bool enabled )" +.br +.ti -1c +.BI "QString \fBlibrary\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void * \fBresolve\fR ( const QString & filename, const char * symb )" +.br +.in -1c +.SH DESCRIPTION +The QLibrary class provides a wrapper for handling shared libraries. +.PP +An instance of a QLibrary object can handle a single shared library and provide access to the functionality in the library in a platform independent way. If the library is a component server, QLibrary provides access to the exported component and can directly query this component for interfaces. +.PP +QLibrary ensures that the shared library is loaded and stays in memory whilst it is in use. QLibrary can also unload the library on destruction and release unused resources. +.PP +A typical use of QLibrary is to resolve an exported symbol in a shared object, and to call the function that this symbol represents. This is called "explicit linking" in contrast to" implicit linking", which is done by the link step in the build process when linking an executable against a library. +.PP +The following code snippet loads a library, resolves the symbol" mysymbol", and calls the function if everything succeeded. If something went wrong, e.g. the library file does not exist or the symbol is not defined, the function pointer will be 0 and won't be called. When the QLibrary object is destroyed the library will be unloaded, making all references to memory allocated in the library invalid. +.PP +.nf +.br + typedef void (*MyPrototype)(); +.br + MyPrototype myFunction; +.br +.br + QLibrary myLib( "mylib" ); +.br + myFunction = (MyPrototype) myLib.resolve( "mysymbol" ); +.br + if ( myFunction ) { +.br + myFunction(); +.br + } +.br +.fi +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLibrary::QLibrary ( const QString & filename )" +Creates a QLibrary object for the shared library \fIfilename\fR. The library will be unloaded in the destructor. +.PP +Note that \fIfilename\fR does not need to include the (platform specific) file extension, so calling +.PP +.nf +.br + QLibrary lib( "mylib" ); +.br +.fi +is equivalent to calling +.PP +.nf +.br + QLibrary lib( "mylib.dll" ); +.br +.fi +on Windows, and +.PP +.nf +.br + QLibrary lib( "libmylib.so" ); +.br +.fi +on Unix. Specifying the extension is not recommended, since doing so introduces a platform dependency. +.PP +If \fIfilename\fR does not include a path, the library loader will look for the file in the platform specific search paths. +.PP +See also load(), unload(), and setAutoUnload(). +.SH "QLibrary::~QLibrary ()\fC [virtual]\fR" +Deletes the QLibrary object. +.PP +The library will be unloaded if autoUnload() is TRUE (the default), otherwise it stays in memory until the application exits. +.PP +See also unload() and setAutoUnload(). +.SH "bool QLibrary::autoUnload () const" +Returns TRUE if the library will be automatically unloaded when this wrapper object is destructed; otherwise returns FALSE. The default is TRUE. +.PP +See also setAutoUnload(). +.SH "bool QLibrary::isLoaded () const" +Returns TRUE if the library is loaded; otherwise returns FALSE. +.PP +See also unload(). +.SH "QString QLibrary::library () const" +Returns the filename of the shared library this QLibrary object handles, including the platform specific file extension. +.PP +For example: +.PP +.nf +.br + QLibrary lib( "mylib" ); +.br + QString str = lib.library(); +.br +.fi +will set \fIstr\fR to "mylib.dll" on Windows, and "libmylib.so" on Linux. +.SH "bool QLibrary::load ()" +Loads the library. Since resolve() always calls this function before resolving any symbols it is not necessary to call it explicitly. In some situations you might want the library loaded in advance, in which case you would use this function. +.PP +On Darwin and Mac OS X this function uses code from dlcompat, part of the OpenDarwin project. +.PP +Copyright (c) 2002 Jorge Acereda and Peter O'Gorman +.PP +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the" Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +.PP +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +.PP +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +.SH "void * QLibrary::resolve ( const char * symb )" +Returns the address of the exported symbol \fIsymb\fR. The library is loaded if necessary. The function returns 0 if the symbol could not be resolved or the library could not be loaded. +.PP +.nf +.br + typedef int (*avgProc)( int, int ); +.br +.br + avgProc avg = (avgProc) library->resolve( "avg" ); +.br + if ( avg ) +.br + return avg( 5, 8 ); +.br + else +.br + return -1; +.br +.fi +.PP +The symbol must be exported as a C-function from the library. This requires the \fCextern "C"\fR notation if the library is compiled with a C++ compiler. On Windows you also have to explicitly export the function from the DLL using the \fC__declspec(dllexport)\fR compiler directive. +.PP +.nf +.br + extern "C" MY_EXPORT_MACRO int avg(int a, int b) +.br + { +.br + return (a + b) / 2; +.br + } +.br +.fi +.PP +with \fCMY_EXPORT\fR defined as +.PP +.nf +.br + #ifdef Q_WS_WIN +.br + # define MY_EXPORT __declspec(dllexport) +.br + #else +.br + # define MY_EXPORT +.br + #endif +.br +.fi +.PP +On Darwin and Mac OS X this function uses code from dlcompat, part of the OpenDarwin project. +.PP +Copyright (c) 2002 Jorge Acereda and Peter O'Gorman +.PP +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the" Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +.PP +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +.PP +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +.SH "void * QLibrary::resolve ( const QString & filename, const char * symb )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Loads the library \fIfilename\fR and returns the address of the exported symbol \fIsymb\fR. Note that like the constructor, \fIfilename\fR does not need to include the (platform specific) file extension. The library remains loaded until the process exits. +.PP +The function returns 0 if the symbol could not be resolved or the library could not be loaded. +.PP +This function is useful only if you want to resolve a single symbol, e.g. a function pointer from a specific library once: +.PP +.nf +.br + typedef void (*FunctionType)(); +.br + static FunctionType *ptrFunction = 0; +.br + static bool triedResolve = FALSE; +.br + if ( !ptrFunction && !triedResolve ) +.br + ptrFunction = QLibrary::resolve( "mylib", "mysymb" ); +.br +.br + if ( ptrFunction ) +.br + ptrFunction(); +.br + else +.br + ... +.br +.fi +.PP +If you want to resolve multiple symbols, use a QLibrary object and call the non-static version of resolve(). +.PP +See also +.SH "void QLibrary::setAutoUnload ( bool enabled )" +If \fIenabled\fR is TRUE (the default), the wrapper object is set to automatically unload the library upon destruction. If \fIenabled\fR is FALSE, the wrapper object is not unloaded unless you explicitly call unload(). +.PP +See also autoUnload(). +.SH "bool QLibrary::unload ()\fC [virtual]\fR" +Unloads the library and returns TRUE if the library could be unloaded; otherwise returns FALSE. +.PP +This function is called by the destructor if autoUnload() is enabled. +.PP +See also resolve(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlibrary.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlibrary.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlineedit.3qt b/doc/man/man3/tqlineedit.3qt new file mode 100644 index 000000000..2900ba56d --- /dev/null +++ b/doc/man/man3/tqlineedit.3qt @@ -0,0 +1,778 @@ +'\" t +.TH QLineEdit 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 +QLineEdit \- One-line text editor +.SH SYNOPSIS +\fC#include <ntqlineedit.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQLineEdit\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQLineEdit\fR ( const QString & contents, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQLineEdit\fR ( const QString & contents, const QString & inputMask, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QLineEdit\fR ()" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "QString \fBdisplayText\fR () const" +.br +.ti -1c +.BI "int \fBmaxLength\fR () const" +.br +.ti -1c +.BI "bool \fBframe\fR () const" +.br +.ti -1c +.BI "enum \fBEchoMode\fR { Normal, NoEcho, Password }" +.br +.ti -1c +.BI "EchoMode \fBechoMode\fR () const" +.br +.ti -1c +.BI "bool \fBisReadOnly\fR () const" +.br +.ti -1c +.BI "const QValidator * \fBvalidator\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBminimumSizeHint\fR () const" +.br +.ti -1c +.BI "int \fBcursorPosition\fR () const" +.br +.ti -1c +.BI "bool validateAndSet ( const QString & newText, int newPos, int newMarkAnchor, int newMarkDrag ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBalignment\fR () const" +.br +.ti -1c +.BI "void cursorLeft ( bool mark, int steps = 1 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void cursorRight ( bool mark, int steps = 1 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBcursorForward\fR ( bool mark, int steps = 1 )" +.br +.ti -1c +.BI "void \fBcursorBackward\fR ( bool mark, int steps = 1 )" +.br +.ti -1c +.BI "void \fBcursorWordForward\fR ( bool mark )" +.br +.ti -1c +.BI "void \fBcursorWordBackward\fR ( bool mark )" +.br +.ti -1c +.BI "void \fBbackspace\fR ()" +.br +.ti -1c +.BI "void \fBdel\fR ()" +.br +.ti -1c +.BI "void \fBhome\fR ( bool mark )" +.br +.ti -1c +.BI "void \fBend\fR ( bool mark )" +.br +.ti -1c +.BI "bool \fBisModified\fR () const" +.br +.ti -1c +.BI "void \fBclearModified\fR ()" +.br +.ti -1c +.BI "bool edited () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setEdited ( bool ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBhasSelectedText\fR () const" +.br +.ti -1c +.BI "QString \fBselectedText\fR () const" +.br +.ti -1c +.BI "int \fBselectionStart\fR () const" +.br +.ti -1c +.BI "bool \fBisUndoAvailable\fR () const" +.br +.ti -1c +.BI "bool \fBisRedoAvailable\fR () const" +.br +.ti -1c +.BI "bool hasMarkedText () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString markedText () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBdragEnabled\fR () const" +.br +.ti -1c +.BI "QString \fBinputMask\fR () const" +.br +.ti -1c +.BI "void \fBsetInputMask\fR ( const QString & inputMask )" +.br +.ti -1c +.BI "bool \fBhasAcceptableInput\fR () const" +.br +.ti -1c +.BI "int characterAt ( int xpos, QChar * chr ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool getSelection ( int * start, int * end ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "virtual void \fBselectAll\fR ()" +.br +.ti -1c +.BI "virtual void \fBdeselect\fR ()" +.br +.ti -1c +.BI "virtual void \fBclearValidator\fR ()" +.br +.ti -1c +.BI "virtual void \fBinsert\fR ( const QString & newText )" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBundo\fR ()" +.br +.ti -1c +.BI "virtual void \fBredo\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetMaxLength\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBsetFrame\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetEchoMode\fR ( EchoMode )" +.br +.ti -1c +.BI "virtual void \fBsetReadOnly\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetValidator\fR ( const QValidator * v )" +.br +.ti -1c +.BI "virtual void \fBsetSelection\fR ( int start, int length )" +.br +.ti -1c +.BI "virtual void \fBsetCursorPosition\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBsetAlignment\fR ( int flag )" +.br +.ti -1c +.BI "virtual void \fBcut\fR ()" +.br +.ti -1c +.BI "virtual void \fBcopy\fR () const" +.br +.ti -1c +.BI "virtual void \fBpaste\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetDragEnabled\fR ( bool b )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBtextChanged\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBreturnPressed\fR ()" +.br +.ti -1c +.BI "void \fBlostFocus\fR ()" +.br +.ti -1c +.BI "void \fBselectionChanged\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBacceptableInput\fR - whether the input satisfies the inputMask and the validator \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "Alignment \fBalignment\fR - the alignment of the line edit" +.br +.ti -1c +.BI "int \fBcursorPosition\fR - the current cursor position for this line edit" +.br +.ti -1c +.BI "QString \fBdisplayText\fR - the displayed text \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBdragEnabled\fR - whether the lineedit starts a drag if the user presses and moves the mouse on some selected text" +.br +.ti -1c +.BI "EchoMode \fBechoMode\fR - the line edit's echo mode" +.br +.ti -1c +.BI "bool edited - whether the line edit has been edited. Use modified instead \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBframe\fR - whether the line edit draws itself with a frame" +.br +.ti -1c +.BI "bool hasMarkedText - whether part of the text has been selected by the user. Use hasSelectedText instead \fI(read " "only" ")\fR \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBhasSelectedText\fR - whether there is any text selected \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QString \fBinputMask\fR - the validation input mask" +.br +.ti -1c +.BI "QString markedText - the text selected by the user. Use selectedText instead \fI(read " "only" ")\fR \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBmaxLength\fR - the maximum permitted length of the text" +.br +.ti -1c +.BI "bool \fBmodified\fR - whether the line edit's contents has been modified by the user \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBreadOnly\fR - whether the line edit is read only" +.br +.ti -1c +.BI "bool \fBredoAvailable\fR - whether redo is available \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QString \fBselectedText\fR - the selected text \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QString \fBtext\fR - the line edit's text" +.br +.ti -1c +.BI "bool \fBundoAvailable\fR - whether undo is available \fI(read " "only" ")\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" +.br +.ti -1c +.BI "virtual QPopupMenu * \fBcreatePopupMenu\fR ()" +.br +.ti -1c +.BI "void repaintArea ( int from, int to ) \fI(obsolete)\fR" +.br +.in -1c +.SH DESCRIPTION +The QLineEdit widget is a one-line text editor. +.PP +A line edit allows the user to enter and edit a single line of plain text with a useful collection of editing functions, including undo and redo, cut and paste, and drag and drop. +.PP +By changing the echoMode() of a line edit, it can also be used as a "write-only" field, for inputs such as passwords. +.PP +The length of the text can be constrained to maxLength(). The text can be arbitrarily constrained using a validator() or an inputMask(), or both. +.PP +A related class is QTextEdit which allows multi-line, rich-text editing. +.PP +You can change the text with setText() or insert(). The text is retrieved with text(); the displayed text (which may be different, see EchoMode) is retrieved with displayText(). Text can be selected with setSelection() or selectAll(), and the selection can be cut(), copy()ied and paste()d. The text can be aligned with setAlignment(). +.PP +When the text changes the textChanged() signal is emitted; when the Return or Enter key is pressed the returnPressed() signal is emitted. Note that if there is a validator set on the line edit, the returnPressed() signal will only be emitted if the validator returns \fCAcceptable\fR. +.PP +By default, QLineEdits have a frame as specified by the Windows and Motif style guides; you can turn it off by calling setFrame(FALSE). +.PP +The default key bindings are described below. The line edit also provides a context menu (usually invoked by a right mouse click) that presents some of these editing options. <center>.nf +.TS +l - l. Keypress Action Left Arrow Moves the cursor one character to the left. Shift+Left Arrow Moves and selects text one character to the left. Right Arrow Moves the cursor one character to the right. Shift+Right Arrow Moves and selects text one character to the right. Home Moves the cursor to the beginning of the line. End Moves the cursor to the end of the line. Backspace Deletes the character to the left of the cursor. Ctrl+Backspace Deletes the word to the left of the cursor. Delete Deletes the character to the right of the cursor. Ctrl+Delete Deletes the word to the right of the cursor. Ctrl+A Moves the cursor to the beginning of the line. Ctrl+B Moves the cursor one character to the left. Ctrl+C Copies the selected text to the clipboard. (Windows also supports Ctrl+Insert for this operation.) Ctrl+D Deletes the character to the right of the cursor. Ctrl+E Moves the cursor to the end of the line. Ctrl+F Moves the cursor one character to the right. Ctrl+H Deletes the character to the left of the cursor. Ctrl+K Deletes to the end of the line. Ctrl+V Pastes the clipboard text into line edit. (Windows also supports Shift+Insert for this operation.) Ctrl+X Deletes the selected text and copies it to the clipboard. (Windows also supports Shift+Delete for this operation.) Ctrl+Z Undoes the last operation. Ctrl+Y +.TE +.fi +</center> +.PP +Any other key sequence that represents a valid character, will cause the character to be inserted into the line edit. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QTextEdit, QLabel, QComboBox, GUI Design Handbook: Field, Entry, and Basic Widgets. +.SS "Member Type Documentation" +.SH "QLineEdit::EchoMode" +This enum type describes how a line edit should display its contents. +.TP +\fCQLineEdit::Normal\fR - Display characters as they are entered. This is the default. +.TP +\fCQLineEdit::NoEcho\fR - Do not display anything. This may be appropriate for passwords where even the length of the password should be kept secret. +.TP +\fCQLineEdit::Password\fR - Display asterisks instead of the characters actually entered. +.PP +See also echoMode and echoMode. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLineEdit::QLineEdit ( QWidget * parent, const char * name = 0 )" +Constructs a line edit with no text. +.PP +The maximum text length is set to 32767 characters. +.PP +The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. +.PP +See also text and maxLength. +.SH "QLineEdit::QLineEdit ( const QString & contents, QWidget * parent, const char * name = 0 )" +Constructs a line edit containing the text \fIcontents\fR. +.PP +The cursor position is set to the end of the line and the maximum text length to 32767 characters. +.PP +The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. +.PP +See also text and maxLength. +.SH "QLineEdit::QLineEdit ( const QString & contents, const QString & inputMask, QWidget * parent, const char * name = 0 )" +Constructs a line edit with an input \fIinputMask\fR and the text \fIcontents\fR. +.PP +The cursor position is set to the end of the line and the maximum text length is set to the length of the mask (the number of mask characters and separators). +.PP +The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. +.PP +See also setMask() and text. +.SH "QLineEdit::~QLineEdit ()" +Destroys the line edit. +.SH "int QLineEdit::alignment () const" +Returns the alignment of the line edit. See the "alignment" property for details. +.SH "void QLineEdit::backspace ()" +If no text is selected, deletes the character to the left of the text cursor and moves the cursor one position to the left. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted. +.PP +See also del(). +.SH "int QLineEdit::characterAt ( int xpos, QChar * chr ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QLineEdit::clear ()\fC [virtual slot]\fR" +Clears the contents of the line edit. +.SH "void QLineEdit::clearModified ()" +Resets the modified flag to FALSE. +.PP +See also modified. +.SH "void QLineEdit::clearValidator ()\fC [virtual slot]\fR" +This slot is equivalent to setValidator(0). +.SH "void QLineEdit::copy () const\fC [virtual slot]\fR" +Copies the selected text to the clipboard, if there is any, and if echoMode() is Normal. +.PP +See also cut() and paste(). +.SH "QPopupMenu * QLineEdit::createPopupMenu ()\fC [virtual protected]\fR" +This function is called to create the popup menu which is shown when the user clicks on the line edit with the right mouse button. If you want to create a custom popup menu, reimplement this function and return the popup menu you create. The popup menu's ownership is transferred to the caller. +.SH "void QLineEdit::cursorBackward ( bool mark, int steps = 1 )" +Moves the cursor back \fIsteps\fR characters. If \fImark\fR is TRUE each character moved over is added to the selection; if \fImark\fR is FALSE the selection is cleared. +.PP +See also cursorForward(). +.SH "void QLineEdit::cursorForward ( bool mark, int steps = 1 )" +Moves the cursor forward \fIsteps\fR characters. If \fImark\fR is TRUE each character moved over is added to the selection; if \fImark\fR is FALSE the selection is cleared. +.PP +See also cursorBackward(). +.SH "void QLineEdit::cursorLeft ( bool mark, int steps = 1 )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +For compatibilty with older applications only. Use cursorBackward() instead. +.PP +See also cursorBackward(). +.SH "int QLineEdit::cursorPosition () const" +Returns the current cursor position for this line edit. See the "cursorPosition" property for details. +.SH "void QLineEdit::cursorRight ( bool mark, int steps = 1 )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use cursorForward() instead. +.PP +See also cursorForward(). +.SH "void QLineEdit::cursorWordBackward ( bool mark )" +Moves the cursor one word backward. If \fImark\fR is TRUE, the word is also selected. +.PP +See also cursorWordForward(). +.SH "void QLineEdit::cursorWordForward ( bool mark )" +Moves the cursor one word forward. If \fImark\fR is TRUE, the word is also selected. +.PP +See also cursorWordBackward(). +.SH "void QLineEdit::cut ()\fC [virtual slot]\fR" +Copies the selected text to the clipboard and deletes it, if there is any, and if echoMode() is Normal. +.PP +If the current validator disallows deleting the selected text, cut() will copy without deleting. +.PP +See also copy(), paste(), and setValidator(). +.SH "void QLineEdit::del ()" +If no text is selected, deletes the character to the right of the text cursor. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted. +.PP +See also backspace(). +.SH "void QLineEdit::deselect ()\fC [virtual slot]\fR" +Deselects any selected text. +.PP +See also setSelection() and selectAll(). +.SH "QString QLineEdit::displayText () const" +Returns the displayed text. See the "displayText" property for details. +.SH "bool QLineEdit::dragEnabled () const" +Returns TRUE if the lineedit starts a drag if the user presses and moves the mouse on some selected text; otherwise returns FALSE. See the "dragEnabled" property for details. +.SH "EchoMode QLineEdit::echoMode () const" +Returns the line edit's echo mode. See the "echoMode" property for details. +.SH "bool QLineEdit::edited () const" +Returns TRUE if the line edit has been edited. Use modified instead; otherwise returns FALSE. See the "edited" property for details. +.SH "void QLineEdit::end ( bool mark )" +Moves the text cursor to the end of the line unless it is already there. If \fImark\fR is TRUE, text is selected towards the last position; otherwise, any selected text is unselected if the cursor is moved. +.PP +See also home(). +.SH "bool QLineEdit::frame () const" +Returns TRUE if the line edit draws itself with a frame; otherwise returns FALSE. See the "frame" property for details. +.SH "bool QLineEdit::getSelection ( int * start, int * end )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. use selectedText(), selectionStart() +.SH "bool QLineEdit::hasAcceptableInput () const" +Returns TRUE if the input satisfies the inputMask and the validator; otherwise returns FALSE. See the "acceptableInput" property for details. +.SH "bool QLineEdit::hasMarkedText () const" +Returns TRUE if part of the text has been selected by the user. Use hasSelectedText instead; otherwise returns FALSE. See the "hasMarkedText" property for details. +.SH "bool QLineEdit::hasSelectedText () const" +Returns TRUE if there is any text selected; otherwise returns FALSE. See the "hasSelectedText" property for details. +.SH "void QLineEdit::home ( bool mark )" +Moves the text cursor to the beginning of the line unless it is already there. If \fImark\fR is TRUE, text is selected towards the first position; otherwise, any selected text is unselected if the cursor is moved. +.PP +See also end(). +.SH "QString QLineEdit::inputMask () const" +Returns the validation input mask. See the "inputMask" property for details. +.SH "void QLineEdit::insert ( const QString & newText )\fC [virtual slot]\fR" +Deletes any selected text, inserts \fInewText\fR, and validates the result. If it is valid, it sets it as the new contents of the line edit. +.SH "bool QLineEdit::isModified () const" +Returns TRUE if the line edit's contents has been modified by the user; otherwise returns FALSE. See the "modified" property for details. +.SH "bool QLineEdit::isReadOnly () const" +Returns TRUE if the line edit is read only; otherwise returns FALSE. See the "readOnly" property for details. +.SH "bool QLineEdit::isRedoAvailable () const" +Returns TRUE if redo is available; otherwise returns FALSE. See the "redoAvailable" property for details. +.SH "bool QLineEdit::isUndoAvailable () const" +Returns TRUE if undo is available; otherwise returns FALSE. See the "undoAvailable" property for details. +.SH "void QLineEdit::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" +Converts key press event \fIe\fR into a line edit action. +.PP +If Return or Enter is pressed and the current text is valid (or can be made valid by the validator), the signal returnPressed() is emitted. +.PP +The default key bindings are listed in the detailed description. +.PP +Reimplemented from QWidget. +.SH "void QLineEdit::lostFocus ()\fC [signal]\fR" +This signal is emitted when the line edit has lost focus. +.PP +See also focus, QWidget::focusInEvent(), and QWidget::focusOutEvent(). +.SH "QString QLineEdit::markedText () const" +Returns the text selected by the user. Use selectedText instead. See the "markedText" property for details. +.SH "int QLineEdit::maxLength () const" +Returns the maximum permitted length of the text. See the "maxLength" property for details. +.SH "QSize QLineEdit::minimumSizeHint () const\fC [virtual]\fR" +Returns a minimum size for the line edit. +.PP +The width returned is enough for at least one character. +.PP +Reimplemented from QWidget. +.SH "void QLineEdit::paste ()\fC [virtual slot]\fR" +Inserts the clipboard's text at the cursor position, deleting any selected text, providing the line edit is not read-only. +.PP +If the end result would not be acceptable to the current validator, nothing happens. +.PP +See also copy() and cut(). +.SH "void QLineEdit::redo ()\fC [virtual slot]\fR" +Redoes the last operation if redo is available. +.SH "void QLineEdit::repaintArea ( int from, int to )\fC [protected]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Repaints all characters from \fIfrom\fR to \fIto\fR. If cursorPos is between from and to, ensures that cursorPos is visible. +.SH "void QLineEdit::returnPressed ()\fC [signal]\fR" +This signal is emitted when the Return or Enter key is pressed. Note that if there is a validator() or inputMask() set on the line edit, the returnPressed() signal will only be emitted if the input follows the inputMask() and the validator() returns \fCAcceptable\fR. +.PP +Example: popup/popup.cpp. +.SH "void QLineEdit::selectAll ()\fC [virtual slot]\fR" +Selects all the text (i.e. highlights it) and moves the cursor to the end. This is useful when a default value has been inserted because if the user types before clicking on the widget, the selected text will be deleted. +.PP +See also setSelection() and deselect(). +.SH "QString QLineEdit::selectedText () const" +Returns the selected text. See the "selectedText" property for details. +.SH "void QLineEdit::selectionChanged ()\fC [signal]\fR" +This signal is emitted whenever the selection changes. +.PP +See also hasSelectedText and selectedText. +.SH "int QLineEdit::selectionStart () const" +selectionStart() returns the index of the first selected character in the line edit or -1 if no text is selected. +.PP +See also selectedText. +.SH "void QLineEdit::setAlignment ( int flag )\fC [virtual slot]\fR" +Sets the alignment of the line edit to \fIflag\fR. See the "alignment" property for details. +.SH "void QLineEdit::setCursorPosition ( int )\fC [virtual slot]\fR" +Sets the current cursor position for this line edit. See the "cursorPosition" property for details. +.SH "void QLineEdit::setDragEnabled ( bool b )\fC [virtual slot]\fR" +Sets whether the lineedit starts a drag if the user presses and moves the mouse on some selected text to \fIb\fR. See the "dragEnabled" property for details. +.SH "void QLineEdit::setEchoMode ( EchoMode )\fC [virtual slot]\fR" +Sets the line edit's echo mode. See the "echoMode" property for details. +.SH "void QLineEdit::setEdited ( bool )" +Sets whether the line edit has been edited. Use modified instead. See the "edited" property for details. +.SH "void QLineEdit::setFrame ( bool )\fC [virtual slot]\fR" +Sets whether the line edit draws itself with a frame. See the "frame" property for details. +.SH "void QLineEdit::setInputMask ( const QString & inputMask )" +Sets the validation input mask to \fIinputMask\fR. See the "inputMask" property for details. +.SH "void QLineEdit::setMaxLength ( int )\fC [virtual slot]\fR" +Sets the maximum permitted length of the text. See the "maxLength" property for details. +.SH "void QLineEdit::setReadOnly ( bool )\fC [virtual slot]\fR" +Sets whether the line edit is read only. See the "readOnly" property for details. +.SH "void QLineEdit::setSelection ( int start, int length )\fC [virtual slot]\fR" +Selects text from position \fIstart\fR and for \fIlength\fR characters. +.PP +Note that this function sets the cursor's position to the end of the selection regardless of its current position. +.PP +See also deselect(), selectAll(), getSelection(), cursorForward(), and cursorBackward(). +.SH "void QLineEdit::setText ( const QString & )\fC [virtual slot]\fR" +Sets the line edit's text. See the "text" property for details. +.SH "void QLineEdit::setValidator ( const QValidator * v )\fC [virtual slot]\fR" +Sets this line edit to only accept input that the validator, \fIv\fR, will accept. This allows you to place any arbitrary constraints on the text which may be entered. +.PP +If \fIv\fR == 0, setValidator() removes the current input validator. The initial setting is to have no input validator (i.e. any input is accepted up to maxLength()). +.PP +See also validator(), QIntValidator, QDoubleValidator, and QRegExpValidator. +.PP +Examples: +.)l lineedits/lineedits.cpp and wizard/wizard.cpp. +.SH "QSize QLineEdit::sizeHint () const\fC [virtual]\fR" +Returns a recommended size for the widget. +.PP +The width returned, in pixels, is usually enough for about 15 to 20 characters. +.PP +Example: addressbook/centralwidget.cpp. +.SH "QString QLineEdit::text () const" +Returns the line edit's text. See the "text" property for details. +.SH "void QLineEdit::textChanged ( const QString & )\fC [signal]\fR" +This signal is emitted whenever the text changes. The argument is the new text. +.PP +Examples: +.)l simple/main.cpp, wizard/wizard.cpp, and xform/xform.cpp. +.SH "void QLineEdit::undo ()\fC [virtual slot]\fR" +Undoes the last operation if undo is available. Deselects any current selection, and updates the selection start to the current cursor position. +.SH "bool QLineEdit::validateAndSet ( const QString & newText, int newPos, int newMarkAnchor, int newMarkDrag )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use setText(), setCursorPosition() and setSelection() instead. +.SH "const QValidator * QLineEdit::validator () const" +Returns a pointer to the current input validator, or 0 if no validator has been set. +.PP +See also setValidator(). +.PP +Example: wizard/wizard.cpp. +.SS "Property Documentation" +.SH "bool acceptableInput" +This property holds whether the input satisfies the inputMask and the validator. +.PP +Get this property's value with hasAcceptableInput(). +.PP +See also inputMask and setValidator(). +.SH "Alignment alignment" +This property holds the alignment of the line edit. +.PP +Possible Values are Qt::AlignAuto, Qt::AlignLeft, Qt::AlignRight and Qt::AlignHCenter. +.PP +Attempting to set the alignment to an illegal flag combination does nothing. +.PP +See also Qt::AlignmentFlags. +.PP +Set this property's value with setAlignment() and get this property's value with alignment(). +.SH "int cursorPosition" +This property holds the current cursor position for this line edit. +.PP +Setting the cursor position causes a repaint when appropriate. +.PP +Set this property's value with setCursorPosition() and get this property's value with cursorPosition(). +.SH "QString displayText" +This property holds the displayed text. +.PP +If EchoMode is Normal this returns the same as text(); if EchoMode is Password it returns a string of asterisks text().length() characters long, e.g. "******"; if EchoMode is NoEcho returns an empty string, "". +.PP +See also echoMode, text, and EchoMode. +.PP +Get this property's value with displayText(). +.SH "bool dragEnabled" +This property holds whether the lineedit starts a drag if the user presses and moves the mouse on some selected text. +.PP +Set this property's value with setDragEnabled() and get this property's value with dragEnabled(). +.SH "EchoMode echoMode" +This property holds the line edit's echo mode. +.PP +The initial setting is Normal, but QLineEdit also supports NoEcho and Password modes. +.PP +The widget's display and the ability to copy or drag the text is affected by this setting. +.PP +See also EchoMode and displayText. +.PP +Set this property's value with setEchoMode() and get this property's value with echoMode(). +.SH "bool edited" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This property holds whether the line edit has been edited. Use modified instead. +.PP +Set this property's value with setEdited() and get this property's value with edited(). +.SH "bool frame" +This property holds whether the line edit draws itself with a frame. +.PP +If enabled (the default) the line edit draws itself inside a two-pixel frame, otherwise the line edit draws itself without any frame. +.PP +Set this property's value with setFrame() and get this property's value with frame(). +.SH "bool hasMarkedText" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This property holds whether part of the text has been selected by the user. Use hasSelectedText instead. +.PP +Get this property's value with hasMarkedText(). +.SH "bool hasSelectedText" +This property holds whether there is any text selected. +.PP +hasSelectedText() returns TRUE if some or all of the text has been selected by the user; otherwise returns FALSE. +.PP +See also selectedText. +.PP +Get this property's value with hasSelectedText(). +.SH "QString inputMask" +This property holds the validation input mask. +.PP +If no mask is set, inputMask() returns QString::null. +.PP +Sets the QLineEdit's validation mask. Validators can be used instead of, or in conjunction with masks; see setValidator(). +.PP +Unset the mask and return to normal QLineEdit operation by passing an empty string ("") or just calling setInputMask() with no arguments. +.PP +The mask format understands these mask characters: <center>.nf +.TS +l - l. Character Meaning ASCII alphabetic character required. A-Z, a-z. ASCII alphabetic character permitted but not required. ASCII alphanumeric character required. A-Z, a-z, 0-9. ASCII alphanumeric character permitted but not required. Any character required. x Any character permitted but not required. ASCII digit required. 0-9. ASCII digit permitted but not required. ASCII digit required. 1-9. ASCII digit permitted but not required (1-9). ASCII digit or plus/minus sign permitted but not required. All following alphabetic characters are uppercased. All following alphabetic characters are lowercased. Switch off case conversion. Use +.TE +.fi +</center> +.PP +The mask consists of a string of mask characters and separators, optionally followed by a semi-colon and the character used for blanks: the blank characters are always removed from the text after editing. The default blank character is space. +.PP +Examples: +.)l +<center>.nf +.TS +l - l. Mask Notes IP address; blanks are ISO Date; blanks are License number; blanks are +.TE +.fi +</center> +.PP +To get range control (e.g. for an IP address) use masks together with validators. +.PP +See also maxLength. +.PP +Set this property's value with setInputMask() and get this property's value with inputMask(). +.SH "QString markedText" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This property holds the text selected by the user. Use selectedText instead. +.PP +Get this property's value with markedText(). +.SH "int maxLength" +This property holds the maximum permitted length of the text. +.PP +If the text is too long, it is truncated at the limit. +.PP +If truncation occurs any selected text will be unselected, the cursor position is set to 0 and the first part of the string is shown. +.PP +If the line edit has an input mask, the mask defines the maximum string length. +.PP +See also inputMask. +.PP +Set this property's value with setMaxLength() and get this property's value with maxLength(). +.SH "bool modified" +This property holds whether the line edit's contents has been modified by the user. +.PP +The modified flag is never read by QLineEdit; it has a default value of FALSE and is changed to TRUE whenever the user changes the line edit's contents. +.PP +This is useful for things that need to provide a default value but do not start out knowing what the default should be (perhaps it depends on other fields on the form). Start the line edit without the best default, and when the default is known, if modified() returns FALSE (the user hasn't entered any text), insert the default value. +.PP +Calling clearModified() or setText() resets the modified flag to FALSE. +.PP +Get this property's value with isModified(). +.SH "bool readOnly" +This property holds whether the line edit is read only. +.PP +In read-only mode, the user can still copy the text to the clipboard or drag-and-drop the text (if echoMode() is Normal), but cannot edit it. +.PP +QLineEdit does not show a cursor in read-only mode. +.PP +See also enabled. +.PP +Set this property's value with setReadOnly() and get this property's value with isReadOnly(). +.SH "bool redoAvailable" +This property holds whether redo is available. +.PP +Get this property's value with isRedoAvailable(). +.SH "QString selectedText" +This property holds the selected text. +.PP +If there is no selected text this property's value is QString::null. +.PP +See also hasSelectedText. +.PP +Get this property's value with selectedText(). +.SH "QString text" +This property holds the line edit's text. +.PP +Note that setting this property clears the selection, clears the undo/redo history, moves the cursor to the end of the line and resets the modified property to FALSE. The text is not validated when inserted with setText(). +.PP +The text is truncated to maxLength() length. +.PP +See also insert(). +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "bool undoAvailable" +This property holds whether undo is available. +.PP +Get this property's value with isUndoAvailable(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlineedit.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlineedit.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlistbox.3qt b/doc/man/man3/tqlistbox.3qt new file mode 100644 index 000000000..b34ee1ee7 --- /dev/null +++ b/doc/man/man3/tqlistbox.3qt @@ -0,0 +1,1110 @@ +'\" t +.TH QListBox 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 +QListBox \- List of selectable, read-only items +.SH SYNOPSIS +\fC#include <ntqlistbox.h>\fR +.PP +Inherits QScrollView. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQListBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QListBox\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "void \fBinsertStringList\fR ( const QStringList & list, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertStrList\fR ( const QStrList * list, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertStrList\fR ( const QStrList & list, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertStrList\fR ( const char ** strings, int numStrings = -1, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QListBoxItem * lbi, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QListBoxItem * lbi, const QListBoxItem * after )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QString & text, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertItem\fR ( const QPixmap & pixmap, const QString & text, int index = -1 )" +.br +.ti -1c +.BI "void \fBremoveItem\fR ( int index )" +.br +.ti -1c +.BI "QString \fBtext\fR ( int index ) const" +.br +.ti -1c +.BI "const QPixmap * \fBpixmap\fR ( int index ) const" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( const QListBoxItem * lbi, int index )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( const QString & text, int index )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( const QPixmap & pixmap, int index )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( const QPixmap & pixmap, const QString & text, int index )" +.br +.ti -1c +.BI "void \fBtakeItem\fR ( const QListBoxItem * item )" +.br +.ti -1c +.BI "int \fBnumItemsVisible\fR () const" +.br +.ti -1c +.BI "int \fBcurrentItem\fR () const" +.br +.ti -1c +.BI "QString \fBcurrentText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCurrentItem\fR ( int index )" +.br +.ti -1c +.BI "virtual void \fBsetCurrentItem\fR ( QListBoxItem * i )" +.br +.ti -1c +.BI "void centerCurrentItem () \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBtopItem\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTopItem\fR ( int index )" +.br +.ti -1c +.BI "virtual void \fBsetBottomItem\fR ( int index )" +.br +.ti -1c +.BI "long \fBmaxItemWidth\fR () const" +.br +.ti -1c +.BI "enum \fBSelectionMode\fR { Single, Multi, Extended, NoSelection }" +.br +.ti -1c +.BI "virtual void \fBsetSelectionMode\fR ( SelectionMode )" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR () const" +.br +.ti -1c +.BI "void setMultiSelection ( bool multi ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isMultiSelection () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void \fBsetSelected\fR ( QListBoxItem * item, bool select )" +.br +.ti -1c +.BI "void \fBsetSelected\fR ( int index, bool select )" +.br +.ti -1c +.BI "bool \fBisSelected\fR ( int i ) const" +.br +.ti -1c +.BI "bool \fBisSelected\fR ( const QListBoxItem * i ) const" +.br +.ti -1c +.BI "QListBoxItem * \fBselectedItem\fR () const" +.br +.ti -1c +.BI "QListBoxItem * \fBitem\fR ( int index ) const" +.br +.ti -1c +.BI "int \fBindex\fR ( const QListBoxItem * lbi ) const" +.br +.ti -1c +.BI "QListBoxItem * \fBfindItem\fR ( const QString & text, ComparisonFlags compare = BeginsWith ) const" +.br +.ti -1c +.BI "void \fBtriggerUpdate\fR ( bool doLayout )" +.br +.ti -1c +.BI "bool \fBitemVisible\fR ( int index )" +.br +.ti -1c +.BI "bool \fBitemVisible\fR ( const QListBoxItem * item )" +.br +.ti -1c +.BI "enum \fBLayoutMode\fR { FixedNumber, FitToWidth, FitToHeight = FitToWidth, Variable }" +.br +.ti -1c +.BI "virtual void \fBsetColumnMode\fR ( LayoutMode )" +.br +.ti -1c +.BI "virtual void \fBsetColumnMode\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBsetRowMode\fR ( LayoutMode )" +.br +.ti -1c +.BI "virtual void \fBsetRowMode\fR ( int )" +.br +.ti -1c +.BI "LayoutMode \fBcolumnMode\fR () const" +.br +.ti -1c +.BI "LayoutMode \fBrowMode\fR () const" +.br +.ti -1c +.BI "int \fBnumColumns\fR () const" +.br +.ti -1c +.BI "int \fBnumRows\fR () const" +.br +.ti -1c +.BI "bool \fBvariableWidth\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetVariableWidth\fR ( bool )" +.br +.ti -1c +.BI "bool \fBvariableHeight\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetVariableHeight\fR ( bool )" +.br +.ti -1c +.BI "bool autoScrollBar () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setAutoScrollBar ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool scrollBar () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setScrollBar ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool autoBottomScrollBar () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setAutoBottomScrollBar ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool bottomScrollBar () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setBottomScrollBar ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int inSort ( const QListBoxItem * lbi ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int inSort ( const QString & text ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int cellHeight ( int i ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int cellHeight () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int cellWidth () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int numCols () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBitemHeight\fR ( int index = 0 ) const" +.br +.ti -1c +.BI "QListBoxItem * \fBitemAt\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "QRect \fBitemRect\fR ( QListBoxItem * item ) const" +.br +.ti -1c +.BI "QListBoxItem * \fBfirstItem\fR () const" +.br +.ti -1c +.BI "void \fBsort\fR ( bool ascending = TRUE )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBensureCurrentVisible\fR ()" +.br +.ti -1c +.BI "virtual void \fBclearSelection\fR ()" +.br +.ti -1c +.BI "virtual void \fBselectAll\fR ( bool select )" +.br +.ti -1c +.BI "virtual void \fBinvertSelection\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBhighlighted\fR ( int index )" +.br +.ti -1c +.BI "void \fBselected\fR ( int index )" +.br +.ti -1c +.BI "void \fBhighlighted\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBselected\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBhighlighted\fR ( QListBoxItem * )" +.br +.ti -1c +.BI "void \fBselected\fR ( QListBoxItem * )" +.br +.ti -1c +.BI "void \fBselectionChanged\fR ()" +.br +.ti -1c +.BI "void \fBselectionChanged\fR ( QListBoxItem * item )" +.br +.ti -1c +.BI "void \fBcurrentChanged\fR ( QListBoxItem * item )" +.br +.ti -1c +.BI "void \fBclicked\fR ( QListBoxItem * item )" +.br +.ti -1c +.BI "void \fBclicked\fR ( QListBoxItem * item, const QPoint & pnt )" +.br +.ti -1c +.BI "void \fBpressed\fR ( QListBoxItem * item )" +.br +.ti -1c +.BI "void \fBpressed\fR ( QListBoxItem * item, const QPoint & pnt )" +.br +.ti -1c +.BI "void \fBdoubleClicked\fR ( QListBoxItem * item )" +.br +.ti -1c +.BI "void \fBreturnPressed\fR ( QListBoxItem * )" +.br +.ti -1c +.BI "void \fBrightButtonClicked\fR ( QListBoxItem *, const QPoint & )" +.br +.ti -1c +.BI "void \fBrightButtonPressed\fR ( QListBoxItem *, const QPoint & )" +.br +.ti -1c +.BI "void \fBmouseButtonPressed\fR ( int button, QListBoxItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBmouseButtonClicked\fR ( int button, QListBoxItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBcontextMenuRequested\fR ( QListBoxItem * item, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBonItem\fR ( QListBoxItem * i )" +.br +.ti -1c +.BI "void \fBonViewport\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "LayoutMode \fBcolumnMode\fR - the column layout mode for this list box" +.br +.ti -1c +.BI "uint \fBcount\fR - the number of items in the list box \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcurrentItem\fR - the current highlighted item" +.br +.ti -1c +.BI "QString \fBcurrentText\fR - the text of the current item \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool multiSelection - whether or not the list box is in Multi selection mode \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBnumColumns\fR - the number of columns in the list box \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBnumItemsVisible\fR - the number of visible items \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBnumRows\fR - the number of rows in the list box \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "LayoutMode \fBrowMode\fR - the row layout mode for this list box" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR - the selection mode of the list box" +.br +.ti -1c +.BI "int \fBtopItem\fR - the index of an item at the top of the screen" +.br +.ti -1c +.BI "bool \fBvariableHeight\fR - whether this list box has variable-height rows" +.br +.ti -1c +.BI "bool \fBvariableWidth\fR - whether this list box has variable-width columns" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBupdateItem\fR ( int index )" +.br +.ti -1c +.BI "void \fBupdateItem\fR ( QListBoxItem * i )" +.br +.ti -1c +.BI "int totalWidth () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int totalHeight () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col )" +.br +.ti -1c +.BI "void \fBtoggleCurrentItem\fR ()" +.br +.ti -1c +.BI "bool \fBisRubberSelecting\fR () const" +.br +.ti -1c +.BI "void \fBdoLayout\fR () const" +.br +.ti -1c +.BI "bool itemYPos ( int index, int * yPos ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int findItem ( int yPos ) const \fI(obsolete)\fR" +.br +.in -1c +.SH DESCRIPTION +The QListBox widget provides a list of selectable, read-only items. +.PP +This is typically a single-column list in which either no item or one item is selected, but it can also be used in many other ways. +.PP +QListBox will add scroll bars as necessary, but it isn't intended for \fIreally\fR big lists. If you want more than a few thousand items, it's probably better to use a different widget mainly because the scroll bars won't provide very good navigation, but also because QListBox may become slow with huge lists. (See QListView and QTable for possible alternatives.) +.PP +There are a variety of selection modes described in the QListBox::SelectionMode documentation. The default is Single selection mode, but you can change it using setSelectionMode(). (setMultiSelection() is still provided for compatibility with Qt 1.x. We recommend using setSelectionMode() in all code.) +.PP +Because QListBox offers multiple selection it must display keyboard focus and selection state separately. Therefore there are functions both to set the selection state of an item, i.e. setSelected(), and to set which item displays keyboard focus, i.e. setCurrentItem(). +.PP +The list box normally arranges its items in a single column and adds a vertical scroll bar if required. It is possible to have a different fixed number of columns (setColumnMode()), or as many columns as will fit in the list box's assigned screen space (setColumnMode(FitToWidth)), or to have a fixed number of rows (setRowMode()) or as many rows as will fit in the list box's assigned screen space (setRowMode(FitToHeight)). In all these cases QListBox will add scroll bars, as appropriate, in at least one direction. +.PP +If multiple rows are used, each row can be as high as necessary (the normal setting), or you can request that all items will have the same height by calling setVariableHeight(FALSE). The same applies to a column's width, see setVariableWidth(). +.PP +The QListBox's items are QListBoxItem objects. QListBox provides methods to insert new items as strings, as pixmaps, and as QListBoxItem * (insertItem() with various arguments), and to replace an existing item with a new string, pixmap or QListBoxItem (changeItem() with various arguments). You can also remove items singly with removeItem() or clear() the entire list box. Note that if you create a QListBoxItem yourself and insert it, QListBox takes ownership of the item. +.PP +You can also create a QListBoxItem, such as QListBoxText or QListBoxPixmap, with the list box as first parameter. The item will then append itself. When you delete an item it is automatically removed from the list box. +.PP +The list of items can be arbitrarily large; QListBox will add scroll bars if necessary. QListBox can display a single-column (the common case) or multiple-columns, and offers both single and multiple selection. QListBox does not support multiple-column items (but QListView and QTable do), or tree hierarchies (but QListView does). +.PP +The list box items can be accessed both as QListBoxItem objects (recommended) and using integer indexes (the original QListBox implementation used an array of strings internally, and the API still supports this mode of operation). Everything can be done using the new objects, and most things can be done using indexes. +.PP +Each item in a QListBox contains a QListBoxItem. One of the items can be the current item. The currentChanged() signal and the highlighted() signal are emitted when a new item becomes current, e.g. because the user clicks on it or QListBox::setCurrentItem() is called. The selected() signal is emitted when the user double-clicks on an item or presses Enter on the current item. +.PP +If the user does not select anything, no signals are emitted and currentItem() returns -1. +.PP +A list box has WheelFocus as a default focusPolicy(), i.e. it can get keyboard focus by tabbing, clicking and through the use of the mouse wheel. +.PP +New items can be inserted using insertItem(), insertStrList() or insertStringList(). inSort() is obsolete because this method is quite inefficient. It's preferable to insert the items normally and call sort() afterwards, or to insert a sorted QStringList(). +.PP +By default, vertical and horizontal scroll bars are added and removed as necessary. setHScrollBarMode() and setVScrollBarMode() can be used to change this policy. +.PP +If you need to insert types other than strings and pixmaps, you must define new classes which inherit QListBoxItem. +.PP +\fBWarning:\fR The list box assumes ownership of all list box items and will delete them when it does not need them any more. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QListView, QComboBox, QButtonGroup, GUI Design Handbook: List Box (two sections), and Advanced Widgets. +.SS "Member Type Documentation" +.SH "QListBox::LayoutMode" +This enum type is used to specify how QListBox lays out its rows and columns. +.TP +\fCQListBox::FixedNumber\fR - There is a fixed number of rows (or columns). +.TP +\fCQListBox::FitToWidth\fR - There are as many columns as will fit on-screen. +.TP +\fCQListBox::FitToHeight\fR - There are as many rows as will fit on-screen. +.TP +\fCQListBox::Variable\fR - There are as many rows as are required by the column mode. (Or as many columns as required by the row mode.) +.PP +Example: When you call setRowMode( FitToHeight ), columnMode() automatically becomes Variable to accommodate the row mode you've set. +.SH "QListBox::SelectionMode" +This enumerated type is used by QListBox to indicate how it reacts to selection by the user. +.TP +\fCQListBox::Single\fR - When the user selects an item, any already-selected item becomes unselected and the user cannot unselect the selected item. This means that the user can never clear the selection, even though the selection may be cleared by the application programmer using QListBox::clearSelection(). +.TP +\fCQListBox::Multi\fR - When the user selects an item the selection status of that item is toggled and the other items are left alone. Also, multiple items can be selected by dragging the mouse while the left mouse button is kept pressed. +.TP +\fCQListBox::Extended\fR - When the user selects an item the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. And if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item get selected or unselected, depending on the state of the clicked item. Also, multiple items can be selected by dragging the mouse while the left mouse button is kept pressed. +.TP +\fCQListBox::NoSelection\fR - Items cannot be selected. +.PP +In other words, Single is a real single-selection list box, Multi is a real multi-selection list box, Extended is a list box in which users can select multiple items but usually want to select either just one or a range of contiguous items, and NoSelection is for a list box where the user can look but not touch. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QListBox::QListBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a new empty list box called \fIname\fR and with parent \fIparent\fR. +.PP +Performance is boosted by modifying the widget flags \fIf\fR so that only part of the QListBoxItem children is redrawn. This may be unsuitable for custom QListBoxItem classes, in which case WStaticContents and WNoAutoErase should be cleared immediately after construction. +.PP +See also QWidget::clearWFlags() and Qt::WidgetFlags. +.SH "QListBox::~QListBox ()" +Destroys the list box. Deletes all list box items. +.SH "bool QListBox::autoBottomScrollBar () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if hScrollBarMode() is Auto; otherwise returns FALSE. +.SH "bool QListBox::autoScrollBar () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if vScrollBarMode() is Auto; otherwise returns FALSE. +.SH "bool QListBox::bottomScrollBar () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns FALSE if vScrollBarMode() is AlwaysOff; otherwise returns TRUE. +.SH "int QListBox::cellHeight ( int i ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the item height of item \fIi\fR. +.PP +See also itemHeight(). +.SH "int QListBox::cellHeight () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the item height of the first item, item 0. +.PP +See also itemHeight(). +.SH "int QListBox::cellWidth () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the maximum item width. +.PP +See also maxItemWidth(). +.SH "void QListBox::centerCurrentItem ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function does exactly the same as ensureCurrentVisible() +.PP +See also QListBox::ensureCurrentVisible(). +.SH "void QListBox::changeItem ( const QListBoxItem * lbi, int index )" +Replaces the item at position \fIindex\fR with \fIlbi\fR. If \fIindex\fR is negative or too large, changeItem() does nothing. +.PP +The item that has been changed will become selected. +.PP +See also insertItem() and removeItem(). +.SH "void QListBox::changeItem ( const QString & text, int index )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces the item at position \fIindex\fR with a new list box text item with text \fItext\fR. +.PP +The operation is ignored if \fIindex\fR is out of range. +.PP +See also insertItem() and removeItem(). +.SH "void QListBox::changeItem ( const QPixmap & pixmap, int index )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces the item at position \fIindex\fR with a new list box pixmap item with pixmap \fIpixmap\fR. +.PP +The operation is ignored if \fIindex\fR is out of range. +.PP +See also insertItem() and removeItem(). +.SH "void QListBox::changeItem ( const QPixmap & pixmap, const QString & text, int index )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces the item at position \fIindex\fR with a new list box pixmap item with pixmap \fIpixmap\fR and text \fItext\fR. +.PP +The operation is ignored if \fIindex\fR is out of range. +.PP +See also insertItem() and removeItem(). +.SH "void QListBox::clear ()\fC [slot]\fR" +Deletes all the items in the list. +.PP +See also removeItem(). +.SH "void QListBox::clearSelection ()\fC [virtual slot]\fR" +Deselects all items, if possible. +.PP +Note that a Single selection list box will automatically select an item if it has keyboard focus. +.PP +Example: listbox/listbox.cpp. +.SH "void QListBox::clicked ( QListBoxItem * item )\fC [signal]\fR" +This signal is emitted when the user clicks any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. +.PP +Note that you must not delete any QListBoxItem objects in slots connected to this signal. +.SH "void QListBox::clicked ( QListBoxItem * item, const QPoint & pnt )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user clicks any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. +.PP +\fIpnt\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differs by a pixel or two, \fIpnt\fR is the position at release time.) +.PP +Note that you must not delete any QListBoxItem objects in slots connected to this signal. +.SH "LayoutMode QListBox::columnMode () const" +Returns the column layout mode for this list box. See the "columnMode" property for details. +.SH "void QListBox::contextMenuRequested ( QListBoxItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user invokes a context menu with the right mouse button or with special system keys, with \fIitem\fR being the item under the mouse cursor or the current item, respectively. +.PP +\fIpos\fR is the position for the context menu in the global coordinate system. +.SH "uint QListBox::count () const" +Returns the number of items in the list box. See the "count" property for details. +.SH "void QListBox::currentChanged ( QListBoxItem * item )\fC [signal]\fR" +This signal is emitted when the user makes a new item the current item. \fIitem\fR is the new current list box item. +.PP +See also currentItem and currentItem. +.SH "int QListBox::currentItem () const" +Returns the current highlighted item. See the "currentItem" property for details. +.SH "QString QListBox::currentText () const" +Returns the text of the current item. See the "currentText" property for details. +.SH "void QListBox::doLayout () const\fC [protected]\fR" +This function does the hard layout work. You should never need to call it. +.SH "void QListBox::doubleClicked ( QListBoxItem * item )\fC [signal]\fR" +This signal is emitted whenever an item is double-clicked. It's emitted on the second button press, not the second button release. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. +.SH "void QListBox::ensureCurrentVisible ()\fC [virtual slot]\fR" +Ensures that the current item is visible. +.SH "QListBoxItem * QListBox::findItem ( const QString & text, ComparisonFlags compare = BeginsWith ) const" +Finds the first list box item that has the text \fItext\fR and returns it, or returns 0 of no such item could be found. The search starts from the current item if the current item exists, otherwise it starts from the first list box item. If \fCComparisonFlags\fR are specified in \fIcompare\fR then these flags are used, otherwise the default is a case-insensitive, "begins with" search. +.PP +See also Qt::StringComparisonMode. +.SH "int QListBox::findItem ( int yPos ) const\fC [protected]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the index of the item a point (0, \fIyPos\fR). +.PP +See also index() and itemAt(). +.SH "QListBoxItem * QListBox::firstItem () const" +Returns the first item in this list box. If the list box is empty, returns 0. +.SH "void QListBox::highlighted ( int index )\fC [signal]\fR" +This signal is emitted when the user makes a new item the current item. \fIindex\fR is the index of the new current item. +.PP +See also currentChanged(), selected(), currentItem, and selectionChanged(). +.SH "void QListBox::highlighted ( const QString & )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user makes a new item the current item and the item is (or has) a string. The argument is the text of the new current item. +.PP +See also currentChanged(), selected(), currentItem, and selectionChanged(). +.SH "void QListBox::highlighted ( QListBoxItem * )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user makes a new item the current item. The argument is a pointer to the new current item. +.PP +See also currentChanged(), selected(), currentItem, and selectionChanged(). +.SH "int QListBox::inSort ( const QListBoxItem * lbi )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Using this method is quite inefficient. We suggest to use insertItem() for inserting and sort() afterwards. +.PP +Inserts \fIlbi\fR at its sorted position in the list box and returns the position. +.PP +All items must be inserted with inSort() to maintain the sorting order. inSort() treats any pixmap (or user-defined type) as lexicographically less than any string. +.PP +See also insertItem() and sort(). +.SH "int QListBox::inSort ( const QString & text )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Using this method is quite inefficient. We suggest to use insertItem() for inserting and sort() afterwards. +.PP +Inserts a new item of \fItext\fR at its sorted position in the list box and returns the position. +.PP +All items must be inserted with inSort() to maintain the sorting order. inSort() treats any pixmap (or user-defined type) as lexicographically less than any string. +.PP +See also insertItem() and sort(). +.SH "int QListBox::index ( const QListBoxItem * lbi ) const" +Returns the index of \fIlbi\fR, or -1 if the item is not in this list box or \fIlbi\fR is 0. +.PP +See also item(). +.SH "void QListBox::insertItem ( const QListBoxItem * lbi, int index = -1 )" +Inserts the item \fIlbi\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative or larger than the number of items in the list box, \fIlbi\fR is inserted at the end of the list. +.PP +See also insertStrList(). +.PP +Examples: +.)l i18n/mywidget.cpp, listbox/listbox.cpp, listboxcombo/listboxcombo.cpp, and tabdialog/tabdialog.cpp. +.SH "void QListBox::insertItem ( const QListBoxItem * lbi, const QListBoxItem * after )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the item \fIlbi\fR into the list after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. +.PP +See also insertStrList(). +.SH "void QListBox::insertItem ( const QString & text, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a new list box text item with the text \fItext\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative, \fItext\fR is inserted at the end of the list. +.PP +See also insertStrList(). +.SH "void QListBox::insertItem ( const QPixmap & pixmap, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a new list box pixmap item with the pixmap \fIpixmap\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative, \fIpixmap\fR is inserted at the end of the list. +.PP +See also insertStrList(). +.SH "void QListBox::insertItem ( const QPixmap & pixmap, const QString & text, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a new list box pixmap item with the pixmap \fIpixmap\fR and the text \fItext\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative, \fIpixmap\fR is inserted at the end of the list. +.PP +See also insertStrList(). +.SH "void QListBox::insertStrList ( const QStrList * list, int index = -1 )" +Inserts the string list \fIlist\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative, \fIlist\fR is inserted at the end of the list. If \fIindex\fR is too large, the operation is ignored. +.PP +\fBWarning:\fR This function uses \fCconst char *\fR rather than QString, so we recommend against using it. It is provided so that legacy code will continue to work, and so that programs that certainly will not need to handle code outside a single 8-bit locale can use it. See insertStringList() which uses real QStrings. +.PP +\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). +.PP +See also insertItem() and insertStringList(). +.SH "void QListBox::insertStrList ( const QStrList & list, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the string list \fIlist\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative, \fIlist\fR is inserted at the end of the list. If \fIindex\fR is too large, the operation is ignored. +.PP +\fBWarning:\fR This function uses \fCconst char *\fR rather than QString, so we recommend against using it. It is provided so that legacy code will continue to work, and so that programs that certainly will not need to handle code outside a single 8-bit locale can use it. See insertStringList() which uses real QStrings. +.PP +\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). +.PP +See also insertItem() and insertStringList(). +.SH "void QListBox::insertStrList ( const char ** strings, int numStrings = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the \fInumStrings\fR strings of the array \fIstrings\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative, insertStrList() inserts \fIstrings\fR at the end of the list. If \fIindex\fR is too large, the operation is ignored. +.PP +\fBWarning:\fR This function uses \fCconst char *\fR rather than QString, so we recommend against using it. It is provided so that legacy code will continue to work, and so that programs that certainly will not need to handle code outside a single 8-bit locale can use it. See insertStringList() which uses real QStrings. +.PP +\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). +.PP +See also insertItem() and insertStringList(). +.SH "void QListBox::insertStringList ( const QStringList & list, int index = -1 )" +Inserts the string list \fIlist\fR into the list at position \fIindex\fR. +.PP +If \fIindex\fR is negative, \fIlist\fR is inserted at the end of the list. If \fIindex\fR is too large, the operation is ignored. +.PP +\fBWarning:\fR This function is never significantly faster than a loop around insertItem(). +.PP +See also insertItem() and insertStrList(). +.SH "void QListBox::invertSelection ()\fC [virtual slot]\fR" +Inverts the selection. Only works in Multi and Extended selection mode. +.SH "bool QListBox::isMultiSelection () const" +Returns TRUE if or not the list box is in Multi selection mode; otherwise returns FALSE. See the "multiSelection" property for details. +.SH "bool QListBox::isRubberSelecting () const\fC [protected]\fR" +Returns TRUE if the user is selecting items using a rubber band rectangle; otherwise returns FALSE. +.SH "bool QListBox::isSelected ( int i ) const" +Returns TRUE if item \fIi\fR is selected; otherwise returns FALSE. +.SH "bool QListBox::isSelected ( const QListBoxItem * i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if item \fIi\fR is selected; otherwise returns FALSE. +.SH "QListBoxItem * QListBox::item ( int index ) const" +Returns a pointer to the item at position \fIindex\fR, or 0 if \fIindex\fR is out of bounds. +.PP +See also index(). +.PP +Example: listboxcombo/listboxcombo.cpp. +.SH "QListBoxItem * QListBox::itemAt ( const QPoint & p ) const" +Returns the item at point \fIp\fR, specified in viewport coordinates, or a 0 if there is no item at \fIp\fR. +.PP +Use contentsToViewport() to convert between widget coordinates and viewport coordinates. +.SH "int QListBox::itemHeight ( int index = 0 ) const" +Returns the height in pixels of the item with index \fIindex\fR. \fIindex\fR defaults to 0. +.PP +If \fIindex\fR is too large, this function returns 0. +.SH "QRect QListBox::itemRect ( QListBoxItem * item ) const" +Returns the rectangle on the screen that \fIitem\fR occupies in viewport()'s coordinates, or an invalid rectangle if \fIitem\fR is 0 or is not currently visible. +.SH "bool QListBox::itemVisible ( int index )" +Returns TRUE if the item at position \fIindex\fR is at least partly visible; otherwise returns FALSE. +.SH "bool QListBox::itemVisible ( const QListBoxItem * item )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIitem\fR is at least partly visible; otherwise returns FALSE. +.SH "bool QListBox::itemYPos ( int index, int * yPos ) const\fC [protected]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the vertical pixel-coordinate in \fI*yPos\fR, of the list box item at position \fIindex\fR in the list. Returns FALSE if the item is outside the visible area. +.SH "long QListBox::maxItemWidth () const" +Returns the width of the widest item in the list box. +.SH "void QListBox::mouseButtonClicked ( int button, QListBoxItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user clicks mouse button \fIbutton\fR. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). (If the click's press and release differs by a pixel or two, \fIpos\fR is the position at release time.) +.PP +Note that you must not delete any QListBoxItem objects in slots connected to this signal. +.SH "void QListBox::mouseButtonPressed ( int button, QListBoxItem * item, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user presses mouse button \fIbutton\fR. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. +.PP +\fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). +.PP +Note that you must not delete any QListBoxItem objects in slots connected to this signal. +.SH "int QListBox::numCols () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the number of columns. +.PP +See also numColumns. +.SH "int QListBox::numColumns () const" +Returns the number of columns in the list box. See the "numColumns" property for details. +.SH "int QListBox::numItemsVisible () const" +Returns the number of visible items. See the "numItemsVisible" property for details. +.SH "int QListBox::numRows () const" +Returns the number of rows in the list box. See the "numRows" property for details. +.SH "void QListBox::onItem ( QListBoxItem * i )\fC [signal]\fR" +This signal is emitted when the user moves the mouse cursor onto an item, similar to the QWidget::enterEvent() function. \fIi\fR is the QListBoxItem that the mouse has moved on. +.SH "void QListBox::onViewport ()\fC [signal]\fR" +This signal is emitted when the user moves the mouse cursor from an item to an empty part of the list box. +.SH "void QListBox::paintCell ( QPainter * p, int row, int col )\fC [virtual protected]\fR" +Provided for compatibility with the old QListBox. We recommend using QListBoxItem::paint() instead. +.PP +Repaints the cell at \fIrow\fR, \fIcol\fR using painter \fIp\fR. +.SH "const QPixmap * QListBox::pixmap ( int index ) const" +Returns a pointer to the pixmap at position \fIindex\fR, or 0 if there is no pixmap there. +.PP +See also text(). +.SH "void QListBox::pressed ( QListBoxItem * item )\fC [signal]\fR" +This signal is emitted when the user presses any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. +.PP +Note that you must not delete any QListBoxItem objects in slots connected to this signal. +.SH "void QListBox::pressed ( QListBoxItem * item, const QPoint & pnt )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user presses any mouse button. If \fIitem\fR is not 0, the cursor is on \fIitem\fR. If \fIitem\fR is 0, the mouse cursor isn't on any item. +.PP +\fIpnt\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). +.PP +Note that you must not delete any QListBoxItem objects in slots connected to this signal. +.PP +See also mouseButtonPressed(), rightButtonPressed(), and clicked(). +.SH "void QListBox::removeItem ( int index )" +Removes and deletes the item at position \fIindex\fR. If \fIindex\fR is equal to currentItem(), a new item becomes current and the currentChanged() and highlighted() signals are emitted. +.PP +See also insertItem() and clear(). +.SH "void QListBox::returnPressed ( QListBoxItem * )\fC [signal]\fR" +This signal is emitted when Enter or Return is pressed. The argument is currentItem(). +.SH "void QListBox::rightButtonClicked ( QListBoxItem *, const QPoint & )\fC [signal]\fR" +This signal is emitted when the right button is clicked (i.e. when it's released at the same point where it was pressed). The arguments are the relevant QListBoxItem (may be 0) and the point in global coordinates. +.SH "void QListBox::rightButtonPressed ( QListBoxItem *, const QPoint & )\fC [signal]\fR" +This signal is emitted when the right button is pressed. The arguments are the relevant QListBoxItem (may be 0) and the point in global coordinates. +.SH "LayoutMode QListBox::rowMode () const" +Returns the row layout mode for this list box. See the "rowMode" property for details. +.SH "bool QListBox::scrollBar () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns FALSE if vScrollBarMode() is AlwaysOff; otherwise returns TRUE. +.SH "void QListBox::selectAll ( bool select )\fC [virtual slot]\fR" +In Multi and Extended modes, this function sets all items to be selected if \fIselect\fR is TRUE, and to be unselected if \fIselect\fR is FALSE. +.PP +In Single and NoSelection modes, this function only changes the selection status of currentItem(). +.SH "void QListBox::selected ( int index )\fC [signal]\fR" +This signal is emitted when the user double-clicks on an item or presses Enter on the current item. \fIindex\fR is the index of the selected item. +.PP +See also currentChanged(), highlighted(), and selectionChanged(). +.SH "void QListBox::selected ( const QString & )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user double-clicks on an item or presses Enter on the current item, and the item is (or has) a string. The argument is the text of the selected item. +.PP +See also currentChanged(), highlighted(), and selectionChanged(). +.SH "void QListBox::selected ( QListBoxItem * )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the user double-clicks on an item or presses Enter on the current item. The argument is a pointer to the new selected item. +.PP +See also currentChanged(), highlighted(), and selectionChanged(). +.SH "QListBoxItem * QListBox::selectedItem () const" +Returns the selected item if the list box is in single-selection mode and an item is selected. +.PP +If no items are selected or the list box is in another selection mode this function returns 0. +.PP +See also setSelected() and multiSelection. +.SH "void QListBox::selectionChanged ()\fC [signal]\fR" +This signal is emitted when the selection set of a list box changes. This signal is emitted in each selection mode. If the user selects five items by drag-selecting, QListBox tries to emit just one selectionChanged() signal so the signal can be connected to computationally expensive slots. +.PP +See also selected() and currentItem. +.SH "void QListBox::selectionChanged ( QListBoxItem * item )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when the selection in a Single selection list box changes. \fIitem\fR is the newly selected list box item. +.PP +See also selected() and currentItem. +.SH "SelectionMode QListBox::selectionMode () const" +Returns the selection mode of the list box. See the "selectionMode" property for details. +.SH "void QListBox::setAutoBottomScrollBar ( bool enable )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +If \fIenable\fR is TRUE sets setHScrollBarMode() to AlwaysOn; otherwise sets setHScrollBarMode() to AlwaysOff. +.SH "void QListBox::setAutoScrollBar ( bool enable )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +If \fIenable\fR is TRUE sets setVScrollBarMode() to AlwaysOn; otherwise sets setVScrollBarMode() to AlwaysOff. +.SH "void QListBox::setBottomItem ( int index )\fC [virtual]\fR" +Scrolls the list box so the item at position \fIindex\fR in the list is displayed in the bottom row of the list box. +.PP +See also topItem. +.SH "void QListBox::setBottomScrollBar ( bool enable )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +If \fIenable\fR is TRUE sets setHScrollBarMode() to AlwaysOn; otherwise sets setHScrollBarMode() to AlwaysOff. +.SH "void QListBox::setColumnMode ( LayoutMode )\fC [virtual]\fR" +Sets the column layout mode for this list box. See the "columnMode" property for details. +.SH "void QListBox::setColumnMode ( int )\fC [virtual]\fR" +Sets the column layout mode for this list box. See the "columnMode" property for details. +.SH "void QListBox::setCurrentItem ( int index )\fC [virtual]\fR" +Sets the current highlighted item to \fIindex\fR. See the "currentItem" property for details. +.SH "void QListBox::setCurrentItem ( QListBoxItem * i )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the current item to the QListBoxItem \fIi\fR. +.SH "void QListBox::setMultiSelection ( bool multi )" +Sets whether or not the list box is in Multi selection mode to \fImulti\fR. See the "multiSelection" property for details. +.SH "void QListBox::setRowMode ( LayoutMode )\fC [virtual]\fR" +Sets the row layout mode for this list box. See the "rowMode" property for details. +.SH "void QListBox::setRowMode ( int )\fC [virtual]\fR" +Sets the row layout mode for this list box. See the "rowMode" property for details. +.SH "void QListBox::setScrollBar ( bool enable )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +If \fIenable\fR is TRUE sets setVScrollBarMode() to AlwaysOn; otherwise sets setVScrollBarMode() to AlwaysOff. +.SH "void QListBox::setSelected ( QListBoxItem * item, bool select )\fC [virtual]\fR" +Selects \fIitem\fR if \fIselect\fR is TRUE or unselects it if \fIselect\fR is FALSE, and repaints the item appropriately. +.PP +If the list box is a Single selection list box and \fIselect\fR is TRUE, setSelected() calls setCurrentItem(). +.PP +If the list box is a Single selection list box, \fIselect\fR is FALSE, setSelected() calls clearSelection(). +.PP +See also multiSelection, currentItem, clearSelection(), and currentItem. +.SH "void QListBox::setSelected ( int index, bool select )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +If \fIselect\fR is TRUE the item at position \fIindex\fR is selected; otherwise the item is deselected. +.SH "void QListBox::setSelectionMode ( SelectionMode )\fC [virtual]\fR" +Sets the selection mode of the list box. See the "selectionMode" property for details. +.SH "void QListBox::setTopItem ( int index )\fC [virtual]\fR" +Sets the index of an item at the top of the screen to \fIindex\fR. See the "topItem" property for details. +.SH "void QListBox::setVariableHeight ( bool )\fC [virtual]\fR" +Sets whether this list box has variable-height rows. See the "variableHeight" property for details. +.SH "void QListBox::setVariableWidth ( bool )\fC [virtual]\fR" +Sets whether this list box has variable-width columns. See the "variableWidth" property for details. +.SH "void QListBox::sort ( bool ascending = TRUE )" +If \fIascending\fR is TRUE sorts the items in ascending order; otherwise sorts in descending order. +.PP +To compare the items, the text (QListBoxItem::text()) of the items is used. +.PP +Example: listbox/listbox.cpp. +.SH "void QListBox::takeItem ( const QListBoxItem * item )" +Removes \fIitem\fR from the list box and causes an update of the screen display. The item is not deleted. You should normally not need to call this function because QListBoxItem::~QListBoxItem() calls it. The normal way to delete an item is with \fCdelete\fR. +.PP +See also QListBox::insertItem(). +.SH "QString QListBox::text ( int index ) const" +Returns the text at position \fIindex\fR, or QString::null if there is no text at that position. +.PP +See also pixmap(). +.SH "void QListBox::toggleCurrentItem ()\fC [protected]\fR" +Toggles the selection status of currentItem() and repaints if the list box is a Multi selection list box. +.PP +See also multiSelection. +.SH "int QListBox::topItem () const" +Returns the index of an item at the top of the screen. See the "topItem" property for details. +.SH "int QListBox::totalHeight () const\fC [protected]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns contentsHeight(). +.SH "int QListBox::totalWidth () const\fC [protected]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns contentsWidth(). +.SH "void QListBox::triggerUpdate ( bool doLayout )" +Ensures that a single paint event will occur at the end of the current event loop iteration. If \fIdoLayout\fR is TRUE, the layout is also redone. +.SH "void QListBox::updateItem ( int index )\fC [protected]\fR" +Repaints the item at position \fIindex\fR in the list. +.SH "void QListBox::updateItem ( QListBoxItem * i )\fC [protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Repaints the QListBoxItem \fIi\fR. +.SH "bool QListBox::variableHeight () const" +Returns TRUE if this list box has variable-height rows; otherwise returns FALSE. See the "variableHeight" property for details. +.SH "bool QListBox::variableWidth () const" +Returns TRUE if this list box has variable-width columns; otherwise returns FALSE. See the "variableWidth" property for details. +.SS "Property Documentation" +.SH "LayoutMode columnMode" +This property holds the column layout mode for this list box. +.PP +setColumnMode() sets the layout mode and adjusts the number of displayed columns. The row layout mode automatically becomes Variable, unless the column mode is Variable. +.PP +See also rowMode, rowMode, and numColumns. +.PP +Set this property's value with setColumnMode() and get this property's value with columnMode(). +.SH "uint count" +This property holds the number of items in the list box. +.PP +Get this property's value with count(). +.SH "int currentItem" +This property holds the current highlighted item. +.PP +When setting this property, the highlighting is moved to the item and the list box scrolled as necessary. +.PP +If no item is current, currentItem() returns -1. +.PP +Set this property's value with setCurrentItem() and get this property's value with currentItem(). +.SH "QString currentText" +This property holds the text of the current item. +.PP +This is equivalent to text(currentItem()). +.PP +Get this property's value with currentText(). +.SH "bool multiSelection" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This property holds whether or not the list box is in Multi selection mode. +.PP +Consider using the QListBox::selectionMode property instead of this property. +.PP +When setting this property, Multi selection mode is used if set to TRUE and to Single selection mode if set to FALSE. +.PP +When getting this property, TRUE is returned if the list box is in Multi selection mode or Extended selection mode, and FALSE if it is in Single selection mode or NoSelection mode. +.PP +See also selectionMode. +.PP +Set this property's value with setMultiSelection() and get this property's value with isMultiSelection(). +.SH "int numColumns" +This property holds the number of columns in the list box. +.PP +This is normally 1, but can be different if QListBox::columnMode or QListBox::rowMode has been set. +.PP +See also columnMode, rowMode, and numRows. +.PP +Get this property's value with numColumns(). +.SH "int numItemsVisible" +This property holds the number of visible items. +.PP +Both partially and entirely visible items are counted. +.PP +Get this property's value with numItemsVisible(). +.SH "int numRows" +This property holds the number of rows in the list box. +.PP +This is equal to the number of items in the default single-column layout, but can be different. +.PP +See also columnMode, rowMode, and numColumns. +.PP +Get this property's value with numRows(). +.SH "LayoutMode rowMode" +This property holds the row layout mode for this list box. +.PP +This property is normally Variable. +.PP +setRowMode() sets the layout mode and adjusts the number of displayed rows. The column layout mode automatically becomes Variable, unless the row mode is Variable. +.PP +See also columnMode. +.PP +Set this property's value with setRowMode() and get this property's value with rowMode(). +.SH "SelectionMode selectionMode" +This property holds the selection mode of the list box. +.PP +Sets the list box's selection mode, which may be one of Single (the default), Extended, Multi or NoSelection. +.PP +See also SelectionMode. +.PP +Set this property's value with setSelectionMode() and get this property's value with selectionMode(). +.SH "int topItem" +This property holds the index of an item at the top of the screen. +.PP +When getting this property and the listbox has multiple columns, an arbitrary item is selected and returned. +.PP +When setting this property, the list box is scrolled so the item at position \fIindex\fR in the list is displayed in the top row of the list box. +.PP +Set this property's value with setTopItem() and get this property's value with topItem(). +.SH "bool variableHeight" +This property holds whether this list box has variable-height rows. +.PP +When the list box has variable-height rows (the default), each row is as high as the highest item in that row. When it has same-sized rows, all rows are as high as the highest item in the list box. +.PP +See also variableWidth. +.PP +Set this property's value with setVariableHeight() and get this property's value with variableHeight(). +.SH "bool variableWidth" +This property holds whether this list box has variable-width columns. +.PP +When the list box has variable-width columns, each column is as wide as the widest item in that column. When it has same-sized columns (the default), all columns are as wide as the widest item in the list box. +.PP +See also variableHeight. +.PP +Set this property's value with setVariableWidth() and get this property's value with variableWidth(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlistbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlistbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlistboxitem.3qt b/doc/man/man3/tqlistboxitem.3qt new file mode 100644 index 000000000..d418f7b1a --- /dev/null +++ b/doc/man/man3/tqlistboxitem.3qt @@ -0,0 +1,203 @@ +'\" t +.TH QListBoxItem 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 +QListBoxItem \- The base class of all list box items +.SH SYNOPSIS +\fC#include <ntqlistbox.h>\fR +.PP +Inherited by QListBoxText and QListBoxPixmap. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQListBoxItem\fR ( QListBox * listbox = 0 )" +.br +.ti -1c +.BI "\fBQListBoxItem\fR ( QListBox * listbox, QListBoxItem * after )" +.br +.ti -1c +.BI "virtual \fB~QListBoxItem\fR ()" +.br +.ti -1c +.BI "virtual QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual const QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual int \fBheight\fR ( const QListBox * lb ) const" +.br +.ti -1c +.BI "virtual int \fBwidth\fR ( const QListBox * lb ) const" +.br +.ti -1c +.BI "bool \fBisSelected\fR () const" +.br +.ti -1c +.BI "bool \fBisCurrent\fR () const" +.br +.ti -1c +.BI "bool selected () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool current () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QListBox * \fBlistBox\fR () const" +.br +.ti -1c +.BI "void \fBsetSelectable\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisSelectable\fR () const" +.br +.ti -1c +.BI "QListBoxItem * \fBnext\fR () const" +.br +.ti -1c +.BI "QListBoxItem * \fBprev\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * p ) = 0" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & text )" +.br +.ti -1c +.BI "void \fBsetCustomHighlighting\fR ( bool b )" +.br +.in -1c +.SH DESCRIPTION +The QListBoxItem class is the base class of all list box items. +.PP +This class is an abstract base class used for all list box items. If you need to insert customized items into a QListBox you must inherit this class and reimplement paint(), height() and width(). +.PP +See also QListBox. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QListBoxItem::QListBoxItem ( QListBox * listbox = 0 )" +Constructs an empty list box item in the list box \fIlistbox\fR. +.SH "QListBoxItem::QListBoxItem ( QListBox * listbox, QListBoxItem * after )" +Constructs an empty list box item in the list box \fIlistbox\fR and inserts it after the item \fIafter\fR or at the beginning if \fIafter\fR is 0. +.SH "QListBoxItem::~QListBoxItem ()\fC [virtual]\fR" +Destroys the list box item. +.SH "bool QListBoxItem::current () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "int QListBoxItem::height ( const QListBox * lb ) const\fC [virtual]\fR" +Implement this function to return the height of your item. The \fIlb\fR parameter is the same as listBox() and is provided for convenience and compatibility. +.PP +The default implementation returns QApplication::globalStrut()'s height. +.PP +See also paint() and width(). +.PP +Reimplemented in QListBoxText and QListBoxPixmap. +.SH "bool QListBoxItem::isCurrent () const" +Returns TRUE if the item is the current item; otherwise returns FALSE. +.PP +See also QListBox::currentItem, QListBox::item(), and isSelected(). +.SH "bool QListBoxItem::isSelectable () const" +Returns TRUE if this item is selectable (the default); otherwise returns FALSE. +.PP +See also setSelectable(). +.SH "bool QListBoxItem::isSelected () const" +Returns TRUE if the item is selected; otherwise returns FALSE. +.PP +See also QListBox::isSelected() and isCurrent(). +.PP +Example: listboxcombo/listboxcombo.cpp. +.SH "QListBox * QListBoxItem::listBox () const" +Returns a pointer to the list box containing this item. +.SH "QListBoxItem * QListBoxItem::next () const" +Returns the item that comes after this in the list box. If this is the last item, 0 is returned. +.PP +See also prev(). +.SH "void QListBoxItem::paint ( QPainter * p )\fC [pure virtual protected]\fR" +Implement this function to draw your item. The painter, \fIp\fR, is already open for painting. +.PP +See also height() and width(). +.PP +Example: listboxcombo/listboxcombo.cpp. +.PP +Reimplemented in QListBoxText and QListBoxPixmap. +.SH "const QPixmap * QListBoxItem::pixmap () const\fC [virtual]\fR" +Returns the pixmap associated with the item, or 0 if there isn't one. +.PP +The default implementation returns 0. +.PP +Example: listboxcombo/listboxcombo.cpp. +.PP +Reimplemented in QListBoxPixmap. +.SH "QListBoxItem * QListBoxItem::prev () const" +Returns the item which comes before this in the list box. If this is the first item, 0 is returned. +.PP +See also next(). +.SH "int QListBoxItem::rtti () const\fC [virtual]\fR" +Returns 0. +.PP +Make your derived classes return their own values for rtti(), and you can distinguish between listbox items. You should use values greater than 1000 preferably a large random number, to allow for extensions to this class. +.SH "bool QListBoxItem::selected () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QListBoxItem::setCustomHighlighting ( bool b )\fC [protected]\fR" +Defines whether the list box item is responsible for drawing itself in a highlighted state when being selected. +.PP +If \fIb\fR is FALSE (the default), the list box will draw some default highlight indicator before calling paint(). +.PP +See also selected() and paint(). +.SH "void QListBoxItem::setSelectable ( bool b )" +If \fIb\fR is TRUE (the default) then this item can be selected by the user; otherwise this item cannot be selected by the user. +.PP +See also isSelectable(). +.SH "void QListBoxItem::setText ( const QString & text )\fC [virtual protected]\fR" +Sets the text of the QListBoxItem to \fItext\fR. This \fItext\fR is also used for sorting. The text is not shown unless explicitly drawn in paint(). +.PP +See also text(). +.SH "QString QListBoxItem::text () const\fC [virtual]\fR" +Returns the text of the item. This text is also used for sorting. +.PP +See also setText(). +.PP +Example: listboxcombo/listboxcombo.cpp. +.SH "int QListBoxItem::width ( const QListBox * lb ) const\fC [virtual]\fR" +Reimplement this function to return the width of your item. The \fIlb\fR parameter is the same as listBox() and is provided for convenience and compatibility. +.PP +The default implementation returns QApplication::globalStrut()'s width. +.PP +See also paint() and height(). +.PP +Reimplemented in QListBoxText and QListBoxPixmap. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qlistboxitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlistboxitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlistboxpixmap.3qt b/doc/man/man3/tqlistboxpixmap.3qt new file mode 100644 index 000000000..5288ac918 --- /dev/null +++ b/doc/man/man3/tqlistboxpixmap.3qt @@ -0,0 +1,120 @@ +'\" t +.TH QListBoxPixmap 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 +QListBoxPixmap \- List box items with a pixmap and optional text +.SH SYNOPSIS +\fC#include <ntqlistbox.h>\fR +.PP +Inherits QListBoxItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pixmap )" +.br +.ti -1c +.BI "\fBQListBoxPixmap\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pixmap, QListBoxItem * after )" +.br +.ti -1c +.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pix, const QString & text )" +.br +.ti -1c +.BI "\fBQListBoxPixmap\fR ( const QPixmap & pix, const QString & text )" +.br +.ti -1c +.BI "\fBQListBoxPixmap\fR ( QListBox * listbox, const QPixmap & pix, const QString & text, QListBoxItem * after )" +.br +.ti -1c +.BI "\fB~QListBoxPixmap\fR ()" +.br +.ti -1c +.BI "virtual const QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual int \fBheight\fR ( const QListBox * lb ) const" +.br +.ti -1c +.BI "virtual int \fBwidth\fR ( const QListBox * lb ) const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * painter )" +.br +.in -1c +.SH DESCRIPTION +The QListBoxPixmap class provides list box items with a pixmap and optional text. +.PP +Items of this class are drawn with the pixmap on the left with the optional text to the right of the pixmap. +.PP +See also QListBox, QListBoxItem, and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pixmap )" +Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpixmap\fR. +.SH "QListBoxPixmap::QListBoxPixmap ( const QPixmap & pixmap )" +Constructs a new list box item showing the pixmap \fIpixmap\fR. +.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pixmap, QListBoxItem * after )" +Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpixmap\fR. The item gets inserted after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. +.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pix, const QString & text )" +Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpix\fR and the text \fItext\fR. +.SH "QListBoxPixmap::QListBoxPixmap ( const QPixmap & pix, const QString & text )" +Constructs a new list box item showing the pixmap \fIpix\fR and the text to \fItext\fR. +.SH "QListBoxPixmap::QListBoxPixmap ( QListBox * listbox, const QPixmap & pix, const QString & text, QListBoxItem * after )" +Constructs a new list box item in list box \fIlistbox\fR showing the pixmap \fIpix\fR and the string \fItext\fR. The item gets inserted after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. +.SH "QListBoxPixmap::~QListBoxPixmap ()" +Destroys the item. +.SH "int QListBoxPixmap::height ( const QListBox * lb ) const\fC [virtual]\fR" +Returns the height of the pixmap in list box \fIlb\fR. +.PP +See also paint() and width(). +.PP +Reimplemented from QListBoxItem. +.SH "void QListBoxPixmap::paint ( QPainter * painter )\fC [virtual protected]\fR" +Draws the pixmap using \fIpainter\fR. +.PP +Reimplemented from QListBoxItem. +.SH "const QPixmap * QListBoxPixmap::pixmap () const\fC [virtual]\fR" +Returns the pixmap associated with the item. +.PP +Reimplemented from QListBoxItem. +.SH "int QListBoxPixmap::width ( const QListBox * lb ) const\fC [virtual]\fR" +Returns the width of the pixmap plus some margin in list box \fIlb\fR. +.PP +See also paint() and height(). +.PP +Reimplemented from QListBoxItem. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qlistboxpixmap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlistboxpixmap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlistboxtext.3qt b/doc/man/man3/tqlistboxtext.3qt new file mode 100644 index 000000000..5714a37d4 --- /dev/null +++ b/doc/man/man3/tqlistboxtext.3qt @@ -0,0 +1,98 @@ +'\" t +.TH QListBoxText 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 +QListBoxText \- List box items that display text +.SH SYNOPSIS +\fC#include <ntqlistbox.h>\fR +.PP +Inherits QListBoxItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQListBoxText\fR ( QListBox * listbox, const QString & text = QString::null )" +.br +.ti -1c +.BI "\fBQListBoxText\fR ( const QString & text = QString::null )" +.br +.ti -1c +.BI "\fBQListBoxText\fR ( QListBox * listbox, const QString & text, QListBoxItem * after )" +.br +.ti -1c +.BI "\fB~QListBoxText\fR ()" +.br +.ti -1c +.BI "virtual int \fBheight\fR ( const QListBox * lb ) const" +.br +.ti -1c +.BI "virtual int \fBwidth\fR ( const QListBox * lb ) const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * painter )" +.br +.in -1c +.SH DESCRIPTION +The QListBoxText class provides list box items that display text. +.PP +The text is drawn in the widget's current font. If you need several different fonts, you must implement your own subclass of QListBoxItem. +.PP +See also QListBox, QListBoxItem, and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QListBoxText::QListBoxText ( QListBox * listbox, const QString & text = QString::null )" +Constructs a list box item in list box \fIlistbox\fR showing the text \fItext\fR. +.SH "QListBoxText::QListBoxText ( const QString & text = QString::null )" +Constructs a list box item showing the text \fItext\fR. +.SH "QListBoxText::QListBoxText ( QListBox * listbox, const QString & text, QListBoxItem * after )" +Constructs a list box item in list box \fIlistbox\fR showing the text \fItext\fR. The item is inserted after the item \fIafter\fR, or at the beginning if \fIafter\fR is 0. +.SH "QListBoxText::~QListBoxText ()" +Destroys the item. +.SH "int QListBoxText::height ( const QListBox * lb ) const\fC [virtual]\fR" +Returns the height of a line of text in list box \fIlb\fR. +.PP +See also paint() and width(). +.PP +Reimplemented from QListBoxItem. +.SH "void QListBoxText::paint ( QPainter * painter )\fC [virtual protected]\fR" +Draws the text using \fIpainter\fR. +.PP +Reimplemented from QListBoxItem. +.SH "int QListBoxText::width ( const QListBox * lb ) const\fC [virtual]\fR" +Returns the width of this line in list box \fIlb\fR. +.PP +See also paint() and height(). +.PP +Reimplemented from QListBoxItem. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qlistboxtext.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlistboxtext.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlistview.3qt b/doc/man/man3/tqlistview.3qt new file mode 100644 index 000000000..39629dece --- /dev/null +++ b/doc/man/man3/tqlistview.3qt @@ -0,0 +1,1108 @@ +'\" t +.TH QListView 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 +QListView \- Implements a list/tree view +.SH SYNOPSIS +\fC#include <ntqlistview.h>\fR +.PP +Inherits QScrollView. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQListView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QListView\fR ()" +.br +.ti -1c +.BI "int \fBtreeStepSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTreeStepSize\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBinsertItem\fR ( QListViewItem * i )" +.br +.ti -1c +.BI "virtual void \fBtakeItem\fR ( QListViewItem * i )" +.br +.ti -1c +.BI "virtual void removeItem ( QListViewItem * item ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QHeader * \fBheader\fR () const" +.br +.ti -1c +.BI "virtual int \fBaddColumn\fR ( const QString & label, int width = -1 )" +.br +.ti -1c +.BI "virtual int \fBaddColumn\fR ( const QIconSet & iconset, const QString & label, int width = -1 )" +.br +.ti -1c +.BI "virtual void \fBremoveColumn\fR ( int index )" +.br +.ti -1c +.BI "virtual void \fBsetColumnText\fR ( int column, const QString & label )" +.br +.ti -1c +.BI "virtual void \fBsetColumnText\fR ( int column, const QIconSet & iconset, const QString & label )" +.br +.ti -1c +.BI "QString \fBcolumnText\fR ( int c ) const" +.br +.ti -1c +.BI "virtual void \fBsetColumnWidth\fR ( int column, int w )" +.br +.ti -1c +.BI "int \fBcolumnWidth\fR ( int c ) const" +.br +.ti -1c +.BI "enum \fBWidthMode\fR { Manual, Maximum }" +.br +.ti -1c +.BI "virtual void \fBsetColumnWidthMode\fR ( int c, WidthMode mode )" +.br +.ti -1c +.BI "WidthMode \fBcolumnWidthMode\fR ( int c ) const" +.br +.ti -1c +.BI "int \fBcolumns\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetColumnAlignment\fR ( int column, int align )" +.br +.ti -1c +.BI "int \fBcolumnAlignment\fR ( int column ) const" +.br +.ti -1c +.BI "QListViewItem * \fBitemAt\fR ( const QPoint & viewPos ) const" +.br +.ti -1c +.BI "QRect \fBitemRect\fR ( const QListViewItem * i ) const" +.br +.ti -1c +.BI "int \fBitemPos\fR ( const QListViewItem * item )" +.br +.ti -1c +.BI "void \fBensureItemVisible\fR ( const QListViewItem * i )" +.br +.ti -1c +.BI "void \fBrepaintItem\fR ( const QListViewItem * item ) const" +.br +.ti -1c +.BI "virtual void setMultiSelection ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isMultiSelection () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "enum \fBSelectionMode\fR { Single, Multi, Extended, NoSelection }" +.br +.ti -1c +.BI "void \fBsetSelectionMode\fR ( SelectionMode mode )" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBclearSelection\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetSelected\fR ( QListViewItem * item, bool selected )" +.br +.ti -1c +.BI "void \fBsetSelectionAnchor\fR ( QListViewItem * item )" +.br +.ti -1c +.BI "bool \fBisSelected\fR ( const QListViewItem * i ) const" +.br +.ti -1c +.BI "QListViewItem * \fBselectedItem\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetOpen\fR ( QListViewItem * item, bool open )" +.br +.ti -1c +.BI "bool \fBisOpen\fR ( const QListViewItem * item ) const" +.br +.ti -1c +.BI "virtual void \fBsetCurrentItem\fR ( QListViewItem * i )" +.br +.ti -1c +.BI "QListViewItem * \fBcurrentItem\fR () const" +.br +.ti -1c +.BI "QListViewItem * \fBfirstChild\fR () const" +.br +.ti -1c +.BI "QListViewItem * \fBlastItem\fR () const" +.br +.ti -1c +.BI "int \fBchildCount\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAllColumnsShowFocus\fR ( bool )" +.br +.ti -1c +.BI "bool \fBallColumnsShowFocus\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetItemMargin\fR ( int )" +.br +.ti -1c +.BI "int \fBitemMargin\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRootIsDecorated\fR ( bool )" +.br +.ti -1c +.BI "bool \fBrootIsDecorated\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSorting\fR ( int column, bool ascending = TRUE )" +.br +.ti -1c +.BI "int \fBsortColumn\fR () const" +.br +.ti -1c +.BI "void \fBsetSortColumn\fR ( int column )" +.br +.ti -1c +.BI "SortOrder \fBsortOrder\fR () const" +.br +.ti -1c +.BI "void \fBsetSortOrder\fR ( SortOrder order )" +.br +.ti -1c +.BI "virtual void \fBsort\fR ()" +.br +.ti -1c +.BI "virtual bool \fBeventFilter\fR ( QObject * o, QEvent * e )" +.br +.ti -1c +.BI "virtual void \fBsetShowSortIndicator\fR ( bool show )" +.br +.ti -1c +.BI "bool \fBshowSortIndicator\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetShowToolTips\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBshowToolTips\fR () const" +.br +.ti -1c +.BI "enum \fBResizeMode\fR { NoColumn, AllColumns, LastColumn }" +.br +.ti -1c +.BI "virtual void \fBsetResizeMode\fR ( ResizeMode m )" +.br +.ti -1c +.BI "ResizeMode \fBresizeMode\fR () const" +.br +.ti -1c +.BI "QListViewItem * \fBfindItem\fR ( const QString & text, int column, ComparisonFlags compare = ExactMatch | CaseSensitive ) const" +.br +.ti -1c +.BI "enum \fBRenameAction\fR { Accept, Reject }" +.br +.ti -1c +.BI "virtual void \fBsetDefaultRenameAction\fR ( RenameAction a )" +.br +.ti -1c +.BI "RenameAction \fBdefaultRenameAction\fR () const" +.br +.ti -1c +.BI "bool \fBisRenaming\fR () const" +.br +.ti -1c +.BI "void \fBhideColumn\fR ( int column )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBinvertSelection\fR ()" +.br +.ti -1c +.BI "virtual void \fBselectAll\fR ( bool select )" +.br +.ti -1c +.BI "void \fBtriggerUpdate\fR ()" +.br +.ti -1c +.BI "void \fBadjustColumn\fR ( int col )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBselectionChanged\fR ()" +.br +.ti -1c +.BI "void \fBselectionChanged\fR ( QListViewItem * )" +.br +.ti -1c +.BI "void \fBcurrentChanged\fR ( QListViewItem * )" +.br +.ti -1c +.BI "void \fBclicked\fR ( QListViewItem * item )" +.br +.ti -1c +.BI "void \fBclicked\fR ( QListViewItem * item, const QPoint & pnt, int c )" +.br +.ti -1c +.BI "void \fBpressed\fR ( QListViewItem * item )" +.br +.ti -1c +.BI "void \fBpressed\fR ( QListViewItem * item, const QPoint & pnt, int c )" +.br +.ti -1c +.BI "void doubleClicked ( QListViewItem * item ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBdoubleClicked\fR ( QListViewItem *, const QPoint &, int )" +.br +.ti -1c +.BI "void \fBreturnPressed\fR ( QListViewItem * )" +.br +.ti -1c +.BI "void \fBspacePressed\fR ( QListViewItem * )" +.br +.ti -1c +.BI "void \fBrightButtonClicked\fR ( QListViewItem *, const QPoint &, int )" +.br +.ti -1c +.BI "void \fBrightButtonPressed\fR ( QListViewItem *, const QPoint &, int )" +.br +.ti -1c +.BI "void \fBmouseButtonPressed\fR ( int button, QListViewItem * item, const QPoint & pos, int c )" +.br +.ti -1c +.BI "void \fBmouseButtonClicked\fR ( int button, QListViewItem * item, const QPoint & pos, int c )" +.br +.ti -1c +.BI "void \fBcontextMenuRequested\fR ( QListViewItem * item, const QPoint & pos, int col )" +.br +.ti -1c +.BI "void \fBonItem\fR ( QListViewItem * i )" +.br +.ti -1c +.BI "void \fBonViewport\fR ()" +.br +.ti -1c +.BI "void \fBexpanded\fR ( QListViewItem * item )" +.br +.ti -1c +.BI "void \fBcollapsed\fR ( QListViewItem * item )" +.br +.ti -1c +.BI "void \fBdropped\fR ( QDropEvent * e )" +.br +.ti -1c +.BI "void \fBitemRenamed\fR ( QListViewItem * item, int col, const QString & text )" +.br +.ti -1c +.BI "void \fBitemRenamed\fR ( QListViewItem * item, int col )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBallColumnsShowFocus\fR - whether items should show keyboard focus using all columns" +.br +.ti -1c +.BI "int \fBchildCount\fR - the number of parentless (top-level) QListViewItem objects in this QListView \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcolumns\fR - the number of columns in this list view \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "RenameAction \fBdefaultRenameAction\fR - what action to perform when the editor loses focus during renaming" +.br +.ti -1c +.BI "int \fBitemMargin\fR - the advisory item margin that list items may use" +.br +.ti -1c +.BI "bool multiSelection - whether the list view is in multi-selection or extended-selection mode \fI(obsolete)\fR" +.br +.ti -1c +.BI "ResizeMode \fBresizeMode\fR - whether " "all" ", none or the only the last column should be resized" +.br +.ti -1c +.BI "bool \fBrootIsDecorated\fR - whether the list view shows open/close signs on root items" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR - the list view's selection mode" +.br +.ti -1c +.BI "bool \fBshowSortIndicator\fR - whether the list view header should display a sort indicator" +.br +.ti -1c +.BI "bool \fBshowToolTips\fR - whether this list view should show tooltips for truncated column texts" +.br +.ti -1c +.BI "int \fBtreeStepSize\fR - the number of pixels a child is offset from its parent" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBcontentsMousePressEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsMouseReleaseEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsMouseMoveEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsMouseDoubleClickEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual QDragObject * \fBdragObject\fR ()" +.br +.ti -1c +.BI "virtual void \fBstartDrag\fR ()" +.br +.ti -1c +.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * e )" +.br +.ti -1c +.BI "virtual void \fBdrawContentsOffset\fR ( QPainter * p, int ox, int oy, int cx, int cy, int cw, int ch )" +.br +.ti -1c +.BI "virtual void \fBpaintEmptyArea\fR ( QPainter * p, const QRect & rect )" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "void \fBupdateContents\fR ()" +.br +.ti -1c +.BI "void \fBdoAutoScroll\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QListView class implements a list/tree view. +.PP +It can display and control a hierarchy of multi-column items, and provides the ability to add new items at any time. The user may select one or many items (depending on the SelectionMode) and sort the list in increasing or decreasing order by any column. +.PP +The simplest pattern of use is to create a QListView, add some column headers using addColumn() and create one or more QListViewItem or QCheckListItem objects with the QListView as parent: +.PP +.nf +.br + QListView * table; +.fi +.PP +.nf +.br + table->addColumn( "Qualified name" ); +.br + table->addColumn( "Namespace" ); +.fi +.PP +.nf +.br + element = new QListViewItem( table, qName, namespaceURI ); +.fi +.PP +Further nodes can be added to the list view object (the root of the tree) or as child nodes to QListViewItems: +.PP +.nf +.br + for ( int i = 0 ; i < attributes.length(); i++ ) { +.br + new QListViewItem( element, attributes.qName(i), attributes.uri(i) ); +.br + } +.fi +.PP +(From xml/tagreader-with-features/structureparser.cpp) +.PP +The main setup functions are: <center>.nf +.TS +l - l. Function Action addColumn() Adds a column with a text label and perhaps width. Columns are counted from the left starting with column 0. setColumnWidthMode() Sets the column to be resized automatically or not. setAllColumnsShowFocus() Sets whether items should show keyboard focus using all columns or just column 0. The default is to show focus just using column 0. setRootIsDecorated() Sets whether root items should show open/close decoration to their left. The default is FALSE. setTreeStepSize() Sets how many pixels an item's children are indented relative to their parent. The default is 20. This is mostly a matter of taste. setSorting() +.TE +.fi +</center> +.PP +To handle events such as mouse presses on the list view, derived classes can reimplement the QScrollView functions: contentsMousePressEvent, contentsMouseReleaseEvent, contentsMouseDoubleClickEvent, contentsMouseMoveEvent, contentsDragEnterEvent, contentsDragMoveEvent, contentsDragLeaveEvent, contentsDropEvent, and contentsWheelEvent. +.PP +There are also several functions for mapping between items and coordinates. itemAt() returns the item at a position on-screen, itemRect() returns the rectangle an item occupies on the screen, and itemPos() returns the position of any item (whether it is on-screen or not). firstChild() returns the list view's first item (not necessarily visible on-screen). +.PP +You can iterate over visible items using QListViewItem::itemBelow(); over a list view's top-level items using QListViewItem::firstChild() and QListViewItem::nextSibling(); or every item using a QListViewItemIterator. See the QListViewItem documentation for examples of traversal. +.PP +An item can be moved amongst its siblings using QListViewItem::moveItem(). To move an item in the hierarchy use takeItem() and insertItem(). Item's (and all their child items) are deleted with \fCdelete\fR; to delete all the list view's items use clear(). +.PP +There are a variety of selection modes described in the QListView::SelectionMode documentation. The default is Single selection, which you can change using setSelectionMode(). +.PP +Because QListView offers multiple selection it must display keyboard focus and selection state separately. Therefore there are functions both to set the selection state of an item (setSelected()) and to set which item displays keyboard focus (setCurrentItem()). +.PP +QListView emits two groups of signals; one group signals changes in selection/focus state and one indicates selection. The first group consists of selectionChanged() (applicable to all list views), selectionChanged(QListViewItem*) (applicable only to a Single selection list view), and currentChanged(QListViewItem*). The second group consists of doubleClicked(QListViewItem*), returnPressed(QListViewItem*), rightButtonClicked(QListViewItem*, const QPoint&, int), etc. +.PP +Note that changing the state of the list view in a slot connected to a list view signal may cause unexpected side effects. If you need to change the list view's state in response to a signal, use a single shot timer with a time out of 0, and connect this timer to a slot that modifies the list view's state. +.PP +In Motif style, QListView deviates fairly strongly from the look and feel of the Motif hierarchical tree view. This is done mostly to provide a usable keyboard interface and to make the list view look better with a white background. +.PP +If selectionMode() is Single (the default) the user can select one item at a time, e.g. by clicking an item with the mouse, see QListView::SelectionMode for details. +.PP +The list view can be navigated either using the mouse or the keyboard. Clicking a \fB-\fR icon closes an item (hides its children) and clicking a \fB+\fR icon opens an item (shows its children). The keyboard controls are these: <center>.nf +.TS +l - l. Keypress Action Home Make the first item current and visible. End Make the last item current and visible. Page Up Make the item above the top visible item current and visible. Page Down Make the item below the bottom visible item current and visible. Up Arrow Make the item above the current item current and visible. Down Arrow Make the item below the current item current and visible. Left Arrow If the current item is closed ( Right Arrow If the current item is closed ( +.TE +.fi +</center> +.PP +If the user starts typing letters with the focus in the list view an incremental search will occur. For example if the user types 'd' the current item will change to the first item that begins with the letter 'd'; if they then type 'a', the current item will change to the first item that begins with 'da', and so on. If no item begins with the letters they type the current item doesn't change. +.PP +\fBWarning:\fR The list view assumes ownership of all list view items and will delete them when it does not need them any more. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QListViewItem, QCheckListItem, and Advanced Widgets. +.SS "Member Type Documentation" +.SH "QListView::RenameAction" +This enum describes whether a rename operation is accepted if the rename editor loses focus without the user pressing Enter. +.TP +\fCQListView::Accept\fR - Rename if Enter is pressed or focus is lost. +.TP +\fCQListView::Reject\fR - Discard the rename operation if focus is lost (and Enter has not been pressed). +.SH "QListView::ResizeMode" +This enum describes how the list view's header adjusts to resize events which affect the width of the list view. +.TP +\fCQListView::NoColumn\fR - The columns do not get resized in resize events. +.TP +\fCQListView::AllColumns\fR - All columns are resized equally to fit the width of the list view. +.TP +\fCQListView::LastColumn\fR - The last column is resized to fit the width of the list view. +.SH "QListView::SelectionMode" +This enumerated type is used by QListView to indicate how it reacts to selection by the user. +.TP +\fCQListView::Single\fR - When the user selects an item, any already-selected item becomes unselected. The user can unselect the selected item by clicking on some empty space within the view. +.TP +\fCQListView::Multi\fR - When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone. Also, multiple items can be selected by dragging the mouse while the left mouse button stays pressed. +.TP +\fCQListView::Extended\fR - When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. And if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item get selected or unselected, depending on the state of the clicked item. Also, multiple items can be selected by dragging the mouse over them. +.TP +\fCQListView::NoSelection\fR - Items cannot be selected. +.PP +In other words, Single is a real single-selection list view, Multi a real multi-selection list view, Extended is a list view where users can select multiple items but usually want to select either just one or a range of contiguous items, and NoSelection is a list view where the user can look but not touch. +.SH "QListView::WidthMode" +This enum type describes how the width of a column in the view changes. +.TP +\fCQListView::Manual\fR - the column width does not change automatically. +.TP +\fCQListView::Maximum\fR - the column is automatically sized according to the widths of all items in the column. (Note: The column never shrinks in this case.) This means that the column is always resized to the width of the item with the largest width in the column. +.PP +See also setColumnWidth(), setColumnWidthMode(), and columnWidth(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QListView::QListView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a new empty list view called \fIname\fR with parent \fIparent\fR. +.PP +Performance is boosted by modifying the widget flags \fIf\fR so that only part of the QListViewItem children is redrawn. This may be unsuitable for custom QListViewItem classes, in which case WStaticContents and WNoAutoErase should be cleared. +.PP +See also QWidget::clearWFlags() and Qt::WidgetFlags. +.SH "QListView::~QListView ()" +Destroys the list view, deleting all its items, and frees up all allocated resources. +.SH "int QListView::addColumn ( const QString & label, int width = -1 )\fC [virtual]\fR" +Adds a \fIwidth\fR pixels wide column with the column header \fIlabel\fR to the list view, and returns the index of the new column. +.PP +All columns apart from the first one are inserted to the right of the existing ones. +.PP +If \fIwidth\fR is negative, the new column's WidthMode is set to Maximum instead of Manual. +.PP +See also setColumnText(), setColumnWidth(), and setColumnWidthMode(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, checklists/checklists.cpp, dirview/main.cpp, fileiconview/mainwindow.cpp, listviews/listviews.cpp, and qdir/qdir.cpp. +.SH "int QListView::addColumn ( const QIconSet & iconset, const QString & label, int width = -1 )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a \fIwidth\fR pixels wide new column with the header \fIlabel\fR and the \fIiconset\fR to the list view, and returns the index of the column. +.PP +If \fIwidth\fR is negative, the new column's WidthMode is set to Maximum, and to Manual otherwise. +.PP +See also setColumnText(), setColumnWidth(), and setColumnWidthMode(). +.SH "void QListView::adjustColumn ( int col )\fC [slot]\fR" +Adjusts the column \fIcol\fR to its preferred width +.SH "bool QListView::allColumnsShowFocus () const" +Returns TRUE if items should show keyboard focus using all columns; otherwise returns FALSE. See the "allColumnsShowFocus" property for details. +.SH "int QListView::childCount () const" +Returns the number of parentless (top-level) QListViewItem objects in this QListView. See the "childCount" property for details. +.SH "void QListView::clear ()\fC [virtual slot]\fR" +Removes and deletes all the items in this list view and triggers an update. +.PP +Note that the currentChanged() signal is not emitted when this slot is invoked. +.PP +See also triggerUpdate(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, checklists/checklists.cpp, listviews/listviews.cpp, and qutlook/centralwidget.cpp. +.SH "void QListView::clearSelection ()\fC [virtual]\fR" +Sets all the items to be not selected, updates the list view as necessary, and emits the selectionChanged() signals. Note that for Multi selection list views this function needs to iterate over \fIall\fR items. +.PP +See also setSelected() and multiSelection. +.PP +Example: addressbook/centralwidget.cpp. +.SH "void QListView::clicked ( QListViewItem * item )\fC [signal]\fR" +This signal is emitted whenever the user clicks (mouse pressed \fIand\fR mouse released) in the list view. \fIitem\fR is the clicked list view item, or 0 if the user didn't click on an item. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.PP +Example: addressbook/centralwidget.cpp. +.SH "void QListView::clicked ( QListViewItem * item, const QPoint & pnt, int c )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted whenever the user clicks (mouse pressed \fIand\fR mouse released) in the list view. \fIitem\fR is the clicked list view item, or 0 if the user didn't click on an item. \fIpnt\fR is the position where the user has clicked in global coordinates. If \fIitem\fR is not 0, \fIc\fR is the list view column into which the user pressed; if \fIitem\fR is 0 \fIc\fR's value is undefined. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.SH "void QListView::collapsed ( QListViewItem * item )\fC [signal]\fR" +This signal is emitted when the \fIitem\fR has been collapsed, i.e. when the children of \fIitem\fR are hidden. +.PP +See also setOpen() and expanded(). +.SH "int QListView::columnAlignment ( int column ) const" +Returns the alignment of column \fIcolumn\fR. The default is AlignAuto. +.PP +See also Qt::AlignmentFlags. +.SH "QString QListView::columnText ( int c ) const" +Returns the text of column \fIc\fR. +.PP +See also setColumnText(). +.SH "int QListView::columnWidth ( int c ) const" +Returns the width of column \fIc\fR. +.PP +See also setColumnWidth(). +.SH "WidthMode QListView::columnWidthMode ( int c ) const" +Returns the WidthMode for column \fIc\fR. +.PP +See also setColumnWidthMode(). +.SH "int QListView::columns () const" +Returns the number of columns in this list view. See the "columns" property for details. +.SH "void QListView::contentsMouseDoubleClickEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +Processes the mouse double-click event \fIe\fR on behalf of the viewed widget. +.PP +Reimplemented from QScrollView. +.SH "void QListView::contentsMouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +Processes the mouse move event \fIe\fR on behalf of the viewed widget. +.PP +Example: dirview/dirview.cpp. +.PP +Reimplemented from QScrollView. +.SH "void QListView::contentsMousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +Processes the mouse press event \fIe\fR on behalf of the viewed widget. +.PP +Example: dirview/dirview.cpp. +.PP +Reimplemented from QScrollView. +.SH "void QListView::contentsMouseReleaseEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +Processes the mouse release event \fIe\fR on behalf of the viewed widget. +.PP +Example: dirview/dirview.cpp. +.PP +Reimplemented from QScrollView. +.SH "void QListView::contextMenuRequested ( QListViewItem * item, const QPoint & pos, int col )\fC [signal]\fR" +This signal is emitted when the user invokes a context menu with the right mouse button or with special system keys. If the keyboard was used \fIitem\fR is the current item; if the mouse was used, \fIitem\fR is the item under the mouse pointer or 0 if there is no item under the mouse pointer. If no item is clicked, the column index emitted is -1. +.PP +\fIpos\fR is the position for the context menu in the global coordinate system. +.PP +\fIcol\fR is the column on which the user pressed, or -1 if the signal was triggered by a key event. +.PP +Example: listviews/listviews.cpp. +.SH "void QListView::currentChanged ( QListViewItem * )\fC [signal]\fR" +This signal is emitted whenever the current item has changed (normally after the screen update). The current item is the item responsible for indicating keyboard focus. +.PP +The argument is the newly current item, or 0 if the change made no item current. This can happen, for example, if all items in the list view are deleted. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.PP +See also setCurrentItem() and currentItem(). +.PP +Example: listviews/listviews.cpp. +.SH "QListViewItem * QListView::currentItem () const" +Returns the current item, or 0 if there isn't one. +.PP +See also setCurrentItem(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, listviews/listviews.cpp, and qutlook/centralwidget.cpp. +.SH "RenameAction QListView::defaultRenameAction () const" +Returns what action to perform when the editor loses focus during renaming. See the "defaultRenameAction" property for details. +.SH "void QListView::doAutoScroll ()\fC [protected slot]\fR" +This slot handles auto-scrolling when the mouse button is pressed and the mouse is outside the widget. +.SH "void QListView::doubleClicked ( QListViewItem *, const QPoint &, int )\fC [signal]\fR" +This signal is emitted whenever an item is double-clicked. It's emitted on the second button press, not the second button release. The arguments are the relevant QListViewItem (may be 0), the point in global coordinates and the relevant column (or -1 if the click was outside the list). +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.SH "void QListView::doubleClicked ( QListViewItem * item )\fC [signal]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. (use doubleClicked( QListViewItem *, const QPoint&, int )) +.PP +This signal is emitted whenever an item is double-clicked. It's emitted on the second button press, not the second button release. \fIitem\fR is the list view item on which the user did the double-click. +.SH "QDragObject * QListView::dragObject ()\fC [virtual protected]\fR" +If the user presses the mouse on an item and starts moving the mouse, and the item allow dragging (see QListViewItem::setDragEnabled()), this function is called to get a drag object and a drag is started unless dragObject() returns 0. +.PP +By default this function returns 0. You should reimplement it and create a QDragObject depending on the selected items. +.SH "void QListView::drawContentsOffset ( QPainter * p, int ox, int oy, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" +Calls QListViewItem::paintCell() and QListViewItem::paintBranches() as necessary for all list view items that require repainting in the \fIcw\fR pixels wide and \fIch\fR pixels high bounding rectangle starting at position \fIcx\fR, \fIcy\fR with offset \fIox\fR, \fIoy\fR. Uses the painter \fIp\fR. +.PP +Reimplemented from QScrollView. +.SH "void QListView::dropped ( QDropEvent * e )\fC [signal]\fR" +This signal is emitted, when a drop event occurred on the viewport (not onto an item). +.PP +\fIe\fR provides all the information about the drop. +.SH "void QListView::ensureItemVisible ( const QListViewItem * i )" +Ensures that item \fIi\fR is visible, scrolling the list view vertically if necessary and opening (expanding) any parent items if this is required to show the item. +.PP +See also itemRect() and QScrollView::ensureVisible(). +.SH "bool QListView::eventFilter ( QObject * o, QEvent * e )\fC [virtual]\fR" +Redirects the event \fIe\fR relating to object \fIo\fR, for the viewport to mousePressEvent(), keyPressEvent() and friends. +.PP +Reimplemented from QScrollView. +.SH "void QListView::expanded ( QListViewItem * item )\fC [signal]\fR" +This signal is emitted when \fIitem\fR has been expanded, i.e. when the children of \fIitem\fR are shown. +.PP +See also setOpen() and collapsed(). +.SH "QListViewItem * QListView::findItem ( const QString & text, int column, ComparisonFlags compare = ExactMatch | CaseSensitive ) const" +Finds the first list view item in column \fIcolumn\fR, that matches \fItext\fR and returns the item, or returns 0 of no such item could be found. The search starts from the current item if the current item exists, otherwise it starts from the first list view item. After reaching the last item the search continues from the first item. Pass OR-ed together Qt::StringComparisonMode values in the \fIcompare\fR flag, to control how the matching is performed. The default comparison mode is case-sensitive, exact match. +.SH "QListViewItem * QListView::firstChild () const" +Returns the first item in this QListView. Returns 0 if there is no first item. +.PP +A list view's items can be traversed using firstChild() and nextSibling() or using a QListViewItemIterator. +.PP +See also itemAt(), QListViewItem::itemBelow(), and QListViewItem::itemAbove(). +.PP +Examples: +.)l addressbook/centralwidget.cpp and listviews/listviews.cpp. +.SH "QHeader * QListView::header () const" +Returns the QHeader object that manages this list view's columns. Please don't modify the header behind the list view's back. +.PP +You may safely call QHeader::setClickEnabled(), QHeader::setResizeEnabled(), QHeader::setMovingEnabled(), QHeader::hide() and all the const QHeader functions. +.PP +Examples: +.)l listviews/listviews.cpp and qdir/qdir.cpp. +.SH "void QListView::hideColumn ( int column )" +Hides the column specified at \fIcolumn\fR. This is a convenience function that calls setColumnWidth( \fIcolumn\fR, 0 ). +.PP +Note: The user may still be able to resize the hidden column using the header handles. To prevent this, call setResizeEnabled(FALSE, \fIcolumn\fR) on the list views header. +.PP +See also setColumnWidth(). +.SH "void QListView::insertItem ( QListViewItem * i )\fC [virtual]\fR" +Inserts item \fIi\fR into the list view as a top-level item. You do not need to call this unless you've called takeItem(\fIi\fR) or QListViewItem::takeItem(\fIi\fR) and need to reinsert \fIi\fR elsewhere. +.PP +See also QListViewItem::takeItem() and takeItem(). +.SH "void QListView::invertSelection ()\fC [virtual slot]\fR" +Inverts the selection. Only works in Multi and Extended selection modes. +.SH "bool QListView::isMultiSelection () const" +Returns TRUE if the list view is in multi-selection or extended-selection mode; otherwise returns FALSE. See the "multiSelection" property for details. +.SH "bool QListView::isOpen ( const QListViewItem * item ) const" +Identical to \fIitem\fR->isOpen(). Provided for completeness. +.PP +See also setOpen(). +.SH "bool QListView::isRenaming () const" +Returns TRUE if an item is being renamed; otherwise returns FALSE. +.SH "bool QListView::isSelected ( const QListViewItem * i ) const" +Returns TRUE if the list view item \fIi\fR is selected; otherwise returns FALSE. +.PP +See also QListViewItem::isSelected(). +.SH "QListViewItem * QListView::itemAt ( const QPoint & viewPos ) const" +Returns the list view item at \fIviewPos\fR. Note that \fIviewPos\fR is in the viewport()'s coordinate system, not in the list view's own, much larger, coordinate system. +.PP +itemAt() returns 0 if there is no such item. +.PP +Note that you also get the pointer to the item if \fIviewPos\fR points to the root decoration (see setRootIsDecorated()) of the item. To check whether or not \fIviewPos\fR is on the root decoration of the item, you can do something like this: +.PP +.nf +.br + QListViewItem *i = itemAt( p ); +.br + if ( i ) { +.br + if ( p.x() > header()->sectionPos( header()->mapToIndex( 0 ) ) + +.br + treeStepSize() * ( i->depth() + ( rootIsDecorated() ? 1 : 0) ) + itemMargin() || +.br + p.x() < header()->sectionPos( header()->mapToIndex( 0 ) ) ) { +.br + ; // p is not on root decoration +.br + else +.br + ; // p is on the root decoration +.br + } +.br +.fi +.PP +This might be interesting if you use this function to find out where the user clicked and if you want to start a drag (which you do not want to do if the user clicked onto the root decoration of an item). +.PP +See also itemPos(), itemRect(), and viewportToContents(). +.SH "int QListView::itemMargin () const" +Returns the advisory item margin that list items may use. See the "itemMargin" property for details. +.SH "int QListView::itemPos ( const QListViewItem * item )" +Returns the y-coordinate of \fIitem\fR in the list view's coordinate system. This function is normally much slower than itemAt() but it works for all items, whereas itemAt() normally works only for items on the screen. +.PP +This is a thin wrapper around QListViewItem::itemPos(). +.PP +See also itemAt() and itemRect(). +.SH "QRect QListView::itemRect ( const QListViewItem * i ) const" +Returns the rectangle on the screen that item \fIi\fR occupies in viewport()'s coordinates, or an invalid rectangle if \fIi\fR is 0 or is not currently visible. +.PP +The rectangle returned does not include any children of the rectangle (i.e. it uses QListViewItem::height(), rather than QListViewItem::totalHeight()). If you want the rectangle to include children you can use something like this: +.PP +.nf +.br + QRect r( listView->itemRect( item ) ); +.br + r.setHeight( (QCOORD)(QMIN( item->totalHeight(), +.br + listView->viewport->height() - r.y() ) ) ) +.br +.fi +.PP +Note the way it avoids too-high rectangles. totalHeight() can be much larger than the window system's coordinate system allows. +.PP +itemRect() is comparatively slow. It's best to call it only for items that are probably on-screen. +.SH "void QListView::itemRenamed ( QListViewItem * item, int col, const QString & text )\fC [signal]\fR" +This signal is emitted when \fIitem\fR has been renamed to \fItext\fR, e.g. by in in-place renaming, in column \fIcol\fR. +.PP +See also QListViewItem::setRenameEnabled(). +.SH "void QListView::itemRenamed ( QListViewItem * item, int col )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when \fIitem\fR has been renamed, e.g. by in-place renaming, in column \fIcol\fR. +.PP +See also QListViewItem::setRenameEnabled(). +.SH "QListViewItem * QListView::lastItem () const" +Returns the last item in the list view tree. Returns 0 if there are no items in the QListView. +.PP +This function is slow because it traverses the entire tree to find the last item. +.SH "void QListView::mouseButtonClicked ( int button, QListViewItem * item, const QPoint & pos, int c )\fC [signal]\fR" +This signal is emitted whenever the user clicks (mouse pressed \fIand\fR mouse released) in the list view at position \fIpos\fR. \fIbutton\fR is the mouse button that the user pressed, \fIitem\fR is the clicked list view item or 0 if the user didn't click on an item. If \fIitem\fR is not 0, \fIc\fR is the list view column into which the user pressed; if \fIitem\fR is 0 \fIc\fR's value is undefined. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.SH "void QListView::mouseButtonPressed ( int button, QListViewItem * item, const QPoint & pos, int c )\fC [signal]\fR" +This signal is emitted whenever the user pressed the mouse button in the list view at position \fIpos\fR. \fIbutton\fR is the mouse button which the user pressed, \fIitem\fR is the pressed list view item or 0 if the user didn't press on an item. If \fIitem\fR is not 0, \fIc\fR is the list view column into which the user pressed; if \fIitem\fR is 0 \fIc\fR's value is undefined. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.SH "void QListView::onItem ( QListViewItem * i )\fC [signal]\fR" +This signal is emitted when the user moves the mouse cursor onto item \fIi\fR, similar to the QWidget::enterEvent() function. +.SH "void QListView::onViewport ()\fC [signal]\fR" +This signal is emitted when the user moves the mouse cursor from an item to an empty part of the list view. +.SH "void QListView::paintEmptyArea ( QPainter * p, const QRect & rect )\fC [virtual protected]\fR" +Paints \fIrect\fR so that it looks like empty background using painter \fIp\fR. \fIrect\fR is in widget coordinates, ready to be fed to \fIp\fR. +.PP +The default function fills \fIrect\fR with the viewport()->backgroundBrush(). +.SH "void QListView::pressed ( QListViewItem * item )\fC [signal]\fR" +This signal is emitted whenever the user presses the mouse button in a list view. \fIitem\fR is the list view item on which the user pressed the mouse button, or 0 if the user didn't press the mouse on an item. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.SH "void QListView::pressed ( QListViewItem * item, const QPoint & pnt, int c )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted whenever the user presses the mouse button in a list view. \fIitem\fR is the list view item on which the user pressed the mouse button, or 0 if the user didn't press the mouse on an item. \fIpnt\fR is the position of the mouse cursor in global coordinates, and \fIc\fR is the column where the mouse cursor was when the user pressed the mouse button. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.SH "void QListView::removeColumn ( int index )\fC [virtual]\fR" +Removes the column at position \fIindex\fR. +.PP +If no columns remain after the column is removed, the list view will be cleared. +.PP +See also clear(). +.SH "void QListView::removeItem ( QListViewItem * item )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function has been renamed takeItem(). +.SH "void QListView::repaintItem ( const QListViewItem * item ) const" +Repaints \fIitem\fR on the screen if \fIitem\fR is currently visible. Takes care to avoid multiple repaints. +.SH "void QListView::resizeEvent ( QResizeEvent * e )\fC [virtual protected]\fR" +Ensures that the header is correctly sized and positioned when the resize event \fIe\fR occurs. +.SH "ResizeMode QListView::resizeMode () const" +Returns TRUE if all, none or the only the last column should be resized; otherwise returns FALSE. See the "resizeMode" property for details. +.SH "void QListView::returnPressed ( QListViewItem * )\fC [signal]\fR" +This signal is emitted when Enter or Return is pressed. The argument is the currentItem(). +.SH "void QListView::rightButtonClicked ( QListViewItem *, const QPoint &, int )\fC [signal]\fR" +This signal is emitted when the right button is clicked (i.e. when it's released). The arguments are the relevant QListViewItem (may be 0), the point in global coordinates and the relevant column (or -1 if the click was outside the list). +.SH "void QListView::rightButtonPressed ( QListViewItem *, const QPoint &, int )\fC [signal]\fR" +This signal is emitted when the right button is pressed. The arguments are the relevant QListViewItem (may be 0), the point in global coordinates and the relevant column (or -1 if the click was outside the list). +.SH "bool QListView::rootIsDecorated () const" +Returns TRUE if the list view shows open/close signs on root items; otherwise returns FALSE. See the "rootIsDecorated" property for details. +.SH "void QListView::selectAll ( bool select )\fC [virtual slot]\fR" +If \fIselect\fR is TRUE, all the items get selected; otherwise all the items get unselected. This only works in the selection modes Multi and Extended. In Single and NoSelection mode the selection of the current item is just set to \fIselect\fR. +.SH "QListViewItem * QListView::selectedItem () const" +Returns the selected item if the list view is in Single selection mode and an item is selected. +.PP +If no items are selected or the list view is not in Single selection mode this function returns 0. +.PP +See also setSelected() and multiSelection. +.SH "void QListView::selectionChanged ()\fC [signal]\fR" +This signal is emitted whenever the set of selected items has changed (normally before the screen update). It is available in Single, Multi, and Extended selection modes, but is most useful in Multi selection mode. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.PP +See also setSelected() and QListViewItem::setSelected(). +.PP +Example: listviews/listviews.cpp. +.SH "void QListView::selectionChanged ( QListViewItem * )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted whenever the selected item has changed in Single selection mode (normally after the screen update). The argument is the newly selected item. If the selection is cleared (when, for example, the user clicks in the unused area of the list view) then this signal will not be emitted. +.PP +In Multi selection mode, use the no argument overload of this signal. +.PP +\fBWarning:\fR Do not delete any QListViewItem objects in slots connected to this signal. +.PP +See also setSelected(), QListViewItem::setSelected(), and currentChanged(). +.SH "SelectionMode QListView::selectionMode () const" +Returns the list view's selection mode. See the "selectionMode" property for details. +.SH "void QListView::setAllColumnsShowFocus ( bool )\fC [virtual]\fR" +Sets whether items should show keyboard focus using all columns. See the "allColumnsShowFocus" property for details. +.SH "void QListView::setColumnAlignment ( int column, int align )\fC [virtual]\fR" +Sets column \fIcolumn\fR's alignment to \fIalign\fR. The alignment is ultimately passed to QListViewItem::paintCell() for each item in the list view. For horizontally aligned text with Qt::AlignLeft or Qt::AlignHCenter the ellipsis (...) will be to the right, for Qt::AlignRight the ellipsis will be to the left. +.PP +See also Qt::AlignmentFlags. +.PP +Example: listviews/listviews.cpp. +.SH "void QListView::setColumnText ( int column, const QString & label )\fC [virtual]\fR" +Sets the heading of column \fIcolumn\fR to \fIlabel\fR. +.PP +See also columnText(). +.SH "void QListView::setColumnText ( int column, const QIconSet & iconset, const QString & label )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the heading of column \fIcolumn\fR to \fIiconset\fR and \fIlabel\fR. +.PP +See also columnText(). +.SH "void QListView::setColumnWidth ( int column, int w )\fC [virtual]\fR" +Sets the width of column \fIcolumn\fR to \fIw\fR pixels. Note that if the column has a WidthMode other than Manual, this width setting may be subsequently overridden. +.PP +See also columnWidth(). +.SH "void QListView::setColumnWidthMode ( int c, WidthMode mode )\fC [virtual]\fR" +Sets column \fIc\fR's width mode to \fImode\fR. The default depends on the original width argument to addColumn(). +.PP +See also QListViewItem::width(). +.SH "void QListView::setCurrentItem ( QListViewItem * i )\fC [virtual]\fR" +Sets item \fIi\fR to be the current item and repaints appropriately (i.e. highlights the item). The current item is used for keyboard navigation and focus indication; it is independent of any selected items, although a selected item can also be the current item. +.PP +This function does not set the selection anchor. Use setSelectionAnchor() instead. +.PP +See also currentItem() and setSelected(). +.PP +Example: listviews/listviews.cpp. +.SH "void QListView::setDefaultRenameAction ( RenameAction a )\fC [virtual]\fR" +Sets what action to perform when the editor loses focus during renaming to \fIa\fR. See the "defaultRenameAction" property for details. +.SH "void QListView::setItemMargin ( int )\fC [virtual]\fR" +Sets the advisory item margin that list items may use. See the "itemMargin" property for details. +.SH "void QListView::setMultiSelection ( bool enable )\fC [virtual]\fR" +Sets whether the list view is in multi-selection or extended-selection mode to \fIenable\fR. See the "multiSelection" property for details. +.SH "void QListView::setOpen ( QListViewItem * item, bool open )\fC [virtual]\fR" +Sets \fIitem\fR to be open if \fIopen\fR is TRUE and \fIitem\fR is expandable, and to be closed if \fIopen\fR is FALSE. Repaints accordingly. +.PP +See also QListViewItem::setOpen() and QListViewItem::setExpandable(). +.SH "void QListView::setResizeMode ( ResizeMode m )\fC [virtual]\fR" +Sets whether all, none or the only the last column should be resized to \fIm\fR. See the "resizeMode" property for details. +.SH "void QListView::setRootIsDecorated ( bool )\fC [virtual]\fR" +Sets whether the list view shows open/close signs on root items. See the "rootIsDecorated" property for details. +.SH "void QListView::setSelected ( QListViewItem * item, bool selected )\fC [virtual]\fR" +If \fIselected\fR is TRUE the \fIitem\fR is selected; otherwise it is unselected. +.PP +If the list view is in Single selection mode and \fIselected\fR is TRUE, the currently selected item is unselected and \fIitem\fR is made current. Unlike QListViewItem::setSelected(), this function updates the list view as necessary and emits the selectionChanged() signals. +.PP +See also isSelected(), multiSelection, multiSelection, setCurrentItem(), and setSelectionAnchor(). +.PP +Example: listviews/listviews.cpp. +.SH "void QListView::setSelectionAnchor ( QListViewItem * item )" +Sets the selection anchor to \fIitem\fR, if \fIitem\fR is selectable. +.PP +The selection anchor is the item that remains selected when Shift-selecting with either mouse or keyboard in Extended selection mode. +.PP +See also setSelected(). +.SH "void QListView::setSelectionMode ( SelectionMode mode )" +Sets the list view's selection mode to \fImode\fR. See the "selectionMode" property for details. +.SH "void QListView::setShowSortIndicator ( bool show )\fC [virtual]\fR" +Sets whether the list view header should display a sort indicator to \fIshow\fR. See the "showSortIndicator" property for details. +.SH "void QListView::setShowToolTips ( bool b )\fC [virtual]\fR" +Sets whether this list view should show tooltips for truncated column texts to \fIb\fR. See the "showToolTips" property for details. +.SH "void QListView::setSortColumn ( int column )" +Sets the sorting column for the list view. +.PP +If \fIcolumn\fR is -1, sorting is disabled and the user cannot sort columns by clicking on the column headers. If \fIcolumn\fR is larger than the number of columns the user must click on a column header to sort the list view. +.PP +See also setSorting(). +.SH "void QListView::setSortOrder ( SortOrder order )" +Sets the sort order for the items in the list view to \fIorder\fR. +.PP +See also setSorting(). +.SH "void QListView::setSorting ( int column, bool ascending = TRUE )\fC [virtual]\fR" +Sets the list view to be sorted by column \fIcolumn\fR in ascending order if \fIascending\fR is TRUE or descending order if it is FALSE. +.PP +If \fIcolumn\fR is -1, sorting is disabled and the user cannot sort columns by clicking on the column headers. If \fIcolumn\fR is larger than the number of columns the user must click on a column header to sort the list view. +.SH "void QListView::setTreeStepSize ( int )\fC [virtual]\fR" +Sets the number of pixels a child is offset from its parent. See the "treeStepSize" property for details. +.SH "bool QListView::showSortIndicator () const" +Returns TRUE if the list view header should display a sort indicator; otherwise returns FALSE. See the "showSortIndicator" property for details. +.SH "bool QListView::showToolTips () const" +Returns TRUE if this list view should show tooltips for truncated column texts; otherwise returns FALSE. See the "showToolTips" property for details. +.SH "void QListView::sort ()\fC [virtual]\fR" +Sorts the list view using the last sorting configuration (sort column and ascending/descending). +.SH "int QListView::sortColumn () const" +Returns the column by which the list view is sorted, or -1 if sorting is disabled. +.PP +See also sortOrder(). +.SH "SortOrder QListView::sortOrder () const" +Returns the sorting order of the list view items. +.PP +See also sortColumn(). +.SH "void QListView::spacePressed ( QListViewItem * )\fC [signal]\fR" +This signal is emitted when Space is pressed. The argument is the currentItem(). +.SH "void QListView::startDrag ()\fC [virtual protected]\fR" +Starts a drag. +.SH "void QListView::takeItem ( QListViewItem * i )\fC [virtual]\fR" +Removes item \fIi\fR from the list view; \fIi\fR must be a top-level item. The warnings regarding QListViewItem::takeItem() apply to this function, too. +.PP +See also insertItem(). +.SH "int QListView::treeStepSize () const" +Returns the number of pixels a child is offset from its parent. See the "treeStepSize" property for details. +.SH "void QListView::triggerUpdate ()\fC [slot]\fR" +Triggers a size, geometry and content update during the next iteration of the event loop. Ensures that there'll be just one update to avoid flicker. +.SH "void QListView::updateContents ()\fC [protected slot]\fR" +Updates the sizes of the viewport, header, scroll bars and so on. +.PP +\fBWarning:\fR Don't call this directly; call triggerUpdate() instead. +.SS "Property Documentation" +.SH "bool allColumnsShowFocus" +This property holds whether items should show keyboard focus using all columns. +.PP +If this property is TRUE all columns will show focus and selection states, otherwise only column 0 will show focus. +.PP +The default is FALSE. +.PP +Setting this to TRUE if it's not necessary may cause noticeable flicker. +.PP +Set this property's value with setAllColumnsShowFocus() and get this property's value with allColumnsShowFocus(). +.SH "int childCount" +This property holds the number of parentless (top-level) QListViewItem objects in this QListView. +.PP +Holds the current number of parentless (top-level) QListViewItem objects in this QListView. +.PP +See also QListViewItem::childCount(). +.PP +Get this property's value with childCount(). +.SH "int columns" +This property holds the number of columns in this list view. +.PP +Get this property's value with columns(). +.PP +See also addColumn() and removeColumn(). +.SH "RenameAction defaultRenameAction" +This property holds what action to perform when the editor loses focus during renaming. +.PP +If this property is Accept, and the user renames an item and the editor loses focus (without the user pressing Enter), the item will still be renamed. If the property's value is Reject, the item will not be renamed unless the user presses Enter. The default is Reject. +.PP +Set this property's value with setDefaultRenameAction() and get this property's value with defaultRenameAction(). +.SH "int itemMargin" +This property holds the advisory item margin that list items may use. +.PP +The item margin defaults to one pixel and is the margin between the item's edges and the area where it draws its contents. QListViewItem::paintFocus() draws in the margin. +.PP +See also QListViewItem::paintCell(). +.PP +Set this property's value with setItemMargin() and get this property's value with itemMargin(). +.SH "bool multiSelection" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This property holds whether the list view is in multi-selection or extended-selection mode. +.PP +If you enable multi-selection, Multi, mode, it is possible to specify whether or not this mode should be extended. Extended means that the user can select multiple items only when pressing the Shift or Ctrl key at the same time. +.PP +The default selection mode is Single. +.PP +See also selectionMode. +.PP +Set this property's value with setMultiSelection() and get this property's value with isMultiSelection(). +.SH "ResizeMode resizeMode" +This property holds whether all, none or the only the last column should be resized. +.PP +Specifies whether all, none or only the last column should be resized to fit the full width of the list view. The values for this property can be one of: NoColumn (the default), AllColumns or LastColumn. +.PP +\fBWarning:\fR Setting the resize mode should be done after all necessary columns have been added to the list view, otherwise the behavior is undefined. +.PP +See also QHeader and header(). +.PP +Set this property's value with setResizeMode() and get this property's value with resizeMode(). +.SH "bool rootIsDecorated" +This property holds whether the list view shows open/close signs on root items. +.PP +Open/close signs are small \fB+\fR or \fB-\fR symbols in windows style, or arrows in Motif style. The default is FALSE. +.PP +Set this property's value with setRootIsDecorated() and get this property's value with rootIsDecorated(). +.SH "SelectionMode selectionMode" +This property holds the list view's selection mode. +.PP +The mode can be Single (the default), Extended, Multi or NoSelection. +.PP +See also multiSelection. +.PP +Set this property's value with setSelectionMode() and get this property's value with selectionMode(). +.SH "bool showSortIndicator" +This property holds whether the list view header should display a sort indicator. +.PP +If this property is TRUE, an arrow is drawn in the header of the list view to indicate the sort order of the list view contents. The arrow will be drawn in the correct column and will point up or down, depending on the current sort direction. The default is FALSE (don't show an indicator). +.PP +See also QHeader::setSortIndicator(). +.PP +Set this property's value with setShowSortIndicator() and get this property's value with showSortIndicator(). +.SH "bool showToolTips" +This property holds whether this list view should show tooltips for truncated column texts. +.PP +The default is TRUE. +.PP +Set this property's value with setShowToolTips() and get this property's value with showToolTips(). +.SH "int treeStepSize" +This property holds the number of pixels a child is offset from its parent. +.PP +The default is 20 pixels. +.PP +Of course, this property is only meaningful for hierarchical list views. +.PP +Set this property's value with setTreeStepSize() and get this property's value with treeStepSize(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlistview.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlistview.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlistviewitem.3qt b/doc/man/man3/tqlistviewitem.3qt new file mode 100644 index 000000000..550099022 --- /dev/null +++ b/doc/man/man3/tqlistviewitem.3qt @@ -0,0 +1,724 @@ +'\" t +.TH QListViewItem 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 +QListViewItem \- Implements a list view item +.SH SYNOPSIS +\fC#include <ntqlistview.h>\fR +.PP +Inherits Qt. +.PP +Inherited by QCheckListItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQListViewItem\fR ( QListView * parent )" +.br +.ti -1c +.BI "\fBQListViewItem\fR ( QListViewItem * parent )" +.br +.ti -1c +.BI "\fBQListViewItem\fR ( QListView * parent, QListViewItem * after )" +.br +.ti -1c +.BI "\fBQListViewItem\fR ( QListViewItem * parent, QListViewItem * after )" +.br +.ti -1c +.BI "\fBQListViewItem\fR ( QListView * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +.br +.ti -1c +.BI "\fBQListViewItem\fR ( QListViewItem * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +.br +.ti -1c +.BI "\fBQListViewItem\fR ( QListView * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +.br +.ti -1c +.BI "\fBQListViewItem\fR ( QListViewItem * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +.br +.ti -1c +.BI "virtual \fB~QListViewItem\fR ()" +.br +.ti -1c +.BI "virtual void \fBinsertItem\fR ( QListViewItem * newChild )" +.br +.ti -1c +.BI "virtual void \fBtakeItem\fR ( QListViewItem * item )" +.br +.ti -1c +.BI "virtual void removeItem ( QListViewItem * item ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "virtual void \fBinvalidateHeight\fR ()" +.br +.ti -1c +.BI "int \fBtotalHeight\fR () const" +.br +.ti -1c +.BI "virtual int \fBwidth\fR ( const QFontMetrics & fm, const QListView * lv, int c ) const" +.br +.ti -1c +.BI "void \fBwidthChanged\fR ( int c = -1 ) const" +.br +.ti -1c +.BI "int \fBdepth\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( int column, const QString & text )" +.br +.ti -1c +.BI "virtual QString \fBtext\fR ( int column ) const" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( int column, const QPixmap & pm )" +.br +.ti -1c +.BI "virtual const QPixmap * \fBpixmap\fR ( int column ) const" +.br +.ti -1c +.BI "virtual QString \fBkey\fR ( int column, bool ascending ) const" +.br +.ti -1c +.BI "virtual int \fBcompare\fR ( QListViewItem * i, int col, bool ascending ) const" +.br +.ti -1c +.BI "virtual void \fBsortChildItems\fR ( int column, bool ascending )" +.br +.ti -1c +.BI "int \fBchildCount\fR () const" +.br +.ti -1c +.BI "bool \fBisOpen\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetOpen\fR ( bool o )" +.br +.ti -1c +.BI "virtual void \fBsetup\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetSelected\fR ( bool s )" +.br +.ti -1c +.BI "bool \fBisSelected\fR () const" +.br +.ti -1c +.BI "virtual void \fBpaintCell\fR ( QPainter * p, const QColorGroup & cg, int column, int width, int align )" +.br +.ti -1c +.BI "virtual void \fBpaintBranches\fR ( QPainter * p, const QColorGroup & cg, int w, int y, int h )" +.br +.ti -1c +.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QColorGroup & cg, const QRect & r )" +.br +.ti -1c +.BI "QListViewItem * \fBfirstChild\fR () const" +.br +.ti -1c +.BI "QListViewItem * \fBnextSibling\fR () const" +.br +.ti -1c +.BI "QListViewItem * \fBparent\fR () const" +.br +.ti -1c +.BI "QListViewItem * \fBitemAbove\fR ()" +.br +.ti -1c +.BI "QListViewItem * \fBitemBelow\fR ()" +.br +.ti -1c +.BI "int \fBitemPos\fR () const" +.br +.ti -1c +.BI "QListView * \fBlistView\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSelectable\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBisSelectable\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetExpandable\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBisExpandable\fR () const" +.br +.ti -1c +.BI "void \fBrepaint\fR () const" +.br +.ti -1c +.BI "virtual void \fBsort\fR ()" +.br +.ti -1c +.BI "void \fBmoveItem\fR ( QListViewItem * after )" +.br +.ti -1c +.BI "virtual void \fBsetDragEnabled\fR ( bool allow )" +.br +.ti -1c +.BI "virtual void \fBsetDropEnabled\fR ( bool allow )" +.br +.ti -1c +.BI "bool \fBdragEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBdropEnabled\fR () const" +.br +.ti -1c +.BI "virtual bool \fBacceptDrop\fR ( const QMimeSource * mime ) const" +.br +.ti -1c +.BI "void \fBsetVisible\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisVisible\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRenameEnabled\fR ( int col, bool b )" +.br +.ti -1c +.BI "bool \fBrenameEnabled\fR ( int col ) const" +.br +.ti -1c +.BI "virtual void \fBstartRename\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBsetEnabled\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMultiLinesEnabled\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBmultiLinesEnabled\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBenforceSortOrder\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetHeight\fR ( int height )" +.br +.ti -1c +.BI "virtual void \fBactivate\fR ()" +.br +.ti -1c +.BI "bool \fBactivatedPos\fR ( QPoint & pos )" +.br +.ti -1c +.BI "virtual void \fBdropped\fR ( QDropEvent * e )" +.br +.ti -1c +.BI "virtual void \fBdragEntered\fR ()" +.br +.ti -1c +.BI "virtual void \fBdragLeft\fR ()" +.br +.ti -1c +.BI "virtual void \fBokRename\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBcancelRename\fR ( int col )" +.br +.in -1c +.SH DESCRIPTION +The QListViewItem class implements a list view item. +.PP +A list view item is a multi-column object capable of displaying itself in a QListView. +.PP +The easiest way to use QListViewItem is to construct one with a few constant strings, and either a QListView or another QListViewItem as parent. +.PP +.nf +.br + (void) new QListViewItem( listView, "Column 1", "Column 2" ); +.br + (void) new QListViewItem( listView->firstChild(), "A", "B", "C" ); +.br +.fi +We've discarded the pointers to the items since we can still access them via their parent \fIlistView\fR. By default, QListView sorts its items; this can be switched off with QListView::setSorting(-1). +.PP +The parent must be another QListViewItem or a QListView. If the parent is a QListView, the item becomes a top-level item within that QListView. If the parent is another QListViewItem, the item becomes a child of that list view item. +.PP +If you keep the pointer, you can set or change the texts using setText(), add pixmaps using setPixmap(), change its mode using setSelectable(), setSelected(), setOpen() and setExpandable(). You'll also be able to change its height using setHeight(), and traverse its sub-items. You don't have to keep the pointer since you can get a pointer to any QListViewItem in a QListView using QListView::selectedItem(), QListView::currentItem(), QListView::firstChild(), QListView::lastItem() and QListView::findItem(). +.PP +If you call \fCdelete\fR on a list view item, it will be deleted as expected, and as usual for QObjects, if it has any child items (to any depth), all these will be deleted too. +.PP +QCheckListItems are list view items that have a checkbox or radio button and can be used in place of plain QListViewItems. +.PP +You can traverse the tree as if it were a doubly-linked list using itemAbove() and itemBelow(); they return pointers to the items directly above and below this item on the screen (even if none of them are actually visible at the moment). +.PP +Here's how to traverse all of an item's children (but not its children's children, etc.): Example: +.PP +.nf +.br + QListViewItem * myChild = myItem->firstChild(); +.br + while( myChild ) { +.br + doSomething( myChild ); +.br + myChild = myChild->nextSibling(); +.br + } +.br +.fi +.PP +If you want to iterate over every item, to any level of depth use an iterator. To iterate over the entire tree, initialize the iterator with the list view itself; to iterate starting from a particular item, initialize the iterator with the item: +.PP +.nf +.br + QListViewItemIterator it( listview ); +.br + while ( it.current() ) { +.br + QListViewItem *item = it.current(); +.br + doSomething( item ); +.br + ++it; +.br + } +.br +.fi +.PP +Note that the order of the children will change when the sorting order changes and is undefined if the items are not visible. You can, however, call enforceSortOrder() at any time; QListView will always call it before it needs to show an item. +.PP +Many programs will need to reimplement QListViewItem. The most commonly reimplemented functions are: <center>.nf +.TS +l - l. Function Description text() Returns the text in a column. Many subclasses will compute this on the fly. key() Used for sorting. The default key() simply calls text(), but judicious use of key() can give you fine control over sorting; for example, QFileDialog reimplements key() to sort by date. setup() Called before showing the item and whenever the list view's font changes, for example. activate() +.TE +.fi +</center> +.PP +Some subclasses call setExpandable(TRUE) even when they have no children, and populate themselves when setup() or setOpen(TRUE) is called. The dirview/dirview.cpp example program uses this technique to start up quickly: The files and subdirectories in a directory aren't inserted into the tree until they're actually needed. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QCheckListItem, QListView, and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QListViewItem::QListViewItem ( QListView * parent )" +Constructs a new top-level list view item in the QListView \fIparent\fR. +.SH "QListViewItem::QListViewItem ( QListViewItem * parent )" +Constructs a new list view item that is a child of \fIparent\fR and first in the parent's list of children. +.SH "QListViewItem::QListViewItem ( QListView * parent, QListViewItem * after )" +Constructs an empty list view item that is a child of \fIparent\fR and is after item \fIafter\fR in the parent's list of children. Since \fIparent\fR is a QListView the item will be a top-level item. +.SH "QListViewItem::QListViewItem ( QListViewItem * parent, QListViewItem * after )" +Constructs an empty list view item that is a child of \fIparent\fR and is after item \fIafter\fR in the parent's list of children. +.SH "QListViewItem::QListViewItem ( QListView * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +Constructs a new top-level list view item in the QListView \fIparent\fR, with up to eight constant strings, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and \fIlabel8\fR defining its columns' contents. +.PP +See also setText(). +.SH "QListViewItem::QListViewItem ( QListViewItem * parent, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +Constructs a new list view item as a child of the QListViewItem \fIparent\fR with up to eight constant strings, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and \fIlabel8\fR as columns' contents. +.PP +See also setText(). +.SH "QListViewItem::QListViewItem ( QListView * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +Constructs a new list view item in the QListView \fIparent\fR that is included after item \fIafter\fR and that has up to eight column texts, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and\fIlabel8\fR. +.PP +Note that the order is changed according to QListViewItem::key() unless the list view's sorting is disabled using QListView::setSorting(-1). +.PP +See also setText(). +.SH "QListViewItem::QListViewItem ( QListViewItem * parent, QListViewItem * after, QString label1, QString label2 = QString::null, QString label3 = QString::null, QString label4 = QString::null, QString label5 = QString::null, QString label6 = QString::null, QString label7 = QString::null, QString label8 = QString::null )" +Constructs a new list view item as a child of the QListViewItem \fIparent\fR. It is inserted after item \fIafter\fR and may contain up to eight strings, \fIlabel1\fR, \fIlabel2\fR, \fIlabel3\fR, \fIlabel4\fR, \fIlabel5\fR, \fIlabel6\fR, \fIlabel7\fR and \fIlabel8\fR as column entries. +.PP +Note that the order is changed according to QListViewItem::key() unless the list view's sorting is disabled using QListView::setSorting(-1). +.PP +See also setText(). +.SH "QListViewItem::~QListViewItem ()\fC [virtual]\fR" +Destroys the item, deleting all its children and freeing up all allocated resources. +.SH "bool QListViewItem::acceptDrop ( const QMimeSource * mime ) const\fC [virtual]\fR" +Returns TRUE if the item can accept drops of type QMimeSource \fImime\fR; otherwise returns FALSE. +.PP +The default implementation does nothing and returns FALSE. A subclass must reimplement this to accept drops. +.SH "void QListViewItem::activate ()\fC [virtual protected]\fR" +This virtual function is called whenever the user presses the mouse on this item or presses Space on it. +.PP +See also activatedPos(). +.PP +Reimplemented in QCheckListItem. +.SH "bool QListViewItem::activatedPos ( QPoint & pos )\fC [protected]\fR" +When called from a reimplementation of activate(), this function gives information on how the item was activated. Otherwise the behavior is undefined. +.PP +If activate() was caused by a mouse press, the function sets \fIpos\fR to where the user clicked and returns TRUE; otherwise it returns FALSE and does not change \fIpos\fR. +.PP +\fIpos\fR is relative to the top-left corner of this item. +.PP +\fBWarning:\fR We recommend that you ignore this function; it is scheduled to become obsolete. +.PP +See also activate(). +.SH "void QListViewItem::cancelRename ( int col )\fC [virtual protected]\fR" +This function is called if the user cancels in-place renaming of this item in column \fIcol\fR (e.g. by pressing Esc). +.PP +See also okRename(). +.SH "int QListViewItem::childCount () const" +Returns how many children this item has. The count only includes the item's immediate children. +.SH "int QListViewItem::compare ( QListViewItem * i, int col, bool ascending ) const\fC [virtual]\fR" +Compares this list view item to \fIi\fR using the column \fIcol\fR in \fIascending\fR order. Returns < 0 if this item is less than \fIi\fR, 0 if they are equal and > 0 if this item is greater than \fIi\fR. +.PP +This function is used for sorting. +.PP +The default implementation compares the item keys (key()) using QString::localeAwareCompare(). A reimplementation can use different values and a different comparison function. Here is a reimplementation that uses plain Unicode comparison: +.PP +.nf +.br + int MyListViewItem::compare( QListViewItem *i, int col, +.br + bool ascending ) const +.br + { +.br + return key( col, ascending ).compare( i->key( col, ascending) ); +.br + } +.br +.fi +We don't recommend using \fIascending\fR so your code can safely ignore it. +.PP +See also key(), QString::localeAwareCompare(), and QString::compare(). +.SH "int QListViewItem::depth () const" +Returns the depth of this item. +.PP +Example: dirview/dirview.cpp. +.SH "bool QListViewItem::dragEnabled () const" +Returns TRUE if this item can be dragged; otherwise returns FALSE. +.PP +See also setDragEnabled(). +.SH "void QListViewItem::dragEntered ()\fC [virtual protected]\fR" +This function is called when a drag enters the item's bounding rectangle. +.PP +The default implementation does nothing, subclasses may need to reimplement this function. +.SH "void QListViewItem::dragLeft ()\fC [virtual protected]\fR" +This function is called when a drag leaves the item's bounding rectangle. +.PP +The default implementation does nothing, subclasses may need to reimplement this function. +.SH "bool QListViewItem::dropEnabled () const" +Returns TRUE if this item accepts drops; otherwise returns FALSE. +.PP +See also setDropEnabled() and acceptDrop(). +.SH "void QListViewItem::dropped ( QDropEvent * e )\fC [virtual protected]\fR" +This function is called when something was dropped on the item. \fIe\fR contains all the information about the drop. +.PP +The default implementation does nothing, subclasses may need to reimplement this function. +.SH "void QListViewItem::enforceSortOrder () const\fC [virtual protected]\fR" +Makes sure that this object's children are sorted appropriately. +.PP +This only works if every item from the root item down to this item is already sorted. +.PP +See also sortChildItems(). +.SH "QListViewItem * QListViewItem::firstChild () const" +Returns the first (top) child of this item, or 0 if this item has no children. +.PP +Note that the children are not guaranteed to be sorted properly. QListView and QListViewItem try to postpone or avoid sorting to the greatest degree possible, in order to keep the user interface snappy. +.PP +See also nextSibling() and sortChildItems(). +.PP +Example: checklists/checklists.cpp. +.SH "int QListViewItem::height () const" +Returns the height of this item in pixels. This does not include the height of any children; totalHeight() returns that. +.SH "void QListViewItem::insertItem ( QListViewItem * newChild )\fC [virtual]\fR" +Inserts \fInewChild\fR into this list view item's list of children. You should not need to call this function; it is called automatically by the constructor of \fInewChild\fR. +.PP +\fBWarning:\fR If you are using \fCSingle\fR selection mode, then you should only insert unselected items. +.SH "void QListViewItem::invalidateHeight ()\fC [virtual]\fR" +Invalidates the cached total height of this item, including all open children. +.PP +See also setHeight(), height(), and totalHeight(). +.SH "bool QListViewItem::isEnabled () const" +Returns TRUE if this item is enabled; otherwise returns FALSE. +.PP +See also setEnabled(). +.SH "bool QListViewItem::isExpandable () const" +Returns TRUE if this item is expandable even when it has no children; otherwise returns FALSE. +.SH "bool QListViewItem::isOpen () const" +Returns TRUE if this list view item has children \fIand\fR they are not explicitly hidden; otherwise returns FALSE. +.PP +See also setOpen(). +.SH "bool QListViewItem::isSelectable () const" +Returns TRUE if the item is selectable (as it is by default); otherwise returns FALSE +.PP +See also setSelectable(). +.SH "bool QListViewItem::isSelected () const" +Returns TRUE if this item is selected; otherwise returns FALSE. +.PP +See also setSelected(), QListView::setSelected(), and QListView::selectionChanged(). +.PP +Example: listviews/listviews.cpp. +.SH "bool QListViewItem::isVisible () const" +Returns TRUE if the item is visible; otherwise returns FALSE. +.PP +See also setVisible(). +.SH "QListViewItem * QListViewItem::itemAbove ()" +Returns a pointer to the item immediately above this item on the screen. This is usually the item's closest older sibling, but it may also be its parent or its next older sibling's youngest child, or something else if anyoftheabove->height() returns 0. Returns 0 if there is no item immediately above this item. +.PP +This function assumes that all parents of this item are open (i.e. that this item is visible, or can be made visible by scrolling). +.PP +This function might be relatively slow because of the tree traversions needed to find the correct item. +.PP +See also itemBelow() and QListView::itemRect(). +.SH "QListViewItem * QListViewItem::itemBelow ()" +Returns a pointer to the item immediately below this item on the screen. This is usually the item's eldest child, but it may also be its next younger sibling, its parent's next younger sibling, grandparent's, etc., or something else if anyoftheabove->height() returns 0. Returns 0 if there is no item immediately below this item. +.PP +This function assumes that all parents of this item are open (i.e. that this item is visible or can be made visible by scrolling). +.PP +See also itemAbove() and QListView::itemRect(). +.PP +Example: dirview/dirview.cpp. +.SH "int QListViewItem::itemPos () const" +Returns the y coordinate of this item in the list view's coordinate system. This function is normally much slower than QListView::itemAt(), but it works for all items whereas QListView::itemAt() normally only works for items on the screen. +.PP +See also QListView::itemAt(), QListView::itemRect(), and QListView::itemPos(). +.SH "QString QListViewItem::key ( int column, bool ascending ) const\fC [virtual]\fR" +Returns a key that can be used for sorting by column \fIcolumn\fR. The default implementation returns text(). Derived classes may also incorporate the order indicated by \fIascending\fR into this key, although this is not recommended. +.PP +If you want to sort on non-alphabetical data, e.g. dates, numbers, etc., it is more efficient to reimplement compare(). +.PP +See also compare() and sortChildItems(). +.SH "QListView * QListViewItem::listView () const" +Returns a pointer to the list view containing this item. +.PP +Note that this function traverses the items to the root to find the listview. This function will return 0 for taken items - see QListViewItem::takeItem() +.SH "void QListViewItem::moveItem ( QListViewItem * after )" +Move the item to be after item \fIafter\fR, which must be one of the item's siblings. To move an item in the hierarchy, use takeItem() and insertItem(). +.PP +Note that this function will have no effect if sorting is enabled in the list view. +.SH "bool QListViewItem::multiLinesEnabled () const" +Returns TRUE if the item can display multiple lines of text in its columns; otherwise returns FALSE. +.SH "QListViewItem * QListViewItem::nextSibling () const" +Returns the sibling item below this item, or 0 if there is no sibling item after this item. +.PP +Note that the siblings are not guaranteed to be sorted properly. QListView and QListViewItem try to postpone or avoid sorting to the greatest degree possible, in order to keep the user interface snappy. +.PP +See also firstChild() and sortChildItems(). +.PP +Example: xml/tagreader-with-features/structureparser.cpp. +.SH "void QListViewItem::okRename ( int col )\fC [virtual protected]\fR" +This function is called if the user presses Enter during in-place renaming of the item in column \fIcol\fR. +.PP +See also cancelRename(). +.SH "void QListViewItem::paintBranches ( QPainter * p, const QColorGroup & cg, int w, int y, int h )\fC [virtual]\fR" +Paints a set of branches from this item to (some of) its children. +.PP +Painter \fIp\fR is set up with clipping and translation so that you can only draw in the rectangle that needs redrawing; \fIcg\fR is the color group to use; the update rectangle is at (0, 0) and has size width \fIw\fR by height \fIh\fR. The top of the rectangle you own is at \fIy\fR (which is never greater than 0 but can be outside the window system's allowed coordinate range). +.PP +The update rectangle is in an undefined state when this function is called; this function must draw on \fIall\fR of the pixels. +.PP +See also paintCell() and QListView::drawContentsOffset(). +.SH "void QListViewItem::paintCell ( QPainter * p, const QColorGroup & cg, int column, int width, int align )\fC [virtual]\fR" +This virtual function paints the contents of one column of an item and aligns it as described by \fIalign\fR. +.PP +\fIp\fR is a QPainter open on the relevant paint device. \fIp\fR is translated so (0, 0) is the top-left pixel in the cell and \fIwidth-1\fR, height()-1 is the bottom-right pixel \fIin\fR the cell. The other properties of \fIp\fR (pen, brush, etc) are undefined. \fIcg\fR is the color group to use. \fIcolumn\fR is the logical column number within the item that is to be painted; 0 is the column which may contain a tree. +.PP +This function may use QListView::itemMargin() for readability spacing on the left and right sides of data such as text, and should honor isSelected() and QListView::allColumnsShowFocus(). +.PP +If you reimplement this function, you should also reimplement width(). +.PP +The rectangle to be painted is in an undefined state when this function is called, so you \fImust\fR draw on all the pixels. The painter \fIp\fR has the right font on entry. +.PP +See also paintBranches() and QListView::drawContentsOffset(). +.PP +Example: listviews/listviews.cpp. +.PP +Reimplemented in QCheckListItem. +.SH "void QListViewItem::paintFocus ( QPainter * p, const QColorGroup & cg, const QRect & r )\fC [virtual]\fR" +Paints a focus indicator on the rectangle \fIr\fR using painter \fIp\fR and colors \fIcg\fR. +.PP +\fIp\fR is already clipped. +.PP +See also paintCell(), paintBranches(), and QListView::allColumnsShowFocus. +.PP +Reimplemented in QCheckListItem. +.SH "QListViewItem * QListViewItem::parent () const" +Returns the parent of this item, or 0 if this item has no parent. +.PP +See also firstChild() and nextSibling(). +.PP +Examples: +.)l dirview/dirview.cpp and qutlook/centralwidget.cpp. +.SH "const QPixmap * QListViewItem::pixmap ( int column ) const\fC [virtual]\fR" +Returns the pixmap for \fIcolumn\fR, or 0 if there is no pixmap for \fIcolumn\fR. +.PP +See also setText() and setPixmap(). +.PP +Example: dirview/dirview.cpp. +.SH "void QListViewItem::removeItem ( QListViewItem * item )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function has been renamed takeItem(). +.SH "bool QListViewItem::renameEnabled ( int col ) const" +Returns TRUE if this item can be in-place renamed in column \fIcol\fR; otherwise returns FALSE. +.SH "void QListViewItem::repaint () const" +Repaints this item on the screen if it is currently visible. +.PP +Example: addressbook/centralwidget.cpp. +.SH "int QListViewItem::rtti () const\fC [virtual]\fR" +Returns 0. +.PP +Make your derived classes return their own values for rtti(), so that you can distinguish between different kinds of list view items. You should use values greater than 1000 to allow for extensions to this class. +.PP +Reimplemented in QCheckListItem. +.SH "void QListViewItem::setDragEnabled ( bool allow )\fC [virtual]\fR" +If \fIallow\fR is TRUE, the list view starts a drag (see QListView::dragObject()) when the user presses and moves the mouse on this item. +.SH "void QListViewItem::setDropEnabled ( bool allow )\fC [virtual]\fR" +If \fIallow\fR is TRUE, the list view accepts drops onto the item; otherwise drops are not allowed. +.SH "void QListViewItem::setEnabled ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE the item is enabled; otherwise it is disabled. Disabled items are drawn differently (e.g. grayed-out) and are not accessible by the user. +.SH "void QListViewItem::setExpandable ( bool enable )\fC [virtual]\fR" +Sets this item to be expandable even if it has no children if \fIenable\fR is TRUE, and to be expandable only if it has children if \fIenable\fR is FALSE (the default). +.PP +The dirview example uses this in the canonical fashion. It checks whether the directory is empty in setup() and calls setExpandable(TRUE) if not; in setOpen() it reads the contents of the directory and inserts items accordingly. This strategy means that dirview can display the entire file system without reading very much at startup. +.PP +Note that root items are not expandable by the user unless QListView::setRootIsDecorated() is set to TRUE. +.PP +See also setSelectable(). +.SH "void QListViewItem::setHeight ( int height )\fC [virtual protected]\fR" +Sets this item's height to \fIheight\fR pixels. This implicitly changes totalHeight(), too. +.PP +Note that a font change causes this height to be overwritten unless you reimplement setup(). +.PP +For best results in Windows style we suggest using an even number of pixels. +.PP +See also height(), totalHeight(), and isOpen(). +.SH "void QListViewItem::setMultiLinesEnabled ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE each of the item's columns may contain multiple lines of text; otherwise each of them may only contain a single line. +.SH "void QListViewItem::setOpen ( bool o )\fC [virtual]\fR" +Opens or closes an item, i.e. shows or hides an item's children. +.PP +If \fIo\fR is TRUE all child items are shown initially. The user can hide them by clicking the \fB-\fR icon to the left of the item. If \fIo\fR is FALSE, the children of this item are initially hidden. The user can show them by clicking the \fB+\fR icon to the left of the item. +.PP +See also height(), totalHeight(), and isOpen(). +.PP +Examples: +.)l checklists/checklists.cpp, dirview/dirview.cpp, dirview/main.cpp, fileiconview/mainwindow.cpp, and xml/tagreader-with-features/structureparser.cpp. +.SH "void QListViewItem::setPixmap ( int column, const QPixmap & pm )\fC [virtual]\fR" +Sets the pixmap in column \fIcolumn\fR to \fIpm\fR, if \fIpm\fR is non-null and different from the current pixmap, and if \fIcolumn\fR is non-negative. +.PP +See also pixmap() and setText(). +.PP +Example: dirview/dirview.cpp. +.SH "void QListViewItem::setRenameEnabled ( int col, bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE, this item can be in-place renamed in the column \fIcol\fR by the user; otherwise it cannot be renamed in-place. +.SH "void QListViewItem::setSelectable ( bool enable )\fC [virtual]\fR" +Sets this item to be selectable if \fIenable\fR is TRUE (the default) or not to be selectable if \fIenable\fR is FALSE. +.PP +The user is not able to select a non-selectable item using either the keyboard or the mouse. This also applies for the application programmer (e.g. setSelected() respects this value). +.PP +See also isSelectable(). +.SH "void QListViewItem::setSelected ( bool s )\fC [virtual]\fR" +If \fIs\fR is TRUE this item is selected; otherwise it is deselected. +.PP +This function does not maintain any invariants or repaint anything -- QListView::setSelected() does that. +.PP +See also height() and totalHeight(). +.PP +Example: addressbook/centralwidget.cpp. +.SH "void QListViewItem::setText ( int column, const QString & text )\fC [virtual]\fR" +Sets the text in column \fIcolumn\fR to \fItext\fR, if \fIcolumn\fR is a valid column number and \fItext\fR is different from the existing text. +.PP +If \fItext()\fR has been reimplemented, this function may be a no-op. +.PP +See also text() and key(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, qutlook/centralwidget.cpp, and xml/outliner/outlinetree.cpp. +.SH "void QListViewItem::setVisible ( bool b )" +If \fIb\fR is TRUE, the item is made visible; otherwise it is hidden. +.PP +If the item is not visible, itemAbove() and itemBelow() will never return this item, although you still can reach it by using e.g. QListViewItemIterator. +.SH "void QListViewItem::setup ()\fC [virtual]\fR" +This virtual function is called before the first time QListView needs to know the height or any other graphical attribute of this object, and whenever the font, GUI style, or colors of the list view change. +.PP +The default calls widthChanged() and sets the item's height to the height of a single line of text in the list view's font. (If you use icons, multi-line text, etc., you will probably need to call setHeight() yourself or reimplement it.) +.PP +Example: dirview/dirview.cpp. +.SH "void QListViewItem::sort ()\fC [virtual]\fR" +Sorts all this item's child items using the current sorting configuration (sort column and direction). +.PP +See also enforceSortOrder(). +.SH "void QListViewItem::sortChildItems ( int column, bool ascending )\fC [virtual]\fR" +Sorts this item's children using column \fIcolumn\fR. This is done in ascending order if \fIascending\fR is TRUE and in descending order if \fIascending\fR is FALSE. +.PP +Asks some of the children to sort their children. (QListView and QListViewItem ensure that all on-screen objects are properly sorted but may avoid or defer sorting other objects in order to be more responsive.) +.PP +See also key() and compare(). +.SH "void QListViewItem::startRename ( int col )\fC [virtual]\fR" +If in-place renaming of this item is enabled (see renameEnabled()), this function starts renaming the item in column \fIcol\fR, by creating and initializing an edit box. +.SH "void QListViewItem::takeItem ( QListViewItem * item )\fC [virtual]\fR" +Removes \fIitem\fR from this object's list of children and causes an update of the screen display. The item is not deleted. You should not normally need to call this function because QListViewItem::~QListViewItem() calls it. +.PP +The normal way to delete an item is to use \fCdelete\fR. +.PP +If you need to move an item from one place in the hierarchy to another you can use takeItem() to remove the item from the list view and then insertItem() to put the item back in its new position. +.PP +If a taken item is part of a selection in \fCSingle\fR selection mode, it is unselected and selectionChanged() is emitted. If a taken item is part of a selection in \fCMulti\fR or \fCExtended\fR selection mode, it remains selected. +.PP +\fBWarning:\fR This function leaves \fIitem\fR and its children in a state where most member functions are unsafe. Only a few functions work correctly on an item in this state, most notably insertItem(). The functions that work on taken items are explicitly documented as such. +.PP +See also QListViewItem::insertItem(). +.SH "QString QListViewItem::text ( int column ) const\fC [virtual]\fR" +Returns the text in column \fIcolumn\fR, or QString::null if there is no text in that column. +.PP +See also key() and paintCell(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, dirview/dirview.cpp, network/archivesearch/archivedialog.ui.h, and network/ftpclient/ftpmainwindow.ui.h. +.SH "int QListViewItem::totalHeight () const" +Returns the total height of this object, including any visible children. This height is recomputed lazily and cached for as long as possible. +.PP +Functions which can affect the total height are, setHeight() which is used to set an item's height, setOpen() to show or hide an item's children, and invalidateHeight() to invalidate the cached height. +.PP +See also height(). +.SH "int QListViewItem::width ( const QFontMetrics & fm, const QListView * lv, int c ) const\fC [virtual]\fR" +Returns the number of pixels of width required to draw column \fIc\fR of list view \fIlv\fR, using the metrics \fIfm\fR without cropping. The list view containing this item may use this information depending on the QListView::WidthMode settings for the column. +.PP +The default implementation returns the width of the bounding rectangle of the text of column \fIc\fR. +.PP +See also listView(), widthChanged(), QListView::setColumnWidthMode(), and QListView::itemMargin. +.SH "void QListViewItem::widthChanged ( int c = -1 ) const" +Call this function when the value of width() may have changed for column \fIc\fR. Normally, you should call this if text(c) changes. Passing -1 for \fIc\fR indicates that all columns may have changed. It is more efficient to pass -1 if two or more columns have changed than to call widthChanged() separately for each one. +.PP +See also width(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qlistviewitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlistviewitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlistviewitemiterator.3qt b/doc/man/man3/tqlistviewitemiterator.3qt new file mode 100644 index 000000000..672564007 --- /dev/null +++ b/doc/man/man3/tqlistviewitemiterator.3qt @@ -0,0 +1,218 @@ +'\" t +.TH QListViewItemIterator 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 +QListViewItemIterator \- Iterator for collections of QListViewItems +.SH SYNOPSIS +\fC#include <ntqlistview.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBIteratorFlag\fR { Visible = 0x00000001, Invisible = 0x00000002, Selected = 0x00000004, Unselected = 0x00000008, Selectable = 0x00000010, NotSelectable = 0x00000020, DragEnabled = 0x00000040, DragDisabled = 0x00000080, DropEnabled = 0x00000100, DropDisabled = 0x00000200, Expandable = 0x00000400, NotExpandable = 0x00000800, Checked = 0x00001000, NotChecked = 0x00002000 }" +.br +.ti -1c +.BI "\fBQListViewItemIterator\fR ()" +.br +.ti -1c +.BI "\fBQListViewItemIterator\fR ( QListViewItem * item )" +.br +.ti -1c +.BI "\fBQListViewItemIterator\fR ( QListViewItem * item, int iteratorFlags )" +.br +.ti -1c +.BI "\fBQListViewItemIterator\fR ( const QListViewItemIterator & it )" +.br +.ti -1c +.BI "\fBQListViewItemIterator\fR ( QListView * lv )" +.br +.ti -1c +.BI "\fBQListViewItemIterator\fR ( QListView * lv, int iteratorFlags )" +.br +.ti -1c +.BI "QListViewItemIterator & \fBoperator=\fR ( const QListViewItemIterator & it )" +.br +.ti -1c +.BI "\fB~QListViewItemIterator\fR ()" +.br +.ti -1c +.BI "QListViewItemIterator & \fBoperator++\fR ()" +.br +.ti -1c +.BI "const QListViewItemIterator \fBoperator++\fR ( int )" +.br +.ti -1c +.BI "QListViewItemIterator & \fBoperator+=\fR ( int j )" +.br +.ti -1c +.BI "QListViewItemIterator & \fBoperator--\fR ()" +.br +.ti -1c +.BI "const QListViewItemIterator \fBoperator--\fR ( int )" +.br +.ti -1c +.BI "QListViewItemIterator & \fBoperator-=\fR ( int j )" +.br +.ti -1c +.BI "QListViewItem * \fBoperator*\fR ()" +.br +.ti -1c +.BI "QListViewItem * \fBcurrent\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QListViewItemIterator class provides an iterator for collections of QListViewItems. +.PP +Construct an instance of a QListViewItemIterator, with either a QListView* or a QListViewItem* as argument, to operate on the tree of QListViewItems, starting from the argument. +.PP +A QListViewItemIterator iterates over all the items from its starting point. This means that it always makes the first child of the current item the new current item. If there is no child, the next sibling becomes the new current item; and if there is no next sibling, the next sibling of the parent becomes current. +.PP +The following example creates a list of all the items that have been selected by the user, storing pointers to the items in a QPtrList: +.PP +.nf +.br + QPtrList<QListViewItem> lst; +.br + QListViewItemIterator it( myListView ); +.br + while ( it.current() ) { +.br + if ( it.current()->isSelected() ) +.br + lst.append( it.current() ); +.br + ++it; +.br + } +.br +.fi +.PP +An alternative approach is to use an IteratorFlag: +.PP +.nf +.br + QPtrList<QListViewItem> lst; +.br + QListViewItemIterator it( myListView, QListViewItemIterator::Selected ); +.br + while ( it.current() ) { +.br + lst.append( it.current() ); +.br + ++it; +.br + } +.br +.fi +.PP +A QListViewItemIterator provides a convenient and easy way to traverse a hierarchical QListView. +.PP +Multiple QListViewItemIterators can operate on the tree of QListViewItems. A QListView knows about all iterators operating on its QListViewItems. So when a QListViewItem gets removed all iterators that point to this item are updated and point to the following item if possible, otherwise to a valid item before the current one or to 0. Note however that deleting the parent item of an item that an iterator points to is not safe. +.PP +See also QListView, QListViewItem, and Advanced Widgets. +.SS "Member Type Documentation" +.SH "QListViewItemIterator::IteratorFlag" +These flags can be passed to a QListViewItemIterator constructor (OR-ed together if more than one is used), so that the iterator will only iterate over items that match the given flags. +.TP +\fCQListViewItemIterator::Visible\fR +.TP +\fCQListViewItemIterator::Invisible\fR +.TP +\fCQListViewItemIterator::Selected\fR +.TP +\fCQListViewItemIterator::Unselected\fR +.TP +\fCQListViewItemIterator::Selectable\fR +.TP +\fCQListViewItemIterator::NotSelectable\fR +.TP +\fCQListViewItemIterator::DragEnabled\fR +.TP +\fCQListViewItemIterator::DragDisabled\fR +.TP +\fCQListViewItemIterator::DropEnabled\fR +.TP +\fCQListViewItemIterator::DropDisabled\fR +.TP +\fCQListViewItemIterator::Expandable\fR +.TP +\fCQListViewItemIterator::NotExpandable\fR +.TP +\fCQListViewItemIterator::Checked\fR +.TP +\fCQListViewItemIterator::NotChecked\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QListViewItemIterator::QListViewItemIterator ()" +Constructs an empty iterator. +.SH "QListViewItemIterator::QListViewItemIterator ( QListViewItem * item )" +Constructs an iterator for the QListView that contains the \fIitem\fR. The current iterator item is set to point to the \fIitem\fR. +.SH "QListViewItemIterator::QListViewItemIterator ( QListViewItem * item, int iteratorFlags )" +Constructs an iterator for the QListView that contains the \fIitem\fR using the flags \fIiteratorFlags\fR. The current iterator item is set to point to \fIitem\fR or the next matching item if \fIitem\fR doesn't match the flags. +.PP +See also QListViewItemIterator::IteratorFlag. +.SH "QListViewItemIterator::QListViewItemIterator ( const QListViewItemIterator & it )" +Constructs an iterator for the same QListView as \fIit\fR. The current iterator item is set to point on the current item of \fIit\fR. +.SH "QListViewItemIterator::QListViewItemIterator ( QListView * lv )" +Constructs an iterator for the QListView \fIlv\fR. The current iterator item is set to point on the first child (QListViewItem) of \fIlv\fR. +.SH "QListViewItemIterator::QListViewItemIterator ( QListView * lv, int iteratorFlags )" +Constructs an iterator for the QListView \fIlv\fR with the flags \fIiteratorFlags\fR. The current iterator item is set to point on the first child (QListViewItem) of \fIlv\fR that matches the flags. +.PP +See also QListViewItemIterator::IteratorFlag. +.SH "QListViewItemIterator::~QListViewItemIterator ()" +Destroys the iterator. +.SH "QListViewItem * QListViewItemIterator::current () const" +Returns iterator's current item. +.PP +Examples: +.)l addressbook/centralwidget.cpp, checklists/checklists.cpp, and dirview/dirview.cpp. +.SH "QListViewItem * QListViewItemIterator::operator* ()" +Dereference operator. Returns a reference to the current item. The same as current(). +.SH "QListViewItemIterator & QListViewItemIterator::operator++ ()" +Prefix ++. Makes the next item the new current item and returns it. Returns 0 if the current item is the last item or the QListView is 0. +.SH "const QListViewItemIterator QListViewItemIterator::operator++ ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix ++. Makes the next item the new current item and returns the item that \fIwas\fR the current item. +.SH "QListViewItemIterator & QListViewItemIterator::operator+= ( int j )" +Sets the current item to the item \fIj\fR positions after the current item. If that item is beyond the last item, the current item is set to 0. Returns the current item. +.SH "QListViewItemIterator & QListViewItemIterator::operator-- ()" +Prefix --. Makes the previous item the new current item and returns it. Returns 0 if the current item is the first item or the QListView is 0. +.SH "const QListViewItemIterator QListViewItemIterator::operator-- ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix --. Makes the previous item the new current item and returns the item that \fIwas\fR the current item. +.SH "QListViewItemIterator & QListViewItemIterator::operator-= ( int j )" +Sets the current item to the item \fIj\fR positions before the current item. If that item is before the first item, the current item is set to 0. Returns the current item. +.SH "QListViewItemIterator & QListViewItemIterator::operator= ( const QListViewItemIterator & it )" +Assignment. Makes a copy of \fIit\fR and returns a reference to its +iterator. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qlistviewitemiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlistviewitemiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlocale.3qt b/doc/man/man3/tqlocale.3qt new file mode 100644 index 000000000..d3654afa4 --- /dev/null +++ b/doc/man/man3/tqlocale.3qt @@ -0,0 +1,1249 @@ +'\" t +.TH QLocale 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 +QLocale \- Converts between numbers and their string representations in various languages +.SH SYNOPSIS +Almost all the functions in this class are reentrant when Qt is built with thread support. The exception is \fBsetDefault\fR(). </p> +.PP +\fC#include <ntqlocale.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBLanguage\fR { C = 1, Abkhazian = 2, Afan = 3, Afar = 4, Afrikaans = 5, Albanian = 6, Amharic = 7, Arabic = 8, Armenian = 9, Assamese = 10, Aymara = 11, Azerbaijani = 12, Bashkir = 13, Basque = 14, Bengali = 15, Bhutani = 16, Bihari = 17, Bislama = 18, Breton = 19, Bulgarian = 20, Burmese = 21, Byelorussian = 22, Cambodian = 23, Catalan = 24, Chinese = 25, Corsican = 26, Croatian = 27, Czech = 28, Danish = 29, Dutch = 30, English = 31, Esperanto = 32, Estonian = 33, Faroese = 34, FijiLanguage = 35, Finnish = 36, French = 37, Frisian = 38, Gaelic = 39, Galician = 40, Georgian = 41, German = 42, Greek = 43, Greenlandic = 44, Guarani = 45, Gujarati = 46, Hausa = 47, Hebrew = 48, Hindi = 49, Hungarian = 50, Icelandic = 51, Indonesian = 52, Interlingua = 53, Interlingue = 54, Inuktitut = 55, Inupiak = 56, Irish = 57, Italian = 58, Japanese = 59, Javanese = 60, Kannada = 61, Kashmiri = 62, Kazakh = 63, Kinyarwanda = 64, Kirghiz = 65, Korean = 66, Kurdish = 67, Kurundi = 68, Laothian = 69, Latin = 70, Latvian = 71, Lingala = 72, Lithuanian = 73, Macedonian = 74, Malagasy = 75, Malay = 76, Malayalam = 77, Maltese = 78, Maori = 79, Marathi = 80, Moldavian = 81, Mongolian = 82, NauruLanguage = 83, Nepali = 84, Norwegian = 85, Occitan = 86, Oriya = 87, Pashto = 88, Persian = 89, Polish = 90, Portuguese = 91, Punjabi = 92, Quechua = 93, RhaetoRomance = 94, Romanian = 95, Russian = 96, Samoan = 97, Sangho = 98, Sanskrit = 99, Serbian = 100, SerboCroatian = 101, Sesotho = 102, Setswana = 103, Shona = 104, Sindhi = 105, Singhalese = 106, Siswati = 107, Slovak = 108, Slovenian = 109, Somali = 110, Spanish = 111, Sundanese = 112, Swahili = 113, Swedish = 114, Tagalog = 115, Tajik = 116, Tamil = 117, Tatar = 118, Telugu = 119, Thai = 120, Tibetan = 121, Tigrinya = 122, TongaLanguage = 123, Tsonga = 124, Turkish = 125, Turkmen = 126, Twi = 127, Uigur = 128, Ukrainian = 129, Urdu = 130, Uzbek = 131, Vietnamese = 132, Volapuk = 133, Welsh = 134, Wolof = 135, Xhosa = 136, Yiddish = 137, Yoruba = 138, Zhuang = 139, Zulu = 140, LastLanguage = Zulu }" +.br +.ti -1c +.BI "enum \fBCountry\fR { AnyCountry = 0, Afghanistan = 1, Albania = 2, Algeria = 3, AmericanSamoa = 4, Andorra = 5, Angola = 6, Anguilla = 7, Antarctica = 8, AntiguaAndBarbuda = 9, Argentina = 10, Armenia = 11, Aruba = 12, Australia = 13, Austria = 14, Azerbaijan = 15, Bahamas = 16, Bahrain = 17, Bangladesh = 18, Barbados = 19, Belarus = 20, Belgium = 21, Belize = 22, Benin = 23, Bermuda = 24, Bhutan = 25, Bolivia = 26, BosniaAndHerzegowina = 27, Botswana = 28, BouvetIsland = 29, Brazil = 30, BritishIndianOceanTerritory = 31, BruneiDarussalam = 32, Bulgaria = 33, BurkinaFaso = 34, Burundi = 35, Cambodia = 36, Cameroon = 37, Canada = 38, CapeVerde = 39, CaymanIslands = 40, CentralAfricanRepublic = 41, Chad = 42, Chile = 43, China = 44, ChristmasIsland = 45, CocosIslands = 46, Colombia = 47, Comoros = 48, DemocraticRepublicOfCongo = 49, PeoplesRepublicOfCongo = 50, CookIslands = 51, CostaRica = 52, IvoryCoast = 53, Croatia = 54, Cuba = 55, Cyprus = 56, CzechRepublic = 57, Denmark = 58, Djibouti = 59, Dominica = 60, DominicanRepublic = 61, EastTimor = 62, Ecuador = 63, Egypt = 64, ElSalvador = 65, EquatorialGuinea = 66, Eritrea = 67, Estonia = 68, Ethiopia = 69, FalklandIslands = 70, FaroeIslands = 71, FijiCountry = 72, Finland = 73, France = 74, MetropolitanFrance = 75, FrenchGuiana = 76, FrenchPolynesia = 77, FrenchSouthernTerritories = 78, Gabon = 79, Gambia = 80, Georgia = 81, Germany = 82, Ghana = 83, Gibraltar = 84, Greece = 85, Greenland = 86, Grenada = 87, Guadeloupe = 88, Guam = 89, Guatemala = 90, Guinea = 91, GuineaBissau = 92, Guyana = 93, Haiti = 94, HeardAndMcDonaldIslands = 95, Honduras = 96, HongKong = 97, Hungary = 98, Iceland = 99, India = 100, Indonesia = 101, Iran = 102, Iraq = 103, Ireland = 104, Israel = 105, Italy = 106, Jamaica = 107, Japan = 108, Jordan = 109, Kazakhstan = 110, Kenya = 111, Kiribati = 112, DemocraticRepublicOfKorea = 113, RepublicOfKorea = 114, Kuwait = 115, Kyrgyzstan = 116, Lao = 117, Latvia = 118, Lebanon = 119, Lesotho = 120, Liberia = 121, LibyanArabJamahiriya = 122, Liechtenstein = 123, Lithuania = 124, Luxembourg = 125, Macau = 126, Macedonia = 127, Madagascar = 128, Malawi = 129, Malaysia = 130, Maldives = 131, Mali = 132, Malta = 133, MarshallIslands = 134, Martinique = 135, Mauritania = 136, Mauritius = 137, Mayotte = 138, Mexico = 139, Micronesia = 140, Moldova = 141, Monaco = 142, Mongolia = 143, Montserrat = 144, Morocco = 145, Mozambique = 146, Myanmar = 147, Namibia = 148, NauruCountry = 149, Nepal = 150, Netherlands = 151, NetherlandsAntilles = 152, NewCaledonia = 153, NewZealand = 154, Nicaragua = 155, Niger = 156, Nigeria = 157, Niue = 158, NorfolkIsland = 159, NorthernMarianaIslands = 160, Norway = 161, Oman = 162, Pakistan = 163, Palau = 164, PalestinianTerritory = 165, Panama = 166, PapuaNewGuinea = 167, Paraguay = 168, Peru = 169, Philippines = 170, Pitcairn = 171, Poland = 172, Portugal = 173, PuertoRico = 174, Qatar = 175, Reunion = 176, Romania = 177, RussianFederation = 178, Rwanda = 179, SaintKittsAndNevis = 180, StLucia = 181, StVincentAndTheGrenadines = 182, Samoa = 183, SanMarino = 184, SaoTomeAndPrincipe = 185, SaudiArabia = 186, Senegal = 187, Seychelles = 188, SierraLeone = 189, Singapore = 190, Slovakia = 191, Slovenia = 192, SolomonIslands = 193, Somalia = 194, SouthAfrica = 195, SouthGeorgiaAndTheSouthSandwichIslands = 196, Spain = 197, SriLanka = 198, StHelena = 199, StPierreAndMiquelon = 200, Sudan = 201, Suriname = 202, SvalbardAndJanMayenIslands = 203, Swaziland = 204, Sweden = 205, Switzerland = 206, SyrianArabRepublic = 207, Taiwan = 208, Tajikistan = 209, Tanzania = 210, Thailand = 211, Togo = 212, Tokelau = 213, TongaCountry = 214, TrinidadAndTobago = 215, Tunisia = 216, Turkey = 217, Turkmenistan = 218, TurksAndCaicosIslands = 219, Tuvalu = 220, Uganda = 221, Ukraine = 222, UnitedArabEmirates = 223, UnitedKingdom = 224, UnitedStates = 225, UnitedStatesMinorOutlyingIslands = 226, Uruguay = 227, Uzbekistan = 228, Vanuatu = 229, VaticanCityState = 230, Venezuela = 231, VietNam = 232, BritishVirginIslands = 233, USVirginIslands = 234, WallisAndFutunaIslands = 235, WesternSahara = 236, Yemen = 237, Yugoslavia = 238, Zambia = 239, Zimbabwe = 240, LastCountry = Zimbabwe }" +.br +.ti -1c +.BI "\fBQLocale\fR ()" +.br +.ti -1c +.BI "\fBQLocale\fR ( const QString & name )" +.br +.ti -1c +.BI "\fBQLocale\fR ( Language language, Country country = AnyCountry )" +.br +.ti -1c +.BI "\fBQLocale\fR ( const QLocale & other )" +.br +.ti -1c +.BI "QLocale & \fBoperator=\fR ( const QLocale & other )" +.br +.ti -1c +.BI "Language \fBlanguage\fR () const" +.br +.ti -1c +.BI "Country \fBcountry\fR () const" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "short \fBtoShort\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "ushort \fBtoUShort\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "int \fBtoInt\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "uint \fBtoUInt\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "TQ_LONG \fBtoLong\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "TQ_ULONG \fBtoULong\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "TQ_LLONG \fBtoLongLong\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "TQ_ULLONG \fBtoULongLong\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "float \fBtoFloat\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "double \fBtoDouble\fR ( const QString & s, bool * ok = 0 ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( short i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( ushort i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( int i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( uint i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( TQ_LONG i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( TQ_ULONG i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( TQ_LLONG i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( TQ_ULLONG i ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( float i, char f = 'g', int prec = 6 ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( double i, char f = 'g', int prec = 6 ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBlanguageToString\fR ( Language language )" +.br +.ti -1c +.BI "QString \fBcountryToString\fR ( Country country )" +.br +.ti -1c +.BI "void \fBsetDefault\fR ( const QLocale & locale )" +.br +.ti -1c +.BI "QLocale \fBc\fR ()" +.br +.ti -1c +.BI "QLocale \fBsystem\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QLocale class converts between numbers and their string representations in various languages. +.PP +It is initialized with a country/language pair in its constructor and offers number-to-string and string-to-number conversion functions simmilar to those in QString. +.PP +.nf +.br + QLocale egyptian(QLocale::Arabic, QLocale::Egypt); +.br + QString s1 = egyptian.toString(1.571429E+07, 'e'); +.br + QString s2 = egyptian.toString(10); +.br +.br + double d = egyptian.toDouble(s1); +.br + int s2 = egyptian.toInt(s2); +.br +.fi +.PP +QLocale supports the concept of a default locale, which is determined from the system's locale settings at application startup. The default locale can be changed by calling the static member setDefault(). The default locale has the following effects: +.TP +If a QLocale object is constructed with the default constructor, it will use the default locale's settings. +.TP +QString::toDouble() interprets the string according to the default locale. If this fails, it falls back on the "C" locale. +.TP +QString::arg() uses the default locale to format a number when its position specifier in the format string contains an 'L', e.g. "%L1". +.PP +.nf +.br + QLocale::setDefault(QLocale(QLocale::Hebrew, QLocale::Israel)); +.br + QLocale hebrew; // Constructs a default QLocale +.br + QString s1 = hebrew.toString(15714.3, 'e'); +.br +.br + bool ok; +.br + double d; +.br +.br + QLocale::setDefault(QLocale::C); +.br + d = QString( "1234,56" ).toDouble(&ok); // ok == false +.br + d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 +.br +.br + QLocale::setDefault(QLocale::German); +.br + d = QString( "1234,56" ).toDouble(&ok); // ok == true, d == 1234.56 +.br + d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 +.br +.br + QLocale::setDefault(QLocale(QLocale::English, QLocale::UnitedStates)); +.br + str = QString( "%1 %L2 %L3" ) +.br + .arg( 12345 ) +.br + .arg( 12345 ) +.br + .arg( 12345, 0, 16 ); +.br + // str == "12345 12,345 3039" +.br +.fi +.PP +When a language/country pair is specified in the constructor, one of three things can happen: +.TP +If the language/country pair is found in the database, it is used. +.TP +If the language is found but the country is not, or if the country is AnyCountry, the language is used with the most appropriate available country (for example, Germany for German), +.TP +If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()). +.PP +The "C" locale is identical to English/UnitedStates. +.PP +Use language() and country() to determine the actual language and country values used. +.PP +An alternative method for constructing a QLocale object is by specifying the locale name. +.PP +.nf +.br + QLocale korean("ko"); +.br + QLocale swiss("de_CH"); +.br +.fi +.PP +This constructor converts the locale name to a language/country pair; it does not use the system locale database. +.PP +All the methods in QLocale, with the exception of setDefault(), are reentrant. +.PP +See also QString::toDouble(), QString::arg(), and Text Related Classes. +.PP +The double-to-string and string-to-double conversion functions are covered by the following licenses: +.PP +Copyright (c) 1991 by AT&T. +.PP +Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software. +.PP +THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR AT&T MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE. +.PP +This product includes software developed by the University of California, Berkeley and its contributors. +.SS "Member Type Documentation" +.SH "QLocale::Country" +This enumerated type is used to specify a country. +.TP +\fCQLocale::AnyCountry\fR +.TP +\fCQLocale::Afghanistan\fR +.TP +\fCQLocale::Albania\fR +.TP +\fCQLocale::Algeria\fR +.TP +\fCQLocale::AmericanSamoa\fR +.TP +\fCQLocale::Andorra\fR +.TP +\fCQLocale::Angola\fR +.TP +\fCQLocale::Anguilla\fR +.TP +\fCQLocale::Antarctica\fR +.TP +\fCQLocale::AntiguaAndBarbuda\fR +.TP +\fCQLocale::Argentina\fR +.TP +\fCQLocale::Armenia\fR +.TP +\fCQLocale::Aruba\fR +.TP +\fCQLocale::Australia\fR +.TP +\fCQLocale::Austria\fR +.TP +\fCQLocale::Azerbaijan\fR +.TP +\fCQLocale::Bahamas\fR +.TP +\fCQLocale::Bahrain\fR +.TP +\fCQLocale::Bangladesh\fR +.TP +\fCQLocale::Barbados\fR +.TP +\fCQLocale::Belarus\fR +.TP +\fCQLocale::Belgium\fR +.TP +\fCQLocale::Belize\fR +.TP +\fCQLocale::Benin\fR +.TP +\fCQLocale::Bermuda\fR +.TP +\fCQLocale::Bhutan\fR +.TP +\fCQLocale::Bolivia\fR +.TP +\fCQLocale::BosniaAndHerzegowina\fR +.TP +\fCQLocale::Botswana\fR +.TP +\fCQLocale::BouvetIsland\fR +.TP +\fCQLocale::Brazil\fR +.TP +\fCQLocale::BritishIndianOceanTerritory\fR +.TP +\fCQLocale::BruneiDarussalam\fR +.TP +\fCQLocale::Bulgaria\fR +.TP +\fCQLocale::BurkinaFaso\fR +.TP +\fCQLocale::Burundi\fR +.TP +\fCQLocale::Cambodia\fR +.TP +\fCQLocale::Cameroon\fR +.TP +\fCQLocale::Canada\fR +.TP +\fCQLocale::CapeVerde\fR +.TP +\fCQLocale::CaymanIslands\fR +.TP +\fCQLocale::CentralAfricanRepublic\fR +.TP +\fCQLocale::Chad\fR +.TP +\fCQLocale::Chile\fR +.TP +\fCQLocale::China\fR +.TP +\fCQLocale::ChristmasIsland\fR +.TP +\fCQLocale::CocosIslands\fR +.TP +\fCQLocale::Colombia\fR +.TP +\fCQLocale::Comoros\fR +.TP +\fCQLocale::DemocraticRepublicOfCongo\fR +.TP +\fCQLocale::PeoplesRepublicOfCongo\fR +.TP +\fCQLocale::CookIslands\fR +.TP +\fCQLocale::CostaRica\fR +.TP +\fCQLocale::IvoryCoast\fR +.TP +\fCQLocale::Croatia\fR +.TP +\fCQLocale::Cuba\fR +.TP +\fCQLocale::Cyprus\fR +.TP +\fCQLocale::CzechRepublic\fR +.TP +\fCQLocale::Denmark\fR +.TP +\fCQLocale::Djibouti\fR +.TP +\fCQLocale::Dominica\fR +.TP +\fCQLocale::DominicanRepublic\fR +.TP +\fCQLocale::EastTimor\fR +.TP +\fCQLocale::Ecuador\fR +.TP +\fCQLocale::Egypt\fR +.TP +\fCQLocale::ElSalvador\fR +.TP +\fCQLocale::EquatorialGuinea\fR +.TP +\fCQLocale::Eritrea\fR +.TP +\fCQLocale::Estonia\fR +.TP +\fCQLocale::Ethiopia\fR +.TP +\fCQLocale::FalklandIslands\fR +.TP +\fCQLocale::FaroeIslands\fR +.TP +\fCQLocale::FijiCountry\fR +.TP +\fCQLocale::Finland\fR +.TP +\fCQLocale::France\fR +.TP +\fCQLocale::MetropolitanFrance\fR +.TP +\fCQLocale::FrenchGuiana\fR +.TP +\fCQLocale::FrenchPolynesia\fR +.TP +\fCQLocale::FrenchSouthernTerritories\fR +.TP +\fCQLocale::Gabon\fR +.TP +\fCQLocale::Gambia\fR +.TP +\fCQLocale::Georgia\fR +.TP +\fCQLocale::Germany\fR +.TP +\fCQLocale::Ghana\fR +.TP +\fCQLocale::Gibraltar\fR +.TP +\fCQLocale::Greece\fR +.TP +\fCQLocale::Greenland\fR +.TP +\fCQLocale::Grenada\fR +.TP +\fCQLocale::Guadeloupe\fR +.TP +\fCQLocale::Guam\fR +.TP +\fCQLocale::Guatemala\fR +.TP +\fCQLocale::Guinea\fR +.TP +\fCQLocale::GuineaBissau\fR +.TP +\fCQLocale::Guyana\fR +.TP +\fCQLocale::Haiti\fR +.TP +\fCQLocale::HeardAndMcDonaldIslands\fR +.TP +\fCQLocale::Honduras\fR +.TP +\fCQLocale::HongKong\fR +.TP +\fCQLocale::Hungary\fR +.TP +\fCQLocale::Iceland\fR +.TP +\fCQLocale::India\fR +.TP +\fCQLocale::Indonesia\fR +.TP +\fCQLocale::Iran\fR +.TP +\fCQLocale::Iraq\fR +.TP +\fCQLocale::Ireland\fR +.TP +\fCQLocale::Israel\fR +.TP +\fCQLocale::Italy\fR +.TP +\fCQLocale::Jamaica\fR +.TP +\fCQLocale::Japan\fR +.TP +\fCQLocale::Jordan\fR +.TP +\fCQLocale::Kazakhstan\fR +.TP +\fCQLocale::Kenya\fR +.TP +\fCQLocale::Kiribati\fR +.TP +\fCQLocale::DemocraticRepublicOfKorea\fR +.TP +\fCQLocale::RepublicOfKorea\fR +.TP +\fCQLocale::Kuwait\fR +.TP +\fCQLocale::Kyrgyzstan\fR +.TP +\fCQLocale::Lao\fR +.TP +\fCQLocale::Latvia\fR +.TP +\fCQLocale::Lebanon\fR +.TP +\fCQLocale::Lesotho\fR +.TP +\fCQLocale::Liberia\fR +.TP +\fCQLocale::LibyanArabJamahiriya\fR +.TP +\fCQLocale::Liechtenstein\fR +.TP +\fCQLocale::Lithuania\fR +.TP +\fCQLocale::Luxembourg\fR +.TP +\fCQLocale::Macau\fR +.TP +\fCQLocale::Macedonia\fR +.TP +\fCQLocale::Madagascar\fR +.TP +\fCQLocale::Malawi\fR +.TP +\fCQLocale::Malaysia\fR +.TP +\fCQLocale::Maldives\fR +.TP +\fCQLocale::Mali\fR +.TP +\fCQLocale::Malta\fR +.TP +\fCQLocale::MarshallIslands\fR +.TP +\fCQLocale::Martinique\fR +.TP +\fCQLocale::Mauritania\fR +.TP +\fCQLocale::Mauritius\fR +.TP +\fCQLocale::Mayotte\fR +.TP +\fCQLocale::Mexico\fR +.TP +\fCQLocale::Micronesia\fR +.TP +\fCQLocale::Moldova\fR +.TP +\fCQLocale::Monaco\fR +.TP +\fCQLocale::Mongolia\fR +.TP +\fCQLocale::Montserrat\fR +.TP +\fCQLocale::Morocco\fR +.TP +\fCQLocale::Mozambique\fR +.TP +\fCQLocale::Myanmar\fR +.TP +\fCQLocale::Namibia\fR +.TP +\fCQLocale::NauruCountry\fR +.TP +\fCQLocale::Nepal\fR +.TP +\fCQLocale::Netherlands\fR +.TP +\fCQLocale::NetherlandsAntilles\fR +.TP +\fCQLocale::NewCaledonia\fR +.TP +\fCQLocale::NewZealand\fR +.TP +\fCQLocale::Nicaragua\fR +.TP +\fCQLocale::Niger\fR +.TP +\fCQLocale::Nigeria\fR +.TP +\fCQLocale::Niue\fR +.TP +\fCQLocale::NorfolkIsland\fR +.TP +\fCQLocale::NorthernMarianaIslands\fR +.TP +\fCQLocale::Norway\fR +.TP +\fCQLocale::Oman\fR +.TP +\fCQLocale::Pakistan\fR +.TP +\fCQLocale::Palau\fR +.TP +\fCQLocale::PalestinianTerritory\fR +.TP +\fCQLocale::Panama\fR +.TP +\fCQLocale::PapuaNewGuinea\fR +.TP +\fCQLocale::Paraguay\fR +.TP +\fCQLocale::Peru\fR +.TP +\fCQLocale::Philippines\fR +.TP +\fCQLocale::Pitcairn\fR +.TP +\fCQLocale::Poland\fR +.TP +\fCQLocale::Portugal\fR +.TP +\fCQLocale::PuertoRico\fR +.TP +\fCQLocale::Qatar\fR +.TP +\fCQLocale::Reunion\fR +.TP +\fCQLocale::Romania\fR +.TP +\fCQLocale::RussianFederation\fR +.TP +\fCQLocale::Rwanda\fR +.TP +\fCQLocale::SaintKittsAndNevis\fR +.TP +\fCQLocale::StLucia\fR +.TP +\fCQLocale::StVincentAndTheGrenadines\fR +.TP +\fCQLocale::Samoa\fR +.TP +\fCQLocale::SanMarino\fR +.TP +\fCQLocale::SaoTomeAndPrincipe\fR +.TP +\fCQLocale::SaudiArabia\fR +.TP +\fCQLocale::Senegal\fR +.TP +\fCQLocale::Seychelles\fR +.TP +\fCQLocale::SierraLeone\fR +.TP +\fCQLocale::Singapore\fR +.TP +\fCQLocale::Slovakia\fR +.TP +\fCQLocale::Slovenia\fR +.TP +\fCQLocale::SolomonIslands\fR +.TP +\fCQLocale::Somalia\fR +.TP +\fCQLocale::SouthAfrica\fR +.TP +\fCQLocale::SouthGeorgiaAndTheSouthSandwichIslands\fR +.TP +\fCQLocale::Spain\fR +.TP +\fCQLocale::SriLanka\fR +.TP +\fCQLocale::StHelena\fR +.TP +\fCQLocale::StPierreAndMiquelon\fR +.TP +\fCQLocale::Sudan\fR +.TP +\fCQLocale::Suriname\fR +.TP +\fCQLocale::SvalbardAndJanMayenIslands\fR +.TP +\fCQLocale::Swaziland\fR +.TP +\fCQLocale::Sweden\fR +.TP +\fCQLocale::Switzerland\fR +.TP +\fCQLocale::SyrianArabRepublic\fR +.TP +\fCQLocale::Taiwan\fR +.TP +\fCQLocale::Tajikistan\fR +.TP +\fCQLocale::Tanzania\fR +.TP +\fCQLocale::Thailand\fR +.TP +\fCQLocale::Togo\fR +.TP +\fCQLocale::Tokelau\fR +.TP +\fCQLocale::TongaCountry\fR +.TP +\fCQLocale::TrinidadAndTobago\fR +.TP +\fCQLocale::Tunisia\fR +.TP +\fCQLocale::Turkey\fR +.TP +\fCQLocale::Turkmenistan\fR +.TP +\fCQLocale::TurksAndCaicosIslands\fR +.TP +\fCQLocale::Tuvalu\fR +.TP +\fCQLocale::Uganda\fR +.TP +\fCQLocale::Ukraine\fR +.TP +\fCQLocale::UnitedArabEmirates\fR +.TP +\fCQLocale::UnitedKingdom\fR +.TP +\fCQLocale::UnitedStates\fR +.TP +\fCQLocale::UnitedStatesMinorOutlyingIslands\fR +.TP +\fCQLocale::Uruguay\fR +.TP +\fCQLocale::Uzbekistan\fR +.TP +\fCQLocale::Vanuatu\fR +.TP +\fCQLocale::VaticanCityState\fR +.TP +\fCQLocale::Venezuela\fR +.TP +\fCQLocale::VietNam\fR +.TP +\fCQLocale::BritishVirginIslands\fR +.TP +\fCQLocale::USVirginIslands\fR +.TP +\fCQLocale::WallisAndFutunaIslands\fR +.TP +\fCQLocale::WesternSahara\fR +.TP +\fCQLocale::Yemen\fR +.TP +\fCQLocale::Yugoslavia\fR +.TP +\fCQLocale::Zambia\fR +.TP +\fCQLocale::Zimbabwe\fR +.SH "QLocale::Language" +This enumerated type is used to specify a language. +.TP +\fCQLocale::C\fR - Identical to English/UnitedStates +.TP +\fCQLocale::Abkhazian\fR +.TP +\fCQLocale::Afan\fR +.TP +\fCQLocale::Afar\fR +.TP +\fCQLocale::Afrikaans\fR +.TP +\fCQLocale::Albanian\fR +.TP +\fCQLocale::Amharic\fR +.TP +\fCQLocale::Arabic\fR +.TP +\fCQLocale::Armenian\fR +.TP +\fCQLocale::Assamese\fR +.TP +\fCQLocale::Aymara\fR +.TP +\fCQLocale::Azerbaijani\fR +.TP +\fCQLocale::Bashkir\fR +.TP +\fCQLocale::Basque\fR +.TP +\fCQLocale::Bengali\fR +.TP +\fCQLocale::Bhutani\fR +.TP +\fCQLocale::Bihari\fR +.TP +\fCQLocale::Bislama\fR +.TP +\fCQLocale::Breton\fR +.TP +\fCQLocale::Bulgarian\fR +.TP +\fCQLocale::Burmese\fR +.TP +\fCQLocale::Byelorussian\fR +.TP +\fCQLocale::Cambodian\fR +.TP +\fCQLocale::Catalan\fR +.TP +\fCQLocale::Chinese\fR +.TP +\fCQLocale::Corsican\fR +.TP +\fCQLocale::Croatian\fR +.TP +\fCQLocale::Czech\fR +.TP +\fCQLocale::Danish\fR +.TP +\fCQLocale::Dutch\fR +.TP +\fCQLocale::English\fR +.TP +\fCQLocale::Esperanto\fR +.TP +\fCQLocale::Estonian\fR +.TP +\fCQLocale::Faroese\fR +.TP +\fCQLocale::FijiLanguage\fR +.TP +\fCQLocale::Finnish\fR +.TP +\fCQLocale::French\fR +.TP +\fCQLocale::Frisian\fR +.TP +\fCQLocale::Gaelic\fR +.TP +\fCQLocale::Galician\fR +.TP +\fCQLocale::Georgian\fR +.TP +\fCQLocale::German\fR +.TP +\fCQLocale::Greek\fR +.TP +\fCQLocale::Greenlandic\fR +.TP +\fCQLocale::Guarani\fR +.TP +\fCQLocale::Gujarati\fR +.TP +\fCQLocale::Hausa\fR +.TP +\fCQLocale::Hebrew\fR +.TP +\fCQLocale::Hindi\fR +.TP +\fCQLocale::Hungarian\fR +.TP +\fCQLocale::Icelandic\fR +.TP +\fCQLocale::Indonesian\fR +.TP +\fCQLocale::Interlingua\fR +.TP +\fCQLocale::Interlingue\fR +.TP +\fCQLocale::Inuktitut\fR +.TP +\fCQLocale::Inupiak\fR +.TP +\fCQLocale::Irish\fR +.TP +\fCQLocale::Italian\fR +.TP +\fCQLocale::Japanese\fR +.TP +\fCQLocale::Javanese\fR +.TP +\fCQLocale::Kannada\fR +.TP +\fCQLocale::Kashmiri\fR +.TP +\fCQLocale::Kazakh\fR +.TP +\fCQLocale::Kinyarwanda\fR +.TP +\fCQLocale::Kirghiz\fR +.TP +\fCQLocale::Korean\fR +.TP +\fCQLocale::Kurdish\fR +.TP +\fCQLocale::Kurundi\fR +.TP +\fCQLocale::Laothian\fR +.TP +\fCQLocale::Latin\fR +.TP +\fCQLocale::Latvian\fR +.TP +\fCQLocale::Lingala\fR +.TP +\fCQLocale::Lithuanian\fR +.TP +\fCQLocale::Macedonian\fR +.TP +\fCQLocale::Malagasy\fR +.TP +\fCQLocale::Malay\fR +.TP +\fCQLocale::Malayalam\fR +.TP +\fCQLocale::Maltese\fR +.TP +\fCQLocale::Maori\fR +.TP +\fCQLocale::Marathi\fR +.TP +\fCQLocale::Moldavian\fR +.TP +\fCQLocale::Mongolian\fR +.TP +\fCQLocale::NauruLanguage\fR +.TP +\fCQLocale::Nepali\fR +.TP +\fCQLocale::Norwegian\fR +.TP +\fCQLocale::Occitan\fR +.TP +\fCQLocale::Oriya\fR +.TP +\fCQLocale::Pashto\fR +.TP +\fCQLocale::Persian\fR +.TP +\fCQLocale::Polish\fR +.TP +\fCQLocale::Portuguese\fR +.TP +\fCQLocale::Punjabi\fR +.TP +\fCQLocale::Quechua\fR +.TP +\fCQLocale::RhaetoRomance\fR +.TP +\fCQLocale::Romanian\fR +.TP +\fCQLocale::Russian\fR +.TP +\fCQLocale::Samoan\fR +.TP +\fCQLocale::Sangho\fR +.TP +\fCQLocale::Sanskrit\fR +.TP +\fCQLocale::Serbian\fR +.TP +\fCQLocale::SerboCroatian\fR +.TP +\fCQLocale::Sesotho\fR +.TP +\fCQLocale::Setswana\fR +.TP +\fCQLocale::Shona\fR +.TP +\fCQLocale::Sindhi\fR +.TP +\fCQLocale::Singhalese\fR +.TP +\fCQLocale::Siswati\fR +.TP +\fCQLocale::Slovak\fR +.TP +\fCQLocale::Slovenian\fR +.TP +\fCQLocale::Somali\fR +.TP +\fCQLocale::Spanish\fR +.TP +\fCQLocale::Sundanese\fR +.TP +\fCQLocale::Swahili\fR +.TP +\fCQLocale::Swedish\fR +.TP +\fCQLocale::Tagalog\fR +.TP +\fCQLocale::Tajik\fR +.TP +\fCQLocale::Tamil\fR +.TP +\fCQLocale::Tatar\fR +.TP +\fCQLocale::Telugu\fR +.TP +\fCQLocale::Thai\fR +.TP +\fCQLocale::Tibetan\fR +.TP +\fCQLocale::Tigrinya\fR +.TP +\fCQLocale::TongaLanguage\fR +.TP +\fCQLocale::Tsonga\fR +.TP +\fCQLocale::Turkish\fR +.TP +\fCQLocale::Turkmen\fR +.TP +\fCQLocale::Twi\fR +.TP +\fCQLocale::Uigur\fR +.TP +\fCQLocale::Ukrainian\fR +.TP +\fCQLocale::Urdu\fR +.TP +\fCQLocale::Uzbek\fR +.TP +\fCQLocale::Vietnamese\fR +.TP +\fCQLocale::Volapuk\fR +.TP +\fCQLocale::Welsh\fR +.TP +\fCQLocale::Wolof\fR +.TP +\fCQLocale::Xhosa\fR +.TP +\fCQLocale::Yiddish\fR +.TP +\fCQLocale::Yoruba\fR +.TP +\fCQLocale::Zhuang\fR +.TP +\fCQLocale::Zulu\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLocale::QLocale ()" +Constructs a QLocale object initialized with the default locale. +.PP +See also setDefault(). +.SH "QLocale::QLocale ( const QString & name )" +Constructs a QLocale object with the specified \fIname\fR, which has the format" language[_country][.codeset][@modifier]" or "C", where: +.TP +language is a lowercase, two-letter, ISO 639 language code, +.TP +territory is an uppercase, two-letter, ISO 3166 country code, +.TP +and codeset and modifier are ignored. +.PP +If the string violates the locale format, or language is not a valid ISO 369 code, the "C" locale is used instead. If country is not present, or is not a valid ISO 3166 code, the most appropriate country is chosen for the specified language. +.PP +The language and country codes are converted to their respective Language and Country enums. After this conversion is performed the constructor behaves exactly like QLocale(Country, Language). +.PP +This constructor is much slower than QLocale(Country, Language). +.PP +See also name(). +.SH "QLocale::QLocale ( Language language, Country country = AnyCountry )" +Constructs a QLocale object with the specified \fIlanguage\fR and \fIcountry\fR. +.TP +If the language/country pair is found in the database, it is used. +.TP +If the language is found but the country is not, or if the country is AnyCountry, the language is used with the most appropriate available country (for example, Germany for German), +.TP +If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()). +.PP +The language and country that are actually used can be queried using language() and country(). +.PP +See also setDefault(), language(), and country(). +.SH "QLocale::QLocale ( const QLocale & other )" +Constructs a QLocale object as a copy of \fIother\fR. +.SH "QLocale QLocale::c ()\fC [static]\fR" +Returns a QLocale object initialized to the "C" locale. +.PP +See also system(). +.SH "Country QLocale::country () const" +Returns the country of this locale. +.PP +See also QLocale(). +.SH "QString QLocale::countryToString ( Country country )\fC [static]\fR" +Returns a QString containing the name of \fIcountry\fR. +.SH "Language QLocale::language () const" +Returns the language of this locale. +.PP +See also QLocale(). +.SH "QString QLocale::languageToString ( Language language )\fC [static]\fR" +Returns a QString containing the name of \fIlanguage\fR. +.SH "QString QLocale::name () const" +Returns the language and country of this locale as a string of the form "language_country", where language is a lowercase, two-letter ISO 639 language code, and country is an uppercase, two-letter ISO 3166 country code. +.PP +See also QLocale(). +.SH "QLocale & QLocale::operator= ( const QLocale & other )" +Assigns \fIother\fR to this QLocale object and returns a reference to this QLocale object. +.SH "void QLocale::setDefault ( const QLocale & locale )\fC [static]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Sets the global default locale to \fIlocale\fR. These values are used when a QLocale object is constructed with no arguments. If this function is not called, the system's locale is used. +.PP +\fBWarning:\fR In a multithreaded application, the default locale should be set at application startup, before any non-GUI threads are created. +.PP +See also system() and c(). +.SH "QLocale QLocale::system ()\fC [static]\fR" +Returns a QLocale object initialized to the system locale. +.SH "double QLocale::toDouble ( const QString & s, bool * ok = 0 ) const" +Returns the double represented by the localized string \fIs\fR, or 0.0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +Unlike QString::toDouble(), this function does not fall back to the "C" locale if the string cannot be interpreted in this locale. +.PP +.nf +.br + bool ok; +.br + double d; +.br +.br + QLocale c(QLocale::C); +.br + d = c.toDouble( "1234.56", &ok ); // ok == true, d == 1234.56 +.br + d = c.toDouble( "1,234.56", &ok ); // ok == true, d == 1234.56 +.br + d = c.toDouble( "1234,56", &ok ); // ok == false +.br +.br + QLocale german(QLocale::German); +.br + d = german.toDouble( "1234,56", &ok ); // ok == true, d == 1234.56 +.br + d = german.toDouble( "1.234,56", &ok ); // ok == true, d == 1234.56 +.br + d = german.toDouble( "1234.56", &ok ); // ok == false +.br +.br + d = german.toDouble( "1.234", &ok ); // ok == true, d == 1234.0 +.br +.fi +.PP +Notice that the last conversion returns 1234.0, because '.' is the thousands group separator in the German locale. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString() and QString::toDouble(). +.SH "float QLocale::toFloat ( const QString & s, bool * ok = 0 ) const" +Returns the float represented by the localized string \fIs\fR, or 0.0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "int QLocale::toInt ( const QString & s, bool * ok = 0 ) const" +Returns the int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "TQ_LONG QLocale::toLong ( const QString & s, bool * ok = 0 ) const" +Returns the long int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "TQ_LLONG QLocale::toLongLong ( const QString & s, bool * ok = 0 ) const" +Returns the long long int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "short QLocale::toShort ( const QString & s, bool * ok = 0 ) const" +Returns the short int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "QString QLocale::toString ( TQ_LLONG i ) const" +Returns a localized string representation of \fIi\fR. +.PP +See also toLongLong(). +.SH "QString QLocale::toString ( short i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also toShort(). +.SH "QString QLocale::toString ( ushort i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also toUShort(). +.SH "QString QLocale::toString ( int i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also toInt(). +.SH "QString QLocale::toString ( uint i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also toUInt(). +.SH "QString QLocale::toString ( TQ_LONG i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also toLong(). +.SH "QString QLocale::toString ( TQ_ULONG i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also toULong(). +.SH "QString QLocale::toString ( TQ_ULLONG i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also toULongLong(). +.SH "QString QLocale::toString ( float i, char f = 'g', int prec = 6 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIf\fR and \fIprec\fR have the same meaning as in QString::number(double, char, int). +.PP +See also toDouble(). +.SH "QString QLocale::toString ( double i, char f = 'g', int prec = 6 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIf\fR and \fIprec\fR have the same meaning as in QString::number(double, char, int). +.PP +See also toDouble(). +.SH "uint QLocale::toUInt ( const QString & s, bool * ok = 0 ) const" +Returns the unsigned int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "TQ_ULONG QLocale::toULong ( const QString & s, bool * ok = 0 ) const" +Returns the unsigned long int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "TQ_ULLONG QLocale::toULongLong ( const QString & s, bool * ok = 0 ) const" +Returns the unsigned long long int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). +.SH "ushort QLocale::toUShort ( const QString & s, bool * ok = 0 ) const" +Returns the unsigned short int represented by the localized string \fIs\fR, or 0 if the conversion failed. +.PP +If \fIok\fR is not 0, reports failure by setting *ok to false and success by setting *ok to true. +.PP +This function ignores leading and trailing whitespace. +.PP +See also toString(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlocale.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlocale.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqlocalfs.3qt b/doc/man/man3/tqlocalfs.3qt new file mode 100644 index 000000000..681a30380 --- /dev/null +++ b/doc/man/man3/tqlocalfs.3qt @@ -0,0 +1,67 @@ +'\" t +.TH QLocalFs 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 +QLocalFs \- Implementation of a QNetworkProtocol that works on the local file system +.SH SYNOPSIS +\fC#include <ntqlocalfs.h>\fR +.PP +Inherits QNetworkProtocol. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQLocalFs\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QLocalFs class is an implementation of a QNetworkProtocol that works on the local file system. +.PP +This class is derived from QNetworkProtocol. QLocalFs is not normally used directly, but rather through a QUrlOperator, for example: +.PP +.nf +.br + QUrlOperator op( "file:///tmp" ); +.br + op.listChildren(); // Asks the server to provide a directory listing +.br +.fi +.PP +This code will only work if the QLocalFs class is registered; to register the class, you must call tqInitNetworkProtocols() before using a QUrlOperator with QLocalFs. +.PP +If you really need to use QLocalFs directly, don't forget to set its QUrlOperator with setUrl(). +.PP +See also Qt Network Documentation, QNetworkProtocol, QUrlOperator, and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QLocalFs::QLocalFs ()" +Constructor. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqlocalfs.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqlocalfs.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmacmime.3qt b/doc/man/man3/tqmacmime.3qt new file mode 100644 index 000000000..eca9e8bcb --- /dev/null +++ b/doc/man/man3/tqmacmime.3qt @@ -0,0 +1,150 @@ +'\" t +.TH QMacMime 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 +QMacMime \- Maps open-standard MIME to Mac flavors +.SH SYNOPSIS +\fC#include <ntqmime.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMacMime\fR ( char t )" +.br +.ti -1c +.BI "virtual \fB~QMacMime\fR ()" +.br +.ti -1c +.BI "virtual const char * \fBconvertorName\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBcountFlavors\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBflavor\fR ( int index ) = 0" +.br +.ti -1c +.BI "virtual bool \fBcanConvert\fR ( const char * mime, int flav ) = 0" +.br +.ti -1c +.BI "virtual const char * \fBmimeFor\fR ( int flav ) = 0" +.br +.ti -1c +.BI "virtual int \fBflavorFor\fR ( const char * mime ) = 0" +.br +.ti -1c +.BI "virtual QByteArray \fBconvertToMime\fR ( QValueList<QByteArray> data, const char * mime, int flav ) = 0" +.br +.ti -1c +.BI "virtual QValueList<QByteArray> \fBconvertFromMime\fR ( QByteArray data, const char * mime, int flav ) = 0" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QPtrList<QMacMime> \fBall\fR ( QMacMimeType t )" +.br +.ti -1c +.BI "QMacMime * \fBconvertor\fR ( QMacMimeType t, const char * mime, int flav )" +.br +.ti -1c +.BI "const char * \fBflavorToMime\fR ( QMacMimeType t, int flav )" +.br +.in -1c +.SH DESCRIPTION +The QMacMime class maps open-standard MIME to Mac flavors. +.PP +Qt's drag-and-drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol, but on Mac although some applications use MIME types to describe clipboard formats, others use arbitrary non-standardized naming conventions, or unnamed built-in Mac formats. +.PP +By instantiating subclasses of QMacMime that provide conversions between Mac flavors and MIME formats, you can convert proprietary clipboard formats to MIME formats. +.PP +Qt has predefined support for the following Mac flavors: +.TP +kScrapFlavorTypeUnicode - converted to "text/plain;charset=ISO-10646-UCS-2" and supported by QTextDrag. +.TP +kScrapFlavorTypeText - converted to "text/plain;charset=system" or "text/plain" and supported by QTextDrag. +.TP +kScrapFlavorTypePicture - converted to "image/format", where format is a Qt image format, and supported by QImageDrag. +.TP +kDragFlavorTypeHFS - converted to "text/uri-list", and supported by QUriDrag. +.PP +You can check if a MIME type is convertible using canConvert() and can perform conversions with convertToMime() and convertFromMime(). +.PP +See also Drag And Drop Classes, Input/Output and Networking, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMacMime::QMacMime ( char t )" +Constructs a new conversion object of type \fIt\fR, adding it to the globally accessed list of available convertors. +.SH "QMacMime::~QMacMime ()\fC [virtual]\fR" +Destroys a conversion object, removing it from the global list of available convertors. +.SH "QPtrList<QMacMime> QMacMime::all ( QMacMimeType t )\fC [static]\fR" +Returns a list of all currently defined QMacMime objects of type \fIt\fR. +.SH "bool QMacMime::canConvert ( const char * mime, int flav )\fC [pure virtual]\fR" +Returns TRUE if the convertor can convert (both ways) between \fImime\fR and \fIflav\fR; otherwise returns FALSE. +.PP +All subclasses must reimplement this pure virtual function. +.SH "QValueList<QByteArray> QMacMime::convertFromMime ( QByteArray data, const char * mime, int flav )\fC [pure virtual]\fR" +Returns \fIdata\fR converted from MIME type \fImime\fR to Mac flavor \fIflav\fR. +.PP +Note that Mac flavors must all be self-terminating. The return value may contain trailing data. +.PP +All subclasses must reimplement this pure virtual function. +.SH "QByteArray QMacMime::convertToMime ( QValueList<QByteArray> data, const char * mime, int flav )\fC [pure virtual]\fR" +Returns \fIdata\fR converted from Mac flavor \fIflav\fR to MIME type \fImime\fR. +.PP +Note that Mac flavors must all be self-terminating. The input \fIdata\fR may contain trailing data. +.PP +All subclasses must reimplement this pure virtual function. +.SH "QMacMime * QMacMime::convertor ( QMacMimeType t, const char * mime, int flav )\fC [static]\fR" +Returns the most-recently created QMacMime of type \fIt\fR that can convert between the \fImime\fR and \fIflav\fR formats. Returns 0 if no such convertor exists. +.SH "const char * QMacMime::convertorName ()\fC [pure virtual]\fR" +Returns a name for the convertor. +.PP +All subclasses must reimplement this pure virtual function. +.SH "int QMacMime::countFlavors ()\fC [pure virtual]\fR" +Returns the number of Mac flavors supported by this convertor. +.PP +All subclasses must reimplement this pure virtual function. +.SH "int QMacMime::flavor ( int index )\fC [pure virtual]\fR" +Returns the Mac flavor supported by this convertor that is ordinarily at position \fIindex\fR. This means that flavor(0) returns the first Mac flavor supported, and flavor(countFlavors()-1) returns the last. If \fIindex\fR is out of range the return value is undefined. +.PP +All subclasses must reimplement this pure virtual function. +.SH "int QMacMime::flavorFor ( const char * mime )\fC [pure virtual]\fR" +Returns the Mac flavor used for MIME type \fImime\fR, or 0 if this convertor does not support \fImime\fR. +.PP +All subclasses must reimplement this pure virtual function. +.SH "const char * QMacMime::flavorToMime ( QMacMimeType t, int flav )\fC [static]\fR" +Returns a MIME type of type \fIt\fR for \fIflav\fR, or 0 if none exists. +.SH "const char * QMacMime::mimeFor ( int flav )\fC [pure virtual]\fR" +Returns the MIME type used for Mac flavor \fIflav\fR, or 0 if this convertor does not support \fIflav\fR. +.PP +All subclasses must reimplement this pure virtual function. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmacmime.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmacmime.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmacstyle.3qt b/doc/man/man3/tqmacstyle.3qt new file mode 100644 index 000000000..65fa493be --- /dev/null +++ b/doc/man/man3/tqmacstyle.3qt @@ -0,0 +1,135 @@ +'\" t +.TH QMacStyle 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 +QMacStyle \- Implements an Appearance Manager style +.SH SYNOPSIS +\fC#include <qmacstyle_mac.h>\fR +.PP +Inherits QWindowsStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMacStyle\fR ()" +.br +.ti -1c +.BI "virtual \fB~QMacStyle\fR ()" +.br +.ti -1c +.BI "enum \fBFocusRectPolicy\fR { FocusEnabled, FocusDisabled, FocusDefault }" +.br +.ti -1c +.BI "enum \fBWidgetSizePolicy\fR { SizeSmall, SizeLarge, SizeNone, SizeDefault }" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBsetFocusRectPolicy\fR ( QWidget * w, FocusRectPolicy policy )" +.br +.ti -1c +.BI "FocusRectPolicy \fBfocusRectPolicy\fR ( QWidget * w )" +.br +.ti -1c +.BI "void \fBsetWidgetSizePolicy\fR ( QWidget * w, WidgetSizePolicy policy )" +.br +.ti -1c +.BI "WidgetSizePolicy \fBwidgetSizePolicy\fR ( QWidget * w )" +.br +.in -1c +.SH DESCRIPTION +The QMacStyle class implements an Appearance Manager style. +.PP +This class is implemented as a wrapper to the Apple Appearance Manager. This allows your application to be styled by whatever theme your Macintosh is using. This is done by having primitives in QStyle implemented in terms of what the Macintosh would normally theme (i.e. the Finder). +.PP +There are additional issues that should be taken into consideration to make an application compatible with the Aqua Style Guidelines. Some of these issues are outlined below. +.IP +.TP +Layout - The restrictions on window layout are such that some aspects of layout that are style-dependent cannot be achieved using QLayout. Changes are being considered (and feedback would be appreciated) to make layouts QStyle-able. Some of the restrictions involve horizontal and vertical widget alignment and widget size (covered below). +.IP +.TP +Widget size - Aqua allows widgets to have specific fixed sizes. Qt does not fully implement this behaviour so as to maintain multiplatform compatibility. As a result some widgets sizes may be inappropriate (and subsequently not rendered correctly by the Appearance Manager).The QWidget::sizeHint() will return the appropriate size for many managed widgets (widgets enumerated in QStyle::ContentsType). +.IP +.TP +Effects - QMacStyle (in contrast to QAquaStyle) is not emulating (except where Appearance Manager does not provide certain capabilities), for example QPushButton pulsing effects. In this case a near matching emulation has been implemented, but naturally this will not be identical to the similar functionality built into the Appearance Manager. Please report any issues you see in effects or non-standard widgets. +.IP +.PP +There are other issues that need to be considered in the feel of your application (including the general color scheme to match the Aqua colors). The Guidelines mentioned above will remain current with new advances and design suggestions for Mac OS X. +.PP +Note that the functions provided by QMacStyle are reimplementations of QStyle functions; see QStyle for their documentation. +.PP +See also Widget Appearance and Style. +.SS "Member Type Documentation" +.SH "QMacStyle::FocusRectPolicy" +This type is used to signify a widget's focus rectangle policy. +.TP +\fCQMacStyle::FocusEnabled\fR - show a focus rectangle when the widget has focus. +.TP +\fCQMacStyle::FocusDisabled\fR - never show a focus rectangle for the widget. +.TP +\fCQMacStyle::FocusDefault\fR - show a focus rectangle when the widget has focus and the widget is a QSpinWidget, QDateTimeEdit, QLineEdit, QListBox, QListView, editable QTextEdit, or one of their subclasses. +.SH "QMacStyle::WidgetSizePolicy" +.TP +\fCQMacStyle::SizeSmall\fR +.TP +\fCQMacStyle::SizeLarge\fR +.TP +\fCQMacStyle::SizeNone\fR +.TP +\fCQMacStyle::SizeDefault\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMacStyle::QMacStyle ()" +Constructs a QMacStyle object. +.SH "QMacStyle::~QMacStyle ()\fC [virtual]\fR" +Destructs a QMacStyle object. +.SH "FocusRectPolicy QMacStyle::focusRectPolicy ( QWidget * w )\fC [static]\fR" +Returns the focus rectangle policy for the widget \fIw\fR. +.PP +The focus rectangle policy can be one of QMacStyle::FocusRectPolicy. +.PP +See also setFocusRectPolicy(). +.SH "void QMacStyle::setFocusRectPolicy ( QWidget * w, FocusRectPolicy policy )\fC [static]\fR" +Sets the focus rectangle policy of \fIw\fR. The \fIpolicy\fR can be one of QMacStyle::FocusRectPolicy. +.PP +See also focusRectPolicy(). +.SH "void QMacStyle::setWidgetSizePolicy ( QWidget * w, WidgetSizePolicy policy )\fC [static]\fR" +Sets the widget size policy of \fIw\fR. The \fIpolicy\fR can be one of QMacStyle::WidgetSizePolicy. +.PP +See also widgetSizePolicy(). +.SH "WidgetSizePolicy QMacStyle::widgetSizePolicy ( QWidget * w )\fC [static]\fR" +Returns the widget size policy for the widget \fIw\fR. +.PP +The widget size policy can be one of QMacStyle::WidgetSizePolicy. +.PP +See also setWidgetSizePolicy(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmacstyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmacstyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmainwindow.3qt b/doc/man/man3/tqmainwindow.3qt new file mode 100644 index 000000000..c71e34418 --- /dev/null +++ b/doc/man/man3/tqmainwindow.3qt @@ -0,0 +1,845 @@ +'\" t +.TH QMainWindow 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 +QMainWindow \- Main application window, with a menu bar, dock windows (e.g. for toolbars), and a status bar +.SH SYNOPSIS +\fC#include <ntqmainwindow.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMainWindow\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = WType_TopLevel )" +.br +.ti -1c +.BI "\fB~QMainWindow\fR ()" +.br +.ti -1c +.BI "QMenuBar * \fBmenuBar\fR () const" +.br +.ti -1c +.BI "QStatusBar * \fBstatusBar\fR () const" +.br +.ti -1c +.BI "QToolTipGroup * \fBtoolTipGroup\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCentralWidget\fR ( QWidget * w )" +.br +.ti -1c +.BI "QWidget * \fBcentralWidget\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDockEnabled\fR ( Dock dock, bool enable )" +.br +.ti -1c +.BI "bool \fBisDockEnabled\fR ( Dock dock ) const" +.br +.ti -1c +.BI "bool \fBisDockEnabled\fR ( QDockArea * area ) const" +.br +.ti -1c +.BI "virtual void \fBsetDockEnabled\fR ( QDockWindow * dw, Dock dock, bool enable )" +.br +.ti -1c +.BI "bool \fBisDockEnabled\fR ( QDockWindow * tb, Dock dock ) const" +.br +.ti -1c +.BI "bool \fBisDockEnabled\fR ( QDockWindow * dw, QDockArea * area ) const" +.br +.ti -1c +.BI "virtual void \fBaddDockWindow\fR ( QDockWindow * dockWindow, Dock edge = DockTop, bool newLine = FALSE )" +.br +.ti -1c +.BI "virtual void \fBaddDockWindow\fR ( QDockWindow * dockWindow, const QString & label, Dock edge = DockTop, bool newLine = FALSE )" +.br +.ti -1c +.BI "virtual void \fBmoveDockWindow\fR ( QDockWindow * dockWindow, Dock edge = DockTop )" +.br +.ti -1c +.BI "virtual void \fBmoveDockWindow\fR ( QDockWindow * dockWindow, Dock edge, bool nl, int index, int extraOffset = -1 )" +.br +.ti -1c +.BI "virtual void \fBremoveDockWindow\fR ( QDockWindow * dockWindow )" +.br +.ti -1c +.BI "bool rightJustification () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBusesBigPixmaps\fR () const" +.br +.ti -1c +.BI "bool \fBusesTextLabel\fR () const" +.br +.ti -1c +.BI "bool \fBdockWindowsMovable\fR () const" +.br +.ti -1c +.BI "bool \fBopaqueMoving\fR () const" +.br +.ti -1c +.BI "bool \fBgetLocation\fR ( QDockWindow * dw, Dock & dock, int & index, bool & nl, int & extraOffset ) const" +.br +.ti -1c +.BI "QPtrList<QDockWindow> \fBdockWindows\fR ( Dock dock ) const" +.br +.ti -1c +.BI "QPtrList<QDockWindow> \fBdockWindows\fR () const" +.br +.ti -1c +.BI "void \fBlineUpDockWindows\fR ( bool keepNewLines = FALSE )" +.br +.ti -1c +.BI "bool \fBisDockMenuEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBhasDockWindow\fR ( QDockWindow * dw )" +.br +.ti -1c +.BI "void addToolBar ( QDockWindow *, Dock = DockTop, bool newLine = FALSE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void addToolBar ( QDockWindow *, const QString & label, Dock = DockTop, bool newLine = FALSE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void moveToolBar ( QDockWindow *, Dock = DockTop ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void moveToolBar ( QDockWindow *, Dock, bool nl, int index, int extraOffset = -1 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void removeToolBar ( QDockWindow * ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool toolBarsMovable () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QPtrList<QToolBar> \fBtoolBars\fR ( Dock dock ) const" +.br +.ti -1c +.BI "void lineUpToolBars ( bool keepNewLines = FALSE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QDockArea * \fBleftDock\fR () const" +.br +.ti -1c +.BI "QDockArea * \fBrightDock\fR () const" +.br +.ti -1c +.BI "QDockArea * \fBtopDock\fR () const" +.br +.ti -1c +.BI "QDockArea * \fBbottomDock\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisCustomizable\fR () const" +.br +.ti -1c +.BI "bool \fBappropriate\fR ( QDockWindow * dw ) const" +.br +.ti -1c +.BI "enum \fBDockWindows\fR { OnlyToolBars, NoToolBars, AllDockWindows }" +.br +.ti -1c +.BI "QPopupMenu * \fBcreateDockWindowMenu\fR ( DockWindows dockWindows = AllDockWindows ) const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void setRightJustification ( bool ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void \fBsetUsesBigPixmaps\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetUsesTextLabel\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetDockWindowsMovable\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetOpaqueMoving\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetDockMenuEnabled\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBwhatsThis\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetAppropriate\fR ( QDockWindow * dw, bool a )" +.br +.ti -1c +.BI "virtual void \fBcustomize\fR ()" +.br +.ti -1c +.BI "void setToolBarsMovable ( bool ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBpixmapSizeChanged\fR ( bool )" +.br +.ti -1c +.BI "void \fBusesTextLabelChanged\fR ( bool )" +.br +.ti -1c +.BI "void \fBdockWindowPositionChanged\fR ( QDockWindow * dockWindow )" +.br +.ti -1c +.BI "void toolBarPositionChanged ( QToolBar * ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBdockWindowsMovable\fR - whether the dock windows are movable" +.br +.ti -1c +.BI "bool \fBopaqueMoving\fR - whether dock windows are moved opaquely" +.br +.ti -1c +.BI "bool rightJustification - whether the main window right-justifies its dock windows \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBusesBigPixmaps\fR - whether big pixmaps are enabled" +.br +.ti -1c +.BI "bool \fBusesTextLabel\fR - whether text labels for toolbar buttons are enabled" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBchildEvent\fR ( QChildEvent * e )" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetUpLayout\fR ()" +.br +.ti -1c +.BI "virtual bool \fBshowDockMenu\fR ( const QPoint & globalPos )" +.br +.ti -1c +.BI "void \fBmenuAboutToShow\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( QTextStream & ts, const QMainWindow & mainWindow )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( QTextStream & ts, QMainWindow & mainWindow )" +.br +.in -1c +.SH DESCRIPTION +The QMainWindow class provides a main application window, with a menu bar, dock windows (e.g. for toolbars), and a status bar. +.PP +Main windows are most often used to provide menus, toolbars and a status bar around a large central widget, such as a text edit, drawing canvas or QWorkspace (for MDI applications). QMainWindow is usually subclassed since this makes it easier to encapsulate the central widget, menus and toolbars as well as the window's state. Subclassing makes it possible to create the slots that are called when the user clicks menu items or toolbar buttons. You can also create main windows using Qt Designer. We'll briefly review adding menu items and toolbar buttons then describe the facilities of QMainWindow itself. +.PP +.nf +.br + QMainWindow *mw = new QMainWindow; +.br + QTextEdit *edit = new QTextEdit( mw, "editor" ); +.br + edit->setFocus(); +.br + mw->setCaption( "Main Window" ); +.br + mw->setCentralWidget( edit ); +.br + mw->show(); +.br +.fi +.PP +QMainWindows may be created in their own right as shown above. The central widget is set with setCentralWidget(). Popup menus can be added to the default menu bar, widgets can be added to the status bar, toolbars and dock windows can be added to any of the dock areas. +.PP +.nf +.br + ApplicationWindow *mw = new ApplicationWindow(); +.br + mw->setCaption( "Qt Example - Application" ); +.br + mw->show(); +.fi +.PP +In the extract above ApplicationWindow is a subclass of QMainWindow that we must write for ourselves; this is the usual approach to using QMainWindow. (The source for the extracts in this description are taken from application/main.cpp, application/application.cpp, action/main.cpp, and action/application.cpp ) +.PP +When subclassing we add the menu items and toolbars in the subclass's constructor. If we've created a QMainWindow instance directly we can add menu items and toolbars just as easily by passing the QMainWindow instance as the parent instead of the \fIthis\fR pointer. +.PP +.nf +.br + QPopupMenu * help = new QPopupMenu( this ); +.br + menuBar()->insertItem( "&Help", help ); +.br +.br + help->insertItem( "&About", this, SLOT(about()), Key_F1 ); +.fi +.PP +Here we've added a new menu with one menu item. The menu has been inserted into the menu bar that QMainWindow provides by default and which is accessible through the menuBar() function. The slot will be called when the menu item is clicked. +.PP +.nf +.br + QToolBar * fileTools = new QToolBar( this, "file operations" ); +.br + fileTools->setLabel( "File Operations" ); +.fi +.PP +.nf +.br + QToolButton * fileOpen +.br + = new QToolButton( openIcon, "Open File", QString::null, +.br + this, SLOT(choose()), fileTools, "open file" ); +.fi +.PP +This extract shows the creation of a toolbar with one toolbar button. QMainWindow supplies four dock areas for toolbars. When a toolbar is created as a child of a QMainWindow (or derived class) instance it will be placed in a dock area (the Top dock area by default). The slot will be called when the toolbar button is clicked. Any dock window can be added to a dock area either using addDockWindow(), or by creating a dock window with the QMainWindow as the parent. +.PP +.nf +.br + e = new QTextEdit( this, "editor" ); +.br + e->setFocus(); +.br + setCentralWidget( e ); +.br + statusBar()->message( "Ready", 2000 ); +.fi +.PP +Having created the menus and toolbar we create an instance of the large central widget, give it the focus and set it as the main window's central widget. In the example we've also set the status bar, accessed via the statusBar() function, to an initial message which will be displayed for two seconds. Note that you can add additional widgets to the status bar, for example labels, to show further status information. See the QStatusBar documentation for details, particularly the addWidget() function. +.PP +Often we want to synchronize a toolbar button with a menu item. For example, if the user clicks a 'bold' toolbar button we want the 'bold' menu item to be checked. This synchronization can be achieved automatically by creating actions and adding the actions to the toolbar and menu. +.PP +.nf +.br + QAction * fileOpenAction; +.fi +.PP +.nf +.br + fileOpenAction = new QAction( QPixmap( fileopen ), "&Open...", +.br + CTRL+Key_O, this, "open" ); +.br + connect( fileOpenAction, SIGNAL( activated() ) , this, SLOT( choose() ) ); +.fi +.PP +Here we create an action with an icon which will be used in any menu and toolbar that the action is added to. We've also given the action a menu name, '&Open', and a keyboard shortcut. The connection that we have made will be used when the user clicks either the menu item \fIor\fR the toolbar button. +.PP +.nf +.br + QPopupMenu * file = new QPopupMenu( this ); +.br + menuBar()->insertItem( "&File", file ); +.fi +.PP +.nf +.br + fileOpenAction->addTo( file ); +.fi +.PP +The extract above shows the creation of a popup menu. We add the menu to the QMainWindow's menu bar and add our action. +.PP +.nf +.br + QToolBar * fileTools = new QToolBar( this, "file operations" ); +.br + fileTools->setLabel( "File Operations" ); +.br + fileOpenAction->addTo( fileTools ); +.fi +.PP +Here we create a new toolbar as a child of the QMainWindow and add our action to the toolbar. +.PP +We'll now explore the functionality offered by QMainWindow. +.PP +The main window will take care of the dock areas, and the geometry of the central widget, but all other aspects of the central widget are left to you. QMainWindow automatically detects the creation of a menu bar or status bar if you specify the QMainWindow as parent, or you can use the provided menuBar() and statusBar() functions. The functions menuBar() and statusBar() create a suitable widget if one doesn't exist, and update the window's layout to make space. +.PP +QMainWindow provides a QToolTipGroup connected to the status bar. The function toolTipGroup() provides access to the default QToolTipGroup. It isn't possible to set a different tool tip group. +.PP +New dock windows and toolbars can be added to a QMainWindow using addDockWindow(). Dock windows can be moved using moveDockWindow() and removed with removeDockWindow(). QMainWindow allows default dock window (toolbar) docking in all its dock areas (Top, Left, Right, Bottom). You can use setDockEnabled() to enable and disable docking areas for dock windows. When adding or moving dock windows you can specify their 'edge' (dock area). The currently available edges are: Top, Left, Right, Bottom, Minimized (effectively a 'hidden' dock area) and TornOff (floating). See Qt::Dock for an explanation of these areas. Note that the *ToolBar functions are included for backward compatibility; all new code should use the *DockWindow functions. QToolbar is a subclass of QDockWindow so all functions that work with dock windows work on toolbars in the same way. +.PP +If the user clicks the close button, then the dock window is hidden. A dock window can be hidden or unhidden by the user by right clicking a dock area and clicking the name of the relevant dock window on the pop up dock window menu. This menu lists the names of every dock window; visible dock windows have a tick beside their names. The dock window menu is created automatically as required by createDockWindowMenu(). Since it may not always be appropriate for a dock window to appear on this menu the setAppropriate() function is used to inform the main window whether or not the dock window menu should include a particular dock window. Double clicking a dock window handle (usually on the left-hand side of the dock window) undocks (floats) the dock window. Double clicking a floating dock window's titlebar will dock the floating dock window. (See also QMainWindow::DockWindows.) +.PP +Some functions change the appearance of a QMainWindow globally: +.TP +QDockWindow::setHorizontalStretchable() and QDockWindow::setVerticalStretchable() are used to make specific dock windows or toolbars stretchable. +.TP +setUsesBigPixmaps() is used to set whether tool buttons should draw small or large pixmaps (see QIconSet for more information). +.TP +setUsesTextLabel() is used to set whether tool buttons should display a textual label in addition to pixmaps (see QToolButton for more information). +.PP +The user can drag dock windows into any enabled docking area. Dock windows can also be dragged \fIwithin\fR a docking area, for example to rearrange the order of some toolbars. Dock windows can also be dragged outside any docking area (undocked or 'floated'). Being able to drag dock windows can be enabled (the default) and disabled using setDockWindowsMovable(). +.PP +The Minimized edge is a hidden dock area. If this dock area is enabled the user can hide (minimize) a dock window or show (restore) a minimized dock window by clicking the dock window handle. If the user hovers the mouse cursor over one of the handles, the caption of the dock window is displayed in a tool tip (see QDockWindow::caption() or QToolBar::label()), so if you enable the Minimized dock area, it is best to specify a meaningful caption or label for each dock window. To minimize a dock window programmatically use moveDockWindow() with an edge of Minimized. +.PP +Dock windows are moved transparently by default, i.e. during the drag an outline rectangle is drawn on the screen representing the position of the dock window as it moves. If you want the dock window to be shown normally whilst it is moved use setOpaqueMoving(). +.PP +The location of a dock window, i.e. its dock area and position within the dock area, can be determined by calling getLocation(). Movable dock windows can be lined up to minimize wasted space with lineUpDockWindows(). Pointers to the dock areas are available from topDock(), leftDock(), rightDock() and bottomDock(). A customize menu item is added to the pop up dock window menu if isCustomizable() returns TRUE; it returns FALSE by default. Reimplement isCustomizable() and customize() if you want to offer this extra menu item, for example, to allow the user to change settings relating to the main window and its toolbars and dock windows. +.PP +The main window's menu bar is fixed (at the top) by default. If you want a movable menu bar, create a QMenuBar as a stretchable widget inside its own movable dock window and restrict this dock window to only live within the Top or Bottom dock: +.PP +.nf +.br + QToolBar *tb = new QToolBar( this ); +.br + addDockWindow( tb, tr( "Menubar" ), Top, FALSE ); +.br + QMenuBar *mb = new QMenuBar( tb ); +.br + mb->setFrameStyle( QFrame::NoFrame ); +.br + tb->setStretchableWidget( mb ); +.br + setDockEnabled( tb, Left, FALSE ); +.br + setDockEnabled( tb, Right, FALSE ); +.br +.fi +.PP +An application with multiple dock windows can choose to save the current dock window layout in order to restore it later, e.g. in the next session. You can do this by using the streaming operators for QMainWindow. +.PP +To save the layout and positions of all the dock windows do this: +.PP +.nf +.br + QFile file( filename ); +.br + if ( file.open( IO_WriteOnly ) ) { +.br + QTextStream stream( &file ); +.br + stream << *mainWindow; +.br + file.close(); +.br + } +.br +.fi +.PP +To restore the dock window positions and sizes (normally when the application is next started), do following: +.PP +.nf +.br + QFile file( filename ); +.br + if ( file.open( IO_ReadOnly ) ) { +.br + QTextStream stream( &file ); +.br + stream >> *mainWindow; +.br + file.close(); +.br + } +.br +.fi +.PP +The QSettings class can be used in conjunction with the streaming operators to store the application's settings. +.PP +QMainWindow's management of dock windows and toolbars is done transparently behind-the-scenes by QDockArea. +.PP +For multi-document interfaces (MDI), use a QWorkspace as the central widget. +.PP +Adding dock windows, e.g. toolbars, to QMainWindow's dock areas is straightforward. If the supplied dock areas are not sufficient for your application we suggest that you create a QWidget subclass and add your own dock areas (see QDockArea) to the subclass since QMainWindow provides functionality specific to the standard dock areas it provides. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QToolBar, QDockWindow, QStatusBar, QAction, QMenuBar, QPopupMenu, QToolTipGroup, QDialog, and Main Window and Related Classes. +.SS "Member Type Documentation" +.SH "QMainWindow::DockWindows" +Right-clicking a dock area will pop-up the dock window menu (createDockWindowMenu() is called automatically). When called in code you can specify what items should appear on the menu with this enum. +.TP +\fCQMainWindow::OnlyToolBars\fR - The menu will list all the toolbars, but not any other dock windows. +.TP +\fCQMainWindow::NoToolBars\fR - The menu will list dock windows but not toolbars. +.TP +\fCQMainWindow::AllDockWindows\fR - The menu will list all toolbars and other dock windows. (This is the default.) +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMainWindow::QMainWindow ( QWidget * parent = 0, const char * name = 0, WFlags f = WType_TopLevel )" +Constructs an empty main window. The \fIparent\fR, \fIname\fR and widget flags \fIf\fR, are passed on to the QWidget constructor. +.PP +By default, the widget flags are set to WType_TopLevel rather than 0 as they are with QWidget. If you don't want your QMainWindow to be a top level widget then you will need to set \fIf\fR to 0. +.SH "QMainWindow::~QMainWindow ()" +Destroys the object and frees any allocated resources. +.SH "void QMainWindow::addDockWindow ( QDockWindow * dockWindow, Dock edge = DockTop, bool newLine = FALSE )\fC [virtual]\fR" +Adds \fIdockWindow\fR to the \fIedge\fR dock area. +.PP +If \fInewLine\fR is FALSE (the default) then the \fIdockWindow\fR is added at the end of the \fIedge\fR. For vertical edges the end is at the bottom, for horizontal edges (including Minimized) the end is at the right. If \fInewLine\fR is TRUE a new line of dock windows is started with \fIdockWindow\fR as the first (left-most and top-most) dock window. +.PP +If \fIdockWindow\fR is managed by another main window, it is first removed from that window. +.SH "void QMainWindow::addDockWindow ( QDockWindow * dockWindow, const QString & label, Dock edge = DockTop, bool newLine = FALSE )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds \fIdockWindow\fR to the dock area with label \fIlabel\fR. +.PP +If \fInewLine\fR is FALSE (the default) the \fIdockWindow\fR is added at the end of the \fIedge\fR. For vertical edges the end is at the bottom, for horizontal edges (including Minimized) the end is at the right. If \fInewLine\fR is TRUE a new line of dock windows is started with \fIdockWindow\fR as the first (left-most and top-most) dock window. +.PP +If \fIdockWindow\fR is managed by another main window, it is first removed from that window. +.SH "void QMainWindow::addToolBar ( QDockWindow *, Dock = DockTop, bool newLine = FALSE )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QMainWindow::addToolBar ( QDockWindow *, const QString & label, Dock = DockTop, bool newLine = FALSE )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "bool QMainWindow::appropriate ( QDockWindow * dw ) const" +Returns TRUE if it is appropriate to include a menu item for the \fIdw\fR dock window in the dock window menu; otherwise returns FALSE. +.PP +The user is able to change the state (show or hide) a dock window that has a menu item by clicking the item. +.PP +Call setAppropriate() to indicate whether or not a particular dock window should appear on the popup menu. +.PP +See also setAppropriate(). +.SH "QDockArea * QMainWindow::bottomDock () const" +Returns a pointer the Bottom dock area +.PP +See also topDock(), leftDock(), and rightDock(). +.SH "QWidget * QMainWindow::centralWidget () const" +Returns a pointer to the main window's central widget. +.PP +The central widget is surrounded by the left, top, right and bottom dock areas. The menu bar is above the top dock area. +.PP +See also setCentralWidget(). +.PP +Example: qfd/qfd.cpp. +.SH "void QMainWindow::childEvent ( QChildEvent * e )\fC [virtual protected]\fR" +Monitors events, recieved in \fIe\fR, to ensure the layout is updated. +.PP +Reimplemented from QObject. +.SH "QPopupMenu * QMainWindow::createDockWindowMenu ( DockWindows dockWindows = AllDockWindows ) const" +Creates the dock window menu which contains all toolbars (if \fIdockWindows\fR is OnlyToolBars ), all dock windows (if \fIdockWindows\fR is NoToolBars) or all toolbars and dock windows (if \fIdockWindows\fR is AllDockWindows - the default). +.PP +This function is called internally when necessary, e.g. when the user right clicks a dock area (providing isDockMenuEnabled() returns TRUE). +.PP +The menu items representing the toolbars and dock windows are checkable. The visible dock windows are checked and the hidden dock windows are unchecked. The user can click a menu item to change its state (show or hide the dock window). +.PP +The list and the state are always kept up-to-date. +.PP +Toolbars and dock windows which are not appropriate in the current context (see setAppropriate()) are not listed in the menu. +.PP +The menu also has a menu item for lining up the dock windows. +.PP +If isCustomizable() returns TRUE, a Customize menu item is added to the menu, which if clicked will call customize(). The isCustomizable() function we provide returns FALSE and customize() does nothing, so they must be reimplemented in a subclass to be useful. +.SH "void QMainWindow::customize ()\fC [virtual slot]\fR" +This function is called when the user clicks the Customize menu item on the dock window menu. +.PP +The customize menu item will only appear if isCustomizable() returns TRUE (it returns FALSE by default). +.PP +The function is intended, for example, to provide the user with a means of telling the application that they wish to customize the main window, dock windows or dock areas. +.PP +The default implementation does nothing and the Customize menu item is not shown on the right-click menu by default. If you want the item to appear then reimplement isCustomizable() to return TRUE, and reimplement this function to do whatever you want. +.PP +See also isCustomizable(). +.SH "void QMainWindow::dockWindowPositionChanged ( QDockWindow * dockWindow )\fC [signal]\fR" +This signal is emitted when the \fIdockWindow\fR has changed its position. A change in position occurs when a dock window is moved within its dock area or moved to another dock area (including the Minimized and \fCTearOff\fR dock areas). +.PP +See also getLocation(). +.SH "QPtrList<QDockWindow> QMainWindow::dockWindows ( Dock dock ) const" +Returns a list of all the dock windows which are in the \fIdock\fR dock area, regardless of their state. +.PP +For example, the DockTornOff dock area may contain closed dock windows but these are returned along with the visible dock windows. +.SH "QPtrList<QDockWindow> QMainWindow::dockWindows () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the list of dock windows which belong to this main window, regardless of which dock area they are in or what their state is, (e.g. irrespective of whether they are visible or not). +.SH "bool QMainWindow::dockWindowsMovable () const" +Returns TRUE if the dock windows are movable; otherwise returns FALSE. See the "dockWindowsMovable" property for details. +.SH "bool QMainWindow::getLocation ( QDockWindow * dw, Dock & dock, int & index, bool & nl, int & extraOffset ) const" +Finds the location of the dock window \fIdw\fR. +.PP +If the \fIdw\fR dock window is found in the main window the function returns TRUE and populates the \fIdock\fR variable with the dw's dock area and the \fIindex\fR with the dw's position within the dock area. It also sets \fInl\fR to TRUE if the \fIdw\fR begins a new line (otherwise FALSE), and \fIextraOffset\fR with the dock window's offset. +.PP +If the \fIdw\fR dock window is not found then the function returns FALSE and the state of \fIdock\fR, \fIindex\fR, \fInl\fR and \fIextraOffset\fR is undefined. +.PP +If you want to save and restore dock window positions then use operator>>() and operator<<(). +.PP +See also operator>>() and operator<<(). +.SH "bool QMainWindow::hasDockWindow ( QDockWindow * dw )" +Returns TRUE if \fIdw\fR is a dock window known to the main window; otherwise returns FALSE. +.SH "bool QMainWindow::isCustomizable () const\fC [virtual]\fR" +Returns TRUE if the dock area dock window menu includes the Customize menu item (which calls customize() when clicked). Returns FALSE by default, i.e. the popup menu will not contain a Customize menu item. You will need to reimplement this function and set it to return TRUE if you wish the user to be able to see the dock window menu. +.PP +See also customize(). +.SH "bool QMainWindow::isDockEnabled ( Dock dock ) const" +Returns TRUE if the \fIdock\fR dock area is enabled, i.e. it can accept user dragged dock windows; otherwise returns FALSE. +.PP +See also setDockEnabled(). +.SH "bool QMainWindow::isDockEnabled ( QDockArea * area ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if dock area \fIarea\fR is enabled, i.e. it can accept user dragged dock windows; otherwise returns FALSE. +.PP +See also setDockEnabled(). +.SH "bool QMainWindow::isDockEnabled ( QDockWindow * tb, Dock dock ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if dock area \fIdock\fR is enabled for the dock window \fItb\fR; otherwise returns FALSE. +.PP +See also setDockEnabled(). +.SH "bool QMainWindow::isDockEnabled ( QDockWindow * dw, QDockArea * area ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if dock area \fIarea\fR is enabled for the dock window \fIdw\fR; otherwise returns FALSE. +.PP +See also setDockEnabled(). +.SH "bool QMainWindow::isDockMenuEnabled () const" +Returns TRUE, if the dock window menu is enabled; otherwise returns FALSE. +.PP +The menu lists the (appropriate()) dock windows (which may be shown or hidden), and has a "Line Up Dock Windows" menu item. It will also have a "Customize" menu item if isCustomizable() returns TRUE. +.PP +See also setDockEnabled(), lineUpDockWindows(), appropriate(), and setAppropriate(). +.SH "QDockArea * QMainWindow::leftDock () const" +Returns the Left dock area +.PP +See also rightDock(), topDock(), and bottomDock(). +.SH "void QMainWindow::lineUpDockWindows ( bool keepNewLines = FALSE )" +This function will line up dock windows within the visible dock areas (Top, Left, Right and Bottom) as compactly as possible. +.PP +If \fIkeepNewLines\fR is TRUE, all dock windows stay on their original lines. If \fIkeepNewLines\fR is FALSE then newlines may be removed to achieve the most compact layout possible. +.PP +The method only works if dockWindowsMovable() returns TRUE. +.SH "void QMainWindow::lineUpToolBars ( bool keepNewLines = FALSE )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QMainWindow::menuAboutToShow ()\fC [protected slot]\fR" +This slot is called from the aboutToShow() signal of the default dock menu of the mainwindow. The default implementation initializes the menu with all dock windows and toolbars in this slot. +.SH "QMenuBar * QMainWindow::menuBar () const" +Returns the menu bar for this window. +.PP +If there isn't one, then menuBar() creates an empty menu bar. +.PP +See also statusBar(). +.SH "void QMainWindow::moveDockWindow ( QDockWindow * dockWindow, Dock edge = DockTop )\fC [virtual]\fR" +Moves \fIdockWindow\fR to the end of the \fIedge\fR. +.PP +For vertical edges the end is at the bottom, for horizontal edges (including Minimized) the end is at the right. +.PP +If \fIdockWindow\fR is managed by another main window, it is first removed from that window. +.SH "void QMainWindow::moveDockWindow ( QDockWindow * dockWindow, Dock edge, bool nl, int index, int extraOffset = -1 )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Moves \fIdockWindow\fR to position \fIindex\fR within the \fIedge\fR dock area. +.PP +Any dock windows with positions \fIindex\fR or higher have their position number incremented and any of these on the same line are moved right (down for vertical dock areas) to make room. +.PP +If \fInl\fR is TRUE, a new dock window line is created below the line in which the moved dock window appears and the moved dock window, with any others with higher positions on the same line, is moved to this new line. +.PP +The \fIextraOffset\fR is the space to put between the left side of the dock area (top side for vertical dock areas) and the dock window. (This is mostly used for restoring dock windows to the positions the user has dragged them to.) +.PP +If \fIdockWindow\fR is managed by another main window, it is first removed from that window. +.SH "void QMainWindow::moveToolBar ( QDockWindow *, Dock = DockTop )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QMainWindow::moveToolBar ( QDockWindow *, Dock, bool nl, int index, int extraOffset = -1 )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "bool QMainWindow::opaqueMoving () const" +Returns TRUE if dock windows are moved opaquely; otherwise returns FALSE. See the "opaqueMoving" property for details. +.SH "void QMainWindow::pixmapSizeChanged ( bool )\fC [signal]\fR" +This signal is emitted whenever the setUsesBigPixmaps() is called with a value different to the current setting. All widgets that should respond to such changes, e.g. toolbar buttons, must connect to this signal. +.SH "void QMainWindow::removeDockWindow ( QDockWindow * dockWindow )\fC [virtual]\fR" +Removes \fIdockWindow\fR from the main window's docking area, provided \fIdockWindow\fR is non-null and managed by this main window. +.SH "void QMainWindow::removeToolBar ( QDockWindow * )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QDockArea * QMainWindow::rightDock () const" +Returns the Right dock area +.PP +See also leftDock(), topDock(), and bottomDock(). +.SH "bool QMainWindow::rightJustification () const" +Returns TRUE if the main window right-justifies its dock windows; otherwise returns FALSE. See the "rightJustification" property for details. +.SH "void QMainWindow::setAppropriate ( QDockWindow * dw, bool a )\fC [virtual slot]\fR" +Use this function to control whether or not the \fIdw\fR dock window's caption should appear as a menu item on the dock window menu that lists the dock windows. +.PP +If \fIa\fR is TRUE then the \fIdw\fR will appear as a menu item on the dock window menu. The user is able to change the state (show or hide) a dock window that has a menu item by clicking the item; depending on the state of your application, this may or may not be appropriate. If \fIa\fR is FALSE the \fIdw\fR will not appear on the popup menu. +.PP +See also showDockMenu(), isCustomizable(), and customize(). +.SH "void QMainWindow::setCentralWidget ( QWidget * w )\fC [virtual]\fR" +Sets the central widget for this main window to \fIw\fR. +.PP +The central widget is surrounded by the left, top, right and bottom dock areas. The menu bar is above the top dock area. +.PP +See also centralWidget(). +.SH "void QMainWindow::setDockEnabled ( Dock dock, bool enable )\fC [virtual]\fR" +If \fIenable\fR is TRUE then users can dock windows in the \fIdock\fR area. If \fIenable\fR is FALSE users cannot dock windows in the \fIdock\fR dock area. +.PP +Users can dock (drag) dock windows into any enabled dock area. +.SH "void QMainWindow::setDockEnabled ( QDockWindow * dw, Dock dock, bool enable )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +If \fIenable\fR is TRUE then users can dock the \fIdw\fR dock window in the \fIdock\fR area. If \fIenable\fR is FALSE users cannot dock the \fIdw\fR dock window in the \fIdock\fR area. +.PP +In general users can dock (drag) dock windows into any enabled dock area. Using this function particular dock areas can be enabled (or disabled) as docking points for particular dock windows. +.SH "void QMainWindow::setDockMenuEnabled ( bool b )\fC [virtual slot]\fR" +If \fIb\fR is TRUE, then right clicking on a dock window or dock area will pop up the dock window menu. If \fIb\fR is FALSE, right clicking a dock window or dock area will not pop up the menu. +.PP +The menu lists the (appropriate()) dock windows (which may be shown or hidden), and has a "Line Up Dock Windows" item. It will also have a "Customize" menu item if isCustomizable() returns TRUE. +.PP +See also lineUpDockWindows() and isDockMenuEnabled(). +.SH "void QMainWindow::setDockWindowsMovable ( bool )\fC [virtual slot]\fR" +Sets whether the dock windows are movable. See the "dockWindowsMovable" property for details. +.SH "void QMainWindow::setOpaqueMoving ( bool )\fC [virtual slot]\fR" +Sets whether dock windows are moved opaquely. See the "opaqueMoving" property for details. +.SH "void QMainWindow::setRightJustification ( bool )\fC [virtual slot]\fR" +Sets whether the main window right-justifies its dock windows. See the "rightJustification" property for details. +.SH "void QMainWindow::setToolBarsMovable ( bool )\fC [slot]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QMainWindow::setUpLayout ()\fC [virtual protected slot]\fR" +Sets up the geometry management of the window. It is called automatically when needed, so you shouldn't need to call it. +.SH "void QMainWindow::setUsesBigPixmaps ( bool )\fC [virtual slot]\fR" +Sets whether big pixmaps are enabled. See the "usesBigPixmaps" property for details. +.SH "void QMainWindow::setUsesTextLabel ( bool )\fC [virtual slot]\fR" +Sets whether text labels for toolbar buttons are enabled. See the "usesTextLabel" property for details. +.SH "bool QMainWindow::showDockMenu ( const QPoint & globalPos )\fC [virtual protected slot]\fR" +Shows the dock menu at the position \fIglobalPos\fR. The menu lists the dock windows so that they can be shown (or hidden), lined up, and possibly customized. Returns TRUE if the menu is shown; otherwise returns FALSE. +.PP +If you want a custom menu, reimplement this function. You can create the menu from scratch or call createDockWindowMenu() and modify the result. +.SH "QStatusBar * QMainWindow::statusBar () const" +Returns this main window's status bar. If there isn't one, statusBar() creates an empty status bar, and if necessary a tool tip group too. +.PP +See also menuBar() and toolTipGroup(). +.PP +Example: qfd/qfd.cpp. +.SH "void QMainWindow::toolBarPositionChanged ( QToolBar * )\fC [signal]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QPtrList<QToolBar> QMainWindow::toolBars ( Dock dock ) const" +Returns a list of all the toolbars which are in the \fIdock\fR dock area, regardless of their state. +.PP +For example, the TornOff dock area may contain closed toolbars but these are returned along with the visible toolbars. +.PP +See also dockWindows(). +.SH "bool QMainWindow::toolBarsMovable () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QToolTipGroup * QMainWindow::toolTipGroup () const" +Returns this main window's tool tip group. If there isn't one, toolTipGroup() creates an empty tool tip group. +.PP +See also menuBar() and statusBar(). +.SH "QDockArea * QMainWindow::topDock () const" +Returns the Top dock area +.PP +See also bottomDock(), leftDock(), and rightDock(). +.SH "bool QMainWindow::usesBigPixmaps () const" +Returns TRUE if big pixmaps are enabled; otherwise returns FALSE. See the "usesBigPixmaps" property for details. +.SH "bool QMainWindow::usesTextLabel () const" +Returns TRUE if text labels for toolbar buttons are enabled; otherwise returns FALSE. See the "usesTextLabel" property for details. +.SH "void QMainWindow::usesTextLabelChanged ( bool )\fC [signal]\fR" +This signal is emitted whenever the setUsesTextLabel() is called with a value different to the current setting. All widgets that should respond to such changes, e.g. toolbar buttons, must connect to this signal. +.SH "void QMainWindow::whatsThis ()\fC [virtual slot]\fR" +Enters 'What's This?' mode and returns immediately. +.PP +This is the same as QWhatsThis::enterWhatsThisMode(), but implemented as a main window object's slot. This way it can easily be used for popup menus, for example: +.PP +.nf +.br + QPopupMenu * help = new QPopupMenu( this ); +.br + help->insertItem( "What's &This", this , SLOT(whatsThis()), SHIFT+Key_F1); +.br +.fi +.PP +See also QWhatsThis::enterWhatsThisMode(). +.SS "Property Documentation" +.SH "bool dockWindowsMovable" +This property holds whether the dock windows are movable. +.PP +If TRUE (the default), the user will be able to move movable dock windows from one QMainWindow dock area to another, including the \fCTearOff\fR area (i.e. where the dock window floats freely as a window in its own right), and the Minimized area (where only the dock window's handle is shown below the menu bar). Moveable dock windows can also be moved within QMainWindow dock areas, i.e. to rearrange them within a dock area. +.PP +If FALSE the user will not be able to move any dock windows. +.PP +By default dock windows are moved transparently (i.e. only an outline rectangle is shown during the drag), but this setting can be changed with setOpaqueMoving(). +.PP +See also setDockEnabled() and opaqueMoving. +.PP +Set this property's value with setDockWindowsMovable() and get this property's value with dockWindowsMovable(). +.SH "bool opaqueMoving" +This property holds whether dock windows are moved opaquely. +.PP +If TRUE the dock windows of the main window are shown opaquely (i.e. it shows the toolbar as it looks when docked) whilst it is being moved. If FALSE (the default) they are shown transparently, (i.e. as an outline rectangle). +.PP +\fBWarning:\fR Opaque moving of toolbars and dockwindows is known to have several problems. We recommend avoiding the use of this feature for the time being. We intend fixing the problems in a future release. +.PP +Set this property's value with setOpaqueMoving() and get this property's value with opaqueMoving(). +.SH "bool rightJustification" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This property holds whether the main window right-justifies its dock windows. +.PP +If disabled (the default), stretchable dock windows are expanded, and non-stretchable dock windows are given the minimum space they need. Since most dock windows are not stretchable, this usually results in an unjustified right edge (or unjustified bottom edge for a vertical dock area). If enabled, the main window will right-justify its dock windows. +.PP +See also QDockWindow::setVerticalStretchable() and QDockWindow::setHorizontalStretchable(). +.PP +Set this property's value with setRightJustification() and get this property's value with rightJustification(). +.SH "bool usesBigPixmaps" +This property holds whether big pixmaps are enabled. +.PP +If FALSE (the default), the tool buttons will use small pixmaps; otherwise big pixmaps will be used. +.PP +Tool buttons and other widgets that wish to respond to this setting are responsible for reading the correct state on startup, and for connecting to the main window's widget's pixmapSizeChanged() signal. +.PP +Set this property's value with setUsesBigPixmaps() and get this property's value with usesBigPixmaps(). +.SH "bool usesTextLabel" +This property holds whether text labels for toolbar buttons are enabled. +.PP +If disabled (the default), the tool buttons will not use text labels. If enabled, text labels will be used. +.PP +Tool buttons and other widgets that wish to respond to this setting are responsible for reading the correct state on startup, and for connecting to the main window's widget's usesTextLabelChanged() signal. +.PP +See also QToolButton::usesTextLabel. +.PP +Set this property's value with setUsesTextLabel() and get this property's value with usesTextLabel(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QTextStream & operator<< ( QTextStream & ts, const QMainWindow & mainWindow )" +Writes the layout (sizes and positions) of the dock windows in the dock areas of the QMainWindow \fImainWindow\fR, including Minimized and TornOff dock windows, to the text stream \fIts\fR. +.PP +This can be used, for example, in conjunction with QSettings to save the user's layout when the \\mainWindow receives a closeEvent. +.PP +See also operator>>() and closeEvent(). +.SH "QTextStream & operator>> ( QTextStream & ts, QMainWindow & mainWindow )" +Reads the layout (sizes and positions) of the dock windows in the dock areas of the QMainWindow \fImainWindow\fR from the text stream, \fIts\fR, including Minimized and TornOff dock windows. Restores the dock windows and dock areas to these sizes and positions. The layout information must be in the format produced by operator<<(). +.PP +This can be used, for example, in conjunction with QSettings to restore the user's layout. +.PP +See also operator<<(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmainwindow.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmainwindow.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmap.3qt b/doc/man/man3/tqmap.3qt new file mode 100644 index 000000000..e7cc4ebf6 --- /dev/null +++ b/doc/man/man3/tqmap.3qt @@ -0,0 +1,554 @@ +'\" t +.TH QMap 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 +QMap \- Value-based template class that provides a dictionary +.SH SYNOPSIS +\fC#include <ntqmap.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef Key \fBkey_type\fR" +.br +.ti -1c +.BI "typedef T \fBmapped_type\fR" +.br +.ti -1c +.BI "typedef QPair<const key_type, mapped_type> \fBvalue_type\fR" +.br +.ti -1c +.BI "typedef value_type * \fBpointer\fR" +.br +.ti -1c +.BI "typedef const value_type * \fBconst_pointer\fR" +.br +.ti -1c +.BI "typedef value_type & \fBreference\fR" +.br +.ti -1c +.BI "typedef const value_type & \fBconst_reference\fR" +.br +.ti -1c +.BI "typedef size_t \fBsize_type\fR" +.br +.ti -1c +.BI "typedef QMapIterator<Key, T> \fBiterator\fR" +.br +.ti -1c +.BI "typedef QMapConstIterator<Key, T> \fBconst_iterator\fR" +.br +.ti -1c +.BI "typedef QPair<iterator, bool> \fBinsert_pair\fR" +.br +.ti -1c +.BI "typedef QMapIterator<Key, T> \fBIterator\fR" +.br +.ti -1c +.BI "typedef QMapConstIterator<Key, T> \fBConstIterator\fR" +.br +.ti -1c +.BI "typedef T \fBValueType\fR" +.br +.ti -1c +.BI "\fBQMap\fR ()" +.br +.ti -1c +.BI "\fBQMap\fR ( const QMap<Key, T> & m )" +.br +.ti -1c +.BI "\fBQMap\fR ( const std::map<Key, T> & m )" +.br +.ti -1c +.BI "\fB~QMap\fR ()" +.br +.ti -1c +.BI "QMap<Key, T> & \fBoperator=\fR ( const QMap<Key, T> & m )" +.br +.ti -1c +.BI "QMap<Key, T> & \fBoperator=\fR ( const std::map<Key, T> & m )" +.br +.ti -1c +.BI "iterator \fBbegin\fR ()" +.br +.ti -1c +.BI "iterator \fBend\fR ()" +.br +.ti -1c +.BI "const_iterator \fBbegin\fR () const" +.br +.ti -1c +.BI "const_iterator \fBend\fR () const" +.br +.ti -1c +.BI "const_iterator \fBconstBegin\fR () const" +.br +.ti -1c +.BI "const_iterator \fBconstEnd\fR () const" +.br +.ti -1c +.BI "iterator \fBreplace\fR ( const Key & k, const T & v )" +.br +.ti -1c +.BI "size_type \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBempty\fR () const" +.br +.ti -1c +.BI "QPair<iterator, bool> \fBinsert\fR ( const value_type & x )" +.br +.ti -1c +.BI "void \fBerase\fR ( iterator it )" +.br +.ti -1c +.BI "void \fBerase\fR ( const key_type & k )" +.br +.ti -1c +.BI "size_type \fBcount\fR ( const key_type & k ) const" +.br +.ti -1c +.BI "T & \fBoperator[]\fR ( const Key & k )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "iterator \fBfind\fR ( const Key & k )" +.br +.ti -1c +.BI "const_iterator \fBfind\fR ( const Key & k ) const" +.br +.ti -1c +.BI "const T & \fBoperator[]\fR ( const Key & k ) const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const Key & k ) const" +.br +.ti -1c +.BI "size_type \fBcount\fR () const" +.br +.ti -1c +.BI "QValueList<Key> \fBkeys\fR () const" +.br +.ti -1c +.BI "QValueList<T> \fBvalues\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "iterator \fBinsert\fR ( const Key & key, const T & value, bool overwrite = TRUE )" +.br +.ti -1c +.BI "void \fBremove\fR ( iterator it )" +.br +.ti -1c +.BI "void \fBremove\fR ( const Key & k )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBdetach\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QMap<Key, T> & m )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QMap<Key, T> & m )" +.br +.in -1c +.SH DESCRIPTION +The QMap class is a value-based template class that provides a dictionary. +.PP +QMap is a Qt implementation of an STL-like map container. It can be used in your application if the standard \fCmap\fR is not available on all your target platforms. QMap is part of the Qt Template Library. +.PP +QMap<Key, Data> defines a template instance to create a dictionary with keys of type Key and values of type Data. QMap does not store pointers to the members of the map; instead, it holds a copy of every member. For this reason, QMap is value-based, whereas QPtrList and QDict are pointer-based. +.PP +QMap contains and manages a collection of objects of type Data with associated key values of type Key and provides iterators that allow the contained objects to be addressed. QMap owns the contained items. +.PP +Some classes cannot be used within a QMap. For example everything derived from QObject and thus all classes that implement widgets. Only values can be used in a QMap. To qualify as a value, the class must provide +.TP +A copy constructor +.TP +An assignment operator +.TP +A default constructor, i.e. a constructor that does not take any arguments. +.PP +Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases, this is sufficient. +.PP +The class used for the key requires that the \fCoperator<\fR is implemented to define ordering of the keys. +.PP +QMap's function naming is consistent with the other Qt classes (e.g., count(), isEmpty()). QMap also provides extra functions for compatibility with STL algorithms, such as size() and empty(). Programmers already familiar with the STL \fCmap\fR can use these the STL-like functions if preferred. +.PP +Example: +.PP +.nf +.br + #include <ntqstring.h> +.br + #include <ntqmap.h> +.br + #include <ntqstring.h> +.br +.br + class Employee +.br + { +.br + public: +.br + Employee(): sn(0) {} +.br + Employee( const QString& forename, const QString& surname, int salary ) +.br + : fn(forename), sn(surname), sal(salary) +.br + { } +.br +.br + QString forename() const { return fn; } +.br + QString surname() const { return sn; } +.br + int salary() const { return sal; } +.br + void setSalary( int salary ) { sal = salary; } +.br +.br + private: +.br + QString fn; +.br + QString sn; +.br + int sal; +.br + }; +.br +.br + int main(int argc, char **argv) +.br + { +.br + QApplication app( argc, argv ); +.br +.br + typedef QMap<QString, Employee> EmployeeMap; +.br + EmployeeMap map; +.br +.br + map["JD001"] = Employee("John", "Doe", 50000); +.br + map["JW002"] = Employee("Jane", "Williams", 80000); +.br + map["TJ001"] = Employee("Tom", "Jones", 60000); +.br +.br + Employee sasha( "Sasha", "Hind", 50000 ); +.br + map["SH001"] = sasha; +.br + sasha.setSalary( 40000 ); +.br +.br + EmployeeMap::Iterator it; +.br + for ( it = map.begin(); it != map.end(); ++it ) { +.br + printf( "%s: %s, %s earns %d\\n", +.br + it.key().latin1(), +.br + it.data().surname().latin1(), +.br + it.data().forename().latin1(), +.br + it.data().salary() ); +.br + } +.br + return 0; +.br + } +.br +.fi +.PP +Program output: +.PP +.nf +.br + JD001: Doe, John earns 50000 +.br + JW002: Williams, Jane earns 80000 +.br + SH001: Hind, Sasha earns 50000 +.br + TJ001: Jones, Tom earns 60000 +.br +.fi +.PP +The latest changes to Sasha's salary did not affect the value in the list because the map created a copy of Sasha's entry. In addition, notice that the items are sorted alphabetically (by key) when iterating over the map. +.PP +There are several ways to find items in a map. The begin() and end() functions return iterators to the beginning and end of the map. The advantage of using an iterator is that you can move forward or backward by incrementing/decrementing the iterator. The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the map it belongs to, however it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. If the map is empty, the iterator returned by begin() will equal the iterator returned by end(). +.PP +Another way to find an element in the map is by using the find() function. This returns an iterator pointing to the desired item or to the end() iterator if no such element exists. +.PP +Another approach uses the operator[]. But be warned: if the map does not contain an entry for the element you are looking for, operator[] inserts a default value. If you do not know that the element you are searching for is really in the list, you should not use operator[]. The following example illustrates this: +.PP +.nf +.br + QMap<QString,QString> map; +.br + map["Clinton"] = "Bill"; +.br + str << map["Clinton"] << map["Bush"] << endl; +.br +.fi +.PP +The code fragment will print out "Clinton", "". Since the value associated with the "Bush" key did not exist, the map inserted a default value (in this case, an empty string). If you are not sure whether a certain element is in the map, you should use find() and iterators instead. +.PP +If you just want to know whether a certain key is contained in the map, use the contains() function. In addition, count() tells you how many keys are in the map. +.PP +It is safe to have multiple iterators at the same time. If some member of the map is removed, only iterators pointing to the removed member become invalid; inserting in the map does not invalidate any iterators. +.PP +Since QMap is value-based, there is no need to be concerned about deleting items in the map. The map holds its own copies and will free them if the corresponding member or the map itself is deleted. +.PP +QMap is implicitly shared. This means you can just make copies of the map in time O(1). If multiple QMap instances share the same data and one is modifying the map's data, this modifying instance makes a copy and modifies its private copy: so it does not affect other instances. If a QMap is being used in a multi-threaded program, you must protect all access to the map. See QMutex. +.PP +There are a couple of ways of inserting new items into the map. One uses the insert() method; the other uses operator[]: +.PP +.nf +.br + QMap<QString, QString> map; +.br + map["Clinton"] = "Bill"; +.br + map.insert( "Bush", "George" ); +.br +.fi +.PP +Items can also be removed from the map in several ways. One way is to pass an iterator to remove(). Another way is to pass a key value to remove(), which will delete the entry with the requested key. In addition you can clear the entire map using the clear() method. +.PP +See also QMapIterator, Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QMap::ConstIterator" +The map's const iterator type, Qt style. +.SH "QMap::Iterator" +The map's iterator type, Qt style. +.SH "QMap::ValueType" +Corresponds to QPair<key_type, mapped_type>, Qt style. +.SH "QMap::const_iterator" +The map's const iterator type. +.SH "QMap::const_pointer" +Const pointer to value_type. +.SH "QMap::const_reference" +Const reference to value_type. +.SH "QMap::iterator" +The map's iterator type. +.SH "QMap::key_type" +The map's key type. +.SH "QMap::mapped_type" +The map's data type. +.SH "QMap::pointer" +Pointer to value_type. +.SH "QMap::reference" +Reference to value_type. +.SH "QMap::size_type" +An unsigned integral type, used to represent various sizes. +.SH "QMap::value_type" +Corresponds to QPair<key_type, mapped_type>. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMap::QMap ()" +Constructs an empty map. +.SH "QMap::QMap ( const QMap<Key, T> & m )" +Constructs a copy of \fIm\fR. +.PP +This operation costs O(1) time because QMap is implicitly shared. This makes returning a QMap from a function very fast. If a shared instance is modified, it will be copied (copy-on-write), and this takes O(n) time. +.SH "QMap::QMap ( const std::map<Key, T> & m )" +Constructs a copy of \fIm\fR. +.SH "QMap::~QMap ()" +Destroys the map. References to the values in the map and all iterators of this map become invalidated. Since QMap is highly tuned for performance you won't see warnings if you use invalid iterators, because it is not possible for an iterator to check whether it is valid or not. +.SH "iterator QMap::begin ()" +Returns an iterator pointing to the first element in the map. This iterator equals end() if the map is empty. +.PP +The items in the map are traversed in the order defined by operator<(Key, Key). +.PP +See also end() and QMapIterator. +.SH "const_iterator QMap::begin () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also end() and QMapConstIterator. +.SH "void QMap::clear ()" +Removes all items from the map. +.PP +See also remove(). +.SH "const_iterator QMap::constBegin () const" +Returns an iterator pointing to the first element in the map. This iterator equals end() if the map is empty. +.PP +The items in the map are traversed in the order defined by operator<(Key, Key). +.PP +See also constEnd() and QMapConstIterator. +.SH "const_iterator QMap::constEnd () const" +The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the map it belongs to, but it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. +.PP +This iterator equals constBegin() if the map is empty. +.PP +See also constBegin() and QMapConstIterator. +.SH "bool QMap::contains ( const Key & k ) const" +Returns TRUE if the map contains an item with key \fIk\fR; otherwise returns FALSE. +.SH "size_type QMap::count ( const key_type & k ) const" +Returns the number of items whose key is \fIk\fR. Since QMap does not allow duplicate keys, the return value is always 0 or 1. +.PP +This function is provided for STL compatibility. +.SH "size_type QMap::count () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the number of items in the map. +.PP +See also isEmpty(). +.SH "void QMap::detach ()\fC [protected]\fR" +If the map does not share its data with another QMap instance, nothing happens; otherwise the function creates a new copy of this map and detaches from the shared one. This function is called whenever the map is modified. The implicit sharing mechanism is implemented this way. +.SH "bool QMap::empty () const" +Returns TRUE if the map contains no items; otherwise returns FALSE. +.PP +This function is provided for STL compatibility. It is equivalent to isEmpty(). +.PP +See also size(). +.SH "iterator QMap::end ()" +The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the map it belongs to, but it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. +.PP +This iterator equals begin() if the map is empty. +.PP +See also begin() and QMapIterator. +.SH "const_iterator QMap::end () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QMap::erase ( iterator it )" +Removes the item associated with the iterator \fIit\fR from the map. +.PP +This function is provided for STL compatibility. It is equivalent to remove(). +.PP +See also clear(). +.SH "void QMap::erase ( const key_type & k )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes the item with the key \fIk\fR from the map. +.SH "iterator QMap::find ( const Key & k )" +Returns an iterator pointing to the element with key \fIk\fR in the map. +.PP +Returns end() if no key matched. +.PP +See also QMapIterator. +.SH "const_iterator QMap::find ( const Key & k ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an iterator pointing to the element with key \fIk\fR in the map. +.PP +Returns end() if no key matched. +.PP +See also QMapConstIterator. +.SH "iterator QMap::insert ( const Key & key, const T & value, bool overwrite = TRUE )" +Inserts a new item with the key, \fIkey\fR, and a value of \fIvalue\fR. If there is already an item whose key is \fIkey\fR, that item's value is replaced with \fIvalue\fR, unless \fIoverwrite\fR is FALSE (it is TRUE by default). In this case an iterator to this item is returned, else an iterator to the new item is returned. +.SH "QPair<iterator, bool> QMap::insert ( const value_type & x )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the (key, value) pair \fIx\fR into the map. \fIx\fR is a QPair whose \fCfirst\fR element is a key to be inserted and whose \fCsecond\fR element is the associated value to be inserted. Returns a pair whose \fCfirst\fR element is an iterator pointing to the inserted item and whose \fCsecond\fR element is a bool indicating TRUE if \fIx\fR was inserted and FALSE if it was not inserted, e.g. because it was already present. +.PP +See also replace(). +.SH "bool QMap::isEmpty () const" +Returns TRUE if the map contains no items; otherwise returns FALSE. +.PP +See also count(). +.SH "QValueList<Key> QMap::keys () const" +Returns a list of all the keys in the map, in order. +.SH "QMap<Key, T> & QMap::operator= ( const QMap<Key, T> & m )" +Assigns \fIm\fR to this map and returns a reference to this map. +.PP +All iterators of the current map become invalidated by this operation. The cost of such an assignment is O(1), because QMap is implicitly shared. +.SH "QMap<Key, T> & QMap::operator= ( const std::map<Key, T> & m )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns \fIm\fR to this map and returns a reference to this map. +.PP +All iterators of the current map become invalidated by this operation. +.SH "T & QMap::operator[] ( const Key & k )" +Returns the value associated with the key \fIk\fR. If no such key is present, an empty item is inserted with this key and a reference to the empty item is returned. +.PP +You can use this operator both for reading and writing: +.PP +.nf +.br + QMap<QString, QString> map; +.br + map["Clinton"] = "Bill"; +.br + stream << map["Clinton"]; +.br +.fi +.SH "const T & QMap::operator[] ( const Key & k ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBWarning:\fR This function differs from the non-const version of the same function. It will \fInot\fR insert an empty value if the key \fIk\fR does not exist. This may lead to logic errors in your program. You should check if the element exists before calling this function. +.PP +Returns the value associated with the key \fIk\fR. If no such key is present, a reference to an empty item is returned. +.SH "void QMap::remove ( iterator it )" +Removes the item associated with the iterator \fIit\fR from the map. +.PP +See also clear(). +.SH "void QMap::remove ( const Key & k )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes the item with the key \fIk\fR from the map. +.SH "iterator QMap::replace ( const Key & k, const T & v )" +Replaces the value of the element with key \fIk\fR, with the value \fIv\fR. +.PP +See also insert() and remove(). +.SH "size_type QMap::size () const" +Returns the number of items in the map. +.PP +This function is provided for STL compatibility. It is equivalent to count(). +.PP +See also empty(). +.SH "QValueList<T> QMap::values () const" +Returns a list of all the values in the map, in key order. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QMap<Key, T> & m )" +Writes the map \fIm\fR to the stream \fIs\fR. The types \fIKey\fR and \fIT\fR must implement the streaming operator as well. +.SH "QDataStream & operator>> ( QDataStream & s, QMap<Key, T> & m )" +Reads the map \fIm\fR from the stream \fIs\fR. The types \fIKey\fR and \fIT\fR +must implement the streaming operator as well. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmapconstiterator.3qt b/doc/man/man3/tqmapconstiterator.3qt new file mode 100644 index 000000000..f9e3d04cd --- /dev/null +++ b/doc/man/man3/tqmapconstiterator.3qt @@ -0,0 +1,141 @@ +'\" t +.TH QMapConstIterator 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 +QMapConstIterator \- Iterator for QMap +.SH SYNOPSIS +\fC#include <ntqmap.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef std::bidirectional_iterator_tag \fBiterator_category\fR" +.br +.ti -1c +.BI "typedef T \fBvalue_type\fR" +.br +.ti -1c +.BI "typedef const T * \fBpointer\fR" +.br +.ti -1c +.BI "typedef const T & \fBreference\fR" +.br +.ti -1c +.BI "\fBQMapConstIterator\fR ()" +.br +.ti -1c +.BI "\fBQMapConstIterator\fR ( QMapNode<K, T> * p )" +.br +.ti -1c +.BI "\fBQMapConstIterator\fR ( const QMapConstIterator<K, T> & it )" +.br +.ti -1c +.BI "\fBQMapConstIterator\fR ( const QMapIterator<K, T> & it )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QMapConstIterator<K, T> & it ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QMapConstIterator<K, T> & it ) const" +.br +.ti -1c +.BI "const T & \fBoperator*\fR () const" +.br +.ti -1c +.BI "const K & \fBkey\fR () const" +.br +.ti -1c +.BI "const T & \fBdata\fR () const" +.br +.ti -1c +.BI "QMapConstIterator<K, T> & \fBoperator++\fR ()" +.br +.ti -1c +.BI "QMapConstIterator<K, T> \fBoperator++\fR ( int )" +.br +.ti -1c +.BI "QMapConstIterator<K, T> & \fBoperator--\fR ()" +.br +.ti -1c +.BI "QMapConstIterator<K, T> \fBoperator--\fR ( int )" +.br +.in -1c +.SH DESCRIPTION +The QMapConstIterator class provides an iterator for QMap. +.PP +In contrast to QMapIterator, this class is used to iterate over a const map. It does not allow you to modify the values of the map because this would break the const semantics. +.PP +For more information on QMap iterators, see QMapIterator and the QMap example. +.PP +See also QMap, QMapIterator, Qt Template Library Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QMapConstIterator::iterator_category" +The type of iterator category, \fCstd::bidirectional_iterator_tag\fR. +.SH "QMapConstIterator::pointer" +Const pointer to value_type. +.SH "QMapConstIterator::reference" +Const reference to value_type. +.SH "QMapConstIterator::value_type" +The type of const value. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMapConstIterator::QMapConstIterator ()" +Constructs an uninitialized iterator. +.SH "QMapConstIterator::QMapConstIterator ( QMapNode<K, T> * p )" +Constructs an iterator starting at node \fIp\fR. +.SH "QMapConstIterator::QMapConstIterator ( const QMapConstIterator<K, T> & it )" +Constructs a copy of the iterator, \fIit\fR. +.SH "QMapConstIterator::QMapConstIterator ( const QMapIterator<K, T> & it )" +Constructs a copy of the iterator, \fIit\fR. +.SH "const T & QMapConstIterator::data () const" +Returns a const reference to the current item's data. +.SH "const K & QMapConstIterator::key () const" +Returns a const reference to the current item's key. +.SH "bool QMapConstIterator::operator!= ( const QMapConstIterator<K, T> & it ) const" +Compares the iterator to the \fIit\fR iterator and returns FALSE if they point to the same item; otherwise returns TRUE. +.SH "const T & QMapConstIterator::operator* () const" +Dereference operator. Returns a const reference to the current item's data. The same as data(). +.SH "QMapConstIterator<K, T> & QMapConstIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. +.SH "QMapConstIterator<K, T> QMapConstIterator::operator++ ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. +.SH "QMapConstIterator<K, T> & QMapConstIterator::operator-- ()" +Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. +.SH "QMapConstIterator<K, T> QMapConstIterator::operator-- ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. +.SH "bool QMapConstIterator::operator== ( const QMapConstIterator<K, T> & it ) const" +Compares the iterator to the \fIit\fR iterator and returns TRUE if +they point to the same item; otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmapconstiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmapconstiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmapiterator.3qt b/doc/man/man3/tqmapiterator.3qt new file mode 100644 index 000000000..17cd56303 --- /dev/null +++ b/doc/man/man3/tqmapiterator.3qt @@ -0,0 +1,152 @@ +'\" t +.TH QMapIterator 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 +QMapIterator \- Iterator for QMap +.SH SYNOPSIS +\fC#include <ntqmap.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef std::bidirectional_iterator_tag \fBiterator_category\fR" +.br +.ti -1c +.BI "typedef T \fBvalue_type\fR" +.br +.ti -1c +.BI "typedef T * \fBpointer\fR" +.br +.ti -1c +.BI "typedef T & \fBreference\fR" +.br +.ti -1c +.BI "\fBQMapIterator\fR ()" +.br +.ti -1c +.BI "\fBQMapIterator\fR ( QMapNode<K, T> * p )" +.br +.ti -1c +.BI "\fBQMapIterator\fR ( const QMapIterator<K, T> & it )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QMapIterator<K, T> & it ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QMapIterator<K, T> & it ) const" +.br +.ti -1c +.BI "T & \fBoperator*\fR ()" +.br +.ti -1c +.BI "const T & \fBoperator*\fR () const" +.br +.ti -1c +.BI "const K & \fBkey\fR () const" +.br +.ti -1c +.BI "T & \fBdata\fR ()" +.br +.ti -1c +.BI "const T & \fBdata\fR () const" +.br +.ti -1c +.BI "QMapIterator<K, T> & \fBoperator++\fR ()" +.br +.ti -1c +.BI "QMapIterator<K, T> \fBoperator++\fR ( int )" +.br +.ti -1c +.BI "QMapIterator<K, T> & \fBoperator--\fR ()" +.br +.ti -1c +.BI "QMapIterator<K, T> \fBoperator--\fR ( int )" +.br +.in -1c +.SH DESCRIPTION +The QMapIterator class provides an iterator for QMap. +.PP +You cannot create an iterator by yourself. Instead, you must ask a map to give you one. An iterator is as big as a pointer; on 32-bit machines that means 4 bytes, on 64-bit machines, 8 bytes. That makes copying iterators very fast. Iterators behave in a similar way to pointers, and they are almost as fast as pointers. See the QMap example. +.PP +QMap is highly optimized for performance and memory usage, but the trade-off is that you must be more careful. The only way to traverse a map is to use iterators. QMap does not know about its iterators, and the iterators don't even know to which map they belong. That makes things fast but a bit dangerous because it is up to you to make sure that the iterators you are using are still valid. QDictIterator will be able to give warnings, whereas QMapIterator may end up in an undefined state. +.PP +For every Iterator there is also a ConstIterator. You must use the ConstIterator to access a QMap in a const environment or if the reference or pointer to the map is itself const. Its semantics are the same, but it only returns const references to the item it points to. +.PP +See also QMap, QMapConstIterator, Qt Template Library Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QMapIterator::iterator_category" +The type of iterator category, \fCstd::bidirectional_iterator_tag\fR. +.SH "QMapIterator::pointer" +Pointer to value_type. +.SH "QMapIterator::reference" +Reference to value_type. +.SH "QMapIterator::value_type" +The type of value. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMapIterator::QMapIterator ()" +Creates an uninitialized iterator. +.SH "QMapIterator::QMapIterator ( QMapNode<K, T> * p )" +Constructs an iterator starting at node \fIp\fR. +.SH "QMapIterator::QMapIterator ( const QMapIterator<K, T> & it )" +Constructs a copy of the iterator, \fIit\fR. +.SH "T & QMapIterator::data ()" +Returns a reference to the current item's data. +.SH "const T & QMapIterator::data () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const reference to the current item's data. +.SH "const K & QMapIterator::key () const" +Returns a const reference to the current item's key. +.SH "bool QMapIterator::operator!= ( const QMapIterator<K, T> & it ) const" +Compares the iterator to the \fIit\fR iterator and returns FALSE if they point to the same item; otherwise returns TRUE. +.SH "T & QMapIterator::operator* ()" +Dereference operator. Returns a reference to the current item's data. The same as data(). +.SH "const T & QMapIterator::operator* () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Dereference operator. Returns a const reference to the current item's data. The same as data(). +.SH "QMapIterator<K, T> & QMapIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. +.SH "QMapIterator<K, T> QMapIterator::operator++ ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results. +.SH "QMapIterator<K, T> & QMapIterator::operator-- ()" +Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. +.SH "QMapIterator<K, T> QMapIterator::operator-- ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results. +.SH "bool QMapIterator::operator== ( const QMapIterator<K, T> & it ) const" +Compares the iterator to the \fIit\fR iterator and returns TRUE if +they point to the same item; otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmapiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmapiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmemarray.3qt b/doc/man/man3/tqmemarray.3qt new file mode 100644 index 000000000..ee598135f --- /dev/null +++ b/doc/man/man3/tqmemarray.3qt @@ -0,0 +1,571 @@ +'\" t +.TH QMemArray 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 +QMemArray \- Template class that provides arrays of simple types +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqmemarray.h>\fR +.PP +Inherited by QByteArray and QPointArray. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef type * \fBIterator\fR" +.br +.ti -1c +.BI "typedef const type * \fBConstIterator\fR" +.br +.ti -1c +.BI "\fBQMemArray\fR ()" +.br +.ti -1c +.BI "\fBQMemArray\fR ( int size )" +.br +.ti -1c +.BI "\fBQMemArray\fR ( const QMemArray<type> & a )" +.br +.ti -1c +.BI "\fB~QMemArray\fR ()" +.br +.ti -1c +.BI "QMemArray<type> & \fBoperator=\fR ( const QMemArray<type> & a )" +.br +.ti -1c +.BI "type * \fBdata\fR () const" +.br +.ti -1c +.BI "uint \fBnrefs\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBresize\fR ( uint size )" +.br +.ti -1c +.BI "bool \fBresize\fR ( uint size, Optimization optim )" +.br +.ti -1c +.BI "bool \fBtruncate\fR ( uint pos )" +.br +.ti -1c +.BI "bool \fBfill\fR ( const type & v, int size = -1 )" +.br +.ti -1c +.BI "virtual void \fBdetach\fR ()" +.br +.ti -1c +.BI "QMemArray<type> \fBcopy\fR () const" +.br +.ti -1c +.BI "QMemArray<type> & \fBassign\fR ( const QMemArray<type> & a )" +.br +.ti -1c +.BI "QMemArray<type> & \fBassign\fR ( const type * data, uint size )" +.br +.ti -1c +.BI "QMemArray<type> & \fBduplicate\fR ( const QMemArray<type> & a )" +.br +.ti -1c +.BI "QMemArray<type> & \fBduplicate\fR ( const type * data, uint size )" +.br +.ti -1c +.BI "QMemArray<type> & \fBsetRawData\fR ( const type * data, uint size )" +.br +.ti -1c +.BI "void \fBresetRawData\fR ( const type * data, uint size )" +.br +.ti -1c +.BI "int \fBfind\fR ( const type & v, uint index = 0 ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( const type & v ) const" +.br +.ti -1c +.BI "void \fBsort\fR ()" +.br +.ti -1c +.BI "int \fBbsearch\fR ( const type & v ) const" +.br +.ti -1c +.BI "type & \fBoperator[]\fR ( int index ) const" +.br +.ti -1c +.BI "type & \fBat\fR ( uint index ) const" +.br +.ti -1c +.BI "\fBoperator const type *\fR () const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QMemArray<type> & a ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QMemArray<type> & a ) const" +.br +.ti -1c +.BI "Iterator \fBbegin\fR ()" +.br +.ti -1c +.BI "Iterator \fBend\fR ()" +.br +.ti -1c +.BI "ConstIterator \fBbegin\fR () const" +.br +.ti -1c +.BI "ConstIterator \fBend\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQMemArray\fR ( int, int )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "TQ_UINT16 \fBqChecksum\fR ( const char * data, uint len )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QByteArray & a )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QByteArray & a )" +.br +.in -1c +.SH DESCRIPTION +The QMemArray class is a template class that provides arrays of simple types. +.PP +QMemArray is implemented as a template class. Define a template instance QMemArray<X> to create an array that contains X items. +.PP +QMemArray stores the array elements directly in the array. It can only deal with simple types (i.e. C++ types, structs, and classes that have no constructors, destructors, or virtual functions). QMemArray uses bitwise operations to copy and compare array elements. +.PP +The QPtrVector collection class is also a kind of array. Like most collection classes, it uses pointers to the contained items. +.PP +QMemArray uses explicit sharing with a reference count. If more than one array shares common data and one of the arrays is modified, all the arrays are modified. +.PP +The benefit of sharing is that a program does not need to duplicate data when it is not required, which results in lower memory use and less copying of data. +.PP +An alternative to QMemArray is QValueVector. The QValueVector class also provides an array of objects, but can deal with objects that have constructors (specifically a copy constructor and a default constructor). QValueVector provides an STL-compatible syntax and is implicitly shared. +.PP +Example: +.PP +.nf +.br + #include <ntqmemarray.h> +.br + #include <stdio.h> +.br +.br + QMemArray<int> fib( int num ) // returns fibonacci array +.br + { +.br + Q_ASSERT( num > 2 ); +.br + QMemArray<int> f( num ); // array of ints +.br +.br + f[0] = f[1] = 1; +.br + for ( int i = 2; i < num; i++ ) +.br + f[i] = f[i-1] + f[i-2]; +.br +.br + return f; +.br + } +.br +.br + int main() +.br + { +.br + QMemArray<int> a = fib( 6 ); // get first 6 fibonaccis +.br + for ( int i = 0; i < a.size(); i++ ) +.br + tqDebug( "%d: %d", i, a[i] ); +.br +.br + tqDebug( "1 is found %d times", a.contains(1) ); +.br + tqDebug( "5 is found at index %d", a.find(5) ); +.br +.br + return 0; +.br + } +.br +.fi +.PP +Program output: +.PP +.nf +.br + 0: 1 +.br + 1: 1 +.br + 2: 2 +.br + 3: 3 +.br + 4: 5 +.br + 5: 8 +.br + 1 is found 2 times +.br + 5 is found at index 4 +.br +.fi +.PP +Note concerning the use of QMemArray for manipulating structs or classes: Compilers will often pad the size of structs of odd sizes up to the nearest word boundary. This will then be the size QMemArray will use for its bitwise element comparisons. Because the remaining bytes will typically be uninitialized, this can cause find() etc. to fail to find the element. Example: +.PP +.nf +.br + // MyStruct may be padded to 4 or 8 bytes +.br + struct MyStruct +.br + { +.br + short i; // 2 bytes +.br + char c; // 1 byte +.br + }; +.br +.br + QMemArray<MyStruct> a(1); +.br + a[0].i = 5; +.br + a[0].c = 't'; +.br +.br + MyStruct x; +.br + x.i = '5'; +.br + x.c = 't'; +.br + int i = a.find( x ); // may return -1 if the pad bytes differ +.br +.fi +.PP +To work around this, make sure that you use a struct where sizeof() returns the same as the sum of the sizes of the members either by changing the types of the struct members or by adding dummy members. +.PP +QMemArray data can be traversed by iterators (see begin() and end()). The number of items is returned by count(). The array can be resized with resize() and filled using fill(). +.PP +You can make a shallow copy of the array with assign() (or operator=()) and a deep copy with duplicate(). +.PP +Search for values in the array with find() and contains(). For sorted arrays (see sort()) you can search using bsearch(). +.PP +You can set the data directly using setRawData() and resetRawData(), although this requires care. +.PP +See also Shared Classes and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QMemArray::ConstIterator" +A const QMemArray iterator. +.PP +See also begin() and end(). +.SH "QMemArray::Iterator" +A QMemArray iterator. +.PP +See also begin() and end(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMemArray::QMemArray ( int, int )\fC [protected]\fR" +Constructs an array \fIwithout allocating\fR array space. The arguments should be (0, 0). Use at your own risk. +.SH "QMemArray::QMemArray ()" +Constructs a null array. +.PP +See also isNull(). +.SH "QMemArray::QMemArray ( int size )" +Constructs an array with room for \fIsize\fR elements. Makes a null array if \fIsize\fR == 0. +.PP +The elements are left uninitialized. +.PP +See also resize() and isNull(). +.SH "QMemArray::QMemArray ( const QMemArray<type> & a )" +Constructs a shallow copy of \fIa\fR. +.PP +See also assign(). +.SH "QMemArray::~QMemArray ()" +Dereferences the array data and deletes it if this was the last reference. +.SH "QMemArray<type> & QMemArray::assign ( const QMemArray<type> & a )" +Shallow copy. Dereferences the current array and references the data contained in \fIa\fR instead. Returns a reference to this array. +.PP +See also operator=(). +.SH "QMemArray<type> & QMemArray::assign ( const type * data, uint size )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Shallow copy. Dereferences the current array and references the array data \fIdata\fR, which contains \fIsize\fR elements. Returns a reference to this array. +.PP +Do not delete \fIdata\fR later; QMemArray will call free() on it at the right time. +.SH "type & QMemArray::at ( uint index ) const" +Returns a reference to the element at position \fIindex\fR in the array. +.PP +This can be used to both read and set an element. +.PP +See also operator[](). +.SH "Iterator QMemArray::begin ()" +Returns an iterator pointing at the beginning of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. +.SH "ConstIterator QMemArray::begin () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const iterator pointing at the beginning of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. +.SH "int QMemArray::bsearch ( const type & v ) const" +In a sorted array (as sorted by sort()), finds the first occurrence of \fIv\fR by using a binary search. For a sorted array this is generally much faster than find(), which does a linear search. +.PP +Returns the position of \fIv\fR, or -1 if \fIv\fR could not be found. +.PP +See also sort() and find(). +.SH "int QMemArray::contains ( const type & v ) const" +Returns the number of times \fIv\fR occurs in the array. +.PP +See also find(). +.SH "QMemArray<type> QMemArray::copy () const" +Returns a deep copy of this array. +.PP +See also detach() and duplicate(). +.SH "uint QMemArray::count () const" +Returns the same as size(). +.PP +See also size(). +.PP +Example: scribble/scribble.cpp. +.SH "type * QMemArray::data () const" +Returns a pointer to the actual array data. +.PP +The array is a null array if data() == 0 (null pointer). +.PP +See also isNull(). +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and network/networkprotocol/nntp.cpp. +.SH "void QMemArray::detach ()\fC [virtual]\fR" +Detaches this array from shared array data; i.e. it makes a private, deep copy of the data. +.PP +Copying will be performed only if the reference count is greater than one. +.PP +See also copy(). +.PP +Reimplemented in QBitArray. +.SH "QMemArray<type> & QMemArray::duplicate ( const QMemArray<type> & a )" +Deep copy. Dereferences the current array and obtains a copy of the data contained in \fIa\fR instead. Returns a reference to this array. +.PP +See also copy(). +.SH "QMemArray<type> & QMemArray::duplicate ( const type * data, uint size )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Deep copy. Dereferences the current array and obtains a copy of the array data \fIdata\fR instead. Returns a reference to this array. The size of the array is given by \fIsize\fR. +.PP +See also copy(). +.SH "Iterator QMemArray::end ()" +Returns an iterator pointing behind the last element of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. +.SH "ConstIterator QMemArray::end () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const iterator pointing behind the last element of this array. This iterator can be used in the same way as the iterators of QValueList and QMap, for example. +.SH "bool QMemArray::fill ( const type & v, int size = -1 )" +Fills the array with the value \fIv\fR. If \fIsize\fR is specified as different from -1, then the array will be resized before being filled. +.PP +Returns TRUE if successful, i.e. if \fIsize\fR is -1, or \fIsize\fR is != -1 and the memory can be allocated; otherwise returns FALSE. +.PP +See also resize(). +.SH "int QMemArray::find ( const type & v, uint index = 0 ) const" +Finds the first occurrence of \fIv\fR, starting at position \fIindex\fR. +.PP +Returns the position of \fIv\fR, or -1 if \fIv\fR could not be found. +.PP +See also contains(). +.SH "bool QMemArray::isEmpty () const" +Returns TRUE if the array is empty; otherwise returns FALSE. +.PP +isEmpty() is equivalent to isNull() for QMemArray (unlike QString). +.SH "bool QMemArray::isNull () const" +Returns TRUE if the array is null; otherwise returns FALSE. +.PP +A null array has size() == 0 and data() == 0. +.SH "uint QMemArray::nrefs () const" +Returns the reference count for the shared array data. This reference count is always greater than zero. +.SH "QMemArray::operator const type * () const" +Cast operator. Returns a pointer to the array. +.PP +See also data(). +.SH "bool QMemArray::operator!= ( const QMemArray<type> & a ) const" +Returns TRUE if this array is different from \fIa\fR; otherwise returns FALSE. +.PP +The two arrays are compared bitwise. +.PP +See also operator==(). +.SH "QMemArray<type> & QMemArray::operator= ( const QMemArray<type> & a )" +Assigns a shallow copy of \fIa\fR to this array and returns a reference to this array. +.PP +Equivalent to assign( a ). +.SH "bool QMemArray::operator== ( const QMemArray<type> & a ) const" +Returns TRUE if this array is equal to \fIa\fR; otherwise returns FALSE. +.PP +The two arrays are compared bitwise. +.PP +See also operator!=(). +.SH "type & QMemArray::operator[] ( int index ) const" +Returns a reference to the element at position \fIindex\fR in the array. +.PP +This can be used to both read and set an element. Equivalent to at(). +.PP +See also at(). +.SH "void QMemArray::resetRawData ( const type * data, uint size )" +Removes internal references to the raw data that was set using setRawData(). This means that QMemArray no longer has access to the \fIdata\fR, so you are free to manipulate \fIdata\fR as you wish. You can now use the QMemArray without affecting the original \fIdata\fR, for example by calling setRawData() with a pointer to some other data. +.PP +The arguments must be the \fIdata\fR and length, \fIsize\fR, that were passed to setRawData(). This is for consistency checking. +.PP +See also setRawData(). +.SH "bool QMemArray::resize ( uint size, Optimization optim )" +Resizes (expands or shrinks) the array to \fIsize\fR elements. The array becomes a null array if \fIsize\fR == 0. +.PP +Returns TRUE if successful, or FALSE if the memory cannot be allocated. +.PP +New elements are not initialized. +.PP +\fIoptim\fR is either \fCQGArray::MemOptim\fR (the default) or \fCQGArray::SpeedOptim\fR. +.PP +\fBNote:\fR By default, \fCSpeedOptim\fR is not available for general use since it is only available if Qt is built in a particular configuration. +.PP +See also size(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QMemArray::resize ( uint size )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Resizes (expands or shrinks) the array to \fIsize\fR elements. The array becomes a null array if \fIsize\fR == 0. +.PP +Returns TRUE if successful, i.e. if the memory can be allocated; otherwise returns FALSE. +.PP +New elements are not initialized. +.PP +See also size(). +.SH "QMemArray<type> & QMemArray::setRawData ( const type * data, uint size )" +Sets raw data and returns a reference to the array. +.PP +Dereferences the current array and sets the new array data to \fIdata\fR and the new array size to \fIsize\fR. Do not attempt to resize or re-assign the array data when raw data has been set. Call resetRawData(\fIdata\fR, \fIsize\fR) to reset the array. +.PP +Setting raw data is useful because it sets QMemArray data without allocating memory or copying data. +.PP +Example I (intended use): +.PP +.nf +.br + static char bindata[] = { 231, 1, 44, ... }; +.br + QByteArray a; +.br + a.setRawData( bindata, sizeof(bindata) ); // a points to bindata +.br + QDataStream s( a, IO_ReadOnly ); // open on a's data +.br + s >> <something>; // read raw bindata +.br + a.resetRawData( bindata, sizeof(bindata) ); // finished +.br +.fi +.PP +Example II (you don't want to do this): +.PP +.nf +.br + static char bindata[] = { 231, 1, 44, ... }; +.br + QByteArray a, b; +.br + a.setRawData( bindata, sizeof(bindata) ); // a points to bindata +.br + a.resize( 8 ); // will crash +.br + b = a; // will crash +.br + a[2] = 123; // might crash +.br + // forget to resetRawData: will crash +.br +.fi +.PP +\fBWarning:\fR If you do not call resetRawData(), QMemArray will attempt to deallocate or reallocate the raw data, which might not be too good. Be careful. +.PP +See also resetRawData(). +.SH "uint QMemArray::size () const" +Returns the size of the array (maximum number of elements). +.PP +The array is a null array if size() == 0. +.PP +See also isNull() and resize(). +.SH "void QMemArray::sort ()" +Sorts the array elements in ascending order, using bitwise comparison (memcmp()). +.PP +See also bsearch(). +.SH "bool QMemArray::truncate ( uint pos )" +Truncates the array at position \fIpos\fR. +.PP +Returns TRUE if successful, i.e. if the memory can be allocated; otherwise returns FALSE. +.PP +Equivalent to resize(\fIpos\fR). +.PP +See also resize(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QByteArray & a )" +Writes byte array \fIa\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QByteArray & a )" +Reads a byte array into \fIa\fR from the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "TQ_UINT16 tqChecksum ( const char * data, uint len )" +Returns the CRC-16 checksum of \fIlen\fR bytes starting at \fIdata\fR. +.PP +The checksum is independent of the byte order (endianness). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmemarray.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmemarray.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmenubar.3qt b/doc/man/man3/tqmenubar.3qt new file mode 100644 index 000000000..ad542f03a --- /dev/null +++ b/doc/man/man3/tqmenubar.3qt @@ -0,0 +1,588 @@ +'\" t +.TH QMenuBar 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 +QMenuBar \- Horizontal menu bar +.SH SYNOPSIS +\fC#include <ntqmenubar.h>\fR +.PP +Inherits QFrame and QMenuData. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMenuBar\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QMenuBar\fR ()" +.br +.ti -1c +.BI "virtual void \fBshow\fR ()" +.br +.ti -1c +.BI "virtual void \fBhide\fR ()" +.br +.ti -1c +.BI "virtual int \fBheightForWidth\fR ( int max_width ) const" +.br +.ti -1c +.BI "enum \fBSeparator\fR { Never = 0, InWindowsStyle = 1 }" +.br +.ti -1c +.BI "Separator separator () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void setSeparator ( Separator when ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetDefaultUp\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisDefaultUp\fR () const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBactivated\fR ( int id )" +.br +.ti -1c +.BI "void \fBhighlighted\fR ( int id )" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( QWidget * widget, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( QCustomMenuItem * custom, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertSeparator\fR ( int index = -1 )" +.br +.ti -1c +.BI "void \fBremoveItem\fR ( int id )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "bool \fBisItemEnabled\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" +.br +.ti -1c +.BI "bool \fBisItemVisible\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemVisible\fR ( int id, bool visible )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBdefaultUp\fR - the popup orientation" +.br +.ti -1c +.BI "Separator separator - in which cases a menubar sparator is drawn \fI(obsolete)\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * p )" +.br +.ti -1c +.BI "virtual void \fBmenuContentsChanged\fR ()" +.br +.ti -1c +.BI "virtual void \fBmenuStateChanged\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QMenuBar class provides a horizontal menu bar. +.PP +A menu bar consists of a list of pull-down menu items. You add menu items with insertItem(). For example, asuming that \fCmenubar\fR is a pointer to a QMenuBar and \fCfilemenu\fR is a pointer to a QPopupMenu, the following statement inserts the menu into the menu bar: +.PP +.nf +.br + menubar->insertItem( "&File", filemenu ); +.br +.fi +The ampersand in the menu item's text sets Alt+F as a shortcut for this menu. (You can use "&&" to get a real ampersand in the menu bar.) +.PP +Items are either enabled or disabled. You toggle their state with setItemEnabled(). +.PP +There is no need to lay out a menu bar. It automatically sets its own geometry to the top of the parent widget and changes it appropriately whenever the parent is resized. +.PP +Example of creating a menu bar with menu items (from menu/menu.cpp): +.PP +.nf +.br + QPopupMenu *file = new QPopupMenu( this ); +.fi +.PP +.nf +.br + file->insertItem( p1, "&Open", this, SLOT(open()), CTRL+Key_O ); +.br + file->insertItem( p2, "&New", this, SLOT(news()), CTRL+Key_N ); +.fi +.PP +.nf +.br + menu = new QMenuBar( this ); +.fi +.PP +.nf +.br + menu->insertItem( "&File", file ); +.fi +.PP +In most main window style applications you would use the menuBar() provided in QMainWindow, adding QPopupMenus to the menu bar and adding QActions to the popup menus. +.PP +Example (from action/application.cpp): +.PP +.nf +.br + QPopupMenu * file = new QPopupMenu( this ); +.br + menuBar()->insertItem( "&File", file ); +.br + fileNewAction->addTo( file ); +.fi +.PP +Menu items can have text and pixmaps (or iconsets), see the various insertItem() overloads, as well as separators, see insertSeparator(). You can also add custom menu items that are derived from QCustomMenuItem. +.PP +Menu items may be removed with removeItem() and enabled or disabled with setItemEnabled(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +.SH "QMenuBar on Qt/Mac" +QMenuBar on Qt/Mac is a wrapper for using the system-wide menubar. If you have multiple menubars in one dialog the outermost menubar (normally inside a widget with widget flag WType_TopLevel) will be used for the system-wide menubar. +.PP +Note that arbitrary Qt widgets \fIcannot\fR be inserted into a QMenuBar on the Mac because Qt uses Mac's native menus which don't support this functionality. This limitation does not apply to stand-alone QPopupMenus. +.PP +Qt/Mac also provides a menubar merging feature to make QMenuBar conform more closely to accepted Mac OS X menubar layout. The merging functionality is based on string matching the title of a QPopupMenu entry. These strings are translated (using QObject::tr()) in the "QMenuBar" context. If an entry is moved its slots will still fire as if it was in the original place. The table below outlines the strings looked for and where the entry is placed if matched: +.PP +<center>.nf +.TS +l - l. String matches Placement Notes about.* Application Menu | About If this entry is not found no About item will appear in the Application Menu config, options, setup, settings or preferences Application Menu | Preferences If this entry is not found the Settings item will be disabled quit or exit Application Menu | Quit If this entry is not found a default Quit item will be created to call +.TE +.fi +</center> +.PP +menu/menu.cpp is an example of QMenuBar and QPopupMenu use. +.PP +See also QPopupMenu, QAccel, QAction, Aqua Style Guidelines, GUI Design Handbook: Menu Bar, and Main Window and Related Classes. +.SS "Member Type Documentation" +.SH "QMenuBar::Separator" +This enum type is used to decide whether QMenuBar should draw a separator line at its bottom. +.TP +\fCQMenuBar::Never\fR - In many applications there is already a separator, and having two looks wrong. +.TP +\fCQMenuBar::InWindowsStyle\fR - In some other applications a separator looks good in Windows style, but nowhere else. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMenuBar::QMenuBar ( QWidget * parent = 0, const char * name = 0 )" +Constructs a menu bar called \fIname\fR with parent \fIparent\fR. +.SH "QMenuBar::~QMenuBar ()" +Destroys the menu bar. +.SH "void QMenuBar::activated ( int id )\fC [signal]\fR" +This signal is emitted when a menu item is selected; \fIid\fR is the id of the selected item. +.PP +Normally you will connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is useful in such cases. +.PP +See also highlighted() and QMenuData::insertItem(). +.PP +Example: progress/progress.cpp. +.SH "void QMenuData::clear ()" +Removes all menu items. +.PP +See also removeItem() and removeItemAt(). +.PP +Examples: +.)l mdi/application.cpp and qwerty/qwerty.cpp. +.SH "void QMenuBar::drawContents ( QPainter * p )\fC [virtual protected]\fR" +Called from QFrame::paintEvent(). Draws the menu bar contents using painter \fIp\fR. +.PP +Reimplemented from QFrame. +.SH "int QMenuBar::heightForWidth ( int max_width ) const\fC [virtual]\fR" +Returns the height that the menu would resize itself to if its parent (and hence itself) resized to the given \fImax_width\fR. This can be useful for simple layout tasks in which the height of the menu bar is needed after items have been inserted. See showimg/showimg.cpp for an example of the usage. +.PP +Example: showimg/showimg.cpp. +.PP +Reimplemented from QWidget. +.SH "void QMenuBar::hide ()\fC [virtual]\fR" +Reimplements QWidget::hide() in order to deselect any selected item, and calls setUpLayout() for the main window. +.PP +Example: grapher/grapher.cpp. +.PP +Reimplemented from QWidget. +.SH "void QMenuBar::highlighted ( int id )\fC [signal]\fR" +This signal is emitted when a menu item is highlighted; \fIid\fR is the id of the highlighted item. +.PP +Normally, you will connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is useful in such cases. +.PP +See also activated() and QMenuData::insertItem(). +.SH "int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +The family of insertItem() functions inserts menu items into a popup menu or a menu bar. +.PP +A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus. +.PP +Some insertItem() members take a popup menu as an additional argument. Use this to insert submenus into existing menus or pulldown menus into a menu bar. +.PP +The number of insert functions may look confusing, but they are actually quite simple to use. +.PP +This default version inserts a menu item with the text \fItext\fR, the accelerator key \fIaccel\fR, an id and an optional index and connects it to the slot \fImember\fR in the object \fIreceiver\fR. +.PP +Example: +.PP +.nf +.br + QMenuBar *mainMenu = new QMenuBar; +.br + QPopupMenu *fileMenu = new QPopupMenu; +.br + fileMenu->insertItem( "New", myView, SLOT(newFile()), CTRL+Key_N ); +.br + fileMenu->insertItem( "Open", myView, SLOT(open()), CTRL+Key_O ); +.br + mainMenu->insertItem( "File", fileMenu ); +.br +.fi +.PP +Not all insert functions take an object/slot parameter or an accelerator key. Use connectItem() and setAccel() on those items. +.PP +If you need to translate accelerators, use tr() with the text and accelerator. (For translations use a string key sequence.): +.PP +.nf +.br + fileMenu->insertItem( tr("Open"), myView, SLOT(open()), +.br + tr("Ctrl+O") ); +.br +.fi +.PP +In the example above, pressing Ctrl+O or selecting "Open" from the menu activates the myView->open() function. +.PP +Some insert functions take a QIconSet parameter to specify the little menu item icon. Note that you can always pass a QPixmap object instead. +.PP +The \fIid\fR specifies the identification number associated with the menu item. Note that only positive values are valid, as a negative value will make Qt select a unique id for the item. +.PP +The \fIindex\fR specifies the position in the menu. The menu item is appended at the end of the list if \fIindex\fR is negative. +.PP +Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. +.PP +\fBWarning:\fR Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g. \fC(QObject*)0\fR. +.PP +\fBWarning:\fR On Mac OS X, items that connect to a slot that are inserted into a menubar will not function as we use the native menubar that knows nothing about signals or slots. Instead insert the items into a popup menu and insert the popup menu into the menubar. This may be fixed in a future Qt version. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.PP +Examples: +.)l addressbook/mainwindow.cpp, canvas/canvas.cpp, menu/menu.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the \fImember\fR slot in the \fIreceiver\fR object. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.SH "int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item that consists of the widget \fIwidget\fR with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +Ownership of \fIwidget\fR is transferred to the popup menu or to the menu bar. +.PP +Theoretically, any widget can be inserted into a popup menu. In practice, this only makes sense with certain widgets. +.PP +If a widget is not focus-enabled (see QWidget::isFocusEnabled()), the menu treats it as a separator; this means that the item is not selectable and will never get focus. In this way you can, for example, simply insert a QLabel if you need a popup menu with a title. +.PP +If the widget is focus-enabled it will get focus when the user traverses the popup menu with the arrow keys. If the widget does not accept \fCArrowUp\fR and \fCArrowDown\fR in its key event handler, the focus will move back to the menu when the respective arrow key is hit one more time. This works with a QLineEdit, for example. If the widget accepts the arrow key itself, it must also provide the possibility to put the focus back on the menu again by calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu when the user made a selection, this can be done safely by calling: +.PP +.nf +.br + if ( isVisible() && +.br + parentWidget() && +.br + parentWidget()->inherits("QPopupMenu") ) +.br + parentWidget()->close(); +.br +.fi +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a custom menu item \fIcustom\fR with an \fIicon\fR and with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. +.PP +If you want to connect a custom item to a slot, use connectItem(). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also connectItem(), removeItem(), and QCustomMenuItem. +.SH "int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a custom menu item \fIcustom\fR with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. +.PP +If you want to connect a custom item to a slot, use connectItem(). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also connectItem(), removeItem(), and QCustomMenuItem. +.SH "int QMenuData::insertSeparator ( int index = -1 )" +Inserts a separator at position \fIindex\fR, and returns the menu identifier number allocated to it. The separator becomes the last menu item if \fIindex\fR is negative. +.PP +In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guidelines). +.PP +Examples: +.)l addressbook/mainwindow.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. +.SH "bool QMenuBar::isDefaultUp () const" +Returns the popup orientation. See the "defaultUp" property for details. +.SH "bool QMenuData::isItemEnabled ( int id ) const" +Returns TRUE if the item with identifier \fIid\fR is enabled; otherwise returns FALSE +.PP +See also setItemEnabled() and isItemVisible(). +.SH "bool QMenuData::isItemVisible ( int id ) const" +Returns TRUE if the menu item with the id \fIid\fR is visible; otherwise returns FALSE. +.PP +See also setItemVisible(). +.SH "void QMenuBar::menuContentsChanged ()\fC [virtual protected]\fR" +Recomputes the menu bar's display data according to the new contents. +.PP +You should never need to call this; it is called automatically by QMenuData whenever it needs to be called. +.PP +Reimplemented from QMenuData. +.SH "void QMenuBar::menuStateChanged ()\fC [virtual protected]\fR" +Recomputes the menu bar's display data according to the new state. +.PP +You should never need to call this; it is called automatically by QMenuData whenever it needs to be called. +.PP +Reimplemented from QMenuData. +.SH "void QMenuData::removeItem ( int id )" +Removes the menu item that has the identifier \fIid\fR. +.PP +See also removeItemAt() and clear(). +.PP +Example: chart/chartform.cpp. +.SH "Separator QMenuBar::separator () const" +Returns in which cases a menubar sparator is drawn. See the "separator" property for details. +.SH "void QMenuBar::setDefaultUp ( bool )" +Sets the popup orientation. See the "defaultUp" property for details. +.SH "void QMenuData::setItemEnabled ( int id, bool enable )" +If \fIenable\fR is TRUE, enables the menu item with identifier \fIid\fR; otherwise disables the menu item with identifier \fIid\fR. +.PP +See also isItemEnabled(). +.PP +Examples: +.)l mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, and showimg/showimg.cpp. +.SH "void QMenuData::setItemVisible ( int id, bool visible )" +If \fIvisible\fR is TRUE, shows the menu item with id \fIid\fR; otherwise hides the menu item with id \fIid\fR. +.PP +See also isItemVisible() and isItemEnabled(). +.SH "void QMenuBar::setSeparator ( Separator when )\fC [virtual]\fR" +Sets in which cases a menubar sparator is drawn to \fIwhen\fR. See the "separator" property for details. +.SH "void QMenuBar::show ()\fC [virtual]\fR" +Reimplements QWidget::show() in order to set up the correct keyboard accelerators and to raise itself to the top of the widget stack. +.PP +Example: grapher/grapher.cpp. +.PP +Reimplemented from QWidget. +.SS "Property Documentation" +.SH "bool defaultUp" +This property holds the popup orientation. +.PP +The default popup orientation. By default, menus pop "down" the screen. By setting the property to TRUE, the menu will pop "up". You might call this for menus that are \fIbelow\fR the document to which they refer. +.PP +If the menu would not fit on the screen, the other direction is used automatically. +.PP +Set this property's value with setDefaultUp() and get this property's value with isDefaultUp(). +.SH "Separator separator" +This property holds in which cases a menubar sparator is drawn. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Set this property's value with setSeparator() and get this property's value with separator(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmenubar.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmenubar.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmenudata.3qt b/doc/man/man3/tqmenudata.3qt new file mode 100644 index 000000000..f0044f254 --- /dev/null +++ b/doc/man/man3/tqmenudata.3qt @@ -0,0 +1,707 @@ +'\" t +.TH QMenuData 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 +QMenuData \- Base class for QMenuBar and QPopupMenu +.SH SYNOPSIS +\fC#include <ntqmenudata.h>\fR +.PP +Inherited by QMenuBar and QPopupMenu. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMenuData\fR ()" +.br +.ti -1c +.BI "virtual \fB~QMenuData\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( QWidget * widget, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( QCustomMenuItem * custom, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertSeparator\fR ( int index = -1 )" +.br +.ti -1c +.BI "void \fBremoveItem\fR ( int id )" +.br +.ti -1c +.BI "void \fBremoveItemAt\fR ( int index )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "QKeySequence \fBaccel\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetAccel\fR ( const QKeySequence & key, int id )" +.br +.ti -1c +.BI "QIconSet * \fBiconSet\fR ( int id ) const" +.br +.ti -1c +.BI "QString \fBtext\fR ( int id ) const" +.br +.ti -1c +.BI "QPixmap * \fBpixmap\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetWhatsThis\fR ( int id, const QString & text )" +.br +.ti -1c +.BI "QString \fBwhatsThis\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QString & text )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QPixmap & pixmap )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QString & text )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QPixmap & pixmap )" +.br +.ti -1c +.BI "void changeItem ( const QString & text, int id ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void changeItem ( const QPixmap & pixmap, int id ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void changeItem ( const QIconSet & icon, const QString & text, int id ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBisItemActive\fR ( int id ) const" +.br +.ti -1c +.BI "bool \fBisItemEnabled\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" +.br +.ti -1c +.BI "bool \fBisItemChecked\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemChecked\fR ( int id, bool check )" +.br +.ti -1c +.BI "bool \fBisItemVisible\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemVisible\fR ( int id, bool visible )" +.br +.ti -1c +.BI "virtual void \fBupdateItem\fR ( int id )" +.br +.ti -1c +.BI "int \fBindexOf\fR ( int id ) const" +.br +.ti -1c +.BI "int \fBidAt\fR ( int index ) const" +.br +.ti -1c +.BI "virtual void \fBsetId\fR ( int index, int id )" +.br +.ti -1c +.BI "bool \fBconnectItem\fR ( int id, const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "bool \fBdisconnectItem\fR ( int id, const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "bool \fBsetItemParameter\fR ( int id, int param )" +.br +.ti -1c +.BI "int \fBitemParameter\fR ( int id ) const" +.br +.ti -1c +.BI "QMenuItem * \fBfindItem\fR ( int id ) const" +.br +.ti -1c +.BI "QMenuItem * \fBfindItem\fR ( int id, QMenuData ** parent ) const" +.br +.ti -1c +.BI "virtual void \fBactivateItemAt\fR ( int index )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBmenuContentsChanged\fR ()" +.br +.ti -1c +.BI "virtual void \fBmenuStateChanged\fR ()" +.br +.ti -1c +.BI "virtual void \fBmenuInsPopup\fR ( QPopupMenu * )" +.br +.ti -1c +.BI "virtual void \fBmenuDelPopup\fR ( QPopupMenu * )" +.br +.in -1c +.SH DESCRIPTION +The QMenuData class is a base class for QMenuBar and QPopupMenu. +.PP +QMenuData has an internal list of menu items. A menu item can have a text(), an accelerator, a pixmap(), an iconSet(), a whatsThis() text and a popup menu (unless it is a separator). Menu items may optionally be checked (except for separators). +.PP +The menu item sends out an activated() signal when it is chosen and a highlighted() signal when it receives the user input focus. +.PP + +.PP +Menu items are assigned the menu identifier \fIid\fR that is passed in insertItem() or an automatically generated identifier if \fIid\fR is < 0 (the default). The generated identifiers (negative integers) are guaranteed to be unique within the entire application. The identifier is used to access the menu item in other functions. +.PP +Menu items can be removed with removeItem() and removeItemAt(), or changed with changeItem(). All menu items can be removed with clear(). Accelerators can be changed or set with setAccel(). Checkable items can be checked or unchecked with setItemChecked(). Items can be enabled or disabled using setItemEnabled() and connected and disconnected with connectItem() and disconnectItem() respectively. By default, newly created menu items are visible. They can be hidden (and shown again) with setItemVisible(). +.PP +Menu items are stored in a list. Use findItem() to find an item by its list position or by its menu identifier. (See also indexOf() and idAt().) +.PP +See also QAccel, QPopupMenu, QAction, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMenuData::QMenuData ()" +Constructs an empty menu data list. +.SH "QMenuData::~QMenuData ()\fC [virtual]\fR" +Removes all menu items and disconnects any signals that have been connected. +.SH "QKeySequence QMenuData::accel ( int id ) const" +Returns the accelerator key that has been defined for the menu item \fIid\fR, or 0 if it has no accelerator key or if there is no such menu item. +.PP +See also setAccel(), QAccel, and ntqnamespace.h. +.SH "void QMenuData::activateItemAt ( int index )\fC [virtual]\fR" +Activates the menu item at position \fIindex\fR. +.PP +If the index is invalid (for example, -1), the object itself is deactivated. +.SH "void QMenuData::changeItem ( int id, const QString & text )" +Changes the text of the menu item \fIid\fR to \fItext\fR. If the item has an icon, the icon remains unchanged. +.PP +See also text(). +.SH "void QMenuData::changeItem ( int id, const QPixmap & pixmap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Changes the pixmap of the menu item \fIid\fR to the pixmap \fIpixmap\fR. If the item has an icon, the icon is unchanged. +.PP +See also pixmap(). +.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QString & text )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Changes the iconset and text of the menu item \fIid\fR to the \fIicon\fR and \fItext\fR respectively. +.PP +See also pixmap(). +.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QPixmap & pixmap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Changes the iconset and pixmap of the menu item \fIid\fR to \fIicon\fR and \fIpixmap\fR respectively. +.PP +See also pixmap(). +.SH "void QMenuData::changeItem ( const QString & text, int id )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Changes the text of the menu item \fIid\fR. If the item has an icon, the icon remains unchanged. +.PP +See also text(). +.SH "void QMenuData::changeItem ( const QPixmap & pixmap, int id )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Changes the pixmap of the menu item \fIid\fR. If the item has an icon, the icon remains unchanged. +.PP +See also pixmap(). +.SH "void QMenuData::changeItem ( const QIconSet & icon, const QString & text, int id )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Changes the icon and text of the menu item \fIid\fR. +.PP +See also pixmap(). +.SH "void QMenuData::clear ()" +Removes all menu items. +.PP +See also removeItem() and removeItemAt(). +.PP +Examples: +.)l mdi/application.cpp and qwerty/qwerty.cpp. +.SH "bool QMenuData::connectItem ( int id, const QObject * receiver, const char * member )" +Connects the menu item with identifier \fIid\fR to \fIreceiver\fR's \fImember\fR slot or signal. +.PP +The receiver's slot (or signal) is activated when the menu item is activated. +.PP +See also disconnectItem() and setItemParameter(). +.PP +Example: menu/menu.cpp. +.SH "uint QMenuData::count () const" +Returns the number of items in the menu. +.SH "bool QMenuData::disconnectItem ( int id, const QObject * receiver, const char * member )" +Disconnects the \fIreceiver\fR's \fImember\fR from the menu item with identifier \fIid\fR. +.PP +All connections are removed when the menu data object is destroyed. +.PP +See also connectItem() and setItemParameter(). +.SH "QMenuItem * QMenuData::findItem ( int id ) const" +Returns the menu item with identifier \fIid\fR, or 0 if there is no item with this identifier. +.PP +Note that QMenuItem is an internal class, and that you should not need to call this function. Use the higher level functions like text(), pixmap() and changeItem() to get and modify menu item attributes instead. +.PP +See also indexOf(). +.PP +Example: chart/chartform.cpp. +.SH "QMenuItem * QMenuData::findItem ( int id, QMenuData ** parent ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the menu item with identifier \fIid\fR, or 0 if there is no item with this identifier. Changes \fI*parent\fR to point to the parent of the return value. +.PP +Note that QMenuItem is an internal class, and that you should not need to call this function. Use the higher level functions like text(), pixmap() and changeItem() to get and modify menu item attributes instead. +.PP +See also indexOf(). +.SH "QIconSet * QMenuData::iconSet ( int id ) const" +Returns the icon set that has been set for menu item \fIid\fR, or 0 if no icon set has been set. +.PP +See also changeItem(), text(), and pixmap(). +.SH "int QMenuData::idAt ( int index ) const" +Returns the identifier of the menu item at position \fIindex\fR in the internal list, or -1 if \fIindex\fR is out of range. +.PP +See also setId() and indexOf(). +.SH "int QMenuData::indexOf ( int id ) const" +Returns the index of the menu item with identifier \fIid\fR, or -1 if there is no item with this identifier. +.PP +See also idAt() and findItem(). +.PP +Example: scrollview/scrollview.cpp. +.SH "int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +The family of insertItem() functions inserts menu items into a popup menu or a menu bar. +.PP +A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus. +.PP +Some insertItem() members take a popup menu as an additional argument. Use this to insert submenus into existing menus or pulldown menus into a menu bar. +.PP +The number of insert functions may look confusing, but they are actually quite simple to use. +.PP +This default version inserts a menu item with the text \fItext\fR, the accelerator key \fIaccel\fR, an id and an optional index and connects it to the slot \fImember\fR in the object \fIreceiver\fR. +.PP +Example: +.PP +.nf +.br + QMenuBar *mainMenu = new QMenuBar; +.br + QPopupMenu *fileMenu = new QPopupMenu; +.br + fileMenu->insertItem( "New", myView, SLOT(newFile()), CTRL+Key_N ); +.br + fileMenu->insertItem( "Open", myView, SLOT(open()), CTRL+Key_O ); +.br + mainMenu->insertItem( "File", fileMenu ); +.br +.fi +.PP +Not all insert functions take an object/slot parameter or an accelerator key. Use connectItem() and setAccel() on those items. +.PP +If you need to translate accelerators, use tr() with the text and accelerator. (For translations use a string key sequence.): +.PP +.nf +.br + fileMenu->insertItem( tr("Open"), myView, SLOT(open()), +.br + tr("Ctrl+O") ); +.br +.fi +.PP +In the example above, pressing Ctrl+O or selecting "Open" from the menu activates the myView->open() function. +.PP +Some insert functions take a QIconSet parameter to specify the little menu item icon. Note that you can always pass a QPixmap object instead. +.PP +The \fIid\fR specifies the identification number associated with the menu item. Note that only positive values are valid, as a negative value will make Qt select a unique id for the item. +.PP +The \fIindex\fR specifies the position in the menu. The menu item is appended at the end of the list if \fIindex\fR is negative. +.PP +Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. +.PP +\fBWarning:\fR Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g. \fC(QObject*)0\fR. +.PP +\fBWarning:\fR On Mac OS X, items that connect to a slot that are inserted into a menubar will not function as we use the native menubar that knows nothing about signals or slots. Instead insert the items into a popup menu and insert the popup menu into the menubar. This may be fixed in a future Qt version. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.PP +Examples: +.)l addressbook/mainwindow.cpp, canvas/canvas.cpp, menu/menu.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the \fImember\fR slot in the \fIreceiver\fR object. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.SH "int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item that consists of the widget \fIwidget\fR with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +Ownership of \fIwidget\fR is transferred to the popup menu or to the menu bar. +.PP +Theoretically, any widget can be inserted into a popup menu. In practice, this only makes sense with certain widgets. +.PP +If a widget is not focus-enabled (see QWidget::isFocusEnabled()), the menu treats it as a separator; this means that the item is not selectable and will never get focus. In this way you can, for example, simply insert a QLabel if you need a popup menu with a title. +.PP +If the widget is focus-enabled it will get focus when the user traverses the popup menu with the arrow keys. If the widget does not accept \fCArrowUp\fR and \fCArrowDown\fR in its key event handler, the focus will move back to the menu when the respective arrow key is hit one more time. This works with a QLineEdit, for example. If the widget accepts the arrow key itself, it must also provide the possibility to put the focus back on the menu again by calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu when the user made a selection, this can be done safely by calling: +.PP +.nf +.br + if ( isVisible() && +.br + parentWidget() && +.br + parentWidget()->inherits("QPopupMenu") ) +.br + parentWidget()->close(); +.br +.fi +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a custom menu item \fIcustom\fR with an \fIicon\fR and with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. +.PP +If you want to connect a custom item to a slot, use connectItem(). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also connectItem(), removeItem(), and QCustomMenuItem. +.SH "int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a custom menu item \fIcustom\fR with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. +.PP +If you want to connect a custom item to a slot, use connectItem(). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also connectItem(), removeItem(), and QCustomMenuItem. +.SH "int QMenuData::insertSeparator ( int index = -1 )" +Inserts a separator at position \fIindex\fR, and returns the menu identifier number allocated to it. The separator becomes the last menu item if \fIindex\fR is negative. +.PP +In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guidelines). +.PP +Examples: +.)l addressbook/mainwindow.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. +.SH "bool QMenuData::isItemActive ( int id ) const" +Returns TRUE if the menu item with the id \fIid\fR is currently active; otherwise returns FALSE. +.SH "bool QMenuData::isItemChecked ( int id ) const" +Returns TRUE if the menu item with the id \fIid\fR has been checked; otherwise returns FALSE. +.PP +See also setItemChecked(). +.PP +Examples: +.)l canvas/canvas.cpp, progress/progress.cpp, and showimg/showimg.cpp. +.SH "bool QMenuData::isItemEnabled ( int id ) const" +Returns TRUE if the item with identifier \fIid\fR is enabled; otherwise returns FALSE +.PP +See also setItemEnabled() and isItemVisible(). +.SH "bool QMenuData::isItemVisible ( int id ) const" +Returns TRUE if the menu item with the id \fIid\fR is visible; otherwise returns FALSE. +.PP +See also setItemVisible(). +.SH "int QMenuData::itemParameter ( int id ) const" +Returns the parameter of the activation signal of item \fIid\fR. +.PP +If no parameter has been specified for this item with setItemParameter(), the value defaults to \fIid\fR. +.PP +See also connectItem(), disconnectItem(), and setItemParameter(). +.SH "void QMenuData::menuContentsChanged ()\fC [virtual protected]\fR" +Virtual function; notifies subclasses that one or more items have been inserted or removed. +.PP +Reimplemented in QMenuBar. +.SH "void QMenuData::menuDelPopup ( QPopupMenu * )\fC [virtual protected]\fR" +Virtual function; notifies subclasses that a popup menu item has been removed. +.SH "void QMenuData::menuInsPopup ( QPopupMenu * )\fC [virtual protected]\fR" +Virtual function; notifies subclasses that a popup menu item has been inserted. +.SH "void QMenuData::menuStateChanged ()\fC [virtual protected]\fR" +Virtual function; notifies subclasses that one or more items have changed state (enabled/disabled or checked/unchecked). +.PP +Reimplemented in QMenuBar. +.SH "QPixmap * QMenuData::pixmap ( int id ) const" +Returns the pixmap that has been set for menu item \fIid\fR, or 0 if no pixmap has been set. +.PP +See also changeItem(), text(), and iconSet(). +.SH "void QMenuData::removeItem ( int id )" +Removes the menu item that has the identifier \fIid\fR. +.PP +See also removeItemAt() and clear(). +.PP +Example: chart/chartform.cpp. +.SH "void QMenuData::removeItemAt ( int index )" +Removes the menu item at position \fIindex\fR. +.PP +See also removeItem() and clear(). +.SH "void QMenuData::setAccel ( const QKeySequence & key, int id )" +Sets the accelerator key for the menu item \fIid\fR to \fIkey\fR. +.PP +An accelerator key consists of a key code and a combination of the modifiers \fCSHIFT\fR, \fCCTRL\fR, \fCALT\fR or \fCUNICODE_ACCEL\fR (OR'ed or added). The header file ntqnamespace.h contains a list of key codes. +.PP +Defining an accelerator key produces a text that is added to the menu item; for instance, \fCCTRL\fR + \fCKey_O\fR produces "Ctrl+O". The text is formatted differently for different platforms. +.PP +Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. +.PP +Example: +.PP +.nf +.br + QMenuBar *mainMenu = new QMenuBar; +.br + QPopupMenu *fileMenu = new QPopupMenu; // file sub menu +.br + fileMenu->insertItem( "Open Document", 67 ); // add "Open" item +.br + fileMenu->setAccel( CTRL + Key_O, 67 ); // Ctrl+O to open +.br + fileMenu->insertItem( "Quit", 69 ); // add "Quit" item +.br + fileMenu->setAccel( CTRL + ALT + Key_Delete, 69 ); // add Alt+Del to quit +.br + mainMenu->insertItem( "File", fileMenu ); // add the file menu +.br +.fi +.PP +If you need to translate accelerators, use tr() with a string: +.PP +.nf +.br + fileMenu->setAccel( tr("Ctrl+O"), 67 ); +.br +.fi +.PP +You can also specify the accelerator in the insertItem() function. You may prefer to use QAction to associate accelerators with menu items. +.PP +See also accel(), insertItem(), QAccel, and QAction. +.PP +Example: menu/menu.cpp. +.SH "void QMenuData::setId ( int index, int id )\fC [virtual]\fR" +Sets the menu identifier of the item at \fIindex\fR to \fIid\fR. +.PP +If \fIindex\fR is out of range, the operation is ignored. +.PP +See also idAt(). +.SH "void QMenuData::setItemChecked ( int id, bool check )" +If \fIcheck\fR is TRUE, checks the menu item with id \fIid\fR; otherwise unchecks the menu item with id \fIid\fR. Calls QPopupMenu::setCheckable( TRUE ) if necessary. +.PP +See also isItemChecked(). +.PP +Examples: +.)l canvas/canvas.cpp, grapher/grapher.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. +.SH "void QMenuData::setItemEnabled ( int id, bool enable )" +If \fIenable\fR is TRUE, enables the menu item with identifier \fIid\fR; otherwise disables the menu item with identifier \fIid\fR. +.PP +See also isItemEnabled(). +.PP +Examples: +.)l mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, and showimg/showimg.cpp. +.SH "bool QMenuData::setItemParameter ( int id, int param )" +Sets the parameter of the activation signal of item \fIid\fR to \fIparam\fR. +.PP +If any receiver takes an integer parameter, this value is passed. +.PP +See also connectItem(), disconnectItem(), and itemParameter(). +.PP +Example: mdi/application.cpp. +.SH "void QMenuData::setItemVisible ( int id, bool visible )" +If \fIvisible\fR is TRUE, shows the menu item with id \fIid\fR; otherwise hides the menu item with id \fIid\fR. +.PP +See also isItemVisible() and isItemEnabled(). +.SH "void QMenuData::setWhatsThis ( int id, const QString & text )" +Sets \fItext\fR as What's This help for the menu item with identifier \fIid\fR. +.PP +See also whatsThis(). +.PP +Examples: +.)l application/application.cpp, helpsystem/mainwindow.cpp, and mdi/application.cpp. +.SH "QString QMenuData::text ( int id ) const" +Returns the text that has been set for menu item \fIid\fR, or QString::null if no text has been set. +.PP +See also changeItem(), pixmap(), and iconSet(). +.PP +Examples: +.)l qdir/qdir.cpp and showimg/showimg.cpp. +.SH "void QMenuData::updateItem ( int id )\fC [virtual]\fR" +Virtual function; notifies subclasses about an item with \fIid\fR that has been changed. +.PP +Reimplemented in QPopupMenu. +.SH "QString QMenuData::whatsThis ( int id ) const" +Returns the What's This help text for the item with identifier \fIid\fR or QString::null if no text has yet been defined. +.PP +See also setWhatsThis(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmenudata.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmenudata.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmessagebox.3qt b/doc/man/man3/tqmessagebox.3qt new file mode 100644 index 000000000..6e9636f9d --- /dev/null +++ b/doc/man/man3/tqmessagebox.3qt @@ -0,0 +1,858 @@ +'\" t +.TH QMessageBox 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 +QMessageBox \- Modal dialog with a short message, an icon, and some buttons +.SH SYNOPSIS +\fC#include <ntqmessagebox.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBIcon\fR { NoIcon = 0, Information = 1, Warning = 2, Critical = 3, Question = 4 }" +.br +.ti -1c +.BI "\fBQMessageBox\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQMessageBox\fR ( const QString & caption, const QString & text, Icon icon, int button0, int button1, int button2, QWidget * parent = 0, const char * name = 0, bool modal = TRUE, WFlags f = WStyle_DialogBorder )" +.br +.ti -1c +.BI "\fB~QMessageBox\fR ()" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "Icon \fBicon\fR () const" +.br +.ti -1c +.BI "void \fBsetIcon\fR ( Icon )" +.br +.ti -1c +.BI "const QPixmap * \fBiconPixmap\fR () const" +.br +.ti -1c +.BI "void \fBsetIconPixmap\fR ( const QPixmap & )" +.br +.ti -1c +.BI "QString \fBbuttonText\fR ( int button ) const" +.br +.ti -1c +.BI "void \fBsetButtonText\fR ( int button, const QString & text )" +.br +.ti -1c +.BI "virtual void \fBadjustSize\fR ()" +.br +.ti -1c +.BI "TextFormat \fBtextFormat\fR () const" +.br +.ti -1c +.BI "void \fBsetTextFormat\fR ( TextFormat )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "int \fBinformation\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )" +.br +.ti -1c +.BI "int \fBinformation\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" +.br +.ti -1c +.BI "int \fBquestion\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )" +.br +.ti -1c +.BI "int \fBquestion\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" +.br +.ti -1c +.BI "int \fBwarning\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )" +.br +.ti -1c +.BI "int \fBwarning\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" +.br +.ti -1c +.BI "int \fBcritical\fR ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )" +.br +.ti -1c +.BI "int \fBcritical\fR ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )" +.br +.ti -1c +.BI "void \fBabout\fR ( QWidget * parent, const QString & caption, const QString & text )" +.br +.ti -1c +.BI "void \fBaboutTQt\fR ( QWidget * parent, const QString & caption = QString::null )" +.br +.ti -1c +.BI "int message ( const QString & caption, const QString & text, const QString & buttonText = QString::null, QWidget * parent = 0, const char * = 0 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool query ( const QString & caption, const QString & text, const QString & yesButtonText = QString::null, const QString & noButtonText = QString::null, QWidget * parent = 0, const char * = 0 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QPixmap standardIcon ( Icon icon, GUIStyle style ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QPixmap \fBstandardIcon\fR ( Icon icon )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "Icon \fBicon\fR - the message box's icon" +.br +.ti -1c +.BI "QPixmap \fBiconPixmap\fR - the current icon" +.br +.ti -1c +.BI "QString \fBtext\fR - the message box text to be displayed" +.br +.ti -1c +.BI "TextFormat \fBtextFormat\fR - the format of the text displayed by the message box" +.br +.in -1c +.SH DESCRIPTION +The QMessageBox class provides a modal dialog with a short message, an icon, and some buttons. +.PP +Message boxes are used to provide informative messages and to ask simple questions. +.PP +QMessageBox provides a range of different messages, arranged roughly along two axes: severity and complexity. +.PP +Severity is <center>.nf +.TS +l - l. Question For message boxes that ask a question as part of normal operation. Some style guides recommend using Information for this purpose. Information For message boxes that are part of normal operation. Warning For message boxes that tell the user about unusual errors. Critical +.TE +.fi +</center> +.PP +The message box has a different icon for each of the severity levels. +.PP +Complexity is one button (OK) for simple messages, or two or even three buttons for questions. +.PP +There are static functions for the most common cases. +.PP +Examples: +.)l +.PP +If a program is unable to find a supporting file, but can do perfectly well without it: +.PP +.nf +.br + QMessageBox::information( this, "Application name", +.br + "Unable to find the user preferences file.\\n" +.br + "The factory default will be used instead." ); +.br +.fi +.PP +question() is useful for simple yes/no questions: +.PP +.nf +.br + if ( QFile::exists( filename ) && +.br + QMessageBox::question( +.br + this, +.br + tr("Overwrite File? -- Application Name"), +.br + tr("A file called %1 already exists." +.br + "Do you want to overwrite it?") +.br + .arg( filename ), +.br + tr("&Yes"), tr("&No"), +.br + QString::null, 0, 1 ) ) +.br + return false; +.br +.fi +.PP +warning() can be used to tell the user about unusual errors, or errors which can't be easily fixed: +.PP +.nf +.br + switch( QMessageBox::warning( this, "Application name", +.br + "Could not connect to the <mumble> server.\\n" +.br + "This program can't function correctly " +.br + "without the server.\\n\\n", +.br + "Retry", +.br + "Quit", 0, 0, 1 ) ) { +.br + case 0: // The user clicked the Retry again button or pressed Enter +.br + // try again +.br + break; +.br + case 1: // The user clicked the Quit or pressed Escape +.br + // exit +.br + break; +.br + } +.br +.fi +.PP +The text part of all message box messages can be either rich text or plain text. If you specify a rich text formatted string, it will be rendered using the default stylesheet. See QStyleSheet::defaultSheet() for details. With certain strings that contain XML meta characters, the auto-rich text detection may fail, interpreting plain text incorrectly as rich text. In these rare cases, use QStyleSheet::convertFromPlainText() to convert your plain text string to a visually equivalent rich text string or set the text format explicitly with setTextFormat(). +.PP +Note that the Microsoft Windows User Interface Guidelines recommend using the application name as the window's caption. +.PP +Below are more examples of how to use the static member functions. After these examples you will find an overview of the non-static member functions. +.PP +Exiting a program is part of its normal operation. If there is unsaved data the user probably should be asked if they want to save the data. For example: +.PP +.nf +.br + switch( QMessageBox::information( this, "Application name here", +.br + "The document contains unsaved changes\\n" +.br + "Do you want to save the changes before exiting?", +.br + "&Save", "&Discard", "Cancel", +.br + 0, // Enter == button 0 +.br + 2 ) ) { // Escape == button 2 +.br + case 0: // Save clicked or Alt+S pressed or Enter pressed. +.br + // save +.br + break; +.br + case 1: // Discard clicked or Alt+D pressed +.br + // don't save but exit +.br + break; +.br + case 2: // Cancel clicked or Escape pressed +.br + // don't exit +.br + break; +.br + } +.br +.fi +.PP +The Escape button cancels the entire exit operation, and pressing Enter causes the changes to be saved before the exit occurs. +.PP +Disk full errors are unusual and they certainly can be hard to correct. This example uses predefined buttons instead of hard-coded button texts: +.PP +.nf +.br + switch( QMessageBox::warning( this, "Application name here", +.br + "Could not save the user preferences,\\n" +.br + "because the disk is full. You can delete\\n" +.br + "some files and press Retry, or you can\\n" +.br + "abort the Save Preferences operation.", +.br + QMessageBox::Retry | QMessageBox::Default, +.br + QMessageBox::Abort | QMessageBox::Escape )) { +.br + case QMessageBox::Retry: // Retry clicked or Enter pressed +.br + // try again +.br + break; +.br + case QMessageBox::Abort: // Abort clicked or Escape pressed +.br + // abort +.br + break; +.br + } +.br +.fi +.PP +The critical() function should be reserved for critical errors. In this example errorDetails is a QString or const char*, and QString is used to concatenate several strings: +.PP +.nf +.br + QMessageBox::critical( 0, "Application name here", +.br + QString("An internal error occurred. Please ") + +.br + "call technical support at 1234-56789 and report\\n"+ +.br + "these numbers:\\n\\n" + errorDetails + +.br + "\\n\\nApplication will now exit." ); +.br +.fi +.PP +In this example an OK button is displayed. +.PP +QMessageBox provides a very simple About box which displays an appropriate icon and the string you provide: +.PP +.nf +.br + QMessageBox::about( this, "About <Application>", +.br + "<Application> is a <one-paragraph blurb>\\n\\n" +.br + "Copyright 1991-2003 Such-and-such. " +.br + "<License words here.>\\n\\n" +.br + "For technical support, call 1234-56789 or see\\n" +.br + "http://www.such-and-such.com/Application/\\n" ); +.br +.fi +.PP +See about() for more information. +.PP +If you want your users to know that the application is built using Qt (so they know that you use high quality tools) you might like to add an "About Qt" menu option under the Help menu to invoke aboutTQt(). +.PP +If none of the standard message boxes is suitable, you can create a QMessageBox from scratch and use custom button texts: +.PP +.nf +.br + QMessageBox mb( "Application name here", +.br + "Saving the file will overwrite the original file on the disk.\\n" +.br + "Do you really want to save?", +.br + QMessageBox::Information, +.br + QMessageBox::Yes | QMessageBox::Default, +.br + QMessageBox::No, +.br + QMessageBox::Cancel | QMessageBox::Escape ); +.br + mb.setButtonText( QMessageBox::Yes, "Save" ); +.br + mb.setButtonText( QMessageBox::No, "Discard" ); +.br + switch( mb.exec() ) { +.br + case QMessageBox::Yes: +.br + // save and exit +.br + break; +.br + case QMessageBox::No: +.br + // exit without saving +.br + break; +.br + case QMessageBox::Cancel: +.br + // don't save and don't exit +.br + break; +.br + } +.br +.fi +.PP +QMessageBox defines two enum types: Icon and an unnamed button type. Icon defines the Question, Information, Warning, and Critical icons for each GUI style. It is used by the constructor and by the static member functions question(), information(), warning() and critical(). A function called standardIcon() gives you access to the various icons. +.PP +The button types are: +.TP +Ok - the default for single-button message boxes +.TP +Cancel - note that this is \fInot\fR automatically Escape +.TP +Yes +.TP +No +.TP +Abort +.TP +Retry +.TP +Ignore +.TP +YesAll +.TP +NoAll +.PP +Button types can be combined with two modifiers by using OR, '|': +.TP +Default - makes pressing Enter equivalent to clicking this button. Normally used with Ok, Yes or similar. +.TP +Escape - makes pressing Escape equivalent to clicking this button. Normally used with Abort, Cancel or similar. +.PP +The text(), icon() and iconPixmap() functions provide access to the current text and pixmap of the message box. The setText(), setIcon() and setIconPixmap() let you change it. The difference between setIcon() and setIconPixmap() is that the former accepts a QMessageBox::Icon and can be used to set standard icons, whereas the latter accepts a QPixmap and can be used to set custom icons. +.PP +setButtonText() and buttonText() provide access to the buttons. +.PP +QMessageBox has no signals or slots. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QDialog, Isys on error messages, GUI Design Handbook: Message Box, and Dialog Classes. +.SS "Member Type Documentation" +.SH "QMessageBox::Icon" +This enum has the following values: +.TP +\fCQMessageBox::NoIcon\fR - the message box does not have any icon. +.TP +\fCQMessageBox::Question\fR - an icon indicating that the message is asking a question. +.TP +\fCQMessageBox::Information\fR - an icon indicating that the message is nothing out of the ordinary. +.TP +\fCQMessageBox::Warning\fR - an icon indicating that the message is a warning, but can be dealt with. +.TP +\fCQMessageBox::Critical\fR - an icon indicating that the message represents a critical problem. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMessageBox::QMessageBox ( QWidget * parent = 0, const char * name = 0 )" +Constructs a message box with no text and a button with the label" OK". +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QDialog constructor. +.SH "QMessageBox::QMessageBox ( const QString & caption, const QString & text, Icon icon, int button0, int button1, int button2, QWidget * parent = 0, const char * name = 0, bool modal = TRUE, WFlags f = WStyle_DialogBorder )" +Constructs a message box with a \fIcaption\fR, a \fItext\fR, an \fIicon\fR, and up to three buttons. +.PP +The \fIicon\fR must be one of the following: +.TP +QMessageBox::NoIcon +.TP +QMessageBox::Question +.TP +QMessageBox::Information +.TP +QMessageBox::Warning +.TP +QMessageBox::Critical +.PP +Each button, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR, can have one of the following values: +.TP +QMessageBox::NoButton +.TP +QMessageBox::Ok +.TP +QMessageBox::Cancel +.TP +QMessageBox::Yes +.TP +QMessageBox::No +.TP +QMessageBox::Abort +.TP +QMessageBox::Retry +.TP +QMessageBox::Ignore +.TP +QMessageBox::YesAll +.TP +QMessageBox::NoAll +.PP +Use QMessageBox::NoButton for the later parameters to have fewer than three buttons in your message box. If you don't specify any buttons at all, QMessageBox will provide an Ok button. +.PP +One of the buttons can be OR-ed with the \fCQMessageBox::Default\fR flag to make it the default button (clicked when Enter is pressed). +.PP +One of the buttons can be OR-ed with the \fCQMessageBox::Escape\fR flag to make it the cancel or close button (clicked when Escape is pressed). +.PP +Example: +.PP +.nf +.br + QMessageBox mb( "Application Name", +.br + "Hardware failure.\\n\\nDisk error detected\\nDo you want to stop?", +.br + QMessageBox::Question, +.br + QMessageBox::Yes | QMessageBox::Default, +.br + QMessageBox::No | QMessageBox::Escape, +.br + QMessageBox::NoButton ); +.br + if ( mb.exec() == QMessageBox::No ) +.br + // try again +.br +.fi +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +If \fImodal\fR is TRUE the message box is modal; otherwise it is modeless. +.PP +The \fIparent\fR, \fIname\fR, \fImodal\fR, and \fIf\fR arguments are passed to the QDialog constructor. +.PP +See also caption, text, and icon. +.SH "QMessageBox::~QMessageBox ()" +Destroys the message box. +.SH "void QMessageBox::about ( QWidget * parent, const QString & caption, const QString & text )\fC [static]\fR" +Displays a simple about box with caption \fIcaption\fR and text \fItext\fR. The about box's parent is \fIparent\fR. +.PP +about() looks for a suitable icon in four locations: <ol type=1> +.TP +It prefers parent->icon() if that exists. +.TP +If not, it tries the top-level widget containing \fIparent\fR. +.TP +If that fails, it tries the main widget. +.TP +As a last resort it uses the Information icon. +.PP +The about box has a single button labelled "OK". +.PP +See also QWidget::icon and QApplication::mainWidget(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, chart/chartform.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, menu/menu.cpp, and themes/themes.cpp. +.SH "void QMessageBox::aboutTQt ( QWidget * parent, const QString & caption = QString::null )\fC [static]\fR" +Displays a simple message box about Qt, with caption \fIcaption\fR and centered over \fIparent\fR (if \fIparent\fR is not 0). The message includes the version number of Qt being used by the application. +.PP +This is useful for inclusion in the Help menu of an application. See the examples/menu/menu.cpp example. +.PP +QApplication provides this functionality as a slot. +.PP +See also QApplication::aboutTQt(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, chart/chartform.cpp, helpviewer/helpwindow.cpp, menu/menu.cpp, themes/themes.cpp, and trivial/trivial.cpp. +.SH "void QMessageBox::adjustSize ()\fC [virtual]\fR" +Adjusts the size of the message box to fit the contents just before QDialog::exec() or QDialog::show() is called. +.PP +This function will not be called if the message box has been explicitly resized before showing it. +.PP +Reimplemented from QWidget. +.SH "QString QMessageBox::buttonText ( int button ) const" +Returns the text of the message box button \fIbutton\fR, or QString::null if the message box does not contain the button. +.PP +See also setButtonText(). +.SH "int QMessageBox::critical ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )\fC [static]\fR" +Opens a critical message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the button parameters, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: +.TP +QMessageBox::NoButton +.TP +QMessageBox::Ok +.TP +QMessageBox::Cancel +.TP +QMessageBox::Yes +.TP +QMessageBox::No +.TP +QMessageBox::Abort +.TP +QMessageBox::Retry +.TP +QMessageBox::Ignore +.TP +QMessageBox::YesAll +.TP +QMessageBox::NoAll +.PP +If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. +.PP +One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. +.PP +Returns the identity (QMessageBox::Ok, or QMessageBox::No, etc.) of the button that was clicked. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +See also information(), question(), and warning(). +.PP +Examples: +.)l network/archivesearch/archivedialog.ui.h, network/ftpclient/ftpmainwindow.ui.h, process/process.cpp, and xml/outliner/outlinetree.cpp. +.SH "int QMessageBox::critical ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Displays a critical error message box with a caption, a text, and 1, 2 or 3 buttons. Returns the number of the button that was clicked (0, 1 or 2). +.PP +\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional, and \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1, or 2 to make pressing Escape equivalent to clicking the relevant button. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +See also information(), question(), and warning(). +.SH "Icon QMessageBox::icon () const" +Returns the message box's icon. See the "icon" property for details. +.SH "const QPixmap * QMessageBox::iconPixmap () const" +Returns the current icon. See the "iconPixmap" property for details. +.SH "int QMessageBox::information ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )\fC [static]\fR" +Opens an information message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the buttons, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: +.TP +QMessageBox::NoButton +.TP +QMessageBox::Ok +.TP +QMessageBox::Cancel +.TP +QMessageBox::Yes +.TP +QMessageBox::No +.TP +QMessageBox::Abort +.TP +QMessageBox::Retry +.TP +QMessageBox::Ignore +.TP +QMessageBox::YesAll +.TP +QMessageBox::NoAll +.PP +If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. +.PP +One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. +.PP +Returns the identity (QMessageBox::Ok, or QMessageBox::No, etc.) of the button that was clicked. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +See also question(), warning(), and critical(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, dirview/dirview.cpp, fileiconview/qfileiconview.cpp, picture/picture.cpp, qwerty/qwerty.cpp, and simple/main.cpp. +.SH "int QMessageBox::information ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Displays an information message box with caption \fIcaption\fR, text \fItext\fR and one, two or three buttons. Returns the index of the button that was clicked (0, 1 or 2). +.PP +\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional. \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1 or 2 to make pressing Escape equivalent to clicking the relevant button. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +Note: If you do not specify an Escape button then if the Escape button is pressed then -1 will be returned. It is suggested that you specify an Escape button to prevent this from happening. +.PP +See also question(), warning(), and critical(). +.SH "int QMessageBox::message ( const QString & caption, const QString & text, const QString & buttonText = QString::null, QWidget * parent = 0, const char * = 0 )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Opens a modal message box directly using the specified parameters. +.PP +Please use information(), warning(), question(), or critical() instead. +.PP +Example: grapher/grapher.cpp. +.SH "bool QMessageBox::query ( const QString & caption, const QString & text, const QString & yesButtonText = QString::null, const QString & noButtonText = QString::null, QWidget * parent = 0, const char * = 0 )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Queries the user using a modal message box with two buttons. Note that \fIcaption\fR is not always shown, it depends on the window manager. +.PP +Please use information(), question(), warning(), or critical() instead. +.SH "int QMessageBox::question ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1 = 0, int button2 = 0 )\fC [static]\fR" +Opens a question message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the buttons, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: +.TP +QMessageBox::NoButton +.TP +QMessageBox::Ok +.TP +QMessageBox::Cancel +.TP +QMessageBox::Yes +.TP +QMessageBox::No +.TP +QMessageBox::Abort +.TP +QMessageBox::Retry +.TP +QMessageBox::Ignore +.TP +QMessageBox::YesAll +.TP +QMessageBox::NoAll +.PP +If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. +.PP +One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. +.PP +Returns the identity (QMessageBox::Yes, or QMessageBox::No, etc.) of the button that was clicked. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +See also information(), warning(), and critical(). +.SH "int QMessageBox::question ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Displays a question message box with caption \fIcaption\fR, text \fItext\fR and one, two or three buttons. Returns the index of the button that was clicked (0, 1 or 2). +.PP +\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional. \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1 or 2 to make pressing Escape equivalent to clicking the relevant button. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +Note: If you do not specify an Escape button then if the Escape button is pressed then -1 will be returned. It is suggested that you specify an Escape button to prevent this from happening. +.PP +See also information(), warning(), and critical(). +.SH "void QMessageBox::setButtonText ( int button, const QString & text )" +Sets the text of the message box button \fIbutton\fR to \fItext\fR. Setting the text of a button that is not in the message box is silently ignored. +.PP +See also buttonText(). +.SH "void QMessageBox::setIcon ( Icon )" +Sets the message box's icon. See the "icon" property for details. +.SH "void QMessageBox::setIconPixmap ( const QPixmap & )" +Sets the current icon. See the "iconPixmap" property for details. +.SH "void QMessageBox::setText ( const QString & )" +Sets the message box text to be displayed. See the "text" property for details. +.SH "void QMessageBox::setTextFormat ( TextFormat )" +Sets the format of the text displayed by the message box. See the "textFormat" property for details. +.SH "QPixmap QMessageBox::standardIcon ( Icon icon )\fC [static]\fR" +Returns the pixmap used for a standard icon. This allows the pixmaps to be used in more complex message boxes. \fIicon\fR specifies the required icon, e.g. QMessageBox::Question, QMessageBox::Information, QMessageBox::Warning or QMessageBox::Critical. +.SH "QPixmap QMessageBox::standardIcon ( Icon icon, GUIStyle style )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the pixmap used for a standard icon. This allows the pixmaps to be used in more complex message boxes. \fIicon\fR specifies the required icon, e.g. QMessageBox::Information, QMessageBox::Warning or QMessageBox::Critical. +.PP +\fIstyle\fR is unused. +.SH "QString QMessageBox::text () const" +Returns the message box text to be displayed. See the "text" property for details. +.SH "TextFormat QMessageBox::textFormat () const" +Returns the format of the text displayed by the message box. See the "textFormat" property for details. +.SH "int QMessageBox::warning ( QWidget * parent, const QString & caption, const QString & text, int button0, int button1, int button2 = 0 )\fC [static]\fR" +Opens a warning message box with the caption \fIcaption\fR and the text \fItext\fR. The dialog may have up to three buttons. Each of the button parameters, \fIbutton0\fR, \fIbutton1\fR and \fIbutton2\fR may be set to one of the following values: +.TP +QMessageBox::NoButton +.TP +QMessageBox::Ok +.TP +QMessageBox::Cancel +.TP +QMessageBox::Yes +.TP +QMessageBox::No +.TP +QMessageBox::Abort +.TP +QMessageBox::Retry +.TP +QMessageBox::Ignore +.TP +QMessageBox::YesAll +.TP +QMessageBox::NoAll +.PP +If you don't want all three buttons, set the last button, or last two buttons to QMessageBox::NoButton. +.PP +One button can be OR-ed with \fCQMessageBox::Default\fR, and one button can be OR-ed with \fCQMessageBox::Escape\fR. +.PP +Returns the identity (QMessageBox::Ok, or QMessageBox::No, etc.) of the button that was clicked. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +See also information(), question(), and critical(). +.PP +Examples: +.)l chart/chartform.cpp, i18n/main.cpp, network/mail/smtp.cpp, qwerty/qwerty.cpp, showimg/showimg.cpp, and sound/sound.cpp. +.SH "int QMessageBox::warning ( QWidget * parent, const QString & caption, const QString & text, const QString & button0Text = QString::null, const QString & button1Text = QString::null, const QString & button2Text = QString::null, int defaultButtonNumber = 0, int escapeButtonNumber = -1 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Displays a warning message box with a caption, a text, and 1, 2 or 3 buttons. Returns the number of the button that was clicked (0, 1, or 2). +.PP +\fIbutton0Text\fR is the text of the first button, and is optional. If \fIbutton0Text\fR is not supplied, "OK" (translated) will be used. \fIbutton1Text\fR is the text of the second button, and is optional, and \fIbutton2Text\fR is the text of the third button, and is optional. \fIdefaultButtonNumber\fR (0, 1 or 2) is the index of the default button; pressing Return or Enter is the same as clicking the default button. It defaults to 0 (the first button). \fIescapeButtonNumber\fR is the index of the Escape button; pressing Escape is the same as clicking this button. It defaults to -1; supply 0, 1, or 2 to make pressing Escape equivalent to clicking the relevant button. +.PP +If \fIparent\fR is 0, the message box becomes an application-global modal dialog box. If \fIparent\fR is a widget, the message box becomes modal relative to \fIparent\fR. +.PP +Note: If you do not specify an Escape button then if the Escape button is pressed then -1 will be returned. It is suggested that you specify an Escape button to prevent this from happening. +.PP +See also information(), question(), and critical(). +.SS "Property Documentation" +.SH "Icon icon" +This property holds the message box's icon. +.PP +The icon of the message box can be one of the following predefined icons: +.TP +QMessageBox::NoIcon +.TP +QMessageBox::Question +.TP +QMessageBox::Information +.TP +QMessageBox::Warning +.TP +QMessageBox::Critical +.PP +The actual pixmap used for displaying the icon depends on the current GUI style. You can also set a custom pixmap icon using the QMessageBox::iconPixmap property. The default icon is QMessageBox::NoIcon. +.PP +See also iconPixmap. +.PP +Set this property's value with setIcon() and get this property's value with icon(). +.SH "QPixmap iconPixmap" +This property holds the current icon. +.PP +The icon currently used by the message box. Note that it's often hard to draw one pixmap that looks appropriate in both Motif and Windows GUI styles; you may want to draw two pixmaps. +.PP +See also icon. +.PP +Set this property's value with setIconPixmap() and get this property's value with iconPixmap(). +.SH "QString text" +This property holds the message box text to be displayed. +.PP +The text will be interpreted either as a plain text or as rich text, depending on the text format setting (QMessageBox::textFormat). The default setting is AutoText, i.e. the message box will try to auto-detect the format of the text. +.PP +The default value of this property is QString::null. +.PP +See also textFormat. +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "TextFormat textFormat" +This property holds the format of the text displayed by the message box. +.PP +The current text format used by the message box. See the Qt::TextFormat enum for an explanation of the possible options. +.PP +The default format is AutoText. +.PP +See also text. +.PP +Set this property's value with setTextFormat() and get this property's value with textFormat(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmessagebox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmessagebox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmetaobject.3qt b/doc/man/man3/tqmetaobject.3qt new file mode 100644 index 000000000..bc5580683 --- /dev/null +++ b/doc/man/man3/tqmetaobject.3qt @@ -0,0 +1,184 @@ +'\" t +.TH QMetaObject 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 +QMetaObject \- Meta information about Qt objects +.SH SYNOPSIS +\fC#include <ntqmetaobject.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "const char * \fBclassName\fR () const" +.br +.ti -1c +.BI "const char * \fBsuperClassName\fR () const" +.br +.ti -1c +.BI "QMetaObject * \fBsuperClass\fR () const" +.br +.ti -1c +.BI "bool \fBinherits\fR ( const char * clname ) const" +.br +.ti -1c +.BI "int \fBnumSlots\fR ( bool super = FALSE ) const" +.br +.ti -1c +.BI "int \fBnumSignals\fR ( bool super = FALSE ) const" +.br +.ti -1c +.BI "QStrList \fBslotNames\fR ( bool super = FALSE ) const" +.br +.ti -1c +.BI "QStrList \fBsignalNames\fR ( bool super = FALSE ) const" +.br +.ti -1c +.BI "int \fBnumClassInfo\fR ( bool super = FALSE ) const" +.br +.ti -1c +.BI "const QClassInfo * \fBclassInfo\fR ( int index, bool super = FALSE ) const" +.br +.ti -1c +.BI "const char * \fBclassInfo\fR ( const char * name, bool super = FALSE ) const" +.br +.ti -1c +.BI "const QMetaProperty * \fBproperty\fR ( int index, bool super = FALSE ) const" +.br +.ti -1c +.BI "int \fBfindProperty\fR ( const char * name, bool super = FALSE ) const" +.br +.ti -1c +.BI "QStrList \fBpropertyNames\fR ( bool super = FALSE ) const" +.br +.ti -1c +.BI "int \fBnumProperties\fR ( bool super = FALSE ) const" +.br +.in -1c +.SH DESCRIPTION +The QMetaObject class contains meta information about Qt objects. +.PP +The Meta Object System in Qt is responsible for the signals and slots inter-object communication mechanism, runtime type information and the property system. All meta information in Qt is kept in a single instance of QMetaObject per class. +.PP +This class is not normally required for application programming. But if you write meta applications, such as scripting engines or GUI builders, you might find these functions useful: +.TP +className() to get the name of a class. +.TP +superClassName() to get the name of the superclass. +.TP +inherits(), the function called by QObject::inherits(). +.TP +superClass() to access the superclass's meta object. +.TP +numSlots(), numSignals(), slotNames(), and signalNames() to get information about a class's signals and slots. +.TP +property() and propertyNames() to obtain information about a class's properties. +.PP +Classes may have a list of name-value pairs of class information. The number of pairs is returned by numClassInfo(), and values are returned by classInfo(). +.PP +See also moc (Meta Object Compiler) and Object Model. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "const QClassInfo * QMetaObject::classInfo ( int index, bool super = FALSE ) const" +Returns the class information with index \fIindex\fR or 0 if no such information exists. +.PP +If \fIsuper\fR is TRUE, inherited class information is included. +.SH "const char * QMetaObject::classInfo ( const char * name, bool super = FALSE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the class information with name \fIname\fR or 0 if no such information exists. +.PP +If \fIsuper\fR is TRUE, inherited class information is included. +.SH "const char * QMetaObject::className () const" +Returns the class name. +.PP +See also QObject::className() and superClassName(). +.SH "int QMetaObject::findProperty ( const char * name, bool super = FALSE ) const" +Returns the index for the property with name \fIname\fR or -1 if no such property exists. +.PP +If \fIsuper\fR is TRUE, inherited properties are included. +.PP +See also property() and propertyNames(). +.SH "bool QMetaObject::inherits ( const char * clname ) const" +Returns TRUE if this class inherits \fIclname\fR within the meta object inheritance chain; otherwise returns FALSE. +.PP +(A class is considered to inherit itself.) +.SH "int QMetaObject::numClassInfo ( bool super = FALSE ) const" +Returns the number of items of class information available for this class. +.PP +If \fIsuper\fR is TRUE, inherited class information is included. +.SH "int QMetaObject::numProperties ( bool super = FALSE ) const" +Returns the number of properties for this class. +.PP +If \fIsuper\fR is TRUE, inherited properties are included. +.PP +See also propertyNames(). +.SH "int QMetaObject::numSignals ( bool super = FALSE ) const" +Returns the number of signals for this class. +.PP +If \fIsuper\fR is TRUE, inherited signals are included. +.PP +See also signalNames(). +.SH "int QMetaObject::numSlots ( bool super = FALSE ) const" +Returns the number of slots for this class. +.PP +If \fIsuper\fR is TRUE, inherited slots are included. +.PP +See also slotNames(). +.SH "const QMetaProperty * QMetaObject::property ( int index, bool super = FALSE ) const" +Returns the property meta data for the property at index \fIindex\fR or 0 if no such property exists. +.PP +If \fIsuper\fR is TRUE, inherited properties are included. +.PP +See also propertyNames(). +.SH "QStrList QMetaObject::propertyNames ( bool super = FALSE ) const" +Returns a list with the names of all this class's properties. +.PP +If \fIsuper\fR is TRUE, inherited properties are included. +.PP +See also property(). +.SH "QStrList QMetaObject::signalNames ( bool super = FALSE ) const" +Returns a list with the names of all this class's signals. +.PP +If \fIsuper\fR is TRUE, inherited signals are included. +.SH "QStrList QMetaObject::slotNames ( bool super = FALSE ) const" +Returns a list with the names of all this class's slots. +.PP +If \fIsuper\fR is TRUE, inherited slots are included. +.PP +See also numSlots(). +.SH "QMetaObject * QMetaObject::superClass () const" +Returns the meta object of the super class or 0 if there is no such object. +.SH "const char * QMetaObject::superClassName () const" +Returns the class name of the superclass or 0 if there is no superclass in the QObject hierachy. +.PP +See also className(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmetaobject.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmetaobject.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmetaproperty.3qt b/doc/man/man3/tqmetaproperty.3qt new file mode 100644 index 000000000..c9437b11f --- /dev/null +++ b/doc/man/man3/tqmetaproperty.3qt @@ -0,0 +1,151 @@ +'\" t +.TH QMetaProperty 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 +QMetaProperty \- Stores meta data about a property +.SH SYNOPSIS +\fC#include <ntqmetaobject.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "const char * \fBtype\fR () const" +.br +.ti -1c +.BI "const char * \fBname\fR () const" +.br +.ti -1c +.BI "bool \fBwritable\fR () const" +.br +.ti -1c +.BI "bool \fBisSetType\fR () const" +.br +.ti -1c +.BI "bool \fBisEnumType\fR () const" +.br +.ti -1c +.BI "QStrList \fBenumKeys\fR () const" +.br +.ti -1c +.BI "int \fBkeyToValue\fR ( const char * key ) const" +.br +.ti -1c +.BI "const char * \fBvalueToKey\fR ( int value ) const" +.br +.ti -1c +.BI "int \fBkeysToValue\fR ( const QStrList & keys ) const" +.br +.ti -1c +.BI "QStrList \fBvalueToKeys\fR ( int value ) const" +.br +.ti -1c +.BI "bool \fBdesignable\fR ( QObject * o = 0 ) const" +.br +.ti -1c +.BI "bool \fBscriptable\fR ( QObject * o = 0 ) const" +.br +.ti -1c +.BI "bool \fBstored\fR ( QObject * o = 0 ) const" +.br +.ti -1c +.BI "bool \fBreset\fR ( QObject * o ) const" +.br +.in -1c +.SH DESCRIPTION +The QMetaProperty class stores meta data about a property. +.PP +Property meta data includes type(), name(), and whether a property is writable(), designable() and stored(). +.PP +The functions isSetType(), isEnumType() and enumKeys() provide further information about a property's type. The conversion functions keyToValue(), valueToKey(), keysToValue() and valueToKeys() allow conversion between the integer representation of an enumeration or set value and its literal representation. +.PP +Actual property values are set and received through QObject's set and get functions. See QObject::setProperty() and QObject::property() for details. +.PP +You receive meta property data through an object's meta object. See QMetaObject::property() and QMetaObject::propertyNames() for details. +.PP +See also Object Model. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "bool QMetaProperty::designable ( QObject * o = 0 ) const" +Returns TRUE if the property is designable for object \fIo\fR; otherwise returns FALSE. +.PP +If no object \fIo\fR is given, the function returns a static approximation. +.SH "QStrList QMetaProperty::enumKeys () const" +Returns the possible enumeration keys if this property is an enumeration type (or a set type). +.PP +See also isEnumType(). +.SH "bool QMetaProperty::isEnumType () const" +Returns TRUE if the property's type is an enumeration value; otherwise returns FALSE. +.PP +See also isSetType() and enumKeys(). +.SH "bool QMetaProperty::isSetType () const" +Returns TRUE if the property's type is an enumeration value that is used as set, i.e. if the enumeration values can be OR-ed together; otherwise returns FALSE. A set type is implicitly also an enum type. +.PP +See also isEnumType() and enumKeys(). +.SH "int QMetaProperty::keyToValue ( const char * key ) const" +Converts the enumeration key \fIkey\fR to its integer value. +.PP +For set types, use keysToValue(). +.PP +See also valueToKey(), isSetType(), and keysToValue(). +.SH "int QMetaProperty::keysToValue ( const QStrList & keys ) const" +Converts the list of keys \fIkeys\fR to their combined (OR-ed) integer value. +.PP +See also isSetType() and valueToKey(). +.SH "const char * QMetaProperty::name () const" +Returns the name of the property. +.SH "bool QMetaProperty::reset ( QObject * o ) const" +Tries to reset the property for object \fIo\fR with a reset method. On success, returns TRUE; otherwise returns FALSE. +.PP +Reset methods are optional, usually only a few properties support them. +.SH "bool QMetaProperty::scriptable ( QObject * o = 0 ) const" +Returns TRUE if the property is scriptable for object \fIo\fR; otherwise returns FALSE. +.PP +If no object \fIo\fR is given, the function returns a static approximation. +.SH "bool QMetaProperty::stored ( QObject * o = 0 ) const" +Returns TRUE if the property shall be stored for object \fIo\fR; otherwise returns FALSE. +.PP +If no object \fIo\fR is given, the function returns a static approximation. +.SH "const char * QMetaProperty::type () const" +Returns the type of the property. +.SH "const char * QMetaProperty::valueToKey ( int value ) const" +Converts the enumeration value \fIvalue\fR to its literal key. +.PP +For set types, use valueToKeys(). +.PP +See also isSetType() and valueToKeys(). +.SH "QStrList QMetaProperty::valueToKeys ( int value ) const" +Converts the set value \fIvalue\fR to a list of keys. +.PP +See also isSetType() and valueToKey(). +.SH "bool QMetaProperty::writable () const" +Returns TRUE if the property is writable; otherwise returns FALSE. +.PP + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmetaproperty.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmetaproperty.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmimesource.3qt b/doc/man/man3/tqmimesource.3qt new file mode 100644 index 000000000..4f7ce52a5 --- /dev/null +++ b/doc/man/man3/tqmimesource.3qt @@ -0,0 +1,94 @@ +'\" t +.TH QMimeSource 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 +QMimeSource \- Abstraction of objects which provide formatted data of a certain MIME type +.SH SYNOPSIS +\fC#include <ntqmime.h>\fR +.PP +Inherited by QDragObject and QDropEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMimeSource\fR ()" +.br +.ti -1c +.BI "virtual \fB~QMimeSource\fR ()" +.br +.ti -1c +.BI "virtual const char * \fBformat\fR ( int i = 0 ) const = 0" +.br +.ti -1c +.BI "virtual bool \fBprovides\fR ( const char * mimeType ) const" +.br +.ti -1c +.BI "virtual QByteArray \fBencodedData\fR ( const char * ) const = 0" +.br +.ti -1c +.BI "int \fBserialNumber\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QMimeSource class is an abstraction of objects which provide formatted data of a certain MIME type. +.PP +Drag-and-drop and clipboard use this abstraction. +.PP +See also IANA list of MIME media types, Drag And Drop Classes, Input/Output and Networking, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMimeSource::QMimeSource ()" +Constructs a mime source and assigns a globally unique serial number to it. +.PP +See also serialNumber(). +.SH "QMimeSource::~QMimeSource ()\fC [virtual]\fR" +Provided to ensure that subclasses destroy themselves correctly. +.SH "QByteArray QMimeSource::encodedData ( const char * ) const\fC [pure virtual]\fR" +Returns the encoded data of this object in the specified MIME format. +.PP +Subclasses must reimplement this function. +.PP +Reimplemented in QStoredDrag, QDropEvent, and QIconDrag. +.SH "const char * QMimeSource::format ( int i = 0 ) const\fC [pure virtual]\fR" +Returns the \fIi\fR-th supported MIME format, or 0. +.PP +Reimplemented in QDropEvent. +.SH "bool QMimeSource::provides ( const char * mimeType ) const\fC [virtual]\fR" +Returns TRUE if the object can provide the data in format \fImimeType\fR; otherwise returns FALSE. +.PP +If you inherit from QMimeSource, for consistency reasons it is better to implement the more abstract canDecode() functions such as QTextDrag::canDecode() and QImageDrag::canDecode(). +.PP +Example: iconview/simple_dd/main.cpp. +.PP +Reimplemented in QDropEvent. +.SH "int QMimeSource::serialNumber () const" +Returns the mime source's globally unique serial number. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmimesource.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmimesource.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmimesourcefactory.3qt b/doc/man/man3/tqmimesourcefactory.3qt new file mode 100644 index 000000000..063c849c2 --- /dev/null +++ b/doc/man/man3/tqmimesourcefactory.3qt @@ -0,0 +1,233 @@ +'\" t +.TH QMimeSourceFactory 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 +QMimeSourceFactory \- Extensible provider of mime-typed data +.SH SYNOPSIS +\fC#include <ntqmime.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMimeSourceFactory\fR ()" +.br +.ti -1c +.BI "virtual \fB~QMimeSourceFactory\fR ()" +.br +.ti -1c +.BI "virtual const QMimeSource * \fBdata\fR ( const QString & abs_name ) const" +.br +.ti -1c +.BI "virtual QString \fBmakeAbsolute\fR ( const QString & abs_or_rel_name, const QString & context ) const" +.br +.ti -1c +.BI "const QMimeSource * \fBdata\fR ( const QString & abs_or_rel_name, const QString & context ) const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & abs_name, const QString & text )" +.br +.ti -1c +.BI "virtual void \fBsetImage\fR ( const QString & abs_name, const QImage & image )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QString & abs_name, const QPixmap & pixmap )" +.br +.ti -1c +.BI "virtual void \fBsetData\fR ( const QString & abs_name, QMimeSource * data )" +.br +.ti -1c +.BI "virtual void \fBsetFilePath\fR ( const QStringList & path )" +.br +.ti -1c +.BI "virtual QStringList \fBfilePath\fR () const" +.br +.ti -1c +.BI "void \fBaddFilePath\fR ( const QString & p )" +.br +.ti -1c +.BI "virtual void \fBsetExtensionType\fR ( const QString & ext, const char * mimetype )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QMimeSourceFactory * \fBdefaultFactory\fR ()" +.br +.ti -1c +.BI "void \fBsetDefaultFactory\fR ( QMimeSourceFactory * factory )" +.br +.ti -1c +.BI "QMimeSourceFactory * \fBtakeDefaultFactory\fR ()" +.br +.ti -1c +.BI "void \fBaddFactory\fR ( QMimeSourceFactory * f )" +.br +.ti -1c +.BI "void \fBremoveFactory\fR ( QMimeSourceFactory * f )" +.br +.in -1c +.SH DESCRIPTION +The QMimeSourceFactory class is an extensible provider of mime-typed data. +.PP +A QMimeSourceFactory provides an abstract interface to a collection of information. Each piece of information is represented by a QMimeSource object which can be examined and converted to concrete data types by functions such as QImageDrag::canDecode() and QImageDrag::decode(). +.PP +The base QMimeSourceFactory can be used in two ways: as an abstraction of a collection of files or as specifically stored data. For it to access files, call setFilePath() before accessing data. For stored data, call setData() for each item (there are also convenience functions, e.g. setText(), setImage() and setPixmap(), that simply call setData() with appropriate parameters). +.PP +The rich text widgets, QTextEdit and QTextBrowser, use QMimeSourceFactory to resolve references such as images or links within rich text documents. They either access the default factory (see defaultFactory()) or their own (see QTextEdit::setMimeSourceFactory()). Other classes that are capable of displaying rich text (such as QLabel, QWhatsThis or QMessageBox) always use the default factory. +.PP +A factory can also be used as a container to store data associated with a name. This technique is useful whenever rich text contains images that are stored in the program itself, not loaded from the hard disk. Your program may, for example, define some image data as: +.PP +.nf +.br + static const char* myimage_data[]={ +.br + "...", +.br + ... +.br + "..."}; +.br +.fi +.PP +To be able to use this image within some rich text, for example inside a QLabel, you must create a QImage from the raw data and insert it into the factory with a unique name: +.PP +.nf +.br + QMimeSourceFactory::defaultFactory()->setImage( "myimage", QImage(myimage_data) ); +.br +.fi +.PP +Now you can create a rich text QLabel with +.PP +.nf +.br + QLabel* label = new QLabel( +.br + "Rich text with embedded image:<img source=\\"myimage\\">" +.br + "Isn't that <em>cute</em>?" ); +.br +.fi +.PP +When no longer needed, you can clear the data from the factory: +.PP +.nf +.br + delete label; +.br + QMimeSourceFactory::defaultFactory()->setData( "myimage", 0 ); +.br +.fi +.PP +See also Environment Classes and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMimeSourceFactory::QMimeSourceFactory ()" +Constructs a QMimeSourceFactory that has no file path and no stored content. +.SH "QMimeSourceFactory::~QMimeSourceFactory ()\fC [virtual]\fR" +Destroys the QMimeSourceFactory, deleting all stored content. +.SH "void QMimeSourceFactory::addFactory ( QMimeSourceFactory * f )\fC [static]\fR" +Adds the QMimeSourceFactory \fIf\fR to the list of available mimesource factories. If the defaultFactory() can't resolve a data() it iterates over the list of installed mimesource factories until the data can be resolved. +.PP +See also removeFactory(). +.SH "void QMimeSourceFactory::addFilePath ( const QString & p )" +Adds another search path, \fIp\fR to the existing search paths. +.PP +See also setFilePath(). +.SH "const QMimeSource * QMimeSourceFactory::data ( const QString & abs_name ) const\fC [virtual]\fR" +Returns a reference to the data associated with \fIabs_name\fR. The return value remains valid only until the next data() or setData() call, so you should immediately decode the result. +.PP +If there is no data associated with \fIabs_name\fR in the factory's store, the factory tries to access the local filesystem. If \fIabs_name\fR isn't an absolute file name, the factory will search for it in all defined paths (see setFilePath()). +.PP +The factory understands all the image formats supported by QImageIO. Any other mime types are determined by the file name extension. The default settings are +.PP +.nf +.br + setExtensionType("html", "text/html;charset=iso8859-1"); +.br + setExtensionType("htm", "text/html;charset=iso8859-1"); +.br + setExtensionType("txt", "text/plain"); +.br + setExtensionType("xml", "text/xml;charset=UTF-8"); +.br +.fi +The effect of these is that file names ending in "txt" will be treated as text encoded in the local encoding; those ending in" xml" will be treated as text encoded in Unicode UTF-8 encoding. The text/html type is treated specially, since the encoding can be specified in the html file itself. "html" or "htm" will be treated as text encoded in the encoding specified by the html meta tag, if none could be found, the charset of the mime type will be used. The text subtype ("html", "plain", or "xml") does not affect the factory, but users of the factory may behave differently. We recommend creating "xml" files where practical. These files can be viewed regardless of the runtime encoding and can encode any Unicode characters without resorting to encoding definitions inside the file. +.PP +Any file data that is not recognized will be retrieved as a QMimeSource providing the "application/octet-stream" mime type, meaning uninterpreted binary data. +.PP +You can add further extensions or change existing ones with subsequent calls to setExtensionType(). If the extension mechanism is not sufficient for your problem domain, you can inherit QMimeSourceFactory and reimplement this function to perform some more specialized mime-type detection. The same applies if you want to use the mime source factory to access URL referenced data over a network. +.SH "const QMimeSource * QMimeSourceFactory::data ( const QString & abs_or_rel_name, const QString & context ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +A convenience function. See data(const QString& abs_name). The file name is given in \fIabs_or_rel_name\fR and the path is in \fIcontext\fR. +.SH "QMimeSourceFactory * QMimeSourceFactory::defaultFactory ()\fC [static]\fR" +Returns the application-wide default mime source factory. This factory is used by rich text rendering classes such as QSimpleRichText, QWhatsThis and QMessageBox to resolve named references within rich text documents. It serves also as the initial factory for the more complex render widgets, QTextEdit and QTextBrowser. +.PP +See also setDefaultFactory(). +.PP +Examples: +.)l action/application.cpp and application/application.cpp. +.SH "QStringList QMimeSourceFactory::filePath () const\fC [virtual]\fR" +Returns the currently set search paths. +.SH "QString QMimeSourceFactory::makeAbsolute ( const QString & abs_or_rel_name, const QString & context ) const\fC [virtual]\fR" +Converts the absolute or relative data item name \fIabs_or_rel_name\fR to an absolute name, interpreted within the context (path) of the data item named \fIcontext\fR (this must be an absolute name). +.SH "void QMimeSourceFactory::removeFactory ( QMimeSourceFactory * f )\fC [static]\fR" +Removes the mimesource factory \fIf\fR from the list of available mimesource factories. +.PP +See also addFactory(). +.SH "void QMimeSourceFactory::setData ( const QString & abs_name, QMimeSource * data )\fC [virtual]\fR" +Sets \fIdata\fR to be the data item associated with the absolute name \fIabs_name\fR. Note that the ownership of \fIdata\fR is transferred to the factory: do not delete or access the pointer after passing it to this function. +.PP +Passing 0 for data removes previously stored data. +.SH "void QMimeSourceFactory::setDefaultFactory ( QMimeSourceFactory * factory )\fC [static]\fR" +Sets the default \fIfactory\fR, destroying any previously set mime source provider. The ownership of the factory is transferred to Qt. +.PP +See also defaultFactory(). +.SH "void QMimeSourceFactory::setExtensionType ( const QString & ext, const char * mimetype )\fC [virtual]\fR" +Sets the mime-type to be associated with the file name extension, \fIext\fR to \fImimetype\fR. This determines the mime-type for files found via the paths set by setFilePath(). +.SH "void QMimeSourceFactory::setFilePath ( const QStringList & path )\fC [virtual]\fR" +Sets the list of directories that will be searched when named data is requested to the those given in the string list \fIpath\fR. +.PP +See also filePath(). +.SH "void QMimeSourceFactory::setImage ( const QString & abs_name, const QImage & image )\fC [virtual]\fR" +Sets \fIimage\fR to be the data item associated with the absolute name \fIabs_name\fR. +.PP +Equivalent to setData(abs_name, new QImageDrag(image)). +.SH "void QMimeSourceFactory::setPixmap ( const QString & abs_name, const QPixmap & pixmap )\fC [virtual]\fR" +Sets \fIpixmap\fR to be the data item associated with the absolute name \fIabs_name\fR. +.SH "void QMimeSourceFactory::setText ( const QString & abs_name, const QString & text )\fC [virtual]\fR" +Sets \fItext\fR to be the data item associated with the absolute name \fIabs_name\fR. +.PP +Equivalent to setData(abs_name, new QTextDrag(text)). +.SH "QMimeSourceFactory * QMimeSourceFactory::takeDefaultFactory ()\fC [static]\fR" +Sets the defaultFactory() to 0 and returns the previous one. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmimesourcefactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmimesourcefactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmotif.3qt b/doc/man/man3/tqmotif.3qt new file mode 100644 index 000000000..9c2ae18dc --- /dev/null +++ b/doc/man/man3/tqmotif.3qt @@ -0,0 +1,114 @@ +'\" t +.TH QMotif 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 +QMotif \- The basis of the +.SH SYNOPSIS +This class is part of the \fBQt Motif Extension\fR. +.PP +\fC#include <qmotif.h>\fR +.PP +Inherits QEventLoop. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMotif\fR ( const char * applicationClass, XtAppContext context = NULL, XrmOptionDescRec * options = 0, int numOptions = 0 )" +.br +.ti -1c +.BI "\fB~QMotif\fR ()" +.br +.ti -1c +.BI "XtAppContext \fBapplicationContext\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "Display * \fBx11Display\fR ()" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt Motif Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QMotif class provides the basis of the Motif Extension. +.PP +QMotif only provides a few public functions, but it is at the heart of the integration. QMotif is responsible for initializing the Xt toolkit and the Xt application context. It does not open a connection to the X server, that is done by QApplication. +.PP +The only member function in QMotif that depends on an X server connection is QMotif::initialize(). QMotif must be created before QApplication. +.PP +Example usage of QMotif and QApplication: +.PP +.nf +.br + static char *resources[] = { +.br + ... +.br + }; +.br +.br + int main(int argc, char **argv) +.br + { +.br + QMotif integrator( "AppClass" ); +.br + XtAppSetFallbackResources( integrator.applicationContext(), +.br + resources ); +.br + QApplication app( argc, argv ); +.br +.br + ... +.br +.br + return app.exec(); +.br + } +.br +.fi +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMotif::QMotif ( const char * applicationClass, XtAppContext context = NULL, XrmOptionDescRec * options = 0, int numOptions = 0 )" +Creates QMotif, which allows Qt and Xt/Motif integration. +.PP +If \fIcontext\fR is 0, QMotif creates a default application context itself. The context is accessible through applicationContext(). +.PP +All arguments passed to this function (\fIapplicationClass\fR, \fIoptions\fR and \fInumOptions\fR) are used to call XtDisplayInitialize() after QApplication has been constructed. +.SH "QMotif::~QMotif ()" +Destroys QMotif. +.SH "XtAppContext QMotif::applicationContext () const" +Returns the application context. +.SH "Display * QMotif::x11Display ()\fC [static]\fR" +Returns the X11 display connection used by the Qt Motif Extension. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmotif.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmotif.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmotifdialog.3qt b/doc/man/man3/tqmotifdialog.3qt new file mode 100644 index 000000000..52cb323b9 --- /dev/null +++ b/doc/man/man3/tqmotifdialog.3qt @@ -0,0 +1,178 @@ +'\" t +.TH QMotifDialog 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 +QMotifDialog \- The QDialog API for Motif-based dialogs +.SH SYNOPSIS +This class is part of the \fBQt Motif Extension\fR. +.PP +\fC#include <qmotifdialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum DialogType { Prompt, Selection, Command, FileSelection, Template, Error, Information, Message, Question, Warning, Working } \fI(obsolete)\fR" +.br +.ti -1c +.BI "QMotifDialog ( DialogType dialogtype, Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QMotifDialog ( Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "\fBQMotifDialog\fR ( Widget parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" +.br +.ti -1c +.BI "\fBQMotifDialog\fR ( QWidget * parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" +.br +.ti -1c +.BI "virtual \fB~QMotifDialog\fR ()" +.br +.ti -1c +.BI "Widget \fBshell\fR () const" +.br +.ti -1c +.BI "Widget \fBdialog\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBacceptCallback\fR ( Widget, XtPointer client_data, XtPointer )" +.br +.ti -1c +.BI "void \fBrejectCallback\fR ( Widget, XtPointer client_data, XtPointer )" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt Motif Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QMotifDialog class provides the QDialog API for Motif-based dialogs. +.PP +QMotifDialog provides two separate modes of operation. The application programmer can use QMotifDialog with an existing Motif-based dialog and a QWidget parent, or the application programmer can use QMotifDialog with a custom Qt-based dialog and a Motif-based parent. Modality continues to work as expected. +.PP +Motif-based dialogs must have a \fCShell\fR widget parent with a single child, due to requirements of the Motif toolkit. The \fCShell\fR widget, which is a special subclass of \fCXmDialogShell\fR, is created during construction. It can be accessed using the shell() member function. +.PP +The single child of the \fCShell\fR can be accessed using the dialog() member function \fIafter\fR it has been created. +.PP +The acceptCallback() and rejectCallback() functions provide a convenient way to call QDialog::accept() and QDialog::reject() through callbacks. A pointer to the QMotifDialog should be passed as the \fCclient_data\fR argument to the callback. +.PP +The API and behavior QMotifDialog is identical to that of QDialog when using a custom Qt-based dialog with a Motif-based parent. The only difference is that a Motif-based \fIparent\fR argument is passed to the constructor, instead of a QWidget parent. +.SS "Member Type Documentation" +.SH "QMotifDialog::DialogType" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This enum lists the predefined Motif dialog types. +.TP +\fCQMotifDialog::Prompt\fR +.TP +\fCQMotifDialog::Selection\fR +.TP +\fCQMotifDialog::Command\fR +.TP +\fCQMotifDialog::FileSelection\fR +.TP +\fCQMotifDialog::Template\fR +.TP +\fCQMotifDialog::Error\fR +.TP +\fCQMotifDialog::Information\fR +.TP +\fCQMotifDialog::Message\fR +.TP +\fCQMotifDialog::Question\fR +.TP +\fCQMotifDialog::Warning\fR +.TP +\fCQMotifDialog::Working\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMotifDialog::QMotifDialog ( DialogType dialogtype, Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Creates a QMotifDialog using one of the predefined Motif dialog types. The \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. +.PP +This constructor creates a Shell widget, which is a special subclass of XmDialogShell. The \fIparent\fR, \fIargs\fR and \fIargcount\fR arguments are passed to XtCreatePopupShell() when creating the subclass. You can access the Shell widget with the shell() member function. +.PP +This constructor also creates the dialog widget with the Shell widget as its parent. The type of the dialog created is specified by the \fIdialogtype\fR argument. See the DialogType enum for a list of available dialog types. You can access the dialog widget with the dialog() member function. +.PP +\fBWarning:\fR QMotifDialog takes ownership of the child widget and destroys it during destruction. You should not destroy the dialog widget yourself. +.PP +See also DialogType, shell(), and dialog(). +.SH "QMotifDialog::QMotifDialog ( Widget parent, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Creates a QMotifDialog which allows the application programmer to use the Motif-based \fIparent\fR for a custom QDialog. The \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. +.PP +This constructor creates a Shell widget, which is a special subclass of XmDialogShell. The \fIargs\fR and \fIargcount\fR arguments are passed to XtCreatePopupShell() when creating the subclass. You can access the Shell widget with the shell() member function. +.PP +The dialog widget is not created by the constructor. You must create the dialog widget as a child of the the widget returned by shell(). You can access the child widget with the dialog() member function. +.PP +A dialog widget is not created by this constructor. Instead, you should create the dialog widget as a child of this dialog. QMotifDialog will take ownership of your custom dialog, and you can access it with the dialog() member function. +.PP +\fBWarning:\fR QMotifDialog takes ownership of the child widget and destroys it during destruction. You should not destroy the dialog widget yourself. +.PP +See also shell() and dialog(). +.SH "QMotifDialog::QMotifDialog ( Widget parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" +Creates a QMotifDialog which allows the application programmer to use the Motif-based \fIparent\fR for a custom QDialog. The \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. +.PP +This constructor creates a \fCShell\fR widget, which is a special subclass of \fCXmDialogShell\fR. You can access the \fCShell\fR widget with the shell() member function. +.PP +See also shell(). +.SH "QMotifDialog::QMotifDialog ( QWidget * parent, const char * name = 0, bool modal = FALSE, WFlags flags = 0 )" +Creates a QMotifDialog which allows the application programmer to use a QWidget parent for an existing Motif-based dialog. The \fIparent\fR, \fIname\fR, \fImodal\fR and \fIflags\fR arguments are passed to the QDialog constructor. +.PP +This constructor creates a \fCShell\fR widget, which is a special subclass of \fCXmDialogShell\fR. You can access the \fCShell\fR widget with the shell() member functon. +.PP +A dialog widget is not created by this constructor. Instead, you should create the dialog widget as a child of this dialog. QMotifDialog will take ownership of your custom dialog, and you can access it with the dialog() member function. +.PP +\fBWarning:\fR QMotifDialog takes ownership of the child widget and destroys it during destruction. You should not destroy the dialog widget yourself. +.PP +See also shell() and dialog(). +.SH "QMotifDialog::~QMotifDialog ()\fC [virtual]\fR" +Destroys the QDialog, dialog widget and \fCShell\fR widget. +.SH "void QMotifDialog::acceptCallback ( Widget, XtPointer client_data, XtPointer )\fC [static]\fR" +Convenient Xt/Motif callback to accept the QMotifDialog. +.PP +The data is passed in \fIclient_data\fR. +.SH "Widget QMotifDialog::dialog () const" +Returns the Motif widget embedded in this dialog. +.SH "void QMotifDialog::rejectCallback ( Widget, XtPointer client_data, XtPointer )\fC [static]\fR" +Convenient Xt/Motif callback to reject the QMotifDialog. +.PP +The data is passed in \fIclient_data\fR. +.SH "Widget QMotifDialog::shell () const" +Returns the \fCShell\fR widget embedded in this dialog. +.PP +Example: dialog/mainwindow.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmotifdialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmotifdialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmotifplusstyle.3qt b/doc/man/man3/tqmotifplusstyle.3qt new file mode 100644 index 000000000..0e0892db5 --- /dev/null +++ b/doc/man/man3/tqmotifplusstyle.3qt @@ -0,0 +1,59 @@ +'\" t +.TH QMotifPlusStyle 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 +QMotifPlusStyle \- More sophisticated Motif-ish look and feel +.SH SYNOPSIS +\fC#include <ntqmotifplusstyle.h>\fR +.PP +Inherits QMotifStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMotifPlusStyle\fR ( bool hoveringHighlight = TRUE )" +.br +.in -1c +.SH DESCRIPTION +The QMotifPlusStyle class provides a more sophisticated Motif-ish look and feel. +.PP +This class implements a Motif-ish look and feel with the more sophisticated bevelling as used by the GIMP Toolkit (GTK+) for Unix/X11. +.PP +See also Widget Appearance and Style. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMotifPlusStyle::QMotifPlusStyle ( bool hoveringHighlight = TRUE )" +Constructs a QMotifPlusStyle +.PP +If \fIhoveringHighlight\fR is TRUE (the default), then the style will +not highlight push buttons, checkboxes, radiobuttons, comboboxes, +scrollbars or sliders. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmotifplusstyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmotifplusstyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmotifstyle.3qt b/doc/man/man3/tqmotifstyle.3qt new file mode 100644 index 000000000..17c6e8fa9 --- /dev/null +++ b/doc/man/man3/tqmotifstyle.3qt @@ -0,0 +1,76 @@ +'\" t +.TH QMotifStyle 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 +QMotifStyle \- Motif look and feel +.SH SYNOPSIS +\fC#include <ntqmotifstyle.h>\fR +.PP +Inherits QCommonStyle. +.PP +Inherited by QCDEStyle, QMotifPlusStyle, and QSGIStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMotifStyle\fR ( bool useHighlightCols = FALSE )" +.br +.ti -1c +.BI "void \fBsetUseHighlightColors\fR ( bool arg )" +.br +.ti -1c +.BI "bool \fBuseHighlightColors\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QMotifStyle class provides Motif look and feel. +.PP +This class implements the Motif look and feel. It closely resembles the original Motif look as defined by the Open Group, but with some minor improvements. The Motif style is Qt's default GUI style on UNIX platforms. +.PP +See also Widget Appearance and Style. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMotifStyle::QMotifStyle ( bool useHighlightCols = FALSE )" +Constructs a QMotifStyle. +.PP +If \fIuseHighlightCols\fR is FALSE (the default), the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. +.SH "void QMotifStyle::setUseHighlightColors ( bool arg )" +If \fIarg\fR is FALSE, the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. +.PP +The effect will show up the next time an application palette is set via QApplication::setPalette(). The current color palette of the application remains unchanged. +.PP +See also QStyle::polish(). +.SH "bool QMotifStyle::useHighlightColors () const" +Returns TRUE if the style treats the highlight colors of the +palette in a Motif-like manner, which is a simple inversion +between the base and the text color; otherwise returns FALSE. The +default is FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmotifstyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmotifstyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmotifwidget.3qt b/doc/man/man3/tqmotifwidget.3qt new file mode 100644 index 000000000..7ec8ff26d --- /dev/null +++ b/doc/man/man3/tqmotifwidget.3qt @@ -0,0 +1,86 @@ +'\" t +.TH QMotifWidget 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 +QMotifWidget \- The QWidget API for Xt/Motif widgets +.SH SYNOPSIS +This class is part of the \fBQt Motif Extension\fR. +.PP +\fC#include <qmotifwidget.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMotifWidget\fR ( QWidget * parent, WidgetClass widgetclass, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, WFlags flags = 0 )" +.br +.ti -1c +.BI "virtual \fB~QMotifWidget\fR ()" +.br +.ti -1c +.BI "Widget \fBmotifWidget\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBx11Event\fR ( XEvent * event )" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt Motif Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QMotifWidget class provides the QWidget API for Xt/Motif widgets. +.PP +QMotifWidget exists to provide a QWidget that can act as a parent for any Xt/Motif widget. Since the QMotifWidget is a proper QWidget, it can be used as a top-level widget (e.g. 0 parent) or as a child of any other QWidget. Note: Since QMotifWidget acts as a parent for Xt/Motif widgets, you should not create QWidgets with a QMotifWidget parent. +.PP +An Xt/Motif widget with a top-level QMotifWidget parent can begin using the standard Qt dialogs and custom QDialogs while keeping the main Xt/Motif interface of the application. Using a QMotifWidget as the parent for the various QDialogs will ensure that modality and stacking works properly throughout the entire application. +.PP +Applications moving to Qt may have custom Xt/Motif widgets that will take time to rewrite with Qt. Such applications can use these custom widgets as QMotifWidget with QWidget parents. This allows the application's interface to be replaced gradually. +.PP +\fBWarning:\fR QMotifWidget uses the X11 window ID of the Motif widget directly, instead of creating its own. Because ot this, QWidget::reparent() will not work. This includes the functions QWidget::showFullScreen() and QWidget::showNormal(), which use QWidget::reparent(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMotifWidget::QMotifWidget ( QWidget * parent, WidgetClass widgetclass, ArgList args = NULL, Cardinal argcount = 0, const char * name = 0, WFlags flags = 0 )" +Creates a QMotifWidget of the given \fIwidgetclass\fR as a child of \fIparent\fR, with the name \fIname\fR and widget flags \fIflags\fR. +.PP +The \fIargs\fR and \fIargcount\fR arguments are passed on to XtCreateWidget. +.PP +The motifWidget() function returns the resulting Xt/Motif widget. This widget can be used as a parent for any other Xt/Motif widget. +.PP +If \fIparent\fR is a QMotifWidget, the Xt/Motif widget is created as a child of the parent's motifWidget(). If \ parent is 0 or a normal QWidget, the Xt/Motif widget is created as a child of a special TopLevelShell widget. Xt/Motif widgets can use this special TopLevelShell parent as the parent for existing Xt/Motif dialogs or QMotifDialogs. +.SH "QMotifWidget::~QMotifWidget ()\fC [virtual]\fR" +Destroys the QMotifWidget. The special TopLevelShell is also destroyed, if it was created during construction. +.SH "Widget QMotifWidget::motifWidget () const" +Returns the embedded Xt/Motif widget. If a Shell widget was +created by the constructor, you can access it with XtParent(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmotifwidget.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmotifwidget.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmousedriverfactory.3qt b/doc/man/man3/tqmousedriverfactory.3qt new file mode 100644 index 000000000..3b6863215 --- /dev/null +++ b/doc/man/man3/tqmousedriverfactory.3qt @@ -0,0 +1,59 @@ +'\" t +.TH QMouseDriverFactory 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 +QMouseDriverFactory \- Creates QWSMouseHandler objects for Qt/Embedded +.SH SYNOPSIS +\fC#include <qmousedriverfactory_qws.h>\fR +.PP +.SS "Static Public Members" +<li class=fn>QStringList \fBkeys\fR () <li class=fn>QWSMouseHandler * \fBcreate\fR ( const QString & key, const QString & device ) +.SH DESCRIPTION +The QMouseDriverFactory class creates QWSMouseHandler objects for Qt/Embedded. +.PP +The graphics driver factory creates a QWSMouseHandler object for a given key with QMouseDriverFactory::create(key). +.PP +The drivers are either built-in or dynamically loaded from a driver plugin (see QMouseDriverPlugin). +.PP +This class is only available in Qt/Embedded. +.PP +QMouseDriverFactory::keys() returns a list of valid keys. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSMouseHandler * QMouseDriverFactory::create ( const QString & key, const QString & device )\fC [static]\fR" +Creates a QWSMouseHandler object that matches \fIkey\fR and uses device \fIdevice\fR. This is either a built-in driver, or a driver from a driver plugin. +.PP +See also keys(). +.SH "QStringList QMouseDriverFactory::keys ()\fC [static]\fR" +Returns the list of keys this factory can create drivers for. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmousedriverfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmousedriverfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmousedriverplugin.3qt b/doc/man/man3/tqmousedriverplugin.3qt new file mode 100644 index 000000000..b476e8ff9 --- /dev/null +++ b/doc/man/man3/tqmousedriverplugin.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QMouseDriverPlugin 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 +QMouseDriverPlugin \- Abstract base for Qt/Embedded mouse driver plugins +.SH SYNOPSIS +\fC#include <qmousedriverplugin_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMouseDriverPlugin\fR ()" +.br +.ti -1c +.BI "\fB~QMouseDriverPlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBkeys\fR () const = 0" +.br +.ti -1c +.BI "virtual QWSMouseHandler * \fBcreate\fR ( const QString & driver, const QString & device ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QMouseDriverPlugin class provides an abstract base for Qt/Embedded mouse driver plugins. +.PP +The mouse driver plugin is a simple plugin interface that makes it easy to create custom mouse drivers. +.PP +Writing a mouse driver plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Plugins documentation for details. +.PP +This class is only available in Qt/Embedded. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMouseDriverPlugin::QMouseDriverPlugin ()" +Constructs a mouse driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. +.SH "QMouseDriverPlugin::~QMouseDriverPlugin ()" +Destroys the mouse driver plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "QWSMouseHandler * QMouseDriverPlugin::create ( const QString & driver, const QString & device )\fC [pure virtual]\fR" +Creates a driver matching the type specified by \fIdriver\fR and which uses device \fIdevice\fR. +.PP +See also keys(). +.SH "QStringList QMouseDriverPlugin::keys () const\fC [pure virtual]\fR" +Returns the list of mouse drivers this plugin supports. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmousedriverplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmousedriverplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmouseevent.3qt b/doc/man/man3/tqmouseevent.3qt new file mode 100644 index 000000000..3385129df --- /dev/null +++ b/doc/man/man3/tqmouseevent.3qt @@ -0,0 +1,199 @@ +'\" t +.TH QMouseEvent 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 +QMouseEvent \- Parameters that describe a mouse event +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMouseEvent\fR ( Type type, const QPoint & pos, int button, int state )" +.br +.ti -1c +.BI "\fBQMouseEvent\fR ( Type type, const QPoint & pos, const QPoint & globalPos, int button, int state )" +.br +.ti -1c +.BI "const QPoint & \fBpos\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBglobalPos\fR () const" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "int \fBglobalX\fR () const" +.br +.ti -1c +.BI "int \fBglobalY\fR () const" +.br +.ti -1c +.BI "ButtonState \fBbutton\fR () const" +.br +.ti -1c +.BI "ButtonState \fBstate\fR () const" +.br +.ti -1c +.BI "ButtonState \fBstateAfter\fR () const" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QMouseEvent class contains parameters that describe a mouse event. +.PP +Mouse events occur when a mouse button is pressed or released inside a widget or when the mouse cursor is moved. +.PP +Mouse move events will occur only when a mouse button is pressed down, unless mouse tracking has been enabled with QWidget::setMouseTracking(). +.PP +Qt automatically grabs the mouse when a mouse button is pressed inside a widget; the widget will continue to receive mouse events until the last mouse button is released. +.PP +A mouse event contains a special accept flag that indicates whether the receiver wants the event. You should call QMouseEvent::ignore() if the mouse event is not handled by your widget. A mouse event is propagated up the parent widget chain until a widget accepts it with QMouseEvent::accept() or an event filter consumes it. +.PP +The functions pos(), x() and y() give the cursor position relative to the widget that receives the mouse event. If you move the widget as a result of the mouse event, use the global position returned by globalPos() to avoid a shaking motion. +.PP +The QWidget::setEnabled() function can be used to enable or disable mouse and keyboard events for a widget. +.PP +The event handlers QWidget::mousePressEvent(), QWidget::mouseReleaseEvent(), QWidget::mouseDoubleClickEvent() and QWidget::mouseMoveEvent() receive mouse events. +.PP +See also QWidget::mouseTracking, QWidget::grabMouse(), QCursor::pos(), and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMouseEvent::QMouseEvent ( Type type, const QPoint & pos, int button, int state )" +Constructs a mouse event object. +.PP +The \fItype\fR parameter must be one of QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick or QEvent::MouseMove. +.PP +The \fIpos\fR parameter specifies the position relative to the receiving widget. \fIbutton\fR specifies the button that caused the event, which should be Qt::NoButton (0), if \fItype\fR is MouseMove. \fIstate\fR is the ButtonState at the time of the event. +.PP +The globalPos() is initialized to QCursor::pos(), which may not be appropriate. Use the other constructor to specify the global position explicitly. +.SH "QMouseEvent::QMouseEvent ( Type type, const QPoint & pos, const QPoint & globalPos, int button, int state )" +Constructs a mouse event object. +.PP +The \fItype\fR parameter must be QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick or QEvent::MouseMove. +.PP +The \fIpos\fR parameter specifies the position relative to the receiving widget. \fIglobalPos\fR is the position in absolute coordinates. \fIbutton\fR specifies the button that caused the event, which should be Qt::NoButton (0), if \fItype\fR is MouseMove. \fIstate\fR is the ButtonState at the time of the event. +.SH "void QMouseEvent::accept ()" +Sets the accept flag of the mouse event object. +.PP +Setting the accept parameter indicates that the receiver of the event wants the mouse event. Unwanted mouse events are sent to the parent widget. +.PP +The accept flag is set by default. +.PP +See also ignore(). +.SH "ButtonState QMouseEvent::button () const" +Returns the button that caused the event. +.PP +Possible return values are LeftButton, RightButton, MidButton and NoButton. +.PP +Note that the returned value is always NoButton for mouse move events. +.PP +See also state() and Qt::ButtonState. +.PP +Examples: +.)l dclock/dclock.cpp, life/life.cpp, and t14/cannon.cpp. +.SH "const QPoint & QMouseEvent::globalPos () const" +Returns the global position of the mouse pointer \fIat the time of the event\fR. This is important on asynchronous window systems like X11. Whenever you move your widgets around in response to mouse events, globalPos() may differ a lot from the current pointer position QCursor::pos(), and from QWidget::mapToGlobal( pos() ). +.PP +See also globalX() and globalY(). +.PP +Example: aclock/aclock.cpp. +.SH "int QMouseEvent::globalX () const" +Returns the global x-position of the mouse pointer at the time of the event. +.PP +See also globalY() and globalPos(). +.SH "int QMouseEvent::globalY () const" +Returns the global y-position of the mouse pointer at the time of the event. +.PP +See also globalX() and globalPos(). +.SH "void QMouseEvent::ignore ()" +Clears the accept flag parameter of the mouse event object. +.PP +Clearing the accept parameter indicates that the event receiver does not want the mouse event. Unwanted mouse events are sent to the parent widget. +.PP +The accept flag is set by default. +.PP +See also accept(). +.SH "bool QMouseEvent::isAccepted () const" +Returns TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE. +.SH "const QPoint & QMouseEvent::pos () const" +Returns the position of the mouse pointer relative to the widget that received the event. +.PP +If you move the widget as a result of the mouse event, use the global position returned by globalPos() to avoid a shaking motion. +.PP +See also x(), y(), and globalPos(). +.PP +Examples: +.)l chart/canvasview.cpp, drawlines/connect.cpp, life/life.cpp, popup/popup.cpp, qmag/qmag.cpp, t14/cannon.cpp, and tooltip/tooltip.cpp. +.SH "ButtonState QMouseEvent::state () const" +Returns the button state (a combination of mouse buttons and keyboard modifiers), i.e. what buttons and keys were being pressed immediately before the event was generated. +.PP +This means that if you have a QEvent::MouseButtonPress or a QEvent::MouseButtonDblClick state() will \fInot\fR include the mouse button that's pressed. But once the mouse button has been released, the QEvent::MouseButtonRelease event will have the button() that was pressed. +.PP +This value is mainly interesting for QEvent::MouseMove; for the other cases, button() is more useful. +.PP +The returned value is LeftButton, RightButton, MidButton, ShiftButton, ControlButton and AltButton OR'ed together. +.PP +See also button(), stateAfter(), and Qt::ButtonState. +.PP +Examples: +.)l popup/popup.cpp and showimg/showimg.cpp. +.SH "ButtonState QMouseEvent::stateAfter () const" +Returns the state of buttons after the event. +.PP +See also state() and Qt::ButtonState. +.SH "int QMouseEvent::x () const" +Returns the x-position of the mouse pointer, relative to the widget that received the event. +.PP +See also y() and pos(). +.PP +Example: showimg/showimg.cpp. +.SH "int QMouseEvent::y () const" +Returns the y-position of the mouse pointer, relative to the widget that received the event. +.PP +See also x() and pos(). +.PP +Example: showimg/showimg.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmouseevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmouseevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmoveevent.3qt b/doc/man/man3/tqmoveevent.3qt new file mode 100644 index 000000000..aa18148d5 --- /dev/null +++ b/doc/man/man3/tqmoveevent.3qt @@ -0,0 +1,68 @@ +'\" t +.TH QMoveEvent 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 +QMoveEvent \- Event parameters for move events +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMoveEvent\fR ( const QPoint & pos, const QPoint & oldPos )" +.br +.ti -1c +.BI "const QPoint & \fBpos\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBoldPos\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QMoveEvent class contains event parameters for move events. +.PP +Move events are sent to widgets that have been moved to a new position relative to their parent. +.PP +The event handler QWidget::moveEvent() receives move events. +.PP +See also QWidget::pos, QWidget::geometry, and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMoveEvent::QMoveEvent ( const QPoint & pos, const QPoint & oldPos )" +Constructs a move event with the new and old widget positions, \fIpos\fR and \fIoldPos\fR respectively. +.SH "const QPoint & QMoveEvent::oldPos () const" +Returns the old position of the widget. +.SH "const QPoint & QMoveEvent::pos () const" +Returns the new position of the widget. This excludes the window +frame for top level widgets. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmoveevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmoveevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmovie.3qt b/doc/man/man3/tqmovie.3qt new file mode 100644 index 000000000..01d11814e --- /dev/null +++ b/doc/man/man3/tqmovie.3qt @@ -0,0 +1,322 @@ +'\" t +.TH QMovie 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 +QMovie \- Incremental loading of animations or images, signalling as it progresses +.SH SYNOPSIS +\fC#include <ntqmovie.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMovie\fR ()" +.br +.ti -1c +.BI "\fBQMovie\fR ( int bufsize )" +.br +.ti -1c +.BI "\fBQMovie\fR ( QDataSource * src, int bufsize = 1024 )" +.br +.ti -1c +.BI "\fBQMovie\fR ( const QString & fileName, int bufsize = 1024 )" +.br +.ti -1c +.BI "\fBQMovie\fR ( QByteArray data, int bufsize = 1024 )" +.br +.ti -1c +.BI "\fBQMovie\fR ( const QMovie & movie )" +.br +.ti -1c +.BI "\fB~QMovie\fR ()" +.br +.ti -1c +.BI "QMovie & \fBoperator=\fR ( const QMovie & movie )" +.br +.ti -1c +.BI "int \fBpushSpace\fR () const" +.br +.ti -1c +.BI "void \fBpushData\fR ( const uchar * data, int length )" +.br +.ti -1c +.BI "const QColor & \fBbackgroundColor\fR () const" +.br +.ti -1c +.BI "void \fBsetBackgroundColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "const QRect & \fBgetValidRect\fR () const" +.br +.ti -1c +.BI "const QPixmap & \fBframePixmap\fR () const" +.br +.ti -1c +.BI "const QImage & \fBframeImage\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "int \fBframeNumber\fR () const" +.br +.ti -1c +.BI "int \fBsteps\fR () const" +.br +.ti -1c +.BI "bool \fBpaused\fR () const" +.br +.ti -1c +.BI "bool \fBfinished\fR () const" +.br +.ti -1c +.BI "bool \fBrunning\fR () const" +.br +.ti -1c +.BI "void \fBunpause\fR ()" +.br +.ti -1c +.BI "void \fBpause\fR ()" +.br +.ti -1c +.BI "void \fBstep\fR ()" +.br +.ti -1c +.BI "void \fBstep\fR ( int steps )" +.br +.ti -1c +.BI "void \fBrestart\fR ()" +.br +.ti -1c +.BI "int \fBspeed\fR () const" +.br +.ti -1c +.BI "void \fBsetSpeed\fR ( int percent )" +.br +.ti -1c +.BI "void \fBconnectResize\fR ( QObject * receiver, const char * member )" +.br +.ti -1c +.BI "void \fBdisconnectResize\fR ( QObject * receiver, const char * member = 0 )" +.br +.ti -1c +.BI "void \fBconnectUpdate\fR ( QObject * receiver, const char * member )" +.br +.ti -1c +.BI "void \fBdisconnectUpdate\fR ( QObject * receiver, const char * member = 0 )" +.br +.ti -1c +.BI "enum \fBStatus\fR { SourceEmpty = -2, UnrecognizedFormat = -1, Paused = 1, EndOfFrame = 2, EndOfLoop = 3, EndOfMovie = 4, SpeedChanged = 5 }" +.br +.ti -1c +.BI "void \fBconnectStatus\fR ( QObject * receiver, const char * member )" +.br +.ti -1c +.BI "void \fBdisconnectStatus\fR ( QObject * receiver, const char * member = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QMovie class provides incremental loading of animations or images, signalling as it progresses. +.PP +The simplest way to display a QMovie is to use a QLabel and QLabel::setMovie(). +.PP +A QMovie provides a QPixmap as the framePixmap(); connections can be made via connectResize() and connectUpdate() to receive notification of size and pixmap changes. All decoding is driven by the normal event-processing mechanisms. +.PP +The movie begins playing as soon as the QMovie is created (actually, once control returns to the event loop). When the last frame in the movie has been played, it may loop back to the start if such looping is defined in the input source. +.PP +QMovie objects are explicitly shared. This means that a QMovie copied from another QMovie will be displaying the same frame at all times. If one shared movie pauses, all pause. To make \fIindependent\fR movies, they must be constructed separately. +.PP +The set of data formats supported by QMovie is determined by the decoder factories that have been installed; the format of the input is determined as the input is decoded. +.PP +The supported formats are MNG (if Qt is configured with MNG support enabled) and GIF (if Qt is configured with GIF support enabled, see ntqgif.h). +.PP +If Qt is configured to support GIF reading, we are required to state that "The Graphics Interchange Format(c) is the Copyright property of CompuServe Incorporated. GIF(sm) is a Service Mark property of CompuServe Incorporated. +.PP +\fBWarning:\fR If you are in a country that recognizes software patents and in which Unisys holds a patent on LZW compression and/or decompression and you want to use GIF, Unisys may require you to license that technology. Such countries include Canada, Japan, the USA, France, Germany, Italy and the UK. +.PP +GIF support may be removed completely in a future version of Qt. We recommend using the MNG or PNG format. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QLabel::setMovie(), Graphics Classes, Image Processing Classes, and Multimedia Classes. +.SS "Member Type Documentation" +.SH "QMovie::Status" +.TP +\fCQMovie::SourceEmpty\fR +.TP +\fCQMovie::UnrecognizedFormat\fR +.TP +\fCQMovie::Paused\fR +.TP +\fCQMovie::EndOfFrame\fR +.TP +\fCQMovie::EndOfLoop\fR +.TP +\fCQMovie::EndOfMovie\fR +.TP +\fCQMovie::SpeedChanged\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMovie::QMovie ()" +Constructs a null QMovie. The only interesting thing to do with such a movie is to assign another movie to it. +.PP +See also isNull(). +.SH "QMovie::QMovie ( int bufsize )" +Constructs a QMovie with an external data source. You should later call pushData() to send incoming animation data to the movie. +.PP +The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. +.PP +See also pushData(). +.SH "QMovie::QMovie ( QDataSource * src, int bufsize = 1024 )" +Constructs a QMovie that reads an image sequence from the given data source, \fIsrc\fR. The source must be allocated dynamically, because QMovie will take ownership of it and will destroy it when the movie is destroyed. The movie starts playing as soon as event processing continues. +.PP +The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. +.SH "QMovie::QMovie ( const QString & fileName, int bufsize = 1024 )" +Constructs a QMovie that reads an image sequence from the file, \fIfileName\fR. +.PP +The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. +.SH "QMovie::QMovie ( QByteArray data, int bufsize = 1024 )" +Constructs a QMovie that reads an image sequence from the byte array, \fIdata\fR. +.PP +The \fIbufsize\fR argument sets the maximum amount of data the movie will transfer from the data source per event loop. The lower this value, the better interleaved the movie playback will be with other event processing, but the slower the overall processing will be. +.SH "QMovie::QMovie ( const QMovie & movie )" +Constructs a movie that uses the same data as movie \fImovie\fR. QMovies use explicit sharing, so operations on the copy will affect both. +.SH "QMovie::~QMovie ()" +Destroys the QMovie. If this is the last reference to the data of the movie, the data is deallocated. +.SH "const QColor & QMovie::backgroundColor () const" +Returns the background color of the movie set by setBackgroundColor(). +.SH "void QMovie::connectResize ( QObject * receiver, const char * member )" +Connects the \fIreceiver\fR's \fImember\fR of type \fCvoid member(const QSize&)\fR so that it is signalled when the movie changes size. +.PP +Note that due to the explicit sharing of QMovie objects, these connections persist until they are explicitly disconnected with disconnectResize() or until \fIevery\fR shared copy of the movie is deleted. +.PP +Example: movies/main.cpp. +.SH "void QMovie::connectStatus ( QObject * receiver, const char * member )" +Connects the \fIreceiver\fR's \fImember\fR, of type \fCvoid member(int)\fR so that it is signalled when the movie changes status. The status codes are negative for errors and positive for information. +.PP +<center>.nf +.TS +l - l. Status Code Meaning QMovie::SourceEmpty signalled if the input cannot be read. QMovie::UnrecognizedFormat signalled if the input data is unrecognized. QMovie::Paused signalled when the movie is paused by a call to paused() or by after stepping pauses. QMovie::EndOfFrame signalled at end-of-frame after any update and Paused signals. QMovie::EndOfLoop signalled at end-of-loop, after any update signals, EndOfFrame - but before EndOfMovie. QMovie::EndOfMovie +.TE +.fi +</center> +.PP +More status messages may be added in the future, so a general test for errors would test for negative. +.PP +Note that due to the explicit sharing of QMovie objects, these connections persist until they are explicitly disconnected with disconnectStatus() or until \fIevery\fR shared copy of the movie is deleted. +.PP +Example: movies/main.cpp. +.SH "void QMovie::connectUpdate ( QObject * receiver, const char * member )" +Connects the \fIreceiver\fR's \fImember\fR of type \fCvoid member(const QRect&)\fR so that it is signalled when an area of the framePixmap() has changed since the previous frame. +.PP +Note that due to the explicit sharing of QMovie objects, these connections persist until they are explicitly disconnected with disconnectUpdate() or until \fIevery\fR shared copy of the movie is deleted. +.PP +Example: movies/main.cpp. +.SH "void QMovie::disconnectResize ( QObject * receiver, const char * member = 0 )" +Disconnects the \fIreceiver\fR's \fImember\fR (or all members if \fImember\fR is zero) that were previously connected by connectResize(). +.SH "void QMovie::disconnectStatus ( QObject * receiver, const char * member = 0 )" +Disconnects the \fIreceiver\fR's \fImember\fR (or all members if \fImember\fR is zero) that were previously connected by connectStatus(). +.SH "void QMovie::disconnectUpdate ( QObject * receiver, const char * member = 0 )" +Disconnects the \fIreceiver\fR's \fImember\fR (or all members if \\q member is zero) that were previously connected by connectUpdate(). +.SH "bool QMovie::finished () const" +Returns TRUE if the image is no longer playing: this happens when all loops of all frames are complete; otherwise returns FALSE. +.PP +Example: movies/main.cpp. +.SH "const QImage & QMovie::frameImage () const" +Returns the current frame of the movie, as a QImage. It is not generally useful to keep a copy of this image. Also note that you must not call this function if the movie is finished(), since by then the image will not be available. +.PP +See also framePixmap(). +.SH "int QMovie::frameNumber () const" +Returns the number of times EndOfFrame has been emitted since the start of the current loop of the movie. Thus, before any EndOfFrame has been emitted the value will be 0; within slots processing the first signal, frameNumber() will be 1, and so on. +.SH "const QPixmap & QMovie::framePixmap () const" +Returns the current frame of the movie, as a QPixmap. It is not generally useful to keep a copy of this pixmap. It is better to keep a copy of the QMovie and get the framePixmap() only when needed for drawing. +.PP +See also frameImage(). +.PP +Example: movies/main.cpp. +.SH "const QRect & QMovie::getValidRect () const" +Returns the area of the pixmap for which pixels have been generated. +.SH "bool QMovie::isNull () const" +Returns TRUE if the movie is null; otherwise returns FALSE. +.SH "QMovie & QMovie::operator= ( const QMovie & movie )" +Makes this movie use the same data as movie \fImovie\fR. QMovies use explicit sharing. +.SH "void QMovie::pause ()" +Pauses the progress of the animation. +.PP +See also unpause(). +.PP +Example: movies/main.cpp. +.SH "bool QMovie::paused () const" +Returns TRUE if the image is paused; otherwise returns FALSE. +.PP +Example: movies/main.cpp. +.SH "void QMovie::pushData ( const uchar * data, int length )" +Pushes \fIlength\fR bytes from \fIdata\fR into the movie. \fIlength\fR must be no more than the amount returned by pushSpace() since the previous call to pushData(). +.SH "int QMovie::pushSpace () const" +Returns the maximum amount of data that can currently be pushed into the movie by a call to pushData(). This is affected by the initial buffer size, but varies as the movie plays and data is consumed. +.SH "void QMovie::restart ()" +Rewinds the movie to the beginning. If the movie has not been paused, it begins playing again. +.PP +Example: movies/main.cpp. +.SH "bool QMovie::running () const" +Returns TRUE if the image is not single-stepping, not paused, and not finished; otherwise returns FALSE. +.SH "void QMovie::setBackgroundColor ( const QColor & c )" +Sets the background color of the pixmap to \fIc\fR. If the background color isValid(), the pixmap will never have a mask because the background color will be used in transparent regions of the image. +.PP +See also backgroundColor(). +.SH "void QMovie::setSpeed ( int percent )" +Sets the movie's play speed as a percentage, to \fIpercent\fR. This is a percentage of the speed dictated by the input data format. The default is 100 percent. +.SH "int QMovie::speed () const" +Returns the movie's play speed as a percentage. The default is 100 percent. +.PP +See also setSpeed(). +.SH "void QMovie::step ()" +Steps forward 1 frame and then pauses. +.PP +Example: movies/main.cpp. +.SH "void QMovie::step ( int steps )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Steps forward, showing \fIsteps\fR frames, and then pauses. +.SH "int QMovie::steps () const" +Returns the number of steps remaining after a call to step(). If the movie is paused, steps() returns 0. If it's running normally or is finished, steps() returns a negative number. +.PP +Example: movies/main.cpp. +.SH "void QMovie::unpause ()" +Unpauses the progress of the animation. +.PP +See also pause(). +.PP +Example: movies/main.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmovie.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmovie.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmutex.3qt b/doc/man/man3/tqmutex.3qt new file mode 100644 index 000000000..b5e92dbe7 --- /dev/null +++ b/doc/man/man3/tqmutex.3qt @@ -0,0 +1,213 @@ +'\" t +.TH QMutex 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 +QMutex \- Access serialization between threads +.SH SYNOPSIS +All the functions in this class are thread-safe when Qt is built with thread support.</p> +.PP +\fC#include <ntqmutex.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMutex\fR ( bool recursive = FALSE )" +.br +.ti -1c +.BI "virtual \fB~QMutex\fR ()" +.br +.ti -1c +.BI "void \fBlock\fR ()" +.br +.ti -1c +.BI "void \fBunlock\fR ()" +.br +.ti -1c +.BI "bool \fBlocked\fR ()" +.br +.ti -1c +.BI "bool \fBtryLock\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QMutex class provides access serialization between threads. +.PP +The purpose of a QMutex is to protect an object, data structure or section of code so that only one thread can access it at a time (This is similar to the Java \fCsynchronized\fR keyword). For example, say there is a method which prints a message to the user on two lines: +.PP +.nf +.br + int number = 6; +.br +.br + void method1() +.br + { +.br + number *= 5; +.br + number /= 4; +.br + } +.br +.br + void method2() +.br + { +.br + number *= 3; +.br + number /= 2; +.br + } +.br +.fi +.PP +If these two methods are called in succession, the following happens: +.PP +.nf +.br + // method1() +.br + number *= 5; // number is now 30 +.br + number /= 4; // number is now 7 +.br +.br + // method2() +.br + number *= 3; // nubmer is now 21 +.br + number /= 2; // number is now 10 +.br +.fi +.PP +If these two methods are called simultaneously from two threads then the following sequence could result: +.PP +.nf +.br + // Thread 1 calls method1() +.br + number *= 5; // number is now 30 +.br +.br + // Thread 2 calls method2(). +.br + // +.br + // Most likely Thread 1 has been put to sleep by the operating +.br + // system to allow Thread 2 to run. +.br + number *= 3; // number is now 90 +.br + number /= 2; // number is now 45 +.br +.br + // Thread 1 finishes executing. +.br + number /= 4; // number is now 11, instead of 10 +.br +.fi +.PP +If we add a mutex, we should get the result we want: +.PP +.nf +.br + QMutex mutex; +.br + int number = 6; +.br +.br + void method1() +.br + { +.br + mutex.lock(); +.br + number *= 5; +.br + number /= 4; +.br + mutex.unlock(); +.br + } +.br +.br + void method2() +.br + { +.br + mutex.lock(); +.br + number *= 3; +.br + number /= 2; +.br + mutex.unlock(); +.br + } +.br +.fi +.PP +Then only one thread can modify \fCnumber\fR at any given time and the result is correct. This is a trivial example, of course, but applies to any other case where things need to happen in a particular sequence. +.PP +When you call lock() in a thread, other threads that try to call lock() in the same place will block until the thread that got the lock calls unlock(). A non-blocking alternative to lock() is tryLock(). +.PP +See also Environment Classes and Threading. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMutex::QMutex ( bool recursive = FALSE )" +Constructs a new mutex. The mutex is created in an unlocked state. A recursive mutex is created if \fIrecursive\fR is TRUE; a normal mutex is created if \fIrecursive\fR is FALSE (the default). With a recursive mutex, a thread can lock the same mutex multiple times and it will not be unlocked until a corresponding number of unlock() calls have been made. +.SH "QMutex::~QMutex ()\fC [virtual]\fR" +Destroys the mutex. +.PP +\fBWarning:\fR If you destroy a mutex that still holds a lock the resultant behavior is undefined. +.SH "void QMutex::lock ()" +Attempt to lock the mutex. If another thread has locked the mutex then this call will \fIblock\fR until that thread has unlocked it. +.PP +See also unlock() and locked(). +.SH "bool QMutex::locked ()" +Returns TRUE if the mutex is locked by another thread; otherwise returns FALSE. +.PP +\fBWarning:\fR Due to differing implementations of recursive mutexes on various platforms, calling this function from the same thread that previously locked the mutex will return undefined results. +.PP +See also lock() and unlock(). +.SH "bool QMutex::tryLock ()" +Attempt to lock the mutex. If the lock was obtained, this function returns TRUE. If another thread has locked the mutex, this function returns FALSE, instead of waiting for the mutex to become available, i.e. it does not block. +.PP +If the lock was obtained, the mutex must be unlocked with unlock() before another thread can successfully lock it. +.PP +See also lock(), unlock(), and locked(). +.SH "void QMutex::unlock ()" +Unlocks the mutex. Attempting to unlock a mutex in a different thread to the one that locked it results in an error. Unlocking a mutex that is not locked results in undefined behaviour (varies between different Operating Systems' thread implementations). +.PP +See also lock() and locked(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqmutex.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmutex.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqmutexlocker.3qt b/doc/man/man3/tqmutexlocker.3qt new file mode 100644 index 000000000..580b4e03e --- /dev/null +++ b/doc/man/man3/tqmutexlocker.3qt @@ -0,0 +1,273 @@ +'\" t +.TH QMutexLocker 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 +QMutexLocker \- Simplifies locking and unlocking QMutexes +.SH SYNOPSIS +All the functions in this class are thread-safe when Qt is built with thread support.</p> +.PP +\fC#include <ntqmutex.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQMutexLocker\fR ( QMutex * mutex )" +.br +.ti -1c +.BI "\fB~QMutexLocker\fR ()" +.br +.ti -1c +.BI "QMutex * \fBmutex\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QMutexLocker class simplifies locking and unlocking QMutexes. +.PP +The purpose of QMutexLocker is to simplify QMutex locking and unlocking. Locking and unlocking a QMutex in complex functions and statements or in exception handling code is error prone and difficult to debug. QMutexLocker should be used in such situations to ensure that the state of the mutex is well defined and always locked and unlocked properly. +.PP +QMutexLocker should be created within a function where a QMutex needs to be locked. The mutex is locked when QMutexLocker is created, and unlocked when QMutexLocker is destroyed. +.PP +For example, this complex function locks a QMutex upon entering the function and unlocks the mutex at all the exit points: +.PP +.nf +.br + int complexFunction( int flag ) +.br + { +.br + mutex.lock(); +.br +.br + int return_value = 0; +.br +.br + switch ( flag ) { +.br + case 0: +.br + case 1: +.br + { +.br + mutex.unlock(); +.br + return moreComplexFunction( flag ); +.br + } +.br +.br + case 2: +.br + { +.br + int status = anotherFunction(); +.br + if ( status < 0 ) { +.br + mutex.unlock(); +.br + return -2; +.br + } +.br + return_value = status + flag; +.br + break; +.br + } +.br +.br + default: +.br + { +.br + if ( flag > 10 ) { +.br + mutex.unlock(); +.br + return -1; +.br + } +.br + break; +.br + } +.br + } +.br +.br + mutex.unlock(); +.br + return return_value; +.br + } +.br +.fi +.PP +This example function will get more complicated as it is developed, which increases the likelihood that errors will occur. +.PP +Using QMutexLocker greatly simplifies the code, and makes it more readable: +.PP +.nf +.br + int complexFunction( int flag ) +.br + { +.br + QMutexLocker locker( &mutex ); +.br +.br + int return_value = 0; +.br +.br + switch ( flag ) { +.br + case 0: +.br + case 1: +.br + { +.br + return moreComplexFunction( flag ); +.br + } +.br +.br + case 2: +.br + { +.br + int status = anotherFunction(); +.br + if ( status < 0 ) +.br + return -2; +.br + return_value = status + flag; +.br + break; +.br + } +.br +.br + default: +.br + { +.br + if ( flag > 10 ) +.br + return -1; +.br + break; +.br + } +.br + } +.br +.br + return return_value; +.br + } +.br +.fi +.PP +Now, the mutex will always be unlocked when the QMutexLocker object is destroyed (when the function returns since \fClocker\fR is an auto variable). Note that the mutex will be unlocked after the call to moreComplexFunction() in this example, avoiding possible bugs caused by unlocking the mutex too early, as in the first example. +.PP +The same principle applies to code that throws and catches exceptions. An exception that is not caught in the function that has locked the mutex has no way of unlocking the mutex before the exception is passed up the stack to the calling function. +.PP +QMutexLocker also provides a mutex() member function that returns the mutex on which the QMutexLocker is operating. This is useful for code that needs access to the mutex, such as QWaitCondition::wait(). For example: +.PP +.nf +.br + class SignalWaiter +.br + { +.br + private: +.br + QMutexLocker locker; +.br +.br + public: +.br + SignalWaiter( QMutex *mutex ) +.br + : locker( mutex ) +.br + { +.br + } +.br +.br + void waitForSignal() +.br + { +.br + ... +.br + ... +.br + ... +.br +.br + while ( ! signalled ) +.br + waitcondition.wait( locker.mutex() ); +.br +.br + ... +.br + ... +.br + ... +.br + } +.br + }; +.br +.fi +.PP +See also QMutex, QWaitCondition, Environment Classes, and Threading. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QMutexLocker::QMutexLocker ( QMutex * mutex )" +Constructs a QMutexLocker and locks \fImutex\fR. The mutex will be unlocked when the QMutexLocker is destroyed. If \fImutex\fR is zero, QMutexLocker does nothing. +.PP +See also QMutex::lock(). +.SH "QMutexLocker::~QMutexLocker ()" +Destroys the QMutexLocker and unlocks the mutex which was locked in the constructor. +.PP +See also QMutexLocker::QMutexLocker() and QMutex::unlock(). +.SH "QMutex * QMutexLocker::mutex () const" +Returns a pointer to the mutex which was locked in the constructor. +.PP +See also QMutexLocker::QMutexLocker(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qmutexlocker.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqmutexlocker.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqnetworkoperation.3qt b/doc/man/man3/tqnetworkoperation.3qt new file mode 100644 index 000000000..3520e9e08 --- /dev/null +++ b/doc/man/man3/tqnetworkoperation.3qt @@ -0,0 +1,145 @@ +'\" t +.TH QNetworkOperation 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 +QNetworkOperation \- Common operations for network protocols +.SH SYNOPSIS +\fC#include <ntqnetworkprotocol.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQNetworkOperation\fR ( QNetworkProtocol::Operation operation, const QString & arg0, const QString & arg1, const QString & arg2 )" +.br +.ti -1c +.BI "\fBQNetworkOperation\fR ( QNetworkProtocol::Operation operation, const QByteArray & arg0, const QByteArray & arg1, const QByteArray & arg2 )" +.br +.ti -1c +.BI "\fB~QNetworkOperation\fR ()" +.br +.ti -1c +.BI "void \fBsetState\fR ( QNetworkProtocol::State state )" +.br +.ti -1c +.BI "void \fBsetProtocolDetail\fR ( const QString & detail )" +.br +.ti -1c +.BI "void \fBsetErrorCode\fR ( int ec )" +.br +.ti -1c +.BI "void \fBsetArg\fR ( int num, const QString & arg )" +.br +.ti -1c +.BI "void \fBsetRawArg\fR ( int num, const QByteArray & arg )" +.br +.ti -1c +.BI "QNetworkProtocol::Operation \fBoperation\fR () const" +.br +.ti -1c +.BI "QNetworkProtocol::State \fBstate\fR () const" +.br +.ti -1c +.BI "QString \fBarg\fR ( int num ) const" +.br +.ti -1c +.BI "QByteArray \fBrawArg\fR ( int num ) const" +.br +.ti -1c +.BI "QString \fBprotocolDetail\fR () const" +.br +.ti -1c +.BI "int \fBerrorCode\fR () const" +.br +.ti -1c +.BI "void \fBfree\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QNetworkOperation class provides common operations for network protocols. +.PP +An object is created to describe the operation and the current state for each operation that a network protocol should process. +.PP +For a detailed description of the Qt Network Architecture and how to implement and use network protocols in Qt, see the Qt Network Documentation. +.PP +See also QNetworkProtocol and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QNetworkOperation::QNetworkOperation ( QNetworkProtocol::Operation operation, const QString & arg0, const QString & arg1, const QString & arg2 )" +Constructs a network operation object. \fIoperation\fR is the type of the operation, and \fIarg0\fR, \fIarg1\fR and \fIarg2\fR are the first three arguments of the operation. The state is initialized to QNetworkProtocol::StWaiting. +.PP +See also QNetworkProtocol::Operation and QNetworkProtocol::State. +.SH "QNetworkOperation::QNetworkOperation ( QNetworkProtocol::Operation operation, const QByteArray & arg0, const QByteArray & arg1, const QByteArray & arg2 )" +Constructs a network operation object. \fIoperation\fR is the type of the operation, and \fIarg0\fR, \fIarg1\fR and \fIarg2\fR are the first three raw data arguments of the operation. The state is initialized to QNetworkProtocol::StWaiting. +.PP +See also QNetworkProtocol::Operation and QNetworkProtocol::State. +.SH "QNetworkOperation::~QNetworkOperation ()" +Destructor. +.SH "QString QNetworkOperation::arg ( int num ) const" +Returns the operation's \fInum\fR-th argument. If this argument was not already set, an empty string is returned. +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "int QNetworkOperation::errorCode () const" +Returns the error code for the last error that occurred. +.SH "void QNetworkOperation::free ()" +Sets this object to delete itself when it hasn't been used for one second. +.PP +Because QNetworkOperation pointers are passed around a lot the QNetworkProtocol generally does not have enough knowledge to delete these at the correct time. If a QNetworkProtocol doesn't need an operation any more it will call this function instead. +.PP +Note: you should never need to call the method yourself. +.SH "QNetworkProtocol::Operation QNetworkOperation::operation () const" +Returns the type of the operation. +.SH "QString QNetworkOperation::protocolDetail () const" +Returns a detailed error message for the last error. This must have been set using setProtocolDetail(). +.SH "QByteArray QNetworkOperation::rawArg ( int num ) const" +Returns the operation's \fInum\fR-th raw data argument. If this argument was not already set, an empty bytearray is returned. +.SH "void QNetworkOperation::setArg ( int num, const QString & arg )" +Sets the network operation's \fInum\fR-th argument to \fIarg\fR. +.SH "void QNetworkOperation::setErrorCode ( int ec )" +Sets the error code to \fIec\fR. +.PP +If the operation failed, the protocol should set an error code to describe the error in more detail. If possible, one of the error codes defined in QNetworkProtocol should be used. +.PP +See also setProtocolDetail() and QNetworkProtocol::Error. +.SH "void QNetworkOperation::setProtocolDetail ( const QString & detail )" +If the operation failed, the error message can be specified as \fIdetail\fR. +.SH "void QNetworkOperation::setRawArg ( int num, const QByteArray & arg )" +Sets the network operation's \fInum\fR-th raw data argument to \fIarg\fR. +.SH "void QNetworkOperation::setState ( QNetworkProtocol::State state )" +Sets the \fIstate\fR of the operation object. This should be done by the network protocol during processing; at the end it should be set to QNetworkProtocol::StDone or QNetworkProtocol::StFailed, depending on success or failure. +.PP +See also QNetworkProtocol::State. +.SH "QNetworkProtocol::State QNetworkOperation::state () const" +Returns the state of the operation. You can determine whether an +operation is still waiting to be processed, is being processed, +has been processed successfully, or failed. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qnetworkoperation.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqnetworkoperation.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqnetworkprotocol.3qt b/doc/man/man3/tqnetworkprotocol.3qt new file mode 100644 index 000000000..4503d3437 --- /dev/null +++ b/doc/man/man3/tqnetworkprotocol.3qt @@ -0,0 +1,386 @@ +'\" t +.TH QNetworkProtocol 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 +QNetworkProtocol \- Common API for network protocols +.SH SYNOPSIS +\fC#include <ntqnetworkprotocol.h>\fR +.PP +Inherits QObject. +.PP +Inherited by QFtp, QHttp, and QLocalFs. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBState\fR { StWaiting = 0, StInProgress, StDone, StFailed, StStopped }" +.br +.ti -1c +.BI "enum \fBOperation\fR { OpListChildren = 1, OpMkDir = 2, OpMkdir = OpMkDir, OpRemove = 4, OpRename = 8, OpGet = 32, OpPut = 64 }" +.br +.ti -1c +.BI "enum \fBConnectionState\fR { ConHostFound, ConConnected, ConClosed }" +.br +.ti -1c +.BI "enum \fBError\fR { NoError = 0, ErrValid, ErrUnknownProtocol, ErrUnsupported, ErrParse, ErrLoginIncorrect, ErrHostNotFound, ErrListChildren, ErrListChlidren = ErrListChildren, ErrMkDir, ErrMkdir = ErrMkDir, ErrRemove, ErrRename, ErrGet, ErrPut, ErrFileNotExisting, ErrPermissionDenied }" +.br +.ti -1c +.BI "\fBQNetworkProtocol\fR ()" +.br +.ti -1c +.BI "virtual \fB~QNetworkProtocol\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetUrl\fR ( QUrlOperator * u )" +.br +.ti -1c +.BI "virtual void \fBsetAutoDelete\fR ( bool b, int i = 10000 )" +.br +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "virtual int \fBsupportedOperations\fR () const" +.br +.ti -1c +.BI "virtual void \fBaddOperation\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "QUrlOperator * \fBurl\fR () const" +.br +.ti -1c +.BI "QNetworkOperation * \fBoperationInProgress\fR () const" +.br +.ti -1c +.BI "virtual void \fBclearOperationQueue\fR ()" +.br +.ti -1c +.BI "virtual void \fBstop\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBdata\fR ( const QByteArray & data, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBconnectionStateChanged\fR ( int state, const QString & data )" +.br +.ti -1c +.BI "void \fBfinished\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBstart\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBnewChildren\fR ( const QValueList<QUrlInfo> & i, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBnewChild\fR ( const QUrlInfo & i, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBcreatedDirectory\fR ( const QUrlInfo & i, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBremoved\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBitemChanged\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBdataTransferProgress\fR ( int bytesDone, int bytesTotal, QNetworkOperation * op )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBregisterNetworkProtocol\fR ( const QString & protocol, QNetworkProtocolFactoryBase * protocolFactory )" +.br +.ti -1c +.BI "QNetworkProtocol * \fBgetNetworkProtocol\fR ( const QString & protocol )" +.br +.ti -1c +.BI "bool \fBhasOnlyLocalFileSystem\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBoperationListChildren\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "virtual void \fBoperationMkDir\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "virtual void \fBoperationRemove\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "virtual void \fBoperationRename\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "virtual void \fBoperationGet\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "virtual void \fBoperationPut\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "virtual bool \fBcheckConnection\fR ( QNetworkOperation * op )" +.br +.in -1c +.SH DESCRIPTION +The QNetworkProtocol class provides a common API for network protocols. +.PP +This is a base class which should be used for network protocols implementations that can then be used in Qt (e.g. in the file dialog) together with the QUrlOperator. +.PP +The easiest way to implement a new network protocol is to reimplement the operation*() methods, e.g. operationGet(), etc. Only the supported operations should be reimplemented. To specify which operations are supported, also reimplement supportedOperations() and return an int that is OR'd together using the supported operations from the QNetworkProtocol::Operation enum. +.PP +When you implement a network protocol this way, it is important to emit the correct signals. Also, always emit the finished() signal when an operation is done (on success \fIand\fR on failure). Qt relies on correctly emitted finished() signals. +.PP +For a detailed description of the Qt Network Architecture and how to implement and use network protocols in Qt, see the Qt Network Documentation. +.PP +See also Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QNetworkProtocol::ConnectionState" +When the connection state of a network protocol changes it emits the signal connectionStateChanged(). The first argument is one of the following values: +.TP +\fCQNetworkProtocol::ConHostFound\fR - Host has been found. +.TP +\fCQNetworkProtocol::ConConnected\fR - Connection to the host has been established. +.TP +\fCQNetworkProtocol::ConClosed\fR - Connection has been closed. +.SH "QNetworkProtocol::Error" +When an operation fails (finishes unsuccessfully), the QNetworkOperation of the operation returns an error code which has one of the following values: +.TP +\fCQNetworkProtocol::NoError\fR - No error occurred. +.TP +\fCQNetworkProtocol::ErrValid\fR - The URL you are operating on is not valid. +.TP +\fCQNetworkProtocol::ErrUnknownProtocol\fR - There is no protocol implementation available for the protocol of the URL you are operating on (e.g. if the protocol is http and no http implementation has been registered). +.TP +\fCQNetworkProtocol::ErrUnsupported\fR - The operation is not supported by the protocol. +.TP +\fCQNetworkProtocol::ErrParse\fR - The URL could not be parsed correctly. +.TP +\fCQNetworkProtocol::ErrLoginIncorrect\fR - You needed to login but the username or password is wrong. +.TP +\fCQNetworkProtocol::ErrHostNotFound\fR - The specified host (in the URL) couldn't be found. +.TP +\fCQNetworkProtocol::ErrListChildren\fR - An error occurred while listing the children (files). +.TP +\fCQNetworkProtocol::ErrMkDir\fR - An error occurred when creating a directory. +.TP +\fCQNetworkProtocol::ErrRemove\fR - An error occurred when removing a child (file). +.TP +\fCQNetworkProtocol::ErrRename\fR - An error occurred when renaming a child (file). +.TP +\fCQNetworkProtocol::ErrGet\fR - An error occurred while getting (retrieving) data. +.TP +\fCQNetworkProtocol::ErrPut\fR - An error occurred while putting (uploading) data. +.TP +\fCQNetworkProtocol::ErrFileNotExisting\fR - A file which is needed by the operation doesn't exist. +.TP +\fCQNetworkProtocol::ErrPermissionDenied\fR - Permission for doing the operation has been denied. +.PP +You should also use these error codes when implementing custom network protocols. If this is not possible, you can define your own error codes by using integer values that don't conflict with any of these values. +.SH "QNetworkProtocol::Operation" +This enum lists the possible operations that a network protocol can support. supportedOperations() returns an int of these that is OR'd together. Also, the type() of a QNetworkOperation is always one of these values. +.TP +\fCQNetworkProtocol::OpListChildren\fR - List the children of a URL, e.g. of a directory. +.TP +\fCQNetworkProtocol::OpMkDir\fR - Create a directory. +.TP +\fCQNetworkProtocol::OpRemove\fR - Remove a child (e.g. a file). +.TP +\fCQNetworkProtocol::OpRename\fR - Rename a child (e.g. a file). +.TP +\fCQNetworkProtocol::OpGet\fR - Get data from a location. +.TP +\fCQNetworkProtocol::OpPut\fR - Put data to a location. +.SH "QNetworkProtocol::State" +This enum contains the state that a QNetworkOperation can have. +.TP +\fCQNetworkProtocol::StWaiting\fR - The operation is in the QNetworkProtocol's queue waiting to be prcessed. +.TP +\fCQNetworkProtocol::StInProgress\fR - The operation is being processed. +.TP +\fCQNetworkProtocol::StDone\fR - The operation has been processed succesfully. +.TP +\fCQNetworkProtocol::StFailed\fR - The operation has been processed but an error occurred. +.TP +\fCQNetworkProtocol::StStopped\fR - The operation has been processed but has been stopped before it finished, and is waiting to be processed. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QNetworkProtocol::QNetworkProtocol ()" +Constructor of the network protocol base class. Does some initialization and connecting of signals and slots. +.SH "QNetworkProtocol::~QNetworkProtocol ()\fC [virtual]\fR" +Destructor. +.SH "void QNetworkProtocol::addOperation ( QNetworkOperation * op )\fC [virtual]\fR" +Adds the operation \fIop\fR to the operation queue. The operation will be processed as soon as possible. This method returns immediately. +.SH "bool QNetworkProtocol::autoDelete () const" +Returns TRUE if auto-deleting is enabled; otherwise returns FALSE. +.PP +See also QNetworkProtocol::setAutoDelete(). +.SH "bool QNetworkProtocol::checkConnection ( QNetworkOperation * op )\fC [virtual protected]\fR" +For processing operations the network protocol base class calls this method quite often. This should be reimplemented by new network protocols. It should return TRUE if the connection is OK (open); otherwise it should return FALSE. If the connection is not open the protocol should open it. +.PP +If the connection can't be opened (e.g. because you already tried but the host couldn't be found), set the state of \fIop\fR to QNetworkProtocol::StFailed and emit the finished() signal with this QNetworkOperation as argument. +.PP +\fIop\fR is the operation that needs an open connection. +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QNetworkProtocol::clearOperationQueue ()\fC [virtual]\fR" +Clears the operation queue. +.SH "void QNetworkProtocol::connectionStateChanged ( int state, const QString & data )\fC [signal]\fR" +This signal is emitted whenever the state of the connection of the network protocol is changed. \fIstate\fR describes the new state, which is one of, ConHostFound, ConConnected or ConClosed. \fIdata\fR is a message text. +.SH "void QNetworkProtocol::createdDirectory ( const QUrlInfo & i, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when mkdir() has been succesful and the directory has been created. \fIi\fR holds the information about the new directory. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. Using op->arg( 0 ), you can get the file name of the new directory. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. +.SH "void QNetworkProtocol::data ( const QByteArray & data, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when new \fIdata\fR has been received after calling get() or put(). \fIop\fR holds the name of the file from which data is retrieved or uploaded in its first argument, and the (raw) data in its second argument. You can get them with op->arg( 0 ) and op->rawArg( 1 ). \fIop\fR is the pointer to the operation object, which contains all the information about the operation, including the state, etc. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator (which is used by the network protocol) emit its corresponding signal. +.SH "void QNetworkProtocol::dataTransferProgress ( int bytesDone, int bytesTotal, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted during the transfer of data (using put() or get()). \fIbytesDone\fR is how many bytes of \fIbytesTotal\fR have been transferred. \fIbytesTotal\fR may be -1, which means that the total number of bytes is not known. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. +.SH "void QNetworkProtocol::finished ( QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when an operation finishes. This signal is always emitted, for both success and failure. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. Check the state and error code of the operation object to determine whether or not the operation was successful. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. +.SH "QNetworkProtocol * QNetworkProtocol::getNetworkProtocol ( const QString & protocol )\fC [static]\fR" +Static method to get a new instance of the network protocol \fIprotocol\fR. For example, if you need to do some FTP operations, do the following: +.PP +.nf +.br + QFtp *ftp = QNetworkProtocol::getNetworkProtocol( "ftp" ); +.br +.fi +This returns a pointer to a new instance of an ftp implementation or null if no protocol for ftp was registered. The ownership of the pointer is transferred to you, so you must delete it if you don't need it anymore. +.PP +Normally you should not work directly with network protocols, so you will not need to call this method yourself. Instead, use QUrlOperator, which makes working with network protocols much more convenient. +.PP +See also QUrlOperator. +.SH "bool QNetworkProtocol::hasOnlyLocalFileSystem ()\fC [static]\fR" +Returns TRUE if the only protocol registered is for working on the local filesystem; returns FALSE if other network protocols are also registered. +.SH "void QNetworkProtocol::itemChanged ( QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted whenever a file which is a child of this URL has been changed, e.g. by successfully calling rename(). \fIop\fR holds the original and the new file names in the first and second arguments, accessible with op->arg( 0 ) and op->arg( 1 ) respectively. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. +.SH "void QNetworkProtocol::newChild ( const QUrlInfo & i, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted if a new child (file) has been read. QNetworkProtocol automatically connects it to a slot which creates a list of QUrlInfo objects (with just one QUrlInfo \fIi\fR) and emits the newChildren() signal with this list. \fIop\fR is the pointer to the operation object which contains all the information about the operation that has finished, including the state, etc. +.PP +This is just a convenience signal useful for implementing your own network protocol. In all other cases connect to the newChildren() signal with its list of QUrlInfo objects. +.SH "void QNetworkProtocol::newChildren ( const QValueList<QUrlInfo> & i, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted after listChildren() was called and new children (files) have been read from the list of files. \fIi\fR holds the information about the new children. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. +.PP +When implementing your own network protocol and reading children, you usually don't read one child at once, but rather a list of them. That's why this signal takes a list of QUrlInfo objects. If you prefer to read just one child at a time you can use the convenience signal newChild(), which takes a single QUrlInfo object. +.SH "void QNetworkProtocol::operationGet ( QNetworkOperation * op )\fC [virtual protected]\fR" +When implementing a new network protocol, this method should be reimplemented if the protocol supports getting data; this method should then process the QNetworkOperation. +.PP +When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. +.PP +\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QNetworkOperation * QNetworkProtocol::operationInProgress () const" +Returns the operation, which is being processed, or 0 of no operation is being processed at the moment. +.SH "void QNetworkProtocol::operationListChildren ( QNetworkOperation * op )\fC [virtual protected]\fR" +When implementing a new network protocol, this method should be reimplemented if the protocol supports listing children (files); this method should then process this QNetworkOperation. +.PP +When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. +.PP +\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QNetworkProtocol::operationMkDir ( QNetworkOperation * op )\fC [virtual protected]\fR" +When implementing a new network protocol, this method should be reimplemented if the protocol supports making directories; this method should then process this QNetworkOperation. +.PP +When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. +.PP +\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. +.SH "void QNetworkProtocol::operationPut ( QNetworkOperation * op )\fC [virtual protected]\fR" +When implementing a new network protocol, this method should be reimplemented if the protocol supports putting (uploading) data; this method should then process the QNetworkOperation. +.PP +When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. +.PP +\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. +.SH "void QNetworkProtocol::operationRemove ( QNetworkOperation * op )\fC [virtual protected]\fR" +When implementing a new network protocol, this method should be reimplemented if the protocol supports removing children (files); this method should then process this QNetworkOperation. +.PP +When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which is describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. +.PP +\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. +.SH "void QNetworkProtocol::operationRename ( QNetworkOperation * op )\fC [virtual protected]\fR" +When implementing a new newtork protocol, this method should be reimplemented if the protocol supports renaming children (files); this method should then process this QNetworkOperation. +.PP +When you reimplement this method it's very important that you emit the correct signals at the correct time (especially the finished() signal after processing an operation). Take a look at the Qt Network Documentation which describes in detail how to reimplement this method. You may also want to look at the example implementation in examples/network/networkprotocol/nntp.cpp. +.PP +\fIop\fR is the pointer to the operation object which contains all the information on the operation that has finished, including the state, etc. +.SH "void QNetworkProtocol::registerNetworkProtocol ( const QString & protocol, QNetworkProtocolFactoryBase * protocolFactory )\fC [static]\fR" +Static method to register a network protocol for Qt. For example, if you have an implementation of NNTP (called Nntp) which is derived from QNetworkProtocol, call: +.PP +.nf +.br + QNetworkProtocol::registerNetworkProtocol( "nntp", new QNetworkProtocolFactory<Nntp> ); +.br +.fi +after which your implementation is registered for future nntp operations. +.PP +The name of the protocol is given in \fIprotocol\fR and a pointer to the protocol factory is given in \fIprotocolFactory\fR. +.SH "void QNetworkProtocol::removed ( QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when remove() has been succesful and the file has been removed. \fIop\fR holds the file name of the removed file in the first argument, accessible with op->arg( 0 ). \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. +.SH "void QNetworkProtocol::setAutoDelete ( bool b, int i = 10000 )\fC [virtual]\fR" +Because it's sometimes hard to take care of removing network protocol instances, QNetworkProtocol provides an auto-delete mechanism. If you set \fIb\fR to TRUE, the network protocol instance is removed after it has been inactive for \fIi\fR milliseconds (i.e. \fIi\fR milliseconds after the last operation has been processed). If you set \fIb\fR to FALSE the auto-delete mechanism is switched off. +.PP +If you switch on auto-delete, the QNetworkProtocol also deletes its QUrlOperator. +.SH "void QNetworkProtocol::setUrl ( QUrlOperator * u )\fC [virtual]\fR" +Sets the QUrlOperator, on which the protocol works, to \fIu\fR. +.PP +See also QUrlOperator. +.SH "void QNetworkProtocol::start ( QNetworkOperation * op )\fC [signal]\fR" +Some operations (such as listChildren()) emit this signal when they start processing the operation. \fIop\fR is the pointer to the operation object which contains all the information about the operation, including the state, etc. +.PP +When a protocol emits this signal, QNetworkProtocol is smart enough to let the QUrlOperator, which is used by the network protocol, emit its corresponding signal. +.SH "void QNetworkProtocol::stop ()\fC [virtual]\fR" +Stops the current operation that is being processed and clears all waiting operations. +.SH "int QNetworkProtocol::supportedOperations () const\fC [virtual]\fR" +Returns an int that is OR'd together using the enum values of QNetworkProtocol::Operation, which describes which operations are supported by the network protocol. Should be reimplemented by new network protocols. +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QUrlOperator * QNetworkProtocol::url () const" +Returns the QUrlOperator on which the protocol works. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqnetworkprotocol.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqnetworkprotocol.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqnpinstance.3qt b/doc/man/man3/tqnpinstance.3qt new file mode 100644 index 000000000..c47e33d49 --- /dev/null +++ b/doc/man/man3/tqnpinstance.3qt @@ -0,0 +1,290 @@ +'\" t +.TH QNPInstance 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 +QNPInstance \- QObject that is a web browser plugin +.SH SYNOPSIS +This class is part of the \fBQt Netscape Extension\fR. +.PP +\fC#include <ntqnp.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fB~QNPInstance\fR ()" +.br +.ti -1c +.BI "int \fBargc\fR () const" +.br +.ti -1c +.BI "const char * \fBargn\fR ( int i ) const" +.br +.ti -1c +.BI "const char * \fBargv\fR ( int i ) const" +.br +.ti -1c +.BI "enum \fBReason\fR { ReasonDone = 0, ReasonBreak = 1, ReasonError = 2, ReasonUnknown = -1 }" +.br +.ti -1c +.BI "const char * \fBarg\fR ( const char * name ) const" +.br +.ti -1c +.BI "enum \fBInstanceMode\fR { Embed = 1, Full = 2, Background = 3 }" +.br +.ti -1c +.BI "InstanceMode \fBmode\fR () const" +.br +.ti -1c +.BI "const char * \fBuserAgent\fR () const" +.br +.ti -1c +.BI "virtual QNPWidget * \fBnewWindow\fR ()" +.br +.ti -1c +.BI "QNPWidget * \fBwidget\fR ()" +.br +.ti -1c +.BI "enum \fBStreamMode\fR { Normal = 1, Seek = 2, AsFile = 3, AsFileOnly = 4 }" +.br +.ti -1c +.BI "virtual bool \fBnewStreamCreated\fR ( QNPStream *, StreamMode & smode )" +.br +.ti -1c +.BI "virtual int \fBwriteReady\fR ( QNPStream * )" +.br +.ti -1c +.BI "virtual int \fBwrite\fR ( QNPStream *, int offset, int len, void * buffer )" +.br +.ti -1c +.BI "virtual void \fBstreamDestroyed\fR ( QNPStream * )" +.br +.ti -1c +.BI "void \fBstatus\fR ( const char * msg )" +.br +.ti -1c +.BI "void \fBgetURLNotify\fR ( const char * url, const char * window = 0, void * data = 0 )" +.br +.ti -1c +.BI "void \fBgetURL\fR ( const char * url, const char * window = 0 )" +.br +.ti -1c +.BI "void \fBpostURL\fR ( const char * url, const char * window, uint len, const char * buf, bool file )" +.br +.ti -1c +.BI "QNPStream * \fBnewStream\fR ( const char * mimetype, const char * window, bool as_file = FALSE )" +.br +.ti -1c +.BI "virtual void \fBstreamAsFile\fR ( QNPStream *, const char * fname )" +.br +.ti -1c +.BI "void * \fBgetJavaPeer\fR () const" +.br +.ti -1c +.BI "virtual void \fBnotifyURL\fR ( const char * url, Reason r, void * notifyData )" +.br +.ti -1c +.BI "virtual bool \fBprintFullPage\fR ()" +.br +.ti -1c +.BI "virtual void \fBprint\fR ( QPainter * )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQNPInstance\fR ()" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QNPInstance class provides a QObject that is a web browser plugin. +.PP +Deriving from QNPInstance creates an object that represents a single \fC<EMBED>\fR tag in an HTML document. +.PP +The QNPInstance is responsible for creating an appropriate QNPWidget window if required (not all plugins have windows), and for interacting with the input/output facilities intrinsic to plugins. +.PP +Note that there is \fIabsolutely no guarantee\fR regarding the order in which functions are called. Sometimes the browser will call newWindow() first, at other times, newStreamCreated() will be called first (assuming the \fC<EMBED>\fR tag has a SRC parameter). +.PP +\fINone of Qt's GUI functionality\fR may be used until after the first call to newWindow(). This includes any use of QPaintDevice (i.e. QPixmap, QWidget, and all subclasses), QApplication, anything related to QPainter (QBrush, etc.), fonts, QMovie, QToolTip, etc. Useful classes which specifically \fIcan\fR be used are QImage, QFile, and QBuffer. +.PP +This restriction can easily be accommodated by structuring your plugin so that the task of the QNPInstance is to gather data, while the task of the QNPWidget is to provide a graphical interface to that data. +.SS "Member Type Documentation" +.SH "QNPInstance::InstanceMode" +This enum type provides Qt-style names for three #defines in \fCnpapi.h\fR: +.TP +\fCQNPInstance::Embed\fR - corresponds to NP_EMBED +.TP +\fCQNPInstance::Full\fR - corresponds to NP_FULL +.TP +\fCQNPInstance::Background\fR - corresponds to NP_BACKGROUND +.SH "QNPInstance::Reason" +.TP +\fCQNPInstance::ReasonDone\fR +.TP +\fCQNPInstance::ReasonBreak\fR +.TP +\fCQNPInstance::ReasonError\fR +.TP +\fCQNPInstance::ReasonUnknown\fR +.SH "QNPInstance::StreamMode" +.TP +\fCQNPInstance::Normal\fR +.TP +\fCQNPInstance::Seek\fR +.TP +\fCQNPInstance::AsFile\fR +.TP +\fCQNPInstance::AsFileOnly\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QNPInstance::QNPInstance ()\fC [protected]\fR" +Creates a QNPInstance. +.PP +Can only be called from within a derived class created within QNPlugin::newInstance(). +.SH "QNPInstance::~QNPInstance ()" +Called when the plugin instance is about to be deleted. +.SH "const char * QNPInstance::arg ( const char * name ) const" +Returns the value of the named arguments, or 0 if no argument called \fIname\fR appears in the \fC<EMBED>\fR tag of this instance. If the argument appears, but has no value assigned, the empty string is returned. In summary: +.PP +<center>.nf +.TS +l +- +l. +Tag Result + arg("FOO") == 0 + arg("FOO") == "" + +.TE +.fi +</center> +.SH "int QNPInstance::argc () const" +Returns the number of arguments to the instance. Note that you should not normally rely on the ordering of arguments, and note that the SGML specification does not permit multiple arguments with the same name. +.PP +See also arg() and argn(). +.SH "const char * QNPInstance::argn ( int i ) const" +Returns the name of the \fIi\fR-th argument. +.PP +See also argc() and argv(). +.SH "const char * QNPInstance::argv ( int i ) const" +Returns the value of the \fIi\fR-th argument. +.PP +\\as argc(), arg() +.SH "void * QNPInstance::getJavaPeer () const" +Returns the Java object associated with the plugin instance, an object of the plugin's Java class, or 0 if the plug-in does not have a Java class, Java is disabled, or an error occurred. +.PP +The return value is actually a \fCjref\fR we use \fCvoid*\fR so as to avoid burdening plugins which do not require Java. +.PP +See also QNPlugin::getJavaClass() and QNPlugin::getJavaEnv(). +.SH "void QNPInstance::getURL ( const char * url, const char * window = 0 )" +Requests that the \fIurl\fR be retrieved and sent to the named \fIwindow\fR. See Netscape's JavaScript documentation for an explanation of window names. +.SH "void QNPInstance::getURLNotify ( const char * url, const char * window = 0, void * data = 0 )" +Requests that the given \fIurl\fR be retrieved and sent to the named \fIwindow\fR. See Netscape's JavaScript documentation for an explanation of window names. Passes the arguments including \fIdata\fR to NPN_GetURLNotify. +.PP +Netscape: NPN_GetURLNotify method +.SH "InstanceMode QNPInstance::mode () const" +Returns the mode of the plugin. +.SH "QNPStream * QNPInstance::newStream ( const char * mimetype, const char * window, bool as_file = FALSE )" +\fBThis function is under development and is subject to change.\fR +.PP +This function is \fInot tested\fR. +.PP +Requests the creation of a new data stream \fIfrom\fR the plugin. The MIME type and window are passed in \fImimetype\fR and \fIwindow\fR. \fIas_file\fR holds the AsFileOnly flag. It is an interface to the NPN_NewStream function of the Netscape Plugin API. +.SH "bool QNPInstance::newStreamCreated ( QNPStream *, StreamMode & smode )\fC [virtual]\fR" +This function is called when a new stream has been created. The instance should return TRUE if it accepts the processing of the stream. If the instance requires the stream as a file, it should set \fIsmode\fR to AsFileOnly, in which case the data will be delivered some time later to the streamAsFile() function. Otherwise, the data will be delivered in chunks to the write() function, which must consume at least as much data as returned by the most recent call to writeReady(). +.PP +Note that the AsFileOnly method is not supported by Netscape 2.0 and MSIE 3.0. +.PP +The default implementation accepts any stream. +.SH "QNPWidget * QNPInstance::newWindow ()\fC [virtual]\fR" +Called at most once, at some time after the QNPInstance is created. If the plugin requires a window, this function should return a derived class of QNPWidget that provides the required interface. +.PP +Example: grapher/grapher.cpp. +.SH "void QNPInstance::notifyURL ( const char * url, Reason r, void * notifyData )\fC [virtual]\fR" +\fBThis function is under development and is subject to change.\fR +.PP +This function is \fInot tested\fR. +.PP +Called whenever a \fIurl\fR is notified after a call to NPN_GetURLNotify with \fInotifyData\fR. The reason is given in \fIr\fR. +.PP +It is an encapsulation of the NPP_URLNotify function of the Netscape Plugin API. +.PP +See also: Netscape: NPP_URLNotify method +.SH "void QNPInstance::postURL ( const char * url, const char * window, uint len, const char * buf, bool file )" +\fBThis function is under development and is subject to change.\fR +.PP +This function is \fInot tested\fR. +.PP +It is an interface to the NPN_PostURL function of the Netscape Plugin API. +.PP +Passes \fIurl\fR, \fIwindow\fR, \fIbuf\fR, \fIlen\fR, and \fIfile\fR to NPN_PostURL. +.SH "void QNPInstance::print ( QPainter * )\fC [virtual]\fR" +\fBThis function is under development and is subject to change.\fR +.PP +This function is \fInot tested\fR. +.PP +Print the instance embedded in a page. +.PP +It is an encapsulation of the NPP_Print function of the Netscape Plugin API. +.SH "bool QNPInstance::printFullPage ()\fC [virtual]\fR" +\fBThis function is under development and is subject to change.\fR +.PP +This function is \fInot tested\fR. +.PP +It is an encapsulation of the NPP_Print function of the Netscape Plugin API. +.SH "void QNPInstance::status ( const char * msg )" +Sets the status message in the browser containing this instance to \fImsg\fR. +.SH "void QNPInstance::streamAsFile ( QNPStream *, const char * fname )\fC [virtual]\fR" +Called when a stream is delivered as a single file called \fIfname\fR rather than as chunks. This may be simpler for a plugin to deal with, but precludes any incremental behavior. +.PP +Note that the AsFileOnly method is not supported by Netscape 2.0 and MSIE 3.0. +.PP +See also newStreamCreated() and newStream(). +.SH "void QNPInstance::streamDestroyed ( QNPStream * )\fC [virtual]\fR" +Called when a stream is destroyed. At this point, the stream may be complete() and okay(). If it is not okay(), then an error has occurred. If it is okay(), but not complete(), then the user has cancelled the transmission; do not give an error message in this case. +.SH "const char * QNPInstance::userAgent () const" +Returns the user agent (browser name) containing this instance. +.SH "QNPWidget * QNPInstance::widget ()" +Returns the plugin window created by newWindow(), if any. +.SH "int QNPInstance::write ( QNPStream *, int offset, int len, void * buffer )\fC [virtual]\fR" +Called when incoming data is available for processing by the instance. The instance \fImust\fR consume at least the amount that it returned in the most recent call to writeReady(), but it may consume up to the amount given by \fIlen\fR. \fIbuffer\fR is the data available for consumption. The \fIoffset\fR argument is merely an informational value indicating the total amount of data that has been consumed in prior calls. +.PP +This function should return the amount of data actually consumed. +.PP +Example: grapher/grapher.cpp. +.SH "int QNPInstance::writeReady ( QNPStream * )\fC [virtual]\fR" +Returns the minimum amount of data the instance is willing to receive from the given stream. +.PP +The default returns a very large value. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qnpinstance.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqnpinstance.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqnplugin.3qt b/doc/man/man3/tqnplugin.3qt new file mode 100644 index 000000000..82c222dbc --- /dev/null +++ b/doc/man/man3/tqnplugin.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QNPlugin 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 +QNPlugin \- The main factory for plugin objects +.SH SYNOPSIS +This class is part of the \fBQt Netscape Extension\fR. +.PP +\fC#include <ntqnp.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QNPlugin\fR ()" +.br +.ti -1c +.BI "void \fBgetVersionInfo\fR ( int & plugin_major, int & plugin_minor, int & browser_major, int & browser_minor )" +.br +.ti -1c +.BI "virtual QNPInstance * \fBnewInstance\fR () = 0" +.br +.ti -1c +.BI "virtual const char * \fBgetMIMEDescription\fR () const = 0" +.br +.ti -1c +.BI "virtual const char * \fBgetPluginNameString\fR () const = 0" +.br +.ti -1c +.BI "virtual const char * \fBgetPluginDescriptionString\fR () const = 0" +.br +.ti -1c +.BI "virtual void * \fBgetJavaClass\fR ()" +.br +.ti -1c +.BI "virtual void \fBunuseJavaClass\fR ()" +.br +.ti -1c +.BI "void * \fBgetJavaEnv\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QNPlugin * \fBcreate\fR ()" +.br +.ti -1c +.BI "QNPlugin * \fBactual\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQNPlugin\fR ()" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QNPlugin class provides the main factory for plugin objects. +.PP +This class is the heart of the plugin. One instance of this object is created when the plugin is \fIfirst\fR needed, by calling QNPlugin::create(), which must be implemented in your plugin code to return some derived class of QNPlugin. The one QNPlugin object creates all QNPInstance instances for a web browser running in a single process. +.PP +Additionally, if Qt is linked to the plugin as a dynamic library, only one instance of QApplication will exist \fIacross all plugins that have been made with Qt\fR. So, your plugin should tread lightly on global settings. Do not, for example, use QApplication::setFont() - that will change the font in every widget of every Qt-based plugin currently loaded! +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QNPlugin::QNPlugin ()\fC [protected]\fR" +Creates a QNPlugin. This may only be used by the constructor of the class, derived from QNPlugin, that is returned by your plugin's implementation of the QNPlugin::create() function. +.SH "QNPlugin::~QNPlugin ()\fC [virtual]\fR" +Destroys the QNPlugin. This is called by the plugin binding code just before the plugin is about to be unloaded from memory. If newWindow() has been called, a QApplication will still exist at this time, but will be deleted shortly after, just before the plugin is deleted. +.SH "QNPlugin * QNPlugin::actual ()\fC [static]\fR" +Returns the plugin most recently returned by QNPlugin::create(). +.SH "QNPlugin * QNPlugin::create ()\fC [static]\fR" +This function must be implemented by your plugin code. It should return a derived class of QNPlugin. +.SH "void * QNPlugin::getJavaClass ()\fC [virtual]\fR" +Override this function to return a reference to the Java class that represents the plugin. The default returns 0, indicating no class. +.PP +If you override this class, you must also override QNPlugin::unuseJavaClass(). +.PP +The return value is actually a \fCjref\fR; we use \fCvoid*\fR so as to avoid burdening plugins which do not require Java. +.PP +See also getJavaEnv() and QNPInstance::getJavaPeer(). +.SH "void * QNPlugin::getJavaEnv () const" +Returns a pointer to the Java execution environment, or 0 if either Java is disabled or an error occurred. +.PP +The return value is actually a \fCJRIEnv*\fR; we use \fCvoid*\fR so as to avoid burdening plugins which do not require Java. +.PP +See also getJavaClass() and QNPInstance::getJavaPeer(). +.SH "const char * QNPlugin::getMIMEDescription () const\fC [pure virtual]\fR" +Override this function to return the MIME description of the data formats supported by your plugin. The format of this string is shown by the following example: +.PP +.nf +.br + const char* getMIMEDescription() const +.br + { +.br + return "image/x-png:png:PNG Image;" +.br + "image/png:png:PNG Image;" +.br + "image/x-portable-bitmap:pbm:PBM Image;" +.br + "image/x-portable-graymap:pgm:PGM Image;" +.br + "image/x-portable-pixmap:ppm:PPM Image;" +.br + "image/bmp:bmp:BMP Image;" +.br + "image/x-ms-bmp:bmp:BMP Image;" +.br + "image/x-xpixmap:xpm:XPM Image;" +.br + "image/xpm:xpm:XPM Image"; +.br + } +.fi +.SH "const char * QNPlugin::getPluginDescriptionString () const\fC [pure virtual]\fR" +Returns a pointer to the plain-text description of the plugin. +.SH "const char * QNPlugin::getPluginNameString () const\fC [pure virtual]\fR" +Returns a pointer to the plain-text name of the plugin. +.SH "void QNPlugin::getVersionInfo ( int & plugin_major, int & plugin_minor, int & browser_major, int & browser_minor )" +Populates \fI*\fR\fIplugin_major\fR and \fI*\fR\fIplugin_minor\fR with the version of the plugin API and populates \fI*\fR\fIbrowser_major\fR and \fI*\fR\fIbrowser_minor\fR with the version of the web browser. +.SH "QNPInstance * QNPlugin::newInstance ()\fC [pure virtual]\fR" +Override this function to return an appropriate derived class of QNPInstance. +.SH "void QNPlugin::unuseJavaClass ()\fC [virtual]\fR" +This function is called when the plugin is shutting down. The +function should \fIunuse\fR the Java class returned earlier by +getJavaClass(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qnplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqnplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqnpstream.3qt b/doc/man/man3/tqnpstream.3qt new file mode 100644 index 000000000..443d0d9f8 --- /dev/null +++ b/doc/man/man3/tqnpstream.3qt @@ -0,0 +1,114 @@ +'\" t +.TH QNPStream 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 +QNPStream \- Stream of data provided to a QNPInstance by the browser +.SH SYNOPSIS +This class is part of the \fBQt Netscape Extension\fR. +.PP +\fC#include <ntqnp.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fB~QNPStream\fR ()" +.br +.ti -1c +.BI "const char * \fBurl\fR () const" +.br +.ti -1c +.BI "uint \fBend\fR () const" +.br +.ti -1c +.BI "uint \fBlastModified\fR () const" +.br +.ti -1c +.BI "const char * \fBtype\fR () const" +.br +.ti -1c +.BI "bool \fBseekable\fR () const" +.br +.ti -1c +.BI "bool \fBokay\fR () const" +.br +.ti -1c +.BI "bool \fBcomplete\fR () const" +.br +.ti -1c +.BI "void \fBrequestRead\fR ( int offset, uint length )" +.br +.ti -1c +.BI "int \fBwrite\fR ( int len, void * buffer )" +.br +.ti -1c +.BI "QNPInstance * \fBinstance\fR ()" +.br +.ti -1c +.BI "\fBQNPStream\fR ( QNPInstance * in, const char * mt, _NPStream * st, bool se )" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QNPStream class provides a stream of data provided to a QNPInstance by the browser. +.PP +Note that this is neither a QTextStream nor a QDataStream. +.PP +See also QNPInstance::write() and QNPInstance::newStreamCreated(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QNPStream::QNPStream ( QNPInstance * in, const char * mt, _NPStream * st, bool se )" +Creates a stream. Plugins should not call this; they should call QNPInstance::newStream() if they need a stream. +.PP +Takes a QNPInstance \fIin\fR, MIME type \fImt\fR, a pointer to an _NPStream \fIst\fR and a seekable flag \fIse\fR. +.SH "QNPStream::~QNPStream ()" +Destroys the stream. +.SH "bool QNPStream::complete () const" +Returns TRUE if the stream has received all the data from the source; otherwise returns FALSE. +.SH "uint QNPStream::end () const" +Returns the length of the stream in bytes. The function might return 0 for streams of unknown length. +.SH "QNPInstance * QNPStream::instance ()" +Returns the QNPInstance for which this stream was created. +.SH "uint QNPStream::lastModified () const" +Returns the time when the source of the stream was last modified. +.SH "bool QNPStream::okay () const" +Returns TRUE if no errors have occurred on the stream; otherwise returns FALSE. +.SH "void QNPStream::requestRead ( int offset, uint length )" +Requests the section of the stream, of \fIlength\fR bytes from \fIoffset\fR, be sent to the QNPInstance::write() function of the instance() of this stream. +.SH "bool QNPStream::seekable () const" +Returns TRUE if the stream is seekable; otherwise returns FALSE. +.SH "const char * QNPStream::type () const" +Returns the MIME type of the stream. +.SH "const char * QNPStream::url () const" +Returns the URL from which the stream was created. +.SH "int QNPStream::write ( int len, void * buffer )" +Writes \fIlen\fR bytes from \fIbuffer\fR \fIto\fR the stream. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qnpstream.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqnpstream.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqnpwidget.3qt b/doc/man/man3/tqnpwidget.3qt new file mode 100644 index 000000000..5b86e3bd4 --- /dev/null +++ b/doc/man/man3/tqnpwidget.3qt @@ -0,0 +1,129 @@ +'\" t +.TH QNPWidget 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 +QNPWidget \- QWidget that is a web browser plugin window +.SH SYNOPSIS +This class is part of the \fBQt Netscape Extension\fR. +.PP +\fC#include <ntqnp.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQNPWidget\fR ()" +.br +.ti -1c +.BI "\fB~QNPWidget\fR ()" +.br +.ti -1c +.BI "virtual void \fBenterInstance\fR ()" +.br +.ti -1c +.BI "virtual void \fBleaveInstance\fR ()" +.br +.ti -1c +.BI "QNPInstance * \fBinstance\fR ()" +.br +.in -1c +.SH DESCRIPTION +This class is defined in the \fBQt Netscape Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +.PP +The QNPWidget class provides a QWidget that is a web browser plugin window. +.PP +Derive from QNPWidget to create a widget that can be used as a web browser plugin window, or create one and add child widgets. Instances of QNPWidget may only be created when QNPInstance::newWindow() is called by the browser. +.PP +A common way to develop a plugin widget is to develop it as a stand-alone application window, then make it a \fIchild\fR of a plugin widget to use it as a browser plugin. The technique is: +.PP +.nf +.br +class MyPluginWindow : public QNPWidget +.br +{ +.br + QWidget* child; +.br +public: +.br + MyPluginWindow() +.br + { +.br + // Some widget that is normally used as a top-level widget +.br + child = new MyIndependentlyDevelopedWidget(); +.br +.br + // Use the background color of the web page +.br + child->setBackgroundColor( backgroundColor() ); +.br +.br + // Fill the plugin widget +.br + child->setGeometry( 0, 0, width(), height() ); +.br + } +.br +.br + void resizeEvent(QResizeEvent*) +.br + { +.br + // Fill the plugin widget +.br + child->resize(size()); +.br + } +.br +}; +.fi +.PP +The default implementation is an empty window. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QNPWidget::QNPWidget ()" +Creates a QNPWidget. +.SH "QNPWidget::~QNPWidget ()" +Destroys the window. This will be called by the plugin binding code when the window is no longer required. The web browser will delete windows when they leave the page. The bindings will change the QWidget::winId() of the window when the window is resized, but this should not affect normal widget behavior. +.SH "void QNPWidget::enterInstance ()\fC [virtual]\fR" +Called when the mouse enters the plugin window. Does nothing by default. +.PP +Example: grapher/grapher.cpp. +.SH "QNPInstance * QNPWidget::instance ()" +Returns the instance for which this widget is the plugin window. +.SH "void QNPWidget::leaveInstance ()\fC [virtual]\fR" +Called when the mouse leaves the plugin window. Does nothing by default. +.PP +Example: grapher/grapher.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qnpwidget.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqnpwidget.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqobject.3qt b/doc/man/man3/tqobject.3qt new file mode 100644 index 000000000..773e6620a --- /dev/null +++ b/doc/man/man3/tqobject.3qt @@ -0,0 +1,1002 @@ +'\" t +.TH QObject 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 +QObject \- The base class of all Qt objects +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqobject.h>\fR +.PP +Inherits Qt. +.PP +Inherited by QAccel, QAccessibleObject, QAction, QApplication, QAssistantClient, QDataPump, QAxObject, QAxScript, QAxScriptManager, QWidget, QCanvas, QStyle, QClipboard, QCopChannel, QDns, QLayout, QDragObject, QEditorFactory, QEventLoop, QFileIconProvider, QNetworkProtocol, QWSKeyboardHandler, QNetworkOperation, QNPInstance, QObjectCleanupHandler, QProcess, QServerSocket, QSessionManager, QSignal, QSignalMapper, QSocket, QSocketNotifier, QSound, QSqlDatabase, QSqlDriver, QSqlForm, QStyleSheet, QTimer, QToolTipGroup, QTranslator, QUrlOperator, and QValidator. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQObject\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QObject\fR ()" +.br +.ti -1c +.BI "virtual const char * \fBclassName\fR () const" +.br +.ti -1c +.BI "virtual QMetaObject * \fBmetaObject\fR () const" +.br +.ti -1c +.BI "virtual bool \fBevent\fR ( QEvent * e )" +.br +.ti -1c +.BI "virtual bool \fBeventFilter\fR ( QObject * watched, QEvent * e )" +.br +.ti -1c +.BI "bool \fBisA\fR ( const char * clname ) const" +.br +.ti -1c +.BI "bool \fBinherits\fR ( const char * clname ) const" +.br +.ti -1c +.BI "const char * \fBname\fR () const" +.br +.ti -1c +.BI "const char * \fBname\fR ( const char * defaultName ) const" +.br +.ti -1c +.BI "virtual void \fBsetName\fR ( const char * name )" +.br +.ti -1c +.BI "bool \fBisWidgetType\fR () const" +.br +.ti -1c +.BI "bool \fBhighPriority\fR () const" +.br +.ti -1c +.BI "bool \fBsignalsBlocked\fR () const" +.br +.ti -1c +.BI "void \fBblockSignals\fR ( bool block )" +.br +.ti -1c +.BI "int \fBstartTimer\fR ( int interval )" +.br +.ti -1c +.BI "void \fBkillTimer\fR ( int id )" +.br +.ti -1c +.BI "void \fBkillTimers\fR ()" +.br +.ti -1c +.BI "QObject * \fBchild\fR ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = TRUE )" +.br +.ti -1c +.BI "const QObjectList * \fBchildren\fR () const" +.br +.ti -1c +.BI "QObjectList * \fBqueryList\fR ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = TRUE, bool recursiveSearch = TRUE ) const" +.br +.ti -1c +.BI "virtual void \fBinsertChild\fR ( QObject * obj )" +.br +.ti -1c +.BI "virtual void \fBremoveChild\fR ( QObject * obj )" +.br +.ti -1c +.BI "void \fBinstallEventFilter\fR ( const QObject * filterObj )" +.br +.ti -1c +.BI "void \fBremoveEventFilter\fR ( const QObject * obj )" +.br +.ti -1c +.BI "bool \fBconnect\fR ( const QObject * sender, const char * signal, const char * member ) const" +.br +.ti -1c +.BI "bool \fBdisconnect\fR ( const char * signal = 0, const QObject * receiver = 0, const char * member = 0 )" +.br +.ti -1c +.BI "bool \fBdisconnect\fR ( const QObject * receiver, const char * member = 0 )" +.br +.ti -1c +.BI "void \fBdumpObjectTree\fR ()" +.br +.ti -1c +.BI "void \fBdumpObjectInfo\fR ()" +.br +.ti -1c +.BI "virtual bool \fBsetProperty\fR ( const char * name, const QVariant & value )" +.br +.ti -1c +.BI "virtual QVariant \fBproperty\fR ( const char * name ) const" +.br +.ti -1c +.BI "QObject * \fBparent\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBdeleteLater\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBdestroyed\fR ()" +.br +.ti -1c +.BI "void \fBdestroyed\fR ( QObject * obj )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBtr\fR ( const char * sourceText, const char * comment )" +.br +.ti -1c +.BI "QString \fBtrUtf8\fR ( const char * sourceText, const char * comment )" +.br +.ti -1c +.BI "const QObjectList * \fBobjectTrees\fR ()" +.br +.ti -1c +.BI "bool \fBconnect\fR ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "bool \fBdisconnect\fR ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QCString \fBname\fR - the name of this object" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "const QObject * \fBsender\fR ()" +.br +.ti -1c +.BI "virtual void \fBtimerEvent\fR ( QTimerEvent * )" +.br +.ti -1c +.BI "virtual void \fBchildEvent\fR ( QChildEvent * )" +.br +.ti -1c +.BI "virtual void \fBcustomEvent\fR ( QCustomEvent * )" +.br +.ti -1c +.BI "virtual void \fBconnectNotify\fR ( const char * signal )" +.br +.ti -1c +.BI "virtual void \fBdisconnectNotify\fR ( const char * signal )" +.br +.ti -1c +.BI "virtual bool \fBcheckConnectArgs\fR ( const char * signal, const QObject * receiver, const char * member )" +.br +.in -1c +.SS "Static Protected Members" +.in +1c +.ti -1c +.BI "QCString \fBnormalizeSignalSlot\fR ( const char * signalSlot )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "void * \fBqt_find_obj_child\fR ( QObject * parent, const char * type, const char * name )" +.br +.in -1c +.SH DESCRIPTION +The QObject class is the base class of all Qt objects. +.PP +QObject is the heart of the Qt object model. The central feature in this model is a very powerful mechanism for seamless object communication called signals and slots. You can connect a signal to a slot with connect() and destroy the connection with disconnect(). To avoid never ending notification loops you can temporarily block signals with blockSignals(). The protected functions connectNotify() and disconnectNotify() make it possible to track connections. +.PP +QObjects organize themselves in object trees. When you create a QObject with another object as parent, the object will automatically do an insertChild() on the parent and thus show up in the parent's children() list. The parent takes ownership of the object i.e. it will automatically delete its children in its destructor. You can look for an object by name and optionally type using child() or queryList(), and get the list of tree roots using objectTrees(). +.PP +Every object has an object name() and can report its className() and whether it inherits() another class in the QObject inheritance hierarchy. +.PP +When an object is deleted, it emits a destroyed() signal. You can catch this signal to avoid dangling references to QObjects. The QGuardedPtr class provides an elegant way to use this feature. +.PP +QObjects can receive events through event() and filter the events of other objects. See installEventFilter() and eventFilter() for details. A convenience handler, childEvent(), can be reimplemented to catch child events. +.PP +Last but not least, QObject provides the basic timer support in Qt; see QTimer for high-level support for timers. +.PP +Notice that the TQ_OBJECT macro is mandatory for any object that implements signals, slots or properties. You also need to run the moc program (Meta Object Compiler) on the source file. We strongly recommend the use of this macro in \fIall\fR subclasses of QObject regardless of whether or not they actually use signals, slots and properties, since failure to do so may lead certain functions to exhibit undefined behaviour. +.PP +All Qt widgets inherit QObject. The convenience function isWidgetType() returns whether an object is actually a widget. It is much faster than inherits( "QWidget" ). +.PP +Some QObject functions, e.g. children(), objectTrees() and queryList() return a QObjectList. A QObjectList is a QPtrList of QObjects. QObjectLists support the same operations as QPtrLists and have an iterator class, QObjectListIt. +.PP +See also Object Model. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QObject::QObject ( QObject * parent = 0, const char * name = 0 )" +Constructs an object called \fIname\fR with parent object, \fIparent\fR. +.PP +The parent of an object may be viewed as the object's owner. For instance, a dialog box is the parent of the" OK" and "Cancel" buttons it contains. +.PP +The destructor of a parent object destroys all child objects. +.PP +Setting \fIparent\fR to 0 constructs an object with no parent. If the object is a widget, it will become a top-level window. +.PP +The object name is some text that can be used to identify a QObject. It's particularly useful in conjunction with \fIQt Designer\fR. You can find an object by name (and type) using child(). To find several objects use queryList(). +.PP +See also parent(), name, child(), and queryList(). +.SH "QObject::~QObject ()\fC [virtual]\fR" +Destroys the object, deleting all its child objects. +.PP +All signals to and from the object are automatically disconnected. +.PP +\fBWarning:\fR All child objects are deleted. If any of these objects are on the stack or global, sooner or later your program will crash. We do not recommend holding pointers to child objects from outside the parent. If you still do, the QObject::destroyed() signal gives you an opportunity to detect when an object is destroyed. +.PP +\fBWarning:\fR Deleting a QObject while pending events are waiting to be delivered can cause a crash. You must not delete the QObject directly from a thread that is not the GUI thread. Use the QObject::deleteLater() method instead, which will cause the event loop to delete the object after all pending events have been delivered to the object. +.SH "void QObject::blockSignals ( bool block )" +Blocks signals if \fIblock\fR is TRUE, or unblocks signals if \fIblock\fR is FALSE. +.PP +Emitted signals disappear into hyperspace if signals are blocked. Note that the destroyed() signals will be emitted even if the signals for this object have been blocked. +.PP +Examples: +.)l rot13/rot13.cpp and simple/main.cpp. +.SH "bool QObject::checkConnectArgs ( const char * signal, const QObject * receiver, const char * member )\fC [virtual protected]\fR" +Returns TRUE if the \fIsignal\fR and the \fImember\fR arguments are compatible; otherwise returns FALSE. (The \fIreceiver\fR argument is currently ignored.) +.PP +\fBWarning:\fR We recommend that you use the default implementation and do not reimplement this function. +.SH "QObject * QObject::child ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = TRUE )" +Searches the children and optionally grandchildren of this object, and returns a child that is called \fIobjName\fR that inherits \fIinheritsClass\fR. If \fIinheritsClass\fR is 0 (the default), any class matches. +.PP +If \fIrecursiveSearch\fR is TRUE (the default), child() performs a depth-first search of the object's children. +.PP +If there is no such object, this function returns 0. If there are more than one, the first one found is retured; if you need all of them, use queryList(). +.SH "void QObject::childEvent ( QChildEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive child events. +.PP +Child events are sent to objects when children are inserted or removed. +.PP +Note that events with QEvent::type() QEvent::ChildInserted are posted (with QApplication::postEvent()) to make sure that the child's construction is completed before this function is called. +.PP +If a child is removed immediately after it is inserted, the \fCChildInserted\fR event may be suppressed, but the \fCChildRemoved\fR event will always be sent. In such cases it is possible that there will be a \fCChildRemoved\fR event without a corresponding \fCChildInserted\fR event. +.PP +If you change state based on \fCChildInserted\fR events, call QWidget::constPolish(), or do +.PP +.nf +.br + QApplication::sendPostedEvents( this, QEvent::ChildInserted ); +.br +.fi +in functions that depend on the state. One notable example is QWidget::sizeHint(). +.PP +See also event() and QChildEvent. +.PP +Reimplemented in QMainWindow and QSplitter. +.SH "const QObjectList * QObject::children () const" +Returns a list of child objects, or 0 if this object has no children. +.PP +The QObjectList class is defined in the ntqobjectlist.h header file. +.PP +The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end. +.PP +Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list. +.PP +See also child(), queryList(), parent(), insertChild(), and removeChild(). +.SH "const char * QObject::className () const\fC [virtual]\fR" +Returns the class name of this object. +.PP +This function is generated by the Meta Object Compiler. +.PP +\fBWarning:\fR This function will return the wrong name if the class definition lacks the TQ_OBJECT macro. +.PP +See also name, inherits(), isA(), and isWidgetType(). +.PP +Example: sql/overview/custom1/main.cpp. +.SH "bool QObject::connect ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )\fC [static]\fR" +Connects \fIsignal\fR from the \fIsender\fR object to \fImember\fR in object \fIreceiver\fR, and returns TRUE if the connection succeeds; otherwise returns FALSE. +.PP +You must use the SIGNAL() and SLOT() macros when specifying the \fIsignal\fR and the \fImember\fR, for example: +.PP +.nf +.br + QLabel *label = new QLabel; +.br + QScrollBar *scroll = new QScrollBar; +.br + QObject::connect( scroll, SIGNAL(valueChanged(int)), +.br + label, SLOT(setNum(int)) ); +.br +.fi +.PP +This example ensures that the label always displays the current scroll bar value. Note that the signal and slots parameters must not contain any variable names, only the type. E.g. the following would not work and return FALSE: QObject::connect( scroll, SIGNAL(valueChanged(int v)), label, SLOT(setNum(int v)) ); +.PP +A signal can also be connected to another signal: +.PP +.nf +.br + class MyWidget : public QWidget +.br + { +.br + TQ_OBJECT +.br + public: +.br + MyWidget(); +.br +.br + signals: +.br + void myUsefulSignal(); +.br +.br + private: +.br + QPushButton *aButton; +.br + }; +.br +.br + MyWidget::MyWidget() +.br + { +.br + aButton = new QPushButton( this ); +.br + connect( aButton, SIGNAL(clicked()), SIGNAL(myUsefulSignal()) ); +.br + } +.br +.fi +.PP +In this example, the MyWidget constructor relays a signal from a private member variable, and makes it available under a name that relates to MyWidget. +.PP +A signal can be connected to many slots and signals. Many signals can be connected to one slot. +.PP +If a signal is connected to several slots, the slots are activated in an arbitrary order when the signal is emitted. +.PP +The function returns TRUE if it successfully connects the signal to the slot. It will return FALSE if it cannot create the connection, for example, if QObject is unable to verify the existence of either \fIsignal\fR or \fImember\fR, or if their signatures aren't compatible. +.PP +A signal is emitted for \fIevery\fR connection you make, so if you duplicate a connection, two signals will be emitted. You can always break a connection using disconnect(). +.PP +See also disconnect(). +.PP +Examples: +.)l action/main.cpp, application/main.cpp, extension/main.cpp, iconview/main.cpp, network/archivesearch/main.cpp, regexptester/main.cpp, and t2/main.cpp. +.SH "bool QObject::connect ( const QObject * sender, const char * signal, const char * member ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Connects \fIsignal\fR from the \fIsender\fR object to this object's \fImember\fR. +.PP +Equivalent to: \fCQObject::connect(sender, signal, this, member)\fR. +.PP +See also disconnect(). +.SH "void QObject::connectNotify ( const char * signal )\fC [virtual protected]\fR" +This virtual function is called when something has been connected to \fIsignal\fR in this object. +.PP +\fBWarning:\fR This function violates the object-oriented principle of modularity. However, it might be useful when you need to perform expensive initialization only if something is connected to a signal. +.PP +See also connect() and disconnectNotify(). +.SH "void QObject::customEvent ( QCustomEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive custom events. Custom events are user-defined events with a type value at least as large as the "User" item of the QEvent::Type enum, and is typically a QCustomEvent or QCustomEvent subclass. +.PP +See also event() and QCustomEvent. +.SH "void QObject::deleteLater ()\fC [slot]\fR" +Performs a deferred deletion of this object. +.PP +Instead of an immediate deletion this function schedules a deferred delete event for processing when Qt returns to the main event loop. +.PP +Example: table/bigtable/main.cpp. +.SH "void QObject::destroyed ()\fC [signal]\fR" +This signal is emitted when the object is being destroyed. +.PP +Note that the signal is emitted by the QObject destructor, so the object's virtual table is already degenerated at this point, and it is not safe to call any functions on the object emitting the signal. This signal can not be blocked. +.PP +All the objects's children are destroyed immediately after this signal is emitted. +.SH "void QObject::destroyed ( QObject * obj )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted immediately before the object \fIobj\fR is destroyed, and can not be blocked. +.PP +All the objects's children are destroyed immediately after this signal is emitted. +.SH "bool QObject::disconnect ( const QObject * sender, const char * signal, const QObject * receiver, const char * member )\fC [static]\fR" +Disconnects \fIsignal\fR in object \fIsender\fR from \fImember\fR in object \fIreceiver\fR. +.PP +A signal-slot connection is removed when either of the objects involved are destroyed. +.PP +disconnect() is typically used in three ways, as the following examples demonstrate. <ol type=1> +.IP 1 +Disconnect everything connected to an object's signals: +.IP +.nf +.br + disconnect( myObject, 0, 0, 0 ); +.br +.fi +equivalent to the non-static overloaded function +.IP +.nf +.br + myObject->disconnect(); +.br +.fi +.IP 2 +Disconnect everything connected to a specific signal: +.IP +.nf +.br + disconnect( myObject, SIGNAL(mySignal()), 0, 0 ); +.br +.fi +equivalent to the non-static overloaded function +.IP +.nf +.br + myObject->disconnect( SIGNAL(mySignal()) ); +.br +.fi +.IP 3 +Disconnect a specific receiver: +.IP +.nf +.br + disconnect( myObject, 0, myReceiver, 0 ); +.br +.fi +equivalent to the non-static overloaded function +.IP +.nf +.br + myObject->disconnect( myReceiver ); +.br +.fi +.PP +0 may be used as a wildcard, meaning "any signal", "any receiving object", or "any slot in the receiving object", respectively. +.PP +The \fIsender\fR may never be 0. (You cannot disconnect signals from more than one object in a single call.) +.PP +If \fIsignal\fR is 0, it disconnects \fIreceiver\fR and \fImember\fR from any signal. If not, only the specified signal is disconnected. +.PP +If \fIreceiver\fR is 0, it disconnects anything connected to \fIsignal\fR. If not, slots in objects other than \fIreceiver\fR are not disconnected. +.PP +If \fImember\fR is 0, it disconnects anything that is connected to \fIreceiver\fR. If not, only slots named \fImember\fR will be disconnected, and all other slots are left alone. The \fImember\fR must be 0 if \fIreceiver\fR is left out, so you cannot disconnect a specifically-named slot on all objects. +.PP +See also connect(). +.SH "bool QObject::disconnect ( const char * signal = 0, const QObject * receiver = 0, const char * member = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Disconnects \fIsignal\fR from \fImember\fR of \fIreceiver\fR. +.PP +A signal-slot connection is removed when either of the objects involved are destroyed. +.SH "bool QObject::disconnect ( const QObject * receiver, const char * member = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Disconnects all signals in this object from \fIreceiver\fR's \fImember\fR. +.PP +A signal-slot connection is removed when either of the objects involved are destroyed. +.SH "void QObject::disconnectNotify ( const char * signal )\fC [virtual protected]\fR" +This virtual function is called when something has been disconnected from \fIsignal\fR in this object. +.PP +\fBWarning:\fR This function violates the object-oriented principle of modularity. However, it might be useful for optimizing access to expensive resources. +.PP +See also disconnect() and connectNotify(). +.SH "void QObject::dumpObjectInfo ()" +Dumps information about signal connections, etc. for this object to the debug output. +.PP +This function is useful for debugging, but does nothing if the library has been compiled in release mode (i.e. without debugging information). +.SH "void QObject::dumpObjectTree ()" +Dumps a tree of children to the debug output. +.PP +This function is useful for debugging, but does nothing if the library has been compiled in release mode (i.e. without debugging information). +.SH "bool QObject::event ( QEvent * e )\fC [virtual]\fR" +This virtual function receives events to an object and should return TRUE if the event \fIe\fR was recognized and processed. +.PP +The event() function can be reimplemented to customize the behavior of an object. +.PP +See also installEventFilter(), timerEvent(), QApplication::sendEvent(), QApplication::postEvent(), and QWidget::event(). +.PP +Reimplemented in QWidget. +.SH "bool QObject::eventFilter ( QObject * watched, QEvent * e )\fC [virtual]\fR" +Filters events if this object has been installed as an event filter for the \fIwatched\fR object. +.PP +In your reimplementation of this function, if you want to filter the event \fIe\fR, out, i.e. stop it being handled further, return TRUE; otherwise return FALSE. +.PP +Example: +.PP +.nf +.br + class MyMainWindow : public QMainWindow +.br + { +.br + public: +.br + MyMainWindow( QWidget *parent = 0, const char *name = 0 ); +.br +.br + protected: +.br + bool eventFilter( QObject *obj, QEvent *ev ); +.br +.br + private: +.br + QTextEdit *textEdit; +.br + }; +.br +.br + MyMainWindow::MyMainWindow( QWidget *parent, const char *name ) +.br + : QMainWindow( parent, name ) +.br + { +.br + textEdit = new QTextEdit( this ); +.br + setCentralWidget( textEdit ); +.br + textEdit->installEventFilter( this ); +.br + } +.br +.br + bool MyMainWindow::eventFilter( QObject *obj, QEvent *ev ) +.br + { +.br + if ( obj == textEdit ) { +.br + if ( e->type() == QEvent::KeyPress ) { +.br + QKeyEvent *k = (QKeyEvent*)ev; +.br + tqDebug( "Ate key press %d", k->key() ); +.br + return TRUE; +.br + } else { +.br + return FALSE; +.br + } +.br + } else { +.br + // pass the event on to the parent class +.br + return QMainWindow::eventFilter( obj, ev ); +.br + } +.br + } +.br +.fi +.PP +Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes. +.PP +\fBWarning:\fR If you delete the receiver object in this function, be sure to return TRUE. Otherwise, Qt will forward the event to the deleted object and the program might crash. +.PP +See also installEventFilter(). +.PP +Reimplemented in QAccel, QScrollView, and QSpinBox. +.SH "bool QObject::highPriority () const" +Returns TRUE if the object is a high-priority object, or FALSE if it is a standard-priority object. +.PP +High-priority objects are placed first in QObject's list of children on the assumption that they will be referenced very often. +.SH "bool QObject::inherits ( const char * clname ) const" +Returns TRUE if this object is an instance of a class that inherits \fIclname\fR, and \fIclname\fR inherits QObject; otherwise returns FALSE. +.PP +A class is considered to inherit itself. +.PP +Example: +.PP +.nf +.br + QTimer *t = new QTimer; // QTimer inherits QObject +.br + t->inherits( "QTimer" ); // returns TRUE +.br + t->inherits( "QObject" ); // returns TRUE +.br + t->inherits( "QButton" ); // returns FALSE +.br +.br + // QScrollBar inherits QWidget and QRangeControl +.br + QScrollBar *s = new QScrollBar( 0 ); +.br + s->inherits( "QWidget" ); // returns TRUE +.br + s->inherits( "QRangeControl" ); // returns FALSE +.br +.fi +.PP +(QRangeControl is not a QObject.) +.PP +See also isA() and metaObject(). +.PP +Examples: +.)l table/statistics/statistics.cpp, themes/metal.cpp, and themes/wood.cpp. +.SH "void QObject::insertChild ( QObject * obj )\fC [virtual]\fR" +Inserts an object \fIobj\fR into the list of child objects. +.PP +\fBWarning:\fR This function cannot be used to make one widget the child widget of another widget. Child widgets can only be created by setting the parent widget in the constructor or by calling QWidget::reparent(). +.PP +See also removeChild() and QWidget::reparent(). +.SH "void QObject::installEventFilter ( const QObject * filterObj )" +Installs an event filter \fIfilterObj\fR on this object. For example: +.PP +.nf +.br + monitoredObj->installEventFilter( filterObj ); +.br +.fi +.PP +An event filter is an object that receives all events that are sent to this object. The filter can either stop the event or forward it to this object. The event filter \fIfilterObj\fR receives events via its eventFilter() function. The eventFilter() function must return TRUE if the event should be filtered, (i.e. stopped); otherwise it must return FALSE. +.PP +If multiple event filters are installed on a single object, the filter that was installed last is activated first. +.PP +Here's a \fCKeyPressEater\fR class that eats the key presses of its monitored objects: +.PP +.nf +.br + class KeyPressEater : public QObject +.br + { +.br + ... +.br + protected: +.br + bool eventFilter( QObject *o, QEvent *e ); +.br + }; +.br +.br + bool KeyPressEater::eventFilter( QObject *o, QEvent *e ) +.br + { +.br + if ( e->type() == QEvent::KeyPress ) { +.br + // special processing for key press +.br + QKeyEvent *k = (QKeyEvent *)e; +.br + tqDebug( "Ate key press %d", k->key() ); +.br + return TRUE; // eat event +.br + } else { +.br + // standard event processing +.br + return FALSE; +.br + } +.br + } +.br +.fi +.PP +And here's how to install it on two widgets: +.PP +.nf +.br + KeyPressEater *keyPressEater = new KeyPressEater( this ); +.br + QPushButton *pushButton = new QPushButton( this ); +.br + QListView *listView = new QListView( this ); +.br +.br + pushButton->installEventFilter( keyPressEater ); +.br + listView->installEventFilter( keyPressEater ); +.br +.fi +.PP +The QAccel class, for example, uses this technique to intercept accelerator key presses. +.PP +\fBWarning:\fR If you delete the receiver object in your eventFilter() function, be sure to return TRUE. If you return FALSE, Qt sends the event to the deleted object and the program will crash. +.PP +See also removeEventFilter(), eventFilter(), and event(). +.SH "bool QObject::isA ( const char * clname ) const" +Returns TRUE if this object is an instance of the class \fIclname\fR; otherwise returns FALSE. +.PP +Example: +.PP +.nf +.br + QTimer *t = new QTimer; // QTimer inherits QObject +.br + t->isA( "QTimer" ); // returns TRUE +.br + t->isA( "QObject" ); // returns FALSE +.br +.fi +.PP +See also inherits() and metaObject(). +.SH "bool QObject::isWidgetType () const" +Returns TRUE if the object is a widget; otherwise returns FALSE. +.PP +Calling this function is equivalent to calling inherits("QWidget"), except that it is much faster. +.SH "void QObject::killTimer ( int id )" +Kills the timer with timer identifier, \fIid\fR. +.PP +The timer identifier is returned by startTimer() when a timer event is started. +.PP +See also timerEvent(), startTimer(), and killTimers(). +.SH "void QObject::killTimers ()" +Kills all timers that this object has started. +.PP +\fBWarning:\fR Using this function can cause hard-to-find bugs: it kills timers started by sub- and superclasses as well as those started by you, which is often not what you want. We recommend using a QTimer or perhaps killTimer(). +.PP +See also timerEvent(), startTimer(), and killTimer(). +.SH "QMetaObject * QObject::metaObject () const\fC [virtual]\fR" +Returns a pointer to the meta object of this object. +.PP +A meta object contains information about a class that inherits QObject, e.g. class name, superclass name, properties, signals and slots. Every class that contains the TQ_OBJECT macro will also have a meta object. +.PP +The meta object information is required by the signal/slot connection mechanism and the property system. The functions isA() and inherits() also make use of the meta object. +.SH "const char * QObject::name () const" +Returns the name of this object. See the "name" property for details. +.SH "const char * QObject::name ( const char * defaultName ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the name of this object, or \fIdefaultName\fR if the object does not have a name. +.SH "QCString QObject::normalizeSignalSlot ( const char * signalSlot )\fC [static protected]\fR" +Normlizes the signal or slot definition \fIsignalSlot\fR by removing unnecessary whitespace. +.SH "const QObjectList * QObject::objectTrees ()\fC [static]\fR" +Returns a pointer to the list of all object trees (their root objects), or 0 if there are no objects. +.PP +The QObjectList class is defined in the ntqobjectlist.h header file. +.PP +The most recent root object created is the first object in the list and the first root object added is the last object in the list. +.PP +See also children(), parent(), insertChild(), and removeChild(). +.SH "QObject * QObject::parent () const" +Returns a pointer to the parent object. +.PP +See also children(). +.SH "QVariant QObject::property ( const char * name ) const\fC [virtual]\fR" +Returns the value of the object's \fIname\fR property. +.PP +If no such property exists, the returned variant is invalid. +.PP +Information about all available properties are provided through the metaObject(). +.PP +See also setProperty(), QVariant::isValid(), metaObject(), QMetaObject::propertyNames(), and QMetaObject::property(). +.PP +Example: qutlook/centralwidget.cpp. +.SH "QObjectList * QObject::queryList ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = TRUE, bool recursiveSearch = TRUE ) const" +Searches the children and optionally grandchildren of this object, and returns a list of those objects that are named or that match \fIobjName\fR and inherit \fIinheritsClass\fR. If \fIinheritsClass\fR is 0 (the default), all classes match. If \fIobjName\fR is 0 (the default), all object names match. +.PP +If \fIregexpMatch\fR is TRUE (the default), \fIobjName\fR is a regular expression that the objects's names must match. The syntax is that of a QRegExp. If \fIregexpMatch\fR is FALSE, \fIobjName\fR is a string and object names must match it exactly. +.PP +Note that \fIinheritsClass\fR uses single inheritance from QObject, the way inherits() does. According to inherits(), QMenuBar inherits QWidget but not QMenuData. This does not quite match reality, but is the best that can be done on the wide variety of compilers Qt supports. +.PP +Finally, if \fIrecursiveSearch\fR is TRUE (the default), queryList() searches \fIn\fRth-generation as well as first-generation children. +.PP +If all this seems a bit complex for your needs, the simpler child() function may be what you want. +.PP +This somewhat contrived example disables all the buttons in this window: +.PP +.nf +.br + QObjectList *l = topLevelWidget()->queryList( "QButton" ); +.br + QObjectListIt it( *l ); // iterate over the buttons +.br + QObject *obj; +.br +.br + while ( (obj = it.current()) != 0 ) { +.br + // for each found object... +.br + ++it; +.br + ((QButton*)obj)->setEnabled( FALSE ); +.br + } +.br + delete l; // delete the list, not the objects +.br +.fi +.PP +The QObjectList class is defined in the ntqobjectlist.h header file. +.PP +\fBWarning:\fR Delete the list as soon you have finished using it. The list contains pointers that may become invalid at almost any time without notice (as soon as the user closes a window you may have dangling pointers, for example). +.PP +See also child(), children(), parent(), inherits(), name, and QRegExp. +.SH "void QObject::removeChild ( QObject * obj )\fC [virtual]\fR" +Removes the child object \fIobj\fR from the list of children. +.PP +\fBWarning:\fR This function will not remove a child widget from the screen. It will only remove it from the parent widget's list of children. +.PP +See also insertChild() and QWidget::reparent(). +.SH "void QObject::removeEventFilter ( const QObject * obj )" +Removes an event filter object \fIobj\fR from this object. The request is ignored if such an event filter has not been installed. +.PP +All event filters for this object are automatically removed when this object is destroyed. +.PP +It is always safe to remove an event filter, even during event filter activation (i.e. from the eventFilter() function). +.PP +See also installEventFilter(), eventFilter(), and event(). +.SH "const QObject * QObject::sender ()\fC [protected]\fR" +Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. The pointer is valid only during the execution of the slot that calls this function. +.PP +The pointer returned by this function becomes invalid if the sender is destroyed, or if the slot is disconnected from the sender's signal. +.PP +\fBWarning:\fR This function violates the object-oriented principle of modularity. However, getting access to the sender might be useful when many signals are connected to a single slot. The sender is undefined if the slot is called as a normal C++ function. +.SH "void QObject::setName ( const char * name )\fC [virtual]\fR" +Sets the object's name to \fIname\fR. +.SH "bool QObject::setProperty ( const char * name, const QVariant & value )\fC [virtual]\fR" +Sets the value of the object's \fIname\fR property to \fIvalue\fR. +.PP +Returns TRUE if the operation was successful; otherwise returns FALSE. +.PP +Information about all available properties is provided through the metaObject(). +.PP +See also property(), metaObject(), QMetaObject::propertyNames(), and QMetaObject::property(). +.PP +Example: qutlook/centralwidget.cpp. +.SH "bool QObject::signalsBlocked () const" +Returns TRUE if signals are blocked; otherwise returns FALSE. +.PP +Signals are not blocked by default. +.PP +See also blockSignals(). +.SH "int QObject::startTimer ( int interval )" +Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. +.PP +A timer event will occur every \fIinterval\fR milliseconds until killTimer() or killTimers() is called. If \fIinterval\fR is 0, then the timer event occurs once every time there are no more window system events to process. +.PP +The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events. +.PP +If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated. +.PP +Example: +.PP +.nf +.br + class MyObject : public QObject +.br + { +.br + TQ_OBJECT +.br + public: +.br + MyObject( QObject *parent = 0, const char *name = 0 ); +.br +.br + protected: +.br + void timerEvent( QTimerEvent * ); +.br + }; +.br +.br + MyObject::MyObject( QObject *parent, const char *name ) +.br + : QObject( parent, name ) +.br + { +.br + startTimer( 50 ); // 50-millisecond timer +.br + startTimer( 1000 ); // 1-second timer +.br + startTimer( 60000 ); // 1-minute timer +.br + } +.br +.br + void MyObject::timerEvent( QTimerEvent *e ) +.br + { +.br + tqDebug( "timer event, id %d", e->timerId() ); +.br + } +.br +.fi +.PP +Note that QTimer's accuracy depends on the underlying operating system and hardware. Most platforms support an accuracy of 20 ms; some provide more. If Qt is unable to deliver the requested number of timer clicks, it will silently discard some. +.PP +The QTimer class provides a high-level programming interface with one-shot timers and timer signals instead of events. +.PP +See also timerEvent(), killTimer(), killTimers(), QEventLoop::awake(), and QEventLoop::aboutToBlock(). +.SH "void QObject::timerEvent ( QTimerEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive timer events for the object. +.PP +QTimer provides a higher-level interface to the timer functionality, and also more general information about timers. +.PP +See also startTimer(), killTimer(), killTimers(), and event(). +.PP +Examples: +.)l biff/biff.cpp, dclock/dclock.cpp, forever/forever.cpp, grapher/grapher.cpp, qmag/qmag.cpp, and xform/xform.cpp. +.SH "QString QObject::tr ( const char * sourceText, const char * comment )\fC [static]\fR" +Returns a translated version of \fIsourceText\fR, or \fIsourceText\fR itself if there is no appropriate translated version. The translation context is QObject with \fIcomment\fR (0 by default). All QObject subclasses using the TQ_OBJECT macro automatically have a reimplementation of this function with the subclass name as context. +.PP +\fBWarning:\fR This method is reentrant only if all translators are installed \fIbefore\fR calling this method. Installing or removing translators while performing translations is not supported. Doing so will probably result in crashes or other undesirable behavior. +.PP +See also trUtf8(), QApplication::translate(), and Internationalization with Qt. +.PP +Example: network/networkprotocol/view.cpp. +.SH "QString QObject::trUtf8 ( const char * sourceText, const char * comment )\fC [static]\fR" +Returns a translated version of \fIsourceText\fR, or QString::fromUtf8(\fIsourceText\fR) if there is no appropriate version. It is otherwise identical to tr(\fIsourceText\fR, \fIcomment\fR). +.PP +\fBWarning:\fR This method is reentrant only if all translators are installed \fIbefore\fR calling this method. Installing or removing translators while performing translations is not supported. Doing so will probably result in crashes or other undesirable behavior. +.PP +See also tr() and QApplication::translate(). +.SS "Property Documentation" +.SH "QCString name" +This property holds the name of this object. +.PP +You can find an object by name (and type) using child(). You can find a set of objects with queryList(). +.PP +The object name is set by the constructor or by the setName() function. The object name is not very useful in the current version of Qt, but will become increasingly important in the future. +.PP +If the object does not have a name, the name() function returns" unnamed", so printf() (used in tqDebug()) will not be asked to output a null pointer. If you want a null pointer to be returned for unnamed objects, you can call name( 0 ). +.PP +.nf +.br + tqDebug( "MyClass::setPrecision(): (%s) invalid precision %f", +.br + name(), newPrecision ); +.br +.fi +.PP +See also className(), child(), and queryList(). +.PP +Set this property's value with setName() and get this property's value with name(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "void * tqt_find_obj_child ( QObject * parent, const char * type, const char * name )" +Returns a pointer to the object named \fIname\fR that inherits \fItype\fR and with a given \fIparent\fR. +.PP +Returns 0 if there is no such child. +.PP +.nf +.br + QListBox *c = (QListBox *) tqt_find_obj_child( myWidget, "QListBox", +.br + "my list box" ); +.br + if ( c ) +.br + c->insertItem( "another string" ); +.br +.fi + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqobject.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqobject.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqobjectcleanuphandler.3qt b/doc/man/man3/tqobjectcleanuphandler.3qt new file mode 100644 index 000000000..7282b8256 --- /dev/null +++ b/doc/man/man3/tqobjectcleanuphandler.3qt @@ -0,0 +1,152 @@ +'\" t +.TH QObjectCleanupHandler 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 +QObjectCleanupHandler \- Watches the lifetime of multiple QObjects +.SH SYNOPSIS +\fC#include <ntqobjectcleanuphandler.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQObjectCleanupHandler\fR ()" +.br +.ti -1c +.BI "\fB~QObjectCleanupHandler\fR ()" +.br +.ti -1c +.BI "QObject * \fBadd\fR ( QObject * object )" +.br +.ti -1c +.BI "void \fBremove\fR ( QObject * object )" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QObjectCleanupHandler class watches the lifetime of multiple QObjects. +.PP +A QObjectCleanupHandler is useful whenever you need to know when a number of QObjects that are owned by someone else have been deleted. This is important, for example, when referencing memory in an application that has been allocated in a shared library. +.PP +Example: +.PP +.nf +.br + class FactoryComponent : public FactoryInterface, public QLibraryInterface +.br + { +.br + public: +.br + ... +.br +.br + QObject *createObject(); +.br +.br + bool init(); +.br + void cleanup(); +.br + bool canUnload() const; +.br +.br + private: +.br + QObjectCleanupHandler objects; +.br + }; +.br +.br + // allocate a new object, and add it to the cleanup handler +.br + QObject *FactoryComponent::createObject() +.br + { +.br + return objects.add( new QObject() ); +.br + } +.br +.br + // QLibraryInterface implementation +.br + bool FactoryComponent::init() +.br + { +.br + return TRUE; +.br + } +.br +.br + void FactoryComponent::cleanup() +.br + { +.br + } +.br +.br + // it is only safe to unload the library when all QObject's have been destroyed +.br + bool FactoryComponent::canUnload() const +.br + { +.br + return objects.isEmpty(); +.br + } +.br +.fi +.PP +See also Object Model. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QObjectCleanupHandler::QObjectCleanupHandler ()" +Constructs an empty QObjectCleanupHandler. +.SH "QObjectCleanupHandler::~QObjectCleanupHandler ()" +Destroys the cleanup handler. All objects in this cleanup handler will be deleted. +.SH "QObject * QObjectCleanupHandler::add ( QObject * object )" +Adds \fIobject\fR to this cleanup handler and returns the pointer to the object. +.SH "void QObjectCleanupHandler::clear ()" +Deletes all objects in this cleanup handler. The cleanup handler becomes empty. +.SH "bool QObjectCleanupHandler::isEmpty () const" +Returns TRUE if this cleanup handler is empty or if all objects in this cleanup handler have been destroyed; otherwise return FALSE. +.SH "void QObjectCleanupHandler::remove ( QObject * object )" +Removes the \fIobject\fR from this cleanup handler. The object will +not be destroyed. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqobjectcleanuphandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqobjectcleanuphandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqobjectlist.3qt b/doc/man/man3/tqobjectlist.3qt new file mode 100644 index 000000000..9bcf83d12 --- /dev/null +++ b/doc/man/man3/tqobjectlist.3qt @@ -0,0 +1,81 @@ +'\" t +.TH QObjectList 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 +QObjectList \- QPtrList of QObjects +.SH SYNOPSIS +\fC#include <ntqobjectlist.h>\fR +.PP +Inherits QPtrList<QObject>. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQObjectList\fR ()" +.br +.ti -1c +.BI "\fBQObjectList\fR ( const QObjectList & list )" +.br +.ti -1c +.BI "\fB~QObjectList\fR ()" +.br +.ti -1c +.BI "QObjectList & \fBoperator=\fR ( const QObjectList & list )" +.br +.in -1c +.SH DESCRIPTION +The QObjectList class is a QPtrList of QObjects. +.PP +A QObjectList is a QPtrList<QObject>. The list can be traversed using inherited functions, e.g. getFirst(), next(), etc., or using a QObjectListIterator iterator. +.PP +See QObject::queryList() for an example of use. +.PP +See also QObjectListIterator, QObject, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QObjectList::QObjectList ()" +Constructs an empty QObject list. +.SH "QObjectList::QObjectList ( const QObjectList & list )" +Constructs a copy of \fIlist\fR. +.PP +Each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy). +.SH "QObjectList::~QObjectList ()" +Removes all the object pointers from the list and destroys the list. +.PP +All list iterators that access this list will be reset. +.PP +See also setAutoDelete(). +.SH "QObjectList & QObjectList::operator= ( const QObjectList & list )" +Assigns \fIlist\fR to this list and returns a reference to this list. +.PP +This list is first cleared and then each item in \fIlist\fR is appended to this list. Only the pointers are +copied (shallow copy) unless newItem() has been reimplemented(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqobjectlist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqobjectlist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqobjectlistiterator.3qt b/doc/man/man3/tqobjectlistiterator.3qt new file mode 100644 index 000000000..0f02fc6fc --- /dev/null +++ b/doc/man/man3/tqobjectlistiterator.3qt @@ -0,0 +1,63 @@ +'\" t +.TH QObjectListIterator 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 +QObjectListIterator \- Iterator for QObjectLists +.SH SYNOPSIS +\fC#include <ntqobjectlist.h>\fR +.PP +Inherits QPtrListIterator<QObject>. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQObjectListIterator\fR ( const QObjectList & list )" +.br +.ti -1c +.BI "QObjectListIterator & \fBoperator=\fR ( const QObjectListIterator & it )" +.br +.in -1c +.SH DESCRIPTION +The QObjectListIterator class provides an iterator for QObjectLists. +.PP +A QObjectListIterator iterator is a QPtrListIterator<QObject>. +.PP +See QObject::queryList() for an example of use. +.PP +See also QObjectList, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QObjectListIterator::QObjectListIterator ( const QObjectList & list )" +Constructs an iterator for \fIlist\fR. The current iterator item is set to point on the first item in the \fIlist\fR. +.SH "QObjectListIterator & QObjectListIterator::operator= ( const QObjectListIterator & it )" +Assignment. Makes a copy of the iterator \fIit\fR and returns a +reference to this iterator. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qobjectlistiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqobjectlistiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpaintdevice.3qt b/doc/man/man3/tqpaintdevice.3qt new file mode 100644 index 000000000..f4830a489 --- /dev/null +++ b/doc/man/man3/tqpaintdevice.3qt @@ -0,0 +1,384 @@ +'\" t +.TH QPaintDevice 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 +QPaintDevice \- The base class of objects that can be painted +.SH SYNOPSIS +\fC#include <ntqpaintdevice.h>\fR +.PP +Inherited by QWidget, QPixmap, QPicture, and QPrinter. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QPaintDevice\fR ()" +.br +.ti -1c +.BI "bool \fBisExtDev\fR () const" +.br +.ti -1c +.BI "bool \fBpaintingActive\fR () const" +.br +.ti -1c +.BI "virtual HDC \fBhandle\fR () const" +.br +.ti -1c +.BI "virtual Qt::HANDLE \fBhandle\fR () const" +.br +.ti -1c +.BI "Display * \fBx11Display\fR () const" +.br +.ti -1c +.BI "int \fBx11Screen\fR () const" +.br +.ti -1c +.BI "int \fBx11Depth\fR () const" +.br +.ti -1c +.BI "int \fBx11Cells\fR () const" +.br +.ti -1c +.BI "Qt::HANDLE \fBx11Colormap\fR () const" +.br +.ti -1c +.BI "bool \fBx11DefaultColormap\fR () const" +.br +.ti -1c +.BI "void * \fBx11Visual\fR () const" +.br +.ti -1c +.BI "bool \fBx11DefaultVisual\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "Display * \fBx11AppDisplay\fR ()" +.br +.ti -1c +.BI "int \fBx11AppScreen\fR ()" +.br +.ti -1c +.BI "int \fBx11AppDpiX\fR ()" +.br +.ti -1c +.BI "int \fBx11AppDpiY\fR ()" +.br +.ti -1c +.BI "void \fBx11SetAppDpiX\fR ( int dpi )" +.br +.ti -1c +.BI "void \fBx11SetAppDpiY\fR ( int dpi )" +.br +.ti -1c +.BI "int \fBx11AppDepth\fR ()" +.br +.ti -1c +.BI "int \fBx11AppCells\fR ()" +.br +.ti -1c +.BI "Qt::HANDLE \fBx11AppRootWindow\fR ()" +.br +.ti -1c +.BI "Qt::HANDLE \fBx11AppColormap\fR ()" +.br +.ti -1c +.BI "bool \fBx11AppDefaultColormap\fR ()" +.br +.ti -1c +.BI "void * \fBx11AppVisual\fR ()" +.br +.ti -1c +.BI "bool \fBx11AppDefaultVisual\fR ()" +.br +.ti -1c +.BI "int \fBx11AppDepth\fR ( int screen )" +.br +.ti -1c +.BI "int \fBx11AppCells\fR ( int screen )" +.br +.ti -1c +.BI "Qt::HANDLE \fBx11AppRootWindow\fR ( int screen )" +.br +.ti -1c +.BI "Qt::HANDLE \fBx11AppColormap\fR ( int screen )" +.br +.ti -1c +.BI "void * \fBx11AppVisual\fR ( int screen )" +.br +.ti -1c +.BI "bool \fBx11AppDefaultColormap\fR ( int screen )" +.br +.ti -1c +.BI "bool \fBx11AppDefaultVisual\fR ( int screen )" +.br +.ti -1c +.BI "int \fBx11AppDpiX\fR ( int screen )" +.br +.ti -1c +.BI "int \fBx11AppDpiY\fR ( int screen )" +.br +.ti -1c +.BI "void \fBx11SetAppDpiX\fR ( int dpi, int screen )" +.br +.ti -1c +.BI "void \fBx11SetAppDpiY\fR ( int dpi, int screen )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQPaintDevice\fR ( uint devflags )" +.br +.ti -1c +.BI "virtual bool \fBcmd\fR ( int, QPainter *, QPDevCmdParam * )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "void \fBbitBlt\fR ( QPaintDevice * dst, int dx, int dy, const QPaintDevice * src, int sx, int sy, int sw, int sh, Qt::RasterOp rop, bool ignoreMask )" +.br +.ti -1c +.BI "void \fBbitBlt\fR ( QPaintDevice * dst, const QPoint & dp, const QPaintDevice * src, const QRect & sr, RasterOp rop )" +.br +.in -1c +.SH DESCRIPTION +The QPaintDevice class is the base class of objects that can be painted. +.PP +A paint device is an abstraction of a two-dimensional space that can be drawn using a QPainter. The drawing capabilities are implemented by the subclasses QWidget, QPixmap, QPicture and QPrinter. +.PP +The default coordinate system of a paint device has its origin located at the top-left position. X increases to the right and Y increases downward. The unit is one pixel. There are several ways to set up a user-defined coordinate system using the painter, for example, using QPainter::setWorldMatrix(). +.PP +Example (draw on a paint device): +.PP +.nf +.br + void MyWidget::paintEvent( QPaintEvent * ) +.br + { +.br + QPainter p; // our painter +.br + p.begin( this ); // start painting the widget +.br + p.setPen( red ); // red outline +.br + p.setBrush( yellow ); // yellow fill +.br + p.drawEllipse( 10, 20, 100,100 ); // 100x100 ellipse at position (10, 20) +.br + p.end(); // painting done +.br + } +.br +.fi +.PP +The bit block transfer is an extremely useful operation for copying pixels from one paint device to another (or to itself). It is implemented as the global function bitBlt(). +.PP +Example (scroll widget contents 10 pixels to the right): +.PP +.nf +.br + bitBlt( myWidget, 10, 0, myWidget ); +.br +.fi +.PP +\fBWarning:\fR Qt requires that a QApplication object exists before any paint devices can be created. Paint devices access window system resources, and these resources are not initialized before an application object is created. +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPaintDevice::QPaintDevice ( uint devflags )\fC [protected]\fR" +Constructs a paint device with internal flags \fIdevflags\fR. This constructor can be invoked only from QPaintDevice subclasses. +.SH "QPaintDevice::~QPaintDevice ()\fC [virtual]\fR" +Destroys the paint device and frees window system resources. +.SH "bool QPaintDevice::cmd ( int, QPainter *, QPDevCmdParam * )\fC [virtual protected]\fR" +Internal virtual function that interprets drawing commands from the painter. +.PP +Implemented by subclasses that have no direct support for drawing graphics (external paint devices, for example, QPicture). +.SH "Qt::HANDLE QPaintDevice::handle () const\fC [virtual]\fR" +Returns the window system handle of the paint device, for low-level access. Using this function is not portable. +.PP +The HANDLE type varies with platform; see ntqpaintdevice.h and ntqwindowdefs.h for details. +.PP +See also x11Display(). +.SH "bool QPaintDevice::isExtDev () const" +Returns TRUE if the device is an external paint device; otherwise returns FALSE. +.PP +External paint devices cannot be bitBlt()'ed from. QPicture and QPrinter are external paint devices. +.SH "bool QPaintDevice::paintingActive () const" +Returns TRUE if the device is being painted, i.e. someone has called QPainter::begin() but not yet called QPainter::end() for this device; otherwise returns FALSE. +.PP +See also QPainter::isActive(). +.SH "int QPaintDevice::x11AppCells ()\fC [static]\fR" +Returns the number of entries in the colormap for the default screen of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also x11Colormap(). +.SH "int QPaintDevice::x11AppCells ( int screen )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the number of entries in the colormap for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also x11Colormap(). +.SH "Qt::HANDLE QPaintDevice::x11AppColormap ()\fC [static]\fR" +Returns the colormap for the default screen of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also x11Cells(). +.SH "Qt::HANDLE QPaintDevice::x11AppColormap ( int screen )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the colormap for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also x11Cells(). +.SH "bool QPaintDevice::x11AppDefaultColormap ()\fC [static]\fR" +Returns the default colormap for the default screen of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also x11Cells(). +.SH "bool QPaintDevice::x11AppDefaultColormap ( int screen )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the default colormap for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also x11Cells(). +.SH "bool QPaintDevice::x11AppDefaultVisual ()\fC [static]\fR" +Returns TRUE if the Visual used is the default for the default screen of the X display global to the application (X11 only); otherwise returns FALSE. Using this function is not portable. +.SH "bool QPaintDevice::x11AppDefaultVisual ( int screen )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the Visual used is the default for screen \fIscreen\fR of the X display global to the application (X11 only); otherwise returns FALSE. Using this function is not portable. +.SH "int QPaintDevice::x11AppDepth ( int screen )\fC [static]\fR" +Returns the depth for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also QPixmap::defaultDepth(). +.SH "int QPaintDevice::x11AppDepth ()\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the depth for the default screen of the X display global to the application (X11 only). Using this function is not portable. +.PP +See also QPixmap::defaultDepth(). +.SH "Display * QPaintDevice::x11AppDisplay ()\fC [static]\fR" +Returns a pointer to the X display global to the application (X11 only). Using this function is not portable. +.PP +See also handle(). +.SH "int QPaintDevice::x11AppDpiX ( int screen )\fC [static]\fR" +Returns the horizontal DPI of the X display (X11 only) for screen \fIscreen\fR. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. +.PP +See also x11AppDpiY(), x11SetAppDpiX(), and QPaintDeviceMetrics::logicalDpiX(). +.SH "int QPaintDevice::x11AppDpiX ()\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the horizontal DPI of the X display (X11 only) for the default screen. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. +.SH "int QPaintDevice::x11AppDpiY ( int screen )\fC [static]\fR" +Returns the vertical DPI of the X11 display (X11 only) for screen \fIscreen\fR. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. +.PP +See also x11AppDpiX(), x11SetAppDpiY(), and QPaintDeviceMetrics::logicalDpiY(). +.SH "int QPaintDevice::x11AppDpiY ()\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the vertical DPI of the X11 display (X11 only) for the default screen. Using this function is not portable. See QPaintDeviceMetrics for portable access to related information. Using this function is not portable. +.PP +See also x11AppDpiX(), x11SetAppDpiY(), and QPaintDeviceMetrics::logicalDpiY(). +.SH "Qt::HANDLE QPaintDevice::x11AppRootWindow ()\fC [static]\fR" +Returns the root window for the default screen of the X display global to the applicatoin (X11 only). Using this function is not portable. +.SH "Qt::HANDLE QPaintDevice::x11AppRootWindow ( int screen )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the root window for screen \fIscreen\fR of the X display global to the applicatoin (X11 only). Using this function is not portable. +.SH "int QPaintDevice::x11AppScreen ()\fC [static]\fR" +Returns the screen number on the X display global to the application (X11 only). Using this function is not portable. +.SH "void * QPaintDevice::x11AppVisual ()\fC [static]\fR" +Returns the Visual for the default screen of the X display global to the application (X11 only). Using this function is not portable. +.SH "void * QPaintDevice::x11AppVisual ( int screen )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the Visual for screen \fIscreen\fR of the X display global to the application (X11 only). Using this function is not portable. +.SH "int QPaintDevice::x11Cells () const" +Returns the number of entries in the colormap of the X display for the paint device (X11 only). Using this function is not portable. +.PP +See also x11Colormap(). +.SH "Qt::HANDLE QPaintDevice::x11Colormap () const" +Returns the colormap of the X display for the paint device (X11 only). Using this function is not portable. +.PP +See also x11Cells(). +.SH "bool QPaintDevice::x11DefaultColormap () const" +Returns the default colormap of the X display for the paint device (X11 only). Using this function is not portable. +.PP +See also x11Cells(). +.SH "bool QPaintDevice::x11DefaultVisual () const" +Returns the default Visual of the X display for the paint device (X11 only). Using this function is not portable. +.SH "int QPaintDevice::x11Depth () const" +Returns the depth of the X display for the paint device (X11 only). Using this function is not portable. +.PP +See also QPixmap::defaultDepth(). +.SH "Display * QPaintDevice::x11Display () const" +Returns a pointer to the X display for the paint device (X11 only). Using this function is not portable. +.PP +See also handle(). +.SH "int QPaintDevice::x11Screen () const" +Returns the screen number on the X display for the paint device (X11 only). Using this function is not portable. +.SH "void QPaintDevice::x11SetAppDpiX ( int dpi, int screen )\fC [static]\fR" +Sets the value returned by x11AppDpiX() to \fIdpi\fR for screen \fIscreen\fR. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. +.PP +See also x11SetAppDpiY(). +.SH "void QPaintDevice::x11SetAppDpiX ( int dpi )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the value returned by x11AppDpiX() to \fIdpi\fR for the default screen. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. +.SH "void QPaintDevice::x11SetAppDpiY ( int dpi, int screen )\fC [static]\fR" +Sets the value returned by x11AppDpiY() to \fIdpi\fR for screen \fIscreen\fR. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. +.PP +See also x11SetAppDpiX(). +.SH "void QPaintDevice::x11SetAppDpiY ( int dpi )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the value returned by x11AppDpiY() to \fIdpi\fR for the default screen. The default is determined by the display configuration. Changing this value will alter the scaling of fonts and many other metrics and is not recommended. Using this function is not portable. +.SH "void * QPaintDevice::x11Visual () const" +Returns the Visual of the X display for the paint device (X11 only). Using this function is not portable. +.SH RELATED FUNCTION DOCUMENTATION +.SH "void bitBlt ( QPaintDevice * dst, int dx, int dy, const QPaintDevice * src, int sx, int sy, int sw, int sh, Qt::RasterOp rop, bool ignoreMask )" +Copies a block of pixels from \fIsrc\fR to \fIdst\fR, perhaps merging each pixel according to the raster operation \fIrop\fR. \fIsx\fR, \fIsy\fR is the top-left pixel in \fIsrc\fR (0, 0) by default, \fIdx\fR, \fIdy\fR is the top-left position in \fIdst\fR and \fIsw\fR, \fIsh\fR is the size of the copied block (all of \fIsrc\fR by default). +.PP +The most common values for \fIrop\fR are CopyROP and XorROP; the Qt::RasterOp documentation defines all the possible values. +.PP +If \fIignoreMask\fR is FALSE (the default) and \fIsrc\fR is a masked QPixmap, the entire blit is masked by \fIsrc\fR->mask(). +.PP +If \fIsrc\fR, \fIdst\fR, \fIsw\fR or \fIsh\fR is 0, bitBlt() does nothing. If \fIsw\fR or \fIsh\fR is negative bitBlt() copies starting at \fIsx\fR (and respectively, \fIsy\fR) and ending at the right end (respectively, bottom) of \fIsrc\fR. +.PP +\fIsrc\fR must be a QWidget or QPixmap. You cannot blit from a QPrinter, for example. bitBlt() does nothing if you attempt to blit from an unsupported device. +.PP +bitBlt() does nothing if \fIsrc\fR has a greater depth than \fIdst\fR. If you need to for example, draw a 24-bit pixmap on an 8-bit widget, you must use drawPixmap(). +.SH "void bitBlt ( QPaintDevice * dst, const QPoint & dp, const QPaintDevice * src, const QRect & sr, RasterOp rop )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Overloaded bitBlt() with the destination point \fIdp\fR and source +rectangle \fIsr\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpaintdevice.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpaintdevice.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpaintdevicemetrics.3qt b/doc/man/man3/tqpaintdevicemetrics.3qt new file mode 100644 index 000000000..7dca8304a --- /dev/null +++ b/doc/man/man3/tqpaintdevicemetrics.3qt @@ -0,0 +1,116 @@ +'\" t +.TH QPaintDeviceMetrics 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 +QPaintDeviceMetrics \- Information about a paint device +.SH SYNOPSIS +\fC#include <ntqpaintdevicemetrics.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPaintDeviceMetrics\fR ( const QPaintDevice * pd )" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "int \fBwidthMM\fR () const" +.br +.ti -1c +.BI "int \fBheightMM\fR () const" +.br +.ti -1c +.BI "int \fBlogicalDpiX\fR () const" +.br +.ti -1c +.BI "int \fBlogicalDpiY\fR () const" +.br +.ti -1c +.BI "int \fBnumColors\fR () const" +.br +.ti -1c +.BI "int \fBdepth\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QPaintDeviceMetrics class provides information about a paint device. +.PP +Sometimes when drawing graphics it is necessary to obtain information about the physical characteristics of a paint device. This class provides the information. For example, to compute the aspect ratio of a paint device: +.PP +.nf +.br + QPaintDeviceMetrics pdm( myWidget ); +.br + double aspect = (double)pdm.widthMM() / (double)pdm.heightMM(); +.br +.fi +.PP +QPaintDeviceMetrics contains methods to provide the width and height of a device in both pixels (width() and height()) and millimeters (widthMM() and heightMM()), the number of colors the device supports (numColors()), the number of bit planes (depth()), and the resolution of the device (logicalDpiX() and logicalDpiY()). +.PP +It is not always possible for QPaintDeviceMetrics to compute the values you ask for, particularly for external devices. The ultimate example is asking for the resolution of of a QPrinter that is set to "print to file": who knows what printer that file will end up on? +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPaintDeviceMetrics::QPaintDeviceMetrics ( const QPaintDevice * pd )" +Constructs a metric for the paint device \fIpd\fR. +.SH "int QPaintDeviceMetrics::depth () const" +Returns the bit depth (number of bit planes) of the paint device. +.SH "int QPaintDeviceMetrics::height () const" +Returns the height of the paint device in default coordinate system units (e.g. pixels for QPixmap and QWidget). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. +.SH "int QPaintDeviceMetrics::heightMM () const" +Returns the height of the paint device, measured in millimeters. +.SH "int QPaintDeviceMetrics::logicalDpiX () const" +Returns the horizontal resolution of the device in dots per inch, which is used when computing font sizes. For X, this is usually the same as could be computed from widthMM(), but it varies on Windows. +.PP +Example: qwerty/qwerty.cpp. +.SH "int QPaintDeviceMetrics::logicalDpiY () const" +Returns the vertical resolution of the device in dots per inch, which is used when computing font sizes. For X, this is usually the same as could be computed from heightMM(), but it varies on Windows. +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "int QPaintDeviceMetrics::numColors () const" +Returns the number of different colors available for the paint device. Since this value is an int will not be sufficient to represent the number of colors on 32 bit displays, in which case INT_MAX is returned instead. +.SH "int QPaintDeviceMetrics::width () const" +Returns the width of the paint device in default coordinate system units (e.g. pixels for QPixmap and QWidget). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. +.SH "int QPaintDeviceMetrics::widthMM () const" +Returns the width of the paint device, measured in millimeters. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpaintdevicemetrics.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpaintdevicemetrics.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpainter.3qt b/doc/man/man3/tqpainter.3qt new file mode 100644 index 000000000..3309b9a92 --- /dev/null +++ b/doc/man/man3/tqpainter.3qt @@ -0,0 +1,1709 @@ +'\" t +.TH QPainter 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 +QPainter \- Does low-level painting e.g. on widgets +.SH SYNOPSIS +\fC#include <ntqpainter.h>\fR +.PP +Inherits Qt. +.PP +Inherited by QDirectPainter. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBCoordinateMode\fR { CoordDevice, CoordPainter }" +.br +.ti -1c +.BI "\fBQPainter\fR ()" +.br +.ti -1c +.BI "\fBQPainter\fR ( const QPaintDevice * pd, bool unclipped = FALSE )" +.br +.ti -1c +.BI "\fBQPainter\fR ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" +.br +.ti -1c +.BI "\fB~QPainter\fR ()" +.br +.ti -1c +.BI "bool \fBbegin\fR ( const QPaintDevice * pd, bool unclipped = FALSE )" +.br +.ti -1c +.BI "bool \fBbegin\fR ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" +.br +.ti -1c +.BI "bool \fBend\fR ()" +.br +.ti -1c +.BI "QPaintDevice * \fBdevice\fR () const" +.br +.ti -1c +.BI "bool \fBisActive\fR () const" +.br +.ti -1c +.BI "void \fBflush\fR ( const QRegion & region, CoordinateMode cm = CoordDevice )" +.br +.ti -1c +.BI "void \fBflush\fR ()" +.br +.ti -1c +.BI "void \fBsave\fR ()" +.br +.ti -1c +.BI "void \fBrestore\fR ()" +.br +.ti -1c +.BI "QFontMetrics \fBfontMetrics\fR () const" +.br +.ti -1c +.BI "QFontInfo \fBfontInfo\fR () const" +.br +.ti -1c +.BI "const QFont & \fBfont\fR () const" +.br +.ti -1c +.BI "void \fBsetFont\fR ( const QFont & font )" +.br +.ti -1c +.BI "const QPen & \fBpen\fR () const" +.br +.ti -1c +.BI "void \fBsetPen\fR ( const QPen & pen )" +.br +.ti -1c +.BI "void \fBsetPen\fR ( PenStyle style )" +.br +.ti -1c +.BI "void \fBsetPen\fR ( const QColor & color )" +.br +.ti -1c +.BI "const QBrush & \fBbrush\fR () const" +.br +.ti -1c +.BI "void \fBsetBrush\fR ( const QBrush & brush )" +.br +.ti -1c +.BI "void \fBsetBrush\fR ( BrushStyle style )" +.br +.ti -1c +.BI "void \fBsetBrush\fR ( const QColor & color )" +.br +.ti -1c +.BI "QPoint pos () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "const QColor & \fBbackgroundColor\fR () const" +.br +.ti -1c +.BI "void \fBsetBackgroundColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "BGMode \fBbackgroundMode\fR () const" +.br +.ti -1c +.BI "void \fBsetBackgroundMode\fR ( BGMode m )" +.br +.ti -1c +.BI "RasterOp \fBrasterOp\fR () const" +.br +.ti -1c +.BI "void \fBsetRasterOp\fR ( RasterOp r )" +.br +.ti -1c +.BI "const QPoint & \fBbrushOrigin\fR () const" +.br +.ti -1c +.BI "void \fBsetBrushOrigin\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBsetBrushOrigin\fR ( const QPoint & p )" +.br +.ti -1c +.BI "bool \fBhasViewXForm\fR () const" +.br +.ti -1c +.BI "bool \fBhasWorldXForm\fR () const" +.br +.ti -1c +.BI "void \fBsetViewXForm\fR ( bool enable )" +.br +.ti -1c +.BI "QRect \fBwindow\fR () const" +.br +.ti -1c +.BI "void \fBsetWindow\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBsetWindow\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "QRect \fBviewport\fR () const" +.br +.ti -1c +.BI "void \fBsetViewport\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBsetViewport\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBsetWorldXForm\fR ( bool enable )" +.br +.ti -1c +.BI "const QWMatrix & \fBworldMatrix\fR () const" +.br +.ti -1c +.BI "void \fBsetWorldMatrix\fR ( const QWMatrix & m, bool combine = FALSE )" +.br +.ti -1c +.BI "void saveWorldMatrix () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void restoreWorldMatrix () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBscale\fR ( double sx, double sy )" +.br +.ti -1c +.BI "void \fBshear\fR ( double sh, double sv )" +.br +.ti -1c +.BI "void \fBrotate\fR ( double a )" +.br +.ti -1c +.BI "void \fBtranslate\fR ( double dx, double dy )" +.br +.ti -1c +.BI "void \fBresetXForm\fR ()" +.br +.ti -1c +.BI "QPoint \fBxForm\fR ( const QPoint & pv ) const" +.br +.ti -1c +.BI "QRect \fBxForm\fR ( const QRect & rv ) const" +.br +.ti -1c +.BI "QPointArray \fBxForm\fR ( const QPointArray & av ) const" +.br +.ti -1c +.BI "QPointArray \fBxForm\fR ( const QPointArray & av, int index, int npoints ) const" +.br +.ti -1c +.BI "QPoint \fBxFormDev\fR ( const QPoint & pd ) const" +.br +.ti -1c +.BI "QRect \fBxFormDev\fR ( const QRect & rd ) const" +.br +.ti -1c +.BI "QPointArray \fBxFormDev\fR ( const QPointArray & ad ) const" +.br +.ti -1c +.BI "QPointArray \fBxFormDev\fR ( const QPointArray & ad, int index, int npoints ) const" +.br +.ti -1c +.BI "void \fBsetClipping\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBhasClipping\fR () const" +.br +.ti -1c +.BI "QRegion \fBclipRegion\fR ( CoordinateMode m = CoordDevice ) const" +.br +.ti -1c +.BI "void \fBsetClipRect\fR ( const QRect & r, CoordinateMode m = CoordDevice )" +.br +.ti -1c +.BI "void \fBsetClipRect\fR ( int x, int y, int w, int h, CoordinateMode m = CoordDevice )" +.br +.ti -1c +.BI "void \fBsetClipRegion\fR ( const QRegion & rgn, CoordinateMode m = CoordDevice )" +.br +.ti -1c +.BI "void \fBdrawPoint\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBdrawPoint\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBdrawPoints\fR ( const QPointArray & a, int index = 0, int npoints = -1 )" +.br +.ti -1c +.BI "void moveTo ( int x, int y ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void moveTo ( const QPoint & p ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void lineTo ( int x, int y ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void lineTo ( const QPoint & p ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBdrawLine\fR ( int x1, int y1, int x2, int y2 )" +.br +.ti -1c +.BI "void \fBdrawLine\fR ( const QPoint & p1, const QPoint & p2 )" +.br +.ti -1c +.BI "void \fBdrawRect\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBdrawRect\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBdrawWinFocusRect\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBdrawWinFocusRect\fR ( int x, int y, int w, int h, const QColor & bgColor )" +.br +.ti -1c +.BI "void \fBdrawWinFocusRect\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBdrawWinFocusRect\fR ( const QRect & r, const QColor & bgColor )" +.br +.ti -1c +.BI "void \fBdrawRoundRect\fR ( int x, int y, int w, int h, int xRnd = 25, int yRnd = 25 )" +.br +.ti -1c +.BI "void \fBdrawRoundRect\fR ( const QRect & r, int xRnd = 25, int yRnd = 25 )" +.br +.ti -1c +.BI "void \fBdrawEllipse\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBdrawEllipse\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBdrawArc\fR ( int x, int y, int w, int h, int a, int alen )" +.br +.ti -1c +.BI "void \fBdrawArc\fR ( const QRect & r, int a, int alen )" +.br +.ti -1c +.BI "void \fBdrawPie\fR ( int x, int y, int w, int h, int a, int alen )" +.br +.ti -1c +.BI "void \fBdrawPie\fR ( const QRect & r, int a, int alen )" +.br +.ti -1c +.BI "void \fBdrawChord\fR ( int x, int y, int w, int h, int a, int alen )" +.br +.ti -1c +.BI "void \fBdrawChord\fR ( const QRect & r, int a, int alen )" +.br +.ti -1c +.BI "void \fBdrawLineSegments\fR ( const QPointArray & a, int index = 0, int nlines = -1 )" +.br +.ti -1c +.BI "void \fBdrawPolyline\fR ( const QPointArray & a, int index = 0, int npoints = -1 )" +.br +.ti -1c +.BI "void \fBdrawPolygon\fR ( const QPointArray & a, bool winding = FALSE, int index = 0, int npoints = -1 )" +.br +.ti -1c +.BI "void \fBdrawConvexPolygon\fR ( const QPointArray & pa, int index = 0, int npoints = -1 )" +.br +.ti -1c +.BI "void \fBdrawCubicBezier\fR ( const QPointArray & a, int index = 0 )" +.br +.ti -1c +.BI "void \fBdrawPixmap\fR ( int x, int y, const QPixmap & pixmap, int sx = 0, int sy = 0, int sw = -1, int sh = -1 )" +.br +.ti -1c +.BI "void \fBdrawPixmap\fR ( const QPoint & p, const QPixmap & pm, const QRect & sr )" +.br +.ti -1c +.BI "void \fBdrawPixmap\fR ( const QPoint & p, const QPixmap & pm )" +.br +.ti -1c +.BI "void \fBdrawPixmap\fR ( const QRect & r, const QPixmap & pm )" +.br +.ti -1c +.BI "void \fBdrawImage\fR ( int x, int y, const QImage & image, int sx = 0, int sy = 0, int sw = -1, int sh = -1, int conversionFlags = 0 )" +.br +.ti -1c +.BI "void \fBdrawImage\fR ( const QPoint &, const QImage &, const QRect & sr, int conversionFlags = 0 )" +.br +.ti -1c +.BI "void \fBdrawImage\fR ( const QPoint & p, const QImage & i, int conversion_flags = 0 )" +.br +.ti -1c +.BI "void \fBdrawImage\fR ( const QRect & r, const QImage & i )" +.br +.ti -1c +.BI "void \fBdrawTiledPixmap\fR ( int x, int y, int w, int h, const QPixmap & pixmap, int sx = 0, int sy = 0 )" +.br +.ti -1c +.BI "void \fBdrawTiledPixmap\fR ( const QRect & r, const QPixmap & pm, const QPoint & sp )" +.br +.ti -1c +.BI "void \fBdrawTiledPixmap\fR ( const QRect & r, const QPixmap & pm )" +.br +.ti -1c +.BI "void drawPicture ( const QPicture & pic ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBdrawPicture\fR ( int x, int y, const QPicture & pic )" +.br +.ti -1c +.BI "void \fBdrawPicture\fR ( const QPoint & p, const QPicture & pic )" +.br +.ti -1c +.BI "void \fBfillRect\fR ( int x, int y, int w, int h, const QBrush & brush )" +.br +.ti -1c +.BI "void \fBfillRect\fR ( const QRect & r, const QBrush & brush )" +.br +.ti -1c +.BI "void \fBeraseRect\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBeraseRect\fR ( const QRect & r )" +.br +.ti -1c +.BI "enum \fBTextDirection\fR { Auto, RTL, LTR }" +.br +.ti -1c +.BI "void \fBdrawText\fR ( int x, int y, const QString &, int len = -1, TextDirection dir = Auto )" +.br +.ti -1c +.BI "void \fBdrawText\fR ( const QPoint &, const QString &, int len = -1, TextDirection dir = Auto )" +.br +.ti -1c +.BI "void \fBdrawText\fR ( int x, int y, const QString &, int pos, int len, TextDirection dir = Auto )" +.br +.ti -1c +.BI "void \fBdrawText\fR ( const QPoint & p, const QString &, int pos, int len, TextDirection dir = Auto )" +.br +.ti -1c +.BI "void \fBdrawText\fR ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QRect * br = 0, QTextParag ** internal = 0 )" +.br +.ti -1c +.BI "void \fBdrawText\fR ( const QRect & r, int tf, const QString & str, int len = -1, QRect * brect = 0, QTextParag ** internal = 0 )" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QTextParag ** intern = 0 )" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR ( const QRect & r, int flags, const QString & str, int len = -1, QTextParag ** internal = 0 )" +.br +.ti -1c +.BI "int \fBtabStops\fR () const" +.br +.ti -1c +.BI "void \fBsetTabStops\fR ( int ts )" +.br +.ti -1c +.BI "int * \fBtabArray\fR () const" +.br +.ti -1c +.BI "void \fBsetTabArray\fR ( int * ta )" +.br +.ti -1c +.BI "HDC \fBhandle\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBredirect\fR ( QPaintDevice * pdev, QPaintDevice * replacement )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "void \fBqDrawShadeLine\fR ( QPainter * p, int x1, int y1, int x2, int y2, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth )" +.br +.ti -1c +.BI "void \fBqDrawShadeRect\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth, const QBrush * fill )" +.br +.ti -1c +.BI "void \fBqDrawShadePanel\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, const QBrush * fill )" +.br +.ti -1c +.BI "void \fBqDrawWinButton\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" +.br +.ti -1c +.BI "void \fBqDrawWinPanel\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" +.br +.ti -1c +.BI "void \fBqDrawPlainRect\fR ( QPainter * p, int x, int y, int w, int h, const QColor & c, int lineWidth, const QBrush * fill )" +.br +.in -1c +.SH DESCRIPTION +The QPainter class does low-level painting e.g. on widgets. +.PP +The painter provides highly optimized functions to do most of the drawing GUI programs require. QPainter can draw everything from simple lines to complex shapes like pies and chords. It can also draw aligned text and pixmaps. Normally, it draws in a "natural" coordinate system, but it can also do view and world transformation. +.PP +The typical use of a painter is: +.TP +Construct a painter. +.TP +Set a pen, a brush etc. +.TP +Draw. +.TP +Destroy the painter. +.PP +Mostly, all this is done inside a paint event. (In fact, 99% of all QPainter use is in a reimplementation of QWidget::paintEvent(), and the painter is heavily optimized for such use.) Here's one very simple example: +.PP +.nf +.br + void SimpleExampleWidget::paintEvent() +.br + { +.br + QPainter paint( this ); +.br + paint.setPen( Qt::blue ); +.br + paint.drawText( rect(), AlignCenter, "The Text" ); +.br + } +.br +.fi +.PP +Usage is simple, and there are many settings you can use: +.IP +.TP +font() is the currently set font. If you set a font that isn't available, Qt finds a close match. In fact font() returns what you set using setFont() and fontInfo() returns the font actually being used (which may be the same). +.IP +.TP +brush() is the currently set brush; the color or pattern that's used for filling e.g. circles. +.IP +.TP +pen() is the currently set pen; the color or stipple that's used for drawing lines or boundaries. +.IP +.TP +backgroundMode() is \fCOpaque\fR or \fCTransparent\fR, i.e. whether backgroundColor() is used or not. +.IP +.TP +backgroundColor() only applies when backgroundMode() is Opaque and pen() is a stipple. In that case, it describes the color of the background pixels in the stipple. +.IP +.TP +rasterOp() is how pixels drawn interact with the pixels already there. +.IP +.TP +brushOrigin() is the origin of the tiled brushes, normally the origin of the window. +.IP +.TP +viewport(), window(), worldMatrix() and many more make up the painter's coordinate transformation system. See The Coordinate System for an explanation of this, or see below for a very brief overview of the functions. +.IP +.TP +hasClipping() is whether the painter clips at all. (The paint device clips, too.) If the painter clips, it clips to clipRegion(). +.IP +.TP +pos() is the current position, set by moveTo() and used by lineTo(). +.IP +.PP +Note that some of these settings mirror settings in some paint devices, e.g. QWidget::font(). QPainter::begin() (or the QPainter constructor) copies these attributes from the paint device. Calling, for example, QWidget::setFont() doesn't take effect until the next time a painter begins painting on it. +.PP +save() saves all of these settings on an internal stack, restore() pops them back. +.PP +The core functionality of QPainter is drawing, and there are functions to draw most primitives: drawPoint(), drawPoints(), drawLine(), drawRect(), drawWinFocusRect(), drawRoundRect(), drawEllipse(), drawArc(), drawPie(), drawChord(), drawLineSegments(), drawPolyline(), drawPolygon(), drawConvexPolygon() and drawCubicBezier(). All of these functions take integer coordinates; there are no floating-point versions since we want drawing to be as fast as possible. +.PP +There are functions to draw pixmaps/images, namely drawPixmap(), drawImage() and drawTiledPixmap(). drawPixmap() and drawImage() produce the same result, except that drawPixmap() is faster on-screen and drawImage() faster and sometimes better on QPrinter and QPicture. +.PP +Text drawing is done using drawText(), and when you need fine-grained positioning, boundingRect() tells you where a given drawText() command would draw. +.PP +There is a drawPicture() function that draws the contents of an entire QPicture using this painter. drawPicture() is the only function that disregards all the painter's settings: the QPicture has its own settings. +.PP +Normally, the QPainter operates on the device's own coordinate system (usually pixels), but QPainter has good support for coordinate transformation. See The Coordinate System for a more general overview and a simple example. +.PP +The most common functions used are scale(), rotate(), translate() and shear(), all of which operate on the worldMatrix(). setWorldMatrix() can replace or add to the currently set worldMatrix(). +.PP +setViewport() sets the rectangle on which QPainter operates. The default is the entire device, which is usually fine, except on printers. setWindow() sets the coordinate system, that is, the rectangle that maps to viewport(). What's drawn inside the window() ends up being inside the viewport(). The window's default is the same as the viewport, and if you don't use the transformations, they are optimized away, gaining another little bit of speed. +.PP +After all the coordinate transformation is done, QPainter can clip the drawing to an arbitrary rectangle or region. hasClipping() is TRUE if QPainter clips, and clipRegion() returns the clip region. You can set it using either setClipRegion() or setClipRect(). Note that the clipping can be slow. It's all system-dependent, but as a rule of thumb, you can assume that drawing speed is inversely proportional to the number of rectangles in the clip region. +.PP +After QPainter's clipping, the paint device may also clip. For example, most widgets clip away the pixels used by child widgets, and most printers clip away an area near the edges of the paper. This additional clipping is not reflected by the return value of clipRegion() or hasClipping(). +.PP +QPainter also includes some less-used functions that are very useful on those occasions when they're needed. +.PP +isActive() indicates whether the painter is active. begin() (and the most usual constructor) makes it active. end() (and the destructor) deactivates it. If the painter is active, device() returns the paint device on which the painter paints. +.PP +Sometimes it is desirable to make someone else paint on an unusual QPaintDevice. QPainter supports a static function to do this, redirect(). We recommend not using it, but for some hacks it's perfect. +.PP +setTabStops() and setTabArray() can change where the tab stops are, but these are very seldomly used. +.PP +\fBWarning:\fR Note that QPainter does not attempt to work around coordinate limitations in the underlying window system. Some platforms may behave incorrectly with coordinates as small as +/-4000. +.PP +See also QPaintDevice, QWidget, QPixmap, QPrinter, QPicture, Application Walkthrough, Coordinate System Overview, Graphics Classes, and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QPainter::CoordinateMode" +.TP +\fCQPainter::CoordDevice\fR +.TP +\fCQPainter::CoordPainter\fR +.PP +See also clipRegion(). +.SH "QPainter::TextDirection" +.TP +\fCQPainter::Auto\fR +.TP +\fCQPainter::RTL\fR - right to left +.TP +\fCQPainter::LTR\fR - left to right +.PP +See also drawText(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPainter::QPainter ()" +Constructs a painter. +.PP +Notice that all painter settings (setPen, setBrush etc.) are reset to default values when begin() is called. +.PP +See also begin() and end(). +.SH "QPainter::QPainter ( const QPaintDevice * pd, bool unclipped = FALSE )" +Constructs a painter that begins painting the paint device \fIpd\fR immediately. Depending on the underlying graphic system the painter will paint over children of the paintdevice if \fIunclipped\fR is TRUE. +.PP +This constructor is convenient for short-lived painters, e.g. in a paint event and should be used only once. The constructor calls begin() for you and the QPainter destructor automatically calls end(). +.PP +Here's an example using begin() and end(): +.PP +.nf +.br + void MyWidget::paintEvent( QPaintEvent * ) +.br + { +.br + QPainter p; +.br + p.begin( this ); +.br + p.drawLine( ... ); // drawing code +.br + p.end(); +.br + } +.br +.fi +.PP +The same example using this constructor: +.PP +.nf +.br + void MyWidget::paintEvent( QPaintEvent * ) +.br + { +.br + QPainter p( this ); +.br + p.drawLine( ... ); // drawing code +.br + } +.br +.fi +.PP +Since the constructor cannot provide feedback when the initialization of the painter failed you should rather use begin() and end() to paint on external devices, e.g. printers. +.PP +See also begin() and end(). +.SH "QPainter::QPainter ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" +Constructs a painter that begins painting the paint device \fIpd\fR immediately, with the default arguments taken from \fIcopyAttributes\fR. The painter will paint over children of the paint device if \fIunclipped\fR is TRUE (although this is not supported on all platforms). +.PP +See also begin(). +.SH "QPainter::~QPainter ()" +Destroys the painter. +.SH "const QColor & QPainter::backgroundColor () const" +Returns the current background color. +.PP +See also setBackgroundColor() and QColor. +.SH "BGMode QPainter::backgroundMode () const" +Returns the current background mode. +.PP +See also setBackgroundMode() and BGMode. +.SH "bool QPainter::begin ( const QPaintDevice * pd, bool unclipped = FALSE )" +Begins painting the paint device \fIpd\fR and returns TRUE if successful; otherwise returns FALSE. If \fIunclipped\fR is TRUE, the painting will not be clipped at the paint device's boundaries, (although this is not supported by all platforms). +.PP +The errors that can occur are serious problems, such as these: +.PP +.nf +.br + p->begin( 0 ); // impossible - paint device cannot be 0 +.br +.br + QPixmap pm( 0, 0 ); +.br + p->begin( pm ); // impossible - pm.isNull(); +.br +.br + p->begin( myWidget ); +.br + p2->begin( myWidget ); // impossible - only one painter at a time +.br +.fi +.PP +Note that most of the time, you can use one of the constructors instead of begin(), and that end() is automatically done at destruction. +.PP +\fBWarning:\fR A paint device can only be painted by one painter at a time. +.PP +See also end() and flush(). +.PP +Examples: +.)l aclock/aclock.cpp, desktop/desktop.cpp, drawdemo/drawdemo.cpp, hello/hello.cpp, picture/picture.cpp, t10/cannon.cpp, and xform/xform.cpp. +.SH "bool QPainter::begin ( const QPaintDevice * pd, const QWidget * copyAttributes, bool unclipped = FALSE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version opens the painter on a paint device \fIpd\fR and sets the initial pen, background color and font from \fIcopyAttributes\fR, painting over the paint device's children when \fIunclipped\fR is TRUE. This is equivalent to: +.PP +.nf +.br + QPainter p; +.br + p.begin( pd ); +.br + p.setPen( copyAttributes->foregroundColor() ); +.br + p.setBackgroundColor( copyAttributes->backgroundColor() ); +.br + p.setFont( copyAttributes->font() ); +.br +.fi +.PP +This begin function is convenient for double buffering. When you draw in a pixmap instead of directly in a widget (to later bitBlt the pixmap into the widget) you will need to set the widget's font etc. This function does exactly that. +.PP +Example: +.PP +.nf +.br + void MyWidget::paintEvent( QPaintEvent * ) +.br + { +.br + QPixmap pm(size()); +.br + QPainter p; +.br + p.begin(&pm, this); +.br + // ... potentially flickering paint operation ... +.br + p.end(); +.br + bitBlt(this, 0, 0, &pm); +.br + } +.br +.fi +.PP +See also end(). +.SH "QRect QPainter::boundingRect ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QTextParag ** intern = 0 )" +Returns the bounding rectangle of the aligned text that would be printed with the corresponding drawText() function using the first \fIlen\fR characters of the string if \fIlen\fR is > -1, or the whole of the string if \fIlen\fR is -1. The drawing, and hence the bounding rectangle, is constrained to the rectangle that begins at point \fI(x, y)\fR with width \fIw\fR and hight \fIh\fR, or to the rectangle required to draw the text, whichever is the larger. +.PP +The \fIflags\fR argument is the bitwise OR of the following flags: <center>.nf +.TS +l - l. Flag Meaning AlignAuto aligns according to the language, usually left. AlignLeft aligns to the left border. AlignRight aligns to the right border. AlignHCenter aligns horizontally centered. AlignTop aligns to the top border. AlignBottom aligns to the bottom border. AlignVCenter aligns vertically centered. AlignCenter (== AlignHCenter | AlignVCenter). SingleLine ignores newline characters in the text. ExpandTabs expands tabs. ShowPrefix interprets "&x" as " WordBreak +.TE +.fi +</center> +.PP +Horizontal alignment defaults to AlignLeft and vertical alignment defaults to AlignTop. +.PP +If several of the horizontal or several of the vertical alignment flags are set, the resulting alignment is undefined. +.PP +The \fIintern\fR parameter should not be used. +.PP +See also Qt::TextFlags. +.SH "QRect QPainter::boundingRect ( const QRect & r, int flags, const QString & str, int len = -1, QTextParag ** internal = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the bounding rectangle of the aligned text that would be printed with the corresponding drawText() function using the first \fIlen\fR characters from \fIstr\fR if \fIlen\fR is > -1, or the whole of \fIstr\fR if \fIlen\fR is -1. The drawing, and hence the bounding rectangle, is constrained to the rectangle \fIr\fR, or to the rectangle required to draw the text, whichever is the larger. +.PP +The \fIinternal\fR parameter should not be used. +.PP +See also drawText(), fontMetrics(), QFontMetrics::boundingRect(), and Qt::TextFlags. +.SH "const QBrush & QPainter::brush () const" +Returns the painter's current brush. +.PP +See also QPainter::setBrush(). +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QPoint & QPainter::brushOrigin () const" +Returns the brush origin currently set. +.PP +See also setBrushOrigin(). +.SH "QRegion QPainter::clipRegion ( CoordinateMode m = CoordDevice ) const" +Returns the currently set clip region. Note that the clip region is given in physical device coordinates and \fInot\fR subject to any coordinate transformation if \fIm\fR is equal to CoordDevice (the default). If \fIm\fR equals CoordPainter the returned region is in model coordinates. +.PP +See also setClipRegion(), setClipRect(), setClipping(), and QPainter::CoordinateMode. +.PP +Example: themes/wood.cpp. +.SH "QPaintDevice * QPainter::device () const" +Returns the paint device on which this painter is currently painting, or 0 if the painter is not active. +.PP +See also QPaintDevice::paintingActive(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, listboxcombo/listboxcombo.cpp, and mdi/application.cpp. +.SH "void QPainter::drawArc ( int x, int y, int w, int h, int a, int alen )" +Draws an arc defined by the rectangle \fI(x, y, w, h)\fR, the start angle \fIa\fR and the arc length \fIalen\fR. +.PP +The angles \fIa\fR and \fIalen\fR are 1/16th of a degree, i.e. a full circle equals 5760 (16*360). Positive values of \fIa\fR and \fIalen\fR mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. +.PP +Example: +.PP +.nf +.br + QPainter p( myWidget ); +.br + p.drawArc( 10,10, 70,100, 100*16, 160*16 ); // draws a "(" arc +.br +.fi +.PP +See also drawPie() and drawChord(). +.SH "void QPainter::drawArc ( const QRect & r, int a, int alen )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the arc that fits inside the rectangle \fIr\fR with start angle \fIa\fR and arc length \fIalen\fR. +.SH "void QPainter::drawChord ( int x, int y, int w, int h, int a, int alen )" +Draws a chord defined by the rectangle \fI(x, y, w, h)\fR, the start angle \fIa\fR and the arc length \fIalen\fR. +.PP +The chord is filled with the current brush(). +.PP +The angles \fIa\fR and \fIalen\fR are 1/16th of a degree, i.e. a full circle equals 5760 (16*360). Positive values of \fIa\fR and \fIalen\fR mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. +.PP +See also drawArc() and drawPie(). +.SH "void QPainter::drawChord ( const QRect & r, int a, int alen )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a chord that fits inside the rectangle \fIr\fR with start angle \fIa\fR and arc length \fIalen\fR. +.SH "void QPainter::drawConvexPolygon ( const QPointArray & pa, int index = 0, int npoints = -1 )" +Draws the convex polygon defined by the \fInpoints\fR points in \fIpa\fR starting at \fIpa[index]\fR (\fIindex\fR defaults to 0). +.PP +If the supplied polygon is not convex, the results are undefined. +.PP +On some platforms (e.g. X Window), this is faster than drawPolygon(). +.PP +\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. +.PP +Example: aclock/aclock.cpp. +.SH "void QPainter::drawCubicBezier ( const QPointArray & a, int index = 0 )" +Draws a cubic Bezier curve defined by the control points in \fIa\fR, starting at \fIa[index]\fR (\fIindex\fR defaults to 0). +.PP +Control points after \fIa[index + 3]\fR are ignored. Nothing happens if there aren't enough control points. +.PP +\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. +.SH "void QPainter::drawEllipse ( int x, int y, int w, int h )" +Draws an ellipse with center at \fI(x + w/2, y + h/2)\fR and size \fI(w, h)\fR. +.PP +Examples: +.)l drawdemo/drawdemo.cpp, multiple/ax2.h, picture/picture.cpp, and tictac/tictac.cpp. +.SH "void QPainter::drawEllipse ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the ellipse that fits inside rectangle \fIr\fR. +.SH "void QPainter::drawImage ( int x, int y, const QImage & image, int sx = 0, int sy = 0, int sw = -1, int sh = -1, int conversionFlags = 0 )" +Draws at (\fIx\fR, \fIy\fR) the \fIsw\fR by \fIsh\fR area of pixels from (\fIsx\fR, \fIsy\fR) in \fIimage\fR, using \fIconversionFlags\fR if the image needs to be converted to a pixmap. The default value for \fIconversionFlags\fR is 0; see convertFromImage() for information about what other values do. +.PP +This function may convert \fIimage\fR to a pixmap and then draw it, if device() is a QPixmap or a QWidget, or else draw it directly, if device() is a QPrinter or QPicture. +.PP +Currently alpha masks of the image are ignored when painting on a QPrinter. +.PP +See also drawPixmap() and QPixmap::convertFromImage(). +.PP +Example: canvas/canvas.cpp. +.SH "void QPainter::drawImage ( const QPoint &, const QImage &, const QRect & sr, int conversionFlags = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the rectangle \fIsr\fR from the image at the given point. +.SH "void QPainter::drawImage ( const QPoint & p, const QImage & i, int conversion_flags = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the image \fIi\fR at point \fIp\fR. +.PP +If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. +.PP +See also Qt::ImageConversionFlags. +.SH "void QPainter::drawImage ( const QRect & r, const QImage & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the image \fIi\fR into the rectangle \fIr\fR. The image will be scaled to fit the rectangle if image and rectangle dimensions differ. +.SH "void QPainter::drawLine ( int x1, int y1, int x2, int y2 )" +Draws a line from (\fIx1\fR, \fIy1\fR) to (\fIx2\fR, \fIy2\fR) and sets the current pen position to (\fIx2\fR, \fIy2\fR). +.PP +See also pen(). +.PP +Examples: +.)l aclock/aclock.cpp, drawlines/connect.cpp, progress/progress.cpp, splitter/splitter.cpp, themes/metal.cpp, and themes/wood.cpp. +.SH "void QPainter::drawLine ( const QPoint & p1, const QPoint & p2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a line from point \fIp1\fR to point \fIp2\fR. +.SH "void QPainter::drawLineSegments ( const QPointArray & a, int index = 0, int nlines = -1 )" +Draws \fInlines\fR separate lines from points defined in \fIa\fR, starting at \fIa[index]\fR (\fIindex\fR defaults to 0). If \fInlines\fR is -1 (the default) all points until the end of the array are used (i.e. (a.size()-index)/2 lines are drawn). +.PP +Draws the 1st line from \fIa[index]\fR to \fIa[index+1]\fR. Draws the 2nd line from \fIa[index+2]\fR to \fIa[index+3]\fR etc. +.PP +\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. +.PP +See also drawPolyline(), drawPolygon(), and QPen. +.SH "void QPainter::drawPicture ( int x, int y, const QPicture & pic )" +Replays the picture \fIpic\fR translated by (\fIx\fR, \fIy\fR). +.PP +This function does exactly the same as QPicture::play() when called with (\fIx\fR, \fIy\fR) = (0, 0). +.PP +Examples: +.)l picture/picture.cpp and xform/xform.cpp. +.SH "void QPainter::drawPicture ( const QPicture & pic )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use one of the other QPainter::drawPicture() functions with a (0, 0) offset instead. +.SH "void QPainter::drawPicture ( const QPoint & p, const QPicture & pic )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws picture \fIpic\fR at point \fIp\fR. +.SH "void QPainter::drawPie ( int x, int y, int w, int h, int a, int alen )" +Draws a pie defined by the rectangle \fI(x, y, w, h)\fR, the start angle \fIa\fR and the arc length \fIalen\fR. +.PP +The pie is filled with the current brush(). +.PP +The angles \fIa\fR and \fIalen\fR are 1/16th of a degree, i.e. a full circle equals 5760 (16*360). Positive values of \fIa\fR and \fIalen\fR mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. +.PP +See also drawArc() and drawChord(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp, grapher/grapher.cpp, t10/cannon.cpp, and t9/cannon.cpp. +.SH "void QPainter::drawPie ( const QRect & r, int a, int alen )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a pie segment that fits inside the rectangle \fIr\fR with start angle \fIa\fR and arc length \fIalen\fR. +.SH "void QPainter::drawPixmap ( int x, int y, const QPixmap & pixmap, int sx = 0, int sy = 0, int sw = -1, int sh = -1 )" +Draws a pixmap at \fI(x, y)\fR by copying a part of \fIpixmap\fR into the paint device. +.PP +\fI(x, y)\fR specifies the top-left point in the paint device that is to be drawn onto. \fI(sx, sy)\fR specifies the top-left point in \fIpixmap\fR that is to be drawn. The default is (0, 0). +.PP +\fI(sw, sh)\fR specifies the size of the pixmap that is to be drawn. The default, (-1, -1), means all the way to the bottom right of the pixmap. +.PP +Currently the mask of the pixmap or it's alpha channel are ignored when painting on a QPrinter. +.PP +See also bitBlt() and QPixmap::setMask(). +.PP +Examples: +.)l grapher/grapher.cpp, picture/picture.cpp, qdir/qdir.cpp, qmag/qmag.cpp, showimg/showimg.cpp, t10/cannon.cpp, and xform/xform.cpp. +.SH "void QPainter::drawPixmap ( const QPoint & p, const QPixmap & pm, const QRect & sr )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the rectangle \fIsr\fR of pixmap \fIpm\fR with its origin at point \fIp\fR. +.SH "void QPainter::drawPixmap ( const QPoint & p, const QPixmap & pm )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the pixmap \fIpm\fR with its origin at point \fIp\fR. +.SH "void QPainter::drawPixmap ( const QRect & r, const QPixmap & pm )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the pixmap \fIpm\fR into the rectangle \fIr\fR. The pixmap is scaled to fit the rectangle, if image and rectangle size disagree. +.SH "void QPainter::drawPoint ( int x, int y )" +Draws/plots a single point at \fI(x, y)\fR using the current pen. +.PP +See also QPen. +.PP +Examples: +.)l desktop/desktop.cpp and drawlines/connect.cpp. +.SH "void QPainter::drawPoint ( const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the point \fIp\fR. +.SH "void QPainter::drawPoints ( const QPointArray & a, int index = 0, int npoints = -1 )" +Draws/plots an array of points, \fIa\fR, using the current pen. +.PP +If \fIindex\fR is non-zero (the default is zero) only points from \fIindex\fR are drawn. If \fInpoints\fR is negative (the default) the rest of the points from \fIindex\fR are drawn. If \fInpoints\fR is zero or greater, \fInpoints\fR points are drawn. +.PP +\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. +.SH "void QPainter::drawPolygon ( const QPointArray & a, bool winding = FALSE, int index = 0, int npoints = -1 )" +Draws the polygon defined by the \fInpoints\fR points in \fIa\fR starting at \fIa[index]\fR. (\fIindex\fR defaults to 0.) +.PP +If \fInpoints\fR is -1 (the default) all points until the end of the array are used (i.e. a.size()-index line segments define the polygon). +.PP +The first point is always connected to the last point. +.PP +The polygon is filled with the current brush(). If \fIwinding\fR is TRUE, the polygon is filled using the winding fill algorithm. If \fIwinding\fR is FALSE, the polygon is filled using the even-odd (alternative) fill algorithm. +.PP +\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. +.PP +See also drawLineSegments(), drawPolyline(), and QPen. +.PP +Examples: +.)l desktop/desktop.cpp and picture/picture.cpp. +.SH "void QPainter::drawPolyline ( const QPointArray & a, int index = 0, int npoints = -1 )" +Draws the polyline defined by the \fInpoints\fR points in \fIa\fR starting at \fIa[index]\fR. (\fIindex\fR defaults to 0.) +.PP +If \fInpoints\fR is -1 (the default) all points until the end of the array are used (i.e. a.size()-index-1 line segments are drawn). +.PP +\fBWarning:\fR On X11, coordinates that do not fit into 16-bit signed values are truncated. This limitation is expected to go away in Qt 4. +.PP +See also drawLineSegments(), drawPolygon(), and QPen. +.PP +Examples: +.)l scribble/scribble.cpp and themes/metal.cpp. +.SH "void QPainter::drawRect ( int x, int y, int w, int h )" +Draws a rectangle with upper left corner at \fI(x, y)\fR and with width \fIw\fR and height \fIh\fR. +.PP +See also QPen and drawRoundRect(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp, picture/picture.cpp, t10/cannon.cpp, t11/cannon.cpp, t9/cannon.cpp, tooltip/tooltip.cpp, and trivial/trivial.cpp. +.SH "void QPainter::drawRect ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the rectangle \fIr\fR. +.SH "void QPainter::drawRoundRect ( int x, int y, int w, int h, int xRnd = 25, int yRnd = 25 )" +Draws a rectangle with rounded corners at \fI(x, y)\fR, with width \fIw\fR and height \fIh\fR. +.PP +The \fIxRnd\fR and \fIyRnd\fR arguments specify how rounded the corners should be. 0 is angled corners, 99 is maximum roundedness. +.PP +The width and height include all of the drawn lines. +.PP +See also drawRect() and QPen. +.PP +Examples: +.)l drawdemo/drawdemo.cpp and themes/wood.cpp. +.SH "void QPainter::drawRoundRect ( const QRect & r, int xRnd = 25, int yRnd = 25 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a rounded rectangle \fIr\fR, rounding to the x position \fIxRnd\fR and the y position \fIyRnd\fR on each corner. +.SH "void QPainter::drawText ( const QPoint & p, const QString &, int pos, int len, TextDirection dir = Auto )" +Draws the text from position \fIpos\fR, at point \fIp\fR. If \fIlen\fR is -1 the entire string is drawn, otherwise just the first \fIlen\fR characters. The text's direction is specified by \fIdir\fR. +.PP +Note that the meaning of \fIy\fR is not the same for the two drawText() varieties. For overloads that take a simple \fIx\fR, \fIy\fR pair (or a point), the \fIy\fR value is the text's baseline; for overloads that take a rectangle, \fIrect.y()\fR is the top of the rectangle and the text is aligned within that rectangle in accordance with the alignment flags. +.PP +See also QPainter::TextDirection. +.PP +Examples: +.)l desktop/desktop.cpp, drawdemo/drawdemo.cpp, grapher/grapher.cpp, picture/picture.cpp, progress/progress.cpp, t8/cannon.cpp, and trivial/trivial.cpp. +.SH "void QPainter::drawText ( int x, int y, const QString &, int len = -1, TextDirection dir = Auto )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the given text at position \fIx\fR, \fIy\fR. If \fIlen\fR is -1 (the default) all the text is drawn, otherwise the first \fIlen\fR characters are drawn. The text's direction is given by \fIdir\fR. +.PP +See also QPainter::TextDirection. +.SH "void QPainter::drawText ( const QPoint &, const QString &, int len = -1, TextDirection dir = Auto )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the text at the given point. +.PP +See also QPainter::TextDirection. +.SH "void QPainter::drawText ( int x, int y, const QString &, int pos, int len, TextDirection dir = Auto )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the text from position \fIpos\fR, at point \fI(x, y)\fR. If \fIlen\fR is -1 the entire string is drawn, otherwise just the first \fIlen\fR characters. The text's direction is specified by \fIdir\fR. +.SH "void QPainter::drawText ( int x, int y, int w, int h, int flags, const QString &, int len = -1, QRect * br = 0, QTextParag ** internal = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the given text within the rectangle starting at \fIx\fR, \fIy\fR, with width \fIw\fR and height \fIh\fR. If \fIlen\fR is -1 (the default) all the text is drawn, otherwise the first \fIlen\fR characters are drawn. The text's flags that are given in the \fIflags\fR parameter are Qt::AlignmentFlags and Qt::TextFlags OR'd together. \fIbr\fR (if not null) is set to the actual bounding rectangle of the output. The \fIinternal\fR parameter is for internal use only. +.SH "void QPainter::drawText ( const QRect & r, int tf, const QString & str, int len = -1, QRect * brect = 0, QTextParag ** internal = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws at most \fIlen\fR characters from \fIstr\fR in the rectangle \fIr\fR. +.PP +This function draws formatted text. The \fItf\fR text format is really of type Qt::AlignmentFlags and Qt::TextFlags OR'd together. +.PP +Horizontal alignment defaults to AlignAuto and vertical alignment defaults to AlignTop. +.PP +\fIbrect\fR (if not null) is set to the actual bounding rectangle of the output. \fIinternal\fR is, yes, internal. +.PP +See also boundingRect(). +.SH "void QPainter::drawTiledPixmap ( int x, int y, int w, int h, const QPixmap & pixmap, int sx = 0, int sy = 0 )" +Draws a tiled \fIpixmap\fR in the specified rectangle. +.PP +\fI(x, y)\fR specifies the top-left point in the paint device that is to be drawn onto; with the width and height given by \fIw\fR and \fIh\fR. \fI(sx, sy)\fR specifies the top-left point in \fIpixmap\fR that is to be drawn. The default is (0, 0). +.PP +Calling drawTiledPixmap() is similar to calling drawPixmap() several times to fill (tile) an area with a pixmap, but is potentially much more efficient depending on the underlying window system. +.PP +See also drawPixmap(). +.SH "void QPainter::drawTiledPixmap ( const QRect & r, const QPixmap & pm, const QPoint & sp )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a tiled pixmap, \fIpm\fR, inside rectangle \fIr\fR with its origin at point \fIsp\fR. +.SH "void QPainter::drawTiledPixmap ( const QRect & r, const QPixmap & pm )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a tiled pixmap, \fIpm\fR, inside rectangle \fIr\fR. +.SH "void QPainter::drawWinFocusRect ( int x, int y, int w, int h, const QColor & bgColor )" +Draws a Windows focus rectangle with upper left corner at (\fIx\fR, \fIy\fR) and with width \fIw\fR and height \fIh\fR using a pen color that contrasts with \fIbgColor\fR. +.PP +This function draws a stippled rectangle (XOR is not used) that is used to indicate keyboard focus (when the QApplication::style() is \fCWindowStyle\fR). +.PP +The pen color used to draw the rectangle is either white or black depending on the color of \fIbgColor\fR (see QColor::gray()). +.PP +\fBWarning:\fR This function draws nothing if the coordinate system has been rotated or sheared. +.PP +See also drawRect() and QApplication::style(). +.SH "void QPainter::drawWinFocusRect ( int x, int y, int w, int h )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a Windows focus rectangle with upper left corner at (\fIx\fR, \fIy\fR) and with width \fIw\fR and height \fIh\fR. +.PP +This function draws a stippled XOR rectangle that is used to indicate keyboard focus (when QApplication::style() is \fCWindowStyle\fR). +.PP +\fBWarning:\fR This function draws nothing if the coordinate system has been rotated or sheared. +.PP +See also drawRect() and QApplication::style(). +.SH "void QPainter::drawWinFocusRect ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws rectangle \fIr\fR as a window focus rectangle. +.SH "void QPainter::drawWinFocusRect ( const QRect & r, const QColor & bgColor )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws rectangle \fIr\fR as a window focus rectangle using background color \fIbgColor\fR. +.SH "bool QPainter::end ()" +Ends painting. Any resources used while painting are released. +.PP +Note that while you mostly don't need to call end(), the destructor will do it, there is at least one common case when it is needed, namely double buffering. +.PP +.nf +.br + QPainter p( myPixmap, this ) +.br + // ... +.br + p.end(); // stops drawing on myPixmap +.br + p.begin( this ); +.br + p.drawPixmap( 0, 0, myPixmap ); +.br +.fi +.PP +Since you can't draw a QPixmap while it is being painted, it is necessary to close the active painter. +.PP +See also begin() and isActive(). +.PP +Examples: +.)l aclock/aclock.cpp, desktop/desktop.cpp, hello/hello.cpp, picture/picture.cpp, scribble/scribble.cpp, t10/cannon.cpp, and xform/xform.cpp. +.SH "void QPainter::eraseRect ( int x, int y, int w, int h )" +Erases the area inside \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR. Equivalent to \fCfillRect( x, y, w, h, backgroundColor() )\fR. +.PP +Examples: +.)l listboxcombo/listboxcombo.cpp and showimg/showimg.cpp. +.SH "void QPainter::eraseRect ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Erases the area inside the rectangle \fIr\fR. +.SH "void QPainter::fillRect ( int x, int y, int w, int h, const QBrush & brush )" +Fills the rectangle \fI(x, y, w, h)\fR with the \fIbrush\fR. +.PP +You can specify a QColor as \fIbrush\fR, since there is a QBrush constructor that takes a QColor argument and creates a solid pattern brush. +.PP +See also drawRect(). +.PP +Examples: +.)l listboxcombo/listboxcombo.cpp, multiple/ax1.h, progress/progress.cpp, qdir/qdir.cpp, qfd/fontdisplayer.cpp, themes/metal.cpp, and themes/wood.cpp. +.SH "void QPainter::fillRect ( const QRect & r, const QBrush & brush )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Fills the rectangle \fIr\fR using brush \fIbrush\fR. +.SH "void QPainter::flush ( const QRegion & region, CoordinateMode cm = CoordDevice )" +Flushes any buffered drawing operations inside the region \fIregion\fR using clipping mode \fIcm\fR. +.PP +The flush may update the whole device if the platform does not support flushing to a specified region. +.PP +See also CoordinateMode. +.SH "void QPainter::flush ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Flushes any buffered drawing operations. +.SH "const QFont & QPainter::font () const" +Returns the currently set painter font. +.PP +See also setFont() and QFont. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QFontInfo QPainter::fontInfo () const" +Returns the font info for the painter, if the painter is active. It is not possible to obtain font information for an inactive painter, so the return value is undefined if the painter is not active. +.PP +See also fontMetrics() and isActive(). +.SH "QFontMetrics QPainter::fontMetrics () const" +Returns the font metrics for the painter, if the painter is active. It is not possible to obtain metrics for an inactive painter, so the return value is undefined if the painter is not active. +.PP +See also fontInfo() and isActive(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, desktop/desktop.cpp, drawdemo/drawdemo.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. +.SH "HDC QPainter::handle () const" +Returns the platform-dependent handle used for drawing. Using this function is not portable. +.SH "bool QPainter::hasClipping () const" +Returns TRUE if clipping has been set; otherwise returns FALSE. +.PP +See also setClipping(). +.PP +Example: themes/wood.cpp. +.SH "bool QPainter::hasViewXForm () const" +Returns TRUE if view transformation is enabled; otherwise returns FALSE. +.PP +See also setViewXForm() and xForm(). +.SH "bool QPainter::hasWorldXForm () const" +Returns TRUE if world transformation is enabled; otherwise returns FALSE. +.PP +See also setWorldXForm(). +.SH "bool QPainter::isActive () const" +Returns TRUE if the painter is active painting, i.e. begin() has been called and end() has not yet been called; otherwise returns FALSE. +.PP +See also QPaintDevice::paintingActive(). +.PP +Examples: +.)l desktop/desktop.cpp and helpviewer/helpwindow.cpp. +.SH "void QPainter::lineTo ( int x, int y )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use drawLine() instead. +.PP +Draws a line from the current pen position to \fI(x, y)\fR and sets \fI(x, y)\fR to be the new current pen position. +.PP +See also QPen, moveTo(), drawLine(), and pos(). +.SH "void QPainter::lineTo ( const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws a line to the point \fIp\fR. +.SH "void QPainter::moveTo ( int x, int y )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the current pen position to \fI(x, y)\fR +.PP +See also lineTo() and pos(). +.SH "void QPainter::moveTo ( const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Moves to the point \fIp\fR. +.SH "const QPen & QPainter::pen () const" +Returns the painter's current pen. +.PP +See also setPen(). +.PP +Examples: +.)l multiple/ax2.h, progress/progress.cpp, and themes/wood.cpp. +.SH "QPoint QPainter::pos () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the current position of the pen. +.PP +See also moveTo(). +.SH "RasterOp QPainter::rasterOp () const" +Returns the current raster operation. +.PP +See also setRasterOp() and RasterOp. +.SH "void QPainter::redirect ( QPaintDevice * pdev, QPaintDevice * replacement )\fC [static]\fR" +Redirects all paint commands for a paint device, \fIpdev\fR, to another paint device, \fIreplacement\fR, unless \fIreplacement\fR is 0. If \fIreplacement\fR is 0, the redirection for \fIpdev\fR is removed. +.PP +In general, you'll probably find calling QPixmap::grabWidget() or QPixmap::grabWindow() is an easier solution. +.SH "void QPainter::resetXForm ()" +Resets any transformations that were made using translate(), scale(), shear(), rotate(), setWorldMatrix(), setViewport() and setWindow(). +.PP +See also worldMatrix(), viewport(), and window(). +.SH "void QPainter::restore ()" +Restores the current painter state (pops a saved state off the stack). +.PP +See also save(). +.PP +Example: aclock/aclock.cpp. +.SH "void QPainter::restoreWorldMatrix ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +We recommend using restore() instead. +.SH "void QPainter::rotate ( double a )" +Rotates the coordinate system \fIa\fR degrees counterclockwise. +.PP +See also translate(), scale(), shear(), resetXForm(), setWorldMatrix(), and xForm(). +.PP +Examples: +.)l aclock/aclock.cpp, t10/cannon.cpp, and t9/cannon.cpp. +.SH "void QPainter::save ()" +Saves the current painter state (pushes the state onto a stack). A save() must be followed by a corresponding restore(). end() unwinds the stack. +.PP +See also restore(). +.PP +Example: aclock/aclock.cpp. +.SH "void QPainter::saveWorldMatrix ()" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +We recommend using save() instead. +.SH "void QPainter::scale ( double sx, double sy )" +Scales the coordinate system by \fI(sx, sy)\fR. +.PP +See also translate(), shear(), rotate(), resetXForm(), setWorldMatrix(), and xForm(). +.PP +Example: xform/xform.cpp. +.SH "void QPainter::setBackgroundColor ( const QColor & c )" +Sets the background color of the painter to \fIc\fR. +.PP +The background color is the color that is filled in when drawing opaque text, stippled lines and bitmaps. The background color has no effect in transparent background mode (which is the default). +.PP +See also backgroundColor(), setBackgroundMode(), and BackgroundMode. +.SH "void QPainter::setBackgroundMode ( BGMode m )" +Sets the background mode of the painter to \fIm\fR, which must be either TransparentMode (the default) or OpaqueMode. +.PP +Transparent mode draws stippled lines and text without setting the background pixels. Opaque mode fills these space with the current background color. +.PP +Note that in order to draw a bitmap or pixmap transparently, you must use QPixmap::setMask(). +.PP +See also backgroundMode() and setBackgroundColor(). +.PP +Example: picture/picture.cpp. +.SH "void QPainter::setBrush ( BrushStyle style )" +Sets the painter's brush to black color and the specified \fIstyle\fR. +.PP +See also brush() and QBrush. +.PP +Examples: +.)l aclock/aclock.cpp, drawdemo/drawdemo.cpp, picture/picture.cpp, t10/cannon.cpp, t9/cannon.cpp, themes/wood.cpp, and tooltip/tooltip.cpp. +.SH "void QPainter::setBrush ( const QBrush & brush )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the painter's brush to \fIbrush\fR. +.PP +The \fIbrush\fR defines how shapes are filled. +.PP +See also brush(). +.SH "void QPainter::setBrush ( const QColor & color )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the painter's brush to have style SolidPattern and the specified \fIcolor\fR. +.PP +See also brush() and QBrush. +.SH "void QPainter::setBrushOrigin ( int x, int y )" +Sets the brush origin to \fI(x, y)\fR. +.PP +The brush origin specifies the (0, 0) coordinate of the painter's brush. This setting only applies to pattern brushes and pixmap brushes. +.PP +See also brushOrigin(). +.SH "void QPainter::setBrushOrigin ( const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the brush origin to point \fIp\fR. +.SH "void QPainter::setClipRect ( int x, int y, int w, int h, CoordinateMode m = CoordDevice )" +Sets the clip region to the rectangle \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR and enables clipping. The clip mode is set to \fIm\fR. +.PP +If \fIm\fR is CoordDevice (the default), the coordinates given for the clip region are taken to be physical device coordinates and are \fInot\fR subject to any coordinate transformations. If \fIm\fR is CoordPainter, the coordinates given for the clip region are taken to be model coordinates. +.PP +See also setClipRegion(), clipRegion(), setClipping(), and QPainter::CoordinateMode. +.PP +Examples: +.)l grapher/grapher.cpp, progress/progress.cpp, showimg/showimg.cpp, splitter/splitter.cpp, and trivial/trivial.cpp. +.SH "void QPainter::setClipRect ( const QRect & r, CoordinateMode m = CoordDevice )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the clip region to the rectangle \fIr\fR and enables clipping. The clip mode is set to \fIm\fR. +.PP +See also CoordinateMode. +.SH "void QPainter::setClipRegion ( const QRegion & rgn, CoordinateMode m = CoordDevice )" +Sets the clip region to \fIrgn\fR and enables clipping. The clip mode is set to \fIm\fR. +.PP +Note that the clip region is given in physical device coordinates and \fInot\fR subject to any coordinate transformation. +.PP +See also setClipRect(), clipRegion(), setClipping(), and CoordinateMode. +.PP +Examples: +.)l qfd/fontdisplayer.cpp and themes/wood.cpp. +.SH "void QPainter::setClipping ( bool enable )" +Enables clipping if \fIenable\fR is TRUE, or disables clipping if \fIenable\fR is FALSE. +.PP +See also hasClipping(), setClipRect(), and setClipRegion(). +.PP +Example: themes/wood.cpp. +.SH "void QPainter::setFont ( const QFont & font )" +Sets the painter's font to \fIfont\fR. +.PP +This font is used by subsequent drawText() functions. The text color is the same as the pen color. +.PP +See also font() and drawText(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp, grapher/grapher.cpp, hello/hello.cpp, picture/picture.cpp, qwerty/qwerty.cpp, t13/cannon.cpp, and xform/xform.cpp. +.SH "void QPainter::setPen ( const QPen & pen )" +Sets a new painter pen. +.PP +The \fIpen\fR defines how to draw lines and outlines, and it also defines the text color. +.PP +See also pen(). +.PP +Examples: +.)l desktop/desktop.cpp, drawdemo/drawdemo.cpp, multiple/ax2.h, progress/progress.cpp, t9/cannon.cpp, themes/metal.cpp, and themes/wood.cpp. +.SH "void QPainter::setPen ( PenStyle style )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the painter's pen to have style \fIstyle\fR, width 0 and black color. +.PP +See also pen() and QPen. +.SH "void QPainter::setPen ( const QColor & color )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the painter's pen to have style SolidLine, width 0 and the specified \fIcolor\fR. +.PP +See also pen() and QPen. +.SH "void QPainter::setRasterOp ( RasterOp r )" +Sets the raster operation to \fIr\fR. The default is CopyROP. +.PP +See also rasterOp() and Qt::RasterOp. +.SH "void QPainter::setTabArray ( int * ta )" +Sets the tab stop array to \fIta\fR. This puts tab stops at \fIta[0]\fR, \fIta[1]\fR and so on. The array is null-terminated. +.PP +If both a tab array and a tab top size is set, the tab array wins. +.PP +See also tabArray(), setTabStops(), drawText(), and fontMetrics(). +.SH "void QPainter::setTabStops ( int ts )" +Set the tab stop width to \fIts\fR, i.e. locates tab stops at \fIts\fR, 2*\fIts\fR, 3*\fIts\fR and so on. +.PP +Tab stops are used when drawing formatted text with ExpandTabs set. This fixed tab stop value is used only if no tab array is set (which is the default case). +.PP +A value of 0 (the default) implies a tabstop setting of 8 times the width of the character 'x' in the font currently set on the painter. +.PP +See also tabStops(), setTabArray(), drawText(), and fontMetrics(). +.SH "void QPainter::setViewXForm ( bool enable )" +Enables view transformations if \fIenable\fR is TRUE, or disables view transformations if \fIenable\fR is FALSE. +.PP +See also hasViewXForm(), setWindow(), setViewport(), setWorldMatrix(), setWorldXForm(), and xForm(). +.SH "void QPainter::setViewport ( int x, int y, int w, int h )" +Sets the viewport rectangle view transformation for the painter and enables view transformation. +.PP +The viewport rectangle is part of the view transformation. The viewport specifies the device coordinate system and is specified by the \fIx\fR, \fIy\fR, \fIw\fR width and \fIh\fR height parameters. Its sister, the window(), specifies the logical coordinate system. +.PP +The default viewport rectangle is the same as the device's rectangle. See the Coordinate System Overview for an overview of coordinate transformation. +.PP +See also viewport(), setWindow(), setViewXForm(), setWorldMatrix(), setWorldXForm(), and xForm(). +.PP +Example: aclock/aclock.cpp. +.SH "void QPainter::setViewport ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the painter's viewport to rectangle \fIr\fR. +.SH "void QPainter::setWindow ( int x, int y, int w, int h )" +Sets the window rectangle view transformation for the painter and enables view transformation. +.PP +The window rectangle is part of the view transformation. The window specifies the logical coordinate system and is specified by the \fIx\fR, \fIy\fR, \fIw\fR width and \fIh\fR height parameters. Its sister, the viewport(), specifies the device coordinate system. +.PP +The default window rectangle is the same as the device's rectangle. See the Coordinate System Overview for an overview of coordinate transformation. +.PP +See also window(), setViewport(), setViewXForm(), setWorldMatrix(), and setWorldXForm(). +.PP +Examples: +.)l aclock/aclock.cpp and drawdemo/drawdemo.cpp. +.SH "void QPainter::setWindow ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the painter's window to rectangle \fIr\fR. +.SH "void QPainter::setWorldMatrix ( const QWMatrix & m, bool combine = FALSE )" +Sets the world transformation matrix to \fIm\fR and enables world transformation. +.PP +If \fIcombine\fR is TRUE, then \fIm\fR is combined with the current transformation matrix, otherwise \fIm\fR replaces the current transformation matrix. +.PP +If \fIm\fR is the identity matrix and \fIcombine\fR is FALSE, this function calls setWorldXForm(FALSE). (The identity matrix is the matrix where QWMatrix::m11() and QWMatrix::m22() are 1.0 and the rest are 0.0.) +.PP +World transformations are applied after the view transformations (i.e. window and viewport). +.PP +The following functions can transform the coordinate system without using a QWMatrix: +.TP +translate() +.TP +scale() +.TP +shear() +.TP +rotate() +.PP +They operate on the painter's worldMatrix() and are implemented like this: +.PP +.nf +.br + void QPainter::rotate( double a ) +.br + { +.br + QWMatrix m; +.br + m.rotate( a ); +.br + setWorldMatrix( m, TRUE ); +.br + } +.br +.fi +.PP +Note that you should always use \fIcombine\fR when you are drawing into a QPicture. Otherwise it may not be possible to replay the picture with additional transformations. Using translate(), scale(), etc., is safe. +.PP +For a brief overview of coordinate transformation, see the Coordinate System Overview. +.PP +See also worldMatrix(), setWorldXForm(), setWindow(), setViewport(), setViewXForm(), xForm(), and QWMatrix. +.PP +Examples: +.)l drawdemo/drawdemo.cpp and xform/xform.cpp. +.SH "void QPainter::setWorldXForm ( bool enable )" +Enables world transformations if \fIenable\fR is TRUE, or disables world transformations if \fIenable\fR is FALSE. The world transformation matrix is not changed. +.PP +See also setWorldMatrix(), setWindow(), setViewport(), setViewXForm(), and xForm(). +.SH "void QPainter::shear ( double sh, double sv )" +Shears the coordinate system by \fI(sh, sv)\fR. +.PP +See also translate(), scale(), rotate(), resetXForm(), setWorldMatrix(), and xForm(). +.SH "int * QPainter::tabArray () const" +Returns the currently set tab stop array. +.PP +See also setTabArray(). +.SH "int QPainter::tabStops () const" +Returns the tab stop setting. +.PP +See also setTabStops(). +.SH "void QPainter::translate ( double dx, double dy )" +Translates the coordinate system by \fI(dx, dy)\fR. After this call, \fI(dx, dy)\fR is added to points. +.PP +For example, the following code draws the same point twice: +.PP +.nf +.br + void MyWidget::paintEvent() +.br + { +.br + QPainter paint( this ); +.br +.br + paint.drawPoint( 0, 0 ); +.br +.br + paint.translate( 100.0, 40.0 ); +.br + paint.drawPoint( -100, -40 ); +.br + } +.br +.fi +.PP +See also scale(), shear(), rotate(), resetXForm(), setWorldMatrix(), and xForm(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, t10/cannon.cpp, t9/cannon.cpp, themes/metal.cpp, themes/wood.cpp, and xform/xform.cpp. +.SH "QRect QPainter::viewport () const" +Returns the viewport rectangle. +.PP +See also setViewport() and setViewXForm(). +.PP +Example: aclock/aclock.cpp. +.SH "QRect QPainter::window () const" +Returns the window rectangle. +.PP +See also setWindow() and setViewXForm(). +.SH "const QWMatrix & QPainter::worldMatrix () const" +Returns the world transformation matrix. +.PP +See also setWorldMatrix(). +.SH "QPoint QPainter::xForm ( const QPoint & pv ) const" +Returns the point \fIpv\fR transformed from model coordinates to device coordinates. +.PP +See also xFormDev() and QWMatrix::map(). +.SH "QRect QPainter::xForm ( const QRect & rv ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the rectangle \fIrv\fR transformed from model coordinates to device coordinates. +.PP +If world transformation is enabled and rotation or shearing has been specified, then the bounding rectangle is returned. +.PP +See also xFormDev() and QWMatrix::map(). +.SH "QPointArray QPainter::xForm ( const QPointArray & av ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point array \fIav\fR transformed from model coordinates to device coordinates. +.PP +See also xFormDev() and QWMatrix::map(). +.SH "QPointArray QPainter::xForm ( const QPointArray & av, int index, int npoints ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point array \fIav\fR transformed from model coordinates to device coordinates. The \fIindex\fR is the first point in the array and \fInpoints\fR denotes the number of points to be transformed. If \fInpoints\fR is negative, all points from \fIav[index]\fR until the last point in the array are transformed. +.PP +The returned point array consists of the number of points that were transformed. +.PP +Example: +.PP +.nf +.br + QPointArray a(10); +.br + QPointArray b; +.br + b = painter.xForm(a, 2, 4); // b.size() == 4 +.br + b = painter.xForm(a, 2, -1); // b.size() == 8 +.br +.fi +.PP +See also xFormDev() and QWMatrix::map(). +.SH "QRect QPainter::xFormDev ( const QRect & rd ) const" +Returns the rectangle \fIrd\fR transformed from device coordinates to model coordinates. +.PP +If world transformation is enabled and rotation or shearing is used, then the bounding rectangle is returned. +.PP +See also xForm() and QWMatrix::map(). +.SH "QPoint QPainter::xFormDev ( const QPoint & pd ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point \fIpd\fR transformed from device coordinates to model coordinates. +.PP +See also xForm() and QWMatrix::map(). +.SH "QPointArray QPainter::xFormDev ( const QPointArray & ad ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point array \fIad\fR transformed from device coordinates to model coordinates. +.PP +See also xForm() and QWMatrix::map(). +.SH "QPointArray QPainter::xFormDev ( const QPointArray & ad, int index, int npoints ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point array \fIad\fR transformed from device coordinates to model coordinates. The \fIindex\fR is the first point in the array and \fInpoints\fR denotes the number of points to be transformed. If \fInpoints\fR is negative, all points from \fIad[index]\fR until the last point in the array are transformed. +.PP +The returned point array consists of the number of points that were transformed. +.PP +Example: +.PP +.nf +.br + QPointArray a(10); +.br + QPointArray b; +.br + b = painter.xFormDev(a, 1, 3); // b.size() == 3 +.br + b = painter.xFormDev(a, 1, -1); // b.size() == 9 +.br +.fi +.PP +See also xForm() and QWMatrix::map(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "void qDrawPlainRect ( QPainter * p, int x, int y, int w, int h, const QColor & c, int lineWidth, const QBrush * fill )" +\fC#include <ntqdrawutil.h>\fR +.PP +Draws the plain rectangle specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. +.PP +The color argument \fIc\fR specifies the line color. +.PP +The \fIlineWidth\fR argument specifies the line width. +.PP +The rectangle's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. +.PP +If you want to use a QFrame widget instead, you can make it display a plain rectangle, for example \fCQFrame::setFrameStyle( QFrame::Box | QFrame::Plain )\fR. +.PP +\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. +.PP +See also qDrawShadeRect() and QStyle::drawPrimitive(). +.SH "void qDrawShadeLine ( QPainter * p, int x1, int y1, int x2, int y2, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth )" +\fC#include <ntqdrawutil.h>\fR +.PP +Draws a horizontal (\fIy1\fR == \fIy2\fR) or vertical (\fIx1\fR == \fIx2\fR) shaded line using the painter \fIp\fR. +.PP +Nothing is drawn if \fIy1\fR != \fIy2\fR and \fIx1\fR != \fIx2\fR (i.e. the line is neither horizontal nor vertical). +.PP +The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). +.PP +The line appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. +.PP +The \fIlineWidth\fR argument specifies the line width for each of the lines. It is not the total line width. +.PP +The \fImidLineWidth\fR argument specifies the width of a middle line drawn in the QColorGroup::mid() color. +.PP +If you want to use a QFrame widget instead, you can make it display a shaded line, for example \fCQFrame::setFrameStyle( QFrame::HLine | QFrame::Sunken )\fR. +.PP +\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. +.PP +See also qDrawShadeRect(), qDrawShadePanel(), and QStyle::drawPrimitive(). +.SH "void qDrawShadePanel ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, const QBrush * fill )" +\fC#include <ntqdrawutil.h>\fR +.PP +Draws the shaded panel specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. +.PP +The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). +.PP +The panel appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. +.PP +The \fIlineWidth\fR argument specifies the line width. +.PP +The panel's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. +.PP +If you want to use a QFrame widget instead, you can make it display a shaded panel, for example \fCQFrame::setFrameStyle( QFrame::Panel | QFrame::Sunken )\fR. +.PP +\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. +.PP +See also qDrawWinPanel(), qDrawShadeLine(), qDrawShadeRect(), and QStyle::drawPrimitive(). +.SH "void qDrawShadeRect ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, int lineWidth, int midLineWidth, const QBrush * fill )" +\fC#include <ntqdrawutil.h>\fR +.PP +Draws the shaded rectangle specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. +.PP +The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). +.PP +The rectangle appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. +.PP +The \fIlineWidth\fR argument specifies the line width for each of the lines. It is not the total line width. +.PP +The \fImidLineWidth\fR argument specifies the width of a middle line drawn in the QColorGroup::mid() color. +.PP +The rectangle's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. +.PP +If you want to use a QFrame widget instead, you can make it display a shaded rectangle, for example \fCQFrame::setFrameStyle( QFrame::Box | QFrame::Raised )\fR. +.PP +\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. +.PP +See also qDrawShadeLine(), qDrawShadePanel(), qDrawPlainRect(), QStyle::drawItem(), QStyle::drawControl(), and QStyle::drawComplexControl(). +.SH "void qDrawWinButton ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" +\fC#include <ntqdrawutil.h>\fR +.PP +Draws the Windows-style button specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. +.PP +The color group argument \fIg\fR specifies the shading colors (light, dark and middle colors). +.PP +The button appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. +.PP +The line width is 2 pixels. +.PP +The button's interior is filled with the \fI*fill\fR brush unless \fIfill\fR is 0. +.PP +\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. +.PP +See also qDrawWinPanel() and QStyle::drawControl(). +.SH "void qDrawWinPanel ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool sunken, const QBrush * fill )" +\fC#include <ntqdrawutil.h>\fR +.PP +Draws the Windows-style panel specified by (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) using the painter \fIp\fR. +.PP +The color group argument \fIg\fR specifies the shading colors. +.PP +The panel appears sunken if \fIsunken\fR is TRUE, or raised if \fIsunken\fR is FALSE. +.PP +The line width is 2 pixels. +.PP +The button's interior is filled with the \fIfill\fR brush unless \fIfill\fR is 0. +.PP +If you want to use a QFrame widget instead, you can make it display a shaded panel, for example \fCQFrame::setFrameStyle( QFrame::WinPanel | QFrame::Raised )\fR. +.PP +\fBWarning:\fR This function does not look at QWidget::style() or QApplication::style(). Use the drawing functions in QStyle to make widgets that follow the current GUI style. +.PP +See also qDrawShadePanel(), qDrawWinButton(), and QStyle::drawPrimitive(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpainter.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpainter.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpaintevent.3qt b/doc/man/man3/tqpaintevent.3qt new file mode 100644 index 000000000..d699a8040 --- /dev/null +++ b/doc/man/man3/tqpaintevent.3qt @@ -0,0 +1,94 @@ +'\" t +.TH QPaintEvent 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 +QPaintEvent \- Event parameters for paint events +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPaintEvent\fR ( const QRegion & paintRegion, bool erased = TRUE )" +.br +.ti -1c +.BI "\fBQPaintEvent\fR ( const QRect & paintRect, bool erased = TRUE )" +.br +.ti -1c +.BI "\fBQPaintEvent\fR ( const QRegion & paintRegion, const QRect & paintRect, bool erased = TRUE )" +.br +.ti -1c +.BI "const QRect & \fBrect\fR () const" +.br +.ti -1c +.BI "const QRegion & \fBregion\fR () const" +.br +.ti -1c +.BI "bool \fBerased\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QPaintEvent class contains event parameters for paint events. +.PP +Paint events are sent to widgets that need to update themselves, for instance when part of a widget is exposed because a covering widget is moved. +.PP +The event contains a region() that needs to be updated, and a rect() that is the bounding rectangle of that region. Both are provided because many widgets can't make much use of region(), and rect() can be much faster than region().boundingRect(). Painting is clipped to region() during processing of a paint event. +.PP +The erased() function returns TRUE if the region() has been cleared to the widget's background (see QWidget::backgroundMode()), and FALSE if the region's contents are arbitrary. +.PP +See also QPainter, QWidget::update(), QWidget::repaint(), QWidget::paintEvent(), QWidget::backgroundMode, QRegion, and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPaintEvent::QPaintEvent ( const QRegion & paintRegion, bool erased = TRUE )" +Constructs a paint event object with the region that should be updated. The region is given by \fIpaintRegion\fR. If \fIerased\fR is TRUE the region will be cleared before repainting. +.SH "QPaintEvent::QPaintEvent ( const QRect & paintRect, bool erased = TRUE )" +Constructs a paint event object with the rectangle that should be updated. The region is also given by \fIpaintRect\fR. If \fIerased\fR is TRUE the region will be cleared before repainting. +.SH "QPaintEvent::QPaintEvent ( const QRegion & paintRegion, const QRect & paintRect, bool erased = TRUE )" +Constructs a paint event object with the rectangle \fIpaintRect\fR that should be updated. The region is given by \fIpaintRegion\fR. If \fIerased\fR is TRUE the region will be cleared before repainting. +.SH "bool QPaintEvent::erased () const" +Returns TRUE if the paint event region (or rectangle) has been erased with the widget's background; otherwise returns FALSE. +.SH "const QRect & QPaintEvent::rect () const" +Returns the rectangle that should be updated. +.PP +See also region() and QPainter::setClipRect(). +.PP +Examples: +.)l life/life.cpp, qfd/fontdisplayer.cpp, showimg/showimg.cpp, t10/cannon.cpp, t11/cannon.cpp, t13/cannon.cpp, and tooltip/tooltip.cpp. +.SH "const QRegion & QPaintEvent::region () const" +Returns the region that should be updated. +.PP +See also rect() and QPainter::setClipRegion(). +.PP +Examples: +.)l qfd/fontdisplayer.cpp and scribble/scribble.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qpaintevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpaintevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpair.3qt b/doc/man/man3/tqpair.3qt new file mode 100644 index 000000000..375a18a0f --- /dev/null +++ b/doc/man/man3/tqpair.3qt @@ -0,0 +1,100 @@ +'\" t +.TH QPair 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 +QPair \- Value-based template class that provides a pair of elements +.SH SYNOPSIS +\fC#include <ntqpair.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef T1 \fBfirst_type\fR" +.br +.ti -1c +.BI "typedef T2 \fBsecond_type\fR" +.br +.ti -1c +.BI "\fBQPair\fR ()" +.br +.ti -1c +.BI "\fBQPair\fR ( const T1 & t1, const T2 & t2 )" +.br +.ti -1c +.BI "QPair<T1, T2> & \fBoperator=\fR ( const QPair<T1, T2> & other )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QPair \fBqMakePair\fR ( T1 t1, T2 t2 )" +.br +.in -1c +.SH DESCRIPTION +The QPair class is a value-based template class that provides a pair of elements. +.PP +QPair is a Qt implementation of an STL-like pair. It can be used in your application if the standard pair<> is not available on your target platforms. +.PP +QPair<T1, T2> defines a template instance to create a pair of values that contains two values of type T1 and T2. Please note that QPair does not store pointers to the two elements; it holds a copy of every member. This is why these kinds of classes are called \fIvalue based\fR. If you're interested in \fIpointer based\fR classes see, for example, QPtrList and QDict. +.PP +QPair holds one copy of type T1 and one copy of type T2, but does not provide iterators to access these elements. Instead, the two elements (\fCfirst\fR and \fCsecond\fR) are public member variables of the pair. QPair owns the contained elements. For more relaxed ownership semantics, see QPtrCollection and friends which are pointer-based containers. +.PP +Some classes cannot be used within a QPair: for example, all classes derived from QObject and thus all classes that implement widgets. Only "values" can be used in a QPair. To qualify as a value the class must provide: +.TP +A copy constructor +.TP +An assignment operator +.TP +A constructor that takes no arguments +.PP +Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. +.PP +QPair uses an STL-like syntax to manipulate and address the objects it contains. See the QTL documentation for more information. +.PP +Functions that need to return two values can use a QPair. +.PP +See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QPair::first_type" +The type of the first element in the pair. +.SH "QPair::second_type" +The type of the second element in the pair. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPair::QPair ()" +Constructs an empty pair. The \fCfirst\fR and \fCsecond\fR elements are default constructed. +.SH "QPair::QPair ( const T1 & t1, const T2 & t2 )" +Constructs a pair and initializes the \fCfirst\fR element with \fIt1\fR and the \fCsecond\fR element with \fIt2\fR. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QPair qMakePair ( T1 t1, T2 t2 )" +This is a template convenience function. It is used to create a +QPair<> object that contains \fIt1\fR and \fIt2\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpair.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpair.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpalette.3qt b/doc/man/man3/tqpalette.3qt new file mode 100644 index 000000000..3b2a9f511 --- /dev/null +++ b/doc/man/man3/tqpalette.3qt @@ -0,0 +1,293 @@ +'\" t +.TH QPalette 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 +QPalette \- Color groups for each widget state +.SH SYNOPSIS +\fC#include <ntqpalette.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPalette\fR ()" +.br +.ti -1c +.BI "QPalette ( const QColor & button ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "\fBQPalette\fR ( const QColor & button, const QColor & background )" +.br +.ti -1c +.BI "\fBQPalette\fR ( const QColorGroup & active, const QColorGroup & disabled, const QColorGroup & inactive )" +.br +.ti -1c +.BI "\fBQPalette\fR ( const QPalette & p )" +.br +.ti -1c +.BI "\fB~QPalette\fR ()" +.br +.ti -1c +.BI "QPalette & \fBoperator=\fR ( const QPalette & p )" +.br +.ti -1c +.BI "enum \fBColorGroup\fR { Disabled, Active, Inactive, NColorGroups, Normal = Active }" +.br +.ti -1c +.BI "const QColor & \fBcolor\fR ( ColorGroup gr, QColorGroup::ColorRole r ) const" +.br +.ti -1c +.BI "const QBrush & \fBbrush\fR ( ColorGroup gr, QColorGroup::ColorRole r ) const" +.br +.ti -1c +.BI "void \fBsetColor\fR ( ColorGroup gr, QColorGroup::ColorRole r, const QColor & c )" +.br +.ti -1c +.BI "void \fBsetBrush\fR ( ColorGroup gr, QColorGroup::ColorRole r, const QBrush & b )" +.br +.ti -1c +.BI "void \fBsetColor\fR ( QColorGroup::ColorRole r, const QColor & c )" +.br +.ti -1c +.BI "void \fBsetBrush\fR ( QColorGroup::ColorRole r, const QBrush & b )" +.br +.ti -1c +.BI "QPalette \fBcopy\fR () const" +.br +.ti -1c +.BI "const QColorGroup & \fBactive\fR () const" +.br +.ti -1c +.BI "const QColorGroup & \fBdisabled\fR () const" +.br +.ti -1c +.BI "const QColorGroup & \fBinactive\fR () const" +.br +.ti -1c +.BI "const QColorGroup & normal () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetActive\fR ( const QColorGroup & g )" +.br +.ti -1c +.BI "void \fBsetDisabled\fR ( const QColorGroup & g )" +.br +.ti -1c +.BI "void \fBsetInactive\fR ( const QColorGroup & g )" +.br +.ti -1c +.BI "void setNormal ( const QColorGroup & cg ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QPalette & p ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QPalette & p ) const" +.br +.ti -1c +.BI "bool \fBisCopyOf\fR ( const QPalette & p )" +.br +.ti -1c +.BI "int \fBserialNumber\fR () const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPalette & p )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPalette & p )" +.br +.in -1c +.SH DESCRIPTION +The QPalette class contains color groups for each widget state. +.PP +A palette consists of three color groups: \fIactive\fR, \fIdisabled\fR, and \fIinactive\fR. All widgets contain a palette, and all widgets in Qt use their palette to draw themselves. This makes the user interface easily configurable and easier to keep consistent. +.PP +If you create a new widget we strongly recommend that you use the colors in the palette rather than hard-coding specific colors. +.PP +The color groups: +.TP +The active() group is used for the window that has keyboard focus. +.TP +The inactive() group is used for other windows. +.TP +The disabled() group is used for widgets (not windows) that are disabled for some reason. +.PP +Both active and inactive windows can contain disabled widgets. (Disabled widgets are often called \fIinaccessible\fR or \fIgrayed out\fR.) +.PP +In Motif style, active() and inactive() look the same. In Windows 2000 style and Macintosh Platinum style, the two styles look slightly different. +.PP +There are setActive(), setInactive(), and setDisabled() functions to modify the palette. (Qt also supports a normal() group; this is an obsolete alias for active(), supported for backwards compatibility.) +.PP +Colors and brushes can be set for particular roles in any of a palette's color groups with setColor() and setBrush(). +.PP +You can copy a palette using the copy constructor and test to see if two palettes are \fIidentical\fR using isCopyOf(). +.PP +See also QApplication::setPalette(), QWidget::palette, QColorGroup, QColor, Widget Appearance and Style, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SS "Member Type Documentation" +.SH "QPalette::ColorGroup" +.TP +\fCQPalette::Disabled\fR +.TP +\fCQPalette::Active\fR +.TP +\fCQPalette::Inactive\fR +.TP +\fCQPalette::NColorGroups\fR +.TP +\fCQPalette::Normal\fR - synonym for Active +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPalette::QPalette ()" +Constructs a palette that consists of color groups with only black colors. +.SH "QPalette::QPalette ( const QColor & button )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Constructs a palette from the \fIbutton\fR color. The other colors are automatically calculated, based on this color. Background will be the button color as well. +.SH "QPalette::QPalette ( const QColor & button, const QColor & background )" +Constructs a palette from a \fIbutton\fR color and a \fIbackground\fR. The other colors are automatically calculated, based on these colors. +.SH "QPalette::QPalette ( const QColorGroup & active, const QColorGroup & disabled, const QColorGroup & inactive )" +Constructs a palette that consists of the three color groups \fIactive\fR, \fIdisabled\fR and \fIinactive\fR. See the Detailed Description for definitions of the color groups and QColorGroup::ColorRole for definitions of each color role in the three groups. +.PP +See also QColorGroup and QColorGroup::ColorRole. +.SH "QPalette::QPalette ( const QPalette & p )" +Constructs a copy of \fIp\fR. +.PP +This constructor is fast (it uses copy-on-write). +.SH "QPalette::~QPalette ()" +Destroys the palette. +.SH "const QColorGroup & QPalette::active () const" +Returns the active color group of this palette. +.PP +See also QColorGroup, setActive(), inactive(), and disabled(). +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QBrush & QPalette::brush ( ColorGroup gr, QColorGroup::ColorRole r ) const" +Returns the brush in color group \fIgr\fR, used for color role \fIr\fR. +.PP +See also color(), setBrush(), and QColorGroup::ColorRole. +.SH "const QColor & QPalette::color ( ColorGroup gr, QColorGroup::ColorRole r ) const" +Returns the color in color group \fIgr\fR, used for color role \fIr\fR. +.PP +See also brush(), setColor(), and QColorGroup::ColorRole. +.SH "QPalette QPalette::copy () const" +Returns a deep copy of this palette. +.PP +\fBWarning:\fR This is slower than the copy constructor and assignment operator and offers no benefits. +.SH "const QColorGroup & QPalette::disabled () const" +Returns the disabled color group of this palette. +.PP +See also QColorGroup, setDisabled(), active(), and inactive(). +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "const QColorGroup & QPalette::inactive () const" +Returns the inactive color group of this palette. +.PP +See also QColorGroup, setInactive(), active(), and disabled(). +.SH "bool QPalette::isCopyOf ( const QPalette & p )" +Returns TRUE if this palette and \fIp\fR are copies of each other, i.e. one of them was created as a copy of the other and neither was subsequently modified; otherwise returns FALSE. This is much stricter than equality. +.PP +See also operator=() and operator==(). +.SH "const QColorGroup & QPalette::normal () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the active color group. Use active() instead. +.PP +See also setActive() and active(). +.SH "bool QPalette::operator!= ( const QPalette & p ) const" +Returns TRUE (slowly) if this palette is different from \fIp\fR; otherwise returns FALSE (usually quickly). +.SH "QPalette & QPalette::operator= ( const QPalette & p )" +Assigns \fIp\fR to this palette and returns a reference to this palette. +.PP +This is fast (it uses copy-on-write). +.PP +See also copy(). +.SH "bool QPalette::operator== ( const QPalette & p ) const" +Returns TRUE (usually quickly) if this palette is equal to \fIp\fR; otherwise returns FALSE (slowly). +.SH "int QPalette::serialNumber () const" +Returns a number that uniquely identifies this QPalette object. The serial number is intended for caching. Its value may not be used for anything other than equality testing. +.PP +Note that QPalette uses copy-on-write, and the serial number changes during the lazy copy operation (detach()), not during a shallow copy (copy constructor or assignment). +.PP +See also QPixmap, QPixmapCache, and QCache. +.SH "void QPalette::setActive ( const QColorGroup & g )" +Sets the Active color group to \fIg\fR. +.PP +See also active(), setDisabled(), setInactive(), and QColorGroup. +.SH "void QPalette::setBrush ( ColorGroup gr, QColorGroup::ColorRole r, const QBrush & b )" +Sets the brush in color group \fIgr\fR, used for color role \fIr\fR, to \fIb\fR. +.PP +See also brush(), setColor(), and QColorGroup::ColorRole. +.SH "void QPalette::setBrush ( QColorGroup::ColorRole r, const QBrush & b )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the brush in for color role \fIr\fR in all three color groups to \fIb\fR. +.PP +See also brush(), setColor(), QColorGroup::ColorRole, active(), inactive(), and disabled(). +.SH "void QPalette::setColor ( ColorGroup gr, QColorGroup::ColorRole r, const QColor & c )" +Sets the brush in color group \fIgr\fR, used for color role \fIr\fR, to the solid color \fIc\fR. +.PP +See also setBrush(), color(), and QColorGroup::ColorRole. +.PP +Example: themes/themes.cpp. +.SH "void QPalette::setColor ( QColorGroup::ColorRole r, const QColor & c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the brush color used for color role \fIr\fR to color \fIc\fR in all three color groups. +.PP +See also color(), setBrush(), and QColorGroup::ColorRole. +.SH "void QPalette::setDisabled ( const QColorGroup & g )" +Sets the Disabled color group to \fIg\fR. +.PP +See also disabled(), setActive(), and setInactive(). +.SH "void QPalette::setInactive ( const QColorGroup & g )" +Sets the Inactive color group to \fIg\fR. +.PP +See also active(), setDisabled(), setActive(), and QColorGroup. +.SH "void QPalette::setNormal ( const QColorGroup & cg )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the active color group to \fIcg\fR. Use setActive() instead. +.PP +See also setActive() and active(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QPalette & p )" +Writes the palette, \fIp\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QPalette & p )" +Reads a palette from the stream, \fIs\fR into the palette \fIp\fR, and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpalette.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpalette.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpen.3qt b/doc/man/man3/tqpen.3qt new file mode 100644 index 000000000..9672bee9d --- /dev/null +++ b/doc/man/man3/tqpen.3qt @@ -0,0 +1,287 @@ +'\" t +.TH QPen 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 +QPen \- Defines how a QPainter should draw lines and outlines of shapes +.SH SYNOPSIS +\fC#include <ntqpen.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPen\fR ()" +.br +.ti -1c +.BI "\fBQPen\fR ( PenStyle style )" +.br +.ti -1c +.BI "\fBQPen\fR ( const QColor & color, uint width = 0, PenStyle style = SolidLine )" +.br +.ti -1c +.BI "\fBQPen\fR ( const QColor & cl, uint w, PenStyle s, PenCapStyle c, PenJoinStyle j )" +.br +.ti -1c +.BI "\fBQPen\fR ( const QPen & p )" +.br +.ti -1c +.BI "\fB~QPen\fR ()" +.br +.ti -1c +.BI "QPen & \fBoperator=\fR ( const QPen & p )" +.br +.ti -1c +.BI "PenStyle \fBstyle\fR () const" +.br +.ti -1c +.BI "void \fBsetStyle\fR ( PenStyle s )" +.br +.ti -1c +.BI "uint \fBwidth\fR () const" +.br +.ti -1c +.BI "void \fBsetWidth\fR ( uint w )" +.br +.ti -1c +.BI "const QColor & \fBcolor\fR () const" +.br +.ti -1c +.BI "void \fBsetColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "PenCapStyle \fBcapStyle\fR () const" +.br +.ti -1c +.BI "void \fBsetCapStyle\fR ( PenCapStyle c )" +.br +.ti -1c +.BI "PenJoinStyle \fBjoinStyle\fR () const" +.br +.ti -1c +.BI "void \fBsetJoinStyle\fR ( PenJoinStyle j )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QPen & p ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QPen & p ) const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPen & p )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPen & p )" +.br +.in -1c +.SH DESCRIPTION +The QPen class defines how a QPainter should draw lines and outlines of shapes. +.PP +A pen has a style, width, color, cap style and join style. +.PP +The pen style defines the line type. The default pen style is Qt::SolidLine. Setting the style to NoPen tells the painter to not draw lines or outlines. +.PP +When drawing 1 pixel wide diagonal lines you can either use a very fast algorithm (specified by a line width of 0, which is the default), or a slower but more accurate algorithm (specified by a line width of 1). For horizontal and vertical lines a line width of 0 is the same as a line width of 1. The cap and join style have no effect on 0-width lines. +.PP +The pen color defines the color of lines and text. The default line color is black. The QColor documentation lists predefined colors. +.PP +The cap style defines how the end points of lines are drawn. The join style defines how the joins between two lines are drawn when multiple connected lines are drawn (QPainter::drawPolyline() etc.). The cap and join styles only apply to wide lines, i.e. when the width is 1 or greater. +.PP +Use the QBrush class to specify fill styles. +.PP +Example: +.PP +.nf +.br + QPainter painter; +.br + QPen pen( red, 2 ); // red solid line, 2 pixels wide +.br + painter.begin( &anyPaintDevice ); // paint something +.br + painter.setPen( pen ); // set the red, wide pen +.br + painter.drawRect( 40,30, 200,100 ); // draw a rectangle +.br + painter.setPen( blue ); // set blue pen, 0 pixel width +.br + painter.drawLine( 40,30, 240,130 ); // draw a diagonal in rectangle +.br + painter.end(); // painting done +.br +.fi +.PP +See the Qt::PenStyle enum type for a complete list of pen styles. +.PP +With reference to the end points of lines, for wide (non-0-width) pens it depends on the cap style whether the end point is drawn or not. QPainter will try to make sure that the end point is drawn for 0-width pens, but this cannot be absolutely guaranteed because the underlying drawing engine is free to use any (typically accelerated) algorithm for drawing 0-width lines. On all tested systems, however, the end point of at least all non-diagonal lines are drawn. +.PP +A pen's color(), width(), style(), capStyle() and joinStyle() can be set in the constructor or later with setColor(), setWidth(), setStyle(), setCapStyle() and setJoinStyle(). Pens may also be compared and streamed. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QPainter, QPainter::setPen(), Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPen::QPen ()" +Constructs a default black solid line pen with 0 width, which renders lines 1 pixel wide (fast diagonals). +.SH "QPen::QPen ( PenStyle style )" +Constructs a black pen with 0 width (fast diagonals) and style \fIstyle\fR. +.PP +See also setStyle(). +.SH "QPen::QPen ( const QColor & color, uint width = 0, PenStyle style = SolidLine )" +Constructs a pen with the specified \fIcolor\fR, \fIwidth\fR and \fIstyle\fR. +.PP +See also setWidth(), setStyle(), and setColor(). +.SH "QPen::QPen ( const QColor & cl, uint w, PenStyle s, PenCapStyle c, PenJoinStyle j )" +Constructs a pen with the specified color \fIcl\fR and width \fIw\fR. The pen style is set to \fIs\fR, the pen cap style to \fIc\fR and the pen join style to \fIj\fR. +.PP +A line width of 0 will produce a 1 pixel wide line using a fast algorithm for diagonals. A line width of 1 will also produce a 1 pixel wide line, but uses a slower more accurate algorithm for diagonals. For horizontal and vertical lines a line width of 0 is the same as a line width of 1. The cap and join style have no effect on 0-width lines. +.PP +See also setWidth(), setStyle(), and setColor(). +.SH "QPen::QPen ( const QPen & p )" +Constructs a pen that is a copy of \fIp\fR. +.SH "QPen::~QPen ()" +Destroys the pen. +.SH "PenCapStyle QPen::capStyle () const" +Returns the pen's cap style. +.PP +See also setCapStyle(). +.SH "const QColor & QPen::color () const" +Returns the pen color. +.PP +See also setColor(). +.PP +Example: scribble/scribble.h. +.SH "PenJoinStyle QPen::joinStyle () const" +Returns the pen's join style. +.PP +See also setJoinStyle(). +.SH "bool QPen::operator!= ( const QPen & p ) const" +Returns TRUE if the pen is different from \fIp\fR; otherwise returns FALSE. +.PP +Two pens are different if they have different styles, widths or colors. +.PP +See also operator==(). +.SH "QPen & QPen::operator= ( const QPen & p )" +Assigns \fIp\fR to this pen and returns a reference to this pen. +.SH "bool QPen::operator== ( const QPen & p ) const" +Returns TRUE if the pen is equal to \fIp\fR; otherwise returns FALSE. +.PP +Two pens are equal if they have equal styles, widths and colors. +.PP +See also operator!=(). +.SH "void QPen::setCapStyle ( PenCapStyle c )" +Sets the pen's cap style to \fIc\fR. +.PP +The default value is FlatCap. The cap style has no effect on 0-width pens. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +\fBWarning:\fR On Windows 95/98 and Macintosh, the cap style setting has no effect. Wide lines are rendered as if the cap style was SquareCap. +.PP +See also capStyle(). +.PP +Example: themes/wood.cpp. +.SH "void QPen::setColor ( const QColor & c )" +Sets the pen color to \fIc\fR. +.PP +See also color(). +.PP +Examples: +.)l progress/progress.cpp and scribble/scribble.h. +.SH "void QPen::setJoinStyle ( PenJoinStyle j )" +Sets the pen's join style to \fIj\fR. +.PP +The default value is MiterJoin. The join style has no effect on 0-width pens. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +\fBWarning:\fR On Windows 95/98 and Macintosh, the join style setting has no effect. Wide lines are rendered as if the join style was BevelJoin. +.PP +See also joinStyle(). +.PP +Example: themes/wood.cpp. +.SH "void QPen::setStyle ( PenStyle s )" +Sets the pen style to \fIs\fR. +.PP +See the Qt::PenStyle documentation for a list of all the styles. +.PP +\fBWarning:\fR On Mac OS X the style setting (other than NoPen and SolidLine) have no effect as they are not implemented by the underlying system. +.PP +\fBWarning:\fR On Windows 95/98, the style setting (other than NoPen and SolidLine) has no effect for lines with width greater than 1. +.PP +See also style(). +.PP +Example: chart/chartform_canvas.cpp. +.SH "void QPen::setWidth ( uint w )" +Sets the pen width to \fIw\fR. +.PP +A line width of 0 will produce a 1 pixel wide line using a fast algorithm for diagonals. A line width of 1 will also produce a 1 pixel wide line, but uses a slower more accurate algorithm for diagonals. For horizontal and vertical lines a line width of 0 is the same as a line width of 1. The cap and join style have no effect on 0-width lines. +.PP +See also width(). +.PP +Examples: +.)l multiple/ax2.h, progress/progress.cpp, and scribble/scribble.h. +.SH "PenStyle QPen::style () const" +Returns the pen style. +.PP +See also setStyle(). +.SH "uint QPen::width () const" +Returns the pen width. +.PP +See also setWidth(). +.PP +Example: scribble/scribble.h. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QPen & p )" +Writes the pen \fIp\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QPen & p )" +Reads a pen from the stream \fIs\fR into \fIp\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpen.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpen.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpicture.3qt b/doc/man/man3/tqpicture.3qt new file mode 100644 index 000000000..0b885f6c0 --- /dev/null +++ b/doc/man/man3/tqpicture.3qt @@ -0,0 +1,255 @@ +'\" t +.TH QPicture 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 +QPicture \- Paint device that records and replays QPainter commands +.SH SYNOPSIS +\fC#include <ntqpicture.h>\fR +.PP +Inherits QPaintDevice. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPicture\fR ( int formatVersion = -1 )" +.br +.ti -1c +.BI "\fBQPicture\fR ( const QPicture & pic )" +.br +.ti -1c +.BI "\fB~QPicture\fR ()" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "const char * \fBdata\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetData\fR ( const char * data, uint size )" +.br +.ti -1c +.BI "bool \fBplay\fR ( QPainter * painter )" +.br +.ti -1c +.BI "bool \fBload\fR ( QIODevice * dev, const char * format = 0 )" +.br +.ti -1c +.BI "bool \fBload\fR ( const QString & fileName, const char * format = 0 )" +.br +.ti -1c +.BI "bool \fBsave\fR ( QIODevice * dev, const char * format = 0 )" +.br +.ti -1c +.BI "bool \fBsave\fR ( const QString & fileName, const char * format = 0 )" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR () const" +.br +.ti -1c +.BI "void \fBsetBoundingRect\fR ( const QRect & r )" +.br +.ti -1c +.BI "QPicture & \fBoperator=\fR ( const QPicture & p )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual int \fBmetric\fR ( int m ) const" +.br +.ti -1c +.BI "void \fBdetach\fR ()" +.br +.ti -1c +.BI "QPicture \fBcopy\fR () const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPicture & r )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPicture & r )" +.br +.in -1c +.SH DESCRIPTION +The QPicture class is a paint device that records and replays QPainter commands. +.PP +A picture serializes painter commands to an IO device in a platform-independent format. For example, a picture created under Windows can be read on a Sun SPARC. +.PP +Pictures are called meta-files on some platforms. +.PP +Qt pictures use a proprietary binary format. Unlike native picture (meta-file) formats on many window systems, Qt pictures have no limitations regarding their contents. Everything that can be painted can also be stored in a picture, e.g. fonts, pixmaps, regions, transformed graphics, etc. +.PP +QPicture is an implicitly shared class. +.PP +Example of how to record a picture: +.PP +.nf +.br + QPicture pic; +.br + QPainter p; +.br + p.begin( &pic ); // paint in picture +.br + p.drawEllipse( 10,20, 80,70 ); // draw an ellipse +.br + p.end(); // painting done +.br + pic.save( "drawing.pic" ); // save picture +.br +.fi +.PP +Example of how to replay a picture: +.PP +.nf +.br + QPicture pic; +.br + pic.load( "drawing.pic" ); // load picture +.br + QPainter p; +.br + p.begin( &myWidget ); // paint in myWidget +.br + p.drawPicture( pic ); // draw the picture +.br + p.end(); // painting done +.br +.fi +.PP +Pictures can also be drawn using play(). Some basic data about a picture is available, for example, size(), isNull() and boundingRect(). +.PP +See also Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPicture::QPicture ( int formatVersion = -1 )" +Constructs an empty picture. +.PP +The \fIformatVersion\fR parameter may be used to \fIcreate\fR a QPicture that can be read by applications that are compiled with earlier versions of Qt. +.TP +\fIformatVersion\fR == 1 is binary compatible with Qt 1.x and later. +.TP +\fIformatVersion\fR == 2 is binary compatible with Qt 2.0.x and later. +.TP +\fIformatVersion\fR == 3 is binary compatible with Qt 2.1.x and later. +.TP +\fIformatVersion\fR == 4 is binary compatible with Qt 3.0.x and later. +.TP +\fIformatVersion\fR == 5 is binary compatible with Qt 3.1. +.PP +Note that the default formatVersion is -1 which signifies the current release, i.e. for Qt 3.1 a formatVersion of 5 is the same as the default formatVersion of -1. +.PP +Reading pictures generated by earlier versions of Qt is supported and needs no special coding; the format is automatically detected. +.SH "QPicture::QPicture ( const QPicture & pic )" +Constructs a shallow copy of \fIpic\fR. +.SH "QPicture::~QPicture ()" +Destroys the picture. +.SH "QRect QPicture::boundingRect () const" +Returns the picture's bounding rectangle or an invalid rectangle if the picture contains no data. +.SH "QPicture QPicture::copy () const\fC [protected]\fR" +Returns a deep copy of the picture. +.SH "const char * QPicture::data () const" +Returns a pointer to the picture data. The pointer is only valid until the next non-const function is called on this picture. The returned pointer is 0 if the picture contains no data. +.PP +See also size() and isNull(). +.SH "void QPicture::detach ()\fC [protected]\fR" +Detaches from shared picture data and makes sure that this picture is the only one referring to the data. +.PP +If multiple pictures share common data, this picture makes a copy of the data and detaches itself from the sharing mechanism. Nothing is done if there is just a single reference. +.SH "bool QPicture::isNull () const" +Returns TRUE if the picture contains no data; otherwise returns FALSE. +.SH "bool QPicture::load ( const QString & fileName, const char * format = 0 )" +Loads a picture from the file specified by \fIfileName\fR and returns TRUE if successful; otherwise returns FALSE. +.PP +By default, the file will be interpreted as being in the native QPicture format. Specifying the \fIformat\fR string is optional and is only needed for importing picture data stored in a different format. +.PP +Currently, the only external format supported is the W3C SVG format which requires the Qt XML module. The corresponding \fIformat\fR string is "svg". +.PP +See also save(). +.PP +Examples: +.)l picture/picture.cpp and xform/xform.cpp. +.SH "bool QPicture::load ( QIODevice * dev, const char * format = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIdev\fR is the device to use for loading. +.SH "int QPicture::metric ( int m ) const\fC [virtual protected]\fR" +Internal implementation of the virtual QPaintDevice::metric() function. +.PP +Use the QPaintDeviceMetrics class instead. +.PP +A picture has the following hard-coded values: dpi=72, numcolors=16777216 and depth=24. +.PP +\fIm\fR is the metric to get. +.SH "QPicture & QPicture::operator= ( const QPicture & p )" +Assigns a shallow copy of \fIp\fR to this picture and returns a reference to this picture. +.SH "bool QPicture::play ( QPainter * painter )" +Replays the picture using \fIpainter\fR, and returns TRUE if successful; otherwise returns FALSE. +.PP +This function does exactly the same as QPainter::drawPicture() with (x, y) = (0, 0). +.SH "bool QPicture::save ( const QString & fileName, const char * format = 0 )" +Saves a picture to the file specified by \fIfileName\fR and returns TRUE if successful; otherwise returns FALSE. +.PP +Specifying the file \fIformat\fR string is optional. It's not recommended unless you intend to export the picture data for use by a third party reader. By default the data will be saved in the native QPicture file format. +.PP +Currently, the only external format supported is the W3C SVG format which requires the Qt XML module. The corresponding \fIformat\fR string is "svg". +.PP +See also load(). +.PP +Example: picture/picture.cpp. +.SH "bool QPicture::save ( QIODevice * dev, const char * format = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIdev\fR is the device to use for saving. +.SH "void QPicture::setBoundingRect ( const QRect & r )" +Sets the picture's bounding rectangle to \fIr\fR. The automatically calculated value is overriden. +.SH "void QPicture::setData ( const char * data, uint size )\fC [virtual]\fR" +Sets the picture data directly from \fIdata\fR and \fIsize\fR. This function copies the input data. +.PP +See also data() and size(). +.SH "uint QPicture::size () const" +Returns the size of the picture data. +.PP +See also data(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QPicture & r )" +Writes picture \fIr\fR to the stream \fIs\fR and returns a reference to the stream. +.SH "QDataStream & operator>> ( QDataStream & s, QPicture & r )" +Reads a picture from the stream \fIs\fR into picture \fIr\fR and returns +a reference to the stream. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpicture.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpicture.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpixmap.3qt b/doc/man/man3/tqpixmap.3qt new file mode 100644 index 000000000..56c2a1b4e --- /dev/null +++ b/doc/man/man3/tqpixmap.3qt @@ -0,0 +1,788 @@ +'\" t +.TH QPixmap 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 +QPixmap \- Off-screen, pixel-based paint device +.SH SYNOPSIS +\fC#include <ntqpixmap.h>\fR +.PP +Inherits QPaintDevice and Qt. +.PP +Inherited by QBitmap and QCanvasPixmap. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBColorMode\fR { Auto, Color, Mono }" +.br +.ti -1c +.BI "enum \fBOptimization\fR { DefaultOptim, NoOptim, MemoryOptim = NoOptim, NormalOptim, BestOptim }" +.br +.ti -1c +.BI "\fBQPixmap\fR ()" +.br +.ti -1c +.BI "\fBQPixmap\fR ( const QImage & image )" +.br +.ti -1c +.BI "\fBQPixmap\fR ( int w, int h, int depth = -1, Optimization optimization = DefaultOptim )" +.br +.ti -1c +.BI "\fBQPixmap\fR ( const QSize & size, int depth = -1, Optimization optimization = DefaultOptim )" +.br +.ti -1c +.BI "\fBQPixmap\fR ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" +.br +.ti -1c +.BI "\fBQPixmap\fR ( const QString & fileName, const char * format, int conversion_flags )" +.br +.ti -1c +.BI "\fBQPixmap\fR ( const char * xpm[] )" +.br +.ti -1c +.BI "\fBQPixmap\fR ( const QByteArray & img_data )" +.br +.ti -1c +.BI "\fBQPixmap\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "\fB~QPixmap\fR ()" +.br +.ti -1c +.BI "QPixmap & \fBoperator=\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "QPixmap & \fBoperator=\fR ( const QImage & image )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "int \fBdepth\fR () const" +.br +.ti -1c +.BI "void \fBfill\fR ( const QColor & fillColor = Qt::white )" +.br +.ti -1c +.BI "void \fBfill\fR ( const QWidget * widget, int xofs, int yofs )" +.br +.ti -1c +.BI "void \fBfill\fR ( const QWidget * widget, const QPoint & ofs )" +.br +.ti -1c +.BI "void \fBresize\fR ( int w, int h )" +.br +.ti -1c +.BI "void \fBresize\fR ( const QSize & size )" +.br +.ti -1c +.BI "const QBitmap * \fBmask\fR () const" +.br +.ti -1c +.BI "void \fBsetMask\fR ( const QBitmap & newmask )" +.br +.ti -1c +.BI "bool \fBselfMask\fR () const" +.br +.ti -1c +.BI "bool \fBhasAlpha\fR () const" +.br +.ti -1c +.BI "bool \fBhasAlphaChannel\fR () const" +.br +.ti -1c +.BI "QBitmap \fBcreateHeuristicMask\fR ( bool clipTight = TRUE ) const" +.br +.ti -1c +.BI "QPixmap \fBxForm\fR ( const QWMatrix & matrix ) const" +.br +.ti -1c +.BI "QImage \fBconvertToImage\fR () const" +.br +.ti -1c +.BI "bool \fBconvertFromImage\fR ( const QImage & image, ColorMode mode = Auto )" +.br +.ti -1c +.BI "bool \fBconvertFromImage\fR ( const QImage & img, int conversion_flags )" +.br +.ti -1c +.BI "bool \fBload\fR ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" +.br +.ti -1c +.BI "bool \fBload\fR ( const QString & fileName, const char * format, int conversion_flags )" +.br +.ti -1c +.BI "bool \fBloadFromData\fR ( const uchar * buf, uint len, const char * format = 0, ColorMode mode = Auto )" +.br +.ti -1c +.BI "bool \fBloadFromData\fR ( const uchar * buf, uint len, const char * format, int conversion_flags )" +.br +.ti -1c +.BI "bool \fBloadFromData\fR ( const QByteArray & buf, const char * format = 0, int conversion_flags = 0 )" +.br +.ti -1c +.BI "bool \fBsave\fR ( const QString & fileName, const char * format, int quality = -1 ) const" +.br +.ti -1c +.BI "bool \fBsave\fR ( QIODevice * device, const char * format, int quality = -1 ) const" +.br +.ti -1c +.BI "int \fBserialNumber\fR () const" +.br +.ti -1c +.BI "Optimization \fBoptimization\fR () const" +.br +.ti -1c +.BI "void \fBsetOptimization\fR ( Optimization optimization )" +.br +.ti -1c +.BI "virtual void \fBdetach\fR ()" +.br +.ti -1c +.BI "bool \fBisQBitmap\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "int \fBdefaultDepth\fR ()" +.br +.ti -1c +.BI "QPixmap \fBfromMimeSource\fR ( const QString & abs_name )" +.br +.ti -1c +.BI "QPixmap \fBgrabWindow\fR ( WId window, int x = 0, int y = 0, int w = -1, int h = -1 )" +.br +.ti -1c +.BI "QPixmap \fBgrabWidget\fR ( QWidget * widget, int x = 0, int y = 0, int w = -1, int h = -1 )" +.br +.ti -1c +.BI "QWMatrix \fBtrueMatrix\fR ( const QWMatrix & matrix, int w, int h )" +.br +.ti -1c +.BI "const char * \fBimageFormat\fR ( const QString & fileName )" +.br +.ti -1c +.BI "Optimization \fBdefaultOptimization\fR ()" +.br +.ti -1c +.BI "void \fBsetDefaultOptimization\fR ( Optimization optimization )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQPixmap\fR ( int w, int h, const uchar * bits, bool isXbitmap )" +.br +.ti -1c +.BI "virtual int \fBmetric\fR ( int m ) const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPixmap & pixmap )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPixmap & pixmap )" +.br +.ti -1c +.BI "void \fBcopyBlt\fR ( QPixmap * dst, int dx, int dy, const QPixmap * src, int sx, int sy, int sw, int sh )" +.br +.in -1c +.SH DESCRIPTION +The QPixmap class is an off-screen, pixel-based paint device. +.PP +QPixmap is one of the two classes Qt provides for dealing with images; the other is QImage. QPixmap is designed and optimized for drawing; QImage is designed and optimized for I/O and for direct pixel access/manipulation. There are (slow) functions to convert between QImage and QPixmap: convertToImage() and convertFromImage(). +.PP +One common use of the QPixmap class is to enable smooth updating of widgets. Whenever something complex needs to be drawn, you can use a pixmap to obtain flicker-free drawing, like this: +.PP +<ol type=1> +.IP 1 +Create a pixmap with the same size as the widget. +.IP 2 +Fill the pixmap with the widget background color. +.IP 3 +Paint the pixmap. +.IP 4 +bitBlt() the pixmap contents onto the widget. +.PP +Pixel data in a pixmap is internal and is managed by the underlying window system. Pixels can be accessed only through QPainter functions, through bitBlt(), and by converting the QPixmap to a QImage. +.PP +You can easily display a QPixmap on the screen using QLabel::setPixmap(). For example, all the QButton subclasses support pixmap use. +.PP +The QPixmap class uses copy-on-write, so it is practical to pass QPixmap objects by value. +.PP +You can retrieve the width(), height(), depth() and size() of a pixmap. The enclosing rectangle is given by rect(). Pixmaps can be filled with fill() and resized with resize(). You can create and set a mask with createHeuristicMask() and setMask(). Use selfMask() to see if the pixmap is identical to its mask. +.PP +In addition to loading a pixmap from file using load() you can also loadFromData(). You can control optimization with setOptimization() and obtain a transformed version of the pixmap using xForm() +.PP +Note regarding Windows 95 and 98: on Windows 9x the system crashes if you create more than about 1000 pixmaps, independent of the size of the pixmaps or installed RAM. Windows NT-systems (including 2000, XP and following versions) do not have the same limitation, but depending on the graphics equipment the system will fail to allocate pixmap objects at some point (due to system running out of GDI resources). +.PP +Qt tries to work around the resource limitation. If you set the pixmap optimization to QPixmap::MemoryOptim and the width of your pixmap is less than or equal to 128 pixels, Qt stores the pixmap in a way that is very memory-efficient when there are many pixmaps. +.PP +If your application uses dozens or hundreds of pixmaps (for example on tool bar buttons and in popup menus), and you plan to run it on Windows 95 or Windows 98, we recommend using code like this: +.PP +.nf +.br + QPixmap::setDefaultOptimization( QPixmap::MemoryOptim ); +.br + while ( ... ) { +.br + // load tool bar pixmaps etc. +.br + QPixmap *pixmap = new QPixmap(fileName); +.br + } +.br + QPixmap::setDefaultOptimization( QPixmap::NormalOptim ); +.br +.fi +.PP +In general it is recommended to make as much use of QPixmap's implicit sharing and the QPixmapCache as possible. +.PP +See also QBitmap, QImage, QImageIO, Shared Classes, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SS "Member Type Documentation" +.SH "QPixmap::ColorMode" +This enum type defines the color modes that exist for converting QImage objects to QPixmap. +.TP +\fCQPixmap::Auto\fR - Select Color or Mono on a case-by-case basis. +.TP +\fCQPixmap::Color\fR - Always create colored pixmaps. +.TP +\fCQPixmap::Mono\fR - Always create bitmaps. +.SH "QPixmap::Optimization" +QPixmap has the choice of optimizing for speed or memory in a few places; the best choice varies from pixmap to pixmap but can generally be derived heuristically. This enum type defines a number of optimization modes that you can set for any pixmap to tweak the speed/memory tradeoffs: +.TP +\fCQPixmap::DefaultOptim\fR - Whatever QPixmap::defaultOptimization() returns. A pixmap with this optimization will have whatever the current default optimization is. If the default optimization is changed using setDefaultOptimization(), then this will not effect any pixmaps that have already been created. +.TP +\fCQPixmap::NoOptim\fR - No optimization (currently the same as MemoryOptim). +.TP +\fCQPixmap::MemoryOptim\fR - Optimize for minimal memory use on Windows 9x and X11 systems. +.TP +\fCQPixmap::NormalOptim\fR - Optimize for typical usage. Often uses more memory than MemoryOptim, and is often faster. +.TP +\fCQPixmap::BestOptim\fR - Optimize for pixmaps that are drawn very often and where performance is critical. Generally uses more memory than NormalOptim and may provide a little more speed. +.PP +We recommend using DefaultOptim. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPixmap::QPixmap ()" +Constructs a null pixmap. +.PP +See also isNull(). +.SH "QPixmap::QPixmap ( const QImage & image )" +Constructs a pixmap from the QImage \fIimage\fR. +.PP +See also convertFromImage(). +.SH "QPixmap::QPixmap ( int w, int h, int depth = -1, Optimization optimization = DefaultOptim )" +Constructs a pixmap with \fIw\fR width, \fIh\fR height and \fIdepth\fR bits per pixel. The pixmap is optimized in accordance with the \fIoptimization\fR value. +.PP +The contents of the pixmap is uninitialized. +.PP +The \fIdepth\fR can be either 1 (monochrome) or the depth of the current video mode. If \fIdepth\fR is negative, then the hardware depth of the current video mode will be used. +.PP +If either \fIw\fR or \fIh\fR is zero, a null pixmap is constructed. +.PP +See also isNull() and QPixmap::Optimization. +.SH "QPixmap::QPixmap ( const QSize & size, int depth = -1, Optimization optimization = DefaultOptim )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a pixmap of size \fIsize\fR, \fIdepth\fR bits per pixel, optimized in accordance with the \fIoptimization\fR value. +.SH "QPixmap::QPixmap ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" +Constructs a pixmap from the file \fIfileName\fR. If the file does not exist or is of an unknown format, the pixmap becomes a null pixmap. +.PP +The \fIfileName\fR, \fIformat\fR and \fImode\fR parameters are passed on to load(). This means that the data in \fIfileName\fR is not compiled into the binary. If \fIfileName\fR contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory. +.PP +See also QPixmap::ColorMode, isNull(), load(), loadFromData(), save(), and imageFormat(). +.SH "QPixmap::QPixmap ( const QString & fileName, const char * format, int conversion_flags )" +Constructs a pixmap from the file \fIfileName\fR. If the file does not exist or is of an unknown format, the pixmap becomes a null pixmap. +.PP +The \fIfileName\fR, \fIformat\fR and \fIconversion_flags\fR parameters are passed on to load(). This means that the data in \fIfileName\fR is not compiled into the binary. If \fIfileName\fR contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory. +.PP +If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversion_flags\fR to specify how you'd prefer this to happen. +.PP +See also Qt::ImageConversionFlags, isNull(), load(), loadFromData(), save(), and imageFormat(). +.SH "QPixmap::QPixmap ( const char * xpm[] )" +Constructs a pixmap from \fIxpm\fR, which must be a valid XPM image. +.PP +Errors are silently ignored. +.PP +Note that it's possible to squeeze the XPM variable a little bit by using an unusual declaration: +.PP +.nf +.br + static const char * const start_xpm[]={ +.br + "16 15 8 1", +.br + "a c #cec6bd", +.br + .... +.br +.fi +.PP +The extra \fCconst\fR makes the entire definition read-only, which is slightly more efficient (for example, when the code is in a shared library) and ROMable when the application is to be stored in ROM. +.PP +In order to use that sort of declaration you must cast the variable back to \fCconst char **\fR when you create the QPixmap. +.SH "QPixmap::QPixmap ( const QByteArray & img_data )" +Constructs a pixmaps by loading from \fIimg_data\fR. The data can be in any image format supported by Qt. +.PP +See also loadFromData(). +.SH "QPixmap::QPixmap ( const QPixmap & pixmap )" +Constructs a pixmap that is a copy of \fIpixmap\fR. +.SH "QPixmap::QPixmap ( int w, int h, const uchar * bits, bool isXbitmap )\fC [protected]\fR" +Constructs a monochrome pixmap, with width \fIw\fR and height \fIh\fR, that is initialized with the data in \fIbits\fR. The \fIisXbitmap\fR indicates whether the data is an X bitmap and defaults to FALSE. This constructor is protected and used by the QBitmap class. +.SH "QPixmap::~QPixmap ()" +Destroys the pixmap. +.SH "bool QPixmap::convertFromImage ( const QImage & img, int conversion_flags )" +Converts image \fIimg\fR and sets this pixmap. Returns TRUE if successful; otherwise returns FALSE. +.PP +The \fIconversion_flags\fR argument is a bitwise-OR of the Qt::ImageConversionFlags. Passing 0 for \fIconversion_flags\fR sets all the default options. +.PP +Note that even though a QPixmap with depth 1 behaves much like a QBitmap, isQBitmap() returns FALSE. +.PP +If a pixmap with depth 1 is painted with color0 and color1 and converted to an image, the pixels painted with color0 will produce pixel index 0 in the image and those painted with color1 will produce pixel index 1. +.PP +See also convertToImage(), isQBitmap(), QImage::convertDepth(), defaultDepth(), and QImage::hasAlphaBuffer(). +.PP +Examples: +.)l canvas/canvas.cpp and themes/wood.cpp. +.SH "bool QPixmap::convertFromImage ( const QImage & image, ColorMode mode = Auto )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Converts \fIimage\fR and sets this pixmap using color mode \fImode\fR. Returns TRUE if successful; otherwise returns FALSE. +.PP +See also QPixmap::ColorMode. +.SH "QImage QPixmap::convertToImage () const" +Converts the pixmap to a QImage. Returns a null image if it fails. +.PP +If the pixmap has 1-bit depth, the returned image will also be 1 bit deep. If the pixmap has 2- to 8-bit depth, the returned image has 8-bit depth. If the pixmap has greater than 8-bit depth, the returned image has 32-bit depth. +.PP +Note that for the moment, alpha masks on monochrome images are ignored. +.PP +See also convertFromImage(). +.PP +Example: qmag/qmag.cpp. +.SH "QBitmap QPixmap::createHeuristicMask ( bool clipTight = TRUE ) const" +Creates and returns a heuristic mask for this pixmap. It works by selecting a color from one of the corners and then chipping away pixels of that color, starting at all the edges. +.PP +The mask may not be perfect but it should be reasonable, so you can do things such as the following: +.PP +.nf +.br + pm->setMask( pm->createHeuristicMask() ); +.br +.fi +.PP +This function is slow because it involves transformation to a QImage, non-trivial computations and a transformation back to a QBitmap. +.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. +.PP +See also QImage::createHeuristicMask(). +.SH "int QPixmap::defaultDepth ()\fC [static]\fR" +Returns the default pixmap depth, i.e. the depth a pixmap gets if -1 is specified. +.PP +See also depth(). +.SH "Optimization QPixmap::defaultOptimization ()\fC [static]\fR" +Returns the default pixmap optimization setting. +.PP +See also setDefaultOptimization(), setOptimization(), and optimization(). +.SH "int QPixmap::depth () const" +Returns the depth of the pixmap. +.PP +The pixmap depth is also called bits per pixel (bpp) or bit planes of a pixmap. A null pixmap has depth 0. +.PP +See also defaultDepth(), isNull(), and QImage::convertDepth(). +.SH "void QPixmap::detach ()\fC [virtual]\fR" +This is a special-purpose function that detaches the pixmap from shared pixmap data. +.PP +A pixmap is automatically detached by Qt whenever its contents is about to change. This is done in all QPixmap member functions that modify the pixmap (fill(), resize(), convertFromImage(), load(), etc.), in bitBlt() for the destination pixmap and in QPainter::begin() on a pixmap. +.PP +It is possible to modify a pixmap without letting Qt know. You can first obtain the system-dependent handle() and then call system-specific functions (for instance, BitBlt under Windows) that modify the pixmap contents. In such cases, you can call detach() to cut the pixmap loose from other pixmaps that share data with this one. +.PP +detach() returns immediately if there is just a single reference or if the pixmap has not been initialized yet. +.SH "void QPixmap::fill ( const QColor & fillColor = Qt::white )" +Fills the pixmap with the color \fIfillColor\fR. +.PP +Examples: +.)l chart/setdataform.cpp, desktop/desktop.cpp, grapher/grapher.cpp, hello/hello.cpp, t10/cannon.cpp, themes/metal.cpp, and xform/xform.cpp. +.SH "void QPixmap::fill ( const QWidget * widget, int xofs, int yofs )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Fills the pixmap with the \fIwidget\fR's background color or pixmap. If the background is empty, nothing is done. \fIxofs\fR, \fIyofs\fR is an offset in the widget. +.SH "void QPixmap::fill ( const QWidget * widget, const QPoint & ofs )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Fills the pixmap with the \fIwidget\fR's background color or pixmap. If the background is empty, nothing is done. +.PP +The \fIofs\fR point is an offset in the widget. +.PP +The point \fIofs\fR is a point in the widget's coordinate system. The pixmap's top-left pixel will be mapped to the point \fIofs\fR in the widget. This is significant if the widget has a background pixmap; otherwise the pixmap will simply be filled with the background color of the widget. +.PP +Example: +.PP +.nf +.br + void CuteWidget::paintEvent( QPaintEvent *e ) +.br + { +.br + QRect ur = e->rect(); // rectangle to update +.br + QPixmap pix( ur.size() ); // Pixmap for double-buffering +.br + pix.fill( this, ur.topLeft() ); // fill with widget background +.br +.br + QPainter p( &pix ); +.br + p.translate( -ur.x(), -ur.y() ); // use widget coordinate system +.br + // when drawing on pixmap +.br + // ... draw on pixmap ... +.br +.br + p.end(); +.br +.br + bitBlt( this, ur.topLeft(), &pix ); +.br + } +.br +.fi +.SH "QPixmap QPixmap::fromMimeSource ( const QString & abs_name )\fC [static]\fR" +Convenience function. Gets the data associated with the absolute name \fIabs_name\fR from the default mime source factory and decodes it to a pixmap. +.PP +See also QMimeSourceFactory, QImage::fromMimeSource(), and QImageDrag::decode(). +.PP +Example: textedit/textedit.cpp. +.SH "QPixmap QPixmap::grabWidget ( QWidget * widget, int x = 0, int y = 0, int w = -1, int h = -1 )\fC [static]\fR" +Creates a pixmap and paints \fIwidget\fR in it. +.PP +If the \fIwidget\fR has any children, then they are also painted in the appropriate positions. +.PP +If you specify \fIx\fR, \fIy\fR, \fIw\fR or \fIh\fR, only the rectangle you specify is painted. The defaults are 0, 0 (top-left corner) and -1,-1 (which means the entire widget). +.PP +(If \fIw\fR is negative, the function copies everything to the right border of the window. If \fIh\fR is negative, the function copies everything to the bottom of the window.) +.PP +If \fIwidget\fR is 0, or if the rectangle defined by \fIx\fR, \fIy\fR, the modified \fIw\fR and the modified \fIh\fR does not overlap the \fIwidget\fR->rect(), this function will return a null QPixmap. +.PP +This function actually asks \fIwidget\fR to paint itself (and its children to paint themselves). QPixmap::grabWindow() grabs pixels off the screen, which is a bit faster and picks up \fIexactly\fR what's on-screen. This function works by calling paintEvent() with painter redirection turned on. If there are overlaying windows, grabWindow() will see them, but not this function. +.PP +If there is overlap, it returns a pixmap of the size you want, containing a rendering of \fIwidget\fR. If the rectangle you ask for is a superset of \fIwidget\fR, the areas outside \fIwidget\fR are covered with the widget's background. +.PP +If an error occurs when trying to grab the widget, such as the size of the widget being too large to fit in memory, an isNull() pixmap is returned. +.PP +See also grabWindow(), QPainter::redirect(), and QWidget::paintEvent(). +.SH "QPixmap QPixmap::grabWindow ( WId window, int x = 0, int y = 0, int w = -1, int h = -1 )\fC [static]\fR" +Grabs the contents of the window \fIwindow\fR and makes a pixmap out of it. Returns the pixmap. +.PP +The arguments \fI(x, y)\fR specify the offset in the window, whereas \fI(w, h)\fR specify the width and height of the area to be copied. +.PP +If \fIw\fR is negative, the function copies everything to the right border of the window. If \fIh\fR is negative, the function copies everything to the bottom of the window. +.PP +Note that grabWindow() grabs pixels from the screen, not from the window. If there is another window partially or entirely over the one you grab, you get pixels from the overlying window, too. +.PP +Note also that the mouse cursor is generally not grabbed. +.PP +The reason we use a window identifier and not a QWidget is to enable grabbing of windows that are not part of the application, window system frames, and so on. +.PP +\fBWarning:\fR Grabbing an area outside the screen is not safe in general. This depends on the underlying window system. +.PP +\fBWarning:\fR X11 only: If \fIwindow\fR is not the same depth as the root window and another window partially or entirely obscures the one you grab, you will \fInot\fR get pixels from the overlying window. The contests of the obscured areas in the pixmap are undefined and uninitialized. +.PP +See also grabWidget(). +.PP +Example: qmag/qmag.cpp. +.SH "bool QPixmap::hasAlpha () const" +Returns TRUE this pixmap has an alpha channel or a mask. +.PP +See also hasAlphaChannel() and mask(). +.SH "bool QPixmap::hasAlphaChannel () const" +Returns TRUE if the pixmap has an alpha channel; otherwise it returns FALSE. +.PP +NOTE: If the pixmap has a mask but not alpha channel, this function returns FALSE. +.PP +See also hasAlpha() and mask(). +.SH "int QPixmap::height () const" +Returns the height of the pixmap. +.PP +See also width(), size(), and rect(). +.PP +Examples: +.)l desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, scrollview/scrollview.cpp, t10/cannon.cpp, and xform/xform.cpp. +.SH "const char * QPixmap::imageFormat ( const QString & fileName )\fC [static]\fR" +Returns a string that specifies the image format of the file \fIfileName\fR, or 0 if the file cannot be read or if the format cannot be recognized. +.PP +The QImageIO documentation lists the supported image formats. +.PP +See also load() and save(). +.SH "bool QPixmap::isNull () const" +Returns TRUE if this is a null pixmap; otherwise returns FALSE. +.PP +A null pixmap has zero width, zero height and no contents. You cannot draw in a null pixmap or bitBlt() anything to it. +.PP +Resizing an existing pixmap to (0, 0) makes a pixmap into a null pixmap. +.PP +See also resize(). +.PP +Examples: +.)l movies/main.cpp, qdir/qdir.cpp, qmag/qmag.cpp, and scrollview/scrollview.cpp. +.SH "bool QPixmap::isQBitmap () const" +Returns TRUE if this is a QBitmap; otherwise returns FALSE. +.SH "bool QPixmap::load ( const QString & fileName, const char * format, int conversion_flags )" +Loads a pixmap from the file \fIfileName\fR at runtime. Returns TRUE if successful; otherwise returns FALSE. +.PP +If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. +.PP +See the convertFromImage() documentation for a description of the \fIconversion_flags\fR argument. +.PP +The QImageIO documentation lists the supported image formats and explains how to add extra formats. +.PP +See also loadFromData(), save(), imageFormat(), QImage::load(), and QImageIO. +.PP +Examples: +.)l picture/picture.cpp, scrollview/scrollview.cpp, and xform/xform.cpp. +.SH "bool QPixmap::load ( const QString & fileName, const char * format = 0, ColorMode mode = Auto )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Loads a pixmap from the file \fIfileName\fR at runtime. +.PP +If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. +.PP +The \fImode\fR is used to specify the color mode of the pixmap. +.PP +See also QPixmap::ColorMode. +.SH "bool QPixmap::loadFromData ( const uchar * buf, uint len, const char * format, int conversion_flags )" +Loads a pixmap from the binary data in \fIbuf\fR (\fIlen\fR bytes). Returns TRUE if successful; otherwise returns FALSE. +.PP +If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. +.PP +See the convertFromImage() documentation for a description of the \fIconversion_flags\fR argument. +.PP +The QImageIO documentation lists the supported image formats and explains how to add extra formats. +.PP +See also load(), save(), imageFormat(), QImage::loadFromData(), and QImageIO. +.SH "bool QPixmap::loadFromData ( const uchar * buf, uint len, const char * format = 0, ColorMode mode = Auto )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Loads a pixmap from the binary data in \fIbuf\fR (\fIlen\fR bytes) using color mode \fImode\fR. Returns TRUE if successful; otherwise returns FALSE. +.PP +If \fIformat\fR is specified, the loader attempts to read the pixmap using the specified format. If \fIformat\fR is not specified (default), the loader reads a few bytes from the header to guess the file's format. +.PP +See also QPixmap::ColorMode. +.SH "bool QPixmap::loadFromData ( const QByteArray & buf, const char * format = 0, int conversion_flags = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "const QBitmap * QPixmap::mask () const" +Returns the mask bitmap, or 0 if no mask has been set. +.PP +See also setMask(), QBitmap, and hasAlpha(). +.SH "int QPixmap::metric ( int m ) const\fC [virtual protected]\fR" +Internal implementation of the virtual QPaintDevice::metric() function. +.PP +Use the QPaintDeviceMetrics class instead. +.PP +\fIm\fR is the metric to get. +.SH "QPixmap & QPixmap::operator= ( const QPixmap & pixmap )" +Assigns the pixmap \fIpixmap\fR to this pixmap and returns a reference to this pixmap. +.SH "QPixmap & QPixmap::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 pixmap that is assigned to this pixmap. Returns a reference to the pixmap. +.PP +See also convertFromImage(). +.SH "Optimization QPixmap::optimization () const" +Returns the optimization setting for this pixmap. +.PP +The default optimization setting is QPixmap::NormalOptim. You can change this setting in two ways: +.TP +Call setDefaultOptimization() to set the default optimization for all new pixmaps. +.TP +Call setOptimization() to set the optimization for individual pixmaps. +.PP +See also setOptimization(), setDefaultOptimization(), and defaultOptimization(). +.SH "QRect QPixmap::rect () const" +Returns the enclosing rectangle (0,0,width(),height()) of the pixmap. +.PP +See also width(), height(), and size(). +.SH "void QPixmap::resize ( int w, int h )" +Resizes the pixmap to \fIw\fR width and \fIh\fR height. If either \fIw\fR or \fIh\fR is 0, the pixmap becomes a null pixmap. +.PP +If both \fIw\fR and \fIh\fR are greater than 0, a valid pixmap is created. New pixels will be uninitialized (random) if the pixmap is expanded. +.PP +Examples: +.)l desktop/desktop.cpp and grapher/grapher.cpp. +.SH "void QPixmap::resize ( const QSize & size )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Resizes the pixmap to size \fIsize\fR. +.SH "bool QPixmap::save ( const QString & fileName, const char * format, int quality = -1 ) const" +Saves the pixmap to the file \fIfileName\fR using the image file format \fIformat\fR and a quality factor \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 to use the default settings. Returns TRUE if successful; otherwise returns FALSE. +.PP +See also load(), loadFromData(), imageFormat(), QImage::save(), and QImageIO. +.PP +Example: qmag/qmag.cpp. +.SH "bool QPixmap::save ( QIODevice * device, const char * format, int quality = -1 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function writes a QPixmap to the QIODevice, \fIdevice\fR. This can be used, for example, to save a pixmap directly into a QByteArray: +.PP +.nf +.br + QPixmap pixmap; +.br + QByteArray ba; +.br + QBuffer buffer( ba ); +.br + buffer.open( IO_WriteOnly ); +.br + pixmap.save( &buffer, "PNG" ); // writes pixmap into ba in PNG format +.br +.fi +.SH "bool QPixmap::selfMask () const" +Returns TRUE if the pixmap's mask is identical to the pixmap itself; otherwise returns FALSE. +.PP +See also mask(). +.SH "int QPixmap::serialNumber () const" +Returns a number that uniquely identifies the contents of this QPixmap object. This means that multiple QPixmap objects can have the same serial number as long as they refer to the same contents. +.PP +An example of where this is useful is for caching QPixmaps. +.PP +See also QPixmapCache. +.SH "void QPixmap::setDefaultOptimization ( Optimization optimization )\fC [static]\fR" +Sets the default pixmap optimization. +.PP +All \fInew\fR pixmaps that are created will use this default optimization. You may also set optimization for individual pixmaps using the setOptimization() function. +.PP +The initial default \fIoptimization\fR setting is \fCQPixmap::Normal\fR. +.PP +See also defaultOptimization(), setOptimization(), and optimization(). +.SH "void QPixmap::setMask ( const QBitmap & newmask )" +Sets a mask bitmap. +.PP +The \fInewmask\fR bitmap defines the clip mask for this pixmap. Every pixel in \fInewmask\fR corresponds to a pixel in this pixmap. Pixel value 1 means opaque and pixel value 0 means transparent. The mask must have the same size as this pixmap. +.PP +\fBWarning:\fR Setting the mask on a pixmap will cause any alpha channel data to be cleared. For example: +.PP +.nf +.br + QPixmap alpha( "image-with-alpha.png" ); +.br + QPixmap alphacopy = alpha; +.br + alphacopy.setMask( *alphacopy.mask() ); +.br +.fi +Now, alpha and alphacopy are visually different. +.PP +Setting a null mask resets the mask. +.PP +See also mask(), createHeuristicMask(), and QBitmap. +.SH "void QPixmap::setOptimization ( Optimization optimization )" +Sets pixmap drawing optimization for this pixmap. +.PP +The \fIoptimization\fR setting affects pixmap operations, in particular drawing of transparent pixmaps (bitBlt() a pixmap with a mask set) and pixmap transformations (the xForm() function). +.PP +Pixmap optimization involves keeping intermediate results in a cache buffer and using the cache to speed up bitBlt() and xForm(). The cost is more memory consumption, up to twice as much as an unoptimized pixmap. +.PP +Use the setDefaultOptimization() to change the default optimization for all new pixmaps. +.PP +See also optimization(), setDefaultOptimization(), and defaultOptimization(). +.PP +Example: desktop/desktop.cpp. +.SH "QSize QPixmap::size () const" +Returns the size of the pixmap. +.PP +See also width(), height(), and rect(). +.PP +Example: movies/main.cpp. +.SH "QWMatrix QPixmap::trueMatrix ( const QWMatrix & matrix, int w, int h )\fC [static]\fR" +Returns the actual matrix used for transforming a pixmap with \fIw\fR width and \fIh\fR height and matrix \fImatrix\fR. +.PP +When transforming a pixmap with xForm(), the transformation matrix is internally adjusted to compensate for unwanted translation, i.e. xForm() returns the smallest pixmap containing all transformed points of the original pixmap. +.PP +This function returns the modified matrix, which maps points correctly from the original pixmap into the new pixmap. +.PP +See also xForm() and QWMatrix. +.SH "int QPixmap::width () const" +Returns the width of the pixmap. +.PP +See also height(), size(), and rect(). +.PP +Examples: +.)l desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, scrollview/scrollview.cpp, and xform/xform.cpp. +.SH "QPixmap QPixmap::xForm ( const QWMatrix & matrix ) const" +Returns a copy of the pixmap that is transformed using \fImatrix\fR. The original pixmap is not changed. +.PP +The transformation \fImatrix\fR is internally adjusted to compensate for unwanted translation, i.e. xForm() returns the smallest image that contains all the transformed points of the original image. +.PP +This function is slow because it involves transformation to a QImage, non-trivial computations and a transformation back to a QPixmap. +.PP +See also trueMatrix(), QWMatrix, QPainter::setWorldMatrix(), and QImage::xForm(). +.PP +Examples: +.)l desktop/desktop.cpp, fileiconview/qfileiconview.cpp, movies/main.cpp, and qmag/qmag.cpp. +.SH RELATED FUNCTION DOCUMENTATION +.SH "void copyBlt ( QPixmap * dst, int dx, int dy, const QPixmap * src, int sx, int sy, int sw, int sh )" +Copies a block of pixels from \fIsrc\fR to \fIdst\fR. The alpha channel and mask data (if any) is also copied from \fIsrc\fR. NOTE: \fIsrc\fR is \fInot\fR alpha blended or masked when copied to \fIdst\fR. Use bitBlt() or QPainter::drawPixmap() to perform alpha blending or masked drawing. +.PP +\fIsx\fR, \fIsy\fR is the top-left pixel in \fIsrc\fR (0, 0 by default), \fIdx\fR, \fIdy\fR is the top-left position in \fIdst\fR and \fIsw\fR, \\sh is the size of the copied block (all of \fIsrc\fR by default). +.PP +If \fIsrc\fR, \fIdst\fR, \fIsw\fR or \fIsh\fR is 0 (zero), copyBlt() does nothing. If \fIsw\fR or \fIsh\fR is negative, copyBlt() copies starting at \fIsx\fR (and respectively, \fIsy\fR) and ending at the right edge (and respectively, the bottom edge) of \fIsrc\fR. +.PP +copyBlt() does nothing if \fIsrc\fR and \fIdst\fR have different depths. +.SH "QDataStream & operator<< ( QDataStream & s, const QPixmap & pixmap )" +Writes the pixmap \fIpixmap\fR to the stream \fIs\fR as a PNG image. +.PP +Note that writing the stream to a file will not produce a valid image file. +.PP +See also QPixmap::save() and Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QPixmap & pixmap )" +Reads a pixmap from the stream \fIs\fR into the pixmap \fIpixmap\fR. +.PP +See also QPixmap::load() and Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpixmap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpixmap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpixmapcache.3qt b/doc/man/man3/tqpixmapcache.3qt new file mode 100644 index 000000000..74f5218cd --- /dev/null +++ b/doc/man/man3/tqpixmapcache.3qt @@ -0,0 +1,145 @@ +'\" t +.TH QPixmapCache 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 +QPixmapCache \- Application-global cache for pixmaps +.SH SYNOPSIS +\fC#include <ntqpixmapcache.h>\fR +.PP +.SS "Static Public Members" +<li class=fn>int \fBcacheLimit\fR () <li class=fn>void \fBsetCacheLimit\fR ( int n ) <li class=fn>QPixmap * \fBfind\fR ( const QString & key ) <li class=fn>bool \fBfind\fR ( const QString & key, QPixmap & pm ) <li class=fn>bool insert ( const QString & key, QPixmap * pm ) \fI(obsolete)\fR <li class=fn>bool \fBinsert\fR ( const QString & key, const QPixmap & pm ) <li class=fn>void \fBremove\fR ( const QString & key ) <li class=fn>void \fBclear\fR () +.SH DESCRIPTION +The QPixmapCache class provides an application-global cache for pixmaps. +.PP +This class is a tool for optimized drawing with QPixmap. You can use it to store temporary pixmaps that are expensive to generate without using more storage space than cacheLimit(). Use insert() to insert pixmaps, find() to find them and clear() to empty the cache. +.PP +For example, QRadioButton has a non-trivial visual representation so we don't want to regenerate a pixmap whenever a radio button is displayed or changes state. In the function QRadioButton::drawButton(), we do not draw the radio button directly. Instead, we first check the global pixmap cache for a pixmap with the key "$qt_radio_nnn_", where \fCnnn\fR is a numerical value that specifies the the radio button state. If a pixmap is found, we bitBlt() it onto the widget and return. Otherwise, we create a new pixmap, draw the radio button in the pixmap, and finally insert the pixmap in the global pixmap cache, using the key above. The bitBlt() is ten times faster than drawing the radio button. All radio buttons in the program share the cached pixmap since QPixmapCache is application-global. +.PP +QPixmapCache contains no member data, only static functions to access the global pixmap cache. It creates an internal QCache for caching the pixmaps. +.PP +The cache associates a pixmap with a string (key). If two pixmaps are inserted into the cache using equal keys, then the last pixmap will hide the first pixmap. The QDict and QCache classes do exactly the same. +.PP +The cache becomes full when the total size of all pixmaps in the cache exceeds cacheLimit(). The initial cache limit is 1024 KByte (1 MByte); it is changed with setCacheLimit(). A pixmap takes roughly width*height*depth/8 bytes of memory. +.PP +See the QCache documentation for more details about the cache mechanism. +.PP +See also Environment Classes, Graphics Classes, and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "int QPixmapCache::cacheLimit ()\fC [static]\fR" +Returns the cache limit (in kilobytes). +.PP +The default setting is 1024 kilobytes. +.PP +See also setCacheLimit(). +.SH "void QPixmapCache::clear ()\fC [static]\fR" +Removes all pixmaps from the cache. +.SH "QPixmap * QPixmapCache::find ( const QString & key )\fC [static]\fR" +Returns the pixmap associated with the \fIkey\fR in the cache, or null if there is no such pixmap. +.PP +\fBWarning:\fR If valid, you should copy the pixmap immediately (this is fast). Subsequent insertions into the cache could cause the pointer to become invalid. For this reason, we recommend you use find(const QString&, QPixmap&) instead. +.PP +Example: +.PP +.nf +.br + QPixmap* pp; +.br + QPixmap p; +.br + if ( (pp=QPixmapCache::find("my_big_image", pm)) ) { +.br + p = *pp; +.br + } else { +.br + p.load("bigimage.png"); +.br + QPixmapCache::insert("my_big_image", new QPixmap(p)); +.br + } +.br + painter->drawPixmap(0, 0, p); +.br +.fi +.SH "bool QPixmapCache::find ( const QString & key, QPixmap & pm )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Looks for a cached pixmap associated with the \fIkey\fR in the cache. If a pixmap is found, the function sets \fIpm\fR to that pixmap and returns TRUE; otherwise leaves \fIpm\fR alone and returns FALSE. +.PP +Example: +.PP +.nf +.br + QPixmap p; +.br + if ( !QPixmapCache::find("my_big_image", pm) ) { +.br + pm.load("bigimage.png"); +.br + QPixmapCache::insert("my_big_image", pm); +.br + } +.br + painter->drawPixmap(0, 0, p); +.br +.fi +.SH "bool QPixmapCache::insert ( const QString & key, const QPixmap & pm )\fC [static]\fR" +Inserts a copy of the pixmap \fIpm\fR associated with the \fIkey\fR into the cache. +.PP +All pixmaps inserted by the Qt library have a key starting with" $qt", so your own pixmap keys should never begin "$qt". +.PP +When a pixmap is inserted and the cache is about to exceed its limit, it removes pixmaps until there is enough room for the pixmap to be inserted. +.PP +The oldest pixmaps (least recently accessed in the cache) are deleted when more space is needed. +.PP +See also setCacheLimit(). +.SH "bool QPixmapCache::insert ( const QString & key, QPixmap * pm )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Inserts the pixmap \fIpm\fR associated with \fIkey\fR into the cache. Returns TRUE if successful, or FALSE if the pixmap is too big for the cache. +.PP +\fB Note: \fIpm\fR must be allocated on the heap (using \fCnew\fR). +.PP +If this function returns FALSE, you must delete \fIpm\fR yourself. +.PP +If this function returns TRUE, do not use \fIpm\fR afterwards or keep references to it because any other insertions into the cache, whether from anywhere in the application or within Qt itself, could cause the pixmap to be discarded from the cache and the pointer to become invalid. +.PP +Due to these dangers, we strongly recommend that you use insert(const QString&, const QPixmap&) instead. \fR +.SH "void QPixmapCache::remove ( const QString & key )\fC [static]\fR" +Removes the pixmap associated with \fIkey\fR from the cache. +.SH "void QPixmapCache::setCacheLimit ( int n )\fC [static]\fR" +Sets the cache limit to \fIn\fR kilobytes. +.PP +The default setting is 1024 kilobytes. +.PP +See also cacheLimit(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpixmapcache.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpixmapcache.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqplatinumstyle.3qt b/doc/man/man3/tqplatinumstyle.3qt new file mode 100644 index 000000000..2f18d5da1 --- /dev/null +++ b/doc/man/man3/tqplatinumstyle.3qt @@ -0,0 +1,68 @@ +'\" t +.TH QPlatinumStyle 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 +QPlatinumStyle \- Mac/Platinum look and feel +.SH SYNOPSIS +\fC#include <ntqplatinumstyle.h>\fR +.PP +Inherits QWindowsStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPlatinumStyle\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "QColor \fBmixedColor\fR ( const QColor & c1, const QColor & c2 ) const" +.br +.ti -1c +.BI "void \fBdrawRiffles\fR ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool horizontal ) const" +.br +.in -1c +.SH DESCRIPTION +The QPlatinumStyle class provides Mac/Platinum look and feel. +.PP +This class implements the Platinum look and feel. It's an experimental class that tries to resemble a Macinosh-like GUI style with the QStyle system. The emulation is currently far from perfect. +.PP +See also QAquaStyle and Widget Appearance and Style. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPlatinumStyle::QPlatinumStyle ()" +Constructs a QPlatinumStyle +.SH "void QPlatinumStyle::drawRiffles ( QPainter * p, int x, int y, int w, int h, const QColorGroup & g, bool horizontal ) const\fC [protected]\fR" +Draws the nifty Macintosh decoration used on sliders using painter \fIp\fR and colorgroup \fIg\fR. \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR and \fIhorizontal\fR specify the geometry and orientation of the riffles. +.SH "QColor QPlatinumStyle::mixedColor ( const QColor & c1, const QColor & c2 ) const\fC [protected]\fR" +Mixes two colors \fIc1\fR and \fIc2\fR to a new color. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqplatinumstyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqplatinumstyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpngimagepacker.3qt b/doc/man/man3/tqpngimagepacker.3qt new file mode 100644 index 000000000..fdf4a4b5a --- /dev/null +++ b/doc/man/man3/tqpngimagepacker.3qt @@ -0,0 +1,72 @@ +'\" t +.TH QPNGImagePacker 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 +QPNGImagePacker \- Creates well-compressed PNG animations +.SH SYNOPSIS +\fC#include <ntqpngio.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPNGImagePacker\fR ( QIODevice * iod, int storage_depth, int conversionflags )" +.br +.ti -1c +.BI "void \fBsetPixelAlignment\fR ( int x )" +.br +.ti -1c +.BI "bool \fBpackImage\fR ( const QImage & img )" +.br +.in -1c +.SH DESCRIPTION +The QPNGImagePacker class creates well-compressed PNG animations. +.PP +By using transparency, QPNGImagePacker allows you to build a PNG image from a sequence of QImages. +.PP +Images are added using packImage(). +.PP +See also Graphics Classes and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPNGImagePacker::QPNGImagePacker ( QIODevice * iod, int storage_depth, int conversionflags )" +Creates an image packer that writes PNG data to IO device \fIiod\fR using a \fIstorage_depth\fR bit encoding (use 8 or 32, depending on the desired quality and compression requirements). +.PP +If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversionflags\fR to specify how you'd prefer this to happen. +.PP +See also Qt::ImageConversionFlags. +.SH "bool QPNGImagePacker::packImage ( const QImage & img )" +Adds the image \fIimg\fR to the PNG animation, analyzing the differences between this and the previous image to improve compression. +.SH "void QPNGImagePacker::setPixelAlignment ( int x )" +Aligns pixel differences to \fIx\fR pixels. For example, using 8 can +improve playback on certain hardware. Normally the default of +1-pixel alignment (i.e. no alignment) gives better compression and +performance. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qpngimagepacker.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpngimagepacker.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpoint.3qt b/doc/man/man3/tqpoint.3qt new file mode 100644 index 000000000..e1cf546a7 --- /dev/null +++ b/doc/man/man3/tqpoint.3qt @@ -0,0 +1,377 @@ +'\" t +.TH QPoint 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 +QPoint \- Defines a point in the plane +.SH SYNOPSIS +\fC#include <ntqpoint.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPoint\fR ()" +.br +.ti -1c +.BI "\fBQPoint\fR ( int xpos, int ypos )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "void \fBsetX\fR ( int x )" +.br +.ti -1c +.BI "void \fBsetY\fR ( int y )" +.br +.ti -1c +.BI "int \fBmanhattanLength\fR () const" +.br +.ti -1c +.BI "QCOORD & \fBrx\fR ()" +.br +.ti -1c +.BI "QCOORD & \fBry\fR ()" +.br +.ti -1c +.BI "QPoint & \fBoperator+=\fR ( const QPoint & p )" +.br +.ti -1c +.BI "QPoint & \fBoperator-=\fR ( const QPoint & p )" +.br +.ti -1c +.BI "QPoint & \fBoperator*=\fR ( int c )" +.br +.ti -1c +.BI "QPoint & \fBoperator*=\fR ( double c )" +.br +.ti -1c +.BI "QPoint & \fBoperator/=\fR ( int c )" +.br +.ti -1c +.BI "QPoint & \fBoperator/=\fR ( double c )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "bool \fBoperator==\fR ( const QPoint & p1, const QPoint & p2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QPoint & p1, const QPoint & p2 )" +.br +.ti -1c +.BI "const QPoint \fBoperator+\fR ( const QPoint & p1, const QPoint & p2 )" +.br +.ti -1c +.BI "const QPoint \fBoperator-\fR ( const QPoint & p1, const QPoint & p2 )" +.br +.ti -1c +.BI "const QPoint \fBoperator*\fR ( const QPoint & p, int c )" +.br +.ti -1c +.BI "const QPoint \fBoperator*\fR ( int c, const QPoint & p )" +.br +.ti -1c +.BI "const QPoint \fBoperator*\fR ( const QPoint & p, double c )" +.br +.ti -1c +.BI "const QPoint \fBoperator*\fR ( double c, const QPoint & p )" +.br +.ti -1c +.BI "const QPoint \fBoperator-\fR ( const QPoint & p )" +.br +.ti -1c +.BI "const QPoint \fBoperator/\fR ( const QPoint & p, int c )" +.br +.ti -1c +.BI "const QPoint \fBoperator/\fR ( const QPoint & p, double c )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPoint & p )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPoint & p )" +.br +.in -1c +.SH DESCRIPTION +The QPoint class defines a point in the plane. +.PP +A point is specified by an x coordinate and a y coordinate. +.PP +The coordinate type is \fCQCOORD\fR (a 32-bit integer). The minimum value of \fCQCOORD\fR is \fCQCOORD_MIN\fR (-2147483648) and the maximum value is \fCQCOORD_MAX\fR (2147483647). +.PP +The coordinates are accessed by the functions x() and y(); they can be set by setX() and setY() or by the reference functions rx() and ry(). +.PP +Given a point \fIp\fR, the following statements are all equivalent: +.PP +.nf +.br + p.setX( p.x() + 1 ); +.br + p += QPoint( 1, 0 ); +.br + p.rx()++; +.br +.fi +.PP +A QPoint can also be used as a vector. Addition and subtraction of QPoints are defined as for vectors (each component is added separately). You can divide or multiply a QPoint by an \fCint\fR or a \fCdouble\fR. The function manhattanLength() gives an inexpensive approximation of the length of the QPoint interpreted as a vector. +.PP +Example: +.PP +.nf +.br + //QPoint oldPos is defined somewhere else +.br + MyWidget::mouseMoveEvent( QMouseEvent *e ) +.br + { +.br + QPoint vector = e->pos() - oldPos; +.br + if ( vector.manhattanLength() > 3 ) +.br + ... //mouse has moved more than 3 pixels since oldPos +.br + } +.br +.fi +.PP +QPoints can be compared for equality or inequality, and they can be written to and read from a QStream. +.PP +See also QPointArray, QSize, QRect, Graphics Classes, and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPoint::QPoint ()" +Constructs a point with coordinates (0, 0) (isNull() returns TRUE). +.SH "QPoint::QPoint ( int xpos, int ypos )" +Constructs a point with x value \fIxpos\fR and y value \fIypos\fR. +.SH "bool QPoint::isNull () const" +Returns TRUE if both the x value and the y value are 0; otherwise returns FALSE. +.SH "int QPoint::manhattanLength () const" +Returns the sum of the absolute values of x() and y(), traditionally known as the "Manhattan length" of the vector from the origin to the point. The tradition arises because such distances apply to travelers who can only travel on a rectangular grid, like the streets of Manhattan. +.PP +This is a useful, and quick to calculate, approximation to the true length: sqrt(pow(x(),2)+pow(y(),2)). +.SH "QPoint & QPoint::operator*= ( int c )" +Multiplies this point's x and y by \fIc\fR, and returns a reference to this point. +.PP +Example: +.PP +.nf +.br + QPoint p( -1, 4 ); +.br + p *= 2; // p becomes (-2,8) +.br +.fi +.SH "QPoint & QPoint::operator*= ( double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Multiplies this point's x and y by \fIc\fR, and returns a reference to this point. +.PP +Example: +.PP +.nf +.br + QPoint p( -1, 4 ); +.br + p *= 2.5; // p becomes (-3,10) +.br +.fi +.PP +Note that the result is truncated because points are held as integers. +.SH "QPoint & QPoint::operator+= ( const QPoint & p )" +Adds point \fIp\fR to this point and returns a reference to this point. +.PP +Example: +.PP +.nf +.br + QPoint p( 3, 7 ); +.br + QPoint q( -1, 4 ); +.br + p += q; // p becomes (2,11) +.br +.fi +.SH "QPoint & QPoint::operator-= ( const QPoint & p )" +Subtracts point \fIp\fR from this point and returns a reference to this point. +.PP +Example: +.PP +.nf +.br + QPoint p( 3, 7 ); +.br + QPoint q( -1, 4 ); +.br + p -= q; // p becomes (4,3) +.br +.fi +.SH "QPoint & QPoint::operator/= ( int c )" +Divides both x and y by \fIc\fR, and returns a reference to this point. +.PP +Example: +.PP +.nf +.br + QPoint p( -2, 8 ); +.br + p /= 2; // p becomes (-1,4) +.br +.fi +.SH "QPoint & QPoint::operator/= ( double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Divides both x and y by \fIc\fR, and returns a reference to this point. +.PP +Example: +.PP +.nf +.br + QPoint p( -3, 10 ); +.br + p /= 2.5; // p becomes (-1,4) +.br +.fi +.PP +Note that the result is truncated because points are held as integers. +.SH "QCOORD & QPoint::rx ()" +Returns a reference to the x coordinate of the point. +.PP +Using a reference makes it possible to directly manipulate x. +.PP +Example: +.PP +.nf +.br + QPoint p( 1, 2 ); +.br + p.rx()--; // p becomes (0, 2) +.br +.fi +.PP +See also ry(). +.SH "QCOORD & QPoint::ry ()" +Returns a reference to the y coordinate of the point. +.PP +Using a reference makes it possible to directly manipulate y. +.PP +Example: +.PP +.nf +.br + QPoint p( 1, 2 ); +.br + p.ry()++; // p becomes (1, 3) +.br +.fi +.PP +See also rx(). +.SH "void QPoint::setX ( int x )" +Sets the x coordinate of the point to \fIx\fR. +.PP +See also x() and setY(). +.PP +Example: t14/cannon.cpp. +.SH "void QPoint::setY ( int y )" +Sets the y coordinate of the point to \fIy\fR. +.PP +See also y() and setX(). +.PP +Example: t14/cannon.cpp. +.SH "int QPoint::x () const" +Returns the x coordinate of the point. +.PP +See also setX() and y(). +.PP +Examples: +.)l canvas/canvas.cpp, chart/canvasview.cpp, dirview/dirview.cpp, fileiconview/qfileiconview.cpp, helpsystem/tooltip.cpp, life/life.cpp, and t14/cannon.cpp. +.SH "int QPoint::y () const" +Returns the y coordinate of the point. +.PP +See also setY() and x(). +.PP +Examples: +.)l canvas/canvas.cpp, chart/canvasview.cpp, fileiconview/qfileiconview.cpp, helpsystem/tooltip.cpp, life/life.cpp, t14/cannon.cpp, and themes/wood.cpp. +.SH RELATED FUNCTION DOCUMENTATION +.SH "bool operator!= ( const QPoint & p1, const QPoint & p2 )" +Returns TRUE if \fIp1\fR and \fIp2\fR are not equal; otherwise returns FALSE. +.SH "const QPoint operator* ( const QPoint & p, int c )" +Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. +.SH "const QPoint operator* ( int c, const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. +.SH "const QPoint operator* ( const QPoint & p, double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. +.PP +Note that the result is truncated because points are held as integers. +.SH "const QPoint operator* ( double c, const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR. +.PP +Note that the result is truncated because points are held as integers. +.SH "const QPoint operator+ ( const QPoint & p1, const QPoint & p2 )" +Returns the sum of \fIp1\fR and \fIp2\fR; each component is added separately. +.SH "const QPoint operator- ( const QPoint & p1, const QPoint & p2 )" +Returns \fIp2\fR subtracted from \fIp1\fR; each component is subtracted separately. +.SH "const QPoint operator- ( const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the QPoint formed by changing the sign of both components of \fIp\fR, equivalent to \fCQPoint(0,0) - p\fR. +.SH "const QPoint operator/ ( const QPoint & p, int c )" +Returns the QPoint formed by dividing both components of \fIp\fR by \fIc\fR. +.SH "const QPoint operator/ ( const QPoint & p, double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the QPoint formed by dividing both components of \fIp\fR by \fIc\fR. +.PP +Note that the result is truncated because points are held as integers. +.SH "QDataStream & operator<< ( QDataStream & s, const QPoint & p )" +Writes point \fIp\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "bool operator== ( const QPoint & p1, const QPoint & p2 )" +Returns TRUE if \fIp1\fR and \fIp2\fR are equal; otherwise returns FALSE. +.SH "QDataStream & operator>> ( QDataStream & s, QPoint & p )" +Reads a QPoint from the stream \fIs\fR into point \fIp\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpoint.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpoint.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpointarray.3qt b/doc/man/man3/tqpointarray.3qt new file mode 100644 index 000000000..0645966b2 --- /dev/null +++ b/doc/man/man3/tqpointarray.3qt @@ -0,0 +1,277 @@ +'\" t +.TH QPointArray 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 +QPointArray \- Array of points +.SH SYNOPSIS +\fC#include <ntqpointarray.h>\fR +.PP +Inherits QMemArray<QPoint>. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPointArray\fR ()" +.br +.ti -1c +.BI "\fB~QPointArray\fR ()" +.br +.ti -1c +.BI "\fBQPointArray\fR ( int size )" +.br +.ti -1c +.BI "\fBQPointArray\fR ( const QPointArray & a )" +.br +.ti -1c +.BI "\fBQPointArray\fR ( const QRect & r, bool closed = FALSE )" +.br +.ti -1c +.BI "QPointArray & \fBoperator=\fR ( const QPointArray & a )" +.br +.ti -1c +.BI "QPointArray \fBcopy\fR () const" +.br +.ti -1c +.BI "void \fBtranslate\fR ( int dx, int dy )" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR () const" +.br +.ti -1c +.BI "void \fBpoint\fR ( uint index, int * x, int * y ) const" +.br +.ti -1c +.BI "QPoint \fBpoint\fR ( uint index ) const" +.br +.ti -1c +.BI "void \fBsetPoint\fR ( uint index, int x, int y )" +.br +.ti -1c +.BI "void \fBsetPoint\fR ( uint i, const QPoint & p )" +.br +.ti -1c +.BI "bool \fBputPoints\fR ( int index, int nPoints, int firstx, int firsty, ... )" +.br +.ti -1c +.BI "bool \fBputPoints\fR ( int index, int nPoints, const QPointArray & from, int fromIndex = 0 )" +.br +.ti -1c +.BI "void \fBmakeArc\fR ( int x, int y, int w, int h, int a1, int a2 )" +.br +.ti -1c +.BI "void \fBmakeEllipse\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBmakeArc\fR ( int x, int y, int w, int h, int a1, int a2, const QWMatrix & xf )" +.br +.ti -1c +.BI "QPointArray \fBcubicBezier\fR () const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPointArray & a )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPointArray & a )" +.br +.in -1c +.SH DESCRIPTION +The QPointArray class provides an array of points. +.PP +A QPointArray is an array of QPoint objects. In addition to the functions provided by QMemArray, QPointArray provides some point-specific functions. +.PP +For convenient reading and writing of the point data use setPoints(), putPoints(), point(), and setPoint(). +.PP +For geometry operations use boundingRect() and translate(). There is also the QWMatrix::map() function for more general transformations of QPointArrays. You can also create arcs and ellipses with makeArc() and makeEllipse(). +.PP +Among others, QPointArray is used by QPainter::drawLineSegments(), QPainter::drawPolyline(), QPainter::drawPolygon() and QPainter::drawCubicBezier(). +.PP +Note that because this class is a QMemArray, copying an array and modifying the copy modifies the original as well, i.e. a shallow copy. If you need a deep copy use copy() or detach(), for example: +.PP +.nf +.br + void drawGiraffe( const QPointArray & r, QPainter * p ) +.br + { +.br + QPointArray tmp = r; +.br + tmp.detach(); +.br + // some code that modifies tmp +.br + p->drawPoints( tmp ); +.br + } +.br +.fi +.PP +If you forget the tmp.detach(), the const array will be modified. +.PP +See also QPainter, QWMatrix, QMemArray, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPointArray::QPointArray ()" +Constructs a null point array. +.PP +See also isNull(). +.SH "QPointArray::QPointArray ( int size )" +Constructs a point array with room for \fIsize\fR points. Makes a null array if \fIsize\fR == 0. +.PP +See also resize() and isNull(). +.SH "QPointArray::QPointArray ( const QPointArray & a )" +Constructs a shallow copy of the point array \fIa\fR. +.PP +See also copy() and detach(). +.SH "QPointArray::QPointArray ( const QRect & r, bool closed = FALSE )" +Constructs a point array from the rectangle \fIr\fR. +.PP +If \fIclosed\fR is FALSE, then the point array just contains the following four points in the listed order: r.topLeft(), r.topRight(), r.bottomRight() and r.bottomLeft(). +.PP +If \fIclosed\fR is TRUE, then a fifth point is set to r.topLeft(). +.SH "QPointArray::~QPointArray ()" +Destroys the point array. +.SH "QRect QPointArray::boundingRect () const" +Returns the bounding rectangle of the points in the array, or QRect(0,0,0,0) if the array is empty. +.SH "QPointArray QPointArray::copy () const" +Creates a deep copy of the array. +.PP +See also detach(). +.SH "QPointArray QPointArray::cubicBezier () const" +Returns the Bezier points for the four control points in this array. +.SH "void QPointArray::makeArc ( int x, int y, int w, int h, int a1, int a2 )" +Sets the points of the array to those describing an arc of an ellipse with size, width \fIw\fR by height \fIh\fR, and position (\fIx\fR, \fIy\fR), starting from angle \fIa1\fR and spanning by angle \fIa2\fR. The resulting array has sufficient resolution for pixel accuracy (see the overloaded function which takes an additional QWMatrix parameter). +.PP +Angles are specified in 16ths of a degree, i.e. a full circle equals 5760 (16*360). Positive values mean counter-clockwise, whereas negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. +.PP +See the angle diagram. +.SH "void QPointArray::makeArc ( int x, int y, int w, int h, int a1, int a2, const QWMatrix & xf )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the points of the array to those describing an arc of an ellipse with width \fIw\fR and height \fIh\fR and position (\fIx\fR, \fIy\fR), starting from angle \fIa1\fR, and spanning angle by \fIa2\fR, and transformed by the matrix \fIxf\fR. The resulting array has sufficient resolution for pixel accuracy. +.PP +Angles are specified in 16ths of a degree, i.e. a full circle equals 5760 (16*360). Positive values mean counter-clockwise, whereas negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position. +.PP +See the angle diagram. +.SH "void QPointArray::makeEllipse ( int x, int y, int w, int h )" +Sets the points of the array to those describing an ellipse with size, width \fIw\fR by height \fIh\fR, and position (\fIx\fR, \fIy\fR). +.PP +The returned array has sufficient resolution for use as pixels. +.SH "QPointArray & QPointArray::operator= ( const QPointArray & a )" +Assigns a shallow copy of \fIa\fR to this point array and returns a reference to this point array. +.PP +Equivalent to assign(a). +.PP +See also copy() and detach(). +.SH "void QPointArray::point ( uint index, int * x, int * y ) const" +Reads the coordinates of the point at position \fIindex\fR within the array and writes them into \fI*x\fR and \fI*y\fR. +.SH "QPoint QPointArray::point ( uint index ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point at position \fIindex\fR within the array. +.SH "bool QPointArray::putPoints ( int index, int nPoints, int firstx, int firsty, ... )" +Copies \fInPoints\fR points from the variable argument list into this point array from position \fIindex\fR, and resizes the point array if \fCindex+nPoints\fR exceeds the size of the array. +.PP +Returns TRUE if successful, or FALSE if the array could not be resized (typically due to lack of memory). +.PP +The example code creates an array with three points (4,5), (6,7) and (8,9), by expanding the array from 1 to 3 points: +.PP +.nf +.br + QPointArray a( 1 ); +.br + a[0] = QPoint( 4, 5 ); +.br + a.putPoints( 1, 2, 6,7, 8,9 ); // index == 1, points == 2 +.br +.fi +.PP +This has the same result, but here putPoints overwrites rather than extends: +.PP +.nf +.br + QPointArray a( 3 ); +.br + a.putPoints( 0, 3, 4,5, 0,0, 8,9 ); +.br + a.putPoints( 1, 1, 6,7 ); +.br +.fi +.PP +The points are given as a sequence of integers, starting with \fIfirstx\fR then \fIfirsty\fR, and so on. +.PP +See also resize(). +.SH "bool QPointArray::putPoints ( int index, int nPoints, const QPointArray & from, int fromIndex = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version of the function copies \fInPoints\fR from \fIfrom\fR into this array, starting at \fIindex\fR in this array and \fIfromIndex\fR in \fIfrom\fR. \fIfromIndex\fR is 0 by default. +.PP +.nf +.br + QPointArray a; +.br + a.putPoints( 0, 3, 1,2, 0,0, 5,6 ); +.br + // a is now the three-point array ( 1,2, 0,0, 5,6 ); +.br + QPointArray b; +.br + b.putPoints( 0, 3, 4,4, 5,5, 6,6 ); +.br + // b is now ( 4,4, 5,5, 6,6 ); +.br + a.putPoints( 2, 3, b ); +.br + // a is now ( 1,2, 0,0, 4,4, 5,5, 6,6 ); +.br +.fi +.SH "void QPointArray::setPoint ( uint index, int x, int y )" +Sets the point at position \fIindex\fR in the array to \fI(x, y)\fR. +.PP +Example: themes/wood.cpp. +.SH "void QPointArray::setPoint ( uint i, const QPoint & p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the point at array index \fIi\fR to \fIp\fR. +.SH "void QPointArray::translate ( int dx, int dy )" +Translates all points in the array by \fI(dx, dy)\fR. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QPointArray & a )" +Writes the point array, \fIa\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QPointArray & a )" +Reads a point array, \fIa\fR from the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpointarray.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpointarray.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpopupmenu.3qt b/doc/man/man3/tqpopupmenu.3qt new file mode 100644 index 000000000..2d14bb887 --- /dev/null +++ b/doc/man/man3/tqpopupmenu.3qt @@ -0,0 +1,810 @@ +'\" t +.TH QPopupMenu 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 +QPopupMenu \- Popup menu widget +.SH SYNOPSIS +\fC#include <ntqpopupmenu.h>\fR +.PP +Inherits QFrame and QMenuData. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPopupMenu\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QPopupMenu\fR ()" +.br +.ti -1c +.BI "void \fBpopup\fR ( const QPoint & pos, int indexAtPoint = -1 )" +.br +.ti -1c +.BI "virtual void \fBupdateItem\fR ( int id )" +.br +.ti -1c +.BI "virtual void \fBsetCheckable\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisCheckable\fR () const" +.br +.ti -1c +.BI "int \fBexec\fR ()" +.br +.ti -1c +.BI "int \fBexec\fR ( const QPoint & pos, int indexAtPoint = 0 )" +.br +.ti -1c +.BI "virtual void \fBsetActiveItem\fR ( int i )" +.br +.ti -1c +.BI "int \fBidAt\fR ( int index ) const" +.br +.ti -1c +.BI "int \fBidAt\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "int \fBinsertTearOffHandle\fR ( int id = -1, int index = -1 )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBactivated\fR ( int id )" +.br +.ti -1c +.BI "void \fBhighlighted\fR ( int id )" +.br +.ti -1c +.BI "void \fBaboutToShow\fR ()" +.br +.ti -1c +.BI "void \fBaboutToHide\fR ()" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( QWidget * widget, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( QCustomMenuItem * custom, int id = -1, int index = -1 )" +.br +.ti -1c +.BI "int \fBinsertSeparator\fR ( int index = -1 )" +.br +.ti -1c +.BI "void \fBremoveItem\fR ( int id )" +.br +.ti -1c +.BI "void \fBremoveItemAt\fR ( int index )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "QKeySequence \fBaccel\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetAccel\fR ( const QKeySequence & key, int id )" +.br +.ti -1c +.BI "QIconSet * \fBiconSet\fR ( int id ) const" +.br +.ti -1c +.BI "QString \fBtext\fR ( int id ) const" +.br +.ti -1c +.BI "QPixmap * \fBpixmap\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetWhatsThis\fR ( int id, const QString & text )" +.br +.ti -1c +.BI "QString \fBwhatsThis\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QString & text )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QPixmap & pixmap )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QString & text )" +.br +.ti -1c +.BI "void \fBchangeItem\fR ( int id, const QIconSet & icon, const QPixmap & pixmap )" +.br +.ti -1c +.BI "bool \fBisItemEnabled\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemEnabled\fR ( int id, bool enable )" +.br +.ti -1c +.BI "bool \fBisItemChecked\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemChecked\fR ( int id, bool check )" +.br +.ti -1c +.BI "bool \fBisItemVisible\fR ( int id ) const" +.br +.ti -1c +.BI "void \fBsetItemVisible\fR ( int id, bool visible )" +.br +.ti -1c +.BI "bool \fBconnectItem\fR ( int id, const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "bool \fBdisconnectItem\fR ( int id, const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "bool \fBsetItemParameter\fR ( int id, int param )" +.br +.ti -1c +.BI "int \fBitemParameter\fR ( int id ) const" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBcheckable\fR - whether the display of check marks on menu items is enabled" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "int \fBitemHeight\fR ( int row ) const" +.br +.ti -1c +.BI "int \fBitemHeight\fR ( QMenuItem * mi ) const" +.br +.ti -1c +.BI "void \fBdrawItem\fR ( QPainter * p, int tab_, QMenuItem * mi, bool act, int x, int y, int w, int h )" +.br +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * p )" +.br +.ti -1c +.BI "int \fBcolumns\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QPopupMenu class provides a popup menu widget. +.PP +A popup menu widget is a selection menu. It can be either a pull-down menu in a menu bar or a standalone context (popup) menu. Pull-down menus are shown by the menu bar when the user clicks on the respective item or presses the specified shortcut key. Use QMenuBar::insertItem() to insert a popup menu into a menu bar. Show a context menu either asynchronously with popup() or synchronously with exec(). +.PP +Technically, a popup menu consists of a list of menu items. You add items with insertItem(). An item is either a string, a pixmap or a custom item that provides its own drawing function (see QCustomMenuItem). In addition, items can have an optional icon drawn on the very left side and an accelerator key such as" Ctrl+X". +.PP +There are three kinds of menu items: separators, menu items that perform an action and menu items that show a submenu. Separators are inserted with insertSeparator(). For submenus, you pass a pointer to a QPopupMenu in your call to insertItem(). All other items are considered action items. +.PP +When inserting action items you usually specify a receiver and a slot. The receiver will be notifed whenever the item is selected. In addition, QPopupMenu provides two signals, activated() and highlighted(), which signal the identifier of the respective menu item. It is sometimes practical to connect several items to one slot. To distinguish between them, specify a slot that takes an integer argument and use setItemParameter() to associate a unique value with each item. +.PP +You clear a popup menu with clear() and remove single items with removeItem() or removeItemAt(). +.PP +A popup menu can display check marks for certain items when enabled with setCheckable(TRUE). You check or uncheck items with setItemChecked(). +.PP +Items are either enabled or disabled. You toggle their state with setItemEnabled(). Just before a popup menu becomes visible, it emits the aboutToShow() signal. You can use this signal to set the correct enabled/disabled states of all menu items before the user sees it. The corresponding aboutToHide() signal is emitted when the menu hides again. +.PP +You can provide What's This? help for single menu items with setWhatsThis(). See QWhatsThis for general information about this kind of lightweight online help. +.PP +For ultimate flexibility, you can also add entire widgets as items into a popup menu (for example, a color selector). +.PP +A QPopupMenu can also provide a tear-off menu. A tear-off menu is a top-level window that contains a copy of the menu. This makes it possible for the user to "tear off" frequently used menus and position them in a convenient place on the screen. If you want that functionality for a certain menu, insert a tear-off handle with insertTearOffHandle(). When using tear-off menus, bear in mind that the concept isn't typically used on Microsoft Windows so users may not be familiar with it. Consider using a QToolBar instead. Tear-off menus cannot contain custom widgets; if the original menu contains a custom widget item, this item is omitted. +.PP +menu/menu.cpp is an example of QMenuBar and QPopupMenu use. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QMenuBar, GUI Design Handbook: Menu, Drop-Down and Pop-Up, Main Window and Related Classes, and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPopupMenu::QPopupMenu ( QWidget * parent = 0, const char * name = 0 )" +Constructs a popup menu called \fIname\fR with parent \fIparent\fR. +.PP +Although a popup menu is always a top-level widget, if a parent is passed the popup menu will be deleted when that parent is destroyed (as with any other QObject). +.SH "QPopupMenu::~QPopupMenu ()" +Destroys the popup menu. +.SH "void QPopupMenu::aboutToHide ()\fC [signal]\fR" +This signal is emitted just before the popup menu is hidden after it has been displayed. +.PP +\fBWarning:\fR Do not open a widget in a slot connected to this signal. +.PP +See also aboutToShow(), setItemEnabled(), setItemChecked(), insertItem(), and removeItem(). +.SH "void QPopupMenu::aboutToShow ()\fC [signal]\fR" +This signal is emitted just before the popup menu is displayed. You can connect it to any slot that sets up the menu contents (e.g. to ensure that the right items are enabled). +.PP +See also aboutToHide(), setItemEnabled(), setItemChecked(), insertItem(), and removeItem(). +.PP +Example: mdi/application.cpp. +.SH "QKeySequence QMenuData::accel ( int id ) const" +Returns the accelerator key that has been defined for the menu item \fIid\fR, or 0 if it has no accelerator key or if there is no such menu item. +.PP +See also setAccel(), QAccel, and ntqnamespace.h. +.SH "void QPopupMenu::activated ( int id )\fC [signal]\fR" +This signal is emitted when a menu item is selected; \fIid\fR is the id of the selected item. +.PP +Normally, you connect each menu item to a single slot using QMenuData::insertItem(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is useful in such cases. +.PP +See also highlighted() and QMenuData::insertItem(). +.PP +Examples: +.)l grapher/grapher.cpp, helpviewer/helpwindow.cpp, qdir/qdir.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. +.SH "void QMenuData::changeItem ( int id, const QString & text )" +Changes the text of the menu item \fIid\fR to \fItext\fR. If the item has an icon, the icon remains unchanged. +.PP +See also text(). +.SH "void QMenuData::changeItem ( int id, const QPixmap & pixmap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Changes the pixmap of the menu item \fIid\fR to the pixmap \fIpixmap\fR. If the item has an icon, the icon is unchanged. +.PP +See also pixmap(). +.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QString & text )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Changes the iconset and text of the menu item \fIid\fR to the \fIicon\fR and \fItext\fR respectively. +.PP +See also pixmap(). +.SH "void QMenuData::changeItem ( int id, const QIconSet & icon, const QPixmap & pixmap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Changes the iconset and pixmap of the menu item \fIid\fR to \fIicon\fR and \fIpixmap\fR respectively. +.PP +See also pixmap(). +.SH "void QMenuData::clear ()" +Removes all menu items. +.PP +See also removeItem() and removeItemAt(). +.PP +Examples: +.)l mdi/application.cpp and qwerty/qwerty.cpp. +.SH "int QPopupMenu::columns () const\fC [protected]\fR" +If a popup menu does not fit on the screen it lays itself out so that it does fit. It is style dependent what layout means (for example, on Windows it will use multiple columns). +.PP +This functions returns the number of columns necessary. +.PP +See also sizeHint. +.SH "bool QMenuData::connectItem ( int id, const QObject * receiver, const char * member )" +Connects the menu item with identifier \fIid\fR to \fIreceiver\fR's \fImember\fR slot or signal. +.PP +The receiver's slot (or signal) is activated when the menu item is activated. +.PP +See also disconnectItem() and setItemParameter(). +.PP +Example: menu/menu.cpp. +.SH "bool QMenuData::disconnectItem ( int id, const QObject * receiver, const char * member )" +Disconnects the \fIreceiver\fR's \fImember\fR from the menu item with identifier \fIid\fR. +.PP +All connections are removed when the menu data object is destroyed. +.PP +See also connectItem() and setItemParameter(). +.SH "void QPopupMenu::drawContents ( QPainter * p )\fC [virtual protected]\fR" +Draws all menu items using painter \fIp\fR. +.PP +Reimplemented from QFrame. +.SH "void QPopupMenu::drawItem ( QPainter * p, int tab_, QMenuItem * mi, bool act, int x, int y, int w, int h )\fC [protected]\fR" +Draws menu item \fImi\fR in the area \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, using painter \fIp\fR. The item is drawn active if \fIact\fR is TRUE or drawn inactive if \fIact\fR is FALSE. The rightmost \fItab_\fR pixels are used for accelerator text. +.PP +See also QStyle::drawControl(). +.SH "int QPopupMenu::exec ()" +Executes this popup synchronously. +.PP +This is equivalent to \fCexec(mapToGlobal(QPoint(0,0)))\fR. In most situations you'll want to specify the position yourself, for example at the current mouse position: +.PP +.nf +.br + exec(QCursor::pos()); +.br +.fi +or aligned to a widget: +.PP +.nf +.br + exec(somewidget.mapToGlobal(QPoint(0,0))); +.br +.fi +.PP +Examples: +.)l fileiconview/qfileiconview.cpp, menu/menu.cpp, and scribble/scribble.cpp. +.SH "int QPopupMenu::exec ( const QPoint & pos, int indexAtPoint = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Executes this popup synchronously. +.PP +Opens the popup menu so that the item number \fIindexAtPoint\fR will be at the specified \fIglobal\fR position \fIpos\fR. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal(). +.PP +The return code is the id of the selected item in either the popup menu or one of its submenus, or -1 if no item is selected (normally because the user pressed Esc). +.PP +Note that all signals are emitted as usual. If you connect a menu item to a slot and call the menu's exec(), you get the result both via the signal-slot connection and in the return value of exec(). +.PP +Common usage is to position the popup at the current mouse position: +.PP +.nf +.br + exec( QCursor::pos() ); +.br +.fi +or aligned to a widget: +.PP +.nf +.br + exec( somewidget.mapToGlobal(QPoint(0, 0)) ); +.br +.fi +.PP +When positioning a popup with exec() or popup(), bear in mind that you cannot rely on the popup menu's current size(). For performance reasons, the popup adapts its size only when necessary. So in many cases, the size before and after the show is different. Instead, use sizeHint(). It calculates the proper size depending on the menu's current contents. +.PP +See also popup() and sizeHint. +.SH "void QPopupMenu::highlighted ( int id )\fC [signal]\fR" +This signal is emitted when a menu item is highlighted; \fIid\fR is the id of the highlighted item. +.PP +See also activated() and QMenuData::insertItem(). +.SH "QIconSet * QMenuData::iconSet ( int id ) const" +Returns the icon set that has been set for menu item \fIid\fR, or 0 if no icon set has been set. +.PP +See also changeItem(), text(), and pixmap(). +.SH "int QPopupMenu::idAt ( int index ) const" +Returns the identifier of the menu item at position \fIindex\fR in the internal list, or -1 if \fIindex\fR is out of range. +.PP +See also QMenuData::setId() and QMenuData::indexOf(). +.PP +Example: scrollview/scrollview.cpp. +.SH "int QPopupMenu::idAt ( const QPoint & pos ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the id of the item at \fIpos\fR, or -1 if there is no item there or if it is a separator. +.SH "int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +The family of insertItem() functions inserts menu items into a popup menu or a menu bar. +.PP +A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus. +.PP +Some insertItem() members take a popup menu as an additional argument. Use this to insert submenus into existing menus or pulldown menus into a menu bar. +.PP +The number of insert functions may look confusing, but they are actually quite simple to use. +.PP +This default version inserts a menu item with the text \fItext\fR, the accelerator key \fIaccel\fR, an id and an optional index and connects it to the slot \fImember\fR in the object \fIreceiver\fR. +.PP +Example: +.PP +.nf +.br + QMenuBar *mainMenu = new QMenuBar; +.br + QPopupMenu *fileMenu = new QPopupMenu; +.br + fileMenu->insertItem( "New", myView, SLOT(newFile()), CTRL+Key_N ); +.br + fileMenu->insertItem( "Open", myView, SLOT(open()), CTRL+Key_O ); +.br + mainMenu->insertItem( "File", fileMenu ); +.br +.fi +.PP +Not all insert functions take an object/slot parameter or an accelerator key. Use connectItem() and setAccel() on those items. +.PP +If you need to translate accelerators, use tr() with the text and accelerator. (For translations use a string key sequence.): +.PP +.nf +.br + fileMenu->insertItem( tr("Open"), myView, SLOT(open()), +.br + tr("Ctrl+O") ); +.br +.fi +.PP +In the example above, pressing Ctrl+O or selecting "Open" from the menu activates the myView->open() function. +.PP +Some insert functions take a QIconSet parameter to specify the little menu item icon. Note that you can always pass a QPixmap object instead. +.PP +The \fIid\fR specifies the identification number associated with the menu item. Note that only positive values are valid, as a negative value will make Qt select a unique id for the item. +.PP +The \fIindex\fR specifies the position in the menu. The menu item is appended at the end of the list if \fIindex\fR is negative. +.PP +Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. +.PP +\fBWarning:\fR Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g. \fC(QObject*)0\fR. +.PP +\fBWarning:\fR On Mac OS X, items that connect to a slot that are inserted into a menubar will not function as we use the native menubar that knows nothing about signals or slots. Instead insert the items into a popup menu and insert the popup menu into the menubar. This may be fixed in a future Qt version. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.PP +Examples: +.)l addressbook/mainwindow.cpp, canvas/canvas.cpp, menu/menu.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the \fImember\fR slot in the \fIreceiver\fR object. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. +.SH "int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with pixmap \fIpixmap\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. +.PP +The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted. +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(), changeItem(), setAccel(), and connectItem(). +.SH "int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a menu item that consists of the widget \fIwidget\fR with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +Ownership of \fIwidget\fR is transferred to the popup menu or to the menu bar. +.PP +Theoretically, any widget can be inserted into a popup menu. In practice, this only makes sense with certain widgets. +.PP +If a widget is not focus-enabled (see QWidget::isFocusEnabled()), the menu treats it as a separator; this means that the item is not selectable and will never get focus. In this way you can, for example, simply insert a QLabel if you need a popup menu with a title. +.PP +If the widget is focus-enabled it will get focus when the user traverses the popup menu with the arrow keys. If the widget does not accept \fCArrowUp\fR and \fCArrowDown\fR in its key event handler, the focus will move back to the menu when the respective arrow key is hit one more time. This works with a QLineEdit, for example. If the widget accepts the arrow key itself, it must also provide the possibility to put the focus back on the menu again by calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu when the user made a selection, this can be done safely by calling: +.PP +.nf +.br + if ( isVisible() && +.br + parentWidget() && +.br + parentWidget()->inherits("QPopupMenu") ) +.br + parentWidget()->close(); +.br +.fi +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also removeItem(). +.SH "int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a custom menu item \fIcustom\fR with an \fIicon\fR and with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. +.PP +If you want to connect a custom item to a slot, use connectItem(). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also connectItem(), removeItem(), and QCustomMenuItem. +.SH "int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a custom menu item \fIcustom\fR with optional id \fIid\fR, and optional \fIindex\fR position. +.PP +This only works with popup menus. It is not supported for menu bars. Ownership of \fIcustom\fR is transferred to the popup menu. +.PP +If you want to connect a custom item to a slot, use connectItem(). +.PP +Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). +.PP +See also connectItem(), removeItem(), and QCustomMenuItem. +.SH "int QMenuData::insertSeparator ( int index = -1 )" +Inserts a separator at position \fIindex\fR, and returns the menu identifier number allocated to it. The separator becomes the last menu item if \fIindex\fR is negative. +.PP +In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guidelines). +.PP +Examples: +.)l addressbook/mainwindow.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. +.SH "int QPopupMenu::insertTearOffHandle ( int id = -1, int index = -1 )" +Inserts a tear-off handle into the menu. A tear-off handle is a special menu item that creates a copy of the menu when the menu is selected. This "torn-off" copy lives in a separate window. It contains the same menu items as the original menu, with the exception of the tear-off handle. +.PP +The handle item is assigned the identifier \fIid\fR or an automatically generated identifier if \fIid\fR is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application. +.PP +The \fIindex\fR specifies the position in the menu. The tear-off handle is appended at the end of the list if \fIindex\fR is negative. +.PP +Example: menu/menu.cpp. +.SH "bool QPopupMenu::isCheckable () const" +Returns TRUE if the display of check marks on menu items is enabled; otherwise returns FALSE. See the "checkable" property for details. +.SH "bool QMenuData::isItemChecked ( int id ) const" +Returns TRUE if the menu item with the id \fIid\fR has been checked; otherwise returns FALSE. +.PP +See also setItemChecked(). +.PP +Examples: +.)l canvas/canvas.cpp, progress/progress.cpp, and showimg/showimg.cpp. +.SH "bool QMenuData::isItemEnabled ( int id ) const" +Returns TRUE if the item with identifier \fIid\fR is enabled; otherwise returns FALSE +.PP +See also setItemEnabled() and isItemVisible(). +.SH "bool QMenuData::isItemVisible ( int id ) const" +Returns TRUE if the menu item with the id \fIid\fR is visible; otherwise returns FALSE. +.PP +See also setItemVisible(). +.SH "int QPopupMenu::itemHeight ( int row ) const\fC [protected]\fR" +Calculates the height in pixels of the item in row \fIrow\fR. +.SH "int QPopupMenu::itemHeight ( QMenuItem * mi ) const\fC [protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Calculates the height in pixels of the menu item \fImi\fR. +.SH "int QMenuData::itemParameter ( int id ) const" +Returns the parameter of the activation signal of item \fIid\fR. +.PP +If no parameter has been specified for this item with setItemParameter(), the value defaults to \fIid\fR. +.PP +See also connectItem(), disconnectItem(), and setItemParameter(). +.SH "QPixmap * QMenuData::pixmap ( int id ) const" +Returns the pixmap that has been set for menu item \fIid\fR, or 0 if no pixmap has been set. +.PP +See also changeItem(), text(), and iconSet(). +.SH "void QPopupMenu::popup ( const QPoint & pos, int indexAtPoint = -1 )" +Displays the popup menu so that the item number \fIindexAtPoint\fR will be at the specified \fIglobal\fR position \fIpos\fR. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal(). +.PP +When positioning a popup with exec() or popup(), bear in mind that you cannot rely on the popup menu's current size(). For performance reasons, the popup adapts its size only when necessary, so in many cases, the size before and after the show is different. Instead, use sizeHint(). It calculates the proper size depending on the menu's current contents. +.PP +Example: listviews/listviews.cpp. +.SH "void QMenuData::removeItem ( int id )" +Removes the menu item that has the identifier \fIid\fR. +.PP +See also removeItemAt() and clear(). +.PP +Example: chart/chartform.cpp. +.SH "void QMenuData::removeItemAt ( int index )" +Removes the menu item at position \fIindex\fR. +.PP +See also removeItem() and clear(). +.SH "void QMenuData::setAccel ( const QKeySequence & key, int id )" +Sets the accelerator key for the menu item \fIid\fR to \fIkey\fR. +.PP +An accelerator key consists of a key code and a combination of the modifiers SHIFT, CTRL, ALT or UNICODE_ACCEL (OR'ed or added). The header file ntqnamespace.h contains a list of key codes. +.PP +Defining an accelerator key produces a text that is added to the menu item; for instance, CTRL + Key_O produces "Ctrl+O". The text is formatted differently for different platforms. +.PP +Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. +.PP +Example: +.PP +.nf +.br + QMenuBar *mainMenu = new QMenuBar; +.br + QPopupMenu *fileMenu = new QPopupMenu; // file sub menu +.br + fileMenu->insertItem( "Open Document", 67 ); // add "Open" item +.br + fileMenu->setAccel( CTRL + Key_O, 67 ); // Ctrl+O to open +.br + fileMenu->insertItem( "Quit", 69 ); // add "Quit" item +.br + fileMenu->setAccel( CTRL + ALT + Key_Delete, 69 ); // add Alt+Del to quit +.br + mainMenu->insertItem( "File", fileMenu ); // add the file menu +.br +.fi +.PP +If you need to translate accelerators, use tr() with a string: +.PP +.nf +.br + fileMenu->setAccel( tr("Ctrl+O"), 67 ); +.br +.fi +.PP +You can also specify the accelerator in the insertItem() function. You may prefer to use QAction to associate accelerators with menu items. +.PP +See also accel(), insertItem(), QAccel, and QAction. +.PP +Example: menu/menu.cpp. +.SH "void QPopupMenu::setActiveItem ( int i )\fC [virtual]\fR" +Sets the currently active item to index \fIi\fR and repaints as necessary. +.SH "void QPopupMenu::setCheckable ( bool )\fC [virtual]\fR" +Sets whether the display of check marks on menu items is enabled. See the "checkable" property for details. +.SH "void QMenuData::setItemChecked ( int id, bool check )" +If \fIcheck\fR is TRUE, checks the menu item with id \fIid\fR; otherwise unchecks the menu item with id \fIid\fR. Calls QPopupMenu::setCheckable( TRUE ) if necessary. +.PP +See also isItemChecked(). +.PP +Examples: +.)l canvas/canvas.cpp, grapher/grapher.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. +.SH "void QMenuData::setItemEnabled ( int id, bool enable )" +If \fIenable\fR is TRUE, enables the menu item with identifier \fIid\fR; otherwise disables the menu item with identifier \fIid\fR. +.PP +See also isItemEnabled(). +.PP +Examples: +.)l mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, and showimg/showimg.cpp. +.SH "bool QMenuData::setItemParameter ( int id, int param )" +Sets the parameter of the activation signal of item \fIid\fR to \fIparam\fR. +.PP +If any receiver takes an integer parameter, this value is passed. +.PP +See also connectItem(), disconnectItem(), and itemParameter(). +.PP +Example: mdi/application.cpp. +.SH "void QMenuData::setItemVisible ( int id, bool visible )" +If \fIvisible\fR is TRUE, shows the menu item with id \fIid\fR; otherwise hides the menu item with id \fIid\fR. +.PP +See also isItemVisible() and isItemEnabled(). +.SH "void QMenuData::setWhatsThis ( int id, const QString & text )" +Sets \fItext\fR as What's This help for the menu item with identifier \fIid\fR. +.PP +See also whatsThis(). +.PP +Examples: +.)l application/application.cpp, helpsystem/mainwindow.cpp, and mdi/application.cpp. +.SH "QString QMenuData::text ( int id ) const" +Returns the text that has been set for menu item \fIid\fR, or QString::null if no text has been set. +.PP +See also changeItem(), pixmap(), and iconSet(). +.PP +Examples: +.)l qdir/qdir.cpp and showimg/showimg.cpp. +.SH "void QPopupMenu::updateItem ( int id )\fC [virtual]\fR" +Updates the item with identity \fIid\fR. +.PP +Reimplemented from QMenuData. +.SH "QString QMenuData::whatsThis ( int id ) const" +Returns the What's This help text for the item with identifier \fIid\fR or QString::null if no text has yet been defined. +.PP +See also setWhatsThis(). +.SS "Property Documentation" +.SH "bool checkable" +This property holds whether the display of check marks on menu items is enabled. +.PP +When TRUE, the display of check marks on menu items is enabled. Checking is always enabled when in Windows-style. +.PP +See also QMenuData::setItemChecked(). +.PP +Set this property's value with setCheckable() and get this property's value with isCheckable(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpopupmenu.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpopupmenu.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqprinter.3qt b/doc/man/man3/tqprinter.3qt new file mode 100644 index 000000000..7db8956cc --- /dev/null +++ b/doc/man/man3/tqprinter.3qt @@ -0,0 +1,734 @@ +'\" t +.TH QPrinter 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 +QPrinter \- Paint device that paints on a printer +.SH SYNOPSIS +\fC#include <ntqprinter.h>\fR +.PP +Inherits QPaintDevice. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBPrinterMode\fR { ScreenResolution, PrinterResolution, HighResolution, Compatible }" +.br +.ti -1c +.BI "\fBQPrinter\fR ( PrinterMode m = ScreenResolution )" +.br +.ti -1c +.BI "\fB~QPrinter\fR ()" +.br +.ti -1c +.BI "enum \fBOrientation\fR { Portrait, Landscape }" +.br +.ti -1c +.BI "enum \fBPageSize\fR { A4, B5, Letter, Legal, Executive, A0, A1, A2, A3, A5, A6, A7, A8, A9, B0, B1, B10, B2, B3, B4, B6, B7, B8, B9, C5E, Comm10E, DLE, Folio, Ledger, Tabloid, Custom, NPageSize = Custom }" +.br +.ti -1c +.BI "enum \fBPageOrder\fR { FirstPageFirst, LastPageFirst }" +.br +.ti -1c +.BI "enum \fBColorMode\fR { GrayScale, Color }" +.br +.ti -1c +.BI "enum \fBPaperSource\fR { OnlyOne, Lower, Middle, Manual, Envelope, EnvelopeManual, Auto, Tractor, SmallFormat, LargeFormat, LargeCapacity, Cassette, FormSource }" +.br +.ti -1c +.BI "enum \fBPrintRange\fR { AllPages, Selection, PageRange }" +.br +.ti -1c +.BI "enum \fBPrinterOption\fR { PrintToFile, PrintSelection, PrintPageRange }" +.br +.ti -1c +.BI "QString \fBprinterName\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPrinterName\fR ( const QString & name )" +.br +.ti -1c +.BI "bool \fBoutputToFile\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetOutputToFile\fR ( bool enable )" +.br +.ti -1c +.BI "QString \fBoutputFileName\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetOutputFileName\fR ( const QString & fileName )" +.br +.ti -1c +.BI "QString \fBprintProgram\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPrintProgram\fR ( const QString & printProg )" +.br +.ti -1c +.BI "QString \fBprinterSelectionOption\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPrinterSelectionOption\fR ( const QString & option )" +.br +.ti -1c +.BI "QString \fBdocName\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDocName\fR ( const QString & name )" +.br +.ti -1c +.BI "QString \fBcreator\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCreator\fR ( const QString & creator )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetOrientation\fR ( Orientation orientation )" +.br +.ti -1c +.BI "PageSize \fBpageSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPageSize\fR ( PageSize newPageSize )" +.br +.ti -1c +.BI "void \fBsetWinPageSize\fR ( short winPageSize )" +.br +.ti -1c +.BI "short \fBwinPageSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPageOrder\fR ( PageOrder newPageOrder )" +.br +.ti -1c +.BI "PageOrder \fBpageOrder\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetResolution\fR ( int dpi )" +.br +.ti -1c +.BI "virtual int \fBresolution\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetColorMode\fR ( ColorMode newColorMode )" +.br +.ti -1c +.BI "ColorMode \fBcolorMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFullPage\fR ( bool fp )" +.br +.ti -1c +.BI "bool \fBfullPage\fR () const" +.br +.ti -1c +.BI "QSize \fBmargins\fR () const" +.br +.ti -1c +.BI "void \fBsetMargins\fR ( uint top, uint left, uint bottom, uint right )" +.br +.ti -1c +.BI "void \fBmargins\fR ( uint * top, uint * left, uint * bottom, uint * right ) const" +.br +.ti -1c +.BI "int \fBfromPage\fR () const" +.br +.ti -1c +.BI "int \fBtoPage\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFromTo\fR ( int fromPage, int toPage )" +.br +.ti -1c +.BI "int \fBminPage\fR () const" +.br +.ti -1c +.BI "int \fBmaxPage\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMinMax\fR ( int minPage, int maxPage )" +.br +.ti -1c +.BI "int \fBnumCopies\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNumCopies\fR ( int numCopies )" +.br +.ti -1c +.BI "PrintRange \fBprintRange\fR () const" +.br +.ti -1c +.BI "void \fBsetPrintRange\fR ( PrintRange range )" +.br +.ti -1c +.BI "bool \fBnewPage\fR ()" +.br +.ti -1c +.BI "bool \fBabort\fR ()" +.br +.ti -1c +.BI "bool \fBaborted\fR () const" +.br +.ti -1c +.BI "bool \fBsetup\fR ( QWidget * parent = 0 )" +.br +.ti -1c +.BI "PaperSource \fBpaperSource\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPaperSource\fR ( PaperSource source )" +.br +.ti -1c +.BI "void \fBsetOptionEnabled\fR ( PrinterOption option, bool enable )" +.br +.ti -1c +.BI "bool \fBisOptionEnabled\fR ( PrinterOption option )" +.br +.in -1c +.SH DESCRIPTION +The QPrinter class is a paint device that paints on a printer. +.PP +On Windows it uses the built-in printer drivers. On X11 it generates postscript and sends that to lpr, lp, or another print command. +.PP +QPrinter is used in much the same way as QWidget and QPixmap are used. The big difference is that you must keep track of the pages. +.PP +QPrinter supports a number of settable parameters, most of which can be changed by the end user when the application calls QPrinter::setup(). +.PP +The most important parameters are: +.TP +setOrientation() tells QPrinter which page orientation to use (virtual). +.TP +setPageSize() tells QPrinter what page size to expect from the printer. +.TP +setResolution() tells QPrinter what resolution you wish the printer to provide (in dpi). +.TP +setFullPage() tells QPrinter whether you want to deal with the full page or just with the part the printer can draw on. The default is FALSE, so that by default you should be able to paint on (0,0). If TRUE the origin of the coordinate system will be in the top left corner of the paper and most probably the printer will not be able to paint something there due to it's physical margins. +.TP +setNumCopies() tells QPrinter how many copies of the document it should print. +.TP +setMinMax() tells QPrinter and QPrintDialog what the allowed range for fromPage() and toPage() are. +.PP +Except where noted, you can only call the set functions before setup(), or between QPainter::end() and setup(). (Some may take effect between setup() and begin(), or between begin() and end(), but that's strictly undocumented and such behaviour may differ depending on platform.) +.PP +There are also some settings that the user sets (through the printer dialog) and that applications are expected to obey: +.IP +.TP +pageOrder() tells the application program whether to print first-page-first or last-page-first. +.IP +.TP +colorMode() tells the application program whether to print in color or grayscale. (If you print in color and the printer does not support color, Qt will try to approximate. The document may take longer to print, but the quality should not be made visibly poorer.) +.IP +.TP +fromPage() and toPage() indicate what pages the application program should print. +.IP +.TP +paperSource() tells the application progam which paper source to print from. +.IP +.PP +You can of course call these functions to establish defaults before you ask the user through QPrinter::setup(). +.PP +Once you start printing, calling newPage() is essential. You will probably also need to look at the QPaintDeviceMetrics for the printer (see the print function in the Application walk-through). In previous versions, paint device metrics were valid only after the QPrinter has been set up, i.e. after setup() has returned successfully. This is no longer the case and paint device metrics can be requested safely before set up. +.PP +If you want to abort the print job, abort() will try its best to stop printing. It may cancel the entire job or just some of it. +.PP +If your current locale converts "," to ".", you will need to set a locale (via the standard C setlocale() function) that doen't do this before using QPrinter. The "C" locale works well for this. +.PP +The TrueType font embedding for Qt's postscript driver uses code by David Chappell of Trinity College Computing Center. +.PP +Copyright 1995, Trinity College Computing Center. Written by David Chappell. +.PP +Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. This software is provided "as is" without express or implied warranty. +.PP +TrueType font support. These functions allow PPR to generate PostScript fonts from Microsoft compatible TrueType font files. +.PP +The functions in this file do most of the work to convert a TrueType font to a type 3 PostScript font. +.PP +Most of the material in this file is derived from a program called" ttf2ps" which L. S. Ng posted to the usenet news group" comp.sources.postscript". The author did not provide a copyright notice or indicate any restrictions on use. +.PP +Last revised 11 July 1995. +.PP +See also Graphics Classes and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QPrinter::ColorMode" +This enum type is used to indicate whether QPrinter should print in color or not. +.TP +\fCQPrinter::Color\fR - print in color if available, otherwise in grayscale. +.TP +\fCQPrinter::GrayScale\fR - print in grayscale, even on color printers. Might be a little faster than Color. This is the default. +.SH "QPrinter::Orientation" +This enum type (not to be confused with Qt::Orientation) is used to specify each page's orientation. +.TP +\fCQPrinter::Portrait\fR - the page's height is greater than its width (the default). +.TP +\fCQPrinter::Landscape\fR - the page's width is greater than its height. +.PP +This type interacts with QPrinter::PageSize and QPrinter::setFullPage() to determine the final size of the page available to the application. +.SH "QPrinter::PageOrder" +This enum type is used by QPrinter to tell the application program how to print. +.TP +\fCQPrinter::FirstPageFirst\fR - the lowest-numbered page should be printed first. +.TP +\fCQPrinter::LastPageFirst\fR - the highest-numbered page should be printed first. +.SH "QPrinter::PageSize" +This enum type specifies what paper size QPrinter should use. QPrinter does not check that the paper size is available; it just uses this information, together with QPrinter::Orientation and QPrinter::setFullPage(), to determine the printable area (see QPaintDeviceMetrics). +.PP +The defined sizes (with setFullPage(TRUE)) are: +.TP +\fCQPrinter::A0\fR - 841 x 1189 mm This value is not supported on windows. +.TP +\fCQPrinter::A1\fR - 594 x 841 mm This value is not supported on windows. +.TP +\fCQPrinter::A2\fR - 420 x 594 mm +.TP +\fCQPrinter::A3\fR - 297 x 420 mm +.TP +\fCQPrinter::A4\fR - 210 x 297 mm, 8.26 x 11.7 inches +.TP +\fCQPrinter::A5\fR - 148 x 210 mm +.TP +\fCQPrinter::A6\fR - 105 x 148 mm +.TP +\fCQPrinter::A7\fR - 74 x 105 mm +.TP +\fCQPrinter::A8\fR - 52 x 74 mm +.TP +\fCQPrinter::A9\fR - 37 x 52 mm +.TP +\fCQPrinter::B0\fR - 1030 x 1456 mm +.TP +\fCQPrinter::B1\fR - 728 x 1030 mm +.TP +\fCQPrinter::B10\fR - 32 x 45 mm +.TP +\fCQPrinter::B2\fR - 515 x 728 mm +.TP +\fCQPrinter::B3\fR - 364 x 515 mm +.TP +\fCQPrinter::B4\fR - 257 x 364 mm +.TP +\fCQPrinter::B5\fR - 182 x 257 mm, 7.17 x 10.13 inches +.TP +\fCQPrinter::B6\fR - 128 x 182 mm +.TP +\fCQPrinter::B7\fR - 91 x 128 mm +.TP +\fCQPrinter::B8\fR - 64 x 91 mm +.TP +\fCQPrinter::B9\fR - 45 x 64 mm +.TP +\fCQPrinter::C5E\fR - 163 x 229 mm +.TP +\fCQPrinter::Comm10E\fR - 105 x 241 mm, US Common #10 Envelope +.TP +\fCQPrinter::DLE\fR - 110 x 220 mm +.TP +\fCQPrinter::Executive\fR - 7.5 x 10 inches, 191 x 254 mm +.TP +\fCQPrinter::Folio\fR - 210 x 330 mm +.TP +\fCQPrinter::Ledger\fR - 432 x 279 mm +.TP +\fCQPrinter::Legal\fR - 8.5 x 14 inches, 216 x 356 mm +.TP +\fCQPrinter::Letter\fR - 8.5 x 11 inches, 216 x 279 mm +.TP +\fCQPrinter::Tabloid\fR - 279 x 432 mm +.TP +\fCQPrinter::Custom\fR +.TP +\fCQPrinter::NPageSize\fR - (internal) +.PP +With setFullPage(FALSE) (the default), the metrics will be a bit smaller; how much depends on the printer in use. +.SH "QPrinter::PaperSource" +This enum type specifies what paper source QPrinter is to use. QPrinter does not check that the paper source is available; it just uses this information to try and set the paper source. Whether it will set the paper source depends on whether the printer has that particular source. +.PP +Note: this is currently only implemented for Windows. +.TP +\fCQPrinter::OnlyOne\fR +.TP +\fCQPrinter::Lower\fR +.TP +\fCQPrinter::Middle\fR +.TP +\fCQPrinter::Manual\fR +.TP +\fCQPrinter::Envelope\fR +.TP +\fCQPrinter::EnvelopeManual\fR +.TP +\fCQPrinter::Auto\fR +.TP +\fCQPrinter::Tractor\fR +.TP +\fCQPrinter::SmallFormat\fR +.TP +\fCQPrinter::LargeFormat\fR +.TP +\fCQPrinter::LargeCapacity\fR +.TP +\fCQPrinter::Cassette\fR +.TP +\fCQPrinter::FormSource\fR +.SH "QPrinter::PrintRange" +This enum is used to specify which print range the application should use to print. +.TP +\fCQPrinter::AllPages\fR - All pages should be printed +.TP +\fCQPrinter::Selection\fR - Only the selection should be printed. +.TP +\fCQPrinter::PageRange\fR - From page, to page option. +.PP +See also setPrintRange() and printRange(). +.SH "QPrinter::PrinterMode" +This enum describes the mode the printer should work in. It basically presets a certain resolution and working mode. +.TP +\fCQPrinter::ScreenResolution\fR - Sets the resolution of the print device to the screen resolution. This has the big advantage that the results obtained when painting on the printer will match more or less exactly the visible output on the screen. It is the easiest to use, as font metrics on the screen and on the printer are the same. This is the default value. ScreenResolution will produce a lower quality output than HighResolution and should only be used for drafts. +.TP +\fCQPrinter::PrinterResolution\fR - Use the physical resolution of the printer on Windows. On Unix, set the postscript resolution to 72 dpi. +.TP +\fCQPrinter::HighResolution\fR - Use printer resolution on windows, set the resolution of the postscript driver to 600dpi. +.TP +\fCQPrinter::Compatible\fR - Almost the same as PrinterResolution, but keeps some peculiarities of the Qt 2.x printer driver. This is useful for applications ported from Qt 2.x to Qt 3.x. +.SH "QPrinter::PrinterOption" +This enum describes various printer options that appear in the printer setup dialog. It is used to enable and disable these options in the setup dialog. +.TP +\fCQPrinter::PrintToFile\fR - Describes if print to file should be enabled. +.TP +\fCQPrinter::PrintSelection\fR - Describes if printing selections should be enabled. +.TP +\fCQPrinter::PrintPageRange\fR - Describes if printing page ranges (from, to) should be enabled +.PP +See also setOptionEnabled() and isOptionEnabled(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPrinter::QPrinter ( PrinterMode m = ScreenResolution )" +Constructs a printer paint device with mode \fIm\fR. +.PP +See also QPrinter::PrinterMode. +.SH "QPrinter::~QPrinter ()" +Destroys the printer paint device and cleans up. +.SH "bool QPrinter::abort ()" +Aborts the print job. Returns TRUE if successful; otherwise returns FALSE. +.PP +See also aborted(). +.SH "bool QPrinter::aborted () const" +Returns TRUE if the print job was aborted; otherwise returns FALSE. +.PP +See also abort(). +.SH "ColorMode QPrinter::colorMode () const" +Returns the current color mode. The default color mode is Color. +.PP +See also setColorMode(). +.SH "QString QPrinter::creator () const" +Returns the name of the application that created the document. +.PP +See also setCreator(). +.SH "QString QPrinter::docName () const" +Returns the document name. +.PP +See also setDocName(). +.SH "int QPrinter::fromPage () const" +Returns the from-page setting. The default value is 0. +.PP +If fromPage() and toPage() both return 0 this signifies 'print the whole document'. +.PP +The programmer is responsible for reading this setting and printing accordingly. +.PP +See also setFromTo() and toPage(). +.SH "bool QPrinter::fullPage () const" +Returns TRUE if the origin of the printer's coordinate system is at the corner of the sheet and FALSE if it is at the edge of the printable area. +.PP +See setFullPage() for details and caveats. +.PP +See also setFullPage(), PageSize, and QPaintDeviceMetrics. +.SH "bool QPrinter::isOptionEnabled ( PrinterOption option )" +Returns TRUE if the printer option with identifier \fIoption\fR is enabled; otherwise returns FALSE. +.PP +See also setOptionEnabled(). +.SH "QSize QPrinter::margins () const" +Returns the width of the left margin and the height of the top margin of the printer. On Unix, this is a best-effort guess, not based on perfect knowledge. +.PP +If you have called setFullPage( TRUE ), margins().width() may be treated as the smallest sane left margin you can use, and margins().height() as the smallest sane top margin you can use. +.PP +If you have called setFullPage( FALSE ) (this is the default), margins() is automatically subtracted from the pageSize() by QPrinter. +.PP +See also setFullPage(), QPaintDeviceMetrics, and PageSize. +.SH "void QPrinter::margins ( uint * top, uint * left, uint * bottom, uint * right ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets \fItop\fR, \fIleft\fR, \fIbottom\fR and \fIright\fR to the margins of the printer. On Unix, this is a best-effort guess, not based on perfect knowledge. +.PP +If you have called setFullPage( TRUE ), the four values specify the smallest sane margins you can use. +.PP +If you have called setFullPage( FALSE ) (this is the default), the margins are automatically subtracted from the pageSize() by QPrinter. +.PP +See also setFullPage(), QPaintDeviceMetrics, and PageSize. +.SH "int QPrinter::maxPage () const" +Returns the max-page setting. A user can't choose a higher page number than maxPage() when they select a print range. The default value is 0. +.PP +See also minPage(), setMinMax(), and setFromTo(). +.SH "int QPrinter::minPage () const" +Returns the min-page setting, i.e. the lowest page number a user is allowed to choose. The default value is 0. +.PP +See also maxPage(), setMinMax(), and setFromTo(). +.SH "bool QPrinter::newPage ()" +Advances to a new page on the printer. Returns TRUE if successful; otherwise returns FALSE. +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "int QPrinter::numCopies () const" +Returns the number of copies to be printed. The default value is 1. +.PP +This value will return the number of times the application is required to print in order to match the number specified in the printer setup dialog. This has been done since some printer drivers are not capable of buffering up the copies and the application in those cases have to make an explicit call to the print code for each copy. +.PP +See also setNumCopies(). +.SH "Orientation QPrinter::orientation () const" +Returns the orientation setting. The default value is QPrinter::Portrait. +.PP +See also setOrientation(). +.SH "QString QPrinter::outputFileName () const" +Returns the name of the output file. There is no default file name. +.PP +See also setOutputFileName() and setOutputToFile(). +.SH "bool QPrinter::outputToFile () const" +Returns TRUE if the output should be written to a file, or FALSE if the output should be sent directly to the printer. The default setting is FALSE. +.PP +This function is currently only supported under X11 and Mac OS X. +.PP +See also setOutputToFile() and setOutputFileName(). +.SH "PageOrder QPrinter::pageOrder () const" +Returns the current page order. +.PP +The default page order is FirstPageFirst. +.PP +Bugs and limitations: +.TP +This value is not kept in sync with the Windows or Mac OS X printer dialogs. +.SH "PageSize QPrinter::pageSize () const" +Returns the printer page size. The default value is system-dependent. +.PP +See also setPageSize(). +.SH "PaperSource QPrinter::paperSource () const" +Returns the currently set paper source of the printer. +.PP +See also setPaperSource(). +.SH "QString QPrinter::printProgram () const" +Returns the name of the program that sends the print output to the printer. +.PP +The default is to return a null string; meaning that QPrinter will try to be smart in a system-dependent way. On X11 only, you can set it to something different to use a specific print program. +.PP +On Windows, this function returns the name of the printer device driver. +.PP +See also setPrintProgram() and setPrinterSelectionOption(). +.SH "PrintRange QPrinter::printRange () const" +Returns the PageRange of the QPrinter. After the print setup dialog has been opened, this function returns the value selected by the user. +.PP +See also setPrintRange(). +.SH "QString QPrinter::printerName () const" +Returns the printer name. This value is initially set to the name of the default printer. +.PP +See also setPrinterName(). +.SH "QString QPrinter::printerSelectionOption () const" +Returns the printer options selection string. This is useful only if the print command has been explicitly set. +.PP +The default value (a null string) implies that the printer should be selected in a system-dependent manner. +.PP +Any other value implies that the given value should be used. +.PP +See also setPrinterSelectionOption(). +.SH "int QPrinter::resolution () const\fC [virtual]\fR" +Returns the current assumed resolution of the printer, as set by setResolution() or by the printer subsystem. +.PP +See also setResolution(). +.SH "void QPrinter::setColorMode ( ColorMode newColorMode )\fC [virtual]\fR" +Sets the printer's color mode to \fInewColorMode\fR, which can be either Color or GrayScale (the default). +.PP +See also colorMode(). +.SH "void QPrinter::setCreator ( const QString & creator )\fC [virtual]\fR" +Sets the name of the application that created the document to \fIcreator\fR. +.PP +This function is only applicable to the X11 version of Qt. If no creator name is specified, the creator will be set to "Qt" followed by some version number. +.PP +See also creator(). +.SH "void QPrinter::setDocName ( const QString & name )\fC [virtual]\fR" +Sets the document name to \fIname\fR. +.SH "void QPrinter::setFromTo ( int fromPage, int toPage )\fC [virtual]\fR" +Sets the from-page and to-page settings to \fIfromPage\fR and \fItoPage\fR respectively. +.PP +The from-page and to-page settings specify what pages to print. +.PP +If fromPage() and toPage() both return 0 this signifies 'print the whole document'. +.PP +This function is useful mostly to set a default value that the user can override in the print dialog when you call setup(). +.PP +See also fromPage(), toPage(), setMinMax(), and setup(). +.SH "void QPrinter::setFullPage ( bool fp )\fC [virtual]\fR" +Sets QPrinter to have the origin of the coordinate system at the top-left corner of the paper if \fIfp\fR is TRUE, or where it thinks the top-left corner of the printable area is if \fIfp\fR is FALSE. +.PP +The default is FALSE. You can (probably) print on (0,0), and QPaintDeviceMetrics will report something smaller than the size indicated by PageSize. (Note that QPrinter may be wrong on Unix systems - it does not have perfect knowledge of the physical printer.) +.PP +If you set \fIfp\fR to TRUE, QPaintDeviceMetrics will report the exact same size as indicated by PageSize, but you cannot print on all of that - you must take care of the output margins yourself. +.PP +See also PageSize, setPageSize(), QPaintDeviceMetrics, and fullPage(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "void QPrinter::setMargins ( uint top, uint left, uint bottom, uint right )" +Sets the printer margins to the sizes specified in \fItop\fR, \fIleft\fR, \fIbottom\fR and \fIright\fR. +.PP +This function currently only has an effect on Unix systems. +.PP +See also margins(). +.SH "void QPrinter::setMinMax ( int minPage, int maxPage )\fC [virtual]\fR" +Sets the min-page and max-page settings to \fIminPage\fR and \fImaxPage\fR respectively. +.PP +The min-page and max-page restrict the from-page and to-page settings. When the printer setup dialog appears, the user cannot select a from page or a to page that are outside the range specified by min and max pages. +.PP +See also minPage(), maxPage(), setFromTo(), and setup(). +.SH "void QPrinter::setNumCopies ( int numCopies )\fC [virtual]\fR" +Sets the number of copies to be printed to \fInumCopies\fR. +.PP +The printer driver reads this setting and prints the specified number of copies. +.PP +See also numCopies() and setup(). +.SH "void QPrinter::setOptionEnabled ( PrinterOption option, bool enable )" +Enables the printer option with the identifier \fIoption\fR if \fIenable\fR is TRUE, and disables option \fIoption\fR if \fIenable\fR is FALSE. +.PP +See also isOptionEnabled(). +.SH "void QPrinter::setOrientation ( Orientation orientation )\fC [virtual]\fR" +Sets the print orientation to \fIorientation\fR. +.PP +The orientation can be either QPrinter::Portrait or QPrinter::Landscape. +.PP +The printer driver reads this setting and prints using the specified orientation. On Windows this setting won't take effect until the printer dialog is shown (using QPrinter::setup()). +.PP +Windows only! This option can be changed while printing and will take effect from the next call to newPage() +.PP +See also orientation(). +.SH "void QPrinter::setOutputFileName ( const QString & fileName )\fC [virtual]\fR" +Sets the name of the output file to \fIfileName\fR. +.PP +Setting a null or empty name (0 or "") disables output to a file, i.e. calls setOutputToFile(FALSE). Setting a non-empty name enables output to a file, i.e. calls setOutputToFile(TRUE). +.PP +This function is currently only supported under X11. +.PP +See also outputFileName() and setOutputToFile(). +.SH "void QPrinter::setOutputToFile ( bool enable )\fC [virtual]\fR" +Specifies whether the output should be written to a file or sent directly to the printer. +.PP +Will output to a file if \fIenable\fR is TRUE, or will output directly to the printer if \fIenable\fR is FALSE. +.PP +This function is currently only supported under X11 and Mac OS X. +.PP +See also outputToFile() and setOutputFileName(). +.SH "void QPrinter::setPageOrder ( PageOrder newPageOrder )\fC [virtual]\fR" +Sets the page order to \fInewPageOrder\fR. +.PP +The page order can be QPrinter::FirstPageFirst or QPrinter::LastPageFirst. The application programmer is responsible for reading the page order and printing accordingly. +.PP +This function is useful mostly for setting a default value that the user can override in the print dialog when you call setup(). +.PP +Bugs and limitations: +.TP +This value is not kept in sync with the Windows or Mac OS X printer dialogs. +.SH "void QPrinter::setPageSize ( PageSize newPageSize )\fC [virtual]\fR" +Sets the printer page size to \fInewPageSize\fR if that size is supported. The result if undefined if \fInewPageSize\fR is not supported. +.PP +The default page size is system-dependent. +.PP +This function is useful mostly for setting a default value that the user can override in the print dialog when you call setup(). +.PP +See also pageSize(), PageSize, setFullPage(), and setResolution(). +.SH "void QPrinter::setPaperSource ( PaperSource source )\fC [virtual]\fR" +Sets the paper source setting to \fIsource\fR. +.PP +Windows only! This option can be changed while printing and will take effect from the next call to newPage() +.PP +See also paperSource(). +.SH "void QPrinter::setPrintProgram ( const QString & printProg )\fC [virtual]\fR" +Sets the name of the program that should do the print job to \fIprintProg\fR. +.PP +On X11, this function sets the program to call with the PostScript output. On other platforms, it has no effect. +.PP +See also printProgram(). +.SH "void QPrinter::setPrintRange ( PrintRange range )" +Sets the default selected page range to be used when the print setup dialog is opened to \fIrange\fR. If the PageRange specified by \fIrange\fR is currently disabled the function does nothing. +.PP +See also printRange(). +.SH "void QPrinter::setPrinterName ( const QString & name )\fC [virtual]\fR" +Sets the printer name to \fIname\fR. +.PP +The default printer will be used if no printer name is set. +.PP +Under X11, the \fCPRINTER\fR environment variable defines the default printer. Under any other window system, the window system defines the default printer. +.PP +See also printerName(). +.SH "void QPrinter::setPrinterSelectionOption ( const QString & option )\fC [virtual]\fR" +Sets the printer to use \fIoption\fR to select the printer. \fIoption\fR is null by default (which implies that Qt should be smart enough to guess correctly), but it can be set to other values to use a specific printer selection option. +.PP +If the printer selection option is changed while the printer is active, the current print job may or may not be affected. +.PP +See also printerSelectionOption(). +.SH "void QPrinter::setResolution ( int dpi )\fC [virtual]\fR" +Requests that the printer prints at \fIdpi\fR or as near to \fIdpi\fR as possible. +.PP +This setting affects the coordinate system as returned by, for example, QPaintDeviceMetrics and QPainter::viewport(). +.PP +The value depends on the \fCPrintingMode\fR used in the QPrinter constructor. By default, the dpi value of the screen is used. +.PP +This function must be called before setup() to have an effect on all platforms. +.PP +See also resolution() and setPageSize(). +.SH "void QPrinter::setWinPageSize ( short winPageSize )" +Windows only, using this function is not portable! Sets the windows page size value that is used by the \fCDEVMODE\fR struct. The \fIwinPageSize\fR value must be one of the DMPAPER_ defines from wingdi.h. +.SH "bool QPrinter::setup ( QWidget * parent = 0 )" +Opens a printer setup dialog, with parent \fIparent\fR, and asks the user to specify which printer they wish to use and what settings it should have. +.PP +Returns TRUE if the user pressed "OK" to print, or FALSE if the user canceled the operation. +.PP +Examples: +.)l action/application.cpp, application/application.cpp, drawdemo/drawdemo.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "int QPrinter::toPage () const" +Returns the to-page setting. The default value is 0. +.PP +If fromPage() and toPage() both return 0 this signifies 'print the whole document'. +.PP +The programmer is responsible for reading this setting and printing accordingly. +.PP +See also setFromTo() and fromPage(). +.SH "short QPrinter::winPageSize () const" +Returns the Windows page size value as used by the \fCDEVMODE\fR struct (Windows only). Using this function is not portable. +.PP +Use pageSize() to get the PageSize, e.g. 'A4', 'Letter', etc. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqprinter.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqprinter.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqprocess.3qt b/doc/man/man3/tqprocess.3qt new file mode 100644 index 000000000..fa0b3fea7 --- /dev/null +++ b/doc/man/man3/tqprocess.3qt @@ -0,0 +1,521 @@ +'\" t +.TH QProcess 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 +QProcess \- Used to start external programs and to communicate with them +.SH SYNOPSIS +\fC#include <ntqprocess.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQProcess\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQProcess\fR ( const QString & arg0, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQProcess\fR ( const QStringList & args, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QProcess\fR ()" +.br +.ti -1c +.BI "QStringList \fBarguments\fR () const" +.br +.ti -1c +.BI "void \fBclearArguments\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetArguments\fR ( const QStringList & args )" +.br +.ti -1c +.BI "virtual void \fBaddArgument\fR ( const QString & arg )" +.br +.ti -1c +.BI "QDir \fBworkingDirectory\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetWorkingDirectory\fR ( const QDir & dir )" +.br +.ti -1c +.BI "enum \fBCommunication\fR { Stdin = 0x01, Stdout = 0x02, Stderr = 0x04, DupStderr = 0x08 }" +.br +.ti -1c +.BI "void \fBsetCommunication\fR ( int commFlags )" +.br +.ti -1c +.BI "int \fBcommunication\fR () const" +.br +.ti -1c +.BI "virtual bool \fBstart\fR ( QStringList * env = 0 )" +.br +.ti -1c +.BI "virtual bool \fBlaunch\fR ( const QString & buf, QStringList * env = 0 )" +.br +.ti -1c +.BI "virtual bool \fBlaunch\fR ( const QByteArray & buf, QStringList * env = 0 )" +.br +.ti -1c +.BI "bool \fBisRunning\fR () const" +.br +.ti -1c +.BI "bool \fBnormalExit\fR () const" +.br +.ti -1c +.BI "int \fBexitStatus\fR () const" +.br +.ti -1c +.BI "virtual QByteArray \fBreadStdout\fR ()" +.br +.ti -1c +.BI "virtual QByteArray \fBreadStderr\fR ()" +.br +.ti -1c +.BI "bool \fBcanReadLineStdout\fR () const" +.br +.ti -1c +.BI "bool \fBcanReadLineStderr\fR () const" +.br +.ti -1c +.BI "virtual QString \fBreadLineStdout\fR ()" +.br +.ti -1c +.BI "virtual QString \fBreadLineStderr\fR ()" +.br +.ti -1c +.BI "PID \fBprocessIdentifier\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBtryTerminate\fR () const" +.br +.ti -1c +.BI "void \fBkill\fR () const" +.br +.ti -1c +.BI "virtual void \fBwriteToStdin\fR ( const QByteArray & buf )" +.br +.ti -1c +.BI "virtual void \fBwriteToStdin\fR ( const QString & buf )" +.br +.ti -1c +.BI "virtual void \fBcloseStdin\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBreadyReadStdout\fR ()" +.br +.ti -1c +.BI "void \fBreadyReadStderr\fR ()" +.br +.ti -1c +.BI "void \fBprocessExited\fR ()" +.br +.ti -1c +.BI "void \fBwroteToStdin\fR ()" +.br +.ti -1c +.BI "void \fBlaunchFinished\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QProcess class is used to start external programs and to communicate with them. +.PP +You can write to the started program's standard input, and can read the program's standard output and standard error. You can pass command line arguments to the program either in the constructor or with setArguments() or addArgument(). The program's working directory can be set with setWorkingDirectory(). If you need to set up environment variables pass them to the start() or launch() functions (see below). The processExited() signal is emitted if the program exits. The program's exit status is available from exitStatus(), although you could simply call normalExit() to see if the program terminated normally. +.PP +There are two different ways to start a process. If you just want to run a program, optionally passing data to its standard input at the beginning, use one of the launch() functions. If you want full control of the program's standard input (especially if you don't know all the data you want to send to standard input at the beginning), use the start() function. +.PP +If you use start() you can write to the program's standard input using writeToStdin() and you can close the standard input with closeStdin(). The wroteToStdin() signal is emitted if the data sent to standard input has been written. You can read from the program's standard output using readStdout() or readLineStdout(). These functions return an empty QByteArray if there is no data to read. The readyReadStdout() signal is emitted when there is data available to be read from standard output. Standard error has a set of functions that correspond to the standard output functions, i.e. readStderr(), readLineStderr() and readyReadStderr(). +.PP +If you use one of the launch() functions the data you pass will be sent to the program's standard input which will be closed once all the data has been written. You should \fInot\fR use writeToStdin() or closeStdin() if you use launch(). If you need to send data to the program's standard input after it has started running use start() instead of launch(). +.PP +Both start() and launch() can accept a string list of strings each of which has the format, key=value, where the keys are the names of environment variables. +.PP +You can test to see if a program is running with isRunning(). The program's process identifier is available from processIdentifier(). If you want to terminate a running program use tryTerminate(), but note that the program may ignore this. If you \fIreally\fR want to terminate the program, without it having any chance to clean up, you can use kill(). +.PP +As an example, suppose we want to start the \fCuic\fR command (a Qt command line tool used with \fIQt Designer\fR) and perform some operations on the output (the \fCuic\fR outputs the code it generates to standard output by default). Suppose further that we want to run the program on the file "small_dialog.ui" with the command line options "-tr i18n". On the command line we would write: +.PP +.nf +.br + uic -tr i18n small_dialog.ui +.br +.fi +.PP +A code snippet for this with the QProcess class might look like this: +.PP +.nf +.br + UicManager::UicManager() +.br + { +.fi +.PP +.nf +.br + proc = new QProcess( this ); +.fi +.PP +.nf +.br + proc->addArgument( "uic" ); +.br + proc->addArgument( "-tr" ); +.br + proc->addArgument( "i18n" ); +.br + proc->addArgument( "small_dialog.ui" ); +.br +.br + connect( proc, SIGNAL(readyReadStdout()), +.br + this, SLOT(readFromStdout()) ); +.fi +.PP +.nf +.br + if ( !proc->start() ) { +.br + // error handling +.fi +.PP +.nf +.br + } +.br + } +.fi +.PP +.nf +.br + void UicManager::readFromStdout() +.br + { +.br + // Read and process the data. +.br + // Bear in mind that the data might be output in chunks. +.fi +.PP +.nf +.br + } +.fi +.PP +Although you may need quotes for a file named on the command line (e.g. if it contains spaces) you shouldn't use extra quotes for arguments passed to addArgument() or setArguments(). +.PP +The readyReadStdout() signal is emitted when there is new data on standard output. This happens asynchronously: you don't know if more data will arrive later. +.PP +In the above example you could connect the processExited() signal to the slot UicManager::readFromStdout() instead. If you do so, you will be certain that all the data is available when the slot is called. On the other hand, you must wait until the process has finished before doing any processing. +.PP +Note that if you are expecting a lot of output from the process, you may hit platform-dependent limits to the pipe buffer size. The solution is to make sure you connect to the output, e.g. the readyReadStdout() and readyReadStderr() signals and read the data as soon as it becomes available. +.PP +Please note that QProcess does not emulate a shell. This means that QProcess does not do any expansion of arguments: a '*' is passed as a '*' to the program and is \fInot\fR replaced by all the files, a '$HOME' is also passed literally and is \fInot\fR replaced by the environment variable HOME and the special characters for IO redirection ('>', '|', etc.) are also passed literally and do \fInot\fR have the special meaning as they have in a shell. +.PP +Also note that QProcess does not emulate a terminal. This means that certain programs which need direct terminal control, do not work as expected with QProcess. Such programs include console email programs (like pine and mutt) but also programs which require the user to enter a password (like su and ssh). +.SH "Notes for Windows users" +Some Windows commands, for example, \fCdir\fR, are not provided by separate applications, but by the command interpreter. If you attempt to use QProcess to execute these commands directly it won't work. One possible solution is to execute the command interpreter itself (\fCcmd.exe\fR on some Windows systems), and ask the interpreter to execute the desired command. +.PP +Under Windows there are certain problems starting 16-bit applications and capturing their output. Microsoft recommends using an intermediate application to start 16-bit applications. +.PP +See also QSocket, Input/Output and Networking, and Miscellaneous Classes. +.SS "Member Type Documentation" +.SH "QProcess::Communication" +This enum type defines the communication channels connected to the process. +.TP +\fCQProcess::Stdin\fR - Data can be written to the process's standard input. +.TP +\fCQProcess::Stdout\fR - Data can be read from the process's standard output. +.TP +\fCQProcess::Stderr\fR - Data can be read from the process's standard error. +.TP +\fCQProcess::DupStderr\fR - Both the process's standard error output \fIand\fR its standard output are written to its standard output. (Like Unix's dup2().) This means that nothing is sent to the standard error output. This is especially useful if your application requires that the output on standard output and on standard error must be read in the same order that they are produced. This is a flag, so to activate it you must pass \fCStdout|Stderr|DupStderr\fR, or \fCStdin|Stdout|Stderr|DupStderr\fR if you want to provide input, to the setCommunication() call. +.PP +See also setCommunication() and communication(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QProcess::QProcess ( QObject * parent = 0, const char * name = 0 )" +Constructs a QProcess object. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. +.PP +See also setArguments(), addArgument(), and start(). +.SH "QProcess::QProcess ( const QString & arg0, QObject * parent = 0, const char * name = 0 )" +Constructs a QProcess with \fIarg0\fR as the command to be executed. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. +.PP +The process is not started. You must call start() or launch() to start the process. +.PP +See also setArguments(), addArgument(), and start(). +.SH "QProcess::QProcess ( const QStringList & args, QObject * parent = 0, const char * name = 0 )" +Constructs a QProcess with \fIargs\fR as the arguments of the process. The first element in the list is the command to be executed. The other elements in the list are the arguments to this command. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor. +.PP +The process is not started. You must call start() or launch() to start the process. +.PP +See also setArguments(), addArgument(), and start(). +.SH "QProcess::~QProcess ()" +Destroys the instance. +.PP +If the process is running, it is \fBnot\fR terminated! The standard input, standard output and standard error of the process are closed. +.PP +You can connect the destroyed() signal to the kill() slot, if you want the process to be terminated automatically when the instance is destroyed. +.PP +See also tryTerminate() and kill(). +.SH "void QProcess::addArgument ( const QString & arg )\fC [virtual]\fR" +Adds \fIarg\fR to the end of the list of arguments. +.PP +The first element in the list of arguments is the command to be executed; the following elements are the command's arguments. +.PP +See also arguments() and setArguments(). +.PP +Example: process/process.cpp. +.SH "QStringList QProcess::arguments () const" +Returns the list of arguments that are set for the process. Arguments can be specified with the constructor or with the functions setArguments() and addArgument(). +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myProcess.arguments(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also setArguments() and addArgument(). +.SH "bool QProcess::canReadLineStderr () const" +Returns TRUE if it's possible to read an entire line of text from standard error at this time; otherwise returns FALSE. +.PP +See also readLineStderr() and canReadLineStdout(). +.SH "bool QProcess::canReadLineStdout () const" +Returns TRUE if it's possible to read an entire line of text from standard output at this time; otherwise returns FALSE. +.PP +See also readLineStdout() and canReadLineStderr(). +.SH "void QProcess::clearArguments ()" +Clears the list of arguments that are set for the process. +.PP +See also setArguments() and addArgument(). +.SH "void QProcess::closeStdin ()\fC [virtual slot]\fR" +Closes the process's standard input. +.PP +This function also deletes any pending data that has not been written to standard input. +.PP +See also wroteToStdin(). +.SH "int QProcess::communication () const" +Returns the communication required with the process, i.e. some combination of the Communication flags. +.PP +See also setCommunication(). +.SH "int QProcess::exitStatus () const" +Returns the exit status of the process or 0 if the process is still running. This function returns immediately and does not wait until the process is finished. +.PP +If normalExit() is FALSE (e.g. if the program was killed or crashed), this function returns 0, so you should check the return value of normalExit() before relying on this value. +.PP +See also normalExit() and processExited(). +.SH "bool QProcess::isRunning () const" +Returns TRUE if the process is running; otherwise returns FALSE. +.PP +See also normalExit(), exitStatus(), and processExited(). +.SH "void QProcess::kill () const\fC [slot]\fR" +Terminates the process. This is not a safe way to end a process since the process will not be able to do any cleanup. tryTerminate() is safer, but processes can ignore a tryTerminate(). +.PP +The nice way to end a process and to be sure that it is finished, is to do something like this: +.PP +.nf +.br + process->tryTerminate(); +.br + QTimer::singleShot( 5000, process, SLOT( kill() ) ); +.br +.fi +.PP +This tries to terminate the process the nice way. If the process is still running after 5 seconds, it terminates the process the hard way. The timeout should be chosen depending on the time the process needs to do all its cleanup: use a higher value if the process is likely to do a lot of computation or I/O on cleanup. +.PP +The slot returns immediately: it does not wait until the process has finished. When the process terminates, the processExited() signal is emitted. +.PP +See also tryTerminate() and processExited(). +.SH "bool QProcess::launch ( const QByteArray & buf, QStringList * env = 0 )\fC [virtual]\fR" +Runs the process and writes the data \fIbuf\fR to the process's standard input. If all the data is written to standard input, standard input is closed. The command is searched for in the path for executable programs; you can also use an absolute path in the command itself. +.PP +If \fIenv\fR is null, then the process is started with the same environment as the starting process. If \fIenv\fR is non-null, then the values in the string list are interpreted as environment setttings of the form \fCkey=value\fR and the process is started with these environment settings. For convenience, there is a small exception to this rule under Unix: if \fIenv\fR does not contain any settings for the environment variable \fCLD_LIBRARY_PATH\fR, then this variable is inherited from the starting process. +.PP +Returns TRUE if the process could be started; otherwise returns FALSE. +.PP +Note that you should not use the slots writeToStdin() and closeStdin() on processes started with launch(), since the result is not well-defined. If you need these slots, use start() instead. +.PP +The process may or may not read the \fIbuf\fR data sent to its standard input. +.PP +You can call this function even when a process that was started with this instance is still running. Be aware that if you do this the standard input of the process that was launched first will be closed, with any pending data being deleted, and the process will be left to run out of your control. Similarly, if the process could not be started the standard input will be closed and the pending data deleted. (On operating systems that have zombie processes, Qt will also wait() on the old process.) +.PP +The object emits the signal launchFinished() when this function call is finished. If the start was successful, this signal is emitted after all the data has been written to standard input. If the start failed, then this signal is emitted immediately. +.PP +See also start() and launchFinished(). +.SH "bool QProcess::launch ( const QString & buf, QStringList * env = 0 )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The data \fIbuf\fR is written to standard input with writeToStdin() using the QString::local8Bit() representation of the strings. +.SH "void QProcess::launchFinished ()\fC [signal]\fR" +This signal is emitted when the process was started with launch(). If the start was successful, this signal is emitted after all the data has been written to standard input. If the start failed, then this signal is emitted immediately. +.PP +This signal is especially useful if you want to know when you can safely delete the QProcess object when you are not interested in reading from standard output or standard error. +.PP +See also launch() and QObject::deleteLater(). +.SH "bool QProcess::normalExit () const" +Returns TRUE if the process has exited normally; otherwise returns FALSE. This implies that this function returns FALSE if the process is still running. +.PP +See also isRunning(), exitStatus(), and processExited(). +.SH "void QProcess::processExited ()\fC [signal]\fR" +This signal is emitted when the process has exited. +.PP +See also isRunning(), normalExit(), exitStatus(), start(), and launch(). +.PP +Example: process/process.cpp. +.SH "PID QProcess::processIdentifier ()" +Returns platform dependent information about the process. This can be used together with platform specific system calls. +.PP +Under Unix the return value is the PID of the process, or -1 if no process belongs to this object. +.PP +Under Windows it is a pointer to the \fCPROCESS_INFORMATION\fR struct, or 0 if no process is belongs to this object. +.PP +Use of this function's return value is likely to be non-portable. +.SH "QString QProcess::readLineStderr ()\fC [virtual]\fR" +Reads a line of text from standard error, excluding any trailing newline or carriage return characters and returns it. Returns QString::null if canReadLineStderr() returns FALSE. +.PP +By default, the text is interpreted to be in Latin-1 encoding. If you need other codecs, you can set a different codec with QTextCodec::setCodecForCStrings(). +.PP +See also canReadLineStderr(), readyReadStderr(), readStderr(), and readLineStdout(). +.SH "QString QProcess::readLineStdout ()\fC [virtual]\fR" +Reads a line of text from standard output, excluding any trailing newline or carriage return characters, and returns it. Returns QString::null if canReadLineStdout() returns FALSE. +.PP +By default, the text is interpreted to be in Latin-1 encoding. If you need other codecs, you can set a different codec with QTextCodec::setCodecForCStrings(). +.PP +See also canReadLineStdout(), readyReadStdout(), readStdout(), and readLineStderr(). +.SH "QByteArray QProcess::readStderr ()\fC [virtual]\fR" +Reads the data that the process has written to standard error. When new data is written to standard error, the class emits the signal readyReadStderr(). +.PP +If there is no data to read, this function returns a QByteArray of size 0: it does not wait until there is something to read. +.PP +See also readyReadStderr(), readLineStderr(), readStdout(), and writeToStdin(). +.SH "QByteArray QProcess::readStdout ()\fC [virtual]\fR" +Reads the data that the process has written to standard output. When new data is written to standard output, the class emits the signal readyReadStdout(). +.PP +If there is no data to read, this function returns a QByteArray of size 0: it does not wait until there is something to read. +.PP +See also readyReadStdout(), readLineStdout(), readStderr(), and writeToStdin(). +.PP +Example: process/process.cpp. +.SH "void QProcess::readyReadStderr ()\fC [signal]\fR" +This signal is emitted when the process has written data to standard error. You can read the data with readStderr(). +.PP +Note that this signal is only emitted when there is new data and not when there is old, but unread data. In the slot connected to this signal, you should always read everything that is available at that moment to make sure that you don't lose any data. +.PP +See also readStderr(), readLineStderr(), and readyReadStdout(). +.SH "void QProcess::readyReadStdout ()\fC [signal]\fR" +This signal is emitted when the process has written data to standard output. You can read the data with readStdout(). +.PP +Note that this signal is only emitted when there is new data and not when there is old, but unread data. In the slot connected to this signal, you should always read everything that is available at that moment to make sure that you don't lose any data. +.PP +See also readStdout(), readLineStdout(), and readyReadStderr(). +.PP +Example: process/process.cpp. +.SH "void QProcess::setArguments ( const QStringList & args )\fC [virtual]\fR" +Sets \fIargs\fR as the arguments for the process. The first element in the list is the command to be executed. The other elements in the list are the arguments to the command. Any previous arguments are deleted. +.PP +QProcess does not perform argument substitutions; for example, if you specify "*" or "$DISPLAY", these values are passed to the process literally. If you want to have the same behavior as the shell provides, you must do the substitutions yourself; i.e. instead of specifying a "*" you must specify the list of all the filenames in the current directory, and instead of "$DISPLAY" you must specify the value of the environment variable \fCDISPLAY\fR. +.PP +Note for Windows users. The standard Windows shells, e.g. \fCcommand.com\fR and \fCcmd.exe\fR, do not perform file globbing, i.e. they do not convert a "*" on the command line into a list of files in the current directory. For this reason most Windows applications implement their own file globbing, and as a result of this, specifying an argument of "*" for a Windows application is likely to result in the application performing a file glob and ending up with a list of filenames. +.PP +See also arguments() and addArgument(). +.SH "void QProcess::setCommunication ( int commFlags )" +Sets \fIcommFlags\fR as the communication required with the process. +.PP +\fIcommFlags\fR is a bitwise OR of the flags defined by the Communication enum. +.PP +The default is \fCStdin|Stdout|Stderr\fR. +.PP +See also communication(). +.SH "void QProcess::setWorkingDirectory ( const QDir & dir )\fC [virtual]\fR" +Sets \fIdir\fR as the working directory for processes. This does not affect running processes; only processes that are started afterwards are affected. +.PP +Setting the working directory is especially useful for processes that try to access files with relative paths. +.PP +See also workingDirectory() and start(). +.SH "bool QProcess::start ( QStringList * env = 0 )\fC [virtual]\fR" +Tries to run a process for the command and arguments that were specified with setArguments(), addArgument() or that were specified in the constructor. The command is searched for in the path for executable programs; you can also use an absolute path in the command itself. +.PP +If \fIenv\fR is null, then the process is started with the same environment as the starting process. If \fIenv\fR is non-null, then the values in the stringlist are interpreted as environment setttings of the form \fCkey=value\fR and the process is started in these environment settings. For convenience, there is a small exception to this rule: under Unix, if \fIenv\fR does not contain any settings for the environment variable \fCLD_LIBRARY_PATH\fR, then this variable is inherited from the starting process; under Windows the same applies for the environment variable \fCPATH\fR. +.PP +Returns TRUE if the process could be started; otherwise returns FALSE. +.PP +You can write data to the process's standard input with writeToStdin(). You can close standard input with closeStdin() and you can terminate the process with tryTerminate(), or with kill(). +.PP +You can call this function even if you've used this instance to create a another process which is still running. In such cases, QProcess closes the old process's standard input and deletes pending data, i.e., you lose all control over the old process, but the old process is not terminated. This applies also if the process could not be started. (On operating systems that have zombie processes, Qt will also wait() on the old process.) +.PP +See also launch() and closeStdin(). +.PP +Example: process/process.cpp. +.SH "void QProcess::tryTerminate () const\fC [slot]\fR" +Asks the process to terminate. Processes can ignore this if they wish. If you want to be certain that the process really terminates, you can use kill() instead. +.PP +The slot returns immediately: it does not wait until the process has finished. When the process terminates, the processExited() signal is emitted. +.PP +See also kill() and processExited(). +.SH "QDir QProcess::workingDirectory () const" +Returns the working directory that was set with setWorkingDirectory(), or the current directory if none has been explicitly set. +.PP +See also setWorkingDirectory() and QDir::current(). +.SH "void QProcess::writeToStdin ( const QByteArray & buf )\fC [virtual slot]\fR" +Writes the data \fIbuf\fR to the process's standard input. The process may or may not read this data. +.PP +This function always returns immediately. The data you pass to writeToStdin() is copied into an internal memory buffer in QProcess, and when control goes back to the event loop, QProcess will starting transferring data from this buffer to the running process. Sometimes the data will be transferred in several payloads, depending on how much data is read at a time by the process itself. When QProcess has transferred all the data from its memory buffer to the running process, it emits wroteToStdin(). +.PP +Note that some operating systems use a buffer to transfer the data. As a result, wroteToStdin() may be emitted before the running process has actually read all the data. +.PP +See also wroteToStdin(), closeStdin(), readStdout(), and readStderr(). +.SH "void QProcess::writeToStdin ( const QString & buf )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The string \fIbuf\fR is handled as text using the QString::local8Bit() representation. +.SH "void QProcess::wroteToStdin ()\fC [signal]\fR" +This signal is emitted if the data sent to standard input (via writeToStdin()) was actually written to the process. This does not imply that the process really read the data, since this class only detects when it was able to write the data to the operating system. But it is now safe to close standard input without losing pending data. +.PP +See also writeToStdin() and closeStdin(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqprocess.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqprocess.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqprogressbar.3qt b/doc/man/man3/tqprogressbar.3qt new file mode 100644 index 000000000..5d616490c --- /dev/null +++ b/doc/man/man3/tqprogressbar.3qt @@ -0,0 +1,238 @@ +'\" t +.TH QProgressBar 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 +QProgressBar \- Horizontal progress bar +.SH SYNOPSIS +\fC#include <ntqprogressbar.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQProgressBar\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQProgressBar\fR ( int totalSteps, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "int \fBtotalSteps\fR () const" +.br +.ti -1c +.BI "int \fBprogress\fR () const" +.br +.ti -1c +.BI "const QString & \fBprogressString\fR () const" +.br +.ti -1c +.BI "void \fBsetCenterIndicator\fR ( bool on )" +.br +.ti -1c +.BI "bool \fBcenterIndicator\fR () const" +.br +.ti -1c +.BI "void \fBsetIndicatorFollowsStyle\fR ( bool )" +.br +.ti -1c +.BI "bool \fBindicatorFollowsStyle\fR () const" +.br +.ti -1c +.BI "bool \fBpercentageVisible\fR () const" +.br +.ti -1c +.BI "void \fBsetPercentageVisible\fR ( bool )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBreset\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetTotalSteps\fR ( int totalSteps )" +.br +.ti -1c +.BI "virtual void \fBsetProgress\fR ( int progress )" +.br +.ti -1c +.BI "void \fBsetProgress\fR ( int progress, int totalSteps )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBcenterIndicator\fR - whether the indicator string should be centered" +.br +.ti -1c +.BI "bool \fBindicatorFollowsStyle\fR - whether the display of the indicator string should follow the GUI style" +.br +.ti -1c +.BI "bool \fBpercentageVisible\fR - whether the current progress value is displayed" +.br +.ti -1c +.BI "int \fBprogress\fR - the current amount of progress" +.br +.ti -1c +.BI "QString \fBprogressString\fR - the amount of progress as a string \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBtotalSteps\fR - the total number of steps" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBsetIndicator\fR ( QString & indicator, int progress, int totalSteps )" +.br +.in -1c +.SH DESCRIPTION +The QProgressBar widget provides a horizontal progress bar. +.PP +A progress bar is used to give the user an indication of the progress of an operation and to reassure them that the application is still running. +.PP +The progress bar uses the concept of \fIsteps\fR; you give it the total number of steps and the number of steps completed so far and it will display the percentage of steps that have been completed. You can specify the total number of steps in the constructor or later with setTotalSteps(). The current number of steps is set with setProgress(). The progress bar can be rewound to the beginning with reset(). +.PP +If the total is given as 0 the progress bar shows a busy indicator instead of a percentage of steps. This is useful, for example, when using QFtp or QHttp to download items when they are unable to determine the size of the item being downloaded. +.PP +See also QProgressDialog, GUI Design Handbook: Progress Indicator, and Advanced Widgets. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QProgressDialog, GUI Design Handbook: Progress Indicator, and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QProgressBar::QProgressBar ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a progress bar. +.PP +The total number of steps is set to 100 by default. +.PP +The \fIparent\fR, \fIname\fR and widget flags, \fIf\fR, are passed on to the QFrame::QFrame() constructor. +.PP +See also totalSteps. +.SH "QProgressBar::QProgressBar ( int totalSteps, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a progress bar. +.PP +The \fItotalSteps\fR is the total number of steps that need to be completed for the operation which this progress bar represents. For example, if the operation is to examine 50 files, this value would be 50. Before examining the first file, call setProgress(0); call setProgress(50) after examining the last file. +.PP +The \fIparent\fR, \fIname\fR and widget flags, \fIf\fR, are passed to the QFrame::QFrame() constructor. +.PP +See also totalSteps and progress. +.SH "bool QProgressBar::centerIndicator () const" +Returns TRUE if the indicator string should be centered; otherwise returns FALSE. See the "centerIndicator" property for details. +.SH "bool QProgressBar::indicatorFollowsStyle () const" +Returns TRUE if the display of the indicator string should follow the GUI style; otherwise returns FALSE. See the "indicatorFollowsStyle" property for details. +.SH "bool QProgressBar::percentageVisible () const" +Returns TRUE if the current progress value is displayed; otherwise returns FALSE. See the "percentageVisible" property for details. +.SH "int QProgressBar::progress () const" +Returns the current amount of progress. See the "progress" property for details. +.SH "const QString & QProgressBar::progressString () const" +Returns the amount of progress as a string. See the "progressString" property for details. +.SH "void QProgressBar::reset ()\fC [slot]\fR" +Reset the progress bar. The progress bar "rewinds" and shows no progress. +.PP +Examples: +.)l fileiconview/mainwindow.cpp and progressbar/progressbar.cpp. +.SH "void QProgressBar::setCenterIndicator ( bool on )" +Sets whether the indicator string should be centered to \fIon\fR. See the "centerIndicator" property for details. +.SH "bool QProgressBar::setIndicator ( QString & indicator, int progress, int totalSteps )\fC [virtual protected]\fR" +This method is called to generate the text displayed in the center (or in some styles, to the left) of the progress bar. +.PP +The \fIprogress\fR may be negative, indicating that the progress bar is in the "reset" state before any progress is set. +.PP +The default implementation is the percentage of completion or blank in the reset state. The percentage is calculated based on the \fIprogress\fR and \fItotalSteps\fR. You can set the \fIindicator\fR text if you wish. +.PP +To allow efficient repainting of the progress bar, this method should return FALSE if the string is unchanged from the last call to this function. +.SH "void QProgressBar::setIndicatorFollowsStyle ( bool )" +Sets whether the display of the indicator string should follow the GUI style. See the "indicatorFollowsStyle" property for details. +.SH "void QProgressBar::setPercentageVisible ( bool )" +Sets whether the current progress value is displayed. See the "percentageVisible" property for details. +.SH "void QProgressBar::setProgress ( int progress )\fC [virtual slot]\fR" +Sets the current amount of progress to \fIprogress\fR. See the "progress" property for details. +.SH "void QProgressBar::setProgress ( int progress, int totalSteps )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the amount of progress to \fIprogress\fR and the total number of steps to \fItotalSteps\fR. +.PP +See also totalSteps. +.SH "void QProgressBar::setTotalSteps ( int totalSteps )\fC [virtual slot]\fR" +Sets the total number of steps to \fItotalSteps\fR. See the "totalSteps" property for details. +.SH "int QProgressBar::totalSteps () const" +Returns the total number of steps. See the "totalSteps" property for details. +.SS "Property Documentation" +.SH "bool centerIndicator" +This property holds whether the indicator string should be centered. +.PP +Changing this property sets QProgressBar::indicatorFollowsStyle to FALSE. The default is TRUE. +.PP +Set this property's value with setCenterIndicator() and get this property's value with centerIndicator(). +.SH "bool indicatorFollowsStyle" +This property holds whether the display of the indicator string should follow the GUI style. +.PP +The default is TRUE. +.PP +See also centerIndicator. +.PP +Set this property's value with setIndicatorFollowsStyle() and get this property's value with indicatorFollowsStyle(). +.SH "bool percentageVisible" +This property holds whether the current progress value is displayed. +.PP +The default is TRUE. +.PP +See also centerIndicator and indicatorFollowsStyle. +.PP +Set this property's value with setPercentageVisible() and get this property's value with percentageVisible(). +.SH "int progress" +This property holds the current amount of progress. +.PP +This property is -1 if progress counting has not started. +.PP +Set this property's value with setProgress() and get this property's value with progress(). +.SH "QString progressString" +This property holds the amount of progress as a string. +.PP +This property is QString::null if progress counting has not started. +.PP +Get this property's value with progressString(). +.SH "int totalSteps" +This property holds the total number of steps. +.PP +If totalSteps is 0, the progress bar will display a busy indicator. +.PP +See also +.PP +Set this property's value with setTotalSteps() and get this property's value with totalSteps(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqprogressbar.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqprogressbar.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqprogressdialog.3qt b/doc/man/man3/tqprogressdialog.3qt new file mode 100644 index 000000000..16a0ae721 --- /dev/null +++ b/doc/man/man3/tqprogressdialog.3qt @@ -0,0 +1,430 @@ +'\" t +.TH QProgressDialog 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 +QProgressDialog \- Feedback on the progress of a slow operation +.SH SYNOPSIS +\fC#include <ntqprogressdialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQProgressDialog\fR ( QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQProgressDialog\fR ( const QString & labelText, const QString & cancelButtonText, int totalSteps, QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QProgressDialog\fR ()" +.br +.ti -1c +.BI "void \fBsetLabel\fR ( QLabel * label )" +.br +.ti -1c +.BI "void \fBsetCancelButton\fR ( QPushButton * cancelButton )" +.br +.ti -1c +.BI "void \fBsetBar\fR ( QProgressBar * bar )" +.br +.ti -1c +.BI "bool wasCancelled () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBwasCanceled\fR () const" +.br +.ti -1c +.BI "int \fBtotalSteps\fR () const" +.br +.ti -1c +.BI "int \fBprogress\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "QString \fBlabelText\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoReset\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBautoReset\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoClose\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBautoClose\fR () const" +.br +.ti -1c +.BI "int \fBminimumDuration\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBcancel\fR ()" +.br +.ti -1c +.BI "void \fBreset\fR ()" +.br +.ti -1c +.BI "void \fBsetTotalSteps\fR ( int totalSteps )" +.br +.ti -1c +.BI "void \fBsetProgress\fR ( int progress )" +.br +.ti -1c +.BI "void \fBsetProgress\fR ( int progress, int totalSteps )" +.br +.ti -1c +.BI "void \fBsetLabelText\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBsetCancelButtonText\fR ( const QString & cancelButtonText )" +.br +.ti -1c +.BI "void \fBsetMinimumDuration\fR ( int ms )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void cancelled () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBcanceled\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoClose\fR - whether the dialog gets hidden by reset()" +.br +.ti -1c +.BI "bool \fBautoReset\fR - whether the progress dialog calls reset() as soon as progress() equals totalSteps()" +.br +.ti -1c +.BI "QString \fBlabelText\fR - the label's text" +.br +.ti -1c +.BI "int \fBminimumDuration\fR - the time that must pass before the dialog appears" +.br +.ti -1c +.BI "int \fBprogress\fR - the current amount of progress made" +.br +.ti -1c +.BI "int \fBtotalSteps\fR - the total number of steps" +.br +.ti -1c +.BI "bool \fBwasCanceled\fR - whether the dialog was canceled \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool wasCancelled - whether the dialog was canceled \fI(read " "only" ")\fR \fI(obsolete)\fR" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "void \fBforceShow\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QProgressDialog class provides feedback on the progress of a slow operation. +.PP +A progress dialog is used to give the user an indication of how long an operation is going to take, and to demonstrate that the application has not frozen. It can also give the user an opportunity to abort the operation. +.PP +A common problem with progress dialogs is that it is difficult to know when to use them; operations take different amounts of time on different hardware. QProgressDialog offers a solution to this problem: it estimates the time the operation will take (based on time for steps), and only shows itself if that estimate is beyond minimumDuration() (4 seconds by default). +.PP +Use setTotalSteps() (or the constructor) to set the number of" steps" in the operation and call setProgress() as the operation progresses. The step value can be chosen arbitrarily. It can be the number of files copied, the number of bytes received, the number of iterations through the main loop of your algorithm, or some other suitable unit. Progress starts at 0, and the progress dialog shows that the operation has finished when you call setProgress() with totalSteps() as its argument. +.PP +The dialog automatically resets and hides itself at the end of the operation. Use setAutoReset() and setAutoClose() to change this behavior. +.PP +There are two ways of using QProgressDialog: modal and modeless. +.PP +Using a modal QProgressDialog is simpler for the programmer, but you must call QApplication::processEvents() or QEventLoop::processEvents(ExcludeUserInput) to keep the event loop running to ensure that the application doesn't freeze. Do the operation in a loop, call setProgress() at intervals, and check for cancellation with wasCanceled(). For example: +.PP +.nf +.br +QProgressDialog progress( "Copying files...", "Abort Copy", numFiles, +.br + this, "progress", TRUE ); +.br +for ( int i = 0; i < numFiles; i++ ) { +.br + progress.setProgress( i ); +.br + tqApp->processEvents(); +.br +.br + if ( progress.wasCanceled() ) +.br + break; +.br + //... copy one file +.br +} +.br +progress.setProgress( numFiles ); +.fi +.PP +A modeless progress dialog is suitable for operations that take place in the background, where the user is able to interact with the application. Such operations are typically based on QTimer (or QObject::timerEvent()), QSocketNotifier, or QUrlOperator; or performed in a separate thread. A QProgressBar in the status bar of your main window is often an alternative to a modeless progress dialog. +.PP +You need to have an event loop to be running, connect the canceled() signal to a slot that stops the operation, and call setProgress() at intervals. For example: +.PP +.nf +.br +Operation::Operation( QObject *parent = 0 ) +.br + : QObject( parent ), steps( 0 ) +.br +{ +.br + pd = new QProgressDialog( "Operation in progress.", "Cancel", 100 ); +.br + connect( pd, SIGNAL(canceled()), this, SLOT(cancel()) ); +.br + t = new QTimer( this ); +.br + connect( t, SIGNAL(timeout()), this, SLOT(perform()) ); +.br + t->start( 0 ); +.br +} +.br +.br +void Operation::perform() +.br +{ +.br + pd->setProgress( steps ); +.br + //... perform one percent of the operation +.br + steps++; +.br + if ( steps > pd->totalSteps() ) +.br + t->stop(); +.br +} +.br +.br +void Operation::cancel() +.br +{ +.br + t->stop(); +.br + //... cleanup +.br +} +.fi +.PP +In both modes the progress dialog may be customized by replacing the child widgets with custom widgets by using setLabel(), setBar(), and setCancelButton(). The functions setLabelText() and setCancelButtonText() set the texts shown. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QDialog, QProgressBar, GUI Design Handbook: Progress Indicator, and Dialog Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QProgressDialog::QProgressDialog ( QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +Constructs a progress dialog. +.PP +Default settings: +.TP +The label text is empty. +.TP +The cancel button text is (translated) "Cancel". +.TP +The total number of steps is 100. +.PP +The \fIcreator\fR argument is the widget to use as the dialog's parent. The \fIname\fR, \fImodal\fR, and the widget flags, \fIf\fR, are passed to the QDialog::QDialog() constructor. If \fImodal\fR is FALSE (the default), you must have an event loop proceeding for any redrawing of the dialog to occur. If \fImodal\fR is TRUE, the dialog ensures that events are processed when needed. +.PP +See also labelText, setLabel(), setCancelButtonText(), setCancelButton(), and totalSteps. +.SH "QProgressDialog::QProgressDialog ( const QString & labelText, const QString & cancelButtonText, int totalSteps, QWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +Constructs a progress dialog. +.PP +The \fIlabelText\fR is text used to remind the user what is progressing. +.PP +The \fIcancelButtonText\fR is the text to display on the cancel button, or 0 if no cancel button is to be shown. +.PP +The \fItotalSteps\fR is the total number of steps in the operation for which this progress dialog shows progress. For example, if the operation is to examine 50 files, this value would be 50. Before examining the first file, call setProgress(0). As each file is processed call setProgress(1), setProgress(2), etc., finally calling setProgress(50) after examining the last file. +.PP +The \fIcreator\fR argument is the widget to use as the dialog's parent. The \fIname\fR, \fImodal\fR, and widget flags, \fIf\fR, are passed to the QDialog::QDialog() constructor. If \fImodal\fR is FALSE (the default), you will must have an event loop proceeding for any redrawing of the dialog to occur. If \fImodal\fR is TRUE, the dialog ensures that events are processed when needed. +.PP +See also labelText, setLabel(), setCancelButtonText(), setCancelButton(), and totalSteps. +.SH "QProgressDialog::~QProgressDialog ()" +Destroys the progress dialog. +.SH "bool QProgressDialog::autoClose () const" +Returns TRUE if the dialog gets hidden by reset(); otherwise returns FALSE. See the "autoClose" property for details. +.SH "bool QProgressDialog::autoReset () const" +Returns TRUE if the progress dialog calls reset() as soon as progress() equals totalSteps(); otherwise returns FALSE. See the "autoReset" property for details. +.SH "void QProgressDialog::cancel ()\fC [slot]\fR" +Resets the progress dialog. wasCanceled() becomes TRUE until the progress dialog is reset. The progress dialog becomes hidden. +.SH "void QProgressDialog::canceled ()\fC [signal]\fR" +This signal is emitted when the cancel button is clicked. It is connected to the cancel() slot by default. +.PP +See also wasCanceled. +.SH "void QProgressDialog::cancelled ()\fC [signal]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use canceled() instead. +.PP +Examples: +.)l network/ftpclient/ftpmainwindow.ui.h and progress/progress.cpp. +.SH "void QProgressDialog::forceShow ()\fC [protected slot]\fR" +Shows the dialog if it is still hidden after the algorithm has been started and minimumDuration milliseconds have passed. +.PP +See also minimumDuration. +.SH "QString QProgressDialog::labelText () const" +Returns the label's text. See the "labelText" property for details. +.SH "int QProgressDialog::minimumDuration () const" +Returns the time that must pass before the dialog appears. See the "minimumDuration" property for details. +.SH "int QProgressDialog::progress () const" +Returns the current amount of progress made. See the "progress" property for details. +.SH "void QProgressDialog::reset ()\fC [slot]\fR" +Resets the progress dialog. The progress dialog becomes hidden if autoClose() is TRUE. +.PP +See also autoClose and autoReset. +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "void QProgressDialog::setAutoClose ( bool b )" +Sets whether the dialog gets hidden by reset() to \fIb\fR. See the "autoClose" property for details. +.SH "void QProgressDialog::setAutoReset ( bool b )" +Sets whether the progress dialog calls reset() as soon as progress() equals totalSteps() to \fIb\fR. See the "autoReset" property for details. +.SH "void QProgressDialog::setBar ( QProgressBar * bar )" +Sets the progress bar widget to \fIbar\fR. The progress dialog resizes to fit. The progress dialog takes ownership of the progress \fIbar\fR which will be deleted when necessary, so do not use a progress bar allocated on the stack. +.SH "void QProgressDialog::setCancelButton ( QPushButton * cancelButton )" +Sets the cancel button to the push button, \fIcancelButton\fR. The progress dialog takes ownership of this button which will be deleted when necessary, so do not pass the address of an object that is on the stack, i.e. use new() to create the button. +.PP +See also setCancelButtonText(). +.SH "void QProgressDialog::setCancelButtonText ( const QString & cancelButtonText )\fC [slot]\fR" +Sets the cancel button's text to \fIcancelButtonText\fR. +.PP +See also setCancelButton(). +.SH "void QProgressDialog::setLabel ( QLabel * label )" +Sets the label to \fIlabel\fR. The progress dialog resizes to fit. The label becomes owned by the progress dialog and will be deleted when necessary, so do not pass the address of an object on the stack. +.PP +See also labelText. +.PP +Example: progress/progress.cpp. +.SH "void QProgressDialog::setLabelText ( const QString & )\fC [slot]\fR" +Sets the label's text. See the "labelText" property for details. +.SH "void QProgressDialog::setMinimumDuration ( int ms )\fC [slot]\fR" +Sets the time that must pass before the dialog appears to \fIms\fR. See the "minimumDuration" property for details. +.SH "void QProgressDialog::setProgress ( int progress )\fC [slot]\fR" +Sets the current amount of progress made to \fIprogress\fR. See the "progress" property for details. +.SH "void QProgressDialog::setProgress ( int progress, int totalSteps )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the current amount of progress to \fIprogress\fR and the total number of steps to \fItotalSteps\fR. +.PP +See also totalSteps. +.SH "void QProgressDialog::setTotalSteps ( int totalSteps )\fC [slot]\fR" +Sets the total number of steps to \fItotalSteps\fR. See the "totalSteps" property for details. +.SH "QSize QProgressDialog::sizeHint () const\fC [virtual]\fR" +Returns a size that fits the contents of the progress dialog. The progress dialog resizes itself as required, so you should not need to call this yourself. +.SH "int QProgressDialog::totalSteps () const" +Returns the total number of steps. See the "totalSteps" property for details. +.SH "bool QProgressDialog::wasCanceled () const" +Returns TRUE if the dialog was canceled; otherwise returns FALSE. See the "wasCanceled" property for details. +.SH "bool QProgressDialog::wasCancelled () const" +Returns TRUE if the dialog was canceled; otherwise returns FALSE. See the "wasCancelled" property for details. +.SS "Property Documentation" +.SH "bool autoClose" +This property holds whether the dialog gets hidden by reset(). +.PP +The default is TRUE. +.PP +See also autoReset. +.PP +Set this property's value with setAutoClose() and get this property's value with autoClose(). +.SH "bool autoReset" +This property holds whether the progress dialog calls reset() as soon as progress() equals totalSteps(). +.PP +The default is TRUE. +.PP +See also autoClose. +.PP +Set this property's value with setAutoReset() and get this property's value with autoReset(). +.SH "QString labelText" +This property holds the label's text. +.PP +The default text is QString::null. +.PP +Set this property's value with setLabelText() and get this property's value with labelText(). +.SH "int minimumDuration" +This property holds the time that must pass before the dialog appears. +.PP +If the expected duration of the task is less than the minimumDuration, the dialog will not appear at all. This prevents the dialog popping up for tasks that are quickly over. For tasks that are expected to exceed the minimumDuration, the dialog will pop up after the minimumDuration time or as soon as any progress is set. +.PP +If set to 0, the dialog is always shown as soon as any progress is set. The default is 4000 milliseconds. +.PP +Set this property's value with setMinimumDuration() and get this property's value with minimumDuration(). +.SH "int progress" +This property holds the current amount of progress made. +.PP +For the progress dialog to work as expected, you should initially set this property to 0 and finally set it to QProgressDialog::totalSteps(); you can call setProgress() any number of times in-between. +.PP +\fBWarning:\fR If the progress dialog is modal (see QProgressDialog::QProgressDialog()), this function calls QApplication::processEvents(), so take care that this does not cause undesirable re-entrancy in your code. For example, don't use a QProgressDialog inside a paintEvent()! +.PP +See also totalSteps. +.PP +Set this property's value with setProgress() and get this property's value with progress(). +.SH "int totalSteps" +This property holds the total number of steps. +.PP +The default is 0. +.PP +Set this property's value with setTotalSteps() and get this property's value with totalSteps(). +.SH "bool wasCanceled" +This property holds whether the dialog was canceled. +.PP +Get this property's value with wasCanceled(). +.PP +See also progress. +.SH "bool wasCancelled" +This property holds whether the dialog was canceled. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use wasCanceled instead. +.PP +Get this property's value with wasCancelled(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqprogressdialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqprogressdialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrcollection.3qt b/doc/man/man3/tqptrcollection.3qt new file mode 100644 index 000000000..24b7ed2a1 --- /dev/null +++ b/doc/man/man3/tqptrcollection.3qt @@ -0,0 +1,145 @@ +'\" t +.TH QPtrCollection 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 +QPtrCollection \- The base class of most pointer-based Qt collections +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqptrcollection.h>\fR +.PP +Inherited by QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const = 0" +.br +.ti -1c +.BI "virtual void \fBclear\fR () = 0" +.br +.ti -1c +.BI "typedef void * \fBItem\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQPtrCollection\fR ()" +.br +.ti -1c +.BI "\fBQPtrCollection\fR ( const QPtrCollection & source )" +.br +.ti -1c +.BI "virtual \fB~QPtrCollection\fR ()" +.br +.ti -1c +.BI "virtual Item \fBnewItem\fR ( Item d )" +.br +.ti -1c +.BI "virtual void \fBdeleteItem\fR ( Item d ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QPtrCollection class is the base class of most pointer-based Qt collections. +.PP +The QPtrCollection class is an abstract base class for the Qt collection classes QDict, QPtrList, etc. Qt also includes value based collections, e.g. QValueList, QMap, etc. +.PP +A QPtrCollection only knows about the number of objects in the collection and the deletion strategy (see setAutoDelete()). +.PP +A collection is implemented using the Item (generic collection item) type, which is a \fCvoid*\fR. The template classes that create the real collections cast the Item to the required type. +.PP +See also Collection Classes and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QPtrCollection::Item" +This type is the generic "item" in a QPtrCollection. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrCollection::QPtrCollection ()\fC [protected]\fR" +Constructs a collection. The constructor is protected because QPtrCollection is an abstract class. +.SH "QPtrCollection::QPtrCollection ( const QPtrCollection & source )\fC [protected]\fR" +Constructs a copy of \fIsource\fR with autoDelete() set to FALSE. The constructor is protected because QPtrCollection is an abstract class. +.PP +Note that if \fIsource\fR has autoDelete turned on, copying it will risk memory leaks, reading freed memory, or both. +.SH "QPtrCollection::~QPtrCollection ()\fC [virtual protected]\fR" +Destroys the collection. The destructor is protected because QPtrCollection is an abstract class. +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QPtrCollection::clear ()\fC [pure virtual]\fR" +Removes all objects from the collection. The objects will be deleted if auto-delete has been enabled. +.PP +See also setAutoDelete(). +.PP +Reimplemented in QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. +.SH "uint QPtrCollection::count () const\fC [pure virtual]\fR" +Returns the number of objects in the collection. +.PP +Reimplemented in QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. +.SH "void QPtrCollection::deleteItem ( Item d )\fC [pure virtual protected]\fR" +Reimplement this function if you want to be able to delete items. +.PP +Deletes an item that is about to be removed from the collection. +.PP +This function has to reimplemented in the collection template classes, and should \fIonly\fR delete item \fId\fR if auto-delete has been enabled. +.PP +\fBWarning:\fR If you reimplement this function you must also reimplement the destructor and call the virtual function clear() from your destructor. This is due to the way virtual functions and destructors work in C++: Virtual functions in derived classes cannot be called from a destructor. If you do not do this, your deleteItem() function will not be called when the container is destroyed. +.PP +See also newItem() and setAutoDelete(). +.SH "Item QPtrCollection::newItem ( Item d )\fC [virtual protected]\fR" +Virtual function that creates a copy of an object that is about to be inserted into the collection. +.PP +The default implementation returns the \fId\fR pointer, i.e. no copy is made. +.PP +This function is seldom reimplemented in the collection template classes. It is not common practice to make a copy of something that is being inserted. +.PP +See also deleteItem(). +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqptrcollection.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrcollection.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrdict.3qt b/doc/man/man3/tqptrdict.3qt new file mode 100644 index 000000000..93a7357b2 --- /dev/null +++ b/doc/man/man3/tqptrdict.3qt @@ -0,0 +1,315 @@ +'\" t +.TH QPtrDict 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 +QPtrDict \- Template class that provides a dictionary based on void* keys +.SH SYNOPSIS +\fC#include <ntqptrdict.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPtrDict\fR ( int size = 17 )" +.br +.ti -1c +.BI "\fBQPtrDict\fR ( const QPtrDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QPtrDict\fR ()" +.br +.ti -1c +.BI "QPtrDict<type> & \fBoperator=\fR ( const QPtrDict<type> & dict )" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "void \fBinsert\fR ( void * key, const type * item )" +.br +.ti -1c +.BI "void \fBreplace\fR ( void * key, const type * item )" +.br +.ti -1c +.BI "bool \fBremove\fR ( void * key )" +.br +.ti -1c +.BI "type * \fBtake\fR ( void * key )" +.br +.ti -1c +.BI "type * \fBfind\fR ( void * key ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( void * key ) const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "void \fBresize\fR ( uint newsize )" +.br +.ti -1c +.BI "void \fBstatistics\fR () const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item ) const" +.br +.in -1c +.SH DESCRIPTION +The QPtrDict class is a template class that provides a dictionary based on void* keys. +.PP +QPtrDict is implemented as a template class. Define a template instance QPtrDict<X> to create a dictionary that operates on pointers to X (X*). +.PP +A dictionary is a collection of key-value pairs. The key is a void* used for insertion, removal and lookup. The value is a pointer. Dictionaries provide very fast insertion and lookup. +.PP +Example: +.PP +.nf +.br + QPtrDict<char> fields; // void* keys, char* values +.br +.br + QLineEdit *le1 = new QLineEdit( this ); +.br + le1->setText( "Simpson" ); +.br + QLineEdit *le2 = new QLineEdit( this ); +.br + le2->setText( "Homer" ); +.br + QLineEdit *le3 = new QLineEdit( this ); +.br + le3->setText( "45" ); +.br +.br + fields.insert( le1, "Surname" ); +.br + fields.insert( le2, "Forename" ); +.br + fields.insert( le3, "Age" ); +.br +.br + QPtrDictIterator<char> it( fields ); +.br + for( ; it.current(); ++it ) +.br + cout << it.current() << endl; +.br + cout << endl; +.br +.br + if ( fields[le1] ) // Prints "Surname: Simpson" +.br + cout << fields[le1] << ": " << le1->text() << endl; +.br +.br + if ( fields[le2] ) // Prints "Forename: Homer" +.br + cout << fields[le2] << ": " << le2->text() << endl; +.br +.br +.br + fields.remove( le1 ); // Removes le1 from the dictionary +.br + cout << le1->text() << endl; // Prints "Simpson" +.br +.fi +In this example we use a dictionary to add an extra property (a char*) to the line edits we're using. +.PP +See QDict for full details, including the choice of dictionary size, and how deletions are handled. +.PP +See also QPtrDictIterator, QDict, QAsciiDict, QIntDict, Collection Classes, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrDict::QPtrDict ( int size = 17 )" +Constructs a dictionary using an internal hash array with the size \fIsize\fR. +.PP +Setting \fIsize\fR to a suitably large prime number (equal to or greater than the expected number of entries) makes the hash distribution better and improves lookup performance. +.SH "QPtrDict::QPtrDict ( const QPtrDict<type> & dict )" +Constructs a copy of \fIdict\fR. +.PP +Each item in \fIdict\fR is inserted into this dictionary. Only the pointers are copied (shallow copy). +.SH "QPtrDict::~QPtrDict ()" +Removes all items from the dictionary and destroys it. +.PP +All iterators that access this dictionary will be reset. +.PP +See also setAutoDelete(). +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QPtrDict::clear ()\fC [virtual]\fR" +Removes all items from the dictionary. +.PP +The removed items are deleted if auto-deletion is enabled. +.PP +All dictionary iterators that access this dictionary will be reset. +.PP +See also remove(), take(), and setAutoDelete(). +.PP +Reimplemented from QPtrCollection. +.SH "uint QPtrDict::count () const\fC [virtual]\fR" +Returns the number of items in the dictionary. +.PP +See also isEmpty(). +.PP +Reimplemented from QPtrCollection. +.SH "type * QPtrDict::find ( void * key ) const" +Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be found. +.PP +Equivalent to operator[]. +.PP +See also operator[](). +.SH "void QPtrDict::insert ( void * key, const type * item )" +Inserts the \fIkey\fR with the \fIitem\fR into the dictionary. +.PP +Multiple items can have the same key, in which case only the last item will be accessible using operator[](). +.PP +\fIitem\fR may not be 0. +.PP +See also replace(). +.SH "bool QPtrDict::isEmpty () const" +Returns TRUE if the dictionary is empty; otherwise returns FALSE. +.PP +See also count(). +.SH "QPtrDict<type> & QPtrDict::operator= ( const QPtrDict<type> & dict )" +Assigns \fIdict\fR to this dictionary and returns a reference to this dictionary. +.PP +This dictionary is first cleared and then each item in \fIdict\fR is inserted into the dictionary. Only the pointers are copied (shallow copy), unless newItem() has been reimplemented. +.SH "type * QPtrDict::operator[] ( void * key ) const" +Returns the item associated with \fIkey\fR, or 0 if the key does not exist in the dictionary. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be found. +.PP +Equivalent to the find() function. +.PP +See also find(). +.SH "QDataStream & QPtrDict::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a dictionary item from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QPtrDict::remove ( void * key )" +Removes the item associated with \fIkey\fR from the dictionary. Returns TRUE if successful, i.e. if \fIkey\fR is in the dictionary; otherwise returns FALSE. +.PP +If there are two or more items with equal keys, then the most recently inserted item will be removed. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +All dictionary iterators that refer to the removed item will be set to point to the next item in the dictionary traversal order. +.PP +See also take(), clear(), and setAutoDelete(). +.SH "void QPtrDict::replace ( void * key, const type * item )" +If the dictionary has key \fIkey\fR, this key's item is replaced with \fIitem\fR. If the dictionary doesn't contain key \fIkey\fR, \fIitem\fR is inserted into the dictionary using key \fIkey\fR. +.PP +\fIitem\fR may not be 0. +.PP +Equivalent to +.PP +.nf +.br + QPtrDict<ItemType> dict; +.br + ... +.br + if ( dict.find( key ) ) +.br + dict.remove( key ); +.br + dict.insert( key, item ); +.br +.fi +.PP +If there are two or more items with equal keys, then the most recently inserted item will be replaced. +.PP +See also insert(). +.SH "void QPtrDict::resize ( uint newsize )" +Changes the size of the hash table to \fInewsize\fR. The contents of the dictionary are preserved, but all iterators on the dictionary become invalid. +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. +.SH "uint QPtrDict::size () const" +Returns the size of the internal hash table (as specified in the constructor). +.PP +See also count(). +.SH "void QPtrDict::statistics () const" +Debugging-only function that prints out the dictionary distribution using tqDebug(). +.SH "type * QPtrDict::take ( void * key )" +Takes the item associated with \fIkey\fR out of the dictionary without deleting it (even if auto-deletion is enabled). +.PP +If there are two or more items with equal keys, then the most recently inserted item will be removed. +.PP +Returns a pointer to the item taken out, or 0 if the key does not exist in the dictionary. +.PP +All dictionary iterators that refer to the taken item will be set to point to the next item in the dictionary traversal order. +.PP +See also remove(), clear(), and setAutoDelete(). +.SH "QDataStream & QPtrDict::write ( QDataStream & s, QPtrCollection::Item ) const\fC [virtual protected]\fR" +Writes a dictionary item to the stream \fIs\fR and returns a reference to the stream. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqptrdict.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrdict.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrdictiterator.3qt b/doc/man/man3/tqptrdictiterator.3qt new file mode 100644 index 000000000..880fa24df --- /dev/null +++ b/doc/man/man3/tqptrdictiterator.3qt @@ -0,0 +1,168 @@ +'\" t +.TH QPtrDictIterator 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 +QPtrDictIterator \- Iterator for QPtrDict collections +.SH SYNOPSIS +\fC#include <ntqptrdict.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPtrDictIterator\fR ( const QPtrDict<type> & dict )" +.br +.ti -1c +.BI "\fB~QPtrDictIterator\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "void * \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.in -1c +.SH DESCRIPTION +The QPtrDictIterator class provides an iterator for QPtrDict collections. +.PP +QPtrDictIterator is implemented as a template class. Define a template instance QPtrDictIterator<X> to create a dictionary iterator that operates on QPtrDict<X> (dictionary of X*). +.PP +Example: +.PP +.nf +.br + QPtrDict<char> fields; +.br +.br + QLineEdit *le1 = new QLineEdit( this ); +.br + le1->setText( "Simpson" ); +.br + QLineEdit *le2 = new QLineEdit( this ); +.br + le2->setText( "Homer" ); +.br + QLineEdit *le3 = new QLineEdit( this ); +.br + le3->setText( "45" ); +.br +.br + fields.insert( le1, "Surname" ); +.br + fields.insert( le2, "Forename" ); +.br + fields.insert( le3, "Age" ); +.br +.br + QPtrDictIterator<char> it( fields ); +.br + for( ; it.current(); ++it ) { +.br + QLineEdit *le = (QLineEdit)it.currentKey(); +.br + cout << it.current() << ": " << le->text() << endl; +.br + } +.br + cout << endl; +.br +.br + // Output (random order): +.br + // Forename: Homer +.br + // Age: 45 +.br + // Surname: Simpson +.br +.fi +In the example we insert some line edits into a dictionary, associating a string with each. We then iterate over the dictionary printing the associated strings. +.PP +Multiple iterators may independently traverse the same dictionary. A QPtrDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QPtrDict updates all iterators that refer the removed item to point to the next item in the traversing order. +.PP +See also QPtrDict, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrDictIterator::QPtrDictIterator ( const QPtrDict<type> & dict )" +Constructs an iterator for \fIdict\fR. The current iterator item is set to point on the first item in the \fIdict\fR. +.SH "QPtrDictIterator::~QPtrDictIterator ()" +Destroys the iterator. +.SH "uint QPtrDictIterator::count () const" +Returns the number of items in the dictionary this iterator operates on. +.PP +See also isEmpty(). +.SH "type * QPtrDictIterator::current () const" +Returns a pointer to the current iterator item's value. +.SH "void * QPtrDictIterator::currentKey () const" +Returns the current iterator item's key. +.SH "bool QPtrDictIterator::isEmpty () const" +Returns TRUE if the dictionary is empty; otherwise returns FALSE. +.PP +See also count(). +.SH "QPtrDictIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QPtrDictIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QPtrDictIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns the new current item. +.PP +If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned. +.SH "type * QPtrDictIterator::operator+= ( uint jump )" +Sets the current item to the item \fIjump\fR positions after the current item and returns a pointer to that item. +.PP +If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0. +.SH "type * QPtrDictIterator::toFirst ()" +Sets the current iterator item to point to the first item in the +dictionary and returns a pointer to the item. If the dictionary is +empty, it sets the current item to 0 and returns 0. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qptrdictiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrdictiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrlist.3qt b/doc/man/man3/tqptrlist.3qt new file mode 100644 index 000000000..9563479ce --- /dev/null +++ b/doc/man/man3/tqptrlist.3qt @@ -0,0 +1,718 @@ +'\" t +.TH QPtrList 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 +QPtrList \- Template class that provides a list +.SH SYNOPSIS +\fC#include <ntqptrlist.h>\fR +.PP +Inherits QPtrCollection. +.PP +Inherited by QObjectList, QSortedList, and QStrList. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPtrList\fR ()" +.br +.ti -1c +.BI "\fBQPtrList\fR ( const QPtrList<type> & list )" +.br +.ti -1c +.BI "\fB~QPtrList\fR ()" +.br +.ti -1c +.BI "QPtrList<type> & \fBoperator=\fR ( const QPtrList<type> & list )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QPtrList<type> & list ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QPtrList<type> & list ) const" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBinsert\fR ( uint index, const type * item )" +.br +.ti -1c +.BI "void \fBinSort\fR ( const type * item )" +.br +.ti -1c +.BI "void \fBprepend\fR ( const type * item )" +.br +.ti -1c +.BI "void \fBappend\fR ( const type * item )" +.br +.ti -1c +.BI "bool \fBremove\fR ( uint index )" +.br +.ti -1c +.BI "bool \fBremove\fR ()" +.br +.ti -1c +.BI "bool \fBremove\fR ( const type * item )" +.br +.ti -1c +.BI "bool \fBremoveRef\fR ( const type * item )" +.br +.ti -1c +.BI "void \fBremoveNode\fR ( QLNode * node )" +.br +.ti -1c +.BI "bool \fBremoveFirst\fR ()" +.br +.ti -1c +.BI "bool \fBremoveLast\fR ()" +.br +.ti -1c +.BI "type * \fBtake\fR ( uint index )" +.br +.ti -1c +.BI "type * \fBtake\fR ()" +.br +.ti -1c +.BI "type * \fBtakeNode\fR ( QLNode * node )" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "void \fBsort\fR ()" +.br +.ti -1c +.BI "int \fBfind\fR ( const type * item )" +.br +.ti -1c +.BI "int \fBfindNext\fR ( const type * item )" +.br +.ti -1c +.BI "int \fBfindRef\fR ( const type * item )" +.br +.ti -1c +.BI "int \fBfindNextRef\fR ( const type * item )" +.br +.ti -1c +.BI "uint \fBcontains\fR ( const type * item ) const" +.br +.ti -1c +.BI "uint \fBcontainsRef\fR ( const type * item ) const" +.br +.ti -1c +.BI "bool \fBreplace\fR ( uint index, const type * item )" +.br +.ti -1c +.BI "type * \fBat\fR ( uint index )" +.br +.ti -1c +.BI "int \fBat\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "QLNode * \fBcurrentNode\fR () const" +.br +.ti -1c +.BI "type * \fBgetFirst\fR () const" +.br +.ti -1c +.BI "type * \fBgetLast\fR () const" +.br +.ti -1c +.BI "type * \fBfirst\fR ()" +.br +.ti -1c +.BI "type * \fBlast\fR ()" +.br +.ti -1c +.BI "type * \fBnext\fR ()" +.br +.ti -1c +.BI "type * \fBprev\fR ()" +.br +.ti -1c +.BI "void \fBtoVector\fR ( QGVector * vec ) const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual int \fBcompareItems\fR ( QPtrCollection::Item item1, QPtrCollection::Item item2 )" +.br +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" +.br +.in -1c +.SH DESCRIPTION +The QPtrList class is a template class that provides a list. +.PP +QValueList is an STL-compatible alternative to this class. +.PP +Define a template instance QPtrList<X> to create a list that operates on pointers to X (X*). +.PP +The list class is indexable and has a current index and a current item. The first item corresponds to index position 0. The current index is -1 if the current item is 0. +.PP +Items are inserted with prepend(), insert() or append(). Items are removed with remove(), removeRef(), removeFirst() and removeLast(). You can search for an item using find(), findNext(), findRef() or findNextRef(). The list can be sorted with sort(). You can count the number of occurrences of an item with contains() or containsRef(). You can get a pointer to the current item with current(), to an item at a particular index position in the list with at() or to the first or last item with getFirst() and getLast(). You can also iterate over the list with first(), last(), next() and prev() (which all update current()). The list's deletion property is set with setAutoDelete(). +.PP +Example: +.PP +.nf +.br + class Employee +.br + { +.br + public: +.br + Employee() : sn( 0 ) { } +.br + Employee( const QString& forename, const QString& surname, int salary ) +.br + : fn( forename ), sn( surname ), sal( salary ) +.br + { } +.br +.br + void setSalary( int salary ) { sal = salary; } +.br +.br + QString forename() const { return fn; } +.br + QString surname() const { return sn; } +.br + int salary() const { return sal; } +.br +.br + private: +.br + QString fn; +.br + QString sn; +.br + int sal; +.br + }; +.br +.br + QPtrList<Employee> list; +.br + list.setAutoDelete( TRUE ); // the list owns the objects +.br +.br + list.append( new Employee("John", "Doe", 50000) ); +.br + list.append( new Employee("Jane", "Williams", 80000) ); +.br + list.append( new Employee("Tom", "Jones", 60000) ); +.br +.br + Employee *employee; +.br + for ( employee = list.first(); employee; employee = list.next() ) +.br + cout << employee->surname().latin1() << ", " << +.br + employee->forename().latin1() << " earns " << +.br + employee->salary() << endl; +.br + cout << endl; +.br +.br + // very inefficient for big lists +.br + for ( uint i = 0; i < list.count(); ++i ) +.br + if ( list.at(i) ) +.br + cout << list.at( i )->surname().latin1() << endl; +.br +.fi +.PP +The output is +.PP +.nf +.br + Doe, John earns 50000 +.br + Williams, Jane earns 80000 +.br + Jones, Tom earns 60000 +.br +.br + Doe +.br + Williams +.br + Jones +.br +.fi +.PP +QPtrList has several member functions for traversing the list, but using a QPtrListIterator can be more practical. Multiple list iterators may traverse the same list, independently of each other and of the current list item. +.PP +In the example above we make the call setAutoDelete(TRUE). Enabling auto-deletion tells the list to delete items that are removed. The default is to not delete items when they are removed but this would cause a memory leak in the example because there are no other references to the list items. +.PP +When inserting an item into a list only the pointer is copied, not the item itself, i.e. a shallow copy. It is possible to make the list copy all of the item's data (deep copy) when an item is inserted. insert(), inSort() and append() call the virtual function QPtrCollection::newItem() for the item to be inserted. Inherit a list and reimplement newItem() to have deep copies. +.PP +When removing an item from a list, the virtual function QPtrCollection::deleteItem() is called. QPtrList's default implementation is to delete the item if auto-deletion is enabled. +.PP +The virtual function compareItems() can be reimplemented to compare two list items. This function is called from all list functions that need to compare list items, for instance remove(const type*). If you only want to deal with pointers, there are functions that compare pointers instead, for instance removeRef(const type*). These functions are somewhat faster than those that call compareItems(). +.PP +List items are stored as \fCvoid*\fR in an internal QLNode, which also holds pointers to the next and previous list items. The functions currentNode(), removeNode(), and takeNode() operate directly on the QLNode, but they should be used with care. The data component of the node is available through QLNode::getData(). +.PP +The QStrList class defined in ntqstrlist.h is a list of \fCchar*\fR. It reimplements newItem(), deleteItem() and compareItems(). (But see QStringList for a list of Unicode QStrings.) +.PP +See also QPtrListIterator, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrList::QPtrList ()" +Constructs an empty list. +.SH "QPtrList::QPtrList ( const QPtrList<type> & list )" +Constructs a copy of \fIlist\fR. +.PP +Each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy). +.SH "QPtrList::~QPtrList ()" +Removes all items from the list and destroys the list. +.PP +All list iterators that access this list will be reset. +.PP +See also setAutoDelete(). +.SH "void QPtrList::append ( const type * item )" +Inserts the \fIitem\fR at the end of the list. +.PP +The inserted item becomes the current list item. This is equivalent to \fCinsert( count(), item )\fR. +.PP +\fIitem\fR must not be 0. +.PP +See also insert(), current(), and prepend(). +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, customlayout/flow.cpp, grapher/grapher.cpp, listviews/listviews.cpp, listviews/listviews.h, and qwerty/qwerty.cpp. +.SH "type * QPtrList::at ( uint index )" +Returns a pointer to the item at position \fIindex\fR in the list, or 0 if the index is out of range. +.PP +Sets the current list item to this item if \fIindex\fR is valid. The valid range is \fC0..(count() - 1)\fR inclusive. +.PP +This function is very efficient. It starts scanning from the first item, last item, or current item, whichever is closest to \fIindex\fR. +.PP +See also current(). +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, customlayout/flow.cpp, dirview/dirview.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. +.SH "int QPtrList::at () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the index of the current list item. The returned value is -1 if the current item is 0. +.PP +See also current(). +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QPtrList::clear ()\fC [virtual]\fR" +Removes all items from the list. +.PP +The removed items are deleted if auto-deletion is enabled. +.PP +All list iterators that access this list will be reset. +.PP +See also remove(), take(), and setAutoDelete(). +.PP +Reimplemented from QPtrCollection. +.SH "int QPtrList::compareItems ( QPtrCollection::Item item1, QPtrCollection::Item item2 )\fC [virtual protected]\fR" +This virtual function compares two list items. +.PP +Returns: +.TP +zero if \fIitem1\fR == \fIitem2\fR +.TP +nonzero if \fIitem1\fR != \fIitem2\fR +.PP +This function returns \fIint\fR rather than \fIbool\fR so that reimplementations can return three values and use it to sort by: +.TP +0 if \fIitem1\fR == \fIitem2\fR +.TP +> 0 (positive integer) if \fIitem1\fR > \fIitem2\fR +.TP +< 0 (negative integer) if \fIitem1\fR < \fIitem2\fR +.PP +inSort() requires that compareItems() is implemented as described here. +.PP +This function should not modify the list because some const functions call compareItems(). +.PP +The default implementation compares the pointers. +.SH "uint QPtrList::contains ( const type * item ) const" +Returns the number of occurrences of \fIitem\fR in the list. +.PP +The compareItems() function is called when looking for the \fIitem\fR in the list. If compareItems() is not reimplemented, it is more efficient to call containsRef(). +.PP +This function does not affect the current list item. +.PP +See also containsRef() and compareItems(). +.SH "uint QPtrList::containsRef ( const type * item ) const" +Returns the number of occurrences of \fIitem\fR in the list. +.PP +Calling this function is much faster than contains() because contains() compares \fIitem\fR with each list item using compareItems(), whereas his function only compares the pointers. +.PP +This function does not affect the current list item. +.PP +See also contains(). +.SH "uint QPtrList::count () const\fC [virtual]\fR" +Returns the number of items in the list. +.PP +See also isEmpty(). +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, customlayout/flow.cpp, dirview/dirview.cpp, grapher/grapher.cpp, mdi/application.cpp, and qwerty/qwerty.cpp. +.PP +Reimplemented from QPtrCollection. +.SH "type * QPtrList::current () const" +Returns a pointer to the current list item. The current item may be 0 (implies that the current index is -1). +.PP +See also at(). +.SH "QLNode * QPtrList::currentNode () const" +Returns a pointer to the current list node. +.PP +The node can be kept and removed later using removeNode(). The advantage is that the item can be removed directly without searching the list. +.PP +\fBWarning:\fR Do not call this function unless you are an expert. +.PP +See also removeNode(), takeNode(), and current(). +.SH "int QPtrList::find ( const type * item )" +Finds the first occurrence of \fIitem\fR in the list. +.PP +If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. +.PP +The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call findRef(). +.PP +See also findNext(), findRef(), compareItems(), and current(). +.SH "int QPtrList::findNext ( const type * item )" +Finds the next occurrence of \fIitem\fR in the list, starting from the current list item. +.PP +If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. +.PP +The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call findNextRef(). +.PP +See also find(), findNextRef(), compareItems(), and current(). +.SH "int QPtrList::findNextRef ( const type * item )" +Finds the next occurrence of \fIitem\fR in the list, starting from the current list item. +.PP +If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. +.PP +Calling this function is much faster than findNext() because findNext() compares \fIitem\fR with each list item using compareItems(), whereas this function only compares the pointers. +.PP +See also findRef(), findNext(), and current(). +.SH "int QPtrList::findRef ( const type * item )" +Finds the first occurrence of \fIitem\fR in the list. +.PP +If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to 0, the current index to -1, and returns -1. +.PP +Calling this function is much faster than find() because find() compares \fIitem\fR with each list item using compareItems(), whereas this function only compares the pointers. +.PP +See also findNextRef(), find(), and current(). +.SH "type * QPtrList::first ()" +Returns a pointer to the first item in the list and makes this the current list item; returns 0 if the list is empty. +.PP +See also getFirst(), last(), next(), prev(), and current(). +.PP +Examples: +.)l grapher/grapher.cpp, listviews/listviews.h, and showimg/showimg.cpp. +.SH "type * QPtrList::getFirst () const" +Returns a pointer to the first item in the list, or 0 if the list is empty. +.PP +This function does not affect the current list item. +.PP +See also first() and getLast(). +.SH "type * QPtrList::getLast () const" +Returns a pointer to the last item in the list, or 0 if the list is empty. +.PP +This function does not affect the current list item. +.PP +See also last() and getFirst(). +.SH "void QPtrList::inSort ( const type * item )" +Inserts the \fIitem\fR at its sorted position in the list. +.PP +The sort order depends on the virtual compareItems() function. All items must be inserted with inSort() to maintain the sorting order. +.PP +The inserted item becomes the current list item. +.PP +\fIitem\fR must not be 0. +.PP +\fBWarning:\fR Using inSort() is slow. An alternative, especially if you have lots of items, is to simply append() or insert() them and then use sort(). inSort() takes up to O(n) compares. That means inserting n items in your list will need O(n^2) compares whereas sort() only needs O(n*log n) for the same task. So use inSort() only if you already have a presorted list and want to insert just a few additional items. +.PP +See also insert(), compareItems(), current(), and sort(). +.SH "bool QPtrList::insert ( uint index, const type * item )" +Inserts the \fIitem\fR at position \fIindex\fR in the list. +.PP +Returns TRUE if successful, i.e. if \fIindex\fR is in range; otherwise returns FALSE. The valid range is 0 to count() (inclusively). The item is appended if \fIindex\fR == count(). +.PP +The inserted item becomes the current list item. +.PP +\fIitem\fR must not be 0. +.PP +See also append(), current(), and replace(). +.SH "bool QPtrList::isEmpty () const" +Returns TRUE if the list is empty; otherwise returns FALSE. +.PP +See also count(). +.SH "type * QPtrList::last ()" +Returns a pointer to the last item in the list and makes this the current list item; returns 0 if the list is empty. +.PP +See also getLast(), first(), next(), prev(), and current(). +.SH "type * QPtrList::next ()" +Returns a pointer to the item succeeding the current item. Returns 0 if the current item is 0 or equal to the last item. +.PP +Makes the succeeding item current. If the current item before this function call was the last item, the current item will be set to 0. If the current item was 0, this function does nothing. +.PP +See also first(), last(), prev(), and current(). +.PP +Examples: +.)l grapher/grapher.cpp, listviews/listviews.h, and showimg/showimg.cpp. +.SH "bool QPtrList::operator!= ( const QPtrList<type> & list ) const" +Compares this list with \fIlist\fR. Returns TRUE if the lists contain different data; otherwise returns FALSE. +.SH "QPtrList<type> & QPtrList::operator= ( const QPtrList<type> & list )" +Assigns \fIlist\fR to this list and returns a reference to this list. +.PP +This list is first cleared and then each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy) unless newItem() has been reimplemented. +.SH "bool QPtrList::operator== ( const QPtrList<type> & list ) const" +Compares this list with \fIlist\fR. Returns TRUE if the lists contain the same data; otherwise returns FALSE. +.SH "void QPtrList::prepend ( const type * item )" +Inserts the \fIitem\fR at the start of the list. +.PP +The inserted item becomes the current list item. This is equivalent to \fCinsert( 0, item )\fR. +.PP +\fIitem\fR must not be 0. +.PP +See also append(), insert(), and current(). +.SH "type * QPtrList::prev ()" +Returns a pointer to the item preceding the current item. Returns 0 if the current item is 0 or equal to the first item. +.PP +Makes the preceding item current. If the current item before this function call was the first item, the current item will be set to 0. If the current item was 0, this function does nothing. +.PP +See also first(), last(), next(), and current(). +.SH "QDataStream & QPtrList::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a list item from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QPtrList::remove ( uint index )" +Removes the item at position \fIindex\fR in the list. +.PP +Returns TRUE if successful, i.e. if \fIindex\fR is in range; otherwise returns FALSE. The valid range is \fC0..(count() - 1)\fR inclusive. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. +.PP +All list iterators that refer to the removed item will be set to point to the new current item. +.PP +See also take(), clear(), setAutoDelete(), current(), and removeRef(). +.SH "bool QPtrList::remove ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes the current list item. +.PP +Returns TRUE if successful, i.e. if the current item isn't 0; otherwise returns FALSE. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the removed item will be set to point to the new current item. +.PP +See also take(), clear(), setAutoDelete(), current(), and removeRef(). +.SH "bool QPtrList::remove ( const type * item )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes the first occurrence of \fIitem\fR from the list. +.PP +Returns TRUE if successful, i.e. if \fIitem\fR is in the list; otherwise returns FALSE. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call removeRef(). +.PP +If \fIitem\fR is NULL then the current item is removed from the list. +.PP +The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the removed item will be set to point to the new current item. +.PP +See also removeRef(), take(), clear(), setAutoDelete(), compareItems(), and current(). +.SH "bool QPtrList::removeFirst ()" +Removes the first item from the list. Returns TRUE if successful, i.e. if the list isn't empty; otherwise returns FALSE. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +The first item in the list becomes the new current list item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the removed item will be set to point to the new current item. +.PP +See also removeLast(), setAutoDelete(), current(), and remove(). +.SH "bool QPtrList::removeLast ()" +Removes the last item from the list. Returns TRUE if successful, i.e. if the list isn't empty; otherwise returns FALSE. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +The last item in the list becomes the new current list item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the removed item will be set to point to the new current item. +.PP +See also removeFirst(), setAutoDelete(), and current(). +.SH "void QPtrList::removeNode ( QLNode * node )" +Removes the \fInode\fR from the list. +.PP +This node must exist in the list, otherwise the program may crash. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +The first item in the list will become the new current list item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the removed item will be set to point to the item succeeding this item or to the preceding item if the removed item was the last item. +.PP +\fBWarning:\fR Do not call this function unless you are an expert. +.PP +See also takeNode(), currentNode(), remove(), and removeRef(). +.SH "bool QPtrList::removeRef ( const type * item )" +Removes the first occurrence of \fIitem\fR from the list. +.PP +Returns TRUE if successful, i.e. if \fIitem\fR is in the list; otherwise returns FALSE. +.PP +The removed item is deleted if auto-deletion is enabled. +.PP +Equivalent to: +.PP +.nf +.br + if ( list.findRef( item ) != -1 ) +.br + list.remove(); +.br +.fi +.PP +The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the removed item will be set to point to the new current item. +.PP +See also remove(), clear(), setAutoDelete(), and current(). +.SH "bool QPtrList::replace ( uint index, const type * item )" +Replaces the item at position \fIindex\fR with the new \fIitem\fR. +.PP +Returns TRUE if successful, i.e. \fIindex\fR is in the range 0 to count()-1. +.PP +See also append(), current(), and insert(). +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. +.SH "void QPtrList::sort ()" +Sorts the list by the result of the virtual compareItems() function. +.PP +The heap sort algorithm is used for sorting. It sorts n items with O(n*log n) comparisons. This is the asymptotic optimal solution of the sorting problem. +.PP +If the items in your list support operator<() and operator==(), you might be better off with QSortedList because it implements the compareItems() function for you using these two operators. +.PP +See also inSort(). +.SH "type * QPtrList::take ( uint index )" +Takes the item at position \fIindex\fR out of the list without deleting it (even if auto-deletion is enabled). +.PP +Returns a pointer to the item taken out of the list, or 0 if the index is out of range. The valid range is \fC0..(count() - 1)\fR inclusive. +.PP +The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the taken item will be set to point to the new current item. +.PP +See also remove(), clear(), and current(). +.PP +Examples: +.)l customlayout/border.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.SH "type * QPtrList::take ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Takes the current item out of the list without deleting it (even if auto-deletion is enabled). +.PP +Returns a pointer to the item taken out of the list, or 0 if the current item is 0. +.PP +The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to 0 if the list becomes empty. +.PP +All list iterators that refer to the taken item will be set to point to the new current item. +.PP +See also remove(), clear(), and current(). +.SH "type * QPtrList::takeNode ( QLNode * node )" +Takes the \fInode\fR out of the list without deleting its item (even if auto-deletion is enabled). Returns a pointer to the item taken out of the list. +.PP +This node must exist in the list, otherwise the program may crash. +.PP +The first item in the list becomes the new current list item. +.PP +All list iterators that refer to the taken item will be set to point to the item succeeding this item or to the preceding item if the taken item was the last item. +.PP +\fBWarning:\fR Do not call this function unless you are an expert. +.PP +See also removeNode() and currentNode(). +.SH "void QPtrList::toVector ( QGVector * vec ) const" +Stores all list items in the vector \fIvec\fR. +.PP +The vector must be of the same item type, otherwise the result will be undefined. +.SH "QDataStream & QPtrList::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" +Writes a list item, \fIitem\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation does nothing. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqptrlist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrlist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrlistiterator.3qt b/doc/man/man3/tqptrlistiterator.3qt new file mode 100644 index 000000000..4d400b4cc --- /dev/null +++ b/doc/man/man3/tqptrlistiterator.3qt @@ -0,0 +1,210 @@ +'\" t +.TH QPtrListIterator 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 +QPtrListIterator \- Iterator for QPtrList collections +.SH SYNOPSIS +\fC#include <ntqptrlist.h>\fR +.PP +Inherited by QObjectListIterator and QStrListIterator. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPtrListIterator\fR ( const QPtrList<type> & list )" +.br +.ti -1c +.BI "\fB~QPtrListIterator\fR ()" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBatFirst\fR () const" +.br +.ti -1c +.BI "bool \fBatLast\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "type * \fBtoLast\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBoperator*\fR ()" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.ti -1c +.BI "type * \fBoperator--\fR ()" +.br +.ti -1c +.BI "type * \fBoperator-=\fR ( uint jump )" +.br +.ti -1c +.BI "QPtrListIterator<type> & \fBoperator=\fR ( const QPtrListIterator<type> & it )" +.br +.in -1c +.SH DESCRIPTION +The QPtrListIterator class provides an iterator for QPtrList collections. +.PP +Define a template instance QPtrListIterator<X> to create a list iterator that operates on QPtrList<X> (list of X*). +.PP +The following example is similar to the example in the QPtrList class documentation, but it uses QPtrListIterator. The class Employee is defined there. +.PP +.nf +.br + QPtrList<Employee> list; +.br +.br + list.append( new Employee("John", "Doe", 50000) ); +.br + list.append( new Employee("Jane", "Williams", 80000) ); +.br + list.append( new Employee("Tom", "Jones", 60000) ); +.br +.br + QPtrListIterator<Employee> it( list ); +.br + Employee *employee; +.br + while ( (employee = it.current()) != 0 ) { +.br + ++it; +.br + cout << employee->surname().latin1() << ", " << +.br + employee->forename().latin1() << " earns " << +.br + employee->salary() << endl; +.br + } +.br +.fi +.PP +The output is +.PP +.nf +.br + Doe, John earns 50000 +.br + Williams, Jane earns 80000 +.br + Jones, Tom earns 60000 +.br +.fi +.PP +Using a list iterator is a more robust way of traversing the list than using the QPtrList member functions first(), next(), current(), etc., as many iterators can traverse the same list independently. +.PP +An iterator has its own current list item and can get the next and previous list items. It doesn't modify the list in any way. +.PP +When an item is removed from the list, all iterators that point to that item are updated to point to QPtrList::current() instead to avoid dangling references. +.PP +See also QPtrList, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrListIterator::QPtrListIterator ( const QPtrList<type> & list )" +Constructs an iterator for \fIlist\fR. The current iterator item is set to point on the first item in the \fIlist\fR. +.SH "QPtrListIterator::~QPtrListIterator ()" +Destroys the iterator. +.SH "bool QPtrListIterator::atFirst () const" +Returns TRUE if the current iterator item is the first list item; otherwise returns FALSE. +.PP +See also toFirst() and atLast(). +.SH "bool QPtrListIterator::atLast () const" +Returns TRUE if the current iterator item is the last list item; otherwise returns FALSE. +.PP +See also toLast() and atFirst(). +.SH "uint QPtrListIterator::count () const" +Returns the number of items in the list this iterator operates on. +.PP +See also isEmpty(). +.PP +Example: customlayout/card.cpp. +.SH "type * QPtrListIterator::current () const" +Returns a pointer to the current iterator item. If the iterator is positioned before the first item in the list or after the last item in the list, 0 is returned. +.PP +Examples: +.)l canvas/canvas.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +.SH "bool QPtrListIterator::isEmpty () const" +Returns TRUE if the list is empty; otherwise returns FALSE. +.PP +See also count(). +.SH "QPtrListIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QPtrListIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the list or if it was 0, 0 is returned. +.SH "type * QPtrListIterator::operator* ()" +Asterisk operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QPtrListIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns the new current item. +.PP +If the current iterator item was the last item in the list or if it was 0, 0 is returned. +.SH "type * QPtrListIterator::operator+= ( uint jump )" +Sets the current item to the item \fIjump\fR positions after the current item and returns a pointer to that item. +.PP +If that item is beyond the last item or if the list is empty, it sets the current item to 0 and returns 0 +.SH "type * QPtrListIterator::operator-- ()" +Prefix - makes the preceding item current and returns the new current item. +.PP +If the current iterator item was the first item in the list or if it was 0, 0 is returned. +.SH "type * QPtrListIterator::operator-= ( uint jump )" +Returns the item \fIjump\fR positions before the current item or 0 if it is beyond the first item. Makes this the current item. +.SH "QPtrListIterator<type> & QPtrListIterator::operator= ( const QPtrListIterator<type> & it )" +Assignment. Makes a copy of the iterator \fIit\fR and returns a reference to this iterator. +.SH "type * QPtrListIterator::toFirst ()" +Sets the current iterator item to point to the first list item and returns a pointer to the item. Sets the current item to 0 and returns 0 if the list is empty. +.PP +See also toLast() and atFirst(). +.SH "type * QPtrListIterator::toLast ()" +Sets the current iterator item to point to the last list item and returns a pointer to the item. Sets the current item to 0 and returns 0 if the list is empty. +.PP +See also toFirst() and atLast(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qptrlistiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrlistiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrqueue.3qt b/doc/man/man3/tqptrqueue.3qt new file mode 100644 index 000000000..296233d2d --- /dev/null +++ b/doc/man/man3/tqptrqueue.3qt @@ -0,0 +1,186 @@ +'\" t +.TH QPtrQueue 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 +QPtrQueue \- Template class that provides a queue +.SH SYNOPSIS +\fC#include <ntqptrqueue.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPtrQueue\fR ()" +.br +.ti -1c +.BI "\fBQPtrQueue\fR ( const QPtrQueue<type> & queue )" +.br +.ti -1c +.BI "\fB~QPtrQueue\fR ()" +.br +.ti -1c +.BI "QPtrQueue<type> & \fBoperator=\fR ( const QPtrQueue<type> & queue )" +.br +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "void \fBenqueue\fR ( const type * d )" +.br +.ti -1c +.BI "type * \fBdequeue\fR ()" +.br +.ti -1c +.BI "bool \fBremove\fR ()" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "type * \fBhead\fR () const" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" +.br +.in -1c +.SH DESCRIPTION +The QPtrQueue class is a template class that provides a queue. +.PP +QValueVector can be used as an STL-compatible alternative to this class. +.PP +A template instance QPtrQueue<X> is a queue that operates on pointers to X (X*). +.PP +A queue is a first in, first out structure. Items are added to the tail of the queue with enqueue() and retrieved from the head with dequeue(). You can peek at the head item without dequeing it using head(). +.PP +You can control the queue's deletion policy with setAutoDelete(). +.PP +For compatibility with the QPtrCollection classes, current() and remove() are provided; both operate on the head(). +.PP +See also QPtrList, QPtrStack, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrQueue::QPtrQueue ()" +Creates an empty queue with autoDelete() set to FALSE. +.SH "QPtrQueue::QPtrQueue ( const QPtrQueue<type> & queue )" +Creates a queue from \fIqueue\fR. +.PP +Only the pointers are copied; the items are not. The autoDelete() flag is set to FALSE. +.SH "QPtrQueue::~QPtrQueue ()" +Destroys the queue. Items in the queue are deleted if autoDelete() is TRUE. +.SH "bool QPtrQueue::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QPtrQueue::clear ()" +Removes all items from the queue, and deletes them if autoDelete() is TRUE. +.PP +See also remove(). +.SH "uint QPtrQueue::count () const" +Returns the number of items in the queue. +.PP +See also isEmpty(). +.SH "type * QPtrQueue::current () const" +Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty. +.PP +See also dequeue() and isEmpty(). +.SH "type * QPtrQueue::dequeue ()" +Takes the head item from the queue and returns a pointer to it. Returns 0 if the queue is empty. +.PP +See also enqueue() and count(). +.SH "void QPtrQueue::enqueue ( const type * d )" +Adds item \fId\fR to the tail of the queue. +.PP +See also count() and dequeue(). +.SH "type * QPtrQueue::head () const" +Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty. +.PP +See also dequeue() and isEmpty(). +.SH "bool QPtrQueue::isEmpty () const" +Returns TRUE if the queue is empty; otherwise returns FALSE. +.PP +See also count(), dequeue(), and head(). +.SH "QPtrQueue::operator type * () const" +Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty. +.PP +See also dequeue() and isEmpty(). +.SH "QPtrQueue<type> & QPtrQueue::operator= ( const QPtrQueue<type> & queue )" +Assigns \fIqueue\fR to this queue and returns a reference to this queue. +.PP +This queue is first cleared and then each item in \fIqueue\fR is enqueued to this queue. Only the pointers are copied. +.PP +\fBWarning:\fR The autoDelete() flag is not modified. If it it TRUE for both \fIqueue\fR and this queue, deleting the two lists will cause \fIdouble-deletion\fR of the items. +.SH "QDataStream & QPtrQueue::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a queue item, \fIitem\fR, from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QPtrQueue::remove ()" +Removes the head item from the queue, and returns TRUE if there was an item, i.e. the queue wasn't empty; otherwise returns FALSE. +.PP +The item is deleted if autoDelete() is TRUE. +.PP +See also head(), isEmpty(), and dequeue(). +.SH "void QPtrQueue::setAutoDelete ( bool enable )" +Sets the queue to auto-delete its contents if \fIenable\fR is TRUE and not to delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a queue are deleted when the queue itself is deleted. This can be quite convenient if the queue has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the queue: you might find yourself with two queues deleting the same items. +.PP +See also autoDelete(). +.SH "QDataStream & QPtrQueue::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" +Writes a queue item, \fIitem\fR, to the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation does nothing. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqptrqueue.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrqueue.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrstack.3qt b/doc/man/man3/tqptrstack.3qt new file mode 100644 index 000000000..8b9d9eecc --- /dev/null +++ b/doc/man/man3/tqptrstack.3qt @@ -0,0 +1,164 @@ +'\" t +.TH QPtrStack 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 +QPtrStack \- Template class that provides a stack +.SH SYNOPSIS +\fC#include <ntqptrstack.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPtrStack\fR ()" +.br +.ti -1c +.BI "\fBQPtrStack\fR ( const QPtrStack<type> & s )" +.br +.ti -1c +.BI "\fB~QPtrStack\fR ()" +.br +.ti -1c +.BI "QPtrStack<type> & \fBoperator=\fR ( const QPtrStack<type> & s )" +.br +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "void \fBpush\fR ( const type * d )" +.br +.ti -1c +.BI "type * \fBpop\fR ()" +.br +.ti -1c +.BI "bool \fBremove\fR ()" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "type * \fBtop\fR () const" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" +.br +.in -1c +.SH DESCRIPTION +The QPtrStack class is a template class that provides a stack. +.PP +QValueStack is an STL-compatible alternative to this class. +.PP +Define a template instance QPtrStack<X> to create a stack that operates on pointers to X, (X*). +.PP +A stack is a last in, first out (LIFO) structure. Items are added to the top of the stack with push() and retrieved from the top with pop(). Use top() to get a reference to the top element without changing the stack. +.PP +You can control the stack's deletion policy with setAutoDelete(). +.PP +For compatibility with the QPtrCollection classes current() and remove() are provided; they both operate on the top(). +.PP +See also QPtrList, QPtrQueue, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrStack::QPtrStack ()" +Creates an empty stack. +.SH "QPtrStack::QPtrStack ( const QPtrStack<type> & s )" +Creates a stack by making a shallow copy of another stack \fIs\fR. +.SH "QPtrStack::~QPtrStack ()" +Destroys the stack. All items will be deleted if autoDelete() is TRUE. +.SH "bool QPtrStack::autoDelete () const" +The same as QPtrCollection::autoDelete(). +.PP +See also setAutoDelete(). +.SH "void QPtrStack::clear ()" +Removes all items from the stack, deleting them if autoDelete() is TRUE. +.PP +See also remove(). +.SH "uint QPtrStack::count () const" +Returns the number of items in the stack. +.PP +See also isEmpty(). +.SH "type * QPtrStack::current () const" +Returns a pointer to the top item on the stack (most recently pushed). The stack is not changed. Returns 0 if the stack is empty. +.SH "bool QPtrStack::isEmpty () const" +Returns TRUE if the stack contains no elements; otherwise returns FALSE. +.SH "QPtrStack::operator type * () const" +Returns a pointer to the top item on the stack (most recently pushed). The stack is not changed. Returns 0 if the stack is empty. +.SH "QPtrStack<type> & QPtrStack::operator= ( const QPtrStack<type> & s )" +Sets the contents of this stack by making a shallow copy of another stack \fIs\fR. Elements currently in this stack will be deleted if autoDelete() is TRUE. +.SH "type * QPtrStack::pop ()" +Removes the top item from the stack and returns it. The stack must not be empty. +.SH "void QPtrStack::push ( const type * d )" +Adds an element \fId\fR to the top of the stack. Last in, first out. +.SH "QDataStream & QPtrStack::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a stack item, \fIitem\fR, from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QPtrStack::remove ()" +Removes the top item from the stack and deletes it if autoDelete() is TRUE. Returns TRUE if there was an item to pop; otherwise returns FALSE. +.PP +See also clear(). +.SH "void QPtrStack::setAutoDelete ( bool enable )" +Defines whether this stack auto-deletes its contents. The same as QPtrCollection::setAutoDelete(). +.PP +If \fIenable\fR is TRUE the stack auto-deletes its contents; if \fIenable\fR is FALSE the stack does not delete its contents. +.PP +See also autoDelete(). +.SH "type * QPtrStack::top () const" +Returns a pointer to the top item on the stack (most recently pushed). The stack is not changed. Returns 0 if the stack is empty. +.SH "QDataStream & QPtrStack::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" +Writes a stack item, \fIitem\fR, to the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation does nothing. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqptrstack.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrstack.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqptrvector.3qt b/doc/man/man3/tqptrvector.3qt new file mode 100644 index 000000000..3515f113f --- /dev/null +++ b/doc/man/man3/tqptrvector.3qt @@ -0,0 +1,351 @@ +'\" t +.TH QPtrVector 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 +QPtrVector \- Template collection class that provides a vector (array) +.SH SYNOPSIS +\fC#include <ntqptrvector.h>\fR +.PP +Inherits QPtrCollection. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPtrVector\fR ()" +.br +.ti -1c +.BI "\fBQPtrVector\fR ( uint size )" +.br +.ti -1c +.BI "\fBQPtrVector\fR ( const QPtrVector<type> & v )" +.br +.ti -1c +.BI "\fB~QPtrVector\fR ()" +.br +.ti -1c +.BI "QPtrVector<type> & \fBoperator=\fR ( const QPtrVector<type> & v )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QPtrVector<type> & v ) const" +.br +.ti -1c +.BI "type ** \fBdata\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "virtual uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBresize\fR ( uint size )" +.br +.ti -1c +.BI "bool \fBinsert\fR ( uint i, const type * d )" +.br +.ti -1c +.BI "bool \fBremove\fR ( uint i )" +.br +.ti -1c +.BI "type * \fBtake\fR ( uint i )" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "bool \fBfill\fR ( const type * d, int size = -1 )" +.br +.ti -1c +.BI "void \fBsort\fR ()" +.br +.ti -1c +.BI "int \fBbsearch\fR ( const type * d ) const" +.br +.ti -1c +.BI "int \fBfindRef\fR ( const type * d, uint i = 0 ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( const type * d, uint i = 0 ) const" +.br +.ti -1c +.BI "uint \fBcontainsRef\fR ( const type * d ) const" +.br +.ti -1c +.BI "uint \fBcontains\fR ( const type * d ) const" +.br +.ti -1c +.BI "type * \fBoperator[]\fR ( int i ) const" +.br +.ti -1c +.BI "type * \fBat\fR ( uint i ) const" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "bool \fBautoDelete\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoDelete\fR ( bool enable )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual int \fBcompareItems\fR ( QPtrCollection::Item d1, QPtrCollection::Item d2 )" +.br +.ti -1c +.BI "virtual QDataStream & \fBread\fR ( QDataStream & s, QPtrCollection::Item & item )" +.br +.ti -1c +.BI "virtual QDataStream & \fBwrite\fR ( QDataStream & s, QPtrCollection::Item item ) const" +.br +.in -1c +.SH DESCRIPTION +The QPtrVector class is a template collection class that provides a vector (array). +.PP +QValueVector is an STL-compatible alternative to this class. +.PP +QPtrVector is implemented as a template class. Defines a template instance QPtrVector<X> to create a vector that contains pointers to X (X*). +.PP +A vector is the same as an array. The main difference between QPtrVector and QMemArray is that QPtrVector stores pointers to the elements, whereas QMemArray stores the elements themselves (i.e. QMemArray is value-based and QPtrVector is pointer-based). +.PP +Items are added to the vector using insert() or fill(). Items are removed with remove(). You can get a pointer to an item at a particular index position using at(). +.PP +Unless otherwise stated, all functions that remove items from the vector will also delete the element pointed to if auto-deletion is enabled. By default, auto-deletion is disabled; see setAutoDelete(). This behaviour can be changed in a subclass by reimplementing the virtual function deleteItem(). +.PP +Functions that compare items (find() and sort() for example) will do so using the virtual function compareItems(). The default implementation of this function only compares the pointer values. Reimplement compareItems() in a subclass to get searching and sorting based on the item contents. You can perform a linear search for a pointer in the vector using findRef(), or a binary search (of a sorted vector) using bsearch(). You can count the number of times an item appears in the vector with contains() or containsRef(). +.PP +See also QMemArray and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrVector::QPtrVector ()" +Constructs a null vector. +.PP +See also isNull(). +.SH "QPtrVector::QPtrVector ( uint size )" +Constructs an vector with room for \fIsize\fR items. Makes a null vector if \fIsize\fR == 0. +.PP +All \fIsize\fR positions in the vector are initialized to 0. +.PP +See also size(), resize(), and isNull(). +.SH "QPtrVector::QPtrVector ( const QPtrVector<type> & v )" +Constructs a copy of \fIv\fR. Only the pointers are copied (i.e. shallow copy). +.SH "QPtrVector::~QPtrVector ()" +Removes all items from the vector, and destroys the vector itself. +.PP +See also clear(). +.SH "type * QPtrVector::at ( uint i ) const" +Returns the item at position \fIi\fR, or 0 if there is no item at that position. \fIi\fR must be less than size(). +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "int QPtrVector::bsearch ( const type * d ) const" +In a sorted array, finds the first occurrence of \fId\fR using a binary search. For a sorted array, this is generally much faster than find(), which performs a linear search. +.PP +Returns the position of \fId\fR, or -1 if \fId\fR could not be found. \fId\fR must not be 0. +.PP +Compares items using the virtual function compareItems(). +.PP +See also sort() and find(). +.SH "void QPtrVector::clear ()\fC [virtual]\fR" +Removes all items from the vector, and destroys the vector itself. +.PP +The vector becomes a null vector. +.PP +See also isNull(). +.PP +Reimplemented from QPtrCollection. +.SH "int QPtrVector::compareItems ( QPtrCollection::Item d1, QPtrCollection::Item d2 )\fC [virtual protected]\fR" +This virtual function compares two list items. +.PP +Returns: +.TP +zero if \fId1\fR == \fId2\fR +.TP +nonzero if \fId1\fR != \fId2\fR +.PP +This function returns \fIint\fR rather than \fIbool\fR so that reimplementations can return one of three values and use it to sort by: +.TP +0 if \fId1\fR == \fId2\fR +.TP +> 0 (positive integer) if \fId1\fR > \fId2\fR +.TP +< 0 (negative integer) if \fId1\fR < \fId2\fR +.PP +The sort() and bsearch() functions require compareItems() to be implemented as described here. +.PP +This function should not modify the vector because some const functions call compareItems(). +.SH "uint QPtrVector::contains ( const type * d ) const" +Returns the number of occurrences of item \fId\fR in the vector. +.PP +Compares items using the virtual function compareItems(). +.PP +See also containsRef(). +.SH "uint QPtrVector::containsRef ( const type * d ) const" +Returns the number of occurrences of the item pointer \fId\fR in the vector. +.PP +This function does \fInot\fR use compareItems() to compare items. +.PP +See also findRef(). +.SH "uint QPtrVector::count () const\fC [virtual]\fR" +Returns the number of items in the vector. The vector is empty if count() == 0. +.PP +See also isEmpty(), size(), and isNull(). +.PP +Reimplemented from QPtrCollection. +.SH "type ** QPtrVector::data () const" +Returns a pointer to the actual vector data, which is an array of type*. +.PP +The vector is a null vector if data() == 0 (null pointer). +.PP +See also isNull(). +.SH "bool QPtrVector::fill ( const type * d, int size = -1 )" +Inserts item \fId\fR in all positions in the vector. Any existing items are removed. If \fId\fR is 0, the vector becomes empty. +.PP +If \fIsize\fR >= 0, the vector is first resized to \fIsize\fR. By default, \fIsize\fR is -1. +.PP +Returns TRUE if successful, i.e. \fIsize\fR is the same as the current size, or \fIsize\fR is larger and the memory has successfully been allocated; otherwise returns FALSE. +.PP +See also resize(), insert(), and isEmpty(). +.SH "int QPtrVector::find ( const type * d, uint i = 0 ) const" +Finds the first occurrence of item \fId\fR in the vector using a linear search. The search starts at position \fIi\fR, which must be less than size(). \fIi\fR is by default 0; i.e. the search starts at the start of the vector. +.PP +Returns the position of \fId\fR, or -1 if \fId\fR could not be found. +.PP +Compares items using the virtual function compareItems(). +.PP +Use the much faster bsearch() to search a sorted vector. +.PP +See also findRef() and bsearch(). +.SH "int QPtrVector::findRef ( const type * d, uint i = 0 ) const" +Finds the first occurrence of the item pointer \fId\fR in the vector using a linear search. The search starts at position \fIi\fR, which must be less than size(). \fIi\fR is by default 0; i.e. the search starts at the start of the vector. +.PP +Returns the position of \fId\fR, or -1 if \fId\fR could not be found. +.PP +This function does \fInot\fR use compareItems() to compare items. +.PP +Use the much faster bsearch() to search a sorted vector. +.PP +See also find() and bsearch(). +.SH "bool QPtrVector::insert ( uint i, const type * d )" +Sets position \fIi\fR in the vector to contain the item \fId\fR. \fIi\fR must be less than size(). Any previous element in position \fIi\fR is removed. +.PP +See also at(). +.SH "bool QPtrVector::isEmpty () const" +Returns TRUE if the vector is empty; otherwise returns FALSE. +.PP +See also count(). +.SH "bool QPtrVector::isNull () const" +Returns TRUE if the vector is null; otherwise returns FALSE. +.PP +A null vector has size() == 0 and data() == 0. +.PP +See also size(). +.SH "QPtrVector<type> & QPtrVector::operator= ( const QPtrVector<type> & v )" +Assigns \fIv\fR to this vector and returns a reference to this vector. +.PP +This vector is first cleared and then all the items from \fIv\fR are copied into the vector. Only the pointers are copied (i.e. shallow copy). +.PP +See also clear(). +.SH "bool QPtrVector::operator== ( const QPtrVector<type> & v ) const" +Returns TRUE if this vector and \fIv\fR are equal; otherwise returns FALSE. +.SH "type * QPtrVector::operator[] ( int i ) const" +Returns the item at position \fIi\fR, or 0 if there is no item at that position. \fIi\fR must be less than size(). +.PP +Equivalent to at( \fIi\fR ). +.PP +See also at(). +.SH "QDataStream & QPtrVector::read ( QDataStream & s, QPtrCollection::Item & item )\fC [virtual protected]\fR" +Reads a vector item, \fIitem\fR, from the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation sets \fIitem\fR to 0. +.PP +See also write(). +.SH "bool QPtrVector::remove ( uint i )" +Removes the item at position \fIi\fR in the vector, if there is one. \fIi\fR must be less than size(). +.PP +Returns TRUE if \fIi\fR is within range; otherwise returns FALSE. +.PP +See also take() and at(). +.SH "bool QPtrVector::resize ( uint size )" +Resizes (expands or shrinks) the vector to \fIsize\fR elements. The vector becomes a null vector if \fIsize\fR == 0. +.PP +Any items at position \fIsize\fR or beyond in the vector are removed. New positions are initialized to 0. +.PP +Returns TRUE if successful, i.e. if the memory was successfully allocated; otherwise returns FALSE. +.PP +See also size() and isNull(). +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. +.SH "uint QPtrVector::size () const" +Returns the size of the vector, i.e. the number of vector positions. This is also the maximum number of items the vector can hold. +.PP +The vector is a null vector if size() == 0. +.PP +See also isNull(), resize(), and count(). +.SH "void QPtrVector::sort ()" +Sorts the items in ascending order. Any empty positions will be put last. +.PP +Compares items using the virtual function compareItems(). +.PP +See also bsearch(). +.SH "type * QPtrVector::take ( uint i )" +Returns the item at position \fIi\fR in the vector, and removes that item from the vector. \fIi\fR must be less than size(). If there is no item at position \fIi\fR, 0 is returned. +.PP +Unlike remove(), this function does \fInot\fR call deleteItem() for the removed item. +.PP +See also remove() and at(). +.SH "QDataStream & QPtrVector::write ( QDataStream & s, QPtrCollection::Item item ) const\fC [virtual protected]\fR" +Writes a vector item, \fIitem\fR, to the stream \fIs\fR and returns a reference to the stream. +.PP +The default implementation does nothing. +.PP +See also read(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqptrvector.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqptrvector.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqpushbutton.3qt b/doc/man/man3/tqpushbutton.3qt new file mode 100644 index 000000000..864e6bb7f --- /dev/null +++ b/doc/man/man3/tqpushbutton.3qt @@ -0,0 +1,468 @@ +'\" t +.TH QPushButton 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 +QPushButton \- Command button +.SH SYNOPSIS +\fC#include <ntqpushbutton.h>\fR +.PP +Inherits QButton. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQPushButton\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQPushButton\fR ( const QString & text, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQPushButton\fR ( const QIconSet & icon, const QString & text, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QPushButton\fR ()" +.br +.ti -1c +.BI "void \fBsetToggleButton\fR ( bool )" +.br +.ti -1c +.BI "bool \fBautoDefault\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoDefault\fR ( bool autoDef )" +.br +.ti -1c +.BI "bool \fBisDefault\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDefault\fR ( bool def )" +.br +.ti -1c +.BI "virtual void setIsMenuButton ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool isMenuButton () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetPopup\fR ( QPopupMenu * popup )" +.br +.ti -1c +.BI "QPopupMenu * \fBpopup\fR () const" +.br +.ti -1c +.BI "void \fBsetIconSet\fR ( const QIconSet & )" +.br +.ti -1c +.BI "QIconSet * \fBiconSet\fR () const" +.br +.ti -1c +.BI "void \fBsetFlat\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisFlat\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetOn\fR ( bool )" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "const QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" +.br +.ti -1c +.BI "QKeySequence \fBaccel\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" +.br +.ti -1c +.BI "bool \fBisToggleButton\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDown\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisDown\fR () const" +.br +.ti -1c +.BI "bool \fBisOn\fR () const" +.br +.ti -1c +.BI "ToggleState \fBstate\fR () const" +.br +.ti -1c +.BI "bool \fBautoRepeat\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoRepeat\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisExclusiveToggle\fR () const" +.br +.ti -1c +.BI "QButtonGroup * \fBgroup\fR () const" +.br +.ti -1c +.BI "void \fBtoggle\fR ()" +.br +.ti -1c +.BI "void \fBpressed\fR ()" +.br +.ti -1c +.BI "void \fBreleased\fR ()" +.br +.ti -1c +.BI "void \fBclicked\fR ()" +.br +.ti -1c +.BI "void \fBtoggled\fR ( bool on )" +.br +.ti -1c +.BI "void \fBstateChanged\fR ( int state )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoDefault\fR - whether the push button is the auto default button" +.br +.ti -1c +.BI "bool \fBautoMask\fR - whether the button is automatically masked \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBdefault\fR - whether the push button is the default button" +.br +.ti -1c +.BI "bool \fBflat\fR - whether the border is disabled" +.br +.ti -1c +.BI "QIconSet \fBiconSet\fR - the icon set on the push button" +.br +.ti -1c +.BI "bool menuButton - whether the push button has a menu button on it \fI(read " "only" ")\fR \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBon\fR - whether the push button is toggled" +.br +.ti -1c +.BI "bool \fBtoggleButton\fR - whether the button is a toggle button" +.br +.in -1c +.SH DESCRIPTION +The QPushButton widget provides a command button. +.PP +The push button, or command button, is perhaps the most commonly used widget in any graphical user interface. Push (click) a button to command the computer to perform some action, or to answer a question. Typical buttons are OK, Apply, Cancel, Close, Yes, No and Help. +.PP +A command button is rectangular and typically displays a text label describing its action. An underlined character in the label (signified by preceding it with an ampersand in the text) indicates an accelerator key, e.g. +.PP +.nf +.br + QPushButton *pb = new QPushButton( "&Download", this ); +.br +.fi +In this example the accelerator is \fIAlt+D\fR, and the label text will be displayed as \fB<u>D</u>ownload\fR. +.PP +Push buttons can display a textual label or a pixmap, and optionally a small icon. These can be set using the constructors and changed later using setText(), setPixmap() and setIconSet(). If the button is disabled the appearance of the text or pixmap and iconset will be manipulated with respect to the GUI style to make the button look "disabled". +.PP +A push button emits the signal clicked() when it is activated by the mouse, the Spacebar or by a keyboard accelerator. Connect to this signal to perform the button's action. Push buttons also provide less commonly used signals, for example, pressed() and released(). +.PP +Command buttons in dialogs are by default auto-default buttons, i.e. they become the default push button automatically when they receive the keyboard input focus. A default button is a push button that is activated when the user presses the Enter or Return key in a dialog. You can change this with setAutoDefault(). Note that auto-default buttons reserve a little extra space which is necessary to draw a default-button indicator. If you do not want this space around your buttons, call setAutoDefault(FALSE). +.PP +Being so central, the button widget has grown to accommodate a great many variations in the past decade. The Microsoft style guide now shows about ten different states of Windows push buttons and the text implies that there are dozens more when all the combinations of features are taken into consideration. +.PP +The most important modes or states are: +.TP +Available or not (grayed out, disabled). +.TP +Standard push button, toggling push button or menu button. +.TP +On or off (only for toggling push buttons). +.TP +Default or normal. The default button in a dialog can generally be "clicked" using the Enter or Return key. +.TP +Auto-repeat or not. +.TP +Pressed down or not. +.PP +As a general rule, use a push button when the application or dialog window performs an action when the user clicks on it (such as Apply, Cancel, Close and Help) \fIand\fR when the widget is supposed to have a wide, rectangular shape with a text label. Small, typically square buttons that change the state of the window rather than performing an action (such as the buttons in the top-right corner of the QFileDialog) are not command buttons, but tool buttons. Qt provides a special class (QToolButton) for these buttons. +.PP +If you need toggle behavior (see setToggleButton()) or a button that auto-repeats the activation signal when being pushed down like the arrows in a scroll bar (see setAutoRepeat()), a command button is probably not what you want. When in doubt, use a tool button. +.PP +A variation of a command button is a menu button. These provide not just one command, but several, since when they are clicked they pop up a menu of options. Use the method setPopup() to associate a popup menu with a push button. +.PP +Other classes of buttons are option buttons (see QRadioButton) and check boxes (see QCheckBox). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +In Qt, the QButton abstract base class provides most of the modes and other API, and QPushButton provides GUI logic. See QButton for more information about the API. +.PP +See also QToolButton, QRadioButton, QCheckBox, GUI Design Handbook: Push Button, and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPushButton::QPushButton ( QWidget * parent, const char * name = 0 )" +Constructs a push button with no text. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.SH "QPushButton::QPushButton ( const QString & text, QWidget * parent, const char * name = 0 )" +Constructs a push button called \fIname\fR with the parent \fIparent\fR and the text \fItext\fR. +.SH "QPushButton::QPushButton ( const QIconSet & icon, const QString & text, QWidget * parent, const char * name = 0 )" +Constructs a push button with an \fIicon\fR and a \fItext\fR. +.PP +Note that you can also pass a QPixmap object as an icon (thanks to the implicit type conversion provided by C++). +.PP +The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. +.SH "QPushButton::~QPushButton ()" +Destroys the push button. +.SH "QKeySequence QButton::accel () const" +Returns the accelerator associated with the button. See the "accel" property for details. +.SH "bool QPushButton::autoDefault () const" +Returns TRUE if the push button is the auto default button; otherwise returns FALSE. See the "autoDefault" property for details. +.SH "bool QButton::autoRepeat () const" +Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. +.SH "void QButton::clicked ()\fC [signal]\fR" +This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). +.PP +The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. +.PP +\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. +.PP +See also pressed(), released(), toggled(), autoRepeat, and down. +.PP +Examples: +.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. +.SH "QButtonGroup * QButton::group () const" +Returns the group that this button belongs to. +.PP +If the button is not a member of any QButtonGroup, this function returns 0. +.PP +See also QButtonGroup. +.SH "QIconSet * QPushButton::iconSet () const" +Returns the icon set on the push button. See the "iconSet" property for details. +.SH "bool QPushButton::isDefault () const" +Returns TRUE if the push button is the default button; otherwise returns FALSE. See the "default" property for details. +.SH "bool QButton::isDown () const" +Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. +.SH "bool QButton::isExclusiveToggle () const" +Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. +.SH "bool QPushButton::isFlat () const" +Returns TRUE if the border is disabled; otherwise returns FALSE. See the "flat" property for details. +.SH "bool QPushButton::isMenuButton () const" +Returns TRUE if the push button has a menu button on it; otherwise returns FALSE. See the "menuButton" property for details. +.SH "bool QButton::isOn () const" +Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. +.SH "bool QButton::isToggleButton () const" +Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. +.SH "const QPixmap * QButton::pixmap () const" +Returns the pixmap shown on the button. See the "pixmap" property for details. +.SH "QPopupMenu * QPushButton::popup () const" +Returns the button's associated popup menu or 0 if no popup menu has been set. +.PP +See also setPopup(). +.SH "void QButton::pressed ()\fC [signal]\fR" +This signal is emitted when the button is pressed down. +.PP +See also released() and clicked(). +.PP +Examples: +.)l network/httpd/httpd.cpp and popup/popup.cpp. +.SH "void QButton::released ()\fC [signal]\fR" +This signal is emitted when the button is released. +.PP +See also pressed(), clicked(), and toggled(). +.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" +Sets the accelerator associated with the button. See the "accel" property for details. +.SH "void QPushButton::setAutoDefault ( bool autoDef )\fC [virtual]\fR" +Sets whether the push button is the auto default button to \fIautoDef\fR. See the "autoDefault" property for details. +.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" +Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. +.SH "void QPushButton::setDefault ( bool def )\fC [virtual]\fR" +Sets whether the push button is the default button to \fIdef\fR. See the "default" property for details. +.SH "void QButton::setDown ( bool )\fC [virtual]\fR" +Sets whether the button is pressed. See the "down" property for details. +.SH "void QPushButton::setFlat ( bool )" +Sets whether the border is disabled. See the "flat" property for details. +.SH "void QPushButton::setIconSet ( const QIconSet & )" +Sets the icon set on the push button. See the "iconSet" property for details. +.SH "void QPushButton::setIsMenuButton ( bool enable )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QPushButton::setOn ( bool )\fC [virtual slot]\fR" +Sets whether the push button is toggled. See the "on" property for details. +.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" +Sets the pixmap shown on the button. See the "pixmap" property for details. +.SH "void QPushButton::setPopup ( QPopupMenu * popup )" +Associates the popup menu \fIpopup\fR with this push button. This turns the button into a menu button. +.PP +Ownership of the popup menu is \fInot\fR transferred to the push button. +.PP +See also popup(). +.PP +Examples: +.)l buttongroups/buttongroups.cpp and qdir/qdir.cpp. +.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" +Sets the text shown on the button. See the "text" property for details. +.SH "void QPushButton::setToggleButton ( bool )" +Sets whether the button is a toggle button. See the "toggleButton" property for details. +.SH "ToggleState QButton::state () const" +Returns the state of the toggle button. See the "toggleState" property for details. +.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. +.PP +See also clicked() and QButton::ToggleState. +.SH "QString QButton::text () const" +Returns the text shown on the button. See the "text" property for details. +.SH "void QButton::toggle ()\fC [slot]\fR" +Toggles the state of a toggle button. +.PP +See also on, on, toggled(), and toggleButton. +.SH "void QButton::toggled ( bool on )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, or because setOn() was called. +.PP +See also clicked(). +.PP +Example: listbox/listbox.cpp. +.SS "Property Documentation" +.SH "QKeySequence accel" +This property holds the accelerator associated with the button. +.PP +This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. +.PP +Set this property's value with setAccel() and get this property's value with accel(). +.SH "bool autoDefault" +This property holds whether the push button is the auto default button. +.PP +If this property is set to TRUE then the push button is the auto default button in a dialog. +.PP +In some GUI styles a default button is drawn with an extra frame around it, up to 3 pixels or more. Qt automatically keeps this space free around auto-default buttons, i.e. auto-default buttons may have a slightly larger size hint. +.PP +This property's default is TRUE for buttons that have a QDialog parent; otherwise it defaults to FALSE. +.PP +See the default property for details of how default and auto-default interact. +.PP +Set this property's value with setAutoDefault() and get this property's value with autoDefault(). +.SH "bool autoMask" +This property holds whether the button is automatically masked. +.PP +See also QWidget::autoMask. +.SH "bool autoRepeat" +This property holds whether autoRepeat is enabled. +.PP +If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. +.PP +Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). +.SH "bool default" +This property holds whether the push button is the default button. +.PP +If this property is set to TRUE then the push button will be pressed if the user presses the Enter (or Return) key in a dialog. +.PP +Regardless of focus, if the user presses Enter: If there is a default button the default button is pressed; otherwise, if there are one or more autoDefault buttons the first autoDefault button that is next in the tab order is pressed. If there are no default or autoDefault buttons only pressing Space on a button with focus, mouse clicking, or using an accelerator will press a button. +.PP +In a dialog, only one push button at a time can be the default button. This button is then displayed with an additional frame (depending on the GUI style). +.PP +The default button behavior is provided only in dialogs. Buttons can always be clicked from the keyboard by pressing Enter (or Return) or the Spacebar when the button has focus. +.PP +This property's default is FALSE. +.PP +Set this property's value with setDefault() and get this property's value with isDefault(). +.SH "bool flat" +This property holds whether the border is disabled. +.PP +This property's default is FALSE. +.PP +Set this property's value with setFlat() and get this property's value with isFlat(). +.SH "QIconSet iconSet" +This property holds the icon set on the push button. +.PP +This property will return 0 if the push button has no iconset. +.PP +Set this property's value with setIconSet() and get this property's value with iconSet(). +.SH "bool menuButton" +This property holds whether the push button has a menu button on it. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +If this property is set to TRUE, then a down arrow is drawn on the push button to indicate that a menu will pop up if the user clicks on the arrow. +.PP +Get this property's value with isMenuButton(). +.SH "bool on" +This property holds whether the push button is toggled. +.PP +This property should only be set for toggle push buttons. The default value is FALSE. +.PP +See also on, toggle(), toggled(), and toggleButton. +.PP +Set this property's value with setOn(). +.SH "QPixmap pixmap" +This property holds the pixmap shown on the button. +.PP +If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. +.PP +pixmap() returns 0 if no pixmap was set. +.PP +Set this property's value with setPixmap() and get this property's value with pixmap(). +.SH "QString text" +This property holds the text shown on the button. +.PP +This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. +.PP +There is no default text. +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "bool toggleButton" +This property holds whether the button is a toggle button. +.PP +Toggle buttons have an on/off state similar to check boxes. A push button is initially not a toggle button. +.PP +See also on, toggle(), toggleButton, and toggled(). +.PP +Set this property's value with setToggleButton(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqpushbutton.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqpushbutton.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqradiobutton.3qt b/doc/man/man3/tqradiobutton.3qt new file mode 100644 index 000000000..ff856b401 --- /dev/null +++ b/doc/man/man3/tqradiobutton.3qt @@ -0,0 +1,278 @@ +'\" t +.TH QRadioButton 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 +QRadioButton \- Radio button with a text or pixmap label +.SH SYNOPSIS +\fC#include <ntqradiobutton.h>\fR +.PP +Inherits QButton. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQRadioButton\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQRadioButton\fR ( const QString & text, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "bool \fBisChecked\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetChecked\fR ( bool check )" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & )" +.br +.ti -1c +.BI "const QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & )" +.br +.ti -1c +.BI "QKeySequence \fBaccel\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAccel\fR ( const QKeySequence & )" +.br +.ti -1c +.BI "bool \fBisToggleButton\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDown\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisDown\fR () const" +.br +.ti -1c +.BI "bool \fBisOn\fR () const" +.br +.ti -1c +.BI "ToggleState \fBstate\fR () const" +.br +.ti -1c +.BI "bool \fBautoRepeat\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoRepeat\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisExclusiveToggle\fR () const" +.br +.ti -1c +.BI "QButtonGroup * \fBgroup\fR () const" +.br +.ti -1c +.BI "void \fBtoggle\fR ()" +.br +.ti -1c +.BI "void \fBpressed\fR ()" +.br +.ti -1c +.BI "void \fBreleased\fR ()" +.br +.ti -1c +.BI "void \fBclicked\fR ()" +.br +.ti -1c +.BI "void \fBtoggled\fR ( bool on )" +.br +.ti -1c +.BI "void \fBstateChanged\fR ( int state )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoMask\fR - whether the radio button is automatically masked \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBchecked\fR - whether the radio button is checked" +.br +.in -1c +.SH DESCRIPTION +The QRadioButton widget provides a radio button with a text or pixmap label. +.PP +QRadioButton and QCheckBox are both option buttons. That is, they can be switched on (checked) or off (unchecked). The classes differ in how the choices for the user are restricted. Check boxes define "many of many" choices, whereas radio buttons provide a" one of many" choice. In a group of radio buttons only one radio button at a time can be checked; if the user selects another button, the previously selected button is switched off. +.PP +The easiest way to implement a "one of many" choice is simply to put the radio buttons into QButtonGroup. +.PP +Whenever a button is switched on or off it emits the signal toggled(). Connect to this signal if you want to trigger an action each time the button changes state. Otherwise, use isChecked() to see if a particular button is selected. +.PP +Just like QPushButton, a radio button can display text or a pixmap. The text can be set in the constructor or with setText(); the pixmap is set with setPixmap(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QPushButton, QToolButton, GUI Design Handbook: Radio Button, and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRadioButton::QRadioButton ( QWidget * parent, const char * name = 0 )" +Constructs a radio button with no text. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.SH "QRadioButton::QRadioButton ( const QString & text, QWidget * parent, const char * name = 0 )" +Constructs a radio button with the text \fItext\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.SH "QKeySequence QButton::accel () const" +Returns the accelerator associated with the button. See the "accel" property for details. +.SH "bool QButton::autoRepeat () const" +Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. +.SH "void QButton::clicked ()\fC [signal]\fR" +This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button), when the accelerator key is typed or when animateClick() is called. This signal is \fInot\fR emitted if you call setDown(). +.PP +The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. +.PP +\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on. +.PP +See also pressed(), released(), toggled(), autoRepeat, and down. +.PP +Examples: +.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp. +.SH "QButtonGroup * QButton::group () const" +Returns the group that this button belongs to. +.PP +If the button is not a member of any QButtonGroup, this function returns 0. +.PP +See also QButtonGroup. +.SH "bool QRadioButton::isChecked () const" +Returns TRUE if the radio button is checked; otherwise returns FALSE. See the "checked" property for details. +.SH "bool QButton::isDown () const" +Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. +.SH "bool QButton::isExclusiveToggle () const" +Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details. +.SH "bool QButton::isOn () const" +Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. +.SH "bool QButton::isToggleButton () const" +Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. +.SH "const QPixmap * QButton::pixmap () const" +Returns the pixmap shown on the button. See the "pixmap" property for details. +.SH "void QButton::pressed ()\fC [signal]\fR" +This signal is emitted when the button is pressed down. +.PP +See also released() and clicked(). +.PP +Examples: +.)l network/httpd/httpd.cpp and popup/popup.cpp. +.SH "void QButton::released ()\fC [signal]\fR" +This signal is emitted when the button is released. +.PP +See also pressed(), clicked(), and toggled(). +.SH "void QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" +Sets the accelerator associated with the button. See the "accel" property for details. +.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" +Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. +.SH "void QRadioButton::setChecked ( bool check )\fC [virtual slot]\fR" +Sets whether the radio button is checked to \fIcheck\fR. See the "checked" property for details. +.SH "void QButton::setDown ( bool )\fC [virtual]\fR" +Sets whether the button is pressed. See the "down" property for details. +.SH "void QButton::setPixmap ( const QPixmap & )\fC [virtual]\fR" +Sets the pixmap shown on the button. See the "pixmap" property for details. +.SH "void QButton::setText ( const QString & )\fC [virtual]\fR" +Sets the text shown on the button. See the "text" property for details. +.SH "ToggleState QButton::state () const" +Returns the state of the toggle button. See the "toggleState" property for details. +.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called. +.PP +See also clicked() and QButton::ToggleState. +.SH "QString QButton::text () const" +Returns the text shown on the button. See the "text" property for details. +.SH "void QButton::toggle ()\fC [slot]\fR" +Toggles the state of a toggle button. +.PP +See also on, setOn(), toggled(), and toggleButton. +.SH "void QButton::toggled ( bool on )\fC [signal]\fR" +This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off. +.PP +This may be the result of a user action, toggle() slot activation, or because setOn() was called. +.PP +See also clicked(). +.PP +Example: listbox/listbox.cpp. +.SS "Property Documentation" +.SH "QKeySequence accel" +This property holds the accelerator associated with the button. +.PP +This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed. +.PP +Set this property's value with setAccel() and get this property's value with accel(). +.SH "bool autoMask" +This property holds whether the radio button is automatically masked. +.PP +See also QWidget::autoMask. +.SH "bool autoRepeat" +This property holds whether autoRepeat is enabled. +.PP +If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default. +.PP +Set this property's value with setAutoRepeat() and get this property's value with autoRepeat(). +.SH "bool checked" +This property holds whether the radio button is checked. +.PP +This property will not effect any other radio buttons unless they have been placed in the same QButtonGroup. The default value is FALSE (unchecked). +.PP +Set this property's value with setChecked() and get this property's value with isChecked(). +.SH "QPixmap pixmap" +This property holds the pixmap shown on the button. +.PP +If the pixmap is monochrome (i.e. it is a QBitmap or its depth is 1) and it does not have a mask, this property will set the pixmap to be its own mask. The purpose of this is to draw transparent bitmaps which are important for toggle buttons, for example. +.PP +pixmap() returns 0 if no pixmap was set. +.PP +Set this property's value with setPixmap() and get this property's value with pixmap(). +.SH "QString text" +This property holds the text shown on the button. +.PP +This property will return a QString::null if the button has no text. If the text has an ampersand (&) in it, then an accelerator is automatically created for it using the character that follows the '&' as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text. +.PP +There is no default text. +.PP +Set this property's value with setText() and get this property's value with text(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqradiobutton.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqradiobutton.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqrangecontrol.3qt b/doc/man/man3/tqrangecontrol.3qt new file mode 100644 index 000000000..58e74f830 --- /dev/null +++ b/doc/man/man3/tqrangecontrol.3qt @@ -0,0 +1,294 @@ +'\" t +.TH QRangeControl 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 +QRangeControl \- Integer value within a range +.SH SYNOPSIS +\fC#include <ntqrangecontrol.h>\fR +.PP +Inherited by QDial, QScrollBar, QSlider, and QSpinBox. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQRangeControl\fR ()" +.br +.ti -1c +.BI "\fBQRangeControl\fR ( int minValue, int maxValue, int lineStep, int pageStep, int value )" +.br +.ti -1c +.BI "virtual \fB~QRangeControl\fR ()" +.br +.ti -1c +.BI "int \fBvalue\fR () const" +.br +.ti -1c +.BI "void \fBsetValue\fR ( int value )" +.br +.ti -1c +.BI "void \fBaddPage\fR ()" +.br +.ti -1c +.BI "void \fBsubtractPage\fR ()" +.br +.ti -1c +.BI "void \fBaddLine\fR ()" +.br +.ti -1c +.BI "void \fBsubtractLine\fR ()" +.br +.ti -1c +.BI "int \fBminValue\fR () const" +.br +.ti -1c +.BI "int \fBmaxValue\fR () const" +.br +.ti -1c +.BI "void \fBsetRange\fR ( int minValue, int maxValue )" +.br +.ti -1c +.BI "void \fBsetMinValue\fR ( int minVal )" +.br +.ti -1c +.BI "void \fBsetMaxValue\fR ( int maxVal )" +.br +.ti -1c +.BI "int \fBlineStep\fR () const" +.br +.ti -1c +.BI "int \fBpageStep\fR () const" +.br +.ti -1c +.BI "void \fBsetSteps\fR ( int lineStep, int pageStep )" +.br +.ti -1c +.BI "int \fBbound\fR ( int v ) const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "int \fBpositionFromValue\fR ( int logical_val, int span ) const" +.br +.ti -1c +.BI "int \fBvalueFromPosition\fR ( int pos, int span ) const" +.br +.ti -1c +.BI "void \fBdirectSetValue\fR ( int value )" +.br +.ti -1c +.BI "int \fBprevValue\fR () const" +.br +.ti -1c +.BI "virtual void \fBvalueChange\fR ()" +.br +.ti -1c +.BI "virtual void \fBrangeChange\fR ()" +.br +.ti -1c +.BI "virtual void \fBstepChange\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QRangeControl class provides an integer value within a range. +.PP +Although originally designed for the QScrollBar widget, the QRangeControl can also be used in conjunction with other widgets such as QSlider and QSpinBox. Here are the five main concepts in the class: +.PP +<ol type=1> +.IP 1 +\fICurrent value\fR The bounded integer that QRangeControl maintains. value() returns it, and several functions, including setValue(), set it. +.IP 2 +\fIMinimum\fR The lowest value that value() can ever return. Returned by minValue() and set by setRange() or one of the constructors. +.IP 3 +\fIMaximum\fR The highest value that value() can ever return. Returned by maxValue() and set by setRange() or one of the constructors. +.IP 4 +\fILine step\fR The smaller of two natural steps that QRangeControl provides and typically corresponds to the user pressing an arrow key. The line step is returned by lineStep() and set using setSteps(). The functions addLine() and subtractLine() respectively increment and decrement the current value by lineStep(). +.IP 5 +\fIPage step\fR The larger of two natural steps that QRangeControl provides and typically corresponds to the user pressing PageUp or PageDown. The page step is returned by pageStep() and set using setSteps(). The functions addPage() and substractPage() respectively increment and decrement the current value by pageStep(). +.IP +.PP +Unity (1) may be viewed as a third step size. setValue() lets you set the current value to any integer in the allowed range, not just minValue() + \fIn\fR * lineStep() for integer values of \fIn\fR. Some widgets may allow the user to set any value at all; others may just provide multiples of lineStep() or pageStep(). +.PP +QRangeControl provides three virtual functions that are well suited for updating the on-screen representation of range controls and emitting signals: valueChange(), rangeChange() and stepChange(). +.PP +QRangeControl also provides a function called bound() which lets you force arbitrary integers to be within the allowed range of the range control. +.PP +We recommend that all widgets that inherit QRangeControl provide at least a signal called valueChanged(); many widgets will want to provide addStep(), addPage(), substractStep() and substractPage() as slots. +.PP +Note that you must use multiple inheritance if you plan to implement a widget using QRangeControl because QRangeControl is not derived from QWidget. +.PP +See also Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRangeControl::QRangeControl ()" +Constructs a range control with a minimum value of 0, maximum value of 99, line step of 1, page step of 10 and initial value 0. +.SH "QRangeControl::QRangeControl ( int minValue, int maxValue, int lineStep, int pageStep, int value )" +Constructs a range control whose value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR, whose line step size is \fIlineStep\fR and page step size is \fIpageStep\fR and whose value is initially \fIvalue\fR (which is guaranteed to be in range using bound()). +.SH "QRangeControl::~QRangeControl ()\fC [virtual]\fR" +Destroys the range control +.SH "void QRangeControl::addLine ()" +Equivalent to \fCsetValue( value() + lineStep() )\fR. +.PP +If the value is changed, then valueChange() is called. +.PP +See also subtractLine(), addPage(), and setValue(). +.SH "void QRangeControl::addPage ()" +Equivalent to \fCsetValue( value() + pageStep() )\fR. +.PP +If the value is changed, then valueChange() is called. +.PP +See also subtractPage(), addLine(), and setValue(). +.SH "int QRangeControl::bound ( int v ) const" +Forces the value \fIv\fR to be within the range from minValue() to maxValue() inclusive, and returns the result. +.PP +This function is provided so that you can easily force other numbers than value() into the allowed range. You do not need to call it in order to use QRangeControl itself. +.PP +See also setValue(), value(), minValue(), and maxValue(). +.SH "void QRangeControl::directSetValue ( int value )\fC [protected]\fR" +Sets the range control \fIvalue\fR directly without calling valueChange(). +.PP +Forces the new \fIvalue\fR to be within the legal range. +.PP +You will rarely have to call this function. However, if you want to change the range control's value inside the overloaded method valueChange(), setValue() would call the function valueChange() again. To avoid this recursion you must use directSetValue() instead. +.PP +See also setValue(). +.SH "int QRangeControl::lineStep () const" +Returns the line step. +.PP +See also setSteps() and pageStep(). +.SH "int QRangeControl::maxValue () const" +Returns the maximum value of the range. +.PP +See also setMaxValue(), setRange(), and minValue(). +.SH "int QRangeControl::minValue () const" +Returns the minimum value of the range. +.PP +See also setMinValue(), setRange(), and maxValue(). +.SH "int QRangeControl::pageStep () const" +Returns the page step. +.PP +See also setSteps() and lineStep(). +.SH "int QRangeControl::positionFromValue ( int logical_val, int span ) const\fC [protected]\fR" +Converts \fIlogical_val\fR to a pixel position. minValue() maps to 0, maxValue() maps to \fIspan\fR and other values are distributed evenly in-between. +.PP +This function can handle the entire integer range without overflow, providing \fIspan\fR is <= 4096. +.PP +Calling this method is useful when actually drawing a range control such as a QScrollBar on-screen. +.PP +See also valueFromPosition(). +.SH "int QRangeControl::prevValue () const\fC [protected]\fR" +Returns the previous value of the range control. "Previous value" means the value before the last change occurred. Setting a new range may affect the value, too, because the value is forced to be inside the specified range. When the range control is initially created, this is the same as value(). +.PP +prevValue() can be outside the current legal range if a call to setRange() causes the current value to change. For example, if the range was [0, 1000] and the current value is 500, setRange(0, 400) makes value() return 400 and prevValue() return 500. +.PP +See also value() and setRange(). +.SH "void QRangeControl::rangeChange ()\fC [virtual protected]\fR" +This virtual function is called whenever the range control's range changes. You can reimplement it if you want to be notified when the range changes. The default implementation does nothing. +.PP +Note that this method is called after the range has changed. +.PP +See also setRange(), valueChange(), and stepChange(). +.PP +Reimplemented in QDial, QSlider, and QSpinBox. +.SH "void QRangeControl::setMaxValue ( int maxVal )" +Sets the minimum value of the range to \fImaxVal\fR. +.PP +If necessary, the minValue() is adjusted so that the range remains valid. +.PP +See also maxValue() and setMinValue(). +.SH "void QRangeControl::setMinValue ( int minVal )" +Sets the minimum value of the range to \fIminVal\fR. +.PP +If necessary, the maxValue() is adjusted so that the range remains valid. +.PP +See also minValue() and setMaxValue(). +.SH "void QRangeControl::setRange ( int minValue, int maxValue )" +Sets the range control's minimum value to \fIminValue\fR and its maximum value to \fImaxValue\fR. +.PP +Calls the virtual rangeChange() function if one or both of the new minimum and maximum values are different from the previous setting. Calls the virtual valueChange() function if the current value is adjusted because it was outside the new range. +.PP +If \fImaxValue\fR is smaller than \fIminValue\fR, \fIminValue\fR becomes the only legal value. +.PP +See also minValue() and maxValue(). +.PP +Examples: +.)l listbox/listbox.cpp, t12/lcdrange.cpp, t5/main.cpp, t6/main.cpp, t8/lcdrange.cpp, and xform/xform.cpp. +.SH "void QRangeControl::setSteps ( int lineStep, int pageStep )" +Sets the range's line step to \fIlineStep\fR and page step to \fIpageStep\fR. +.PP +Calls the virtual stepChange() function if the new line step or page step are different from the previous settings. +.PP +See also lineStep(), pageStep(), and setRange(). +.SH "void QRangeControl::setValue ( int value )" +Sets the range control's value to \fIvalue\fR and forces it to be within the legal range. +.PP +Calls the virtual valueChange() function if the new value is different from the previous value. The old value can still be retrieved using prevValue(). +.PP +See also value(). +.SH "void QRangeControl::stepChange ()\fC [virtual protected]\fR" +This virtual function is called whenever the range control's line or page step settings change. You can reimplement it if you want to be notified when the step changes. The default implementation does nothing. +.PP +Note that this method is called after a step setting has changed. +.PP +See also setSteps(), rangeChange(), and valueChange(). +.SH "void QRangeControl::subtractLine ()" +Equivalent to \fCsetValue( value() - lineStep() )\fR. +.PP +If the value is changed, then valueChange() is called. +.PP +See also addLine(), subtractPage(), and setValue(). +.SH "void QRangeControl::subtractPage ()" +Equivalent to \fCsetValue( value() - pageStep() )\fR. +.PP +If the value is changed, then valueChange() is called. +.PP +See also addPage(), subtractLine(), and setValue(). +.SH "int QRangeControl::value () const" +Returns the current range control value. This is guaranteed to be within the range [minValue(), maxValue()]. +.PP +See also setValue() and prevValue(). +.SH "void QRangeControl::valueChange ()\fC [virtual protected]\fR" +This virtual function is called whenever the range control value changes. You can reimplement it if you want to be notified when the value changes. The default implementation does nothing. +.PP +Note that this method is called after the value has changed. The previous value can be retrieved using prevValue(). +.PP +See also setValue(), addPage(), subtractPage(), addLine(), subtractLine(), rangeChange(), and stepChange(). +.PP +Reimplemented in QDial, QSlider, and QSpinBox. +.SH "int QRangeControl::valueFromPosition ( int pos, int span ) const\fC [protected]\fR" +Converts the pixel position \fIpos\fR to a value. 0 maps to minValue(), \fIspan\fR maps to maxValue() and other values are distributed evenly in-between. +.PP +This function can handle the entire integer range without overflow. +.PP +Calling this method is useful if you actually implemented a range control widget such as QScrollBar and want to handle mouse press events. This function then maps screen coordinates to the logical values. +.PP +See also positionFromValue(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqrangecontrol.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqrangecontrol.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqrect.3qt b/doc/man/man3/tqrect.3qt new file mode 100644 index 000000000..86f6ebb0f --- /dev/null +++ b/doc/man/man3/tqrect.3qt @@ -0,0 +1,662 @@ +'\" t +.TH QRect 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 +QRect \- Defines a rectangle in the plane +.SH SYNOPSIS +\fC#include <ntqrect.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQRect\fR ()" +.br +.ti -1c +.BI "\fBQRect\fR ( const QPoint & topLeft, const QPoint & bottomRight )" +.br +.ti -1c +.BI "\fBQRect\fR ( const QPoint & topLeft, const QSize & size )" +.br +.ti -1c +.BI "\fBQRect\fR ( int left, int top, int width, int height )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "QRect \fBnormalize\fR () const" +.br +.ti -1c +.BI "int \fBleft\fR () const" +.br +.ti -1c +.BI "int \fBtop\fR () const" +.br +.ti -1c +.BI "int \fBright\fR () const" +.br +.ti -1c +.BI "int \fBbottom\fR () const" +.br +.ti -1c +.BI "QCOORD & \fBrLeft\fR ()" +.br +.ti -1c +.BI "QCOORD & \fBrTop\fR ()" +.br +.ti -1c +.BI "QCOORD & \fBrRight\fR ()" +.br +.ti -1c +.BI "QCOORD & \fBrBottom\fR ()" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "void \fBsetLeft\fR ( int pos )" +.br +.ti -1c +.BI "void \fBsetTop\fR ( int pos )" +.br +.ti -1c +.BI "void \fBsetRight\fR ( int pos )" +.br +.ti -1c +.BI "void \fBsetBottom\fR ( int pos )" +.br +.ti -1c +.BI "void \fBsetX\fR ( int x )" +.br +.ti -1c +.BI "void \fBsetY\fR ( int y )" +.br +.ti -1c +.BI "void \fBsetTopLeft\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBsetBottomRight\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBsetTopRight\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBsetBottomLeft\fR ( const QPoint & p )" +.br +.ti -1c +.BI "QPoint \fBtopLeft\fR () const" +.br +.ti -1c +.BI "QPoint \fBbottomRight\fR () const" +.br +.ti -1c +.BI "QPoint \fBtopRight\fR () const" +.br +.ti -1c +.BI "QPoint \fBbottomLeft\fR () const" +.br +.ti -1c +.BI "QPoint \fBcenter\fR () const" +.br +.ti -1c +.BI "void \fBrect\fR ( int * x, int * y, int * w, int * h ) const" +.br +.ti -1c +.BI "void \fBcoords\fR ( int * xp1, int * yp1, int * xp2, int * yp2 ) const" +.br +.ti -1c +.BI "void \fBmoveLeft\fR ( int pos )" +.br +.ti -1c +.BI "void \fBmoveTop\fR ( int pos )" +.br +.ti -1c +.BI "void \fBmoveRight\fR ( int pos )" +.br +.ti -1c +.BI "void \fBmoveBottom\fR ( int pos )" +.br +.ti -1c +.BI "void \fBmoveTopLeft\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBmoveBottomRight\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBmoveTopRight\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBmoveBottomLeft\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBmoveCenter\fR ( const QPoint & p )" +.br +.ti -1c +.BI "void \fBmoveBy\fR ( int dx, int dy )" +.br +.ti -1c +.BI "void \fBsetRect\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBsetCoords\fR ( int xp1, int yp1, int xp2, int yp2 )" +.br +.ti -1c +.BI "void \fBaddCoords\fR ( int xp1, int yp1, int xp2, int yp2 )" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "void \fBsetWidth\fR ( int w )" +.br +.ti -1c +.BI "void \fBsetHeight\fR ( int h )" +.br +.ti -1c +.BI "void \fBsetSize\fR ( const QSize & s )" +.br +.ti -1c +.BI "QRect \fBoperator|\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "QRect \fBoperator&\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "QRect & \fBoperator|=\fR ( const QRect & r )" +.br +.ti -1c +.BI "QRect & \fBoperator&=\fR ( const QRect & r )" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QPoint & p, bool proper = FALSE ) const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( int x, int y ) const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( int x, int y, bool proper ) const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QRect & r, bool proper = FALSE ) const" +.br +.ti -1c +.BI "QRect \fBunite\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "QRect \fBintersect\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "bool \fBintersects\fR ( const QRect & r ) const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "bool \fBoperator==\fR ( const QRect & r1, const QRect & r2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QRect & r1, const QRect & r2 )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QRect & r )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QRect & r )" +.br +.in -1c +.SH DESCRIPTION +The QRect class defines a rectangle in the plane. +.PP +A rectangle is internally represented as an upper-left corner and a bottom-right corner, but it is normally expressed as an upper-left corner and a size. +.PP +The coordinate type is QCOORD (defined in ntqwindowdefs.h as \fCint\fR). The minimum value of QCOORD is QCOORD_MIN (-2147483648) and the maximum value is QCOORD_MAX (2147483647). +.PP +Note that the size (width and height) of a rectangle might be different from what you are used to. If the top-left corner and the bottom-right corner are the same, the height and the width of the rectangle will both be 1. +.PP +Generally, \fIwidth = right - left + 1\fR and \fIheight = bottom - top + 1\fR. We designed it this way to make it correspond to rectangular spaces used by drawing functions in which the width and height denote a number of pixels. For example, drawing a rectangle with width and height 1 draws a single pixel. +.PP +The default coordinate system has origin (0, 0) in the top-left corner. The positive direction of the y axis is down, and the positive x axis is from left to right. +.PP +A QRect can be constructed with a set of left, top, width and height integers, from two QPoints or from a QPoint and a QSize. After creation the dimensions can be changed, e.g. with setLeft(), setRight(), setTop() and setBottom(), or by setting sizes, e.g. setWidth(), setHeight() and setSize(). The dimensions can also be changed with the move functions, e.g. moveBy(), moveCenter(), moveBottomRight(), etc. You can also add coordinates to a rectangle with addCoords(). +.PP +You can test to see if a QRect contains a specific point with contains(). You can also test to see if two QRects intersect with intersects() (see also intersect()). To get the bounding rectangle of two QRects use unite(). +.PP +See also QPoint, QSize, Graphics Classes, and Image Processing Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRect::QRect ()" +Constructs an invalid rectangle. +.SH "QRect::QRect ( const QPoint & topLeft, const QPoint & bottomRight )" +Constructs a rectangle with \fItopLeft\fR as the top-left corner and \fIbottomRight\fR as the bottom-right corner. +.SH "QRect::QRect ( const QPoint & topLeft, const QSize & size )" +Constructs a rectangle with \fItopLeft\fR as the top-left corner and \fIsize\fR as the rectangle size. +.SH "QRect::QRect ( int left, int top, int width, int height )" +Constructs a rectangle with the \fItop\fR, \fIleft\fR corner and \fIwidth\fR and \fIheight\fR. +.PP +Example (creates three identical rectangles): +.PP +.nf +.br + QRect r1( QPoint(100,200), QPoint(110,215) ); +.br + QRect r2( QPoint(100,200), QSize(11,16) ); +.br + QRect r3( 100, 200, 11, 16 ); +.br +.fi +.SH "void QRect::addCoords ( int xp1, int yp1, int xp2, int yp2 )" +Adds \fIxp1\fR, \fIyp1\fR, \fIxp2\fR and \fIyp2\fR respectively to the existing coordinates of the rectangle. +.PP +Examples: +.)l multiple/ax1.h and multiple/ax2.h. +.SH "int QRect::bottom () const" +Returns the bottom coordinate of the rectangle. +.PP +See also setBottom(), top(), bottomLeft(), and bottomRight(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, desktop/desktop.cpp, helpviewer/helpwindow.cpp, qfd/fontdisplayer.cpp, scribble/scribble.cpp, and themes/wood.cpp. +.SH "QPoint QRect::bottomLeft () const" +Returns the bottom-left position of the rectangle. +.PP +See also setBottomLeft(), moveBottomLeft(), topRight(), bottom(), and left(). +.PP +Example: tictac/tictac.cpp. +.SH "QPoint QRect::bottomRight () const" +Returns the bottom-right position of the rectangle. +.PP +See also setBottomRight(), moveBottomRight(), topLeft(), right(), and bottom(). +.PP +Example: tictac/tictac.cpp. +.SH "QPoint QRect::center () const" +Returns the center point of the rectangle. +.PP +See also moveCenter(), topLeft(), bottomRight(), topRight(), and bottomLeft(). +.PP +Example: tooltip/tooltip.cpp. +.SH "bool QRect::contains ( const QPoint & p, bool proper = FALSE ) const" +Returns TRUE if the point \fIp\fR is inside or on the edge of the rectangle; otherwise returns FALSE. +.PP +If \fIproper\fR is TRUE, this function returns TRUE only if \fIp\fR is inside (not on the edge). +.PP +Example: t14/cannon.cpp. +.SH "bool QRect::contains ( int x, int y ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the point \fIx\fR, \fIy\fR is inside this rectangle; otherwise returns FALSE. +.SH "bool QRect::contains ( int x, int y, bool proper ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the point \fIx\fR, \fIy\fR is inside this rectangle; otherwise returns FALSE. +.PP +If \fIproper\fR is TRUE, this function returns TRUE only if the point is entirely inside (not on the edge). +.SH "bool QRect::contains ( const QRect & r, bool proper = FALSE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the rectangle \fIr\fR is inside this rectangle; otherwise returns FALSE. +.PP +If \fIproper\fR is TRUE, this function returns TRUE only if \fIr\fR is entirely inside (not on the edge). +.PP +See also unite(), intersect(), and intersects(). +.SH "void QRect::coords ( int * xp1, int * yp1, int * xp2, int * yp2 ) const" +Extracts the rectangle parameters as the top-left point \fI*xp1\fR, \fI*yp1\fR and the bottom-right point \fI*xp2\fR, \fI*yp2\fR. +.PP +See also setCoords() and rect(). +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "int QRect::height () const" +Returns the height of the rectangle. The height includes both the top and bottom edges, i.e. height = bottom - top + 1. +.PP +See also width(), size(), and setHeight(). +.PP +Examples: +.)l aclock/aclock.cpp, desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, themes/metal.cpp, themes/wood.cpp, and xform/xform.cpp. +.SH "QRect QRect::intersect ( const QRect & r ) const" +Returns the intersection of this rectangle and rectangle \fIr\fR. \fCr.intersect(s)\fR is equivalent to \fCr&s\fR. +.SH "bool QRect::intersects ( const QRect & r ) const" +Returns TRUE if this rectangle intersects with rectangle \fIr\fR (there is at least one pixel that is within both rectangles); otherwise returns FALSE. +.PP +See also intersect() and contains(). +.PP +Examples: +.)l t11/cannon.cpp, t12/cannon.cpp, t13/cannon.cpp, and t14/cannon.cpp. +.SH "bool QRect::isEmpty () const" +Returns TRUE if the rectangle is empty; otherwise returns FALSE. +.PP +An empty rectangle has a left() > right() or top() > bottom(). +.PP +An empty rectangle is not valid. \fCisEmpty() == !isValid()\fR +.PP +See also isNull(), isValid(), and normalize(). +.SH "bool QRect::isNull () const" +Returns TRUE if the rectangle is a null rectangle; otherwise returns FALSE. +.PP +A null rectangle has both the width and the height set to 0, that is right() == left() - 1 and bottom() == top() - 1. +.PP +Note that if right() == left() and bottom() == top(), then the rectangle has width 1 and height 1. +.PP +A null rectangle is also empty. +.PP +A null rectangle is not valid. +.PP +See also isEmpty() and isValid(). +.SH "bool QRect::isValid () const" +Returns TRUE if the rectangle is valid; otherwise returns FALSE. +.PP +A valid rectangle has a left() <= right() and top() <= bottom(). +.PP +Note that non-trivial operations like intersections are not defined for invalid rectangles. +.PP +\fCisValid() == !isEmpty()\fR +.PP +See also isNull(), isEmpty(), and normalize(). +.PP +Examples: +.)l themes/metal.cpp and tooltip/tooltip.cpp. +.SH "int QRect::left () const" +Returns the left coordinate of the rectangle. Identical to x(). +.PP +See also setLeft(), right(), topLeft(), and bottomLeft(). +.PP +Examples: +.)l aclock/aclock.cpp, desktop/desktop.cpp, i18n/main.cpp, scribble/scribble.cpp, tictac/tictac.cpp, and xform/xform.cpp. +.SH "void QRect::moveBottom ( int pos )" +Sets the bottom position of the rectangle to \fIpos\fR, leaving the size unchanged. +.PP +See also bottom(), setBottom(), moveLeft(), moveTop(), and moveRight(). +.SH "void QRect::moveBottomLeft ( const QPoint & p )" +Sets the bottom-left position of the rectangle to \fIp\fR, leaving the size unchanged. +.PP +See also bottomLeft(), setBottomLeft(), moveTopLeft(), moveBottomRight(), and moveTopRight(). +.PP +Example: t10/cannon.cpp. +.SH "void QRect::moveBottomRight ( const QPoint & p )" +Sets the bottom-right position of the rectangle to \fIp\fR, leaving the size unchanged. +.PP +See also bottomRight(), setBottomRight(), moveTopLeft(), moveTopRight(), and moveBottomLeft(). +.SH "void QRect::moveBy ( int dx, int dy )" +Moves the rectangle \fIdx\fR along the x axis and \fIdy\fR along the y axis, relative to the current position. Positive values move the rectangle to the right and down. +.PP +See also moveTopLeft(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, themes/wood.cpp, and xform/xform.cpp. +.SH "void QRect::moveCenter ( const QPoint & p )" +Sets the center point of the rectangle to \fIp\fR, leaving the size unchanged. +.PP +See also center(), moveTopLeft(), moveBottomRight(), moveTopRight(), and moveBottomLeft(). +.PP +Examples: +.)l t11/cannon.cpp and t12/cannon.cpp. +.SH "void QRect::moveLeft ( int pos )" +Sets the left position of the rectangle to \fIpos\fR, leaving the size unchanged. +.PP +See also left(), setLeft(), moveTop(), moveRight(), and moveBottom(). +.SH "void QRect::moveRight ( int pos )" +Sets the right position of the rectangle to \fIpos\fR, leaving the size unchanged. +.PP +See also right(), setRight(), moveLeft(), moveTop(), and moveBottom(). +.SH "void QRect::moveTop ( int pos )" +Sets the top position of the rectangle to \fIpos\fR, leaving the size unchanged. +.PP +See also top(), setTop(), moveLeft(), moveRight(), and moveBottom(). +.SH "void QRect::moveTopLeft ( const QPoint & p )" +Sets the top-left position of the rectangle to \fIp\fR, leaving the size unchanged. +.PP +See also topLeft(), setTopLeft(), moveBottomRight(), moveTopRight(), and moveBottomLeft(). +.PP +Examples: +.)l helpsystem/tooltip.cpp and xform/xform.cpp. +.SH "void QRect::moveTopRight ( const QPoint & p )" +Sets the top-right position of the rectangle to \fIp\fR, leaving the size unchanged. +.PP +See also topRight(), setTopRight(), moveTopLeft(), moveBottomRight(), and moveBottomLeft(). +.SH "QRect QRect::normalize () const" +Returns a normalized rectangle, i.e. a rectangle that has a non-negative width and height. +.PP +It swaps left and right if left() > right(), and swaps top and bottom if top() > bottom(). +.PP +See also isValid(). +.PP +Example: scribble/scribble.cpp. +.SH "QRect QRect::operator& ( const QRect & r ) const" +Returns the intersection of this rectangle and rectangle \fIr\fR. +.PP +Returns an empty rectangle if there is no intersection. +.PP +See also operator&=(), operator|(), isEmpty(), intersects(), and contains(). +.SH "QRect & QRect::operator&= ( const QRect & r )" +Intersects this rectangle with rectangle \fIr\fR. +.SH "QRect QRect::operator| ( const QRect & r ) const" +Returns the bounding rectangle of this rectangle and rectangle \fIr\fR. +.PP +The bounding rectangle of a nonempty rectangle and an empty or invalid rectangle is defined to be the nonempty rectangle. +.PP +See also operator|=(), operator&(), intersects(), and contains(). +.SH "QRect & QRect::operator|= ( const QRect & r )" +Unites this rectangle with rectangle \fIr\fR. +.SH "QCOORD & QRect::rBottom ()" +Returns a reference to the bottom coordinate of the rectangle. +.PP +See also rLeft(), rTop(), and rRight(). +.SH "QCOORD & QRect::rLeft ()" +Returns a reference to the left coordinate of the rectangle. +.PP +See also rTop(), rRight(), and rBottom(). +.SH "QCOORD & QRect::rRight ()" +Returns a reference to the right coordinate of the rectangle. +.PP +See also rLeft(), rTop(), and rBottom(). +.SH "QCOORD & QRect::rTop ()" +Returns a reference to the top coordinate of the rectangle. +.PP +See also rLeft(), rRight(), and rBottom(). +.SH "void QRect::rect ( int * x, int * y, int * w, int * h ) const" +Extracts the rectangle parameters as the position \fI*x\fR, \fI*y\fR and width \fI*w\fR and height \fI*h\fR. +.PP +See also setRect() and coords(). +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "int QRect::right () const" +Returns the right coordinate of the rectangle. +.PP +See also setRight(), left(), topRight(), and bottomRight(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, customlayout/flow.cpp, desktop/desktop.cpp, scribble/scribble.cpp, t11/cannon.cpp, and themes/wood.cpp. +.SH "void QRect::setBottom ( int pos )" +Sets the bottom edge of the rectangle to \fIpos\fR. May change the height, but will never change the top edge of the rectangle. +.PP +See also bottom(), setTop(), and setHeight(). +.PP +Example: scribble/scribble.cpp. +.SH "void QRect::setBottomLeft ( const QPoint & p )" +Set the bottom-left corner of the rectangle to \fIp\fR. May change the size, but will the never change the top-right corner of the rectangle. +.PP +See also bottomLeft(), moveBottomLeft(), setTopLeft(), setBottomRight(), and setTopRight(). +.SH "void QRect::setBottomRight ( const QPoint & p )" +Set the bottom-right corner of the rectangle to \fIp\fR. May change the size, but will the never change the top-left corner of the rectangle. +.PP +See also bottomRight(), moveBottomRight(), setTopLeft(), setTopRight(), and setBottomLeft(). +.SH "void QRect::setCoords ( int xp1, int yp1, int xp2, int yp2 )" +Sets the coordinates of the rectangle's top-left corner to \fI(xp1, yp1)\fR, and the coordinates of its bottom-right corner to \fI(xp2, yp2)\fR. +.PP +See also coords() and setRect(). +.SH "void QRect::setHeight ( int h )" +Sets the height of the rectangle to \fIh\fR. The top edge is not moved, but the bottom edge may be moved. +.PP +See also height(), setTop(), setBottom(), and setSize(). +.PP +Example: desktop/desktop.cpp. +.SH "void QRect::setLeft ( int pos )" +Sets the left edge of the rectangle to \fIpos\fR. May change the width, but will never change the right edge of the rectangle. +.PP +Identical to setX(). +.PP +See also left(), setTop(), and setWidth(). +.PP +Example: scribble/scribble.cpp. +.SH "void QRect::setRect ( int x, int y, int w, int h )" +Sets the coordinates of the rectangle's top-left corner to \fI(x, y)\fR, and its size to \fI(w, h)\fR. +.PP +See also rect() and setCoords(). +.PP +Example: themes/wood.cpp. +.SH "void QRect::setRight ( int pos )" +Sets the right edge of the rectangle to \fIpos\fR. May change the width, but will never change the left edge of the rectangle. +.PP +See also right(), setLeft(), and setWidth(). +.PP +Example: scribble/scribble.cpp. +.SH "void QRect::setSize ( const QSize & s )" +Sets the size of the rectangle to \fIs\fR. The top-left corner is not moved. +.PP +See also size(), setWidth(), and setHeight(). +.PP +Example: xform/xform.cpp. +.SH "void QRect::setTop ( int pos )" +Sets the top edge of the rectangle to \fIpos\fR. May change the height, but will never change the bottom edge of the rectangle. +.PP +Identical to setY(). +.PP +See also top(), setBottom(), and setHeight(). +.PP +Example: scribble/scribble.cpp. +.SH "void QRect::setTopLeft ( const QPoint & p )" +Set the top-left corner of the rectangle to \fIp\fR. May change the size, but will the never change the bottom-right corner of the rectangle. +.PP +See also topLeft(), moveTopLeft(), setBottomRight(), setTopRight(), and setBottomLeft(). +.SH "void QRect::setTopRight ( const QPoint & p )" +Set the top-right corner of the rectangle to \fIp\fR. May change the size, but will the never change the bottom-left corner of the rectangle. +.PP +See also topRight(), moveTopRight(), setTopLeft(), setBottomRight(), and setBottomLeft(). +.SH "void QRect::setWidth ( int w )" +Sets the width of the rectangle to \fIw\fR. The right edge is changed, but not the left edge. +.PP +See also width(), setLeft(), setRight(), and setSize(). +.PP +Example: desktop/desktop.cpp. +.SH "void QRect::setX ( int x )" +Sets the x position of the rectangle (its left end) to \fIx\fR. May change the width, but will never change the right edge of the rectangle. +.PP +Identical to setLeft(). +.PP +See also x() and setY(). +.SH "void QRect::setY ( int y )" +Sets the y position of the rectangle (its top) to \fIy\fR. May change the height, but will never change the bottom edge of the rectangle. +.PP +Identical to setTop(). +.PP +See also y() and setX(). +.SH "QSize QRect::size () const" +Returns the size of the rectangle. +.PP +See also width() and height(). +.PP +Examples: +.)l desktop/desktop.cpp, movies/main.cpp, and t10/cannon.cpp. +.SH "int QRect::top () const" +Returns the top coordinate of the rectangle. Identical to y(). +.PP +See also setTop(), bottom(), topLeft(), and topRight(). +.PP +Examples: +.)l aclock/aclock.cpp, desktop/desktop.cpp, scribble/scribble.cpp, themes/wood.cpp, tictac/tictac.cpp, and xform/xform.cpp. +.SH "QPoint QRect::topLeft () const" +Returns the top-left position of the rectangle. +.PP +See also setTopLeft(), moveTopLeft(), bottomRight(), left(), and top(). +.PP +Examples: +.)l helpsystem/tooltip.cpp, t10/cannon.cpp, and tictac/tictac.cpp. +.SH "QPoint QRect::topRight () const" +Returns the top-right position of the rectangle. +.PP +See also setTopRight(), moveTopRight(), bottomLeft(), top(), and right(). +.PP +Example: tictac/tictac.cpp. +.SH "QRect QRect::unite ( const QRect & r ) const" +Returns the bounding rectangle of this rectangle and rectangle \fIr\fR. \fCr.unite(s)\fR is equivalent to \fCr|s\fR. +.PP +Examples: +.)l t11/cannon.cpp, t12/cannon.cpp, and xform/xform.cpp. +.SH "int QRect::width () const" +Returns the width of the rectangle. The width includes both the left and right edges, i.e. width = right - left + 1. +.PP +See also height(), size(), and setHeight(). +.PP +Examples: +.)l aclock/aclock.cpp, customlayout/border.cpp, desktop/desktop.cpp, movies/main.cpp, themes/metal.cpp, themes/wood.cpp, and xform/xform.cpp. +.SH "int QRect::x () const" +Returns the left coordinate of the rectangle. Identical to left(). +.PP +See also left(), y(), and setX(). +.PP +Examples: +.)l customlayout/border.cpp, desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, t12/cannon.cpp, themes/metal.cpp, and themes/wood.cpp. +.SH "int QRect::y () const" +Returns the top coordinate of the rectangle. Identical to top(). +.PP +See also top(), x(), and setY(). +.PP +Examples: +.)l desktop/desktop.cpp, movies/main.cpp, scribble/scribble.cpp, t12/cannon.cpp, t14/cannon.cpp, themes/metal.cpp, and themes/wood.cpp. +.SH RELATED FUNCTION DOCUMENTATION +.SH "bool operator!= ( const QRect & r1, const QRect & r2 )" +Returns TRUE if \fIr1\fR and \fIr2\fR are different; otherwise returns FALSE. +.SH "QDataStream & operator<< ( QDataStream & s, const QRect & r )" +Writes the QRect, \fIr\fR, to the stream \fIs\fR, and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "bool operator== ( const QRect & r1, const QRect & r2 )" +Returns TRUE if \fIr1\fR and \fIr2\fR are equal; otherwise returns FALSE. +.SH "QDataStream & operator>> ( QDataStream & s, QRect & r )" +Reads a QRect from the stream \fIs\fR into rect \fIr\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqrect.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqrect.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqregexp.3qt b/doc/man/man3/tqregexp.3qt new file mode 100644 index 000000000..cbd85ea30 --- /dev/null +++ b/doc/man/man3/tqregexp.3qt @@ -0,0 +1,855 @@ +'\" t +.TH QRegExp 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 +QRegExp \- Pattern matching using regular expressions +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqregexp.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBCaretMode\fR { CaretAtZero, CaretAtOffset, CaretWontMatch }" +.br +.ti -1c +.BI "\fBQRegExp\fR ()" +.br +.ti -1c +.BI "\fBQRegExp\fR ( const QString & pattern, bool caseSensitive = TRUE, bool wildcard = FALSE )" +.br +.ti -1c +.BI "\fBQRegExp\fR ( const QRegExp & rx )" +.br +.ti -1c +.BI "\fB~QRegExp\fR ()" +.br +.ti -1c +.BI "QRegExp & \fBoperator=\fR ( const QRegExp & rx )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QRegExp & rx ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QRegExp & rx ) const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "QString \fBpattern\fR () const" +.br +.ti -1c +.BI "void \fBsetPattern\fR ( const QString & pattern )" +.br +.ti -1c +.BI "bool \fBcaseSensitive\fR () const" +.br +.ti -1c +.BI "void \fBsetCaseSensitive\fR ( bool sensitive )" +.br +.ti -1c +.BI "bool \fBwildcard\fR () const" +.br +.ti -1c +.BI "void \fBsetWildcard\fR ( bool wildcard )" +.br +.ti -1c +.BI "bool \fBminimal\fR () const" +.br +.ti -1c +.BI "void \fBsetMinimal\fR ( bool minimal )" +.br +.ti -1c +.BI "bool \fBexactMatch\fR ( const QString & str ) const" +.br +.ti -1c +.BI "int match ( const QString & str, int index = 0, int * len = 0, bool indexIsStart = TRUE ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBsearch\fR ( const QString & str, int offset = 0, CaretMode caretMode = CaretAtZero ) const" +.br +.ti -1c +.BI "int \fBsearchRev\fR ( const QString & str, int offset = -1, CaretMode caretMode = CaretAtZero ) const" +.br +.ti -1c +.BI "int \fBmatchedLength\fR () const" +.br +.ti -1c +.BI "int \fBnumCaptures\fR () const" +.br +.ti -1c +.BI "QStringList \fBcapturedTexts\fR ()" +.br +.ti -1c +.BI "QString \fBcap\fR ( int nth = 0 )" +.br +.ti -1c +.BI "int \fBpos\fR ( int nth = 0 )" +.br +.ti -1c +.BI "QString \fBerrorString\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBescape\fR ( const QString & str )" +.br +.in -1c +.SH DESCRIPTION +The QRegExp class provides pattern matching using regular expressions. +.PP + +.PP +Regular expressions, or "regexps", provide a way to find patterns within text. This is useful in many contexts, for example: +.PP +<center>.nf +.TS +l - l. Validation A regexp can be used to check whether a piece of text meets some criteria, e.g. is an integer or contains no whitespace. Searching Regexps provide a much more powerful means of searching text than simple string matching does. For example we can create a regexp which says "find one of the words 'mail', 'letter' or 'correspondence' but not any of the words 'email', 'mailman' 'mailer', 'letterbox' etc." Search and Replace A regexp can be used to replace a pattern with a piece of text, for example replace all occurrences of '&' with '&' except where the '&' is already followed by 'amp;'. String Splitting +.TE +.fi +</center> +.PP +We present a very brief introduction to regexps, a description of Qt's regexp language, some code examples, and finally the function documentation itself. QRegExp is modeled on Perl's regexp language, and also fully supports Unicode. QRegExp can also be used in the weaker 'wildcard' (globbing) mode which works in a similar way to command shells. A good text on regexps is \fIMastering Regular Expressions: Powerful Techniques for Perl and Other Tools\fR by Jeffrey E. Friedl, ISBN 1565922573. +.PP +Experienced regexp users may prefer to skip the introduction and go directly to the relevant information. +.PP +In case of multi-threaded programming, note that QRegExp depends on QThreadStorage internally. For that reason, QRegExp should only be used with threads started with QThread, i.e. not with threads started with platform-specific APIs. +.PP + +.TP +Introduction +.TP +Characters and Abbreviations for Sets of Characters +.TP +Sets of Characters +.TP +Quantifiers +.TP +Capturing Text +.TP +Assertions +.TP +Wildcard Matching (globbing) +.TP +Notes for Perl Users +.TP + Code Examples + +.SH "Introduction" +Regexps are built up from expressions, quantifiers, and assertions. The simplest form of expression is simply a character, e.g. \fBx\fR or \fB5\fR. An expression can also be a set of characters. For example, \fB[ABCD]\fR, will match an \fBA\fR or a \fBB\fR or a \fBC\fR or a \fBD\fR. As a shorthand we could write this as \fB[A-D]\fR. If we want to match any of the captital letters in the English alphabet we can write \fB[A-Z]\fR. A quantifier tells the regexp engine how many occurrences of the expression we want, e.g. \fBx{1,1}\fR means match an \fBx\fR which occurs at least once and at most once. We'll look at assertions and more complex expressions later. +.PP +Note that in general regexps cannot be used to check for balanced brackets or tags. For example if you want to match an opening html \fC<b>\fR and its closing \fC</b>\fR you can only use a regexp if you know that these tags are not nested; the html fragment, \fC<b>bold <b>bolder</b></b>\fR will not match as expected. If you know the maximum level of nesting it is possible to create a regexp that will match correctly, but for an unknown level of nesting, regexps will fail. +.PP +We'll start by writing a regexp to match integers in the range 0 to 99. We will require at least one digit so we will start with \fB[0-9]{1,1}\fR which means match a digit exactly once. This regexp alone will match integers in the range 0 to 9. To match one or two digits we can increase the maximum number of occurrences so the regexp becomes \fB[0-9]{1,2}\fR meaning match a digit at least once and at most twice. However, this regexp as it stands will not match correctly. This regexp will match one or two digits \fIwithin\fR a string. To ensure that we match against the whole string we must use the anchor assertions. We need \fB^\fR (caret) which when it is the first character in the regexp means that the regexp must match from the beginning of the string. And we also need \fB$\fR (dollar) which when it is the last character in the regexp means that the regexp must match until the end of the string. So now our regexp is \fB^[0-9]{1,2}$\fR. Note that assertions, such as \fB^\fR and \fB$\fR, do not match any characters. +.PP +If you've seen regexps elsewhere they may have looked different from the ones above. This is because some sets of characters and some quantifiers are so common that they have special symbols to represent them. \fB[0-9]\fR can be replaced with the symbol \fB\\d\fR. The quantifier to match exactly one occurrence, \fB{1,1}\fR, can be replaced with the expression itself. This means that \fBx{1,1}\fR is exactly the same as \fBx\fR alone. So our 0 to 99 matcher could be written \fB^\\d{1,2}$\fR. Another way of writing it would be \fB^\\d\\d{0,1}$\fR, i.e. from the start of the string match a digit followed by zero or one digits. In practice most people would write it \fB^\\d\\d?$\fR. The \fB?\fR is a shorthand for the quantifier \fB{0,1}\fR, i.e. a minimum of no occurrences a maximum of one occurrence. This is used to make an expression optional. The regexp \fB^\\d\\d?$\fR means "from the beginning of the string match one digit followed by zero or one digits and then the end of the string". +.PP +Our second example is matching the words 'mail', 'letter' or 'correspondence' but without matching 'email', 'mailman', 'mailer', 'letterbox' etc. We'll start by just matching 'mail'. In full the regexp is, \fBm{1,1}a{1,1}i{1,1}l{1,1}\fR, but since each expression itself is automatically quantified by \fB{1,1}\fR we can simply write this as \fBmail\fR; an 'm' followed by an 'a' followed by an 'i' followed by an 'l'. The symbol '|' (bar) is used for \fIalternation\fR, so our regexp now becomes \fBmail|letter|correspondence\fR which means match 'mail' \fIor\fR 'letter' \fIor\fR 'correspondence'. Whilst this regexp will find the words we want it will also find words we don't want such as 'email'. We will start by putting our regexp in parentheses, \fB(mail|letter|correspondence)\fR. Parentheses have two effects, firstly they group expressions together and secondly they identify parts of the regexp that we wish to capture. Our regexp still matches any of the three words but now they are grouped together as a unit. This is useful for building up more complex regexps. It is also useful because it allows us to examine which of the words actually matched. We need to use another assertion, this time \fB\\b\fR "word boundary": \fB\\b(mail|letter|correspondence)\\b\fR. This regexp means "match a word boundary followed by the expression in parentheses followed by another word boundary". The \fB\\b\fR assertion matches at a \fIposition\fR in the regexp not a \fIcharacter\fR in the regexp. A word boundary is any non-word character such as a space a newline or the beginning or end of the string. +.PP +For our third example we want to replace ampersands with the HTML entity '&'. The regexp to match is simple: \fB&\fR, i.e. match one ampersand. Unfortunately this will mess up our text if some of the ampersands have already been turned into HTML entities. So what we really want to say is replace an ampersand providing it is not followed by 'amp;'. For this we need the negative lookahead assertion and our regexp becomes: \fB&(?!amp;)\fR. The negative lookahead assertion is introduced with '(?!' and finishes at the ')'. It means that the text it contains, 'amp;' in our example, must \fInot\fR follow the expression that preceeds it. +.PP +Regexps provide a rich language that can be used in a variety of ways. For example suppose we want to count all the occurrences of 'Eric' and 'Eirik' in a string. Two valid regexps to match these are \fB\b(Eric|Eirik)\b\fR and \fB\bEi?ri[ck]\b\fR. We need the word boundary '\\b' so we don't get 'Ericsson' etc. The second regexp actually matches more than we want, 'Eric', 'Erik', 'Eiric' and 'Eirik'. +.PP +We will implement some the examples above in the code examples section. +.SH "Characters and Abbreviations for Sets of Characters" +<center>.nf +.TS +l +- +l. +Element Meaning + Any character represents itself unless it has a special +regexp meaning. Thus + A character that follows a backslash matches the character +itself except where mentioned below. For example if you +wished to match a literal caret at the beginning of a string +you would write + This matches the ASCII bell character (BEL, 0x07). + This matches the ASCII form feed character (FF, 0x0C). + This matches the ASCII line feed character (LF, 0x0A, Unix newline). + This matches the ASCII carriage return character (CR, 0x0D). + This matches the ASCII horizontal tab character (HT, 0x09). + This matches the ASCII vertical tab character (VT, 0x0B). + This matches the Unicode character corresponding to the +hexadecimal number hhhh (between 0x0000 and 0xFFFF). \0ooo +(i.e., \\zero ooo) matches the ASCII/Latin-1 character +corresponding to the octal number ooo (between 0 and 0377). + This matches any character (including newline). + This matches a digit (QChar::isDigit()). + This matches a non-digit. + This matches a whitespace (QChar::isSpace()). + This matches a non-whitespace. + This matches a word character (QChar::isLetterOrNumber() or '_'). + This matches a non-word character. + +.TE +.fi +</center> +.PP +\fINote that the C++ compiler transforms backslashes in strings so to include a \fB\\fR in a regexp you will need to enter it twice, i.e. \fB\\\fR.\fR +.SH "Sets of Characters" +Square brackets are used to match any character in the set of characters contained within the square brackets. All the character set abbreviations described above can be used within square brackets. Apart from the character set abbreviations and the following two exceptions no characters have special meanings in square brackets. +.PP +<center>.nf +.TS +l - l. The caret negates the character set if it occurs as the first character, i.e. immediately after the opening square bracket. For example, The dash is used to indicate a range of characters, for example +.TE +.fi +</center> +.PP +Using the predefined character set abbreviations is more portable than using character ranges across platforms and languages. For example, \fB[0-9]\fR matches a digit in Western alphabets but \fB\\d\fR matches a digit in \fIany\fR alphabet. +.PP +Note that in most regexp literature sets of characters are called" character classes". +.SH "Quantifiers" +By default an expression is automatically quantified by \fB{1,1}\fR, i.e. it should occur exactly once. In the following list \fB\fIE\fR\fR stands for any expression. An expression is a character or an abbreviation for a set of characters or a set of characters in square brackets or any parenthesised expression. +.PP +<center>.nf +.TS +l +- +l. + Matches zero or one occurrence of \fIE\fR. This quantifier +means "the previous expression is optional" since it will +match whether or not the expression occurs in the string. It +is the same as + Matches one or more occurrences of \fIE\fR. This is the same +as + Matches zero or more occurrences of \fIE\fR. This is the same +as + Matches exactly \fIn\fR occurrences of the expression. This +is the same as repeating the expression \fIn\fR times. For +example, + Matches at least \fIn\fR occurrences of the expression. This +is the same as + Matches at most \fIm\fR occurrences of the expression. This +is the same as + +.TE +.fi +</center> +.PP +(MAXINT is implementation dependent but will not be smaller than 1024.) +.PP +If we wish to apply a quantifier to more than just the preceding character we can use parentheses to group characters together in an expression. For example, \fBtag+\fR matches a 't' followed by an 'a' followed by at least one 'g', whereas \fB(tag)+\fR matches at least one occurrence of 'tag'. +.PP +Note that quantifiers are "greedy". They will match as much text as they can. For example, \fB0+\fR will match as many zeros as it can from the first zero it finds, e.g. '2.<u>000</u>5'. Quantifiers can be made non-greedy, see setMinimal(). +.SH "Capturing Text" +Parentheses allow us to group elements together so that we can quantify and capture them. For example if we have the expression \fBmail|letter|correspondence\fR that matches a string we know that \fIone\fR of the words matched but not which one. Using parentheses allows us to "capture" whatever is matched within their bounds, so if we used \fB(mail|letter|correspondence)\fR and matched this regexp against the string "I sent you some email" we can use the cap() or capturedTexts() functions to extract the matched characters, in this case 'mail'. +.PP +We can use captured text within the regexp itself. To refer to the captured text we use \fIbackreferences\fR which are indexed from 1, the same as for cap(). For example we could search for duplicate words in a string using \fB\\b(\\w+)\\W+\1\\b\fR which means match a word boundary followed by one or more word characters followed by one or more non-word characters followed by the same text as the first parenthesised expression followed by a word boundary. +.PP +If we want to use parentheses purely for grouping and not for capturing we can use the non-capturing syntax, e.g. \fB(?:green|blue)\fR. Non-capturing parentheses begin '(?:' and end ')'. In this example we match either 'green' or 'blue' but we do not capture the match so we only know whether or not we matched but not which color we actually found. Using non-capturing parentheses is more efficient than using capturing parentheses since the regexp engine has to do less book-keeping. +.PP +Both capturing and non-capturing parentheses may be nested. +.SH "Assertions" +Assertions make some statement about the text at the point where they occur in the regexp but they do not match any characters. In the following list \fB\fIE\fR\fR stands for any expression. +.PP +<center>.nf +.TS +l - l. The caret signifies the beginning of the string. If you wish to match a literal The dollar signifies the end of the string. For example A word boundary. For example the regexp A non-word boundary. This assertion is true wherever Positive lookahead. This assertion is true if the expression matches at this point in the regexp. For example, Negative lookahead. This assertion is true if the expression does not match at this point in the regexp. For example, +.TE +.fi +</center> +.SH "Wildcard Matching (globbing)" +Most command shells such as \fIbash\fR or \fIcmd.exe\fR support "file globbing", the ability to identify a group of files by using wildcards. The setWildcard() function is used to switch between regexp and wildcard mode. Wildcard matching is much simpler than full regexps and has only four features: +.PP +<center>.nf +.TS +l +- +l. + Any character represents itself apart from those mentioned +below. Thus + This matches any single character. It is the same as + This matches zero or more of any characters. It is the +same as + +.TE +.fi +</center> +.PP +For example if we are in wildcard mode and have strings which contain filenames we could identify HTML files with \fB*.html\fR. This will match zero or more characters followed by a dot followed by 'h', 't', 'm' and 'l'. +.SH "Notes for Perl Users" +Most of the character class abbreviations supported by Perl are supported by QRegExp, see characters and abbreviations for sets of characters. +.PP +In QRegExp, apart from within character classes, \fC^\fR always signifies the start of the string, so carets must always be escaped unless used for that purpose. In Perl the meaning of caret varies automagically depending on where it occurs so escaping it is rarely necessary. The same applies to \fC$\fR which in QRegExp always signifies the end of the string. +.PP +QRegExp's quantifiers are the same as Perl's greedy quantifiers. Non-greedy matching cannot be applied to individual quantifiers, but can be applied to all the quantifiers in the pattern. For example, to match the Perl regexp \fBro+?m\fR requires: +.PP +.nf +.br + QRegExp rx( "ro+m" ); +.br + rx.setMinimal( TRUE ); +.br +.fi +.PP +The equivalent of Perl's \fC/i\fR option is setCaseSensitive(FALSE). +.PP +Perl's \fC/g\fR option can be emulated using a loop. +.PP +In QRegExp \fB.\fR matches any character, therefore all QRegExp regexps have the equivalent of Perl's \fC/s\fR option. QRegExp does not have an equivalent to Perl's \fC/m\fR option, but this can be emulated in various ways for example by splitting the input into lines or by looping with a regexp that searches for newlines. +.PP +Because QRegExp is string oriented there are no \\A, \\Z or \\z assertions. The \\G assertion is not supported but can be emulated in a loop. +.PP +Perl's $& is cap(0) or capturedTexts()[0]. There are no QRegExp equivalents for $`, $' or $+. Perl's capturing variables, $1, $2, +... correspond to cap(1) or capturedTexts()[1], cap(2) or +capturedTexts()[2], etc. +.PP +To substitute a pattern use QString::replace(). +.PP +Perl's extended \fC/x\fR syntax is not supported, nor are directives, e.g. (?i), or regexp comments, e.g. (?#comment). On the other hand, C++'s rules for literal strings can be used to achieve the same: +.PP +.nf +.br + QRegExp mark( "\\\\b" // word boundary +.br + "[Mm]ark" // the word we want to match +.br + ); +.br +.fi +.PP +Both zero-width positive and zero-width negative lookahead assertions (?=pattern) and (?!pattern) are supported with the same syntax as Perl. Perl's lookbehind assertions, "independent" subexpressions and conditional expressions are not supported. +.PP +Non-capturing parentheses are also supported, with the same (?:pattern) syntax. +.PP +See QStringList::split() and QStringList::join() for equivalents to Perl's split and join functions. +.PP +Note: because C++ transforms \'s they must be written \fItwice\fR in code, e.g. \fB\b\fR must be written \fB\\b\fR. +.SH "Code Examples" +.nf +.br + QRegExp rx( "^\\\\d\\\\d?$" ); // match integers 0 to 99 +.br + rx.search( "123" ); // returns -1 (no match) +.br + rx.search( "-6" ); // returns -1 (no match) +.br + rx.search( "6" ); // returns 0 (matched as position 0) +.br +.fi +.PP +The third string matches '<u>6</u>'. This is a simple validation regexp for integers in the range 0 to 99. +.PP +.nf +.br + QRegExp rx( "^\\\\S+$" ); // match strings without whitespace +.br + rx.search( "Hello world" ); // returns -1 (no match) +.br + rx.search( "This_is-OK" ); // returns 0 (matched at position 0) +.br +.fi +.PP +The second string matches '<u>This_is-OK</u>'. We've used the character set abbreviation '\\S' (non-whitespace) and the anchors to match strings which contain no whitespace. +.PP +In the following example we match strings containing 'mail' or 'letter' or 'correspondence' but only match whole words i.e. not 'email' +.PP +.nf +.br + QRegExp rx( "\\\\b(mail|letter|correspondence)\\\\b" ); +.br + rx.search( "I sent you an email" ); // returns -1 (no match) +.br + rx.search( "Please write the letter" ); // returns 17 +.br +.fi +.PP +The second string matches "Please write the <u>letter</u>". The word 'letter' is also captured (because of the parentheses). We can see what text we've captured like this: +.PP +.nf +.br + QString captured = rx.cap( 1 ); // captured == "letter" +.br +.fi +.PP +This will capture the text from the first set of capturing parentheses (counting capturing left parentheses from left to right). The parentheses are counted from 1 since cap( 0 ) is the whole matched regexp (equivalent to '&' in most regexp engines). +.PP +.nf +.br + QRegExp rx( "&(?!amp;)" ); // match ampersands but not & +.br + QString line1 = "This & that"; +.br + line1.replace( rx, "&" ); +.br + // line1 == "This & that" +.br + QString line2 = "His & hers & theirs"; +.br + line2.replace( rx, "&" ); +.br + // line2 == "His & hers & theirs" +.br +.fi +.PP +Here we've passed the QRegExp to QString's replace() function to replace the matched text with new text. +.PP +.nf +.br + QString str = "One Eric another Eirik, and an Ericsson." +.br + " How many Eiriks, Eric?"; +.br + QRegExp rx( "\\\\b(Eric|Eirik)\\\\b" ); // match Eric or Eirik +.br + int pos = 0; // where we are in the string +.br + int count = 0; // how many Eric and Eirik's we've counted +.br + while ( pos >= 0 ) { +.br + pos = rx.search( str, pos ); +.br + if ( pos >= 0 ) { +.br + pos++; // move along in str +.br + count++; // count our Eric or Eirik +.br + } +.br + } +.br +.fi +.PP +We've used the search() function to repeatedly match the regexp in the string. Note that instead of moving forward by one character at a time \fCpos++\fR we could have written \fCpos += rx.matchedLength()\fR to skip over the already matched string. The count will equal 3, matching 'One <u>Eric</u> another <u>Eirik</u>, and an Ericsson. How many Eiriks, <u>Eric</u>?'; it doesn't match 'Ericsson' or 'Eiriks' because they are not bounded by non-word boundaries. +.PP +One common use of regexps is to split lines of delimited data into their component fields. +.PP +.nf +.br + str = "Trolltech AS\\twww.trolltech.com\\tNorway"; +.br + QString company, web, country; +.br + rx.setPattern( "^([^\\t]+)\\t([^\\t]+)\\t([^\\t]+)$" ); +.br + if ( rx.search( str ) != -1 ) { +.br + company = rx.cap( 1 ); +.br + web = rx.cap( 2 ); +.br + country = rx.cap( 3 ); +.br + } +.br +.fi +.PP +In this example our input lines have the format company name, web address and country. Unfortunately the regexp is rather long and not very versatile -- the code will break if we add any more fields. A simpler and better solution is to look for the separator, '\\t' in this case, and take the surrounding text. The QStringList split() function can take a separator string or regexp as an argument and split a string accordingly. +.PP +.nf +.br + QStringList field = QStringList::split( "\\t", str ); +.br +.fi +.PP +Here field[0] is the company, field[1] the web address and so on. +.PP +To imitate the matching of a shell we can use wildcard mode. +.PP +.nf +.br + QRegExp rx( "*.html" ); // invalid regexp: * doesn't quantify anything +.br + rx.setWildcard( TRUE ); // now it's a valid wildcard regexp +.br + rx.exactMatch( "index.html" ); // returns TRUE +.br + rx.exactMatch( "default.htm" ); // returns FALSE +.br + rx.exactMatch( "readme.txt" ); // returns FALSE +.br +.fi +.PP +Wildcard matching can be convenient because of its simplicity, but any wildcard regexp can be defined using full regexps, e.g. \fB.*\.html$\fR. Notice that we can't match both \fC.html\fR and \fC.htm\fR files with a wildcard unless we use \fB*.htm*\fR which will also match 'test.html.bak'. A full regexp gives us the precision we need, \fB.*\.html?$\fR. +.PP +QRegExp can match case insensitively using setCaseSensitive(), and can use non-greedy matching, see setMinimal(). By default QRegExp uses full regexps but this can be changed with setWildcard(). Searching can be forward with search() or backward with searchRev(). Captured text can be accessed using capturedTexts() which returns a string list of all captured strings, or using cap() which returns the captured string for the given index. The pos() function takes a match index and returns the position in the string where the match was made (or -1 if there was no match). +.PP +See also QRegExpValidator, QString, QStringList, Miscellaneous Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.PP +.SS "Member Type Documentation" +.SH "QRegExp::CaretMode" +The CaretMode enum defines the different meanings of the caret (\fB^\fR) in a regular expression. The possible values are: +.TP +\fCQRegExp::CaretAtZero\fR - The caret corresponds to index 0 in the searched string. +.TP +\fCQRegExp::CaretAtOffset\fR - The caret corresponds to the start offset of the search. +.TP +\fCQRegExp::CaretWontMatch\fR - The caret never matches. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRegExp::QRegExp ()" +Constructs an empty regexp. +.PP +See also isValid() and errorString(). +.SH "QRegExp::QRegExp ( const QString & pattern, bool caseSensitive = TRUE, bool wildcard = FALSE )" +Constructs a regular expression object for the given \fIpattern\fR string. The pattern must be given using wildcard notation if \fIwildcard\fR is TRUE (default is FALSE). The pattern is case sensitive, unless \fIcaseSensitive\fR is FALSE. Matching is greedy (maximal), but can be changed by calling setMinimal(). +.PP +See also setPattern(), setCaseSensitive(), setWildcard(), and setMinimal(). +.SH "QRegExp::QRegExp ( const QRegExp & rx )" +Constructs a regular expression as a copy of \fIrx\fR. +.PP +See also operator=(). +.SH "QRegExp::~QRegExp ()" +Destroys the regular expression and cleans up its internal data. +.SH "QString QRegExp::cap ( int nth = 0 )" +Returns the text captured by the \fInth\fR subexpression. The entire match has index 0 and the parenthesized subexpressions have indices starting from 1 (excluding non-capturing parentheses). +.PP +.nf +.br + QRegExp rxlen( "(\\\\d+)(?:\\\\s*)(cm|inch)" ); +.br + int pos = rxlen.search( "Length: 189cm" ); +.br + if ( pos > -1 ) { +.br + QString value = rxlen.cap( 1 ); // "189" +.br + QString unit = rxlen.cap( 2 ); // "cm" +.br + // ... +.br + } +.br +.fi +.PP +The order of elements matched by cap() is as follows. The first element, cap(0), is the entire matching string. Each subsequent element corresponds to the next capturing open left parentheses. Thus cap(1) is the text of the first capturing parentheses, cap(2) is the text of the second, and so on. +.PP +Some patterns may lead to a number of matches which cannot be determined in advance, for example: +.PP +.nf +.br + QRegExp rx( "(\\\\d+)" ); +.br + str = "Offsets: 12 14 99 231 7"; +.br + QStringList list; +.br + pos = 0; +.br + while ( pos >= 0 ) { +.br + pos = rx.search( str, pos ); +.br + if ( pos > -1 ) { +.br + list += rx.cap( 1 ); +.br + pos += rx.matchedLength(); +.br + } +.br + } +.br + // list contains "12", "14", "99", "231", "7" +.br +.fi +.PP +See also capturedTexts(), pos(), exactMatch(), search(), and searchRev(). +.PP +Examples: +.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. +.SH "QStringList QRegExp::capturedTexts ()" +Returns a list of the captured text strings. +.PP +The first string in the list is the entire matched string. Each subsequent list element contains a string that matched a (capturing) subexpression of the regexp. +.PP +For example: +.PP +.nf +.br + QRegExp rx( "(\\\\d+)(\\\\s*)(cm|inch(es)?)" ); +.br + int pos = rx.search( "Length: 36 inches" ); +.br + QStringList list = rx.capturedTexts(); +.br + // list is now ( "36 inches", "36", " ", "inches", "es" ) +.br +.fi +.PP +The above example also captures elements that may be present but which we have no interest in. This problem can be solved by using non-capturing parentheses: +.PP +.nf +.br + QRegExp rx( "(\\\\d+)(?:\\\\s*)(cm|inch(?:es)?)" ); +.br + int pos = rx.search( "Length: 36 inches" ); +.br + QStringList list = rx.capturedTexts(); +.br + // list is now ( "36 inches", "36", "inches" ) +.br +.fi +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = rx.capturedTexts(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +Some regexps can match an indeterminate number of times. For example if the input string is "Offsets: 12 14 99 231 7" and the regexp, \fCrx\fR, is \fB(\d+)+\fR, we would hope to get a list of all the numbers matched. However, after calling \fCrx.search(str)\fR, capturedTexts() will return the list ( "12"," 12" ), i.e. the entire match was "12" and the first subexpression matched was "12". The correct approach is to use cap() in a loop. +.PP +The order of elements in the string list is as follows. The first element is the entire matching string. Each subsequent element corresponds to the next capturing open left parentheses. Thus capturedTexts()[1] is the text of the first capturing parentheses, capturedTexts()[2] is the text of the second and so on (corresponding to $1, $2, etc., in some other regexp languages). +.PP +See also cap(), pos(), exactMatch(), search(), and searchRev(). +.SH "bool QRegExp::caseSensitive () const" +Returns TRUE if case sensitivity is enabled; otherwise returns FALSE. The default is TRUE. +.PP +See also setCaseSensitive(). +.SH "QString QRegExp::errorString ()" +Returns a text string that explains why a regexp pattern is invalid the case being; otherwise returns "no error occurred". +.PP +See also isValid(). +.PP +Example: regexptester/regexptester.cpp. +.SH "QString QRegExp::escape ( const QString & str )\fC [static]\fR" +Returns the string \fIstr\fR with every regexp special character escaped with a backslash. The special characters are $, (, ), *, +, +., ?, [, \, ], ^, {, | and }. +.PP +Example: +.PP +.nf +.br + s1 = QRegExp::escape( "bingo" ); // s1 == "bingo" +.br + s2 = QRegExp::escape( "f(x)" ); // s2 == "f\\\\(x\\\\)" +.br +.fi +.PP +This function is useful to construct regexp patterns dynamically: +.PP +.nf +.br + QRegExp rx( "(" + QRegExp::escape(name) + +.br + "|" + QRegExp::escape(alias) + ")" ); +.br +.fi +.SH "bool QRegExp::exactMatch ( const QString & str ) const" +Returns TRUE if \fIstr\fR is matched exactly by this regular expression; otherwise returns FALSE. You can determine how much of the string was matched by calling matchedLength(). +.PP +For a given regexp string, R, exactMatch("R") is the equivalent of search("^R$") since exactMatch() effectively encloses the regexp in the start of string and end of string anchors, except that it sets matchedLength() differently. +.PP +For example, if the regular expression is \fBblue\fR, then exactMatch() returns TRUE only for input \fCblue\fR. For inputs \fCbluebell\fR, \fCblutak\fR and \fClightblue\fR, exactMatch() returns FALSE and matchedLength() will return 4, 3 and 0 respectively. +.PP +Although const, this function sets matchedLength(), capturedTexts() and pos(). +.PP +See also search(), searchRev(), and QRegExpValidator. +.SH "bool QRegExp::isEmpty () const" +Returns TRUE if the pattern string is empty; otherwise returns FALSE. +.PP +If you call exactMatch() with an empty pattern on an empty string it will return TRUE; otherwise it returns FALSE since it operates over the whole string. If you call search() with an empty pattern on \fIany\fR string it will return the start offset (0 by default) because the empty pattern matches the 'emptiness' at the start of the string. In this case the length of the match returned by matchedLength() will be 0. +.PP +See QString::isEmpty(). +.SH "bool QRegExp::isValid () const" +Returns TRUE if the regular expression is valid; otherwise returns FALSE. An invalid regular expression never matches. +.PP +The pattern \fB[a-z\fR is an example of an invalid pattern, since it lacks a closing square bracket. +.PP +Note that the validity of a regexp may also depend on the setting of the wildcard flag, for example \fB*.html\fR is a valid wildcard regexp but an invalid full regexp. +.PP +See also errorString(). +.PP +Example: regexptester/regexptester.cpp. +.SH "int QRegExp::match ( const QString & str, int index = 0, int * len = 0, bool indexIsStart = TRUE ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Attempts to match in \fIstr\fR, starting from position \fIindex\fR. Returns the position of the match, or -1 if there was no match. +.PP +The length of the match is stored in \fI*len\fR, unless \fIlen\fR is a null pointer. +.PP +If \fIindexIsStart\fR is TRUE (the default), the position \fIindex\fR in the string will match the start of string anchor, \fB^\fR, in the regexp, if present. Otherwise, position 0 in \fIstr\fR will match. +.PP +Use search() and matchedLength() instead of this function. +.PP +See also QString::mid() and QConstString. +.PP +Example: qmag/qmag.cpp. +.SH "int QRegExp::matchedLength () const" +Returns the length of the last matched string, or -1 if there was no match. +.PP +See also exactMatch(), search(), and searchRev(). +.PP +Examples: +.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. +.SH "bool QRegExp::minimal () const" +Returns TRUE if minimal (non-greedy) matching is enabled; otherwise returns FALSE. +.PP +See also setMinimal(). +.SH "int QRegExp::numCaptures () const" +Returns the number of captures contained in the regular expression. +.PP +Example: regexptester/regexptester.cpp. +.SH "bool QRegExp::operator!= ( const QRegExp & rx ) const" +Returns TRUE if this regular expression is not equal to \fIrx\fR; otherwise returns FALSE. +.PP +See also operator==(). +.SH "QRegExp & QRegExp::operator= ( const QRegExp & rx )" +Copies the regular expression \fIrx\fR and returns a reference to the copy. The case sensitivity, wildcard and minimal matching options are also copied. +.SH "bool QRegExp::operator== ( const QRegExp & rx ) const" +Returns TRUE if this regular expression is equal to \fIrx\fR; otherwise returns FALSE. +.PP +Two QRegExp objects are equal if they have the same pattern strings and the same settings for case sensitivity, wildcard and minimal matching. +.SH "QString QRegExp::pattern () const" +Returns the pattern string of the regular expression. The pattern has either regular expression syntax or wildcard syntax, depending on wildcard(). +.PP +See also setPattern(). +.SH "int QRegExp::pos ( int nth = 0 )" +Returns the position of the \fInth\fR captured text in the searched string. If \fInth\fR is 0 (the default), pos() returns the position of the whole match. +.PP +Example: +.PP +.nf +.br + QRegExp rx( "/([a-z]+)/([a-z]+)" ); +.br + rx.search( "Output /dev/null" ); // returns 7 (position of /dev/null) +.br + rx.pos( 0 ); // returns 7 (position of /dev/null) +.br + rx.pos( 1 ); // returns 8 (position of dev) +.br + rx.pos( 2 ); // returns 12 (position of null) +.br +.fi +.PP +For zero-length matches, pos() always returns -1. (For example, if cap(4) would return an empty string, pos(4) returns -1.) This is due to an implementation tradeoff. +.PP +See also capturedTexts(), exactMatch(), search(), and searchRev(). +.SH "int QRegExp::search ( const QString & str, int offset = 0, CaretMode caretMode = CaretAtZero ) const" +Attempts to find a match in \fIstr\fR from position \fIoffset\fR (0 by default). If \fIoffset\fR is -1, the search starts at the last character; if -2, at the next to last character; etc. +.PP +Returns the position of the first match, or -1 if there was no match. +.PP +The \fIcaretMode\fR parameter can be used to instruct whether \fB^\fR should match at index 0 or at \fIoffset\fR. +.PP +You might prefer to use QString::find(), QString::contains() or even QStringList::grep(). To replace matches use QString::replace(). +.PP +Example: +.PP +.nf +.br + QString str = "offsets: 1.23 .50 71.00 6.00"; +.br + QRegExp rx( "\\\\d*\\\\.\\\\d+" ); // primitive floating point matching +.br + int count = 0; +.br + int pos = 0; +.br + while ( (pos = rx.search(str, pos)) != -1 ) { +.br + count++; +.br + pos += rx.matchedLength(); +.br + } +.br + // pos will be 9, 14, 18 and finally 24; count will end up as 4 +.br +.fi +.PP +Although const, this function sets matchedLength(), capturedTexts() and pos(). +.PP +See also searchRev() and exactMatch(). +.PP +Examples: +.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. +.SH "int QRegExp::searchRev ( const QString & str, int offset = -1, CaretMode caretMode = CaretAtZero ) const" +Attempts to find a match backwards in \fIstr\fR from position \fIoffset\fR. If \fIoffset\fR is -1 (the default), the search starts at the last character; if -2, at the next to last character; etc. +.PP +Returns the position of the first match, or -1 if there was no match. +.PP +The \fIcaretMode\fR parameter can be used to instruct whether \fB^\fR should match at index 0 or at \fIoffset\fR. +.PP +Although const, this function sets matchedLength(), capturedTexts() and pos(). +.PP +\fBWarning:\fR Searching backwards is much slower than searching forwards. +.PP +See also search() and exactMatch(). +.SH "void QRegExp::setCaseSensitive ( bool sensitive )" +Sets case sensitive matching to \fIsensitive\fR. +.PP +If \fIsensitive\fR is TRUE, \fB\.txt$\fR matches \fCreadme.txt\fR but not \fCREADME.TXT\fR. +.PP +See also caseSensitive(). +.PP +Example: regexptester/regexptester.cpp. +.SH "void QRegExp::setMinimal ( bool minimal )" +Enables or disables minimal matching. If \fIminimal\fR is FALSE, matching is greedy (maximal) which is the default. +.PP +For example, suppose we have the input string "We must be <b>bold</b>, very <b>bold</b>!" and the pattern \fB<b>.*</b>\fR. With the default greedy (maximal) matching, the match is "We must be <u><b>bold</b>, very <b>bold</b></u>!". But with minimal (non-greedy) matching the first match is: "We must be <u><b>bold</b></u>, very <b>bold</b>!" and the second match is "We must be <b>bold</b>, very <u><b>bold</b></u>!". In practice we might use the pattern \fB<b>[^<]+</b>\fR instead, although this will still fail for nested tags. +.PP +See also minimal(). +.PP +Examples: +.)l network/archivesearch/archivedialog.ui.h and regexptester/regexptester.cpp. +.SH "void QRegExp::setPattern ( const QString & pattern )" +Sets the pattern string to \fIpattern\fR. The case sensitivity, wildcard and minimal matching options are not changed. +.PP +See also pattern(). +.SH "void QRegExp::setWildcard ( bool wildcard )" +Sets the wildcard mode for the regular expression. The default is FALSE. +.PP +Setting \fIwildcard\fR to TRUE enables simple shell-like wildcard matching. (See wildcard matching (globbing).) +.PP +For example, \fBr*.txt\fR matches the string \fCreadme.txt\fR in wildcard mode, but does not match \fCreadme\fR. +.PP +See also wildcard(). +.PP +Example: regexptester/regexptester.cpp. +.SH "bool QRegExp::wildcard () const" +Returns TRUE if wildcard mode is enabled; otherwise returns FALSE. The default is FALSE. +.PP +See also setWildcard(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqregexp.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqregexp.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqregexpvalidator.3qt b/doc/man/man3/tqregexpvalidator.3qt new file mode 100644 index 000000000..ec7af3122 --- /dev/null +++ b/doc/man/man3/tqregexpvalidator.3qt @@ -0,0 +1,179 @@ +'\" t +.TH QRegExpValidator 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 +QRegExpValidator \- Used to check a string against a +.SH SYNOPSIS +\fC#include <ntqvalidator.h>\fR +.PP +Inherits QValidator. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQRegExpValidator\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQRegExpValidator\fR ( const QRegExp & rx, QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QRegExpValidator\fR ()" +.br +.ti -1c +.BI "virtual QValidator::State \fBvalidate\fR ( QString & input, int & pos ) const" +.br +.ti -1c +.BI "void \fBsetRegExp\fR ( const QRegExp & rx )" +.br +.ti -1c +.BI "const QRegExp & \fBregExp\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QRegExpValidator class is used to check a string against a regular expression. +.PP +QRegExpValidator contains a regular expression, "regexp", used to determine whether an input string is Acceptable, Intermediate or Invalid. +.PP +The regexp is treated as if it begins with the start of string assertion, \fB^\fR, and ends with the end of string assertion \fB$\fR so the match is against the entire input string, or from the given position if a start position greater than zero is given. +.PP +For a brief introduction to Qt's regexp engine see QRegExp. +.PP +Example of use: +.PP +.nf +.br + // regexp: optional '-' followed by between 1 and 3 digits +.br + QRegExp rx( "-?\\\\d{1,3}" ); +.br + QValidator* validator = new QRegExpValidator( rx, this ); +.br +.br + QLineEdit* edit = new QLineEdit( this ); +.br + edit->setValidator( validator ); +.br +.fi +.PP +Below we present some examples of validators. In practice they would normally be associated with a widget as in the example above. +.PP +.nf +.br + // integers 1 to 9999 +.br + QRegExp rx( "[1-9]\\\\d{0,3}" ); +.br + // the validator treats the regexp as "^[1-9]\\\\d{0,3}$" +.br + QRegExpValidator v( rx, 0 ); +.br + QString s; +.br + int pos = 0; +.br +.br + s = "0"; v.validate( s, pos ); // returns Invalid +.br + s = "12345"; v.validate( s, pos ); // returns Invalid +.br + s = "1"; v.validate( s, pos ); // returns Acceptable +.br +.br + rx.setPattern( "\\\\S+" ); // one or more non-whitespace characters +.br + v.setRegExp( rx ); +.br + s = "myfile.txt"; v.validate( s, pos ); // Returns Acceptable +.br + s = "my file.txt"; v.validate( s, pos ); // Returns Invalid +.br +.br + // A, B or C followed by exactly five digits followed by W, X, Y or Z +.br + rx.setPattern( "[A-C]\\\\d{5}[W-Z]" ); +.br + v.setRegExp( rx ); +.br + s = "a12345Z"; v.validate( s, pos ); // Returns Invalid +.br + s = "A12345Z"; v.validate( s, pos ); // Returns Acceptable +.br + s = "B12"; v.validate( s, pos ); // Returns Intermediate +.br +.br + // match most 'readme' files +.br + rx.setPattern( "read\\\\S?me(\\.(txt|asc|1st))?" ); +.br + rx.setCaseSensitive( FALSE ); +.br + v.setRegExp( rx ); +.br + s = "readme"; v.validate( s, pos ); // Returns Acceptable +.br + s = "README.1ST"; v.validate( s, pos ); // Returns Acceptable +.br + s = "read me.txt"; v.validate( s, pos ); // Returns Invalid +.br + s = "readm"; v.validate( s, pos ); // Returns Intermediate +.br +.fi +.PP +See also QRegExp, QIntValidator, QDoubleValidator, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRegExpValidator::QRegExpValidator ( QObject * parent, const char * name = 0 )" +Constructs a validator that accepts any string (including an empty one) as valid. The object's parent is \fIparent\fR and its name is \fIname\fR. +.SH "QRegExpValidator::QRegExpValidator ( const QRegExp & rx, QObject * parent, const char * name = 0 )" +Constructs a validator which accepts all strings that match the regular expression \fIrx\fR. The object's parent is \fIparent\fR and its name is \fIname\fR. +.PP +The match is made against the entire string, e.g. if the regexp is \fB[A-Fa-f0-9]+\fR it will be treated as \fB^[A-Fa-f0-9]+$\fR. +.SH "QRegExpValidator::~QRegExpValidator ()" +Destroys the validator, freeing any resources allocated. +.SH "const QRegExp & QRegExpValidator::regExp () const" +Returns the regular expression used for validation. +.PP +See also setRegExp(). +.SH "void QRegExpValidator::setRegExp ( const QRegExp & rx )" +Sets the regular expression used for validation to \fIrx\fR. +.PP +See also regExp(). +.SH "QValidator::State QRegExpValidator::validate ( QString & input, int & pos ) const\fC [virtual]\fR" +Returns Acceptable if \fIinput\fR is matched by the regular expression for this validator, Intermediate if it has matched partially (i.e. could be a valid match if additional valid characters are added), and Invalid if \fIinput\fR is not matched. +.PP +The \fIpos\fR parameter is set to the length of the \fIinput\fR parameter. +.PP +For example, if the regular expression is \fB\w\d\d\fR (that is, word-character, digit, digit) then "A57" is Acceptable," E5" is Intermediate and "+9" is Invalid. +.PP +See also QRegExp::match() and QRegExp::search(). +.PP +Reimplemented from QValidator. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qregexpvalidator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqregexpvalidator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqregion.3qt b/doc/man/man3/tqregion.3qt new file mode 100644 index 000000000..c7de7178a --- /dev/null +++ b/doc/man/man3/tqregion.3qt @@ -0,0 +1,388 @@ +'\" t +.TH QRegion 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 +QRegion \- Clip region for a painter +.SH SYNOPSIS +\fC#include <ntqregion.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBRegionType\fR { Rectangle, Ellipse }" +.br +.ti -1c +.BI "\fBQRegion\fR ()" +.br +.ti -1c +.BI "\fBQRegion\fR ( int x, int y, int w, int h, RegionType t = Rectangle )" +.br +.ti -1c +.BI "\fBQRegion\fR ( const QRect & r, RegionType t = Rectangle )" +.br +.ti -1c +.BI "\fBQRegion\fR ( const QPointArray & a, bool winding = FALSE )" +.br +.ti -1c +.BI "\fBQRegion\fR ( const QRegion & r )" +.br +.ti -1c +.BI "\fBQRegion\fR ( const QBitmap & bm )" +.br +.ti -1c +.BI "\fB~QRegion\fR ()" +.br +.ti -1c +.BI "QRegion & \fBoperator=\fR ( const QRegion & r )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QRect & r ) const" +.br +.ti -1c +.BI "void \fBtranslate\fR ( int dx, int dy )" +.br +.ti -1c +.BI "QRegion \fBunite\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "QRegion \fBintersect\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "QRegion \fBsubtract\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "QRegion \fBeor\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "QRect \fBboundingRect\fR () const" +.br +.ti -1c +.BI "QMemArray<QRect> \fBrects\fR () const" +.br +.ti -1c +.BI "const QRegion \fBoperator|\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "const QRegion \fBoperator+\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "const QRegion \fBoperator&\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "const QRegion \fBoperator-\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "const QRegion \fBoperator^\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "QRegion & \fBoperator|=\fR ( const QRegion & r )" +.br +.ti -1c +.BI "QRegion & \fBoperator+=\fR ( const QRegion & r )" +.br +.ti -1c +.BI "QRegion & \fBoperator&=\fR ( const QRegion & r )" +.br +.ti -1c +.BI "QRegion & \fBoperator-=\fR ( const QRegion & r )" +.br +.ti -1c +.BI "QRegion & \fBoperator^=\fR ( const QRegion & r )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "HRGN \fBhandle\fR () const" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QRegion & r )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QRegion & r )" +.br +.in -1c +.SH DESCRIPTION +The QRegion class specifies a clip region for a painter. +.PP +QRegion is used with QPainter::setClipRegion() to limit the paint area to what needs to be painted. There is also a QWidget::repaint() that takes a QRegion parameter. QRegion is the best tool for reducing flicker. +.PP +A region can be created from a rectangle, an ellipse, a polygon or a bitmap. Complex regions may be created by combining simple regions using unite(), intersect(), subtract() or eor() (exclusive or). You can move a region using translate(). +.PP +You can test whether a region isNull(), isEmpty() or if it contains() a QPoint or QRect. The bounding rectangle is given by boundingRect(). +.PP +The function rects() gives a decomposition of the region into rectangles. +.PP +Example of using complex regions: +.PP +.nf +.br + void MyWidget::paintEvent( QPaintEvent * ) +.br + { +.br + QPainter p; // our painter +.br + QRegion r1( QRect(100,100,200,80), // r1 = elliptic region +.br + QRegion::Ellipse ); +.br + QRegion r2( QRect(100,120,90,30) ); // r2 = rectangular region +.br + QRegion r3 = r1.intersect( r2 ); // r3 = intersection +.br + p.begin( this ); // start painting widget +.br + p.setClipRegion( r3 ); // set clip region +.br + ... // paint clipped graphics +.br + p.end(); // painting done +.br + } +.br +.fi +.PP +QRegion is an implicitly shared class. +.PP +\fBWarning:\fR Due to window system limitations, the whole coordinate space for a region is limited to the points between -32767 and 32767 on Mac OS X and Windows 95/98/ME. +.PP +See also QPainter::setClipRegion(), QPainter::setClipRect(), Graphics Classes, and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QRegion::RegionType" +Specifies the shape of the region to be created. +.TP +\fCQRegion::Rectangle\fR - the region covers the entire rectangle. +.TP +\fCQRegion::Ellipse\fR - the region is an ellipse inside the rectangle. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRegion::QRegion ()" +Constructs a null region. +.PP +See also isNull(). +.SH "QRegion::QRegion ( int x, int y, int w, int h, RegionType t = Rectangle )" +Constructs a rectangular or elliptic region. +.PP +If \fIt\fR is Rectangle, the region is the filled rectangle (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR). If \fIt\fR is Ellipse, the region is the filled ellipse with center at (\fIx\fR + \fIw\fR / 2, \fIy\fR + \fIh\fR / 2) and size (\fIw\fR ,\fIh\fR ). +.SH "QRegion::QRegion ( const QRect & r, RegionType t = Rectangle )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Create a region based on the rectange \fIr\fR with region type \fIt\fR. +.PP +If the rectangle is invalid a null region will be created. +.PP +See also QRegion::RegionType. +.SH "QRegion::QRegion ( const QPointArray & a, bool winding = FALSE )" +Constructs a polygon region from the point array \fIa\fR. +.PP +If \fIwinding\fR is TRUE, the polygon region is filled using the winding algorithm, otherwise the default even-odd fill algorithm is used. +.PP +This constructor may create complex regions that will slow down painting when used. +.SH "QRegion::QRegion ( const QRegion & r )" +Constructs a new region which is equal to region \fIr\fR. +.SH "QRegion::QRegion ( const QBitmap & bm )" +Constructs a region from the bitmap \fIbm\fR. +.PP +The resulting region consists of the pixels in bitmap \fIbm\fR that are \fCcolor1\fR, as if each pixel was a 1 by 1 rectangle. +.PP +This constructor may create complex regions that will slow down painting when used. Note that drawing masked pixmaps can be done much faster using QPixmap::setMask(). +.SH "QRegion::~QRegion ()" +Destroys the region. +.SH "QRect QRegion::boundingRect () const" +Returns the bounding rectangle of this region. An empty region gives a rectangle that is QRect::isNull(). +.SH "bool QRegion::contains ( const QPoint & p ) const" +Returns TRUE if the region contains the point \fIp\fR; otherwise returns FALSE. +.SH "bool QRegion::contains ( const QRect & r ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the region overlaps the rectangle \fIr\fR; otherwise returns FALSE. +.SH "QRegion QRegion::eor ( const QRegion & r ) const" +Returns a region which is the exclusive or (XOR) of this region and \fIr\fR. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The figure shows the exclusive or of two elliptical regions. +.SH "HRGN QRegion::handle () const" +Returns the region's handle. +.SH "QRegion QRegion::intersect ( const QRegion & r ) const" +Returns a region which is the intersection of this region and \fIr\fR. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The figure shows the intersection of two elliptical regions. +.SH "bool QRegion::isEmpty () const" +Returns TRUE if the region is empty; otherwise returns FALSE. An empty region is a region that contains no points. +.PP +Example: +.PP +.nf +.br + QRegion r1( 10, 10, 20, 20 ); +.br + QRegion r2( 40, 40, 20, 20 ); +.br + QRegion r3; +.br + r1.isNull(); // FALSE +.br + r1.isEmpty(); // FALSE +.br + r3.isNull(); // TRUE +.br + r3.isEmpty(); // TRUE +.br + r3 = r1.intersect( r2 ); // r3 = intersection of r1 and r2 +.br + r3.isNull(); // FALSE +.br + r3.isEmpty(); // TRUE +.br + r3 = r1.unite( r2 ); // r3 = union of r1 and r2 +.br + r3.isNull(); // FALSE +.br + r3.isEmpty(); // FALSE +.br +.fi +.PP +See also isNull(). +.SH "bool QRegion::isNull () const" +Returns TRUE if the region is a null region; otherwise returns FALSE. +.PP +A null region is a region that has not been initialized. A null region is always empty. +.PP +See also isEmpty(). +.SH "bool QRegion::operator!= ( const QRegion & r ) const" +Returns TRUE if the region is different from \fIr\fR; otherwise returns FALSE. +.SH "const QRegion QRegion::operator& ( const QRegion & r ) const" +Applies the intersect() function to this region and \fIr\fR. \fCr1&r2\fR is equivalent to \fCr1.intersect(r2)\fR +.PP +See also intersect(). +.SH "QRegion & QRegion::operator&= ( const QRegion & r )" +Applies the intersect() function to this region and \fIr\fR and assigns the result to this region. \fCr1&=r2\fR is equivalent to \fCr1=r1.intersect(r2)\fR +.PP +See also intersect(). +.SH "const QRegion QRegion::operator+ ( const QRegion & r ) const" +Applies the unite() function to this region and \fIr\fR. \fCr1+r2\fR is equivalent to \fCr1.unite(r2)\fR +.PP +See also unite() and operator|(). +.SH "QRegion & QRegion::operator+= ( const QRegion & r )" +Applies the unite() function to this region and \fIr\fR and assigns the result to this region. \fCr1+=r2\fR is equivalent to \fCr1=r1.unite(r2)\fR +.PP +See also intersect(). +.SH "const QRegion QRegion::operator- ( const QRegion & r ) const" +Applies the subtract() function to this region and \fIr\fR. \fCr1-r2\fR is equivalent to \fCr1.subtract(r2)\fR +.PP +See also subtract(). +.SH "QRegion & QRegion::operator-= ( const QRegion & r )" +Applies the subtract() function to this region and \fIr\fR and assigns the result to this region. \fCr1-=r2\fR is equivalent to \fCr1=r1.subtract(r2)\fR +.PP +See also subtract(). +.SH "QRegion & QRegion::operator= ( const QRegion & r )" +Assigns \fIr\fR to this region and returns a reference to the region. +.SH "bool QRegion::operator== ( const QRegion & r ) const" +Returns TRUE if the region is equal to \fIr\fR; otherwise returns FALSE. +.SH "const QRegion QRegion::operator^ ( const QRegion & r ) const" +Applies the eor() function to this region and \fIr\fR. \fCr1^r2\fR is equivalent to \fCr1.eor(r2)\fR +.PP +See also eor(). +.SH "QRegion & QRegion::operator^= ( const QRegion & r )" +Applies the eor() function to this region and \fIr\fR and assigns the result to this region. \fCr1^=r2\fR is equivalent to \fCr1=r1.eor(r2)\fR +.PP +See also eor(). +.SH "const QRegion QRegion::operator| ( const QRegion & r ) const" +Applies the unite() function to this region and \fIr\fR. \fCr1|r2\fR is equivalent to \fCr1.unite(r2)\fR +.PP +See also unite() and operator+(). +.SH "QRegion & QRegion::operator|= ( const QRegion & r )" +Applies the unite() function to this region and \fIr\fR and assigns the result to this region. \fCr1|=r2\fR is equivalent to \fCr1=r1.unite(r2)\fR +.PP +See also unite(). +.SH "QMemArray<QRect> QRegion::rects () const" +Returns an array of non-overlapping rectangles that make up the region. +.PP +The union of all the rectangles is equal to the original region. +.SH "QRegion QRegion::subtract ( const QRegion & r ) const" +Returns a region which is \fIr\fR subtracted from this region. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The figure shows the result when the ellipse on the right is subtracted from the ellipse on the left. (\fCleft-right\fR ) +.SH "void QRegion::translate ( int dx, int dy )" +Translates (moves) the region \fIdx\fR along the X axis and \fIdy\fR along the Y axis. +.SH "QRegion QRegion::unite ( const QRegion & r ) const" +Returns a region which is the union of this region and \fIr\fR. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The figure shows the union of two elliptical regions. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QRegion & r )" +Writes the region \fIr\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QRegion & r )" +Reads a region from the stream \fIs\fR into \fIr\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqregion.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqregion.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqresizeevent.3qt b/doc/man/man3/tqresizeevent.3qt new file mode 100644 index 000000000..b6f2c5f4e --- /dev/null +++ b/doc/man/man3/tqresizeevent.3qt @@ -0,0 +1,70 @@ +'\" t +.TH QResizeEvent 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 +QResizeEvent \- Event parameters for resize events +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQResizeEvent\fR ( const QSize & size, const QSize & oldSize )" +.br +.ti -1c +.BI "const QSize & \fBsize\fR () const" +.br +.ti -1c +.BI "const QSize & \fBoldSize\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QResizeEvent class contains event parameters for resize events. +.PP +Resize events are sent to widgets that have been resized. +.PP +The event handler QWidget::resizeEvent() receives resize events. +.PP +See also QWidget::size, QWidget::geometry, and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QResizeEvent::QResizeEvent ( const QSize & size, const QSize & oldSize )" +Constructs a resize event with the new and old widget sizes, \fIsize\fR and \fIoldSize\fR respectively. +.SH "const QSize & QResizeEvent::oldSize () const" +Returns the old size of the widget. +.SH "const QSize & QResizeEvent::size () const" +Returns the new size of the widget, which is the same as QWidget::size(). +.PP +Examples: +.)l chart/canvasview.cpp and life/life.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qresizeevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqresizeevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqscreen.3qt b/doc/man/man3/tqscreen.3qt new file mode 100644 index 000000000..f3519b3e6 --- /dev/null +++ b/doc/man/man3/tqscreen.3qt @@ -0,0 +1,329 @@ +'\" t +.TH QScreen 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 +QScreen \- And its descendants manage the framebuffer and palette +.SH SYNOPSIS +\fC#include <qgfx_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQScreen\fR ( int display_id )" +.br +.ti -1c +.BI "virtual \fB~QScreen\fR ()" +.br +.ti -1c +.BI "virtual bool \fBinitDevice\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBconnect\fR ( const QString & displaySpec ) = 0" +.br +.ti -1c +.BI "virtual void \fBdisconnect\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBinitCursor\fR ( void * end_of_location, bool init = FALSE )" +.br +.ti -1c +.BI "virtual void \fBshutdownDevice\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetMode\fR ( int, int, int ) = 0" +.br +.ti -1c +.BI "virtual bool \fBsupportsDepth\fR ( int d ) const" +.br +.ti -1c +.BI "virtual QGfx * \fBcreateGfx\fR ( unsigned char * bytes, int w, int h, int d, int linestep )" +.br +.ti -1c +.BI "virtual QGfx * \fBscreenGfx\fR ()" +.br +.ti -1c +.BI "virtual void \fBsave\fR ()" +.br +.ti -1c +.BI "virtual void \fBrestore\fR ()" +.br +.ti -1c +.BI "virtual void \fBblank\fR ( bool on )" +.br +.ti -1c +.BI "virtual int \fBpixmapOffsetAlignment\fR ()" +.br +.ti -1c +.BI "virtual int \fBpixmapLinestepAlignment\fR ()" +.br +.ti -1c +.BI "virtual bool \fBonCard\fR ( unsigned char * p ) const" +.br +.ti -1c +.BI "virtual bool \fBonCard\fR ( unsigned char * p, ulong & offset ) const" +.br +.ti -1c +.BI "virtual void \fBset\fR ( unsigned " "int" ", unsigned " "int" ", unsigned " "int" ", unsigned int )" +.br +.ti -1c +.BI "virtual int \fBalloc\fR ( unsigned int r, unsigned int g, unsigned int b )" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "int \fBdepth\fR () const" +.br +.ti -1c +.BI "virtual int \fBpixmapDepth\fR () const" +.br +.ti -1c +.BI "int \fBpixelType\fR () const" +.br +.ti -1c +.BI "int \fBlinestep\fR () const" +.br +.ti -1c +.BI "int \fBdeviceWidth\fR () const" +.br +.ti -1c +.BI "int \fBdeviceHeight\fR () const" +.br +.ti -1c +.BI "uchar * \fBbase\fR () const" +.br +.ti -1c +.BI "virtual uchar * \fBcache\fR ( int, int )" +.br +.ti -1c +.BI "virtual void \fBuncache\fR ( uchar * )" +.br +.ti -1c +.BI "int \fBscreenSize\fR () const" +.br +.ti -1c +.BI "int \fBtotalSize\fR () const" +.br +.ti -1c +.BI "QRgb * \fBclut\fR ()" +.br +.ti -1c +.BI "int \fBnumCols\fR ()" +.br +.ti -1c +.BI "virtual QSize \fBmapToDevice\fR ( const QSize & s ) const" +.br +.ti -1c +.BI "virtual QSize \fBmapFromDevice\fR ( const QSize & s ) const" +.br +.ti -1c +.BI "virtual QPoint \fBmapToDevice\fR ( const QPoint &, const QSize & ) const" +.br +.ti -1c +.BI "virtual QPoint \fBmapFromDevice\fR ( const QPoint &, const QSize & ) const" +.br +.ti -1c +.BI "virtual QRect \fBmapToDevice\fR ( const QRect & r, const QSize & ) const" +.br +.ti -1c +.BI "virtual QRect \fBmapFromDevice\fR ( const QRect & r, const QSize & ) const" +.br +.ti -1c +.BI "virtual QImage \fBmapToDevice\fR ( const QImage & i ) const" +.br +.ti -1c +.BI "virtual QImage \fBmapFromDevice\fR ( const QImage & i ) const" +.br +.ti -1c +.BI "virtual QRegion \fBmapToDevice\fR ( const QRegion & r, const QSize & ) const" +.br +.ti -1c +.BI "virtual QRegion \fBmapFromDevice\fR ( const QRegion & r, const QSize & ) const" +.br +.ti -1c +.BI "virtual int \fBtransformOrientation\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisTransformed\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisInterlaced\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDirty\fR ( const QRect & )" +.br +.ti -1c +.BI "int * \fBopType\fR ()" +.br +.ti -1c +.BI "int * \fBlastOp\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QScreen class and its descendants manage the framebuffer and palette. +.PP +QScreens act as factories for the screen cursor and QGfx's. QLinuxFbScreen manages a Linux framebuffer; accelerated drivers subclass QLinuxFbScreen. There can only be one screen in a Qt/Embedded application. +.PP +See also Qt/Embedded. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QScreen::QScreen ( int display_id )" +Create a screen; the \fIdisplay_id\fR is the number of the Qt/Embedded server to connect to. +.SH "QScreen::~QScreen ()\fC [virtual]\fR" +Destroys a QScreen +.SH "int QScreen::alloc ( unsigned int r, unsigned int g, unsigned int b )\fC [virtual]\fR" +Given an RGB value \fIr\fR \fIg\fR \fIb\fR, return an index which is the closest match to it in the screen's palette. Used in paletted modes only. +.SH "uchar * QScreen::base () const" +Returns a pointer to the start of the framebuffer. +.SH "void QScreen::blank ( bool on )\fC [virtual]\fR" +If \fIon\fR is true, blank the screen. Otherwise unblank it. +.SH "uchar * QScreen::cache ( int, int )\fC [virtual]\fR" +This function is used to store pixmaps in graphics memory for the use of the accelerated drivers. See QLinuxFbScreen (where the cacheing is implemented) for more information. +.SH "QRgb * QScreen::clut ()" +Returns the screen's color lookup table (color palette). This is only valid in paletted modes (8bpp and lower). +.SH "bool QScreen::connect ( const QString & displaySpec )\fC [pure virtual]\fR" +This function is called by every Qt/Embedded application on startup. It maps in the framebuffer and in the accelerated drivers the graphics card control registers. \fIdisplaySpec\fR has the following syntax: +.PP +\fC[gfx driver][:driver specific options][:display number]\fR +.PP +for example if you want to use the mach64 driver on fb1 as display 2: +.PP +\fCMach64:/dev/fb1:2\fR +.PP +\fIdisplaySpec\fR is passed in via the QWS_DISPLAY environment variable or the -display command line parameter. +.SH "QGfx * QScreen::createGfx ( unsigned char * bytes, int w, int h, int d, int linestep )\fC [virtual]\fR" +Creates a gfx on an arbitrary buffer \fIbytes\fR, width \fIw\fR and height \fIh\fR in pixels, depth \fId\fR and \fIlinestep\fR (length in bytes of each line in the buffer). Accelerated drivers can check to see if \fIbytes\fR points into graphics memory and create an accelerated Gfx. +.SH "int QScreen::depth () const" +Gives the depth in bits per pixel of the framebuffer. This is the number of bits each pixel takes up rather than the number of significant bits, so 24bpp and 32bpp express the same range of colors (8 bits of red, green and blue) +.SH "int QScreen::deviceHeight () const" +Gives the full height of the framebuffer device, as opposed to the height which Qt/Embedded will actually use. These can differ if the display is centered within the framebuffer. +.SH "int QScreen::deviceWidth () const" +Gives the full width of the framebuffer device, as opposed to the width which Qt/Embedded will actually use. These can differ if the display is centered within the framebuffer. +.SH "void QScreen::disconnect ()\fC [pure virtual]\fR" +This function is called by every Qt/Embedded application just before exitting; it's normally used to unmap the framebuffer. +.SH "int QScreen::height () const" +Gives the height in pixels of the framebuffer. +.SH "int QScreen::initCursor ( void * end_of_location, bool init = FALSE )\fC [virtual]\fR" +This is used to initialize the software cursor - \fIend_of_location\fR points to the address after the area where the cursor image can be stored. \fIinit\fR is true for the first application this method is called from (the Qt/Embedded server), false otherwise. +.SH "bool QScreen::initDevice ()\fC [pure virtual]\fR" +This function is called by the Qt/Embedded server when initializing the framebuffer. Accelerated drivers use it to set up the graphics card. +.SH "bool QScreen::isInterlaced () const\fC [virtual]\fR" +Returns TRUE if the display is interlaced (for instance a television screen); otherwise returns FALSE. If TRUE, drawing is altered to look better on such displays. +.SH "bool QScreen::isTransformed () const\fC [virtual]\fR" +Returns TRUE if the screen is transformed (for instance, rotated 90 degrees); otherwise returns FALSE. QScreen's version always returns FALSE. +.SH "int * QScreen::lastOp ()" +Returns the screens last operation. +.SH "int QScreen::linestep () const" +Returns the length in bytes of each scanline of the framebuffer. +.SH "QSize QScreen::mapFromDevice ( const QSize & s ) const\fC [virtual]\fR" +Map a framebuffer coordinate to the coordinate space used by the application. Used by the rotated driver; the QScreen implementation simply returns \fIs\fR. +.SH "QPoint QScreen::mapFromDevice ( const QPoint &, const QSize & ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Map a framebuffer coordinate to the coordinate space used by the application. Used by the rotated driver; the QScreen implementation simply returns the point. +.SH "QRect QScreen::mapFromDevice ( const QRect & r, const QSize & ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Map a framebuffer coordinate to the coordinate space used by the application. Used by the rotated driver; the QScreen implementation simply returns \fIr\fR. +.SH "QImage QScreen::mapFromDevice ( const QImage & i ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Transforms an image so that it matches the application coordinate space (e.g. rotating it 90 degrees counter-clockwise). The QScreen implementation simply returns \fIi\fR. +.SH "QRegion QScreen::mapFromDevice ( const QRegion & r, const QSize & ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Transforms a region so that it matches the application coordinate space (e.g. rotating it 90 degrees counter-clockwise). The QScreen implementation simply returns \fIr\fR. +.SH "QSize QScreen::mapToDevice ( const QSize & s ) const\fC [virtual]\fR" +Map a user coordinate to the one to actually draw. Used by the rotated driver; the QScreen implementation simply returns \fIs\fR. +.SH "QPoint QScreen::mapToDevice ( const QPoint &, const QSize & ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Map a user coordinate to the one to actually draw. Used by the rotated driver; the QScreen implementation simply returns the point passed in. +.SH "QRect QScreen::mapToDevice ( const QRect & r, const QSize & ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Map a user coordinate to the one to actually draw. Used by the rotated driver; the QScreen implementation simply returns \fIr\fR. +.SH "QImage QScreen::mapToDevice ( const QImage & i ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Transforms an image so that it fits the device coordinate space (e.g. rotating it 90 degrees clockwise). The QScreen implementation simply returns \fIi\fR. +.SH "QRegion QScreen::mapToDevice ( const QRegion & r, const QSize & ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Transforms a region so that it fits the device coordinate space (e.g. rotating it 90 degrees clockwise). The QScreen implementation simply returns \fIr\fR. +.SH "int QScreen::numCols ()" +Returns the number of entries in the color table returned by clut(). +.SH "bool QScreen::onCard ( unsigned char * p ) const\fC [virtual]\fR" +Returns true if the buffer pointed to by \fIp\fR is within graphics card memory, false if it's in main RAM. +.SH "bool QScreen::onCard ( unsigned char * p, ulong & offset ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This checks whether the buffer specified by \fIp\fR is on the card (as per the other version of onCard) and returns an offset in bytes from the start of graphics card memory in \fIoffset\fR if it is. +.SH "int * QScreen::opType ()" +Returns the screen's operation type. +.SH "int QScreen::pixelType () const" +Returns an integer (taking the same values as QGfx::PixelType) that specifies the pixel storage format of the screen. +.SH "int QScreen::pixmapDepth () const\fC [virtual]\fR" +Gives the preferred depth for pixmaps. By default this is the same as the screen depth, but for the VGA16 driver it's 8bpp. +.SH "int QScreen::pixmapLinestepAlignment ()\fC [virtual]\fR" +Returns the value in bits to which individual scanlines of pixmaps held in graphics card memory should be aligned. This is only useful for accelerated drivers. By default the value returned is 64 but it can be overridden by individual accelerated drivers. +.SH "int QScreen::pixmapOffsetAlignment ()\fC [virtual]\fR" +Returns the value in bits to which the start address of pixmaps held in graphics card memory should be aligned. This is only useful for accelerated drivers. By default the value returned is 64 but it can be overridden by individual accelerated drivers. +.SH "void QScreen::restore ()\fC [virtual]\fR" +Restores the state of the graphics card from a previous save() +.SH "void QScreen::save ()\fC [virtual]\fR" +Saves the state of the graphics card - used so that, for instance, the palette can be restored when switching between linux virtual consoles. Hardware QScreen descendants should save register state here if necessary if switching between virtual consoles (for example to/from X) is to be permitted. +.SH "QGfx * QScreen::screenGfx ()\fC [virtual]\fR" +Returns a QGfx (normally a QGfxRaster) initialized to point to the screen, with an origin at 0,0 and a clip region covering the whole screen. +.SH "int QScreen::screenSize () const" +Returns the size in bytes of the screen. This is always located at the beginning of framebuffer memory (i.e. at base()). +.SH "void QScreen::set ( unsigned int, unsigned int, unsigned int, unsigned int )\fC [virtual]\fR" +Sets an entry in the color palette. +.SH "void QScreen::setDirty ( const QRect & )\fC [virtual]\fR" +Indicates which section of the screen has been altered. Used by the VNC and VFB displays; the QScreen version does nothing. +.SH "void QScreen::setMode ( int, int, int )\fC [pure virtual]\fR" +This function can be used to set the framebuffer width, height and depth. It's currently unused. +.SH "void QScreen::shutdownDevice ()\fC [virtual]\fR" +Called by the Qt/Embedded server on shutdown; never called by a Qt/Embedded client. This is intended to support graphics card specific shutdown; the unaccelerated implementation simply hides the mouse cursor. +.SH "bool QScreen::supportsDepth ( int d ) const\fC [virtual]\fR" +Returns true if the screen supports a particular color depth \fId\fR. Possible values are 1,4,8,16 and 32. +.SH "int QScreen::totalSize () const" +Returns the size in bytes of available graphics card memory, including the screen. Offscreen memory is only used by the accelerated drivers. +.SH "int QScreen::transformOrientation () const\fC [virtual]\fR" +Used by the rotated server. The QScreeen implementation returns 0. +.SH "void QScreen::uncache ( uchar * )\fC [virtual]\fR" +This function is called on pixmap destruction to remove them from graphics card memory. +.SH "int QScreen::width () const" +Gives the width in pixels of the framebuffer. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qscreen.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqscreen.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqscrollbar.3qt b/doc/man/man3/tqscrollbar.3qt new file mode 100644 index 000000000..f528a4235 --- /dev/null +++ b/doc/man/man3/tqscrollbar.3qt @@ -0,0 +1,360 @@ +'\" t +.TH QScrollBar 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 +QScrollBar \- Vertical or horizontal scroll bar +.SH SYNOPSIS +\fC#include <ntqscrollbar.h>\fR +.PP +Inherits QWidget and QRangeControl. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQScrollBar\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQScrollBar\fR ( Orientation orientation, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQScrollBar\fR ( int minValue, int maxValue, int lineStep, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QScrollBar\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetOrientation\fR ( Orientation )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTracking\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBtracking\fR () const" +.br +.ti -1c +.BI "bool \fBdraggingSlider\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPalette\fR ( const QPalette & p )" +.br +.ti -1c +.BI "int \fBminValue\fR () const" +.br +.ti -1c +.BI "int \fBmaxValue\fR () const" +.br +.ti -1c +.BI "void \fBsetMinValue\fR ( int )" +.br +.ti -1c +.BI "void \fBsetMaxValue\fR ( int )" +.br +.ti -1c +.BI "int \fBlineStep\fR () const" +.br +.ti -1c +.BI "int \fBpageStep\fR () const" +.br +.ti -1c +.BI "void \fBsetLineStep\fR ( int )" +.br +.ti -1c +.BI "void \fBsetPageStep\fR ( int )" +.br +.ti -1c +.BI "int \fBvalue\fR () const" +.br +.ti -1c +.BI "int \fBsliderStart\fR () const" +.br +.ti -1c +.BI "QRect \fBsliderRect\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBsetValue\fR ( int )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBvalueChanged\fR ( int value )" +.br +.ti -1c +.BI "void \fBsliderPressed\fR ()" +.br +.ti -1c +.BI "void \fBsliderMoved\fR ( int value )" +.br +.ti -1c +.BI "void \fBsliderReleased\fR ()" +.br +.ti -1c +.BI "void \fBnextLine\fR ()" +.br +.ti -1c +.BI "void \fBprevLine\fR ()" +.br +.ti -1c +.BI "void \fBnextPage\fR ()" +.br +.ti -1c +.BI "void \fBprevPage\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBdraggingSlider\fR - whether the user has clicked the mouse on the slider and is currently dragging it \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBlineStep\fR - the line step" +.br +.ti -1c +.BI "int \fBmaxValue\fR - the scroll bar's maximum value" +.br +.ti -1c +.BI "int \fBminValue\fR - the scroll bar's minimum value" +.br +.ti -1c +.BI "Orientation \fBorientation\fR - the orientation of the scroll bar" +.br +.ti -1c +.BI "int \fBpageStep\fR - the page step" +.br +.ti -1c +.BI "bool \fBtracking\fR - whether scroll bar tracking is enabled" +.br +.ti -1c +.BI "int \fBvalue\fR - the scroll bar's value" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBhideEvent\fR ( QHideEvent * )" +.br +.in -1c +.SH DESCRIPTION +The QScrollBar widget provides a vertical or horizontal scroll bar. +.PP +A scroll bar allows the user to control a value within a program-definable range and gives users a visible indication of the current value of a range control. +.PP +Scroll bars include four separate controls: +.IP +.TP +The \fIline-up\fR and \fIline-down\fR controls are little buttons which the user can use to move one "line" up or down. The meaning of line is configurable. In editors and list boxes it means one line of text; in an image viewer it might mean 20 pixels. +.IP +.TP +The \fIslider\fR is the handle that indicates the current value of the scroll bar, which the user can drag to change the value. This part of the scroll bar is sometimes called the "thumb". +.IP +.TP +The \fIpage-up/page-down\fR control is the area on which the slider slides (the scroll bar's background). Clicking here moves the scroll bar towards the click. The meaning of "page" is also configurable: in editors and list boxes it means as many lines as there is space for in the widget. +.IP +.PP +QScrollBar has very few of its own functions; it mostly relies on QRangeControl. The most useful functions are setValue() to set the scroll bar directly to some value; addPage(), addLine(), subtractPage(), and subtractLine() to simulate the effects of clicking (useful for accelerator keys); setSteps() to define the values of pageStep() and lineStep(); and setRange() to set the minValue() and maxValue() of the scroll bar. QScrollBar has a convenience constructor with which you can set most of these properties. +.PP +Some GUI styles (for example, the Windows and Motif styles provided with Qt), also use the pageStep() value to calculate the size of the slider. +.PP +In addition to the access functions from QRangeControl, QScrollBar provides a comprehensive set of signals: <center>.nf +.TS +l - l. Signal Emitted when valueChanged() the scroll bar's value has changed. The tracking() determines whether this signal is emitted during user interaction. sliderPressed() the user starts to drag the slider. sliderMoved() the user drags the slider. sliderReleased() the user releases the slider. nextLine() the scroll bar has moved one line down or right. Line is defined in QRangeControl. prevLine() the scroll bar has moved one line up or left. nextPage() the scroll bar has moved one page down or right. prevPage() +.TE +.fi +</center> +.PP +QScrollBar only provides integer ranges. Note that although QScrollBar handles very large numbers, scroll bars on current screens cannot usefully control ranges above about 100,000 pixels. Beyond that, it becomes difficult for the user to control the scroll bar using either the keyboard or the mouse. +.PP +A scroll bar can be controlled by the keyboard, but it has a default focusPolicy() of NoFocus. Use setFocusPolicy() to enable keyboard focus. See keyPressEvent() for a list of key bindings. +.PP +If you need to add scroll bars to an interface, consider using the QScrollView class, which encapsulates the common uses for scroll bars. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QSlider, QSpinBox, QScrollView, GUI Design Handbook: Scroll Bar, and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QScrollBar::QScrollBar ( QWidget * parent, const char * name = 0 )" +Constructs a vertical scroll bar. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.PP +The minValue defaults to 0, the maxValue to 99, with a lineStep size of 1 and a pageStep size of 10, and an initial value of 0. +.SH "QScrollBar::QScrollBar ( Orientation orientation, QWidget * parent, const char * name = 0 )" +Constructs a scroll bar. +.PP +The \fIorientation\fR must be Qt::Vertical or Qt::Horizontal. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.PP +The minValue defaults to 0, the maxValue to 99, with a lineStep size of 1 and a pageStep size of 10, and an initial value of 0. +.SH "QScrollBar::QScrollBar ( int minValue, int maxValue, int lineStep, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" +Constructs a scroll bar whose value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR, whose line step size is \fIlineStep\fR and page step size is \fIpageStep\fR and whose value is initially \fIvalue\fR (which is guaranteed to be in range using bound()). +.PP +If \fIorientation\fR is Vertical the scroll bar is vertical and if it is Horizontal the scroll bar is horizontal. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.SH "QScrollBar::~QScrollBar ()" +Destructor. +.SH "bool QScrollBar::draggingSlider () const" +Returns TRUE if the user has clicked the mouse on the slider and is currently dragging it; otherwise returns FALSE. See the "draggingSlider" property for details. +.SH "void QScrollBar::hideEvent ( QHideEvent * )\fC [virtual protected]\fR" +This function is called when the scrollbar is hidden. +.PP +Reimplemented from QWidget. +.SH "int QScrollBar::lineStep () const" +Returns the line step. See the "lineStep" property for details. +.SH "int QScrollBar::maxValue () const" +Returns the scroll bar's maximum value. See the "maxValue" property for details. +.SH "int QScrollBar::minValue () const" +Returns the scroll bar's minimum value. See the "minValue" property for details. +.SH "void QScrollBar::nextLine ()\fC [signal]\fR" +This signal is emitted when the scroll bar scrolls one line down or right. +.SH "void QScrollBar::nextPage ()\fC [signal]\fR" +This signal is emitted when the scroll bar scrolls one page down or right. +.SH "Orientation QScrollBar::orientation () const" +Returns the orientation of the scroll bar. See the "orientation" property for details. +.SH "int QScrollBar::pageStep () const" +Returns the page step. See the "pageStep" property for details. +.SH "void QScrollBar::prevLine ()\fC [signal]\fR" +This signal is emitted when the scroll bar scrolls one line up or left. +.SH "void QScrollBar::prevPage ()\fC [signal]\fR" +This signal is emitted when the scroll bar scrolls one page up or left. +.SH "void QScrollBar::setLineStep ( int )" +Sets the line step. See the "lineStep" property for details. +.SH "void QScrollBar::setMaxValue ( int )" +Sets the scroll bar's maximum value. See the "maxValue" property for details. +.SH "void QScrollBar::setMinValue ( int )" +Sets the scroll bar's minimum value. See the "minValue" property for details. +.SH "void QScrollBar::setOrientation ( Orientation )\fC [virtual]\fR" +Sets the orientation of the scroll bar. See the "orientation" property for details. +.SH "void QScrollBar::setPageStep ( int )" +Sets the page step. See the "pageStep" property for details. +.SH "void QScrollBar::setPalette ( const QPalette & p )\fC [virtual]\fR" +Reimplements the virtual function QWidget::setPalette(). +.PP +Sets the background color to the mid color for Motif style scroll bars using palette \fIp\fR. +.PP +Reimplemented from QWidget. +.SH "void QScrollBar::setTracking ( bool enable )\fC [virtual]\fR" +Sets whether scroll bar tracking is enabled to \fIenable\fR. See the "tracking" property for details. +.SH "void QScrollBar::setValue ( int )\fC [slot]\fR" +Sets the scroll bar's value. See the "value" property for details. +.SH "void QScrollBar::sliderMoved ( int value )\fC [signal]\fR" +This signal is emitted when the slider is dragged by the user, with the new scroll bar \fIvalue\fR as an argument. +.PP +This signal is emitted even when tracking is turned off. +.PP +See also tracking, valueChanged(), nextLine(), prevLine(), nextPage(), and prevPage(). +.SH "void QScrollBar::sliderPressed ()\fC [signal]\fR" +This signal is emitted when the user presses the slider with the mouse. +.SH "QRect QScrollBar::sliderRect () const" +Returns the scroll bar slider rectangle. +.PP +See also sliderStart(). +.SH "void QScrollBar::sliderReleased ()\fC [signal]\fR" +This signal is emitted when the user releases the slider with the mouse. +.SH "int QScrollBar::sliderStart () const" +Returns the pixel position where the scroll bar slider starts. +.PP +This is equivalent to sliderRect().y() for vertical scroll bars or sliderRect().x() for horizontal scroll bars. +.SH "bool QScrollBar::tracking () const" +Returns TRUE if scroll bar tracking is enabled; otherwise returns FALSE. See the "tracking" property for details. +.SH "int QScrollBar::value () const" +Returns the scroll bar's value. See the "value" property for details. +.SH "void QScrollBar::valueChanged ( int value )\fC [signal]\fR" +This signal is emitted when the scroll bar value has changed, with the new scroll bar \fIvalue\fR as an argument. +.SS "Property Documentation" +.SH "bool draggingSlider" +This property holds whether the user has clicked the mouse on the slider and is currently dragging it. +.PP +Get this property's value with draggingSlider(). +.SH "int lineStep" +This property holds the line step. +.PP +When setting lineStep, the virtual stepChange() function will be called if the new line step is different from the previous setting. +.PP +See also setSteps(), QRangeControl::pageStep(), and setRange(). +.PP +Set this property's value with setLineStep() and get this property's value with lineStep(). +.SH "int maxValue" +This property holds the scroll bar's maximum value. +.PP +When setting this property, the QScrollBar::minValue is adjusted if necessary to ensure that the range remains valid. +.PP +See also setRange(). +.PP +Set this property's value with setMaxValue() and get this property's value with maxValue(). +.SH "int minValue" +This property holds the scroll bar's minimum value. +.PP +When setting this property, the QScrollBar::maxValue is adjusted if necessary to ensure that the range remains valid. +.PP +See also setRange(). +.PP +Set this property's value with setMinValue() and get this property's value with minValue(). +.SH "Orientation orientation" +This property holds the orientation of the scroll bar. +.PP +The orientation must be Qt::Vertical (the default) or Qt::Horizontal. +.PP +Set this property's value with setOrientation() and get this property's value with orientation(). +.SH "int pageStep" +This property holds the page step. +.PP +When setting pageStep, the virtual stepChange() function will be called if the new page step is different from the previous setting. +.PP +See also QRangeControl::setSteps(), lineStep, and setRange(). +.PP +Set this property's value with setPageStep() and get this property's value with pageStep(). +.SH "bool tracking" +This property holds whether scroll bar tracking is enabled. +.PP +If tracking is enabled (the default), the scroll bar emits the valueChanged() signal while the slider is being dragged. If tracking is disabled, the scroll bar emits the valueChanged() signal only when the user releases the mouse button after moving the slider. +.PP +Set this property's value with setTracking() and get this property's value with tracking(). +.SH "int value" +This property holds the scroll bar's value. +.PP +Set this property's value with setValue() and get this property's value with value(). +.PP +See also QRangeControl::value() and prevValue(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqscrollbar.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqscrollbar.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqscrollview.3qt b/doc/man/man3/tqscrollview.3qt new file mode 100644 index 000000000..e8dc7da69 --- /dev/null +++ b/doc/man/man3/tqscrollview.3qt @@ -0,0 +1,913 @@ +'\" t +.TH QScrollView 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 +QScrollView \- Scrolling area with on-demand scroll bars +.SH SYNOPSIS +\fC#include <ntqscrollview.h>\fR +.PP +Inherits QFrame. +.PP +Inherited by QCanvasView, QTable, QGridView, QIconView, QListBox, QListView, and QTextEdit. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQScrollView\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QScrollView\fR ()" +.br +.ti -1c +.BI "enum \fBResizePolicy\fR { Default, Manual, AutoOne, AutoOneFit }" +.br +.ti -1c +.BI "virtual void \fBsetResizePolicy\fR ( ResizePolicy )" +.br +.ti -1c +.BI "ResizePolicy \fBresizePolicy\fR () const" +.br +.ti -1c +.BI "void \fBremoveChild\fR ( QWidget * child )" +.br +.ti -1c +.BI "virtual void \fBaddChild\fR ( QWidget * child, int x = 0, int y = 0 )" +.br +.ti -1c +.BI "virtual void \fBmoveChild\fR ( QWidget * child, int x, int y )" +.br +.ti -1c +.BI "int \fBchildX\fR ( QWidget * child )" +.br +.ti -1c +.BI "int \fBchildY\fR ( QWidget * child )" +.br +.ti -1c +.BI "bool childIsVisible ( QWidget * child ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void showChild ( QWidget * child, bool y = TRUE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "enum \fBScrollBarMode\fR { Auto, AlwaysOff, AlwaysOn }" +.br +.ti -1c +.BI "ScrollBarMode \fBvScrollBarMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetVScrollBarMode\fR ( ScrollBarMode )" +.br +.ti -1c +.BI "ScrollBarMode \fBhScrollBarMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetHScrollBarMode\fR ( ScrollBarMode )" +.br +.ti -1c +.BI "QWidget * \fBcornerWidget\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCornerWidget\fR ( QWidget * corner )" +.br +.ti -1c +.BI "QScrollBar * \fBhorizontalScrollBar\fR () const" +.br +.ti -1c +.BI "QScrollBar * \fBverticalScrollBar\fR () const" +.br +.ti -1c +.BI "QWidget * \fBviewport\fR () const" +.br +.ti -1c +.BI "QWidget * \fBclipper\fR () const" +.br +.ti -1c +.BI "int \fBvisibleWidth\fR () const" +.br +.ti -1c +.BI "int \fBvisibleHeight\fR () const" +.br +.ti -1c +.BI "int \fBcontentsWidth\fR () const" +.br +.ti -1c +.BI "int \fBcontentsHeight\fR () const" +.br +.ti -1c +.BI "int \fBcontentsX\fR () const" +.br +.ti -1c +.BI "int \fBcontentsY\fR () const" +.br +.ti -1c +.BI "void \fBupdateContents\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBupdateContents\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBupdateContents\fR ()" +.br +.ti -1c +.BI "void \fBrepaintContents\fR ( int x, int y, int w, int h, bool erase = TRUE )" +.br +.ti -1c +.BI "void \fBrepaintContents\fR ( const QRect & r, bool erase = TRUE )" +.br +.ti -1c +.BI "void \fBrepaintContents\fR ( bool erase = TRUE )" +.br +.ti -1c +.BI "void \fBcontentsToViewport\fR ( int x, int y, int & vx, int & vy ) const" +.br +.ti -1c +.BI "void \fBviewportToContents\fR ( int vx, int vy, int & x, int & y ) const" +.br +.ti -1c +.BI "QPoint \fBcontentsToViewport\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "QPoint \fBviewportToContents\fR ( const QPoint & vp ) const" +.br +.ti -1c +.BI "void \fBenableClipper\fR ( bool y )" +.br +.ti -1c +.BI "void \fBsetStaticBackground\fR ( bool y )" +.br +.ti -1c +.BI "bool \fBhasStaticBackground\fR () const" +.br +.ti -1c +.BI "QSize \fBviewportSize\fR ( int x, int y ) const" +.br +.ti -1c +.BI "bool \fBisHorizontalSliderPressed\fR ()" +.br +.ti -1c +.BI "bool \fBisVerticalSliderPressed\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetDragAutoScroll\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBdragAutoScroll\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBresizeContents\fR ( int w, int h )" +.br +.ti -1c +.BI "void \fBscrollBy\fR ( int dx, int dy )" +.br +.ti -1c +.BI "virtual void \fBsetContentsPos\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBensureVisible\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBensureVisible\fR ( int x, int y, int xmargin, int ymargin )" +.br +.ti -1c +.BI "void \fBcenter\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBcenter\fR ( int x, int y, float xmargin, float ymargin )" +.br +.ti -1c +.BI "void \fBupdateScrollBars\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBcontentsMoving\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBhorizontalSliderPressed\fR ()" +.br +.ti -1c +.BI "void \fBhorizontalSliderReleased\fR ()" +.br +.ti -1c +.BI "void \fBverticalSliderPressed\fR ()" +.br +.ti -1c +.BI "void \fBverticalSliderReleased\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBcontentsHeight\fR - the height of the contents area \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcontentsWidth\fR - the width of the contents area \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcontentsX\fR - the X coordinate of the contents that are at the left edge of the viewport \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcontentsY\fR - the Y coordinate of the contents that are at the top edge of the viewport \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBdragAutoScroll\fR - whether autoscrolling in drag move events is enabled" +.br +.ti -1c +.BI "ScrollBarMode \fBhScrollBarMode\fR - the mode for the horizontal scroll bar" +.br +.ti -1c +.BI "ResizePolicy \fBresizePolicy\fR - the resize policy" +.br +.ti -1c +.BI "ScrollBarMode \fBvScrollBarMode\fR - the mode for the vertical scroll bar" +.br +.ti -1c +.BI "int \fBvisibleHeight\fR - the vertical amount of the content that is visible \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBvisibleWidth\fR - the horizontal amount of the content that is visible \fI(read " "only" ")\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * p, int clipx, int clipy, int clipw, int cliph )" +.br +.ti -1c +.BI "virtual void \fBdrawContentsOffset\fR ( QPainter * p, int offsetx, int offsety, int clipx, int clipy, int clipw, int cliph )" +.br +.ti -1c +.BI "virtual void \fBcontentsMousePressEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsMouseReleaseEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsMouseDoubleClickEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsMouseMoveEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsDragEnterEvent\fR ( QDragEnterEvent * )" +.br +.ti -1c +.BI "virtual void \fBcontentsDragMoveEvent\fR ( QDragMoveEvent * )" +.br +.ti -1c +.BI "virtual void \fBcontentsDragLeaveEvent\fR ( QDragLeaveEvent * )" +.br +.ti -1c +.BI "virtual void \fBcontentsDropEvent\fR ( QDropEvent * )" +.br +.ti -1c +.BI "virtual void \fBcontentsWheelEvent\fR ( QWheelEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsContextMenuEvent\fR ( QContextMenuEvent * e )" +.br +.ti -1c +.BI "virtual void \fBviewportPaintEvent\fR ( QPaintEvent * pe )" +.br +.ti -1c +.BI "virtual void \fBviewportResizeEvent\fR ( QResizeEvent * )" +.br +.ti -1c +.BI "virtual void \fBsetMargins\fR ( int left, int top, int right, int bottom )" +.br +.ti -1c +.BI "int \fBleftMargin\fR () const" +.br +.ti -1c +.BI "int \fBtopMargin\fR () const" +.br +.ti -1c +.BI "int \fBrightMargin\fR () const" +.br +.ti -1c +.BI "int \fBbottomMargin\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetHBarGeometry\fR ( QScrollBar & hbar, int x, int y, int w, int h )" +.br +.ti -1c +.BI "virtual void \fBsetVBarGeometry\fR ( QScrollBar & vbar, int x, int y, int w, int h )" +.br +.ti -1c +.BI "virtual bool \fBeventFilter\fR ( QObject * obj, QEvent * e )" +.br +.in -1c +.SH DESCRIPTION +The QScrollView widget provides a scrolling area with on-demand scroll bars. +.PP +The QScrollView is a large canvas - potentially larger than the coordinate system normally supported by the underlying window system. This is important because it is quite easy to go beyond these limitations (e.g. many web pages are more than 32000 pixels high). Additionally, the QScrollView can have QWidgets positioned on it that scroll around with the drawn content. These sub-widgets can also have positions outside the normal coordinate range (but they are still limited in size). +.PP +To provide content for the widget, inherit from QScrollView, reimplement drawContents() and use resizeContents() to set the size of the viewed area. Use addChild() and moveChild() to position widgets on the view. +.PP +To use QScrollView effectively it is important to understand its widget structure in the three styles of use: a single large child widget, a large panning area with some widgets and a large panning area with many widgets. +.SH "Using One Big Widget" +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The first, simplest usage of QScrollView (depicted above), is appropriate for scrolling areas that are never more than about 4000 pixels in either dimension (this is about the maximum reliable size on X11 servers). In this usage, you just make one large child in the QScrollView. The child should be a child of the viewport() of the scrollview and be added with addChild(): +.PP +.nf +.br + QScrollView* sv = new QScrollView(...); +.br + QVBox* big_box = new QVBox(sv->viewport()); +.br + sv->addChild(big_box); +.br +.fi +You can go on to add arbitrary child widgets to the single child in the scrollview as you would with any widget: +.PP +.nf +.br + QLabel* child1 = new QLabel("CHILD", big_box); +.br + QLabel* child2 = new QLabel("CHILD", big_box); +.br + QLabel* child3 = new QLabel("CHILD", big_box); +.br + ... +.br +.fi +.PP +Here the QScrollView has four children: the viewport(), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The viewport() has one child: the big QVBox. The QVBox has the three QLabel objects as child widgets. When the view is scrolled, the QVBox is moved; its children move with it as child widgets normally do. +.SH "Using a Very Big View with Some Widgets" +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The second usage of QScrollView (depicted above) is appropriate when few, if any, widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You may also add some widgets by making them children of the viewport() and adding them with addChild() (this is the same as the process for the single large widget in the previous example): +.PP +.nf +.br + QScrollView* sv = new QScrollView(...); +.br + QLabel* child1 = new QLabel("CHILD", sv->viewport()); +.br + sv->addChild(child1); +.br + QLabel* child2 = new QLabel("CHILD", sv->viewport()); +.br + sv->addChild(child2); +.br + QLabel* child3 = new QLabel("CHILD", sv->viewport()); +.br + sv->addChild(child3); +.br +.fi +Here, the QScrollView has the same four children: the viewport(), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The viewport() has the three QLabel objects as child widgets. When the view is scrolled, the scrollview moves the child widgets individually. +.SH "Using a Very Big View with Many Widgets" +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +The final usage of QScrollView (depicted above) is appropriate when many widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You then call enableClipper(TRUE) and add widgets, again by making them children of the viewport(), and adding them with addChild(): +.PP +.nf +.br + QScrollView* sv = new QScrollView(...); +.br + sv->enableClipper(TRUE); +.br + QLabel* child1 = new QLabel("CHILD", sv->viewport()); +.br + sv->addChild(child1); +.br + QLabel* child2 = new QLabel("CHILD", sv->viewport()); +.br + sv->addChild(child2); +.br + QLabel* child3 = new QLabel("CHILD", sv->viewport()); +.br + sv->addChild(child3); +.br +.fi +.PP +Here, the QScrollView has four children: the clipper() (not the viewport() this time), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The clipper() has one child: the viewport(). The viewport() has the same three labels as child widgets. When the view is scrolled the viewport() is moved; its children move with it as child widgets normally do. +.SH "Details Relevant for All Views" +Normally you will use the first or third method if you want any child widgets in the view. +.PP +Note that the widget you see in the scrolled area is the viewport() widget, not the QScrollView itself. So to turn mouse tracking on, for example, use viewport()->setMouseTracking(TRUE). +.PP +To enable drag-and-drop, you would setAcceptDrops(TRUE) on the QScrollView (because drag-and-drop events propagate to the parent). But to work out the logical position in the view, you would need to map the drop co-ordinate from being relative to the QScrollView to being relative to the contents; use the function viewportToContents() for this. +.PP +To handle mouse events on the scrolling area, subclass scrollview as you would subclass other widgets, but rather than reimplementing mousePressEvent(), reimplement contentsMousePressEvent() instead. The contents specific event handlers provide translated events in the coordinate system of the scrollview. If you reimplement mousePressEvent(), you'll get called only when part of the QScrollView is clicked: and the only such part is the "corner" (if you don't set a cornerWidget()) and the frame; everything else is covered up by the viewport, clipper or scroll bars. +.PP +When you construct a QScrollView, some of the widget flags apply to the viewport() instead of being sent to the QWidget constructor for the QScrollView. This applies to WNoAutoErase, WStaticContents, and WPaintClever. See Qt::WidgetFlags for documentation about these flags. Here are some examples: +.IP +.TP +An image-manipulation widget would use \fCWNoAutoErase|WStaticContents\fR because the widget draws all pixels itself, and when its size increases, it only needs a paint event for the new part because the old part remains unchanged. +.IP +.TP +A scrolling game widget in which the background scrolls as the characters move might use WNoAutoErase (in addition to WStaticContents) so that the window system background does not flash in and out during scrolling. +.IP +.TP +A word processing widget might use WNoAutoErase and repaint itself line by line to get a less-flickery resizing. If the widget is in a mode in which no text justification can take place, it might use WStaticContents too, so that it would only get a repaint for the newly visible parts. +.IP +.PP +Child widgets may be moved using addChild() or moveChild(). Use childX() and childY() to get the position of a child widget. +.PP +A widget may be placed in the corner between the vertical and horizontal scrollbars with setCornerWidget(). You can get access to the scrollbars using horizontalScrollBar() and verticalScrollBar(), and to the viewport with viewport(). The scroll view can be scrolled using scrollBy(), ensureVisible(), setContentsPos() or center(). +.PP +The visible area is given by visibleWidth() and visibleHeight(), and the contents area by contentsWidth() and contentsHeight(). The contents may be repainted using one of the repaintContents() or updateContents() functions. +.PP +Coordinate conversion is provided by contentsToViewport() and viewportToContents(). +.PP +The contentsMoving() signal is emitted just before the contents are moved to a new position. +.PP +\fBWarning:\fR QScrollView currently does not erase the background when resized, i.e. you must always clear the background manually in scrollview subclasses. This will change in a future version of Qt and we recommend specifying the WNoAutoErase flag explicitly. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also Abstract Widget Classes. +.SS "Member Type Documentation" +.SH "QScrollView::ResizePolicy" +This enum type is used to control a QScrollView's reaction to resize events. +.TP +\fCQScrollView::Default\fR - the QScrollView selects one of the other settings automatically when it has to. In this version of Qt, QScrollView changes to Manual if you resize the contents with resizeContents() and to AutoOne if a child is added. +.TP +\fCQScrollView::Manual\fR - the contents stays the size set by resizeContents(). +.TP +\fCQScrollView::AutoOne\fR - if there is only one child widget the contents stays the size of that widget. Otherwise the behavior is undefined. +.TP +\fCQScrollView::AutoOneFit\fR - if there is only one child widget the contents stays the size of that widget's sizeHint(). If the scrollview is resized larger than the child's sizeHint(), the child will be resized to fit. If there is more than one child, the behavior is undefined. +.SH "QScrollView::ScrollBarMode" +This enum type describes the various modes of QScrollView's scroll bars. +.TP +\fCQScrollView::Auto\fR - QScrollView shows a scroll bar when the content is too large to fit and not otherwise. This is the default. +.TP +\fCQScrollView::AlwaysOff\fR - QScrollView never shows a scroll bar. +.TP +\fCQScrollView::AlwaysOn\fR - QScrollView always shows a scroll bar. +.PP +(The modes for the horizontal and vertical scroll bars are independent.) +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QScrollView::QScrollView ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a QScrollView called \fIname\fR with parent \fIparent\fR and widget flags \fIf\fR. +.PP +The widget flags WStaticContents, WNoAutoErase and WPaintClever are propagated to the viewport() widget. The other widget flags are propagated to the parent constructor as usual. +.SH "QScrollView::~QScrollView ()" +Destroys the QScrollView. Any children added with addChild() will be deleted. +.SH "void QScrollView::addChild ( QWidget * child, int x = 0, int y = 0 )\fC [virtual]\fR" +Inserts the widget, \fIchild\fR, into the scrolled area positioned at (\fIx\fR, \fIy\fR). The position defaults to (0, 0). If the child is already in the view, it is just moved. +.PP +You may want to call enableClipper(TRUE) if you add a large number of widgets. +.PP +Example: scrollview/scrollview.cpp. +.SH "int QScrollView::bottomMargin () const\fC [protected]\fR" +Returns the bottom margin. +.PP +See also setMargins(). +.SH "void QScrollView::center ( int x, int y )\fC [slot]\fR" +Scrolls the content so that the point \fI(x, y)\fR is in the center of visible area. +.PP +Example: scrollview/scrollview.cpp. +.SH "void QScrollView::center ( int x, int y, float xmargin, float ymargin )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Scrolls the content so that the point \fI(x, y)\fR is visible with the \fIxmargin\fR and \fIymargin\fR margins (as fractions of visible the area). +.PP +For example: +.TP +Margin 0.0 allows (x, y) to be on the edge of the visible area. +.TP +Margin 0.5 ensures that (x, y) is in middle 50% of the visible area. +.TP +Margin 1.0 ensures that (x, y) is in the center of the the visible area. +.SH "bool QScrollView::childIsVisible ( QWidget * child )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if \fIchild\fR is visible. This is equivalent to child->isVisible(). +.SH "int QScrollView::childX ( QWidget * child )" +Returns the X position of the given \fIchild\fR widget. Use this rather than QWidget::x() for widgets added to the view. +.PP +This function returns 0 if \fIchild\fR has not been added to the view. +.SH "int QScrollView::childY ( QWidget * child )" +Returns the Y position of the given \fIchild\fR widget. Use this rather than QWidget::y() for widgets added to the view. +.PP +This function returns 0 if \fIchild\fR has not been added to the view. +.SH "QWidget * QScrollView::clipper () const" +Returns the clipper widget. Contents in the scrollview are ultimately clipped to be inside the clipper widget. +.PP +You should not need to use this function. +.PP +See also visibleWidth and visibleHeight. +.SH "void QScrollView::contentsContextMenuEvent ( QContextMenuEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a contextMenuEvent() in \fIe\fR: the mouse position is translated to be a point on the contents. +.PP +Example: chart/canvasview.cpp. +.SH "void QScrollView::contentsDragEnterEvent ( QDragEnterEvent * )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a dragEnterEvent(): the drag position is translated to be a point on the contents. +.PP +Reimplemented in QTable. +.SH "void QScrollView::contentsDragLeaveEvent ( QDragLeaveEvent * )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a dragLeaveEvent(): the drag position is translated to be a point on the contents. +.PP +Reimplemented in QTable. +.SH "void QScrollView::contentsDragMoveEvent ( QDragMoveEvent * )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a dragMoveEvent(): the drag position is translated to be a point on the contents. +.PP +Reimplemented in QTable. +.SH "void QScrollView::contentsDropEvent ( QDropEvent * )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a dropEvent(): the drop position is translated to be a point on the contents. +.PP +Reimplemented in QTable. +.SH "int QScrollView::contentsHeight () const" +Returns the height of the contents area. See the "contentsHeight" property for details. +.SH "void QScrollView::contentsMouseDoubleClickEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a mouseDoubleClickEvent(): the click position in \fIe\fR is translated to be a point on the contents. +.PP +The default implementation generates a normal mouse press event. +.PP +Reimplemented in QListView. +.SH "void QScrollView::contentsMouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a mouseMoveEvent(): the mouse position in \fIe\fR is translated to be a point on the contents. +.PP +Examples: +.)l canvas/canvas.cpp and chart/canvasview.cpp. +.PP +Reimplemented in QListView. +.SH "void QScrollView::contentsMousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a mousePressEvent(): the press position in \fIe\fR is translated to be a point on the contents. +.PP +Examples: +.)l canvas/canvas.cpp and chart/canvasview.cpp. +.PP +Reimplemented in QListView. +.SH "void QScrollView::contentsMouseReleaseEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a mouseReleaseEvent(): the release position in \fIe\fR is translated to be a point on the contents. +.PP +Reimplemented in QListView. +.SH "void QScrollView::contentsMoving ( int x, int y )\fC [signal]\fR" +This signal is emitted just before the contents are moved to position \fI(x, y)\fR. +.PP +See also contentsX and contentsY. +.SH "void QScrollView::contentsToViewport ( int x, int y, int & vx, int & vy ) const" +Translates a point (\fIx\fR, \fIy\fR) in the contents to a point (\fIvx\fR, \fIvy\fR) on the viewport() widget. +.SH "QPoint QScrollView::contentsToViewport ( const QPoint & p ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point \fIp\fR translated to a point on the viewport() widget. +.SH "void QScrollView::contentsWheelEvent ( QWheelEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever the QScrollView receives a wheelEvent() in \fIe\fR: the mouse position is translated to be a point on the contents. +.SH "int QScrollView::contentsWidth () const" +Returns the width of the contents area. See the "contentsWidth" property for details. +.SH "int QScrollView::contentsX () const" +Returns the X coordinate of the contents that are at the left edge of the viewport. See the "contentsX" property for details. +.SH "int QScrollView::contentsY () const" +Returns the Y coordinate of the contents that are at the top edge of the viewport. See the "contentsY" property for details. +.SH "QWidget * QScrollView::cornerWidget () const" +Returns the widget in the corner between the two scroll bars. +.PP +By default, no corner widget is present. +.PP +Example: scrollview/scrollview.cpp. +.SH "bool QScrollView::dragAutoScroll () const" +Returns TRUE if autoscrolling in drag move events is enabled; otherwise returns FALSE. See the "dragAutoScroll" property for details. +.SH "void QScrollView::drawContents ( QPainter * p, int clipx, int clipy, int clipw, int cliph )\fC [virtual protected]\fR" +Reimplement this function if you are viewing a drawing area rather than a widget. +.PP +The function should draw the rectangle (\fIclipx\fR, \fIclipy\fR, \fIclipw\fR, \fIcliph\fR) of the contents using painter \fIp\fR. The clip rectangle is in the scrollview's coordinates. +.PP +For example: +.PP +.nf +.br + { +.br + // Fill a 40000 by 50000 rectangle at (100000,150000) +.br +.br + // Calculate the coordinates... +.br + int x1 = 100000, y1 = 150000; +.br + int x2 = x1+40000-1, y2 = y1+50000-1; +.br +.br + // Clip the coordinates so X/Windows will not have problems... +.br + if (x1 < clipx) x1=clipx; +.br + if (y1 < clipy) y1=clipy; +.br + if (x2 > clipx+clipw-1) x2=clipx+clipw-1; +.br + if (y2 > clipy+cliph-1) y2=clipy+cliph-1; +.br +.br + // Paint using the small coordinates... +.br + if ( x2 >= x1 && y2 >= y1 ) +.br + p->fillRect(x1, y1, x2-x1+1, y2-y1+1, red); +.br + } +.br +.fi +.PP +The clip rectangle and translation of the painter \fIp\fR is already set appropriately. +.PP +Example: qdir/qdir.cpp. +.PP +Reimplemented in QCanvasView and QTable. +.SH "void QScrollView::drawContentsOffset ( QPainter * p, int offsetx, int offsety, int clipx, int clipy, int clipw, int cliph )\fC [virtual protected]\fR" +For backward-compatibility only. It is easier to use drawContents(QPainter*,int,int,int,int). +.PP +The default implementation translates the painter appropriately and calls drawContents(QPainter*,int,int,int,int). See drawContents() for an explanation of the parameters \fIp\fR, \fIoffsetx\fR, \fIoffsety\fR, \fIclipx\fR, \fIclipy\fR, \fIclipw\fR and \fIcliph\fR. +.PP +Reimplemented in QListView. +.SH "void QScrollView::enableClipper ( bool y )" +When a large numbers of child widgets are in a scrollview, especially if they are close together, the scrolling performance can suffer greatly. If \fIy\fR is TRUE the scrollview will use an extra widget to group child widgets. +.PP +Note that you may only call enableClipper() prior to adding widgets. +.PP +For a full discussion, see this class's detailed description. +.PP +Example: scrollview/scrollview.cpp. +.SH "void QScrollView::ensureVisible ( int x, int y )\fC [slot]\fR" +Scrolls the content so that the point \fI(x, y)\fR is visible with at least 50-pixel margins (if possible, otherwise centered). +.SH "void QScrollView::ensureVisible ( int x, int y, int xmargin, int ymargin )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Scrolls the content so that the point \fI(x, y)\fR is visible with at least the \fIxmargin\fR and \fIymargin\fR margins (if possible, otherwise centered). +.SH "bool QScrollView::eventFilter ( QObject * obj, QEvent * e )\fC [virtual protected]\fR" +This event filter ensures the scroll bars are updated when a single contents widget is resized, shown, hidden or destroyed; it passes mouse events to the QScrollView. The event is in \fIe\fR and the object is in \fIobj\fR. +.PP +Reimplemented from QObject. +.PP +Reimplemented in QListView. +.SH "ScrollBarMode QScrollView::hScrollBarMode () const" +Returns the mode for the horizontal scroll bar. See the "hScrollBarMode" property for details. +.SH "bool QScrollView::hasStaticBackground () const" +Returns TRUE if QScrollView uses a static background; otherwise returns FALSE. +.PP +See also setStaticBackground(). +.SH "QScrollBar * QScrollView::horizontalScrollBar () const" +Returns the component horizontal scroll bar. It is made available to allow accelerators, autoscrolling, etc. +.PP +It should not be used for other purposes. +.PP +This function never returns 0. +.SH "void QScrollView::horizontalSliderPressed ()\fC [signal]\fR" +This signal is emitted whenever the user presses the horizontal slider. +.SH "void QScrollView::horizontalSliderReleased ()\fC [signal]\fR" +This signal is emitted whenever the user releases the horizontal slider. +.SH "bool QScrollView::isHorizontalSliderPressed ()" +Returns TRUE if horizontal slider is pressed by user; otherwise returns FALSE. +.SH "bool QScrollView::isVerticalSliderPressed ()" +Returns TRUE if vertical slider is pressed by user; otherwise returns FALSE. +.SH "int QScrollView::leftMargin () const\fC [protected]\fR" +Returns the left margin. +.PP +See also setMargins(). +.SH "void QScrollView::moveChild ( QWidget * child, int x, int y )\fC [virtual]\fR" +Repositions the \fIchild\fR widget to (\fIx\fR, \fIy\fR). This function is the same as addChild(). +.SH "void QScrollView::removeChild ( QWidget * child )" +Removes the \fIchild\fR widget from the scrolled area. Note that this happens automatically if the \fIchild\fR is deleted. +.SH "void QScrollView::repaintContents ( int x, int y, int w, int h, bool erase = TRUE )" +Calls repaint() on a rectangle defined by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, translated appropriately. If the rectangle is not visible, nothing is repainted. If \fIerase\fR is TRUE the background is cleared using the background color. +.PP +See also updateContents(). +.SH "void QScrollView::repaintContents ( const QRect & r, bool erase = TRUE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Repaints the contents of rectangle \fIr\fR. If \fIerase\fR is TRUE the background is cleared using the background color. +.SH "void QScrollView::repaintContents ( bool erase = TRUE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Repaints the contents. If \fIerase\fR is TRUE the background is cleared using the background color. +.SH "void QScrollView::resizeContents ( int w, int h )\fC [virtual slot]\fR" +Sets the size of the contents area to \fIw\fR pixels wide and \fIh\fR pixels high and updates the viewport accordingly. +.SH "ResizePolicy QScrollView::resizePolicy () const" +Returns the resize policy. See the "resizePolicy" property for details. +.SH "int QScrollView::rightMargin () const\fC [protected]\fR" +Returns the right margin. +.PP +See also setMargins(). +.SH "void QScrollView::scrollBy ( int dx, int dy )\fC [slot]\fR" +Scrolls the content by \fIdx\fR to the left and \fIdy\fR upwards. +.SH "void QScrollView::setContentsPos ( int x, int y )\fC [virtual slot]\fR" +Scrolls the content so that the point \fI(x, y)\fR is in the top-left corner. +.PP +Example: process/process.cpp. +.SH "void QScrollView::setCornerWidget ( QWidget * corner )\fC [virtual]\fR" +Sets the widget in the \fIcorner\fR between the two scroll bars. +.PP +You will probably also want to set at least one of the scroll bar modes to AlwaysOn. +.PP +Passing 0 shows no widget in the corner. +.PP +Any previous \fIcorner\fR widget is hidden. +.PP +You may call setCornerWidget() with the same widget at different times. +.PP +All widgets set here will be deleted by the QScrollView when it is destroyed unless you separately reparent the widget after setting some other corner widget (or 0). +.PP +Any \fInewly\fR set widget should have no current parent. +.PP +By default, no corner widget is present. +.PP +See also vScrollBarMode and hScrollBarMode. +.PP +Example: scrollview/scrollview.cpp. +.SH "void QScrollView::setDragAutoScroll ( bool b )\fC [virtual]\fR" +Sets whether autoscrolling in drag move events is enabled to \fIb\fR. See the "dragAutoScroll" property for details. +.SH "void QScrollView::setHBarGeometry ( QScrollBar & hbar, int x, int y, int w, int h )\fC [virtual protected]\fR" +Called when the horizontal scroll bar geometry changes. This is provided as a protected function so that subclasses can do interesting things such as providing extra buttons in some of the space normally used by the scroll bars. +.PP +The default implementation simply gives all the space to \fIhbar\fR. The new geometry is given by \fIx\fR, \fIy\fR, \fIw\fR and \fIh\fR. +.PP +See also setVBarGeometry(). +.SH "void QScrollView::setHScrollBarMode ( ScrollBarMode )\fC [virtual]\fR" +Sets the mode for the horizontal scroll bar. See the "hScrollBarMode" property for details. +.SH "void QScrollView::setMargins ( int left, int top, int right, int bottom )\fC [virtual protected]\fR" +Sets the margins around the scrolling area to \fIleft\fR, \fItop\fR, \fIright\fR and \fIbottom\fR. This is useful for applications such as spreadsheets with "locked" rows and columns. The marginal space is \fIinside\fR the frameRect() and is left blank; reimplement drawFrame() or put widgets in the unused area. +.PP +By default all margins are zero. +.PP +See also frameChanged(). +.SH "void QScrollView::setResizePolicy ( ResizePolicy )\fC [virtual]\fR" +Sets the resize policy. See the "resizePolicy" property for details. +.SH "void QScrollView::setStaticBackground ( bool y )" +Sets the scrollview to have a static background if \fIy\fR is TRUE, or a scrolling background if \fIy\fR is FALSE. By default, the background is scrolling. +.PP +Be aware that this mode is quite slow, as a full repaint of the visible area has to be triggered on every contents move. +.PP +See also hasStaticBackground(). +.SH "void QScrollView::setVBarGeometry ( QScrollBar & vbar, int x, int y, int w, int h )\fC [virtual protected]\fR" +Called when the vertical scroll bar geometry changes. This is provided as a protected function so that subclasses can do interesting things such as providing extra buttons in some of the space normally used by the scroll bars. +.PP +The default implementation simply gives all the space to \fIvbar\fR. The new geometry is given by \fIx\fR, \fIy\fR, \fIw\fR and \fIh\fR. +.PP +See also setHBarGeometry(). +.SH "void QScrollView::setVScrollBarMode ( ScrollBarMode )\fC [virtual]\fR" +Sets the mode for the vertical scroll bar. See the "vScrollBarMode" property for details. +.SH "void QScrollView::showChild ( QWidget * child, bool y = TRUE )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the visibility of \fIchild\fR. Equivalent to QWidget::show() or QWidget::hide(). +.SH "int QScrollView::topMargin () const\fC [protected]\fR" +Returns the top margin. +.PP +See also setMargins(). +.SH "void QScrollView::updateContents ( int x, int y, int w, int h )" +Calls update() on a rectangle defined by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, translated appropriately. If the rectangle is not visible, nothing is repainted. +.PP +See also repaintContents(). +.SH "void QScrollView::updateContents ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Updates the contents in rectangle \fIr\fR +.SH "void QScrollView::updateContents ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QScrollView::updateScrollBars ()\fC [slot]\fR" +Updates scroll bars: all possibilities are considered. You should never need to call this in your code. +.SH "ScrollBarMode QScrollView::vScrollBarMode () const" +Returns the mode for the vertical scroll bar. See the "vScrollBarMode" property for details. +.SH "QScrollBar * QScrollView::verticalScrollBar () const" +Returns the component vertical scroll bar. It is made available to allow accelerators, autoscrolling, etc. +.PP +It should not be used for other purposes. +.PP +This function never returns 0. +.SH "void QScrollView::verticalSliderPressed ()\fC [signal]\fR" +This signal is emitted whenever the user presses the vertical slider. +.SH "void QScrollView::verticalSliderReleased ()\fC [signal]\fR" +This signal is emitted whenever the user releases the vertical slider. +.SH "QWidget * QScrollView::viewport () const" +Returns the viewport widget of the scrollview. This is the widget containing the contents widget or which is the drawing area. +.PP +Examples: +.)l helpsystem/tooltip.cpp and scrollview/scrollview.cpp. +.SH "void QScrollView::viewportPaintEvent ( QPaintEvent * pe )\fC [virtual protected]\fR" +This is a low-level painting routine that draws the viewport contents. Reimplement this if drawContents() is too high-level (for example, if you don't want to open a QPainter on the viewport). The paint event is passed in \fIpe\fR. +.SH "void QScrollView::viewportResizeEvent ( QResizeEvent * )\fC [virtual protected]\fR" +To provide simple processing of events on the contents, this function receives all resize events sent to the viewport. +.PP +See also QWidget::resizeEvent(). +.PP +Example: chart/canvasview.cpp. +.SH "QSize QScrollView::viewportSize ( int x, int y ) const" +Returns the viewport size for size (\fIx\fR, \fIy\fR). +.PP +The viewport size depends on \fI(x, y)\fR (the size of the contents), the size of this widget and the modes of the horizontal and vertical scroll bars. +.PP +This function permits widgets that can trade vertical and horizontal space for each other to control scroll bar appearance better. For example, a word processor or web browser can control the width of the right margin accurately, whether or not there needs to be a vertical scroll bar. +.SH "void QScrollView::viewportToContents ( int vx, int vy, int & x, int & y ) const" +Translates a point (\fIvx\fR, \fIvy\fR) on the viewport() widget to a point (\fIx\fR, \fIy\fR) in the contents. +.SH "QPoint QScrollView::viewportToContents ( const QPoint & vp ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point on the viewport \fIvp\fR translated to a point in the contents. +.SH "int QScrollView::visibleHeight () const" +Returns the vertical amount of the content that is visible. See the "visibleHeight" property for details. +.SH "int QScrollView::visibleWidth () const" +Returns the horizontal amount of the content that is visible. See the "visibleWidth" property for details. +.SS "Property Documentation" +.SH "int contentsHeight" +This property holds the height of the contents area. +.PP +Get this property's value with contentsHeight(). +.SH "int contentsWidth" +This property holds the width of the contents area. +.PP +Get this property's value with contentsWidth(). +.SH "int contentsX" +This property holds the X coordinate of the contents that are at the left edge of the viewport. +.PP +Get this property's value with contentsX(). +.SH "int contentsY" +This property holds the Y coordinate of the contents that are at the top edge of the viewport. +.PP +Get this property's value with contentsY(). +.SH "bool dragAutoScroll" +This property holds whether autoscrolling in drag move events is enabled. +.PP +If this property is set to TRUE (the default), the QScrollView automatically scrolls the contents in drag move events if the user moves the cursor close to a border of the view. Of course this works only if the viewport accepts drops. Specifying FALSE disables this autoscroll feature. +.PP +\fBWarning:\fR Enabling this property might not be enough to effectively turn on autoscrolling. If you put a custom widget in the QScrollView, you might need to call QDragEvent::ignore() on the event in the dragEnterEvent() and dragMoveEvent() reimplementations. +.PP +Set this property's value with setDragAutoScroll() and get this property's value with dragAutoScroll(). +.SH "ScrollBarMode hScrollBarMode" +This property holds the mode for the horizontal scroll bar. +.PP +The default mode is QScrollView::Auto. +.PP +See also vScrollBarMode. +.PP +Set this property's value with setHScrollBarMode() and get this property's value with hScrollBarMode(). +.SH "ResizePolicy resizePolicy" +This property holds the resize policy. +.PP +The default is Default. +.PP +See also ResizePolicy. +.PP +Set this property's value with setResizePolicy() and get this property's value with resizePolicy(). +.SH "ScrollBarMode vScrollBarMode" +This property holds the mode for the vertical scroll bar. +.PP +The default mode is QScrollView::Auto. +.PP +See also hScrollBarMode. +.PP +Set this property's value with setVScrollBarMode() and get this property's value with vScrollBarMode(). +.SH "int visibleHeight" +This property holds the vertical amount of the content that is visible. +.PP +Get this property's value with visibleHeight(). +.SH "int visibleWidth" +This property holds the horizontal amount of the content that is visible. +.PP +Get this property's value with visibleWidth(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqscrollview.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqscrollview.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsemaphore.3qt b/doc/man/man3/tqsemaphore.3qt new file mode 100644 index 000000000..e7e2a5735 --- /dev/null +++ b/doc/man/man3/tqsemaphore.3qt @@ -0,0 +1,110 @@ +'\" t +.TH QSemaphore 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 +QSemaphore \- Robust integer semaphore +.SH SYNOPSIS +All the functions in this class are thread-safe when Qt is built with thread support.</p> +.PP +\fC#include <ntqsemaphore.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSemaphore\fR ( int maxcount )" +.br +.ti -1c +.BI "virtual \fB~QSemaphore\fR ()" +.br +.ti -1c +.BI "int \fBavailable\fR () const" +.br +.ti -1c +.BI "int \fBtotal\fR () const" +.br +.ti -1c +.BI "int \fBoperator++\fR ( int )" +.br +.ti -1c +.BI "int \fBoperator--\fR ( int )" +.br +.ti -1c +.BI "int \fBoperator+=\fR ( int n )" +.br +.ti -1c +.BI "int \fBoperator-=\fR ( int n )" +.br +.ti -1c +.BI "bool \fBtryAccess\fR ( int n )" +.br +.in -1c +.SH DESCRIPTION +The QSemaphore class provides a robust integer semaphore. +.PP +A QSemaphore can be used to serialize thread execution, in a similar way to a QMutex. A semaphore differs from a mutex, in that a semaphore can be accessed by more than one thread at a time. +.PP +For example, suppose we have an application that stores data in a large tree structure. The application creates 10 threads (commonly called a thread pool) to perform searches on the tree. When the application searches the tree for some piece of data, it uses one thread per base node to do the searching. A semaphore could be used to make sure that two threads don't try to search the same branch of the tree at the same time. +.PP +A non-computing example of a semaphore would be dining at a restuarant. A semaphore is initialized to have a maximum count equal to the number of chairs in the restuarant. As people arrive, they want a seat. As seats are filled, the semaphore is accessed, once per person. As people leave, the access is released, allowing more people to enter. If a party of 10 people want to be seated, but there are only 9 seats, those 10 people will wait, but a party of 4 people would be seated (taking the available seats to 5, making the party of 10 people wait longer). +.PP +When a semaphore is created it is given a number which is the maximum number of concurrent accesses it will permit. Accesses to the sempahore are gained using operator++() or operator+=(), and released with operator--() or operator-=(). The number of accesses allowed is retrieved with available(), and the total number with total(). Note that the incrementing functions will block if there aren't enough available accesses. Use tryAccess() if you want to acquire accesses without blocking. +.PP +See also Environment Classes and Threading. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSemaphore::QSemaphore ( int maxcount )" +Creates a new semaphore. The semaphore can be concurrently accessed at most \fImaxcount\fR times. +.SH "QSemaphore::~QSemaphore ()\fC [virtual]\fR" +Destroys the semaphore. +.PP +\fBWarning:\fR If you destroy a semaphore that has accesses in use the resultant behavior is undefined. +.SH "int QSemaphore::available () const" +Returns the number of accesses currently available to the semaphore. +.SH "int QSemaphore::operator++ ( int )" +Postfix ++ operator. +.PP +Try to get access to the semaphore. If available() == 0, this call will block until it can get access, i.e. until available() > 0. +.SH "int QSemaphore::operator+= ( int n )" +Try to get access to the semaphore. If available() < \fIn\fR, this call will block until it can get all the accesses it wants, i.e. until available() >= \fIn\fR. +.SH "int QSemaphore::operator-- ( int )" +Postfix -- operator. +.PP +Release access of the semaphore. This wakes all threads waiting for access to the semaphore. +.SH "int QSemaphore::operator-= ( int n )" +Release \fIn\fR accesses to the semaphore. +.SH "int QSemaphore::total () const" +Returns the total number of accesses to the semaphore. +.SH "bool QSemaphore::tryAccess ( int n )" +Try to get access to the semaphore. If available() < \fIn\fR, this +function will return FALSE immediately. If available() >= \fIn\fR, +this function will take \fIn\fR accesses and return TRUE. This +function does \fInot\fR block. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsemaphore.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsemaphore.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqserversocket.3qt b/doc/man/man3/tqserversocket.3qt new file mode 100644 index 000000000..50611e1cb --- /dev/null +++ b/doc/man/man3/tqserversocket.3qt @@ -0,0 +1,142 @@ +'\" t +.TH QServerSocket 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 +QServerSocket \- TCP-based server +.SH SYNOPSIS +\fC#include <ntqserversocket.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQServerSocket\fR ( TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQServerSocket\fR ( const QHostAddress & address, TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQServerSocket\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QServerSocket\fR ()" +.br +.ti -1c +.BI "bool \fBok\fR () const" +.br +.ti -1c +.BI "TQ_UINT16 \fBport\fR () const" +.br +.ti -1c +.BI "int \fBsocket\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSocket\fR ( int socket )" +.br +.ti -1c +.BI "QHostAddress \fBaddress\fR () const" +.br +.ti -1c +.BI "virtual void \fBnewConnection\fR ( int socket ) = 0" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "QSocketDevice * \fBsocketDevice\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QServerSocket class provides a TCP-based server. +.PP +This class is a convenience class for accepting incoming TCP connections. You can specify the port or have QServerSocket pick one, and listen on just one address or on all the machine's addresses. +.PP +Using the API is very simple: subclass QServerSocket, call the constructor of your choice, and implement newConnection() to handle new incoming connections. There is nothing more to do. +.PP +(Note that due to lack of support in the underlying APIs, QServerSocket cannot accept or reject connections conditionally.) +.PP +See also QSocket, QSocketDevice, QHostAddress, QSocketNotifier, and Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QServerSocket::QServerSocket ( TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" +Creates a server socket object, that will serve the given \fIport\fR on all the addresses of this host. If \fIport\fR is 0, QServerSocket will pick a suitable port in a system-dependent manner. Use \fIbacklog\fR to specify how many pending connections the server can have. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. +.PP +\fBWarning:\fR On Tru64 Unix systems a value of 0 for \fIbacklog\fR means that you don't accept any connections at all; you should specify a value larger than 0. +.SH "QServerSocket::QServerSocket ( const QHostAddress & address, TQ_UINT16 port, int backlog = 1, QObject * parent = 0, const char * name = 0 )" +Creates a server socket object, that will serve the given \fIport\fR only on the given \fIaddress\fR. Use \fIbacklog\fR to specify how many pending connections the server can have. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. +.PP +\fBWarning:\fR On Tru64 Unix systems a value of 0 for \fIbacklog\fR means that you don't accept any connections at all; you should specify a value larger than 0. +.SH "QServerSocket::QServerSocket ( QObject * parent = 0, const char * name = 0 )" +Construct an empty server socket. +.PP +This constructor, in combination with setSocket(), allows us to use the QServerSocket class as a wrapper for other socket types (e.g. Unix Domain Sockets under Unix). +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. +.PP +See also setSocket(). +.SH "QServerSocket::~QServerSocket ()\fC [virtual]\fR" +Destroys the socket. +.PP +This causes any backlogged connections (connections that have reached the host, but not yet been completely set up by calling QSocketDevice::accept()) to be severed. +.PP +Existing connections continue to exist; this only affects the acceptance of new connections. +.SH "QHostAddress QServerSocket::address () const" +Returns the address on which this object listens, or 0.0.0.0 if this object listens on more than one address. ok() must be TRUE before calling this function. +.PP +See also port() and QSocketDevice::address(). +.SH "void QServerSocket::newConnection ( int socket )\fC [pure virtual]\fR" +This pure virtual function is responsible for setting up a new incoming connection. \fIsocket\fR is the fd (file descriptor) for the newly accepted connection. +.SH "bool QServerSocket::ok () const" +Returns TRUE if the construction succeeded; otherwise returns FALSE. +.SH "TQ_UINT16 QServerSocket::port () const" +Returns the port number on which this server socket listens. This is always non-zero; if you specify 0 in the constructor, QServerSocket will pick a non-zero port itself. ok() must be TRUE before calling this function. +.PP +See also address() and QSocketDevice::port(). +.PP +Example: network/httpd/httpd.cpp. +.SH "void QServerSocket::setSocket ( int socket )\fC [virtual]\fR" +Sets the socket to use \fIsocket\fR. bind() and listen() should already have been called for \fIsocket\fR. +.PP +This allows us to use the QServerSocket class as a wrapper for other socket types (e.g. Unix Domain Sockets). +.SH "int QServerSocket::socket () const" +Returns the operating system socket. +.SH "QSocketDevice * QServerSocket::socketDevice ()\fC [protected]\fR" +Returns a pointer to the internal socket device. The returned pointer is 0 if there is no connection or pending connection. +.PP +There is normally no need to manipulate the socket device directly +since this class does all the necessary setup for most client or +server socket applications. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqserversocket.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqserversocket.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsessionmanager.3qt b/doc/man/man3/tqsessionmanager.3qt new file mode 100644 index 000000000..f7e2fa976 --- /dev/null +++ b/doc/man/man3/tqsessionmanager.3qt @@ -0,0 +1,314 @@ +'\" t +.TH QSessionManager 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 +QSessionManager \- Access to the session manager +.SH SYNOPSIS +\fC#include <ntqsessionmanager.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "QString \fBsessionId\fR () const" +.br +.ti -1c +.BI "QString \fBsessionKey\fR () const" +.br +.ti -1c +.BI "void * \fBhandle\fR () const" +.br +.ti -1c +.BI "bool \fBallowsInteraction\fR ()" +.br +.ti -1c +.BI "bool \fBallowsErrorInteraction\fR ()" +.br +.ti -1c +.BI "void \fBrelease\fR ()" +.br +.ti -1c +.BI "void \fBcancel\fR ()" +.br +.ti -1c +.BI "enum \fBRestartHint\fR { RestartIfRunning, RestartAnyway, RestartImmediately, RestartNever }" +.br +.ti -1c +.BI "void \fBsetRestartHint\fR ( RestartHint hint )" +.br +.ti -1c +.BI "RestartHint \fBrestartHint\fR () const" +.br +.ti -1c +.BI "void \fBsetRestartCommand\fR ( const QStringList & command )" +.br +.ti -1c +.BI "QStringList \fBrestartCommand\fR () const" +.br +.ti -1c +.BI "void \fBsetDiscardCommand\fR ( const QStringList & )" +.br +.ti -1c +.BI "QStringList \fBdiscardCommand\fR () const" +.br +.ti -1c +.BI "void \fBsetManagerProperty\fR ( const QString & name, const QString & value )" +.br +.ti -1c +.BI "void \fBsetManagerProperty\fR ( const QString & name, const QStringList & value )" +.br +.ti -1c +.BI "bool \fBisPhase2\fR () const" +.br +.ti -1c +.BI "void \fBrequestPhase2\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSessionManager class provides access to the session manager. +.PP +The session manager is responsible for session management, most importantly for interruption and resumption. A "session" is a kind of record of the state of the system, e.g. which applications were run at start up and which applications are currently running. The session manager is used to save the session, e.g. when the machine is shut down; and to restore a session, e.g. when the machine is started up. Use QSettings to save and restore an individual application's settings, e.g. window positions, recently used files, etc. +.PP +QSessionManager provides an interface between the application and the session manager so that the program can work well with the session manager. In Qt, session management requests for action are handled by the two virtual functions QApplication::commitData() and QApplication::saveState(). Both provide a reference to a session manager object as argument, to allow the application to communicate with the session manager. +.PP +During a session management action (i.e. within commitData() and saveState()), no user interaction is possible \fIunless\fR the application got explicit permission from the session manager. You ask for permission by calling allowsInteraction() or, if it's really urgent, allowsErrorInteraction(). Qt does not enforce this, but the session manager may. +.PP +You can try to abort the shutdown process by calling cancel(). The default commitData() function does this if some top-level window rejected its closeEvent(). +.PP +For sophisticated session managers provided on Unix/X11, QSessionManager offers further possibilites to fine-tune an application's session management behavior: setRestartCommand(), setDiscardCommand(), setRestartHint(), setProperty(), requestPhase2(). See the respective function descriptions for further details. +.PP +See also Main Window and Related Classes and Environment Classes. +.SS "Member Type Documentation" +.SH "QSessionManager::RestartHint" +This enum type defines the circumstances under which this application wants to be restarted by the session manager. The current values are +.TP +\fCQSessionManager::RestartIfRunning\fR - if the application is still running when the session is shut down, it wants to be restarted at the start of the next session. +.TP +\fCQSessionManager::RestartAnyway\fR - the application wants to be started at the start of the next session, no matter what. (This is useful for utilities that run just after startup and then quit.) +.TP +\fCQSessionManager::RestartImmediately\fR - the application wants to be started immediately whenever it is not running. +.TP +\fCQSessionManager::RestartNever\fR - the application does not want to be restarted automatically. +.PP +The default hint is RestartIfRunning. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "bool QSessionManager::allowsErrorInteraction ()" +This is similar to allowsInteraction(), but also tells the session manager that an error occurred. Session managers may give error interaction request higher priority, which means that it is more likely that an error interaction is permitted. However, you are still not guaranteed that the session manager will allow interaction. +.PP +See also allowsInteraction(), release(), and cancel(). +.SH "bool QSessionManager::allowsInteraction ()" +Asks the session manager for permission to interact with the user. Returns TRUE if interaction is permitted; otherwise returns FALSE. +.PP +The rationale behind this mechanism is to make it possible to synchronize user interaction during a shutdown. Advanced session managers may ask all applications simultaneously to commit their data, resulting in a much faster shutdown. +.PP +When the interaction is completed we strongly recommend releasing the user interaction semaphore with a call to release(). This way, other applications may get the chance to interact with the user while your application is still busy saving data. (The semaphore is implicitly released when the application exits.) +.PP +If the user decides to cancel the shutdown process during the interaction phase, you must tell the session manager that this has happened by calling cancel(). +.PP +Here's an example of how an application's QApplication::commitData() might be implemented: +.PP +.nf +.br +void MyApplication::commitData( QSessionManager& sm ) { +.br + if ( sm.allowsInteraction() ) { +.br + switch ( QMessageBox::warning( +.br + yourMainWindow, +.br + tr("Application Name"), +.br + tr("Save changes to document Foo?"), +.br + tr("&Yes"), +.br + tr("&No"), +.br + tr("Cancel"), +.br + 0, 2) ) { +.br + case 0: // yes +.br + sm.release(); +.br + // save document here; if saving fails, call sm.cancel() +.br + break; +.br + case 1: // continue without saving +.br + break; +.br + default: // cancel +.br + sm.cancel(); +.br + break; +.br + } +.br + } else { +.br + // we did not get permission to interact, then +.br + // do something reasonable instead. +.br + } +.br +} +.fi +.PP +If an error occurred within the application while saving its data, you may want to try allowsErrorInteraction() instead. +.PP +See also QApplication::commitData(), release(), and cancel(). +.SH "void QSessionManager::cancel ()" +Tells the session manager to cancel the shutdown process. Applications should not call this function without first asking the user. +.PP +See also allowsInteraction() and allowsErrorInteraction(). +.SH "QStringList QSessionManager::discardCommand () const" +Returns the currently set discard command. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = mySession.discardCommand(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also setDiscardCommand(), restartCommand(), and setRestartCommand(). +.SH "void * QSessionManager::handle () const" +X11 only: returns a handle to the current \fCSmcConnection\fR. +.SH "bool QSessionManager::isPhase2 () const" +Returns TRUE if the session manager is currently performing a second session management phase; otherwise returns FALSE. +.PP +See also requestPhase2(). +.SH "void QSessionManager::release ()" +Releases the session manager's interaction semaphore after an interaction phase. +.PP +See also allowsInteraction() and allowsErrorInteraction(). +.SH "void QSessionManager::requestPhase2 ()" +Requests a second session management phase for the application. The application may then return immediately from the QApplication::commitData() or QApplication::saveState() function, and they will be called again once most or all other applications have finished their session management. +.PP +The two phases are useful for applications such as the X11 window manager that need to store information about another application's windows and therefore have to wait until these applications have completed their respective session management tasks. +.PP +Note that if another application has requested a second phase it may get called before, simultaneously with, or after your application's second phase. +.PP +See also isPhase2(). +.SH "QStringList QSessionManager::restartCommand () const" +Returns the currently set restart command. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = mySession.restartCommand(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also setRestartCommand() and restartHint(). +.SH "RestartHint QSessionManager::restartHint () const" +Returns the application's current restart hint. The default is RestartIfRunning. +.PP +See also setRestartHint(). +.SH "QString QSessionManager::sessionId () const" +Returns the identifier of the current session. +.PP +If the application has been restored from an earlier session, this identifier is the same as it was in that earlier session. +.PP +See also sessionKey() and QApplication::sessionId(). +.SH "QString QSessionManager::sessionKey () const" +Returns the session key in the current session. +.PP +If the application has been restored from an earlier session, this key is the same as it was when the previous session ended. +.PP +The session key changes with every call of commitData() or saveState(). +.PP +See also sessionId() and QApplication::sessionKey(). +.SH "void QSessionManager::setDiscardCommand ( const QStringList & )" +See also discardCommand() and setRestartCommand(). +.SH "void QSessionManager::setManagerProperty ( const QString & name, const QStringList & value )" +Low-level write access to the application's identification and state record are kept in the session manager. +.PP +The property called \fIname\fR has its value set to the string list \fIvalue\fR. +.SH "void QSessionManager::setManagerProperty ( const QString & name, const QString & value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Low-level write access to the application's identification and state records are kept in the session manager. +.PP +The property called \fIname\fR has its value set to the string \fIvalue\fR. +.SH "void QSessionManager::setRestartCommand ( const QStringList & command )" +If the session manager is capable of restoring sessions it will execute \fIcommand\fR in order to restore the application. The command defaults to +.PP +.nf +.br + appname -session id +.br +.fi +.PP +The \fC-session\fR option is mandatory; otherwise QApplication cannot tell whether it has been restored or what the current session identifier is. See QApplication::isSessionRestored() and QApplication::sessionId() for details. +.PP +If your application is very simple, it may be possible to store the entire application state in additional command line options. This is usually a very bad idea because command lines are often limited to a few hundred bytes. Instead, use QSettings, or temporary files or a database for this purpose. By marking the data with the unique sessionId(), you will be able to restore the application in a future session. +.PP +See also restartCommand(), setDiscardCommand(), and setRestartHint(). +.SH "void QSessionManager::setRestartHint ( RestartHint hint )" +Sets the application's restart hint to \fIhint\fR. On application startup the hint is set to RestartIfRunning. +.PP +Note that these flags are only hints, a session manager may or may not respect them. +.PP +We recommend setting the restart hint in QApplication::saveState() because most session managers perform a checkpoint shortly after an application's startup. +.PP +See also restartHint(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsessionmanager.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsessionmanager.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsettings.3qt b/doc/man/man3/tqsettings.3qt new file mode 100644 index 000000000..40724b787 --- /dev/null +++ b/doc/man/man3/tqsettings.3qt @@ -0,0 +1,654 @@ +'\" t +.TH QSettings 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 +QSettings \- Persistent platform-independent application settings +.SH SYNOPSIS +\fC#include <ntqsettings.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBFormat\fR { Native = 0, Ini }" +.br +.ti -1c +.BI "enum \fBSystem\fR { Unix = 0, Windows, Mac }" +.br +.ti -1c +.BI "enum \fBScope\fR { User, Global }" +.br +.ti -1c +.BI "\fBQSettings\fR ()" +.br +.ti -1c +.BI "\fBQSettings\fR ( Format format )" +.br +.ti -1c +.BI "\fB~QSettings\fR ()" +.br +.ti -1c +.BI "bool \fBwriteEntry\fR ( const QString & key, bool value )" +.br +.ti -1c +.BI "bool \fBwriteEntry\fR ( const QString & key, double value )" +.br +.ti -1c +.BI "bool \fBwriteEntry\fR ( const QString & key, int value )" +.br +.ti -1c +.BI "bool \fBwriteEntry\fR ( const QString & key, const QString & value )" +.br +.ti -1c +.BI "bool \fBwriteEntry\fR ( const QString & key, const QStringList & value )" +.br +.ti -1c +.BI "bool writeEntry ( const QString & key, const QStringList & value, const QChar & separator ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QStringList \fBentryList\fR ( const QString & key ) const" +.br +.ti -1c +.BI "QStringList \fBsubkeyList\fR ( const QString & key ) const" +.br +.ti -1c +.BI "QStringList \fBreadListEntry\fR ( const QString & key, bool * ok = 0 ) const" +.br +.ti -1c +.BI "QStringList readListEntry ( const QString & key, const QChar & separator, bool * ok = 0 ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString \fBreadEntry\fR ( const QString & key, const QString & def = QString::null, bool * ok = 0 ) const" +.br +.ti -1c +.BI "int \fBreadNumEntry\fR ( const QString & key, int def = 0, bool * ok = 0 ) const" +.br +.ti -1c +.BI "double \fBreadDoubleEntry\fR ( const QString & key, double def = 0, bool * ok = 0 ) const" +.br +.ti -1c +.BI "bool \fBreadBoolEntry\fR ( const QString & key, bool def = FALSE, bool * ok = 0 ) const" +.br +.ti -1c +.BI "bool \fBremoveEntry\fR ( const QString & key )" +.br +.ti -1c +.BI "void \fBinsertSearchPath\fR ( System s, const QString & path )" +.br +.ti -1c +.BI "void \fBremoveSearchPath\fR ( System s, const QString & path )" +.br +.ti -1c +.BI "void \fBsetPath\fR ( const QString & domain, const QString & product, Scope scope = Global )" +.br +.ti -1c +.BI "void \fBbeginGroup\fR ( const QString & group )" +.br +.ti -1c +.BI "void \fBendGroup\fR ()" +.br +.ti -1c +.BI "void \fBresetGroup\fR ()" +.br +.ti -1c +.BI "QString \fBgroup\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QSettings class provides persistent platform-independent application settings. +.PP +On Unix systems, QSettings uses text files to store settings. On Windows systems, QSettings uses the system registry. On Mac OS X, QSettings uses the Carbon preferences API. +.PP +Each setting comprises an identifying key and the data associated with the key. A key is a unicode string which consists of \fItwo\fR or more subkeys. A subkey is a slash, '/', followed by one or more unicode characters (excluding slashes, newlines, carriage returns and equals, '=', signs). The associated data, called the entry or value, may be a boolean, an integer, a double, a string or a list of strings. Entry strings may contain any unicode characters. +.PP +If you want to save and restore the entire desktop's settings, i.e. which applications are running, use QSettings to save the settings for each individual application and QSessionManager to save the desktop's session. +.PP +Example settings: +.PP +.nf +.br + /MyCompany/MyApplication/background color +.br + /MyCompany/MyApplication/foreground color +.br + /MyCompany/MyApplication/geometry/x +.br + /MyCompany/MyApplication/geometry/y +.br + /MyCompany/MyApplication/geometry/width +.br + /MyCompany/MyApplication/geometry/height +.br + /MyCompany/MyApplication/recent files/1 +.br + /MyCompany/MyApplication/recent files/2 +.br + /MyCompany/MyApplication/recent files/3 +.br +.fi +Each line above is a complete key, made up of subkeys. +.PP +A typical usage pattern for reading settings at application startup: +.PP +.nf +.br + QSettings settings; +.br + settings.setPath( "MyCompany.com", "MyApplication" ); +.br +.br + QString bgColor = settings.readEntry( "/colors/background", "white" ); +.br + int width = settings.readNumEntry( "/geometry/width", 640 ); +.br + // ... +.br +.fi +.PP +A typical usage pattern for saving settings at application exit or 'save preferences': +.PP +.nf +.br + QSettings settings; +.br + settings.setPath( "MyCompany.com", "MyApplication" ); +.br +.br + settings.writeEntry( "/colors/background", bgColor ); +.br + settings.writeEntry( "/geometry/width", width ); +.br + // ... +.br +.fi +.PP +A key prefix can be prepended to all keys using beginGroup(). The application of the prefix is stopped using endGroup(). For example: +.PP +.nf +.br + QSettings settings; +.br +.br + settings.beginGroup( "/MainWindow" ); +.br + settings.beginGroup( "/Geometry" ); +.br + int x = settings.readEntry( "/x" ); +.br + // ... +.br + settings.endGroup(); +.br + settings.beginGroup( "/Toolbars" ); +.br + // ... +.br + settings.endGroup(); +.br + settings.endGroup(); +.br +.fi +.PP +You can get a list of entry-holding keys by calling entryList(), and a list of key-holding keys using subkeyList(). +.PP +.nf +.br + QStringList keys = settings.entryList( "/MyApplication" ); +.br + // keys contains 'background color' and 'foreground color'. +.br +.br + QStringList keys = settings.entryList( "/MyApplication/recent files" ); +.br + // keys contains '1', '2' and '3'. +.br +.br + QStringList subkeys = settings.subkeyList( "/MyApplication" ); +.br + // subkeys contains 'geometry' and 'recent files' +.br +.br + QStringList subkeys = settings.subkeyList( "/MyApplication/recent files" ); +.br + // subkeys is empty. +.br +.fi +.PP +Since settings for Windows are stored in the registry there are some size limitations as follows: +.TP +A subkey may not exceed 255 characters. +.TP +An entry's value may not exceed 16,300 characters. +.TP +All the values of a key (for example, all the 'recent files' subkeys values), may not exceed 65,535 characters. +.PP +These limitations are not enforced on Unix or Mac OS X. +.PP +\fBWarning:\fR Creating multiple, simultaneous instances of QSettings writing to a text file may lead to data loss! This is a known issue which will be fixed in a future release of Qt. +.SH "Notes for Mac OS X Applications" +The location where settings are stored is not formally defined by the CFPreferences API. +.PP +At the time of writing settings are stored (either on a global or user basis, preferring locally) into a plist file in \fC$ROOT/System/Library/Preferences\fR (in XML format). QSettings will create an appropriate plist file (\fCcom.<first group name>.plist\fR) out of the full path to a key. +.PP +For further information on CFPreferences see Apple's Specifications +.SH "Notes for Unix Applications" +There is no universally accepted place for storing application settings under Unix. In the examples the settings file will be searched for in the following directories: <ol type=1> +.TP +\fCSYSCONF\fR - the default value is \fCINSTALL/etc/settings\fR +.TP +\fC/opt/MyCompany/share/etc\fR +.TP +\fC/opt/MyCompany/share/MyApplication/etc\fR +.TP +\fC$HOME/.qt\fR When reading settings the files are searched in the order shown above, with later settings overriding earlier settings. Files for which the user doesn't have read permission are ignored. When saving settings QSettings works in the order shown above, writing to the first settings file for which the user has write permission. (\fCINSTALL\fR is the directory where Qt was installed. This can be modified by using the configure script's -prefix argument ) +.PP +If you want to put the settings in a particular place in the filesystem you could do this: +.PP +.nf +.br + settings.insertSearchPath( QSettings::Unix, "/opt/MyCompany/share" ); +.br +.fi +.PP +But in practice you may prefer not to use a search path for Unix. For example the following code: +.PP +.nf +.br + settings.writeEntry( "/MyApplication/geometry/width", width ); +.br +.fi +will end up writing the "geometry/width" setting to the file \fC$HOME/.qt/myapplicationrc\fR (assuming that the application is being run by an ordinary user, i.e. not by root). +.PP +For cross-platform applications you should ensure that the Windows size limitations are not exceeded. +.PP +\fBWarning:\fR QSettings doesn't write the settings until it is destroyed so you should construct the QSettings object on the stack. +.PP +See also Input/Output and Networking and Miscellaneous Classes. +.SS "Member Type Documentation" +.SH "QSettings::Format" +.TP +\fCQSettings::Native\fR - Store the settings in a platform dependent location +.TP +\fCQSettings::Ini\fR - Store the settings in a text file +.SH "QSettings::Scope" +.TP +\fCQSettings::Global\fR - Save settings as global as possible +.TP +\fCQSettings::User\fR - Save settings in user space +.SH "QSettings::System" +.TP +\fCQSettings::Mac\fR - Macintosh execution environments +.TP +\fCQSettings::Unix\fR - Mac OS X, Unix, Linux and Unix-like execution environments +.TP +\fCQSettings::Windows\fR - Windows execution environments +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSettings::QSettings ()" +Creates a settings object. +.PP +Be aware that you must call setPath() or insertSearchPath() before you can use the QSettings object. +.SH "QSettings::QSettings ( Format format )" +Creates a settings object. If \fIformat\fR is 'Ini' the settings will be stored in a text file, using the Unix strategy (see above). If \fIformat\fR is 'Native', the settings will be stored in a platform specific way (ie. the Windows registry). +.PP +Be aware that you must call setPath() or insertSearchPath() before you can use the QSettings object. +.SH "QSettings::~QSettings ()" +Destroys the settings object. All modifications made to the settings will automatically be saved. +.SH "void QSettings::beginGroup ( const QString & group )" +Appends \fIgroup\fR to the current key prefix. +.PP +.nf +.br + QSettings settings; +.br + settings.beginGroup( "/MainWindow" ); +.br + // read values +.br + settings.endGroup(); +.br +.fi +.SH "void QSettings::endGroup ()" +Undo previous calls to beginGroup(). Note that a single beginGroup("a/b/c") is undone by a single call to endGroup(). +.PP +.nf +.br + QSettings settings; +.br + settings.beginGroup( "/MainWindow/Geometry" ); +.br + // read values +.br + settings.endGroup(); +.br +.fi +.SH "QStringList QSettings::entryList ( const QString & key ) const" +Returns a list of the keys which contain entries under \fIkey\fR. Does \fInot\fR return any keys that contain subkeys. +.PP +Example settings: +.PP +.nf +.br + /MyCompany/MyApplication/background color +.br + /MyCompany/MyApplication/foreground color +.br + /MyCompany/MyApplication/geometry/x +.br + /MyCompany/MyApplication/geometry/y +.br + /MyCompany/MyApplication/geometry/width +.br + /MyCompany/MyApplication/geometry/height +.br +.fi +.PP +.nf +.br + QStringList keys = settings.entryList( "/MyCompany/MyApplication" ); +.br +.fi +.PP +In the above example, \fCkeys\fR will contain 'background color' and 'foreground color'. It will not contain 'geometry' because this key contains subkeys not entries. +.PP +To access the geometry values, you could either use subkeyList() to read the keys then read each entry, or simply read each entry directly by specifying its full key, e.g." /MyCompany/MyApplication/geometry/y". +.PP +See also subkeyList(). +.SH "QString QSettings::group () const" +Returns the current key prefix, or a null string if there is no key prefix set. +.PP +See also beginGroup(). +.SH "void QSettings::insertSearchPath ( System s, const QString & path )" +Inserts \fIpath\fR into the settings search path. The semantics of \fIpath\fR depends on the system \fIs\fR. It is usually easier and better to use setPath() instead of this function. +.PP +When \fIs\fR is \fIWindows\fR and the execution environment is \fInot\fR Windows the function does nothing. Similarly when \fIs\fR is \fIUnix\fR and the execution environment is \fInot\fR Unix the function does nothing. +.PP +When \fIs\fR is \fIWindows\fR, and the execution environment is Windows, the search path list will be used as the first subfolder of the "Software" folder in the registry. +.PP +When reading settings the folders are searched forwards from the first folder (listed below) to the last, returning the first settings found, and ignoring any folders for which the user doesn't have read permission. <ol type=1> +.TP +HKEY_CURRENT_USER/Software/MyCompany/MyApplication +.TP +HKEY_LOCAL_MACHINE/Software/MyCompany/MyApplication +.TP +HKEY_CURRENT_USER/Software/MyApplication +.TP +HKEY_LOCAL_MACHINE/Software/MyApplication +.PP +.nf +.br + QSettings settings; +.br + settings.insertSearchPath( QSettings::Windows, "/MyCompany" ); +.br + settings.writeEntry( "/MyApplication/Tip of the day", TRUE ); +.br +.fi +The code above will write the subkey "Tip of the day" into the \fIfirst\fR of the registry folders listed below that is found and for which the user has write permission. <ol type=1> +.TP +HKEY_LOCAL_MACHINE/Software/MyCompany/MyApplication +.TP +HKEY_CURRENT_USER/Software/MyCompany/MyApplication +.TP +HKEY_LOCAL_MACHINE/Software/MyApplication +.TP +HKEY_CURRENT_USER/Software/MyApplication If a setting is found in the HKEY_CURRENT_USER space, this setting is overwritten independently of write permissions in the HKEY_LOCAL_MACHINE space. +.PP +When \fIs\fR is \fIUnix\fR, and the execution environment is Unix, the search path list will be used when trying to determine a suitable filename for reading and writing settings files. By default, there are two entries in the search path: +.PP +<ol type=1> +.TP +\fCSYSCONF\fR - where \fCSYSCONF\fR is a directory specified when configuring Qt; by default it is INSTALL/etc/settings. +.TP +\fC$HOME/.qt/\fR - where \fC$HOME\fR is the user's home directory. +.PP +All insertions into the search path will go before $HOME/.qt/. For example: +.PP +.nf +.br + QSettings settings; +.br + settings.insertSearchPath( QSettings::Unix, "/opt/MyCompany/share/etc" ); +.br + settings.insertSearchPath( QSettings::Unix, "/opt/MyCompany/share/MyApplication/etc" ); +.br + // ... +.br +.fi +Will result in a search path of: <ol type=1> +.TP +SYSCONF +.TP +/opt/MyCompany/share/etc +.TP +/opt/MyCompany/share/MyApplication/etc +.TP +$HOME/.qt When reading settings the files are searched in the order shown above, with later settings overriding earlier settings. Files for which the user doesn't have read permission are ignored. When saving settings QSettings works in the order shown above, writing to the first settings file for which the user has write permission. +.PP +Note that paths in the file system are not created by this function, so they must already exist to be useful. +.PP +Settings under Unix are stored in files whose names are based on the first subkey of the key (not including the search path). The algorithm for creating names is essentially: lowercase the first subkey, replace spaces with underscores and add 'rc', e.g. \fC/MyCompany/MyApplication/background color\fR will be stored in \fCmyapplicationrc\fR (assuming that \fC/MyCompany\fR is part of the search path). +.PP +See also removeSearchPath(). +.PP +Example: chart/chartform.cpp. +.SH "bool QSettings::readBoolEntry ( const QString & key, bool def = FALSE, bool * ok = 0 ) const" +Reads the entry specified by \fIkey\fR, and returns a bool, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +.PP +See also readEntry(), readNumEntry(), readDoubleEntry(), writeEntry(), and removeEntry(). +.SH "double QSettings::readDoubleEntry ( const QString & key, double def = 0, bool * ok = 0 ) const" +Reads the entry specified by \fIkey\fR, and returns a double, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +.PP +See also readEntry(), readNumEntry(), readBoolEntry(), writeEntry(), and removeEntry(). +.SH "QString QSettings::readEntry ( const QString & key, const QString & def = QString::null, bool * ok = 0 ) const" +Reads the entry specified by \fIkey\fR, and returns a QString, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +.PP +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). +.SH "QStringList QSettings::readListEntry ( const QString & key, bool * ok = 0 ) const" +Reads the entry specified by \fIkey\fR as a string. If \fIok\fR is not 0, \fI*ok\fR is set to TRUE if the key was read, otherwise \fI*ok\fR is set to FALSE. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = mySettings.readListEntry( "recentfiles" ); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). +.SH "QStringList QSettings::readListEntry ( const QString & key, const QChar & separator, bool * ok = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Reads the entry specified by \fIkey\fR as a string. The \fIseparator\fR is used to create a QStringList by calling QStringList::split(\fIseparator\fR, entry). If \fIok\fR is not 0: \fI*ok\fR is set to TRUE if the key was read, otherwise \fI*ok\fR is set to FALSE. +.PP +\fBWarning:\fR As the documentation states, QStringList::split() will omit empty strings from the list. Because of this, it is impossible to retrieve identical list data with this function. We recommend using the readListEntry() and writeEntry() overloads that do not take a \fIseparator\fR argument. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = mySettings.readListEntry( "size", " " ); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). +.SH "int QSettings::readNumEntry ( const QString & key, int def = 0, bool * ok = 0 ) const" +Reads the entry specified by \fIkey\fR, and returns an integer, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +.PP +See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). +.SH "bool QSettings::removeEntry ( const QString & key )" +Removes the entry specified by \fIkey\fR. +.PP +Returns true if the entry was successfully removed; otherwise returns false. Note that removing the last entry in any given folder, will also remove the folder. +.PP +See also readEntry() and writeEntry(). +.SH "void QSettings::removeSearchPath ( System s, const QString & path )" +Removes all occurrences of \fIpath\fR (using exact matching) from the settings search path for system \fIs\fR. Note that the default search paths cannot be removed. +.PP +See also insertSearchPath(). +.SH "void QSettings::resetGroup ()" +Set the current key prefix to the empty string. +.SH "void QSettings::setPath ( const QString & domain, const QString & product, Scope scope = Global )" +Insert platform-dependent paths from platform-independent information. +.PP +The \fIdomain\fR should be an Internet domain name controlled by the producer of the software, eg. Trolltech products use "trolltech.com". +.PP +The \fIproduct\fR should be the official name of the product. +.PP +The \fIscope\fR should be QSettings::User for user-specific settings, or QSettings::Global for system-wide settings (generally these will be read-only to many users). +.PP +Not all information is relevant on all systems. +.SH "QStringList QSettings::subkeyList ( const QString & key ) const" +Returns a list of the keys which contain subkeys under \fIkey\fR. Does \fInot\fR return any keys that contain entries. +.PP +Example settings: +.PP +.nf +.br + /MyCompany/MyApplication/background color +.br + /MyCompany/MyApplication/foreground color +.br + /MyCompany/MyApplication/geometry/x +.br + /MyCompany/MyApplication/geometry/y +.br + /MyCompany/MyApplication/geometry/width +.br + /MyCompany/MyApplication/geometry/height +.br + /MyCompany/MyApplication/recent files/1 +.br + /MyCompany/MyApplication/recent files/2 +.br + /MyCompany/MyApplication/recent files/3 +.br +.fi +.PP +.nf +.br + QStringList keys = settings.subkeyList( "/MyCompany/MyApplication" ); +.br +.fi +.PP +In the above example, \fCkeys\fR will contain 'geometry' and 'recent files'. It will not contain 'background color' or 'foreground color' because those keys contain entries not subkeys. To get a list of keys that contain entries rather than subkeys use entryList() instead. +.PP +\fBWarning:\fR In the above example, if QSettings is writing to an Ini file, then a call to +.PP +.nf +.br + subkeyList("/MyCompany") +.fi +will return an empty list. This happens because a key like +.PP +.nf +.br + /MyCompany/MyApplication/background color +.fi +is written to the file \fI"mycompanyrc"\fR, under the section \fI[MyApplication]\fR. This call is therefore a request to list the sections in an ini file, which is not supported in this version of QSettings. This is a known issue which will be fixed in Qt-4. +.PP +See also entryList(). +.SH "bool QSettings::writeEntry ( const QString & key, bool value )" +Writes the boolean entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. +.PP +If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +.PP +\fBWarning:\fR On certain platforms, keys are required to contain at least two components (e.g., "/foo/bar"). This limitation does not apply to Qt 4. +.PP +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). +.PP +Example: chart/chartform.cpp. +.SH "bool QSettings::writeEntry ( const QString & key, double value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes the double entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. +.PP +If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +.PP +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). +.SH "bool QSettings::writeEntry ( const QString & key, int value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes the integer entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. +.PP +If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +.PP +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). +.SH "bool QSettings::writeEntry ( const QString & key, const QString & value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes the string entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. If \fIvalue\fR is an empty string or a null string the key's value will be an empty string. +.PP +If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +.PP +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). +.SH "bool QSettings::writeEntry ( const QString & key, const QStringList & value )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes the string list entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. +.PP +If an error occurs the settings are left unchanged and FALSE is returned; otherwise returns TRUE. +.PP +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). +.SH "bool QSettings::writeEntry ( const QString & key, const QStringList & value, const QChar & separator )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Writes the string list entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. The list is stored as a sequence of strings separated by \fIseparator\fR (using QStringList::join()), so none of the strings in the list should contain the separator. If the list is empty or null the key's value will be an empty string. +.PP +\fBWarning:\fR The list should not contain empty or null strings, as readListEntry() will use QStringList::split() to recreate the list. As the documentation states, QStringList::split() will omit empty strings from the list. Because of this, it is impossible to retrieve identical list data that is stored with this function. We recommend using the writeEntry() and readListEntry() overloads that do not take a \fIseparator\fR argument. +.PP +If an error occurs the settings are left unchanged and FALSE is returned; otherwise returns TRUE. +.PP +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), removeEntry(), and QStringList::join(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsettings.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsettings.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsgistyle.3qt b/doc/man/man3/tqsgistyle.3qt new file mode 100644 index 000000000..7eb267538 --- /dev/null +++ b/doc/man/man3/tqsgistyle.3qt @@ -0,0 +1,64 @@ +'\" t +.TH QSGIStyle 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 +QSGIStyle \- SGI/Irix look and feel +.SH SYNOPSIS +\fC#include <ntqsgistyle.h>\fR +.PP +Inherits QMotifStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSGIStyle\fR ( bool useHighlightCols = FALSE )" +.br +.ti -1c +.BI "virtual \fB~QSGIStyle\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSGIStyle class provides SGI/Irix look and feel. +.PP +This class implements the SGI look and feel. It resembles the SGI/Irix Motif GUI style as closely as QStyle allows. +.PP +See also Widget Appearance and Style. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSGIStyle::QSGIStyle ( bool useHighlightCols = FALSE )" +Constructs a QSGIStyle. +.PP +If \fIuseHighlightCols\fR is FALSE (default value), the style will polish the application's color palette to emulate the Motif way of highlighting, which is a simple inversion between the base and the text color. +.PP +See also QMotifStyle::useHighlightColors(). +.SH "QSGIStyle::~QSGIStyle ()\fC [virtual]\fR" +Destroys the style. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsgistyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsgistyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqshowevent.3qt b/doc/man/man3/tqshowevent.3qt new file mode 100644 index 000000000..779509dc8 --- /dev/null +++ b/doc/man/man3/tqshowevent.3qt @@ -0,0 +1,55 @@ +'\" t +.TH QShowEvent 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 +QShowEvent \- Event which is sent when a widget is shown +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQShowEvent\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QShowEvent class provides an event which is sent when a widget is shown. +.PP +There are two kinds of show events: show events caused by the window system (spontaneous) and internal show events. Spontaneous show events are sent just after the window system shows the window, including after a top-level window has been shown (un-iconified) by the user. Internal show events are delivered just before the widget becomes visible. +.PP +See also QHideEvent and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QShowEvent::QShowEvent ()" +Constructs a QShowEvent. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qshowevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqshowevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsignal.3qt b/doc/man/man3/tqsignal.3qt new file mode 100644 index 000000000..b8142965f --- /dev/null +++ b/doc/man/man3/tqsignal.3qt @@ -0,0 +1,197 @@ +'\" t +.TH QSignal 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 +QSignal \- Can be used to send signals for classes that don't inherit QObject +.SH SYNOPSIS +\fC#include <ntqsignal.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSignal\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSignal\fR ()" +.br +.ti -1c +.BI "bool \fBconnect\fR ( const QObject * receiver, const char * member )" +.br +.ti -1c +.BI "bool \fBdisconnect\fR ( const QObject * receiver, const char * member = 0 )" +.br +.ti -1c +.BI "void \fBactivate\fR ()" +.br +.ti -1c +.BI "bool isBlocked () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void block ( bool b ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setParameter ( int value ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int parameter () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetValue\fR ( const QVariant & value )" +.br +.ti -1c +.BI "QVariant \fBvalue\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QSignal class can be used to send signals for classes that don't inherit QObject. +.PP +If you want to send signals from a class that does not inherit QObject, you can create an internal QSignal object to emit the signal. You must also provide a function that connects the signal to an outside object slot. This is how we have implemented signals in the QMenuData class, which is not a QObject. +.PP +In general, we recommend inheriting QObject instead. QObject provides much more functionality. +.PP +You can set a single QVariant parameter for the signal with setValue(). +.PP +Note that QObject is a \fIprivate\fR base class of QSignal, i.e. you cannot call any QObject member functions from a QSignal object. +.PP +Example: +.PP +.nf +.br + #include <ntqsignal.h> +.br +.br + class MyClass +.br + { +.br + public: +.br + MyClass(); +.br + ~MyClass(); +.br +.br + void doSomething(); +.br +.br + void connect( QObject *receiver, const char *member ); +.br +.br + private: +.br + QSignal *sig; +.br + }; +.br +.br + MyClass::MyClass() +.br + { +.br + sig = new QSignal; +.br + } +.br +.br + MyClass::~MyClass() +.br + { +.br + delete sig; +.br + } +.br +.br + void MyClass::doSomething() +.br + { +.br + // ... does something +.br + sig->activate(); // emits the signal +.br + } +.br +.br + void MyClass::connect( QObject *receiver, const char *member ) +.br + { +.br + sig->connect( receiver, member ); +.br + } +.br +.fi +.PP +See also Input/Output and Networking and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSignal::QSignal ( QObject * parent = 0, const char * name = 0 )" +Constructs a signal object called \fIname\fR, with the parent object \fIparent\fR. These arguments are passed directly to QObject. +.SH "QSignal::~QSignal ()" +Destroys the signal. All connections are removed, as is the case with all QObjects. +.SH "void QSignal::activate ()" +Emits the signal. If the platform supports QVariant and a parameter has been set with setValue(), this value is passed in the signal. +.SH "void QSignal::block ( bool b )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Blocks the signal if \fIb\fR is TRUE, or unblocks the signal if \fIb\fR is FALSE. +.PP +An activated signal disappears into hyperspace if it is blocked. +.PP +See also isBlocked(), activate(), and QObject::blockSignals(). +.SH "bool QSignal::connect ( const QObject * receiver, const char * member )" +Connects the signal to \fImember\fR in object \fIreceiver\fR. +.PP +See also disconnect() and QObject::connect(). +.SH "bool QSignal::disconnect ( const QObject * receiver, const char * member = 0 )" +Disonnects the signal from \fImember\fR in object \fIreceiver\fR. +.PP +See also connect() and QObject::disconnect(). +.SH "bool QSignal::isBlocked () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if the signal is blocked, or FALSE if it is not blocked. +.PP +The signal is not blocked by default. +.PP +See also block() and QObject::signalsBlocked(). +.SH "int QSignal::parameter () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QSignal::setParameter ( int value )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QSignal::setValue ( const QVariant & value )" +Sets the signal's parameter to \fIvalue\fR +.SH "QVariant QSignal::value () const" +Returns the signal's parameter + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsignal.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsignal.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsignalmapper.3qt b/doc/man/man3/tqsignalmapper.3qt new file mode 100644 index 000000000..3d4183fae --- /dev/null +++ b/doc/man/man3/tqsignalmapper.3qt @@ -0,0 +1,118 @@ +'\" t +.TH QSignalMapper 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 +QSignalMapper \- Bundles signals from identifiable senders +.SH SYNOPSIS +\fC#include <ntqsignalmapper.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSignalMapper\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSignalMapper\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetMapping\fR ( const QObject * sender, int identifier )" +.br +.ti -1c +.BI "virtual void \fBsetMapping\fR ( const QObject * sender, const QString & identifier )" +.br +.ti -1c +.BI "void \fBremoveMappings\fR ( const QObject * sender )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBmap\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBmapped\fR ( int )" +.br +.ti -1c +.BI "void \fBmapped\fR ( const QString & )" +.br +.in -1c +.SH DESCRIPTION +The QSignalMapper class bundles signals from identifiable senders. +.PP +This class collects a set of parameterless signals, and re-emits them with integer or string parameters corresponding to the object that sent the signal. +.PP +See also Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSignalMapper::QSignalMapper ( QObject * parent, const char * name = 0 )" +Constructs a QSignalMapper called \fIname\fR, with parent \fIparent\fR. Like all QObjects, it will be deleted when the parent is deleted. +.SH "QSignalMapper::~QSignalMapper ()" +Destroys the QSignalMapper. +.SH "void QSignalMapper::map ()\fC [slot]\fR" +This slot emits signals based on which object sends signals to it. +.PP +Examples: +.)l i18n/main.cpp and themes/themes.cpp. +.SH "void QSignalMapper::mapped ( int )\fC [signal]\fR" +This signal is emitted when map() is signaled from an object that has an integer mapping set. +.PP +See also setMapping(). +.PP +Examples: +.)l i18n/main.cpp and themes/themes.cpp. +.SH "void QSignalMapper::mapped ( const QString & )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when map() is signaled from an object that has a string mapping set. +.PP +See also setMapping(). +.SH "void QSignalMapper::removeMappings ( const QObject * sender )" +Removes all mappings for \fIsender\fR. This is done automatically when mapped objects are destroyed. +.SH "void QSignalMapper::setMapping ( const QObject * sender, int identifier )\fC [virtual]\fR" +Adds a mapping so that when map() is signaled from the given \fIsender\fR, the signal mapped(\fIidentifier\fR) is emitted. +.PP +There may be at most one integer identifier for each object. +.PP +Examples: +.)l i18n/main.cpp and themes/themes.cpp. +.SH "void QSignalMapper::setMapping ( const QObject * sender, const QString & identifier )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a mapping so that when map() is signaled from the given \fIsender\fR, the signal mapper(\fIidentifier\fR) is emitted. +.PP +There may be at most one string identifier for each object, and it +may not be empty. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsignalmapper.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsignalmapper.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsimplerichtext.3qt b/doc/man/man3/tqsimplerichtext.3qt new file mode 100644 index 000000000..cd5d3bc64 --- /dev/null +++ b/doc/man/man3/tqsimplerichtext.3qt @@ -0,0 +1,182 @@ +'\" t +.TH QSimpleRichText 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 +QSimpleRichText \- Small displayable piece of rich text +.SH SYNOPSIS +\fC#include <ntqsimplerichtext.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSimpleRichText\fR ( const QString & text, const QFont & fnt, const QString & context = QString::null, const QStyleSheet * sheet = 0 )" +.br +.ti -1c +.BI "\fBQSimpleRichText\fR ( const QString & text, const QFont & fnt, const QString & context, const QStyleSheet * sheet, const QMimeSourceFactory * factory, int pageBreak = -1, const QColor & linkColor = Qt::blue, bool linkUnderline = TRUE )" +.br +.ti -1c +.BI "\fB~QSimpleRichText\fR ()" +.br +.ti -1c +.BI "void \fBsetWidth\fR ( int w )" +.br +.ti -1c +.BI "void \fBsetWidth\fR ( QPainter * p, int w )" +.br +.ti -1c +.BI "void \fBsetDefaultFont\fR ( const QFont & f )" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBwidthUsed\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "void \fBadjustSize\fR ()" +.br +.ti -1c +.BI "void \fBdraw\fR ( QPainter * p, int x, int y, const QRect & clipRect, const QColorGroup & cg, const QBrush * paper = 0 ) const" +.br +.ti -1c +.BI "void draw ( QPainter * p, int x, int y, const QRegion & clipRegion, const QColorGroup & cg, const QBrush * paper = 0 ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString \fBcontext\fR () const" +.br +.ti -1c +.BI "QString \fBanchorAt\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "bool \fBinText\fR ( const QPoint & pos ) const" +.br +.in -1c +.SH DESCRIPTION +The QSimpleRichText class provides a small displayable piece of rich text. +.PP +This class encapsulates simple rich text usage in which a string is interpreted as rich text and can be drawn. This is particularly useful if you want to display some rich text in a custom widget. A QStyleSheet is needed to interpret the tags and format the rich text. Qt provides a default HTML-like style sheet, but you may define custom style sheets. +.PP +Once created, the rich text object can be queried for its width(), height(), and the actual width used (see widthUsed()). Most importantly, it can be drawn on any given QPainter with draw(). QSimpleRichText can also be used to implement hypertext or active text facilities by using anchorAt(). A hit test through inText() makes it possible to use simple rich text for text objects in editable drawing canvases. +.PP +Once constructed from a string the contents cannot be changed, only resized. If the contents change, just throw the rich text object away and make a new one with the new contents. +.PP +For large documents use QTextEdit or QTextBrowser. For very small items of rich text you can use a QLabel. +.PP +If you are using QSimpleRichText to print in high resolution you should call setWidth(QPainter, int) so that the content will be laid out properly on the page. +.PP +See also Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSimpleRichText::QSimpleRichText ( const QString & text, const QFont & fnt, const QString & context = QString::null, const QStyleSheet * sheet = 0 )" +Constructs a QSimpleRichText from the rich text string \fItext\fR and the font \fIfnt\fR. +.PP +The font is used as a basis for the text rendering. When using rich text rendering on a widget \fIw\fR, you would normally specify the widget's font, for example: +.PP +.nf +.br + QSimpleRichText myrichtext( contents, mywidget->font() ); +.br +.fi +.PP +\fIcontext\fR is the optional context of the rich text object. This becomes important if \fItext\fR contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see QMimeSourceFactory::defaultFactory()) to resolve those references. The context will then be used to calculate the absolute path. See QMimeSourceFactory::makeAbsolute() for details. +.PP +The \fIsheet\fR is an optional style sheet. If it is 0, the default style sheet will be used (see QStyleSheet::defaultSheet()). +.SH "QSimpleRichText::QSimpleRichText ( const QString & text, const QFont & fnt, const QString & context, const QStyleSheet * sheet, const QMimeSourceFactory * factory, int pageBreak = -1, const QColor & linkColor = Qt::blue, bool linkUnderline = TRUE )" +Constructs a QSimpleRichText from the rich text string \fItext\fR and the font \fIfnt\fR. +.PP +This is a slightly more complex constructor for QSimpleRichText that takes an additional mime source factory \fIfactory\fR, a page break parameter \fIpageBreak\fR and a bool \fIlinkUnderline\fR. \fIlinkColor\fR is only provided for compatibility, but has no effect, as QColorGroup's QColorGroup::link() color is used now. +.PP +\fIcontext\fR is the optional context of the rich text object. This becomes important if \fItext\fR contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see QMimeSourceFactory::defaultFactory()) to resolve those references. The context will then be used to calculate the absolute path. See QMimeSourceFactory::makeAbsolute() for details. +.PP +The \fIsheet\fR is an optional style sheet. If it is 0, the default style sheet will be used (see QStyleSheet::defaultSheet()). +.PP +This constructor is useful for creating a QSimpleRichText object suitable for printing. Set \fIpageBreak\fR to be the height of the contents area of the pages. +.SH "QSimpleRichText::~QSimpleRichText ()" +Destroys the rich text object, freeing memory. +.SH "void QSimpleRichText::adjustSize ()" +Adjusts the richt text object to a reasonable size. +.PP +See also setWidth(). +.SH "QString QSimpleRichText::anchorAt ( const QPoint & pos ) const" +Returns the anchor at the requested position, \fIpos\fR. An empty string is returned if no anchor is specified for this position. +.SH "QString QSimpleRichText::context () const" +Returns the context of the rich text object. If no context has been specified in the constructor, a null string is returned. The context is the path to use to look up relative links, such as image tags and anchor references. +.SH "void QSimpleRichText::draw ( QPainter * p, int x, int y, const QRect & clipRect, const QColorGroup & cg, const QBrush * paper = 0 ) const" +Draws the formatted text with painter \fIp\fR, at position (\fIx\fR, \fIy\fR), clipped to \fIclipRect\fR. The clipping rectangle is given in the rich text object's coordinates translated by (\fIx\fR, \fIy\fR). Passing an null rectangle results in no clipping. Colors from the color group \fIcg\fR are used as needed, and if not 0, \fI*paper\fR is used as the background brush. +.PP +Note that the display code is highly optimized to reduce flicker, so passing a brush for \fIpaper\fR is preferable to simply clearing the area to be painted and then calling this without a brush. +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "void QSimpleRichText::draw ( QPainter * p, int x, int y, const QRegion & clipRegion, const QColorGroup & cg, const QBrush * paper = 0 ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use the version with clipRect instead. The region version has problems with larger documents on some platforms (on X11 regions internally are represented with 16bit coordinates). +.SH "int QSimpleRichText::height () const" +Returns the height of the rich text object in pixels. +.PP +See also setWidth(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "bool QSimpleRichText::inText ( const QPoint & pos ) const" +Returns TRUE if \fIpos\fR is within a text line of the rich text object; otherwise returns FALSE. +.SH "void QSimpleRichText::setDefaultFont ( const QFont & f )" +Sets the default font for the rich text object to \fIf\fR +.SH "void QSimpleRichText::setWidth ( QPainter * p, int w )" +Sets the width of the rich text object to \fIw\fR pixels, recalculating the layout as if it were to be drawn with painter \fIp\fR. +.PP +Passing a painter is useful when you intend drawing on devices other than the screen, for example a QPrinter. +.PP +See also height() and adjustSize(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "void QSimpleRichText::setWidth ( int w )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the width of the rich text object to \fIw\fR pixels. +.PP +See also height() and adjustSize(). +.SH "int QSimpleRichText::width () const" +Returns the set width of the rich text object in pixels. +.PP +See also widthUsed(). +.SH "int QSimpleRichText::widthUsed () const" +Returns the width in pixels that is actually used by the rich text object. This can be smaller or wider than the set width. +.PP +It may be wider, for example, if the text contains images or non-breakable words that are already wider than the available space. It's smaller when the object only consists of lines that do not fill the width completely. +.PP +See also width(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsimplerichtext.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsimplerichtext.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsize.3qt b/doc/man/man3/tqsize.3qt new file mode 100644 index 000000000..fc2cc4dd3 --- /dev/null +++ b/doc/man/man3/tqsize.3qt @@ -0,0 +1,370 @@ +'\" t +.TH QSize 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 +QSize \- Defines the size of a two-dimensional object +.SH SYNOPSIS +\fC#include <ntqsize.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBScaleMode\fR { ScaleFree, ScaleMin, ScaleMax }" +.br +.ti -1c +.BI "\fBQSize\fR ()" +.br +.ti -1c +.BI "\fBQSize\fR ( int w, int h )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "void \fBsetWidth\fR ( int w )" +.br +.ti -1c +.BI "void \fBsetHeight\fR ( int h )" +.br +.ti -1c +.BI "void \fBtranspose\fR ()" +.br +.ti -1c +.BI "void \fBscale\fR ( int w, int h, ScaleMode mode )" +.br +.ti -1c +.BI "void \fBscale\fR ( const QSize & s, ScaleMode mode )" +.br +.ti -1c +.BI "QSize \fBexpandedTo\fR ( const QSize & otherSize ) const" +.br +.ti -1c +.BI "QSize \fBboundedTo\fR ( const QSize & otherSize ) const" +.br +.ti -1c +.BI "QCOORD & \fBrwidth\fR ()" +.br +.ti -1c +.BI "QCOORD & \fBrheight\fR ()" +.br +.ti -1c +.BI "QSize & \fBoperator+=\fR ( const QSize & s )" +.br +.ti -1c +.BI "QSize & \fBoperator-=\fR ( const QSize & s )" +.br +.ti -1c +.BI "QSize & \fBoperator*=\fR ( int c )" +.br +.ti -1c +.BI "QSize & \fBoperator*=\fR ( double c )" +.br +.ti -1c +.BI "QSize & \fBoperator/=\fR ( int c )" +.br +.ti -1c +.BI "QSize & \fBoperator/=\fR ( double c )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "bool \fBoperator==\fR ( const QSize & s1, const QSize & s2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QSize & s1, const QSize & s2 )" +.br +.ti -1c +.BI "const QSize \fBoperator+\fR ( const QSize & s1, const QSize & s2 )" +.br +.ti -1c +.BI "const QSize \fBoperator-\fR ( const QSize & s1, const QSize & s2 )" +.br +.ti -1c +.BI "const QSize \fBoperator*\fR ( const QSize & s, int c )" +.br +.ti -1c +.BI "const QSize \fBoperator*\fR ( int c, const QSize & s )" +.br +.ti -1c +.BI "const QSize \fBoperator*\fR ( const QSize & s, double c )" +.br +.ti -1c +.BI "const QSize \fBoperator*\fR ( double c, const QSize & s )" +.br +.ti -1c +.BI "const QSize \fBoperator/\fR ( const QSize & s, int c )" +.br +.ti -1c +.BI "const QSize \fBoperator/\fR ( const QSize & s, double c )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QSize & sz )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QSize & sz )" +.br +.in -1c +.SH DESCRIPTION +The QSize class defines the size of a two-dimensional object. +.PP +A size is specified by a width and a height. +.PP +The coordinate type is QCOORD (defined in \fC<ntqwindowdefs.h>\fR as \fCint\fR). The minimum value of QCOORD is QCOORD_MIN (-2147483648) and the maximum value is QCOORD_MAX (2147483647). +.PP +The size can be set in the constructor and changed with setWidth() and setHeight(), or using operator+=(), operator-=(), operator*=() and operator/=(), etc. You can swap the width and height with transpose(). You can get a size which holds the maximum height and width of two sizes using expandedTo(), and the minimum height and width of two sizes using boundedTo(). +.PP +See also QPoint, QRect, Graphics Classes, and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QSize::ScaleMode" +This enum type defines the different ways of scaling a size. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.TP +\fCQSize::ScaleFree\fR - The size is scaled freely. The ratio is not preserved. +.TP +\fCQSize::ScaleMin\fR - The size is scaled to a rectangle as large as possible inside a given rectangle, preserving the aspect ratio. +.TP +\fCQSize::ScaleMax\fR - The size is scaled to a rectangle as small as possible outside a given rectangle, preserving the aspect ratio. +.PP +See also QSize::scale(), QImage::scale(), and QImage::smoothScale(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSize::QSize ()" +Constructs a size with invalid (negative) width and height. +.SH "QSize::QSize ( int w, int h )" +Constructs a size with width \fIw\fR and height \fIh\fR. +.SH "QSize QSize::boundedTo ( const QSize & otherSize ) const" +Returns a size with the minimum width and height of this size and \fIotherSize\fR. +.SH "QSize QSize::expandedTo ( const QSize & otherSize ) const" +Returns a size with the maximum width and height of this size and \fIotherSize\fR. +.PP +Examples: +.)l customlayout/card.cpp and customlayout/flow.cpp. +.SH "int QSize::height () const" +Returns the height. +.PP +See also width(). +.PP +Examples: +.)l movies/main.cpp, qfd/fontdisplayer.cpp, and qfd/qfd.cpp. +.SH "bool QSize::isEmpty () const" +Returns TRUE if the width is less than or equal to 0, or the height is less than or equal to 0; otherwise returns FALSE. +.SH "bool QSize::isNull () const" +Returns TRUE if the width is 0 and the height is 0; otherwise returns FALSE. +.SH "bool QSize::isValid () const" +Returns TRUE if the width is equal to or greater than 0 and the height is equal to or greater than 0; otherwise returns FALSE. +.SH "QSize & QSize::operator*= ( int c )" +Multiplies both the width and height by \fIc\fR and returns a reference to the size. +.SH "QSize & QSize::operator*= ( double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Multiplies both the width and height by \fIc\fR and returns a reference to the size. +.PP +Note that the result is truncated. +.SH "QSize & QSize::operator+= ( const QSize & s )" +Adds \fIs\fR to the size and returns a reference to this size. +.PP +Example: +.PP +.nf +.br + QSize s( 3, 7 ); +.br + QSize r( -1, 4 ); +.br + s += r; // s becomes (2,11) +.fi +.SH "QSize & QSize::operator-= ( const QSize & s )" +Subtracts \fIs\fR from the size and returns a reference to this size. +.PP +Example: +.PP +.nf +.br + QSize s( 3, 7 ); +.br + QSize r( -1, 4 ); +.br + s -= r; // s becomes (4,3) +.br +.fi +.SH "QSize & QSize::operator/= ( int c )" +Divides both the width and height by \fIc\fR and returns a reference to the size. +.SH "QSize & QSize::operator/= ( double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Divides both the width and height by \fIc\fR and returns a reference to the size. +.PP +Note that the result is truncated. +.SH "QCOORD & QSize::rheight ()" +Returns a reference to the height. +.PP +Using a reference makes it possible to directly manipulate the height. +.PP +Example: +.PP +.nf +.br + QSize s( 100, 10 ); +.br + s.rheight() += 5; // s becomes (100,15) +.br +.fi +.PP +See also rwidth(). +.SH "QCOORD & QSize::rwidth ()" +Returns a reference to the width. +.PP +Using a reference makes it possible to directly manipulate the width. +.PP +Example: +.PP +.nf +.br + QSize s( 100, 10 ); +.br + s.rwidth() += 20; // s becomes (120,10) +.br +.fi +.PP +See also rheight(). +.SH "void QSize::scale ( int w, int h, ScaleMode mode )" +Scales the size to a rectangle of width \fIw\fR and height \fIh\fR according to the ScaleMode \fImode\fR. +.TP +If \fImode\fR is ScaleFree, the size is set to (\fIw\fR, \fIh\fR). +.TP +If \fImode\fR is ScaleMin, the current size is scaled to a rectangle as large as possible inside (\fIw\fR, \fIh\fR), preserving the aspect ratio. +.TP +If \fImode\fR is ScaleMax, the current size is scaled to a rectangle as small as possible outside (\fIw\fR, \fIh\fR), preserving the aspect ratio. +.PP +Example: +.PP +.nf +.br + QSize t1( 10, 12 ); +.br + t1.scale( 60, 60, QSize::ScaleFree ); +.br + // t1 is (60, 60) +.br +.br + QSize t2( 10, 12 ); +.br + t2.scale( 60, 60, QSize::ScaleMin ); +.br + // t2 is (50, 60) +.br +.br + QSize t3( 10, 12 ); +.br + t3.scale( 60, 60, QSize::ScaleMax ); +.br + // t3 is (60, 72) +.br +.fi +.SH "void QSize::scale ( const QSize & s, ScaleMode mode )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Equivalent to scale(\fIs\fR.width(), \fIs\fR.height(), \fImode\fR). +.SH "void QSize::setHeight ( int h )" +Sets the height to \fIh\fR. +.PP +See also height() and setWidth(). +.SH "void QSize::setWidth ( int w )" +Sets the width to \fIw\fR. +.PP +See also width() and setHeight(). +.SH "void QSize::transpose ()" +Swaps the values of width and height. +.SH "int QSize::width () const" +Returns the width. +.PP +See also height(). +.PP +Examples: +.)l movies/main.cpp, qfd/fontdisplayer.cpp, and qfd/qfd.cpp. +.SH RELATED FUNCTION DOCUMENTATION +.SH "bool operator!= ( const QSize & s1, const QSize & s2 )" +Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. +.SH "const QSize operator* ( const QSize & s, int c )" +Multiplies \fIs\fR by \fIc\fR and returns the result. +.SH "const QSize operator* ( int c, const QSize & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Multiplies \fIs\fR by \fIc\fR and returns the result. +.SH "const QSize operator* ( const QSize & s, double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Multiplies \fIs\fR by \fIc\fR and returns the result. +.SH "const QSize operator* ( double c, const QSize & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Multiplies \fIs\fR by \fIc\fR and returns the result. +.SH "const QSize operator+ ( const QSize & s1, const QSize & s2 )" +Returns the sum of \fIs1\fR and \fIs2\fR; each component is added separately. +.SH "const QSize operator- ( const QSize & s1, const QSize & s2 )" +Returns \fIs2\fR subtracted from \fIs1\fR; each component is subtracted separately. +.SH "const QSize operator/ ( const QSize & s, int c )" +Divides \fIs\fR by \fIc\fR and returns the result. +.SH "const QSize operator/ ( const QSize & s, double c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Divides \fIs\fR by \fIc\fR and returns the result. +.PP +Note that the result is truncated. +.SH "QDataStream & operator<< ( QDataStream & s, const QSize & sz )" +Writes the size \fIsz\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "bool operator== ( const QSize & s1, const QSize & s2 )" +Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. +.SH "QDataStream & operator>> ( QDataStream & s, QSize & sz )" +Reads the size from the stream \fIs\fR into size \fIsz\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsize.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsize.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsizegrip.3qt b/doc/man/man3/tqsizegrip.3qt new file mode 100644 index 000000000..69c79e4ba --- /dev/null +++ b/doc/man/man3/tqsizegrip.3qt @@ -0,0 +1,100 @@ +'\" t +.TH QSizeGrip 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 +QSizeGrip \- Corner-grip for resizing a top-level window +.SH SYNOPSIS +\fC#include <ntqsizegrip.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSizeGrip\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSizeGrip\fR ()" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * e )" +.br +.ti -1c +.BI "virtual void \fBmousePressEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBmouseMoveEvent\fR ( QMouseEvent * e )" +.br +.in -1c +.SH DESCRIPTION +The QSizeGrip class provides a corner-grip for resizing a top-level window. +.PP +This widget works like the standard Windows resize handle. In the X11 version this resize handle generally works differently from the one provided by the system; we hope to reduce this difference in the future. +.PP +Put this widget anywhere in a widget tree and the user can use it to resize the top-level window. Generally, this should be in the lower right-hand corner. Note that QStatusBar already uses this widget, so if you have a status bar (e.g. you are using QMainWindow), then you don't need to use this widget explicitly. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QStatusBar, Widget Appearance and Style, Main Window and Related Classes, and Basic Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSizeGrip::QSizeGrip ( QWidget * parent, const char * name = 0 )" +Constructs a resize corner called \fIname\fR, as a child widget of \fIparent\fR. +.SH "QSizeGrip::~QSizeGrip ()" +Destroys the size grip. +.SH "void QSizeGrip::mouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +Resizes the top-level widget containing this widget. The event is in \fIe\fR. +.PP +Reimplemented from QWidget. +.SH "void QSizeGrip::mousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +Primes the resize operation. The event is in \fIe\fR. +.PP +Reimplemented from QWidget. +.SH "void QSizeGrip::paintEvent ( QPaintEvent * e )\fC [virtual protected]\fR" +Paints the resize grip. Resize grips are usually rendered as small diagonal textured lines in the lower-right corner. The event is in \fIe\fR. +.PP +Reimplemented from QWidget. +.SH "QSize QSizeGrip::sizeHint () const\fC [virtual]\fR" +Returns the size grip's size hint; this is a small size. +.PP +Reimplemented from QWidget. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsizegrip.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsizegrip.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsizepolicy.3qt b/doc/man/man3/tqsizepolicy.3qt new file mode 100644 index 000000000..bacabf06c --- /dev/null +++ b/doc/man/man3/tqsizepolicy.3qt @@ -0,0 +1,238 @@ +'\" t +.TH QSizePolicy 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 +QSizePolicy \- Layout attribute describing horizontal and vertical resizing policy +.SH SYNOPSIS +\fC#include <ntqsizepolicy.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBSizeType\fR { Fixed = 0, Minimum = MayGrow, Maximum = MayShrink, Preferred = MayGrow | MayShrink, MinimumExpanding = MayGrow | ExpMask, Expanding = MayGrow | MayShrink | ExpMask, Ignored = ExpMask }" +.br +.ti -1c +.BI "enum \fBExpandData\fR { NoDirection = 0, Horizontally = 1, Vertically = 2, Horizontal = Horizontally, Vertical = Vertically, BothDirections = Horizontally | Vertically }" +.br +.ti -1c +.BI "\fBQSizePolicy\fR ()" +.br +.ti -1c +.BI "\fBQSizePolicy\fR ( SizeType hor, SizeType ver, bool hfw = FALSE )" +.br +.ti -1c +.BI "\fBQSizePolicy\fR ( SizeType hor, SizeType ver, uchar horStretch, uchar verStretch, bool hfw = FALSE )" +.br +.ti -1c +.BI "SizeType \fBhorData\fR () const" +.br +.ti -1c +.BI "SizeType \fBverData\fR () const" +.br +.ti -1c +.BI "bool \fBmayShrinkHorizontally\fR () const" +.br +.ti -1c +.BI "bool \fBmayShrinkVertically\fR () const" +.br +.ti -1c +.BI "bool \fBmayGrowHorizontally\fR () const" +.br +.ti -1c +.BI "bool \fBmayGrowVertically\fR () const" +.br +.ti -1c +.BI "ExpandData \fBexpanding\fR () const" +.br +.ti -1c +.BI "void \fBsetHorData\fR ( SizeType d )" +.br +.ti -1c +.BI "void \fBsetVerData\fR ( SizeType d )" +.br +.ti -1c +.BI "void \fBsetHeightForWidth\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBhasHeightForWidth\fR () const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QSizePolicy & s ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QSizePolicy & s ) const" +.br +.ti -1c +.BI "uint \fBhorStretch\fR () const" +.br +.ti -1c +.BI "uint \fBverStretch\fR () const" +.br +.ti -1c +.BI "void \fBsetHorStretch\fR ( uchar sf )" +.br +.ti -1c +.BI "void \fBsetVerStretch\fR ( uchar sf )" +.br +.ti -1c +.BI "void \fBtranspose\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSizePolicy class is a layout attribute describing horizontal and vertical resizing policy. +.PP +The size policy of a widget is an expression of its willingness to be resized in various ways. +.PP +Widgets that reimplement QWidget::sizePolicy() return a QSizePolicy that describes the horizontal and vertical resizing policy they prefer when being laid out. Only one of the constructors is of interest in most applications. +.PP +QSizePolicy contains two independent SizeType objects; one describes the widgets's horizontal size policy, and the other describes its vertical size policy. It also contains a flag to indicate whether the height and width of its preferred size are related. +.PP +The horizontal and vertical SizeTypes are set in the usual constructor and can be queried using a variety of functions. +.PP +The hasHeightForWidth() flag indicates whether the widget's sizeHint() is width-dependent (such as a word-wrapping label) or not. +.PP +See also QSizePolicy::SizeType, Widget Appearance and Style, and Layout Management. +.SS "Member Type Documentation" +.SH "QSizePolicy::ExpandData" +This enum type describes in which directions a widget can make use of extra space. There are four possible values: +.TP +\fCQSizePolicy::NoDirection\fR - the widget cannot make use of extra space in any direction. +.TP +\fCQSizePolicy::Horizontally\fR - the widget can usefully be wider than the sizeHint(). +.TP +\fCQSizePolicy::Vertically\fR - the widget can usefully be taller than the sizeHint(). +.TP +\fCQSizePolicy::BothDirections\fR - the widget can usefully be both wider and taller than the sizeHint(). +.SH "QSizePolicy::SizeType" +The per-dimension sizing types used when constructing a QSizePolicy are: +.TP +\fCQSizePolicy::Fixed\fR - The QWidget::sizeHint() is the only acceptable alternative, so the widget can never grow or shrink (e.g. the vertical direction of a push button). +.TP +\fCQSizePolicy::Minimum\fR - The sizeHint() is minimal, and sufficient. The widget can be expanded, but there is no advantage to it being larger (e.g. the horizontal direction of a push button). It cannot be smaller than the size provided by sizeHint(). +.TP +\fCQSizePolicy::Maximum\fR - The sizeHint() is a maximum. The widget can be shrunk any amount without detriment if other widgets need the space (e.g. a separator line). It cannot be larger than the size provided by sizeHint(). +.TP +\fCQSizePolicy::Preferred\fR - The sizeHint() is best, but the widget can be shrunk and still be useful. The widget can be expanded, but there is no advantage to it being larger than sizeHint() (the default QWidget policy). +.TP +\fCQSizePolicy::Expanding\fR - The sizeHint() is a sensible size, but the widget can be shrunk and still be useful. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a slider). +.TP +\fCQSizePolicy::MinimumExpanding\fR - The sizeHint() is minimal, and sufficient. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a slider). +.TP +\fCQSizePolicy::Ignored\fR - the sizeHint() is ignored. The widget will get as much space as possible. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSizePolicy::QSizePolicy ()" +Constructs a minimally initialized QSizePolicy. +.SH "QSizePolicy::QSizePolicy ( SizeType hor, SizeType ver, bool hfw = FALSE )" +This is the constructor normally used to return a value in the overridden QWidget::sizePolicy() function of a QWidget subclass. +.PP +It constructs a QSizePolicy with independent horizontal and vertical sizing types, \fIhor\fR and \fIver\fR respectively. These sizing types affect how the widget is treated by the layout engine. +.PP +If \fIhfw\fR is TRUE, the preferred height of the widget is dependent on the width of the widget (for example, a QLabel with line wrapping). +.PP +See also horData(), verData(), and hasHeightForWidth(). +.SH "QSizePolicy::QSizePolicy ( SizeType hor, SizeType ver, uchar horStretch, uchar verStretch, bool hfw = FALSE )" +Constructs a QSizePolicy with independent horizontal and vertical sizing types \fIhor\fR and \fIver\fR, and stretch factors \fIhorStretch\fR and \fIverStretch\fR. +.PP +If \fIhfw\fR is TRUE, the preferred height of the widget is dependent on the width of the widget. +.PP +See also horStretch() and verStretch(). +.SH "ExpandData QSizePolicy::expanding () const" +Returns whether this layout can make use of more space than sizeHint(). A value of Vertical or Horizontal means that it wants to grow in only one dimension, whereas BothDirections means that it wants to grow in both dimensions. +.PP +See also mayShrinkHorizontally(), mayGrowHorizontally(), mayShrinkVertically(), and mayGrowVertically(). +.SH "bool QSizePolicy::hasHeightForWidth () const" +Returns TRUE if the widget's preferred height depends on its width; otherwise returns FALSE. +.PP +See also setHeightForWidth(). +.SH "SizeType QSizePolicy::horData () const" +Returns the horizontal component of the size policy. +.PP +See also setHorData(), verData(), and horStretch(). +.SH "uint QSizePolicy::horStretch () const" +Returns the horizontal stretch factor of the size policy. +.PP +See also setHorStretch() and verStretch(). +.SH "bool QSizePolicy::mayGrowHorizontally () const" +Returns TRUE if the widget can sensibly be wider than its sizeHint(); otherwise returns FALSE. +.PP +See also mayGrowVertically() and mayShrinkHorizontally(). +.SH "bool QSizePolicy::mayGrowVertically () const" +Returns TRUE if the widget can sensibly be taller than its sizeHint(); otherwise returns FALSE. +.PP +See also mayGrowHorizontally() and mayShrinkVertically(). +.SH "bool QSizePolicy::mayShrinkHorizontally () const" +Returns TRUE if the widget can sensibly be narrower than its sizeHint(); otherwise returns FALSE. +.PP +See also mayShrinkVertically() and mayGrowHorizontally(). +.SH "bool QSizePolicy::mayShrinkVertically () const" +Returns TRUE if the widget can sensibly be shorter than its sizeHint(); otherwise returns FALSE. +.PP +See also mayShrinkHorizontally() and mayGrowVertically(). +.SH "bool QSizePolicy::operator!= ( const QSizePolicy & s ) const" +Returns TRUE if this policy is different from \fIs\fR; otherwise returns FALSE. +.PP +See also operator==(). +.SH "bool QSizePolicy::operator== ( const QSizePolicy & s ) const" +Returns TRUE if this policy is equal to \fIs\fR; otherwise returns FALSE. +.PP +See also operator!=(). +.SH "void QSizePolicy::setHeightForWidth ( bool b )" +Sets the hasHeightForWidth() flag to \fIb\fR. +.PP +See also hasHeightForWidth(). +.SH "void QSizePolicy::setHorData ( SizeType d )" +Sets the horizontal component of the size policy to size type \fId\fR. +.PP +See also horData() and setVerData(). +.SH "void QSizePolicy::setHorStretch ( uchar sf )" +Sets the horizontal stretch factor of the size policy to \fIsf\fR. +.PP +See also horStretch() and setVerStretch(). +.SH "void QSizePolicy::setVerData ( SizeType d )" +Sets the vertical component of the size policy to size type \fId\fR. +.PP +See also verData() and setHorData(). +.SH "void QSizePolicy::setVerStretch ( uchar sf )" +Sets the vertical stretch factor of the size policy to \fIsf\fR. +.PP +See also verStretch() and setHorStretch(). +.SH "void QSizePolicy::transpose ()" +Swaps the horizontal and vertical policies and stretches. +.SH "SizeType QSizePolicy::verData () const" +Returns the vertical component of the size policy. +.PP +See also setVerData(), horData(), and verStretch(). +.SH "uint QSizePolicy::verStretch () const" +Returns the vertical stretch factor of the size policy. +.PP +See also setVerStretch() and horStretch(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsizepolicy.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsizepolicy.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsjiscodec.3qt b/doc/man/man3/tqsjiscodec.3qt new file mode 100644 index 000000000..4cb97332a --- /dev/null +++ b/doc/man/man3/tqsjiscodec.3qt @@ -0,0 +1,83 @@ +'\" t +.TH QSjisCodec 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 +QSjisCodec \- Conversion to and from Shift-JIS +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqsjiscodec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual const char * \fBmimeName\fR () const" +.br +.ti -1c +.BI "\fBQSjisCodec\fR ()" +.br +.ti -1c +.BI "\fB~QSjisCodec\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSjisCodec class provides conversion to and from Shift-JIS. +.PP +More precisely, the QSjisCodec class subclasses QTextCodec to provide support for Shift-JIS, an encoding of JIS X 0201 Latin, JIS X 0201 Kana or JIS X 0208. +.PP +The environment variable \fCUNICODEMAP_JP\fR can be used to fine-tune QJisCodec, QSjisCodec and QEucJpCodec. The QJisCodec documentation describes how to use this variable. +.PP +Most of the code here was written by Serika Kurusugawa, a.k.a. Junji Takagi, and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for the code as it was at the point of contribution. Trolltech's subsequent modifications are covered by the usual copyright for Qt. +.PP +Copyright (C) 1999 Serika Kurusugawa. All rights reserved. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> +.IP 1 +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.IP 2 +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS". ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.PP +See also Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSjisCodec::QSjisCodec ()" +Creates a Shift-JIS codec. Note that this is done automatically by the QApplication, you do not need construct your own. +.SH "QSjisCodec::~QSjisCodec ()" +Destroys the Shift-JIS codec. +.SH "const char * QSjisCodec::mimeName () const\fC [virtual]\fR" +Returns the codec's mime name. +.PP +Reimplemented from QTextCodec. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsjiscodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsjiscodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqslider.3qt b/doc/man/man3/tqslider.3qt new file mode 100644 index 000000000..c37f05728 --- /dev/null +++ b/doc/man/man3/tqslider.3qt @@ -0,0 +1,390 @@ +'\" t +.TH QSlider 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 +QSlider \- Vertical or horizontal slider +.SH SYNOPSIS +\fC#include <ntqslider.h>\fR +.PP +Inherits QWidget and QRangeControl. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBTickSetting\fR { NoMarks = 0, Above = 1, Left = Above, Below = 2, Right = Below, Both = 3 }" +.br +.ti -1c +.BI "\fBQSlider\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQSlider\fR ( Orientation orientation, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQSlider\fR ( int minValue, int maxValue, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSlider\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetOrientation\fR ( Orientation )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTracking\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBtracking\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPalette\fR ( const QPalette & p )" +.br +.ti -1c +.BI "int \fBsliderStart\fR () const" +.br +.ti -1c +.BI "QRect \fBsliderRect\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTickmarks\fR ( TickSetting )" +.br +.ti -1c +.BI "TickSetting \fBtickmarks\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTickInterval\fR ( int )" +.br +.ti -1c +.BI "int \fBtickInterval\fR () const" +.br +.ti -1c +.BI "int \fBminValue\fR () const" +.br +.ti -1c +.BI "int \fBmaxValue\fR () const" +.br +.ti -1c +.BI "void \fBsetMinValue\fR ( int )" +.br +.ti -1c +.BI "void \fBsetMaxValue\fR ( int )" +.br +.ti -1c +.BI "int \fBlineStep\fR () const" +.br +.ti -1c +.BI "int \fBpageStep\fR () const" +.br +.ti -1c +.BI "void \fBsetLineStep\fR ( int )" +.br +.ti -1c +.BI "void \fBsetPageStep\fR ( int )" +.br +.ti -1c +.BI "int \fBvalue\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetValue\fR ( int )" +.br +.ti -1c +.BI "void \fBaddStep\fR ()" +.br +.ti -1c +.BI "void \fBsubtractStep\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBvalueChanged\fR ( int value )" +.br +.ti -1c +.BI "void \fBsliderPressed\fR ()" +.br +.ti -1c +.BI "void \fBsliderMoved\fR ( int value )" +.br +.ti -1c +.BI "void \fBsliderReleased\fR ()" +.br +.in -1c +.SS "Important Inherited Members" +.in +1c +.ti -1c +.BI "void \fBsetRange\fR ( int minValue, int maxValue )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBlineStep\fR - the current line step" +.br +.ti -1c +.BI "int \fBmaxValue\fR - the current maximum value of the slider" +.br +.ti -1c +.BI "int \fBminValue\fR - the current minimum value of the slider" +.br +.ti -1c +.BI "Orientation \fBorientation\fR - the slider's orientation" +.br +.ti -1c +.BI "int \fBpageStep\fR - the current page step" +.br +.ti -1c +.BI "int \fBtickInterval\fR - the interval between tickmarks" +.br +.ti -1c +.BI "TickSetting \fBtickmarks\fR - the tickmark settings for this slider" +.br +.ti -1c +.BI "bool \fBtracking\fR - whether slider tracking is enabled" +.br +.ti -1c +.BI "int \fBvalue\fR - the current slider value" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBvalueChange\fR ()" +.br +.ti -1c +.BI "virtual void \fBrangeChange\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSlider widget provides a vertical or horizontal slider. +.PP +The slider is the classic widget for controlling a bounded value. It lets the user move a slider along a horizontal or vertical groove and translates the slider's position into an integer value within the legal range. +.PP +QSlider inherits QRangeControl, which provides the "integer" side of the slider. setRange() and value() are likely to be used by practically all slider users; see the QRangeControl documentation for information about the many other functions that class provides. +.PP +The main functions offered by the slider itself are tickmark and orientation control; you can use setTickmarks() to indicate where you want the tickmarks to be, setTickInterval() to indicate how many of them you want and setOrientation() to indicate whether the slider is to be horizontal or vertical. +.PP +A slider accepts focus on Tab and uses the mouse wheel and a suitable keyboard interface. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QScrollBar, QSpinBox, GUI Design Handbook: Slider, and Basic Widgets. +.SS "Member Type Documentation" +.SH "QSlider::TickSetting" +This enum specifies where the tickmarks are to be drawn relative to the slider's groove and the handle the user moves. +.TP +\fCQSlider::NoMarks\fR - do not draw any tickmarks. +.TP +\fCQSlider::Both\fR - draw tickmarks on both sides of the groove. +.TP +\fCQSlider::Above\fR - draw tickmarks above the (horizontal) slider +.TP +\fCQSlider::Below\fR - draw tickmarks below the (horizontal) slider +.TP +\fCQSlider::Left\fR - draw tickmarks to the left of the (vertical) slider +.TP +\fCQSlider::Right\fR - draw tickmarks to the right of the (vertical) slider +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSlider::QSlider ( QWidget * parent, const char * name = 0 )" +Constructs a vertical slider. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.SH "QSlider::QSlider ( Orientation orientation, QWidget * parent, const char * name = 0 )" +Constructs a slider. +.PP +The \fIorientation\fR must be Qt::Vertical or Qt::Horizontal. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.SH "QSlider::QSlider ( int minValue, int maxValue, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )" +Constructs a slider whose value can never be smaller than \fIminValue\fR or greater than \fImaxValue\fR, whose page step size is \fIpageStep\fR and whose value is initially \fIvalue\fR (which is guaranteed to be in range using bound()). +.PP +If \fIorientation\fR is Qt::Vertical the slider is vertical and if it is Qt::Horizontal the slider is horizontal. +.PP +The \fIparent\fR and \fIname\fR arguments are sent on to the QWidget constructor. +.SH "QSlider::~QSlider ()" +Destructor. +.SH "void QSlider::addStep ()\fC [slot]\fR" +Moves the slider one pageStep() up or right. +.SH "int QSlider::lineStep () const" +Returns the current line step. See the "lineStep" property for details. +.SH "int QSlider::maxValue () const" +Returns the current maximum value of the slider. See the "maxValue" property for details. +.SH "int QSlider::minValue () const" +Returns the current minimum value of the slider. See the "minValue" property for details. +.SH "Orientation QSlider::orientation () const" +Returns the slider's orientation. See the "orientation" property for details. +.SH "int QSlider::pageStep () const" +Returns the current page step. See the "pageStep" property for details. +.SH "void QSlider::rangeChange ()\fC [virtual protected]\fR" +Implements the virtual QRangeControl function. +.PP +Reimplemented from QRangeControl. +.SH "void QSlider::setLineStep ( int )" +Sets the current line step. See the "lineStep" property for details. +.SH "void QSlider::setMaxValue ( int )" +Sets the current maximum value of the slider. See the "maxValue" property for details. +.SH "void QSlider::setMinValue ( int )" +Sets the current minimum value of the slider. See the "minValue" property for details. +.SH "void QSlider::setOrientation ( Orientation )\fC [virtual]\fR" +Sets the slider's orientation. See the "orientation" property for details. +.SH "void QSlider::setPageStep ( int )" +Sets the current page step. See the "pageStep" property for details. +.SH "void QSlider::setPalette ( const QPalette & p )\fC [virtual]\fR" +Reimplements the virtual function QWidget::setPalette(). +.PP +Sets the background color to the mid color for Motif style sliders using palette \fIp\fR. +.PP +Reimplemented from QWidget. +.SH "void QRangeControl::setRange ( int minValue, int maxValue )" +Sets the range control's minimum value to \fIminValue\fR and its maximum value to \fImaxValue\fR. +.PP +Calls the virtual rangeChange() function if one or both of the new minimum and maximum values are different from the previous setting. Calls the virtual valueChange() function if the current value is adjusted because it was outside the new range. +.PP +If \fImaxValue\fR is smaller than \fIminValue\fR, \fIminValue\fR becomes the only legal value. +.PP +See also minValue and maxValue. +.PP +Examples: +.)l listbox/listbox.cpp, t12/lcdrange.cpp, t5/main.cpp, t6/main.cpp, t8/lcdrange.cpp, and xform/xform.cpp. +.SH "void QSlider::setTickInterval ( int )\fC [virtual]\fR" +Sets the interval between tickmarks. See the "tickInterval" property for details. +.SH "void QSlider::setTickmarks ( TickSetting )\fC [virtual]\fR" +Sets the tickmark settings for this slider. See the "tickmarks" property for details. +.SH "void QSlider::setTracking ( bool enable )\fC [virtual]\fR" +Sets whether slider tracking is enabled to \fIenable\fR. See the "tracking" property for details. +.SH "void QSlider::setValue ( int )\fC [virtual slot]\fR" +Sets the current slider value. See the "value" property for details. +.SH "void QSlider::sliderMoved ( int value )\fC [signal]\fR" +This signal is emitted when the slider is dragged, with the new slider \fIvalue\fR as its argument. +.SH "void QSlider::sliderPressed ()\fC [signal]\fR" +This signal is emitted when the user presses the slider with the mouse. +.SH "QRect QSlider::sliderRect () const" +Returns the slider handle rectangle. (This is the visual marker that the user can move.) +.SH "void QSlider::sliderReleased ()\fC [signal]\fR" +This signal is emitted when the user releases the slider with the mouse. +.SH "int QSlider::sliderStart () const" +Returns the start position of the slider. +.SH "void QSlider::subtractStep ()\fC [slot]\fR" +Moves the slider one pageStep() down or left. +.SH "int QSlider::tickInterval () const" +Returns the interval between tickmarks. See the "tickInterval" property for details. +.SH "TickSetting QSlider::tickmarks () const" +Returns the tickmark settings for this slider. See the "tickmarks" property for details. +.SH "bool QSlider::tracking () const" +Returns TRUE if slider tracking is enabled; otherwise returns FALSE. See the "tracking" property for details. +.SH "int QSlider::value () const" +Returns the current slider value. See the "value" property for details. +.SH "void QSlider::valueChange ()\fC [virtual protected]\fR" +Implements the virtual QRangeControl function. +.PP +Reimplemented from QRangeControl. +.SH "void QSlider::valueChanged ( int value )\fC [signal]\fR" +This signal is emitted when the slider value is changed, with the new slider \fIvalue\fR as its argument. +.PP +Examples: +.)l rangecontrols/rangecontrols.cpp, simple/main.cpp, t12/lcdrange.cpp, t5/main.cpp, t6/main.cpp, t7/lcdrange.cpp, and xform/xform.cpp. +.SS "Property Documentation" +.SH "int lineStep" +This property holds the current line step. +.PP +When setting lineStep, the virtual stepChange() function will be called if the new line step is different from the previous setting. +.PP +See also setSteps(), QRangeControl::pageStep(), and setRange(). +.PP +Set this property's value with setLineStep() and get this property's value with lineStep(). +.SH "int maxValue" +This property holds the current maximum value of the slider. +.PP +When setting this property, the QSlider::minValue is adjusted, if necessary, to ensure that the range remains valid. +.PP +See also setRange(). +.PP +Set this property's value with setMaxValue() and get this property's value with maxValue(). +.SH "int minValue" +This property holds the current minimum value of the slider. +.PP +When setting this property, the QSlider::maxValue is adjusted, if necessary, to ensure that the range remains valid. +.PP +See also setRange(). +.PP +Set this property's value with setMinValue() and get this property's value with minValue(). +.SH "Orientation orientation" +This property holds the slider's orientation. +.PP +The orientation must be Qt::Vertical (the default) or Qt::Horizontal. +.PP +Set this property's value with setOrientation() and get this property's value with orientation(). +.SH "int pageStep" +This property holds the current page step. +.PP +When setting pageStep, the virtual stepChange() function will be called if the new page step is different from the previous setting. +.PP +See also QRangeControl::setSteps(), lineStep, and setRange(). +.PP +Set this property's value with setPageStep() and get this property's value with pageStep(). +.SH "int tickInterval" +This property holds the interval between tickmarks. +.PP +This is a value interval, not a pixel interval. If it is 0, the slider will choose between lineStep() and pageStep(). The initial value of tickInterval is 0. +.PP +See also QRangeControl::lineStep() and QRangeControl::pageStep(). +.PP +Set this property's value with setTickInterval() and get this property's value with tickInterval(). +.SH "TickSetting tickmarks" +This property holds the tickmark settings for this slider. +.PP +The valid values are in QSlider::TickSetting. The default is NoMarks. +.PP +See also tickInterval. +.PP +Set this property's value with setTickmarks() and get this property's value with tickmarks(). +.SH "bool tracking" +This property holds whether slider tracking is enabled. +.PP +If tracking is enabled (the default), the slider emits the valueChanged() signal whenever the slider is being dragged. If tracking is disabled, the slider emits the valueChanged() signal when the user releases the mouse button (unless the value happens to be the same as before). +.PP +Set this property's value with setTracking() and get this property's value with tracking(). +.SH "int value" +This property holds the current slider value. +.PP +Set this property's value with setValue() and get this property's value with value(). +.PP +See also QRangeControl::value() and prevValue(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqslider.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqslider.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsocket.3qt b/doc/man/man3/tqsocket.3qt new file mode 100644 index 000000000..b68a07e2a --- /dev/null +++ b/doc/man/man3/tqsocket.3qt @@ -0,0 +1,471 @@ +'\" t +.TH QSocket 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 +QSocket \- Buffered TCP connection +.SH SYNOPSIS +\fC#include <ntqsocket.h>\fR +.PP +Inherits QObject and QIODevice. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBError\fR { ErrConnectionRefused, ErrHostNotFound, ErrSocketRead }" +.br +.ti -1c +.BI "\fBQSocket\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QSocket\fR ()" +.br +.ti -1c +.BI "enum \fBState\fR { Idle, HostLookup, Connecting, Connected, Closing, Connection = Connected }" +.br +.ti -1c +.BI "State \fBstate\fR () const" +.br +.ti -1c +.BI "int \fBsocket\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSocket\fR ( int socket )" +.br +.ti -1c +.BI "QSocketDevice * \fBsocketDevice\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetSocketDevice\fR ( QSocketDevice * device )" +.br +.ti -1c +.BI "virtual void \fBconnectToHost\fR ( const QString & host, TQ_UINT16 port )" +.br +.ti -1c +.BI "QString \fBpeerName\fR () const" +.br +.ti -1c +.BI "virtual bool \fBopen\fR ( int m )" +.br +.ti -1c +.BI "virtual void \fBclose\fR ()" +.br +.ti -1c +.BI "virtual void \fBflush\fR ()" +.br +.ti -1c +.BI "virtual Offset \fBsize\fR () const" +.br +.ti -1c +.BI "virtual Offset \fBat\fR () const" +.br +.ti -1c +.BI "virtual bool \fBat\fR ( Offset index )" +.br +.ti -1c +.BI "virtual bool \fBatEnd\fR () const" +.br +.ti -1c +.BI "TQ_ULONG \fBbytesAvailable\fR () const" +.br +.ti -1c +.BI "TQ_ULONG \fBwaitForMore\fR ( int msecs, bool * timeout ) const" +.br +.ti -1c +.BI "TQ_ULONG \fBwaitForMore\fR ( int msecs ) const" +.br +.ti -1c +.BI "TQ_ULONG \fBbytesToWrite\fR () const" +.br +.ti -1c +.BI "void \fBclearPendingData\fR ()" +.br +.ti -1c +.BI "virtual TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" +.br +.ti -1c +.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len )" +.br +.ti -1c +.BI "virtual int \fBgetch\fR ()" +.br +.ti -1c +.BI "virtual int \fBputch\fR ( int ch )" +.br +.ti -1c +.BI "virtual int \fBungetch\fR ( int ch )" +.br +.ti -1c +.BI "bool \fBcanReadLine\fR () const" +.br +.ti -1c +.BI "virtual QString \fBreadLine\fR ()" +.br +.ti -1c +.BI "TQ_UINT16 \fBport\fR () const" +.br +.ti -1c +.BI "TQ_UINT16 \fBpeerPort\fR () const" +.br +.ti -1c +.BI "QHostAddress \fBaddress\fR () const" +.br +.ti -1c +.BI "QHostAddress \fBpeerAddress\fR () const" +.br +.ti -1c +.BI "void \fBsetReadBufferSize\fR ( TQ_ULONG bufSize )" +.br +.ti -1c +.BI "TQ_ULONG \fBreadBufferSize\fR () const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBhostFound\fR ()" +.br +.ti -1c +.BI "void \fBconnected\fR ()" +.br +.ti -1c +.BI "void \fBconnectionClosed\fR ()" +.br +.ti -1c +.BI "void \fBdelayedCloseFinished\fR ()" +.br +.ti -1c +.BI "void \fBreadyRead\fR ()" +.br +.ti -1c +.BI "void \fBbytesWritten\fR ( int nbytes )" +.br +.ti -1c +.BI "void \fBerror\fR ( int )" +.br +.in -1c +.SH DESCRIPTION +The QSocket class provides a buffered TCP connection. +.PP +It provides a totally non-blocking QIODevice, and modifies and extends the API of QIODevice with socket-specific code. +.PP +Note that a QApplication must have been constructed before this class can be used. +.PP +The functions you're likely to call most are connectToHost(), bytesAvailable(), canReadLine() and the ones it inherits from QIODevice. +.PP +connectToHost() is the most-used function. As its name implies, it opens a connection to a named host. +.PP +Most network protocols are either packet-oriented or line-oriented. canReadLine() indicates whether a connection contains an entire unread line or not, and bytesAvailable() returns the number of bytes available for reading. +.PP +The signals error(), connected(), readyRead() and connectionClosed() inform you of the progress of the connection. There are also some less commonly used signals. hostFound() is emitted when connectToHost() has finished its DNS lookup and is starting its TCP connection. delayedCloseFinished() is emitted when close() succeeds. bytesWritten() is emitted when QSocket moves data from its "to be written" queue into the TCP implementation. +.PP +There are several access functions for the socket: state() returns whether the object is idle, is doing a DNS lookup, is connecting, has an operational connection, etc. address() and port() return the IP address and port used for the connection. The peerAddress() and peerPort() functions return the IP address and port used by the peer, and peerName() returns the name of the peer (normally the name that was passed to connectToHost()). socketDevice() returns a pointer to the QSocketDevice used for this socket. +.PP +QSocket inherits QIODevice, and reimplements some functions. In general, you can treat it as a QIODevice for writing, and mostly also for reading. The match isn't perfect, since the QIODevice API is designed for devices that are controlled by the same machine, and an asynchronous peer-to-peer network connection isn't quite like that. For example, there is nothing that matches QIODevice::size() exactly. The documentation for open(), close(), flush(), size(), at(), atEnd(), readBlock(), writeBlock(), getch(), putch(), ungetch() and readLine() describes the differences in detail. +.PP +\fBWarning:\fR QSocket is not suitable for use in threads. If you need to uses sockets in threads use the lower-level QSocketDevice class. +.PP +\fBWarning:\fR Because Qt doesn't use the native socketstream implementation on Mac OS X, QSocket has an implicit transfer latency of 100ms. You can achieve lower latency on Mac OS X by using QSocketDevice instead. +.PP +See also QSocketDevice, QHostAddress, QSocketNotifier, and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QSocket::Error" +This enum specifies the possible errors: +.TP +\fCQSocket::ErrConnectionRefused\fR - if the connection was refused +.TP +\fCQSocket::ErrHostNotFound\fR - if the host was not found +.TP +\fCQSocket::ErrSocketRead\fR - if a read from the socket failed +.SH "QSocket::State" +This enum defines the connection states: +.TP +\fCQSocket::Idle\fR - if there is no connection +.TP +\fCQSocket::HostLookup\fR - during a DNS lookup +.TP +\fCQSocket::Connecting\fR - during TCP connection establishment +.TP +\fCQSocket::Connected\fR - when there is an operational connection +.TP +\fCQSocket::Closing\fR - if the socket is closing down, but is not yet closed. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSocket::QSocket ( QObject * parent = 0, const char * name = 0 )" +Creates a QSocket object in QSocket::Idle state. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QObject constructor. +.PP +Note that a QApplication must have been constructed before sockets can be used. +.SH "QSocket::~QSocket ()\fC [virtual]\fR" +Destroys the socket. Closes the connection if necessary. +.PP +See also close(). +.SH "QHostAddress QSocket::address () const" +Returns the host address of this socket. (This is normally the main IP address of the host, but can be e.g. 127.0.0.1 for connections to localhost.) +.SH "Offset QSocket::at () const\fC [virtual]\fR" +Returns the current read index. Since QSocket is a sequential device, the current read index is always zero. +.PP +Reimplemented from QIODevice. +.SH "bool QSocket::at ( Offset index )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Moves the read index forward to \fIindex\fR and returns TRUE if the operation was successful; otherwise returns FALSE. Moving the index forward means skipping incoming data. +.PP +Reimplemented from QIODevice. +.SH "bool QSocket::atEnd () const\fC [virtual]\fR" +Returns TRUE if there is no more data to read; otherwise returns FALSE. +.PP +Reimplemented from QIODevice. +.SH "TQ_ULONG QSocket::bytesAvailable () const" +Returns the number of incoming bytes that can be read, i.e. the size of the input buffer. Equivalent to size(). +.PP +This function can trigger the readyRead() signal, if more data has arrived on the socket. +.PP +See also bytesToWrite(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "TQ_ULONG QSocket::bytesToWrite () const" +Returns the number of bytes that are waiting to be written, i.e. the size of the output buffer. +.PP +See also bytesAvailable() and clearPendingData(). +.SH "void QSocket::bytesWritten ( int nbytes )\fC [signal]\fR" +This signal is emitted when data has been written to the network. The \fInbytes\fR parameter specifies how many bytes were written. +.PP +The bytesToWrite() function is often used in the same context; it indicates how many buffered bytes there are left to write. +.PP +See also writeBlock() and bytesToWrite(). +.SH "bool QSocket::canReadLine () const" +Returns TRUE if it's possible to read an entire line of text from this socket at this time; otherwise returns FALSE. +.PP +Note that if the peer closes the connection unexpectedly, this function returns FALSE. This means that loops such as this won't work: +.PP +.nf +.br + while( !socket->canReadLine() ) // WRONG +.br + ; +.br +.fi +.PP +See also readLine(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. +.SH "void QSocket::clearPendingData ()" +Deletes the data that is waiting to be written. This is useful if you want to close the socket without waiting for all the data to be written. +.PP +See also bytesToWrite(), close(), and delayedCloseFinished(). +.SH "void QSocket::close ()\fC [virtual]\fR" +Closes the socket. +.PP +The read buffer is cleared. +.PP +If the output buffer is empty, the state is set to QSocket::Idle and the connection is terminated immediately. If the output buffer still contains data to be written, QSocket goes into the QSocket::Closing state and the rest of the data will be written. When all of the outgoing data have been written, the state is set to QSocket::Idle and the connection is terminated. At this point, the delayedCloseFinished() signal is emitted. +.PP +If you don't want that the data of the output buffer is written, call clearPendingData() before you call close(). +.PP +See also state(), bytesToWrite(), and clearPendingData(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, and network/networkprotocol/nntp.cpp. +.PP +Reimplemented from QIODevice. +.SH "void QSocket::connectToHost ( const QString & host, TQ_UINT16 port )\fC [virtual]\fR" +Attempts to make a connection to \fIhost\fR on the specified \fIport\fR and return immediately. +.PP +Any connection or pending connection is closed immediately, and QSocket goes into the HostLookup state. When the lookup succeeds, it emits hostFound(), starts a TCP connection and goes into the Connecting state. Finally, when the connection succeeds, it emits connected() and goes into the Connected state. If there is an error at any point, it emits error(). +.PP +\fIhost\fR may be an IP address in string form, or it may be a DNS name. QSocket will do a normal DNS lookup if required. Note that \fIport\fR is in native byte order, unlike some other libraries. +.PP +See also state(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. +.SH "void QSocket::connected ()\fC [signal]\fR" +This signal is emitted after connectToHost() has been called and a connection has been successfully established. +.PP +See also connectToHost() and connectionClosed(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. +.SH "void QSocket::connectionClosed ()\fC [signal]\fR" +This signal is emitted when the other end has closed the connection. The read buffers may contain buffered input data which you can read after the connection was closed. +.PP +See also connectToHost() and close(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/clientserver/server/server.cpp, and network/networkprotocol/nntp.cpp. +.SH "void QSocket::delayedCloseFinished ()\fC [signal]\fR" +This signal is emitted when a delayed close is finished. +.PP +If you call close() and there is buffered output data to be written, QSocket goes into the QSocket::Closing state and returns immediately. It will then keep writing to the socket until all the data has been written. Then, the delayedCloseFinished() signal is emitted. +.PP +See also close(). +.PP +Examples: +.)l network/clientserver/client/client.cpp and network/httpd/httpd.cpp. +.SH "void QSocket::error ( int )\fC [signal]\fR" +This signal is emitted after an error occurred. The parameter is the Error value. +.PP +Examples: +.)l network/clientserver/client/client.cpp and network/networkprotocol/nntp.cpp. +.SH "void QSocket::flush ()\fC [virtual]\fR" +Implementation of the abstract virtual QIODevice::flush() function. +.PP +Reimplemented from QIODevice. +.SH "int QSocket::getch ()\fC [virtual]\fR" +Reads a single byte/character from the internal read buffer. Returns the byte/character read, or -1 if there is nothing to be read. +.PP +See also bytesAvailable() and putch(). +.PP +Reimplemented from QIODevice. +.SH "void QSocket::hostFound ()\fC [signal]\fR" +This signal is emitted after connectToHost() has been called and the host lookup has succeeded. +.PP +See also connected(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "bool QSocket::open ( int m )\fC [virtual]\fR" +Opens the socket using the specified QIODevice file mode \fIm\fR. This function is called automatically when needed and you should not call it yourself. +.PP +See also close(). +.PP +Reimplemented from QIODevice. +.SH "QHostAddress QSocket::peerAddress () const" +Returns the address of the connected peer if the socket is in Connected state; otherwise an empty QHostAddress is returned. +.SH "QString QSocket::peerName () const" +Returns the host name as specified to the connectToHost() function. An empty string is returned if none has been set. +.PP +Example: network/mail/smtp.cpp. +.SH "TQ_UINT16 QSocket::peerPort () const" +Returns the peer's host port number, normally as specified to the connectToHost() function. If none has been set, this function returns 0. +.PP +Note that Qt always uses native byte order, i.e. 67 is 67 in Qt; there is no need to call htons(). +.SH "TQ_UINT16 QSocket::port () const" +Returns the host port number of this socket, in native byte order. +.SH "int QSocket::putch ( int ch )\fC [virtual]\fR" +Writes the character \fIch\fR to the output buffer. +.PP +Returns \fIch\fR, or -1 if an error occurred. +.PP +See also getch(). +.PP +Reimplemented from QIODevice. +.SH "TQ_LONG QSocket::readBlock ( char * data, TQ_ULONG maxlen )\fC [virtual]\fR" +Reads \fImaxlen\fR bytes from the socket into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. +.PP +Example: network/networkprotocol/nntp.cpp. +.PP +Reimplemented from QIODevice. +.SH "TQ_ULONG QSocket::readBufferSize () const" +Returns the size of the read buffer. +.PP +See also setReadBufferSize(). +.SH "QString QSocket::readLine ()\fC [virtual]\fR" +Returns a line of text including a terminating newline character (\\n). Returns "" if canReadLine() returns FALSE. +.PP +See also canReadLine(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. +.SH "void QSocket::readyRead ()\fC [signal]\fR" +This signal is emitted every time there is new incoming data. +.PP +Bear in mind that new incoming data is only reported once; if you do not read all the data, this class buffers the data and you can read it later, but no signal is emitted unless new data arrives. A good practice is to read all data in the slot connected to this signal unless you are sure that you need to receive more data to be able to process it. +.PP +See also readBlock(), readLine(), and bytesAvailable(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/httpd/httpd.cpp, network/mail/smtp.cpp, and network/networkprotocol/nntp.cpp. +.SH "void QSocket::setReadBufferSize ( TQ_ULONG bufSize )" +Sets the size of the QSocket's internal read buffer to \fIbufSize\fR. +.PP +Usually QSocket reads all data that is available from the operating system's socket. If the buffer size is limited to a certain size, this means that the QSocket class doesn't buffer more than this size of data. +.PP +If the size of the read buffer is 0, the read buffer is unlimited and all incoming data is buffered. This is the default. +.PP +If you read the data in the readyRead() signal, you shouldn't use this option since it might slow down your program unnecessary. This option is useful if you only need to read the data at certain points in time, like in a realtime streaming application. +.PP +See also readBufferSize(). +.SH "void QSocket::setSocket ( int socket )\fC [virtual]\fR" +Sets the socket to use \fIsocket\fR and the state() to Connected. The socket must already be connected. +.PP +This allows us to use the QSocket class as a wrapper for other socket types (e.g. Unix Domain Sockets). +.PP +Example: network/httpd/httpd.cpp. +.SH "void QSocket::setSocketDevice ( QSocketDevice * device )\fC [virtual]\fR" +Sets the internal socket device to \fIdevice\fR. Passing a \fIdevice\fR of 0 will cause the internal socket device to be used. Any existing connection will be disconnected before using the new \fIdevice\fR. +.PP +The new device should not be connected before being associated with a QSocket; after setting the socket call connectToHost() to make the connection. +.PP +This function is useful if you need to subclass QSocketDevice and want to use the QSocket API, for example, to implement Unix domain sockets. +.SH "Offset QSocket::size () const\fC [virtual]\fR" +Returns the number of incoming bytes that can be read right now (like bytesAvailable()). +.PP +Reimplemented from QIODevice. +.SH "int QSocket::socket () const" +Returns the socket number, or -1 if there is no socket at the moment. +.SH "QSocketDevice * QSocket::socketDevice ()" +Returns a pointer to the internal socket device. +.PP +There is normally no need to manipulate the socket device directly since this class does the necessary setup for most applications. +.SH "State QSocket::state () const" +Returns the current state of the socket connection. +.PP +See also QSocket::State. +.PP +Examples: +.)l network/clientserver/client/client.cpp and network/networkprotocol/nntp.cpp. +.SH "int QSocket::ungetch ( int ch )\fC [virtual]\fR" +This implementation of the virtual function QIODevice::ungetch() prepends the character \fIch\fR to the read buffer so that the next read returns this character as the first character of the output. +.PP +Reimplemented from QIODevice. +.SH "TQ_ULONG QSocket::waitForMore ( int msecs, bool * timeout ) const" +Wait up to \fImsecs\fR milliseconds for more data to be available. +.PP +If \fImsecs\fR is -1 the call will block indefinitely. +.PP +Returns the number of bytes available. +.PP +If \fItimeout\fR is non-null and no error occurred (i.e. it does not return -1): this function sets \fI*timeout\fR to TRUE, if the reason for returning was that the timeout was reached; otherwise it sets \fI*timeout\fR to FALSE. This is useful to find out if the peer closed the connection. +.PP +\fBWarning:\fR This is a blocking call and should be avoided in event driven applications. +.PP +See also bytesAvailable(). +.SH "TQ_ULONG QSocket::waitForMore ( int msecs ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "TQ_LONG QSocket::writeBlock ( const char * data, TQ_ULONG len )\fC [virtual]\fR" +Writes \fIlen\fR bytes to the socket from \fIdata\fR and returns the number of bytes written. Returns -1 if an error occurred. +.PP +Example: network/networkprotocol/nntp.cpp. +.PP +Reimplemented from QIODevice. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsocket.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsocket.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsocketdevice.3qt b/doc/man/man3/tqsocketdevice.3qt new file mode 100644 index 000000000..c905675ba --- /dev/null +++ b/doc/man/man3/tqsocketdevice.3qt @@ -0,0 +1,373 @@ +'\" t +.TH QSocketDevice 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 +QSocketDevice \- Platform-independent low-level socket API +.SH SYNOPSIS +\fC#include <ntqsocketdevice.h>\fR +.PP +Inherits QIODevice. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBType\fR { Stream, Datagram }" +.br +.ti -1c +.BI "enum \fBProtocol\fR { IPv4, IPv6, Unknown }" +.br +.ti -1c +.BI "\fBQSocketDevice\fR ( Type type = Stream )" +.br +.ti -1c +.BI "\fBQSocketDevice\fR ( Type type, Protocol protocol, int dummy )" +.br +.ti -1c +.BI "\fBQSocketDevice\fR ( int socket, Type type )" +.br +.ti -1c +.BI "virtual \fB~QSocketDevice\fR ()" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "Type \fBtype\fR () const" +.br +.ti -1c +.BI "Protocol \fBprotocol\fR () const" +.br +.ti -1c +.BI "int \fBsocket\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSocket\fR ( int socket, Type type )" +.br +.ti -1c +.BI "bool \fBblocking\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetBlocking\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBaddressReusable\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAddressReusable\fR ( bool enable )" +.br +.ti -1c +.BI "int \fBreceiveBufferSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetReceiveBufferSize\fR ( uint size )" +.br +.ti -1c +.BI "int \fBsendBufferSize\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSendBufferSize\fR ( uint size )" +.br +.ti -1c +.BI "virtual bool \fBconnect\fR ( const QHostAddress & addr, TQ_UINT16 port )" +.br +.ti -1c +.BI "virtual bool \fBbind\fR ( const QHostAddress & address, TQ_UINT16 port )" +.br +.ti -1c +.BI "virtual bool \fBlisten\fR ( int backlog )" +.br +.ti -1c +.BI "virtual int \fBaccept\fR ()" +.br +.ti -1c +.BI "TQ_LONG \fBbytesAvailable\fR () const" +.br +.ti -1c +.BI "TQ_LONG \fBwaitForMore\fR ( int msecs, bool * timeout = 0 ) const" +.br +.ti -1c +.BI "virtual TQ_LONG \fBreadBlock\fR ( char * data, TQ_ULONG maxlen )" +.br +.ti -1c +.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len )" +.br +.ti -1c +.BI "virtual TQ_LONG \fBwriteBlock\fR ( const char * data, TQ_ULONG len, const QHostAddress & host, TQ_UINT16 port )" +.br +.ti -1c +.BI "TQ_UINT16 \fBport\fR () const" +.br +.ti -1c +.BI "TQ_UINT16 \fBpeerPort\fR () const" +.br +.ti -1c +.BI "QHostAddress \fBaddress\fR () const" +.br +.ti -1c +.BI "QHostAddress \fBpeerAddress\fR () const" +.br +.ti -1c +.BI "enum \fBError\fR { NoError, AlreadyBound, Inaccessible, NoResources, InternalError, Bug = InternalError, Impossible, NoFiles, ConnectionRefused, NetworkFailure, UnknownError }" +.br +.ti -1c +.BI "Error \fBerror\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsetError\fR ( Error err )" +.br +.in -1c +.SH DESCRIPTION +The QSocketDevice class provides a platform-independent low-level socket API. +.PP +This class provides a low level API for working with sockets. Users of this class are assumed to have networking experience. For most users the QSocket class provides a much easier and high level alternative, but certain things (like UDP) can't be done with QSocket and if you need a platform-independent API for those, QSocketDevice is the right choice. +.PP +The essential purpose of the class is to provide a QIODevice that works on sockets, wrapped in a platform-independent API. +.PP +When calling connect() or bind(), QSocketDevice detects the protocol family (IPv4, IPv6) automatically. Passing the protocol family to QSocketDevice's constructor or to setSocket() forces creation of a socket device of a specific protocol. If not set, the protocol will be detected at the first call to connect() or bind(). +.PP +See also QSocket, QSocketNotifier, QHostAddress, and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QSocketDevice::Error" +This enum type describes the error states of QSocketDevice. +.TP +\fCQSocketDevice::NoError\fR - No error has occurred. +.TP +\fCQSocketDevice::AlreadyBound\fR - The device is already bound, according to bind(). +.TP +\fCQSocketDevice::Inaccessible\fR - The operating system or firewall prohibited the action. +.TP +\fCQSocketDevice::NoResources\fR - The operating system ran out of a resource. +.TP +\fCQSocketDevice::InternalError\fR - An internal error occurred in QSocketDevice. +.TP +\fCQSocketDevice::Impossible\fR - An attempt was made to do something which makes no sense. For example: +.IP +.nf +.br + ::close( sd->socket() ); +.br + sd->writeBlock( someData, 42 ); +.br +.fi +The libc ::close() closes the socket, but QSocketDevice is not aware of this. So when you call writeBlock(), the impossible happens. +.TP +\fCQSocketDevice::NoFiles\fR - The operating system will not let QSocketDevice open another file. +.TP +\fCQSocketDevice::ConnectionRefused\fR - A connection attempt was rejected by the peer. +.TP +\fCQSocketDevice::NetworkFailure\fR - There is a network failure. +.TP +\fCQSocketDevice::UnknownError\fR - The operating system did something unexpected. +.SH "QSocketDevice::Protocol" +This enum type describes the protocol family of the socket. Possible values are: +.TP +\fCQSocketDevice::IPv4\fR - The socket is an IPv4 socket. +.TP +\fCQSocketDevice::IPv6\fR - The socket is an IPv6 socket. +.TP +\fCQSocketDevice::Unknown\fR - The protocol family of the socket is not known. This can happen if you use QSocketDevice with an already existing socket; it tries to determine the protocol family, but this can fail if the protocol family is not known to QSocketDevice. +.PP +See also protocol() and setSocket(). +.SH "QSocketDevice::Type" +This enum type describes the type of the socket: +.TP +\fCQSocketDevice::Stream\fR - a stream socket (TCP, usually) +.TP +\fCQSocketDevice::Datagram\fR - a datagram socket (UDP, usually) +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSocketDevice::QSocketDevice ( Type type = Stream )" +Creates a QSocketDevice object for a stream or datagram socket. +.PP +The \fItype\fR argument must be either QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable UDP socket. +.PP +The socket is created as an IPv4 socket. +.PP +See also blocking() and protocol(). +.SH "QSocketDevice::QSocketDevice ( Type type, Protocol protocol, int dummy )" +Creates a QSocketDevice object for a stream or datagram socket. +.PP +The \fItype\fR argument must be either QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable UDP socket. +.PP +The \fIprotocol\fR indicates whether the socket should be of type IPv4 or IPv6. Passing Unknown is not meaningful in this context and you should avoid using (it creates an IPv4 socket, but your code is not easily readable). +.PP +The argument \fIdummy\fR is necessary for compatibility with some compilers. +.PP +See also blocking() and protocol(). +.SH "QSocketDevice::QSocketDevice ( int socket, Type type )" +Creates a QSocketDevice object for the existing socket \fIsocket\fR. +.PP +The \fItype\fR argument must match the actual socket type; use QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable, connectionless UDP socket. +.SH "QSocketDevice::~QSocketDevice ()\fC [virtual]\fR" +Destroys the socket device and closes the socket if it is open. +.SH "int QSocketDevice::accept ()\fC [virtual]\fR" +Extracts the first connection from the queue of pending connections for this socket and returns a new socket identifier. Returns -1 if the operation failed. +.PP +See also bind() and listen(). +.SH "QHostAddress QSocketDevice::address () const" +Returns the address of this socket device. This may be 0.0.0.0 for a while, but is set to something sensible as soon as a sensible value is available. +.SH "bool QSocketDevice::addressReusable () const" +Returns TRUE if the address of this socket can be used by other sockets at the same time, and FALSE if this socket claims exclusive ownership. +.PP +See also setAddressReusable(). +.SH "bool QSocketDevice::bind ( const QHostAddress & address, TQ_UINT16 port )\fC [virtual]\fR" +Assigns a name to an unnamed socket. The name is the host address \fIaddress\fR and the port number \fIport\fR. If the operation succeeds, bind() returns TRUE; otherwise it returns FALSE without changing what port() and address() return. +.PP +bind() is used by servers for setting up incoming connections. Call bind() before listen(). +.SH "bool QSocketDevice::blocking () const" +Returns TRUE if the socket is valid and in blocking mode; otherwise returns FALSE. +.PP +Note that this function does not set error(). +.PP +\fBWarning:\fR On Windows, this function always returns TRUE since the ioctlsocket() function is broken. +.PP +See also setBlocking() and isValid(). +.SH "TQ_LONG QSocketDevice::bytesAvailable () const" +Returns the number of bytes available for reading, or -1 if an error occurred. +.PP +\fBWarning:\fR On Microsoft Windows, we use the ioctlsocket() function to determine the number of bytes queued on the socket. According to Microsoft (KB Q125486), ioctlsocket() sometimes returns an incorrect number. The only safe way to determine the amount of data on the socket is to read it using readBlock(). QSocket has workarounds to deal with this problem. +.SH "bool QSocketDevice::connect ( const QHostAddress & addr, TQ_UINT16 port )\fC [virtual]\fR" +Connects to the IP address and port specified by \fIaddr\fR and \fIport\fR. Returns TRUE if it establishes a connection; otherwise returns FALSE. If it returns FALSE, error() explains why. +.PP +Note that error() commonly returns NoError for non-blocking sockets; this just means that you can call connect() again in a little while and it'll probably succeed. +.SH "Error QSocketDevice::error () const" +Returns the first error seen. +.SH "bool QSocketDevice::isValid () const" +Returns TRUE if this is a valid socket; otherwise returns FALSE. +.PP +See also socket(). +.SH "bool QSocketDevice::listen ( int backlog )\fC [virtual]\fR" +Specifies how many pending connections a server socket can have. Returns TRUE if the operation was successful; otherwise returns FALSE. A \fIbacklog\fR value of 50 is quite common. +.PP +The listen() call only applies to sockets where type() is Stream, i.e. not to Datagram sockets. listen() must not be called before bind() or after accept(). +.PP +See also bind() and accept(). +.SH "QHostAddress QSocketDevice::peerAddress () const" +Returns the address of the port this socket device is connected to. This may be 0.0.0.0 for a while, but is set to something sensible as soon as a sensible value is available. +.PP +Note that for Datagram sockets, this is the source port of the last packet received. +.SH "TQ_UINT16 QSocketDevice::peerPort () const" +Returns the port number of the port this socket device is connected to. This may be 0 for a while, but is set to something sensible as soon as a sensible value is available. +.PP +Note that for Datagram sockets, this is the source port of the last packet received, and that it is in native byte order. +.SH "TQ_UINT16 QSocketDevice::port () const" +Returns the port number of this socket device. This may be 0 for a while, but is set to something sensible as soon as a sensible value is available. +.PP +Note that Qt always uses native byte order, i.e. 67 is 67 in Qt; there is no need to call htons(). +.SH "Protocol QSocketDevice::protocol () const" +Returns the socket's protocol family, which is one of Unknown, IPv4, or IPv6. +.PP +QSocketDevice either creates a socket with a well known protocol family or it uses an already existing socket. In the first case, this function returns the protocol family it was constructed with. In the second case, it tries to determine the protocol family of the socket; if this fails, it returns Unknown. +.PP +See also Protocol and setSocket(). +.SH "TQ_LONG QSocketDevice::readBlock ( char * data, TQ_ULONG maxlen )\fC [virtual]\fR" +Reads \fImaxlen\fR bytes from the socket into \fIdata\fR and returns the number of bytes read. Returns -1 if an error occurred. Returning 0 is not an error. For Stream sockets, 0 is returned when the remote host closes the connection. For Datagram sockets, 0 is a valid datagram size. +.PP +Reimplemented from QIODevice. +.SH "int QSocketDevice::receiveBufferSize () const" +Returns the size of the operating system receive buffer. +.PP +See also setReceiveBufferSize(). +.SH "int QSocketDevice::sendBufferSize () const" +Returns the size of the operating system send buffer. +.PP +See also setSendBufferSize(). +.SH "void QSocketDevice::setAddressReusable ( bool enable )\fC [virtual]\fR" +Sets the address of this socket to be usable by other sockets too if \fIenable\fR is TRUE, and to be used exclusively by this socket if \fIenable\fR is FALSE. +.PP +When a socket is reusable, other sockets can use the same port number (and IP address), which is generally useful. Of course other sockets cannot use the same (address,port,peer-address,peer-port) 4-tuple as this socket, so there is no risk of confusing the two TCP connections. +.PP +See also addressReusable(). +.SH "void QSocketDevice::setBlocking ( bool enable )\fC [virtual]\fR" +Makes the socket blocking if \fIenable\fR is TRUE or nonblocking if \fIenable\fR is FALSE. +.PP +Sockets are blocking by default, but we recommend using nonblocking socket operations, especially for GUI programs that need to be responsive. +.PP +\fBWarning:\fR On Windows, this function should be used with care since whenever you use a QSocketNotifier on Windows, the socket is immediately made nonblocking. +.PP +See also blocking() and isValid(). +.SH "void QSocketDevice::setError ( Error err )\fC [protected]\fR" +Allows subclasses to set the error state to \fIerr\fR. +.SH "void QSocketDevice::setReceiveBufferSize ( uint size )\fC [virtual]\fR" +Sets the size of the operating system receive buffer to \fIsize\fR. +.PP +The operating system receive buffer size effectively limits two things: how much data can be in transit at any one moment, and how much data can be received in one iteration of the main event loop. +.PP +The default is operating system-dependent. A socket that receives large amounts of data is probably best with a buffer size of 49152. +.SH "void QSocketDevice::setSendBufferSize ( uint size )\fC [virtual]\fR" +Sets the size of the operating system send buffer to \fIsize\fR. +.PP +The operating system send buffer size effectively limits how much data can be in transit at any one moment. +.PP +The default is operating system-dependent. A socket that sends large amounts of data is probably best with a buffer size of 49152. +.SH "void QSocketDevice::setSocket ( int socket, Type type )\fC [virtual]\fR" +Sets the socket device to operate on the existing socket \fIsocket\fR. +.PP +The \fItype\fR argument must match the actual socket type; use QSocketDevice::Stream for a reliable, connection-oriented TCP socket, or QSocketDevice::Datagram for an unreliable, connectionless UDP socket. +.PP +Any existing socket is closed. +.PP +See also isValid() and close(). +.SH "int QSocketDevice::socket () const" +Returns the socket number, or -1 if it is an invalid socket. +.PP +See also isValid() and type(). +.SH "Type QSocketDevice::type () const" +Returns the socket type which is either QSocketDevice::Stream or QSocketDevice::Datagram. +.PP +See also socket(). +.SH "TQ_LONG QSocketDevice::waitForMore ( int msecs, bool * timeout = 0 ) const" +Wait up to \fImsecs\fR milliseconds for more data to be available. If \fImsecs\fR is -1 the call will block indefinitely. +.PP +Returns the number of bytes available for reading, or -1 if an error occurred. +.PP +If \fItimeout\fR is non-null and no error occurred (i.e. it does not return -1): this function sets \fI*timeout\fR to TRUE, if the reason for returning was that the timeout was reached; otherwise it sets \fI*timeout\fR to FALSE. This is useful to find out if the peer closed the connection. +.PP +\fBWarning:\fR This is a blocking call and should be avoided in event driven applications. +.PP +See also bytesAvailable(). +.SH "TQ_LONG QSocketDevice::writeBlock ( const char * data, TQ_ULONG len )\fC [virtual]\fR" +Writes \fIlen\fR bytes to the socket from \fIdata\fR and returns the number of bytes written. Returns -1 if an error occurred. +.PP +This is used for QSocketDevice::Stream sockets. +.PP +Reimplemented from QIODevice. +.SH "TQ_LONG QSocketDevice::writeBlock ( const char * data, TQ_ULONG len, const QHostAddress & host, TQ_UINT16 port )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes \fIlen\fR bytes to the socket from \fIdata\fR and returns the number of bytes written. Returns -1 if an error occurred. +.PP +This is used for QSocketDevice::Datagram sockets. You must +specify the \fIhost\fR and \fIport\fR of the destination of the data. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsocketdevice.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsocketdevice.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsocketnotifier.3qt b/doc/man/man3/tqsocketnotifier.3qt new file mode 100644 index 000000000..ddba610f4 --- /dev/null +++ b/doc/man/man3/tqsocketnotifier.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QSocketNotifier 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 +QSocketNotifier \- Support for socket callbacks +.SH SYNOPSIS +\fC#include <ntqsocketnotifier.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBType\fR { Read, Write, Exception }" +.br +.ti -1c +.BI "\fBQSocketNotifier\fR ( int socket, Type type, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSocketNotifier\fR ()" +.br +.ti -1c +.BI "int \fBsocket\fR () const" +.br +.ti -1c +.BI "Type \fBtype\fR () const" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetEnabled\fR ( bool enable )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBactivated\fR ( int socket )" +.br +.in -1c +.SH DESCRIPTION +The QSocketNotifier class provides support for socket callbacks. +.PP +This class makes it possible to write asynchronous socket-based code in Qt. Using synchronous socket operations blocks the program, which is clearly not acceptable for an event-driven GUI program. +.PP +Once you have opened a non-blocking socket (whether for TCP, UDP, a UNIX-domain socket, or any other protocol family your operating system supports), you can create a socket notifier to monitor the socket. Then you connect the activated() signal to the slot you want to be called when a socket event occurs. +.PP +Note for Windows users: the socket passed to QSocketNotifier will become non-blocking, even if it was created as a blocking socket. +.PP +There are three types of socket notifiers (read, write and exception); you must specify one of these in the constructor. +.PP +The type specifies when the activated() signal is to be emitted: <ol type=1> +.IP 1 +QSocketNotifier::Read - There is data to be read (socket read event). +.IP 2 +QSocketNotifier::Write - Data can be written (socket write event). +.IP 3 +QSocketNofifier::Exception - An exception has occurred (socket exception event). We recommend against using this. +.PP +For example, if you need to monitor both reads and writes for the same socket you must create two socket notifiers. +.PP +For read notifiers it makes little sense to connect the activated() signal to more than one slot because the data can be read from the socket only once. +.PP +Also observe that if you do not read all the available data when the read notifier fires, it fires again and again. +.PP +For write notifiers, immediately disable the notifier after the activated() signal has been received and you have sent the data to be written on the socket. When you have more data to be written, enable it again to get a new activated() signal. The exception is if the socket data writing operation (send() or equivalent) fails with a "would block" error, which means that some buffer is full and you must wait before sending more data. In that case you do not need to disable and re-enable the write notifier; it will fire again as soon as the system allows more data to be sent. +.PP +The behavior of a write notifier that is left in enabled state after having emitting the first activated() signal (and no "would block" error has occurred) is undefined. Depending on the operating system, it may fire on every pass of the event loop or not at all. +.PP +If you need a time-out for your sockets you can use either timer events or the QTimer class. +.PP +Socket action is detected in the main event loop of Qt. The X11 version of Qt has a single UNIX select() call that incorporates all socket notifiers and the X socket. +.PP +Note that on XFree86 for OS/2, select() works only in the thread in which main() is running; you should therefore use that thread for GUI operations. +.PP +See also QSocket, QServerSocket, QSocketDevice, QFile::handle(), and Input/Output and Networking. +.SS "Member Type Documentation" +.SH "QSocketNotifier::Type" +.TP +\fCQSocketNotifier::Read\fR +.TP +\fCQSocketNotifier::Write\fR +.TP +\fCQSocketNotifier::Exception\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSocketNotifier::QSocketNotifier ( int socket, Type type, QObject * parent = 0, const char * name = 0 )" +Constructs a socket notifier called \fIname\fR, with the parent, \fIparent\fR. It watches \fIsocket\fR for \fItype\fR events, and enables it. +.PP +It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers. +.PP +See also setEnabled() and isEnabled(). +.SH "QSocketNotifier::~QSocketNotifier ()" +Destroys the socket notifier. +.SH "void QSocketNotifier::activated ( int socket )\fC [signal]\fR" +This signal is emitted under certain conditions specified by the notifier type(): <ol type=1> +.TP +QSocketNotifier::Read - There is data to be read (socket read event). +.TP +QSocketNotifier::Write - Data can be written (socket write event). +.TP +QSocketNofifier::Exception - An exception has occurred (socket exception event). +.PP +The \fIsocket\fR argument is the socket identifier. +.PP +See also type() and socket(). +.SH "bool QSocketNotifier::isEnabled () const" +Returns TRUE if the notifier is enabled; otherwise returns FALSE. +.PP +See also setEnabled(). +.SH "void QSocketNotifier::setEnabled ( bool enable )\fC [virtual]\fR" +Enables the notifier if \fIenable\fR is TRUE or disables it if \fIenable\fR is FALSE. +.PP +The notifier is enabled by default. +.PP +If the notifier is enabled, it emits the activated() signal whenever a socket event corresponding to its type occurs. If it is disabled, it ignores socket events (the same effect as not creating the socket notifier). +.PP +Write notifiers should normally be disabled immediately after the activated() signal has been emitted; see discussion of write notifiers in the class description above. +.PP +See also isEnabled() and activated(). +.SH "int QSocketNotifier::socket () const" +Returns the socket identifier specified to the constructor. +.PP +See also type(). +.SH "Type QSocketNotifier::type () const" +Returns the socket event type specified to the constructor: QSocketNotifier::Read, QSocketNotifier::Write, or QSocketNotifier::Exception. +.PP +See also socket(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsocketnotifier.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsocketnotifier.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsound.3qt b/doc/man/man3/tqsound.3qt new file mode 100644 index 000000000..ffb66f168 --- /dev/null +++ b/doc/man/man3/tqsound.3qt @@ -0,0 +1,167 @@ +'\" t +.TH QSound 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 +QSound \- Access to the platform audio facilities +.SH SYNOPSIS +\fC#include <ntqsound.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSound\fR ( const QString & filename, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSound\fR ()" +.br +.ti -1c +.BI "int \fBloops\fR () const" +.br +.ti -1c +.BI "int \fBloopsRemaining\fR () const" +.br +.ti -1c +.BI "void \fBsetLoops\fR ( int l )" +.br +.ti -1c +.BI "QString \fBfileName\fR () const" +.br +.ti -1c +.BI "bool \fBisFinished\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBplay\fR ()" +.br +.ti -1c +.BI "void \fBstop\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBisAvailable\fR ()" +.br +.ti -1c +.BI "void \fBplay\fR ( const QString & filename )" +.br +.ti -1c +.BI "bool \fBavailable\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSound class provides access to the platform audio facilities. +.PP +Qt provides the most commonly required audio operation in GUI applications: asynchronously playing a sound file. This is most easily accomplished with a single call: +.PP +.nf +.br + QSound::play("mysounds/bells.wav"); +.br +.fi +.PP +A second API is provided in which a QSound object is created from a sound file and is played later: +.PP +.nf +.br + QSound bells("mysounds/bells.wav"); +.br +.br + bells.play(); +.br +.fi +.PP +Sounds played using the second model may use more memory but play more immediately than sounds played using the first model, depending on the underlying platform audio facilities. +.PP +On Microsoft Windows the underlying multimedia system is used; only WAVE format sound files are supported. +.PP +On X11 the Network Audio System is used if available, otherwise all operations work silently. NAS supports WAVE and AU files. +.PP +On Macintosh, ironically, we use QT (QuickTime) for sound, this means all QuickTime formats are supported by Qt/Mac. +.PP +On Qt/Embedded, a built-in mixing sound server is used, which accesses \fC/dev/dsp\fR directly. Only the WAVE format is supported. +.PP +The availability of sound can be tested with QSound::isAvailable(). +.PP +See also Multimedia Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSound::QSound ( const QString & filename, QObject * parent = 0, const char * name = 0 )" +Constructs a QSound that can quickly play the sound in a file named \fIfilename\fR. +.PP +This may use more memory than the static \fCplay\fR function. +.PP +The \fIparent\fR and \fIname\fR arguments (default 0) are passed on to the QObject constructor. +.SH "QSound::~QSound ()" +Destroys the sound object. If the sound is not finished playing stop() is called on it. +.PP +See also stop() and isFinished(). +.SH "bool QSound::available ()\fC [static]\fR" +Returns TRUE if sound support is available; otherwise returns FALSE. +.SH "QString QSound::fileName () const" +Returns the filename associated with the sound. +.SH "bool QSound::isAvailable ()\fC [static]\fR" +Returns TRUE if sound facilities exist on the platform; otherwise returns FALSE. An application may choose either to notify the user if sound is crucial to the application or to operate silently without bothering the user. +.PP +If no sound is available, all QSound operations work silently and quickly. +.SH "bool QSound::isFinished () const" +Returns TRUE if the sound has finished playing; otherwise returns FALSE. +.PP +\fBWarning:\fR On Windows this function always returns TRUE for unlooped sounds. +.SH "int QSound::loops () const" +Returns the number of times the sound will play. +.SH "int QSound::loopsRemaining () const" +Returns the number of times the sound will loop. This value decreases each time the sound loops. +.SH "void QSound::play ( const QString & filename )\fC [static]\fR" +Plays the sound in a file called \fIfilename\fR. +.PP +Example: sound/sound.cpp. +.SH "void QSound::play ()\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Starts the sound playing. The function returns immediately. Depending on the platform audio facilities, other sounds may stop or may be mixed with the new sound. +.PP +The sound can be played again at any time, possibly mixing or replacing previous plays of the sound. +.SH "void QSound::setLoops ( int l )" +Sets the sound to repeat \fIl\fR times when it is played. Passing the value -1 will cause the sound to loop indefinitely. +.PP +See also loops(). +.SH "void QSound::stop ()\fC [slot]\fR" +Stops the sound playing. +.PP +On Windows the current loop will finish if a sound is played in a loop. +.PP +See also play(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsound.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsound.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqspaceritem.3qt b/doc/man/man3/tqspaceritem.3qt new file mode 100644 index 000000000..42e1b71ba --- /dev/null +++ b/doc/man/man3/tqspaceritem.3qt @@ -0,0 +1,108 @@ +'\" t +.TH QSpacerItem 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 +QSpacerItem \- Blank space in a layout +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherits QLayoutItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSpacerItem\fR ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" +.br +.ti -1c +.BI "void \fBchangeSize\fR ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBminimumSize\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBmaximumSize\fR () const" +.br +.ti -1c +.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" +.br +.in -1c +.SH DESCRIPTION +The QSpacerItem class provides blank space in a layout. +.PP +This class is used by custom layouts. +.PP +See also QLayout, QLayout::spacerItem(), Widget Appearance and Style, and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSpacerItem::QSpacerItem ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" +Constructs a spacer item with preferred width \fIw\fR, preferred height \fIh\fR, horizontal size policy \fIhData\fR and vertical size policy \fIvData\fR. +.PP +The default values provide a gap that is able to stretch if nothing else wants the space. +.SH "void QSpacerItem::changeSize ( int w, int h, QSizePolicy::SizeType hData = QSizePolicy::Minimum, QSizePolicy::SizeType vData = QSizePolicy::Minimum )" +Changes this spacer item to have preferred width \fIw\fR, preferred height \fIh\fR, horizontal size policy \fIhData\fR and vertical size policy \fIvData\fR. +.PP +The default values provide a gap that is able to stretch if nothing else wants the space. +.SH "QSizePolicy::ExpandData QSpacerItem::expanding () const\fC [virtual]\fR" +Returns the direction in which this spacer item will expand. +.PP +See also QSizePolicy::ExpandData. +.PP +Reimplemented from QLayoutItem. +.SH "bool QSpacerItem::isEmpty () const\fC [virtual]\fR" +Returns TRUE because a spacer item never contains widgets. +.PP +Reimplemented from QLayoutItem. +.SH "QSize QSpacerItem::maximumSize () const\fC [virtual]\fR" +Returns the maximum size of this spacer item. +.PP +Reimplemented from QLayoutItem. +.SH "QSize QSpacerItem::minimumSize () const\fC [virtual]\fR" +Returns the minimum size of this spacer item. +.PP +Reimplemented from QLayoutItem. +.SH "void QSpacerItem::setGeometry ( const QRect & r )\fC [virtual]\fR" +Stores the spacer item's rect \fIr\fR so that it can be returned by geometry(). +.PP +Reimplemented from QLayoutItem. +.SH "QSize QSpacerItem::sizeHint () const\fC [virtual]\fR" +Returns the preferred size of this spacer item. +.PP +Reimplemented from QLayoutItem. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qspaceritem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqspaceritem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqspinbox.3qt b/doc/man/man3/tqspinbox.3qt new file mode 100644 index 000000000..eac35c95c --- /dev/null +++ b/doc/man/man3/tqspinbox.3qt @@ -0,0 +1,572 @@ +'\" t +.TH QSpinBox 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 +QSpinBox \- Spin box widget (spin button) +.SH SYNOPSIS +\fC#include <ntqspinbox.h>\fR +.PP +Inherits QWidget and QRangeControl. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSpinBox\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQSpinBox\fR ( int minValue, int maxValue, int step = 1, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSpinBox\fR ()" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual QString \fBprefix\fR () const" +.br +.ti -1c +.BI "virtual QString \fBsuffix\fR () const" +.br +.ti -1c +.BI "virtual QString \fBcleanText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSpecialValueText\fR ( const QString & text )" +.br +.ti -1c +.BI "QString \fBspecialValueText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetWrapping\fR ( bool on )" +.br +.ti -1c +.BI "bool \fBwrapping\fR () const" +.br +.ti -1c +.BI "enum \fBButtonSymbols\fR { UpDownArrows, PlusMinus }" +.br +.ti -1c +.BI "virtual void \fBsetButtonSymbols\fR ( ButtonSymbols )" +.br +.ti -1c +.BI "ButtonSymbols \fBbuttonSymbols\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetValidator\fR ( const QValidator * v )" +.br +.ti -1c +.BI "const QValidator * \fBvalidator\fR () const" +.br +.ti -1c +.BI "int \fBminValue\fR () const" +.br +.ti -1c +.BI "int \fBmaxValue\fR () const" +.br +.ti -1c +.BI "void \fBsetMinValue\fR ( int )" +.br +.ti -1c +.BI "void \fBsetMaxValue\fR ( int )" +.br +.ti -1c +.BI "int \fBlineStep\fR () const" +.br +.ti -1c +.BI "void \fBsetLineStep\fR ( int )" +.br +.ti -1c +.BI "int \fBvalue\fR () const" +.br +.ti -1c +.BI "QRect \fBupRect\fR () const" +.br +.ti -1c +.BI "QRect \fBdownRect\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetValue\fR ( int value )" +.br +.ti -1c +.BI "virtual void \fBsetPrefix\fR ( const QString & text )" +.br +.ti -1c +.BI "virtual void \fBsetSuffix\fR ( const QString & text )" +.br +.ti -1c +.BI "virtual void \fBstepUp\fR ()" +.br +.ti -1c +.BI "virtual void \fBstepDown\fR ()" +.br +.ti -1c +.BI "virtual void \fBselectAll\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBvalueChanged\fR ( int value )" +.br +.ti -1c +.BI "void \fBvalueChanged\fR ( const QString & valueText )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "ButtonSymbols \fBbuttonSymbols\fR - the current button symbol mode" +.br +.ti -1c +.BI "QString \fBcleanText\fR - the spin box's text with no prefix(), suffix() or leading or trailing whitespace \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBlineStep\fR - the line step" +.br +.ti -1c +.BI "int \fBmaxValue\fR - the maximum value of the spin box" +.br +.ti -1c +.BI "int \fBminValue\fR - the minimum value of the spin box" +.br +.ti -1c +.BI "QString \fBprefix\fR - the spin box's prefix" +.br +.ti -1c +.BI "QString \fBspecialValueText\fR - the special-value text" +.br +.ti -1c +.BI "QString \fBsuffix\fR - the suffix of the spin box" +.br +.ti -1c +.BI "QString \fBtext\fR - the spin box's " "text" ", including any prefix() and suffix() \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBvalue\fR - the value of the spin box" +.br +.ti -1c +.BI "bool \fBwrapping\fR - whether it is possible to step the value from the highest value to the lowest value and vice versa" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QString \fBmapValueToText\fR ( int v )" +.br +.ti -1c +.BI "virtual int \fBmapTextToValue\fR ( bool * ok )" +.br +.ti -1c +.BI "QString \fBcurrentValueText\fR ()" +.br +.ti -1c +.BI "virtual void \fBupdateDisplay\fR ()" +.br +.ti -1c +.BI "virtual void \fBinterpretText\fR ()" +.br +.ti -1c +.BI "QLineEdit * \fBeditor\fR () const" +.br +.ti -1c +.BI "virtual void \fBvalueChange\fR ()" +.br +.ti -1c +.BI "virtual void \fBrangeChange\fR ()" +.br +.ti -1c +.BI "virtual bool \fBeventFilter\fR ( QObject * o, QEvent * ev )" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "void \fBtextChanged\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSpinBox class provides a spin box widget (spin button). +.PP +QSpinBox allows the user to choose a value either by clicking the up/down buttons to increase/decrease the value currently displayed or by typing the value directly into the spin box. If the value is entered directly into the spin box, Enter (or Return) must be pressed to apply the new value. The value is usually an integer. +.PP +Every time the value changes QSpinBox emits the valueChanged() signal. The current value can be fetched with value() and set with setValue(). +.PP +The spin box keeps the value within a numeric range, and to multiples of the lineStep() size (see QRangeControl for details). Clicking the up/down buttons or using the keyboard accelerator's up and down arrows will increase or decrease the current value in steps of size lineStep(). The minimum and maximum value and the step size can be set using one of the constructors, and can be changed later with setMinValue(), setMaxValue() and setLineStep(). +.PP +Most spin boxes are directional, but QSpinBox can also operate as a circular spin box, i.e. if the range is 0-99 and the current value is 99, clicking "up" will give 0. Use setWrapping() if you want circular behavior. +.PP +The displayed value can be prepended and appended with arbitrary strings indicating, for example, currency or the unit of measurement. See setPrefix() and setSuffix(). The text in the spin box is retrieved with text() (which includes any prefix() and suffix()), or with cleanText() (which has no prefix(), no suffix() and no leading or trailing whitespace). currentValueText() returns the spin box's current value as text. +.PP +Normally the spin box displays up and down arrows in the buttons. You can use setButtonSymbols() to change the display to show \fB+\fR and \fB-\fR symbols if you prefer. In either case the up and down arrow keys work as expected. +.PP +It is often desirable to give the user a special (often default) choice in addition to the range of numeric values. See setSpecialValueText() for how to do this with QSpinBox. +.PP +The default QWidget::focusPolicy() is StrongFocus. +.PP +If using prefix(), suffix() and specialValueText() don't provide enough control, you can ignore them and subclass QSpinBox instead. +.PP +QSpinBox can easily be subclassed to allow the user to input things other than an integer value as long as the allowed input can be mapped to a range of integers. This can be done by overriding the virtual functions mapValueToText() and mapTextToValue(), and setting another suitable validator using setValidator(). +.PP +For example, these functions could be changed so that the user provided values from 0.0 to 10.0, or -1 to signify 'Auto', while the range of integers used inside the program would be -1 to 100: +.PP +.nf +.br + class MySpinBox : public QSpinBox +.br + { +.br + TQ_OBJECT +.br + public: +.br + ... +.br +.br + QString mapValueToText( int value ) +.br + { +.br + if ( value == -1 ) // special case +.br + return QString( "Auto" ); +.br +.br + return QString( "%1.%2" ) // 0.0 to 10.0 +.br + .arg( value / 10 ).arg( value % 10 ); +.br + } +.br +.br + int mapTextToValue( bool *ok ) +.br + { +.br + if ( text() == "Auto" ) // special case +.br + return -1; +.br +.br + return (int) ( 10 * text().toFloat() ); // 0 to 100 +.br + } +.br + }; +.br +.fi +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QScrollBar, QSlider, GUI Design Handbook: Spin Box, and Basic Widgets. +.SS "Member Type Documentation" +.SH "QSpinBox::ButtonSymbols" +This enum type determines what the buttons in a spin box show. +.TP +\fCQSpinBox::UpDownArrows\fR - the buttons show little arrows in the classic style. +.TP +\fCQSpinBox::PlusMinus\fR - the buttons show \fB+\fR and \fB-\fR symbols. +.PP +See also QSpinBox::buttonSymbols. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSpinBox::QSpinBox ( QWidget * parent = 0, const char * name = 0 )" +Constructs a spin box with the default QRangeControl range and step values. It is called \fIname\fR and has parent \fIparent\fR. +.PP +See also minValue, maxValue, setRange(), lineStep, and setSteps(). +.SH "QSpinBox::QSpinBox ( int minValue, int maxValue, int step = 1, QWidget * parent = 0, const char * name = 0 )" +Constructs a spin box that allows values from \fIminValue\fR to \fImaxValue\fR inclusive, with step amount \fIstep\fR. The value is initially set to \fIminValue\fR. +.PP +The spin box is called \fIname\fR and has parent \fIparent\fR. +.PP +See also minValue, maxValue, setRange(), lineStep, and setSteps(). +.SH "QSpinBox::~QSpinBox ()" +Destroys the spin box, freeing all memory and other resources. +.SH "ButtonSymbols QSpinBox::buttonSymbols () const" +Returns the current button symbol mode. See the "buttonSymbols" property for details. +.SH "QString QSpinBox::cleanText () const\fC [virtual]\fR" +Returns the spin box's text with no prefix(), suffix() or leading or trailing whitespace. See the "cleanText" property for details. +.SH "QString QSpinBox::currentValueText ()\fC [protected]\fR" +Returns the full text calculated from the current value, including any prefix and suffix. If there is special value text and the value is minValue() the specialValueText() is returned. +.SH "QRect QSpinBox::downRect () const" +Returns the geometry of the "down" button. +.SH "QLineEdit * QSpinBox::editor () const\fC [protected]\fR" +Returns a pointer to the embedded QLineEdit. +.SH "bool QSpinBox::eventFilter ( QObject * o, QEvent * ev )\fC [virtual protected]\fR" +Intercepts and handles the events coming to the embedded QLineEdit that have special meaning for the QSpinBox. The object is passed as \fIo\fR and the event is passed as \fIev\fR. +.PP +Reimplemented from QObject. +.SH "void QSpinBox::interpretText ()\fC [virtual protected]\fR" +QSpinBox calls this after the user has manually edited the contents of the spin box (i.e. by typing in the embedded QLineEdit, rather than using the up/down buttons/keys). +.PP +The default implementation of this function interprets the new text using mapTextToValue(). If mapTextToValue() is successful, it changes the spin box's value; if not, the value is left unchanged. +.PP +See also editor(). +.SH "int QSpinBox::lineStep () const" +Returns the line step. See the "lineStep" property for details. +.SH "int QSpinBox::mapTextToValue ( bool * ok )\fC [virtual protected]\fR" +This virtual function is used by the spin box whenever it needs to interpret text entered by the user as a value. The text is available as text() and as cleanText(), and this function must parse it if possible. If \fIok\fR is not 0: if it parses the text successfully, \fI*ok\fR is set to TRUE; otherwise \fI*ok\fR is set to FALSE. +.PP +Subclasses that need to display spin box values in a non-numeric way need to reimplement this function. +.PP +Note that Qt handles specialValueText() separately; this function is only concerned with the other values. +.PP +The default implementation tries to interpret the text() as an integer in the standard way and returns the integer value. +.PP +See also interpretText() and mapValueToText(). +.SH "QString QSpinBox::mapValueToText ( int v )\fC [virtual protected]\fR" +This virtual function is used by the spin box whenever it needs to display value \fIv\fR. The default implementation returns a string containing \fIv\fR printed in the standard way. Reimplementations may return anything. (See the example in the detailed description.) +.PP +Note that Qt does not call this function for specialValueText() and that neither prefix() nor suffix() are included in the return value. +.PP +If you reimplement this, you may also need to reimplement mapTextToValue(). +.PP +See also updateDisplay() and mapTextToValue(). +.SH "int QSpinBox::maxValue () const" +Returns the maximum value of the spin box. See the "maxValue" property for details. +.SH "int QSpinBox::minValue () const" +Returns the minimum value of the spin box. See the "minValue" property for details. +.SH "QString QSpinBox::prefix () const\fC [virtual]\fR" +Returns the spin box's prefix. See the "prefix" property for details. +.SH "void QSpinBox::rangeChange ()\fC [virtual protected]\fR" +This virtual function is called by QRangeControl whenever the range has changed. It adjusts the default validator and updates the display; if you need additional processing, you can reimplement this function. +.PP +Reimplemented from QRangeControl. +.SH "void QSpinBox::selectAll ()\fC [virtual slot]\fR" +Selects all the text in the spin box's editor. +.SH "void QSpinBox::setButtonSymbols ( ButtonSymbols )\fC [virtual]\fR" +Sets the current button symbol mode. See the "buttonSymbols" property for details. +.SH "void QSpinBox::setLineStep ( int )" +Sets the line step. See the "lineStep" property for details. +.SH "void QSpinBox::setMaxValue ( int )" +Sets the maximum value of the spin box. See the "maxValue" property for details. +.SH "void QSpinBox::setMinValue ( int )" +Sets the minimum value of the spin box. See the "minValue" property for details. +.SH "void QSpinBox::setPrefix ( const QString & text )\fC [virtual slot]\fR" +Sets the spin box's prefix to \fItext\fR. See the "prefix" property for details. +.SH "void QSpinBox::setSpecialValueText ( const QString & text )\fC [virtual]\fR" +Sets the special-value text to \fItext\fR. See the "specialValueText" property for details. +.SH "void QSpinBox::setSuffix ( const QString & text )\fC [virtual slot]\fR" +Sets the suffix of the spin box to \fItext\fR. See the "suffix" property for details. +.SH "void QSpinBox::setValidator ( const QValidator * v )\fC [virtual]\fR" +Sets the validator to \fIv\fR. The validator controls what keyboard input is accepted when the user is editing in the value field. The default is to use a suitable QIntValidator. +.PP +Use setValidator(0) to turn off input validation (entered input will still be kept within the spin box's range). +.SH "void QSpinBox::setValue ( int value )\fC [virtual slot]\fR" +Sets the value of the spin box to \fIvalue\fR. See the "value" property for details. +.SH "void QSpinBox::setWrapping ( bool on )\fC [virtual]\fR" +Sets whether it is possible to step the value from the highest value to the lowest value and vice versa to \fIon\fR. See the "wrapping" property for details. +.SH "QString QSpinBox::specialValueText () const" +Returns the special-value text. See the "specialValueText" property for details. +.SH "void QSpinBox::stepDown ()\fC [virtual slot]\fR" +Decreases the spin box's value one lineStep(), wrapping as necessary if wrapping() is TRUE. This is the same as clicking on the pointing-down button and can be used for keyboard accelerators, for example. +.PP +See also stepUp(), subtractLine(), lineStep, setSteps(), value, and value. +.SH "void QSpinBox::stepUp ()\fC [virtual slot]\fR" +Increases the spin box's value by one lineStep(), wrapping as necessary if wrapping() is TRUE. This is the same as clicking on the pointing-up button and can be used for keyboard accelerators, for example. +.PP +See also stepDown(), addLine(), lineStep, setSteps(), value, and value. +.SH "QString QSpinBox::suffix () const\fC [virtual]\fR" +Returns the suffix of the spin box. See the "suffix" property for details. +.SH "QString QSpinBox::text () const" +Returns the spin box's text, including any prefix() and suffix(). See the "text" property for details. +.SH "void QSpinBox::textChanged ()\fC [protected slot]\fR" +This slot is called whenever the user edits the spin box's text. +.SH "QRect QSpinBox::upRect () const" +Returns the geometry of the "up" button. +.SH "void QSpinBox::updateDisplay ()\fC [virtual protected]\fR" +Updates the contents of the embedded QLineEdit to reflect the current value using mapValueToText(). Also enables/disables the up/down push buttons accordingly. +.PP +See also mapValueToText(). +.SH "const QValidator * QSpinBox::validator () const" +Returns the validator that constrains editing for this spin box if there is any; otherwise returns 0. +.PP +See also setValidator() and QValidator. +.SH "int QSpinBox::value () const" +Returns the value of the spin box. See the "value" property for details. +.SH "void QSpinBox::valueChange ()\fC [virtual protected]\fR" +This virtual function is called by QRangeControl whenever the value has changed. The QSpinBox reimplementation updates the display and emits the valueChanged() signals; if you need additional processing, either reimplement this or connect to one of the valueChanged() signals. +.PP +Reimplemented from QRangeControl. +.SH "void QSpinBox::valueChanged ( int value )\fC [signal]\fR" +This signal is emitted every time the value of the spin box changes; the new value is passed in \fIvalue\fR. This signal will be emitted as a result of a call to setValue(), or because the user changed the value by using a keyboard accelerator or mouse click, etc. +.PP +Note that the valueChanged() signal is emitted \fIevery\fR time, not just for the "last" step; i.e. if the user clicks "up" three times, this signal is emitted three times. +.PP +See also value. +.PP +Examples: +.)l listbox/listbox.cpp, qfd/fontdisplayer.cpp, and scribble/scribble.cpp. +.SH "void QSpinBox::valueChanged ( const QString & valueText )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted whenever the valueChanged( int ) signal is emitted, i.e. every time the value of the spin box changes (whatever the cause, e.g. by setValue(), by a keyboard accelerator, by mouse clicks, etc.). +.PP +The \fIvalueText\fR parameter is the same string that is displayed in the edit field of the spin box. +.PP +See also value, prefix, suffix, and specialValueText. +.SH "bool QSpinBox::wrapping () const" +Returns TRUE if it is possible to step the value from the highest value to the lowest value and vice versa; otherwise returns FALSE. See the "wrapping" property for details. +.SS "Property Documentation" +.SH "ButtonSymbols buttonSymbols" +This property holds the current button symbol mode. +.PP +The possible values can be either UpDownArrows or PlusMinus. The default is UpDownArrows. +.PP +See also ButtonSymbols. +.PP +Set this property's value with setButtonSymbols() and get this property's value with buttonSymbols(). +.SH "QString cleanText" +This property holds the spin box's text with no prefix(), suffix() or leading or trailing whitespace. +.PP +Get this property's value with cleanText(). +.PP +See also text, prefix, and suffix. +.SH "int lineStep" +This property holds the line step. +.PP +When the user uses the arrows to change the spin box's value the value will be incremented/decremented by the amount of the line step. +.PP +The setLineStep() function calls the virtual stepChange() function if the new line step is different from the previous setting. +.PP +See also QRangeControl::setSteps() and setRange(). +.PP +Set this property's value with setLineStep() and get this property's value with lineStep(). +.SH "int maxValue" +This property holds the maximum value of the spin box. +.PP +When setting this property, QSpinBox::minValue is adjusted, if necessary, to ensure that the range remains valid. +.PP +See also setRange() and specialValueText. +.PP +Set this property's value with setMaxValue() and get this property's value with maxValue(). +.SH "int minValue" +This property holds the minimum value of the spin box. +.PP +When setting this property, QSpinBox::maxValue is adjusted, if necessary, to ensure that the range remains valid. +.PP +See also setRange() and specialValueText. +.PP +Set this property's value with setMinValue() and get this property's value with minValue(). +.SH "QString prefix" +This property holds the spin box's prefix. +.PP +The prefix is prepended to the start of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example: +.PP +.nf +.br + sb->setPrefix( "$" ); +.br +.fi +.PP +To turn off the prefix display, set this property to an empty string. The default is no prefix. The prefix is not displayed for the minValue() if specialValueText() is not empty. +.PP +If no prefix is set, prefix() returns QString::null. +.PP +See also suffix. +.PP +Set this property's value with setPrefix() and get this property's value with prefix(). +.SH "QString specialValueText" +This property holds the special-value text. +.PP +If set, the spin box will display this text instead of a numeric value whenever the current value is equal to minVal(). Typical use is to indicate that this choice has a special (default) meaning. +.PP +For example, if your spin box allows the user to choose the margin width in a print dialog and your application is able to automatically choose a good margin width, you can set up the spin box like this: +.PP +.nf +.br + QSpinBox marginBox( -1, 20, 1, parent, "marginBox" ); +.br + marginBox->setSuffix( " mm" ); +.br + marginBox->setSpecialValueText( "Auto" ); +.br +.fi +The user will then be able to choose a margin width from 0-20 millimeters or select "Auto" to leave it to the application to choose. Your code must then interpret the spin box value of -1 as the user requesting automatic margin width. +.PP +All values are displayed with the prefix() and suffix() (if set), \fIexcept\fR for the special value, which only shows the special value text. +.PP +To turn off the special-value text display, call this function with an empty string. The default is no special-value text, i.e. the numeric value is shown as usual. +.PP +If no special-value text is set, specialValueText() returns QString::null. +.PP +Set this property's value with setSpecialValueText() and get this property's value with specialValueText(). +.SH "QString suffix" +This property holds the suffix of the spin box. +.PP +The suffix is appended to the end of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example: +.PP +.nf +.br + sb->setSuffix( " km" ); +.br +.fi +.PP +To turn off the suffix display, set this property to an empty string. The default is no suffix. The suffix is not displayed for the minValue() if specialValueText() is not empty. +.PP +If no suffix is set, suffix() returns a QString::null. +.PP +See also prefix. +.PP +Set this property's value with setSuffix() and get this property's value with suffix(). +.SH "QString text" +This property holds the spin box's text, including any prefix() and suffix(). +.PP +There is no default text. +.PP +See also value. +.PP +Get this property's value with text(). +.SH "int value" +This property holds the value of the spin box. +.PP +Set this property's value with setValue() and get this property's value with value(). +.PP +See also QRangeControl::setValue(). +.SH "bool wrapping" +This property holds whether it is possible to step the value from the highest value to the lowest value and vice versa. +.PP +By default, wrapping is turned off. +.PP +If you have a range of 0..100 and wrapping is off when the user reaches 100 and presses the Up Arrow nothing will happen; but if wrapping is on the value will change from 100 to 0, then to 1, etc. When wrapping is on, navigating past the highest value takes you to the lowest and vice versa. +.PP +See also minValue, maxValue, and setRange(). +.PP +Set this property's value with setWrapping() and get this property's value with wrapping(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqspinbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqspinbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsplashscreen.3qt b/doc/man/man3/tqsplashscreen.3qt new file mode 100644 index 000000000..a41f2fd71 --- /dev/null +++ b/doc/man/man3/tqsplashscreen.3qt @@ -0,0 +1,182 @@ +'\" t +.TH QSplashScreen 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 +QSplashScreen \- Splash screen that can be shown during application startup +.SH SYNOPSIS +\fC#include <ntqsplashscreen.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSplashScreen\fR ( const QPixmap & pixmap = QPixmap ( ), WFlags f = 0 )" +.br +.ti -1c +.BI "virtual \fB~QSplashScreen\fR ()" +.br +.ti -1c +.BI "void \fBsetPixmap\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "QPixmap * \fBpixmap\fR () const" +.br +.ti -1c +.BI "void \fBfinish\fR ( QWidget * mainWin )" +.br +.ti -1c +.BI "void \fBrepaint\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBmessage\fR ( const QString & message, int alignment = AlignLeft, const QColor & color = black )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBmessageChanged\fR ( const QString & message )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * painter )" +.br +.in -1c +.SH DESCRIPTION +The QSplashScreen widget provides a splash screen that can be shown during application startup. +.PP +A splash screen is a widget that is usually displayed when an application is being started. Splash screens are often used for applications that have long start up times (e.g. database or networking applications that take time to establish connections) to provide the user with feedback that the application is loading. +.PP +The splash screen appears centered on the screen. It may be useful to add the WStyle_StaysOnTop if you desire to keep above all the windows in the GUI. +.PP +Some X11 window managers do not support the "stays on top" flag. A solution is to set up a timer that periodically calls raise() on the splash screen to simulate the "stays on top" effect. +.PP +The most common usage is to show a splash screen before the main widget is displayed on the screen. This is illustrated in the following code snippet. +.PP +.nf +.br + int main( int argc, char **argv ) +.br + { +.br + QApplication app( argc, argv ); +.br + QPixmap pixmap( "splash.png" ); +.br + QSplashScreen *splash = new QSplashScreen( pixmap ); +.br + splash->show(); +.br + QMainWindow *mainWin = new QMainWindow; +.br + ... +.br + app.setMainWidget( mainWin ); +.br + mainWin->show(); +.br + splash->finish( mainWin ); +.br + delete splash; +.br + return app.exec(); +.br + } +.br +.fi +.PP +It is sometimes useful to update the splash screen with messages, for example, announcing connections established or modules loaded as the application starts up. QSplashScreen supports this with the message() function. If you wish to do your own drawing you can get a pointer to the pixmap used in the splash screen with pixmap(). Alternatively, you can subclass QSplashScreen and reimplement drawContents(). +.PP +The user can hide the splash screen by clicking on it with the mouse. Since the splash screen is typically displayed before the event loop has started running, it is necessary to periodically call QApplication::processEvents() to receive the mouse clicks. +.PP +.nf +.br + QPixmap pixmap( "splash.png" ); +.br + QSplashScreen *splash = new QSplashScreen( pixmap ); +.br + splash->show(); +.br + ... // Loading some items +.br + splash->message( "Loaded modules" ); +.br + tqApp->processEvents(); +.br + ... // Establishing connections +.br + splash->message( "Established connections" ); +.br + tqApp->processEvents(); +.br +.fi +.PP +See also Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSplashScreen::QSplashScreen ( const QPixmap & pixmap = QPixmap ( ), WFlags f = 0 )" +Construct a splash screen that will display the \fIpixmap\fR. +.PP +There should be no need to set the widget flags, \fIf\fR, except perhaps WDestructiveClose or WStyle_StaysOnTop. +.SH "QSplashScreen::~QSplashScreen ()\fC [virtual]\fR" +Destructor. +.SH "void QSplashScreen::clear ()\fC [slot]\fR" +Removes the message being displayed on the splash screen +.PP +See also message(). +.SH "void QSplashScreen::drawContents ( QPainter * painter )\fC [virtual protected]\fR" +Draw the contents of the splash screen using painter \fIpainter\fR. The default implementation draws the message passed by message(). Reimplement this function if you want to do your own drawing on the splash screen. +.SH "void QSplashScreen::finish ( QWidget * mainWin )" +Makes the splash screen wait until the widget \fImainWin\fR is displayed before calling close() on itself. +.SH "void QSplashScreen::message ( const QString & message, int alignment = AlignLeft, const QColor & color = black )\fC [slot]\fR" +Draws the \fImessage\fR text onto the splash screen with color \fIcolor\fR and aligns the text according to the flags in \fIalignment\fR. +.PP +See also Qt::AlignmentFlags and clear(). +.SH "void QSplashScreen::messageChanged ( const QString & message )\fC [signal]\fR" +This signal is emitted when the message on the splash screen changes. \fImessage\fR is the new message and is a null-string when the message has been removed. +.PP +See also message() and clear(). +.SH "QPixmap * QSplashScreen::pixmap () const" +Returns the pixmap that is used in the splash screen. The image does not have any of the text drawn by message() calls. +.SH "void QSplashScreen::repaint ()" +This overrides QWidget::repaint(). It differs from the standard repaint function in that it also calls QApplication::flush() to ensure the updates are displayed, even when there is no event loop present. +.SH "void QSplashScreen::setPixmap ( const QPixmap & pixmap )" +Sets the pixmap that will be used as the splash screen's image to +\fIpixmap\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsplashscreen.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsplashscreen.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsplitter.3qt b/doc/man/man3/tqsplitter.3qt new file mode 100644 index 000000000..4e473bc48 --- /dev/null +++ b/doc/man/man3/tqsplitter.3qt @@ -0,0 +1,332 @@ +'\" t +.TH QSplitter 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 +QSplitter \- Implements a splitter widget +.SH SYNOPSIS +\fC#include <ntqsplitter.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBResizeMode\fR { Stretch, KeepSize, FollowSizeHint, Auto }" +.br +.ti -1c +.BI "\fBQSplitter\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQSplitter\fR ( Orientation o, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSplitter\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetOrientation\fR ( Orientation )" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "void \fBsetChildrenCollapsible\fR ( bool )" +.br +.ti -1c +.BI "bool \fBchildrenCollapsible\fR () const" +.br +.ti -1c +.BI "void \fBsetCollapsible\fR ( QWidget * w, bool collapse )" +.br +.ti -1c +.BI "virtual void \fBsetResizeMode\fR ( QWidget * w, ResizeMode mode )" +.br +.ti -1c +.BI "virtual void \fBsetOpaqueResize\fR ( bool = TRUE )" +.br +.ti -1c +.BI "bool \fBopaqueResize\fR () const" +.br +.ti -1c +.BI "void \fBmoveToFirst\fR ( QWidget * w )" +.br +.ti -1c +.BI "void \fBmoveToLast\fR ( QWidget * w )" +.br +.ti -1c +.BI "void \fBrefresh\fR ()" +.br +.ti -1c +.BI "QValueList<int> \fBsizes\fR () const" +.br +.ti -1c +.BI "void \fBsetSizes\fR ( QValueList<int> list )" +.br +.ti -1c +.BI "int \fBhandleWidth\fR () const" +.br +.ti -1c +.BI "void \fBsetHandleWidth\fR ( int )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBchildrenCollapsible\fR - whether child widgets can be resized down to size 0 by the user" +.br +.ti -1c +.BI "int \fBhandleWidth\fR - the width of the splitter handle" +.br +.ti -1c +.BI "bool \fBopaqueResize\fR - whether resizing is opaque" +.br +.ti -1c +.BI "Orientation \fBorientation\fR - the orientation of the splitter" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBchildEvent\fR ( QChildEvent * c )" +.br +.ti -1c +.BI "int \fBidAfter\fR ( QWidget * w ) const" +.br +.ti -1c +.BI "void \fBmoveSplitter\fR ( QCOORD p, int id )" +.br +.ti -1c +.BI "virtual void drawSplitter ( QPainter * p, QCOORD x, QCOORD y, QCOORD w, QCOORD h ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBadjustPos\fR ( int pos, int id )" +.br +.ti -1c +.BI "virtual void \fBsetRubberband\fR ( int p )" +.br +.ti -1c +.BI "void \fBgetRange\fR ( int id, int * min, int * max )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( QTextStream & ts, const QSplitter & splitter )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( QTextStream & ts, QSplitter & splitter )" +.br +.in -1c +.SH DESCRIPTION +The QSplitter class implements a splitter widget. +.PP +A splitter lets the user control the size of child widgets by dragging the boundary between the children. Any number of widgets may be controlled by a single splitter. +.PP +To show a QListBox, a QListView and a QTextEdit side by side: +.PP +.nf +.br + QSplitter *split = new QSplitter( parent ); +.br + QListBox *lb = new QListBox( split ); +.br + QListView *lv = new QListView( split ); +.br + QTextEdit *ed = new QTextEdit( split ); +.br +.fi +.PP +QSplitter lays out its children horizontally (side by side); you can use setOrientation(QSplitter::Vertical) to lay out the children vertically. +.PP +By default, all widgets can be as large or as small as the user wishes, between the minimumSizeHint() (or minimumSize()) and maximumSize() of the widgets. Use setResizeMode() to specify that a widget should keep its size when the splitter is resized, or set the stretch component of the sizePolicy. +.PP +Although QSplitter normally resizes the children only at the end of a resize operation, if you call setOpaqueResize(TRUE) the widgets are resized as often as possible. +.PP +The initial distribution of size between the widgets is determined by the initial size of each widget. You can also use setSizes() to set the sizes of all the widgets. The function sizes() returns the sizes set by the user. +.PP +If you hide() a child its space will be distributed among the other children. It will be reinstated when you show() it again. It is also possible to reorder the widgets within the splitter using moveToFirst() and moveToLast(). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QTabBar and Organizers. +.SS "Member Type Documentation" +.SH "QSplitter::ResizeMode" +This enum type describes how QSplitter will resize each of its child widgets. +.TP +\fCQSplitter::Auto\fR - The widget will be resized according to the stretch factors set in its sizePolicy(). +.TP +\fCQSplitter::Stretch\fR - The widget will be resized when the splitter itself is resized. +.TP +\fCQSplitter::KeepSize\fR - QSplitter will try to keep the widget's size unchanged. +.TP +\fCQSplitter::FollowSizeHint\fR - QSplitter will resize the widget when the widget's size hint changes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSplitter::QSplitter ( QWidget * parent = 0, const char * name = 0 )" +Constructs a horizontal splitter with the \fIparent\fR and \fIname\fR arguments being passed on to the QFrame constructor. +.SH "QSplitter::QSplitter ( Orientation o, QWidget * parent = 0, const char * name = 0 )" +Constructs a splitter with orientation \fIo\fR with the \fIparent\fR and \fIname\fR arguments being passed on to the QFrame constructor. +.SH "QSplitter::~QSplitter ()" +Destroys the splitter and any children. +.SH "int QSplitter::adjustPos ( int pos, int id )\fC [protected]\fR" +Returns the closest legal position to \fIpos\fR of the widget with ID \fIid\fR. +.PP +See also idAfter(). +.SH "void QSplitter::childEvent ( QChildEvent * c )\fC [virtual protected]\fR" +Tells the splitter that the child widget described by \fIc\fR has been inserted or removed. +.PP +Reimplemented from QObject. +.SH "bool QSplitter::childrenCollapsible () const" +Returns TRUE if child widgets can be resized down to size 0 by the user; otherwise returns FALSE. See the "childrenCollapsible" property for details. +.SH "void QSplitter::drawSplitter ( QPainter * p, QCOORD x, QCOORD y, QCOORD w, QCOORD h )\fC [virtual protected]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Draws the splitter handle in the rectangle described by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR using painter \fIp\fR. +.PP +See also QStyle::drawPrimitive(). +.SH "void QSplitter::getRange ( int id, int * min, int * max )\fC [protected]\fR" +Returns the valid range of the splitter with ID \fIid\fR in \fI*min\fR and \fI*max\fR if \fImin\fR and \fImax\fR are not 0. +.PP +See also idAfter(). +.SH "int QSplitter::handleWidth () const" +Returns the width of the splitter handle. See the "handleWidth" property for details. +.SH "int QSplitter::idAfter ( QWidget * w ) const\fC [protected]\fR" +Returns the ID of the widget to the right of or below the widget \fIw\fR, or 0 if there is no such widget (i.e. it is either not in this QSplitter or \fIw\fR is at the end). +.SH "void QSplitter::moveSplitter ( QCOORD p, int id )\fC [protected]\fR" +Moves the left/top edge of the splitter handle with ID \fIid\fR as close as possible to position \fIp\fR, which is the distance from the left (or top) edge of the widget. +.PP +For Arabic, Hebrew and other right-to-left languages the layout is reversed. \fIp\fR is then the distance from the right (or top) edge of the widget. +.PP +See also idAfter(). +.SH "void QSplitter::moveToFirst ( QWidget * w )" +Moves widget \fIw\fR to the leftmost/top position. +.PP +Example: splitter/splitter.cpp. +.SH "void QSplitter::moveToLast ( QWidget * w )" +Moves widget \fIw\fR to the rightmost/bottom position. +.SH "bool QSplitter::opaqueResize () const" +Returns TRUE if resizing is opaque; otherwise returns FALSE. See the "opaqueResize" property for details. +.SH "Orientation QSplitter::orientation () const" +Returns the orientation of the splitter. See the "orientation" property for details. +.SH "void QSplitter::refresh ()" +Updates the splitter's state. You should not need to call this function. +.SH "void QSplitter::setChildrenCollapsible ( bool )" +Sets whether child widgets can be resized down to size 0 by the user. See the "childrenCollapsible" property for details. +.SH "void QSplitter::setCollapsible ( QWidget * w, bool collapse )" +Sets whether the child widget \fIw\fR is collapsible to \fIcollapse\fR. +.PP +By default, children are collapsible, meaning that the user can resize them down to size 0, even if they have a non-zero minimumSize() or minimumSizeHint(). This behavior can be changed on a per-widget basis by calling this function, or globally for all the widgets in the splitter by setting the childrenCollapsible property. +.PP +See also childrenCollapsible. +.SH "void QSplitter::setHandleWidth ( int )" +Sets the width of the splitter handle. See the "handleWidth" property for details. +.SH "void QSplitter::setOpaqueResize ( bool = TRUE )\fC [virtual]\fR" +Sets whether resizing is opaque. See the "opaqueResize" property for details. +.SH "void QSplitter::setOrientation ( Orientation )\fC [virtual]\fR" +Sets the orientation of the splitter. See the "orientation" property for details. +.SH "void QSplitter::setResizeMode ( QWidget * w, ResizeMode mode )\fC [virtual]\fR" +Sets resize mode of widget \fIw\fR to \fImode\fR. (The default is Auto.) +.PP +Examples: +.)l fileiconview/mainwindow.cpp, listviews/listviews.cpp, and splitter/splitter.cpp. +.SH "void QSplitter::setRubberband ( int p )\fC [virtual protected]\fR" +Displays a rubber band at position \fIp\fR. If \fIp\fR is negative, the rubber band is removed. +.SH "void QSplitter::setSizes ( QValueList<int> list )" +Sets the size parameters to the values given in the \fIlist\fR. If the splitter is horizontal, the values set the widths of each widget going from left to right. If the splitter is vertical, the values set the heights of each widget going from top to bottom. Extra values in the \fIlist\fR are ignored. +.PP +If \fIlist\fR contains too few values, the result is undefined but the program will still be well-behaved. +.PP +Note that the values in \fIlist\fR should be the height/width that the widgets should be resized to. +.PP +See also sizes(). +.SH "QValueList<int> QSplitter::sizes () const" +Returns a list of the size parameters of all the widgets in this splitter. +.PP +If the splitter's orientation is horizontal, the list is a list of widget widths; if the orientation is vertical, the list is a list of widget heights. +.PP +Giving the values to another splitter's setSizes() function will produce a splitter with the same layout as this one. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<int> list = mySplitter.sizes(); +.br + QValueList<int>::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also setSizes(). +.SS "Property Documentation" +.SH "bool childrenCollapsible" +This property holds whether child widgets can be resized down to size 0 by the user. +.PP +By default, children are collapsible. It is possible to enable and disable the collapsing of individual children; see setCollapsible(). +.PP +Set this property's value with setChildrenCollapsible() and get this property's value with childrenCollapsible(). +.SH "int handleWidth" +This property holds the width of the splitter handle. +.PP +Set this property's value with setHandleWidth() and get this property's value with handleWidth(). +.SH "bool opaqueResize" +This property holds whether resizing is opaque. +.PP +Opaque resizing is off by default. +.PP +Set this property's value with setOpaqueResize() and get this property's value with opaqueResize(). +.SH "Orientation orientation" +This property holds the orientation of the splitter. +.PP +By default the orientation is horizontal (the widgets are side by side). The possible orientations are Horizontal and Vertical. +.PP +Set this property's value with setOrientation() and get this property's value with orientation(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QTextStream & operator<< ( QTextStream & ts, const QSplitter & splitter )" +Writes the sizes and the hidden state of the widgets in the splitter \fIsplitter\fR to the text stream \fIts\fR. +.PP +See also operator>>(), sizes(), and QWidget::hidden. +.SH "QTextStream & operator>> ( QTextStream & ts, QSplitter & splitter )" +Reads the sizes and the hidden state of the widgets in the splitter \fIsplitter\fR from the text stream \fIts\fR. The sizes must have been previously written by the operator<<() function. +.PP +See also operator<<(), setSizes(), and QWidget::hide(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsplitter.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsplitter.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsql.3qt b/doc/man/man3/tqsql.3qt new file mode 100644 index 000000000..a238b0ba0 --- /dev/null +++ b/doc/man/man3/tqsql.3qt @@ -0,0 +1,111 @@ +'\" t +.TH QSql 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 +QSql \- Namespace for Qt SQL identifiers that need to be global-like +.SH SYNOPSIS +\fC#include <ntqsql.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSql\fR ()" +.br +.ti -1c +.BI "enum \fBOp\fR { None = -1, Insert = 0, Update = 1, Delete = 2 }" +.br +.ti -1c +.BI "enum \fBLocation\fR { BeforeFirst = -1, AfterLast = -2 }" +.br +.ti -1c +.BI "enum \fBConfirm\fR { Cancel = -1, No = 0, Yes = 1 }" +.br +.ti -1c +.BI "enum \fBParameterType\fR { In = 1, Out = 2, InOut = 3 }" +.br +.ti -1c +.BI "enum \fBTableType\fR { Tables = 0x01, SystemTables = 0x02, Views = 0x04, AllTables = 0xff }" +.br +.in -1c +.SH DESCRIPTION +The QSql class is a namespace for Qt SQL identifiers that need to be global-like. +.PP +Normally, you can ignore this class. Several Qt SQL classes inherit it, so all the identifiers in the Qt SQL namespace are visible without qualification. +.PP +See also Database Classes. +.SS "Member Type Documentation" +.SH "QSql::Confirm" +This enum type describes edit confirmations. +.TP +\fCQSql::Yes\fR +.TP +\fCQSql::No\fR +.TP +\fCQSql::Cancel\fR +.SH "QSql::Location" +This enum type describes SQL navigation locations. +.TP +\fCQSql::BeforeFirst\fR +.TP +\fCQSql::AfterLast\fR +.SH "QSql::Op" +This enum type describes edit operations. +.TP +\fCQSql::None\fR +.TP +\fCQSql::Insert\fR +.TP +\fCQSql::Update\fR +.TP +\fCQSql::Delete\fR +.SH "QSql::ParameterType" +This enum is used to set the type of a bind parameter +.TP +\fCQSql::In\fR - the bind parameter is used to put data into the database +.TP +\fCQSql::Out\fR - the bind parameter is used to receive data from the database +.TP +\fCQSql::InOut\fR - the bind parameter is used to put data into the database; it will be overwritten with output data on executing a query. +.SH "QSql::TableType" +This enum type describes types of tables +.TP +\fCQSql::Tables\fR - All the tables visible to the user +.TP +\fCQSql::SystemTables\fR - Internal tables used by the DBMS +.TP +\fCQSql::Views\fR - All the views visible to the user +.TP +\fCQSql::AllTables\fR - All of the above +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSql::QSql ()" +Constructs a Qt SQL namespace class + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsql.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsql.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlcursor.3qt b/doc/man/man3/tqsqlcursor.3qt new file mode 100644 index 000000000..240899d82 --- /dev/null +++ b/doc/man/man3/tqsqlcursor.3qt @@ -0,0 +1,661 @@ +'\" t +.TH QSqlCursor 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 +QSqlCursor \- Browsing and editing of SQL tables and views +.SH SYNOPSIS +\fC#include <ntqsqlcursor.h>\fR +.PP +Inherits QSqlRecord and QSqlQuery. +.PP +Inherited by QSqlSelectCursor. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlCursor\fR ( const QString & name = QString::null, bool autopopulate = TRUE, QSqlDatabase * db = 0 )" +.br +.ti -1c +.BI "\fBQSqlCursor\fR ( const QSqlCursor & other )" +.br +.ti -1c +.BI "QSqlCursor & \fBoperator=\fR ( const QSqlCursor & other )" +.br +.ti -1c +.BI "\fB~QSqlCursor\fR ()" +.br +.ti -1c +.BI "enum \fBMode\fR { ReadOnly = 0, Insert = 1, Update = 2, Delete = 4, Writable = 7 }" +.br +.ti -1c +.BI "virtual QSqlIndex \fBprimaryIndex\fR ( bool setFromCursor = TRUE ) const" +.br +.ti -1c +.BI "virtual QSqlIndex \fBindex\fR ( const QStringList & fieldNames ) const" +.br +.ti -1c +.BI "QSqlIndex \fBindex\fR ( const QString & fieldName ) const" +.br +.ti -1c +.BI "QSqlIndex \fBindex\fR ( const char * fieldName ) const" +.br +.ti -1c +.BI "virtual void \fBsetPrimaryIndex\fR ( const QSqlIndex & idx )" +.br +.ti -1c +.BI "virtual void \fBappend\fR ( const QSqlFieldInfo & fieldInfo )" +.br +.ti -1c +.BI "virtual void \fBinsert\fR ( int pos, const QSqlFieldInfo & fieldInfo )" +.br +.ti -1c +.BI "virtual void \fBremove\fR ( int pos )" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetGenerated\fR ( const QString & name, bool generated )" +.br +.ti -1c +.BI "virtual void \fBsetGenerated\fR ( int i, bool generated )" +.br +.ti -1c +.BI "virtual QSqlRecord * \fBeditBuffer\fR ( bool copy = FALSE )" +.br +.ti -1c +.BI "virtual QSqlRecord * \fBprimeInsert\fR ()" +.br +.ti -1c +.BI "virtual QSqlRecord * \fBprimeUpdate\fR ()" +.br +.ti -1c +.BI "virtual QSqlRecord * \fBprimeDelete\fR ()" +.br +.ti -1c +.BI "virtual int \fBinsert\fR ( bool invalidate = TRUE )" +.br +.ti -1c +.BI "virtual int \fBupdate\fR ( bool invalidate = TRUE )" +.br +.ti -1c +.BI "virtual int \fBdel\fR ( bool invalidate = TRUE )" +.br +.ti -1c +.BI "virtual void \fBsetMode\fR ( int mode )" +.br +.ti -1c +.BI "int \fBmode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCalculated\fR ( const QString & name, bool calculated )" +.br +.ti -1c +.BI "bool \fBisCalculated\fR ( const QString & name ) const" +.br +.ti -1c +.BI "virtual void \fBsetTrimmed\fR ( const QString & name, bool trim )" +.br +.ti -1c +.BI "bool \fBisTrimmed\fR ( const QString & name ) const" +.br +.ti -1c +.BI "bool \fBisReadOnly\fR () const" +.br +.ti -1c +.BI "bool \fBcanInsert\fR () const" +.br +.ti -1c +.BI "bool \fBcanUpdate\fR () const" +.br +.ti -1c +.BI "bool \fBcanDelete\fR () const" +.br +.ti -1c +.BI "bool \fBselect\fR ()" +.br +.ti -1c +.BI "bool \fBselect\fR ( const QSqlIndex & sort )" +.br +.ti -1c +.BI "bool \fBselect\fR ( const QSqlIndex & filter, const QSqlIndex & sort )" +.br +.ti -1c +.BI "virtual bool \fBselect\fR ( const QString & filter, const QSqlIndex & sort = QSqlIndex ( ) )" +.br +.ti -1c +.BI "virtual void \fBsetSort\fR ( const QSqlIndex & sort )" +.br +.ti -1c +.BI "QSqlIndex \fBsort\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFilter\fR ( const QString & filter )" +.br +.ti -1c +.BI "QString \fBfilter\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetName\fR ( const QString & name, bool autopopulate = TRUE )" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR ( int i ) const" +.br +.ti -1c +.BI "bool \fBisNull\fR ( const QString & name ) const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QVariant \fBcalculateField\fR ( const QString & name )" +.br +.ti -1c +.BI "virtual int \fBupdate\fR ( const QString & filter, bool invalidate = TRUE )" +.br +.ti -1c +.BI "virtual int \fBdel\fR ( const QString & filter, bool invalidate = TRUE )" +.br +.ti -1c +.BI "virtual QString \fBtoString\fR ( const QString & prefix, QSqlField * field, const QString & fieldSep ) const" +.br +.ti -1c +.BI "virtual QString \fBtoString\fR ( QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const" +.br +.ti -1c +.BI "virtual QString \fBtoString\fR ( const QSqlIndex & i, QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const" +.br +.in -1c +.SH DESCRIPTION +The QSqlCursor class provides browsing and editing of SQL tables and views. +.PP +A QSqlCursor is a database record (see QSqlRecord) that corresponds to a table or view within an SQL database (see QSqlDatabase). There are two buffers in a cursor, one used for browsing and one used for editing records. Each buffer contains a list of fields which correspond to the fields in the table or view. +.PP +When positioned on a valid record, the browse buffer contains the values of the current record's fields from the database. The edit buffer is separate, and is used for editing existing records and inserting new records. +.PP +For browsing data, a cursor must first select() data from the database. After a successful select() the cursor is active (isActive() returns TRUE), but is initially not positioned on a valid record (isValid() returns FALSE). To position the cursor on a valid record, use one of the navigation functions, next(), prev(), first(), last(), or seek(). Once positioned on a valid record, data can be retrieved from the browse buffer using value(). If a navigation function is not successful, it returns FALSE, the cursor will no longer be positioned on a valid record and the values returned by value() are undefined. +.PP +For example: +.PP +.nf +.br + QSqlCursor cur( "staff" ); // Specify the table/view name +.br + cur.select(); // We'll retrieve every record +.br + while ( cur.next() ) { +.br + tqDebug( cur.value( "id" ).toString() + ": " + +.br + cur.value( "surname" ).toString() + " " + +.br + cur.value( "salary" ).toString() ); +.br + } +.fi +.PP +In the above example, a cursor is created specifying a table or view name in the database. Then, select() is called, which can be optionally parameterised to filter and order the records retrieved. Each record in the cursor is retrieved using next(). When next() returns FALSE, there are no more records to process, and the loop terminates. +.PP +For editing records (rows of data), a cursor contains a separate edit buffer which is independent of the fields used when browsing. The functions insert(), update() and del() operate on the edit buffer. This allows the cursor to be repositioned to other records while simultaneously maintaining a separate buffer for edits. You can get a pointer to the edit buffer using editBuffer(). The primeInsert(), primeUpdate() and primeDelete() functions also return a pointer to the edit buffer and prepare it for insert, update and delete respectively. Edit operations only affect a single row at a time. Note that update() and del() require that the table or view contain a primaryIndex() to ensure that edit operations affect a unique record within the database. +.PP +For example: +.PP +.nf +.br + QSqlCursor cur( "prices" ); +.br + cur.select( "id=202" ); +.br + if ( cur.next() ) { +.br + QSqlRecord *buffer = cur.primeUpdate(); +.br + double price = buffer->value( "price" ).toDouble(); +.br + double newprice = price * 1.05; +.br + buffer->setValue( "price", newprice ); +.br + cur.update(); +.br + } +.fi +.PP +To edit an existing database record, first move to the record you wish to update. Call primeUpdate() to get the pointer to the cursor's edit buffer. Then use this pointer to modify the values in the edit buffer. Finally, call update() to save the changes to the database. The values in the edit buffer will be used to locate the appropriate record when updating the database (see primaryIndex()). +.PP +Similarly, when deleting an existing database record, first move to the record you wish to delete. Then, call primeDelete() to get the pointer to the edit buffer. Finally, call del() to delete the record from the database. Again, the values in the edit buffer will be used to locate and delete the appropriate record. +.PP +To insert a new record, call primeInsert() to get the pointer to the edit buffer. Use this pointer to populate the edit buffer with new values and then insert() the record into the database. +.PP +After calling insert(), update() or del(), the cursor is no longer positioned on a valid record and can no longer be navigated (isValid() return FALSE). The reason for this is that any changes made to the database will not be visible until select() is called to refresh the cursor. You can change this behavior by passing FALSE to insert(), update() or del() which will prevent the cursor from becoming invalid. The edits will still not be visible when navigating the cursor until select() is called. +.PP +QSqlCursor contains virtual methods which allow editing behavior to be customized by subclasses. This allows custom cursors to be created that encapsulate the editing behavior of a database table for an entire application. For example, a cursor can be customized to always auto-number primary index fields, or provide fields with suitable default values, when inserting new records. QSqlCursor generates SQL statements which are sent to the database engine; you can control which fields are included in these statements using setGenerated(). +.PP +Note that QSqlCursor does not inherit from QObject. This means that you are responsible for destroying instances of this class yourself. However if you create a QSqlCursor and use it in a QDataTable, QDataBrowser or a QDataView these classes will usually take ownership of the cursor and destroy it when they don't need it anymore. The documentation for QDataTable, QDataBrowser and QDataView explicitly states which calls take ownership of the cursor. +.PP +See also Database Classes. +.SS "Member Type Documentation" +.SH "QSqlCursor::Mode" +This enum type describes how QSqlCursor operates on records in the database. +.TP +\fCQSqlCursor::ReadOnly\fR - the cursor can only SELECT records from the database. +.TP +\fCQSqlCursor::Insert\fR - the cursor can INSERT records into the database. +.TP +\fCQSqlCursor::Update\fR - the cursor can UPDATE records in the database. +.TP +\fCQSqlCursor::Delete\fR - the cursor can DELETE records from the database. +.TP +\fCQSqlCursor::Writable\fR - the cursor can INSERT, UPDATE and DELETE records in the database. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlCursor::QSqlCursor ( const QString & name = QString::null, bool autopopulate = TRUE, QSqlDatabase * db = 0 )" +Constructs a cursor on database \fIdb\fR using table or view \fIname\fR. +.PP +If \fIautopopulate\fR is TRUE (the default), the \fIname\fR of the cursor must correspond to an existing table or view name in the database so that field information can be automatically created. If the table or view does not exist, the cursor will not be functional. +.PP +The cursor is created with an initial mode of QSqlCursor::Writable (meaning that records can be inserted, updated or deleted using the cursor). If the cursor does not have a unique primary index, update and deletes cannot be performed. +.PP +Note that \fIautopopulate\fR refers to populating the cursor with meta-data, e.g. the names of the table's fields, not with retrieving data. The select() function is used to populate the cursor with data. +.PP +See also setName() and setMode(). +.SH "QSqlCursor::QSqlCursor ( const QSqlCursor & other )" +Constructs a copy of \fIother\fR. +.SH "QSqlCursor::~QSqlCursor ()" +Destroys the object and frees any allocated resources. +.SH "void QSqlCursor::append ( const QSqlFieldInfo & fieldInfo )\fC [virtual]\fR" +Append a copy of field \fIfieldInfo\fR to the end of the cursor. Note that all references to the cursor edit buffer become invalidated. +.SH "QVariant QSqlCursor::calculateField ( const QString & name )\fC [virtual protected]\fR" +Protected virtual function which is called whenever a field needs to be calculated. If calculated fields are being used, derived classes must reimplement this function and return the appropriate value for field \fIname\fR. The default implementation returns an invalid QVariant. +.PP +See also setCalculated(). +.PP +Examples: +.)l sql/overview/subclass3/main.cpp and sql/overview/subclass4/main.cpp. +.SH "bool QSqlCursor::canDelete () const" +Returns TRUE if the cursor will perform deletes; otherwise returns FALSE. +.PP +See also setMode(). +.SH "bool QSqlCursor::canInsert () const" +Returns TRUE if the cursor will perform inserts; otherwise returns FALSE. +.PP +See also setMode(). +.SH "bool QSqlCursor::canUpdate () const" +Returns TRUE if the cursor will perform updates; otherwise returns FALSE. +.PP +See also setMode(). +.SH "void QSqlCursor::clear ()\fC [virtual]\fR" +Removes all fields from the cursor. Note that all references to the cursor edit buffer become invalidated. +.PP +Reimplemented from QSqlRecord. +.SH "int QSqlCursor::del ( bool invalidate = TRUE )\fC [virtual]\fR" +Deletes a record from the database using the cursor's primary index and the contents of the cursor edit buffer. Returns the number of records which were deleted. For error information, use lastError(). +.PP +Only records which meet the filter criteria specified by the cursor's primary index are deleted. If the cursor does not contain a primary index, no delete is performed and 0 is returned. If \fIinvalidate\fR is TRUE (the default), the current cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. For example: +.PP +.nf +.br + QSqlCursor cur( "prices" ); +.br + cur.select( "id=999" ); +.br + if ( cur.next() ) { +.br + cur.primeDelete(); +.br + cur.del(); +.br + } +.fi +.PP +In the above example, a cursor is created on the 'prices' table and positioned to the record to be deleted. First primeDelete() is called to populate the edit buffer with the current cursor values, e.g. with an id of 999, and then del() is called to actually delete the record from the database. Remember: all edit operations (insert(), update() and delete()) operate on the contents of the cursor edit buffer and not on the contents of the cursor itself. +.PP +See also primeDelete(), setMode(), and lastError(). +.PP +Example: sql/overview/delete/main.cpp. +.SH "int QSqlCursor::del ( const QString & filter, bool invalidate = TRUE )\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Deletes the current cursor record from the database using the filter \fIfilter\fR. Only records which meet the filter criteria are deleted. Returns the number of records which were deleted. If \fIinvalidate\fR is TRUE (the default), the current cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. For error information, use lastError(). +.PP +The \fIfilter\fR is an SQL \fCWHERE\fR clause, e.g. \fCid=500\fR. +.PP +See also setMode() and lastError(). +.SH "QSqlRecord * QSqlCursor::editBuffer ( bool copy = FALSE )\fC [virtual]\fR" +Returns the current internal edit buffer. If \fIcopy\fR is TRUE (the default is FALSE), the current cursor field values are first copied into the edit buffer. The edit buffer is valid as long as the cursor remains valid. The cursor retains ownership of the returned pointer, so it must not be deleted or modified. +.PP +See also primeInsert(), primeUpdate(), and primeDelete(). +.SH "QString QSqlCursor::filter () const" +Returns the current filter, or an empty string if there is no current filter. +.SH "QSqlIndex QSqlCursor::index ( const QStringList & fieldNames ) const\fC [virtual]\fR" +Returns an index composed of \fIfieldNames\fR, all in ASCending order. Note that all field names must exist in the cursor, otherwise an empty index is returned. +.PP +See also QSqlIndex. +.PP +Examples: +.)l sql/overview/extract/main.cpp, sql/overview/order1/main.cpp, sql/overview/order2/main.cpp, and sql/overview/table3/main.cpp. +.SH "QSqlIndex QSqlCursor::index ( const QString & fieldName ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an index based on \fIfieldName\fR. +.SH "QSqlIndex QSqlCursor::index ( const char * fieldName ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an index based on \fIfieldName\fR. +.SH "void QSqlCursor::insert ( int pos, const QSqlFieldInfo & fieldInfo )\fC [virtual]\fR" +Insert a copy of \fIfieldInfo\fR at position \fIpos\fR. If a field already exists at \fIpos\fR, it is removed. Note that all references to the cursor edit buffer become invalidated. +.PP +Examples: +.)l sql/overview/insert/main.cpp and sql/overview/insert2/main.cpp. +.SH "int QSqlCursor::insert ( bool invalidate = TRUE )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the current contents of the cursor's edit record buffer into the database, if the cursor allows inserts. Returns the number of rows affected by the insert. For error information, use lastError(). +.PP +If \fIinvalidate\fR is TRUE (the default), the cursor will no longer be positioned on a valid record and can no longer be navigated. A new select() call must be made before navigating to a valid record. +.PP +.nf +.br + QSqlCursor cur( "prices" ); +.br + QSqlRecord *buffer = cur.primeInsert(); +.br + buffer->setValue( "id", 53981 ); +.br + buffer->setValue( "name", "Thingy" ); +.br + buffer->setValue( "price", 105.75 ); +.br + cur.insert(); +.fi +.PP +In the above example, a cursor is created on the 'prices' table and a pointer to the insert buffer is acquired using primeInsert(). Each field's value is set to the desired value and then insert() is called to insert the data into the database. Remember: all edit operations (insert(), update() and delete()) operate on the contents of the cursor edit buffer and not on the contents of the cursor itself. +.PP +See also setMode() and lastError(). +.SH "bool QSqlCursor::isCalculated ( const QString & name ) const" +Returns TRUE if the field \fIname\fR exists and is calculated; otherwise returns FALSE. +.PP +See also setCalculated(). +.SH "bool QSqlCursor::isNull ( int i ) const" +Returns TRUE if the field \fIi\fR is NULL or if there is no field at position \fIi\fR; otherwise returns FALSE. +.PP +This is the same as calling QSqlRecord::isNull( \fIi\fR ) +.SH "bool QSqlCursor::isNull ( const QString & name ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the field called \fIname\fR is NULL or if there is no field called \fIname\fR; otherwise returns FALSE. +.PP +This is the same as calling QSqlRecord::isNull( \fIname\fR ) +.SH "bool QSqlCursor::isReadOnly () const" +Returns TRUE if the cursor is read-only; otherwise returns FALSE. The default is FALSE. Read-only cursors cannot be edited using insert(), update() or del(). +.PP +See also setMode(). +.SH "bool QSqlCursor::isTrimmed ( const QString & name ) const" +Returns TRUE if the field \fIname\fR exists and is trimmed; otherwise returns FALSE. +.PP +When a trimmed field of type string or cstring is read from the database any trailing (right-most) spaces are removed. +.PP +See also setTrimmed(). +.SH "int QSqlCursor::mode () const" +Returns the current cursor mode. +.PP +See also setMode(). +.SH "QString QSqlCursor::name () const" +Returns the name of the cursor. +.SH "QSqlCursor & QSqlCursor::operator= ( const QSqlCursor & other )" +Sets the cursor equal to \fIother\fR. +.SH "QSqlIndex QSqlCursor::primaryIndex ( bool setFromCursor = TRUE ) const\fC [virtual]\fR" +Returns the primary index associated with the cursor as defined in the database, or an empty index if there is no primary index. If \fIsetFromCursor\fR is TRUE (the default), the index fields are populated with the corresponding values in the cursor's current record. +.SH "QSqlRecord * QSqlCursor::primeDelete ()\fC [virtual]\fR" +This function primes the edit buffer's field values for delete and returns the edit buffer. The default implementation copies the field values from the current cursor record into the edit buffer (therefore, this function is equivalent to calling editBuffer( TRUE ) ). The cursor retains ownership of the returned pointer, so it must not be deleted or modified. +.PP +See also editBuffer() and del(). +.PP +Example: sql/overview/delete/main.cpp. +.SH "QSqlRecord * QSqlCursor::primeInsert ()\fC [virtual]\fR" +This function primes the edit buffer's field values for insert and returns the edit buffer. The default implementation clears all field values in the edit buffer. The cursor retains ownership of the returned pointer, so it must not be deleted or modified. +.PP +See also editBuffer() and insert(). +.PP +Examples: +.)l sql/overview/insert/main.cpp, sql/overview/insert2/main.cpp, sql/overview/subclass5/main.cpp, and sql/sqltable/main.cpp. +.SH "QSqlRecord * QSqlCursor::primeUpdate ()\fC [virtual]\fR" +This function primes the edit buffer's field values for update and returns the edit buffer. The default implementation copies the field values from the current cursor record into the edit buffer (therefore, this function is equivalent to calling editBuffer( TRUE ) ). The cursor retains ownership of the returned pointer, so it must not be deleted or modified. +.PP +See also editBuffer() and update(). +.PP +Examples: +.)l sql/overview/custom1/main.cpp, sql/overview/form1/main.cpp, and sql/overview/update/main.cpp. +.SH "void QSqlCursor::remove ( int pos )\fC [virtual]\fR" +Removes the field at \fIpos\fR. If \fIpos\fR does not exist, nothing happens. Note that all references to the cursor edit buffer become invalidated. +.PP +Reimplemented from QSqlRecord. +.SH "bool QSqlCursor::select ( const QString & filter, const QSqlIndex & sort = QSqlIndex ( ) )\fC [virtual]\fR" +Selects all fields in the cursor from the database matching the filter criteria \fIfilter\fR. The data is returned in the order specified by the index \fIsort\fR. Returns TRUE if the data was successfully selected; otherwise returns FALSE. +.PP +The \fIfilter\fR is a string containing a SQL \fCWHERE\fR clause but without the 'WHERE' keyword. The cursor is initially positioned at an invalid row after this function is called. To move to a valid row, use seek(), first(), last(), prev() or next(). +.PP +Example: +.PP +.nf +.br + QSqlCursor cur( "Employee" ); // Use the Employee table or view +.br + cur.select( "deptno=10" ); // select all records in department 10 +.br + while( cur.next() ) { +.br + ... // process data +.br + } +.br + ... +.br + // select records in other departments, ordered by department number +.br + cur.select( "deptno>10", cur.index( "deptno" ) ); +.br + ... +.br +.fi +.PP +The filter will apply to any subsequent select() calls that do not explicitly specify another filter. Similarly the sort will apply to any subsequent select() calls that do not explicitly specify another sort. +.PP +.nf +.br + QSqlCursor cur( "Employee" ); +.br + cur.select( "deptno=10" ); // select all records in department 10 +.br + while( cur.next() ) { +.br + ... // process data +.br + } +.br + ... +.br + cur.select(); // re-selects all records in department 10 +.br + ... +.br +.fi +.PP +Examples: +.)l sql/overview/delete/main.cpp, sql/overview/extract/main.cpp, sql/overview/order1/main.cpp, sql/overview/order2/main.cpp, sql/overview/retrieve2/main.cpp, sql/overview/table3/main.cpp, and sql/overview/update/main.cpp. +.SH "bool QSqlCursor::select ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Selects all fields in the cursor from the database. The rows are returned in the order specified by the last call to setSort() or the last call to select() that specified a sort, whichever is the most recent. If there is no current sort, the order in which the rows are returned is undefined. The records are filtered according to the filter specified by the last call to setFilter() or the last call to select() that specified a filter, whichever is the most recent. If there is no current filter, all records are returned. The cursor is initially positioned at an invalid row. To move to a valid row, use seek(), first(), last(), prev() or next(). +.PP +See also setSort() and setFilter(). +.SH "bool QSqlCursor::select ( const QSqlIndex & sort )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Selects all fields in the cursor from the database. The data is returned in the order specified by the index \fIsort\fR. The records are filtered according to the filter specified by the last call to setFilter() or the last call to select() that specified a filter, whichever is the most recent. The cursor is initially positioned at an invalid row. To move to a valid row, use seek(), first(), last(), prev() or next(). +.SH "bool QSqlCursor::select ( const QSqlIndex & filter, const QSqlIndex & sort )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Selects all fields in the cursor matching the filter index \fIfilter\fR. The data is returned in the order specified by the index \fIsort\fR. The \fIfilter\fR index works by constructing a WHERE clause using the names of the fields from the \fIfilter\fR and their values from the current cursor record. The cursor is initially positioned at an invalid row. To move to a valid row, use seek(), first(), last(), prev() or next(). This function is useful, for example, for retrieving data based upon a table's primary index: +.PP +.nf +.br + QSqlCursor cur( "Employee" ); +.br + QSqlIndex pk = cur.primaryIndex(); +.br + cur.setValue( "id", 10 ); +.br + cur.select( pk, pk ); // generates "SELECT ... FROM Employee WHERE id=10 ORDER BY id" +.br + ... +.br +.fi +.PP +In this example the QSqlIndex, pk, is used for two different purposes. When used as the filter (first) argument, the field names it contains are used to construct the WHERE clause, each set to the current cursor value, \fCWHERE id=10\fR, in this case. When used as the sort (second) argument the field names it contains are used for the ORDER BY clause, \fCORDER BY id\fR in this example. +.SH "void QSqlCursor::setCalculated ( const QString & name, bool calculated )\fC [virtual]\fR" +Sets field \fIname\fR to \fIcalculated\fR. If the field \fIname\fR does not exist, nothing happens. The value of a calculated field is set by the calculateField() virtual function which you must reimplement (or the field value will be an invalid QVariant). Calculated fields do not appear in generated SQL statements sent to the database. +.PP +See also calculateField() and QSqlRecord::setGenerated(). +.SH "void QSqlCursor::setFilter ( const QString & filter )\fC [virtual]\fR" +Sets the current filter to \fIfilter\fR. Note that no new records are selected. To select new records, use select(). The \fIfilter\fR will apply to any subsequent select() calls that do not explicitly specify a filter. +.PP +The filter is a SQL \fCWHERE\fR clause without the keyword 'WHERE', e.g. \fCname='Dave'\fR which will be processed by the DBMS. +.SH "void QSqlCursor::setGenerated ( const QString & name, bool generated )\fC [virtual]\fR" +Sets the generated flag for the field \fIname\fR to \fIgenerated\fR. If the field does not exist, nothing happens. Only fields that have \fIgenerated\fR set to TRUE are included in the SQL that is generated by insert(), update() or del(). +.PP +See also isGenerated(). +.PP +Reimplemented from QSqlRecord. +.SH "void QSqlCursor::setGenerated ( int i, bool generated )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the generated flag for the field \fIi\fR to \fIgenerated\fR. +.PP +See also isGenerated(). +.PP +Reimplemented from QSqlRecord. +.SH "void QSqlCursor::setMode ( int mode )\fC [virtual]\fR" +Sets the cursor mode to \fImode\fR. This value can be an OR'ed combination of QSqlCursor::Mode values. The default mode for a cursor is QSqlCursor::Writable. +.PP +.nf +.br + QSqlCursor cur( "Employee" ); +.br + cur.setMode( QSqlCursor::Writable ); // allow insert/update/delete +.br + ... +.br + cur.setMode( QSqlCursor::Insert | QSqlCursor::Update ); // allow inserts and updates only +.br + ... +.br + cur.setMode( QSqlCursor::ReadOnly ); // no inserts/updates/deletes allowed +.br +.br +.fi +.SH "void QSqlCursor::setName ( const QString & name, bool autopopulate = TRUE )\fC [virtual]\fR" +Sets the name of the cursor to \fIname\fR. If \fIautopopulate\fR is TRUE (the default), the \fIname\fR must correspond to a valid table or view name in the database. Also, note that all references to the cursor edit buffer become invalidated when fields are auto-populated. See the QSqlCursor constructor documentation for more information. +.SH "void QSqlCursor::setPrimaryIndex ( const QSqlIndex & idx )\fC [virtual]\fR" +Sets the primary index associated with the cursor to the index \fIidx\fR. Note that this index must contain a field or set of fields which identify a unique record within the underlying database table or view so that update() and del() will execute as expected. +.PP +See also update() and del(). +.SH "void QSqlCursor::setSort ( const QSqlIndex & sort )\fC [virtual]\fR" +Sets the current sort to \fIsort\fR. Note that no new records are selected. To select new records, use select(). The \fIsort\fR will apply to any subsequent select() calls that do not explicitly specify a sort. +.SH "void QSqlCursor::setTrimmed ( const QString & name, bool trim )\fC [virtual]\fR" +Sets field \fIname\fR's trimmed status to \fItrim\fR. If the field \fIname\fR does not exist, nothing happens. +.PP +When a trimmed field of type string or cstring is read from the database any trailing (right-most) spaces are removed. +.PP +See also isTrimmed() and QVariant. +.SH "QSqlIndex QSqlCursor::sort () const" +Returns the current sort, or an empty index if there is no current sort. +.SH "QString QSqlCursor::toString ( QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const\fC [virtual protected]\fR" +Returns a formatted string composed of all the fields in \fIrec\fR. Each field is composed of the \fIprefix\fR (e.g. table or view name)," +.", the field name, the \fIfieldSep\fR and the field value. If the +\fIprefix\fR is empty then each field will begin with the field name. The fields are then joined together separated by \fIsep\fR. Fields where isGenerated() returns FALSE are not included. This function is useful for generating SQL statements. +.SH "QString QSqlCursor::toString ( const QString & prefix, QSqlField * field, const QString & fieldSep ) const\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a formatted string composed of the \fIprefix\fR (e.g. table or view name), ".", the \fIfield\fR name, the \fIfieldSep\fR and the field value. If the \fIprefix\fR is empty then the string will begin with the \fIfield\fR name. This function is useful for generating SQL statements. +.SH "QString QSqlCursor::toString ( const QSqlIndex & i, QSqlRecord * rec, const QString & prefix, const QString & fieldSep, const QString & sep ) const\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a formatted string composed of all the fields in the index \fIi\fR. Each field is composed of the \fIprefix\fR (e.g. table or view name), ".", the field name, the \fIfieldSep\fR and the field value. If the \fIprefix\fR is empty then each field will begin with the field name. The field values are taken from \fIrec\fR. The fields are then joined together separated by \fIsep\fR. Fields where isGenerated() returns FALSE are ignored. This function is useful for generating SQL statements. +.SH "int QSqlCursor::update ( bool invalidate = TRUE )\fC [virtual]\fR" +Updates the database with the current contents of the edit buffer. Returns the number of records which were updated. For error information, use lastError(). +.PP +Only records which meet the filter criteria specified by the cursor's primary index are updated. If the cursor does not contain a primary index, no update is performed and 0 is returned. +.PP +If \fIinvalidate\fR is TRUE (the default), the current cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. For example: +.PP +.nf +.br + QSqlCursor cur( "prices" ); +.br + cur.select( "id=202" ); +.br + if ( cur.next() ) { +.br + QSqlRecord *buffer = cur.primeUpdate(); +.br + double price = buffer->value( "price" ).toDouble(); +.br + double newprice = price * 1.05; +.br + buffer->setValue( "price", newprice ); +.br + cur.update(); +.br + } +.fi +.PP +In the above example, a cursor is created on the 'prices' table and is positioned on the record to be updated. Then a pointer to the cursor's edit buffer is acquired using primeUpdate(). A new value is calculated and placed into the edit buffer with the setValue() call. Finally, an update() call is made on the cursor which uses the tables's primary index to update the record in the database with the contents of the cursor's edit buffer. Remember: all edit operations (insert(), update() and delete()) operate on the contents of the cursor edit buffer and not on the contents of the cursor itself. +.PP +Note that if the primary index does not uniquely distinguish records the database may be changed into an inconsistent state. +.PP +See also setMode() and lastError(). +.PP +Example: sql/overview/update/main.cpp. +.SH "int QSqlCursor::update ( const QString & filter, bool invalidate = TRUE )\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Updates the database with the current contents of the cursor edit buffer using the specified \fIfilter\fR. Returns the number of records which were updated. For error information, use lastError(). +.PP +Only records which meet the filter criteria are updated, otherwise all records in the table are updated. +.PP +If \fIinvalidate\fR is TRUE (the default), the cursor can no longer be navigated. A new select() call must be made before you can move to a valid record. +.PP +See also primeUpdate(), setMode(), and lastError(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlcursor.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlcursor.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqldatabase.3qt b/doc/man/man3/tqsqldatabase.3qt new file mode 100644 index 000000000..72a7c19af --- /dev/null +++ b/doc/man/man3/tqsqldatabase.3qt @@ -0,0 +1,666 @@ +'\" t +.TH QSqlDatabase 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 +QSqlDatabase \- Used to create SQL database connections and to provide transaction handling +.SH SYNOPSIS +\fC#include <ntqsqldatabase.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fB~QSqlDatabase\fR ()" +.br +.ti -1c +.BI "bool \fBopen\fR ()" +.br +.ti -1c +.BI "bool \fBopen\fR ( const QString & user, const QString & password )" +.br +.ti -1c +.BI "void \fBclose\fR ()" +.br +.ti -1c +.BI "bool \fBisOpen\fR () const" +.br +.ti -1c +.BI "bool \fBisOpenError\fR () const" +.br +.ti -1c +.BI "QStringList \fBtables\fR () const" +.br +.ti -1c +.BI "QStringList \fBtables\fR ( QSql::TableType type ) const" +.br +.ti -1c +.BI "QSqlIndex \fBprimaryIndex\fR ( const QString & tablename ) const" +.br +.ti -1c +.BI "QSqlRecord \fBrecord\fR ( const QString & tablename ) const" +.br +.ti -1c +.BI "QSqlRecord \fBrecord\fR ( const QSqlQuery & query ) const" +.br +.ti -1c +.BI "QSqlRecordInfo \fBrecordInfo\fR ( const QString & tablename ) const" +.br +.ti -1c +.BI "QSqlRecordInfo \fBrecordInfo\fR ( const QSqlQuery & query ) const" +.br +.ti -1c +.BI "QSqlQuery \fBexec\fR ( const QString & query = QString::null ) const" +.br +.ti -1c +.BI "QSqlError \fBlastError\fR () const" +.br +.ti -1c +.BI "bool \fBtransaction\fR ()" +.br +.ti -1c +.BI "bool \fBcommit\fR ()" +.br +.ti -1c +.BI "bool \fBrollback\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetDatabaseName\fR ( const QString & name )" +.br +.ti -1c +.BI "virtual void \fBsetUserName\fR ( const QString & name )" +.br +.ti -1c +.BI "virtual void \fBsetPassword\fR ( const QString & password )" +.br +.ti -1c +.BI "virtual void \fBsetHostName\fR ( const QString & host )" +.br +.ti -1c +.BI "virtual void \fBsetPort\fR ( int p )" +.br +.ti -1c +.BI "void \fBsetConnectOptions\fR ( const QString & options = QString::null )" +.br +.ti -1c +.BI "QString \fBdatabaseName\fR () const" +.br +.ti -1c +.BI "QString \fBuserName\fR () const" +.br +.ti -1c +.BI "QString \fBpassword\fR () const" +.br +.ti -1c +.BI "QString \fBhostName\fR () const" +.br +.ti -1c +.BI "QString \fBdriverName\fR () const" +.br +.ti -1c +.BI "int \fBport\fR () const" +.br +.ti -1c +.BI "QString \fBconnectOptions\fR () const" +.br +.ti -1c +.BI "QSqlDriver * \fBdriver\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QSqlDatabase * \fBaddDatabase\fR ( const QString & type, const QString & connectionName = defaultConnection )" +.br +.ti -1c +.BI "QSqlDatabase * \fBaddDatabase\fR ( QSqlDriver * driver, const QString & connectionName = defaultConnection )" +.br +.ti -1c +.BI "QSqlDatabase * \fBdatabase\fR ( const QString & connectionName = defaultConnection, bool open = TRUE )" +.br +.ti -1c +.BI "void \fBremoveDatabase\fR ( const QString & connectionName )" +.br +.ti -1c +.BI "void \fBremoveDatabase\fR ( QSqlDatabase * db )" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QString & connectionName = defaultConnection )" +.br +.ti -1c +.BI "QStringList \fBdrivers\fR ()" +.br +.ti -1c +.BI "void \fBregisterSqlDriver\fR ( const QString & name, const QSqlDriverCreatorBase * creator )" +.br +.ti -1c +.BI "bool \fBisDriverAvailable\fR ( const QString & name )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QString \fBconnectOptions\fR - the database connect options" +.br +.ti -1c +.BI "QString \fBdatabaseName\fR - the name of the database" +.br +.ti -1c +.BI "QString \fBhostName\fR - the host name where the database resides" +.br +.ti -1c +.BI "QString \fBpassword\fR - the password used to connect to the database" +.br +.ti -1c +.BI "int \fBport\fR - the port used to connect to the database" +.br +.ti -1c +.BI "QString \fBuserName\fR - the user name connected to the database" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQSqlDatabase\fR ( const QString & type, const QString & name, QObject * parent = 0, const char * objname = 0 )" +.br +.ti -1c +.BI "\fBQSqlDatabase\fR ( QSqlDriver * driver, QObject * parent = 0, const char * objname = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QSqlDatabase class is used to create SQL database connections and to provide transaction handling. +.PP +Note that transaction handling is not supported by every SQL database. You can find out whether transactions are supported using QSqlDriver::hasFeature(). +.PP +The QSqlDatabase class provides an abstract interface for accessing many types of database backends. Database-specific drivers are used internally to actually access and manipulate data, (see QSqlDriver). Result set objects provide the interface for executing and manipulating SQL queries (see QSqlQuery). +.PP +See also Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlDatabase::QSqlDatabase ( const QString & type, const QString & name, QObject * parent = 0, const char * objname = 0 )\fC [protected]\fR" +Creates a QSqlDatabase connection called \fIname\fR that uses the driver referred to by \fItype\fR, with the parent \fIparent\fR and the object name \fIobjname\fR. If the \fItype\fR is not recognized, the database connection will have no functionality. +.PP +The currently available drivers are: +.PP +<center>.nf +.TS +l - l. Driver Type Description QODBC3 ODBC Driver (includes Microsoft SQL Server) QOCI8 Oracle Call Interface Driver QPSQL7 PostgreSQL v6.x and v7.x Driver QTDS7 Sybase Adaptive Server QMYSQL3 MySQL Driver QDB2 IBM DB2, v7.1 and higher QSQLITE SQLite Driver QIBASE +.TE +.fi +</center> +.PP +Additional third party drivers, including your own custom drivers, can be loaded dynamically. +.PP +See also registerSqlDriver(). +.SH "QSqlDatabase::QSqlDatabase ( QSqlDriver * driver, QObject * parent = 0, const char * objname = 0 )\fC [protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Creates a database connection using the driver \fIdriver\fR, with the parent \fIparent\fR and the object name \fIobjname\fR. +.PP +\fBWarning:\fR The framework takes ownership of the \fIdriver\fR pointer, so it should not be deleted. +.SH "QSqlDatabase::~QSqlDatabase ()" +Destroys the object and frees any allocated resources. +.SH "QSqlDatabase * QSqlDatabase::addDatabase ( const QString & type, const QString & connectionName = defaultConnection )\fC [static]\fR" +Adds a database to the list of database connections using the driver \fItype\fR and the connection name \fIconnectionName\fR. +.PP +The database connection is referred to by \fIconnectionName\fR. The newly added database connection is returned. This pointer is owned by QSqlDatabase and will be deleted on program exit or when removeDatabase() is called. +.PP +If \fIconnectionName\fR is not specified, the newly added database connection becomes the default database connection for the application, and subsequent calls to database() (without a database name parameter) will return a pointer to it. If \fIconnectionName\fR is given, use database(connectionName) to retrieve a pointer to the database connection. +.PP +\fBWarning:\fR If you add a database with the same name as an existing database, the new database will replace the old one. This will happen automatically if you call this function more than once without specifying \fIconnectionName\fR. +.PP +See also database() and removeDatabase(). +.PP +Examples: +.)l sql/overview/connect1/main.cpp, sql/overview/connection.cpp, and sql/sqltable/main.cpp. +.SH "QSqlDatabase * QSqlDatabase::addDatabase ( QSqlDriver * driver, const QString & connectionName = defaultConnection )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function is useful if you need to set up the database connection and instantiate the driver yourself. If you do this, it is recommended that you include the driver code in your own application. For example, setting up a custom PostgreSQL connection and instantiating the QPSQL7 driver can be done the following way: +.PP +.nf +.br + #include "qtdir/src/sql/drivers/psql/qsql_psql.cpp" +.br +.fi +(We assume that \fCqtdir\fR is the directory where Qt is installed.) This will pull in the code that is needed to use the PostgreSQL client library and to instantiate a QPSQLDriver object, assuming that you have the PostgreSQL headers somewhere in your include search path. +.PP +.nf +.br + PGconn* con = PQconnectdb( "host=server user=bart password=simpson dbname=springfield" ); +.br + QPSQLDriver* drv = new QPSQLDriver( con ); +.br + QSqlDatabase* db = QSqlDatabase::addDatabase( drv ); // becomes the new default connection +.br + QSqlQuery q; +.br + q.exec( "SELECT * FROM people" ); +.br + ... +.br +.fi +.PP +The above code sets up a PostgreSQL connection and instantiates a QPSQLDriver object. Next, addDatabase() is called to add the connection to the known connections so that it can be used by the Qt SQL classes. When a driver is instantiated with a connection handle (or set of handles), Qt assumes that you have already opened the database connection. +.PP +Remember that you must link your application against the database client library as well. The simplest way to do this is to add lines like those below to your \fC.pro\fR file: +.PP +.nf +.br + unix:LIBS += -lpq +.br + win32:LIBS += libpqdll.lib +.br +.fi +.PP +You will need to have the client library in your linker's search path. +.PP +The method described above will work for all the drivers, the only difference is the arguments the driver constructors take. Below is an overview of the drivers and their constructor arguments. +.PP +<center>.nf +.TS +l - l. Driver Class name Constructor arguments File to include QPSQL7 QPSQLDriver PGconn* connection QMYSQL3 QMYSQLDriver MYSQL* connection QOCI8 QOCIDriver OCIEnv* environment, OCIError* error, OCISvcCtx* serviceContext QODBC3 QODBCDriver SQLHANDLE environment, SQLHANDLE connection QDB2 QDB2 SQLHANDLE environment, SQLHANDLE connection QTDS7 QTDSDriver LOGINREC* loginRecord, DBPROCESS* dbProcess, const QString& hostName QSQLITE QSQLiteDriver sqlite* connection QIBASE QIBaseDriver isc_db_handle connection +.TE +.fi +</center> +.PP +Note: The host name (or service name) is needed when constructing the QTDSDriver for creating new connections for internal queries. This is to prevent the simultaneous usage of several QSqlQuery/QSqlCursor objects from blocking each other. +.PP +\fBWarning:\fR The SQL framework takes ownership of the \fIdriver\fR pointer, and it should not be deleted. The returned QSqlDatabase object is owned by the framework and must not be deleted. If you want to explicitly remove the connection, use removeDatabase() +.PP +See also drivers(). +.SH "void QSqlDatabase::close ()" +Closes the database connection, freeing any resources acquired. +.PP +See also removeDatabase(). +.SH "bool QSqlDatabase::commit ()" +Commits a transaction to the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. +.PP +See also QSqlDriver::hasFeature() and rollback(). +.SH "QString QSqlDatabase::connectOptions () const" +Returns the database connect options. See the "connectOptions" property for details. +.SH "bool QSqlDatabase::contains ( const QString & connectionName = defaultConnection )\fC [static]\fR" +Returns TRUE if the list of database connections contains \fIconnectionName\fR; otherwise returns FALSE. +.SH "QSqlDatabase * QSqlDatabase::database ( const QString & connectionName = defaultConnection, bool open = TRUE )\fC [static]\fR" +Returns the database connection called \fIconnectionName\fR. The database connection must have been previously added with addDatabase(). If \fIopen\fR is TRUE (the default) and the database connection is not already open it is opened now. If no \fIconnectionName\fR is specified the default connection is used. If \fIconnectionName\fR does not exist in the list of databases, 0 is returned. The pointer returned is owned by QSqlDatabase and should \fInot\fR be deleted. +.PP +\fBWarning:\fR There are restrictions on the use of database connections in threaded applications. Please see the Thread Support in Qt document for more information about threading and SQL databases. +.PP +Examples: +.)l sql/overview/basicbrowsing/main.cpp and sql/overview/create_connections/main.cpp. +.SH "QString QSqlDatabase::databaseName () const" +Returns the name of the database. See the "databaseName" property for details. +.SH "QSqlDriver * QSqlDatabase::driver () const" +Returns the database driver used to access the database connection. +.SH "QString QSqlDatabase::driverName () const" +Returns the name of the driver used by the database connection. +.SH "QStringList QSqlDatabase::drivers ()\fC [static]\fR" +Returns a list of all the available database drivers. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = QSqlDatabase::drivers(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "QSqlQuery QSqlDatabase::exec ( const QString & query = QString::null ) const" +Executes a SQL statement (e.g. an \fCINSERT\fR, \fCUPDATE\fR or \fCDELETE\fR statement) on the database, and returns a QSqlQuery object. Use lastError() to retrieve error information. If \fIquery\fR is QString::null, an empty, invalid query is returned and lastError() is not affected. +.PP +See also QSqlQuery and lastError(). +.SH "QString QSqlDatabase::hostName () const" +Returns the host name where the database resides. See the "hostName" property for details. +.SH "bool QSqlDatabase::isDriverAvailable ( const QString & name )\fC [static]\fR" +Returns TRUE if a driver called \fIname\fR is available; otherwise returns FALSE. +.PP +See also drivers(). +.SH "bool QSqlDatabase::isOpen () const" +Returns TRUE if the database connection is currently open; otherwise returns FALSE. +.SH "bool QSqlDatabase::isOpenError () const" +Returns TRUE if there was an error opening the database connection; otherwise returns FALSE. Error information can be retrieved using the lastError() function. +.SH "QSqlError QSqlDatabase::lastError () const" +Returns information about the last error that occurred on the database. See QSqlError for more information. +.PP +Examples: +.)l sql/overview/connection.cpp and sql/sqltable/main.cpp. +.SH "bool QSqlDatabase::open ()" +Opens the database connection using the current connection values. Returns TRUE on success; otherwise returns FALSE. Error information can be retrieved using the lastError() function. +.PP +See also lastError(). +.PP +Examples: +.)l sql/overview/connect1/main.cpp, sql/overview/connection.cpp, and sql/sqltable/main.cpp. +.SH "bool QSqlDatabase::open ( const QString & user, const QString & password )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Opens the database connection using the given \fIuser\fR name and \fIpassword\fR. Returns TRUE on success; otherwise returns FALSE. Error information can be retrieved using the lastError() function. +.PP +This function does not store the password it is given. Instead, the password is passed directly to the driver for opening a connection and is then discarded. +.PP +See also lastError(). +.SH "QString QSqlDatabase::password () const" +Returns the password used to connect to the database. See the "password" property for details. +.SH "int QSqlDatabase::port () const" +Returns the port used to connect to the database. See the "port" property for details. +.SH "QSqlIndex QSqlDatabase::primaryIndex ( const QString & tablename ) const" +Returns the primary index for table \fItablename\fR. If no primary index exists an empty QSqlIndex will be returned. +.SH "QSqlRecord QSqlDatabase::record ( const QString & tablename ) const" +Returns a QSqlRecord populated with the names of all the fields in the table (or view) called \fItablename\fR. The order in which the fields appear in the record is undefined. If no such table (or view) exists, an empty record is returned. +.PP +See also recordInfo(). +.SH "QSqlRecord QSqlDatabase::record ( const QSqlQuery & query ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a QSqlRecord populated with the names of all the fields used in the SQL \fIquery\fR. If the query is a "SELECT *" the order in which fields appear in the record is undefined. +.PP +See also recordInfo(). +.SH "QSqlRecordInfo QSqlDatabase::recordInfo ( const QString & tablename ) const" +Returns a QSqlRecordInfo populated with meta data about the table or view \fItablename\fR. If no such table (or view) exists, an empty record is returned. +.PP +See also QSqlRecordInfo, QSqlFieldInfo, and record(). +.SH "QSqlRecordInfo QSqlDatabase::recordInfo ( const QSqlQuery & query ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a QSqlRecordInfo object with meta data for the QSqlQuery \fIquery\fR. Note that this overloaded function may return less information than the recordInfo() function which takes the name of a table as parameter. +.PP +See also QSqlRecordInfo, QSqlFieldInfo, and record(). +.SH "void QSqlDatabase::registerSqlDriver ( const QString & name, const QSqlDriverCreatorBase * creator )\fC [static]\fR" +This function registers a new SQL driver called \fIname\fR, within the SQL framework. This is useful if you have a custom SQL driver and don't want to compile it as a plugin. +.PP +Example usage: +.PP +.nf +.br + QSqlDatabase::registerSqlDriver( "MYDRIVER", new QSqlDriverCreator<MyDatabaseDriver> ); +.br + QSqlDatabase* db = QSqlDatabase::addDatabase( "MYDRIVER" ); +.br + ... +.br +.fi +.PP +\fBWarning:\fR The framework takes ownership of the \fIcreator\fR pointer, so it should not be deleted. +.SH "void QSqlDatabase::removeDatabase ( const QString & connectionName )\fC [static]\fR" +Removes the database connection \fIconnectionName\fR from the list of database connections. +.PP +\fBWarning:\fR There should be no open queries on the database connection when this function is called, otherwise a resource leak will occur. +.SH "void QSqlDatabase::removeDatabase ( QSqlDatabase * db )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes the database connection \fIdb\fR from the list of database connections. The QSqlDatabase object is destroyed when it is removed from the list. +.PP +\fBWarning:\fR The \fIdb\fR pointer is not valid after this function has been called. There should be no open queries on the database connection when this function is called, otherwise a resource leak will occur. +.SH "bool QSqlDatabase::rollback ()" +Rolls a transaction back on the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. +.PP +See also QSqlDriver::hasFeature(), commit(), and transaction(). +.SH "void QSqlDatabase::setConnectOptions ( const QString & options = QString::null )" +Sets the database connect options to \fIoptions\fR. See the "connectOptions" property for details. +.SH "void QSqlDatabase::setDatabaseName ( const QString & name )\fC [virtual]\fR" +Sets the name of the database to \fIname\fR. See the "databaseName" property for details. +.SH "void QSqlDatabase::setHostName ( const QString & host )\fC [virtual]\fR" +Sets the host name where the database resides to \fIhost\fR. See the "hostName" property for details. +.SH "void QSqlDatabase::setPassword ( const QString & password )\fC [virtual]\fR" +Sets the password used to connect to the database to \fIpassword\fR. See the "password" property for details. +.SH "void QSqlDatabase::setPort ( int p )\fC [virtual]\fR" +Sets the port used to connect to the database to \fIp\fR. See the "port" property for details. +.SH "void QSqlDatabase::setUserName ( const QString & name )\fC [virtual]\fR" +Sets the user name connected to the database to \fIname\fR. See the "userName" property for details. +.SH "QStringList QSqlDatabase::tables ( QSql::TableType type ) const" +Returns a list of the database's tables, system tables and views, as specified by the parameter \fItype\fR. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myDatabase.tables( QSql::Tables | QSql::Views ); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +Example: sql/sqltable/main.cpp. +.SH "QStringList QSqlDatabase::tables () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a list of the database's tables that are visible to the user. To include views or system tables, use the version of this function that takes a table \fCtype\fR parameter. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myDatabase.tables(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "bool QSqlDatabase::transaction ()" +Begins a transaction on the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. +.PP +See also QSqlDriver::hasFeature(), commit(), and rollback(). +.SH "QString QSqlDatabase::userName () const" +Returns the user name connected to the database. See the "userName" property for details. +.SS "Property Documentation" +.SH "QString connectOptions" +This property holds the database connect options. +.PP +The format of the options string is a semi-colon separated list of option names or option = value pairs. The options depend on the database client used: +.PP +<center>.nf +.TS +l - l. ODBC MySQL PostgreSQL +.TP +SQL_ATTR_ACCESS_MODE +.TP +SQL_ATTR_LOGIN_TIMEOUT +.TP +SQL_ATTR_CONNECTION_TIMEOUT +.TP +SQL_ATTR_CURRENT_CATALOG +.TP +SQL_ATTR_METADATA_ID +.TP +SQL_ATTR_PACKET_SIZE +.TP +SQL_ATTR_TRACEFILE +.TP +SQL_ATTR_TRACE +.PP .TP +CLIENT_COMPRESS +.TP +CLIENT_FOUND_ROWS +.TP +CLIENT_IGNORE_SPACE +.TP +CLIENT_SSL +.TP +CLIENT_ODBC +.TP +CLIENT_NO_SCHEMA +.TP +CLIENT_INTERACTIVE +.PP .TP +connect_timeout +.TP +options +.TP +tty +.TP +requiressl +.TP +service DB2 OCI TDS +.TP +SQL_ATTR_ACCESS_MODE +.TP +SQL_ATTR_LOGIN_TIMEOUT +.PP \fInone\fR +.PP +.TE +.fi +</center> +.PP +Example of usage: +.PP +.nf +.br + ... +.br + // MySQL connection +.br + db->setConnectOptions( "CLIENT_SSL;CLIENT_IGNORE_SPACE" ); // use an SSL connection to the server +.br + if ( !db->open() ) { +.br + db->setConnectOptions(); // clears the connect option string +.br + ... +.br + } +.br + ... +.br + // PostgreSQL connection +.br + db->setConnectOptions( "requiressl=1" ); // enable PostgreSQL SSL connections +.br + if ( !db->open() ) { +.br + db->setConnectOptions(); // clear options +.br + ... +.br + } +.br + ... +.br + // ODBC connection +.br + db->setConnectOptions( "SQL_ATTR_ACCESS_MODE=SQL_MODE_READ_ONLY;SQL_ATTR_TRACE=SQL_OPT_TRACE_ON" ); // set ODBC options +.br + if ( !db->open() ) { +.br + db->setConnectOptions(); // don't try to set this option +.br + ... +.br + } +.br +.fi +.PP +Please refer to the client library documentation for more information about the different options. The options will be set prior to opening the database connection. Setting new options without re-opening the connection does nothing. +.PP +See also +.PP +Set this property's value with setConnectOptions() and get this property's value with connectOptions(). +.SH "QString databaseName" +This property holds the name of the database. +.PP +Note that the database name is the TNS Service Name for the QOCI8 (Oracle) driver. +.PP +For the QODBC3 driver it can either be a DSN, a DSN filename (the file must have a \fC.dsn\fR extension), or a connection string. MS Access users can for example use the following connection string to open a \fC.mdb\fR file directly, instead of having to create a DSN entry in the ODBC manager: +.PP +.nf +.br + ... +.br + db = QSqlDatabase::addDatabase( "QODBC3" ); +.br + db->setDatabaseName( "DRIVER={Microsoft Access Driver (*.mdb)};FIL={MS Access};DBQ=myaccessfile.mdb" ); +.br + if ( db->open() ) { +.br + // success! +.br + } +.br + ... +.br +.fi +("FIL" is the required spelling in Microsoft's API.) +.PP +There is no default value. +.PP +Set this property's value with setDatabaseName() and get this property's value with databaseName(). +.SH "QString hostName" +This property holds the host name where the database resides. +.PP +There is no default value. +.PP +Set this property's value with setHostName() and get this property's value with hostName(). +.SH "QString password" +This property holds the password used to connect to the database. +.PP +There is no default value. +.PP +\fBWarning:\fR This function stores the password in plain text within Qt. Use the open() call that takes a password as parameter to avoid this behaviour. +.PP +See also open(). +.PP +Set this property's value with setPassword() and get this property's value with password(). +.SH "int port" +This property holds the port used to connect to the database. +.PP +There is no default value. +.PP +Set this property's value with setPort() and get this property's value with port(). +.SH "QString userName" +This property holds the user name connected to the database. +.PP +There is no default value. +.PP +Set this property's value with setUserName() and get this property's value with userName(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqldatabase.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqldatabase.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqldriver.3qt b/doc/man/man3/tqsqldriver.3qt new file mode 100644 index 000000000..b6e6e08f6 --- /dev/null +++ b/doc/man/man3/tqsqldriver.3qt @@ -0,0 +1,253 @@ +'\" t +.TH QSqlDriver 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 +QSqlDriver \- Abstract base class for accessing SQL databases +.SH SYNOPSIS +\fC#include <ntqsqldriver.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBDriverFeature\fR { Transactions, QuerySize, BLOB, Unicode, PreparedQueries, NamedPlaceholders, PositionalPlaceholders }" +.br +.ti -1c +.BI "\fBQSqlDriver\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSqlDriver\fR ()" +.br +.ti -1c +.BI "bool \fBisOpen\fR () const" +.br +.ti -1c +.BI "bool \fBisOpenError\fR () const" +.br +.ti -1c +.BI "virtual bool \fBbeginTransaction\fR ()" +.br +.ti -1c +.BI "virtual bool \fBcommitTransaction\fR ()" +.br +.ti -1c +.BI "virtual bool \fBrollbackTransaction\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBtables\fR ( const QString & tableType ) const" +.br +.ti -1c +.BI "virtual QSqlIndex \fBprimaryIndex\fR ( const QString & tableName ) const" +.br +.ti -1c +.BI "virtual QSqlRecord \fBrecord\fR ( const QString & tableName ) const" +.br +.ti -1c +.BI "virtual QSqlRecord \fBrecord\fR ( const QSqlQuery & query ) const" +.br +.ti -1c +.BI "virtual QSqlRecordInfo \fBrecordInfo\fR ( const QString & tablename ) const" +.br +.ti -1c +.BI "virtual QSqlRecordInfo \fBrecordInfo\fR ( const QSqlQuery & query ) const" +.br +.ti -1c +.BI "virtual QString \fBnullText\fR () const" +.br +.ti -1c +.BI "virtual QString \fBformatValue\fR ( const QSqlField * field, bool trimStrings = FALSE ) const" +.br +.ti -1c +.BI "QSqlError \fBlastError\fR () const" +.br +.ti -1c +.BI "virtual bool \fBhasFeature\fR ( DriverFeature f ) const = 0" +.br +.ti -1c +.BI "virtual bool \fBopen\fR ( const QString & db, const QString & user = QString::null, const QString & password = QString::null, const QString & host = QString::null, int port = -1 ) = 0" +.br +.ti -1c +.BI "virtual void \fBclose\fR () = 0" +.br +.ti -1c +.BI "virtual QSqlQuery \fBcreateQuery\fR () const = 0" +.br +.ti -1c +.BI "bool \fBopen\fR ( const QString & db, const QString & user, const QString & password, const QString & host, int port, const QString & connOpts )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBsetOpen\fR ( bool o )" +.br +.ti -1c +.BI "virtual void \fBsetOpenError\fR ( bool e )" +.br +.ti -1c +.BI "virtual void \fBsetLastError\fR ( const QSqlError & e )" +.br +.in -1c +.SH DESCRIPTION +The QSqlDriver class is an abstract base class for accessing SQL databases. +.PP +This class should not be used directly. Use QSqlDatabase instead. +.PP +See also Database Classes. +.SS "Member Type Documentation" +.SH "QSqlDriver::DriverFeature" +This enum contains a list of features a driver may support. Use hasFeature() to query whether a feature is supported or not. +.TP +\fCQSqlDriver::Transactions\fR - whether the driver supports SQL transactions +.TP +\fCQSqlDriver::QuerySize\fR - whether the database is capable of reporting the size of a query. Note that some databases do not support returning the size (i.e. number of rows returned) of a query, in which case QSqlQuery::size() will return -1 +.TP +\fCQSqlDriver::BLOB\fR - whether the driver supports Binary Large Object fields +.TP +\fCQSqlDriver::Unicode\fR - whether the driver supports Unicode strings if the database server does +.TP +\fCQSqlDriver::PreparedQueries\fR - whether the driver supports prepared query execution +.TP +\fCQSqlDriver::NamedPlaceholders\fR - whether the driver supports usage of named placeholders +.TP +\fCQSqlDriver::PositionalPlaceholders\fR - whether the driver supports usage of positional placeholders +.PP +More information about supported features can be found in the Qt SQL driver documentation. +.PP +See also hasFeature(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlDriver::QSqlDriver ( QObject * parent = 0, const char * name = 0 )" +Default constructor. Creates a new driver with parent \fIparent\fR, called \fIname\fR. +.SH "QSqlDriver::~QSqlDriver ()" +Destroys the object and frees any allocated resources. +.SH "bool QSqlDriver::beginTransaction ()\fC [virtual]\fR" +Protected function which derived classes can reimplement to begin a transaction. If successful, return TRUE, otherwise return FALSE. The default implementation returns FALSE. +.PP +See also commitTransaction() and rollbackTransaction(). +.SH "void QSqlDriver::close ()\fC [pure virtual]\fR" +Derived classes must reimplement this abstract virtual function in order to close the database connection. Return TRUE on success, FALSE on failure. +.PP +See also setOpen(). +.SH "bool QSqlDriver::commitTransaction ()\fC [virtual]\fR" +Protected function which derived classes can reimplement to commit a transaction. If successful, return TRUE, otherwise return FALSE. The default implementation returns FALSE. +.PP +See also beginTransaction() and rollbackTransaction(). +.SH "QSqlQuery QSqlDriver::createQuery () const\fC [pure virtual]\fR" +Creates an empty SQL result on the database. Derived classes must reimplement this function and return a QSqlQuery object appropriate for their database to the caller. +.SH "QString QSqlDriver::formatValue ( const QSqlField * field, bool trimStrings = FALSE ) const\fC [virtual]\fR" +Returns a string representation of the \fIfield\fR value for the database. This is used, for example, when constructing INSERT and UPDATE statements. +.PP +The default implementation returns the value formatted as a string according to the following rules: +.IP +.TP +If \fIfield\fR is NULL, nullText() is returned. +.IP +.TP +If \fIfield\fR is character data, the value is returned enclosed in single quotation marks, which is appropriate for many SQL databases. Any embedded single-quote characters are escaped (replaced with two single-quote characters). If \fItrimStrings\fR is TRUE (the default is FALSE), all trailing whitespace is trimmed from the field. +.IP +.TP +If \fIfield\fR is date/time data, the value is formatted in ISO format and enclosed in single quotation marks. If the date/time data is invalid, nullText() is returned. +.IP +.TP +If \fIfield\fR is bytearray data, and the driver can edit binary fields, the value is formatted as a hexadecimal string. +.IP +.TP +For any other field type toString() will be called on its value and the result returned. +.IP +.PP +See also QVariant::toString(). +.SH "bool QSqlDriver::hasFeature ( DriverFeature f ) const\fC [pure virtual]\fR" +Returns TRUE if the driver supports feature \fIf\fR; otherwise returns FALSE. +.PP +Note that some databases need to be open() before this can be determined. +.PP +See also DriverFeature. +.SH "bool QSqlDriver::isOpen () const" +Returns TRUE if the database connection is open; otherwise returns FALSE. +.SH "bool QSqlDriver::isOpenError () const" +Returns TRUE if the there was an error opening the database connection; otherwise returns FALSE. +.SH "QSqlError QSqlDriver::lastError () const" +Returns a QSqlError object which contains information about the last error that occurred on the database. +.SH "QString QSqlDriver::nullText () const\fC [virtual]\fR" +Returns a string representation of the NULL value for the database. This is used, for example, when constructing INSERT and UPDATE statements. The default implementation returns the string" NULL". +.SH "bool QSqlDriver::open ( const QString & db, const QString & user = QString::null, const QString & password = QString::null, const QString & host = QString::null, int port = -1 )\fC [pure virtual]\fR" +Derived classes must reimplement this abstract virtual function in order to open a database connection on database \fIdb\fR, using user name \fIuser\fR, password \fIpassword\fR, host \fIhost\fR and port \fIport\fR. +.PP +The function \fImust\fR return TRUE on success and FALSE on failure. +.PP +See also setOpen(). +.SH "bool QSqlDriver::open ( const QString & db, const QString & user, const QString & password, const QString & host, int port, const QString & connOpts )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Open a database connection on database \fIdb\fR, using user name \fIuser\fR, password \fIpassword\fR, host \fIhost\fR, port \fIport\fR and connection options \fIconnOpts\fR. +.PP +Returns TRUE on success and FALSE on failure. +.PP +See also setOpen(). +.SH "QSqlIndex QSqlDriver::primaryIndex ( const QString & tableName ) const\fC [virtual]\fR" +Returns the primary index for table \fItableName\fR. Returns an empty QSqlIndex if the table doesn't have a primary index. The default implementation returns an empty index. +.SH "QSqlRecord QSqlDriver::record ( const QString & tableName ) const\fC [virtual]\fR" +Returns a QSqlRecord populated with the names of the fields in table \fItableName\fR. If no such table exists, an empty record is returned. The default implementation returns an empty record. +.SH "QSqlRecord QSqlDriver::record ( const QSqlQuery & query ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a QSqlRecord populated with the names of the fields in the SQL \fIquery\fR. The default implementation returns an empty record. +.SH "QSqlRecordInfo QSqlDriver::recordInfo ( const QString & tablename ) const\fC [virtual]\fR" +Returns a QSqlRecordInfo object with meta data about the table \fItablename\fR. +.SH "QSqlRecordInfo QSqlDriver::recordInfo ( const QSqlQuery & query ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a QSqlRecordInfo object with meta data for the QSqlQuery \fIquery\fR. Note that this overloaded function may return less information than the recordInfo() function which takes the name of a table as parameter. +.SH "bool QSqlDriver::rollbackTransaction ()\fC [virtual]\fR" +Protected function which derived classes can reimplement to rollback a transaction. If successful, return TRUE, otherwise return FALSE. The default implementation returns FALSE. +.PP +See also beginTransaction() and commitTransaction(). +.SH "void QSqlDriver::setLastError ( const QSqlError & e )\fC [virtual protected]\fR" +Protected function which allows derived classes to set the value of the last error, \fIe\fR, that occurred on the database. +.PP +See also lastError(). +.SH "void QSqlDriver::setOpen ( bool o )\fC [virtual protected]\fR" +Protected function which sets the open state of the database to \fIo\fR. Derived classes can use this function to report the status of open(). +.PP +See also open() and setOpenError(). +.SH "void QSqlDriver::setOpenError ( bool e )\fC [virtual protected]\fR" +Protected function which sets the open error state of the database to \fIe\fR. Derived classes can use this function to report the status of open(). Note that if \fIe\fR is TRUE the open state of the database is set to closed (i.e. isOpen() returns FALSE). +.PP +See also open(). +.SH "QStringList QSqlDriver::tables ( const QString & tableType ) const\fC [virtual]\fR" +Returns a list of tables in the database. The default implementation returns an empty list. +.PP +The \fItableType\fR argument describes what types of tables should be returned. Due to binary compatibility, the string contains the value of the enum QSql::TableTypes as text. An empty string should be treated as QSql::Tables for downward compatibility. +.PP +See also QSql::TableType. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqldriver.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqldriver.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqldriverplugin.3qt b/doc/man/man3/tqsqldriverplugin.3qt new file mode 100644 index 000000000..b58f77eb8 --- /dev/null +++ b/doc/man/man3/tqsqldriverplugin.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QSqlDriverPlugin 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 +QSqlDriverPlugin \- Abstract base for custom QSqlDriver plugins +.SH SYNOPSIS +\fC#include <ntqsqldriverplugin.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlDriverPlugin\fR ()" +.br +.ti -1c +.BI "\fB~QSqlDriverPlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBkeys\fR () const = 0" +.br +.ti -1c +.BI "virtual QSqlDriver * \fBcreate\fR ( const QString & key ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QSqlDriverPlugin class provides an abstract base for custom QSqlDriver plugins. +.PP +The SQL driver plugin is a simple plugin interface that makes it easy to create your own SQL driver plugins that can be loaded dynamically by Qt. +.PP +Writing a SQL plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the SQL plugins that come with Qt for example implementations (in the \fCplugins/src/sqldrivers\fR subdirectory of the source distribution). Read the plugins documentation for more information on plugins. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlDriverPlugin::QSqlDriverPlugin ()" +Constructs a SQL driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. +.SH "QSqlDriverPlugin::~QSqlDriverPlugin ()" +Destroys the SQL driver plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "QSqlDriver * QSqlDriverPlugin::create ( const QString & key )\fC [pure virtual]\fR" +Creates and returns a QSqlDriver object for the driver key \fIkey\fR. The driver key is usually the class name of the required driver. +.PP +See also keys(). +.SH "QStringList QSqlDriverPlugin::keys () const\fC [pure virtual]\fR" +Returns the list of drivers (keys) this plugin supports. +.PP +These keys are usually the class names of the custom drivers that are implemented in the plugin. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqldriverplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqldriverplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqleditorfactory.3qt b/doc/man/man3/tqsqleditorfactory.3qt new file mode 100644 index 000000000..7e259890c --- /dev/null +++ b/doc/man/man3/tqsqleditorfactory.3qt @@ -0,0 +1,93 @@ +'\" t +.TH QSqlEditorFactory 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 +QSqlEditorFactory \- Used to create the editors used by QDataTable and QSqlForm +.SH SYNOPSIS +\fC#include <ntqsqleditorfactory.h>\fR +.PP +Inherits QEditorFactory. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlEditorFactory\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSqlEditorFactory\fR ()" +.br +.ti -1c +.BI "virtual QWidget * \fBcreateEditor\fR ( QWidget * parent, const QVariant & variant )" +.br +.ti -1c +.BI "virtual QWidget * \fBcreateEditor\fR ( QWidget * parent, const QSqlField * field )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QSqlEditorFactory * \fBdefaultFactory\fR ()" +.br +.ti -1c +.BI "void \fBinstallDefaultFactory\fR ( QSqlEditorFactory * factory )" +.br +.in -1c +.SH DESCRIPTION +The QSqlEditorFactory class is used to create the editors used by QDataTable and QSqlForm. +.PP +QSqlEditorFactory is used by QDataTable and QSqlForm to automatically create appropriate editors for a given QSqlField. For example if the field is a QVariant::String a QLineEdit would be the default editor, whereas a QVariant::Int's default editor would be a QSpinBox. +.PP +If you want to create different editors for fields with the same data type, subclass QSqlEditorFactory and reimplement the createEditor() function. +.PP +See also QDataTable, QSqlForm, and Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlEditorFactory::QSqlEditorFactory ( QObject * parent = 0, const char * name = 0 )" +Constructs a SQL editor factory with parent \fIparent\fR, called \fIname\fR. +.SH "QSqlEditorFactory::~QSqlEditorFactory ()" +Destroys the object and frees any allocated resources. +.SH "QWidget * QSqlEditorFactory::createEditor ( QWidget * parent, const QVariant & variant )\fC [virtual]\fR" +Creates and returns the appropriate editor widget for the QVariant \fIvariant\fR. +.PP +The widget that is returned has the parent \fIparent\fR (which may be zero). If \fIvariant\fR is invalid, 0 is returned. +.PP +Reimplemented from QEditorFactory. +.SH "QWidget * QSqlEditorFactory::createEditor ( QWidget * parent, const QSqlField * field )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Creates and returns the appropriate editor for the QSqlField \fIfield\fR. +.SH "QSqlEditorFactory * QSqlEditorFactory::defaultFactory ()\fC [static]\fR" +Returns an instance of a default editor factory. +.SH "void QSqlEditorFactory::installDefaultFactory ( QSqlEditorFactory * factory )\fC [static]\fR" +Replaces the default editor factory with \fIfactory\fR. All +QDataTable and QSqlForm instantiations will use this new factory +for creating field editors. \fIQSqlEditorFactory takes ownership of \a factory, and destroys it when it is no longer needed.\fR + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqleditorfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqleditorfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlerror.3qt b/doc/man/man3/tqsqlerror.3qt new file mode 100644 index 000000000..7c320b563 --- /dev/null +++ b/doc/man/man3/tqsqlerror.3qt @@ -0,0 +1,142 @@ +'\" t +.TH QSqlError 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 +QSqlError \- SQL database error information +.SH SYNOPSIS +\fC#include <ntqsqlerror.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBType\fR { None, Connection, Statement, Transaction, Unknown }" +.br +.ti -1c +.BI "\fBQSqlError\fR ( const QString & driverText = QString::null, const QString & databaseText = QString::null, int type = QSqlError::None, int number = -1 )" +.br +.ti -1c +.BI "\fBQSqlError\fR ( const QSqlError & other )" +.br +.ti -1c +.BI "QSqlError & \fBoperator=\fR ( const QSqlError & other )" +.br +.ti -1c +.BI "virtual \fB~QSqlError\fR ()" +.br +.ti -1c +.BI "QString \fBdriverText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDriverText\fR ( const QString & driverText )" +.br +.ti -1c +.BI "QString \fBdatabaseText\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetDatabaseText\fR ( const QString & databaseText )" +.br +.ti -1c +.BI "int \fBtype\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetType\fR ( int type )" +.br +.ti -1c +.BI "int \fBnumber\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNumber\fR ( int number )" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "void showMessage ( const QString & msg = QString::null ) const \fI(obsolete)\fR" +.br +.in -1c +.SH DESCRIPTION +The QSqlError class provides SQL database error information. +.PP +This class is used to report database-specific errors. An error description and (if appropriate) a database-specific error number can be obtained using this class. +.PP +See also Database Classes. +.SS "Member Type Documentation" +.SH "QSqlError::Type" +This enum type describes the type of SQL error that occurred. +.TP +\fCQSqlError::None\fR - no error occurred +.TP +\fCQSqlError::Connection\fR - connection error +.TP +\fCQSqlError::Statement\fR - SQL statement syntax error +.TP +\fCQSqlError::Transaction\fR - transaction failed error +.TP +\fCQSqlError::Unknown\fR - unknown error +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlError::QSqlError ( const QString & driverText = QString::null, const QString & databaseText = QString::null, int type = QSqlError::None, int number = -1 )" +Constructs an error containing the driver error text \fIdriverText\fR, the database-specific error text \fIdatabaseText\fR, the type \fItype\fR and the optional error number \fInumber\fR. +.SH "QSqlError::QSqlError ( const QSqlError & other )" +Creates a copy of \fIother\fR. +.SH "QSqlError::~QSqlError ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "QString QSqlError::databaseText () const" +Returns the text of the error as reported by the database. This may contain database-specific descriptions. +.SH "QString QSqlError::driverText () const" +Returns the text of the error as reported by the driver. This may contain database-specific descriptions. +.SH "int QSqlError::number () const" +Returns the database-specific error number, or -1 if it cannot be determined. +.SH "QSqlError & QSqlError::operator= ( const QSqlError & other )" +Sets the error equal to \fIother\fR. +.SH "void QSqlError::setDatabaseText ( const QString & databaseText )\fC [virtual]\fR" +Sets the database error text to the value of \fIdatabaseText\fR. +.SH "void QSqlError::setDriverText ( const QString & driverText )\fC [virtual]\fR" +Sets the driver error text to the value of \fIdriverText\fR. +.SH "void QSqlError::setNumber ( int number )\fC [virtual]\fR" +Sets the database-specific error number to \fInumber\fR. +.SH "void QSqlError::setType ( int type )\fC [virtual]\fR" +Sets the error type to the value of \fItype\fR. +.SH "void QSqlError::showMessage ( const QString & msg = QString::null ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is a convenience function that pops up a QMessageBox containing the message returned by text(). An additional string can be passed in via the \fImsg\fR parameter, which will be concatenated with the text() message. +.PP +See also text(), driverText(), and databaseText(). +.SH "QString QSqlError::text () const" +This is a convenience function that returns databaseText() and driverText() concatenated into a single string. +.PP +See also showMessage(), driverText(), and databaseText(). +.SH "int QSqlError::type () const" +Returns the error type, or -1 if the type cannot be determined. +.PP +See also QSqlError::Type. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlerror.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlerror.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlfield.3qt b/doc/man/man3/tqsqlfield.3qt new file mode 100644 index 000000000..d50016d2d --- /dev/null +++ b/doc/man/man3/tqsqlfield.3qt @@ -0,0 +1,199 @@ +'\" t +.TH QSqlField 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 +QSqlField \- Manipulates the fields in SQL database tables and views +.SH SYNOPSIS +\fC#include <ntqsqlfield.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlField\fR ( const QString & fieldName = QString::null, QVariant::Type type = QVariant::Invalid )" +.br +.ti -1c +.BI "\fBQSqlField\fR ( const QSqlField & other )" +.br +.ti -1c +.BI "QSqlField & \fBoperator=\fR ( const QSqlField & other )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QSqlField & other ) const" +.br +.ti -1c +.BI "virtual \fB~QSqlField\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetValue\fR ( const QVariant & value )" +.br +.ti -1c +.BI "virtual QVariant \fBvalue\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetName\fR ( const QString & name )" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetNull\fR ()" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetReadOnly\fR ( bool readOnly )" +.br +.ti -1c +.BI "bool \fBisReadOnly\fR () const" +.br +.ti -1c +.BI "void \fBclear\fR ( bool nullify = TRUE )" +.br +.ti -1c +.BI "QVariant::Type \fBtype\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QSqlField class manipulates the fields in SQL database tables and views. +.PP +QSqlField represents the characteristics of a single column in a database table or view, such as the data type and column name. A field also contains the value of the database column, which can be viewed or changed. +.PP +Field data values are stored as QVariants. Using an incompatible type is not permitted. For example: +.PP +.nf +.br + QSqlField f( "myfield", QVariant::Int ); +.br + f.setValue( QPixmap() ); // will not work +.br +.fi +.PP +However, the field will attempt to cast certain data types to the field data type where possible: +.PP +.nf +.br + QSqlField f( "myfield", QVariant::Int ); +.br + f.setValue( QString("123") ); // casts QString to int +.br +.fi +.PP +QSqlField objects are rarely created explicitly in application code. They are usually accessed indirectly through QSqlRecord or QSqlCursor which already contain a list of fields. For example: +.PP +.nf +.br + QSqlCursor cur( "Employee" ); // create cursor using the 'Employee' table +.br + QSqlField* f = cur.field( "name" ); // use the 'name' field +.br + f->setValue( "Dave" ); // set field value +.br + ... +.br +.fi +.PP +In practice we rarely need to extract a pointer to a field at all. The previous example would normally be written: +.PP +.nf +.br + QSqlCursor cur( "Employee" ); +.br + cur.setValue( "name", "Dave" ); +.br + ... +.br +.fi +.PP +See also Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlField::QSqlField ( const QString & fieldName = QString::null, QVariant::Type type = QVariant::Invalid )" +Constructs an empty field called \fIfieldName\fR of type \fItype\fR. +.SH "QSqlField::QSqlField ( const QSqlField & other )" +Constructs a copy of \fIother\fR. +.SH "QSqlField::~QSqlField ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "void QSqlField::clear ( bool nullify = TRUE )" +Clears the value of the field. If the field is read-only, nothing happens. If \fInullify\fR is TRUE (the default), the field is set to NULL. +.SH "bool QSqlField::isNull () const" +Returns TRUE if the field is currently NULL; otherwise returns FALSE. +.SH "bool QSqlField::isReadOnly () const" +Returns TRUE if the field's value is read only; otherwise returns FALSE. +.SH "QString QSqlField::name () const" +Returns the name of the field. +.PP +Example: sql/overview/table4/main.cpp. +.SH "QSqlField & QSqlField::operator= ( const QSqlField & other )" +Sets the field equal to \fIother\fR. +.SH "bool QSqlField::operator== ( const QSqlField & other ) const" +Returns TRUE if the field is equal to \fIother\fR; otherwise returns FALSE. Fields are considered equal when the following field properties are the same: +.TP +name() +.TP +isNull() +.TP +value() +.TP +isReadOnly() +.SH "void QSqlField::setName ( const QString & name )\fC [virtual]\fR" +Sets the name of the field to \fIname\fR. +.SH "void QSqlField::setNull ()\fC [virtual]\fR" +Sets the field to NULL and clears the value using clear(). If the field is read-only, nothing happens. +.PP +See also isReadOnly() and clear(). +.SH "void QSqlField::setReadOnly ( bool readOnly )\fC [virtual]\fR" +Sets the read only flag of the field's value to \fIreadOnly\fR. +.PP +See also setValue(). +.SH "void QSqlField::setValue ( const QVariant & value )\fC [virtual]\fR" +Sets the value of the field to \fIvalue\fR. If the field is read-only (isReadOnly() returns TRUE), nothing happens. If the data type of \fIvalue\fR differs from the field's current data type, an attempt is made to cast it to the proper type. This preserves the data type of the field in the case of assignment, e.g. a QString to an integer data type. For example: +.PP +.nf +.br + QSqlCursor cur( "Employee" ); // 'Employee' table +.br + QSqlField* f = cur.field( "student_count" ); // an integer field +.br + ... +.br + f->setValue( myLineEdit->text() ); // cast the line edit text to an integer +.br +.fi +.PP +See also isReadOnly(). +.SH "QVariant::Type QSqlField::type () const" +Returns the field's type as stored in the database. Note that the actual value might have a different type, Numerical values that are too large to store in a long int or double are usually stored as strings to prevent precision loss. +.SH "QVariant QSqlField::value () const\fC [virtual]\fR" +Returns the value of the field as a QVariant. +.PP +Example: sql/overview/table4/main.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlfield.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlfield.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlfieldinfo.3qt b/doc/man/man3/tqsqlfieldinfo.3qt new file mode 100644 index 000000000..64199d888 --- /dev/null +++ b/doc/man/man3/tqsqlfieldinfo.3qt @@ -0,0 +1,175 @@ +'\" t +.TH QSqlFieldInfo 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 +QSqlFieldInfo \- Stores meta data associated with a SQL field +.SH SYNOPSIS +\fC#include <ntqsqlfield.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlFieldInfo\fR ( const QString & name = QString::null, QVariant::Type typ = QVariant::Invalid, int required = -1, int len = -1, int prec = -1, const QVariant & defValue = QVariant ( ), int typeID = 0, bool generated = TRUE, bool trim = FALSE, bool calculated = FALSE )" +.br +.ti -1c +.BI "\fBQSqlFieldInfo\fR ( const QSqlFieldInfo & other )" +.br +.ti -1c +.BI "\fBQSqlFieldInfo\fR ( const QSqlField & other, bool generated = TRUE )" +.br +.ti -1c +.BI "virtual \fB~QSqlFieldInfo\fR ()" +.br +.ti -1c +.BI "QSqlFieldInfo & \fBoperator=\fR ( const QSqlFieldInfo & other )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QSqlFieldInfo & f ) const" +.br +.ti -1c +.BI "QSqlField \fBtoField\fR () const" +.br +.ti -1c +.BI "int \fBisRequired\fR () const" +.br +.ti -1c +.BI "QVariant::Type \fBtype\fR () const" +.br +.ti -1c +.BI "int \fBlength\fR () const" +.br +.ti -1c +.BI "int \fBprecision\fR () const" +.br +.ti -1c +.BI "QVariant \fBdefaultValue\fR () const" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "int \fBtypeID\fR () const" +.br +.ti -1c +.BI "bool \fBisGenerated\fR () const" +.br +.ti -1c +.BI "bool \fBisTrim\fR () const" +.br +.ti -1c +.BI "bool \fBisCalculated\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetTrim\fR ( bool trim )" +.br +.ti -1c +.BI "virtual void \fBsetGenerated\fR ( bool gen )" +.br +.ti -1c +.BI "virtual void \fBsetCalculated\fR ( bool calc )" +.br +.in -1c +.SH DESCRIPTION +The QSqlFieldInfo class stores meta data associated with a SQL field. +.PP +QSqlFieldInfo objects only store meta data; field values are stored in QSqlField objects. +.PP +All values must be set in the constructor, and may be retrieved using isRequired(), type(), length(), precision(), defaultValue(), name(), isGenerated() and typeID(). +.PP +See also Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlFieldInfo::QSqlFieldInfo ( const QString & name = QString::null, QVariant::Type typ = QVariant::Invalid, int required = -1, int len = -1, int prec = -1, const QVariant & defValue = QVariant ( ), int typeID = 0, bool generated = TRUE, bool trim = FALSE, bool calculated = FALSE )" +Constructs a QSqlFieldInfo with the following parameters: <center>.nf +.TS +l - l. \fIname\fR the name of the field. \fItyp\fR the field's type in a QVariant. \fIrequired\fR greater than 0 if the field is required, 0 if its value can be NULL and less than 0 if it cannot be determined whether the field is required or not. \fIlen\fR the length of the field. Note that for non-character types some databases return either the length in bytes or the number of digits. -1 signifies that the length cannot be determined. \fIprec\fR the precision of the field, or -1 if the field has no precision or it cannot be determined. \fIdefValue\fR the default value that is inserted into the table if none is specified by the user. QVariant() if there is no default value or it cannot be determined. \fItypeID\fR the internal typeID of the database system (only useful for low-level programming). 0 if unknown. \fIgenerated\fR TRUE indicates that this field should be included in auto-generated SQL statments, e.g. in QSqlCursor. \fItrim\fR TRUE indicates that widgets should remove trailing whitespace from character fields. This does not affect the field value but only its representation inside widgets. \fIcalculated\fR +.TE +.fi +</center> +.SH "QSqlFieldInfo::QSqlFieldInfo ( const QSqlFieldInfo & other )" +Constructs a copy of \fIother\fR. +.SH "QSqlFieldInfo::QSqlFieldInfo ( const QSqlField & other, bool generated = TRUE )" +Creates a QSqlFieldInfo object with the type and the name of the QSqlField \fIother\fR. If \fIgenerated\fR is TRUE this field will be included in auto-generated SQL statments, e.g. in QSqlCursor. +.SH "QSqlFieldInfo::~QSqlFieldInfo ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "QVariant QSqlFieldInfo::defaultValue () const" +Returns the field's default value or an empty QVariant if the field has no default value or the value couldn't be determined. The default value is the value inserted in the database when it is not explicitly specified by the user. +.SH "bool QSqlFieldInfo::isCalculated () const" +Returns TRUE if the field is calculated; otherwise returns FALSE. +.PP +See also setCalculated(). +.SH "bool QSqlFieldInfo::isGenerated () const" +Returns TRUE if the field should be included in auto-generated SQL statments, e.g. in QSqlCursor; otherwise returns FALSE. +.PP +See also setGenerated(). +.SH "int QSqlFieldInfo::isRequired () const" +Returns a value greater than 0 if the field is required (NULL values are not allowed), 0 if it isn't required (NULL values are allowed) or less than 0 if it cannot be determined whether the field is required or not. +.SH "bool QSqlFieldInfo::isTrim () const" +Returns TRUE if trailing whitespace should be removed from character fields; otherwise returns FALSE. +.PP +See also setTrim(). +.SH "int QSqlFieldInfo::length () const" +Returns the field's length. For fields storing text the return value is the maximum number of characters the field can hold. For non-character fields some database systems return the number of bytes needed or the number of digits allowed. If the length cannot be determined -1 is returned. +.SH "QString QSqlFieldInfo::name () const" +Returns the name of the field in the SQL table. +.PP +Examples: +.)l sql/overview/subclass3/main.cpp and sql/overview/subclass4/main.cpp. +.SH "QSqlFieldInfo & QSqlFieldInfo::operator= ( const QSqlFieldInfo & other )" +Assigns \fIother\fR to this field info and returns a reference to it. +.SH "bool QSqlFieldInfo::operator== ( const QSqlFieldInfo & f ) const" +Returns TRUE if this fieldinfo is equal to \fIf\fR; otherwise returns FALSE. +.PP +Two field infos are considered equal if all their attributes match. +.SH "int QSqlFieldInfo::precision () const" +Returns the field's precision or -1 if the field has no precision or it cannot be determined. +.SH "void QSqlFieldInfo::setCalculated ( bool calc )\fC [virtual]\fR" +\fIcalc\fR set to TRUE indicates that this field is a calculated field. The value of calculated fields can by modified by subclassing QSqlCursor and overriding QSqlCursor::calculateField(). +.PP +See also isCalculated(). +.SH "void QSqlFieldInfo::setGenerated ( bool gen )\fC [virtual]\fR" +\fIgen\fR set to FALSE indicates that this field should not appear in auto-generated SQL statements (for example in QSqlCursor). +.PP +See also isGenerated(). +.SH "void QSqlFieldInfo::setTrim ( bool trim )\fC [virtual]\fR" +If \fItrim\fR is TRUE widgets should remove trailing whitespace from character fields. This does not affect the field value but only its representation inside widgets. +.PP +See also isTrim(). +.SH "QSqlField QSqlFieldInfo::toField () const" +Returns an empty QSqlField based on the information in this QSqlFieldInfo. +.SH "QVariant::Type QSqlFieldInfo::type () const" +Returns the field's type or QVariant::Invalid if the type is unknown. +.SH "int QSqlFieldInfo::typeID () const" +Returns the internal type identifier as returned from the database system. The return value is 0 if the type is unknown. +.PP +\fBWarning:\fR This information is only useful for low-level database +programming and is \fInot\fR database independent. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qsqlfieldinfo.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlfieldinfo.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlform.3qt b/doc/man/man3/tqsqlform.3qt new file mode 100644 index 000000000..a79bd5292 --- /dev/null +++ b/doc/man/man3/tqsqlform.3qt @@ -0,0 +1,244 @@ +'\" t +.TH QSqlForm 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 +QSqlForm \- Creates and manages data entry forms tied to SQL databases +.SH SYNOPSIS +\fC#include <ntqsqlform.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlForm\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSqlForm\fR ()" +.br +.ti -1c +.BI "virtual void \fBinsert\fR ( QWidget * widget, const QString & field )" +.br +.ti -1c +.BI "virtual void \fBremove\fR ( const QString & field )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "QWidget * \fBwidget\fR ( uint i ) const" +.br +.ti -1c +.BI "QSqlField * \fBwidgetToField\fR ( QWidget * widget ) const" +.br +.ti -1c +.BI "QWidget * \fBfieldToWidget\fR ( QSqlField * field ) const" +.br +.ti -1c +.BI "void \fBinstallPropertyMap\fR ( QSqlPropertyMap * pmap )" +.br +.ti -1c +.BI "virtual void \fBsetRecord\fR ( QSqlRecord * buf )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBreadField\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual void \fBwriteField\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual void \fBreadFields\fR ()" +.br +.ti -1c +.BI "virtual void \fBwriteFields\fR ()" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBclearValues\fR ( bool nullify = FALSE )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBinsert\fR ( QWidget * widget, QSqlField * field )" +.br +.ti -1c +.BI "virtual void \fBremove\fR ( QWidget * widget )" +.br +.in -1c +.SH DESCRIPTION +The QSqlForm class creates and manages data entry forms tied to SQL databases. +.PP +Typical use of a QSqlForm consists of the following steps: +.TP +Create the widgets you want to appear in the form. +.TP +Create a cursor and navigate to the record to be edited. +.TP +Create the QSqlForm. +.TP +Set the form's record buffer to the cursor's update buffer. +.TP +Insert each widget and the field it is to edit into the form. +.TP +Use readFields() to update the editor widgets with values from the database's fields. +.TP +Display the form and let the user edit values etc. +.TP +Use writeFields() to update the database's field values with the values in the editor widgets. +.PP +Note that a QSqlForm does not access the database directly, but most often via QSqlFields which are part of a QSqlCursor. A QSqlCursor::insert(), QSqlCursor::update() or QSqlCursor::del() call is needed to actually write values to the database. +.PP +Some sample code to initialize a form successfully: +.PP +.nf +.br + QLineEdit myEditor( this ); +.br + QSqlForm myForm( this ); +.br + QSqlCursor myCursor( "mytable" ); +.br +.br + // Execute a query to make the cursor valid +.br + myCursor.select(); +.br + // Move the cursor to a valid record (the first record) +.br + myCursor.next(); +.br + // Set the form's record pointer to the cursor's edit buffer (which +.br + // contains the current record's values) +.br + myForm.setRecord( myCursor.primeUpdate() ); +.br +.br + // Insert a field into the form that uses myEditor to edit the +.br + // field 'somefield' in 'mytable' +.br + myForm.insert( &myEditor, "somefield" ); +.br +.br + // Update myEditor with the value from the mapped database field +.br + myForm.readFields(); +.br + ... +.br + // Let the user edit the form +.br + ... +.br + // Update the database +.br + myForm.writeFields(); // Update the cursor's edit buffer from the form +.br + myCursor.update(); // Update the database from the cursor's buffer +.br +.fi +.PP +If you want to use custom editors for displaying and editing data fields, you must install a custom QSqlPropertyMap. The form uses this object to get or set the value of a widget. +.PP +Note that Qt Designer provides a visual means of creating data-aware forms. +.PP +See also installPropertyMap(), QSqlPropertyMap, and Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlForm::QSqlForm ( QObject * parent = 0, const char * name = 0 )" +Constructs a QSqlForm with parent \fIparent\fR and called \fIname\fR. +.SH "QSqlForm::~QSqlForm ()" +Destroys the object and frees any allocated resources. +.SH "void QSqlForm::clear ()\fC [virtual slot]\fR" +Removes every widget, and the fields they're mapped to, from the form. +.SH "void QSqlForm::clearValues ( bool nullify = FALSE )\fC [virtual slot]\fR" +Clears the values in all the widgets, and the fields they are mapped to, in the form. If \fInullify\fR is TRUE (the default is FALSE), each field is also set to NULL. +.SH "uint QSqlForm::count () const" +Returns the number of widgets in the form. +.SH "QWidget * QSqlForm::fieldToWidget ( QSqlField * field ) const" +Returns the widget that field \fIfield\fR is mapped to. +.SH "void QSqlForm::insert ( QWidget * widget, const QString & field )\fC [virtual]\fR" +Inserts a \fIwidget\fR, and the name of the \fIfield\fR it is to be mapped to, into the form. To actually associate inserted widgets with an edit buffer, use setRecord(). +.PP +See also setRecord(). +.PP +Examples: +.)l sql/overview/form1/main.cpp and sql/overview/form2/main.cpp. +.SH "void QSqlForm::insert ( QWidget * widget, QSqlField * field )\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts a \fIwidget\fR, and the \fIfield\fR it is to be mapped to, into the form. +.SH "void QSqlForm::installPropertyMap ( QSqlPropertyMap * pmap )" +Installs a custom QSqlPropertyMap. This is useful if you plan to create your own custom editor widgets. +.PP +QSqlForm takes ownership of \fIpmap\fR, so \fIpmap\fR is deleted when QSqlForm goes out of scope. +.PP +See also QDataTable::installEditorFactory(). +.PP +Example: sql/overview/custom1/main.cpp. +.SH "void QSqlForm::readField ( QWidget * widget )\fC [virtual slot]\fR" +Updates the widget \fIwidget\fR with the value from the SQL field it is mapped to. Nothing happens if no SQL field is mapped to the \fIwidget\fR. +.SH "void QSqlForm::readFields ()\fC [virtual slot]\fR" +Updates the widgets in the form with current values from the SQL fields they are mapped to. +.PP +Examples: +.)l sql/overview/form1/main.cpp and sql/overview/form2/main.cpp. +.SH "void QSqlForm::remove ( QWidget * widget )\fC [virtual protected]\fR" +Removes a \fIwidget\fR, and hence the field it's mapped to, from the form. +.SH "void QSqlForm::remove ( const QString & field )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes \fIfield\fR from the form. +.SH "void QSqlForm::setRecord ( QSqlRecord * buf )\fC [virtual]\fR" +Sets \fIbuf\fR as the record buffer for the form. To force the display of the data from \fIbuf\fR, use readFields(). +.PP +See also readFields() and writeFields(). +.PP +Examples: +.)l sql/overview/custom1/main.cpp, sql/overview/form1/main.cpp, and sql/overview/form2/main.cpp. +.SH "QWidget * QSqlForm::widget ( uint i ) const" +Returns the \fIi\fR-th widget in the form. Useful for traversing the widgets in the form. +.SH "QSqlField * QSqlForm::widgetToField ( QWidget * widget ) const" +Returns the SQL field that widget \fIwidget\fR is mapped to. +.SH "void QSqlForm::writeField ( QWidget * widget )\fC [virtual slot]\fR" +Updates the SQL field with the value from the \fIwidget\fR it is mapped to. Nothing happens if no SQL field is mapped to the \fIwidget\fR. +.SH "void QSqlForm::writeFields ()\fC [virtual slot]\fR" +Updates the SQL fields with values from the widgets they are mapped to. To actually update the database with the contents of the record buffer, use QSqlCursor::insert(), QSqlCursor::update() or QSqlCursor::del() as appropriate. +.PP +Example: sql/overview/form2/main.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlform.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlform.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlindex.3qt b/doc/man/man3/tqsqlindex.3qt new file mode 100644 index 000000000..dcf58e7c5 --- /dev/null +++ b/doc/man/man3/tqsqlindex.3qt @@ -0,0 +1,126 @@ +'\" t +.TH QSqlIndex 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 +QSqlIndex \- Functions to manipulate and describe QSqlCursor and QSqlDatabase indexes +.SH SYNOPSIS +\fC#include <ntqsqlindex.h>\fR +.PP +Inherits QSqlRecord. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlIndex\fR ( const QString & cursorname = QString::null, const QString & name = QString::null )" +.br +.ti -1c +.BI "\fBQSqlIndex\fR ( const QSqlIndex & other )" +.br +.ti -1c +.BI "\fB~QSqlIndex\fR ()" +.br +.ti -1c +.BI "QSqlIndex & \fBoperator=\fR ( const QSqlIndex & other )" +.br +.ti -1c +.BI "virtual void \fBsetCursorName\fR ( const QString & cursorName )" +.br +.ti -1c +.BI "QString \fBcursorName\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetName\fR ( const QString & name )" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "virtual void \fBappend\fR ( const QSqlField & field )" +.br +.ti -1c +.BI "virtual void \fBappend\fR ( const QSqlField & field, bool desc )" +.br +.ti -1c +.BI "bool \fBisDescending\fR ( int i ) const" +.br +.ti -1c +.BI "virtual void \fBsetDescending\fR ( int i, bool desc )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QSqlIndex \fBfromStringList\fR ( const QStringList & l, const QSqlCursor * cursor )" +.br +.in -1c +.SH DESCRIPTION +The QSqlIndex class provides functions to manipulate and describe QSqlCursor and QSqlDatabase indexes. +.PP +This class is used to describe and manipulate QSqlCursor and QSqlDatabase indexes. An index refers to a single table or view in a database. Information about the fields that comprise the index can be used to generate SQL statements, or to affect the behavior of a QSqlCursor object. +.PP +Normally, QSqlIndex objects are created by QSqlDatabase or QSqlCursor. +.PP +See also Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlIndex::QSqlIndex ( const QString & cursorname = QString::null, const QString & name = QString::null )" +Constructs an empty index using the cursor name \fIcursorname\fR and index name \fIname\fR. +.SH "QSqlIndex::QSqlIndex ( const QSqlIndex & other )" +Constructs a copy of \fIother\fR. +.SH "QSqlIndex::~QSqlIndex ()" +Destroys the object and frees any allocated resources. +.SH "void QSqlIndex::append ( const QSqlField & field )\fC [virtual]\fR" +Appends the field \fIfield\fR to the list of indexed fields. The field is appended with an ascending sort order. +.PP +Reimplemented from QSqlRecord. +.SH "void QSqlIndex::append ( const QSqlField & field, bool desc )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends the field \fIfield\fR to the list of indexed fields. The field is appended with an ascending sort order, unless \fIdesc\fR is TRUE. +.SH "QString QSqlIndex::cursorName () const" +Returns the name of the cursor which the index is associated with. +.SH "QSqlIndex QSqlIndex::fromStringList ( const QStringList & l, const QSqlCursor * cursor )\fC [static]\fR" +Returns an index based on the field descriptions in \fIl\fR and the cursor \fIcursor\fR. The field descriptions should be in the same format that toStringList() produces, for example, a surname field in the people table might be in one of these forms: "surname"," surname DESC" or "people.surname ASC". +.PP +See also toStringList(). +.SH "bool QSqlIndex::isDescending ( int i ) const" +Returns TRUE if field \fIi\fR in the index is sorted in descending order; otherwise returns FALSE. +.SH "QString QSqlIndex::name () const" +Returns the name of the index. +.SH "QSqlIndex & QSqlIndex::operator= ( const QSqlIndex & other )" +Sets the index equal to \fIother\fR. +.SH "void QSqlIndex::setCursorName ( const QString & cursorName )\fC [virtual]\fR" +Sets the name of the cursor that the index is associated with to \fIcursorName\fR. +.SH "void QSqlIndex::setDescending ( int i, bool desc )\fC [virtual]\fR" +If \fIdesc\fR is TRUE, field \fIi\fR is sorted in descending order. Otherwise, field \fIi\fR is sorted in ascending order (the default). If the field does not exist, nothing happens. +.SH "void QSqlIndex::setName ( const QString & name )\fC [virtual]\fR" +Sets the name of the index to \fIname\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlindex.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlindex.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlpropertymap.3qt b/doc/man/man3/tqsqlpropertymap.3qt new file mode 100644 index 000000000..b6bcb4ed6 --- /dev/null +++ b/doc/man/man3/tqsqlpropertymap.3qt @@ -0,0 +1,172 @@ +'\" t +.TH QSqlPropertyMap 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 +QSqlPropertyMap \- Used to map widgets to SQL fields +.SH SYNOPSIS +\fC#include <ntqsqlpropertymap.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlPropertyMap\fR ()" +.br +.ti -1c +.BI "virtual \fB~QSqlPropertyMap\fR ()" +.br +.ti -1c +.BI "QVariant \fBproperty\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual void \fBsetProperty\fR ( QWidget * widget, const QVariant & value )" +.br +.ti -1c +.BI "void \fBinsert\fR ( const QString & classname, const QString & property )" +.br +.ti -1c +.BI "void \fBremove\fR ( const QString & classname )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QSqlPropertyMap * \fBdefaultMap\fR ()" +.br +.ti -1c +.BI "void \fBinstallDefaultMap\fR ( QSqlPropertyMap * map )" +.br +.in -1c +.SH DESCRIPTION +The QSqlPropertyMap class is used to map widgets to SQL fields. +.PP +The SQL module uses Qt object properties to insert and extract values from editor widgets. +.PP +This class is used to map editors to SQL fields. This works by associating SQL editor class names to the properties used to insert and extract values to/from the editor. +.PP +For example, a QLineEdit can be used to edit text strings and other data types in QDataTables or QSqlForms. Several properties are defined in QLineEdit, but only the \fItext\fR property is used to insert and extract text from a QLineEdit. Both QDataTable and QSqlForm use the global QSqlPropertyMap for inserting and extracting values to and from an editor widget. The global property map defines several common widgets and properties that are suitable for many applications. You can add and remove widget properties to suit your specific needs. +.PP +If you want to use custom editors with your QDataTable or QSqlForm, you must install your own QSqlPropertyMap for that table or form. Example: +.PP +.nf +.br + QSqlPropertyMap *myMap = new QSqlPropertyMap(); +.br + QSqlForm *myForm = new QSqlForm( this ); +.br + MyEditor myEditor( this ); +.br +.br + // Set the QSqlForm's record buffer to the update buffer of +.br + // a pre-existing QSqlCursor called 'cur'. +.br + myForm->setRecord( cur->primeUpdate() ); +.br +.br + // Install the customized map +.br + myMap->insert( "MyEditor", "content" ); +.br + myForm->installPropertyMap( myMap ); // myForm now owns myMap +.br + ... +.br + // Insert a field into the form that uses a myEditor to edit the +.br + // field 'somefield' +.br + myForm->insert( &myEditor, "somefield" ); +.br +.br + // Update myEditor with the value from the mapped database field +.br + myForm->readFields(); +.br + ... +.br + // Let the user edit the form +.br + ... +.br + // Update the database fields with the values in the form +.br + myForm->writeFields(); +.br + ... +.br +.fi +.PP +You can also replace the global QSqlPropertyMap that is used by default. (Bear in mind that QSqlPropertyMap takes ownership of the new default map.) +.PP +.nf +.br + QSqlPropertyMap *myMap = new QSqlPropertyMap; +.br +.br + myMap->insert( "MyEditor", "content" ); +.br + QSqlPropertyMap::installDefaultMap( myMap ); +.br + ... +.br +.fi +.PP +See also QDataTable, QSqlForm, QSqlEditorFactory, and Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlPropertyMap::QSqlPropertyMap ()" +Constructs a QSqlPropertyMap. +.PP +The default property mappings used by Qt widgets are: <center>.nf +.TS +l - l. Widgets Property QCheckBox, QRadioButton checked QComboBox, QListBox currentItem QDateEdit date QDateTimeEdit dateTime QTextBrowser source QButton, QDial, QLabel, QLineEdit, QMultiLineEdit, QPushButton, QTextEdit, text QTimeEdit time QLCDNumber, QScrollBar QSlider, QSpinBox +.TE +.fi +</center> +.SH "QSqlPropertyMap::~QSqlPropertyMap ()\fC [virtual]\fR" +Destroys the QSqlPropertyMap. +.PP +Note that if the QSqlPropertyMap is installed with installPropertyMap() the object it was installed into, e.g. the QSqlForm, takes ownership and will delete the QSqlPropertyMap when necessary. +.SH "QSqlPropertyMap * QSqlPropertyMap::defaultMap ()\fC [static]\fR" +Returns the application global QSqlPropertyMap. +.SH "void QSqlPropertyMap::insert ( const QString & classname, const QString & property )" +Insert a new classname/property pair, which is used for custom SQL field editors. There \fImust\fR be a \fCTQ_PROPERTY\fR clause in the \fIclassname\fR class declaration for the \fIproperty\fR. +.PP +Example: sql/overview/custom1/main.cpp. +.SH "void QSqlPropertyMap::installDefaultMap ( QSqlPropertyMap * map )\fC [static]\fR" +Replaces the global default property map with \fImap\fR. All QDataTable and QSqlForm instantiations will use this new map for inserting and extracting values to and from editors. \fIQSqlPropertyMap takes ownership of \a map, and destroys it when it is no longer needed.\fR +.SH "QVariant QSqlPropertyMap::property ( QWidget * widget )" +Returns the mapped property of \fIwidget\fR as a QVariant. +.SH "void QSqlPropertyMap::remove ( const QString & classname )" +Removes \fIclassname\fR from the map. +.SH "void QSqlPropertyMap::setProperty ( QWidget * widget, const QVariant & value )\fC [virtual]\fR" +Sets the property of \fIwidget\fR to \fIvalue\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlpropertymap.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlpropertymap.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlquery.3qt b/doc/man/man3/tqsqlquery.3qt new file mode 100644 index 000000000..5cf282d2b --- /dev/null +++ b/doc/man/man3/tqsqlquery.3qt @@ -0,0 +1,567 @@ +'\" t +.TH QSqlQuery 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 +QSqlQuery \- Means of executing and manipulating SQL statements +.SH SYNOPSIS +\fC#include <ntqsqlquery.h>\fR +.PP +Inherited by QSqlCursor. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlQuery\fR ( QSqlResult * r )" +.br +.ti -1c +.BI "\fBQSqlQuery\fR ( const QString & query = QString::null, QSqlDatabase * db = 0 )" +.br +.ti -1c +.BI "explicit \fBQSqlQuery\fR ( QSqlDatabase * db )" +.br +.ti -1c +.BI "\fBQSqlQuery\fR ( const QSqlQuery & other )" +.br +.ti -1c +.BI "QSqlQuery & \fBoperator=\fR ( const QSqlQuery & other )" +.br +.ti -1c +.BI "virtual \fB~QSqlQuery\fR ()" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "bool \fBisActive\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR ( int field ) const" +.br +.ti -1c +.BI "int \fBat\fR () const" +.br +.ti -1c +.BI "QString \fBlastQuery\fR () const" +.br +.ti -1c +.BI "int \fBnumRowsAffected\fR () const" +.br +.ti -1c +.BI "QSqlError \fBlastError\fR () const" +.br +.ti -1c +.BI "bool \fBisSelect\fR () const" +.br +.ti -1c +.BI "int \fBsize\fR () const" +.br +.ti -1c +.BI "const QSqlDriver * \fBdriver\fR () const" +.br +.ti -1c +.BI "const QSqlResult * \fBresult\fR () const" +.br +.ti -1c +.BI "bool \fBisForwardOnly\fR () const" +.br +.ti -1c +.BI "void \fBsetForwardOnly\fR ( bool forward )" +.br +.ti -1c +.BI "virtual bool \fBexec\fR ( const QString & query )" +.br +.ti -1c +.BI "virtual QVariant \fBvalue\fR ( int i ) const" +.br +.ti -1c +.BI "virtual bool \fBseek\fR ( int i, bool relative = FALSE )" +.br +.ti -1c +.BI "virtual bool \fBnext\fR ()" +.br +.ti -1c +.BI "virtual bool \fBprev\fR ()" +.br +.ti -1c +.BI "virtual bool \fBfirst\fR ()" +.br +.ti -1c +.BI "virtual bool \fBlast\fR ()" +.br +.ti -1c +.BI "bool \fBexec\fR ()" +.br +.ti -1c +.BI "bool \fBprepare\fR ( const QString & query )" +.br +.ti -1c +.BI "void \fBbindValue\fR ( const QString & placeholder, const QVariant & val )" +.br +.ti -1c +.BI "void \fBbindValue\fR ( int pos, const QVariant & val )" +.br +.ti -1c +.BI "void \fBaddBindValue\fR ( const QVariant & val )" +.br +.ti -1c +.BI "void \fBbindValue\fR ( const QString & placeholder, const QVariant & val, QSql::ParameterType type )" +.br +.ti -1c +.BI "void \fBbindValue\fR ( int pos, const QVariant & val, QSql::ParameterType type )" +.br +.ti -1c +.BI "void \fBaddBindValue\fR ( const QVariant & val, QSql::ParameterType type )" +.br +.ti -1c +.BI "QVariant \fBboundValue\fR ( const QString & placeholder ) const" +.br +.ti -1c +.BI "QVariant \fBboundValue\fR ( int pos ) const" +.br +.ti -1c +.BI "QMap<QString, QVariant> \fBboundValues\fR () const" +.br +.ti -1c +.BI "QString \fBexecutedQuery\fR () const" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBbeforeSeek\fR ()" +.br +.ti -1c +.BI "virtual void \fBafterSeek\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSqlQuery class provides a means of executing and manipulating SQL statements. +.PP +QSqlQuery encapsulates the functionality involved in creating, navigating and retrieving data from SQL queries which are executed on a QSqlDatabase. It can be used to execute DML (data manipulation language) statements, e.g. \fCSELECT\fR, \fCINSERT\fR, \fCUPDATE\fR and \fCDELETE\fR, and also DDL (data definition language) statements, e.g. \fCCREATE TABLE\fR. It can also be used to execute database-specific commands which are not standard SQL (e.g. \fCSET DATESTYLE=ISO\fR for PostgreSQL). +.PP +Successfully executed SQL statements set the query's state to active (isActive() returns TRUE); otherwise the query's state is set to inactive. In either case, when executing a new SQL statement, the query is positioned on an invalid record; an active query must be navigated to a valid record (so that isValid() returns TRUE) before values can be retrieved. +.PP +Navigating records is performed with the following functions: +.TP +next() +.TP +prev() +.TP +first() +.TP +last() +.TP +\fC\fRseek(int) +.PP +These functions allow the programmer to move forward, backward or arbitrarily through the records returned by the query. If you only need to move forward through the results, e.g. using next() or using seek() with a positive offset, you can use setForwardOnly() and save a significant amount of memory overhead. Once an active query is positioned on a valid record, data can be retrieved using value(). All data is transferred from the SQL backend using QVariants. +.PP +For example: +.PP +.nf +.br + QSqlQuery query( "SELECT name FROM customer" ); +.br + while ( query.next() ) { +.br + QString name = query.value(0).toString(); +.br + doSomething( name ); +.br + } +.br +.fi +.PP +To access the data returned by a query, use the value() method. Each field in the data returned by a SELECT statement is accessed by passing the field's position in the statement, starting from 0. Information about the fields can be obtained via QSqlDatabase::record(). For the sake of efficiency there are no functions to access a field by name. (The QSqlCursor class provides a higher-level interface with field access by name and automatic SQL generation.) +.PP +QSqlQuery supports prepared query execution and the binding of parameter values to placeholders. Some databases don't support these features, so for them Qt emulates the required functionality. For example, the Oracle and ODBC drivers have proper prepared query support, and Qt makes use of it; but for databases that don't have this support, Qt implements the feature itself, e.g. by replacing placeholders with actual values when a query is executed. The exception is positional binding using named placeholders, which requires that the database supports prepared queries. +.PP +Oracle databases identify placeholders by using a colon-name syntax, e.g \fC:name\fR. ODBC simply uses \fC?\fR characters. Qt supports both syntaxes (although you can't mix them in the same query). +.PP +Below we present the same example using each of the four different binding approaches. +.PP +\fBNamed binding using named placeholders\fR +.PP +.nf +.br + QSqlQuery query; +.br + query.prepare( "INSERT INTO atable (id, forename, surname) " +.br + "VALUES (:id, :forename, :surname)" ); +.br + query.bindValue( ":id", 1001 ); +.br + query.bindValue( ":forename", "Bart" ); +.br + query.bindValue( ":surname", "Simpson" ); +.br + query.exec(); +.br +.fi +.PP +\fBPositional binding using named placeholders\fR +.PP +.nf +.br + QSqlQuery query; +.br + query.prepare( "INSERT INTO atable (id, forename, surname) " +.br + "VALUES (:id, :forename, :surname)" ); +.br + query.bindValue( 0, 1001 ); +.br + query.bindValue( 1, "Bart" ); +.br + query.bindValue( 2, "Simpson" ); +.br + query.exec(); +.br +.fi +\fBNote:\fR Using positional binding with named placeholders will only work if the database supports prepared queries. This can be checked with QSqlDriver::hasFeature() using QSqlDriver::PreparedQueries as argument for driver feature. +.PP +\fBBinding values using positional placeholders #1\fR +.PP +.nf +.br + QSqlQuery query; +.br + query.prepare( "INSERT INTO atable (id, forename, surname) " +.br + "VALUES (?, ?, ?)" ); +.br + query.bindValue( 0, 1001 ); +.br + query.bindValue( 1, "Bart" ); +.br + query.bindValue( 2, "Simpson" ); +.br + query.exec(); +.br +.fi +.PP +\fBBinding values using positional placeholders #2\fR +.PP +.nf +.br + query.prepare( "INSERT INTO atable (id, forename, surname) " +.br + "VALUES (?, ?, ?)" ); +.br + query.addBindValue( 1001 ); +.br + query.addBindValue( "Bart" ); +.br + query.addBindValue( "Simpson" ); +.br + query.exec(); +.br +.fi +.PP +\fBBinding values to a stored procedure\fR This code calls a stored procedure called \fCAsciiToInt()\fR, passing it a character through its in parameter, and taking its result in the out parameter. +.PP +.nf +.br + QSqlQuery query; +.br + query.prepare( "call AsciiToInt(?, ?)" ); +.br + query.bindValue( 0, "A" ); +.br + query.bindValue( 1, 0, QSql::Out ); +.br + query.exec(); +.br + int i = query.boundValue( 1 ).toInt(); // i is 65. +.br +.fi +.PP +See also QSqlDatabase, QSqlCursor, QVariant, and Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlQuery::QSqlQuery ( QSqlResult * r )" +Creates a QSqlQuery object which uses the QSqlResult \fIr\fR to communicate with a database. +.SH "QSqlQuery::QSqlQuery ( const QString & query = QString::null, QSqlDatabase * db = 0 )" +Creates a QSqlQuery object using the SQL \fIquery\fR and the database \fIdb\fR. If \fIdb\fR is 0, (the default), the application's default database is used. If \fIquery\fR is not a null string, it will be executed. +.PP +See also QSqlDatabase. +.SH "explicit QSqlQuery::QSqlQuery ( QSqlDatabase * db )" +Creates a QSqlQuery object using the database \fIdb\fR. If \fIdb\fR is 0, the application's default database is used. +.PP +See also QSqlDatabase. +.SH "QSqlQuery::QSqlQuery ( const QSqlQuery & other )" +Constructs a copy of \fIother\fR. +.SH "QSqlQuery::~QSqlQuery ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "void QSqlQuery::addBindValue ( const QVariant & val, QSql::ParameterType type )" +Adds the value \fIval\fR to the list of values when using positional value binding. The order of the addBindValue() calls determines which placeholder a value will be bound to in the prepared query. If \fItype\fR is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call. +.PP +See also bindValue(), prepare(), and exec(). +.SH "void QSqlQuery::addBindValue ( const QVariant & val )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Binds the placeholder with type QSql::In. +.SH "void QSqlQuery::afterSeek ()\fC [virtual protected]\fR" +Protected virtual function called after the internal record pointer is moved to a new record. The default implementation does nothing. +.SH "int QSqlQuery::at () const" +Returns the current internal position of the query. The first record is at position zero. If the position is invalid, a QSql::Location will be returned indicating the invalid position. +.PP +See also prev(), next(), first(), last(), seek(), isActive(), and isValid(). +.PP +Example: sql/overview/navigating/main.cpp. +.SH "void QSqlQuery::beforeSeek ()\fC [virtual protected]\fR" +Protected virtual function called before the internal record pointer is moved to a new record. The default implementation does nothing. +.SH "void QSqlQuery::bindValue ( const QString & placeholder, const QVariant & val, QSql::ParameterType type )" +Set the placeholder \fIplaceholder\fR to be bound to value \fIval\fR in the prepared statement. Note that the placeholder mark (e.g \fC:\fR) must be included when specifying the placeholder name. If \fItype\fR is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call. +.PP +See also addBindValue(), prepare(), and exec(). +.SH "void QSqlQuery::bindValue ( const QString & placeholder, const QVariant & val )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Binds the placeholder with type QSql::In. +.SH "void QSqlQuery::bindValue ( int pos, const QVariant & val )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Binds the placeholder at position \fIpos\fR with type QSql::In. +.SH "void QSqlQuery::bindValue ( int pos, const QVariant & val, QSql::ParameterType type )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Set the placeholder in position \fIpos\fR to be bound to value \fIval\fR in the prepared statement. Field numbering starts at 0. If \fItype\fR is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call. +.PP +See also addBindValue(), prepare(), and exec(). +.SH "QVariant QSqlQuery::boundValue ( const QString & placeholder ) const" +Returns the value for the \fIplaceholder\fR. +.SH "QVariant QSqlQuery::boundValue ( int pos ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the value for the placeholder at position \fIpos\fR. +.SH "QMap<QString, QVariant> QSqlQuery::boundValues () const" +Returns a map of the bound values. +.PP +The bound values can be examined in the following way: +.PP +.nf +.br + QSqlQuery query; +.br + ... +.br + // Examine the bound values - bound using named binding +.br + QMap<QString, QVariant>::ConstIterator it; +.br + QMap<QString, QVariant> vals = query.boundValues(); +.br + for ( it = vals.begin(); it != vals.end(); ++it ) +.br + tqWarning( "Placeholder: " + it.key() + ", Value: " + (*it).toString() ); +.br + ... +.br +.br + // Examine the bound values - bound using positional binding +.br + QValueList<QVariant>::ConstIterator it; +.br + QValueList<QVariant> list = query.boundValues().values(); +.br + int i = 0; +.br + for ( it = list.begin(); it != list.end(); ++it ) +.br + tqWarning( "Placeholder pos: %d, Value: " + (*it).toString(), i++ ); +.br + ... +.br +.br +.fi +.SH "const QSqlDriver * QSqlQuery::driver () const" +Returns the database driver associated with the query. +.SH "bool QSqlQuery::exec ( const QString & query )\fC [virtual]\fR" +Executes the SQL in \fIquery\fR. Returns TRUE and sets the query state to active if the query was successful; otherwise returns FALSE and sets the query state to inactive. The \fIquery\fR string must use syntax appropriate for the SQL database being queried, for example, standard SQL. +.PP +After the query is executed, the query is positioned on an \fIinvalid\fR record, and must be navigated to a valid record before data values can be retrieved, e.g. using next(). +.PP +Note that the last error for this query is reset when exec() is called. +.PP +See also isActive(), isValid(), next(), prev(), first(), last(), and seek(). +.PP +Examples: +.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/basicdatamanip/main.cpp, and sql/overview/connection.cpp. +.SH "bool QSqlQuery::exec ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Executes a previously prepared SQL query. Returns TRUE if the query executed successfully; otherwise returns FALSE. +.PP +See also prepare(), bindValue(), and addBindValue(). +.SH "QString QSqlQuery::executedQuery () const" +Returns the last query that was executed. +.PP +In most cases this function returns the same as lastQuery(). If a prepared query with placeholders is executed on a DBMS that does not support it, the preparation of this query is emulated. The placeholders in the original query are replaced with their bound values to form a new query. This function returns the modified query. Useful for debugging purposes. +.PP +See also lastQuery(). +.SH "bool QSqlQuery::first ()\fC [virtual]\fR" +Retrieves the first record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. Returns TRUE if successful. If unsuccessful the query position is set to an invalid position and FALSE is returned. +.PP +See also next(), prev(), last(), seek(), at(), isActive(), and isValid(). +.PP +Example: sql/overview/navigating/main.cpp. +.SH "bool QSqlQuery::isActive () const" +Returns TRUE if the query is currently active; otherwise returns FALSE. +.PP +Examples: +.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/basicdatamanip/main.cpp, sql/overview/navigating/main.cpp, and sql/overview/retrieve1/main.cpp. +.SH "bool QSqlQuery::isForwardOnly () const" +Returns TRUE if you can only scroll \fIforward\fR through a result set; otherwise returns FALSE. +.PP +See also setForwardOnly(). +.SH "bool QSqlQuery::isNull ( int field ) const" +Returns TRUE if the query is active and positioned on a valid record and the \fIfield\fR is NULL; otherwise returns FALSE. Note that for some drivers isNull() will not return accurate information until after an attempt is made to retrieve data. +.PP +See also isActive(), isValid(), and value(). +.SH "bool QSqlQuery::isSelect () const" +Returns TRUE if the current query is a \fCSELECT\fR statement; otherwise returns FALSE. +.SH "bool QSqlQuery::isValid () const" +Returns TRUE if the query is currently positioned on a valid record; otherwise returns FALSE. +.SH "bool QSqlQuery::last ()\fC [virtual]\fR" +Retrieves the last record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. Returns TRUE if successful. If unsuccessful the query position is set to an invalid position and FALSE is returned. +.PP +See also next(), prev(), first(), seek(), at(), isActive(), and isValid(). +.PP +Example: sql/overview/navigating/main.cpp. +.SH "QSqlError QSqlQuery::lastError () const" +Returns error information about the last error (if any) that occurred. +.PP +See also QSqlError. +.SH "QString QSqlQuery::lastQuery () const" +Returns the text of the current query being used, or QString::null if there is no current query text. +.PP +See also executedQuery(). +.SH "bool QSqlQuery::next ()\fC [virtual]\fR" +Retrieves the next record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. +.PP +The following rules apply: +.TP +If the result is currently located before the first record, e.g. immediately after a query is executed, an attempt is made to retrieve the first record. +.IP +.TP +If the result is currently located after the last record, there is no change and FALSE is returned. +.IP +.TP +If the result is located somewhere in the middle, an attempt is made to retrieve the next record. +.PP +If the record could not be retrieved, the result is positioned after the last record and FALSE is returned. If the record is successfully retrieved, TRUE is returned. +.PP +See also prev(), first(), last(), seek(), at(), isActive(), and isValid(). +.PP +Examples: +.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/delete/main.cpp, sql/overview/order1/main.cpp, sql/overview/retrieve1/main.cpp, sql/overview/subclass4/main.cpp, and sql/overview/subclass5/main.cpp. +.SH "int QSqlQuery::numRowsAffected () const" +Returns the number of rows affected by the result's SQL statement, or -1 if it cannot be determined. Note that for \fCSELECT\fR statements, the value is undefined; see size() instead. If the query is not active (isActive() returns FALSE), -1 is returned. +.PP +See also size() and QSqlDriver::hasFeature(). +.PP +Examples: +.)l sql/overview/basicbrowsing2/main.cpp and sql/overview/basicdatamanip/main.cpp. +.SH "QSqlQuery & QSqlQuery::operator= ( const QSqlQuery & other )" +Assigns \fIother\fR to the query. +.SH "bool QSqlQuery::prepare ( const QString & query )" +Prepares the SQL query \fIquery\fR for execution. The query may contain placeholders for binding values. Both Oracle style colon-name (e.g. \fC:surname\fR), and ODBC style (e.g. \fC?\fR) placeholders are supported; but they cannot be mixed in the same query. See the Description for examples. +.PP +See also exec(), bindValue(), and addBindValue(). +.SH "bool QSqlQuery::prev ()\fC [virtual]\fR" +Retrieves the previous record in the result, if available, and positions the query on the retrieved record. Note that the result must be in an active state and isSelect() must return TRUE before calling this function or it will do nothing and return FALSE. +.PP +The following rules apply: +.TP +If the result is currently located before the first record, there is no change and FALSE is returned. +.IP +.TP +If the result is currently located after the last record, an attempt is made to retrieve the last record. +.IP +.TP +If the result is somewhere in the middle, an attempt is made to retrieve the previous record. +.PP +If the record could not be retrieved, the result is positioned before the first record and FALSE is returned. If the record is successfully retrieved, TRUE is returned. +.PP +See also next(), first(), last(), seek(), at(), isActive(), and isValid(). +.SH "const QSqlResult * QSqlQuery::result () const" +Returns the result associated with the query. +.SH "bool QSqlQuery::seek ( int i, bool relative = FALSE )\fC [virtual]\fR" +Retrieves the record at position (offset) \fIi\fR, if available, and positions the query on the retrieved record. The first record is at position 0. Note that the query must be in an active state and isSelect() must return TRUE before calling this function. +.PP +If \fIrelative\fR is FALSE (the default), the following rules apply: +.TP +If \fIi\fR is negative, the result is positioned before the first record and FALSE is returned. +.TP +Otherwise, an attempt is made to move to the record at position \fIi\fR. If the record at position \fIi\fR could not be retrieved, the result is positioned after the last record and FALSE is returned. If the record is successfully retrieved, TRUE is returned. +.PP +If \fIrelative\fR is TRUE, the following rules apply: +.TP +If the result is currently positioned before the first record or on the first record, and \fIi\fR is negative, there is no change, and FALSE is returned. +.TP +If the result is currently located after the last record, and \fIi\fR is positive, there is no change, and FALSE is returned. +.TP +If the result is currently located somewhere in the middle, and the relative offset \fIi\fR moves the result below zero, the result is positioned before the first record and FALSE is returned. +.TP +Otherwise, an attempt is made to move to the record \fIi\fR records ahead of the current record (or \fIi\fR records behind the current record if \fIi\fR is negative). If the record at offset \fIi\fR could not be retrieved, the result is positioned after the last record if \fIi\fR >= 0, (or before the first record if \fIi\fR is negative), and FALSE is returned. If the record is successfully retrieved, TRUE is returned. +.PP +See also next(), prev(), first(), last(), at(), isActive(), and isValid(). +.PP +Example: sql/overview/navigating/main.cpp. +.SH "void QSqlQuery::setForwardOnly ( bool forward )" +Sets forward only mode to \fIforward\fR. If forward is TRUE only next(), and seek() with positive values, are allowed for navigating the results. Forward only mode needs far less memory since results do not need to be cached. +.PP +Forward only mode is off by default. +.PP +Forward only mode cannot be used with data aware widgets like QDataTable, since they must to be able to scroll backward as well as forward. +.PP +See also isForwardOnly(), next(), and seek(). +.SH "int QSqlQuery::size () const" +Returns the size of the result, (number of rows returned), or -1 if the size cannot be determined or if the database does not support reporting information about query sizes. Note that for non-\fCSELECT\fR statements (isSelect() returns FALSE), size() will return -1. If the query is not active (isActive() returns FALSE), -1 is returned. +.PP +To determine the number of rows affected by a non-SELECT statement, use numRowsAffected(). +.PP +See also isActive(), numRowsAffected(), and QSqlDriver::hasFeature(). +.PP +Example: sql/overview/navigating/main.cpp. +.SH "QVariant QSqlQuery::value ( int i ) const\fC [virtual]\fR" +Returns the value of the \fIi\fR-th field in the query (zero based). +.PP +The fields are numbered from left to right using the text of the \fCSELECT\fR statement, e.g. in \fCSELECT forename, surname FROM people\fR, field 0 is \fCforename\fR and field 1 is \fCsurname\fR. Using \fCSELECT *\fR is not recommended because the order of the fields in the query is undefined. +.PP +An invalid QVariant is returned if field \fIi\fR does not exist, if the query is inactive, or if the query is positioned on an invalid record. +.PP +See also prev(), next(), first(), last(), seek(), isActive(), and isValid(). +.PP +Examples: +.)l sql/overview/basicbrowsing/main.cpp, sql/overview/basicbrowsing2/main.cpp, sql/overview/retrieve1/main.cpp, sql/overview/subclass3/main.cpp, sql/overview/subclass4/main.cpp, sql/overview/subclass5/main.cpp, and sql/overview/table4/main.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlquery.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlquery.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlrecord.3qt b/doc/man/man3/tqsqlrecord.3qt new file mode 100644 index 000000000..3eba8404c --- /dev/null +++ b/doc/man/man3/tqsqlrecord.3qt @@ -0,0 +1,268 @@ +'\" t +.TH QSqlRecord 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 +QSqlRecord \- Encapsulates a database record, i.e. a set of database fields +.SH SYNOPSIS +\fC#include <ntqsqlrecord.h>\fR +.PP +Inherited by QSqlCursor and QSqlIndex. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlRecord\fR ()" +.br +.ti -1c +.BI "\fBQSqlRecord\fR ( const QSqlRecord & other )" +.br +.ti -1c +.BI "QSqlRecord & \fBoperator=\fR ( const QSqlRecord & other )" +.br +.ti -1c +.BI "virtual \fB~QSqlRecord\fR ()" +.br +.ti -1c +.BI "virtual QVariant \fBvalue\fR ( int i ) const" +.br +.ti -1c +.BI "virtual QVariant \fBvalue\fR ( const QString & name ) const" +.br +.ti -1c +.BI "virtual void \fBsetValue\fR ( int i, const QVariant & val )" +.br +.ti -1c +.BI "virtual void \fBsetValue\fR ( const QString & name, const QVariant & val )" +.br +.ti -1c +.BI "bool \fBisGenerated\fR ( int i ) const" +.br +.ti -1c +.BI "bool \fBisGenerated\fR ( const QString & name ) const" +.br +.ti -1c +.BI "virtual void \fBsetGenerated\fR ( const QString & name, bool generated )" +.br +.ti -1c +.BI "virtual void \fBsetGenerated\fR ( int i, bool generated )" +.br +.ti -1c +.BI "virtual void \fBsetNull\fR ( int i )" +.br +.ti -1c +.BI "virtual void \fBsetNull\fR ( const QString & name )" +.br +.ti -1c +.BI "bool \fBisNull\fR ( int i ) const" +.br +.ti -1c +.BI "bool \fBisNull\fR ( const QString & name ) const" +.br +.ti -1c +.BI "int \fBposition\fR ( const QString & name ) const" +.br +.ti -1c +.BI "QString \fBfieldName\fR ( int i ) const" +.br +.ti -1c +.BI "QSqlField * \fBfield\fR ( int i )" +.br +.ti -1c +.BI "QSqlField * \fBfield\fR ( const QString & name )" +.br +.ti -1c +.BI "const QSqlField * \fBfield\fR ( int i ) const" +.br +.ti -1c +.BI "const QSqlField * \fBfield\fR ( const QString & name ) const" +.br +.ti -1c +.BI "virtual void \fBappend\fR ( const QSqlField & field )" +.br +.ti -1c +.BI "virtual void \fBinsert\fR ( int pos, const QSqlField & field )" +.br +.ti -1c +.BI "virtual void \fBremove\fR ( int pos )" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const QString & name ) const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBclearValues\fR ( bool nullify = FALSE )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "virtual QString \fBtoString\fR ( const QString & prefix = QString::null, const QString & sep = "","" ) const" +.br +.ti -1c +.BI "virtual QStringList \fBtoStringList\fR ( const QString & prefix = QString::null ) const" +.br +.in -1c +.SH DESCRIPTION +The QSqlRecord class encapsulates a database record, i.e. a set of database fields. +.PP +The QSqlRecord class encapsulates the functionality and characteristics of a database record (usually a table or view within the database). QSqlRecords support adding and removing fields as well as setting and retrieving field values. +.PP +QSqlRecord is implicitly shared. This means you can make copies of the record in time O(1). If multiple QSqlRecord instances share the same data and one is modifying the record's data then this modifying instance makes a copy and modifies its private copy - thus it does not affect other instances. +.PP +See also QSqlRecordInfo and Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlRecord::QSqlRecord ()" +Constructs an empty record. +.SH "QSqlRecord::QSqlRecord ( const QSqlRecord & other )" +Constructs a copy of \fIother\fR. +.SH "QSqlRecord::~QSqlRecord ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "void QSqlRecord::append ( const QSqlField & field )\fC [virtual]\fR" +Append a copy of field \fIfield\fR to the end of the record. +.PP +Reimplemented in QSqlIndex. +.SH "void QSqlRecord::clear ()\fC [virtual]\fR" +Removes all the record's fields. +.PP +See also clearValues(). +.PP +Reimplemented in QSqlCursor. +.SH "void QSqlRecord::clearValues ( bool nullify = FALSE )\fC [virtual]\fR" +Clears the value of all fields in the record. If \fInullify\fR is TRUE, (the default is FALSE), each field is set to NULL. +.SH "bool QSqlRecord::contains ( const QString & name ) const" +Returns TRUE if there is a field in the record called \fIname\fR; otherwise returns FALSE. +.SH "uint QSqlRecord::count () const" +Returns the number of fields in the record. +.SH "QSqlField * QSqlRecord::field ( int i )" +Returns the field at position \fIi\fR within the record, or 0 if it cannot be found. +.SH "QSqlField * QSqlRecord::field ( const QString & name )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the field called \fIname\fR within the record, or 0 if it cannot be found. Field names are not case-sensitive. +.SH "const QSqlField * QSqlRecord::field ( int i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "const QSqlField * QSqlRecord::field ( const QString & name ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the field called \fIname\fR within the record, or 0 if it cannot be found. Field names are not case-sensitive. +.SH "QString QSqlRecord::fieldName ( int i ) const" +Returns the name of the field at position \fIi\fR. If the field does not exist, QString::null is returned. +.SH "void QSqlRecord::insert ( int pos, const QSqlField & field )\fC [virtual]\fR" +Insert a copy of \fIfield\fR at position \fIpos\fR. If a field already exists at \fIpos\fR, it is removed. +.SH "bool QSqlRecord::isEmpty () const" +Returns TRUE if there are no fields in the record; otherwise returns FALSE. +.SH "bool QSqlRecord::isGenerated ( const QString & name ) const" +Returns TRUE if the record has a field called \fIname\fR and this field is to be generated (the default); otherwise returns FALSE. +.PP +See also setGenerated(). +.SH "bool QSqlRecord::isGenerated ( int i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the record has a field at position \fIi\fR and this field is to be generated (the default); otherwise returns FALSE. +.PP +See also setGenerated(). +.SH "bool QSqlRecord::isNull ( const QString & name ) const" +Returns TRUE if the field called \fIname\fR is NULL or if there is no field called \fIname\fR; otherwise returns FALSE. +.PP +See also position(). +.SH "bool QSqlRecord::isNull ( int i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the field \fIi\fR is NULL or if there is no field at position \fIi\fR; otherwise returns FALSE. +.PP +See also fieldName(). +.SH "QSqlRecord & QSqlRecord::operator= ( const QSqlRecord & other )" +Sets the record equal to \fIother\fR. +.SH "int QSqlRecord::position ( const QString & name ) const" +Returns the position of the field called \fIname\fR within the record, or -1 if it cannot be found. Field names are not case-sensitive. If more than one field matches, the first one is returned. +.SH "void QSqlRecord::remove ( int pos )\fC [virtual]\fR" +Removes the field at \fIpos\fR. If \fIpos\fR does not exist, nothing happens. +.PP +Reimplemented in QSqlCursor. +.SH "void QSqlRecord::setGenerated ( const QString & name, bool generated )\fC [virtual]\fR" +Sets the generated flag for the field called \fIname\fR to \fIgenerated\fR. If the field does not exist, nothing happens. Only fields that have \fIgenerated\fR set to TRUE are included in the SQL that is generated, e.g. by QSqlCursor. +.PP +See also isGenerated(). +.PP +Reimplemented in QSqlCursor. +.SH "void QSqlRecord::setGenerated ( int i, bool generated )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the generated flag for the field \fIi\fR to \fIgenerated\fR. +.PP +See also isGenerated(). +.PP +Reimplemented in QSqlCursor. +.SH "void QSqlRecord::setNull ( int i )\fC [virtual]\fR" +Sets the value of field \fIi\fR to NULL. If the field does not exist, nothing happens. +.SH "void QSqlRecord::setNull ( const QString & name )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the value of the field called \fIname\fR to NULL. If the field does not exist, nothing happens. +.SH "void QSqlRecord::setValue ( int i, const QVariant & val )\fC [virtual]\fR" +Sets the value of the field at position \fIi\fR to \fIval\fR. If the field does not exist, nothing happens. +.PP +Examples: +.)l sql/overview/insert/main.cpp, sql/overview/insert2/main.cpp, sql/overview/subclass5/main.cpp, sql/overview/update/main.cpp, and sql/sqltable/main.cpp. +.SH "void QSqlRecord::setValue ( const QString & name, const QVariant & val )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the value of the field called \fIname\fR to \fIval\fR. If the field does not exist, nothing happens. +.SH "QString QSqlRecord::toString ( const QString & prefix = QString::null, const QString & sep = "," ) const\fC [virtual]\fR" +Returns a list of all the record's field names as a string separated by \fIsep\fR. +.PP +Note that fields which are not generated are \fInot\fR included (see isGenerated()). The returned string is suitable, for example, for generating SQL SELECT statements. If a \fIprefix\fR is specified, e.g. a table name, all fields are prefixed in the form: +.PP" +\fIprefix\fR.<fieldname>" +.SH "QStringList QSqlRecord::toStringList ( const QString & prefix = QString::null ) const\fC [virtual]\fR" +Returns a list of all the record's field names, each having the prefix \fIprefix\fR. +.PP +Note that fields which have generated set to FALSE are \fInot\fR included. (See isGenerated()). If \fIprefix\fR is supplied, e.g. a table name, all fields are prefixed in the form: +.PP" +\fIprefix\fR.<fieldname>" +.SH "QVariant QSqlRecord::value ( int i ) const\fC [virtual]\fR" +Returns the value of the field located at position \fIi\fR in the record. If field \fIi\fR does not exist the resultant behaviour is undefined. +.PP +This function should be used with QSqlQuerys. When working with a QSqlCursor the value(const QString&) overload which uses field names is more appropriate. +.PP +Example: sql/overview/update/main.cpp. +.SH "QVariant QSqlRecord::value ( const QString & name ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the value of the field called \fIname\fR in the record. If +field \fIname\fR does not exist the resultant behaviour is undefined. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlrecord.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlrecord.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlrecordinfo.3qt b/doc/man/man3/tqsqlrecordinfo.3qt new file mode 100644 index 000000000..25f83617f --- /dev/null +++ b/doc/man/man3/tqsqlrecordinfo.3qt @@ -0,0 +1,79 @@ +'\" t +.TH QSqlRecordInfo 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 +QSqlRecordInfo \- Encapsulates a set of database field meta data +.SH SYNOPSIS +\fC#include <ntqsqlrecord.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlRecordInfo\fR ()" +.br +.ti -1c +.BI "\fBQSqlRecordInfo\fR ( const QSqlFieldInfoList & other )" +.br +.ti -1c +.BI "\fBQSqlRecordInfo\fR ( const QSqlRecord & other )" +.br +.ti -1c +.BI "size_type \fBcontains\fR ( const QString & fieldName ) const" +.br +.ti -1c +.BI "QSqlFieldInfo \fBfind\fR ( const QString & fieldName ) const" +.br +.ti -1c +.BI "QSqlRecord \fBtoRecord\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QSqlRecordInfo class encapsulates a set of database field meta data. +.PP +This class is a QValueList that holds a set of database field meta data. Use contains() to see if a given field name exists in the record, and use find() to get a QSqlFieldInfo record for a named field. +.PP +See also QValueList, QSqlFieldInfo, and Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlRecordInfo::QSqlRecordInfo ()" +Constructs an empty record info object +.SH "QSqlRecordInfo::QSqlRecordInfo ( const QSqlFieldInfoList & other )" +Constructs a copy of \fIother\fR. +.SH "QSqlRecordInfo::QSqlRecordInfo ( const QSqlRecord & other )" +Constructs a QSqlRecordInfo object based on the fields in the QSqlRecord \fIother\fR. +.SH "size_type QSqlRecordInfo::contains ( const QString & fieldName ) const" +Returns the number of times a field called \fIfieldName\fR occurs in the record. Returns 0 if no field by that name could be found. +.SH "QSqlFieldInfo QSqlRecordInfo::find ( const QString & fieldName ) const" +Returns a QSqlFieldInfo object for the first field in the record which has the field name \fIfieldName\fR. If no matching field is found then an empty QSqlFieldInfo object is returned. +.SH "QSqlRecord QSqlRecordInfo::toRecord () const" +Returns an empty QSqlRecord based on the field information +in this QSqlRecordInfo. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qsqlrecordinfo.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlrecordinfo.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlresult.3qt b/doc/man/man3/tqsqlresult.3qt new file mode 100644 index 000000000..89d3482c2 --- /dev/null +++ b/doc/man/man3/tqsqlresult.3qt @@ -0,0 +1,189 @@ +'\" t +.TH QSqlResult 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 +QSqlResult \- Abstract interface for accessing data from SQL databases +.SH SYNOPSIS +\fC#include <ntqsqlresult.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QSqlResult\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQSqlResult\fR ( const QSqlDriver * db )" +.br +.ti -1c +.BI "int \fBat\fR () const" +.br +.ti -1c +.BI "QString \fBlastQuery\fR () const" +.br +.ti -1c +.BI "QSqlError \fBlastError\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "bool \fBisActive\fR () const" +.br +.ti -1c +.BI "bool \fBisSelect\fR () const" +.br +.ti -1c +.BI "bool \fBisForwardOnly\fR () const" +.br +.ti -1c +.BI "const QSqlDriver * \fBdriver\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAt\fR ( int at )" +.br +.ti -1c +.BI "virtual void \fBsetActive\fR ( bool a )" +.br +.ti -1c +.BI "virtual void \fBsetLastError\fR ( const QSqlError & e )" +.br +.ti -1c +.BI "virtual void \fBsetQuery\fR ( const QString & query )" +.br +.ti -1c +.BI "virtual void \fBsetSelect\fR ( bool s )" +.br +.ti -1c +.BI "virtual void \fBsetForwardOnly\fR ( bool forward )" +.br +.ti -1c +.BI "virtual QVariant \fBdata\fR ( int i ) = 0" +.br +.ti -1c +.BI "virtual bool \fBisNull\fR ( int i ) = 0" +.br +.ti -1c +.BI "virtual bool \fBreset\fR ( const QString & query ) = 0" +.br +.ti -1c +.BI "virtual bool \fBfetch\fR ( int i ) = 0" +.br +.ti -1c +.BI "virtual bool \fBfetchNext\fR ()" +.br +.ti -1c +.BI "virtual bool \fBfetchPrev\fR ()" +.br +.ti -1c +.BI "virtual bool \fBfetchFirst\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBfetchLast\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBsize\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBnumRowsAffected\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QSqlResult class provides an abstract interface for accessing data from SQL databases. +.PP +Normally you would use QSqlQuery instead of QSqlResult since QSqlQuery provides a generic wrapper for database-specific implementations of QSqlResult. +.PP +See also QSql and Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlResult::QSqlResult ( const QSqlDriver * db )\fC [protected]\fR" +Protected constructor which creates a QSqlResult using database \fIdb\fR. The object is initialized to an inactive state. +.SH "QSqlResult::~QSqlResult ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "int QSqlResult::at () const\fC [protected]\fR" +Returns the current (zero-based) position of the result. +.SH "QVariant QSqlResult::data ( int i )\fC [pure virtual protected]\fR" +Returns the data for field \fIi\fR (zero-based) as a QVariant. This function is only called if the result is in an active state and is positioned on a valid record and \fIi\fR is non-negative. Derived classes must reimplement this function and return the value of field \fIi\fR, or QVariant() if it cannot be determined. +.SH "const QSqlDriver * QSqlResult::driver () const\fC [protected]\fR" +Returns the driver associated with the result. +.SH "bool QSqlResult::fetch ( int i )\fC [pure virtual protected]\fR" +Positions the result to an arbitrary (zero-based) index \fIi\fR. This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the index \fIi\fR, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. +.SH "bool QSqlResult::fetchFirst ()\fC [pure virtual protected]\fR" +Positions the result to the first record in the result. This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the first record, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. +.SH "bool QSqlResult::fetchLast ()\fC [pure virtual protected]\fR" +Positions the result to the last record in the result. This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the last record, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. +.SH "bool QSqlResult::fetchNext ()\fC [virtual protected]\fR" +Positions the result to the next available record in the result. This function is only called if the result is in an active state. The default implementation calls fetch() with the next index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. +.SH "bool QSqlResult::fetchPrev ()\fC [virtual protected]\fR" +Positions the result to the previous available record in the result. This function is only called if the result is in an active state. The default implementation calls fetch() with the previous index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return TRUE to indicate success, or FALSE to signify failure. +.SH "bool QSqlResult::isActive () const\fC [protected]\fR" +Returns TRUE if the result has records to be retrieved; otherwise returns FALSE. +.SH "bool QSqlResult::isForwardOnly () const\fC [protected]\fR" +Returns TRUE if you can only scroll forward through a result set; otherwise returns FALSE. +.SH "bool QSqlResult::isNull ( int i )\fC [pure virtual protected]\fR" +Returns TRUE if the field at position \fIi\fR is NULL; otherwise returns FALSE. +.SH "bool QSqlResult::isSelect () const\fC [protected]\fR" +Returns TRUE if the current result is from a SELECT statement; otherwise returns FALSE. +.SH "bool QSqlResult::isValid () const\fC [protected]\fR" +Returns TRUE if the result is positioned on a valid record (that is, the result is not positioned before the first or after the last record); otherwise returns FALSE. +.SH "QSqlError QSqlResult::lastError () const\fC [protected]\fR" +Returns the last error associated with the result. +.SH "QString QSqlResult::lastQuery () const\fC [protected]\fR" +Returns the current SQL query text, or QString::null if there is none. +.SH "int QSqlResult::numRowsAffected ()\fC [pure virtual protected]\fR" +Returns the number of rows affected by the last query executed. +.SH "bool QSqlResult::reset ( const QString & query )\fC [pure virtual protected]\fR" +Sets the result to use the SQL statement \fIquery\fR for subsequent data retrieval. Derived classes must reimplement this function and apply the \fIquery\fR to the database. This function is called only after the result is set to an inactive state and is positioned before the first record of the new result. Derived classes should return TRUE if the query was successful and ready to be used, or FALSE otherwise. +.SH "void QSqlResult::setActive ( bool a )\fC [virtual protected]\fR" +Protected function provided for derived classes to set the internal active state to the value of \fIa\fR. +.PP +See also isActive(). +.SH "void QSqlResult::setAt ( int at )\fC [virtual protected]\fR" +Protected function provided for derived classes to set the internal (zero-based) result index to \fIat\fR. +.PP +See also at(). +.SH "void QSqlResult::setForwardOnly ( bool forward )\fC [virtual protected]\fR" +Sets forward only mode to \fIforward\fR. If forward is TRUE only fetchNext() is allowed for navigating the results. Forward only mode needs far less memory since results do not have to be cached. forward only mode is off by default. +.PP +See also fetchNext(). +.SH "void QSqlResult::setLastError ( const QSqlError & e )\fC [virtual protected]\fR" +Protected function provided for derived classes to set the last error to the value of \fIe\fR. +.PP +See also lastError(). +.SH "void QSqlResult::setQuery ( const QString & query )\fC [virtual protected]\fR" +Sets the current query for the result to \fIquery\fR. The result must be reset() in order to execute the query on the database. +.SH "void QSqlResult::setSelect ( bool s )\fC [virtual protected]\fR" +Protected function provided for derived classes to indicate whether or not the current statement is a SQL SELECT statement. The \fIs\fR parameter should be TRUE if the statement is a SELECT statement, or FALSE otherwise. +.SH "int QSqlResult::size ()\fC [pure virtual protected]\fR" +Returns the size of the result or -1 if it cannot be determined. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlresult.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlresult.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsqlselectcursor.3qt b/doc/man/man3/tqsqlselectcursor.3qt new file mode 100644 index 000000000..051f73e9f --- /dev/null +++ b/doc/man/man3/tqsqlselectcursor.3qt @@ -0,0 +1,91 @@ +'\" t +.TH QSqlSelectCursor 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 +QSqlSelectCursor \- Browsing of general SQL SELECT statements +.SH SYNOPSIS +\fC#include <ntqsqlselectcursor.h>\fR +.PP +Inherits QSqlCursor. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSqlSelectCursor\fR ( const QString & query = QString::null, QSqlDatabase * db = 0 )" +.br +.ti -1c +.BI "\fBQSqlSelectCursor\fR ( const QSqlSelectCursor & other )" +.br +.ti -1c +.BI "\fB~QSqlSelectCursor\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QSqlSelectCursor class provides browsing of general SQL SELECT statements. +.PP +QSqlSelectCursor is a convenience class that makes it possible to display result sets from general SQL \fCSELECT\fR statements in data-aware Qt widgets. QSqlSelectCursor is read-only and does not support \fCINSERT\fR, \fCUPDATE\fR or \fCDELETE\fR operations. +.PP +Pass the query in at construction time, or use the QSqlSelectCursor::exec() function. +.PP +Example: +.PP +.nf +.br + ... +.br + QSqlSelectCursor* cur = new QSqlSelectCursor( "SELECT id, firstname, lastname FROM author" ); +.br + QDataTable* table = new QDataTable( this ); +.br + table->setSqlCursor( cur, TRUE, TRUE ); +.br + table->refresh(); +.br + ... +.br + cur->exec( "SELECT * FROM books" ); +.br + table->refresh(); +.br + ... +.br +.fi +.PP +See also Database Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSqlSelectCursor::QSqlSelectCursor ( const QString & query = QString::null, QSqlDatabase * db = 0 )" +Constructs a read only cursor on database \fIdb\fR using the query \fIquery\fR. +.SH "QSqlSelectCursor::QSqlSelectCursor ( const QSqlSelectCursor & other )" +Constructs a copy of \fIother\fR +.SH "QSqlSelectCursor::~QSqlSelectCursor ()" +Destroys the object and frees any allocated resources + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsqlselectcursor.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsqlselectcursor.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstatusbar.3qt b/doc/man/man3/tqstatusbar.3qt new file mode 100644 index 000000000..af6057bf5 --- /dev/null +++ b/doc/man/man3/tqstatusbar.3qt @@ -0,0 +1,209 @@ +'\" t +.TH QStatusBar 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 +QStatusBar \- Horizontal bar suitable for presenting status information +.SH SYNOPSIS +\fC#include <ntqstatusbar.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStatusBar\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QStatusBar\fR ()" +.br +.ti -1c +.BI "virtual void \fBaddWidget\fR ( QWidget * widget, int stretch = 0, bool permanent = FALSE )" +.br +.ti -1c +.BI "virtual void \fBremoveWidget\fR ( QWidget * widget )" +.br +.ti -1c +.BI "void \fBsetSizeGripEnabled\fR ( bool )" +.br +.ti -1c +.BI "bool \fBisSizeGripEnabled\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBmessage\fR ( const QString & message )" +.br +.ti -1c +.BI "void \fBmessage\fR ( const QString & message, int ms )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBmessageChanged\fR ( const QString & message )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBsizeGripEnabled\fR - whether the QSizeGrip in the bottom right of the status bar is enabled" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" +.br +.ti -1c +.BI "void \fBreformat\fR ()" +.br +.ti -1c +.BI "void \fBhideOrShow\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QStatusBar class provides a horizontal bar suitable for presenting status information. +.PP +Each status indicator falls into one of three categories: +.TP +\fITemporary\fR - briefly occupies most of the status bar. Used to explain tool tip texts or menu entries, for example. +.TP +\fINormal\fR - occupies part of the status bar and may be hidden by temporary messages. Used to display the page and line number in a word processor, for example. +.TP +\fIPermanent\fR - is never hidden. Used for important mode indications, for example, some applications put a Caps Lock indicator in the status bar. +.PP +QStatusBar lets you display all three types of indicators. +.PP +To display a \fItemporary\fR message, call message() (perhaps by connecting a suitable signal to it). To remove a temporary message, call clear(). There are two variants of message(): one that displays the message until the next clear() or message() and one that has a time limit: +.PP +.nf +.br + connect( loader, SIGNAL(progressMessage(const QString&)), +.br + statusBar(), SLOT(message(const QString&)) ); +.br +.br + statusBar()->message("Loading..."); // Initial message +.br + loader.loadStuff(); // Emits progress messages +.br + statusBar()->message("Done.", 2000); // Final message for 2 seconds +.br +.fi +.PP +\fINormal\fR and \fIPermanent\fR messages are displayed by creating a small widget and then adding it to the status bar with addWidget(). Widgets like QLabel, QProgressBar or even QToolButton are useful for adding to status bars. removeWidget() is used to remove widgets. +.PP +.nf +.br + statusBar()->addWidget(new MyReadWriteIndication(statusBar())); +.br +.fi +.PP +By default QStatusBar provides a QSizeGrip in the lower-right corner. You can disable it with setSizeGripEnabled(FALSE); +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QToolBar, QMainWindow, QLabel, GUI Design Handbook: Status Bar, Main Window and Related Classes, and Help System. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStatusBar::QStatusBar ( QWidget * parent = 0, const char * name = 0 )" +Constructs a status bar called \fIname\fR with parent \fIparent\fR and with a size grip. +.PP +See also sizeGripEnabled. +.SH "QStatusBar::~QStatusBar ()\fC [virtual]\fR" +Destroys the status bar and frees any allocated resources and child widgets. +.SH "void QStatusBar::addWidget ( QWidget * widget, int stretch = 0, bool permanent = FALSE )\fC [virtual]\fR" +Adds \fIwidget\fR to this status bar. \fIwidget\fR is reparented if it isn't already a child of the QStatusBar. +.PP +\fIwidget\fR is permanently visible if \fIpermanent\fR is TRUE and may be obscured by temporary messages if \fIpermanent\fR is FALSE. The default is FALSE. +.PP +If \fIpermanent\fR is TRUE, \fIwidget\fR is located at the far right of the status bar. If \fIpermanent\fR is FALSE (the default), \fIwidget\fR is located just to the left of the first permanent widget. +.PP +\fIstretch\fR is used to compute a suitable size for \fIwidget\fR as the status bar grows and shrinks. The default of 0 uses a minimum of space. +.PP +This function may cause some flicker. +.PP +See also removeWidget(). +.SH "void QStatusBar::clear ()\fC [slot]\fR" +Removes any temporary message being shown. +.PP +See also message(). +.SH "void QStatusBar::hideOrShow ()\fC [protected]\fR" +Ensures that the right widgets are visible. Used by message() and clear(). +.SH "bool QStatusBar::isSizeGripEnabled () const" +Returns TRUE if the QSizeGrip in the bottom right of the status bar is enabled; otherwise returns FALSE. See the "sizeGripEnabled" property for details. +.SH "void QStatusBar::message ( const QString & message )\fC [slot]\fR" +Hides the normal status indicators and displays \fImessage\fR until clear() or another message() is called. +.PP +See also clear(). +.PP +Example: regexptester/regexptester.cpp. +.SH "void QStatusBar::message ( const QString & message, int ms )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Hides the normal status indications and displays \fImessage\fR for \fIms\fR milli-seconds or until clear() or another message() is called, whichever occurs first. +.SH "void QStatusBar::messageChanged ( const QString & message )\fC [signal]\fR" +This signal is emitted when the temporary status messages changes. \fImessage\fR is the new temporary message, and is a null-string when the message has been removed. +.PP +See also message() and clear(). +.SH "void QStatusBar::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" +Shows the temporary message, if appropriate. +.PP +Reimplemented from QWidget. +.SH "void QStatusBar::reformat ()\fC [protected]\fR" +Changes the status bar's appearance to account for item changes. Special subclasses may need this, but geometry management will usually take care of any necessary rearrangements. +.SH "void QStatusBar::removeWidget ( QWidget * widget )\fC [virtual]\fR" +Removes \fIwidget\fR from the status bar. +.PP +This function may cause some flicker. +.PP +Note that \fIwidget\fR is not deleted. +.PP +See also addWidget(). +.SH "void QStatusBar::setSizeGripEnabled ( bool )" +Sets whether the QSizeGrip in the bottom right of the status bar is enabled. See the "sizeGripEnabled" property for details. +.SS "Property Documentation" +.SH "bool sizeGripEnabled" +This property holds whether the QSizeGrip in the bottom right of the status bar is enabled. +.PP +Enables or disables the QSizeGrip in the bottom right of the status bar. By default, the size grip is enabled. +.PP +Set this property's value with setSizeGripEnabled() and get this property's value with isSizeGripEnabled(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstatusbar.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstatusbar.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstoreddrag.3qt b/doc/man/man3/tqstoreddrag.3qt new file mode 100644 index 000000000..45350d317 --- /dev/null +++ b/doc/man/man3/tqstoreddrag.3qt @@ -0,0 +1,83 @@ +'\" t +.TH QStoredDrag 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 +QStoredDrag \- Simple stored-value drag object for arbitrary MIME data +.SH SYNOPSIS +\fC#include <ntqdragobject.h>\fR +.PP +Inherits QDragObject. +.PP +Inherited by QUriDrag and QColorDrag. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStoredDrag\fR ( const char * mimeType, QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QStoredDrag\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetEncodedData\fR ( const QByteArray & encodedData )" +.br +.ti -1c +.BI "virtual QByteArray \fBencodedData\fR ( const char * m ) const" +.br +.in -1c +.SH DESCRIPTION +The QStoredDrag class provides a simple stored-value drag object for arbitrary MIME data. +.PP +When a block of data has only one representation, you can use a QStoredDrag to hold it. +.PP +For more information about drag and drop, see the QDragObject class and the drag and drop documentation. +.PP +See also Drag And Drop Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStoredDrag::QStoredDrag ( const char * mimeType, QWidget * dragSource = 0, const char * name = 0 )" +Constructs a QStoredDrag. The \fIdragSource\fR and \fIname\fR are passed to the QDragObject constructor, and the format is set to \fImimeType\fR. +.PP +The data will be unset. Use setEncodedData() to set it. +.SH "QStoredDrag::~QStoredDrag ()" +Destroys the drag object and frees up all allocated resources. +.SH "QByteArray QStoredDrag::encodedData ( const char * m ) const\fC [virtual]\fR" +Returns the stored data. \fIm\fR contains the data's format. +.PP +See also setEncodedData(). +.PP +Reimplemented from QMimeSource. +.SH "void QStoredDrag::setEncodedData ( const QByteArray & encodedData )\fC [virtual]\fR" +Sets the encoded data of this drag object to \fIencodedData\fR. The encoded data is what's delivered to the drop sites. It must be in a strictly defined and portable format. +.PP +The drag object can't be dropped (by the user) until this function +has been called. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qstoreddrag.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstoreddrag.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstrilist.3qt b/doc/man/man3/tqstrilist.3qt new file mode 100644 index 000000000..5589a0c87 --- /dev/null +++ b/doc/man/man3/tqstrilist.3qt @@ -0,0 +1,64 @@ +'\" t +.TH QStrIList 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 +QStrIList \- Doubly-linked list of char* with case-insensitive comparison +.SH SYNOPSIS +\fC#include <ntqstrlist.h>\fR +.PP +Inherits QStrList. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStrIList\fR ( bool deepCopies = TRUE )" +.br +.ti -1c +.BI "\fB~QStrIList\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QStrIList class provides a doubly-linked list of char* with case-insensitive comparison. +.PP +This class is a QPtrList<char> instance (a list of char*). +.PP +QStrIList is identical to QStrList except that the virtual compareItems() function is reimplemented to compare strings case-insensitively. The inSort() function inserts strings in a sorted order. In general it is fastest to insert the strings as they come and sort() at the end; inSort() is useful when you just have to add a few extra strings to an already sorted list. +.PP +The QStrListIterator class works for QStrIList. +.PP +See also QStringList, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStrIList::QStrIList ( bool deepCopies = TRUE )" +Constructs a list of strings. Will make deep copies of all inserted strings if \fIdeepCopies\fR is TRUE, or use shallow copies if \fIdeepCopies\fR is FALSE. +.SH "QStrIList::~QStrIList ()" +Destroys the list. All strings are removed. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qstrilist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstrilist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstring.3qt b/doc/man/man3/tqstring.3qt new file mode 100644 index 000000000..89f2798ba --- /dev/null +++ b/doc/man/man3/tqstring.3qt @@ -0,0 +1,2553 @@ +'\" t +.TH QString 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 +QString \- Abstraction of Unicode text and the classic C '\0'-terminated char array +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqstring.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQString\fR ()" +.br +.ti -1c +.BI "\fBQString\fR ( QChar ch )" +.br +.ti -1c +.BI "\fBQString\fR ( const QString & s )" +.br +.ti -1c +.BI "\fBQString\fR ( const QByteArray & ba )" +.br +.ti -1c +.BI "\fBQString\fR ( const QChar * unicode, uint length )" +.br +.ti -1c +.BI "\fBQString\fR ( const char * str )" +.br +.ti -1c +.BI "\fBQString\fR ( const std::string & str )" +.br +.ti -1c +.BI "\fB~QString\fR ()" +.br +.ti -1c +.BI "QString & \fBoperator=\fR ( const QString & s )" +.br +.ti -1c +.BI "QString & \fBoperator=\fR ( const char * str )" +.br +.ti -1c +.BI "QString & \fBoperator=\fR ( const std::string & s )" +.br +.ti -1c +.BI "QString & \fBoperator=\fR ( const QCString & cstr )" +.br +.ti -1c +.BI "QString & \fBoperator=\fR ( QChar c )" +.br +.ti -1c +.BI "QString & \fBoperator=\fR ( char c )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "uint \fBlength\fR () const" +.br +.ti -1c +.BI "void \fBtruncate\fR ( uint newLen )" +.br +.ti -1c +.BI "QString & \fBfill\fR ( QChar c, int len = -1 )" +.br +.ti -1c +.BI "QString copy () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString \fBarg\fR ( long a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( ulong a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( TQ_LLONG a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( TQ_ULLONG a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( int a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( uint a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( short a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( ushort a, int fieldWidth = 0, int base = 10 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( double a, int fieldWidth = 0, char fmt = 'g', int prec = -1 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( char a, int fieldWidth = 0 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( QChar a, int fieldWidth = 0 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( const QString & a, int fieldWidth = 0 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( const QString & a1, const QString & a2 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( const QString & a1, const QString & a2, const QString & a3 ) const" +.br +.ti -1c +.BI "QString \fBarg\fR ( const QString & a1, const QString & a2, const QString & a3, const QString & a4 ) const" +.br +.ti -1c +.BI "QString & \fBsprintf\fR ( const char * cformat, ... )" +.br +.ti -1c +.BI "int \fBfind\fR ( QChar c, int index = 0, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( char c, int index = 0, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( const QString & str, int index = 0, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( const QRegExp & rx, int index = 0 ) const" +.br +.ti -1c +.BI "int \fBfind\fR ( const char * str, int index = 0 ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( QChar c, int index = -1, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( char c, int index = -1, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( const QString & str, int index = -1, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( const QRegExp & rx, int index = -1 ) const" +.br +.ti -1c +.BI "int \fBfindRev\fR ( const char * str, int index = -1 ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( QChar c, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( char c, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( const char * str, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( const QString & str, bool cs = TRUE ) const" +.br +.ti -1c +.BI "int \fBcontains\fR ( const QRegExp & rx ) const" +.br +.ti -1c +.BI "enum \fBSectionFlags\fR { SectionDefault = 0x00, SectionSkipEmpty = 0x01, SectionIncludeLeadingSep = 0x02, SectionIncludeTrailingSep = 0x04, SectionCaseInsensitiveSeps = 0x08 }" +.br +.ti -1c +.BI "QString \fBsection\fR ( QChar sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +.br +.ti -1c +.BI "QString \fBsection\fR ( char sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +.br +.ti -1c +.BI "QString \fBsection\fR ( const char * sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +.br +.ti -1c +.BI "QString \fBsection\fR ( const QString & sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +.br +.ti -1c +.BI "QString \fBsection\fR ( const QRegExp & reg, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +.br +.ti -1c +.BI "QString \fBleft\fR ( uint len ) const" +.br +.ti -1c +.BI "QString \fBright\fR ( uint len ) const" +.br +.ti -1c +.BI "QString \fBmid\fR ( uint index, uint len = 0xffffffff ) const" +.br +.ti -1c +.BI "QString \fBleftJustify\fR ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" +.br +.ti -1c +.BI "QString \fBrightJustify\fR ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" +.br +.ti -1c +.BI "QString \fBlower\fR () const" +.br +.ti -1c +.BI "QString \fBupper\fR () const" +.br +.ti -1c +.BI "QString \fBstripWhiteSpace\fR () const" +.br +.ti -1c +.BI "QString \fBsimplifyWhiteSpace\fR () const" +.br +.ti -1c +.BI "QString & \fBinsert\fR ( uint index, const QString & s )" +.br +.ti -1c +.BI "QString & \fBinsert\fR ( uint index, const QByteArray & s )" +.br +.ti -1c +.BI "QString & \fBinsert\fR ( uint index, const char * s )" +.br +.ti -1c +.BI "QString & \fBinsert\fR ( uint index, const QChar * s, uint len )" +.br +.ti -1c +.BI "QString & \fBinsert\fR ( uint index, QChar c )" +.br +.ti -1c +.BI "QString & \fBinsert\fR ( uint index, char c )" +.br +.ti -1c +.BI "QString & \fBappend\fR ( char ch )" +.br +.ti -1c +.BI "QString & \fBappend\fR ( QChar ch )" +.br +.ti -1c +.BI "QString & \fBappend\fR ( const QString & str )" +.br +.ti -1c +.BI "QString & \fBappend\fR ( const QByteArray & str )" +.br +.ti -1c +.BI "QString & \fBappend\fR ( const char * str )" +.br +.ti -1c +.BI "QString & \fBappend\fR ( const std::string & str )" +.br +.ti -1c +.BI "QString & \fBprepend\fR ( char ch )" +.br +.ti -1c +.BI "QString & \fBprepend\fR ( QChar ch )" +.br +.ti -1c +.BI "QString & \fBprepend\fR ( const QString & s )" +.br +.ti -1c +.BI "QString & \fBprepend\fR ( const QByteArray & s )" +.br +.ti -1c +.BI "QString & \fBprepend\fR ( const char * s )" +.br +.ti -1c +.BI "QString & \fBprepend\fR ( const std::string & s )" +.br +.ti -1c +.BI "QString & \fBremove\fR ( uint index, uint len )" +.br +.ti -1c +.BI "QString & \fBremove\fR ( const QString & str, bool cs = TRUE )" +.br +.ti -1c +.BI "QString & \fBremove\fR ( QChar c )" +.br +.ti -1c +.BI "QString & \fBremove\fR ( char c )" +.br +.ti -1c +.BI "QString & \fBremove\fR ( const char * str )" +.br +.ti -1c +.BI "QString & \fBremove\fR ( const QRegExp & rx )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( uint index, uint len, const QString & s )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( uint index, uint len, const QChar * s, uint slen )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( uint index, uint len, QChar c )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( uint index, uint len, char c )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( QChar c, const QString & after, bool cs = TRUE )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( char c, const QString & after, bool cs = TRUE )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( const QString & before, const QString & after, bool cs = TRUE )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( const QRegExp & rx, const QString & after )" +.br +.ti -1c +.BI "QString & \fBreplace\fR ( QChar c1, QChar c2 )" +.br +.ti -1c +.BI "short \fBtoShort\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "ushort \fBtoUShort\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "int \fBtoInt\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "uint \fBtoUInt\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "long \fBtoLong\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "ulong \fBtoULong\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "TQ_LLONG \fBtoLongLong\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "TQ_ULLONG \fBtoULongLong\fR ( bool * ok = 0, int base = 10 ) const" +.br +.ti -1c +.BI "float \fBtoFloat\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "double \fBtoDouble\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( short n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( ushort n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( int n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( uint n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( long n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( ulong n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( TQ_LLONG n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( TQ_ULLONG n, int base = 10 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( float n, char f = 'g', int prec = 6 )" +.br +.ti -1c +.BI "QString & \fBsetNum\fR ( double n, char f = 'g', int prec = 6 )" +.br +.ti -1c +.BI "void setExpand ( uint index, QChar c ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString & \fBoperator+=\fR ( const QString & str )" +.br +.ti -1c +.BI "QString & \fBoperator+=\fR ( const QByteArray & str )" +.br +.ti -1c +.BI "QString & \fBoperator+=\fR ( const char * str )" +.br +.ti -1c +.BI "QString & \fBoperator+=\fR ( const std::string & str )" +.br +.ti -1c +.BI "QString & \fBoperator+=\fR ( QChar c )" +.br +.ti -1c +.BI "QString & \fBoperator+=\fR ( char c )" +.br +.ti -1c +.BI "QChar \fBat\fR ( uint i ) const" +.br +.ti -1c +.BI "QChar \fBoperator[]\fR ( int i ) const" +.br +.ti -1c +.BI "QCharRef \fBat\fR ( uint i )" +.br +.ti -1c +.BI "QCharRef \fBoperator[]\fR ( int i )" +.br +.ti -1c +.BI "QChar \fBconstref\fR ( uint i ) const" +.br +.ti -1c +.BI "QChar & \fBref\fR ( uint i )" +.br +.ti -1c +.BI "const QChar * \fBunicode\fR () const" +.br +.ti -1c +.BI "const char * \fBascii\fR () const" +.br +.ti -1c +.BI "const char * \fBlatin1\fR () const" +.br +.ti -1c +.BI "QCString \fButf8\fR () const" +.br +.ti -1c +.BI "QCString \fBlocal8Bit\fR () const" +.br +.ti -1c +.BI "bool \fBoperator!\fR () const" +.br +.ti -1c +.BI "\fBoperator const char *\fR () const" +.br +.ti -1c +.BI "\fBoperator std::string\fR () const" +.br +.ti -1c +.BI "const unsigned short * \fBucs2\fR () const" +.br +.ti -1c +.BI "QString & \fBsetUnicode\fR ( const QChar * unicode, uint len )" +.br +.ti -1c +.BI "QString & \fBsetUnicodeCodes\fR ( const ushort * unicode_as_ushorts, uint len )" +.br +.ti -1c +.BI "QString & \fBsetAscii\fR ( const char * str, int len = -1 )" +.br +.ti -1c +.BI "QString & \fBsetLatin1\fR ( const char * str, int len = -1 )" +.br +.ti -1c +.BI "int \fBcompare\fR ( const QString & s ) const" +.br +.ti -1c +.BI "int \fBlocaleAwareCompare\fR ( const QString & s ) const" +.br +.ti -1c +.BI "void \fBcompose\fR ()" +.br +.ti -1c +.BI "const char * data () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBstartsWith\fR ( const QString & s, bool cs = TRUE ) const" +.br +.ti -1c +.BI "bool \fBendsWith\fR ( const QString & s, bool cs = TRUE ) const" +.br +.ti -1c +.BI "void \fBsetLength\fR ( uint newLen )" +.br +.ti -1c +.BI "uint \fBcapacity\fR () const" +.br +.ti -1c +.BI "void \fBreserve\fR ( uint minCapacity )" +.br +.ti -1c +.BI "void \fBsqueeze\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBnumber\fR ( long n, int base = 10 )" +.br +.ti -1c +.BI "QString \fBnumber\fR ( ulong n, int base = 10 )" +.br +.ti -1c +.BI "QString \fBnumber\fR ( TQ_LLONG n, int base = 10 )" +.br +.ti -1c +.BI "QString \fBnumber\fR ( TQ_ULLONG n, int base = 10 )" +.br +.ti -1c +.BI "QString \fBnumber\fR ( int n, int base = 10 )" +.br +.ti -1c +.BI "QString \fBnumber\fR ( uint n, int base = 10 )" +.br +.ti -1c +.BI "QString \fBnumber\fR ( double n, char f = 'g', int prec = 6 )" +.br +.ti -1c +.BI "QString \fBfromAscii\fR ( const char * ascii, int len = -1 )" +.br +.ti -1c +.BI "QString \fBfromLatin1\fR ( const char * chars, int len = -1 )" +.br +.ti -1c +.BI "QString \fBfromUtf8\fR ( const char * utf8, int len = -1 )" +.br +.ti -1c +.BI "QString \fBfromLocal8Bit\fR ( const char * local8Bit, int len = -1 )" +.br +.ti -1c +.BI "QString \fBfromUcs2\fR ( const unsigned short * str )" +.br +.ti -1c +.BI "int \fBcompare\fR ( const QString & s1, const QString & s2 )" +.br +.ti -1c +.BI "int \fBlocaleAwareCompare\fR ( const QString & s1, const QString & s2 )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "bool \fBoperator==\fR ( const QString & s1, const QString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const char * s1, const QString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QString & s1, const QString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const char * s1, const QString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const QString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const char * s1, const QString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const QString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const char * s1, const QString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const QString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const char * s1, const QString & s2 )" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const QString & s1, const char * s2 )" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const char * s1, const QString & s2 )" +.br +.ti -1c +.BI "const QString \fBoperator+\fR ( const QString & s1, const QString & s2 )" +.br +.ti -1c +.BI "const QString \fBoperator+\fR ( const QString & s1, const char * s2 )" +.br +.ti -1c +.BI "const QString \fBoperator+\fR ( const char * s1, const QString & s2 )" +.br +.ti -1c +.BI "const QString \fBoperator+\fR ( const QString & s, char c )" +.br +.ti -1c +.BI "const QString \fBoperator+\fR ( char c, const QString & s )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QString & str )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QString & str )" +.br +.in -1c +.SH DESCRIPTION +The QString class provides an abstraction of Unicode text and the classic C '\0'-terminated char array. +.PP +QString uses implicit sharing, which makes it very efficient and easy to use. +.PP +In all of the QString methods that take \fCconst char *\fR parameters, the \fCconst char *\fR is interpreted as a classic C-style '\0'-terminated ASCII string. It is legal for the \fCconst char *\fR parameter to be 0. If the \fCconst char *\fR is not '\0'-terminated, the results are undefined. Functions that copy classic C strings into a QString will not copy the terminating '\0' character. The QChar array of the QString (as returned by unicode()) is generally not terminated by a '\0'. If you need to pass a QString to a function that requires a C '\0'-terminated string use latin1(). +.PP +A QString that has not been assigned to anything is \fInull\fR, i.e. both the length and data pointer is 0. A QString that references the empty string ("", a single '\0' char) is \fIempty\fR. Both null and empty QStrings are legal parameters to the methods. Assigning \fC(const char *) 0\fR to QString gives a null QString. For convenience, QString::null is a null QString. When sorting, empty strings come first, followed by non-empty strings, followed by null strings. We recommend using \fCif ( !str.isNull() )\fR to check for a non-null string rather than \fCif ( !str )\fR; see operator!() for an explanation. +.PP +Note that if you find that you are mixing usage of QCString, QString, and QByteArray, this causes lots of unnecessary copying and might indicate that the true nature of the data you are dealing with is uncertain. If the data is '\0'-terminated 8-bit data, use QCString; if it is unterminated (i.e. contains '\0's) 8-bit data, use QByteArray; if it is text, use QString. +.PP +Lists of strings are handled by the QStringList class. You can split a string into a list of strings using QStringList::split(), and join a list of strings into a single string with an optional separator using QStringList::join(). You can obtain a list of strings from a string list that contain a particular substring or that match a particular regex using QStringList::grep(). +.PP +\fBNote for C programmers\fR +.PP +Due to C++'s type system and the fact that QString is implicitly shared, QStrings can be treated like ints or other simple base types. For example: +.PP +.nf +.br + QString boolToString( bool b ) +.br + { +.br + QString result; +.br + if ( b ) +.br + result = "True"; +.br + else +.br + result = "False"; +.br + return result; +.br + } +.br +.fi +.PP +The variable, result, is an auto variable allocated on the stack. When return is called, because we're returning by value, The copy constructor is called and a copy of the string is returned. (No actual copying takes place thanks to the implicit sharing, see below.) +.PP +Throughout Qt's source code you will encounter QString usages like this: +.PP +.nf +.br + QString func( const QString& input ) +.br + { +.br + QString output = input; +.br + // process output +.br + return output; +.br + } +.br +.fi +.PP +The 'copying' of input to output is almost as fast as copying a pointer because behind the scenes copying is achieved by incrementing a reference count. QString (like all Qt's implicitly shared classes) operates on a copy-on-write basis, only copying if an instance is actually changed. +.PP +If you wish to create a deep copy of a QString without losing any Unicode information then you should use QDeepCopy. +.PP +See also QChar, QCString, QByteArray, QConstString, Implicitly and Explicitly Shared Classes, Text Related Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QString::SectionFlags" +.TP +\fCQString::SectionDefault\fR - Empty fields are counted, leading and trailing separators are not included, and the separator is compared case sensitively. +.TP +\fCQString::SectionSkipEmpty\fR - Treat empty fields as if they don't exist, i.e. they are not considered as far as \fIstart\fR and \fIend\fR are concerned. +.TP +\fCQString::SectionIncludeLeadingSep\fR - Include the leading separator (if any) in the result string. +.TP +\fCQString::SectionIncludeTrailingSep\fR - Include the trailing separator (if any) in the result string. +.TP +\fCQString::SectionCaseInsensitiveSeps\fR - Compare the separator case-insensitively. +.PP +Any of the last four values can be OR-ed together to form a flag. +.PP +See also section(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QString::QString ()" +Constructs a null string, i.e. both the length and data pointer are 0. +.PP +See also isNull(). +.SH "QString::QString ( QChar ch )" +Constructs a string of length one, containing the character \fIch\fR. +.SH "QString::QString ( const QString & s )" +Constructs an implicitly shared copy of \fIs\fR. This is very fast since it only involves incrementing a reference count. +.SH "QString::QString ( const QByteArray & ba )" +Constructs a string that is a deep copy of \fIba\fR interpreted as a classic C string. +.SH "QString::QString ( const QChar * unicode, uint length )" +Constructs a string that is a deep copy of the first \fIlength\fR characters in the QChar array. +.PP +If \fIunicode\fR and \fIlength\fR are 0, then a null string is created. +.PP +If only \fIunicode\fR is 0, the string is empty but has \fIlength\fR characters of space preallocated: QString expands automatically anyway, but this may speed up some cases a little. We recommend using the plain constructor and setLength() for this purpose since it will result in more readable code. +.PP +See also isNull() and setLength(). +.SH "QString::QString ( const char * str )" +Constructs a string that is a deep copy of \fIstr\fR, interpreted as a classic C string. The encoding is assumed to be Latin-1, unless you change it using QTextCodec::setCodecForCStrings(). +.PP +If \fIstr\fR is 0, then a null string is created. +.PP +This is a cast constructor, but it is perfectly safe: converting a Latin-1 \fCconst char *\fR to QString preserves all the information. You can disable this constructor by defining \fCQT_NO_CAST_ASCII\fR when you compile your applications. You can also make QString objects by using setLatin1(), fromLatin1(), fromLocal8Bit(), and fromUtf8(). Or whatever encoding is appropriate for the 8-bit data you have. +.PP +See also isNull() and fromAscii(). +.SH "QString::QString ( const std::string & str )" +Constructs a string that is a deep copy of \fIstr\fR. +.PP +This is the same as fromAscii(\fIstr\fR). +.SH "QString::~QString ()" +Destroys the string and frees the string's data if this is the last reference to the string. +.SH "QString & QString::append ( const QString & str )" +Appends \fIstr\fR to the string and returns a reference to the result. +.PP +.nf +.br + string = "Test"; +.br + string.append( "ing" ); // string == "Testing" +.br +.fi +.PP +Equivalent to operator+=(). +.PP +Example: dirview/dirview.cpp. +.SH "QString & QString::append ( char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends character \fIch\fR to the string and returns a reference to the result. +.PP +Equivalent to operator+=(). +.SH "QString & QString::append ( QChar ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends character \fIch\fR to the string and returns a reference to the result. +.PP +Equivalent to operator+=(). +.SH "QString & QString::append ( const QByteArray & str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIstr\fR to the string and returns a reference to the result. +.PP +Equivalent to operator+=(). +.SH "QString & QString::append ( const char * str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIstr\fR to the string and returns a reference to the result. +.PP +Equivalent to operator+=(). +.SH "QString & QString::append ( const std::string & str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIstr\fR to the string and returns a reference to the result. +.PP +Equivalent to operator+=(). +.SH "QString QString::arg ( const QString & a, int fieldWidth = 0 ) const" +This function will return a string that replaces the lowest numbered occurrence of \fC%1\fR, \fC%2\fR, ..., \fC%9\fR with \fIa\fR. +.PP +The \fIfieldWidth\fR value specifies the minimum amount of space that \fIa\fR is padded to. A positive value will produce right-aligned text, whereas a negative value will produce left-aligned text. +.PP +The following example shows how we could create a 'status' string when processing a list of files: +.PP +.nf +.br + QString status = QString( "Processing file %1 of %2: %3" ) +.br + .arg( i ) // current file's number +.br + .arg( total ) // number of files to process +.br + .arg( fileName ); // current file's name +.br +.fi +.PP +It is generally fine to use filenames and numbers as we have done in the example above. But note that using arg() to construct natural language sentences does not usually translate well into other languages because sentence structure and word order often differ between languages. +.PP +If there is no place marker (\fC%1\fR, \fC%2\fR, etc.), a warning message (tqWarning()) is output and the result is undefined. +.PP +\fBWarning:\fR If any placeholder occurs more than once, the result is undefined. +.SH "QString QString::arg ( long a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The \fIfieldWidth\fR value specifies the minimum amount of space that \fIa\fR is padded to. A positive value will produce a right-aligned number, whereas a negative value will produce a left-aligned number. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. +.PP +The '%' can be followed by an 'L', in which case the sequence is replaced with a localized representation of \fIa\fR. The conversion uses the default locale. The default locale is determined from the system's locale settings at application startup. It can be changed using QLocale::setDefault(). The 'L' flag is ignored if \fIbase\fR is not 10. +.PP +.nf +.br + QString str; +.br + str = QString( "Decimal 63 is %1 in hexadecimal" ) +.br + .arg( 63, 0, 16 ); +.br + // str == "Decimal 63 is 3f in hexadecimal" +.br +.br + QLocale::setDefault(QLocale::English, QLocale::UnitedStates); +.br + str = QString( "%1 %L2 %L3" ) +.br + .arg( 12345 ) +.br + .arg( 12345 ) +.br + .arg( 12345, 0, 16 ); +.br + // str == "12345 12,345 3039" +.br +.fi +.SH "QString QString::arg ( ulong a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( TQ_LLONG a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( TQ_ULLONG a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( int a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( uint a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( short a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( ushort a, int fieldWidth = 0, int base = 10 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is expressed in base \fIbase\fR, which is 10 by default and must be between 2 and 36. If \fIbase\fR is 10, the '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( double a, int fieldWidth = 0, char fmt = 'g', int prec = -1 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Argument \fIa\fR is formatted according to the \fIfmt\fR format specified, which is 'g' by default and can be any of the following: +.PP +<center>.nf +.TS +l - l. Format Meaning format as [-]9.9e[+|-]999 format as [-]9.9E[+|-]999 format as [-]9.9 use use +.TE +.fi +</center> +.PP +With 'e', 'E', and 'f', \fIprec\fR is the number of digits after the decimal point. With 'g' and 'G', \fIprec\fR is the maximum number of significant digits (trailing zeroes are omitted). +.PP +.nf +.br + double d = 12.34; +.br + QString ds = QString( "'E' format, precision 3, gives %1" ) +.br + .arg( d, 0, 'E', 3 ); +.br + // ds == "'E' format, precision 3, gives 1.234E+01" +.br +.fi +.PP +The '%L' syntax can be used to produce localized strings. +.SH "QString QString::arg ( char a, int fieldWidth = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR is assumed to be in the Latin-1 character set. +.SH "QString QString::arg ( QChar a, int fieldWidth = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QString QString::arg ( const QString & a1, const QString & a2 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is the same as str.arg(\fIa1\fR).arg(\fIa2\fR), except that the strings are replaced in one pass. This can make a difference if \fIa1\fR contains e.g. \fC%1\fR: +.PP +.nf +.br + QString str( "%1 %2" ); +.br + str.arg( "Hello", "world" ); // returns "Hello world" +.br + str.arg( "Hello" ).arg( "world" ); // returns "Hello world" +.br +.br + str.arg( "(%1)", "Hello" ); // returns "(%1) Hello" +.br + str.arg( "(%1)" ).arg( "Hello" ); // returns "(Hello) %2" +.br +.fi +.SH "QString QString::arg ( const QString & a1, const QString & a2, const QString & a3 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is the same as calling str.arg(\fIa1\fR).arg(\fIa2\fR).arg(\fIa3\fR), except that the strings are replaced in one pass. +.SH "QString QString::arg ( const QString & a1, const QString & a2, const QString & a3, const QString & a4 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is the same as calling str.arg(\fIa1\fR).arg(\fIa2\fR).arg(\fIa3\fR).arg(\fIa4\fR), except that the strings are replaced in one pass. +.SH "const char * QString::ascii () const" +Returns an 8-bit ASCII representation of the string. +.PP +If a codec has been set using QTextCodec::codecForCStrings(), it is used to convert Unicode to 8-bit char. Otherwise, this function does the same as latin1(). +.PP +See also fromAscii(), latin1(), utf8(), and local8Bit(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "QChar QString::at ( uint i ) const" +Returns the character at index \fIi\fR, or 0 if \fIi\fR is beyond the length of the string. +.PP +.nf +.br + const QString string( "abcdefgh" ); +.br + QChar ch = string.at( 4 ); +.br + // ch == 'e' +.br +.fi +.PP +If the QString is not const (i.e. const QString) or const& (i.e. const QString &), then the non-const overload of at() will be used instead. +.SH "QCharRef QString::at ( uint i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The function returns a reference to the character at index \fIi\fR. The resulting reference can then be assigned to, or used immediately, but it will become invalid once further modifications are made to the original string. +.PP +If \fIi\fR is beyond the length of the string then the string is expanded with QChar::null. +.SH "uint QString::capacity () const" +Returns the number of characters this string can hold in the allocated memory. +.PP +See also reserve() and squeeze(). +.SH "int QString::compare ( const QString & s1, const QString & s2 )\fC [static]\fR" +Lexically compares \fIs1\fR with \fIs2\fR and returns an integer less than, equal to, or greater than zero if \fIs1\fR is less than, equal to, or greater than \fIs2\fR. +.PP +The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with QString::localeAwareCompare(). +.PP +.nf +.br + int a = QString::compare( "def", "abc" ); // a > 0 +.br + int b = QString::compare( "abc", "def" ); // b < 0 +.br + int c = QString::compare( "abc", "abc" ); // c == 0 +.br +.fi +.SH "int QString::compare ( const QString & s ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Lexically compares this string with \fIs\fR and returns an integer less than, equal to, or greater than zero if it is less than, equal to, or greater than \fIs\fR. +.SH "void QString::compose ()" +\fBWarning:\fR This function is not supported in Qt 3.x. It is provided for experimental and illustrative purposes only. It is mainly of interest to those experimenting with Arabic and other composition-rich texts. +.PP +Applies possible ligatures to a QString. Useful when composition-rich text requires rendering with glyph-poor fonts, but it also makes compositions such as QChar(0x0041) ('A') and QChar(0x0308) (Unicode accent diaresis), giving QChar(0x00c4) (German A Umlaut). +.SH "QChar QString::constref ( uint i ) const" +Returns the QChar at index \fIi\fR by value. +.PP +Equivalent to at(\fIi\fR). +.PP +See also ref(). +.SH "int QString::contains ( QChar c, bool cs = TRUE ) const" +Returns the number of times the character \fIc\fR occurs in the string. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +.nf +.br + QString string( "Trolltech and Qt" ); +.br + int n = string.contains( 't', FALSE ); +.br + // n == 3 +.br +.fi +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and mdi/application.cpp. +.SH "int QString::contains ( char c, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "int QString::contains ( const char * str, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the number of times the string \fIstr\fR occurs in the string. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.SH "int QString::contains ( const QString & str, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the number of times \fIstr\fR occurs in the string. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +This function counts overlapping strings, so in the example below, there are two instances of "ana" in "bananas". +.PP +.nf +.br + QString str( "bananas" ); +.br + int i = str.contains( "ana" ); // i == 2 +.br +.fi +.PP +See also findRev(). +.SH "int QString::contains ( const QRegExp & rx ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the number of times the regexp, \fIrx\fR, matches in the string. +.PP +This function counts overlapping matches, so in the example below, there are four instances of "ana" or "ama". +.PP +.nf +.br + QString str = "banana and panama"; +.br + QRegExp rxp = QRegExp( "a[nm]a", TRUE, FALSE ); +.br + int i = str.contains( rxp ); // i == 4 +.br +.fi +.PP +See also find() and findRev(). +.SH "QString QString::copy () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +In Qt 2.0 and later, all calls to this function are needless. Just remove them. +.SH "const char * QString::data () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns a pointer to a '\0'-terminated classic C string. +.PP +In Qt 1.x, this returned a char* allowing direct manipulation of the string as a sequence of bytes. In Qt 2.x where QString is a Unicode string, char* conversion constructs a temporary string, and hence direct character operations are meaningless. +.SH "bool QString::endsWith ( const QString & s, bool cs = TRUE ) const" +Returns TRUE if the string ends with \fIs\fR; otherwise returns FALSE. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +.nf +.br + QString str( "Bananas" ); +.br + str.endsWith( "anas" ); // returns TRUE +.br + str.endsWith( "pple" ); // returns FALSE +.br +.fi +.PP +See also startsWith(). +.PP +Example: chart/main.cpp. +.SH "QString & QString::fill ( QChar c, int len = -1 )" +Fills the string with \fIlen\fR characters of value \fIc\fR, and returns a reference to the string. +.PP +If \fIlen\fR is negative (the default), the current string length is used. +.PP +.nf +.br + QString str; +.br + str.fill( 'g', 5 ); // string == "ggggg" +.br +.fi +.SH "int QString::find ( const QRegExp & rx, int index = 0 ) const" +Finds the first match of the regular expression \fIrx\fR, starting from position \fIindex\fR. If \fIindex\fR is -1, the search starts at the last character; if -2, at the next to last character and so on. (See findRev() for searching backwards.) +.PP +Returns the position of the first match of \fIrx\fR or -1 if no match was found. +.PP +.nf +.br + QString string( "bananas" ); +.br + int i = string.find( QRegExp("an"), 0 ); // i == 1 +.br +.fi +.PP +See also findRev(), replace(), and contains(). +.PP +Example: network/mail/smtp.cpp. +.SH "int QString::find ( QChar c, int index = 0, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR. If \fIindex\fR is -1, the search starts at the last character; if -2, at the next to last character and so on. (See findRev() for searching backwards.) +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +Returns the position of \fIc\fR or -1 if \fIc\fR could not be found. +.SH "int QString::find ( char c, int index = 0, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Find character \fIc\fR starting from position \fIindex\fR. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.SH "int QString::find ( const QString & str, int index = 0, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR. If \fIindex\fR is -1, the search starts at the last character, if it is -2, at the next to last character and so on. (See findRev() for searching backwards.) +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +Returns the position of \fIstr\fR or -1 if \fIstr\fR could not be found. +.SH "int QString::find ( const char * str, int index = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Equivalent to find(QString(\fIstr\fR), \fIindex\fR). +.SH "int QString::findRev ( const char * str, int index = -1 ) const" +Equivalent to findRev(QString(\fIstr\fR), \fIindex\fR). +.SH "int QString::findRev ( QChar c, int index = -1, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR and searching backwards. If the index is -1, the search starts at the last character, if it is -2, at the next to last character and so on. +.PP +Returns the position of \fIc\fR or -1 if \fIc\fR could not be found. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +.nf +.br + QString string( "bananas" ); +.br + int i = string.findRev( 'a' ); // i == 5 +.br +.fi +.SH "int QString::findRev ( char c, int index = -1, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Find character \fIc\fR starting from position \fIindex\fR and working backwards. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.SH "int QString::findRev ( const QString & str, int index = -1, bool cs = TRUE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR and searching backwards. If the index is -1, the search starts at the last character, if it is -2, at the next to last character and so on. +.PP +Returns the position of \fIstr\fR or -1 if \fIstr\fR could not be found. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +.nf +.br + QString string("bananas"); +.br + int i = string.findRev( "ana" ); // i == 3 +.br +.fi +.SH "int QString::findRev ( const QRegExp & rx, int index = -1 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first match of the regexp \fIrx\fR, starting at position \fIindex\fR and searching backwards. If the index is -1, the search starts at the last character, if it is -2, at the next to last character and so on. (See findRev() for searching backwards.) +.PP +Returns the position of the match or -1 if no match was found. +.PP +.nf +.br + QString string( "bananas" ); +.br + int i = string.findRev( QRegExp("an") ); // i == 3 +.br +.fi +.PP +See also find(). +.SH "QString QString::fromAscii ( const char * ascii, int len = -1 )\fC [static]\fR" +Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIascii\fR, ignoring the rest of \fIascii\fR. If \fIlen\fR is -1 then the length of \fIascii\fR is used. If \fIlen\fR is bigger than the length of \fIascii\fR then it will use the length of \fIascii\fR. +.PP +If a codec has been set using QTextCodec::codecForCStrings(), it is used to convert the string from 8-bit characters to Unicode. Otherwise, this function does the same as fromLatin1(). +.PP +This is the same as the QString(const char*) constructor, but you can make that constructor invisible if you compile with the define \fCQT_NO_CAST_ASCII\fR, in which case you can explicitly create a QString from 8-bit ASCII text using this function. +.PP +.nf +.br + QString str = QString::fromAscii( "123456789", 5 ); +.br + // str == "12345" +.br +.fi +.SH "QString QString::fromLatin1 ( const char * chars, int len = -1 )\fC [static]\fR" +Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIchars\fR, ignoring the rest of \fIchars\fR. If \fIlen\fR is -1 then the length of \fIchars\fR is used. If \fIlen\fR is bigger than the length of \fIchars\fR then it will use the length of \fIchars\fR. +.PP +See also fromAscii(). +.PP +Examples: +.)l listbox/listbox.cpp and network/mail/smtp.cpp. +.SH "QString QString::fromLocal8Bit ( const char * local8Bit, int len = -1 )\fC [static]\fR" +Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIlocal8Bit\fR, ignoring the rest of \fIlocal8Bit\fR. If \fIlen\fR is -1 then the length of \fIlocal8Bit\fR is used. If \fIlen\fR is bigger than the length of \fIlocal8Bit\fR then it will use the length of \fIlocal8Bit\fR. +.PP +.nf +.br + QString str = QString::fromLocal8Bit( "123456789", 5 ); +.br + // str == "12345" +.br +.fi +.PP +\fIlocal8Bit\fR is assumed to be encoded in a locale-specific format. +.PP +See QTextCodec for more diverse coding/decoding of Unicode strings. +.SH "QString QString::fromUcs2 ( const unsigned short * str )\fC [static]\fR" +Constructs a string that is a deep copy of \fIstr\fR, interpreted as a UCS2 encoded, zero terminated, Unicode string. +.PP +If \fIstr\fR is 0, then a null string is created. +.PP +See also isNull(). +.SH "QString QString::fromUtf8 ( const char * utf8, int len = -1 )\fC [static]\fR" +Returns the Unicode string decoded from the first \fIlen\fR bytes of \fIutf8\fR, ignoring the rest of \fIutf8\fR. If \fIlen\fR is -1 then the length of \fIutf8\fR is used. If \fIlen\fR is bigger than the length of \fIutf8\fR then it will use the length of \fIutf8\fR. +.PP +.nf +.br + QString str = QString::fromUtf8( "123456789", 5 ); +.br + // str == "12345" +.br +.fi +.PP +See QTextCodec for more diverse coding/decoding of Unicode strings. +.PP +Example: fonts/simple-qfont-demo/viewer.cpp. +.SH "QString & QString::insert ( uint index, const QString & s )" +Inserts \fIs\fR into the string at position \fIindex\fR. +.PP +If \fIindex\fR is beyond the end of the string, the string is extended with spaces to length \fIindex\fR and \fIs\fR is then appended and returns a reference to the string. +.PP +.nf +.br + QString string( "I like fish" ); +.br + str = string.insert( 2, "don't " ); +.br + // str == "I don't like fish" +.br +.fi +.PP +See also remove() and replace(). +.PP +Examples: +.)l themes/themes.cpp and xform/xform.cpp. +.SH "QString & QString::insert ( uint index, const QByteArray & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIs\fR into the string at position \fIindex\fR and returns a reference to the string. +.SH "QString & QString::insert ( uint index, const char * s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIs\fR into the string at position \fIindex\fR and returns a reference to the string. +.SH "QString & QString::insert ( uint index, const QChar * s, uint len )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the first \fIlen\fR characters in \fIs\fR into the string at position \fIindex\fR and returns a reference to the string. +.SH "QString & QString::insert ( uint index, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Insert \fIc\fR into the string at position \fIindex\fR and returns a reference to the string. +.PP +If \fIindex\fR is beyond the end of the string, the string is extended with spaces (ASCII 32) to length \fIindex\fR and \fIc\fR is then appended. +.SH "QString & QString::insert ( uint index, char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Insert character \fIc\fR at position \fIindex\fR. +.SH "bool QString::isEmpty () const" +Returns TRUE if the string is empty, i.e. if length() == 0; otherwise returns FALSE. Null strings are also empty. +.PP +.nf +.br + QString a( "" ); +.br + a.isEmpty(); // TRUE +.br + a.isNull(); // FALSE +.br +.br + QString b; +.br + b.isEmpty(); // TRUE +.br + b.isNull(); // TRUE +.br +.fi +.PP +See also isNull() and length(). +.PP +Examples: +.)l addressbook/mainwindow.cpp, chart/chartform.cpp, chart/chartform_canvas.cpp, network/networkprotocol/nntp.cpp, qmag/qmag.cpp, and qwerty/qwerty.cpp. +.SH "bool QString::isNull () const" +Returns TRUE if the string is null; otherwise returns FALSE. A null string is always empty. +.PP +.nf +.br + QString a; // a.unicode() == 0, a.length() == 0 +.br + a.isNull(); // TRUE, because a.unicode() == 0 +.br + a.isEmpty(); // TRUE, because a.length() == 0 +.br +.fi +.PP +See also isEmpty() and length(). +.PP +Examples: +.)l i18n/main.cpp, network/ftpclient/ftpmainwindow.ui.h, and qdir/qdir.cpp. +.SH "const char * QString::latin1 () const" +Returns a Latin-1 representation of the string. The returned value is undefined if the string contains non-Latin-1 characters. If you want to convert strings into formats other than Unicode, see the QTextCodec classes. +.PP +This function is mainly useful for boot-strapping legacy code to use Unicode. +.PP +The result remains valid so long as one unmodified copy of the source string exists. +.PP +See also fromLatin1(), ascii(), utf8(), and local8Bit(). +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and network/networkprotocol/nntp.cpp. +.SH "QString QString::left ( uint len ) const" +Returns a substring that contains the \fIlen\fR leftmost characters of the string. +.PP +The whole string is returned if \fIlen\fR exceeds the length of the string. +.PP +.nf +.br + QString s = "Pineapple"; +.br + QString t = s.left( 4 ); // t == "Pine" +.br +.fi +.PP +See also right(), mid(), and isEmpty(). +.PP +Example: themes/themes.cpp. +.SH "QString QString::leftJustify ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" +Returns a string of length \fIwidth\fR that contains this string padded by the \fIfill\fR character. +.PP +If \fItruncate\fR is FALSE and the length of the string is more than \fIwidth\fR, then the returned string is a copy of the string. +.PP +If \fItruncate\fR is TRUE and the length of the string is more than \fIwidth\fR, then any characters in a copy of the string after length \fIwidth\fR are removed, and the copy is returned. +.PP +.nf +.br + QString s( "apple" ); +.br + QString t = s.leftJustify( 8, '.' ); // t == "apple..." +.br +.fi +.PP +See also rightJustify(). +.SH "uint QString::length () const" +Returns the length of the string. +.PP +Null strings and empty strings have zero length. +.PP +See also isNull() and isEmpty(). +.PP +Examples: +.)l dirview/dirview.cpp, fileiconview/qfileiconview.cpp, network/networkprotocol/nntp.cpp, rot13/rot13.cpp, and themes/themes.cpp. +.SH "QCString QString::local8Bit () const" +Returns the string encoded in a locale-specific format. On X11, this is the QTextCodec::codecForLocale(). On Windows, it is a system-defined encoding. On Mac OS X, this always uses UTF-8 as the encoding. +.PP +See QTextCodec for more diverse coding/decoding of Unicode strings. +.PP +See also fromLocal8Bit(), ascii(), latin1(), and utf8(). +.SH "int QString::localeAwareCompare ( const QString & s1, const QString & s2 )\fC [static]\fR" +Compares \fIs1\fR with \fIs2\fR and returns an integer less than, equal to, or greater than zero if \fIs1\fR is less than, equal to, or greater than \fIs2\fR. +.PP +The comparison is performed in a locale- and also platform-dependent manner. Use this function to present sorted lists of strings to the user. +.PP +See also QString::compare() and QTextCodec::locale(). +.SH "int QString::localeAwareCompare ( const QString & s ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Compares this string with \fIs\fR. +.SH "QString QString::lower () const" +Returns a lowercase copy of the string. +.PP +.nf +.br + QString string( "TROlltECH" ); +.br + str = string.lower(); // str == "trolltech" +.br +.fi +.PP +See also upper(). +.PP +Example: scribble/scribble.cpp. +.SH "QString QString::mid ( uint index, uint len = 0xffffffff ) const" +Returns a string that contains the \fIlen\fR characters of this string, starting at position \fIindex\fR. +.PP +Returns a null string if the string is empty or \fIindex\fR is out of range. Returns the whole string from \fIindex\fR if \fIindex\fR + \fIlen\fR exceeds the length of the string. +.PP +.nf +.br + QString s( "Five pineapples" ); +.br + QString t = s.mid( 5, 4 ); // t == "pine" +.br +.fi +.PP +See also left() and right(). +.PP +Examples: +.)l network/mail/smtp.cpp, qmag/qmag.cpp, and themes/themes.cpp. +.SH "QString QString::number ( long n, int base = 10 )\fC [static]\fR" +A convenience function that returns a string equivalent of the number \fIn\fR to base \fIbase\fR, which is 10 by default and must be between 2 and 36. The returned string is in "C" locale. +.PP +.nf +.br + long a = 63; +.br + QString str = QString::number( a, 16 ); // str == "3f" +.br + QString str = QString::number( a, 16 ).upper(); // str == "3F" +.br +.fi +.PP +See also setNum(). +.PP +Examples: +.)l application/application.cpp, chart/chartform.cpp, fonts/simple-qfont-demo/viewer.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, regexptester/regexptester.cpp, and sql/overview/extract/main.cpp. +.SH "QString QString::number ( ulong n, int base = 10 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also setNum(). +.SH "QString QString::number ( TQ_LLONG n, int base = 10 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also setNum(). +.SH "QString QString::number ( TQ_ULLONG n, int base = 10 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also setNum(). +.SH "QString QString::number ( int n, int base = 10 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +See also setNum(). +.SH "QString QString::number ( uint n, int base = 10 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +A convenience factory function that returns a string representation of the number \fIn\fR to the base \fIbase\fR, which is 10 by default and must be between 2 and 36. +.PP +See also setNum(). +.SH "QString QString::number ( double n, char f = 'g', int prec = 6 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Argument \fIn\fR is formatted according to the \fIf\fR format specified, which is \fCg\fR by default, and can be any of the following: +.PP +<center>.nf +.TS +l - l. Format Meaning format as [-]9.9e[+|-]999 format as [-]9.9E[+|-]999 format as [-]9.9 use use +.TE +.fi +</center> +.PP +With 'e', 'E', and 'f', \fIprec\fR is the number of digits after the decimal point. With 'g' and 'G', \fIprec\fR is the maximum number of significant digits (trailing zeroes are omitted). +.PP +.nf +.br + double d = 12.34; +.br + QString ds = QString( "'E' format, precision 3, gives %1" ) +.br + .arg( d, 0, 'E', 3 ); +.br + // ds == "1.234E+001" +.br +.fi +.PP +See also setNum(). +.SH "QString::operator const char * () const" +Returns ascii(). Be sure to see the warnings documented in the ascii() function. Note that for new code which you wish to be strictly Unicode-clean, you can define the macro \fCQT_NO_ASCII_CAST\fR when compiling your code to hide this function so that automatic casts are not done. This has the added advantage that you catch the programming error described in operator!(). +.SH "QString::operator std::string () const" +Returns ascii() as a std::string. +.PP +\fBWarning:\fR The function may cause an application to crash if a static C run-time is in use. This can happen in Microsoft Visual C++ if Qt is configured as single-threaded. A safe alternative is to call ascii() directly and construct a std::string manually. +.SH "bool QString::operator! () const" +Returns TRUE if this is a null string; otherwise returns FALSE. +.PP +.nf +.br + QString name = getName(); +.br + if ( !name ) +.br + name = "Rodney"; +.br +.fi +.PP +Note that if you say +.PP +.nf +.br + QString name = getName(); +.br + if ( name ) +.br + doSomethingWith(name); +.br +.fi +.PP +It will call "operator const char*()", which is inefficent; you may wish to define the macro \fCQT_NO_ASCII_CAST\fR when writing code which you wish to remain Unicode-clean. +.PP +When you want the above semantics, use: +.PP +.nf +.br + QString name = getName(); +.br + if ( !name.isNull() ) +.br + doSomethingWith(name); +.br +.fi +.PP +See also isEmpty(). +.SH "QString & QString::operator+= ( const QString & str )" +Appends \fIstr\fR to the string and returns a reference to the string. +.SH "QString & QString::operator+= ( const QByteArray & str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIstr\fR to the string and returns a reference to the string. +.SH "QString & QString::operator+= ( const char * str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIstr\fR to the string and returns a reference to the string. +.SH "QString & QString::operator+= ( const std::string & str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIstr\fR to the string and returns a reference to the string. +.SH "QString & QString::operator+= ( QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIc\fR to the string and returns a reference to the string. +.SH "QString & QString::operator+= ( char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends \fIc\fR to the string and returns a reference to the string. +.SH "QString & QString::operator= ( QChar c )" +Sets the string to contain just the single character \fIc\fR. +.SH "QString & QString::operator= ( const QString & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns a shallow copy of \fIs\fR to this string and returns a reference to this string. This is very fast because the string isn't actually copied. +.SH "QString & QString::operator= ( const char * str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns a deep copy of \fIstr\fR, interpreted as a classic C string to this string and returns a reference to this string. +.PP +If \fIstr\fR is 0, then a null string is created. +.PP +See also isNull(). +.SH "QString & QString::operator= ( const std::string & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Makes a deep copy of \fIs\fR and returns a reference to the deep copy. +.SH "QString & QString::operator= ( const QCString & cstr )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns a deep copy of \fIcstr\fR, interpreted as a classic C string, to this string. Returns a reference to this string. +.SH "QString & QString::operator= ( char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to contain just the single character \fIc\fR. +.SH "QChar QString::operator[] ( int i ) const" +Returns the character at index \fIi\fR, or QChar::null if \fIi\fR is beyond the length of the string. +.PP +If the QString is not const (i.e., const QString) or const& (i.e., const QString&), then the non-const overload of operator[] will be used instead. +.SH "QCharRef QString::operator[] ( int i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The function returns a reference to the character at index \fIi\fR. The resulting reference can then be assigned to, or used immediately, but it will become invalid once further modifications are made to the original string. +.PP +If \fIi\fR is beyond the length of the string then the string is expanded with QChar::nulls, so that the QCharRef references a valid (null) character in the string. +.PP +The QCharRef internal class can be used much like a constant QChar, but if you assign to it, you change the original string (which will detach itself because of QString's copy-on-write semantics). You will get compilation errors if you try to use the result as anything but a QChar. +.SH "QString & QString::prepend ( const QString & s )" +Inserts \fIs\fR at the beginning of the string and returns a reference to the string. +.PP +Equivalent to insert(0, \fIs\fR). +.PP +.nf +.br + QString string = "42"; +.br + string.prepend( "The answer is " ); +.br + // string == "The answer is 42" +.br +.fi +.PP +See also insert(). +.SH "QString & QString::prepend ( char ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIch\fR at the beginning of the string and returns a reference to the string. +.PP +Equivalent to insert(0, \fIch\fR). +.PP +See also insert(). +.SH "QString & QString::prepend ( QChar ch )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIch\fR at the beginning of the string and returns a reference to the string. +.PP +Equivalent to insert(0, \fIch\fR). +.PP +See also insert(). +.SH "QString & QString::prepend ( const QByteArray & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIs\fR at the beginning of the string and returns a reference to the string. +.PP +Equivalent to insert(0, \fIs\fR). +.PP +See also insert(). +.SH "QString & QString::prepend ( const char * s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIs\fR at the beginning of the string and returns a reference to the string. +.PP +Equivalent to insert(0, \fIs\fR). +.PP +See also insert(). +.SH "QString & QString::prepend ( const std::string & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIs\fR at the beginning of the string and returns a reference to the string. +.PP +Equivalent to insert(0, \fIs\fR). +.PP +See also insert(). +.SH "QChar & QString::ref ( uint i )" +Returns the QChar at index \fIi\fR by reference, expanding the string with QChar::null if necessary. The resulting reference can be assigned to, or otherwise used immediately, but becomes invalid once furher modifications are made to the string. +.PP +.nf +.br + QString string("ABCDEF"); +.br + QChar ch = string.ref( 3 ); // ch == 'D' +.br +.fi +.PP +See also constref(). +.SH "QString & QString::remove ( uint index, uint len )" +Removes \fIlen\fR characters from the string starting at position \fIindex\fR, and returns a reference to the string. +.PP +If \fIindex\fR is beyond the length of the string, nothing happens. If \fIindex\fR is within the string, but \fIindex\fR + \fIlen\fR is beyond the end of the string, the string is truncated at position \fIindex\fR. +.PP +.nf +.br + QString string( "Montreal" ); +.br + string.remove( 1, 4 ); // string == "Meal" +.br +.fi +.PP +See also insert() and replace(). +.SH "QString & QString::remove ( const QString & str, bool cs = TRUE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes every occurrence of \fIstr\fR in the string. Returns a reference to the string. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +This is the same as replace(\fIstr\fR, "", \fIcs\fR). +.SH "QString & QString::remove ( QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes every occurrence of the character \fIc\fR in the string. Returns a reference to the string. +.PP +This is the same as replace(\fIc\fR, ""). +.SH "QString & QString::remove ( char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes every occurrence of the character \fIc\fR in the string. Returns a reference to the string. +.PP +This is the same as replace(\fIc\fR, ""). +.SH "QString & QString::remove ( const char * str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes every occurrence of \fIstr\fR in the string. Returns a reference to the string. +.SH "QString & QString::remove ( const QRegExp & rx )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes every occurrence of the regular expression \fIrx\fR in the string. Returns a reference to the string. +.PP +This is the same as replace(\fIrx\fR, ""). +.SH "QString & QString::replace ( uint index, uint len, const QString & s )" +Replaces \fIlen\fR characters from the string with \fIs\fR, starting at position \fIindex\fR, and returns a reference to the string. +.PP +If \fIindex\fR is beyond the length of the string, nothing is deleted and \fIs\fR is appended at the end of the string. If \fIindex\fR is valid, but \fIindex\fR + \fIlen\fR is beyond the end of the string, the string is truncated at position \fIindex\fR, then \fIs\fR is appended at the end. +.PP +.nf +.br + QString string( "Say yes!" ); +.br + string = string.replace( 4, 3, "NO" ); +.br + // string == "Say NO!" +.br +.fi +.PP +\fBWarning:\fR Qt 3.3.3 and earlier had different semantics for the case \fIindex\fR >= length(), which contradicted the documentation. To avoid portability problems between Qt 3 versions and with Qt 4, we recommend that you never call the function with \fIindex\fR >= length(). +.PP +See also insert() and remove(). +.PP +Examples: +.)l listviews/listviews.cpp, network/networkprotocol/nntp.cpp, qmag/qmag.cpp, and regexptester/regexptester.cpp. +.SH "QString & QString::replace ( uint index, uint len, const QChar * s, uint slen )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces \fIlen\fR characters with \fIslen\fR characters of QChar data from \fIs\fR, starting at position \fIindex\fR, and returns a reference to the string. +.PP +See also insert() and remove(). +.SH "QString & QString::replace ( uint index, uint len, QChar c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is the same as replace(\fIindex\fR, \fIlen\fR, QString(\fIc\fR)). +.SH "QString & QString::replace ( uint index, uint len, char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is the same as replace(\fIindex\fR, \fIlen\fR, QChar(\fIc\fR)). +.SH "QString & QString::replace ( QChar c, const QString & after, bool cs = TRUE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of the character \fIc\fR in the string with \fIafter\fR. Returns a reference to the string. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +Example: +.PP +.nf +.br + QString s = "a,b,c"; +.br + s.replace( QChar(','), " or " ); +.br + // s == "a or b or c" +.br +.fi +.SH "QString & QString::replace ( char c, const QString & after, bool cs = TRUE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of the character \fIc\fR in the string with \fIafter\fR. Returns a reference to the string. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.SH "QString & QString::replace ( const QString & before, const QString & after, bool cs = TRUE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of the string \fIbefore\fR in the string with the string \fIafter\fR. Returns a reference to the string. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +Example: +.PP +.nf +.br + QString s = "Greek is Greek"; +.br + s.replace( "Greek", "English" ); +.br + // s == "English is English" +.br +.fi +.SH "QString & QString::replace ( const QRegExp & rx, const QString & after )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of the regexp \fIrx\fR in the string with \fIafter\fR. Returns a reference to the string. For example: +.PP +.nf +.br + QString s = "banana"; +.br + s.replace( QRegExp("an"), "" ); +.br + // s == "ba" +.br +.fi +.PP +For regexps containing capturing parentheses, occurrences of \fB\1\fR, \fB\2\fR, ..., in \fIafter\fR are replaced with \fIrx\fR.cap(1), cap(2), ... +.PP +.nf +.br + QString t = "A <i>bon mot</i>."; +.br + t.replace( QRegExp("<i>([^<]*)</i>"), "\\\\emph{\\\\1}" ); +.br + // t == "A \\\\emph{bon mot}." +.br +.fi +.PP +See also find(), findRev(), and QRegExp::cap(). +.SH "QString & QString::replace ( QChar c1, QChar c2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of \fIc1\fR with the char \fIc2\fR. Returns a reference to the string. +.SH "void QString::reserve ( uint minCapacity )" +Ensures that at least \fIminCapacity\fR characters are allocated to the string. +.PP +This function is useful for code that needs to build up a long string and wants to avoid repeated reallocation. In this example, we want to add to the string until some condition is true, and we're fairly sure that size is big enough: +.PP +.nf +.br + QString result; +.br + int len = 0; +.br + result.reserve(maxLen); +.br + while (...) { +.br + result[len++] = ... // fill part of the space +.br + } +.br + result.squeeze(); +.br +.fi +.PP +If \fImaxLen\fR is an underestimate, the worst that will happen is that the loop will slow down. +.PP +If it is not possible to allocate enough memory, the string remains unchanged. +.PP +See also capacity(), squeeze(), and setLength(). +.SH "QString QString::right ( uint len ) const" +Returns a string that contains the \fIlen\fR rightmost characters of the string. +.PP +If \fIlen\fR is greater than the length of the string then the whole string is returned. +.PP +.nf +.br + QString string( "Pineapple" ); +.br + QString t = string.right( 5 ); // t == "apple" +.br +.fi +.PP +See also left(), mid(), and isEmpty(). +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "QString QString::rightJustify ( uint width, QChar fill = ' ', bool truncate = FALSE ) const" +Returns a string of length \fIwidth\fR that contains the \fIfill\fR character followed by the string. +.PP +If \fItruncate\fR is FALSE and the length of the string is more than \fIwidth\fR, then the returned string is a copy of the string. +.PP +If \fItruncate\fR is TRUE and the length of the string is more than \fIwidth\fR, then the resulting string is truncated at position \fIwidth\fR. +.PP +.nf +.br + QString string( "apple" ); +.br + QString t = string.rightJustify( 8, '.' ); // t == "...apple" +.br +.fi +.PP +See also leftJustify(). +.SH "QString QString::section ( QChar sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +This function returns a section of the string. +.PP +This string is treated as a sequence of fields separated by the character, \fIsep\fR. The returned string consists of the fields from position \fIstart\fR to position \fIend\fR inclusive. If \fIend\fR is not specified, all fields from position \fIstart\fR to the end of the string are included. Fields are numbered 0, 1, 2, etc., counting from the left, and -1, -2, etc., counting from right to left. +.PP +The \fIflags\fR argument can be used to affect some aspects of the function's behaviour, e.g. whether to be case sensitive, whether to skip empty fields and how to deal with leading and trailing separators; see SectionFlags. +.PP +.nf +.br + QString csv( "forename,middlename,surname,phone" ); +.br + QString s = csv.section( ',', 2, 2 ); // s == "surname" +.br +.br + QString path( "/usr/local/bin/myapp" ); // First field is empty +.br + QString s = path.section( '/', 3, 4 ); // s == "bin/myapp" +.br + QString s = path.section( '/', 3, 3, SectionSkipEmpty ); // s == "myapp" +.br +.fi +.PP +If \fIstart\fR or \fIend\fR is negative, we count fields from the right of the string, the right-most field being -1, the one from right-most field being -2, and so on. +.PP +.nf +.br + QString csv( "forename,middlename,surname,phone" ); +.br + QString s = csv.section( ',', -3, -2 ); // s == "middlename,surname" +.br +.br + QString path( "/usr/local/bin/myapp" ); // First field is empty +.br + QString s = path.section( '/', -1 ); // s == "myapp" +.br +.fi +.PP +See also QStringList::split(). +.PP +Examples: +.)l chart/element.cpp and network/ftpclient/ftpmainwindow.ui.h. +.SH "QString QString::section ( char sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QString QString::section ( const char * sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QString QString::section ( const QString & sep, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function returns a section of the string. +.PP +This string is treated as a sequence of fields separated by the string, \fIsep\fR. The returned string consists of the fields from position \fIstart\fR to position \fIend\fR inclusive. If \fIend\fR is not specified, all fields from position \fIstart\fR to the end of the string are included. Fields are numbered 0, 1, 2, etc., counting from the left, and -1, -2, etc., counting from right to left. +.PP +The \fIflags\fR argument can be used to affect some aspects of the function's behaviour, e.g. whether to be case sensitive, whether to skip empty fields and how to deal with leading and trailing separators; see SectionFlags. +.PP +.nf +.br + QString data( "forename**middlename**surname**phone" ); +.br + QString s = data.section( "**", 2, 2 ); // s == "surname" +.br +.fi +.PP +If \fIstart\fR or \fIend\fR is negative, we count fields from the right of the string, the right-most field being -1, the one from right-most field being -2, and so on. +.PP +.nf +.br + QString data( "forename**middlename**surname**phone" ); +.br + QString s = data.section( "**", -3, -2 ); // s == "middlename**surname" +.br +.fi +.PP +See also QStringList::split(). +.SH "QString QString::section ( const QRegExp & reg, int start, int end = 0xffffffff, int flags = SectionDefault ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function returns a section of the string. +.PP +This string is treated as a sequence of fields separated by the regular expression, \fIreg\fR. The returned string consists of the fields from position \fIstart\fR to position \fIend\fR inclusive. If \fIend\fR is not specified, all fields from position \fIstart\fR to the end of the string are included. Fields are numbered 0, 1, 2, etc., counting from the left, and -1, -2, etc., counting from right to left. +.PP +The \fIflags\fR argument can be used to affect some aspects of the function's behaviour, e.g. whether to be case sensitive, whether to skip empty fields and how to deal with leading and trailing separators; see SectionFlags. +.PP +.nf +.br + QString line( "forename\\tmiddlename surname \\t \\t phone" ); +.br + QRegExp sep( "\\s+" ); +.br + QString s = line.section( sep, 2, 2 ); // s == "surname" +.br +.fi +.PP +If \fIstart\fR or \fIend\fR is negative, we count fields from the right of the string, the right-most field being -1, the one from right-most field being -2, and so on. +.PP +.nf +.br + QString line( "forename\\tmiddlename surname \\t \\t phone" ); +.br + QRegExp sep( "\\\\s+" ); +.br + QString s = line.section( sep, -3, -2 ); // s == "middlename surname" +.br +.fi +.PP +\fBWarning:\fR Using this QRegExp version is much more expensive than the overloaded string and character versions. +.PP +See also QStringList::split() and simplifyWhiteSpace(). +.SH "QString & QString::setAscii ( const char * str, int len = -1 )" +Sets this string to \fIstr\fR, interpreted as a classic 8-bit ASCII C string. If \fIlen\fR is -1 (the default), then it is set to strlen(str). +.PP +If \fIstr\fR is 0 a null string is created. If \fIstr\fR is "", an empty string is created. +.PP +See also isNull() and isEmpty(). +.SH "void QString::setExpand ( uint index, QChar c )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the character at position \fIindex\fR to \fIc\fR and expands the string if necessary, filling with spaces. +.PP +This method is redundant in Qt 3.x, because operator[] will expand the string as necessary. +.SH "QString & QString::setLatin1 ( const char * str, int len = -1 )" +Sets this string to \fIstr\fR, interpreted as a classic Latin-1 C string. If \fIlen\fR is -1 (the default), then it is set to strlen(str). +.PP +If \fIstr\fR is 0 a null string is created. If \fIstr\fR is "", an empty string is created. +.PP +See also isNull() and isEmpty(). +.SH "void QString::setLength ( uint newLen )" +Ensures that at least \fInewLen\fR characters are allocated to the string, and sets the length of the string to \fInewLen\fR. Any new space allocated contains arbitrary data. +.PP +See also reserve() and truncate(). +.SH "QString & QString::setNum ( TQ_LLONG n, int base = 10 )" +Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. The returned string is in "C" locale. +.PP +The base is 10 by default and must be between 2 and 36. +.PP +.nf +.br + QString string; +.br + string = string.setNum( 1234 ); // string == "1234" +.br +.fi +.SH "QString & QString::setNum ( short n, int base = 10 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. +.PP +The base is 10 by default and must be between 2 and 36. +.SH "QString & QString::setNum ( ushort n, int base = 10 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. +.PP +The base is 10 by default and must be between 2 and 36. +.SH "QString & QString::setNum ( int n, int base = 10 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. +.PP +The base is 10 by default and must be between 2 and 36. +.SH "QString & QString::setNum ( uint n, int base = 10 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. +.PP +The base is 10 by default and must be between 2 and 36. +.SH "QString & QString::setNum ( long n, int base = 10 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QString & QString::setNum ( ulong n, int base = 10 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QString & QString::setNum ( TQ_ULLONG n, int base = 10 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the printed value of \fIn\fR in base \fIbase\fR and returns a reference to the string. +.PP +The base is 10 by default and must be between 2 and 36. +.SH "QString & QString::setNum ( float n, char f = 'g', int prec = 6 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the printed value of \fIn\fR, formatted in format \fIf\fR with precision \fIprec\fR, and returns a reference to the string. +.PP +The format \fIf\fR can be 'f', 'F', 'e', 'E', 'g' or 'G'. See arg() for an explanation of the formats. +.SH "QString & QString::setNum ( double n, char f = 'g', int prec = 6 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the string to the printed value of \fIn\fR, formatted in format \fIf\fR with precision \fIprec\fR, and returns a reference to the string. +.PP +The format \fIf\fR can be 'f', 'F', 'e', 'E', 'g' or 'G'. See arg() for an explanation of the formats. +.SH "QString & QString::setUnicode ( const QChar * unicode, uint len )" +Resizes the string to \fIlen\fR characters and copies \fIunicode\fR into the string. If \fIunicode\fR is 0, nothing is copied, but the string is still resized to \fIlen\fR. If \fIlen\fR is zero, then the string becomes a null string. +.PP +See also setLatin1() and isNull(). +.SH "QString & QString::setUnicodeCodes ( const ushort * unicode_as_ushorts, uint len )" +Resizes the string to \fIlen\fR characters and copies \fIunicode_as_ushorts\fR into the string (on some X11 client platforms this will involve a byte-swapping pass). +.PP +If \fIunicode_as_ushorts\fR is 0, nothing is copied, but the string is still resized to \fIlen\fR. If \fIlen\fR is zero, the string becomes a null string. +.PP +See also setLatin1() and isNull(). +.SH "QString QString::simplifyWhiteSpace () const" +Returns a string that has whitespace removed from the start and the end, and which has each sequence of internal whitespace replaced with a single space. +.PP +Whitespace means any character for which QChar::isSpace() returns TRUE. This includes Unicode characters with decimal values 9 (TAB), 10 (LF), 11 (VT), 12 (FF), 13 (CR), and 32 (Space). +.PP +.nf +.br + QString string = " lots\\t of\\nwhite space "; +.br + QString t = string.simplifyWhiteSpace(); +.br + // t == "lots of white space" +.br +.fi +.PP +See also stripWhiteSpace(). +.SH "QString & QString::sprintf ( const char * cformat, ... )" +Safely builds a formatted string from the format string \fIcformat\fR and an arbitrary list of arguments. The format string supports all the escape sequences of printf() in the standard C library. +.PP +The %s escape sequence expects a utf8() encoded string. The format string \fIcformat\fR is expected to be in latin1. If you need a Unicode format string, use arg() instead. For typesafe string building, with full Unicode support, you can use QTextOStream like this: +.PP +.nf +.br + QString str; +.br + QString s = ...; +.br + int x = ...; +.br + QTextOStream( &str ) << s << " : " << x; +.br +.fi +.PP +For translations, especially if the strings contains more than one escape sequence, you should consider using the arg() function instead. This allows the order of the replacements to be controlled by the translator, and has Unicode support. +.PP +The %lc escape sequence expects a unicode character of type ushort (as returned by QChar::unicode()). The %ls escape sequence expects a pointer to a zero-terminated array of unicode characters of type ushort (as returned by QString::ucs2()). +.PP +See also arg(). +.PP +Examples: +.)l dclock/dclock.cpp, forever/forever.cpp, layout/layout.cpp, qmag/qmag.cpp, scrollview/scrollview.cpp, tooltip/tooltip.cpp, and xform/xform.cpp. +.SH "void QString::squeeze ()" +Squeezes the string's capacity to the current content. +.PP +See also capacity() and reserve(). +.SH "bool QString::startsWith ( const QString & s, bool cs = TRUE ) const" +Returns TRUE if the string starts with \fIs\fR; otherwise returns FALSE. +.PP +If \fIcs\fR is TRUE (the default), the search is case sensitive; otherwise the search is case insensitive. +.PP +.nf +.br + QString str( "Bananas" ); +.br + str.startsWith( "Ban" ); // returns TRUE +.br + str.startsWith( "Car" ); // returns FALSE +.br +.fi +.PP +See also endsWith(). +.SH "QString QString::stripWhiteSpace () const" +Returns a string that has whitespace removed from the start and the end. +.PP +Whitespace means any character for which QChar::isSpace() returns TRUE. This includes Unicode characters with decimal values 9 (TAB), 10 (LF), 11 (VT), 12 (FF), 13 (CR) and 32 (Space), and may also include other Unicode characters. +.PP +.nf +.br + QString string = " white space "; +.br + QString s = string.stripWhiteSpace(); // s == "white space" +.br +.fi +.PP +See also simplifyWhiteSpace(). +.SH "double QString::toDouble ( bool * ok = 0 ) const" +Returns the string converted to a \fCdouble\fR value. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +.nf +.br + QString string( "1234.56" ); +.br + double a = string.toDouble(); // a == 1234.56 +.br +.fi +.PP +The string-to-number functions: +.TP +toShort() +.TP +toUShort() +.TP +toInt() +.TP +toUInt() +.TP +toLong() +.TP +toULong() +.TP +toLongLong() +.TP +toULongLong() +.TP +toFloat() +.TP +toDouble() can handle numbers represented in various locales. These representations may use different characters for the decimal point, thousands group sepearator and even individual digits. QString's functions try to interpret the string according to the current locale. The current locale is determined from the system at application startup and can be changed by calling QLocale::setDefault(). If the string cannot be interpreted according to the current locale, this function falls back on the "C" locale. +.PP +.nf +.br + bool ok; +.br + double d; +.br +.br + QLocale::setDefault(QLocale::C); +.br + d = QString( "1234,56" ).toDouble(&ok); // ok == false +.br + d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 +.br +.br + QLocale::setDefault(QLocale::German); +.br + d = QString( "1234,56" ).toDouble(&ok); // ok == true, d == 1234.56 +.br + d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56 +.br +.fi +.PP +Due to the ambiguity between the decimal point and thousands group separator in various locales, these functions do not handle thousands group separators. If you need to convert such numbers, use the corresponding function in QLocale. +.PP +.nf +.br + bool ok; +.br + QLocale::setDefault(QLocale::C); +.br + double d = QString( "1,234,567.89" ).toDouble(&ok); // ok == false +.br +.fi +.PP +\fBWarning:\fR If the string contains trailing whitespace this function will fail, and set \fI*ok\fR to false if \fIok\fR is not 0. Leading whitespace is ignored. +.PP +See also number(), QLocale::setDefault(), QLocale::toDouble(), and stripWhiteSpace(). +.SH "float QString::toFloat ( bool * ok = 0 ) const" +Returns the string converted to a \fCfloat\fR value. +.PP +Returns 0.0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +\fBWarning:\fR If the string contains trailing whitespace this function will fail, settings \fI*ok\fR to false if \fIok\fR is not 0. Leading whitespace is ignored. +.PP +See also number(). +.SH "int QString::toInt ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to an \fCint\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +.nf +.br + QString str( "FF" ); +.br + bool ok; +.br + int hex = str.toInt( &ok, 16 ); // hex == 255, ok == TRUE +.br + int dec = str.toInt( &ok, 10 ); // dec == 0, ok == FALSE +.br +.fi +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "long QString::toLong ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to a \fClong\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "TQ_LLONG QString::toLongLong ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to a \fClong long\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "short QString::toShort ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to a \fCshort\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "uint QString::toUInt ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to an \fCunsigned int\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "ulong QString::toULong ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to an \fCunsigned long\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "TQ_ULLONG QString::toULongLong ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to an \fCunsigned long long\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "ushort QString::toUShort ( bool * ok = 0, int base = 10 ) const" +Returns the string converted to an \fCunsigned short\fR using base \fIbase\fR, which is 10 by default and must be between 2 and 36 or 0. If \fIbase\fR is 0, the base is determined automatically using the following rules: +.TP +If the string begins with "0x", it is assumed to be hexadecimal; +.TP +If it begins with "0", it is assumed to be octal; +.TP +Otherwise it is assumed to be decimal. +.PP +Returns 0 if the conversion fails. +.PP +If \fIok\fR is not 0: if a conversion error occurs, \fI*ok\fR is set to FALSE; otherwise \fI*ok\fR is set to TRUE. +.PP +Leading and trailing whitespace is ignored by this function. +.PP +For information on how string-to-number functions in QString handle localized input, see toDouble(). +.PP +See also number(). +.SH "void QString::truncate ( uint newLen )" +If \fInewLen\fR is less than the length of the string, then the string is truncated at position \fInewLen\fR. Otherwise nothing happens. +.PP +.nf +.br + QString s = "truncate me"; +.br + s.truncate( 5 ); // s == "trunc" +.br +.fi +.PP +See also setLength(). +.PP +Example: network/mail/smtp.cpp. +.SH "const unsigned short * QString::ucs2 () const" +Returns the QString as a zero terminated array of unsigned shorts if the string is not null; otherwise returns zero. +.PP +The result remains valid so long as one unmodified copy of the source string exists. +.PP +Example: dotnet/wrapper/lib/tools.cpp. +.SH "const QChar * QString::unicode () const" +Returns the Unicode representation of the string. The result remains valid until the string is modified. +.SH "QString QString::upper () const" +Returns an uppercase copy of the string. +.PP +.nf +.br + QString string( "TeXt" ); +.br + str = string.upper(); // t == "TEXT" +.br +.fi +.PP +See also lower(). +.PP +Examples: +.)l scribble/scribble.cpp and sql/overview/custom1/main.cpp. +.SH "QCString QString::utf8 () const" +Returns the string encoded in UTF-8 format. +.PP +See QTextCodec for more diverse coding/decoding of Unicode strings. +.PP +See also fromUtf8(), ascii(), latin1(), and local8Bit(). +.PP +Example: network/archivesearch/archivedialog.ui.h. +.SH RELATED FUNCTION DOCUMENTATION +.SH "bool operator!= ( const QString & s1, const QString & s2 )" +Returns TRUE if \fIs1\fR is not equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) != 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator!= ( const QString & s1, const char * s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is not equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) != 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator!= ( const char * s1, const QString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is not equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) != 0. +.PP +See also isNull() and isEmpty(). +.SH "const QString operator+ ( const QString & s1, const QString & s2 )" +Returns a string which is the result of concatenating the string \fIs1\fR and the string \fIs2\fR. +.PP +Equivalent to \fIs1\fR.append(\fIs2\fR). +.SH "const QString operator+ ( const QString & s1, const char * s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which is the result of concatenating the string \fIs1\fR and character \fIs2\fR. +.PP +Equivalent to \fIs1\fR.append(\fIs2\fR). +.SH "const QString operator+ ( const char * s1, const QString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which is the result of concatenating the character \fIs1\fR and string \fIs2\fR. +.SH "const QString operator+ ( const QString & s, char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which is the result of concatenating the string \fIs\fR and character \fIc\fR. +.PP +Equivalent to \fIs\fR.append(\fIc\fR). +.SH "const QString operator+ ( char c, const QString & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a string which is the result of concatenating the character \fIc\fR and string \fIs\fR. +.PP +Equivalent to \fIs\fR.prepend(\fIc\fR). +.SH "bool operator< ( const QString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is lexically less than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) < 0. +.SH "bool operator< ( const char * s1, const QString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is lexically less than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) < 0. +.SH "QDataStream & operator<< ( QDataStream & s, const QString & str )" +Writes the string \fIstr\fR to the stream \fIs\fR. +.PP +See also Format of the QDataStream operators +.SH "bool operator<= ( const QString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is lexically less than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR,\fIs2\fR) <= 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator<= ( const char * s1, const QString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is lexically less than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) <= 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator== ( const QString & s1, const QString & s2 )" +Returns TRUE if \fIs1\fR is equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) == 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator== ( const QString & s1, const char * s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) == 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator== ( const char * s1, const QString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is equal to \fIs2\fR; otherwise returns FALSE. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) == 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator> ( const QString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is lexically greater than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) > 0. +.SH "bool operator> ( const char * s1, const QString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is lexically greater than \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) > 0. +.SH "bool operator>= ( const QString & s1, const char * s2 )" +Returns TRUE if \fIs1\fR is lexically greater than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) >= 0. +.PP +See also isNull() and isEmpty(). +.SH "bool operator>= ( const char * s1, const QString & s2 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if \fIs1\fR is lexically greater than or equal to \fIs2\fR; otherwise returns FALSE. The comparison is case sensitive. Note that a null string is not equal to a not-null empty string. +.PP +Equivalent to compare(\fIs1\fR, \fIs2\fR) >= 0. +.PP +See also isNull() and isEmpty(). +.SH "QDataStream & operator>> ( QDataStream & s, QString & str )" +Reads a string from the stream \fIs\fR into string \fIstr\fR. +.PP +See also Format of the QDataStream operators + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstring.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstring.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstringlist.3qt b/doc/man/man3/tqstringlist.3qt new file mode 100644 index 000000000..05258fafc --- /dev/null +++ b/doc/man/man3/tqstringlist.3qt @@ -0,0 +1,336 @@ +'\" t +.TH QStringList 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 +QStringList \- List of strings +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqstringlist.h>\fR +.PP +Inherits QValueList<QString>. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStringList\fR ()" +.br +.ti -1c +.BI "\fBQStringList\fR ( const QStringList & l )" +.br +.ti -1c +.BI "\fBQStringList\fR ( const QValueList<QString> & l )" +.br +.ti -1c +.BI "\fBQStringList\fR ( const QString & i )" +.br +.ti -1c +.BI "\fBQStringList\fR ( const char * i )" +.br +.ti -1c +.BI "void \fBsort\fR ()" +.br +.ti -1c +.BI "QString \fBjoin\fR ( const QString & sep ) const" +.br +.ti -1c +.BI "QStringList \fBgrep\fR ( const QString & str, bool cs = TRUE ) const" +.br +.ti -1c +.BI "QStringList \fBgrep\fR ( const QRegExp & rx ) const" +.br +.ti -1c +.BI "QStringList & \fBgres\fR ( const QString & before, const QString & after, bool cs = TRUE )" +.br +.ti -1c +.BI "QStringList & \fBgres\fR ( const QRegExp & rx, const QString & after )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QStringList \fBfromStrList\fR ( const QStrList & ascii )" +.br +.ti -1c +.BI "QStringList \fBsplit\fR ( const QString & sep, const QString & str, bool allowEmptyEntries = FALSE )" +.br +.ti -1c +.BI "QStringList \fBsplit\fR ( const QChar & sep, const QString & str, bool allowEmptyEntries = FALSE )" +.br +.ti -1c +.BI "QStringList \fBsplit\fR ( const QRegExp & sep, const QString & str, bool allowEmptyEntries = FALSE )" +.br +.in -1c +.SH DESCRIPTION +The QStringList class provides a list of strings. +.PP +It is used to store and manipulate strings that logically belong together. Essentially QStringList is a QValueList of QString objects. Unlike QStrList, which stores pointers to characters, QStringList holds real QString objects. It is the class of choice whenever you work with Unicode strings. QStringList is part of the Qt Template Library. +.PP +Like QString itself, QStringList objects are implicitly shared, so passing them around as value-parameters is both fast and safe. +.PP +Strings can be added to a list using append(), operator+=() or operator<<(), e.g. +.PP +.nf +.br + QStringList fonts; +.br + fonts.append( "Times" ); +.br + fonts += "Courier"; +.br + fonts += "Courier New"; +.br + fonts << "Helvetica [Cronyx]" << "Helvetica [Adobe]"; +.br +.fi +.PP +String lists have an iterator, QStringList::Iterator(), e.g. +.PP +.nf +.br + for ( QStringList::Iterator it = fonts.begin(); it != fonts.end(); ++it ) { +.br + cout << *it << ":"; +.br + } +.br + cout << endl; +.br + // Output: +.br + // Times:Courier:Courier New:Helvetica [Cronyx]:Helvetica [Adobe]: +.br +.fi +.PP +Many Qt functions return string lists by value; to iterate over these you should make a copy and iterate over the copy. +.PP +You can concatenate all the strings in a string list into a single string (with an optional separator) using join(), e.g. +.PP +.nf +.br + QString allFonts = fonts.join( ", " ); +.br + cout << allFonts << endl; +.br + // Output: +.br + // Times, Courier, Courier New, Helvetica [Cronyx], Helvetica [Adobe] +.br +.fi +.PP +You can sort the list with sort(), and extract a new list which contains only those strings which contain a particular substring (or match a particular regular expression) using the grep() functions, e.g. +.PP +.nf +.br + fonts.sort(); +.br + cout << fonts.join( ", " ) << endl; +.br + // Output: +.br + // Courier, Courier New, Helvetica [Adobe], Helvetica [Cronyx], Times +.br +.br + QStringList helveticas = fonts.grep( "Helvetica" ); +.br + cout << helveticas.join( ", " ) << endl; +.br + // Output: +.br + // Helvetica [Adobe], Helvetica [Cronyx] +.br +.fi +.PP +Existing strings can be split into string lists with character, string or regular expression separators, e.g. +.PP +.nf +.br + QString s = "Red\\tGreen\\tBlue"; +.br + QStringList colors = QStringList::split( "\\t", s ); +.br + cout << colors.join( ", " ) << endl; +.br + // Output: +.br + // Red, Green, Blue +.br +.fi +.PP +See also Implicitly and Explicitly Shared Classes, Text Related Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStringList::QStringList ()" +Creates an empty string list. +.SH "QStringList::QStringList ( const QStringList & l )" +Creates a copy of the list \fIl\fR. This function is very fast because QStringList is implicitly shared. In most situations this acts like a deep copy, for example, if this list or the original one or some other list referencing the same shared data is modified, the modifying list first makes a copy, i.e. copy-on-write. In a threaded environment you may require a real deep copy +. +.SH "QStringList::QStringList ( const QValueList<QString> & l )" +Constructs a new string list that is a copy of \fIl\fR. +.SH "QStringList::QStringList ( const QString & i )" +Constructs a string list consisting of the single string \fIi\fR. Longer lists are easily created as follows: +.PP +.nf +.br + QStringList items; +.br + items << "Buy" << "Sell" << "Update" << "Value"; +.br +.fi +.SH "QStringList::QStringList ( const char * i )" +Constructs a string list consisting of the single Latin-1 string \fIi\fR. +.SH "QStringList QStringList::fromStrList ( const QStrList & ascii )\fC [static]\fR" +Converts from an ASCII-QStrList \fIascii\fR to a QStringList (Unicode). +.SH "QStringList QStringList::grep ( const QString & str, bool cs = TRUE ) const" +Returns a list of all the strings containing the substring \fIstr\fR. +.PP +If \fIcs\fR is TRUE, the grep is done case-sensitively; otherwise case is ignored. +.PP +.nf +.br + QStringList list; +.br + list << "Bill Gates" << "John Doe" << "Bill Clinton"; +.br + list = list.grep( "Bill" ); +.br + // list == ["Bill Gates", "Bill Clinton"] +.br +.fi +.PP +See also QString::find(). +.SH "QStringList QStringList::grep ( const QRegExp & rx ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a list of all the strings that match the regular expression \fIrx\fR. +.PP +See also QString::find(). +.SH "QStringList & QStringList::gres ( const QString & before, const QString & after, bool cs = TRUE )" +Replaces every occurrence of the string \fIbefore\fR in the strings that constitute the string list with the string \fIafter\fR. Returns a reference to the string list. +.PP +If \fIcs\fR is TRUE, the search is case sensitive; otherwise the search is case insensitive. +.PP +Example: +.PP +.nf +.br + QStringList list; +.br + list << "alpha" << "beta" << "gamma" << "epsilon"; +.br + list.gres( "a", "o" ); +.br + // list == ["olpho", "beto", "gommo", "epsilon"] +.br +.fi +.PP +See also QString::replace(). +.SH "QStringList & QStringList::gres ( const QRegExp & rx, const QString & after )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Replaces every occurrence of the regexp \fIrx\fR in the string with \fIafter\fR. Returns a reference to the string list. +.PP +Example: +.PP +.nf +.br + QStringList list; +.br + list << "alpha" << "beta" << "gamma" << "epsilon"; +.br + list.gres( QRegExp("^a"), "o" ); +.br + // list == ["olpha", "beta", "gamma", "epsilon"] +.br +.fi +.PP +For regexps containing capturing parentheses, occurrences of \fB\1\fR, \fB\2\fR, ..., in \fIafter\fR are replaced with \fIrx\fR.cap(1), cap(2), ... +.PP +Example: +.PP +.nf +.br + QStringList list; +.br + list << "Bill Clinton" << "Gates, Bill"; +.br + list.gres( QRegExp("^(.*), (.*)$"), "\\\\2 \\\\1" ); +.br + // list == ["Bill Clinton", "Bill Gates"] +.br +.fi +.PP +See also QString::replace(). +.SH "QString QStringList::join ( const QString & sep ) const" +Joins the string list into a single string with each element separated by the string \fIsep\fR (which can be empty). +.PP +See also split(). +.PP +Examples: +.)l fileiconview/qfileiconview.cpp and toplevel/options.ui.h. +.SH "void QStringList::sort ()" +Sorts the list of strings in ascending case-sensitive order. +.PP +Sorting is very fast. It uses the Qt Template Library's efficient HeapSort implementation that has a time complexity of O(n*log n). +.PP +If you want to sort your strings in an arbitrary order consider using a QMap. For example you could use a QMap<QString,QString> to create a case-insensitive ordering (e.g. mapping the lowercase text to the text), or a QMap<int,QString> to sort the strings by some integer index, etc. +.PP +Example: themes/themes.cpp. +.SH "QStringList QStringList::split ( const QRegExp & sep, const QString & str, bool allowEmptyEntries = FALSE )\fC [static]\fR" +Splits the string \fIstr\fR into strings wherever the regular expression \fIsep\fR occurs, and returns the list of those strings. +.PP +If \fIallowEmptyEntries\fR is TRUE, a null string is inserted in the list wherever the separator matches twice without intervening text. +.PP +For example, if you split the string "a,,b,c" on commas, split() returns the three-item list "a", "b", "c" if \fIallowEmptyEntries\fR is FALSE (the default), and the four-item list "a", "", "b", "c" if \fIallowEmptyEntries\fR is TRUE. +.PP +If \fIsep\fR does not match anywhere in \fIstr\fR, split() returns a single element list with the element containing the single string \fIstr\fR. +.PP +See also join() and QString::section(). +.PP +Examples: +.)l chart/element.cpp, dirview/dirview.cpp, and network/httpd/httpd.cpp. +.SH "QStringList QStringList::split ( const QString & sep, const QString & str, bool allowEmptyEntries = FALSE )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version of the function uses a QString as separator, rather than a regular expression. +.PP +If \fIsep\fR is an empty string, the return value is a list of one-character strings: split( QString( "" ), "four" ) returns the four-item list, "f", "o", "u", "r". +.PP +If \fIallowEmptyEntries\fR is TRUE, a null string is inserted in the list wherever the separator matches twice without intervening text. +.PP +See also join() and QString::section(). +.SH "QStringList QStringList::split ( const QChar & sep, const QString & str, bool allowEmptyEntries = FALSE )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version of the function uses a QChar as separator, rather than a regular expression. +.PP +See also join() and QString::section(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstringlist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstringlist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstrlist.3qt b/doc/man/man3/tqstrlist.3qt new file mode 100644 index 000000000..da9be26a8 --- /dev/null +++ b/doc/man/man3/tqstrlist.3qt @@ -0,0 +1,92 @@ +'\" t +.TH QStrList 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 +QStrList \- Doubly-linked list of char* +.SH SYNOPSIS +\fC#include <ntqstrlist.h>\fR +.PP +Inherits QPtrList<char>. +.PP +Inherited by QStrIList. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStrList\fR ( bool deepCopies = TRUE )" +.br +.ti -1c +.BI "\fBQStrList\fR ( const QStrList & list )" +.br +.ti -1c +.BI "\fB~QStrList\fR ()" +.br +.ti -1c +.BI "QStrList & \fBoperator=\fR ( const QStrList & list )" +.br +.in -1c +.SH DESCRIPTION +The QStrList class provides a doubly-linked list of char*. +.PP +If you want a string list of QStrings use QStringList. +.PP +This class is a QPtrList<char> instance (a list of char*). +.PP +QStrList can make deep or shallow copies of the strings that are inserted. +.PP +A deep copy means that memory is allocated for the string and then the string data is copied into that memory. A shallow copy is just a copy of the pointer value and not of the string data itself. +.PP +The disadvantage of shallow copies is that because a pointer can be deleted only once, the program must put all strings in a central place and know when it is safe to delete them (i.e. when the strings are no longer referenced by other parts of the program). This can make the program more complex. The advantage of shallow copies is that they consume far less memory than deep copies. It is also much faster to copy a pointer (typically 4 or 8 bytes) than to copy string data. +.PP +A QStrList that operates on deep copies will, by default, turn on auto-deletion (see setAutoDelete()). Thus, by default QStrList will deallocate any string copies it allocates. +.PP +The virtual compareItems() function is reimplemented and does a case-sensitive string comparison. The inSort() function will insert strings in sorted order. In general it is fastest to insert the strings as they come and sort() at the end; inSort() is useful when you just have to add a few extra strings to an already sorted list. +.PP +The QStrListIterator class is an iterator for QStrList. +.PP +See also Collection Classes, Text Related Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStrList::QStrList ( bool deepCopies = TRUE )" +Constructs an empty list of strings. Will make deep copies of all inserted strings if \fIdeepCopies\fR is TRUE, or use shallow copies if \fIdeepCopies\fR is FALSE. +.SH "QStrList::QStrList ( const QStrList & list )" +Constructs a copy of \fIlist\fR. +.PP +If \fIlist\fR has deep copies, this list will also get deep copies. Only the pointers are copied (shallow copy) if the other list does not use deep copies. +.SH "QStrList::~QStrList ()" +Destroys the list. All strings are removed. +.SH "QStrList & QStrList::operator= ( const QStrList & list )" +Assigns \fIlist\fR to this list and returns a reference to this list. +.PP +If \fIlist\fR has deep copies, this list will also get deep copies. +Only the pointers are copied (shallow copy) if the other list does +not use deep copies. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstrlist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstrlist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstrlistiterator.3qt b/doc/man/man3/tqstrlistiterator.3qt new file mode 100644 index 000000000..24816378f --- /dev/null +++ b/doc/man/man3/tqstrlistiterator.3qt @@ -0,0 +1,46 @@ +'\" t +.TH QStrListIterator 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 +QStrListIterator \- Iterator for the QStrList and QStrIList classes +.SH SYNOPSIS +\fC#include <ntqstrlist.h>\fR +.PP +Inherits QPtrListIterator<char>. +.PP +.SH DESCRIPTION +The QStrListIterator class is an iterator for the QStrList and QStrIList classes. +.PP +This class is a QPtrListIterator<char> instance. It can traverse the strings in the QStrList and QStrIList classes. +.PP +See also Non-GUI Classes. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qstrlistiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstrlistiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstyle.3qt b/doc/man/man3/tqstyle.3qt new file mode 100644 index 000000000..19899636e --- /dev/null +++ b/doc/man/man3/tqstyle.3qt @@ -0,0 +1,1089 @@ +'\" t +.TH QStyle 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 +QStyle \- The look and feel of a GUI +.SH SYNOPSIS +\fC#include <ntqstyle.h>\fR +.PP +Inherits QObject. +.PP +Inherited by QCommonStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStyle\fR ()" +.br +.ti -1c +.BI "virtual \fB~QStyle\fR ()" +.br +.ti -1c +.BI "virtual void \fBpolish\fR ( QWidget * )" +.br +.ti -1c +.BI "virtual void \fBunPolish\fR ( QWidget * )" +.br +.ti -1c +.BI "virtual void \fBpolish\fR ( QApplication * )" +.br +.ti -1c +.BI "virtual void \fBunPolish\fR ( QApplication * )" +.br +.ti -1c +.BI "virtual void \fBpolish\fR ( QPalette & )" +.br +.ti -1c +.BI "virtual void \fBpolishPopupMenu\fR ( QPopupMenu * ) = 0" +.br +.ti -1c +.BI "virtual QRect \fBitemRect\fR ( QPainter * p, const QRect & r, int flags, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1 ) const" +.br +.ti -1c +.BI "virtual void \fBdrawItem\fR ( QPainter * p, const QRect & r, int flags, const QColorGroup & g, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1, const QColor * penColor = 0 ) const" +.br +.ti -1c +.BI "enum \fBPrimitiveElement\fR { PE_ButtonCommand, PE_ButtonDefault, PE_ButtonBevel, PE_ButtonTool, PE_ButtonDropDown, PE_FocusRect, PE_ArrowUp, PE_ArrowDown, PE_ArrowRight, PE_ArrowLeft, PE_SpinWidgetUp, PE_SpinWidgetDown, PE_SpinWidgetPlus, PE_SpinWidgetMinus, PE_Indicator, PE_IndicatorMask, PE_ExclusiveIndicator, PE_ExclusiveIndicatorMask, PE_DockWindowHandle, PE_DockWindowSeparator, PE_DockWindowResizeHandle, PE_Splitter, PE_Panel, PE_PanelPopup, PE_PanelMenuBar, PE_PanelDockWindow, PE_TabBarBase, PE_HeaderSection, PE_HeaderArrow, PE_StatusBarSection, PE_GroupBoxFrame, PE_Separator, PE_SizeGrip, PE_CheckMark, PE_ScrollBarAddLine, PE_ScrollBarSubLine, PE_ScrollBarAddPage, PE_ScrollBarSubPage, PE_ScrollBarSlider, PE_ScrollBarFirst, PE_ScrollBarLast, PE_ProgressBarChunk, PE_PanelLineEdit, PE_PanelTabWidget, PE_WindowFrame, PE_CheckListController, PE_CheckListIndicator, PE_CheckListExclusiveIndicator, PE_PanelGroupBox, PE_RubberBand, PE_CustomBase = 0xf000000 }" +.br +.ti -1c +.BI "enum \fBStyleFlags\fR { Style_Default = 0x00000000, Style_Enabled = 0x00000001, Style_Raised = 0x00000002, Style_Sunken = 0x00000004, Style_Off = 0x00000008, Style_NoChange = 0x00000010, Style_On = 0x00000020, Style_Down = 0x00000040, Style_Horizontal = 0x00000080, Style_HasFocus = 0x00000100, Style_Top = 0x00000200, Style_Bottom = 0x00000400, Style_FocusAtBorder = 0x00000800, Style_AutoRaise = 0x00001000, Style_MouseOver = 0x00002000, Style_Up = 0x00004000, Style_Selected = 0x00008000, Style_Active = 0x00010000, Style_ButtonDefault = 0x00020000 }" +.br +.ti -1c +.BI "virtual void \fBdrawPrimitive\fR ( PrimitiveElement pe, QPainter * p, const QRect & r, const QColorGroup & cg, SFlags flags = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "enum \fBControlElement\fR { CE_PushButton, CE_PushButtonLabel, CE_CheckBox, CE_CheckBoxLabel, CE_RadioButton, CE_RadioButtonLabel, CE_TabBarTab, CE_TabBarLabel, CE_ProgressBarGroove, CE_ProgressBarContents, CE_ProgressBarLabel, CE_PopupMenuItem, CE_MenuBarItem, CE_ToolButtonLabel, CE_MenuBarEmptyArea, CE_PopupMenuScroller, CE_DockWindowEmptyArea, CE_PopupMenuVerticalExtra, CE_PopupMenuHorizontalExtra, CE_ToolBoxTab, CE_HeaderLabel, CE_CustomBase = 0xf0000000 }" +.br +.ti -1c +.BI "virtual void \fBdrawControl\fR ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "virtual void \fBdrawControlMask\fR ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "enum \fBSubRect\fR { SR_PushButtonContents, SR_PushButtonFocusRect, SR_CheckBoxIndicator, SR_CheckBoxContents, SR_CheckBoxFocusRect, SR_RadioButtonIndicator, SR_RadioButtonContents, SR_RadioButtonFocusRect, SR_ComboBoxFocusRect, SR_SliderFocusRect, SR_DockWindowHandleRect, SR_ProgressBarGroove, SR_ProgressBarContents, SR_ProgressBarLabel, SR_ToolButtonContents, SR_DialogButtonAccept, SR_DialogButtonReject, SR_DialogButtonApply, SR_DialogButtonHelp, SR_DialogButtonAll, SR_DialogButtonAbort, SR_DialogButtonIgnore, SR_DialogButtonRetry, SR_DialogButtonCustom, SR_ToolBoxTabContents, SR_CustomBase = 0xf0000000 }" +.br +.ti -1c +.BI "virtual QRect \fBsubRect\fR ( SubRect subrect, const QWidget * widget ) const = 0" +.br +.ti -1c +.BI "enum \fBComplexControl\fR { CC_SpinWidget, CC_ComboBox, CC_ScrollBar, CC_Slider, CC_ToolButton, CC_TitleBar, CC_ListView, CC_CustomBase = 0xf0000000 }" +.br +.ti -1c +.BI "enum \fBSubControl\fR { SC_None = 0x00000000, SC_ScrollBarAddLine = 0x00000001, SC_ScrollBarSubLine = 0x00000002, SC_ScrollBarAddPage = 0x00000004, SC_ScrollBarSubPage = 0x00000008, SC_ScrollBarFirst = 0x00000010, SC_ScrollBarLast = 0x00000020, SC_ScrollBarSlider = 0x00000040, SC_ScrollBarGroove = 0x00000080, SC_SpinWidgetUp = 0x00000001, SC_SpinWidgetDown = 0x00000002, SC_SpinWidgetFrame = 0x00000004, SC_SpinWidgetEditField = 0x00000008, SC_SpinWidgetButtonField = 0x00000010, SC_ComboBoxFrame = 0x00000001, SC_ComboBoxEditField = 0x00000002, SC_ComboBoxArrow = 0x00000004, SC_ComboBoxListBoxPopup = 0x00000008, SC_SliderGroove = 0x00000001, SC_SliderHandle = 0x00000002, SC_SliderTickmarks = 0x00000004, SC_ToolButton = 0x00000001, SC_ToolButtonMenu = 0x00000002, SC_TitleBarLabel = 0x00000001, SC_TitleBarSysMenu = 0x00000002, SC_TitleBarMinButton = 0x00000004, SC_TitleBarMaxButton = 0x00000008, SC_TitleBarCloseButton = 0x00000010, SC_TitleBarNormalButton = 0x00000020, SC_TitleBarShadeButton = 0x00000040, SC_TitleBarUnshadeButton = 0x00000080, SC_ListView = 0x00000001, SC_ListViewBranch = 0x00000002, SC_ListViewExpand = 0x00000004, SC_All = 0xffffffff }" +.br +.ti -1c +.BI "virtual void \fBdrawComplexControl\fR ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, SCFlags sub = SC_All, SCFlags subActive = SC_None, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "virtual void \fBdrawComplexControlMask\fR ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "virtual QRect \fBquerySubControlMetrics\fR ( ComplexControl control, const QWidget * widget, SubControl subcontrol, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "virtual SubControl \fBquerySubControl\fR ( ComplexControl control, const QWidget * widget, const QPoint & pos, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "enum \fBPixelMetric\fR { PM_ButtonMargin, PM_ButtonDefaultIndicator, PM_MenuButtonIndicator, PM_ButtonShiftHorizontal, PM_ButtonShiftVertical, PM_DefaultFrameWidth, PM_SpinBoxFrameWidth, PM_MaximumDragDistance, PM_ScrollBarExtent, PM_ScrollBarSliderMin, PM_SliderThickness, PM_SliderControlThickness, PM_SliderLength, PM_SliderTickmarkOffset, PM_SliderSpaceAvailable, PM_DockWindowSeparatorExtent, PM_DockWindowHandleExtent, PM_DockWindowFrameWidth, PM_MenuBarFrameWidth, PM_TabBarTabOverlap, PM_TabBarTabHSpace, PM_TabBarTabVSpace, PM_TabBarBaseHeight, PM_TabBarBaseOverlap, PM_ProgressBarChunkWidth, PM_SplitterWidth, PM_TitleBarHeight, PM_IndicatorWidth, PM_IndicatorHeight, PM_ExclusiveIndicatorWidth, PM_ExclusiveIndicatorHeight, PM_PopupMenuScrollerHeight, PM_CheckListButtonSize, PM_CheckListControllerSize, PM_PopupMenuFrameHorizontalExtra, PM_PopupMenuFrameVerticalExtra, PM_DialogButtonsSeparator, PM_DialogButtonsButtonWidth, PM_DialogButtonsButtonHeight, PM_MDIFrameWidth, PM_MDIMinimizedWidth, PM_HeaderMargin, PM_HeaderMarkSize, PM_HeaderGripMargin, PM_TabBarTabShiftHorizontal, PM_TabBarTabShiftVertical, PM_TabBarScrollButtonWidth, PM_MenuBarItemSpacing, PM_ToolBarItemSpacing, PM_CustomBase = 0xf0000000 }" +.br +.ti -1c +.BI "virtual int \fBpixelMetric\fR ( PixelMetric metric, const QWidget * widget = 0 ) const = 0" +.br +.ti -1c +.BI "enum \fBContentsType\fR { CT_PushButton, CT_CheckBox, CT_RadioButton, CT_ToolButton, CT_ComboBox, CT_Splitter, CT_DockWindow, CT_ProgressBar, CT_PopupMenuItem, CT_TabBarTab, CT_Slider, CT_Header, CT_LineEdit, CT_MenuBar, CT_SpinBox, CT_SizeGrip, CT_TabWidget, CT_DialogButtons, CT_CustomBase = 0xf0000000 }" +.br +.ti -1c +.BI "virtual QSize \fBsizeFromContents\fR ( ContentsType contents, const QWidget * widget, const QSize & contentsSize, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "enum \fBStyleHint\fR { SH_EtchDisabledText, SH_GUIStyle, SH_ScrollBar_BackgroundMode, SH_ScrollBar_MiddleClickAbsolutePosition, SH_ScrollBar_ScrollWhenPointerLeavesControl, SH_TabBar_SelectMouseType, SH_TabBar_Alignment, SH_Header_ArrowAlignment, SH_Slider_SnapToValue, SH_Slider_SloppyKeyEvents, SH_ProgressDialog_CenterCancelButton, SH_ProgressDialog_TextLabelAlignment, SH_PrintDialog_RightAlignButtons, SH_MainWindow_SpaceBelowMenuBar, SH_FontDialog_SelectAssociatedText, SH_PopupMenu_AllowActiveAndDisabled, SH_PopupMenu_SpaceActivatesItem, SH_PopupMenu_SubMenuPopupDelay, SH_ScrollView_FrameOnlyAroundContents, SH_MenuBar_AltKeyNavigation, SH_ComboBox_ListMouseTracking, SH_PopupMenu_MouseTracking, SH_MenuBar_MouseTracking, SH_ItemView_ChangeHighlightOnFocus, SH_Widget_ShareActivation, SH_Workspace_FillSpaceOnMaximize, SH_ComboBox_Popup, SH_TitleBar_NoBorder, SH_ScrollBar_StopMouseOverSlider, SH_BlinkCursorWhenTextSelected, SH_RichText_FullWidthSelection, SH_PopupMenu_Scrollable, SH_GroupBox_TextLabelVerticalAlignment, SH_GroupBox_TextLabelColor, SH_PopupMenu_SloppySubMenus, SH_Table_GridLineColor, SH_LineEdit_PasswordCharacter, SH_DialogButtons_DefaultButton, SH_ToolBox_SelectedPageTitleBold, SH_TabBar_PreferNoArrows, SH_ScrollBar_LeftClickAbsolutePosition, SH_ListViewExpand_SelectMouseType, SH_UnderlineAccelerator, SH_ToolButton_Uses3D, SH_CustomBase = 0xf0000000 }" +.br +.ti -1c +.BI "virtual int \fBstyleHint\fR ( StyleHint stylehint, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default, QStyleHintReturn * returnData = 0 ) const = 0" +.br +.ti -1c +.BI "enum \fBStylePixmap\fR { SP_TitleBarMinButton, SP_TitleBarMaxButton, SP_TitleBarCloseButton, SP_TitleBarNormalButton, SP_TitleBarShadeButton, SP_TitleBarUnshadeButton, SP_DockWindowCloseButton, SP_MessageBoxInformation, SP_MessageBoxWarning, SP_MessageBoxCritical, SP_MessageBoxQuestion, SP_CustomBase = 0xf0000000 }" +.br +.ti -1c +.BI "virtual QPixmap \fBstylePixmap\fR ( StylePixmap stylepixmap, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default ) const = 0" +.br +.ti -1c +.BI "int defaultFrameWidth () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void tabbarMetrics ( const QWidget * t, int & hf, int & vf, int & ov ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QSize scrollBarExtent () const \fI(obsolete)\fR" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QRect \fBvisualRect\fR ( const QRect & logical, const QWidget * w )" +.br +.ti -1c +.BI "QRect \fBvisualRect\fR ( const QRect & logical, const QRect & bounding )" +.br +.in -1c +.SH DESCRIPTION +The QStyle class specifies the look and feel of a GUI. +.PP +A large number of GUI elements are common to many widgets. The QStyle class allows the look of these elements to be modified across all widgets that use the QStyle functions. It also provides two feel options: Motif and Windows. +.PP +Although it is not possible to fully enumerate the look of graphical elements and the feel of widgets in a GUI, QStyle provides a considerable amount of control and customisability. +.PP +In Qt 1.x the look and feel option for widgets was specified by a single value: the GUIStyle. Starting with Qt 2.0, this notion was expanded to allow the look to be specified by virtual drawing functions. +.PP +Derived classes may reimplement some or all of the drawing functions to modify the look of all widgets that use those functions. +.PP +Languages written from right to left (such as Arabic and Hebrew) usually also mirror the whole layout of widgets. If you design a style, you should take special care when drawing asymmetric elements to make sure that they also look correct in a mirrored layout. You can start your application with \fC-reverse\fR to check the mirrored layout. Also notice, that for a reversed layout, the light usually comes from top right instead of top left. +.PP +The actual reverse layout is performed automatically when possible. However, for the sake of flexibility, the translation cannot be performed everywhere. The documentation for each function in the QStyle API states whether the function expects/returns logical or screen coordinates. Using logical coordinates (in ComplexControls, for example) provides great flexibility in controlling the look of a widget. Use visualRect() when necessary to translate logical coordinates into screen coordinates for drawing. +.PP +In Qt versions prior to 3.0, if you wanted a low level route into changing the appearance of a widget, you would reimplement polish(). With the new 3.0 style engine the recommended approach is to reimplement the draw functions, for example drawItem(), drawPrimitive(), drawControl(), drawControlMask(), drawComplexControl() and drawComplexControlMask(). Each of these functions is called with a range of parameters that provide information that you can use to determine how to draw them, e.g. style flags, rectangle, color group, etc. +.PP +For information on changing elements of an existing style or creating your own style see the Style overview. +.PP +Styles can also be created as plugins. +.PP +See also Widget Appearance and Style. +.SS "Member Type Documentation" +.SH "QStyle::ComplexControl" +This enum represents a ComplexControl. ComplexControls have different behaviour depending upon where the user clicks on them or which keys are pressed. +.TP +\fCQStyle::CC_SpinWidget\fR +.TP +\fCQStyle::CC_ComboBox\fR +.TP +\fCQStyle::CC_ScrollBar\fR +.TP +\fCQStyle::CC_Slider\fR +.TP +\fCQStyle::CC_ToolButton\fR +.TP +\fCQStyle::CC_TitleBar\fR +.TP +\fCQStyle::CC_ListView\fR +.TP +\fCQStyle::CC_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. +.PP +See also SubControl and drawComplexControl(). +.SH "QStyle::ContentsType" +This enum represents a ContentsType. It is used to calculate sizes for the contents of various widgets. +.TP +\fCQStyle::CT_PushButton\fR +.TP +\fCQStyle::CT_CheckBox\fR +.TP +\fCQStyle::CT_RadioButton\fR +.TP +\fCQStyle::CT_ToolButton\fR +.TP +\fCQStyle::CT_ComboBox\fR +.TP +\fCQStyle::CT_Splitter\fR +.TP +\fCQStyle::CT_DockWindow\fR +.TP +\fCQStyle::CT_ProgressBar\fR +.TP +\fCQStyle::CT_PopupMenuItem\fR +.TP +\fCQStyle::CT_TabBarTab\fR +.TP +\fCQStyle::CT_Slider\fR +.TP +\fCQStyle::CT_Header\fR +.TP +\fCQStyle::CT_LineEdit\fR +.TP +\fCQStyle::CT_MenuBar\fR +.TP +\fCQStyle::CT_SpinBox\fR +.TP +\fCQStyle::CT_SizeGrip\fR +.TP +\fCQStyle::CT_TabWidget\fR +.TP +\fCQStyle::CT_DialogButtons\fR +.TP +\fCQStyle::CT_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Custom values must be greater than this value. +.PP +See also sizeFromContents(). +.SH "QStyle::ControlElement" +This enum represents a ControlElement. A ControlElement is part of a widget that performs some action or displays information to the user. +.TP +\fCQStyle::CE_PushButton\fR - the bevel and default indicator of a QPushButton. +.TP +\fCQStyle::CE_PushButtonLabel\fR - the label (iconset with text or pixmap) of a QPushButton. +.TP +\fCQStyle::CE_CheckBox\fR - the indicator of a QCheckBox. +.TP +\fCQStyle::CE_CheckBoxLabel\fR - the label (text or pixmap) of a QCheckBox. +.TP +\fCQStyle::CE_RadioButton\fR - the indicator of a QRadioButton. +.TP +\fCQStyle::CE_RadioButtonLabel\fR - the label (text or pixmap) of a QRadioButton. +.TP +\fCQStyle::CE_TabBarTab\fR - the tab within a QTabBar (a QTab). +.TP +\fCQStyle::CE_TabBarLabel\fR - the label within a QTab. +.TP +\fCQStyle::CE_ProgressBarGroove\fR - the groove where the progress indicator is drawn in a QProgressBar. +.TP +\fCQStyle::CE_ProgressBarContents\fR - the progress indicator of a QProgressBar. +.TP +\fCQStyle::CE_ProgressBarLabel\fR - the text label of a QProgressBar. +.TP +\fCQStyle::CE_PopupMenuItem\fR - a menu item in a QPopupMenu. +.TP +\fCQStyle::CE_PopupMenuScroller\fR - scrolling areas in a popumenu when the style supports scrolling. +.TP +\fCQStyle::CE_PopupMenuHorizontalExtra\fR - extra frame area set aside with PM_PopupMenuFrameHorizontalExtra +.TP +\fCQStyle::CE_PopupMenuVerticalExtra\fR - extra frame area set aside with PM_PopupMenuFrameVerticalExtra +.TP +\fCQStyle::CE_MenuBarItem\fR - a menu item in a QMenuBar. +.TP +\fCQStyle::CE_ToolButtonLabel\fR - a tool button's label. +.TP +\fCQStyle::CE_MenuBarEmptyArea\fR - the empty area of a QMenuBar. +.TP +\fCQStyle::CE_DockWindowEmptyArea\fR - the empty area of a QDockWindow. +.TP +\fCQStyle::CE_ToolBoxTab\fR - the toolbox's tab area +.TP +\fCQStyle::CE_HeaderLabel\fR - the header's label +.TP +\fCQStyle::CE_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. +.PP +See also drawControl(). +.SH "QStyle::PixelMetric" +This enum represents a PixelMetric. A PixelMetric is a style dependent size represented as a single pixel value. +.TP +\fCQStyle::PM_ButtonMargin\fR - amount of whitespace between pushbutton labels and the frame. +.TP +\fCQStyle::PM_ButtonDefaultIndicator\fR - width of the default-button indicator frame. +.TP +\fCQStyle::PM_MenuButtonIndicator\fR - width of the menu button indicator proportional to the widget height. +.TP +\fCQStyle::PM_ButtonShiftHorizontal\fR - horizontal contents shift of a button when the button is down. +.TP +\fCQStyle::PM_ButtonShiftVertical\fR - vertical contents shift of a button when the button is down. +.TP +\fCQStyle::PM_DefaultFrameWidth\fR - default frame width, usually 2. +.TP +\fCQStyle::PM_SpinBoxFrameWidth\fR - frame width of a spin box. +.TP +\fCQStyle::PM_MDIFrameWidth\fR - frame width of an MDI window. +.TP +\fCQStyle::PM_MDIMinimizedWidth\fR - width of a minimized MSI window. +.TP +\fCQStyle::PM_MaximumDragDistance\fR - Some feels require the scrollbar or other sliders to jump back to the original position when the mouse pointer is too far away while dragging. A value of -1 disables this behavior. +.TP +\fCQStyle::PM_ScrollBarExtent\fR - width of a vertical scrollbar and the height of a horizontal scrollbar. +.TP +\fCQStyle::PM_ScrollBarSliderMin\fR - the minimum height of a vertical scrollbar's slider and the minimum width of a horiztonal scrollbar slider. +.TP +\fCQStyle::PM_SliderThickness\fR - total slider thickness. +.TP +\fCQStyle::PM_SliderControlThickness\fR - thickness of the slider handle. +.TP +\fCQStyle::PM_SliderLength\fR - length of the slider. +.TP +\fCQStyle::PM_SliderTickmarkOffset\fR - the offset between the tickmarks and the slider. +.TP +\fCQStyle::PM_SliderSpaceAvailable\fR - the available space for the slider to move. +.TP +\fCQStyle::PM_DockWindowSeparatorExtent\fR - width of a separator in a horiztonal dock window and the height of a separator in a vertical dock window. +.TP +\fCQStyle::PM_DockWindowHandleExtent\fR - width of the handle in a horizontal dock window and the height of the handle in a vertical dock window. +.TP +\fCQStyle::PM_DockWindowFrameWidth\fR - frame width of a dock window. +.TP +\fCQStyle::PM_MenuBarFrameWidth\fR - frame width of a menubar. +.TP +\fCQStyle::PM_MenuBarItemSpacing\fR - spacing between menubar items. +.TP +\fCQStyle::PM_ToolBarItemSpacing\fR - spacing between toolbar items. +.TP +\fCQStyle::PM_TabBarTabOverlap\fR - number of pixels the tabs should overlap. +.TP +\fCQStyle::PM_TabBarTabHSpace\fR - extra space added to the tab width. +.TP +\fCQStyle::PM_TabBarTabVSpace\fR - extra space added to the tab height. +.TP +\fCQStyle::PM_TabBarBaseHeight\fR - height of the area between the tab bar and the tab pages. +.TP +\fCQStyle::PM_TabBarBaseOverlap\fR - number of pixels the tab bar overlaps the tab bar base. +.TP +\fCQStyle::PM_TabBarScrollButtonWidth\fR +.TP +\fCQStyle::PM_TabBarTabShiftHorizontal\fR - horizontal pixel shift when a tab is selected. +.TP +\fCQStyle::PM_TabBarTabShiftVertical\fR - vertical pixel shift when a tab is selected. +.TP +\fCQStyle::PM_ProgressBarChunkWidth\fR - width of a chunk in a progress bar indicator. +.TP +\fCQStyle::PM_SplitterWidth\fR - width of a splitter. +.TP +\fCQStyle::PM_TitleBarHeight\fR - height of the title bar. +.TP +\fCQStyle::PM_PopupMenuFrameHorizontalExtra\fR - additional border, e.g. for panels +.TP +\fCQStyle::PM_PopupMenuFrameVerticalExtra\fR - additional border, e.g. for panels +.TP +\fCQStyle::PM_IndicatorWidth\fR - width of a check box indicator. +.TP +\fCQStyle::PM_IndicatorHeight\fR - height of a checkbox indicator. +.TP +\fCQStyle::PM_ExclusiveIndicatorWidth\fR - width of a radio button indicator. +.TP +\fCQStyle::PM_ExclusiveIndicatorHeight\fR - height of a radio button indicator. +.TP +\fCQStyle::PM_PopupMenuScrollerHeight\fR - height of the scroller area in a popupmenu. +.TP +\fCQStyle::PM_PopupMenuScrollerHeight\fR - height of the scroller area in a popupmenu. +.TP +\fCQStyle::PM_CheckListButtonSize\fR - area (width/height) of the checkbox/radiobutton in a QCheckListItem +.TP +\fCQStyle::PM_CheckListControllerSize\fR - area (width/height) of the controller in a QCheckListItem +.TP +\fCQStyle::PM_DialogButtonsSeparator\fR - distance between buttons in a dialog buttons widget. +.TP +\fCQStyle::PM_DialogButtonsButtonWidth\fR - minimum width of a button in a dialog buttons widget. +.TP +\fCQStyle::PM_DialogButtonsButtonHeight\fR - minimum height of a button in a dialog buttons widget. +.TP +\fCQStyle::PM_HeaderMarkSize\fR +.TP +\fCQStyle::PM_HeaderGripMargin\fR +.TP +\fCQStyle::PM_HeaderMargin\fR +.TP +\fCQStyle::PM_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. +.PP +See also pixelMetric(). +.SH "QStyle::PrimitiveElement" +This enum represents the PrimitiveElements of a style. A PrimitiveElement is a common GUI element, such as a checkbox indicator or pushbutton bevel. +.TP +\fCQStyle::PE_ButtonCommand\fR - button used to initiate an action, for example, a QPushButton. +.TP +\fCQStyle::PE_ButtonDefault\fR - this button is the default button, e.g. in a dialog. +.TP +\fCQStyle::PE_ButtonBevel\fR - generic button bevel. +.TP +\fCQStyle::PE_ButtonTool\fR - tool button, for example, a QToolButton. +.TP +\fCQStyle::PE_ButtonDropDown\fR - drop down button, for example, a tool button that displays a popup menu, for example, QPopupMenu. +.TP +\fCQStyle::PE_FocusRect\fR - generic focus indicator. +.TP +\fCQStyle::PE_ArrowUp\fR - up arrow. +.TP +\fCQStyle::PE_ArrowDown\fR - down arrow. +.TP +\fCQStyle::PE_ArrowRight\fR - right arrow. +.TP +\fCQStyle::PE_ArrowLeft\fR - left arrow. +.TP +\fCQStyle::PE_SpinWidgetUp\fR - up symbol for a spin widget, for example a QSpinBox. +.TP +\fCQStyle::PE_SpinWidgetDown\fR - down symbol for a spin widget. +.TP +\fCQStyle::PE_SpinWidgetPlus\fR - increase symbol for a spin widget. +.TP +\fCQStyle::PE_SpinWidgetMinus\fR - decrease symbol for a spin widget. +.TP +\fCQStyle::PE_Indicator\fR - on/off indicator, for example, a QCheckBox. +.TP +\fCQStyle::PE_IndicatorMask\fR - bitmap mask for an indicator. +.TP +\fCQStyle::PE_ExclusiveIndicator\fR - exclusive on/off indicator, for example, a QRadioButton. +.TP +\fCQStyle::PE_ExclusiveIndicatorMask\fR - bitmap mask for an exclusive indicator. +.TP +\fCQStyle::PE_DockWindowHandle\fR - tear off handle for dock windows and toolbars, for example QDockWindows and QToolBars. +.TP +\fCQStyle::PE_DockWindowSeparator\fR - item separator for dock window and toolbar contents. +.TP +\fCQStyle::PE_DockWindowResizeHandle\fR - resize handle for dock windows. +.TP +\fCQStyle::PE_Splitter\fR - splitter handle; see also QSplitter. +.TP +\fCQStyle::PE_Panel\fR - generic panel frame; see also QFrame. +.TP +\fCQStyle::PE_PanelPopup\fR - panel frame for popup windows/menus; see also QPopupMenu. +.TP +\fCQStyle::PE_PanelMenuBar\fR - panel frame for menu bars. +.TP +\fCQStyle::PE_PanelDockWindow\fR - panel frame for dock windows and toolbars. +.TP +\fCQStyle::PE_PanelTabWidget\fR - panel frame for tab widgets. +.TP +\fCQStyle::PE_PanelLineEdit\fR - panel frame for line edits. +.TP +\fCQStyle::PE_PanelGroupBox\fR - panel frame for group boxes. +.TP +\fCQStyle::PE_TabBarBase\fR - area below tabs in a tab widget, for example, QTab. +.TP +\fCQStyle::PE_HeaderSection\fR - section of a list or table header; see also QHeader. +.TP +\fCQStyle::PE_HeaderArrow\fR - arrow used to indicate sorting on a list or table header +.TP +\fCQStyle::PE_StatusBarSection\fR - section of a status bar; see also QStatusBar. +.TP +\fCQStyle::PE_GroupBoxFrame\fR - frame around a group box; see also QGroupBox. +.TP +\fCQStyle::PE_WindowFrame\fR - frame around a MDI window or a docking window +.TP +\fCQStyle::PE_Separator\fR - generic separator. +.TP +\fCQStyle::PE_SizeGrip\fR - window resize handle; see also QSizeGrip. +.TP +\fCQStyle::PE_CheckMark\fR - generic check mark; see also QCheckBox. +.TP +\fCQStyle::PE_ScrollBarAddLine\fR - scrollbar line increase indicator (i.e. scroll down); see also QScrollBar. +.TP +\fCQStyle::PE_ScrollBarSubLine\fR - scrollbar line decrease indicator (i.e. scroll up). +.TP +\fCQStyle::PE_ScrollBarAddPage\fR - scolllbar page increase indicator (i.e. page down). +.TP +\fCQStyle::PE_ScrollBarSubPage\fR - scrollbar page decrease indicator (i.e. page up). +.TP +\fCQStyle::PE_ScrollBarSlider\fR - scrollbar slider +.TP +\fCQStyle::PE_ScrollBarFirst\fR - scrollbar first line indicator (i.e. home). +.TP +\fCQStyle::PE_ScrollBarLast\fR - scrollbar last line indicator (i.e. end). +.TP +\fCQStyle::PE_ProgressBarChunk\fR - section of a progress bar indicator; see also QProgressBar. +.TP +\fCQStyle::PE_CheckListController\fR - controller part of a listview item +.TP +\fCQStyle::PE_CheckListIndicator\fR - checkbox part of a listview item +.TP +\fCQStyle::PE_CheckListExclusiveIndicator\fR - radiobutton part of a listview item +.TP +\fCQStyle::PE_RubberBand\fR - rubber band used in such things as iconview +.TP +\fCQStyle::PE_CustomBase\fR - base value for custom PrimitiveElements. All values above this are reserved for custom use. Custom values must be greater than this value. +.PP +See also drawPrimitive(). +.SH "QStyle::StyleFlags" +This enum represents flags for drawing PrimitiveElements. Not all primitives use all of these flags. Note that these flags may mean different things to different primitives. For an explanation of the relationship between primitives and their flags, as well as the different meanings of the flags, see the Style overview. +.TP +\fCQStyle::Style_Default\fR +.TP +\fCQStyle::Style_Enabled\fR +.TP +\fCQStyle::Style_Raised\fR +.TP +\fCQStyle::Style_Sunken\fR +.TP +\fCQStyle::Style_Off\fR +.TP +\fCQStyle::Style_NoChange\fR +.TP +\fCQStyle::Style_On\fR +.TP +\fCQStyle::Style_Down\fR +.TP +\fCQStyle::Style_Horizontal\fR +.TP +\fCQStyle::Style_HasFocus\fR +.TP +\fCQStyle::Style_Top\fR +.TP +\fCQStyle::Style_Bottom\fR +.TP +\fCQStyle::Style_FocusAtBorder\fR +.TP +\fCQStyle::Style_AutoRaise\fR +.TP +\fCQStyle::Style_MouseOver\fR +.TP +\fCQStyle::Style_Up\fR +.TP +\fCQStyle::Style_Selected\fR +.TP +\fCQStyle::Style_HasFocus\fR +.TP +\fCQStyle::Style_Active\fR +.TP +\fCQStyle::Style_ButtonDefault\fR +.PP +See also drawPrimitive(). +.SH "QStyle::StyleHint" +This enum represents a StyleHint. A StyleHint is a general look and/or feel hint. +.TP +\fCQStyle::SH_EtchDisabledText\fR - disabled text is "etched" like Windows. +.TP +\fCQStyle::SH_GUIStyle\fR - the GUI style to use. +.TP +\fCQStyle::SH_ScrollBar_BackgroundMode\fR - the background mode for a QScrollBar. Possible values are any of those in the BackgroundMode enum. +.TP +\fCQStyle::SH_ScrollBar_MiddleClickAbsolutePosition\fR - a boolean value. If TRUE, middle clicking on a scrollbar causes the slider to jump to that position. If FALSE, the middle clicking is ignored. +.TP +\fCQStyle::SH_ScrollBar_LeftClickAbsolutePosition\fR - a boolean value. If TRUE, left clicking on a scrollbar causes the slider to jump to that position. If FALSE, the left clicking will behave as appropriate for each control. +.TP +\fCQStyle::SH_ScrollBar_ScrollWhenPointerLeavesControl\fR - a boolean value. If TRUE, when clicking a scrollbar SubControl, holding the mouse button down and moving the pointer outside the SubControl, the scrollbar continues to scroll. If FALSE, the scollbar stops scrolling when the pointer leaves the SubControl. +.TP +\fCQStyle::SH_TabBar_Alignment\fR - the alignment for tabs in a QTabWidget. Possible values are Qt::AlignLeft, Qt::AlignCenter and Qt::AlignRight. +.TP +\fCQStyle::SH_Header_ArrowAlignment\fR - the placement of the sorting indicator may appear in list or table headers. Possible values are Qt::Left or Qt::Right. +.TP +\fCQStyle::SH_Slider_SnapToValue\fR - sliders snap to values while moving, like Windows +.TP +\fCQStyle::SH_Slider_SloppyKeyEvents\fR - key presses handled in a sloppy manner, i.e. left on a vertical slider subtracts a line. +.TP +\fCQStyle::SH_ProgressDialog_CenterCancelButton\fR - center button on progress dialogs, like Motif, otherwise right aligned. +.TP +\fCQStyle::SH_ProgressDialog_TextLabelAlignment\fR - Qt::AlignmentFlags -- text label alignment in progress dialogs; Center on windows, Auto|VCenter otherwise. +.TP +\fCQStyle::SH_PrintDialog_RightAlignButtons\fR - right align buttons in the print dialog, like Windows. +.TP +\fCQStyle::SH_MainWindow_SpaceBelowMenuBar\fR - 1 or 2 pixel space between the menubar and the dockarea, like Windows. +.TP +\fCQStyle::SH_FontDialog_SelectAssociatedText\fR - select the text in the line edit, or when selecting an item from the listbox, or when the line edit receives focus, like Windows. +.TP +\fCQStyle::SH_PopupMenu_AllowActiveAndDisabled\fR - allows disabled menu items to be active. +.TP +\fCQStyle::SH_PopupMenu_SpaceActivatesItem\fR - pressing Space activates the item, like Motif. +.TP +\fCQStyle::SH_PopupMenu_SubMenuPopupDelay\fR - the number of milliseconds to wait before opening a submenu; 256 on windows, 96 on Motif. +.TP +\fCQStyle::SH_PopupMenu_Scrollable\fR - whether popupmenu's must support scrolling. +.TP +\fCQStyle::SH_PopupMenu_SloppySubMenus\fR - whether popupmenu's must support sloppy submenu; as implemented on Mac OS. +.TP +\fCQStyle::SH_ScrollView_FrameOnlyAroundContents\fR - whether scrollviews draw their frame only around contents (like Motif), or around contents, scrollbars and corner widgets (like Windows). +.TP +\fCQStyle::SH_MenuBar_AltKeyNavigation\fR - menubars items are navigable by pressing Alt, followed by using the arrow keys to select the desired item. +.TP +\fCQStyle::SH_ComboBox_ListMouseTracking\fR - mouse tracking in combobox dropdown lists. +.TP +\fCQStyle::SH_PopupMenu_MouseTracking\fR - mouse tracking in popup menus. +.TP +\fCQStyle::SH_MenuBar_MouseTracking\fR - mouse tracking in menubars. +.TP +\fCQStyle::SH_ItemView_ChangeHighlightOnFocus\fR - gray out selected items when losing focus. +.TP +\fCQStyle::SH_Widget_ShareActivation\fR - turn on sharing activation with floating modeless dialogs. +.TP +\fCQStyle::SH_TabBar_SelectMouseType\fR - which type of mouse event should cause a tab to be selected. +.TP +\fCQStyle::SH_ListViewExpand_SelectMouseType\fR - which type of mouse event should cause a listview expansion to be selected. +.TP +\fCQStyle::SH_TabBar_PreferNoArrows\fR - whether a tabbar should suggest a size to prevent scoll arrows. +.TP +\fCQStyle::SH_ComboBox_Popup\fR - allows popups as a combobox dropdown menu. +.TP +\fCQStyle::SH_Workspace_FillSpaceOnMaximize\fR - the workspace should maximize the client area. +.TP +\fCQStyle::SH_TitleBar_NoBorder\fR - the titlebar has no border +.TP +\fCQStyle::SH_ScrollBar_StopMouseOverSlider\fR - stops autorepeat when slider reaches mouse +.TP +\fCQStyle::SH_BlinkCursorWhenTextSelected\fR - whether cursor should blink when text is selected +.TP +\fCQStyle::SH_RichText_FullWidthSelection\fR - whether richtext selections should extend the full width of the document. +.TP +\fCQStyle::SH_GroupBox_TextLabelVerticalAlignment\fR - how to vertically align a groupbox's text label. +.TP +\fCQStyle::SH_GroupBox_TextLabelColor\fR - how to paint a groupbox's text label. +.TP +\fCQStyle::SH_DialogButtons_DefaultButton\fR - which buttons gets the default status in a dialog's button widget. +.TP +\fCQStyle::SH_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. +.TP +\fCQStyle::SH_ToolButton_Uses3D\fR - indicates whether QToolButtons should use a 3D frame when the mouse is over them +.TP +\fCQStyle::SH_ToolBox_SelectedPageTitleBold\fR - Boldness of the selected page title in a QToolBox. +.TP +\fCQStyle::SH_LineEdit_PasswordCharacter\fR - The QChar Unicode character to be used for passwords. +.TP +\fCQStyle::SH_Table_GridLineColor\fR +.TP +\fCQStyle::SH_UnderlineAccelerator\fR - whether accelerators are underlined +.PP +See also styleHint(). +.SH "QStyle::StylePixmap" +This enum represents a StylePixmap. A StylePixmap is a pixmap that can follow some existing GUI style or guideline. +.TP +\fCQStyle::SP_TitleBarMinButton\fR - minimize button on titlebars. For example, in a QWorkspace. +.TP +\fCQStyle::SP_TitleBarMaxButton\fR - maximize button on titlebars. +.TP +\fCQStyle::SP_TitleBarCloseButton\fR - close button on titlebars. +.TP +\fCQStyle::SP_TitleBarNormalButton\fR - normal (restore) button on titlebars. +.TP +\fCQStyle::SP_TitleBarShadeButton\fR - shade button on titlebars. +.TP +\fCQStyle::SP_TitleBarUnshadeButton\fR - unshade button on titlebars. +.TP +\fCQStyle::SP_MessageBoxInformation\fR - the 'information' icon. +.TP +\fCQStyle::SP_MessageBoxWarning\fR - the 'warning' icon. +.TP +\fCQStyle::SP_MessageBoxCritical\fR - the 'critical' icon. +.TP +\fCQStyle::SP_MessageBoxQuestion\fR - the 'question' icon. +.TP +\fCQStyle::SP_DockWindowCloseButton\fR - close button on dock windows; see also QDockWindow. +.TP +\fCQStyle::SP_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. +.PP +See also stylePixmap(). +.SH "QStyle::SubControl" +This enum represents a SubControl within a ComplexControl. +.TP +\fCQStyle::SC_None\fR - special value that matches no other SubControl. +.TP +\fCQStyle::SC_ScrollBarAddLine\fR - scrollbar add line (i.e. down/right arrow); see also QScrollbar. +.TP +\fCQStyle::SC_ScrollBarSubLine\fR - scrollbar sub line (i.e. up/left arrow). +.TP +\fCQStyle::SC_ScrollBarAddPage\fR - scrollbar add page (i.e. page down). +.TP +\fCQStyle::SC_ScrollBarSubPage\fR - scrollbar sub page (i.e. page up). +.TP +\fCQStyle::SC_ScrollBarFirst\fR - scrollbar first line (i.e. home). +.TP +\fCQStyle::SC_ScrollBarLast\fR - scrollbar last line (i.e. end). +.TP +\fCQStyle::SC_ScrollBarSlider\fR - scrollbar slider handle. +.TP +\fCQStyle::SC_ScrollBarGroove\fR - special subcontrol which contains the area in which the slider handle may move. +.TP +\fCQStyle::SC_SpinWidgetUp\fR - spinwidget up/increase; see also QSpinBox. +.TP +\fCQStyle::SC_SpinWidgetDown\fR - spinwidget down/decrease. +.TP +\fCQStyle::SC_SpinWidgetFrame\fR - spinwidget frame. +.TP +\fCQStyle::SC_SpinWidgetEditField\fR - spinwidget edit field. +.TP +\fCQStyle::SC_SpinWidgetButtonField\fR - spinwidget button field. +.TP +\fCQStyle::SC_ComboBoxEditField\fR - combobox edit field; see also QComboBox. +.TP +\fCQStyle::SC_ComboBoxArrow\fR - combobox arrow +.TP +\fCQStyle::SC_ComboBoxFrame\fR - combobox frame +.TP +\fCQStyle::SC_ComboBoxListBoxPopup\fR - combobox list box +.TP +\fCQStyle::SC_SliderGroove\fR - special subcontrol which contains the area in which the slider handle may move. +.TP +\fCQStyle::SC_SliderHandle\fR - slider handle. +.TP +\fCQStyle::SC_SliderTickmarks\fR - slider tickmarks. +.TP +\fCQStyle::SC_ToolButton\fR - tool button; see also QToolbutton. +.TP +\fCQStyle::SC_ToolButtonMenu\fR - subcontrol for opening a popup menu in a tool button; see also QPopupMenu. +.TP +\fCQStyle::SC_TitleBarSysMenu\fR - system menu button (i.e. restore, close, etc.). +.TP +\fCQStyle::SC_TitleBarMinButton\fR - minimize button. +.TP +\fCQStyle::SC_TitleBarMaxButton\fR - maximize button. +.TP +\fCQStyle::SC_TitleBarCloseButton\fR - close button. +.TP +\fCQStyle::SC_TitleBarLabel\fR - window title label. +.TP +\fCQStyle::SC_TitleBarNormalButton\fR - normal (restore) button. +.TP +\fCQStyle::SC_TitleBarShadeButton\fR - shade button. +.TP +\fCQStyle::SC_TitleBarUnshadeButton\fR - unshade button. +.TP +\fCQStyle::SC_ListView\fR - the list view area. +.TP +\fCQStyle::SC_ListViewBranch\fR - (internal) +.TP +\fCQStyle::SC_ListViewExpand\fR - expand item (i.e. show/hide child items). +.TP +\fCQStyle::SC_All\fR - special value that matches all SubControls. +.PP +See also ComplexControl. +.SH "QStyle::SubRect" +This enum represents a sub-area of a widget. Style implementations would use these areas to draw the different parts of a widget. +.TP +\fCQStyle::SR_PushButtonContents\fR - area containing the label (iconset with text or pixmap). +.TP +\fCQStyle::SR_PushButtonFocusRect\fR - area for the focus rect (usually larger than the contents rect). +.TP +\fCQStyle::SR_CheckBoxIndicator\fR - area for the state indicator (e.g. check mark). +.TP +\fCQStyle::SR_CheckBoxContents\fR - area for the label (text or pixmap). +.TP +\fCQStyle::SR_CheckBoxFocusRect\fR - area for the focus indicator. +.TP +\fCQStyle::SR_RadioButtonIndicator\fR - area for the state indicator. +.TP +\fCQStyle::SR_RadioButtonContents\fR - area for the label. +.TP +\fCQStyle::SR_RadioButtonFocusRect\fR - area for the focus indicator. +.TP +\fCQStyle::SR_ComboBoxFocusRect\fR - area for the focus indicator. +.TP +\fCQStyle::SR_SliderFocusRect\fR - area for the focus indicator. +.TP +\fCQStyle::SR_DockWindowHandleRect\fR - area for the tear-off handle. +.TP +\fCQStyle::SR_ProgressBarGroove\fR - area for the groove. +.TP +\fCQStyle::SR_ProgressBarContents\fR - area for the progress indicator. +.TP +\fCQStyle::SR_ProgressBarLabel\fR - area for the text label. +.TP +\fCQStyle::SR_ToolButtonContents\fR - area for the tool button's label. +.TP +\fCQStyle::SR_DialogButtonAccept\fR - area for a dialog's accept button. +.TP +\fCQStyle::SR_DialogButtonReject\fR - area for a dialog's reject button. +.TP +\fCQStyle::SR_DialogButtonApply\fR - area for a dialog's apply button. +.TP +\fCQStyle::SR_DialogButtonHelp\fR - area for a dialog's help button. +.TP +\fCQStyle::SR_DialogButtonAll\fR - area for a dialog's all button. +.TP +\fCQStyle::SR_DialogButtonRetry\fR - area for a dialog's retry button. +.TP +\fCQStyle::SR_DialogButtonAbort\fR - area for a dialog's abort button. +.TP +\fCQStyle::SR_DialogButtonIgnore\fR - area for a dialog's ignore button. +.TP +\fCQStyle::SR_DialogButtonCustom\fR - area for a dialog's custom widget area (in button row). +.TP +\fCQStyle::SR_ToolBoxTabContents\fR - area for a toolbox tab's icon and label +.TP +\fCQStyle::SR_CustomBase\fR - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value. +.PP +See also subRect(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStyle::QStyle ()" +Constructs a QStyle. +.SH "QStyle::~QStyle ()\fC [virtual]\fR" +Destroys the style and frees all allocated resources. +.SH "int QStyle::defaultFrameWidth () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QStyle::drawComplexControl ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, SCFlags sub = SC_All, SCFlags subActive = SC_None, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Draws the ComplexControl \fIcontrol\fR using the painter \fIp\fR in the area \fIr\fR. Colors are used from the color group \fIcg\fR. The \fIsub\fR argument specifies which SubControls to draw. Multiple SubControls can be OR'ed together. The \fIsubActive\fR argument specifies which SubControl is active. +.PP +The rect \fIr\fR should be in logical coordinates. Reimplementations of this function should use visualRect() to change the logical coordinates into screen coordinates when using drawPrimitive() and drawControl(). +.PP +The \fIhow\fR argument is used to control how the ComplexControl is drawn. Multiple flags can OR'ed together. See the table below for an explanation of which flags are used with the various ComplexControls. +.PP +The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontrol\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ComplexControl. Note that \fIopt\fR may be the default value even for ComplexControls that can make use of the extra options. See the table below for the appropriate \fIwidget\fR and \fIopt\fR usage: +.PP +<center>.nf +.TS +l - l. ComplexControl +.br +& Widget Cast Style Flags Notes Options Notes CC_SpinWidget(const QSpinWidget *) Style_Enabled Set if the spinwidget is enabled. Unused. Style_HasFocus Set if the spinwidget has input focus. CC_ComboBox(const QComboBox *) Style_Enabled Set if the combobox is enabled. Unused. Style_HasFocus Set if the combobox has input focus. CC_ScrollBar(const QScrollBar *) Style_Enabled Set if the scrollbar is enabled. Unused. Style_HasFocus Set if the scrollbar has input focus. CC_Slider(const QSlider *) Style_Enabled Set if the slider is enabled. Unused. Style_HasFocus Set if the slider has input focus. CC_ToolButton(const QToolButton *) Style_Enabled Set if the toolbutton is enabled. QStyleOption ( ArrowType t ) +.TP +opt.arrowType() When the tool button only contains an arrow, \fIt\fR is the arrow's type. Style_HasFocus Set if the toolbutton has input focus. Style_Down Set if the toolbutton is down (ie. mouse button or space pressed). Style_On Set if the toolbutton is a toggle button and is toggled on. Style_AutoRaise Set if the toolbutton has auto-raise enabled. Style_Raised Set if the button is not down, not on and doesn't contain the mouse when auto-raise is enabled. CC_TitleBar(const QWidget *) Style_Enabled Set if the titlebar is enabled. Unused. CC_ListView(const QListView *) Style_Enabled Set if the titlebar is enabled. QStyleOption ( QListViewItem *item ) +.TP +opt.listViewItem() +.TE +.fi +</center> +.PP +See also ComplexControl and SubControl. +.SH "void QStyle::drawComplexControlMask ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Draw a bitmask for the ComplexControl \fIcontrol\fR using the painter \fIp\fR in the area \fIr\fR. See drawComplexControl() for an explanation of the use of the \fIwidget\fR and \fIopt\fR arguments. +.PP +The rect \fIr\fR should be in logical coordinates. Reimplementations of this function should use visualRect() to change the logical corrdinates into screen coordinates when using drawPrimitive() and drawControl(). +.PP +See also drawComplexControl() and ComplexControl. +.SH "void QStyle::drawControl ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Draws the ControlElement \fIelement\fR using the painter \fIp\fR in the area \fIr\fR. Colors are used from the color group \fIcg\fR. +.PP +The rect \fIr\fR should be in screen coordinates. +.PP +The \fIhow\fR argument is used to control how the ControlElement is drawn. Multiple flags can be OR'ed together. See the table below for an explanation of which flags are used with the various ControlElements. +.PP +The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIelement\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ControlElement. Note that \fIopt\fR may be the default value even for ControlElements that can make use of the extra options. See the table below for the appropriate \fIwidget\fR and \fIopt\fR usage: +.PP +<center>.nf +.TS +l - l. ControlElement +.br +& Widget Cast Style Flags Notes Options Notes CE_PushButton(const QPushButton *) +.PP +and +.PP +CE_PushButtonLabel(const QPushButton *) Style_Enabled Set if the button is enabled. Unused. Style_HasFocus Set if the button has input focus. Style_Raised Set if the button is not down, not on and not flat. Style_On Set if the button is a toggle button and toggled on. Style_Down Set if the button is down (i.e., the mouse button or space bar is pressed on the button). Style_ButtonDefault Set if the button is a default button. CE_CheckBox(const QCheckBox *) +.PP +and +.PP +CE_CheckBoxLabel(const QCheckBox *) +.PP Style_Enabled Set if the checkbox is enabled. Unused. +Style_HasFocus Set if the checkbox has input focus. Style_On Set if the checkbox is checked. Style_Off Set if the checkbox is not checked. Style_NoChange Set if the checkbox is in the NoChange state. Style_Down Set if the checkbox is down (i.e., the mouse button or space bar is pressed on the button). CE_RadioButton(const QRadioButton *) +.PP +and +.PP +CE_RadioButtonLabel(const QRadioButton *) Style_Enabled Set if the radiobutton is enabled. Unused. Style_HasFocus Set if the radiobutton has input focus. Style_On Set if the radiobutton is checked. Style_Off Set if the radiobutton is not checked. Style_Down Set if the radiobutton is down (i.e., the mouse button or space bar is pressed on the radiobutton). CE_TabBarTab(const QTabBar *) +.PP +and +.PP +CE_TabBarLabel(const QTabBar *) +.PP Style_Enabled Set if the tabbar and tab is enabled. QStyleOption ( QTab *t ) +.TP +opt.tab() \fIt\fR is the QTab being drawn. Style_Selected Set if the tab is the current tab. CE_ProgressBarGroove(const QProgressBar *) +.PP +and +.PP +CE_ProgressBarContents(const QProgressBar *) +.PP +and +.PP +CE_ProgressBarLabel(const QProgressBar *) +.PP Style_Enabled Set if the progressbar is enabled. Unused. +Style_HasFocus Set if the progressbar has input focus. CE_PopupMenuItem(const QPopupMenu *) Style_Enabled Set if the menuitem is enabled. QStyleOption ( QMenuItem *mi, int tabwidth, int maxpmwidth ) +.TP +opt.menuItem() +.TP +opt.tabWidth() +.TP +opt.maxIconWidth() \fImi\fR is the menu item being drawn. QMenuItem is currently an internal class. Style_Active Set if the menuitem is the current item. \fItabwidth\fR is the width of the tab column where key accelerators are drawn. Style_Down Set if the menuitem is down (i.e., the mouse button or space bar is pressed). \fImaxpmwidth\fR is the maximum width of the check column where checkmarks and iconsets are drawn. CE_MenuBarItem(const QMenuBar *) Style_Enabled Set if the menuitem is enabled QStyleOption ( QMenuItem *mi ) +.TP +opt.menuItem() \fImi\fR is the menu item being drawn. Style_Active Set if the menuitem is the current item. Style_Down Set if the menuitem is down (i.e., a mouse button or the space bar is pressed). Style_HasFocus Set if the menubar has input focus. CE_ToolButtonLabel(const QToolButton *) Style_Enabled Set if the toolbutton is enabled. QStyleOption ( ArrowType t ) +.TP +opt.arrowType() When the tool button only contains an arrow, \fIt\fR is the arrow's type. Style_HasFocus Set if the toolbutton has input focus. Style_Down Set if the toolbutton is down (i.e., a mouse button or the space is pressed). Style_On Set if the toolbutton is a toggle button and is toggled on. Style_AutoRaise Set if the toolbutton has auto-raise enabled. Style_MouseOver Set if the mouse pointer is over the toolbutton. Style_Raised +.TE +.fi +</center> +.PP +See also ControlElement and StyleFlags. +.SH "void QStyle::drawControlMask ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Draw a bitmask for the ControlElement \fIelement\fR using the painter \fIp\fR in the area \fIr\fR. See drawControl() for an explanation of the use of the \fIwidget\fR and \fIopt\fR arguments. +.PP +The rect \fIr\fR should be in screen coordinates. +.PP +See also drawControl() and ControlElement. +.SH "void QStyle::drawItem ( QPainter * p, const QRect & r, int flags, const QColorGroup & g, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1, const QColor * penColor = 0 ) const\fC [virtual]\fR" +Draws the \fItext\fR or \fIpixmap\fR in rectangle \fIr\fR using painter \fIp\fR and color group \fIg\fR. The pen color is specified with \fIpenColor\fR. The \fIenabled\fR bool indicates whether or not the item is enabled; when reimplementing this bool should influence how the item is drawn. If \fIlen\fR is -1 (the default) all the \fItext\fR is drawn; otherwise only the first \fIlen\fR characters of \fItext\fR are drawn. The text is aligned and wrapped according to the alignment \fIflags\fR (see Qt::AlignmentFlags). +.PP +By default, if both the text and the pixmap are not null, the pixmap is drawn and the text is ignored. +.SH "void QStyle::drawPrimitive ( PrimitiveElement pe, QPainter * p, const QRect & r, const QColorGroup & cg, SFlags flags = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Draws the style PrimitiveElement \fIpe\fR using the painter \fIp\fR in the area \fIr\fR. Colors are used from the color group \fIcg\fR. +.PP +The rect \fIr\fR should be in screen coordinates. +.PP +The \fIflags\fR argument is used to control how the PrimitiveElement is drawn. Multiple flags can be OR'ed together. +.PP +For example, a pressed button would be drawn with the flags Style_Enabled and Style_Down. +.PP +The \fIopt\fR argument can be used to control how various PrimitiveElements are drawn. Note that \fIopt\fR may be the default value even for PrimitiveElements that make use of extra options. When \fIopt\fR is non-default, it is used as follows: +.PP +<center>.nf +.TS +l - l. PrimitiveElement Options Notes PE_FocusRect QStyleOption ( const QColor & bg ) +.TP +opt.color() \fIbg\fR is the background color on which the focus rect is being drawn. PE_Panel QStyleOption ( int linewidth, int midlinewidth ) +.TP +opt.lineWidth() +.TP +opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_PanelPopup QStyleOption ( int linewidth, int midlinewidth ) +.TP +opt.lineWidth() +.TP +opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_PanelMenuBar QStyleOption ( int linewidth, int midlinewidth ) +.TP +opt.lineWidth() +.TP +opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_PanelDockWindow QStyleOption ( int linewidth, int midlinewidth ) +.TP +opt.lineWidth() +.TP +opt.midLineWidth() \fIlinewidth\fR is the line width for drawing the panel. \fImidlinewidth\fR is the mid-line width for drawing the panel. PE_GroupBoxFrame QStyleOption ( int linewidth, int midlinewidth, int shape, int shadow ) +.TP +opt.lineWidth() +.TP +opt.midLineWidth() +.TP +opt.frameShape() +.TP +opt.frameShadow() \fIlinewidth\fR is the line width for the group box. \fImidlinewidth\fR is the mid-line width for the group box. \fIshape\fR is the frame shape for the group box. +.TE +.fi +</center> +.PP +For all other PrimitiveElements, \fIopt\fR is unused. +.PP +See also StyleFlags. +.PP +Example: themes/wood.cpp. +.SH "QRect QStyle::itemRect ( QPainter * p, const QRect & r, int flags, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1 ) const\fC [virtual]\fR" +Returns the appropriate area (see below) within rectangle \fIr\fR in which to draw the \fItext\fR or \fIpixmap\fR using painter \fIp\fR. If \fIlen\fR is -1 (the default) all the \fItext\fR is drawn; otherwise only the first \fIlen\fR characters of \fItext\fR are drawn. The text is aligned in accordance with the alignment \fIflags\fR (see Qt::AlignmentFlags). The \fIenabled\fR bool indicates whether or not the item is enabled. +.PP +If \fIr\fR is larger than the area needed to render the \fItext\fR the rectangle that is returned will be offset within \fIr\fR in accordance with the alignment \fIflags\fR. For example if \fIflags\fR is AlignCenter the returned rectangle will be centered within \fIr\fR. If \fIr\fR is smaller than the area needed the rectangle that is returned will be \fIlarger\fR than \fIr\fR (the smallest rectangle large enough to render the \fItext\fR or \fIpixmap\fR). +.PP +By default, if both the text and the pixmap are not null, the pixmap is drawn and the text is ignored. +.SH "int QStyle::pixelMetric ( PixelMetric metric, const QWidget * widget = 0 ) const\fC [pure virtual]\fR" +Returns the pixel metric for \fImetric\fR. The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fImetric\fR. Note that \fIwidget\fR may be zero even for PixelMetrics that can make use of \fIwidget\fR. See the table below for the appropriate \fIwidget\fR casts: +.PP +<center>.nf +.TS +l - l. PixelMetric Widget Cast PM_SliderControlThickness (const QSlider *) PM_SliderLength (const QSlider *) PM_SliderTickmarkOffset (const QSlider *) PM_SliderSpaceAvailable (const QSlider *) PM_TabBarTabOverlap (const QTabBar *) PM_TabBarTabHSpace (const QTabBar *) PM_TabBarTabVSpace (const QTabBar *) PM_TabBarBaseHeight (const QTabBar *) PM_TabBarBaseOverlap +.TE +.fi +</center> +.SH "void QStyle::polish ( QWidget * )\fC [virtual]\fR" +Initializes the appearance of a widget. +.PP +This function is called for every widget at some point after it has been fully created but just \fIbefore\fR it is shown the very first time. +.PP +Reasonable actions in this function might be to call QWidget::setBackgroundMode() for the widget. An example of highly unreasonable use would be setting the geometry! Reimplementing this function gives you a back-door through which you can change the appearance of a widget. With Qt 3.0's style engine you will rarely need to write your own polish(); instead reimplement drawItem(), drawPrimitive(), etc. +.PP +The QWidget::inherits() function may provide enough information to allow class-specific customizations. But be careful not to hard-code things too much because new QStyle subclasses are expected to work reasonably with all current and \fIfuture\fR widgets. +.PP +See also unPolish(). +.SH "void QStyle::polish ( QApplication * )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Late initialization of the QApplication object. +.PP +See also unPolish(). +.SH "void QStyle::polish ( QPalette & )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The style may have certain requirements for color palettes. In this function it has the chance to change the palette according to these requirements. +.PP +See also QPalette and QApplication::setPalette(). +.SH "void QStyle::polishPopupMenu ( QPopupMenu * )\fC [pure virtual]\fR" +Polishes the popup menu according to the GUI style. This usually means setting the mouse tracking (QPopupMenu::setMouseTracking()) and whether the menu is checkable by default (QPopupMenu::setCheckable()). +.SH "SubControl QStyle::querySubControl ( ComplexControl control, const QWidget * widget, const QPoint & pos, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Returns the SubControl for \fIwidget\fR at the point \fIpos\fR. The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontrol\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ComplexControl. Note that \fIopt\fR may be the default value even for ComplexControls that can make use of the extra options. See drawComplexControl() for an explanation of the \fIwidget\fR and \fIopt\fR arguments. +.PP +Note that \fIpos\fR is passed in screen coordinates. When using querySubControlMetrics() to check for hits and misses, use visualRect() to change the logical coordinates into screen coordinates. +.PP +See also drawComplexControl(), ComplexControl, SubControl, and querySubControlMetrics(). +.SH "QRect QStyle::querySubControlMetrics ( ComplexControl control, const QWidget * widget, SubControl subcontrol, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Returns the rect for the SubControl \fIsubcontrol\fR for \fIwidget\fR in logical coordinates. +.PP +The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontrol\fR. The \fIopt\fR argument can be used to pass extra information required when drawing the ComplexControl. Note that \fIopt\fR may be the default value even for ComplexControls that can make use of the extra options. See drawComplexControl() for an explanation of the \fIwidget\fR and \fIopt\fR arguments. +.PP +See also drawComplexControl(), ComplexControl, and SubControl. +.SH "QSize QStyle::scrollBarExtent () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QSize QStyle::sizeFromContents ( ContentsType contents, const QWidget * widget, const QSize & contentsSize, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Returns the size of \fIwidget\fR based on the contents size \fIcontentsSize\fR. +.PP +The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIcontents\fR. The \fIopt\fR argument can be used to pass extra information required when calculating the size. Note that \fIopt\fR may be the default value even for ContentsTypes that can make use of the extra options. See the table below for the appropriate \fIwidget\fR and \fIopt\fR usage: +.PP +<center>.nf +.TS +l - l. ContentsType Widget Cast Options Notes CT_PushButton (const QPushButton *) Unused. CT_CheckBox (const QCheckBox *) Unused. CT_RadioButton (const QRadioButton *) Unused. CT_ToolButton (const QToolButton *) Unused. CT_ComboBox (const QComboBox *) Unused. CT_Splitter (const QSplitter *) Unused. CT_DockWindow (const QDockWindow *) Unused. CT_ProgressBar (const QProgressBar *) Unused. CT_PopupMenuItem (const QPopupMenu *) QStyleOption ( QMenuItem *mi ) +.TP +opt.menuItem() +.TE +.fi +</center> +.SH "int QStyle::styleHint ( StyleHint stylehint, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default, QStyleHintReturn * returnData = 0 ) const\fC [pure virtual]\fR" +Returns the style hint \fIstylehint\fR for \fIwidget\fR. Currently, \fIwidget\fR, \fIopt\fR, and \fIreturnData\fR are unused; they're included to allow for future enhancements. +.PP +For an explanation of the return value see StyleHint. +.SH "QPixmap QStyle::stylePixmap ( StylePixmap stylepixmap, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default ) const\fC [pure virtual]\fR" +Returns a pixmap for \fIstylepixmap\fR. +.PP +The \fIopt\fR argument can be used to pass extra information required when drawing the ControlElement. Note that \fIopt\fR may be the default value even for StylePixmaps that can make use of the extra options. Currently, the \fIopt\fR argument is unused. +.PP +The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIstylepixmap\fR. See the table below for the appropriate \fIwidget\fR casts: +.PP +<center>.nf +.TS +l - l. StylePixmap Widget Cast SP_TitleBarMinButton (const QWidget *) SP_TitleBarMaxButton (const QWidget *) SP_TitleBarCloseButton (const QWidget *) SP_TitleBarNormalButton (const QWidget *) SP_TitleBarShadeButton (const QWidget *) SP_TitleBarUnshadeButton (const QWidget *) SP_DockWindowCloseButton +.TE +.fi +</center> +.PP +See also StylePixmap. +.SH "QRect QStyle::subRect ( SubRect subrect, const QWidget * widget ) const\fC [pure virtual]\fR" +Returns the sub-area \fIsubrect\fR for the \fIwidget\fR in logical coordinates. +.PP +The \fIwidget\fR argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of \fIsubrect\fR. See the table below for the appropriate \fIwidget\fR casts: +.PP +<center>.nf +.TS +l - l. SubRect Widget Cast SR_PushButtonContents (const QPushButton *) SR_PushButtonFocusRect (const QPushButton *) SR_CheckBoxIndicator (const QCheckBox *) SR_CheckBoxContents (const QCheckBox *) SR_CheckBoxFocusRect (const QCheckBox *) SR_RadioButtonIndicator (const QRadioButton *) SR_RadioButtonContents (const QRadioButton *) SR_RadioButtonFocusRect (const QRadioButton *) SR_ComboBoxFocusRect (const QComboBox *) SR_DockWindowHandleRect (const QWidget *) SR_ProgressBarGroove (const QProgressBar *) SR_ProgressBarContents (const QProgressBar *) SR_ProgressBarLabel +.TE +.fi +</center> +.PP +The tear-off handle (SR_DockWindowHandleRect) for QDockWindow is a private class. Use QWidget::parentWidget() to access the QDockWindow: +.PP +.nf +.br + if ( !widget->parentWidget() ) +.br + return; +.br + const QDockWindow *dw = (const QDockWindow *) widget->parentWidget(); +.br +.fi +.PP +See also SubRect. +.SH "void QStyle::tabbarMetrics ( const QWidget * t, int & hf, int & vf, int & ov ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QStyle::unPolish ( QWidget * )\fC [virtual]\fR" +Undoes the initialization of a widget's appearance. +.PP +This function is the counterpart to polish. It is called for every polished widget when the style is dynamically changed. The former style has to unpolish its settings before the new style can polish them again. +.PP +See also polish(). +.SH "void QStyle::unPolish ( QApplication * )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Undoes the application polish. +.PP +See also polish(). +.SH "QRect QStyle::visualRect ( const QRect & logical, const QWidget * w )\fC [static]\fR" +Returns the rect \fIlogical\fR in screen coordinates. The bounding rect for widget \fIw\fR is used to perform the translation. This function is provided to aid style implementors in supporting right-to-left mode. +.PP +See also QApplication::reverseLayout(). +.SH "QRect QStyle::visualRect ( const QRect & logical, const QRect & bounding )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the rect \fIlogical\fR in screen coordinates. The rect \fIbounding\fR is used to perform the translation. This function is provided to aid style implementors in supporting right-to-left mode. +.PP +See also QApplication::reverseLayout(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstylefactory.3qt b/doc/man/man3/tqstylefactory.3qt new file mode 100644 index 000000000..050993efe --- /dev/null +++ b/doc/man/man3/tqstylefactory.3qt @@ -0,0 +1,61 @@ +'\" t +.TH QStyleFactory 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 +QStyleFactory \- Creates QStyle objects +.SH SYNOPSIS +\fC#include <ntqstylefactory.h>\fR +.PP +.SS "Static Public Members" +<li class=fn>QStringList \fBkeys\fR () <li class=fn>QStyle * \fBcreate\fR ( const QString & key ) +.SH DESCRIPTION +The QStyleFactory class creates QStyle objects. +.PP +The style factory creates a QStyle object for a given key with QStyleFactory::create(key). +.PP +The styles are either built-in or dynamically loaded from a style plugin (see QStylePlugin). +.PP +QStyleFactory::keys() returns a list of valid keys, typically including "Windows", "Motif", "CDE", "MotifPlus", "Platinum"," SGI" and "Compact". Depending on the platform, "WindowsXP"," Aqua" or "Macintosh" may be available. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStyle * QStyleFactory::create ( const QString & key )\fC [static]\fR" +Creates a QStyle object that matches \fIkey\fR case-insensitively. This is either a built-in style, or a style from a style plugin. +.PP +See also keys(). +.PP +Example: themes/wood.cpp. +.SH "QStringList QStyleFactory::keys ()\fC [static]\fR" +Returns the list of keys this factory can create styles for. +.PP +See also create(). +.PP +Example: themes/themes.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstylefactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstylefactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstyleoption.3qt b/doc/man/man3/tqstyleoption.3qt new file mode 100644 index 000000000..a5ebd7818 --- /dev/null +++ b/doc/man/man3/tqstyleoption.3qt @@ -0,0 +1,222 @@ +'\" t +.TH QStyleOption 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 +QStyleOption \- Optional parameters for QStyle functions +.SH SYNOPSIS +\fC#include <ntqstyle.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBStyleOptionDefault\fR { Default }" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( StyleOptionDefault = Default )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( int in1 )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( int in1, int in2 )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( int in1, int in2, int in3, int in4 )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( QMenuItem * m )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( QMenuItem * m, int in1 )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( QMenuItem * m, int in1, int in2 )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( const QColor & c )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( QTab * t )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( QListViewItem * i )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( QCheckListItem * i )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( Qt::ArrowType a )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( const QRect & r )" +.br +.ti -1c +.BI "\fBQStyleOption\fR ( QWidget * w )" +.br +.ti -1c +.BI "bool \fBisDefault\fR () const" +.br +.ti -1c +.BI "int \fBday\fR () const" +.br +.ti -1c +.BI "int \fBlineWidth\fR () const" +.br +.ti -1c +.BI "int \fBmidLineWidth\fR () const" +.br +.ti -1c +.BI "int \fBframeShape\fR () const" +.br +.ti -1c +.BI "int \fBframeShadow\fR () const" +.br +.ti -1c +.BI "int \fBheaderSection\fR () const" +.br +.ti -1c +.BI "QMenuItem * \fBmenuItem\fR () const" +.br +.ti -1c +.BI "int \fBmaxIconWidth\fR () const" +.br +.ti -1c +.BI "int \fBtabWidth\fR () const" +.br +.ti -1c +.BI "const QColor & \fBcolor\fR () const" +.br +.ti -1c +.BI "QTab * \fBtab\fR () const" +.br +.ti -1c +.BI "QCheckListItem * \fBcheckListItem\fR () const" +.br +.ti -1c +.BI "QListViewItem * \fBlistViewItem\fR () const" +.br +.ti -1c +.BI "Qt::ArrowType \fBarrowType\fR () const" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "QWidget * \fBwidget\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QStyleOption class specifies optional parameters for QStyle functions. +.PP +Some QStyle functions take an optional argument specifying extra information that is required for a paritical primitive or control. So that the QStyle class can be extended, QStyleOption is used to provide a variable-argument for these options. +.PP +The QStyleOption class has constructors for each type of optional argument, and this set of constructors may be extended in future Qt releases. There are also corresponding access functions that return the optional arguments: these too may be extended. +.PP +For each constructor, you should refer to the documentation of the QStyle functions to see the meaning of the arguments. +.PP +When calling QStyle functions from your own widgets, you must only pass the default QStyleOption or the argument that QStyle is documented to accept. For example, if the function expects QStyleOption(QMenuItem *, int), passing QStyleOption(QMenuItem *) leaves the optional integer argument uninitialized. +.PP +When subclassing QStyle, you must similarly only expect the default or documented arguments. The other arguments will have uninitialized values. +.PP +If you make your own QStyle subclasses and your own widgets, you can make a subclass of QStyleOption to pass additional arguments to your QStyle subclass. You will need to cast the "const QStyleOption&" argument to your subclass, so be sure your style has been called from your widget. +.PP +See also Widget Appearance and Style. +.SS "Member Type Documentation" +.SH "QStyleOption::StyleOptionDefault" +This enum value can be passed as the optional argument to any QStyle function. +.TP +\fCQStyleOption::Default\fR +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStyleOption::QStyleOption ( StyleOptionDefault = Default )" +The default option. This can always be passed as the optional argument to QStyle functions. +.SH "QStyleOption::QStyleOption ( int in1 )" +Pass one integer, \fIin1\fR. For example, headerSection. +.SH "QStyleOption::QStyleOption ( int in1, int in2 )" +Pass two integers, \fIin1\fR and \fIin2\fR. For example, linewidth and midlinewidth. +.SH "QStyleOption::QStyleOption ( int in1, int in2, int in3, int in4 )" +Pass four integers, \fIin1\fR, \fIin2\fR, \fIin3\fR and \fIin4\fR. +.SH "QStyleOption::QStyleOption ( QMenuItem * m )" +Pass a menu item, \fIm\fR. +.SH "QStyleOption::QStyleOption ( QMenuItem * m, int in1 )" +Pass a menu item and an integer, \fIm\fR and \fIin1\fR. +.SH "QStyleOption::QStyleOption ( QMenuItem * m, int in1, int in2 )" +Pass a menu item and two integers, \fIm\fR, \fIin1\fR and \fIin2\fR. +.SH "QStyleOption::QStyleOption ( const QColor & c )" +Pass a color, \fIc\fR. +.SH "QStyleOption::QStyleOption ( QTab * t )" +Pass a QTab, \fIt\fR. +.SH "QStyleOption::QStyleOption ( QListViewItem * i )" +Pass a QListViewItem, \fIi\fR. +.SH "QStyleOption::QStyleOption ( QCheckListItem * i )" +Pass a QCheckListItem, \fIi\fR. +.SH "QStyleOption::QStyleOption ( Qt::ArrowType a )" +Pass an Qt::ArrowType, \fIa\fR. +.SH "QStyleOption::QStyleOption ( const QRect & r )" +Pass a QRect, \fIr\fR. +.SH "QStyleOption::QStyleOption ( QWidget * w )" +Pass a QWidget, \fIw\fR. +.SH "Qt::ArrowType QStyleOption::arrowType () const" +Returns an arrow type if the appropriate constructor was called; otherwise the return value is undefined. +.SH "QCheckListItem * QStyleOption::checkListItem () const" +Returns a check list item if the appropriate constructor was called; otherwise the return value is undefined. +.SH "const QColor & QStyleOption::color () const" +Returns a color if the appropriate constructor was called; otherwise the return value is undefined. +.SH "int QStyleOption::day () const" +Returns the index of the day in the month if the appropriate constructor was called; otherwise the return value is undefined. +.SH "int QStyleOption::frameShadow () const" +Returns a QFrame::Shadow value if the appropriate constructor was called; otherwise the return value is undefined. +.SH "int QStyleOption::frameShape () const" +Returns a QFrame::Shape value if the appropriate constructor was called; otherwise the return value is undefined. +.SH "int QStyleOption::headerSection () const" +Returns the header section if the appropriate constructor was called; otherwise the return value is undefined. +.SH "bool QStyleOption::isDefault () const" +Returns TRUE if the option was constructed with the default constructor; otherwise returns FALSE. +.SH "int QStyleOption::lineWidth () const" +Returns the line width if the appropriate constructor was called; otherwise the return value is undefined. +.SH "QListViewItem * QStyleOption::listViewItem () const" +Returns a QListView item if the appropriate constructor was called; otherwise the return value is undefined. +.SH "int QStyleOption::maxIconWidth () const" +Returns the maximum width of the menu item check area if the appropriate constructor was called; otherwise the return value is undefined. +.SH "QMenuItem * QStyleOption::menuItem () const" +Returns a menu item if the appropriate constructor was called; otherwise the return value is undefined. +.SH "int QStyleOption::midLineWidth () const" +Returns the mid-line width if the appropriate constructor was called; otherwise the return value is undefined. +.SH "QRect QStyleOption::rect () const" +Returns a rectangle if the appropriate constructor was called; otherwise the return value is undefined. +.SH "QTab * QStyleOption::tab () const" +Returns a QTabBar tab if the appropriate constructor was called; otherwise the return value is undefined. +.SH "int QStyleOption::tabWidth () const" +Returns the tab indent width if the appropriate constructor was called; otherwise the return value is undefined. +.SH "QWidget * QStyleOption::widget () const" +Returns a pointer to a widget if the appropriate constructor was called; +otherwise the return value is undefined. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qstyleoption.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstyleoption.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstyleplugin.3qt b/doc/man/man3/tqstyleplugin.3qt new file mode 100644 index 000000000..86245b8eb --- /dev/null +++ b/doc/man/man3/tqstyleplugin.3qt @@ -0,0 +1,78 @@ +'\" t +.TH QStylePlugin 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 +QStylePlugin \- Abstract base for custom QStyle plugins +.SH SYNOPSIS +\fC#include <ntqstyleplugin.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStylePlugin\fR ()" +.br +.ti -1c +.BI "\fB~QStylePlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBkeys\fR () const = 0" +.br +.ti -1c +.BI "virtual QStyle * \fBcreate\fR ( const QString & key ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QStylePlugin class provides an abstract base for custom QStyle plugins. +.PP +The style plugin is a simple plugin interface that makes it easy to create custom styles that can be loaded dynamically into applications with a QStyleFactory. +.PP +Writing a style plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the plugins documentation for an example. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStylePlugin::QStylePlugin ()" +Constructs a style plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. +.SH "QStylePlugin::~QStylePlugin ()" +Destroys the style plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "QStyle * QStylePlugin::create ( const QString & key )\fC [pure virtual]\fR" +Creates and returns a QStyle object for the style key \fIkey\fR. The style key is usually the class name of the required style. +.PP +See also keys(). +.SH "QStringList QStylePlugin::keys () const\fC [pure virtual]\fR" +Returns the list of style keys this plugin supports. +.PP +These keys are usually the class names of the custom styles that are implemented in the plugin. +.PP +See also create(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstyleplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstyleplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstylesheet.3qt b/doc/man/man3/tqstylesheet.3qt new file mode 100644 index 000000000..986c03243 --- /dev/null +++ b/doc/man/man3/tqstylesheet.3qt @@ -0,0 +1,224 @@ +'\" t +.TH QStyleSheet 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 +QStyleSheet \- Collection of styles for rich text rendering and a generator of tags +.SH SYNOPSIS +\fC#include <ntqstylesheet.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStyleSheet\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "virtual \fB~QStyleSheet\fR ()" +.br +.ti -1c +.BI "QStyleSheetItem * \fBitem\fR ( const QString & name )" +.br +.ti -1c +.BI "const QStyleSheetItem * \fBitem\fR ( const QString & name ) const" +.br +.ti -1c +.BI "virtual QTextCustomItem * \fBtag\fR ( const QString & name, const QMap<QString, QString> & attr, const QString & context, const QMimeSourceFactory & factory, bool emptyTag, QTextDocument * doc ) const" +.br +.ti -1c +.BI "virtual void \fBscaleFont\fR ( QFont & font, int logicalSize ) const" +.br +.ti -1c +.BI "virtual void \fBerror\fR ( const QString & msg ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QStyleSheet * \fBdefaultSheet\fR ()" +.br +.ti -1c +.BI "void \fBsetDefaultSheet\fR ( QStyleSheet * sheet )" +.br +.ti -1c +.BI "QString \fBescape\fR ( const QString & plain )" +.br +.ti -1c +.BI "QString \fBconvertFromPlainText\fR ( const QString & plain, QStyleSheetItem::WhiteSpaceMode mode = QStyleSheetItem::WhiteSpacePre )" +.br +.ti -1c +.BI "bool \fBmightBeRichText\fR ( const QString & text )" +.br +.in -1c +.SH DESCRIPTION +The QStyleSheet class is a collection of styles for rich text rendering and a generator of tags. +.PP +By creating QStyleSheetItem objects for a style sheet you build a definition of a set of tags. This definition will be used by the internal rich text rendering system to parse and display text documents to which the style sheet applies. Rich text is normally visualized in a QTextEdit or a QTextBrowser. However, QLabel, QWhatsThis and QMessageBox also support it, and other classes are likely to follow. With QSimpleRichText it is possible to use the rich text renderer for custom widgets as well. +.PP +The default QStyleSheet object has the following style bindings, sorted by structuring bindings, anchors, character style bindings (i.e. inline styles), special elements such as horizontal lines or images, and other tags. In addition, rich text supports simple HTML tables. +.PP +The structuring tags are <center>.nf +.TS +l - l. Structuring tags Notes A Qt rich text document. It understands the following attributes: +.TP + A top-level heading. + A sublevel heading. + A sub-sublevel heading. + Headings of lesser importance. + A left-aligned paragraph. Adjust the alignment with the + A centered paragraph. + An indented paragraph that is useful for quotes. + An unordered list. You can also pass a type argument to +define the bullet style. The default is + An ordered list. You can also pass a type argument to +define the enumeration label style. The default is + A list item. This tag can be used only within the context +of + A list of definitions, consisting of terms and descriptions. + A term in a list of definitions. This tag can be used only +in the context of + A description in a list of definitions. This tag can be +used only in the context of + For larger chunks of code. Whitespaces in the contents are +preserved. For small bits of code use the inline-style + +.TE +.fi +</center> +.PP +Anchors and links are done with a single tag: <center>.nf +.TS +l - l. Anchor tags Notes An anchor or link. +.TP +A link is created by using an +.TE +.fi +</center> +.PP +The default character style bindings are <center>.nf +.TS +l - l. Style tags Notes Emphasized. By default this is the same as Strong. By default this is the same as Italic font style. Bold font style. Underlined font style. Strike out font style. A larger font size. A smaller font size. Subscripted text Superscripted text Indicates code. By default this is the same as Typewriter font style. Customizes the font size, family and text color. The tag understands the following attributes: +.TP +.TE +.fi +</center> +.PP +Special elements are: <center>.nf +.TS +l +- +l. +Special tags Notes + An image. The image name for the mime source factory is +given in the source attribute, for example + A horizontal line. + A line break. + +.TE +.fi +</center> +.PP +In addition, rich text supports simple HTML tables. A table consists of one or more rows each of which contains one or more cells. Cells are either data cells or header cells, depending on their content. Cells which span rows and columns are supported. +.PP +<center>.nf +.TS +l - l. Table tags Notes A table. Tables support the following attributes: +.TP +A table row. This is only valid within a A table header cell. Similar to A table data cell. This is only valid within a +.TE +.fi +</center> +.PP +See also Graphics Classes, Help System, and Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStyleSheet::QStyleSheet ( QObject * parent = 0, const char * name = 0 )" +Creates a style sheet called \fIname\fR, with parent \fIparent\fR. Like any QObject it will be deleted when its parent is destroyed (if the child still exists). +.PP +By default the style sheet has the tag definitions defined above. +.SH "QStyleSheet::~QStyleSheet ()\fC [virtual]\fR" +Destroys the style sheet. All styles inserted into the style sheet will be deleted. +.SH "QString QStyleSheet::convertFromPlainText ( const QString & plain, QStyleSheetItem::WhiteSpaceMode mode = QStyleSheetItem::WhiteSpacePre )\fC [static]\fR" +Auxiliary function. Converts the plain text string \fIplain\fR to a rich text formatted paragraph while preserving most of its look. +.PP +\fImode\fR defines the whitespace mode. Possible values are QStyleSheetItem::WhiteSpacePre (no wrapping, all whitespaces preserved) and QStyleSheetItem::WhiteSpaceNormal (wrapping, simplified whitespaces). +.PP +See also escape(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, and mdi/application.cpp. +.SH "QStyleSheet * QStyleSheet::defaultSheet ()\fC [static]\fR" +Returns the application-wide default style sheet. This style sheet is used by rich text rendering classes such as QSimpleRichText, QWhatsThis and QMessageBox to define the rendering style and available tags within rich text documents. It also serves as the initial style sheet for the more complex render widgets, QTextEdit and QTextBrowser. +.PP +See also setDefaultSheet(). +.SH "void QStyleSheet::error ( const QString & msg ) const\fC [virtual]\fR" +This virtual function is called when an error occurs when processing rich text. Reimplement it if you need to catch error messages. +.PP +Errors might occur if some rich text strings contain tags that are not understood by the stylesheet, if some tags are nested incorrectly, or if tags are not closed properly. +.PP +\fImsg\fR is the error message. +.SH "QString QStyleSheet::escape ( const QString & plain )\fC [static]\fR" +Auxiliary function. Converts the plain text string \fIplain\fR to a rich text formatted string with any HTML meta-characters escaped. +.PP +See also convertFromPlainText(). +.SH "QStyleSheetItem * QStyleSheet::item ( const QString & name )" +Returns the style called \fIname\fR or 0 if there is no such style. +.SH "const QStyleSheetItem * QStyleSheet::item ( const QString & name ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the style called \fIname\fR or 0 if there is no such style (const version) +.SH "bool QStyleSheet::mightBeRichText ( const QString & text )\fC [static]\fR" +Returns TRUE if the string \fItext\fR is likely to be rich text; otherwise returns FALSE. +.PP +This function uses a fast and therefore simple heuristic. It mainly checks whether there is something that looks like a tag before the first line break. Although the result may be correct for common cases, there is no guarantee. +.SH "void QStyleSheet::scaleFont ( QFont & font, int logicalSize ) const\fC [virtual]\fR" +Scales the font \fIfont\fR to the appropriate physical point size corresponding to the logical font size \fIlogicalSize\fR. +.PP +When calling this function, \fIfont\fR has a point size corresponding to the logical font size 3. +.PP +Logical font sizes range from 1 to 7, with 1 being the smallest. +.PP +See also QStyleSheetItem::logicalFontSize(), QStyleSheetItem::logicalFontSizeStep(), and QFont::setPointSize(). +.SH "void QStyleSheet::setDefaultSheet ( QStyleSheet * sheet )\fC [static]\fR" +Sets the application-wide default style sheet to \fIsheet\fR, deleting any style sheet previously set. The ownership is transferred to QStyleSheet. +.PP +See also defaultSheet(). +.SH "QTextCustomItem * QStyleSheet::tag ( const QString & name, const QMap<QString, QString> & attr, const QString & context, const QMimeSourceFactory & factory, bool emptyTag, QTextDocument * doc ) const\fC [virtual]\fR" +\fBThis function is under development and is subject to change.\fR +.PP +Generates an internal object for the tag called \fIname\fR, given the attributes \fIattr\fR, and using additional information provided by the mime source factory \fIfactory\fR. +.PP +\fIcontext\fR is the optional context of the document, i.e. the path to look for relative links. This becomes important if the text contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see QMimeSourceFactory::defaultFactory()) to resolve these references. The context will then be used to calculate the absolute path. See QMimeSourceFactory::makeAbsolute() for details. +.PP +\fIemptyTag\fR and \fIdoc\fR are for internal use only. +.PP +This function should not be used in application code. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqstylesheet.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstylesheet.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqstylesheetitem.3qt b/doc/man/man3/tqstylesheetitem.3qt new file mode 100644 index 000000000..872d6b08a --- /dev/null +++ b/doc/man/man3/tqstylesheetitem.3qt @@ -0,0 +1,484 @@ +'\" t +.TH QStyleSheetItem 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 +QStyleSheetItem \- Encapsulation of a set of text styles +.SH SYNOPSIS +\fC#include <ntqstylesheet.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQStyleSheetItem\fR ( QStyleSheet * parent, const QString & name )" +.br +.ti -1c +.BI "\fBQStyleSheetItem\fR ( const QStyleSheetItem & other )" +.br +.ti -1c +.BI "\fB~QStyleSheetItem\fR ()" +.br +.ti -1c +.BI "QStyleSheetItem & \fBoperator=\fR ( const QStyleSheetItem & other )" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "QStyleSheet * \fBstyleSheet\fR ()" +.br +.ti -1c +.BI "const QStyleSheet * \fBstyleSheet\fR () const" +.br +.ti -1c +.BI "enum \fBDisplayMode\fR { DisplayBlock, DisplayInline, DisplayListItem, DisplayNone }" +.br +.ti -1c +.BI "DisplayMode \fBdisplayMode\fR () const" +.br +.ti -1c +.BI "void \fBsetDisplayMode\fR ( DisplayMode m )" +.br +.ti -1c +.BI "int \fBalignment\fR () const" +.br +.ti -1c +.BI "void \fBsetAlignment\fR ( int f )" +.br +.ti -1c +.BI "enum \fBVerticalAlignment\fR { VAlignBaseline, VAlignSub, VAlignSuper }" +.br +.ti -1c +.BI "VerticalAlignment \fBverticalAlignment\fR () const" +.br +.ti -1c +.BI "void \fBsetVerticalAlignment\fR ( VerticalAlignment valign )" +.br +.ti -1c +.BI "int \fBfontWeight\fR () const" +.br +.ti -1c +.BI "void \fBsetFontWeight\fR ( int w )" +.br +.ti -1c +.BI "int \fBlogicalFontSize\fR () const" +.br +.ti -1c +.BI "void \fBsetLogicalFontSize\fR ( int s )" +.br +.ti -1c +.BI "int \fBlogicalFontSizeStep\fR () const" +.br +.ti -1c +.BI "void \fBsetLogicalFontSizeStep\fR ( int s )" +.br +.ti -1c +.BI "int \fBfontSize\fR () const" +.br +.ti -1c +.BI "void \fBsetFontSize\fR ( int s )" +.br +.ti -1c +.BI "QString \fBfontFamily\fR () const" +.br +.ti -1c +.BI "void \fBsetFontFamily\fR ( const QString & fam )" +.br +.ti -1c +.BI "int numberOfColumns () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setNumberOfColumns ( int ncols ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QColor \fBcolor\fR () const" +.br +.ti -1c +.BI "void \fBsetColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "bool \fBfontItalic\fR () const" +.br +.ti -1c +.BI "void \fBsetFontItalic\fR ( bool italic )" +.br +.ti -1c +.BI "bool \fBdefinesFontItalic\fR () const" +.br +.ti -1c +.BI "bool \fBfontUnderline\fR () const" +.br +.ti -1c +.BI "void \fBsetFontUnderline\fR ( bool underline )" +.br +.ti -1c +.BI "bool \fBdefinesFontUnderline\fR () const" +.br +.ti -1c +.BI "bool \fBfontStrikeOut\fR () const" +.br +.ti -1c +.BI "void \fBsetFontStrikeOut\fR ( bool strikeOut )" +.br +.ti -1c +.BI "bool \fBdefinesFontStrikeOut\fR () const" +.br +.ti -1c +.BI "bool \fBisAnchor\fR () const" +.br +.ti -1c +.BI "void \fBsetAnchor\fR ( bool anc )" +.br +.ti -1c +.BI "enum \fBWhiteSpaceMode\fR { WhiteSpaceNormal, WhiteSpacePre, WhiteSpaceNoWrap }" +.br +.ti -1c +.BI "WhiteSpaceMode \fBwhiteSpaceMode\fR () const" +.br +.ti -1c +.BI "void \fBsetWhiteSpaceMode\fR ( WhiteSpaceMode m )" +.br +.ti -1c +.BI "enum \fBMargin\fR { MarginLeft, MarginRight, MarginTop, MarginBottom, MarginFirstLine, MarginAll, MarginVertical, MarginHorizontal }" +.br +.ti -1c +.BI "int \fBmargin\fR ( Margin m ) const" +.br +.ti -1c +.BI "void \fBsetMargin\fR ( Margin m, int v )" +.br +.ti -1c +.BI "enum \fBListStyle\fR { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, ListUpperAlpha }" +.br +.ti -1c +.BI "ListStyle \fBlistStyle\fR () const" +.br +.ti -1c +.BI "void \fBsetListStyle\fR ( ListStyle s )" +.br +.ti -1c +.BI "QString \fBcontexts\fR () const" +.br +.ti -1c +.BI "void \fBsetContexts\fR ( const QString & c )" +.br +.ti -1c +.BI "bool \fBallowedInContext\fR ( const QStyleSheetItem * s ) const" +.br +.ti -1c +.BI "bool \fBselfNesting\fR () const" +.br +.ti -1c +.BI "void \fBsetSelfNesting\fR ( bool nesting )" +.br +.ti -1c +.BI "int lineSpacing () const \fI(obsolete)\fR" +.br +.in -1c +.SH DESCRIPTION +The QStyleSheetItem class provides an encapsulation of a set of text styles. +.PP +A style sheet item consists of a name and a set of attributes that specifiy its font, color, etc. When used in a style sheet (see styleSheet()), items define the name() of a rich text tag and the display property changes associated with it. +.PP +The display mode attribute indicates whether the item is a block, an inline element or a list element; see setDisplayMode(). The treatment of whitespace is controlled by the white space mode; see setWhiteSpaceMode(). An item's margins are set with setMargin(), In the case of list items, the list style is set with setListStyle(). An item may be a hypertext link anchor; see setAnchor(). Other attributes are set with setAlignment(), setVerticalAlignment(), setFontFamily(), setFontSize(), setFontWeight(), setFontItalic(), setFontUnderline(), setFontStrikeOut and setColor(). +.PP +See also Text Related Classes. +.SS "Member Type Documentation" +.SH "QStyleSheetItem::DisplayMode" +This enum type defines the way adjacent elements are displayed. +.TP +\fCQStyleSheetItem::DisplayBlock\fR - elements are displayed as a rectangular block (e.g. \fC<p>...</p>\fR). +.TP +\fCQStyleSheetItem::DisplayInline\fR - elements are displayed in a horizontally flowing sequence (e.g. \fC<em>...</em>\fR). +.TP +\fCQStyleSheetItem::DisplayListItem\fR - elements are displayed in a vertical sequence (e.g. \fC<li>...</li>\fR). +.TP +\fCQStyleSheetItem::DisplayNone\fR - elements are not displayed at all. +.SH "QStyleSheetItem::ListStyle" +This enum type defines how the items in a list are prefixed when displayed. +.TP +\fCQStyleSheetItem::ListDisc\fR - a filled circle (i.e. a bullet) +.TP +\fCQStyleSheetItem::ListCircle\fR - an unfilled circle +.TP +\fCQStyleSheetItem::ListSquare\fR - a filled square +.TP +\fCQStyleSheetItem::ListDecimal\fR - an integer in base 10: \fI1\fR, \fI2\fR, \fI3\fR, ... +.TP +\fCQStyleSheetItem::ListLowerAlpha\fR - a lowercase letter: \fIa\fR, \fIb\fR, \fIc\fR, ... +.TP +\fCQStyleSheetItem::ListUpperAlpha\fR - an uppercase letter: \fIA\fR, \fIB\fR, \fIC\fR, ... +.SH "QStyleSheetItem::Margin" +.TP +\fCQStyleSheetItem::MarginLeft\fR - left margin +.TP +\fCQStyleSheetItem::MarginRight\fR - right margin +.TP +\fCQStyleSheetItem::MarginTop\fR - top margin +.TP +\fCQStyleSheetItem::MarginBottom\fR - bottom margin +.TP +\fCQStyleSheetItem::MarginAll\fR - all margins (left, right, top and bottom) +.TP +\fCQStyleSheetItem::MarginVertical\fR - top and bottom margins +.TP +\fCQStyleSheetItem::MarginHorizontal\fR - left and right margins +.TP +\fCQStyleSheetItem::MarginFirstLine\fR - margin (indentation) of the first line of a paragarph (in addition to the MarginLeft of the paragraph) +.SH "QStyleSheetItem::VerticalAlignment" +This enum type defines the way elements are aligned vertically. This is only supported for text elements. +.TP +\fCQStyleSheetItem::VAlignBaseline\fR - align the baseline of the element (or the bottom, if the element doesn't have a baseline) with the baseline of the parent +.TP +\fCQStyleSheetItem::VAlignSub\fR - subscript the element +.TP +\fCQStyleSheetItem::VAlignSuper\fR - superscript the element +.SH "QStyleSheetItem::WhiteSpaceMode" +This enum defines the ways in which QStyleSheet can treat whitespace. +.TP +\fCQStyleSheetItem::WhiteSpaceNormal\fR - any sequence of whitespace (including line-breaks) is equivalent to a single space. +.TP +\fCQStyleSheetItem::WhiteSpacePre\fR - whitespace must be output exactly as given in the input. +.TP +\fCQStyleSheetItem::WhiteSpaceNoWrap\fR - multiple spaces are collapsed as with WhiteSpaceNormal, but no automatic line-breaks occur. To break lines manually, use the \fC<br>\fR tag. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QStyleSheetItem::QStyleSheetItem ( QStyleSheet * parent, const QString & name )" +Constructs a new style called \fIname\fR for the stylesheet \fIparent\fR. +.PP +All properties in QStyleSheetItem are initially in the "do not change" state, except display mode, which defaults to DisplayInline. +.SH "QStyleSheetItem::QStyleSheetItem ( const QStyleSheetItem & other )" +Copy constructor. Constructs a copy of \fIother\fR that is not bound to any style sheet. +.SH "QStyleSheetItem::~QStyleSheetItem ()" +Destroys the style. Note that QStyleSheetItem objects become owned by QStyleSheet when they are created. +.SH "int QStyleSheetItem::alignment () const" +Returns the alignment of this style. Possible values are AlignAuto, AlignLeft, AlignRight, AlignCenter or AlignJustify. +.PP +See also setAlignment() and Qt::AlignmentFlags. +.SH "bool QStyleSheetItem::allowedInContext ( const QStyleSheetItem * s ) const" +Returns TRUE if this style can be nested into an element of style \fIs\fR; otherwise returns FALSE. +.PP +See also contexts() and setContexts(). +.SH "QColor QStyleSheetItem::color () const" +Returns the text color of this style or an invalid color if no color has been set. +.PP +See also setColor() and QColor::isValid(). +.SH "QString QStyleSheetItem::contexts () const" +Returns a space-separated list of names of styles that may contain elements of this style. If nothing has been set, contexts() returns an empty string, which indicates that this style can be nested everywhere. +.PP +See also setContexts(). +.SH "bool QStyleSheetItem::definesFontItalic () const" +Returns TRUE if the style defines a font shape; otherwise returns FALSE. A style does not define any shape until setFontItalic() is called. +.PP +See also setFontItalic() and fontItalic(). +.SH "bool QStyleSheetItem::definesFontStrikeOut () const" +Returns TRUE if the style defines a setting for the strikeOut property of the font; otherwise returns FALSE. A style does not define this until setFontStrikeOut() is called. +.PP +See also setFontStrikeOut() and fontStrikeOut(). +.SH "bool QStyleSheetItem::definesFontUnderline () const" +Returns TRUE if the style defines a setting for the underline property of the font; otherwise returns FALSE. A style does not define this until setFontUnderline() is called. +.PP +See also setFontUnderline() and fontUnderline(). +.SH "DisplayMode QStyleSheetItem::displayMode () const" +Returns the display mode of the style. +.PP +See also setDisplayMode(). +.SH "QString QStyleSheetItem::fontFamily () const" +Returns the font family setting of the style. This is either a valid font family or QString::null if no family has been set. +.PP +See also setFontFamily(), QFont::family(), and QFont::setFamily(). +.SH "bool QStyleSheetItem::fontItalic () const" +Returns TRUE if the style sets an italic font; otherwise returns FALSE. +.PP +See also setFontItalic() and definesFontItalic(). +.SH "int QStyleSheetItem::fontSize () const" +Returns the font size setting of the style. This is either a valid point size or QStyleSheetItem::Undefined. +.PP +See also setFontSize(), QFont::pointSize(), and QFont::setPointSize(). +.SH "bool QStyleSheetItem::fontStrikeOut () const" +Returns TRUE if the style sets a strike out font; otherwise returns FALSE. +.PP +See also setFontStrikeOut() and definesFontStrikeOut(). +.SH "bool QStyleSheetItem::fontUnderline () const" +Returns TRUE if the style sets an underlined font; otherwise returns FALSE. +.PP +See also setFontUnderline() and definesFontUnderline(). +.SH "int QStyleSheetItem::fontWeight () const" +Returns the font weight setting of the style. This is either a valid QFont::Weight or the value QStyleSheetItem::Undefined. +.PP +See also setFontWeight() and QFont. +.SH "bool QStyleSheetItem::isAnchor () const" +Returns whether this style is an anchor. +.PP +See also setAnchor(). +.SH "int QStyleSheetItem::lineSpacing () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the linespacing +.SH "ListStyle QStyleSheetItem::listStyle () const" +Returns the list style of the style. +.PP +See also setListStyle() and ListStyle. +.SH "int QStyleSheetItem::logicalFontSize () const" +Returns the logical font size setting of the style. This is either a valid size between 1 and 7 or QStyleSheetItem::Undefined. +.PP +See also setLogicalFontSize(), setLogicalFontSizeStep(), QFont::pointSize(), and QFont::setPointSize(). +.SH "int QStyleSheetItem::logicalFontSizeStep () const" +Returns the logical font size step of this style. +.PP +The default is 0. Tags such as \fCbig\fR define \fC+1\fR; \fCsmall\fR defines \fC-1\fR. +.PP +See also setLogicalFontSizeStep(). +.SH "int QStyleSheetItem::margin ( Margin m ) const" +Returns the width of margin \fIm\fR in pixels. +.PP +The margin, \fIm\fR, can be MarginLeft, MarginRight, MarginTop, MarginBottom, or MarginFirstLine. +.PP +See also setMargin() and Margin. +.SH "QString QStyleSheetItem::name () const" +Returns the name of the style item. +.SH "int QStyleSheetItem::numberOfColumns () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the number of columns for this style. +.PP +See also setNumberOfColumns(), displayMode(), and setDisplayMode(). +.SH "QStyleSheetItem & QStyleSheetItem::operator= ( const QStyleSheetItem & other )" +Assignment. Assings a copy of \fIother\fR that is not bound to any style sheet. Unbounds first from previous style sheet. +.SH "bool QStyleSheetItem::selfNesting () const" +Returns TRUE if this style has self-nesting enabled; otherwise returns FALSE. +.PP +See also setSelfNesting(). +.SH "void QStyleSheetItem::setAlignment ( int f )" +Sets the alignment to \fIf\fR. This only makes sense for styles with a display mode of DisplayBlock. Possible values are AlignAuto, AlignLeft, AlignRight, AlignCenter or AlignJustify. +.PP +See also alignment(), displayMode(), and Qt::AlignmentFlags. +.SH "void QStyleSheetItem::setAnchor ( bool anc )" +If \fIanc\fR is TRUE, sets this style to be an anchor (hypertext link); otherwise sets it to not be an anchor. Elements in this style link to other documents or anchors. +.PP +See also isAnchor(). +.SH "void QStyleSheetItem::setColor ( const QColor & c )" +Sets the text color of this style to \fIc\fR. +.PP +See also color(). +.SH "void QStyleSheetItem::setContexts ( const QString & c )" +Sets a space-separated list of names of styles that may contain elements of this style. If \fIc\fR is empty, the style can be nested everywhere. +.PP +See also contexts(). +.SH "void QStyleSheetItem::setDisplayMode ( DisplayMode m )" +Sets the display mode of the style to \fIm\fR. +.PP +See also displayMode(). +.SH "void QStyleSheetItem::setFontFamily ( const QString & fam )" +Sets the font family setting of the style to \fIfam\fR. +.PP +See also fontFamily(), QFont::family(), and QFont::setFamily(). +.SH "void QStyleSheetItem::setFontItalic ( bool italic )" +If \fIitalic\fR is TRUE sets italic for the style; otherwise sets upright. +.PP +See also fontItalic() and definesFontItalic(). +.SH "void QStyleSheetItem::setFontSize ( int s )" +Sets the font size setting of the style to \fIs\fR points. +.PP +See also fontSize(), QFont::pointSize(), and QFont::setPointSize(). +.SH "void QStyleSheetItem::setFontStrikeOut ( bool strikeOut )" +If \fIstrikeOut\fR is TRUE, sets strike out for the style; otherwise sets no strike out. +.PP +See also fontStrikeOut() and definesFontStrikeOut(). +.SH "void QStyleSheetItem::setFontUnderline ( bool underline )" +If \fIunderline\fR is TRUE, sets underline for the style; otherwise sets no underline. +.PP +See also fontUnderline() and definesFontUnderline(). +.SH "void QStyleSheetItem::setFontWeight ( int w )" +Sets the font weight setting of the style to \fIw\fR. Valid values are those defined by QFont::Weight. +.PP +See also QFont and fontWeight(). +.SH "void QStyleSheetItem::setListStyle ( ListStyle s )" +Sets the list style of the style to \fIs\fR. +.PP +This is used by nested elements that have a display mode of DisplayListItem. +.PP +See also listStyle(), DisplayMode, and ListStyle. +.SH "void QStyleSheetItem::setLogicalFontSize ( int s )" +Sets the logical font size setting of the style to \fIs\fR. Valid logical sizes are 1 to 7. +.PP +See also logicalFontSize(), QFont::pointSize(), and QFont::setPointSize(). +.SH "void QStyleSheetItem::setLogicalFontSizeStep ( int s )" +Sets the logical font size step of this style to \fIs\fR. +.PP +See also logicalFontSizeStep(). +.SH "void QStyleSheetItem::setMargin ( Margin m, int v )" +Sets the width of margin \fIm\fR to \fIv\fR pixels. +.PP +The margin, \fIm\fR, can be MarginLeft, MarginRight, MarginTop, MarginBottom, MarginFirstLine, MarginAll, MarginVertical or MarginHorizontal. The value \fIv\fR must be >= 0. +.PP +See also margin(). +.SH "void QStyleSheetItem::setNumberOfColumns ( int ncols )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Sets the number of columns for this style. Elements in the style are divided into columns. +.PP +This makes sense only if the style uses a block display mode (see QStyleSheetItem::DisplayMode). +.PP +See also numberOfColumns(). +.SH "void QStyleSheetItem::setSelfNesting ( bool nesting )" +Sets the self-nesting property for this style to \fInesting\fR. +.PP +In order to support "dirty" HTML, paragraphs \fC<p>\fR and list items \fC<li>\fR are not self-nesting. This means that starting a new paragraph or list item automatically closes the previous one. +.PP +See also selfNesting(). +.SH "void QStyleSheetItem::setVerticalAlignment ( VerticalAlignment valign )" +Sets the vertical alignment to \fIvalign\fR. Possible values are VAlignBaseline, VAlignSub or VAlignSuper. +.PP +The vertical alignment property is not inherited. +.PP +See also verticalAlignment(). +.SH "void QStyleSheetItem::setWhiteSpaceMode ( WhiteSpaceMode m )" +Sets the whitespace mode to \fIm\fR. +.PP +See also WhiteSpaceMode. +.SH "QStyleSheet * QStyleSheetItem::styleSheet ()" +Returns the style sheet this item is in. +.SH "const QStyleSheet * QStyleSheetItem::styleSheet () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the style sheet this item is in. +.SH "VerticalAlignment QStyleSheetItem::verticalAlignment () const" +Returns the vertical alignment of the style. Possible values are VAlignBaseline, VAlignSub or VAlignSuper. +.PP +See also setVerticalAlignment(). +.SH "WhiteSpaceMode QStyleSheetItem::whiteSpaceMode () const" +Returns the whitespace mode. +.PP +See also setWhiteSpaceMode() and WhiteSpaceMode. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qstylesheetitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqstylesheetitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqsyntaxhighlighter.3qt b/doc/man/man3/tqsyntaxhighlighter.3qt new file mode 100644 index 000000000..4014834c4 --- /dev/null +++ b/doc/man/man3/tqsyntaxhighlighter.3qt @@ -0,0 +1,120 @@ +'\" t +.TH QSyntaxHighlighter 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 +QSyntaxHighlighter \- Base class for implementing QTextEdit syntax highlighters +.SH SYNOPSIS +\fC#include <ntqsyntaxhighlighter.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSyntaxHighlighter\fR ( QTextEdit * textEdit )" +.br +.ti -1c +.BI "virtual \fB~QSyntaxHighlighter\fR ()" +.br +.ti -1c +.BI "virtual int \fBhighlightParagraph\fR ( const QString & text, int endStateOfLastPara ) = 0" +.br +.ti -1c +.BI "void \fBsetFormat\fR ( int start, int count, const QFont & font, const QColor & color )" +.br +.ti -1c +.BI "void \fBsetFormat\fR ( int start, int count, const QColor & color )" +.br +.ti -1c +.BI "void \fBsetFormat\fR ( int start, int count, const QFont & font )" +.br +.ti -1c +.BI "QTextEdit * \fBtextEdit\fR () const" +.br +.ti -1c +.BI "void \fBrehighlight\fR ()" +.br +.ti -1c +.BI "int \fBcurrentParagraph\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QSyntaxHighlighter class is a base class for implementing QTextEdit syntax highlighters. +.PP +A syntax highligher automatically highlights parts of the text in a QTextEdit. Syntax highlighters are often used when the user is entering text in a specific format (for example, source code) and help the user to read the text and identify syntax errors. +.PP +To provide your own syntax highlighting for QTextEdit, you must subclass QSyntaxHighlighter and reimplement highlightParagraph(). +.PP +When you create an instance of your QSyntaxHighlighter subclass, pass it the QTextEdit that you want the syntax highlighting to be applied to. After this your highlightParagraph() function will be called automatically whenever necessary. Use your highlightParagraph() function to apply formatting (e.g. setting the font and color) to the text that is passed to it. +.PP +See also Basic Widgets and Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSyntaxHighlighter::QSyntaxHighlighter ( QTextEdit * textEdit )" +Constructs the QSyntaxHighlighter and installs it on \fItextEdit\fR. +.PP +It is the caller's responsibility to delete the QSyntaxHighlighter when it is no longer needed. +.SH "QSyntaxHighlighter::~QSyntaxHighlighter ()\fC [virtual]\fR" +Destructor. Uninstalls this syntax highlighter from the textEdit() +.SH "int QSyntaxHighlighter::currentParagraph () const" +Returns the id of the paragraph which is highlighted, or -1 of no paragraph is currently highlighted. +.PP +Usually this function is called from within highlightParagraph(). +.SH "int QSyntaxHighlighter::highlightParagraph ( const QString & text, int endStateOfLastPara )\fC [pure virtual]\fR" +This function is called when necessary by the rich text engine, i.e. on paragraphs which have changed. +.PP +In your reimplementation you should parse the paragraph's \fItext\fR and call setFormat() as often as necessary to apply any font and color changes that you require. Your function must return a value which indicates the paragraph's end state: see below. +.PP +Some syntaxes can have constructs that span paragraphs. For example, a C++ syntax highlighter should be able to cope with \fC/\fR\fC*...*\fR\fC/\fR comments that span paragraphs. To deal with these cases it is necessary to know the end state of the previous paragraph (e.g. "in comment"). +.PP +If your syntax does not have paragraph spanning constructs, simply ignore the \fIendStateOfLastPara\fR parameter and always return 0. +.PP +Whenever highlightParagraph() is called it is passed a value for \fIendStateOfLastPara\fR. For the very first paragraph this value is always -2. For any other paragraph the value is the value returned by the most recent highlightParagraph() call that applied to the preceding paragraph. +.PP +The value you return is up to you. We recommend only returning 0 (to signify that this paragraph's syntax highlighting does not affect the following paragraph), or a positive integer (to signify that this paragraph has ended in the middle of a paragraph spanning construct). +.PP +To find out which paragraph is highlighted, call currentParagraph(). +.PP +For example, if you're writing a simple C++ syntax highlighter, you might designate 1 to signify "in comment". For a paragraph that ended in the middle of a comment you'd return 1, and for other paragraphs you'd return 0. In your parsing code if \fIendStateOfLastPara\fR was 1, you would highlight the text as a C++ comment until you reached the closing \fC*\fR\fC/\fR. +.SH "void QSyntaxHighlighter::rehighlight ()" +Redoes the highlighting of the whole document. +.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const QFont & font, const QColor & color )" +This function is applied to the syntax highlighter's current paragraph (the text of which is passed to the highlightParagraph() function). +.PP +The specified \fIfont\fR and \fIcolor\fR are applied to the text from position \fIstart\fR for \fIcount\fR characters. (If \fIcount\fR is 0, nothing is done.) +.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const QColor & color )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const QFont & font )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QTextEdit * QSyntaxHighlighter::textEdit () const" +Returns the QTextEdit on which this syntax highlighter is +installed + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqsyntaxhighlighter.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqsyntaxhighlighter.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqt.3qt b/doc/man/man3/tqt.3qt new file mode 100644 index 000000000..1444f5df3 --- /dev/null +++ b/doc/man/man3/tqt.3qt @@ -0,0 +1,1451 @@ +'\" t +.TH Qt 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 +Qt \- Namespace for miscellaneous identifiers that need to be global-like +.SH SYNOPSIS +\fC#include <ntqnamespace.h>\fR +.PP +Inherited by QObject, QPixmap, QBrush, QCanvasItem, QCursor, QPainter, QEvent, QIconViewItem, QKeySequence, QListViewItem, QCustomMenuItem, QPen, QStyleSheetItem, QSyntaxHighlighter, QTab, QTableItem, QThread, QToolTip, and QWhatsThis. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBButtonState\fR { NoButton = 0x0000, LeftButton = 0x0001, RightButton = 0x0002, MidButton = 0x0004, MouseButtonMask = 0x0007, ShiftButton = 0x0100, ControlButton = 0x0200, AltButton = 0x0400, MetaButton = 0x0800, KeyButtonMask = 0x0f00, Keypad = 0x4000 }" +.br +.ti -1c +.BI "enum \fBOrientation\fR { Horizontal = 0, Vertical }" +.br +.ti -1c +.BI "enum \fBSortOrder\fR { Ascending, Descending }" +.br +.ti -1c +.BI "enum \fBAlignmentFlags\fR { AlignAuto = 0x0000, AlignLeft = 0x0001, AlignRight = 0x0002, AlignHCenter = 0x0004, AlignJustify = 0x0008, AlignHorizontal_Mask = AlignLeft | AlignRight | AlignHCenter | AlignJustify, AlignTop = 0x0010, AlignBottom = 0x0020, AlignVCenter = 0x0040, AlignVertical_Mask = AlignTop | AlignBottom | AlignVCenter, AlignCenter = AlignVCenter | AlignHCenter }" +.br +.ti -1c +.BI "enum \fBTextFlags\fR { SingleLine = 0x0080, DontClip = 0x0100, ExpandTabs = 0x0200, ShowPrefix = 0x0400, WordBreak = 0x0800, BreakAnywhere = 0x1000, NoAccel = 0x4000 }" +.br +.ti -1c +.BI "enum \fBWidgetState\fR { WState_Created = 0x00000001, WState_Disabled = 0x00000002, WState_Visible = 0x00000004, WState_ForceHide = 0x00000008, WState_OwnCursor = 0x00000010, WState_MouseTracking = 0x00000020, WState_CompressKeys = 0x00000040, WState_BlockUpdates = 0x00000080, WState_InPaintEvent = 0x00000100, WState_Reparented = 0x00000200, WState_ConfigPending = 0x00000400, WState_Resized = 0x00000800, WState_AutoMask = 0x00001000, WState_Polished = 0x00002000, WState_DND = 0x00004000, WState_Reserved0 = 0x00008000, WState_FullScreen = 0x00010000, WState_OwnSizePolicy = 0x00020000, WState_CreatedHidden = 0x00040000, WState_Maximized = 0x00080000, WState_Minimized = 0x00100000, WState_ForceDisabled = 0x00200000, WState_Exposed = 0x00400000, WState_HasMouse = 0x00800000 }" +.br +.ti -1c +.BI "enum \fBWidgetFlags\fR { WType_TopLevel = 0x00000001, WType_Dialog = 0x00000002, WType_Popup = 0x00000004, WType_Desktop = 0x00000008, WType_Mask = 0x0000000f, WStyle_Customize = 0x00000010, WStyle_NormalBorder = 0x00000020, WStyle_DialogBorder = 0x00000040, WStyle_NoBorder = 0x00002000, WStyle_Title = 0x00000080, WStyle_SysMenu = 0x00000100, WStyle_Minimize = 0x00000200, WStyle_Maximize = 0x00000400, WStyle_MinMax = WStyle_Minimize | WStyle_Maximize, WStyle_Tool = 0x00000800, WStyle_StaysOnTop = 0x00001000, WStyle_ContextHelp = 0x00004000, WStyle_Reserved = 0x00008000, WStyle_Mask = 0x0000fff0, WDestructiveClose = 0x00010000, WPaintDesktop = 0x00020000, WPaintUnclipped = 0x00040000, WPaintClever = 0x00080000, WResizeNoErase = 0x00100000, WMouseNoMask = 0x00200000, WStaticContents = 0x00400000, WRepaintNoErase = 0x00800000, WX11BypassWM = 0x01000000, WWinOwnDC = 0x00000000, WMacNoSheet = 0x00000000, WMacDrawer = 0x00000000, WX11BypassWM = 0x00000000, WWinOwnDC = 0x01000000, WMacNoSheet = 0x00000000, WMacDrawer = 0x00000000, WGroupLeader = 0x02000000, WShowModal = 0x04000000, WNoMousePropagation = 0x08000000, WSubWindow = 0x10000000, WStyle_Splash = 0x20000000, WNoAutoErase = WRepaintNoErase | WResizeNoErase, WNorthWestGravity = WStaticContents, WType_Modal = WType_Dialog | WShowModal, WStyle_Dialog = WType_Dialog, WStyle_NoBorderEx = WStyle_NoBorder }" +.br +.ti -1c +.BI "enum \fBWindowState\fR { WindowNoState = 0x00000000, WindowMinimized = 0x00000001, WindowMaximized = 0x00000002, WindowFullScreen = 0x00000004, WindowActive = 0x00000008 }" +.br +.ti -1c +.BI "enum \fBImageConversionFlags\fR { ColorMode_Mask = 0x00000003, AutoColor = 0x00000000, ColorOnly = 0x00000003, MonoOnly = 0x00000002, AlphaDither_Mask = 0x0000000c, ThresholdAlphaDither = 0x00000000, OrderedAlphaDither = 0x00000004, DiffuseAlphaDither = 0x00000008, NoAlpha = 0x0000000c, Dither_Mask = 0x00000030, DiffuseDither = 0x00000000, OrderedDither = 0x00000010, ThresholdDither = 0x00000020, DitherMode_Mask = 0x000000c0, AutoDither = 0x00000000, PreferDither = 0x00000040, AvoidDither = 0x00000080 }" +.br +.ti -1c +.BI "enum \fBBGMode\fR { TransparentMode, OpaqueMode }" +.br +.ti -1c +.BI "enum \fBPaintUnit\fR { PixelUnit, LoMetricUnit, HiMetricUnit, LoEnglishUnit, HiEnglishUnit, TwipsUnit }" +.br +.ti -1c +.BI "enum GUIStyle { MacStyle, WindowsStyle, Win3Style, PMStyle, MotifStyle } \fI(obsolete)\fR" +.br +.ti -1c +.BI "enum \fBSequenceMatch\fR { NoMatch, PartialMatch, Identical }" +.br +.ti -1c +.BI "enum \fBModifier\fR { META = 0x00100000, SHIFT = 0x00200000, CTRL = 0x00400000, ALT = 0x00800000, MODIFIER_MASK = 0x00f00000, UNICODE_ACCEL = 0x10000000, ASCII_ACCEL = UNICODE_ACCEL }" +.br +.ti -1c +.BI "enum \fBKey\fR { Key_Escape = 0x1000, Key_Tab = 0x1001, Key_Backtab = 0x1002, Key_BackTab = Key_Backtab, Key_Backspace = 0x1003, Key_BackSpace = Key_Backspace, Key_Return = 0x1004, Key_Enter = 0x1005, Key_Insert = 0x1006, Key_Delete = 0x1007, Key_Pause = 0x1008, Key_Print = 0x1009, Key_SysReq = 0x100a, Key_Clear = 0x100b, Key_Home = 0x1010, Key_End = 0x1011, Key_Left = 0x1012, Key_Up = 0x1013, Key_Right = 0x1014, Key_Down = 0x1015, Key_Prior = 0x1016, Key_PageUp = Key_Prior, Key_Next = 0x1017, Key_PageDown = Key_Next, Key_Shift = 0x1020, Key_Control = 0x1021, Key_Meta = 0x1022, Key_Alt = 0x1023, Key_CapsLock = 0x1024, Key_NumLock = 0x1025, Key_ScrollLock = 0x1026, Key_F1 = 0x1030, Key_F2 = 0x1031, Key_F3 = 0x1032, Key_F4 = 0x1033, Key_F5 = 0x1034, Key_F6 = 0x1035, Key_F7 = 0x1036, Key_F8 = 0x1037, Key_F9 = 0x1038, Key_F10 = 0x1039, Key_F11 = 0x103a, Key_F12 = 0x103b, Key_F13 = 0x103c, Key_F14 = 0x103d, Key_F15 = 0x103e, Key_F16 = 0x103f, Key_F17 = 0x1040, Key_F18 = 0x1041, Key_F19 = 0x1042, Key_F20 = 0x1043, Key_F21 = 0x1044, Key_F22 = 0x1045, Key_F23 = 0x1046, Key_F24 = 0x1047, Key_F25 = 0x1048, Key_F26 = 0x1049, Key_F27 = 0x104a, Key_F28 = 0x104b, Key_F29 = 0x104c, Key_F30 = 0x104d, Key_F31 = 0x104e, Key_F32 = 0x104f, Key_F33 = 0x1050, Key_F34 = 0x1051, Key_F35 = 0x1052, Key_Super_L = 0x1053, Key_Super_R = 0x1054, Key_Menu = 0x1055, Key_Hyper_L = 0x1056, Key_Hyper_R = 0x1057, Key_Help = 0x1058, Key_Direction_L = 0x1059, Key_Direction_R = 0x1060, Key_Space = 0x20, Key_Any = Key_Space, Key_Exclam = 0x21, Key_QuoteDbl = 0x22, Key_NumberSign = 0x23, Key_Dollar = 0x24, Key_Percent = 0x25, Key_Ampersand = 0x26, Key_Apostrophe = 0x27, Key_ParenLeft = 0x28, Key_ParenRight = 0x29, Key_Asterisk = 0x2a, Key_Plus = 0x2b, Key_Comma = 0x2c, Key_Minus = 0x2d, Key_Period = 0x2e, Key_Slash = 0x2f, Key_0 = 0x30, Key_1 = 0x31, Key_2 = 0x32, Key_3 = 0x33, Key_4 = 0x34, Key_5 = 0x35, Key_6 = 0x36, Key_7 = 0x37, Key_8 = 0x38, Key_9 = 0x39, Key_Colon = 0x3a, Key_Semicolon = 0x3b, Key_Less = 0x3c, Key_Equal = 0x3d, Key_Greater = 0x3e, Key_Question = 0x3f, Key_At = 0x40, Key_A = 0x41, Key_B = 0x42, Key_C = 0x43, Key_D = 0x44, Key_E = 0x45, Key_F = 0x46, Key_G = 0x47, Key_H = 0x48, Key_I = 0x49, Key_J = 0x4a, Key_K = 0x4b, Key_L = 0x4c, Key_M = 0x4d, Key_N = 0x4e, Key_O = 0x4f, Key_P = 0x50, Key_Q = 0x51, Key_R = 0x52, Key_S = 0x53, Key_T = 0x54, Key_U = 0x55, Key_V = 0x56, Key_W = 0x57, Key_X = 0x58, Key_Y = 0x59, Key_Z = 0x5a, Key_BracketLeft = 0x5b, Key_Backslash = 0x5c, Key_BracketRight = 0x5d, Key_AsciiCircum = 0x5e, Key_Underscore = 0x5f, Key_QuoteLeft = 0x60, Key_BraceLeft = 0x7b, Key_Bar = 0x7c, Key_BraceRight = 0x7d, Key_AsciiTilde = 0x7e, Key_nobreakspace = 0x0a0, Key_exclamdown = 0x0a1, Key_cent = 0x0a2, Key_sterling = 0x0a3, Key_currency = 0x0a4, Key_yen = 0x0a5, Key_brokenbar = 0x0a6, Key_section = 0x0a7, Key_diaeresis = 0x0a8, Key_copyright = 0x0a9, Key_ordfeminine = 0x0aa, Key_guillemotleft = 0x0ab, Key_notsign = 0x0ac, Key_hyphen = 0x0ad, Key_registered = 0x0ae, Key_macron = 0x0af, Key_degree = 0x0b0, Key_plusminus = 0x0b1, Key_twosuperior = 0x0b2, Key_threesuperior = 0x0b3, Key_acute = 0x0b4, Key_mu = 0x0b5, Key_paragraph = 0x0b6, Key_periodcentered = 0x0b7, Key_cedilla = 0x0b8, Key_onesuperior = 0x0b9, Key_masculine = 0x0ba, Key_guillemotright = 0x0bb, Key_onequarter = 0x0bc, Key_onehalf = 0x0bd, Key_threequarters = 0x0be, Key_questiondown = 0x0bf, Key_Agrave = 0x0c0, Key_Aacute = 0x0c1, Key_Acircumflex = 0x0c2, Key_Atilde = 0x0c3, Key_Adiaeresis = 0x0c4, Key_Aring = 0x0c5, Key_AE = 0x0c6, Key_Ccedilla = 0x0c7, Key_Egrave = 0x0c8, Key_Eacute = 0x0c9, Key_Ecircumflex = 0x0ca, Key_Ediaeresis = 0x0cb, Key_Igrave = 0x0cc, Key_Iacute = 0x0cd, Key_Icircumflex = 0x0ce, Key_Idiaeresis = 0x0cf, Key_ETH = 0x0d0, Key_Ntilde = 0x0d1, Key_Ograve = 0x0d2, Key_Oacute = 0x0d3, Key_Ocircumflex = 0x0d4, Key_Otilde = 0x0d5, Key_Odiaeresis = 0x0d6, Key_multiply = 0x0d7, Key_Ooblique = 0x0d8, Key_Ugrave = 0x0d9, Key_Uacute = 0x0da, Key_Ucircumflex = 0x0db, Key_Udiaeresis = 0x0dc, Key_Yacute = 0x0dd, Key_THORN = 0x0de, Key_ssharp = 0x0df, Key_agrave = 0x0e0, Key_aacute = 0x0e1, Key_acircumflex = 0x0e2, Key_atilde = 0x0e3, Key_adiaeresis = 0x0e4, Key_aring = 0x0e5, Key_ae = 0x0e6, Key_ccedilla = 0x0e7, Key_egrave = 0x0e8, Key_eacute = 0x0e9, Key_ecircumflex = 0x0ea, Key_ediaeresis = 0x0eb, Key_igrave = 0x0ec, Key_iacute = 0x0ed, Key_icircumflex = 0x0ee, Key_idiaeresis = 0x0ef, Key_eth = 0x0f0, Key_ntilde = 0x0f1, Key_ograve = 0x0f2, Key_oacute = 0x0f3, Key_ocircumflex = 0x0f4, Key_otilde = 0x0f5, Key_odiaeresis = 0x0f6, Key_division = 0x0f7, Key_oslash = 0x0f8, Key_ugrave = 0x0f9, Key_uacute = 0x0fa, Key_ucircumflex = 0x0fb, Key_udiaeresis = 0x0fc, Key_yacute = 0x0fd, Key_thorn = 0x0fe, Key_ydiaeresis = 0x0ff, Key_Back = 0x1061, Key_Forward = 0x1062, Key_Stop = 0x1063, Key_Refresh = 0x1064, Key_VolumeDown = 0x1070, Key_VolumeMute = 0x1071, Key_VolumeUp = 0x1072, Key_BassBoost = 0x1073, Key_BassUp = 0x1074, Key_BassDown = 0x1075, Key_TrebleUp = 0x1076, Key_TrebleDown = 0x1077, Key_MediaPlay = 0x1080, Key_MediaStop = 0x1081, Key_MediaPrev = 0x1082, Key_MediaNext = 0x1083, Key_MediaRecord = 0x1084, Key_HomePage = 0x1090, Key_Favorites = 0x1091, Key_Search = 0x1092, Key_Standby = 0x1093, Key_OpenUrl = 0x1094, Key_LaunchMail = 0x10a0, Key_LaunchMedia = 0x10a1, Key_Launch0 = 0x10a2, Key_Launch1 = 0x10a3, Key_Launch2 = 0x10a4, Key_Launch3 = 0x10a5, Key_Launch4 = 0x10a6, Key_Launch5 = 0x10a7, Key_Launch6 = 0x10a8, Key_Launch7 = 0x10a9, Key_Launch8 = 0x10aa, Key_Launch9 = 0x10ab, Key_LaunchA = 0x10ac, Key_LaunchB = 0x10ad, Key_LaunchC = 0x10ae, Key_LaunchD = 0x10af, Key_LaunchE = 0x10b0, Key_LaunchF = 0x10b1, Key_MediaLast = 0x1fff, Key_unknown = 0xffff }" +.br +.ti -1c +.BI "enum \fBArrowType\fR { UpArrow, DownArrow, LeftArrow, RightArrow }" +.br +.ti -1c +.BI "enum \fBRasterOp\fR { CopyROP, OrROP, XorROP, NotAndROP, EraseROP = NotAndROP, NotCopyROP, NotOrROP, NotXorROP, AndROP, NotEraseROP = AndROP, NotROP, ClearROP, SetROP, NopROP, AndNotROP, OrNotROP, NandROP, NorROP, LastROP = NorROP }" +.br +.ti -1c +.BI "enum \fBPenStyle\fR { NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine, MPenStyle = 0x0f }" +.br +.ti -1c +.BI "enum \fBPenCapStyle\fR { FlatCap = 0x00, SquareCap = 0x10, RoundCap = 0x20, MPenCapStyle = 0x30 }" +.br +.ti -1c +.BI "enum \fBPenJoinStyle\fR { MiterJoin = 0x00, BevelJoin = 0x40, RoundJoin = 0x80, MPenJoinStyle = 0xc0 }" +.br +.ti -1c +.BI "enum \fBBrushStyle\fR { NoBrush, SolidPattern, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, HorPattern, VerPattern, CrossPattern, BDiagPattern, FDiagPattern, DiagCrossPattern, CustomPattern = 24 }" +.br +.ti -1c +.BI "enum \fBMacintoshVersion\fR { MV_Unknown = 0x0000, MV_9 = 0x0001, MV_10_DOT_0 = 0x0002, MV_10_DOT_1 = 0x0003, MV_10_DOT_2 = 0x0004, MV_10_DOT_3 = 0x0005, MV_10_DOT_4 = 0x0006, MV_CHEETAH = MV_10_DOT_0, MV_PUMA = MV_10_DOT_1, MV_JAGUAR = MV_10_DOT_2, MV_PANTHER = MV_10_DOT_3, MV_TIGER = MV_10_DOT_4 }" +.br +.ti -1c +.BI "enum \fBWindowsVersion\fR { WV_32s = 0x0001, WV_95 = 0x0002, WV_98 = 0x0003, WV_Me = 0x0004, WV_DOS_based = 0x000f, WV_NT = 0x0010, WV_2000 = 0x0020, WV_XP = 0x0030, WV_2003 = 0x0040, WV_VISTA = 0x0080, WV_NT_based = 0x00f0, WV_CE = 0x0100, WV_CENET = 0x0200, WV_CE_based = 0x0f00 }" +.br +.ti -1c +.BI "enum \fBUIEffect\fR { UI_General, UI_AnimateMenu, UI_FadeMenu, UI_AnimateCombo, UI_AnimateTooltip, UI_FadeTooltip, UI_AnimateToolBox }" +.br +.ti -1c +.BI "enum \fBCursorShape\fR { ArrowCursor, UpArrowCursor, CrossCursor, WaitCursor, IbeamCursor, SizeVerCursor, SizeHorCursor, SizeBDiagCursor, SizeFDiagCursor, SizeAllCursor, BlankCursor, SplitVCursor, SplitHCursor, PointingHandCursor, ForbiddenCursor, WhatsThisCursor, BusyCursor, LastCursor = BusyCursor, BitmapCursor = 24 }" +.br +.ti -1c +.BI "enum \fBTextFormat\fR { PlainText, RichText, AutoText, LogText }" +.br +.ti -1c +.BI "enum \fBAnchorAttribute\fR { AnchorName, AnchorHref }" +.br +.ti -1c +.BI "enum \fBDock\fR { DockUnmanaged, DockTornOff, DockTop, DockBottom, DockRight, DockLeft, DockMinimized, Unmanaged = DockUnmanaged, TornOff = DockTornOff, Top = DockTop, Bottom = DockBottom, Right = DockRight, Left = DockLeft, Minimized = DockMinimized }" +.br +.ti -1c +.BI "enum \fBDateFormat\fR { TextDate, ISODate, LocalDate }" +.br +.ti -1c +.BI "enum \fBTimeSpec\fR { LocalTime, UTC }" +.br +.ti -1c +.BI "enum \fBBackgroundMode\fR { FixedColor, FixedPixmap, NoBackground, PaletteForeground, PaletteButton, PaletteLight, PaletteMidlight, PaletteDark, PaletteMid, PaletteText, PaletteBrightText, PaletteBase, PaletteBackground, PaletteShadow, PaletteHighlight, PaletteHighlightedText, PaletteButtonText, PaletteLink, PaletteLinkVisited, X11ParentRelative }" +.br +.ti -1c +.BI "enum \fBStringComparisonMode\fR { CaseSensitive = 0x00001, BeginsWith = 0x00002, EndsWith = 0x00004, Contains = 0x00008, ExactMatch = 0x00010 }" +.br +.ti -1c +.BI "enum \fBCorner\fR { TopLeft = 0x00000, TopRight = 0x00001, BottomLeft = 0x00002, BottomRight = 0x00003 }" +.br +.ti -1c +.BI "typedef void * \fBHANDLE\fR" +.br +.in -1c +.SH DESCRIPTION +The Qt class is a namespace for miscellaneous identifiers that need to be global-like. +.PP +Normally, you can ignore this class. QObject and a few other classes inherit it, so all the identifiers in the Qt namespace are normally usable without qualification. +.PP +However, you may occasionally need to say \fCQt::black\fR instead of just \fCblack\fR, particularly in static utility functions (such as many class factories). +.PP +See also Miscellaneous Classes. +.SS "Member Type Documentation" +.SH "Qt::AlignmentFlags" +This enum type is used to describe alignment. It contains horizontal and vertical flags. +.PP +The horizontal flags are: +.TP +\fCQt::AlignAuto\fR - Aligns according to the language. Left for most, right for Arabic and Hebrew. +.TP +\fCQt::AlignLeft\fR - Aligns with the left edge. +.TP +\fCQt::AlignRight\fR - Aligns with the right edge. +.TP +\fCQt::AlignHCenter\fR - Centers horizontally in the available space. +.TP +\fCQt::AlignJustify\fR - Justifies the text in the available space. Does not work for everything and may be interpreted as AlignAuto in some cases. +.PP +The vertical flags are: +.TP +\fCQt::AlignTop\fR - Aligns with the top. +.TP +\fCQt::AlignBottom\fR - Aligns with the bottom. +.TP +\fCQt::AlignVCenter\fR - Centers vertically in the available space. +.PP +You can use only one of the horizontal flags at a time. There is one two-dimensional flag: +.TP +\fCQt::AlignCenter\fR - Centers in both dimensions. +.PP +You can use at most one horizontal and one vertical flag at a time. AlignCenter counts as both horizontal and vertical. +.PP +Masks: +.TP +\fCQt::AlignHorizontal_Mask\fR +.TP +\fCQt::AlignVertical_Mask\fR +.PP +Conflicting combinations of flags have undefined meanings. +.SH "Qt::AnchorAttribute" +An anchor has one or more of the following attributes: +.TP +\fCQt::AnchorName\fR - the name attribute of the anchor. This attribute is used when scrolling to an anchor in the document. +.TP +\fCQt::AnchorHref\fR - the href attribute of the anchor. This attribute is used when a link is clicked to determine what content to load. +.SH "Qt::ArrowType" +.TP +\fCQt::UpArrow\fR +.TP +\fCQt::DownArrow\fR +.TP +\fCQt::LeftArrow\fR +.TP +\fCQt::RightArrow\fR +.SH "Qt::BGMode" +Background mode +.TP +\fCQt::TransparentMode\fR +.TP +\fCQt::OpaqueMode\fR +.SH "Qt::BackgroundMode" +This enum describes how the background of a widget changes, as the widget's palette changes. +.PP +The background is what the widget contains when paintEvent() is called. To minimize flicker, this should be the most common color or pixmap in the widget. For PaletteBackground, use colorGroup().brush( QColorGroup::Background ), and so on. +.TP +\fCQt::PaletteForeground\fR +.TP +\fCQt::PaletteBackground\fR +.TP +\fCQt::PaletteButton\fR +.TP +\fCQt::PaletteLight\fR +.TP +\fCQt::PaletteMidlight\fR +.TP +\fCQt::PaletteDark\fR +.TP +\fCQt::PaletteMid\fR +.TP +\fCQt::PaletteText\fR +.TP +\fCQt::PaletteBrightText\fR +.TP +\fCQt::PaletteButtonText\fR +.TP +\fCQt::PaletteBase\fR +.TP +\fCQt::PaletteShadow\fR +.TP +\fCQt::PaletteHighlight\fR +.TP +\fCQt::PaletteHighlightedText\fR +.TP +\fCQt::PaletteLink\fR +.TP +\fCQt::PaletteLinkVisited\fR +.TP +\fCQt::X11ParentRelative\fR - (internal use only) +.PP +The final three values have special meaning: +.TP +\fCQt::NoBackground\fR - the widget is not cleared before paintEvent(). If the widget's paint event always draws on all the pixels, using this mode can be both fast and flicker-free. +.TP +\fCQt::FixedColor\fR - the widget is cleared to a fixed color, normally different from all the ones in the palette(). Set using setPaletteBackgroundColor(). +.TP +\fCQt::FixedPixmap\fR - the widget is cleared to a fixed pixmap, normally different from all the ones in the palette(). Set using setPaletteBackgroundPixmap(). +.PP +Although FixedColor and FixedPixmap are sometimes just right, if you use them, make sure that you test your application when the desktop color scheme has been changed. (On X11, a quick way to test this is e.g. "./myapp -bg paleblue". On Windows, you must use the control panel.) +.PP +See also QWidget::backgroundMode, QWidget::backgroundMode, QWidget::setBackgroundPixmap(), and QWidget::paletteBackgroundColor. +.SH "Qt::BrushStyle" +.TP +\fCQt::NoBrush\fR +.TP +\fCQt::SolidPattern\fR +.TP +\fCQt::Dense1Pattern\fR +.TP +\fCQt::Dense2Pattern\fR +.TP +\fCQt::Dense3Pattern\fR +.TP +\fCQt::Dense4Pattern\fR +.TP +\fCQt::Dense5Pattern\fR +.TP +\fCQt::Dense6Pattern\fR +.TP +\fCQt::Dense7Pattern\fR +.TP +\fCQt::HorPattern\fR +.TP +\fCQt::VerPattern\fR +.TP +\fCQt::CrossPattern\fR +.TP +\fCQt::BDiagPattern\fR +.TP +\fCQt::FDiagPattern\fR +.TP +\fCQt::DiagCrossPattern\fR +.TP +\fCQt::CustomPattern\fR +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH "Qt::ButtonState" +This enum type describes the state of the mouse and the modifier buttons. +.TP +\fCQt::NoButton\fR - used when the button state does not refer to any button (see QMouseEvent::button()). +.TP +\fCQt::LeftButton\fR - set if the left button is pressed, or if this event refers to the left button. (The left button may be the right button on left-handed mice.) +.TP +\fCQt::RightButton\fR - the right button. +.TP +\fCQt::MidButton\fR - the middle button. +.TP +\fCQt::ShiftButton\fR - a Shift key on the keyboard is also pressed. +.TP +\fCQt::ControlButton\fR - a Ctrl key on the keyboard is also pressed. +.TP +\fCQt::AltButton\fR - an Alt key on the keyboard is also pressed. +.TP +\fCQt::MetaButton\fR - a Meta key on the keyboard is also pressed. +.TP +\fCQt::Keypad\fR - a keypad button is pressed. +.TP +\fCQt::KeyButtonMask\fR - a mask for ShiftButton, ControlButton, AltButton and MetaButton. +.TP +\fCQt::MouseButtonMask\fR - a mask for LeftButton, RightButton and MidButton. +.SH "Qt::Corner" +This enum type specifies a corner in a rectangle: +.TP +\fCQt::TopLeft\fR - top left corner +.TP +\fCQt::TopRight\fR - top right corner +.TP +\fCQt::BottomLeft\fR - bottom left corner +.TP +\fCQt::BottomRight\fR - bottom right corner +.SH "Qt::CursorShape" +This enum type defines the various cursors that can be used. +.TP +\fCQt::ArrowCursor\fR - standard arrow cursor +.TP +\fCQt::UpArrowCursor\fR - upwards arrow +.TP +\fCQt::CrossCursor\fR - crosshair +.TP +\fCQt::WaitCursor\fR - hourglass/watch +.TP +\fCQt::BusyCursor\fR - standard arrow with hourglass/watch +.TP +\fCQt::IbeamCursor\fR - ibeam/text entry +.TP +\fCQt::SizeVerCursor\fR - vertical resize +.TP +\fCQt::SizeHorCursor\fR - horizontal resize +.TP +\fCQt::SizeFDiagCursor\fR - diagonal resize (\) +.TP +\fCQt::SizeBDiagCursor\fR - diagonal resize (/) +.TP +\fCQt::SizeAllCursor\fR - all directions resize +.TP +\fCQt::BlankCursor\fR - blank/invisible cursor +.TP +\fCQt::SplitVCursor\fR - vertical splitting +.TP +\fCQt::SplitHCursor\fR - horizontal splitting +.TP +\fCQt::PointingHandCursor\fR - a pointing hand +.TP +\fCQt::ForbiddenCursor\fR - a slashed circle +.TP +\fCQt::WhatsThisCursor\fR - an arrow with a question mark +.TP +\fCQt::BitmapCursor\fR +.PP +ArrowCursor is the default for widgets in a normal state. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH "Qt::DateFormat" +.TP +\fCQt::TextDate\fR - (default) Qt format +.TP +\fCQt::ISODate\fR - ISO 8601 extended format (YYYY-MM-DD, or with time, YYYY-MM-DDTHH:MM:SS) +.TP +\fCQt::LocalDate\fR - locale dependent format +.SH "Qt::Dock" +Each dock window can be in one of the following positions: +.TP +\fCQt::DockTop\fR - above the central widget, below the menu bar. +.TP +\fCQt::DockBottom\fR - below the central widget, above the status bar. +.TP +\fCQt::DockLeft\fR - to the left of the central widget. +.TP +\fCQt::DockRight\fR - to the right of the central widget. +.TP +\fCQt::DockMinimized\fR - the dock window is not shown (this is effectively a 'hidden' dock area); the handles of all minimized dock windows are drawn in one row below the menu bar. +.TP +\fCQt::DockTornOff\fR - the dock window floats as its own top level window which always stays on top of the main window. +.TP +\fCQt::DockUnmanaged\fR - not managed by a QMainWindow. +.SH "Qt::GUIStyle" +\fBThis type is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.TP +\fCQt::WindowsStyle\fR +.TP +\fCQt::MotifStyle\fR +.TP +\fCQt::MacStyle\fR +.TP +\fCQt::Win3Style\fR +.TP +\fCQt::PMStyle\fR +.SH "Qt::ImageConversionFlags" +The conversion flag is a bitwise-OR of the following values. The options marked "(default)" are set if no other values from the list are included (since the defaults are zero): +.PP +Color/Mono preference (ignored for QBitmap) +.TP +\fCQt::AutoColor\fR - (default) - If the image has depth 1 and contains only black and white pixels, the pixmap becomes monochrome. +.TP +\fCQt::ColorOnly\fR - The pixmap is dithered/converted to the native display depth. +.TP +\fCQt::MonoOnly\fR - The pixmap becomes monochrome. If necessary, it is dithered using the chosen dithering algorithm. +.PP +Dithering mode preference for RGB channels +.TP +\fCQt::DiffuseDither\fR - (default) - A high-quality dither. +.TP +\fCQt::OrderedDither\fR - A faster, more ordered dither. +.TP +\fCQt::ThresholdDither\fR - No dithering; closest color is used. +.PP +Dithering mode preference for alpha channel +.TP +\fCQt::ThresholdAlphaDither\fR - (default) - No dithering. +.TP +\fCQt::OrderedAlphaDither\fR - A faster, more ordered dither. +.TP +\fCQt::DiffuseAlphaDither\fR - A high-quality dither. +.TP +\fCQt::NoAlpha\fR - Not supported. +.PP +Color matching versus dithering preference +.TP +\fCQt::PreferDither\fR - (default when converting to a pixmap) - Always dither 32-bit images when the image is converted to 8 bits. +.TP +\fCQt::AvoidDither\fR - (default when converting for the purpose of saving to file) - Dither 32-bit images only if the image has more than 256 colors and it is being converted to 8 bits. +.TP +\fCQt::AutoDither\fR - Not supported. +.PP +The following are not values that are used directly, but masks for the above classes: +.TP +\fCQt::ColorMode_Mask\fR - Mask for the color mode. +.TP +\fCQt::Dither_Mask\fR - Mask for the dithering mode for RGB channels. +.TP +\fCQt::AlphaDither_Mask\fR - Mask for the dithering mode for the alpha channel. +.TP +\fCQt::DitherMode_Mask\fR - Mask for the mode that determines the preference of color matching versus dithering. +.PP +Using 0 as the conversion flag sets all the default options. +.SH "Qt::Key" +The key names used by Qt. +.TP +\fCQt::Key_Escape\fR +.TP +\fCQt::Key_Tab\fR +.TP +\fCQt::Key_Backtab\fR +.TP +\fCQt::Key_Backspace\fR +.TP +\fCQt::Key_Return\fR +.TP +\fCQt::Key_Enter\fR +.TP +\fCQt::Key_Insert\fR +.TP +\fCQt::Key_Delete\fR +.TP +\fCQt::Key_Pause\fR +.TP +\fCQt::Key_Print\fR +.TP +\fCQt::Key_SysReq\fR +.TP +\fCQt::Key_Home\fR +.TP +\fCQt::Key_End\fR +.TP +\fCQt::Key_Left\fR +.TP +\fCQt::Key_Up\fR +.TP +\fCQt::Key_Right\fR +.TP +\fCQt::Key_Down\fR +.TP +\fCQt::Key_Prior\fR +.TP +\fCQt::Key_Next\fR +.TP +\fCQt::Key_Shift\fR +.TP +\fCQt::Key_Control\fR +.TP +\fCQt::Key_Meta\fR +.TP +\fCQt::Key_Alt\fR +.TP +\fCQt::Key_CapsLock\fR +.TP +\fCQt::Key_NumLock\fR +.TP +\fCQt::Key_ScrollLock\fR +.TP +\fCQt::Key_Clear\fR +.TP +\fCQt::Key_F1\fR +.TP +\fCQt::Key_F2\fR +.TP +\fCQt::Key_F3\fR +.TP +\fCQt::Key_F4\fR +.TP +\fCQt::Key_F5\fR +.TP +\fCQt::Key_F6\fR +.TP +\fCQt::Key_F7\fR +.TP +\fCQt::Key_F8\fR +.TP +\fCQt::Key_F9\fR +.TP +\fCQt::Key_F10\fR +.TP +\fCQt::Key_F11\fR +.TP +\fCQt::Key_F12\fR +.TP +\fCQt::Key_F13\fR +.TP +\fCQt::Key_F14\fR +.TP +\fCQt::Key_F15\fR +.TP +\fCQt::Key_F16\fR +.TP +\fCQt::Key_F17\fR +.TP +\fCQt::Key_F18\fR +.TP +\fCQt::Key_F19\fR +.TP +\fCQt::Key_F20\fR +.TP +\fCQt::Key_F21\fR +.TP +\fCQt::Key_F22\fR +.TP +\fCQt::Key_F23\fR +.TP +\fCQt::Key_F24\fR +.TP +\fCQt::Key_F25\fR +.TP +\fCQt::Key_F26\fR +.TP +\fCQt::Key_F27\fR +.TP +\fCQt::Key_F28\fR +.TP +\fCQt::Key_F29\fR +.TP +\fCQt::Key_F30\fR +.TP +\fCQt::Key_F31\fR +.TP +\fCQt::Key_F32\fR +.TP +\fCQt::Key_F33\fR +.TP +\fCQt::Key_F34\fR +.TP +\fCQt::Key_F35\fR +.TP +\fCQt::Key_Super_L\fR +.TP +\fCQt::Key_Super_R\fR +.TP +\fCQt::Key_Menu\fR +.TP +\fCQt::Key_Hyper_L\fR +.TP +\fCQt::Key_Hyper_R\fR +.TP +\fCQt::Key_Help\fR +.TP +\fCQt::Key_Space\fR +.TP +\fCQt::Key_Any\fR +.TP +\fCQt::Key_Exclam\fR +.TP +\fCQt::Key_QuoteDbl\fR +.TP +\fCQt::Key_NumberSign\fR +.TP +\fCQt::Key_Dollar\fR +.TP +\fCQt::Key_Percent\fR +.TP +\fCQt::Key_Ampersand\fR +.TP +\fCQt::Key_Apostrophe\fR +.TP +\fCQt::Key_ParenLeft\fR +.TP +\fCQt::Key_ParenRight\fR +.TP +\fCQt::Key_Asterisk\fR +.TP +\fCQt::Key_Plus\fR +.TP +\fCQt::Key_Comma\fR +.TP +\fCQt::Key_Minus\fR +.TP +\fCQt::Key_Period\fR +.TP +\fCQt::Key_Slash\fR +.TP +\fCQt::Key_0\fR +.TP +\fCQt::Key_1\fR +.TP +\fCQt::Key_2\fR +.TP +\fCQt::Key_3\fR +.TP +\fCQt::Key_4\fR +.TP +\fCQt::Key_5\fR +.TP +\fCQt::Key_6\fR +.TP +\fCQt::Key_7\fR +.TP +\fCQt::Key_8\fR +.TP +\fCQt::Key_9\fR +.TP +\fCQt::Key_Colon\fR +.TP +\fCQt::Key_Semicolon\fR +.TP +\fCQt::Key_Less\fR +.TP +\fCQt::Key_Equal\fR +.TP +\fCQt::Key_Greater\fR +.TP +\fCQt::Key_Question\fR +.TP +\fCQt::Key_At\fR +.TP +\fCQt::Key_A\fR +.TP +\fCQt::Key_B\fR +.TP +\fCQt::Key_C\fR +.TP +\fCQt::Key_D\fR +.TP +\fCQt::Key_E\fR +.TP +\fCQt::Key_F\fR +.TP +\fCQt::Key_G\fR +.TP +\fCQt::Key_H\fR +.TP +\fCQt::Key_I\fR +.TP +\fCQt::Key_J\fR +.TP +\fCQt::Key_K\fR +.TP +\fCQt::Key_L\fR +.TP +\fCQt::Key_M\fR +.TP +\fCQt::Key_N\fR +.TP +\fCQt::Key_O\fR +.TP +\fCQt::Key_P\fR +.TP +\fCQt::Key_Q\fR +.TP +\fCQt::Key_R\fR +.TP +\fCQt::Key_S\fR +.TP +\fCQt::Key_T\fR +.TP +\fCQt::Key_U\fR +.TP +\fCQt::Key_V\fR +.TP +\fCQt::Key_W\fR +.TP +\fCQt::Key_X\fR +.TP +\fCQt::Key_Y\fR +.TP +\fCQt::Key_Z\fR +.TP +\fCQt::Key_BracketLeft\fR +.TP +\fCQt::Key_Backslash\fR +.TP +\fCQt::Key_BracketRight\fR +.TP +\fCQt::Key_AsciiCircum\fR +.TP +\fCQt::Key_Underscore\fR +.TP +\fCQt::Key_QuoteLeft\fR +.TP +\fCQt::Key_BraceLeft\fR +.TP +\fCQt::Key_Bar\fR +.TP +\fCQt::Key_BraceRight\fR +.TP +\fCQt::Key_AsciiTilde\fR +.TP +\fCQt::Key_nobreakspace\fR +.TP +\fCQt::Key_exclamdown\fR +.TP +\fCQt::Key_cent\fR +.TP +\fCQt::Key_sterling\fR +.TP +\fCQt::Key_currency\fR +.TP +\fCQt::Key_yen\fR +.TP +\fCQt::Key_brokenbar\fR +.TP +\fCQt::Key_section\fR +.TP +\fCQt::Key_diaeresis\fR +.TP +\fCQt::Key_copyright\fR +.TP +\fCQt::Key_ordfeminine\fR +.TP +\fCQt::Key_guillemotleft\fR +.TP +\fCQt::Key_notsign\fR +.TP +\fCQt::Key_hyphen\fR +.TP +\fCQt::Key_registered\fR +.TP +\fCQt::Key_macron\fR +.TP +\fCQt::Key_degree\fR +.TP +\fCQt::Key_plusminus\fR +.TP +\fCQt::Key_twosuperior\fR +.TP +\fCQt::Key_threesuperior\fR +.TP +\fCQt::Key_acute\fR +.TP +\fCQt::Key_mu\fR +.TP +\fCQt::Key_paragraph\fR +.TP +\fCQt::Key_periodcentered\fR +.TP +\fCQt::Key_cedilla\fR +.TP +\fCQt::Key_onesuperior\fR +.TP +\fCQt::Key_masculine\fR +.TP +\fCQt::Key_guillemotright\fR +.TP +\fCQt::Key_onequarter\fR +.TP +\fCQt::Key_onehalf\fR +.TP +\fCQt::Key_threequarters\fR +.TP +\fCQt::Key_questiondown\fR +.TP +\fCQt::Key_Agrave\fR +.TP +\fCQt::Key_Aacute\fR +.TP +\fCQt::Key_Acircumflex\fR +.TP +\fCQt::Key_Atilde\fR +.TP +\fCQt::Key_Adiaeresis\fR +.TP +\fCQt::Key_Aring\fR +.TP +\fCQt::Key_AE\fR +.TP +\fCQt::Key_Ccedilla\fR +.TP +\fCQt::Key_Egrave\fR +.TP +\fCQt::Key_Eacute\fR +.TP +\fCQt::Key_Ecircumflex\fR +.TP +\fCQt::Key_Ediaeresis\fR +.TP +\fCQt::Key_Igrave\fR +.TP +\fCQt::Key_Iacute\fR +.TP +\fCQt::Key_Icircumflex\fR +.TP +\fCQt::Key_Idiaeresis\fR +.TP +\fCQt::Key_ETH\fR +.TP +\fCQt::Key_Ntilde\fR +.TP +\fCQt::Key_Ograve\fR +.TP +\fCQt::Key_Oacute\fR +.TP +\fCQt::Key_Ocircumflex\fR +.TP +\fCQt::Key_Otilde\fR +.TP +\fCQt::Key_Odiaeresis\fR +.TP +\fCQt::Key_multiply\fR +.TP +\fCQt::Key_Ooblique\fR +.TP +\fCQt::Key_Ugrave\fR +.TP +\fCQt::Key_Uacute\fR +.TP +\fCQt::Key_Ucircumflex\fR +.TP +\fCQt::Key_Udiaeresis\fR +.TP +\fCQt::Key_Yacute\fR +.TP +\fCQt::Key_THORN\fR +.TP +\fCQt::Key_ssharp\fR +.TP +\fCQt::Key_agrave\fR +.TP +\fCQt::Key_aacute\fR +.TP +\fCQt::Key_acircumflex\fR +.TP +\fCQt::Key_atilde\fR +.TP +\fCQt::Key_adiaeresis\fR +.TP +\fCQt::Key_aring\fR +.TP +\fCQt::Key_ae\fR +.TP +\fCQt::Key_ccedilla\fR +.TP +\fCQt::Key_egrave\fR +.TP +\fCQt::Key_eacute\fR +.TP +\fCQt::Key_ecircumflex\fR +.TP +\fCQt::Key_ediaeresis\fR +.TP +\fCQt::Key_igrave\fR +.TP +\fCQt::Key_iacute\fR +.TP +\fCQt::Key_icircumflex\fR +.TP +\fCQt::Key_idiaeresis\fR +.TP +\fCQt::Key_eth\fR +.TP +\fCQt::Key_ntilde\fR +.TP +\fCQt::Key_ograve\fR +.TP +\fCQt::Key_oacute\fR +.TP +\fCQt::Key_ocircumflex\fR +.TP +\fCQt::Key_otilde\fR +.TP +\fCQt::Key_odiaeresis\fR +.TP +\fCQt::Key_division\fR +.TP +\fCQt::Key_oslash\fR +.TP +\fCQt::Key_ugrave\fR +.TP +\fCQt::Key_uacute\fR +.TP +\fCQt::Key_ucircumflex\fR +.TP +\fCQt::Key_udiaeresis\fR +.TP +\fCQt::Key_yacute\fR +.TP +\fCQt::Key_thorn\fR +.TP +\fCQt::Key_ydiaeresis\fR +.PP +Multimedia keys +.TP +\fCQt::Key_Back\fR +.TP +\fCQt::Key_Forward\fR +.TP +\fCQt::Key_Stop\fR +.TP +\fCQt::Key_Refresh\fR +.TP +\fCQt::Key_VolumeDown\fR +.TP +\fCQt::Key_VolumeMute\fR +.TP +\fCQt::Key_VolumeUp\fR +.TP +\fCQt::Key_BassBoost\fR +.TP +\fCQt::Key_BassUp\fR +.TP +\fCQt::Key_BassDown\fR +.TP +\fCQt::Key_TrebleUp\fR +.TP +\fCQt::Key_TrebleDown\fR +.TP +\fCQt::Key_MediaPlay\fR +.TP +\fCQt::Key_MediaStop\fR +.TP +\fCQt::Key_MediaPrev\fR +.TP +\fCQt::Key_MediaNext\fR +.TP +\fCQt::Key_MediaRecord\fR +.TP +\fCQt::Key_HomePage\fR +.TP +\fCQt::Key_Favorites\fR +.TP +\fCQt::Key_Search\fR +.TP +\fCQt::Key_Standby\fR +.TP +\fCQt::Key_OpenUrl\fR +.TP +\fCQt::Key_LaunchMail\fR +.TP +\fCQt::Key_LaunchMedia\fR +.TP +\fCQt::Key_Launch0\fR +.TP +\fCQt::Key_Launch1\fR +.TP +\fCQt::Key_Launch2\fR +.TP +\fCQt::Key_Launch3\fR +.TP +\fCQt::Key_Launch4\fR +.TP +\fCQt::Key_Launch5\fR +.TP +\fCQt::Key_Launch6\fR +.TP +\fCQt::Key_Launch7\fR +.TP +\fCQt::Key_Launch8\fR +.TP +\fCQt::Key_Launch9\fR +.TP +\fCQt::Key_LaunchA\fR +.TP +\fCQt::Key_LaunchB\fR +.TP +\fCQt::Key_LaunchC\fR +.TP +\fCQt::Key_LaunchD\fR +.TP +\fCQt::Key_LaunchE\fR +.TP +\fCQt::Key_LaunchF\fR +.TP +\fCQt::Key_MediaLast\fR +.TP +\fCQt::Key_unknown\fR +.TP +\fCQt::Key_Direction_L\fR - internal use only +.TP +\fCQt::Key_Direction_R\fR - internal use only +.SH "Qt::MacintoshVersion" +.TP +\fCQt::MV_Unknown\fR - Version cannot be detected +.TP +\fCQt::MV_9\fR - Mac OS 9 +.TP +\fCQt::MV_10_DOT_3\fR - Mac OS X 10.3 +.TP +\fCQt::MV_10_DOT_2\fR - Mac OS X 10.2 +.TP +\fCQt::MV_10_DOT_1\fR - Mac OS X 10.1 +.TP +\fCQt::MV_10_DOT_0\fR - Mac OS X 10.0 +.TP +\fCQt::MV_10_DOT_4\fR - Mac OS X 10.4 +.TP +\fCQt::MV_CHEETAH\fR - 10.0 Codename +.TP +\fCQt::MV_PUMA\fR - 10.1 Codename +.TP +\fCQt::MV_JAGUAR\fR - 10.2 Codename +.TP +\fCQt::MV_PANTHER\fR - 10.3 Codename +.TP +\fCQt::MV_TIGER\fR - 10.4 Codename +.SH "Qt::Modifier" +This enum type describes the keyboard modifier keys supported by Qt. +.TP +\fCQt::SHIFT\fR - the Shift keys provided on all standard keyboards. +.TP +\fCQt::META\fR - the Meta keys. +.TP +\fCQt::CTRL\fR - the Ctrl keys. +.TP +\fCQt::ALT\fR - the normal Alt keys, but not e.g. AltGr. +.TP +\fCQt::MODIFIER_MASK\fR - is a mask of Shift, Ctrl, Alt and Meta. +.TP +\fCQt::UNICODE_ACCEL\fR - the accelerator is specified as a Unicode code point, not as a Qt Key. +.SH "Qt::Orientation" +This type is used to signify an object's orientation. +.TP +\fCQt::Horizontal\fR +.TP +\fCQt::Vertical\fR +.PP +Orientation is used with QScrollBar for example. +.SH "Qt::PaintUnit" +.TP +\fCQt::PixelUnit\fR +.TP +\fCQt::LoMetricUnit\fR - \fIobsolete\fR +.TP +\fCQt::HiMetricUnit\fR - \fIobsolete\fR +.TP +\fCQt::LoEnglishUnit\fR - \fIobsolete\fR +.TP +\fCQt::HiEnglishUnit\fR - \fIobsolete\fR +.TP +\fCQt::TwipsUnit\fR - \fIobsolete\fR +.SH "Qt::PenCapStyle" +This enum type defines the pen cap styles supported by Qt, i.e. the line end caps that can be drawn using QPainter. +.TP +\fCQt::FlatCap\fR - a square line end that does not cover the end point of the line. +.TP +\fCQt::SquareCap\fR - a square line end that covers the end point and extends beyond it with half the line width. +.TP +\fCQt::RoundCap\fR - a rounded line end. +.TP +\fCQt::MPenCapStyle\fR - mask of the pen cap styles. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH "Qt::PenJoinStyle" +This enum type defines the pen join styles supported by Qt, i.e. which joins between two connected lines can be drawn using QPainter. +.TP +\fCQt::MiterJoin\fR - The outer edges of the lines are extended to meet at an angle, and this area is filled. +.TP +\fCQt::BevelJoin\fR - The triangular notch between the two lines is filled. +.TP +\fCQt::RoundJoin\fR - A circular arc between the two lines is filled. +.TP +\fCQt::MPenJoinStyle\fR - mask of the pen join styles. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH "Qt::PenStyle" +This enum type defines the pen styles that can be drawn using QPainter. The styles are +.TP +\fCQt::NoPen\fR - no line at all. For example, QPainter::drawRect() fills but does not draw any boundary line. +.TP +\fCQt::SolidLine\fR - a simple line. +.TP +\fCQt::DashLine\fR - dashes separated by a few pixels. +.TP +\fCQt::DotLine\fR - dots separated by a few pixels. +.TP +\fCQt::DashDotLine\fR - alternate dots and dashes. +.TP +\fCQt::DashDotDotLine\fR - one dash, two dots, one dash, two dots. +.TP +\fCQt::MPenStyle\fR - mask of the pen styles. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH "Qt::RasterOp" +This enum type is used to describe the way things are written to the paint device. Each bit of the \fIsrc\fR (what you write) interacts with the corresponding bit of the \fIdst\fR pixel. +.TP +\fCQt::CopyROP\fR - dst = src +.TP +\fCQt::OrROP\fR - dst = src OR dst +.TP +\fCQt::XorROP\fR - dst = src XOR dst +.TP +\fCQt::NotAndROP\fR - dst = (NOT src) AND dst +.TP +\fCQt::EraseROP\fR - an alias for NotAndROP +.TP +\fCQt::NotCopyROP\fR - dst = NOT src +.TP +\fCQt::NotOrROP\fR - dst = (NOT src) OR dst +.TP +\fCQt::NotXorROP\fR - dst = (NOT src) XOR dst +.TP +\fCQt::AndROP\fR - dst = src AND dst +.TP +\fCQt::NotEraseROP\fR - an alias for AndROP +.TP +\fCQt::NotROP\fR - dst = NOT dst +.TP +\fCQt::ClearROP\fR - dst = 0 +.TP +\fCQt::SetROP\fR - dst = 1 +.TP +\fCQt::NopROP\fR - dst = dst +.TP +\fCQt::AndNotROP\fR - dst = src AND (NOT dst) +.TP +\fCQt::OrNotROP\fR - dst = src OR (NOT dst) +.TP +\fCQt::NandROP\fR - dst = NOT (src AND dst) +.TP +\fCQt::NorROP\fR - dst = NOT (src OR dst) +.PP +By far the most useful ones are CopyROP and XorROP. +.PP +On Qt/Embedded, only CopyROP, XorROP, and NotROP are supported. +.SH "Qt::SequenceMatch" +.TP +\fCQt::NoMatch\fR - Sequences have nothing in common +.TP +\fCQt::PartialMatch\fR - Sequences match partially, but are not complete +.TP +\fCQt::Identical\fR - Sequences do not differ +.SH "Qt::SortOrder" +This enum describes how the items in a widget are sorted. +.TP +\fCQt::Ascending\fR - The items are sorted ascending e.g. starts with 'AAA' ends with 'ZZZ' in Latin-1 locales +.TP +\fCQt::Descending\fR - The items are sorted descending e.g. starts with 'ZZZ' ends with 'AAA' in Latin-1 locales +.SH "Qt::StringComparisonMode" +This enum type is used to set the string comparison mode when searching for an item. It is used by QListBox, QListView and QIconView, for example. We'll refer to the string being searched as the 'target' string. +.TP +\fCQt::CaseSensitive\fR - The strings must match case sensitively. +.TP +\fCQt::ExactMatch\fR - The target and search strings must match exactly. +.TP +\fCQt::BeginsWith\fR - The target string begins with the search string. +.TP +\fCQt::EndsWith\fR - The target string ends with the search string. +.TP +\fCQt::Contains\fR - The target string contains the search string. +.PP +If you OR these flags together (excluding CaseSensitive), the search criteria be applied in the following order: ExactMatch, BeginsWith, EndsWith, Contains. +.PP +Matching is case-insensitive unless CaseSensitive is set. CaseSensitive can be OR-ed with any combination of the other flags. +.SH "Qt::TextFlags" +This enum type is used to define some modifier flags. Some of these flags only make sense in the context of printing: +.TP +\fCQt::SingleLine\fR - Treats all whitespace as spaces and prints just one line. +.TP +\fCQt::DontClip\fR - If it's impossible to stay within the given bounds, it prints outside. +.TP +\fCQt::ExpandTabs\fR - Makes the U+0009 (ASCII tab) character move to the next tab stop. +.TP +\fCQt::ShowPrefix\fR - Displays the string "&P" as <u>P</u> (see QButton for an example). For an ampersand, use "&&". +.TP +\fCQt::WordBreak\fR - Breaks lines at appropriate points, e.g. at word boundaries. +.TP +\fCQt::BreakAnywhere\fR - Breaks lines anywhere, even within words. +.TP +\fCQt::NoAccel\fR - Same as ShowPrefix but doesn't draw the underlines. +.PP +You can use as many modifier flags as you want, except that SingleLine and WordBreak cannot be combined. +.PP +Flags that are inappropriate for a given use (e.g. ShowPrefix to QGridLayout::addWidget()) are generally ignored. +.SH "Qt::TextFormat" +This enum is used in widgets that can display both plain text and rich text, e.g. QLabel. It is used for deciding whether a text string should be interpreted as one or the other. This is normally done by passing one of the enum values to a setTextFormat() function. +.TP +\fCQt::PlainText\fR - The text string is interpreted as a plain text string. +.TP +\fCQt::RichText\fR - The text string is interpreted as a rich text string using the current QStyleSheet::defaultSheet(). +.TP +\fCQt::AutoText\fR - The text string is interpreted as for RichText if QStyleSheet::mightBeRichText() returns TRUE, otherwise as PlainText. +.TP +\fCQt::LogText\fR - A special, limited text format which is only used by QTextEdit in an optimized mode. +.SH "Qt::TimeSpec" +.TP +\fCQt::LocalTime\fR - Locale dependent time (Timezones and Daylight Savings Time) +.TP +\fCQt::UTC\fR - Coordinated Universal Time, replaces Greenwich Time +.SH "Qt::UIEffect" +.TP +\fCQt::UI_General\fR +.TP +\fCQt::UI_AnimateMenu\fR +.TP +\fCQt::UI_FadeMenu\fR +.TP +\fCQt::UI_AnimateCombo\fR +.TP +\fCQt::UI_AnimateTooltip\fR +.TP +\fCQt::UI_FadeTooltip\fR +.TP +\fCQt::UI_AnimateToolBox\fR - Reserved +.SH "Qt::WidgetFlags" + +.PP +This enum type is used to specify various window-system properties for the widget. They are fairly unusual but necessary in a few cases. Some of these flags depend on whether the underlying window manager supports them. (See the toplevel example for an explanation and example of their use.) +.PP +The main types are +.TP +\fCQt::WType_TopLevel\fR - indicates that this widget is a top-level widget, usually with a window-system frame and so on. +.TP +\fCQt::WType_Dialog\fR - indicates that this widget is a top-level window that should be decorated as a dialog (i.e. typically no maximize or minimize buttons in the title bar). If you want to use it as a modal dialog it should be launched from another window, or have a parent and this flag should be combined with WShowModal. If you make it modal, the dialog will prevent other top-level windows in the application from getting any input. WType_Dialog implies WType_TopLevel. We refer to a top-level window that has a parent as a \fIsecondary\fR window. (See also WGroupLeader.) +.TP +\fCQt::WType_Popup\fR - indicates that this widget is a popup top-level window, i.e. that it is modal, but has a window system frame appropriate for popup menus. WType_Popup implies WType_TopLevel. +.TP +\fCQt::WType_Desktop\fR - indicates that this widget is the desktop. See also WPaintDesktop below. WType_Desktop implies WType_TopLevel. +.PP +There are also a number of flags which you can use to customize the appearance of top-level windows. These have no effect on other windows: +.TP +\fCQt::WStyle_Customize\fR - indicates that the \fCWStyle_*\fR flags should be used to build the window instead of the default flags. +.TP +\fCQt::WStyle_NormalBorder\fR - gives the window a normal border. This cannot be combined with WStyle_DialogBorder or WStyle_NoBorder. +.TP +\fCQt::WStyle_DialogBorder\fR - gives the window a thin dialog border. This cannot be combined with WStyle_NormalBorder or WStyle_NoBorder. +.TP +\fCQt::WStyle_NoBorder\fR - produces a borderless window. Note that the user cannot move or resize a borderless window via the window system. This cannot be combined with WStyle_NormalBorder or WStyle_DialogBorder. On Windows, the flag works fine. On X11, the result of the flag is dependent on the window manager and its ability to understand MOTIF and/or NETWM hints: most existing modern window managers can handle this. With WX11BypassWM, you can bypass the window manager completely. This results in a borderless window that is not managed at all (i.e. no keyboard input unless you call setActiveWindow() manually). +.TP +\fCQt::WStyle_NoBorderEx\fR - this value is obsolete. It has the same effect as using WStyle_NoBorder. +.TP +\fCQt::WStyle_Title\fR - gives the window a title bar. +.TP +\fCQt::WStyle_SysMenu\fR - adds a window system menu. +.TP +\fCQt::WStyle_Minimize\fR - adds a minimize button. Note that on Windows this has to be combined with WStyle_SysMenu for it to work. +.TP +\fCQt::WStyle_Maximize\fR - adds a maximize button. Note that on Windows this has to be combined with WStyle_SysMenu for it to work. +.TP +\fCQt::WStyle_MinMax\fR - is equal to \fCWStyle_Minimize|WStyle_Maximize\fR. Note that on Windows this has to be combined with WStyle_SysMenu to work. +.TP +\fCQt::WStyle_ContextHelp\fR - adds a context help button to dialogs. +.TP +\fCQt::WStyle_Tool\fR - makes the window a tool window. A tool window is often a small window with a smaller than usual title bar and decoration, typically used for collections of tool buttons. It there is a parent, the tool window will always be kept on top of it. If there isn't a parent, you may consider passing WStyle_StaysOnTop as well. If the window system supports it, a tool window can be decorated with a somewhat lighter frame. It can also be combined with WStyle_NoBorder. +.TP +\fCQt::WStyle_StaysOnTop\fR - informs the window system that the window should stay on top of all other windows. Note that on some window managers on X11 you also have to pass WX11BypassWM for this flag to work correctly. +.TP +\fCQt::WStyle_Dialog\fR - indicates that the window is a logical subwindow of its parent (i.e. a dialog). The window will not get its own taskbar entry and will be kept on top of its parent by the window system. Usually it will also be minimized when the parent is minimized. If not customized, the window is decorated with a slightly simpler title bar. This is the flag QDialog uses. +.TP +\fCQt::WStyle_Splash\fR - indicates that the window is a splash screen. On X11, we try to follow NETWM standard for a splash screen window if the window manager supports is otherwise it is equivalent to WX11BypassWM. On other platforms, it is equivalent to WStyle_NoBorder \fC|\fR WMacNoSheet \fC|\fR WStyle_Tool \fC|\fR WWinOwnDC +.PP +Modifier flags: +.TP +\fCQt::WDestructiveClose\fR - makes Qt delete this widget when the widget has accepted closeEvent(), or when the widget tried to ignore closeEvent() but could not. +.TP +\fCQt::WPaintDesktop\fR - gives this widget paint events for the desktop. +.TP +\fCQt::WPaintUnclipped\fR - makes all painters operating on this widget unclipped. Children of this widget or other widgets in front of it do not clip the area the painter can paint on. +.TP +\fCQt::WPaintClever\fR - indicates that Qt should \fInot\fR try to optimize repainting for the widget, but instead pass on window system repaint events directly. (This tends to produce more events and smaller repaint regions.) +.TP +\fCQt::WMouseNoMask\fR - indicates that even if the widget has a mask, it wants mouse events for its entire rectangle. +.TP +\fCQt::WStaticContents\fR - indicates that the widget contents are north-west aligned and static. On resize, such a widget will receive paint events only for the newly visible part of itself. +.TP +\fCQt::WNoAutoErase\fR - indicates that the widget paints all its pixels. Updating, resizing, scrolling and focus changes should therefore not erase the widget. This allows smart-repainting to avoid flicker. +.TP +\fCQt::WResizeNoErase\fR - this value is obsolete; use WNoAutoErase instead. +.TP +\fCQt::WRepaintNoErase\fR - this value is obsolete; use WNoAutoErase instead. +.TP +\fCQt::WGroupLeader\fR - makes this window a group leader. A group leader should \fInot\fR have a parent (i.e. it should be a top-level window). Any decendant windows (direct or indirect) of a group leader are in its group; other windows are not. If you show a secondary window from the group (i.e. show a window whose top-most parent is a group leader), that window will be modal with respect to the other windows in the group, but modeless with respect to windows in other groups. +.PP +Miscellaneous flags +.TP +\fCQt::WShowModal\fR - see WType_Dialog +.PP +Internal flags. +.TP +\fCQt::WNoMousePropagation\fR +.TP +\fCQt::WStaticContents\fR +.TP +\fCQt::WStyle_Reserved\fR +.TP +\fCQt::WSubWindow\fR +.TP +\fCQt::WType_Modal\fR +.TP +\fCQt::WWinOwnDC\fR +.TP +\fCQt::WX11BypassWM\fR +.TP +\fCQt::WMacNoSheet\fR +.TP +\fCQt::WMacDrawer\fR +.TP +\fCQt::WStyle_Mask\fR +.TP +\fCQt::WType_Mask\fR +.SH "Qt::WidgetState" +Internal flags. +.TP +\fCQt::WState_Created\fR +.TP +\fCQt::WState_Disabled\fR +.TP +\fCQt::WState_Visible\fR +.TP +\fCQt::WState_ForceHide\fR +.TP +\fCQt::WState_OwnCursor\fR +.TP +\fCQt::WState_MouseTracking\fR +.TP +\fCQt::WState_CompressKeys\fR +.TP +\fCQt::WState_BlockUpdates\fR +.TP +\fCQt::WState_InPaintEvent\fR +.TP +\fCQt::WState_Reparented\fR +.TP +\fCQt::WState_ConfigPending\fR +.TP +\fCQt::WState_Resized\fR +.TP +\fCQt::WState_AutoMask\fR +.TP +\fCQt::WState_Polished\fR +.TP +\fCQt::WState_DND\fR +.TP +\fCQt::WState_Reserved0\fR - \fIinternal\fR +.TP +\fCQt::WState_CreatedHidden\fR +.TP +\fCQt::WState_Maximized\fR +.TP +\fCQt::WState_Minimized\fR +.TP +\fCQt::WState_ForceDisabled\fR +.TP +\fCQt::WState_Exposed\fR +.TP +\fCQt::WState_HasMouse\fR +.TP +\fCQt::WState_CreatedHidden\fR +.TP +\fCQt::WState_OwnSizePolicy\fR +.TP +\fCQt::WState_FullScreen\fR +.SH "Qt::WindowState" + +.PP +This enum type is used to specify the current state of a top-level window. +.PP +The states are +.TP +\fCQt::WindowNoState\fR - The window has no state set (in normal state). +.TP +\fCQt::WindowMinimized\fR - The window is minimized (i.e. iconified). +.TP +\fCQt::WindowMaximized\fR - The window is maximized with a frame around it. +.TP +\fCQt::WindowFullScreen\fR - The window fills the entire screen without any frame around it. +.TP +\fCQt::WindowActive\fR - The window is the active window, i.e. it has keyboard focus. +.SH "Qt::WindowsVersion" +.TP +\fCQt::WV_32s\fR - Windows 3.1 with Win 32s +.TP +\fCQt::WV_95\fR - Windows 95 +.TP +\fCQt::WV_98\fR - Windows 98 +.TP +\fCQt::WV_Me\fR - Windows Me +.TP +\fCQt::WV_DOS_based\fR +.TP +\fCQt::WV_NT\fR - Windows NT +.TP +\fCQt::WV_2000\fR - Windows 2000 +.TP +\fCQt::WV_XP\fR - Windows XP +.TP +\fCQt::WV_2003\fR - Windows Server 2003 +.TP +\fCQt::WV_NT_based\fR +.TP +\fCQt::WV_VISTA\fR - Windows Vista +.TP +\fCQt::WV_CE\fR - Windows CE +.TP +\fCQt::WV_CENET\fR - Windows CE .NET +.TP +\fCQt::WV_CE_based\fR + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqt.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqt.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtab.3qt b/doc/man/man3/tqtab.3qt new file mode 100644 index 000000000..1cfa140b7 --- /dev/null +++ b/doc/man/man3/tqtab.3qt @@ -0,0 +1,120 @@ +'\" t +.TH QTab 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 +QTab \- The structures in a QTabBar +.SH SYNOPSIS +\fC#include <ntqtabbar.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTab\fR ()" +.br +.ti -1c +.BI "virtual \fB~QTab\fR ()" +.br +.ti -1c +.BI "\fBQTab\fR ( const QString & text )" +.br +.ti -1c +.BI "\fBQTab\fR ( const QIconSet & icon, const QString & text = QString::null )" +.br +.ti -1c +.BI "void \fBsetText\fR ( const QString & text )" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "void \fBsetIconSet\fR ( const QIconSet & icon )" +.br +.ti -1c +.BI "QIconSet * \fBiconSet\fR () const" +.br +.ti -1c +.BI "void \fBsetRect\fR ( const QRect & rect )" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "void \fBsetEnabled\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "void \fBsetIdentifier\fR ( int i )" +.br +.ti -1c +.BI "int \fBidentifier\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QTab class provides the structures in a QTabBar. +.PP +This class is used for custom QTabBar tab headings. +.PP +See also QTabBar and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTab::QTab ()" +Constructs an empty tab. All fields are set to empty. +.SH "QTab::QTab ( const QString & text )" +Constructs a tab with the text \fItext\fR. +.SH "QTab::QTab ( const QIconSet & icon, const QString & text = QString::null )" +Constructs a tab with an \fIicon\fR and the text, \fItext\fR. +.SH "QTab::~QTab ()\fC [virtual]\fR" +Destroys the tab and frees up all allocated resources. +.SH "QIconSet * QTab::iconSet () const" +Return the QIconSet of the QTab. +.SH "int QTab::identifier () const" +Return the QTab's identifier. +.SH "bool QTab::isEnabled () const" +Returns TRUE if the QTab is enabled; otherwise returns FALSE. +.SH "QRect QTab::rect () const" +Return the QRect for the QTab. +.SH "void QTab::setEnabled ( bool enable )" +If \fIenable\fR is TRUE enable the QTab, otherwise disable it. +.SH "void QTab::setIconSet ( const QIconSet & icon )" +Sets the tab's iconset to \fIicon\fR +.SH "void QTab::setIdentifier ( int i )" +Set the identifier for the QTab to \fIi\fR. Each QTab's identifier within a QTabBar must be unique. +.SH "void QTab::setRect ( const QRect & rect )" +Set the QTab QRect to \fIrect\fR. +.SH "void QTab::setText ( const QString & text )" +Sets the text of the tab to \fItext\fR. +.SH "QString QTab::text () const" +Returns the text of the QTab label. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtab.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtab.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtabbar.3qt b/doc/man/man3/tqtabbar.3qt new file mode 100644 index 000000000..686bd508b --- /dev/null +++ b/doc/man/man3/tqtabbar.3qt @@ -0,0 +1,332 @@ +'\" t +.TH QTabBar 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 +QTabBar \- Tab bar, e.g. for use in tabbed dialogs +.SH SYNOPSIS +\fC#include <ntqtabbar.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTabBar\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QTabBar\fR ()" +.br +.ti -1c +.BI "enum \fBShape\fR { RoundedAbove, RoundedBelow, TriangularAbove, TriangularBelow }" +.br +.ti -1c +.BI "Shape \fBshape\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetShape\fR ( Shape )" +.br +.ti -1c +.BI "virtual int \fBaddTab\fR ( QTab * newTab )" +.br +.ti -1c +.BI "virtual int \fBinsertTab\fR ( QTab * newTab, int index = -1 )" +.br +.ti -1c +.BI "virtual void \fBremoveTab\fR ( QTab * t )" +.br +.ti -1c +.BI "virtual void \fBsetTabEnabled\fR ( int id, bool enabled )" +.br +.ti -1c +.BI "bool \fBisTabEnabled\fR ( int id ) const" +.br +.ti -1c +.BI "int \fBcurrentTab\fR () const" +.br +.ti -1c +.BI "int \fBkeyboardFocusTab\fR () const" +.br +.ti -1c +.BI "QTab * \fBtab\fR ( int id ) const" +.br +.ti -1c +.BI "QTab * \fBtabAt\fR ( int index ) const" +.br +.ti -1c +.BI "int \fBindexOf\fR ( int id ) const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "virtual void \fBlayoutTabs\fR ()" +.br +.ti -1c +.BI "virtual QTab * \fBselectTab\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "void \fBremoveToolTip\fR ( int index )" +.br +.ti -1c +.BI "void \fBsetToolTip\fR ( int index, const QString & tip )" +.br +.ti -1c +.BI "QString \fBtoolTip\fR ( int index ) const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetCurrentTab\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBsetCurrentTab\fR ( QTab * tab )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBselected\fR ( int id )" +.br +.ti -1c +.BI "void \fBlayoutChanged\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBcount\fR - the number of tabs in the tab bar \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcurrentTab\fR - the id of the tab bar's visible tab" +.br +.ti -1c +.BI "int \fBkeyboardFocusTab\fR - the id of the tab that has the keyboard focus \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "Shape \fBshape\fR - the shape of the tabs in the tab bar" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * p, QTab * t, bool selected ) const" +.br +.ti -1c +.BI "virtual void \fBpaintLabel\fR ( QPainter * p, const QRect & br, QTab * t, bool has_focus ) const" +.br +.ti -1c +.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * e )" +.br +.ti -1c +.BI "QPtrList<QTab> * \fBtabList\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs. +.PP +QTabBar is straightforward to use; it draws the tabs using one of the predefined shapes, and emits a signal when a tab is selected. It can be subclassed to tailor the look and feel. Qt also provides a ready-made QTabWidget and a QTabDialog. +.PP +The choice of tab shape is a matter of taste, although tab dialogs (for preferences and similar) invariably use RoundedAbove; nobody uses TriangularAbove. Tab controls in windows other than dialogs almost always use either RoundedBelow or TriangularBelow. Many spreadsheets and other tab controls in which all the pages are essentially similar use TriangularBelow, whereas RoundedBelow is used mostly when the pages are different (e.g. a multi-page tool palette). +.PP +The most important part of QTabBar's API is the selected() signal. This is emitted whenever the selected page changes (even at startup, when the selected page changes from 'none'). There is also a slot, setCurrentTab(), which can be used to select a page programmatically. +.PP +QTabBar creates automatic accelerator keys in the manner of QButton; e.g. if a tab's label is "&Graphics", Alt+G becomes an accelerator key for switching to that tab. +.PP +The following virtual functions may need to be reimplemented: +.TP +paint() paints a single tab. paintEvent() calls paint() for each tab so that any overlap will look right. +.TP +addTab() creates a new tab and adds it to the bar. +.TP +selectTab() decides which tab, if any, the user selects with the mouse. +.PP +The index of the current tab is returned by currentTab(). The tab with a particular index is returned by tabAt(), the tab with a particular id is returned by tab(). The index of a tab is returned by indexOf(). The current tab can be set by index or tab pointer using one of the setCurrentTab() functions. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also Advanced Widgets. +.SS "Member Type Documentation" +.SH "QTabBar::Shape" +This enum type lists the built-in shapes supported by QTabBar: +.TP +\fCQTabBar::RoundedAbove\fR - the normal rounded look above the pages +.TP +\fCQTabBar::RoundedBelow\fR - the normal rounded look below the pages +.TP +\fCQTabBar::TriangularAbove\fR - triangular tabs above the pages (very unusual; included for completeness) +.TP +\fCQTabBar::TriangularBelow\fR - triangular tabs similar to those used in the Excel spreadsheet, for example +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTabBar::QTabBar ( QWidget * parent = 0, const char * name = 0 )" +Constructs a new, empty tab bar; the \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. +.SH "QTabBar::~QTabBar ()" +Destroys the tab control, freeing memory used. +.SH "int QTabBar::addTab ( QTab * newTab )\fC [virtual]\fR" +Adds the tab, \fInewTab\fR, to the tab control. +.PP +Sets \fInewTab\fR's id to a new id and places the tab just to the right of the existing tabs. If the tab's label contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. Returns the id. +.PP +See also insertTab(). +.SH "int QTabBar::count () const" +Returns the number of tabs in the tab bar. See the "count" property for details. +.SH "int QTabBar::currentTab () const" +Returns the id of the tab bar's visible tab. See the "currentTab" property for details. +.SH "int QTabBar::indexOf ( int id ) const" +Returns the position index of the tab with id \fIid\fR or -1 if no tab has this \fIid\fR. +.PP +See also tabAt(). +.SH "int QTabBar::insertTab ( QTab * newTab, int index = -1 )\fC [virtual]\fR" +Inserts the tab, \fInewTab\fR, into the tab control. +.PP +If \fIindex\fR is not specified, the tab is simply appended. Otherwise it's inserted at the specified position. +.PP +Sets \fInewTab\fR's id to a new id. If the tab's label contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. Returns the id. +.PP +See also addTab(). +.SH "bool QTabBar::isTabEnabled ( int id ) const" +Returns TRUE if the tab with id \fIid\fR exists and is enabled; otherwise returns FALSE. +.PP +See also setTabEnabled(). +.SH "int QTabBar::keyboardFocusTab () const" +Returns the id of the tab that has the keyboard focus. See the "keyboardFocusTab" property for details. +.SH "void QTabBar::layoutChanged ()\fC [signal]\fR" +QTabBar emits the signal whenever the layout of the tab bar has been recalculated, for example when the contents of a tab change. +.SH "void QTabBar::layoutTabs ()\fC [virtual]\fR" +Lays out all existing tabs according to their label and their iconset. +.SH "void QTabBar::paint ( QPainter * p, QTab * t, bool selected ) const\fC [virtual protected]\fR" +Paints the tab \fIt\fR using painter \fIp\fR. If and only if \fIselected\fR is TRUE, \fIt\fR is drawn currently selected. +.PP +This virtual function may be reimplemented to change the look of QTabBar. If you decide to reimplement it, you may also need to reimplement sizeHint(). +.SH "void QTabBar::paintEvent ( QPaintEvent * e )\fC [virtual protected]\fR" +Repaints the tab row. All the painting is done by paint(); paintEvent() only decides which tabs need painting and in what order. The event is passed in \fIe\fR. +.PP +See also paint(). +.PP +Reimplemented from QWidget. +.SH "void QTabBar::paintLabel ( QPainter * p, const QRect & br, QTab * t, bool has_focus ) const\fC [virtual protected]\fR" +Paints the label of tab \fIt\fR centered in rectangle \fIbr\fR using painter \fIp\fR. A focus indication is drawn if \fIhas_focus\fR is TRUE. +.SH "void QTabBar::removeTab ( QTab * t )\fC [virtual]\fR" +Removes tab \fIt\fR from the tab control, and deletes the tab. +.SH "void QTabBar::removeToolTip ( int index )" +Removes the tool tip for the tab at index position \fIindex\fR. +.SH "QTab * QTabBar::selectTab ( const QPoint & p ) const\fC [virtual]\fR" +This virtual function is called by the mouse event handlers to determine which tab is pressed. The default implementation returns a pointer to the tab whose bounding rectangle contains \fIp\fR, if exactly one tab's bounding rectangle contains \fIp\fR. Otherwise it returns 0. +.PP +See also mousePressEvent() and mouseReleaseEvent(). +.SH "void QTabBar::selected ( int id )\fC [signal]\fR" +QTabBar emits this signal whenever any tab is selected, whether by the program or by the user. The argument \fIid\fR is the id of the tab as returned by addTab(). +.PP +show() is guaranteed to emit this signal; you can display your page in a slot connected to this signal. +.SH "void QTabBar::setCurrentTab ( int )\fC [virtual slot]\fR" +Sets the id of the tab bar's visible tab. See the "currentTab" property for details. +.SH "void QTabBar::setCurrentTab ( QTab * tab )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Raises \fItab\fR and emits the selected() signal unless the tab was already current. +.PP +See also currentTab and selected(). +.SH "void QTabBar::setShape ( Shape )\fC [virtual]\fR" +Sets the shape of the tabs in the tab bar. See the "shape" property for details. +.SH "void QTabBar::setTabEnabled ( int id, bool enabled )\fC [virtual]\fR" +Enables tab \fIid\fR if \fIenabled\fR is TRUE or disables it if \fIenabled\fR is FALSE. If \fIid\fR is currently selected, setTabEnabled(FALSE) makes another tab selected. +.PP +setTabEnabled() updates the display if this causes a change in \fIid\fR's status. +.PP +See also update() and isTabEnabled(). +.SH "void QTabBar::setToolTip ( int index, const QString & tip )" +Sets the tool tip for the tab at index position \fIindex\fR to \fItip\fR. +.SH "Shape QTabBar::shape () const" +Returns the shape of the tabs in the tab bar. See the "shape" property for details. +.SH "QTab * QTabBar::tab ( int id ) const" +Returns the tab with id \fIid\fR or 0 if there is no such tab. +.PP +See also count. +.SH "QTab * QTabBar::tabAt ( int index ) const" +Returns the tab at position \fIindex\fR. +.PP +See also indexOf(). +.SH "QPtrList<QTab> * QTabBar::tabList ()\fC [protected]\fR" +The list of QTab objects in the tab bar. +.PP +This list is unlikely to be in the order that the QTab elements appear visually. One way of iterating over the tabs is like this: +.PP +.nf +.br + for ( uint i = 0; i < myTabBar->count(); ++i ) { +.br + nextTab = myTabBar->tabAt( i ); +.br + // do something with nextTab +.br + } +.br +.fi +.SH "QString QTabBar::toolTip ( int index ) const" +Returns the tool tip for the tab at index position \fIindex\fR. +.SS "Property Documentation" +.SH "int count" +This property holds the number of tabs in the tab bar. +.PP +Get this property's value with count(). +.PP +See also tab(). +.SH "int currentTab" +This property holds the id of the tab bar's visible tab. +.PP +If no tab page is currently visible, the property's value is -1. Even if the property's value is not -1, you cannot assume that the user can see the relevant page, or that the tab is enabled. When you need to display something the value of this property represents the best page to display. +.PP +When this property is set to \fIid\fR, it will raise the tab with the id \fIid\fR and emit the selected() signal. +.PP +See also selected() and isTabEnabled(). +.PP +Set this property's value with setCurrentTab() and get this property's value with currentTab(). +.SH "int keyboardFocusTab" +This property holds the id of the tab that has the keyboard focus. +.PP +This property contains the id of the tab that has the keyboard focus or -1 if the tab bar does not have the keyboard focus. +.PP +Get this property's value with keyboardFocusTab(). +.SH "Shape shape" +This property holds the shape of the tabs in the tab bar. +.PP +The value of this property is one of the following: RoundedAbove (default), RoundedBelow, TriangularAbove or TriangularBelow. +.PP +See also Shape. +.PP +Set this property's value with setShape() and get this property's value with shape(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtabbar.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtabbar.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtabdialog.3qt b/doc/man/man3/tqtabdialog.3qt new file mode 100644 index 000000000..e09c92413 --- /dev/null +++ b/doc/man/man3/tqtabdialog.3qt @@ -0,0 +1,464 @@ +'\" t +.TH QTabDialog 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 +QTabDialog \- Stack of tabbed widgets +.SH SYNOPSIS +\fC#include <ntqtabdialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTabDialog\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QTabDialog\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetFont\fR ( const QFont & font )" +.br +.ti -1c +.BI "void \fBaddTab\fR ( QWidget * child, const QString & label )" +.br +.ti -1c +.BI "void \fBaddTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label )" +.br +.ti -1c +.BI "void \fBaddTab\fR ( QWidget * child, QTab * tab )" +.br +.ti -1c +.BI "void \fBinsertTab\fR ( QWidget * child, const QString & label, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )" +.br +.ti -1c +.BI "void \fBinsertTab\fR ( QWidget * child, QTab * tab, int index = -1 )" +.br +.ti -1c +.BI "void \fBchangeTab\fR ( QWidget * w, const QString & label )" +.br +.ti -1c +.BI "void \fBchangeTab\fR ( QWidget * w, const QIconSet & iconset, const QString & label )" +.br +.ti -1c +.BI "bool \fBisTabEnabled\fR ( QWidget * w ) const" +.br +.ti -1c +.BI "void \fBsetTabEnabled\fR ( QWidget * w, bool enable )" +.br +.ti -1c +.BI "bool isTabEnabled ( const char * name ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setTabEnabled ( const char * name, bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBshowPage\fR ( QWidget * w )" +.br +.ti -1c +.BI "void \fBremovePage\fR ( QWidget * w )" +.br +.ti -1c +.BI "QString \fBtabLabel\fR ( QWidget * w )" +.br +.ti -1c +.BI "QWidget * \fBcurrentPage\fR () const" +.br +.ti -1c +.BI "void \fBsetDefaultButton\fR ( const QString & text )" +.br +.ti -1c +.BI "void \fBsetDefaultButton\fR ()" +.br +.ti -1c +.BI "bool \fBhasDefaultButton\fR () const" +.br +.ti -1c +.BI "void \fBsetHelpButton\fR ( const QString & text )" +.br +.ti -1c +.BI "void \fBsetHelpButton\fR ()" +.br +.ti -1c +.BI "bool \fBhasHelpButton\fR () const" +.br +.ti -1c +.BI "void \fBsetCancelButton\fR ( const QString & text )" +.br +.ti -1c +.BI "void \fBsetCancelButton\fR ()" +.br +.ti -1c +.BI "bool \fBhasCancelButton\fR () const" +.br +.ti -1c +.BI "void \fBsetApplyButton\fR ( const QString & text )" +.br +.ti -1c +.BI "void \fBsetApplyButton\fR ()" +.br +.ti -1c +.BI "bool \fBhasApplyButton\fR () const" +.br +.ti -1c +.BI "void \fBsetOkButton\fR ( const QString & text )" +.br +.ti -1c +.BI "void \fBsetOkButton\fR ()" +.br +.ti -1c +.BI "bool \fBhasOkButton\fR () const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBaboutToShow\fR ()" +.br +.ti -1c +.BI "void \fBapplyButtonPressed\fR ()" +.br +.ti -1c +.BI "void \fBcancelButtonPressed\fR ()" +.br +.ti -1c +.BI "void \fBdefaultButtonPressed\fR ()" +.br +.ti -1c +.BI "void \fBhelpButtonPressed\fR ()" +.br +.ti -1c +.BI "void \fBcurrentChanged\fR ( QWidget * )" +.br +.ti -1c +.BI "void selected ( const QString & ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsetTabBar\fR ( QTabBar * tb )" +.br +.ti -1c +.BI "QTabBar * \fBtabBar\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QTabDialog class provides a stack of tabbed widgets. +.PP +A tabbed dialog is one in which several "tab pages" are available. By clicking on a tab page's tab or by pressing the indicated Alt+\fIletter\fR key combination, the user can select which tab page they want to use. +.PP +QTabDialog provides a tab bar consisting of single row of tabs at the top; each tab has an associated widget which is that tab's tab page. In addition, QTabDialog provides an OK button and the following optional buttons: Apply, Cancel, Defaults and Help. +.PP +The normal way to use QTabDialog is to do the following in the constructor: <ol type=1> +.IP 1 +Create a QTabDialog. +.IP 2 +Create a QWidget for each of the pages in the tab dialog, insert children into it, set up geometry management for it, and use addTab() (or insertTab()) to set up a tab and keyboard accelerator for it. +.IP 3 +Set up the buttons for the tab dialog using setOkButton(), setApplyButton(), setDefaultsButton(), setCancelButton() and setHelpButton(). +.IP 4 +Connect to the signals and slots. +.PP +If you don't call addTab() the page you have created will not be visible. Don't confuse the object name you supply to the QWidget constructor and the tab label you supply to addTab(); addTab() takes user-visible name that appears on the widget's tab and may identify an accelerator, whereas the widget name is used primarily for debugging. +.PP +Almost all applications have to connect the applyButtonPressed() signal to something. applyButtonPressed() is emitted when either OK or Apply is clicked, and your slot must copy the dialog's state into the application. +.PP +There are also several other signals which may be useful: +.TP +cancelButtonPressed() is emitted when the user clicks Cancel. +.TP +defaultButtonPressed() is emitted when the user clicks Defaults; the slot it is connected to should reset the state of the dialog to the application defaults. +.TP +helpButtonPressed() is emitted when the user clicks Help. +.TP +aboutToShow() is emitted at the start of show(); if there is any chance that the state of the application may change between the creation of the tab dialog and the time show() is called, you must connect this signal to a slot that resets the state of the dialog. +.TP +currentChanged() is emitted when the user selects a page. +.PP +Each tab is either enabled or disabled at any given time (see setTabEnabled()). If a tab is enabled the tab text is drawn in black and the user can select that tab. If it is disabled the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible; for example, if all of the tabs happen to be disabled. +.PP +You can change a tab's label and iconset using changeTab(). A tab page can be removed with removePage() and shown with showPage(). The current page is given by currentPage(). +.PP +QTabDialog does not support tabs on the sides or bottom, nor can you set or retrieve the visible page. If you need more functionality than QTabDialog provides, consider creating a QDialog and using a QTabBar with QTabWidgets. +.PP +Most of the functionality in QTabDialog is provided by a QTabWidget. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QDialog and Dialog Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTabDialog::QTabDialog ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +Constructs a QTabDialog with only an OK button. The \fIparent\fR, \fIname\fR, \fImodal\fR and widget flag, \fIf\fR, arguments are passed on to the QDialog constructor. +.SH "QTabDialog::~QTabDialog ()" +Destroys the tab dialog. +.SH "void QTabDialog::aboutToShow ()\fC [signal]\fR" +This signal is emitted by show() when it is time to set the state of the dialog's contents. The dialog should reflect the current state of the application when it appears; if there is any possibility that the state of the application may change between the time you call QTabDialog::QTabDialog() and QTabDialog::show(), you should set the dialog's state in a slot and connect this signal to it. +.PP +This applies mainly to QTabDialog objects that are kept around hidden, rather than being created, shown, and deleted afterwards. +.PP +See also applyButtonPressed(), show(), and cancelButtonPressed(). +.SH "void QTabDialog::addTab ( QWidget * child, const QString & label )" +Adds another tab and page to the tab view. +.PP +The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. +.PP +If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. +.PP +If you call addTab() after show() the screen will flicker and the user may be confused. +.PP +See also insertTab(). +.SH "void QTabDialog::addTab ( QWidget * child, const QIconSet & iconset, const QString & label )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version of the function shows the \fIiconset\fR as well as the \fIlabel\fR on the tab of \fIchild\fR. +.SH "void QTabDialog::addTab ( QWidget * child, QTab * tab )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is a lower-level method for adding tabs, similar to the other addTab() method. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. +.PP +The \fIchild\fR is the widget to be placed on the new tab page. The \fItab\fR is the tab to display on the tab page -- normally this shows a label or an icon that identifies the tab page. +.SH "void QTabDialog::applyButtonPressed ()\fC [signal]\fR" +This signal is emitted when either the Apply or OK button is clicked. +.PP +It should be connected to a slot (or several slots) that change the application's state according to the state of the dialog. +.PP +See also cancelButtonPressed(), defaultButtonPressed(), and setApplyButton(). +.SH "void QTabDialog::cancelButtonPressed ()\fC [signal]\fR" +This signal is emitted when the Cancel button is clicked. It is automatically connected to QDialog::reject(), which will hide the dialog. +.PP +The Cancel button should not change the application's state at all, so you should generally not need to connect it to any slot. +.PP +See also applyButtonPressed(), defaultButtonPressed(), and setCancelButton(). +.SH "void QTabDialog::changeTab ( QWidget * w, const QIconSet & iconset, const QString & label )" +Changes tab page \fIw\fR's iconset to \fIiconset\fR and label to \fIlabel\fR. +.SH "void QTabDialog::changeTab ( QWidget * w, const QString & label )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Defines a new \fIlabel\fR for the tab of page \fIw\fR +.SH "void QTabDialog::currentChanged ( QWidget * )\fC [signal]\fR" +This signal is emitted whenever the current page changes. +.PP +See also currentPage(), showPage(), and tabLabel(). +.SH "QWidget * QTabDialog::currentPage () const" +Returns a pointer to the page currently being displayed by the tab dialog. The tab dialog does its best to make sure that this value is never 0 (but if you try hard enough, it can be). +.SH "void QTabDialog::defaultButtonPressed ()\fC [signal]\fR" +This signal is emitted when the Defaults button is pressed. It should reset the dialog (but not the application) to the "factory defaults". +.PP +The application's state should not be changed until the user clicks Apply or OK. +.PP +See also applyButtonPressed(), cancelButtonPressed(), and setDefaultButton(). +.SH "bool QTabDialog::hasApplyButton () const" +Returns TRUE if the tab dialog has an Apply button; otherwise returns FALSE. +.PP +See also setApplyButton(), applyButtonPressed(), hasCancelButton(), and hasDefaultButton(). +.SH "bool QTabDialog::hasCancelButton () const" +Returns TRUE if the tab dialog has a Cancel button; otherwise returns FALSE. +.PP +See also setCancelButton(), cancelButtonPressed(), hasApplyButton(), and hasDefaultButton(). +.SH "bool QTabDialog::hasDefaultButton () const" +Returns TRUE if the tab dialog has a Defaults button; otherwise returns FALSE. +.PP +See also setDefaultButton(), defaultButtonPressed(), hasApplyButton(), and hasCancelButton(). +.SH "bool QTabDialog::hasHelpButton () const" +Returns TRUE if the tab dialog has a Help button; otherwise returns FALSE. +.PP +See also setHelpButton(), helpButtonPressed(), hasApplyButton(), and hasCancelButton(). +.SH "bool QTabDialog::hasOkButton () const" +Returns TRUE if the tab dialog has an OK button; otherwise returns FALSE. +.PP +See also setOkButton(), hasApplyButton(), hasCancelButton(), and hasDefaultButton(). +.SH "void QTabDialog::helpButtonPressed ()\fC [signal]\fR" +This signal is emitted when the Help button is pressed. It could be used to present information about how to use the dialog. +.PP +See also applyButtonPressed(), cancelButtonPressed(), and setHelpButton(). +.SH "void QTabDialog::insertTab ( QWidget * child, const QString & label, int index = -1 )" +Inserts another tab and page to the tab view. +.PP +The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. +.PP +If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. +.PP +If \fIindex\fR is not specified, the tab is simply added. Otherwise it is inserted at the specified position. +.PP +If you call insertTab() after show(), the screen will flicker and the user may be confused. +.PP +See also addTab(). +.SH "void QTabDialog::insertTab ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version of the function shows the \fIiconset\fR as well as the \fIlabel\fR on the tab of \fIchild\fR. +.SH "void QTabDialog::insertTab ( QWidget * child, QTab * tab, int index = -1 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is a lower-level method for inserting tabs, similar to the other insertTab() method. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. +.PP +The \fIchild\fR is the widget to be placed on the new tab page. The \fItab\fR is the tab to display on the tab page -- normally this shows a label or an icon that identifies the tab page. The \fIindex\fR is the position where this tab page should be inserted. +.SH "bool QTabDialog::isTabEnabled ( QWidget * w ) const" +Returns TRUE if the page \fIw\fR is enabled; otherwise returns FALSE. +.PP +See also setTabEnabled() and QWidget::enabled. +.SH "bool QTabDialog::isTabEnabled ( const char * name ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns TRUE if the page with object name \fIname\fR is enabled and FALSE if it is disabled. +.PP +If \fIname\fR is 0 or not the name of any of the pages, isTabEnabled() returns FALSE. +.PP +See also setTabEnabled() and QWidget::enabled. +.SH "void QTabDialog::removePage ( QWidget * w )" +Removes page \fIw\fR from this stack of widgets. Does not delete \fIw\fR. +.PP +See also showPage(), QTabWidget::removePage(), and QWidgetStack::removeWidget(). +.SH "void QTabDialog::selected ( const QString & )\fC [signal]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This signal is emitted whenever a tab is selected (raised), including during the first show(). +.PP +See also raise(). +.SH "void QTabDialog::setApplyButton ( const QString & text )" +Adds an Apply button to the dialog. The button's text is set to \fItext\fR. +.PP +The Apply button should apply the current settings in the dialog box to the application while keeping the dialog visible. +.PP +When Apply is clicked, the applyButtonPressed() signal is emitted. +.PP +If \fItext\fR is a null string, no button is shown. +.PP +See also setCancelButton(), setDefaultButton(), and applyButtonPressed(). +.SH "void QTabDialog::setApplyButton ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds an Apply button to the dialog. The button's text is set to a localizable "Apply". +.SH "void QTabDialog::setCancelButton ( const QString & text )" +Adds a Cancel button to the dialog. The button's text is set to \fItext\fR. +.PP +The cancel button should always return the application to the state it was in before the tab view popped up, or if the user has clicked Apply, back to the state immediately after the last Apply. +.PP +When Cancel is clicked, the cancelButtonPressed() signal is emitted. The dialog is closed at the same time. +.PP +If \fItext\fR is a null string, no button is shown. +.PP +See also setApplyButton(), setDefaultButton(), and cancelButtonPressed(). +.SH "void QTabDialog::setCancelButton ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a Cancel button to the dialog. The button's text is set to a localizable "Cancel". +.SH "void QTabDialog::setDefaultButton ( const QString & text )" +Adds a Defaults button to the dialog. The button's text is set to \fItext\fR. +.PP +The Defaults button should set the dialog (but not the application) back to the application defaults. +.PP +When Defaults is clicked, the defaultButtonPressed() signal is emitted. +.PP +If \fItext\fR is a null string, no button is shown. +.PP +See also setApplyButton(), setCancelButton(), and defaultButtonPressed(). +.SH "void QTabDialog::setDefaultButton ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a Defaults button to the dialog. The button's text is set to a localizable "Defaults". +.SH "void QTabDialog::setFont ( const QFont & font )\fC [virtual]\fR" +Sets the font for the tabs to \fIfont\fR. +.PP +If the widget is visible, the display is updated with the new font immediately. There may be some geometry changes, depending on the size of the old and new fonts. +.PP +Reimplemented from QWidget. +.SH "void QTabDialog::setHelpButton ( const QString & text )" +Adds a Help button to the dialog. The button's text is set to \fItext\fR. +.PP +When Help is clicked, the helpButtonPressed() signal is emitted. +.PP +If \fItext\fR is a null string, no button is shown. +.PP +See also setApplyButton(), setCancelButton(), and helpButtonPressed(). +.SH "void QTabDialog::setHelpButton ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a Help button to the dialog. The button's text is set to a localizable "Help". +.SH "void QTabDialog::setOkButton ( const QString & text )" +Adds an OK button to the dialog and sets the button's text to \fItext\fR. +.PP +When the OK button is clicked, the applyButtonPressed() signal is emitted, and the current settings in the dialog box should be applied to the application. The dialog then closes. +.PP +If \fItext\fR is a null string, no button is shown. +.PP +See also setCancelButton(), setDefaultButton(), and applyButtonPressed(). +.SH "void QTabDialog::setOkButton ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds an OK button to the dialog. The button's text is set to a localizable "OK". +.SH "void QTabDialog::setTabBar ( QTabBar * tb )\fC [protected]\fR" +Replaces the QTabBar heading the dialog by the given tab bar, \fItb\fR. Note that this must be called \fIbefore\fR any tabs have been added, or the behavior is undefined. +.PP +See also tabBar(). +.SH "void QTabDialog::setTabEnabled ( QWidget * w, bool enable )" +If \fIenable\fR is TRUE the page \fIw\fR is enabled; otherwise \fIw\fR is disabled. The page's tab is redrawn appropriately. +.PP +QTabWidget uses QWidget::setEnabled() internally, rather than keeping a separate flag. +.PP +Note that even a disabled tab and tab page may be visible. If the page is already visible QTabWidget will not hide it; if all the pages are disabled QTabWidget will show one of them. +.PP +See also isTabEnabled() and QWidget::enabled. +.SH "void QTabDialog::setTabEnabled ( const char * name, bool enable )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Finds the page with object name \fIname\fR, enables/disables it according to the value of \fIenable\fR and redraws the page's tab appropriately. +.PP +QTabDialog uses QWidget::setEnabled() internally, rather than keeping a separate flag. +.PP +Note that even a disabled tab/page may be visible. If the page is already visible QTabDialog will not hide it; if all the pages are disabled QTabDialog will show one of them. +.PP +The object name is used (rather than the tab label) because the tab text may not be invariant in multi-language applications. +.PP +See also isTabEnabled() and QWidget::enabled. +.SH "void QTabDialog::showPage ( QWidget * w )" +Ensures that widget \fIw\fR is shown. This is mainly useful for accelerators. +.PP +\fBWarning:\fR If used carelessly, this function can easily surprise or confuse the user. +.PP +See also QTabBar::currentTab. +.SH "QTabBar * QTabDialog::tabBar () const\fC [protected]\fR" +Returns the currently set QTabBar. +.PP +See also setTabBar(). +.SH "QString QTabDialog::tabLabel ( QWidget * w )" +Returns the text in the tab for page \fIw\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtabdialog.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtabdialog.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtable.3qt b/doc/man/man3/tqtable.3qt new file mode 100644 index 000000000..5357bbd2a --- /dev/null +++ b/doc/man/man3/tqtable.3qt @@ -0,0 +1,1382 @@ +'\" t +.TH QTable 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 +QTable \- Flexible editable table widget +.SH SYNOPSIS +\fC#include <ntqtable.h>\fR +.PP +Inherits QScrollView. +.PP +Inherited by QDataTable. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTable\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQTable\fR ( int numRows, int numCols, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QTable\fR ()" +.br +.ti -1c +.BI "QHeader * \fBhorizontalHeader\fR () const" +.br +.ti -1c +.BI "QHeader * \fBverticalHeader\fR () const" +.br +.ti -1c +.BI "enum \fBSelectionMode\fR { Single, Multi, SingleRow, MultiRow, NoSelection }" +.br +.ti -1c +.BI "virtual void \fBsetSelectionMode\fR ( SelectionMode mode )" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetItem\fR ( int row, int col, QTableItem * item )" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( int row, int col, const QString & text )" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( int row, int col, const QPixmap & pix )" +.br +.ti -1c +.BI "virtual QTableItem * \fBitem\fR ( int row, int col ) const" +.br +.ti -1c +.BI "virtual QString \fBtext\fR ( int row, int col ) const" +.br +.ti -1c +.BI "virtual QPixmap \fBpixmap\fR ( int row, int col ) const" +.br +.ti -1c +.BI "virtual void \fBclearCell\fR ( int row, int col )" +.br +.ti -1c +.BI "virtual QRect \fBcellGeometry\fR ( int row, int col ) const" +.br +.ti -1c +.BI "virtual int \fBcolumnWidth\fR ( int col ) const" +.br +.ti -1c +.BI "virtual int \fBrowHeight\fR ( int row ) const" +.br +.ti -1c +.BI "virtual int \fBcolumnPos\fR ( int col ) const" +.br +.ti -1c +.BI "virtual int \fBrowPos\fR ( int row ) const" +.br +.ti -1c +.BI "virtual int \fBcolumnAt\fR ( int x ) const" +.br +.ti -1c +.BI "virtual int \fBrowAt\fR ( int y ) const" +.br +.ti -1c +.BI "virtual int \fBnumRows\fR () const" +.br +.ti -1c +.BI "virtual int \fBnumCols\fR () const" +.br +.ti -1c +.BI "void \fBupdateCell\fR ( int row, int col )" +.br +.ti -1c +.BI "int \fBcurrentRow\fR () const" +.br +.ti -1c +.BI "int \fBcurrentColumn\fR () const" +.br +.ti -1c +.BI "void \fBensureCellVisible\fR ( int row, int col )" +.br +.ti -1c +.BI "bool \fBisSelected\fR ( int row, int col ) const" +.br +.ti -1c +.BI "bool \fBisRowSelected\fR ( int row, bool full = FALSE ) const" +.br +.ti -1c +.BI "bool \fBisColumnSelected\fR ( int col, bool full = FALSE ) const" +.br +.ti -1c +.BI "int \fBnumSelections\fR () const" +.br +.ti -1c +.BI "QTableSelection \fBselection\fR ( int num ) const" +.br +.ti -1c +.BI "virtual int \fBaddSelection\fR ( const QTableSelection & s )" +.br +.ti -1c +.BI "virtual void \fBremoveSelection\fR ( const QTableSelection & s )" +.br +.ti -1c +.BI "virtual void \fBremoveSelection\fR ( int num )" +.br +.ti -1c +.BI "virtual int \fBcurrentSelection\fR () const" +.br +.ti -1c +.BI "void \fBselectCells\fR ( int start_row, int start_col, int end_row, int end_col )" +.br +.ti -1c +.BI "void \fBselectRow\fR ( int row )" +.br +.ti -1c +.BI "void \fBselectColumn\fR ( int col )" +.br +.ti -1c +.BI "bool \fBshowGrid\fR () const" +.br +.ti -1c +.BI "bool \fBcolumnMovingEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBrowMovingEnabled\fR () const" +.br +.ti -1c +.BI "virtual void \fBsortColumn\fR ( int col, bool ascending = TRUE, bool wholeRows = FALSE )" +.br +.ti -1c +.BI "bool \fBsorting\fR () const" +.br +.ti -1c +.BI "virtual void \fBtakeItem\fR ( QTableItem * i )" +.br +.ti -1c +.BI "virtual void \fBsetCellWidget\fR ( int row, int col, QWidget * e )" +.br +.ti -1c +.BI "virtual QWidget * \fBcellWidget\fR ( int row, int col ) const" +.br +.ti -1c +.BI "virtual void \fBclearCellWidget\fR ( int row, int col )" +.br +.ti -1c +.BI "virtual QRect \fBcellRect\fR ( int row, int col ) const" +.br +.ti -1c +.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col, const QRect & cr, bool selected )" +.br +.ti -1c +.BI "virtual void \fBpaintCell\fR ( QPainter * p, int row, int col, const QRect & cr, bool selected, const QColorGroup & cg )" +.br +.ti -1c +.BI "virtual void \fBpaintFocus\fR ( QPainter * p, const QRect & cr )" +.br +.ti -1c +.BI "bool \fBisReadOnly\fR () const" +.br +.ti -1c +.BI "bool \fBisRowReadOnly\fR ( int row ) const" +.br +.ti -1c +.BI "bool \fBisColumnReadOnly\fR ( int col ) const" +.br +.ti -1c +.BI "void \fBrepaintSelections\fR ()" +.br +.ti -1c +.BI "enum \fBFocusStyle\fR { FollowStyle, SpreadSheet }" +.br +.ti -1c +.BI "virtual void \fBsetFocusStyle\fR ( FocusStyle fs )" +.br +.ti -1c +.BI "FocusStyle \fBfocusStyle\fR () const" +.br +.ti -1c +.BI "void \fBupdateHeaderStates\fR ()" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetNumRows\fR ( int r )" +.br +.ti -1c +.BI "virtual void \fBsetNumCols\fR ( int r )" +.br +.ti -1c +.BI "virtual void \fBsetShowGrid\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBhideRow\fR ( int row )" +.br +.ti -1c +.BI "virtual void \fBhideColumn\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBshowRow\fR ( int row )" +.br +.ti -1c +.BI "virtual void \fBshowColumn\fR ( int col )" +.br +.ti -1c +.BI "bool \fBisRowHidden\fR ( int row ) const" +.br +.ti -1c +.BI "bool \fBisColumnHidden\fR ( int col ) const" +.br +.ti -1c +.BI "virtual void \fBsetColumnWidth\fR ( int col, int w )" +.br +.ti -1c +.BI "virtual void \fBsetRowHeight\fR ( int row, int h )" +.br +.ti -1c +.BI "virtual void \fBadjustColumn\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBadjustRow\fR ( int row )" +.br +.ti -1c +.BI "virtual void \fBsetColumnStretchable\fR ( int col, bool stretch )" +.br +.ti -1c +.BI "virtual void \fBsetRowStretchable\fR ( int row, bool stretch )" +.br +.ti -1c +.BI "bool \fBisColumnStretchable\fR ( int col ) const" +.br +.ti -1c +.BI "bool \fBisRowStretchable\fR ( int row ) const" +.br +.ti -1c +.BI "virtual void \fBsetSorting\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBswapRows\fR ( int row1, int row2, bool swapHeader = FALSE )" +.br +.ti -1c +.BI "virtual void \fBswapColumns\fR ( int col1, int col2, bool swapHeader = FALSE )" +.br +.ti -1c +.BI "virtual void \fBswapCells\fR ( int row1, int col1, int row2, int col2 )" +.br +.ti -1c +.BI "virtual void \fBsetLeftMargin\fR ( int m )" +.br +.ti -1c +.BI "virtual void \fBsetTopMargin\fR ( int m )" +.br +.ti -1c +.BI "virtual void \fBsetCurrentCell\fR ( int row, int col )" +.br +.ti -1c +.BI "void \fBclearSelection\fR ( bool repaint = TRUE )" +.br +.ti -1c +.BI "virtual void \fBsetColumnMovingEnabled\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetRowMovingEnabled\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetReadOnly\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetRowReadOnly\fR ( int row, bool ro )" +.br +.ti -1c +.BI "virtual void \fBsetColumnReadOnly\fR ( int col, bool ro )" +.br +.ti -1c +.BI "virtual void \fBsetDragEnabled\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBdragEnabled\fR () const" +.br +.ti -1c +.BI "virtual void \fBinsertRows\fR ( int row, int count = 1 )" +.br +.ti -1c +.BI "virtual void \fBinsertColumns\fR ( int col, int count = 1 )" +.br +.ti -1c +.BI "virtual void \fBremoveRow\fR ( int row )" +.br +.ti -1c +.BI "virtual void \fBremoveRows\fR ( const QMemArray<int> & rows )" +.br +.ti -1c +.BI "virtual void \fBremoveColumn\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBremoveColumns\fR ( const QMemArray<int> & cols )" +.br +.ti -1c +.BI "virtual void \fBeditCell\fR ( int row, int col, bool replace = FALSE )" +.br +.ti -1c +.BI "void \fBsetRowLabels\fR ( const QStringList & labels )" +.br +.ti -1c +.BI "void \fBsetColumnLabels\fR ( const QStringList & labels )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBcurrentChanged\fR ( int row, int col )" +.br +.ti -1c +.BI "void \fBclicked\fR ( int row, int col, int button, const QPoint & mousePos )" +.br +.ti -1c +.BI "void \fBdoubleClicked\fR ( int row, int col, int button, const QPoint & mousePos )" +.br +.ti -1c +.BI "void \fBpressed\fR ( int row, int col, int button, const QPoint & mousePos )" +.br +.ti -1c +.BI "void \fBselectionChanged\fR ()" +.br +.ti -1c +.BI "void \fBvalueChanged\fR ( int row, int col )" +.br +.ti -1c +.BI "void \fBcontextMenuRequested\fR ( int row, int col, const QPoint & pos )" +.br +.ti -1c +.BI "void \fBdropped\fR ( QDropEvent * e )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBcolumnMovingEnabled\fR - whether columns can be moved by the user" +.br +.ti -1c +.BI "FocusStyle \fBfocusStyle\fR - how the current (focus) cell is drawn" +.br +.ti -1c +.BI "int \fBnumCols\fR - the number of columns in the table" +.br +.ti -1c +.BI "int \fBnumRows\fR - the number of rows in the table" +.br +.ti -1c +.BI "int \fBnumSelections\fR - the number of selections \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBreadOnly\fR - whether the table is read-only" +.br +.ti -1c +.BI "bool \fBrowMovingEnabled\fR - whether rows can be moved by the user" +.br +.ti -1c +.BI "SelectionMode \fBselectionMode\fR - the current selection mode" +.br +.ti -1c +.BI "bool \fBshowGrid\fR - whether the table's grid is displayed" +.br +.ti -1c +.BI "bool \fBsorting\fR - whether a click on the header of a column sorts that column" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "enum \fBEditMode\fR { NotEditing, Editing, Replacing }" +.br +.ti -1c +.BI "virtual void \fBdrawContents\fR ( QPainter * p, int cx, int cy, int cw, int ch )" +.br +.ti -1c +.BI "void \fBsetEditMode\fR ( EditMode mode, int row, int col )" +.br +.ti -1c +.BI "virtual void \fBcontentsDragEnterEvent\fR ( QDragEnterEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsDragMoveEvent\fR ( QDragMoveEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsDragLeaveEvent\fR ( QDragLeaveEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontentsDropEvent\fR ( QDropEvent * e )" +.br +.ti -1c +.BI "virtual QDragObject * \fBdragObject\fR ()" +.br +.ti -1c +.BI "virtual void \fBstartDrag\fR ()" +.br +.ti -1c +.BI "virtual void \fBpaintEmptyArea\fR ( QPainter * p, int cx, int cy, int cw, int ch )" +.br +.ti -1c +.BI "virtual void \fBactivateNextCell\fR ()" +.br +.ti -1c +.BI "virtual QWidget * \fBcreateEditor\fR ( int row, int col, bool initFromCell ) const" +.br +.ti -1c +.BI "virtual void \fBsetCellContentFromEditor\fR ( int row, int col )" +.br +.ti -1c +.BI "virtual QWidget * \fBbeginEdit\fR ( int row, int col, bool replace )" +.br +.ti -1c +.BI "virtual void \fBendEdit\fR ( int row, int col, bool accept, bool replace )" +.br +.ti -1c +.BI "virtual void \fBresizeData\fR ( int len )" +.br +.ti -1c +.BI "virtual void \fBinsertWidget\fR ( int row, int col, QWidget * w )" +.br +.ti -1c +.BI "int \fBindexOf\fR ( int row, int col ) const" +.br +.ti -1c +.BI "bool \fBisEditing\fR () const" +.br +.ti -1c +.BI "EditMode \fBeditMode\fR () const" +.br +.ti -1c +.BI "int \fBcurrEditRow\fR () const" +.br +.ti -1c +.BI "int \fBcurrEditCol\fR () const" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "virtual void \fBcolumnWidthChanged\fR ( int col )" +.br +.ti -1c +.BI "virtual void \fBrowHeightChanged\fR ( int row )" +.br +.ti -1c +.BI "virtual void \fBcolumnIndexChanged\fR ( int section, int fromIndex, int toIndex )" +.br +.ti -1c +.BI "virtual void \fBrowIndexChanged\fR ( int section, int fromIndex, int toIndex )" +.br +.ti -1c +.BI "virtual void \fBcolumnClicked\fR ( int col )" +.br +.in -1c +.SH DESCRIPTION +The QTable class provides a flexible editable table widget. +.PP +QTable is easy to use, although it does have a large API because of the comprehensive functionality that it provides. QTable includes functions for manipulating headers, rows and columns, cells and selections. QTable also provides in-place editing and drag and drop, as well as a useful set of signals. QTable efficiently supports very large tables, for example, tables one million by one million cells are perfectly possible. QTable is economical with memory, using none for unused cells. +.PP +.nf +.br + QTable *table = new QTable( 100, 250, this ); +.br + table->setPixmap( 3, 2, pix ); +.br + table->setText( 3, 2, "A pixmap" ); +.br +.fi +.PP +The first line constructs the table specifying its size in rows and columns. We then insert a pixmap and some text into the \fIsame\fR cell, with the pixmap appearing to the left of the text. QTable cells can be populated with QTableItems, QComboTableItems or by QCheckTableItems. By default a vertical header appears at the left of the table showing row numbers and a horizontal header appears at the top of the table showing column numbers. (The numbers displayed start at 1, although row and column numbers within QTable begin at 0.) +.PP +If you want to use mouse tracking call setMouseTracking( TRUE ) on the \fIviewport\fR; (see QScrollView). +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH "Headers" +QTable supports a header column, e.g. to display row numbers, and a header row, e.g to display column titles. To set row or column labels use QHeader::setLabel() on the pointers returned by verticalHeader() and horizontalHeader() respectively. The vertical header is displayed within the table's left margin whose width is set with setLeftMargin(). The horizontal header is displayed within the table's top margin whose height is set with setTopMargin(). The table's grid can be switched off with setShowGrid(). If you want to hide a horizontal header call hide(), and call setTopMargin( 0 ) so that the area the header would have occupied is reduced to zero size. +.PP +Header labels are indexed via their section numbers. Note that the default behavior of QHeader regarding section numbers is overriden for QTable. See the explanation below in the Rows and Columns section in the discussion of moving columns and rows. +.SH "Rows and Columns" +Row and column sizes are set with setRowHeight() and setColumnWidth(). If you want a row high enough to show the tallest item in its entirety, use adjustRow(). Similarly, to make a column wide enough to show the widest item use adjustColumn(). If you want the row height and column width to adjust automatically as the height and width of the table changes use setRowStretchable() and setColumnStretchable(). +.PP +Rows and columns can be hidden and shown with hideRow(), hideColumn(), showRow() and showColumn(). New rows and columns are inserted using insertRows() and insertColumns(). Additional rows and columns are added at the bottom (rows) or right (columns) if you set setNumRows() or setNumCols() to be larger than numRows() or numCols(). Existing rows and columns are removed with removeRow() and removeColumn(). Multiple rows and columns can be removed with removeRows() and removeColumns(). +.PP +Rows and columns can be set to be moveable using rowMovingEnabled() and columnMovingEnabled(). The user can drag them to reorder them holding down the Ctrl key and dragging the mouse. For performance reasons, the default behavior of QHeader section numbers is overridden by QTable. Currently in QTable, when a row or column is dragged and reordered, the section number is also changed to its new position. Therefore, there is no difference between the section and the index fields in QHeader. The QTable QHeader classes do not provide a mechanism for indexing independently of the user interface ordering. +.PP +The table can be sorted using sortColumn(). Users can sort a column by clicking its header if setSorting() is set to TRUE. Rows can be swapped with swapRows(), columns with swapColumns() and cells with swapCells(). +.PP +For editable tables (see setReadOnly()) you can set the read-only property of individual rows and columns with setRowReadOnly() and setColumnReadOnly(). (Whether a cell is editable or read-only depends on these settings and the cell's QTableItem::EditType.) +.PP +The row and column which have the focus are returned by currentRow() and currentColumn() respectively. +.PP +Although many QTable functions operate in terms of rows and columns the indexOf() function returns a single integer identifying a particular cell. +.SH "Cells" +All of a QTable's cells are empty when the table is constructed. +.PP +There are two approaches to populating the table's cells. The first and simplest approach is to use QTableItems or QTableItem subclasses. The second approach doesn't use QTableItems at all which is useful for very large sparse tables but requires you to reimplement a number of functions. We'll look at each approach in turn. +.PP +To put a string in a cell use setText(). This function will create a new QTableItem for the cell if one doesn't already exist, and displays the text in it. By default the table item's widget will be a QLineEdit. A pixmap may be put in a cell with setPixmap(), which also creates a table item if required. A cell may contain \fIboth\fR a pixmap and text; the pixmap is displayed to the left of the text. Another approach is to construct a QTableItem or QTableItem subclass, set its properties, then insert it into a cell with setItem(). +.PP +If you want cells which contain comboboxes use the QComboTableItem class. Similarly if you require cells containing checkboxes use the QCheckTableItem class. These table items look and behave just like the combobox or checkbox widgets but consume far less memory. +.PP +.nf +.br + for ( int j = 0; j < numRows; ++j ) +.br + table.setItem( j, 1, new QCheckTableItem( &table, "Check me" ) ); +.fi +In the example above we create a column of QCheckTableItems and insert them into the table using setItem(). +.PP +QTable takes ownership of its QTableItems and will delete them when the table itself is destroyed. You can take ownership of a table item using takeItem() which you use to move a cell's contents from one cell to another, either within the same table, or from one table to another. (See also, swapCells()). +.PP +In-place editing of the text in QTableItems, and the values in QComboTableItems and QCheckTableItems works automatically. Cells may be editable or read-only, see QTableItem::EditType. If you want fine control over editing see beginEdit() and endEdit(). +.PP +The contents of a cell can be retrieved as a QTableItem using item(), or as a string with text() or as a pixmap (if there is one) with pixmap(). A cell's bounding rectangle is given by cellGeometry(). Use updateCell() to repaint a cell, for example to clear away a cell's visual representation after it has been deleted with clearCell(). The table can be forced to scroll to show a particular cell with ensureCellVisible(). The isSelected() function indicates if a cell is selected. +.PP +It is possible to use your own widget as a cell's widget using setCellWidget(), but subclassing QTableItem might be a simpler approach. The cell's widget (if there is one) can be removed with clearCellWidget(). +.PP + +<h4> Large tables </h4> +.PP +For large, sparse, tables using QTableItems or other widgets is inefficient. The solution is to \fIdraw\fR the cell as it should appear and to create and destroy cell editors on demand. +.PP +This approach requires that you reimplement various functions. Reimplement paintCell() to display your data, and createEditor() and setCellContentFromEditor() to support in-place editing. It is very important to reimplement resizeData() to have no functionality, to prevent QTable from attempting to create a huge array. You will also need to reimplement item(), setItem(), takeItem(), clearCell(), and insertWidget(), cellWidget() and clearCellWidget(). In almost every circumstance (for sorting, removing and inserting columns and rows, etc.), you also need to reimplement swapRows(), swapCells() and swapColumns(), including header handling. +.PP +If you represent active cells with a dictionary of QTableItems and QWidgets, i.e. only store references to cells that are actually used, many of the functions can be implemented with a single line of code. (See the table/bigtable/main.cpp example.) +.PP +For more information on cells see the QTableItem documenation. +.SH "Selections" +QTable's support single selection, multi-selection (multiple cells) or no selection. The selection mode is set with setSelectionMode(). Use isSelected() to determine if a particular cell is selected, and isRowSelected() and isColumnSelected() to see if a row or column is selected. +.PP +QTable's support many simultaneous selections. You can programmatically select cells with addSelection(). The number of selections is given by numSelections(). The current selection is returned by currentSelection(). You can remove a selection with removeSelection() and remove all selections with clearSelection(). Selections are QTableSelection objects. +.PP +To easily add a new selection use selectCells(), selectRow() or selectColumn(). +.PP +Alternatively, use addSelection() to add new selections using QTableSelection objects. The advantage of using QTableSelection objects is that you can call QTableSelection::expandTo() to resize the selection and can query and compare them. +.PP +The number of selections is given by numSelections(). The current selection is returned by currentSelection(). You can remove a selection with removeSelection() and remove all selections with clearSelection(). +.SH "Signals" +When the user clicks a cell the currentChanged() signal is emitted. You can also connect to the lower level clicked(), doubleClicked() and pressed() signals. If the user changes the selection the selectionChanged() signal is emitted; similarly if the user changes a cell's value the valueChanged() signal is emitted. If the user right-clicks (or presses the appropriate platform-specific key sequence) the contextMenuRequested() signal is emitted. If the user drops a drag and drop object the dropped() signal is emitted with the drop event. +.PP +See also Advanced Widgets. +.SS "Member Type Documentation" +.SH "QTable::EditMode" +.TP +\fCQTable::NotEditing\fR - No cell is currently being edited. +.TP +\fCQTable::Editing\fR - A cell is currently being edited. The editor was initialised with the cell's contents. +.TP +\fCQTable::Replacing\fR - A cell is currently being edited. The editor was not initialised with the cell's contents. +.SH "QTable::FocusStyle" +Specifies how the current cell (focus cell) is drawn. +.TP +\fCQTable::FollowStyle\fR - The current cell is drawn according to the current style and the cell's background is also drawn selected, if the current cell is within a selection +.TP +\fCQTable::SpreadSheet\fR - The current cell is drawn as in a spreadsheet. This means, it is signified by a black rectangle around the cell, and the background of the current cell is always drawn with the widget's base color - even when selected. +.SH "QTable::SelectionMode" +.TP +\fCQTable::NoSelection\fR - No cell can be selected by the user. +.TP +\fCQTable::Single\fR - The user may only select a single range of cells. +.TP +\fCQTable::Multi\fR - The user may select multiple ranges of cells. +.TP +\fCQTable::SingleRow\fR - The user may select one row at once. +.TP +\fCQTable::MultiRow\fR - The user may select multiple rows. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTable::QTable ( QWidget * parent = 0, const char * name = 0 )" +Creates an empty table object called \fIname\fR as a child of \fIparent\fR. +.PP +Call setNumRows() and setNumCols() to set the table size before populating the table if you're using QTableItems. +.PP +See also QWidget::clearWFlags() and Qt::WidgetFlags. +.SH "QTable::QTable ( int numRows, int numCols, QWidget * parent = 0, const char * name = 0 )" +Constructs an empty table called \fIname\fR with \fInumRows\fR rows and \fInumCols\fR columns. The table is a child of \fIparent\fR. +.PP +If you're using QTableItems to populate the table's cells, you can create QTableItem, QComboTableItem and QCheckTableItem items and insert them into the table using setItem(). (See the notes on large tables for an alternative to using QTableItems.) +.PP +See also QWidget::clearWFlags() and Qt::WidgetFlags. +.SH "QTable::~QTable ()" +Releases all the resources used by the QTable object, including all QTableItems and their widgets. +.SH "void QTable::activateNextCell ()\fC [virtual protected]\fR" +This function is called to activate the next cell if in-place editing was finished by pressing the Enter key. +.PP +The default behaviour is to move from top to bottom, i.e. move to the cell beneath the cell being edited. Reimplement this function if you want different behaviour, e.g. moving from left to right. +.SH "int QTable::addSelection ( const QTableSelection & s )\fC [virtual]\fR" +Adds a selection described by \fIs\fR to the table and returns its number or -1 if the selection is invalid. +.PP +Remember to call QTableSelection::init() and QTableSelection::expandTo() to make the selection valid (see also QTableSelection::isActive(), or use the QTableSelection(int,int,int,int) constructor). +.PP +See also numSelections, removeSelection(), and clearSelection(). +.SH "void QTable::adjustColumn ( int col )\fC [virtual slot]\fR" +Resizes column \fIcol\fR so that the column width is wide enough to display the widest item the column contains. +.PP +See also adjustRow(). +.PP +Example: regexptester/regexptester.cpp. +.PP +Reimplemented in QDataTable. +.SH "void QTable::adjustRow ( int row )\fC [virtual slot]\fR" +Resizes row \fIrow\fR so that the row height is tall enough to display the tallest item the row contains. +.PP +See also adjustColumn(). +.SH "QWidget * QTable::beginEdit ( int row, int col, bool replace )\fC [virtual protected]\fR" +This function is called to start in-place editing of the cell at \fIrow\fR, \fIcol\fR. Editing is achieved by creating an editor (createEditor() is called) and setting the cell's editor with setCellWidget() to the newly created editor. (After editing is complete endEdit() will be called to replace the cell's content with the editor's content.) If \fIreplace\fR is TRUE the editor will start empty; otherwise it will be initialized with the cell's content (if any), i.e. the user will be modifying the original cell content. +.PP +See also endEdit(). +.SH "QRect QTable::cellGeometry ( int row, int col ) const\fC [virtual]\fR" +Returns the bounding rectangle of the cell at \fIrow\fR, \fIcol\fR in content coordinates. +.SH "QRect QTable::cellRect ( int row, int col ) const\fC [virtual]\fR" +Returns the geometry of cell \fIrow\fR, \fIcol\fR in the cell's coordinate system. This is a convenience function useful in paintCell(). It is equivalent to QRect( QPoint(0,0), cellGeometry( row, col).size() ); +.PP +See also cellGeometry(). +.PP +Example: chart/setdataform.cpp. +.SH "QWidget * QTable::cellWidget ( int row, int col ) const\fC [virtual]\fR" +Returns the widget that has been set for the cell at \fIrow\fR, \fIcol\fR, or 0 if no widget has been set. +.PP +If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. +.PP +See also clearCellWidget() and setCellWidget(). +.PP +Example: chart/setdataform.cpp. +.SH "void QTable::clearCell ( int row, int col )\fC [virtual]\fR" +Removes the QTableItem at \fIrow\fR, \fIcol\fR. +.PP +If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. +.SH "void QTable::clearCellWidget ( int row, int col )\fC [virtual]\fR" +Removes the widget (if there is one) set for the cell at \fIrow\fR, \fIcol\fR. +.PP +If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. +.PP +This function deletes the widget at \fIrow\fR, \fIcol\fR. Note that the widget is not deleted immediately; instead QObject::deleteLater() is called on the widget to avoid problems with timing issues. +.PP +See also cellWidget() and setCellWidget(). +.SH "void QTable::clearSelection ( bool repaint = TRUE )\fC [slot]\fR" +Clears all selections and repaints the appropriate regions if \fIrepaint\fR is TRUE. +.PP +See also removeSelection(). +.SH "void QTable::clicked ( int row, int col, int button, const QPoint & mousePos )\fC [signal]\fR" +This signal is emitted when mouse button \fIbutton\fR is clicked. The cell where the event took place is at \fIrow\fR, \fIcol\fR, and the mouse's position is in \fImousePos\fR. +.PP +See also Qt::ButtonState. +.PP +Example: chart/setdataform.cpp. +.SH "int QTable::columnAt ( int x ) const\fC [virtual]\fR" +Returns the number of the column at position \fIx\fR. \fIx\fR must be given in content coordinates. +.PP +See also columnPos() and rowAt(). +.SH "void QTable::columnClicked ( int col )\fC [virtual protected slot]\fR" +This function is called when the column \fIcol\fR has been clicked. The default implementation sorts this column if sorting() is TRUE. +.SH "void QTable::columnIndexChanged ( int section, int fromIndex, int toIndex )\fC [virtual protected slot]\fR" +This function is called when column order is to be changed, i.e. when the user moved the column header \fIsection\fR from \fIfromIndex\fR to \fItoIndex\fR. +.PP +If you want to change the column order programmatically, call swapRows() or swapColumns(); +.PP +See also QHeader::indexChange() and rowIndexChanged(). +.SH "bool QTable::columnMovingEnabled () const" +Returns TRUE if columns can be moved by the user; otherwise returns FALSE. See the "columnMovingEnabled" property for details. +.SH "int QTable::columnPos ( int col ) const\fC [virtual]\fR" +Returns the x-coordinate of the column \fIcol\fR in content coordinates. +.PP +See also columnAt() and rowPos(). +.SH "int QTable::columnWidth ( int col ) const\fC [virtual]\fR" +Returns the width of column \fIcol\fR. +.PP +See also setColumnWidth() and rowHeight(). +.SH "void QTable::columnWidthChanged ( int col )\fC [virtual protected slot]\fR" +This function should be called whenever the column width of \fIcol\fR has been changed. It updates the geometry of any affected columns and repaints the table to reflect the changes it has made. +.SH "void QTable::contentsDragEnterEvent ( QDragEnterEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever a QTable object receives a QDragEnterEvent \fIe\fR, i.e. when the user pressed the mouse button to drag something. +.PP +The focus is moved to the cell where the QDragEnterEvent occurred. +.PP +Reimplemented from QScrollView. +.SH "void QTable::contentsDragLeaveEvent ( QDragLeaveEvent * e )\fC [virtual protected]\fR" +This event handler is called when a drag activity leaves \fIthis\fR QTable object with event \fIe\fR. +.PP +Reimplemented from QScrollView. +.SH "void QTable::contentsDragMoveEvent ( QDragMoveEvent * e )\fC [virtual protected]\fR" +This event handler is called whenever a QTable object receives a QDragMoveEvent \fIe\fR, i.e. when the user actually drags the mouse. +.PP +The focus is moved to the cell where the QDragMoveEvent occurred. +.PP +Reimplemented from QScrollView. +.SH "void QTable::contentsDropEvent ( QDropEvent * e )\fC [virtual protected]\fR" +This event handler is called when the user ends a drag and drop by dropping something onto \fIthis\fR QTable and thus triggers the drop event, \fIe\fR. +.PP +Reimplemented from QScrollView. +.SH "void QTable::contextMenuRequested ( int row, int col, const QPoint & pos )\fC [signal]\fR" +This signal is emitted when the user invokes a context menu with the right mouse button (or with a system-specific keypress). The cell where the event took place is at \fIrow\fR, \fIcol\fR. \fIpos\fR is the position where the context menu will appear in the global coordinate system. This signal is always emitted, even if the contents of the cell are disabled. +.SH "QWidget * QTable::createEditor ( int row, int col, bool initFromCell ) const\fC [virtual protected]\fR" +This function returns the widget which should be used as an editor for the contents of the cell at \fIrow\fR, \fIcol\fR. +.PP +If \fIinitFromCell\fR is TRUE, the editor is used to edit the current contents of the cell (so the editor widget should be initialized with this content). If \fIinitFromCell\fR is FALSE, the content of the cell is replaced with the new content which the user entered into the widget created by this function. +.PP +The default functionality is as follows: if \fIinitFromCell\fR is TRUE or the cell has a QTableItem and the table item's QTableItem::isReplaceable() is FALSE then the cell is asked to create an appropriate editor (using QTableItem::createEditor()). Otherwise a QLineEdit is used as the editor. +.PP +If you want to create your own editor for certain cells, implement a custom QTableItem subclass and reimplement QTableItem::createEditor(). +.PP +If you are not using QTableItems and you don't want to use a QLineEdit as the default editor, subclass QTable and reimplement this function with code like this: +.PP +.nf +.br + QTableItem *i = item( row, col ); +.br + if ( initFromCell || ( i && !i->isReplaceable() ) ) +.br + // If we had a QTableItem ask the base class to create the editor +.br + return QTable::createEditor( row, col, initFromCell ); +.br + else +.br + return ...(create your own editor) +.br +.fi +Ownership of the editor widget is transferred to the caller. +.PP +If you reimplement this function return 0 for read-only cells. You will need to reimplement setCellContentFromEditor() to retrieve the data the user entered. +.PP +See also QTableItem::createEditor(). +.SH "int QTable::currEditCol () const\fC [protected]\fR" +Returns the current edited column +.SH "int QTable::currEditRow () const\fC [protected]\fR" +Returns the current edited row +.SH "void QTable::currentChanged ( int row, int col )\fC [signal]\fR" +This signal is emitted when the current cell has changed to \fIrow\fR, \fIcol\fR. +.PP +Example: chart/setdataform.cpp. +.SH "int QTable::currentColumn () const" +Returns the current column. +.PP +See also currentRow(). +.PP +Example: chart/setdataform.cpp. +.SH "int QTable::currentRow () const" +Returns the current row. +.PP +See also currentColumn(). +.PP +Example: chart/setdataform.cpp. +.SH "int QTable::currentSelection () const\fC [virtual]\fR" +Returns the number of the current selection or -1 if there is no current selection. +.PP +See also numSelections. +.SH "void QTable::doubleClicked ( int row, int col, int button, const QPoint & mousePos )\fC [signal]\fR" +This signal is emitted when mouse button \fIbutton\fR is double-clicked. The cell where the event took place is at \fIrow\fR, \fIcol\fR, and the mouse's position is in \fImousePos\fR. +.PP +See also Qt::ButtonState. +.SH "bool QTable::dragEnabled () const\fC [slot]\fR" +If this function returns TRUE, the table supports dragging. +.PP +See also setDragEnabled(). +.SH "QDragObject * QTable::dragObject ()\fC [virtual protected]\fR" +If the user presses the mouse on a selected cell, starts moving (i.e. dragging), and dragEnabled() is TRUE, this function is called to obtain a drag object. A drag using this object begins immediately unless dragObject() returns 0. +.PP +By default this function returns 0. You might reimplement it and create a QDragObject depending on the selected items. +.PP +See also dropped(). +.SH "void QTable::drawContents ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" +Draws the table contents on the painter \fIp\fR. This function is optimized so that it only draws the cells inside the \fIcw\fR pixels wide and \fIch\fR pixels high clipping rectangle at position \fIcx\fR, \fIcy\fR. +.PP +Additionally, drawContents() highlights the current cell. +.PP +Reimplemented from QScrollView. +.SH "void QTable::dropped ( QDropEvent * e )\fC [signal]\fR" +This signal is emitted when a drop event occurred on the table. +.PP +\fIe\fR contains information about the drop. +.SH "void QTable::editCell ( int row, int col, bool replace = FALSE )\fC [virtual slot]\fR" +Starts editing the cell at \fIrow\fR, \fIcol\fR. +.PP +If \fIreplace\fR is TRUE the content of this cell will be replaced by the content of the editor when editing is finished, i.e. the user will be entering new data; otherwise the current content of the cell (if any) will be modified in the editor. +.PP +See also beginEdit(). +.SH "EditMode QTable::editMode () const\fC [protected]\fR" +Returns the current edit mode +.PP +See also QTable::EditMode. +.SH "void QTable::endEdit ( int row, int col, bool accept, bool replace )\fC [virtual protected]\fR" +This function is called when in-place editing of the cell at \fIrow\fR, \fIcol\fR is requested to stop. +.PP +If the cell is not being edited or \fIaccept\fR is FALSE the function returns and the cell's contents are left unchanged. +.PP +If \fIaccept\fR is TRUE the content of the editor must be transferred to the relevant cell. If \fIreplace\fR is TRUE the current content of this cell should be replaced by the content of the editor (this means removing the current QTableItem of the cell and creating a new one for the cell). Otherwise (if possible) the content of the editor should just be set to the existing QTableItem of this cell. +.PP +setCellContentFromEditor() is called to replace the contents of the cell with the contents of the cell's editor. +.PP +Finally clearCellWidget() is called to remove the editor widget. +.PP +See also setCellContentFromEditor() and beginEdit(). +.SH "void QTable::ensureCellVisible ( int row, int col )" +Scrolls the table until the cell at \fIrow\fR, \fIcol\fR becomes visible. +.SH "FocusStyle QTable::focusStyle () const" +Returns how the current (focus) cell is drawn. See the "focusStyle" property for details. +.SH "void QTable::hideColumn ( int col )\fC [virtual slot]\fR" +Hides column \fIcol\fR. +.PP +See also showColumn() and hideRow(). +.SH "void QTable::hideRow ( int row )\fC [virtual slot]\fR" +Hides row \fIrow\fR. +.PP +See also showRow() and hideColumn(). +.SH "QHeader * QTable::horizontalHeader () const" +Returns the table's top QHeader. +.PP +This header contains the column labels. +.PP +To modify a column label use QHeader::setLabel(), e.g. +.PP +.nf +.br + horizontalHeader()->setLabel( 0, tr( "File" ) ); +.fi +.PP +See also verticalHeader(), setTopMargin(), and QHeader. +.PP +Examples: +.)l chart/setdataform.cpp, helpsystem/mainwindow.cpp, regexptester/regexptester.cpp, and table/small-table-demo/main.cpp. +.SH "int QTable::indexOf ( int row, int col ) const\fC [protected]\fR" +Returns a single integer which identifies a particular \fIrow\fR and \fIcol\fR by mapping the 2D table to a 1D array. +.PP +This is useful, for example, if you have a sparse table and want to use a QIntDict to map integers to the cells that are used. +.SH "void QTable::insertColumns ( int col, int count = 1 )\fC [virtual slot]\fR" +Inserts \fIcount\fR empty columns at column \fIcol\fR. Also clears the selection(s). +.PP +See also insertRows() and removeColumn(). +.SH "void QTable::insertRows ( int row, int count = 1 )\fC [virtual slot]\fR" +Inserts \fIcount\fR empty rows at row \fIrow\fR. Also clears the selection(s). +.PP +See also insertColumns() and removeRow(). +.SH "void QTable::insertWidget ( int row, int col, QWidget * w )\fC [virtual protected]\fR" +Inserts widget \fIw\fR at \fIrow\fR, \fIcol\fR into the internal data structure. See the documentation of setCellWidget() for further details. +.PP +If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. +.SH "bool QTable::isColumnHidden ( int col ) const\fC [slot]\fR" +Returns TRUE if column \fIcol\fR is hidden; otherwise returns FALSE. +.PP +See also hideColumn() and isRowHidden(). +.SH "bool QTable::isColumnReadOnly ( int col ) const" +Returns TRUE if column \fIcol\fR is read-only; otherwise returns FALSE. +.PP +Whether a cell in this column is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. +.PP +See also setColumnReadOnly() and isRowReadOnly(). +.SH "bool QTable::isColumnSelected ( int col, bool full = FALSE ) const" +Returns TRUE if column \fIcol\fR is selected; otherwise returns FALSE. +.PP +If \fIfull\fR is FALSE (the default), 'column is selected' means that at least one cell in the column is selected. If \fIfull\fR is TRUE, then 'column is selected' means every cell in the column is selected. +.PP +See also isRowSelected() and isSelected(). +.SH "bool QTable::isColumnStretchable ( int col ) const\fC [slot]\fR" +Returns TRUE if column \fIcol\fR is stretchable; otherwise returns FALSE. +.PP +See also setColumnStretchable() and isRowStretchable(). +.SH "bool QTable::isEditing () const\fC [protected]\fR" +Returns TRUE if the EditMode is Editing or Replacing; otherwise (i.e. the EditMode is NotEditing) returns FALSE. +.PP +See also QTable::EditMode. +.SH "bool QTable::isReadOnly () const" +Returns TRUE if the table is read-only; otherwise returns FALSE. See the "readOnly" property for details. +.SH "bool QTable::isRowHidden ( int row ) const\fC [slot]\fR" +Returns TRUE if row \fIrow\fR is hidden; otherwise returns FALSE. +.PP +See also hideRow() and isColumnHidden(). +.SH "bool QTable::isRowReadOnly ( int row ) const" +Returns TRUE if row \fIrow\fR is read-only; otherwise returns FALSE. +.PP +Whether a cell in this row is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. +.PP +See also setRowReadOnly() and isColumnReadOnly(). +.SH "bool QTable::isRowSelected ( int row, bool full = FALSE ) const" +Returns TRUE if row \fIrow\fR is selected; otherwise returns FALSE. +.PP +If \fIfull\fR is FALSE (the default), 'row is selected' means that at least one cell in the row is selected. If \fIfull\fR is TRUE, then 'row is selected' means every cell in the row is selected. +.PP +See also isColumnSelected() and isSelected(). +.SH "bool QTable::isRowStretchable ( int row ) const\fC [slot]\fR" +Returns TRUE if row \fIrow\fR is stretchable; otherwise returns FALSE. +.PP +See also setRowStretchable() and isColumnStretchable(). +.SH "bool QTable::isSelected ( int row, int col ) const" +Returns TRUE if the cell at \fIrow\fR, \fIcol\fR is selected; otherwise returns FALSE. +.PP +See also isRowSelected() and isColumnSelected(). +.SH "QTableItem * QTable::item ( int row, int col ) const\fC [virtual]\fR" +Returns the QTableItem representing the contents of the cell at \fIrow\fR, \fIcol\fR. +.PP +If \fIrow\fR or \fIcol\fR are out of range or no content has been set for this cell, item() returns 0. +.PP +If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. +.PP +See also setItem(). +.PP +Example: regexptester/regexptester.cpp. +.SH "int QTable::numCols () const\fC [virtual]\fR" +Returns the number of columns in the table. See the "numCols" property for details. +.PP +Reimplemented in QDataTable. +.SH "int QTable::numRows () const\fC [virtual]\fR" +Returns the number of rows in the table. See the "numRows" property for details. +.PP +Reimplemented in QDataTable. +.SH "int QTable::numSelections () const" +Returns the number of selections. See the "numSelections" property for details. +.SH "void QTable::paintCell ( QPainter * p, int row, int col, const QRect & cr, bool selected, const QColorGroup & cg )\fC [virtual]\fR" +Paints the cell at \fIrow\fR, \fIcol\fR on the painter \fIp\fR. The painter has already been translated to the cell's origin. \fIcr\fR describes the cell coordinates in the content coordinate system. +.PP +If \fIselected\fR is TRUE the cell is highlighted. +.PP +\fIcg\fR is the colorgroup which should be used to draw the cell content. +.PP +If you want to draw custom cell content, for example right-aligned text, you must either reimplement paintCell(), or subclass QTableItem and reimplement QTableItem::paint() to do the custom drawing. +.PP +If you're using a QTableItem subclass, for example, to store a data structure, then reimplementing QTableItem::paint() may be the best approach. For data you want to draw immediately, e.g. data retrieved from a database, it is probably best to reimplement paintCell(). Note that if you reimplement paintCell(), i.e. don't use QTableItems, you must reimplement other functions: see the notes on large tables. +.PP +Note that the painter is not clipped by default in order to get maximum efficiency. If you want clipping, use code like this: +.PP +.nf +.br + p->setClipRect( cellRect(row, col), QPainter::CoordPainter ); +.br + //... your drawing code +.br + p->setClipping( FALSE ); +.br +.fi +.SH "void QTable::paintCell ( QPainter * p, int row, int col, const QRect & cr, bool selected )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Use the other paintCell() function. This function is only included for backwards compatibilty. +.SH "void QTable::paintEmptyArea ( QPainter * p, int cx, int cy, int cw, int ch )\fC [virtual protected]\fR" +This function fills the \fIcw\fR pixels wide and \fIch\fR pixels high rectangle starting at position \fIcx\fR, \fIcy\fR with the background color using the painter \fIp\fR. +.PP +paintEmptyArea() is invoked by drawContents() to erase or fill unused areas. +.SH "void QTable::paintFocus ( QPainter * p, const QRect & cr )\fC [virtual]\fR" +Draws the focus rectangle of the current cell (see currentRow(), currentColumn()). +.PP +The painter \fIp\fR is already translated to the cell's origin, while \fIcr\fR specifies the cell's geometry in content coordinates. +.SH "QPixmap QTable::pixmap ( int row, int col ) const\fC [virtual]\fR" +Returns the pixmap set for the cell at \fIrow\fR, \fIcol\fR, or a null-pixmap if the cell contains no pixmap. +.PP +See also setPixmap(). +.PP +Example: chart/setdataform.cpp. +.SH "void QTable::pressed ( int row, int col, int button, const QPoint & mousePos )\fC [signal]\fR" +This signal is emitted when mouse button \fIbutton\fR is pressed. The cell where the event took place is at \fIrow\fR, \fIcol\fR, and the mouse's position is in \fImousePos\fR. +.PP +See also Qt::ButtonState. +.SH "void QTable::removeColumn ( int col )\fC [virtual slot]\fR" +Removes column \fIcol\fR, and deletes all its cells including any table items and widgets the cells may contain. Also clears the selection(s). +.PP +See also removeColumns(), hideColumn(), insertColumns(), and removeRow(). +.SH "void QTable::removeColumns ( const QMemArray<int> & cols )\fC [virtual slot]\fR" +Removes the columns listed in the array \fIcols\fR, and deletes all their cells including any table items and widgets the cells may contain. +.PP +The array passed in must only contain valid columns (in the range from 0 to numCols() - 1) with no duplicates, and must be sorted in ascending order. Also clears the selection(s). +.PP +See also removeColumn(), insertColumns(), and removeRows(). +.SH "void QTable::removeRow ( int row )\fC [virtual slot]\fR" +Removes row \fIrow\fR, and deletes all its cells including any table items and widgets the cells may contain. Also clears the selection(s). +.PP +See also hideRow(), insertRows(), removeColumn(), and removeRows(). +.SH "void QTable::removeRows ( const QMemArray<int> & rows )\fC [virtual slot]\fR" +Removes the rows listed in the array \fIrows\fR, and deletes all their cells including any table items and widgets the cells may contain. +.PP +The array passed in must only contain valid rows (in the range from 0 to numRows() - 1) with no duplicates, and must be sorted in ascending order. Also clears the selection(s). +.PP +See also removeRow(), insertRows(), and removeColumns(). +.SH "void QTable::removeSelection ( const QTableSelection & s )\fC [virtual]\fR" +If the table has a selection, \fIs\fR, this selection is removed from the table. +.PP +See also addSelection() and numSelections. +.SH "void QTable::removeSelection ( int num )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes selection number \fInum\fR from the table. +.PP +See also numSelections, addSelection(), and clearSelection(). +.SH "void QTable::repaintSelections ()" +Repaints all selections +.SH "void QTable::resizeData ( int len )\fC [virtual protected]\fR" +This is called when QTable's internal array needs to be resized to \fIlen\fR elements. +.PP +If you don't use QTableItems you should reimplement this as an empty method to avoid wasting memory. See the notes on large tables for further details. +.SH "int QTable::rowAt ( int y ) const\fC [virtual]\fR" +Returns the number of the row at position \fIy\fR. \fIy\fR must be given in content coordinates. +.PP +See also rowPos() and columnAt(). +.SH "int QTable::rowHeight ( int row ) const\fC [virtual]\fR" +Returns the height of row \fIrow\fR. +.PP +See also setRowHeight() and columnWidth(). +.PP +Example: table/small-table-demo/main.cpp. +.SH "void QTable::rowHeightChanged ( int row )\fC [virtual protected slot]\fR" +This function should be called whenever the row height of \fIrow\fR has been changed. It updates the geometry of any affected rows and repaints the table to reflect the changes it has made. +.SH "void QTable::rowIndexChanged ( int section, int fromIndex, int toIndex )\fC [virtual protected slot]\fR" +This function is called when the order of the rows is to be changed, i.e. the user moved the row header section \fIsection\fR from \fIfromIndex\fR to \fItoIndex\fR. +.PP +If you want to change the order programmatically, call swapRows() or swapColumns(); +.PP +See also QHeader::indexChange() and columnIndexChanged(). +.SH "bool QTable::rowMovingEnabled () const" +Returns TRUE if rows can be moved by the user; otherwise returns FALSE. See the "rowMovingEnabled" property for details. +.SH "int QTable::rowPos ( int row ) const\fC [virtual]\fR" +Returns the y-coordinate of the row \fIrow\fR in content coordinates. +.PP +See also rowAt() and columnPos(). +.SH "void QTable::selectCells ( int start_row, int start_col, int end_row, int end_col )" +Selects the range starting at \fIstart_row\fR and \fIstart_col\fR and ending at \fIend_row\fR and \fIend_col\fR. +.PP +See also QTableSelection. +.SH "void QTable::selectColumn ( int col )" +Selects the column \fIcol\fR. +.PP +See also QTableSelection. +.SH "void QTable::selectRow ( int row )" +Selects the row \fIrow\fR. +.PP +See also QTableSelection. +.SH "QTableSelection QTable::selection ( int num ) const" +Returns selection number \fInum\fR, or an inactive QTableSelection if \fInum\fR is out of range (see QTableSelection::isActive()). +.SH "void QTable::selectionChanged ()\fC [signal]\fR" +This signal is emitted whenever a selection changes. +.PP +See also QTableSelection. +.SH "SelectionMode QTable::selectionMode () const" +Returns the current selection mode. See the "selectionMode" property for details. +.SH "void QTable::setCellContentFromEditor ( int row, int col )\fC [virtual protected]\fR" +This function is called to replace the contents of the cell at \fIrow\fR, \fIcol\fR with the contents of the cell's editor. +.PP +If there already exists a QTableItem for the cell, it calls QTableItem::setContentFromEditor() on this QTableItem. +.PP +If, for example, you want to create different QTableItems depending on the contents of the editor, you might reimplement this function. +.PP +If you want to work without QTableItems, you will need to reimplement this function to save the data the user entered into your data structure. (See the notes on large tables.) +.PP +See also QTableItem::setContentFromEditor() and createEditor(). +.SH "void QTable::setCellWidget ( int row, int col, QWidget * e )\fC [virtual]\fR" +Sets the widget \fIe\fR to the cell at \fIrow\fR, \fIcol\fR and takes care of placing and resizing the widget when the cell geometry changes. +.PP +By default widgets are inserted into a vector with numRows() * numCols() elements. In very large tables you will probably want to store the widgets in a data structure that consumes less memory (see the notes on large tables). To support the use of your own data structure this function calls insertWidget() to add the widget to the internal data structure. To use your own data structure reimplement insertWidget(), cellWidget() and clearCellWidget(). +.PP +Cell widgets are created dynamically with the \fCnew\fR operator. The cell widgets are destroyed automatically once the table is destroyed; the table takes ownership of the widget when using setCellWidget. +.PP +Example: chart/setdataform.cpp. +.SH "void QTable::setColumnLabels ( const QStringList & labels )\fC [slot]\fR" +Sets the section labels of the horizontalHeader() to \fIlabels\fR +.SH "void QTable::setColumnMovingEnabled ( bool b )\fC [virtual slot]\fR" +Sets whether columns can be moved by the user to \fIb\fR. See the "columnMovingEnabled" property for details. +.SH "void QTable::setColumnReadOnly ( int col, bool ro )\fC [virtual slot]\fR" +If \fIro\fR is TRUE, column \fIcol\fR is set to be read-only; otherwise the column is set to be editable. +.PP +Whether a cell in this column is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. +.PP +See also isColumnReadOnly(), setRowReadOnly(), and readOnly. +.PP +Example: chart/setdataform.cpp. +.SH "void QTable::setColumnStretchable ( int col, bool stretch )\fC [virtual slot]\fR" +If \fIstretch\fR is TRUE, column \fIcol\fR is set to be stretchable; otherwise column \fIcol\fR is set to be unstretchable. +.PP +If the table widget's width decreases or increases stretchable columns will grow narrower or wider to fit the space available as completely as possible. The user cannot manually resize stretchable columns. +.PP +See also isColumnStretchable(), setRowStretchable(), and adjustColumn(). +.SH "void QTable::setColumnWidth ( int col, int w )\fC [virtual slot]\fR" +Resizes column \fIcol\fR to be \fIw\fR pixels wide. +.PP +See also columnWidth() and setRowHeight(). +.PP +Example: chart/setdataform.cpp. +.PP +Reimplemented in QDataTable. +.SH "void QTable::setCurrentCell ( int row, int col )\fC [virtual slot]\fR" +Moves the focus to the cell at \fIrow\fR, \fIcol\fR. +.PP +See also currentRow() and currentColumn(). +.SH "void QTable::setDragEnabled ( bool b )\fC [virtual slot]\fR" +If \fIb\fR is TRUE, the table starts a drag (see dragObject()) when the user presses and moves the mouse on a selected cell. +.SH "void QTable::setEditMode ( EditMode mode, int row, int col )\fC [protected]\fR" +Sets the current edit mode to \fImode\fR, the current edit row to \fIrow\fR and the current edit column to \fIcol\fR. +.PP +See also EditMode. +.SH "void QTable::setFocusStyle ( FocusStyle fs )\fC [virtual]\fR" +Sets how the current (focus) cell is drawn to \fIfs\fR. See the "focusStyle" property for details. +.SH "void QTable::setItem ( int row, int col, QTableItem * item )\fC [virtual]\fR" +Inserts the table item \fIitem\fR into the table at row \fIrow\fR, column \fIcol\fR, and repaints the cell. If a table item already exists in this cell it is deleted and replaced with \fIitem\fR. The table takes ownership of the table item. +.PP +If you don't use QTableItems you may need to reimplement this function: see the notes on large tables. +.PP +See also item() and takeItem(). +.PP +Examples: +.)l helpsystem/mainwindow.cpp and table/small-table-demo/main.cpp. +.SH "void QTable::setLeftMargin ( int m )\fC [virtual slot]\fR" +Sets the left margin to be \fIm\fR pixels wide. +.PP +The verticalHeader(), which displays row labels, occupies this margin. +.PP +In an Arabic or Hebrew localization, the verticalHeader() will appear on the right side of the table, and this call will set the right margin. +.PP +See also leftMargin(), setTopMargin(), and verticalHeader(). +.PP +Example: regexptester/regexptester.cpp. +.SH "void QTable::setNumCols ( int r )\fC [virtual slot]\fR" +Sets the number of columns in the table to \fIr\fR. See the "numCols" property for details. +.SH "void QTable::setNumRows ( int r )\fC [virtual slot]\fR" +Sets the number of rows in the table to \fIr\fR. See the "numRows" property for details. +.SH "void QTable::setPixmap ( int row, int col, const QPixmap & pix )\fC [virtual]\fR" +Sets the pixmap in the cell at \fIrow\fR, \fIcol\fR to \fIpix\fR. +.PP +If the cell does not contain a table item a QTableItem is created with an EditType of \fCOnTyping\fR, otherwise the existing table item's pixmap (if any) is replaced with \fIpix\fR. +.PP +Note that QComboTableItems and QCheckTableItems don't show pixmaps. +.PP +See also pixmap(), setText(), setItem(), and QTableItem::setPixmap(). +.PP +Examples: +.)l chart/setdataform.cpp and table/small-table-demo/main.cpp. +.SH "void QTable::setReadOnly ( bool b )\fC [virtual slot]\fR" +Sets whether the table is read-only to \fIb\fR. See the "readOnly" property for details. +.SH "void QTable::setRowHeight ( int row, int h )\fC [virtual slot]\fR" +Resizes row \fIrow\fR to be \fIh\fR pixels high. +.PP +See also rowHeight() and setColumnWidth(). +.SH "void QTable::setRowLabels ( const QStringList & labels )\fC [slot]\fR" +Sets the section labels of the verticalHeader() to \fIlabels\fR +.SH "void QTable::setRowMovingEnabled ( bool b )\fC [virtual slot]\fR" +Sets whether rows can be moved by the user to \fIb\fR. See the "rowMovingEnabled" property for details. +.SH "void QTable::setRowReadOnly ( int row, bool ro )\fC [virtual slot]\fR" +If \fIro\fR is TRUE, row \fIrow\fR is set to be read-only; otherwise the row is set to be editable. +.PP +Whether a cell in this row is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. +.PP +See also isRowReadOnly(), setColumnReadOnly(), and readOnly. +.SH "void QTable::setRowStretchable ( int row, bool stretch )\fC [virtual slot]\fR" +If \fIstretch\fR is TRUE, row \fIrow\fR is set to be stretchable; otherwise row \fIrow\fR is set to be unstretchable. +.PP +If the table widget's height decreases or increases stretchable rows will grow shorter or taller to fit the space available as completely as possible. The user cannot manually resize stretchable rows. +.PP +See also isRowStretchable() and setColumnStretchable(). +.SH "void QTable::setSelectionMode ( SelectionMode mode )\fC [virtual]\fR" +Sets the current selection mode to \fImode\fR. See the "selectionMode" property for details. +.SH "void QTable::setShowGrid ( bool b )\fC [virtual slot]\fR" +Sets whether the table's grid is displayed to \fIb\fR. See the "showGrid" property for details. +.SH "void QTable::setSorting ( bool b )\fC [virtual slot]\fR" +Sets whether a click on the header of a column sorts that column to \fIb\fR. See the "sorting" property for details. +.SH "void QTable::setText ( int row, int col, const QString & text )\fC [virtual]\fR" +Sets the text in the cell at \fIrow\fR, \fIcol\fR to \fItext\fR. +.PP +If the cell does not contain a table item a QTableItem is created with an EditType of \fCOnTyping\fR, otherwise the existing table item's text (if any) is replaced with \fItext\fR. +.PP +See also text(), setPixmap(), setItem(), and QTableItem::setText(). +.PP +Examples: +.)l chart/setdataform.cpp, helpsystem/mainwindow.cpp, regexptester/regexptester.cpp, and table/small-table-demo/main.cpp. +.SH "void QTable::setTopMargin ( int m )\fC [virtual slot]\fR" +Sets the top margin to be \fIm\fR pixels high. +.PP +The horizontalHeader(), which displays column labels, occupies this margin. +.PP +See also topMargin() and setLeftMargin(). +.PP +Example: regexptester/regexptester.cpp. +.SH "void QTable::showColumn ( int col )\fC [virtual slot]\fR" +Shows column \fIcol\fR. +.PP +See also hideColumn() and showRow(). +.SH "bool QTable::showGrid () const" +Returns TRUE if the table's grid is displayed; otherwise returns FALSE. See the "showGrid" property for details. +.SH "void QTable::showRow ( int row )\fC [virtual slot]\fR" +Shows row \fIrow\fR. +.PP +See also hideRow() and showColumn(). +.SH "void QTable::sortColumn ( int col, bool ascending = TRUE, bool wholeRows = FALSE )\fC [virtual]\fR" +Sorts column \fIcol\fR. If \fIascending\fR is TRUE the sort is in ascending order, otherwise the sort is in descending order. +.PP +If \fIwholeRows\fR is TRUE, entire rows are sorted using swapRows(); otherwise only cells in the column are sorted using swapCells(). +.PP +Note that if you are not using QTableItems you will need to reimplement swapRows() and swapCells(). (See the notes on large tables.) +.PP +See also swapRows(). +.PP +Example: table/statistics/statistics.cpp. +.PP +Reimplemented in QDataTable. +.SH "bool QTable::sorting () const" +Returns TRUE if a click on the header of a column sorts that column; otherwise returns FALSE. See the "sorting" property for details. +.SH "void QTable::startDrag ()\fC [virtual protected]\fR" +Starts a drag. +.PP +Usually you don't need to call or reimplement this function yourself. +.PP +See also dragObject(). +.SH "void QTable::swapCells ( int row1, int col1, int row2, int col2 )\fC [virtual slot]\fR" +Swaps the contents of the cell at \fIrow1\fR, \fIcol1\fR with the contents of the cell at \fIrow2\fR, \fIcol2\fR. +.PP +This function is also called when the table is sorted. +.PP +If you don't use QTableItems and want your users to be able to swap cells, you will need to reimplement this function. (See the notes on large tables.) +.PP +See also swapColumns() and swapRows(). +.SH "void QTable::swapColumns ( int col1, int col2, bool swapHeader = FALSE )\fC [virtual slot]\fR" +Swaps the data in \fIcol1\fR with \fIcol2\fR. +.PP +This function is used to swap the positions of two columns. It is called when the user changes the order of columns (see setColumnMovingEnabled(), and when columns are sorted. +.PP +If you don't use QTableItems and want your users to be able to swap columns you will need to reimplement this function. (See the notes on large tables.) +.PP +If \fIswapHeader\fR is TRUE, the columns' header contents is also swapped. +.PP +See also swapCells(). +.SH "void QTable::swapRows ( int row1, int row2, bool swapHeader = FALSE )\fC [virtual slot]\fR" +Swaps the data in \fIrow1\fR and \fIrow2\fR. +.PP +This function is used to swap the positions of two rows. It is called when the user changes the order of rows (see setRowMovingEnabled()), and when rows are sorted. +.PP +If you don't use QTableItems and want your users to be able to swap rows, e.g. for sorting, you will need to reimplement this function. (See the notes on large tables.) +.PP +If \fIswapHeader\fR is TRUE, the rows' header contents is also swapped. +.PP +This function will not update the QTable, you will have to do this manually, e.g. by calling updateContents(). +.PP +See also swapColumns() and swapCells(). +.SH "void QTable::takeItem ( QTableItem * i )\fC [virtual]\fR" +Takes the table item \fIi\fR out of the table. This function does \fInot\fR delete the table item. You must either delete the table item yourself or put it into a table (using setItem()) which will then take ownership of it. +.PP +Use this function if you want to move an item from one cell in a table to another, or to move an item from one table to another, reinserting the item with setItem(). +.PP +If you want to exchange two cells use swapCells(). +.SH "QString QTable::text ( int row, int col ) const\fC [virtual]\fR" +Returns the text in the cell at \fIrow\fR, \fIcol\fR, or QString::null if the relevant item does not exist or has no text. +.PP +See also setText() and setPixmap(). +.PP +Example: chart/setdataform.cpp. +.PP +Reimplemented in QDataTable. +.SH "void QTable::updateCell ( int row, int col )" +Repaints the cell at \fIrow\fR, \fIcol\fR. +.SH "void QTable::updateHeaderStates ()" +This functions updates all the header states to be in sync with the current selections. This should be called after programatically changing, adding or removing selections, so that the headers are updated. +.SH "void QTable::valueChanged ( int row, int col )\fC [signal]\fR" +This signal is emitted when the user changed the value in the cell at \fIrow\fR, \fIcol\fR. +.PP +Example: chart/setdataform.cpp. +.SH "QHeader * QTable::verticalHeader () const" +Returns the table's vertical QHeader. +.PP +This header contains the row labels. +.PP +See also horizontalHeader(), setLeftMargin(), and QHeader. +.PP +Examples: +.)l helpsystem/mainwindow.cpp and regexptester/regexptester.cpp. +.SS "Property Documentation" +.SH "bool columnMovingEnabled" +This property holds whether columns can be moved by the user. +.PP +The default is FALSE. Columns are moved by dragging whilst holding down the Ctrl key. +.PP +\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping between header indexes and section exposed by QHeader will not reflect the order of the headers in the table; i.e., QTable does not call QHeader::moveSection() to move sections but handles move operations internally. +.PP +See also rowMovingEnabled. +.PP +Set this property's value with setColumnMovingEnabled() and get this property's value with columnMovingEnabled(). +.SH "FocusStyle focusStyle" +This property holds how the current (focus) cell is drawn. +.PP +The default style is SpreadSheet. +.PP +See also QTable::FocusStyle. +.PP +Set this property's value with setFocusStyle() and get this property's value with focusStyle(). +.SH "int numCols" +This property holds the number of columns in the table. +.PP +Set this property's value with setNumCols() and get this property's value with numCols(). +.PP +See also numRows. +.SH "int numRows" +This property holds the number of rows in the table. +.PP +Set this property's value with setNumRows() and get this property's value with numRows(). +.PP +See also numCols. +.SH "int numSelections" +This property holds the number of selections. +.PP +Get this property's value with numSelections(). +.PP +See also currentSelection(). +.SH "bool readOnly" +This property holds whether the table is read-only. +.PP +Whether a cell in the table is editable or read-only depends on the cell's EditType, and this setting: see QTableItem::EditType. +.PP +See also QWidget::enabled, setColumnReadOnly(), and setRowReadOnly(). +.PP +Set this property's value with setReadOnly() and get this property's value with isReadOnly(). +.SH "bool rowMovingEnabled" +This property holds whether rows can be moved by the user. +.PP +The default is FALSE. Rows are moved by dragging whilst holding down the Ctrl key. +.PP +\fBWarning:\fR If QTable is used to move header sections as a result of user interaction, the mapping between header indexes and section exposed by QHeader will not reflect the order of the headers in the table; i.e., QTable does not call QHeader::moveSection() to move sections but handles move operations internally. +.PP +See also columnMovingEnabled. +.PP +Set this property's value with setRowMovingEnabled() and get this property's value with rowMovingEnabled(). +.SH "SelectionMode selectionMode" +This property holds the current selection mode. +.PP +The default mode is Multi which allows the user to select multiple ranges of cells. +.PP +See also SelectionMode and selectionMode. +.PP +Set this property's value with setSelectionMode() and get this property's value with selectionMode(). +.SH "bool showGrid" +This property holds whether the table's grid is displayed. +.PP +The grid is shown by default. +.PP +Set this property's value with setShowGrid() and get this property's value with showGrid(). +.SH "bool sorting" +This property holds whether a click on the header of a column sorts that column. +.PP +Set this property's value with setSorting() and get this property's value with sorting(). +.PP +See also sortColumn(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtable.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtable.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtableitem.3qt b/doc/man/man3/tqtableitem.3qt new file mode 100644 index 000000000..be7a32603 --- /dev/null +++ b/doc/man/man3/tqtableitem.3qt @@ -0,0 +1,466 @@ +'\" t +.TH QTableItem 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 +QTableItem \- The cell content for QTable cells +.SH SYNOPSIS +\fC#include <ntqtable.h>\fR +.PP +Inherits Qt. +.PP +Inherited by QComboTableItem and QCheckTableItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBEditType\fR { Never, OnTyping, WhenCurrent, Always }" +.br +.ti -1c +.BI "\fBQTableItem\fR ( QTable * table, EditType et )" +.br +.ti -1c +.BI "\fBQTableItem\fR ( QTable * table, EditType et, const QString & text )" +.br +.ti -1c +.BI "\fBQTableItem\fR ( QTable * table, EditType et, const QString & text, const QPixmap & p )" +.br +.ti -1c +.BI "virtual \fB~QTableItem\fR ()" +.br +.ti -1c +.BI "virtual QPixmap \fBpixmap\fR () const" +.br +.ti -1c +.BI "virtual QString \fBtext\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPixmap\fR ( const QPixmap & p )" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & str )" +.br +.ti -1c +.BI "QTable * \fBtable\fR () const" +.br +.ti -1c +.BI "virtual int \fBalignment\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetWordWrap\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBwordWrap\fR () const" +.br +.ti -1c +.BI "EditType \fBeditType\fR () const" +.br +.ti -1c +.BI "virtual QWidget * \fBcreateEditor\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetContentFromEditor\fR ( QWidget * w )" +.br +.ti -1c +.BI "virtual void \fBsetReplaceable\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisReplaceable\fR () const" +.br +.ti -1c +.BI "virtual QString \fBkey\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSpan\fR ( int rs, int cs )" +.br +.ti -1c +.BI "int \fBrowSpan\fR () const" +.br +.ti -1c +.BI "int \fBcolSpan\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRow\fR ( int r )" +.br +.ti -1c +.BI "virtual void \fBsetCol\fR ( int c )" +.br +.ti -1c +.BI "int \fBrow\fR () const" +.br +.ti -1c +.BI "int \fBcol\fR () const" +.br +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * p, const QColorGroup & cg, const QRect & cr, bool selected )" +.br +.ti -1c +.BI "virtual void \fBsetEnabled\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "virtual int \fBrtti\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QTableItem class provides the cell content for QTable cells. +.PP +For many applications QTableItems are ideal for presenting and editing the contents of QTable cells. In situations where you need to create very large tables you may prefer an alternative approach to using QTableItems: see the notes on large tables. +.PP +A QTableItem contains a cell's data, by default, a string and a pixmap. The table item also holds the cell's display size and how the data should be aligned. The table item specifies the cell's EditType and the editor used for in-place editing (by default a QLineEdit). If you want checkboxes use QCheckTableItem, and if you want comboboxes use QComboTableItem. The EditType (set in the constructor) determines whether the cell's contents may be edited. +.PP +If a pixmap is specified it is displayed to the left of any text. You can change the text or pixmap with setText() and setPixmap() respectively. For text you can use setWordWrap(). +.PP +When sorting table items the key() function is used; by default this returns the table item's text(). Reimplement key() to customize how your table items will sort. +.PP +Table items are inserted into a table using QTable::setItem(). If you insert an item into a cell that already contains a table item the original item will be deleted. +.PP +Example: +.PP +.nf +.br + for ( int row = 0; row < table->numRows(); row++ ) { +.br + for ( int col = 0; col < table->numCols(); col++ ) { +.br + table->setItem( row, col, +.br + new QTableItem( table, QTableItem::WhenCurrent, QString::number( row * col ) ) ); +.br + } +.br + } +.br +.fi +.PP +You can move a table item from one cell to another, in the same or a different table, using QTable::takeItem() and QTable::setItem() but see also QTable::swapCells(). +.PP +Table items can be deleted with delete in the standard way; the table and cell will be updated accordingly. +.PP +Note, that if you have a table item that is not currently in a table then anything you do to that item other than insert it into a table will result in undefined behaviour. +.PP +Reimplement createEditor() and setContentFromEditor() if you want to use your own widget instead of a QLineEdit for editing cell contents. Reimplement paint() if you want to display custom content. +.PP +It is important to ensure that your custom widget can accept the keyboard focus, so that the user can use the tab key to navigate the table as normal. Therefore, if the widget returned by createEditor() does not itself accept the keyboard focus, it is necessary to nominate a child widget to do so on its behalf. For example, a QHBox with two child QLineEdit widgets may use one of them to accept the keyboard focus: +.PP +.nf +.br + QWidget* MyTableItem::createEditor() const +.br + { +.br + QHBox* hbox = new QHBox( table()->viewport() ); +.br + hbox->setFocusProxy(new QLineEdit( hbox )); +.br + new QLineEdit( hbox ); +.br + return hbox; +.br + } +.br +.fi +.PP +By default, table items may be replaced by new QTableItems during the lifetime of a QTable. Therefore, if you create your own subclass of QTableItem, and you want to ensure that this does not happen, you must call setReplaceable(FALSE) in the constructor of your subclass. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QCheckTableItem, QComboTableItem, and Advanced Widgets. +.PP +.SS "Member Type Documentation" +.SH "QTableItem::EditType" +This enum is used to define whether a cell is editable or read-only (in conjunction with other settings), and how the cell should be displayed. +.TP +\fCQTableItem::Always\fR - The cell always \fIlooks\fR editable. +.PP +Using this EditType ensures that the editor created with createEditor() (by default a QLineEdit) is always visible. This has implications for the alignment of the content: the default editor aligns everything (even numbers) to the left whilst numerical values in the cell are by default aligned to the right. +.PP +If a cell with the edit type Always looks misaligned you could reimplement createEditor() for these items. +.TP +\fCQTableItem::WhenCurrent\fR - The cell \fIlooks\fR editable only when it has keyboard focus (see QTable::setCurrentCell()). +.TP +\fCQTableItem::OnTyping\fR - The cell \fIlooks\fR editable only when the user types in it or double-clicks it. It resembles the WhenCurrent functionality but is, perhaps, nicer. +.PP +The OnTyping edit type is the default when QTableItem objects are created by the convenience functions QTable::setText() and QTable::setPixmap(). +.TP +\fCQTableItem::Never\fR - The cell is not editable. +.PP +The cell is actually editable only if QTable::isRowReadOnly() is FALSE for its row, QTable::isColumnReadOnly() is FALSE for its column, and QTable::isReadOnly() is FALSE. +.PP +QComboTableItems have an isEditable() property. This property is used to indicate whether the user may enter their own text or are restricted to choosing one of the choices in the list. QComboTableItems may be interacted with only if they are editable in accordance with their EditType as described above. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTableItem::QTableItem ( QTable * table, EditType et )" +Creates a table item that is a child of table \fItable\fR with no text. The item has the EditType \fIet\fR. +.PP +The table item will use a QLineEdit for its editor, will not word-wrap and will occupy a single cell. Insert the table item into a table with QTable::setItem(). +.PP +The table takes ownership of the table item, so a table item should not be inserted into more than one table at a time. +.SH "QTableItem::QTableItem ( QTable * table, EditType et, const QString & text )" +Creates a table item that is a child of table \fItable\fR with text \fItext\fR. The item has the EditType \fIet\fR. +.PP +The table item will use a QLineEdit for its editor, will not word-wrap and will occupy a single cell. Insert the table item into a table with QTable::setItem(). +.PP +The table takes ownership of the table item, so a table item should not be inserted into more than one table at a time. +.SH "QTableItem::QTableItem ( QTable * table, EditType et, const QString & text, const QPixmap & p )" +Creates a table item that is a child of table \fItable\fR with text \fItext\fR and pixmap \fIp\fR. The item has the EditType \fIet\fR. +.PP +The table item will display the pixmap to the left of the text. It will use a QLineEdit for editing the text, will not word-wrap and will occupy a single cell. Insert the table item into a table with QTable::setItem(). +.PP +The table takes ownership of the table item, so a table item should not be inserted in more than one table at a time. +.SH "QTableItem::~QTableItem ()\fC [virtual]\fR" +The destructor deletes this item and frees all allocated resources. +.PP +If the table item is in a table (i.e. was inserted with setItem()), it will be removed from the table and the cell it occupied. +.SH "int QTableItem::alignment () const\fC [virtual]\fR" +The alignment function returns how the text contents of the cell are aligned when drawn. The default implementation aligns numbers to the right and any other text to the left. +.PP +See also Qt::AlignmentFlags. +.SH "int QTableItem::col () const" +Returns the column where the table item is located. If the cell spans multiple columns, this function returns the left-most column. +.PP +See also row() and setCol(). +.PP +Example: table/bigtable/main.cpp. +.SH "int QTableItem::colSpan () const" +Returns the column span of the table item, usually 1. +.PP +See also setSpan() and rowSpan(). +.SH "QWidget * QTableItem::createEditor () const\fC [virtual]\fR" +This virtual function creates an editor which the user can interact with to edit the cell's contents. The default implementation creates a QLineEdit. +.PP +If the function returns 0, the cell is read-only. +.PP +The returned widget should preferably be invisible, ideally with QTable::viewport() as parent. +.PP +If you reimplement this function you'll almost certainly need to reimplement setContentFromEditor(), and may need to reimplement sizeHint(). +.PP +.nf +.br + QWidget *ComboItem::createEditor() const +.br + { +.br + // create an editor - a combobox in our case +.br + ( (ComboItem*)this )->cb = new QComboBox( table()->viewport() ); +.br + QObject::connect( cb, SIGNAL( activated( int ) ), table(), SLOT( doValueChanged() ) ); +.br + cb->insertItem( "Yes" ); +.br + cb->insertItem( "No" ); +.br + // and initialize it +.br + cb->setCurrentItem( text() == "No" ? 1 : 0 ); +.br + return cb; +.fi +.PP +See also QTable::createEditor(), setContentFromEditor(), QTable::viewport(), and setReplaceable(). +.PP +Example: table/statistics/statistics.cpp. +.SH "EditType QTableItem::editType () const" +Returns the table item's edit type. +.PP +This is set when the table item is constructed. +.PP +See also EditType and QTableItem(). +.SH "bool QTableItem::isEnabled () const" +Returns TRUE if the table item is enabled; otherwise returns FALSE. +.PP +See also setEnabled(). +.SH "bool QTableItem::isReplaceable () const" +This function returns whether the contents of the cell may be replaced with the contents of another table item. Regardless of this setting, table items that span more than one cell may not have their contents replaced by another table item. +.PP +(This differs from EditType because EditType is concerned with whether the \fIuser\fR is able to change the contents of a cell.) +.PP +See also setReplaceable() and EditType. +.SH "QString QTableItem::key () const\fC [virtual]\fR" +This virtual function returns the key that should be used for sorting. The default implementation returns the text() of the relevant item. +.PP +See also QTable::sorting. +.SH "void QTableItem::paint ( QPainter * p, const QColorGroup & cg, const QRect & cr, bool selected )\fC [virtual]\fR" +This virtual function is used to paint the contents of an item using the painter \fIp\fR in the rectangular area \fIcr\fR using the color group \fIcg\fR. +.PP +If \fIselected\fR is TRUE the cell is displayed in a way that indicates that it is highlighted. +.PP +You don't usually need to use this function but if you want to draw custom content in a cell you will need to reimplement it. +.PP +The painter passed to this function is translated so that 0, 0 is the top-left corner of the item that is being painted. +.PP +Note that the painter is not clipped by default in order to get maximum efficiency. If you want clipping, use +.PP +.nf +.br + p->setClipRect( table()->cellRect(row, col), QPainter::ClipPainter ); +.br + //... your drawing code +.br + p->setClipping( FALSE ); +.br +.fi +.PP +Example: table/statistics/statistics.cpp. +.SH "QPixmap QTableItem::pixmap () const\fC [virtual]\fR" +Returns the table item's pixmap or a null pixmap if no pixmap has been set. +.PP +See also setPixmap() and text(). +.SH "int QTableItem::row () const" +Returns the row where the table item is located. If the cell spans multiple rows, this function returns the top-most row. +.PP +See also col() and setRow(). +.PP +Example: table/bigtable/main.cpp. +.SH "int QTableItem::rowSpan () const" +Returns the row span of the table item, usually 1. +.PP +See also setSpan() and colSpan(). +.SH "int QTableItem::rtti () const\fC [virtual]\fR" +Returns the Run Time Type Identification value for this table item which for QTableItems is 0. +.PP +When you create subclasses based on QTableItem make sure that each subclass returns a unique rtti() value. It is advisable to use values greater than 1000, preferably large random numbers, to allow for extensions to this class. +.PP +See also QCheckTableItem::rtti() and QComboTableItem::rtti(). +.PP +Reimplemented in QComboTableItem and QCheckTableItem. +.SH "void QTableItem::setCol ( int c )\fC [virtual]\fR" +Sets column \fIc\fR as the table item's column. Usually you will not need to call this function. +.PP +If the cell spans multiple columns, this function sets the left-most column and retains the width of the multi-cell table item. +.PP +See also col(), setRow(), and colSpan(). +.SH "void QTableItem::setContentFromEditor ( QWidget * w )\fC [virtual]\fR" +Whenever the content of a cell has been edited by the editor \fIw\fR, QTable calls this virtual function to copy the new values into the QTableItem. +.PP +If you reimplement createEditor() and return something that is not a QLineEdit you will need to reimplement this function. +.PP +.nf +.br + void ComboItem::setContentFromEditor( QWidget *w ) +.br + { +.br + // the user changed the value of the combobox, so synchronize the +.br + // value of the item (its text), with the value of the combobox +.br + if ( w->inherits( "QComboBox" ) ) +.br + setText( ( (QComboBox*)w )->currentText() ); +.br + else +.br + QTableItem::setContentFromEditor( w ); +.fi +.PP +See also QTable::setCellContentFromEditor(). +.PP +Example: table/statistics/statistics.cpp. +.SH "void QTableItem::setEnabled ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE, the table item is enabled; if \fIb\fR is FALSE the table item is disabled. +.PP +A disabled item doesn't respond to user interaction. +.PP +See also isEnabled(). +.SH "void QTableItem::setPixmap ( const QPixmap & p )\fC [virtual]\fR" +Sets pixmap \fIp\fR to be this item's pixmap. +.PP +Note that setPixmap() does not update the cell the table item belongs to. Use QTable::updateCell() to repaint the cell's contents. +.PP +For QComboTableItems and QCheckTableItems this function has no visible effect. +.PP +See also QTable::setPixmap(), pixmap(), and setText(). +.SH "void QTableItem::setReplaceable ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE it is acceptable to replace the contents of the cell with the contents of another QTableItem. If \fIb\fR is FALSE the contents of the cell may not be replaced by the contents of another table item. Table items that span more than one cell may not have their contents replaced by another table item. +.PP +(This differs from EditType because EditType is concerned with whether the \fIuser\fR is able to change the contents of a cell.) +.PP +See also isReplaceable(). +.SH "void QTableItem::setRow ( int r )\fC [virtual]\fR" +Sets row \fIr\fR as the table item's row. Usually you do not need to call this function. +.PP +If the cell spans multiple rows, this function sets the top row and retains the height of the multi-cell table item. +.PP +See also row(), setCol(), and rowSpan(). +.SH "void QTableItem::setSpan ( int rs, int cs )\fC [virtual]\fR" +Changes the extent of the QTableItem so that it spans multiple cells covering \fIrs\fR rows and \fIcs\fR columns. The top left cell is the original cell. +.PP +\fBWarning:\fR This function only works if the item has already been inserted into the table using e.g. QTable::setItem(). This function also checks to make sure if \fIrs\fR and \fIcs\fR are within the bounds of the table and returns without changing the span if they are not. In addition swapping, inserting or removing rows and columns that cross QTableItems spanning more than one cell is not supported. +.PP +See also rowSpan() and colSpan(). +.SH "void QTableItem::setText ( const QString & str )\fC [virtual]\fR" +Changes the table item's text to \fIstr\fR. +.PP +Note that setText() does not update the cell the table item belongs to. Use QTable::updateCell() to repaint the cell's contents. +.PP +See also QTable::setText(), text(), setPixmap(), and QTable::updateCell(). +.PP +Example: table/statistics/statistics.cpp. +.SH "void QTableItem::setWordWrap ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE, the cell's text will be wrapped over multiple lines, when necessary, to fit the width of the cell; otherwise the text will be written as a single line. +.PP +See also wordWrap(), QTable::adjustColumn(), and QTable::setColumnStretchable(). +.SH "QSize QTableItem::sizeHint () const\fC [virtual]\fR" +This virtual function returns the size a cell needs to show its entire content. +.PP +If you subclass QTableItem you will often need to reimplement this function. +.SH "QTable * QTableItem::table () const" +Returns the QTable the table item belongs to. +.PP +See also QTable::setItem() and QTableItem(). +.SH "QString QTableItem::text () const\fC [virtual]\fR" +Returns the text of the table item or QString::null if there is no text. +.PP +To ensure that the current value of the editor is returned, setContentFromEditor() is called: <ol type=1> +.TP +if the editMode() is Always, or +.TP +if editMode() is \fInot\fR Always but the editor of the cell is active and the editor is not a QLineEdit. +.PP +This means that text() returns the original text value of the item if the editor is a line edit, until the user commits an edit (e.g. by pressing Enter or Tab) in which case the new text is returned. For other editors (e.g. a combobox) setContentFromEditor() is always called so the currently display value is the one returned. +.PP +See also setText() and pixmap(). +.SH "bool QTableItem::wordWrap () const" +Returns TRUE if word wrap is enabled for the cell; otherwise returns FALSE. +.PP +See also setWordWrap(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtableitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtableitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtableselection.3qt b/doc/man/man3/tqtableselection.3qt new file mode 100644 index 000000000..1b053c6f2 --- /dev/null +++ b/doc/man/man3/tqtableselection.3qt @@ -0,0 +1,158 @@ +'\" t +.TH QTableSelection 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 +QTableSelection \- Access to a selected area in a QTable +.SH SYNOPSIS +\fC#include <ntqtable.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTableSelection\fR ()" +.br +.ti -1c +.BI "\fBQTableSelection\fR ( int start_row, int start_col, int end_row, int end_col )" +.br +.ti -1c +.BI "void \fBinit\fR ( int row, int col )" +.br +.ti -1c +.BI "void \fBexpandTo\fR ( int row, int col )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QTableSelection & s ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QTableSelection & s ) const" +.br +.ti -1c +.BI "int \fBtopRow\fR () const" +.br +.ti -1c +.BI "int \fBbottomRow\fR () const" +.br +.ti -1c +.BI "int \fBleftCol\fR () const" +.br +.ti -1c +.BI "int \fBrightCol\fR () const" +.br +.ti -1c +.BI "int \fBanchorRow\fR () const" +.br +.ti -1c +.BI "int \fBanchorCol\fR () const" +.br +.ti -1c +.BI "int \fBnumRows\fR () const" +.br +.ti -1c +.BI "int \fBnumCols\fR () const" +.br +.ti -1c +.BI "bool \fBisActive\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QTableSelection class provides access to a selected area in a QTable. +.PP +The selection is a rectangular set of cells in a QTable. One of the rectangle's cells is called the anchor cell; this is the cell that was selected first. The init() function sets the anchor and the selection rectangle to exactly this cell; the expandTo() function expands the selection rectangle to include additional cells. +.PP +There are various access functions to find out about the area: anchorRow() and anchorCol() return the anchor's position; leftCol(), rightCol(), topRow() and bottomRow() return the rectangle's four edges. All four are part of the selection. +.PP +A newly created QTableSelection is inactive -- isActive() returns FALSE. You must use init() and expandTo() to activate it. +.PP +See also QTable, QTable::addSelection(), QTable::selection(), QTable::selectCells(), QTable::selectRow(), QTable::selectColumn(), and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTableSelection::QTableSelection ()" +Creates an inactive selection. Use init() and expandTo() to activate it. +.SH "QTableSelection::QTableSelection ( int start_row, int start_col, int end_row, int end_col )" +Creates an active selection, starting at \fIstart_row\fR and \fIstart_col\fR, ending at \fIend_row\fR and \fIend_col\fR. +.SH "int QTableSelection::anchorCol () const" +Returns the anchor column of the selection. +.PP +See also anchorRow() and expandTo(). +.SH "int QTableSelection::anchorRow () const" +Returns the anchor row of the selection. +.PP +See also anchorCol() and expandTo(). +.SH "int QTableSelection::bottomRow () const" +Returns the bottom row of the selection. +.PP +See also topRow(), leftCol(), and rightCol(). +.SH "void QTableSelection::expandTo ( int row, int col )" +Expands the selection to include cell \fIrow\fR, \fIcol\fR. The new selection rectangle is the bounding rectangle of \fIrow\fR, \fIcol\fR and the previous selection rectangle. After calling this function the selection is active. +.PP +If you haven't called init(), this function does nothing. +.PP +See also init() and isActive(). +.SH "void QTableSelection::init ( int row, int col )" +Sets the selection anchor to cell \fIrow\fR, \fIcol\fR and the selection to only contain this cell. The selection is not active until expandTo() is called. +.PP +To extend the selection to include additional cells, call expandTo(). +.PP +See also isActive(). +.SH "bool QTableSelection::isActive () const" +Returns whether the selection is active or not. A selection is active after init() \fIand\fR expandTo() have been called. +.SH "bool QTableSelection::isEmpty () const" +Returns whether the selection is empty or not. +.PP +See also numRows() and numCols(). +.SH "int QTableSelection::leftCol () const" +Returns the left column of the selection. +.PP +See also topRow(), bottomRow(), and rightCol(). +.SH "int QTableSelection::numCols () const" +Returns the number of columns in the selection. +.PP +See also numRows(). +.SH "int QTableSelection::numRows () const" +Returns the number of rows in the selection. +.PP +See also numCols(). +.SH "bool QTableSelection::operator!= ( const QTableSelection & s ) const" +Returns TRUE if \fIs\fR does not include the same cells as the selection; otherwise returns FALSE. +.SH "bool QTableSelection::operator== ( const QTableSelection & s ) const" +Returns TRUE if \fIs\fR includes the same cells as the selection; otherwise returns FALSE. +.SH "int QTableSelection::rightCol () const" +Returns the right column of the selection. +.PP +See also topRow(), bottomRow(), and leftCol(). +.SH "int QTableSelection::topRow () const" +Returns the top row of the selection. +.PP +See also bottomRow(), leftCol(), and rightCol(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtableselection.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtableselection.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtabletevent.3qt b/doc/man/man3/tqtabletevent.3qt new file mode 100644 index 000000000..387fb2717 --- /dev/null +++ b/doc/man/man3/tqtabletevent.3qt @@ -0,0 +1,192 @@ +'\" t +.TH QTabletEvent 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 +QTabletEvent \- Parameters that describe a Tablet event +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBTabletDevice\fR { NoDevice = -1, Puck, Stylus, Eraser }" +.br +.ti -1c +.BI "\fBQTabletEvent\fR ( Type t, const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId )" +.br +.ti -1c +.BI "QTabletEvent ( const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBpressure\fR () const" +.br +.ti -1c +.BI "int \fBxTilt\fR () const" +.br +.ti -1c +.BI "int \fByTilt\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBpos\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBglobalPos\fR () const" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "int \fBglobalX\fR () const" +.br +.ti -1c +.BI "int \fBglobalY\fR () const" +.br +.ti -1c +.BI "TabletDevice \fBdevice\fR () const" +.br +.ti -1c +.BI "int \fBisAccepted\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.ti -1c +.BI "QPair<int, int> \fBuniqueId\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QTabletEvent class contains parameters that describe a Tablet event. +.PP +Tablet Events are generated from a Wacom© tablet. Most of the time you will want to deal with events from the tablet as if they were events from a mouse, for example retrieving the position with x(), y(), pos(), globalX(), globalY() and globalPos(). In some situations you may wish to retrieve the extra information provided by the tablet device driver, for example, you might want to adjust color brightness based on pressure. QTabletEvent allows you to get the pressure(), the xTilt() and yTilt(), as well as the type of device being used with device() (see TabletDevice). +.PP +A tablet event contains a special accept flag that indicates whether the receiver wants the event. You should call QTabletEvent::accept() if you handle the tablet event; otherwise it will be sent to the parent widget. +.PP +The QWidget::setEnabled() function can be used to enable or disable mouse and keyboard events for a widget. +.PP +The event handler QWidget::tabletEvent() receives all three types of tablet events. Qt will first send a tabletEvent and then, if it is not accepted, it will send a mouse event. This allows applications that don't utilize tablets to use a tablet like a mouse while also enabling those who want to use both tablets and mouses differently. +.PP +See also Event Classes. +.SS "Member Type Documentation" +.SH "QTabletEvent::TabletDevice" +This enum defines what type of device is generating the event. +.TP +\fCQTabletEvent::NoDevice\fR - No device, or an unknown device. +.TP +\fCQTabletEvent::Puck\fR - A Puck (a device that is similar to a flat mouse with a transparent circle with cross-hairs). +.TP +\fCQTabletEvent::Stylus\fR - A Stylus (the narrow end of the pen). +.TP +\fCQTabletEvent::Eraser\fR - An Eraser (the broad end of the pen). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTabletEvent::QTabletEvent ( Type t, const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId )" +Construct a tablet event of type \fIt\fR. The position of when the event occurred is given int \fIpos\fR and \fIglobalPos\fR. \fIdevice\fR contains the device type, \fIpressure\fR contains the pressure exerted on the \fIdevice\fR, \fIxTilt\fR and \fIyTilt\fR contain \fIdevice\fR's degree of tilt from the X and Y axis respectively. The \fIuId\fR contains an event id. +.PP +On Irix, \fIglobalPos\fR will contain the high-resolution coordinates received from the tablet device driver, instead of from the windowing system. +.PP +See also pos(), globalPos(), device(), pressure(), xTilt(), and yTilt(). +.SH "QTabletEvent::QTabletEvent ( const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Constructs a tablet event object. The position when the event occurred is is given in \fIpos\fR and \fIglobalPos\fR. \fIdevice\fR contains the device type, \fIpressure\fR contains the pressure exerted on the \fIdevice\fR, \fIxTilt\fR and \fIyTilt\fR contain the \fIdevice\fR's degrees of tilt from the X and Y axis respectively. The \fIuId\fR contains an event id. +.PP +On Irix, \fIglobalPos\fR will contain the high-resolution coordinates received from the tablet device driver, instead of from the windowing system. +.PP +See also pos(), globalPos(), device(), pressure(), xTilt(), and yTilt(). +.SH "void QTabletEvent::accept ()" +Sets the accept flag of the tablet event object. +.PP +Setting the accept flag indicates that the receiver of the event wants the tablet event. Unwanted tablet events are sent to the parent widget. +.PP +The accept flag is set by default. +.PP +See also ignore(). +.SH "TabletDevice QTabletEvent::device () const" +Returns the type of device that generated the event. Useful if you want one end of the pen to do something different than the other. +.PP +See also TabletDevice. +.SH "const QPoint & QTabletEvent::globalPos () const" +Returns the global position of the device \fIat the time of the event\fR. This is important on asynchronous windows systems like X11; whenever you move your widgets around in response to mouse events, globalPos() can differ significantly from the current position QCursor::pos(). +.PP +See also globalX() and globalY(). +.SH "int QTabletEvent::globalX () const" +Returns the global x-position of the mouse pointer at the time of the event. +.PP +See also globalY() and globalPos(). +.SH "int QTabletEvent::globalY () const" +Returns the global y-position of the mouse pointer at the time of the event. +.PP +See also globalX() and globalPos(). +.SH "void QTabletEvent::ignore ()" +Clears the accept flag parameter of the tablet event object. +.PP +Clearing the accept flag indicates that the event receiver does not want the tablet event. Unwanted tablet events are sent to the parent widget. +.PP +The accept flag is set by default. +.PP +See also accept(). +.SH "int QTabletEvent::isAccepted () const" +Returns TRUE if the receiver of the event handles the tablet event; otherwise returns FALSE. +.SH "const QPoint & QTabletEvent::pos () const" +Returns the position of the device, relative to the widget that received the event. +.PP +If you move widgets around in response to mouse events, use globalPos() instead of this function. +.PP +See also x(), y(), and globalPos(). +.SH "int QTabletEvent::pressure () const" +Returns the pressure that is exerted on the device. This number is a value from 0 (no pressure) to 255 (maximum pressure). The pressure is always scaled to be within this range no matter how many pressure levels the underlying hardware supports. +.SH "QPair<int, int> QTabletEvent::uniqueId ()" +Returns a unique ID for the current device. It is possible to generate a unique ID for any Wacom© device. This makes it possible to differentiate between multiple devices being used at the same time on the tablet. The \fCfirst\fR member contains a value for the type, the \fCsecond\fR member contains a physical ID obtained from the device. Each combination of these values is unique. Note: for different platforms, the \fCfirst\fR value is different due to different driver implementations. +.SH "int QTabletEvent::x () const" +Returns the x-position of the device, relative to the widget that received the event. +.PP +See also y() and pos(). +.SH "int QTabletEvent::xTilt () const" +Returns the difference from the perpendicular in the X Axis. Positive values are towards the tablet's physical right. The angle is in the range -60 to +60 degrees. +.PP +See also yTilt(). +.SH "int QTabletEvent::y () const" +Returns the y-position of the device, relative to the widget that received the event. +.PP +See also x() and pos(). +.SH "int QTabletEvent::yTilt () const" +Returns the difference from the perpendicular in the Y Axis. Positive values are towards the bottom of the tablet. The angle is within the range -60 to +60 degrees. +.PP +See also xTilt(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtabletevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtabletevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtabwidget.3qt b/doc/man/man3/tqtabwidget.3qt new file mode 100644 index 000000000..6360b75a2 --- /dev/null +++ b/doc/man/man3/tqtabwidget.3qt @@ -0,0 +1,424 @@ +'\" t +.TH QTabWidget 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 +QTabWidget \- Stack of tabbed widgets +.SH SYNOPSIS +\fC#include <ntqtabwidget.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTabWidget\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "virtual void \fBaddTab\fR ( QWidget * child, const QString & label )" +.br +.ti -1c +.BI "virtual void \fBaddTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label )" +.br +.ti -1c +.BI "virtual void \fBaddTab\fR ( QWidget * child, QTab * tab )" +.br +.ti -1c +.BI "virtual void \fBinsertTab\fR ( QWidget * child, const QString & label, int index = -1 )" +.br +.ti -1c +.BI "virtual void \fBinsertTab\fR ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )" +.br +.ti -1c +.BI "virtual void \fBinsertTab\fR ( QWidget * child, QTab * tab, int index = -1 )" +.br +.ti -1c +.BI "void \fBchangeTab\fR ( QWidget * w, const QString & label )" +.br +.ti -1c +.BI "void \fBchangeTab\fR ( QWidget * w, const QIconSet & iconset, const QString & label )" +.br +.ti -1c +.BI "bool \fBisTabEnabled\fR ( QWidget * w ) const" +.br +.ti -1c +.BI "void \fBsetTabEnabled\fR ( QWidget * w, bool enable )" +.br +.ti -1c +.BI "void \fBsetCornerWidget\fR ( QWidget * w, Qt::Corner corner = Qt::TopRight )" +.br +.ti -1c +.BI "QWidget * \fBcornerWidget\fR ( Qt::Corner corner = Qt::TopRight ) const" +.br +.ti -1c +.BI "QString \fBtabLabel\fR ( QWidget * w ) const" +.br +.ti -1c +.BI "void \fBsetTabLabel\fR ( QWidget * w, const QString & l )" +.br +.ti -1c +.BI "QIconSet \fBtabIconSet\fR ( QWidget * w ) const" +.br +.ti -1c +.BI "void \fBsetTabIconSet\fR ( QWidget * w, const QIconSet & iconset )" +.br +.ti -1c +.BI "void \fBremoveTabToolTip\fR ( QWidget * w )" +.br +.ti -1c +.BI "void \fBsetTabToolTip\fR ( QWidget * w, const QString & tip )" +.br +.ti -1c +.BI "QString \fBtabToolTip\fR ( QWidget * w ) const" +.br +.ti -1c +.BI "QWidget * \fBcurrentPage\fR () const" +.br +.ti -1c +.BI "QWidget * \fBpage\fR ( int index ) const" +.br +.ti -1c +.BI "QString \fBlabel\fR ( int index ) const" +.br +.ti -1c +.BI "int \fBcurrentPageIndex\fR () const" +.br +.ti -1c +.BI "int \fBindexOf\fR ( QWidget * w ) const" +.br +.ti -1c +.BI "enum \fBTabPosition\fR { Top, Bottom }" +.br +.ti -1c +.BI "TabPosition \fBtabPosition\fR () const" +.br +.ti -1c +.BI "void \fBsetTabPosition\fR ( TabPosition )" +.br +.ti -1c +.BI "enum \fBTabShape\fR { Rounded, Triangular }" +.br +.ti -1c +.BI "TabShape \fBtabShape\fR () const" +.br +.ti -1c +.BI "void \fBsetTabShape\fR ( TabShape s )" +.br +.ti -1c +.BI "int \fBmargin\fR () const" +.br +.ti -1c +.BI "void \fBsetMargin\fR ( int )" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBsetCurrentPage\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBshowPage\fR ( QWidget * w )" +.br +.ti -1c +.BI "virtual void \fBremovePage\fR ( QWidget * w )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBcurrentChanged\fR ( QWidget * )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoMask\fR - whether the tab widget is automatically masked \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcount\fR - the number of tabs in the tab bar \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcurrentPage\fR - the index position of the current tab page" +.br +.ti -1c +.BI "int \fBmargin\fR - the margin in this tab widget" +.br +.ti -1c +.BI "TabPosition \fBtabPosition\fR - the position of the tabs in this tab widget" +.br +.ti -1c +.BI "TabShape \fBtabShape\fR - the shape of the tabs in this tab widget" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsetTabBar\fR ( QTabBar * tb )" +.br +.ti -1c +.BI "QTabBar * \fBtabBar\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QTabWidget class provides a stack of tabbed widgets. +.PP +A tab widget provides a tab bar of tabs and a `page area' below (or above, see TabPosition) the tabs. Each tab is associated with a different widget (called a `page'). Only the current tab's page is shown in the page area; all the other tabs' pages are hidden. The user can show a different page by clicking on its tab or by pressing its Alt+\fIletter\fR accelerator if it has one. +.PP +The normal way to use QTabWidget is to do the following in the constructor: <ol type=1> +.IP 1 +Create a QTabWidget. +.IP 2 +Create a QWidget for each of the pages in the tab dialog, insert children into it, set up geometry management for it and use addTab() (or insertTab()) to set up a tab and keyboard accelerator for it. +.IP 3 +Connect to the signals and slots. +.PP +The position of the tabs is set with setTabPosition(), their shape with setTabShape(), and their margin with setMargin(). +.PP +If you don't call addTab() and the QTabWidget is already visible, then the page you have created will not be visible. Don't confuse the object name you supply to the QWidget constructor and the tab label you supply to addTab(). addTab() takes a name which indicates an accelerator and is meaningful and descriptive to the user, whereas the widget name is used primarily for debugging. +.PP +The signal currentChanged() is emitted when the user selects a page. +.PP +The current page is available as an index position with currentPageIndex() or as a wiget pointer with currentPage(). You can retrieve a pointer to a page with a given index using page(), and can find the index position of a page with indexOf(). Use setCurrentPage() to show a particular page by index, or showPage() to show a page by widget pointer. +.PP +You can change a tab's label and iconset using changeTab() or setTabLabel() and setTabIconSet(). A tab page can be removed with removePage(). +.PP +Each tab is either enabled or disabled at any given time (see setTabEnabled()). If a tab is enabled, the tab text is drawn normally and the user can select that tab. If it is disabled, the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible, for example if all of the tabs happen to be disabled. +.PP +Although tab widgets can be a very good way to split up a complex dialog, it's also very easy to get into a mess. See QTabDialog for some design hints. An alternative is to use a QWidgetStack for which you provide some means of navigating between pages, for example, a QToolBar or a QListBox. +.PP +Most of the functionality in QTabWidget is provided by a QTabBar (at the top, providing the tabs) and a QWidgetStack (most of the area, organizing the individual pages). +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also QTabDialog, QToolBox, Advanced Widgets, and Organizers. +.SS "Member Type Documentation" +.SH "QTabWidget::TabPosition" +This enum type defines where QTabWidget draws the tab row: +.TP +\fCQTabWidget::Top\fR - above the pages +.TP +\fCQTabWidget::Bottom\fR - below the pages +.SH "QTabWidget::TabShape" +This enum type defines the shape of the tabs: +.TP +\fCQTabWidget::Rounded\fR - rounded look (normal) +.TP +\fCQTabWidget::Triangular\fR - triangular look (very unusual, included for completeness) +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTabWidget::QTabWidget ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a tabbed widget called \fIname\fR with parent \fIparent\fR, and widget flags \fIf\fR. +.SH "void QTabWidget::addTab ( QWidget * child, const QString & label )\fC [virtual]\fR" +Adds another tab and page to the tab view. +.PP +The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. +.PP +If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. +.PP +If you call addTab() after show() the screen will flicker and the user may be confused. +.PP +Adding the same child twice will have undefined behavior. +.PP +See also insertTab(). +.PP +Examples: +.)l addressbook/centralwidget.cpp and themes/themes.cpp. +.SH "void QTabWidget::addTab ( QWidget * child, const QIconSet & iconset, const QString & label )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds another tab and page to the tab view. +.PP +This function is the same as addTab(), but with an additional \fIiconset\fR. +.SH "void QTabWidget::addTab ( QWidget * child, QTab * tab )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is a low-level function for adding tabs. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. The \fIchild\fR is the new page and \fItab\fR is the tab to put the \fIchild\fR on. +.SH "void QTabWidget::changeTab ( QWidget * w, const QString & label )" +Defines a new \fIlabel\fR for page \fIw\fR's tab. +.SH "void QTabWidget::changeTab ( QWidget * w, const QIconSet & iconset, const QString & label )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Defines a new \fIiconset\fR and a new \fIlabel\fR for page \fIw\fR's tab. +.SH "QWidget * QTabWidget::cornerWidget ( Qt::Corner corner = Qt::TopRight ) const" +Returns the widget shown in the \fIcorner\fR of the tab widget or 0. +.SH "int QTabWidget::count () const" +Returns the number of tabs in the tab bar. See the "count" property for details. +.SH "void QTabWidget::currentChanged ( QWidget * )\fC [signal]\fR" +This signal is emitted whenever the current page changes. The parameter is the new current page. +.PP +See also currentPage(), showPage(), and tabLabel(). +.SH "QWidget * QTabWidget::currentPage () const" +Returns a pointer to the page currently being displayed by the tab dialog. The tab dialog does its best to make sure that this value is never 0 (but if you try hard enough, it can be). +.SH "int QTabWidget::currentPageIndex () const" +Returns the index position of the current tab page. See the "currentPage" property for details. +.SH "int QTabWidget::indexOf ( QWidget * w ) const" +Returns the index position of page \fIw\fR, or -1 if the widget cannot be found. +.SH "void QTabWidget::insertTab ( QWidget * child, const QString & label, int index = -1 )\fC [virtual]\fR" +Inserts another tab and page to the tab view. +.PP +The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. +.PP +If the tab's \fIlabel\fR contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. +.PP +If \fIindex\fR is not specified, the tab is simply appended. Otherwise it is inserted at the specified position. +.PP +If you call insertTab() after show(), the screen will flicker and the user may be confused. +.PP +See also addTab(). +.SH "void QTabWidget::insertTab ( QWidget * child, const QIconSet & iconset, const QString & label, int index = -1 )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts another tab and page to the tab view. +.PP +This function is the same as insertTab(), but with an additional \fIiconset\fR. +.SH "void QTabWidget::insertTab ( QWidget * child, QTab * tab, int index = -1 )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This is a lower-level method for inserting tabs, similar to the other insertTab() method. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. The \fIchild\fR is the new page, \fItab\fR is the tab to put the \fIchild\fR on and \fIindex\fR is the position in the tab bar that this page should occupy. +.SH "bool QTabWidget::isTabEnabled ( QWidget * w ) const" +Returns TRUE if the page \fIw\fR is enabled; otherwise returns FALSE. +.PP +See also setTabEnabled() and QWidget::enabled. +.SH "QString QTabWidget::label ( int index ) const" +Returns the label of the tab at index position \fIindex\fR or QString::null if the \fIindex\fR is out of range. +.SH "int QTabWidget::margin () const" +Returns the margin in this tab widget. See the "margin" property for details. +.SH "QWidget * QTabWidget::page ( int index ) const" +Returns the tab page at index position \fIindex\fR or 0 if the \fIindex\fR is out of range. +.SH "void QTabWidget::removePage ( QWidget * w )\fC [virtual slot]\fR" +Removes page \fIw\fR from this stack of widgets. Does not delete \fIw\fR. +.PP +See also addTab(), showPage(), and QWidgetStack::removeWidget(). +.SH "void QTabWidget::removeTabToolTip ( QWidget * w )" +Removes the tab tool tip for page \fIw\fR. If the page does not have a tip, nothing happens. +.PP +See also setTabToolTip() and tabToolTip(). +.SH "void QTabWidget::setCornerWidget ( QWidget * w, Qt::Corner corner = Qt::TopRight )" +Sets widget \fIw\fR to be the shown in the specified \fIcorner\fR of the tab widget. +.PP +Only the horizontal element of the \fIcorner\fR will be used. +.PP +See also cornerWidget() and tabPosition. +.SH "void QTabWidget::setCurrentPage ( int )\fC [slot]\fR" +Sets the index position of the current tab page. See the "currentPage" property for details. +.SH "void QTabWidget::setMargin ( int )" +Sets the margin in this tab widget. See the "margin" property for details. +.SH "void QTabWidget::setTabBar ( QTabBar * tb )\fC [protected]\fR" +Replaces the dialog's QTabBar heading with the tab bar \fItb\fR. Note that this must be called \fIbefore\fR any tabs have been added, or the behavior is undefined. +.PP +See also tabBar(). +.SH "void QTabWidget::setTabEnabled ( QWidget * w, bool enable )" +If \fIenable\fR is TRUE, page \fIw\fR is enabled; otherwise page \fIw\fR is disabled. The page's tab is redrawn appropriately. +.PP +QTabWidget uses QWidget::setEnabled() internally, rather than keeping a separate flag. +.PP +Note that even a disabled tab/page may be visible. If the page is visible already, QTabWidget will not hide it; if all the pages are disabled, QTabWidget will show one of them. +.PP +See also isTabEnabled() and QWidget::enabled. +.SH "void QTabWidget::setTabIconSet ( QWidget * w, const QIconSet & iconset )" +Sets the iconset for page \fIw\fR to \fIiconset\fR. +.SH "void QTabWidget::setTabLabel ( QWidget * w, const QString & l )" +Sets the tab label for page \fIw\fR to \fIl\fR +.SH "void QTabWidget::setTabPosition ( TabPosition )" +Sets the position of the tabs in this tab widget. See the "tabPosition" property for details. +.SH "void QTabWidget::setTabShape ( TabShape s )" +Sets the shape of the tabs in this tab widget to \fIs\fR. See the "tabShape" property for details. +.SH "void QTabWidget::setTabToolTip ( QWidget * w, const QString & tip )" +Sets the tab tool tip for page \fIw\fR to \fItip\fR. +.PP +See also removeTabToolTip() and tabToolTip(). +.SH "void QTabWidget::showPage ( QWidget * w )\fC [virtual slot]\fR" +Ensures that page \fIw\fR is shown. This is useful mainly for accelerators. +.PP +\fBWarning:\fR Used carelessly, this function can easily surprise or confuse the user. +.PP +See also QTabBar::currentTab. +.SH "QTabBar * QTabWidget::tabBar () const\fC [protected]\fR" +Returns the current QTabBar. +.PP +See also setTabBar(). +.SH "QIconSet QTabWidget::tabIconSet ( QWidget * w ) const" +Returns the iconset of page \fIw\fR or a null iconset if \fIw\fR is not a tab page or does not have an iconset. +.SH "QString QTabWidget::tabLabel ( QWidget * w ) const" +Returns the label text for the tab on page \fIw\fR. +.SH "TabPosition QTabWidget::tabPosition () const" +Returns the position of the tabs in this tab widget. See the "tabPosition" property for details. +.SH "TabShape QTabWidget::tabShape () const" +Returns the shape of the tabs in this tab widget. See the "tabShape" property for details. +.SH "QString QTabWidget::tabToolTip ( QWidget * w ) const" +Returns the tab tool tip for page \fIw\fR or QString::null if no tool tip has been set. +.PP +See also setTabToolTip() and removeTabToolTip(). +.SS "Property Documentation" +.SH "bool autoMask" +This property holds whether the tab widget is automatically masked. +.PP +See also QWidget::autoMask. +.SH "int count" +This property holds the number of tabs in the tab bar. +.PP +Get this property's value with count(). +.SH "int currentPage" +This property holds the index position of the current tab page. +.PP +Set this property's value with setCurrentPage() and get this property's value with currentPageIndex(). +.PP +See also QTabBar::currentTab. +.SH "int margin" +This property holds the margin in this tab widget. +.PP +The margin is the distance between the innermost pixel of the frame and the outermost pixel of the pages. +.PP +Set this property's value with setMargin() and get this property's value with margin(). +.SH "TabPosition tabPosition" +This property holds the position of the tabs in this tab widget. +.PP +Possible values for this property are QTabWidget::Top and QTabWidget::Bottom. +.PP +See also TabPosition. +.PP +Set this property's value with setTabPosition() and get this property's value with tabPosition(). +.SH "TabShape tabShape" +This property holds the shape of the tabs in this tab widget. +.PP +Possible values for this property are QTabWidget::Rounded (default) or QTabWidget::Triangular. +.PP +See also TabShape. +.PP +Set this property's value with setTabShape() and get this property's value with tabShape(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtabwidget.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtabwidget.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextbrowser.3qt b/doc/man/man3/tqtextbrowser.3qt new file mode 100644 index 000000000..20f8c2504 --- /dev/null +++ b/doc/man/man3/tqtextbrowser.3qt @@ -0,0 +1,231 @@ +'\" t +.TH QTextBrowser 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 +QTextBrowser \- Rich text browser with hypertext navigation +.SH SYNOPSIS +\fC#include <ntqtextbrowser.h>\fR +.PP +Inherits QTextEdit. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTextBrowser\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "QString \fBsource\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetSource\fR ( const QString & name )" +.br +.ti -1c +.BI "virtual void \fBbackward\fR ()" +.br +.ti -1c +.BI "virtual void \fBforward\fR ()" +.br +.ti -1c +.BI "virtual void \fBhome\fR ()" +.br +.ti -1c +.BI "virtual void \fBreload\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBbackwardAvailable\fR ( bool available )" +.br +.ti -1c +.BI "void \fBforwardAvailable\fR ( bool available )" +.br +.ti -1c +.BI "void \fBsourceChanged\fR ( const QString & src )" +.br +.ti -1c +.BI "void \fBhighlighted\fR ( const QString & link )" +.br +.ti -1c +.BI "void \fBlinkClicked\fR ( const QString & link )" +.br +.ti -1c +.BI "void \fBanchorClicked\fR ( const QString & name, const QString & link )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBmodified\fR - whether the contents have been modified \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBoverwriteMode\fR - this text browser's overwrite mode \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBreadOnly\fR - whether the contents are read only \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QString \fBsource\fR - the name of the displayed document" +.br +.ti -1c +.BI "int \fBundoDepth\fR - this text browser's undo depth \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBundoRedoEnabled\fR - whether undo and redo are enabled \fI(read " "only" ")\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" +.br +.in -1c +.SH DESCRIPTION +The QTextBrowser class provides a rich text browser with hypertext navigation. +.PP +This class extends QTextEdit (in read-only mode), adding some navigation functionality so that users can follow links in hypertext documents. The contents of QTextEdit is set with setText(), but QTextBrowser has an additional function, setSource(), which makes it possible to set the text to a named document. The name is looked up in the text view's mime source factory. If a document name ends with an anchor (for example, "\fC#anchor"\fR), the text browser automatically scrolls to that position (using scrollToAnchor()). When the user clicks on a hyperlink, the browser will call setSource() itself, with the link's \fChref\fR value as argument. You can track the current source by connetion to the sourceChanged() signal. +.PP +QTextBrowser provides backward() and forward() slots which you can use to implement Back and Forward buttons. The home() slot sets the text to the very first document displayed. The linkClicked() signal is emitted when the user clicks a link. +.PP +By using QTextEdit::setMimeSourceFactory() you can provide your own subclass of QMimeSourceFactory. This makes it possible to access data from anywhere, for example from a network or from a database. See QMimeSourceFactory::data() for details. +.PP +If you intend using the mime factory to read the data directly from the file system, you may have to specify the encoding for the file extension you are using. For example: +.PP +.nf +.br + mimeSourceFactory()->setExtensionType("qml", "text/utf8"); +.br +.fi +This is to ensure that the factory is able to resolve the document names. +.PP +QTextBrowser interprets the tags it processes in accordance with the default style sheet. Change the style sheet with setStyleSheet(); see QStyleSheet for details. +.PP +If you want to provide your users with editable rich text use QTextEdit. If you want a text browser without hypertext navigation use QTextEdit, and use QTextEdit::setReadOnly() to disable editing. If you just need to display a small piece of rich text use QSimpleRichText or QLabel. +.PP +.ce 1 +.B "[Image Omitted]" +.PP + +.ce 1 +.B "[Image Omitted]" +.PP +See also Advanced Widgets, Help System, and Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextBrowser::QTextBrowser ( QWidget * parent = 0, const char * name = 0 )" +Constructs an empty QTextBrowser called \fIname\fR, with parent \fIparent\fR. +.SH "void QTextBrowser::anchorClicked ( const QString & name, const QString & link )\fC [signal]\fR" +This signal is emitted when the user clicks an anchor. The \fIlink\fR is the value of the \fChref\fR i.e. the name of the target document. The \fIname\fR is the name of the anchor. +.PP +See also linkClicked(). +.SH "void QTextBrowser::backward ()\fC [virtual slot]\fR" +Changes the document displayed to the previous document in the list of documents built by navigating links. Does nothing if there is no previous document. +.PP +See also forward() and backwardAvailable(). +.PP +Example: helpviewer/helpwindow.cpp. +.SH "void QTextBrowser::backwardAvailable ( bool available )\fC [signal]\fR" +This signal is emitted when the availability of backward() changes. \fIavailable\fR is FALSE when the user is at home(); otherwise it is TRUE. +.PP +Example: helpviewer/helpwindow.cpp. +.SH "void QTextBrowser::forward ()\fC [virtual slot]\fR" +Changes the document displayed to the next document in the list of documents built by navigating links. Does nothing if there is no next document. +.PP +See also backward() and forwardAvailable(). +.PP +Example: helpviewer/helpwindow.cpp. +.SH "void QTextBrowser::forwardAvailable ( bool available )\fC [signal]\fR" +This signal is emitted when the availability of forward() changes. \fIavailable\fR is TRUE after the user navigates backward() and FALSE when the user navigates or goes forward(). +.PP +Example: helpviewer/helpwindow.cpp. +.SH "void QTextBrowser::highlighted ( const QString & link )\fC [signal]\fR" +This signal is emitted when the user has selected but not activated a link in the document. \fIlink\fR is the value of the \fChref\fR i.e. the name of the target document. +.PP +Example: helpviewer/helpwindow.cpp. +.SH "void QTextBrowser::home ()\fC [virtual slot]\fR" +Changes the document displayed to be the first document the browser displayed. +.PP +Example: helpviewer/helpwindow.cpp. +.SH "void QTextBrowser::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" +The event \fIe\fR is used to provide the following keyboard shortcuts: <center>.nf +.TS +l - l. Keypress Action Alt+Left Arrow backward() Alt+Right Arrow forward() Alt+Up Arrow +.TE +.fi +</center> +.PP +Reimplemented from QTextEdit. +.SH "void QTextBrowser::linkClicked ( const QString & link )\fC [signal]\fR" +This signal is emitted when the user clicks a link. The \fIlink\fR is the value of the \fChref\fR i.e. the name of the target document. +.PP +The \fIlink\fR will be the absolute location of the document, based on the value of the anchor's href tag and the current context of the document. +.PP +See also anchorClicked() and context(). +.SH "void QTextBrowser::reload ()\fC [virtual slot]\fR" +Reloads the current set source. +.SH "void QTextBrowser::setSource ( const QString & name )\fC [virtual slot]\fR" +Sets the name of the displayed document to \fIname\fR. See the "source" property for details. +.SH "QString QTextBrowser::source () const" +Returns the name of the displayed document. See the "source" property for details. +.SH "void QTextBrowser::sourceChanged ( const QString & src )\fC [signal]\fR" +This signal is emitted when the mime source has changed, \fIsrc\fR being the new source. +.PP +Source changes happen both programmatically when calling setSource(), forward(), backword() or home() or when the user clicks on links or presses the equivalent key sequences. +.PP +Example: helpviewer/helpwindow.cpp. +.SS "Property Documentation" +.SH "bool modified" +This property holds whether the contents have been modified. +.SH "bool overwriteMode" +This property holds this text browser's overwrite mode. +.SH "bool readOnly" +This property holds whether the contents are read only. +.SH "QString source" +This property holds the name of the displayed document. +.PP +This is a QString::null if no document is displayed or if the source is unknown. +.PP +Setting this property uses the mimeSourceFactory() to lookup the named document. It also checks for optional anchors and scrolls the document accordingly. +.PP +If the first tag in the document is \fC<qt type=detail>\fR, the document is displayed as a popup rather than as new document in the browser window itself. Otherwise, the document is displayed normally in the text browser with the text set to the contents of the named document with setText(). +.PP +If you are using the filesystem access capabilities of the mime source factory, you must ensure that the factory knows about the encoding of specified files; otherwise no data will be available. The default factory handles a couple of common file extensions such as \fC*.html\fR and \fC*.txt\fR with reasonable defaults. See QMimeSourceFactory::data() for details. +.PP +Set this property's value with setSource() and get this property's value with source(). +.SH "int undoDepth" +This property holds this text browser's undo depth. +.SH "bool undoRedoEnabled" +This property holds whether undo and redo are enabled. +.PP + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtextbrowser.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextbrowser.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextcodec.3qt b/doc/man/man3/tqtextcodec.3qt new file mode 100644 index 000000000..2191c2328 --- /dev/null +++ b/doc/man/man3/tqtextcodec.3qt @@ -0,0 +1,586 @@ +'\" t +.TH QTextCodec 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 +QTextCodec \- Conversion between text encodings +.SH SYNOPSIS +Almost all the functions in this class are reentrant when Qt is built with thread support. The exceptions are \fB~QTextCodec\fR(), \fBsetCodecForTr\fR(), \fBsetCodecForCStrings\fR(), and \fBQTextCodec\fR(). </p> +.PP +\fC#include <ntqtextcodec.h>\fR +.PP +Inherited by QBig5Codec, QBig5hkscsCodec, QEucJpCodec, QEucKrCodec, QGb18030Codec, QJisCodec, QHebrewCodec, QSjisCodec, and QTsciiCodec. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QTextCodec\fR ()" +.br +.ti -1c +.BI "virtual const char * \fBname\fR () const = 0" +.br +.ti -1c +.BI "virtual const char * \fBmimeName\fR () const" +.br +.ti -1c +.BI "virtual int \fBmibEnum\fR () const = 0" +.br +.ti -1c +.BI "virtual QTextDecoder * \fBmakeDecoder\fR () const" +.br +.ti -1c +.BI "virtual QTextEncoder * \fBmakeEncoder\fR () const" +.br +.ti -1c +.BI "virtual QString \fBtoUnicode\fR ( const char * chars, int len ) const" +.br +.ti -1c +.BI "virtual QCString \fBfromUnicode\fR ( const QString & uc, int & lenInOut ) const" +.br +.ti -1c +.BI "QCString \fBfromUnicode\fR ( const QString & uc ) const" +.br +.ti -1c +.BI "QString \fBtoUnicode\fR ( const QByteArray & a, int len ) const" +.br +.ti -1c +.BI "QString \fBtoUnicode\fR ( const QByteArray & a ) const" +.br +.ti -1c +.BI "QString \fBtoUnicode\fR ( const QCString & a, int len ) const" +.br +.ti -1c +.BI "QString \fBtoUnicode\fR ( const QCString & a ) const" +.br +.ti -1c +.BI "QString \fBtoUnicode\fR ( const char * chars ) const" +.br +.ti -1c +.BI "virtual bool \fBcanEncode\fR ( QChar ch ) const" +.br +.ti -1c +.BI "virtual bool \fBcanEncode\fR ( const QString & s ) const" +.br +.ti -1c +.BI "virtual int \fBheuristicContentMatch\fR ( const char * chars, int len ) const = 0" +.br +.ti -1c +.BI "virtual int \fBheuristicNameMatch\fR ( const char * hint ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QTextCodec * \fBloadCharmap\fR ( QIODevice * iod )" +.br +.ti -1c +.BI "QTextCodec * \fBloadCharmapFile\fR ( QString filename )" +.br +.ti -1c +.BI "QTextCodec * \fBcodecForMib\fR ( int mib )" +.br +.ti -1c +.BI "QTextCodec * \fBcodecForName\fR ( const char * name, int accuracy = 0 )" +.br +.ti -1c +.BI "QTextCodec * \fBcodecForContent\fR ( const char * chars, int len )" +.br +.ti -1c +.BI "QTextCodec * \fBcodecForIndex\fR ( int i )" +.br +.ti -1c +.BI "QTextCodec * \fBcodecForLocale\fR ()" +.br +.ti -1c +.BI "void \fBsetCodecForLocale\fR ( QTextCodec * c )" +.br +.ti -1c +.BI "QTextCodec * \fBcodecForTr\fR ()" +.br +.ti -1c +.BI "void \fBsetCodecForTr\fR ( QTextCodec * c )" +.br +.ti -1c +.BI "QTextCodec * \fBcodecForCStrings\fR ()" +.br +.ti -1c +.BI "void \fBsetCodecForCStrings\fR ( QTextCodec * c )" +.br +.ti -1c +.BI "void \fBdeleteAllCodecs\fR ()" +.br +.ti -1c +.BI "const char * \fBlocale\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQTextCodec\fR ()" +.br +.in -1c +.SS "Static Protected Members" +.in +1c +.ti -1c +.BI "int \fBsimpleHeuristicNameMatch\fR ( const char * name, const char * hint )" +.br +.in -1c +.SH DESCRIPTION +The QTextCodec class provides conversion between text encodings. +.PP +Qt uses Unicode to store, draw and manipulate strings. In many situations you may wish to deal with data that uses a different encoding. For example, most Japanese documents are still stored in Shift-JIS or ISO2022, while Russian users often have their documents in KOI8-R or CP1251. +.PP +Qt provides a set of QTextCodec classes to help with converting non-Unicode formats to and from Unicode. You can also create your own codec classes (see later). +.PP +The supported encodings are: +.TP +Latin1 +.TP +Big5 -- Chinese +.TP +Big5-HKSCS -- Chinese +.TP +eucJP -- Japanese +.TP +eucKR -- Korean +.TP +GB2312 -- Chinese +.TP +GBK -- Chinese +.TP +GB18030 -- Chinese +.TP +JIS7 -- Japanese +.TP +Shift-JIS -- Japanese +.TP +TSCII -- Tamil +.TP +utf8 -- Unicode, 8-bit +.TP +utf16 -- Unicode +.TP +KOI8-R -- Russian +.TP +KOI8-U -- Ukrainian +.TP +ISO8859-1 -- Western +.TP +ISO8859-2 -- Central European +.TP +ISO8859-3 -- Central European +.TP +ISO8859-4 -- Baltic +.TP +ISO8859-5 -- Cyrillic +.TP +ISO8859-6 -- Arabic +.TP +ISO8859-7 -- Greek +.TP +ISO8859-8 -- Hebrew, visually ordered +.TP +ISO8859-8-i -- Hebrew, logically ordered +.TP +ISO8859-9 -- Turkish +.TP +ISO8859-10 +.TP +ISO8859-13 +.TP +ISO8859-14 +.TP +ISO8859-15 -- Western +.TP +IBM 850 +.TP +IBM 866 +.TP +CP874 +.TP +CP1250 -- Central European +.TP +CP1251 -- Cyrillic +.TP +CP1252 -- Western +.TP +CP1253 -- Greek +.TP +CP1254 -- Turkish +.TP +CP1255 -- Hebrew +.TP +CP1256 -- Arabic +.TP +CP1257 -- Baltic +.TP +CP1258 +.TP +Apple Roman +.TP +TIS-620 -- Thai +.PP +QTextCodecs can be used as follows to convert some locally encoded string to Unicode. Suppose you have some string encoded in Russian KOI8-R encoding, and want to convert it to Unicode. The simple way to do this is: +.PP +.nf +.br + QCString locallyEncoded = "..."; // text to convert +.br + QTextCodec *codec = QTextCodec::codecForName("KOI8-R"); // get the codec for KOI8-R +.br + QString unicodeString = codec->toUnicode( locallyEncoded ); +.br +.fi +.PP +After this, \fCunicodeString\fR holds the text converted to Unicode. Converting a string from Unicode to the local encoding is just as easy: +.PP +.nf +.br + QString unicodeString = "..."; // any Unicode text +.br + QTextCodec *codec = QTextCodec::codecForName("KOI8-R"); // get the codec for KOI8-R +.br + QCString locallyEncoded = codec->fromUnicode( unicodeString ); +.br +.fi +.PP +Some care must be taken when trying to convert the data in chunks, for example, when receiving it over a network. In such cases it is possible that a multi-byte character will be split over two chunks. At best this might result in the loss of a character and at worst cause the entire conversion to fail. +.PP +The approach to use in these situations is to create a QTextDecoder object for the codec and use this QTextDecoder for the whole decoding process, as shown below: +.PP +.nf +.br + QTextCodec *codec = QTextCodec::codecForName( "Shift-JIS" ); +.br + QTextDecoder *decoder = codec->makeDecoder(); +.br +.br + QString unicodeString; +.br + while( receiving_data ) { +.br + QByteArray chunk = new_data; +.br + unicodeString += decoder->toUnicode( chunk.data(), chunk.length() ); +.br + } +.br +.fi +.PP +The QTextDecoder object maintains state between chunks and therefore works correctly even if a multi-byte character is split between chunks. +.SH "Creating your own Codec class" +Support for new text encodings can be added to Qt by creating QTextCodec subclasses. +.PP +Built-in codecs can be overridden by custom codecs since more recently created QTextCodec objects take precedence over earlier ones. +.PP +You may find it more convenient to make your codec class available as a plugin; see the plugin documentation for more details. +.PP +The abstract virtual functions describe the encoder to the system and the coder is used as required in the different text file formats supported by QTextStream, and under X11, for the locale-specific character input and output. +.PP +To add support for another 8-bit encoding to Qt, make a subclass of QTextCodec and implement at least the following methods: +.PP +.nf +.br + const char* name() const +.br +.fi +Return the official name for the encoding. +.PP +.nf +.br + int mibEnum() const +.br +.fi +Return the MIB enum for the encoding if it is listed in the IANA character-sets encoding file. +.PP +If the encoding is multi-byte then it will have "state"; that is, the interpretation of some bytes will be dependent on some preceding bytes. For such encodings, you must implement: +.PP +.nf +.br + QTextDecoder* makeDecoder() const +.br +.fi +Return a QTextDecoder that remembers incomplete multi-byte sequence prefixes or other required state. +.PP +If the encoding does \fInot\fR require state, you should implement: +.PP +.nf +.br + QString toUnicode(const char* chars, int len) const +.br +.fi +Converts \fIlen\fR characters from \fIchars\fR to Unicode. +.PP +The base QTextCodec class has default implementations of the above two functions, \fIbut they are mutually recursive\fR, so you must re-implement at least one of them, or both for improved efficiency. +.PP +For conversion from Unicode to 8-bit encodings, it is rarely necessary to maintain state. However, two functions similar to the two above are used for encoding: +.PP +.nf +.br + QTextEncoder* makeEncoder() const +.br +.fi +Return a QTextEncoder. +.PP +.nf +.br + QCString fromUnicode(const QString& uc, int& lenInOut ) const +.br +.fi +Converts \fIlenInOut\fR characters (of type QChar) from the start of the string \fIuc\fR, returning a QCString result, and also returning the length of the result in \fIlenInOut\fR. +.PP +Again, these are mutually recursive so only one needs to be implemented, or both if greater efficiency is possible. +.PP +Finally, you must implement: +.PP +.nf +.br + int heuristicContentMatch(const char* chars, int len) const +.br +.fi +Gives a value indicating how likely it is that \fIlen\fR characters from \fIchars\fR are in the encoding. +.PP +A good model for this function is the QWindowsLocalCodec::heuristicContentMatch function found in the Qt sources. +.PP +A QTextCodec subclass might have improved performance if you also re-implement: +.PP +.nf +.br + bool canEncode( QChar ) const +.br +.fi +Test if a Unicode character can be encoded. +.PP +.nf +.br + bool canEncode( const QString& ) const +.br +.fi +Test if a string of Unicode characters can be encoded. +.PP +.nf +.br + int heuristicNameMatch(const char* hint) const +.br +.fi +Test if a possibly non-standard name is referring to the codec. +.PP +Codecs can also be created as plugins. +.PP +See also Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextCodec::QTextCodec ()\fC [protected]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Constructs a QTextCodec, and gives it the highest precedence. The QTextCodec should always be constructed on the heap (i.e. with \fCnew\fR). Qt takes ownership and will delete it when the application terminates. +.SH "QTextCodec::~QTextCodec ()\fC [virtual]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Destroys the QTextCodec. Note that you should not delete codecs yourself: once created they become Qt's responsibility. +.SH "bool QTextCodec::canEncode ( QChar ch ) const\fC [virtual]\fR" +Returns TRUE if the Unicode character \fIch\fR can be fully encoded with this codec; otherwise returns FALSE. The default implementation tests if the result of toUnicode(fromUnicode(ch)) is the original \fIch\fR. Subclasses may be able to improve the efficiency. +.SH "bool QTextCodec::canEncode ( const QString & s ) const\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIs\fR contains the string being tested for encode-ability. +.SH "QTextCodec * QTextCodec::codecForCStrings ()\fC [static]\fR" +Returns the codec used by QString to convert to and from const char* and QCStrings. If this function returns 0 (the default), QString assumes Latin-1. +.PP +See also setCodecForCStrings(). +.SH "QTextCodec * QTextCodec::codecForContent ( const char * chars, int len )\fC [static]\fR" +Searches all installed QTextCodec objects, returning the one which most recognizes the given content. May return 0. +.PP +Note that this is often a poor choice, since character encodings often use most of the available character sequences, and so only by linguistic analysis could a true match be made. +.PP +\fIchars\fR contains the string to check, and \fIlen\fR contains the number of characters in the string to use. +.PP +See also heuristicContentMatch(). +.PP +Example: qwerty/qwerty.cpp. +.SH "QTextCodec * QTextCodec::codecForIndex ( int i )\fC [static]\fR" +Returns the QTextCodec \fIi\fR positions from the most recently inserted codec, or 0 if there is no such QTextCodec. Thus, codecForIndex(0) returns the most recently created QTextCodec. +.PP +Example: qwerty/qwerty.cpp. +.SH "QTextCodec * QTextCodec::codecForLocale ()\fC [static]\fR" +Returns a pointer to the codec most suitable for this locale. +.PP +Example: qwerty/qwerty.cpp. +.SH "QTextCodec * QTextCodec::codecForMib ( int mib )\fC [static]\fR" +Returns the QTextCodec which matches the MIBenum \fImib\fR. +.SH "QTextCodec * QTextCodec::codecForName ( const char * name, int accuracy = 0 )\fC [static]\fR" +Searches all installed QTextCodec objects and returns the one which best matches \fIname\fR; the match is case-insensitive. Returns 0 if no codec's heuristicNameMatch() reports a match better than \fIaccuracy\fR, or if \fIname\fR is a null string. +.PP +See also heuristicNameMatch(). +.SH "QTextCodec * QTextCodec::codecForTr ()\fC [static]\fR" +Returns the codec used by QObject::tr() on its argument. If this function returns 0 (the default), tr() assumes Latin-1. +.PP +See also setCodecForTr(). +.SH "void QTextCodec::deleteAllCodecs ()\fC [static]\fR" +Deletes all the created codecs. +.PP +\fBWarning:\fR Do not call this function. +.PP +QApplication calls this function just before exiting to delete any QTextCodec objects that may be lying around. Since various other classes hold pointers to QTextCodec objects, it is not safe to call this function earlier. +.PP +If you are using the utility classes (like QString) but not using QApplication, calling this function at the very end of your application may be helpful for chasing down memory leaks by eliminating any QTextCodec objects. +.SH "QCString QTextCodec::fromUnicode ( const QString & uc, int & lenInOut ) const\fC [virtual]\fR" +QTextCodec subclasses must reimplement either this function or makeEncoder(). It converts the first \fIlenInOut\fR characters of \fIuc\fR from Unicode to the encoding of the subclass. If \fIlenInOut\fR is negative or too large, the length of \fIuc\fR is used instead. +.PP +Converts \fIlenInOut\fR characters (not bytes) from \fIuc\fR, producing a QCString. \fIlenInOut\fR will be set to the length of the result (in bytes). +.PP +The default implementation makes an encoder with makeEncoder() and converts the input with that. Note that the default makeEncoder() implementation makes an encoder that simply calls this function, hence subclasses \fImust\fR reimplement one function or the other to avoid infinite recursion. +.PP +Reimplemented in QHebrewCodec. +.SH "QCString QTextCodec::fromUnicode ( const QString & uc ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIuc\fR is the unicode source string. +.SH "int QTextCodec::heuristicContentMatch ( const char * chars, int len ) const\fC [pure virtual]\fR" +QTextCodec subclasses must reimplement this function. It examines the first \fIlen\fR bytes of \fIchars\fR and returns a value indicating how likely it is that the string is a prefix of text encoded in the encoding of the subclass. A negative return value indicates that the text is detectably not in the encoding (e.g. it contains characters undefined in the encoding). A return value of 0 indicates that the text should be decoded with this codec rather than as ASCII, but there is no particular evidence. The value should range up to \fIlen\fR. Thus, most decoders will return -1, 0, or -\fIlen\fR. +.PP +The characters are not null terminated. +.PP +See also codecForContent(). +.SH "int QTextCodec::heuristicNameMatch ( const char * hint ) const\fC [virtual]\fR" +Returns a value indicating how likely it is that this decoder is appropriate for decoding some format that has the given name. The name is compared with the \fIhint\fR. +.PP +A good match returns a positive number around the length of the string. A bad match is negative. +.PP +The default implementation calls simpleHeuristicNameMatch() with the name of the codec. +.SH "QTextCodec * QTextCodec::loadCharmap ( QIODevice * iod )\fC [static]\fR" +Reads a POSIX2 charmap definition from \fIiod\fR. The parser recognizes the following lines: +.PP +<font name="sans"> <code_set_name> \fIname\fR</br> <escape_char> \fIcharacter\fR</br> % alias \fIalias\fR</br> CHARMAP</br> <\fItoken\fR> /x\fIhexbyte\fR <U\fIunicode\fR> ...</br> <\fItoken\fR> /d\fIdecbyte\fR <U\fIunicode\fR> ...</br> <\fItoken\fR> /\fIoctbyte\fR <U\fIunicode\fR> ...</br> <\fItoken\fR> /\fIany\fR/\fIany\fR... <U\fIunicode\fR> ...</br> END CHARMAP</br> </font> +.PP +The resulting QTextCodec is returned (and also added to the global list of codecs). The name() of the result is taken from the code_set_name. +.PP +Note that a codec constructed in this way uses much more memory and is slower than a hand-written QTextCodec subclass, since tables in code are kept in memory shared by all Qt applications. +.PP +See also loadCharmapFile(). +.PP +Example: qwerty/qwerty.cpp. +.SH "QTextCodec * QTextCodec::loadCharmapFile ( QString filename )\fC [static]\fR" +A convenience function for loadCharmap() that loads the charmap definition from the file \fIfilename\fR. +.SH "const char * QTextCodec::locale ()\fC [static]\fR" +Returns a string representing the current language and sublanguage, e.g. "pt" for Portuguese, or "pt_br" for Portuguese/Brazil. +.PP +Example: i18n/main.cpp. +.SH "QTextDecoder * QTextCodec::makeDecoder () const\fC [virtual]\fR" +Creates a QTextDecoder which stores enough state to decode chunks of char* data to create chunks of Unicode data. The default implementation creates a stateless decoder, which is only sufficient for the simplest encodings where each byte corresponds to exactly one Unicode character. +.PP +The caller is responsible for deleting the returned object. +.SH "QTextEncoder * QTextCodec::makeEncoder () const\fC [virtual]\fR" +Creates a QTextEncoder which stores enough state to encode chunks of Unicode data as char* data. The default implementation creates a stateless encoder, which is only sufficient for the simplest encodings where each Unicode character corresponds to exactly one character. +.PP +The caller is responsible for deleting the returned object. +.SH "int QTextCodec::mibEnum () const\fC [pure virtual]\fR" +Subclasses of QTextCodec must reimplement this function. It returns the MIBenum (see the IANA character-sets encoding file for more information). It is important that each QTextCodec subclass returns the correct unique value for this function. +.PP +Reimplemented in QEucJpCodec. +.SH "const char * QTextCodec::mimeName () const\fC [virtual]\fR" +Returns the preferred mime name of the encoding as defined in the IANA character-sets encoding file. +.PP +Reimplemented in QEucJpCodec, QEucKrCodec, QJisCodec, QHebrewCodec, and QSjisCodec. +.SH "const char * QTextCodec::name () const\fC [pure virtual]\fR" +QTextCodec subclasses must reimplement this function. It returns the name of the encoding supported by the subclass. When choosing a name for an encoding, consider these points: +.TP +On X11, heuristicNameMatch( const char * hint ) is used to test if a the QTextCodec can convert between Unicode and the encoding of a font with encoding \fIhint\fR, such as "iso8859-1" for Latin-1 fonts," koi8-r" for Russian KOI8 fonts. The default algorithm of heuristicNameMatch() uses name(). +.TP +Some applications may use this function to present encodings to the end user. +.PP +Example: qwerty/qwerty.cpp. +.SH "void QTextCodec::setCodecForCStrings ( QTextCodec * c )\fC [static]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Sets the codec used by QString to convert to and from const char* and QCStrings. If \fIc\fR is 0 (the default), QString assumes Latin-1. +.PP +\fBWarning:\fR Some codecs do not preserve the characters in the ascii range (0x00 to 0x7f). For example, the Japanese Shift-JIS encoding maps the backslash character (0x5a) to the Yen character. This leads to unexpected results when using the backslash character to escape characters in strings used in e.g. regular expressions. Use QString::fromLatin1() to preserve characters in the ascii range when needed. +.PP +See also codecForCStrings() and setCodecForTr(). +.SH "void QTextCodec::setCodecForLocale ( QTextCodec * c )\fC [static]\fR" +Set the codec to \fIc\fR; this will be returned by codecForLocale(). This might be needed for some applications that want to use their own mechanism for setting the locale. +.PP +See also codecForLocale(). +.SH "void QTextCodec::setCodecForTr ( QTextCodec * c )\fC [static]\fR" +\fBWarning:\fR This function is \fInot\fR reentrant.</p> +.PP +Sets the codec used by QObject::tr() on its argument to \fIc\fR. If \fIc\fR is 0 (the default), tr() assumes Latin-1. +.PP +If the literal quoted text in the program is not in the Latin-1 encoding, this function can be used to set the appropriate encoding. For example, software developed by Korean programmers might use eucKR for all the text in the program, in which case the main() function might look like this: +.PP +.nf +.br + int main(int argc, char** argv) +.br + { +.br + QApplication app(argc, argv); +.br + ... install any additional codecs ... +.br + QTextCodec::setCodecForTr( QTextCodec::codecForName("eucKR") ); +.br + ... +.br + } +.br +.fi +.PP +Note that this is not the way to select the encoding that the \fIuser\fR has chosen. For example, to convert an application containing literal English strings to Korean, all that is needed is for the English strings to be passed through tr() and for translation files to be loaded. For details of internationalization, see the Qt internationalization documentation. +.PP +See also codecForTr() and setCodecForCStrings(). +.SH "int QTextCodec::simpleHeuristicNameMatch ( const char * name, const char * hint )\fC [static protected]\fR" +A simple utility function for heuristicNameMatch(): it does some very minor character-skipping so that almost-exact matches score high. \fIname\fR is the text we're matching and \fIhint\fR is used for the comparison. +.SH "QString QTextCodec::toUnicode ( const char * chars, int len ) const\fC [virtual]\fR" +QTextCodec subclasses must reimplement this function or makeDecoder(). It converts the first \fIlen\fR characters of \fIchars\fR to Unicode. +.PP +The default implementation makes a decoder with makeDecoder() and converts the input with that. Note that the default makeDecoder() implementation makes a decoder that simply calls this function, hence subclasses \fImust\fR reimplement one function or the other to avoid infinite recursion. +.SH "QString QTextCodec::toUnicode ( const QByteArray & a, int len ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR contains the source characters; \fIlen\fR contains the number of characters in \fIa\fR to use. +.SH "QString QTextCodec::toUnicode ( const QByteArray & a ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR contains the source characters. +.SH "QString QTextCodec::toUnicode ( const QCString & a, int len ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR contains the source characters; \fIlen\fR contains the number of characters in \fIa\fR to use. +.SH "QString QTextCodec::toUnicode ( const QCString & a ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIa\fR contains the source characters. +.SH "QString QTextCodec::toUnicode ( const char * chars ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fIchars\fR contains the source characters. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtextcodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextcodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextcodecplugin.3qt b/doc/man/man3/tqtextcodecplugin.3qt new file mode 100644 index 000000000..4013f6f5d --- /dev/null +++ b/doc/man/man3/tqtextcodecplugin.3qt @@ -0,0 +1,96 @@ +'\" t +.TH QTextCodecPlugin 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 +QTextCodecPlugin \- Abstract base for custom QTextCodec plugins +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqtextcodecplugin.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTextCodecPlugin\fR ()" +.br +.ti -1c +.BI "\fB~QTextCodecPlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBnames\fR () const = 0" +.br +.ti -1c +.BI "virtual QTextCodec * \fBcreateForName\fR ( const QString & name ) = 0" +.br +.ti -1c +.BI "virtual QValueList<int> \fBmibEnums\fR () const = 0" +.br +.ti -1c +.BI "virtual QTextCodec * \fBcreateForMib\fR ( int mib ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QTextCodecPlugin class provides an abstract base for custom QTextCodec plugins. +.PP +The text codec plugin is a simple plugin interface that makes it easy to create custom text codecs that can be loaded dynamically into applications. +.PP +Writing a text codec plugin is achieved by subclassing this base class, reimplementing the pure virtual functions names(), createForName(), mibEnums() and createForMib(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the Qt Plugins documentation for details. +.PP +See the IANA character-sets encoding file for more information on mime names and mib enums. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextCodecPlugin::QTextCodecPlugin ()" +Constructs a text codec plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. +.SH "QTextCodecPlugin::~QTextCodecPlugin ()" +Destroys the text codec plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "QTextCodec * QTextCodecPlugin::createForMib ( int mib )\fC [pure virtual]\fR" +Creates a QTextCodec object for the mib enum \fImib\fR. +.PP +(See the IANA character-sets encoding file for more information) +.PP +See also mibEnums(). +.SH "QTextCodec * QTextCodecPlugin::createForName ( const QString & name )\fC [pure virtual]\fR" +Creates a QTextCodec object for the codec called \fIname\fR. +.PP +See also names(). +.SH "QValueList<int> QTextCodecPlugin::mibEnums () const\fC [pure virtual]\fR" +Returns the list of mib enums supported by this plugin. +.PP +See also createForMib(). +.SH "QStringList QTextCodecPlugin::names () const\fC [pure virtual]\fR" +Returns the list of mime names supported by this plugin. +.PP +See also createForName(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtextcodecplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextcodecplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextdecoder.3qt b/doc/man/man3/tqtextdecoder.3qt new file mode 100644 index 000000000..4a780e4b4 --- /dev/null +++ b/doc/man/man3/tqtextdecoder.3qt @@ -0,0 +1,64 @@ +'\" t +.TH QTextDecoder 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 +QTextDecoder \- State-based decoder +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqtextcodec.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QTextDecoder\fR ()" +.br +.ti -1c +.BI "virtual QString \fBtoUnicode\fR ( const char * chars, int len ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QTextDecoder class provides a state-based decoder. +.PP +The decoder converts a text format into Unicode, remembering any state that is required between calls. +.PP +See also QTextCodec::makeEncoder() and Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextDecoder::~QTextDecoder ()\fC [virtual]\fR" +Destroys the decoder. +.SH "QString QTextDecoder::toUnicode ( const char * chars, int len )\fC [pure virtual]\fR" +Converts the first \fIlen\fR bytes in \fIchars\fR to Unicode, returning the result. +.PP +If not all characters are used (e.g. if only part of a multi-byte +encoding is at the end of the characters), the decoder remembers +enough state to continue with the next call to this function. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtextdecoder.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextdecoder.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextdrag.3qt b/doc/man/man3/tqtextdrag.3qt new file mode 100644 index 000000000..a0a2478e3 --- /dev/null +++ b/doc/man/man3/tqtextdrag.3qt @@ -0,0 +1,110 @@ +'\" t +.TH QTextDrag 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 +QTextDrag \- Drag and drop object for transferring plain and Unicode text +.SH SYNOPSIS +\fC#include <ntqdragobject.h>\fR +.PP +Inherits QDragObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTextDrag\fR ( const QString & text, QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQTextDrag\fR ( QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QTextDrag\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & text )" +.br +.ti -1c +.BI "virtual void \fBsetSubtype\fR ( const QCString & st )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBcanDecode\fR ( const QMimeSource * e )" +.br +.ti -1c +.BI "bool \fBdecode\fR ( const QMimeSource * e, QString & str )" +.br +.ti -1c +.BI "bool \fBdecode\fR ( const QMimeSource * e, QString & str, QCString & subtype )" +.br +.in -1c +.SH DESCRIPTION +The QTextDrag class is a drag and drop object for transferring plain and Unicode text. +.PP +Plain text is passed in a QString which may contain multiple lines (i.e. may contain newline characters). The drag target will receive the newlines according to the runtime environment, e.g. LF on Unix, and CRLF on Windows. +.PP +Qt provides no built-in mechanism for delivering only a single-line. +.PP +For more information about drag and drop, see the QDragObject class and the drag and drop documentation. +.PP +See also Drag And Drop Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextDrag::QTextDrag ( const QString & text, QWidget * dragSource = 0, const char * name = 0 )" +Constructs a text drag object and sets its data to \fItext\fR. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. +.SH "QTextDrag::QTextDrag ( QWidget * dragSource = 0, const char * name = 0 )" +Constructs a default text drag object. \fIdragSource\fR must be the drag source; \fIname\fR is the object name. +.SH "QTextDrag::~QTextDrag ()" +Destroys the text drag object and frees up all allocated resources. +.SH "bool QTextDrag::canDecode ( const QMimeSource * e )\fC [static]\fR" +Returns TRUE if the information in \fIe\fR can be decoded into a QString; otherwise returns FALSE. +.PP +See also decode(). +.PP +Example: iconview/simple_dd/main.cpp. +.SH "bool QTextDrag::decode ( const QMimeSource * e, QString & str )\fC [static]\fR" +Attempts to decode the dropped information in \fIe\fR into \fIstr\fR. Returns TRUE if successful; otherwise returns FALSE. +.PP +See also canDecode(). +.PP +Example: iconview/simple_dd/main.cpp. +.SH "bool QTextDrag::decode ( const QMimeSource * e, QString & str, QCString & subtype )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Attempts to decode the dropped information in \fIe\fR into \fIstr\fR. Returns TRUE if successful; otherwise returns FALSE. If \fIsubtype\fR is null, any text subtype is accepted; otherwise only the specified \fIsubtype\fR is accepted. +.PP +See also canDecode(). +.SH "void QTextDrag::setSubtype ( const QCString & st )\fC [virtual]\fR" +Sets the MIME subtype of the text being dragged to \fIst\fR. The default subtype is "plain", so the default MIME type of the text is "text/plain". You might use this to declare that the text is" text/html" by calling setSubtype("html"). +.SH "void QTextDrag::setText ( const QString & text )\fC [virtual]\fR" +Sets the text to be dragged to \fItext\fR. You will need to call this +if you did not pass the text during construction. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtextdrag.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextdrag.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextedit.3qt b/doc/man/man3/tqtextedit.3qt new file mode 100644 index 000000000..dbb03023b --- /dev/null +++ b/doc/man/man3/tqtextedit.3qt @@ -0,0 +1,1452 @@ +'\" t +.TH QTextEdit 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 +QTextEdit \- Powerful single-page rich text editor +.SH SYNOPSIS +\fC#include <ntqtextedit.h>\fR +.PP +Inherits QScrollView. +.PP +Inherited by QMultiLineEdit, QTextBrowser, and QTextView. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBWordWrap\fR { NoWrap, WidgetWidth, FixedPixelWidth, FixedColumnWidth }" +.br +.ti -1c +.BI "enum \fBWrapPolicy\fR { AtWordBoundary, AtWhiteSpace = AtWordBoundary, Anywhere, AtWordOrDocumentBoundary }" +.br +.ti -1c +.BI "enum \fBAutoFormatting\fR { AutoNone = 0, AutoBulletList = 0x00000001, AutoAll = 0xffffffff }" +.br +.ti -1c +.BI "enum \fBKeyboardAction\fR { ActionBackspace, ActionDelete, ActionReturn, ActionKill, ActionWordBackspace, ActionWordDelete }" +.br +.ti -1c +.BI "enum \fBCursorAction\fR { MoveBackward, MoveForward, MoveWordBackward, MoveWordForward, MoveUp, MoveDown, MoveLineStart, MoveLineEnd, MoveHome, MoveEnd, MovePgUp, MovePgDown }" +.br +.ti -1c +.BI "enum \fBVerticalAlignment\fR { AlignNormal, AlignSuperScript, AlignSubScript }" +.br +.ti -1c +.BI "\fBQTextEdit\fR ( const QString & text, const QString & context = QString::null, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQTextEdit\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "QString \fBtext\fR () const" +.br +.ti -1c +.BI "QString \fBtext\fR ( int para ) const" +.br +.ti -1c +.BI "TextFormat \fBtextFormat\fR () const" +.br +.ti -1c +.BI "QString \fBcontext\fR () const" +.br +.ti -1c +.BI "QString \fBdocumentTitle\fR () const" +.br +.ti -1c +.BI "void \fBgetSelection\fR ( int * paraFrom, int * indexFrom, int * paraTo, int * indexTo, int selNum = 0 ) const" +.br +.ti -1c +.BI "virtual bool \fBfind\fR ( const QString & expr, bool cs, bool wo, bool forward = TRUE, int * para = 0, int * index = 0 )" +.br +.ti -1c +.BI "int \fBparagraphs\fR () const" +.br +.ti -1c +.BI "int \fBlines\fR () const" +.br +.ti -1c +.BI "int \fBlinesOfParagraph\fR ( int para ) const" +.br +.ti -1c +.BI "int \fBlineOfChar\fR ( int para, int index )" +.br +.ti -1c +.BI "int \fBlength\fR () const" +.br +.ti -1c +.BI "QRect \fBparagraphRect\fR ( int para ) const" +.br +.ti -1c +.BI "int \fBparagraphAt\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "int \fBcharAt\fR ( const QPoint & pos, int * para ) const" +.br +.ti -1c +.BI "int \fBparagraphLength\fR ( int para ) const" +.br +.ti -1c +.BI "QStyleSheet * \fBstyleSheet\fR () const" +.br +.ti -1c +.BI "QMimeSourceFactory * \fBmimeSourceFactory\fR () const" +.br +.ti -1c +.BI "QBrush \fBpaper\fR () const" +.br +.ti -1c +.BI "bool \fBlinkUnderline\fR () const" +.br +.ti -1c +.BI "virtual int \fBheightForWidth\fR ( int w ) const" +.br +.ti -1c +.BI "bool \fBhasSelectedText\fR () const" +.br +.ti -1c +.BI "QString \fBselectedText\fR () const" +.br +.ti -1c +.BI "bool \fBisUndoAvailable\fR () const" +.br +.ti -1c +.BI "bool \fBisRedoAvailable\fR () const" +.br +.ti -1c +.BI "WordWrap \fBwordWrap\fR () const" +.br +.ti -1c +.BI "int \fBwrapColumnOrWidth\fR () const" +.br +.ti -1c +.BI "WrapPolicy \fBwrapPolicy\fR () const" +.br +.ti -1c +.BI "int \fBtabStopWidth\fR () const" +.br +.ti -1c +.BI "QString \fBanchorAt\fR ( const QPoint & pos )" +.br +.ti -1c +.BI "QString \fBanchorAt\fR ( const QPoint & pos, AnchorAttribute attr )" +.br +.ti -1c +.BI "bool \fBisReadOnly\fR () const" +.br +.ti -1c +.BI "void \fBgetCursorPosition\fR ( int * para, int * index ) const" +.br +.ti -1c +.BI "bool \fBisModified\fR () const" +.br +.ti -1c +.BI "bool \fBitalic\fR () const" +.br +.ti -1c +.BI "bool \fBbold\fR () const" +.br +.ti -1c +.BI "bool \fBunderline\fR () const" +.br +.ti -1c +.BI "QString \fBfamily\fR () const" +.br +.ti -1c +.BI "int \fBpointSize\fR () const" +.br +.ti -1c +.BI "QColor \fBcolor\fR () const" +.br +.ti -1c +.BI "QFont font () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QFont \fBcurrentFont\fR () const" +.br +.ti -1c +.BI "int \fBalignment\fR () const" +.br +.ti -1c +.BI "int \fBundoDepth\fR () const" +.br +.ti -1c +.BI "bool \fBisOverwriteMode\fR () const" +.br +.ti -1c +.BI "QColor \fBparagraphBackgroundColor\fR ( int para ) const" +.br +.ti -1c +.BI "bool \fBisUndoRedoEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBtabChangesFocus\fR () const" +.br +.ti -1c +.BI "void \fBsetAutoFormatting\fR ( uint features )" +.br +.ti -1c +.BI "uint \fBautoFormatting\fR () const" +.br +.ti -1c +.BI "QSyntaxHighlighter * \fBsyntaxHighlighter\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetMimeSourceFactory\fR ( QMimeSourceFactory * factory )" +.br +.ti -1c +.BI "virtual void \fBsetStyleSheet\fR ( QStyleSheet * styleSheet )" +.br +.ti -1c +.BI "virtual void \fBscrollToAnchor\fR ( const QString & name )" +.br +.ti -1c +.BI "virtual void \fBsetPaper\fR ( const QBrush & pap )" +.br +.ti -1c +.BI "virtual void \fBsetLinkUnderline\fR ( bool )" +.br +.ti -1c +.BI "virtual void \fBsetWordWrap\fR ( WordWrap mode )" +.br +.ti -1c +.BI "virtual void \fBsetWrapColumnOrWidth\fR ( int )" +.br +.ti -1c +.BI "virtual void \fBsetWrapPolicy\fR ( WrapPolicy policy )" +.br +.ti -1c +.BI "virtual void \fBcopy\fR ()" +.br +.ti -1c +.BI "virtual void \fBappend\fR ( const QString & text )" +.br +.ti -1c +.BI "void \fBsetText\fR ( const QString & txt )" +.br +.ti -1c +.BI "virtual void \fBsetText\fR ( const QString & text, const QString & context )" +.br +.ti -1c +.BI "virtual void \fBsetTextFormat\fR ( TextFormat f )" +.br +.ti -1c +.BI "virtual void \fBselectAll\fR ( bool select = TRUE )" +.br +.ti -1c +.BI "virtual void \fBsetTabStopWidth\fR ( int ts )" +.br +.ti -1c +.BI "virtual void \fBzoomIn\fR ( int range )" +.br +.ti -1c +.BI "virtual void \fBzoomIn\fR ()" +.br +.ti -1c +.BI "virtual void \fBzoomOut\fR ( int range )" +.br +.ti -1c +.BI "virtual void \fBzoomOut\fR ()" +.br +.ti -1c +.BI "virtual void \fBzoomTo\fR ( int size )" +.br +.ti -1c +.BI "virtual void \fBsync\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetReadOnly\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBundo\fR ()" +.br +.ti -1c +.BI "virtual void \fBredo\fR ()" +.br +.ti -1c +.BI "virtual void \fBcut\fR ()" +.br +.ti -1c +.BI "virtual void \fBpaste\fR ()" +.br +.ti -1c +.BI "virtual void \fBpasteSubType\fR ( const QCString & subtype )" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.ti -1c +.BI "virtual void \fBdel\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetItalic\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetBold\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetUnderline\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetFamily\fR ( const QString & fontFamily )" +.br +.ti -1c +.BI "virtual void \fBsetPointSize\fR ( int s )" +.br +.ti -1c +.BI "virtual void \fBsetColor\fR ( const QColor & c )" +.br +.ti -1c +.BI "virtual void \fBsetVerticalAlignment\fR ( VerticalAlignment a )" +.br +.ti -1c +.BI "virtual void \fBsetAlignment\fR ( int a )" +.br +.ti -1c +.BI "virtual void \fBsetCursorPosition\fR ( int para, int index )" +.br +.ti -1c +.BI "virtual void \fBsetSelection\fR ( int paraFrom, int indexFrom, int paraTo, int indexTo, int selNum = 0 )" +.br +.ti -1c +.BI "virtual void \fBsetSelectionAttributes\fR ( int selNum, const QColor & back, bool invertText )" +.br +.ti -1c +.BI "virtual void \fBsetModified\fR ( bool m )" +.br +.ti -1c +.BI "virtual void \fBsetUndoDepth\fR ( int d )" +.br +.ti -1c +.BI "virtual void \fBensureCursorVisible\fR ()" +.br +.ti -1c +.BI "virtual void \fBplaceCursor\fR ( const QPoint & pos, QTextCursor * c = 0 )" +.br +.ti -1c +.BI "virtual void \fBmoveCursor\fR ( CursorAction action, bool select )" +.br +.ti -1c +.BI "virtual void \fBdoKeyboardAction\fR ( KeyboardAction action )" +.br +.ti -1c +.BI "virtual void \fBremoveSelectedText\fR ( int selNum = 0 )" +.br +.ti -1c +.BI "virtual void \fBremoveSelection\fR ( int selNum = 0 )" +.br +.ti -1c +.BI "virtual void \fBsetCurrentFont\fR ( const QFont & f )" +.br +.ti -1c +.BI "virtual void \fBsetOverwriteMode\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBscrollToBottom\fR ()" +.br +.ti -1c +.BI "void \fBinsert\fR ( const QString & text, uint insertionFlags = CheckNewLines | RemoveSelected )" +.br +.ti -1c +.BI "virtual void insert ( const QString & text, bool indent, bool checkNewLine = TRUE, bool removeSelected = TRUE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void \fBinsertAt\fR ( const QString & text, int para, int index )" +.br +.ti -1c +.BI "virtual void \fBremoveParagraph\fR ( int para )" +.br +.ti -1c +.BI "virtual void \fBinsertParagraph\fR ( const QString & text, int para )" +.br +.ti -1c +.BI "virtual void \fBsetParagraphBackgroundColor\fR ( int para, const QColor & bg )" +.br +.ti -1c +.BI "virtual void \fBclearParagraphBackground\fR ( int para )" +.br +.ti -1c +.BI "virtual void \fBsetUndoRedoEnabled\fR ( bool b )" +.br +.ti -1c +.BI "void \fBsetTabChangesFocus\fR ( bool b )" +.br +.ti -1c +.BI "void \fBsetMaxLogLines\fR ( int limit )" +.br +.ti -1c +.BI "int \fBmaxLogLines\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBtextChanged\fR ()" +.br +.ti -1c +.BI "void \fBselectionChanged\fR ()" +.br +.ti -1c +.BI "void \fBcopyAvailable\fR ( bool yes )" +.br +.ti -1c +.BI "void \fBundoAvailable\fR ( bool yes )" +.br +.ti -1c +.BI "void \fBredoAvailable\fR ( bool yes )" +.br +.ti -1c +.BI "void \fBcurrentFontChanged\fR ( const QFont & f )" +.br +.ti -1c +.BI "void \fBcurrentColorChanged\fR ( const QColor & c )" +.br +.ti -1c +.BI "void \fBcurrentAlignmentChanged\fR ( int a )" +.br +.ti -1c +.BI "void \fBcurrentVerticalAlignmentChanged\fR ( VerticalAlignment a )" +.br +.ti -1c +.BI "void \fBcursorPositionChanged\fR ( int para, int pos )" +.br +.ti -1c +.BI "void \fBreturnPressed\fR ()" +.br +.ti -1c +.BI "void \fBmodificationChanged\fR ( bool m )" +.br +.ti -1c +.BI "void \fBclicked\fR ( int para, int pos )" +.br +.ti -1c +.BI "void \fBdoubleClicked\fR ( int para, int pos )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "AutoFormatting \fBautoFormatting\fR - the enabled set of auto formatting features" +.br +.ti -1c +.BI "QString \fBdocumentTitle\fR - the title of the document parsed from the text \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBhasSelectedText\fR - whether some text is selected in selection 0 \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBlength\fR - the number of characters in the text \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBlinkUnderline\fR - whether hypertext links will be underlined" +.br +.ti -1c +.BI "bool \fBmodified\fR - whether the document has been modified by the user" +.br +.ti -1c +.BI "bool \fBoverwriteMode\fR - the text edit's overwrite mode" +.br +.ti -1c +.BI "QBrush \fBpaper\fR - the background (paper) brush" +.br +.ti -1c +.BI "bool \fBreadOnly\fR - whether the text edit is read-only" +.br +.ti -1c +.BI "QString \fBselectedText\fR - the selected text (from selection " "0" ") or an empty string if there is no currently selected text (in selection " "0" ") \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBtabChangesFocus\fR - whether TAB changes focus or is accepted as input" +.br +.ti -1c +.BI "int \fBtabStopWidth\fR - the tab stop width in pixels" +.br +.ti -1c +.BI "QString \fBtext\fR - the text edit's text" +.br +.ti -1c +.BI "TextFormat \fBtextFormat\fR - the text format: rich " "text" ", plain " "text" ", log text or auto text" +.br +.ti -1c +.BI "int \fBundoDepth\fR - the depth of the undo history" +.br +.ti -1c +.BI "bool \fBundoRedoEnabled\fR - whether undo/redo is enabled" +.br +.ti -1c +.BI "WordWrap \fBwordWrap\fR - the word wrap mode" +.br +.ti -1c +.BI "int \fBwrapColumnOrWidth\fR - the position (in pixels or columns depending on the wrap " "mode" ") where text will be wrapped" +.br +.ti -1c +.BI "WrapPolicy \fBwrapPolicy\fR - the word wrap " "policy" ", at whitespace or anywhere" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBrepaintChanged\fR ()" +.br +.ti -1c +.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" +.br +.ti -1c +.BI "virtual bool \fBfocusNextPrevChild\fR ( bool n )" +.br +.ti -1c +.BI "QTextCursor * \fBtextCursor\fR () const" +.br +.ti -1c +.BI "virtual QPopupMenu * \fBcreatePopupMenu\fR ( const QPoint & pos )" +.br +.ti -1c +.BI "virtual QPopupMenu * createPopupMenu () \fI(obsolete)\fR" +.br +.in -1c +.SH DESCRIPTION +The QTextEdit widget provides a powerful single-page rich text editor. +.PP + +.TP +Introduction and Concepts +.TP +Using QTextEdit as a Display Widget +.TP +Read-only key bindings +.TP +Using QTextEdit in LogText Mode +.TP +Using QTextEdit as an Editor +.TP + Editing key bindings + +.SH "Introduction and Concepts" +QTextEdit is an advanced WYSIWYG viewer/editor supporting rich text formatting using HTML-style tags. It is optimized to handle large documents and to respond quickly to user input. +.PP +QTextEdit has four modes of operation: <center>.nf +.TS +l - l. Mode Command Notes Plain Text Editor setTextFormat(PlainText) Set text with setText(); text() returns plain text. Text attributes (e.g. colors) can be set, but plain text is always returned. Rich Text Editor setTextFormat(RichText) Set text with setText(); text() returns rich text. Rich text editing is fairly limited. You can't set margins or insert images for example (although you can read and correctly display files that have margins set and that include images). This mode is mostly useful for editing small amounts of rich text. Text Viewer setReadOnly(TRUE) Set text with setText() or append() (which has no undo history so is faster and uses less memory); text() returns plain or rich text depending on the textFormat(). This mode can correctly display a large subset of HTML tags. Log Viewer setTextFormat(LogText) +.TE +.fi +</center> +.PP +<sup>1.</sup><small>A more complete API that supports setting margins, images, etc., is planned for a later Qt release.</small> +.PP +QTextEdit can be used as a syntax highlighting editor when used in conjunction with QSyntaxHighlighter. +.PP +We recommend that you always call setTextFormat() to set the mode you want to use. If you use AutoText then setText() and append() will try to determine whether the text they are given is plain text or rich text. If you use RichText then setText() and append() will assume that the text they are given is rich text. insert() simply inserts the text it is given. +.PP +QTextEdit works on paragraphs and characters. A paragraph is a formatted string which is word-wrapped to fit into the width of the widget. By default when reading plain text, one newline signify a paragraph. A document consists of zero or more paragraphs, indexed from 0. Characters are indexed on a per-paragraph basis, also indexed from 0. The words in the paragraph are aligned in accordance with the paragraph's alignment(). Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color. +.PP +The text edit documentation uses the following concepts: +.TP +\fIcurrent format\fR -- this is the format at the current cursor position, \fIand\fR it is the format of the selected text if any. +.TP +\fIcurrent paragraph\fR -- the paragraph which contains the cursor. +.PP +QTextEdit can display images (using QMimeSourceFactory), lists and tables. If the text is too large to view within the text edit's viewport, scrollbars will appear. The text edit can load both plain text and HTML files (a subset of HTML 3.2 and 4). The rendering style and the set of valid tags are defined by a styleSheet(). Custom tags can be created and placed in a custom style sheet. Change the style sheet with setStyleSheet(); see QStyleSheet for details. The images identified by image tags are displayed if they can be interpreted using the text edit's QMimeSourceFactory; see setMimeSourceFactory(). +.PP +If you want a text browser with more navigation use QTextBrowser. If you just need to display a small piece of rich text use QLabel or QSimpleRichText. +.PP +If you create a new QTextEdit, and want to allow the user to edit rich text, call setTextFormat(Qt::RichText) to ensure that the text is treated as rich text. (Rich text uses HTML tags to set text formatting attributes. See QStyleSheet for information on the HTML tags that are supported.). If you don't call setTextFormat() explicitly the text edit will guess from the text itself whether it is rich text or plain text. This means that if the text looks like HTML or XML it will probably be interpreted as rich text, so you should call setTextFormat(Qt::PlainText) to preserve such text. +.PP +Note that we do not intend to add a full-featured web browser widget to Qt (because that would easily double Qt's size and only a few applications would benefit from it). The rich text support in Qt is designed to provide a fast, portable and efficient way to add reasonable online help facilities to applications, and to provide a basis for rich text editors. +.SH "Using QTextEdit as a Display Widget" +QTextEdit can display a large HTML subset, including tables and images. +.PP +The text is set or replaced using setText() which deletes any existing text and replaces it with the text passed in the setText() call. If you call setText() with legacy HTML (with setTextFormat(RichText) in force), and then call text(), the text that is returned may have different markup, but will render the same. Text can be inserted with insert(), paste(), pasteSubType() and append(). Text that is appended does not go into the undo history; this makes append() faster and consumes less memory. Text can also be cut(). The entire text is deleted with clear() and the selected text is deleted with removeSelectedText(). Selected (marked) text can also be deleted with del() (which will delete the character to the right of the cursor if no text is selected). +.PP +Loading and saving text is achieved using setText() and text(), for example: +.PP +.nf +.br + QFile file( fileName ); // Read the text from a file +.br + if ( file.open( IO_ReadOnly ) ) { +.br + QTextStream stream( &file ); +.br + textEdit->setText( stream.read() ); +.br + } +.br +.br + QFile file( fileName ); // Write the text to a file +.br + if ( file.open( IO_WriteOnly ) ) { +.br + QTextStream stream( &file ); +.br + stream << textEdit->text(); +.br + textEdit->setModified( FALSE ); +.br + } +.br +.fi +.PP +By default the text edit wraps words at whitespace to fit within the text edit widget. The setWordWrap() function is used to specify the kind of word wrap you want, or NoWrap if you don't want any wrapping. Call setWordWrap() to set a fixed pixel width FixedPixelWidth, or character column (e.g. 80 column) FixedColumnWidth with the pixels or columns specified with setWrapColumnOrWidth(). If you use word wrap to the widget's width WidgetWidth, you can specify whether to break on whitespace or anywhere with setWrapPolicy(). +.PP +The background color is set differently than other widgets, using setPaper(). You specify a brush style which could be a plain color or a complex pixmap. +.PP +Hypertext links are automatically underlined; this can be changed with setLinkUnderline(). The tab stop width is set with setTabStopWidth(). +.PP +The zoomIn() and zoomOut() functions can be used to resize the text by increasing (decreasing for zoomOut()) the point size used. Images are not affected by the zoom functions. +.PP +The lines() function returns the number of lines in the text and paragraphs() returns the number of paragraphs. The number of lines within a particular paragraph is returned by linesOfParagraph(). The length of the entire text in characters is returned by length(). +.PP +You can scroll to an anchor in the text, e.g. \fC<a name="anchor">\fR with scrollToAnchor(). The find() function can be used to find and select a given string within the text. +.PP +A read-only QTextEdit provides the same functionality as the (obsolete) QTextView. (QTextView is still supplied for compatibility with old code.) +.PP +<h4> Read-only key bindings </h4> +.PP +When QTextEdit is used read-only the key-bindings are limited to navigation, and text may only be selected with the mouse: <center>.nf +.TS +l - l. Keypresses Action UpArrow Move one line up DownArrow Move one line down LeftArrow Move one character left RightArrow Move one character right PageUp Move one (viewport) page up PageDown Move one (viewport) page down Home Move to the beginning of the text End Move to the end of the text Shift+Wheel Scroll the page horizontally (the Wheel is the mouse wheel) Ctrl+Wheel +.TE +.fi +</center> +.PP +The text edit may be able to provide some meta-information. For example, the documentTitle() function will return the text from within HTML \fC<title>\fR tags. +.PP +The text displayed in a text edit has a \fIcontext\fR. The context is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. It is passed to the mimeSourceFactory() when quering data. (See QTextEdit() and context().) +.PP +<h4> Using QTextEdit in LogText Mode </h4> +.PP +Setting the text format to LogText puts the widget in a special mode which is optimized for very large texts. Editing, word wrap, and rich text support are disabled in this mode (the widget is explicitly made read-only). This allows the text to be stored in a different, more memory efficient manner. However, a certain degree of text formatting is supported through the use of formatting tags. A tag is delimited by \fC<\fR and \fC>\fR. The characters \fC<\fR, \fC>\fR and \fC&\fR are escaped by using \fC<\fR, \fC>\fR and \fC&\fR. A tag pair consists of a left and a right tag (or open/close tags). Left-tags mark the starting point for formatting, while right-tags mark the ending point. A right-tag always start with a \fC/\fR before the tag keyword. For example \fC<b>\fR and \fC</b>\fR are a tag pair. Tags can be nested, but they have to be closed in the same order as they are opened. For example, \fC<b><u></u></b>\fR is valid, while \fC<b><u></b></u>\fR will output an error message. +.PP +By using tags it is possible to change the color, bold, italic and underline settings for a piece of text. A color can be specified by using the HTML font tag \fC<font color=colorname>\fR. The color name can be one of the color names from the X11 color database, or a RGB hex value (e.g \fC#00ff00\fR). Example of valid color tags: \fC<font color=red>\fR, \fC<font color="light blue">\fR, \fC<font color="#223344">\fR. Bold, italic and underline settings can be specified by the tags \fC<b>\fR, \fC<i>\fR and \fC<u>\fR. Note that a tag does not necessarily have to be closed. A valid example: +.PP +.nf +.br + This is <font color=red>red</font> while <b>this</b> is <font color=blue>blue</font>. +.br + <font color=green><font color=yellow>Yellow,</font> and <u>green</u>. +.br +.fi +.PP +Stylesheets can also be used in LogText mode. To create and use a custom tag, you could do the following: +.PP +.nf +.br + QTextEdit * log = new QTextEdit( this ); +.br + log->setTextFormat( Qt::LogText ); +.br + QStyleSheetItem * item = new QStyleSheetItem( log->styleSheet(), "mytag" ); +.br + item->setColor( "red" ); +.br + item->setFontWeight( QFont::Bold ); +.br + item->setFontUnderline( TRUE ); +.br + log->append( "This is a <mytag>custom tag</mytag>!" ); +.br +.fi +Note that only the color, bold, underline and italic attributes of a QStyleSheetItem is used in LogText mode. +.PP +Note that you can use setMaxLogLines() to limit the number of lines the widget can hold in LogText mode. +.PP +There are a few things that you need to be aware of when the widget is in this mode: +.TP +Functions that deal with rich text formatting and cursor movement will not work or return anything valid. +.TP +Lines are equivalent to paragraphs. +.SH "Using QTextEdit as an Editor" +All the information about using QTextEdit as a display widget also applies here. +.PP +The current format's attributes are set with setItalic(), setBold(), setUnderline(), setFamily() (font family), setPointSize(), setColor() and setCurrentFont(). The current paragraph's alignment is set with setAlignment(). +.PP +Use setSelection() to select text. The setSelectionAttributes() function is used to indicate how selected text should be displayed. Use hasSelectedText() to find out if any text is selected. The currently selected text's position is available using getSelection() and the selected text itself is returned by selectedText(). The selection can be copied to the clipboard with copy(), or cut to the clipboard with cut(). It can be deleted with removeSelectedText(). The entire text can be selected (or unselected) using selectAll(). QTextEdit supports multiple selections. Most of the selection functions operate on the default selection, selection 0. If the user presses a non-selecting key, e.g. a cursor key without also holding down Shift, all selections are cleared. +.PP +Set and get the position of the cursor with setCursorPosition() and getCursorPosition() respectively. When the cursor is moved, the signals currentFontChanged(), currentColorChanged() and currentAlignmentChanged() are emitted to reflect the font, color and alignment at the new cursor position. +.PP +If the text changes, the textChanged() signal is emitted, and if the user inserts a new line by pressing Return or Enter, returnPressed() is emitted. The isModified() function will return TRUE if the text has been modified. +.PP +QTextEdit provides command-based undo and redo. To set the depth of the command history use setUndoDepth() which defaults to 100 steps. To undo or redo the last operation call undo() or redo(). The signals undoAvailable() and redoAvailable() indicate whether the undo and redo operations can be executed. +.PP +The indent() function is used to reindent a paragraph. It is useful for code editors, for example in Qt Designer's code editor \fICtrl+I\fR invokes the indent() function. +.PP +<h4> Editing key bindings </h4> +.PP +The list of key-bindings which are implemented for editing: <center>.nf +.TS +l - l. Keypresses Action Backspace Delete the character to the left of the cursor Delete Delete the character to the right of the cursor Ctrl+A Move the cursor to the beginning of the line Ctrl+B Move the cursor one character left Ctrl+C Copy the marked text to the clipboard (also Ctrl+Insert under Windows) Ctrl+D Delete the character to the right of the cursor Ctrl+E Move the cursor to the end of the line Ctrl+F Move the cursor one character right Ctrl+H Delete the character to the left of the cursor Ctrl+K Delete to end of line Ctrl+N Move the cursor one line down Ctrl+P Move the cursor one line up Ctrl+V Paste the clipboard text into line edit (also Shift+Insert under Windows) Ctrl+X Cut the marked text, copy to clipboard (also Shift+Delete under Windows) Ctrl+Z Undo the last operation Ctrl+Y Redo the last operation LeftArrow Move the cursor one character left Ctrl+LeftArrow Move the cursor one word left RightArrow Move the cursor one character right Ctrl+RightArrow Move the cursor one word right UpArrow Move the cursor one line up Ctrl+UpArrow Move the cursor one word up DownArrow Move the cursor one line down Ctrl+Down Arrow Move the cursor one word down PageUp Move the cursor one page up PageDown Move the cursor one page down Home Move the cursor to the beginning of the line Ctrl+Home Move the cursor to the beginning of the text End Move the cursor to the end of the line Ctrl+End Move the cursor to the end of the text Shift+Wheel Scroll the page horizontally (the Wheel is the mouse wheel) Ctrl+Wheel +.TE +.fi +</center> +.PP +To select (mark) text hold down the Shift key whilst pressing one of the movement keystrokes, for example, \fIShift+Right Arrow\fR will select the character to the right, and \fIShift+Ctrl+Right Arrow\fR will select the word to the right, etc. +.PP +By default the text edit widget operates in insert mode so all text that the user enters is inserted into the text edit and any text to the right of the cursor is moved out of the way. The mode can be changed to overwrite, where new text overwrites any text to the right of the cursor, using setOverwriteMode(). +.PP +See also Basic Widgets and Text Related Classes. +.SS "Member Type Documentation" +.SH "QTextEdit::AutoFormatting" +.TP +\fCQTextEdit::AutoNone\fR - Do not perform any automatic formatting +.TP +\fCQTextEdit::AutoBulletList\fR - Only automatically format bulletted lists +.TP +\fCQTextEdit::AutoAll\fR - Apply all available autoformatting +.SH "QTextEdit::CursorAction" +This enum is used by moveCursor() to specify in which direction the cursor should be moved: +.TP +\fCQTextEdit::MoveBackward\fR - Moves the cursor one character backward +.TP +\fCQTextEdit::MoveWordBackward\fR - Moves the cursor one word backward +.TP +\fCQTextEdit::MoveForward\fR - Moves the cursor one character forward +.TP +\fCQTextEdit::MoveWordForward\fR - Moves the cursor one word forward +.TP +\fCQTextEdit::MoveUp\fR - Moves the cursor up one line +.TP +\fCQTextEdit::MoveDown\fR - Moves the cursor down one line +.TP +\fCQTextEdit::MoveLineStart\fR - Moves the cursor to the beginning of the line +.TP +\fCQTextEdit::MoveLineEnd\fR - Moves the cursor to the end of the line +.TP +\fCQTextEdit::MoveHome\fR - Moves the cursor to the beginning of the document +.TP +\fCQTextEdit::MoveEnd\fR - Moves the cursor to the end of the document +.TP +\fCQTextEdit::MovePgUp\fR - Moves the cursor one viewport page up +.TP +\fCQTextEdit::MovePgDown\fR - Moves the cursor one viewport page down +.SH "QTextEdit::KeyboardAction" +This enum is used by doKeyboardAction() to specify which action should be executed: +.TP +\fCQTextEdit::ActionBackspace\fR - Delete the character to the left of the cursor. +.TP +\fCQTextEdit::ActionDelete\fR - Delete the character to the right of the cursor. +.TP +\fCQTextEdit::ActionReturn\fR - Split the paragraph at the cursor position. +.TP +\fCQTextEdit::ActionKill\fR - If the cursor is not at the end of the paragraph, delete the text from the cursor position until the end of the paragraph. If the cursor is at the end of the paragraph, delete the hard line break at the end of the paragraph: this will cause this paragraph to be joined with the following paragraph. +.TP +\fCQTextEdit::ActionWordBackspace\fR - Delete the word to the left of the cursor position. +.TP +\fCQTextEdit::ActionWordDelete\fR - Delete the word to the right of the cursor position +.SH "QTextEdit::VerticalAlignment" +This enum is used to set the vertical alignment of the text. +.TP +\fCQTextEdit::AlignNormal\fR - Normal alignment +.TP +\fCQTextEdit::AlignSuperScript\fR - Superscript +.TP +\fCQTextEdit::AlignSubScript\fR - Subscript +.SH "QTextEdit::WordWrap" +This enum defines the QTextEdit's word wrap modes. +.TP +\fCQTextEdit::NoWrap\fR - Do not wrap the text. +.TP +\fCQTextEdit::WidgetWidth\fR - Wrap the text at the current width of the widget (this is the default). Wrapping is at whitespace by default; this can be changed with setWrapPolicy(). +.TP +\fCQTextEdit::FixedPixelWidth\fR - Wrap the text at a fixed number of pixels from the widget's left side. The number of pixels is set with wrapColumnOrWidth(). +.TP +\fCQTextEdit::FixedColumnWidth\fR - Wrap the text at a fixed number of character columns from the widget's left side. The number of characters is set with wrapColumnOrWidth(). This is useful if you need formatted text that can also be displayed gracefully on devices with monospaced fonts, for example a standard VT100 terminal, where you might set wrapColumnOrWidth() to 80. +.PP +See also wordWrap and wordWrap. +.SH "QTextEdit::WrapPolicy" +This enum defines where text can be wrapped in word wrap mode. +.TP +\fCQTextEdit::AtWhiteSpace\fR - Don't use this deprecated value (it is a synonym for AtWordBoundary which you should use instead). +.TP +\fCQTextEdit::Anywhere\fR - Break anywhere, including within words. +.TP +\fCQTextEdit::AtWordBoundary\fR - Break lines at word boundaries, e.g. spaces or newlines +.TP +\fCQTextEdit::AtWordOrDocumentBoundary\fR - Break lines at whitespace, e.g. spaces or newlines if possible. Break it anywhere otherwise. +.PP +See also wrapPolicy. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextEdit::QTextEdit ( const QString & text, const QString & context = QString::null, QWidget * parent = 0, const char * name = 0 )" +Constructs a QTextEdit called \fIname\fR, with parent \fIparent\fR. The text edit will display the text \fItext\fR using context \fIcontext\fR. +.PP +The \fIcontext\fR is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. It is passed to the mimeSourceFactory() when quering data. +.PP +For example if the text contains an image tag, \fC<img src="image.png">\fR, and the context is "path/to/look/in", the QMimeSourceFactory will try to load the image from" path/to/look/in/image.png". If the tag was \fC<img src="/image.png">\fR, the context will not be used (because QMimeSourceFactory recognizes that we have used an absolute path) and will try to load "/image.png". The context is applied in exactly the same way to \fIhrefs\fR, for example, \fC<a href="target.html">Target</a>\fR, would resolve to" path/to/look/in/target.html". +.SH "QTextEdit::QTextEdit ( QWidget * parent = 0, const char * name = 0 )" +Constructs an empty QTextEdit called \fIname\fR, with parent \fIparent\fR. +.SH "int QTextEdit::alignment () const" +Returns the alignment of the current paragraph. +.PP +See also setAlignment(). +.SH "QString QTextEdit::anchorAt ( const QPoint & pos, AnchorAttribute attr )" +If there is an anchor at position \fIpos\fR (in contents coordinates), the text for attribute \fIattr\fR is returned, otherwise QString::null is returned. +.SH "QString QTextEdit::anchorAt ( const QPoint & pos )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +If there is an anchor at position \fIpos\fR (in contents coordinates), its \fChref\fR is returned, otherwise QString::null is returned. +.SH "void QTextEdit::append ( const QString & text )\fC [virtual slot]\fR" +Appends a new paragraph with \fItext\fR to the end of the text edit. Note that the undo/redo history is cleared by this function, and no undo history is kept for appends which makes them faster than insert()s. If you want to append text which is added to the undo/redo history as well, use insertParagraph(). +.PP +Examples: +.)l network/clientserver/client/client.cpp, network/clientserver/server/server.cpp, network/httpd/httpd.cpp, and process/process.cpp. +.SH "uint QTextEdit::autoFormatting () const" +Returns the enabled set of auto formatting features. See the "autoFormatting" property for details. +.SH "bool QTextEdit::bold () const" +Returns TRUE if the current format is bold; otherwise returns FALSE. +.PP +See also setBold(). +.SH "int QTextEdit::charAt ( const QPoint & pos, int * para ) const" +Returns the index of the character (relative to its paragraph) at position \fIpos\fR (in contents coordinates). If \fIpara\fR is not 0, \fI*para\fR is set to the character's paragraph. +.SH "void QTextEdit::clear ()\fC [virtual slot]\fR" +Deletes all the text in the text edit. +.PP +See also cut(), removeSelectedText(), and text. +.SH "void QTextEdit::clearParagraphBackground ( int para )\fC [virtual slot]\fR" +Clears the background color of the paragraph \fIpara\fR, so that the default color is used again. +.SH "void QTextEdit::clicked ( int para, int pos )\fC [signal]\fR" +This signal is emitted when the mouse is clicked on the paragraph \fIpara\fR at character position \fIpos\fR. +.PP +See also doubleClicked(). +.SH "QColor QTextEdit::color () const" +Returns the color of the current format. +.PP +See also setColor() and paper. +.SH "QString QTextEdit::context () const" +Returns the context of the text edit. The context is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. +.PP +See also text. +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qdir/qdir.cpp. +.SH "void QTextEdit::copy ()\fC [virtual slot]\fR" +Copies any selected text (from selection 0) to the clipboard. +.PP +See also hasSelectedText and copyAvailable(). +.SH "void QTextEdit::copyAvailable ( bool yes )\fC [signal]\fR" +This signal is emitted when text is selected or de-selected in the text edit. +.PP +When text is selected this signal will be emitted with \fIyes\fR set to TRUE. If no text has been selected or if the selected text is de-selected this signal is emitted with \fIyes\fR set to FALSE. +.PP +If \fIyes\fR is TRUE then copy() can be used to copy the selection to the clipboard. If \fIyes\fR is FALSE then copy() does nothing. +.PP +See also selectionChanged(). +.SH "QPopupMenu * QTextEdit::createPopupMenu ( const QPoint & pos )\fC [virtual protected]\fR" +This function is called to create a right mouse button popup menu at the document position \fIpos\fR. If you want to create a custom popup menu, reimplement this function and return the created popup menu. Ownership of the popup menu is transferred to the caller. +.PP +\fBWarning:\fR The QPopupMenu ID values 0-7 are reserved, and they map to the standard operations. When inserting items into your custom popup menu, be sure to specify ID values larger than 7. +.SH "QPopupMenu * QTextEdit::createPopupMenu ()\fC [virtual protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function is called to create a right mouse button popup menu. If you want to create a custom popup menu, reimplement this function and return the created popup menu. Ownership of the popup menu is transferred to the caller. +.PP +This function is only called if createPopupMenu( const QPoint & ) returns 0. +.SH "void QTextEdit::currentAlignmentChanged ( int a )\fC [signal]\fR" +This signal is emitted if the alignment of the current paragraph has changed. +.PP +The new alignment is \fIa\fR. +.PP +See also setAlignment(). +.SH "void QTextEdit::currentColorChanged ( const QColor & c )\fC [signal]\fR" +This signal is emitted if the color of the current format has changed. +.PP +The new color is \fIc\fR. +.PP +See also setColor(). +.SH "QFont QTextEdit::currentFont () const" +Returns the font of the current format. +.PP +See also setCurrentFont(), setFamily(), and setPointSize(). +.SH "void QTextEdit::currentFontChanged ( const QFont & f )\fC [signal]\fR" +This signal is emitted if the font of the current format has changed. +.PP +The new font is \fIf\fR. +.PP +See also setCurrentFont(). +.SH "void QTextEdit::currentVerticalAlignmentChanged ( VerticalAlignment a )\fC [signal]\fR" +This signal is emitted if the vertical alignment of the current format has changed. +.PP +The new vertical alignment is \fIa\fR. +.PP +See also setVerticalAlignment(). +.SH "void QTextEdit::cursorPositionChanged ( int para, int pos )\fC [signal]\fR" +This signal is emitted if the position of the cursor has changed. \fIpara\fR contains the paragraph index and \fIpos\fR contains the character position within the paragraph. +.PP +See also setCursorPosition(). +.SH "void QTextEdit::cut ()\fC [virtual slot]\fR" +Copies the selected text (from selection 0) to the clipboard and deletes it from the text edit. +.PP +If there is no selected text (in selection 0) nothing happens. +.PP +See also QTextEdit::copy(), paste(), and pasteSubType(). +.SH "void QTextEdit::del ()\fC [virtual slot]\fR" +If there is some selected text (in selection 0) it is deleted. If there is no selected text (in selection 0) the character to the right of the text cursor is deleted. +.PP +See also removeSelectedText() and cut(). +.SH "void QTextEdit::doKeyboardAction ( KeyboardAction action )\fC [virtual slot]\fR" +Executes keyboard action \fIaction\fR. This is normally called by a key event handler. +.SH "QString QTextEdit::documentTitle () const" +Returns the title of the document parsed from the text. See the "documentTitle" property for details. +.SH "void QTextEdit::doubleClicked ( int para, int pos )\fC [signal]\fR" +This signal is emitted when the mouse is double-clicked on the paragraph \fIpara\fR at character position \fIpos\fR. +.PP +See also clicked(). +.SH "void QTextEdit::ensureCursorVisible ()\fC [virtual slot]\fR" +Ensures that the cursor is visible by scrolling the text edit if necessary. +.PP +See also setCursorPosition(). +.SH "QString QTextEdit::family () const" +Returns the font family of the current format. +.PP +See also setFamily(), setCurrentFont(), and setPointSize(). +.SH "bool QTextEdit::find ( const QString & expr, bool cs, bool wo, bool forward = TRUE, int * para = 0, int * index = 0 )\fC [virtual]\fR" +Finds the next occurrence of the string, \fIexpr\fR. Returns TRUE if \fIexpr\fR was found; otherwise returns FALSE. +.PP +If \fIpara\fR and \fIindex\fR are both 0 the search begins from the current cursor position. If \fIpara\fR and \fIindex\fR are both not 0, the search begins from the \fI*index\fR character position in the \fI*para\fR paragraph. +.PP +If \fIcs\fR is TRUE the search is case sensitive, otherwise it is case insensitive. If \fIwo\fR is TRUE the search looks for whole word matches only; otherwise it searches for any matching text. If \fIforward\fR is TRUE (the default) the search works forward from the starting position to the end of the text, otherwise it works backwards to the beginning of the text. +.PP +If \fIexpr\fR is found the function returns TRUE. If \fIindex\fR and \fIpara\fR are not 0, the number of the paragraph in which the first character of the match was found is put into \fI*para\fR, and the index position of that character within the paragraph is put into \fI*index\fR. +.PP +If \fIexpr\fR is not found the function returns FALSE. If \fIindex\fR and \fIpara\fR are not 0 and \fIexpr\fR is not found, \fI*index\fR and \fI*para\fR are undefined. +.PP +Please note that this function will make the next occurrence of the string (if found) the current selection, and will thus modify the cursor position. +.PP +Using the \fIpara\fR and \fIindex\fR parameters will not work correctly in case the document contains tables. +.SH "bool QTextEdit::focusNextPrevChild ( bool n )\fC [virtual protected]\fR" +Reimplemented to allow tabbing through links. If \fIn\fR is TRUE the tab moves the focus to the next child; if \fIn\fR is FALSE the tab moves the focus to the previous child. Returns TRUE if the focus was moved; otherwise returns FALSE. +.SH "QFont QTextEdit::font () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns QScrollView::font() +.PP +\fBWarning:\fR In previous versions this function returned the font of the current format. This lead to confusion. Please use currentFont() instead. +.PP +Example: qwerty/qwerty.cpp. +.SH "void QTextEdit::getCursorPosition ( int * para, int * index ) const" +This function sets the \fI*para\fR and \fI*index\fR parameters to the current cursor position. \fIpara\fR and \fIindex\fR must not be 0. +.PP +See also setCursorPosition(). +.SH "void QTextEdit::getSelection ( int * paraFrom, int * indexFrom, int * paraTo, int * indexTo, int selNum = 0 ) const" +If there is a selection, \fI*paraFrom\fR is set to the number of the paragraph in which the selection begins and \fI*paraTo\fR is set to the number of the paragraph in which the selection ends. (They could be the same.) \fI*indexFrom\fR is set to the index at which the selection begins within \fI*paraFrom\fR, and \fI*indexTo\fR is set to the index at which the selection ends within \fI*paraTo\fR. +.PP +If there is no selection, \fI*paraFrom\fR, \fI*indexFrom\fR, \fI*paraTo\fR and \fI*indexTo\fR are all set to -1. +.PP +If \fIparaFrom\fR, \fIindexFrom\fR, \fIparaTo\fR or \fIindexTo\fR is 0 this function does nothing. +.PP +The \fIselNum\fR is the number of the selection (multiple selections are supported). It defaults to 0 (the default selection). +.PP +See also setSelection() and selectedText. +.SH "bool QTextEdit::hasSelectedText () const" +Returns TRUE if some text is selected in selection 0; otherwise returns FALSE. See the "hasSelectedText" property for details. +.SH "int QTextEdit::heightForWidth ( int w ) const\fC [virtual]\fR" +Returns how many pixels high the text edit needs to be to display all the text if the text edit is \fIw\fR pixels wide. +.PP +Reimplemented from QWidget. +.SH "void QTextEdit::insert ( const QString & text, uint insertionFlags = CheckNewLines | RemoveSelected )\fC [slot]\fR" +Inserts \fItext\fR at the current cursor position. +.PP +The \fIinsertionFlags\fR define how the text is inserted. If RedoIndentation is set, the paragraph is re-indented. If CheckNewLines is set, newline characters in \fItext\fR result in hard line breaks (i.e. new paragraphs). If \fCcheckNewLine\fR is not set, the behaviour of the editor is undefined if the \fItext\fR contains newlines. (It is not possible to change QTextEdit's newline handling behavior, but you can use QString::replace() to preprocess text before inserting it.) If RemoveSelected is set, any selected text (in selection 0) is removed before the text is inserted. +.PP +The default flags are CheckNewLines | RemoveSelected. +.PP +If the widget is in LogText mode this function will do nothing. +.PP +See also paste() and pasteSubType(). +.SH "void QTextEdit::insert ( const QString & text, bool indent, bool checkNewLine = TRUE, bool removeSelected = TRUE )\fC [virtual slot]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QTextEdit::insertAt ( const QString & text, int para, int index )\fC [virtual slot]\fR" +Inserts \fItext\fR in the paragraph \fIpara\fR at position \fIindex\fR. +.SH "void QTextEdit::insertParagraph ( const QString & text, int para )\fC [virtual slot]\fR" +Inserts \fItext\fR as a new paragraph at position \fIpara\fR. If \fIpara\fR is -1, the text is appended. Use append() if the append operation is performance critical. +.SH "bool QTextEdit::isModified () const" +Returns TRUE if the document has been modified by the user; otherwise returns FALSE. See the "modified" property for details. +.SH "bool QTextEdit::isOverwriteMode () const" +Returns the text edit's overwrite mode. See the "overwriteMode" property for details. +.SH "bool QTextEdit::isReadOnly () const" +Returns TRUE if the text edit is read-only; otherwise returns FALSE. See the "readOnly" property for details. +.SH "bool QTextEdit::isRedoAvailable () const" +Returns TRUE if redo is available; otherwise returns FALSE. +.SH "bool QTextEdit::isUndoAvailable () const" +Returns TRUE if undo is available; otherwise returns FALSE. +.SH "bool QTextEdit::isUndoRedoEnabled () const" +Returns TRUE if undo/redo is enabled; otherwise returns FALSE. See the "undoRedoEnabled" property for details. +.SH "bool QTextEdit::italic () const" +Returns TRUE if the current format is italic; otherwise returns FALSE. +.PP +See also setItalic(). +.SH "void QTextEdit::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" +Processes the key event, \fIe\fR. By default key events are used to provide keyboard navigation and text editing. +.PP +Reimplemented from QWidget. +.PP +Reimplemented in QTextBrowser. +.SH "int QTextEdit::length () const" +Returns the number of characters in the text. See the "length" property for details. +.SH "int QTextEdit::lineOfChar ( int para, int index )" +Returns the line number of the line in paragraph \fIpara\fR in which the character at position \fIindex\fR appears. The \fIindex\fR position is relative to the beginning of the paragraph. If there is no such paragraph or no such character at the \fIindex\fR position (e.g. the index is out of range) -1 is returned. +.SH "int QTextEdit::lines () const" +Returns the number of lines in the text edit; this could be 0. +.PP +\fBWarning:\fR This function may be slow. Lines change all the time during word wrapping, so this function has to iterate over all the paragraphs and get the number of lines from each one individually. +.SH "int QTextEdit::linesOfParagraph ( int para ) const" +Returns the number of lines in paragraph \fIpara\fR, or -1 if there is no paragraph with index \fIpara\fR. +.SH "bool QTextEdit::linkUnderline () const" +Returns TRUE if hypertext links will be underlined; otherwise returns FALSE. See the "linkUnderline" property for details. +.SH "int QTextEdit::maxLogLines ()\fC [slot]\fR" +Returns the maximum number of lines QTextEdit can hold in LogText mode. By default the number of lines is unlimited, which is signified by a value of -1. +.SH "QMimeSourceFactory * QTextEdit::mimeSourceFactory () const" +Returns the QMimeSourceFactory which is being used by this text edit. +.PP +See also setMimeSourceFactory(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qdir/qdir.cpp. +.SH "void QTextEdit::modificationChanged ( bool m )\fC [signal]\fR" +This signal is emitted when the modification status of the document has changed. If \fIm\fR is TRUE, the document was modified, otherwise the modification state has been reset to unmodified. +.PP +See also modified. +.SH "void QTextEdit::moveCursor ( CursorAction action, bool select )\fC [virtual slot]\fR" +Moves the text cursor according to \fIaction\fR. This is normally used by some key event handler. \fIselect\fR specifies whether the text between the current cursor position and the new position should be selected. +.SH "QBrush QTextEdit::paper () const" +Returns the background (paper) brush. See the "paper" property for details. +.SH "int QTextEdit::paragraphAt ( const QPoint & pos ) const" +Returns the paragraph which is at position \fIpos\fR (in contents coordinates). +.SH "QColor QTextEdit::paragraphBackgroundColor ( int para ) const" +Returns the background color of the paragraph \fIpara\fR or an invalid color if \fIpara\fR is out of range or the paragraph has no background set +.SH "int QTextEdit::paragraphLength ( int para ) const" +Returns the length of the paragraph \fIpara\fR (i.e. the number of characters), or -1 if there is no paragraph with index \fIpara\fR. +.PP +This function ignores newlines. +.SH "QRect QTextEdit::paragraphRect ( int para ) const" +Returns the rectangle of the paragraph \fIpara\fR in contents coordinates, or an invalid rectangle if \fIpara\fR is out of range. +.SH "int QTextEdit::paragraphs () const" +Returns the number of paragraphs in the text; an empty textedit is always considered to have one paragraph, so 1 is returned in this case. +.SH "void QTextEdit::paste ()\fC [virtual slot]\fR" +Pastes the text from the clipboard into the text edit at the current cursor position. Only plain text is pasted. +.PP +If there is no text in the clipboard nothing happens. +.PP +See also pasteSubType(), cut(), and QTextEdit::copy(). +.SH "void QTextEdit::pasteSubType ( const QCString & subtype )\fC [virtual slot]\fR" +Pastes the text with format \fIsubtype\fR from the clipboard into the text edit at the current cursor position. The \fIsubtype\fR can be" plain" or "html". +.PP +If there is no text with format \fIsubtype\fR in the clipboard nothing happens. +.PP +See also paste(), cut(), and QTextEdit::copy(). +.SH "void QTextEdit::placeCursor ( const QPoint & pos, QTextCursor * c = 0 )\fC [virtual slot]\fR" +Places the cursor \fIc\fR at the character which is closest to position \fIpos\fR (in contents coordinates). If \fIc\fR is 0, the default text cursor is used. +.PP +See also setCursorPosition(). +.SH "int QTextEdit::pointSize () const" +Returns the point size of the font of the current format. +.PP +See also setFamily(), setCurrentFont(), and setPointSize(). +.SH "void QTextEdit::redo ()\fC [virtual slot]\fR" +Redoes the last operation. +.PP +If there is no operation to redo, i.e. there is no redo step in the undo/redo history, nothing happens. +.PP +See also redoAvailable(), undo(), and undoDepth. +.SH "void QTextEdit::redoAvailable ( bool yes )\fC [signal]\fR" +This signal is emitted when the availability of redo changes. If \fIyes\fR is TRUE, then redo() will work until redoAvailable( FALSE ) is next emitted. +.PP +See also redo() and undoDepth. +.SH "void QTextEdit::removeParagraph ( int para )\fC [virtual slot]\fR" +Removes the paragraph \fIpara\fR. +.SH "void QTextEdit::removeSelectedText ( int selNum = 0 )\fC [virtual slot]\fR" +Deletes the text of selection \fIselNum\fR (by default, the default selection, 0). If there is no selected text nothing happens. +.PP +See also selectedText and removeSelection(). +.SH "void QTextEdit::removeSelection ( int selNum = 0 )\fC [virtual slot]\fR" +Removes the selection \fIselNum\fR (by default 0). This does not remove the selected text. +.PP +See also removeSelectedText(). +.SH "void QTextEdit::repaintChanged ()\fC [protected]\fR" +Repaints any paragraphs that have changed. +.PP +Although used extensively internally you shouldn't need to call this yourself. +.SH "void QTextEdit::returnPressed ()\fC [signal]\fR" +This signal is emitted if the user pressed the Return or the Enter key. +.SH "void QTextEdit::scrollToAnchor ( const QString & name )\fC [virtual slot]\fR" +Scrolls the text edit to make the text at the anchor called \fIname\fR visible, if it can be found in the document. If the anchor isn't found no scrolling will occur. An anchor is defined using the HTML anchor tag, e.g. \fC<a name="target">\fR. +.SH "void QTextEdit::scrollToBottom ()\fC [virtual slot]\fR" +Scrolls to the bottom of the document and does formatting if required. +.SH "void QTextEdit::selectAll ( bool select = TRUE )\fC [virtual slot]\fR" +If \fIselect\fR is TRUE (the default), all the text is selected as selection 0. If \fIselect\fR is FALSE any selected text is unselected, i.e. the default selection (selection 0) is cleared. +.PP +See also selectedText. +.SH "QString QTextEdit::selectedText () const" +Returns the selected text (from selection 0) or an empty string if there is no currently selected text (in selection 0). See the "selectedText" property for details. +.SH "void QTextEdit::selectionChanged ()\fC [signal]\fR" +This signal is emitted whenever the selection changes. +.PP +See also setSelection() and copyAvailable(). +.SH "void QTextEdit::setAlignment ( int a )\fC [virtual slot]\fR" +Sets the alignment of the current paragraph to \fIa\fR. Valid alignments are Qt::AlignLeft, Qt::AlignRight, Qt::AlignJustify and Qt::AlignCenter (which centers horizontally). +.PP +Reimplemented in QMultiLineEdit. +.SH "void QTextEdit::setAutoFormatting ( uint features )" +Sets the enabled set of auto formatting features to \fIfeatures\fR. See the "autoFormatting" property for details. +.SH "void QTextEdit::setBold ( bool b )\fC [virtual slot]\fR" +If \fIb\fR is TRUE sets the current format to bold; otherwise sets the current format to non-bold. +.PP +See also bold(). +.SH "void QTextEdit::setColor ( const QColor & c )\fC [virtual slot]\fR" +Sets the color of the current format, i.e. of the text, to \fIc\fR. +.PP +See also color() and paper. +.SH "void QTextEdit::setCurrentFont ( const QFont & f )\fC [virtual slot]\fR" +Sets the font of the current format to \fIf\fR. +.PP +If the widget is in LogText mode this function will do nothing. Use setFont() instead. +.PP +See also currentFont(), setPointSize(), and setFamily(). +.SH "void QTextEdit::setCursorPosition ( int para, int index )\fC [virtual slot]\fR" +Sets the cursor to position \fIindex\fR in paragraph \fIpara\fR. +.PP +See also getCursorPosition(). +.SH "void QTextEdit::setFamily ( const QString & fontFamily )\fC [virtual slot]\fR" +Sets the font family of the current format to \fIfontFamily\fR. +.PP +See also family() and setCurrentFont(). +.SH "void QTextEdit::setItalic ( bool b )\fC [virtual slot]\fR" +If \fIb\fR is TRUE sets the current format to italic; otherwise sets the current format to non-italic. +.PP +See also italic(). +.SH "void QTextEdit::setLinkUnderline ( bool )\fC [virtual slot]\fR" +Sets whether hypertext links will be underlined. See the "linkUnderline" property for details. +.SH "void QTextEdit::setMaxLogLines ( int limit )\fC [slot]\fR" +Sets the maximum number of lines a QTextEdit can hold in LogText mode to \fIlimit\fR. If \fIlimit\fR is -1 (the default), this signifies an unlimited number of lines. +.PP +\fBWarning:\fR Never use formatting tags that span more than one line when the maximum log lines is set. When lines are removed from the top of the buffer it could result in an unbalanced tag pair, i.e. the left formatting tag is removed before the right one. +.SH "void QTextEdit::setMimeSourceFactory ( QMimeSourceFactory * factory )\fC [virtual slot]\fR" +Sets the text edit's mimesource factory to \fIfactory\fR. See QMimeSourceFactory for further details. +.PP +See also mimeSourceFactory(). +.SH "void QTextEdit::setModified ( bool m )\fC [virtual slot]\fR" +Sets whether the document has been modified by the user to \fIm\fR. See the "modified" property for details. +.SH "void QTextEdit::setOverwriteMode ( bool b )\fC [virtual slot]\fR" +Sets the text edit's overwrite mode to \fIb\fR. See the "overwriteMode" property for details. +.SH "void QTextEdit::setPaper ( const QBrush & pap )\fC [virtual slot]\fR" +Sets the background (paper) brush to \fIpap\fR. See the "paper" property for details. +.SH "void QTextEdit::setParagraphBackgroundColor ( int para, const QColor & bg )\fC [virtual slot]\fR" +Sets the background color of the paragraph \fIpara\fR to \fIbg\fR. +.SH "void QTextEdit::setPointSize ( int s )\fC [virtual slot]\fR" +Sets the point size of the current format to \fIs\fR. +.PP +Note that if \fIs\fR is zero or negative, the behaviour of this function is not defined. +.PP +See also pointSize(), setCurrentFont(), and setFamily(). +.SH "void QTextEdit::setReadOnly ( bool b )\fC [virtual slot]\fR" +Sets whether the text edit is read-only to \fIb\fR. See the "readOnly" property for details. +.SH "void QTextEdit::setSelection ( int paraFrom, int indexFrom, int paraTo, int indexTo, int selNum = 0 )\fC [virtual slot]\fR" +Sets a selection which starts at position \fIindexFrom\fR in paragraph \fIparaFrom\fR and ends at position \fIindexTo\fR in paragraph \fIparaTo\fR. +.PP +Any existing selections which have a different id (\fIselNum\fR) are left alone, but if an existing selection has the same id as \fIselNum\fR it is removed and replaced by this selection. +.PP +Uses the selection settings of selection \fIselNum\fR. If \fIselNum\fR is 0, this is the default selection. +.PP +The cursor is moved to the end of the selection if \fIselNum\fR is 0, otherwise the cursor position remains unchanged. +.PP +See also getSelection() and selectedText. +.SH "void QTextEdit::setSelectionAttributes ( int selNum, const QColor & back, bool invertText )\fC [virtual slot]\fR" +Sets the background color of selection number \fIselNum\fR to \fIback\fR and specifies whether the text of this selection should be inverted with \fIinvertText\fR. +.PP +This only works for \fIselNum\fR > 0. The default selection (\fIselNum\fR == 0) gets its attributes from the text edit's colorGroup(). +.SH "void QTextEdit::setStyleSheet ( QStyleSheet * styleSheet )\fC [virtual slot]\fR" +Sets the stylesheet to use with this text edit to \fIstyleSheet\fR. Changes will only take effect for new text added with setText() or append(). +.PP +See also styleSheet(). +.SH "void QTextEdit::setTabChangesFocus ( bool b )\fC [slot]\fR" +Sets whether TAB changes focus or is accepted as input to \fIb\fR. See the "tabChangesFocus" property for details. +.SH "void QTextEdit::setTabStopWidth ( int ts )\fC [virtual slot]\fR" +Sets the tab stop width in pixels to \fIts\fR. See the "tabStopWidth" property for details. +.SH "void QTextEdit::setText ( const QString & txt )\fC [slot]\fR" +Sets the text edit's text to \fItxt\fR. See the "text" property for details. +.SH "void QTextEdit::setText ( const QString & text, const QString & context )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Changes the text of the text edit to the string \fItext\fR and the context to \fIcontext\fR. Any previous text is removed. +.PP +\fItext\fR may be interpreted either as plain text or as rich text, depending on the textFormat(). The default setting is AutoText, i.e. the text edit auto-detects the format from \fItext\fR. +.PP +For rich text the rendering style and available tags are defined by a styleSheet(); see QStyleSheet for details. +.PP +The optional \fIcontext\fR is a path which the text edit's QMimeSourceFactory uses to resolve the locations of files and images. (See QTextEdit::QTextEdit().) It is passed to the text edit's QMimeSourceFactory when quering data. +.PP +Note that the undo/redo history is cleared by this function. +.PP +See also text and textFormat. +.SH "void QTextEdit::setTextFormat ( TextFormat f )\fC [virtual slot]\fR" +Sets the text format: rich text, plain text, log text or auto text to \fIf\fR. See the "textFormat" property for details. +.SH "void QTextEdit::setUnderline ( bool b )\fC [virtual slot]\fR" +If \fIb\fR is TRUE sets the current format to underline; otherwise sets the current format to non-underline. +.PP +See also underline(). +.SH "void QTextEdit::setUndoDepth ( int d )\fC [virtual slot]\fR" +Sets the depth of the undo history to \fId\fR. See the "undoDepth" property for details. +.SH "void QTextEdit::setUndoRedoEnabled ( bool b )\fC [virtual slot]\fR" +Sets whether undo/redo is enabled to \fIb\fR. See the "undoRedoEnabled" property for details. +.SH "void QTextEdit::setVerticalAlignment ( VerticalAlignment a )\fC [virtual slot]\fR" +Sets the vertical alignment of the current format, i.e. of the text, to \fIa\fR. +.PP +See also color() and paper. +.SH "void QTextEdit::setWordWrap ( WordWrap mode )\fC [virtual slot]\fR" +Sets the word wrap mode to \fImode\fR. See the "wordWrap" property for details. +.SH "void QTextEdit::setWrapColumnOrWidth ( int )\fC [virtual slot]\fR" +Sets the position (in pixels or columns depending on the wrap mode) where text will be wrapped. See the "wrapColumnOrWidth" property for details. +.SH "void QTextEdit::setWrapPolicy ( WrapPolicy policy )\fC [virtual slot]\fR" +Sets the word wrap policy, at whitespace or anywhere to \fIpolicy\fR. See the "wrapPolicy" property for details. +.SH "QStyleSheet * QTextEdit::styleSheet () const" +Returns the QStyleSheet which is being used by this text edit. +.PP +See also setStyleSheet(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +.SH "void QTextEdit::sync ()\fC [virtual slot]\fR" +QTextEdit is optimized for large amounts text. One of its optimizations is to format only the visible text, formatting the rest on demand, e.g. as the user scrolls, so you don't usually need to call this function. +.PP +In some situations you may want to force the whole text to be formatted. For example, if after calling setText(), you wanted to know the height of the document (using contentsHeight()), you would call this function first. +.SH "QSyntaxHighlighter * QTextEdit::syntaxHighlighter () const" +Returns the QSyntaxHighlighter set on this QTextEdit. 0 is returned if no syntax highlighter is set. +.SH "bool QTextEdit::tabChangesFocus () const" +Returns TRUE if TAB changes focus or is accepted as input; otherwise returns FALSE. See the "tabChangesFocus" property for details. +.SH "int QTextEdit::tabStopWidth () const" +Returns the tab stop width in pixels. See the "tabStopWidth" property for details. +.SH "QString QTextEdit::text () const" +Returns the text edit's text. See the "text" property for details. +.SH "QString QTextEdit::text ( int para ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the text of paragraph \fIpara\fR. +.PP +If textFormat() is RichText the text will contain HTML formatting tags. +.SH "void QTextEdit::textChanged ()\fC [signal]\fR" +This signal is emitted whenever the text in the text edit changes. +.PP +See also text and append(). +.PP +Examples: +.)l qwerty/qwerty.cpp and rot13/rot13.cpp. +.SH "QTextCursor * QTextEdit::textCursor () const\fC [protected]\fR" +Returns the text edit's text cursor. +.PP +\fBWarning:\fR QTextCursor is not in the public API, but in special circumstances you might wish to use it. +.SH "TextFormat QTextEdit::textFormat () const" +Returns the text format: rich text, plain text, log text or auto text. See the "textFormat" property for details. +.SH "bool QTextEdit::underline () const" +Returns TRUE if the current format is underlined; otherwise returns FALSE. +.PP +See also setUnderline(). +.SH "void QTextEdit::undo ()\fC [virtual slot]\fR" +Undoes the last operation. +.PP +If there is no operation to undo, i.e. there is no undo step in the undo/redo history, nothing happens. +.PP +See also undoAvailable(), redo(), and undoDepth. +.SH "void QTextEdit::undoAvailable ( bool yes )\fC [signal]\fR" +This signal is emitted when the availability of undo changes. If \fIyes\fR is TRUE, then undo() will work until undoAvailable( FALSE ) is next emitted. +.PP +See also undo() and undoDepth. +.SH "int QTextEdit::undoDepth () const" +Returns the depth of the undo history. See the "undoDepth" property for details. +.SH "WordWrap QTextEdit::wordWrap () const" +Returns the word wrap mode. See the "wordWrap" property for details. +.SH "int QTextEdit::wrapColumnOrWidth () const" +Returns the position (in pixels or columns depending on the wrap mode) where text will be wrapped. See the "wrapColumnOrWidth" property for details. +.SH "WrapPolicy QTextEdit::wrapPolicy () const" +Returns the word wrap policy, at whitespace or anywhere. See the "wrapPolicy" property for details. +.SH "void QTextEdit::zoomIn ( int range )\fC [virtual slot]\fR" +Zooms in on the text by making the base font size \fIrange\fR points larger and recalculating all font sizes to be the new size. This does not change the size of any images. +.PP +See also zoomOut(). +.SH "void QTextEdit::zoomIn ()\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Zooms in on the text by making the base font size one point larger and recalculating all font sizes to be the new size. This does not change the size of any images. +.PP +See also zoomOut(). +.SH "void QTextEdit::zoomOut ( int range )\fC [virtual slot]\fR" +Zooms out on the text by making the base font size \fIrange\fR points smaller and recalculating all font sizes to be the new size. This does not change the size of any images. +.PP +See also zoomIn(). +.SH "void QTextEdit::zoomOut ()\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Zooms out on the text by making the base font size one point smaller and recalculating all font sizes to be the new size. This does not change the size of any images. +.PP +See also zoomIn(). +.SH "void QTextEdit::zoomTo ( int size )\fC [virtual slot]\fR" +Zooms the text by making the base font size \fIsize\fR points and recalculating all font sizes to be the new size. This does not change the size of any images. +.SS "Property Documentation" +.SH "AutoFormatting autoFormatting" +This property holds the enabled set of auto formatting features. +.PP +The value can be any combination of the values in the AutoFormatting enum. The default is AutoAll. Choose AutoNone to disable all automatic formatting. +.PP +Currently, the only automatic formatting feature provided is AutoBulletList; future versions of Qt may offer more. +.PP +Set this property's value with setAutoFormatting() and get this property's value with autoFormatting(). +.SH "QString documentTitle" +This property holds the title of the document parsed from the text. +.PP +For PlainText the title will be an empty string. For RichText the title will be the text between the \fC<title>\fR tags, if present, otherwise an empty string. +.PP +Get this property's value with documentTitle(). +.SH "bool hasSelectedText" +This property holds whether some text is selected in selection 0. +.PP +Get this property's value with hasSelectedText(). +.SH "int length" +This property holds the number of characters in the text. +.PP +Get this property's value with length(). +.SH "bool linkUnderline" +This property holds whether hypertext links will be underlined. +.PP +If TRUE (the default) hypertext links will be displayed underlined. If FALSE links will not be displayed underlined. +.PP +Set this property's value with setLinkUnderline() and get this property's value with linkUnderline(). +.SH "bool modified" +This property holds whether the document has been modified by the user. +.PP +Set this property's value with setModified() and get this property's value with isModified(). +.SH "bool overwriteMode" +This property holds the text edit's overwrite mode. +.PP +If FALSE (the default) characters entered by the user are inserted with any characters to the right being moved out of the way. If TRUE, the editor is in overwrite mode, i.e. characters entered by the user overwrite any characters to the right of the cursor position. +.PP +Set this property's value with setOverwriteMode() and get this property's value with isOverwriteMode(). +.SH "QBrush paper" +This property holds the background (paper) brush. +.PP +The brush that is currently used to draw the background of the text edit. The initial setting is an empty brush. +.PP +Set this property's value with setPaper() and get this property's value with paper(). +.SH "bool readOnly" +This property holds whether the text edit is read-only. +.PP +In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible. +.PP +This property's default is FALSE. +.PP +Set this property's value with setReadOnly() and get this property's value with isReadOnly(). +.SH "QString selectedText" +This property holds the selected text (from selection 0) or an empty string if there is no currently selected text (in selection 0). +.PP +The text is always returned as PlainText if the textFormat() is PlainText or AutoText, otherwise it is returned as HTML. +.PP +See also hasSelectedText. +.PP +Get this property's value with selectedText(). +.SH "bool tabChangesFocus" +This property holds whether TAB changes focus or is accepted as input. +.PP +In some occasions text edits should not allow the user to input tabulators or change indentation using the TAB key, as this breaks the focus chain. The default is FALSE. +.PP +Set this property's value with setTabChangesFocus() and get this property's value with tabChangesFocus(). +.SH "int tabStopWidth" +This property holds the tab stop width in pixels. +.PP +Set this property's value with setTabStopWidth() and get this property's value with tabStopWidth(). +.SH "QString text" +This property holds the text edit's text. +.PP +There is no default text. +.PP +On setting, any previous text is deleted. +.PP +The text may be interpreted either as plain text or as rich text, depending on the textFormat(). The default setting is AutoText, i.e. the text edit auto-detects the format of the text. +.PP +For richtext, calling text() on an editable QTextEdit will cause the text to be regenerated from the textedit. This may mean that the QString returned may not be exactly the same as the one that was set. +.PP +See also textFormat. +.PP +Set this property's value with setText() and get this property's value with text(). +.SH "TextFormat textFormat" +This property holds the text format: rich text, plain text, log text or auto text. +.PP +The text format is one of the following: +.TP +PlainText - all characters, except newlines, are displayed verbatim, including spaces. Whenever a newline appears in the text the text edit inserts a hard line break and begins a new paragraph. +.TP +RichText - rich text rendering. The available styles are defined in the default stylesheet QStyleSheet::defaultSheet(). +.TP +LogText - optimized mode for very large texts. Supports a very limited set of formatting tags (color, bold, underline and italic settings). +.TP +AutoText - this is the default. The text edit autodetects which rendering style is best, PlainText or RichText. This is done by using the QStyleSheet::mightBeRichText() function. +.PP +Set this property's value with setTextFormat() and get this property's value with textFormat(). +.SH "int undoDepth" +This property holds the depth of the undo history. +.PP +The maximum number of steps in the undo/redo history. The default is 100. +.PP +See also undo() and redo(). +.PP +Set this property's value with setUndoDepth() and get this property's value with undoDepth(). +.SH "bool undoRedoEnabled" +This property holds whether undo/redo is enabled. +.PP +When changing this property, the undo/redo history is cleared. +.PP +The default is TRUE. +.PP +Set this property's value with setUndoRedoEnabled() and get this property's value with isUndoRedoEnabled(). +.SH "WordWrap wordWrap" +This property holds the word wrap mode. +.PP +The default mode is WidgetWidth which causes words to be wrapped at the right edge of the text edit. Wrapping occurs at whitespace, keeping whole words intact. If you want wrapping to occur within words use setWrapPolicy(). If you set a wrap mode of FixedPixelWidth or FixedColumnWidth you should also call setWrapColumnOrWidth() with the width you want. +.PP +See also WordWrap, wrapColumnOrWidth, and wrapPolicy. +.PP +Set this property's value with setWordWrap() and get this property's value with wordWrap(). +.SH "int wrapColumnOrWidth" +This property holds the position (in pixels or columns depending on the wrap mode) where text will be wrapped. +.PP +If the wrap mode is FixedPixelWidth, the value is the number of pixels from the left edge of the text edit at which text should be wrapped. If the wrap mode is FixedColumnWidth, the value is the column number (in character columns) from the left edge of the text edit at which text should be wrapped. +.PP +See also wordWrap. +.PP +Set this property's value with setWrapColumnOrWidth() and get this property's value with wrapColumnOrWidth(). +.SH "WrapPolicy wrapPolicy" +This property holds the word wrap policy, at whitespace or anywhere. +.PP +Defines where text can be wrapped when word wrap mode is not NoWrap. The choices are AtWordBoundary (the default), Anywhere and AtWordOrDocumentBoundary +.PP +See also wordWrap. +.PP +Set this property's value with setWrapPolicy() and get this property's value with wrapPolicy(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtextedit.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextedit.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextencoder.3qt b/doc/man/man3/tqtextencoder.3qt new file mode 100644 index 000000000..489428a3a --- /dev/null +++ b/doc/man/man3/tqtextencoder.3qt @@ -0,0 +1,65 @@ +'\" t +.TH QTextEncoder 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 +QTextEncoder \- State-based encoder +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqtextcodec.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual \fB~QTextEncoder\fR ()" +.br +.ti -1c +.BI "virtual QCString \fBfromUnicode\fR ( const QString & uc, int & lenInOut ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QTextEncoder class provides a state-based encoder. +.PP +The encoder converts Unicode into another format, remembering any state that is required between calls. +.PP +See also QTextCodec::makeEncoder() and Internationalization with Qt. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextEncoder::~QTextEncoder ()\fC [virtual]\fR" +Destroys the encoder. +.SH "QCString QTextEncoder::fromUnicode ( const QString & uc, int & lenInOut )\fC [pure virtual]\fR" +Converts \fIlenInOut\fR characters (not bytes) from \fIuc\fR, producing a QCString. \fIlenInOut\fR will be set to the length of the result (in bytes). +.PP +The encoder is free to record state to use when subsequent calls +are made to this function (for example, it might change modes with +escape sequences if needed during the encoding of one string, then +assume that mode applies when a subsequent call begins). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtextencoder.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextencoder.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextistream.3qt b/doc/man/man3/tqtextistream.3qt new file mode 100644 index 000000000..a94e99e10 --- /dev/null +++ b/doc/man/man3/tqtextistream.3qt @@ -0,0 +1,79 @@ +'\" t +.TH QTextIStream 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 +QTextIStream \- Convenience class for input streams +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqtextstream.h>\fR +.PP +Inherits QTextStream. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTextIStream\fR ( const QString * s )" +.br +.ti -1c +.BI "\fBQTextIStream\fR ( QByteArray ba )" +.br +.ti -1c +.BI "\fBQTextIStream\fR ( FILE * f )" +.br +.in -1c +.SH DESCRIPTION +The QTextIStream class is a convenience class for input streams. +.PP +This class provides a shorthand for creating simple input QTextStreams without having to pass a \fImode\fR argument to the constructor. +.PP +This class makes it easy, for example, to write things like this: +.PP +.nf +.br + QString data = "123 456"; +.br + int a, b; +.br + QTextIStream(&data) >> a >> b; +.br +.fi +.PP +See also QTextOStream, Input/Output and Networking, and Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextIStream::QTextIStream ( const QString * s )" +Constructs a stream to read from the string \fIs\fR. +.SH "QTextIStream::QTextIStream ( QByteArray ba )" +Constructs a stream to read from the array \fIba\fR. +.SH "QTextIStream::QTextIStream ( FILE * f )" +Constructs a stream to read from the file \fIf\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtextistream.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextistream.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextostream.3qt b/doc/man/man3/tqtextostream.3qt new file mode 100644 index 000000000..e90b1f199 --- /dev/null +++ b/doc/man/man3/tqtextostream.3qt @@ -0,0 +1,77 @@ +'\" t +.TH QTextOStream 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 +QTextOStream \- Convenience class for output streams +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqtextstream.h>\fR +.PP +Inherits QTextStream. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTextOStream\fR ( QString * s )" +.br +.ti -1c +.BI "\fBQTextOStream\fR ( QByteArray ba )" +.br +.ti -1c +.BI "\fBQTextOStream\fR ( FILE * f )" +.br +.in -1c +.SH DESCRIPTION +The QTextOStream class is a convenience class for output streams. +.PP +This class provides a shorthand for creating simple output QTextStreams without having to pass a \fImode\fR argument to the constructor. +.PP +This makes it easy for example, to write things like this: +.PP +.nf +.br + QString result; +.br + QTextOStream(&result) << "pi = " << 3.14; +.br +.fi +.PP +See also Input/Output and Networking and Text Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextOStream::QTextOStream ( QString * s )" +Constructs a stream to write to string \fIs\fR. +.SH "QTextOStream::QTextOStream ( QByteArray ba )" +Constructs a stream to write to the array \fIba\fR. +.SH "QTextOStream::QTextOStream ( FILE * f )" +Constructs a stream to write to the file \fIf\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtextostream.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextostream.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtextstream.3qt b/doc/man/man3/tqtextstream.3qt new file mode 100644 index 000000000..fbe4778cb --- /dev/null +++ b/doc/man/man3/tqtextstream.3qt @@ -0,0 +1,642 @@ +'\" t +.TH QTextStream 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 +QTextStream \- Basic functions for reading and writing text using a QIODevice +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqtextstream.h>\fR +.PP +Inherited by QTextIStream and QTextOStream. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBEncoding\fR { Locale, Latin1, Unicode, UnicodeNetworkOrder, UnicodeReverse, RawUnicode, UnicodeUTF8 }" +.br +.ti -1c +.BI "void \fBsetEncoding\fR ( Encoding e )" +.br +.ti -1c +.BI "void \fBsetCodec\fR ( QTextCodec * codec )" +.br +.ti -1c +.BI "QTextCodec * \fBcodec\fR ()" +.br +.ti -1c +.BI "\fBQTextStream\fR ()" +.br +.ti -1c +.BI "\fBQTextStream\fR ( QIODevice * iod )" +.br +.ti -1c +.BI "\fBQTextStream\fR ( QString * str, int filemode )" +.br +.ti -1c +.BI "QTextStream ( QString & str, int filemode ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "\fBQTextStream\fR ( QByteArray a, int mode )" +.br +.ti -1c +.BI "\fBQTextStream\fR ( FILE * fh, int mode )" +.br +.ti -1c +.BI "virtual \fB~QTextStream\fR ()" +.br +.ti -1c +.BI "QIODevice * \fBdevice\fR () const" +.br +.ti -1c +.BI "void \fBsetDevice\fR ( QIODevice * iod )" +.br +.ti -1c +.BI "void \fBunsetDevice\fR ()" +.br +.ti -1c +.BI "bool \fBatEnd\fR () const" +.br +.ti -1c +.BI "bool eof () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( QChar & c )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( char & c )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( signed short & i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( unsigned short & i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( signed int & i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( unsigned int & i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( signed long & i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( unsigned long & i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( float & f )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( double & f )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( char * s )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( QString & str )" +.br +.ti -1c +.BI "QTextStream & \fBoperator>>\fR ( QCString & str )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( QChar c )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( char c )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( signed short i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( unsigned short i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( signed int i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( unsigned int i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( signed long i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( unsigned long i )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( float f )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( double f )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( const char * s )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( const QString & s )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( const QCString & s )" +.br +.ti -1c +.BI "QTextStream & \fBoperator<<\fR ( void * ptr )" +.br +.ti -1c +.BI "QTextStream & \fBreadRawBytes\fR ( char * s, uint len )" +.br +.ti -1c +.BI "QTextStream & \fBwriteRawBytes\fR ( const char * s, uint len )" +.br +.ti -1c +.BI "QString \fBreadLine\fR ()" +.br +.ti -1c +.BI "QString \fBread\fR ()" +.br +.ti -1c +.BI "void \fBskipWhiteSpace\fR ()" +.br +.ti -1c +.BI "int \fBflags\fR () const" +.br +.ti -1c +.BI "int \fBflags\fR ( int f )" +.br +.ti -1c +.BI "int \fBsetf\fR ( int bits )" +.br +.ti -1c +.BI "int \fBsetf\fR ( int bits, int mask )" +.br +.ti -1c +.BI "int \fBunsetf\fR ( int bits )" +.br +.ti -1c +.BI "void \fBreset\fR ()" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR ( int w )" +.br +.ti -1c +.BI "int \fBfill\fR () const" +.br +.ti -1c +.BI "int \fBfill\fR ( int f )" +.br +.ti -1c +.BI "int \fBprecision\fR () const" +.br +.ti -1c +.BI "int \fBprecision\fR ( int p )" +.br +.in -1c +.SH DESCRIPTION +The QTextStream class provides basic functions for reading and writing text using a QIODevice. +.PP +The text stream class has a functional interface that is very similar to that of the standard C++ iostream class. +.PP +Qt provides several global functions similar to the ones in iostream: <center>.nf +.TS +l - l. Function Meaning bin sets the QTextStream to read/write binary numbers oct sets the QTextStream to read/write octal numbers dec sets the QTextStream to read/write decimal numbers hex sets the QTextStream to read/write hexadecimal numbers endl forces a line break flush forces the QIODevice to flush any buffered data ws eats any available whitespace (on input) reset resets the QTextStream to its default mode (see reset()) qSetW(int) sets the field width to the given argument qSetFill(int) sets the fill character to the given argument qSetPrecision(int) +.TE +.fi +</center> +.PP +\fBWarning:\fR By default QTextStream will automatically detect whether integers in the stream are in decimal, octal, hexadecimal or binary format when reading from the stream. In particular, a leading '0' signifies octal, i.e. the sequence "0100" will be interpreted as 64. +.PP +The QTextStream class reads and writes text; it is not appropriate for dealing with binary data (but QDataStream is). +.PP +By default, output of Unicode text (i.e. QString) is done using the local 8-bit encoding. This can be changed using the setEncoding() method. For input, the QTextStream will auto-detect standard Unicode "byte order marked" text files; otherwise the local 8-bit encoding is used. +.PP +The QIODevice is set in the constructor, or later using setDevice(). If the end of the input is reached atEnd() returns TRUE. Data can be read into variables of the appropriate type using the operator>>() overloads, or read in its entirety into a single string using read(), or read a line at a time using readLine(). Whitespace can be skipped over using skipWhiteSpace(). You can set flags for the stream using flags() or setf(). The stream also supports width(), precision() and fill(); use reset() to reset the defaults. +.PP +See also QDataStream, Input/Output and Networking, and Text Related Classes. +.SS "Member Type Documentation" +.SH "QTextStream::Encoding" +.TP +\fCQTextStream::Locale\fR +.TP +\fCQTextStream::Latin1\fR +.TP +\fCQTextStream::Unicode\fR +.TP +\fCQTextStream::UnicodeNetworkOrder\fR +.TP +\fCQTextStream::UnicodeReverse\fR +.TP +\fCQTextStream::RawUnicode\fR +.TP +\fCQTextStream::UnicodeUTF8\fR +.PP +See setEncoding() for an explanation of the encodings. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTextStream::QTextStream ()" +Constructs a data stream that has no IO device. +.SH "QTextStream::QTextStream ( QIODevice * iod )" +Constructs a text stream that uses the IO device \fIiod\fR. +.SH "QTextStream::QTextStream ( QString * str, int filemode )" +Constructs a text stream that operates on the Unicode QString, \fIstr\fR, through an internal device. The \fIfilemode\fR argument is passed to the device's open() function; see QIODevice::mode(). +.PP +If you set an encoding or codec with setEncoding() or setCodec(), this setting is ignored for text streams that operate on QString. +.PP +Example: +.PP +.nf +.br + QString str; +.br + QTextStream ts( &str, IO_WriteOnly ); +.br + ts << "pi = " << 3.14; // str == "pi = 3.14" +.br +.fi +.PP +Writing data to the text stream will modify the contents of the string. The string will be expanded when data is written beyond the end of the string. Note that the string will not be truncated: +.PP +.nf +.br + QString str = "pi = 3.14"; +.br + QTextStream ts( &str, IO_WriteOnly ); +.br + ts << "2+2 = " << 2+2; // str == "2+2 = 414" +.br +.fi +.PP +Note that because QString is Unicode, you should not use readRawBytes() or writeRawBytes() on such a stream. +.SH "QTextStream::QTextStream ( QString & str, int filemode )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This constructor is equivalent to the constructor taking a QString* parameter. +.SH "QTextStream::QTextStream ( QByteArray a, int mode )" +Constructs a text stream that operates on the byte array, \fIa\fR, through an internal QBuffer device. The \fImode\fR argument is passed to the device's open() function; see QIODevice::mode(). +.PP +Example: +.PP +.nf +.br + QByteArray array; +.br + QTextStream ts( array, IO_WriteOnly ); +.br + ts << "pi = " << 3.14 << '\\0'; // array == "pi = 3.14" +.br +.fi +.PP +Writing data to the text stream will modify the contents of the array. The array will be expanded when data is written beyond the end of the string. +.PP +Same example, using a QBuffer: +.PP +.nf +.br + QByteArray array; +.br + QBuffer buf( array ); +.br + buf.open( IO_WriteOnly ); +.br + QTextStream ts( &buf ); +.br + ts << "pi = " << 3.14 << '\\0'; // array == "pi = 3.14" +.br + buf.close(); +.br +.fi +.SH "QTextStream::QTextStream ( FILE * fh, int mode )" +Constructs a text stream that operates on an existing file handle \fIfh\fR through an internal QFile device. The \fImode\fR argument is passed to the device's open() function; see QIODevice::mode(). +.PP +Note that if you create a QTextStream \fCcout\fR or another name that is also used for another variable of a different type, some linkers may confuse the two variables, which will often cause crashes. +.SH "QTextStream::~QTextStream ()\fC [virtual]\fR" +Destroys the text stream. +.PP +The destructor does not affect the current IO device. +.SH "bool QTextStream::atEnd () const" +Returns TRUE if the IO device has reached the end position (end of the stream or file) or if there is no IO device set; otherwise returns FALSE. +.PP +See also QIODevice::atEnd(). +.PP +Examples: +.)l addressbook/centralwidget.cpp and grapher/grapher.cpp. +.SH "QTextCodec * QTextStream::codec ()" +Returns the codec actually used for this stream. +.PP +If Unicode is automatically detected in input, a codec with name() "ISO-10646-UCS-2" is returned. +.PP +See also setCodec(). +.SH "QIODevice * QTextStream::device () const" +Returns the IO device currently set. +.PP +See also setDevice() and unsetDevice(). +.SH "bool QTextStream::eof () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function has been renamed to atEnd(). +.PP +See also QIODevice::atEnd(). +.PP +Example: chart/chartform_files.cpp. +.SH "int QTextStream::fill () const" +Returns the fill character. The default value is ' ' (space). +.SH "int QTextStream::fill ( int f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the fill character to \fIf\fR. Returns the previous fill character. +.SH "int QTextStream::flags () const" +Returns the current stream flags. The default value is 0. +.PP +<center>.nf +.TS +l +- +l. +Flag Meaning + Not currently used; whitespace always skipped + Numeric fields are left-aligned + Not currently used (by default, numerics are right-aligned) + Puts any padding spaces between +/- and value + Output \fIand\fR input only in binary + Output \fIand\fR input only in octal + Output \fIand\fR input only in decimal + Output \fIand\fR input only in hexadecimal + Annotates numeric outputs with 0b, 0, or 0x if in + Not currently used + Uses 0B and 0X rather than 0b and 0x + Shows + for positive numeric values + Uses scientific notation for floating point values + +.TE +.fi +</center> +.PP +Note that unless \fCbin\fR, \fCoct\fR, \fCdec\fR, or \fChex\fR is set, the input base is octal if the value starts with 0, hexadecimal if it starts with 0x, binary if it starts with 0b, and decimal otherwise. +.PP +See also setf() and unsetf(). +.SH "int QTextStream::flags ( int f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the stream flags to \fIf\fR. Returns the previous stream flags. +.PP +See also setf() and unsetf(). +.SH "QTextStream & QTextStream::operator<< ( QChar c )" +Writes character \fCchar\fR to the stream and returns a reference to the stream. +.PP +The character \fIc\fR is assumed to be Latin1 encoded independent of the Encoding set for the QTextStream. +.SH "QTextStream & QTextStream::operator<< ( char c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes character \fIc\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( signed short i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a \fCshort\fR integer \fIi\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( unsigned short i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an \fCunsigned\fR \fCshort\fR integer \fIi\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( signed int i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an \fCint\fR \fIi\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( unsigned int i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an \fCunsigned\fR \fCint\fR \fIi\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( signed long i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a \fClong\fR \fCint\fR \fIi\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( unsigned long i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes an \fCunsigned\fR \fClong\fR \fCint\fR \fIi\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( float f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a \fCfloat\fR \fIf\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( double f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a \fCdouble\fR \fIf\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( const char * s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a string to the stream and returns a reference to the stream. +.PP +The string \fIs\fR is assumed to be Latin1 encoded independent of the Encoding set for the QTextStream. +.SH "QTextStream & QTextStream::operator<< ( const QString & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes \fIs\fR to the stream and returns a reference to the stream. +.SH "QTextStream & QTextStream::operator<< ( const QCString & s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes \fIs\fR to the stream and returns a reference to the stream. +.PP +The string \fIs\fR is assumed to be Latin1 encoded independent of the Encoding set for the QTextStream. +.SH "QTextStream & QTextStream::operator<< ( void * ptr )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a pointer to the stream and returns a reference to the stream. +.PP +The \fIptr\fR is output as an unsigned long hexadecimal integer. +.SH "QTextStream & QTextStream::operator>> ( QChar & c )" +Reads a char \fIc\fR from the stream and returns a reference to the stream. Note that whitespace is \fInot\fR skipped. +.SH "QTextStream & QTextStream::operator>> ( char & c )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a char \fIc\fR from the stream and returns a reference to the stream. Note that whitespace is skipped. +.SH "QTextStream & QTextStream::operator>> ( signed short & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a signed \fCshort\fR integer \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( unsigned short & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned \fCshort\fR integer \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( signed int & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a signed \fCint\fR \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( unsigned int & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned \fCint\fR \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( signed long & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a signed \fClong\fR int \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( unsigned long & i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads an unsigned \fClong\fR int \fIi\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( float & f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a \fCfloat\fR \fIf\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( double & f )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a \fCdouble\fR \fIf\fR from the stream and returns a reference to the stream. See flags() for an explanation of the expected input format. +.SH "QTextStream & QTextStream::operator>> ( char * s )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a "word" from the stream into \fIs\fR and returns a reference to the stream. +.PP +A word consists of characters for which isspace() returns FALSE. +.SH "QTextStream & QTextStream::operator>> ( QString & str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a "word" from the stream into \fIstr\fR and returns a reference to the stream. +.PP +A word consists of characters for which isspace() returns FALSE. +.SH "QTextStream & QTextStream::operator>> ( QCString & str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Reads a "word" from the stream into \fIstr\fR and returns a reference to the stream. +.PP +A word consists of characters for which isspace() returns FALSE. +.SH "int QTextStream::precision () const" +Returns the precision. The default value is 6. +.SH "int QTextStream::precision ( int p )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the precision to \fIp\fR. Returns the previous precision setting. +.SH "QString QTextStream::read ()" +Reads the entire stream from the current position, and returns a string containing the text. +.PP +See also QIODevice::readLine(). +.PP +Examples: +.)l action/application.cpp, application/application.cpp, mdi/application.cpp, qdir/qdir.cpp, and qwerty/qwerty.cpp. +.SH "QString QTextStream::readLine ()" +Reads a line from the stream and returns a string containing the text. +.PP +The returned string does not contain any trailing newline or carriage return. Note that this is different from QIODevice::readLine(), which does not strip the newline at the end of the line. +.PP +On EOF you will get a QString that is null. On reading an empty line the returned QString is empty but not null. +.PP +See also QIODevice::readLine(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, chart/element.cpp, and network/clientserver/server/server.cpp. +.SH "QTextStream & QTextStream::readRawBytes ( char * s, uint len )" +Reads \fIlen\fR bytes from the stream into \fIs\fR and returns a reference to the stream. +.PP +The buffer \fIs\fR must be preallocated. +.PP +Note that no encoding is done by this function. +.PP +\fBWarning:\fR The behavior of this function is undefined unless the stream's encoding is set to Unicode or Latin1. +.PP +See also QIODevice::readBlock(). +.SH "void QTextStream::reset ()" +Resets the text stream. +.TP +All flags are set to 0. +.TP +The field width is set to 0. +.TP +The fill character is set to ' ' (Space). +.TP +The precision is set to 6. +.PP +See also setf(), width(), fill(), and precision(). +.SH "void QTextStream::setCodec ( QTextCodec * codec )" +Sets the codec for this stream to \fIcodec\fR. Will not try to autodetect Unicode. +.PP +Note that this function should be called before any data is read to/written from the stream. +.PP +See also setEncoding() and codec(). +.PP +Example: qwerty/qwerty.cpp. +.SH "void QTextStream::setDevice ( QIODevice * iod )" +Sets the IO device to \fIiod\fR. +.PP +See also device() and unsetDevice(). +.SH "void QTextStream::setEncoding ( Encoding e )" +Sets the encoding of this stream to \fIe\fR, where \fIe\fR is one of the following values: <center>.nf +.TS +l - l. Encoding Meaning Locale Uses local file format (Latin1 if locale is not set), but autodetecting Unicode(utf16) on input. Unicode Uses Unicode(utf16) for input and output. Output will be written in the order most efficient for the current platform (i.e. the order used internally in QString). UnicodeUTF8 Using Unicode(utf8) for input and output. If you use it for input it will autodetect utf16 and use it instead of utf8. Latin1 ISO-8859-1. Will not autodetect utf16. UnicodeNetworkOrder Uses network order Unicode(utf16) for input and output. Useful when reading Unicode data that does not start with the byte order marker. UnicodeReverse Uses reverse network order Unicode(utf16) for input and output. Useful when reading Unicode data that does not start with the byte order marker or when writing data that should be read by buggy Windows applications. RawUnicode +.TE +.fi +</center> +.PP +Locale and all Unicode encodings, except RawUnicode, will look at the first two bytes in an input stream to determine the byte order. The initial byte order marker will be stripped off before data is read. +.PP +Note that this function should be called before any data is read to or written from the stream. +.PP +See also setCodec(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, network/httpd/httpd.cpp, and qwerty/qwerty.cpp. +.SH "int QTextStream::setf ( int bits )" +Sets the stream flag bits \fIbits\fR. Returns the previous stream flags. +.PP +Equivalent to \fCflags( flags() | bits )\fR. +.PP +See also unsetf(). +.SH "int QTextStream::setf ( int bits, int mask )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the stream flag bits \fIbits\fR with a bit mask \fImask\fR. Returns the previous stream flags. +.PP +Equivalent to \fCflags( (flags() & ~mask) | (bits & mask) )\fR. +.PP +See also unsetf(). +.SH "void QTextStream::skipWhiteSpace ()" +Positions the read pointer at the first non-whitespace character. +.SH "void QTextStream::unsetDevice ()" +Unsets the IO device. Equivalent to setDevice( 0 ). +.PP +See also device() and setDevice(). +.SH "int QTextStream::unsetf ( int bits )" +Clears the stream flag bits \fIbits\fR. Returns the previous stream flags. +.PP +Equivalent to \fCflags( flags() & ~mask )\fR. +.PP +See also setf(). +.SH "int QTextStream::width () const" +Returns the field width. The default value is 0. +.SH "int QTextStream::width ( int w )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the field width to \fIw\fR. Returns the previous field width. +.SH "QTextStream & QTextStream::writeRawBytes ( const char * s, uint len )" +Writes the \fIlen\fR bytes from \fIs\fR to the stream and returns a reference to the stream. +.PP +Note that no encoding is done by this function. +.PP +See also QIODevice::writeBlock(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtextstream.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtextstream.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqthread.3qt b/doc/man/man3/tqthread.3qt new file mode 100644 index 000000000..5d08faf41 --- /dev/null +++ b/doc/man/man3/tqthread.3qt @@ -0,0 +1,230 @@ +'\" t +.TH QThread 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 +QThread \- Platform-independent threads +.SH SYNOPSIS +All the functions in this class are thread-safe when Qt is built with thread support.</p> +.PP +\fC#include <ntqthread.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQThread\fR ( unsigned int stackSize = 0 )" +.br +.ti -1c +.BI "virtual \fB~QThread\fR ()" +.br +.ti -1c +.BI "bool \fBwait\fR ( unsigned long time = ULONG_MAX )" +.br +.ti -1c +.BI "enum \fBPriority\fR { IdlePriority, LowestPriority, LowPriority, NormalPriority, HighPriority, HighestPriority, TimeCriticalPriority, InheritPriority }" +.br +.ti -1c +.BI "void \fBstart\fR ( Priority priority = InheritPriority )" +.br +.ti -1c +.BI "void \fBterminate\fR ()" +.br +.ti -1c +.BI "bool \fBfinished\fR () const" +.br +.ti -1c +.BI "bool \fBrunning\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "Qt::HANDLE \fBcurrentThread\fR ()" +.br +.ti -1c +.BI "void postEvent ( QObject * receiver, QEvent * event ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBexit\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBrun\fR () = 0" +.br +.in -1c +.SS "Static Protected Members" +.in +1c +.ti -1c +.BI "void \fBsleep\fR ( unsigned long secs )" +.br +.ti -1c +.BI "void \fBmsleep\fR ( unsigned long msecs )" +.br +.ti -1c +.BI "void \fBusleep\fR ( unsigned long usecs )" +.br +.in -1c +.SH DESCRIPTION +The QThread class provides platform-independent threads. +.PP +A QThread represents a separate thread of control within the program; it shares data with all the other threads within the process but executes independently in the way that a separate program does on a multitasking operating system. Instead of starting in main(), QThreads begin executing in run(). You inherit run() to include your code. For example: +.PP +.nf +.br + class MyThread : public QThread { +.br +.br + public: +.br +.br + virtual void run(); +.br +.br + }; +.br +.br + void MyThread::run() +.br + { +.br + for( int count = 0; count < 20; count++ ) { +.br + sleep( 1 ); +.br + tqDebug( "Ping!" ); +.br + } +.br + } +.br +.br + int main() +.br + { +.br + MyThread a; +.br + MyThread b; +.br + a.start(); +.br + b.start(); +.br + a.wait(); +.br + b.wait(); +.br + } +.br +.fi +.PP +This will start two threads, each of which writes Ping! 20 times to the screen and exits. The wait() calls at the end of main() are necessary because exiting main() ends the program, unceremoniously killing all other threads. Each MyThread stops executing when it reaches the end of MyThread::run(), just as an application does when it leaves main(). +.PP +See also Thread Support in Qt, Environment Classes, and Threading. +.SS "Member Type Documentation" +.SH "QThread::Priority" +This enum type indicates how the operating system should schedule newly created threads. +.TP +\fCQThread::IdlePriority\fR - scheduled only when no other threads are running. +.TP +\fCQThread::LowestPriority\fR - scheduled less often than LowPriority. +.TP +\fCQThread::LowPriority\fR - scheduled less often than NormalPriority. +.TP +\fCQThread::NormalPriority\fR - the default priority of the operating system. +.TP +\fCQThread::HighPriority\fR - scheduled more often than NormalPriority. +.TP +\fCQThread::HighestPriority\fR - scheduled more often then HighPriority. +.TP +\fCQThread::TimeCriticalPriority\fR - scheduled as often as possible. +.TP +\fCQThread::InheritPriority\fR - use the same priority as the creating thread. This is the default. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QThread::QThread ( unsigned int stackSize = 0 )" +Constructs a new thread. The thread does not begin executing until start() is called. +.PP +If \fIstackSize\fR is greater than zero, the maximum stack size is set to \fIstackSize\fR bytes, otherwise the maximum stack size is automatically determined by the operating system. +.PP +\fBWarning:\fR Most operating systems place minimum and maximum limits on thread stack sizes. The thread will fail to start if the stack size is outside these limits. +.SH "QThread::~QThread ()\fC [virtual]\fR" +QThread destructor. +.PP +Note that deleting a QThread object will not stop the execution of the thread it represents. Deleting a running QThread (i.e. finished() returns FALSE) will probably result in a program crash. You can wait() on a thread to make sure that it has finished. +.SH "Qt::HANDLE QThread::currentThread ()\fC [static]\fR" +This returns the thread handle of the currently executing thread. +.PP +\fBWarning:\fR The handle returned by this function is used for internal purposes and should \fInot\fR be used in any application code. On Windows, the returned value is a pseudo handle for the current thread, and it cannot be used for numerical comparison. +.SH "void QThread::exit ()\fC [static]\fR" +Ends the execution of the calling thread and wakes up any threads waiting for its termination. +.SH "bool QThread::finished () const" +Returns TRUE if the thread is finished; otherwise returns FALSE. +.SH "void QThread::msleep ( unsigned long msecs )\fC [static protected]\fR" +System independent sleep. This causes the current thread to sleep for \fImsecs\fR milliseconds +.SH "void QThread::postEvent ( QObject * receiver, QEvent * event )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use QApplication::postEvent() instead. +.SH "void QThread::run ()\fC [pure virtual protected]\fR" +This method is pure virtual, and must be implemented in derived classes in order to do useful work. Returning from this method will end the execution of the thread. +.PP +See also wait(). +.SH "bool QThread::running () const" +Returns TRUE if the thread is running; otherwise returns FALSE. +.SH "void QThread::sleep ( unsigned long secs )\fC [static protected]\fR" +System independent sleep. This causes the current thread to sleep for \fIsecs\fR seconds. +.SH "void QThread::start ( Priority priority = InheritPriority )" +Begins execution of the thread by calling run(), which should be reimplemented in a QThread subclass to contain your code. The operating system will schedule the thread according to the \fIpriority\fR argument. +.PP +If you try to start a thread that is already running, this function will wait until the the thread has finished and then restart the thread. +.PP +See also Priority. +.SH "void QThread::terminate ()" +This function terminates the execution of the thread. The thread may or may not be terminated immediately, depending on the operating system's scheduling policies. Use QThread::wait() after terminate() for synchronous termination. +.PP +When the thread is terminated, all threads waiting for the the thread to finish will be woken up. +.PP +\fBWarning:\fR This function is dangerous, and its use is discouraged. The thread can be terminated at any point in its code path. Threads can be terminated while modifying data. There is no chance for the thread to cleanup after itself, unlock any held mutexes, etc. In short, use this function only if \fIabsolutely\fR necessary. +.SH "void QThread::usleep ( unsigned long usecs )\fC [static protected]\fR" +System independent sleep. This causes the current thread to sleep for \fIusecs\fR microseconds +.SH "bool QThread::wait ( unsigned long time = ULONG_MAX )" +A thread calling this function will block until either of these conditions is met: +.TP +The thread associated with this QThread object has finished execution (i.e. when it returns from run()). This function will return TRUE if the thread has finished. It also returns TRUE if the thread has not been started yet. +.TP +\fItime\fR milliseconds has elapsed. If \fItime\fR is ULONG_MAX (the default), then the wait will never timeout (the thread must return from run()). This function will return FALSE if the wait timed out. +.PP +This provides similar functionality to the POSIX \fCpthread_join()\fR function. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqthread.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqthread.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqthreadstorage.3qt b/doc/man/man3/tqthreadstorage.3qt new file mode 100644 index 000000000..fb9dc2ce4 --- /dev/null +++ b/doc/man/man3/tqthreadstorage.3qt @@ -0,0 +1,166 @@ +'\" t +.TH QThreadStorage 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 +QThreadStorage \- Per-thread data storage +.SH SYNOPSIS +All the functions in this class are thread-safe when Qt is built with thread support.</p> +.PP +\fC#include <ntqthreadstorage.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQThreadStorage\fR ()" +.br +.ti -1c +.BI "\fB~QThreadStorage\fR ()" +.br +.ti -1c +.BI "bool \fBhasLocalData\fR () const" +.br +.ti -1c +.BI "T & \fBlocalData\fR ()" +.br +.ti -1c +.BI "T \fBlocalData\fR () const" +.br +.ti -1c +.BI "void \fBsetLocalData\fR ( T data )" +.br +.in -1c +.SH DESCRIPTION +The QThreadStorage class provides per-thread data storage. +.PP +QThreadStorage is a template class that provides per-thread data storage. +.PP +\fINote that due to compiler limitations, QThreadStorage can only store pointers.\fR +.PP +The setLocalData() function stores a single thread-specific value for the calling thread. The data can be accessed later using the localData() functions. QThreadStorage takes ownership of the data (which must be created on the heap with \fInew\fR) and deletes it when the thread exits (either normally or via termination). +.PP +The hasLocalData() function allows the programmer to determine if data has previously been set using the setLocalData() function. This is useful for lazy initializiation. +.PP +For example, the following code uses QThreadStorage to store a single cache for each thread that calls the \fIcacheObject()\fR and \fIremoveFromCache()\fR functions. The cache is automatically deleted when the calling thread exits (either normally or via termination). +.PP +.nf +.br + QThreadStorage<QCache<SomeClass> *> caches; +.br +.br + void cacheObject( const QString &key, SomeClass *object ) +.br + { +.br + if ( ! caches.hasLocalData() ) +.br + caches.setLocalData( new QCache<SomeClass> ); +.br +.br + caches.localData()->insert( key, object ); +.br + } +.br +.br + void removeFromCache( const QString &key ) +.br + { +.br + if ( ! caches.hasLocalData() ) +.br + return; // nothing to do +.br +.br + caches.localData()->remove( key ); +.br + } +.br +.fi +.SH "Caveats" +.IP +.TP +As noted above, QThreadStorage can only store pointers due to compiler limitations. Support for value-based objects will be added when the majority of compilers are able to support partial template specialization. +.IP +.TP +The destructor does \fInot\fR delete per-thread data. QThreadStorage only deletes per-thread data when the thread exits or when setLocalData() is called multiple times. +.IP +.TP +QThreadStorage can only be used with threads started with QThread. It \fIcannot\fR be used with threads started with platform-specific APIs. +.IP +.TP +As a corollary to the above, platform-specific APIs cannot be used to exit or terminate a QThread using QThreadStorage. Doing so will cause all per-thread data to be leaked. See QThread::exit() and QThread::terminate(). +.IP +.TP +QThreadStorage \fIcan\fR be used to store data for the \fImain()\fR thread \fIafter\fR QApplication has been constructed. QThreadStorage deletes all data set for the \fImain()\fR thread when QApplication is destroyed, regardless of whether or not the \fImain()\fR thread has actually finished. +.IP +.TP +The implementation of QThreadStorage limits the total number of QThreadStorage objects to 256. An unlimited number of threads can store per-thread data in each QThreadStorage object. +.IP +.PP +See also Environment Classes and Threading. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QThreadStorage::QThreadStorage ()" +Constructs a new per-thread data storage object. +.SH "QThreadStorage::~QThreadStorage ()" +Destroys the per-thread data storage object. +.PP +Note: The per-thread data stored is \fInot\fR deleted. Any data left in QThreadStorage is leaked. Make sure that all threads using QThreadStorage have exited before deleting the QThreadStorage. +.PP +See also hasLocalData(). +.SH "bool QThreadStorage::hasLocalData () const" +Returns TRUE if the calling thread has non-zero data available; otherwise returns FALSE. +.PP +See also localData(). +.SH "T & QThreadStorage::localData ()" +Returns a reference to the data that was set by the calling thread. +.PP +Note: QThreadStorage can only store pointers. This function returns a \fIreference\fR to the pointer that was set by the calling thread. The value of this reference is 0 if no data was set by the calling thread, +.PP +See also hasLocalData(). +.SH "T QThreadStorage::localData () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a copy of the data that was set by the calling thread. +.PP +Note: QThreadStorage can only store pointers. This function returns a pointer to the data that was set by the calling thread. If no data was set by the calling thread, this function returns 0. +.PP +See also hasLocalData(). +.SH "void QThreadStorage::setLocalData ( T data )" +Sets the local data for the calling thread to \fIdata\fR. It can be accessed later using the localData() functions. +.PP +If \fIdata\fR is 0, this function deletes the previous data (if any) and returns immediately. +.PP +If \fIdata\fR is non-zero, QThreadStorage takes ownership of the \fIdata\fR and deletes it automatically either when the thread exits (either normally or via termination) or when setLocalData() is called again. +.PP +Note: QThreadStorage can only store pointers. The \fIdata\fR argument must be either a pointer to an object created on the heap (i.e. using \fInew\fR) or 0. You should not delete \fIdata\fR yourself; QThreadStorage takes ownership and will delete the \fIdata\fR itself. +.PP +See also localData() and hasLocalData(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqthreadstorage.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqthreadstorage.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtime.3qt b/doc/man/man3/tqtime.3qt new file mode 100644 index 000000000..59b7dc18a --- /dev/null +++ b/doc/man/man3/tqtime.3qt @@ -0,0 +1,372 @@ +'\" t +.TH QTime 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 +QTime \- Clock time functions +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqdatetime.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTime\fR ()" +.br +.ti -1c +.BI "\fBQTime\fR ( int h, int m, int s = 0, int ms = 0 )" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "int \fBhour\fR () const" +.br +.ti -1c +.BI "int \fBminute\fR () const" +.br +.ti -1c +.BI "int \fBsecond\fR () const" +.br +.ti -1c +.BI "int \fBmsec\fR () const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( Qt::DateFormat f = Qt::TextDate ) const" +.br +.ti -1c +.BI "QString \fBtoString\fR ( const QString & format ) const" +.br +.ti -1c +.BI "bool \fBsetHMS\fR ( int h, int m, int s, int ms = 0 )" +.br +.ti -1c +.BI "QTime \fBaddSecs\fR ( int nsecs ) const" +.br +.ti -1c +.BI "int \fBsecsTo\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "QTime \fBaddMSecs\fR ( int ms ) const" +.br +.ti -1c +.BI "int \fBmsecsTo\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const QTime & t ) const" +.br +.ti -1c +.BI "void \fBstart\fR ()" +.br +.ti -1c +.BI "int \fBrestart\fR ()" +.br +.ti -1c +.BI "int \fBelapsed\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QTime \fBcurrentTime\fR ()" +.br +.ti -1c +.BI "QTime \fBcurrentTime\fR ( Qt::TimeSpec ts )" +.br +.ti -1c +.BI "QTime \fBfromString\fR ( const QString & s, Qt::DateFormat f = Qt::TextDate )" +.br +.ti -1c +.BI "bool \fBisValid\fR ( int h, int m, int s, int ms = 0 )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QTime & t )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QTime & t )" +.br +.in -1c +.SH DESCRIPTION +The QTime class provides clock time functions. +.PP +A QTime object contains a clock time, i.e. the number of hours, minutes, seconds, and milliseconds since midnight. It can read the current time from the system clock and measure a span of elapsed time. It provides functions for comparing times and for manipulating a time by adding a number of (milli)seconds. +.PP +QTime uses the 24-hour clock format; it has no concept of AM/PM. It operates in local time; it knows nothing about time zones or daylight savings time. +.PP +A QTime object is typically created either by giving the number of hours, minutes, seconds, and milliseconds explicitly, or by using the static function currentTime(), which creates a QTime object that contains the system's clock time. Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. +.PP +The hour(), minute(), second(), and msec() functions provide access to the number of hours, minutes, seconds, and milliseconds of the time. The same information is provided in textual format by the toString() function. +.PP +QTime provides a full set of operators to compare two QTime objects. One time is considered smaller than another if it is earlier than the other. +.PP +The time a given number of seconds or milliseconds later than a given time can be found using the addSecs() or addMSecs() functions. Correspondingly, the number of (milli)seconds between two times can be found using the secsTo() or msecsTo() functions. +.PP +QTime can be used to measure a span of elapsed time using the start(), restart(), and elapsed() functions. +.PP +See also QDate, QDateTime, and Time and Date. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTime::QTime ()" +Constructs the time 0 hours, minutes, seconds and milliseconds, i.e. 00:00:00.000 (midnight). This is a valid time. +.PP +See also isValid(). +.SH "QTime::QTime ( int h, int m, int s = 0, int ms = 0 )" +Constructs a time with hour \fIh\fR, minute \fIm\fR, seconds \fIs\fR and milliseconds \fIms\fR. +.PP +\fIh\fR must be in the range 0..23, \fIm\fR and \fIs\fR must be in the range 0..59, and \fIms\fR must be in the range 0..999. +.PP +See also isValid(). +.SH "QTime QTime::addMSecs ( int ms ) const" +Returns a QTime object containing a time \fIms\fR milliseconds later than the time of this object (or earlier if \fIms\fR is negative). +.PP +Note that the time will wrap if it passes midnight. See addSecs() for an example. +.PP +See also addSecs() and msecsTo(). +.SH "QTime QTime::addSecs ( int nsecs ) const" +Returns a QTime object containing a time \fInsecs\fR seconds later than the time of this object (or earlier if \fInsecs\fR is negative). +.PP +Note that the time will wrap if it passes midnight. +.PP +Example: +.PP +.nf +.br + QTime n( 14, 0, 0 ); // n == 14:00:00 +.br + QTime t; +.br + t = n.addSecs( 70 ); // t == 14:01:10 +.br + t = n.addSecs( -70 ); // t == 13:58:50 +.br + t = n.addSecs( 10*60*60 + 5 ); // t == 00:00:05 +.br + t = n.addSecs( -15*60*60 ); // t == 23:00:00 +.br +.fi +.PP +See also addMSecs(), secsTo(), and QDateTime::addSecs(). +.SH "QTime QTime::currentTime ( Qt::TimeSpec ts )\fC [static]\fR" +Returns the current time as reported by the system clock, for the TimeSpec \fIts\fR. The default TimeSpec is LocalTime. +.PP +Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. +.PP +See also Qt::TimeSpec. +.PP +Examples: +.)l aclock/aclock.cpp, dclock/dclock.cpp, t12/cannon.cpp, and tictac/tictac.cpp. +.SH "QTime QTime::currentTime ()\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the current time as reported by the system clock. +.PP +Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. +.SH "int QTime::elapsed () const" +Returns the number of milliseconds that have elapsed since the last time start() or restart() was called. +.PP +Note that the counter wraps to zero 24 hours after the last call to start() or restart. +.PP +Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy. +.PP +\fBWarning:\fR If the system's clock setting has been changed since the last time start() or restart() was called, the result is undefined. This can happen when daylight savings time is turned on or off. +.PP +See also start() and restart(). +.SH "QTime QTime::fromString ( const QString & s, Qt::DateFormat f = Qt::TextDate )\fC [static]\fR" +Returns the representation \fIs\fR as a QTime using the format \fIf\fR, or an invalid time if this is not possible. +.PP +\fBWarning:\fR Note that Qt::LocalDate cannot be used here. +.SH "int QTime::hour () const" +Returns the hour part (0..23) of the time. +.PP +Examples: +.)l aclock/aclock.cpp and tictac/tictac.cpp. +.SH "bool QTime::isNull () const" +Returns TRUE if the time is equal to 00:00:00.000; otherwise returns FALSE. A null time is valid. +.PP +See also isValid(). +.SH "bool QTime::isValid () const" +Returns TRUE if the time is valid; otherwise returns FALSE. The time 23:30:55.746 is valid, whereas 24:12:30 is invalid. +.PP +See also isNull(). +.SH "bool QTime::isValid ( int h, int m, int s, int ms = 0 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if the specified time is valid; otherwise returns FALSE. +.PP +The time is valid if \fIh\fR is in the range 0..23, \fIm\fR and \fIs\fR are in the range 0..59, and \fIms\fR is in the range 0..999. +.PP +Example: +.PP +.nf +.br + QTime::isValid(21, 10, 30); // returns TRUE +.br + QTime::isValid(22, 5, 62); // returns FALSE +.br +.fi +.SH "int QTime::minute () const" +Returns the minute part (0..59) of the time. +.PP +Examples: +.)l aclock/aclock.cpp and tictac/tictac.cpp. +.SH "int QTime::msec () const" +Returns the millisecond part (0..999) of the time. +.SH "int QTime::msecsTo ( const QTime & t ) const" +Returns the number of milliseconds from this time to \fIt\fR (which is negative if \fIt\fR is earlier than this time). +.PP +Because QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400000 and 86400000 msec. +.PP +See also secsTo(). +.SH "bool QTime::operator!= ( const QTime & t ) const" +Returns TRUE if this time is different from \fIt\fR; otherwise returns FALSE. +.SH "bool QTime::operator< ( const QTime & t ) const" +Returns TRUE if this time is earlier than \fIt\fR; otherwise returns FALSE. +.SH "bool QTime::operator<= ( const QTime & t ) const" +Returns TRUE if this time is earlier than or equal to \fIt\fR; otherwise returns FALSE. +.SH "bool QTime::operator== ( const QTime & t ) const" +Returns TRUE if this time is equal to \fIt\fR; otherwise returns FALSE. +.SH "bool QTime::operator> ( const QTime & t ) const" +Returns TRUE if this time is later than \fIt\fR; otherwise returns FALSE. +.SH "bool QTime::operator>= ( const QTime & t ) const" +Returns TRUE if this time is later than or equal to \fIt\fR; otherwise returns FALSE. +.SH "int QTime::restart ()" +Sets this time to the current time and returns the number of milliseconds that have elapsed since the last time start() or restart() was called. +.PP +This function is guaranteed to be atomic and is thus very handy for repeated measurements. Call start() to start the first measurement and then restart() for each later measurement. +.PP +Note that the counter wraps to zero 24 hours after the last call to start() or restart(). +.PP +\fBWarning:\fR If the system's clock setting has been changed since the last time start() or restart() was called, the result is undefined. This can happen when daylight savings time is turned on or off. +.PP +See also start(), elapsed(), and currentTime(). +.SH "int QTime::second () const" +Returns the second part (0..59) of the time. +.PP +Example: tictac/tictac.cpp. +.SH "int QTime::secsTo ( const QTime & t ) const" +Returns the number of seconds from this time to \fIt\fR (which is negative if \fIt\fR is earlier than this time). +.PP +Because QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400 and 86400. +.PP +See also addSecs() and QDateTime::secsTo(). +.PP +Example: t12/cannon.cpp. +.SH "bool QTime::setHMS ( int h, int m, int s, int ms = 0 )" +Sets the time to hour \fIh\fR, minute \fIm\fR, seconds \fIs\fR and milliseconds \fIms\fR. +.PP +\fIh\fR must be in the range 0..23, \fIm\fR and \fIs\fR must be in the range 0..59, and \fIms\fR must be in the range 0..999. Returns TRUE if the set time is valid; otherwise returns FALSE. +.PP +See also isValid(). +.SH "void QTime::start ()" +Sets this time to the current time. This is practical for timing: +.PP +.nf +.br + QTime t; +.br + t.start(); +.br + some_lengthy_task(); +.br + tqDebug( "Time elapsed: %d ms", t.elapsed() ); +.br +.fi +.PP +See also restart(), elapsed(), and currentTime(). +.SH "QString QTime::toString ( const QString & format ) const" +Returns the time as a string. The \fIformat\fR parameter determines the format of the result string. +.PP +These expressions may be used: +.PP +<center>.nf +.TS +l - l. Expression Output h the hour without a leading zero (0..23 or 1..12 if AM/PM display) hh the hour with a leading zero (00..23 or 01..12 if AM/PM display) m the minute without a leading zero (0..59) mm the minute with a leading zero (00..59) s the second whithout a leading zero (0..59) ss the second whith a leading zero (00..59) z the milliseconds without leading zeroes (0..999) zzz the milliseconds with leading zeroes (000..999) AP use AM/PM display. \fIAP\fR will be replaced by either "AM" or "PM". ap +.TE +.fi +</center> +.PP +All other input characters will be ignored. +.PP +Example format strings (assuming that the QTime is 14:13:09.042) +.PP +<center>.nf +.TS +l - l. Format Result hh:mm:ss.zzz 14:13:09.042 h:m:s ap +.TE +.fi +</center> +.PP +If the time is an invalid time, then QString::null will be returned. +.PP +See also QDate::toString() and QDateTime::toString(). +.SH "QString QTime::toString ( Qt::DateFormat f = Qt::TextDate ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the time as a string. Milliseconds are not included. The \fIf\fR parameter determines the format of the string. +.PP +If \fIf\fR is Qt::TextDate, the string format is HH:MM:SS; e.g. 1 second before midnight would be "23:59:59". +.PP +If \fIf\fR is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates, which is also HH:MM:SS. +.PP +If \fIf\fR is Qt::LocalDate, the string format depends on the locale settings of the system. +.PP +If the time is an invalid time, then QString::null will be returned. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QTime & t )" +Writes time \fIt\fR to the stream \fIs\fR. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QTime & t )" +Reads a time from the stream \fIs\fR into \fIt\fR. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtime.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtime.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtimeedit.3qt b/doc/man/man3/tqtimeedit.3qt new file mode 100644 index 000000000..74fdee027 --- /dev/null +++ b/doc/man/man3/tqtimeedit.3qt @@ -0,0 +1,256 @@ +'\" t +.TH QTimeEdit 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 +QTimeEdit \- Time editor +.SH SYNOPSIS +\fC#include <ntqdatetimeedit.h>\fR +.PP +Inherits QDateTimeEditBase. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBDisplay\fR { Hours = 0x01, Minutes = 0x02, Seconds = 0x04, AMPM = 0x10 }" +.br +.ti -1c +.BI "\fBQTimeEdit\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQTimeEdit\fR ( const QTime & time, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QTimeEdit\fR ()" +.br +.ti -1c +.BI "QTime \fBtime\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAutoAdvance\fR ( bool advance )" +.br +.ti -1c +.BI "bool \fBautoAdvance\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMinValue\fR ( const QTime & d )" +.br +.ti -1c +.BI "QTime \fBminValue\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMaxValue\fR ( const QTime & d )" +.br +.ti -1c +.BI "QTime \fBmaxValue\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRange\fR ( const QTime & min, const QTime & max )" +.br +.ti -1c +.BI "QString \fBseparator\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSeparator\fR ( const QString & s )" +.br +.ti -1c +.BI "uint \fBdisplay\fR () const" +.br +.ti -1c +.BI "void \fBsetDisplay\fR ( uint disp )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetTime\fR ( const QTime & time )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBvalueChanged\fR ( const QTime & time )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoAdvance\fR - whether the editor automatically advances to the next section" +.br +.ti -1c +.BI "Display \fBdisplay\fR - the sections that are displayed in the time edit" +.br +.ti -1c +.BI "QTime \fBmaxValue\fR - the maximum time value" +.br +.ti -1c +.BI "QTime \fBminValue\fR - the minimum time value" +.br +.ti -1c +.BI "QTime \fBtime\fR - the editor's time value" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QString \fBsectionFormattedText\fR ( int sec )" +.br +.ti -1c +.BI "virtual void \fBsetHour\fR ( int h )" +.br +.ti -1c +.BI "virtual void \fBsetMinute\fR ( int m )" +.br +.ti -1c +.BI "virtual void \fBsetSecond\fR ( int s )" +.br +.in -1c +.SH DESCRIPTION +The QTimeEdit class provides a time editor. +.PP +QTimeEdit allows the user to edit times by using the keyboard or the arrow keys to increase/decrease time values. The arrow keys can be used to move from section to section within the QTimeEdit box. The user can automatically be moved to the next section once they complete a section using setAutoAdvance(). Times appear in hour, minute, second order. It is recommended that the QTimeEdit is initialised with a time, e.g. +.PP +.nf +.br + QTime timeNow = QTime::currentTime(); +.br + QTimeEdit *timeEdit = new QTimeEdit( timeNow, this ); +.br + timeEdit->setRange( timeNow, timeNow.addSecs( 60 * 60 ) ); +.br +.fi +Here we've created a QTimeEdit widget set to the current time. We've also set the minimum value to the current time and the maximum time to one hour from now. +.PP +The maximum and minimum values for a time value in the time editor default to the maximum and minimum values for a QTime. You can change this by calling setMinValue(), setMaxValue() or setRange(). +.PP +Terminology: A QTimeWidget consists of three sections, one each for the hour, minute and second. You can change the separator character using setSeparator(), by default the separator is read from the system's settings. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QTime, QDateEdit, QDateTimeEdit, Advanced Widgets, and Time and Date. +.SS "Member Type Documentation" +.SH "QTimeEdit::Display" +This enum defines the sections that comprise a time +.TP +\fCQTimeEdit::Hours\fR - The hours section +.TP +\fCQTimeEdit::Minutes\fR - The minutes section +.TP +\fCQTimeEdit::Seconds\fR - The seconds section +.TP +\fCQTimeEdit::AMPM\fR - The AM/PM section +.PP +The values can be or'ed together to show any combination. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTimeEdit::QTimeEdit ( QWidget * parent = 0, const char * name = 0 )" +Constructs an empty time edit with parent \fIparent\fR and called \fIname\fR. +.SH "QTimeEdit::QTimeEdit ( const QTime & time, QWidget * parent = 0, const char * name = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a time edit with the initial time value, \fItime\fR, parent \fIparent\fR and called \fIname\fR. +.SH "QTimeEdit::~QTimeEdit ()" +Destroys the object and frees any allocated resources. +.SH "bool QTimeEdit::autoAdvance () const" +Returns TRUE if the editor automatically advances to the next section; otherwise returns FALSE. See the "autoAdvance" property for details. +.SH "uint QTimeEdit::display () const" +Returns the sections that are displayed in the time edit. See the "display" property for details. +.SH "QTime QTimeEdit::maxValue () const" +Returns the maximum time value. See the "maxValue" property for details. +.SH "QTime QTimeEdit::minValue () const" +Returns the minimum time value. See the "minValue" property for details. +.SH "QString QTimeEdit::sectionFormattedText ( int sec )\fC [virtual protected]\fR" +Returns the formatted number for section \fIsec\fR. This will correspond to either the hour, minute or second section, depending on \fIsec\fR. +.SH "QString QTimeEdit::separator () const" +Returns the editor's separator. +.SH "void QTimeEdit::setAutoAdvance ( bool advance )\fC [virtual]\fR" +Sets whether the editor automatically advances to the next section to \fIadvance\fR. See the "autoAdvance" property for details. +.SH "void QTimeEdit::setDisplay ( uint disp )" +Sets the sections that are displayed in the time edit to \fIdisp\fR. See the "display" property for details. +.SH "void QTimeEdit::setHour ( int h )\fC [virtual protected]\fR" +Sets the hour to \fIh\fR, which must be a valid hour, i.e. in the range 0..24. +.SH "void QTimeEdit::setMaxValue ( const QTime & d )\fC [virtual]\fR" +Sets the maximum time value to \fId\fR. See the "maxValue" property for details. +.SH "void QTimeEdit::setMinValue ( const QTime & d )\fC [virtual]\fR" +Sets the minimum time value to \fId\fR. See the "minValue" property for details. +.SH "void QTimeEdit::setMinute ( int m )\fC [virtual protected]\fR" +Sets the minute to \fIm\fR, which must be a valid minute, i.e. in the range 0..59. +.SH "void QTimeEdit::setRange ( const QTime & min, const QTime & max )\fC [virtual]\fR" +Sets the valid input range for the editor to be from \fImin\fR to \fImax\fR inclusive. If \fImin\fR is invalid no minimum time is set. Similarly, if \fImax\fR is invalid no maximum time is set. +.SH "void QTimeEdit::setSecond ( int s )\fC [virtual protected]\fR" +Sets the second to \fIs\fR, which must be a valid second, i.e. in the range 0..59. +.SH "void QTimeEdit::setSeparator ( const QString & s )\fC [virtual]\fR" +Sets the separator to \fIs\fR. Note that currently only the first character of \fIs\fR is used. +.SH "void QTimeEdit::setTime ( const QTime & time )\fC [virtual slot]\fR" +Sets the editor's time value to \fItime\fR. See the "time" property for details. +.SH "QTime QTimeEdit::time () const" +Returns the editor's time value. See the "time" property for details. +.SH "void QTimeEdit::valueChanged ( const QTime & time )\fC [signal]\fR" +This signal is emitted whenever the editor's value changes. The \fItime\fR parameter is the new value. +.SS "Property Documentation" +.SH "bool autoAdvance" +This property holds whether the editor automatically advances to the next section. +.PP +If autoAdvance is TRUE, the editor will automatically advance focus to the next time section if a user has completed a section. The default is FALSE. +.PP +Set this property's value with setAutoAdvance() and get this property's value with autoAdvance(). +.SH "Display display" +This property holds the sections that are displayed in the time edit. +.PP +The value can be any combination of the values in the Display enum. By default, the widget displays hours, minutes and seconds. +.PP +Set this property's value with setDisplay() and get this property's value with display(). +.SH "QTime maxValue" +This property holds the maximum time value. +.PP +Setting the maximum time value is equivalent to calling QTimeEdit::setRange( minValue(), \fIt\fR ), where \fIt\fR is the maximum time. The default maximum time is 23:59:59. +.PP +See also minValue and setRange(). +.PP +Set this property's value with setMaxValue() and get this property's value with maxValue(). +.SH "QTime minValue" +This property holds the minimum time value. +.PP +Setting the minimum time value is equivalent to calling QTimeEdit::setRange( \fIt\fR, maxValue() ), where \fIt\fR is the minimum time. The default minimum time is 00:00:00. +.PP +See also maxValue and setRange(). +.PP +Set this property's value with setMinValue() and get this property's value with minValue(). +.SH "QTime time" +This property holds the editor's time value. +.PP +When changing the time property, if the time is less than minValue(), or is greater than maxValue(), nothing happens. +.PP +Set this property's value with setTime() and get this property's value with time(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtimeedit.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtimeedit.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtimer.3qt b/doc/man/man3/tqtimer.3qt new file mode 100644 index 000000000..0911e0900 --- /dev/null +++ b/doc/man/man3/tqtimer.3qt @@ -0,0 +1,196 @@ +'\" t +.TH QTimer 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 +QTimer \- Timer signals and single-shot timers +.SH SYNOPSIS +\fC#include <ntqtimer.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTimer\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QTimer\fR ()" +.br +.ti -1c +.BI "bool \fBisActive\fR () const" +.br +.ti -1c +.BI "int \fBstart\fR ( int msec, bool sshot = FALSE )" +.br +.ti -1c +.BI "void \fBchangeInterval\fR ( int msec )" +.br +.ti -1c +.BI "void \fBstop\fR ()" +.br +.ti -1c +.BI "int \fBtimerId\fR () const" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBtimeout\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBsingleShot\fR ( int msec, QObject * receiver, const char * member )" +.br +.in -1c +.SH DESCRIPTION +The QTimer class provides timer signals and single-shot timers. +.PP +It uses timer events internally to provide a more versatile timer. QTimer is very easy to use: create a QTimer, call start() to start it and connect its timeout() to the appropriate slots. When the time is up it will emit the timeout() signal. +.PP +Note that a QTimer object is destroyed automatically when its parent object is destroyed. +.PP +Example: +.PP +.nf +.br + QTimer *timer = new QTimer( myObject ); +.br + connect( timer, SIGNAL(timeout()), myObject, SLOT(timerDone()) ); +.br + timer->start( 2000, TRUE ); // 2 seconds single-shot timer +.br +.fi +.PP +You can also use the static singleShot() function to create a single shot timer. +.PP +As a special case, a QTimer with timeout 0 times out as soon as all the events in the window system's event queue have been processed. +.PP +This can be used to do heavy work while providing a snappy user interface: +.PP +.nf +.br + QTimer *t = new QTimer( myObject ); +.br + connect( t, SIGNAL(timeout()), SLOT(processOneThing()) ); +.br + t->start( 0, FALSE ); +.br +.fi +.PP +myObject->processOneThing() will be called repeatedly and should return quickly (typically after processing one data item) so that Qt can deliver events to widgets and stop the timer as soon as it has done all its work. This is the traditional way of implementing heavy work in GUI applications; multi-threading is now becoming available on more and more platforms, and we expect that null events will eventually be replaced by threading. +.PP +Note that QTimer's accuracy depends on the underlying operating system and hardware. Most platforms support an accuracy of 20ms; some provide more. If Qt is unable to deliver the requested number of timer clicks, it will silently discard some. +.PP +An alternative to using QTimer is to call QObject::startTimer() for your object and reimplement the QObject::timerEvent() event handler in your class (which must, of course, inherit QObject). The disadvantage is that timerEvent() does not support such high-level features as single-shot timers or signals. +.PP +Some operating systems limit the number of timers that may be used; Qt tries to work around these limitations. +.PP +See also Event Classes and Time and Date. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTimer::QTimer ( QObject * parent = 0, const char * name = 0 )" +Constructs a timer called \fIname\fR, with the parent \fIparent\fR. +.PP +Note that the parent object's destructor will destroy this timer object. +.SH "QTimer::~QTimer ()" +Destroys the timer. +.SH "void QTimer::changeInterval ( int msec )" +Changes the timeout interval to \fImsec\fR milliseconds. +.PP +If the timer signal is pending, it will be stopped and restarted; otherwise it will be started. +.PP +See also start() and isActive(). +.SH "bool QTimer::isActive () const" +Returns TRUE if the timer is running (pending); otherwise returns FALSE. +.PP +Example: t11/cannon.cpp. +.SH "void QTimer::singleShot ( int msec, QObject * receiver, const char * member )\fC [static]\fR" +This static function calls a slot after a given time interval. +.PP +It is very convenient to use this function because you do not need to bother with a timerEvent or to create a local QTimer object. +.PP +Example: +.PP +.nf +.br + #include <ntqapplication.h> +.br + #include <ntqtimer.h> +.br +.br + int main( int argc, char **argv ) +.br + { +.br + QApplication a( argc, argv ); +.br + QTimer::singleShot( 10*60*1000, &a, SLOT(quit()) ); +.br + ... // create and show your widgets +.br + return a.exec(); +.br + } +.br +.fi +.PP +This sample program automatically terminates after 10 minutes (i.e. 600000 milliseconds). +.PP +The \fIreceiver\fR is the receiving object and the \fImember\fR is the slot. The time interval is \fImsec\fR. +.SH "int QTimer::start ( int msec, bool sshot = FALSE )" +Starts the timer with a \fImsec\fR milliseconds timeout, and returns the ID of the timer, or zero when starting the timer failed. +.PP +If \fIsshot\fR is TRUE, the timer will be activated only once; otherwise it will continue until it is stopped. +.PP +Any pending timer will be stopped. +.PP +See also singleShot(), stop(), changeInterval(), and isActive(). +.PP +Examples: +.)l aclock/aclock.cpp, dirview/dirview.cpp, distributor/distributor.ui.h, forever/forever.cpp, hello/hello.cpp, t11/cannon.cpp, and t13/cannon.cpp. +.SH "void QTimer::stop ()" +Stops the timer. +.PP +See also start(). +.PP +Examples: +.)l dirview/dirview.cpp, t11/cannon.cpp, t12/cannon.cpp, and t13/cannon.cpp. +.SH "void QTimer::timeout ()\fC [signal]\fR" +This signal is emitted when the timer is activated. +.PP +Examples: +.)l aclock/aclock.cpp, dirview/dirview.cpp, distributor/distributor.ui.h, forever/forever.cpp, hello/hello.cpp, and t11/cannon.cpp. +.SH "int QTimer::timerId () const" +Returns the ID of the timer if the timer is running; otherwise returns +-1. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtimer.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtimer.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtimerevent.3qt b/doc/man/man3/tqtimerevent.3qt new file mode 100644 index 000000000..1601a3796 --- /dev/null +++ b/doc/man/man3/tqtimerevent.3qt @@ -0,0 +1,66 @@ +'\" t +.TH QTimerEvent 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 +QTimerEvent \- Parameters that describe a timer event +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTimerEvent\fR ( int timerId )" +.br +.ti -1c +.BI "int \fBtimerId\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QTimerEvent class contains parameters that describe a timer event. +.PP +Timer events are sent at regular intervals to objects that have started one or more timers. Each timer has a unique identifier. A timer is started with QObject::startTimer(). +.PP +The QTimer class provides a high-level programming interface that uses signals instead of events. It also provides one-shot timers. +.PP +The event handler QObject::timerEvent() receives timer events. +.PP +See also QTimer, QObject::timerEvent(), QObject::startTimer(), QObject::killTimer(), QObject::killTimers(), and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTimerEvent::QTimerEvent ( int timerId )" +Constructs a timer event object with the timer identifier set to \fItimerId\fR. +.SH "int QTimerEvent::timerId () const" +Returns the unique timer identifier, which is the same identifier as returned from QObject::startTimer(). +.PP +Example: dclock/dclock.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtimerevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtimerevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtoolbar.3qt b/doc/man/man3/tqtoolbar.3qt new file mode 100644 index 000000000..82e378a05 --- /dev/null +++ b/doc/man/man3/tqtoolbar.3qt @@ -0,0 +1,163 @@ +'\" t +.TH QToolBar 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 +QToolBar \- Movable panel containing widgets such as tool buttons +.SH SYNOPSIS +\fC#include <ntqtoolbar.h>\fR +.PP +Inherits QDockWindow. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "QToolBar ( const QString & label, QMainWindow *, ToolBarDock = DockTop, bool newLine = FALSE, const char * name = 0 ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "\fBQToolBar\fR ( const QString & label, QMainWindow * mainWindow, QWidget * parent, bool newLine = FALSE, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fBQToolBar\fR ( QMainWindow * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "void \fBaddSeparator\fR ()" +.br +.ti -1c +.BI "QMainWindow * \fBmainWindow\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetStretchableWidget\fR ( QWidget * w )" +.br +.ti -1c +.BI "virtual void \fBsetLabel\fR ( const QString & )" +.br +.ti -1c +.BI "QString \fBlabel\fR () const" +.br +.ti -1c +.BI "virtual void \fBclear\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QString \fBlabel\fR - the toolbar's label" +.br +.in -1c +.SH DESCRIPTION +The QToolBar class provides a movable panel containing widgets such as tool buttons. +.PP +A toolbar is a panel that contains a set of controls, usually represented by small icons. It's purpose is to provide quick access to frequently used commands or options. Within a QMainWindow the user can drag toolbars within and between the dock areas. Toolbars can also be dragged out of any dock area to float freely as top-level windows. +.PP +QToolBar is a specialization of QDockWindow, and so provides all the functionality of a QDockWindow. +.PP +To use QToolBar you simply create a QToolBar as a child of a QMainWindow, create a number of QToolButton widgets (or other widgets) in left to right (or top to bottom) order and call addSeparator() when you want a separator. When a toolbar is floated the caption used is the label given in the constructor call. This can be changed with setLabel(). +.PP +.nf +.br + QToolBar * fileTools = new QToolBar( this, "file operations" ); +.br + fileTools->setLabel( "File Operations" ); +.br + fileOpenAction->addTo( fileTools ); +.br + fileSaveAction->addTo( fileTools ); +.fi +.PP +This extract from the application/application.cpp example shows the creation of a new toolbar as a child of a QMainWindow and adding two QActions. +.PP +You may use most widgets within a toolbar, with QToolButton and QComboBox being the most common. +.PP +If you create a new widget on an already visible QToolBar, this widget will automatically become visible without needing a show() call. (This differs from every other Qt widget container. We recommend calling show() anyway since we hope to fix this anomaly in a future release.) +.PP +QToolBars, like QDockWindows, are located in QDockAreas or float as top-level windows. QMainWindow provides four QDockAreas (top, left, right and bottom). When you create a new toolbar (as in the example above) as a child of a QMainWindow the toolbar will be added to the top dock area. You can move it to another dock area (or float it) by calling QMainWindow::moveDockWindow(). QDock areas lay out their windows in Lines. +.PP +If the main window is resized so that the area occupied by the toolbar is too small to show all its widgets a little arrow button (which looks like a right-pointing chevron, '»') will appear at the right or bottom of the toolbar depending on its orientation. Clicking this button pops up a menu that shows the 'overflowing' items. QToolButtons are represented in the menu using their textLabel property, other QButton subclasses are represented using their text property, and QComboBoxes are represented as submenus, with the caption text being used in the submenu item. +.PP +Usually a toolbar will get precisely the space it needs. However, with setHorizontalStretchable(), setVerticalStretchable() or setStretchableWidget() you can tell the main window to expand the toolbar to fill all available space in the specified orientation. +.PP +The toolbar arranges its buttons either horizontally or vertically (see orientation() for details). Generally, QDockArea will set the orientation correctly for you, but you can set it yourself with setOrientation() and track any changes by connecting to the orientationChanged() signal. +.PP +You can use the clear() method to remove all items from a toolbar. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> <blockquote><p align="center">\fI A floating QToolbar (dock window) \fR</p> </blockquote> +.PP +See also QToolButton, QMainWindow, Parts of Isys on Visual Design, GUI Design Handbook: Tool Bar, and Main Window and Related Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QToolBar::QToolBar ( const QString & label, QMainWindow *, ToolBarDock = DockTop, bool newLine = FALSE, const char * name = 0 )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QToolBar::QToolBar ( const QString & label, QMainWindow * mainWindow, QWidget * parent, bool newLine = FALSE, const char * name = 0, WFlags f = 0 )" +Constructs an empty horizontal toolbar. +.PP +The toolbar is called \fIname\fR and is a child of \fIparent\fR and is managed by \fImainWindow\fR. The \fIlabel\fR and \fInewLine\fR parameters are passed straight to QMainWindow::addDockWindow(). \fIname\fR and the widget flags \fIf\fR are passed on to the QDockWindow constructor. +.PP +Use this constructor if you want to create torn-off (undocked, floating) toolbars or toolbars in the status bar. +.SH "QToolBar::QToolBar ( QMainWindow * parent = 0, const char * name = 0 )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs an empty toolbar called \fIname\fR, with parent \fIparent\fR, in its \fIparent\fR's top dock area, without any label and without requiring a newline. +.SH "void QToolBar::addSeparator ()" +Adds a separator to the right/bottom of the toolbar. +.PP +Examples: +.)l chart/chartform.cpp, fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, qfd/fontdisplayer.cpp, and scribble/scribble.cpp. +.SH "void QToolBar::clear ()\fC [virtual]\fR" +Deletes all the toolbar's child widgets. +.SH "QString QToolBar::label () const" +Returns the toolbar's label. See the "label" property for details. +.SH "QMainWindow * QToolBar::mainWindow () const" +Returns a pointer to the QMainWindow which manages this toolbar. +.SH "void QToolBar::setLabel ( const QString & )\fC [virtual]\fR" +Sets the toolbar's label. See the "label" property for details. +.SH "void QToolBar::setStretchableWidget ( QWidget * w )\fC [virtual]\fR" +Sets the widget \fIw\fR to be expanded if this toolbar is requested to stretch. +.PP +The request to stretch might occur because QMainWindow right-justifies the dock area the toolbar is in, or because this toolbar's isVerticalStretchable() or isHorizontalStretchable() is set to TRUE. +.PP +If you call this function and the toolbar is not yet stretchable, setStretchable() is called. +.PP +See also QMainWindow::rightJustification, setVerticalStretchable(), and setHorizontalStretchable(). +.PP +Examples: +.)l fileiconview/mainwindow.cpp and helpviewer/helpwindow.cpp. +.SS "Property Documentation" +.SH "QString label" +This property holds the toolbar's label. +.PP +If the toolbar is floated the label becomes the toolbar window's caption. There is no default label text. +.PP +Set this property's value with setLabel() and get this property's value with label(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtoolbar.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtoolbar.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtoolbox.3qt b/doc/man/man3/tqtoolbox.3qt new file mode 100644 index 000000000..6c19c9e63 --- /dev/null +++ b/doc/man/man3/tqtoolbox.3qt @@ -0,0 +1,211 @@ +'\" t +.TH QToolBox 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 +QToolBox \- Column of tabbed widget items +.SH SYNOPSIS +\fC#include <ntqtoolbox.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQToolBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "int \fBaddItem\fR ( QWidget * w, const QString & label )" +.br +.ti -1c +.BI "int \fBaddItem\fR ( QWidget * item, const QIconSet & iconSet, const QString & label )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( int index, QWidget * item, const QString & label )" +.br +.ti -1c +.BI "int \fBinsertItem\fR ( int index, QWidget * item, const QIconSet & iconSet, const QString & label )" +.br +.ti -1c +.BI "int \fBremoveItem\fR ( QWidget * item )" +.br +.ti -1c +.BI "void \fBsetItemEnabled\fR ( int index, bool enabled )" +.br +.ti -1c +.BI "bool \fBisItemEnabled\fR ( int index ) const" +.br +.ti -1c +.BI "void \fBsetItemLabel\fR ( int index, const QString & label )" +.br +.ti -1c +.BI "QString \fBitemLabel\fR ( int index ) const" +.br +.ti -1c +.BI "void \fBsetItemIconSet\fR ( int index, const QIconSet & iconSet )" +.br +.ti -1c +.BI "QIconSet \fBitemIconSet\fR ( int index ) const" +.br +.ti -1c +.BI "void \fBsetItemToolTip\fR ( int index, const QString & toolTip )" +.br +.ti -1c +.BI "QString \fBitemToolTip\fR ( int index ) const" +.br +.ti -1c +.BI "QWidget * \fBcurrentItem\fR () const" +.br +.ti -1c +.BI "void \fBsetCurrentItem\fR ( QWidget * item )" +.br +.ti -1c +.BI "int \fBcurrentIndex\fR () const" +.br +.ti -1c +.BI "QWidget * \fBitem\fR ( int index ) const" +.br +.ti -1c +.BI "int \fBindexOf\fR ( QWidget * item ) const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBsetCurrentIndex\fR ( int index )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBcurrentChanged\fR ( int index )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "int \fBcount\fR - the number of items contained in the toolbox \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBcurrentIndex\fR - the index of the current " "item" ", or -1 if the toolbox is empty" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBitemInserted\fR ( int index )" +.br +.ti -1c +.BI "virtual void \fBitemRemoved\fR ( int index )" +.br +.in -1c +.SH DESCRIPTION +The QToolBox class provides a column of tabbed widget items. +.PP +A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. Every tab has an index position within the column of tabs. A tab's item is a QWidget. +.PP +Each item has an itemLabel(), an optional icon, itemIconSet(), an optional itemToolTip(), and a widget. The item's attributes can be changed with setItemLabel(), setItemIconSet() and setItemToolTip(). +.PP +Items are added using addItem(), or inserted at particular positions using insertItem(). The total number of items is given by count(). Items can be deleted with delete, or removed from the toolbox with removeItem(). Combining removeItem() and insertItem() allows to move items to different positions. +.PP +The current item widget is returned by currentItem() and set with setCurrentItem(). If you prefer you can work in terms of indexes using currentIndex(), setCurrentIndex(), indexOf() and item(). +.PP +The currentChanged() signal is emitted when the current item is changed. +.PP +See also QTabWidget and Advanced Widgets. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QToolBox::QToolBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a toolbox called \fIname\fR with parent \fIparent\fR and flags \fIf\fR. +.SH "int QToolBox::addItem ( QWidget * item, const QIconSet & iconSet, const QString & label )" +Adds the widget \fIitem\fR in a new tab at bottom of the toolbox. The new tab's label is set to \fIlabel\fR, and the \fIiconSet\fR is displayed to the left of the \fIlabel\fR. Returns the new tab's index. +.SH "int QToolBox::addItem ( QWidget * w, const QString & label )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds the widget \fIw\fR in a new tab at bottom of the toolbox. The new tab's label is set to \fIlabel\fR. Returns the new tab's index. +.SH "int QToolBox::count () const" +Returns the number of items contained in the toolbox. See the "count" property for details. +.SH "void QToolBox::currentChanged ( int index )\fC [signal]\fR" +This signal is emitted when the current item changed. The new current item's index is passed in \fIindex\fR, or -1 if there is no current item. +.SH "int QToolBox::currentIndex () const" +Returns the index of the current item, or -1 if the toolbox is empty. See the "currentIndex" property for details. +.SH "QWidget * QToolBox::currentItem () const" +Returns the toolbox's current item, or 0 if the toolbox is empty. +.SH "int QToolBox::indexOf ( QWidget * item ) const" +Returns the index of item \fIitem\fR, or -1 if the item does not exist. +.SH "int QToolBox::insertItem ( int index, QWidget * item, const QIconSet & iconSet, const QString & label )" +Inserts the widget \fIitem\fR at position \fIindex\fR, or at the bottom of the toolbox if \fIindex\fR is out of range. The new item's label is set to \fIlabel\fR, and the \fIiconSet\fR is displayed to the left of the \fIlabel\fR. Returns the new item's index. +.SH "int QToolBox::insertItem ( int index, QWidget * item, const QString & label )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts the widget \fIitem\fR at position \fIindex\fR, or at the bottom of the toolbox if \fIindex\fR is out of range. The new item's label is set to \fIlabel\fR. Returns the new item's index. +.SH "bool QToolBox::isItemEnabled ( int index ) const" +Returns TRUE if the item at position \fIindex\fR is enabled; otherwise returns FALSE. +.SH "QWidget * QToolBox::item ( int index ) const" +Returns the item at position \fIindex\fR, or 0 if there is no such item. +.SH "QIconSet QToolBox::itemIconSet ( int index ) const" +Returns the icon of the item at position \fIindex\fR, or a null icon if \fIindex\fR is out of range. +.SH "void QToolBox::itemInserted ( int index )\fC [virtual protected]\fR" +This virtual handler is called after a new item was added or inserted at position \fIindex\fR. +.SH "QString QToolBox::itemLabel ( int index ) const" +Returns the label of the item at position \fIindex\fR, or a null string if \fIindex\fR is out of range. +.SH "void QToolBox::itemRemoved ( int index )\fC [virtual protected]\fR" +This virtual handler is called after an item was removed from position \fIindex\fR. +.SH "QString QToolBox::itemToolTip ( int index ) const" +Returns the tooltip of the item at position \fIindex\fR, or a null string if \fIindex\fR is out of range. +.SH "int QToolBox::removeItem ( QWidget * item )" +Removes the widget \fIitem\fR from the toolbox. Note that the widget is \fInot\fR deleted. Returns the removed widget's index, or -1 if the widget was not in this tool box. +.SH "void QToolBox::setCurrentIndex ( int index )\fC [slot]\fR" +Sets the index of the current item, or -1 if the toolbox is empty to \fIindex\fR. See the "currentIndex" property for details. +.SH "void QToolBox::setCurrentItem ( QWidget * item )" +Sets the current item to be \fIitem\fR. +.SH "void QToolBox::setItemEnabled ( int index, bool enabled )" +If \fIenabled\fR is TRUE then the item at position \fIindex\fR is enabled; otherwise item \fIindex\fR is disabled. +.SH "void QToolBox::setItemIconSet ( int index, const QIconSet & iconSet )" +Sets the icon of the item at position \fIindex\fR to \fIiconSet\fR. +.SH "void QToolBox::setItemLabel ( int index, const QString & label )" +Sets the label of the item at position \fIindex\fR to \fIlabel\fR. +.SH "void QToolBox::setItemToolTip ( int index, const QString & toolTip )" +Sets the tooltip of the item at position \fIindex\fR to \fItoolTip\fR. +.SS "Property Documentation" +.SH "int count" +This property holds the number of items contained in the toolbox. +.PP +Get this property's value with count(). +.SH "int currentIndex" +This property holds the index of the current item, or -1 if the toolbox is empty. +.PP +Set this property's value with setCurrentIndex() and get this property's value with currentIndex(). +.PP +See also currentItem(), indexOf(), and item(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtoolbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtoolbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtoolbutton.3qt b/doc/man/man3/tqtoolbutton.3qt new file mode 100644 index 000000000..69285e03c --- /dev/null +++ b/doc/man/man3/tqtoolbutton.3qt @@ -0,0 +1,419 @@ +'\" t +.TH QToolButton 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 +QToolButton \- Quick-access button to commands or options, usually used inside a QToolBar +.SH SYNOPSIS +\fC#include <ntqtoolbutton.h>\fR +.PP +Inherits QButton. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBTextPosition\fR { BesideIcon, BelowIcon, Right = BesideIcon, Under = BelowIcon }" +.br +.ti -1c +.BI "\fBQToolButton\fR ( QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQToolButton\fR ( const QIconSet & iconSet, const QString & textLabel, const QString & grouptext, QObject * receiver, const char * slot, QToolBar * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQToolButton\fR ( ArrowType type, QWidget * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QToolButton\fR ()" +.br +.ti -1c +.BI "void setOnIconSet ( const QIconSet & ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setOffIconSet ( const QIconSet & ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setIconSet ( const QIconSet & set, bool on ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QIconSet onIconSet () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QIconSet offIconSet () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QIconSet iconSet ( bool on ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void \fBsetIconSet\fR ( const QIconSet & )" +.br +.ti -1c +.BI "QIconSet \fBiconSet\fR () const" +.br +.ti -1c +.BI "bool \fBusesBigPixmap\fR () const" +.br +.ti -1c +.BI "bool \fBusesTextLabel\fR () const" +.br +.ti -1c +.BI "QString \fBtextLabel\fR () const" +.br +.ti -1c +.BI "void \fBsetPopup\fR ( QPopupMenu * popup )" +.br +.ti -1c +.BI "QPopupMenu * \fBpopup\fR () const" +.br +.ti -1c +.BI "void \fBsetPopupDelay\fR ( int delay )" +.br +.ti -1c +.BI "int \fBpopupDelay\fR () const" +.br +.ti -1c +.BI "void \fBopenPopup\fR ()" +.br +.ti -1c +.BI "void \fBsetAutoRaise\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBautoRaise\fR () const" +.br +.ti -1c +.BI "TextPosition \fBtextPosition\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetUsesBigPixmap\fR ( bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetUsesTextLabel\fR ( bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetTextLabel\fR ( const QString & newLabel, bool tipToo )" +.br +.ti -1c +.BI "virtual void \fBsetToggleButton\fR ( bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetOn\fR ( bool enable )" +.br +.ti -1c +.BI "void \fBtoggle\fR ()" +.br +.ti -1c +.BI "void \fBsetTextLabel\fR ( const QString & )" +.br +.ti -1c +.BI "void \fBsetTextPosition\fR ( TextPosition pos )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBautoRaise\fR - whether auto-raising is enabled" +.br +.ti -1c +.BI "BackgroundMode \fBbackgroundMode\fR - the toolbutton's background mode \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QIconSet \fBiconSet\fR - the icon set providing the icon shown on the button" +.br +.ti -1c +.BI "QIconSet offIconSet - the icon set that is used when the button is in an ""off"" state \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBon\fR - whether this tool button is on" +.br +.ti -1c +.BI "QIconSet onIconSet - the icon set that is used when the button is in an ""on"" state \fI(obsolete)\fR" +.br +.ti -1c +.BI "QPixmap \fBpixmap\fR - the pixmap of the button \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBpopupDelay\fR - the time delay between pressing the button and the appearance of the associated popup menu in milliseconds" +.br +.ti -1c +.BI "QString \fBtextLabel\fR - the label of this button" +.br +.ti -1c +.BI "TextPosition \fBtextPosition\fR - the position of the text label of this button" +.br +.ti -1c +.BI "bool \fBtoggleButton\fR - whether this tool button is a toggle button" +.br +.ti -1c +.BI "bool \fBusesBigPixmap\fR - whether this toolbutton uses big pixmaps" +.br +.ti -1c +.BI "bool \fBusesTextLabel\fR - whether the toolbutton displays a text label below the button pixmap" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "bool \fBuses3D\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QToolButton class provides a quick-access button to commands or options, usually used inside a QToolBar. +.PP +A tool button is a special button that provides quick-access to specific commands or options. As opposed to a normal command button, a tool button usually doesn't show a text label, but shows an icon instead. Its classic usage is to select tools, for example the "pen" tool in a drawing program. This would be implemented with a QToolButton as toggle button (see setToggleButton() ). +.PP +QToolButton supports auto-raising. In auto-raise mode, the button draws a 3D frame only when the mouse points at it. The feature is automatically turned on when a button is used inside a QToolBar. Change it with setAutoRaise(). +.PP +A tool button's icon is set as QIconSet. This makes it possible to specify different pixmaps for the disabled and active state. The disabled pixmap is used when the button's functionality is not available. The active pixmap is displayed when the button is auto-raised because the mouse pointer is hovering over it. +.PP +The button's look and dimension is adjustable with setUsesBigPixmap() and setUsesTextLabel(). When used inside a QToolBar in a QMainWindow, the button automatically adjusts to QMainWindow's settings (see QMainWindow::setUsesTextLabel() and QMainWindow::setUsesBigPixmaps()). The pixmap set on a QToolButton will be set to 22x22 if it is bigger than this size. If usesBigPixmap() is TRUE, then the pixmap will be set to 32x32. +.PP +A tool button can offer additional choices in a popup menu. The feature is sometimes used with the "Back" button in a web browser. After pressing and holding the button down for a while, a menu pops up showing a list of possible pages to jump to. With QToolButton you can set a popup menu using setPopup(). The default delay is 600ms; you can adjust it with setPopupDelay(). +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> QToolbar with QToolbuttons +.PP +See also QPushButton, QToolBar, QMainWindow, GUI Design Handbook: Push Button, and Basic Widgets. +.SS "Member Type Documentation" +.SH "QToolButton::TextPosition" +The position of the tool button's textLabel in relation to the tool button's icon. +.TP +\fCQToolButton::BesideIcon\fR - The text appears beside the icon. +.TP +\fCQToolButton::BelowIcon\fR - The text appears below the icon. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QToolButton::QToolButton ( QWidget * parent, const char * name = 0 )" +Constructs an empty tool button called \fIname\fR, with parent \fIparent\fR. +.SH "QToolButton::QToolButton ( const QIconSet & iconSet, const QString & textLabel, const QString & grouptext, QObject * receiver, const char * slot, QToolBar * parent, const char * name = 0 )" +Constructs a tool button called \fIname\fR, that is a child of \fIparent\fR (which must be a QToolBar). +.PP +The tool button will display \fIiconSet\fR, with its text label and tool tip set to \fItextLabel\fR and its status bar message set to \fIgrouptext\fR. It will be connected to the \fIslot\fR in object \fIreceiver\fR. +.SH "QToolButton::QToolButton ( ArrowType type, QWidget * parent, const char * name = 0 )" +Constructs a tool button as an arrow button. The ArrowType \fItype\fR defines the arrow direction. Possible values are LeftArrow, RightArrow, UpArrow and DownArrow. +.PP +An arrow button has auto-repeat turned on by default. +.PP +The \fIparent\fR and \fIname\fR arguments are sent to the QWidget constructor. +.SH "QToolButton::~QToolButton ()" +Destroys the object and frees any allocated resources. +.SH "bool QToolButton::autoRaise () const" +Returns TRUE if auto-raising is enabled; otherwise returns FALSE. See the "autoRaise" property for details. +.SH "QIconSet QToolButton::iconSet () const" +Returns the icon set providing the icon shown on the button. See the "iconSet" property for details. +.SH "QIconSet QToolButton::iconSet ( bool on ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Since Qt 3.0, QIconSet contains both the On and Off icons. +.PP +For ease of porting, this function ignores the \fIon\fR parameter and returns the iconSet property. If you relied on the \fIon\fR parameter, you probably want to update your code to use the QIconSet On/Off mechanism. +.SH "QIconSet QToolButton::offIconSet () const" +Returns the icon set that is used when the button is in an "off" state. See the "offIconSet" property for details. +.SH "QIconSet QToolButton::onIconSet () const" +Returns the icon set that is used when the button is in an "on" state. See the "onIconSet" property for details. +.SH "void QToolButton::openPopup ()" +Opens (pops up) the associated popup menu. If there is no such menu, this function does nothing. This function does not return until the popup menu has been closed by the user. +.SH "QPopupMenu * QToolButton::popup () const" +Returns the associated popup menu, or 0 if no popup menu has been defined. +.PP +See also setPopup(). +.SH "int QToolButton::popupDelay () const" +Returns the time delay between pressing the button and the appearance of the associated popup menu in milliseconds. See the "popupDelay" property for details. +.SH "void QToolButton::setAutoRaise ( bool enable )" +Sets whether auto-raising is enabled to \fIenable\fR. See the "autoRaise" property for details. +.SH "void QToolButton::setIconSet ( const QIconSet & )\fC [virtual]\fR" +Sets the icon set providing the icon shown on the button. See the "iconSet" property for details. +.SH "void QToolButton::setIconSet ( const QIconSet & set, bool on )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Since Qt 3.0, QIconSet contains both the On and Off icons. +.PP +For ease of porting, this function ignores the \fIon\fR parameter and sets the iconSet property. If you relied on the \fIon\fR parameter, you probably want to update your code to use the QIconSet On/Off mechanism. +.PP +See also iconSet and QIconSet::State. +.SH "void QToolButton::setOffIconSet ( const QIconSet & )" +Sets the icon set that is used when the button is in an "off" state. See the "offIconSet" property for details. +.SH "void QToolButton::setOn ( bool enable )\fC [virtual slot]\fR" +Sets whether this tool button is on to \fIenable\fR. See the "on" property for details. +.SH "void QToolButton::setOnIconSet ( const QIconSet & )" +Sets the icon set that is used when the button is in an "on" state. See the "onIconSet" property for details. +.SH "void QToolButton::setPopup ( QPopupMenu * popup )" +Associates the popup menu \fIpopup\fR with this tool button. +.PP +The popup will be shown each time the tool button has been pressed down for a certain amount of time. A typical application example is the "back" button in some web browsers's tool bars. If the user clicks it, the browser simply browses back to the previous page. If the user presses and holds the button down for a while, the tool button shows a menu containing the current history list. +.PP +Ownership of the popup menu is not transferred to the tool button. +.PP +See also popup(). +.SH "void QToolButton::setPopupDelay ( int delay )" +Sets the time delay between pressing the button and the appearance of the associated popup menu in milliseconds to \fIdelay\fR. See the "popupDelay" property for details. +.SH "void QToolButton::setTextLabel ( const QString & )\fC [slot]\fR" +Sets the label of this button. See the "textLabel" property for details. +.SH "void QToolButton::setTextLabel ( const QString & newLabel, bool tipToo )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the label of this button to \fInewLabel\fR and automatically sets it as a tool tip if \fItipToo\fR is TRUE. +.SH "void QToolButton::setTextPosition ( TextPosition pos )\fC [slot]\fR" +Sets the position of the text label of this button to \fIpos\fR. See the "textPosition" property for details. +.SH "void QToolButton::setToggleButton ( bool enable )\fC [virtual slot]\fR" +Sets whether this tool button is a toggle button to \fIenable\fR. See the "toggleButton" property for details. +.SH "void QToolButton::setUsesBigPixmap ( bool enable )\fC [virtual slot]\fR" +Sets whether this toolbutton uses big pixmaps to \fIenable\fR. See the "usesBigPixmap" property for details. +.SH "void QToolButton::setUsesTextLabel ( bool enable )\fC [virtual slot]\fR" +Sets whether the toolbutton displays a text label below the button pixmap to \fIenable\fR. See the "usesTextLabel" property for details. +.SH "QString QToolButton::textLabel () const" +Returns the label of this button. See the "textLabel" property for details. +.SH "TextPosition QToolButton::textPosition () const" +Returns the position of the text label of this button. See the "textPosition" property for details. +.SH "void QToolButton::toggle ()\fC [slot]\fR" +Toggles the state of this tool button. +.PP +This function has no effect on non-toggling buttons. +.PP +See also toggleButton and toggled(). +.SH "bool QToolButton::uses3D () const\fC [protected]\fR" +Returns TRUE if this button should be drawn using raised edges; otherwise returns FALSE. +.PP +See also drawButton(). +.SH "bool QToolButton::usesBigPixmap () const" +Returns TRUE if this toolbutton uses big pixmaps; otherwise returns FALSE. See the "usesBigPixmap" property for details. +.SH "bool QToolButton::usesTextLabel () const" +Returns TRUE if the toolbutton displays a text label below the button pixmap; otherwise returns FALSE. See the "usesTextLabel" property for details. +.SS "Property Documentation" +.SH "bool autoRaise" +This property holds whether auto-raising is enabled. +.PP +The default is disabled (i.e. FALSE). +.PP +Set this property's value with setAutoRaise() and get this property's value with autoRaise(). +.SH "BackgroundMode backgroundMode" +This property holds the toolbutton's background mode. +.PP +Get this property with backgroundMode(). +.PP +See also QWidget::backgroundMode. +.SH "QIconSet iconSet" +This property holds the icon set providing the icon shown on the button. +.PP +Setting this property sets QToolButton::pixmap to a null pixmap. There is no default iconset. +.PP +See also pixmap, toggleButton, and on. +.PP +Set this property's value with setIconSet() and get this property's value with iconSet(). +.SH "QIconSet offIconSet" +This property holds the icon set that is used when the button is in an "off" state. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Since Qt 3.0, QIconSet contains both the On and Off icons. There is now an QToolButton::iconSet property that replaces both QToolButton::onIconSet and QToolButton::offIconSet. +.PP +For ease of porting, this property is a synonym for QToolButton::iconSet. You probably want to go over your application code and use the QIconSet On/Off mechanism. +.PP +See also iconSet and QIconSet::State. +.PP +Set this property's value with setOffIconSet() and get this property's value with offIconSet(). +.SH "bool on" +This property holds whether this tool button is on. +.PP +This property has no effect on non-toggling buttons. The default is FALSE (i.e. off). +.PP +See also toggleButton and toggle(). +.PP +Set this property's value with setOn(). +.SH "QIconSet onIconSet" +This property holds the icon set that is used when the button is in an "on" state. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Since Qt 3.0, QIconSet contains both the On and Off icons. There is now an QToolButton::iconSet property that replaces both QToolButton::onIconSet and QToolButton::offIconSet. +.PP +For ease of porting, this property is a synonym for QToolButton::iconSet. You probably want to go over your application code and use the QIconSet On/Off mechanism. +.PP +See also iconSet and QIconSet::State. +.PP +Set this property's value with setOnIconSet() and get this property's value with onIconSet(). +.SH "QPixmap pixmap" +This property holds the pixmap of the button. +.PP +The pixmap property has no meaning for tool buttons. Use the iconSet property instead. +.SH "int popupDelay" +This property holds the time delay between pressing the button and the appearance of the associated popup menu in milliseconds. +.PP +Usually this is around half a second. A value of 0 draws the down arrow button to the side of the button which can be used to open up the popup menu. +.PP +See also setPopup(). +.PP +Set this property's value with setPopupDelay() and get this property's value with popupDelay(). +.SH "QString textLabel" +This property holds the label of this button. +.PP +Setting this property automatically sets the text as a tool tip too. There is no default text. +.PP +Set this property's value with setTextLabel() and get this property's value with textLabel(). +.SH "TextPosition textPosition" +This property holds the position of the text label of this button. +.PP +Set this property's value with setTextPosition() and get this property's value with textPosition(). +.SH "bool toggleButton" +This property holds whether this tool button is a toggle button. +.PP +Toggle buttons have an on/off state similar to check boxes. A tool button is not a toggle button by default. +.PP +See also on and toggle(). +.PP +Set this property's value with setToggleButton(). +.SH "bool usesBigPixmap" +This property holds whether this toolbutton uses big pixmaps. +.PP +QToolButton automatically connects this property to the relevant signal in the QMainWindow in which it resides. We strongly recommend that you use QMainWindow::setUsesBigPixmaps() instead. +.PP +This property's default is TRUE. +.PP +\fBWarning:\fR If you set some buttons (in a QMainWindow) to have big pixmaps and others to have small pixmaps, QMainWindow may not get the geometry right. +.PP +Set this property's value with setUsesBigPixmap() and get this property's value with usesBigPixmap(). +.SH "bool usesTextLabel" +This property holds whether the toolbutton displays a text label below the button pixmap. +.PP +The default is FALSE. +.PP +QToolButton automatically connects this slot to the relevant signal in the QMainWindow in which is resides. +.PP +Set this property's value with setUsesTextLabel() and get this property's value with usesTextLabel(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtoolbutton.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtoolbutton.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtooltip.3qt b/doc/man/man3/tqtooltip.3qt new file mode 100644 index 000000000..b133ff261 --- /dev/null +++ b/doc/man/man3/tqtooltip.3qt @@ -0,0 +1,354 @@ +'\" t +.TH QToolTip 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 +QToolTip \- Tool tips (balloon help) for any widget or rectangular part of a widget +.SH SYNOPSIS +\fC#include <ntqtooltip.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQToolTip\fR ( QWidget * widget, QToolTipGroup * group = 0 )" +.br +.ti -1c +.BI "QWidget * \fBparentWidget\fR () const" +.br +.ti -1c +.BI "QToolTipGroup * \fBgroup\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBadd\fR ( QWidget * widget, const QString & text )" +.br +.ti -1c +.BI "void \fBadd\fR ( QWidget * widget, const QString & text, QToolTipGroup * group, const QString & longText )" +.br +.ti -1c +.BI "void \fBremove\fR ( QWidget * widget )" +.br +.ti -1c +.BI "void \fBadd\fR ( QWidget * widget, const QRect & rect, const QString & text )" +.br +.ti -1c +.BI "void \fBadd\fR ( QWidget * widget, const QRect & rect, const QString & text, QToolTipGroup * group, const QString & groupText )" +.br +.ti -1c +.BI "void \fBremove\fR ( QWidget * widget, const QRect & rect )" +.br +.ti -1c +.BI "QString \fBtextFor\fR ( QWidget * widget, const QPoint & pos = QPoint ( ) )" +.br +.ti -1c +.BI "void \fBhide\fR ()" +.br +.ti -1c +.BI "QFont \fBfont\fR ()" +.br +.ti -1c +.BI "void \fBsetFont\fR ( const QFont & font )" +.br +.ti -1c +.BI "QPalette \fBpalette\fR ()" +.br +.ti -1c +.BI "void \fBsetPalette\fR ( const QPalette & palette )" +.br +.ti -1c +.BI "void setEnabled ( bool enable ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool enabled () \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetGloballyEnabled\fR ( bool enable )" +.br +.ti -1c +.BI "bool \fBisGloballyEnabled\fR ()" +.br +.ti -1c +.BI "void \fBsetWakeUpDelay\fR ( int i )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBmaybeTip\fR ( const QPoint & p ) = 0" +.br +.ti -1c +.BI "void \fBtip\fR ( const QRect & rect, const QString & text )" +.br +.ti -1c +.BI "void \fBtip\fR ( const QRect & rect, const QString & text, const QString & groupText )" +.br +.ti -1c +.BI "void \fBtip\fR ( const QRect & rect, const QString & text, const QRect & geometry )" +.br +.ti -1c +.BI "void \fBtip\fR ( const QRect & rect, const QString & text, const QString & groupText, const QRect & geometry )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QToolTip class provides tool tips (balloon help) for any widget or rectangular part of a widget. +.PP +The tip is a short, single line of text reminding the user of the widget's or rectangle's function. It is drawn immediately below the region in a distinctive black-on-yellow combination. +.PP +The tip can be any Rich-Text formatted string. +.PP +QToolTipGroup provides a way for tool tips to display another text elsewhere (most often in a status bar). +.PP +At any point in time, QToolTip is either dormant or active. In dormant mode the tips are not shown and in active mode they are. The mode is global, not particular to any one widget. +.PP +QToolTip switches from dormant to active mode when the user hovers the mouse on a tip-equipped region for a second or so and remains active until the user either clicks a mouse button, presses a key, lets the mouse hover for five seconds or moves the mouse outside \fIall\fR tip-equipped regions for at least a second. +.PP +The QToolTip class can be used in three different ways: <ol type=1> +.IP 1 +Adding a tip to an entire widget. +.IP 2 +Adding a tip to a fixed rectangle within a widget. +.IP 3 +Adding a tip to a dynamic rectangle within a widget. +.PP +To add a tip to a widget, call the \fIstatic\fR function QToolTip::add() with the widget and tip as arguments: +.PP +.nf +.br + QToolTip::add( quitButton, "Leave the application" ); +.br +.fi +.PP +This is the simplest and most common use of QToolTip. The tip will be deleted automatically when \fIquitButton\fR is deleted, but you can remove it yourself, too: +.PP +.nf +.br + QToolTip::remove( quitButton ); +.br +.fi +.PP +You can also display another text (typically in a status bar), courtesy of QToolTipGroup. This example assumes that \fIgrp\fR is a \fCQToolTipGroup *\fR and is already connected to the appropriate status bar: +.PP +.nf +.br + QToolTip::add( quitButton, "Leave the application", grp, +.br + "Leave the application, prompting to save if necessary" ); +.br + QToolTip::add( closeButton, "Close this window", grp, +.br + "Close this window, prompting to save if necessary" ); +.br +.fi +.PP +To add a tip to a fixed rectangle within a widget, call the static function QToolTip::add() with the widget, rectangle and tip as arguments. (See the tooltip/tooltip.cpp example.) Again, you can supply a \fCQToolTipGroup *\fR and another text if you want. +.PP +Both of these are one-liners and cover the majority of cases. The third and most general way to use QToolTip requires you to reimplement a pure virtual function to decide whether to pop up a tool tip. The tooltip/tooltip.cpp example demonstrates this too. This mode can be used to implement tips for text that can move as the user scrolls, for example. +.PP +To use QToolTip like this, you must subclass QToolTip and reimplement maybeTip(). QToolTip calls maybeTip() when a tip should pop up, and maybeTip() decides whether to show a tip. +.PP +Tool tips can be globally disabled using QToolTip::setGloballyEnabled() or disabled in groups with QToolTipGroup::setEnabled(). +.PP +You can retrieve the text of a tooltip for a given position within a widget using textFor(). +.PP +The global tooltip font and palette can be set with the static setFont() and setPalette() functions respectively. +.PP +See also QStatusBar, QWhatsThis, QToolTipGroup, GUI Design Handbook: Tool Tip, and Help System. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QToolTip::QToolTip ( QWidget * widget, QToolTipGroup * group = 0 )" +Constructs a tool tip object. This is only necessary if you need tool tips on regions that can move within the widget (most often because the widget's contents can scroll). +.PP +\fIwidget\fR is the widget you want to add dynamic tool tips to and \fIgroup\fR (optional) is the tool tip group they should belong to. +.PP +\fBWarning:\fR QToolTip is not a subclass of QObject, so the instance of QToolTip is not deleted when \fIwidget\fR is deleted. +.PP +\fBWarning:\fR If you delete the tool tip before you have deleted \fIwidget\fR then you need to make sure you call remove() yourself from \fIwidget\fR in your reimplemented QToolTip destructor. +.PP +.nf +.br + MyToolTip::~MyToolTip() +.br + { +.br + remove( widget ); +.br + } +.br +.fi +.PP +See also maybeTip(). +.SH "void QToolTip::add ( QWidget * widget, const QString & text )\fC [static]\fR" +Adds a tool tip to \fIwidget\fR. \fItext\fR is the text to be shown in the tool tip. +.PP +This is the most common entry point to the QToolTip class; it is suitable for adding tool tips to buttons, checkboxes, comboboxes and so on. +.PP +Examples: +.)l helpsystem/mainwindow.cpp, qdir/qdir.cpp, scribble/scribble.cpp, and tooltip/tooltip.cpp. +.SH "void QToolTip::add ( QWidget * widget, const QString & text, QToolTipGroup * group, const QString & longText )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a tool tip to \fIwidget\fR and to tool tip group \fIgroup\fR. +.PP +\fItext\fR is the text shown in the tool tip and \fIlongText\fR is the text emitted from \fIgroup\fR. +.PP +Normally, \fIlongText\fR is shown in a status bar or similar. +.SH "void QToolTip::add ( QWidget * widget, const QRect & rect, const QString & text )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a tool tip to a fixed rectangle, \fIrect\fR, within \fIwidget\fR. \fItext\fR is the text shown in the tool tip. +.SH "void QToolTip::add ( QWidget * widget, const QRect & rect, const QString & text, QToolTipGroup * group, const QString & groupText )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a tool tip to an entire \fIwidget\fR and to tool tip group \fIgroup\fR. The tooltip will disappear when the mouse leaves the \fIrect\fR. +.PP +\fItext\fR is the text shown in the tool tip and \fIgroupText\fR is the text emitted from \fIgroup\fR. +.PP +Normally, \fIgroupText\fR is shown in a status bar or similar. +.SH "void QToolTip::clear ()\fC [protected]\fR" +Immediately removes all tool tips for this tooltip's parent widget. +.SH "bool QToolTip::enabled ()\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "QFont QToolTip::font ()\fC [static]\fR" +Returns the font common to all tool tips. +.PP +See also setFont(). +.SH "QToolTipGroup * QToolTip::group () const" +Returns the tool tip group this QToolTip is a member of or 0 if it isn't a member of any group. +.PP +The tool tip group is the object responsible for maintaining contact between tool tips and a status bar or something else which can show the longer help text. +.PP +See also parentWidget() and QToolTipGroup. +.SH "void QToolTip::hide ()\fC [static]\fR" +Hides any tip that is currently being shown. +.PP +Normally, there is no need to call this function; QToolTip takes care of showing and hiding the tips as the user moves the mouse. +.SH "bool QToolTip::isGloballyEnabled ()\fC [static]\fR" +Returns whether tool tips are enabled globally. +.PP +See also setGloballyEnabled(). +.SH "void QToolTip::maybeTip ( const QPoint & p )\fC [pure virtual protected]\fR" +This pure virtual function is half of the most versatile interface QToolTip offers. +.PP +It is called when there is a possibility that a tool tip should be shown and must decide whether there is a tool tip for the point \fIp\fR in the widget that this QToolTip object relates to. If so, maybeTip() must call tip() with the rectangle the tip applies to, the tip's text and optionally the QToolTipGroup details and the geometry in screen coordinates. +.PP +\fIp\fR is given in that widget's local coordinates. Most maybeTip() implementations will be of the form: +.PP +.nf +.br + if ( <something> ) { +.br + tip( <something>, <something> ); +.br + } +.br +.fi +.PP +The first argument to tip() (a rectangle) must encompass \fIp\fR, i.e. the tip must apply to the current mouse position; otherwise QToolTip's operation is undefined. +.PP +Note that the tip will disappear once the mouse moves outside the rectangle you give to tip(), and will not reappear if the mouse moves back in: maybeTip() is called again instead. +.PP +See also tip(). +.PP +Examples: +.)l helpsystem/tooltip.cpp and tooltip/tooltip.cpp. +.SH "QPalette QToolTip::palette ()\fC [static]\fR" +Returns the palette common to all tool tips. +.PP +See also setPalette(). +.SH "QWidget * QToolTip::parentWidget () const" +Returns the widget this QToolTip applies to. +.PP +The tool tip is destroyed automatically when the parent widget is destroyed. +.PP +See also group(). +.SH "void QToolTip::remove ( QWidget * widget )\fC [static]\fR" +Removes the tool tip from \fIwidget\fR. +.PP +If there is more than one tool tip on \fIwidget\fR, only the one covering the entire widget is removed. +.SH "void QToolTip::remove ( QWidget * widget, const QRect & rect )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes any tool tip for \fIrect\fR from \fIwidget\fR. +.PP +If there is more than one tool tip on \fIwidget\fR, only the one covering rectangle \fIrect\fR is removed. +.SH "void QToolTip::setEnabled ( bool enable )\fC [static]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QToolTip::setFont ( const QFont & font )\fC [static]\fR" +Sets the font for all tool tips to \fIfont\fR. +.PP +See also font(). +.SH "void QToolTip::setGloballyEnabled ( bool enable )\fC [static]\fR" +If \fIenable\fR is TRUE sets all tool tips to be enabled (shown when needed); if \fIenable\fR is FALSE sets all tool tips to be disabled (never shown). +.PP +By default, tool tips are enabled. Note that this function affects all tool tips in the entire application. +.PP +See also QToolTipGroup::enabled. +.SH "void QToolTip::setPalette ( const QPalette & palette )\fC [static]\fR" +Sets the palette for all tool tips to \fIpalette\fR. +.PP +See also palette(). +.SH "void QToolTip::setWakeUpDelay ( int i )\fC [static]\fR" +Sets the wakeup delay for all tooltips to \fIi\fR milliseconds. +.SH "QString QToolTip::textFor ( QWidget * widget, const QPoint & pos = QPoint ( ) )\fC [static]\fR" +Returns the tool tip text for \fIwidget\fR at position \fIpos\fR, or QString::null if there is no tool tip for the given widget and position. +.SH "void QToolTip::tip ( const QRect & rect, const QString & text )\fC [protected]\fR" +Immediately pops up a tip saying \fItext\fR and removes the tip once the cursor moves out of rectangle \fIrect\fR (which is given in the coordinate system of the widget this QToolTip relates to). +.PP +The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. +.SH "void QToolTip::tip ( const QRect & rect, const QString & text, const QString & groupText )\fC [protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Immediately pops up a tip saying \fItext\fR and removes that tip once the cursor moves out of rectangle \fIrect\fR (which is given in the coordinate system of the widget this QToolTip relates to). \fIgroupText\fR is the text emitted from the group. +.PP +The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. +.SH "void QToolTip::tip ( const QRect & rect, const QString & text, const QRect & geometry )\fC [protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Immediately pops up a tip within the rectangle \fIgeometry\fR, saying \fItext\fR and removes the tip once the cursor moves out of rectangle \fIrect\fR. Both rectangles are given in the coordinate system of the widget this QToolTip relates to. +.PP +The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. +.PP +If the tip does not fit inside \fIgeometry\fR, the tip expands. +.SH "void QToolTip::tip ( const QRect & rect, const QString & text, const QString & groupText, const QRect & geometry )\fC [protected]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Immediately pops up a tip within the rectangle \fIgeometry\fR, saying \fItext\fR and removes the tip once the cursor moves out of rectangle \fIrect\fR. \fIgroupText\fR is the text emitted from the group. Both rectangles are given in the coordinate system of the widget this QToolTip relates to. +.PP +The tip will not reappear if the cursor moves back; your maybeTip() must reinstate it each time. +.PP +If the tip does not fit inside \fIgeometry\fR, the tip expands. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtooltip.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtooltip.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtooltipgroup.3qt b/doc/man/man3/tqtooltipgroup.3qt new file mode 100644 index 000000000..4a6edcb4e --- /dev/null +++ b/doc/man/man3/tqtooltipgroup.3qt @@ -0,0 +1,154 @@ +'\" t +.TH QToolTipGroup 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 +QToolTipGroup \- Collects tool tips into related groups +.SH SYNOPSIS +\fC#include <ntqtooltip.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQToolTipGroup\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QToolTipGroup\fR ()" +.br +.ti -1c +.BI "bool \fBdelay\fR () const" +.br +.ti -1c +.BI "bool \fBenabled\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBsetDelay\fR ( bool )" +.br +.ti -1c +.BI "void \fBsetEnabled\fR ( bool )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBshowTip\fR ( const QString & longText )" +.br +.ti -1c +.BI "void \fBremoveTip\fR ()" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBdelay\fR - whether the display of the group text is delayed" +.br +.ti -1c +.BI "bool \fBenabled\fR - whether tool tips in the group are enabled" +.br +.in -1c +.SH DESCRIPTION +The QToolTipGroup class collects tool tips into related groups. +.PP +Tool tips can display \fItwo\fR texts: one in the tip and (optionally) one that is typically in a status bar. QToolTipGroup provides a way to link tool tips to this status bar. +.PP +QToolTipGroup has practically no API; it is only used as an argument to QToolTip's member functions, for example like this: +.PP +.nf +.br + QToolTipGroup * grp = new QToolTipGroup( this, "tool tip relay" ); +.br + connect( grp, SIGNAL(showTip(const QString&)), +.br + myLabel, SLOT(setText(const QString&)) ); +.br + connect( grp, SIGNAL(removeTip()), +.br + myLabel, SLOT(clear()) ); +.br + QToolTip::add( giraffeButton, "feed giraffe", +.br + grp, "Give the giraffe a meal" ); +.br + QToolTip::add( gorillaButton, "feed gorilla", +.br + grp, "Give the gorilla a meal" ); +.br +.fi +.PP +This example makes the object myLabel (which you must supply) display (one assumes, though you can make myLabel do anything, of course) the strings "Give the giraffe a meal" and "Give the gorilla a meal" while the relevant tool tips are being displayed. +.PP +Deleting a tool tip group removes the tool tips in it. +.PP +See also Help System. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QToolTipGroup::QToolTipGroup ( QObject * parent, const char * name = 0 )" +Constructs a tool tip group called \fIname\fR, with parent \fIparent\fR. +.SH "QToolTipGroup::~QToolTipGroup ()" +Destroys this tool tip group and all tool tips in it. +.SH "bool QToolTipGroup::delay () const" +Returns TRUE if the display of the group text is delayed; otherwise returns FALSE. See the "delay" property for details. +.SH "bool QToolTipGroup::enabled () const" +Returns TRUE if tool tips in the group are enabled; otherwise returns FALSE. See the "enabled" property for details. +.SH "void QToolTipGroup::removeTip ()\fC [signal]\fR" +This signal is emitted when a tool tip in this group is hidden. See the QToolTipGroup documentation for an example of use. +.PP +See also showTip(). +.PP +Example: helpsystem/mainwindow.cpp. +.SH "void QToolTipGroup::setDelay ( bool )\fC [slot]\fR" +Sets whether the display of the group text is delayed. See the "delay" property for details. +.SH "void QToolTipGroup::setEnabled ( bool )\fC [slot]\fR" +Sets whether tool tips in the group are enabled. See the "enabled" property for details. +.SH "void QToolTipGroup::showTip ( const QString & longText )\fC [signal]\fR" +This signal is emitted when one of the tool tips in the group is displayed. \fIlongText\fR is the extra text for the displayed tool tip. +.PP +See also removeTip(). +.PP +Example: helpsystem/mainwindow.cpp. +.SS "Property Documentation" +.SH "bool delay" +This property holds whether the display of the group text is delayed. +.PP +If set to TRUE (the default), the group text is displayed at the same time as the tool tip. Otherwise, the group text is displayed immediately when the cursor enters the widget. +.PP +Set this property's value with setDelay() and get this property's value with delay(). +.SH "bool enabled" +This property holds whether tool tips in the group are enabled. +.PP +This property's default is TRUE. +.PP +Set this property's value with setEnabled() and get this property's value with enabled(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtooltipgroup.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtooltipgroup.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtranslator.3qt b/doc/man/man3/tqtranslator.3qt new file mode 100644 index 000000000..63bd16457 --- /dev/null +++ b/doc/man/man3/tqtranslator.3qt @@ -0,0 +1,297 @@ +'\" t +.TH QTranslator 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 +QTranslator \- +.SH SYNOPSIS +\fC#include <ntqtranslator.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTranslator\fR ( QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QTranslator\fR ()" +.br +.ti -1c +.BI "QString find ( const char * context, const char * sourceText, const char * comment = 0 ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual QTranslatorMessage \fBfindMessage\fR ( const char * context, const char * sourceText, const char * comment = 0 ) const" +.br +.ti -1c +.BI "bool \fBload\fR ( const QString & filename, const QString & directory = QString::null, const QString & search_delimiters = QString::null, const QString & suffix = QString::null )" +.br +.ti -1c +.BI "bool \fBload\fR ( const uchar * data, int len )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "enum \fBSaveMode\fR { Everything, Stripped }" +.br +.ti -1c +.BI "bool \fBsave\fR ( const QString & filename, SaveMode mode = Everything )" +.br +.ti -1c +.BI "void \fBinsert\fR ( const QTranslatorMessage & message )" +.br +.ti -1c +.BI "void insert ( const char * context, const char * sourceText, const QString & translation ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBremove\fR ( const QTranslatorMessage & message )" +.br +.ti -1c +.BI "void remove ( const char * context, const char * sourceText ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBcontains\fR ( const char * context, const char * sourceText, const char * comment = 0 ) const" +.br +.ti -1c +.BI "void \fBsqueeze\fR ( SaveMode mode = Everything )" +.br +.ti -1c +.BI "void \fBunsqueeze\fR ()" +.br +.ti -1c +.BI "QValueList<QTranslatorMessage> \fBmessages\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QTranslator class provides internationalization support for text output. +.PP +An object of this class contains a set of QTranslatorMessage objects, each of which specifies a translation from a source language to a target language. QTranslator provides functions to look up translations, add new ones, remove them, load and save them, etc. +.PP +The most common use of QTranslator is to: load a translator file created with Qt Linguist, install it using QApplication::installTranslator(), and use it via QObject::tr(). For example: +.PP +.nf +.br + int main( int argc, char ** argv ) +.br + { +.br + QApplication app( argc, argv ); +.br +.br + QTranslator translator( 0 ); +.br + translator.load( "french.qm", "." ); +.br + app.installTranslator( &translator ); +.br +.br + MyWidget m; +.br + app.setMainWidget( &m ); +.br + m.show(); +.br +.br + return app.exec(); +.br + } +.br +.fi +Note that the translator must be created \fIbefore\fR the application's main window. +.PP +Most applications will never need to do anything else with this class. The other functions provided by this class are useful for applications that work on translator files. +.PP +We call a translation a "messsage". For this reason, translation files are sometimes referred to as "message files". +.PP +It is possible to lookup a translation using findMessage() (as tr() and QApplication::translate() do) and contains(), to insert a new translation messsage using insert(), and to remove one using remove(). +.PP +Translation tools often need more information than the bare source text and translation, for example, context information to help the translator. But end-user programs that are using translations usually only need lookup. To cater for these different needs, QTranslator can use stripped translator files that use the minimum of memory and which support little more functionality than findMessage(). +.PP +Thus, load() may not load enough information to make anything more than findMessage() work. save() has an argument indicating whether to save just this minimum of information or to save everything. +.PP" +Everything" means that for each translation item the following information is kept: +.TP +The \fItranslated text\fR - the return value from tr(). +.TP +The input key: +.TP +The \fIsource text\fR - usually the argument to tr(). +.TP +The \fIcontext\fR - usually the class name for the tr() caller. +.TP +The \fIcomment\fR - a comment that helps disambiguate different uses of the same text in the same context. +.PP +The minimum for each item is just the information necessary for findMessage() to return the right text. This may include the source, context and comment, but usually it is just a hash value and the translated text. +.PP +For example, the "Cancel" in a dialog might have "Anuluj" when the program runs in Polish (in this case the source text would be" Cancel"). The context would (normally) be the dialog's class name; there would normally be no comment, and the translated text would be "Anuluj". +.PP +But it's not always so simple. The Spanish version of a printer dialog with settings for two-sided printing and binding would probably require both "Activado" and "Activada" as translations for "Enabled". In this case the source text would be "Enabled" in both cases, and the context would be the dialog's class name, but the two items would have disambiguating comments such as" two-sided printing" for one and "binding" for the other. The comment enables the translator to choose the appropriate gender for the Spanish version, and enables Qt to distinguish between translations. +.PP +Note that when QTranslator loads a stripped file, most functions do not work. The functions that do work with stripped files are explicitly documented as such. +.PP +See also QTranslatorMessage, QApplication::installTranslator(), QApplication::removeTranslator(), QObject::tr(), QApplication::translate(), Environment Classes, and Internationalization with Qt. +.SS "Member Type Documentation" +.SH "QTranslator::SaveMode" +This enum type defines how QTranslator writes translation files. There are two modes: +.TP +\fCQTranslator::Everything\fR - files are saved with all available information +.TP +\fCQTranslator::Stripped\fR - files are saved with just enough information for end-user applications +.PP +Note that when QTranslator loads a stripped file, most functions do not work. The functions that do work with stripped files are explicitly documented as such. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTranslator::QTranslator ( QObject * parent = 0, const char * name = 0 )" +Constructs an empty message file object that is not connected to any file. The object is called \fIname\fR with parent \fIparent\fR. +.SH "QTranslator::~QTranslator ()" +Destroys the object and frees any allocated resources. +.SH "void QTranslator::clear ()" +Empties this translator of all contents. +.PP +This function works with stripped translator files. +.SH "bool QTranslator::contains ( const char * context, const char * sourceText, const char * comment = 0 ) const" +Returns TRUE if this message file contains a message with the key (\fIcontext\fR, \fIsourceText\fR, \fIcomment\fR); otherwise returns FALSE. +.PP +This function works with stripped translator files. +.PP +(This is is a one-liner that calls findMessage().) +.SH "QString QTranslator::find ( const char * context, const char * sourceText, const char * comment = 0 ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Please use findMessage() instead. +.PP +Returns the translation for the key (\fIcontext\fR, \fIsourceText\fR, \fIcomment\fR) or QString::null if there is none in this translator. +.SH "QTranslatorMessage QTranslator::findMessage ( const char * context, const char * sourceText, const char * comment = 0 ) const\fC [virtual]\fR" +Returns the QTranslatorMessage for the key (\fIcontext\fR, \fIsourceText\fR, \fIcomment\fR). If none is found, also tries (\fIcontext\fR, \fIsourceText\fR, ""). +.SH "void QTranslator::insert ( const QTranslatorMessage & message )" +Inserts \fImessage\fR into this message file. +.PP +This function does \fInot\fR work with stripped translator files. It may appear to, but that is not dependable. +.PP +See also remove(). +.SH "void QTranslator::insert ( const char * context, const char * sourceText, const QString & translation )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "bool QTranslator::isEmpty () const" +Returns TRUE if this translator is empty, otherwise returns FALSE. This function works with stripped and unstripped translation files. +.SH "bool QTranslator::load ( const QString & filename, const QString & directory = QString::null, const QString & search_delimiters = QString::null, const QString & suffix = QString::null )" +Loads \fIfilename\fR, which may be an absolute file name or relative to \fIdirectory\fR. The previous contents of this translator object is discarded. Returns TRUE if the file is loaded successfully; otherwise returns FALSE. +.PP +If the full file name does not exist, other file names are tried in the following order: +.PP +<ol type=1> +.TP +File name with \fIsuffix\fR appended (".qm" if the \fIsuffix\fR is QString::null). +.TP +File name with text after a character in \fIsearch_delimiters\fR stripped ("_." is the default for \fIsearch_delimiters\fR if it is QString::null). +.TP +File name stripped and \fIsuffix\fR appended. +.TP +File name stripped further, etc. +.PP +For example, an application running in the fr_CA locale (French-speaking Canada) might call load("foo.fr_ca"," /opt/foolib"). load() would then try to open the first existing readable file from this list: +.PP +<ol type=1> +.TP +/opt/foolib/foo.fr_ca +.TP +/opt/foolib/foo.fr_ca.qm +.TP +/opt/foolib/foo.fr +.TP +/opt/foolib/foo.fr.qm +.TP +/opt/foolib/foo +.TP +/opt/foolib/foo.qm +.PP +See also save(). +.PP +Example: i18n/main.cpp. +.SH "bool QTranslator::load ( const uchar * data, int len )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Loads the .qm file data \fIdata\fR of length \fIlen\fR into the translator. Returns TRUE if the data is loaded successfully; otherwise returns FALSE. +.PP +The data is not copied. The caller must be able to guarantee that \fIdata\fR will not be deleted or modified. +.SH "QValueList<QTranslatorMessage> QTranslator::messages () const" +Returns a list of the messages in the translator. This function is rather slow. Because it is seldom called, it's optimized for simplicity and small size, rather than speed. +.PP +If you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<QTranslatorMessage> list = myTranslator.messages(); +.br + QValueList<QTranslatorMessage>::Iterator it = list.begin(); +.br + while ( it != list.end() ) { +.br + process_message( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "void QTranslator::remove ( const QTranslatorMessage & message )" +Removes \fImessage\fR from this translator. +.PP +This function works with stripped translator files. +.PP +See also insert(). +.SH "void QTranslator::remove ( const char * context, const char * sourceText )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Removes the translation associated to the key (\fIcontext\fR, \fIsourceText\fR," ") from this translator. +.SH "bool QTranslator::save ( const QString & filename, SaveMode mode = Everything )" +Saves this message file to \fIfilename\fR, overwriting the previous contents of \fIfilename\fR. If \fImode\fR is Everything (the default), all the information is preserved. If \fImode\fR is Stripped, any information that is not necessary for findMessage() is stripped away. +.PP +See also load(). +.SH "void QTranslator::squeeze ( SaveMode mode = Everything )" +Converts this message file to the compact format used to store message files on disk. +.PP +You should never need to call this directly; save() and other functions call it as necessary. \fImode\fR is for internal use. +.PP +See also save() and unsqueeze(). +.SH "void QTranslator::unsqueeze ()" +Converts this message file into an easily modifiable data structure, less compact than the format used in the files. +.PP +You should never need to call this function; it is called by insert() and friends as necessary. +.PP +See also squeeze(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtranslator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtranslator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtranslatormessage.3qt b/doc/man/man3/tqtranslatormessage.3qt new file mode 100644 index 000000000..3278d9b72 --- /dev/null +++ b/doc/man/man3/tqtranslatormessage.3qt @@ -0,0 +1,185 @@ +'\" t +.TH QTranslatorMessage 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 +QTranslatorMessage \- Translator message and its properties +.SH SYNOPSIS +\fC#include <ntqtranslator.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQTranslatorMessage\fR ()" +.br +.ti -1c +.BI "\fBQTranslatorMessage\fR ( const char * context, const char * sourceText, const char * comment, const QString & translation = QString::null )" +.br +.ti -1c +.BI "\fBQTranslatorMessage\fR ( QDataStream & stream )" +.br +.ti -1c +.BI "\fBQTranslatorMessage\fR ( const QTranslatorMessage & m )" +.br +.ti -1c +.BI "QTranslatorMessage & \fBoperator=\fR ( const QTranslatorMessage & m )" +.br +.ti -1c +.BI "uint \fBhash\fR () const" +.br +.ti -1c +.BI "const char * \fBcontext\fR () const" +.br +.ti -1c +.BI "const char * \fBsourceText\fR () const" +.br +.ti -1c +.BI "const char * \fBcomment\fR () const" +.br +.ti -1c +.BI "void \fBsetTranslation\fR ( const QString & translation )" +.br +.ti -1c +.BI "QString \fBtranslation\fR () const" +.br +.ti -1c +.BI "enum \fBPrefix\fR { NoPrefix, Hash, HashContext, HashContextSourceText, HashContextSourceTextComment }" +.br +.ti -1c +.BI "void \fBwrite\fR ( QDataStream & stream, bool strip = FALSE, Prefix prefix = HashContextSourceTextComment ) const" +.br +.ti -1c +.BI "Prefix \fBcommonPrefix\fR ( const QTranslatorMessage & m ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QTranslatorMessage & m ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QTranslatorMessage & m ) const" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const QTranslatorMessage & m ) const" +.br +.ti -1c +.BI "bool \fBoperator<=\fR ( const QTranslatorMessage & m ) const" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const QTranslatorMessage & m ) const" +.br +.ti -1c +.BI "bool \fBoperator>=\fR ( const QTranslatorMessage & m ) const" +.br +.in -1c +.SH DESCRIPTION +The QTranslatorMessage class contains a translator message and its properties. +.PP +This class is of no interest to most applications. It is useful for translation tools such as Qt Linguist. It is provided simply to make the API complete and regular. +.PP +For a QTranslator object, a lookup key is a triple (\fIcontext\fR, \fIsource text\fR, \fIcomment\fR) that uniquely identifies a message. An extended key is a quadruple (\fIhash\fR, \fIcontext\fR, \fIsource text\fR, \fIcomment\fR), where \fIhash\fR is computed from the source text and the comment. Unless you plan to read and write messages yourself, you need not worry about the hash value. +.PP +QTranslatorMessage stores this triple or quadruple and the relevant translation if there is any. +.PP +See also QTranslator, Environment Classes, and Internationalization with Qt. +.SS "Member Type Documentation" +.SH "QTranslatorMessage::Prefix" +Let (\fIh\fR, \fIc\fR, \fIs\fR, \fIm\fR) be the extended key. The possible prefixes are +.TP +\fCQTranslatorMessage::NoPrefix\fR - no prefix +.TP +\fCQTranslatorMessage::Hash\fR - only (\fIh\fR) +.TP +\fCQTranslatorMessage::HashContext\fR - only (\fIh\fR, \fIc\fR) +.TP +\fCQTranslatorMessage::HashContextSourceText\fR - only (\fIh\fR, \fIc\fR, \fIs\fR) +.TP +\fCQTranslatorMessage::HashContextSourceTextComment\fR - the whole extended key, (\fIh\fR, \fIc\fR, \fIs\fR, \fIm\fR) +.PP +See also write() and commonPrefix(). +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QTranslatorMessage::QTranslatorMessage ()" +Constructs a translator message with the extended key (0, 0, 0, 0) and QString::null as translation. +.SH "QTranslatorMessage::QTranslatorMessage ( const char * context, const char * sourceText, const char * comment, const QString & translation = QString::null )" +Constructs an translator message with the extended key (\fIh\fR, \fIcontext\fR, \fIsourceText\fR, \fIcomment\fR), where \fIh\fR is computed from \fIsourceText\fR and \fIcomment\fR, and possibly with a \fItranslation\fR. +.SH "QTranslatorMessage::QTranslatorMessage ( QDataStream & stream )" +Constructs a translator message read from the \fIstream\fR. The resulting message may have any combination of content. +.PP +See also QTranslator::save(). +.SH "QTranslatorMessage::QTranslatorMessage ( const QTranslatorMessage & m )" +Constructs a copy of translator message \fIm\fR. +.SH "const char * QTranslatorMessage::comment () const" +Returns the comment for this message (e.g. "File|Save"). +.PP +\fBWarning:\fR This may return 0 if the QTranslator object is stripped (compressed). +.SH "Prefix QTranslatorMessage::commonPrefix ( const QTranslatorMessage & m ) const" +Returns the widest lookup prefix that is common to this translator message and to message \fIm\fR. +.PP +For example, if the extended key is for this message is (71," PrintDialog", "Yes", "Print?") and that for \fIm\fR is (71," PrintDialog", "No", "Print?"), this function returns HashContext. +.PP +See also write(). +.SH "const char * QTranslatorMessage::context () const" +Returns the context for this message (e.g. "MyDialog"). +.PP +\fBWarning:\fR This may return 0 if the QTranslator object is stripped (compressed). +.SH "uint QTranslatorMessage::hash () const" +Returns the hash value used internally to represent the lookup key. This value is zero only if this translator message was constructed from a stream containing invalid data. +.PP +The hashing function is unspecified, but it will remain unchanged in future versions of Qt. +.SH "bool QTranslatorMessage::operator!= ( const QTranslatorMessage & m ) const" +Returns TRUE if the extended key of this object is different from that of \fIm\fR; otherwise returns FALSE. +.SH "bool QTranslatorMessage::operator< ( const QTranslatorMessage & m ) const" +Returns TRUE if the extended key of this object is lexicographically before than that of \fIm\fR; otherwise returns FALSE. +.SH "bool QTranslatorMessage::operator<= ( const QTranslatorMessage & m ) const" +Returns TRUE if the extended key of this object is lexicographically before that of \fIm\fR or if they are equal; otherwise returns FALSE. +.SH "QTranslatorMessage & QTranslatorMessage::operator= ( const QTranslatorMessage & m )" +Assigns message \fIm\fR to this translator message and returns a reference to this translator message. +.SH "bool QTranslatorMessage::operator== ( const QTranslatorMessage & m ) const" +Returns TRUE if the extended key of this object is equal to that of \fIm\fR; otherwise returns FALSE. +.SH "bool QTranslatorMessage::operator> ( const QTranslatorMessage & m ) const" +Returns TRUE if the extended key of this object is lexicographically after that of \fIm\fR; otherwise returns FALSE. +.SH "bool QTranslatorMessage::operator>= ( const QTranslatorMessage & m ) const" +Returns TRUE if the extended key of this object is lexicographically after that of \fIm\fR or if they are equal; otherwise returns FALSE. +.SH "void QTranslatorMessage::setTranslation ( const QString & translation )" +Sets the translation of the source text to \fItranslation\fR. +.PP +See also translation(). +.SH "const char * QTranslatorMessage::sourceText () const" +Returns the source text of this message (e.g. "&Save"). +.PP +\fBWarning:\fR This may return 0 if the QTranslator object is stripped (compressed). +.SH "QString QTranslatorMessage::translation () const" +Returns the translation of the source text (e.g., "&Sauvegarder"). +.PP +See also setTranslation(). +.SH "void QTranslatorMessage::write ( QDataStream & stream, bool strip = FALSE, Prefix prefix = HashContextSourceTextComment ) const" +Writes this translator message to the \fIstream\fR. If \fIstrip\fR is FALSE (the default), all the information in the message is written. If \fIstrip\fR is TRUE, only the part of the extended key specified by \fIprefix\fR is written with the translation (HashContextSourceTextComment by default). +.PP +See also commonPrefix(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qtranslatormessage.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtranslatormessage.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqtsciicodec.3qt b/doc/man/man3/tqtsciicodec.3qt new file mode 100644 index 000000000..e33214d1e --- /dev/null +++ b/doc/man/man3/tqtsciicodec.3qt @@ -0,0 +1,62 @@ +'\" t +.TH QTsciiCodec 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 +QTsciiCodec \- Conversion to and from the Tamil TSCII encoding +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqtsciicodec.h>\fR +.PP +Inherits QTextCodec. +.PP +.SH DESCRIPTION +The QTsciiCodec class provides conversion to and from the Tamil TSCII encoding. +.PP +TSCII, formally the Tamil Standard Code Information Interchange specification, is a commonly used charset for Tamils. The official page for the standard is at http://www.tamil.net/tscii/ +.PP +This codec uses the mapping table found at http://www.geocities.com/Athens/5180/tsciiset.html. Tamil uses composed Unicode which might cause some problems if you are using Unicode fonts instead of TSCII fonts. +.PP +Most of the code here was written by Hans Petter Bieker and is included in Qt with the author's permission and the grateful thanks of the Trolltech team. Here is the copyright statement for the code as it was at the point of contribution. Trolltech's subsequent modifications are covered by the usual copyright for Qt. +.PP +Copyright (C) 2000 Hans Petter Bieker. All rights reserved. +.PP +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ol type=1> +.IP 1 +Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +.IP 2 +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +.PP +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.PP +See also Internationalization with Qt. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqtsciicodec.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqtsciicodec.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tquridrag.3qt b/doc/man/man3/tquridrag.3qt new file mode 100644 index 000000000..0ee6db77d --- /dev/null +++ b/doc/man/man3/tquridrag.3qt @@ -0,0 +1,168 @@ +'\" t +.TH QUriDrag 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 +QUriDrag \- Drag object for a list of URI references +.SH SYNOPSIS +\fC#include <ntqdragobject.h>\fR +.PP +Inherits QStoredDrag. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQUriDrag\fR ( QStrList uris, QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQUriDrag\fR ( QWidget * dragSource = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QUriDrag\fR ()" +.br +.ti -1c +.BI "void setFilenames ( const QStringList & fnames ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBsetFileNames\fR ( const QStringList & fnames )" +.br +.ti -1c +.BI "void \fBsetUnicodeUris\fR ( const QStringList & uuris )" +.br +.ti -1c +.BI "virtual void \fBsetUris\fR ( QStrList uris )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QString \fBuriToLocalFile\fR ( const char * uri )" +.br +.ti -1c +.BI "QCString \fBlocalFileToUri\fR ( const QString & filename )" +.br +.ti -1c +.BI "QString \fBuriToUnicodeUri\fR ( const char * uri )" +.br +.ti -1c +.BI "QCString \fBunicodeUriToUri\fR ( const QString & uuri )" +.br +.ti -1c +.BI "bool \fBcanDecode\fR ( const QMimeSource * e )" +.br +.ti -1c +.BI "bool \fBdecode\fR ( const QMimeSource * e, QStrList & l )" +.br +.ti -1c +.BI "bool \fBdecodeToUnicodeUris\fR ( const QMimeSource * e, QStringList & l )" +.br +.ti -1c +.BI "bool \fBdecodeLocalFiles\fR ( const QMimeSource * e, QStringList & l )" +.br +.in -1c +.SH DESCRIPTION +The QUriDrag class provides a drag object for a list of URI references. +.PP +URIs are a useful way to refer to files that may be distributed across multiple machines. A URI will often refer to a file on a machine local to both the drag source and the drop target, so the URI can be equivalent to passing a file name but is more extensible. +.PP +Use URIs in Unicode form so that the user can comfortably edit and view them. For use in HTTP or other protocols, use the correctly escaped ASCII form. +.PP +You can convert a list of file names to file URIs using setFileNames(), or into human-readble form with setUnicodeUris(). +.PP +Static functions are provided to convert between filenames and URIs, e.g. uriToLocalFile() and localFileToUri(), and to and from human-readable form, e.g. uriToUnicodeUri(), unicodeUriToUri(). You can also decode URIs from a mimesource into a list with decodeLocalFiles() and decodeToUnicodeUris(). +.PP +See also Drag And Drop Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QUriDrag::QUriDrag ( QStrList uris, QWidget * dragSource = 0, const char * name = 0 )" +Constructs an object to drag the list of URIs in \fIuris\fR. The \fIdragSource\fR and \fIname\fR arguments are passed on to QStoredDrag. Note that URIs are always in escaped UTF8 encoding. +.SH "QUriDrag::QUriDrag ( QWidget * dragSource = 0, const char * name = 0 )" +Constructs an object to drag. You must call setUris() before you start the drag(). Passes \fIdragSource\fR and \fIname\fR to the QStoredDrag constructor. +.SH "QUriDrag::~QUriDrag ()" +Destroys the object. +.SH "bool QUriDrag::canDecode ( const QMimeSource * e )\fC [static]\fR" +Returns TRUE if decode() would be able to decode \fIe\fR; otherwise returns FALSE. +.SH "bool QUriDrag::decode ( const QMimeSource * e, QStrList & l )\fC [static]\fR" +Decodes URIs from \fIe\fR, placing the result in \fIl\fR (which is first cleared). +.PP +Returns TRUE if \fIe\fR contained a valid list of URIs; otherwise returns FALSE. +.PP +Example: dirview/dirview.cpp. +.SH "bool QUriDrag::decodeLocalFiles ( const QMimeSource * e, QStringList & l )\fC [static]\fR" +Decodes URIs from the mime source event \fIe\fR, converts them to local files if they refer to local files, and places them in \fIl\fR (which is first cleared). +.PP +Returns TRUE if \fIcontained\fR a valid list of URIs; otherwise returns FALSE. The list will be empty if no URIs were local files. +.PP +Example: fileiconview/qfileiconview.cpp. +.SH "bool QUriDrag::decodeToUnicodeUris ( const QMimeSource * e, QStringList & l )\fC [static]\fR" +Decodes URIs from the mime source event \fIe\fR, converts them to Unicode URIs (only useful for displaying to humans), placing them in \fIl\fR (which is first cleared). +.PP +Returns TRUE if \fIcontained\fR a valid list of URIs; otherwise returns FALSE. +.SH "QCString QUriDrag::localFileToUri ( const QString & filename )\fC [static]\fR" +Returns the URI equivalent to the absolute local file \fIfilename\fR. +.PP +See also uriToLocalFile(). +.SH "void QUriDrag::setFileNames ( const QStringList & fnames )" +Sets the URIs to be the local-file URIs equivalent to \fIfnames\fR. +.PP +See also localFileToUri() and setUris(). +.PP +Example: dirview/dirview.cpp. +.SH "void QUriDrag::setFilenames ( const QStringList & fnames )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use setFileNames() instead (notice the N). +.SH "void QUriDrag::setUnicodeUris ( const QStringList & uuris )" +Sets the URIs in \fIuuris\fR to be the Unicode URIs (only useful for displaying to humans). +.PP +See also localFileToUri() and setUris(). +.SH "void QUriDrag::setUris ( QStrList uris )\fC [virtual]\fR" +Changes the list of \fIuris\fR to be dragged. +.PP +Note that URIs are always in escaped UTF8 encoding. +.SH "QCString QUriDrag::unicodeUriToUri ( const QString & uuri )\fC [static]\fR" +Returns the URI equivalent of the Unicode URI given in \fIuuri\fR (only useful for displaying to humans). +.PP +See also uriToLocalFile(). +.SH "QString QUriDrag::uriToLocalFile ( const char * uri )\fC [static]\fR" +Returns the name of a local file equivalent to \fIuri\fR or a null string if \fIuri\fR is not a local file. +.PP +Note that URIs are always in escaped UTF8 encoding. +.PP +See also localFileToUri(). +.PP +Example: dirview/dirview.cpp. +.SH "QString QUriDrag::uriToUnicodeUri ( const char * uri )\fC [static]\fR" +Returns the Unicode URI (only useful for displaying to humans) equivalent of \fIuri\fR. +.PP +Note that URIs are always in escaped UTF8 encoding. +.PP +See also localFileToUri(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/quridrag.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tquridrag.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqurl.3qt b/doc/man/man3/tqurl.3qt new file mode 100644 index 000000000..a7c52ff95 --- /dev/null +++ b/doc/man/man3/tqurl.3qt @@ -0,0 +1,496 @@ +'\" t +.TH QUrl 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 +QUrl \- URL parser and simplifies working with URLs +.SH SYNOPSIS +\fC#include <ntqurl.h>\fR +.PP +Inherited by QUrlOperator. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQUrl\fR ()" +.br +.ti -1c +.BI "\fBQUrl\fR ( const QString & url )" +.br +.ti -1c +.BI "\fBQUrl\fR ( const QUrl & url )" +.br +.ti -1c +.BI "\fBQUrl\fR ( const QUrl & url, const QString & relUrl, bool checkSlash = FALSE )" +.br +.ti -1c +.BI "virtual \fB~QUrl\fR ()" +.br +.ti -1c +.BI "QString \fBprotocol\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetProtocol\fR ( const QString & protocol )" +.br +.ti -1c +.BI "QString \fBuser\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetUser\fR ( const QString & user )" +.br +.ti -1c +.BI "bool \fBhasUser\fR () const" +.br +.ti -1c +.BI "QString \fBpassword\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPassword\fR ( const QString & pass )" +.br +.ti -1c +.BI "bool \fBhasPassword\fR () const" +.br +.ti -1c +.BI "QString \fBhost\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetHost\fR ( const QString & host )" +.br +.ti -1c +.BI "bool \fBhasHost\fR () const" +.br +.ti -1c +.BI "int \fBport\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPort\fR ( int port )" +.br +.ti -1c +.BI "bool \fBhasPort\fR () const" +.br +.ti -1c +.BI "QString \fBpath\fR ( bool correct = TRUE ) const" +.br +.ti -1c +.BI "virtual void \fBsetPath\fR ( const QString & path )" +.br +.ti -1c +.BI "bool \fBhasPath\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetEncodedPathAndQuery\fR ( const QString & pathAndQuery )" +.br +.ti -1c +.BI "QString \fBencodedPathAndQuery\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetQuery\fR ( const QString & txt )" +.br +.ti -1c +.BI "QString \fBquery\fR () const" +.br +.ti -1c +.BI "QString \fBref\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetRef\fR ( const QString & txt )" +.br +.ti -1c +.BI "bool \fBhasRef\fR () const" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "bool \fBisLocalFile\fR () const" +.br +.ti -1c +.BI "virtual void \fBaddPath\fR ( const QString & pa )" +.br +.ti -1c +.BI "virtual void \fBsetFileName\fR ( const QString & name )" +.br +.ti -1c +.BI "QString \fBfileName\fR () const" +.br +.ti -1c +.BI "QString \fBdirPath\fR () const" +.br +.ti -1c +.BI "QUrl & \fBoperator=\fR ( const QUrl & url )" +.br +.ti -1c +.BI "QUrl & \fBoperator=\fR ( const QString & url )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QUrl & url ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QString & url ) const" +.br +.ti -1c +.BI "\fBoperator QString\fR () const" +.br +.ti -1c +.BI "virtual QString \fBtoString\fR ( bool encodedPath = FALSE, bool forcePrependProtocol = TRUE ) const" +.br +.ti -1c +.BI "virtual bool \fBcdUp\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBdecode\fR ( QString & url )" +.br +.ti -1c +.BI "void \fBencode\fR ( QString & url )" +.br +.ti -1c +.BI "bool \fBisRelativeUrl\fR ( const QString & url )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBreset\fR ()" +.br +.ti -1c +.BI "virtual bool \fBparse\fR ( const QString & url )" +.br +.in -1c +.SH DESCRIPTION +The QUrl class provides a URL parser and simplifies working with URLs. +.PP +The QUrl class is provided for simple work with URLs. It can parse, decode, encode, etc. +.PP +QUrl works with the decoded path and encoded query in turn. +.PP +Example: +.PP +\fChttp://www.trolltech.com:80/cgi-bin/test%20me.pl?cmd=Hello%20you\fR +.PP +<center>.nf +.TS +l - l. Function Returns protocol() "http" host() "www.trolltech.com" port() 80 path() "/cgi-bin/testme.pl" fileName() "testme.pl" query() +.TE +.fi +</center> +.PP +Example: +.PP +\fChttp://doc.trolltech.com/ntqdockarea.html#lines\fR +.PP +<center>.nf +.TS +l - l. Function Returns protocol() "http" host() "doc.trolltech.com" fileName() "ntqdockarea.html" ref() +.TE +.fi +</center> +.PP +The individual parts of a URL can be set with setProtocol(), setHost(), setPort(), setPath(), setFileName(), setRef() and setQuery(). A URL could contain, for example, an ftp address which requires a user name and password; these can be set with setUser() and setPassword(). +.PP +Because path is always encoded internally you must not use "%00" in the path, although this is okay (but not recommended) for the query. +.PP +QUrl is normally used like this: +.PP +.nf +.br + QUrl url( "http://www.trolltech.com" ); +.br + // or +.br + QUrl url( "file:/home/myself/Mail", "Inbox" ); +.br +.fi +.PP +You can then access and manipulate the various parts of the URL. +.PP +To make it easy to work with QUrls and QStrings, QUrl implements the necessary cast and assignment operators so you can do following: +.PP +.nf +.br + QUrl url( "http://www.trolltech.com" ); +.br + QString s = url; +.br + // or +.br + QString s( "http://www.trolltech.com" ); +.br + QUrl url( s ); +.br +.fi +.PP +Use the static functions, encode() and decode() to encode or decode a URL in a string. (They operate on the string in-place.) The isRelativeUrl() static function returns TRUE if the given string is a relative URL. +.PP +If you want to use a URL to work on a hierarchical structure (e.g. a local or remote filesystem), you might want to use the subclass QUrlOperator. +.PP +See also QUrlOperator, Input/Output and Networking, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QUrl::QUrl ()" +Constructs an empty URL that is invalid. +.SH "QUrl::QUrl ( const QString & url )" +Constructs a URL by parsing the string \fIurl\fR. +.PP +If you pass a string like "/home/qt", the "file" protocol is assumed. +.SH "QUrl::QUrl ( const QUrl & url )" +Copy constructor. Copies the data of \fIurl\fR. +.SH "QUrl::QUrl ( const QUrl & url, const QString & relUrl, bool checkSlash = FALSE )" +Constructs an URL taking \fIurl\fR as the base (context) and \fIrelUrl\fR as a relative URL to \fIurl\fR. If \fIrelUrl\fR is not relative, \fIrelUrl\fR is taken as the new URL. +.PP +For example, the path of +.PP +.nf +.br + QUrl url( "ftp://ftp.trolltech.com/qt/source", "qt-2.1.0.tar.gz" ); +.br +.fi +will be "/qt/srource/qt-2.1.0.tar.gz". +.PP +On the other hand, +.PP +.nf +.br + QUrl url( "ftp://ftp.trolltech.com/qt/source", "/usr/local" ); +.br +.fi +will result in a new URL, "ftp://ftp.trolltech.com/usr/local", because "/usr/local" isn't relative. +.PP +Similarly, +.PP +.nf +.br + QUrl url( "ftp://ftp.trolltech.com/qt/source", "file:/usr/local" ); +.br +.fi +will result in a new URL, with "/usr/local" as the path and "file" as the protocol. +.PP +Normally it is expected that the path of \fIurl\fR points to a directory, even if the path has no slash at the end. But if you want the constructor to handle the last part of the path as a file name if there is no slash at the end, and to let it be replaced by the file name of \fIrelUrl\fR (if it contains one), set \fIcheckSlash\fR to TRUE. +.SH "QUrl::~QUrl ()\fC [virtual]\fR" +Destructor. +.SH "void QUrl::addPath ( const QString & pa )\fC [virtual]\fR" +Adds the path \fIpa\fR to the path of the URL. +.PP +See also setPath() and hasPath(). +.SH "bool QUrl::cdUp ()\fC [virtual]\fR" +Changes the directory to one directory up. +.PP +See also setPath(). +.SH "void QUrl::decode ( QString & url )\fC [static]\fR" +Decodes the \fIurl\fR in-place into UTF-8. For example +.PP +.nf +.br + QString url = "http%3A//www%20trolltech%20com" +.br + QUrl::decode( url ); +.br + // url is now "http://www.trolltech.com" +.br +.fi +.PP +See also encode(). +.SH "QString QUrl::dirPath () const" +Returns the directory path of the URL. This is the part of the path of the URL without the fileName(). See the documentation of fileName() for a discussion of what is handled as file name and what is handled as directory path. +.PP +See also setPath() and hasPath(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QUrl::encode ( QString & url )\fC [static]\fR" +Encodes the \fIurl\fR in-place into UTF-8. For example +.PP +.nf +.br + QString url = http://www.trolltech.com +.br + QUrl::encode( url ); +.br + // url is now "http%3A//www%20trolltech%20com" +.br +.fi +.PP +See also decode(). +.PP +Example: network/archivesearch/archivedialog.ui.h. +.SH "QString QUrl::encodedPathAndQuery ()" +Returns the encoded path and query. +.PP +See also decode(). +.SH "QString QUrl::fileName () const" +Returns the file name of the URL. If the path of the URL doesn't have a slash at the end, the part between the last slash and the end of the path string is considered to be the file name. If the path has a slash at the end, an empty string is returned here. +.PP +See also setFileName(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "bool QUrl::hasHost () const" +Returns TRUE if the URL contains a hostname; otherwise returns FALSE. +.PP +See also setHost(). +.SH "bool QUrl::hasPassword () const" +Returns TRUE if the URL contains a password; otherwise returns FALSE. +.PP +\fBWarning:\fR Passwords passed in URLs are normally \fIinsecure\fR; this is due to the mechanism, not because of Qt. +.PP +See also setPassword() and setUser(). +.SH "bool QUrl::hasPath () const" +Returns TRUE if the URL contains a path; otherwise returns FALSE. +.PP +See also path() and setPath(). +.SH "bool QUrl::hasPort () const" +Returns TRUE if the URL contains a port; otherwise returns FALSE. +.PP +See also setPort(). +.SH "bool QUrl::hasRef () const" +Returns TRUE if the URL has a reference; otherwise returns FALSE. +.PP +See also setRef(). +.SH "bool QUrl::hasUser () const" +Returns TRUE if the URL contains a username; otherwise returns FALSE. +.PP +See also setUser() and setPassword(). +.SH "QString QUrl::host () const" +Returns the hostname of the URL. +.PP +See also setHost() and hasHost(). +.PP +Example: network/archivesearch/archivedialog.ui.h. +.SH "bool QUrl::isLocalFile () const" +Returns TRUE if the URL is a local file; otherwise returns FALSE. +.PP +Example: qdir/qdir.cpp. +.SH "bool QUrl::isRelativeUrl ( const QString & url )\fC [static]\fR" +Returns TRUE if \fIurl\fR is relative; otherwise returns FALSE. +.SH "bool QUrl::isValid () const" +Returns TRUE if the URL is valid; otherwise returns FALSE. A URL is invalid if it cannot be parsed, for example. +.SH "QUrl::operator QString () const" +Composes a string version of the URL and returns it. +.PP +See also QUrl::toString(). +.SH "QUrl & QUrl::operator= ( const QUrl & url )" +Assigns the data of \fIurl\fR to this class. +.SH "QUrl & QUrl::operator= ( const QString & url )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Parses \fIurl\fR and assigns the resulting data to this class. +.PP +If you pass a string like "/home/qt" the "file" protocol will be assumed. +.SH "bool QUrl::operator== ( const QUrl & url ) const" +Compares this URL with \fIurl\fR and returns TRUE if they are equal; otherwise returns FALSE. +.SH "bool QUrl::operator== ( const QString & url ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Compares this URL with \fIurl\fR. \fIurl\fR is parsed first. Returns TRUE if \fIurl\fR is equal to this url; otherwise returns FALSE. +.SH "bool QUrl::parse ( const QString & url )\fC [virtual protected]\fR" +Parses the \fIurl\fR. +.SH "QString QUrl::password () const" +Returns the password of the URL. +.PP +\fBWarning:\fR Passwords passed in URLs are normally \fIinsecure\fR; this is due to the mechanism, not because of Qt. +.PP +See also setPassword() and setUser(). +.SH "QString QUrl::path ( bool correct = TRUE ) const" +Returns the path of the URL. If \fIcorrect\fR is TRUE, the path is cleaned (deals with too many or too few slashes, cleans things like "/../..", etc). Otherwise path() returns exactly the path that was parsed or set. +.PP +See also setPath() and hasPath(). +.PP +Example: qdir/qdir.cpp. +.SH "int QUrl::port () const" +Returns the port of the URL or -1 if no port has been set. +.PP +See also setPort(). +.SH "QString QUrl::protocol () const" +Returns the protocol of the URL. Typically, "file", "http", "ftp", etc. +.PP +See also setProtocol(). +.SH "QString QUrl::query () const" +Returns the (encoded) query of the URL. +.PP +See also setQuery() and decode(). +.SH "QString QUrl::ref () const" +Returns the (encoded) reference of the URL. +.PP +See also setRef(), hasRef(), and decode(). +.SH "void QUrl::reset ()\fC [virtual protected]\fR" +Resets all parts of the URL to their default values and invalidates it. +.SH "void QUrl::setEncodedPathAndQuery ( const QString & pathAndQuery )\fC [virtual]\fR" +Parses \fIpathAndQuery\fR for a path and query and sets those values. The whole string must be encoded. +.PP +See also encode(). +.SH "void QUrl::setFileName ( const QString & name )\fC [virtual]\fR" +Sets the file name of the URL to \fIname\fR. If this URL contains a fileName(), the original file name is replaced by \fIname\fR. +.PP +See the documentation of fileName() for a more detailed discussion of what is handled as file name and what is handled as a directory path. +.PP +See also fileName(). +.SH "void QUrl::setHost ( const QString & host )\fC [virtual]\fR" +Sets the hostname of the URL to \fIhost\fR. +.PP +See also host() and hasHost(). +.SH "void QUrl::setPassword ( const QString & pass )\fC [virtual]\fR" +Sets the password of the URL to \fIpass\fR. +.PP +\fBWarning:\fR Passwords passed in URLs are normally \fIinsecure\fR; this is due to the mechanism, not because of Qt. +.PP +See also password() and setUser(). +.SH "void QUrl::setPath ( const QString & path )\fC [virtual]\fR" +Sets the path of the URL to \fIpath\fR. +.PP +See also path() and hasPath(). +.SH "void QUrl::setPort ( int port )\fC [virtual]\fR" +Sets the port of the URL to \fIport\fR. +.PP +See also port(). +.SH "void QUrl::setProtocol ( const QString & protocol )\fC [virtual]\fR" +Sets the protocol of the URL to \fIprotocol\fR. Typically, "file"," http", "ftp", etc. +.PP +See also protocol(). +.SH "void QUrl::setQuery ( const QString & txt )\fC [virtual]\fR" +Sets the query of the URL to \fItxt\fR. \fItxt\fR must be encoded. +.PP +See also query() and encode(). +.SH "void QUrl::setRef ( const QString & txt )\fC [virtual]\fR" +Sets the reference of the URL to \fItxt\fR. \fItxt\fR must be encoded. +.PP +See also ref(), hasRef(), and encode(). +.SH "void QUrl::setUser ( const QString & user )\fC [virtual]\fR" +Sets the username of the URL to \fIuser\fR. +.PP +See also user() and setPassword(). +.SH "QString QUrl::toString ( bool encodedPath = FALSE, bool forcePrependProtocol = TRUE ) const\fC [virtual]\fR" +Composes a string version of the URL and returns it. If \fIencodedPath\fR is TRUE the path in the returned string is encoded. If \fIforcePrependProtocol\fR is TRUE and \fIencodedPath\fR looks like a local filename, the "file:/" protocol is also prepended. +.PP +See also encode() and decode(). +.SH "QString QUrl::user () const" +Returns the username of the URL. +.PP +See also setUser() and setPassword(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqurl.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqurl.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqurlinfo.3qt b/doc/man/man3/tqurlinfo.3qt new file mode 100644 index 000000000..9d6580e61 --- /dev/null +++ b/doc/man/man3/tqurlinfo.3qt @@ -0,0 +1,366 @@ +'\" t +.TH QUrlInfo 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 +QUrlInfo \- Stores information about URLs +.SH SYNOPSIS +\fC#include <ntqurlinfo.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBPermissionSpec\fR { ReadOwner = 00400, WriteOwner = 00200, ExeOwner = 00100, ReadGroup = 00040, WriteGroup = 00020, ExeGroup = 00010, ReadOther = 00004, WriteOther = 00002, ExeOther = 00001 }" +.br +.ti -1c +.BI "\fBQUrlInfo\fR ()" +.br +.ti -1c +.BI "\fBQUrlInfo\fR ( const QUrlOperator & path, const QString & file )" +.br +.ti -1c +.BI "\fBQUrlInfo\fR ( const QUrlInfo & ui )" +.br +.ti -1c +.BI "\fBQUrlInfo\fR ( const QString & name, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" +.br +.ti -1c +.BI "\fBQUrlInfo\fR ( const QUrl & url, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" +.br +.ti -1c +.BI "QUrlInfo & \fBoperator=\fR ( const QUrlInfo & ui )" +.br +.ti -1c +.BI "virtual \fB~QUrlInfo\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetName\fR ( const QString & name )" +.br +.ti -1c +.BI "virtual void \fBsetDir\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetFile\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetSymLink\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetOwner\fR ( const QString & s )" +.br +.ti -1c +.BI "virtual void \fBsetGroup\fR ( const QString & s )" +.br +.ti -1c +.BI "virtual void \fBsetSize\fR ( uint size )" +.br +.ti -1c +.BI "virtual void \fBsetWritable\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetReadable\fR ( bool b )" +.br +.ti -1c +.BI "virtual void \fBsetPermissions\fR ( int p )" +.br +.ti -1c +.BI "virtual void \fBsetLastModified\fR ( const QDateTime & dt )" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "QString \fBname\fR () const" +.br +.ti -1c +.BI "int \fBpermissions\fR () const" +.br +.ti -1c +.BI "QString \fBowner\fR () const" +.br +.ti -1c +.BI "QString \fBgroup\fR () const" +.br +.ti -1c +.BI "uint \fBsize\fR () const" +.br +.ti -1c +.BI "QDateTime \fBlastModified\fR () const" +.br +.ti -1c +.BI "QDateTime \fBlastRead\fR () const" +.br +.ti -1c +.BI "bool \fBisDir\fR () const" +.br +.ti -1c +.BI "bool \fBisFile\fR () const" +.br +.ti -1c +.BI "bool \fBisSymLink\fR () const" +.br +.ti -1c +.BI "bool \fBisWritable\fR () const" +.br +.ti -1c +.BI "bool \fBisReadable\fR () const" +.br +.ti -1c +.BI "bool \fBisExecutable\fR () const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QUrlInfo & i ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "bool \fBgreaterThan\fR ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )" +.br +.ti -1c +.BI "bool \fBlessThan\fR ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )" +.br +.ti -1c +.BI "bool \fBequal\fR ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )" +.br +.in -1c +.SH DESCRIPTION +The QUrlInfo class stores information about URLs. +.PP +This class is just a container for storing information about URLs, which is why all information must be passed in the constructor. +.PP +Unless you're reimplementing a network protocol you're unlikely to create QUrlInfo objects yourself, but you may receive QUrlInfo objects from functions, e.g. QUrlOperator::info(). +.PP +The information that can be retrieved includes name(), permissions(), owner(), group(), size(), lastModified(), lastRead(), isDir(), isFile(), isSymLink(), isWritable(), isReadable() and isExecutable(). +.PP +See also Input/Output and Networking and Miscellaneous Classes. +.SS "Member Type Documentation" +.SH "QUrlInfo::PermissionSpec" +This enum is used by the permissions() function to report the permissions of a file. +.TP +\fCQUrlInfo::ReadOwner\fR - The file is readable by the owner of the file. +.TP +\fCQUrlInfo::WriteOwner\fR - The file is writable by the owner of the file. +.TP +\fCQUrlInfo::ExeOwner\fR - The file is executable by the owner of the file. +.TP +\fCQUrlInfo::ReadGroup\fR - The file is readable by the group. +.TP +\fCQUrlInfo::WriteGroup\fR - The file is writable by the group. +.TP +\fCQUrlInfo::ExeGroup\fR - The file is executable by the group. +.TP +\fCQUrlInfo::ReadOther\fR - The file is readable by anyone. +.TP +\fCQUrlInfo::WriteOther\fR - The file is writable by anyone. +.TP +\fCQUrlInfo::ExeOther\fR - The file is executable by anyone. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QUrlInfo::QUrlInfo ()" +Constructs an invalid QUrlInfo object with default values. +.PP +See also isValid(). +.SH "QUrlInfo::QUrlInfo ( const QUrlOperator & path, const QString & file )" +Constructs a QUrlInfo object with information about the file \fIfile\fR in the \fIpath\fR. It tries to find the information about the \fIfile\fR in the QUrlOperator \fIpath\fR. +.PP +If the information is not found, this constructor creates an invalid QUrlInfo, i.e. isValid() returns FALSE. You should always check if the URL info is valid before relying on the return values of any getter functions. +.PP +If \fIfile\fR is empty, it defaults to the QUrlOperator \fIpath\fR, i.e. to the directory. +.PP +See also isValid() and QUrlOperator::info(). +.SH "QUrlInfo::QUrlInfo ( const QUrlInfo & ui )" +Copy constructor, copies \fIui\fR to this URL info object. +.SH "QUrlInfo::QUrlInfo ( const QString & name, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" +Constructs a QUrlInfo object by specifying all the URL's information. +.PP +The information that is passed is the \fIname\fR, file \fIpermissions\fR, \fIowner\fR and \fIgroup\fR and the file's \fIsize\fR. Also passed is the \fIlastModified\fR date/time and the \fIlastRead\fR date/time. Flags are also passed, specifically, \fIisDir\fR, \fIisFile\fR, \fIisSymLink\fR, \fIisWritable\fR, \fIisReadable\fR and \fIisExecutable\fR. +.SH "QUrlInfo::QUrlInfo ( const QUrl & url, int permissions, const QString & owner, const QString & group, uint size, const QDateTime & lastModified, const QDateTime & lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable )" +Constructs a QUrlInfo object by specifying all the URL's information. +.PP +The information that is passed is the \fIurl\fR, file \fIpermissions\fR, \fIowner\fR and \fIgroup\fR and the file's \fIsize\fR. Also passed is the \fIlastModified\fR date/time and the \fIlastRead\fR date/time. Flags are also passed, specifically, \fIisDir\fR, \fIisFile\fR, \fIisSymLink\fR, \fIisWritable\fR, \fIisReadable\fR and \fIisExecutable\fR. +.SH "QUrlInfo::~QUrlInfo ()\fC [virtual]\fR" +Destroys the URL info object. +.PP +The QUrlOperator object to which this URL referred (if any) is not affected. +.SH "bool QUrlInfo::equal ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )\fC [static]\fR" +Returns TRUE if \fIi1\fR equals to \fIi2\fR; otherwise returns FALSE. The objects are compared by the value, which is specified by \fIsortBy\fR. This must be one of QDir::Name, QDir::Time or QDir::Size. +.SH "bool QUrlInfo::greaterThan ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )\fC [static]\fR" +Returns TRUE if \fIi1\fR is greater than \fIi2\fR; otherwise returns FALSE. The objects are compared by the value, which is specified by \fIsortBy\fR. This must be one of QDir::Name, QDir::Time or QDir::Size. +.SH "QString QUrlInfo::group () const" +Returns the group of the URL. +.PP +See also isValid(). +.SH "bool QUrlInfo::isDir () const" +Returns TRUE if the URL is a directory; otherwise returns FALSE. +.PP +See also isValid(). +.PP +Examples: +.)l network/ftpclient/ftpmainwindow.ui.h and network/networkprotocol/nntp.cpp. +.SH "bool QUrlInfo::isExecutable () const" +Returns TRUE if the URL is executable; otherwise returns FALSE. +.PP +See also isValid(). +.SH "bool QUrlInfo::isFile () const" +Returns TRUE if the URL is a file; otherwise returns FALSE. +.PP +See also isValid(). +.SH "bool QUrlInfo::isReadable () const" +Returns TRUE if the URL is readable; otherwise returns FALSE. +.PP +See also isValid(). +.SH "bool QUrlInfo::isSymLink () const" +Returns TRUE if the URL is a symbolic link; otherwise returns FALSE. +.PP +See also isValid(). +.SH "bool QUrlInfo::isValid () const" +Returns TRUE if the URL info is valid; otherwise returns FALSE. Valid means that the QUrlInfo contains real information. For example, a call to QUrlOperator::info() might return a an invalid QUrlInfo, if no information about the requested entry is available. +.PP +You should always check if the URL info is valid before relying on the values. +.SH "bool QUrlInfo::isWritable () const" +Returns TRUE if the URL is writable; otherwise returns FALSE. +.PP +See also isValid(). +.SH "QDateTime QUrlInfo::lastModified () const" +Returns the last modification date of the URL. +.PP +See also isValid(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "QDateTime QUrlInfo::lastRead () const" +Returns the date when the URL was last read. +.PP +See also isValid(). +.SH "bool QUrlInfo::lessThan ( const QUrlInfo & i1, const QUrlInfo & i2, int sortBy )\fC [static]\fR" +Returns TRUE if \fIi1\fR is less than \fIi2\fR; otherwise returns FALSE. The objects are compared by the value, which is specified by \fIsortBy\fR. This must be one of QDir::Name, QDir::Time or QDir::Size. +.SH "QString QUrlInfo::name () const" +Returns the file name of the URL. +.PP +See also isValid(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. +.SH "QUrlInfo & QUrlInfo::operator= ( const QUrlInfo & ui )" +Assigns the values of \fIui\fR to this QUrlInfo object. +.SH "bool QUrlInfo::operator== ( const QUrlInfo & i ) const" +Compares this QUrlInfo with \fIi\fR and returns TRUE if they are equal; otherwise returns FALSE. +.SH "QString QUrlInfo::owner () const" +Returns the owner of the URL. +.PP +See also isValid(). +.SH "int QUrlInfo::permissions () const" +Returns the permissions of the URL. You can use the PermissionSpec flags to test for certain permissions. +.PP +See also isValid(). +.SH "void QUrlInfo::setDir ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE then the URL is set to be a directory; if \\b is FALSE then the URL is set not to be a directory (which normally means it is a file). (Note that a URL can refer to both a file and a directory even though most file systems do not support this.) +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QUrlInfo::setFile ( bool b )\fC [virtual]\fR" +If \fIb\fR is TRUE then the URL is set to be a file; if \\b is FALSE then the URL is set not to be a file (which normally means it is a directory). (Note that a URL can refer to both a file and a directory even though most file systems do not support this.) +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QUrlInfo::setGroup ( const QString & s )\fC [virtual]\fR" +Specifies that the owning group of the URL is called \fIs\fR. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.SH "void QUrlInfo::setLastModified ( const QDateTime & dt )\fC [virtual]\fR" +Specifies that the object the URL refers to was last modified at \fIdt\fR. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.SH "void QUrlInfo::setName ( const QString & name )\fC [virtual]\fR" +Sets the name of the URL to \fIname\fR. The name is the full text, for example, "http://doc.trolltech.com/ntqurlinfo.html". +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QUrlInfo::setOwner ( const QString & s )\fC [virtual]\fR" +Specifies that the owner of the URL is called \fIs\fR. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.SH "void QUrlInfo::setPermissions ( int p )\fC [virtual]\fR" +Specifies that the URL has access permisions, \fIp\fR. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.SH "void QUrlInfo::setReadable ( bool b )\fC [virtual]\fR" +Specifies that the URL is readable if \fIb\fR is TRUE and not readable if \fIb\fR is FALSE. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QUrlInfo::setSize ( uint size )\fC [virtual]\fR" +Specifies the \fIsize\fR of the URL. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.SH "void QUrlInfo::setSymLink ( bool b )\fC [virtual]\fR" +Specifies that the URL refers to a symbolic link if \fIb\fR is TRUE and that it does not if \fIb\fR is FALSE. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "void QUrlInfo::setWritable ( bool b )\fC [virtual]\fR" +Specifies that the URL is writable if \fIb\fR is TRUE and not writable if \fIb\fR is FALSE. +.PP +If you call this function for an invalid URL info, this function turns it into a valid one. +.PP +See also isValid(). +.PP +Example: network/networkprotocol/nntp.cpp. +.SH "uint QUrlInfo::size () const" +Returns the size of the URL. +.PP +See also isValid(). +.PP +Example: network/ftpclient/ftpmainwindow.ui.h. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqurlinfo.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqurlinfo.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqurloperator.3qt b/doc/man/man3/tqurloperator.3qt new file mode 100644 index 000000000..d4442332b --- /dev/null +++ b/doc/man/man3/tqurloperator.3qt @@ -0,0 +1,379 @@ +'\" t +.TH QUrlOperator 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 +QUrlOperator \- Common operations on URLs +.SH SYNOPSIS +\fC#include <ntqurloperator.h>\fR +.PP +Inherits QObject and QUrl. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQUrlOperator\fR ()" +.br +.ti -1c +.BI "\fBQUrlOperator\fR ( const QString & url )" +.br +.ti -1c +.BI "\fBQUrlOperator\fR ( const QUrlOperator & url )" +.br +.ti -1c +.BI "\fBQUrlOperator\fR ( const QUrlOperator & url, const QString & relUrl, bool checkSlash = FALSE )" +.br +.ti -1c +.BI "virtual \fB~QUrlOperator\fR ()" +.br +.ti -1c +.BI "virtual const QNetworkOperation * \fBlistChildren\fR ()" +.br +.ti -1c +.BI "virtual const QNetworkOperation * \fBmkdir\fR ( const QString & dirname )" +.br +.ti -1c +.BI "virtual const QNetworkOperation * \fBremove\fR ( const QString & filename )" +.br +.ti -1c +.BI "virtual const QNetworkOperation * \fBrename\fR ( const QString & oldname, const QString & newname )" +.br +.ti -1c +.BI "virtual const QNetworkOperation * \fBget\fR ( const QString & location = QString::null )" +.br +.ti -1c +.BI "virtual const QNetworkOperation * \fBput\fR ( const QByteArray & data, const QString & location = QString::null )" +.br +.ti -1c +.BI "virtual QPtrList<QNetworkOperation> \fBcopy\fR ( const QString & from, const QString & to, bool move = FALSE, bool toPath = TRUE )" +.br +.ti -1c +.BI "virtual void \fBcopy\fR ( const QStringList & files, const QString & dest, bool move = FALSE )" +.br +.ti -1c +.BI "virtual bool \fBisDir\fR ( bool * ok = 0 )" +.br +.ti -1c +.BI "virtual void \fBsetNameFilter\fR ( const QString & nameFilter )" +.br +.ti -1c +.BI "QString \fBnameFilter\fR () const" +.br +.ti -1c +.BI "virtual QUrlInfo \fBinfo\fR ( const QString & entry ) const" +.br +.ti -1c +.BI "virtual void \fBstop\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBnewChildren\fR ( const QValueList<QUrlInfo> & i, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBfinished\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBstart\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBcreatedDirectory\fR ( const QUrlInfo & i, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBremoved\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBitemChanged\fR ( QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBdata\fR ( const QByteArray & data, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBdataTransferProgress\fR ( int bytesDone, int bytesTotal, QNetworkOperation * op )" +.br +.ti -1c +.BI "void \fBstartedNextCopy\fR ( const QPtrList<QNetworkOperation> & lst )" +.br +.ti -1c +.BI "void \fBconnectionStateChanged\fR ( int state, const QString & data )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBclearEntries\fR ()" +.br +.ti -1c +.BI "void \fBgetNetworkProtocol\fR ()" +.br +.ti -1c +.BI "void \fBdeleteNetworkProtocol\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "void \fBqInitNetworkProtocols\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QUrlOperator class provides common operations on URLs. +.PP +This class operates on hierarchical structures (such as filesystems) using URLs. Its API facilitates all the common operations: <center>.nf +.TS +l - l. Operation Function List files listChildren() Make a directory mkdir() Remove a file remove() Rename a file rename() Get a file get() Put a file put() Copy a file +.TE +.fi +</center> +.PP +You can obtain additional information about the URL with isDir() and info(). If a directory is to be traversed using listChildren(), a name filter can be set with setNameFilter(). +.PP +A QUrlOperator can be used like this, for example to download a file (and assuming that the FTP protocol is registered): +.PP +.nf +.br + QUrlOperator *op = new QUrlOperator(); +.br + op->copy( QString("ftp://ftp.trolltech.com/qt/source/qt-2.1.0.tar.gz"), +.br + "file:/tmp" ); +.br +.fi +.PP +If you want to be notified about success/failure, progress, etc., you can connect to QUrlOperator's signals, e.g. to start(), newChildren(), createdDirectory(), removed(), data(), dataTransferProgress(), startedNextCopy(), connectionStateChanged(), finished(), etc. A network operation can be stopped with stop(). +.PP +The class uses the functionality of registered network protocols to perform these operations. Depending of the protocol of the URL, it uses an appropriate network protocol class for the operations. Each of the operation functions of QUrlOperator creates a QNetworkOperation object that describes the operation and puts it into the operation queue for the network protocol used. If no suitable protocol could be found (because no implementation of the necessary network protocol is registered), the URL operator emits errors. Not every protocol supports every operation, but error handling deals with this problem. +.PP +To register the available network protocols, use the tqInitNetworkProtocols() function. The protocols currently supported are: +.TP +FTP, +.TP +HTTP, +.TP +local file system. +.PP +For more information about the Qt Network Architecture see the Qt Network Documentation. +.PP +See also QNetworkProtocol, QNetworkOperation, Input/Output and Networking, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QUrlOperator::QUrlOperator ()" +Constructs a QUrlOperator with an empty (i.e. invalid) URL. +.SH "QUrlOperator::QUrlOperator ( const QString & url )" +Constructs a QUrlOperator using \fIurl\fR and parses this string. +.PP +If you pass strings like "/home/qt" the "file" protocol is assumed. +.SH "QUrlOperator::QUrlOperator ( const QUrlOperator & url )" +Constructs a copy of \fIurl\fR. +.SH "QUrlOperator::QUrlOperator ( const QUrlOperator & url, const QString & relUrl, bool checkSlash = FALSE )" +Constructs a QUrlOperator. The URL on which this QUrlOperator operates is constructed out of the arguments \fIurl\fR, \fIrelUrl\fR and \fIcheckSlash\fR: see the corresponding QUrl constructor for an explanation of these arguments. +.SH "QUrlOperator::~QUrlOperator ()\fC [virtual]\fR" +Destructor. +.SH "void QUrlOperator::clearEntries ()\fC [virtual protected]\fR" +Clears the cache of children. +.SH "void QUrlOperator::connectionStateChanged ( int state, const QString & data )\fC [signal]\fR" +This signal is emitted whenever the URL operator's connection state changes. \fIstate\fR describes the new state, which is a QNetworkProtocol::ConnectionState value. +.PP +\fIdata\fR is a string that describes the change of the connection. This can be used to display a message to the user. +.SH "QPtrList<QNetworkOperation> QUrlOperator::copy ( const QString & from, const QString & to, bool move = FALSE, bool toPath = TRUE )\fC [virtual]\fR" +Copies the file \fIfrom\fR to \fIto\fR. If \fImove\fR is TRUE, the file is moved (copied and removed). \fIfrom\fR must point to a file and \fIto\fR must point to a directory (into which \fIfrom\fR is copied) unless \fItoPath\fR is set to FALSE. If \fItoPath\fR is set to FALSE then the \fIto\fR variable is assumed to be the absolute file path (destination file path + file name). The copying is done using the get() and put() operations. If you want to be notified about the progress of the operation, connect to the dataTransferProgress() signal. Bear in mind that the get() and put() operations emit this signal through the QUrlOperator. The number of transferred bytes and the total bytes that you receive as arguments in this signal do not relate to the the whole copy operation; they relate first to the get() and then to the put() operation. Always check what type of operation the signal comes from; this is given in the signal's last argument. +.PP +At the end, finished() (with success or failure) is emitted, so check the state of the network operation object to see whether or not the operation was successful. +.PP +Because a move or copy operation consists of multiple operations (get(), put() and maybe remove()), this function doesn't return a single QNetworkOperation, but rather a list of them. They are in the order: get(), put() and (if applicable) remove(). +.PP +See also get() and put(). +.SH "void QUrlOperator::copy ( const QStringList & files, const QString & dest, bool move = FALSE )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Copies the \fIfiles\fR to the directory \fIdest\fR. If \fImove\fR is TRUE the files are moved, not copied. \fIdest\fR must point to a directory. +.PP +This function calls copy() for each entry in \fIfiles\fR in turn. You don't get a result from this function; each time a new copy begins, startedNextCopy() is emitted, with a list of QNetworkOperations that describe the new copy operation. +.SH "void QUrlOperator::createdDirectory ( const QUrlInfo & i, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when mkdir() succeeds and the directory has been created. \fIi\fR holds the information about the new directory. +.PP +\fIop\fR is a pointer to the operation object, which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the new directory's name. +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "void QUrlOperator::data ( const QByteArray & data, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when new \fIdata\fR has been received after calling get() or put(). \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the name of the file whose data is retrieved and op->rawArg(1) holds the (raw) data. +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "void QUrlOperator::dataTransferProgress ( int bytesDone, int bytesTotal, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted during data transfer (using put() or get()). \fIbytesDone\fR specifies how many bytes of \fIbytesTotal\fR have been transferred. More information about the operation is stored in \fIop\fR, a pointer to the network operation that is processed. \fIbytesTotal\fR may be -1, which means that the total number of bytes is not known. +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "void QUrlOperator::deleteNetworkProtocol ()\fC [protected]\fR" +Deletes the currently used network protocol. +.SH "void QUrlOperator::finished ( QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when an operation of some sort finishes, whether with success or failure. \fIop\fR is a pointer to the operation object, which contains all the information, including the state, of the operation which has been finished. Check the state and error code of the operation object to see whether or not the operation was successful. +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "const QNetworkOperation * QUrlOperator::get ( const QString & location = QString::null )\fC [virtual]\fR" +Tells the network protocol to get data from \fIlocation\fR or, if this is QString::null, to get data from the location to which this URL points (see QUrl::fileName() and QUrl::encodedPathAndQuery()). What happens then depends on the network protocol. The data() signal is emitted when data comes in. Because it's unlikely that all data will come in at once, it is common for multiple data() signals to be emitted. The dataTransferProgress() signal is emitted while processing the operation. At the end, finished() (with success or failure) is emitted, so check the state of the network operation object to see whether or not the operation was successful. +.PP +If \fIlocation\fR is QString::null, the path of this QUrlOperator should point to a file when you use this operation. If \fIlocation\fR is not empty, it can be a relative URL (a child of the path to which the QUrlOperator points) or an absolute URL. +.PP +For example, to get a web page you might do something like this: +.PP +.nf +.br + QUrlOperator op( "http://www.whatever.org/cgi-bin/search.pl?cmd=Hello" ); +.br + op.get(); +.br +.fi +.PP +For most other operations, the path of the QUrlOperator must point to a directory. If you want to download a file you could do the following: +.PP +.nf +.br + QUrlOperator op( "ftp://ftp.whatever.org/pub" ); +.br + // do some other stuff like op.listChildren() or op.mkdir( "new_dir" ) +.br + op.get( "a_file.txt" ); +.br +.fi +.PP +This will get the data of ftp://ftp.whatever.org/pub/a_file.txt. +.PP +\fINever\fR do anything like this: +.PP +.nf +.br + QUrlOperator op( "http://www.whatever.org/cgi-bin" ); +.br + op.get( "search.pl?cmd=Hello" ); // WRONG! +.br +.fi +.PP +If \fIlocation\fR is not empty and relative it must not contain any queries or references, just the name of a child. So if you need to specify a query or reference, do it as shown in the first example or specify the full URL (such as http://www.whatever.org/cgi-bin/search.pl?cmd=Hello) as \fIlocation\fR. +.PP +See also copy(). +.SH "void QUrlOperator::getNetworkProtocol ()\fC [protected]\fR" +Finds a network protocol for the URL and deletes the old network protocol. +.SH "QUrlInfo QUrlOperator::info ( const QString & entry ) const\fC [virtual]\fR" +Returns the URL information for the child \fIentry\fR, or returns an empty QUrlInfo object if there is no information available about \fIentry\fR. Information about \fIentry\fR is only available after a successfully finished listChildren() operation. +.SH "bool QUrlOperator::isDir ( bool * ok = 0 )\fC [virtual]\fR" +Returns TRUE if the URL is a directory; otherwise returns FALSE. This may not always work correctly, if the protocol of the URL is something other than file (local filesystem). If you pass a bool pointer as the \fIok\fR argument, \fI*ok\fR is set to TRUE if the result of this function is known to be correct, and to FALSE otherwise. +.SH "void QUrlOperator::itemChanged ( QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted whenever a file which is a child of the URL has been changed, for example by successfully calling rename(). \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the original file name and \fCop->arg(1)\fR holds the new file name (if it was changed). +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "const QNetworkOperation * QUrlOperator::listChildren ()\fC [virtual]\fR" +Starts listing the children of this URL (e.g. the files in the directory). The start() signal is emitted before the first entry is listed and finished() is emitted after the last one. The newChildren() signal is emitted for each list of new entries. If an error occurs, the signal finished() is emitted, so be sure to check the state of the network operation pointer. +.PP +Because the operation may not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. +.PP +The path of this QUrlOperator must to point to a directory (because the children of this directory will be listed), not to a file. +.SH "const QNetworkOperation * QUrlOperator::mkdir ( const QString & dirname )\fC [virtual]\fR" +Tries to create a directory (child) with the name \fIdirname\fR. If it is successful, a newChildren() signal with the new child is emitted, and the createdDirectory() signal with the information about the new child is also emitted. The finished() signal (with success or failure) is emitted after the operation has been processed, so check the state of the network operation object to see whether or not the operation was successful. +.PP +Because the operation will not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. +.PP +The path of this QUrlOperator must to point to a directory (not a file) because the new directory will be created in this path. +.SH "QString QUrlOperator::nameFilter () const" +Returns the name filter of the URL. +.PP +See also QUrlOperator::setNameFilter() and QDir::nameFilter(). +.SH "void QUrlOperator::newChildren ( const QValueList<QUrlInfo> & i, QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted after listChildren() was called and new children (i.e. files) have been read from a list of files. \fIi\fR holds the information about the new files. \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "const QNetworkOperation * QUrlOperator::put ( const QByteArray & data, const QString & location = QString::null )\fC [virtual]\fR" +This function tells the network protocol to put \fIdata\fR in \fIlocation\fR. If \fIlocation\fR is empty (QString::null), it puts the \fIdata\fR in the location to which the URL points. What happens depends on the network protocol. Depending on the network protocol, some data might come back after putting data, in which case the data() signal is emitted. The dataTransferProgress() signal is emitted during processing of the operation. At the end, finished() (with success or failure) is emitted, so check the state of the network operation object to see whether or not the operation was successful. +.PP +If \fIlocation\fR is QString::null, the path of this QUrlOperator should point to a file when you use this operation. If \fIlocation\fR is not empty, it can be a relative (a child of the path to which the QUrlOperator points) or an absolute URL. +.PP +For putting some data to a file you can do the following: +.PP +.nf +.br + QUrlOperator op( "ftp://ftp.whatever.com/home/me/filename.dat" ); +.br + op.put( data ); +.br +.fi +.PP +For most other operations, the path of the QUrlOperator must point to a directory. If you want to upload data to a file you could do the following: +.PP +.nf +.br + QUrlOperator op( "ftp://ftp.whatever.com/home/me" ); +.br + // do some other stuff like op.listChildren() or op.mkdir( "new_dir" ) +.br + op.put( data, "filename.dat" ); +.br +.fi +.PP +This will upload the data to ftp://ftp.whatever.com/home/me/filename.dat. +.PP +See also copy(). +.SH "const QNetworkOperation * QUrlOperator::remove ( const QString & filename )\fC [virtual]\fR" +Tries to remove the file (child) \fIfilename\fR. If it succeeds the removed() signal is emitted. finished() (with success or failure) is also emitted after the operation has been processed, so check the state of the network operation object to see whether or not the operation was successful. +.PP +Because the operation will not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. +.PP +The path of this QUrlOperator must point to a directory; because if \fIfilename\fR is relative, it will try to remove it in this directory. +.SH "void QUrlOperator::removed ( QNetworkOperation * op )\fC [signal]\fR" +This signal is emitted when remove() has been succesful and the file has been removed. +.PP +\fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. \fCop->arg(0)\fR holds the name of the file that was removed. +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "const QNetworkOperation * QUrlOperator::rename ( const QString & oldname, const QString & newname )\fC [virtual]\fR" +Tries to rename the file (child) called \fIoldname\fR to \fInewname\fR. If it succeeds, the itemChanged() signal is emitted. finished() (with success or failure) is also emitted after the operation has been processed, so check the state of the network operation object to see whether or not the operation was successful. +.PP +Because the operation may not be executed immediately, a pointer to the QNetworkOperation object created by this function is returned. This object contains all the data about the operation and is used to refer to this operation later (e.g. in the signals that are emitted by the QUrlOperator). The return value can also be 0 if the operation object couldn't be created. +.PP +This path of this QUrlOperator must to point to a directory because \fIoldname\fR and \fInewname\fR are handled relative to this directory. +.SH "void QUrlOperator::setNameFilter ( const QString & nameFilter )\fC [virtual]\fR" +Sets the name filter of the URL to \fInameFilter\fR. +.PP +See also QDir::setNameFilter(). +.SH "void QUrlOperator::start ( QNetworkOperation * op )\fC [signal]\fR" +Some operations (such as listChildren()) emit this signal when they start processing the operation. \fIop\fR is a pointer to the operation object which contains all the information about the operation, including the state. +.PP +See also QNetworkOperation and QNetworkProtocol. +.SH "void QUrlOperator::startedNextCopy ( const QPtrList<QNetworkOperation> & lst )\fC [signal]\fR" +This signal is emitted if copy() starts a new copy operation. \fIlst\fR contains all QNetworkOperations related to this copy operation. +.PP +See also copy(). +.SH "void QUrlOperator::stop ()\fC [virtual]\fR" +Stops the current network operation and removes all this QUrlOperator's waiting network operations. +.SH RELATED FUNCTION DOCUMENTATION +.SH "void tqInitNetworkProtocols ()" +This function registers the network protocols for FTP and HTTP. You must call this function before you use QUrlOperator for these protocols. +.PP +This function is declared in ntqnetwork.h. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqurloperator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqurloperator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tquuid.3qt b/doc/man/man3/tquuid.3qt new file mode 100644 index 000000000..0df677c79 --- /dev/null +++ b/doc/man/man3/tquuid.3qt @@ -0,0 +1,203 @@ +'\" t +.TH QUuid 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 +QUuid \- Defines a Universally Unique Identifier (UUID) +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntquuid.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBVariant\fR { VarUnknown = -1, NCS = 0, DCE = 2, Microsoft = 6, Reserved = 7 }" +.br +.ti -1c +.BI "enum \fBVersion\fR { VerUnknown = -1, Time = 1, EmbeddedPOSIX = 2, Name = 3, Random = 4 }" +.br +.ti -1c +.BI "\fBQUuid\fR ()" +.br +.ti -1c +.BI "\fBQUuid\fR ( uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8 )" +.br +.ti -1c +.BI "\fBQUuid\fR ( const QUuid & orig )" +.br +.ti -1c +.BI "\fBQUuid\fR ( const QString & text )" +.br +.ti -1c +.BI "QString \fBtoString\fR () const" +.br +.ti -1c +.BI "\fBoperator QString\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "QUuid & \fBoperator=\fR ( const QUuid & uuid )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QUuid & other ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QUuid & other ) const" +.br +.ti -1c +.BI "bool \fBoperator<\fR ( const QUuid & other ) const" +.br +.ti -1c +.BI "bool \fBoperator>\fR ( const QUuid & other ) const" +.br +.ti -1c +.BI "QUuid::Variant \fBvariant\fR () const" +.br +.ti -1c +.BI "QUuid::Version \fBversion\fR () const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QUuid \fBcreateUuid\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QUuid & id )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QUuid & id )" +.br +.in -1c +.SH DESCRIPTION +The QUuid class defines a Universally Unique Identifier (UUID). +.PP +For objects or declarations that must be uniquely identified, UUIDs (also known as GUIDs) are widely used in order to assign a fixed and easy to compare value to the object or declaration. The 128-bit value of a UUID is generated by an algorithm that guarantees that the value is unique. +.PP +In Qt, UUIDs are wrapped by the QUuid struct which provides convenience functions for handling UUIDs. Most platforms provide a tool to generate new UUIDs, for example, uuidgen and guidgen. +.PP +UUIDs generated by QUuid, are based on the Random version of the DCE (Distributed Computing Environment) standard. +.PP +UUIDs can be constructed from numeric values or from strings, or using the static createUuid() function. They can be converted to a string with toString(). UUIDs have a variant() and a version(), and null UUIDs return TRUE from isNull(). +.SS "Member Type Documentation" +.SH "QUuid::Variant" +This enum defines the variant of the UUID, which is the scheme which defines the layout of the 128-bits value. +.TP +\fCQUuid::VarUnknown\fR - Variant is unknown +.TP +\fCQUuid::NCS\fR - Reserved for NCS (Network Computing System) backward compatibility +.TP +\fCQUuid::DCE\fR - Distributed Computing Environment, the scheme used by QUuid +.TP +\fCQUuid::Microsoft\fR - Reserved for Microsoft backward compatibility (GUID) +.TP +\fCQUuid::Reserved\fR - Reserved for future definition +.SH "QUuid::Version" +This enum defines the version of the UUID. +.TP +\fCQUuid::VerUnknown\fR - Version is unknown +.TP +\fCQUuid::Time\fR - Time-based, by using timestamp, clock sequence, and MAC network card address (if available) for the node sections +.TP +\fCQUuid::EmbeddedPOSIX\fR - DCE Security version, with embedded POSIX UUIDs +.TP +\fCQUuid::Name\fR - Name-based, by using values from a name for all sections +.TP +\fCQUuid::Random\fR - Random-based, by using random numbers for all sections +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QUuid::QUuid ()" +Creates the null UUID {00000000-0000-0000-0000-000000000000}. +.SH "QUuid::QUuid ( uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8 )" +Creates a UUID with the value specified by the parameters, \fIl\fR, \fIw1\fR, \fIw2\fR, \fIb1\fR, \fIb2\fR, \fIb3\fR, \fIb4\fR, \fIb5\fR, \fIb6\fR, \fIb7\fR, \fIb8\fR. +.PP +Example: +.PP +.nf +.br + // {67C8770B-44F1-410A-AB9A-F9B5446F13EE} +.br + QUuid IID_MyInterface( 0x67c8770b, 0x44f1, 0x410a, 0xab, 0x9a, 0xf9, 0xb5, 0x44, 0x6f, 0x13, 0xee ) +.br +.fi +.SH "QUuid::QUuid ( const QUuid & orig )" +Creates a copy of the QUuid \fIorig\fR. +.SH "QUuid::QUuid ( const QString & text )" +Creates a QUuid object from the string \fItext\fR. The function can only convert a string in the format {HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHH} (where 'H' stands for a hex digit). If the conversion fails a null UUID is created. +.SH "QUuid QUuid::createUuid ()\fC [static]\fR" +Returns a new UUID of DCE variant, and Random type. The UUIDs generated are based on the platform specific pseudo-random generator, which is usually not a cryptographic-quality random number generator. Therefore, a UUID is not guaranteed to be unique cross application instances. +.PP +On Windows, the new UUID is extremely likely to be unique on the same or any other system, networked or not. +.PP +See also variant() and version(). +.SH "bool QUuid::isNull () const" +Returns TRUE if this is the null UUID {00000000-0000-0000-0000-000000000000}; otherwise returns FALSE. +.SH "QUuid::operator QString () const" +Returns the string representation of the uuid. +.PP +See also toString(). +.SH "bool QUuid::operator!= ( const QUuid & other ) const" +Returns TRUE if this QUuid and the \fIother\fR QUuid are different; otherwise returns FALSE. +.SH "bool QUuid::operator< ( const QUuid & other ) const" +Returns TRUE if this QUuid is of the same variant, and lexicographically before the \fIother\fR QUuid; otherwise returns FALSE. +.PP +See also variant(). +.SH "QUuid & QUuid::operator= ( const QUuid & uuid )" +Assigns the value of \fIuuid\fR to this QUuid object. +.SH "bool QUuid::operator== ( const QUuid & other ) const" +Returns TRUE if this QUuid and the \fIother\fR QUuid are identical; otherwise returns FALSE. +.SH "bool QUuid::operator> ( const QUuid & other ) const" +Returns TRUE if this QUuid is of the same variant, and lexicographically after the \fIother\fR QUuid; otherwise returns FALSE. +.PP +See also variant(). +.SH "QString QUuid::toString () const" +QString QUuid::toString() const +.PP +Returns the string representation of the uuid. +.SH "QUuid::Variant QUuid::variant () const" +Returns the variant of the UUID. The null UUID is considered to be of an unknown variant. +.PP +See also version(). +.SH "QUuid::Version QUuid::version () const" +Returns the version of the UUID, if the UUID is of the DCE variant; otherwise returns VerUnknown. +.PP +See also variant(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QUuid & id )" +Writes the uuid \fIid\fR to the datastream \fIs\fR. +.SH "QDataStream & operator>> ( QDataStream & s, QUuid & id )" +Reads uuid from from the stream \fIs\fR into \fIid\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntquuid.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tquuid.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvalidator.3qt b/doc/man/man3/tqvalidator.3qt new file mode 100644 index 000000000..42d31bc44 --- /dev/null +++ b/doc/man/man3/tqvalidator.3qt @@ -0,0 +1,112 @@ +'\" t +.TH QValidator 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 +QValidator \- Validation of input text +.SH SYNOPSIS +\fC#include <ntqvalidator.h>\fR +.PP +Inherits QObject. +.PP +Inherited by QIntValidator, QDoubleValidator, and QRegExpValidator. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQValidator\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QValidator\fR ()" +.br +.ti -1c +.BI "enum \fBState\fR { Invalid, Intermediate, Valid = Intermediate, Acceptable }" +.br +.ti -1c +.BI "virtual State \fBvalidate\fR ( QString & input, int & pos ) const = 0" +.br +.ti -1c +.BI "virtual void \fBfixup\fR ( QString & input ) const" +.br +.in -1c +.SH DESCRIPTION +The QValidator class provides validation of input text. +.PP +The class itself is abstract. Two subclasses, QIntValidator and QDoubleValidator, provide basic numeric-range checking, and QRegExpValidator provides general checking using a custom regular expression. +.PP +If the built-in validators aren't sufficient, you can subclass QValidator. The class has two virtual functions: validate() and fixup(). +.PP +validate() must be implemented by every subclass. It returns Invalid, Intermediate or Acceptable depending on whether its argument is valid (for the subclass's definition of valid). +.PP +These three states require some explanation. An Invalid string is \fIclearly\fR invalid. Intermediate is less obvious: the concept of validity is slippery when the string is incomplete (still being edited). QValidator defines Intermediate as the property of a string that is neither clearly invalid nor acceptable as a final result. Acceptable means that the string is acceptable as a final result. One might say that any string that is a plausible intermediate state during entry of an Acceptable string is Intermediate. +.PP +Here are some examples: +.IP +.TP +For a line edit that accepts integers from 0 to 999 inclusive, 42 and 123 are Acceptable, the empty string and 1114 are Intermediate and asdf is Invalid. +.IP +.TP +For an editable combobox that accepts URLs, any well-formed URL is Acceptable, "http://www.trolltech.com/," is Intermediate (it might be a cut and paste operation that accidentally took in a comma at the end), the empty string is Intermediate (the user might select and delete all of the text in preparation for entering a new URL), and "http:///./" is Invalid. +.IP +.TP +For a spin box that accepts lengths, "11cm" and "1in" are Acceptable, "11" and the empty string are Intermediate and" http://www.trolltech.com" and "hour" are Invalid. +.IP +.PP +fixup() is provided for validators that can repair some user errors. The default implementation does nothing. QLineEdit, for example, will call fixup() if the user presses Enter (or Return) and the content is not currently valid. This allows the fixup() function the opportunity of performing some magic to make an Invalid string Acceptable. +.PP +QValidator is typically used with QLineEdit, QSpinBox and QComboBox. +.PP +See also Miscellaneous Classes. +.SS "Member Type Documentation" +.SH "QValidator::State" +This enum type defines the states in which a validated string can exist. +.TP +\fCQValidator::Invalid\fR - the string is \fIclearly\fR invalid. +.TP +\fCQValidator::Intermediate\fR - the string is a plausible intermediate value during editing. +.TP +\fCQValidator::Acceptable\fR - the string is acceptable as a final result, i.e. it is valid. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QValidator::QValidator ( QObject * parent, const char * name = 0 )" +Sets up the validator. The \fIparent\fR and \fIname\fR parameters are passed on to the QObject constructor. +.SH "QValidator::~QValidator ()" +Destroys the validator, freeing any storage and other resources used. +.SH "void QValidator::fixup ( QString & input ) const\fC [virtual]\fR" +This function attempts to change \fIinput\fR to be valid according to this validator's rules. It need not result in a valid string: callers of this function must re-test afterwards; the default does nothing. +.PP +Reimplementations of this function can change \fIinput\fR even if they do not produce a valid string. For example, an ISBN validator might want to delete every character except digits and "-", even if the result is still not a valid ISBN; a surname validator might want to remove whitespace from the start and end of the string, even if the resulting string is not in the list of accepted surnames. +.SH "State QValidator::validate ( QString & input, int & pos ) const\fC [pure virtual]\fR" +This pure virtual function returns Invalid if \fIinput\fR is invalid according to this validator's rules, Intermediate if it is likely that a little more editing will make the input acceptable (e.g. the user types '4' into a widget which accepts integers between 10 and 99) and Acceptable if the input is valid. +.PP +The function can change \fIinput\fR and \fIpos\fR (the cursor position) if it wants to. +.PP +Reimplemented in QIntValidator, QDoubleValidator, and QRegExpValidator. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvalidator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvalidator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvaluelist.3qt b/doc/man/man3/tqvaluelist.3qt new file mode 100644 index 000000000..114bc5504 --- /dev/null +++ b/doc/man/man3/tqvaluelist.3qt @@ -0,0 +1,756 @@ +'\" t +.TH QValueList 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 +QValueList \- Value-based template class that provides lists +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqvaluelist.h>\fR +.PP +Inherited by QCanvasItemList, QStringList, and QValueStack. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef QValueListIterator<T> \fBiterator\fR" +.br +.ti -1c +.BI "typedef QValueListConstIterator<T> \fBconst_iterator\fR" +.br +.ti -1c +.BI "typedef T \fBvalue_type\fR" +.br +.ti -1c +.BI "typedef value_type * \fBpointer\fR" +.br +.ti -1c +.BI "typedef const value_type * \fBconst_pointer\fR" +.br +.ti -1c +.BI "typedef value_type & \fBreference\fR" +.br +.ti -1c +.BI "typedef const value_type & \fBconst_reference\fR" +.br +.ti -1c +.BI "typedef size_t \fBsize_type\fR" +.br +.ti -1c +.BI "\fBQValueList\fR ()" +.br +.ti -1c +.BI "\fBQValueList\fR ( const QValueList<T> & l )" +.br +.ti -1c +.BI "\fBQValueList\fR ( const std::list<T> & l )" +.br +.ti -1c +.BI "\fB~QValueList\fR ()" +.br +.ti -1c +.BI "QValueList<T> & \fBoperator=\fR ( const QValueList<T> & l )" +.br +.ti -1c +.BI "QValueList<T> & \fBoperator=\fR ( const std::list<T> & l )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const std::list<T> & l ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QValueList<T> & l ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QValueList<T> & l ) const" +.br +.ti -1c +.BI "iterator \fBbegin\fR ()" +.br +.ti -1c +.BI "const_iterator \fBbegin\fR () const" +.br +.ti -1c +.BI "const_iterator \fBconstBegin\fR () const" +.br +.ti -1c +.BI "iterator \fBend\fR ()" +.br +.ti -1c +.BI "const_iterator \fBend\fR () const" +.br +.ti -1c +.BI "const_iterator \fBconstEnd\fR () const" +.br +.ti -1c +.BI "iterator \fBinsert\fR ( iterator it, const T & x )" +.br +.ti -1c +.BI "uint \fBremove\fR ( const T & x )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "QValueList<T> & \fBoperator<<\fR ( const T & x )" +.br +.ti -1c +.BI "size_type \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBempty\fR () const" +.br +.ti -1c +.BI "void \fBpush_front\fR ( const T & x )" +.br +.ti -1c +.BI "void \fBpush_back\fR ( const T & x )" +.br +.ti -1c +.BI "iterator \fBerase\fR ( iterator it )" +.br +.ti -1c +.BI "iterator \fBerase\fR ( iterator first, iterator last )" +.br +.ti -1c +.BI "reference \fBfront\fR ()" +.br +.ti -1c +.BI "const_reference \fBfront\fR () const" +.br +.ti -1c +.BI "reference \fBback\fR ()" +.br +.ti -1c +.BI "const_reference \fBback\fR () const" +.br +.ti -1c +.BI "void \fBpop_front\fR ()" +.br +.ti -1c +.BI "void \fBpop_back\fR ()" +.br +.ti -1c +.BI "void \fBinsert\fR ( iterator pos, size_type n, const T & x )" +.br +.ti -1c +.BI "QValueList<T> \fBoperator+\fR ( const QValueList<T> & l ) const" +.br +.ti -1c +.BI "QValueList<T> & \fBoperator+=\fR ( const QValueList<T> & l )" +.br +.ti -1c +.BI "iterator \fBfromLast\fR ()" +.br +.ti -1c +.BI "const_iterator \fBfromLast\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "iterator \fBappend\fR ( const T & x )" +.br +.ti -1c +.BI "iterator \fBprepend\fR ( const T & x )" +.br +.ti -1c +.BI "iterator \fBremove\fR ( iterator it )" +.br +.ti -1c +.BI "T & \fBfirst\fR ()" +.br +.ti -1c +.BI "const T & \fBfirst\fR () const" +.br +.ti -1c +.BI "T & \fBlast\fR ()" +.br +.ti -1c +.BI "const T & \fBlast\fR () const" +.br +.ti -1c +.BI "T & \fBoperator[]\fR ( size_type i )" +.br +.ti -1c +.BI "const T & \fBoperator[]\fR ( size_type i ) const" +.br +.ti -1c +.BI "iterator \fBat\fR ( size_type i )" +.br +.ti -1c +.BI "const_iterator \fBat\fR ( size_type i ) const" +.br +.ti -1c +.BI "iterator \fBfind\fR ( const T & x )" +.br +.ti -1c +.BI "const_iterator \fBfind\fR ( const T & x ) const" +.br +.ti -1c +.BI "iterator \fBfind\fR ( iterator it, const T & x )" +.br +.ti -1c +.BI "const_iterator \fBfind\fR ( const_iterator it, const T & x ) const" +.br +.ti -1c +.BI "int \fBfindIndex\fR ( const T & x ) const" +.br +.ti -1c +.BI "size_type \fBcontains\fR ( const T & x ) const" +.br +.ti -1c +.BI "size_type \fBcount\fR () const" +.br +.ti -1c +.BI "QValueList<T> & \fBoperator+=\fR ( const T & x )" +.br +.ti -1c +.BI "typedef QValueListIterator<T> \fBIterator\fR" +.br +.ti -1c +.BI "typedef QValueListConstIterator<T> \fBConstIterator\fR" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QValueList<T> & l )" +.br +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QValueList<T> & l )" +.br +.in -1c +.SH DESCRIPTION +The QValueList class is a value-based template class that provides lists. +.PP +QValueList is a Qt implementation of an STL-like list container. It can be used in your application if the standard \fClist\fR is not available for your target platform(s). QValueList is part of the Qt Template Library. +.PP +QValueList<T> defines a template instance to create a list of values that all have the class T. Note that QValueList does not store pointers to the members of the list; it holds a copy of every member. This is why these kinds of classes are called "value based"; QPtrList and QDict are "pointer based". +.PP +QValueList contains and manages a collection of objects of type T and provides iterators that allow the contained objects to be addressed. QValueList owns the contained items. For more relaxed ownership semantics, see QPtrCollection and friends which are pointer-based containers. +.PP +Some classes cannot be used within a QValueList, for example, all classes derived from QObject and thus all classes that implement widgets. Only values can be used in a QValueList. To qualify as a value the class must provide: +.TP +a copy constructor; +.TP +an assignment operator; +.TP +a default constructor, i.e. a constructor that does not take any arguments. +.PP +Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. +.PP +In addition, some compilers (e.g. Sun CC) might require that the class provides an equality operator (operator==()). +.PP +QValueList's function naming is consistent with the other Qt classes (e.g. count(), isEmpty()). QValueList also provides extra functions for compatibility with STL algorithms, such as size() and empty(). Programmers already familiar with the STL \fClist\fR may prefer to use the STL-compatible functions. +.PP +Example: +.PP +.nf +.br + class Employee +.br + { +.br + public: +.br + Employee(): sn(0) {} +.br + Employee( const QString& forename, const QString& surname, int salary ) +.br + : fn(forename), sn(surname), sal(salary) +.br + {} +.br +.br + QString forename() const { return fn; } +.br + QString surname() const { return sn; } +.br + int salary() const { return sal; } +.br + void setSalary( int salary ) { sal = salary; } +.br +.br + private: +.br + QString fn; +.br + QString sn; +.br + int sal; +.br + }; +.br +.br + typedef QValueList<Employee> EmployeeList; +.br + EmployeeList list; +.br +.br + list.append( Employee("John", "Doe", 50000) ); +.br + list.append( Employee("Jane", "Williams", 80000) ); +.br + list.append( Employee("Tom", "Jones", 60000) ); +.br +.br + Employee mary( "Mary", "Hawthorne", 90000 ); +.br + list.append( mary ); +.br + mary.setSalary( 100000 ); +.br +.br + EmployeeList::iterator it; +.br + for ( it = list.begin(); it != list.end(); ++it ) +.br + cout << (*it).surname().latin1() << ", " << +.br + (*it).forename().latin1() << " earns " << +.br + (*it).salary() << endl; +.br +.br + // Output: +.br + // Doe, John earns 50000 +.br + // Williams, Jane earns 80000 +.br + // Hawthorne, Mary earns 90000 +.br + // Jones, Tom earns 60000 +.br +.fi +.PP +Notice that the latest changes to Mary's salary did not affect the value in the list because the list created a copy of Mary's entry. +.PP +There are several ways to find items in the list. The begin() and end() functions return iterators to the beginning and end of the list. The advantage of getting an iterator is that you can move forward or backward from this position by incrementing/decrementing the iterator. The iterator returned by end() points to the item which is one \fIpast\fR the last item in the container. The past-the-end iterator is still associated with the list it belongs to, however it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. If the list is empty(), the iterator returned by begin() will equal the iterator returned by end(). +.PP +Another way to find an item in the list is by using the tqFind() algorithm. For example: +.PP +.nf +.br + QValueList<int> list; +.br + ... +.br + QValueList<int>::iterator it = tqFind( list.begin(), list.end(), 3 ); +.br + if ( it != list.end() ) +.br + // it points to the found item +.br +.fi +.PP +It is safe to have multiple iterators a the list at the same time. If some member of the list is removed, only iterators pointing to the removed member become invalid. Inserting into the list does not invalidate any iterator. For convenience, the function last() returns a reference to the last item in the list, and first() returns a reference to the the first item. If the list is empty(), both last() and first() have undefined behavior (your application will crash or do unpredictable things). Use last() and first() with caution, for example: +.PP +.nf +.br + QValueList<int> list; +.br + list.append( 1 ); +.br + list.append( 2 ); +.br + list.append( 3 ); +.br + ... +.br + if ( !list.empty() ) { +.br + // OK, modify the first item +.br + int& i = list.first(); +.br + i = 18; +.br + } +.br + ... +.br + QValueList<double> dlist; +.br + double d = dlist.last(); // undefined +.br +.fi +.PP +Because QValueList is value-based there is no need to be careful about deleting items in the list. The list holds its own copies and will free them if the corresponding member or the list itself is deleted. You can force the list to free all of its items with clear(). +.PP +QValueList is shared implicitly, which means it can be copied in constant time, i.e. O(1). If multiple QValueList instances share the same data and one needs to modify its contents, this modifying instance makes a copy and modifies its private copy; therefore it does not affect the other instances; this takes O(n) time. This is often called "copy on write". If a QValueList is being used in a multi-threaded program, you must protect all access to the list. See QMutex. +.PP +There are several ways to insert items into the list. The prepend() and append() functions insert items at the beginning and the end of the list respectively. The insert() function comes in several flavors and can be used to add one or more items at specific positions within the list. +.PP +Items can also be removed from the list in several ways. There are several variants of the remove() function, which removes a specific item from the list. The remove() function will find and remove items according to a specific item value. +.PP +Lists can also be sorted using the Qt Template Library. For example with qHeapSort(): +.PP +Example: +.PP +.nf +.br + QValueList<int> list; +.br + list.append( 5 ); +.br + list.append( 8 ); +.br + list.append( 3 ); +.br + list.append( 4 ); +.br + qHeapSort( list ); +.br +.fi +.PP +See also QValueListIterator, Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QValueList::ConstIterator" +This iterator is an instantiation of QValueListConstIterator for the same type as this QValueList. In other words, if you instantiate QValueList<int>, ConstIterator is a QValueListConstIterator<int>. Several member function use it, such as QValueList::begin(), which returns an iterator pointing to the first item in the list. +.PP +Functionally, this is almost the same as Iterator. The only difference is you cannot use ConstIterator for non-const operations, and that the compiler can often generate better code if you use ConstIterator. +.PP +See also QValueListIterator and Iterator. +.SH "QValueList::Iterator" +This iterator is an instantiation of QValueListIterator for the same type as this QValueList. In other words, if you instantiate QValueList<int>, Iterator is a QValueListIterator<int>. Several member function use it, such as QValueList::begin(), which returns an iterator pointing to the first item in the list. +.PP +Functionally, this is almost the same as ConstIterator. The only difference is that you cannot use ConstIterator for non-const operations, and that the compiler can often generate better code if you use ConstIterator. +.PP +See also QValueListIterator and ConstIterator. +.SH "QValueList::const_iterator" +The list's const iterator type, QValueListConstIterator. +.SH "QValueList::const_pointer" +The const pointer to T type. +.SH "QValueList::const_reference" +The const reference to T type. +.SH "QValueList::iterator" +The list's iterator type, QValueListIterator. +.SH "QValueList::pointer" +The pointer to T type. +.SH "QValueList::reference" +The reference to T type. +.SH "QValueList::size_type" +An unsigned integral type, used to represent various sizes. +.SH "QValueList::value_type" +The type of the object stored in the list, T. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QValueList::QValueList ()" +Constructs an empty list. +.SH "QValueList::QValueList ( const QValueList<T> & l )" +Constructs a copy of \fIl\fR. +.PP +This operation takes O(1) time because QValueList is implicitly shared. +.PP +The first modification to a list will take O(n) time. +.SH "QValueList::QValueList ( const std::list<T> & l )" +Contructs a copy of \fIl\fR. +.PP +This constructor is provided for compatibility with STL containers. +.SH "QValueList::~QValueList ()" +Destroys the list. References to the values in the list and all iterators of this list become invalidated. Note that it is impossible for an iterator to check whether or not it is valid: QValueList is highly tuned for performance, not for error checking. +.SH "iterator QValueList::append ( const T & x )" +Inserts \fIx\fR at the end of the list. +.PP +See also insert() and prepend(). +.PP +Examples: +.)l checklists/checklists.cpp and fonts/simple-qfont-demo/viewer.cpp. +.SH "const_iterator QValueList::at ( size_type i ) const" +Returns an iterator pointing to the item at position \fIi\fR in the list, or an undefined value if the index is out of range. +.PP +\fBWarning:\fR This function uses a linear search and can be extremely slow for large lists. QValueList is not optimized for random item access. If you need random access use a different container, such as QValueVector. +.SH "iterator QValueList::at ( size_type i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an iterator pointing to the item at position \fIi\fR in the list, or an undefined value if the index is out of range. +.SH "reference QValueList::back ()" +Returns a reference to the last item. If the list contains no last item (i.e. empty() returns TRUE), the return value is undefined. +.PP +This function is provided for STL compatibility. It is equivalent to last(). +.PP +See also front(). +.SH "const_reference QValueList::back () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "const_iterator QValueList::begin () const" +Returns an iterator pointing to the first item in the list. This iterator equals end() if the list is empty. +.PP +See also first(), end(), and constBegin(). +.PP +Examples: +.)l canvas/canvas.cpp, chart/canvasview.cpp, chart/element.cpp, checklists/checklists.cpp, sql/overview/insert/main.cpp, table/statistics/statistics.cpp, and themes/themes.cpp. +.SH "iterator QValueList::begin ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an iterator pointing to the first item in the list. This iterator equals end() if the list is empty. +.PP +See also first() and end(). +.SH "void QValueList::clear ()" +Removes all items from the list. +.PP +See also remove(). +.SH "const_iterator QValueList::constBegin () const" +Returns an iterator pointing to the first item in the list. This iterator equals constEnd() if the list is empty. +.PP +See also begin(). +.SH "const_iterator QValueList::constEnd () const" +Returns an iterator pointing \fIpast\fR the last item in the list. This iterator equals constBegin() if the list is empty. +.PP +See also end(). +.SH "size_type QValueList::contains ( const T & x ) const" +Returns the number of occurrences of the value \fIx\fR in the list. +.SH "size_type QValueList::count () const" +Returns the number of items in the list. +.PP +See also isEmpty(). +.PP +Examples: +.)l chart/element.cpp, fileiconview/qfileiconview.cpp, and table/statistics/statistics.cpp. +.SH "bool QValueList::empty () const" +Returns TRUE if the list contains no items; otherwise returns FALSE. +.PP +See also size(). +.SH "iterator QValueList::end ()" +Returns an iterator pointing \fIpast\fR the last item in the list. This iterator equals begin() if the list is empty. +.PP +See also last(), begin(), and constEnd(). +.PP +Examples: +.)l canvas/canvas.cpp, chart/canvasview.cpp, chart/element.cpp, checklists/checklists.cpp, sql/overview/insert/main.cpp, table/statistics/statistics.cpp, and themes/themes.cpp. +.SH "const_iterator QValueList::end () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an iterator pointing \fIpast\fR the last item in the list. This iterator equals begin() if the list is empty. +.PP +See also last() and begin(). +.SH "iterator QValueList::erase ( iterator it )" +Removes the item pointed to by \fIit\fR from the list. No iterators other than \fIit\fR or other iterators pointing at the same item as \fIit\fR are invalidated. Returns an iterator to the next item after \fIit\fR, or end() if there is no such item. +.PP +This function is provided for STL compatibility. It is equivalent to remove(). +.SH "iterator QValueList::erase ( iterator first, iterator last )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Deletes all items from \fIfirst\fR to \fIlast\fR (not including \fIlast\fR). No iterators are invalidated, except those pointing to the removed items themselves. Returns \fIlast\fR. +.SH "iterator QValueList::find ( const T & x )" +Returns an iterator pointing to the first occurrence of \fIx\fR in the list. +.PP +Returns end() is no item matched. +.SH "const_iterator QValueList::find ( const T & x ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an iterator pointing to the first occurrence of \fIx\fR in the list. +.PP +Returns end() if no item matched. +.SH "iterator QValueList::find ( iterator it, const T & x )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of \fIx\fR in the list starting at the position given by \fIit\fR. +.PP +Returns end() if no item matched. +.SH "const_iterator QValueList::find ( const_iterator it, const T & x ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Finds the first occurrence of \fIx\fR in the list starting at the position given by \fIit\fR. +.PP +Returns end() if no item matched. +.SH "int QValueList::findIndex ( const T & x ) const" +Returns the index of the first occurrence of the value \fIx\fR. Returns -1 if no item matched. +.SH "T & QValueList::first ()" +Returns a reference to the first item. If the list contains no first item (i.e. isEmpty() returns TRUE), the return value is undefined. +.PP +See also last(). +.PP +Example: network/mail/smtp.cpp. +.SH "const T & QValueList::first () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "const_iterator QValueList::fromLast () const" +Returns an iterator to the last item in the list, or end() if there is no last item. +.PP +Use the end() function instead. For example: +.PP +.nf +.br + QValueList<int> l; +.br + ... +.br + QValueList<int>::iterator it = l.end(); +.br + --it; +.br + if ( it != end() ) +.br + // ... +.br +.fi +.SH "iterator QValueList::fromLast ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns an iterator to the last item in the list, or end() if there is no last item. +.PP +Use the end() function instead. For example: +.PP +.nf +.br + QValueList<int> l; +.br + ... +.br + QValueList<int>::iterator it = l.end(); +.br + --it; +.br + if ( it != end() ) +.br + // ... +.br +.fi +.SH "reference QValueList::front ()" +Returns a reference to the first item. If the list contains no first item (i.e. empty() returns TRUE), the return value is undefined. +.PP +This function is provided for STL compatibility. It is equivalent to first(). +.PP +See also back(). +.SH "const_reference QValueList::front () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "iterator QValueList::insert ( iterator it, const T & x )" +Inserts the value \fIx\fR in front of the item pointed to by the iterator, \fIit\fR. +.PP +Returns an iterator pointing at the inserted item. +.PP +See also append() and prepend(). +.PP +Example: themes/themes.cpp. +.SH "void QValueList::insert ( iterator pos, size_type n, const T & x )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIn\fR copies of \fIx\fR before position \fIpos\fR. +.SH "bool QValueList::isEmpty () const" +Returns TRUE if the list contains no items; otherwise returns FALSE. +.PP +See also count(). +.PP +Examples: +.)l fonts/simple-qfont-demo/viewer.cpp and network/mail/smtp.cpp. +.SH "T & QValueList::last ()" +Returns a reference to the last item. If the list contains no last item (i.e. empty() returns TRUE), the return value is undefined. +.SH "const T & QValueList::last () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "bool QValueList::operator!= ( const QValueList<T> & l ) const" +Compares both lists. +.PP +Returns TRUE if this list and \fIl\fR are unequal; otherwise returns FALSE. +.SH "QValueList<T> QValueList::operator+ ( const QValueList<T> & l ) const" +Creates a new list and fills it with the items of this list. Then the items of \fIl\fR are appended. Returns the new list. +.SH "QValueList<T> & QValueList::operator+= ( const QValueList<T> & l )" +Appends the items of \fIl\fR to this list. Returns a reference to this list. +.SH "QValueList<T> & QValueList::operator+= ( const T & x )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Appends the value \fIx\fR to the list. Returns a reference to the list. +.SH "QValueList<T> & QValueList::operator<< ( const T & x )" +Adds the value \fIx\fR to the end of the list. +.PP +Returns a reference to the list. +.SH "QValueList<T> & QValueList::operator= ( const QValueList<T> & l )" +Assigns \fIl\fR to this list and returns a reference to this list. +.PP +All iterators of the current list become invalidated by this operation. The cost of such an assignment is O(1) since QValueList is implicitly shared. +.SH "QValueList<T> & QValueList::operator= ( const std::list<T> & l )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns the contents of \fIl\fR to the list. +.PP +All iterators of the current list become invalidated by this operation. +.SH "bool QValueList::operator== ( const QValueList<T> & l ) const" +Compares both lists. +.PP +Returns TRUE if this list and \fIl\fR are equal; otherwise returns FALSE. +.SH "bool QValueList::operator== ( const std::list<T> & l ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if this list and \fIl\fR are equal; otherwise returns FALSE. +.PP +This operator is provided for compatibility with STL containers. +.SH "const T & QValueList::operator[] ( size_type i ) const" +Returns a const reference to the item with index \fIi\fR in the list. It is up to you to check whether this item really exists. You can do that easily with the count() function. However this operator does not check whether \fIi\fR is in range and will deliver undefined results if it does not exist. +.PP +\fBWarning:\fR This function uses a linear search and can be extremely slow for large lists. QValueList is not optimized for random item access. If you need random access use a different container, such as QValueVector. +.SH "T & QValueList::operator[] ( size_type i )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a non-const reference to the item with index \fIi\fR. +.SH "void QValueList::pop_back ()" +Removes the last item. If there is no last item, this operation is undefined. +.PP +This function is provided for STL compatibility. +.SH "void QValueList::pop_front ()" +Removes the first item. If there is no first item, this operation is undefined. +.PP +This function is provided for STL compatibility. +.SH "iterator QValueList::prepend ( const T & x )" +Inserts \fIx\fR at the beginning of the list. +.PP +See also insert() and append(). +.SH "void QValueList::push_back ( const T & x )" +Inserts \fIx\fR at the end of the list. +.PP +This function is provided for STL compatibility. It is equivalent to append(). +.SH "void QValueList::push_front ( const T & x )" +Inserts \fIx\fR at the beginning of the list. +.PP +This function is provided for STL compatibility. It is equivalent to prepend(). +.PP +Example: toplevel/options.ui.h. +.SH "iterator QValueList::remove ( iterator it )" +Removes the item pointed to by \fIit\fR from the list. No iterators other than \fIit\fR or other iterators pointing at the same item as \fIit\fR are invalidated. Returns an iterator to the next item after \fIit\fR, or end() if there is no such item. +.PP +See also clear(). +.SH "uint QValueList::remove ( const T & x )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes all items that have value \fIx\fR and returns the number of removed items. +.SH "size_type QValueList::size () const" +Returns the number of items in the list. +.PP +This function is provided for STL compatibility. It is equivalent to count(). +.PP +See also empty(). +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QValueList<T> & l )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Writes a list, \fIl\fR, to the stream \fIs\fR. The type T stored in the list must implement the streaming operator. +.SH "QDataStream & operator>> ( QDataStream & s, QValueList<T> & l )" +Reads a list, \fIl\fR, from the stream \fIs\fR. The type T stored in the +list must implement the streaming operator. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvaluelist.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvaluelist.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvaluelistconstiterator.3qt b/doc/man/man3/tqvaluelistconstiterator.3qt new file mode 100644 index 000000000..95ad95ade --- /dev/null +++ b/doc/man/man3/tqvaluelistconstiterator.3qt @@ -0,0 +1,127 @@ +'\" t +.TH QValueListConstIterator 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 +QValueListConstIterator \- Const iterator for QValueList +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqvaluelist.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef T \fBvalue_type\fR" +.br +.ti -1c +.BI "typedef const T * \fBpointer\fR" +.br +.ti -1c +.BI "typedef const T & \fBreference\fR" +.br +.ti -1c +.BI "\fBQValueListConstIterator\fR ()" +.br +.ti -1c +.BI "\fBQValueListConstIterator\fR ( const QValueListConstIterator<T> & it )" +.br +.ti -1c +.BI "\fBQValueListConstIterator\fR ( const QValueListIterator<T> & it )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QValueListConstIterator<T> & it ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QValueListConstIterator<T> & it ) const" +.br +.ti -1c +.BI "const T & \fBoperator*\fR () const" +.br +.ti -1c +.BI "QValueListConstIterator<T> & \fBoperator++\fR ()" +.br +.ti -1c +.BI "QValueListConstIterator<T> \fBoperator++\fR ( int )" +.br +.ti -1c +.BI "QValueListConstIterator<T> & \fBoperator--\fR ()" +.br +.ti -1c +.BI "QValueListConstIterator<T> \fBoperator--\fR ( int )" +.br +.in -1c +.SH DESCRIPTION +The QValueListConstIterator class provides a const iterator for QValueList. +.PP +In contrast to QValueListIterator, this class is used to iterate over a const list. It does not allow modification of the values of the list since that would break const semantics. +.PP +You can create the appropriate const iterator type by using the \fCconst_iterator\fR typedef provided by QValueList. +.PP +For more information on QValueList iterators, see QValueListIterator. +.PP +See also QValueListIterator, QValueList, Qt Template Library Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QValueListConstIterator::pointer" +Pointer to value_type. +.SH "QValueListConstIterator::reference" +Reference to value_type. +.SH "QValueListConstIterator::value_type" +The type of value. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QValueListConstIterator::QValueListConstIterator ()" +Creates un uninitialized iterator. +.SH "QValueListConstIterator::QValueListConstIterator ( const QValueListConstIterator<T> & it )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a copy of the iterator \fIit\fR. +.SH "QValueListConstIterator::QValueListConstIterator ( const QValueListIterator<T> & it )" +Constructs a copy of the iterator \fIit\fR. +.SH "bool QValueListConstIterator::operator!= ( const QValueListConstIterator<T> & it ) const" +Compares this iterator with \fIit\fR and returns TRUE if they point to different items; otherwise returns FALSE. +.SH "const T & QValueListConstIterator::operator* () const" +Asterisk operator. Returns a reference to the current iterator item. +.SH "QValueListConstIterator<T> & QValueListConstIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. +.SH "QValueListConstIterator<T> QValueListConstIterator::operator++ ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. +.SH "QValueListConstIterator<T> & QValueListConstIterator::operator-- ()" +Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. +.SH "QValueListConstIterator<T> QValueListConstIterator::operator-- ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. +.SH "bool QValueListConstIterator::operator== ( const QValueListConstIterator<T> & it ) const" +Compares this iterator with \fIit\fR and returns TRUE if they point +to the same item; otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qvaluelistconstiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvaluelistconstiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvaluelistiterator.3qt b/doc/man/man3/tqvaluelistiterator.3qt new file mode 100644 index 000000000..1bc1c263d --- /dev/null +++ b/doc/man/man3/tqvaluelistiterator.3qt @@ -0,0 +1,172 @@ +'\" t +.TH QValueListIterator 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 +QValueListIterator \- Iterator for QValueList +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqvaluelist.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef T \fBvalue_type\fR" +.br +.ti -1c +.BI "typedef T * \fBpointer\fR" +.br +.ti -1c +.BI "typedef T & \fBreference\fR" +.br +.ti -1c +.BI "\fBQValueListIterator\fR ()" +.br +.ti -1c +.BI "\fBQValueListIterator\fR ( const QValueListIterator<T> & it )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QValueListIterator<T> & it ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QValueListIterator<T> & it ) const" +.br +.ti -1c +.BI "const T & \fBoperator*\fR () const" +.br +.ti -1c +.BI "T & \fBoperator*\fR ()" +.br +.ti -1c +.BI "QValueListIterator<T> & \fBoperator++\fR ()" +.br +.ti -1c +.BI "QValueListIterator<T> \fBoperator++\fR ( int )" +.br +.ti -1c +.BI "QValueListIterator<T> & \fBoperator--\fR ()" +.br +.ti -1c +.BI "QValueListIterator<T> \fBoperator--\fR ( int )" +.br +.ti -1c +.BI "QValueListIterator<T> & \fBoperator+=\fR ( int j )" +.br +.ti -1c +.BI "QValueListIterator<T> & \fBoperator-=\fR ( int j )" +.br +.in -1c +.SH DESCRIPTION +The QValueListIterator class provides an iterator for QValueList. +.PP +An iterator is a class for accessing the items of a container class: a generalization of the index in an array. A pointer into a "const char *" and an index into an "int[]" are both iterators, and the general idea is to provide that functionality for any data structure. +.PP +The QValueListIterator class is an iterator for QValueList instantiations. You can create the appropriate iterator type by using the \fCiterator\fR typedef provided by QValueList. +.PP +The only way to access the items in a QValueList is to use an iterator. +.PP +Example (see QValueList for the complete code): +.PP +.nf +.br + EmployeeList::iterator it; +.br + for ( it = list.begin(); it != list.end(); ++it ) +.br + cout << (*it).surname().latin1() << ", " << +.br + (*it).forename().latin1() << " earns " << +.br + (*it).salary() << endl; +.br +.br + // Output: +.br + // Doe, John earns 50000 +.br + // Williams, Jane earns 80000 +.br + // Hawthorne, Mary earns 90000 +.br + // Jones, Tom earns 60000 +.br +.fi +.PP +QValueList is highly optimized for performance and memory usage. This means that you must be careful: QValueList does not know about all its iterators and the iterators don't know to which list they belong. This makes things very fast, but if you're not careful, you can get spectacular bugs. Always make sure iterators are valid before dereferencing them or using them as parameters to generic algorithms in the STL or the QTL. +.PP +Using an invalid iterator is undefined (your application will probably crash). Many Qt functions return const value lists; to iterate over these you should make a copy and iterate over the copy. +.PP +For every Iterator there is a ConstIterator. When accessing a QValueList in a const environment or if the reference or pointer to the list is itself const, then you must use the ConstIterator. Its semantics are the same as the Iterator, but it only returns const references. +.PP +See also QValueList, QValueListConstIterator, Qt Template Library Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QValueListIterator::pointer" +Pointer to value_type. +.SH "QValueListIterator::reference" +Reference to value_type. +.SH "QValueListIterator::value_type" +The type of value, T. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QValueListIterator::QValueListIterator ()" +Creates un uninitialized iterator. +.SH "QValueListIterator::QValueListIterator ( const QValueListIterator<T> & it )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a copy of the iterator \fIit\fR. +.SH "bool QValueListIterator::operator!= ( const QValueListIterator<T> & it ) const" +Compares this iterator and \fIit\fR and returns TRUE if they point to different items; otherwise returns FALSE. +.SH "T & QValueListIterator::operator* ()" +Asterisk operator. Returns a reference to the current iterator item. +.SH "const T & QValueListIterator::operator* () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Asterisk operator. Returns a reference to the current iterator item. +.SH "QValueListIterator<T> & QValueListIterator::operator++ ()" +Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. +.SH "QValueListIterator<T> QValueListIterator::operator++ ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator returned by end() causes undefined results. +.SH "QValueListIterator<T> & QValueListIterator::operator+= ( int j )" +Postfix -- jumps \fIj\fR steps forward in the list. The iterator cannot check whether it reached the end of the list. Jumping past the end() causes undefined results. +.SH "QValueListIterator<T> & QValueListIterator::operator-- ()" +Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. +.SH "QValueListIterator<T> QValueListIterator::operator-- ( int )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator returned by begin() causes undefined results. +.SH "QValueListIterator<T> & QValueListIterator::operator-= ( int j )" +Postfix -- jumps \fIj\fR steps backward in the list. The iterator cannot check whether it reached the beginning of the list. Jumping past begin() causes undefined results. +.SH "bool QValueListIterator::operator== ( const QValueListIterator<T> & it ) const" +Compares this iterator and \fIit\fR and returns TRUE if they point to +the same item; otherwise returns FALSE. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qvaluelistiterator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvaluelistiterator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvaluestack.3qt b/doc/man/man3/tqvaluestack.3qt new file mode 100644 index 000000000..4d35ab181 --- /dev/null +++ b/doc/man/man3/tqvaluestack.3qt @@ -0,0 +1,141 @@ +'\" t +.TH QValueStack 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 +QValueStack \- Value-based template class that provides a stack +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqvaluestack.h>\fR +.PP +Inherits QValueList<T>. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQValueStack\fR ()" +.br +.ti -1c +.BI "\fB~QValueStack\fR ()" +.br +.ti -1c +.BI "void \fBpush\fR ( const T & d )" +.br +.ti -1c +.BI "T \fBpop\fR ()" +.br +.ti -1c +.BI "T & \fBtop\fR ()" +.br +.ti -1c +.BI "const T & \fBtop\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QValueStack class is a value-based template class that provides a stack. +.PP +Define a template instance QValueStack<X> to create a stack of values that all have the class X. QValueStack is part of the Qt Template Library. +.PP +Note that QValueStack does not store pointers to the members of the stack; it holds a copy of every member. That is why these kinds of classes are called "value based"; QPtrStack, QPtrList, QDict, etc., are "pointer based". +.PP +A stack is a last in, first out (LIFO) structure. Items are added to the top of the stack with push() and retrieved from the top with pop(). The top() function provides access to the topmost item without removing it. +.PP +Example: +.PP +.nf +.br + QValueStack<int> stack; +.br + stack.push( 1 ); +.br + stack.push( 2 ); +.br + stack.push( 3 ); +.br + while ( ! stack.isEmpty() ) +.br + cout << "Item: " << stack.pop() << endl; +.br +.br + // Output: +.br + // Item: 3 +.br + // Item: 2 +.br + // Item: 1 +.br +.fi +.PP +QValueStack is a specialized QValueList provided for convenience. All of QValueList's functionality also applies to QPtrStack, for example the facility to iterate over all elements using QValueStack<T>::Iterator. See QValueListIterator for further details. +.PP +Some classes cannot be used within a QValueStack, for example everything derived from QObject and thus all classes that implement widgets. Only values can be used in a QValueStack. To qualify as a value, the class must provide +.TP +a copy constructor; +.TP +an assignment operator; +.TP +a default constructor, i.e. a constructor that does not take any arguments. +.PP +Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. +.PP +See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QValueStack::QValueStack ()" +Constructs an empty stack. +.SH "QValueStack::~QValueStack ()" +Destroys the stack. References to the values in the stack and all iterators of this stack become invalidated. Because QValueStack is highly tuned for performance, you won't see warnings if you use invalid iterators because it is impossible for an iterator to check whether or not it is valid. +.SH "T QValueStack::pop ()" +Removes the top item from the stack and returns it. +.PP +See also top() and push(). +.SH "void QValueStack::push ( const T & d )" +Adds element, \fId\fR, to the top of the stack. Last in, first out. +.PP +This function is equivalent to append(). +.PP +See also pop() and top(). +.SH "T & QValueStack::top ()" +Returns a reference to the top item of the stack or the item referenced by end() if no such item exists. Note that you must not change the value the end() iterator points to. +.PP +This function is equivalent to last(). +.PP +See also pop(), push(), and QValueList::fromLast(). +.SH "const T & QValueStack::top () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a reference to the top item of the stack or the item referenced by end() if no such item exists. +.PP +This function is equivalent to last(). +.PP +See also pop(), push(), and QValueList::fromLast(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvaluestack.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvaluestack.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvaluevector.3qt b/doc/man/man3/tqvaluevector.3qt new file mode 100644 index 000000000..578e4fdc3 --- /dev/null +++ b/doc/man/man3/tqvaluevector.3qt @@ -0,0 +1,635 @@ +'\" t +.TH QValueVector 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 +QValueVector \- Value-based template class that provides a dynamic array +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqvaluevector.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef T \fBvalue_type\fR" +.br +.ti -1c +.BI "typedef value_type * \fBpointer\fR" +.br +.ti -1c +.BI "typedef const value_type * \fBconst_pointer\fR" +.br +.ti -1c +.BI "typedef value_type * \fBiterator\fR" +.br +.ti -1c +.BI "typedef const value_type * \fBconst_iterator\fR" +.br +.ti -1c +.BI "typedef value_type & \fBreference\fR" +.br +.ti -1c +.BI "typedef const value_type & \fBconst_reference\fR" +.br +.ti -1c +.BI "typedef size_t \fBsize_type\fR" +.br +.ti -1c +.BI "typedef ptrdiff_t \fBdifference_type\fR" +.br +.ti -1c +.BI "\fBQValueVector\fR ()" +.br +.ti -1c +.BI "\fBQValueVector\fR ( const QValueVector<T> & v )" +.br +.ti -1c +.BI "\fBQValueVector\fR ( size_type n, const T & val = T ( ) )" +.br +.ti -1c +.BI "\fBQValueVector\fR ( std::vector<T> & v )" +.br +.ti -1c +.BI "\fBQValueVector\fR ( const std::vector<T> & v )" +.br +.ti -1c +.BI "\fB~QValueVector\fR ()" +.br +.ti -1c +.BI "QValueVector<T> & \fBoperator=\fR ( const QValueVector<T> & v )" +.br +.ti -1c +.BI "QValueVector<T> & \fBoperator=\fR ( const std::vector<T> & v )" +.br +.ti -1c +.BI "size_type \fBsize\fR () const" +.br +.ti -1c +.BI "bool \fBempty\fR () const" +.br +.ti -1c +.BI "size_type \fBcapacity\fR () const" +.br +.ti -1c +.BI "iterator \fBbegin\fR ()" +.br +.ti -1c +.BI "const_iterator \fBbegin\fR () const" +.br +.ti -1c +.BI "const_iterator \fBconstBegin\fR () const" +.br +.ti -1c +.BI "iterator \fBend\fR ()" +.br +.ti -1c +.BI "const_iterator \fBend\fR () const" +.br +.ti -1c +.BI "const_iterator \fBconstEnd\fR () const" +.br +.ti -1c +.BI "reference \fBat\fR ( size_type i, bool * ok = 0 )" +.br +.ti -1c +.BI "const_reference \fBat\fR ( size_type i, bool * ok = 0 ) const" +.br +.ti -1c +.BI "reference \fBoperator[]\fR ( size_type i )" +.br +.ti -1c +.BI "const_reference \fBoperator[]\fR ( size_type i ) const" +.br +.ti -1c +.BI "reference \fBfront\fR ()" +.br +.ti -1c +.BI "const_reference \fBfront\fR () const" +.br +.ti -1c +.BI "reference \fBback\fR ()" +.br +.ti -1c +.BI "const_reference \fBback\fR () const" +.br +.ti -1c +.BI "void \fBpush_back\fR ( const T & x )" +.br +.ti -1c +.BI "void \fBpop_back\fR ()" +.br +.ti -1c +.BI "iterator \fBinsert\fR ( iterator pos, const T & x )" +.br +.ti -1c +.BI "iterator \fBinsert\fR ( iterator pos, size_type n, const T & x )" +.br +.ti -1c +.BI "void \fBreserve\fR ( size_type n )" +.br +.ti -1c +.BI "void \fBresize\fR ( size_type n, const T & val = T ( ) )" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "iterator \fBerase\fR ( iterator pos )" +.br +.ti -1c +.BI "iterator \fBerase\fR ( iterator first, iterator last )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QValueVector<T> & x )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QValueVector<T> & x ) const" +.br +.ti -1c +.BI "typedef T \fBValueType\fR" +.br +.ti -1c +.BI "typedef ValueType * \fBIterator\fR" +.br +.ti -1c +.BI "typedef const ValueType * \fBConstIterator\fR" +.br +.ti -1c +.BI "size_type \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "reference \fBfirst\fR ()" +.br +.ti -1c +.BI "const_reference \fBfirst\fR () const" +.br +.ti -1c +.BI "reference \fBlast\fR ()" +.br +.ti -1c +.BI "const_reference \fBlast\fR () const" +.br +.ti -1c +.BI "void \fBappend\fR ( const T & x )" +.br +.in -1c +.SH DESCRIPTION +The QValueVector class is a value-based template class that provides a dynamic array. +.PP +QValueVector is a Qt implementation of an STL-like vector container. It can be used in your application if the standard \fCvector\fR is not available for your target platforms. QValueVector is part of the Qt Template Library. +.PP +QValueVector<T> defines a template instance to create a vector of values that all have the class T. QValueVector does not store pointers to the members of the vector; it holds a copy of every member. QValueVector is said to be value based; in contrast, QPtrList and QDict are pointer based. +.PP +QValueVector contains and manages a collection of objects of type T and provides random access iterators that allow the contained objects to be addressed. QValueVector owns the contained elements. For more relaxed ownership semantics, see QPtrCollection and friends, which are pointer-based containers. +.PP +QValueVector provides good performance if you append or remove elements from the end of the vector. If you insert or remove elements from anywhere but the end, performance is very bad. The reason for this is that elements must to be copied into new positions. +.PP +Some classes cannot be used within a QValueVector: for example, all classes derived from QObject and thus all classes that implement widgets. Only values can be used in a QValueVector. To qualify as a value the class must provide: +.TP +a copy constructor; +.TP +an assignment operator; +.TP +a default constructor, i.e., a constructor that does not take any arguments. +.PP +Note that C++ defaults to field-by-field assignment operators and copy constructors if no explicit version is supplied. In many cases this is sufficient. +.PP +QValueVector uses an STL-like syntax to manipulate and address the objects it contains. See this document for more information. +.PP +Example: +.PP +.nf +.br + #include <ntqvaluevector.h> +.br + #include <ntqstring.h> +.br + #include <stdio.h> +.br +.br + class Employee +.br + { +.br + public: +.br + Employee(): s(0) {} +.br + Employee( const QString& name, int salary ) +.br + : n( name ), s( salary ) +.br + { } +.br +.br + QString name() const { return n; } +.br + int salary() const { return s; } +.br + void setSalary( int salary ) { s = salary; } +.br + private: +.br + QString n; +.br + int s; +.br + }; +.br +.br + int main() +.br + { +.br + typedef QValueVector<Employee> EmployeeVector; +.br + EmployeeVector vec( 3 ); // vector of 3 Employees +.br +.br + vec[0] = Employee( "Bill", 50000 ); +.br + vec[1] = Employee( "Steve", 80000 ); +.br + vec[2] = Employee( "Ron", 60000 ); +.br +.br + Employee joe( "Joe", 50000 ); +.br + vec.push_back( joe ); // vector expands to accommodate 4 Employees +.br + joe.setSalary( 70000 ); +.br +.br +.br + EmployeeVector::iterator it; +.br + for( it = vec.begin(); it != vec.end(); ++it ) +.br + printf( "%s earns %d\\n", (*it).name().latin1(), (*it).salary() ); +.br +.br + return 0; +.br + } +.br +.fi +.PP +Program output: +.PP +.nf +.br + Bill earns 50000 +.br + Steve earns 80000 +.br + Ron earns 60000 +.br + Joe earns 50000 +.br +.fi +.PP +As you can see, the most recent change to Joe's salary did not affect the value in the vector because the vector created a copy of Joe's entry. +.PP +Many Qt functions return const value vectors; to iterate over these you should make a copy and iterate over the copy. +.PP +There are several ways to find items in the vector. The begin() and end() functions return iterators to the beginning and end of the vector. The advantage of getting an iterator is that you can move forward or backward from this position by incrementing/decrementing the iterator. The iterator returned by end() points to the element which is one past the last element in the container. The past-the-end iterator is still associated with the vector it belongs to, however it is \fInot\fR dereferenceable; operator*() will not return a well-defined value. If the vector is empty(), the iterator returned by begin() will equal the iterator returned by end(). +.PP +The fastest way to access an element of a vector is by using operator[]. This function provides random access and will return a reference to the element located at the specified index. Thus, you can access every element directly, in constant time, providing you know the location of the element. It is undefined to access an element that does not exist (your application will probably crash). For example: +.PP +.nf +.br + QValueVector<int> vec1; // an empty vector +.br + vec1[10] = 4; // WARNING: undefined, probably a crash +.br +.br + QValueVector<QString> vec2(25); // initialize with 25 elements +.br + vec2[10] = "Dave"; // OK +.br +.fi +.PP +Whenever inserting, removing or referencing elements in a vector, always make sure you are referring to valid positions. For example: +.PP +.nf +.br + void func( QValueVector<int>& vec ) +.br + { +.br + if ( vec.size() > 10 ) { +.br + vec[9] = 99; // OK +.br + } +.br + }; +.br +.fi +.PP +The iterators provided by vector are random access iterators, therefore you can use them with many generic algorithms, for example, algorithms provided by the STL or the QTL. +.PP +Another way to find an element in the vector is by using the std::find() or tqFind() algorithms. For example: +.PP +.nf +.br + QValueVector<int> vec; +.br + ... +.br + QValueVector<int>::const_iterator it = tqFind( vec.begin(), vec.end(), 3 ); +.br + if ( it != vector.end() ) +.br + // 'it' points to the found element +.br +.fi +.PP +It is safe to have multiple iterators on the vector at the same time. Since QValueVector manages memory dynamically, all iterators can become invalid if a memory reallocation occurs. For example, if some member of the vector is removed, iterators that point to the removed element and to all following elements become invalidated. Inserting into the middle of the vector will invalidate all iterators. For convenience, the function back() returns a reference to the last element in the vector, and front() returns a reference to the first element. If the vector is empty(), both back() and front() have undefined behavior (your application will crash or do unpredictable things). Use back() and front() with caution, for example: +.PP +.nf +.br + QValueVector<int> vec( 3 ); +.br + vec.push_back( 1 ); +.br + vec.push_back( 2 ); +.br + vec.push_back( 3 ); +.br + ... +.br + if ( !vec.empty() ) { +.br + // OK: modify the first element +.br + int& i = vec.front(); +.br + i = 18; +.br + } +.br + ... +.br + QValueVector<double> dvec; +.br + double d = dvec.back(); // undefined behavior +.br +.fi +.PP +Because QValueVector manages memory dynamically, it is recommended that you contruct a vector with an initial size. Inserting and removing elements happens fastest when: +.TP +Inserting or removing elements happens at the end() of the vector; +.TP +The vector does not need to allocate additional memory. +.PP +By creating a QValueVector with a sufficiently large initial size, there will be less memory allocations. Do not use an initial size that is too big, since it will still take time to construct all the empty entries, and the extra space will be wasted if it is never used. +.PP +Because QValueVector is value-based there is no need to be careful about deleting elements in the vector. The vector holds its own copies and will free them if the corresponding member or the vector itself is deleted. You can force the vector to free all of its items with clear(). +.PP +QValueVector is shared implicitly, which means it can be copied in constant time. If multiple QValueVector instances share the same data and one needs to modify its contents, this modifying instance makes a copy and modifies its private copy; it thus does not affect the other instances. This is often called "copy on write". If a QValueVector is being used in a multi-threaded program, you must protect all access to the vector. See QMutex. +.PP +There are several ways to insert elements into the vector. The push_back() function insert elements into the end of the vector, and is usually fastest. The insert() function can be used to add elements at specific positions within the vector. +.PP +Items can be also be removed from the vector in several ways. There are several variants of the erase() function which removes a specific element, or range of elements, from the vector. +.PP +Vectors can be also sorted with various STL algorithms , or it can be sorted using the Qt Template Library. For example with qHeapSort(): +.PP +Example: +.PP +.nf +.br + QValueVector<int> v( 4 ); +.br + v.push_back( 5 ); +.br + v.push_back( 8 ); +.br + v.push_back( 3 ); +.br + v.push_back( 4 ); +.br + qHeapSort( v ); +.br +.fi +.PP +QValueVector stores its elements in contiguous memory. This means that you can use a QValueVector in any situation that requires an array. +.PP +See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QValueVector::ConstIterator" +The vector's const iterator type. +.SH "QValueVector::Iterator" +The vector's iterator type. +.SH "QValueVector::ValueType" +The type of the object stored in the vector. +.SH "QValueVector::const_iterator" +The vector's const iterator type. +.SH "QValueVector::const_pointer" +The const pointer to T type. +.SH "QValueVector::const_reference" +The const reference to T type. +.SH "QValueVector::difference_type" +A signed integral type used to represent the distance between two iterators. +.SH "QValueVector::iterator" +The vector's iterator type. +.SH "QValueVector::pointer" +The pointer to T type. +.SH "QValueVector::reference" +The reference to T type. +.SH "QValueVector::size_type" +An unsigned integral type, used to represent various sizes. +.SH "QValueVector::value_type" +The type of the object stored in the vector. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QValueVector::QValueVector ()" +Constructs an empty vector without any elements. To create a vector which reserves an initial amount of space for elements, use \fCQValueVector(size_type n)\fR. +.SH "QValueVector::QValueVector ( const QValueVector<T> & v )" +Constructs a copy of \fIv\fR. +.PP +This operation costs O(1) time because QValueVector is implicitly shared. +.PP +The first modification to the vector does takes O(n) time, because the elements must be copied. +.SH "QValueVector::QValueVector ( size_type n, const T & val = T ( ) )" +Constructs a vector with an initial size of \fIn\fR elements. Each element is initialized with the value of \fIval\fR. +.SH "QValueVector::QValueVector ( std::vector<T> & v )" +Constructs a copy of \fIv\fR. +.SH "QValueVector::QValueVector ( const std::vector<T> & v )" +This operation costs O(n) time because \fIv\fR is copied. +.SH "QValueVector::~QValueVector ()" +Destroys the vector, destroying all elements and freeing the allocated memory. References to the values in the vector and all iterators of this vector become invalidated. Note that it is impossible for an iterator to check whether or not it is valid: QValueVector is tuned for performance, not for error checking. +.SH "void QValueVector::append ( const T & x )" +Appends a copy of \fIx\fR to the end of the vector. +.PP +See also push_back() and insert(). +.SH "reference QValueVector::at ( size_type i, bool * ok = 0 )" +Returns a reference to the element with index \fIi\fR. If \fIok\fR is non-null, and the index \fIi\fR is out of range, *\fIok\fR is set to FALSE and the returned reference is undefined. If the index \fIi\fR is within the range of the vector, and \fIok\fR is non-null, *\fIok\fR is set to TRUE and the returned reference is well defined. +.SH "const_reference QValueVector::at ( size_type i, bool * ok = 0 ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const reference to the element with index \fIi\fR. If \fIok\fR is non-null, and the index \fIi\fR is out of range, *\fIok\fR is set to FALSE and the returned reference is undefined. If the index \fIi\fR is within the range of the vector, and \fIok\fR is non-null, *\fIok\fR is set to TRUE and the returned reference is well defined. +.SH "reference QValueVector::back ()" +Returns a reference to the last element in the vector. If there is no last element, this function has undefined behavior. +.PP +See also empty() and front(). +.SH "const_reference QValueVector::back () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const reference to the last element in the vector. If there is no last element, this function has undefined behavior. +.PP +See also empty() and front(). +.SH "iterator QValueVector::begin ()" +Returns an iterator pointing to the beginning of the vector. If the vector is empty(), the returned iterator will equal end(). +.SH "const_iterator QValueVector::begin () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const iterator pointing to the beginning of the vector. If the vector is empty(), the returned iterator will equal end(). +.SH "size_type QValueVector::capacity () const" +Returns the maximum number of elements that can be stored in the vector without forcing memory reallocation. If memory reallocation takes place, some or all iterators may become invalidated. +.SH "void QValueVector::clear ()" +Removes all the elements from the vector. +.SH "const_iterator QValueVector::constBegin () const" +Returns a const iterator pointing to the beginning of the vector. If the vector is empty(), the returned iterator will equal end(). +.PP +See also constEnd(). +.SH "const_iterator QValueVector::constEnd () const" +Returns a const iterator pointing behind the last element of the vector. +.PP +See also constBegin(). +.SH "size_type QValueVector::count () const" +Returns the number of items in the vector. +.PP +See also isEmpty(). +.SH "bool QValueVector::empty () const" +Returns TRUE if the vector is empty; otherwise returns FALSE. Equivalent to size()==0, only faster. +.PP +This function is provided for STL compatibility. It is equivalent to isEmpty(). +.PP +See also size(). +.SH "iterator QValueVector::end ()" +Returns an iterator pointing behind the last element of the vector. +.SH "const_iterator QValueVector::end () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const iterator pointing behind the last element of the vector. +.SH "iterator QValueVector::erase ( iterator pos )" +Removes the element at position \fIpos\fR and returns the position of the next element. +.SH "iterator QValueVector::erase ( iterator first, iterator last )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Removes all elements from \fIfirst\fR up to but not including \fIlast\fR and returns the position of the next element. +.SH "reference QValueVector::first ()" +Returns a reference to the first item in the vector. If there is no first item, this function has undefined behavior. +.PP +See also empty() and last(). +.SH "const_reference QValueVector::first () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "reference QValueVector::front ()" +Returns a reference to the first element in the vector. If there is no first element, this function has undefined behavior. +.PP +See also empty() and back(). +.SH "const_reference QValueVector::front () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const reference to the first element in the vector. If there is no first element, this function has undefined behavior. +.PP +See also empty() and back(). +.SH "iterator QValueVector::insert ( iterator pos, const T & x )" +Inserts a copy of \fIx\fR at the position immediately before \fIpos\fR. +.PP +See also push_back(). +.SH "iterator QValueVector::insert ( iterator pos, size_type n, const T & x )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Inserts \fIn\fR copies of \fIx\fR immediately before position x. +.PP +See also push_back(). +.SH "bool QValueVector::isEmpty () const" +Returns TRUE if the vector is empty; returns FALSE otherwise. +.PP +See also count(). +.SH "reference QValueVector::last ()" +Returns a reference to the last item in the vector. If there is no last item, this function has undefined behavior. +.PP +See also empty() and first(). +.SH "const_reference QValueVector::last () const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.SH "QValueVector<T> & QValueVector::operator= ( const QValueVector<T> & v )" +Assigns \fIv\fR to this vector and returns a reference to this vector. +.PP +All iterators of the current vector become invalidated by this operation. The cost of such an assignment is O(1) since QValueVector is implicitly shared. +.SH "QValueVector<T> & QValueVector::operator= ( const std::vector<T> & v )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns \fIv\fR to this vector and returns a reference to this vector. +.PP +All iterators of the current vector become invalidated by this operation. The cost of this assignment is O(n) since \fIv\fR is copied. +.SH "bool QValueVector::operator== ( const QValueVector<T> & x ) const" +Returns TRUE if each element in this vector equals each corresponding element in \fIx\fR; otherwise returns FALSE. +.SH "bool QValueVector::operator== ( const QValueVector<T> & x )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns TRUE if each element in this vector equals each corresponding element in \fIx\fR; otherwise returns FALSE. +.SH "reference QValueVector::operator[] ( size_type i )" +Returns a reference to the element at index \fIi\fR. If \fIi\fR is out of range, this function has undefined behavior. +.PP +See also at(). +.SH "const_reference QValueVector::operator[] ( size_type i ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a const reference to the element at index \fIi\fR. If \fIi\fR is out of range, this function has undefined behavior. +.PP +See also at(). +.SH "void QValueVector::pop_back ()" +Removes the last item from the vector. +.PP +This function is provided for STL compatibility. +.SH "void QValueVector::push_back ( const T & x )" +Appends a copy of \fIx\fR to the end of the vector. This is the fastest way to add new elements. +.PP +This function is provided for STL compatibility. It is equivalent to append(). +.PP +See also insert(). +.SH "void QValueVector::reserve ( size_type n )" +Increases the vector's capacity. If \fIn\fR is less than or equal to capacity(), nothing happens. Otherwise, additional memory is allocated so that capacity() will be increased to a value greater than or equal to \fIn\fR. All iterators will then become invalidated. Note that the vector's size() and the values of existing elements remain unchanged. +.SH "void QValueVector::resize ( size_type n, const T & val = T ( ) )" +Changes the size of the vector to \fIn\fR. If \fIn\fR is greater than the current size(), elements are added to the end and initialized with the value of \fIval\fR. If \fIn\fR is less than size(), elements are removed from the end. If \fIn\fR is equal to size() nothing happens. +.SH "size_type QValueVector::size () const" +Returns the number of elements in the vector. +.PP +This function is provided for STL compatibility. It is equivalent to count(). +.PP +See also empty(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvaluevector.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvaluevector.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvariant.3qt b/doc/man/man3/tqvariant.3qt new file mode 100644 index 000000000..09bec059b --- /dev/null +++ b/doc/man/man3/tqvariant.3qt @@ -0,0 +1,1155 @@ +'\" t +.TH QVariant 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 +QVariant \- Acts like a union for the most common Qt data types +.SH SYNOPSIS +\fC#include <ntqvariant.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "enum \fBType\fR { Invalid, Map, List, String, StringList, Font, Pixmap, Brush, Rect, Size, Color, Palette, ColorGroup, IconSet, Point, Image, Int, UInt, Bool, Double, CString, PointArray, Region, Bitmap, Cursor, SizePolicy, Date, Time, DateTime, ByteArray, BitArray, KeySequence, Pen, LongLong, ULongLong }" +.br +.ti -1c +.BI "\fBQVariant\fR ()" +.br +.ti -1c +.BI "\fB~QVariant\fR ()" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QVariant & p )" +.br +.ti -1c +.BI "\fBQVariant\fR ( QDataStream & s )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QString & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QCString & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const char * val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QStringList & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QFont & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QPixmap & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QImage & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QBrush & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QPoint & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QRect & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QSize & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QColor & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QPalette & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QColorGroup & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QIconSet & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QPointArray & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QRegion & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QBitmap & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QCursor & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QDate & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QTime & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QDateTime & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QByteArray & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QBitArray & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QKeySequence & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QPen & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QValueList<QVariant> & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( const QMap<QString, QVariant> & val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( int val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( uint val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( TQ_LLONG val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( TQ_ULLONG val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( bool val, int )" +.br +.ti -1c +.BI "\fBQVariant\fR ( double val )" +.br +.ti -1c +.BI "\fBQVariant\fR ( QSizePolicy val )" +.br +.ti -1c +.BI "QVariant & \fBoperator=\fR ( const QVariant & variant )" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QVariant & v ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QVariant & v ) const" +.br +.ti -1c +.BI "Type \fBtype\fR () const" +.br +.ti -1c +.BI "const char * \fBtypeName\fR () const" +.br +.ti -1c +.BI "bool \fBcanCast\fR ( Type t ) const" +.br +.ti -1c +.BI "bool \fBcast\fR ( Type t )" +.br +.ti -1c +.BI "bool \fBisValid\fR () const" +.br +.ti -1c +.BI "bool \fBisNull\fR () const" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "const QString \fBtoString\fR () const" +.br +.ti -1c +.BI "const QCString \fBtoCString\fR () const" +.br +.ti -1c +.BI "const QStringList \fBtoStringList\fR () const" +.br +.ti -1c +.BI "const QFont \fBtoFont\fR () const" +.br +.ti -1c +.BI "const QPixmap \fBtoPixmap\fR () const" +.br +.ti -1c +.BI "const QImage \fBtoImage\fR () const" +.br +.ti -1c +.BI "const QBrush \fBtoBrush\fR () const" +.br +.ti -1c +.BI "const QPoint \fBtoPoint\fR () const" +.br +.ti -1c +.BI "const QRect \fBtoRect\fR () const" +.br +.ti -1c +.BI "const QSize \fBtoSize\fR () const" +.br +.ti -1c +.BI "const QColor \fBtoColor\fR () const" +.br +.ti -1c +.BI "const QPalette \fBtoPalette\fR () const" +.br +.ti -1c +.BI "const QColorGroup \fBtoColorGroup\fR () const" +.br +.ti -1c +.BI "const QIconSet \fBtoIconSet\fR () const" +.br +.ti -1c +.BI "const QPointArray \fBtoPointArray\fR () const" +.br +.ti -1c +.BI "const QBitmap \fBtoBitmap\fR () const" +.br +.ti -1c +.BI "const QRegion \fBtoRegion\fR () const" +.br +.ti -1c +.BI "const QCursor \fBtoCursor\fR () const" +.br +.ti -1c +.BI "const QDate \fBtoDate\fR () const" +.br +.ti -1c +.BI "const QTime \fBtoTime\fR () const" +.br +.ti -1c +.BI "const QDateTime \fBtoDateTime\fR () const" +.br +.ti -1c +.BI "const QByteArray \fBtoByteArray\fR () const" +.br +.ti -1c +.BI "const QBitArray \fBtoBitArray\fR () const" +.br +.ti -1c +.BI "const QKeySequence \fBtoKeySequence\fR () const" +.br +.ti -1c +.BI "const QPen \fBtoPen\fR () const" +.br +.ti -1c +.BI "int \fBtoInt\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "uint \fBtoUInt\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "TQ_LLONG \fBtoLongLong\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "TQ_ULLONG \fBtoULongLong\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "bool \fBtoBool\fR () const" +.br +.ti -1c +.BI "double \fBtoDouble\fR ( bool * ok = 0 ) const" +.br +.ti -1c +.BI "const QValueList<QVariant> \fBtoList\fR () const" +.br +.ti -1c +.BI "const QMap<QString, QVariant> \fBtoMap\fR () const" +.br +.ti -1c +.BI "QSizePolicy \fBtoSizePolicy\fR () const" +.br +.ti -1c +.BI "QValueListConstIterator<QString> stringListBegin () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QValueListConstIterator<QString> stringListEnd () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QValueListConstIterator<QVariant> listBegin () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QValueListConstIterator<QVariant> listEnd () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QMapConstIterator<QString, QVariant> mapBegin () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QMapConstIterator<QString, QVariant> mapEnd () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QMapConstIterator<QString, QVariant> mapFind ( const QString & key ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QString & \fBasString\fR ()" +.br +.ti -1c +.BI "QCString & \fBasCString\fR ()" +.br +.ti -1c +.BI "QStringList & \fBasStringList\fR ()" +.br +.ti -1c +.BI "QFont & \fBasFont\fR ()" +.br +.ti -1c +.BI "QPixmap & \fBasPixmap\fR ()" +.br +.ti -1c +.BI "QImage & \fBasImage\fR ()" +.br +.ti -1c +.BI "QBrush & \fBasBrush\fR ()" +.br +.ti -1c +.BI "QPoint & \fBasPoint\fR ()" +.br +.ti -1c +.BI "QRect & \fBasRect\fR ()" +.br +.ti -1c +.BI "QSize & \fBasSize\fR ()" +.br +.ti -1c +.BI "QColor & \fBasColor\fR ()" +.br +.ti -1c +.BI "QPalette & \fBasPalette\fR ()" +.br +.ti -1c +.BI "QColorGroup & \fBasColorGroup\fR ()" +.br +.ti -1c +.BI "QIconSet & \fBasIconSet\fR ()" +.br +.ti -1c +.BI "QPointArray & \fBasPointArray\fR ()" +.br +.ti -1c +.BI "QBitmap & \fBasBitmap\fR ()" +.br +.ti -1c +.BI "QRegion & \fBasRegion\fR ()" +.br +.ti -1c +.BI "QCursor & \fBasCursor\fR ()" +.br +.ti -1c +.BI "QDate & \fBasDate\fR ()" +.br +.ti -1c +.BI "QTime & \fBasTime\fR ()" +.br +.ti -1c +.BI "QDateTime & \fBasDateTime\fR ()" +.br +.ti -1c +.BI "QByteArray & \fBasByteArray\fR ()" +.br +.ti -1c +.BI "QBitArray & \fBasBitArray\fR ()" +.br +.ti -1c +.BI "QKeySequence & \fBasKeySequence\fR ()" +.br +.ti -1c +.BI "QPen & \fBasPen\fR ()" +.br +.ti -1c +.BI "int & \fBasInt\fR ()" +.br +.ti -1c +.BI "uint & \fBasUInt\fR ()" +.br +.ti -1c +.BI "TQ_LLONG & \fBasLongLong\fR ()" +.br +.ti -1c +.BI "TQ_ULLONG & \fBasULongLong\fR ()" +.br +.ti -1c +.BI "bool & \fBasBool\fR ()" +.br +.ti -1c +.BI "double & \fBasDouble\fR ()" +.br +.ti -1c +.BI "QValueList<QVariant> & \fBasList\fR ()" +.br +.ti -1c +.BI "QMap<QString, QVariant> & \fBasMap\fR ()" +.br +.ti -1c +.BI "QSizePolicy & \fBasSizePolicy\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "const char * \fBtypeToName\fR ( Type typ )" +.br +.ti -1c +.BI "Type \fBnameToType\fR ( const char * name )" +.br +.in -1c +.SH DESCRIPTION +The QVariant class acts like a union for the most common Qt data types. +.PP +Because C++ forbids unions from including types that have non-default constructors or destructors, most interesting Qt classes cannot be used in unions. Without QVariant, this would be a problem for QObject::property() and for database work, etc. +.PP +A QVariant object holds a single value of a single type() at a time. (Some type()s are multi-valued, for example a string list.) You can find out what type, T, the variant holds, convert it to a different type using one of the asT() functions, e.g. asSize(), get its value using one of the toT() functions, e.g. toSize(), and check whether the type can be converted to a particular type using canCast(). +.PP +The methods named toT() (for any supported T, see the Type documentation for a list) are const. If you ask for the stored type, they return a copy of the stored object. If you ask for a type that can be generated from the stored type, toT() copies and converts and leaves the object itself unchanged. If you ask for a type that cannot be generated from the stored type, the result depends on the type (see the function documentation for details). +.PP +Note that three data types supported by QVariant are explicitly shared, namely QImage, QPointArray, and QCString, and in these cases the toT() methods return a shallow copy. In almost all cases you must make a deep copy of the returned values before modifying them. +.PP +The asT() functions are not const. They do conversion like the toT() methods, set the variant to hold the converted value, and return a reference to the new contents of the variant. +.PP +Here is some example code to demonstrate the use of QVariant: +.PP +.nf +.br + QDataStream out(...); +.br + QVariant v(123); // The variant now contains an int +.br + int x = v.toInt(); // x = 123 +.br + out << v; // Writes a type tag and an int to out +.br + v = QVariant("hello"); // The variant now contains a QCString +.br + v = QVariant(tr("hello"));// The variant now contains a QString +.br + int y = v.toInt(); // y = 0 since v cannot be converted to an int +.br + QString s = v.toString(); // s = tr("hello") (see QObject::tr()) +.br + out << v; // Writes a type tag and a QString to out +.br + ... +.br + QDataStream in(...); // (opening the previously written stream) +.br + in >> v; // Reads an Int variant +.br + int z = v.toInt(); // z = 123 +.br + tqDebug("Type is %s", // prints "Type is int" +.br + v.typeName()); +.br + v.asInt() += 100; // The variant now hold the value 223. +.br + v = QVariant( QStringList() ); +.br + v.asStringList().append( "Hello" ); +.br +.fi +.PP +You can even store QValueList<QVariant>s and QMap<QString,QVariant>s in a variant, so you can easily construct arbitrarily complex data structures of arbitrary types. This is very powerful and versatile, but may prove less memory and speed efficient than storing specific types in standard data structures. +.PP +QVariant also supports the notion of NULL values, where you have a defined type with no value set. +.PP +.nf +.br + QVariant x, y( QString() ), z( QString("") ); +.br + x.asInt(); +.br + // x.isNull() == TRUE, y.isNull() == TRUE, z.isNull() == FALSE +.br +.fi +.PP +See the Collection Classes. +.PP +See also Miscellaneous Classes and Object Model. +.SS "Member Type Documentation" +.SH "QVariant::Type" +This enum type defines the types of variable that a QVariant can contain. +.TP +\fCQVariant::Invalid\fR - no type +.TP +\fCQVariant::BitArray\fR - a QBitArray +.TP +\fCQVariant::ByteArray\fR - a QByteArray +.TP +\fCQVariant::Bitmap\fR - a QBitmap +.TP +\fCQVariant::Bool\fR - a bool +.TP +\fCQVariant::Brush\fR - a QBrush +.TP +\fCQVariant::Color\fR - a QColor +.TP +\fCQVariant::ColorGroup\fR - a QColorGroup +.TP +\fCQVariant::Cursor\fR - a QCursor +.TP +\fCQVariant::Date\fR - a QDate +.TP +\fCQVariant::DateTime\fR - a QDateTime +.TP +\fCQVariant::Double\fR - a double +.TP +\fCQVariant::Font\fR - a QFont +.TP +\fCQVariant::IconSet\fR - a QIconSet +.TP +\fCQVariant::Image\fR - a QImage +.TP +\fCQVariant::Int\fR - an int +.TP +\fCQVariant::KeySequence\fR - a QKeySequence +.TP +\fCQVariant::List\fR - a QValueList<QVariant> +.TP +\fCQVariant::LongLong\fR - a long long +.TP +\fCQVariant::ULongLong\fR - an unsigned long long +.TP +\fCQVariant::Map\fR - a QMap<QString,QVariant> +.TP +\fCQVariant::Palette\fR - a QPalette +.TP +\fCQVariant::Pen\fR - a QPen +.TP +\fCQVariant::Pixmap\fR - a QPixmap +.TP +\fCQVariant::Point\fR - a QPoint +.TP +\fCQVariant::PointArray\fR - a QPointArray +.TP +\fCQVariant::Rect\fR - a QRect +.TP +\fCQVariant::Region\fR - a QRegion +.TP +\fCQVariant::Size\fR - a QSize +.TP +\fCQVariant::SizePolicy\fR - a QSizePolicy +.TP +\fCQVariant::String\fR - a QString +.TP +\fCQVariant::CString\fR - a QCString +.TP +\fCQVariant::StringList\fR - a QStringList +.TP +\fCQVariant::Time\fR - a QTime +.TP +\fCQVariant::UInt\fR - an unsigned int +.PP +Note that Qt's definition of bool depends on the compiler. ntqglobal.h has the system-dependent definition of bool. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QVariant::QVariant ()" +Constructs an invalid variant. +.SH "QVariant::QVariant ( bool val, int )" +Constructs a new variant with a boolean value, \fIval\fR. The integer argument is a dummy, necessary for compatibility with some compilers. +.SH "QVariant::QVariant ( double val )" +Constructs a new variant with a floating point value, \fIval\fR. +.SH "QVariant::QVariant ( QSizePolicy val )" +Constructs a new variant with a size policy value, \fIval\fR. +.SH "QVariant::QVariant ( const QVariant & p )" +Constructs a copy of the variant, \fIp\fR, passed as the argument to this constructor. Usually this is a deep copy, but a shallow copy is made if the stored data type is explicitly shared, as e.g. QImage is. +.SH "QVariant::QVariant ( QDataStream & s )" +Reads the variant from the data stream, \fIs\fR. +.SH "QVariant::QVariant ( const QString & val )" +Constructs a new variant with a string value, \fIval\fR. +.SH "QVariant::QVariant ( const QCString & val )" +Constructs a new variant with a C-string value, \fIval\fR. +.PP +If you want to modify the QCString after you've passed it to this constructor, we recommend passing a deep copy (see QCString::copy()). +.SH "QVariant::QVariant ( const char * val )" +Constructs a new variant with a C-string value of \fIval\fR if \fIval\fR is non-null. The variant creates a deep copy of \fIval\fR. +.PP +If \fIval\fR is null, the resulting variant has type Invalid. +.SH "QVariant::QVariant ( const QStringList & val )" +Constructs a new variant with a string list value, \fIval\fR. +.SH "QVariant::QVariant ( const QFont & val )" +Constructs a new variant with a font value, \fIval\fR. +.SH "QVariant::QVariant ( const QPixmap & val )" +Constructs a new variant with a pixmap value, \fIval\fR. +.SH "QVariant::QVariant ( const QImage & val )" +Constructs a new variant with an image value, \fIval\fR. +.PP +Because QImage is explicitly shared, you may need to pass a deep copy to the variant using QImage::copy(), e.g. if you intend changing the image you've passed later on. +.SH "QVariant::QVariant ( const QBrush & val )" +Constructs a new variant with a brush value, \fIval\fR. +.SH "QVariant::QVariant ( const QPoint & val )" +Constructs a new variant with a point value, \fIval\fR. +.SH "QVariant::QVariant ( const QRect & val )" +Constructs a new variant with a rect value, \fIval\fR. +.SH "QVariant::QVariant ( const QSize & val )" +Constructs a new variant with a size value, \fIval\fR. +.SH "QVariant::QVariant ( const QColor & val )" +Constructs a new variant with a color value, \fIval\fR. +.SH "QVariant::QVariant ( const QPalette & val )" +Constructs a new variant with a color palette value, \fIval\fR. +.SH "QVariant::QVariant ( const QColorGroup & val )" +Constructs a new variant with a color group value, \fIval\fR. +.SH "QVariant::QVariant ( const QIconSet & val )" +Constructs a new variant with an icon set value, \fIval\fR. +.SH "QVariant::QVariant ( const QPointArray & val )" +Constructs a new variant with a point array value, \fIval\fR. +.PP +Because QPointArray is explicitly shared, you may need to pass a deep copy to the variant using QPointArray::copy(), e.g. if you intend changing the point array you've passed later on. +.SH "QVariant::QVariant ( const QRegion & val )" +Constructs a new variant with a region value, \fIval\fR. +.SH "QVariant::QVariant ( const QBitmap & val )" +Constructs a new variant with a bitmap value, \fIval\fR. +.SH "QVariant::QVariant ( const QCursor & val )" +Constructs a new variant with a cursor value, \fIval\fR. +.SH "QVariant::QVariant ( const QDate & val )" +Constructs a new variant with a date value, \fIval\fR. +.SH "QVariant::QVariant ( const QTime & val )" +Constructs a new variant with a time value, \fIval\fR. +.SH "QVariant::QVariant ( const QDateTime & val )" +Constructs a new variant with a date/time value, \fIval\fR. +.SH "QVariant::QVariant ( const QByteArray & val )" +Constructs a new variant with a bytearray value, \fIval\fR. +.SH "QVariant::QVariant ( const QBitArray & val )" +Constructs a new variant with a bitarray value, \fIval\fR. +.SH "QVariant::QVariant ( const QKeySequence & val )" +Constructs a new variant with a key sequence value, \fIval\fR. +.SH "QVariant::QVariant ( const QPen & val )" +Constructs a new variant with a pen value, \fIval\fR. +.SH "QVariant::QVariant ( const QValueList<QVariant> & val )" +Constructs a new variant with a list value, \fIval\fR. +.SH "QVariant::QVariant ( const QMap<QString, QVariant> & val )" +Constructs a new variant with a map of QVariants, \fIval\fR. +.SH "QVariant::QVariant ( int val )" +Constructs a new variant with an integer value, \fIval\fR. +.SH "QVariant::QVariant ( uint val )" +Constructs a new variant with an unsigned integer value, \fIval\fR. +.SH "QVariant::QVariant ( TQ_LLONG val )" +Constructs a new variant with a long long integer value, \fIval\fR. +.SH "QVariant::QVariant ( TQ_ULLONG val )" +Constructs a new variant with an unsigned long long integer value, \fIval\fR. +.SH "QVariant::~QVariant ()" +Destroys the QVariant and the contained object. +.PP +Note that subclasses that reimplement clear() should reimplement the destructor to call clear(). This destructor calls clear(), but because it is the destructor, QVariant::clear() is called rather than a subclass's clear(). +.SH "QBitArray & QVariant::asBitArray ()" +Tries to convert the variant to hold a QBitArray value. If that is not possible then the variant is set to an empty bitarray. +.PP +Returns a reference to the stored bitarray. +.PP +See also toBitArray(). +.SH "QBitmap & QVariant::asBitmap ()" +Tries to convert the variant to hold a bitmap value. If that is not possible the variant is set to a null bitmap. +.PP +Returns a reference to the stored bitmap. +.PP +See also toBitmap(). +.SH "bool & QVariant::asBool ()" +Returns the variant's value as bool reference. +.SH "QBrush & QVariant::asBrush ()" +Tries to convert the variant to hold a brush value. If that is not possible the variant is set to a default black brush. +.PP +Returns a reference to the stored brush. +.PP +See also toBrush(). +.SH "QByteArray & QVariant::asByteArray ()" +Tries to convert the variant to hold a QByteArray value. If that is not possible then the variant is set to an empty bytearray. +.PP +Returns a reference to the stored bytearray. +.PP +See also toByteArray(). +.SH "QCString & QVariant::asCString ()" +Tries to convert the variant to hold a string value. If that is not possible the variant is set to an empty string. +.PP +Returns a reference to the stored string. +.PP +See also toCString(). +.SH "QColor & QVariant::asColor ()" +Tries to convert the variant to hold a QColor value. If that is not possible the variant is set to an invalid color. +.PP +Returns a reference to the stored color. +.PP +See also toColor() and QColor::isValid(). +.SH "QColorGroup & QVariant::asColorGroup ()" +Tries to convert the variant to hold a QColorGroup value. If that is not possible the variant is set to a color group of all black colors. +.PP +Returns a reference to the stored color group. +.PP +See also toColorGroup(). +.SH "QCursor & QVariant::asCursor ()" +Tries to convert the variant to hold a QCursor value. If that is not possible the variant is set to a default arrow cursor. +.PP +Returns a reference to the stored cursor. +.PP +See also toCursor(). +.SH "QDate & QVariant::asDate ()" +Tries to convert the variant to hold a QDate value. If that is not possible then the variant is set to an invalid date. +.PP +Returns a reference to the stored date. +.PP +See also toDate(). +.SH "QDateTime & QVariant::asDateTime ()" +Tries to convert the variant to hold a QDateTime value. If that is not possible then the variant is set to an invalid date/time. +.PP +Returns a reference to the stored date/time. +.PP +See also toDateTime(). +.SH "double & QVariant::asDouble ()" +Returns the variant's value as double reference. +.SH "QFont & QVariant::asFont ()" +Tries to convert the variant to hold a QFont. If that is not possible the variant is set to the application's default font. +.PP +Returns a reference to the stored font. +.PP +See also toFont(). +.SH "QIconSet & QVariant::asIconSet ()" +Tries to convert the variant to hold a QIconSet value. If that is not possible the variant is set to an empty iconset. +.PP +Returns a reference to the stored iconset. +.PP +See also toIconSet(). +.SH "QImage & QVariant::asImage ()" +Tries to convert the variant to hold an image value. If that is not possible the variant is set to a null image. +.PP +Returns a reference to the stored image. +.PP +See also toImage(). +.SH "int & QVariant::asInt ()" +Returns the variant's value as int reference. +.SH "QKeySequence & QVariant::asKeySequence ()" +Tries to convert the variant to hold a QKeySequence value. If that is not possible then the variant is set to an empty key sequence. +.PP +Returns a reference to the stored key sequence. +.PP +See also toKeySequence(). +.SH "QValueList<QVariant> & QVariant::asList ()" +Returns the variant's value as variant list reference. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<QVariant> list = myVariant.asList(); +.br + QValueList<QVariant>::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "TQ_LLONG & QVariant::asLongLong ()" +Returns the variant's value as long long reference. +.SH "QMap<QString, QVariant> & QVariant::asMap ()" +Returns the variant's value as variant map reference. +.PP +Note that if you want to iterate over the map, you should iterate over a copy, e.g. +.PP +.nf +.br + QMap<QString, QVariant> map = myVariant.asMap(); +.br + QMap<QString, QVariant>::Iterator it = map.begin(); +.br + while( it != map.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "QPalette & QVariant::asPalette ()" +Tries to convert the variant to hold a QPalette value. If that is not possible the variant is set to a palette of black colors. +.PP +Returns a reference to the stored palette. +.PP +See also toString(). +.SH "QPen & QVariant::asPen ()" +Tries to convert the variant to hold a QPen value. If that is not possible then the variant is set to an empty pen. +.PP +Returns a reference to the stored pen. +.PP +See also toPen(). +.SH "QPixmap & QVariant::asPixmap ()" +Tries to convert the variant to hold a pixmap value. If that is not possible the variant is set to a null pixmap. +.PP +Returns a reference to the stored pixmap. +.PP +See also toPixmap(). +.SH "QPoint & QVariant::asPoint ()" +Tries to convert the variant to hold a point value. If that is not possible the variant is set to a (0, 0) point. +.PP +Returns a reference to the stored point. +.PP +See also toPoint(). +.SH "QPointArray & QVariant::asPointArray ()" +Tries to convert the variant to hold a QPointArray value. If that is not possible the variant is set to an empty point array. +.PP +Returns a reference to the stored point array. +.PP +See also toPointArray(). +.SH "QRect & QVariant::asRect ()" +Tries to convert the variant to hold a rectangle value. If that is not possible the variant is set to an empty rectangle. +.PP +Returns a reference to the stored rectangle. +.PP +See also toRect(). +.SH "QRegion & QVariant::asRegion ()" +Tries to convert the variant to hold a QRegion value. If that is not possible the variant is set to a null region. +.PP +Returns a reference to the stored region. +.PP +See also toRegion(). +.SH "QSize & QVariant::asSize ()" +Tries to convert the variant to hold a QSize value. If that is not possible the variant is set to an invalid size. +.PP +Returns a reference to the stored size. +.PP +See also toSize() and QSize::isValid(). +.SH "QSizePolicy & QVariant::asSizePolicy ()" +Tries to convert the variant to hold a QSizePolicy value. If that fails, the variant is set to an arbitrary (valid) size policy. +.SH "QString & QVariant::asString ()" +Tries to convert the variant to hold a string value. If that is not possible the variant is set to an empty string. +.PP +Returns a reference to the stored string. +.PP +See also toString(). +.SH "QStringList & QVariant::asStringList ()" +Tries to convert the variant to hold a QStringList value. If that is not possible the variant is set to an empty string list. +.PP +Returns a reference to the stored string list. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myVariant.asStringList(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also toStringList(). +.SH "QTime & QVariant::asTime ()" +Tries to convert the variant to hold a QTime value. If that is not possible then the variant is set to an invalid time. +.PP +Returns a reference to the stored time. +.PP +See also toTime(). +.SH "uint & QVariant::asUInt ()" +Returns the variant's value as unsigned int reference. +.SH "TQ_ULLONG & QVariant::asULongLong ()" +Returns the variant's value as unsigned long long reference. +.SH "bool QVariant::canCast ( Type t ) const" +Returns TRUE if the variant's type can be cast to the requested type, \fIt\fR. Such casting is done automatically when calling the toInt(), toBool(), ... or asInt(), asBool(), ... methods. +.PP +The following casts are done automatically: <center>.nf +.TS +l - l. Type Automatically Cast To Bool Double, Int, UInt, LongLong, ULongLong, String, CString, ByteArray Color String. CString. ByteArray Date String, CString, ByteArray, DateTime DateTime String, CString, ByteArray, Date, Time Double String, CString, ByteArray, Int, Bool, UInt, LongLong, ULongLong Font String, CString, ByteArray Int String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence LongLong String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence ULongLong String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence List StringList (if the list contains only strings or something that can be cast to a string) String CString, ByteArray, CString, Int, UInt, Bool, Double, Date, Time, DateTime, KeySequence, Font, Color CString String, ByteArray, Int, UInt, Bool, Double, Date, ULongLong, LongLong ByteArray String, CString, Int, UInt, Bool, Double, Date, ULongLong, LongLong StringList List Time String Int String, CString, ByteArray, Double, Bool, UInt, LongLong, ULongLong, KeySequence KeySequence +.TE +.fi +</center> +.SH "bool QVariant::cast ( Type t )" +Casts the variant to the requested type. If the cast cannot be done, the variant is set to the default value of the requested type (e.g. an empty string if the requested type \fIt\fR is QVariant::String, an empty point array if the requested type \fIt\fR is QVariant::PointArray, etc). Returns TRUE if the current type of the variant was successfully cast; otherwise returns FALSE. +.PP +See also canCast(). +.SH "void QVariant::clear ()" +Convert this variant to type Invalid and free up any resources used. +.SH "bool QVariant::isNull () const" +Returns TRUE if this is a NULL variant, FALSE otherwise. +.SH "bool QVariant::isValid () const" +Returns TRUE if the storage type of this variant is not QVariant::Invalid; otherwise returns FALSE. +.SH "QValueListConstIterator<QVariant> QVariant::listBegin () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns an iterator to the first item in the list if the variant's type is appropriate; otherwise returns a null iterator. +.SH "QValueListConstIterator<QVariant> QVariant::listEnd () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the end iterator for the list if the variant's type is appropriate; otherwise returns a null iterator. +.SH "QMapConstIterator<QString, QVariant> QVariant::mapBegin () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns an iterator to the first item in the map, if the variant's type is appropriate; otherwise returns a null iterator. +.SH "QMapConstIterator<QString, QVariant> QVariant::mapEnd () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the end iterator for the map, if the variant's type is appropriate; otherwise returns a null iterator. +.SH "QMapConstIterator<QString, QVariant> QVariant::mapFind ( const QString & key ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns an iterator to the item in the map with \fIkey\fR as key, if the variant's type is appropriate and \fIkey\fR is a valid key; otherwise returns a null iterator. +.SH "Type QVariant::nameToType ( const char * name )\fC [static]\fR" +Converts the string representation of the storage type given in \fIname\fR, to its enum representation. +.PP +If the string representation cannot be converted to any enum representation, the variant is set to Invalid. +.SH "bool QVariant::operator!= ( const QVariant & v ) const" +Compares this QVariant with \fIv\fR and returns TRUE if they are not equal; otherwise returns FALSE. +.SH "QVariant & QVariant::operator= ( const QVariant & variant )" +Assigns the value of the variant \fIvariant\fR to this variant. +.PP +This is a deep copy of the variant, but note that if the variant holds an explicitly shared type such as QImage, a shallow copy is performed. +.SH "bool QVariant::operator== ( const QVariant & v ) const" +Compares this QVariant with \fIv\fR and returns TRUE if they are equal; otherwise returns FALSE. +.SH "QValueListConstIterator<QString> QVariant::stringListBegin () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns an iterator to the first string in the list if the variant's type is StringList; otherwise returns a null iterator. +.SH "QValueListConstIterator<QString> QVariant::stringListEnd () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Returns the end iterator for the list if the variant's type is StringList; otherwise returns a null iterator. +.SH "const QBitArray QVariant::toBitArray () const" +Returns the variant as a QBitArray if the variant has type() BitArray; otherwise returns an empty bitarray. +.PP +See also asBitArray(). +.SH "const QBitmap QVariant::toBitmap () const" +Returns the variant as a QBitmap if the variant has type() Bitmap; otherwise returns a null QBitmap. +.PP +See also asBitmap(). +.SH "bool QVariant::toBool () const" +Returns the variant as a bool if the variant can be cast to Bool; otherWise returns FALSE. +.PP +Returns TRUE if the variant has a numeric type and its value is non-zero, or if the variant has type String, ByteArray or CString and its lower-case content is not empty, "0" or "false"; otherwise returns FALSE. +.PP +See also asBool() and canCast(). +.SH "const QBrush QVariant::toBrush () const" +Returns the variant as a QBrush if the variant has type() Brush; otherwise returns a default brush (with all black colors). +.PP +See also asBrush(). +.SH "const QByteArray QVariant::toByteArray () const" +Returns the variant as a QByteArray if the variant can be cast to a ByteArray; otherwise returns an empty bytearray. +.PP +See also asByteArray() and canCast(). +.SH "const QCString QVariant::toCString () const" +Returns the variant as a QCString if the variant can be cast to a CString; otherwise returns 0. +.PP +See also asCString() and canCast(). +.SH "const QColor QVariant::toColor () const" +Returns the variant as a QColor if the variant can be cast to Color; otherwise returns an invalid color. +.PP +See also asColor() and canCast(). +.SH "const QColorGroup QVariant::toColorGroup () const" +Returns the variant as a QColorGroup if the variant has type() ColorGroup; otherwise returns a completely black color group. +.PP +See also asColorGroup(). +.SH "const QCursor QVariant::toCursor () const" +Returns the variant as a QCursor if the variant has type() Cursor; otherwise returns the default arrow cursor. +.PP +See also asCursor(). +.SH "const QDate QVariant::toDate () const" +Returns the variant as a QDate if the variant can be cast to Date; otherwise returns an invalid date. +.PP +Note that if the type() is String, CString or ByteArray an invalid date will be returned if the string cannot be parsed as a Qt::ISODate format date. +.PP +See also asDate() and canCast(). +.SH "const QDateTime QVariant::toDateTime () const" +Returns the variant as a QDateTime if the variant can be cast to DateTime; otherwise returns an invalid QDateTime. +.PP +Note that if the type() is String, CString or ByteArray an invalid QDateTime will be returned if the string cannot be parsed as a Qt::ISODate format date/time. +.PP +See also asDateTime(). +.SH "double QVariant::toDouble ( bool * ok = 0 ) const" +Returns the variant as a double if the variant can be cast to Double; otherwise returns 0.0. +.PP +If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to a double; otherwise \fI*ok\fR is set to FALSE. +.PP +See also asDouble() and canCast(). +.SH "const QFont QVariant::toFont () const" +Returns the variant as a QFont if the variant can be cast to Font; otherwise returns the application's default font. +.PP +See also asFont() and canCast(). +.SH "const QIconSet QVariant::toIconSet () const" +Returns the variant as a QIconSet if the variant has type() IconSet; otherwise returns an icon set of null pixmaps. +.PP +See also asIconSet(). +.SH "const QImage QVariant::toImage () const" +Returns the variant as a QImage if the variant has type() Image; otherwise returns a null image. +.PP +See also asImage(). +.SH "int QVariant::toInt ( bool * ok = 0 ) const" +Returns the variant as an int if the variant can be cast to Int; otherwise returns 0. +.PP +If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an int; otherwise \fI*ok\fR is set to FALSE. +.PP +See also asInt() and canCast(). +.SH "const QKeySequence QVariant::toKeySequence () const" +Returns the variant as a QKeySequence if the variant can be cast to a KeySequence; otherwise returns an empty key sequence. +.PP +See also asKeySequence() and canCast(). +.SH "const QValueList<QVariant> QVariant::toList () const" +Returns the variant as a QValueList<QVariant> if the variant has type() List or StringList; otherwise returns an empty list. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QValueList<QVariant> list = myVariant.toList(); +.br + QValueList<QVariant>::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also asList(). +.SH "TQ_LLONG QVariant::toLongLong ( bool * ok = 0 ) const" +Returns the variant as a long long int if the variant can be cast to LongLong; otherwise returns 0. +.PP +If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an int; otherwise \fI*ok\fR is set to FALSE. +.PP +See also asLongLong() and canCast(). +.SH "const QMap<QString, QVariant> QVariant::toMap () const" +Returns the variant as a QMap<QString,QVariant> if the variant has type() Map; otherwise returns an empty map. +.PP +Note that if you want to iterate over the map, you should iterate over a copy, e.g. +.PP +.nf +.br + QMap<QString, QVariant> map = myVariant.toMap(); +.br + QMap<QString, QVariant>::Iterator it = map.begin(); +.br + while( it != map.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also asMap(). +.SH "const QPalette QVariant::toPalette () const" +Returns the variant as a QPalette if the variant has type() Palette; otherwise returns a completely black palette. +.PP +See also asPalette(). +.SH "const QPen QVariant::toPen () const" +Returns the variant as a QPen if the variant has type() Pen; otherwise returns an empty QPen. +.PP +See also asPen(). +.SH "const QPixmap QVariant::toPixmap () const" +Returns the variant as a QPixmap if the variant has type() Pixmap; otherwise returns a null pixmap. +.PP +See also asPixmap(). +.SH "const QPoint QVariant::toPoint () const" +Returns the variant as a QPoint if the variant has type() Point; otherwise returns a point (0, 0). +.PP +See also asPoint(). +.SH "const QPointArray QVariant::toPointArray () const" +Returns the variant as a QPointArray if the variant has type() PointArray; otherwise returns an empty QPointArray. +.PP +See also asPointArray(). +.SH "const QRect QVariant::toRect () const" +Returns the variant as a QRect if the variant has type() Rect; otherwise returns an empty rectangle. +.PP +See also asRect(). +.SH "const QRegion QVariant::toRegion () const" +Returns the variant as a QRegion if the variant has type() Region; otherwise returns an empty QRegion. +.PP +See also asRegion(). +.SH "const QSize QVariant::toSize () const" +Returns the variant as a QSize if the variant has type() Size; otherwise returns an invalid size. +.PP +See also asSize(). +.SH "QSizePolicy QVariant::toSizePolicy () const" +Returns the variant as a QSizePolicy if the variant has type() SizePolicy; otherwise returns an undefined (but legal) size policy. +.SH "const QString QVariant::toString () const" +Returns the variant as a QString if the variant can be cast to String, otherwise returns QString::null. +.PP +See also asString() and canCast(). +.SH "const QStringList QVariant::toStringList () const" +Returns the variant as a QStringList if the variant has type() StringList or List of a type that can be converted to QString; otherwise returns an empty list. +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myVariant.toStringList(); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.PP +See also asStringList(). +.SH "const QTime QVariant::toTime () const" +Returns the variant as a QTime if the variant can be cast to Time; otherwise returns an invalid date. +.PP +Note that if the type() is String, CString or ByteArray an invalid time will be returned if the string cannot be parsed as a Qt::ISODate format time. +.PP +See also asTime(). +.SH "uint QVariant::toUInt ( bool * ok = 0 ) const" +Returns the variant as an unsigned int if the variant can be cast to UInt; otherwise returns 0. +.PP +If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an unsigned int; otherwise \fI*ok\fR is set to FALSE. +.PP +See also asUInt() and canCast(). +.SH "TQ_ULLONG QVariant::toULongLong ( bool * ok = 0 ) const" +Returns the variant as as an unsigned long long int if the variant can be cast to ULongLong; otherwise returns 0. +.PP +If \fIok\fR is non-null: \fI*ok\fR is set to TRUE if the value could be converted to an int; otherwise \fI*ok\fR is set to FALSE. +.PP +See also asULongLong() and canCast(). +.SH "Type QVariant::type () const" +Returns the storage type of the value stored in the variant. Usually it's best to test with canCast() whether the variant can deliver the data type you are interested in. +.SH "const char * QVariant::typeName () const" +Returns the name of the type stored in the variant. The returned strings describe the C++ datatype used to store the data: for example, "QFont", "QString", or "QValueList<QVariant>". An Invalid variant returns 0. +.SH "const char * QVariant::typeToName ( Type typ )\fC [static]\fR" +Converts the enum representation of the storage type, \fItyp\fR, to +its string representation. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvariant.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvariant.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvbox.3qt b/doc/man/man3/tqvbox.3qt new file mode 100644 index 000000000..06089c9eb --- /dev/null +++ b/doc/man/man3/tqvbox.3qt @@ -0,0 +1,62 @@ +'\" t +.TH QVBox 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 +QVBox \- Vertical geometry management of its child widgets +.SH SYNOPSIS +\fC#include <ntqvbox.h>\fR +.PP +Inherits QHBox. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQVBox\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QVBox widget provides vertical geometry management of its child widgets. +.PP +All its child widgets will be placed vertically and sized according to their sizeHint()s. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QHBox, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QVBox::QVBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a vbox widget called \fIname\fR with parent \fIparent\fR and +widget flags \fIf\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvboxlayout.3qt b/doc/man/man3/tqvboxlayout.3qt new file mode 100644 index 000000000..d5ffead05 --- /dev/null +++ b/doc/man/man3/tqvboxlayout.3qt @@ -0,0 +1,96 @@ +'\" t +.TH QVBoxLayout 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 +QVBoxLayout \- Lines up widgets vertically +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherits QBoxLayout. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQVBoxLayout\fR ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQVBoxLayout\fR ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQVBoxLayout\fR ( int spacing = -1, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QVBoxLayout\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QVBoxLayout class lines up widgets vertically. +.PP +This class is used to construct vertical box layout objects. See QBoxLayout for more details. +.PP +The simplest use of the class is like this: +.PP +.nf +.br + QBoxLayout * l = new QVBoxLayout( widget ); +.br + l->addWidget( aWidget ); +.br + l->addWidget( anotherWidget ); +.br +.fi +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QHBoxLayout, QGridLayout, the Layout overview, Widget Appearance and Style, and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QVBoxLayout::QVBoxLayout ( QWidget * parent, int margin = 0, int spacing = -1, const char * name = 0 )" +Constructs a new top-level vertical box called \fIname\fR, with parent \fIparent\fR. +.PP +The \fImargin\fR is the number of pixels between the edge of the widget and its managed children. The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1 the value of \fImargin\fR is used for \fIspacing\fR. +.SH "QVBoxLayout::QVBoxLayout ( QLayout * parentLayout, int spacing = -1, const char * name = 0 )" +Constructs a new vertical box called name \fIname\fR and adds it to \fIparentLayout\fR. +.PP +The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QVBoxLayout will inherit its parent's spacing(). +.SH "QVBoxLayout::QVBoxLayout ( int spacing = -1, const char * name = 0 )" +Constructs a new vertical box called name \fIname\fR. You must add it to another layout. +.PP +The \fIspacing\fR is the default number of pixels between neighboring children. If \fIspacing\fR is -1, this QVBoxLayout will inherit its parent's spacing(). +.SH "QVBoxLayout::~QVBoxLayout ()" +Destroys this box layout. +.PP +The layout's widgets aren't destroyed. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qvboxlayout.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvboxlayout.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvbuttongroup.3qt b/doc/man/man3/tqvbuttongroup.3qt new file mode 100644 index 000000000..ca1ab2eb3 --- /dev/null +++ b/doc/man/man3/tqvbuttongroup.3qt @@ -0,0 +1,75 @@ +'\" t +.TH QVButtonGroup 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 +QVButtonGroup \- Organizes QButton widgets in a vertical column +.SH SYNOPSIS +\fC#include <ntqvbuttongroup.h>\fR +.PP +Inherits QButtonGroup. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQVButtonGroup\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQVButtonGroup\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QVButtonGroup\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QVButtonGroup widget organizes QButton widgets in a vertical column. +.PP +QVButtonGroup is a convenience class that offers a thin layer on top of QButtonGroup. Think of it as a QVBox that offers a frame with a title and is specifically designed for buttons. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QHButtonGroup, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QVButtonGroup::QVButtonGroup ( QWidget * parent = 0, const char * name = 0 )" +Constructs a vertical button group with no title. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. +.SH "QVButtonGroup::QVButtonGroup ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a vertical button group with the title \fItitle\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. +.SH "QVButtonGroup::~QVButtonGroup ()" +Destroys the vertical button group, deleting its child widgets. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvbuttongroup.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvbuttongroup.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqvgroupbox.3qt b/doc/man/man3/tqvgroupbox.3qt new file mode 100644 index 000000000..cf60b0e94 --- /dev/null +++ b/doc/man/man3/tqvgroupbox.3qt @@ -0,0 +1,75 @@ +'\" t +.TH QVGroupBox 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 +QVGroupBox \- Organizes a group of widgets in a vertical column +.SH SYNOPSIS +\fC#include <ntqvgroupbox.h>\fR +.PP +Inherits QGroupBox. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQVGroupBox\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQVGroupBox\fR ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QVGroupBox\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QVGroupBox widget organizes a group of widgets in a vertical column. +.PP +QVGroupBox is a convenience class that offers a thin layer on top of QGroupBox. Think of it as a QVBox that offers a frame with a title. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also QHGroupBox, Widget Appearance and Style, Layout Management, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QVGroupBox::QVGroupBox ( QWidget * parent = 0, const char * name = 0 )" +Constructs a vertical group box with no title. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. +.SH "QVGroupBox::QVGroupBox ( const QString & title, QWidget * parent = 0, const char * name = 0 )" +Constructs a vertical group box with the title \fItitle\fR. +.PP +The \fIparent\fR and \fIname\fR arguments are passed on to the QWidget constructor. +.SH "QVGroupBox::~QVGroupBox ()" +Destroys the vertical group box, deleting its child widgets. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqvgroupbox.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqvgroupbox.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwaitcondition.3qt b/doc/man/man3/tqwaitcondition.3qt new file mode 100644 index 000000000..673adf623 --- /dev/null +++ b/doc/man/man3/tqwaitcondition.3qt @@ -0,0 +1,202 @@ +'\" t +.TH QWaitCondition 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 +QWaitCondition \- Allows waiting/waking for conditions between threads +.SH SYNOPSIS +All the functions in this class are thread-safe when Qt is built with thread support.</p> +.PP +\fC#include <ntqwaitcondition.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWaitCondition\fR ()" +.br +.ti -1c +.BI "virtual \fB~QWaitCondition\fR ()" +.br +.ti -1c +.BI "bool \fBwait\fR ( unsigned long time = ULONG_MAX )" +.br +.ti -1c +.BI "bool \fBwait\fR ( QMutex * mutex, unsigned long time = ULONG_MAX )" +.br +.ti -1c +.BI "void \fBwakeOne\fR ()" +.br +.ti -1c +.BI "void \fBwakeAll\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWaitCondition class allows waiting/waking for conditions between threads. +.PP +QWaitConditions allow a thread to tell other threads that some sort of condition has been met; one or many threads can block waiting for a QWaitCondition to set a condition with wakeOne() or wakeAll(). Use wakeOne() to wake one randomly selected event or wakeAll() to wake them all. For example, say we have three tasks that should be performed every time the user presses a key; each task could be split into a thread, each of which would have a run() body like this: +.PP +.nf +.br + QWaitCondition key_pressed; +.br +.br + for (;;) { +.br + key_pressed.wait(); // This is a QWaitCondition global variable +.br + // Key was pressed, do something interesting +.br + do_something(); +.br + } +.br +.fi +.PP +A fourth thread would read key presses and wake the other three threads up every time it receives one, like this: +.PP +.nf +.br + QWaitCondition key_pressed; +.br +.br + for (;;) { +.br + getchar(); +.br + // Causes any thread in key_pressed.wait() to return from +.br + // that method and continue processing +.br + key_pressed.wakeAll(); +.br + } +.br +.fi +.PP +Note that the order the three threads are woken up in is undefined, and that if some or all of the threads are still in do_something() when the key is pressed, they won't be woken up (since they're not waiting on the condition variable) and so the task will not be performed for that key press. This can be avoided by, for example, doing something like this: +.PP +.nf +.br + QMutex mymutex; +.br + QWaitCondition key_pressed; +.br + int mycount=0; +.br +.br + // Worker thread code +.br + for (;;) { +.br + key_pressed.wait(); // This is a QWaitCondition global variable +.br + mymutex.lock(); +.br + mycount++; +.br + mymutex.unlock(); +.br + do_something(); +.br + mymutex.lock(); +.br + mycount--; +.br + mymutex.unlock(); +.br + } +.br +.br + // Key reading thread code +.br + for (;;) { +.br + getchar(); +.br + mymutex.lock(); +.br + // Sleep until there are no busy worker threads +.br + while( mycount > 0 ) { +.br + mymutex.unlock(); +.br + sleep( 1 ); +.br + mymutex.lock(); +.br + } +.br + mymutex.unlock(); +.br + key_pressed.wakeAll(); +.br + } +.br +.fi +.PP +The mutexes are necessary because the results of two threads attempting to change the value of the same variable simultaneously are unpredictable. +.PP +See also Environment Classes and Threading. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWaitCondition::QWaitCondition ()" +Constructs a new event signalling, i.e. wait condition, object. +.SH "QWaitCondition::~QWaitCondition ()\fC [virtual]\fR" +Deletes the event signalling, i.e. wait condition, object. +.SH "bool QWaitCondition::wait ( unsigned long time = ULONG_MAX )" +Wait on the thread event object. The thread calling this will block until either of these conditions is met: +.TP +Another thread signals it using wakeOne() or wakeAll(). This function will return TRUE in this case. +.TP +\fItime\fR milliseconds has elapsed. If \fItime\fR is ULONG_MAX (the default), then the wait will never timeout (the event must be signalled). This function will return FALSE if the wait timed out. +.PP +See also wakeOne() and wakeAll(). +.SH "bool QWaitCondition::wait ( QMutex * mutex, unsigned long time = ULONG_MAX )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Release the locked \fImutex\fR and wait on the thread event object. The \fImutex\fR must be initially locked by the calling thread. If \fImutex\fR is not in a locked state, this function returns immediately. If \fImutex\fR is a recursive mutex, this function returns immediately. The \fImutex\fR will be unlocked, and the calling thread will block until either of these conditions is met: +.TP +Another thread signals it using wakeOne() or wakeAll(). This function will return TRUE in this case. +.TP +\fItime\fR milliseconds has elapsed. If \fItime\fR is ULONG_MAX (the default), then the wait will never timeout (the event must be signalled). This function will return FALSE if the wait timed out. +.PP +The mutex will be returned to the same locked state. This function is provided to allow the atomic transition from the locked state to the wait state. +.PP +See also wakeOne() and wakeAll(). +.SH "void QWaitCondition::wakeAll ()" +This wakes all threads waiting on the QWaitCondition. The order in which the threads are woken up depends on the operating system's scheduling policies, and cannot be controlled or predicted. +.PP +See also wakeOne(). +.SH "void QWaitCondition::wakeOne ()" +This wakes one thread waiting on the QWaitCondition. The thread that is woken up depends on the operating system's scheduling policies, and cannot be controlled or predicted. +.PP +See also wakeAll(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwaitcondition.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwaitcondition.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwhatsthis.3qt b/doc/man/man3/tqwhatsthis.3qt new file mode 100644 index 000000000..01bb29058 --- /dev/null +++ b/doc/man/man3/tqwhatsthis.3qt @@ -0,0 +1,207 @@ +'\" t +.TH QWhatsThis 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 +QWhatsThis \- Simple description of any widget, i.e. answering the question "What's this?" +.SH SYNOPSIS +\fC#include <ntqwhatsthis.h>\fR +.PP +Inherits Qt. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWhatsThis\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual \fB~QWhatsThis\fR ()" +.br +.ti -1c +.BI "virtual QString \fBtext\fR ( const QPoint & )" +.br +.ti -1c +.BI "virtual bool \fBclicked\fR ( const QString & href )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBsetFont\fR ( const QFont & font )" +.br +.ti -1c +.BI "void \fBadd\fR ( QWidget * widget, const QString & text )" +.br +.ti -1c +.BI "void \fBremove\fR ( QWidget * widget )" +.br +.ti -1c +.BI "QString \fBtextFor\fR ( QWidget * w, const QPoint & pos = QPoint ( ), bool includeParents = FALSE )" +.br +.ti -1c +.BI "QToolButton * \fBwhatsThisButton\fR ( QWidget * parent )" +.br +.ti -1c +.BI "void \fBenterWhatsThisMode\fR ()" +.br +.ti -1c +.BI "bool \fBinWhatsThisMode\fR ()" +.br +.ti -1c +.BI "void \fBleaveWhatsThisMode\fR ( const QString & text = QString::null, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )" +.br +.ti -1c +.BI "void \fBdisplay\fR ( const QString & text, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QWhatsThis class provides a simple description of any widget, i.e. answering the question "What's this?". +.PP +.PP" +What's this?" help is part of an application's online help system that provides users with information about functionality, usage, background etc., in various levels of detail from short tool tips to full text browsing help windows. +.PP +QWhatsThis provides a single window with an explanatory text that pops up when the user asks "What's this?". The default way to do this is to focus the relevant widget and press Shift+F1. The help text appears immediately; it goes away as soon as the user does something else. +.PP +(Note that if there is an accelerator for Shift+F1, this mechanism will not work.) +.PP +To add "What's this?" text to a widget you simply call QWhatsThis::add() for the widget. For example, to assign text to a menu item, call QMenuData::setWhatsThis(); for a global accelerator key, call QAccel::setWhatsThis() and If you're using actions, use QAction::setWhatsThis(). +.PP +The text can be either rich text or plain text. If you specify a rich text formatted string, it will be rendered using the default stylesheet. This makes it possible to embed images. See QStyleSheet::defaultSheet() for details. +.PP +.nf +.br + const char * fileOpenText = "<p><img source=\\"fileopen\\"> " +.br + "Click this button to open a <em>new file</em>. <br>" +.br + "You can also select the <b>Open</b> command " +.br + "from the <b>File</b> menu.</p>"; +.br + QMimeSourceFactory::defaultFactory()->setPixmap( "fileopen", +.br + fileOpenAction->iconSet().pixmap() ); +.br + fileOpenAction->setWhatsThis( fileOpenText ); +.fi +.PP +An alternative way to enter "What's this?" mode is to use the ready-made tool bar tool button from QWhatsThis::whatsThisButton(). By invoking this context help button (in the picture below the first one from the right) the user switches into "What's this?" mode. If they now click on a widget the appropriate help text is shown. The mode is left when help is given or when the user presses Esc. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +If you are using QMainWindow you can also use the QMainWindow::whatsThis() slot to invoke the mode from a menu item. +.PP +For more control you can create a dedicated QWhatsThis object for a special widget. By subclassing and reimplementing QWhatsThis::text() it is possible to have different help texts, depending on the position of the mouse click. By reimplementing QWhatsThis::clicked() it is possible to have hyperlinks inside the help texts. +.PP +If you wish to control the "What's this?" behavior of a widget manually see QWidget::customWhatsThis(). +.PP +The What's This object can be removed using QWhatsThis::remove(), although this is rarely necessary because it is automatically removed when the widget is destroyed. +.PP +See also QToolTip and Help System. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWhatsThis::QWhatsThis ( QWidget * widget )" +Constructs a dynamic "What's this?" object for \fIwidget\fR. The object is deleted when the \fIwidget\fR is destroyed. +.PP +When the widget is queried by the user the text() function of this QWhatsThis will be called to provide the appropriate text, rather than using the text assigned by add(). +.SH "QWhatsThis::~QWhatsThis ()\fC [virtual]\fR" +Destroys the object and frees any allocated resources. +.SH "void QWhatsThis::add ( QWidget * widget, const QString & text )\fC [static]\fR" +Adds \fItext\fR as "What's this" help for \fIwidget\fR. If the text is rich text formatted (i.e. it contains markup) it will be rendered with the default stylesheet QStyleSheet::defaultSheet(). +.PP +The text is destroyed if the widget is later destroyed, so it need not be explicitly removed. +.PP +See also remove(). +.PP +Examples: +.)l application/application.cpp, helpsystem/mainwindow.cpp, and mdi/application.cpp. +.SH "bool QWhatsThis::clicked ( const QString & href )\fC [virtual]\fR" +This virtual function is called when the user clicks inside the" What's this?" window. \fIhref\fR is the link the user clicked on, or QString::null if there was no link. +.PP +If the function returns TRUE (the default), the "What's this?" window is closed, otherwise it remains visible. +.PP +The default implementation ignores \fIhref\fR and returns TRUE. +.SH "void QWhatsThis::display ( const QString & text, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )\fC [static]\fR" +Display \fItext\fR in a help window at the global screen position \fIpos\fR. +.PP +If widget \fIw\fR is not 0 and has its own dedicated QWhatsThis object, this object will receive clicked() messages when the user clicks on hyperlinks inside the help text. +.PP +See also QWhatsThis::clicked(). +.SH "void QWhatsThis::enterWhatsThisMode ()\fC [static]\fR" +Enters "What's this?" mode and returns immediately. +.PP +Qt will install a special cursor and take over mouse input until the user clicks somewhere. It then shows any help available and ends "What's this?" mode. Finally, Qt removes the special cursor and help window and then restores ordinary event processing, at which point the left mouse button is no longer pressed. +.PP +The user can also use the Esc key to leave "What's this?" mode. +.PP +See also inWhatsThisMode() and leaveWhatsThisMode(). +.SH "bool QWhatsThis::inWhatsThisMode ()\fC [static]\fR" +Returns TRUE if the application is in "What's this?" mode; otherwise returns FALSE. +.PP +See also enterWhatsThisMode() and leaveWhatsThisMode(). +.SH "void QWhatsThis::leaveWhatsThisMode ( const QString & text = QString::null, const QPoint & pos = QCursor::pos ( ), QWidget * w = 0 )\fC [static]\fR" +Leaves "What's this?" question mode. +.PP +This function is used internally by widgets that support QWidget::customWhatsThis(); applications do not usually call it. An example of such a widget is QPopupMenu: menus still work normally in "What's this?" mode but also provide help texts for individual menu items. +.PP +If \fItext\fR is not QString::null, a "What's this?" help window is displayed at the global screen position \fIpos\fR. If widget \fIw\fR is not 0 and has its own dedicated QWhatsThis object, this object will receive clicked() messages when the user clicks on hyperlinks inside the help text. +.PP +See also inWhatsThisMode(), enterWhatsThisMode(), and QWhatsThis::clicked(). +.SH "void QWhatsThis::remove ( QWidget * widget )\fC [static]\fR" +Removes the "What's this?" help associated with the \fIwidget\fR. This happens automatically if the widget is destroyed. +.PP +See also add(). +.SH "void QWhatsThis::setFont ( const QFont & font )\fC [static]\fR" +Sets the font for all "What's this?" helps to \fIfont\fR. +.SH "QString QWhatsThis::text ( const QPoint & )\fC [virtual]\fR" +This virtual function returns the text for position \fIp\fR in the widget that this "What's this?" object documents. If there is no" What's this?" text for the position, QString::null is returned. +.PP +The default implementation returns QString::null. +.SH "QString QWhatsThis::textFor ( QWidget * w, const QPoint & pos = QPoint ( ), bool includeParents = FALSE )\fC [static]\fR" +Returns the what's this text for widget \fIw\fR or QString::null if there is no "What's this?" help for the widget. \fIpos\fR contains the mouse position; this is useful, for example, if you've subclassed to make the text that is displayed position dependent. +.PP +If \fIincludeParents\fR is TRUE, parent widgets are taken into consideration as well when looking for what's this help text. +.PP +See also add(). +.SH "QToolButton * QWhatsThis::whatsThisButton ( QWidget * parent )\fC [static]\fR" +Creates a QToolButton preconfigured to enter "What's this?" mode when clicked. You will often use this with a tool bar as \fIparent\fR: +.PP +.nf +.br + (void) QWhatsThis::whatsThisButton( my_help_tool_bar ); +.br +.fi +.PP +Example: helpsystem/mainwindow.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwhatsthis.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwhatsthis.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwheelevent.3qt b/doc/man/man3/tqwheelevent.3qt new file mode 100644 index 000000000..a58e8e491 --- /dev/null +++ b/doc/man/man3/tqwheelevent.3qt @@ -0,0 +1,160 @@ +'\" t +.TH QWheelEvent 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 +QWheelEvent \- Parameters that describe a wheel event +.SH SYNOPSIS +\fC#include <ntqevent.h>\fR +.PP +Inherits QEvent. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWheelEvent\fR ( const QPoint & pos, int delta, int state, Orientation orient = Vertical )" +.br +.ti -1c +.BI "\fBQWheelEvent\fR ( const QPoint & pos, const QPoint & globalPos, int delta, int state, Orientation orient = Vertical )" +.br +.ti -1c +.BI "int \fBdelta\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBpos\fR () const" +.br +.ti -1c +.BI "const QPoint & \fBglobalPos\fR () const" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "int \fBglobalX\fR () const" +.br +.ti -1c +.BI "int \fBglobalY\fR () const" +.br +.ti -1c +.BI "ButtonState \fBstate\fR () const" +.br +.ti -1c +.BI "Orientation \fBorientation\fR () const" +.br +.ti -1c +.BI "bool \fBisAccepted\fR () const" +.br +.ti -1c +.BI "void \fBaccept\fR ()" +.br +.ti -1c +.BI "void \fBignore\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWheelEvent class contains parameters that describe a wheel event. +.PP +Wheel events are sent to the widget under the mouse, and if that widget does not handle the event they are sent to the focus widget. The rotation distance is provided by delta(). The functions pos() and globalPos() return the mouse pointer location at the time of the event. +.PP +A wheel event contains a special accept flag that indicates whether the receiver wants the event. You should call QWheelEvent::accept() if you handle the wheel event; otherwise it will be sent to the parent widget. +.PP +The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget. +.PP +The event handler QWidget::wheelEvent() receives wheel events. +.PP +See also QMouseEvent, QWidget::grabMouse(), and Event Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWheelEvent::QWheelEvent ( const QPoint & pos, int delta, int state, Orientation orient = Vertical )" +Constructs a wheel event object. +.PP +The globalPos() is initialized to QCursor::pos(), i.e. \fIpos\fR, which is usually (but not always) right. Use the other constructor if you need to specify the global position explicitly. \fIdelta\fR contains the rotation distance, \fIstate\fR holds the keyboard modifier flags at the time of the event and \fIorient\fR holds the wheel's orientation. +.PP +See also pos(), delta(), and state(). +.SH "QWheelEvent::QWheelEvent ( const QPoint & pos, const QPoint & globalPos, int delta, int state, Orientation orient = Vertical )" +Constructs a wheel event object. The position when the event occurred is given in \fIpos\fR and \fIglobalPos\fR. \fIdelta\fR contains the rotation distance, \fIstate\fR holds the keyboard modifier flags at the time of the event and \fIorient\fR holds the wheel's orientation. +.PP +See also pos(), globalPos(), delta(), and state(). +.SH "void QWheelEvent::accept ()" +Sets the accept flag of the wheel event object. +.PP +Setting the accept parameter indicates that the receiver of the event wants the wheel event. Unwanted wheel events are sent to the parent widget. +.PP +The accept flag is set by default. +.PP +See also ignore(). +.SH "int QWheelEvent::delta () const" +Returns the distance that the wheel is rotated expressed in multiples or divisions of the \fIwheel delta\fR, which is currently defined to be 120. A positive value indicates that the wheel was rotated forwards away from the user; a negative value indicates that the wheel was rotated backwards toward the user. +.PP +The \fIwheel delta\fR constant was defined to be 120 by wheel mouse vendors to allow building finer-resolution wheels in the future, including perhaps a freely rotating wheel with no notches. The expectation is that such a device would send more messages per rotation but with a smaller value in each message. +.SH "const QPoint & QWheelEvent::globalPos () const" +Returns the global position of the mouse pointer \fIat the time of the event\fR. This is important on asynchronous window systems such as X11; whenever you move your widgets around in response to mouse events, globalPos() can differ a lot from the current pointer position QCursor::pos(). +.PP +See also globalX() and globalY(). +.SH "int QWheelEvent::globalX () const" +Returns the global x-position of the mouse pointer at the time of the event. +.PP +See also globalY() and globalPos(). +.SH "int QWheelEvent::globalY () const" +Returns the global y-position of the mouse pointer at the time of the event. +.PP +See also globalX() and globalPos(). +.SH "void QWheelEvent::ignore ()" +Clears the accept flag parameter of the wheel event object. +.PP +Clearing the accept parameter indicates that the event receiver does not want the wheel event. Unwanted wheel events are sent to the parent widget. The accept flag is set by default. +.PP +See also accept(). +.SH "bool QWheelEvent::isAccepted () const" +Returns TRUE if the receiver of the event handles the wheel event; otherwise returns FALSE. +.SH "Orientation QWheelEvent::orientation () const" +Returns the wheel's orientation. +.SH "const QPoint & QWheelEvent::pos () const" +Returns the position of the mouse pointer, relative to the widget that received the event. +.PP +If you move your widgets around in response to mouse events, use globalPos() instead of this function. +.PP +See also x(), y(), and globalPos(). +.SH "ButtonState QWheelEvent::state () const" +Returns the keyboard modifier flags of the event. +.PP +The returned value is ShiftButton, ControlButton, and AltButton OR'ed together. +.SH "int QWheelEvent::x () const" +Returns the x-position of the mouse pointer, relative to the widget that received the event. +.PP +See also y() and pos(). +.SH "int QWheelEvent::y () const" +Returns the y-position of the mouse pointer, relative to the widget that received the event. +.PP +See also x() and pos(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwheelevent.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwheelevent.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwidget.3qt b/doc/man/man3/tqwidget.3qt new file mode 100644 index 000000000..a654663b3 --- /dev/null +++ b/doc/man/man3/tqwidget.3qt @@ -0,0 +1,3219 @@ +'\" t +.TH QWidget 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 +QWidget \- The base class of all user interface objects +.SH SYNOPSIS +\fC#include <ntqwidget.h>\fR +.PP +Inherits QObject and QPaintDevice. +.PP +Inherited by QAxWidget, QButton, QFrame, QDialog, QComboBox, QDataBrowser, QDataView, QDateTimeEditBase, QDateTimeEdit, QDesktopWidget, QDial, QDockArea, QGLWidget, QHeader, QMainWindow, QMotifWidget, QNPWidget, QScrollBar, QSizeGrip, QSlider, QSpinBox, QSplashScreen, QStatusBar, QTabBar, QTabWidget, QWorkspace, and QXtWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "explicit \fBQWidget\fR ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QWidget\fR ()" +.br +.ti -1c +.BI "WId \fBwinId\fR () const" +.br +.ti -1c +.BI "QStyle & \fBstyle\fR () const" +.br +.ti -1c +.BI "void \fBsetStyle\fR ( QStyle * style )" +.br +.ti -1c +.BI "QStyle * \fBsetStyle\fR ( const QString & style )" +.br +.ti -1c +.BI "bool \fBisTopLevel\fR () const" +.br +.ti -1c +.BI "bool \fBisDialog\fR () const" +.br +.ti -1c +.BI "bool \fBisPopup\fR () const" +.br +.ti -1c +.BI "bool \fBisDesktop\fR () const" +.br +.ti -1c +.BI "bool \fBisModal\fR () const" +.br +.ti -1c +.BI "bool \fBisEnabled\fR () const" +.br +.ti -1c +.BI "bool \fBisEnabledTo\fR ( QWidget * ancestor ) const" +.br +.ti -1c +.BI "bool isEnabledToTLW () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QRect \fBframeGeometry\fR () const" +.br +.ti -1c +.BI "const QRect & \fBgeometry\fR () const" +.br +.ti -1c +.BI "int \fBx\fR () const" +.br +.ti -1c +.BI "int \fBy\fR () const" +.br +.ti -1c +.BI "QPoint \fBpos\fR () const" +.br +.ti -1c +.BI "QSize \fBframeSize\fR () const" +.br +.ti -1c +.BI "QSize \fBsize\fR () const" +.br +.ti -1c +.BI "int \fBwidth\fR () const" +.br +.ti -1c +.BI "int \fBheight\fR () const" +.br +.ti -1c +.BI "QRect \fBrect\fR () const" +.br +.ti -1c +.BI "QRect \fBchildrenRect\fR () const" +.br +.ti -1c +.BI "QRegion \fBchildrenRegion\fR () const" +.br +.ti -1c +.BI "QSize \fBminimumSize\fR () const" +.br +.ti -1c +.BI "QSize \fBmaximumSize\fR () const" +.br +.ti -1c +.BI "int \fBminimumWidth\fR () const" +.br +.ti -1c +.BI "int \fBminimumHeight\fR () const" +.br +.ti -1c +.BI "int \fBmaximumWidth\fR () const" +.br +.ti -1c +.BI "int \fBmaximumHeight\fR () const" +.br +.ti -1c +.BI "void \fBsetMinimumSize\fR ( const QSize & )" +.br +.ti -1c +.BI "virtual void \fBsetMinimumSize\fR ( int minw, int minh )" +.br +.ti -1c +.BI "void \fBsetMaximumSize\fR ( const QSize & )" +.br +.ti -1c +.BI "virtual void \fBsetMaximumSize\fR ( int maxw, int maxh )" +.br +.ti -1c +.BI "void \fBsetMinimumWidth\fR ( int minw )" +.br +.ti -1c +.BI "void \fBsetMinimumHeight\fR ( int minh )" +.br +.ti -1c +.BI "void \fBsetMaximumWidth\fR ( int maxw )" +.br +.ti -1c +.BI "void \fBsetMaximumHeight\fR ( int maxh )" +.br +.ti -1c +.BI "QSize \fBsizeIncrement\fR () const" +.br +.ti -1c +.BI "void \fBsetSizeIncrement\fR ( const QSize & )" +.br +.ti -1c +.BI "virtual void \fBsetSizeIncrement\fR ( int w, int h )" +.br +.ti -1c +.BI "QSize \fBbaseSize\fR () const" +.br +.ti -1c +.BI "void \fBsetBaseSize\fR ( const QSize & )" +.br +.ti -1c +.BI "void \fBsetBaseSize\fR ( int basew, int baseh )" +.br +.ti -1c +.BI "void \fBsetFixedSize\fR ( const QSize & s )" +.br +.ti -1c +.BI "void \fBsetFixedSize\fR ( int w, int h )" +.br +.ti -1c +.BI "void \fBsetFixedWidth\fR ( int w )" +.br +.ti -1c +.BI "void \fBsetFixedHeight\fR ( int h )" +.br +.ti -1c +.BI "QPoint \fBmapToGlobal\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "QPoint \fBmapFromGlobal\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "QPoint \fBmapToParent\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "QPoint \fBmapFromParent\fR ( const QPoint & pos ) const" +.br +.ti -1c +.BI "QPoint \fBmapTo\fR ( QWidget * parent, const QPoint & pos ) const" +.br +.ti -1c +.BI "QPoint \fBmapFrom\fR ( QWidget * parent, const QPoint & pos ) const" +.br +.ti -1c +.BI "QWidget * \fBtopLevelWidget\fR () const" +.br +.ti -1c +.BI "BackgroundMode \fBbackgroundMode\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetBackgroundMode\fR ( BackgroundMode )" +.br +.ti -1c +.BI "void \fBsetBackgroundMode\fR ( BackgroundMode m, BackgroundMode visual )" +.br +.ti -1c +.BI "const QColor & \fBforegroundColor\fR () const" +.br +.ti -1c +.BI "const QColor & \fBeraseColor\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetEraseColor\fR ( const QColor & color )" +.br +.ti -1c +.BI "const QPixmap * \fBerasePixmap\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetErasePixmap\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "const QColorGroup & \fBcolorGroup\fR () const" +.br +.ti -1c +.BI "const QPalette & \fBpalette\fR () const" +.br +.ti -1c +.BI "bool \fBownPalette\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPalette\fR ( const QPalette & )" +.br +.ti -1c +.BI "void \fBunsetPalette\fR ()" +.br +.ti -1c +.BI "const QColor & \fBpaletteForegroundColor\fR () const" +.br +.ti -1c +.BI "void \fBsetPaletteForegroundColor\fR ( const QColor & )" +.br +.ti -1c +.BI "const QColor & \fBpaletteBackgroundColor\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPaletteBackgroundColor\fR ( const QColor & )" +.br +.ti -1c +.BI "const QPixmap * \fBpaletteBackgroundPixmap\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetPaletteBackgroundPixmap\fR ( const QPixmap & )" +.br +.ti -1c +.BI "const QBrush & \fBbackgroundBrush\fR () const" +.br +.ti -1c +.BI "QFont \fBfont\fR () const" +.br +.ti -1c +.BI "bool \fBownFont\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFont\fR ( const QFont & )" +.br +.ti -1c +.BI "void \fBunsetFont\fR ()" +.br +.ti -1c +.BI "QFontMetrics \fBfontMetrics\fR () const" +.br +.ti -1c +.BI "QFontInfo \fBfontInfo\fR () const" +.br +.ti -1c +.BI "const QCursor & \fBcursor\fR () const" +.br +.ti -1c +.BI "bool \fBownCursor\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetCursor\fR ( const QCursor & )" +.br +.ti -1c +.BI "virtual void \fBunsetCursor\fR ()" +.br +.ti -1c +.BI "QString \fBcaption\fR () const" +.br +.ti -1c +.BI "const QPixmap * \fBicon\fR () const" +.br +.ti -1c +.BI "QString \fBiconText\fR () const" +.br +.ti -1c +.BI "bool \fBhasMouseTracking\fR () const" +.br +.ti -1c +.BI "bool \fBhasMouse\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetMask\fR ( const QBitmap & bitmap )" +.br +.ti -1c +.BI "virtual void \fBsetMask\fR ( const QRegion & region )" +.br +.ti -1c +.BI "void \fBclearMask\fR ()" +.br +.ti -1c +.BI "const QColor & backgroundColor () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void setBackgroundColor ( const QColor & c ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "const QPixmap * backgroundPixmap () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void setBackgroundPixmap ( const QPixmap & pm ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "enum \fBFocusPolicy\fR { NoFocus = 0, TabFocus = 0x1, ClickFocus = 0x2, StrongFocus = TabFocus | ClickFocus | 0x8, WheelFocus = StrongFocus | 0x4 }" +.br +.ti -1c +.BI "bool \fBisActiveWindow\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetActiveWindow\fR ()" +.br +.ti -1c +.BI "bool \fBisFocusEnabled\fR () const" +.br +.ti -1c +.BI "FocusPolicy \fBfocusPolicy\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFocusPolicy\fR ( FocusPolicy )" +.br +.ti -1c +.BI "bool \fBhasFocus\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetFocusProxy\fR ( QWidget * w )" +.br +.ti -1c +.BI "QWidget * \fBfocusProxy\fR () const" +.br +.ti -1c +.BI "void \fBsetInputMethodEnabled\fR ( bool b )" +.br +.ti -1c +.BI "bool \fBisInputMethodEnabled\fR () const" +.br +.ti -1c +.BI "void \fBgrabMouse\fR ()" +.br +.ti -1c +.BI "void \fBgrabMouse\fR ( const QCursor & cursor )" +.br +.ti -1c +.BI "void \fBreleaseMouse\fR ()" +.br +.ti -1c +.BI "void \fBgrabKeyboard\fR ()" +.br +.ti -1c +.BI "void \fBreleaseKeyboard\fR ()" +.br +.ti -1c +.BI "bool \fBisUpdatesEnabled\fR () const" +.br +.ti -1c +.BI "virtual bool \fBclose\fR ( bool alsoDelete )" +.br +.ti -1c +.BI "bool \fBisVisible\fR () const" +.br +.ti -1c +.BI "bool \fBisVisibleTo\fR ( QWidget * ancestor ) const" +.br +.ti -1c +.BI "bool isVisibleToTLW () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QRect visibleRect () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "bool \fBisHidden\fR () const" +.br +.ti -1c +.BI "bool \fBisShown\fR () const" +.br +.ti -1c +.BI "bool \fBisMinimized\fR () const" +.br +.ti -1c +.BI "bool \fBisMaximized\fR () const" +.br +.ti -1c +.BI "bool \fBisFullScreen\fR () const" +.br +.ti -1c +.BI "uint \fBwindowState\fR () const" +.br +.ti -1c +.BI "void \fBsetWindowState\fR ( uint windowState )" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBminimumSizeHint\fR () const" +.br +.ti -1c +.BI "virtual QSizePolicy \fBsizePolicy\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetSizePolicy\fR ( QSizePolicy )" +.br +.ti -1c +.BI "void \fBsetSizePolicy\fR ( QSizePolicy::SizeType hor, QSizePolicy::SizeType ver, bool hfw = FALSE )" +.br +.ti -1c +.BI "virtual int \fBheightForWidth\fR ( int w ) const" +.br +.ti -1c +.BI "QRegion \fBclipRegion\fR () const" +.br +.ti -1c +.BI "QLayout * \fBlayout\fR () const" +.br +.ti -1c +.BI "void \fBupdateGeometry\fR ()" +.br +.ti -1c +.BI "virtual void \fBreparent\fR ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE )" +.br +.ti -1c +.BI "void \fBreparent\fR ( QWidget * parent, const QPoint & p, bool showIt = FALSE )" +.br +.ti -1c +.BI "void recreate ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void \fBerase\fR ()" +.br +.ti -1c +.BI "void \fBerase\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBerase\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBerase\fR ( const QRegion & reg )" +.br +.ti -1c +.BI "void \fBscroll\fR ( int dx, int dy )" +.br +.ti -1c +.BI "void \fBscroll\fR ( int dx, int dy, const QRect & r )" +.br +.ti -1c +.BI "void \fBdrawText\fR ( int x, int y, const QString & str )" +.br +.ti -1c +.BI "void \fBdrawText\fR ( const QPoint & pos, const QString & str )" +.br +.ti -1c +.BI "QWidget * \fBfocusWidget\fR () const" +.br +.ti -1c +.BI "QRect \fBmicroFocusHint\fR () const" +.br +.ti -1c +.BI "bool \fBacceptDrops\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetAcceptDrops\fR ( bool on )" +.br +.ti -1c +.BI "virtual void \fBsetAutoMask\fR ( bool )" +.br +.ti -1c +.BI "bool \fBautoMask\fR () const" +.br +.ti -1c +.BI "enum \fBBackgroundOrigin\fR { WidgetOrigin, ParentOrigin, WindowOrigin, AncestorOrigin }" +.br +.ti -1c +.BI "virtual void \fBsetBackgroundOrigin\fR ( BackgroundOrigin )" +.br +.ti -1c +.BI "BackgroundOrigin \fBbackgroundOrigin\fR () const" +.br +.ti -1c +.BI "virtual bool \fBcustomWhatsThis\fR () const" +.br +.ti -1c +.BI "QWidget * \fBparentWidget\fR ( bool sameWindow = FALSE ) const" +.br +.ti -1c +.BI "WFlags \fBtestWFlags\fR ( WFlags f ) const" +.br +.ti -1c +.BI "QWidget * \fBchildAt\fR ( int x, int y, bool includeThis = FALSE ) const" +.br +.ti -1c +.BI "QWidget * \fBchildAt\fR ( const QPoint & p, bool includeThis = FALSE ) const" +.br +.ti -1c +.BI "void \fBsetWindowOpacity\fR ( double level )" +.br +.ti -1c +.BI "double \fBwindowOpacity\fR () const" +.br +.ti -1c +.BI "void setPalette ( const QPalette & p, bool ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "void setFont ( const QFont & f, bool ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetEnabled\fR ( bool )" +.br +.ti -1c +.BI "void \fBsetDisabled\fR ( bool disable )" +.br +.ti -1c +.BI "virtual void \fBsetCaption\fR ( const QString & )" +.br +.ti -1c +.BI "virtual void \fBsetIcon\fR ( const QPixmap & )" +.br +.ti -1c +.BI "virtual void \fBsetIconText\fR ( const QString & )" +.br +.ti -1c +.BI "virtual void \fBsetMouseTracking\fR ( bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetFocus\fR ()" +.br +.ti -1c +.BI "void \fBclearFocus\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetUpdatesEnabled\fR ( bool enable )" +.br +.ti -1c +.BI "void \fBupdate\fR ()" +.br +.ti -1c +.BI "void \fBupdate\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "void \fBupdate\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBrepaint\fR ()" +.br +.ti -1c +.BI "void \fBrepaint\fR ( bool erase )" +.br +.ti -1c +.BI "void \fBrepaint\fR ( int x, int y, int w, int h, bool erase = TRUE )" +.br +.ti -1c +.BI "void \fBrepaint\fR ( const QRect & r, bool erase = TRUE )" +.br +.ti -1c +.BI "void \fBrepaint\fR ( const QRegion & reg, bool erase = TRUE )" +.br +.ti -1c +.BI "virtual void \fBshow\fR ()" +.br +.ti -1c +.BI "virtual void \fBhide\fR ()" +.br +.ti -1c +.BI "void \fBsetShown\fR ( bool show )" +.br +.ti -1c +.BI "void \fBsetHidden\fR ( bool hide )" +.br +.ti -1c +.BI "void iconify () \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual void \fBshowMinimized\fR ()" +.br +.ti -1c +.BI "virtual void \fBshowMaximized\fR ()" +.br +.ti -1c +.BI "void \fBshowFullScreen\fR ()" +.br +.ti -1c +.BI "virtual void \fBshowNormal\fR ()" +.br +.ti -1c +.BI "virtual void \fBpolish\fR ()" +.br +.ti -1c +.BI "void \fBconstPolish\fR () const" +.br +.ti -1c +.BI "bool \fBclose\fR ()" +.br +.ti -1c +.BI "void \fBraise\fR ()" +.br +.ti -1c +.BI "void \fBlower\fR ()" +.br +.ti -1c +.BI "void \fBstackUnder\fR ( QWidget * w )" +.br +.ti -1c +.BI "virtual void \fBmove\fR ( int x, int y )" +.br +.ti -1c +.BI "void \fBmove\fR ( const QPoint & )" +.br +.ti -1c +.BI "virtual void \fBresize\fR ( int w, int h )" +.br +.ti -1c +.BI "void \fBresize\fR ( const QSize & )" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( int x, int y, int w, int h )" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( const QRect & )" +.br +.ti -1c +.BI "virtual void \fBadjustSize\fR ()" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBsetTabOrder\fR ( QWidget * first, QWidget * second )" +.br +.ti -1c +.BI "QWidget * \fBmouseGrabber\fR ()" +.br +.ti -1c +.BI "QWidget * \fBkeyboardGrabber\fR ()" +.br +.ti -1c +.BI "QWidget * \fBfind\fR ( WId id )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBacceptDrops\fR - whether drop events are enabled for this widget" +.br +.ti -1c +.BI "bool \fBautoMask\fR - whether the auto mask feature is enabled for the widget" +.br +.ti -1c +.BI "QBrush \fBbackgroundBrush\fR - the widget's background brush \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "BackgroundMode \fBbackgroundMode\fR - the color role used for painting the background of the widget" +.br +.ti -1c +.BI "BackgroundOrigin \fBbackgroundOrigin\fR - the origin of the widget's background" +.br +.ti -1c +.BI "QSize \fBbaseSize\fR - the base size of the widget" +.br +.ti -1c +.BI "QString \fBcaption\fR - the window caption (title)" +.br +.ti -1c +.BI "QRect \fBchildrenRect\fR - the bounding rectangle of the widget's children \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QRegion \fBchildrenRegion\fR - the combined region occupied by the widget's children \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QColorGroup \fBcolorGroup\fR - the current color group of the widget palette \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QCursor \fBcursor\fR - the cursor shape for this widget" +.br +.ti -1c +.BI "bool \fBcustomWhatsThis\fR - whether the widget wants to handle What's This help manually \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBenabled\fR - whether the widget is enabled" +.br +.ti -1c +.BI "bool \fBfocus\fR - whether this widget (or its focus " "proxy" ") has the keyboard input focus \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBfocusEnabled\fR - whether the widget accepts keyboard focus \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "FocusPolicy \fBfocusPolicy\fR - the way the widget accepts keyboard focus" +.br +.ti -1c +.BI "QFont \fBfont\fR - the font currently set for the widget" +.br +.ti -1c +.BI "QRect \fBframeGeometry\fR - geometry of the widget relative to its parent including any window frame \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QSize \fBframeSize\fR - the size of the widget including any window frame \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBfullScreen\fR - whether the widget is full screen \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QRect \fBgeometry\fR - the geometry of the widget relative to its parent and excluding the window frame" +.br +.ti -1c +.BI "int \fBheight\fR - the height of the widget excluding any window frame \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBhidden\fR - whether the widget is explicitly hidden" +.br +.ti -1c +.BI "QPixmap \fBicon\fR - the widget's icon" +.br +.ti -1c +.BI "QString \fBiconText\fR - the widget's icon text" +.br +.ti -1c +.BI "bool \fBinputMethodEnabled\fR - enables or disables the use of input methods for this widget" +.br +.ti -1c +.BI "bool \fBisActiveWindow\fR - whether this widget is the active window \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBisDesktop\fR - whether the widget is a desktop " "widget" ", i.e. represents the desktop \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBisDialog\fR - whether the widget is a dialog widget \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBisModal\fR - whether the widget is a modal widget \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBisPopup\fR - whether the widget is a popup widget \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBisTopLevel\fR - whether the widget is a top-level widget \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBmaximized\fR - whether this widget is maximized \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBmaximumHeight\fR - the widget's maximum height" +.br +.ti -1c +.BI "QSize \fBmaximumSize\fR - the widget's maximum size" +.br +.ti -1c +.BI "int \fBmaximumWidth\fR - the widget's maximum width" +.br +.ti -1c +.BI "QRect \fBmicroFocusHint\fR - the currently set micro focus hint for this widget \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBminimized\fR - whether this widget is minimized (iconified) \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBminimumHeight\fR - the widget's minimum height" +.br +.ti -1c +.BI "QSize \fBminimumSize\fR - the widget's minimum size" +.br +.ti -1c +.BI "QSize \fBminimumSizeHint\fR - the recommended minimum size for the widget \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBminimumWidth\fR - the widget's minimum width" +.br +.ti -1c +.BI "bool \fBmouseTracking\fR - whether mouse tracking is enabled for the widget" +.br +.ti -1c +.BI "bool \fBownCursor\fR - whether the widget uses its own cursor \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBownFont\fR - whether the widget uses its own font \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBownPalette\fR - whether the widget uses its own palette \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QPalette \fBpalette\fR - the widget's palette" +.br +.ti -1c +.BI "QColor \fBpaletteBackgroundColor\fR - the background color of the widget" +.br +.ti -1c +.BI "QPixmap \fBpaletteBackgroundPixmap\fR - the background pixmap of the widget" +.br +.ti -1c +.BI "QColor \fBpaletteForegroundColor\fR - the foreground color of the widget" +.br +.ti -1c +.BI "QPoint \fBpos\fR - the position of the widget within its parent widget" +.br +.ti -1c +.BI "QRect \fBrect\fR - the internal geometry of the widget excluding any window frame \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBshown\fR - whether the widget is shown" +.br +.ti -1c +.BI "QSize \fBsize\fR - the size of the widget excluding any window frame" +.br +.ti -1c +.BI "QSize \fBsizeHint\fR - the recommended size for the widget \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QSize \fBsizeIncrement\fR - the size increment of the widget" +.br +.ti -1c +.BI "QSizePolicy \fBsizePolicy\fR - the default layout behavior of the widget" +.br +.ti -1c +.BI "bool \fBunderMouse\fR - whether the widget is under the mouse cursor \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "bool \fBupdatesEnabled\fR - whether updates are enabled" +.br +.ti -1c +.BI "bool \fBvisible\fR - whether the widget is visible \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "QRect visibleRect - the visible rectangle \fI(read " "only" ")\fR \fI(obsolete)\fR" +.br +.ti -1c +.BI "int \fBwidth\fR - the width of the widget excluding any window frame \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "double \fBwindowOpacity\fR - the level of opacity for the window" +.br +.ti -1c +.BI "int \fBx\fR - the x coordinate of the widget relative to its parent including any window frame \fI(read " "only" ")\fR" +.br +.ti -1c +.BI "int \fBy\fR - the y coordinate of the widget relative to its parent and including any window frame \fI(read " "only" ")\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual bool \fBevent\fR ( QEvent * e )" +.br +.ti -1c +.BI "virtual void \fBmousePressEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBmouseReleaseEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBmouseDoubleClickEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBmouseMoveEvent\fR ( QMouseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBwheelEvent\fR ( QWheelEvent * e )" +.br +.ti -1c +.BI "virtual void \fBkeyPressEvent\fR ( QKeyEvent * e )" +.br +.ti -1c +.BI "virtual void \fBkeyReleaseEvent\fR ( QKeyEvent * e )" +.br +.ti -1c +.BI "virtual void \fBfocusInEvent\fR ( QFocusEvent * )" +.br +.ti -1c +.BI "virtual void \fBfocusOutEvent\fR ( QFocusEvent * )" +.br +.ti -1c +.BI "virtual void \fBenterEvent\fR ( QEvent * )" +.br +.ti -1c +.BI "virtual void \fBleaveEvent\fR ( QEvent * )" +.br +.ti -1c +.BI "virtual void \fBpaintEvent\fR ( QPaintEvent * )" +.br +.ti -1c +.BI "virtual void \fBmoveEvent\fR ( QMoveEvent * )" +.br +.ti -1c +.BI "virtual void \fBresizeEvent\fR ( QResizeEvent * )" +.br +.ti -1c +.BI "virtual void \fBcloseEvent\fR ( QCloseEvent * e )" +.br +.ti -1c +.BI "virtual void \fBcontextMenuEvent\fR ( QContextMenuEvent * e )" +.br +.ti -1c +.BI "virtual void \fBimStartEvent\fR ( QIMEvent * e )" +.br +.ti -1c +.BI "virtual void \fBimComposeEvent\fR ( QIMEvent * e )" +.br +.ti -1c +.BI "virtual void \fBimEndEvent\fR ( QIMEvent * e )" +.br +.ti -1c +.BI "virtual void \fBtabletEvent\fR ( QTabletEvent * e )" +.br +.ti -1c +.BI "virtual void \fBdragEnterEvent\fR ( QDragEnterEvent * )" +.br +.ti -1c +.BI "virtual void \fBdragMoveEvent\fR ( QDragMoveEvent * )" +.br +.ti -1c +.BI "virtual void \fBdragLeaveEvent\fR ( QDragLeaveEvent * )" +.br +.ti -1c +.BI "virtual void \fBdropEvent\fR ( QDropEvent * )" +.br +.ti -1c +.BI "virtual void \fBshowEvent\fR ( QShowEvent * )" +.br +.ti -1c +.BI "virtual void \fBhideEvent\fR ( QHideEvent * )" +.br +.ti -1c +.BI "virtual bool \fBmacEvent\fR ( MSG * )" +.br +.ti -1c +.BI "virtual bool \fBwinEvent\fR ( MSG * )" +.br +.ti -1c +.BI "virtual bool \fBx11Event\fR ( XEvent * )" +.br +.ti -1c +.BI "virtual bool \fBqwsEvent\fR ( QWSEvent * )" +.br +.ti -1c +.BI "virtual void \fBupdateMask\fR ()" +.br +.ti -1c +.BI "virtual void \fBstyleChange\fR ( QStyle & oldStyle )" +.br +.ti -1c +.BI "virtual void \fBenabledChange\fR ( bool oldEnabled )" +.br +.ti -1c +.BI "virtual void \fBpaletteChange\fR ( const QPalette & oldPalette )" +.br +.ti -1c +.BI "virtual void \fBfontChange\fR ( const QFont & oldFont )" +.br +.ti -1c +.BI "virtual void \fBwindowActivationChange\fR ( bool oldActive )" +.br +.ti -1c +.BI "virtual int \fBmetric\fR ( int m ) const" +.br +.ti -1c +.BI "void \fBresetInputContext\fR ()" +.br +.ti -1c +.BI "virtual void \fBcreate\fR ( WId window = 0, bool initializeWindow = TRUE, bool destroyOldWindow = TRUE )" +.br +.ti -1c +.BI "virtual void \fBdestroy\fR ( bool destroyWindow = TRUE, bool destroySubWindows = TRUE )" +.br +.ti -1c +.BI "WFlags \fBgetWFlags\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetWFlags\fR ( WFlags f )" +.br +.ti -1c +.BI "void \fBclearWFlags\fR ( WFlags f )" +.br +.ti -1c +.BI "virtual bool \fBfocusNextPrevChild\fR ( bool next )" +.br +.ti -1c +.BI "QFocusData * \fBfocusData\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetKeyCompression\fR ( bool compress )" +.br +.ti -1c +.BI "virtual void \fBsetMicroFocusHint\fR ( int x, int y, int width, int height, bool text = TRUE, QFont * f = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QWidget class is the base class of all user interface objects. +.PP +The widget is the atom of the user interface: it receives mouse, keyboard and other events from the window system, and paints a representation of itself on the screen. Every widget is rectangular, and they are sorted in a Z-order. A widget is clipped by its parent and by the widgets in front of it. +.PP +A widget that isn't embedded in a parent widget is called a top-level widget. Usually, top-level widgets are windows with a frame and a title bar (although it is also possible to create top-level widgets without such decoration if suitable widget flags are used). In Qt, QMainWindow and the various subclasses of QDialog are the most common top-level windows. +.PP +A widget without a parent widget is always a top-level widget. +.PP +Non-top-level widgets are child widgets. These are child windows in their parent widgets. You cannot usually distinguish a child widget from its parent visually. Most other widgets in Qt are useful only as child widgets. (It is possible to make, say, a button into a top-level widget, but most people prefer to put their buttons inside other widgets, e.g. QDialog.) +.PP +If you want to use a QWidget to hold child widgets you will probably want to add a layout to the parent QWidget. (See Layouts.) +.PP +QWidget has many member functions, but some of them have little direct functionality: for example, QWidget has a font property, but never uses this itself. There are many subclasses which provide real functionality, such as QPushButton, QListBox and QTabDialog, etc. +.SH "Groups of functions:" +<center>.nf +.TS +l - l. Context Functions Window functions show(), hide(), raise(), lower(), close(). Top level windows caption(), setCaption(), icon(), setIcon(), iconText(), setIconText(), isActiveWindow(), setActiveWindow(), showMinimized(). showMaximized(), showFullScreen(), showNormal(). Window contents update(), repaint(), erase(), scroll(), updateMask(). Geometry pos(), size(), rect(), x(), y(), width(), height(), sizePolicy(), setSizePolicy(), sizeHint(), updateGeometry(), layout(), move(), resize(), setGeometry(), frameGeometry(), geometry(), childrenRect(), adjustSize(), mapFromGlobal(), mapFromParent() mapToGlobal(), mapToParent(), maximumSize(), minimumSize(), sizeIncrement(), setMaximumSize(), setMinimumSize(), setSizeIncrement(), setBaseSize(), setFixedSize() Mode isVisible(), isVisibleTo(), isMinimized(), isDesktop(), isEnabled(), isEnabledTo(), isModal(), isPopup(), isTopLevel(), setEnabled(), hasMouseTracking(), setMouseTracking(), isUpdatesEnabled(), setUpdatesEnabled(), clipRegion(). Look and feel style(), setStyle(), cursor(), setCursor() font(), setFont(), palette(), setPalette(), backgroundMode(), setBackgroundMode(), colorGroup(), fontMetrics(), fontInfo(). Keyboard focus +.br +functions isFocusEnabled(), setFocusPolicy(), focusPolicy(), hasFocus(), setFocus(), clearFocus(), setTabOrder(), setFocusProxy(). Mouse and +.br +keyboard grabbing grabMouse(), releaseMouse(), grabKeyboard(), releaseKeyboard(), mouseGrabber(), keyboardGrabber(). Event handlers event(), mousePressEvent(), mouseReleaseEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), keyPressEvent(), keyReleaseEvent(), focusInEvent(), focusOutEvent(), wheelEvent(), enterEvent(), leaveEvent(), paintEvent(), moveEvent(), resizeEvent(), closeEvent(), dragEnterEvent(), dragMoveEvent(), dragLeaveEvent(), dropEvent(), childEvent(), showEvent(), hideEvent(), customEvent(). Change handlers enabledChange(), fontChange(), paletteChange(), styleChange(), windowActivationChange(). System functions parentWidget(), topLevelWidget(), reparent(), polish(), winId(), find(), metric(). What's this help customWhatsThis() Internal kernel +.br +functions +.TE +.fi +</center> +.PP +Every widget's constructor accepts two or three standard arguments: <ol type=1> +.IP 1 +\fCQWidget *parent = 0\fR is the parent of the new widget. If it is 0 (the default), the new widget will be a top-level window. If not, it will be a child of \fIparent\fR, and be constrained by \fIparent\fR's geometry (unless you specify WType_TopLevel as widget flag). +.IP 2 +\fCconst char *name = 0\fR is the widget name of the new widget. You can access it using name(). The widget name is little used by programmers but is quite useful with GUI builders such as \fIQt Designer\fR (you can name a widget in \fIQt Designer\fR, and connect() to it using the name in your code). The dumpObjectTree() debugging function also uses it. +.IP 3 +\fCWFlags f = 0\fR (where available) sets the widget flags; the default is suitable for almost all widgets, but to get, for example, a top-level widget without a window system frame, you must use special flags. +.PP +The tictac/tictac.cpp example program is good example of a simple widget. It contains a few event handlers (as all widgets must), a few custom routines that are specific to it (as all useful widgets do), and has a few children and connections. Everything it does is done in response to an event: this is by far the most common way to design GUI applications. +.PP +You will need to supply the content for your widgets yourself, but here is a brief run-down of the events, starting with the most common ones: +.IP +.TP +paintEvent() - called whenever the widget needs to be repainted. Every widget which displays output must implement it, and it is wise \fInot\fR to paint on the screen outside paintEvent(). +.IP +.TP +resizeEvent() - called when the widget has been resized. +.IP +.TP +mousePressEvent() - called when a mouse button is pressed. There are six mouse-related events, but the mouse press and mouse release events are by far the most important. A widget receives mouse press events when the mouse is inside it, or when it has grabbed the mouse using grabMouse(). +.IP +.TP +mouseReleaseEvent() - called when a mouse button is released. A widget receives mouse release events when it has received the corresponding mouse press event. This means that if the user presses the mouse inside \fIyour\fR widget, then drags the mouse to somewhere else, then releases, \fIyour\fR widget receives the release event. There is one exception: if a popup menu appears while the mouse button is held down, this popup immediately steals the mouse events. +.IP +.TP +mouseDoubleClickEvent() - not quite as obvious as it might seem. If the user double-clicks, the widget receives a mouse press event (perhaps a mouse move event or two if they don't hold the mouse quite steady), a mouse release event and finally this event. It is \fInot possible\fR to distinguish a click from a double click until you've seen whether the second click arrives. (This is one reason why most GUI books recommend that double clicks be an extension of single clicks, rather than trigger a different action.) +.IP +.PP +If your widget only contains child widgets, you probably do not need to implement any event handlers. If you want to detect a mouse click in a child widget call the child's hasMouse() function inside the parent widget's mousePressEvent(). +.PP +Widgets that accept keyboard input need to reimplement a few more event handlers: +.IP +.TP +keyPressEvent() - called whenever a key is pressed, and again when a key has been held down long enough for it to auto-repeat. Note that the Tab and Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement QWidget::event(). +.IP +.TP +focusInEvent() - called when the widget gains keyboard focus (assuming you have called setFocusPolicy()). Well written widgets indicate that they own the keyboard focus in a clear but discreet way. +.IP +.TP +focusOutEvent() - called when the widget loses keyboard focus. +.IP +.PP +Some widgets will also need to reimplement some of the less common event handlers: +.IP +.TP +mouseMoveEvent() - called whenever the mouse moves while a button is held down. This is useful for, for example, dragging. If you call setMouseTracking(TRUE), you get mouse move events even when no buttons are held down. (Note that applications which make use of mouse tracking are often not very useful on low-bandwidth X connections.) (See also the drag and drop information.) +.IP +.TP +keyReleaseEvent() - called whenever a key is released, and also while it is held down if the key is auto-repeating. In that case the widget receives a key release event and immediately a key press event for every repeat. Note that the Tab and Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement QWidget::event(). +.IP +.TP +wheelEvent() -- called whenever the user turns the mouse wheel while the widget has the focus. +.IP +.TP +enterEvent() - called when the mouse enters the widget's screen space. (This excludes screen space owned by any children of the widget.) +.IP +.TP +leaveEvent() - called when the mouse leaves the widget's screen space. +.IP +.TP +moveEvent() - called when the widget has been moved relative to its parent. +.IP +.TP +closeEvent() - called when the user closes the widget (or when close() is called). +.IP +.PP +There are also some rather obscure events. They are listed in ntqevent.h and you need to reimplement event() to handle them. The default implementation of event() handles Tab and Shift+Tab (to move the keyboard focus), and passes on most other events to one of the more specialized handlers above. +.PP +When implementing a widget, there are a few more things to consider. +.IP +.TP +In the constructor, be sure to set up your member variables early on, before there's any chance that you might receive an event. +.IP +.TP +It is almost always useful to reimplement sizeHint() and to set the correct size policy with setSizePolicy(), so users of your class can set up layout management more easily. A size policy lets you supply good defaults for the layout management handling, so that other widgets can contain and manage yours easily. sizeHint() indicates a "good" size for the widget. +.IP +.TP +If your widget is a top-level window, setCaption() and setIcon() set the title bar and icon respectively. +.IP +.PP +See also QEvent, QPainter, QGridLayout, QBoxLayout, and Abstract Widget Classes. +.SS "Member Type Documentation" +.SH "QWidget::BackgroundOrigin" +This enum defines the origin used to draw a widget's background pixmap. +.PP +The pixmap is drawn using the: +.TP +\fCQWidget::WidgetOrigin\fR - widget's coordinate system. +.TP +\fCQWidget::ParentOrigin\fR - parent's coordinate system. +.TP +\fCQWidget::WindowOrigin\fR - top-level window's coordinate system. +.TP +\fCQWidget::AncestorOrigin\fR - same origin as the parent uses. +.SH "QWidget::FocusPolicy" +This enum type defines the various policies a widget can have with respect to acquiring keyboard focus. +.TP +\fCQWidget::TabFocus\fR - the widget accepts focus by tabbing. +.TP +\fCQWidget::ClickFocus\fR - the widget accepts focus by clicking. +.TP +\fCQWidget::StrongFocus\fR - the widget accepts focus by both tabbing and clicking. On Mac OS X this will also be indicate that the widget accepts tab focus when in 'Text/List focus mode'. +.TP +\fCQWidget::WheelFocus\fR - like StrongFocus plus the widget accepts focus by using the mouse wheel. +.TP +\fCQWidget::NoFocus\fR - the widget does not accept focus. +.PP +.SH MEMBER FUNCTION DOCUMENTATION +.SH "explicit QWidget::QWidget ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +Constructs a widget which is a child of \fIparent\fR, with the name \fIname\fR and widget flags set to \fIf\fR. +.PP +If \fIparent\fR is 0, the new widget becomes a top-level window. If \fIparent\fR is another widget, this widget becomes a child window inside \fIparent\fR. The new widget is deleted when its \fIparent\fR is deleted. +.PP +The \fIname\fR is sent to the QObject constructor. +.PP +The widget flags argument, \fIf\fR, is normally 0, but it can be set to customize the window frame of a top-level widget (i.e. \fIparent\fR must be 0). To customize the frame, set the WStyle_Customize flag OR'ed with any of the Qt::WidgetFlags. +.PP +If you add a child widget to an already visible widget you must explicitly show the child to make it visible. +.PP +Note that the X11 version of Qt may not be able to deliver all combinations of style flags on all systems. This is because on X11, Qt can only ask the window manager, and the window manager can override the application's settings. On Windows, Qt can set whatever flags you want. +.PP +Example: +.PP +.nf +.br + QLabel *splashScreen = new QLabel( 0, "mySplashScreen", +.br + WStyle_Customize | WStyle_Splash ); +.br +.fi +.SH "QWidget::~QWidget ()" +Destroys the widget. +.PP +All this widget's children are deleted first. The application exits if this widget is the main widget. +.SH "bool QWidget::acceptDrops () const" +Returns TRUE if drop events are enabled for this widget; otherwise returns FALSE. See the "acceptDrops" property for details. +.SH "void QWidget::adjustSize ()\fC [virtual slot]\fR" +Adjusts the size of the widget to fit the contents. +.PP +Uses sizeHint() if valid (i.e if the size hint's width and height are >= 0), otherwise sets the size to the children rectangle (the union of all child widget geometries). +.PP +See also sizeHint and childrenRect. +.PP +Example: xform/xform.cpp. +.PP +Reimplemented in QMessageBox. +.SH "bool QWidget::autoMask () const" +Returns TRUE if the auto mask feature is enabled for the widget; otherwise returns FALSE. See the "autoMask" property for details. +.SH "const QBrush & QWidget::backgroundBrush () const" +Returns the widget's background brush. See the "backgroundBrush" property for details. +.SH "const QColor & QWidget::backgroundColor () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use paletteBackgroundColor() or eraseColor() instead. +.SH "BackgroundMode QWidget::backgroundMode () const" +Returns the color role used for painting the background of the widget. See the "backgroundMode" property for details. +.SH "BackgroundOrigin QWidget::backgroundOrigin () const" +Returns the origin of the widget's background. See the "backgroundOrigin" property for details. +.SH "const QPixmap * QWidget::backgroundPixmap () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use paletteBackgroundPixmap() or erasePixmap() instead. +.PP +Examples: +.)l themes/metal.cpp and themes/wood.cpp. +.SH "QSize QWidget::baseSize () const" +Returns the base size of the widget. See the "baseSize" property for details. +.SH "QString QWidget::caption () const" +Returns the window caption (title). See the "caption" property for details. +.SH "QWidget * QWidget::childAt ( int x, int y, bool includeThis = FALSE ) const" +Returns the visible child widget at pixel position \fI(x, y)\fR in the widget's own coordinate system. +.PP +If \fIincludeThis\fR is TRUE, and there is no child visible at \fI(x, y)\fR, the widget itself is returned. +.SH "QWidget * QWidget::childAt ( const QPoint & p, bool includeThis = FALSE ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the visible child widget at point \fIp\fR in the widget's own coordinate system. +.PP +If \fIincludeThis\fR is TRUE, and there is no child visible at \fIp\fR, the widget itself is returned. +.SH "QRect QWidget::childrenRect () const" +Returns the bounding rectangle of the widget's children. See the "childrenRect" property for details. +.SH "QRegion QWidget::childrenRegion () const" +Returns the combined region occupied by the widget's children. See the "childrenRegion" property for details. +.SH "void QWidget::clearFocus ()\fC [slot]\fR" +Takes keyboard input focus from the widget. +.PP +If the widget has active focus, a focus out event is sent to this widget to tell it that it is about to lose the focus. +.PP +This widget must enable focus setting in order to get the keyboard input focus, i.e. it must call setFocusPolicy(). +.PP +See also focus, setFocus(), focusInEvent(), focusOutEvent(), focusPolicy, and QApplication::focusWidget(). +.SH "void QWidget::clearMask ()" +Removes any mask set by setMask(). +.PP +See also setMask(). +.SH "void QWidget::clearWFlags ( WFlags f )\fC [protected]\fR" +Clears the widget flags \fIf\fR. +.PP +Widget flags are a combination of Qt::WidgetFlags. +.PP +See also testWFlags(), getWFlags(), and setWFlags(). +.SH "QRegion QWidget::clipRegion () const" +Returns the unobscured region where paint events can occur. +.PP +For visible widgets, this is an approximation of the area not covered by other widgets; otherwise, this is an empty region. +.PP +The repaint() function calls this function if necessary, so in general you do not need to call it. +.SH "bool QWidget::close ()\fC [slot]\fR" +Closes this widget. Returns TRUE if the widget was closed; otherwise returns FALSE. +.PP +First it sends the widget a QCloseEvent. The widget is hidden if it accepts the close event. The default implementation of QWidget::closeEvent() accepts the close event. +.PP +The QApplication::lastWindowClosed() signal is emitted when the last visible top level widget is closed. +.PP +Examples: +.)l dialog/mainwindow.cpp, mdi/application.cpp, popup/popup.cpp, and toplevel/options.ui.h. +.SH "bool QWidget::close ( bool alsoDelete )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Closes this widget. Returns TRUE if the widget was closed; otherwise returns FALSE. +.PP +If \fIalsoDelete\fR is TRUE or the widget has the WDestructiveClose widget flag, the widget is also deleted. The widget can prevent itself from being closed by rejecting the QCloseEvent it gets. A close events is delivered to the widget no matter if the widget is visible or not. +.PP +The QApplication::lastWindowClosed() signal is emitted when the last visible top level widget is closed. +.PP +Note that closing the QApplication::mainWidget() terminates the application. +.PP +See also closeEvent(), QCloseEvent, hide(), QApplication::quit(), QApplication::setMainWidget(), and QApplication::lastWindowClosed(). +.SH "void QWidget::closeEvent ( QCloseEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive widget close events. +.PP +The default implementation calls e->accept(), which hides this widget. See the QCloseEvent documentation for more details. +.PP +See also event(), hide(), close(), and QCloseEvent. +.PP +Examples: +.)l action/application.cpp, application/application.cpp, chart/chartform.cpp, i18n/mywidget.cpp, mdi/application.cpp, popup/popup.cpp, and qwerty/qwerty.cpp. +.SH "const QColorGroup & QWidget::colorGroup () const" +Returns the current color group of the widget palette. See the "colorGroup" property for details. +.SH "void QWidget::constPolish () const\fC [slot]\fR" +Ensures that the widget is properly initialized by calling polish(). +.PP +Call constPolish() from functions like sizeHint() that depends on the widget being initialized, and that may be called before show(). +.PP +\fBWarning:\fR Do not call constPolish() on a widget from inside that widget's constructor. +.PP +See also polish(). +.SH "void QWidget::contextMenuEvent ( QContextMenuEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive widget context menu events. +.PP +The default implementation calls e->ignore(), which rejects the context event. See the QContextMenuEvent documentation for more details. +.PP +See also event() and QContextMenuEvent. +.PP +Example: menu/menu.cpp. +.SH "void QWidget::create ( WId window = 0, bool initializeWindow = TRUE, bool destroyOldWindow = TRUE )\fC [virtual protected]\fR" +Creates a new widget window if \fIwindow\fR is 0, otherwise sets the widget's window to \fIwindow\fR. +.PP +Initializes the window (sets the geometry etc.) if \fIinitializeWindow\fR is TRUE. If \fIinitializeWindow\fR is FALSE, no initialization is performed. This parameter only makes sense if \fIwindow\fR is a valid window. +.PP +Destroys the old window if \fIdestroyOldWindow\fR is TRUE. If \fIdestroyOldWindow\fR is FALSE, you are responsible for destroying the window yourself (using platform native code). +.PP +The QWidget constructor calls create(0,TRUE,TRUE) to create a window for this widget. +.SH "const QCursor & QWidget::cursor () const" +Returns the cursor shape for this widget. See the "cursor" property for details. +.SH "bool QWidget::customWhatsThis () const\fC [virtual]\fR" +Returns TRUE if the widget wants to handle What's This help manually; otherwise returns FALSE. See the "customWhatsThis" property for details. +.SH "void QWidget::destroy ( bool destroyWindow = TRUE, bool destroySubWindows = TRUE )\fC [virtual protected]\fR" +Frees up window system resources. Destroys the widget window if \fIdestroyWindow\fR is TRUE. +.PP +destroy() calls itself recursively for all the child widgets, passing \fIdestroySubWindows\fR for the \fIdestroyWindow\fR parameter. To have more control over destruction of subwidgets, destroy subwidgets selectively first. +.PP +This function is usually called from the QWidget destructor. +.SH "void QWidget::dragEnterEvent ( QDragEnterEvent * )\fC [virtual protected]\fR" +This event handler is called when a drag is in progress and the mouse enters this widget. +.PP +See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. +.PP +See also QTextDrag, QImageDrag, and QDragEnterEvent. +.PP +Example: iconview/simple_dd/main.cpp. +.SH "void QWidget::dragLeaveEvent ( QDragLeaveEvent * )\fC [virtual protected]\fR" +This event handler is called when a drag is in progress and the mouse leaves this widget. +.PP +See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. +.PP +See also QTextDrag, QImageDrag, and QDragLeaveEvent. +.SH "void QWidget::dragMoveEvent ( QDragMoveEvent * )\fC [virtual protected]\fR" +This event handler is called when a drag is in progress and the mouse enters this widget, and whenever it moves within the widget. +.PP +See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. +.PP +See also QTextDrag, QImageDrag, and QDragMoveEvent. +.SH "void QWidget::drawText ( int x, int y, const QString & str )" +Draws the string \fIstr\fR at position \fI(x, y)\fR. +.PP +The \fIy\fR position is the base line position of the text. The text is drawn using the default font and the default foreground color. +.PP +This function is provided for convenience. You will generally get more flexible results and often higher speed by using a a painter instead. +.PP +See also font, foregroundColor(), and QPainter::drawText(). +.SH "void QWidget::drawText ( const QPoint & pos, const QString & str )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Draws the string \fIstr\fR at position \fIpos\fR. +.SH "void QWidget::dropEvent ( QDropEvent * )\fC [virtual protected]\fR" +This event handler is called when the drag is dropped on this widget. +.PP +See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application. +.PP +See also QTextDrag, QImageDrag, and QDropEvent. +.PP +Example: iconview/simple_dd/main.cpp. +.SH "void QWidget::enabledChange ( bool oldEnabled )\fC [virtual protected]\fR" +This virtual function is called from setEnabled(). \fIoldEnabled\fR is the previous setting; you can get the new setting from isEnabled(). +.PP +Reimplement this function if your widget needs to know when it becomes enabled or disabled. You will almost certainly need to update the widget using update(). +.PP +The default implementation repaints the visible part of the widget. +.PP +See also enabled, enabled, repaint(), update(), and clipRegion(). +.SH "void QWidget::enterEvent ( QEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive widget enter events. +.PP +An event is sent to the widget when the mouse cursor enters the widget. +.PP +See also leaveEvent(), mouseMoveEvent(), and event(). +.SH "void QWidget::erase ( int x, int y, int w, int h )" +Erases the specified area \fI(x, y, w, h)\fR in the widget without generating a paint event. +.PP +If \fIw\fR is negative, it is replaced with \fCwidth() - x\fR. If \fIh\fR is negative, it is replaced width \fCheight() - y\fR. +.PP +Child widgets are not affected. +.PP +See also repaint(). +.SH "void QWidget::erase ()" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version erases the entire widget. +.SH "void QWidget::erase ( const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Erases the specified area \fIr\fR in the widget without generating a paint event. +.SH "void QWidget::erase ( const QRegion & reg )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Erases the area defined by \fIreg\fR, without generating a paint event. +.PP +Child widgets are not affected. +.SH "const QColor & QWidget::eraseColor () const" +Returns the erase color of the widget. +.PP +See also setEraseColor(), setErasePixmap(), and backgroundColor(). +.SH "const QPixmap * QWidget::erasePixmap () const" +Returns the widget's erase pixmap. +.PP +See also setErasePixmap() and eraseColor(). +.SH "bool QWidget::event ( QEvent * e )\fC [virtual protected]\fR" +This is the main event handler; it handles event \fIe\fR. You can reimplement this function in a subclass, but we recommend using one of the specialized event handlers instead. +.PP +The main event handler first passes an event through all event filters that have been installed. If none of the filters intercept the event, it calls one of the specialized event handlers. +.PP +Key press and release events are treated differently from other events. event() checks for Tab and Shift+Tab and tries to move the focus appropriately. If there is no widget to move the focus to (or the key press is not Tab or Shift+Tab), event() calls keyPressEvent(). +.PP +This function returns TRUE if it is able to pass the event over to someone (i.e. someone wanted the event); otherwise returns FALSE. +.PP +See also closeEvent(), focusInEvent(), focusOutEvent(), enterEvent(), keyPressEvent(), keyReleaseEvent(), leaveEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), moveEvent(), paintEvent(), resizeEvent(), QObject::event(), and QObject::timerEvent(). +.PP +Reimplemented from QObject. +.SH "QWidget * QWidget::find ( WId id )\fC [static]\fR" +Returns a pointer to the widget with window identifer/handle \fIid\fR. +.PP +The window identifier type depends on the underlying window system, see ntqwindowdefs.h for the actual definition. If there is no widget with this identifier, 0 is returned. +.SH "QFocusData * QWidget::focusData ()\fC [protected]\fR" +Returns the focus data for this widget's top-level widget. +.PP +Focus data always belongs to the top-level widget. The focus data list contains all the widgets in this top-level widget that can accept focus, in tab order. An iterator points to the current focus widget (focusWidget() returns a pointer to this widget). +.PP +This information is useful for implementing advanced versions of focusNextPrevChild(). +.SH "void QWidget::focusInEvent ( QFocusEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget. +.PP +A widget normally must setFocusPolicy() to something other than NoFocus in order to receive focus events. (Note that the application programmer can call setFocus() on any widget, even those that do not normally accept focus.) +.PP +The default implementation updates the widget (except for toplevel widgets that do not specify a focusPolicy() ). It also calls setMicroFocusHint(), hinting any system-specific input tools about the focus of the user's attention. +.PP +See also focusOutEvent(), focusPolicy, keyPressEvent(), keyReleaseEvent(), event(), and QFocusEvent. +.SH "bool QWidget::focusNextPrevChild ( bool next )\fC [virtual protected]\fR" +Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns TRUE if is can find a new widget and FALSE if it can't, +.PP +If \fInext\fR is TRUE, this function searches "forwards", if \fInext\fR is FALSE, it searches "backwards". +.PP +Sometimes, you will want to reimplement this function. For example, a web browser might reimplement it to move its "current active link" forwards or backwards, and call QWidget::focusNextPrevChild() only when it reaches the last or first link on the "page". +.PP +Child widgets call focusNextPrevChild() on their parent widgets, but only the top-level widget decides where to redirect focus. By overriding this method for an object, you thus gain control of focus traversal for all child widgets. +.PP +\fBWarning:\fR QScrollView uses it own logic for this function, which does the right thing in most cases. But if you are using a QScrollView and want complete control of the focus chain you'll need to override QScrollView::focusNextPrevChild() and your top-level widgets' focusNextPrevChild() functions. +.PP +See also focusData(). +.SH "void QWidget::focusOutEvent ( QFocusEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget. +.PP +A widget normally must setFocusPolicy() to something other than NoFocus in order to receive focus events. (Note that the application programmer can call setFocus() on any widget, even those that do not normally accept focus.) +.PP +The default implementation updates the widget (except for toplevel widgets that do not specify a focusPolicy() ). It also calls setMicroFocusHint(), hinting any system-specific input tools about the focus of the user's attention. +.PP +See also focusInEvent(), focusPolicy, keyPressEvent(), keyReleaseEvent(), event(), and QFocusEvent. +.PP +Example: qmag/qmag.cpp. +.SH "FocusPolicy QWidget::focusPolicy () const" +Returns the way the widget accepts keyboard focus. See the "focusPolicy" property for details. +.SH "QWidget * QWidget::focusProxy () const" +Returns the focus proxy, or 0 if there is no focus proxy. +.PP +See also setFocusProxy(). +.SH "QWidget * QWidget::focusWidget () const" +Returns the focus widget in this widget's window. This is not the same as QApplication::focusWidget(), which returns the focus widget in the currently active window. +.SH "QFont QWidget::font () const" +Returns the font currently set for the widget. See the "font" property for details. +.SH "void QWidget::fontChange ( const QFont & oldFont )\fC [virtual protected]\fR" +This virtual function is called from setFont(). \fIoldFont\fR is the previous font; you can get the new font from font(). +.PP +Reimplement this function if your widget needs to know when its font changes. You will almost certainly need to update the widget using update(). +.PP +The default implementation updates the widget including its geometry. +.PP +See also font, font, update(), and updateGeometry(). +.SH "QFontInfo QWidget::fontInfo () const" +Returns the font info for the widget's current font. Equivalent to QFontInto(widget->font()). +.PP +See also font, fontMetrics(), and font. +.SH "QFontMetrics QWidget::fontMetrics () const" +Returns the font metrics for the widget's current font. Equivalent to QFontMetrics(widget->font()). +.PP +See also font, fontInfo(), and font. +.PP +Examples: +.)l drawdemo/drawdemo.cpp and qmag/qmag.cpp. +.SH "const QColor & QWidget::foregroundColor () const" +Same as paletteForegroundColor() +.SH "QRect QWidget::frameGeometry () const" +Returns geometry of the widget relative to its parent including any window frame. See the "frameGeometry" property for details. +.SH "QSize QWidget::frameSize () const" +Returns the size of the widget including any window frame. See the "frameSize" property for details. +.SH "const QRect & QWidget::geometry () const" +Returns the geometry of the widget relative to its parent and excluding the window frame. See the "geometry" property for details. +.SH "WFlags QWidget::getWFlags () const\fC [protected]\fR" +Returns the widget flags for this this widget. +.PP +Widget flags are a combination of Qt::WidgetFlags. +.PP +See also testWFlags(), setWFlags(), and clearWFlags(). +.SH "void QWidget::grabKeyboard ()" +Grabs the keyboard input. +.PP +This widget reveives all keyboard events until releaseKeyboard() is called; other widgets get no keyboard events at all. Mouse events are not affected. Use grabMouse() if you want to grab that. +.PP +The focus widget is not affected, except that it doesn't receive any keyboard events. setFocus() moves the focus as usual, but the new focus widget receives keyboard events only after releaseKeyboard() is called. +.PP +If a different widget is currently grabbing keyboard input, that widget's grab is released first. +.PP +See also releaseKeyboard(), grabMouse(), releaseMouse(), and focusWidget(). +.SH "void QWidget::grabMouse ()" +Grabs the mouse input. +.PP +This widget receives all mouse events until releaseMouse() is called; other widgets get no mouse events at all. Keyboard events are not affected. Use grabKeyboard() if you want to grab that. +.PP +\fBWarning:\fR Bugs in mouse-grabbing applications very often lock the terminal. Use this function with extreme caution, and consider using the \fC-nograb\fR command line option while debugging. +.PP +It is almost never necessary to grab the mouse when using Qt, as Qt grabs and releases it sensibly. In particular, Qt grabs the mouse when a mouse button is pressed and keeps it until the last button is released. +.PP +Note that only visible widgets can grab mouse input. If isVisible() returns FALSE for a widget, that widget cannot call grabMouse(). +.PP +See also releaseMouse(), grabKeyboard(), releaseKeyboard(), grabKeyboard(), and focusWidget(). +.SH "void QWidget::grabMouse ( const QCursor & cursor )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Grabs the mouse input and changes the cursor shape. +.PP +The cursor will assume shape \fIcursor\fR (for as long as the mouse focus is grabbed) and this widget will be the only one to receive mouse events until releaseMouse() is called(). +.PP +\fBWarning:\fR Grabbing the mouse might lock the terminal. +.PP +See also releaseMouse(), grabKeyboard(), releaseKeyboard(), and cursor. +.SH "bool QWidget::hasFocus () const" +Returns TRUE if this widget (or its focus proxy) has the keyboard input focus; otherwise returns FALSE. See the "focus" property for details. +.SH "bool QWidget::hasMouse () const" +Returns TRUE if the widget is under the mouse cursor; otherwise returns FALSE. See the "underMouse" property for details. +.SH "bool QWidget::hasMouseTracking () const" +Returns TRUE if mouse tracking is enabled for the widget; otherwise returns FALSE. See the "mouseTracking" property for details. +.SH "int QWidget::height () const" +Returns the height of the widget excluding any window frame. See the "height" property for details. +.SH "int QWidget::heightForWidth ( int w ) const\fC [virtual]\fR" +Returns the preferred height for this widget, given the width \fIw\fR. The default implementation returns 0, indicating that the preferred height does not depend on the width. +.PP +\fBWarning:\fR Does not look at the widget's layout. +.PP +Reimplemented in QMenuBar and QTextEdit. +.SH "void QWidget::hide ()\fC [virtual slot]\fR" +Hides the widget. +.PP +You almost never have to reimplement this function. If you need to do something after a widget is hidden, use hideEvent() instead. +.PP +See also hideEvent(), hidden, show(), showMinimized(), visible, and close(). +.PP +Examples: +.)l mdi/application.cpp, popup/popup.cpp, progress/progress.cpp, scrollview/scrollview.cpp, webbrowser/mainwindow.ui.h, and xform/xform.cpp. +.PP +Reimplemented in QMenuBar. +.SH "void QWidget::hideEvent ( QHideEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive widget hide events. +.PP +Hide events are sent to widgets immediately after they have been hidden. +.PP +See also event() and QHideEvent. +.PP +Reimplemented in QScrollBar. +.SH "const QPixmap * QWidget::icon () const" +Returns the widget's icon. See the "icon" property for details. +.SH "QString QWidget::iconText () const" +Returns the widget's icon text. See the "iconText" property for details. +.SH "void QWidget::iconify ()\fC [slot]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void QWidget::imComposeEvent ( QIMEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the user has entered some text using an Input Method. +.PP +The default implementation calls e->ignore(), which rejects the Input Method event. See the QIMEvent documentation for more details. +.PP +See also event() and QIMEvent. +.SH "void QWidget::imEndEvent ( QIMEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the user has finished inputting text via an Input Method. +.PP +The default implementation calls e->ignore(), which rejects the Input Method event. See the QIMEvent documentation for more details. +.PP +See also event() and QIMEvent. +.SH "void QWidget::imStartEvent ( QIMEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the user begins entering text using an Input Method. +.PP +The default implementation calls e->ignore(), which rejects the Input Method event. See the QIMEvent documentation for more details. +.PP +See also event() and QIMEvent. +.SH "bool QWidget::isActiveWindow () const" +Returns TRUE if this widget is the active window; otherwise returns FALSE. See the "isActiveWindow" property for details. +.SH "bool QWidget::isDesktop () const" +Returns TRUE if the widget is a desktop widget, i.e. represents the desktop; otherwise returns FALSE. See the "isDesktop" property for details. +.SH "bool QWidget::isDialog () const" +Returns TRUE if the widget is a dialog widget; otherwise returns FALSE. See the "isDialog" property for details. +.SH "bool QWidget::isEnabled () const" +Returns TRUE if the widget is enabled; otherwise returns FALSE. See the "enabled" property for details. +.SH "bool QWidget::isEnabledTo ( QWidget * ancestor ) const" +Returns TRUE if this widget would become enabled if \fIancestor\fR is enabled; otherwise returns FALSE. +.PP +This is the case if neither the widget itself nor every parent up to but excluding \fIancestor\fR has been explicitly disabled. +.PP +isEnabledTo(0) is equivalent to isEnabled(). +.PP +See also enabled and enabled. +.SH "bool QWidget::isEnabledToTLW () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function is deprecated. It is equivalent to isEnabled() +.SH "bool QWidget::isFocusEnabled () const" +Returns TRUE if the widget accepts keyboard focus; otherwise returns FALSE. See the "focusEnabled" property for details. +.SH "bool QWidget::isFullScreen () const" +Returns TRUE if the widget is full screen; otherwise returns FALSE. See the "fullScreen" property for details. +.SH "bool QWidget::isHidden () const" +Returns TRUE if the widget is explicitly hidden; otherwise returns FALSE. See the "hidden" property for details. +.SH "bool QWidget::isInputMethodEnabled () const" +Returns enables or disables the use of input methods for this widget. See the "inputMethodEnabled" property for details. +.SH "bool QWidget::isMaximized () const" +Returns TRUE if this widget is maximized; otherwise returns FALSE. See the "maximized" property for details. +.SH "bool QWidget::isMinimized () const" +Returns TRUE if this widget is minimized (iconified); otherwise returns FALSE. See the "minimized" property for details. +.SH "bool QWidget::isModal () const" +Returns TRUE if the widget is a modal widget; otherwise returns FALSE. See the "isModal" property for details. +.SH "bool QWidget::isPopup () const" +Returns TRUE if the widget is a popup widget; otherwise returns FALSE. See the "isPopup" property for details. +.SH "bool QWidget::isShown () const" +Returns TRUE if the widget is shown; otherwise returns FALSE. See the "shown" property for details. +.SH "bool QWidget::isTopLevel () const" +Returns TRUE if the widget is a top-level widget; otherwise returns FALSE. See the "isTopLevel" property for details. +.SH "bool QWidget::isUpdatesEnabled () const" +Returns TRUE if updates are enabled; otherwise returns FALSE. See the "updatesEnabled" property for details. +.SH "bool QWidget::isVisible () const" +Returns TRUE if the widget is visible; otherwise returns FALSE. See the "visible" property for details. +.SH "bool QWidget::isVisibleTo ( QWidget * ancestor ) const" +Returns TRUE if this widget would become visible if \fIancestor\fR is shown; otherwise returns FALSE. +.PP +The TRUE case occurs if neither the widget itself nor any parent up to but excluding \fIancestor\fR has been explicitly hidden. +.PP +This function will still return TRUE if the widget is obscured by other windows on the screen, but could be physically visible if it or they were to be moved. +.PP +isVisibleTo(0) is identical to isVisible(). +.PP +See also show(), hide(), and visible. +.SH "bool QWidget::isVisibleToTLW () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This function is deprecated. It is equivalent to isVisible() +.SH "void QWidget::keyPressEvent ( QKeyEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive key press events for the widget. +.PP +A widget must call setFocusPolicy() to accept focus initially and have focus in order to receive a key press event. +.PP +If you reimplement this handler, it is very important that you explicitly ignore the event if you do not understand it, so that the widget's parent can interpret it; otherwise, the event will be implicitly accepted. Although top-level widgets are able to choose whether to accept or ignore unknown events because they have no parent widgets that could otherwise handle them, it is good practice to explicitly ignore events to make widgets as reusable as possible. +.PP +The default implementation closes popup widgets if the user presses \fBEsc\fR. Otherwise the event is ignored. +.PP +See also keyReleaseEvent(), QKeyEvent::ignore(), focusPolicy, focusInEvent(), focusOutEvent(), event(), and QKeyEvent. +.PP +Example: picture/picture.cpp. +.PP +Reimplemented in QLineEdit and QTextEdit. +.SH "void QWidget::keyReleaseEvent ( QKeyEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive key release events for the widget. +.PP +A widget must accept focus initially and have focus in order to receive a key release event. +.PP +If you reimplement this handler, it is very important that you ignore() the release if you do not understand it, so that the widget's parent can interpret it. +.PP +The default implementation ignores the event. +.PP +See also keyPressEvent(), QKeyEvent::ignore(), focusPolicy, focusInEvent(), focusOutEvent(), event(), and QKeyEvent. +.SH "QWidget * QWidget::keyboardGrabber ()\fC [static]\fR" +Returns the widget that is currently grabbing the keyboard input. +.PP +If no widget in this application is currently grabbing the keyboard, 0 is returned. +.PP +See also grabMouse() and mouseGrabber(). +.SH "QLayout * QWidget::layout () const" +Returns the layout engine that manages the geometry of this widget's children. +.PP +If the widget does not have a layout, layout() returns 0. +.PP +See also sizePolicy. +.PP +Examples: +.)l chart/optionsform.cpp and fonts/simple-qfont-demo/viewer.cpp. +.SH "void QWidget::leaveEvent ( QEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive widget leave events. +.PP +A leave event is sent to the widget when the mouse cursor leaves the widget. +.PP +See also enterEvent(), mouseMoveEvent(), and event(). +.SH "void QWidget::lower ()\fC [slot]\fR" +Lowers the widget to the bottom of the parent widget's stack. +.PP +After this call the widget will be visually behind (and therefore obscured by) any overlapping sibling widgets. +.PP +See also raise() and stackUnder(). +.SH "bool QWidget::macEvent ( MSG * )\fC [virtual protected]\fR" +This special event handler can be reimplemented in a subclass to receive native Macintosh events. +.PP +In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. +.PP +\fBWarning:\fR This function is not portable. +.PP +See also QApplication::macEventFilter(). +.SH "QPoint QWidget::mapFrom ( QWidget * parent, const QPoint & pos ) const" +Translates the widget coordinate \fIpos\fR from the coordinate system of \fIparent\fR to this widget's coordinate system. The \fIparent\fR must not be 0 and must be a parent of the calling widget. +.PP +See also mapTo(), mapFromParent(), mapFromGlobal(), and underMouse. +.SH "QPoint QWidget::mapFromGlobal ( const QPoint & pos ) const" +Translates the global screen coordinate \fIpos\fR to widget coordinates. +.PP +See also mapToGlobal(), mapFrom(), and mapFromParent(). +.SH "QPoint QWidget::mapFromParent ( const QPoint & pos ) const" +Translates the parent widget coordinate \fIpos\fR to widget coordinates. +.PP +Same as mapFromGlobal() if the widget has no parent. +.PP +See also mapToParent(), mapFrom(), mapFromGlobal(), and underMouse. +.SH "QPoint QWidget::mapTo ( QWidget * parent, const QPoint & pos ) const" +Translates the widget coordinate \fIpos\fR to the coordinate system of \fIparent\fR. The \fIparent\fR must not be 0 and must be a parent of the calling widget. +.PP +See also mapFrom(), mapToParent(), mapToGlobal(), and underMouse. +.SH "QPoint QWidget::mapToGlobal ( const QPoint & pos ) const" +Translates the widget coordinate \fIpos\fR to global screen coordinates. For example, \fCmapToGlobal(QPoint(0,0))\fR would give the global coordinates of the top-left pixel of the widget. +.PP +See also mapFromGlobal(), mapTo(), and mapToParent(). +.PP +Example: scribble/scribble.cpp. +.SH "QPoint QWidget::mapToParent ( const QPoint & pos ) const" +Translates the widget coordinate \fIpos\fR to a coordinate in the parent widget. +.PP +Same as mapToGlobal() if the widget has no parent. +.PP +See also mapFromParent(), mapTo(), mapToGlobal(), and underMouse. +.SH "int QWidget::maximumHeight () const" +Returns the widget's maximum height. See the "maximumHeight" property for details. +.SH "QSize QWidget::maximumSize () const" +Returns the widget's maximum size. See the "maximumSize" property for details. +.SH "int QWidget::maximumWidth () const" +Returns the widget's maximum width. See the "maximumWidth" property for details. +.SH "int QWidget::metric ( int m ) const\fC [virtual protected]\fR" +Internal implementation of the virtual QPaintDevice::metric() function. +.PP +Use the QPaintDeviceMetrics class instead. +.PP +\fIm\fR is the metric to get. +.SH "QRect QWidget::microFocusHint () const" +Returns the currently set micro focus hint for this widget. See the "microFocusHint" property for details. +.SH "int QWidget::minimumHeight () const" +Returns the widget's minimum height. See the "minimumHeight" property for details. +.SH "QSize QWidget::minimumSize () const" +Returns the widget's minimum size. See the "minimumSize" property for details. +.SH "QSize QWidget::minimumSizeHint () const\fC [virtual]\fR" +Returns the recommended minimum size for the widget. See the "minimumSizeHint" property for details. +.PP +Reimplemented in QLineEdit. +.SH "int QWidget::minimumWidth () const" +Returns the widget's minimum width. See the "minimumWidth" property for details. +.SH "void QWidget::mouseDoubleClickEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse double click events for the widget. +.PP +The default implementation generates a normal mouse press event. +.PP +Note that the widgets gets a mousePressEvent() and a mouseReleaseEvent() before the mouseDoubleClickEvent(). +.PP +See also mousePressEvent(), mouseReleaseEvent(), mouseMoveEvent(), event(), and QMouseEvent. +.SH "QWidget * QWidget::mouseGrabber ()\fC [static]\fR" +Returns the widget that is currently grabbing the mouse input. +.PP +If no widget in this application is currently grabbing the mouse, 0 is returned. +.PP +See also grabMouse() and keyboardGrabber(). +.SH "void QWidget::mouseMoveEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse move events for the widget. +.PP +If mouse tracking is switched off, mouse move events only occur if a mouse button is pressed while the mouse is being moved. If mouse tracking is switched on, mouse move events occur even if no mouse button is pressed. +.PP +QMouseEvent::pos() reports the position of the mouse cursor, relative to this widget. For press and release events, the position is usually the same as the position of the last mouse move event, but it might be different if the user's hand shakes. This is a feature of the underlying window system, not Qt. +.PP +See also mouseTracking, mousePressEvent(), mouseReleaseEvent(), mouseDoubleClickEvent(), event(), and QMouseEvent. +.PP +Examples: +.)l aclock/aclock.cpp, drawlines/connect.cpp, iconview/simple_dd/main.cpp, life/life.cpp, popup/popup.cpp, qmag/qmag.cpp, and scribble/scribble.cpp. +.PP +Reimplemented in QSizeGrip. +.SH "void QWidget::mousePressEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse press events for the widget. +.PP +If you create new widgets in the mousePressEvent() the mouseReleaseEvent() may not end up where you expect, depending on the underlying window system (or X11 window manager), the widgets' location and maybe more. +.PP +The default implementation implements the closing of popup widgets when you click outside the window. For other widget types it does nothing. +.PP +See also mouseReleaseEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), event(), and QMouseEvent. +.PP +Examples: +.)l biff/biff.cpp, drawlines/connect.cpp, iconview/simple_dd/main.cpp, life/life.cpp, qmag/qmag.cpp, scribble/scribble.cpp, and tooltip/tooltip.cpp. +.PP +Reimplemented in QSizeGrip. +.SH "void QWidget::mouseReleaseEvent ( QMouseEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive mouse release events for the widget. +.PP +See also mouseDoubleClickEvent(), mouseMoveEvent(), event(), and QMouseEvent. +.PP +Examples: +.)l drawlines/connect.cpp, hello/hello.cpp, popup/popup.cpp, qmag/qmag.cpp, scribble/scribble.cpp, showimg/showimg.cpp, and t14/cannon.cpp. +.SH "void QWidget::move ( const QPoint & )\fC [slot]\fR" +Sets the position of the widget within its parent widget. See the "pos" property for details. +.SH "void QWidget::move ( int x, int y )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This corresponds to move( QPoint(\fIx\fR, \fIy\fR) ). +.SH "void QWidget::moveEvent ( QMoveEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive widget move events. When the widget receives this event, it is already at the new position. +.PP +The old position is accessible through QMoveEvent::oldPos(). +.PP +See also resizeEvent(), event(), pos, and QMoveEvent. +.SH "bool QWidget::ownCursor () const" +Returns TRUE if the widget uses its own cursor; otherwise returns FALSE. See the "ownCursor" property for details. +.SH "bool QWidget::ownFont () const" +Returns TRUE if the widget uses its own font; otherwise returns FALSE. See the "ownFont" property for details. +.SH "bool QWidget::ownPalette () const" +Returns TRUE if the widget uses its own palette; otherwise returns FALSE. See the "ownPalette" property for details. +.SH "void QWidget::paintEvent ( QPaintEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive paint events. +.PP +A paint event is a request to repaint all or part of the widget. It can happen as a result of repaint() or update(), or because the widget was obscured and has now been uncovered, or for many other reasons. +.PP +Many widgets can simply repaint their entire surface when asked to, but some slow widgets need to optimize by painting only the requested region: QPaintEvent::region(). This speed optimization does not change the result, as painting is clipped to that region during event processing. QListView and QCanvas do this, for example. +.PP +Qt also tries to speed up painting by merging multiple paint events into one. When update() is called several times or the window system sends several paint events, Qt merges these events into one event with a larger region (see QRegion::unite()). repaint() does not permit this optimization, so we suggest using update() when possible. +.PP +When the paint event occurs, the update region has normally been erased, so that you're painting on the widget's background. There are a couple of exceptions and QPaintEvent::erased() tells you whether the widget has been erased or not. +.PP +The background can be set using setBackgroundMode(), setPaletteBackgroundColor() or setBackgroundPixmap(). The documentation for setBackgroundMode() elaborates on the background; we recommend reading it. +.PP +See also event(), repaint(), update(), QPainter, QPixmap, and QPaintEvent. +.PP +Examples: +.)l drawlines/connect.cpp, forever/forever.cpp, qmag/qmag.cpp, scribble/scribble.cpp, splitter/splitter.cpp, t8/cannon.cpp, and t9/cannon.cpp. +.PP +Reimplemented in QButton, QFrame, QGLWidget, QSizeGrip, QStatusBar, and QTabBar. +.SH "const QPalette & QWidget::palette () const" +Returns the widget's palette. See the "palette" property for details. +.SH "const QColor & QWidget::paletteBackgroundColor () const" +Returns the background color of the widget. See the "paletteBackgroundColor" property for details. +.SH "const QPixmap * QWidget::paletteBackgroundPixmap () const" +Returns the background pixmap of the widget. See the "paletteBackgroundPixmap" property for details. +.SH "void QWidget::paletteChange ( const QPalette & oldPalette )\fC [virtual protected]\fR" +This virtual function is called from setPalette(). \fIoldPalette\fR is the previous palette; you can get the new palette from palette(). +.PP +Reimplement this function if your widget needs to know when its palette changes. +.PP +See also palette and palette. +.SH "const QColor & QWidget::paletteForegroundColor () const" +Returns the foreground color of the widget. See the "paletteForegroundColor" property for details. +.SH "QWidget * QWidget::parentWidget ( bool sameWindow = FALSE ) const" +Returns the parent of this widget, or 0 if it does not have any parent widget. If \fIsameWindow\fR is TRUE and the widget is top level returns 0; otherwise returns the widget's parent. +.PP +Example: mdi/application.cpp. +.SH "void QWidget::polish ()\fC [virtual slot]\fR" +Delayed initialization of a widget. +.PP +This function will be called \fIafter\fR a widget has been fully created and \fIbefore\fR it is shown the very first time. +.PP +Polishing is useful for final initialization which depends on having an instantiated widget. This is something a constructor cannot guarantee since the initialization of the subclasses might not be finished. +.PP +After this function, the widget has a proper font and palette and QApplication::polish() has been called. +.PP +Remember to call QWidget's implementation first when reimplementing this function to ensure that your program does not end up in infinite recursion. +.PP +See also constPolish() and QApplication::polish(). +.PP +Example: menu/menu.cpp. +.SH "QPoint QWidget::pos () const" +Returns the position of the widget within its parent widget. See the "pos" property for details. +.SH "bool QWidget::qwsEvent ( QWSEvent * )\fC [virtual protected]\fR" +This special event handler can be reimplemented in a subclass to receive native Qt/Embedded events. +.PP +In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. +.PP +\fBWarning:\fR This function is not portable. +.PP +See also QApplication::qwsEventFilter(). +.SH "void QWidget::raise ()\fC [slot]\fR" +Raises this widget to the top of the parent widget's stack. +.PP +After this call the widget will be visually in front of any overlapping sibling widgets. +.PP +See also lower() and stackUnder(). +.PP +Example: showimg/showimg.cpp. +.SH "void QWidget::recreate ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This method is provided to aid porting from Qt 1.0 to 2.0. It has been renamed reparent() in Qt 2.0. +.SH "QRect QWidget::rect () const" +Returns the internal geometry of the widget excluding any window frame. See the "rect" property for details. +.SH "void QWidget::releaseKeyboard ()" +Releases the keyboard grab. +.PP +See also grabKeyboard(), grabMouse(), and releaseMouse(). +.SH "void QWidget::releaseMouse ()" +Releases the mouse grab. +.PP +See also grabMouse(), grabKeyboard(), and releaseKeyboard(). +.SH "void QWidget::repaint ( int x, int y, int w, int h, bool erase = TRUE )\fC [slot]\fR" +Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. +.PP +If \fIerase\fR is TRUE, Qt erases the area \fI(x, y, w, h)\fR before the paintEvent() call. +.PP +If \fIw\fR is negative, it is replaced with \fCwidth() - x\fR, and if \fIh\fR is negative, it is replaced width \fCheight() - y\fR. +.PP +We suggest only using repaint() if you need an immediate repaint, for example during animation. In almost all circumstances update() is better, as it permits Qt to optimize for speed and minimize flicker. +.PP +\fBWarning:\fR If you call repaint() in a function which may itself be called from paintEvent(), you may get infinite recursion. The update() function never causes recursion. +.PP +See also update(), paintEvent(), updatesEnabled, and erase(). +.PP +Example: qwerty/qwerty.cpp. +.SH "void QWidget::repaint ()\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version erases and repaints the entire widget. +.SH "void QWidget::repaint ( bool erase )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version repaints the entire widget. +.SH "void QWidget::repaint ( const QRect & r, bool erase = TRUE )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Repaints the widget directly by calling paintEvent() directly, unless updates are disabled or the widget is hidden. +.PP +Erases the widget region \fIr\fR if \fIerase\fR is TRUE. +.SH "void QWidget::repaint ( const QRegion & reg, bool erase = TRUE )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Repaints the widget directly by calling paintEvent() directly, unless updates are disabled or the widget is hidden. +.PP +Erases the widget region \fIreg\fR if \fIerase\fR is TRUE. +.PP +Only use repaint if your widget needs to be repainted immediately, for example when doing some animation. In all other cases, use update(). Calling update() many times in a row will generate a single paint event. +.PP +\fBWarning:\fR If you call repaint() in a function which may itself be called from paintEvent(), you may get infinite recursion. The update() function never causes recursion. +.PP +See also update(), paintEvent(), updatesEnabled, and erase(). +.SH "void QWidget::reparent ( QWidget * parent, WFlags f, const QPoint & p, bool showIt = FALSE )\fC [virtual]\fR" +Reparents the widget. The widget gets a new \fIparent\fR, new widget flags (\fIf\fR, but as usual, use 0) at a new position in its new parent (\fIp\fR). +.PP +If \fIshowIt\fR is TRUE, show() is called once the widget has been reparented. +.PP +If the new parent widget is in a different top-level widget, the reparented widget and its children are appended to the end of the tab chain of the new parent widget, in the same internal order as before. If one of the moved widgets had keyboard focus, reparent() calls clearFocus() for that widget. +.PP +If the new parent widget is in the same top-level widget as the old parent, reparent doesn't change the tab order or keyboard focus. +.PP +\fBWarning:\fR It is extremely unlikely that you will ever need this function. If you have a widget that changes its content dynamically, it is far easier to use QWidgetStack or QWizard. +.PP +See also getWFlags(). +.PP +Example: toplevel/options.ui.h. +.SH "void QWidget::reparent ( QWidget * parent, const QPoint & p, bool showIt = FALSE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +A convenience version of reparent that does not take widget flags as argument. +.PP +Calls reparent(\fIparent\fR, getWFlags() & ~WType_Mask, \fIp\fR, \fIshowIt\fR). +.SH "void QWidget::resetInputContext ()\fC [protected]\fR" +This function is called when the user finishes input composition, e.g. changes focus to another widget, moves the cursor, etc. +.SH "void QWidget::resize ( const QSize & )\fC [slot]\fR" +Sets the size of the widget excluding any window frame. See the "size" property for details. +.SH "void QWidget::resize ( int w, int h )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This corresponds to resize( QSize(\fIw\fR, \fIh\fR) ). +.SH "void QWidget::resizeEvent ( QResizeEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive widget resize events. When resizeEvent() is called, the widget already has its new geometry. The old size is accessible through QResizeEvent::oldSize(). +.PP +The widget will be erased and receive a paint event immediately after processing the resize event. No drawing need be (or should be) done inside this handler. +.PP +Widgets that have been created with the WNoAutoErase flag will not be erased. Nevertheless, they will receive a paint event for their entire area afterwards. Again, no drawing needs to be done inside this handler. +.PP +The default implementation calls updateMask() if the widget has automatic masking enabled. +.PP +See also moveEvent(), event(), size, QResizeEvent, and paintEvent(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp, menu/menu.cpp, qmag/qmag.cpp, scribble/scribble.cpp, showimg/showimg.cpp, tooltip/tooltip.cpp, and xform/xform.cpp. +.PP +Reimplemented in QFrame and QGLWidget. +.SH "void QWidget::scroll ( int dx, int dy )" +Scrolls the widget including its children \fIdx\fR pixels to the right and \fIdy\fR downwards. Both \fIdx\fR and \fIdy\fR may be negative. +.PP +After scrolling, scroll() sends a paint event for the the part that is read but not written. For example, when scrolling 10 pixels rightwards, the leftmost ten pixels of the widget need repainting. The paint event may be delivered immediately or later, depending on some heuristics (note that you might have to force processing of paint events using QApplication::sendPostedEvents() when using scroll() and move() in combination). +.PP +See also QScrollView, erase(), and bitBlt(). +.SH "void QWidget::scroll ( int dx, int dy, const QRect & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This version only scrolls \fIr\fR and does not move the children of the widget. +.PP +If \fIr\fR is empty or invalid, the result is undefined. +.PP +See also QScrollView, erase(), and bitBlt(). +.SH "void QWidget::setAcceptDrops ( bool on )\fC [virtual]\fR" +Sets whether drop events are enabled for this widget to \fIon\fR. See the "acceptDrops" property for details. +.SH "void QWidget::setActiveWindow ()\fC [virtual]\fR" +Sets the top-level widget containing this widget to be the active window. +.PP +An active window is a visible top-level window that has the keyboard input focus. +.PP +This function performs the same operation as clicking the mouse on the title bar of a top-level window. On X11, the result depends on the Window Manager. If you want to ensure that the window is stacked on top as well you should also call raise(). Note that the window must be visible, otherwise setActiveWindow() has no effect. +.PP +On Windows, if you are calling this when the application is not currently the active one then it will not make it the active window. It will flash the task bar entry blue to indicate that the window has done something. This is because Microsoft do not allow an application to interrupt what the user is currently doing in another application. +.PP +See also isActiveWindow, topLevelWidget(), and show(). +.PP +Reimplemented in QXtWidget. +.SH "void QWidget::setAutoMask ( bool )\fC [virtual]\fR" +Sets whether the auto mask feature is enabled for the widget. See the "autoMask" property for details. +.SH "void QWidget::setBackgroundColor ( const QColor & c )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use setPaletteBackgroundColor() or setEraseColor() instead. +.PP +Examples: +.)l customlayout/main.cpp, desktop/desktop.cpp, hello/main.cpp, movies/main.cpp, and splitter/splitter.cpp. +.SH "void QWidget::setBackgroundMode ( BackgroundMode )\fC [virtual]\fR" +Sets the color role used for painting the background of the widget. See the "backgroundMode" property for details. +.SH "void QWidget::setBackgroundMode ( BackgroundMode m, BackgroundMode visual )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the widget's own background mode to \fIm\fR and the visual background mode to \fIvisual\fR. The visual background mode is used with the designable properties \fCbackgroundColor\fR, \fCforegroundColor\fR and \fCbackgroundPixmap\fR. +.PP +For complex controls, the logical background mode sometimes differs from a widget's own background mode. A spinbox for example has PaletteBackground as background mode (typically dark gray), while it's embedded lineedit control uses PaletteBase (typically white). Since the lineedit covers most of the visual area of a spinbox, it defines PaletteBase to be its \fIvisual\fR background mode. Changing the \fCbackgroundColor\fR property thus changes the lineedit control's background, which is exactly what the user expects in \fIQt Designer\fR. +.SH "void QWidget::setBackgroundOrigin ( BackgroundOrigin )\fC [virtual]\fR" +Sets the origin of the widget's background. See the "backgroundOrigin" property for details. +.SH "void QWidget::setBackgroundPixmap ( const QPixmap & pm )\fC [virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. Use setPaletteBackgroundPixmap() or setErasePixmap() instead. +.PP +Example: desktop/desktop.cpp. +.SH "void QWidget::setBaseSize ( const QSize & )" +Sets the base size of the widget. See the "baseSize" property for details. +.SH "void QWidget::setBaseSize ( int basew, int baseh )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This corresponds to setBaseSize( QSize(\fIbasew\fR, \fIbaseh\fR) ). Sets the widgets base size to width \fIbasew\fR and height \fIbaseh\fR. +.SH "void QWidget::setCaption ( const QString & )\fC [virtual slot]\fR" +Sets the window caption (title). See the "caption" property for details. +.SH "void QWidget::setCursor ( const QCursor & )\fC [virtual]\fR" +Sets the cursor shape for this widget. See the "cursor" property for details. +.SH "void QWidget::setDisabled ( bool disable )\fC [slot]\fR" +Disables widget input events if \fIdisable\fR is TRUE; otherwise enables input events. +.PP +See the enabled documentation for more information. +.PP +See also isEnabledTo(), QKeyEvent, QMouseEvent, and enabledChange(). +.SH "void QWidget::setEnabled ( bool )\fC [virtual slot]\fR" +Sets whether the widget is enabled. See the "enabled" property for details. +.SH "void QWidget::setEraseColor ( const QColor & color )\fC [virtual]\fR" +Sets the erase color of the widget to \fIcolor\fR. +.PP +The erase color is the color the widget is to be cleared to before paintEvent() is called. If there is an erase pixmap (set using setErasePixmap()), then this property has an indeterminate value. +.PP +See also erasePixmap(), backgroundColor(), backgroundMode, and palette. +.SH "void QWidget::setErasePixmap ( const QPixmap & pixmap )\fC [virtual]\fR" +Sets the widget's erase pixmap to \fIpixmap\fR. +.PP +This pixmap is used to clear the widget before paintEvent() is called. +.SH "void QWidget::setFixedHeight ( int h )" +Sets both the minimum and maximum heights of the widget to \fIh\fR without changing the widths. Provided for convenience. +.PP +See also sizeHint, minimumSize, maximumSize, and setFixedSize(). +.PP +Examples: +.)l fonts/simple-qfont-demo/viewer.cpp, layout/layout.cpp, qdir/qdir.cpp, and showimg/showimg.cpp. +.SH "void QWidget::setFixedSize ( const QSize & s )" +Sets both the minimum and maximum sizes of the widget to \fIs\fR, thereby preventing it from ever growing or shrinking. +.PP +See also maximumSize and minimumSize. +.SH "void QWidget::setFixedSize ( int w, int h )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the width of the widget to \fIw\fR and the height to \fIh\fR. +.SH "void QWidget::setFixedWidth ( int w )" +Sets both the minimum and maximum width of the widget to \fIw\fR without changing the heights. Provided for convenience. +.PP +See also sizeHint, minimumSize, maximumSize, and setFixedSize(). +.PP +Examples: +.)l progressbar/progressbar.cpp and qdir/qdir.cpp. +.SH "void QWidget::setFocus ()\fC [virtual slot]\fR" +Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. +.PP +First, a focus out event is sent to the focus widget (if any) to tell it that it is about to lose the focus. Then a focus in event is sent to this widget to tell it that it just received the focus. (Nothing happens if the focus in and focus out widgets are the same.) +.PP +setFocus() gives focus to a widget regardless of its focus policy, but does not clear any keyboard grab (see grabKeyboard()). +.PP +Be aware that if the widget is hidden, it will not accept focus. +.PP +\fBWarning:\fR If you call setFocus() in a function which may itself be called from focusOutEvent() or focusInEvent(), you may get an infinite recursion. +.PP +See also focus, clearFocus(), focusInEvent(), focusOutEvent(), focusPolicy, QApplication::focusWidget(), grabKeyboard(), and grabMouse(). +.PP +Examples: +.)l addressbook/centralwidget.cpp, lineedits/lineedits.cpp, mdi/application.cpp, popup/popup.cpp, rot13/rot13.cpp, t8/main.cpp, and wizard/wizard.cpp. +.SH "void QWidget::setFocusPolicy ( FocusPolicy )\fC [virtual]\fR" +Sets the way the widget accepts keyboard focus. See the "focusPolicy" property for details. +.SH "void QWidget::setFocusProxy ( QWidget * w )\fC [virtual]\fR" +Sets the widget's focus proxy to widget \fIw\fR. If \fIw\fR is 0, the function resets this widget to have no focus proxy. +.PP +Some widgets, such as QComboBox, can "have focus", but create a child widget to actually handle the focus. QComboBox, for example, creates a QLineEdit which handles the focus. +.PP +setFocusProxy() sets the widget which will actually get focus when" this widget" gets it. If there is a focus proxy, focusPolicy(), setFocusPolicy(), setFocus() and hasFocus() all operate on the focus proxy. +.PP +See also focusProxy(). +.SH "void QWidget::setFont ( const QFont & )\fC [virtual]\fR" +Sets the font currently set for the widget. See the "font" property for details. +.PP +Reimplemented in QComboBox, QLabel, and QTabDialog. +.SH "void QWidget::setFont ( const QFont & f, bool )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use setFont(const QFont& font) instead. +.SH "void QWidget::setGeometry ( const QRect & )\fC [virtual slot]\fR" +Sets the geometry of the widget relative to its parent and excluding the window frame. See the "geometry" property for details. +.SH "void QWidget::setGeometry ( int x, int y, int w, int h )\fC [virtual slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This corresponds to setGeometry( QRect(\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) ). +.SH "void QWidget::setHidden ( bool hide )\fC [slot]\fR" +Sets whether the widget is explicitly hidden to \fIhide\fR. See the "hidden" property for details. +.SH "void QWidget::setIcon ( const QPixmap & )\fC [virtual slot]\fR" +Sets the widget's icon. See the "icon" property for details. +.SH "void QWidget::setIconText ( const QString & )\fC [virtual slot]\fR" +Sets the widget's icon text. See the "iconText" property for details. +.SH "void QWidget::setInputMethodEnabled ( bool b )" +Sets enables or disables the use of input methods for this widget to \fIb\fR. See the "inputMethodEnabled" property for details. +.SH "void QWidget::setKeyCompression ( bool compress )\fC [virtual protected]\fR" +Enables key event compression, if \fIcompress\fR is TRUE, and disables it if \fIcompress\fR is FALSE. +.PP +Key compression is off by default (except for QLineEdit and QTextEdit), so widgets receive one key press event for each key press (or more, since autorepeat is usually on). If you turn it on and your program doesn't keep up with key input, Qt may try to compress key events so that more than one character can be processed in each event. +.PP +For example, a word processor widget might receive 2, 3 or more characters in each QKeyEvent::text(), if the layout recalculation takes too long for the CPU. +.PP +If a widget supports multiple character unicode input, it is always safe to turn the compression on. +.PP +Qt performs key event compression only for printable characters. Modifier keys, cursor movement keys, function keys and miscellaneous action keys (e.g. Escape, Enter, Backspace, PrintScreen) will stop key event compression, even if there are more compressible key events available. +.PP +Not all platforms support this compression, in which case turning it on will have no effect. +.PP +See also QKeyEvent::text(). +.SH "void QWidget::setMask ( const QBitmap & bitmap )\fC [virtual]\fR" +Causes only the pixels of the widget for which \fIbitmap\fR has a corresponding 1 bit to be visible. Use Qt::color0 to draw transparent regions and Qt::color1 to draw opaque regions of the bitmap. +.PP +If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform. +.PP +Note that this effect can be slow if the region is particularly complex. +.PP +See \fCexamples/tux\fR for an example of masking for transparency. +.PP +See also clearMask(). +.SH "void QWidget::setMask ( const QRegion & region )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Causes only the parts of the widget which overlap \fIregion\fR to be visible. If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform. +.PP +Note that this effect can be slow if the region is particularly complex. +.PP +See also clearMask(). +.SH "void QWidget::setMaximumHeight ( int maxh )" +Sets the widget's maximum height to \fImaxh\fR. See the "maximumHeight" property for details. +.SH "void QWidget::setMaximumSize ( const QSize & )" +Sets the widget's maximum size. See the "maximumSize" property for details. +.SH "void QWidget::setMaximumSize ( int maxw, int maxh )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function corresponds to setMaximumSize( QSize(\fImaxw\fR, \fImaxh\fR) ). Sets the maximum width to \fImaxw\fR and the maximum height to \fImaxh\fR. +.SH "void QWidget::setMaximumWidth ( int maxw )" +Sets the widget's maximum width to \fImaxw\fR. See the "maximumWidth" property for details. +.SH "void QWidget::setMicroFocusHint ( int x, int y, int width, int height, bool text = TRUE, QFont * f = 0 )\fC [virtual protected]\fR" +When a widget gets focus, it should call setMicroFocusHint() with some appropriate position and size, \fIx\fR, \fIy\fR, \fIwidth\fR and \fIheight\fR. This has no \fIvisual\fR effect, it just provides hints to any system-specific input handling tools. +.PP +The \fItext\fR argument should be TRUE if this is a position for text input. +.PP +In the Windows version of Qt, this method sets the system caret, which is used for user Accessibility focus handling. If \fItext\fR is TRUE, it also sets the IME composition window in Far East Asian language input systems. +.PP +In the X11 version of Qt, if \fItext\fR is TRUE, this method sets the XIM "spot" point for complex language input handling. +.PP +The font \fIf\fR is a rendering hint to the currently active input method. If \fIf\fR is 0 the widget's font is used. +.PP +See also microFocusHint. +.SH "void QWidget::setMinimumHeight ( int minh )" +Sets the widget's minimum height to \fIminh\fR. See the "minimumHeight" property for details. +.SH "void QWidget::setMinimumSize ( const QSize & )" +Sets the widget's minimum size. See the "minimumSize" property for details. +.SH "void QWidget::setMinimumSize ( int minw, int minh )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This function corresponds to setMinimumSize( QSize(minw, minh) ). Sets the minimum width to \fIminw\fR and the minimum height to \fIminh\fR. +.SH "void QWidget::setMinimumWidth ( int minw )" +Sets the widget's minimum width to \fIminw\fR. See the "minimumWidth" property for details. +.SH "void QWidget::setMouseTracking ( bool enable )\fC [virtual slot]\fR" +Sets whether mouse tracking is enabled for the widget to \fIenable\fR. See the "mouseTracking" property for details. +.SH "void QWidget::setPalette ( const QPalette & )\fC [virtual]\fR" +Sets the widget's palette. See the "palette" property for details. +.PP +Reimplemented in QComboBox, QScrollBar, and QSlider. +.SH "void QWidget::setPalette ( const QPalette & p, bool )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use setPalette( const QPalette& p ) instead. +.SH "void QWidget::setPaletteBackgroundColor ( const QColor & )\fC [virtual]\fR" +Sets the background color of the widget. See the "paletteBackgroundColor" property for details. +.SH "void QWidget::setPaletteBackgroundPixmap ( const QPixmap & )\fC [virtual]\fR" +Sets the background pixmap of the widget. See the "paletteBackgroundPixmap" property for details. +.SH "void QWidget::setPaletteForegroundColor ( const QColor & )" +Sets the foreground color of the widget. See the "paletteForegroundColor" property for details. +.SH "void QWidget::setShown ( bool show )\fC [slot]\fR" +Sets whether the widget is shown to \fIshow\fR. See the "shown" property for details. +.SH "void QWidget::setSizeIncrement ( const QSize & )" +Sets the size increment of the widget. See the "sizeIncrement" property for details. +.SH "void QWidget::setSizeIncrement ( int w, int h )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the x (width) size increment to \fIw\fR and the y (height) size increment to \fIh\fR. +.SH "void QWidget::setSizePolicy ( QSizePolicy )\fC [virtual]\fR" +Sets the default layout behavior of the widget. See the "sizePolicy" property for details. +.SH "void QWidget::setSizePolicy ( QSizePolicy::SizeType hor, QSizePolicy::SizeType ver, bool hfw = FALSE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the size policy of the widget to \fIhor\fR, \fIver\fR and \fIhfw\fR (height for width). +.PP +See also QSizePolicy::QSizePolicy(). +.SH "void QWidget::setStyle ( QStyle * style )" +Sets the widget's GUI style to \fIstyle\fR. Ownership of the style object is not transferred. +.PP +If no style is set, the widget uses the application's style, QApplication::style() instead. +.PP +Setting a widget's style has no effect on existing or future child widgets. +.PP +\fBWarning:\fR This function is particularly useful for demonstration purposes, where you want to show Qt's styling capabilities. Real applications should avoid it and use one consistent GUI style instead. +.PP +See also style(), QStyle, QApplication::style(), and QApplication::setStyle(). +.PP +Examples: +.)l grapher/grapher.cpp and progressbar/progressbar.cpp. +.SH "QStyle * QWidget::setStyle ( const QString & style )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the widget's GUI style to \fIstyle\fR using the QStyleFactory. +.SH "void QWidget::setTabOrder ( QWidget * first, QWidget * second )\fC [static]\fR" +Moves the \fIsecond\fR widget around the ring of focus widgets so that keyboard focus moves from the \fIfirst\fR widget to the \fIsecond\fR widget when the Tab key is pressed. +.PP +Note that since the tab order of the \fIsecond\fR widget is changed, you should order a chain like this: +.PP +.nf +.br + setTabOrder( a, b ); // a to b +.br + setTabOrder( b, c ); // a to b to c +.br + setTabOrder( c, d ); // a to b to c to d +.br +.fi +.PP +\fInot\fR like this: +.PP +.nf +.br + setTabOrder( c, d ); // c to d WRONG +.br + setTabOrder( a, b ); // a to b AND c to d +.br + setTabOrder( b, c ); // a to b to c, but not c to d +.br +.fi +.PP +If \fIfirst\fR or \fIsecond\fR has a focus proxy, setTabOrder() correctly substitutes the proxy. +.PP +See also focusPolicy and setFocusProxy(). +.PP +Example: customlayout/main.cpp. +.SH "void QWidget::setUpdatesEnabled ( bool enable )\fC [virtual slot]\fR" +Sets whether updates are enabled to \fIenable\fR. See the "updatesEnabled" property for details. +.SH "void QWidget::setWFlags ( WFlags f )\fC [virtual protected]\fR" +Sets the widget flags \fIf\fR. +.PP +Widget flags are a combination of Qt::WidgetFlags. +.PP +See also testWFlags(), getWFlags(), and clearWFlags(). +.SH "void QWidget::setWindowOpacity ( double level )" +Sets the level of opacity for the window to \fIlevel\fR. See the "windowOpacity" property for details. +.SH "void QWidget::setWindowState ( uint windowState )" +Sets the window state to \fIwindowState\fR. The window state is a OR'ed combination of Qt::WindowState: WindowMinimized, WindowMaximized, WindowFullScreen and WindowActive. +.PP +If the window is not visible (i.e. isVisible() returns FALSE), the window state will take effect when show() is called. For visible windows, the change is immediate. For example, to toggle between full-screen and mormal mode, use the following code: +.PP +.nf +.br + w->setWindowState(w->windowState() ^ WindowFullScreen); +.br +.fi +.PP +In order to restore and activate a minimized window (while preserving its maximized and/or full-screen state), use the following: +.PP +.nf +.br + w->setWindowState(w->windowState() & ~WindowMinimized | WindowActive); +.br +.fi +.PP +Note: On some window systems WindowActive is not immediate, and may be ignored in certain cases. +.PP +See also Qt::WindowState and windowState(). +.SH "void QWidget::show ()\fC [virtual slot]\fR" +Shows the widget and its child widgets. +.PP +If its size or position has changed, Qt guarantees that a widget gets move and resize events just before it is shown. +.PP +You almost never have to reimplement this function. If you need to change some settings before a widget is shown, use showEvent() instead. If you need to do some delayed initialization use polish(). +.PP +See also showEvent(), hide(), showMinimized(), showMaximized(), showNormal(), visible, and polish(). +.PP +Examples: +.)l aclock/main.cpp, life/main.cpp, popup/popup.cpp, t1/main.cpp, t3/main.cpp, t4/main.cpp, and toplevel/options.ui.h. +.PP +Reimplemented in QDialog and QMenuBar. +.SH "void QWidget::showEvent ( QShowEvent * )\fC [virtual protected]\fR" +This event handler can be reimplemented in a subclass to receive widget show events. +.PP +Non-spontaneous show events are sent to widgets immediately before they are shown. The spontaneous show events of top-level widgets are delivered afterwards. +.PP +See also event() and QShowEvent. +.PP +Example: qdir/qdir.cpp. +.SH "void QWidget::showFullScreen ()\fC [slot]\fR" +Shows the widget in full-screen mode. +.PP +Calling this function only affects top-level widgets. +.PP +To return from full-screen mode, call showNormal(). +.PP +Full-screen mode works fine under Windows, but has certain problems under X. These problems are due to limitations of the ICCCM protocol that specifies the communication between X11 clients and the window manager. ICCCM simply does not understand the concept of non-decorated full-screen windows. Therefore, the best we can do is to request a borderless window and place and resize it to fill the entire screen. Depending on the window manager, this may or may not work. The borderless window is requested using MOTIF hints, which are at least partially supported by virtually all modern window managers. +.PP +An alternative would be to bypass the window manager entirely and create a window with the WX11BypassWM flag. This has other severe problems though, like totally broken keyboard focus and very strange effects on desktop changes or when the user raises other windows. +.PP +X11 window managers that follow modern post-ICCCM specifications support full-screen mode properly. +.PP +See also showNormal(), showMaximized(), show(), hide(), and visible. +.SH "void QWidget::showMaximized ()\fC [virtual slot]\fR" +Shows the widget maximized. +.PP +Calling this function only affects top-level widgets. +.PP +On X11, this function may not work properly with certain window managers. See the Window Geometry documentation for an explanation. +.PP +See also setWindowState(), showNormal(), showMinimized(), show(), hide(), and visible. +.PP +Examples: +.)l canvas/main.cpp, helpviewer/main.cpp, mdi/application.cpp, qwerty/main.cpp, qwerty/qwerty.cpp, and scribble/main.cpp. +.SH "void QWidget::showMinimized ()\fC [virtual slot]\fR" +Shows the widget minimized, as an icon. +.PP +Calling this function only affects top-level widgets. +.PP +See also showNormal(), showMaximized(), show(), hide(), visible, and minimized. +.SH "void QWidget::showNormal ()\fC [virtual slot]\fR" +Restores the widget after it has been maximized or minimized. +.PP +Calling this function only affects top-level widgets. +.PP +See also setWindowState(), showMinimized(), showMaximized(), show(), hide(), and visible. +.PP +Example: mdi/application.cpp. +.SH "QSize QWidget::size () const" +Returns the size of the widget excluding any window frame. See the "size" property for details. +.SH "QSize QWidget::sizeHint () const\fC [virtual]\fR" +Returns the recommended size for the widget. See the "sizeHint" property for details. +.PP +Reimplemented in QSizeGrip. +.SH "QSize QWidget::sizeIncrement () const" +Returns the size increment of the widget. See the "sizeIncrement" property for details. +.SH "QSizePolicy QWidget::sizePolicy () const\fC [virtual]\fR" +Returns the default layout behavior of the widget. See the "sizePolicy" property for details. +.SH "void QWidget::stackUnder ( QWidget * w )\fC [slot]\fR" +Places the widget under \fIw\fR in the parent widget's stack. +.PP +To make this work, the widget itself and \fIw\fR must be siblings. +.PP +See also raise() and lower(). +.SH "QStyle & QWidget::style () const" +Returns the GUI style for this widget +.PP +See also QWidget::setStyle(), QApplication::setStyle(), and QApplication::style(). +.SH "void QWidget::styleChange ( QStyle & oldStyle )\fC [virtual protected]\fR" +This virtual function is called when the style of the widgets changes. \fIoldStyle\fR is the previous GUI style; you can get the new style from style(). +.PP +Reimplement this function if your widget needs to know when its GUI style changes. You will almost certainly need to update the widget using update(). +.PP +The default implementation updates the widget including its geometry. +.PP +See also QApplication::setStyle(), style(), update(), and updateGeometry(). +.SH "void QWidget::tabletEvent ( QTabletEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive tablet events for the widget. +.PP +If you reimplement this handler, it is very important that you ignore() the event if you do not handle it, so that the widget's parent can interpret it. +.PP +The default implementation ignores the event. +.PP +See also QTabletEvent::ignore(), QTabletEvent::accept(), event(), and QTabletEvent. +.SH "WFlags QWidget::testWFlags ( WFlags f ) const" +Returns the bitwise AND of the widget flags and \fIf\fR. +.PP +Widget flags are a combination of Qt::WidgetFlags. +.PP +If you want to test for the presence of multiple flags (or composite flags such as WStyle_Splash), test the return value for equality against the argument. For example: +.PP +.nf +.br + int flags = WStyle_Tool | WStyle_NoBorder; +.br + if ( testWFlags(flags) ) +.br + ... // WStyle_Tool or WStyle_NoBorder or both are set +.br + if ( testWFlags(flags) == flags ) +.br + ... // both WStyle_Tool and WStyle_NoBorder are set +.br +.fi +.PP +See also getWFlags(), setWFlags(), and clearWFlags(). +.SH "QWidget * QWidget::topLevelWidget () const" +Returns the top-level widget for this widget, i.e. the next ancestor widget that has (or could have) a window-system frame. +.PP +If the widget is a top-level, the widget itself is returned. +.PP +Typical usage is changing the window caption: +.PP +.nf +.br + aWidget->topLevelWidget()->setCaption( "New Caption" ); +.br +.fi +.PP +See also isTopLevel. +.SH "void QWidget::unsetCursor ()\fC [virtual]\fR" +Resets the cursor shape for this widget. See the "cursor" property for details. +.SH "void QWidget::unsetFont ()" +Resets the font currently set for the widget. See the "font" property for details. +.SH "void QWidget::unsetPalette ()" +Resets the widget's palette. See the "palette" property for details. +.SH "void QWidget::update ()\fC [slot]\fR" +Updates the widget unless updates are disabled or the widget is hidden. +.PP +This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker than a call to repaint() does. +.PP +Calling update() several times normally results in just one paintEvent() call. +.PP +Qt normally erases the widget's area before the paintEvent() call. If the WRepaintNoErase widget flag is set, the widget is responsible for painting all its pixels itself. +.PP +See also repaint(), paintEvent(), updatesEnabled, erase(), and setWFlags(). +.PP +Examples: +.)l desktop/desktop.cpp and scrollview/scrollview.cpp. +.SH "void QWidget::update ( int x, int y, int w, int h )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Updates a rectangle (\fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR) inside the widget unless updates are disabled or the widget is hidden. +.PP +This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker and a call to repaint() does. +.PP +Calling update() several times normally results in just one paintEvent() call. +.PP +If \fIw\fR is negative, it is replaced with \fCwidth() - x\fR. If \fIh\fR is negative, it is replaced width \fCheight() - y\fR. +.PP +Qt normally erases the specified area before the paintEvent() call. If the WRepaintNoErase widget flag is set, the widget is responsible for painting all its pixels itself. +.PP +See also repaint(), paintEvent(), updatesEnabled, and erase(). +.SH "void QWidget::update ( const QRect & r )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Updates a rectangle \fIr\fR inside the widget unless updates are disabled or the widget is hidden. +.PP +This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker and a call to repaint() does. +.PP +Calling update() several times normally results in just one paintEvent() call. +.SH "void QWidget::updateGeometry ()" +Notifies the layout system that this widget has changed and may need to change geometry. +.PP +Call this function if the sizeHint() or sizePolicy() have changed. +.PP +For explicitly hidden widgets, updateGeometry() is a no-op. The layout system will be notified as soon as the widget is shown. +.SH "void QWidget::updateMask ()\fC [virtual protected]\fR" +This function can be reimplemented in a subclass to support transparent widgets. It should be called whenever a widget changes state in a way that means that the shape mask must be recalculated. +.PP +See also autoMask, setMask(), and clearMask(). +.SH "QRect QWidget::visibleRect () const" +Returns the visible rectangle. See the "visibleRect" property for details. +.SH "void QWidget::wheelEvent ( QWheelEvent * e )\fC [virtual protected]\fR" +This event handler, for event \fIe\fR, can be reimplemented in a subclass to receive wheel events for the widget. +.PP +If you reimplement this handler, it is very important that you ignore() the event if you do not handle it, so that the widget's parent can interpret it. +.PP +The default implementation ignores the event. +.PP +See also QWheelEvent::ignore(), QWheelEvent::accept(), event(), and QWheelEvent. +.SH "int QWidget::width () const" +Returns the width of the widget excluding any window frame. See the "width" property for details. +.SH "bool QWidget::winEvent ( MSG * )\fC [virtual protected]\fR" +This special event handler can be reimplemented in a subclass to receive native Windows events. +.PP +In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. +.PP +\fBWarning:\fR This function is not portable. +.PP +See also QApplication::winEventFilter(). +.SH "WId QWidget::winId () const" +Returns the window system identifier of the widget. +.PP +Portable in principle, but if you use it you are probably about to do something non-portable. Be careful. +.PP +See also find(). +.SH "void QWidget::windowActivationChange ( bool oldActive )\fC [virtual protected]\fR" +This virtual function is called for a widget when its window is activated or deactivated by the window system. \fIoldActive\fR is the previous state; you can get the new setting from isActiveWindow(). +.PP +Reimplement this function if your widget needs to know when its window becomes activated or deactivated. +.PP +The default implementation updates the visible part of the widget if the inactive and the active colorgroup are different for colors other than the highlight and link colors. +.PP +See also setActiveWindow(), isActiveWindow, update(), and palette. +.SH "double QWidget::windowOpacity () const" +Returns the level of opacity for the window. See the "windowOpacity" property for details. +.SH "uint QWidget::windowState () const" +Returns the current window state. The window state is a OR'ed combination of Qt::WindowState: WindowMinimized, WindowMaximized, WindowFullScreen and WindowActive. +.PP +See also Qt::WindowState and setWindowState(). +.SH "int QWidget::x () const" +Returns the x coordinate of the widget relative to its parent including any window frame. See the "x" property for details. +.SH "bool QWidget::x11Event ( XEvent * )\fC [virtual protected]\fR" +This special event handler can be reimplemented in a subclass to receive native X11 events. +.PP +In your reimplementation of this function, if you want to stop the event being handled by Qt, return TRUE. If you return FALSE, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget. +.PP +\fBWarning:\fR This function is not portable. +.PP +See also QApplication::x11EventFilter(). +.PP +Reimplemented in QXtWidget. +.SH "int QWidget::y () const" +Returns the y coordinate of the widget relative to its parent and including any window frame. See the "y" property for details. +.SS "Property Documentation" +.SH "bool acceptDrops" +This property holds whether drop events are enabled for this widget. +.PP +Setting this property to TRUE announces to the system that this widget \fImay\fR be able to accept drop events. +.PP +If the widget is the desktop (QWidget::isDesktop()), this may fail if another application is using the desktop; you can call acceptDrops() to test if this occurs. +.PP +\fBWarning:\fR Do not modify this property in a Drag&Drop event handler. +.PP +Set this property's value with setAcceptDrops() and get this property's value with acceptDrops(). +.SH "bool autoMask" +This property holds whether the auto mask feature is enabled for the widget. +.PP +Transparent widgets use a mask to define their visible region. QWidget has some built-in support to make the task of recalculating the mask easier. When setting auto mask to TRUE, updateMask() will be called whenever the widget is resized or changes its focus state. Note that you must reimplement updateMask() (which should include a call to setMask()) or nothing will happen. +.PP +Note: when you re-implement resizeEvent(), focusInEvent() or focusOutEvent() in your custom widgets and still want to ensure that the auto mask calculation works, you should add: +.PP +.nf +.br + if ( autoMask() ) +.br + updateMask(); +.br +.fi +.PP +at the end of your event handlers. This is true for all member functions that change the appearance of the widget in a way that requires a recalculation of the mask. +.PP +While being a technically appealing concept, masks have a big drawback: when using complex masks that cannot be expressed easily with relatively simple regions, they can be very slow on some window systems. The classic example is a transparent label. The complex shape of its contents makes it necessary to represent its mask by a bitmap, which consumes both memory and time. If all you want is to blend the background of several neighboring widgets together seamlessly, you will probably want to use setBackgroundOrigin() rather than a mask. +.PP +See also updateMask(), setMask(), clearMask(), and backgroundOrigin. +.PP +Set this property's value with setAutoMask() and get this property's value with autoMask(). +.SH "QBrush backgroundBrush" +This property holds the widget's background brush. +.PP +The background brush depends on a widget's palette and its background mode. +.PP +See also backgroundColor(), backgroundPixmap(), eraseColor(), palette, and QApplication::setPalette(). +.PP +Get this property's value with backgroundBrush(). +.SH "BackgroundMode backgroundMode" +This property holds the color role used for painting the background of the widget. +.PP +setPaletteBackgroundColor() reads this property to determine which entry of the palette to set. +.PP +For most widgets the default suffices (PaletteBackground, typically gray), but some need to use PaletteBase (the background color for text output, typically white) or another role. +.PP +QListBox, which is "sunken" and uses the base color to contrast with its environment, does this in its constructor: +.PP +.nf +.br + setBackgroundMode( PaletteBase ); +.br +.fi +.PP +You will never need to set the background mode of a built-in widget in Qt, but you might consider setting it in your custom widgets, so that setPaletteBackgroundColor() works as expected. +.PP +Note that two of the BackgroundMode values make no sense for setBackgroundMode(), namely FixedPixmap and FixedColor. You must call setBackgroundPixmap() and setPaletteBackgroundColor() instead. +.PP +Set this property's value with setBackgroundMode() and get this property's value with backgroundMode(). +.SH "BackgroundOrigin backgroundOrigin" +This property holds the origin of the widget's background. +.PP +The origin is either WidgetOrigin (the default), ParentOrigin, WindowOrigin or AncestorOrigin. +.PP +This only makes a difference if the widget has a background pixmap, in which case positioning matters. Using WindowOrigin for several neighboring widgets makes the background blend together seamlessly. AncestorOrigin allows blending backgrounds seamlessly when an ancestor of the widget has an origin other than WindowOrigin. +.PP +See also backgroundPixmap() and backgroundMode. +.PP +Set this property's value with setBackgroundOrigin() and get this property's value with backgroundOrigin(). +.SH "QSize baseSize" +This property holds the base size of the widget. +.PP +The base size is used to calculate a proper widget size if the widget defines sizeIncrement(). +.PP +See also sizeIncrement. +.PP +Set this property's value with setBaseSize() and get this property's value with baseSize(). +.SH "QString caption" +This property holds the window caption (title). +.PP +This property only makes sense for top-level widgets. If no caption has been set, the caption is QString::null. +.PP +See also icon and iconText. +.PP +Set this property's value with setCaption() and get this property's value with caption(). +.SH "QRect childrenRect" +This property holds the bounding rectangle of the widget's children. +.PP +Hidden children are excluded. +.PP +See also childrenRegion and geometry. +.PP +Get this property's value with childrenRect(). +.SH "QRegion childrenRegion" +This property holds the combined region occupied by the widget's children. +.PP +Hidden children are excluded. +.PP +See also childrenRect and geometry. +.PP +Get this property's value with childrenRegion(). +.SH "QColorGroup colorGroup" +This property holds the current color group of the widget palette. +.PP +The color group is determined by the state of the widget. A disabled widget has the QPalette::disabled() color group, a widget with keyboard focus has the QPalette::active() color group, and an inactive widget has the QPalette::inactive() color group. +.PP +See also palette. +.PP +Get this property's value with colorGroup(). +.SH "QCursor cursor" +This property holds the cursor shape for this widget. +.PP +The mouse cursor will assume this shape when it's over this widget. See the list of predefined cursor objects for a range of useful shapes. +.PP +An editor widget might use an I-beam cursor: +.PP +.nf +.br + setCursor( IbeamCursor ); +.br +.fi +.PP +If no cursor has been set, or after a call to unsetCursor(), the parent's cursor is used. The function unsetCursor() has no effect on top-level widgets. +.PP +See also QApplication::setOverrideCursor(). +.PP +Set this property's value with setCursor(), get this property's value with cursor(), and reset this property's value with unsetCursor(). +.SH "bool customWhatsThis" +This property holds whether the widget wants to handle What's This help manually. +.PP +The default implementation of customWhatsThis() returns FALSE, which means the widget will not receive any events in Whats This mode. +.PP +The widget may leave What's This mode by calling QWhatsThis::leaveWhatsThisMode(), with or without actually displaying any help text. +.PP +You can also reimplement customWhatsThis() if your widget is a" passive interactor" supposed to work under all circumstances. Simply don't call QWhatsThis::leaveWhatsThisMode() in that case. +.PP +See also QWhatsThis::inWhatsThisMode() and QWhatsThis::leaveWhatsThisMode(). +.PP +Get this property's value with customWhatsThis(). +.SH "bool enabled" +This property holds whether the widget is enabled. +.PP +An enabled widget receives keyboard and mouse events; a disabled widget does not. In fact, an enabled widget only receives keyboard events when it is in focus. +.PP +Some widgets display themselves differently when they are disabled. For example a button might draw its label grayed out. If your widget needs to know when it becomes enabled or disabled, you can reimplement the enabledChange() function. +.PP +Disabling a widget implicitly disables all its children. Enabling respectively enables all child widgets unless they have been explicitly disabled. +.PP +See also enabled, isEnabledTo(), QKeyEvent, QMouseEvent, and enabledChange(). +.PP +Set this property's value with setEnabled() and get this property's value with isEnabled(). +.SH "bool focus" +This property holds whether this widget (or its focus proxy) has the keyboard input focus. +.PP +Effectively equivalent to \fCqApp->focusWidget() == this\fR. +.PP +See also setFocus(), clearFocus(), focusPolicy, and QApplication::focusWidget(). +.PP +Get this property's value with hasFocus(). +.SH "bool focusEnabled" +This property holds whether the widget accepts keyboard focus. +.PP +Keyboard focus is initially disabled (i.e. focusPolicy() == QWidget::NoFocus). +.PP +You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget's constructor. For instance, the QLineEdit constructor calls setFocusPolicy(QWidget::StrongFocus). +.PP +See also focusPolicy, focusInEvent(), focusOutEvent(), keyPressEvent(), keyReleaseEvent(), and enabled. +.PP +Get this property's value with isFocusEnabled(). +.SH "FocusPolicy focusPolicy" +This property holds the way the widget accepts keyboard focus. +.PP +The policy is QWidget::TabFocus if the widget accepts keyboard focus by tabbing, QWidget::ClickFocus if the widget accepts focus by clicking, QWidget::StrongFocus if it accepts both, and QWidget::NoFocus (the default) if it does not accept focus at all. +.PP +You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget's constructor. For instance, the QLineEdit constructor calls setFocusPolicy(QWidget::StrongFocus). +.PP +See also focusEnabled, focusInEvent(), focusOutEvent(), keyPressEvent(), keyReleaseEvent(), and enabled. +.PP +Set this property's value with setFocusPolicy() and get this property's value with focusPolicy(). +.SH "QFont font" +This property holds the font currently set for the widget. +.PP +The fontInfo() function reports the actual font that is being used by the widget. +.PP +As long as no special font has been set, or after unsetFont() is called, this is either a special font for the widget class, the parent's font or (if this widget is a top level widget), the default application font. +.PP +This code fragment sets a 12 point helvetica bold font: +.PP +.nf +.br + QFont f( "Helvetica", 12, QFont::Bold ); +.br + setFont( f ); +.br +.fi +.PP +In addition to setting the font, setFont() informs all children about the change. +.PP +See also fontChange(), fontInfo(), fontMetrics(), and ownFont. +.PP +Set this property's value with setFont(), get this property's value with font(), and reset this property's value with unsetFont(). +.SH "QRect frameGeometry" +This property holds geometry of the widget relative to its parent including any window frame. +.PP +See the Window Geometry documentation for an overview of geometry issues with top-level widgets. +.PP +See also geometry, x, y, and pos. +.PP +Get this property's value with frameGeometry(). +.SH "QSize frameSize" +This property holds the size of the widget including any window frame. +.PP +Get this property's value with frameSize(). +.SH "bool fullScreen" +This property holds whether the widget is full screen. +.PP +Get this property's value with isFullScreen(). +.PP +See also windowState(), minimized, and maximized. +.SH "QRect geometry" +This property holds the geometry of the widget relative to its parent and excluding the window frame. +.PP +When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive appropriate events before it is shown. +.PP +The size component is adjusted if it lies outside the range defined by minimumSize() and maximumSize(). +.PP +setGeometry() is virtual, and all other overloaded setGeometry() implementations in Qt call it. +.PP +\fBWarning:\fR Calling setGeometry() inside resizeEvent() or moveEvent() can lead to infinite recursion. +.PP +See the Window Geometry documentation for an overview of top-level widget geometry. +.PP +See also frameGeometry, rect, pos, size, moveEvent(), resizeEvent(), minimumSize, and maximumSize. +.PP +Set this property's value with setGeometry() and get this property's value with geometry(). +.SH "int height" +This property holds the height of the widget excluding any window frame. +.PP +See the Window Geometry documentation for an overview of top-level widget geometry. +.PP +See also geometry, width, and size. +.PP +Get this property's value with height(). +.SH "bool hidden" +This property holds whether the widget is explicitly hidden. +.PP +If FALSE, the widget is visible or would become visible if all its ancestors became visible. +.PP +See also hide(), show(), visible, isVisibleTo(), and shown. +.PP +Set this property's value with setHidden() and get this property's value with isHidden(). +.SH "QPixmap icon" +This property holds the widget's icon. +.PP +This property only makes sense for top-level widgets. If no icon has been set, icon() returns 0. +.PP +See also iconText, caption, and Setting the Application Icon. +.PP +Set this property's value with setIcon() and get this property's value with icon(). +.SH "QString iconText" +This property holds the widget's icon text. +.PP +This property only makes sense for top-level widgets. If no icon text has been set, this functions returns QString::null. +.PP +See also icon and caption. +.PP +Set this property's value with setIconText() and get this property's value with iconText(). +.SH "bool inputMethodEnabled" +This property holds enables or disables the use of input methods for this widget. +.PP +Most Widgets (as eg. buttons) that do not handle text input should have the input method disabled if they have focus. This is the default. +.PP +If a widget handles text input it should set this property to TRUE. +.PP +Set this property's value with setInputMethodEnabled() and get this property's value with isInputMethodEnabled(). +.SH "bool isActiveWindow" +This property holds whether this widget is the active window. +.PP +The active window is the window that contains the widget that has keyboard focus. +.PP +When popup windows are visible, this property is TRUE for both the active window \fIand\fR for the popup. +.PP +See also setActiveWindow() and QApplication::activeWindow(). +.PP +Get this property's value with isActiveWindow(). +.SH "bool isDesktop" +This property holds whether the widget is a desktop widget, i.e. represents the desktop. +.PP +A desktop widget is also a top-level widget. +.PP +See also isTopLevel and QApplication::desktop(). +.PP +Get this property's value with isDesktop(). +.SH "bool isDialog" +This property holds whether the widget is a dialog widget. +.PP +A dialog widget is a secondary top-level widget, i.e. a top-level widget with a parent. +.PP +See also isTopLevel and QDialog. +.PP +Get this property's value with isDialog(). +.SH "bool isModal" +This property holds whether the widget is a modal widget. +.PP +This property only makes sense for top-level widgets. A modal widget prevents widgets in all other top-level widgets from getting any input. +.PP +See also isTopLevel, isDialog, and QDialog. +.PP +Get this property's value with isModal(). +.SH "bool isPopup" +This property holds whether the widget is a popup widget. +.PP +A popup widget is created by specifying the widget flag WType_Popup to the widget constructor. A popup widget is also a top-level widget. +.PP +See also isTopLevel. +.PP +Get this property's value with isPopup(). +.SH "bool isTopLevel" +This property holds whether the widget is a top-level widget. +.PP +A top-level widget is a widget which usually has a frame and a caption (title). Popup and desktop widgets are also top-level widgets. +.PP +A top-level widget can have a parent widget. It will then be grouped with its parent and deleted when the parent is deleted, minimized when the parent is minimized etc. If supported by the window manager, it will also have a common taskbar entry with its parent. +.PP +QDialog and QMainWindow widgets are by default top-level, even if a parent widget is specified in the constructor. This behavior is specified by the WType_TopLevel widget flag. +.PP +See also topLevelWidget(), isDialog, isModal, isPopup, isDesktop, and parentWidget(). +.PP +Get this property's value with isTopLevel(). +.SH "bool maximized" +This property holds whether this widget is maximized. +.PP +This property is only relevant for top-level widgets. +.PP +Note that due to limitations in some window-systems, this does not always report the expected results (e.g. if the user on X11 maximizes the window via the window manager, Qt has no way of distinguishing this from any other resize). This is expected to improve as window manager protocols evolve. +.PP +See also windowState(), showMaximized(), visible, show(), hide(), showNormal(), and minimized. +.PP +Get this property's value with isMaximized(). +.SH "int maximumHeight" +This property holds the widget's maximum height. +.PP +This property corresponds to maximumSize().height(). +.PP +See also maximumSize and maximumWidth. +.PP +Set this property's value with setMaximumHeight() and get this property's value with maximumHeight(). +.SH "QSize maximumSize" +This property holds the widget's maximum size. +.PP +The widget cannot be resized to a larger size than the maximum widget size. +.PP +See also maximumWidth, maximumHeight, maximumSize, minimumSize, and sizeIncrement. +.PP +Set this property's value with setMaximumSize() and get this property's value with maximumSize(). +.SH "int maximumWidth" +This property holds the widget's maximum width. +.PP +This property corresponds to maximumSize().width(). +.PP +See also maximumSize and maximumHeight. +.PP +Set this property's value with setMaximumWidth() and get this property's value with maximumWidth(). +.SH "QRect microFocusHint" +This property holds the currently set micro focus hint for this widget. +.PP +See the documentation of setMicroFocusHint() for more information. +.PP +Get this property's value with microFocusHint(). +.SH "bool minimized" +This property holds whether this widget is minimized (iconified). +.PP +This property is only relevant for top-level widgets. +.PP +See also showMinimized(), visible, show(), hide(), showNormal(), and maximized. +.PP +Get this property's value with isMinimized(). +.SH "int minimumHeight" +This property holds the widget's minimum height. +.PP +This property corresponds to minimumSize().height(). +.PP +See also minimumSize and minimumWidth. +.PP +Set this property's value with setMinimumHeight() and get this property's value with minimumHeight(). +.SH "QSize minimumSize" +This property holds the widget's minimum size. +.PP +The widget cannot be resized to a smaller size than the minimum widget size. The widget's size is forced to the minimum size if the current size is smaller. +.PP +If you use a layout inside the widget, the minimum size will be set by the layout and not by setMinimumSize(), unless you set the layout's resize mode to QLayout::FreeResize. +.PP +See also minimumWidth, minimumHeight, maximumSize, sizeIncrement, and QLayout::resizeMode. +.PP +Set this property's value with setMinimumSize() and get this property's value with minimumSize(). +.SH "QSize minimumSizeHint" +This property holds the recommended minimum size for the widget. +.PP +If the value of this property is an invalid size, no minimum size is recommended. +.PP +The default implementation of minimumSizeHint() returns an invalid size if there is no layout for this widget, and returns the layout's minimum size otherwise. Most built-in widgets reimplement minimumSizeHint(). +.PP +QLayout will never resize a widget to a size smaller than minimumSizeHint. +.PP +See also QSize::isValid(), size, minimumSize, and sizePolicy. +.PP +Get this property's value with minimumSizeHint(). +.SH "int minimumWidth" +This property holds the widget's minimum width. +.PP +This property corresponds to minimumSize().width(). +.PP +See also minimumSize and minimumHeight. +.PP +Set this property's value with setMinimumWidth() and get this property's value with minimumWidth(). +.SH "bool mouseTracking" +This property holds whether mouse tracking is enabled for the widget. +.PP +If mouse tracking is disabled (the default), the widget only receives mouse move events when at least one mouse button is pressed while the mouse is being moved. +.PP +If mouse tracking is enabled, the widget receives mouse move events even if no buttons are pressed. +.PP +See also mouseMoveEvent() and QApplication::setGlobalMouseTracking(). +.PP +Set this property's value with setMouseTracking() and get this property's value with hasMouseTracking(). +.SH "bool ownCursor" +This property holds whether the widget uses its own cursor. +.PP +If FALSE, the widget uses its parent widget's cursor. +.PP +See also cursor. +.PP +Get this property's value with ownCursor(). +.SH "bool ownFont" +This property holds whether the widget uses its own font. +.PP +If FALSE, the widget uses its parent widget's font. +.PP +See also font. +.PP +Get this property's value with ownFont(). +.SH "bool ownPalette" +This property holds whether the widget uses its own palette. +.PP +If FALSE, the widget uses its parent widget's palette. +.PP +See also palette. +.PP +Get this property's value with ownPalette(). +.SH "QPalette palette" +This property holds the widget's palette. +.PP +As long as no special palette has been set, or after unsetPalette() has been called, this is either a special palette for the widget class, the parent's palette or (if this widget is a top level widget), the default application palette. +.PP +Instead of defining an entirely new palette, you can also use the paletteBackgroundColor, paletteBackgroundPixmap and paletteForegroundColor convenience properties to change a widget's background and foreground appearance only. +.PP +See also ownPalette, colorGroup, and QApplication::palette(). +.PP +Set this property's value with setPalette(), get this property's value with palette(), and reset this property's value with unsetPalette(). +.SH "QColor paletteBackgroundColor" +This property holds the background color of the widget. +.PP +The palette background color is usually set implicitly by setBackgroundMode(), although it can also be set explicitly by setPaletteBackgroundColor(). setPaletteBackgroundColor() is a convenience function that creates and sets a modified QPalette with setPalette(). The palette is modified according to the widget's background mode. For example, if the background mode is PaletteButton the color used for the palette's QColorGroup::Button color entry is set. +.PP +If there is a background pixmap (set using setPaletteBackgroundPixmap()), then the return value of this function is indeterminate. +.PP +See also paletteBackgroundPixmap, paletteForegroundColor, palette, and colorGroup. +.PP +Set this property's value with setPaletteBackgroundColor(), get this property's value with paletteBackgroundColor(), and reset this property's value with unsetPalette(). +.SH "QPixmap paletteBackgroundPixmap" +This property holds the background pixmap of the widget. +.PP +The palette background pixmap is usually set implicitly by setBackgroundMode(), although it can also be set explicitly by setPaletteBackgroundPixmap(). setPaletteBackgroundPixmap() is a convenience function that creates and sets a modified QPalette with setPalette(). The palette is modified according to the widget's background mode. For example, if the background mode is PaletteButton the pixmap used for the palette's QColorGroup::Button color entry is set. +.PP +If there is a plain background color (set using setPaletteBackgroundColor()), then this function returns 0. +.PP +See also paletteBackgroundColor, paletteForegroundColor, palette, and colorGroup. +.PP +Set this property's value with setPaletteBackgroundPixmap(), get this property's value with paletteBackgroundPixmap(), and reset this property's value with unsetPalette(). +.SH "QColor paletteForegroundColor" +This property holds the foreground color of the widget. +.PP +setPaletteForegroundColor() is a convenience function that creates and sets a modified QPalette with setPalette(). The palette is modified according to the widget's \fIbackground mode\fR. For example, if the background mode is PaletteButton the palette entry QColorGroup::ButtonText is set to color. +.PP +See also palette, QApplication::setPalette(), backgroundMode, foregroundColor(), backgroundMode, and setEraseColor(). +.PP +Set this property's value with setPaletteForegroundColor(), get this property's value with paletteForegroundColor(), and reset this property's value with unsetPalette(). +.SH "QPoint pos" +This property holds the position of the widget within its parent widget. +.PP +If the widget is a top-level widget, the position is that of the widget on the desktop, including its frame. +.PP +When changing the position, the widget, if visible, receives a move event (moveEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown. +.PP +move() is virtual, and all other overloaded move() implementations in Qt call it. +.PP +\fBWarning:\fR Calling move() or setGeometry() inside moveEvent() can lead to infinite recursion. +.PP +See the Window Geometry documentation for an overview of top-level widget geometry. +.PP +See also frameGeometry, size, x, and y. +.PP +Set this property's value with move() and get this property's value with pos(). +.SH "QRect rect" +This property holds the internal geometry of the widget excluding any window frame. +.PP +The rect property equals QRect(0, 0, width(), height()). +.PP +See the Window Geometry documentation for an overview of top-level widget geometry. +.PP +See also size. +.PP +Get this property's value with rect(). +.SH "bool shown" +This property holds whether the widget is shown. +.PP +If TRUE, the widget is visible or would become visible if all its ancestors became visible. +.PP +See also hide(), show(), visible, isVisibleTo(), and hidden. +.PP +Set this property's value with setShown() and get this property's value with isShown(). +.SH "QSize size" +This property holds the size of the widget excluding any window frame. +.PP +When resizing, the widget, if visible, receives a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown. +.PP +The size is adjusted if it lies outside the range defined by minimumSize() and maximumSize(). Furthermore, the size is always at least QSize(1, 1). For toplevel widgets, the minimum size might be larger, depending on the window manager. +.PP +If you want a top-level window to have a fixed size, call setResizeMode( QLayout::FreeResize ) on its layout. +.PP +resize() is virtual, and all other overloaded resize() implementations in Qt call it. +.PP +\fBWarning:\fR Calling resize() or setGeometry() inside resizeEvent() can lead to infinite recursion. +.PP +See also pos, geometry, minimumSize, maximumSize, and resizeEvent(). +.PP +Set this property's value with resize() and get this property's value with size(). +.SH "QSize sizeHint" +This property holds the recommended size for the widget. +.PP +If the value of this property is an invalid size, no size is recommended. +.PP +The default implementation of sizeHint() returns an invalid size if there is no layout for this widget, and returns the layout's preferred size otherwise. +.PP +See also QSize::isValid(), minimumSizeHint, sizePolicy, minimumSize, and updateGeometry(). +.PP +Get this property's value with sizeHint(). +.SH "QSize sizeIncrement" +This property holds the size increment of the widget. +.PP +When the user resizes the window, the size will move in steps of sizeIncrement().width() pixels horizontally and sizeIncrement.height() pixels vertically, with baseSize() as the basis. Preferred widget sizes are for non-negative integers \fIi\fR and \fIj\fR: +.PP +.nf +.br + width = baseSize().width() + i * sizeIncrement().width(); +.br + height = baseSize().height() + j * sizeIncrement().height(); +.br +.fi +.PP +Note that while you can set the size increment for all widgets, it only affects top-level widgets. +.PP +\fBWarning:\fR The size increment has no effect under Windows, and may be disregarded by the window manager on X. +.PP +See also size, minimumSize, and maximumSize. +.PP +Set this property's value with setSizeIncrement() and get this property's value with sizeIncrement(). +.SH "QSizePolicy sizePolicy" +This property holds the default layout behavior of the widget. +.PP +If there is a QLayout that manages this widget's children, the size policy specified by that layout is used. If there is no such QLayout, the result of this function is used. +.PP +The default policy is Preferred/Preferred, which means that the widget can be freely resized, but prefers to be the size sizeHint() returns. Button-like widgets set the size policy to specify that they may stretch horizontally, but are fixed vertically. The same applies to lineedit controls (such as QLineEdit, QSpinBox or an editable QComboBox) and other horizontally orientated widgets (such as QProgressBar). QToolButton's are normally square, so they allow growth in both directions. Widgets that support different directions (such as QSlider, QScrollBar or QHeader) specify stretching in the respective direction only. Widgets that can provide scrollbars (usually subclasses of QScrollView) tend to specify that they can use additional space, and that they can make do with less than sizeHint(). +.PP +See also sizeHint, QLayout, QSizePolicy, and updateGeometry(). +.PP +Set this property's value with setSizePolicy() and get this property's value with sizePolicy(). +.SH "bool underMouse" +This property holds whether the widget is under the mouse cursor. +.PP +This value is not updated properly during drag and drop operations. +.PP +See also QEvent::Enter and QEvent::Leave. +.PP +Get this property's value with hasMouse(). +.SH "bool updatesEnabled" +This property holds whether updates are enabled. +.PP +Calling update() and repaint() has no effect if updates are disabled. Paint events from the window system are processed normally even if updates are disabled. +.PP +setUpdatesEnabled() is normally used to disable updates for a short period of time, for instance to avoid screen flicker during large changes. +.PP +Example: +.PP +.nf +.br + setUpdatesEnabled( FALSE ); +.br + bigVisualChanges(); +.br + setUpdatesEnabled( TRUE ); +.br + repaint(); +.br +.fi +.PP +See also update(), repaint(), and paintEvent(). +.PP +Set this property's value with setUpdatesEnabled() and get this property's value with isUpdatesEnabled(). +.SH "bool visible" +This property holds whether the widget is visible. +.PP +Calling show() sets the widget to visible status if all its parent widgets up to the top-level widget are visible. If an ancestor is not visible, the widget won't become visible until all its ancestors are shown. +.PP +Calling hide() hides a widget explicitly. An explicitly hidden widget will never become visible, even if all its ancestors become visible, unless you show it. +.PP +A widget receives show and hide events when its visibility status changes. Between a hide and a show event, there is no need to waste CPU cycles preparing or displaying information to the user. A video application, for example, might simply stop generating new frames. +.PP +A widget that happens to be obscured by other windows on the screen is considered to be visible. The same applies to iconified top-level widgets and windows that exist on another virtual desktop (on platforms that support this concept). A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again. +.PP +See also show(), hide(), hidden, isVisibleTo(), minimized, showEvent(), and hideEvent(). +.PP +Get this property's value with isVisible(). +.SH "QRect visibleRect" +This property holds the visible rectangle. +.PP +\fBThis property is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +No longer necessary, you can simply call repaint(). If you do not need the rectangle for repaint(), use clipRegion() instead. +.PP +Get this property's value with visibleRect(). +.SH "int width" +This property holds the width of the widget excluding any window frame. +.PP +See the Window Geometry documentation for an overview of top-level widget geometry. +.PP +See also geometry, height, and size. +.PP +Get this property's value with width(). +.SH "double windowOpacity" +This property holds the level of opacity for the window. +.PP +The valid range of opacity is from 1.0 (completely opaque) to 0.0 (completely transparent). +.PP +By default the value of this property is 1.0. +.PP +This feature is only present on Mac OS X and Windows 2000 and up. +.PP +\fBWarning:\fR Changing this property from opaque to transparent might issue a paint event that needs to be processed before the window is displayed correctly. This affects mainly the use of QPixmap::grabWindow(). Also note that semi-transparent windows update and resize significantely slower than opaque windows. +.PP +Set this property's value with setWindowOpacity() and get this property's value with windowOpacity(). +.SH "int x" +This property holds the x coordinate of the widget relative to its parent including any window frame. +.PP +See the Window Geometry documentation for an overview of top-level widget geometry. +.PP +See also frameGeometry, y, and pos. +.PP +Get this property's value with x(). +.SH "int y" +This property holds the y coordinate of the widget relative to its parent and including any window frame. +.PP +See the Window Geometry documentation for an overview of top-level widget geometry. +.PP +See also frameGeometry, x, and pos. +.PP +Get this property's value with y(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwidget.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwidget.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwidgetfactory.3qt b/doc/man/man3/tqwidgetfactory.3qt new file mode 100644 index 000000000..40dd3934c --- /dev/null +++ b/doc/man/man3/tqwidgetfactory.3qt @@ -0,0 +1,135 @@ +'\" t +.TH QWidgetFactory 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 +QWidgetFactory \- For the dynamic creation of widgets from Qt Designer .ui files +.SH SYNOPSIS +\fC#include <ntqwidgetfactory.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWidgetFactory\fR ()" +.br +.ti -1c +.BI "virtual \fB~QWidgetFactory\fR ()" +.br +.ti -1c +.BI "virtual QWidget * \fBcreateWidget\fR ( const QString & className, QWidget * parent, const char * name ) const" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "QWidget * \fBcreate\fR ( const QString & uiFile, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "QWidget * \fBcreate\fR ( QIODevice * dev, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "void \fBaddWidgetFactory\fR ( QWidgetFactory * factory )" +.br +.ti -1c +.BI "void \fBloadImages\fR ( const QString & dir )" +.br +.ti -1c +.BI "QStringList \fBwidgets\fR ()" +.br +.ti -1c +.BI "bool \fBsupportsWidget\fR ( const QString & widget )" +.br +.in -1c +.SH DESCRIPTION +The QWidgetFactory class provides for the dynamic creation of widgets from Qt Designer .ui files. +.PP +This class basically offers two things: +.IP +.TP +Dynamically creating widgets from Qt Designer user interface description files. You can do this using the static function QWidgetFactory::create(). This function also performs signal and slot connections, tab ordering, etc., as defined in the .ui file, and returns the top-level widget in the .ui file. After creating the widget you can use QObject::child() and QObject::queryList() to access child widgets of this returned widget. +.IP +.TP +Adding additional widget factories to be able to create custom widgets. See createWidget() for details. +.IP +.PP +This class is not included in the Qt library itself. To use it you must link against \fClibtqui.so\fR (Unix) or \fCtqui.lib\fR (Windows), which is built into \fCINSTALL/lib\fR if you built \fIQt Designer\fR (\fCINSTALL\fR is the directory where Qt is installed ). +.PP +If you create a QMainWindow using a QWidgetFactory, be aware that it already has a central widget. Therefore, you need to delete this one before setting another one. +.PP +See the "Creating Dynamic Dialogs from .ui Files" section of the Qt Designer manual for an example. See also the QWidgetPlugin class and the Plugins documentation. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWidgetFactory::QWidgetFactory ()" +Constructs a QWidgetFactory. +.SH "QWidgetFactory::~QWidgetFactory ()\fC [virtual]\fR" +Destructor. +.SH "void QWidgetFactory::addWidgetFactory ( QWidgetFactory * factory )\fC [static]\fR" +Installs a widget factory \fIfactory\fR, which normally contains additional widgets that can then be created using a QWidgetFactory. See createWidget() for further details. +.SH "QWidget * QWidgetFactory::create ( const QString & uiFile, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Loads the \fIQt Designer\fR user interface description file \fIuiFile\fR and returns the top-level widget in that description. \fIparent\fR and \fIname\fR are passed to the constructor of the top-level widget. +.PP +This function also performs signal and slot connections, tab ordering, etc., as described in the .ui file. In \fIQt Designer\fR it is possible to add custom slots to a form and connect to them. If you want these connections to be made, you must create a class derived from QObject, which implements all these slots. Then pass an instance of the object as \fIconnector\fR to this function. If you do this, the connections to the custom slots will be done using the \fIconnector\fR as slot. +.PP +If something fails, 0 is returned. +.PP +The ownership of the returned widget is passed to the caller. +.SH "QWidget * QWidgetFactory::create ( QIODevice * dev, QObject * connector = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Loads the user interface description from device \fIdev\fR. +.SH "QWidget * QWidgetFactory::createWidget ( const QString & className, QWidget * parent, const char * name ) const\fC [virtual]\fR" +Creates a widget of the type \fIclassName\fR passing \fIparent\fR and \fIname\fR to its constructor. +.PP +If \fIclassName\fR is a widget in the Qt library, it is directly created by this function. If the widget isn't in the Qt library, each of the installed widget plugins is asked, in turn, to create the widget. As soon as a plugin says it can create the widget it is asked to do so. It may occur that none of the plugins can create the widget, in which case each installed widget factory is asked to create the widget (see addWidgetFactory()). If the widget cannot be created by any of these means, 0 is returned. +.PP +If you have a custom widget, and want it to be created using the widget factory, there are two approaches you can use: +.PP +<ol type=1> +.IP +.TP +Write a widget plugin. This allows you to use the widget in \fIQt Designer\fR and in this QWidgetFactory. See the widget plugin documentation for further details. (See the "Creating Custom Widgets with Plugins" section of the Qt Designer manual for an example. +.IP +.TP +Subclass QWidgetFactory. Then reimplement this function to create and return an instance of your custom widget if \fIclassName\fR equals the name of your widget, otherwise return 0. Then at the beginning of your program where you want to use the widget factory to create widgets do a: +.IP +.nf +.br + QWidgetFactory::addWidgetFactory( new MyWidgetFactory ); +.br +.fi +where MyWidgetFactory is your QWidgetFactory subclass. +.IP +.SH "void QWidgetFactory::loadImages ( const QString & dir )\fC [static]\fR" +If you use a pixmap collection (which is the default for new projects) rather than saving the pixmaps within the .ui XML file, you must load the pixmap collection. QWidgetFactory looks in the default QMimeSourceFactory for the pixmaps. Either add it there manually, or call this function and specify the directory where the images can be found, as \fIdir\fR. This is normally the directory called \fCimages\fR in the project's directory. +.SH "bool QWidgetFactory::supportsWidget ( const QString & widget )\fC [static]\fR" +Returns TRUE if the widget factory can create the specified \fIwidget\fR; otherwise returns FALSE. +.SH "QStringList QWidgetFactory::widgets ()\fC [static]\fR" +Returns the names of the widgets this factory can create. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwidgetfactory.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwidgetfactory.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwidgetitem.3qt b/doc/man/man3/tqwidgetitem.3qt new file mode 100644 index 000000000..01d4fde1e --- /dev/null +++ b/doc/man/man3/tqwidgetitem.3qt @@ -0,0 +1,104 @@ +'\" t +.TH QWidgetItem 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 +QWidgetItem \- Layout item that represents a widget +.SH SYNOPSIS +\fC#include <ntqlayout.h>\fR +.PP +Inherits QLayoutItem. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWidgetItem\fR ( QWidget * w )" +.br +.ti -1c +.BI "virtual QSize \fBsizeHint\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBminimumSize\fR () const" +.br +.ti -1c +.BI "virtual QSize \fBmaximumSize\fR () const" +.br +.ti -1c +.BI "virtual QSizePolicy::ExpandData \fBexpanding\fR () const" +.br +.ti -1c +.BI "virtual bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "virtual void \fBsetGeometry\fR ( const QRect & r )" +.br +.ti -1c +.BI "virtual QWidget * \fBwidget\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWidgetItem class is a layout item that represents a widget. +.PP +This is used by custom layouts. +.PP +See also QLayout, QLayout::widget(), Widget Appearance and Style, and Layout Management. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWidgetItem::QWidgetItem ( QWidget * w )" +Creates an item containing widget \fIw\fR. +.SH "QSizePolicy::ExpandData QWidgetItem::expanding () const\fC [virtual]\fR" +Returns whether this item's widget can make use of more space than sizeHint(). A value of \fCVertical\fR or \fCHorizontal\fR means that it wants to grow in only one dimension, whereas \fCBothDirections\fR means that it wants to grow in both dimensions and \fCNoDirection\fR means that it doesn't want to grow at all. +.PP +Reimplemented from QLayoutItem. +.SH "bool QWidgetItem::isEmpty () const\fC [virtual]\fR" +Returns TRUE if the widget has been hidden; otherwise returns FALSE. +.PP +Reimplemented from QLayoutItem. +.SH "QSize QWidgetItem::maximumSize () const\fC [virtual]\fR" +Returns the maximum size of this item. +.PP +Reimplemented from QLayoutItem. +.SH "QSize QWidgetItem::minimumSize () const\fC [virtual]\fR" +Returns the minimum size of this item. +.PP +Reimplemented from QLayoutItem. +.SH "void QWidgetItem::setGeometry ( const QRect & r )\fC [virtual]\fR" +Sets the geometry of this item's widget to be contained within rect \fIr\fR, taking alignment and maximum size into account. +.PP +Reimplemented from QLayoutItem. +.SH "QSize QWidgetItem::sizeHint () const\fC [virtual]\fR" +Returns the preferred size of this item. +.PP +Reimplemented from QLayoutItem. +.SH "QWidget * QWidgetItem::widget ()\fC [virtual]\fR" +Returns the widget managed by this item. +.PP +Reimplemented from QLayoutItem. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwidgetitem.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwidgetitem.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwidgetplugin.3qt b/doc/man/man3/tqwidgetplugin.3qt new file mode 100644 index 000000000..6024a534b --- /dev/null +++ b/doc/man/man3/tqwidgetplugin.3qt @@ -0,0 +1,124 @@ +'\" t +.TH QWidgetPlugin 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 +QWidgetPlugin \- Abstract base for custom QWidget plugins +.SH SYNOPSIS +\fC#include <ntqwidgetplugin.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWidgetPlugin\fR ()" +.br +.ti -1c +.BI "\fB~QWidgetPlugin\fR ()" +.br +.ti -1c +.BI "virtual QStringList \fBkeys\fR () const = 0" +.br +.ti -1c +.BI "virtual QWidget * \fBcreate\fR ( const QString & key, QWidget * parent = 0, const char * name = 0 ) = 0" +.br +.ti -1c +.BI "virtual QString \fBgroup\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual QIconSet \fBiconSet\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual QString \fBincludeFile\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual QString \fBtoolTip\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual QString \fBwhatsThis\fR ( const QString & key ) const" +.br +.ti -1c +.BI "virtual bool \fBisContainer\fR ( const QString & key ) const" +.br +.in -1c +.SH DESCRIPTION +The QWidgetPlugin class provides an abstract base for custom QWidget plugins. +.PP +The widget plugin is a simple plugin interface that makes it easy to create custom widgets that can be included in forms using Qt Designer and used by applications. +.PP +Writing a widget plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys(), create(), group(), iconSet(), includeFile(), toolTip(), whatsThis() and isContainer(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. +.PP +See the Qt Designer manual's, 'Creating Custom Widgets' section in the 'Creating Custom Widgets' chapter, for a complete example of a QWidgetPlugin. +.PP +See also the Plugins documentation and the QWidgetFactory class that is supplied with Qt Designer. +.PP +See also Plugins. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWidgetPlugin::QWidgetPlugin ()" +Constructs a widget plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro. +.SH "QWidgetPlugin::~QWidgetPlugin ()" +Destroys the widget plugin. +.PP +You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used. +.SH "QWidget * QWidgetPlugin::create ( const QString & key, QWidget * parent = 0, const char * name = 0 )\fC [pure virtual]\fR" +Creates and returns a QWidget object for the widget key \fIkey\fR. The widget key is the class name of the required widget. The \fIname\fR and \fIparent\fR arguments are passed to the custom widget's constructor. +.PP +See also keys(). +.SH "QString QWidgetPlugin::group ( const QString & key ) const\fC [virtual]\fR" +Returns the group (toolbar name) that the custom widget of class \fIkey\fR should be part of when \fIQt Designer\fR loads it. +.PP +The default implementation returns QString::null. +.SH "QIconSet QWidgetPlugin::iconSet ( const QString & key ) const\fC [virtual]\fR" +Returns the iconset that \fIQt Designer\fR should use to represent the custom widget of class \fIkey\fR in the toolbar. +.PP +The default implementation returns an null iconset. +.SH "QString QWidgetPlugin::includeFile ( const QString & key ) const\fC [virtual]\fR" +Returns the name of the include file that \fIQt Designer\fR and \fCuic\fR should use to include the custom widget of class \fIkey\fR in generated code. +.PP +The default implementation returns QString::null. +.SH "bool QWidgetPlugin::isContainer ( const QString & key ) const\fC [virtual]\fR" +Returns TRUE if the custom widget of class \fIkey\fR can contain other widgets, e.g. like QFrame; otherwise returns FALSE. +.PP +The default implementation returns FALSE. +.SH "QStringList QWidgetPlugin::keys () const\fC [pure virtual]\fR" +Returns the list of widget keys this plugin supports. +.PP +These keys must be the class names of the custom widgets that are implemented in the plugin. +.PP +See also create(). +.SH "QString QWidgetPlugin::toolTip ( const QString & key ) const\fC [virtual]\fR" +Returns the text of the tooltip that \fIQt Designer\fR should use for the custom widget of class \fIkey\fR's toolbar button. +.PP +The default implementation returns QString::null. +.SH "QString QWidgetPlugin::whatsThis ( const QString & key ) const\fC [virtual]\fR" +Returns the text of the whatsThis text that \fIQt Designer\fR should use when the user requests whatsThis help for the custom widget of class \fIkey\fR. +.PP +The default implementation returns QString::null. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwidgetplugin.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwidgetplugin.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwidgetstack.3qt b/doc/man/man3/tqwidgetstack.3qt new file mode 100644 index 000000000..884ac4bf3 --- /dev/null +++ b/doc/man/man3/tqwidgetstack.3qt @@ -0,0 +1,166 @@ +'\" t +.TH QWidgetStack 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 +QWidgetStack \- Stack of widgets of which only the top widget is user-visible +.SH SYNOPSIS +\fC#include <ntqwidgetstack.h>\fR +.PP +Inherits QFrame. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWidgetStack\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fBQWidgetStack\fR ( QWidget * parent, const char * name, WFlags f )" +.br +.ti -1c +.BI "\fB~QWidgetStack\fR ()" +.br +.ti -1c +.BI "int \fBaddWidget\fR ( QWidget * w, int id = -1 )" +.br +.ti -1c +.BI "void \fBremoveWidget\fR ( QWidget * w )" +.br +.ti -1c +.BI "QWidget * \fBwidget\fR ( int id ) const" +.br +.ti -1c +.BI "int \fBid\fR ( QWidget * widget ) const" +.br +.ti -1c +.BI "QWidget * \fBvisibleWidget\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBraiseWidget\fR ( int id )" +.br +.ti -1c +.BI "void \fBraiseWidget\fR ( QWidget * w )" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBaboutToShow\fR ( int )" +.br +.ti -1c +.BI "void \fBaboutToShow\fR ( QWidget * )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBsetChildGeometries\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWidgetStack class provides a stack of widgets of which only the top widget is user-visible. +.PP +The application programmer can move any widget to the top of the stack at any time using raiseWidget(), and add or remove widgets using addWidget() and removeWidget(). It is not sufficient to pass the widget stack as parent to a widget which should be inserted into the widgetstack. +.PP +visibleWidget() is the \fIget\fR equivalent of raiseWidget(); it returns a pointer to the widget that is currently at the top of the stack. +.PP +QWidgetStack also provides the ability to manipulate widgets through application-specified integer IDs. You can also translate from widget pointers to IDs using id() and from IDs to widget pointers using widget(). These numeric IDs are unique (per QWidgetStack, not globally), but QWidgetStack does not attach any additional meaning to them. +.PP +The default widget stack is frameless, but you can use the usual QFrame functions (such as setFrameStyle()) to add a frame. +.PP +QWidgetStack provides a signal, aboutToShow(), which is emitted just before a managed widget is shown. +.PP +See also QTabDialog, QTabBar, QFrame, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWidgetStack::QWidgetStack ( QWidget * parent = 0, const char * name = 0 )" +Constructs an empty widget stack. +.PP +The \fIparent\fR and \fIname\fR arguments are passed to the QFrame constructor. +.SH "QWidgetStack::QWidgetStack ( QWidget * parent, const char * name, WFlags f )" +Constructs an empty widget stack. +.PP +The \fIparent\fR, \fIname\fR and \fIf\fR arguments are passed to the QFrame constructor. +.SH "QWidgetStack::~QWidgetStack ()" +Destroys the object and frees any allocated resources. +.SH "void QWidgetStack::aboutToShow ( int )\fC [signal]\fR" +This signal is emitted just before a managed widget is shown if that managed widget has an ID != -1. The argument is the numeric ID of the widget. +.PP +If you call visibleWidget() in a slot connected to aboutToShow(), the widget it returns is the one that is currently visible, not the one that is about to be shown. +.SH "void QWidgetStack::aboutToShow ( QWidget * )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted just before a managed widget is shown. The argument is a pointer to the widget. +.PP +If you call visibleWidget() in a slot connected to aboutToShow(), the widget returned is the one that is currently visible, not the one that is about to be shown. +.SH "int QWidgetStack::addWidget ( QWidget * w, int id = -1 )" +Adds widget \fIw\fR to this stack of widgets, with ID \fIid\fR. +.PP +If you pass an id >= 0 this ID is used. If you pass an \fIid\fR of -1 (the default), the widgets will be numbered automatically. If you pass -2 a unique negative integer will be generated. No widget has an ID of -1. Returns the ID or -1 on failure (e.g. \fIw\fR is 0). +.PP +If you pass an id that is already used, then a unique negative integer will be generated to prevent two widgets having the same id. +.PP +If \fIw\fR already exists in the stack the widget will be removed first. +.PP +If \fIw\fR is not a child of this QWidgetStack moves it using reparent(). +.PP +Example: xform/xform.cpp. +.SH "int QWidgetStack::id ( QWidget * widget ) const" +Returns the ID of the \fIwidget\fR. Returns -1 if \fIwidget\fR is 0 or is not being managed by this widget stack. +.PP +See also widget() and addWidget(). +.SH "void QWidgetStack::raiseWidget ( int id )\fC [slot]\fR" +Raises the widget with ID \fIid\fR to the top of the widget stack. +.PP +See also visibleWidget(). +.PP +Example: xform/xform.cpp. +.SH "void QWidgetStack::raiseWidget ( QWidget * w )\fC [slot]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Raises widget \fIw\fR to the top of the widget stack. +.SH "void QWidgetStack::removeWidget ( QWidget * w )" +Removes widget \fIw\fR from this stack of widgets. Does not delete \fIw\fR. If \fIw\fR is the currently visible widget, no other widget is substituted. +.PP +See also visibleWidget() and raiseWidget(). +.SH "void QWidgetStack::setChildGeometries ()\fC [virtual protected]\fR" +Fixes up the children's geometries. +.SH "QWidget * QWidgetStack::visibleWidget () const" +Returns the currently visible widget (the one at the top of the stack), or 0 if nothing is currently being shown. +.PP +See also aboutToShow(), id(), and raiseWidget(). +.SH "QWidget * QWidgetStack::widget ( int id ) const" +Returns the widget with ID \fIid\fR. Returns 0 if this widget stack does not manage a widget with ID \fIid\fR. +.PP +See also id() and addWidget(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwidgetstack.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwidgetstack.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwindowsmime.3qt b/doc/man/man3/tqwindowsmime.3qt new file mode 100644 index 000000000..ec0e23cb1 --- /dev/null +++ b/doc/man/man3/tqwindowsmime.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QWindowsMime 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 +QWindowsMime \- Maps open-standard MIME to Window Clipboard formats +.SH SYNOPSIS +\fC#include <ntqmime.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWindowsMime\fR ()" +.br +.ti -1c +.BI "virtual \fB~QWindowsMime\fR ()" +.br +.ti -1c +.BI "virtual const char * \fBconvertorName\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBcountCf\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBcf\fR ( int index ) = 0" +.br +.ti -1c +.BI "virtual bool \fBcanConvert\fR ( const char * mime, int cf ) = 0" +.br +.ti -1c +.BI "virtual const char * \fBmimeFor\fR ( int cf ) = 0" +.br +.ti -1c +.BI "virtual int \fBcfFor\fR ( const char * mime ) = 0" +.br +.ti -1c +.BI "virtual QByteArray \fBconvertToMime\fR ( QByteArray data, const char * mime, int cf ) = 0" +.br +.ti -1c +.BI "virtual QByteArray \fBconvertFromMime\fR ( QByteArray data, const char * mime, int cf ) = 0" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBinitialize\fR ()" +.br +.ti -1c +.BI "QPtrList<QWindowsMime> \fBall\fR ()" +.br +.ti -1c +.BI "QWindowsMime * \fBconvertor\fR ( const char * mime, int cf )" +.br +.ti -1c +.BI "const char * \fBcfToMime\fR ( int cf )" +.br +.in -1c +.SH DESCRIPTION +The QWindowsMime class maps open-standard MIME to Window Clipboard formats. +.PP +Qt's drag-and-drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol, but on Windows although some applications use MIME types to describe clipboard formats, others use arbitrary non-standardized naming conventions, or unnamed built-in formats of Windows. +.PP +By instantiating subclasses of QWindowsMime that provide conversions between Windows Clipboard and MIME formats, you can convert proprietary clipboard formats to MIME formats. +.PP +Qt has predefined support for the following Windows Clipboard formats: +.TP +CF_UNICODETEXT - converted to "text/plain;charset=ISO-10646-UCS-2" and supported by QTextDrag. +.TP +CF_TEXT - converted to "text/plain;charset=system" or "text/plain" and supported by QTextDrag. +.TP +CF_DIB - converted to "image/*", where * is a Qt image format, and supported by QImageDrag. +.TP +CF_HDROP - converted to "text/uri-list", and supported by QUriDrag. +.PP +An example use of this class would be to map the Windows Metafile clipboard format (CF_METAFILEPICT) to and from the MIME type "image/x-wmf". This conversion might simply be adding or removing a header, or even just passing on the data. See the Drag-and-Drop documentation for more information on choosing and definition MIME types. +.PP +You can check if a MIME type is convertible using canConvert() and can perform conversions with convertToMime() and convertFromMime(). +.PP +See also Drag And Drop Classes, Input/Output and Networking, and Miscellaneous Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWindowsMime::QWindowsMime ()" +Constructs a new conversion object, adding it to the globally accessed list of available convertors. +.SH "QWindowsMime::~QWindowsMime ()\fC [virtual]\fR" +Destroys a conversion object, removing it from the global list of available convertors. +.SH "QPtrList<QWindowsMime> QWindowsMime::all ()\fC [static]\fR" +Returns a list of all currently defined QWindowsMime objects. +.SH "bool QWindowsMime::canConvert ( const char * mime, int cf )\fC [pure virtual]\fR" +Returns TRUE if the convertor can convert (both ways) between \fImime\fR and \fIcf\fR; otherwise returns FALSE. +.PP +All subclasses must reimplement this pure virtual function. +.SH "int QWindowsMime::cf ( int index )\fC [pure virtual]\fR" +Returns the Windows Clipboard format supported by this convertor that is ordinarily at position \fIindex\fR. This means that cf(0) returns the first Windows Clipboard format supported, and cf(countCf()-1) returns the last. If \fIindex\fR is out of range the return value is undefined. +.PP +All subclasses must reimplement this pure virtual function. +.SH "int QWindowsMime::cfFor ( const char * mime )\fC [pure virtual]\fR" +Returns the Windows Clipboard type used for MIME type \fImime\fR, or 0 if this convertor does not support \fImime\fR. +.PP +All subclasses must reimplement this pure virtual function. +.SH "const char * QWindowsMime::cfToMime ( int cf )\fC [static]\fR" +Returns a MIME type for \fIcf\fR, or 0 if none exists. +.SH "QByteArray QWindowsMime::convertFromMime ( QByteArray data, const char * mime, int cf )\fC [pure virtual]\fR" +Returns \fIdata\fR converted from MIME type \fImime\fR to Windows Clipboard format \fIcf\fR. +.PP +Note that Windows Clipboard formats must all be self-terminating. The return value may contain trailing data. +.PP +All subclasses must reimplement this pure virtual function. +.SH "QByteArray QWindowsMime::convertToMime ( QByteArray data, const char * mime, int cf )\fC [pure virtual]\fR" +Returns \fIdata\fR converted from Windows Clipboard format \fIcf\fR to MIME type \fImime\fR. +.PP +Note that Windows Clipboard formats must all be self-terminating. The input \fIdata\fR may contain trailing data. +.PP +All subclasses must reimplement this pure virtual function. +.SH "QWindowsMime * QWindowsMime::convertor ( const char * mime, int cf )\fC [static]\fR" +Returns the most-recently created QWindowsMime that can convert between the \fImime\fR and \fIcf\fR formats. Returns 0 if no such convertor exists. +.SH "const char * QWindowsMime::convertorName ()\fC [pure virtual]\fR" +Returns a name for the convertor. +.PP +All subclasses must reimplement this pure virtual function. +.SH "int QWindowsMime::countCf ()\fC [pure virtual]\fR" +Returns the number of Windows Clipboard formats supported by this convertor. +.PP +All subclasses must reimplement this pure virtual function. +.SH "void QWindowsMime::initialize ()\fC [static]\fR" +This is an internal function. +.SH "const char * QWindowsMime::mimeFor ( int cf )\fC [pure virtual]\fR" +Returns the MIME type used for Windows Clipboard format \fIcf\fR, or 0 if this convertor does not support \fIcf\fR. +.PP +All subclasses must reimplement this pure virtual function. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwindowsmime.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwindowsmime.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwindowsstyle.3qt b/doc/man/man3/tqwindowsstyle.3qt new file mode 100644 index 000000000..a2396d758 --- /dev/null +++ b/doc/man/man3/tqwindowsstyle.3qt @@ -0,0 +1,57 @@ +'\" t +.TH QWindowsStyle 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 +QWindowsStyle \- Microsoft Windows-like look and feel +.SH SYNOPSIS +\fC#include <ntqwindowsstyle.h>\fR +.PP +Inherits QCommonStyle. +.PP +Inherited by QMacStyle and QPlatinumStyle. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWindowsStyle\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWindowsStyle class provides a Microsoft Windows-like look and feel. +.PP +This style is Qt's default GUI style on Windows. +.PP +See also Widget Appearance and Style. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWindowsStyle::QWindowsStyle ()" +Constructs a QWindowsStyle + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwindowsstyle.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwindowsstyle.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwizard.3qt b/doc/man/man3/tqwizard.3qt new file mode 100644 index 000000000..7de8d5af8 --- /dev/null +++ b/doc/man/man3/tqwizard.3qt @@ -0,0 +1,289 @@ +'\" t +.TH QWizard 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 +QWizard \- Framework for wizard dialogs +.SH SYNOPSIS +\fC#include <ntqwizard.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWizard\fR ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.br +.ti -1c +.BI "\fB~QWizard\fR ()" +.br +.ti -1c +.BI "virtual void \fBaddPage\fR ( QWidget * page, const QString & title )" +.br +.ti -1c +.BI "virtual void \fBinsertPage\fR ( QWidget * page, const QString & title, int index )" +.br +.ti -1c +.BI "virtual void \fBremovePage\fR ( QWidget * page )" +.br +.ti -1c +.BI "QString \fBtitle\fR ( QWidget * page ) const" +.br +.ti -1c +.BI "void \fBsetTitle\fR ( QWidget * page, const QString & title )" +.br +.ti -1c +.BI "QFont \fBtitleFont\fR () const" +.br +.ti -1c +.BI "void \fBsetTitleFont\fR ( const QFont & )" +.br +.ti -1c +.BI "virtual void \fBshowPage\fR ( QWidget * page )" +.br +.ti -1c +.BI "QWidget * \fBcurrentPage\fR () const" +.br +.ti -1c +.BI "QWidget * \fBpage\fR ( int index ) const" +.br +.ti -1c +.BI "int \fBpageCount\fR () const" +.br +.ti -1c +.BI "int \fBindexOf\fR ( QWidget * page ) const" +.br +.ti -1c +.BI "virtual bool \fBappropriate\fR ( QWidget * page ) const" +.br +.ti -1c +.BI "virtual void \fBsetAppropriate\fR ( QWidget * page, bool appropriate )" +.br +.ti -1c +.BI "QPushButton * \fBbackButton\fR () const" +.br +.ti -1c +.BI "QPushButton * \fBnextButton\fR () const" +.br +.ti -1c +.BI "QPushButton * \fBfinishButton\fR () const" +.br +.ti -1c +.BI "QPushButton * \fBcancelButton\fR () const" +.br +.ti -1c +.BI "QPushButton * \fBhelpButton\fR () const" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "virtual void \fBsetBackEnabled\fR ( QWidget * page, bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetNextEnabled\fR ( QWidget * page, bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetFinishEnabled\fR ( QWidget * page, bool enable )" +.br +.ti -1c +.BI "virtual void \fBsetHelpEnabled\fR ( QWidget * page, bool enable )" +.br +.ti -1c +.BI "virtual void setFinish ( QWidget *, bool ) \fI(obsolete)\fR" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBhelpClicked\fR ()" +.br +.ti -1c +.BI "void \fBselected\fR ( const QString & )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "QFont \fBtitleFont\fR - the font used for page titles" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBlayOutButtonRow\fR ( QHBoxLayout * layout )" +.br +.ti -1c +.BI "virtual void \fBlayOutTitleRow\fR ( QHBoxLayout * layout, const QString & title )" +.br +.in -1c +.SS "Protected Slots" +.in +1c +.ti -1c +.BI "virtual void \fBback\fR ()" +.br +.ti -1c +.BI "virtual void \fBnext\fR ()" +.br +.ti -1c +.BI "virtual void \fBhelp\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWizard class provides a framework for wizard dialogs. +.PP +A wizard is a special type of input dialog that consists of a sequence of dialog pages. A wizard's purpose is to walk the user through a process step by step. Wizards are useful for complex or infrequently occurring tasks that people may find difficult to learn or do. +.PP +QWizard provides page titles and displays Next, Back, Finish, Cancel, and Help push buttons, as appropriate to the current position in the page sequence. These buttons can be enabled/disabled using setBackEnabled(), setNextEnabled(), setFinishEnabled() and setHelpEnabled(). +.PP +Create and populate dialog pages that inherit from QWidget and add them to the wizard using addPage(). Use insertPage() to add a dialog page at a certain position in the page sequence. Use removePage() to remove a page from the page sequence. +.PP +Use currentPage() to retrieve a pointer to the currently displayed page. page() returns a pointer to the page at a certain position in the page sequence. +.PP +Use pageCount() to retrieve the total number of pages in the page sequence. indexOf() will return the index of a page in the page sequence. +.PP +QWizard provides functionality to mark pages as appropriate (or not) in the current context with setAppropriate(). The idea is that a page may be irrelevant and should be skipped depending on the data entered by the user on a preceding page. +.PP +It is generally considered good design to provide a greater number of simple pages with fewer choices rather than a smaller number of complex pages. +.PP +Example code is available here: wizard/wizard.cpp wizard/wizard.h +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> <blockquote><p align="center">\fI A QWizard page \fR</p> </blockquote> +.PP +See also Abstract Widget Classes, Dialog Classes, and Organizers. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWizard::QWizard ( QWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +Constructs an empty wizard dialog. The \fIparent\fR, \fIname\fR, \fImodal\fR and \fIf\fR arguments are passed to the QDialog constructor. +.SH "QWizard::~QWizard ()" +Destroys the object and frees any allocated resources, including all pages and controllers. +.SH "void QWizard::addPage ( QWidget * page, const QString & title )\fC [virtual]\fR" +Adds \fIpage\fR to the end of the page sequence, with the title, \fItitle\fR. +.SH "bool QWizard::appropriate ( QWidget * page ) const\fC [virtual]\fR" +Called when the Next button is clicked; this virtual function returns TRUE if \fIpage\fR is relevant for display in the current context; otherwise it is ignored by QWizard and returns FALSE. The default implementation returns the value set using setAppropriate(). The ultimate default is TRUE. +.PP +\fBWarning:\fR The last page of the wizard will be displayed if no page is relevant in the current context. +.SH "void QWizard::back ()\fC [virtual protected slot]\fR" +Called when the user clicks the Back button; this function shows the preceding relevant page in the sequence. +.PP +See also appropriate(). +.SH "QPushButton * QWizard::backButton () const" +Returns a pointer to the dialog's Back button +.PP +By default, this button is connected to the back() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setBackEnabled() to enable/disable this button. +.SH "QPushButton * QWizard::cancelButton () const" +Returns a pointer to the dialog's Cancel button +.PP +By default, this button is connected to the QDialog::reject() slot, which is virtual so you can reimplement it in a QWizard subclass. +.SH "QWidget * QWizard::currentPage () const" +Returns a pointer to the current page in the sequence. Although the wizard does its best to make sure that this value is never 0, it can be if you try hard enough. +.SH "QPushButton * QWizard::finishButton () const" +Returns a pointer to the dialog's Finish button +.PP +By default, this button is connected to the QDialog::accept() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setFinishEnabled() to enable/disable this button. +.SH "void QWizard::help ()\fC [virtual protected slot]\fR" +Called when the user clicks the Help button, this function emits the helpClicked() signal. +.SH "QPushButton * QWizard::helpButton () const" +Returns a pointer to the dialog's Help button +.PP +By default, this button is connected to the help() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setHelpEnabled() to enable/disable this button. +.SH "void QWizard::helpClicked ()\fC [signal]\fR" +This signal is emitted when the user clicks on the Help button. +.SH "int QWizard::indexOf ( QWidget * page ) const" +Returns the position of page \fIpage\fR. If the page is not part of the wizard -1 is returned. +.SH "void QWizard::insertPage ( QWidget * page, const QString & title, int index )\fC [virtual]\fR" +Inserts \fIpage\fR at position \fIindex\fR into the page sequence, with title \fItitle\fR. If \fIindex\fR is -1, the page will be appended to the end of the wizard's page sequence. +.SH "void QWizard::layOutButtonRow ( QHBoxLayout * layout )\fC [virtual protected]\fR" +This virtual function is responsible for adding the buttons below the bottom divider. +.PP +\fIlayout\fR is the horizontal layout of the entire wizard. +.SH "void QWizard::layOutTitleRow ( QHBoxLayout * layout, const QString & title )\fC [virtual protected]\fR" +This virtual function is responsible for laying out the title row. +.PP +\fIlayout\fR is the horizontal layout for the wizard, and \fItitle\fR is the title for this page. This function is called every time \fItitle\fR changes. +.SH "void QWizard::next ()\fC [virtual protected slot]\fR" +Called when the user clicks the Next button, this function shows the next relevant page in the sequence. +.PP +See also appropriate(). +.SH "QPushButton * QWizard::nextButton () const" +Returns a pointer to the dialog's Next button +.PP +By default, this button is connected to the next() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setNextEnabled() to enable/disable this button. +.SH "QWidget * QWizard::page ( int index ) const" +Returns a pointer to the page at position \fIindex\fR in the sequence, or 0 if \fIindex\fR is out of range. The first page has index 0. +.SH "int QWizard::pageCount () const" +Returns the number of pages in the wizard. +.SH "void QWizard::removePage ( QWidget * page )\fC [virtual]\fR" +Removes \fIpage\fR from the page sequence but does not delete the page. If \fIpage\fR is currently being displayed, QWizard will display the page that precedes it, or the first page if this was the first page. +.SH "void QWizard::selected ( const QString & )\fC [signal]\fR" +This signal is emitted when the current page changes. The parameter contains the title of the selected page. +.SH "void QWizard::setAppropriate ( QWidget * page, bool appropriate )\fC [virtual]\fR" +If \fIappropriate\fR is TRUE then page \fIpage\fR is considered relevant in the current context and should be displayed in the page sequence; otherwise \fIpage\fR should not be displayed in the page sequence. +.PP +See also appropriate(). +.SH "void QWizard::setBackEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" +If \fIenable\fR is TRUE, page \fIpage\fR has a Back button; otherwise \fIpage\fR has no Back button. By default all pages have this button. +.SH "void QWizard::setFinish ( QWidget *, bool )\fC [virtual slot]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Use setFinishEnabled instead +.SH "void QWizard::setFinishEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" +If \fIenable\fR is TRUE, page \fIpage\fR has a Finish button; otherwise \fIpage\fR has no Finish button. By default \fIno\fR page has this button. +.SH "void QWizard::setHelpEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" +If \fIenable\fR is TRUE, page \fIpage\fR has a Help button; otherwise \fIpage\fR has no Help button. By default all pages have this button. +.SH "void QWizard::setNextEnabled ( QWidget * page, bool enable )\fC [virtual slot]\fR" +If \fIenable\fR is TRUE, page \fIpage\fR has a Next button; otherwise the Next button on \fIpage\fR is disabled. By default all pages have this button. +.SH "void QWizard::setTitle ( QWidget * page, const QString & title )" +Sets the title for page \fIpage\fR to \fItitle\fR. +.SH "void QWizard::setTitleFont ( const QFont & )" +Sets the font used for page titles. See the "titleFont" property for details. +.SH "void QWizard::showPage ( QWidget * page )\fC [virtual]\fR" +Makes \fIpage\fR the current page and emits the selected() signal. +.PP +This virtual function is called whenever a different page is to be shown, including the first time the QWizard is shown. By reimplementing it (and calling QWizard::showPage()), you can prepare each page prior to it being shown. +.PP +Examples: +.)l distributor/distributor.ui.h and wizard/wizard.cpp. +.SH "QString QWizard::title ( QWidget * page ) const" +Returns the title of page \fIpage\fR. +.SH "QFont QWizard::titleFont () const" +Returns the font used for page titles. See the "titleFont" property for details. +.SS "Property Documentation" +.SH "QFont titleFont" +This property holds the font used for page titles. +.PP +The default is QApplication::font(). +.PP +Set this property's value with setTitleFont() and get this property's value with titleFont(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwizard.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwizard.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwmatrix.3qt b/doc/man/man3/tqwmatrix.3qt new file mode 100644 index 000000000..8e0bd1903 --- /dev/null +++ b/doc/man/man3/tqwmatrix.3qt @@ -0,0 +1,473 @@ +'\" t +.TH QWMatrix 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 +QWMatrix \- 2D transformations of a coordinate system +.SH SYNOPSIS +\fC#include <ntqwmatrix.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWMatrix\fR ()" +.br +.ti -1c +.BI "\fBQWMatrix\fR ( double m11, double m12, double m21, double m22, double dx, double dy )" +.br +.ti -1c +.BI "void \fBsetMatrix\fR ( double m11, double m12, double m21, double m22, double dx, double dy )" +.br +.ti -1c +.BI "double \fBm11\fR () const" +.br +.ti -1c +.BI "double \fBm12\fR () const" +.br +.ti -1c +.BI "double \fBm21\fR () const" +.br +.ti -1c +.BI "double \fBm22\fR () const" +.br +.ti -1c +.BI "double \fBdx\fR () const" +.br +.ti -1c +.BI "double \fBdy\fR () const" +.br +.ti -1c +.BI "void \fBmap\fR ( int x, int y, int * tx, int * ty ) const" +.br +.ti -1c +.BI "void \fBmap\fR ( double x, double y, double * tx, double * ty ) const" +.br +.ti -1c +.BI "QRect \fBmapRect\fR ( const QRect & rect ) const" +.br +.ti -1c +.BI "QPoint \fBmap\fR ( const QPoint & p ) const" +.br +.ti -1c +.BI "QRect map ( const QRect & r ) const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QPointArray \fBmap\fR ( const QPointArray & a ) const" +.br +.ti -1c +.BI "QRegion \fBmap\fR ( const QRegion & r ) const" +.br +.ti -1c +.BI "QRegion \fBmapToRegion\fR ( const QRect & rect ) const" +.br +.ti -1c +.BI "QPointArray \fBmapToPolygon\fR ( const QRect & rect ) const" +.br +.ti -1c +.BI "void \fBreset\fR ()" +.br +.ti -1c +.BI "bool \fBisIdentity\fR () const" +.br +.ti -1c +.BI "QWMatrix & \fBtranslate\fR ( double dx, double dy )" +.br +.ti -1c +.BI "QWMatrix & \fBscale\fR ( double sx, double sy )" +.br +.ti -1c +.BI "QWMatrix & \fBshear\fR ( double sh, double sv )" +.br +.ti -1c +.BI "QWMatrix & \fBrotate\fR ( double a )" +.br +.ti -1c +.BI "bool \fBisInvertible\fR () const" +.br +.ti -1c +.BI "double \fBdet\fR () const" +.br +.ti -1c +.BI "QWMatrix \fBinvert\fR ( bool * invertible = 0 ) const" +.br +.ti -1c +.BI "bool \fBoperator==\fR ( const QWMatrix & m ) const" +.br +.ti -1c +.BI "bool \fBoperator!=\fR ( const QWMatrix & m ) const" +.br +.ti -1c +.BI "QWMatrix & \fBoperator*=\fR ( const QWMatrix & m )" +.br +.ti -1c +.BI "enum \fBTransformationMode\fR { Points, Areas }" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBsetTransformationMode\fR ( QWMatrix::TransformationMode m )" +.br +.ti -1c +.BI "TransformationMode \fBtransformationMode\fR ()" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QWMatrix & m )" +.br +.ti -1c +.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QWMatrix & m )" +.br +.in -1c +.SH DESCRIPTION +The QWMatrix class specifies 2D transformations of a coordinate system. +.PP +The standard coordinate system of a paint device has the origin located at the top-left position. X values increase to the right; Y values increase downward. +.PP +This coordinate system is the default for the QPainter, which renders graphics in a paint device. A user-defined coordinate system can be specified by setting a QWMatrix for the painter. +.PP +Example: +.PP +.nf +.br + MyWidget::paintEvent( QPaintEvent * ) +.br + { +.br + QPainter p; // our painter +.br + QWMatrix m; // our transformation matrix +.br + m.rotate( 22.5 ); // rotated coordinate system +.br + p.begin( this ); // start painting +.br + p.setWorldMatrix( m ); // use rotated coordinate system +.br + p.drawText( 30,20, "detator" ); // draw rotated text at 30,20 +.br + p.end(); // painting done +.br + } +.br +.fi +.PP +A matrix specifies how to translate, scale, shear or rotate the graphics; the actual transformation is performed by the drawing routines in QPainter and by QPixmap::xForm(). +.PP +The QWMatrix class contains a 3x3 matrix of the form: +.nf +.TS +l +- +l. +m11 m12 0 +m21 m22 0 +dx dy 1 +.TE +.fi + +.PP +A matrix transforms a point in the plane to another point: +.PP +.nf +.br + x' = m11*x + m21*y + dx +.br + y' = m22*y + m12*x + dy +.br +.fi +.PP +The point \fI(x, y)\fR is the original point, and \fI(x', y')\fR is the transformed point. \fI(x', y')\fR can be transformed back to \fI(x, y)\fR by performing the same operation on the inverted matrix. +.PP +The elements \fIdx\fR and \fIdy\fR specify horizontal and vertical translation. The elements \fIm11\fR and \fIm22\fR specify horizontal and vertical scaling. The elements \fIm12\fR and \fIm21\fR specify horizontal and vertical shearing. +.PP +The identity matrix has \fIm11\fR and \fIm22\fR set to 1; all others are set to 0. This matrix maps a point to itself. +.PP +Translation is the simplest transformation. Setting \fIdx\fR and \fIdy\fR will move the coordinate system \fIdx\fR units along the X axis and \fIdy\fR units along the Y axis. +.PP +Scaling can be done by setting \fIm11\fR and \fIm22\fR. For example, setting \fIm11\fR to 2 and \fIm22\fR to 1.5 will double the height and increase the width by 50%. +.PP +Shearing is controlled by \fIm12\fR and \fIm21\fR. Setting these elements to values different from zero will twist the coordinate system. +.PP +Rotation is achieved by carefully setting both the shearing factors and the scaling factors. The QWMatrix also has a function that sets rotation directly. +.PP +QWMatrix lets you combine transformations like this: +.PP +.nf +.br + QWMatrix m; // identity matrix +.br + m.translate(10, -20); // first translate (10,-20) +.br + m.rotate(25); // then rotate 25 degrees +.br + m.scale(1.2, 0.7); // finally scale it +.br +.fi +.PP +Here's the same example using basic matrix operations: +.PP +.nf +.br + double a = pi/180 * 25; // convert 25 to radians +.br + double sina = sin(a); +.br + double cosa = cos(a); +.br + QWMatrix m1(1, 0, 0, 1, 10, -20); // translation matrix +.br + QWMatrix m2( cosa, sina, // rotation matrix +.br + -sina, cosa, 0, 0 ); +.br + QWMatrix m3(1.2, 0, 0, 0.7, 0, 0); // scaling matrix +.br + QWMatrix m; +.br + m = m3 * m2 * m1; // combine all transformations +.br +.fi +.PP +QPainter has functions to translate, scale, shear and rotate the coordinate system without using a QWMatrix. Although these functions are very convenient, it can be more efficient to build a QWMatrix and call QPainter::setWorldMatrix() if you want to perform more than a single transform operation. +.PP +See also QPainter::setWorldMatrix(), QPixmap::xForm(), Graphics Classes, and Image Processing Classes. +.SS "Member Type Documentation" +.SH "QWMatrix::TransformationMode" + +.PP +QWMatrix offers two transformation modes. Calculations can either be done in terms of points (Points mode, the default), or in terms of area (Area mode). +.PP +In Points mode the transformation is applied to the points that mark out the shape's bounding line. In Areas mode the transformation is applied in such a way that the area of the contained region is correctly transformed under the matrix. +.TP +\fCQWMatrix::Points\fR - transformations are applied to the shape's points. +.TP +\fCQWMatrix::Areas\fR - transformations are applied (e.g. to the width and height) so that the area is transformed. +.PP +Example: +.PP +Suppose we have a rectangle, \fCQRect( 10, 20, 30, 40 )\fR and a transformation matrix \fCQWMatrix( 2, 0, 0, 2, 0, 0 )\fR to double the rectangle's size. +.PP +In Points mode, the matrix will transform the top-left (10,20) and the bottom-right (39,59) points producing a rectangle with its top-left point at (20,40) and its bottom-right point at (78,118), i.e. with a width of 59 and a height of 79. +.PP +In Areas mode, the matrix will transform the top-left point in the same way as in Points mode to (20/40), and double the width and height, so the bottom-right will become (69,99), i.e. a width of 60 and a height of 80. +.PP +Because integer arithmetic is used (for speed), rounding differences mean that the modes will produce slightly different results given the same shape and the same transformation, especially when scaling up. This also means that some operations are not commutative. +.PP +Under Points mode, \fCmatrix * ( region1 | region2 )\fR is not equal to \fCmatrix * region1 | matrix * region2\fR. Under Area mode, \fCmatrix * (pointarray[i])\fR is not neccesarily equal to \fC(matrix * pointarry)[i]\fR. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWMatrix::QWMatrix ()" +Constructs an identity matrix. All elements are set to zero except \fIm11\fR and \fIm22\fR (scaling), which are set to 1. +.SH "QWMatrix::QWMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" +Constructs a matrix with the elements, \fIm11\fR, \fIm12\fR, \fIm21\fR, \fIm22\fR, \fIdx\fR and \fIdy\fR. +.SH "double QWMatrix::det () const" +Returns the matrix's determinant. +.SH "double QWMatrix::dx () const" +Returns the horizontal translation. +.SH "double QWMatrix::dy () const" +Returns the vertical translation. +.SH "QWMatrix QWMatrix::invert ( bool * invertible = 0 ) const" +Returns the inverted matrix. +.PP +If the matrix is singular (not invertible), the identity matrix is returned. +.PP +If \fIinvertible\fR is not 0: the value of \fI*invertible\fR is set to TRUE if the matrix is invertible; otherwise \fI*invertible\fR is set to FALSE. +.PP +See also isInvertible(). +.PP +Example: t14/cannon.cpp. +.SH "bool QWMatrix::isIdentity () const" +Returns TRUE if the matrix is the identity matrix; otherwise returns FALSE. +.PP +See also reset(). +.SH "bool QWMatrix::isInvertible () const" +Returns TRUE if the matrix is invertible; otherwise returns FALSE. +.PP +See also invert(). +.SH "double QWMatrix::m11 () const" +Returns the X scaling factor. +.SH "double QWMatrix::m12 () const" +Returns the vertical shearing factor. +.SH "double QWMatrix::m21 () const" +Returns the horizontal shearing factor. +.SH "double QWMatrix::m22 () const" +Returns the Y scaling factor. +.SH "void QWMatrix::map ( int x, int y, int * tx, int * ty ) const" +Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the formulae: +.PP +.nf +.br + *tx = m11*x + m21*y + dx (rounded to the nearest integer) +.br + *ty = m22*y + m12*x + dy (rounded to the nearest integer) +.br +.fi +.PP +Examples: +.)l t14/cannon.cpp and xform/xform.cpp. +.SH "void QWMatrix::map ( double x, double y, double * tx, double * ty ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the following formulae: +.PP +.nf +.br + *tx = m11*x + m21*y + dx +.br + *ty = m22*y + m12*x + dy +.br +.fi +.SH "QPoint QWMatrix::map ( const QPoint & p ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Transforms \fIp\fR to using the formulae: +.PP +.nf +.br + retx = m11*px + m21*py + dx (rounded to the nearest integer) +.br + rety = m22*py + m12*px + dy (rounded to the nearest integer) +.br +.fi +.SH "QRect QWMatrix::map ( const QRect & r ) const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Please use QWMatrix::mapRect() instead. +.PP +Note that this method does return the bounding rectangle of the \fIr\fR, when shearing or rotations are used. +.SH "QPointArray QWMatrix::map ( const QPointArray & a ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns the point array \fIa\fR transformed by calling map for each point. +.SH "QRegion QWMatrix::map ( const QRegion & r ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Transforms the region \fIr\fR. +.PP +Calling this method can be rather expensive, if rotations or shearing are used. +.SH "QRect QWMatrix::mapRect ( const QRect & rect ) const" +Returns the transformed rectangle \fIrect\fR. +.PP +The bounding rectangle is returned if rotation or shearing has been specified. +.PP +If you need to know the exact region \fIrect\fR maps to use operator*(). +.PP +See also operator*(). +.PP +Example: xform/xform.cpp. +.SH "QPointArray QWMatrix::mapToPolygon ( const QRect & rect ) const" +Returns the transformed rectangle \fIrect\fR as a polygon. +.PP +Polygons and rectangles behave slightly differently when transformed (due to integer rounding), so \fCmatrix.map( QPointArray( rect ) )\fR is not always the same as \fCmatrix.mapToPolygon( rect )\fR. +.SH "QRegion QWMatrix::mapToRegion ( const QRect & rect ) const" +Returns the transformed rectangle \fIrect\fR. +.PP +A rectangle which has been rotated or sheared may result in a non-rectangular region being returned. +.PP +Calling this method can be expensive, if rotations or shearing are used. If you just need to know the bounding rectangle of the returned region, use mapRect() which is a lot faster than this function. +.PP +See also QWMatrix::mapRect(). +.SH "bool QWMatrix::operator!= ( const QWMatrix & m ) const" +Returns TRUE if this matrix is not equal to \fIm\fR; otherwise returns FALSE. +.SH "QWMatrix & QWMatrix::operator*= ( const QWMatrix & m )" +Returns the result of multiplying this matrix by matrix \fIm\fR. +.SH "bool QWMatrix::operator== ( const QWMatrix & m ) const" +Returns TRUE if this matrix is equal to \fIm\fR; otherwise returns FALSE. +.SH "void QWMatrix::reset ()" +Resets the matrix to an identity matrix. +.PP +All elements are set to zero, except \fIm11\fR and \fIm22\fR (scaling) which are set to 1. +.PP +See also isIdentity(). +.SH "QWMatrix & QWMatrix::rotate ( double a )" +Rotates the coordinate system \fIa\fR degrees counterclockwise. +.PP +Returns a reference to the matrix. +.PP +See also translate(), scale(), and shear(). +.PP +Examples: +.)l canvas/canvas.cpp, desktop/desktop.cpp, drawdemo/drawdemo.cpp, t14/cannon.cpp, and xform/xform.cpp. +.SH "QWMatrix & QWMatrix::scale ( double sx, double sy )" +Scales the coordinate system unit by \fIsx\fR horizontally and \fIsy\fR vertically. +.PP +Returns a reference to the matrix. +.PP +See also translate(), shear(), and rotate(). +.PP +Examples: +.)l canvas/canvas.cpp, fileiconview/qfileiconview.cpp, movies/main.cpp, qmag/qmag.cpp, showimg/showimg.cpp, and xform/xform.cpp. +.SH "void QWMatrix::setMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" +Sets the matrix elements to the specified values, \fIm11\fR, \fIm12\fR, \fIm21\fR, \fIm22\fR, \fIdx\fR and \fIdy\fR. +.SH "void QWMatrix::setTransformationMode ( QWMatrix::TransformationMode m )\fC [static]\fR" +Sets the transformation mode that QWMatrix and painter transformations use to \fIm\fR. +.PP +See also QWMatrix::TransformationMode. +.SH "QWMatrix & QWMatrix::shear ( double sh, double sv )" +Shears the coordinate system by \fIsh\fR horizontally and \fIsv\fR vertically. +.PP +Returns a reference to the matrix. +.PP +See also translate(), scale(), and rotate(). +.PP +Examples: +.)l drawdemo/drawdemo.cpp and xform/xform.cpp. +.SH "TransformationMode QWMatrix::transformationMode ()\fC [static]\fR" +Returns the current transformation mode. +.PP +See also QWMatrix::TransformationMode. +.SH "QWMatrix & QWMatrix::translate ( double dx, double dy )" +Moves the coordinate system \fIdx\fR along the X-axis and \fIdy\fR along the Y-axis. +.PP +Returns a reference to the matrix. +.PP +See also scale(), shear(), and rotate(). +.PP +Examples: +.)l canvas/canvas.cpp, drawdemo/drawdemo.cpp, t14/cannon.cpp, and xform/xform.cpp. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QDataStream & operator<< ( QDataStream & s, const QWMatrix & m )" +Writes the matrix \fIm\fR to the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. +.SH "QDataStream & operator>> ( QDataStream & s, QWMatrix & m )" +Reads the matrix \fIm\fR from the stream \fIs\fR and returns a reference to the stream. +.PP +See also Format of the QDataStream operators. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqwmatrix.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwmatrix.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqworkspace.3qt b/doc/man/man3/tqworkspace.3qt new file mode 100644 index 000000000..a1afea1f5 --- /dev/null +++ b/doc/man/man3/tqworkspace.3qt @@ -0,0 +1,196 @@ +'\" t +.TH QWorkspace 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 +QWorkspace \- Workspace window that can contain decorated windows, e.g. for MDI +.SH SYNOPSIS +\fC#include <ntqworkspace.h>\fR +.PP +Inherits QWidget. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWorkspace\fR ( QWidget * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QWorkspace\fR ()" +.br +.ti -1c +.BI "enum \fBWindowOrder\fR { CreationOrder, StackingOrder }" +.br +.ti -1c +.BI "QWidget * \fBactiveWindow\fR () const" +.br +.ti -1c +.BI "QWidgetList windowList () const \fI(obsolete)\fR" +.br +.ti -1c +.BI "QWidgetList \fBwindowList\fR ( WindowOrder order ) const" +.br +.ti -1c +.BI "bool \fBscrollBarsEnabled\fR () const" +.br +.ti -1c +.BI "void \fBsetScrollBarsEnabled\fR ( bool enable )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBcascade\fR ()" +.br +.ti -1c +.BI "void \fBtile\fR ()" +.br +.ti -1c +.BI "void \fBcloseActiveWindow\fR ()" +.br +.ti -1c +.BI "void \fBcloseAllWindows\fR ()" +.br +.ti -1c +.BI "void \fBactivateNextWindow\fR ()" +.br +.ti -1c +.BI "void \fBactivatePrevWindow\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBwindowActivated\fR ( QWidget * w )" +.br +.in -1c +.SS "Properties" +.in +1c +.ti -1c +.BI "bool \fBscrollBarsEnabled\fR - whether the workspace provides scrollbars" +.br +.in -1c +.SH DESCRIPTION +The QWorkspace widget provides a workspace window that can contain decorated windows, e.g. for MDI. +.PP +MDI (multiple document interface) applications typically have one main window with a menu bar and toolbar, and a central widget that is a QWorkspace. The workspace itself contains zero, one or more document windows, each of which is a widget. +.PP +The workspace itself is an ordinary Qt widget. It has a standard constructor that takes a parent widget and an object name. The parent window is usually a QMainWindow, but it need not be. +.PP +Document windows (i.e. MDI windows) are also ordinary Qt widgets which have the workspace as their parent widget. When you call show(), hide(), showMaximized(), setCaption(), etc. on a document window, it is shown, hidden, etc. with a frame, caption, icon and icon text, just as you'd expect. You can provide widget flags which will be used for the layout of the decoration or the behaviour of the widget itself. +.PP +To change or retrieve the geometry of MDI windows you must operate on the MDI widget's parentWidget(). (The parentWidget() provides access to the decorated window in which the MDI window's widget is shown.) +.PP +A document window becomes active when it gets the keyboard focus. You can also activate a window in code using setFocus(). The user can activate a window by moving focus in the usual ways, for example by clicking a window or by pressing Tab. The workspace emits a signal windowActivated() when it detects the activation change, and the function activeWindow() always returns a pointer to the active document window. +.PP +The convenience function windowList() returns a list of all document windows. This is useful to create a popup menu" <u>W</u>indows" on the fly, for example. +.PP +QWorkspace provides two built-in layout strategies for child windows: cascade() and tile(). Both are slots so you can easily connect menu entries to them. +.PP +If you want your users to be able to work with document windows larger than the actual workspace, set the scrollBarsEnabled property to TRUE. +.PP +If the top-level window contains a menu bar and a document window is maximised, QWorkspace moves the document window's minimize, restore and close buttons from the document window's frame to the workspace window's menu bar. It then inserts a window operations menu at the far left of the menu bar. +.PP +See also Main Window and Related Classes and Organizers. +.SS "Member Type Documentation" +.SH "QWorkspace::WindowOrder" +Specifies the order in which windows are returned from windowList(). +.TP +\fCQWorkspace::CreationOrder\fR - The windows are returned in the order of their creation +.TP +\fCQWorkspace::StackingOrder\fR - The windows are returned in the order of their stacking +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWorkspace::QWorkspace ( QWidget * parent = 0, const char * name = 0 )" +Constructs a workspace with a \fIparent\fR and a \fIname\fR. +.SH "QWorkspace::~QWorkspace ()" +Destroys the workspace and frees any allocated resources. +.SH "void QWorkspace::activateNextWindow ()\fC [slot]\fR" +Activates the next window in the child window chain. +.PP +See also activatePrevWindow(). +.SH "void QWorkspace::activatePrevWindow ()\fC [slot]\fR" +Activates the previous window in the child window chain. +.PP +See also activateNextWindow(). +.SH "QWidget * QWorkspace::activeWindow () const" +Returns the active window, or 0 if no window is active. +.PP +Example: mdi/application.cpp. +.SH "void QWorkspace::cascade ()\fC [slot]\fR" +Arranges all the child windows in a cascade pattern. +.PP +See also tile(). +.PP +Example: mdi/application.cpp. +.SH "void QWorkspace::closeActiveWindow ()\fC [slot]\fR" +Closes the child window that is currently active. +.PP +See also closeAllWindows(). +.SH "void QWorkspace::closeAllWindows ()\fC [slot]\fR" +Closes all child windows. +.PP +The windows are closed in random order. The operation stops if a window does not accept the close event. +.PP +See also closeActiveWindow(). +.SH "bool QWorkspace::scrollBarsEnabled () const" +Returns TRUE if the workspace provides scrollbars; otherwise returns FALSE. See the "scrollBarsEnabled" property for details. +.SH "void QWorkspace::setScrollBarsEnabled ( bool enable )" +Sets whether the workspace provides scrollbars to \fIenable\fR. See the "scrollBarsEnabled" property for details. +.SH "void QWorkspace::tile ()\fC [slot]\fR" +Arranges all child windows in a tile pattern. +.PP +See also cascade(). +.PP +Example: mdi/application.cpp. +.SH "void QWorkspace::windowActivated ( QWidget * w )\fC [signal]\fR" +This signal is emitted when the window widget \fIw\fR becomes active. Note that \fIw\fR can be null, and that more than one signal may be emitted for a single activation event. +.PP +See also activeWindow() and windowList(). +.SH "QWidgetList QWorkspace::windowList ( WindowOrder order ) const" +Returns a list of all windows. If \fIorder\fR is CreationOrder (the default) the windows are listed in the order in which they had been inserted into the workspace. If \fIorder\fR is StackingOrder the windows are listed in their stacking order, with the topmost window being the last window in the list. +.PP +QWidgetList is the same as QPtrList<QWidget>. +.PP +See also QPtrList. +.PP +Example: mdi/application.cpp. +.SH "QWidgetList QWorkspace::windowList () const" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +.SS "Property Documentation" +.SH "bool scrollBarsEnabled" +This property holds whether the workspace provides scrollbars. +.PP +If this property is set to TRUE, it is possible to resize child windows over the right or the bottom edge out of the visible area of the workspace. The workspace shows scrollbars to make it possible for the user to access those windows. If this property is set to FALSE (the default), resizing windows out of the visible area of the workspace is not permitted. +.PP +Set this property's value with setScrollBarsEnabled() and get this property's value with scrollBarsEnabled(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/ntqworkspace.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqworkspace.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwsdecoration.3qt b/doc/man/man3/tqwsdecoration.3qt new file mode 100644 index 000000000..7d485f510 --- /dev/null +++ b/doc/man/man3/tqwsdecoration.3qt @@ -0,0 +1,156 @@ +'\" t +.TH QWSDecoration 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 +QWSDecoration \- Allows the appearance of the Qt/Embedded Window Manager to be customized +.SH SYNOPSIS +\fC#include <qwsdecoration_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWSDecoration\fR ()" +.br +.ti -1c +.BI "virtual \fB~QWSDecoration\fR ()" +.br +.ti -1c +.BI "enum \fBRegion\fR { None = 0, All = 1, Title = 2, Top = 3, Bottom = 4, Left = 5, Right = 6, TopLeft = 7, TopRight = 8, BottomLeft = 9, BottomRight = 10, Close = 11, Minimize = 12, Maximize = 13, Normalize = 14, Menu = 15, LastRegion = Menu }" +.br +.ti -1c +.BI "virtual QRegion \fBregion\fR ( const QWidget * widget, const QRect & rect, Region type = All ) = 0" +.br +.ti -1c +.BI "virtual void \fBclose\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual void \fBminimize\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual void \fBmaximize\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual QPopupMenu * \fBmenu\fR ( const QWidget *, const QPoint & )" +.br +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * painter, const QWidget * widget ) = 0" +.br +.ti -1c +.BI "virtual void \fBpaintButton\fR ( QPainter * painter, const QWidget * widget, Region type, int state ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QWSDecoration class allows the appearance of the Qt/Embedded Window Manager to be customized. +.PP +Qt/Embedded provides window management to top level windows. The appearance of the borders and buttons (the decoration) around the managed windows can be customized by creating your own class derived from QWSDecoration and overriding a few methods. +.PP +This class is non-portable. It is available \fIonly\fR in Qt/Embedded. +.PP +See also QApplication::qwsSetDecoration() and Qt/Embedded. +.SS "Member Type Documentation" +.SH "QWSDecoration::Region" +This enum describes the regions in the window decorations. +.TP +\fCQWSDecoration::None\fR - used internally. +.TP +\fCQWSDecoration::All\fR - the entire region used by the window decoration. +.TP +\fCQWSDecoration::Title\fR - Displays the window title and allows the window to be moved by dragging. +.TP +\fCQWSDecoration::Top\fR - allows the top of the window to be resized. +.TP +\fCQWSDecoration::Bottom\fR - allows the bottom of the window to be resized. +.TP +\fCQWSDecoration::Left\fR - allows the left edge of the window to be resized. +.TP +\fCQWSDecoration::Right\fR - allows the right edge of the window to be resized. +.TP +\fCQWSDecoration::TopLeft\fR - allows the top-left of the window to be resized. +.TP +\fCQWSDecoration::TopRight\fR - allows the top-right of the window to be resized. +.TP +\fCQWSDecoration::BottomLeft\fR - allows the bottom-left of the window to be resized. +.TP +\fCQWSDecoration::BottomRight\fR - allows the bottom-right of the window to be resized. +.TP +\fCQWSDecoration::Close\fR - clicking in this region closes the window. +.TP +\fCQWSDecoration::Minimize\fR - clicking in this region minimizes the window. +.TP +\fCQWSDecoration::Maximize\fR - clicking in this region maximizes the window. +.TP +\fCQWSDecoration::Normalize\fR - returns a maximized window to its previous size. +.TP +\fCQWSDecoration::Menu\fR - clicking in this region opens the window operations (system) menu. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSDecoration::QWSDecoration ()" +Constructs a decorator. +.SH "QWSDecoration::~QWSDecoration ()\fC [virtual]\fR" +Destroys a decorator. +.SH "void QWSDecoration::close ( QWidget * widget )\fC [virtual]\fR" +Called when the user clicks in the Close region. +.PP +\fIwidget\fR is the widget to be closed. +.PP +The default behaviour is to close the widget. +.SH "void QWSDecoration::maximize ( QWidget * widget )\fC [virtual]\fR" +Called when the user clicks in the Maximize region. +.PP +\fIwidget\fR is the widget to be maximized. +.PP +The default behaviour is to resize the widget to be full-screen. This method can be overridden e.g. to allow room for launch panels. +.SH "QPopupMenu * QWSDecoration::menu ( const QWidget *, const QPoint & )\fC [virtual]\fR" +Called to create a QPopupMenu containing the valid menu operations. +.PP +The default implementation adds all possible window operations. +.SH "void QWSDecoration::minimize ( QWidget * widget )\fC [virtual]\fR" +Called when the user clicks in the Minimize region. +.PP +\fIwidget\fR is the widget to be minimized. +.PP +The default behaviour is to ignore this action. +.SH "void QWSDecoration::paint ( QPainter * painter, const QWidget * widget )\fC [pure virtual]\fR" +Override to paint the border and title decoration around \fIwidget\fR using \fIpainter\fR. +.SH "void QWSDecoration::paintButton ( QPainter * painter, const QWidget * widget, Region type, int state )\fC [pure virtual]\fR" +Override to paint a button of type \fItype\fR using \fIpainter\fR. +.PP +\fIwidget\fR is the widget whose button is to be drawn. \fIstate\fR is the state of the button. It can be a combination of the following OR-ed together: +.TP +\fCQWSButton::MouseOver\fR +.TP +\fCQWSButton::Clicked\fR +.TP +\fCQWSButton::On\fR +.SH "QRegion QWSDecoration::region ( const QWidget * widget, const QRect & rect, Region type = All )\fC [pure virtual]\fR" +Returns the requested region \fItype\fR which will contain \fIwidget\fR +with geometry \fIrect\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwsdecoration.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwsdecoration.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwsinputmethod.3qt b/doc/man/man3/tqwsinputmethod.3qt new file mode 100644 index 000000000..418a3fdd6 --- /dev/null +++ b/doc/man/man3/tqwsinputmethod.3qt @@ -0,0 +1,105 @@ +'\" t +.TH QWSInputMethod 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 +QWSInputMethod \- International input methods for Qt/Embedded +.SH SYNOPSIS +\fC#include <qwindowsystem_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWSInputMethod\fR ()" +.br +.ti -1c +.BI "virtual \fB~QWSInputMethod\fR ()" +.br +.ti -1c +.BI "virtual bool \fBfilter\fR ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat ) = 0" +.br +.ti -1c +.BI "virtual void \fBreset\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetMicroFocus\fR ( int x, int y )" +.br +.ti -1c +.BI "virtual void \fBsetFont\fR ( const QFont & )" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "void \fBsendIMEvent\fR ( QWSServer::IMState state, const QString & txt, int cpos, int selLen = 0 )" +.br +.in -1c +.SH DESCRIPTION +The QWSInputMethod class provides international input methods for Qt/Embedded. +.PP +Subclass this class to implement your own input method. +.PP +An input methods consists of a keyboard filter and optionally a graphical interface. The keyboard filter intercepts key events from physical or virtual keyboards by implementing the filter() function. +.PP +Use sendIMEvent() to send composition events. Composition starts with the input method sending an \fCIMStart\fR event, followed by a number of \fCIMCompose\fR events and ending with an \fCIMEnd\fR event or when the virtual reset() function is called. +.PP +The functions setMicroFocus() and setFont() can be reimplemented to receive more information about the state of the focus widget. +.PP +Use QWSServer::setCurrentInputMethod() to install an input method. +.PP +See also Qt/Embedded. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSInputMethod::QWSInputMethod ()" +Constructs a new input method +.SH "QWSInputMethod::~QWSInputMethod ()\fC [virtual]\fR" +Destructs the input method uninstalling it if it is currently installed. +.SH "bool QWSInputMethod::filter ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )\fC [pure virtual]\fR" +This function must be implemented in subclasses to handle key input from physical or virtual keyboards. Returning TRUE will block the event from further processing. +.PP +The Unicode value is given in \fIunicode\fR and the key code in \fIkeycode\fR. Keyboard modifiers are OR-ed together in \fImodifiers\fR. If \fIisPress\fR is TRUE this is a key press; otherwise it is a key release. If \fIautoRepeat\fR is TRUE this is an auto-repeated key press. +.PP +All normal key events should be blocked while in compose mode (i.e., between \fCIMStart\fR and \fCIMEnd\fR). +.SH "void QWSInputMethod::reset ()\fC [virtual]\fR" +Implemented in subclasses to reset the state of the input method. +.SH "void QWSInputMethod::sendIMEvent ( QWSServer::IMState state, const QString & txt, int cpos, int selLen = 0 )\fC [protected]\fR" +Causes a QIMEvent to be sent to the focus widget. \fIstate\fR may be one of QWSServer::IMStart, QWSServer::IMCompose or QWSServer::IMEnd. +.PP +\fItxt\fR is the text being composed (or the finished text if state is \fCIMEnd\fR). \fIcpos\fR is the current cursor position. +.PP +If state is \fCIMCompose\fR, \fIselLen\fR is the number of characters in the composition string (starting at \fIcpos\fR) that should be marked as selected by the input widget receiving the event. +.SH "void QWSInputMethod::setFont ( const QFont & )\fC [virtual]\fR" +Implemented in subclasses to handle font changes in the focus widget. +.PP +This functionality is provided for future expansion; it is not used in this version of Qt/Embedded. +.SH "void QWSInputMethod::setMicroFocus ( int x, int y )\fC [virtual]\fR" +Implemented in subclasses to handle microFocusHint changes in the focus widget. \fIx\fR and \fIy\fR are the global coordinates of the text cursor. +.PP + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwsinputmethod.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwsinputmethod.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwskeyboardhandler.3qt b/doc/man/man3/tqwskeyboardhandler.3qt new file mode 100644 index 000000000..6b238d133 --- /dev/null +++ b/doc/man/man3/tqwskeyboardhandler.3qt @@ -0,0 +1,77 @@ +'\" t +.TH QWSKeyboardHandler 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 +QWSKeyboardHandler \- Implements the keyboard driver for Qt/Embedded +.SH SYNOPSIS +\fC#include <qkeyboard_qws.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWSKeyboardHandler\fR ()" +.br +.ti -1c +.BI "virtual \fB~QWSKeyboardHandler\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual void \fBprocessKeyEvent\fR ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )" +.br +.in -1c +.SH DESCRIPTION +The QWSKeyboardHandler class implements the keyboard driver for Qt/Embedded. +.PP +The keyboard driver handles events from system devices and generates key events. +.PP +A QWSKeyboardHandler will usually open some system device in its constructor, create a QSocketNotifier on that opened device and when it receives data, it will call processKeyEvent() to send the event to Qt/Embedded for relaying to clients. +.PP +See also Qt/Embedded. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSKeyboardHandler::QWSKeyboardHandler ()" +Constructs a keyboard handler. The handler \fImay\fR be passed to the system for later destruction with QWSServer::setKeyboardHandler(), although even without doing this, the handler can function, calling processKeyEvent() to emit events. +.SH "QWSKeyboardHandler::~QWSKeyboardHandler ()\fC [virtual]\fR" +Destroys a keyboard handler. Note that if you have called QWSServer::setKeyboardHandler(), you must not delete the handler. +.SH "void QWSKeyboardHandler::processKeyEvent ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )\fC [virtual protected]\fR" +Subclasses call this function to send a key event. The server may additionally filter the event before sending it on to applications. +.PP +<center>.nf +.TS +l - l. Parameter Meaning \fIunicode\fR The Unicode value for the key, or 0xFFFF is none is appropriate. \fIkeycode\fR The Qt keycode for the key (see Qt::Key for the list of codes). \fImodifiers\fR The set of modifier keys (see Qt::Modifier). \fIisPress\fR Whether this is a press or a release. \fIautoRepeat\fR +.TE +.fi +</center> + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwskeyboardhandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwskeyboardhandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwsmousehandler.3qt b/doc/man/man3/tqwsmousehandler.3qt new file mode 100644 index 000000000..64fef6ed6 --- /dev/null +++ b/doc/man/man3/tqwsmousehandler.3qt @@ -0,0 +1,89 @@ +'\" t +.TH QWSMouseHandler 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 +QWSMouseHandler \- Mouse driver for Qt/Embedded +.SH SYNOPSIS +\fC#include <qmouse_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWSMouseHandler\fR ( const QString & driver = QString::null, const QString & device = QString::null )" +.br +.ti -1c +.BI "virtual \fB~QWSMouseHandler\fR ()" +.br +.ti -1c +.BI "virtual void \fBclearCalibration\fR ()" +.br +.ti -1c +.BI "virtual void \fBcalibrate\fR ( QWSPointerCalibrationData * )" +.br +.ti -1c +.BI "void \fBlimitToScreen\fR ( QPoint & pt )" +.br +.ti -1c +.BI "void \fBmouseChanged\fR ( const QPoint & pos, int bstate )" +.br +.ti -1c +.BI "const QPoint & \fBpos\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QWSMouseHandler class is a mouse driver for Qt/Embedded. +.PP +The mouse driver handles events from system devices and generates mouse events. +.PP +A QWSMouseHandler will usually open some system device in its constructor, create a QSocketNotifier on that opened device and when it receives data, it will call mouseChanged() to send the event to Qt/Embedded for relaying to clients. +.PP +See also Qt/Embedded. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSMouseHandler::QWSMouseHandler ( const QString & driver = QString::null, const QString & device = QString::null )" +Constructs a mouse handler. This becomes the primary mouse handler. +.PP +Note that once created, mouse handlers are controlled by the system and should not be deleted. +.PP +The \fIdriver\fR and \fIdevice\fR arguments are not used by this base class. +.SH "QWSMouseHandler::~QWSMouseHandler ()\fC [virtual]\fR" +Destroys the mouse handler. You should not call this directly. +.SH "void QWSMouseHandler::calibrate ( QWSPointerCalibrationData * )\fC [virtual]\fR" +This method is reimplemented in the calibrated mouse handler to set calibration information (from, for instance, the Qtopia calibration screen). This version does nothing. +.SH "void QWSMouseHandler::clearCalibration ()\fC [virtual]\fR" +This method is reimplemented in the calibrated mouse handler to clear calibration information. This version does nothing. +.SH "void QWSMouseHandler::limitToScreen ( QPoint & pt )" +Ensures that the given point, \fIpt\fR is within the screen's boundaries, changing \fIpt\fR if necessary. +.SH "void QWSMouseHandler::mouseChanged ( const QPoint & pos, int bstate )" +When a mouse event occurs this function is called with the mouse's position in \fIpos\fR, and the state of its buttons in \fIbstate\fR. +.SH "const QPoint & QWSMouseHandler::pos () const" +Returns the mouse position. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwsmousehandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwsmousehandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwsserver.3qt b/doc/man/man3/tqwsserver.3qt new file mode 100644 index 000000000..5747df299 --- /dev/null +++ b/doc/man/man3/tqwsserver.3qt @@ -0,0 +1,311 @@ +'\" t +.TH QWSServer 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 +QWSServer \- Server-specific functionality in Qt/Embedded +.SH SYNOPSIS +\fC#include <qwindowsystem_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWSServer\fR ( int flags = 0, QObject * parent = 0, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QWSServer\fR ()" +.br +.ti -1c +.BI "enum \fBServerFlags\fR { DisableKeyboard = 0x01, DisableMouse = 0x02 }" +.br +.ti -1c +.BI "enum \fBGUIMode\fR { NoGui = FALSE, NormalGUI = TRUE, Server }" +.br +.ti -1c +.BI "void \fBsendIMEvent\fR ( IMState state, const QString & txt, int cpos, int selLen )" +.br +.ti -1c +.BI "class \fBKeyMap\fR { }" +.br +.ti -1c +.BI "class \fBKeyOverride\fR { }" +.br +.ti -1c +.BI "class \fBKeyboardFilter\fR { }" +.br +.ti -1c +.BI "QWSWindow * \fBwindowAt\fR ( const QPoint & pos )" +.br +.ti -1c +.BI "const QPtrList<QWSWindow> & \fBclientWindows\fR ()" +.br +.ti -1c +.BI "void \fBopenMouse\fR ()" +.br +.ti -1c +.BI "void \fBcloseMouse\fR ()" +.br +.ti -1c +.BI "void \fBopenKeyboard\fR ()" +.br +.ti -1c +.BI "void \fBcloseKeyboard\fR ()" +.br +.ti -1c +.BI "void \fBrefresh\fR ()" +.br +.ti -1c +.BI "void \fBrefresh\fR ( QRegion & r )" +.br +.ti -1c +.BI "void \fBenablePainting\fR ( bool e )" +.br +.ti -1c +.BI "QWSPropertyManager * \fBmanager\fR ()" +.br +.ti -1c +.BI "enum \fBWindowEvent\fR { Create = 0x0001, Destroy = 0x0002, Hide = 0x0004, Show = 0x0008, Raise = 0x0010, Lower = 0x0020, Geometry = 0x0040, Active = 0x0080, Name = 0x0100 }" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBwindowEvent\fR ( QWSWindow * w, QWSServer::WindowEvent e )" +.br +.ti -1c +.BI "void \fBnewChannel\fR ( const QString & channel )" +.br +.ti -1c +.BI "void \fBremovedChannel\fR ( const QString & channel )" +.br +.in -1c +.SS "Static Public Members" +.in +1c +.ti -1c +.BI "void \fBsendKeyEvent\fR ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )" +.br +.ti -1c +.BI "const KeyMap * \fBkeyMap\fR ()" +.br +.ti -1c +.BI "void \fBsetOverrideKeys\fR ( const KeyOverride * )" +.br +.ti -1c +.BI "void \fBsetKeyboardFilter\fR ( KeyboardFilter * f )" +.br +.ti -1c +.BI "void \fBsetDefaultMouse\fR ( const char * m )" +.br +.ti -1c +.BI "void \fBsetDefaultKeyboard\fR ( const char * k )" +.br +.ti -1c +.BI "void \fBsetMaxWindowRect\fR ( const QRect & r )" +.br +.ti -1c +.BI "void \fBsetDesktopBackground\fR ( const QImage & img )" +.br +.ti -1c +.BI "void \fBsetDesktopBackground\fR ( const QColor & c )" +.br +.ti -1c +.BI "QWSMouseHandler * \fBmouseHandler\fR ()" +.br +.ti -1c +.BI "QWSKeyboardHandler * \fBkeyboardHandler\fR ()" +.br +.ti -1c +.BI "void \fBsetKeyboardHandler\fR ( QWSKeyboardHandler * kh )" +.br +.ti -1c +.BI "void \fBsetScreenSaverIntervals\fR ( int * ms )" +.br +.ti -1c +.BI "void \fBsetScreenSaverInterval\fR ( int ms )" +.br +.ti -1c +.BI "bool \fBscreenSaverActive\fR ()" +.br +.ti -1c +.BI "void \fBscreenSaverActivate\fR ( bool activate )" +.br +.ti -1c +.BI "void \fBsetCursorVisible\fR ( bool vis )" +.br +.ti -1c +.BI "bool \fBisCursorVisible\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWSServer class provides server-specific functionality in Qt/Embedded. +.PP +When you run a Qt/Embedded application, it either runs as a server or connects to an existing server. If it runs as a server, some additional operations are provided by this class. +.PP +This class is instantiated by QApplication for Qt/Embedded server processes. You should never construct this class yourself. +.PP +A pointer to the QWSServer instance can be obtained via the global \fCqwsServer\fR variable. +.PP +The mouse and keyboard devices can be opened with openMouse() and openKeyboard(). (Close them with closeMouse() and closeKeyboard().) +.PP +The display is refreshed with refresh(), and painting can be enabled or disabled with enablePainting(). +.PP +Obtain the list of client windows with clientWindows() and find out which window is at a particular point with windowAt(). +.PP +Many static functions are provided, for example, setKeyboardFilter(), setKeyboardHandler(), setDefaultKeyboard() and setDefaultMouse(). +.PP +The size of the window rectangle can be set with setMaxWindowRect(), and the desktop's background can be set with setDesktopBackground(). +.PP +The screen saver is controlled with setScreenSaverInterval() and screenSaverActivate(). +.PP +See also Qt/Embedded. +.SS "Member Type Documentation" +.SH "QWSServer::GUIMode" +This determines what sort of QWS server to create: +.TP +\fCQWSServer::NoGui\fR - This is used for non-graphical Qt applications. +.TP +\fCQWSServer::NormalGUI\fR - A normal Qt/Embedded application (not the server). +.TP +\fCQWSServer::Server\fR - A Qt/Embedded server (e.g. if \fC-qws\fR has been specified on the command line. +.SH "QWSServer::ServerFlags" +This enum is used to pass various options to the window system server. +.TP +\fCQWSServer::DisableKeyboard\fR - Ignore all keyboard input. +.TP +\fCQWSServer::DisableMouse\fR - Ignore all mouse input. +.SH "QWSServer::WindowEvent" +This specifies what sort of event has occurred to a top-level window: +.TP +\fCQWSServer::Create\fR - A new window has been created (QWidget constructor). +.TP +\fCQWSServer::Destroy\fR - The window has been closed and deleted (QWidget destructor). +.TP +\fCQWSServer::Hide\fR - The window has been hidden with QWidget::hide(). +.TP +\fCQWSServer::Show\fR - The window has been shown with QWidget::show() or similar. +.TP +\fCQWSServer::Raise\fR - The window has been raised to the top of the desktop. +.TP +\fCQWSServer::Lower\fR - The window has been lowered. +.TP +\fCQWSServer::Geometry\fR - The window has changed size or position. +.TP +\fCQWSServer::Active\fR - The window has become the active window (has keyboard focus). +.TP +\fCQWSServer::Name\fR - The window has been named. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSServer::QWSServer ( int flags = 0, QObject * parent = 0, const char * name = 0 )" +Construct a QWSServer object. +.PP +\fBWarning:\fR This class is instantiated by QApplication for Qt/Embedded server processes. You should never construct this class yourself. +.PP +The \fIflags\fR are used for keyboard and mouse setting. The server's parent is \fIparent\fR and it is called \fIname\fR. +.SH "QWSServer::~QWSServer ()" +Destruct QWSServer +.SH "const QPtrList<QWSWindow> & QWSServer::clientWindows ()" +Returns the list of top-level windows. This list will change as applications add and remove wigdets so it should not be stored for future use. The windows are sorted in stacking order from top-most to bottom-most. +.SH "void QWSServer::closeKeyboard ()" +Closes keyboard device(s). +.SH "void QWSServer::closeMouse ()" +Closes the pointer device(s). +.SH "void QWSServer::enablePainting ( bool e )" +If \fIe\fR is TRUE, painting on the display is enabled; if \fIe\fR is FALSE, painting is disabled. +.SH "bool QWSServer::isCursorVisible ()\fC [static]\fR" +Returns TRUE if the cursor is visible; otherwise returns FALSE. +.PP +See also setCursorVisible(). +.SH "const KeyMap * QWSServer::keyMap ()\fC [static]\fR" +Returns the keyboard mapping table used to convert keyboard scancodes to Qt keycodes and Unicode values. It's used by the keyboard driver in \fCqkeyboard_qws.cpp\fR. +.SH "QWSKeyboardHandler * QWSServer::keyboardHandler ()\fC [static]\fR" +Returns the primary keyboard handler. +.SH "QWSPropertyManager * QWSServer::manager ()" +Returns the QWSPropertyManager, which is used for implementing X11-style window properties. +.SH "QWSMouseHandler * QWSServer::mouseHandler ()\fC [static]\fR" +Returns the primary mouse handler. +.SH "void QWSServer::newChannel ( const QString & channel )\fC [signal]\fR" +This signal is emitted when the QCopChannel \fIchannel\fR is created. +.SH "void QWSServer::openKeyboard ()" +Opens the keyboard device(s). +.SH "void QWSServer::openMouse ()" +Opens the mouse device(s). +.SH "void QWSServer::refresh ()" +Refreshes the entire display. +.SH "void QWSServer::refresh ( QRegion & r )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Refreshes the region \fIr\fR. +.SH "void QWSServer::removedChannel ( const QString & channel )\fC [signal]\fR" +This signal is emitted immediately after the QCopChannel \fIchannel\fR is destroyed. Note that a channel is not destroyed until all its listeners have unregistered. +.SH "void QWSServer::screenSaverActivate ( bool activate )\fC [static]\fR" +If \fIactivate\fR is TRUE the screensaver is activated immediately; if \fIactivate\fR is FALSE the screensaver is deactivated. +.SH "bool QWSServer::screenSaverActive ()\fC [static]\fR" +Returns TRUE if the screensaver is active (i.e. the screen is blanked); otherwise returns FALSE. +.SH "void QWSServer::sendIMEvent ( IMState state, const QString & txt, int cpos, int selLen )" +This function sends an input method event to the server. The current state is passed in \fIstate\fR and the current text in \fItxt\fR. The cursor's position in the text is given by \fIcpos\fR, and the selection length (which could be 0) is given in \fIselLen\fR. +.SH "void QWSServer::sendKeyEvent ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )\fC [static]\fR" +Send a key event. You can use this to send key events generated by" virtual keyboards". \fIunicode\fR is the Unicode value of the key to send, \fIkeycode\fR the Qt keycode (e.g. \fCKey_Left\fR), \fImodifiers\fR indicates whether, Shift/Alt/Ctrl keys are pressed, \fIisPress\fR is TRUE if this is a key down event and FALSE if it's a key up event, and \fIautoRepeat\fR is TRUE if this is an autorepeat event (i.e. the user has held the key down and this is the second or subsequent key event being sent). +.SH "void QWSServer::setCursorVisible ( bool vis )\fC [static]\fR" +If \fIvis\fR is TRUE, makes the cursor visible; if \fIvis\fR is FALSE, makes the cursor invisible. +.PP +See also isCursorVisible(). +.SH "void QWSServer::setDefaultKeyboard ( const char * k )\fC [static]\fR" +Set the keyboard driver to \fIk\fR, e.g. if \fC$QWS_KEYBOARD\fR is not defined. The default is platform-dependent. +.SH "void QWSServer::setDefaultMouse ( const char * m )\fC [static]\fR" +Set the mouse driver \fIm\fR to use if \fC$QWS_MOUSE_PROTO\fR is not defined. The default is platform-dependent. +.SH "void QWSServer::setDesktopBackground ( const QImage & img )\fC [static]\fR" +Sets the image \fIimg\fR to be used as the background in the absence of obscuring windows. +.SH "void QWSServer::setDesktopBackground ( const QColor & c )\fC [static]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Sets the color \fIc\fR to be used as the background in the absence of obscuring windows. +.SH "void QWSServer::setKeyboardFilter ( KeyboardFilter * f )\fC [static]\fR" +Adds a filter \fIf\fR to be invoked for all key events from physical keyboard drivers (events sent via processKeyEvent()). +.PP +The filter is not invoked for keys generated by virtual keyboard drivers (events sent via sendKeyEvent()). +.PP +If \fIf\fR is 0, the most-recently added filter is removed and deleted. The caller is responsible for matching each addition with a corresponding removal. +.SH "void QWSServer::setKeyboardHandler ( QWSKeyboardHandler * kh )\fC [static]\fR" +Sets the primary keyboard handler to \fIkh\fR. +.SH "void QWSServer::setMaxWindowRect ( const QRect & r )\fC [static]\fR" +Sets the area of the screen which Qt/Embedded applications will consider to be the maximum area to use for windows to \fIr\fR. +.PP +See also QWidget::showMaximized(). +.SH "void QWSServer::setScreenSaverInterval ( int ms )\fC [static]\fR" +Sets the timeout for the screensaver to \fIms\fR milliseconds. A setting of zero turns off the screensaver. +.SH "void QWSServer::setScreenSaverIntervals ( int * ms )\fC [static]\fR" +Sets an array of timeouts for the screensaver to a list of \fIms\fR milliseconds. A setting of zero turns off the screensaver. The array must be 0-terminated. +.SH "QWSWindow * QWSServer::windowAt ( const QPoint & pos )" +Returns the window containing the point \fIpos\fR or 0 if there is no window under the point. +.SH "void QWSServer::windowEvent ( QWSWindow * w, QWSServer::WindowEvent e )\fC [signal]\fR" +This signal is emitted whenever something happens to a top-level +window (e.g. it's created or destroyed). \fIw\fR is the window to +which the event of type \fIe\fR has occurred. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwsserver.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwsserver.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqwswindow.3qt b/doc/man/man3/tqwswindow.3qt new file mode 100644 index 000000000..886329d63 --- /dev/null +++ b/doc/man/man3/tqwswindow.3qt @@ -0,0 +1,140 @@ +'\" t +.TH QWSWindow 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 +QWSWindow \- Server-specific functionality in Qt/Embedded +.SH SYNOPSIS +\fC#include <qwindowsystem_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWSWindow\fR ( int i, QWSClient * client )" +.br +.ti -1c +.BI "\fB~QWSWindow\fR ()" +.br +.ti -1c +.BI "int \fBwinId\fR () const" +.br +.ti -1c +.BI "const QString & \fBname\fR () const" +.br +.ti -1c +.BI "const QString & \fBcaption\fR () const" +.br +.ti -1c +.BI "QWSClient * \fBclient\fR () const" +.br +.ti -1c +.BI "QRegion \fBrequested\fR () const" +.br +.ti -1c +.BI "QRegion \fBallocation\fR () const" +.br +.ti -1c +.BI "bool \fBisVisible\fR () const" +.br +.ti -1c +.BI "bool \fBisPartiallyObscured\fR () const" +.br +.ti -1c +.BI "bool \fBisFullyObscured\fR () const" +.br +.ti -1c +.BI "void \fBraise\fR ()" +.br +.ti -1c +.BI "void \fBlower\fR ()" +.br +.ti -1c +.BI "void \fBshow\fR ()" +.br +.ti -1c +.BI "void \fBhide\fR ()" +.br +.ti -1c +.BI "void \fBsetActiveWindow\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QWSWindow class provides server-specific functionality in Qt/Embedded. +.PP +When you run a Qt/Embedded application, it either runs as a server or connects to an existing server. If it runs as a server, some additional functionality is provided by the QWSServer class. +.PP +This class maintains information about each window and allows operations to be performed on the windows. +.PP +You can get the window's name(), caption() and winId(), along with the client() that owns the window. +.PP +The region the window wants to draw on is returned by requested(); the region that the window is allowed to draw on is returned by allocation(). +.PP +The visibility of the window can be determined using isVisible(), isPartiallyObscured() and isFullyObscured(). Visibility can be changed using raise(), lower(), show(), hide() and setActiveWindow(). +.PP +See also Qt/Embedded. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSWindow::QWSWindow ( int i, QWSClient * client )" +Constructs a new top-level window, associated with the client \fIclient\fR and giving it the id \fIi\fR. +.SH "QWSWindow::~QWSWindow ()" +Destructor. +.SH "QRegion QWSWindow::allocation () const" +Returns the region that the window is allowed to draw onto, including any window decorations but excluding regions covered by other windows. +.PP +See also requested(). +.SH "const QString & QWSWindow::caption () const" +Returns the window's caption. +.SH "QWSClient * QWSWindow::client () const" +Returns the QWSClient that owns this window. +.SH "void QWSWindow::hide ()" +Hides the window. +.SH "bool QWSWindow::isFullyObscured () const" +Returns TRUE if the window is completely obsured by another window or by the bounds of the screen; otherwise returns FALSE. +.SH "bool QWSWindow::isPartiallyObscured () const" +Returns TRUE if the window is partially obsured by another window or by the bounds of the screen; otherwise returns FALSE. +.SH "bool QWSWindow::isVisible () const" +Returns TRUE if the window is visible; otherwise returns FALSE. +.SH "void QWSWindow::lower ()" +Lowers the window below other windows. +.SH "const QString & QWSWindow::name () const" +Returns the window's name. +.SH "void QWSWindow::raise ()" +Raises the window above all other windows except "Stay on top" windows. +.SH "QRegion QWSWindow::requested () const" +Returns the region that the window has requested to draw onto, including any window decorations. +.PP +See also allocation(). +.SH "void QWSWindow::setActiveWindow ()" +Make this the active window (i.e. sets the keyboard focus to this window). +.SH "void QWSWindow::show ()" +Shows the window. +.SH "int QWSWindow::winId () const" +Returns the window's Id. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwswindow.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqwswindow.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlattributes.3qt b/doc/man/man3/tqxmlattributes.3qt new file mode 100644 index 000000000..8620ead3d --- /dev/null +++ b/doc/man/man3/tqxmlattributes.3qt @@ -0,0 +1,189 @@ +'\" t +.TH QXmlAttributes 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 +QXmlAttributes \- XML attributes +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQXmlAttributes\fR ()" +.br +.ti -1c +.BI "virtual \fB~QXmlAttributes\fR ()" +.br +.ti -1c +.BI "int \fBindex\fR ( const QString & qName ) const" +.br +.ti -1c +.BI "int \fBindex\fR ( const QString & uri, const QString & localPart ) const" +.br +.ti -1c +.BI "int \fBlength\fR () const" +.br +.ti -1c +.BI "int \fBcount\fR () const" +.br +.ti -1c +.BI "QString \fBlocalName\fR ( int index ) const" +.br +.ti -1c +.BI "QString \fBqName\fR ( int index ) const" +.br +.ti -1c +.BI "QString \fBuri\fR ( int index ) const" +.br +.ti -1c +.BI "QString \fBtype\fR ( int index ) const" +.br +.ti -1c +.BI "QString \fBtype\fR ( const QString & qName ) const" +.br +.ti -1c +.BI "QString \fBtype\fR ( const QString & uri, const QString & localName ) const" +.br +.ti -1c +.BI "QString \fBvalue\fR ( int index ) const" +.br +.ti -1c +.BI "QString \fBvalue\fR ( const QString & qName ) const" +.br +.ti -1c +.BI "QString \fBvalue\fR ( const QString & uri, const QString & localName ) const" +.br +.ti -1c +.BI "void \fBclear\fR ()" +.br +.ti -1c +.BI "void \fBappend\fR ( const QString & qName, const QString & uri, const QString & localPart, const QString & value )" +.br +.in -1c +.SH DESCRIPTION +The QXmlAttributes class provides XML attributes. +.PP +If attributes are reported by QXmlContentHandler::startElement() this class is used to pass the attribute values. +.PP +Use index() to locate the position of an attribute in the list, count() to retrieve the number of attributes, and clear() to remove the attributes. New attributes can be added with append(). Use type() to get an attribute's type and value() to get its value. The attribute's name is available from localName() or qName(), and its namespace URI from uri(). +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlAttributes::QXmlAttributes ()" +Constructs an empty attribute list. +.SH "QXmlAttributes::~QXmlAttributes ()\fC [virtual]\fR" +Destroys the attributes object. +.SH "void QXmlAttributes::append ( const QString & qName, const QString & uri, const QString & localPart, const QString & value )" +Appends a new attribute entry to the list of attributes. The qualified name of the attribute is \fIqName\fR, the namespace URI is \fIuri\fR and the local name is \fIlocalPart\fR. The value of the attribute is \fIvalue\fR. +.PP +See also qName(), uri(), localName(), and value(). +.SH "void QXmlAttributes::clear ()" +Clears the list of attributes. +.PP +See also append(). +.SH "int QXmlAttributes::count () const" +Returns the number of attributes in the list. This function is equivalent to length(). +.SH "int QXmlAttributes::index ( const QString & qName ) const" +Looks up the index of an attribute by the qualified name \fIqName\fR. +.PP +Returns the index of the attribute or -1 if it wasn't found. +.PP +See also the namespace description. +.SH "int QXmlAttributes::index ( const QString & uri, const QString & localPart ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Looks up the index of an attribute by a namespace name. +.PP +\fIuri\fR specifies the namespace URI, or an empty string if the name has no namespace URI. \fIlocalPart\fR specifies the attribute's local name. +.PP +Returns the index of the attribute, or -1 if it wasn't found. +.PP +See also the namespace description. +.SH "int QXmlAttributes::length () const" +Returns the number of attributes in the list. +.PP +See also count(). +.PP +Example: xml/tagreader-with-features/structureparser.cpp. +.SH "QString QXmlAttributes::localName ( int index ) const" +Looks up an attribute's local name for the attribute at position \fIindex\fR. If no namespace processing is done, the local name is QString::null. +.PP +See also the namespace description. +.SH "QString QXmlAttributes::qName ( int index ) const" +Looks up an attribute's XML 1.0 qualified name for the attribute at position \fIindex\fR. +.PP +See also the namespace description. +.PP +Example: xml/tagreader-with-features/structureparser.cpp. +.SH "QString QXmlAttributes::type ( int index ) const" +Looks up an attribute's type for the attribute at position \fIindex\fR. +.PP +Currently only "CDATA" is returned. +.SH "QString QXmlAttributes::type ( const QString & qName ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Looks up an attribute's type for the qualified name \fIqName\fR. +.PP +Currently only "CDATA" is returned. +.SH "QString QXmlAttributes::type ( const QString & uri, const QString & localName ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Looks up an attribute's type by namespace name. +.PP +\fIuri\fR specifies the namespace URI and \fIlocalName\fR specifies the local name. If the name has no namespace URI, use an empty string for \fIuri\fR. +.PP +Currently only "CDATA" is returned. +.SH "QString QXmlAttributes::uri ( int index ) const" +Looks up an attribute's namespace URI for the attribute at position \fIindex\fR. If no namespace processing is done or if the attribute has no namespace, the namespace URI is QString::null. +.PP +See also the namespace description. +.PP +Example: xml/tagreader-with-features/structureparser.cpp. +.SH "QString QXmlAttributes::value ( int index ) const" +Looks up an attribute's value for the attribute at position \fIindex\fR. +.SH "QString QXmlAttributes::value ( const QString & qName ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Looks up an attribute's value for the qualified name \fIqName\fR. +.PP +See also the namespace description. +.SH "QString QXmlAttributes::value ( const QString & uri, const QString & localName ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Looks up an attribute's value by namespace name. +.PP +\fIuri\fR specifies the namespace URI, or an empty string if the name has no namespace URI. \fIlocalName\fR specifies the attribute's local name. +.PP +See also the namespace description. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlattributes.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlattributes.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlcontenthandler.3qt b/doc/man/man3/tqxmlcontenthandler.3qt new file mode 100644 index 000000000..73ad825fb --- /dev/null +++ b/doc/man/man3/tqxmlcontenthandler.3qt @@ -0,0 +1,184 @@ +'\" t +.TH QXmlContentHandler 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 +QXmlContentHandler \- Interface to report the logical content of XML data +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherited by QXmlDefaultHandler. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual void \fBsetDocumentLocator\fR ( QXmlLocator * locator ) = 0" +.br +.ti -1c +.BI "virtual bool \fBstartDocument\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBendDocument\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBstartPrefixMapping\fR ( const QString & prefix, const QString & uri ) = 0" +.br +.ti -1c +.BI "virtual bool \fBendPrefixMapping\fR ( const QString & prefix ) = 0" +.br +.ti -1c +.BI "virtual bool \fBstartElement\fR ( const QString & namespaceURI, const QString & localName, const QString & qName, const QXmlAttributes & atts ) = 0" +.br +.ti -1c +.BI "virtual bool \fBendElement\fR ( const QString & namespaceURI, const QString & localName, const QString & qName ) = 0" +.br +.ti -1c +.BI "virtual bool \fBcharacters\fR ( const QString & ch ) = 0" +.br +.ti -1c +.BI "virtual bool \fBignorableWhitespace\fR ( const QString & ch ) = 0" +.br +.ti -1c +.BI "virtual bool \fBprocessingInstruction\fR ( const QString & target, const QString & data ) = 0" +.br +.ti -1c +.BI "virtual bool \fBskippedEntity\fR ( const QString & name ) = 0" +.br +.ti -1c +.BI "virtual QString \fBerrorString\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlContentHandler class provides an interface to report the logical content of XML data. +.PP +If the application needs to be informed of basic parsing events, it can implement this interface and activate it using QXmlReader::setContentHandler(). The reader can then report basic document-related events like the start and end of elements and character data through this interface. +.PP +The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, all of an element's content (character data, processing instructions, and sub-elements) appears, in order, between the startElement() event and the corresponding endElement() event. +.PP +The class QXmlDefaultHandler provides a default implementation for this interface; subclassing from the QXmlDefaultHandler class is very convenient if you only want to be informed of some parsing events. +.PP +The startDocument() function is called at the start of the document, and endDocument() is called at the end. Before parsing begins setDocumentLocator() is called. For each element startElement() is called, with endElement() being called at the end of each element. The characters() function is called with chunks of character data; ignorableWhitespace() is called with chunks of whitespace and processingInstruction() is called with processing instructions. If an entity is skipped skippedEntity() is called. At the beginning of prefix-URI scopes startPrefixMapping() is called. +.PP +See also the Introduction to SAX2. +.PP +See also QXmlDTDHandler, QXmlDeclHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "bool QXmlContentHandler::characters ( const QString & ch )\fC [pure virtual]\fR" +The reader calls this function when it has parsed a chunk of character data (either normal character data or character data inside a CDATA section; if you need to distinguish between those two types you must use QXmlLexicalHandler::startCDATA() and QXmlLexicalHandler::endCDATA()). The character data is reported in \fIch\fR. +.PP +Some readers report whitespace in element content using the ignorableWhitespace() function rather than using this one. +.PP +A reader may report the character data of an element in more than one chunk; e.g. a reader might want to report "a<b" in three characters() events ("a ", "<" and " b"). +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "bool QXmlContentHandler::endDocument ()\fC [pure virtual]\fR" +The reader calls this function after it has finished parsing. It is called just once, and is the last handler function called. It is called after the reader has read all input or has abandoned parsing because of a fatal error. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also startDocument(). +.SH "bool QXmlContentHandler::endElement ( const QString & namespaceURI, const QString & localName, const QString & qName )\fC [pure virtual]\fR" +The reader calls this function when it has parsed an end element tag with the qualified name \fIqName\fR, the local name \fIlocalName\fR and the namespace URI \fInamespaceURI\fR. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also the namespace description. +.PP +See also startElement(). +.PP +Example: xml/tagreader/structureparser.cpp. +.SH "bool QXmlContentHandler::endPrefixMapping ( const QString & prefix )\fC [pure virtual]\fR" +The reader calls this function to signal the end of a prefix mapping for the prefix \fIprefix\fR. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also the namespace description. +.PP +See also startPrefixMapping(). +.SH "QString QXmlContentHandler::errorString ()\fC [pure virtual]\fR" +The reader calls this function to get an error string, e.g. if any of the handler functions returns FALSE. +.SH "bool QXmlContentHandler::ignorableWhitespace ( const QString & ch )\fC [pure virtual]\fR" +Some readers may use this function to report each chunk of whitespace in element content. The whitespace is reported in \fIch\fR. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "bool QXmlContentHandler::processingInstruction ( const QString & target, const QString & data )\fC [pure virtual]\fR" +The reader calls this function when it has parsed a processing instruction. +.PP +\fItarget\fR is the target name of the processing instruction and \fIdata\fR is the data in the processing instruction. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "void QXmlContentHandler::setDocumentLocator ( QXmlLocator * locator )\fC [pure virtual]\fR" +The reader calls this function before it starts parsing the document. The argument \fIlocator\fR is a pointer to a QXmlLocator which allows the application to get the parsing position within the document. +.PP +Do not destroy the \fIlocator\fR; it is destroyed when the reader is destroyed. (Do not use the \fIlocator\fR after the reader is destroyed). +.SH "bool QXmlContentHandler::skippedEntity ( const QString & name )\fC [pure virtual]\fR" +Some readers may skip entities if they have not seen the declarations (e.g. because they are in an external DTD). If they do so they report that they skipped the entity called \fIname\fR by calling this function. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "bool QXmlContentHandler::startDocument ()\fC [pure virtual]\fR" +The reader calls this function when it starts parsing the document. The reader calls this function just once, after the call to setDocumentLocator(), and before any other functions in this class or in the QXmlDTDHandler class are called. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also endDocument(). +.PP +Example: xml/tagreader/structureparser.cpp. +.SH "bool QXmlContentHandler::startElement ( const QString & namespaceURI, const QString & localName, const QString & qName, const QXmlAttributes & atts )\fC [pure virtual]\fR" +The reader calls this function when it has parsed a start element tag. +.PP +There is a corresponding endElement() call when the corresponding end element tag is read. The startElement() and endElement() calls are always nested correctly. Empty element tags (e.g. \fC<x/>\fR) cause a startElement() call to be immediately followed by an endElement() call. +.PP +The attribute list provided only contains attributes with explicit values. The attribute list contains attributes used for namespace declaration (i.e. attributes starting with xmlns) only if the namespace-prefix property of the reader is TRUE. +.PP +The argument \fInamespaceURI\fR is the namespace URI, or QString::null if the element has no namespace URI or if no namespace processing is done. \fIlocalName\fR is the local name (without prefix), or QString::null if no namespace processing is done, \fIqName\fR is the qualified name (with prefix) and \fIatts\fR are the attributes attached to the element. If there are no attributes, \fIatts\fR is an empty attributes object. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also the namespace description. +.PP +See also endElement(). +.PP +Example: xml/tagreader/structureparser.cpp. +.SH "bool QXmlContentHandler::startPrefixMapping ( const QString & prefix, const QString & uri )\fC [pure virtual]\fR" +The reader calls this function to signal the begin of a prefix-URI namespace mapping scope. This information is not necessary for normal namespace processing since the reader automatically replaces prefixes for element and attribute names. +.PP +Note that startPrefixMapping() and endPrefixMapping() calls are not guaranteed to be properly nested relative to each other: all startPrefixMapping() events occur before the corresponding startElement() event, and all endPrefixMapping() events occur after the corresponding endElement() event, but their order is not otherwise guaranteed. +.PP +The argument \fIprefix\fR is the namespace prefix being declared and the argument \fIuri\fR is the namespace URI the prefix is mapped to. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also the namespace description. +.PP +See also endPrefixMapping(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlcontenthandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlcontenthandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmldeclhandler.3qt b/doc/man/man3/tqxmldeclhandler.3qt new file mode 100644 index 000000000..721dc689f --- /dev/null +++ b/doc/man/man3/tqxmldeclhandler.3qt @@ -0,0 +1,92 @@ +'\" t +.TH QXmlDeclHandler 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 +QXmlDeclHandler \- Interface to report declaration content of XML data +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherited by QXmlDefaultHandler. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual bool \fBattributeDecl\fR ( const QString & eName, const QString & aName, const QString & type, const QString & valueDefault, const QString & value ) = 0" +.br +.ti -1c +.BI "virtual bool \fBinternalEntityDecl\fR ( const QString & name, const QString & value ) = 0" +.br +.ti -1c +.BI "virtual bool \fBexternalEntityDecl\fR ( const QString & name, const QString & publicId, const QString & systemId ) = 0" +.br +.ti -1c +.BI "virtual QString \fBerrorString\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlDeclHandler class provides an interface to report declaration content of XML data. +.PP +You can set the declaration handler with QXmlReader::setDeclHandler(). +.PP +This interface is based on the SAX2 extension DeclHandler. +.PP +The interface provides attributeDecl(), internalEntityDecl() and externalEntityDecl() functions. +.PP +See also the Introduction to SAX2. +.PP +See also QXmlDTDHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "bool QXmlDeclHandler::attributeDecl ( const QString & eName, const QString & aName, const QString & type, const QString & valueDefault, const QString & value )\fC [pure virtual]\fR" +The reader calls this function to report an attribute type declaration. Only the effective (first) declaration for an attribute is reported. +.PP +The reader passes the name of the associated element in \fIeName\fR and the name of the attribute in \fIaName\fR. It passes a string that represents the attribute type in \fItype\fR and a string that represents the attribute default in \fIvalueDefault\fR. This string is one of "#IMPLIED", "#REQUIRED", "#FIXED" or QString::null (if none of the others applies). The reader passes the attribute's default value in \fIvalue\fR. If no default value is specified in the XML file, \fIvalue\fR is QString::null. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "QString QXmlDeclHandler::errorString ()\fC [pure virtual]\fR" +The reader calls this function to get an error string if any of the handler functions returns FALSE. +.SH "bool QXmlDeclHandler::externalEntityDecl ( const QString & name, const QString & publicId, const QString & systemId )\fC [pure virtual]\fR" +The reader calls this function to report a parsed external entity declaration. Only the effective (first) declaration for each entity is reported. +.PP +The reader passes the name of the entity in \fIname\fR, the public identifier in \fIpublicId\fR and the system identifier in \fIsystemId\fR. If there is no public identifier specified, it passes QString::null in \fIpublicId\fR. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "bool QXmlDeclHandler::internalEntityDecl ( const QString & name, const QString & value )\fC [pure virtual]\fR" +The reader calls this function to report an internal entity declaration. Only the effective (first) declaration is reported. +.PP +The reader passes the name of the entity in \fIname\fR and the value of the entity in \fIvalue\fR. +.PP +If this function returns FALSE the reader stops parsing and +reports an error. The reader uses the function errorString() to +get the error message. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmldeclhandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmldeclhandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmldefaulthandler.3qt b/doc/man/man3/tqxmldefaulthandler.3qt new file mode 100644 index 000000000..cc5e4bc13 --- /dev/null +++ b/doc/man/man3/tqxmldefaulthandler.3qt @@ -0,0 +1,64 @@ +'\" t +.TH QXmlDefaultHandler 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 +QXmlDefaultHandler \- Default implementation of all the XML handler classes +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherits QXmlContentHandler, QXmlErrorHandler, QXmlDTDHandler, QXmlEntityResolver, QXmlLexicalHandler, and QXmlDeclHandler. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQXmlDefaultHandler\fR ()" +.br +.ti -1c +.BI "virtual \fB~QXmlDefaultHandler\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QXmlDefaultHandler class provides a default implementation of all the XML handler classes. +.PP +Very often we are only interested in parts of the things that the reader reports. This class implements a default behaviour for the handler classes (i.e. most of the time do nothing). Usually this is the class you subclass for implementing your own customized handler. +.PP +See also the Introduction to SAX2. +.PP +See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlDefaultHandler::QXmlDefaultHandler ()" +Constructor. +.SH "QXmlDefaultHandler::~QXmlDefaultHandler ()\fC [virtual]\fR" +Destructor. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmldefaulthandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmldefaulthandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmldtdhandler.3qt b/doc/man/man3/tqxmldtdhandler.3qt new file mode 100644 index 000000000..9d99660d7 --- /dev/null +++ b/doc/man/man3/tqxmldtdhandler.3qt @@ -0,0 +1,81 @@ +'\" t +.TH QXmlDTDHandler 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 +QXmlDTDHandler \- Interface to report DTD content of XML data +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherited by QXmlDefaultHandler. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual bool \fBnotationDecl\fR ( const QString & name, const QString & publicId, const QString & systemId ) = 0" +.br +.ti -1c +.BI "virtual bool \fBunparsedEntityDecl\fR ( const QString & name, const QString & publicId, const QString & systemId, const QString & notationName ) = 0" +.br +.ti -1c +.BI "virtual QString \fBerrorString\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlDTDHandler class provides an interface to report DTD content of XML data. +.PP +If an application needs information about notations and unparsed entities, it can implement this interface and register an instance with QXmlReader::setDTDHandler(). +.PP +Note that this interface includes only those DTD events that the XML recommendation requires processors to report, i.e. notation and unparsed entity declarations using notationDecl() and unparsedEntityDecl() respectively. +.PP +See also the Introduction to SAX2. +.PP +See also QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, QXmlLexicalHandler, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QString QXmlDTDHandler::errorString ()\fC [pure virtual]\fR" +The reader calls this function to get an error string if any of the handler functions returns FALSE. +.SH "bool QXmlDTDHandler::notationDecl ( const QString & name, const QString & publicId, const QString & systemId )\fC [pure virtual]\fR" +The reader calls this function when it has parsed a notation declaration. +.PP +The argument \fIname\fR is the notation name, \fIpublicId\fR is the notation's public identifier and \fIsystemId\fR is the notation's system identifier. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "bool QXmlDTDHandler::unparsedEntityDecl ( const QString & name, const QString & publicId, const QString & systemId, const QString & notationName )\fC [pure virtual]\fR" +The reader calls this function when it finds an unparsed entity declaration. +.PP +The argument \fIname\fR is the unparsed entity's name, \fIpublicId\fR is the entity's public identifier, \fIsystemId\fR is the entity's system identifier and \fInotationName\fR is the name of the associated notation. +.PP +If this function returns FALSE the reader stops parsing and +reports an error. The reader uses the function errorString() to +get the error message. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmldtdhandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmldtdhandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlentityresolver.3qt b/doc/man/man3/tqxmlentityresolver.3qt new file mode 100644 index 000000000..2ec44c333 --- /dev/null +++ b/doc/man/man3/tqxmlentityresolver.3qt @@ -0,0 +1,72 @@ +'\" t +.TH QXmlEntityResolver 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 +QXmlEntityResolver \- Interface to resolve external entities contained in XML data +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherited by QXmlDefaultHandler. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual bool \fBresolveEntity\fR ( const QString & publicId, const QString & systemId, QXmlInputSource *& ret ) = 0" +.br +.ti -1c +.BI "virtual QString \fBerrorString\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlEntityResolver class provides an interface to resolve external entities contained in XML data. +.PP +If an application needs to implement customized handling for external entities, it must implement this interface, i.e. resolveEntity(), and register it with QXmlReader::setEntityResolver(). +.PP +See also the Introduction to SAX2. +.PP +See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlErrorHandler, QXmlLexicalHandler, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QString QXmlEntityResolver::errorString ()\fC [pure virtual]\fR" +The reader calls this function to get an error string if any of the handler functions returns FALSE. +.SH "bool QXmlEntityResolver::resolveEntity ( const QString & publicId, const QString & systemId, QXmlInputSource *& ret )\fC [pure virtual]\fR" +The reader calls this function before it opens any external entity, except the top-level document entity. The application may request the reader to resolve the entity itself (\fIret\fR is 0) or to use an entirely different input source (\fIret\fR points to the input source). +.PP +The reader deletes the input source \fIret\fR when it no longer needs it, so you should allocate it on the heap with \fCnew\fR. +.PP +The argument \fIpublicId\fR is the public identifier of the external entity, \fIsystemId\fR is the system identifier of the external entity and \fIret\fR is the return value of this function. If \fIret\fR is 0 the reader should resolve the entity itself, if it is non-zero it must point to an input source which the reader uses instead. +.PP +If this function returns FALSE the reader stops parsing and +reports an error. The reader uses the function errorString() to +get the error message. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlentityresolver.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlentityresolver.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlerrorhandler.3qt b/doc/man/man3/tqxmlerrorhandler.3qt new file mode 100644 index 000000000..57f368d42 --- /dev/null +++ b/doc/man/man3/tqxmlerrorhandler.3qt @@ -0,0 +1,88 @@ +'\" t +.TH QXmlErrorHandler 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 +QXmlErrorHandler \- Interface to report errors in XML data +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherited by QXmlDefaultHandler. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual bool \fBwarning\fR ( const QXmlParseException & exception ) = 0" +.br +.ti -1c +.BI "virtual bool \fBerror\fR ( const QXmlParseException & exception ) = 0" +.br +.ti -1c +.BI "virtual bool \fBfatalError\fR ( const QXmlParseException & exception ) = 0" +.br +.ti -1c +.BI "virtual QString \fBerrorString\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlErrorHandler class provides an interface to report errors in XML data. +.PP +If you want your application to report errors to the user or to perform customized error handling, you should subclass this class. +.PP +You can set the error handler with QXmlReader::setErrorHandler(). +.PP +Errors can be reported using warning(), error() and fatalError(), with the error text being reported with errorString(). +.PP +See also the Introduction to SAX2. +.PP +See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlLexicalHandler, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "bool QXmlErrorHandler::error ( const QXmlParseException & exception )\fC [pure virtual]\fR" +A reader might use this function to report a recoverable error. A recoverable error corresponds to the definiton of "error" in section 1.2 of the XML 1.0 specification. Details of the error are stored in \fIexception\fR. +.PP +The reader must continue to provide normal parsing events after invoking this function. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "QString QXmlErrorHandler::errorString ()\fC [pure virtual]\fR" +The reader calls this function to get an error string if any of the handler functions returns FALSE. +.SH "bool QXmlErrorHandler::fatalError ( const QXmlParseException & exception )\fC [pure virtual]\fR" +A reader must use this function to report a non-recoverable error. Details of the error are stored in \fIexception\fR. +.PP +If this function returns TRUE the reader might try to go on parsing and reporting further errors; but no regular parsing events are reported. +.SH "bool QXmlErrorHandler::warning ( const QXmlParseException & exception )\fC [pure virtual]\fR" +A reader might use this function to report a warning. Warnings are conditions that are not errors or fatal errors as defined by the XML 1.0 specification. Details of the warning are stored in \fIexception\fR. +.PP +If this function returns FALSE the reader stops parsing and +reports an error. The reader uses the function errorString() to +get the error message. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlerrorhandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlerrorhandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlinputsource.3qt b/doc/man/man3/tqxmlinputsource.3qt new file mode 100644 index 000000000..2a3b10d5f --- /dev/null +++ b/doc/man/man3/tqxmlinputsource.3qt @@ -0,0 +1,156 @@ +'\" t +.TH QXmlInputSource 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 +QXmlInputSource \- The input data for the QXmlReader subclasses +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQXmlInputSource\fR ()" +.br +.ti -1c +.BI "\fBQXmlInputSource\fR ( QIODevice * dev )" +.br +.ti -1c +.BI "QXmlInputSource ( QFile & file ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "QXmlInputSource ( QTextStream & stream ) \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual \fB~QXmlInputSource\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetData\fR ( const QString & dat )" +.br +.ti -1c +.BI "virtual void \fBsetData\fR ( const QByteArray & dat )" +.br +.ti -1c +.BI "virtual void \fBfetchData\fR ()" +.br +.ti -1c +.BI "virtual QString \fBdata\fR ()" +.br +.ti -1c +.BI "virtual QChar \fBnext\fR ()" +.br +.ti -1c +.BI "virtual void \fBreset\fR ()" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "virtual QString \fBfromRawData\fR ( const QByteArray & data, bool beginning = FALSE )" +.br +.in -1c +.SH DESCRIPTION +The QXmlInputSource class provides the input data for the QXmlReader subclasses. +.PP +All subclasses of QXmlReader read the input XML document from this class. +.PP +This class recognizes the encoding of the data by reading the encoding declaration in the XML file if it finds one, and reading the data using the corresponding encoding. If it does not find an encoding declaration, then it assumes that the data is either in UTF-8 or UTF-16, depending on whether it can find a byte-order mark. +.PP +There are two ways to populate the input source with data: you can construct it with a QIODevice* so that the input source reads the data from that device. Or you can set the data explicitly with one of the setData() functions. +.PP +Usually you either construct a QXmlInputSource that works on a QIODevice* or you construct an empty QXmlInputSource and set the data with setData(). There are only rare occasions where you would want to mix both methods. +.PP +The QXmlReader subclasses use the next() function to read the input character by character. If you want to start from the beginning again, use reset(). +.PP +The functions data() and fetchData() are useful if you want to do something with the data other than parsing, e.g. displaying the raw XML file. The benefit of using the QXmlInputClass in such cases is that it tries to use the correct encoding. +.PP +See also QXmlReader, QXmlSimpleReader, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlInputSource::QXmlInputSource ()" +Constructs an input source which contains no data. +.PP +See also setData(). +.SH "QXmlInputSource::QXmlInputSource ( QIODevice * dev )" +Constructs an input source and gets the data from device \fIdev\fR. If \fIdev\fR is not open, it is opened in read-only mode. If \fIdev\fR is 0 or it is not possible to read from the device, the input source will contain no data. +.PP +See also setData(), fetchData(), and QIODevice. +.SH "QXmlInputSource::QXmlInputSource ( QFile & file )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Constructs an input source and gets the data from the file \fIfile\fR. If the file cannot be read the input source is empty. +.SH "QXmlInputSource::QXmlInputSource ( QTextStream & stream )" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.PP +Constructs an input source and gets the data from the text stream \fIstream\fR. +.SH "QXmlInputSource::~QXmlInputSource ()\fC [virtual]\fR" +Destructor. +.SH "QString QXmlInputSource::data ()\fC [virtual]\fR" +Returns the data the input source contains or QString::null if the input source does not contain any data. +.PP +See also setData(), QXmlInputSource(), and fetchData(). +.SH "void QXmlInputSource::fetchData ()\fC [virtual]\fR" +This function reads more data from the device that was set during construction. If the input source already contained data, this function deletes that data first. +.PP +This object contains no data after a call to this function if the object was constructed without a device to read data from or if this function was not able to get more data from the device. +.PP +There are two occasions where a fetch is done implicitly by another function call: during construction (so that the object starts out with some initial data where available), and during a call to next() (if the data had run out). +.PP +You don't normally need to use this function if you use next(). +.PP +See also data(), next(), and QXmlInputSource(). +.SH "QString QXmlInputSource::fromRawData ( const QByteArray & data, bool beginning = FALSE )\fC [virtual protected]\fR" +This function reads the XML file from \fIdata\fR and tries to recognize the encoding. It converts the raw data \fIdata\fR into a QString and returns it. It tries its best to get the correct encoding for the XML file. +.PP +If \fIbeginning\fR is TRUE, this function assumes that the data starts at the beginning of a new XML document and looks for an encoding declaration. If \fIbeginning\fR is FALSE, it converts the raw data using the encoding determined from prior calls. +.SH "QChar QXmlInputSource::next ()\fC [virtual]\fR" +Returns the next character of the input source. If this function reaches the end of available data, it returns QXmlInputSource::EndOfData. If you call next() after that, it tries to fetch more data by calling fetchData(). If the fetchData() call results in new data, this function returns the first character of that data; otherwise it returns QXmlInputSource::EndOfDocument. +.PP +See also reset(), fetchData(), QXmlSimpleReader::parse(), and QXmlSimpleReader::parseContinue(). +.SH "void QXmlInputSource::reset ()\fC [virtual]\fR" +This function sets the position used by next() to the beginning of the data returned by data(). This is useful if you want to use the input source for more than one parse. +.PP +See also next(). +.PP +Example: xml/tagreader-with-features/tagreader.cpp. +.SH "void QXmlInputSource::setData ( const QString & dat )\fC [virtual]\fR" +Sets the data of the input source to \fIdat\fR. +.PP +If the input source already contains data, this function deletes that data first. +.PP +See also data(). +.SH "void QXmlInputSource::setData ( const QByteArray & dat )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +The data \fIdat\fR is passed through the correct text-codec, before +it is set. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlinputsource.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlinputsource.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmllexicalhandler.3qt b/doc/man/man3/tqxmllexicalhandler.3qt new file mode 100644 index 000000000..c81e1035e --- /dev/null +++ b/doc/man/man3/tqxmllexicalhandler.3qt @@ -0,0 +1,134 @@ +'\" t +.TH QXmlLexicalHandler 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 +QXmlLexicalHandler \- Interface to report the lexical content of XML data +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherited by QXmlDefaultHandler. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual bool \fBstartDTD\fR ( const QString & name, const QString & publicId, const QString & systemId ) = 0" +.br +.ti -1c +.BI "virtual bool \fBendDTD\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBstartEntity\fR ( const QString & name ) = 0" +.br +.ti -1c +.BI "virtual bool \fBendEntity\fR ( const QString & name ) = 0" +.br +.ti -1c +.BI "virtual bool \fBstartCDATA\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBendCDATA\fR () = 0" +.br +.ti -1c +.BI "virtual bool \fBcomment\fR ( const QString & ch ) = 0" +.br +.ti -1c +.BI "virtual QString \fBerrorString\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlLexicalHandler class provides an interface to report the lexical content of XML data. +.PP +The events in the lexical handler apply to the entire document, not just to the document element, and all lexical handler events appear between the content handler's startDocument and endDocument events. +.PP +You can set the lexical handler with QXmlReader::setLexicalHandler(). +.PP +This interface's design is based on the the SAX2 extension LexicalHandler. +.PP +The interface provides the startDTD(), endDTD(), startEntity(), endEntity(), startCDATA(), endCDATA() and comment() functions. +.PP +See also the Introduction to SAX2. +.PP +See also QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "bool QXmlLexicalHandler::comment ( const QString & ch )\fC [pure virtual]\fR" +The reader calls this function to report an XML comment anywhere in the document. It reports the text of the comment in \fIch\fR. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.SH "bool QXmlLexicalHandler::endCDATA ()\fC [pure virtual]\fR" +The reader calls this function to report the end of a CDATA section. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also startCDATA() and QXmlContentHandler::characters(). +.SH "bool QXmlLexicalHandler::endDTD ()\fC [pure virtual]\fR" +The reader calls this function to report the end of a DTD declaration, if any. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also startDTD(). +.SH "bool QXmlLexicalHandler::endEntity ( const QString & name )\fC [pure virtual]\fR" +The reader calls this function to report the end of an entity called \fIname\fR. +.PP +For every startEntity() call, there is a corresponding endEntity() call. The calls to startEntity() and endEntity() are properly nested. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also startEntity(), QXmlContentHandler::skippedEntity(), and QXmlSimpleReader::setFeature(). +.SH "QString QXmlLexicalHandler::errorString ()\fC [pure virtual]\fR" +The reader calls this function to get an error string if any of the handler functions returns FALSE. +.SH "bool QXmlLexicalHandler::startCDATA ()\fC [pure virtual]\fR" +The reader calls this function to report the start of a CDATA section. The content of the CDATA section is reported through the QXmlContentHandler::characters() function. This function is intended only to report the boundary. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also endCDATA(). +.SH "bool QXmlLexicalHandler::startDTD ( const QString & name, const QString & publicId, const QString & systemId )\fC [pure virtual]\fR" +The reader calls this function to report the start of a DTD declaration, if any. It reports the name of the document type in \fIname\fR, the public identifier in \fIpublicId\fR and the system identifier in \fIsystemId\fR. +.PP +If the public identifier is missing, \fIpublicId\fR is set to QString::null. If the system identifier is missing, \fIsystemId\fR is set to QString::null. Note that it is not valid XML to have a public identifier but no system identifier; in such cases a parse error will occur. +.PP +All declarations reported through QXmlDTDHandler or QXmlDeclHandler appear between the startDTD() and endDTD() calls. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also endDTD(). +.SH "bool QXmlLexicalHandler::startEntity ( const QString & name )\fC [pure virtual]\fR" +The reader calls this function to report the start of an entity called \fIname\fR. +.PP +Note that if the entity is unknown, the reader reports it through QXmlContentHandler::skippedEntity() and not through this function. +.PP +If this function returns FALSE the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message. +.PP +See also endEntity() and QXmlSimpleReader::setFeature(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmllexicalhandler.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmllexicalhandler.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmllocator.3qt b/doc/man/man3/tqxmllocator.3qt new file mode 100644 index 000000000..32f645faf --- /dev/null +++ b/doc/man/man3/tqxmllocator.3qt @@ -0,0 +1,71 @@ +'\" t +.TH QXmlLocator 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 +QXmlLocator \- The XML handler classes with information about the parsing position within a file +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQXmlLocator\fR ()" +.br +.ti -1c +.BI "virtual \fB~QXmlLocator\fR ()" +.br +.ti -1c +.BI "virtual int \fBcolumnNumber\fR () = 0" +.br +.ti -1c +.BI "virtual int \fBlineNumber\fR () = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlLocator class provides the XML handler classes with information about the parsing position within a file. +.PP +The reader reports a QXmlLocator to the content handler before it starts to parse the document. This is done with the QXmlContentHandler::setDocumentLocator() function. The handler classes can now use this locator to get the position (lineNumber() and columnNumber()) that the reader has reached. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlLocator::QXmlLocator ()" +Constructor. +.SH "QXmlLocator::~QXmlLocator ()\fC [virtual]\fR" +Destructor. +.SH "int QXmlLocator::columnNumber ()\fC [pure virtual]\fR" +Returns the column number (starting at 1) or -1 if there is no column number available. +.SH "int QXmlLocator::lineNumber ()\fC [pure virtual]\fR" +Returns the line number (starting at 1) or -1 if there is no line +number available. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmllocator.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmllocator.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlnamespacesupport.3qt b/doc/man/man3/tqxmlnamespacesupport.3qt new file mode 100644 index 000000000..1b017edc0 --- /dev/null +++ b/doc/man/man3/tqxmlnamespacesupport.3qt @@ -0,0 +1,180 @@ +'\" t +.TH QXmlNamespaceSupport 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 +QXmlNamespaceSupport \- Helper class for XML readers which want to include namespace support +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQXmlNamespaceSupport\fR ()" +.br +.ti -1c +.BI "\fB~QXmlNamespaceSupport\fR ()" +.br +.ti -1c +.BI "void \fBsetPrefix\fR ( const QString & pre, const QString & uri )" +.br +.ti -1c +.BI "QString \fBprefix\fR ( const QString & uri ) const" +.br +.ti -1c +.BI "QString \fBuri\fR ( const QString & prefix ) const" +.br +.ti -1c +.BI "void \fBsplitName\fR ( const QString & qname, QString & prefix, QString & localname ) const" +.br +.ti -1c +.BI "void \fBprocessName\fR ( const QString & qname, bool isAttribute, QString & nsuri, QString & localname ) const" +.br +.ti -1c +.BI "QStringList \fBprefixes\fR () const" +.br +.ti -1c +.BI "QStringList \fBprefixes\fR ( const QString & uri ) const" +.br +.ti -1c +.BI "void \fBpushContext\fR ()" +.br +.ti -1c +.BI "void \fBpopContext\fR ()" +.br +.ti -1c +.BI "void \fBreset\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QXmlNamespaceSupport class is a helper class for XML readers which want to include namespace support. +.PP +You can set the prefix for the current namespace with setPrefix(), and get the list of current prefixes (or those for a given URI) with prefixes(). The namespace URI is available from uri(). Use pushContext() to start a new namespace context, and popContext() to return to the previous namespace context. Use splitName() or processName() to split a name into its prefix and local name. +.PP +See also the namespace description. +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlNamespaceSupport::QXmlNamespaceSupport ()" +Constructs a QXmlNamespaceSupport. +.SH "QXmlNamespaceSupport::~QXmlNamespaceSupport ()" +Destroys a QXmlNamespaceSupport. +.SH "void QXmlNamespaceSupport::popContext ()" +Reverts to the previous namespace context. +.PP +Normally, you should pop the context at the end of each XML element. After popping the context, all namespace prefix mappings that were previously in force are restored. +.PP +See also pushContext(). +.SH "QString QXmlNamespaceSupport::prefix ( const QString & uri ) const" +Returns one of the prefixes mapped to the namespace URI \fIuri\fR. +.PP +If more than one prefix is currently mapped to the same URI, this function makes an arbitrary selection; if you want all of the prefixes, use prefixes() instead. +.PP +Note: to check for a default prefix, use the uri() function with an argument of "". +.SH "QStringList QXmlNamespaceSupport::prefixes () const" +Returns a list of all the prefixes currently declared. +.PP +If there is a default prefix, this function does not return it in the list; check for the default prefix using uri() with an argument of "". +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myXmlNamespaceSupport.prefixes(); +.br + QStringList::iterator it = list.begin(); +.br + while ( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "QStringList QXmlNamespaceSupport::prefixes ( const QString & uri ) const" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Returns a list of all prefixes currently declared for the namespace URI \fIuri\fR. +.PP +The "xml:" prefix is included. If you only want one prefix that is mapped to the namespace URI, and you don't care which one you get, use the prefix() function instead. +.PP +Note: the empty (default) prefix is never included in this list; to check for the presence of a default namespace, use uri() with an argument of "". +.PP +Note that if you want to iterate over the list, you should iterate over a copy, e.g. +.PP +.nf +.br + QStringList list = myXmlNamespaceSupport.prefixes( "" ); +.br + QStringList::Iterator it = list.begin(); +.br + while( it != list.end() ) { +.br + myProcessing( *it ); +.br + ++it; +.br + } +.br +.fi +.SH "void QXmlNamespaceSupport::processName ( const QString & qname, bool isAttribute, QString & nsuri, QString & localname ) const" +Processes a raw XML 1.0 name in the current context by removing the prefix and looking it up among the prefixes currently declared. +.PP +\fIqname\fR is the raw XML 1.0 name to be processed. \fIisAttribute\fR is TRUE if the name is an attribute name. +.PP +This function stores the namespace URI in \fInsuri\fR (which will be set to QString::null if the raw name has an undeclared prefix), and stores the local name (without prefix) in \fIlocalname\fR (which will be set to QString::null if no namespace is in use). +.PP +Note that attribute names are processed differently than element names: an unprefixed element name gets the default namespace (if any), while an unprefixed element name does not. +.SH "void QXmlNamespaceSupport::pushContext ()" +Starts a new namespace context. +.PP +Normally, you should push a new context at the beginning of each XML element: the new context automatically inherits the declarations of its parent context, and it also keeps track of which declarations were made within this context. +.PP +See also popContext(). +.SH "void QXmlNamespaceSupport::reset ()" +Resets this namespace support object ready for reuse. +.SH "void QXmlNamespaceSupport::setPrefix ( const QString & pre, const QString & uri )" +This function declares a prefix \fIpre\fR in the current namespace context to be the namespace URI \fIuri\fR. The prefix remains in force until this context is popped, unless it is shadowed in a descendant context. +.PP +Note that there is an asymmetry in this library. prefix() does not return the default "" prefix, even if you have declared one; to check for a default prefix, you must look it up explicitly using uri(). This asymmetry exists to make it easier to look up prefixes for attribute names, where the default prefix is not allowed. +.SH "void QXmlNamespaceSupport::splitName ( const QString & qname, QString & prefix, QString & localname ) const" +Splits the name \fIqname\fR at the ':' and returns the prefix in \fIprefix\fR and the local name in \fIlocalname\fR. +.PP +See also processName(). +.SH "QString QXmlNamespaceSupport::uri ( const QString & prefix ) const" +Looks up the prefix \fIprefix\fR in the current context and returns +the currently-mapped namespace URI. Use the empty string ("") for +the default namespace. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlnamespacesupport.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlnamespacesupport.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlparseexception.3qt b/doc/man/man3/tqxmlparseexception.3qt new file mode 100644 index 000000000..adc710716 --- /dev/null +++ b/doc/man/man3/tqxmlparseexception.3qt @@ -0,0 +1,80 @@ +'\" t +.TH QXmlParseException 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 +QXmlParseException \- Used to report errors with the QXmlErrorHandler interface +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQXmlParseException\fR ( const QString & name = """", int c = -1, int l = -1, const QString & p = """", const QString & s = """" )" +.br +.ti -1c +.BI "int \fBcolumnNumber\fR () const" +.br +.ti -1c +.BI "int \fBlineNumber\fR () const" +.br +.ti -1c +.BI "QString \fBpublicId\fR () const" +.br +.ti -1c +.BI "QString \fBsystemId\fR () const" +.br +.ti -1c +.BI "QString \fBmessage\fR () const" +.br +.in -1c +.SH DESCRIPTION +The QXmlParseException class is used to report errors with the QXmlErrorHandler interface. +.PP +The XML subsystem constructs an instance of this class when it detects an error. You can retrieve the place where the error occurred using systemId(), publicId(), lineNumber() and columnNumber(), along with the error message(). +.PP +See also QXmlErrorHandler, QXmlReader, and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlParseException::QXmlParseException ( const QString & name = "", int c = -1, int l = -1, const QString & p = "", const QString & s = "" )" +Constructs a parse exception with the error string \fIname\fR for column \fIc\fR and line \fIl\fR for the public identifier \fIp\fR and the system identifier \fIs\fR. +.SH "int QXmlParseException::columnNumber () const" +Returns the column number where the error occurred. +.SH "int QXmlParseException::lineNumber () const" +Returns the line number where the error occurred. +.SH "QString QXmlParseException::message () const" +Returns the error message. +.SH "QString QXmlParseException::publicId () const" +Returns the public identifier where the error occurred. +.SH "QString QXmlParseException::systemId () const" +Returns the system identifier where the error occurred. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlparseexception.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlparseexception.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlreader.3qt b/doc/man/man3/tqxmlreader.3qt new file mode 100644 index 000000000..924d61a90 --- /dev/null +++ b/doc/man/man3/tqxmlreader.3qt @@ -0,0 +1,206 @@ +'\" t +.TH QXmlReader 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 +QXmlReader \- Interface for XML readers (i.e. parsers) +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherited by QXmlSimpleReader. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual bool \fBfeature\fR ( const QString & name, bool * ok = 0 ) const = 0" +.br +.ti -1c +.BI "virtual void \fBsetFeature\fR ( const QString & name, bool value ) = 0" +.br +.ti -1c +.BI "virtual bool \fBhasFeature\fR ( const QString & name ) const = 0" +.br +.ti -1c +.BI "virtual void * \fBproperty\fR ( const QString & name, bool * ok = 0 ) const = 0" +.br +.ti -1c +.BI "virtual void \fBsetProperty\fR ( const QString & name, void * value ) = 0" +.br +.ti -1c +.BI "virtual bool \fBhasProperty\fR ( const QString & name ) const = 0" +.br +.ti -1c +.BI "virtual void \fBsetEntityResolver\fR ( QXmlEntityResolver * handler ) = 0" +.br +.ti -1c +.BI "virtual QXmlEntityResolver * \fBentityResolver\fR () const = 0" +.br +.ti -1c +.BI "virtual void \fBsetDTDHandler\fR ( QXmlDTDHandler * handler ) = 0" +.br +.ti -1c +.BI "virtual QXmlDTDHandler * \fBDTDHandler\fR () const = 0" +.br +.ti -1c +.BI "virtual void \fBsetContentHandler\fR ( QXmlContentHandler * handler ) = 0" +.br +.ti -1c +.BI "virtual QXmlContentHandler * \fBcontentHandler\fR () const = 0" +.br +.ti -1c +.BI "virtual void \fBsetErrorHandler\fR ( QXmlErrorHandler * handler ) = 0" +.br +.ti -1c +.BI "virtual QXmlErrorHandler * \fBerrorHandler\fR () const = 0" +.br +.ti -1c +.BI "virtual void \fBsetLexicalHandler\fR ( QXmlLexicalHandler * handler ) = 0" +.br +.ti -1c +.BI "virtual QXmlLexicalHandler * \fBlexicalHandler\fR () const = 0" +.br +.ti -1c +.BI "virtual void \fBsetDeclHandler\fR ( QXmlDeclHandler * handler ) = 0" +.br +.ti -1c +.BI "virtual QXmlDeclHandler * \fBdeclHandler\fR () const = 0" +.br +.ti -1c +.BI "virtual bool parse ( const QXmlInputSource & input ) = 0 \fI(obsolete)\fR" +.br +.ti -1c +.BI "virtual bool \fBparse\fR ( const QXmlInputSource * input ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QXmlReader class provides an interface for XML readers (i.e. parsers). +.PP +This abstract class provides an interface for all of Qt's XML readers. Currently there is only one implementation of a reader included in Qt's XML module: QXmlSimpleReader. In future releases there might be more readers with different properties available (e.g. a validating parser). +.PP +The design of the XML classes follows the SAX2 Java interface, with the names adapted to fit Qt naming conventions. It should be very easy for anybody who has worked with SAX2 to get started with the Qt XML classes. +.PP +All readers use the class QXmlInputSource to read the input document. Since you are normally interested in particular content in the XML document, the reader reports the content through special handler classes (QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler and QXmlLexicalHandler), which you must subclass, if you want to process the contents. +.PP +Since the handler classes only describe interfaces you must implement all the functions. We provide the QXmlDefaultHandler class to make this easier: it implements a default behaviour (do nothing) for all functions, so you can subclass it and just implement the functions you are interested in. +.PP +Features and properties of the reader can be set with setFeature() and setProperty() respectively. You can set the reader to use your own subclasses with setEntityResolver(), setDTDHandler(), setContentHandler(), setErrorHandler(), setLexicalHandler() and setDeclHandler(). The parse itself is started with a call to parse(). +.PP +See also QXmlSimpleReader and XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlDTDHandler * QXmlReader::DTDHandler () const\fC [pure virtual]\fR" +Returns the DTD handler or 0 if none was set. +.PP +See also setDTDHandler(). +.SH "QXmlContentHandler * QXmlReader::contentHandler () const\fC [pure virtual]\fR" +Returns the content handler or 0 if none was set. +.PP +See also setContentHandler(). +.SH "QXmlDeclHandler * QXmlReader::declHandler () const\fC [pure virtual]\fR" +Returns the declaration handler or 0 if none was set. +.PP +See also setDeclHandler(). +.SH "QXmlEntityResolver * QXmlReader::entityResolver () const\fC [pure virtual]\fR" +Returns the entity resolver or 0 if none was set. +.PP +See also setEntityResolver(). +.SH "QXmlErrorHandler * QXmlReader::errorHandler () const\fC [pure virtual]\fR" +Returns the error handler or 0 if none is set. +.PP +See also setErrorHandler(). +.SH "bool QXmlReader::feature ( const QString & name, bool * ok = 0 ) const\fC [pure virtual]\fR" +If the reader has the feature called \fIname\fR, the feature's value is returned. If no such feature exists the return value is undefined. +.PP +If \fIok\fR is not 0: \fI*ok\fR is set to TRUE if the reader has the feature called \fIname\fR; otherwise \fI*ok\fR is set to FALSE. +.PP +See also setFeature() and hasFeature(). +.SH "bool QXmlReader::hasFeature ( const QString & name ) const\fC [pure virtual]\fR" +Returns \fCTRUE\fR if the reader has the feature called \fIname\fR; otherwise returns FALSE. +.PP +See also feature() and setFeature(). +.SH "bool QXmlReader::hasProperty ( const QString & name ) const\fC [pure virtual]\fR" +Returns TRUE if the reader has the property \fIname\fR; otherwise returns FALSE. +.PP +See also property() and setProperty(). +.SH "QXmlLexicalHandler * QXmlReader::lexicalHandler () const\fC [pure virtual]\fR" +Returns the lexical handler or 0 if none was set. +.PP +See also setLexicalHandler(). +.SH "bool QXmlReader::parse ( const QXmlInputSource * input )\fC [pure virtual]\fR" +Reads an XML document from \fIinput\fR and parses it. Returns TRUE if the parsing was successful; otherwise returns FALSE. +.PP +Example: xml/tagreader/tagreader.cpp. +.SH "bool QXmlReader::parse ( const QXmlInputSource & input )\fC [pure virtual]\fR" +\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. +.SH "void * QXmlReader::property ( const QString & name, bool * ok = 0 ) const\fC [pure virtual]\fR" +If the reader has the property \fIname\fR, this function returns the value of the property; otherwise the return value is undefined. +.PP +If \fIok\fR is not 0: if the reader has the \fIname\fR property \fI*ok\fR is set to TRUE; otherwise \fI*ok\fR is set to FALSE. +.PP +See also setProperty() and hasProperty(). +.SH "void QXmlReader::setContentHandler ( QXmlContentHandler * handler )\fC [pure virtual]\fR" +Sets the content handler to \fIhandler\fR. +.PP +See also contentHandler(). +.PP +Example: xml/tagreader/tagreader.cpp. +.SH "void QXmlReader::setDTDHandler ( QXmlDTDHandler * handler )\fC [pure virtual]\fR" +Sets the DTD handler to \fIhandler\fR. +.PP +See also DTDHandler(). +.SH "void QXmlReader::setDeclHandler ( QXmlDeclHandler * handler )\fC [pure virtual]\fR" +Sets the declaration handler to \fIhandler\fR. +.PP +See also declHandler(). +.SH "void QXmlReader::setEntityResolver ( QXmlEntityResolver * handler )\fC [pure virtual]\fR" +Sets the entity resolver to \fIhandler\fR. +.PP +See also entityResolver(). +.SH "void QXmlReader::setErrorHandler ( QXmlErrorHandler * handler )\fC [pure virtual]\fR" +Sets the error handler to \fIhandler\fR. Clears the error handler if \fIhandler\fR is 0. +.PP +See also errorHandler(). +.SH "void QXmlReader::setFeature ( const QString & name, bool value )\fC [pure virtual]\fR" +Sets the feature called \fIname\fR to the given \fIvalue\fR. If the reader doesn't have the feature nothing happens. +.PP +See also feature() and hasFeature(). +.PP +Reimplemented in QXmlSimpleReader. +.SH "void QXmlReader::setLexicalHandler ( QXmlLexicalHandler * handler )\fC [pure virtual]\fR" +Sets the lexical handler to \fIhandler\fR. +.PP +See also lexicalHandler(). +.SH "void QXmlReader::setProperty ( const QString & name, void * value )\fC [pure virtual]\fR" +Sets the property \fIname\fR to \fIvalue\fR. If the reader doesn't have the property nothing happens. +.PP +See also property() and hasProperty(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlreader.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlreader.3qt) and the Qt +version (3.3.8). diff --git a/doc/man/man3/tqxmlsimplereader.3qt b/doc/man/man3/tqxmlsimplereader.3qt new file mode 100644 index 000000000..6372b6952 --- /dev/null +++ b/doc/man/man3/tqxmlsimplereader.3qt @@ -0,0 +1,142 @@ +'\" t +.TH QXmlSimpleReader 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 +QXmlSimpleReader \- Implementation of a simple XML reader (parser) +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <ntqxml.h>\fR +.PP +Inherits QXmlReader. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQXmlSimpleReader\fR ()" +.br +.ti -1c +.BI "virtual \fB~QXmlSimpleReader\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetFeature\fR ( const QString & name, bool value )" +.br +.ti -1c +.BI "virtual bool \fBparse\fR ( const QXmlInputSource * input, bool incremental )" +.br +.ti -1c +.BI "virtual bool \fBparseContinue\fR ()" +.br +.in -1c +.SH DESCRIPTION +The QXmlSimpleReader class provides an implementation of a simple XML reader (parser). +.PP +This XML reader is sufficient for simple parsing tasks. The reader: +.TP +provides a well-formed parser; +.TP +does not parse any external entities; +.TP +can do namespace processing. +.PP +Documents are parsed with a call to parse(). +.PP +See also XML. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QXmlSimpleReader::QXmlSimpleReader ()" +Constructs a simple XML reader with the following feature settings: <center>.nf +.TS +l - l. Feature Setting \fIhttp://xml.org/sax/features/namespaces\fR TRUE \fIhttp://xml.org/sax/features/namespace-prefixes\fR FALSE \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR TRUE \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR +.TE +.fi +</center> +.PP +More information about features can be found in the Qt SAX2 overview. +.PP +See also setFeature(). +.SH "QXmlSimpleReader::~QXmlSimpleReader ()\fC [virtual]\fR" +Destroys the simple XML reader. +.SH "bool QXmlSimpleReader::parse ( const QXmlInputSource * input, bool incremental )\fC [virtual]\fR" +Reads an XML document from \fIinput\fR and parses it. Returns FALSE if the parsing detects an error; otherwise returns TRUE. +.PP +If \fIincremental\fR is TRUE, the parser does not return FALSE when it reaches the end of the \fIinput\fR without reaching the end of the XML file. Instead it stores the state of the parser so that parsing can be continued at a later stage when more data is available. You can use the function parseContinue() to continue with parsing. This class stores a pointer to the input source \fIinput\fR and the parseContinue() function tries to read from that input souce. This means that you should not delete the input source \fIinput\fR until you've finished your calls to parseContinue(). If you call this function with \fIincremental\fR TRUE whilst an incremental parse is in progress a new parsing session will be started and the previous session lost. +.PP +If \fIincremental\fR is FALSE, this function behaves like the normal parse function, i.e. it returns FALSE when the end of input is reached without reaching the end of the XML file and the parsing cannot be continued. +.PP +See also parseContinue() and QSocket. +.PP +Examples: +.)l xml/tagreader-with-features/tagreader.cpp and xml/tagreader/tagreader.cpp. +.SH "bool QXmlSimpleReader::parseContinue ()\fC [virtual]\fR" +Continues incremental parsing; this function reads the input from the QXmlInputSource that was specified with the last parse() command. To use this function, you \fImust\fR have called parse() with the incremental argument set to TRUE. +.PP +Returns FALSE if a parsing error occurs; otherwise returns TRUE. +.PP +If the input source returns an empty string for the function QXmlInputSource::data(), then this means that the end of the XML file has been reached; this is quite important, especially if you want to use the reader to parse more than one XML file. +.PP +The case of the end of the XML file being reached without having finished parsing is not considered to be an error: you can continue parsing at a later stage by calling this function again when there is more data available to parse. +.PP +This function assumes that the end of the XML document is reached if the QXmlInputSource::next() function returns QXmlInputSource::EndOfDocument. If the parser has not finished parsing when it encounters this symbol, it is an error and FALSE is returned. +.PP +See also parse() and QXmlInputSource::next(). +.SH "void QXmlSimpleReader::setFeature ( const QString & name, bool value )\fC [virtual]\fR" +Sets the state of the feature \fIname\fR to \fIvalue\fR: +.PP +If the feature is not recognized, it is ignored. +.PP +The following features are supported: <center>.nf +.TS +l - l. Feature Notes \fIhttp://xml.org/sax/features/namespaces\fR If this feature is TRUE, namespace processing is performed. \fIhttp://xml.org/sax/features/namespace-prefixes\fR If this feature is TRUE, the the original prefixed names and attributes used for namespace declarations are reported. \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR If this feature is TRUE, CharData that only contain whitespace are not ignored, but are reported via QXmlContentHandler::characters(). \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR +.TE +.fi +</center> +.PP +.nf +.br + ** $Id: qt/tagreader.cpp 3.3.8 edited Jan 11 14:46 $ +.fi +.PP +.nf +.br + reader.setFeature( "http://xml.org/sax/features/namespace-prefixes", +.br + TRUE ); +.fi +.PP +(Code taken from xml/tagreader-with-features/tagreader.cpp) +.PP +See also feature() and hasFeature(). +.PP +Example: xml/tagreader-with-features/tagreader.cpp. +.PP +Reimplemented from QXmlReader. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qxmlsimplereader.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 qt-bugs@trolltech.com . +Please include the name of the manual page (tqxmlsimplereader.3qt) and the Qt +version (3.3.8). -- cgit v1.2.1